Fix 4a9820
[org-mode.git] / lisp / org.el
blob088b905af36d769889f2965d36688778a71dda68
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-inlinetask-at-task-p "org-inlinetask" ())
115 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
116 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
117 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
118 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
119 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
120 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
121 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
123 (declare-function orgtbl-mode "org-table" (&optional arg))
124 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
125 (declare-function org-beamer-mode "ox-beamer" ())
126 (declare-function org-table-edit-field "org-table" (arg))
127 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
128 (declare-function org-table-set-constants "org-table" ())
129 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
130 (declare-function org-id-get-create "org-id" (&optional force))
131 (declare-function org-id-find-id-file "org-id" (id))
132 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
133 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
134 (declare-function org-agenda-redo "org-agenda" (&optional all))
135 (declare-function org-table-align "org-table" ())
136 (declare-function org-table-paste-rectangle "org-table" ())
137 (declare-function org-table-maybe-eval-formula "org-table" ())
138 (declare-function org-table-maybe-recalculate-line "org-table" ())
140 (declare-function org-element--parse-objects "org-element"
141 (beg end acc restriction))
142 (declare-function org-element-at-point "org-element" (&optional keep-trail))
143 (declare-function org-element-contents "org-element" (element))
144 (declare-function org-element-context "org-element" (&optional element))
145 (declare-function org-element-interpret-data "org-element"
146 (data &optional parent))
147 (declare-function org-element-map "org-element"
148 (data types fun &optional info first-match no-recursion))
149 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
150 (declare-function org-element-parse-buffer "org-element"
151 (&optional granularity visible-only))
152 (declare-function org-element-property "org-element" (property element))
153 (declare-function org-element-put-property "org-element"
154 (element property value))
155 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
156 (declare-function org-element--parse-objects "org-element"
157 (beg end acc restriction))
158 (declare-function org-element-parse-buffer "org-element"
159 (&optional granularity visible-only))
160 (declare-function org-element-restriction "org-element" (element))
161 (declare-function org-element-type "org-element" (element))
163 ;; load languages based on value of `org-babel-load-languages'
164 (defvar org-babel-load-languages)
166 ;;;###autoload
167 (defun org-babel-do-load-languages (sym value)
168 "Load the languages defined in `org-babel-load-languages'."
169 (set-default sym value)
170 (mapc (lambda (pair)
171 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
172 (if active
173 (progn
174 (require (intern (concat "ob-" lang))))
175 (progn
176 (funcall 'fmakunbound
177 (intern (concat "org-babel-execute:" lang)))
178 (funcall 'fmakunbound
179 (intern (concat "org-babel-expand-body:" lang)))))))
180 org-babel-load-languages))
182 ;;;###autoload
183 (defun org-babel-load-file (file &optional compile)
184 "Load Emacs Lisp source code blocks in the Org-mode FILE.
185 This function exports the source code using `org-babel-tangle'
186 and then loads the resulting file using `load-file'. With prefix
187 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
188 file to byte-code before it is loaded."
189 (interactive "fFile to load: \nP")
190 (require 'ob-core)
191 (let* ((age (lambda (file)
192 (float-time
193 (time-subtract (current-time)
194 (nth 5 (or (file-attributes (file-truename file))
195 (file-attributes file)))))))
196 (base-name (file-name-sans-extension file))
197 (exported-file (concat base-name ".el")))
198 ;; tangle if the org-mode file is newer than the elisp file
199 (unless (and (file-exists-p exported-file)
200 (> (funcall age file) (funcall age exported-file)))
201 (setq exported-file
202 (car (org-babel-tangle-file file exported-file "emacs-lisp"))))
203 (message "%s %s"
204 (if compile
205 (progn (byte-compile-file exported-file 'load)
206 "Compiled and loaded")
207 (progn (load-file exported-file) "Loaded"))
208 exported-file)))
210 (defcustom org-babel-load-languages '((emacs-lisp . t))
211 "Languages which can be evaluated in Org-mode buffers.
212 This list can be used to load support for any of the languages
213 below, note that each language will depend on a different set of
214 system executables and/or Emacs modes. When a language is
215 \"loaded\", then code blocks in that language can be evaluated
216 with `org-babel-execute-src-block' bound by default to C-c
217 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
218 be set to remove code block evaluation from the C-c C-c
219 keybinding. By default only Emacs Lisp (which has no
220 requirements) is loaded."
221 :group 'org-babel
222 :set 'org-babel-do-load-languages
223 :version "24.1"
224 :type '(alist :tag "Babel Languages"
225 :key-type
226 (choice
227 (const :tag "Awk" awk)
228 (const :tag "C" C)
229 (const :tag "R" R)
230 (const :tag "Asymptote" asymptote)
231 (const :tag "Calc" calc)
232 (const :tag "Clojure" clojure)
233 (const :tag "CSS" css)
234 (const :tag "Ditaa" ditaa)
235 (const :tag "Dot" dot)
236 (const :tag "Emacs Lisp" emacs-lisp)
237 (const :tag "Fortran" fortran)
238 (const :tag "Gnuplot" gnuplot)
239 (const :tag "Haskell" haskell)
240 (const :tag "IO" io)
241 (const :tag "Java" java)
242 (const :tag "Javascript" js)
243 (const :tag "LaTeX" latex)
244 (const :tag "Ledger" ledger)
245 (const :tag "Lilypond" lilypond)
246 (const :tag "Lisp" lisp)
247 (const :tag "Makefile" makefile)
248 (const :tag "Maxima" maxima)
249 (const :tag "Matlab" matlab)
250 (const :tag "Mscgen" mscgen)
251 (const :tag "Ocaml" ocaml)
252 (const :tag "Octave" octave)
253 (const :tag "Org" org)
254 (const :tag "Perl" perl)
255 (const :tag "Pico Lisp" picolisp)
256 (const :tag "PlantUML" plantuml)
257 (const :tag "Python" python)
258 (const :tag "Ruby" ruby)
259 (const :tag "Sass" sass)
260 (const :tag "Scala" scala)
261 (const :tag "Scheme" scheme)
262 (const :tag "Screen" screen)
263 (const :tag "Shell Script" sh)
264 (const :tag "Shen" shen)
265 (const :tag "Sql" sql)
266 (const :tag "Sqlite" sqlite))
267 :value-type (boolean :tag "Activate" :value t)))
269 ;;;; Customization variables
270 (defcustom org-clone-delete-id nil
271 "Remove ID property of clones of a subtree.
272 When non-nil, clones of a subtree don't inherit the ID property.
273 Otherwise they inherit the ID property with a new unique
274 identifier."
275 :type 'boolean
276 :version "24.1"
277 :group 'org-id)
279 ;;; Version
280 (org-check-version)
282 ;;;###autoload
283 (defun org-version (&optional here full message)
284 "Show the org-mode version in the echo area.
285 With prefix argument HERE, insert it at point.
286 When FULL is non-nil, use a verbose version string.
287 When MESSAGE is non-nil, display a message with the version."
288 (interactive "P")
289 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
290 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
291 (load-suffixes (list ".el"))
292 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
293 (org-trash (or
294 (and (fboundp 'org-release) (fboundp 'org-git-version))
295 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
296 (load-suffixes save-load-suffixes)
297 (org-version (org-release))
298 (git-version (org-git-version))
299 (version (format "Org-mode version %s (%s @ %s)"
300 org-version
301 git-version
302 (if org-install-dir
303 (if (string= org-dir org-install-dir)
304 org-install-dir
305 (concat "mixed installation! " org-install-dir " and " org-dir))
306 "org-loaddefs.el can not be found!")))
307 (version1 (if full version org-version)))
308 (if (org-called-interactively-p 'interactive)
309 (if here
310 (insert version)
311 (message version))
312 (if message (message version1))
313 version1)))
315 (defconst org-version (org-version))
317 ;;; Compatibility constants
319 ;;; The custom variables
321 (defgroup org nil
322 "Outline-based notes management and organizer."
323 :tag "Org"
324 :group 'outlines
325 :group 'calendar)
327 (defcustom org-mode-hook nil
328 "Mode hook for Org-mode, run after the mode was turned on."
329 :group 'org
330 :type 'hook)
332 (defcustom org-load-hook nil
333 "Hook that is run after org.el has been loaded."
334 :group 'org
335 :type 'hook)
337 (defcustom org-log-buffer-setup-hook nil
338 "Hook that is run after an Org log buffer is created."
339 :group 'org
340 :version "24.1"
341 :type 'hook)
343 (defvar org-modules) ; defined below
344 (defvar org-modules-loaded nil
345 "Have the modules been loaded already?")
347 (defun org-load-modules-maybe (&optional force)
348 "Load all extensions listed in `org-modules'."
349 (when (or force (not org-modules-loaded))
350 (mapc (lambda (ext)
351 (condition-case nil (require ext)
352 (error (message "Problems while trying to load feature `%s'" ext))))
353 org-modules)
354 (setq org-modules-loaded t)))
356 (defun org-set-modules (var value)
357 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
358 (set var value)
359 (when (featurep 'org)
360 (org-load-modules-maybe 'force)))
362 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
363 "Modules that should always be loaded together with org.el.
365 If a description starts with <C>, the file is not part of Emacs
366 and loading it will require that you have downloaded and properly
367 installed the Org mode distribution.
369 You can also use this system to load external packages (i.e. neither Org
370 core modules, nor modules from the CONTRIB directory). Just add symbols
371 to the end of the list. If the package is called org-xyz.el, then you need
372 to add the symbol `xyz', and the package must have a call to:
374 \(provide 'org-xyz)
376 For export specific modules, see also `org-export-backends'."
377 :group 'org
378 :set 'org-set-modules
379 :version "24.4"
380 :package-version '(Org . "8.0")
381 :type
382 '(set :greedy t
383 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
384 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
385 (const :tag " crypt: Encryption of subtrees" org-crypt)
386 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
387 (const :tag " docview: Links to doc-view buffers" org-docview)
388 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
389 (const :tag " habit: Track your consistency with habits" org-habit)
390 (const :tag " id: Global IDs for identifying entries" org-id)
391 (const :tag " info: Links to Info nodes" org-info)
392 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
393 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
394 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
395 (const :tag " mouse: Additional mouse support" org-mouse)
396 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
397 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
398 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
400 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
401 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
402 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
403 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
404 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
405 (const :tag "C collector: Collect properties into tables" org-collector)
406 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
407 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
408 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
409 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
410 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
411 (const :tag "C eval: Include command output as text" org-eval)
412 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
413 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
414 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
415 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
416 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
417 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
418 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
419 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
420 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
421 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
422 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
423 (const :tag "C mew: Links to Mew folders/messages" org-mew)
424 (const :tag "C mtags: Support for muse-like tags" org-mtags)
425 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
426 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
427 (const :tag "C registry: A registry for Org-mode links" org-registry)
428 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
429 (const :tag "C secretary: Team management with org-mode" org-secretary)
430 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
431 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
432 (const :tag "C track: Keep up with Org-mode development" org-track)
433 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
434 (const :tag "C vm: Links to VM folders/messages" org-vm)
435 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
436 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
437 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
439 (defvar org-export--registered-backends) ; From ox.el.
440 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
441 (declare-function org-export-backend-name "ox" (backend))
442 (defcustom org-export-backends '(ascii html icalendar latex)
443 "List of export back-ends that should be always available.
445 If a description starts with <C>, the file is not part of Emacs
446 and loading it will require that you have downloaded and properly
447 installed the Org mode distribution.
449 Unlike to `org-modules', libraries in this list will not be
450 loaded along with Org, but only once the export framework is
451 needed.
453 This variable needs to be set before org.el is loaded. If you
454 need to make a change while Emacs is running, use the customize
455 interface or run the following code, where VAL stands for the new
456 value of the variable, after updating it:
458 \(progn
459 \(setq org-export--registered-backends
460 \(org-remove-if-not
461 \(lambda (backend)
462 \(let ((name (org-export-backend-name backend)))
463 \(or (memq name val)
464 \(catch 'parentp
465 \(dolist (b val)
466 \(and (org-export-derived-backend-p b name)
467 \(throw 'parentp t)))))))
468 org-export--registered-backends))
469 \(let ((new-list (mapcar 'org-export-backend-name
470 org-export--registered-backends)))
471 \(dolist (backend val)
472 \(cond
473 \((not (load (format \"ox-%s\" backend) t t))
474 \(message \"Problems while trying to load export back-end `%s'\"
475 backend))
476 \((not (memq backend new-list)) (push backend new-list))))
477 \(set-default 'org-export-backends new-list)))
479 Adding a back-end to this list will also pull the back-end it
480 depends on, if any."
481 :group 'org
482 :group 'org-export
483 :version "24.4"
484 :package-version '(Org . "8.0")
485 :initialize 'custom-initialize-set
486 :set (lambda (var val)
487 (if (not (featurep 'ox)) (set-default var val)
488 ;; Any back-end not required anymore (not present in VAL and not
489 ;; a parent of any back-end in the new value) is removed from the
490 ;; list of registered back-ends.
491 (setq org-export--registered-backends
492 (org-remove-if-not
493 (lambda (backend)
494 (let ((name (org-export-backend-name backend)))
495 (or (memq name val)
496 (catch 'parentp
497 (dolist (b val)
498 (and (org-export-derived-backend-p b name)
499 (throw 'parentp t)))))))
500 org-export--registered-backends))
501 ;; Now build NEW-LIST of both new back-ends and required
502 ;; parents.
503 (let ((new-list (mapcar 'org-export-backend-name
504 org-export--registered-backends)))
505 (dolist (backend val)
506 (cond
507 ((not (load (format "ox-%s" backend) t t))
508 (message "Problems while trying to load export back-end `%s'"
509 backend))
510 ((not (memq backend new-list)) (push backend new-list))))
511 ;; Set VAR to that list with fixed dependencies.
512 (set-default var new-list))))
513 :type '(set :greedy t
514 (const :tag " ascii Export buffer to ASCII format" ascii)
515 (const :tag " beamer Export buffer to Beamer presentation" beamer)
516 (const :tag " html Export buffer to HTML format" html)
517 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
518 (const :tag " latex Export buffer to LaTeX format" latex)
519 (const :tag " man Export buffer to MAN format" man)
520 (const :tag " md Export buffer to Markdown format" md)
521 (const :tag " odt Export buffer to ODT format" odt)
522 (const :tag " org Export buffer to Org format" org)
523 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
524 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
525 (const :tag "C deck Export buffer to deck.js presentations" deck)
526 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
527 (const :tag "C groff Export buffer to Groff format" groff)
528 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
529 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
530 (const :tag "C s5 Export buffer to s5 presentations" s5)
531 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
533 (eval-after-load 'ox
534 '(mapc
535 (lambda (backend)
536 (condition-case nil (require (intern (format "ox-%s" backend)))
537 (error (message "Problems while trying to load export back-end `%s'"
538 backend))))
539 org-export-backends))
541 (defcustom org-support-shift-select nil
542 "Non-nil means make shift-cursor commands select text when possible.
544 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
545 start selecting a region, or enlarge regions started in this way.
546 In Org-mode, in special contexts, these same keys are used for
547 other purposes, important enough to compete with shift selection.
548 Org tries to balance these needs by supporting `shift-select-mode'
549 outside these special contexts, under control of this variable.
551 The default of this variable is nil, to avoid confusing behavior. Shifted
552 cursor keys will then execute Org commands in the following contexts:
553 - on a headline, changing TODO state (left/right) and priority (up/down)
554 - on a time stamp, changing the time
555 - in a plain list item, changing the bullet type
556 - in a property definition line, switching between allowed values
557 - in the BEGIN line of a clock table (changing the time block).
558 Outside these contexts, the commands will throw an error.
560 When this variable is t and the cursor is not in a special
561 context, Org-mode will support shift-selection for making and
562 enlarging regions. To make this more effective, the bullet
563 cycling will no longer happen anywhere in an item line, but only
564 if the cursor is exactly on the bullet.
566 If you set this variable to the symbol `always', then the keys
567 will not be special in headlines, property lines, and item lines,
568 to make shift selection work there as well. If this is what you
569 want, you can use the following alternative commands: `C-c C-t'
570 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
571 can be used to switch TODO sets, `C-c -' to cycle item bullet
572 types, and properties can be edited by hand or in column view.
574 However, when the cursor is on a timestamp, shift-cursor commands
575 will still edit the time stamp - this is just too good to give up.
577 XEmacs user should have this variable set to nil, because
578 `shift-select-mode' is in Emacs 23 or later only."
579 :group 'org
580 :type '(choice
581 (const :tag "Never" nil)
582 (const :tag "When outside special context" t)
583 (const :tag "Everywhere except timestamps" always)))
585 (defcustom org-loop-over-headlines-in-active-region nil
586 "Shall some commands act upon headlines in the active region?
588 When set to `t', some commands will be performed in all headlines
589 within the active region.
591 When set to `start-level', some commands will be performed in all
592 headlines within the active region, provided that these headlines
593 are of the same level than the first one.
595 When set to a string, those commands will be performed on the
596 matching headlines within the active region. Such string must be
597 a tags/property/todo match as it is used in the agenda tags view.
599 The list of commands is: `org-schedule', `org-deadline',
600 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
601 `org-archive-to-archive-sibling'. The archiving commands skip
602 already archived entries."
603 :type '(choice (const :tag "Don't loop" nil)
604 (const :tag "All headlines in active region" t)
605 (const :tag "In active region, headlines at the same level than the first one" start-level)
606 (string :tag "Tags/Property/Todo matcher"))
607 :version "24.1"
608 :group 'org-todo
609 :group 'org-archive)
611 (defgroup org-startup nil
612 "Options concerning startup of Org-mode."
613 :tag "Org Startup"
614 :group 'org)
616 (defcustom org-startup-folded t
617 "Non-nil means entering Org-mode will switch to OVERVIEW.
618 This can also be configured on a per-file basis by adding one of
619 the following lines anywhere in the buffer:
621 #+STARTUP: fold (or `overview', this is equivalent)
622 #+STARTUP: nofold (or `showall', this is equivalent)
623 #+STARTUP: content
624 #+STARTUP: showeverything
626 By default, this option is ignored when Org opens agenda files
627 for the first time. If you want the agenda to honor the startup
628 option, set `org-agenda-inhibit-startup' to nil."
629 :group 'org-startup
630 :type '(choice
631 (const :tag "nofold: show all" nil)
632 (const :tag "fold: overview" t)
633 (const :tag "content: all headlines" content)
634 (const :tag "show everything, even drawers" showeverything)))
636 (defcustom org-startup-truncated t
637 "Non-nil means entering Org-mode will set `truncate-lines'.
638 This is useful since some lines containing links can be very long and
639 uninteresting. Also tables look terrible when wrapped."
640 :group 'org-startup
641 :type 'boolean)
643 (defcustom org-startup-indented nil
644 "Non-nil means turn on `org-indent-mode' on startup.
645 This can also be configured on a per-file basis by adding one of
646 the following lines anywhere in the buffer:
648 #+STARTUP: indent
649 #+STARTUP: noindent"
650 :group 'org-structure
651 :type '(choice
652 (const :tag "Not" nil)
653 (const :tag "Globally (slow on startup in large files)" t)))
655 (defcustom org-use-sub-superscripts t
656 "Non-nil means interpret \"_\" and \"^\" for display.
658 If you want to control how Org exports those characters, see
659 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
660 used to be an alias for `org-export-with-sub-superscripts' in
661 Org <8.0, it is not anymore.
663 When this option is turned on, you can use TeX-like syntax for
664 sub- and superscripts within the buffer. Several characters after
665 \"_\" or \"^\" will be considered as a single item - so grouping
666 with {} is normally not needed. For example, the following things
667 will be parsed as single sub- or superscripts:
669 10^24 or 10^tau several digits will be considered 1 item.
670 10^-12 or 10^-tau a leading sign with digits or a word
671 x^2-y^3 will be read as x^2 - y^3, because items are
672 terminated by almost any nonword/nondigit char.
673 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
675 Still, ambiguity is possible. So when in doubt, use {} to enclose
676 the sub/superscript. If you set this variable to the symbol `{}',
677 the braces are *required* in order to trigger interpretations as
678 sub/superscript. This can be helpful in documents that need \"_\"
679 frequently in plain text."
680 :group 'org-startup
681 :version "24.4"
682 :package-version '(Org . "8.0")
683 :type '(choice
684 (const :tag "Always interpret" t)
685 (const :tag "Only with braces" {})
686 (const :tag "Never interpret" nil)))
688 (defcustom org-startup-with-beamer-mode nil
689 "Non-nil means turn on `org-beamer-mode' on startup.
690 This can also be configured on a per-file basis by adding one of
691 the following lines anywhere in the buffer:
693 #+STARTUP: beamer"
694 :group 'org-startup
695 :version "24.1"
696 :type 'boolean)
698 (defcustom org-startup-align-all-tables nil
699 "Non-nil means align all tables when visiting a file.
700 This is useful when the column width in tables is forced with <N> cookies
701 in table fields. Such tables will look correct only after the first re-align.
702 This can also be configured on a per-file basis by adding one of
703 the following lines anywhere in the buffer:
704 #+STARTUP: align
705 #+STARTUP: noalign"
706 :group 'org-startup
707 :type 'boolean)
709 (defcustom org-startup-with-inline-images nil
710 "Non-nil means show inline images when loading a new Org file.
711 This can also be configured on a per-file basis by adding one of
712 the following lines anywhere in the buffer:
713 #+STARTUP: inlineimages
714 #+STARTUP: noinlineimages"
715 :group 'org-startup
716 :version "24.1"
717 :type 'boolean)
719 (defcustom org-startup-with-latex-preview nil
720 "Non-nil means preview LaTeX fragments when loading a new Org file.
722 This can also be configured on a per-file basis by adding one of
723 the following lines anywhere in the buffer:
724 #+STARTUP: latexpreview
725 #+STARTUP: nolatexpreview"
726 :group 'org-startup
727 :version "24.4"
728 :package-version '(Org . "8.0")
729 :type 'boolean)
731 (defcustom org-insert-mode-line-in-empty-file nil
732 "Non-nil means insert the first line setting Org-mode in empty files.
733 When the function `org-mode' is called interactively in an empty file, this
734 normally means that the file name does not automatically trigger Org-mode.
735 To ensure that the file will always be in Org-mode in the future, a
736 line enforcing Org-mode will be inserted into the buffer, if this option
737 has been set."
738 :group 'org-startup
739 :type 'boolean)
741 (defcustom org-replace-disputed-keys nil
742 "Non-nil means use alternative key bindings for some keys.
743 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
744 These keys are also used by other packages like shift-selection-mode'
745 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
746 If you want to use Org-mode together with one of these other modes,
747 or more generally if you would like to move some Org-mode commands to
748 other keys, set this variable and configure the keys with the variable
749 `org-disputed-keys'.
751 This option is only relevant at load-time of Org-mode, and must be set
752 *before* org.el is loaded. Changing it requires a restart of Emacs to
753 become effective."
754 :group 'org-startup
755 :type 'boolean)
757 (defcustom org-use-extra-keys nil
758 "Non-nil means use extra key sequence definitions for certain commands.
759 This happens automatically if you run XEmacs or if `window-system'
760 is nil. This variable lets you do the same manually. You must
761 set it before loading org.
763 Example: on Carbon Emacs 22 running graphically, with an external
764 keyboard on a Powerbook, the default way of setting M-left might
765 not work for either Alt or ESC. Setting this variable will make
766 it work for ESC."
767 :group 'org-startup
768 :type 'boolean)
770 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
772 (defcustom org-disputed-keys
773 '(([(shift up)] . [(meta p)])
774 ([(shift down)] . [(meta n)])
775 ([(shift left)] . [(meta -)])
776 ([(shift right)] . [(meta +)])
777 ([(control shift right)] . [(meta shift +)])
778 ([(control shift left)] . [(meta shift -)]))
779 "Keys for which Org-mode and other modes compete.
780 This is an alist, cars are the default keys, second element specifies
781 the alternative to use when `org-replace-disputed-keys' is t.
783 Keys can be specified in any syntax supported by `define-key'.
784 The value of this option takes effect only at Org-mode's startup,
785 therefore you'll have to restart Emacs to apply it after changing."
786 :group 'org-startup
787 :type 'alist)
789 (defun org-key (key)
790 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
791 Or return the original if not disputed.
792 Also apply the translations defined in `org-xemacs-key-equivalents'."
793 (when org-replace-disputed-keys
794 (let* ((nkey (key-description key))
795 (x (org-find-if (lambda (x)
796 (equal (key-description (car x)) nkey))
797 org-disputed-keys)))
798 (setq key (if x (cdr x) key))))
799 (when (featurep 'xemacs)
800 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
801 key)
803 (defun org-find-if (predicate seq)
804 (catch 'exit
805 (while seq
806 (if (funcall predicate (car seq))
807 (throw 'exit (car seq))
808 (pop seq)))))
810 (defun org-defkey (keymap key def)
811 "Define a key, possibly translated, as returned by `org-key'."
812 (define-key keymap (org-key key) def))
814 (defcustom org-ellipsis nil
815 "The ellipsis to use in the Org-mode outline.
816 When nil, just use the standard three dots.
817 When a string, use that string instead.
818 When a face, use the standard 3 dots, but with the specified face.
819 The change affects only Org-mode (which will then use its own display table).
820 Changing this requires executing `M-x org-mode RET' in a buffer to become
821 effective."
822 :group 'org-startup
823 :type '(choice (const :tag "Default" nil)
824 (face :tag "Face" :value org-warning)
825 (string :tag "String" :value "...#")))
827 (defvar org-display-table nil
828 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
830 (defgroup org-keywords nil
831 "Keywords in Org-mode."
832 :tag "Org Keywords"
833 :group 'org)
835 (defcustom org-deadline-string "DEADLINE:"
836 "String to mark deadline entries.
837 A deadline is this string, followed by a time stamp. Should be a word,
838 terminated by a colon. You can insert a schedule keyword and
839 a timestamp with \\[org-deadline].
840 Changes become only effective after restarting Emacs."
841 :group 'org-keywords
842 :type 'string)
844 (defcustom org-scheduled-string "SCHEDULED:"
845 "String to mark scheduled TODO entries.
846 A schedule is this string, followed by a time stamp. Should be a word,
847 terminated by a colon. You can insert a schedule keyword and
848 a timestamp with \\[org-schedule].
849 Changes become only effective after restarting Emacs."
850 :group 'org-keywords
851 :type 'string)
853 (defcustom org-closed-string "CLOSED:"
854 "String used as the prefix for timestamps logging closing a TODO entry."
855 :group 'org-keywords
856 :type 'string)
858 (defcustom org-clock-string "CLOCK:"
859 "String used as prefix for timestamps clocking work hours on an item."
860 :group 'org-keywords
861 :type 'string)
863 (defcustom org-closed-keep-when-no-todo nil
864 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
865 :group 'org-todo
866 :group 'org-keywords
867 :version "24.4"
868 :package-version '(Org . "8.0")
869 :type 'boolean)
871 (defconst org-planning-or-clock-line-re (concat "^[ \t]*\\("
872 org-scheduled-string "\\|"
873 org-deadline-string "\\|"
874 org-closed-string "\\|"
875 org-clock-string "\\)")
876 "Matches a line with planning or clock info.")
878 (defcustom org-comment-string "COMMENT"
879 "Entries starting with this keyword will never be exported.
880 An entry can be toggled between COMMENT and normal with
881 \\[org-toggle-comment].
882 Changes become only effective after restarting Emacs."
883 :group 'org-keywords
884 :type 'string)
886 (defcustom org-quote-string "QUOTE"
887 "Entries starting with this keyword will be exported in fixed-width font.
888 Quoting applies only to the text in the entry following the headline, and does
889 not extend beyond the next headline, even if that is lower level.
890 An entry can be toggled between QUOTE and normal with
891 \\[org-toggle-fixed-width-section]."
892 :group 'org-keywords
893 :type 'string)
895 (defconst org-repeat-re
896 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
897 "Regular expression for specifying repeated events.
898 After a match, group 1 contains the repeat expression.")
900 (defgroup org-structure nil
901 "Options concerning the general structure of Org-mode files."
902 :tag "Org Structure"
903 :group 'org)
905 (defgroup org-reveal-location nil
906 "Options about how to make context of a location visible."
907 :tag "Org Reveal Location"
908 :group 'org-structure)
910 (defconst org-context-choice
911 '(choice
912 (const :tag "Always" t)
913 (const :tag "Never" nil)
914 (repeat :greedy t :tag "Individual contexts"
915 (cons
916 (choice :tag "Context"
917 (const agenda)
918 (const org-goto)
919 (const occur-tree)
920 (const tags-tree)
921 (const link-search)
922 (const mark-goto)
923 (const bookmark-jump)
924 (const isearch)
925 (const default))
926 (boolean))))
927 "Contexts for the reveal options.")
929 (defcustom org-show-hierarchy-above '((default . t))
930 "Non-nil means show full hierarchy when revealing a location.
931 Org-mode often shows locations in an org-mode file which might have
932 been invisible before. When this is set, the hierarchy of headings
933 above the exposed location is shown.
934 Turning this off for example for sparse trees makes them very compact.
935 Instead of t, this can also be an alist specifying this option for different
936 contexts. Valid contexts are
937 agenda when exposing an entry from the agenda
938 org-goto when using the command `org-goto' on key C-c C-j
939 occur-tree when using the command `org-occur' on key C-c /
940 tags-tree when constructing a sparse tree based on tags matches
941 link-search when exposing search matches associated with a link
942 mark-goto when exposing the jump goal of a mark
943 bookmark-jump when exposing a bookmark location
944 isearch when exiting from an incremental search
945 default default for all contexts not set explicitly"
946 :group 'org-reveal-location
947 :type org-context-choice)
949 (defcustom org-show-following-heading '((default . nil))
950 "Non-nil means show following heading when revealing a location.
951 Org-mode often shows locations in an org-mode file which might have
952 been invisible before. When this is set, the heading following the
953 match is shown.
954 Turning this off for example for sparse trees makes them very compact,
955 but makes it harder to edit the location of the match. In such a case,
956 use the command \\[org-reveal] to show more context.
957 Instead of t, this can also be an alist specifying this option for different
958 contexts. See `org-show-hierarchy-above' for valid contexts."
959 :group 'org-reveal-location
960 :type org-context-choice)
962 (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
963 "Non-nil means show all sibling heading when revealing a location.
964 Org-mode often shows locations in an org-mode file which might have
965 been invisible before. When this is set, the sibling of the current entry
966 heading are all made visible. If `org-show-hierarchy-above' is t,
967 the same happens on each level of the hierarchy above the current entry.
969 By default this is on for the isearch context, off for all other contexts.
970 Turning this off for example for sparse trees makes them very compact,
971 but makes it harder to edit the location of the match. In such a case,
972 use the command \\[org-reveal] to show more context.
973 Instead of t, this can also be an alist specifying this option for different
974 contexts. See `org-show-hierarchy-above' for valid contexts."
975 :group 'org-reveal-location
976 :type org-context-choice
977 :version "24.4"
978 :package-version '(Org . "8.0"))
980 (defcustom org-show-entry-below '((default . nil))
981 "Non-nil means show the entry below a headline when revealing a location.
982 Org-mode often shows locations in an org-mode file which might have
983 been invisible before. When this is set, the text below the headline that is
984 exposed is also shown.
986 By default this is off for all contexts.
987 Instead of t, this can also be an alist specifying this option for different
988 contexts. See `org-show-hierarchy-above' for valid contexts."
989 :group 'org-reveal-location
990 :type org-context-choice)
992 (defcustom org-indirect-buffer-display 'other-window
993 "How should indirect tree buffers be displayed?
994 This applies to indirect buffers created with the commands
995 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
996 Valid values are:
997 current-window Display in the current window
998 other-window Just display in another window.
999 dedicated-frame Create one new frame, and re-use it each time.
1000 new-frame Make a new frame each time. Note that in this case
1001 previously-made indirect buffers are kept, and you need to
1002 kill these buffers yourself."
1003 :group 'org-structure
1004 :group 'org-agenda-windows
1005 :type '(choice
1006 (const :tag "In current window" current-window)
1007 (const :tag "In current frame, other window" other-window)
1008 (const :tag "Each time a new frame" new-frame)
1009 (const :tag "One dedicated frame" dedicated-frame)))
1011 (defcustom org-use-speed-commands nil
1012 "Non-nil means activate single letter commands at beginning of a headline.
1013 This may also be a function to test for appropriate locations where speed
1014 commands should be active."
1015 :group 'org-structure
1016 :type '(choice
1017 (const :tag "Never" nil)
1018 (const :tag "At beginning of headline stars" t)
1019 (function)))
1021 (defcustom org-speed-commands-user nil
1022 "Alist of additional speed commands.
1023 This list will be checked before `org-speed-commands-default'
1024 when the variable `org-use-speed-commands' is non-nil
1025 and when the cursor is at the beginning of a headline.
1026 The car if each entry is a string with a single letter, which must
1027 be assigned to `self-insert-command' in the global map.
1028 The cdr is either a command to be called interactively, a function
1029 to be called, or a form to be evaluated.
1030 An entry that is just a list with a single string will be interpreted
1031 as a descriptive headline that will be added when listing the speed
1032 commands in the Help buffer using the `?' speed command."
1033 :group 'org-structure
1034 :type '(repeat :value ("k" . ignore)
1035 (choice :value ("k" . ignore)
1036 (list :tag "Descriptive Headline" (string :tag "Headline"))
1037 (cons :tag "Letter and Command"
1038 (string :tag "Command letter")
1039 (choice
1040 (function)
1041 (sexp))))))
1043 (defcustom org-bookmark-names-plist
1044 '(:last-capture "org-capture-last-stored"
1045 :last-refile "org-refile-last-stored"
1046 :last-capture-marker "org-capture-last-stored-marker")
1047 "Names for bookmarks automatically set by some Org commands.
1048 This can provide strings as names for a number of bookmarks Org sets
1049 automatically. The following keys are currently implemented:
1050 :last-capture
1051 :last-capture-marker
1052 :last-refile
1053 When a key does not show up in the property list, the corresponding bookmark
1054 is not set."
1055 :group 'org-structure
1056 :type 'plist)
1058 (defgroup org-cycle nil
1059 "Options concerning visibility cycling in Org-mode."
1060 :tag "Org Cycle"
1061 :group 'org-structure)
1063 (defcustom org-cycle-skip-children-state-if-no-children t
1064 "Non-nil means skip CHILDREN state in entries that don't have any."
1065 :group 'org-cycle
1066 :type 'boolean)
1068 (defcustom org-cycle-max-level nil
1069 "Maximum level which should still be subject to visibility cycling.
1070 Levels higher than this will, for cycling, be treated as text, not a headline.
1071 When `org-odd-levels-only' is set, a value of N in this variable actually
1072 means 2N-1 stars as the limiting headline.
1073 When nil, cycle all levels.
1074 Note that the limiting level of cycling is also influenced by
1075 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1076 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1077 than its value."
1078 :group 'org-cycle
1079 :type '(choice
1080 (const :tag "No limit" nil)
1081 (integer :tag "Maximum level")))
1083 (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK" "RESULTS")
1084 "Names of drawers. Drawers are not opened by cycling on the headline above.
1085 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1086 this:
1087 :DRAWERNAME:
1088 .....
1089 :END:
1090 The drawer \"PROPERTIES\" is special for capturing properties through
1091 the property API.
1093 Drawers can be defined on the per-file basis with a line like:
1095 #+DRAWERS: HIDDEN STATE PROPERTIES"
1096 :group 'org-structure
1097 :group 'org-cycle
1098 :type '(repeat (string :tag "Drawer Name")))
1100 (defcustom org-hide-block-startup nil
1101 "Non-nil means entering Org-mode will fold all blocks.
1102 This can also be set in on a per-file basis with
1104 #+STARTUP: hideblocks
1105 #+STARTUP: showblocks"
1106 :group 'org-startup
1107 :group 'org-cycle
1108 :type 'boolean)
1110 (defcustom org-cycle-global-at-bob nil
1111 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1112 This makes it possible to do global cycling without having to use S-TAB or
1113 \\[universal-argument] TAB. For this special case to work, the first line
1114 of the buffer must not be a headline -- it may be empty or some other text.
1115 When used in this way, `org-cycle-hook' is disabled temporarily to make
1116 sure the cursor stays at the beginning of the buffer. When this option is
1117 nil, don't do anything special at the beginning of the buffer."
1118 :group 'org-cycle
1119 :type 'boolean)
1121 (defcustom org-cycle-level-after-item/entry-creation t
1122 "Non-nil means cycle entry level or item indentation in new empty entries.
1124 When the cursor is at the end of an empty headline, i.e., with only stars
1125 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1126 and then all possible ancestor states, before returning to the original state.
1127 This makes data entry extremely fast: M-RET to create a new headline,
1128 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1130 When the cursor is at the end of an empty plain list item, one TAB will
1131 make it a subitem, two or more tabs will back up to make this an item
1132 higher up in the item hierarchy."
1133 :group 'org-cycle
1134 :type 'boolean)
1136 (defcustom org-cycle-emulate-tab t
1137 "Where should `org-cycle' emulate TAB.
1138 nil Never
1139 white Only in completely white lines
1140 whitestart Only at the beginning of lines, before the first non-white char
1141 t Everywhere except in headlines
1142 exc-hl-bol Everywhere except at the start of a headline
1143 If TAB is used in a place where it does not emulate TAB, the current subtree
1144 visibility is cycled."
1145 :group 'org-cycle
1146 :type '(choice (const :tag "Never" nil)
1147 (const :tag "Only in completely white lines" white)
1148 (const :tag "Before first char in a line" whitestart)
1149 (const :tag "Everywhere except in headlines" t)
1150 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1152 (defcustom org-cycle-separator-lines 2
1153 "Number of empty lines needed to keep an empty line between collapsed trees.
1154 If you leave an empty line between the end of a subtree and the following
1155 headline, this empty line is hidden when the subtree is folded.
1156 Org-mode will leave (exactly) one empty line visible if the number of
1157 empty lines is equal or larger to the number given in this variable.
1158 So the default 2 means at least 2 empty lines after the end of a subtree
1159 are needed to produce free space between a collapsed subtree and the
1160 following headline.
1162 If the number is negative, and the number of empty lines is at least -N,
1163 all empty lines are shown.
1165 Special case: when 0, never leave empty lines in collapsed view."
1166 :group 'org-cycle
1167 :type 'integer)
1168 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1170 (defcustom org-pre-cycle-hook nil
1171 "Hook that is run before visibility cycling is happening.
1172 The function(s) in this hook must accept a single argument which indicates
1173 the new state that will be set right after running this hook. The
1174 argument is a symbol. Before a global state change, it can have the values
1175 `overview', `content', or `all'. Before a local state change, it can have
1176 the values `folded', `children', or `subtree'."
1177 :group 'org-cycle
1178 :type 'hook)
1180 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1181 org-cycle-hide-drawers
1182 org-cycle-hide-inline-tasks
1183 org-cycle-show-empty-lines
1184 org-optimize-window-after-visibility-change)
1185 "Hook that is run after `org-cycle' has changed the buffer visibility.
1186 The function(s) in this hook must accept a single argument which indicates
1187 the new state that was set by the most recent `org-cycle' command. The
1188 argument is a symbol. After a global state change, it can have the values
1189 `overview', `contents', or `all'. After a local state change, it can have
1190 the values `folded', `children', or `subtree'."
1191 :group 'org-cycle
1192 :type 'hook)
1194 (defgroup org-edit-structure nil
1195 "Options concerning structure editing in Org-mode."
1196 :tag "Org Edit Structure"
1197 :group 'org-structure)
1199 (defcustom org-odd-levels-only nil
1200 "Non-nil means skip even levels and only use odd levels for the outline.
1201 This has the effect that two stars are being added/taken away in
1202 promotion/demotion commands. It also influences how levels are
1203 handled by the exporters.
1204 Changing it requires restart of `font-lock-mode' to become effective
1205 for fontification also in regions already fontified.
1206 You may also set this on a per-file basis by adding one of the following
1207 lines to the buffer:
1209 #+STARTUP: odd
1210 #+STARTUP: oddeven"
1211 :group 'org-edit-structure
1212 :group 'org-appearance
1213 :type 'boolean)
1215 (defcustom org-adapt-indentation t
1216 "Non-nil means adapt indentation to outline node level.
1218 When this variable is set, Org assumes that you write outlines by
1219 indenting text in each node to align with the headline (after the stars).
1220 The following issues are influenced by this variable:
1222 - When this is set and the *entire* text in an entry is indented, the
1223 indentation is increased by one space in a demotion command, and
1224 decreased by one in a promotion command. If any line in the entry
1225 body starts with text at column 0, indentation is not changed at all.
1227 - Property drawers and planning information is inserted indented when
1228 this variable s set. When nil, they will not be indented.
1230 - TAB indents a line relative to context. The lines below a headline
1231 will be indented when this variable is set.
1233 Note that this is all about true indentation, by adding and removing
1234 space characters. See also `org-indent.el' which does level-dependent
1235 indentation in a virtual way, i.e. at display time in Emacs."
1236 :group 'org-edit-structure
1237 :type 'boolean)
1239 (defcustom org-special-ctrl-a/e nil
1240 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1242 When t, `C-a' will bring back the cursor to the beginning of the
1243 headline text, i.e. after the stars and after a possible TODO
1244 keyword. In an item, this will be the position after bullet and
1245 check-box, if any. When the cursor is already at that position,
1246 another `C-a' will bring it to the beginning of the line.
1248 `C-e' will jump to the end of the headline, ignoring the presence
1249 of tags in the headline. A second `C-e' will then jump to the
1250 true end of the line, after any tags. This also means that, when
1251 this variable is non-nil, `C-e' also will never jump beyond the
1252 end of the heading of a folded section, i.e. not after the
1253 ellipses.
1255 When set to the symbol `reversed', the first `C-a' or `C-e' works
1256 normally, going to the true line boundary first. Only a directly
1257 following, identical keypress will bring the cursor to the
1258 special positions.
1260 This may also be a cons cell where the behavior for `C-a' and
1261 `C-e' is set separately."
1262 :group 'org-edit-structure
1263 :type '(choice
1264 (const :tag "off" nil)
1265 (const :tag "on: after stars/bullet and before tags first" t)
1266 (const :tag "reversed: true line boundary first" reversed)
1267 (cons :tag "Set C-a and C-e separately"
1268 (choice :tag "Special C-a"
1269 (const :tag "off" nil)
1270 (const :tag "on: after stars/bullet first" t)
1271 (const :tag "reversed: before stars/bullet first" reversed))
1272 (choice :tag "Special C-e"
1273 (const :tag "off" nil)
1274 (const :tag "on: before tags first" t)
1275 (const :tag "reversed: after tags first" reversed)))))
1276 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1278 (defcustom org-special-ctrl-k nil
1279 "Non-nil means `C-k' will behave specially in headlines.
1280 When nil, `C-k' will call the default `kill-line' command.
1281 When t, the following will happen while the cursor is in the headline:
1283 - When the cursor is at the beginning of a headline, kill the entire
1284 line and possible the folded subtree below the line.
1285 - When in the middle of the headline text, kill the headline up to the tags.
1286 - When after the headline text, kill the tags."
1287 :group 'org-edit-structure
1288 :type 'boolean)
1290 (defcustom org-ctrl-k-protect-subtree nil
1291 "Non-nil means, do not delete a hidden subtree with C-k.
1292 When set to the symbol `error', simply throw an error when C-k is
1293 used to kill (part-of) a headline that has hidden text behind it.
1294 Any other non-nil value will result in a query to the user, if it is
1295 OK to kill that hidden subtree. When nil, kill without remorse."
1296 :group 'org-edit-structure
1297 :version "24.1"
1298 :type '(choice
1299 (const :tag "Do not protect hidden subtrees" nil)
1300 (const :tag "Protect hidden subtrees with a security query" t)
1301 (const :tag "Never kill a hidden subtree with C-k" error)))
1303 (defcustom org-special-ctrl-o t
1304 "Non-nil means, make `C-o' insert a row in tables."
1305 :group 'org-edit-structure
1306 :type 'boolean)
1308 (defcustom org-catch-invisible-edits nil
1309 "Check if in invisible region before inserting or deleting a character.
1310 Valid values are:
1312 nil Do not check, so just do invisible edits.
1313 error Throw an error and do nothing.
1314 show Make point visible, and do the requested edit.
1315 show-and-error Make point visible, then throw an error and abort the edit.
1316 smart Make point visible, and do insertion/deletion if it is
1317 adjacent to visible text and the change feels predictable.
1318 Never delete a previously invisible character or add in the
1319 middle or right after an invisible region. Basically, this
1320 allows insertion and backward-delete right before ellipses.
1321 FIXME: maybe in this case we should not even show?"
1322 :group 'org-edit-structure
1323 :version "24.1"
1324 :type '(choice
1325 (const :tag "Do not check" nil)
1326 (const :tag "Throw error when trying to edit" error)
1327 (const :tag "Unhide, but do not do the edit" show-and-error)
1328 (const :tag "Show invisible part and do the edit" show)
1329 (const :tag "Be smart and do the right thing" smart)))
1331 (defcustom org-yank-folded-subtrees t
1332 "Non-nil means when yanking subtrees, fold them.
1333 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1334 it starts with a heading and all other headings in it are either children
1335 or siblings, then fold all the subtrees. However, do this only if no
1336 text after the yank would be swallowed into a folded tree by this action."
1337 :group 'org-edit-structure
1338 :type 'boolean)
1340 (defcustom org-yank-adjusted-subtrees nil
1341 "Non-nil means when yanking subtrees, adjust the level.
1342 With this setting, `org-paste-subtree' is used to insert the subtree, see
1343 this function for details."
1344 :group 'org-edit-structure
1345 :type 'boolean)
1347 (defcustom org-M-RET-may-split-line '((default . t))
1348 "Non-nil means M-RET will split the line at the cursor position.
1349 When nil, it will go to the end of the line before making a
1350 new line.
1351 You may also set this option in a different way for different
1352 contexts. Valid contexts are:
1354 headline when creating a new headline
1355 item when creating a new item
1356 table in a table field
1357 default the value to be used for all contexts not explicitly
1358 customized"
1359 :group 'org-structure
1360 :group 'org-table
1361 :type '(choice
1362 (const :tag "Always" t)
1363 (const :tag "Never" nil)
1364 (repeat :greedy t :tag "Individual contexts"
1365 (cons
1366 (choice :tag "Context"
1367 (const headline)
1368 (const item)
1369 (const table)
1370 (const default))
1371 (boolean)))))
1374 (defcustom org-insert-heading-respect-content nil
1375 "Non-nil means insert new headings after the current subtree.
1376 When nil, the new heading is created directly after the current line.
1377 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1378 this variable on for the duration of the command."
1379 :group 'org-structure
1380 :type 'boolean)
1382 (defcustom org-blank-before-new-entry '((heading . auto)
1383 (plain-list-item . auto))
1384 "Should `org-insert-heading' leave a blank line before new heading/item?
1385 The value is an alist, with `heading' and `plain-list-item' as CAR,
1386 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1387 which case Org will look at the surrounding headings/items and try to
1388 make an intelligent decision whether to insert a blank line or not.
1390 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1391 the setting here is ignored and no empty line is inserted to avoid breaking
1392 the list structure."
1393 :group 'org-edit-structure
1394 :type '(list
1395 (cons (const heading)
1396 (choice (const :tag "Never" nil)
1397 (const :tag "Always" t)
1398 (const :tag "Auto" auto)))
1399 (cons (const plain-list-item)
1400 (choice (const :tag "Never" nil)
1401 (const :tag "Always" t)
1402 (const :tag "Auto" auto)))))
1404 (defcustom org-insert-heading-hook nil
1405 "Hook being run after inserting a new heading."
1406 :group 'org-edit-structure
1407 :type 'hook)
1409 (defcustom org-enable-fixed-width-editor t
1410 "Non-nil means lines starting with \":\" are treated as fixed-width.
1411 This currently only means they are never auto-wrapped.
1412 When nil, such lines will be treated like ordinary lines.
1413 See also the QUOTE keyword."
1414 :group 'org-edit-structure
1415 :type 'boolean)
1417 (defcustom org-goto-auto-isearch t
1418 "Non-nil means typing characters in `org-goto' starts incremental search.
1419 When nil, you can use these keybindings to navigate the buffer:
1421 q Quit the org-goto interface
1422 n Go to the next visible heading
1423 p Go to the previous visible heading
1424 f Go one heading forward on same level
1425 b Go one heading backward on same level
1426 u Go one heading up"
1427 :group 'org-edit-structure
1428 :type 'boolean)
1430 (defgroup org-sparse-trees nil
1431 "Options concerning sparse trees in Org-mode."
1432 :tag "Org Sparse Trees"
1433 :group 'org-structure)
1435 (defcustom org-highlight-sparse-tree-matches t
1436 "Non-nil means highlight all matches that define a sparse tree.
1437 The highlights will automatically disappear the next time the buffer is
1438 changed by an edit command."
1439 :group 'org-sparse-trees
1440 :type 'boolean)
1442 (defcustom org-remove-highlights-with-change t
1443 "Non-nil means any change to the buffer will remove temporary highlights.
1444 Such highlights are created by `org-occur' and `org-clock-display'.
1445 When nil, `C-c C-c needs to be used to get rid of the highlights.
1446 The highlights created by `org-preview-latex-fragment' always need
1447 `C-c C-c' to be removed."
1448 :group 'org-sparse-trees
1449 :group 'org-time
1450 :type 'boolean)
1453 (defcustom org-occur-hook '(org-first-headline-recenter)
1454 "Hook that is run after `org-occur' has constructed a sparse tree.
1455 This can be used to recenter the window to show as much of the structure
1456 as possible."
1457 :group 'org-sparse-trees
1458 :type 'hook)
1460 (defgroup org-imenu-and-speedbar nil
1461 "Options concerning imenu and speedbar in Org-mode."
1462 :tag "Org Imenu and Speedbar"
1463 :group 'org-structure)
1465 (defcustom org-imenu-depth 2
1466 "The maximum level for Imenu access to Org-mode headlines.
1467 This also applied for speedbar access."
1468 :group 'org-imenu-and-speedbar
1469 :type 'integer)
1471 (defgroup org-table nil
1472 "Options concerning tables in Org-mode."
1473 :tag "Org Table"
1474 :group 'org)
1476 (defcustom org-enable-table-editor 'optimized
1477 "Non-nil means lines starting with \"|\" are handled by the table editor.
1478 When nil, such lines will be treated like ordinary lines.
1480 When equal to the symbol `optimized', the table editor will be optimized to
1481 do the following:
1482 - Automatic overwrite mode in front of whitespace in table fields.
1483 This makes the structure of the table stay in tact as long as the edited
1484 field does not exceed the column width.
1485 - Minimize the number of realigns. Normally, the table is aligned each time
1486 TAB or RET are pressed to move to another field. With optimization this
1487 happens only if changes to a field might have changed the column width.
1488 Optimization requires replacing the functions `self-insert-command',
1489 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1490 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1491 very good at guessing when a re-align will be necessary, but you can always
1492 force one with \\[org-ctrl-c-ctrl-c].
1494 If you would like to use the optimized version in Org-mode, but the
1495 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1497 This variable can be used to turn on and off the table editor during a session,
1498 but in order to toggle optimization, a restart is required.
1500 See also the variable `org-table-auto-blank-field'."
1501 :group 'org-table
1502 :type '(choice
1503 (const :tag "off" nil)
1504 (const :tag "on" t)
1505 (const :tag "on, optimized" optimized)))
1507 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1508 (version<= emacs-version "24.1"))
1509 "Non-nil means cluster self-insert commands for undo when possible.
1510 If this is set, then, like in the Emacs command loop, 20 consecutive
1511 characters will be undone together.
1512 This is configurable, because there is some impact on typing performance."
1513 :group 'org-table
1514 :type 'boolean)
1516 (defcustom org-table-tab-recognizes-table.el t
1517 "Non-nil means TAB will automatically notice a table.el table.
1518 When it sees such a table, it moves point into it and - if necessary -
1519 calls `table-recognize-table'."
1520 :group 'org-table-editing
1521 :type 'boolean)
1523 (defgroup org-link nil
1524 "Options concerning links in Org-mode."
1525 :tag "Org Link"
1526 :group 'org)
1528 (defvar org-link-abbrev-alist-local nil
1529 "Buffer-local version of `org-link-abbrev-alist', which see.
1530 The value of this is taken from the #+LINK lines.")
1531 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1533 (defcustom org-link-abbrev-alist nil
1534 "Alist of link abbreviations.
1535 The car of each element is a string, to be replaced at the start of a link.
1536 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1537 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1539 [[linkkey:tag][description]]
1541 The 'linkkey' must be a word word, starting with a letter, followed
1542 by letters, numbers, '-' or '_'.
1544 If REPLACE is a string, the tag will simply be appended to create the link.
1545 If the string contains \"%s\", the tag will be inserted there. If the string
1546 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1547 at that point (see the function `url-hexify-string'). If the string contains
1548 the specifier \"%(my-function)\", then the custom function `my-function' will
1549 be invoked: this function takes the tag as its only argument and must return
1550 a string.
1552 REPLACE may also be a function that will be called with the tag as the
1553 only argument to create the link, which should be returned as a string.
1555 See the manual for examples."
1556 :group 'org-link
1557 :type '(repeat
1558 (cons
1559 (string :tag "Protocol")
1560 (choice
1561 (string :tag "Format")
1562 (function)))))
1564 (defcustom org-descriptive-links t
1565 "Non-nil means Org will display descriptive links.
1566 E.g. [[http://orgmode.org][Org website]] will be displayed as
1567 \"Org Website\", hiding the link itself and just displaying its
1568 description. When set to `nil', Org will display the full links
1569 literally.
1571 You can interactively set the value of this variable by calling
1572 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1573 :group 'org-link
1574 :type 'boolean)
1576 (defcustom org-link-file-path-type 'adaptive
1577 "How the path name in file links should be stored.
1578 Valid values are:
1580 relative Relative to the current directory, i.e. the directory of the file
1581 into which the link is being inserted.
1582 absolute Absolute path, if possible with ~ for home directory.
1583 noabbrev Absolute path, no abbreviation of home directory.
1584 adaptive Use relative path for files in the current directory and sub-
1585 directories of it. For other files, use an absolute path."
1586 :group 'org-link
1587 :type '(choice
1588 (const relative)
1589 (const absolute)
1590 (const noabbrev)
1591 (const adaptive)))
1593 (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
1594 "Types of links that should be activated in Org-mode files.
1595 This is a list of symbols, each leading to the activation of a certain link
1596 type. In principle, it does not hurt to turn on most link types - there may
1597 be a small gain when turning off unused link types. The types are:
1599 bracket The recommended [[link][description]] or [[link]] links with hiding.
1600 angle Links in angular brackets that may contain whitespace like
1601 <bbdb:Carsten Dominik>.
1602 plain Plain links in normal text, no whitespace, like http://google.com.
1603 radio Text that is matched by a radio target, see manual for details.
1604 tag Tag settings in a headline (link to tag search).
1605 date Time stamps (link to calendar).
1606 footnote Footnote labels.
1608 Changing this variable requires a restart of Emacs to become effective."
1609 :group 'org-link
1610 :type '(set :greedy t
1611 (const :tag "Double bracket links" bracket)
1612 (const :tag "Angular bracket links" angle)
1613 (const :tag "Plain text links" plain)
1614 (const :tag "Radio target matches" radio)
1615 (const :tag "Tags" tag)
1616 (const :tag "Timestamps" date)
1617 (const :tag "Footnotes" footnote)))
1619 (defcustom org-make-link-description-function nil
1620 "Function to use for generating link descriptions from links.
1621 When nil, the link location will be used. This function must take
1622 two parameters: the first one is the link, the second one is the
1623 description generated by `org-insert-link'. The function should
1624 return the description to use."
1625 :group 'org-link
1626 :type '(choice (const nil) (function)))
1628 (defgroup org-link-store nil
1629 "Options concerning storing links in Org-mode."
1630 :tag "Org Store Link"
1631 :group 'org-link)
1633 (defcustom org-url-hexify-p t
1634 "When non-nil, hexify URL when creating a link."
1635 :type 'boolean
1636 :version "24.3"
1637 :group 'org-link-store)
1639 (defcustom org-email-link-description-format "Email %c: %.30s"
1640 "Format of the description part of a link to an email or usenet message.
1641 The following %-escapes will be replaced by corresponding information:
1643 %F full \"From\" field
1644 %f name, taken from \"From\" field, address if no name
1645 %T full \"To\" field
1646 %t first name in \"To\" field, address if no name
1647 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1648 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1649 %s subject
1650 %d date
1651 %m message-id.
1653 You may use normal field width specification between the % and the letter.
1654 This is for example useful to limit the length of the subject.
1656 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1657 :group 'org-link-store
1658 :type 'string)
1660 (defcustom org-from-is-user-regexp
1661 (let (r1 r2)
1662 (when (and user-mail-address (not (string= user-mail-address "")))
1663 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1664 (when (and user-full-name (not (string= user-full-name "")))
1665 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1666 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1667 "Regexp matched against the \"From:\" header of an email or usenet message.
1668 It should match if the message is from the user him/herself."
1669 :group 'org-link-store
1670 :type 'regexp)
1672 (defcustom org-context-in-file-links t
1673 "Non-nil means file links from `org-store-link' contain context.
1674 A search string will be added to the file name with :: as separator and
1675 used to find the context when the link is activated by the command
1676 `org-open-at-point'. When this option is t, the entire active region
1677 will be placed in the search string of the file link. If set to a
1678 positive integer, only the first n lines of context will be stored.
1680 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1681 negates this setting for the duration of the command."
1682 :group 'org-link-store
1683 :type '(choice boolean integer))
1685 (defcustom org-keep-stored-link-after-insertion nil
1686 "Non-nil means keep link in list for entire session.
1688 The command `org-store-link' adds a link pointing to the current
1689 location to an internal list. These links accumulate during a session.
1690 The command `org-insert-link' can be used to insert links into any
1691 Org-mode file (offering completion for all stored links). When this
1692 option is nil, every link which has been inserted once using \\[org-insert-link]
1693 will be removed from the list, to make completing the unused links
1694 more efficient."
1695 :group 'org-link-store
1696 :type 'boolean)
1698 (defgroup org-link-follow nil
1699 "Options concerning following links in Org-mode."
1700 :tag "Org Follow Link"
1701 :group 'org-link)
1703 (defcustom org-link-translation-function nil
1704 "Function to translate links with different syntax to Org syntax.
1705 This can be used to translate links created for example by the Planner
1706 or emacs-wiki packages to Org syntax.
1707 The function must accept two parameters, a TYPE containing the link
1708 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1709 which is everything after the link protocol. It should return a cons
1710 with possibly modified values of type and path.
1711 Org contains a function for this, so if you set this variable to
1712 `org-translate-link-from-planner', you should be able follow many
1713 links created by planner."
1714 :group 'org-link-follow
1715 :type '(choice (const nil) (function)))
1717 (defcustom org-follow-link-hook nil
1718 "Hook that is run after a link has been followed."
1719 :group 'org-link-follow
1720 :type 'hook)
1722 (defcustom org-tab-follows-link nil
1723 "Non-nil means on links TAB will follow the link.
1724 Needs to be set before org.el is loaded.
1725 This really should not be used, it does not make sense, and the
1726 implementation is bad."
1727 :group 'org-link-follow
1728 :type 'boolean)
1730 (defcustom org-return-follows-link nil
1731 "Non-nil means on links RET will follow the link.
1732 In tables, the special behavior of RET has precedence."
1733 :group 'org-link-follow
1734 :type 'boolean)
1736 (defcustom org-mouse-1-follows-link
1737 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1738 "Non-nil means mouse-1 on a link will follow the link.
1739 A longer mouse click will still set point. Does not work on XEmacs.
1740 Needs to be set before org.el is loaded."
1741 :group 'org-link-follow
1742 :version "24.4"
1743 :package-version '(Org . "8.3")
1744 :type '(choice
1745 (const :tag "A double click follows the link" double)
1746 (const :tag "Unconditionally follow the link with mouse-1" t)
1747 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1749 (defcustom org-mark-ring-length 4
1750 "Number of different positions to be recorded in the ring.
1751 Changing this requires a restart of Emacs to work correctly."
1752 :group 'org-link-follow
1753 :type 'integer)
1755 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1756 "Non-nil means internal links in Org files must exactly match a headline.
1757 When nil, the link search tries to match a phrase with all words
1758 in the search text."
1759 :group 'org-link-follow
1760 :version "24.1"
1761 :type '(choice
1762 (const :tag "Use fuzzy text search" nil)
1763 (const :tag "Match only exact headline" t)
1764 (const :tag "Match exact headline or query to create it"
1765 query-to-create)))
1767 (defcustom org-link-frame-setup
1768 '((vm . vm-visit-folder-other-frame)
1769 (vm-imap . vm-visit-imap-folder-other-frame)
1770 (gnus . org-gnus-no-new-news)
1771 (file . find-file-other-window)
1772 (wl . wl-other-frame))
1773 "Setup the frame configuration for following links.
1774 When following a link with Emacs, it may often be useful to display
1775 this link in another window or frame. This variable can be used to
1776 set this up for the different types of links.
1777 For VM, use any of
1778 `vm-visit-folder'
1779 `vm-visit-folder-other-window'
1780 `vm-visit-folder-other-frame'
1781 For Gnus, use any of
1782 `gnus'
1783 `gnus-other-frame'
1784 `org-gnus-no-new-news'
1785 For FILE, use any of
1786 `find-file'
1787 `find-file-other-window'
1788 `find-file-other-frame'
1789 For Wanderlust use any of
1790 `wl'
1791 `wl-other-frame'
1792 For the calendar, use the variable `calendar-setup'.
1793 For BBDB, it is currently only possible to display the matches in
1794 another window."
1795 :group 'org-link-follow
1796 :type '(list
1797 (cons (const vm)
1798 (choice
1799 (const vm-visit-folder)
1800 (const vm-visit-folder-other-window)
1801 (const vm-visit-folder-other-frame)))
1802 (cons (const vm-imap)
1803 (choice
1804 (const vm-visit-imap-folder)
1805 (const vm-visit-imap-folder-other-window)
1806 (const vm-visit-imap-folder-other-frame)))
1807 (cons (const gnus)
1808 (choice
1809 (const gnus)
1810 (const gnus-other-frame)
1811 (const org-gnus-no-new-news)))
1812 (cons (const file)
1813 (choice
1814 (const find-file)
1815 (const find-file-other-window)
1816 (const find-file-other-frame)))
1817 (cons (const wl)
1818 (choice
1819 (const wl)
1820 (const wl-other-frame)))))
1822 (defcustom org-display-internal-link-with-indirect-buffer nil
1823 "Non-nil means use indirect buffer to display infile links.
1824 Activating internal links (from one location in a file to another location
1825 in the same file) normally just jumps to the location. When the link is
1826 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1827 is displayed in
1828 another window. When this option is set, the other window actually displays
1829 an indirect buffer clone of the current buffer, to avoid any visibility
1830 changes to the current buffer."
1831 :group 'org-link-follow
1832 :type 'boolean)
1834 (defcustom org-open-non-existing-files nil
1835 "Non-nil means `org-open-file' will open non-existing files.
1836 When nil, an error will be generated.
1837 This variable applies only to external applications because they
1838 might choke on non-existing files. If the link is to a file that
1839 will be opened in Emacs, the variable is ignored."
1840 :group 'org-link-follow
1841 :type 'boolean)
1843 (defcustom org-open-directory-means-index-dot-org nil
1844 "Non-nil means a link to a directory really means to index.org.
1845 When nil, following a directory link will run dired or open a finder/explorer
1846 window on that directory."
1847 :group 'org-link-follow
1848 :type 'boolean)
1850 (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
1851 "Function and arguments to call for following mailto links.
1852 This is a list with the first element being a Lisp function, and the
1853 remaining elements being arguments to the function. In string arguments,
1854 %a will be replaced by the address, and %s will be replaced by the subject
1855 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1856 :group 'org-link-follow
1857 :type '(choice
1858 (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1859 (const :tag "compose-mail" (compose-mail "%a" "%s"))
1860 (const :tag "message-mail" (message-mail "%a" "%s"))
1861 (cons :tag "other" (function) (repeat :tag "argument" sexp))))
1863 (defcustom org-confirm-shell-link-function 'yes-or-no-p
1864 "Non-nil means ask for confirmation before executing shell links.
1865 Shell links can be dangerous: just think about a link
1867 [[shell:rm -rf ~/*][Google Search]]
1869 This link would show up in your Org-mode document as \"Google Search\",
1870 but really it would remove your entire home directory.
1871 Therefore we advise against setting this variable to nil.
1872 Just change it to `y-or-n-p' if you want to confirm with a
1873 single keystroke rather than having to type \"yes\"."
1874 :group 'org-link-follow
1875 :type '(choice
1876 (const :tag "with yes-or-no (safer)" yes-or-no-p)
1877 (const :tag "with y-or-n (faster)" y-or-n-p)
1878 (const :tag "no confirmation (dangerous)" nil)))
1879 (put 'org-confirm-shell-link-function
1880 'safe-local-variable
1881 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1883 (defcustom org-confirm-shell-link-not-regexp ""
1884 "A regexp to skip confirmation for shell links."
1885 :group 'org-link-follow
1886 :version "24.1"
1887 :type 'regexp)
1889 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
1890 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1891 Elisp links can be dangerous: just think about a link
1893 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
1895 This link would show up in your Org-mode document as \"Google Search\",
1896 but really it would remove your entire home directory.
1897 Therefore we advise against setting this variable to nil.
1898 Just change it to `y-or-n-p' if you want to confirm with a
1899 single keystroke rather than having to type \"yes\"."
1900 :group 'org-link-follow
1901 :type '(choice
1902 (const :tag "with yes-or-no (safer)" yes-or-no-p)
1903 (const :tag "with y-or-n (faster)" y-or-n-p)
1904 (const :tag "no confirmation (dangerous)" nil)))
1905 (put 'org-confirm-shell-link-function
1906 'safe-local-variable
1907 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1909 (defcustom org-confirm-elisp-link-not-regexp ""
1910 "A regexp to skip confirmation for Elisp links."
1911 :group 'org-link-follow
1912 :version "24.1"
1913 :type 'regexp)
1915 (defconst org-file-apps-defaults-gnu
1916 '((remote . emacs)
1917 (system . mailcap)
1918 (t . mailcap))
1919 "Default file applications on a UNIX or GNU/Linux system.
1920 See `org-file-apps'.")
1922 (defconst org-file-apps-defaults-macosx
1923 '((remote . emacs)
1924 (t . "open %s")
1925 (system . "open %s")
1926 ("ps.gz" . "gv %s")
1927 ("eps.gz" . "gv %s")
1928 ("dvi" . "xdvi %s")
1929 ("fig" . "xfig %s"))
1930 "Default file applications on a MacOS X system.
1931 The system \"open\" is known as a default, but we use X11 applications
1932 for some files for which the OS does not have a good default.
1933 See `org-file-apps'.")
1935 (defconst org-file-apps-defaults-windowsnt
1936 (list
1937 '(remote . emacs)
1938 (cons t
1939 (list (if (featurep 'xemacs)
1940 'mswindows-shell-execute
1941 'w32-shell-execute)
1942 "open" 'file))
1943 (cons 'system
1944 (list (if (featurep 'xemacs)
1945 'mswindows-shell-execute
1946 'w32-shell-execute)
1947 "open" 'file)))
1948 "Default file applications on a Windows NT system.
1949 The system \"open\" is used for most files.
1950 See `org-file-apps'.")
1952 (defcustom org-file-apps
1953 '((auto-mode . emacs)
1954 ("\\.mm\\'" . default)
1955 ("\\.x?html?\\'" . default)
1956 ("\\.pdf\\'" . default))
1957 "External applications for opening `file:path' items in a document.
1958 Org-mode uses system defaults for different file types, but
1959 you can use this variable to set the application for a given file
1960 extension. The entries in this list are cons cells where the car identifies
1961 files and the cdr the corresponding command. Possible values for the
1962 file identifier are
1963 \"string\" A string as a file identifier can be interpreted in different
1964 ways, depending on its contents:
1966 - Alphanumeric characters only:
1967 Match links with this file extension.
1968 Example: (\"pdf\" . \"evince %s\")
1969 to open PDFs with evince.
1971 - Regular expression: Match links where the
1972 filename matches the regexp. If you want to
1973 use groups here, use shy groups.
1975 Example: (\"\\.x?html\\'\" . \"firefox %s\")
1976 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
1977 to open *.html and *.xhtml with firefox.
1979 - Regular expression which contains (non-shy) groups:
1980 Match links where the whole link, including \"::\", and
1981 anything after that, matches the regexp.
1982 In a custom command string, %1, %2, etc. are replaced with
1983 the parts of the link that were matched by the groups.
1984 For backwards compatibility, if a command string is given
1985 that does not use any of the group matches, this case is
1986 handled identically to the second one (i.e. match against
1987 file name only).
1988 In a custom lisp form, you can access the group matches with
1989 (match-string n link).
1991 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
1992 to open [[file:document.pdf::5]] with evince at page 5.
1994 `directory' Matches a directory
1995 `remote' Matches a remote file, accessible through tramp or efs.
1996 Remote files most likely should be visited through Emacs
1997 because external applications cannot handle such paths.
1998 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1999 so all files Emacs knows how to handle. Using this with
2000 command `emacs' will open most files in Emacs. Beware that this
2001 will also open html files inside Emacs, unless you add
2002 (\"html\" . default) to the list as well.
2003 t Default for files not matched by any of the other options.
2004 `system' The system command to open files, like `open' on Windows
2005 and Mac OS X, and mailcap under GNU/Linux. This is the command
2006 that will be selected if you call `C-c C-o' with a double
2007 \\[universal-argument] \\[universal-argument] prefix.
2009 Possible values for the command are:
2010 `emacs' The file will be visited by the current Emacs process.
2011 `default' Use the default application for this file type, which is the
2012 association for t in the list, most likely in the system-specific
2013 part.
2014 This can be used to overrule an unwanted setting in the
2015 system-specific variable.
2016 `system' Use the system command for opening files, like \"open\".
2017 This command is specified by the entry whose car is `system'.
2018 Most likely, the system-specific version of this variable
2019 does define this command, but you can overrule/replace it
2020 here.
2021 string A command to be executed by a shell; %s will be replaced
2022 by the path to the file.
2023 sexp A Lisp form which will be evaluated. The file path will
2024 be available in the Lisp variable `file'.
2025 For more examples, see the system specific constants
2026 `org-file-apps-defaults-macosx'
2027 `org-file-apps-defaults-windowsnt'
2028 `org-file-apps-defaults-gnu'."
2029 :group 'org-link-follow
2030 :type '(repeat
2031 (cons (choice :value ""
2032 (string :tag "Extension")
2033 (const :tag "System command to open files" system)
2034 (const :tag "Default for unrecognized files" t)
2035 (const :tag "Remote file" remote)
2036 (const :tag "Links to a directory" directory)
2037 (const :tag "Any files that have Emacs modes"
2038 auto-mode))
2039 (choice :value ""
2040 (const :tag "Visit with Emacs" emacs)
2041 (const :tag "Use default" default)
2042 (const :tag "Use the system command" system)
2043 (string :tag "Command")
2044 (sexp :tag "Lisp form")))))
2046 (defcustom org-doi-server-url "http://dx.doi.org/"
2047 "The URL of the DOI server."
2048 :type 'string
2049 :version "24.3"
2050 :group 'org-link-follow)
2052 (defgroup org-refile nil
2053 "Options concerning refiling entries in Org-mode."
2054 :tag "Org Refile"
2055 :group 'org)
2057 (defcustom org-directory "~/org"
2058 "Directory with org files.
2059 This is just a default location to look for Org files. There is no need
2060 at all to put your files into this directory. It is only used in the
2061 following situations:
2063 1. When a capture template specifies a target file that is not an
2064 absolute path. The path will then be interpreted relative to
2065 `org-directory'
2066 2. When a capture note is filed away in an interactive way (when exiting the
2067 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2068 with `org-directory' as the default path."
2069 :group 'org-refile
2070 :group 'org-capture
2071 :type 'directory)
2073 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2074 "Default target for storing notes.
2075 Used as a fall back file for org-capture.el, for templates that
2076 do not specify a target file."
2077 :group 'org-refile
2078 :group 'org-capture
2079 :type '(choice
2080 (const :tag "Default from remember-data-file" nil)
2081 file))
2083 (defcustom org-goto-interface 'outline
2084 "The default interface to be used for `org-goto'.
2085 Allowed values are:
2086 outline The interface shows an outline of the relevant file
2087 and the correct heading is found by moving through
2088 the outline or by searching with incremental search.
2089 outline-path-completion Headlines in the current buffer are offered via
2090 completion. This is the interface also used by
2091 the refile command."
2092 :group 'org-refile
2093 :type '(choice
2094 (const :tag "Outline" outline)
2095 (const :tag "Outline-path-completion" outline-path-completion)))
2097 (defcustom org-goto-max-level 5
2098 "Maximum target level when running `org-goto' with refile interface."
2099 :group 'org-refile
2100 :type 'integer)
2102 (defcustom org-reverse-note-order nil
2103 "Non-nil means store new notes at the beginning of a file or entry.
2104 When nil, new notes will be filed to the end of a file or entry.
2105 This can also be a list with cons cells of regular expressions that
2106 are matched against file names, and values."
2107 :group 'org-capture
2108 :group 'org-refile
2109 :type '(choice
2110 (const :tag "Reverse always" t)
2111 (const :tag "Reverse never" nil)
2112 (repeat :tag "By file name regexp"
2113 (cons regexp boolean))))
2115 (defcustom org-log-refile nil
2116 "Information to record when a task is refiled.
2118 Possible values are:
2120 nil Don't add anything
2121 time Add a time stamp to the task
2122 note Prompt for a note and add it with template `org-log-note-headings'
2124 This option can also be set with on a per-file-basis with
2126 #+STARTUP: nologrefile
2127 #+STARTUP: logrefile
2128 #+STARTUP: lognoterefile
2130 You can have local logging settings for a subtree by setting the LOGGING
2131 property to one or more of these keywords.
2133 When bulk-refiling from the agenda, the value `note' is forbidden and
2134 will temporarily be changed to `time'."
2135 :group 'org-refile
2136 :group 'org-progress
2137 :version "24.1"
2138 :type '(choice
2139 (const :tag "No logging" nil)
2140 (const :tag "Record timestamp" time)
2141 (const :tag "Record timestamp with note." note)))
2143 (defcustom org-refile-targets nil
2144 "Targets for refiling entries with \\[org-refile].
2145 This is a list of cons cells. Each cell contains:
2146 - a specification of the files to be considered, either a list of files,
2147 or a symbol whose function or variable value will be used to retrieve
2148 a file name or a list of file names. If you use `org-agenda-files' for
2149 that, all agenda files will be scanned for targets. Nil means consider
2150 headings in the current buffer.
2151 - A specification of how to find candidate refile targets. This may be
2152 any of:
2153 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2154 This tag has to be present in all target headlines, inheritance will
2155 not be considered.
2156 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2157 todo keyword.
2158 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2159 headlines that are refiling targets.
2160 - a cons cell (:level . N). Any headline of level N is considered a target.
2161 Note that, when `org-odd-levels-only' is set, level corresponds to
2162 order in hierarchy, not to the number of stars.
2163 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2164 Note that, when `org-odd-levels-only' is set, level corresponds to
2165 order in hierarchy, not to the number of stars.
2167 Each element of this list generates a set of possible targets.
2168 The union of these sets is presented (with completion) to
2169 the user by `org-refile'.
2171 You can set the variable `org-refile-target-verify-function' to a function
2172 to verify each headline found by the simple criteria above.
2174 When this variable is nil, all top-level headlines in the current buffer
2175 are used, equivalent to the value `((nil . (:level . 1))'."
2176 :group 'org-refile
2177 :type '(repeat
2178 (cons
2179 (choice :value org-agenda-files
2180 (const :tag "All agenda files" org-agenda-files)
2181 (const :tag "Current buffer" nil)
2182 (function) (variable) (file))
2183 (choice :tag "Identify target headline by"
2184 (cons :tag "Specific tag" (const :value :tag) (string))
2185 (cons :tag "TODO keyword" (const :value :todo) (string))
2186 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2187 (cons :tag "Level number" (const :value :level) (integer))
2188 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2190 (defcustom org-refile-target-verify-function nil
2191 "Function to verify if the headline at point should be a refile target.
2192 The function will be called without arguments, with point at the
2193 beginning of the headline. It should return t and leave point
2194 where it is if the headline is a valid target for refiling.
2196 If the target should not be selected, the function must return nil.
2197 In addition to this, it may move point to a place from where the search
2198 should be continued. For example, the function may decide that the entire
2199 subtree of the current entry should be excluded and move point to the end
2200 of the subtree."
2201 :group 'org-refile
2202 :type '(choice
2203 (const nil)
2204 (function)))
2206 (defcustom org-refile-use-cache nil
2207 "Non-nil means cache refile targets to speed up the process.
2208 The cache for a particular file will be updated automatically when
2209 the buffer has been killed, or when any of the marker used for flagging
2210 refile targets no longer points at a live buffer.
2211 If you have added new entries to a buffer that might themselves be targets,
2212 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2213 find that easier, `C-u C-u C-u C-c C-w'."
2214 :group 'org-refile
2215 :version "24.1"
2216 :type 'boolean)
2218 (defcustom org-refile-use-outline-path nil
2219 "Non-nil means provide refile targets as paths.
2220 So a level 3 headline will be available as level1/level2/level3.
2222 When the value is `file', also include the file name (without directory)
2223 into the path. In this case, you can also stop the completion after
2224 the file name, to get entries inserted as top level in the file.
2226 When `full-file-path', include the full file path."
2227 :group 'org-refile
2228 :type '(choice
2229 (const :tag "Not" nil)
2230 (const :tag "Yes" t)
2231 (const :tag "Start with file name" file)
2232 (const :tag "Start with full file path" full-file-path)))
2234 (defcustom org-outline-path-complete-in-steps t
2235 "Non-nil means complete the outline path in hierarchical steps.
2236 When Org-mode uses the refile interface to select an outline path
2237 \(see variable `org-refile-use-outline-path'), the completion of
2238 the path can be done is a single go, or if can be done in steps down
2239 the headline hierarchy. Going in steps is probably the best if you
2240 do not use a special completion package like `ido' or `icicles'.
2241 However, when using these packages, going in one step can be very
2242 fast, while still showing the whole path to the entry."
2243 :group 'org-refile
2244 :type 'boolean)
2246 (defcustom org-refile-allow-creating-parent-nodes nil
2247 "Non-nil means allow to create new nodes as refile targets.
2248 New nodes are then created by adding \"/new node name\" to the completion
2249 of an existing node. When the value of this variable is `confirm',
2250 new node creation must be confirmed by the user (recommended).
2251 When nil, the completion must match an existing entry.
2253 Note that, if the new heading is not seen by the criteria
2254 listed in `org-refile-targets', multiple instances of the same
2255 heading would be created by trying again to file under the new
2256 heading."
2257 :group 'org-refile
2258 :type '(choice
2259 (const :tag "Never" nil)
2260 (const :tag "Always" t)
2261 (const :tag "Prompt for confirmation" confirm)))
2263 (defcustom org-refile-active-region-within-subtree nil
2264 "Non-nil means also refile active region within a subtree.
2266 By default `org-refile' doesn't allow refiling regions if they
2267 don't contain a set of subtrees, but it might be convenient to
2268 do so sometimes: in that case, the first line of the region is
2269 converted to a headline before refiling."
2270 :group 'org-refile
2271 :version "24.1"
2272 :type 'boolean)
2274 (defgroup org-todo nil
2275 "Options concerning TODO items in Org-mode."
2276 :tag "Org TODO"
2277 :group 'org)
2279 (defgroup org-progress nil
2280 "Options concerning Progress logging in Org-mode."
2281 :tag "Org Progress"
2282 :group 'org-time)
2284 (defvar org-todo-interpretation-widgets
2285 '((:tag "Sequence (cycling hits every state)" sequence)
2286 (:tag "Type (cycling directly to DONE)" type))
2287 "The available interpretation symbols for customizing `org-todo-keywords'.
2288 Interested libraries should add to this list.")
2290 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2291 "List of TODO entry keyword sequences and their interpretation.
2292 \\<org-mode-map>This is a list of sequences.
2294 Each sequence starts with a symbol, either `sequence' or `type',
2295 indicating if the keywords should be interpreted as a sequence of
2296 action steps, or as different types of TODO items. The first
2297 keywords are states requiring action - these states will select a headline
2298 for inclusion into the global TODO list Org-mode produces. If one of
2299 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2300 signify that no further action is necessary. If \"|\" is not found,
2301 the last keyword is treated as the only DONE state of the sequence.
2303 The command \\[org-todo] cycles an entry through these states, and one
2304 additional state where no keyword is present. For details about this
2305 cycling, see the manual.
2307 TODO keywords and interpretation can also be set on a per-file basis with
2308 the special #+SEQ_TODO and #+TYP_TODO lines.
2310 Each keyword can optionally specify a character for fast state selection
2311 \(in combination with the variable `org-use-fast-todo-selection')
2312 and specifiers for state change logging, using the same syntax that
2313 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2314 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2315 indicates to record a time stamp each time this state is selected.
2317 Each keyword may also specify if a timestamp or a note should be
2318 recorded when entering or leaving the state, by adding additional
2319 characters in the parenthesis after the keyword. This looks like this:
2320 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2321 record only the time of the state change. With X and Y being either
2322 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2323 Y when leaving the state if and only if the *target* state does not
2324 define X. You may omit any of the fast-selection key or X or /Y,
2325 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2327 For backward compatibility, this variable may also be just a list
2328 of keywords. In this case the interpretation (sequence or type) will be
2329 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2330 :group 'org-todo
2331 :group 'org-keywords
2332 :type '(choice
2333 (repeat :tag "Old syntax, just keywords"
2334 (string :tag "Keyword"))
2335 (repeat :tag "New syntax"
2336 (cons
2337 (choice
2338 :tag "Interpretation"
2339 ;;Quick and dirty way to see
2340 ;;`org-todo-interpretations'. This takes the
2341 ;;place of item arguments
2342 :convert-widget
2343 (lambda (widget)
2344 (widget-put widget
2345 :args (mapcar
2346 #'(lambda (x)
2347 (widget-convert
2348 (cons 'const x)))
2349 org-todo-interpretation-widgets))
2350 widget))
2351 (repeat
2352 (string :tag "Keyword"))))))
2354 (defvar org-todo-keywords-1 nil
2355 "All TODO and DONE keywords active in a buffer.")
2356 (make-variable-buffer-local 'org-todo-keywords-1)
2357 (defvar org-todo-keywords-for-agenda nil)
2358 (defvar org-done-keywords-for-agenda nil)
2359 (defvar org-drawers-for-agenda nil)
2360 (defvar org-todo-keyword-alist-for-agenda nil)
2361 (defvar org-tag-alist-for-agenda nil
2362 "Alist of all tags from all agenda files.")
2363 (defvar org-tag-groups-alist-for-agenda nil
2364 "Alist of all groups tags from all current agenda files.")
2365 (defvar org-tag-groups-alist nil)
2366 (make-variable-buffer-local 'org-tag-groups-alist)
2367 (defvar org-agenda-contributing-files nil)
2368 (defvar org-not-done-keywords nil)
2369 (make-variable-buffer-local 'org-not-done-keywords)
2370 (defvar org-done-keywords nil)
2371 (make-variable-buffer-local 'org-done-keywords)
2372 (defvar org-todo-heads nil)
2373 (make-variable-buffer-local 'org-todo-heads)
2374 (defvar org-todo-sets nil)
2375 (make-variable-buffer-local 'org-todo-sets)
2376 (defvar org-todo-log-states nil)
2377 (make-variable-buffer-local 'org-todo-log-states)
2378 (defvar org-todo-kwd-alist nil)
2379 (make-variable-buffer-local 'org-todo-kwd-alist)
2380 (defvar org-todo-key-alist nil)
2381 (make-variable-buffer-local 'org-todo-key-alist)
2382 (defvar org-todo-key-trigger nil)
2383 (make-variable-buffer-local 'org-todo-key-trigger)
2385 (defcustom org-todo-interpretation 'sequence
2386 "Controls how TODO keywords are interpreted.
2387 This variable is in principle obsolete and is only used for
2388 backward compatibility, if the interpretation of todo keywords is
2389 not given already in `org-todo-keywords'. See that variable for
2390 more information."
2391 :group 'org-todo
2392 :group 'org-keywords
2393 :type '(choice (const sequence)
2394 (const type)))
2396 (defcustom org-use-fast-todo-selection t
2397 "Non-nil means use the fast todo selection scheme with C-c C-t.
2398 This variable describes if and under what circumstances the cycling
2399 mechanism for TODO keywords will be replaced by a single-key, direct
2400 selection scheme.
2402 When nil, fast selection is never used.
2404 When the symbol `prefix', it will be used when `org-todo' is called
2405 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2406 `C-u t' in an agenda buffer.
2408 When t, fast selection is used by default. In this case, the prefix
2409 argument forces cycling instead.
2411 In all cases, the special interface is only used if access keys have
2412 actually been assigned by the user, i.e. if keywords in the configuration
2413 are followed by a letter in parenthesis, like TODO(t)."
2414 :group 'org-todo
2415 :type '(choice
2416 (const :tag "Never" nil)
2417 (const :tag "By default" t)
2418 (const :tag "Only with C-u C-c C-t" prefix)))
2420 (defcustom org-provide-todo-statistics t
2421 "Non-nil means update todo statistics after insert and toggle.
2422 ALL-HEADLINES means update todo statistics by including headlines
2423 with no TODO keyword as well, counting them as not done.
2424 A list of TODO keywords means the same, but skip keywords that are
2425 not in this list.
2427 When this is set, todo statistics is updated in the parent of the
2428 current entry each time a todo state is changed."
2429 :group 'org-todo
2430 :type '(choice
2431 (const :tag "Yes, only for TODO entries" t)
2432 (const :tag "Yes, including all entries" all-headlines)
2433 (repeat :tag "Yes, for TODOs in this list"
2434 (string :tag "TODO keyword"))
2435 (other :tag "No TODO statistics" nil)))
2437 (defcustom org-hierarchical-todo-statistics t
2438 "Non-nil means TODO statistics covers just direct children.
2439 When nil, all entries in the subtree are considered.
2440 This has only an effect if `org-provide-todo-statistics' is set.
2441 To set this to nil for only a single subtree, use a COOKIE_DATA
2442 property and include the word \"recursive\" into the value."
2443 :group 'org-todo
2444 :type 'boolean)
2446 (defcustom org-after-todo-state-change-hook nil
2447 "Hook which is run after the state of a TODO item was changed.
2448 The new state (a string with a TODO keyword, or nil) is available in the
2449 Lisp variable `org-state'."
2450 :group 'org-todo
2451 :type 'hook)
2453 (defvar org-blocker-hook nil
2454 "Hook for functions that are allowed to block a state change.
2456 Functions in this hook should not modify the buffer.
2457 Each function gets as its single argument a property list,
2458 see `org-trigger-hook' for more information about this list.
2460 If any of the functions in this hook returns nil, the state change
2461 is blocked.")
2463 (defvar org-trigger-hook nil
2464 "Hook for functions that are triggered by a state change.
2466 Each function gets as its single argument a property list with at
2467 least the following elements:
2469 (:type type-of-change :position pos-at-entry-start
2470 :from old-state :to new-state)
2472 Depending on the type, more properties may be present.
2474 This mechanism is currently implemented for:
2476 TODO state changes
2477 ------------------
2478 :type todo-state-change
2479 :from previous state (keyword as a string), or nil, or a symbol
2480 'todo' or 'done', to indicate the general type of state.
2481 :to new state, like in :from")
2483 (defcustom org-enforce-todo-dependencies nil
2484 "Non-nil means undone TODO entries will block switching the parent to DONE.
2485 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2486 be blocked if any prior sibling is not yet done.
2487 Finally, if the parent is blocked because of ordered siblings of its own,
2488 the child will also be blocked."
2489 :set (lambda (var val)
2490 (set var val)
2491 (if val
2492 (add-hook 'org-blocker-hook
2493 'org-block-todo-from-children-or-siblings-or-parent)
2494 (remove-hook 'org-blocker-hook
2495 'org-block-todo-from-children-or-siblings-or-parent)))
2496 :group 'org-todo
2497 :type 'boolean)
2499 (defcustom org-enforce-todo-checkbox-dependencies nil
2500 "Non-nil means unchecked boxes will block switching the parent to DONE.
2501 When this is nil, checkboxes have no influence on switching TODO states.
2502 When non-nil, you first need to check off all check boxes before the TODO
2503 entry can be switched to DONE.
2504 This variable needs to be set before org.el is loaded, and you need to
2505 restart Emacs after a change to make the change effective. The only way
2506 to change is while Emacs is running is through the customize interface."
2507 :set (lambda (var val)
2508 (set var val)
2509 (if val
2510 (add-hook 'org-blocker-hook
2511 'org-block-todo-from-checkboxes)
2512 (remove-hook 'org-blocker-hook
2513 'org-block-todo-from-checkboxes)))
2514 :group 'org-todo
2515 :type 'boolean)
2517 (defcustom org-treat-insert-todo-heading-as-state-change nil
2518 "Non-nil means inserting a TODO heading is treated as state change.
2519 So when the command \\[org-insert-todo-heading] is used, state change
2520 logging will apply if appropriate. When nil, the new TODO item will
2521 be inserted directly, and no logging will take place."
2522 :group 'org-todo
2523 :type 'boolean)
2525 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2526 "Non-nil means switching TODO states with S-cursor counts as state change.
2527 This is the default behavior. However, setting this to nil allows a
2528 convenient way to select a TODO state and bypass any logging associated
2529 with that."
2530 :group 'org-todo
2531 :type 'boolean)
2533 (defcustom org-todo-state-tags-triggers nil
2534 "Tag changes that should be triggered by TODO state changes.
2535 This is a list. Each entry is
2537 (state-change (tag . flag) .......)
2539 State-change can be a string with a state, and empty string to indicate the
2540 state that has no TODO keyword, or it can be one of the symbols `todo'
2541 or `done', meaning any not-done or done state, respectively."
2542 :group 'org-todo
2543 :group 'org-tags
2544 :type '(repeat
2545 (cons (choice :tag "When changing to"
2546 (const :tag "Not-done state" todo)
2547 (const :tag "Done state" done)
2548 (string :tag "State"))
2549 (repeat
2550 (cons :tag "Tag action"
2551 (string :tag "Tag")
2552 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2554 (defcustom org-log-done nil
2555 "Information to record when a task moves to the DONE state.
2557 Possible values are:
2559 nil Don't add anything, just change the keyword
2560 time Add a time stamp to the task
2561 note Prompt for a note and add it with template `org-log-note-headings'
2563 This option can also be set with on a per-file-basis with
2565 #+STARTUP: nologdone
2566 #+STARTUP: logdone
2567 #+STARTUP: lognotedone
2569 You can have local logging settings for a subtree by setting the LOGGING
2570 property to one or more of these keywords."
2571 :group 'org-todo
2572 :group 'org-progress
2573 :type '(choice
2574 (const :tag "No logging" nil)
2575 (const :tag "Record CLOSED timestamp" time)
2576 (const :tag "Record CLOSED timestamp with note." note)))
2578 ;; Normalize old uses of org-log-done.
2579 (cond
2580 ((eq org-log-done t) (setq org-log-done 'time))
2581 ((and (listp org-log-done) (memq 'done org-log-done))
2582 (setq org-log-done 'note)))
2584 (defcustom org-log-reschedule nil
2585 "Information to record when the scheduling date of a tasks is modified.
2587 Possible values are:
2589 nil Don't add anything, just change the date
2590 time Add a time stamp to the task
2591 note Prompt for a note and add it with template `org-log-note-headings'
2593 This option can also be set with on a per-file-basis with
2595 #+STARTUP: nologreschedule
2596 #+STARTUP: logreschedule
2597 #+STARTUP: lognotereschedule"
2598 :group 'org-todo
2599 :group 'org-progress
2600 :type '(choice
2601 (const :tag "No logging" nil)
2602 (const :tag "Record timestamp" time)
2603 (const :tag "Record timestamp with note." note)))
2605 (defcustom org-log-redeadline nil
2606 "Information to record when the deadline date of a tasks is modified.
2608 Possible values are:
2610 nil Don't add anything, just change the date
2611 time Add a time stamp to the task
2612 note Prompt for a note and add it with template `org-log-note-headings'
2614 This option can also be set with on a per-file-basis with
2616 #+STARTUP: nologredeadline
2617 #+STARTUP: logredeadline
2618 #+STARTUP: lognoteredeadline
2620 You can have local logging settings for a subtree by setting the LOGGING
2621 property to one or more of these keywords."
2622 :group 'org-todo
2623 :group 'org-progress
2624 :type '(choice
2625 (const :tag "No logging" nil)
2626 (const :tag "Record timestamp" time)
2627 (const :tag "Record timestamp with note." note)))
2629 (defcustom org-log-note-clock-out nil
2630 "Non-nil means record a note when clocking out of an item.
2631 This can also be configured on a per-file basis by adding one of
2632 the following lines anywhere in the buffer:
2634 #+STARTUP: lognoteclock-out
2635 #+STARTUP: nolognoteclock-out"
2636 :group 'org-todo
2637 :group 'org-progress
2638 :type 'boolean)
2640 (defcustom org-log-done-with-time t
2641 "Non-nil means the CLOSED time stamp will contain date and time.
2642 When nil, only the date will be recorded."
2643 :group 'org-progress
2644 :type 'boolean)
2646 (defcustom org-log-note-headings
2647 '((done . "CLOSING NOTE %t")
2648 (state . "State %-12s from %-12S %t")
2649 (note . "Note taken on %t")
2650 (reschedule . "Rescheduled from %S on %t")
2651 (delschedule . "Not scheduled, was %S on %t")
2652 (redeadline . "New deadline from %S on %t")
2653 (deldeadline . "Removed deadline, was %S on %t")
2654 (refile . "Refiled on %t")
2655 (clock-out . ""))
2656 "Headings for notes added to entries.
2657 The value is an alist, with the car being a symbol indicating the note
2658 context, and the cdr is the heading to be used. The heading may also be the
2659 empty string.
2660 %t in the heading will be replaced by a time stamp.
2661 %T will be an active time stamp instead the default inactive one
2662 %d will be replaced by a short-format time stamp.
2663 %D will be replaced by an active short-format time stamp.
2664 %s will be replaced by the new TODO state, in double quotes.
2665 %S will be replaced by the old TODO state, in double quotes.
2666 %u will be replaced by the user name.
2667 %U will be replaced by the full user name.
2669 In fact, it is not a good idea to change the `state' entry, because
2670 agenda log mode depends on the format of these entries."
2671 :group 'org-todo
2672 :group 'org-progress
2673 :type '(list :greedy t
2674 (cons (const :tag "Heading when closing an item" done) string)
2675 (cons (const :tag
2676 "Heading when changing todo state (todo sequence only)"
2677 state) string)
2678 (cons (const :tag "Heading when just taking a note" note) string)
2679 (cons (const :tag "Heading when rescheduling" reschedule) string)
2680 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2681 (cons (const :tag "Heading when changing deadline" redeadline) string)
2682 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2683 (cons (const :tag "Heading when refiling" refile) string)
2684 (cons (const :tag "Heading when clocking out" clock-out) string)))
2686 (unless (assq 'note org-log-note-headings)
2687 (push '(note . "%t") org-log-note-headings))
2689 (defcustom org-log-into-drawer nil
2690 "Non-nil means insert state change notes and time stamps into a drawer.
2691 When nil, state changes notes will be inserted after the headline and
2692 any scheduling and clock lines, but not inside a drawer.
2694 The value of this variable should be the name of the drawer to use.
2695 LOGBOOK is proposed as the default drawer for this purpose, you can
2696 also set this to a string to define the drawer of your choice.
2698 A value of t is also allowed, representing \"LOGBOOK\".
2700 A value of t or nil can also be set with on a per-file-basis with
2702 #+STARTUP: logdrawer
2703 #+STARTUP: nologdrawer
2705 If this variable is set, `org-log-state-notes-insert-after-drawers'
2706 will be ignored.
2708 You can set the property LOG_INTO_DRAWER to overrule this setting for
2709 a subtree."
2710 :group 'org-todo
2711 :group 'org-progress
2712 :type '(choice
2713 (const :tag "Not into a drawer" nil)
2714 (const :tag "LOGBOOK" t)
2715 (string :tag "Other")))
2717 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2719 (defun org-log-into-drawer ()
2720 "Return the value of `org-log-into-drawer', but let properties overrule.
2721 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2722 used instead of the default value."
2723 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2724 (cond
2725 ((not p) org-log-into-drawer)
2726 ((equal p "nil") nil)
2727 ((equal p "t") "LOGBOOK")
2728 (t p))))
2730 (defcustom org-log-state-notes-insert-after-drawers nil
2731 "Non-nil means insert state change notes after any drawers in entry.
2732 Only the drawers that *immediately* follow the headline and the
2733 deadline/scheduled line are skipped.
2734 When nil, insert notes right after the heading and perhaps the line
2735 with deadline/scheduling if present.
2737 This variable will have no effect if `org-log-into-drawer' is
2738 set."
2739 :group 'org-todo
2740 :group 'org-progress
2741 :type 'boolean)
2743 (defcustom org-log-states-order-reversed t
2744 "Non-nil means the latest state note will be directly after heading.
2745 When nil, the state change notes will be ordered according to time.
2747 This option can also be set with on a per-file-basis with
2749 #+STARTUP: logstatesreversed
2750 #+STARTUP: nologstatesreversed"
2751 :group 'org-todo
2752 :group 'org-progress
2753 :type 'boolean)
2755 (defcustom org-todo-repeat-to-state nil
2756 "The TODO state to which a repeater should return the repeating task.
2757 By default this is the first task in a TODO sequence, or the previous state
2758 in a TODO_TYP set. But you can specify another task here.
2759 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2760 :group 'org-todo
2761 :version "24.1"
2762 :type '(choice (const :tag "Head of sequence" nil)
2763 (string :tag "Specific state")))
2765 (defcustom org-log-repeat 'time
2766 "Non-nil means record moving through the DONE state when triggering repeat.
2767 An auto-repeating task is immediately switched back to TODO when
2768 marked DONE. If you are not logging state changes (by adding \"@\"
2769 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2770 record a closing note, there will be no record of the task moving
2771 through DONE. This variable forces taking a note anyway.
2773 nil Don't force a record
2774 time Record a time stamp
2775 note Prompt for a note and add it with template `org-log-note-headings'
2777 This option can also be set with on a per-file-basis with
2779 #+STARTUP: nologrepeat
2780 #+STARTUP: logrepeat
2781 #+STARTUP: lognoterepeat
2783 You can have local logging settings for a subtree by setting the LOGGING
2784 property to one or more of these keywords."
2785 :group 'org-todo
2786 :group 'org-progress
2787 :type '(choice
2788 (const :tag "Don't force a record" nil)
2789 (const :tag "Force recording the DONE state" time)
2790 (const :tag "Force recording a note with the DONE state" note)))
2793 (defgroup org-priorities nil
2794 "Priorities in Org-mode."
2795 :tag "Org Priorities"
2796 :group 'org-todo)
2798 (defcustom org-enable-priority-commands t
2799 "Non-nil means priority commands are active.
2800 When nil, these commands will be disabled, so that you never accidentally
2801 set a priority."
2802 :group 'org-priorities
2803 :type 'boolean)
2805 (defcustom org-highest-priority ?A
2806 "The highest priority of TODO items. A character like ?A, ?B etc.
2807 Must have a smaller ASCII number than `org-lowest-priority'."
2808 :group 'org-priorities
2809 :type 'character)
2811 (defcustom org-lowest-priority ?C
2812 "The lowest priority of TODO items. A character like ?A, ?B etc.
2813 Must have a larger ASCII number than `org-highest-priority'."
2814 :group 'org-priorities
2815 :type 'character)
2817 (defcustom org-default-priority ?B
2818 "The default priority of TODO items.
2819 This is the priority an item gets if no explicit priority is given.
2820 When starting to cycle on an empty priority the first step in the cycle
2821 depends on `org-priority-start-cycle-with-default'. The resulting first
2822 step priority must not exceed the range from `org-highest-priority' to
2823 `org-lowest-priority' which means that `org-default-priority' has to be
2824 in this range exclusive or inclusive the range boundaries. Else the
2825 first step refuses to set the default and the second will fall back
2826 to (depending on the command used) the highest or lowest priority."
2827 :group 'org-priorities
2828 :type 'character)
2830 (defcustom org-priority-start-cycle-with-default t
2831 "Non-nil means start with default priority when starting to cycle.
2832 When this is nil, the first step in the cycle will be (depending on the
2833 command used) one higher or lower than the default priority.
2834 See also `org-default-priority'."
2835 :group 'org-priorities
2836 :type 'boolean)
2838 (defcustom org-get-priority-function nil
2839 "Function to extract the priority from a string.
2840 The string is normally the headline. If this is nil Org computes the
2841 priority from the priority cookie like [#A] in the headline. It returns
2842 an integer, increasing by 1000 for each priority level.
2843 The user can set a different function here, which should take a string
2844 as an argument and return the numeric priority."
2845 :group 'org-priorities
2846 :version "24.1"
2847 :type '(choice
2848 (const nil)
2849 (function)))
2851 (defgroup org-time nil
2852 "Options concerning time stamps and deadlines in Org-mode."
2853 :tag "Org Time"
2854 :group 'org)
2856 (defcustom org-insert-labeled-timestamps-at-point nil
2857 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2858 When nil, these labeled time stamps are forces into the second line of an
2859 entry, just after the headline. When scheduling from the global TODO list,
2860 the time stamp will always be forced into the second line."
2861 :group 'org-time
2862 :type 'boolean)
2864 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
2865 "Formats for `format-time-string' which are used for time stamps.
2866 It is not recommended to change this constant.")
2868 (defcustom org-time-stamp-rounding-minutes '(0 5)
2869 "Number of minutes to round time stamps to.
2870 These are two values, the first applies when first creating a time stamp.
2871 The second applies when changing it with the commands `S-up' and `S-down'.
2872 When changing the time stamp, this means that it will change in steps
2873 of N minutes, as given by the second value.
2875 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2876 numbers should be factors of 60, so for example 5, 10, 15.
2878 When this is larger than 1, you can still force an exact time stamp by using
2879 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2880 and by using a prefix arg to `S-up/down' to specify the exact number
2881 of minutes to shift."
2882 :group 'org-time
2883 :get #'(lambda (var) ; Make sure both elements are there
2884 (if (integerp (default-value var))
2885 (list (default-value var) 5)
2886 (default-value var)))
2887 :type '(list
2888 (integer :tag "when inserting times")
2889 (integer :tag "when modifying times")))
2891 ;; Normalize old customizations of this variable.
2892 (when (integerp org-time-stamp-rounding-minutes)
2893 (setq org-time-stamp-rounding-minutes
2894 (list org-time-stamp-rounding-minutes
2895 org-time-stamp-rounding-minutes)))
2897 (defcustom org-display-custom-times nil
2898 "Non-nil means overlay custom formats over all time stamps.
2899 The formats are defined through the variable `org-time-stamp-custom-formats'.
2900 To turn this on on a per-file basis, insert anywhere in the file:
2901 #+STARTUP: customtime"
2902 :group 'org-time
2903 :set 'set-default
2904 :type 'sexp)
2905 (make-variable-buffer-local 'org-display-custom-times)
2907 (defcustom org-time-stamp-custom-formats
2908 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
2909 "Custom formats for time stamps. See `format-time-string' for the syntax.
2910 These are overlaid over the default ISO format if the variable
2911 `org-display-custom-times' is set. Time like %H:%M should be at the
2912 end of the second format. The custom formats are also honored by export
2913 commands, if custom time display is turned on at the time of export."
2914 :group 'org-time
2915 :type 'sexp)
2917 (defun org-time-stamp-format (&optional long inactive)
2918 "Get the right format for a time string."
2919 (let ((f (if long (cdr org-time-stamp-formats)
2920 (car org-time-stamp-formats))))
2921 (if inactive
2922 (concat "[" (substring f 1 -1) "]")
2923 f)))
2925 (defcustom org-time-clocksum-format
2926 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
2927 "The format string used when creating CLOCKSUM lines.
2928 This is also used when Org mode generates a time duration.
2930 The value can be a single format string containing two
2931 %-sequences, which will be filled with the number of hours and
2932 minutes in that order.
2934 Alternatively, the value can be a plist associating any of the
2935 keys :years, :months, :weeks, :days, :hours or :minutes with
2936 format strings. The time duration is formatted using only the
2937 time components that are needed and concatenating the results.
2938 If a time unit in absent, it falls back to the next smallest
2939 unit.
2941 The keys :require-years, :require-months, :require-days,
2942 :require-weeks, :require-hours, :require-minutes are also
2943 meaningful. A non-nil value for these keys indicates that the
2944 corresponding time component should always be included, even if
2945 its value is 0.
2948 For example,
2950 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
2951 :require-minutes t)
2953 means durations longer than a day will be expressed in days,
2954 hours and minutes, and durations less than a day will always be
2955 expressed in hours and minutes (even for durations less than an
2956 hour).
2958 The value
2960 \(:days \"%dd\" :minutes \"%dm\")
2962 means durations longer than a day will be expressed in days and
2963 minutes, and durations less than a day will be expressed entirely
2964 in minutes (even for durations longer than an hour)."
2965 :group 'org-time
2966 :group 'org-clock
2967 :version "24.4"
2968 :package-version '(Org . "8.0")
2969 :type '(choice (string :tag "Format string")
2970 (set :tag "Plist"
2971 (group :inline t (const :tag "Years" :years)
2972 (string :tag "Format string"))
2973 (group :inline t
2974 (const :tag "Always show years" :require-years)
2975 (const t))
2976 (group :inline t (const :tag "Months" :months)
2977 (string :tag "Format string"))
2978 (group :inline t
2979 (const :tag "Always show months" :require-months)
2980 (const t))
2981 (group :inline t (const :tag "Weeks" :weeks)
2982 (string :tag "Format string"))
2983 (group :inline t
2984 (const :tag "Always show weeks" :require-weeks)
2985 (const t))
2986 (group :inline t (const :tag "Days" :days)
2987 (string :tag "Format string"))
2988 (group :inline t
2989 (const :tag "Always show days" :require-days)
2990 (const t))
2991 (group :inline t (const :tag "Hours" :hours)
2992 (string :tag "Format string"))
2993 (group :inline t
2994 (const :tag "Always show hours" :require-hours)
2995 (const t))
2996 (group :inline t (const :tag "Minutes" :minutes)
2997 (string :tag "Format string"))
2998 (group :inline t
2999 (const :tag "Always show minutes" :require-minutes)
3000 (const t)))))
3002 (defcustom org-time-clocksum-use-fractional nil
3003 "When non-nil, \\[org-clock-display] uses fractional times.
3004 See `org-time-clocksum-format' for more on time clock formats."
3005 :group 'org-time
3006 :group 'org-clock
3007 :version "24.3"
3008 :type 'boolean)
3010 (defcustom org-time-clocksum-use-effort-durations nil
3011 "When non-nil, \\[org-clock-display] uses effort durations.
3012 E.g. by default, one day is considered to be a 8 hours effort,
3013 so a task that has been clocked for 16 hours will be displayed
3014 as during 2 days in the clock display or in the clocktable.
3016 See `org-effort-durations' on how to set effort durations
3017 and `org-time-clocksum-format' for more on time clock formats."
3018 :group 'org-time
3019 :group 'org-clock
3020 :version "24.4"
3021 :package-version '(Org . "8.0")
3022 :type 'boolean)
3024 (defcustom org-time-clocksum-fractional-format "%.2f"
3025 "The format string used when creating CLOCKSUM lines,
3026 or when Org mode generates a time duration, if
3027 `org-time-clocksum-use-fractional' is enabled.
3029 The value can be a single format string containing one
3030 %-sequence, which will be filled with the number of hours as
3031 a float.
3033 Alternatively, the value can be a plist associating any of the
3034 keys :years, :months, :weeks, :days, :hours or :minutes with
3035 a format string. The time duration is formatted using the
3036 largest time unit which gives a non-zero integer part. If all
3037 specified formats have zero integer part, the smallest time unit
3038 is used."
3039 :group 'org-time
3040 :type '(choice (string :tag "Format string")
3041 (set (group :inline t (const :tag "Years" :years)
3042 (string :tag "Format string"))
3043 (group :inline t (const :tag "Months" :months)
3044 (string :tag "Format string"))
3045 (group :inline t (const :tag "Weeks" :weeks)
3046 (string :tag "Format string"))
3047 (group :inline t (const :tag "Days" :days)
3048 (string :tag "Format string"))
3049 (group :inline t (const :tag "Hours" :hours)
3050 (string :tag "Format string"))
3051 (group :inline t (const :tag "Minutes" :minutes)
3052 (string :tag "Format string")))))
3054 (defcustom org-deadline-warning-days 14
3055 "Number of days before expiration during which a deadline becomes active.
3056 This variable governs the display in sparse trees and in the agenda.
3057 When 0 or negative, it means use this number (the absolute value of it)
3058 even if a deadline has a different individual lead time specified.
3060 Custom commands can set this variable in the options section."
3061 :group 'org-time
3062 :group 'org-agenda-daily/weekly
3063 :type 'integer)
3065 (defcustom org-scheduled-delay-days 0
3066 "Number of days before a scheduled item becomes active.
3067 This variable governs the display in sparse trees and in the agenda.
3068 The default value (i.e. 0) means: don't delay scheduled item.
3069 When negative, it means use this number (the absolute value of it)
3070 even if a scheduled item has a different individual delay time
3071 specified.
3073 Custom commands can set this variable in the options section."
3074 :group 'org-time
3075 :group 'org-agenda-daily/weekly
3076 :version "24.4"
3077 :package-version '(Org . "8.0")
3078 :type 'integer)
3080 (defcustom org-read-date-prefer-future t
3081 "Non-nil means assume future for incomplete date input from user.
3082 This affects the following situations:
3083 1. The user gives a month but not a year.
3084 For example, if it is April and you enter \"feb 2\", this will be read
3085 as Feb 2, *next* year. \"May 5\", however, will be this year.
3086 2. The user gives a day, but no month.
3087 For example, if today is the 15th, and you enter \"3\", Org-mode will
3088 read this as the third of *next* month. However, if you enter \"17\",
3089 it will be considered as *this* month.
3091 If you set this variable to the symbol `time', then also the following
3092 will work:
3094 3. If the user gives a time.
3095 If the time is before now, it will be interpreted as tomorrow.
3097 Currently none of this works for ISO week specifications.
3099 When this option is nil, the current day, month and year will always be
3100 used as defaults.
3102 See also `org-agenda-jump-prefer-future'."
3103 :group 'org-time
3104 :type '(choice
3105 (const :tag "Never" nil)
3106 (const :tag "Check month and day" t)
3107 (const :tag "Check month, day, and time" time)))
3109 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3110 "Should the agenda jump command prefer the future for incomplete dates?
3111 The default is to do the same as configured in `org-read-date-prefer-future'.
3112 But you can also set a deviating value here.
3113 This may t or nil, or the symbol `org-read-date-prefer-future'."
3114 :group 'org-agenda
3115 :group 'org-time
3116 :version "24.1"
3117 :type '(choice
3118 (const :tag "Use org-read-date-prefer-future"
3119 org-read-date-prefer-future)
3120 (const :tag "Never" nil)
3121 (const :tag "Always" t)))
3123 (defcustom org-read-date-force-compatible-dates t
3124 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3126 Depending on the system Emacs is running on, certain dates cannot
3127 be represented with the type used internally to represent time.
3128 Dates between 1970-1-1 and 2038-1-1 can always be represented
3129 correctly. Some systems allow for earlier dates, some for later,
3130 some for both. One way to find out it to insert any date into an
3131 Org buffer, putting the cursor on the year and hitting S-up and
3132 S-down to test the range.
3134 When this variable is set to t, the date/time prompt will not let
3135 you specify dates outside the 1970-2037 range, so it is certain that
3136 these dates will work in whatever version of Emacs you are
3137 running, and also that you can move a file from one Emacs implementation
3138 to another. WHenever Org is forcing the year for you, it will display
3139 a message and beep.
3141 When this variable is nil, Org will check if the date is
3142 representable in the specific Emacs implementation you are using.
3143 If not, it will force a year, usually the current year, and beep
3144 to remind you. Currently this setting is not recommended because
3145 the likelihood that you will open your Org files in an Emacs that
3146 has limited date range is not negligible.
3148 A workaround for this problem is to use diary sexp dates for time
3149 stamps outside of this range."
3150 :group 'org-time
3151 :version "24.1"
3152 :type 'boolean)
3154 (defcustom org-read-date-display-live t
3155 "Non-nil means display current interpretation of date prompt live.
3156 This display will be in an overlay, in the minibuffer."
3157 :group 'org-time
3158 :type 'boolean)
3160 (defcustom org-read-date-popup-calendar t
3161 "Non-nil means pop up a calendar when prompting for a date.
3162 In the calendar, the date can be selected with mouse-1. However, the
3163 minibuffer will also be active, and you can simply enter the date as well.
3164 When nil, only the minibuffer will be available."
3165 :group 'org-time
3166 :type 'boolean)
3167 (org-defvaralias 'org-popup-calendar-for-date-prompt
3168 'org-read-date-popup-calendar)
3170 (make-obsolete-variable
3171 'org-read-date-minibuffer-setup-hook
3172 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3173 (defcustom org-read-date-minibuffer-setup-hook nil
3174 "Hook to be used to set up keys for the date/time interface.
3175 Add key definitions to `minibuffer-local-map', which will be a
3176 temporary copy.
3178 WARNING: This option is obsolete, you should use
3179 `org-read-date-minibuffer-local-map' to set up keys."
3180 :group 'org-time
3181 :type 'hook)
3183 (defcustom org-extend-today-until 0
3184 "The hour when your day really ends. Must be an integer.
3185 This has influence for the following applications:
3186 - When switching the agenda to \"today\". It it is still earlier than
3187 the time given here, the day recognized as TODAY is actually yesterday.
3188 - When a date is read from the user and it is still before the time given
3189 here, the current date and time will be assumed to be yesterday, 23:59.
3190 Also, timestamps inserted in capture templates follow this rule.
3192 IMPORTANT: This is a feature whose implementation is and likely will
3193 remain incomplete. Really, it is only here because past midnight seems to
3194 be the favorite working time of John Wiegley :-)"
3195 :group 'org-time
3196 :type 'integer)
3198 (defcustom org-use-effective-time nil
3199 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3200 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3201 \"effective time\" of any timestamps between midnight and 8am will be
3202 23:59 of the previous day."
3203 :group 'org-time
3204 :version "24.1"
3205 :type 'boolean)
3207 (defcustom org-use-last-clock-out-time-as-effective-time nil
3208 "When non-nil, use the last clock out time for `org-todo'.
3209 Note that this option has precedence over the combined use of
3210 `org-use-effective-time' and `org-extend-today-until'."
3211 :group 'org-time
3212 :version "24.4"
3213 :package-version '(Org . "8.0")
3214 :type 'boolean)
3216 (defcustom org-edit-timestamp-down-means-later nil
3217 "Non-nil means S-down will increase the time in a time stamp.
3218 When nil, S-up will increase."
3219 :group 'org-time
3220 :type 'boolean)
3222 (defcustom org-calendar-follow-timestamp-change t
3223 "Non-nil means make the calendar window follow timestamp changes.
3224 When a timestamp is modified and the calendar window is visible, it will be
3225 moved to the new date."
3226 :group 'org-time
3227 :type 'boolean)
3229 (defgroup org-tags nil
3230 "Options concerning tags in Org-mode."
3231 :tag "Org Tags"
3232 :group 'org)
3234 (defcustom org-tag-alist nil
3235 "List of tags allowed in Org-mode files.
3236 When this list is nil, Org-mode will base TAG input on what is already in the
3237 buffer.
3238 The value of this variable is an alist, the car of each entry must be a
3239 keyword as a string, the cdr may be a character that is used to select
3240 that tag through the fast-tag-selection interface.
3241 See the manual for details."
3242 :group 'org-tags
3243 :type '(repeat
3244 (choice
3245 (cons (string :tag "Tag name")
3246 (character :tag "Access char"))
3247 (list :tag "Start radio group"
3248 (const :startgroup)
3249 (option (string :tag "Group description")))
3250 (list :tag "Group tags delimiter"
3251 (const :grouptags))
3252 (list :tag "End radio group"
3253 (const :endgroup)
3254 (option (string :tag "Group description")))
3255 (const :tag "New line" (:newline)))))
3257 (defcustom org-tag-persistent-alist nil
3258 "List of tags that will always appear in all Org-mode files.
3259 This is in addition to any in buffer settings or customizations
3260 of `org-tag-alist'.
3261 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3262 The value of this variable is an alist, the car of each entry must be a
3263 keyword as a string, the cdr may be a character that is used to select
3264 that tag through the fast-tag-selection interface.
3265 See the manual for details.
3266 To disable these tags on a per-file basis, insert anywhere in the file:
3267 #+STARTUP: noptag"
3268 :group 'org-tags
3269 :type '(repeat
3270 (choice
3271 (cons (string :tag "Tag name")
3272 (character :tag "Access char"))
3273 (const :tag "Start radio group" (:startgroup))
3274 (const :tag "Group tags delimiter" (:grouptags))
3275 (const :tag "End radio group" (:endgroup))
3276 (const :tag "New line" (:newline)))))
3278 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3279 "If non-nil, always offer completion for all tags of all agenda files.
3280 Instead of customizing this variable directly, you might want to
3281 set it locally for capture buffers, because there no list of
3282 tags in that file can be created dynamically (there are none).
3284 (add-hook 'org-capture-mode-hook
3285 (lambda ()
3286 (set (make-local-variable
3287 'org-complete-tags-always-offer-all-agenda-tags)
3288 t)))"
3289 :group 'org-tags
3290 :version "24.1"
3291 :type 'boolean)
3293 (defvar org-file-tags nil
3294 "List of tags that can be inherited by all entries in the file.
3295 The tags will be inherited if the variable `org-use-tag-inheritance'
3296 says they should be.
3297 This variable is populated from #+FILETAGS lines.")
3299 (defcustom org-use-fast-tag-selection 'auto
3300 "Non-nil means use fast tag selection scheme.
3301 This is a special interface to select and deselect tags with single keys.
3302 When nil, fast selection is never used.
3303 When the symbol `auto', fast selection is used if and only if selection
3304 characters for tags have been configured, either through the variable
3305 `org-tag-alist' or through a #+TAGS line in the buffer.
3306 When t, fast selection is always used and selection keys are assigned
3307 automatically if necessary."
3308 :group 'org-tags
3309 :type '(choice
3310 (const :tag "Always" t)
3311 (const :tag "Never" nil)
3312 (const :tag "When selection characters are configured" auto)))
3314 (defcustom org-fast-tag-selection-single-key nil
3315 "Non-nil means fast tag selection exits after first change.
3316 When nil, you have to press RET to exit it.
3317 During fast tag selection, you can toggle this flag with `C-c'.
3318 This variable can also have the value `expert'. In this case, the window
3319 displaying the tags menu is not even shown, until you press C-c again."
3320 :group 'org-tags
3321 :type '(choice
3322 (const :tag "No" nil)
3323 (const :tag "Yes" t)
3324 (const :tag "Expert" expert)))
3326 (defvar org-fast-tag-selection-include-todo nil
3327 "Non-nil means fast tags selection interface will also offer TODO states.
3328 This is an undocumented feature, you should not rely on it.")
3330 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3331 "The column to which tags should be indented in a headline.
3332 If this number is positive, it specifies the column. If it is negative,
3333 it means that the tags should be flushright to that column. For example,
3334 -80 works well for a normal 80 character screen.
3335 When 0, place tags directly after headline text, with only one space in
3336 between."
3337 :group 'org-tags
3338 :type 'integer)
3340 (defcustom org-auto-align-tags t
3341 "Non-nil keeps tags aligned when modifying headlines.
3342 Some operations (i.e. demoting) change the length of a headline and
3343 therefore shift the tags around. With this option turned on, after
3344 each such operation the tags are again aligned to `org-tags-column'."
3345 :group 'org-tags
3346 :type 'boolean)
3348 (defcustom org-use-tag-inheritance t
3349 "Non-nil means tags in levels apply also for sublevels.
3350 When nil, only the tags directly given in a specific line apply there.
3351 This may also be a list of tags that should be inherited, or a regexp that
3352 matches tags that should be inherited. Additional control is possible
3353 with the variable `org-tags-exclude-from-inheritance' which gives an
3354 explicit list of tags to be excluded from inheritance, even if the value of
3355 `org-use-tag-inheritance' would select it for inheritance.
3357 If this option is t, a match early-on in a tree can lead to a large
3358 number of matches in the subtree when constructing the agenda or creating
3359 a sparse tree. If you only want to see the first match in a tree during
3360 a search, check out the variable `org-tags-match-list-sublevels'."
3361 :group 'org-tags
3362 :type '(choice
3363 (const :tag "Not" nil)
3364 (const :tag "Always" t)
3365 (repeat :tag "Specific tags" (string :tag "Tag"))
3366 (regexp :tag "Tags matched by regexp")))
3368 (defcustom org-tags-exclude-from-inheritance nil
3369 "List of tags that should never be inherited.
3370 This is a way to exclude a few tags from inheritance. For way to do
3371 the opposite, to actively allow inheritance for selected tags,
3372 see the variable `org-use-tag-inheritance'."
3373 :group 'org-tags
3374 :type '(repeat (string :tag "Tag")))
3376 (defun org-tag-inherit-p (tag)
3377 "Check if TAG is one that should be inherited."
3378 (cond
3379 ((member tag org-tags-exclude-from-inheritance) nil)
3380 ((eq org-use-tag-inheritance t) t)
3381 ((not org-use-tag-inheritance) nil)
3382 ((stringp org-use-tag-inheritance)
3383 (string-match org-use-tag-inheritance tag))
3384 ((listp org-use-tag-inheritance)
3385 (member tag org-use-tag-inheritance))
3386 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3388 (defcustom org-tags-match-list-sublevels t
3389 "Non-nil means list also sublevels of headlines matching a search.
3390 This variable applies to tags/property searches, and also to stuck
3391 projects because this search is based on a tags match as well.
3393 When set to the symbol `indented', sublevels are indented with
3394 leading dots.
3396 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3397 the sublevels of a headline matching a tag search often also match
3398 the same search. Listing all of them can create very long lists.
3399 Setting this variable to nil causes subtrees of a match to be skipped.
3401 This variable is semi-obsolete and probably should always be true. It
3402 is better to limit inheritance to certain tags using the variables
3403 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3404 :group 'org-tags
3405 :type '(choice
3406 (const :tag "No, don't list them" nil)
3407 (const :tag "Yes, do list them" t)
3408 (const :tag "List them, indented with leading dots" indented)))
3410 (defcustom org-tags-sort-function nil
3411 "When set, tags are sorted using this function as a comparator."
3412 :group 'org-tags
3413 :type '(choice
3414 (const :tag "No sorting" nil)
3415 (const :tag "Alphabetical" string<)
3416 (const :tag "Reverse alphabetical" string>)
3417 (function :tag "Custom function" nil)))
3419 (defvar org-tags-history nil
3420 "History of minibuffer reads for tags.")
3421 (defvar org-last-tags-completion-table nil
3422 "The last used completion table for tags.")
3423 (defvar org-after-tags-change-hook nil
3424 "Hook that is run after the tags in a line have changed.")
3426 (defgroup org-properties nil
3427 "Options concerning properties in Org-mode."
3428 :tag "Org Properties"
3429 :group 'org)
3431 (defcustom org-property-format "%-10s %s"
3432 "How property key/value pairs should be formatted by `indent-line'.
3433 When `indent-line' hits a property definition, it will format the line
3434 according to this format, mainly to make sure that the values are
3435 lined-up with respect to each other."
3436 :group 'org-properties
3437 :type 'string)
3439 (defcustom org-properties-postprocess-alist nil
3440 "Alist of properties and functions to adjust inserted values.
3441 Elements of this alist must be of the form
3443 ([string] [function])
3445 where [string] must be a property name and [function] must be a
3446 lambda expression: this lambda expression must take one argument,
3447 the value to adjust, and return the new value as a string.
3449 For example, this element will allow the property \"Remaining\"
3450 to be updated wrt the relation between the \"Effort\" property
3451 and the clock summary:
3453 ((\"Remaining\" (lambda(value)
3454 (let ((clocksum (org-clock-sum-current-item))
3455 (effort (org-duration-string-to-minutes
3456 (org-entry-get (point) \"Effort\"))))
3457 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3458 :group 'org-properties
3459 :version "24.1"
3460 :type '(alist :key-type (string :tag "Property")
3461 :value-type (function :tag "Function")))
3463 (defcustom org-use-property-inheritance nil
3464 "Non-nil means properties apply also for sublevels.
3466 This setting is chiefly used during property searches. Turning it on can
3467 cause significant overhead when doing a search, which is why it is not
3468 on by default.
3470 When nil, only the properties directly given in the current entry count.
3471 When t, every property is inherited. The value may also be a list of
3472 properties that should have inheritance, or a regular expression matching
3473 properties that should be inherited.
3475 However, note that some special properties use inheritance under special
3476 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3477 and the properties ending in \"_ALL\" when they are used as descriptor
3478 for valid values of a property.
3480 Note for programmers:
3481 When querying an entry with `org-entry-get', you can control if inheritance
3482 should be used. By default, `org-entry-get' looks only at the local
3483 properties. You can request inheritance by setting the inherit argument
3484 to t (to force inheritance) or to `selective' (to respect the setting
3485 in this variable)."
3486 :group 'org-properties
3487 :type '(choice
3488 (const :tag "Not" nil)
3489 (const :tag "Always" t)
3490 (repeat :tag "Specific properties" (string :tag "Property"))
3491 (regexp :tag "Properties matched by regexp")))
3493 (defun org-property-inherit-p (property)
3494 "Check if PROPERTY is one that should be inherited."
3495 (cond
3496 ((eq org-use-property-inheritance t) t)
3497 ((not org-use-property-inheritance) nil)
3498 ((stringp org-use-property-inheritance)
3499 (string-match org-use-property-inheritance property))
3500 ((listp org-use-property-inheritance)
3501 (member property org-use-property-inheritance))
3502 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3504 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3505 "The default column format, if no other format has been defined.
3506 This variable can be set on the per-file basis by inserting a line
3508 #+COLUMNS: %25ITEM ....."
3509 :group 'org-properties
3510 :type 'string)
3512 (defcustom org-columns-ellipses ".."
3513 "The ellipses to be used when a field in column view is truncated.
3514 When this is the empty string, as many characters as possible are shown,
3515 but then there will be no visual indication that the field has been truncated.
3516 When this is a string of length N, the last N characters of a truncated
3517 field are replaced by this string. If the column is narrower than the
3518 ellipses string, only part of the ellipses string will be shown."
3519 :group 'org-properties
3520 :type 'string)
3522 (defcustom org-columns-modify-value-for-display-function nil
3523 "Function that modifies values for display in column view.
3524 For example, it can be used to cut out a certain part from a time stamp.
3525 The function must take 2 arguments:
3527 column-title The title of the column (*not* the property name)
3528 value The value that should be modified.
3530 The function should return the value that should be displayed,
3531 or nil if the normal value should be used."
3532 :group 'org-properties
3533 :type '(choice (const nil) (function)))
3535 (defcustom org-effort-property "Effort"
3536 "The property that is being used to keep track of effort estimates.
3537 Effort estimates given in this property need to have the format H:MM."
3538 :group 'org-properties
3539 :group 'org-progress
3540 :type '(string :tag "Property"))
3542 (defconst org-global-properties-fixed
3543 '(("VISIBILITY_ALL" . "folded children content all")
3544 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3545 "List of property/value pairs that can be inherited by any entry.
3547 These are fixed values, for the preset properties. The user variable
3548 that can be used to add to this list is `org-global-properties'.
3550 The entries in this list are cons cells where the car is a property
3551 name and cdr is a string with the value. If the value represents
3552 multiple items like an \"_ALL\" property, separate the items by
3553 spaces.")
3555 (defcustom org-global-properties nil
3556 "List of property/value pairs that can be inherited by any entry.
3558 This list will be combined with the constant `org-global-properties-fixed'.
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.
3563 You can set buffer-local values for the same purpose in the variable
3564 `org-file-properties' this by adding lines like
3566 #+PROPERTY: NAME VALUE"
3567 :group 'org-properties
3568 :type '(repeat
3569 (cons (string :tag "Property")
3570 (string :tag "Value"))))
3572 (defvar org-file-properties nil
3573 "List of property/value pairs that can be inherited by any entry.
3574 Valid for the current buffer.
3575 This variable is populated from #+PROPERTY lines.")
3576 (make-variable-buffer-local 'org-file-properties)
3578 (defgroup org-agenda nil
3579 "Options concerning agenda views in Org-mode."
3580 :tag "Org Agenda"
3581 :group 'org)
3583 (defvar org-category nil
3584 "Variable used by org files to set a category for agenda display.
3585 Such files should use a file variable to set it, for example
3587 # -*- mode: org; org-category: \"ELisp\"
3589 or contain a special line
3591 #+CATEGORY: ELisp
3593 If the file does not specify a category, then file's base name
3594 is used instead.")
3595 (make-variable-buffer-local 'org-category)
3596 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3598 (defcustom org-agenda-files nil
3599 "The files to be used for agenda display.
3600 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3601 \\[org-remove-file]. You can also use customize to edit the list.
3603 If an entry is a directory, all files in that directory that are matched by
3604 `org-agenda-file-regexp' will be part of the file list.
3606 If the value of the variable is not a list but a single file name, then
3607 the list of agenda files is actually stored and maintained in that file, one
3608 agenda file per line. In this file paths can be given relative to
3609 `org-directory'. Tilde expansion and environment variable substitution
3610 are also made."
3611 :group 'org-agenda
3612 :type '(choice
3613 (repeat :tag "List of files and directories" file)
3614 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3616 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3617 "Regular expression to match files for `org-agenda-files'.
3618 If any element in the list in that variable contains a directory instead
3619 of a normal file, all files in that directory that are matched by this
3620 regular expression will be included."
3621 :group 'org-agenda
3622 :type 'regexp)
3624 (defcustom org-agenda-text-search-extra-files nil
3625 "List of extra files to be searched by text search commands.
3626 These files will be searched in addition to the agenda files by the
3627 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3628 Note that these files will only be searched for text search commands,
3629 not for the other agenda views like todo lists, tag searches or the weekly
3630 agenda. This variable is intended to list notes and possibly archive files
3631 that should also be searched by these two commands.
3632 In fact, if the first element in the list is the symbol `agenda-archives',
3633 then all archive files of all agenda files will be added to the search
3634 scope."
3635 :group 'org-agenda
3636 :type '(set :greedy t
3637 (const :tag "Agenda Archives" agenda-archives)
3638 (repeat :inline t (file))))
3640 (org-defvaralias 'org-agenda-multi-occur-extra-files
3641 'org-agenda-text-search-extra-files)
3643 (defcustom org-agenda-skip-unavailable-files nil
3644 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3645 A nil value means to remove them, after a query, from the list."
3646 :group 'org-agenda
3647 :type 'boolean)
3649 (defcustom org-calendar-to-agenda-key [?c]
3650 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3651 The command `org-calendar-goto-agenda' will be bound to this key. The
3652 default is the character `c' because then `c' can be used to switch back and
3653 forth between agenda and calendar."
3654 :group 'org-agenda
3655 :type 'sexp)
3657 (defcustom org-calendar-insert-diary-entry-key [?i]
3658 "The key to be installed in `calendar-mode-map' for adding diary entries.
3659 This option is irrelevant until `org-agenda-diary-file' has been configured
3660 to point to an Org-mode file. When that is the case, the command
3661 `org-agenda-diary-entry' will be bound to the key given here, by default
3662 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3663 if you want to continue doing this, you need to change this to a different
3664 key."
3665 :group 'org-agenda
3666 :type 'sexp)
3668 (defcustom org-agenda-diary-file 'diary-file
3669 "File to which to add new entries with the `i' key in agenda and calendar.
3670 When this is the symbol `diary-file', the functionality in the Emacs
3671 calendar will be used to add entries to the `diary-file'. But when this
3672 points to a file, `org-agenda-diary-entry' will be used instead."
3673 :group 'org-agenda
3674 :type '(choice
3675 (const :tag "The standard Emacs diary file" diary-file)
3676 (file :tag "Special Org file diary entries")))
3678 (eval-after-load "calendar"
3679 '(progn
3680 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3681 'org-calendar-goto-agenda)
3682 (add-hook 'calendar-mode-hook
3683 (lambda ()
3684 (unless (eq org-agenda-diary-file 'diary-file)
3685 (define-key calendar-mode-map
3686 org-calendar-insert-diary-entry-key
3687 'org-agenda-diary-entry))))))
3689 (defgroup org-latex nil
3690 "Options for embedding LaTeX code into Org-mode."
3691 :tag "Org LaTeX"
3692 :group 'org)
3694 (defcustom org-format-latex-options
3695 '(:foreground default :background default :scale 1.0
3696 :html-foreground "Black" :html-background "Transparent"
3697 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3698 "Options for creating images from LaTeX fragments.
3699 This is a property list with the following properties:
3700 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3701 `default' means use the foreground of the default face.
3702 `auto' means use the foreground from the text face.
3703 :background the background color, or \"Transparent\".
3704 `default' means use the background of the default face.
3705 `auto' means use the background from the text face.
3706 :scale a scaling factor for the size of the images, to get more pixels
3707 :html-foreground, :html-background, :html-scale
3708 the same numbers for HTML export.
3709 :matchers a list indicating which matchers should be used to
3710 find LaTeX fragments. Valid members of this list are:
3711 \"begin\" find environments
3712 \"$1\" find single characters surrounded by $.$
3713 \"$\" find math expressions surrounded by $...$
3714 \"$$\" find math expressions surrounded by $$....$$
3715 \"\\(\" find math expressions surrounded by \\(...\\)
3716 \"\\ [\" find math expressions surrounded by \\ [...\\]"
3717 :group 'org-latex
3718 :type 'plist)
3720 (defcustom org-format-latex-signal-error t
3721 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3722 When nil, just push out a message."
3723 :group 'org-latex
3724 :version "24.1"
3725 :type 'boolean)
3727 (defcustom org-latex-to-mathml-jar-file nil
3728 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3729 Use this to specify additional executable file say a jar file.
3731 When using MathToWeb as the converter, specify the full-path to
3732 your mathtoweb.jar file."
3733 :group 'org-latex
3734 :version "24.1"
3735 :type '(choice
3736 (const :tag "None" nil)
3737 (file :tag "JAR file" :must-match t)))
3739 (defcustom org-latex-to-mathml-convert-command nil
3740 "Command to convert LaTeX fragments to MathML.
3741 Replace format-specifiers in the command as noted below and use
3742 `shell-command' to convert LaTeX to MathML.
3743 %j: Executable file in fully expanded form as specified by
3744 `org-latex-to-mathml-jar-file'.
3745 %I: Input LaTeX file in fully expanded form
3746 %o: Output MathML file
3747 This command is used by `org-create-math-formula'.
3749 When using MathToWeb as the converter, set this to
3750 \"java -jar %j -unicode -force -df %o %I\"."
3751 :group 'org-latex
3752 :version "24.1"
3753 :type '(choice
3754 (const :tag "None" nil)
3755 (string :tag "\nShell command")))
3757 (defcustom org-latex-create-formula-image-program 'dvipng
3758 "Program to convert LaTeX fragments with.
3760 dvipng Process the LaTeX fragments to dvi file, then convert
3761 dvi files to png files using dvipng.
3762 This will also include processing of non-math environments.
3763 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3764 to convert pdf files to png files"
3765 :group 'org-latex
3766 :version "24.1"
3767 :type '(choice
3768 (const :tag "dvipng" dvipng)
3769 (const :tag "imagemagick" imagemagick)))
3771 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
3772 "Path to store latex preview images.
3773 A relative path here creates many directories relative to the
3774 processed org files paths. An absolute path puts all preview
3775 images at the same place."
3776 :group 'org-latex
3777 :version "24.3"
3778 :type 'string)
3780 (defun org-format-latex-mathml-available-p ()
3781 "Return t if `org-latex-to-mathml-convert-command' is usable."
3782 (save-match-data
3783 (when (and (boundp 'org-latex-to-mathml-convert-command)
3784 org-latex-to-mathml-convert-command)
3785 (let ((executable (car (split-string
3786 org-latex-to-mathml-convert-command))))
3787 (when (executable-find executable)
3788 (if (string-match
3789 "%j" org-latex-to-mathml-convert-command)
3790 (file-readable-p org-latex-to-mathml-jar-file)
3791 t))))))
3793 (defcustom org-format-latex-header "\\documentclass{article}
3794 \\usepackage[usenames]{color}
3795 \[PACKAGES]
3796 \[DEFAULT-PACKAGES]
3797 \\pagestyle{empty} % do not remove
3798 % The settings below are copied from fullpage.sty
3799 \\setlength{\\textwidth}{\\paperwidth}
3800 \\addtolength{\\textwidth}{-3cm}
3801 \\setlength{\\oddsidemargin}{1.5cm}
3802 \\addtolength{\\oddsidemargin}{-2.54cm}
3803 \\setlength{\\evensidemargin}{\\oddsidemargin}
3804 \\setlength{\\textheight}{\\paperheight}
3805 \\addtolength{\\textheight}{-\\headheight}
3806 \\addtolength{\\textheight}{-\\headsep}
3807 \\addtolength{\\textheight}{-\\footskip}
3808 \\addtolength{\\textheight}{-3cm}
3809 \\setlength{\\topmargin}{1.5cm}
3810 \\addtolength{\\topmargin}{-2.54cm}"
3811 "The document header used for processing LaTeX fragments.
3812 It is imperative that this header make sure that no page number
3813 appears on the page. The package defined in the variables
3814 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3815 will either replace the placeholder \"[PACKAGES]\" in this
3816 header, or they will be appended."
3817 :group 'org-latex
3818 :type 'string)
3820 (defun org-set-packages-alist (var val)
3821 "Set the packages alist and make sure it has 3 elements per entry."
3822 (set var (mapcar (lambda (x)
3823 (if (and (consp x) (= (length x) 2))
3824 (list (car x) (nth 1 x) t)
3826 val)))
3828 (defun org-get-packages-alist (var)
3829 "Get the packages alist and make sure it has 3 elements per entry."
3830 (mapcar (lambda (x)
3831 (if (and (consp x) (= (length x) 2))
3832 (list (car x) (nth 1 x) t)
3834 (default-value var)))
3836 (defcustom org-latex-default-packages-alist
3837 '(("AUTO" "inputenc" t)
3838 ("T1" "fontenc" t)
3839 ("" "fixltx2e" nil)
3840 ("" "graphicx" t)
3841 ("" "longtable" nil)
3842 ("" "float" nil)
3843 ("" "wrapfig" nil)
3844 ("" "rotating" nil)
3845 ("normalem" "ulem" t)
3846 ("" "amsmath" t)
3847 ("" "textcomp" t)
3848 ("" "marvosym" t)
3849 ("" "wasysym" t)
3850 ("" "amssymb" t)
3851 ("" "hyperref" nil)
3852 "\\tolerance=1000")
3853 "Alist of default packages to be inserted in the header.
3855 Change this only if one of the packages here causes an
3856 incompatibility with another package you are using.
3858 The packages in this list are needed by one part or another of
3859 Org mode to function properly:
3861 - inputenc, fontenc: for basic font and character selection
3862 - fixltx2e: Important patches of LaTeX itself
3863 - graphicx: for including images
3864 - longtable: For multipage tables
3865 - float, wrapfig: for figure placement
3866 - rotating: for sideways figures and tables
3867 - ulem: for underline and strike-through
3868 - amsmath: for subscript and superscript and math environments
3869 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
3870 for interpreting the entities in `org-entities'. You can skip
3871 some of these packages if you don't use any of their symbols.
3872 - hyperref: for cross references
3874 Therefore you should not modify this variable unless you know
3875 what you are doing. The one reason to change it anyway is that
3876 you might be loading some other package that conflicts with one
3877 of the default packages. Each cell is of the format
3878 \( \"options\" \"package\" snippet-flag). If SNIPPET-FLAG is t,
3879 the package also needs to be included when compiling LaTeX
3880 snippets into images for inclusion into non-LaTeX output."
3881 :group 'org-latex
3882 :group 'org-export-latex
3883 :set 'org-set-packages-alist
3884 :get 'org-get-packages-alist
3885 :version "24.1"
3886 :type '(repeat
3887 (choice
3888 (list :tag "options/package pair"
3889 (string :tag "options")
3890 (string :tag "package")
3891 (boolean :tag "Snippet"))
3892 (string :tag "A line of LaTeX"))))
3894 (defcustom org-latex-packages-alist nil
3895 "Alist of packages to be inserted in every LaTeX header.
3897 These will be inserted after `org-latex-default-packages-alist'.
3898 Each cell is of the format:
3900 \(\"options\" \"package\" snippet-flag)
3902 SNIPPET-FLAG, when t, indicates that this package is also needed
3903 when turning LaTeX snippets into images for inclusion into
3904 non-LaTeX output.
3906 Make sure that you only list packages here which:
3908 - you want in every file
3909 - do not conflict with the setup in `org-format-latex-header'.
3910 - do not conflict with the default packages in
3911 `org-latex-default-packages-alist'."
3912 :group 'org-latex
3913 :group 'org-export-latex
3914 :set 'org-set-packages-alist
3915 :get 'org-get-packages-alist
3916 :type '(repeat
3917 (choice
3918 (list :tag "options/package pair"
3919 (string :tag "options")
3920 (string :tag "package")
3921 (boolean :tag "Snippet"))
3922 (string :tag "A line of LaTeX"))))
3924 (defgroup org-appearance nil
3925 "Settings for Org-mode appearance."
3926 :tag "Org Appearance"
3927 :group 'org)
3929 (defcustom org-level-color-stars-only nil
3930 "Non-nil means fontify only the stars in each headline.
3931 When nil, the entire headline is fontified.
3932 Changing it requires restart of `font-lock-mode' to become effective
3933 also in regions already fontified."
3934 :group 'org-appearance
3935 :type 'boolean)
3937 (defcustom org-hide-leading-stars nil
3938 "Non-nil means hide the first N-1 stars in a headline.
3939 This works by using the face `org-hide' for these stars. This
3940 face is white for a light background, and black for a dark
3941 background. You may have to customize the face `org-hide' to
3942 make this work.
3943 Changing it requires restart of `font-lock-mode' to become effective
3944 also in regions already fontified.
3945 You may also set this on a per-file basis by adding one of the following
3946 lines to the buffer:
3948 #+STARTUP: hidestars
3949 #+STARTUP: showstars"
3950 :group 'org-appearance
3951 :type 'boolean)
3953 (defcustom org-hidden-keywords nil
3954 "List of symbols corresponding to keywords to be hidden the org buffer.
3955 For example, a value '(title) for this list will make the document's title
3956 appear in the buffer without the initial #+TITLE: keyword."
3957 :group 'org-appearance
3958 :version "24.1"
3959 :type '(set (const :tag "#+AUTHOR" author)
3960 (const :tag "#+DATE" date)
3961 (const :tag "#+EMAIL" email)
3962 (const :tag "#+TITLE" title)))
3964 (defcustom org-custom-properties nil
3965 "List of properties (as strings) with a special meaning.
3966 The default use of these custom properties is to let the user
3967 hide them with `org-toggle-custom-properties-visibility'."
3968 :group 'org-properties
3969 :group 'org-appearance
3970 :version "24.3"
3971 :type '(repeat (string :tag "Property Name")))
3973 (defcustom org-fontify-done-headline nil
3974 "Non-nil means change the face of a headline if it is marked DONE.
3975 Normally, only the TODO/DONE keyword indicates the state of a headline.
3976 When this is non-nil, the headline after the keyword is set to the
3977 `org-headline-done' as an additional indication."
3978 :group 'org-appearance
3979 :type 'boolean)
3981 (defcustom org-fontify-emphasized-text t
3982 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3983 Changing this variable requires a restart of Emacs to take effect."
3984 :group 'org-appearance
3985 :type 'boolean)
3987 (defcustom org-fontify-whole-heading-line nil
3988 "Non-nil means fontify the whole line for headings.
3989 This is useful when setting a background color for the
3990 org-level-* faces."
3991 :group 'org-appearance
3992 :type 'boolean)
3994 (defcustom org-highlight-latex-and-related nil
3995 "Non-nil means highlight LaTeX related syntax in the buffer.
3996 When non nil, the value should be a list containing any of the
3997 following symbols:
3998 `latex' Highlight LaTeX snippets and environments.
3999 `script' Highlight subscript and superscript.
4000 `entities' Highlight entities."
4001 :group 'org-appearance
4002 :version "24.4"
4003 :package-version '(Org . "8.0")
4004 :type '(choice
4005 (const :tag "No highlighting" nil)
4006 (set :greedy t :tag "Highlight"
4007 (const :tag "LaTeX snippets and environments" latex)
4008 (const :tag "Subscript and superscript" script)
4009 (const :tag "Entities" entities))))
4011 (defcustom org-hide-emphasis-markers nil
4012 "Non-nil mean font-lock should hide the emphasis marker characters."
4013 :group 'org-appearance
4014 :type 'boolean)
4016 (defcustom org-pretty-entities nil
4017 "Non-nil means show entities as UTF8 characters.
4018 When nil, the \\name form remains in the buffer."
4019 :group 'org-appearance
4020 :version "24.1"
4021 :type 'boolean)
4023 (defcustom org-pretty-entities-include-sub-superscripts t
4024 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4025 :group 'org-appearance
4026 :version "24.1"
4027 :type 'boolean)
4029 (defvar org-emph-re nil
4030 "Regular expression for matching emphasis.
4031 After a match, the match groups contain these elements:
4032 0 The match of the full regular expression, including the characters
4033 before and after the proper match
4034 1 The character before the proper match, or empty at beginning of line
4035 2 The proper match, including the leading and trailing markers
4036 3 The leading marker like * or /, indicating the type of highlighting
4037 4 The text between the emphasis markers, not including the markers
4038 5 The character after the match, empty at the end of a line")
4039 (defvar org-verbatim-re nil
4040 "Regular expression for matching verbatim text.")
4041 (defvar org-emphasis-regexp-components) ; defined just below
4042 (defvar org-emphasis-alist) ; defined just below
4043 (defun org-set-emph-re (var val)
4044 "Set variable and compute the emphasis regular expression."
4045 (set var val)
4046 (when (and (boundp 'org-emphasis-alist)
4047 (boundp 'org-emphasis-regexp-components)
4048 org-emphasis-alist org-emphasis-regexp-components)
4049 (let* ((e org-emphasis-regexp-components)
4050 (pre (car e))
4051 (post (nth 1 e))
4052 (border (nth 2 e))
4053 (body (nth 3 e))
4054 (nl (nth 4 e))
4055 (body1 (concat body "*?"))
4056 (markers (mapconcat 'car org-emphasis-alist ""))
4057 (vmarkers (mapconcat
4058 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4059 org-emphasis-alist "")))
4060 ;; make sure special characters appear at the right position in the class
4061 (if (string-match "\\^" markers)
4062 (setq markers (concat (replace-match "" t t markers) "^")))
4063 (if (string-match "-" markers)
4064 (setq markers (concat (replace-match "" t t markers) "-")))
4065 (if (string-match "\\^" vmarkers)
4066 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4067 (if (string-match "-" vmarkers)
4068 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4069 (if (> nl 0)
4070 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4071 (int-to-string nl) "\\}")))
4072 ;; Make the regexp
4073 (setq org-emph-re
4074 (concat "\\([" pre "]\\|^\\)"
4075 "\\("
4076 "\\([" markers "]\\)"
4077 "\\("
4078 "[^" border "]\\|"
4079 "[^" border "]"
4080 body1
4081 "[^" border "]"
4082 "\\)"
4083 "\\3\\)"
4084 "\\([" post "]\\|$\\)"))
4085 (setq org-verbatim-re
4086 (concat "\\([" pre "]\\|^\\)"
4087 "\\("
4088 "\\([" vmarkers "]\\)"
4089 "\\("
4090 "[^" border "]\\|"
4091 "[^" border "]"
4092 body1
4093 "[^" border "]"
4094 "\\)"
4095 "\\3\\)"
4096 "\\([" post "]\\|$\\)")))))
4098 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4099 ;; set this option proved cumbersome. See this message/thread:
4100 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4101 (defvar org-emphasis-regexp-components
4102 '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
4103 "Components used to build the regular expression for emphasis.
4104 This is a list with five entries. Terminology: In an emphasis string
4105 like \" *strong word* \", we call the initial space PREMATCH, the final
4106 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4107 and \"trong wor\" is the body. The different components in this variable
4108 specify what is allowed/forbidden in each part:
4110 pre Chars allowed as prematch. Beginning of line will be allowed too.
4111 post Chars allowed as postmatch. End of line will be allowed too.
4112 border The chars *forbidden* as border characters.
4113 body-regexp A regexp like \".\" to match a body character. Don't use
4114 non-shy groups here, and don't allow newline here.
4115 newline The maximum number of newlines allowed in an emphasis exp.
4117 You need to reload Org or to restart Emacs after customizing this.")
4119 (defcustom org-emphasis-alist
4120 `(("*" bold)
4121 ("/" italic)
4122 ("_" underline)
4123 ("=" org-code verbatim)
4124 ("~" org-verbatim verbatim)
4125 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4126 "Alist of characters and faces to emphasize text.
4127 Text starting and ending with a special character will be emphasized,
4128 for example *bold*, _underlined_ and /italic/. This variable sets the
4129 marker characters and the face to be used by font-lock for highlighting
4130 in Org-mode Emacs buffers.
4132 You need to reload Org or to restart Emacs after customizing this."
4133 :group 'org-appearance
4134 :set 'org-set-emph-re
4135 :version "24.4"
4136 :package-version '(Org . "8.0")
4137 :type '(repeat
4138 (list
4139 (string :tag "Marker character")
4140 (choice
4141 (face :tag "Font-lock-face")
4142 (plist :tag "Face property list"))
4143 (option (const verbatim)))))
4145 (defvar org-protecting-blocks
4146 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4147 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4148 This is needed for font-lock setup.")
4150 ;;; Miscellaneous options
4152 (defgroup org-completion nil
4153 "Completion in Org-mode."
4154 :tag "Org Completion"
4155 :group 'org)
4157 (defcustom org-completion-use-ido nil
4158 "Non-nil means use ido completion wherever possible.
4159 Note that `ido-mode' must be active for this variable to be relevant.
4160 If you decide to turn this variable on, you might well want to turn off
4161 `org-outline-path-complete-in-steps'.
4162 See also `org-completion-use-iswitchb'."
4163 :group 'org-completion
4164 :type 'boolean)
4166 (defcustom org-completion-use-iswitchb nil
4167 "Non-nil means use iswitchb completion wherever possible.
4168 Note that `iswitchb-mode' must be active for this variable to be relevant.
4169 If you decide to turn this variable on, you might well want to turn off
4170 `org-outline-path-complete-in-steps'.
4171 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4172 :group 'org-completion
4173 :type 'boolean)
4175 (defcustom org-completion-fallback-command 'hippie-expand
4176 "The expansion command called by \\[pcomplete] in normal context.
4177 Normal means, no org-mode-specific context."
4178 :group 'org-completion
4179 :type 'function)
4181 ;;; Functions and variables from their packages
4182 ;; Declared here to avoid compiler warnings
4184 ;; XEmacs only
4185 (defvar outline-mode-menu-heading)
4186 (defvar outline-mode-menu-show)
4187 (defvar outline-mode-menu-hide)
4188 (defvar zmacs-regions) ; XEmacs regions
4190 ;; Emacs only
4191 (defvar mark-active)
4193 ;; Various packages
4194 (declare-function calendar-absolute-from-iso "cal-iso" (date))
4195 (declare-function calendar-forward-day "cal-move" (arg))
4196 (declare-function calendar-goto-date "cal-move" (date))
4197 (declare-function calendar-goto-today "cal-move" ())
4198 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4199 (defvar calc-embedded-close-formula)
4200 (defvar calc-embedded-open-formula)
4201 (declare-function cdlatex-tab "ext:cdlatex" ())
4202 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4203 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4204 (defvar font-lock-unfontify-region-function)
4205 (declare-function iswitchb-read-buffer "iswitchb"
4206 (prompt &optional default require-match start matches-set))
4207 (defvar iswitchb-temp-buflist)
4208 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4209 (defvar org-agenda-tags-todo-honor-ignore-options)
4210 (declare-function org-agenda-skip "org-agenda" ())
4211 (declare-function
4212 org-agenda-format-item "org-agenda"
4213 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4214 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4215 (declare-function org-agenda-change-all-lines "org-agenda"
4216 (newhead hdmarker &optional fixface just-this))
4217 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4218 (declare-function org-agenda-maybe-redo "org-agenda" ())
4219 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4220 (beg end))
4221 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4222 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4223 "org-agenda" (&optional end))
4224 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4225 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4226 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4227 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4228 (declare-function org-indent-mode "org-indent" (&optional arg))
4229 (declare-function parse-time-string "parse-time" (string))
4230 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4231 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4232 (defvar remember-data-file)
4233 (defvar texmathp-why)
4234 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4235 (declare-function table--at-cell-p "table" (position &optional object at-column))
4237 (defvar org-latex-regexps)
4239 ;;; Autoload and prepare some org modules
4241 ;; Some table stuff that needs to be defined here, because it is used
4242 ;; by the functions setting up org-mode or checking for table context.
4244 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
4245 "Detect an org-type or table-type table.")
4246 (defconst org-table-line-regexp "^[ \t]*|"
4247 "Detect an org-type table line.")
4248 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
4249 "Detect an org-type table line.")
4250 (defconst org-table-hline-regexp "^[ \t]*|-"
4251 "Detect an org-type table hline.")
4252 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
4253 "Detect a table-type table hline.")
4254 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
4255 "Detect the first line outside a table when searching from within it.
4256 This works for both table types.")
4258 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
4259 "Detect a #+TBLFM line.")
4261 ;;;###autoload
4262 (defun turn-on-orgtbl ()
4263 "Unconditionally turn on `orgtbl-mode'."
4264 (require 'org-table)
4265 (orgtbl-mode 1))
4267 (defun org-at-table-p (&optional table-type)
4268 "Return t if the cursor is inside an org-type table.
4269 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4270 (if org-enable-table-editor
4271 (save-excursion
4272 (beginning-of-line 1)
4273 (looking-at (if table-type org-table-any-line-regexp
4274 org-table-line-regexp)))
4275 nil))
4276 (defsubst org-table-p () (org-at-table-p))
4278 (defun org-at-table.el-p ()
4279 "Return t if and only if we are at a table.el table."
4280 (and (org-at-table-p 'any)
4281 (save-excursion
4282 (goto-char (org-table-begin 'any))
4283 (looking-at org-table1-hline-regexp))))
4285 (defun org-table-recognize-table.el ()
4286 "If there is a table.el table nearby, recognize it and move into it."
4287 (if org-table-tab-recognizes-table.el
4288 (if (org-at-table.el-p)
4289 (progn
4290 (beginning-of-line 1)
4291 (if (looking-at org-table-dataline-regexp)
4293 (if (looking-at org-table1-hline-regexp)
4294 (progn
4295 (beginning-of-line 2)
4296 (if (looking-at org-table-any-border-regexp)
4297 (beginning-of-line -1)))))
4298 (if (re-search-forward "|" (org-table-end t) t)
4299 (progn
4300 (require 'table)
4301 (if (table--at-cell-p (point))
4303 (message "recognizing table.el table...")
4304 (table-recognize-table)
4305 (message "recognizing table.el table...done")))
4306 (error "This should not happen"))
4308 nil)
4309 nil))
4311 (defun org-at-table-hline-p ()
4312 "Return t if the cursor is inside a hline in a table."
4313 (if org-enable-table-editor
4314 (save-excursion
4315 (beginning-of-line 1)
4316 (looking-at org-table-hline-regexp))
4317 nil))
4319 (defun org-table-map-tables (function &optional quietly)
4320 "Apply FUNCTION to the start of all tables in the buffer."
4321 (save-excursion
4322 (save-restriction
4323 (widen)
4324 (goto-char (point-min))
4325 (while (re-search-forward org-table-any-line-regexp nil t)
4326 (unless quietly
4327 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4328 (beginning-of-line 1)
4329 (when (and (looking-at org-table-line-regexp)
4330 ;; Exclude tables in src/example/verbatim/clocktable blocks
4331 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4332 (save-excursion (funcall function))
4333 (or (looking-at org-table-line-regexp)
4334 (forward-char 1)))
4335 (re-search-forward org-table-any-border-regexp nil 1))))
4336 (unless quietly (message "Mapping tables: done")))
4338 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4339 (declare-function org-clock-update-mode-line "org-clock" ())
4340 (declare-function org-resolve-clocks "org-clock"
4341 (&optional also-non-dangling-p prompt last-valid))
4343 (defun org-at-TBLFM-p (&optional pos)
4344 "Return t when point (or POS) is in #+TBLFM line."
4345 (save-excursion
4346 (let ((pos pos)))
4347 (goto-char (or pos (point)))
4348 (beginning-of-line 1)
4349 (looking-at org-TBLFM-regexp)))
4351 (defvar org-clock-start-time)
4352 (defvar org-clock-marker (make-marker)
4353 "Marker recording the last clock-in.")
4354 (defvar org-clock-hd-marker (make-marker)
4355 "Marker recording the last clock-in, but the headline position.")
4356 (defvar org-clock-heading ""
4357 "The heading of the current clock entry.")
4358 (defun org-clock-is-active ()
4359 "Return the buffer where the clock is currently running.
4360 Return nil if no clock is running."
4361 (marker-buffer org-clock-marker))
4363 (defun org-check-running-clock ()
4364 "Check if the current buffer contains the running clock.
4365 If yes, offer to stop it and to save the buffer with the changes."
4366 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4367 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4368 (buffer-name))))
4369 (org-clock-out)
4370 (when (y-or-n-p "Save changed buffer?")
4371 (save-buffer))))
4373 (defun org-clocktable-try-shift (dir n)
4374 "Check if this line starts a clock table, if yes, shift the time block."
4375 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4376 (org-clocktable-shift dir n)))
4378 ;;;###autoload
4379 (defun org-clock-persistence-insinuate ()
4380 "Set up hooks for clock persistence."
4381 (require 'org-clock)
4382 (add-hook 'org-mode-hook 'org-clock-load)
4383 (add-hook 'kill-emacs-hook 'org-clock-save))
4385 ;; Define the variable already here, to make sure we have it.
4386 (defvar org-indent-mode nil
4387 "Non-nil if Org-Indent mode is enabled.
4388 Use the command `org-indent-mode' to change this variable.")
4390 ;; Autoload archiving code
4391 ;; The stuff that is needed for cycling and tags has to be defined here.
4393 (defgroup org-archive nil
4394 "Options concerning archiving in Org-mode."
4395 :tag "Org Archive"
4396 :group 'org-structure)
4398 (defcustom org-archive-location "%s_archive::"
4399 "The location where subtrees should be archived.
4401 The value of this variable is a string, consisting of two parts,
4402 separated by a double-colon. The first part is a filename and
4403 the second part is a headline.
4405 When the filename is omitted, archiving happens in the same file.
4406 %s in the filename will be replaced by the current file
4407 name (without the directory part). Archiving to a different file
4408 is useful to keep archived entries from contributing to the
4409 Org-mode Agenda.
4411 The archived entries will be filed as subtrees of the specified
4412 headline. When the headline is omitted, the subtrees are simply
4413 filed away at the end of the file, as top-level entries. Also in
4414 the heading you can use %s to represent the file name, this can be
4415 useful when using the same archive for a number of different files.
4417 Here are a few examples:
4418 \"%s_archive::\"
4419 If the current file is Projects.org, archive in file
4420 Projects.org_archive, as top-level trees. This is the default.
4422 \"::* Archived Tasks\"
4423 Archive in the current file, under the top-level headline
4424 \"* Archived Tasks\".
4426 \"~/org/archive.org::\"
4427 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4429 \"~/org/archive.org::* From %s\"
4430 Archive in file ~/org/archive.org (absolute path), under headlines
4431 \"From FILENAME\" where file name is the current file name.
4433 \"~/org/datetree.org::datetree/* Finished Tasks\"
4434 The \"datetree/\" string is special, signifying to archive
4435 items to the datetree. Items are placed in either the CLOSED
4436 date of the item, or the current date if there is no CLOSED date.
4437 The heading will be a subentry to the current date. There doesn't
4438 need to be a heading, but there always needs to be a slash after
4439 datetree. For example, to store archived items directly in the
4440 datetree, use \"~/org/datetree.org::datetree/\".
4442 \"basement::** Finished Tasks\"
4443 Archive in file ./basement (relative path), as level 3 trees
4444 below the level 2 heading \"** Finished Tasks\".
4446 You may set this option on a per-file basis by adding to the buffer a
4447 line like
4449 #+ARCHIVE: basement::** Finished Tasks
4451 You may also define it locally for a subtree by setting an ARCHIVE property
4452 in the entry. If such a property is found in an entry, or anywhere up
4453 the hierarchy, it will be used."
4454 :group 'org-archive
4455 :type 'string)
4457 (defcustom org-archive-tag "ARCHIVE"
4458 "The tag that marks a subtree as archived.
4459 An archived subtree does not open during visibility cycling, and does
4460 not contribute to the agenda listings.
4461 After changing this, font-lock must be restarted in the relevant buffers to
4462 get the proper fontification."
4463 :group 'org-archive
4464 :group 'org-keywords
4465 :type 'string)
4467 (defcustom org-agenda-skip-archived-trees t
4468 "Non-nil means the agenda will skip any items located in archived trees.
4469 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4470 variable is no longer recommended, you should leave it at the value t.
4471 Instead, use the key `v' to cycle the archives-mode in the agenda."
4472 :group 'org-archive
4473 :group 'org-agenda-skip
4474 :type 'boolean)
4476 (defcustom org-columns-skip-archived-trees t
4477 "Non-nil means ignore archived trees when creating column view."
4478 :group 'org-archive
4479 :group 'org-properties
4480 :type 'boolean)
4482 (defcustom org-cycle-open-archived-trees nil
4483 "Non-nil means `org-cycle' will open archived trees.
4484 An archived tree is a tree marked with the tag ARCHIVE.
4485 When nil, archived trees will stay folded. You can still open them with
4486 normal outline commands like `show-all', but not with the cycling commands."
4487 :group 'org-archive
4488 :group 'org-cycle
4489 :type 'boolean)
4491 (defcustom org-sparse-tree-open-archived-trees nil
4492 "Non-nil means sparse tree construction shows matches in archived trees.
4493 When nil, matches in these trees are highlighted, but the trees are kept in
4494 collapsed state."
4495 :group 'org-archive
4496 :group 'org-sparse-trees
4497 :type 'boolean)
4499 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4500 "The default date type when building a sparse tree.
4501 When this is nil, a date is a scheduled or a deadline timestamp.
4502 Otherwise, these types are allowed:
4504 all: all timestamps
4505 active: only active timestamps (<...>)
4506 inactive: only inactive timestamps (<...)
4507 scheduled: only scheduled timestamps
4508 deadline: only deadline timestamps"
4509 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4510 (const :tag "All timestamps" all)
4511 (const :tag "Only active timestamps" active)
4512 (const :tag "Only inactive timestamps" inactive)
4513 (const :tag "Only scheduled timestamps" scheduled)
4514 (const :tag "Only deadline timestamps" deadline)
4515 (const :tag "Only closed timestamps" closed))
4516 :version "24.3"
4517 :group 'org-sparse-trees)
4519 (defun org-cycle-hide-archived-subtrees (state)
4520 "Re-hide all archived subtrees after a visibility state change."
4521 (when (and (not org-cycle-open-archived-trees)
4522 (not (memq state '(overview folded))))
4523 (save-excursion
4524 (let* ((globalp (memq state '(contents all)))
4525 (beg (if globalp (point-min) (point)))
4526 (end (if globalp (point-max) (org-end-of-subtree t))))
4527 (org-hide-archived-subtrees beg end)
4528 (goto-char beg)
4529 (if (looking-at (concat ".*:" org-archive-tag ":"))
4530 (message "%s" (substitute-command-keys
4531 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4533 (defun org-force-cycle-archived ()
4534 "Cycle subtree even if it is archived."
4535 (interactive)
4536 (setq this-command 'org-cycle)
4537 (let ((org-cycle-open-archived-trees t))
4538 (call-interactively 'org-cycle)))
4540 (defun org-hide-archived-subtrees (beg end)
4541 "Re-hide all archived subtrees after a visibility state change."
4542 (save-excursion
4543 (let* ((re (concat ":" org-archive-tag ":")))
4544 (goto-char beg)
4545 (while (re-search-forward re end t)
4546 (when (org-at-heading-p)
4547 (org-flag-subtree t)
4548 (org-end-of-subtree t))))))
4550 (declare-function outline-end-of-heading "outline" ())
4551 (declare-function outline-flag-region "outline" (from to flag))
4552 (defun org-flag-subtree (flag)
4553 (save-excursion
4554 (org-back-to-heading t)
4555 (outline-end-of-heading)
4556 (outline-flag-region (point)
4557 (progn (org-end-of-subtree t) (point))
4558 flag)))
4560 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4562 ;; Declare Column View Code
4564 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4565 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4566 (declare-function org-columns-compute "org-colview" (property))
4568 ;; Declare ID code
4570 (declare-function org-id-store-link "org-id")
4571 (declare-function org-id-locations-load "org-id")
4572 (declare-function org-id-locations-save "org-id")
4573 (defvar org-id-track-globally)
4575 ;;; Variables for pre-computed regular expressions, all buffer local
4577 (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
4578 "Matches first line of a hidden block.")
4579 (make-variable-buffer-local 'org-drawer-regexp)
4580 (defvar org-todo-regexp nil
4581 "Matches any of the TODO state keywords.")
4582 (make-variable-buffer-local 'org-todo-regexp)
4583 (defvar org-not-done-regexp nil
4584 "Matches any of the TODO state keywords except the last one.")
4585 (make-variable-buffer-local 'org-not-done-regexp)
4586 (defvar org-not-done-heading-regexp nil
4587 "Matches a TODO headline that is not done.")
4588 (make-variable-buffer-local 'org-not-done-regexp)
4589 (defvar org-todo-line-regexp nil
4590 "Matches a headline and puts TODO state into group 2 if present.")
4591 (make-variable-buffer-local 'org-todo-line-regexp)
4592 (defvar org-complex-heading-regexp nil
4593 "Matches a headline and puts everything into groups:
4594 group 1: the stars
4595 group 2: The todo keyword, maybe
4596 group 3: Priority cookie
4597 group 4: True headline
4598 group 5: Tags")
4599 (make-variable-buffer-local 'org-complex-heading-regexp)
4600 (defvar org-complex-heading-regexp-format nil
4601 "Printf format to make regexp to match an exact headline.
4602 This regexp will match the headline of any node which has the
4603 exact headline text that is put into the format, but may have any
4604 TODO state, priority and tags.")
4605 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4606 (defvar org-todo-line-tags-regexp nil
4607 "Matches a headline and puts TODO state into group 2 if present.
4608 Also put tags into group 4 if tags are present.")
4609 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4610 (defvar org-ds-keyword-length 12
4611 "Maximum length of the DEADLINE and SCHEDULED keywords.")
4612 (make-variable-buffer-local 'org-ds-keyword-length)
4613 (defvar org-deadline-regexp nil
4614 "Matches the DEADLINE keyword.")
4615 (make-variable-buffer-local 'org-deadline-regexp)
4616 (defvar org-deadline-time-regexp nil
4617 "Matches the DEADLINE keyword together with a time stamp.")
4618 (make-variable-buffer-local 'org-deadline-time-regexp)
4619 (defvar org-deadline-time-hour-regexp nil
4620 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
4621 (make-variable-buffer-local 'org-deadline-time-hour-regexp)
4622 (defvar org-deadline-line-regexp nil
4623 "Matches the DEADLINE keyword and the rest of the line.")
4624 (make-variable-buffer-local 'org-deadline-line-regexp)
4625 (defvar org-scheduled-regexp nil
4626 "Matches the SCHEDULED keyword.")
4627 (make-variable-buffer-local 'org-scheduled-regexp)
4628 (defvar org-scheduled-time-regexp nil
4629 "Matches the SCHEDULED keyword together with a time stamp.")
4630 (make-variable-buffer-local 'org-scheduled-time-regexp)
4631 (defvar org-scheduled-time-hour-regexp nil
4632 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
4633 (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
4634 (defvar org-closed-time-regexp nil
4635 "Matches the CLOSED keyword together with a time stamp.")
4636 (make-variable-buffer-local 'org-closed-time-regexp)
4638 (defvar org-keyword-time-regexp nil
4639 "Matches any of the 4 keywords, together with the time stamp.")
4640 (make-variable-buffer-local 'org-keyword-time-regexp)
4641 (defvar org-keyword-time-not-clock-regexp nil
4642 "Matches any of the 3 keywords, together with the time stamp.")
4643 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
4644 (defvar org-maybe-keyword-time-regexp nil
4645 "Matches a timestamp, possibly preceded by a keyword.")
4646 (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
4647 (defvar org-all-time-keywords nil
4648 "List of time keywords.")
4649 (make-variable-buffer-local 'org-all-time-keywords)
4651 (defconst org-plain-time-of-day-regexp
4652 (concat
4653 "\\(\\<[012]?[0-9]"
4654 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4655 "\\(--?"
4656 "\\(\\<[012]?[0-9]"
4657 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4658 "\\)?")
4659 "Regular expression to match a plain time or time range.
4660 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4661 groups carry important information:
4662 0 the full match
4663 1 the first time, range or not
4664 8 the second time, if it is a range.")
4666 (defconst org-plain-time-extension-regexp
4667 (concat
4668 "\\(\\<[012]?[0-9]"
4669 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4670 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4671 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4672 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4673 groups carry important information:
4674 0 the full match
4675 7 hours of duration
4676 9 minutes of duration")
4678 (defconst org-stamp-time-of-day-regexp
4679 (concat
4680 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4681 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4682 "\\(--?"
4683 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4684 "Regular expression to match a timestamp time or time range.
4685 After a match, the following groups carry important information:
4686 0 the full match
4687 1 date plus weekday, for back referencing to make sure both times are on the same day
4688 2 the first time, range or not
4689 4 the second time, if it is a range.")
4691 (defconst org-startup-options
4692 '(("fold" org-startup-folded t)
4693 ("overview" org-startup-folded t)
4694 ("nofold" org-startup-folded nil)
4695 ("showall" org-startup-folded nil)
4696 ("showeverything" org-startup-folded showeverything)
4697 ("content" org-startup-folded content)
4698 ("indent" org-startup-indented t)
4699 ("noindent" org-startup-indented nil)
4700 ("hidestars" org-hide-leading-stars t)
4701 ("showstars" org-hide-leading-stars nil)
4702 ("odd" org-odd-levels-only t)
4703 ("oddeven" org-odd-levels-only nil)
4704 ("align" org-startup-align-all-tables t)
4705 ("noalign" org-startup-align-all-tables nil)
4706 ("inlineimages" org-startup-with-inline-images t)
4707 ("noinlineimages" org-startup-with-inline-images nil)
4708 ("latexpreview" org-startup-with-latex-preview t)
4709 ("nolatexpreview" org-startup-with-latex-preview nil)
4710 ("customtime" org-display-custom-times t)
4711 ("logdone" org-log-done time)
4712 ("lognotedone" org-log-done note)
4713 ("nologdone" org-log-done nil)
4714 ("lognoteclock-out" org-log-note-clock-out t)
4715 ("nolognoteclock-out" org-log-note-clock-out nil)
4716 ("logrepeat" org-log-repeat state)
4717 ("lognoterepeat" org-log-repeat note)
4718 ("logdrawer" org-log-into-drawer t)
4719 ("nologdrawer" org-log-into-drawer nil)
4720 ("logstatesreversed" org-log-states-order-reversed t)
4721 ("nologstatesreversed" org-log-states-order-reversed nil)
4722 ("nologrepeat" org-log-repeat nil)
4723 ("logreschedule" org-log-reschedule time)
4724 ("lognotereschedule" org-log-reschedule note)
4725 ("nologreschedule" org-log-reschedule nil)
4726 ("logredeadline" org-log-redeadline time)
4727 ("lognoteredeadline" org-log-redeadline note)
4728 ("nologredeadline" org-log-redeadline nil)
4729 ("logrefile" org-log-refile time)
4730 ("lognoterefile" org-log-refile note)
4731 ("nologrefile" org-log-refile nil)
4732 ("fninline" org-footnote-define-inline t)
4733 ("nofninline" org-footnote-define-inline nil)
4734 ("fnlocal" org-footnote-section nil)
4735 ("fnauto" org-footnote-auto-label t)
4736 ("fnprompt" org-footnote-auto-label nil)
4737 ("fnconfirm" org-footnote-auto-label confirm)
4738 ("fnplain" org-footnote-auto-label plain)
4739 ("fnadjust" org-footnote-auto-adjust t)
4740 ("nofnadjust" org-footnote-auto-adjust nil)
4741 ("constcgs" constants-unit-system cgs)
4742 ("constSI" constants-unit-system SI)
4743 ("noptag" org-tag-persistent-alist nil)
4744 ("hideblocks" org-hide-block-startup t)
4745 ("nohideblocks" org-hide-block-startup nil)
4746 ("beamer" org-startup-with-beamer-mode t)
4747 ("entitiespretty" org-pretty-entities t)
4748 ("entitiesplain" org-pretty-entities nil))
4749 "Variable associated with STARTUP options for org-mode.
4750 Each element is a list of three items: the startup options (as written
4751 in the #+STARTUP line), the corresponding variable, and the value to set
4752 this variable to if the option is found. An optional forth element PUSH
4753 means to push this value onto the list in the variable.")
4755 (defun org-update-property-plist (key val props)
4756 "Update PROPS with KEY and VAL."
4757 (let* ((appending (string= "+" (substring key (- (length key) 1))))
4758 (key (if appending (substring key 0 (- (length key) 1)) key))
4759 (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
4760 (previous (cdr (assoc key props))))
4761 (if appending
4762 (cons (cons key (if previous (concat previous " " val) val)) remainder)
4763 (cons (cons key val) remainder))))
4765 (defconst org-block-regexp
4766 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
4767 "Regular expression for hiding blocks.")
4768 (defconst org-heading-keyword-regexp-format
4769 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
4770 "Printf format for a regexp matching a headline with some keyword.
4771 This regexp will match the headline of any node which has the
4772 exact keyword that is put into the format. The keyword isn't in
4773 any group by default, but the stars and the body are.")
4774 (defconst org-heading-keyword-maybe-regexp-format
4775 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
4776 "Printf format for a regexp matching a headline, possibly with some keyword.
4777 This regexp can match any headline with the specified keyword, or
4778 without a keyword. The keyword isn't in any group by default,
4779 but the stars and the body are.")
4781 (defcustom org-group-tags t
4782 "When non-nil (the default), use group tags.
4783 This can be turned on/off through `org-toggle-tags-groups'."
4784 :group 'org-tags
4785 :group 'org-startup
4786 :type 'boolean)
4788 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4790 (defun org-toggle-tags-groups ()
4791 "Toggle support for group tags.
4792 Support for group tags is controlled by the option
4793 `org-group-tags', which is non-nil by default."
4794 (interactive)
4795 (setq org-group-tags (not org-group-tags))
4796 (cond ((and (derived-mode-p 'org-agenda-mode)
4797 org-group-tags)
4798 (org-agenda-redo))
4799 ((derived-mode-p 'org-mode)
4800 (let ((org-inhibit-startup t)) (org-mode))))
4801 (message "Groups tags support has been turned %s"
4802 (if org-group-tags "on" "off")))
4804 (defun org-set-regexps-and-options-for-tags ()
4805 "Precompute variables used for tags."
4806 (when (derived-mode-p 'org-mode)
4807 (org-set-local 'org-file-tags nil)
4808 (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
4809 (splitre "[ \t]+")
4810 (start 0)
4811 tags ftags key value)
4812 (save-excursion
4813 (save-restriction
4814 (widen)
4815 (goto-char (point-min))
4816 (while (re-search-forward re nil t)
4817 (setq key (upcase (org-match-string-no-properties 1))
4818 value (org-match-string-no-properties 2))
4819 (if (stringp value) (setq value (org-trim value)))
4820 (cond
4821 ((equal key "TAGS")
4822 (setq tags (append tags (if tags '("\\n") nil)
4823 (org-split-string value splitre))))
4824 ((equal key "FILETAGS")
4825 (when (string-match "\\S-" value)
4826 (setq ftags
4827 (append
4828 ftags
4829 (apply 'append
4830 (mapcar (lambda (x) (org-split-string x ":"))
4831 (org-split-string value)))))))))))
4832 ;; Process the file tags.
4833 (and ftags (org-set-local 'org-file-tags
4834 (mapcar 'org-add-prop-inherited ftags)))
4835 (org-set-local 'org-tag-groups-alist nil)
4836 ;; Process the tags.
4837 (when (and (not tags) org-tag-alist)
4838 (setq tags
4839 (mapcar
4840 (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
4841 ((eq (car tg) :endgroup) "}")
4842 ((eq (car tg) :grouptags) ":")
4843 ((eq (car tg) :newline) "\n")
4844 (t (concat (car tg)
4845 (if (characterp (cdr tg))
4846 (format "(%s)" (char-to-string (cdr tg))) "")))))
4847 org-tag-alist)))
4848 (let (e tgs g)
4849 (while (setq e (pop tags))
4850 (cond
4851 ((equal e "{")
4852 (progn (push '(:startgroup) tgs)
4853 (when (equal (nth 1 tags) ":")
4854 (push (list (replace-regexp-in-string
4855 "(.+)$" "" (nth 0 tags)))
4856 org-tag-groups-alist)
4857 (setq g 0))))
4858 ((equal e ":") (push '(:grouptags) tgs))
4859 ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
4860 ((equal e "\\n") (push '(:newline) tgs))
4861 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
4862 (push (cons (match-string 1 e)
4863 (string-to-char (match-string 2 e))) tgs)
4864 (if (and g (> g 0))
4865 (setcar org-tag-groups-alist
4866 (append (car org-tag-groups-alist)
4867 (list (match-string 1 e)))))
4868 (if g (setq g (1+ g))))
4869 (t (push (list e) tgs)
4870 (if (and g (> g 0))
4871 (setcar org-tag-groups-alist
4872 (append (car org-tag-groups-alist) (list e))))
4873 (if g (setq g (1+ g))))))
4874 (org-set-local 'org-tag-alist nil)
4875 (while (setq e (pop tgs))
4876 (or (and (stringp (car e))
4877 (assoc (car e) org-tag-alist))
4878 (push e org-tag-alist)))
4879 ;; Return a list with tag variables
4880 (list org-file-tags org-tag-alist org-tag-groups-alist)))))
4882 (defvar org-ota nil)
4883 (defun org-set-regexps-and-options ()
4884 "Precompute regular expressions used in the current buffer."
4885 (when (derived-mode-p 'org-mode)
4886 (org-set-local 'org-todo-kwd-alist nil)
4887 (org-set-local 'org-todo-key-alist nil)
4888 (org-set-local 'org-todo-key-trigger nil)
4889 (org-set-local 'org-todo-keywords-1 nil)
4890 (org-set-local 'org-done-keywords nil)
4891 (org-set-local 'org-todo-heads nil)
4892 (org-set-local 'org-todo-sets nil)
4893 (org-set-local 'org-todo-log-states nil)
4894 (org-set-local 'org-file-properties nil)
4895 (let ((re (org-make-options-regexp
4896 '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
4897 "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
4898 "SETUPFILE" "OPTIONS")
4899 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
4900 (splitre "[ \t]+")
4901 (scripts org-use-sub-superscripts)
4902 kwds kws0 kwsa key log value cat arch const links hw dws
4903 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4904 (start 0))
4905 (save-excursion
4906 (save-restriction
4907 (widen)
4908 (goto-char (point-min))
4909 (while
4910 (or (and
4911 ext-setup-or-nil
4912 (not org-ota)
4913 (let (ret)
4914 (with-temp-buffer
4915 (insert ext-setup-or-nil)
4916 (let ((major-mode 'org-mode) org-ota)
4917 (setq ret (save-match-data
4918 (org-set-regexps-and-options-for-tags)))))
4919 ;; Append setupfile tags to existing tags
4920 (setq org-ota t)
4921 (setq org-file-tags
4922 (delq nil (append org-file-tags (nth 0 ret)))
4923 org-tag-alist
4924 (delq nil (append org-tag-alist (nth 1 ret)))
4925 org-tag-groups-alist
4926 (delq nil (append org-tag-groups-alist (nth 2 ret))))))
4927 (and ext-setup-or-nil
4928 (string-match re ext-setup-or-nil start)
4929 (setq start (match-end 0)))
4930 (and (setq ext-setup-or-nil nil start 0)
4931 (re-search-forward re nil t)))
4932 (setq key (upcase (match-string 1 ext-setup-or-nil))
4933 value (org-match-string-no-properties 2 ext-setup-or-nil))
4934 (if (stringp value) (setq value (org-trim value)))
4935 (cond
4936 ((equal key "CATEGORY")
4937 (setq cat value))
4938 ((member key '("SEQ_TODO" "TODO"))
4939 (push (cons 'sequence (org-split-string value splitre)) kwds))
4940 ((equal key "TYP_TODO")
4941 (push (cons 'type (org-split-string value splitre)) kwds))
4942 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
4943 ;; general TODO-like setup
4944 (push (cons (intern (downcase (match-string 1 key)))
4945 (org-split-string value splitre)) kwds))
4946 ((equal key "COLUMNS")
4947 (org-set-local 'org-columns-default-format value))
4948 ((equal key "LINK")
4949 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
4950 (push (cons (match-string 1 value)
4951 (org-trim (match-string 2 value)))
4952 links)))
4953 ((equal key "PRIORITIES")
4954 (setq prio (org-split-string value " +")))
4955 ((equal key "PROPERTY")
4956 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
4957 (setq props (org-update-property-plist (match-string 1 value)
4958 (match-string 2 value)
4959 props))))
4960 ((equal key "DRAWERS")
4961 (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
4962 ((equal key "CONSTANTS")
4963 (org-table-set-constants))
4964 ((equal key "STARTUP")
4965 (let ((opts (org-split-string value splitre))
4966 l var val)
4967 (while (setq l (pop opts))
4968 (when (setq l (assoc l org-startup-options))
4969 (setq var (nth 1 l) val (nth 2 l))
4970 (if (not (nth 3 l))
4971 (set (make-local-variable var) val)
4972 (if (not (listp (symbol-value var)))
4973 (set (make-local-variable var) nil))
4974 (set (make-local-variable var) (symbol-value var))
4975 (add-to-list var val))))))
4976 ((equal key "ARCHIVE")
4977 (setq arch value)
4978 (remove-text-properties 0 (length arch)
4979 '(face t fontified t) arch))
4980 ((equal key "OPTIONS")
4981 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
4982 (setq scripts (read (match-string 2 value)))))
4983 ((and (equal key "SETUPFILE")
4984 ;; Prevent checking in Gnus messages
4985 (not buffer-read-only))
4986 (setq setup-contents (org-file-contents
4987 (expand-file-name
4988 (org-remove-double-quotes value))
4989 'noerror))
4990 (if (not ext-setup-or-nil)
4991 (setq ext-setup-or-nil setup-contents start 0)
4992 (setq ext-setup-or-nil
4993 (concat (substring ext-setup-or-nil 0 start)
4994 "\n" setup-contents "\n"
4995 (substring ext-setup-or-nil start)))))))
4996 ;; search for property blocks
4997 (goto-char (point-min))
4998 (while (re-search-forward org-block-regexp nil t)
4999 (when (equal "PROPERTY" (upcase (match-string 1)))
5000 (setq value (replace-regexp-in-string
5001 "[\n\r]" " " (match-string 4)))
5002 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5003 (setq props (org-update-property-plist (match-string 1 value)
5004 (match-string 2 value)
5005 props)))))))
5006 (org-set-local 'org-use-sub-superscripts scripts)
5007 (when cat
5008 (org-set-local 'org-category (intern cat))
5009 (push (cons "CATEGORY" cat) props))
5010 (when prio
5011 (if (< (length prio) 3) (setq prio '("A" "C" "B")))
5012 (setq prio (mapcar 'string-to-char prio))
5013 (org-set-local 'org-highest-priority (nth 0 prio))
5014 (org-set-local 'org-lowest-priority (nth 1 prio))
5015 (org-set-local 'org-default-priority (nth 2 prio)))
5016 (and props (org-set-local 'org-file-properties (nreverse props)))
5017 (and drawers (org-set-local 'org-drawers drawers))
5018 (and arch (org-set-local 'org-archive-location arch))
5019 (and links (setq org-link-abbrev-alist-local (nreverse links)))
5020 ;; Process the TODO keywords
5021 (unless kwds
5022 ;; Use the global values as if they had been given locally.
5023 (setq kwds (default-value 'org-todo-keywords))
5024 (if (stringp (car kwds))
5025 (setq kwds (list (cons org-todo-interpretation
5026 (default-value 'org-todo-keywords)))))
5027 (setq kwds (reverse kwds)))
5028 (setq kwds (nreverse kwds))
5029 (let (inter kws kw)
5030 (while (setq kws (pop kwds))
5031 (let ((kws (or
5032 (run-hook-with-args-until-success
5033 'org-todo-setup-filter-hook kws)
5034 kws)))
5035 (setq inter (pop kws) sep (member "|" kws)
5036 kws0 (delete "|" (copy-sequence kws))
5037 kwsa nil
5038 kws1 (mapcar
5039 (lambda (x)
5040 ;; 1 2
5041 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
5042 (progn
5043 (setq kw (match-string 1 x)
5044 key (and (match-end 2) (match-string 2 x))
5045 log (org-extract-log-state-settings x))
5046 (push (cons kw (and key (string-to-char key))) kwsa)
5047 (and log (push log org-todo-log-states))
5049 (error "Invalid TODO keyword %s" x)))
5050 kws0)
5051 kwsa (if kwsa (append '((:startgroup))
5052 (nreverse kwsa)
5053 '((:endgroup))))
5054 hw (car kws1)
5055 dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
5056 tail (list inter hw (car dws) (org-last dws))))
5057 (add-to-list 'org-todo-heads hw 'append)
5058 (push kws1 org-todo-sets)
5059 (setq org-done-keywords (append org-done-keywords dws nil))
5060 (setq org-todo-key-alist (append org-todo-key-alist kwsa))
5061 (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
5062 (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
5063 (setq org-todo-sets (nreverse org-todo-sets)
5064 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5065 org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
5066 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
5067 ;; Compute the regular expressions and other local variables.
5068 ;; Using `org-outline-regexp-bol' would complicate them much,
5069 ;; because of the fixed white space at the end of that string.
5070 (if (not org-done-keywords)
5071 (setq org-done-keywords (and org-todo-keywords-1
5072 (list (org-last org-todo-keywords-1)))))
5073 (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
5074 (length org-scheduled-string)
5075 (length org-clock-string)
5076 (length org-closed-string)))
5077 org-drawer-regexp
5078 (concat "^[ \t]*:\\("
5079 (mapconcat 'regexp-quote org-drawers "\\|")
5080 "\\):[ \t]*$")
5081 org-not-done-keywords
5082 (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
5083 org-todo-regexp
5084 (concat "\\("
5085 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
5086 "\\)")
5087 org-not-done-regexp
5088 (concat "\\("
5089 (mapconcat 'regexp-quote org-not-done-keywords "\\|")
5090 "\\)")
5091 org-not-done-heading-regexp
5092 (format org-heading-keyword-regexp-format org-not-done-regexp)
5093 org-todo-line-regexp
5094 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5095 org-complex-heading-regexp
5096 (concat "^\\(\\*+\\)"
5097 "\\(?: +" org-todo-regexp "\\)?"
5098 "\\(?: +\\(\\[#.\\]\\)\\)?"
5099 "\\(?: +\\(.*?\\)\\)??"
5100 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5101 "[ \t]*$")
5102 org-complex-heading-regexp-format
5103 (concat "^\\(\\*+\\)"
5104 "\\(?: +" org-todo-regexp "\\)?"
5105 "\\(?: +\\(\\[#.\\]\\)\\)?"
5106 "\\(?: +"
5107 ;; Stats cookies can be stuck to body.
5108 "\\(?:\\[[0-9%%/]+\\] *\\)?"
5109 "\\(%s\\)"
5110 "\\(?: *\\[[0-9%%/]+\\]\\)?"
5111 "\\)"
5112 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5113 "[ \t]*$")
5114 org-todo-line-tags-regexp
5115 (concat "^\\(\\*+\\)"
5116 "\\(?: +" org-todo-regexp "\\)?"
5117 "\\(?: +\\(.*?\\)\\)??"
5118 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5119 "[ \t]*$")
5120 org-deadline-regexp (concat "\\<" org-deadline-string)
5121 org-deadline-time-regexp
5122 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
5123 org-deadline-time-hour-regexp
5124 (concat "\\<" org-deadline-string
5125 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5126 org-deadline-line-regexp
5127 (concat "\\<\\(" org-deadline-string "\\).*")
5128 org-scheduled-regexp
5129 (concat "\\<" org-scheduled-string)
5130 org-scheduled-time-regexp
5131 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
5132 org-scheduled-time-hour-regexp
5133 (concat "\\<" org-scheduled-string
5134 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5135 org-closed-time-regexp
5136 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
5137 org-keyword-time-regexp
5138 (concat "\\<\\(" org-scheduled-string
5139 "\\|" org-deadline-string
5140 "\\|" org-closed-string
5141 "\\|" org-clock-string "\\)"
5142 " *[[<]\\([^]>]+\\)[]>]")
5143 org-keyword-time-not-clock-regexp
5144 (concat "\\<\\(" org-scheduled-string
5145 "\\|" org-deadline-string
5146 "\\|" org-closed-string
5147 "\\)"
5148 " *[[<]\\([^]>]+\\)[]>]")
5149 org-maybe-keyword-time-regexp
5150 (concat "\\(\\<\\(" org-scheduled-string
5151 "\\|" org-deadline-string
5152 "\\|" org-closed-string
5153 "\\|" org-clock-string "\\)\\)?"
5154 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
5155 org-all-time-keywords
5156 (mapcar (lambda (w) (substring w 0 -1))
5157 (list org-scheduled-string org-deadline-string
5158 org-clock-string org-closed-string)))
5159 (setq org-ota nil)
5160 (org-compute-latex-and-related-regexp))))
5162 (defun org-file-contents (file &optional noerror)
5163 "Return the contents of FILE, as a string."
5164 (if (or (not file)
5165 (not (file-readable-p file)))
5166 (if noerror
5167 (message "Cannot read file \"%s\"" file)
5168 (error "Cannot read file \"%s\"" file))
5169 (with-temp-buffer
5170 (insert-file-contents file)
5171 (buffer-string))))
5173 (defun org-extract-log-state-settings (x)
5174 "Extract the log state setting from a TODO keyword string.
5175 This will extract info from a string like \"WAIT(w@/!)\"."
5176 (let (kw key log1 log2)
5177 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5178 (setq kw (match-string 1 x)
5179 key (and (match-end 2) (match-string 2 x))
5180 log1 (and (match-end 3) (match-string 3 x))
5181 log2 (and (match-end 4) (match-string 4 x)))
5182 (and (or log1 log2)
5183 (list kw
5184 (and log1 (if (equal log1 "!") 'time 'note))
5185 (and log2 (if (equal log2 "!") 'time 'note)))))))
5187 (defun org-remove-keyword-keys (list)
5188 "Remove a pair of parenthesis at the end of each string in LIST."
5189 (mapcar (lambda (x)
5190 (if (string-match "(.*)$" x)
5191 (substring x 0 (match-beginning 0))
5193 list))
5195 (defun org-assign-fast-keys (alist)
5196 "Assign fast keys to a keyword-key alist.
5197 Respect keys that are already there."
5198 (let (new e (alt ?0))
5199 (while (setq e (pop alist))
5200 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5201 (cdr e)) ;; Key already assigned.
5202 (push e new)
5203 (let ((clist (string-to-list (downcase (car e))))
5204 (used (append new alist)))
5205 (when (= (car clist) ?@)
5206 (pop clist))
5207 (while (and clist (rassoc (car clist) used))
5208 (pop clist))
5209 (unless clist
5210 (while (rassoc alt used)
5211 (incf alt)))
5212 (push (cons (car e) (or (car clist) alt)) new))))
5213 (nreverse new)))
5215 ;;; Some variables used in various places
5217 (defvar org-window-configuration nil
5218 "Used in various places to store a window configuration.")
5219 (defvar org-selected-window nil
5220 "Used in various places to store a window configuration.")
5221 (defvar org-finish-function nil
5222 "Function to be called when `C-c C-c' is used.
5223 This is for getting out of special buffers like capture.")
5226 ;; FIXME: Occasionally check by commenting these, to make sure
5227 ;; no other functions uses these, forgetting to let-bind them.
5228 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5229 (defvar org-last-state)
5230 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5232 ;; Defined somewhere in this file, but used before definition.
5233 (defvar org-entities) ;; defined in org-entities.el
5234 (defvar org-struct-menu)
5235 (defvar org-org-menu)
5236 (defvar org-tbl-menu)
5238 ;;;; Define the Org-mode
5240 ;; We use a before-change function to check if a table might need
5241 ;; an update.
5242 (defvar org-table-may-need-update t
5243 "Indicates that a table might need an update.
5244 This variable is set by `org-before-change-function'.
5245 `org-table-align' sets it back to nil.")
5246 (defun org-before-change-function (beg end)
5247 "Every change indicates that a table might need an update."
5248 (setq org-table-may-need-update t))
5249 (defvar org-mode-map)
5250 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5251 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5252 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5253 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5254 (defvar org-table-buffer-is-an nil)
5256 (defvar bidi-paragraph-direction)
5257 (defvar buffer-face-mode-face)
5259 (require 'outline)
5260 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5261 (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"))
5262 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5264 ;; Other stuff we need.
5265 (require 'time-date)
5266 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5267 (require 'easymenu)
5268 (require 'overlay)
5270 ;; (require 'org-macs) moved higher up in the file before it is first used
5271 (require 'org-entities)
5272 ;; (require 'org-compat) moved higher up in the file before it is first used
5273 (require 'org-faces)
5274 (require 'org-list)
5275 (require 'org-pcomplete)
5276 (require 'org-src)
5277 (require 'org-footnote)
5278 (require 'org-macro)
5280 ;; babel
5281 (require 'ob)
5283 ;;;###autoload
5284 (define-derived-mode org-mode outline-mode "Org"
5285 "Outline-based notes management and organizer, alias
5286 \"Carsten's outline-mode for keeping track of everything.\"
5288 Org-mode develops organizational tasks around a NOTES file which
5289 contains information about projects as plain text. Org-mode is
5290 implemented on top of outline-mode, which is ideal to keep the content
5291 of large files well structured. It supports ToDo items, deadlines and
5292 time stamps, which magically appear in the diary listing of the Emacs
5293 calendar. Tables are easily created with a built-in table editor.
5294 Plain text URL-like links connect to websites, emails (VM), Usenet
5295 messages (Gnus), BBDB entries, and any files related to the project.
5296 For printing and sharing of notes, an Org-mode file (or a part of it)
5297 can be exported as a structured ASCII or HTML file.
5299 The following commands are available:
5301 \\{org-mode-map}"
5303 ;; Get rid of Outline menus, they are not needed
5304 ;; Need to do this here because define-derived-mode sets up
5305 ;; the keymap so late. Still, it is a waste to call this each time
5306 ;; we switch another buffer into org-mode.
5307 (if (featurep 'xemacs)
5308 (when (boundp 'outline-mode-menu-heading)
5309 ;; Assume this is Greg's port, it uses easymenu
5310 (easy-menu-remove outline-mode-menu-heading)
5311 (easy-menu-remove outline-mode-menu-show)
5312 (easy-menu-remove outline-mode-menu-hide))
5313 (define-key org-mode-map [menu-bar headings] 'undefined)
5314 (define-key org-mode-map [menu-bar hide] 'undefined)
5315 (define-key org-mode-map [menu-bar show] 'undefined))
5317 (org-load-modules-maybe)
5318 (easy-menu-add org-org-menu)
5319 (easy-menu-add org-tbl-menu)
5320 (org-install-agenda-files-menu)
5321 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5322 (add-to-invisibility-spec '(org-cwidth))
5323 (add-to-invisibility-spec '(org-hide-block . t))
5324 (when (featurep 'xemacs)
5325 (org-set-local 'line-move-ignore-invisible t))
5326 (org-set-local 'outline-regexp org-outline-regexp)
5327 (org-set-local 'outline-level 'org-outline-level)
5328 (setq bidi-paragraph-direction 'left-to-right)
5329 (when (and org-ellipsis
5330 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5331 (fboundp 'make-glyph-code))
5332 (unless org-display-table
5333 (setq org-display-table (make-display-table)))
5334 (set-display-table-slot
5335 org-display-table 4
5336 (vconcat (mapcar
5337 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5338 org-ellipsis)))
5339 (if (stringp org-ellipsis) org-ellipsis "..."))))
5340 (setq buffer-display-table org-display-table))
5341 (org-set-regexps-and-options-for-tags)
5342 (org-set-regexps-and-options)
5343 (org-set-font-lock-defaults)
5344 (when (and org-tag-faces (not org-tags-special-faces-re))
5345 ;; tag faces set outside customize.... force initialization.
5346 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5347 ;; Calc embedded
5348 (org-set-local 'calc-embedded-open-mode "# ")
5349 ;; Modify a few syntax entries
5350 (modify-syntax-entry ?@ "w")
5351 (modify-syntax-entry ?\" "\"")
5352 (if org-startup-truncated (setq truncate-lines t))
5353 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5354 (org-set-local 'font-lock-unfontify-region-function
5355 'org-unfontify-region)
5356 ;; Activate before-change-function
5357 (org-set-local 'org-table-may-need-update t)
5358 (org-add-hook 'before-change-functions 'org-before-change-function nil
5359 'local)
5360 ;; Check for running clock before killing a buffer
5361 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5362 ;; Initialize macros templates.
5363 (org-macro-initialize-templates)
5364 ;; Initialize radio targets.
5365 (org-update-radio-target-regexp)
5366 ;; Indentation.
5367 (org-set-local 'indent-line-function 'org-indent-line)
5368 (org-set-local 'indent-region-function 'org-indent-region)
5369 ;; Filling and auto-filling.
5370 (org-setup-filling)
5371 ;; Comments.
5372 (org-setup-comments-handling)
5373 ;; Beginning/end of defun
5374 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5375 (org-set-local 'end-of-defun-function 'org-forward-element)
5376 ;; Next error for sparse trees
5377 (org-set-local 'next-error-function 'org-occur-next-match)
5378 ;; Make sure dependence stuff works reliably, even for users who set it
5379 ;; too late :-(
5380 (if org-enforce-todo-dependencies
5381 (add-hook 'org-blocker-hook
5382 'org-block-todo-from-children-or-siblings-or-parent)
5383 (remove-hook 'org-blocker-hook
5384 'org-block-todo-from-children-or-siblings-or-parent))
5385 (if org-enforce-todo-checkbox-dependencies
5386 (add-hook 'org-blocker-hook
5387 'org-block-todo-from-checkboxes)
5388 (remove-hook 'org-blocker-hook
5389 'org-block-todo-from-checkboxes))
5391 ;; Align options lines
5392 (org-set-local
5393 'align-mode-rules-list
5394 '((org-in-buffer-settings
5395 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5396 (modes . '(org-mode)))))
5398 ;; Imenu
5399 (org-set-local 'imenu-create-index-function
5400 'org-imenu-get-tree)
5402 ;; Make isearch reveal context
5403 (if (or (featurep 'xemacs)
5404 (not (boundp 'outline-isearch-open-invisible-function)))
5405 ;; Emacs 21 and XEmacs make use of the hook
5406 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5407 ;; Emacs 22 deals with this through a special variable
5408 (org-set-local 'outline-isearch-open-invisible-function
5409 (lambda (&rest ignore) (org-show-context 'isearch)))
5410 (org-add-hook 'isearch-mode-end-hook 'org-fix-ellipsis-at-bol 'append 'local))
5412 ;; Setup the pcomplete hooks
5413 (set (make-local-variable 'pcomplete-command-completion-function)
5414 'org-pcomplete-initial)
5415 (set (make-local-variable 'pcomplete-command-name-function)
5416 'org-command-at-point)
5417 (set (make-local-variable 'pcomplete-default-completion-function)
5418 'ignore)
5419 (set (make-local-variable 'pcomplete-parse-arguments-function)
5420 'org-parse-arguments)
5421 (set (make-local-variable 'pcomplete-termination-string) "")
5422 (when (>= emacs-major-version 23)
5423 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5425 ;; If empty file that did not turn on org-mode automatically, make it to.
5426 (if (and org-insert-mode-line-in-empty-file
5427 (org-called-interactively-p 'any)
5428 (= (point-min) (point-max)))
5429 (insert "# -*- mode: org -*-\n\n"))
5430 (unless org-inhibit-startup
5431 (org-unmodified
5432 (and org-startup-with-beamer-mode (org-beamer-mode))
5433 (when org-startup-align-all-tables
5434 (org-table-map-tables 'org-table-align 'quietly))
5435 (when org-startup-with-inline-images
5436 (org-display-inline-images))
5437 (when org-startup-with-latex-preview
5438 (org-preview-latex-fragment))
5439 (unless org-inhibit-startup-visibility-stuff
5440 (org-set-startup-visibility))))
5441 ;; Try to set org-hide correctly
5442 (set-face-foreground 'org-hide (org-find-invisible-foreground)))
5444 ;; Update `customize-package-emacs-version-alist'
5445 (add-to-list 'customize-package-emacs-version-alist
5446 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5447 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5448 ("8.0" . "24.4")))
5450 (defvar org-mode-transpose-word-syntax-table
5451 (let ((st (make-syntax-table)))
5452 (mapc (lambda(c) (modify-syntax-entry
5453 (string-to-char (car c)) "w p" st))
5454 org-emphasis-alist)
5455 st))
5457 (when (fboundp 'abbrev-table-put)
5458 (abbrev-table-put org-mode-abbrev-table
5459 :parents (list text-mode-abbrev-table)))
5461 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
5463 (defsubst org-fix-ellipsis-at-bol ()
5464 (save-excursion (goto-char (window-start)) (recenter 0)))
5466 (defun org-find-invisible-foreground ()
5467 (let ((candidates (remove
5468 "unspecified-bg"
5469 (nconc
5470 (list (face-background 'default)
5471 (face-background 'org-default))
5472 (mapcar
5473 (lambda (alist)
5474 (when (boundp alist)
5475 (cdr (assoc 'background-color (symbol-value alist)))))
5476 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5477 (list (face-foreground 'org-hide))))))
5478 (car (remove nil candidates))))
5480 (defun org-current-time (&optional rounding-minutes past)
5481 "Current time, possibly rounded to ROUNDING-MINUTES.
5482 When ROUNDING-MINUTES is not an integer, fall back on the car of
5483 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5484 the rounding returns a past time."
5485 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5486 (car org-time-stamp-rounding-minutes)))
5487 (time (decode-time)) res)
5488 (if (< r 1)
5489 (current-time)
5490 (setq res
5491 (apply 'encode-time
5492 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5493 (nthcdr 2 time))))
5494 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5495 (seconds-to-time (- (org-float-time res) (* r 60)))
5496 res))))
5498 (defun org-today ()
5499 "Return today date, considering `org-extend-today-until'."
5500 (time-to-days
5501 (time-subtract (current-time)
5502 (list 0 (* 3600 org-extend-today-until) 0))))
5504 ;;;; Font-Lock stuff, including the activators
5506 (defvar org-mouse-map (make-sparse-keymap))
5507 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5508 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5509 (when org-mouse-1-follows-link
5510 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5511 (when org-tab-follows-link
5512 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5513 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5515 (require 'font-lock)
5517 (defconst org-non-link-chars "]\t\n\r<>")
5518 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
5519 "shell" "elisp" "doi" "message"))
5520 (defvar org-link-types-re nil
5521 "Matches a link that has a url-like prefix like \"http:\"")
5522 (defvar org-link-re-with-space nil
5523 "Matches a link with spaces, optional angular brackets around it.")
5524 (defvar org-link-re-with-space2 nil
5525 "Matches a link with spaces, optional angular brackets around it.")
5526 (defvar org-link-re-with-space3 nil
5527 "Matches a link with spaces, only for internal part in bracket links.")
5528 (defvar org-angle-link-re nil
5529 "Matches link with angular brackets, spaces are allowed.")
5530 (defvar org-plain-link-re nil
5531 "Matches plain link, without spaces.")
5532 (defvar org-bracket-link-regexp nil
5533 "Matches a link in double brackets.")
5534 (defvar org-bracket-link-analytic-regexp nil
5535 "Regular expression used to analyze links.
5536 Here is what the match groups contain after a match:
5537 1: http:
5538 2: http
5539 3: path
5540 4: [desc]
5541 5: desc")
5542 (defvar org-bracket-link-analytic-regexp++ nil
5543 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5544 (defvar org-any-link-re nil
5545 "Regular expression matching any link.")
5547 (defconst org-match-sexp-depth 3
5548 "Number of stacked braces for sub/superscript matching.")
5550 (defun org-create-multibrace-regexp (left right n)
5551 "Create a regular expression which will match a balanced sexp.
5552 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5553 as single character strings.
5554 The regexp returned will match the entire expression including the
5555 delimiters. It will also define a single group which contains the
5556 match except for the outermost delimiters. The maximum depth of
5557 stacked delimiters is N. Escaping delimiters is not possible."
5558 (let* ((nothing (concat "[^" left right "]*?"))
5559 (or "\\|")
5560 (re nothing)
5561 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5562 (while (> n 1)
5563 (setq n (1- n)
5564 re (concat re or next)
5565 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5566 (concat left "\\(" re "\\)" right)))
5568 (defvar org-match-substring-regexp
5569 (concat
5570 "\\(\\S-\\)\\([_^]\\)\\("
5571 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5572 "\\|"
5573 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5574 "\\|"
5575 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
5576 "The regular expression matching a sub- or superscript.")
5578 (defvar org-match-substring-with-braces-regexp
5579 (concat
5580 "\\(\\S-\\)\\([_^]\\)\\("
5581 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5582 "\\)")
5583 "The regular expression matching a sub- or superscript, forcing braces.")
5585 (defun org-make-link-regexps ()
5586 "Update the link regular expressions.
5587 This should be called after the variable `org-link-types' has changed."
5588 (setq org-link-types-re
5589 (concat
5590 "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
5591 org-link-re-with-space
5592 (concat
5593 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5594 "\\([^" org-non-link-chars " ]"
5595 "[^" org-non-link-chars "]*"
5596 "[^" org-non-link-chars " ]\\)>?")
5597 org-link-re-with-space2
5598 (concat
5599 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5600 "\\([^" org-non-link-chars " ]"
5601 "[^\t\n\r]*"
5602 "[^" org-non-link-chars " ]\\)>?")
5603 org-link-re-with-space3
5604 (concat
5605 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5606 "\\([^" org-non-link-chars " ]"
5607 "[^\t\n\r]*\\)")
5608 org-angle-link-re
5609 (concat
5610 "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5611 "\\([^" org-non-link-chars " ]"
5612 "[^" org-non-link-chars "]*"
5613 "\\)>")
5614 org-plain-link-re
5615 (concat
5616 "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5617 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5618 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5619 org-bracket-link-regexp
5620 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5621 org-bracket-link-analytic-regexp
5622 (concat
5623 "\\[\\["
5624 "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
5625 "\\([^]]+\\)"
5626 "\\]"
5627 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5628 "\\]")
5629 org-bracket-link-analytic-regexp++
5630 (concat
5631 "\\[\\["
5632 "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
5633 "\\([^]]+\\)"
5634 "\\]"
5635 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5636 "\\]")
5637 org-any-link-re
5638 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5639 org-angle-link-re "\\)\\|\\("
5640 org-plain-link-re "\\)")))
5642 (org-make-link-regexps)
5644 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
5645 "Regular expression for fast time stamp matching.")
5646 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5647 "Regular expression for fast time stamp matching.")
5648 (defconst org-ts-regexp0
5649 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5650 "Regular expression matching time strings for analysis.
5651 This one does not require the space after the date, so it can be used
5652 on a string that terminates immediately after the date.")
5653 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5654 "Regular expression matching time strings for analysis.")
5655 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
5656 "Regular expression matching time stamps, with groups.")
5657 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
5658 "Regular expression matching time stamps (also [..]), with groups.")
5659 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5660 "Regular expression matching a time stamp range.")
5661 (defconst org-tr-regexp-both
5662 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5663 "Regular expression matching a time stamp range.")
5664 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
5665 org-ts-regexp "\\)?")
5666 "Regular expression matching a time stamp or time stamp range.")
5667 (defconst org-tsr-regexp-both
5668 (concat org-ts-regexp-both "\\(--?-?"
5669 org-ts-regexp-both "\\)?")
5670 "Regular expression matching a time stamp or time stamp range.
5671 The time stamps may be either active or inactive.")
5673 (defvar org-emph-face nil)
5675 (defun org-do-emphasis-faces (limit)
5676 "Run through the buffer and add overlays to emphasized strings."
5677 (let (rtn a)
5678 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5679 (if (not (= (char-after (match-beginning 3))
5680 (char-after (match-beginning 4))))
5681 (progn
5682 (setq rtn t)
5683 (setq a (assoc (match-string 3) org-emphasis-alist))
5684 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5685 'face
5686 (nth 1 a))
5687 (and (nth 2 a)
5688 (org-remove-flyspell-overlays-in
5689 (match-beginning 0) (match-end 0)))
5690 (add-text-properties (match-beginning 2) (match-end 2)
5691 '(font-lock-multiline t org-emphasis t))
5692 (when org-hide-emphasis-markers
5693 (add-text-properties (match-end 4) (match-beginning 5)
5694 '(invisible org-link))
5695 (add-text-properties (match-beginning 3) (match-end 3)
5696 '(invisible org-link)))))
5697 (goto-char (1+ (match-beginning 0))))
5698 rtn))
5700 (defun org-emphasize (&optional char)
5701 "Insert or change an emphasis, i.e. a font like bold or italic.
5702 If there is an active region, change that region to a new emphasis.
5703 If there is no region, just insert the marker characters and position
5704 the cursor between them.
5705 CHAR should be the marker character. If it is a space, it means to
5706 remove the emphasis of the selected region.
5707 If CHAR is not given (for example in an interactive call) it will be
5708 prompted for."
5709 (interactive)
5710 (let ((erc org-emphasis-regexp-components)
5711 (prompt "")
5712 (string "") beg end move c s)
5713 (if (org-region-active-p)
5714 (setq beg (region-beginning) end (region-end)
5715 string (buffer-substring beg end))
5716 (setq move t))
5718 (unless char
5719 (message "Emphasis marker or tag: [%s]"
5720 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5721 (setq char (read-char-exclusive)))
5722 (if (equal char ?\ )
5723 (setq s "" move nil)
5724 (unless (assoc (char-to-string char) org-emphasis-alist)
5725 (user-error "No such emphasis marker: \"%c\"" char))
5726 (setq s (char-to-string char)))
5727 (while (and (> (length string) 1)
5728 (equal (substring string 0 1) (substring string -1))
5729 (assoc (substring string 0 1) org-emphasis-alist))
5730 (setq string (substring string 1 -1)))
5731 (setq string (concat s string s))
5732 (if beg (delete-region beg end))
5733 (unless (or (bolp)
5734 (string-match (concat "[" (nth 0 erc) "\n]")
5735 (char-to-string (char-before (point)))))
5736 (insert " "))
5737 (unless (or (eobp)
5738 (string-match (concat "[" (nth 1 erc) "\n]")
5739 (char-to-string (char-after (point)))))
5740 (insert " ") (backward-char 1))
5741 (insert string)
5742 (and move (backward-char 1))))
5744 (defconst org-nonsticky-props
5745 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5747 (defsubst org-rear-nonsticky-at (pos)
5748 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5750 (defun org-activate-plain-links (limit)
5751 "Run through the buffer and add overlays to links."
5752 (let (f hl)
5753 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5754 (not (org-in-src-block-p)))
5755 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5756 (setq f (get-text-property (match-beginning 0) 'face))
5757 (setq hl (org-match-string-no-properties 0))
5758 (if (or (eq f 'org-tag)
5759 (and (listp f) (memq 'org-tag f)))
5761 (add-text-properties (match-beginning 0) (match-end 0)
5762 (list 'mouse-face 'highlight
5763 'face 'org-link
5764 'htmlize-link `(:uri ,hl)
5765 'keymap org-mouse-map))
5766 (org-rear-nonsticky-at (match-end 0)))
5767 t)))
5769 (defun org-activate-code (limit)
5770 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5771 (progn
5772 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5773 (remove-text-properties (match-beginning 0) (match-end 0)
5774 '(display t invisible t intangible t))
5775 t)))
5777 (defcustom org-src-fontify-natively nil
5778 "When non-nil, fontify code in code blocks."
5779 :type 'boolean
5780 :version "24.1"
5781 :group 'org-appearance
5782 :group 'org-babel)
5784 (defcustom org-allow-promoting-top-level-subtree nil
5785 "When non-nil, allow promoting a top level subtree.
5786 The leading star of the top level headline will be replaced
5787 by a #."
5788 :type 'boolean
5789 :version "24.1"
5790 :group 'org-appearance)
5792 (defun org-fontify-meta-lines-and-blocks (limit)
5793 (condition-case nil
5794 (org-fontify-meta-lines-and-blocks-1 limit)
5795 (error (message "org-mode fontification error"))))
5797 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5798 "Fontify #+ lines and blocks."
5799 (let ((case-fold-search t))
5800 (if (re-search-forward
5801 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5802 limit t)
5803 (let ((beg (match-beginning 0))
5804 (block-start (match-end 0))
5805 (block-end nil)
5806 (lang (match-string 7))
5807 (beg1 (line-beginning-position 2))
5808 (dc1 (downcase (match-string 2)))
5809 (dc3 (downcase (match-string 3)))
5810 end end1 quoting block-type ovl)
5811 (cond
5812 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5813 ;; a single line of backend-specific content
5814 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5815 (remove-text-properties (match-beginning 0) (match-end 0)
5816 '(display t invisible t intangible t))
5817 (add-text-properties (match-beginning 1) (match-end 3)
5818 '(font-lock-fontified t face org-meta-line))
5819 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5820 '(font-lock-fontified t face org-block))
5821 ; for backend-specific code
5823 ((and (match-end 4) (equal dc3 "+begin"))
5824 ;; Truly a block
5825 (setq block-type (downcase (match-string 5))
5826 quoting (member block-type org-protecting-blocks))
5827 (when (re-search-forward
5828 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5829 nil t) ;; on purpose, we look further than LIMIT
5830 (setq end (min (point-max) (match-end 0))
5831 end1 (min (point-max) (1- (match-beginning 0))))
5832 (setq block-end (match-beginning 0))
5833 (when quoting
5834 (remove-text-properties beg end
5835 '(display t invisible t intangible t)))
5836 (add-text-properties
5837 beg end
5838 '(font-lock-fontified t font-lock-multiline t))
5839 (add-text-properties beg beg1 '(face org-meta-line))
5840 (add-text-properties end1 (min (point-max) (1+ end))
5841 '(face org-meta-line)) ; for end_src
5842 (cond
5843 ((and lang (not (string= lang "")) org-src-fontify-natively)
5844 (org-src-font-lock-fontify-block lang block-start block-end)
5845 ;; remove old background overlays
5846 (mapc (lambda (ov)
5847 (if (eq (overlay-get ov 'face) 'org-block-background)
5848 (delete-overlay ov)))
5849 (overlays-at (/ (+ beg1 block-end) 2)))
5850 ;; add a background overlay
5851 (setq ovl (make-overlay beg1 block-end))
5852 (overlay-put ovl 'face 'org-block-background)
5853 (overlay-put ovl 'evaporate t)) ;; make it go away when empty
5854 (quoting
5855 (add-text-properties beg1 (min (point-max) (1+ end1))
5856 '(face org-block))) ; end of source block
5857 ((not org-fontify-quote-and-verse-blocks))
5858 ((string= block-type "quote")
5859 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5860 ((string= block-type "verse")
5861 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5862 (add-text-properties beg beg1 '(face org-block-begin-line))
5863 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5864 '(face org-block-end-line))
5866 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5867 (add-text-properties
5868 beg (match-end 3)
5869 (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
5870 '(font-lock-fontified t invisible t)
5871 '(font-lock-fontified t face org-document-info-keyword)))
5872 (add-text-properties
5873 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5874 (if (string-equal dc1 "+title:")
5875 '(font-lock-fontified t face org-document-title)
5876 '(font-lock-fontified t face org-document-info))))
5877 ((or (equal dc1 "+results")
5878 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5879 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5880 "+call:" "+header:" "+headers:" "+name:"))
5881 (and (match-end 4) (equal dc3 "+attr")))
5882 (add-text-properties
5883 beg (match-end 0)
5884 '(font-lock-fontified t face org-meta-line))
5886 ((member dc3 '(" " ""))
5887 (add-text-properties
5888 beg (match-end 0)
5889 '(font-lock-fontified t face font-lock-comment-face)))
5890 ((not (member (char-after beg) '(?\ ?\t)))
5891 ;; just any other in-buffer setting, but not indented
5892 (add-text-properties
5893 beg (match-end 0)
5894 '(font-lock-fontified t face org-meta-line))
5896 (t nil))))))
5898 (defun org-activate-angle-links (limit)
5899 "Run through the buffer and add overlays to links."
5900 (if (and (re-search-forward org-angle-link-re limit t)
5901 (not (org-in-src-block-p)))
5902 (progn
5903 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5904 (add-text-properties (match-beginning 0) (match-end 0)
5905 (list 'mouse-face 'highlight
5906 'keymap org-mouse-map))
5907 (org-rear-nonsticky-at (match-end 0))
5908 t)))
5910 (defun org-activate-footnote-links (limit)
5911 "Run through the buffer and add overlays to footnotes."
5912 (let ((fn (org-footnote-next-reference-or-definition limit)))
5913 (when fn
5914 (let ((beg (nth 1 fn)) (end (nth 2 fn)))
5915 (org-remove-flyspell-overlays-in beg end)
5916 (add-text-properties beg end
5917 (list 'mouse-face 'highlight
5918 'keymap org-mouse-map
5919 'help-echo
5920 (if (= (point-at-bol) beg)
5921 "Footnote definition"
5922 "Footnote reference")
5923 'font-lock-fontified t
5924 'font-lock-multiline t
5925 'face 'org-footnote))))))
5927 (defun org-activate-bracket-links (limit)
5928 "Run through the buffer and add overlays to bracketed links."
5929 (if (and (re-search-forward org-bracket-link-regexp limit t)
5930 (not (org-in-src-block-p)))
5931 (let* ((hl (org-match-string-no-properties 1))
5932 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
5933 (ip (org-maybe-intangible
5934 (list 'invisible 'org-link
5935 'keymap org-mouse-map 'mouse-face 'highlight
5936 'font-lock-multiline t 'help-echo help
5937 'htmlize-link `(:uri ,hl))))
5938 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
5939 'font-lock-multiline t 'help-echo help
5940 'htmlize-link `(:uri ,hl))))
5941 ;; We need to remove the invisible property here. Table narrowing
5942 ;; may have made some of this invisible.
5943 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5944 (remove-text-properties (match-beginning 0) (match-end 0)
5945 '(invisible nil))
5946 (if (match-end 3)
5947 (progn
5948 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5949 (org-rear-nonsticky-at (match-beginning 3))
5950 (add-text-properties (match-beginning 3) (match-end 3) vp)
5951 (org-rear-nonsticky-at (match-end 3))
5952 (add-text-properties (match-end 3) (match-end 0) ip)
5953 (org-rear-nonsticky-at (match-end 0)))
5954 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5955 (org-rear-nonsticky-at (match-beginning 1))
5956 (add-text-properties (match-beginning 1) (match-end 1) vp)
5957 (org-rear-nonsticky-at (match-end 1))
5958 (add-text-properties (match-end 1) (match-end 0) ip)
5959 (org-rear-nonsticky-at (match-end 0)))
5960 t)))
5962 (defun org-activate-dates (limit)
5963 "Run through the buffer and add overlays to dates."
5964 (if (and (re-search-forward org-tsr-regexp-both limit t)
5965 (not (equal (char-before (match-beginning 0)) 91)))
5966 (progn
5967 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5968 (add-text-properties (match-beginning 0) (match-end 0)
5969 (list 'mouse-face 'highlight
5970 'keymap org-mouse-map))
5971 (org-rear-nonsticky-at (match-end 0))
5972 (when org-display-custom-times
5973 (if (match-end 3)
5974 (org-display-custom-time (match-beginning 3) (match-end 3)))
5975 (org-display-custom-time (match-beginning 1) (match-end 1)))
5976 t)))
5978 (defvar org-target-link-regexp nil
5979 "Regular expression matching radio targets in plain text.")
5980 (make-variable-buffer-local 'org-target-link-regexp)
5981 (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
5982 "Regular expression matching a link target.")
5983 (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
5984 "Regular expression matching a radio target.")
5985 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5986 "Regular expression matching any target.")
5988 (defun org-activate-target-links (limit)
5989 "Run through the buffer and add overlays to target matches."
5990 (when org-target-link-regexp
5991 (let ((case-fold-search t))
5992 (if (re-search-forward org-target-link-regexp limit t)
5993 (progn
5994 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5995 (add-text-properties (match-beginning 0) (match-end 0)
5996 (list 'mouse-face 'highlight
5997 'keymap org-mouse-map
5998 'help-echo "Radio target link"
5999 'org-linked-text t))
6000 (org-rear-nonsticky-at (match-end 0))
6001 t)))))
6003 (defun org-update-radio-target-regexp ()
6004 "Find all radio targets in this file and update the regular expression."
6005 (interactive)
6006 (when (memq 'radio org-activate-links)
6007 (setq org-target-link-regexp
6008 (org-make-target-link-regexp (org-all-targets 'radio)))
6009 (org-restart-font-lock)))
6011 (defun org-hide-wide-columns (limit)
6012 (let (s e)
6013 (setq s (text-property-any (point) (or limit (point-max))
6014 'org-cwidth t))
6015 (when s
6016 (setq e (next-single-property-change s 'org-cwidth))
6017 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6018 (goto-char e)
6019 t)))
6021 (defvar org-latex-and-related-regexp nil
6022 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6023 (defvar org-match-substring-regexp)
6024 (defvar org-match-substring-with-braces-regexp)
6026 (defun org-compute-latex-and-related-regexp ()
6027 "Compute regular expression for LaTeX, entities and sub/superscript.
6028 Result depends on variable `org-highlight-latex-and-related'."
6029 (org-set-local
6030 'org-latex-and-related-regexp
6031 (let* ((re-sub
6032 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6033 ((eq org-use-sub-superscripts '{})
6034 (list org-match-substring-with-braces-regexp))
6035 (org-use-sub-superscripts (list org-match-substring-regexp))))
6036 (re-latex
6037 (when (memq 'latex org-highlight-latex-and-related)
6038 (let ((matchers (plist-get org-format-latex-options :matchers)))
6039 (delq nil
6040 (mapcar (lambda (x)
6041 (and (member (car x) matchers) (nth 1 x)))
6042 org-latex-regexps)))))
6043 (re-entities
6044 (when (memq 'entities org-highlight-latex-and-related)
6045 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6046 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6048 (defun org-do-latex-and-related (limit)
6049 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6050 LIMIT bounds the search for syntax to highlight. Stop at first
6051 highlighted object, if any. Return t if some highlighting was
6052 done, nil otherwise."
6053 (when (org-string-nw-p org-latex-and-related-regexp)
6054 (catch 'found
6055 (while (re-search-forward org-latex-and-related-regexp limit t)
6056 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6057 'face))
6058 '(org-code org-verbatim underline))
6059 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6060 '(?_ ?^))
6062 0)))
6063 (font-lock-prepend-text-property
6064 (+ offset (match-beginning 0)) (match-end 0)
6065 'face 'org-latex-and-related)
6066 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6067 '(font-lock-multiline t)))
6068 (throw 'found t)))
6069 nil)))
6071 (defun org-restart-font-lock ()
6072 "Restart `font-lock-mode', to force refontification."
6073 (when (and (boundp 'font-lock-mode) font-lock-mode)
6074 (font-lock-mode -1)
6075 (font-lock-mode 1)))
6077 (defun org-all-targets (&optional radio)
6078 "Return a list of all targets in this file.
6079 When optional argument RADIO is non-nil, only find radio
6080 targets."
6081 (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
6082 (save-excursion
6083 (goto-char (point-min))
6084 (while (re-search-forward re nil t)
6085 ;; Make sure point is really within the object.
6086 (backward-char)
6087 (let ((obj (org-element-context)))
6088 (when (memq (org-element-type obj) '(radio-target target))
6089 (add-to-list 'rtn (downcase (org-element-property :value obj))))))
6090 rtn)))
6092 (defun org-make-target-link-regexp (targets)
6093 "Make regular expression matching all strings in TARGETS.
6094 The regular expression finds the targets also if there is a line break
6095 between words."
6096 (and targets
6097 (concat
6098 "\\<\\("
6099 (mapconcat
6100 (lambda (x)
6101 (setq x (regexp-quote x))
6102 (while (string-match " +" x)
6103 (setq x (replace-match "\\s-+" t t x)))
6105 targets
6106 "\\|")
6107 "\\)\\>")))
6109 (defun org-activate-tags (limit)
6110 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6111 (progn
6112 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6113 (add-text-properties (match-beginning 1) (match-end 1)
6114 (list 'mouse-face 'highlight
6115 'keymap org-mouse-map))
6116 (org-rear-nonsticky-at (match-end 1))
6117 t)))
6119 (defun org-outline-level ()
6120 "Compute the outline level of the heading at point.
6121 If this is called at a normal headline, the level is the number of stars.
6122 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6123 (save-excursion
6124 (if (not (condition-case nil
6125 (org-back-to-heading t)
6126 (error nil)))
6128 (looking-at org-outline-regexp)
6129 (1- (- (match-end 0) (match-beginning 0))))))
6131 (defvar org-font-lock-keywords nil)
6133 (defsubst org-re-property (property &optional literal)
6134 "Return a regexp matching a PROPERTY line.
6135 Match group 3 will be set to the value if it exists."
6136 (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
6137 (if literal property (regexp-quote property))
6138 "\\):\\)[ \t]+\\(?3:[^ \t\r\n].*?\\)\\(?5:[ \t]*\\)$"))
6140 (defconst org-property-re
6141 (org-re-property ".*?" 'literal)
6142 "Regular expression matching a property line.
6143 There are four matching groups:
6144 1: :PROPKEY: including the leading and trailing colon,
6145 2: PROPKEY without the leading and trailing colon,
6146 3: PROPVAL without leading or trailing spaces,
6147 4: the indentation of the current line,
6148 5: trailing whitespace.")
6150 (defvar org-font-lock-hook nil
6151 "Functions to be called for special font lock stuff.")
6153 (defvar org-font-lock-set-keywords-hook nil
6154 "Functions that can manipulate `org-font-lock-extra-keywords'.
6155 This is called after `org-font-lock-extra-keywords' is defined, but before
6156 it is installed to be used by font lock. This can be useful if something
6157 needs to be inserted at a specific position in the font-lock sequence.")
6159 (defun org-font-lock-hook (limit)
6160 "Run `org-font-lock-hook' within LIMIT."
6161 (run-hook-with-args 'org-font-lock-hook limit))
6163 (defun org-set-font-lock-defaults ()
6164 "Set font lock defaults for the current buffer."
6165 (let* ((em org-fontify-emphasized-text)
6166 (lk org-activate-links)
6167 (org-font-lock-extra-keywords
6168 (list
6169 ;; Call the hook
6170 '(org-font-lock-hook)
6171 ;; Headlines
6172 `(,(if org-fontify-whole-heading-line
6173 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6174 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6175 (1 (org-get-level-face 1))
6176 (2 (org-get-level-face 2))
6177 (3 (org-get-level-face 3)))
6178 ;; Table lines
6179 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6180 (1 'org-table t))
6181 ;; Table internals
6182 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6183 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6184 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6185 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6186 ;; Drawers
6187 (list org-drawer-regexp '(0 'org-special-keyword t))
6188 (list "^[ \t]*:END:" '(0 'org-special-keyword t))
6189 ;; Properties
6190 (list org-property-re
6191 '(1 'org-special-keyword t)
6192 '(3 'org-property-value t))
6193 ;; Links
6194 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6195 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6196 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6197 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6198 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
6199 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6200 (if (memq 'footnote lk) '(org-activate-footnote-links))
6201 ;; Targets.
6202 (list org-any-target-regexp '(0 'org-target t))
6203 ;; Diary sexps.
6204 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6205 ;; Macro
6206 '("{{{.+}}}" (0 'org-macro t))
6207 '(org-hide-wide-columns (0 nil append))
6208 ;; TODO keyword
6209 (list (format org-heading-keyword-regexp-format
6210 org-todo-regexp)
6211 '(2 (org-get-todo-face 2) t))
6212 ;; DONE
6213 (if org-fontify-done-headline
6214 (list (format org-heading-keyword-regexp-format
6215 (concat
6216 "\\(?:"
6217 (mapconcat 'regexp-quote org-done-keywords "\\|")
6218 "\\)"))
6219 '(2 'org-headline-done t))
6220 nil)
6221 ;; Priorities
6222 '(org-font-lock-add-priority-faces)
6223 ;; Tags
6224 '(org-font-lock-add-tag-faces)
6225 ;; Tags groups
6226 (if (and org-group-tags org-tag-groups-alist)
6227 (list (concat org-outline-regexp-bol ".+\\(:"
6228 (regexp-opt (mapcar 'car org-tag-groups-alist))
6229 ":\\).*$")
6230 '(1 'org-tag-group prepend)))
6231 ;; Special keywords
6232 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6233 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6234 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6235 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6236 ;; Emphasis
6237 (if em
6238 (if (featurep 'xemacs)
6239 '(org-do-emphasis-faces (0 nil append))
6240 '(org-do-emphasis-faces)))
6241 ;; Checkboxes
6242 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6243 1 'org-checkbox prepend)
6244 (if (cdr (assq 'checkbox org-list-automatic-rules))
6245 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6246 (0 (org-get-checkbox-statistics-face) t)))
6247 ;; Description list items
6248 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6249 1 'org-list-dt prepend)
6250 ;; ARCHIVEd headings
6251 (list (concat
6252 org-outline-regexp-bol
6253 "\\(.*:" org-archive-tag ":.*\\)")
6254 '(1 'org-archived prepend))
6255 ;; Specials
6256 '(org-do-latex-and-related)
6257 '(org-fontify-entities)
6258 '(org-raise-scripts)
6259 ;; Code
6260 '(org-activate-code (1 'org-code t))
6261 ;; COMMENT
6262 (list (format org-heading-keyword-regexp-format
6263 (concat "\\("
6264 org-comment-string "\\|" org-quote-string
6265 "\\)"))
6266 '(2 'org-special-keyword t))
6267 ;; Blocks and meta lines
6268 '(org-fontify-meta-lines-and-blocks))))
6269 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6270 (run-hooks 'org-font-lock-set-keywords-hook)
6271 ;; Now set the full font-lock-keywords
6272 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6273 (org-set-local 'font-lock-defaults
6274 '(org-font-lock-keywords t nil nil backward-paragraph))
6275 (kill-local-variable 'font-lock-keywords) nil))
6277 (defun org-toggle-pretty-entities ()
6278 "Toggle the composition display of entities as UTF8 characters."
6279 (interactive)
6280 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6281 (org-restart-font-lock)
6282 (if org-pretty-entities
6283 (message "Entities are now displayed as UTF8 characters")
6284 (save-restriction
6285 (widen)
6286 (org-decompose-region (point-min) (point-max))
6287 (message "Entities are now displayed as plain text"))))
6289 (defvar org-custom-properties-overlays nil
6290 "List of overlays used for custom properties.")
6291 (make-variable-buffer-local 'org-custom-properties-overlays)
6293 (defun org-toggle-custom-properties-visibility ()
6294 "Display or hide properties in `org-custom-properties'."
6295 (interactive)
6296 (if org-custom-properties-overlays
6297 (progn (mapc 'delete-overlay org-custom-properties-overlays)
6298 (setq org-custom-properties-overlays nil))
6299 (unless (not org-custom-properties)
6300 (save-excursion
6301 (save-restriction
6302 (widen)
6303 (goto-char (point-min))
6304 (while (re-search-forward org-property-re nil t)
6305 (mapc (lambda(p)
6306 (when (equal p (substring (match-string 1) 1 -1))
6307 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6308 (overlay-put o 'invisible t)
6309 (overlay-put o 'org-custom-property t)
6310 (push o org-custom-properties-overlays))))
6311 org-custom-properties)))))))
6313 (defun org-fontify-entities (limit)
6314 "Find an entity to fontify."
6315 (let (ee)
6316 (when org-pretty-entities
6317 (catch 'match
6318 (while (re-search-forward
6319 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6320 limit t)
6321 (if (and (not (org-in-indented-comment-line))
6322 (setq ee (org-entity-get (match-string 1)))
6323 (= (length (nth 6 ee)) 1))
6324 (let*
6325 ((end (if (equal (match-string 2) "{}")
6326 (match-end 2)
6327 (match-end 1))))
6328 (add-text-properties
6329 (match-beginning 0) end
6330 (list 'font-lock-fontified t))
6331 (compose-region (match-beginning 0) end
6332 (nth 6 ee) nil)
6333 (backward-char 1)
6334 (throw 'match t))))
6335 nil))))
6337 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6338 "Fontify string S like in Org-mode."
6339 (with-temp-buffer
6340 (insert s)
6341 (let ((org-odd-levels-only odd-levels))
6342 (org-mode)
6343 (font-lock-fontify-buffer)
6344 (buffer-string))))
6346 (defvar org-m nil)
6347 (defvar org-l nil)
6348 (defvar org-f nil)
6349 (defun org-get-level-face (n)
6350 "Get the right face for match N in font-lock matching of headlines."
6351 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6352 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6353 (if org-cycle-level-faces
6354 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6355 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6356 (cond
6357 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6358 ((eq n 2) org-f)
6359 (t (if org-level-color-stars-only nil org-f))))
6362 (defun org-get-todo-face (kwd)
6363 "Get the right face for a TODO keyword KWD.
6364 If KWD is a number, get the corresponding match group."
6365 (if (numberp kwd) (setq kwd (match-string kwd)))
6366 (or (org-face-from-face-or-color
6367 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6368 (and (member kwd org-done-keywords) 'org-done)
6369 'org-todo))
6371 (defun org-face-from-face-or-color (context inherit face-or-color)
6372 "Create a face list that inherits INHERIT, but sets the foreground color.
6373 When FACE-OR-COLOR is not a string, just return it."
6374 (if (stringp face-or-color)
6375 (list :inherit inherit
6376 (cdr (assoc context org-faces-easy-properties))
6377 face-or-color)
6378 face-or-color))
6380 (defun org-font-lock-add-tag-faces (limit)
6381 "Add the special tag faces."
6382 (when (and org-tag-faces org-tags-special-faces-re)
6383 (while (re-search-forward org-tags-special-faces-re limit t)
6384 (add-text-properties (match-beginning 1) (match-end 1)
6385 (list 'face (org-get-tag-face 1)
6386 'font-lock-fontified t))
6387 (backward-char 1))))
6389 (defun org-font-lock-add-priority-faces (limit)
6390 "Add the special priority faces."
6391 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6392 (when (save-match-data (org-at-heading-p))
6393 (add-text-properties
6394 (match-beginning 0) (match-end 0)
6395 (list 'face (or (org-face-from-face-or-color
6396 'priority 'org-priority
6397 (cdr (assoc (char-after (match-beginning 1))
6398 org-priority-faces)))
6399 'org-priority)
6400 'font-lock-fontified t)))))
6402 (defun org-get-tag-face (kwd)
6403 "Get the right face for a TODO keyword KWD.
6404 If KWD is a number, get the corresponding match group."
6405 (if (numberp kwd) (setq kwd (match-string kwd)))
6406 (or (org-face-from-face-or-color
6407 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6408 'org-tag))
6410 (defun org-unfontify-region (beg end &optional maybe_loudly)
6411 "Remove fontification and activation overlays from links."
6412 (font-lock-default-unfontify-region beg end)
6413 (let* ((buffer-undo-list t)
6414 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6415 (inhibit-modification-hooks t)
6416 deactivate-mark buffer-file-name buffer-file-truename)
6417 (org-decompose-region beg end)
6418 (remove-text-properties beg end
6419 '(mouse-face t keymap t org-linked-text t
6420 invisible t intangible t
6421 org-no-flyspell t org-emphasis t))
6422 (org-remove-font-lock-display-properties beg end)))
6424 (defconst org-script-display '(((raise -0.3) (height 0.7))
6425 ((raise 0.3) (height 0.7))
6426 ((raise -0.5))
6427 ((raise 0.5)))
6428 "Display properties for showing superscripts and subscripts.")
6430 (defun org-remove-font-lock-display-properties (beg end)
6431 "Remove specific display properties that have been added by font lock.
6432 The will remove the raise properties that are used to show superscripts
6433 and subscripts."
6434 (let (next prop)
6435 (while (< beg end)
6436 (setq next (next-single-property-change beg 'display nil end)
6437 prop (get-text-property beg 'display))
6438 (if (member prop org-script-display)
6439 (put-text-property beg next 'display nil))
6440 (setq beg next))))
6442 (defun org-raise-scripts (limit)
6443 "Add raise properties to sub/superscripts."
6444 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6445 (if (re-search-forward
6446 (if (eq org-use-sub-superscripts t)
6447 org-match-substring-regexp
6448 org-match-substring-with-braces-regexp)
6449 limit t)
6450 (let* ((pos (point)) table-p comment-p
6451 (mpos (match-beginning 3))
6452 (emph-p (get-text-property mpos 'org-emphasis))
6453 (link-p (get-text-property mpos 'mouse-face))
6454 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6455 (goto-char (point-at-bol))
6456 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6457 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6458 (goto-char pos)
6459 ;; Handle a_b^c
6460 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6461 (if (or comment-p emph-p link-p keyw-p)
6463 (put-text-property (match-beginning 3) (match-end 0)
6464 'display
6465 (if (equal (char-after (match-beginning 2)) ?^)
6466 (nth (if table-p 3 1) org-script-display)
6467 (nth (if table-p 2 0) org-script-display)))
6468 (add-text-properties (match-beginning 2) (match-end 2)
6469 (list 'invisible t
6470 'org-dwidth t 'org-dwidth-n 1))
6471 (if (and (eq (char-after (match-beginning 3)) ?{)
6472 (eq (char-before (match-end 3)) ?}))
6473 (progn
6474 (add-text-properties
6475 (match-beginning 3) (1+ (match-beginning 3))
6476 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6477 (add-text-properties
6478 (1- (match-end 3)) (match-end 3)
6479 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6480 t)))))
6482 ;;;; Visibility cycling, including org-goto and indirect buffer
6484 ;;; Cycling
6486 (defvar org-cycle-global-status nil)
6487 (make-variable-buffer-local 'org-cycle-global-status)
6488 (put 'org-cycle-global-status 'org-state t)
6489 (defvar org-cycle-subtree-status nil)
6490 (make-variable-buffer-local 'org-cycle-subtree-status)
6491 (put 'org-cycle-subtree-status 'org-state t)
6493 (defvar org-inlinetask-min-level)
6495 (defun org-unlogged-message (&rest args)
6496 "Display a message, but avoid logging it in the *Messages* buffer."
6497 (let ((message-log-max nil))
6498 (apply 'message args)))
6500 ;;;###autoload
6501 (defun org-cycle (&optional arg)
6502 "TAB-action and visibility cycling for Org-mode.
6504 This is the command invoked in Org-mode by the TAB key. Its main purpose
6505 is outline visibility cycling, but it also invokes other actions
6506 in special contexts.
6508 - When this function is called with a prefix argument, rotate the entire
6509 buffer through 3 states (global cycling)
6510 1. OVERVIEW: Show only top-level headlines.
6511 2. CONTENTS: Show all headlines of all levels, but no body text.
6512 3. SHOW ALL: Show everything.
6513 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6514 determined by the variable `org-startup-folded', and by any VISIBILITY
6515 properties in the buffer.
6516 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6517 including any drawers.
6519 - When inside a table, re-align the table and move to the next field.
6521 - When point is at the beginning of a headline, rotate the subtree started
6522 by this line through 3 different states (local cycling)
6523 1. FOLDED: Only the main headline is shown.
6524 2. CHILDREN: The main headline and the direct children are shown.
6525 From this state, you can move to one of the children
6526 and zoom in further.
6527 3. SUBTREE: Show the entire subtree, including body text.
6528 If there is no subtree, switch directly from CHILDREN to FOLDED.
6530 - When point is at the beginning of an empty headline and the variable
6531 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6532 of the headline by demoting and promoting it to likely levels. This
6533 speeds up creation document structure by pressing TAB once or several
6534 times right after creating a new headline.
6536 - When there is a numeric prefix, go up to a heading with level ARG, do
6537 a `show-subtree' and return to the previous cursor position. If ARG
6538 is negative, go up that many levels.
6540 - When point is not at the beginning of a headline, execute the global
6541 binding for TAB, which is re-indenting the line. See the option
6542 `org-cycle-emulate-tab' for details.
6544 - Special case: if point is at the beginning of the buffer and there is
6545 no headline in line 1, this function will act as if called with prefix arg
6546 (C-u TAB, same as S-TAB) also when called without prefix arg.
6547 But only if also the variable `org-cycle-global-at-bob' is t."
6548 (interactive "P")
6549 (org-load-modules-maybe)
6550 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6551 (and org-cycle-level-after-item/entry-creation
6552 (or (org-cycle-level)
6553 (org-cycle-item-indentation))))
6554 (let* ((limit-level
6555 (or org-cycle-max-level
6556 (and (boundp 'org-inlinetask-min-level)
6557 org-inlinetask-min-level
6558 (1- org-inlinetask-min-level))))
6559 (nstars (and limit-level
6560 (if org-odd-levels-only
6561 (and limit-level (1- (* limit-level 2)))
6562 limit-level)))
6563 (org-outline-regexp
6564 (if (not (derived-mode-p 'org-mode))
6565 outline-regexp
6566 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6567 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6568 (not (looking-at org-outline-regexp))))
6569 (org-cycle-hook
6570 (if bob-special
6571 (delq 'org-optimize-window-after-visibility-change
6572 (copy-sequence org-cycle-hook))
6573 org-cycle-hook))
6574 (pos (point)))
6576 (if (or bob-special (equal arg '(4)))
6577 ;; special case: use global cycling
6578 (setq arg t))
6580 (cond
6582 ((equal arg '(16))
6583 (setq last-command 'dummy)
6584 (org-set-startup-visibility)
6585 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6587 ((equal arg '(64))
6588 (show-all)
6589 (org-unlogged-message "Entire buffer visible, including drawers"))
6591 ;; Table: enter it or move to the next field.
6592 ((org-at-table-p 'any)
6593 (if (org-at-table.el-p)
6594 (message "Use C-c ' to edit table.el tables")
6595 (if arg (org-table-edit-field t)
6596 (org-table-justify-field-maybe)
6597 (call-interactively 'org-table-next-field))))
6599 ((run-hook-with-args-until-success
6600 'org-tab-after-check-for-table-hook))
6602 ;; Global cycling: delegate to `org-cycle-internal-global'.
6603 ((eq arg t) (org-cycle-internal-global))
6605 ;; Drawers: delegate to `org-flag-drawer'.
6606 ((and org-drawers org-drawer-regexp
6607 (save-excursion
6608 (beginning-of-line 1)
6609 (looking-at org-drawer-regexp)))
6610 (org-flag-drawer ; toggle block visibility
6611 (not (get-char-property (match-end 0) 'invisible))))
6613 ;; Show-subtree, ARG levels up from here.
6614 ((integerp arg)
6615 (save-excursion
6616 (org-back-to-heading)
6617 (outline-up-heading (if (< arg 0) (- arg)
6618 (- (funcall outline-level) arg)))
6619 (org-show-subtree)))
6621 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6622 ((and (featurep 'org-inlinetask)
6623 (org-inlinetask-at-task-p)
6624 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6625 (org-inlinetask-toggle-visibility))
6627 ((org-try-cdlatex-tab))
6629 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6630 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6631 (save-excursion (beginning-of-line 1)
6632 (looking-at org-outline-regexp)))
6633 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6634 (org-cycle-internal-local))
6636 ;; From there: TAB emulation and template completion.
6637 (buffer-read-only (org-back-to-heading))
6639 ((run-hook-with-args-until-success
6640 'org-tab-after-check-for-cycling-hook))
6642 ((org-try-structure-completion))
6644 ((run-hook-with-args-until-success
6645 'org-tab-before-tab-emulation-hook))
6647 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6648 (or (not (bolp))
6649 (not (looking-at org-outline-regexp))))
6650 (call-interactively (global-key-binding "\t")))
6652 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6653 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6654 (or (and (eq org-cycle-emulate-tab 'white)
6655 (= (match-end 0) (point-at-eol)))
6656 (and (eq org-cycle-emulate-tab 'whitestart)
6657 (>= (match-end 0) pos))))
6659 (eq org-cycle-emulate-tab t))
6660 (call-interactively (global-key-binding "\t")))
6662 (t (save-excursion
6663 (org-back-to-heading)
6664 (org-cycle)))))))
6666 (defun org-cycle-internal-global ()
6667 "Do the global cycling action."
6668 ;; Hack to avoid display of messages for .org attachments in Gnus
6669 (let ((ga (string-match "\\*fontification" (buffer-name))))
6670 (cond
6671 ((and (eq last-command this-command)
6672 (eq org-cycle-global-status 'overview))
6673 ;; We just created the overview - now do table of contents
6674 ;; This can be slow in very large buffers, so indicate action
6675 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6676 (unless ga (org-unlogged-message "CONTENTS..."))
6677 (org-content)
6678 (unless ga (org-unlogged-message "CONTENTS...done"))
6679 (setq org-cycle-global-status 'contents)
6680 (run-hook-with-args 'org-cycle-hook 'contents))
6682 ((and (eq last-command this-command)
6683 (eq org-cycle-global-status 'contents))
6684 ;; We just showed the table of contents - now show everything
6685 (run-hook-with-args 'org-pre-cycle-hook 'all)
6686 (show-all)
6687 (unless ga (org-unlogged-message "SHOW ALL"))
6688 (setq org-cycle-global-status 'all)
6689 (run-hook-with-args 'org-cycle-hook 'all))
6692 ;; Default action: go to overview
6693 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6694 (org-overview)
6695 (unless ga (org-unlogged-message "OVERVIEW"))
6696 (setq org-cycle-global-status 'overview)
6697 (run-hook-with-args 'org-cycle-hook 'overview)))))
6699 (defvar org-called-with-limited-levels);Dyn-bound in ̀org-with-limited-levels'.
6701 (defun org-cycle-internal-local ()
6702 "Do the local cycling action."
6703 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6704 ;; First, determine end of headline (EOH), end of subtree or item
6705 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6706 (save-excursion
6707 (if (org-at-item-p)
6708 (progn
6709 (beginning-of-line)
6710 (setq struct (org-list-struct))
6711 (setq eoh (point-at-eol))
6712 (setq eos (org-list-get-item-end-before-blank (point) struct))
6713 (setq has-children (org-list-has-child-p (point) struct)))
6714 (org-back-to-heading)
6715 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6716 (setq eos (save-excursion (1- (org-end-of-subtree t t))))
6717 (setq has-children
6718 (or (save-excursion
6719 (let ((level (funcall outline-level)))
6720 (outline-next-heading)
6721 (and (org-at-heading-p t)
6722 (> (funcall outline-level) level))))
6723 (save-excursion
6724 (org-list-search-forward (org-item-beginning-re) eos t)))))
6725 ;; Determine end invisible part of buffer (EOL)
6726 (beginning-of-line 2)
6727 ;; XEmacs doesn't have `next-single-char-property-change'
6728 (if (featurep 'xemacs)
6729 (while (and (not (eobp)) ;; this is like `next-line'
6730 (get-char-property (1- (point)) 'invisible))
6731 (beginning-of-line 2))
6732 (while (and (not (eobp)) ;; this is like `next-line'
6733 (get-char-property (1- (point)) 'invisible))
6734 (goto-char (next-single-char-property-change (point) 'invisible))
6735 (and (eolp) (beginning-of-line 2))))
6736 (setq eol (point)))
6737 ;; Find out what to do next and set `this-command'
6738 (cond
6739 ((= eos eoh)
6740 ;; Nothing is hidden behind this heading
6741 (unless (org-before-first-heading-p)
6742 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6743 (org-unlogged-message "EMPTY ENTRY")
6744 (setq org-cycle-subtree-status nil)
6745 (save-excursion
6746 (goto-char eos)
6747 (outline-next-heading)
6748 (if (outline-invisible-p) (org-flag-heading nil))))
6749 ((and (or (>= eol eos)
6750 (not (string-match "\\S-" (buffer-substring eol eos))))
6751 (or has-children
6752 (not (setq children-skipped
6753 org-cycle-skip-children-state-if-no-children))))
6754 ;; Entire subtree is hidden in one line: children view
6755 (unless (org-before-first-heading-p)
6756 (run-hook-with-args 'org-pre-cycle-hook 'children))
6757 (if (org-at-item-p)
6758 (org-list-set-item-visibility (point-at-bol) struct 'children)
6759 (org-show-entry)
6760 (org-with-limited-levels (show-children))
6761 ;; FIXME: This slows down the func way too much.
6762 ;; How keep drawers hidden in subtree anyway?
6763 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6764 ;; (org-cycle-hide-drawers 'subtree))
6766 ;; Fold every list in subtree to top-level items.
6767 (when (eq org-cycle-include-plain-lists 'integrate)
6768 (save-excursion
6769 (org-back-to-heading)
6770 (while (org-list-search-forward (org-item-beginning-re) eos t)
6771 (beginning-of-line 1)
6772 (let* ((struct (org-list-struct))
6773 (prevs (org-list-prevs-alist struct))
6774 (end (org-list-get-bottom-point struct)))
6775 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6776 (org-list-get-all-items (point) struct prevs))
6777 (goto-char (if (< end eos) end eos)))))))
6778 (org-unlogged-message "CHILDREN")
6779 (save-excursion
6780 (goto-char eos)
6781 (outline-next-heading)
6782 (if (outline-invisible-p) (org-flag-heading nil)))
6783 (setq org-cycle-subtree-status 'children)
6784 (unless (org-before-first-heading-p)
6785 (run-hook-with-args 'org-cycle-hook 'children)))
6786 ((or children-skipped
6787 (and (eq last-command this-command)
6788 (eq org-cycle-subtree-status 'children)))
6789 ;; We just showed the children, or no children are there,
6790 ;; now show everything.
6791 (unless (org-before-first-heading-p)
6792 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6793 (outline-flag-region eoh eos nil)
6794 (org-unlogged-message
6795 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6796 (setq org-cycle-subtree-status 'subtree)
6797 (unless (org-before-first-heading-p)
6798 (run-hook-with-args 'org-cycle-hook 'subtree)))
6800 ;; Default action: hide the subtree.
6801 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6802 (outline-flag-region eoh eos t)
6803 (org-unlogged-message "FOLDED")
6804 (setq org-cycle-subtree-status 'folded)
6805 (unless (org-before-first-heading-p)
6806 (run-hook-with-args 'org-cycle-hook 'folded))))))
6808 ;;;###autoload
6809 (defun org-global-cycle (&optional arg)
6810 "Cycle the global visibility. For details see `org-cycle'.
6811 With \\[universal-argument] prefix arg, switch to startup visibility.
6812 With a numeric prefix, show all headlines up to that level."
6813 (interactive "P")
6814 (let ((org-cycle-include-plain-lists
6815 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6816 (cond
6817 ((integerp arg)
6818 (show-all)
6819 (hide-sublevels arg)
6820 (setq org-cycle-global-status 'contents))
6821 ((equal arg '(4))
6822 (org-set-startup-visibility)
6823 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6825 (org-cycle '(4))))))
6827 (defun org-set-startup-visibility ()
6828 "Set the visibility required by startup options and properties."
6829 (cond
6830 ((eq org-startup-folded t)
6831 (org-overview))
6832 ((eq org-startup-folded 'content)
6833 (org-content))
6834 ((or (eq org-startup-folded 'showeverything)
6835 (eq org-startup-folded nil))
6836 (show-all)))
6837 (unless (eq org-startup-folded 'showeverything)
6838 (if org-hide-block-startup (org-hide-block-all))
6839 (org-set-visibility-according-to-property 'no-cleanup)
6840 (org-cycle-hide-archived-subtrees 'all)
6841 (org-cycle-hide-drawers 'all)
6842 (org-cycle-show-empty-lines t)))
6844 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6845 "Switch subtree visibilities according to :VISIBILITY: property."
6846 (interactive)
6847 (let (org-show-entry-below state)
6848 (save-excursion
6849 (goto-char (point-min))
6850 (while (re-search-forward
6851 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6852 nil t)
6853 (setq state (match-string 1))
6854 (save-excursion
6855 (org-back-to-heading t)
6856 (hide-subtree)
6857 (org-reveal)
6858 (cond
6859 ((equal state '("fold" "folded"))
6860 (hide-subtree))
6861 ((equal state "children")
6862 (org-show-hidden-entry)
6863 (show-children))
6864 ((equal state "content")
6865 (save-excursion
6866 (save-restriction
6867 (org-narrow-to-subtree)
6868 (org-content))))
6869 ((member state '("all" "showall"))
6870 (show-subtree)))))
6871 (unless no-cleanup
6872 (org-cycle-hide-archived-subtrees 'all)
6873 (org-cycle-hide-drawers 'all)
6874 (org-cycle-show-empty-lines 'all)))))
6876 ;; This function uses outline-regexp instead of the more fundamental
6877 ;; org-outline-regexp so that org-cycle-global works outside of Org
6878 ;; buffers, where outline-regexp is needed.
6879 (defun org-overview ()
6880 "Switch to overview mode, showing only top-level headlines.
6881 Really, this shows all headlines with level equal or greater than the level
6882 of the first headline in the buffer. This is important, because if the
6883 first headline is not level one, then (hide-sublevels 1) gives confusing
6884 results."
6885 (interactive)
6886 (let ((pos (point))
6887 (level (save-excursion
6888 (goto-char (point-min))
6889 (if (re-search-forward (concat "^" outline-regexp) nil t)
6890 (progn
6891 (goto-char (match-beginning 0))
6892 (funcall outline-level))))))
6893 (and level (hide-sublevels level))
6894 (recenter '(4))
6895 (goto-char pos)))
6897 (defun org-content (&optional arg)
6898 "Show all headlines in the buffer, like a table of contents.
6899 With numerical argument N, show content up to level N."
6900 (interactive "P")
6901 (save-excursion
6902 ;; Visit all headings and show their offspring
6903 (and (integerp arg) (org-overview))
6904 (goto-char (point-max))
6905 (catch 'exit
6906 (while (and (progn (condition-case nil
6907 (outline-previous-visible-heading 1)
6908 (error (goto-char (point-min))))
6910 (looking-at org-outline-regexp))
6911 (if (integerp arg)
6912 (show-children (1- arg))
6913 (show-branches))
6914 (if (bobp) (throw 'exit nil))))))
6916 (defun org-optimize-window-after-visibility-change (state)
6917 "Adjust the window after a change in outline visibility.
6918 This function is the default value of the hook `org-cycle-hook'."
6919 (when (get-buffer-window (current-buffer))
6920 (cond
6921 ((eq state 'content) nil)
6922 ((eq state 'all) nil)
6923 ((eq state 'folded) nil)
6924 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6925 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6927 (defun org-remove-empty-overlays-at (pos)
6928 "Remove outline overlays that do not contain non-white stuff."
6929 (mapc
6930 (lambda (o)
6931 (and (eq 'outline (overlay-get o 'invisible))
6932 (not (string-match "\\S-" (buffer-substring (overlay-start o)
6933 (overlay-end o))))
6934 (delete-overlay o)))
6935 (overlays-at pos)))
6937 (defun org-clean-visibility-after-subtree-move ()
6938 "Fix visibility issues after moving a subtree."
6939 ;; First, find a reasonable region to look at:
6940 ;; Start two siblings above, end three below
6941 (let* ((beg (save-excursion
6942 (and (org-get-last-sibling)
6943 (org-get-last-sibling))
6944 (point)))
6945 (end (save-excursion
6946 (and (org-get-next-sibling)
6947 (org-get-next-sibling)
6948 (org-get-next-sibling))
6949 (if (org-at-heading-p)
6950 (point-at-eol)
6951 (point))))
6952 (level (looking-at "\\*+"))
6953 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
6954 (save-excursion
6955 (save-restriction
6956 (narrow-to-region beg end)
6957 (when re
6958 ;; Properly fold already folded siblings
6959 (goto-char (point-min))
6960 (while (re-search-forward re nil t)
6961 (if (and (not (outline-invisible-p))
6962 (save-excursion
6963 (goto-char (point-at-eol)) (outline-invisible-p)))
6964 (hide-entry))))
6965 (org-cycle-show-empty-lines 'overview)
6966 (org-cycle-hide-drawers 'overview)))))
6968 (defun org-cycle-show-empty-lines (state)
6969 "Show empty lines above all visible headlines.
6970 The region to be covered depends on STATE when called through
6971 `org-cycle-hook'. Lisp program can use t for STATE to get the
6972 entire buffer covered. Note that an empty line is only shown if there
6973 are at least `org-cycle-separator-lines' empty lines before the headline."
6974 (when (not (= org-cycle-separator-lines 0))
6975 (save-excursion
6976 (let* ((n (abs org-cycle-separator-lines))
6977 (re (cond
6978 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
6979 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
6980 (t (let ((ns (number-to-string (- n 2))))
6981 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
6982 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
6983 beg end b e)
6984 (cond
6985 ((memq state '(overview contents t))
6986 (setq beg (point-min) end (point-max)))
6987 ((memq state '(children folded))
6988 (setq beg (point) end (progn (org-end-of-subtree t t)
6989 (beginning-of-line 2)
6990 (point)))))
6991 (when beg
6992 (goto-char beg)
6993 (while (re-search-forward re end t)
6994 (unless (get-char-property (match-end 1) 'invisible)
6995 (setq e (match-end 1))
6996 (if (< org-cycle-separator-lines 0)
6997 (setq b (save-excursion
6998 (goto-char (match-beginning 0))
6999 (org-back-over-empty-lines)
7000 (if (save-excursion
7001 (goto-char (max (point-min) (1- (point))))
7002 (org-at-heading-p))
7003 (1- (point))
7004 (point))))
7005 (setq b (match-beginning 1)))
7006 (outline-flag-region b e nil)))))))
7007 ;; Never hide empty lines at the end of the file.
7008 (save-excursion
7009 (goto-char (point-max))
7010 (outline-previous-heading)
7011 (outline-end-of-heading)
7012 (if (and (looking-at "[ \t\n]+")
7013 (= (match-end 0) (point-max)))
7014 (outline-flag-region (point) (match-end 0) nil))))
7016 (defun org-show-empty-lines-in-parent ()
7017 "Move to the parent and re-show empty lines before visible headlines."
7018 (save-excursion
7019 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7020 (org-cycle-show-empty-lines context))))
7022 (defun org-files-list ()
7023 "Return `org-agenda-files' list, plus all open org-mode files.
7024 This is useful for operations that need to scan all of a user's
7025 open and agenda-wise Org files."
7026 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7027 (dolist (buf (buffer-list))
7028 (with-current-buffer buf
7029 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7030 (let ((file (expand-file-name (buffer-file-name))))
7031 (unless (member file files)
7032 (push file files))))))
7033 files))
7035 (defsubst org-entry-beginning-position ()
7036 "Return the beginning position of the current entry."
7037 (save-excursion (outline-back-to-heading t) (point)))
7039 (defsubst org-entry-end-position ()
7040 "Return the end position of the current entry."
7041 (save-excursion (outline-next-heading) (point)))
7043 (defun org-cycle-hide-drawers (state)
7044 "Re-hide all drawers after a visibility state change."
7045 (when (and (derived-mode-p 'org-mode)
7046 (not (memq state '(overview folded contents))))
7047 (save-excursion
7048 (let* ((globalp (memq state '(contents all)))
7049 (beg (if globalp (point-min) (point)))
7050 (end (if globalp (point-max)
7051 (if (eq state 'children)
7052 (save-excursion (outline-next-heading) (point))
7053 (org-end-of-subtree t)))))
7054 (goto-char beg)
7055 (while (re-search-forward org-drawer-regexp end t)
7056 (org-flag-drawer t))))))
7058 (defun org-cycle-hide-inline-tasks (state)
7059 "Re-hide inline tasks when switching to 'contents or 'children
7060 visibility state."
7061 (case state
7062 (contents
7063 (when (org-bound-and-true-p org-inlinetask-min-level)
7064 (hide-sublevels (1- org-inlinetask-min-level))))
7065 (children
7066 (when (featurep 'org-inlinetask)
7067 (save-excursion
7068 (while (and (outline-next-heading)
7069 (org-inlinetask-at-task-p))
7070 (org-inlinetask-toggle-visibility)
7071 (org-inlinetask-goto-end)))))))
7073 (defun org-flag-drawer (flag)
7074 "When FLAG is non-nil, hide the drawer we are within.
7075 Otherwise make it visible."
7076 (save-excursion
7077 (beginning-of-line 1)
7078 (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
7079 (let ((b (match-end 0)))
7080 (if (re-search-forward
7081 "^[ \t]*:END:"
7082 (save-excursion (outline-next-heading) (point)) t)
7083 (outline-flag-region b (point-at-eol) flag)
7084 (user-error ":END: line missing at position %s" b))))))
7086 (defun org-subtree-end-visible-p ()
7087 "Is the end of the current subtree visible?"
7088 (pos-visible-in-window-p
7089 (save-excursion (org-end-of-subtree t) (point))))
7091 (defun org-first-headline-recenter (&optional N)
7092 "Move cursor to the first headline and recenter the headline.
7093 Optional argument N means put the headline into the Nth line of the window."
7094 (goto-char (point-min))
7095 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7096 (beginning-of-line)
7097 (recenter (prefix-numeric-value N))))
7099 ;;; Saving and restoring visibility
7101 (defun org-outline-overlay-data (&optional use-markers)
7102 "Return a list of the locations of all outline overlays.
7103 These are overlays with the `invisible' property value `outline'.
7104 The return value is a list of cons cells, with start and stop
7105 positions for each overlay.
7106 If USE-MARKERS is set, return the positions as markers."
7107 (let (beg end)
7108 (save-excursion
7109 (save-restriction
7110 (widen)
7111 (delq nil
7112 (mapcar (lambda (o)
7113 (when (eq (overlay-get o 'invisible) 'outline)
7114 (setq beg (overlay-start o)
7115 end (overlay-end o))
7116 (and beg end (> end beg)
7117 (if use-markers
7118 (cons (move-marker (make-marker) beg)
7119 (move-marker (make-marker) end))
7120 (cons beg end)))))
7121 (overlays-in (point-min) (point-max))))))))
7123 (defun org-set-outline-overlay-data (data)
7124 "Create visibility overlays for all positions in DATA.
7125 DATA should have been made by `org-outline-overlay-data'."
7126 (let (o)
7127 (save-excursion
7128 (save-restriction
7129 (widen)
7130 (show-all)
7131 (mapc (lambda (c)
7132 (outline-flag-region (car c) (cdr c) t))
7133 data)))))
7135 ;;; Folding of blocks
7137 (defvar org-hide-block-overlays nil
7138 "Overlays hiding blocks.")
7139 (make-variable-buffer-local 'org-hide-block-overlays)
7141 (defun org-block-map (function &optional start end)
7142 "Call FUNCTION at the head of all source blocks in the current buffer.
7143 Optional arguments START and END can be used to limit the range."
7144 (let ((start (or start (point-min)))
7145 (end (or end (point-max))))
7146 (save-excursion
7147 (goto-char start)
7148 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7149 (save-excursion
7150 (save-match-data
7151 (goto-char (match-beginning 0))
7152 (funcall function)))))))
7154 (defun org-hide-block-toggle-all ()
7155 "Toggle the visibility of all blocks in the current buffer."
7156 (org-block-map #'org-hide-block-toggle))
7158 (defun org-hide-block-all ()
7159 "Fold all blocks in the current buffer."
7160 (interactive)
7161 (org-show-block-all)
7162 (org-block-map #'org-hide-block-toggle-maybe))
7164 (defun org-show-block-all ()
7165 "Unfold all blocks in the current buffer."
7166 (interactive)
7167 (mapc 'delete-overlay org-hide-block-overlays)
7168 (setq org-hide-block-overlays nil))
7170 (defun org-hide-block-toggle-maybe ()
7171 "Toggle visibility of block at point."
7172 (interactive)
7173 (let ((case-fold-search t))
7174 (if (save-excursion
7175 (beginning-of-line 1)
7176 (looking-at org-block-regexp))
7177 (progn (org-hide-block-toggle)
7178 t) ;; to signal that we took action
7179 nil))) ;; to signal that we did not
7181 (defun org-hide-block-toggle (&optional force)
7182 "Toggle the visibility of the current block."
7183 (interactive)
7184 (save-excursion
7185 (beginning-of-line)
7186 (if (re-search-forward org-block-regexp nil t)
7187 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
7188 (end (match-end 0)) ;; end of entire body
7190 (if (memq t (mapcar (lambda (overlay)
7191 (eq (overlay-get overlay 'invisible)
7192 'org-hide-block))
7193 (overlays-at start)))
7194 (if (or (not force) (eq force 'off))
7195 (mapc (lambda (ov)
7196 (when (member ov org-hide-block-overlays)
7197 (setq org-hide-block-overlays
7198 (delq ov org-hide-block-overlays)))
7199 (when (eq (overlay-get ov 'invisible)
7200 'org-hide-block)
7201 (delete-overlay ov)))
7202 (overlays-at start)))
7203 (setq ov (make-overlay start end))
7204 (overlay-put ov 'invisible 'org-hide-block)
7205 ;; make the block accessible to isearch
7206 (overlay-put
7207 ov 'isearch-open-invisible
7208 (lambda (ov)
7209 (when (member ov org-hide-block-overlays)
7210 (setq org-hide-block-overlays
7211 (delq ov org-hide-block-overlays)))
7212 (when (eq (overlay-get ov 'invisible)
7213 'org-hide-block)
7214 (delete-overlay ov))))
7215 (push ov org-hide-block-overlays)))
7216 (user-error "Not looking at a source block"))))
7218 ;; org-tab-after-check-for-cycling-hook
7219 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7220 ;; Remove overlays when changing major mode
7221 (add-hook 'org-mode-hook
7222 (lambda () (org-add-hook 'change-major-mode-hook
7223 'org-show-block-all 'append 'local)))
7225 ;;; Org-goto
7227 (defvar org-goto-window-configuration nil)
7228 (defvar org-goto-marker nil)
7229 (defvar org-goto-map)
7230 (defun org-goto-map ()
7231 "Set the keymap `org-goto'."
7232 (setq org-goto-map
7233 (let ((map (make-sparse-keymap)))
7234 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7235 mouse-drag-region universal-argument org-occur))
7236 cmd)
7237 (while (setq cmd (pop cmds))
7238 (substitute-key-definition cmd cmd map global-map)))
7239 (suppress-keymap map)
7240 (org-defkey map "\C-m" 'org-goto-ret)
7241 (org-defkey map [(return)] 'org-goto-ret)
7242 (org-defkey map [(left)] 'org-goto-left)
7243 (org-defkey map [(right)] 'org-goto-right)
7244 (org-defkey map [(control ?g)] 'org-goto-quit)
7245 (org-defkey map "\C-i" 'org-cycle)
7246 (org-defkey map [(tab)] 'org-cycle)
7247 (org-defkey map [(down)] 'outline-next-visible-heading)
7248 (org-defkey map [(up)] 'outline-previous-visible-heading)
7249 (if org-goto-auto-isearch
7250 (if (fboundp 'define-key-after)
7251 (define-key-after map [t] 'org-goto-local-auto-isearch)
7252 nil)
7253 (org-defkey map "q" 'org-goto-quit)
7254 (org-defkey map "n" 'outline-next-visible-heading)
7255 (org-defkey map "p" 'outline-previous-visible-heading)
7256 (org-defkey map "f" 'outline-forward-same-level)
7257 (org-defkey map "b" 'outline-backward-same-level)
7258 (org-defkey map "u" 'outline-up-heading))
7259 (org-defkey map "/" 'org-occur)
7260 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7261 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7262 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7263 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7264 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7265 map)))
7267 (defconst org-goto-help
7268 "Browse buffer copy, to find location or copy text.%s
7269 RET=jump to location C-g=quit and return to previous location
7270 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7272 (defvar org-goto-start-pos) ; dynamically scoped parameter
7274 (defun org-goto (&optional alternative-interface)
7275 "Look up a different location in the current file, keeping current visibility.
7277 When you want look-up or go to a different location in a
7278 document, the fastest way is often to fold the entire buffer and
7279 then dive into the tree. This method has the disadvantage, that
7280 the previous location will be folded, which may not be what you
7281 want.
7283 This command works around this by showing a copy of the current
7284 buffer in an indirect buffer, in overview mode. You can dive
7285 into the tree in that copy, use org-occur and incremental search
7286 to find a location. When pressing RET or `Q', the command
7287 returns to the original buffer in which the visibility is still
7288 unchanged. After RET it will also jump to the location selected
7289 in the indirect buffer and expose the headline hierarchy above.
7291 With a prefix argument, use the alternative interface: e.g. if
7292 `org-goto-interface' is 'outline use 'outline-path-completion."
7293 (interactive "P")
7294 (org-goto-map)
7295 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7296 (org-refile-use-outline-path t)
7297 (org-refile-target-verify-function nil)
7298 (interface
7299 (if (not alternative-interface)
7300 org-goto-interface
7301 (if (eq org-goto-interface 'outline)
7302 'outline-path-completion
7303 'outline)))
7304 (org-goto-start-pos (point))
7305 (selected-point
7306 (if (eq interface 'outline)
7307 (car (org-get-location (current-buffer) org-goto-help))
7308 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7309 (org-refile-check-position pa)
7310 (nth 3 pa)))))
7311 (if selected-point
7312 (progn
7313 (org-mark-ring-push org-goto-start-pos)
7314 (goto-char selected-point)
7315 (if (or (outline-invisible-p) (org-invisible-p2))
7316 (org-show-context 'org-goto)))
7317 (message "Quit"))))
7319 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7320 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7321 (defvar org-goto-local-auto-isearch-map) ; defined below
7323 (defun org-get-location (buf help)
7324 "Let the user select a location in the Org-mode buffer BUF.
7325 This function uses a recursive edit. It returns the selected position
7326 or nil."
7327 (org-no-popups
7328 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7329 (isearch-hide-immediately nil)
7330 (isearch-search-fun-function
7331 (lambda () 'org-goto-local-search-headings))
7332 (org-goto-selected-point org-goto-exit-command))
7333 (save-excursion
7334 (save-window-excursion
7335 (delete-other-windows)
7336 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7337 (org-pop-to-buffer-same-window
7338 (condition-case nil
7339 (make-indirect-buffer (current-buffer) "*org-goto*")
7340 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7341 (with-output-to-temp-buffer "*Org Help*"
7342 (princ (format help (if org-goto-auto-isearch
7343 " Just type for auto-isearch."
7344 " n/p/f/b/u to navigate, q to quit."))))
7345 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7346 (setq buffer-read-only nil)
7347 (let ((org-startup-truncated t)
7348 (org-startup-folded nil)
7349 (org-startup-align-all-tables nil))
7350 (org-mode)
7351 (org-overview))
7352 (setq buffer-read-only t)
7353 (if (and (boundp 'org-goto-start-pos)
7354 (integer-or-marker-p org-goto-start-pos))
7355 (let ((org-show-hierarchy-above t)
7356 (org-show-siblings t)
7357 (org-show-following-heading t))
7358 (goto-char org-goto-start-pos)
7359 (and (outline-invisible-p) (org-show-context)))
7360 (goto-char (point-min)))
7361 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7362 (message "Select location and press RET")
7363 (use-local-map org-goto-map)
7364 (recursive-edit)))
7365 (kill-buffer "*org-goto*")
7366 (cons org-goto-selected-point org-goto-exit-command))))
7368 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7369 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7370 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7371 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7373 (defun org-goto-local-search-headings (string bound noerror)
7374 "Search and make sure that any matches are in headlines."
7375 (catch 'return
7376 (while (if isearch-forward
7377 (search-forward string bound noerror)
7378 (search-backward string bound noerror))
7379 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7380 (and (member :headline context)
7381 (not (member :tags context))))
7382 (throw 'return (point))))))
7384 (defun org-goto-local-auto-isearch ()
7385 "Start isearch."
7386 (interactive)
7387 (goto-char (point-min))
7388 (let ((keys (this-command-keys)))
7389 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7390 (isearch-mode t)
7391 (isearch-process-search-char (string-to-char keys)))))
7393 (defun org-goto-ret (&optional arg)
7394 "Finish `org-goto' by going to the new location."
7395 (interactive "P")
7396 (setq org-goto-selected-point (point)
7397 org-goto-exit-command 'return)
7398 (throw 'exit nil))
7400 (defun org-goto-left ()
7401 "Finish `org-goto' by going to the new location."
7402 (interactive)
7403 (if (org-at-heading-p)
7404 (progn
7405 (beginning-of-line 1)
7406 (setq org-goto-selected-point (point)
7407 org-goto-exit-command 'left)
7408 (throw 'exit nil))
7409 (user-error "Not on a heading")))
7411 (defun org-goto-right ()
7412 "Finish `org-goto' by going to the new location."
7413 (interactive)
7414 (if (org-at-heading-p)
7415 (progn
7416 (setq org-goto-selected-point (point)
7417 org-goto-exit-command 'right)
7418 (throw 'exit nil))
7419 (user-error "Not on a heading")))
7421 (defun org-goto-quit ()
7422 "Finish `org-goto' without cursor motion."
7423 (interactive)
7424 (setq org-goto-selected-point nil)
7425 (setq org-goto-exit-command 'quit)
7426 (throw 'exit nil))
7428 ;;; Indirect buffer display of subtrees
7430 (defvar org-indirect-dedicated-frame nil
7431 "This is the frame being used for indirect tree display.")
7432 (defvar org-last-indirect-buffer nil)
7434 (defun org-tree-to-indirect-buffer (&optional arg)
7435 "Create indirect buffer and narrow it to current subtree.
7436 With a numerical prefix ARG, go up to this level and then take that tree.
7437 If ARG is negative, go up that many levels.
7439 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7440 indirect buffer previously made with this command, to avoid proliferation of
7441 indirect buffers. However, when you call the command with a \
7442 \\[universal-argument] prefix, or
7443 when `org-indirect-buffer-display' is `new-frame', the last buffer
7444 is kept so that you can work with several indirect buffers at the same time.
7445 If `org-indirect-buffer-display' is `dedicated-frame', the \
7446 \\[universal-argument] prefix also
7447 requests that a new frame be made for the new buffer, so that the dedicated
7448 frame is not changed."
7449 (interactive "P")
7450 (let ((cbuf (current-buffer))
7451 (cwin (selected-window))
7452 (pos (point))
7453 beg end level heading ibuf)
7454 (save-excursion
7455 (org-back-to-heading t)
7456 (when (numberp arg)
7457 (setq level (org-outline-level))
7458 (if (< arg 0) (setq arg (+ level arg)))
7459 (while (> (setq level (org-outline-level)) arg)
7460 (org-up-heading-safe)))
7461 (setq beg (point)
7462 heading (org-get-heading))
7463 (org-end-of-subtree t t)
7464 (if (org-at-heading-p) (backward-char 1))
7465 (setq end (point)))
7466 (if (and (buffer-live-p org-last-indirect-buffer)
7467 (not (eq org-indirect-buffer-display 'new-frame))
7468 (not arg))
7469 (kill-buffer org-last-indirect-buffer))
7470 (setq ibuf (org-get-indirect-buffer cbuf)
7471 org-last-indirect-buffer ibuf)
7472 (cond
7473 ((or (eq org-indirect-buffer-display 'new-frame)
7474 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7475 (select-frame (make-frame))
7476 (delete-other-windows)
7477 (org-pop-to-buffer-same-window ibuf)
7478 (org-set-frame-title heading))
7479 ((eq org-indirect-buffer-display 'dedicated-frame)
7480 (raise-frame
7481 (select-frame (or (and org-indirect-dedicated-frame
7482 (frame-live-p org-indirect-dedicated-frame)
7483 org-indirect-dedicated-frame)
7484 (setq org-indirect-dedicated-frame (make-frame)))))
7485 (delete-other-windows)
7486 (org-pop-to-buffer-same-window ibuf)
7487 (org-set-frame-title (concat "Indirect: " heading)))
7488 ((eq org-indirect-buffer-display 'current-window)
7489 (org-pop-to-buffer-same-window ibuf))
7490 ((eq org-indirect-buffer-display 'other-window)
7491 (pop-to-buffer ibuf))
7492 (t (error "Invalid value")))
7493 (if (featurep 'xemacs)
7494 (save-excursion (org-mode) (turn-on-font-lock)))
7495 (narrow-to-region beg end)
7496 (show-all)
7497 (goto-char pos)
7498 (run-hook-with-args 'org-cycle-hook 'all)
7499 (and (window-live-p cwin) (select-window cwin))))
7501 (defun org-get-indirect-buffer (&optional buffer)
7502 (setq buffer (or buffer (current-buffer)))
7503 (let ((n 1) (base (buffer-name buffer)) bname)
7504 (while (buffer-live-p
7505 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7506 (setq n (1+ n)))
7507 (condition-case nil
7508 (make-indirect-buffer buffer bname 'clone)
7509 (error (make-indirect-buffer buffer bname)))))
7511 (defun org-set-frame-title (title)
7512 "Set the title of the current frame to the string TITLE."
7513 ;; FIXME: how to name a single frame in XEmacs???
7514 (unless (featurep 'xemacs)
7515 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7517 ;;;; Structure editing
7519 ;;; Inserting headlines
7521 (defun org-previous-line-empty-p (&optional next)
7522 "Is the previous line a blank line?
7523 When NEXT is non-nil, check the next line instead."
7524 (save-excursion
7525 (and (not (bobp))
7526 (or (beginning-of-line (if next 2 0)) t)
7527 (save-match-data
7528 (looking-at "[ \t]*$")))))
7530 (defun org-insert-heading (&optional arg invisible-ok)
7531 "Insert a new heading or item with same depth at point.
7532 If point is in a plain list and ARG is nil, create a new list item.
7533 With one universal prefix argument, insert a heading even in lists.
7534 With two universal prefix arguments, insert the heading at the end
7535 of the parent subtree.
7537 If point is at the beginning of a headline, insert a sibling before
7538 the current headline. If point is not at the beginning, split the line
7539 and create a new headline with the text in the current line after point
7540 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7542 If point is at the beginning of a normal line, turn this line into
7543 a heading.
7545 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7546 This is important for non-interactive uses of the command."
7547 (interactive "P")
7548 (if (org-called-interactively-p 'any) (org-reveal))
7549 (let ((itemp (org-in-item-p))
7550 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7551 (respect-content (or org-insert-heading-respect-content
7552 (equal arg '(16))))
7553 (initial-content "")
7554 (adjust-empty-lines t))
7556 (cond
7558 ((or (= (buffer-size) 0)
7559 (and (not (save-excursion
7560 (and (ignore-errors (org-back-to-heading invisible-ok))
7561 (org-at-heading-p))))
7562 (or arg (not itemp))))
7563 ;; At beginning of buffer or so high up that only a heading
7564 ;; makes sense.
7565 (insert
7566 (if (or (bobp) (org-previous-line-empty-p)) "" "\n")
7567 (if (org-in-src-block-p) ",* " "* "))
7568 (run-hooks 'org-insert-heading-hook))
7570 ((and itemp (not (equal arg '(4))))
7571 ;; Insert an item
7572 (org-insert-item))
7575 ;; Insert a heading
7576 (save-restriction
7577 (widen)
7578 (let* ((level nil)
7579 (on-heading (org-at-heading-p))
7580 (empty-line-p (if on-heading
7581 (org-previous-line-empty-p)
7582 ;; We will decide later
7583 nil))
7584 ;; Get a level string to fall back on
7585 (fix-level
7586 (save-excursion
7587 (org-back-to-heading t)
7588 (if (org-previous-line-empty-p) (setq empty-line-p t))
7589 (looking-at org-outline-regexp)
7590 (make-string (1- (length (match-string 0))) ?*)))
7591 (stars
7592 (save-excursion
7593 (condition-case nil
7594 (progn
7595 (org-back-to-heading invisible-ok)
7596 (when (and (not on-heading)
7597 (featurep 'org-inlinetask)
7598 (integerp org-inlinetask-min-level)
7599 (>= (length (match-string 0))
7600 org-inlinetask-min-level))
7601 ;; Find a heading level before the inline task
7602 (while (and (setq level (org-up-heading-safe))
7603 (>= level org-inlinetask-min-level)))
7604 (if (org-at-heading-p)
7605 (org-back-to-heading invisible-ok)
7606 (error "This should not happen")))
7607 (unless (and (save-excursion
7608 (save-match-data
7609 (org-backward-heading-same-level
7610 1 invisible-ok))
7611 (= (point) (match-beginning 0)))
7612 (not (org-previous-line-empty-p t)))
7613 (setq empty-line-p (or empty-line-p
7614 (org-previous-line-empty-p))))
7615 (match-string 0))
7616 (error (or fix-level "* ")))))
7617 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7618 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7619 pos hide-previous previous-pos)
7621 ;; If we insert after content, move there and clean up whitespace
7622 (when respect-content
7623 (org-end-of-subtree nil t)
7624 (skip-chars-backward " \r\n")
7625 (and (looking-at "[ \t]+") (replace-match ""))
7626 (unless (eobp) (forward-char 1))
7627 (when (looking-at "^\\*")
7628 (unless (bobp) (backward-char 1))
7629 (insert "\n")))
7631 ;; If we are splitting, grab the text that should be moved to the new headline
7632 (when may-split
7633 (if (org-on-heading-p)
7634 ;; This is a heading, we split intelligently (keeping tags)
7635 (let ((pos (point)))
7636 (goto-char (point-at-bol))
7637 (unless (looking-at org-complex-heading-regexp)
7638 (error "This should not happen"))
7639 (when (and (match-beginning 4)
7640 (> pos (match-beginning 4))
7641 (< pos (match-end 4)))
7642 (setq initial-content (buffer-substring pos (match-end 4)))
7643 (goto-char pos)
7644 (delete-region (point) (match-end 4))
7645 (if (looking-at "[ \t]*$")
7646 (replace-match "")
7647 (insert (make-string (length initial-content) ?\ )))
7648 (setq initial-content (org-trim initial-content)))
7649 (goto-char pos))
7650 ;; a normal line
7651 (unless (bolp)
7652 (setq initial-content (buffer-substring (point) (point-at-eol)))
7653 (delete-region (point) (point-at-eol))
7654 (setq initial-content (org-trim initial-content)))))
7656 ;; If we are at the beginning of the line, insert before it. Else after
7657 (cond
7658 ((and (bolp) (looking-at "[ \t]*$")))
7659 ((and (bolp) (not (looking-at "[ \t]*$")))
7660 (open-line 1))
7662 (goto-char (point-at-eol))
7663 (insert "\n")))
7665 ;; Insert the new heading
7666 (insert stars)
7667 (just-one-space)
7668 (insert initial-content)
7669 (when adjust-empty-lines
7670 (if (or (not blank)
7671 (and blank (not (org-previous-line-empty-p))))
7672 (org-N-empty-lines-before-current (if blank 1 0))))
7673 (run-hooks 'org-insert-heading-hook)))))))
7675 (defun org-N-empty-lines-before-current (N)
7676 "Make the number of empty lines before current exactly N.
7677 So this will delete or add empty lines."
7678 (save-excursion
7679 (goto-char (point-at-bol))
7680 (if (looking-back "\\s-+" nil 'greedy)
7681 (replace-match ""))
7682 (or (bobp) (insert "\n"))
7683 (while (> N 0)
7684 (insert "\n")
7685 (setq N (1- N)))))
7687 (defun org-get-heading (&optional no-tags no-todo)
7688 "Return the heading of the current entry, without the stars.
7689 When NO-TAGS is non-nil, don't include tags.
7690 When NO-TODO is non-nil, don't include TODO keywords."
7691 (save-excursion
7692 (org-back-to-heading t)
7693 (cond
7694 ((and no-tags no-todo)
7695 (looking-at org-complex-heading-regexp)
7696 (match-string 4))
7697 (no-tags
7698 (looking-at (concat org-outline-regexp
7699 "\\(.*?\\)"
7700 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7701 (match-string 1))
7702 (no-todo
7703 (looking-at org-todo-line-regexp)
7704 (match-string 3))
7705 (t (looking-at org-heading-regexp)
7706 (match-string 2)))))
7708 (defvar orgstruct-mode) ; defined below
7710 (defun org-heading-components ()
7711 "Return the components of the current heading.
7712 This is a list with the following elements:
7713 - the level as an integer
7714 - the reduced level, different if `org-odd-levels-only' is set.
7715 - the TODO keyword, or nil
7716 - the priority character, like ?A, or nil if no priority is given
7717 - the headline text itself, or the tags string if no headline text
7718 - the tags string, or nil."
7719 (save-excursion
7720 (org-back-to-heading t)
7721 (if (let (case-fold-search)
7722 (looking-at
7723 (if orgstruct-mode
7724 org-heading-regexp
7725 org-complex-heading-regexp)))
7726 (if orgstruct-mode
7727 (list (length (match-string 1))
7728 (org-reduced-level (length (match-string 1)))
7731 (match-string 2)
7732 nil)
7733 (list (length (match-string 1))
7734 (org-reduced-level (length (match-string 1)))
7735 (org-match-string-no-properties 2)
7736 (and (match-end 3) (aref (match-string 3) 2))
7737 (org-match-string-no-properties 4)
7738 (org-match-string-no-properties 5))))))
7740 (defun org-get-entry ()
7741 "Get the entry text, after heading, entire subtree."
7742 (save-excursion
7743 (org-back-to-heading t)
7744 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7746 (defun org-insert-heading-after-current ()
7747 "Insert a new heading with same level as current, after current subtree."
7748 (interactive)
7749 (org-back-to-heading)
7750 (org-insert-heading)
7751 (org-move-subtree-down)
7752 (end-of-line 1))
7754 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7755 "Insert heading with `org-insert-heading-respect-content' set to t."
7756 (interactive "P")
7757 (let ((org-insert-heading-respect-content t))
7758 (org-insert-heading '(4) invisible-ok)))
7760 (defun org-insert-todo-heading-respect-content (&optional force-state)
7761 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7762 (interactive "P")
7763 (let ((org-insert-heading-respect-content t))
7764 (org-insert-todo-heading force-state '(4))))
7766 (defun org-insert-todo-heading (arg &optional force-heading)
7767 "Insert a new heading with the same level and TODO state as current heading.
7768 If the heading has no TODO state, or if the state is DONE, use the first
7769 state (TODO by default). Also one prefix arg, force first state. With two
7770 prefix args, force inserting at the end of the parent subtree."
7771 (interactive "P")
7772 (when (or force-heading (not (org-insert-item 'checkbox)))
7773 (org-insert-heading (or (and (equal arg '(16)) '(16))
7774 force-heading))
7775 (save-excursion
7776 (org-back-to-heading)
7777 (outline-previous-heading)
7778 (looking-at org-todo-line-regexp))
7779 (let*
7780 ((new-mark-x
7781 (if (or arg
7782 (not (match-beginning 2))
7783 (member (match-string 2) org-done-keywords))
7784 (car org-todo-keywords-1)
7785 (match-string 2)))
7786 (new-mark
7788 (run-hook-with-args-until-success
7789 'org-todo-get-default-hook new-mark-x nil)
7790 new-mark-x)))
7791 (beginning-of-line 1)
7792 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7793 (if org-treat-insert-todo-heading-as-state-change
7794 (org-todo new-mark)
7795 (insert new-mark " "))))
7796 (when org-provide-todo-statistics
7797 (org-update-parent-todo-statistics))))
7799 (defun org-insert-subheading (arg)
7800 "Insert a new subheading and demote it.
7801 Works for outline headings and for plain lists alike."
7802 (interactive "P")
7803 (org-insert-heading arg)
7804 (cond
7805 ((org-at-heading-p) (org-do-demote))
7806 ((org-at-item-p) (org-indent-item))))
7808 (defun org-insert-todo-subheading (arg)
7809 "Insert a new subheading with TODO keyword or checkbox and demote it.
7810 Works for outline headings and for plain lists alike."
7811 (interactive "P")
7812 (org-insert-todo-heading arg)
7813 (cond
7814 ((org-at-heading-p) (org-do-demote))
7815 ((org-at-item-p) (org-indent-item))))
7817 ;;; Promotion and Demotion
7819 (defvar org-after-demote-entry-hook nil
7820 "Hook run after an entry has been demoted.
7821 The cursor will be at the beginning of the entry.
7822 When a subtree is being demoted, the hook will be called for each node.")
7824 (defvar org-after-promote-entry-hook nil
7825 "Hook run after an entry has been promoted.
7826 The cursor will be at the beginning of the entry.
7827 When a subtree is being promoted, the hook will be called for each node.")
7829 (defun org-promote-subtree ()
7830 "Promote the entire subtree.
7831 See also `org-promote'."
7832 (interactive)
7833 (save-excursion
7834 (org-with-limited-levels (org-map-tree 'org-promote)))
7835 (org-fix-position-after-promote))
7837 (defun org-demote-subtree ()
7838 "Demote the entire subtree. See `org-demote'.
7839 See also `org-promote'."
7840 (interactive)
7841 (save-excursion
7842 (org-with-limited-levels (org-map-tree 'org-demote)))
7843 (org-fix-position-after-promote))
7846 (defun org-do-promote ()
7847 "Promote the current heading higher up the tree.
7848 If the region is active in `transient-mark-mode', promote all headings
7849 in the region."
7850 (interactive)
7851 (save-excursion
7852 (if (org-region-active-p)
7853 (org-map-region 'org-promote (region-beginning) (region-end))
7854 (org-promote)))
7855 (org-fix-position-after-promote))
7857 (defun org-do-demote ()
7858 "Demote the current heading lower down the tree.
7859 If the region is active in `transient-mark-mode', demote all headings
7860 in the region."
7861 (interactive)
7862 (save-excursion
7863 (if (org-region-active-p)
7864 (org-map-region 'org-demote (region-beginning) (region-end))
7865 (org-demote)))
7866 (org-fix-position-after-promote))
7868 (defun org-fix-position-after-promote ()
7869 "Make sure that after pro/demotion cursor position is right."
7870 (let ((pos (point)))
7871 (when (save-excursion
7872 (beginning-of-line 1)
7873 (looking-at org-todo-line-regexp)
7874 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7875 (cond ((eobp) (insert " "))
7876 ((eolp) (insert " "))
7877 ((equal (char-after) ?\ ) (forward-char 1))))))
7879 (defun org-current-level ()
7880 "Return the level of the current entry, or nil if before the first headline.
7881 The level is the number of stars at the beginning of the headline."
7882 (save-excursion
7883 (org-with-limited-levels
7884 (if (ignore-errors (org-back-to-heading t))
7885 (funcall outline-level)))))
7887 (defun org-get-previous-line-level ()
7888 "Return the outline depth of the last headline before the current line.
7889 Returns 0 for the first headline in the buffer, and nil if before the
7890 first headline."
7891 (and (org-current-level)
7892 (or (and (/= (line-beginning-position) (point-min))
7893 (save-excursion (beginning-of-line 0) (org-current-level)))
7894 0)))
7896 (defun org-reduced-level (l)
7897 "Compute the effective level of a heading.
7898 This takes into account the setting of `org-odd-levels-only'."
7899 (cond
7900 ((zerop l) 0)
7901 (org-odd-levels-only (1+ (floor (/ l 2))))
7902 (t l)))
7904 (defun org-level-increment ()
7905 "Return the number of stars that will be added or removed at a
7906 time to headlines when structure editing, based on the value of
7907 `org-odd-levels-only'."
7908 (if org-odd-levels-only 2 1))
7910 (defun org-get-valid-level (level &optional change)
7911 "Rectify a level change under the influence of `org-odd-levels-only'
7912 LEVEL is a current level, CHANGE is by how much the level should be
7913 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7914 even level numbers will become the next higher odd number."
7915 (if org-odd-levels-only
7916 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7917 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7918 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7919 (max 1 (+ level (or change 0)))))
7921 (if (boundp 'define-obsolete-function-alias)
7922 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7923 (define-obsolete-function-alias 'org-get-legal-level
7924 'org-get-valid-level)
7925 (define-obsolete-function-alias 'org-get-legal-level
7926 'org-get-valid-level "23.1")))
7928 (defun org-promote ()
7929 "Promote the current heading higher up the tree.
7930 If the region is active in `transient-mark-mode', promote all headings
7931 in the region."
7932 (org-back-to-heading t)
7933 (let* ((level (save-match-data (funcall outline-level)))
7934 (after-change-functions (remove 'flyspell-after-change-function
7935 after-change-functions))
7936 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7937 (diff (abs (- level (length up-head) -1))))
7938 (cond ((and (= level 1) org-called-with-limited-levels
7939 org-allow-promoting-top-level-subtree)
7940 (replace-match "# " nil t))
7941 ((= level 1)
7942 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7943 (t (replace-match up-head nil t)))
7944 ;; Fixup tag positioning
7945 (unless (= level 1)
7946 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
7947 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7948 (run-hooks 'org-after-promote-entry-hook)))
7950 (defun org-demote ()
7951 "Demote the current heading lower down the tree.
7952 If the region is active in `transient-mark-mode', demote all headings
7953 in the region."
7954 (org-back-to-heading t)
7955 (let* ((level (save-match-data (funcall outline-level)))
7956 (after-change-functions (remove 'flyspell-after-change-function
7957 after-change-functions))
7958 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7959 (diff (abs (- level (length down-head) -1))))
7960 (replace-match down-head nil t)
7961 ;; Fixup tag positioning
7962 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
7963 (if org-adapt-indentation (org-fixup-indentation diff))
7964 (run-hooks 'org-after-demote-entry-hook)))
7966 (defun org-cycle-level ()
7967 "Cycle the level of an empty headline through possible states.
7968 This goes first to child, then to parent, level, then up the hierarchy.
7969 After top level, it switches back to sibling level."
7970 (interactive)
7971 (let ((org-adapt-indentation nil))
7972 (when (org-point-at-end-of-empty-headline)
7973 (setq this-command 'org-cycle-level) ; Only needed for caching
7974 (let ((cur-level (org-current-level))
7975 (prev-level (org-get-previous-line-level)))
7976 (cond
7977 ;; If first headline in file, promote to top-level.
7978 ((= prev-level 0)
7979 (loop repeat (/ (- cur-level 1) (org-level-increment))
7980 do (org-do-promote)))
7981 ;; If same level as prev, demote one.
7982 ((= prev-level cur-level)
7983 (org-do-demote))
7984 ;; If parent is top-level, promote to top level if not already.
7985 ((= prev-level 1)
7986 (loop repeat (/ (- cur-level 1) (org-level-increment))
7987 do (org-do-promote)))
7988 ;; If top-level, return to prev-level.
7989 ((= cur-level 1)
7990 (loop repeat (/ (- prev-level 1) (org-level-increment))
7991 do (org-do-demote)))
7992 ;; If less than prev-level, promote one.
7993 ((< cur-level prev-level)
7994 (org-do-promote))
7995 ;; If deeper than prev-level, promote until higher than
7996 ;; prev-level.
7997 ((> cur-level prev-level)
7998 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7999 do (org-do-promote))))
8000 t))))
8002 (defun org-map-tree (fun)
8003 "Call FUN for every heading underneath the current one."
8004 (org-back-to-heading)
8005 (let ((level (funcall outline-level)))
8006 (save-excursion
8007 (funcall fun)
8008 (while (and (progn
8009 (outline-next-heading)
8010 (> (funcall outline-level) level))
8011 (not (eobp)))
8012 (funcall fun)))))
8014 (defun org-map-region (fun beg end)
8015 "Call FUN for every heading between BEG and END."
8016 (let ((org-ignore-region t))
8017 (save-excursion
8018 (setq end (copy-marker end))
8019 (goto-char beg)
8020 (if (and (re-search-forward org-outline-regexp-bol nil t)
8021 (< (point) end))
8022 (funcall fun))
8023 (while (and (progn
8024 (outline-next-heading)
8025 (< (point) end))
8026 (not (eobp)))
8027 (funcall fun)))))
8029 (defvar org-property-end-re) ; silence byte-compiler
8030 (defun org-fixup-indentation (diff)
8031 "Change the indentation in the current entry by DIFF.
8032 However, if any line in the current entry has no indentation, or if it
8033 would end up with no indentation after the change, nothing at all is done."
8034 (save-excursion
8035 (let ((end (save-excursion (outline-next-heading)
8036 (point-marker)))
8037 (prohibit (if (> diff 0)
8038 "^\\S-"
8039 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8040 col)
8041 (unless (save-excursion (end-of-line 1)
8042 (re-search-forward prohibit end t))
8043 (while (and (< (point) end)
8044 (re-search-forward "^[ \t]+" end t))
8045 (goto-char (match-end 0))
8046 (setq col (current-column))
8047 (if (< diff 0) (replace-match ""))
8048 (org-indent-to-column (+ diff col))))
8049 (move-marker end nil))))
8051 (defun org-convert-to-odd-levels ()
8052 "Convert an org-mode file with all levels allowed to one with odd levels.
8053 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8054 level 5 etc."
8055 (interactive)
8056 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8057 (let ((outline-level 'org-outline-level)
8058 (org-odd-levels-only nil) n)
8059 (save-excursion
8060 (goto-char (point-min))
8061 (while (re-search-forward "^\\*\\*+ " nil t)
8062 (setq n (- (length (match-string 0)) 2))
8063 (while (>= (setq n (1- n)) 0)
8064 (org-demote))
8065 (end-of-line 1))))))
8067 (defun org-convert-to-oddeven-levels ()
8068 "Convert an org-mode file with only odd levels to one with odd/even levels.
8069 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8070 file contains a section with an even level, conversion would
8071 destroy the structure of the file. An error is signaled in this
8072 case."
8073 (interactive)
8074 (goto-char (point-min))
8075 ;; First check if there are no even levels
8076 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8077 (org-show-context t)
8078 (error "Not all levels are odd in this file. Conversion not possible"))
8079 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8080 (let ((outline-regexp org-outline-regexp)
8081 (outline-level 'org-outline-level)
8082 (org-odd-levels-only nil) n)
8083 (save-excursion
8084 (goto-char (point-min))
8085 (while (re-search-forward "^\\*\\*+ " nil t)
8086 (setq n (/ (1- (length (match-string 0))) 2))
8087 (while (>= (setq n (1- n)) 0)
8088 (org-promote))
8089 (end-of-line 1))))))
8091 (defun org-tr-level (n)
8092 "Make N odd if required."
8093 (if org-odd-levels-only (1+ (/ n 2)) n))
8095 ;;; Vertical tree motion, cutting and pasting of subtrees
8097 (defun org-move-subtree-up (&optional arg)
8098 "Move the current subtree up past ARG headlines of the same level."
8099 (interactive "p")
8100 (org-move-subtree-down (- (prefix-numeric-value arg))))
8102 (defun org-move-subtree-down (&optional arg)
8103 "Move the current subtree down past ARG headlines of the same level."
8104 (interactive "p")
8105 (setq arg (prefix-numeric-value arg))
8106 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8107 'org-get-last-sibling))
8108 (ins-point (make-marker))
8109 (cnt (abs arg))
8110 (col (current-column))
8111 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8112 ;; Select the tree
8113 (org-back-to-heading)
8114 (setq beg0 (point))
8115 (save-excursion
8116 (setq ne-beg (org-back-over-empty-lines))
8117 (setq beg (point)))
8118 (save-match-data
8119 (save-excursion (outline-end-of-heading)
8120 (setq folded (outline-invisible-p)))
8121 (outline-end-of-subtree))
8122 (outline-next-heading)
8123 (setq ne-end (org-back-over-empty-lines))
8124 (setq end (point))
8125 (goto-char beg0)
8126 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8127 ;; include less whitespace
8128 (save-excursion
8129 (goto-char beg)
8130 (forward-line (- ne-beg ne-end))
8131 (setq beg (point))))
8132 ;; Find insertion point, with error handling
8133 (while (> cnt 0)
8134 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8135 (progn (goto-char beg0)
8136 (user-error "Cannot move past superior level or buffer limit")))
8137 (setq cnt (1- cnt)))
8138 (if (> arg 0)
8139 ;; Moving forward - still need to move over subtree
8140 (progn (org-end-of-subtree t t)
8141 (save-excursion
8142 (org-back-over-empty-lines)
8143 (or (bolp) (newline)))))
8144 (setq ne-ins (org-back-over-empty-lines))
8145 (move-marker ins-point (point))
8146 (setq txt (buffer-substring beg end))
8147 (org-save-markers-in-region beg end)
8148 (delete-region beg end)
8149 (org-remove-empty-overlays-at beg)
8150 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8151 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8152 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8153 (let ((bbb (point)))
8154 (insert-before-markers txt)
8155 (org-reinstall-markers-in-region bbb)
8156 (move-marker ins-point bbb))
8157 (or (bolp) (insert "\n"))
8158 (setq ins-end (point))
8159 (goto-char ins-point)
8160 (org-skip-whitespace)
8161 (when (and (< arg 0)
8162 (org-first-sibling-p)
8163 (> ne-ins ne-beg))
8164 ;; Move whitespace back to beginning
8165 (save-excursion
8166 (goto-char ins-end)
8167 (let ((kill-whole-line t))
8168 (kill-line (- ne-ins ne-beg)) (point)))
8169 (insert (make-string (- ne-ins ne-beg) ?\n)))
8170 (move-marker ins-point nil)
8171 (if folded
8172 (hide-subtree)
8173 (org-show-entry)
8174 (show-children)
8175 (org-cycle-hide-drawers 'children))
8176 (org-clean-visibility-after-subtree-move)
8177 ;; move back to the initial column we were at
8178 (move-to-column col)))
8180 (defvar org-subtree-clip ""
8181 "Clipboard for cut and paste of subtrees.
8182 This is actually only a copy of the kill, because we use the normal kill
8183 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8185 (defvar org-subtree-clip-folded nil
8186 "Was the last copied subtree folded?
8187 This is used to fold the tree back after pasting.")
8189 (defun org-cut-subtree (&optional n)
8190 "Cut the current subtree into the clipboard.
8191 With prefix arg N, cut this many sequential subtrees.
8192 This is a short-hand for marking the subtree and then cutting it."
8193 (interactive "p")
8194 (org-copy-subtree n 'cut))
8196 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8197 "Copy the current subtree it in the clipboard.
8198 With prefix arg N, copy this many sequential subtrees.
8199 This is a short-hand for marking the subtree and then copying it.
8200 If CUT is non-nil, actually cut the subtree.
8201 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8202 of some markers in the region, even if CUT is non-nil. This is
8203 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8204 (interactive "p")
8205 (let (beg end folded (beg0 (point)))
8206 (if (org-called-interactively-p 'any)
8207 (org-back-to-heading nil) ; take what looks like a subtree
8208 (org-back-to-heading t)) ; take what is really there
8209 (setq beg (point))
8210 (skip-chars-forward " \t\r\n")
8211 (save-match-data
8212 (if nosubtrees
8213 (outline-next-heading)
8214 (save-excursion (outline-end-of-heading)
8215 (setq folded (outline-invisible-p)))
8216 (condition-case nil
8217 (org-forward-heading-same-level (1- n) t)
8218 (error nil))
8219 (org-end-of-subtree t t)))
8220 (setq end (point))
8221 (goto-char beg0)
8222 (when (> end beg)
8223 (setq org-subtree-clip-folded folded)
8224 (when (or cut force-store-markers)
8225 (org-save-markers-in-region beg end))
8226 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8227 (setq org-subtree-clip (current-kill 0))
8228 (message "%s: Subtree(s) with %d characters"
8229 (if cut "Cut" "Copied")
8230 (length org-subtree-clip)))))
8232 (defun org-paste-subtree (&optional level tree for-yank)
8233 "Paste the clipboard as a subtree, with modification of headline level.
8234 The entire subtree is promoted or demoted in order to match a new headline
8235 level.
8237 If the cursor is at the beginning of a headline, the same level as
8238 that headline is used to paste the tree.
8240 If not, the new level is derived from the *visible* headings
8241 before and after the insertion point, and taken to be the inferior headline
8242 level of the two. So if the previous visible heading is level 3 and the
8243 next is level 4 (or vice versa), level 4 will be used for insertion.
8244 This makes sure that the subtree remains an independent subtree and does
8245 not swallow low level entries.
8247 You can also force a different level, either by using a numeric prefix
8248 argument, or by inserting the heading marker by hand. For example, if the
8249 cursor is after \"*****\", then the tree will be shifted to level 5.
8251 If optional TREE is given, use this text instead of the kill ring.
8253 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8254 move back over whitespace before inserting, and move point to the end of
8255 the inserted text when done."
8256 (interactive "P")
8257 (setq tree (or tree (and kill-ring (current-kill 0))))
8258 (unless (org-kill-is-subtree-p tree)
8259 (user-error "%s"
8260 (substitute-command-keys
8261 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8262 (org-with-limited-levels
8263 (let* ((visp (not (outline-invisible-p)))
8264 (txt tree)
8265 (^re_ "\\(\\*+\\)[ \t]*")
8266 (old-level (if (string-match org-outline-regexp-bol txt)
8267 (- (match-end 0) (match-beginning 0) 1)
8268 -1))
8269 (force-level (cond (level (prefix-numeric-value level))
8270 ((and (looking-at "[ \t]*$")
8271 (string-match
8272 "^\\*+$" (buffer-substring
8273 (point-at-bol) (point))))
8274 (- (match-end 1) (match-beginning 1)))
8275 ((and (bolp)
8276 (looking-at org-outline-regexp))
8277 (- (match-end 0) (point) 1))))
8278 (previous-level (save-excursion
8279 (condition-case nil
8280 (progn
8281 (outline-previous-visible-heading 1)
8282 (if (looking-at ^re_)
8283 (- (match-end 0) (match-beginning 0) 1)
8285 (error 1))))
8286 (next-level (save-excursion
8287 (condition-case nil
8288 (progn
8289 (or (looking-at org-outline-regexp)
8290 (outline-next-visible-heading 1))
8291 (if (looking-at ^re_)
8292 (- (match-end 0) (match-beginning 0) 1)
8294 (error 1))))
8295 (new-level (or force-level (max previous-level next-level)))
8296 (shift (if (or (= old-level -1)
8297 (= new-level -1)
8298 (= old-level new-level))
8300 (- new-level old-level)))
8301 (delta (if (> shift 0) -1 1))
8302 (func (if (> shift 0) 'org-demote 'org-promote))
8303 (org-odd-levels-only nil)
8304 beg end newend)
8305 ;; Remove the forced level indicator
8306 (if force-level
8307 (delete-region (point-at-bol) (point)))
8308 ;; Paste
8309 (beginning-of-line (if (bolp) 1 2))
8310 (setq beg (point))
8311 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8312 (insert-before-markers txt)
8313 (unless (string-match "\n\\'" txt) (insert "\n"))
8314 (setq newend (point))
8315 (org-reinstall-markers-in-region beg)
8316 (setq end (point))
8317 (goto-char beg)
8318 (skip-chars-forward " \t\n\r")
8319 (setq beg (point))
8320 (if (and (outline-invisible-p) visp)
8321 (save-excursion (outline-show-heading)))
8322 ;; Shift if necessary
8323 (unless (= shift 0)
8324 (save-restriction
8325 (narrow-to-region beg end)
8326 (while (not (= shift 0))
8327 (org-map-region func (point-min) (point-max))
8328 (setq shift (+ delta shift)))
8329 (goto-char (point-min))
8330 (setq newend (point-max))))
8331 (when (or (org-called-interactively-p 'interactive) for-yank)
8332 (message "Clipboard pasted as level %d subtree" new-level))
8333 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8334 kill-ring
8335 (eq org-subtree-clip (current-kill 0))
8336 org-subtree-clip-folded)
8337 ;; The tree was folded before it was killed/copied
8338 (hide-subtree))
8339 (and for-yank (goto-char newend)))))
8341 (defun org-kill-is-subtree-p (&optional txt)
8342 "Check if the current kill is an outline subtree, or a set of trees.
8343 Returns nil if kill does not start with a headline, or if the first
8344 headline level is not the largest headline level in the tree.
8345 So this will actually accept several entries of equal levels as well,
8346 which is OK for `org-paste-subtree'.
8347 If optional TXT is given, check this string instead of the current kill."
8348 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8349 (re (org-get-limited-outline-regexp))
8350 (^re (concat "^" re))
8351 (start-level (and kill
8352 (string-match
8353 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8354 kill)
8355 (- (match-end 2) (match-beginning 2) 1)))
8356 (start (1+ (or (match-beginning 2) -1))))
8357 (if (not start-level)
8358 (progn
8359 nil) ;; does not even start with a heading
8360 (catch 'exit
8361 (while (setq start (string-match ^re kill (1+ start)))
8362 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8363 (throw 'exit nil)))
8364 t))))
8366 (defvar org-markers-to-move nil
8367 "Markers that should be moved with a cut-and-paste operation.
8368 Those markers are stored together with their positions relative to
8369 the start of the region.")
8371 (defun org-save-markers-in-region (beg end)
8372 "Check markers in region.
8373 If these markers are between BEG and END, record their position relative
8374 to BEG, so that after moving the block of text, we can put the markers back
8375 into place.
8376 This function gets called just before an entry or tree gets cut from the
8377 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8378 called immediately, to move the markers with the entries."
8379 (setq org-markers-to-move nil)
8380 (when (featurep 'org-clock)
8381 (org-clock-save-markers-for-cut-and-paste beg end))
8382 (when (featurep 'org-agenda)
8383 (org-agenda-save-markers-for-cut-and-paste beg end)))
8385 (defun org-check-and-save-marker (marker beg end)
8386 "Check if MARKER is between BEG and END.
8387 If yes, remember the marker and the distance to BEG."
8388 (when (and (marker-buffer marker)
8389 (equal (marker-buffer marker) (current-buffer)))
8390 (if (and (>= marker beg) (< marker end))
8391 (push (cons marker (- marker beg)) org-markers-to-move))))
8393 (defun org-reinstall-markers-in-region (beg)
8394 "Move all remembered markers to their position relative to BEG."
8395 (mapc (lambda (x)
8396 (move-marker (car x) (+ beg (cdr x))))
8397 org-markers-to-move)
8398 (setq org-markers-to-move nil))
8400 (defun org-narrow-to-subtree ()
8401 "Narrow buffer to the current subtree."
8402 (interactive)
8403 (save-excursion
8404 (save-match-data
8405 (org-with-limited-levels
8406 (narrow-to-region
8407 (progn (org-back-to-heading t) (point))
8408 (progn (org-end-of-subtree t t)
8409 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8410 (point)))))))
8412 (defun org-narrow-to-block ()
8413 "Narrow buffer to the current block."
8414 (interactive)
8415 (let* ((case-fold-search t)
8416 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8417 "^[ \t]*#\\+end_.*")))
8418 (if blockp
8419 (narrow-to-region (car blockp) (cdr blockp))
8420 (user-error "Not in a block"))))
8422 (eval-when-compile
8423 (defvar org-property-drawer-re))
8425 (defvar org-property-start-re) ;; defined below
8426 (defun org-clone-subtree-with-time-shift (n &optional shift)
8427 "Clone the task (subtree) at point N times.
8428 The clones will be inserted as siblings.
8430 In interactive use, the user will be prompted for the number of
8431 clones to be produced. If the entry has a timestamp, the user
8432 will also be prompted for a time shift, which may be a repeater
8433 as used in time stamps, for example `+3d'. To disable this,
8434 you can call the function with a universal prefix argument.
8436 When a valid repeater is given and the entry contains any time
8437 stamps, the clones will become a sequence in time, with time
8438 stamps in the subtree shifted for each clone produced. If SHIFT
8439 is nil or the empty string, time stamps will be left alone. The
8440 ID property of the original subtree is removed.
8442 If the original subtree did contain time stamps with a repeater,
8443 the following will happen:
8444 - the repeater will be removed in each clone
8445 - an additional clone will be produced, with the current, unshifted
8446 date(s) in the entry.
8447 - the original entry will be placed *after* all the clones, with
8448 repeater intact.
8449 - the start days in the repeater in the original entry will be shifted
8450 to past the last clone.
8451 In this way you can spell out a number of instances of a repeating task,
8452 and still retain the repeater to cover future instances of the task."
8453 (interactive "nNumber of clones to produce: ")
8454 (let ((shift
8455 (or shift
8456 (if (and (not (equal current-prefix-arg '(4)))
8457 (save-excursion
8458 (re-search-forward org-ts-regexp-both
8459 (save-excursion
8460 (org-end-of-subtree t)
8461 (point)) t)))
8462 (read-from-minibuffer
8463 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8464 ""))) ;; No time shift
8465 (n-no-remove -1)
8466 (drawer-re org-drawer-regexp)
8467 beg end template task idprop
8468 shift-n shift-what doshift nmin nmax)
8469 (if (not (and (integerp n) (> n 0)))
8470 (error "Invalid number of replications %s" n))
8471 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8472 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8473 shift)))
8474 (error "Invalid shift specification %s" shift))
8475 (when doshift
8476 (setq shift-n (string-to-number (match-string 1 shift))
8477 shift-what (cdr (assoc (match-string 2 shift)
8478 '(("d" . day) ("w" . week)
8479 ("m" . month) ("y" . year))))))
8480 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8481 (setq nmin 1 nmax n)
8482 (org-back-to-heading t)
8483 (setq beg (point))
8484 (setq idprop (org-entry-get nil "ID"))
8485 (org-end-of-subtree t t)
8486 (or (bolp) (insert "\n"))
8487 (setq end (point))
8488 (setq template (buffer-substring beg end))
8489 (when (and doshift
8490 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8491 (delete-region beg end)
8492 (setq end beg)
8493 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8494 (goto-char end)
8495 (loop for n from nmin to nmax do
8496 ;; prepare clone
8497 (with-temp-buffer
8498 (insert template)
8499 (org-mode)
8500 (goto-char (point-min))
8501 (org-show-subtree)
8502 (and idprop (if org-clone-delete-id
8503 (org-entry-delete nil "ID")
8504 (org-id-get-create t)))
8505 (unless (= n 0)
8506 (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
8507 (kill-whole-line))
8508 (goto-char (point-min))
8509 (while (re-search-forward drawer-re nil t)
8510 (mapc (lambda (d)
8511 (org-remove-empty-drawer-at d (point))) org-drawers)))
8512 (goto-char (point-min))
8513 (when doshift
8514 (while (re-search-forward org-ts-regexp-both nil t)
8515 (org-timestamp-change (* n shift-n) shift-what))
8516 (unless (= n n-no-remove)
8517 (goto-char (point-min))
8518 (while (re-search-forward org-ts-regexp nil t)
8519 (save-excursion
8520 (goto-char (match-beginning 0))
8521 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8522 (delete-region (match-beginning 1) (match-end 1)))))))
8523 (setq task (buffer-string)))
8524 (insert task))
8525 (goto-char beg)))
8527 ;;; Outline Sorting
8529 (defun org-sort (with-case)
8530 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8531 Optional argument WITH-CASE means sort case-sensitively."
8532 (interactive "P")
8533 (cond
8534 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8535 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8537 (org-call-with-arg 'org-sort-entries with-case))))
8539 (defun org-sort-remove-invisible (s)
8540 "Remove invisible links from string S."
8541 (remove-text-properties 0 (length s) org-rm-props s)
8542 (while (string-match org-bracket-link-regexp s)
8543 (setq s (replace-match (if (match-end 2)
8544 (match-string 3 s)
8545 (match-string 1 s)) t t s)))
8546 (let ((st (format " %s " s)))
8547 (while (string-match org-emph-re st)
8548 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8549 (setq s (substring st 1 -1)))
8552 (defvar org-priority-regexp) ; defined later in the file
8554 (defvar org-after-sorting-entries-or-items-hook nil
8555 "Hook that is run after a bunch of entries or items have been sorted.
8556 When children are sorted, the cursor is in the parent line when this
8557 hook gets called. When a region or a plain list is sorted, the cursor
8558 will be in the first entry of the sorted region/list.")
8560 (defun org-sort-entries
8561 (&optional with-case sorting-type getkey-func compare-func property)
8562 "Sort entries on a certain level of an outline tree.
8563 If there is an active region, the entries in the region are sorted.
8564 Else, if the cursor is before the first entry, sort the top-level items.
8565 Else, the children of the entry at point are sorted.
8567 Sorting can be alphabetically, numerically, by date/time as given by
8568 a time stamp, by a property, by priority order, or by a custom function.
8570 The command prompts for the sorting type unless it has been given to the
8571 function through the SORTING-TYPE argument, which needs to be a character,
8572 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8573 precise meaning of each character:
8575 n Numerically, by converting the beginning of the entry/item to a number.
8576 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8577 o By order of TODO keywords.
8578 t By date/time, either the first active time stamp in the entry, or, if
8579 none exist, by the first inactive one.
8580 s By the scheduled date/time.
8581 d By deadline date/time.
8582 c By creation time, which is assumed to be the first inactive time stamp
8583 at the beginning of a line.
8584 p By priority according to the cookie.
8585 r By the value of a property.
8587 Capital letters will reverse the sort order.
8589 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8590 called with point at the beginning of the record. It must return either
8591 a string or a number that should serve as the sorting key for that record.
8593 Comparing entries ignores case by default. However, with an optional argument
8594 WITH-CASE, the sorting considers case as well.
8596 Sorting is done against the visible part of the headlines, it ignores hidden
8597 links."
8598 (interactive "P")
8599 (let ((case-func (if with-case 'identity 'downcase))
8600 (cmstr
8601 ;; The clock marker is lost when using `sort-subr', let's
8602 ;; store the clocking string.
8603 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8604 (save-excursion
8605 (goto-char org-clock-marker)
8606 (looking-back "^.*") (match-string-no-properties 0))))
8607 start beg end stars re re2
8608 txt what tmp)
8609 ;; Find beginning and end of region to sort
8610 (cond
8611 ((org-region-active-p)
8612 ;; we will sort the region
8613 (setq end (region-end)
8614 what "region")
8615 (goto-char (region-beginning))
8616 (if (not (org-at-heading-p)) (outline-next-heading))
8617 (setq start (point)))
8618 ((or (org-at-heading-p)
8619 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8620 ;; we will sort the children of the current headline
8621 (org-back-to-heading)
8622 (setq start (point)
8623 end (progn (org-end-of-subtree t t)
8624 (or (bolp) (insert "\n"))
8625 (org-back-over-empty-lines)
8626 (point))
8627 what "children")
8628 (goto-char start)
8629 (show-subtree)
8630 (outline-next-heading))
8632 ;; we will sort the top-level entries in this file
8633 (goto-char (point-min))
8634 (or (org-at-heading-p) (outline-next-heading))
8635 (setq start (point))
8636 (goto-char (point-max))
8637 (beginning-of-line 1)
8638 (when (looking-at ".*?\\S-")
8639 ;; File ends in a non-white line
8640 (end-of-line 1)
8641 (insert "\n"))
8642 (setq end (point-max))
8643 (setq what "top-level")
8644 (goto-char start)
8645 (show-all)))
8647 (setq beg (point))
8648 (if (>= beg end) (user-error "Nothing to sort"))
8650 (looking-at "\\(\\*+\\)")
8651 (setq stars (match-string 1)
8652 re (concat "^" (regexp-quote stars) " +")
8653 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8654 txt (buffer-substring beg end))
8655 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8656 (if (and (not (equal stars "*")) (string-match re2 txt))
8657 (user-error "Region to sort contains a level above the first entry"))
8659 (unless sorting-type
8660 (message
8661 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8662 [t]ime [s]cheduled [d]eadline [c]reated
8663 A/N/P/R/O/F/T/S/D/C means reversed:"
8664 what)
8665 (setq sorting-type (read-char-exclusive))
8667 (unless getkey-func
8668 (and (= (downcase sorting-type) ?f)
8669 (setq getkey-func
8670 (org-icompleting-read "Sort using function: "
8671 obarray 'fboundp t nil nil))
8672 (setq getkey-func (intern getkey-func))))
8674 (and (= (downcase sorting-type) ?r)
8675 (not property)
8676 (setq property
8677 (org-icompleting-read "Property: "
8678 (mapcar 'list (org-buffer-property-keys t))
8679 nil t))))
8681 (message "Sorting entries...")
8683 (save-restriction
8684 (narrow-to-region start end)
8685 (let ((dcst (downcase sorting-type))
8686 (case-fold-search nil)
8687 (now (current-time)))
8688 (sort-subr
8689 (/= dcst sorting-type)
8690 ;; This function moves to the beginning character of the "record" to
8691 ;; be sorted.
8692 (lambda nil
8693 (if (re-search-forward re nil t)
8694 (goto-char (match-beginning 0))
8695 (goto-char (point-max))))
8696 ;; This function moves to the last character of the "record" being
8697 ;; sorted.
8698 (lambda nil
8699 (save-match-data
8700 (condition-case nil
8701 (outline-forward-same-level 1)
8702 (error
8703 (goto-char (point-max))))))
8704 ;; This function returns the value that gets sorted against.
8705 (lambda nil
8706 (cond
8707 ((= dcst ?n)
8708 (if (looking-at org-complex-heading-regexp)
8709 (string-to-number (org-sort-remove-invisible (match-string 4)))
8710 nil))
8711 ((= dcst ?a)
8712 (if (looking-at org-complex-heading-regexp)
8713 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8714 nil))
8715 ((= dcst ?t)
8716 (let ((end (save-excursion (outline-next-heading) (point))))
8717 (if (or (re-search-forward org-ts-regexp end t)
8718 (re-search-forward org-ts-regexp-both end t))
8719 (org-time-string-to-seconds (match-string 0))
8720 (org-float-time now))))
8721 ((= dcst ?c)
8722 (let ((end (save-excursion (outline-next-heading) (point))))
8723 (if (re-search-forward
8724 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8725 end t)
8726 (org-time-string-to-seconds (match-string 0))
8727 (org-float-time now))))
8728 ((= dcst ?s)
8729 (let ((end (save-excursion (outline-next-heading) (point))))
8730 (if (re-search-forward org-scheduled-time-regexp end t)
8731 (org-time-string-to-seconds (match-string 1))
8732 (org-float-time now))))
8733 ((= dcst ?d)
8734 (let ((end (save-excursion (outline-next-heading) (point))))
8735 (if (re-search-forward org-deadline-time-regexp end t)
8736 (org-time-string-to-seconds (match-string 1))
8737 (org-float-time now))))
8738 ((= dcst ?p)
8739 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8740 (string-to-char (match-string 2))
8741 org-default-priority))
8742 ((= dcst ?r)
8743 (or (org-entry-get nil property) ""))
8744 ((= dcst ?o)
8745 (if (looking-at org-complex-heading-regexp)
8746 (- 9999 (length (member (match-string 2)
8747 org-todo-keywords-1)))))
8748 ((= dcst ?f)
8749 (if getkey-func
8750 (progn
8751 (setq tmp (funcall getkey-func))
8752 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8753 tmp)
8754 (error "Invalid key function `%s'" getkey-func)))
8755 (t (error "Invalid sorting type `%c'" sorting-type))))
8757 (cond
8758 ((= dcst ?a) 'string<)
8759 ((= dcst ?f) compare-func)
8760 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8761 (run-hooks 'org-after-sorting-entries-or-items-hook)
8762 ;; Reset the clock marker if needed
8763 (when cmstr
8764 (save-excursion
8765 (goto-char start)
8766 (search-forward cmstr nil t)
8767 (move-marker org-clock-marker (point))))
8768 (message "Sorting entries...done")))
8770 (defun org-do-sort (table what &optional with-case sorting-type)
8771 "Sort TABLE of WHAT according to SORTING-TYPE.
8772 The user will be prompted for the SORTING-TYPE if the call to this
8773 function does not specify it. WHAT is only for the prompt, to indicate
8774 what is being sorted. The sorting key will be extracted from
8775 the car of the elements of the table.
8776 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8777 (unless sorting-type
8778 (message
8779 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8780 what)
8781 (setq sorting-type (read-char-exclusive)))
8782 (let ((dcst (downcase sorting-type))
8783 extractfun comparefun)
8784 ;; Define the appropriate functions
8785 (cond
8786 ((= dcst ?n)
8787 (setq extractfun 'string-to-number
8788 comparefun (if (= dcst sorting-type) '< '>)))
8789 ((= dcst ?a)
8790 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8791 (lambda(x) (downcase (org-sort-remove-invisible x))))
8792 comparefun (if (= dcst sorting-type)
8793 'string<
8794 (lambda (a b) (and (not (string< a b))
8795 (not (string= a b)))))))
8796 ((= dcst ?t)
8797 (setq extractfun
8798 (lambda (x)
8799 (if (or (string-match org-ts-regexp x)
8800 (string-match org-ts-regexp-both x))
8801 (org-float-time
8802 (org-time-string-to-time (match-string 0 x)))
8804 comparefun (if (= dcst sorting-type) '< '>)))
8805 (t (error "Invalid sorting type `%c'" sorting-type)))
8807 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8808 table)
8809 (lambda (a b) (funcall comparefun (car a) (car b))))))
8812 ;;; The orgstruct minor mode
8814 ;; Define a minor mode which can be used in other modes in order to
8815 ;; integrate the org-mode structure editing commands.
8817 ;; This is really a hack, because the org-mode structure commands use
8818 ;; keys which normally belong to the major mode. Here is how it
8819 ;; works: The minor mode defines all the keys necessary to operate the
8820 ;; structure commands, but wraps the commands into a function which
8821 ;; tests if the cursor is currently at a headline or a plain list
8822 ;; item. If that is the case, the structure command is used,
8823 ;; temporarily setting many Org-mode variables like regular
8824 ;; expressions for filling etc. However, when any of those keys is
8825 ;; used at a different location, function uses `key-binding' to look
8826 ;; up if the key has an associated command in another currently active
8827 ;; keymap (minor modes, major mode, global), and executes that
8828 ;; command. There might be problems if any of the keys is otherwise
8829 ;; used as a prefix key.
8831 (defcustom orgstruct-heading-prefix-regexp ""
8832 "Regexp that matches the custom prefix of Org headlines in
8833 orgstruct(++)-mode."
8834 :group 'org
8835 :version "24.4"
8836 :package-version '(Org . "8.3")
8837 :type 'regexp)
8838 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8840 (defcustom orgstruct-setup-hook nil
8841 "Hook run after orgstruct-mode-map is filled."
8842 :group 'org
8843 :version "24.4"
8844 :package-version '(Org . "8.0")
8845 :type 'hook)
8847 (defvar orgstruct-initialized nil)
8849 (defvar org-local-vars nil
8850 "List of local variables, for use by `orgstruct-mode'.")
8852 ;;;###autoload
8853 (define-minor-mode orgstruct-mode
8854 "Toggle the minor mode `orgstruct-mode'.
8855 This mode is for using Org-mode structure commands in other
8856 modes. The following keys behave as if Org-mode were active, if
8857 the cursor is on a headline, or on a plain list item (both as
8858 defined by Org-mode)."
8859 nil " OrgStruct" (make-sparse-keymap)
8860 (funcall (if orgstruct-mode
8861 'add-to-invisibility-spec
8862 'remove-from-invisibility-spec)
8863 '(outline . t))
8864 (when orgstruct-mode
8865 (org-load-modules-maybe)
8866 (unless orgstruct-initialized
8867 (orgstruct-setup)
8868 (setq orgstruct-initialized t))))
8870 ;;;###autoload
8871 (defun turn-on-orgstruct ()
8872 "Unconditionally turn on `orgstruct-mode'."
8873 (orgstruct-mode 1))
8875 (defvar org-fb-vars nil)
8876 (make-variable-buffer-local 'org-fb-vars)
8877 (defun orgstruct++-mode (&optional arg)
8878 "Toggle `orgstruct-mode', the enhanced version of it.
8879 In addition to setting orgstruct-mode, this also exports all
8880 indentation and autofilling variables from org-mode into the
8881 buffer. It will also recognize item context in multiline items."
8882 (interactive "P")
8883 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8884 (if (< arg 1)
8885 (progn (orgstruct-mode -1)
8886 (mapc (lambda(v)
8887 (org-set-local (car v)
8888 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8889 org-fb-vars))
8890 (orgstruct-mode 1)
8891 (setq org-fb-vars nil)
8892 (unless org-local-vars
8893 (setq org-local-vars (org-get-local-variables)))
8894 (let (var val)
8895 (mapc
8896 (lambda (x)
8897 (when (string-match
8898 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
8899 (symbol-name (car x)))
8900 (setq var (car x) val (nth 1 x))
8901 (push (list var `(quote ,(eval var))) org-fb-vars)
8902 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8903 org-local-vars)
8904 (org-set-local 'orgstruct-is-++ t))))
8906 (defvar orgstruct-is-++ nil
8907 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8908 (make-variable-buffer-local 'orgstruct-is-++)
8910 ;;;###autoload
8911 (defun turn-on-orgstruct++ ()
8912 "Unconditionally turn on `orgstruct++-mode'."
8913 (orgstruct++-mode 1))
8915 (defun orgstruct-error ()
8916 "Error when there is no default binding for a structure key."
8917 (interactive)
8918 (funcall (if (fboundp 'user-error)
8919 'user-error
8920 'error)
8921 "This key has no function outside structure elements"))
8923 (defun orgstruct-setup ()
8924 "Setup orgstruct keymap."
8925 (dolist (cell '((org-demote . t)
8926 (org-metaleft . t)
8927 (org-metaright . t)
8928 (org-promote . t)
8929 (org-shiftmetaleft . t)
8930 (org-shiftmetaright . t)
8931 org-backward-element
8932 org-backward-heading-same-level
8933 org-ctrl-c-ret
8934 org-ctrl-c-minus
8935 org-ctrl-c-star
8936 org-cycle
8937 org-forward-heading-same-level
8938 org-insert-heading
8939 org-insert-heading-respect-content
8940 org-kill-note-or-show-branches
8941 org-mark-subtree
8942 org-meta-return
8943 org-metadown
8944 org-metaup
8945 org-narrow-to-subtree
8946 org-promote-subtree
8947 org-reveal
8948 org-shiftdown
8949 org-shiftleft
8950 org-shiftmetadown
8951 org-shiftmetaup
8952 org-shiftright
8953 org-shifttab
8954 org-shifttab
8955 org-shiftup
8956 org-show-subtree
8957 org-sort
8958 org-up-element
8959 outline-demote
8960 outline-next-visible-heading
8961 outline-previous-visible-heading
8962 outline-promote
8963 outline-up-heading
8964 show-children))
8965 (let ((f (or (car-safe cell) cell))
8966 (disable-when-heading-prefix (cdr-safe cell)))
8967 (when (fboundp f)
8968 (let ((new-bindings))
8969 (dolist (binding (nconc (where-is-internal f org-mode-map)
8970 (where-is-internal f outline-mode-map)))
8971 (push binding new-bindings)
8972 ;; TODO use local-function-key-map
8973 (dolist (rep '(("<tab>" . "TAB")
8974 ("<return>" . "RET")
8975 ("<escape>" . "ESC")
8976 ("<delete>" . "DEL")))
8977 (setq binding (read-kbd-macro
8978 (let ((case-fold-search))
8979 (replace-regexp-in-string
8980 (regexp-quote (cdr rep))
8981 (car rep)
8982 (key-description binding)))))
8983 (pushnew binding new-bindings :test 'equal)))
8984 (dolist (binding new-bindings)
8985 (let ((key (lookup-key orgstruct-mode-map binding)))
8986 (when (or (not key) (numberp key))
8987 (condition-case nil
8988 (org-defkey orgstruct-mode-map
8989 binding
8990 (orgstruct-make-binding f binding disable-when-heading-prefix))
8991 (error nil)))))))))
8992 (run-hooks 'orgstruct-setup-hook))
8994 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
8995 "Create a function for binding in the structure minor mode.
8996 FUN is the command to call inside a table. KEY is the key that
8997 should be checked in for a command to execute outside of tables.
8998 Non-nil `disable-when-heading-prefix' means to disable the command
8999 if `orgstruct-heading-prefix-regexp' is not empty."
9000 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9001 (let ((nname name)
9002 (i 0))
9003 (while (fboundp (intern nname))
9004 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9005 (setq name (intern nname)))
9006 (eval
9007 (let ((bindings '((org-heading-regexp
9008 (concat "^"
9009 orgstruct-heading-prefix-regexp
9010 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9011 (org-outline-regexp
9012 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9013 (org-outline-regexp-bol
9014 (concat "^" org-outline-regexp))
9015 (outline-regexp org-outline-regexp)
9016 (outline-heading-end-regexp "\n")
9017 (outline-level 'org-outline-level)
9018 (outline-heading-alist))))
9019 `(defun ,name (arg)
9020 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9021 "Outside of structure, run the binding of `"
9022 (key-description key) "'."
9023 (when disable-when-heading-prefix
9024 (concat
9025 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9026 "back to the default binding due to limitations of Org's implementation of\n"
9027 "`" (symbol-name fun) "'.")))
9028 (interactive "p")
9029 (let* ((disable
9030 ,(and disable-when-heading-prefix
9031 '(not (string= orgstruct-heading-prefix-regexp ""))))
9032 (fallback
9033 (or disable
9034 (not
9035 (let* ,bindings
9036 (org-context-p 'headline 'item
9037 ,(when (memq fun
9038 '(org-insert-heading
9039 org-insert-heading-respect-content
9040 org-meta-return))
9041 '(when orgstruct-is-++
9042 'item-body))))))))
9043 (if fallback
9044 (let* ((orgstruct-mode)
9045 (binding
9046 (loop with key = ,key
9047 for rep in
9048 '(nil
9049 ("<\\([^>]*\\)tab>" . "\\1TAB")
9050 ("<\\([^>]*\\)return>" . "\\1RET")
9051 ("<\\([^>]*\\)escape>" . "\\1ESC")
9052 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9054 (when rep
9055 (setq key (read-kbd-macro
9056 (let ((case-fold-search))
9057 (replace-regexp-in-string
9058 (car rep)
9059 (cdr rep)
9060 (key-description key))))))
9061 thereis (key-binding key))))
9062 (if (keymapp binding)
9063 (set-transient-map binding)
9064 (let ((func (or binding
9065 (unless disable
9066 'orgstruct-error))))
9067 (when func
9068 (call-interactively func)))))
9069 (org-run-like-in-org-mode
9070 (lambda ()
9071 (interactive)
9072 (let* ,bindings
9073 (call-interactively ',fun)))))))))
9074 name))
9076 (defun org-contextualize-keys (alist contexts)
9077 "Return valid elements in ALIST depending on CONTEXTS.
9079 `org-agenda-custom-commands' or `org-capture-templates' are the
9080 values used for ALIST, and `org-agenda-custom-commands-contexts'
9081 or `org-capture-templates-contexts' are the associated contexts
9082 definitions."
9083 (let ((contexts
9084 ;; normalize contexts
9085 (mapcar
9086 (lambda(c) (cond ((listp (cadr c))
9087 (list (car c) (car c) (cadr c)))
9088 ((string= "" (cadr c))
9089 (list (car c) (car c) (caddr c)))
9090 (t c))) contexts))
9091 (a alist) c r s)
9092 ;; loop over all commands or templates
9093 (while (setq c (pop a))
9094 (let (vrules repl)
9095 (cond
9096 ((not (assoc (car c) contexts))
9097 (push c r))
9098 ((and (assoc (car c) contexts)
9099 (setq vrules (org-contextualize-validate-key
9100 (car c) contexts)))
9101 (mapc (lambda (vr)
9102 (when (not (equal (car vr) (cadr vr)))
9103 (setq repl vr))) vrules)
9104 (if (not repl) (push c r)
9105 (push (cadr repl) s)
9106 (push
9107 (cons (car c)
9108 (cdr (or (assoc (cadr repl) alist)
9109 (error "Undefined key `%s' as contextual replacement for `%s'"
9110 (cadr repl) (car c)))))
9111 r))))))
9112 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9113 (delq
9115 (delete-dups
9116 (mapcar (lambda (x)
9117 (let ((tpl (car x)))
9118 (when (not (delq
9120 (mapcar (lambda(y)
9121 (equal y tpl)) s))) x)))
9122 (reverse r))))))
9124 (defun org-contextualize-validate-key (key contexts)
9125 "Check CONTEXTS for agenda or capture KEY."
9126 (let (r rr res)
9127 (while (setq r (pop contexts))
9128 (mapc
9129 (lambda (rr)
9130 (when
9131 (and (equal key (car r))
9132 (if (functionp rr) (funcall rr)
9133 (or (and (eq (car rr) 'in-file)
9134 (buffer-file-name)
9135 (string-match (cdr rr) (buffer-file-name)))
9136 (and (eq (car rr) 'in-mode)
9137 (string-match (cdr rr) (symbol-name major-mode)))
9138 (and (eq (car rr) 'in-buffer)
9139 (string-match (cdr rr) (buffer-name)))
9140 (when (and (eq (car rr) 'not-in-file)
9141 (buffer-file-name))
9142 (not (string-match (cdr rr) (buffer-file-name))))
9143 (when (eq (car rr) 'not-in-mode)
9144 (not (string-match (cdr rr) (symbol-name major-mode))))
9145 (when (eq (car rr) 'not-in-buffer)
9146 (not (string-match (cdr rr) (buffer-name)))))))
9147 (push r res)))
9148 (car (last r))))
9149 (delete-dups (delq nil res))))
9151 (defun org-context-p (&rest contexts)
9152 "Check if local context is any of CONTEXTS.
9153 Possible values in the list of contexts are `table', `headline', and `item'."
9154 (let ((pos (point)))
9155 (goto-char (point-at-bol))
9156 (prog1 (or (and (memq 'table contexts)
9157 (looking-at "[ \t]*|"))
9158 (and (memq 'headline contexts)
9159 (looking-at org-outline-regexp))
9160 (and (memq 'item contexts)
9161 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9162 (and (memq 'item-body contexts)
9163 (org-in-item-p)))
9164 (goto-char pos))))
9166 (defun org-get-local-variables ()
9167 "Return a list of all local variables in an Org mode buffer."
9168 (let (varlist)
9169 (with-current-buffer (get-buffer-create "*Org tmp*")
9170 (erase-buffer)
9171 (org-mode)
9172 (setq varlist (buffer-local-variables)))
9173 (kill-buffer "*Org tmp*")
9174 (delq nil
9175 (mapcar
9176 (lambda (x)
9177 (setq x
9178 (if (symbolp x)
9179 (list x)
9180 (list (car x) (cdr x))))
9181 (if (and (not (get (car x) 'org-state))
9182 (string-match
9183 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9184 (symbol-name (car x))))
9185 x nil))
9186 varlist))))
9188 (defun org-clone-local-variables (from-buffer &optional regexp)
9189 "Clone local variables from FROM-BUFFER.
9190 Optional argument REGEXP selects variables to clone."
9191 (mapc
9192 (lambda (pair)
9193 (and (symbolp (car pair))
9194 (or (null regexp)
9195 (string-match regexp (symbol-name (car pair))))
9196 (set (make-local-variable (car pair))
9197 (cdr pair))))
9198 (buffer-local-variables from-buffer)))
9200 ;;;###autoload
9201 (defun org-run-like-in-org-mode (cmd)
9202 "Run a command, pretending that the current buffer is in Org-mode.
9203 This will temporarily bind local variables that are typically bound in
9204 Org-mode to the values they have in Org-mode, and then interactively
9205 call CMD."
9206 (org-load-modules-maybe)
9207 (unless org-local-vars
9208 (setq org-local-vars (org-get-local-variables)))
9209 (let (binds)
9210 (dolist (var org-local-vars)
9211 (when (or (not (boundp (car var)))
9212 (eq (symbol-value (car var))
9213 (default-value (car var))))
9214 (push (list (car var) `(quote ,(cadr var))) binds)))
9215 (eval `(let ,binds
9216 (call-interactively (quote ,cmd))))))
9218 ;;;; Archiving
9220 (defun org-get-category (&optional pos force-refresh)
9221 "Get the category applying to position POS."
9222 (save-match-data
9223 (if force-refresh (org-refresh-category-properties))
9224 (let ((pos (or pos (point))))
9225 (or (get-text-property pos 'org-category)
9226 (progn (org-refresh-category-properties)
9227 (get-text-property pos 'org-category))))))
9229 (defun org-refresh-category-properties ()
9230 "Refresh category text properties in the buffer."
9231 (let ((case-fold-search t)
9232 (inhibit-read-only t)
9233 (def-cat (cond
9234 ((null org-category)
9235 (if buffer-file-name
9236 (file-name-sans-extension
9237 (file-name-nondirectory buffer-file-name))
9238 "???"))
9239 ((symbolp org-category) (symbol-name org-category))
9240 (t org-category)))
9241 beg end cat pos optionp)
9242 (org-with-silent-modifications
9243 (save-excursion
9244 (save-restriction
9245 (widen)
9246 (goto-char (point-min))
9247 (put-text-property (point) (point-max) 'org-category def-cat)
9248 (while (re-search-forward
9249 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
9250 (setq pos (match-end 0)
9251 optionp (equal (char-after (match-beginning 0)) ?#)
9252 cat (org-trim (match-string 2)))
9253 (if optionp
9254 (setq beg (point-at-bol) end (point-max))
9255 (org-back-to-heading t)
9256 (setq beg (point) end (org-end-of-subtree t t)))
9257 (put-text-property beg end 'org-category cat)
9258 (put-text-property beg end 'org-category-position beg)
9259 (goto-char pos)))))))
9261 (defun org-refresh-properties (dprop tprop)
9262 "Refresh buffer text properties.
9263 DPROP is the drawer property and TPROP is the corresponding text
9264 property to set."
9265 (let ((case-fold-search t)
9266 (inhibit-read-only t) p)
9267 (org-with-silent-modifications
9268 (save-excursion
9269 (save-restriction
9270 (widen)
9271 (goto-char (point-min))
9272 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9273 (setq p (org-match-string-no-properties 1))
9274 (save-excursion
9275 (org-back-to-heading t)
9276 (put-text-property
9277 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9280 ;;;; Link Stuff
9282 ;;; Link abbreviations
9284 (defun org-link-expand-abbrev (link)
9285 "Apply replacements as defined in `org-link-abbrev-alist'."
9286 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9287 (let* ((key (match-string 1 link))
9288 (as (or (assoc key org-link-abbrev-alist-local)
9289 (assoc key org-link-abbrev-alist)))
9290 (tag (and (match-end 2) (match-string 3 link)))
9291 rpl)
9292 (if (not as)
9293 link
9294 (setq rpl (cdr as))
9295 (cond
9296 ((symbolp rpl) (funcall rpl tag))
9297 ((string-match "%(\\([^)]+\\))" rpl)
9298 (replace-match
9299 (save-match-data
9300 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9301 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9302 ((string-match "%h" rpl)
9303 (replace-match (url-hexify-string (or tag "")) t t rpl))
9304 (t (concat rpl tag)))))
9305 link))
9307 ;;; Storing and inserting links
9309 (defvar org-insert-link-history nil
9310 "Minibuffer history for links inserted with `org-insert-link'.")
9312 (defvar org-stored-links nil
9313 "Contains the links stored with `org-store-link'.")
9315 (defvar org-store-link-plist nil
9316 "Plist with info about the most recently link created with `org-store-link'.")
9318 (defvar org-link-protocols nil
9319 "Link protocols added to Org-mode using `org-add-link-type'.")
9321 (defvar org-store-link-functions nil
9322 "List of functions that are called to create and store a link.
9323 Each function will be called in turn until one returns a non-nil
9324 value. Each function should check if it is responsible for creating
9325 this link (for example by looking at the major mode).
9326 If not, it must exit and return nil.
9327 If yes, it should return a non-nil value after a calling
9328 `org-store-link-props' with a list of properties and values.
9329 Special properties are:
9331 :type The link prefix, like \"http\". This must be given.
9332 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9333 This is obligatory as well.
9334 :description Optional default description for the second pair
9335 of brackets in an Org-mode link. The user can still change
9336 this when inserting this link into an Org-mode buffer.
9338 In addition to these, any additional properties can be specified
9339 and then used in capture templates.")
9341 (defun org-add-link-type (type &optional follow export)
9342 "Add TYPE to the list of `org-link-types'.
9343 Re-compute all regular expressions depending on `org-link-types'
9345 FOLLOW and EXPORT are two functions.
9347 FOLLOW should take the link path as the single argument and do whatever
9348 is necessary to follow the link, for example find a file or display
9349 a mail message.
9351 EXPORT should format the link path for export to one of the export formats.
9352 It should be a function accepting three arguments:
9354 path the path of the link, the text after the prefix (like \"http:\")
9355 desc the description of the link, if any, or a description added by
9356 org-export-normalize-links if there is none
9357 format the export format, a symbol like `html' or `latex' or `ascii'..
9359 The function may use the FORMAT information to return different values
9360 depending on the format. The return value will be put literally into
9361 the exported file. If the return value is nil, this means Org should
9362 do what it normally does with links which do not have EXPORT defined.
9364 Org-mode has a built-in default for exporting links. If you are happy with
9365 this default, there is no need to define an export function for the link
9366 type. For a simple example of an export function, see `org-bbdb.el'."
9367 (add-to-list 'org-link-types type t)
9368 (org-make-link-regexps)
9369 (if (assoc type org-link-protocols)
9370 (setcdr (assoc type org-link-protocols) (list follow export))
9371 (push (list type follow export) org-link-protocols)))
9373 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9374 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9376 ;;;###autoload
9377 (defun org-store-link (arg)
9378 "\\<org-mode-map>Store an org-link to the current location.
9379 This link is added to `org-stored-links' and can later be inserted
9380 into an org-buffer with \\[org-insert-link].
9382 For some link types, a prefix arg is interpreted.
9383 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9384 For file links, arg negates `org-context-in-file-links'.
9386 A double prefix arg force skipping storing functions that are not
9387 part of Org's core.
9389 A triple prefix arg force storing a link for each line in the
9390 active region."
9391 (interactive "P")
9392 (org-load-modules-maybe)
9393 (if (and (equal arg '(64)) (org-region-active-p))
9394 (save-excursion
9395 (let ((end (region-end)))
9396 (goto-char (region-beginning))
9397 (set-mark (point))
9398 (while (< (point-at-eol) end)
9399 (move-end-of-line 1) (activate-mark)
9400 (let (current-prefix-arg)
9401 (call-interactively 'org-store-link))
9402 (move-beginning-of-line 2)
9403 (set-mark (point)))))
9404 (org-with-limited-levels
9405 (setq org-store-link-plist nil)
9406 (let (link cpltxt desc description search
9407 txt custom-id agenda-link sfuns sfunsn)
9408 (cond
9410 ;; Store a link using an external link type
9411 ((and (not (equal arg '(16)))
9412 (setq sfuns
9413 (delq
9414 nil (mapcar (lambda (f)
9415 (let (fs) (if (funcall f) (push f fs))))
9416 org-store-link-functions))
9417 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9418 (or (and (cdr sfuns)
9419 (funcall (intern
9420 (completing-read
9421 "Which function for creating the link? "
9422 sfunsn t (car sfunsn)))))
9423 (funcall (caar sfuns)))
9424 (setq link (plist-get org-store-link-plist :link)
9425 desc (or (plist-get org-store-link-plist
9426 :description) link))))
9428 ;; Store a link from a source code buffer
9429 ((org-src-edit-buffer-p)
9430 (let (label gc)
9431 (while (or (not label)
9432 (save-excursion
9433 (save-restriction
9434 (widen)
9435 (goto-char (point-min))
9436 (re-search-forward
9437 (regexp-quote (format org-coderef-label-format label))
9438 nil t))))
9439 (when label (message "Label exists already") (sit-for 2))
9440 (setq label (read-string "Code line label: " label)))
9441 (end-of-line 1)
9442 (setq link (format org-coderef-label-format label))
9443 (setq gc (- 79 (length link)))
9444 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9445 (insert link)
9446 (setq link (concat "(" label ")") desc nil)))
9448 ;; We are in the agenda, link to referenced location
9449 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9450 (let ((m (or (get-text-property (point) 'org-hd-marker)
9451 (get-text-property (point) 'org-marker))))
9452 (when m
9453 (org-with-point-at m
9454 (setq agenda-link
9455 (if (org-called-interactively-p 'any)
9456 (call-interactively 'org-store-link)
9457 (org-store-link nil)))))))
9459 ((eq major-mode 'calendar-mode)
9460 (let ((cd (calendar-cursor-to-date)))
9461 (setq link
9462 (format-time-string
9463 (car org-time-stamp-formats)
9464 (apply 'encode-time
9465 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9466 nil nil nil))))
9467 (org-store-link-props :type "calendar" :date cd)))
9469 ((eq major-mode 'help-mode)
9470 (setq link (concat "help:" (save-excursion
9471 (goto-char (point-min))
9472 (looking-at "^[^ ]+")
9473 (match-string 0))))
9474 (org-store-link-props :type "help"))
9476 ((eq major-mode 'w3-mode)
9477 (setq cpltxt (if (and (buffer-name)
9478 (not (string-match "Untitled" (buffer-name))))
9479 (buffer-name)
9480 (url-view-url t))
9481 link (url-view-url t))
9482 (org-store-link-props :type "w3" :url (url-view-url t)))
9484 ((eq major-mode 'image-mode)
9485 (setq cpltxt (concat "file:"
9486 (abbreviate-file-name buffer-file-name))
9487 link cpltxt)
9488 (org-store-link-props :type "image" :file buffer-file-name))
9490 ;; In dired, store a link to the file of the current line
9491 ((eq major-mode 'dired-mode)
9492 (let ((file (dired-get-filename nil t)))
9493 (setq file (if file
9494 (abbreviate-file-name
9495 (expand-file-name (dired-get-filename nil t)))
9496 ;; otherwise, no file so use current directory.
9497 default-directory))
9498 (setq cpltxt (concat "file:" file)
9499 link cpltxt)))
9501 ((setq search (run-hook-with-args-until-success
9502 'org-create-file-search-functions))
9503 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9504 "::" search))
9505 (setq cpltxt (or description link)))
9507 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9508 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9509 (cond
9510 ;; Store a link using the target at point
9511 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9512 (setq cpltxt
9513 (concat "file:"
9514 (abbreviate-file-name
9515 (buffer-file-name (buffer-base-buffer)))
9516 "::" (match-string 1))
9517 link cpltxt))
9518 ((and (featurep 'org-id)
9519 (or (eq org-id-link-to-org-use-id t)
9520 (and (org-called-interactively-p 'any)
9521 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9522 (and (eq org-id-link-to-org-use-id
9523 'create-if-interactive-and-no-custom-id)
9524 (not custom-id))))
9525 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9526 ;; Store a link using the ID at point
9527 (setq link (condition-case nil
9528 (prog1 (org-id-store-link)
9529 (setq desc (plist-get org-store-link-plist
9530 :description)))
9531 (error
9532 ;; Probably before first headline, link only to file
9533 (concat "file:"
9534 (abbreviate-file-name
9535 (buffer-file-name (buffer-base-buffer))))))))
9537 ;; Just link to current headline
9538 (setq cpltxt (concat "file:"
9539 (abbreviate-file-name
9540 (buffer-file-name (buffer-base-buffer)))))
9541 ;; Add a context search string
9542 (when (org-xor org-context-in-file-links arg)
9543 (let* ((ee (org-element-at-point))
9544 (et (org-element-type ee))
9545 (ev (plist-get (cadr ee) :value))
9546 (ek (plist-get (cadr ee) :key))
9547 (eok (and (stringp ek) (string-match "name" ek))))
9548 (setq txt (cond
9549 ((org-at-heading-p) nil)
9550 ((and (eq et 'keyword) eok) ev)
9551 ((org-region-active-p)
9552 (buffer-substring (region-beginning) (region-end)))))
9553 (when (or (null txt) (string-match "\\S-" txt))
9554 (setq cpltxt
9555 (concat cpltxt "::"
9556 (condition-case nil
9557 (org-make-org-heading-search-string txt)
9558 (error "")))
9559 desc (or (and (eq et 'keyword) eok ev)
9560 (nth 4 (ignore-errors (org-heading-components)))
9561 "NONE")))))
9562 (if (string-match "::\\'" cpltxt)
9563 (setq cpltxt (substring cpltxt 0 -2)))
9564 (setq link cpltxt))))
9566 ((buffer-file-name (buffer-base-buffer))
9567 ;; Just link to this file here.
9568 (setq cpltxt (concat "file:"
9569 (abbreviate-file-name
9570 (buffer-file-name (buffer-base-buffer)))))
9571 ;; Add a context string.
9572 (when (org-xor org-context-in-file-links arg)
9573 (setq txt (if (org-region-active-p)
9574 (buffer-substring (region-beginning) (region-end))
9575 (buffer-substring (point-at-bol) (point-at-eol))))
9576 ;; Only use search option if there is some text.
9577 (when (string-match "\\S-" txt)
9578 (setq cpltxt
9579 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9580 desc "NONE")))
9581 (setq link cpltxt))
9583 ((org-called-interactively-p 'interactive)
9584 (user-error "No method for storing a link from this buffer"))
9586 (t (setq link nil)))
9588 ;; We're done setting link and desc, clean up
9589 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9590 (setq link (or link cpltxt)
9591 desc (or desc cpltxt))
9592 (cond ((equal desc "NONE") (setq desc nil))
9593 ((string-match org-bracket-link-analytic-regexp desc)
9594 (let ((d0 (match-string 3 desc))
9595 (p0 (match-string 5 desc)))
9596 (setq desc
9597 (replace-regexp-in-string
9598 org-bracket-link-regexp
9599 (concat (or p0 d0)
9600 (if (equal (length (match-string 0 desc))
9601 (length desc)) "*" "")) desc)))))
9603 ;; Return the link
9604 (if (not (and (or (org-called-interactively-p 'any)
9605 executing-kbd-macro) link))
9606 (or agenda-link (and link (org-make-link-string link desc)))
9607 (push (list link desc) org-stored-links)
9608 (message "Stored: %s" (or desc link))
9609 (when custom-id
9610 (setq link (concat "file:" (abbreviate-file-name
9611 (buffer-file-name)) "::#" custom-id))
9612 (push (list link desc) org-stored-links))
9613 (car org-stored-links))))))
9615 (defun org-store-link-props (&rest plist)
9616 "Store link properties, extract names and addresses."
9617 (let (x adr)
9618 (when (setq x (plist-get plist :from))
9619 (setq adr (mail-extract-address-components x))
9620 (setq plist (plist-put plist :fromname (car adr)))
9621 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9622 (when (setq x (plist-get plist :to))
9623 (setq adr (mail-extract-address-components x))
9624 (setq plist (plist-put plist :toname (car adr)))
9625 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9626 (let ((from (plist-get plist :from))
9627 (to (plist-get plist :to)))
9628 (when (and from to org-from-is-user-regexp)
9629 (setq plist
9630 (plist-put plist :fromto
9631 (if (string-match org-from-is-user-regexp from)
9632 (concat "to %t")
9633 (concat "from %f"))))))
9634 (setq org-store-link-plist plist))
9636 (defun org-add-link-props (&rest plist)
9637 "Add these properties to the link property list."
9638 (let (key value)
9639 (while plist
9640 (setq key (pop plist) value (pop plist))
9641 (setq org-store-link-plist
9642 (plist-put org-store-link-plist key value)))))
9644 (defun org-email-link-description (&optional fmt)
9645 "Return the description part of an email link.
9646 This takes information from `org-store-link-plist' and formats it
9647 according to FMT (default from `org-email-link-description-format')."
9648 (setq fmt (or fmt org-email-link-description-format))
9649 (let* ((p org-store-link-plist)
9650 (to (plist-get p :toaddress))
9651 (from (plist-get p :fromaddress))
9652 (table
9653 (list
9654 (cons "%c" (plist-get p :fromto))
9655 (cons "%F" (plist-get p :from))
9656 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9657 (cons "%T" (plist-get p :to))
9658 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9659 (cons "%s" (plist-get p :subject))
9660 (cons "%d" (plist-get p :date))
9661 (cons "%m" (plist-get p :message-id)))))
9662 (when (string-match "%c" fmt)
9663 ;; Check if the user wrote this message
9664 (if (and org-from-is-user-regexp from to
9665 (save-match-data (string-match org-from-is-user-regexp from)))
9666 (setq fmt (replace-match "to %t" t t fmt))
9667 (setq fmt (replace-match "from %f" t t fmt))))
9668 (org-replace-escapes fmt table)))
9670 (defun org-make-org-heading-search-string (&optional string)
9671 "Make search string for the current headline or STRING."
9672 (let ((s (or string
9673 (and (derived-mode-p 'org-mode)
9674 (save-excursion
9675 (org-back-to-heading t)
9676 (org-element-property :raw-value (org-element-at-point))))))
9677 (lines org-context-in-file-links))
9678 (or string (setq s (concat "*" s))) ; Add * for headlines
9679 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9680 (when (and string (integerp lines) (> lines 0))
9681 (let ((slines (org-split-string s "\n")))
9682 (when (< lines (length slines))
9683 (setq s (mapconcat
9684 'identity
9685 (reverse (nthcdr (- (length slines) lines)
9686 (reverse slines))) "\n")))))
9687 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9689 (defun org-make-link-string (link &optional description)
9690 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9691 (unless (string-match "\\S-" link)
9692 (error "Empty link"))
9693 (when (and description
9694 (stringp description)
9695 (not (string-match "\\S-" description)))
9696 (setq description nil))
9697 (when (stringp description)
9698 ;; Remove brackets from the description, they are fatal.
9699 (while (string-match "\\[" description)
9700 (setq description (replace-match "{" t t description)))
9701 (while (string-match "\\]" description)
9702 (setq description (replace-match "}" t t description))))
9703 (when (equal link description)
9704 ;; No description needed, it is identical
9705 (setq description nil))
9706 (when (and (not description)
9707 (not (string-match (org-image-file-name-regexp) link))
9708 (not (equal link (org-link-escape link))))
9709 (setq description (org-extract-attributes link)))
9710 (setq link
9711 (cond ((string-match (org-image-file-name-regexp) link) link)
9712 ((string-match org-link-types-re link)
9713 (concat (match-string 1 link)
9714 (org-link-escape (substring link (match-end 1)))))
9715 (t (org-link-escape link))))
9716 (concat "[[" link "]"
9717 (if description (concat "[" description "]") "")
9718 "]"))
9720 (defconst org-link-escape-chars
9721 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9722 "List of characters that should be escaped in link.
9723 This is the list that is used for internal purposes.")
9725 (defconst org-link-escape-chars-browser
9726 '(?\ ?\")
9727 "List of escapes for characters that are problematic in links.
9728 This is the list that is used before handing over to the browser.")
9730 (defun org-link-escape (text &optional table merge)
9731 "Return percent escaped representation of TEXT.
9732 TEXT is a string with the text to escape.
9733 Optional argument TABLE is a list with characters that should be
9734 escaped. When nil, `org-link-escape-chars' is used.
9735 If optional argument MERGE is set, merge TABLE into
9736 `org-link-escape-chars'."
9737 (cond
9738 ((and table merge)
9739 (mapc (lambda (defchr)
9740 (unless (member defchr table)
9741 (setq table (cons defchr table)))) org-link-escape-chars))
9742 ((null table)
9743 (setq table org-link-escape-chars)))
9744 (mapconcat
9745 (lambda (char)
9746 (if (or (member char table)
9747 (and (or (< char 32) (= char 37) (> char 126))
9748 org-url-hexify-p))
9749 (mapconcat (lambda (sequence-element)
9750 (format "%%%.2X" sequence-element))
9751 (or (encode-coding-char char 'utf-8)
9752 (error "Unable to percent escape character: %s"
9753 (char-to-string char))) "")
9754 (char-to-string char))) text ""))
9756 (defun org-link-unescape (str)
9757 "Unhex hexified Unicode strings as returned from the JavaScript function
9758 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9759 (unless (and (null str) (string= "" str))
9760 (let ((pos 0) (case-fold-search t) unhexed)
9761 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
9762 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9763 (setq str (replace-match unhexed t t str))
9764 (setq pos (+ pos (length unhexed))))))
9765 str)
9767 (defun org-link-unescape-compound (hex)
9768 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9769 Note: this function also decodes single byte encodings like
9770 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9771 (save-match-data
9772 (let* ((bytes (cdr (split-string hex "%")))
9773 (ret "")
9774 (eat 0)
9775 (sum 0))
9776 (while bytes
9777 (let* ((val (string-to-number (pop bytes) 16))
9778 (shift-xor
9779 (if (= 0 eat)
9780 (cond
9781 ((>= val 252) (cons 6 252))
9782 ((>= val 248) (cons 5 248))
9783 ((>= val 240) (cons 4 240))
9784 ((>= val 224) (cons 3 224))
9785 ((>= val 192) (cons 2 192))
9786 (t (cons 0 0)))
9787 (cons 6 128))))
9788 (if (>= val 192) (setq eat (car shift-xor)))
9789 (setq val (logxor val (cdr shift-xor)))
9790 (setq sum (+ (lsh sum (car shift-xor)) val))
9791 (if (> eat 0) (setq eat (- eat 1)))
9792 (cond
9793 ((= 0 eat) ;multi byte
9794 (setq ret (concat ret (org-char-to-string sum)))
9795 (setq sum 0))
9796 ((not bytes) ; single byte(s)
9797 (setq ret (org-link-unescape-single-byte-sequence hex))))
9798 )) ;; end (while bytes
9799 ret )))
9801 (defun org-link-unescape-single-byte-sequence (hex)
9802 "Unhexify hex-encoded single byte character sequences."
9803 (mapconcat (lambda (byte)
9804 (char-to-string (string-to-number byte 16)))
9805 (cdr (split-string hex "%")) ""))
9807 (defun org-xor (a b)
9808 "Exclusive or."
9809 (if a (not b) b))
9811 (defun org-fixup-message-id-for-http (s)
9812 "Replace special characters in a message id, so it can be used in an http query."
9813 (when (string-match "%" s)
9814 (setq s (mapconcat (lambda (c)
9815 (if (eq c ?%)
9816 "%25"
9817 (char-to-string c)))
9818 s "")))
9819 (while (string-match "<" s)
9820 (setq s (replace-match "%3C" t t s)))
9821 (while (string-match ">" s)
9822 (setq s (replace-match "%3E" t t s)))
9823 (while (string-match "@" s)
9824 (setq s (replace-match "%40" t t s)))
9827 (defun org-link-prettify (link)
9828 "Return a human-readable representation of LINK.
9829 The car of LINK must be a raw link the cdr of LINK must be either
9830 a link description or nil."
9831 (let ((desc (or (cadr link) "<no description>")))
9832 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9833 "<" (car link) ">")))
9835 ;;;###autoload
9836 (defun org-insert-link-global ()
9837 "Insert a link like Org-mode does.
9838 This command can be called in any mode to insert a link in Org-mode syntax."
9839 (interactive)
9840 (org-load-modules-maybe)
9841 (org-run-like-in-org-mode 'org-insert-link))
9843 (defun org-insert-all-links (&optional keep)
9844 "Insert all links in `org-stored-links'."
9845 (interactive "P")
9846 (let ((links (copy-sequence org-stored-links)) l)
9847 (while (setq l (if keep (pop links) (pop org-stored-links)))
9848 (insert "- ")
9849 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9850 (insert "\n"))))
9852 (defun org-link-fontify-links-to-this-file ()
9853 "Fontify links to the current file in `org-stored-links'."
9854 (let ((f (buffer-file-name)) a b)
9855 (setq a (mapcar (lambda(l)
9856 (let ((ll (car l)))
9857 (when (and (string-match "^file:\\(.+\\)::" ll)
9858 (equal f (expand-file-name (match-string 1 ll))))
9859 ll)))
9860 org-stored-links))
9861 (when (featurep 'org-id)
9862 (setq b (mapcar (lambda(l)
9863 (let ((ll (car l)))
9864 (when (and (string-match "^id:\\(.+\\)$" ll)
9865 (equal f (expand-file-name
9866 (or (org-id-find-id-file
9867 (match-string 1 ll)) ""))))
9868 ll)))
9869 org-stored-links)))
9870 (mapcar (lambda(l)
9871 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9872 (delq nil (append a b)))))
9874 (defvar org-link-links-in-this-file nil)
9875 (defun org-insert-link (&optional complete-file link-location default-description)
9876 "Insert a link. At the prompt, enter the link.
9878 Completion can be used to insert any of the link protocol prefixes like
9879 http or ftp in use.
9881 The history can be used to select a link previously stored with
9882 `org-store-link'. When the empty string is entered (i.e. if you just
9883 press RET at the prompt), the link defaults to the most recently
9884 stored link. As SPC triggers completion in the minibuffer, you need to
9885 use M-SPC or C-q SPC to force the insertion of a space character.
9887 You will also be prompted for a description, and if one is given, it will
9888 be displayed in the buffer instead of the link.
9890 If there is already a link at point, this command will allow you to edit link
9891 and description parts.
9893 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
9894 be selected using completion. The path to the file will be relative to the
9895 current directory if the file is in the current directory or a subdirectory.
9896 Otherwise, the link will be the absolute path as completed in the minibuffer
9897 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9898 option `org-link-file-path-type'.
9900 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
9901 the current directory or below.
9903 With three \\[universal-argument] prefixes, negate the meaning of
9904 `org-keep-stored-link-after-insertion'.
9906 If `org-make-link-description-function' is non-nil, this function will be
9907 called with the link target, and the result will be the default
9908 link description.
9910 If the LINK-LOCATION parameter is non-nil, this value will be
9911 used as the link location instead of reading one interactively.
9913 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9914 be used as the default description."
9915 (interactive "P")
9916 (let* ((wcf (current-window-configuration))
9917 (origbuf (current-buffer))
9918 (region (if (org-region-active-p)
9919 (buffer-substring (region-beginning) (region-end))))
9920 (remove (and region (list (region-beginning) (region-end))))
9921 (desc region)
9922 tmphist ; byte-compile incorrectly complains about this
9923 (link link-location)
9924 (abbrevs org-link-abbrev-alist-local)
9925 entry file all-prefixes auto-desc)
9926 (cond
9927 (link-location) ; specified by arg, just use it.
9928 ((org-in-regexp org-bracket-link-regexp 1)
9929 ;; We do have a link at point, and we are going to edit it.
9930 (setq remove (list (match-beginning 0) (match-end 0)))
9931 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9932 (setq link (read-string "Link: "
9933 (org-link-unescape
9934 (org-match-string-no-properties 1)))))
9935 ((or (org-in-regexp org-angle-link-re)
9936 (org-in-regexp org-plain-link-re))
9937 ;; Convert to bracket link
9938 (setq remove (list (match-beginning 0) (match-end 0))
9939 link (read-string "Link: "
9940 (org-remove-angle-brackets (match-string 0)))))
9941 ((member complete-file '((4) (16)))
9942 ;; Completing read for file names.
9943 (setq link (org-file-complete-link complete-file)))
9945 ;; Read link, with completion for stored links.
9946 (org-link-fontify-links-to-this-file)
9947 (org-switch-to-buffer-other-window "*Org Links*")
9948 (with-current-buffer "*Org Links*"
9949 (erase-buffer)
9950 (insert "Insert a link.
9951 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
9952 (when org-stored-links
9953 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
9954 (insert (mapconcat 'org-link-prettify
9955 (reverse org-stored-links) "\n")))
9956 (goto-char (point-min)))
9957 (let ((cw (selected-window)))
9958 (select-window (get-buffer-window "*Org Links*" 'visible))
9959 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9960 (unless (pos-visible-in-window-p (point-max))
9961 (org-fit-window-to-buffer))
9962 (and (window-live-p cw) (select-window cw)))
9963 ;; Fake a link history, containing the stored links.
9964 (setq tmphist (append (mapcar 'car org-stored-links)
9965 org-insert-link-history))
9966 (setq all-prefixes (append (mapcar 'car abbrevs)
9967 (mapcar 'car org-link-abbrev-alist)
9968 org-link-types))
9969 (unwind-protect
9970 (progn
9971 (setq link
9972 (org-completing-read
9973 "Link: "
9974 (append
9975 (mapcar (lambda (x) (concat x ":"))
9976 all-prefixes)
9977 (mapcar 'car org-stored-links))
9978 nil nil nil
9979 'tmphist
9980 (caar org-stored-links)))
9981 (if (not (string-match "\\S-" link))
9982 (user-error "No link selected"))
9983 (mapc (lambda(l)
9984 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9985 org-stored-links)
9986 (if (or (member link all-prefixes)
9987 (and (equal ":" (substring link -1))
9988 (member (substring link 0 -1) all-prefixes)
9989 (setq link (substring link 0 -1))))
9990 (setq link (with-current-buffer origbuf
9991 (org-link-try-special-completion link)))))
9992 (set-window-configuration wcf)
9993 (kill-buffer "*Org Links*"))
9994 (setq entry (assoc link org-stored-links))
9995 (or entry (push link org-insert-link-history))
9996 (setq desc (or desc (nth 1 entry)))))
9998 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9999 (not org-keep-stored-link-after-insertion))
10000 (setq org-stored-links (delq (assoc link org-stored-links)
10001 org-stored-links)))
10003 (if (and (string-match org-plain-link-re link)
10004 (not (string-match org-ts-regexp link)))
10005 ;; URL-like link, normalize the use of angular brackets.
10006 (setq link (org-remove-angle-brackets link)))
10008 ;; Check if we are linking to the current file with a search
10009 ;; option If yes, simplify the link by using only the search
10010 ;; option.
10011 (when (and buffer-file-name
10012 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10013 (let* ((path (match-string 1 link))
10014 (case-fold-search nil)
10015 (search (match-string 2 link)))
10016 (save-match-data
10017 (if (equal (file-truename buffer-file-name) (file-truename path))
10018 ;; We are linking to this same file, with a search option
10019 (setq link search)))))
10021 ;; Check if we can/should use a relative path. If yes, simplify the link
10022 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10023 (let* ((type (match-string 1 link))
10024 (path (match-string 2 link))
10025 (origpath path)
10026 (case-fold-search nil))
10027 (cond
10028 ((or (eq org-link-file-path-type 'absolute)
10029 (equal complete-file '(16)))
10030 (setq path (abbreviate-file-name (expand-file-name path))))
10031 ((eq org-link-file-path-type 'noabbrev)
10032 (setq path (expand-file-name path)))
10033 ((eq org-link-file-path-type 'relative)
10034 (setq path (file-relative-name path)))
10036 (save-match-data
10037 (if (string-match (concat "^" (regexp-quote
10038 (expand-file-name
10039 (file-name-as-directory
10040 default-directory))))
10041 (expand-file-name path))
10042 ;; We are linking a file with relative path name.
10043 (setq path (substring (expand-file-name path)
10044 (match-end 0)))
10045 (setq path (abbreviate-file-name (expand-file-name path)))))))
10046 (setq link (concat type path))
10047 (if (equal desc origpath)
10048 (setq desc path))))
10050 (if org-make-link-description-function
10051 (setq desc
10052 (or (condition-case nil
10053 (funcall org-make-link-description-function link desc)
10054 (error (progn (message "Can't get link description from `%s'"
10055 (symbol-name org-make-link-description-function))
10056 (sit-for 2) nil)))
10057 (read-string "Description: " default-description)))
10058 (if default-description (setq desc default-description)
10059 (setq desc (or (and auto-desc desc)
10060 (read-string "Description: " desc)))))
10062 (unless (string-match "\\S-" desc) (setq desc nil))
10063 (if remove (apply 'delete-region remove))
10064 (insert (org-make-link-string link desc))))
10066 (defun org-link-try-special-completion (type)
10067 "If there is completion support for link type TYPE, offer it."
10068 (let ((fun (intern (concat "org-" type "-complete-link"))))
10069 (if (functionp fun)
10070 (funcall fun)
10071 (read-string "Link (no completion support): " (concat type ":")))))
10073 (defun org-file-complete-link (&optional arg)
10074 "Create a file link using completion."
10075 (let (file link)
10076 (setq file (org-iread-file-name "File: "))
10077 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10078 (pwd1 (file-name-as-directory (abbreviate-file-name
10079 (expand-file-name ".")))))
10080 (cond
10081 ((equal arg '(16))
10082 (setq link (concat
10083 "file:"
10084 (abbreviate-file-name (expand-file-name file)))))
10085 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10086 (setq link (concat "file:" (match-string 1 file))))
10087 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10088 (expand-file-name file))
10089 (setq link (concat
10090 "file:" (match-string 1 (expand-file-name file)))))
10091 (t (setq link (concat "file:" file)))))
10092 link))
10094 (defun org-iread-file-name (&rest args)
10095 "Read-file-name using `ido-mode' speedup if available.
10096 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10097 See `read-file-name' for a description of parameters."
10098 (org-without-partial-completion
10099 (if (and org-completion-use-ido
10100 (fboundp 'ido-read-file-name)
10101 (boundp 'ido-mode) ido-mode
10102 (listp (second args)))
10103 (let ((ido-enter-matching-directory nil))
10104 (apply 'ido-read-file-name args))
10105 (apply 'read-file-name args))))
10107 (defun org-completing-read (&rest args)
10108 "Completing-read with SPACE being a normal character."
10109 (let ((enable-recursive-minibuffers t)
10110 (minibuffer-local-completion-map
10111 (copy-keymap minibuffer-local-completion-map)))
10112 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10113 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10114 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10115 (apply 'org-icompleting-read args)))
10117 (defun org-completing-read-no-i (&rest args)
10118 (let (org-completion-use-ido org-completion-use-iswitchb)
10119 (apply 'org-completing-read args)))
10121 (defun org-iswitchb-completing-read (prompt choices &rest args)
10122 "Use iswitch as a completing-read replacement to choose from choices.
10123 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10124 from."
10125 (let* ((iswitchb-use-virtual-buffers nil)
10126 (iswitchb-make-buflist-hook
10127 (lambda ()
10128 (setq iswitchb-temp-buflist choices))))
10129 (iswitchb-read-buffer prompt)))
10131 (defun org-icompleting-read (&rest args)
10132 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10133 (org-without-partial-completion
10134 (if (and org-completion-use-ido
10135 (fboundp 'ido-completing-read)
10136 (boundp 'ido-mode) ido-mode
10137 (listp (second args)))
10138 (let ((ido-enter-matching-directory nil))
10139 (apply 'ido-completing-read (concat (car args))
10140 (if (consp (car (nth 1 args)))
10141 (mapcar 'car (nth 1 args))
10142 (nth 1 args))
10143 (cddr args)))
10144 (if (and org-completion-use-iswitchb
10145 (boundp 'iswitchb-mode) iswitchb-mode
10146 (listp (second args)))
10147 (apply 'org-iswitchb-completing-read (concat (car args))
10148 (if (consp (car (nth 1 args)))
10149 (mapcar 'car (nth 1 args))
10150 (nth 1 args))
10151 (cddr args))
10152 (apply 'completing-read args)))))
10154 (defun org-extract-attributes (s)
10155 "Extract the attributes cookie from a string and set as text property."
10156 (let (a attr (start 0) key value)
10157 (save-match-data
10158 (when (string-match "{{\\([^}]+\\)}}$" s)
10159 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10160 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10161 (setq key (match-string 1 a) value (match-string 2 a)
10162 start (match-end 0)
10163 attr (plist-put attr (intern key) value))))
10164 (org-add-props s nil 'org-attr attr))
10167 ;;; Opening/following a link
10169 (defvar org-link-search-failed nil)
10171 (defvar org-open-link-functions nil
10172 "Hook for functions finding a plain text link.
10173 These functions must take a single argument, the link content.
10174 They will be called for links that look like [[link text][description]]
10175 when LINK TEXT does not have a protocol like \"http:\" and does not look
10176 like a filename (e.g. \"./blue.png\").
10178 These functions will be called *before* Org attempts to resolve the
10179 link by doing text searches in the current buffer - so if you want a
10180 link \"[[target]]\" to still find \"<<target>>\", your function should
10181 handle this as a special case.
10183 When the function does handle the link, it must return a non-nil value.
10184 If it decides that it is not responsible for this link, it must return
10185 nil to indicate that that Org-mode can continue with other options
10186 like exact and fuzzy text search.")
10188 (defun org-next-link (&optional search-backward)
10189 "Move forward to the next link.
10190 If the link is in hidden text, expose it."
10191 (interactive "P")
10192 (when (and org-link-search-failed (eq this-command last-command))
10193 (goto-char (point-min))
10194 (message "Link search wrapped back to beginning of buffer"))
10195 (setq org-link-search-failed nil)
10196 (let* ((pos (point))
10197 (ct (org-context))
10198 (a (assoc :link ct))
10199 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10200 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10201 ((looking-at org-any-link-re)
10202 ;; Don't stay stuck at link without an org-link face
10203 (forward-char (if search-backward -1 1))))
10204 (if (funcall srch-fun org-any-link-re nil t)
10205 (progn
10206 (goto-char (match-beginning 0))
10207 (if (outline-invisible-p) (org-show-context)))
10208 (goto-char pos)
10209 (setq org-link-search-failed t)
10210 (message "No further link found"))))
10212 (defun org-previous-link ()
10213 "Move backward to the previous link.
10214 If the link is in hidden text, expose it."
10215 (interactive)
10216 (funcall 'org-next-link t))
10218 (defun org-translate-link (s)
10219 "Translate a link string if a translation function has been defined."
10220 (if (and org-link-translation-function
10221 (fboundp org-link-translation-function)
10222 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10223 (progn
10224 (setq s (funcall org-link-translation-function
10225 (match-string 1 s) (match-string 2 s)))
10226 (concat (car s) ":" (cdr s)))
10229 (defun org-translate-link-from-planner (type path)
10230 "Translate a link from Emacs Planner syntax so that Org can follow it.
10231 This is still an experimental function, your mileage may vary."
10232 (cond
10233 ((member type '("http" "https" "news" "ftp"))
10234 ;; standard Internet links are the same.
10235 nil)
10236 ((and (equal type "irc") (string-match "^//" path))
10237 ;; Planner has two / at the beginning of an irc link, we have 1.
10238 ;; We should have zero, actually....
10239 (setq path (substring path 1)))
10240 ((and (equal type "lisp") (string-match "^/" path))
10241 ;; Planner has a slash, we do not.
10242 (setq type "elisp" path (substring path 1)))
10243 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10244 ;; A typical message link. Planner has the id after the final slash,
10245 ;; we separate it with a hash mark
10246 (setq path (concat (match-string 1 path) "#"
10247 (org-remove-angle-brackets (match-string 2 path))))))
10248 (cons type path))
10250 (defun org-find-file-at-mouse (ev)
10251 "Open file link or URL at mouse."
10252 (interactive "e")
10253 (mouse-set-point ev)
10254 (org-open-at-point 'in-emacs))
10256 (defun org-open-at-mouse (ev)
10257 "Open file link or URL at mouse.
10258 See the docstring of `org-open-file' for details."
10259 (interactive "e")
10260 (mouse-set-point ev)
10261 (if (eq major-mode 'org-agenda-mode)
10262 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10263 (org-open-at-point))
10265 (defvar org-window-config-before-follow-link nil
10266 "The window configuration before following a link.
10267 This is saved in case the need arises to restore it.")
10269 (defvar org-open-link-marker (make-marker)
10270 "Marker pointing to the location where `org-open-at-point; was called.")
10272 ;;;###autoload
10273 (defun org-open-at-point-global ()
10274 "Follow a link like Org-mode does.
10275 This command can be called in any mode to follow a link that has
10276 Org-mode syntax."
10277 (interactive)
10278 (org-run-like-in-org-mode 'org-open-at-point))
10280 ;;;###autoload
10281 (defun org-open-link-from-string (s &optional arg reference-buffer)
10282 "Open a link in the string S, as if it was in Org-mode."
10283 (interactive "sLink: \nP")
10284 (let ((reference-buffer (or reference-buffer (current-buffer))))
10285 (with-temp-buffer
10286 (let ((org-inhibit-startup (not reference-buffer)))
10287 (org-mode)
10288 (insert s)
10289 (goto-char (point-min))
10290 (when reference-buffer
10291 (setq org-link-abbrev-alist-local
10292 (with-current-buffer reference-buffer
10293 org-link-abbrev-alist-local)))
10294 (org-open-at-point arg reference-buffer)))))
10296 (defvar org-open-at-point-functions nil
10297 "Hook that is run when following a link at point.
10299 Functions in this hook must return t if they identify and follow
10300 a link at point. If they don't find anything interesting at point,
10301 they must return nil.")
10303 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10304 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10305 (defun org-open-at-point (&optional arg reference-buffer)
10306 "Open link at or after point.
10307 If there is no link at point, this function will search forward up to
10308 the end of the current line.
10309 Normally, files will be opened by an appropriate application. If the
10310 optional prefix argument ARG is non-nil, Emacs will visit the file.
10311 With a double prefix argument, try to open outside of Emacs, in the
10312 application the system uses for this file type."
10313 (interactive "P")
10314 ;; if in a code block, then open the block's results
10315 (unless (call-interactively #'org-babel-open-src-block-result)
10316 (org-load-modules-maybe)
10317 (move-marker org-open-link-marker (point))
10318 (setq org-window-config-before-follow-link (current-window-configuration))
10319 (org-remove-occur-highlights nil nil t)
10320 (cond
10321 ((and (org-at-heading-p)
10322 (not (org-at-timestamp-p t))
10323 (not (org-in-regexp
10324 (concat org-plain-link-re "\\|"
10325 org-bracket-link-regexp "\\|"
10326 org-angle-link-re "\\|"
10327 "[ \t]:[^ \t\n]+:[ \t]*$")))
10328 (not (get-text-property (point) 'org-linked-text)))
10329 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10330 (lk0 (car lkall))
10331 (lk (if (stringp lk0) (list lk0) lk0))
10332 (lkend (cdr lkall)))
10333 (mapcar (lambda(l)
10334 (search-forward l nil lkend)
10335 (goto-char (match-beginning 0))
10336 (org-open-at-point))
10337 lk))
10338 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10339 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10340 ((and (org-at-timestamp-p t)
10341 (not (org-in-regexp org-bracket-link-regexp)))
10342 (org-follow-timestamp-link))
10343 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10344 (not (org-in-regexp org-any-link-re)))
10345 (org-footnote-action))
10347 (let (type path link line search (pos (point)))
10348 (catch 'match
10349 (save-excursion
10350 (skip-chars-forward "^]\n\r")
10351 (when (org-in-regexp org-bracket-link-regexp 1)
10352 (setq link (org-extract-attributes
10353 (org-link-unescape (org-match-string-no-properties 1))))
10354 (while (string-match " *\n *" link)
10355 (setq link (replace-match " " t t link)))
10356 (setq link (org-link-expand-abbrev link))
10357 (cond
10358 ((or (file-name-absolute-p link)
10359 (string-match "^\\.\\.?/" link))
10360 (setq type "file" path link))
10361 ((string-match org-link-re-with-space3 link)
10362 (setq type (match-string 1 link) path (match-string 2 link)))
10363 ((string-match "^help:+\\(.+\\)" link)
10364 (setq type "help" path (match-string 1 link)))
10365 (t (setq type "thisfile" path link)))
10366 (throw 'match t)))
10368 (when (get-text-property (point) 'org-linked-text)
10369 (setq type "thisfile"
10370 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10371 (1+ (point)) (point))
10372 path (buffer-substring
10373 (or (previous-single-property-change pos 'org-linked-text)
10374 (point-min))
10375 (or (next-single-property-change pos 'org-linked-text)
10376 (point-max)))
10377 ;; Ensure we will search for a <<<radio>>> link, not
10378 ;; a simple reference like <<ref>>
10379 path (concat "<" path))
10380 (throw 'match t))
10382 (save-excursion
10383 (when (or (org-in-regexp org-angle-link-re)
10384 (let ((match (org-in-regexp org-plain-link-re)))
10385 ;; Check a plain link is not within a bracket link
10386 (and match
10387 (save-excursion
10388 (progn
10389 (goto-char (car match))
10390 (not (org-in-regexp org-bracket-link-regexp))))))
10391 (let ((line_ending (save-excursion (end-of-line) (point))))
10392 ;; We are in a line before a plain or bracket link
10393 (or (re-search-forward org-plain-link-re line_ending t)
10394 (re-search-forward org-bracket-link-regexp line_ending t))))
10395 (setq type (match-string 1)
10396 path (org-link-unescape (match-string 2)))
10397 (throw 'match t)))
10398 (save-excursion
10399 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
10400 (setq type "tags"
10401 path (match-string 1))
10402 (while (string-match ":" path)
10403 (setq path (replace-match "+" t t path)))
10404 (throw 'match t)))
10405 (when (org-in-regexp "<\\([^><\n]+\\)>")
10406 (setq type "tree-match"
10407 path (match-string 1))
10408 (throw 'match t)))
10409 (unless path
10410 (user-error "No link found"))
10412 ;; switch back to reference buffer
10413 ;; needed when if called in a temporary buffer through
10414 ;; org-open-link-from-string
10415 (with-current-buffer (or reference-buffer (current-buffer))
10417 ;; Remove any trailing spaces in path
10418 (if (string-match " +\\'" path)
10419 (setq path (replace-match "" t t path)))
10420 (if (and org-link-translation-function
10421 (fboundp org-link-translation-function))
10422 ;; Check if we need to translate the link
10423 (let ((tmp (funcall org-link-translation-function type path)))
10424 (setq type (car tmp) path (cdr tmp))))
10426 (cond
10428 ((assoc type org-link-protocols)
10429 (funcall (nth 1 (assoc type org-link-protocols)) path))
10431 ((equal type "help")
10432 (let ((f-or-v (intern path)))
10433 (cond ((fboundp f-or-v)
10434 (describe-function f-or-v))
10435 ((boundp f-or-v)
10436 (describe-variable f-or-v))
10437 (t (error "Not a known function or variable")))))
10439 ((equal type "mailto")
10440 (let ((cmd (car org-link-mailto-program))
10441 (args (cdr org-link-mailto-program)) args1
10442 (address path) (subject "") a)
10443 (if (string-match "\\(.*\\)::\\(.*\\)" path)
10444 (setq address (match-string 1 path)
10445 subject (org-link-escape (match-string 2 path))))
10446 (while args
10447 (cond
10448 ((not (stringp (car args))) (push (pop args) args1))
10449 (t (setq a (pop args))
10450 (if (string-match "%a" a)
10451 (setq a (replace-match address t t a)))
10452 (if (string-match "%s" a)
10453 (setq a (replace-match subject t t a)))
10454 (push a args1))))
10455 (apply cmd (nreverse args1))))
10457 ((member type '("http" "https" "ftp" "news"))
10458 (browse-url
10459 (concat type ":"
10460 (if (org-string-match-p
10461 (concat "[[:nonascii:]"
10462 org-link-escape-chars-browser "]")
10463 path)
10464 (org-link-escape path org-link-escape-chars-browser)
10465 path))))
10467 ((string= type "doi")
10468 (browse-url
10469 (concat org-doi-server-url
10470 (if (org-string-match-p
10471 (concat "[[:nonascii:]"
10472 org-link-escape-chars-browser "]")
10473 path)
10474 (org-link-escape path org-link-escape-chars-browser)
10475 path))))
10477 ((member type '("message"))
10478 (browse-url (concat type ":" path)))
10480 ((string= type "tags")
10481 (org-tags-view arg path))
10483 ((string= type "tree-match")
10484 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
10486 ((string= type "file")
10487 (if (string-match "::\\([0-9]+\\)\\'" path)
10488 (setq line (string-to-number (match-string 1 path))
10489 path (substring path 0 (match-beginning 0)))
10490 (if (string-match "::\\(.+\\)\\'" path)
10491 (setq search (match-string 1 path)
10492 path (substring path 0 (match-beginning 0)))))
10493 (if (string-match "[*?{]" (file-name-nondirectory path))
10494 (dired path)
10495 (org-open-file path arg line search)))
10497 ((string= type "shell")
10498 (let ((buf (generate-new-buffer "*Org Shell Output"))
10499 (cmd path))
10500 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10501 (string-match org-confirm-shell-link-not-regexp cmd))
10502 (not org-confirm-shell-link-function)
10503 (funcall org-confirm-shell-link-function
10504 (format "Execute \"%s\" in shell? "
10505 (org-add-props cmd nil
10506 'face 'org-warning))))
10507 (progn
10508 (message "Executing %s" cmd)
10509 (shell-command cmd buf)
10510 (if (featurep 'midnight)
10511 (setq clean-buffer-list-kill-buffer-names
10512 (cons buf clean-buffer-list-kill-buffer-names))))
10513 (error "Abort"))))
10515 ((string= type "elisp")
10516 (let ((cmd path))
10517 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10518 (string-match org-confirm-elisp-link-not-regexp cmd))
10519 (not org-confirm-elisp-link-function)
10520 (funcall org-confirm-elisp-link-function
10521 (format "Execute \"%s\" as elisp? "
10522 (org-add-props cmd nil
10523 'face 'org-warning))))
10524 (message "%s => %s" cmd
10525 (if (equal (string-to-char cmd) ?\()
10526 (eval (read cmd))
10527 (call-interactively (read cmd))))
10528 (error "Abort"))))
10530 ((and (string= type "thisfile")
10531 (or (run-hook-with-args-until-success
10532 'org-open-link-functions path)
10533 (and link
10534 (string-match "^id:" link)
10535 (or (featurep 'org-id) (require 'org-id))
10536 (progn
10537 (funcall (nth 1 (assoc "id" org-link-protocols))
10538 (substring path 3))
10539 t)))))
10541 ((string= type "thisfile")
10542 (if arg
10543 (switch-to-buffer-other-window
10544 (org-get-buffer-for-internal-link (current-buffer)))
10545 (org-mark-ring-push))
10546 (let ((cmd `(org-link-search
10547 ,path
10548 ,(cond ((equal arg '(4)) ''occur)
10549 ((equal arg '(16)) ''org-occur))
10550 ,pos)))
10551 (condition-case nil (let ((org-link-search-inhibit-query t))
10552 (eval cmd))
10553 (error (progn (widen) (eval cmd))))))
10555 (t (browse-url-at-point)))))))
10556 (move-marker org-open-link-marker nil)
10557 (run-hook-with-args 'org-follow-link-hook)))
10559 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10560 "Offer links in the current entry and return the selected link.
10561 If there is only one link, return it.
10562 If NTH is an integer, return the NTH link found.
10563 If ZERO is a string, check also this string for a link, and if
10564 there is one, return it."
10565 (with-current-buffer buffer
10566 (save-excursion
10567 (save-restriction
10568 (widen)
10569 (goto-char marker)
10570 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
10571 "\\(" org-angle-link-re "\\)\\|"
10572 "\\(" org-plain-link-re "\\)"))
10573 (cnt ?0)
10574 (in-emacs (if (integerp nth) nil nth))
10575 have-zero end links link c)
10576 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10577 (push (match-string 0 zero) links)
10578 (setq cnt (1- cnt) have-zero t))
10579 (save-excursion
10580 (org-back-to-heading t)
10581 (setq end (save-excursion (outline-next-heading) (point)))
10582 (while (re-search-forward re end t)
10583 (push (match-string 0) links))
10584 (setq links (org-uniquify (reverse links))))
10585 (cond
10586 ((null links)
10587 (message "No links"))
10588 ((equal (length links) 1)
10589 (setq link (car links)))
10590 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10591 (setq link (nth (if have-zero nth (1- nth)) links)))
10592 (t ; we have to select a link
10593 (save-excursion
10594 (save-window-excursion
10595 (delete-other-windows)
10596 (with-output-to-temp-buffer "*Select Link*"
10597 (mapc (lambda (l)
10598 (if (not (string-match org-bracket-link-regexp l))
10599 (princ (format "[%c] %s\n" (incf cnt)
10600 (org-remove-angle-brackets l)))
10601 (if (match-end 3)
10602 (princ (format "[%c] %s (%s)\n" (incf cnt)
10603 (match-string 3 l) (match-string 1 l)))
10604 (princ (format "[%c] %s\n" (incf cnt)
10605 (match-string 1 l))))))
10606 links))
10607 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10608 (message "Select link to open, RET to open all:")
10609 (setq c (read-char-exclusive))
10610 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10611 (when (equal c ?q) (error "Abort"))
10612 (if (equal c ?\C-m)
10613 (setq link links)
10614 (setq nth (- c ?0))
10615 (if have-zero (setq nth (1+ nth)))
10616 (unless (and (integerp nth) (>= (length links) nth))
10617 (user-error "Invalid link selection"))
10618 (setq link (nth (1- nth) links)))))
10619 (cons link end))))))
10621 ;; Add special file links that specify the way of opening
10623 (org-add-link-type "file+sys" 'org-open-file-with-system)
10624 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10625 (defun org-open-file-with-system (path)
10626 "Open file at PATH using the system way of opening it."
10627 (org-open-file path 'system))
10628 (defun org-open-file-with-emacs (path)
10629 "Open file at PATH in Emacs."
10630 (org-open-file path 'emacs))
10633 ;;; File search
10635 (defvar org-create-file-search-functions nil
10636 "List of functions to construct the right search string for a file link.
10637 These functions are called in turn with point at the location to
10638 which the link should point.
10640 A function in the hook should first test if it would like to
10641 handle this file type, for example by checking the `major-mode'
10642 or the file extension. If it decides not to handle this file, it
10643 should just return nil to give other functions a chance. If it
10644 does handle the file, it must return the search string to be used
10645 when following the link. The search string will be part of the
10646 file link, given after a double colon, and `org-open-at-point'
10647 will automatically search for it. If special measures must be
10648 taken to make the search successful, another function should be
10649 added to the companion hook `org-execute-file-search-functions',
10650 which see.
10652 A function in this hook may also use `setq' to set the variable
10653 `description' to provide a suggestion for the descriptive text to
10654 be used for this link when it gets inserted into an Org-mode
10655 buffer with \\[org-insert-link].")
10657 (defvar org-execute-file-search-functions nil
10658 "List of functions to execute a file search triggered by a link.
10660 Functions added to this hook must accept a single argument, the
10661 search string that was part of the file link, the part after the
10662 double colon. The function must first check if it would like to
10663 handle this search, for example by checking the `major-mode' or
10664 the file extension. If it decides not to handle this search, it
10665 should just return nil to give other functions a chance. If it
10666 does handle the search, it must return a non-nil value to keep
10667 other functions from trying.
10669 Each function can access the current prefix argument through the
10670 variable `current-prefix-arg'. Note that a single prefix is used
10671 to force opening a link in Emacs, so it may be good to only use a
10672 numeric or double prefix to guide the search function.
10674 In case this is needed, a function in this hook can also restore
10675 the window configuration before `org-open-at-point' was called using:
10677 (set-window-configuration org-window-config-before-follow-link)")
10679 (defun org-link-search (s &optional type avoid-pos stealth)
10680 "Search for a link search option.
10681 If S is surrounded by forward slashes, it is interpreted as a
10682 regular expression. In org-mode files, this will create an `org-occur'
10683 sparse tree. In ordinary files, `occur' will be used to list matches.
10684 If the current buffer is in `dired-mode', grep will be used to search
10685 in all files. If AVOID-POS is given, ignore matches near that position.
10687 When optional argument STEALTH is non-nil, do not modify
10688 visibility around point, thus ignoring
10689 `org-show-hierarchy-above', `org-show-following-heading' and
10690 `org-show-siblings' variables."
10691 (let ((case-fold-search t)
10692 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10693 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10694 (append '(("") (" ") ("\t") ("\n"))
10695 org-emphasis-alist)
10696 "\\|") "\\)"))
10697 (pos (point))
10698 (pre nil) (post nil)
10699 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10700 (cond
10701 ;; First check if there are any special search functions
10702 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10703 ;; Now try the builtin stuff
10704 ((and (equal (string-to-char s0) ?#)
10705 (> (length s0) 1)
10706 (save-excursion
10707 (goto-char (point-min))
10708 (and
10709 (re-search-forward
10710 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10711 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10712 (setq type 'dedicated
10713 pos (match-beginning 0))))
10714 ;; There is an exact target for this
10715 (goto-char pos)
10716 (org-back-to-heading t)))
10717 ((save-excursion
10718 (goto-char (point-min))
10719 (and
10720 (re-search-forward
10721 (concat "<<" (regexp-quote s0) ">>") nil t)
10722 (setq type 'dedicated
10723 pos (match-beginning 0))))
10724 ;; There is an exact target for this
10725 (goto-char pos))
10726 ((save-excursion
10727 (goto-char (point-min))
10728 (and
10729 (re-search-forward
10730 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
10731 (setq type 'dedicated pos (match-beginning 0))))
10732 ;; Found an element with a matching #+name affiliated keyword.
10733 (goto-char pos))
10734 ((and (string-match "^(\\(.*\\))$" s0)
10735 (save-excursion
10736 (goto-char (point-min))
10737 (and
10738 (re-search-forward
10739 (concat "[^[]" (regexp-quote
10740 (format org-coderef-label-format
10741 (match-string 1 s0))))
10742 nil t)
10743 (setq type 'dedicated
10744 pos (1+ (match-beginning 0))))))
10745 ;; There is a coderef target for this
10746 (goto-char pos))
10747 ((string-match "^/\\(.*\\)/$" s)
10748 ;; A regular expression
10749 (cond
10750 ((derived-mode-p 'org-mode)
10751 (org-occur (match-string 1 s)))
10752 (t (org-do-occur (match-string 1 s)))))
10753 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10754 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10755 (goto-char (point-min))
10756 (cond
10757 ((let (case-fold-search)
10758 (re-search-forward (format org-complex-heading-regexp-format
10759 (regexp-quote s))
10760 nil t))
10761 ;; OK, found a match
10762 (setq type 'dedicated)
10763 (goto-char (match-beginning 0)))
10764 ((and (not org-link-search-inhibit-query)
10765 (eq org-link-search-must-match-exact-headline 'query-to-create)
10766 (y-or-n-p "No match - create this as a new heading? "))
10767 (goto-char (point-max))
10768 (or (bolp) (newline))
10769 (insert "* " s "\n")
10770 (beginning-of-line 0))
10772 (goto-char pos)
10773 (error "No match"))))
10775 ;; A normal search string
10776 (when (equal (string-to-char s) ?*)
10777 ;; Anchor on headlines, post may include tags.
10778 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
10779 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
10780 s (substring s 1)))
10781 (remove-text-properties
10782 0 (length s)
10783 '(face nil mouse-face nil keymap nil fontified nil) s)
10784 ;; Make a series of regular expressions to find a match
10785 (setq words (org-split-string s "[ \n\r\t]+")
10787 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
10788 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
10789 "\\)" markers)
10790 re2a_ (concat "\\(" (mapconcat 'downcase words
10791 "[ \t\r\n]+") "\\)[ \t\r\n]")
10792 re2a (concat "[ \t\r\n]" re2a_)
10793 re4_ (concat "\\(" (mapconcat 'downcase words
10794 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
10795 re4 (concat "[^a-zA-Z_]" re4_)
10797 re1 (concat pre re2 post)
10798 re3 (concat pre (if pre re4_ re4) post)
10799 re5 (concat pre ".*" re4)
10800 re2 (concat pre re2)
10801 re2a (concat pre (if pre re2a_ re2a))
10802 re4 (concat pre (if pre re4_ re4))
10803 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
10804 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
10805 re5 "\\)"))
10806 (cond
10807 ((eq type 'org-occur) (org-occur reall))
10808 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10809 (t (goto-char (point-min))
10810 (setq type 'fuzzy)
10811 (if (or (and (org-search-not-self 1 re0 nil t)
10812 (setq type 'dedicated))
10813 (org-search-not-self 1 re1 nil t)
10814 (org-search-not-self 1 re2 nil t)
10815 (org-search-not-self 1 re2a nil t)
10816 (org-search-not-self 1 re3 nil t)
10817 (org-search-not-self 1 re4 nil t)
10818 (org-search-not-self 1 re5 nil t))
10819 (goto-char (match-beginning 1))
10820 (goto-char pos)
10821 (error "No match"))))))
10822 (and (derived-mode-p 'org-mode)
10823 (not stealth)
10824 (org-show-context 'link-search))
10825 type))
10827 (defun org-search-not-self (group &rest args)
10828 "Execute `re-search-forward', but only accept matches that do not
10829 enclose the position of `org-open-link-marker'."
10830 (let ((m org-open-link-marker))
10831 (catch 'exit
10832 (while (apply 're-search-forward args)
10833 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10834 (goto-char (match-end group))
10835 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10836 (> (match-beginning 0) (marker-position m))
10837 (< (match-end 0) (marker-position m)))
10838 (save-match-data
10839 (or (not (org-in-regexp
10840 org-bracket-link-analytic-regexp 1))
10841 (not (match-end 4)) ; no description
10842 (and (<= (match-beginning 4) (point))
10843 (>= (match-end 4) (point))))))
10844 (throw 'exit (point))))))))
10846 (defun org-get-buffer-for-internal-link (buffer)
10847 "Return a buffer to be used for displaying the link target of internal links."
10848 (cond
10849 ((not org-display-internal-link-with-indirect-buffer)
10850 buffer)
10851 ((string-match "(Clone)$" (buffer-name buffer))
10852 (message "Buffer is already a clone, not making another one")
10853 ;; we also do not modify visibility in this case
10854 buffer)
10855 (t ; make a new indirect buffer for displaying the link
10856 (let* ((bn (buffer-name buffer))
10857 (ibn (concat bn "(Clone)"))
10858 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10859 (with-current-buffer ib (org-overview))
10860 ib))))
10862 (defun org-do-occur (regexp &optional cleanup)
10863 "Call the Emacs command `occur'.
10864 If CLEANUP is non-nil, remove the printout of the regular expression
10865 in the *Occur* buffer. This is useful if the regex is long and not useful
10866 to read."
10867 (occur regexp)
10868 (when cleanup
10869 (let ((cwin (selected-window)) win beg end)
10870 (when (setq win (get-buffer-window "*Occur*"))
10871 (select-window win))
10872 (goto-char (point-min))
10873 (when (re-search-forward "match[a-z]+" nil t)
10874 (setq beg (match-end 0))
10875 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
10876 (setq end (1- (match-beginning 0)))))
10877 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10878 (goto-char (point-min))
10879 (select-window cwin))))
10881 ;;; The mark ring for links jumps
10883 (defvar org-mark-ring nil
10884 "Mark ring for positions before jumps in Org-mode.")
10885 (defvar org-mark-ring-last-goto nil
10886 "Last position in the mark ring used to go back.")
10887 ;; Fill and close the ring
10888 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10889 (loop for i from 1 to org-mark-ring-length do
10890 (push (make-marker) org-mark-ring))
10891 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10892 org-mark-ring)
10894 (defun org-mark-ring-push (&optional pos buffer)
10895 "Put the current position or POS into the mark ring and rotate it."
10896 (interactive)
10897 (setq pos (or pos (point)))
10898 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10899 (move-marker (car org-mark-ring)
10900 (or pos (point))
10901 (or buffer (current-buffer)))
10902 (message "%s"
10903 (substitute-command-keys
10904 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
10906 (defun org-mark-ring-goto (&optional n)
10907 "Jump to the previous position in the mark ring.
10908 With prefix arg N, jump back that many stored positions. When
10909 called several times in succession, walk through the entire ring.
10910 Org-mode commands jumping to a different position in the current file,
10911 or to another Org-mode file, automatically push the old position
10912 onto the ring."
10913 (interactive "p")
10914 (let (p m)
10915 (if (eq last-command this-command)
10916 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10917 (setq p org-mark-ring))
10918 (setq org-mark-ring-last-goto p)
10919 (setq m (car p))
10920 (org-pop-to-buffer-same-window (marker-buffer m))
10921 (goto-char m)
10922 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10924 (defun org-remove-angle-brackets (s)
10925 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10926 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10928 (defun org-add-angle-brackets (s)
10929 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10930 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10932 (defun org-remove-double-quotes (s)
10933 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
10934 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
10937 ;;; Following specific links
10939 (defun org-follow-timestamp-link ()
10940 "Open an agenda view for the time-stamp date/range at point."
10941 (cond
10942 ((org-at-date-range-p t)
10943 (let ((org-agenda-start-on-weekday)
10944 (t1 (match-string 1))
10945 (t2 (match-string 2)) tt1 tt2)
10946 (setq tt1 (time-to-days (org-time-string-to-time t1))
10947 tt2 (time-to-days (org-time-string-to-time t2)))
10948 (let ((org-agenda-buffer-tmp-name
10949 (format "*Org Agenda(a:%s)"
10950 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10951 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10952 ((org-at-timestamp-p t)
10953 (let ((org-agenda-buffer-tmp-name
10954 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10955 (org-agenda-list nil (time-to-days (org-time-string-to-time
10956 (substring (match-string 1) 0 10)))
10957 1)))
10958 (t (error "This should not happen"))))
10961 ;;; Following file links
10962 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10963 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10964 (declare-function mailcap-mime-info
10965 "mailcap" (string &optional request no-decode))
10966 (defvar org-wait nil)
10967 (defun org-open-file (path &optional in-emacs line search)
10968 "Open the file at PATH.
10969 First, this expands any special file name abbreviations. Then the
10970 configuration variable `org-file-apps' is checked if it contains an
10971 entry for this file type, and if yes, the corresponding command is launched.
10973 If no application is found, Emacs simply visits the file.
10975 With optional prefix argument IN-EMACS, Emacs will visit the file.
10976 With a double \\[universal-argument] \\[universal-argument] \
10977 prefix arg, Org tries to avoid opening in Emacs
10978 and to use an external application to visit the file.
10980 Optional LINE specifies a line to go to, optional SEARCH a string
10981 to search for. If LINE or SEARCH is given, the file will be
10982 opened in Emacs, unless an entry from org-file-apps that makes
10983 use of groups in a regexp matches.
10985 If you want to change the way frames are used when following a
10986 link, please customize `org-link-frame-setup'.
10988 If the file does not exist, an error is thrown."
10989 (let* ((file (if (equal path "")
10990 buffer-file-name
10991 (substitute-in-file-name (expand-file-name path))))
10992 (file-apps (append org-file-apps (org-default-apps)))
10993 (apps (org-remove-if
10994 'org-file-apps-entry-match-against-dlink-p file-apps))
10995 (apps-dlink (org-remove-if-not
10996 'org-file-apps-entry-match-against-dlink-p file-apps))
10997 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10998 (dirp (if remp nil (file-directory-p file)))
10999 (file (if (and dirp org-open-directory-means-index-dot-org)
11000 (concat (file-name-as-directory file) "index.org")
11001 file))
11002 (a-m-a-p (assq 'auto-mode apps))
11003 (dfile (downcase file))
11004 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11005 (link (cond ((and (eq line nil)
11006 (eq search nil))
11007 file)
11008 (line
11009 (concat file "::" (number-to-string line)))
11010 (search
11011 (concat file "::" search))))
11012 (dlink (downcase link))
11013 (old-buffer (current-buffer))
11014 (old-pos (point))
11015 (old-mode major-mode)
11016 ext cmd link-match-data)
11017 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11018 (setq ext (match-string 1 dfile))
11019 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11020 (setq ext (match-string 1 dfile))))
11021 (cond
11022 ((member in-emacs '((16) system))
11023 (setq cmd (cdr (assoc 'system apps))))
11024 (in-emacs (setq cmd 'emacs))
11026 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11027 (and dirp (cdr (assoc 'directory apps)))
11028 ; first, try matching against apps-dlink
11029 ; if we get a match here, store the match data for later
11030 (let ((match (assoc-default dlink apps-dlink
11031 'string-match)))
11032 (if match
11033 (progn (setq link-match-data (match-data))
11034 match)
11035 (progn (setq in-emacs (or in-emacs line search))
11036 nil))) ; if we have no match in apps-dlink,
11037 ; always open the file in emacs if line or search
11038 ; is given (for backwards compatibility)
11039 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11040 'string-match)
11041 (cdr (assoc ext apps))
11042 (cdr (assoc t apps))))))
11043 (when (eq cmd 'system)
11044 (setq cmd (cdr (assoc 'system apps))))
11045 (when (eq cmd 'default)
11046 (setq cmd (cdr (assoc t apps))))
11047 (when (eq cmd 'mailcap)
11048 (require 'mailcap)
11049 (mailcap-parse-mailcaps)
11050 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11051 (command (mailcap-mime-info mime-type)))
11052 (if (stringp command)
11053 (setq cmd command)
11054 (setq cmd 'emacs))))
11055 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11056 (not (file-exists-p file))
11057 (not org-open-non-existing-files))
11058 (user-error "No such file: %s" file))
11059 (cond
11060 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11061 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11062 (while (string-match "['\"]%s['\"]" cmd)
11063 (setq cmd (replace-match "%s" t t cmd)))
11064 (while (string-match "%s" cmd)
11065 (setq cmd (replace-match
11066 (save-match-data
11067 (shell-quote-argument
11068 (convert-standard-filename file)))
11069 t t cmd)))
11071 ;; Replace "%1", "%2" etc. in command with group matches from regex
11072 (save-match-data
11073 (let ((match-index 1)
11074 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11075 (set-match-data link-match-data)
11076 (while (<= match-index number-of-groups)
11077 (let ((regex (concat "%" (number-to-string match-index)))
11078 (replace-with (match-string match-index dlink)))
11079 (while (string-match regex cmd)
11080 (setq cmd (replace-match replace-with t t cmd))))
11081 (setq match-index (+ match-index 1)))))
11083 (save-window-excursion
11084 (message "Running %s...done" cmd)
11085 (start-process-shell-command cmd nil cmd)
11086 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11087 ((or (stringp cmd)
11088 (eq cmd 'emacs))
11089 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11090 (widen)
11091 (if line (org-goto-line line)
11092 (if search (org-link-search search))))
11093 ((consp cmd)
11094 (let ((file (convert-standard-filename file)))
11095 (save-match-data
11096 (set-match-data link-match-data)
11097 (eval cmd))))
11098 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11099 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11100 (or (not (equal old-buffer (current-buffer)))
11101 (not (equal old-pos (point))))
11102 (org-mark-ring-push old-pos old-buffer))))
11104 (defun org-file-apps-entry-match-against-dlink-p (entry)
11105 "This function returns non-nil if `entry' uses a regular
11106 expression which should be matched against the whole link by
11107 org-open-file.
11109 It assumes that is the case when the entry uses a regular
11110 expression which has at least one grouping construct and the
11111 action is either a lisp form or a command string containing
11112 '%1', i.e. using at least one subexpression match as a
11113 parameter."
11114 (let ((selector (car entry))
11115 (action (cdr entry)))
11116 (if (stringp selector)
11117 (and (> (regexp-opt-depth selector) 0)
11118 (or (and (stringp action)
11119 (string-match "%[0-9]" action))
11120 (consp action)))
11121 nil)))
11123 (defun org-default-apps ()
11124 "Return the default applications for this operating system."
11125 (cond
11126 ((eq system-type 'darwin)
11127 org-file-apps-defaults-macosx)
11128 ((eq system-type 'windows-nt)
11129 org-file-apps-defaults-windowsnt)
11130 (t org-file-apps-defaults-gnu)))
11132 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11133 "Convert extensions to regular expressions in the cars of LIST.
11134 Also, weed out any non-string entries, because the return value is used
11135 only for regexp matching.
11136 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11137 point to the symbol `emacs', indicating that the file should
11138 be opened in Emacs."
11139 (append
11140 (delq nil
11141 (mapcar (lambda (x)
11142 (if (not (stringp (car x)))
11144 (if (string-match "\\W" (car x))
11146 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11147 list))
11148 (if add-auto-mode
11149 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11151 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11152 (defun org-file-remote-p (file)
11153 "Test whether FILE specifies a location on a remote system.
11154 Return non-nil if the location is indeed remote.
11156 For example, the filename \"/user@host:/foo\" specifies a location
11157 on the system \"/user@host:\"."
11158 (cond ((fboundp 'file-remote-p)
11159 (file-remote-p file))
11160 ((fboundp 'tramp-handle-file-remote-p)
11161 (tramp-handle-file-remote-p file))
11162 ((and (boundp 'ange-ftp-name-format)
11163 (string-match (car ange-ftp-name-format) file))
11164 t)))
11167 ;;;; Refiling
11169 (defun org-get-org-file ()
11170 "Read a filename, with default directory `org-directory'."
11171 (let ((default (or org-default-notes-file remember-data-file)))
11172 (read-file-name (format "File name [%s]: " default)
11173 (file-name-as-directory org-directory)
11174 default)))
11176 (defun org-notes-order-reversed-p ()
11177 "Check if the current file should receive notes in reversed order."
11178 (cond
11179 ((not org-reverse-note-order) nil)
11180 ((eq t org-reverse-note-order) t)
11181 ((not (listp org-reverse-note-order)) nil)
11182 (t (catch 'exit
11183 (let ((all org-reverse-note-order)
11184 entry)
11185 (while (setq entry (pop all))
11186 (if (string-match (car entry) buffer-file-name)
11187 (throw 'exit (cdr entry))))
11188 nil)))))
11190 (defvar org-refile-target-table nil
11191 "The list of refile targets, created by `org-refile'.")
11193 (defvar org-agenda-new-buffers nil
11194 "Buffers created to visit agenda files.")
11196 (defvar org-refile-cache nil
11197 "Cache for refile targets.")
11199 (defvar org-refile-markers nil
11200 "All the markers used for caching refile locations.")
11202 (defun org-refile-marker (pos)
11203 "Get a new refile marker, but only if caching is in use."
11204 (if (not org-refile-use-cache)
11206 (let ((m (make-marker)))
11207 (move-marker m pos)
11208 (push m org-refile-markers)
11209 m)))
11211 (defun org-refile-cache-clear ()
11212 "Clear the refile cache and disable all the markers."
11213 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11214 (setq org-refile-markers nil)
11215 (setq org-refile-cache nil)
11216 (message "Refile cache has been cleared"))
11218 (defun org-refile-cache-check-set (set)
11219 "Check if all the markers in the cache still have live buffers."
11220 (let (marker)
11221 (catch 'exit
11222 (while (and set (setq marker (nth 3 (pop set))))
11223 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11224 (when (and marker (null (marker-buffer marker)))
11225 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11226 (sit-for 3)
11227 (throw 'exit nil)))
11228 t)))
11230 (defun org-refile-cache-put (set &rest identifiers)
11231 "Push the refile targets SET into the cache, under IDENTIFIERS."
11232 (let* ((key (sha1 (prin1-to-string identifiers)))
11233 (entry (assoc key org-refile-cache)))
11234 (if entry
11235 (setcdr entry set)
11236 (push (cons key set) org-refile-cache))))
11238 (defun org-refile-cache-get (&rest identifiers)
11239 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11240 (cond
11241 ((not org-refile-cache) nil)
11242 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11244 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11245 org-refile-cache))))
11246 (and set (org-refile-cache-check-set set) set)))))
11248 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11249 "Produce a table with refile targets."
11250 (let ((case-fold-search nil)
11251 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11252 (entries (or org-refile-targets '((nil . (:level . 1)))))
11253 targets tgs txt re files f desc descre fast-path-p level pos0)
11254 (message "Getting targets...")
11255 (with-current-buffer (or default-buffer (current-buffer))
11256 (while (setq entry (pop entries))
11257 (setq files (car entry) desc (cdr entry))
11258 (setq fast-path-p nil)
11259 (cond
11260 ((null files) (setq files (list (current-buffer))))
11261 ((eq files 'org-agenda-files)
11262 (setq files (org-agenda-files 'unrestricted)))
11263 ((and (symbolp files) (fboundp files))
11264 (setq files (funcall files)))
11265 ((and (symbolp files) (boundp files))
11266 (setq files (symbol-value files))))
11267 (if (stringp files) (setq files (list files)))
11268 (cond
11269 ((eq (car desc) :tag)
11270 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11271 ((eq (car desc) :todo)
11272 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11273 ((eq (car desc) :regexp)
11274 (setq descre (cdr desc)))
11275 ((eq (car desc) :level)
11276 (setq descre (concat "^\\*\\{" (number-to-string
11277 (if org-odd-levels-only
11278 (1- (* 2 (cdr desc)))
11279 (cdr desc)))
11280 "\\}[ \t]")))
11281 ((eq (car desc) :maxlevel)
11282 (setq fast-path-p t)
11283 (setq descre (concat "^\\*\\{1," (number-to-string
11284 (if org-odd-levels-only
11285 (1- (* 2 (cdr desc)))
11286 (cdr desc)))
11287 "\\}[ \t]")))
11288 (t (error "Bad refiling target description %s" desc)))
11289 (while (setq f (pop files))
11290 (with-current-buffer
11291 (if (bufferp f) f (org-get-agenda-file-buffer f))
11293 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11294 (progn
11295 (if (bufferp f) (setq f (buffer-file-name
11296 (buffer-base-buffer f))))
11297 (setq f (and f (expand-file-name f)))
11298 (if (eq org-refile-use-outline-path 'file)
11299 (push (list (file-name-nondirectory f) f nil nil) tgs))
11300 (save-excursion
11301 (save-restriction
11302 (widen)
11303 (goto-char (point-min))
11304 (while (re-search-forward descre nil t)
11305 (goto-char (setq pos0 (point-at-bol)))
11306 (catch 'next
11307 (when org-refile-target-verify-function
11308 (save-match-data
11309 (or (funcall org-refile-target-verify-function)
11310 (throw 'next t))))
11311 (when (and (looking-at org-complex-heading-regexp)
11312 (not (member (match-string 4) excluded-entries))
11313 (match-string 4))
11314 (setq level (org-reduced-level
11315 (- (match-end 1) (match-beginning 1)))
11316 txt (org-link-display-format (match-string 4))
11317 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11318 re (format org-complex-heading-regexp-format
11319 (regexp-quote (match-string 4))))
11320 (when org-refile-use-outline-path
11321 (setq txt (mapconcat
11322 'org-protect-slash
11323 (append
11324 (if (eq org-refile-use-outline-path
11325 'file)
11326 (list (file-name-nondirectory
11327 (buffer-file-name
11328 (buffer-base-buffer))))
11329 (if (eq org-refile-use-outline-path
11330 'full-file-path)
11331 (list (buffer-file-name
11332 (buffer-base-buffer)))))
11333 (org-get-outline-path fast-path-p
11334 level txt)
11335 (list txt))
11336 "/")))
11337 (push (list txt f re (org-refile-marker (point)))
11338 tgs)))
11339 (when (= (point) pos0)
11340 ;; verification function has not moved point
11341 (goto-char (point-at-eol))))))))
11342 (when org-refile-use-cache
11343 (org-refile-cache-put tgs (buffer-file-name) descre))
11344 (setq targets (append tgs targets))))))
11345 (message "Getting targets...done")
11346 (nreverse targets)))
11348 (defun org-protect-slash (s)
11349 (while (string-match "/" s)
11350 (setq s (replace-match "\\" t t s)))
11353 (defvar org-olpa (make-vector 20 nil))
11355 (defun org-get-outline-path (&optional fastp level heading)
11356 "Return the outline path to the current entry, as a list.
11358 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11359 routine which makes outline path derivations for an entire file,
11360 avoiding backtracing. Refile target collection makes use of that."
11361 (if fastp
11362 (progn
11363 (if (> level 19)
11364 (error "Outline path failure, more than 19 levels"))
11365 (loop for i from level upto 19 do
11366 (aset org-olpa i nil))
11367 (prog1
11368 (delq nil (append org-olpa nil))
11369 (aset org-olpa level heading)))
11370 (let (rtn case-fold-search)
11371 (save-excursion
11372 (save-restriction
11373 (widen)
11374 (while (org-up-heading-safe)
11375 (when (looking-at org-complex-heading-regexp)
11376 (push (org-trim
11377 (replace-regexp-in-string
11378 ;; Remove statistical/checkboxes cookies
11379 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11380 (org-match-string-no-properties 4)))
11381 rtn)))
11382 rtn)))))
11384 (defun org-format-outline-path (path &optional width prefix separator)
11385 "Format the outline path PATH for display.
11386 WIDTH is the maximum number of characters that is available.
11387 PREFIX is a prefix to be included in the returned string,
11388 such as the file name.
11389 SEPARATOR is inserted between the different parts of the path,
11390 the default is \"/\"."
11391 (setq width (or width 79))
11392 (if prefix (setq width (- width (length prefix))))
11393 (if (not path)
11394 (or prefix "")
11395 (let* ((nsteps (length path))
11396 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11397 (maxwidth (if (<= total-width width)
11398 10000 ;; everything fits
11399 ;; we need to shorten the level headings
11400 (/ (- width nsteps) nsteps)))
11401 (org-odd-levels-only nil)
11402 (n 0)
11403 (total (1+ (length prefix))))
11404 (setq maxwidth (max maxwidth 10))
11405 (concat prefix
11406 (if prefix (or separator "/"))
11407 (mapconcat
11408 (lambda (h)
11409 (setq n (1+ n))
11410 (if (and (= n nsteps) (< maxwidth 10000))
11411 (setq maxwidth (- total-width total)))
11412 (if (< (length h) maxwidth)
11413 (progn (setq total (+ total (length h) 1)) h)
11414 (setq h (substring h 0 (- maxwidth 2))
11415 total (+ total maxwidth 1))
11416 (if (string-match "[ \t]+\\'" h)
11417 (setq h (substring h 0 (match-beginning 0))))
11418 (setq h (concat h "..")))
11419 (org-add-props h nil 'face
11420 (nth (% (1- n) org-n-level-faces)
11421 org-level-faces))
11423 path (or separator "/"))))))
11425 (defun org-display-outline-path (&optional file current separator just-return-string)
11426 "Display the current outline path in the echo area.
11428 If FILE is non-nil, prepend the output with the file name.
11429 If CURRENT is non-nil, append the current heading to the output.
11430 SEPARATOR is passed through to `org-format-outline-path'. It separates
11431 the different parts of the path and defaults to \"/\".
11432 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11433 (interactive "P")
11434 (let* (case-fold-search
11435 (bfn (buffer-file-name (buffer-base-buffer)))
11436 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11437 res)
11438 (if current (setq path (append path
11439 (save-excursion
11440 (org-back-to-heading t)
11441 (if (looking-at org-complex-heading-regexp)
11442 (list (match-string 4)))))))
11443 (setq res
11444 (org-format-outline-path
11445 path
11446 (1- (frame-width))
11447 (and file bfn (concat (file-name-nondirectory bfn) separator))
11448 separator))
11449 (if just-return-string
11450 (org-no-properties res)
11451 (org-unlogged-message "%s" res))))
11453 (defvar org-refile-history nil
11454 "History for refiling operations.")
11456 (defvar org-after-refile-insert-hook nil
11457 "Hook run after `org-refile' has inserted its stuff at the new location.
11458 Note that this is still *before* the stuff will be removed from
11459 the *old* location.")
11461 (defvar org-capture-last-stored-marker)
11462 (defvar org-refile-keep nil
11463 "Non-nil means `org-refile' will copy instead of refile.")
11465 (defun org-copy ()
11466 "Like `org-refile', but copy."
11467 (interactive)
11468 (let ((org-refile-keep t))
11469 (funcall 'org-refile nil nil nil "Copy")))
11471 (defun org-refile (&optional goto default-buffer rfloc msg)
11472 "Move the entry or entries at point to another heading.
11473 The list of target headings is compiled using the information in
11474 `org-refile-targets', which see.
11476 At the target location, the entry is filed as a subitem of the target
11477 heading. Depending on `org-reverse-note-order', the new subitem will
11478 either be the first or the last subitem.
11480 If there is an active region, all entries in that region will be moved.
11481 However, the region must fulfill the requirement that the first heading
11482 is the first one sets the top-level of the moved text - at most siblings
11483 below it are allowed.
11485 With prefix arg GOTO, the command will only visit the target location
11486 and not actually move anything.
11488 With a double prefix arg \\[universal-argument] \\[universal-argument], \
11489 go to the location where the last refiling operation has put the subtree.
11491 With a numeric prefix argument of `2', refile to the running clock.
11493 With a numeric prefix argument of `3', emulate `org-refile-keep'
11494 being set to `t' and copy to the target location, don't move it.
11495 Beware that keeping refiled entries may result in duplicated ID
11496 properties.
11498 RFLOC can be a refile location obtained in a different way.
11500 MSG is a string to replace \"Refile\" in the default prompt with
11501 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11503 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11505 If you are using target caching (see `org-refile-use-cache'),
11506 you have to clear the target cache in order to find new targets.
11507 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11508 prefix argument (`C-u C-u C-u C-c C-w')."
11510 (interactive "P")
11511 (if (member goto '(0 (64)))
11512 (org-refile-cache-clear)
11513 (let* ((actionmsg (or msg "Refile"))
11514 (cbuf (current-buffer))
11515 (regionp (org-region-active-p))
11516 (region-start (and regionp (region-beginning)))
11517 (region-end (and regionp (region-end)))
11518 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11519 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11520 pos it nbuf file re level reversed)
11521 (setq last-command nil)
11522 (when regionp
11523 (goto-char region-start)
11524 (or (bolp) (goto-char (point-at-bol)))
11525 (setq region-start (point))
11526 (unless (or (org-kill-is-subtree-p
11527 (buffer-substring region-start region-end))
11528 (prog1 org-refile-active-region-within-subtree
11529 (let ((s (point-at-eol)))
11530 (org-toggle-heading)
11531 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11532 (user-error "The region is not a (sequence of) subtree(s)")))
11533 (if (equal goto '(16))
11534 (org-refile-goto-last-stored)
11535 (when (or
11536 (and (equal goto 2)
11537 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11538 (prog1
11539 (setq it (list (or org-clock-heading "running clock")
11540 (buffer-file-name
11541 (marker-buffer org-clock-hd-marker))
11543 (marker-position org-clock-hd-marker)))
11544 (setq goto nil)))
11545 (setq it (or rfloc
11546 (let (heading-text)
11547 (save-excursion
11548 (unless goto
11549 (org-back-to-heading t)
11550 (setq heading-text
11551 (nth 4 (org-heading-components))))
11553 (org-refile-get-location
11554 (cond (goto "Goto")
11555 (regionp (concat actionmsg " region to"))
11556 (t (concat actionmsg " subtree \""
11557 heading-text "\" to")))
11558 default-buffer
11559 (and (not (equal '(4) goto))
11560 org-refile-allow-creating-parent-nodes)
11561 goto))))))
11562 (setq file (nth 1 it)
11563 re (nth 2 it)
11564 pos (nth 3 it))
11565 (if (and (not goto)
11567 (equal (buffer-file-name) file)
11568 (if regionp
11569 (and (>= pos region-start)
11570 (<= pos region-end))
11571 (and (>= pos (point))
11572 (< pos (save-excursion
11573 (org-end-of-subtree t t))))))
11574 (error "Cannot refile to position inside the tree or region"))
11576 (setq nbuf (or (find-buffer-visiting file)
11577 (find-file-noselect file)))
11578 (if (and goto (not (equal goto 3)))
11579 (progn
11580 (org-pop-to-buffer-same-window nbuf)
11581 (goto-char pos)
11582 (org-show-context 'org-goto))
11583 (if regionp
11584 (progn
11585 (org-kill-new (buffer-substring region-start region-end))
11586 (org-save-markers-in-region region-start region-end))
11587 (org-copy-subtree 1 nil t))
11588 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11589 (find-file-noselect file)))
11590 (setq reversed (org-notes-order-reversed-p))
11591 (save-excursion
11592 (save-restriction
11593 (widen)
11594 (if pos
11595 (progn
11596 (goto-char pos)
11597 (looking-at org-outline-regexp)
11598 (setq level (org-get-valid-level (funcall outline-level) 1))
11599 (goto-char
11600 (if reversed
11601 (or (outline-next-heading) (point-max))
11602 (or (save-excursion (org-get-next-sibling))
11603 (org-end-of-subtree t t)
11604 (point-max)))))
11605 (setq level 1)
11606 (if (not reversed)
11607 (goto-char (point-max))
11608 (goto-char (point-min))
11609 (or (outline-next-heading) (goto-char (point-max)))))
11610 (if (not (bolp)) (newline))
11611 (org-paste-subtree level)
11612 (when org-log-refile
11613 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11614 (unless (eq org-log-refile 'note)
11615 (save-excursion (org-add-log-note))))
11616 (and org-auto-align-tags
11617 (let ((org-loop-over-headlines-in-active-region nil))
11618 (org-set-tags nil t)))
11619 (let ((bookmark-name (plist-get org-bookmark-names-plist
11620 :last-refile)))
11621 (when bookmark-name
11622 (with-demoted-errors
11623 (bookmark-set bookmark-name))))
11624 ;; If we are refiling for capture, make sure that the
11625 ;; last-capture pointers point here
11626 (when (org-bound-and-true-p org-refile-for-capture)
11627 (let ((bookmark-name (plist-get org-bookmark-names-plist
11628 :last-capture-marker)))
11629 (when bookmark-name
11630 (with-demoted-errors
11631 (bookmark-set bookmark-name))))
11632 (move-marker org-capture-last-stored-marker (point)))
11633 (if (fboundp 'deactivate-mark) (deactivate-mark))
11634 (run-hooks 'org-after-refile-insert-hook))))
11635 (unless org-refile-keep
11636 (if regionp
11637 (delete-region (point) (+ (point) (- region-end region-start)))
11638 (delete-region
11639 (and (org-back-to-heading t) (point))
11640 (min (buffer-size) (org-end-of-subtree t t) (point)))))
11641 (when (featurep 'org-inlinetask)
11642 (org-inlinetask-remove-END-maybe))
11643 (setq org-markers-to-move nil)
11644 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11646 (defun org-refile-goto-last-stored ()
11647 "Go to the location where the last refile was stored."
11648 (interactive)
11649 (bookmark-jump "org-refile-last-stored")
11650 (message "This is the location of the last refile"))
11652 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11653 no-exclude)
11654 "Prompt the user for a refile location, using PROMPT.
11655 PROMPT should not be suffixed with a colon and a space, because
11656 this function appends the default value from
11657 `org-refile-history' automatically, if that is not empty.
11658 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11659 this is used for the GOTO interface."
11660 (let ((org-refile-targets org-refile-targets)
11661 (org-refile-use-outline-path org-refile-use-outline-path)
11662 excluded-entries)
11663 (when (and (derived-mode-p 'org-mode)
11664 (not org-refile-use-cache)
11665 (not no-exclude))
11666 (org-map-tree
11667 (lambda()
11668 (setq excluded-entries
11669 (append excluded-entries (list (org-get-heading t t)))))))
11670 (setq org-refile-target-table
11671 (org-refile-get-targets default-buffer excluded-entries)))
11672 (unless org-refile-target-table
11673 (user-error "No refile targets"))
11674 (let* ((cbuf (current-buffer))
11675 (partial-completion-mode nil)
11676 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11677 (cfunc (if (and org-refile-use-outline-path
11678 org-outline-path-complete-in-steps)
11679 'org-olpath-completing-read
11680 'org-icompleting-read))
11681 (extra (if org-refile-use-outline-path "/" ""))
11682 (cbnex (concat (buffer-name) extra))
11683 (filename (and cfn (expand-file-name cfn)))
11684 (tbl (mapcar
11685 (lambda (x)
11686 (if (and (not (member org-refile-use-outline-path
11687 '(file full-file-path)))
11688 (not (equal filename (nth 1 x))))
11689 (cons (concat (car x) extra " ("
11690 (file-name-nondirectory (nth 1 x)) ")")
11691 (cdr x))
11692 (cons (concat (car x) extra) (cdr x))))
11693 org-refile-target-table))
11694 (completion-ignore-case t)
11695 cdef
11696 (prompt (concat prompt
11697 (or (and (car org-refile-history)
11698 (concat " (default " (car org-refile-history) ")"))
11699 (and (assoc cbnex tbl) (setq cdef cbnex)
11700 (concat " (default " cbnex ")"))) ": "))
11701 pa answ parent-target child parent old-hist)
11702 (setq old-hist org-refile-history)
11703 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11704 nil 'org-refile-history (or cdef (car org-refile-history))))
11705 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11706 (if pa
11707 (progn
11708 (org-refile-check-position pa)
11709 (when (or (not org-refile-history)
11710 (not (eq old-hist org-refile-history))
11711 (not (equal (car pa) (car org-refile-history))))
11712 (setq org-refile-history
11713 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11714 org-refile-history
11715 (cdr org-refile-history))))
11716 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11717 (pop org-refile-history)))
11719 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
11720 (progn
11721 (setq parent (match-string 1 answ)
11722 child (match-string 2 answ))
11723 (setq parent-target (or (assoc parent tbl)
11724 (assoc (concat parent "/") tbl)))
11725 (when (and parent-target
11726 (or (eq new-nodes t)
11727 (and (eq new-nodes 'confirm)
11728 (y-or-n-p (format "Create new node \"%s\"? "
11729 child)))))
11730 (org-refile-new-child parent-target child)))
11731 (user-error "Invalid target location")))))
11733 (declare-function org-string-nw-p "org-macs" (s))
11734 (defun org-refile-check-position (refile-pointer)
11735 "Check if the refile pointer matches the headline to which it points."
11736 (let* ((file (nth 1 refile-pointer))
11737 (re (nth 2 refile-pointer))
11738 (pos (nth 3 refile-pointer))
11739 buffer)
11740 (if (and (not (markerp pos)) (not file))
11741 (user-error "Please save the buffer to a file before refiling")
11742 (when (org-string-nw-p re)
11743 (setq buffer (if (markerp pos)
11744 (marker-buffer pos)
11745 (or (find-buffer-visiting file)
11746 (find-file-noselect file))))
11747 (with-current-buffer buffer
11748 (save-excursion
11749 (save-restriction
11750 (widen)
11751 (goto-char pos)
11752 (beginning-of-line 1)
11753 (unless (org-looking-at-p re)
11754 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11756 (defun org-refile-new-child (parent-target child)
11757 "Use refile target PARENT-TARGET to add new CHILD below it."
11758 (unless parent-target
11759 (error "Cannot find parent for new node"))
11760 (let ((file (nth 1 parent-target))
11761 (pos (nth 3 parent-target))
11762 level)
11763 (with-current-buffer (or (find-buffer-visiting file)
11764 (find-file-noselect file))
11765 (save-excursion
11766 (save-restriction
11767 (widen)
11768 (if pos
11769 (goto-char pos)
11770 (goto-char (point-max))
11771 (if (not (bolp)) (newline)))
11772 (when (looking-at org-outline-regexp)
11773 (setq level (funcall outline-level))
11774 (org-end-of-subtree t t))
11775 (org-back-over-empty-lines)
11776 (insert "\n" (make-string
11777 (if pos (org-get-valid-level level 1) 1) ?*)
11778 " " child "\n")
11779 (beginning-of-line 0)
11780 (list (concat (car parent-target) "/" child) file "" (point)))))))
11782 (defun org-olpath-completing-read (prompt collection &rest args)
11783 "Read an outline path like a file name."
11784 (let ((thetable collection)
11785 (org-completion-use-ido nil) ; does not work with ido.
11786 (org-completion-use-iswitchb nil)) ; or iswitchb
11787 (apply
11788 'org-icompleting-read prompt
11789 (lambda (string predicate &optional flag)
11790 (let (rtn r f (l (length string)))
11791 (cond
11792 ((eq flag nil)
11793 ;; try completion
11794 (try-completion string thetable))
11795 ((eq flag t)
11796 ;; all-completions
11797 (setq rtn (all-completions string thetable predicate))
11798 (mapcar
11799 (lambda (x)
11800 (setq r (substring x l))
11801 (if (string-match " ([^)]*)$" x)
11802 (setq f (match-string 0 x))
11803 (setq f ""))
11804 (if (string-match "/" r)
11805 (concat string (substring r 0 (match-end 0)) f)
11807 rtn))
11808 ((eq flag 'lambda)
11809 ;; exact match?
11810 (assoc string thetable)))))
11811 args)))
11813 ;;;; Dynamic blocks
11815 (defun org-find-dblock (name)
11816 "Find the first dynamic block with name NAME in the buffer.
11817 If not found, stay at current position and return nil."
11818 (let ((case-fold-search t) pos)
11819 (save-excursion
11820 (goto-char (point-min))
11821 (setq pos (and (re-search-forward
11822 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
11823 (match-beginning 0))))
11824 (if pos (goto-char pos))
11825 pos))
11827 (defconst org-dblock-start-re
11828 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
11829 "Matches the start line of a dynamic block, with parameters.")
11831 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
11832 "Matches the end of a dynamic block.")
11834 (defun org-create-dblock (plist)
11835 "Create a dynamic block section, with parameters taken from PLIST.
11836 PLIST must contain a :name entry which is used as name of the block."
11837 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
11838 (end-of-line 1)
11839 (newline))
11840 (let ((col (current-column))
11841 (name (plist-get plist :name)))
11842 (insert "#+BEGIN: " name)
11843 (while plist
11844 (if (eq (car plist) :name)
11845 (setq plist (cddr plist))
11846 (insert " " (prin1-to-string (pop plist)))))
11847 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
11848 (beginning-of-line -2)))
11850 (defun org-prepare-dblock ()
11851 "Prepare dynamic block for refresh.
11852 This empties the block, puts the cursor at the insert position and returns
11853 the property list including an extra property :name with the block name."
11854 (unless (looking-at org-dblock-start-re)
11855 (user-error "Not at a dynamic block"))
11856 (let* ((begdel (1+ (match-end 0)))
11857 (name (org-no-properties (match-string 1)))
11858 (params (append (list :name name)
11859 (read (concat "(" (match-string 3) ")")))))
11860 (save-excursion
11861 (beginning-of-line 1)
11862 (skip-chars-forward " \t")
11863 (setq params (plist-put params :indentation-column (current-column))))
11864 (unless (re-search-forward org-dblock-end-re nil t)
11865 (error "Dynamic block not terminated"))
11866 (setq params
11867 (append params
11868 (list :content (buffer-substring
11869 begdel (match-beginning 0)))))
11870 (delete-region begdel (match-beginning 0))
11871 (goto-char begdel)
11872 (open-line 1)
11873 params))
11875 (defun org-map-dblocks (&optional command)
11876 "Apply COMMAND to all dynamic blocks in the current buffer.
11877 If COMMAND is not given, use `org-update-dblock'."
11878 (let ((cmd (or command 'org-update-dblock)))
11879 (save-excursion
11880 (goto-char (point-min))
11881 (while (re-search-forward org-dblock-start-re nil t)
11882 (goto-char (match-beginning 0))
11883 (save-excursion
11884 (condition-case nil
11885 (funcall cmd)
11886 (error (message "Error during update of dynamic block"))))
11887 (unless (re-search-forward org-dblock-end-re nil t)
11888 (error "Dynamic block not terminated"))))))
11890 (defun org-dblock-update (&optional arg)
11891 "User command for updating dynamic blocks.
11892 Update the dynamic block at point. With prefix ARG, update all dynamic
11893 blocks in the buffer."
11894 (interactive "P")
11895 (if arg
11896 (org-update-all-dblocks)
11897 (or (looking-at org-dblock-start-re)
11898 (org-beginning-of-dblock))
11899 (org-update-dblock)))
11901 (defun org-update-dblock ()
11902 "Update the dynamic block at point.
11903 This means to empty the block, parse for parameters and then call
11904 the correct writing function."
11905 (interactive)
11906 (save-window-excursion
11907 (let* ((pos (point))
11908 (line (org-current-line))
11909 (params (org-prepare-dblock))
11910 (name (plist-get params :name))
11911 (indent (plist-get params :indentation-column))
11912 (cmd (intern (concat "org-dblock-write:" name))))
11913 (message "Updating dynamic block `%s' at line %d..." name line)
11914 (funcall cmd params)
11915 (message "Updating dynamic block `%s' at line %d...done" name line)
11916 (goto-char pos)
11917 (when (and indent (> indent 0))
11918 (setq indent (make-string indent ?\ ))
11919 (save-excursion
11920 (org-beginning-of-dblock)
11921 (forward-line 1)
11922 (while (not (looking-at org-dblock-end-re))
11923 (insert indent)
11924 (beginning-of-line 2))
11925 (when (looking-at org-dblock-end-re)
11926 (and (looking-at "[ \t]+")
11927 (replace-match ""))
11928 (insert indent)))))))
11930 (defun org-beginning-of-dblock ()
11931 "Find the beginning of the dynamic block at point.
11932 Error if there is no such block at point."
11933 (let ((pos (point))
11934 beg)
11935 (end-of-line 1)
11936 (if (and (re-search-backward org-dblock-start-re nil t)
11937 (setq beg (match-beginning 0))
11938 (re-search-forward org-dblock-end-re nil t)
11939 (> (match-end 0) pos))
11940 (goto-char beg)
11941 (goto-char pos)
11942 (error "Not in a dynamic block"))))
11944 (defun org-update-all-dblocks ()
11945 "Update all dynamic blocks in the buffer.
11946 This function can be used in a hook."
11947 (interactive)
11948 (when (derived-mode-p 'org-mode)
11949 (org-map-dblocks 'org-update-dblock)))
11952 ;;;; Completion
11954 (declare-function org-export-backend-name "org-export" (cl-x))
11955 (declare-function org-export-backend-options "org-export" (cl-x))
11956 (defun org-get-export-keywords ()
11957 "Return a list of all currently understood export keywords.
11958 Export keywords include options, block names, attributes and
11959 keywords relative to each registered export back-end."
11960 (let (keywords)
11961 (dolist (backend
11962 (org-bound-and-true-p org-export--registered-backends)
11963 (delq nil keywords))
11964 ;; Back-end name (for keywords, like #+LATEX:)
11965 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
11966 (dolist (option-entry (org-export-backend-options backend))
11967 ;; Back-end options.
11968 (push (nth 1 option-entry) keywords)))))
11970 (defconst org-options-keywords
11971 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11972 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11973 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11974 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11975 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11977 (defcustom org-structure-template-alist
11978 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
11979 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
11980 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
11981 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
11982 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
11983 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
11984 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
11985 "<literal style=\"latex\">\n?\n</literal>")
11986 ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
11987 ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
11988 "<literal style=\"html\">\n?\n</literal>")
11989 ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
11990 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
11991 ("A" "#+ASCII: " "")
11992 ("i" "#+INDEX: ?" "#+INDEX: ?")
11993 ("I" "#+INCLUDE: %file ?"
11994 "<include file=%file markup=\"?\">"))
11995 "Structure completion elements.
11996 This is a list of abbreviation keys and values. The value gets inserted
11997 if you type `<' followed by the key and then press the completion key,
11998 usually `M-TAB'. %file will be replaced by a file name after prompting
11999 for the file using completion. The cursor will be placed at the position
12000 of the `?` in the template.
12001 There are two templates for each key, the first uses the original Org syntax,
12002 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12003 the default when the /org-mtags.el/ module has been loaded. See also the
12004 variable `org-mtags-prefer-muse-templates'."
12005 :group 'org-completion
12006 :type '(repeat
12007 (list
12008 (string :tag "Key")
12009 (string :tag "Template")
12010 (string :tag "Muse Template"))))
12012 (defun org-try-structure-completion ()
12013 "Try to complete a structure template before point.
12014 This looks for strings like \"<e\" on an otherwise empty line and
12015 expands them."
12016 (let ((l (buffer-substring (point-at-bol) (point)))
12018 (when (and (looking-at "[ \t]*$")
12019 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12020 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12021 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12022 (match-beginning 1)) a)
12023 t)))
12025 (defun org-complete-expand-structure-template (start cell)
12026 "Expand a structure template."
12027 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12028 (rpl (nth (if musep 2 1) cell))
12029 (ind ""))
12030 (delete-region start (point))
12031 (when (string-match "\\`#\\+" rpl)
12032 (cond
12033 ((bolp))
12034 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12035 (setq ind (buffer-substring (point-at-bol) (point))))
12036 (t (newline))))
12037 (setq start (point))
12038 (if (string-match "%file" rpl)
12039 (setq rpl (replace-match
12040 (concat
12041 "\""
12042 (save-match-data
12043 (abbreviate-file-name (read-file-name "Include file: ")))
12044 "\"")
12045 t t rpl)))
12046 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12047 (concat "\n" ind)))
12048 (insert rpl)
12049 (if (re-search-backward "\\?" start t) (delete-char 1))))
12051 ;;;; TODO, DEADLINE, Comments
12053 (defun org-toggle-comment ()
12054 "Change the COMMENT state of an entry."
12055 (interactive)
12056 (save-excursion
12057 (org-back-to-heading)
12058 (let (case-fold-search)
12059 (cond
12060 ((looking-at (format org-heading-keyword-regexp-format
12061 org-comment-string))
12062 (goto-char (match-end 1))
12063 (looking-at (concat " +" org-comment-string))
12064 (replace-match "" t t)
12065 (when (eolp) (insert " ")))
12066 ((looking-at org-outline-regexp)
12067 (goto-char (match-end 0))
12068 (insert org-comment-string " "))))))
12070 (defvar org-last-todo-state-is-todo nil
12071 "This is non-nil when the last TODO state change led to a TODO state.
12072 If the last change removed the TODO tag or switched to DONE, then
12073 this is nil.")
12075 (defvar org-setting-tags nil) ; dynamically skipped
12077 (defvar org-todo-setup-filter-hook nil
12078 "Hook for functions that pre-filter todo specs.
12079 Each function takes a todo spec and returns either nil or the spec
12080 transformed into canonical form." )
12082 (defvar org-todo-get-default-hook nil
12083 "Hook for functions that get a default item for todo.
12084 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12085 nil or a string to be used for the todo mark." )
12087 (defvar org-agenda-headline-snapshot-before-repeat)
12089 (defun org-current-effective-time ()
12090 "Return current time adjusted for `org-extend-today-until' variable."
12091 (let* ((ct (org-current-time))
12092 (dct (decode-time ct))
12093 (ct1
12094 (cond
12095 (org-use-last-clock-out-time-as-effective-time
12096 (or (org-clock-get-last-clock-out-time) ct))
12097 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12098 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12099 (t ct))))
12100 ct1))
12102 (defun org-todo-yesterday (&optional arg)
12103 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12104 (interactive "P")
12105 (if (eq major-mode 'org-agenda-mode)
12106 (apply 'org-agenda-todo-yesterday arg)
12107 (let* ((hour (third (decode-time
12108 (org-current-time))))
12109 (org-extend-today-until (1+ hour)))
12110 (org-todo arg))))
12112 (defvar org-block-entry-blocking ""
12113 "First entry preventing the TODO state change.")
12115 (defun org-todo (&optional arg)
12116 "Change the TODO state of an item.
12117 The state of an item is given by a keyword at the start of the heading,
12118 like
12119 *** TODO Write paper
12120 *** DONE Call mom
12122 The different keywords are specified in the variable `org-todo-keywords'.
12123 By default the available states are \"TODO\" and \"DONE\".
12124 So for this example: when the item starts with TODO, it is changed to DONE.
12125 When it starts with DONE, the DONE is removed. And when neither TODO nor
12126 DONE are present, add TODO at the beginning of the heading.
12128 With \\[universal-argument] prefix arg, use completion to determine the new \
12129 state.
12130 With numeric prefix arg, switch to that state.
12131 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12132 keywords (nextset).
12133 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12134 With a numeric prefix arg of 0, inhibit note taking for the change.
12136 For calling through lisp, arg is also interpreted in the following way:
12137 'none -> empty state
12138 \"\"(empty string) -> switch to empty state
12139 'done -> switch to DONE
12140 'nextset -> switch to the next set of keywords
12141 'previousset -> switch to the previous set of keywords
12142 \"WAITING\" -> switch to the specified keyword, but only if it
12143 really is a member of `org-todo-keywords'."
12144 (interactive "P")
12145 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12146 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12147 'region-start-level 'region))
12148 org-loop-over-headlines-in-active-region)
12149 (org-map-entries
12150 `(org-todo ,arg)
12151 org-loop-over-headlines-in-active-region
12152 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12153 (if (equal arg '(16)) (setq arg 'nextset))
12154 (let ((org-blocker-hook org-blocker-hook)
12155 commentp
12156 case-fold-search)
12157 (when (equal arg '(64))
12158 (setq arg nil org-blocker-hook nil))
12159 (when (and org-blocker-hook
12160 (or org-inhibit-blocking
12161 (org-entry-get nil "NOBLOCKING")))
12162 (setq org-blocker-hook nil))
12163 (save-excursion
12164 (catch 'exit
12165 (org-back-to-heading t)
12166 (when (looking-at (concat "^\\*+ " org-comment-string))
12167 (org-toggle-comment)
12168 (setq commentp t))
12169 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12170 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12171 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12172 (let* ((match-data (match-data))
12173 (startpos (point-at-bol))
12174 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12175 (org-log-done org-log-done)
12176 (org-log-repeat org-log-repeat)
12177 (org-todo-log-states org-todo-log-states)
12178 (org-inhibit-logging
12179 (if (equal arg 0)
12180 (progn (setq arg nil) 'note) org-inhibit-logging))
12181 (this (match-string 1))
12182 (hl-pos (match-beginning 0))
12183 (head (org-get-todo-sequence-head this))
12184 (ass (assoc head org-todo-kwd-alist))
12185 (interpret (nth 1 ass))
12186 (done-word (nth 3 ass))
12187 (final-done-word (nth 4 ass))
12188 (org-last-state (or this ""))
12189 (completion-ignore-case t)
12190 (member (member this org-todo-keywords-1))
12191 (tail (cdr member))
12192 (org-state (cond
12193 ((and org-todo-key-trigger
12194 (or (and (equal arg '(4))
12195 (eq org-use-fast-todo-selection 'prefix))
12196 (and (not arg) org-use-fast-todo-selection
12197 (not (eq org-use-fast-todo-selection
12198 'prefix)))))
12199 ;; Use fast selection
12200 (org-fast-todo-selection))
12201 ((and (equal arg '(4))
12202 (or (not org-use-fast-todo-selection)
12203 (not org-todo-key-trigger)))
12204 ;; Read a state with completion
12205 (org-icompleting-read
12206 "State: " (mapcar 'list org-todo-keywords-1)
12207 nil t))
12208 ((eq arg 'right)
12209 (if this
12210 (if tail (car tail) nil)
12211 (car org-todo-keywords-1)))
12212 ((eq arg 'left)
12213 (if (equal member org-todo-keywords-1)
12215 (if this
12216 (nth (- (length org-todo-keywords-1)
12217 (length tail) 2)
12218 org-todo-keywords-1)
12219 (org-last org-todo-keywords-1))))
12220 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12221 (setq arg nil))) ; hack to fall back to cycling
12222 (arg
12223 ;; user or caller requests a specific state
12224 (cond
12225 ((equal arg "") nil)
12226 ((eq arg 'none) nil)
12227 ((eq arg 'done) (or done-word (car org-done-keywords)))
12228 ((eq arg 'nextset)
12229 (or (car (cdr (member head org-todo-heads)))
12230 (car org-todo-heads)))
12231 ((eq arg 'previousset)
12232 (let ((org-todo-heads (reverse org-todo-heads)))
12233 (or (car (cdr (member head org-todo-heads)))
12234 (car org-todo-heads))))
12235 ((car (member arg org-todo-keywords-1)))
12236 ((stringp arg)
12237 (user-error "State `%s' not valid in this file" arg))
12238 ((nth (1- (prefix-numeric-value arg))
12239 org-todo-keywords-1))))
12240 ((null member) (or head (car org-todo-keywords-1)))
12241 ((equal this final-done-word) nil) ;; -> make empty
12242 ((null tail) nil) ;; -> first entry
12243 ((memq interpret '(type priority))
12244 (if (eq this-command last-command)
12245 (car tail)
12246 (if (> (length tail) 0)
12247 (or done-word (car org-done-keywords))
12248 nil)))
12250 (car tail))))
12251 (org-state (or
12252 (run-hook-with-args-until-success
12253 'org-todo-get-default-hook org-state org-last-state)
12254 org-state))
12255 (next (if org-state (concat " " org-state " ") " "))
12256 (change-plist (list :type 'todo-state-change :from this :to org-state
12257 :position startpos))
12258 dolog now-done-p)
12259 (when org-blocker-hook
12260 (setq org-last-todo-state-is-todo
12261 (not (member this org-done-keywords)))
12262 (unless (save-excursion
12263 (save-match-data
12264 (org-with-wide-buffer
12265 (run-hook-with-args-until-failure
12266 'org-blocker-hook change-plist))))
12267 (if (org-called-interactively-p 'interactive)
12268 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12269 this org-state org-block-entry-blocking)
12270 ;; fail silently
12271 (message "TODO state change from %s to %s blocked (by \"%s\")"
12272 this org-state org-block-entry-blocking)
12273 (throw 'exit nil))))
12274 (store-match-data match-data)
12275 (replace-match next t t)
12276 (unless (pos-visible-in-window-p hl-pos)
12277 (message "TODO state changed to %s" (org-trim next)))
12278 (unless head
12279 (setq head (org-get-todo-sequence-head org-state)
12280 ass (assoc head org-todo-kwd-alist)
12281 interpret (nth 1 ass)
12282 done-word (nth 3 ass)
12283 final-done-word (nth 4 ass)))
12284 (when (memq arg '(nextset previousset))
12285 (message "Keyword-Set %d/%d: %s"
12286 (- (length org-todo-sets) -1
12287 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12288 (length org-todo-sets)
12289 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12290 (setq org-last-todo-state-is-todo
12291 (not (member org-state org-done-keywords)))
12292 (setq now-done-p (and (member org-state org-done-keywords)
12293 (not (member this org-done-keywords))))
12294 (and logging (org-local-logging logging))
12295 (when (and (or org-todo-log-states org-log-done)
12296 (not (eq org-inhibit-logging t))
12297 (not (memq arg '(nextset previousset))))
12298 ;; we need to look at recording a time and note
12299 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12300 (nth 2 (assoc this org-todo-log-states))))
12301 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12302 (setq dolog 'time))
12303 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12304 (and org-state
12305 (member org-state org-not-done-keywords)
12306 (not (member this org-not-done-keywords))))
12307 ;; This is now a todo state and was not one before
12308 ;; If there was a CLOSED time stamp, get rid of it.
12309 (org-add-planning-info nil nil 'closed))
12310 (when (and now-done-p org-log-done)
12311 ;; It is now done, and it was not done before
12312 (org-add-planning-info 'closed (org-current-effective-time))
12313 (if (and (not dolog) (eq 'note org-log-done))
12314 (org-add-log-setup 'done org-state this 'findpos 'note)))
12315 (when (and org-state dolog)
12316 ;; This is a non-nil state, and we need to log it
12317 (org-add-log-setup 'state org-state this 'findpos dolog)))
12318 ;; Fixup tag positioning
12319 (org-todo-trigger-tag-changes org-state)
12320 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12321 (when org-provide-todo-statistics
12322 (org-update-parent-todo-statistics))
12323 (run-hooks 'org-after-todo-state-change-hook)
12324 (if (and arg (not (member org-state org-done-keywords)))
12325 (setq head (org-get-todo-sequence-head org-state)))
12326 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12327 ;; Do we need to trigger a repeat?
12328 (when now-done-p
12329 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12330 ;; This is for the agenda, take a snapshot of the headline.
12331 (save-match-data
12332 (setq org-agenda-headline-snapshot-before-repeat
12333 (org-get-heading))))
12334 (org-auto-repeat-maybe org-state))
12335 ;; Fixup cursor location if close to the keyword
12336 (if (and (outline-on-heading-p)
12337 (not (bolp))
12338 (save-excursion (beginning-of-line 1)
12339 (looking-at org-todo-line-regexp))
12340 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12341 (progn
12342 (goto-char (or (match-end 2) (match-end 1)))
12343 (and (looking-at " ") (just-one-space))))
12344 (when org-trigger-hook
12345 (save-excursion
12346 (run-hook-with-args 'org-trigger-hook change-plist)))
12347 (when commentp (org-toggle-comment))))))))
12349 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12350 "Block turning an entry into a TODO, using the hierarchy.
12351 This checks whether the current task should be blocked from state
12352 changes. Such blocking occurs when:
12354 1. The task has children which are not all in a completed state.
12356 2. A task has a parent with the property :ORDERED:, and there
12357 are siblings prior to the current task with incomplete
12358 status.
12360 3. The parent of the task is blocked because it has siblings that should
12361 be done first, or is child of a block grandparent TODO entry."
12363 (if (not org-enforce-todo-dependencies)
12364 t ; if locally turned off don't block
12365 (catch 'dont-block
12366 ;; If this is not a todo state change, or if this entry is already DONE,
12367 ;; do not block
12368 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12369 (member (plist-get change-plist :from)
12370 (cons 'done org-done-keywords))
12371 (member (plist-get change-plist :to)
12372 (cons 'todo org-not-done-keywords))
12373 (not (plist-get change-plist :to)))
12374 (throw 'dont-block t))
12375 ;; If this task has children, and any are undone, it's blocked
12376 (save-excursion
12377 (org-back-to-heading t)
12378 (let ((this-level (funcall outline-level)))
12379 (outline-next-heading)
12380 (let ((child-level (funcall outline-level)))
12381 (while (and (not (eobp))
12382 (> child-level this-level))
12383 ;; this todo has children, check whether they are all
12384 ;; completed
12385 (if (and (not (org-entry-is-done-p))
12386 (org-entry-is-todo-p))
12387 (progn (setq org-block-entry-blocking (org-get-heading))
12388 (throw 'dont-block nil)))
12389 (outline-next-heading)
12390 (setq child-level (funcall outline-level))))))
12391 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12392 ;; any previous siblings are undone, it's blocked
12393 (save-excursion
12394 (org-back-to-heading t)
12395 (let* ((pos (point))
12396 (parent-pos (and (org-up-heading-safe) (point))))
12397 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12398 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12399 (forward-line 1)
12400 (re-search-forward org-not-done-heading-regexp pos t))
12401 (setq org-block-entry-blocking (match-string 0))
12402 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12403 ;; Search further up the hierarchy, to see if an ancestor is blocked
12404 (while t
12405 (goto-char parent-pos)
12406 (if (not (looking-at org-not-done-heading-regexp))
12407 (throw 'dont-block t)) ; do not block, parent is not a TODO
12408 (setq pos (point))
12409 (setq parent-pos (and (org-up-heading-safe) (point)))
12410 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12411 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12412 (forward-line 1)
12413 (re-search-forward org-not-done-heading-regexp pos t)
12414 (setq org-block-entry-blocking (org-get-heading)))
12415 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12417 (defcustom org-track-ordered-property-with-tag nil
12418 "Should the ORDERED property also be shown as a tag?
12419 The ORDERED property decides if an entry should require subtasks to be
12420 completed in sequence. Since a property is not very visible, setting
12421 this option means that toggling the ORDERED property with the command
12422 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12423 not relevant for the behavior, but it makes things more visible.
12425 Note that toggling the tag with tags commands will not change the property
12426 and therefore not influence behavior!
12428 This can be t, meaning the tag ORDERED should be used, It can also be a
12429 string to select a different tag for this task."
12430 :group 'org-todo
12431 :type '(choice
12432 (const :tag "No tracking" nil)
12433 (const :tag "Track with ORDERED tag" t)
12434 (string :tag "Use other tag")))
12436 (defun org-toggle-ordered-property ()
12437 "Toggle the ORDERED property of the current entry.
12438 For better visibility, you can track the value of this property with a tag.
12439 See variable `org-track-ordered-property-with-tag'."
12440 (interactive)
12441 (let* ((t1 org-track-ordered-property-with-tag)
12442 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12443 (save-excursion
12444 (org-back-to-heading)
12445 (if (org-entry-get nil "ORDERED")
12446 (progn
12447 (org-delete-property "ORDERED" "PROPERTIES")
12448 (and tag (org-toggle-tag tag 'off))
12449 (message "Subtasks can be completed in arbitrary order"))
12450 (org-entry-put nil "ORDERED" "t")
12451 (and tag (org-toggle-tag tag 'on))
12452 (message "Subtasks must be completed in sequence")))))
12454 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12455 (defun org-block-todo-from-checkboxes (change-plist)
12456 "Block turning an entry into a TODO, using checkboxes.
12457 This checks whether the current task should be blocked from state
12458 changes because there are unchecked boxes in this entry."
12459 (if (not org-enforce-todo-checkbox-dependencies)
12460 t ; if locally turned off don't block
12461 (catch 'dont-block
12462 ;; If this is not a todo state change, or if this entry is already DONE,
12463 ;; do not block
12464 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12465 (member (plist-get change-plist :from)
12466 (cons 'done org-done-keywords))
12467 (member (plist-get change-plist :to)
12468 (cons 'todo org-not-done-keywords))
12469 (not (plist-get change-plist :to)))
12470 (throw 'dont-block t))
12471 ;; If this task has checkboxes that are not checked, it's blocked
12472 (save-excursion
12473 (org-back-to-heading t)
12474 (let ((beg (point)) end)
12475 (outline-next-heading)
12476 (setq end (point))
12477 (goto-char beg)
12478 (if (org-list-search-forward
12479 (concat (org-item-beginning-re)
12480 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12481 "\\[[- ]\\]")
12482 end t)
12483 (progn
12484 (if (boundp 'org-blocked-by-checkboxes)
12485 (setq org-blocked-by-checkboxes t))
12486 (throw 'dont-block nil)))))
12487 t))) ; do not block
12489 (defun org-entry-blocked-p ()
12490 "Is the current entry blocked?"
12491 (org-with-silent-modifications
12492 (if (org-entry-get nil "NOBLOCKING")
12493 nil ;; Never block this entry
12494 (not (run-hook-with-args-until-failure
12495 'org-blocker-hook
12496 (list :type 'todo-state-change
12497 :position (point)
12498 :from 'todo
12499 :to 'done))))))
12501 (defun org-update-statistics-cookies (all)
12502 "Update the statistics cookie, either from TODO or from checkboxes.
12503 This should be called with the cursor in a line with a statistics cookie."
12504 (interactive "P")
12505 (if all
12506 (progn
12507 (org-update-checkbox-count 'all)
12508 (org-map-entries 'org-update-parent-todo-statistics))
12509 (if (not (org-at-heading-p))
12510 (org-update-checkbox-count)
12511 (let ((pos (point-marker))
12512 end l1 l2)
12513 (ignore-errors (org-back-to-heading t))
12514 (if (not (org-at-heading-p))
12515 (org-update-checkbox-count)
12516 (setq l1 (org-outline-level))
12517 (setq end (save-excursion
12518 (outline-next-heading)
12519 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12520 (point)))
12521 (if (and (save-excursion
12522 (re-search-forward
12523 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12524 (not (save-excursion (re-search-forward
12525 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12526 (org-update-checkbox-count)
12527 (if (and l2 (> l2 l1))
12528 (progn
12529 (goto-char end)
12530 (org-update-parent-todo-statistics))
12531 (goto-char pos)
12532 (beginning-of-line 1)
12533 (while (re-search-forward
12534 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12535 (point-at-eol) t)
12536 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12537 (goto-char pos)
12538 (move-marker pos nil)))))
12540 (defvar org-entry-property-inherited-from) ;; defined below
12541 (defun org-update-parent-todo-statistics ()
12542 "Update any statistics cookie in the parent of the current headline.
12543 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12544 the entire subtree and this will travel up the hierarchy and update
12545 statistics everywhere."
12546 (let* ((prop (save-excursion (org-up-heading-safe)
12547 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12548 (recursive (or (not org-hierarchical-todo-statistics)
12549 (and prop (string-match "\\<recursive\\>" prop))))
12550 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12552 (first t)
12553 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12554 level ltoggle l1 new ndel
12555 (cnt-all 0) (cnt-done 0) is-percent kwd
12556 checkbox-beg ov ovs ove cookie-present)
12557 (catch 'exit
12558 (save-excursion
12559 (beginning-of-line 1)
12560 (setq ltoggle (funcall outline-level))
12561 ;; Three situations are to consider:
12563 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12564 ;; to the top-level ancestor on the headline;
12566 ;; 2. If parent has "recursive" property, repeat up to the
12567 ;; headline setting that property, taking inheritance into
12568 ;; account;
12570 ;; 3. Else, move up to direct parent and proceed only once.
12571 (while (and (setq level (org-up-heading-safe))
12572 (or recursive first)
12573 (>= (point) lim))
12574 (setq first nil cookie-present nil)
12575 (unless (and level
12576 (not (string-match
12577 "\\<checkbox\\>"
12578 (downcase (or (org-entry-get nil "COOKIE_DATA")
12579 "")))))
12580 (throw 'exit nil))
12581 (while (re-search-forward box-re (point-at-eol) t)
12582 (setq cnt-all 0 cnt-done 0 cookie-present t)
12583 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12584 (save-match-data
12585 (unless (outline-next-heading) (throw 'exit nil))
12586 (while (and (looking-at org-complex-heading-regexp)
12587 (> (setq l1 (length (match-string 1))) level))
12588 (setq kwd (and (or recursive (= l1 ltoggle))
12589 (match-string 2)))
12590 (if (or (eq org-provide-todo-statistics 'all-headlines)
12591 (and (listp org-provide-todo-statistics)
12592 (or (member kwd org-provide-todo-statistics)
12593 (member kwd org-done-keywords))))
12594 (setq cnt-all (1+ cnt-all))
12595 (if (eq org-provide-todo-statistics t)
12596 (and kwd (setq cnt-all (1+ cnt-all)))))
12597 (and (member kwd org-done-keywords)
12598 (setq cnt-done (1+ cnt-done)))
12599 (outline-next-heading)))
12600 (setq new
12601 (if is-percent
12602 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12603 (format "[%d/%d]" cnt-done cnt-all))
12604 ndel (- (match-end 0) checkbox-beg))
12605 ;; handle overlays when updating cookie from column view
12606 (when (setq ov (car (overlays-at checkbox-beg)))
12607 (setq ovs (overlay-start ov) ove (overlay-end ov))
12608 (delete-overlay ov))
12609 (goto-char checkbox-beg)
12610 (insert new)
12611 (delete-region (point) (+ (point) ndel))
12612 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12613 (when ov (move-overlay ov ovs ove)))
12614 (when cookie-present
12615 (run-hook-with-args 'org-after-todo-statistics-hook
12616 cnt-done (- cnt-all cnt-done))))))
12617 (run-hooks 'org-todo-statistics-hook)))
12619 (defvar org-after-todo-statistics-hook nil
12620 "Hook that is called after a TODO statistics cookie has been updated.
12621 Each function is called with two arguments: the number of not-done entries
12622 and the number of done entries.
12624 For example, the following function, when added to this hook, will switch
12625 an entry to DONE when all children are done, and back to TODO when new
12626 entries are set to a TODO status. Note that this hook is only called
12627 when there is a statistics cookie in the headline!
12629 (defun org-summary-todo (n-done n-not-done)
12630 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12631 (let (org-log-done org-log-states) ; turn off logging
12632 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12635 (defvar org-todo-statistics-hook nil
12636 "Hook that is run whenever Org thinks TODO statistics should be updated.
12637 This hook runs even if there is no statistics cookie present, in which case
12638 `org-after-todo-statistics-hook' would not run.")
12640 (defun org-todo-trigger-tag-changes (state)
12641 "Apply the changes defined in `org-todo-state-tags-triggers'."
12642 (let ((l org-todo-state-tags-triggers)
12643 changes)
12644 (when (or (not state) (equal state ""))
12645 (setq changes (append changes (cdr (assoc "" l)))))
12646 (when (and (stringp state) (> (length state) 0))
12647 (setq changes (append changes (cdr (assoc state l)))))
12648 (when (member state org-not-done-keywords)
12649 (setq changes (append changes (cdr (assoc 'todo l)))))
12650 (when (member state org-done-keywords)
12651 (setq changes (append changes (cdr (assoc 'done l)))))
12652 (dolist (c changes)
12653 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12655 (defun org-local-logging (value)
12656 "Get logging settings from a property VALUE."
12657 (let* (words w a)
12658 ;; directly set the variables, they are already local.
12659 (setq org-log-done nil
12660 org-log-repeat nil
12661 org-todo-log-states nil)
12662 (setq words (org-split-string value))
12663 (while (setq w (pop words))
12664 (cond
12665 ((setq a (assoc w org-startup-options))
12666 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12667 (set (nth 1 a) (nth 2 a))))
12668 ((setq a (org-extract-log-state-settings w))
12669 (and (member (car a) org-todo-keywords-1)
12670 (push a org-todo-log-states)))))))
12672 (defun org-get-todo-sequence-head (kwd)
12673 "Return the head of the TODO sequence to which KWD belongs.
12674 If KWD is not set, check if there is a text property remembering the
12675 right sequence."
12676 (let (p)
12677 (cond
12678 ((not kwd)
12679 (or (get-text-property (point-at-bol) 'org-todo-head)
12680 (progn
12681 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12682 nil (point-at-eol)))
12683 (get-text-property p 'org-todo-head))))
12684 ((not (member kwd org-todo-keywords-1))
12685 (car org-todo-keywords-1))
12686 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12688 (defun org-fast-todo-selection ()
12689 "Fast TODO keyword selection with single keys.
12690 Returns the new TODO keyword, or nil if no state change should occur."
12691 (let* ((fulltable org-todo-key-alist)
12692 (done-keywords org-done-keywords) ;; needed for the faces.
12693 (maxlen (apply 'max (mapcar
12694 (lambda (x)
12695 (if (stringp (car x)) (string-width (car x)) 0))
12696 fulltable)))
12697 (expert nil)
12698 (fwidth (+ maxlen 3 1 3))
12699 (ncol (/ (- (window-width) 4) fwidth))
12700 tg cnt e c tbl
12701 groups ingroup)
12702 (save-excursion
12703 (save-window-excursion
12704 (if expert
12705 (set-buffer (get-buffer-create " *Org todo*"))
12706 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12707 (erase-buffer)
12708 (org-set-local 'org-done-keywords done-keywords)
12709 (setq tbl fulltable cnt 0)
12710 (while (setq e (pop tbl))
12711 (cond
12712 ((equal e '(:startgroup))
12713 (push '() groups) (setq ingroup t)
12714 (when (not (= cnt 0))
12715 (setq cnt 0)
12716 (insert "\n"))
12717 (insert "{ "))
12718 ((equal e '(:endgroup))
12719 (setq ingroup nil cnt 0)
12720 (insert "}\n"))
12721 ((equal e '(:newline))
12722 (when (not (= cnt 0))
12723 (setq cnt 0)
12724 (insert "\n")
12725 (setq e (car tbl))
12726 (while (equal (car tbl) '(:newline))
12727 (insert "\n")
12728 (setq tbl (cdr tbl)))))
12730 (setq tg (car e) c (cdr e))
12731 (if ingroup (push tg (car groups)))
12732 (setq tg (org-add-props tg nil 'face
12733 (org-get-todo-face tg)))
12734 (if (and (= cnt 0) (not ingroup)) (insert " "))
12735 (insert "[" c "] " tg (make-string
12736 (- fwidth 4 (length tg)) ?\ ))
12737 (when (= (setq cnt (1+ cnt)) ncol)
12738 (insert "\n")
12739 (if ingroup (insert " "))
12740 (setq cnt 0)))))
12741 (insert "\n")
12742 (goto-char (point-min))
12743 (if (not expert) (org-fit-window-to-buffer))
12744 (message "[a-z..]:Set [SPC]:clear")
12745 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12746 (cond
12747 ((or (= c ?\C-g)
12748 (and (= c ?q) (not (rassoc c fulltable))))
12749 (setq quit-flag t))
12750 ((= c ?\ ) nil)
12751 ((setq e (rassoc c fulltable) tg (car e))
12753 (t (setq quit-flag t)))))))
12755 (defun org-entry-is-todo-p ()
12756 (member (org-get-todo-state) org-not-done-keywords))
12758 (defun org-entry-is-done-p ()
12759 (member (org-get-todo-state) org-done-keywords))
12761 (defun org-get-todo-state ()
12762 "Return the TODO keyword of the current subtree."
12763 (save-excursion
12764 (org-back-to-heading t)
12765 (and (looking-at org-todo-line-regexp)
12766 (match-end 2)
12767 (match-string 2))))
12769 (defun org-at-date-range-p (&optional inactive-ok)
12770 "Is the cursor inside a date range?"
12771 (interactive)
12772 (save-excursion
12773 (catch 'exit
12774 (let ((pos (point)))
12775 (skip-chars-backward "^[<\r\n")
12776 (skip-chars-backward "<[")
12777 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12778 (>= (match-end 0) pos)
12779 (throw 'exit t))
12780 (skip-chars-backward "^<[\r\n")
12781 (skip-chars-backward "<[")
12782 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12783 (>= (match-end 0) pos)
12784 (throw 'exit t)))
12785 nil)))
12787 (defun org-get-repeat (&optional tagline)
12788 "Check if there is a deadline/schedule with repeater in this entry."
12789 (save-match-data
12790 (save-excursion
12791 (org-back-to-heading t)
12792 (and (re-search-forward (if tagline
12793 (concat tagline "\\s-*" org-repeat-re)
12794 org-repeat-re)
12795 (org-entry-end-position) t)
12796 (match-string-no-properties 1)))))
12798 (defvar org-last-changed-timestamp)
12799 (defvar org-last-inserted-timestamp)
12800 (defvar org-log-post-message)
12801 (defvar org-log-note-purpose)
12802 (defvar org-log-note-how)
12803 (defvar org-log-note-extra)
12804 (defun org-auto-repeat-maybe (done-word)
12805 "Check if the current headline contains a repeated deadline/schedule.
12806 If yes, set TODO state back to what it was and change the base date
12807 of repeating deadline/scheduled time stamps to new date.
12808 This function is run automatically after each state change to a DONE state."
12809 ;; last-state is dynamically scoped into this function
12810 (let* ((repeat (org-get-repeat))
12811 (aa (assoc org-last-state org-todo-kwd-alist))
12812 (interpret (nth 1 aa))
12813 (head (nth 2 aa))
12814 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12815 (msg "Entry repeats: ")
12816 (org-log-done nil)
12817 (org-todo-log-states nil)
12818 re type n what ts time to-state)
12819 (when repeat
12820 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12821 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12822 org-todo-repeat-to-state))
12823 (unless (and to-state (member to-state org-todo-keywords-1))
12824 (setq to-state (if (eq interpret 'type) org-last-state head)))
12825 (org-todo to-state)
12826 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12827 (org-entry-put nil "LAST_REPEAT" (format-time-string
12828 (org-time-stamp-format t t))))
12829 (when org-log-repeat
12830 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12831 (memq 'org-add-log-note post-command-hook))
12832 ;; OK, we are already setup for some record
12833 (if (eq org-log-repeat 'note)
12834 ;; make sure we take a note, not only a time stamp
12835 (setq org-log-note-how 'note))
12836 ;; Set up for taking a record
12837 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12838 org-last-state
12839 'findpos org-log-repeat)))
12840 (org-back-to-heading t)
12841 (org-add-planning-info nil nil 'closed)
12842 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12843 org-deadline-time-regexp "\\)\\|\\("
12844 org-ts-regexp "\\)"))
12845 (while (re-search-forward
12846 re (save-excursion (outline-next-heading) (point)) t)
12847 (setq type (if (match-end 1) org-scheduled-string
12848 (if (match-end 3) org-deadline-string "Plain:"))
12849 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12850 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
12851 (setq n (string-to-number (match-string 2 ts))
12852 what (match-string 3 ts))
12853 (if (equal what "w") (setq n (* n 7) what "d"))
12854 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
12855 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12856 ;; Preparation, see if we need to modify the start date for the change
12857 (when (match-end 1)
12858 (setq time (save-match-data (org-time-string-to-time ts)))
12859 (cond
12860 ((equal (match-string 1 ts) ".")
12861 ;; Shift starting date to today
12862 (org-timestamp-change
12863 (- (org-today) (time-to-days time))
12864 'day))
12865 ((equal (match-string 1 ts) "+")
12866 (let ((nshiftmax 10) (nshift 0))
12867 (while (or (= nshift 0)
12868 (<= (time-to-days time)
12869 (time-to-days (current-time))))
12870 (when (= (incf nshift) nshiftmax)
12871 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12872 (error "Abort")))
12873 (org-timestamp-change n (cdr (assoc what whata)))
12874 (org-at-timestamp-p t)
12875 (setq ts (match-string 1))
12876 (setq time (save-match-data (org-time-string-to-time ts)))))
12877 (org-timestamp-change (- n) (cdr (assoc what whata)))
12878 ;; rematch, so that we have everything in place for the real shift
12879 (org-at-timestamp-p t)
12880 (setq ts (match-string 1))
12881 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
12882 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12883 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12884 (setq org-log-post-message msg)
12885 (message "%s" msg))))
12887 (defun org-show-todo-tree (arg)
12888 "Make a compact tree which shows all headlines marked with TODO.
12889 The tree will show the lines where the regexp matches, and all higher
12890 headlines above the match.
12891 With a \\[universal-argument] prefix, prompt for a regexp to match.
12892 With a numeric prefix N, construct a sparse tree for the Nth element
12893 of `org-todo-keywords-1'."
12894 (interactive "P")
12895 (let ((case-fold-search nil)
12896 (kwd-re
12897 (cond ((null arg) org-not-done-regexp)
12898 ((equal arg '(4))
12899 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12900 (mapcar 'list org-todo-keywords-1))))
12901 (concat "\\("
12902 (mapconcat 'identity (org-split-string kwd "|") "\\|")
12903 "\\)\\>")))
12904 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12905 (regexp-quote (nth (1- (prefix-numeric-value arg))
12906 org-todo-keywords-1)))
12907 (t (user-error "Invalid prefix argument: %s" arg)))))
12908 (message "%d TODO entries found"
12909 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12911 (defun org-deadline (arg &optional time)
12912 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
12913 With one universal prefix argument, remove any deadline from the item.
12914 With two universal prefix arguments, prompt for a warning delay.
12915 With argument TIME, set the deadline at the corresponding date. TIME
12916 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
12917 (interactive "P")
12918 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12919 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12920 'region-start-level 'region))
12921 org-loop-over-headlines-in-active-region)
12922 (org-map-entries
12923 `(org-deadline ',arg ,time)
12924 org-loop-over-headlines-in-active-region
12925 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12926 (let* ((old-date (org-entry-get nil "DEADLINE"))
12927 (old-date-time (if old-date (org-time-string-to-time old-date)))
12928 (repeater (and old-date
12929 (string-match
12930 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
12931 old-date)
12932 (match-string 1 old-date))))
12933 (cond
12934 ((equal arg '(4))
12935 (when (and old-date org-log-redeadline)
12936 (org-add-log-setup 'deldeadline nil old-date 'findpos
12937 org-log-redeadline))
12938 (org-remove-timestamp-with-keyword org-deadline-string)
12939 (message "Item no longer has a deadline."))
12940 ((equal arg '(16))
12941 (save-excursion
12942 (org-back-to-heading t)
12943 (if (re-search-forward
12944 org-deadline-time-regexp
12945 (save-excursion (outline-next-heading) (point)) t)
12946 (let* ((rpl0 (match-string 1))
12947 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12948 (replace-match
12949 (concat org-deadline-string
12950 " <" rpl
12951 (format " -%dd"
12952 (abs
12953 (- (time-to-days
12954 (save-match-data
12955 (org-read-date nil t nil "Warn starting from" old-date-time)))
12956 (time-to-days old-date-time))))
12957 ">") t t))
12958 (user-error "No deadline information to update"))))
12960 (org-add-planning-info 'deadline time 'closed)
12961 (when (and old-date org-log-redeadline
12962 (not (equal old-date
12963 (substring org-last-inserted-timestamp 1 -1))))
12964 (org-add-log-setup 'redeadline nil old-date 'findpos
12965 org-log-redeadline))
12966 (when repeater
12967 (save-excursion
12968 (org-back-to-heading t)
12969 (when (re-search-forward (concat org-deadline-string " "
12970 org-last-inserted-timestamp)
12971 (save-excursion
12972 (outline-next-heading) (point)) t)
12973 (goto-char (1- (match-end 0)))
12974 (insert " " repeater)
12975 (setq org-last-inserted-timestamp
12976 (concat (substring org-last-inserted-timestamp 0 -1)
12977 " " repeater
12978 (substring org-last-inserted-timestamp -1))))))
12979 (message "Deadline on %s" org-last-inserted-timestamp))))))
12981 (defun org-schedule (arg &optional time)
12982 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12983 With one universal prefix argument, remove any scheduling date from the item.
12984 With two universal prefix arguments, prompt for a delay cookie.
12985 With argument TIME, scheduled at the corresponding date. TIME can
12986 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
12987 (interactive "P")
12988 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12989 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12990 'region-start-level 'region))
12991 org-loop-over-headlines-in-active-region)
12992 (org-map-entries
12993 `(org-schedule ',arg ,time)
12994 org-loop-over-headlines-in-active-region
12995 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12996 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12997 (old-date-time (if old-date (org-time-string-to-time old-date)))
12998 (repeater (and old-date
12999 (string-match
13000 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13001 old-date)
13002 (match-string 1 old-date))))
13003 (cond
13004 ((equal arg '(4))
13005 (progn
13006 (when (and old-date org-log-reschedule)
13007 (org-add-log-setup 'delschedule nil old-date 'findpos
13008 org-log-reschedule))
13009 (org-remove-timestamp-with-keyword org-scheduled-string)
13010 (message "Item is no longer scheduled.")))
13011 ((equal arg '(16))
13012 (save-excursion
13013 (org-back-to-heading t)
13014 (if (re-search-forward
13015 org-scheduled-time-regexp
13016 (save-excursion (outline-next-heading) (point)) t)
13017 (let* ((rpl0 (match-string 1))
13018 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13019 (replace-match
13020 (concat org-scheduled-string
13021 " <" rpl
13022 (format " -%dd"
13023 (abs
13024 (- (time-to-days
13025 (save-match-data
13026 (org-read-date nil t nil "Delay until" old-date-time)))
13027 (time-to-days old-date-time))))
13028 ">") t t))
13029 (user-error "No scheduled information to update"))))
13031 (org-add-planning-info 'scheduled time 'closed)
13032 (when (and old-date org-log-reschedule
13033 (not (equal old-date
13034 (substring org-last-inserted-timestamp 1 -1))))
13035 (org-add-log-setup 'reschedule nil old-date 'findpos
13036 org-log-reschedule))
13037 (when repeater
13038 (save-excursion
13039 (org-back-to-heading t)
13040 (when (re-search-forward (concat org-scheduled-string " "
13041 org-last-inserted-timestamp)
13042 (save-excursion
13043 (outline-next-heading) (point)) t)
13044 (goto-char (1- (match-end 0)))
13045 (insert " " repeater)
13046 (setq org-last-inserted-timestamp
13047 (concat (substring org-last-inserted-timestamp 0 -1)
13048 " " repeater
13049 (substring org-last-inserted-timestamp -1))))))
13050 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13052 (defun org-get-scheduled-time (pom &optional inherit)
13053 "Get the scheduled time as a time tuple, of a format suitable
13054 for calling org-schedule with, or if there is no scheduling,
13055 returns nil."
13056 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13057 (when time
13058 (apply 'encode-time (org-parse-time-string time)))))
13060 (defun org-get-deadline-time (pom &optional inherit)
13061 "Get the deadline as a time tuple, of a format suitable for
13062 calling org-deadline with, or if there is no scheduling, returns
13063 nil."
13064 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13065 (when time
13066 (apply 'encode-time (org-parse-time-string time)))))
13068 (defun org-remove-timestamp-with-keyword (keyword)
13069 "Remove all time stamps with KEYWORD in the current entry."
13070 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13071 beg)
13072 (save-excursion
13073 (org-back-to-heading t)
13074 (setq beg (point))
13075 (outline-next-heading)
13076 (while (re-search-backward re beg t)
13077 (replace-match "")
13078 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13079 (equal (char-before) ?\ ))
13080 (backward-delete-char 1)
13081 (if (string-match "^[ \t]*$" (buffer-substring
13082 (point-at-bol) (point-at-eol)))
13083 (delete-region (point-at-bol)
13084 (min (point-max) (1+ (point-at-eol))))))))))
13086 (defvar org-time-was-given) ; dynamically scoped parameter
13087 (defvar org-end-time-was-given) ; dynamically scoped parameter
13089 (defun org-add-planning-info (what &optional time &rest remove)
13090 "Insert new timestamp with keyword in the line directly after the headline.
13091 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13092 If non is given, the user is prompted for a date.
13093 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13094 be removed."
13095 (interactive)
13096 (let (org-time-was-given org-end-time-was-given ts
13097 end default-time default-input)
13099 (catch 'exit
13100 (when (and (memq what '(scheduled deadline))
13101 (or (not time)
13102 (and (stringp time)
13103 (string-match "^[-+]+[0-9]" time))))
13104 ;; Try to get a default date/time from existing timestamp
13105 (save-excursion
13106 (org-back-to-heading t)
13107 (setq end (save-excursion (outline-next-heading) (point)))
13108 (when (re-search-forward (if (eq what 'scheduled)
13109 org-scheduled-time-regexp
13110 org-deadline-time-regexp)
13111 end t)
13112 (setq ts (match-string 1)
13113 default-time
13114 (apply 'encode-time (org-parse-time-string ts))
13115 default-input (and ts (org-get-compact-tod ts))))))
13116 (when what
13117 (setq time
13118 (if (stringp time)
13119 ;; This is a string (relative or absolute), set proper date
13120 (apply 'encode-time
13121 (org-read-date-analyze
13122 time default-time (decode-time default-time)))
13123 ;; If necessary, get the time from the user
13124 (or time (org-read-date nil 'to-time nil nil
13125 default-time default-input)))))
13127 (when (and org-insert-labeled-timestamps-at-point
13128 (member what '(scheduled deadline)))
13129 (insert
13130 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13131 (org-insert-time-stamp time org-time-was-given
13132 nil nil nil (list org-end-time-was-given))
13133 (setq what nil))
13134 (save-excursion
13135 (save-restriction
13136 (let (col list elt ts buffer-invisibility-spec)
13137 (org-back-to-heading t)
13138 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13139 (goto-char (match-end 1))
13140 (setq col (current-column))
13141 (goto-char (match-end 0))
13142 (if (eobp) (insert "\n") (forward-char 1))
13143 (when (and (not what)
13144 (not (looking-at
13145 (concat "[ \t]*"
13146 org-keyword-time-not-clock-regexp))))
13147 ;; Nothing to add, nothing to remove...... :-)
13148 (throw 'exit nil))
13149 (if (and (not (looking-at org-outline-regexp))
13150 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13151 "[^\r\n]*"))
13152 (not (equal (match-string 1) org-clock-string)))
13153 (narrow-to-region (match-beginning 0) (match-end 0))
13154 (insert-before-markers "\n")
13155 (backward-char 1)
13156 (narrow-to-region (point) (point))
13157 (and org-adapt-indentation (org-indent-to-column col)))
13158 ;; Check if we have to remove something.
13159 (setq list (cons what remove))
13160 (while list
13161 (setq elt (pop list))
13162 (when (or (and (eq elt 'scheduled)
13163 (re-search-forward org-scheduled-time-regexp nil t))
13164 (and (eq elt 'deadline)
13165 (re-search-forward org-deadline-time-regexp nil t))
13166 (and (eq elt 'closed)
13167 (re-search-forward org-closed-time-regexp nil t)))
13168 (replace-match "")
13169 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13170 (and (looking-at "[ \t]+") (replace-match ""))
13171 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13172 (when what
13173 (insert
13174 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13175 (cond ((eq what 'scheduled) org-scheduled-string)
13176 ((eq what 'deadline) org-deadline-string)
13177 ((eq what 'closed) org-closed-string))
13178 " ")
13179 (setq ts (org-insert-time-stamp
13180 time
13181 (or org-time-was-given
13182 (and (eq what 'closed) org-log-done-with-time))
13183 (eq what 'closed)
13184 nil nil (list org-end-time-was-given)))
13185 (insert
13186 (if (not (or (bolp) (eq (char-before) ?\ )
13187 (memq (char-after) '(32 10))
13188 (eobp))) " " ""))
13189 (end-of-line 1))
13190 (goto-char (point-min))
13191 (widen)
13192 (if (and (looking-at "[ \t]*\n")
13193 (equal (char-before) ?\n))
13194 (delete-region (1- (point)) (point-at-eol)))
13195 ts))))))
13197 (defvar org-log-note-marker (make-marker))
13198 (defvar org-log-note-purpose nil)
13199 (defvar org-log-note-state nil)
13200 (defvar org-log-note-previous-state nil)
13201 (defvar org-log-note-how nil)
13202 (defvar org-log-note-extra nil)
13203 (defvar org-log-note-window-configuration nil)
13204 (defvar org-log-note-return-to (make-marker))
13205 (defvar org-log-note-effective-time nil
13206 "Remembered current time so that dynamically scoped
13207 `org-extend-today-until' affects tha timestamps in state change
13208 log")
13210 (defvar org-log-post-message nil
13211 "Message to be displayed after a log note has been stored.
13212 The auto-repeater uses this.")
13214 (defun org-add-note ()
13215 "Add a note to the current entry.
13216 This is done in the same way as adding a state change note."
13217 (interactive)
13218 (org-add-log-setup 'note nil nil 'findpos nil))
13220 (defvar org-property-end-re)
13221 (defun org-add-log-setup (&optional purpose state prev-state
13222 findpos how extra)
13223 "Set up the post command hook to take a note.
13224 If this is about to TODO state change, the new state is expected in STATE.
13225 When FINDPOS is non-nil, find the correct position for the note in
13226 the current entry. If not, assume that it can be inserted at point.
13227 HOW is an indicator what kind of note should be created.
13228 EXTRA is additional text that will be inserted into the notes buffer."
13229 (let* ((org-log-into-drawer (org-log-into-drawer))
13230 (drawer (cond ((stringp org-log-into-drawer)
13231 org-log-into-drawer)
13232 (org-log-into-drawer "LOGBOOK"))))
13233 (save-restriction
13234 (save-excursion
13235 (when findpos
13236 (org-back-to-heading t)
13237 (narrow-to-region (point) (save-excursion
13238 (outline-next-heading) (point)))
13239 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13240 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13241 "[^\r\n]*\\)?"))
13242 (goto-char (match-end 0))
13243 (cond
13244 (drawer
13245 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13246 nil t)
13247 (progn
13248 (goto-char (match-end 0))
13249 (or org-log-states-order-reversed
13250 (and (re-search-forward org-property-end-re nil t)
13251 (goto-char (1- (match-beginning 0))))))
13252 (insert "\n:" drawer ":\n:END:")
13253 (beginning-of-line 0)
13254 (org-indent-line)
13255 (beginning-of-line 2)
13256 (org-indent-line)
13257 (end-of-line 0)))
13258 ((and org-log-state-notes-insert-after-drawers
13259 (save-excursion
13260 (forward-line) (looking-at org-drawer-regexp)))
13261 (forward-line)
13262 (while (looking-at org-drawer-regexp)
13263 (goto-char (match-end 0))
13264 (re-search-forward org-property-end-re (point-max) t)
13265 (forward-line))
13266 (forward-line -1)))
13267 (unless org-log-states-order-reversed
13268 (and (= (char-after) ?\n) (forward-char 1))
13269 (org-skip-over-state-notes)
13270 (skip-chars-backward " \t\n\r")))
13271 (move-marker org-log-note-marker (point))
13272 (setq org-log-note-purpose purpose
13273 org-log-note-state state
13274 org-log-note-previous-state prev-state
13275 org-log-note-how how
13276 org-log-note-extra extra
13277 org-log-note-effective-time (org-current-effective-time))
13278 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13280 (defun org-skip-over-state-notes ()
13281 "Skip past the list of State notes in an entry."
13282 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13283 (when (ignore-errors (goto-char (org-in-item-p)))
13284 (let* ((struct (org-list-struct))
13285 (prevs (org-list-prevs-alist struct)))
13286 (while (looking-at "[ \t]*- State")
13287 (goto-char (or (org-list-get-next-item (point) struct prevs)
13288 (org-list-get-item-end (point) struct)))))))
13290 (defun org-add-log-note (&optional purpose)
13291 "Pop up a window for taking a note, and add this note later at point."
13292 (remove-hook 'post-command-hook 'org-add-log-note)
13293 (setq org-log-note-window-configuration (current-window-configuration))
13294 (delete-other-windows)
13295 (move-marker org-log-note-return-to (point))
13296 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13297 (goto-char org-log-note-marker)
13298 (org-switch-to-buffer-other-window "*Org Note*")
13299 (erase-buffer)
13300 (if (memq org-log-note-how '(time state))
13301 (let (current-prefix-arg) (org-store-log-note))
13302 (let ((org-inhibit-startup t)) (org-mode))
13303 (insert (format "# Insert note for %s.
13304 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13305 (cond
13306 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13307 ((eq org-log-note-purpose 'done) "closed todo item")
13308 ((eq org-log-note-purpose 'state)
13309 (format "state change from \"%s\" to \"%s\""
13310 (or org-log-note-previous-state "")
13311 (or org-log-note-state "")))
13312 ((eq org-log-note-purpose 'reschedule)
13313 "rescheduling")
13314 ((eq org-log-note-purpose 'delschedule)
13315 "no longer scheduled")
13316 ((eq org-log-note-purpose 'redeadline)
13317 "changing deadline")
13318 ((eq org-log-note-purpose 'deldeadline)
13319 "removing deadline")
13320 ((eq org-log-note-purpose 'refile)
13321 "refiling")
13322 ((eq org-log-note-purpose 'note)
13323 "this entry")
13324 (t (error "This should not happen")))))
13325 (if org-log-note-extra (insert org-log-note-extra))
13326 (org-set-local 'org-finish-function 'org-store-log-note)
13327 (run-hooks 'org-log-buffer-setup-hook)))
13329 (defvar org-note-abort nil) ; dynamically scoped
13330 (defun org-store-log-note ()
13331 "Finish taking a log note, and insert it to where it belongs."
13332 (let ((txt (buffer-string)))
13333 (kill-buffer (current-buffer))
13334 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13335 lines ind bul)
13336 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13337 (setq txt (replace-match "" t t txt)))
13338 (if (string-match "\\s-+\\'" txt)
13339 (setq txt (replace-match "" t t txt)))
13340 (setq lines (org-split-string txt "\n"))
13341 (when (and note (string-match "\\S-" note))
13342 (setq note
13343 (org-replace-escapes
13344 note
13345 (list (cons "%u" (user-login-name))
13346 (cons "%U" user-full-name)
13347 (cons "%t" (format-time-string
13348 (org-time-stamp-format 'long 'inactive)
13349 org-log-note-effective-time))
13350 (cons "%T" (format-time-string
13351 (org-time-stamp-format 'long nil)
13352 org-log-note-effective-time))
13353 (cons "%d" (format-time-string
13354 (org-time-stamp-format nil 'inactive)
13355 org-log-note-effective-time))
13356 (cons "%D" (format-time-string
13357 (org-time-stamp-format nil nil)
13358 org-log-note-effective-time))
13359 (cons "%s" (if org-log-note-state
13360 (concat "\"" org-log-note-state "\"")
13361 ""))
13362 (cons "%S" (if org-log-note-previous-state
13363 (concat "\"" org-log-note-previous-state "\"")
13364 "\"\"")))))
13365 (if lines (setq note (concat note " \\\\")))
13366 (push note lines))
13367 (when (or current-prefix-arg org-note-abort)
13368 (when org-log-into-drawer
13369 (org-remove-empty-drawer-at
13370 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13371 org-log-note-marker))
13372 (setq lines nil))
13373 (when lines
13374 (with-current-buffer (marker-buffer org-log-note-marker)
13375 (save-excursion
13376 (goto-char org-log-note-marker)
13377 (move-marker org-log-note-marker nil)
13378 (end-of-line 1)
13379 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13380 (setq ind (save-excursion
13381 (if (ignore-errors (goto-char (org-in-item-p)))
13382 (let ((struct (org-list-struct)))
13383 (org-list-get-ind
13384 (org-list-get-top-point struct) struct))
13385 (skip-chars-backward " \r\t\n")
13386 (cond
13387 ((and (org-at-heading-p)
13388 org-adapt-indentation)
13389 (1+ (org-current-level)))
13390 ((org-at-heading-p) 0)
13391 (t (org-get-indentation))))))
13392 (setq bul (org-list-bullet-string "-"))
13393 (org-indent-line-to ind)
13394 (insert bul (pop lines))
13395 (let ((ind-body (+ (length bul) ind)))
13396 (while lines
13397 (insert "\n")
13398 (org-indent-line-to ind-body)
13399 (insert (pop lines))))
13400 (message "Note stored")
13401 (org-back-to-heading t)
13402 (org-cycle-hide-drawers 'children))
13403 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13404 ;; from within `org-add-log-note' because `buffer-undo-list'
13405 ;; is then modified outside of `org-with-remote-undo'.
13406 (when (eq this-command 'org-agenda-todo)
13407 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13408 ;; Don't add undo information when called from `org-agenda-todo'
13409 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13410 (set-window-configuration org-log-note-window-configuration)
13411 (with-current-buffer (marker-buffer org-log-note-return-to)
13412 (goto-char org-log-note-return-to))
13413 (move-marker org-log-note-return-to nil)
13414 (and org-log-post-message (message "%s" org-log-post-message))))
13416 (defun org-remove-empty-drawer-at (drawer pos)
13417 "Remove an empty drawer DRAWER at position POS.
13418 POS may also be a marker."
13419 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13420 (save-excursion
13421 (save-restriction
13422 (widen)
13423 (goto-char pos)
13424 (if (org-in-regexp
13425 (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
13426 (replace-match ""))))))
13428 (defvar org-ts-type nil)
13429 (defun org-sparse-tree (&optional arg type)
13430 "Create a sparse tree, prompt for the details.
13431 This command can create sparse trees. You first need to select the type
13432 of match used to create the tree:
13434 t Show all TODO entries.
13435 T Show entries with a specific TODO keyword.
13436 m Show entries selected by a tags/property match.
13437 p Enter a property name and its value (both with completion on existing
13438 names/values) and show entries with that property.
13439 r Show entries matching a regular expression (`/' can be used as well).
13440 b Show deadlines and scheduled items before a date.
13441 a Show deadlines and scheduled items after a date.
13442 d Show deadlines due within `org-deadline-warning-days'.
13443 D Show deadlines and scheduled items between a date range."
13444 (interactive "P")
13445 (let (ans kwd value ts-type)
13446 (setq type (or type org-sparse-tree-default-date-type))
13447 (setq org-ts-type type)
13448 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range\n [c]ycle through date types: %s"
13449 (cond ((eq type 'all) "all timestamps")
13450 ((eq type 'scheduled) "only scheduled")
13451 ((eq type 'deadline) "only deadline")
13452 ((eq type 'active) "only active timestamps")
13453 ((eq type 'inactive) "only inactive timestamps")
13454 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13455 ((eq type 'closed) "with a closed time-stamp")
13456 (t "scheduled/deadline")))
13457 (setq ans (read-char-exclusive))
13458 (cond
13459 ((equal ans ?c)
13460 (org-sparse-tree
13461 arg (cadr (member type '(scheduled-or-deadline
13462 all scheduled deadline active inactive closed)))))
13463 ((equal ans ?d)
13464 (call-interactively 'org-check-deadlines))
13465 ((equal ans ?b)
13466 (call-interactively 'org-check-before-date))
13467 ((equal ans ?a)
13468 (call-interactively 'org-check-after-date))
13469 ((equal ans ?D)
13470 (call-interactively 'org-check-dates-range))
13471 ((equal ans ?t)
13472 (call-interactively 'org-show-todo-tree))
13473 ((equal ans ?T)
13474 (org-show-todo-tree '(4)))
13475 ((member ans '(?T ?m))
13476 (call-interactively 'org-match-sparse-tree))
13477 ((member ans '(?p ?P))
13478 (setq kwd (org-icompleting-read "Property: "
13479 (mapcar 'list (org-buffer-property-keys))))
13480 (setq value (org-icompleting-read "Value: "
13481 (mapcar 'list (org-property-values kwd))))
13482 (unless (string-match "\\`{.*}\\'" value)
13483 (setq value (concat "\"" value "\"")))
13484 (org-match-sparse-tree arg (concat kwd "=" value)))
13485 ((member ans '(?r ?R ?/))
13486 (call-interactively 'org-occur))
13487 (t (user-error "No such sparse tree command \"%c\"" ans)))))
13489 (defvar org-occur-highlights nil
13490 "List of overlays used for occur matches.")
13491 (make-variable-buffer-local 'org-occur-highlights)
13492 (defvar org-occur-parameters nil
13493 "Parameters of the active org-occur calls.
13494 This is a list, each call to org-occur pushes as cons cell,
13495 containing the regular expression and the callback, onto the list.
13496 The list can contain several entries if `org-occur' has been called
13497 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13498 will only contain one set of parameters. When the highlights are
13499 removed (for example with `C-c C-c', or with the next edit (depending
13500 on `org-remove-highlights-with-change'), this variable is emptied
13501 as well.")
13502 (make-variable-buffer-local 'org-occur-parameters)
13504 (defun org-occur (regexp &optional keep-previous callback)
13505 "Make a compact tree which shows all matches of REGEXP.
13506 The tree will show the lines where the regexp matches, and all higher
13507 headlines above the match. It will also show the heading after the match,
13508 to make sure editing the matching entry is easy.
13509 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13510 call to `org-occur' will be kept, to allow stacking of calls to this
13511 command.
13512 If CALLBACK is non-nil, it is a function which is called to confirm
13513 that the match should indeed be shown."
13514 (interactive "sRegexp: \nP")
13515 (when (equal regexp "")
13516 (user-error "Regexp cannot be empty"))
13517 (unless keep-previous
13518 (org-remove-occur-highlights nil nil t))
13519 (push (cons regexp callback) org-occur-parameters)
13520 (let ((cnt 0))
13521 (save-excursion
13522 (goto-char (point-min))
13523 (if (or (not keep-previous) ; do not want to keep
13524 (not org-occur-highlights)) ; no previous matches
13525 ;; hide everything
13526 (org-overview))
13527 (while (re-search-forward regexp nil t)
13528 (when (or (not callback)
13529 (save-match-data (funcall callback)))
13530 (setq cnt (1+ cnt))
13531 (when org-highlight-sparse-tree-matches
13532 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13533 (org-show-context 'occur-tree))))
13534 (when org-remove-highlights-with-change
13535 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13536 nil 'local))
13537 (unless org-sparse-tree-open-archived-trees
13538 (org-hide-archived-subtrees (point-min) (point-max)))
13539 (run-hooks 'org-occur-hook)
13540 (if (org-called-interactively-p 'interactive)
13541 (message "%d match(es) for regexp %s" cnt regexp))
13542 cnt))
13544 (defun org-occur-next-match (&optional n reset)
13545 "Function for `next-error-function' to find sparse tree matches.
13546 N is the number of matches to move, when negative move backwards.
13547 RESET is entirely ignored - this function always goes back to the
13548 starting point when no match is found."
13549 (let* ((limit (if (< n 0) (point-min) (point-max)))
13550 (search-func (if (< n 0)
13551 'previous-single-char-property-change
13552 'next-single-char-property-change))
13553 (n (abs n))
13554 (pos (point))
13556 (catch 'exit
13557 (while (setq p1 (funcall search-func (point) 'org-type))
13558 (when (equal p1 limit)
13559 (goto-char pos)
13560 (error "No more matches"))
13561 (when (equal (get-char-property p1 'org-type) 'org-occur)
13562 (setq n (1- n))
13563 (when (= n 0)
13564 (goto-char p1)
13565 (throw 'exit (point))))
13566 (goto-char p1))
13567 (goto-char p1)
13568 (error "No more matches"))))
13570 (defun org-show-context (&optional key)
13571 "Make sure point and context are visible.
13572 How much context is shown depends upon the variables
13573 `org-show-hierarchy-above', `org-show-following-heading',
13574 `org-show-entry-below' and `org-show-siblings'."
13575 (let ((heading-p (org-at-heading-p t))
13576 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13577 (following-p (org-get-alist-option org-show-following-heading key))
13578 (entry-p (org-get-alist-option org-show-entry-below key))
13579 (siblings-p (org-get-alist-option org-show-siblings key)))
13580 ;; Show heading or entry text
13581 (if (and heading-p (not entry-p))
13582 (org-flag-heading nil) ; only show the heading
13583 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13584 (org-show-hidden-entry))) ; show entire entry
13585 (when following-p
13586 ;; Show next sibling, or heading below text
13587 (save-excursion
13588 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13589 (org-flag-heading nil))))
13590 (when siblings-p (org-show-siblings))
13591 (when hierarchy-p
13592 ;; show all higher headings, possibly with siblings
13593 (save-excursion
13594 (while (and (condition-case nil
13595 (progn (org-up-heading-all 1) t)
13596 (error nil))
13597 (not (bobp)))
13598 (org-flag-heading nil)
13599 (when siblings-p (org-show-siblings)))))
13600 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13602 (defvar org-reveal-start-hook nil
13603 "Hook run before revealing a location.")
13605 (defun org-reveal (&optional siblings)
13606 "Show current entry, hierarchy above it, and the following headline.
13607 This can be used to show a consistent set of context around locations
13608 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13609 not t for the search context.
13611 With optional argument SIBLINGS, on each level of the hierarchy all
13612 siblings are shown. This repairs the tree structure to what it would
13613 look like when opened with hierarchical calls to `org-cycle'.
13614 With double optional argument \\[universal-argument] \\[universal-argument], \
13615 go to the parent and show the
13616 entire tree."
13617 (interactive "P")
13618 (run-hooks 'org-reveal-start-hook)
13619 (let ((org-show-hierarchy-above t)
13620 (org-show-following-heading t)
13621 (org-show-siblings (if siblings t org-show-siblings)))
13622 (org-show-context nil))
13623 (when (equal siblings '(16))
13624 (save-excursion
13625 (when (org-up-heading-safe)
13626 (org-show-subtree)
13627 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13629 (defun org-highlight-new-match (beg end)
13630 "Highlight from BEG to END and mark the highlight is an occur headline."
13631 (let ((ov (make-overlay beg end)))
13632 (overlay-put ov 'face 'secondary-selection)
13633 (overlay-put ov 'org-type 'org-occur)
13634 (push ov org-occur-highlights)))
13636 (defun org-remove-occur-highlights (&optional beg end noremove)
13637 "Remove the occur highlights from the buffer.
13638 BEG and END are ignored. If NOREMOVE is nil, remove this function
13639 from the `before-change-functions' in the current buffer."
13640 (interactive)
13641 (unless org-inhibit-highlight-removal
13642 (mapc 'delete-overlay org-occur-highlights)
13643 (setq org-occur-highlights nil)
13644 (setq org-occur-parameters nil)
13645 (unless noremove
13646 (remove-hook 'before-change-functions
13647 'org-remove-occur-highlights 'local))))
13649 ;;;; Priorities
13651 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13652 "Regular expression matching the priority indicator.")
13654 (defvar org-remove-priority-next-time nil)
13656 (defun org-priority-up ()
13657 "Increase the priority of the current item."
13658 (interactive)
13659 (org-priority 'up))
13661 (defun org-priority-down ()
13662 "Decrease the priority of the current item."
13663 (interactive)
13664 (org-priority 'down))
13666 (defun org-priority (&optional action show)
13667 "Change the priority of an item.
13668 ACTION can be `set', `up', `down', or a character."
13669 (interactive "P")
13670 (if (equal action '(4))
13671 (org-show-priority)
13672 (unless org-enable-priority-commands
13673 (user-error "Priority commands are disabled"))
13674 (setq action (or action 'set))
13675 (let (current new news have remove)
13676 (save-excursion
13677 (org-back-to-heading t)
13678 (if (looking-at org-priority-regexp)
13679 (setq current (string-to-char (match-string 2))
13680 have t))
13681 (cond
13682 ((eq action 'remove)
13683 (setq remove t new ?\ ))
13684 ((or (eq action 'set)
13685 (if (featurep 'xemacs) (characterp action) (integerp action)))
13686 (if (not (eq action 'set))
13687 (setq new action)
13688 (message "Priority %c-%c, SPC to remove: "
13689 org-highest-priority org-lowest-priority)
13690 (save-match-data
13691 (setq new (read-char-exclusive))))
13692 (if (and (= (upcase org-highest-priority) org-highest-priority)
13693 (= (upcase org-lowest-priority) org-lowest-priority))
13694 (setq new (upcase new)))
13695 (cond ((equal new ?\ ) (setq remove t))
13696 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13697 (user-error "Priority must be between `%c' and `%c'"
13698 org-highest-priority org-lowest-priority))))
13699 ((eq action 'up)
13700 (setq new (if have
13701 (1- current) ; normal cycling
13702 ;; last priority was empty
13703 (if (eq last-command this-command)
13704 org-lowest-priority ; wrap around empty to lowest
13705 ;; default
13706 (if org-priority-start-cycle-with-default
13707 org-default-priority
13708 (1- org-default-priority))))))
13709 ((eq action 'down)
13710 (setq new (if have
13711 (1+ current) ; normal cycling
13712 ;; last priority was empty
13713 (if (eq last-command this-command)
13714 org-highest-priority ; wrap around empty to highest
13715 ;; default
13716 (if org-priority-start-cycle-with-default
13717 org-default-priority
13718 (1+ org-default-priority))))))
13719 (t (user-error "Invalid action")))
13720 (if (or (< (upcase new) org-highest-priority)
13721 (> (upcase new) org-lowest-priority))
13722 (if (and (memq action '(up down))
13723 (not have) (not (eq last-command this-command)))
13724 ;; `new' is from default priority
13725 (error
13726 "The default can not be set, see `org-default-priority' why")
13727 ;; normal cycling: `new' is beyond highest/lowest priority
13728 ;; and is wrapped around to the empty priority
13729 (setq remove t)))
13730 (setq news (format "%c" new))
13731 (if have
13732 (if remove
13733 (replace-match "" t t nil 1)
13734 (replace-match news t t nil 2))
13735 (if remove
13736 (user-error "No priority cookie found in line")
13737 (let ((case-fold-search nil))
13738 (looking-at org-todo-line-regexp))
13739 (if (match-end 2)
13740 (progn
13741 (goto-char (match-end 2))
13742 (insert " [#" news "]"))
13743 (goto-char (match-beginning 3))
13744 (insert "[#" news "] "))))
13745 (org-preserve-lc (org-set-tags nil 'align)))
13746 (if remove
13747 (message "Priority removed")
13748 (message "Priority of current item set to %s" news)))))
13750 (defun org-show-priority ()
13751 "Show the priority of the current item.
13752 This priority is composed of the main priority given with the [#A] cookies,
13753 and by additional input from the age of a schedules or deadline entry."
13754 (interactive)
13755 (let ((pri (if (eq major-mode 'org-agenda-mode)
13756 (org-get-at-bol 'priority)
13757 (save-excursion
13758 (save-match-data
13759 (beginning-of-line)
13760 (and (looking-at org-heading-regexp)
13761 (org-get-priority (match-string 0))))))))
13762 (message "Priority is %d" (if pri pri -1000))))
13764 (defun org-get-priority (s)
13765 "Find priority cookie and return priority."
13766 (save-match-data
13767 (if (functionp org-get-priority-function)
13768 (funcall org-get-priority-function)
13769 (if (not (string-match org-priority-regexp s))
13770 (* 1000 (- org-lowest-priority org-default-priority))
13771 (* 1000 (- org-lowest-priority
13772 (string-to-char (match-string 2 s))))))))
13774 ;;;; Tags
13776 (defvar org-agenda-archives-mode)
13777 (defvar org-map-continue-from nil
13778 "Position from where mapping should continue.
13779 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13781 (defvar org-scanner-tags nil
13782 "The current tag list while the tags scanner is running.")
13783 (defvar org-trust-scanner-tags nil
13784 "Should `org-get-tags-at' use the tags for the scanner.
13785 This is for internal dynamical scoping only.
13786 When this is non-nil, the function `org-get-tags-at' will return the value
13787 of `org-scanner-tags' instead of building the list by itself. This
13788 can lead to large speed-ups when the tags scanner is used in a file with
13789 many entries, and when the list of tags is retrieved, for example to
13790 obtain a list of properties. Building the tags list for each entry in such
13791 a file becomes an N^2 operation - but with this variable set, it scales
13792 as N.")
13794 (defun org-scan-tags (action matcher todo-only &optional start-level)
13795 "Sca headline tags with inheritance and produce output ACTION.
13797 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13798 or `agenda' to produce an entry list for an agenda view. It can also be
13799 a Lisp form or a function that should be called at each matched headline, in
13800 this case the return value is a list of all return values from these calls.
13802 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13803 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13804 only lines with a not-done TODO keyword are included in the output.
13805 This should be the same variable that was scoped into
13806 and set by `org-make-tags-matcher' when it constructed MATCHER.
13808 START-LEVEL can be a string with asterisks, reducing the scope to
13809 headlines matching this string."
13810 (require 'org-agenda)
13811 (let* ((re (concat "^"
13812 (if start-level
13813 ;; Get the correct level to match
13814 (concat "\\*\\{" (number-to-string start-level) "\\} ")
13815 org-outline-regexp)
13816 " *\\(\\<\\("
13817 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
13818 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
13819 (props (list 'face 'default
13820 'done-face 'org-agenda-done
13821 'undone-face 'default
13822 'mouse-face 'highlight
13823 'org-not-done-regexp org-not-done-regexp
13824 'org-todo-regexp org-todo-regexp
13825 'org-complex-heading-regexp org-complex-heading-regexp
13826 'help-echo
13827 (format "mouse-2 or RET jump to org file %s"
13828 (abbreviate-file-name
13829 (or (buffer-file-name (buffer-base-buffer))
13830 (buffer-name (buffer-base-buffer)))))))
13831 (org-map-continue-from nil)
13832 lspos tags tags-list
13833 (tags-alist (list (cons 0 org-file-tags)))
13834 (llast 0) rtn rtn1 level category i txt
13835 todo marker entry priority)
13836 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13837 (setq action (list 'lambda nil action)))
13838 (save-excursion
13839 (goto-char (point-min))
13840 (when (eq action 'sparse-tree)
13841 (org-overview)
13842 (org-remove-occur-highlights))
13843 (while (let (case-fold-search)
13844 (re-search-forward re nil t))
13845 (setq org-map-continue-from nil)
13846 (catch :skip
13847 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13848 tags (if (match-end 4) (org-match-string-no-properties 4)))
13849 (goto-char (setq lspos (match-beginning 0)))
13850 (setq level (org-reduced-level (org-outline-level))
13851 category (org-get-category))
13852 (setq i llast llast level)
13853 ;; remove tag lists from same and sublevels
13854 (while (>= i level)
13855 (when (setq entry (assoc i tags-alist))
13856 (setq tags-alist (delete entry tags-alist)))
13857 (setq i (1- i)))
13858 ;; add the next tags
13859 (when tags
13860 (setq tags (org-split-string tags ":")
13861 tags-alist
13862 (cons (cons level tags) tags-alist)))
13863 ;; compile tags for current headline
13864 (setq tags-list
13865 (if org-use-tag-inheritance
13866 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13867 tags)
13868 org-scanner-tags tags-list)
13869 (when org-use-tag-inheritance
13870 (setcdr (car tags-alist)
13871 (mapcar (lambda (x)
13872 (setq x (copy-sequence x))
13873 (org-add-prop-inherited x))
13874 (cdar tags-alist))))
13875 (when (and tags org-use-tag-inheritance
13876 (or (not (eq t org-use-tag-inheritance))
13877 org-tags-exclude-from-inheritance))
13878 ;; selective inheritance, remove uninherited ones
13879 (setcdr (car tags-alist)
13880 (org-remove-uninherited-tags (cdar tags-alist))))
13881 (when (and
13883 ;; eval matcher only when the todo condition is OK
13884 (and (or (not todo-only) (member todo org-not-done-keywords))
13885 (let ((case-fold-search t) (org-trust-scanner-tags t))
13886 (eval matcher)))
13888 ;; Call the skipper, but return t if it does not skip,
13889 ;; so that the `and' form continues evaluating
13890 (progn
13891 (unless (eq action 'sparse-tree) (org-agenda-skip))
13894 ;; Check if timestamps are deselecting this entry
13895 (or (not todo-only)
13896 (and (member todo org-not-done-keywords)
13897 (or (not org-agenda-tags-todo-honor-ignore-options)
13898 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13900 ;; select this headline
13901 (cond
13902 ((eq action 'sparse-tree)
13903 (and org-highlight-sparse-tree-matches
13904 (org-get-heading) (match-end 0)
13905 (org-highlight-new-match
13906 (match-beginning 1) (match-end 1)))
13907 (org-show-context 'tags-tree))
13908 ((eq action 'agenda)
13909 (setq txt (org-agenda-format-item
13911 (concat
13912 (if (eq org-tags-match-list-sublevels 'indented)
13913 (make-string (1- level) ?.) "")
13914 (org-get-heading))
13915 level category
13916 tags-list)
13917 priority (org-get-priority txt))
13918 (goto-char lspos)
13919 (setq marker (org-agenda-new-marker))
13920 (org-add-props txt props
13921 'org-marker marker 'org-hd-marker marker 'org-category category
13922 'todo-state todo
13923 'priority priority 'type "tagsmatch")
13924 (push txt rtn))
13925 ((functionp action)
13926 (setq org-map-continue-from nil)
13927 (save-excursion
13928 (setq rtn1 (funcall action))
13929 (push rtn1 rtn)))
13930 (t (user-error "Invalid action")))
13932 ;; if we are to skip sublevels, jump to end of subtree
13933 (unless org-tags-match-list-sublevels
13934 (org-end-of-subtree t)
13935 (backward-char 1))))
13936 ;; Get the correct position from where to continue
13937 (if org-map-continue-from
13938 (goto-char org-map-continue-from)
13939 (and (= (point) lspos) (end-of-line 1)))))
13940 (when (and (eq action 'sparse-tree)
13941 (not org-sparse-tree-open-archived-trees))
13942 (org-hide-archived-subtrees (point-min) (point-max)))
13943 (nreverse rtn)))
13945 (defun org-remove-uninherited-tags (tags)
13946 "Remove all tags that are not inherited from the list TAGS."
13947 (cond
13948 ((eq org-use-tag-inheritance t)
13949 (if org-tags-exclude-from-inheritance
13950 (org-delete-all org-tags-exclude-from-inheritance tags)
13951 tags))
13952 ((not org-use-tag-inheritance) nil)
13953 ((stringp org-use-tag-inheritance)
13954 (delq nil (mapcar
13955 (lambda (x)
13956 (if (and (string-match org-use-tag-inheritance x)
13957 (not (member x org-tags-exclude-from-inheritance)))
13958 x nil))
13959 tags)))
13960 ((listp org-use-tag-inheritance)
13961 (delq nil (mapcar
13962 (lambda (x)
13963 (if (member x org-use-tag-inheritance) x nil))
13964 tags)))))
13966 (defun org-match-sparse-tree (&optional todo-only match)
13967 "Create a sparse tree according to tags string MATCH.
13968 MATCH can contain positive and negative selection of tags, like
13969 \"+WORK+URGENT-WITHBOSS\".
13970 If optional argument TODO-ONLY is non-nil, only select lines that are
13971 also TODO lines."
13972 (interactive "P")
13973 (org-agenda-prepare-buffers (list (current-buffer)))
13974 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13976 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13978 (defvar org-cached-props nil)
13979 (defun org-cached-entry-get (pom property)
13980 (if (or (eq t org-use-property-inheritance)
13981 (and (stringp org-use-property-inheritance)
13982 (string-match org-use-property-inheritance property))
13983 (and (listp org-use-property-inheritance)
13984 (member property org-use-property-inheritance)))
13985 ;; Caching is not possible, check it directly
13986 (org-entry-get pom property 'inherit)
13987 ;; Get all properties, so that we can do complicated checks easily
13988 (cdr (assoc property (or org-cached-props
13989 (setq org-cached-props
13990 (org-entry-properties pom)))))))
13992 (defun org-global-tags-completion-table (&optional files)
13993 "Return the list of all tags in all agenda buffer/files.
13994 Optional FILES argument is a list of files which can be used
13995 instead of the agenda files."
13996 (save-excursion
13997 (org-uniquify
13998 (delq nil
13999 (apply 'append
14000 (mapcar
14001 (lambda (file)
14002 (set-buffer (find-file-noselect file))
14003 (append (org-get-buffer-tags)
14004 (mapcar (lambda (x) (if (stringp (car-safe x))
14005 (list (car-safe x)) nil))
14006 org-tag-alist)))
14007 (if (and files (car files))
14008 files
14009 (org-agenda-files))))))))
14011 (defun org-make-tags-matcher (match)
14012 "Create the TAGS/TODO matcher form for the selection string MATCH.
14014 The variable `todo-only' is scoped dynamically into this function.
14015 It will be set to t if the matcher restricts matching to TODO entries,
14016 otherwise will not be touched.
14018 Returns a cons of the selection string MATCH and the constructed
14019 lisp form implementing the matcher. The matcher is to be evaluated
14020 at an Org entry, with point on the headline, and returns t if the
14021 entry matches the selection string MATCH. The returned lisp form
14022 references two variables with information about the entry, which
14023 must be bound around the form's evaluation: todo, the TODO keyword
14024 at the entry (or nil of none); and tags-list, the list of all tags
14025 at the entry including inherited ones. Additionally, the category
14026 of the entry (if any) must be specified as the text property
14027 'org-category on the headline.
14029 See also `org-scan-tags'.
14031 (declare (special todo-only))
14032 (unless (boundp 'todo-only)
14033 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14034 (unless match
14035 ;; Get a new match request, with completion against the global
14036 ;; tags table and the local tags in current buffer
14037 (let ((org-last-tags-completion-table
14038 (org-uniquify
14039 (delq nil (append (org-get-buffer-tags)
14040 (org-global-tags-completion-table))))))
14041 (setq match (org-completing-read-no-i
14042 "Match: " 'org-tags-completion-function nil nil nil
14043 'org-tags-history))))
14045 ;; Parse the string and create a lisp form
14046 (let ((match0 match)
14047 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14048 minus tag mm
14049 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14050 orterms term orlist re-p str-p level-p level-op time-p
14051 prop-p pn pv po gv rest (start 0) (ss 0))
14052 ;; Expand group tags
14053 (setq match (org-tags-expand match))
14055 ;; Check if there is a TODO part of this match, which would be the
14056 ;; part after a "/". TO make sure that this slash is not part of
14057 ;; a property value to be matched against, we also check that there
14058 ;; is no " after that slash.
14059 ;; First, find the last slash
14060 (while (string-match "/+" match ss)
14061 (setq start (match-beginning 0) ss (match-end 0)))
14062 (if (and (string-match "/+" match start)
14063 (not (save-match-data (string-match "\"" match start))))
14064 ;; match contains also a todo-matching request
14065 (progn
14066 (setq tagsmatch (substring match 0 (match-beginning 0))
14067 todomatch (substring match (match-end 0)))
14068 (if (string-match "^!" todomatch)
14069 (setq todo-only t todomatch (substring todomatch 1)))
14070 (if (string-match "^\\s-*$" todomatch)
14071 (setq todomatch nil)))
14072 ;; only matching tags
14073 (setq tagsmatch match todomatch nil))
14075 ;; Make the tags matcher
14076 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14077 (setq tagsmatcher t)
14078 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14079 (while (setq term (pop orterms))
14080 (while (and (equal (substring term -1) "\\") orterms)
14081 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14082 (while (string-match re term)
14083 (setq rest (substring term (match-end 0))
14084 minus (and (match-end 1)
14085 (equal (match-string 1 term) "-"))
14086 tag (save-match-data (replace-regexp-in-string
14087 "\\\\-" "-"
14088 (match-string 2 term)))
14089 re-p (equal (string-to-char tag) ?{)
14090 level-p (match-end 4)
14091 prop-p (match-end 5)
14092 mm (cond
14093 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14094 (level-p
14095 (setq level-op (org-op-to-function (match-string 3 term)))
14096 `(,level-op level ,(string-to-number
14097 (match-string 4 term))))
14098 (prop-p
14099 (setq pn (match-string 5 term)
14100 po (match-string 6 term)
14101 pv (match-string 7 term)
14102 re-p (equal (string-to-char pv) ?{)
14103 str-p (equal (string-to-char pv) ?\")
14104 time-p (save-match-data
14105 (string-match "^\"[[<].*[]>]\"$" pv))
14106 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14107 (if time-p (setq pv (org-matcher-time pv)))
14108 (setq po (org-op-to-function po (if time-p 'time str-p)))
14109 (cond
14110 ((equal pn "CATEGORY")
14111 (setq gv '(get-text-property (point) 'org-category)))
14112 ((equal pn "TODO")
14113 (setq gv 'todo))
14115 (setq gv `(org-cached-entry-get nil ,pn))))
14116 (if re-p
14117 (if (eq po 'org<>)
14118 `(not (string-match ,pv (or ,gv "")))
14119 `(string-match ,pv (or ,gv "")))
14120 (if str-p
14121 `(,po (or ,gv "") ,pv)
14122 `(,po (string-to-number (or ,gv ""))
14123 ,(string-to-number pv) ))))
14124 (t `(member ,tag tags-list)))
14125 mm (if minus (list 'not mm) mm)
14126 term rest)
14127 (push mm tagsmatcher))
14128 (push (if (> (length tagsmatcher) 1)
14129 (cons 'and tagsmatcher)
14130 (car tagsmatcher))
14131 orlist)
14132 (setq tagsmatcher nil))
14133 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14134 (setq tagsmatcher
14135 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14136 ;; Make the todo matcher
14137 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14138 (setq todomatcher t)
14139 (setq orterms (org-split-string todomatch "|") orlist nil)
14140 (while (setq term (pop orterms))
14141 (while (string-match re term)
14142 (setq minus (and (match-end 1)
14143 (equal (match-string 1 term) "-"))
14144 kwd (match-string 2 term)
14145 re-p (equal (string-to-char kwd) ?{)
14146 term (substring term (match-end 0))
14147 mm (if re-p
14148 `(string-match ,(substring kwd 1 -1) todo)
14149 (list 'equal 'todo kwd))
14150 mm (if minus (list 'not mm) mm))
14151 (push mm todomatcher))
14152 (push (if (> (length todomatcher) 1)
14153 (cons 'and todomatcher)
14154 (car todomatcher))
14155 orlist)
14156 (setq todomatcher nil))
14157 (setq todomatcher (if (> (length orlist) 1)
14158 (cons 'or orlist) (car orlist))))
14160 ;; Return the string and lisp forms of the matcher
14161 (setq matcher (if todomatcher
14162 (list 'and tagsmatcher todomatcher)
14163 tagsmatcher))
14164 (when todo-only
14165 (setq matcher (list 'and '(member todo org-not-done-keywords)
14166 matcher)))
14167 (cons match0 matcher)))
14169 (defun org-tags-expand (match &optional single-as-list downcased)
14170 "Expand group tags in MATCH.
14172 This replaces every group tag in MATCH with a regexp tag search.
14173 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14174 will be replaced like this:
14176 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14177 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14178 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14180 Replacing by a regexp preserves the structure of the match.
14181 E.g., this expansion
14183 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14185 will match anything tagged with \"Lab\" and \"Home\", or tagged
14186 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14188 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14189 assumed to be a single group tag, and the function will return
14190 the list of tags in this group.
14192 When DOWNCASE is non-nil, expand downcased TAGS."
14193 (if org-group-tags
14194 (let* ((case-fold-search t)
14195 (stable org-mode-syntax-table)
14196 (tal (or org-tag-groups-alist-for-agenda
14197 org-tag-groups-alist))
14198 (tal (if downcased
14199 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14200 (tml (mapcar 'car tal))
14201 (rtnmatch match) rpl)
14202 ;; @ and _ are allowed as word-components in tags
14203 (modify-syntax-entry ?@ "w" stable)
14204 (modify-syntax-entry ?_ "w" stable)
14205 (while (and tml
14206 (with-syntax-table stable
14207 (string-match
14208 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14209 (regexp-opt tml) "\\>\\)") rtnmatch)))
14210 (let* ((dir (match-string 1 rtnmatch))
14211 (tag (match-string 2 rtnmatch))
14212 (tag (if downcased (downcase tag) tag)))
14213 (setq tml (delete tag tml))
14214 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14215 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14216 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14217 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14218 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14219 (if single-as-list
14220 (or (reverse rpl) (list rtnmatch))
14221 rtnmatch))
14222 (if single-as-list (list (if downcased (downcase match) match))
14223 match)))
14225 (defun org-op-to-function (op &optional stringp)
14226 "Turn an operator into the appropriate function."
14227 (setq op
14228 (cond
14229 ((equal op "<" ) '(< string< org-time<))
14230 ((equal op ">" ) '(> org-string> org-time>))
14231 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14232 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14233 ((member op '("=" "==")) '(= string= org-time=))
14234 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14235 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14237 (defun org<> (a b) (not (= a b)))
14238 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14239 (defun org-string>= (a b) (not (string< a b)))
14240 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14241 (defun org-string<> (a b) (not (string= a b)))
14242 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14243 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14244 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14245 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14246 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14247 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14248 (defun org-2ft (s)
14249 "Convert S to a floating point time.
14250 If S is already a number, just return it. If it is a string, parse
14251 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14252 (cond
14253 ((numberp s) s)
14254 ((stringp s)
14255 (condition-case nil
14256 (float-time (apply 'encode-time (org-parse-time-string s)))
14257 (error 0.)))
14258 (t 0.)))
14260 (defun org-time-today ()
14261 "Time in seconds today at 0:00.
14262 Returns the float number of seconds since the beginning of the
14263 epoch to the beginning of today (00:00)."
14264 (float-time (apply 'encode-time
14265 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14267 (defun org-matcher-time (s)
14268 "Interpret a time comparison value."
14269 (save-match-data
14270 (cond
14271 ((string= s "<now>") (float-time))
14272 ((string= s "<today>") (org-time-today))
14273 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14274 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14275 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14276 (+ (org-time-today)
14277 (* (string-to-number (match-string 1 s))
14278 (cdr (assoc (match-string 2 s)
14279 '(("d" . 86400.0) ("w" . 604800.0)
14280 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14281 (t (org-2ft s)))))
14283 (defun org-match-any-p (re list)
14284 "Does re match any element of list?"
14285 (setq list (mapcar (lambda (x) (string-match re x)) list))
14286 (delq nil list))
14288 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14289 (defvar org-tags-overlay (make-overlay 1 1))
14290 (org-detach-overlay org-tags-overlay)
14292 (defun org-get-local-tags-at (&optional pos)
14293 "Get a list of tags defined in the current headline."
14294 (org-get-tags-at pos 'local))
14296 (defun org-get-local-tags ()
14297 "Get a list of tags defined in the current headline."
14298 (org-get-tags-at nil 'local))
14300 (defun org-get-tags-at (&optional pos local)
14301 "Get a list of all headline tags applicable at POS.
14302 POS defaults to point. If tags are inherited, the list contains
14303 the targets in the same sequence as the headlines appear, i.e.
14304 the tags of the current headline come last.
14305 When LOCAL is non-nil, only return tags from the current headline,
14306 ignore inherited ones."
14307 (interactive)
14308 (if (and org-trust-scanner-tags
14309 (or (not pos) (equal pos (point)))
14310 (not local))
14311 org-scanner-tags
14312 (let (tags ltags lastpos parent)
14313 (save-excursion
14314 (save-restriction
14315 (widen)
14316 (goto-char (or pos (point)))
14317 (save-match-data
14318 (catch 'done
14319 (condition-case nil
14320 (progn
14321 (org-back-to-heading t)
14322 (while (not (equal lastpos (point)))
14323 (setq lastpos (point))
14324 (when (looking-at
14325 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14326 (setq ltags (org-split-string
14327 (org-match-string-no-properties 1) ":"))
14328 (when parent
14329 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14330 (setq tags (append
14331 (if parent
14332 (org-remove-uninherited-tags ltags)
14333 ltags)
14334 tags)))
14335 (or org-use-tag-inheritance (throw 'done t))
14336 (if local (throw 'done t))
14337 (or (org-up-heading-safe) (error nil))
14338 (setq parent t)))
14339 (error nil)))))
14340 (if local
14341 tags
14342 (reverse (delete-dups
14343 (reverse (append
14344 (org-remove-uninherited-tags
14345 org-file-tags) tags)))))))))
14347 (defun org-add-prop-inherited (s)
14348 (add-text-properties 0 (length s) '(inherited t) s)
14351 (defun org-toggle-tag (tag &optional onoff)
14352 "Toggle the tag TAG for the current line.
14353 If ONOFF is `on' or `off', don't toggle but set to this state."
14354 (let (res current)
14355 (save-excursion
14356 (org-back-to-heading t)
14357 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14358 (point-at-eol) t)
14359 (progn
14360 (setq current (match-string 1))
14361 (replace-match ""))
14362 (setq current ""))
14363 (setq current (nreverse (org-split-string current ":")))
14364 (cond
14365 ((eq onoff 'on)
14366 (setq res t)
14367 (or (member tag current) (push tag current)))
14368 ((eq onoff 'off)
14369 (or (not (member tag current)) (setq current (delete tag current))))
14370 (t (if (member tag current)
14371 (setq current (delete tag current))
14372 (setq res t)
14373 (push tag current))))
14374 (end-of-line 1)
14375 (if current
14376 (progn
14377 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14378 (org-set-tags nil t))
14379 (delete-horizontal-space))
14380 (run-hooks 'org-after-tags-change-hook))
14381 res))
14383 (defun org-align-tags-here (to-col)
14384 ;; Assumes that this is a headline
14385 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14386 (beginning-of-line 1)
14387 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14388 (< pos (match-beginning 2)))
14389 (progn
14390 (setq tags-l (- (match-end 2) (match-beginning 2)))
14391 (goto-char (match-beginning 1))
14392 (insert " ")
14393 (delete-region (point) (1+ (match-beginning 2)))
14394 (setq ncol (max (current-column)
14395 (1+ col)
14396 (if (> to-col 0)
14397 to-col
14398 (- (abs to-col) tags-l))))
14399 (setq p (point))
14400 (insert (make-string (- ncol (current-column)) ?\ ))
14401 (setq ncol (current-column))
14402 (when indent-tabs-mode (tabify p (point-at-eol)))
14403 (org-move-to-column (min ncol col) t nil t))
14404 (goto-char pos))))
14406 (defun org-set-tags-command (&optional arg just-align)
14407 "Call the set-tags command for the current entry."
14408 (interactive "P")
14409 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14410 (org-set-tags arg just-align)
14411 (save-excursion
14412 (unless (and (org-region-active-p)
14413 org-loop-over-headlines-in-active-region)
14414 (org-back-to-heading t))
14415 (org-set-tags arg just-align))))
14417 (defun org-set-tags-to (data)
14418 "Set the tags of the current entry to DATA, replacing the current tags.
14419 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14420 If DATA is nil or the empty string, any tags will be removed."
14421 (interactive "sTags: ")
14422 (setq data
14423 (cond
14424 ((eq data nil) "")
14425 ((equal data "") "")
14426 ((stringp data)
14427 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14428 ":"))
14429 ((listp data)
14430 (concat ":" (mapconcat 'identity data ":") ":"))))
14431 (when data
14432 (save-excursion
14433 (org-back-to-heading t)
14434 (when (looking-at org-complex-heading-regexp)
14435 (if (match-end 5)
14436 (progn
14437 (goto-char (match-beginning 5))
14438 (insert data)
14439 (delete-region (point) (point-at-eol))
14440 (org-set-tags nil 'align))
14441 (goto-char (point-at-eol))
14442 (insert " " data)
14443 (org-set-tags nil 'align)))
14444 (beginning-of-line 1)
14445 (if (looking-at ".*?\\([ \t]+\\)$")
14446 (delete-region (match-beginning 1) (match-end 1))))))
14448 (defun org-align-all-tags ()
14449 "Align the tags i all headings."
14450 (interactive)
14451 (save-excursion
14452 (or (ignore-errors (org-back-to-heading t))
14453 (outline-next-heading))
14454 (if (org-at-heading-p)
14455 (org-set-tags t)
14456 (message "No headings"))))
14458 (defvar org-indent-indentation-per-level)
14459 (defun org-set-tags (&optional arg just-align)
14460 "Set the tags for the current headline.
14461 With prefix ARG, realign all tags in headings in the current buffer.
14462 When JUST-ALIGN is non-nil, only align tags.
14463 When JUST-ALIGN is 'ignore-column, align tags without trying to set
14464 the column by ignoring invisible text."
14465 (interactive "P")
14466 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14467 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14468 'region-start-level 'region))
14469 org-loop-over-headlines-in-active-region)
14470 (org-map-entries
14471 ;; We don't use ARG and JUST-ALIGN here because these args
14472 ;; are not useful when looping over headlines.
14473 `(org-set-tags)
14474 org-loop-over-headlines-in-active-region
14475 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14476 (let* ((re org-outline-regexp-bol)
14477 (current (unless arg (org-get-tags-string)))
14478 (col (current-column))
14479 (org-setting-tags t)
14480 table current-tags inherited-tags ; computed below when needed
14481 tags p0 c0 c1 rpl di tc level)
14482 (if arg
14483 (save-excursion
14484 (goto-char (point-min))
14485 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14486 (while (re-search-forward re nil t)
14487 (org-set-tags nil t)
14488 (end-of-line 1)))
14489 (message "All tags realigned to column %d" org-tags-column))
14490 (if just-align
14491 (setq tags current)
14492 ;; Get a new set of tags from the user
14493 (save-excursion
14494 (setq table (append org-tag-persistent-alist
14495 (or org-tag-alist (org-get-buffer-tags))
14496 (and
14497 org-complete-tags-always-offer-all-agenda-tags
14498 (org-global-tags-completion-table
14499 (org-agenda-files))))
14500 org-last-tags-completion-table table
14501 current-tags (org-split-string current ":")
14502 inherited-tags (nreverse
14503 (nthcdr (length current-tags)
14504 (nreverse (org-get-tags-at))))
14505 tags
14506 (if (or (eq t org-use-fast-tag-selection)
14507 (and org-use-fast-tag-selection
14508 (delq nil (mapcar 'cdr table))))
14509 (org-fast-tag-selection
14510 current-tags inherited-tags table
14511 (if org-fast-tag-selection-include-todo
14512 org-todo-key-alist))
14513 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14514 (org-trim
14515 (org-icompleting-read "Tags: "
14516 'org-tags-completion-function
14517 nil nil current 'org-tags-history))))))
14518 (while (string-match "[-+&]+" tags)
14519 ;; No boolean logic, just a list
14520 (setq tags (replace-match ":" t t tags))))
14522 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14524 (if org-tags-sort-function
14525 (setq tags (mapconcat 'identity
14526 (sort (org-split-string
14527 tags (org-re "[^[:alnum:]_@#%]+"))
14528 org-tags-sort-function) ":")))
14530 (if (string-match "\\`[\t ]*\\'" tags)
14531 (setq tags "")
14532 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14533 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14535 ;; Insert new tags at the correct column
14536 (beginning-of-line 1)
14537 (setq level (or (and (looking-at org-outline-regexp)
14538 (- (match-end 0) (point) 1))
14540 (cond
14541 ((and (equal current "") (equal tags "")))
14542 ((re-search-forward
14543 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14544 (point-at-eol) t)
14545 (if (equal tags "")
14546 (setq rpl "")
14547 (goto-char (match-beginning 0))
14548 (setq c0 (current-column)
14549 ;; compute offset for the case of org-indent-mode active
14550 di (if org-indent-mode
14551 (* (1- org-indent-indentation-per-level) (1- level))
14553 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14554 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14555 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14556 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14557 (replace-match rpl t t)
14558 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14559 tags)
14560 (t (error "Tags alignment failed")))
14561 (org-move-to-column col nil nil (not (eq just-align 'ignore-column)))
14562 (unless just-align
14563 (run-hooks 'org-after-tags-change-hook))))))
14565 (defun org-change-tag-in-region (beg end tag off)
14566 "Add or remove TAG for each entry in the region.
14567 This works in the agenda, and also in an org-mode buffer."
14568 (interactive
14569 (list (region-beginning) (region-end)
14570 (let ((org-last-tags-completion-table
14571 (if (derived-mode-p 'org-mode)
14572 (org-uniquify
14573 (delq nil (append (org-get-buffer-tags)
14574 (org-global-tags-completion-table))))
14575 (org-global-tags-completion-table))))
14576 (org-icompleting-read
14577 "Tag: " 'org-tags-completion-function nil nil nil
14578 'org-tags-history))
14579 (progn
14580 (message "[s]et or [r]emove? ")
14581 (equal (read-char-exclusive) ?r))))
14582 (if (fboundp 'deactivate-mark) (deactivate-mark))
14583 (let ((agendap (equal major-mode 'org-agenda-mode))
14584 l1 l2 m buf pos newhead (cnt 0))
14585 (goto-char end)
14586 (setq l2 (1- (org-current-line)))
14587 (goto-char beg)
14588 (setq l1 (org-current-line))
14589 (loop for l from l1 to l2 do
14590 (org-goto-line l)
14591 (setq m (get-text-property (point) 'org-hd-marker))
14592 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14593 (and agendap m))
14594 (setq buf (if agendap (marker-buffer m) (current-buffer))
14595 pos (if agendap m (point)))
14596 (with-current-buffer buf
14597 (save-excursion
14598 (save-restriction
14599 (goto-char pos)
14600 (setq cnt (1+ cnt))
14601 (org-toggle-tag tag (if off 'off 'on))
14602 (setq newhead (org-get-heading)))))
14603 (and agendap (org-agenda-change-all-lines newhead m))))
14604 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14606 (defun org-tags-completion-function (string predicate &optional flag)
14607 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14608 (confirm (lambda (x) (stringp (car x)))))
14609 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14610 (setq s1 (match-string 1 string)
14611 s2 (match-string 2 string))
14612 (setq s1 "" s2 string))
14613 (cond
14614 ((eq flag nil)
14615 ;; try completion
14616 (setq rtn (try-completion s2 ctable confirm))
14617 (if (stringp rtn)
14618 (setq rtn
14619 (concat s1 s2 (substring rtn (length s2))
14620 (if (and org-add-colon-after-tag-completion
14621 (assoc rtn ctable))
14622 ":" ""))))
14623 rtn)
14624 ((eq flag t)
14625 ;; all-completions
14626 (all-completions s2 ctable confirm))
14627 ((eq flag 'lambda)
14628 ;; exact match?
14629 (assoc s2 ctable)))))
14631 (defun org-fast-tag-insert (kwd tags face &optional end)
14632 "Insert KDW, and the TAGS, the latter with face FACE.
14633 Also insert END."
14634 (insert (format "%-12s" (concat kwd ":"))
14635 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14636 (or end "")))
14638 (defun org-fast-tag-show-exit (flag)
14639 (save-excursion
14640 (org-goto-line 3)
14641 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14642 (replace-match ""))
14643 (when flag
14644 (end-of-line 1)
14645 (org-move-to-column (- (window-width) 19) t)
14646 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14648 (defun org-set-current-tags-overlay (current prefix)
14649 "Add an overlay to CURRENT tag with PREFIX."
14650 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14651 (if (featurep 'xemacs)
14652 (org-overlay-display org-tags-overlay (concat prefix s)
14653 'secondary-selection)
14654 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14655 (org-overlay-display org-tags-overlay (concat prefix s)))))
14657 (defvar org-last-tag-selection-key nil)
14658 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14659 "Fast tag selection with single keys.
14660 CURRENT is the current list of tags in the headline, INHERITED is the
14661 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14662 possibly with grouping information. TODO-TABLE is a similar table with
14663 TODO keywords, should these have keys assigned to them.
14664 If the keys are nil, a-z are automatically assigned.
14665 Returns the new tags string, or nil to not change the current settings."
14666 (let* ((fulltable (append table todo-table))
14667 (maxlen (apply 'max (mapcar
14668 (lambda (x)
14669 (if (stringp (car x)) (string-width (car x)) 0))
14670 fulltable)))
14671 (buf (current-buffer))
14672 (expert (eq org-fast-tag-selection-single-key 'expert))
14673 (buffer-tags nil)
14674 (fwidth (+ maxlen 3 1 3))
14675 (ncol (/ (- (window-width) 4) fwidth))
14676 (i-face 'org-done)
14677 (c-face 'org-todo)
14678 tg cnt e c char c1 c2 ntable tbl rtn
14679 ov-start ov-end ov-prefix
14680 (exit-after-next org-fast-tag-selection-single-key)
14681 (done-keywords org-done-keywords)
14682 groups ingroup)
14683 (save-excursion
14684 (beginning-of-line 1)
14685 (if (looking-at
14686 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14687 (setq ov-start (match-beginning 1)
14688 ov-end (match-end 1)
14689 ov-prefix "")
14690 (setq ov-start (1- (point-at-eol))
14691 ov-end (1+ ov-start))
14692 (skip-chars-forward "^\n\r")
14693 (setq ov-prefix
14694 (concat
14695 (buffer-substring (1- (point)) (point))
14696 (if (> (current-column) org-tags-column)
14698 (make-string (- org-tags-column (current-column)) ?\ ))))))
14699 (move-overlay org-tags-overlay ov-start ov-end)
14700 (save-window-excursion
14701 (if expert
14702 (set-buffer (get-buffer-create " *Org tags*"))
14703 (delete-other-windows)
14704 (split-window-vertically)
14705 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14706 (erase-buffer)
14707 (org-set-local 'org-done-keywords done-keywords)
14708 (org-fast-tag-insert "Inherited" inherited i-face "\n")
14709 (org-fast-tag-insert "Current" current c-face "\n\n")
14710 (org-fast-tag-show-exit exit-after-next)
14711 (org-set-current-tags-overlay current ov-prefix)
14712 (setq tbl fulltable char ?a cnt 0)
14713 (while (setq e (pop tbl))
14714 (cond
14715 ((equal (car e) :startgroup)
14716 (push '() groups) (setq ingroup t)
14717 (when (not (= cnt 0))
14718 (setq cnt 0)
14719 (insert "\n"))
14720 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14721 ((equal (car e) :endgroup)
14722 (setq ingroup nil cnt 0)
14723 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
14724 ((equal e '(:newline))
14725 (when (not (= cnt 0))
14726 (setq cnt 0)
14727 (insert "\n")
14728 (setq e (car tbl))
14729 (while (equal (car tbl) '(:newline))
14730 (insert "\n")
14731 (setq tbl (cdr tbl)))))
14732 ((equal e '(:grouptags)) nil)
14734 (setq tg (copy-sequence (car e)) c2 nil)
14735 (if (cdr e)
14736 (setq c (cdr e))
14737 ;; automatically assign a character.
14738 (setq c1 (string-to-char
14739 (downcase (substring
14740 tg (if (= (string-to-char tg) ?@) 1 0)))))
14741 (if (or (rassoc c1 ntable) (rassoc c1 table))
14742 (while (or (rassoc char ntable) (rassoc char table))
14743 (setq char (1+ char)))
14744 (setq c2 c1))
14745 (setq c (or c2 char)))
14746 (if ingroup (push tg (car groups)))
14747 (setq tg (org-add-props tg nil 'face
14748 (cond
14749 ((not (assoc tg table))
14750 (org-get-todo-face tg))
14751 ((member tg current) c-face)
14752 ((member tg inherited) i-face))))
14753 (if (equal (caar tbl) :grouptags)
14754 (org-add-props tg nil 'face 'org-tag-group))
14755 (if (and (= cnt 0) (not ingroup)) (insert " "))
14756 (insert "[" c "] " tg (make-string
14757 (- fwidth 4 (length tg)) ?\ ))
14758 (push (cons tg c) ntable)
14759 (when (= (setq cnt (1+ cnt)) ncol)
14760 (insert "\n")
14761 (if ingroup (insert " "))
14762 (setq cnt 0)))))
14763 (setq ntable (nreverse ntable))
14764 (insert "\n")
14765 (goto-char (point-min))
14766 (if (not expert) (org-fit-window-to-buffer))
14767 (setq rtn
14768 (catch 'exit
14769 (while t
14770 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14771 (if (not groups) "no " "")
14772 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14773 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14774 (setq org-last-tag-selection-key c)
14775 (cond
14776 ((= c ?\r) (throw 'exit t))
14777 ((= c ?!)
14778 (setq groups (not groups))
14779 (goto-char (point-min))
14780 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14781 ((= c ?\C-c)
14782 (if (not expert)
14783 (org-fast-tag-show-exit
14784 (setq exit-after-next (not exit-after-next)))
14785 (setq expert nil)
14786 (delete-other-windows)
14787 (set-window-buffer (split-window-vertically) " *Org tags*")
14788 (org-switch-to-buffer-other-window " *Org tags*")
14789 (org-fit-window-to-buffer)))
14790 ((or (= c ?\C-g)
14791 (and (= c ?q) (not (rassoc c ntable))))
14792 (org-detach-overlay org-tags-overlay)
14793 (setq quit-flag t))
14794 ((= c ?\ )
14795 (setq current nil)
14796 (if exit-after-next (setq exit-after-next 'now)))
14797 ((= c ?\t)
14798 (condition-case nil
14799 (setq tg (org-icompleting-read
14800 "Tag: "
14801 (or buffer-tags
14802 (with-current-buffer buf
14803 (org-get-buffer-tags)))))
14804 (quit (setq tg "")))
14805 (when (string-match "\\S-" tg)
14806 (add-to-list 'buffer-tags (list tg))
14807 (if (member tg current)
14808 (setq current (delete tg current))
14809 (push tg current)))
14810 (if exit-after-next (setq exit-after-next 'now)))
14811 ((setq e (rassoc c todo-table) tg (car e))
14812 (with-current-buffer buf
14813 (save-excursion (org-todo tg)))
14814 (if exit-after-next (setq exit-after-next 'now)))
14815 ((setq e (rassoc c ntable) tg (car e))
14816 (if (member tg current)
14817 (setq current (delete tg current))
14818 (loop for g in groups do
14819 (if (member tg g)
14820 (mapc (lambda (x)
14821 (setq current (delete x current)))
14822 g)))
14823 (push tg current))
14824 (if exit-after-next (setq exit-after-next 'now))))
14826 ;; Create a sorted list
14827 (setq current
14828 (sort current
14829 (lambda (a b)
14830 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14831 (if (eq exit-after-next 'now) (throw 'exit t))
14832 (goto-char (point-min))
14833 (beginning-of-line 2)
14834 (delete-region (point) (point-at-eol))
14835 (org-fast-tag-insert "Current" current c-face)
14836 (org-set-current-tags-overlay current ov-prefix)
14837 (while (re-search-forward
14838 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
14839 (setq tg (match-string 1))
14840 (add-text-properties
14841 (match-beginning 1) (match-end 1)
14842 (list 'face
14843 (cond
14844 ((member tg current) c-face)
14845 ((member tg inherited) i-face)
14846 (t (get-text-property (match-beginning 1) 'face))))))
14847 (goto-char (point-min)))))
14848 (org-detach-overlay org-tags-overlay)
14849 (if rtn
14850 (mapconcat 'identity current ":")
14851 nil))))
14853 (defun org-get-tags-string ()
14854 "Get the TAGS string in the current headline."
14855 (unless (org-at-heading-p t)
14856 (user-error "Not on a heading"))
14857 (save-excursion
14858 (beginning-of-line 1)
14859 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14860 (org-match-string-no-properties 1)
14861 "")))
14863 (defun org-get-tags ()
14864 "Get the list of tags specified in the current headline."
14865 (org-split-string (org-get-tags-string) ":"))
14867 (defun org-get-buffer-tags ()
14868 "Get a table of all tags used in the buffer, for completion."
14869 (let (tags)
14870 (save-excursion
14871 (goto-char (point-min))
14872 (while (re-search-forward
14873 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
14874 (when (equal (char-after (point-at-bol 0)) ?*)
14875 (mapc (lambda (x) (add-to-list 'tags x))
14876 (org-split-string (org-match-string-no-properties 1) ":")))))
14877 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14878 (mapcar 'list tags)))
14880 ;;;; The mapping API
14882 (defun org-map-entries (func &optional match scope &rest skip)
14883 "Call FUNC at each headline selected by MATCH in SCOPE.
14885 FUNC is a function or a lisp form. The function will be called without
14886 arguments, with the cursor positioned at the beginning of the headline.
14887 The return values of all calls to the function will be collected and
14888 returned as a list.
14890 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14891 does not need to preserve point. After evaluation, the cursor will be
14892 moved to the end of the line (presumably of the headline of the
14893 processed entry) and search continues from there. Under some
14894 circumstances, this may not produce the wanted results. For example,
14895 if you have removed (e.g. archived) the current (sub)tree it could
14896 mean that the next entry will be skipped entirely. In such cases, you
14897 can specify the position from where search should continue by making
14898 FUNC set the variable `org-map-continue-from' to the desired buffer
14899 position.
14901 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14902 Only headlines that are matched by this query will be considered during
14903 the iteration. When MATCH is nil or t, all headlines will be
14904 visited by the iteration.
14906 SCOPE determines the scope of this command. It can be any of:
14908 nil The current buffer, respecting the restriction if any
14909 tree The subtree started with the entry at point
14910 region The entries within the active region, if any
14911 region-start-level
14912 The entries within the active region, but only those at
14913 the same level than the first one.
14914 file The current buffer, without restriction
14915 file-with-archives
14916 The current buffer, and any archives associated with it
14917 agenda All agenda files
14918 agenda-with-archives
14919 All agenda files with any archive files associated with them
14920 \(file1 file2 ...)
14921 If this is a list, all files in the list will be scanned
14923 The remaining args are treated as settings for the skipping facilities of
14924 the scanner. The following items can be given here:
14926 archive skip trees with the archive tag
14927 comment skip trees with the COMMENT keyword
14928 function or Emacs Lisp form:
14929 will be used as value for `org-agenda-skip-function', so
14930 whenever the function returns a position, FUNC will not be
14931 called for that entry and search will continue from the
14932 position returned
14934 If your function needs to retrieve the tags including inherited tags
14935 at the *current* entry, you can use the value of the variable
14936 `org-scanner-tags' which will be much faster than getting the value
14937 with `org-get-tags-at'. If your function gets properties with
14938 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14939 to t around the call to `org-entry-properties' to get the same speedup.
14940 Note that if your function moves around to retrieve tags and properties at
14941 a *different* entry, you cannot use these techniques."
14942 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14943 (not (org-region-active-p)))
14944 (let* ((org-agenda-archives-mode nil) ; just to make sure
14945 (org-agenda-skip-archived-trees (memq 'archive skip))
14946 (org-agenda-skip-comment-trees (memq 'comment skip))
14947 (org-agenda-skip-function
14948 (car (org-delete-all '(comment archive) skip)))
14949 (org-tags-match-list-sublevels t)
14950 (start-level (eq scope 'region-start-level))
14951 matcher file res
14952 org-todo-keywords-for-agenda
14953 org-done-keywords-for-agenda
14954 org-todo-keyword-alist-for-agenda
14955 org-drawers-for-agenda
14956 org-tag-alist-for-agenda
14957 todo-only)
14959 (cond
14960 ((eq match t) (setq matcher t))
14961 ((eq match nil) (setq matcher t))
14962 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14964 (save-window-excursion
14965 (save-restriction
14966 (cond ((eq scope 'tree)
14967 (org-back-to-heading t)
14968 (org-narrow-to-subtree)
14969 (setq scope nil))
14970 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14971 (org-region-active-p))
14972 ;; If needed, set start-level to a string like "2"
14973 (when start-level
14974 (save-excursion
14975 (goto-char (region-beginning))
14976 (unless (org-at-heading-p) (outline-next-heading))
14977 (setq start-level (org-current-level))))
14978 (narrow-to-region (region-beginning)
14979 (save-excursion
14980 (goto-char (region-end))
14981 (unless (and (bolp) (org-at-heading-p))
14982 (outline-next-heading))
14983 (point)))
14984 (setq scope nil)))
14986 (if (not scope)
14987 (progn
14988 (org-agenda-prepare-buffers
14989 (list (buffer-file-name (current-buffer))))
14990 (setq res (org-scan-tags func matcher todo-only start-level)))
14991 ;; Get the right scope
14992 (cond
14993 ((and scope (listp scope) (symbolp (car scope)))
14994 (setq scope (eval scope)))
14995 ((eq scope 'agenda)
14996 (setq scope (org-agenda-files t)))
14997 ((eq scope 'agenda-with-archives)
14998 (setq scope (org-agenda-files t))
14999 (setq scope (org-add-archive-files scope)))
15000 ((eq scope 'file)
15001 (setq scope (list (buffer-file-name))))
15002 ((eq scope 'file-with-archives)
15003 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15004 (org-agenda-prepare-buffers scope)
15005 (while (setq file (pop scope))
15006 (with-current-buffer (org-find-base-buffer-visiting file)
15007 (save-excursion
15008 (save-restriction
15009 (widen)
15010 (goto-char (point-min))
15011 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15012 res)))
15014 ;;;; Properties
15016 ;;; Setting and retrieving properties
15018 (defconst org-special-properties
15019 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15020 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15021 "The special properties valid in Org-mode.
15023 These are properties that are not defined in the property drawer,
15024 but in some other way.")
15026 (defconst org-default-properties
15027 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15028 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15029 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15030 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15031 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15032 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15033 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15034 "Some properties that are used by Org-mode for various purposes.
15035 Being in this list makes sure that they are offered for completion.")
15037 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
15038 "Regular expression matching the first line of a property drawer.")
15040 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
15041 "Regular expression matching the last line of a property drawer.")
15043 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
15044 "Regular expression matching the first line of a property drawer.")
15046 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
15047 "Regular expression matching the first line of a property drawer.")
15049 (defconst org-property-drawer-re
15050 (concat "\\(" org-property-start-re "\\)[^\000]*\\("
15051 org-property-end-re "\\)\n?")
15052 "Matches an entire property drawer.")
15054 (defconst org-clock-drawer-re
15055 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
15056 org-property-end-re "\\)\n?")
15057 "Matches an entire clock drawer.")
15059 (defun org-property-action ()
15060 "Do an action on properties."
15061 (interactive)
15062 (let (c)
15063 (org-at-property-p)
15064 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15065 (setq c (read-char-exclusive))
15066 (cond
15067 ((equal c ?s)
15068 (call-interactively 'org-set-property))
15069 ((equal c ?d)
15070 (call-interactively 'org-delete-property))
15071 ((equal c ?D)
15072 (call-interactively 'org-delete-property-globally))
15073 ((equal c ?c)
15074 (call-interactively 'org-compute-property-at-point))
15075 (t (user-error "No such property action %c" c)))))
15077 (defun org-inc-effort ()
15078 "Increment the value of the effort property in the current entry."
15079 (interactive)
15080 (org-set-effort nil t))
15082 (defvar org-clock-effort) ;; Defined in org-clock.el
15083 (defvar org-clock-current-task) ;; Defined in org-clock.el
15084 (defun org-set-effort (&optional value increment)
15085 "Set the effort property of the current entry.
15086 With numerical prefix arg, use the nth allowed value, 0 stands for the
15087 10th allowed value.
15089 When INCREMENT is non-nil, set the property to the next allowed value."
15090 (interactive "P")
15091 (if (equal value 0) (setq value 10))
15092 (let* ((completion-ignore-case t)
15093 (prop org-effort-property)
15094 (cur (org-entry-get nil prop))
15095 (allowed (org-property-get-allowed-values nil prop 'table))
15096 (existing (mapcar 'list (org-property-values prop)))
15097 (heading (nth 4 (org-heading-components)))
15099 (val (cond
15100 ((stringp value) value)
15101 ((and allowed (integerp value))
15102 (or (car (nth (1- value) allowed))
15103 (car (org-last allowed))))
15104 ((and allowed increment)
15105 (or (caadr (member (list cur) allowed))
15106 (user-error "Allowed effort values are not set")))
15107 (allowed
15108 (message "Select 1-9,0, [RET%s]: %s"
15109 (if cur (concat "=" cur) "")
15110 (mapconcat 'car allowed " "))
15111 (setq rpl (read-char-exclusive))
15112 (if (equal rpl ?\r)
15114 (setq rpl (- rpl ?0))
15115 (if (equal rpl 0) (setq rpl 10))
15116 (if (and (> rpl 0) (<= rpl (length allowed)))
15117 (car (nth (1- rpl) allowed))
15118 (org-completing-read "Effort: " allowed nil))))
15120 (let (org-completion-use-ido org-completion-use-iswitchb)
15121 (org-completing-read
15122 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15123 (concat "[" cur "]") "")
15124 ": ")
15125 existing nil nil "" nil cur))))))
15126 (unless (equal (org-entry-get nil prop) val)
15127 (org-entry-put nil prop val))
15128 (save-excursion
15129 (org-back-to-heading t)
15130 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15131 (when (string= heading org-clock-current-task)
15132 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15133 (org-clock-update-mode-line))
15134 (message "%s is now %s" prop val)))
15136 (defun org-at-property-p ()
15137 "Is cursor inside a property drawer?"
15138 (save-excursion
15139 (when (equal 'node-property (car (org-element-at-point)))
15140 (beginning-of-line 1)
15141 (looking-at org-property-re))))
15143 (defun org-get-property-block (&optional beg end force)
15144 "Return the (beg . end) range of the body of the property drawer.
15145 BEG and END are the beginning and end of the current subtree, or of
15146 the part before the first headline. If they are not given, they will
15147 be found. If the drawer does not exist and FORCE is non-nil, create
15148 the drawer."
15149 (catch 'exit
15150 (save-excursion
15151 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15152 (progn (org-back-to-heading t) (point))))
15153 (end (or end (and (not (outline-next-heading)) (point-max))
15154 (point))))
15155 (goto-char beg)
15156 (if (re-search-forward org-property-start-re end t)
15157 (setq beg (1+ (match-end 0)))
15158 (if force
15159 (save-excursion
15160 (org-insert-property-drawer)
15161 (setq end (progn (outline-next-heading) (point))))
15162 (throw 'exit nil))
15163 (goto-char beg)
15164 (if (re-search-forward org-property-start-re end t)
15165 (setq beg (1+ (match-end 0)))))
15166 (if (re-search-forward org-property-end-re end t)
15167 (setq end (match-beginning 0))
15168 (or force (throw 'exit nil))
15169 (goto-char beg)
15170 (setq end beg)
15171 (org-indent-line)
15172 (insert ":END:\n"))
15173 (cons beg end)))))
15175 (defun org-entry-properties (&optional pom which specific)
15176 "Get all properties of the entry at point-or-marker POM.
15177 This includes the TODO keyword, the tags, time strings for deadline,
15178 scheduled, and clocking, and any additional properties defined in the
15179 entry. The return value is an alist, keys may occur multiple times
15180 if the property key was used several times.
15181 POM may also be nil, in which case the current entry is used.
15182 If WHICH is nil or `all', get all properties. If WHICH is
15183 `special' or `standard', only get that subclass. If WHICH
15184 is a string only get exactly this property. SPECIFIC can be a string, the
15185 specific property we are interested in. Specifying it can speed
15186 things up because then unnecessary parsing is avoided."
15187 (setq which (or which 'all))
15188 (org-with-wide-buffer
15189 (org-with-point-at pom
15190 (let ((clockstr (substring org-clock-string 0 -1))
15191 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15192 (case-fold-search nil)
15193 beg end range props sum-props key key1 value string clocksum clocksumt)
15194 (when (and (derived-mode-p 'org-mode)
15195 (ignore-errors (org-back-to-heading t)))
15196 (setq beg (point))
15197 (setq sum-props (get-text-property (point) 'org-summaries))
15198 (setq clocksum (get-text-property (point) :org-clock-minutes)
15199 clocksumt (get-text-property (point) :org-clock-minutes-today))
15200 (outline-next-heading)
15201 (setq end (point))
15202 (when (memq which '(all special))
15203 ;; Get the special properties, like TODO and tags
15204 (goto-char beg)
15205 (when (and (or (not specific) (string= specific "TODO"))
15206 (looking-at org-todo-line-regexp) (match-end 2))
15207 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15208 (when (and (or (not specific) (string= specific "PRIORITY"))
15209 (looking-at org-priority-regexp))
15210 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15211 (when (or (not specific) (string= specific "FILE"))
15212 (push (cons "FILE" buffer-file-name) props))
15213 (when (and (or (not specific) (string= specific "TAGS"))
15214 (setq value (org-get-tags-string))
15215 (string-match "\\S-" value))
15216 (push (cons "TAGS" value) props))
15217 (when (and (or (not specific) (string= specific "ALLTAGS"))
15218 (setq value (org-get-tags-at)))
15219 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15220 ":"))
15221 props))
15222 (when (or (not specific) (string= specific "BLOCKED"))
15223 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15224 (when (or (not specific)
15225 (member specific
15226 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15227 "TIMESTAMP" "TIMESTAMP_IA")))
15228 (catch 'match
15229 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15230 (setq key (if (match-end 1)
15231 (substring (org-match-string-no-properties 1)
15232 0 -1))
15233 string (if (equal key clockstr)
15234 (org-trim
15235 (buffer-substring-no-properties
15236 (match-beginning 3) (goto-char
15237 (point-at-eol))))
15238 (substring (org-match-string-no-properties 3)
15239 1 -1)))
15240 ;; Get the correct property name from the key. This is
15241 ;; necessary if the user has configured time keywords.
15242 (setq key1 (concat key ":"))
15243 (cond
15244 ((not key)
15245 (setq key
15246 (if (= (char-after (match-beginning 3)) ?\[)
15247 "TIMESTAMP_IA" "TIMESTAMP")))
15248 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15249 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15250 ((equal key1 org-closed-string) (setq key "CLOSED"))
15251 ((equal key1 org-clock-string) (setq key "CLOCK")))
15252 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15253 (progn
15254 (push (cons key string) props)
15255 ;; no need to search further if match is found
15256 (throw 'match t))
15257 (when (or (equal key "CLOCK") (not (assoc key props)))
15258 (push (cons key string) props)))))))
15260 (when (memq which '(all standard))
15261 ;; Get the standard properties, like :PROP: ...
15262 (setq range (org-get-property-block beg end))
15263 (when range
15264 (goto-char (car range))
15265 (while (re-search-forward org-property-re
15266 (cdr range) t)
15267 (setq key (org-match-string-no-properties 2)
15268 value (org-trim (or (org-match-string-no-properties 3) "")))
15269 (unless (member key excluded)
15270 (push (cons key (or value "")) props)))))
15271 (if clocksum
15272 (push (cons "CLOCKSUM"
15273 (org-columns-number-to-string (/ (float clocksum) 60.)
15274 'add_times))
15275 props))
15276 (if clocksumt
15277 (push (cons "CLOCKSUM_T"
15278 (org-columns-number-to-string (/ (float clocksumt) 60.)
15279 'add_times))
15280 props))
15281 (unless (assoc "CATEGORY" props)
15282 (push (cons "CATEGORY" (org-get-category)) props))
15283 (append sum-props (nreverse props)))))))
15285 (defun org-entry-get (pom property &optional inherit literal-nil)
15286 "Get value of PROPERTY for entry or content at point-or-marker POM.
15287 If INHERIT is non-nil and the entry does not have the property,
15288 then also check higher levels of the hierarchy.
15289 If INHERIT is the symbol `selective', use inheritance only if the setting
15290 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15291 If the property is present but empty, the return value is the empty string.
15292 If the property is not present at all, nil is returned.
15294 Return the value as a string.
15296 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15297 do not interpret it as the list atom nil. This is used for inheritance
15298 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15299 (org-with-point-at pom
15300 (if (and inherit (if (eq inherit 'selective)
15301 (org-property-inherit-p property)
15303 (org-entry-get-with-inheritance property literal-nil)
15304 (if (member property org-special-properties)
15305 ;; We need a special property. Use `org-entry-properties'
15306 ;; to retrieve it, but specify the wanted property
15307 (cdr (assoc property (org-entry-properties nil 'special property)))
15308 (org-with-wide-buffer
15309 (let ((range (org-get-property-block)))
15310 (when (and range (not (eq (car range) (cdr range))))
15311 (let* ((props
15312 (list (or (assoc property org-file-properties)
15313 (assoc property org-global-properties)
15314 (assoc property org-global-properties-fixed))))
15315 (ap (lambda (key)
15316 (when (re-search-forward
15317 (org-re-property key) (cdr range) t)
15318 (setq props
15319 (org-update-property-plist
15321 (if (match-end 3)
15322 (org-match-string-no-properties 3) "")
15323 props)))))
15324 val)
15325 (goto-char (car range))
15326 (funcall ap property)
15327 (goto-char (car range))
15328 (while (funcall ap (concat property "+")))
15329 (setq val (cdr (assoc property props)))
15330 (when val (if literal-nil val (org-not-nil val)))))))))))
15332 (defun org-property-or-variable-value (var &optional inherit)
15333 "Check if there is a property fixing the value of VAR.
15334 If yes, return this value. If not, return the current value of the variable."
15335 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15336 (if (and prop (stringp prop) (string-match "\\S-" prop))
15337 (read prop)
15338 (symbol-value var))))
15340 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15341 "Delete the property PROPERTY from entry at point-or-marker POM.
15342 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15343 an empty drawer to delete."
15344 (org-with-point-at pom
15345 (if (member property org-special-properties)
15346 nil ; cannot delete these properties.
15347 (let ((range (org-get-property-block)))
15348 (if (and range
15349 (goto-char (car range))
15350 (re-search-forward
15351 (org-re-property property)
15352 (cdr range) t))
15353 (progn
15354 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15355 (and delete-empty-drawer
15356 (org-remove-empty-drawer-at
15357 delete-empty-drawer (car range)))
15359 nil)))))
15361 ;; Multi-values properties are properties that contain multiple values
15362 ;; These values are assumed to be single words, separated by whitespace.
15363 (defun org-entry-add-to-multivalued-property (pom property value)
15364 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15365 (let* ((old (org-entry-get pom property))
15366 (values (and old (org-split-string old "[ \t]"))))
15367 (setq value (org-entry-protect-space value))
15368 (unless (member value values)
15369 (setq values (append values (list value)))
15370 (org-entry-put pom property
15371 (mapconcat 'identity values " ")))))
15373 (defun org-entry-remove-from-multivalued-property (pom property value)
15374 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15375 (let* ((old (org-entry-get pom property))
15376 (values (and old (org-split-string old "[ \t]"))))
15377 (setq value (org-entry-protect-space value))
15378 (when (member value values)
15379 (setq values (delete value values))
15380 (org-entry-put pom property
15381 (mapconcat 'identity values " ")))))
15383 (defun org-entry-member-in-multivalued-property (pom property value)
15384 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15385 (let* ((old (org-entry-get pom property))
15386 (values (and old (org-split-string old "[ \t]"))))
15387 (setq value (org-entry-protect-space value))
15388 (member value values)))
15390 (defun org-entry-get-multivalued-property (pom property)
15391 "Return a list of values in a multivalued property."
15392 (let* ((value (org-entry-get pom property))
15393 (values (and value (org-split-string value "[ \t]"))))
15394 (mapcar 'org-entry-restore-space values)))
15396 (defun org-entry-put-multivalued-property (pom property &rest values)
15397 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15398 VALUES should be a list of strings. Spaces will be protected."
15399 (org-entry-put pom property
15400 (mapconcat 'org-entry-protect-space values " "))
15401 (let* ((value (org-entry-get pom property))
15402 (values (and value (org-split-string value "[ \t]"))))
15403 (mapcar 'org-entry-restore-space values)))
15405 (defun org-entry-protect-space (s)
15406 "Protect spaces and newline in string S."
15407 (while (string-match " " s)
15408 (setq s (replace-match "%20" t t s)))
15409 (while (string-match "\n" s)
15410 (setq s (replace-match "%0A" t t s)))
15413 (defun org-entry-restore-space (s)
15414 "Restore spaces and newline in string S."
15415 (while (string-match "%20" s)
15416 (setq s (replace-match " " t t s)))
15417 (while (string-match "%0A" s)
15418 (setq s (replace-match "\n" t t s)))
15421 (defvar org-entry-property-inherited-from (make-marker)
15422 "Marker pointing to the entry from where a property was inherited.
15423 Each call to `org-entry-get-with-inheritance' will set this marker to the
15424 location of the entry where the inheritance search matched. If there was
15425 no match, the marker will point nowhere.
15426 Note that also `org-entry-get' calls this function, if the INHERIT flag
15427 is set.")
15429 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15430 "Get PROPERTY of entry or content at point, search higher levels if needed.
15431 The search will stop at the first ancestor which has the property defined.
15432 If the value found is \"nil\", return nil to show that the property
15433 should be considered as undefined (this is the meaning of nil here).
15434 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15435 (move-marker org-entry-property-inherited-from nil)
15436 (let (tmp)
15437 (save-excursion
15438 (save-restriction
15439 (widen)
15440 (catch 'ex
15441 (while t
15442 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15443 (or (ignore-errors (org-back-to-heading t))
15444 (goto-char (point-min)))
15445 (move-marker org-entry-property-inherited-from (point))
15446 (throw 'ex tmp))
15447 (or (ignore-errors (org-up-heading-safe))
15448 (throw 'ex nil))))))
15449 (setq tmp (or tmp
15450 (cdr (assoc property org-file-properties))
15451 (cdr (assoc property org-global-properties))
15452 (cdr (assoc property org-global-properties-fixed))))
15453 (if literal-nil tmp (org-not-nil tmp))))
15455 (defvar org-property-changed-functions nil
15456 "Hook called when the value of a property has changed.
15457 Each hook function should accept two arguments, the name of the property
15458 and the new value.")
15460 (defun org-entry-put (pom property value)
15461 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15462 If the value is `nil', it is converted to the empty string.
15463 If it is not a string, an error is raised."
15464 (cond ((null value) (setq value ""))
15465 ((not (stringp value))
15466 (error "Properties values should be strings.")))
15467 (org-with-point-at pom
15468 (org-back-to-heading t)
15469 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15470 range)
15471 (cond
15472 ((equal property "TODO")
15473 (when (and (string-match "\\S-" value)
15474 (not (member value org-todo-keywords-1)))
15475 (user-error "\"%s\" is not a valid TODO state" value))
15476 (if (or (not value)
15477 (not (string-match "\\S-" value)))
15478 (setq value 'none))
15479 (org-todo value)
15480 (org-set-tags nil 'align))
15481 ((equal property "PRIORITY")
15482 (org-priority (if (and value (string-match "\\S-" value))
15483 (string-to-char value) ?\ ))
15484 (org-set-tags nil 'align))
15485 ((equal property "CLOCKSUM")
15486 (if (not (re-search-forward
15487 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15488 (error "Cannot find a clock log")
15489 (goto-char (- (match-end 1) 2))
15490 (cond
15491 ((eq value 'earlier) (org-timestamp-down))
15492 ((eq value 'later) (org-timestamp-up)))
15493 (org-clock-sum-current-item)))
15494 ((equal property "SCHEDULED")
15495 (if (re-search-forward org-scheduled-time-regexp end t)
15496 (cond
15497 ((eq value 'earlier) (org-timestamp-change -1 'day))
15498 ((eq value 'later) (org-timestamp-change 1 'day))
15499 (t (call-interactively 'org-schedule)))
15500 (call-interactively 'org-schedule)))
15501 ((equal property "DEADLINE")
15502 (if (re-search-forward org-deadline-time-regexp end t)
15503 (cond
15504 ((eq value 'earlier) (org-timestamp-change -1 'day))
15505 ((eq value 'later) (org-timestamp-change 1 'day))
15506 (t (call-interactively 'org-deadline)))
15507 (call-interactively 'org-deadline)))
15508 ((member property org-special-properties)
15509 (error "The %s property can not yet be set with `org-entry-put'"
15510 property))
15511 (t ; a non-special property
15512 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15513 (setq range (org-get-property-block beg end 'force))
15514 (goto-char (car range))
15515 (if (re-search-forward
15516 (org-re-property property) (cdr range) t)
15517 (progn
15518 (delete-region (match-beginning 0) (match-end 0))
15519 (goto-char (match-beginning 0)))
15520 (goto-char (cdr range))
15521 (insert "\n")
15522 (backward-char 1)
15523 (org-indent-line))
15524 (insert ":" property ":")
15525 (and value (insert " " value))
15526 (org-indent-line)))))
15527 (run-hook-with-args 'org-property-changed-functions property value)))
15529 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15530 "Get all property keys in the current buffer.
15531 With INCLUDE-SPECIALS, also list the special properties that reflect things
15532 like tags and TODO state.
15533 With INCLUDE-DEFAULTS, also include properties that has special meaning
15534 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15535 and others.
15536 With INCLUDE-COLUMNS, also include property names given in COLUMN
15537 formats in the current buffer."
15538 (let (rtn range cfmt s p)
15539 (save-excursion
15540 (save-restriction
15541 (widen)
15542 (goto-char (point-min))
15543 (while (re-search-forward org-property-start-re nil t)
15544 (setq range (org-get-property-block))
15545 (goto-char (car range))
15546 (while (re-search-forward org-property-re
15547 (cdr range) t)
15548 (add-to-list 'rtn (org-match-string-no-properties 2)))
15549 (outline-next-heading))))
15551 (when include-specials
15552 (setq rtn (append org-special-properties rtn)))
15554 (when include-defaults
15555 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15556 (add-to-list 'rtn org-effort-property))
15558 (when include-columns
15559 (save-excursion
15560 (save-restriction
15561 (widen)
15562 (goto-char (point-min))
15563 (while (re-search-forward
15564 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15565 nil t)
15566 (setq cfmt (match-string 2) s 0)
15567 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15568 cfmt s)
15569 (setq s (match-end 0)
15570 p (match-string 1 cfmt))
15571 (unless (or (equal p "ITEM")
15572 (member p org-special-properties))
15573 (add-to-list 'rtn (match-string 1 cfmt))))))))
15575 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15577 (defun org-property-values (key)
15578 "Return a list of all values of property KEY in the current buffer."
15579 (save-excursion
15580 (save-restriction
15581 (widen)
15582 (goto-char (point-min))
15583 (let ((re (org-re-property key))
15584 values)
15585 (while (re-search-forward re nil t)
15586 (add-to-list 'values (org-trim (match-string 3))))
15587 (delete "" values)))))
15589 (defun org-insert-property-drawer ()
15590 "Insert a property drawer into the current entry."
15591 (org-back-to-heading t)
15592 (looking-at org-outline-regexp)
15593 (let ((indent (if org-adapt-indentation
15594 (- (match-end 0) (match-beginning 0))
15596 (beg (point))
15597 (re (concat "^[ \t]*" org-keyword-time-regexp))
15598 end hiddenp)
15599 (outline-next-heading)
15600 (setq end (point))
15601 (goto-char beg)
15602 (while (re-search-forward re end t))
15603 (setq hiddenp (outline-invisible-p))
15604 (end-of-line 1)
15605 (and (equal (char-after) ?\n) (forward-char 1))
15606 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
15607 (if (member (match-string 1) '("CLOCK:" ":END:"))
15608 ;; just skip this line
15609 (beginning-of-line 2)
15610 ;; Drawer start, find the end
15611 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15612 (beginning-of-line 1)))
15613 (org-skip-over-state-notes)
15614 (skip-chars-backward " \t\n\r")
15615 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15616 (forward-char 1))
15617 (goto-char (point-at-eol))
15618 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15619 (beginning-of-line 0)
15620 (org-indent-to-column indent)
15621 (beginning-of-line 2)
15622 (org-indent-to-column indent)
15623 (beginning-of-line 0)
15624 (if hiddenp
15625 (save-excursion
15626 (org-back-to-heading t)
15627 (hide-entry))
15628 (org-flag-drawer t))))
15630 (defun org-insert-drawer (&optional arg drawer)
15631 "Insert a drawer at point.
15633 Optional argument DRAWER, when non-nil, is a string representing
15634 drawer's name. Otherwise, the user is prompted for a name.
15636 If a region is active, insert the drawer around that region
15637 instead.
15639 Point is left between drawer's boundaries."
15640 (interactive "P")
15641 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15642 "LOGBOOK"))
15643 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15644 ;; internally by Org. They are meant to be inserted
15645 ;; automatically.
15646 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15647 ;; Remove system drawers from list. Note: For some reason,
15648 ;; `org-completing-read' ignores the predicate while
15649 ;; `completing-read' handles it fine.
15650 (drawer (if arg "PROPERTIES"
15651 (or drawer
15652 (completing-read
15653 "Drawer: " org-drawers
15654 (lambda (d) (not (member d system-drawers))))))))
15655 (cond
15656 ;; With C-u, fall back on `org-insert-property-drawer'
15657 (arg (org-insert-property-drawer))
15658 ;; With an active region, insert a drawer at point.
15659 ((not (org-region-active-p))
15660 (progn
15661 (unless (bolp) (insert "\n"))
15662 (insert (format ":%s:\n\n:END:\n" drawer))
15663 (forward-line -2)))
15664 ;; Otherwise, insert the drawer at point
15666 (let ((rbeg (region-beginning))
15667 (rend (copy-marker (region-end))))
15668 (unwind-protect
15669 (progn
15670 (goto-char rbeg)
15671 (beginning-of-line)
15672 (when (save-excursion
15673 (re-search-forward org-outline-regexp-bol rend t))
15674 (user-error "Drawers cannot contain headlines"))
15675 ;; Position point at the beginning of the first
15676 ;; non-blank line in region. Insert drawer's opening
15677 ;; there, then indent it.
15678 (org-skip-whitespace)
15679 (beginning-of-line)
15680 (insert ":" drawer ":\n")
15681 (forward-line -1)
15682 (indent-for-tab-command)
15683 ;; Move point to the beginning of the first blank line
15684 ;; after the last non-blank line in region. Insert
15685 ;; drawer's closing, then indent it.
15686 (goto-char rend)
15687 (skip-chars-backward " \r\t\n")
15688 (insert "\n:END:")
15689 (deactivate-mark t)
15690 (indent-for-tab-command)
15691 (unless (eolp) (insert "\n")))
15692 ;; Clear marker, whatever the outcome of insertion is.
15693 (set-marker rend nil)))))))
15695 (defvar org-property-set-functions-alist nil
15696 "Property set function alist.
15697 Each entry should have the following format:
15699 (PROPERTY . READ-FUNCTION)
15701 The read function will be called with the same argument as
15702 `org-completing-read'.")
15704 (defun org-set-property-function (property)
15705 "Get the function that should be used to set PROPERTY.
15706 This is computed according to `org-property-set-functions-alist'."
15707 (or (cdr (assoc property org-property-set-functions-alist))
15708 'org-completing-read))
15710 (defun org-read-property-value (property)
15711 "Read PROPERTY value from user."
15712 (let* ((completion-ignore-case t)
15713 (allowed (org-property-get-allowed-values nil property 'table))
15714 (cur (org-entry-get nil property))
15715 (prompt (concat property " value"
15716 (if (and cur (string-match "\\S-" cur))
15717 (concat " [" cur "]") "") ": "))
15718 (set-function (org-set-property-function property))
15719 (val (if allowed
15720 (funcall set-function prompt allowed nil
15721 (not (get-text-property 0 'org-unrestricted
15722 (caar allowed))))
15723 (let (org-completion-use-ido org-completion-use-iswitchb)
15724 (funcall set-function prompt
15725 (mapcar 'list (org-property-values property))
15726 nil nil "" nil cur)))))
15727 (if (equal val "")
15729 val)))
15731 (defvar org-last-set-property nil)
15732 (defvar org-last-set-property-value nil)
15733 (defun org-read-property-name ()
15734 "Read a property name."
15735 (let* ((completion-ignore-case t)
15736 (keys (org-buffer-property-keys nil t t))
15737 (default-prop (or (save-excursion
15738 (save-match-data
15739 (beginning-of-line)
15740 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
15741 (null (string= (match-string 1) "END"))
15742 (match-string 1))))
15743 org-last-set-property))
15744 (property (org-icompleting-read
15745 (concat "Property"
15746 (if default-prop (concat " [" default-prop "]") "")
15747 ": ")
15748 (mapcar 'list keys)
15749 nil nil nil nil
15750 default-prop)))
15751 (if (member property keys)
15752 property
15753 (or (cdr (assoc (downcase property)
15754 (mapcar (lambda (x) (cons (downcase x) x))
15755 keys)))
15756 property))))
15758 (defun org-set-property-and-value (use-last)
15759 "Allow to set [PROPERTY]: [value] direction from prompt.
15760 When use-default, don't even ask, just use the last
15761 \"[PROPERTY]: [value]\" string from the history."
15762 (interactive "P")
15763 (let* ((completion-ignore-case t)
15764 (pv (or (and use-last org-last-set-property-value)
15765 (org-completing-read
15766 "Enter a \"[Property]: [value]\" pair: "
15767 nil nil nil nil nil
15768 org-last-set-property-value)))
15769 prop val)
15770 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
15771 (setq prop (match-string 1 pv)
15772 val (match-string 2 pv))
15773 (org-set-property prop val))))
15775 (defun org-set-property (property value)
15776 "In the current entry, set PROPERTY to VALUE.
15777 When called interactively, this will prompt for a property name, offering
15778 completion on existing and default properties. And then it will prompt
15779 for a value, offering completion either on allowed values (via an inherited
15780 xxx_ALL property) or on existing values in other instances of this property
15781 in the current file."
15782 (interactive (list nil nil))
15783 (let* ((property (or property (org-read-property-name)))
15784 (value (or value (org-read-property-value property)))
15785 (fn (cdr (assoc property org-properties-postprocess-alist))))
15786 (setq org-last-set-property property)
15787 (setq org-last-set-property-value (concat property ": " value))
15788 ;; Possibly postprocess the inserted value:
15789 (when fn (setq value (funcall fn value)))
15790 (unless (equal (org-entry-get nil property) value)
15791 (org-entry-put nil property value))))
15793 (defun org-delete-property (property &optional delete-empty-drawer)
15794 "In the current entry, delete PROPERTY.
15795 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15796 an empty drawer to delete."
15797 (interactive
15798 (let* ((completion-ignore-case t)
15799 (prop (org-icompleting-read "Property: "
15800 (org-entry-properties nil 'standard))))
15801 (list prop)))
15802 (message "Property %s %s" property
15803 (if (org-entry-delete nil property delete-empty-drawer)
15804 "deleted"
15805 "was not present in the entry")))
15807 (defun org-delete-property-globally (property)
15808 "Remove PROPERTY globally, from all entries."
15809 (interactive
15810 (let* ((completion-ignore-case t)
15811 (prop (org-icompleting-read
15812 "Globally remove property: "
15813 (mapcar 'list (org-buffer-property-keys)))))
15814 (list prop)))
15815 (save-excursion
15816 (save-restriction
15817 (widen)
15818 (goto-char (point-min))
15819 (let ((cnt 0))
15820 (while (re-search-forward
15821 (org-re-property property)
15822 nil t)
15823 (setq cnt (1+ cnt))
15824 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15825 (message "Property \"%s\" removed from %d entries" property cnt)))))
15827 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15829 (defun org-compute-property-at-point ()
15830 "Compute the property at point.
15831 This looks for an enclosing column format, extracts the operator and
15832 then applies it to the property in the column format's scope."
15833 (interactive)
15834 (unless (org-at-property-p)
15835 (user-error "Not at a property"))
15836 (let ((prop (org-match-string-no-properties 2)))
15837 (org-columns-get-format-and-top-level)
15838 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15839 (user-error "No operator defined for property %s" prop))
15840 (org-columns-compute prop)))
15842 (defvar org-property-allowed-value-functions nil
15843 "Hook for functions supplying allowed values for a specific property.
15844 The functions must take a single argument, the name of the property, and
15845 return a flat list of allowed values. If \":ETC\" is one of
15846 the values, this means that these values are intended as defaults for
15847 completion, but that other values should be allowed too.
15848 The functions must return nil if they are not responsible for this
15849 property.")
15851 (defun org-property-get-allowed-values (pom property &optional table)
15852 "Get allowed values for the property PROPERTY.
15853 When TABLE is non-nil, return an alist that can directly be used for
15854 completion."
15855 (let (vals)
15856 (cond
15857 ((equal property "TODO")
15858 (setq vals (org-with-point-at pom
15859 (append org-todo-keywords-1 '("")))))
15860 ((equal property "PRIORITY")
15861 (let ((n org-lowest-priority))
15862 (while (>= n org-highest-priority)
15863 (push (char-to-string n) vals)
15864 (setq n (1- n)))))
15865 ((member property org-special-properties))
15866 ((setq vals (run-hook-with-args-until-success
15867 'org-property-allowed-value-functions property)))
15869 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15870 (when (and vals (string-match "\\S-" vals))
15871 (setq vals (car (read-from-string (concat "(" vals ")"))))
15872 (setq vals (mapcar (lambda (x)
15873 (cond ((stringp x) x)
15874 ((numberp x) (number-to-string x))
15875 ((symbolp x) (symbol-name x))
15876 (t "???")))
15877 vals)))))
15878 (when (member ":ETC" vals)
15879 (setq vals (remove ":ETC" vals))
15880 (org-add-props (car vals) '(org-unrestricted t)))
15881 (if table (mapcar 'list vals) vals)))
15883 (defun org-property-previous-allowed-value (&optional previous)
15884 "Switch to the next allowed value for this property."
15885 (interactive)
15886 (org-property-next-allowed-value t))
15888 (defun org-property-next-allowed-value (&optional previous)
15889 "Switch to the next allowed value for this property."
15890 (interactive)
15891 (unless (org-at-property-p)
15892 (user-error "Not at a property"))
15893 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15894 (key (match-string 2))
15895 (value (match-string 3))
15896 (allowed (or (org-property-get-allowed-values (point) key)
15897 (and (member value '("[ ]" "[-]" "[X]"))
15898 '("[ ]" "[X]"))))
15899 (heading (save-match-data (nth 4 (org-heading-components))))
15900 nval)
15901 (unless allowed
15902 (user-error "Allowed values for this property have not been defined"))
15903 (if previous (setq allowed (reverse allowed)))
15904 (if (member value allowed)
15905 (setq nval (car (cdr (member value allowed)))))
15906 (setq nval (or nval (car allowed)))
15907 (if (equal nval value)
15908 (user-error "Only one allowed value for this property"))
15909 (org-at-property-p)
15910 (replace-match (concat " :" key ": " nval) t t)
15911 (org-indent-line)
15912 (beginning-of-line 1)
15913 (skip-chars-forward " \t")
15914 (when (equal prop org-effort-property)
15915 (save-excursion
15916 (org-back-to-heading t)
15917 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15918 (when (string= org-clock-current-task heading)
15919 (setq org-clock-effort nval)
15920 (org-clock-update-mode-line)))
15921 (run-hook-with-args 'org-property-changed-functions key nval)))
15923 (defun org-find-olp (path &optional this-buffer)
15924 "Return a marker pointing to the entry at outline path OLP.
15925 If anything goes wrong, throw an error.
15926 You can wrap this call to catch the error like this:
15928 (condition-case msg
15929 (org-mobile-locate-entry (match-string 4))
15930 (error (nth 1 msg)))
15932 The return value will then be either a string with the error message,
15933 or a marker if everything is OK.
15935 If THIS-BUFFER is set, the outline path does not contain a file,
15936 only headings."
15937 (let* ((file (if this-buffer buffer-file-name (pop path)))
15938 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15939 (level 1)
15940 (lmin 1)
15941 (lmax 1)
15942 limit re end found pos heading cnt flevel)
15943 (unless buffer (error "File not found :%s" file))
15944 (with-current-buffer buffer
15945 (save-excursion
15946 (save-restriction
15947 (widen)
15948 (setq limit (point-max))
15949 (goto-char (point-min))
15950 (while (setq heading (pop path))
15951 (setq re (format org-complex-heading-regexp-format
15952 (regexp-quote heading)))
15953 (setq cnt 0 pos (point))
15954 (while (re-search-forward re end t)
15955 (setq level (- (match-end 1) (match-beginning 1)))
15956 (if (and (>= level lmin) (<= level lmax))
15957 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15958 (when (= cnt 0) (error "Heading not found on level %d: %s"
15959 lmax heading))
15960 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15961 lmax heading))
15962 (goto-char found)
15963 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15964 (setq end (save-excursion (org-end-of-subtree t t))))
15965 (when (org-at-heading-p)
15966 (point-marker)))))))
15968 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15969 "Find node HEADING in BUFFER.
15970 Return a marker to the heading if it was found, or nil if not.
15971 If POS-ONLY is set, return just the position instead of a marker.
15973 The heading text must match exact, but it may have a TODO keyword,
15974 a priority cookie and tags in the standard locations."
15975 (with-current-buffer (or buffer (current-buffer))
15976 (save-excursion
15977 (save-restriction
15978 (widen)
15979 (goto-char (point-min))
15980 (let (case-fold-search)
15981 (if (re-search-forward
15982 (format org-complex-heading-regexp-format
15983 (regexp-quote heading)) nil t)
15984 (if pos-only
15985 (match-beginning 0)
15986 (move-marker (make-marker) (match-beginning 0)))))))))
15988 (defun org-find-exact-heading-in-directory (heading &optional dir)
15989 "Find Org node headline HEADING in all .org files in directory DIR.
15990 When the target headline is found, return a marker to this location."
15991 (let ((files (directory-files (or dir default-directory)
15992 nil "\\`[^.#].*\\.org\\'"))
15993 file visiting m buffer)
15994 (catch 'found
15995 (while (setq file (pop files))
15996 (message "trying %s" file)
15997 (setq visiting (org-find-base-buffer-visiting file))
15998 (setq buffer (or visiting (find-file-noselect file)))
15999 (setq m (org-find-exact-headline-in-buffer
16000 heading buffer))
16001 (when (and (not m) (not visiting)) (kill-buffer buffer))
16002 (and m (throw 'found m))))))
16004 (defun org-find-entry-with-id (ident)
16005 "Locate the entry that contains the ID property with exact value IDENT.
16006 IDENT can be a string, a symbol or a number, this function will search for
16007 the string representation of it.
16008 Return the position where this entry starts, or nil if there is no such entry."
16009 (interactive "sID: ")
16010 (let ((id (cond
16011 ((stringp ident) ident)
16012 ((symbol-name ident) (symbol-name ident))
16013 ((numberp ident) (number-to-string ident))
16014 (t (error "IDENT %s must be a string, symbol or number" ident))))
16015 (case-fold-search nil))
16016 (save-excursion
16017 (save-restriction
16018 (widen)
16019 (goto-char (point-min))
16020 (when (re-search-forward
16021 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16022 nil t)
16023 (org-back-to-heading t)
16024 (point))))))
16026 ;;;; Timestamps
16028 (defvar org-last-changed-timestamp nil)
16029 (defvar org-last-inserted-timestamp nil
16030 "The last time stamp inserted with `org-insert-time-stamp'.")
16031 (defvar org-ts-what) ; dynamically scoped parameter
16033 (defun org-time-stamp (arg &optional inactive)
16034 "Prompt for a date/time and insert a time stamp.
16035 If the user specifies a time like HH:MM or if this command is
16036 called with at least one prefix argument, the time stamp contains
16037 the date and the time. Otherwise, only the date is be included.
16039 All parts of a date not specified by the user is filled in from
16040 the current date/time. So if you just press return without
16041 typing anything, the time stamp will represent the current
16042 date/time.
16044 If there is already a timestamp at the cursor, it will be
16045 modified.
16047 With two universal prefix arguments, insert an active timestamp
16048 with the current time without prompting the user.
16050 When called from lisp, the timestamp is inactive if INACTIVE is
16051 non-nil."
16052 (interactive "P")
16053 (let* ((ts nil)
16054 (default-time
16055 ;; Default time is either today, or, when entering a range,
16056 ;; the range start.
16057 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16058 (save-excursion
16059 (re-search-backward
16060 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16061 (- (point) 20) t)))
16062 (apply 'encode-time (org-parse-time-string (match-string 1)))
16063 (current-time)))
16064 (default-input (and ts (org-get-compact-tod ts)))
16065 (repeater (save-excursion
16066 (save-match-data
16067 (beginning-of-line)
16068 (when (re-search-forward
16069 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16070 (save-excursion (progn (end-of-line) (point))) t)
16071 (match-string 0)))))
16072 org-time-was-given org-end-time-was-given time)
16073 (cond
16074 ((and (org-at-timestamp-p t)
16075 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16076 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16077 (insert "--")
16078 (setq time (let ((this-command this-command))
16079 (org-read-date arg 'totime nil nil
16080 default-time default-input inactive)))
16081 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16082 ((org-at-timestamp-p t)
16083 (setq time (let ((this-command this-command))
16084 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16085 (when (org-at-timestamp-p t) ; just to get the match data
16086 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16087 (replace-match "")
16088 (setq org-last-changed-timestamp
16089 (org-insert-time-stamp
16090 time (or org-time-was-given arg)
16091 inactive nil nil (list org-end-time-was-given)))
16092 (when repeater (goto-char (1- (point))) (insert " " repeater)
16093 (setq org-last-changed-timestamp
16094 (concat (substring org-last-inserted-timestamp 0 -1)
16095 " " repeater ">"))))
16096 (message "Timestamp updated"))
16097 ((equal arg '(16))
16098 (org-insert-time-stamp (current-time) t inactive))
16100 (setq time (let ((this-command this-command))
16101 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16102 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16103 nil nil (list org-end-time-was-given))))))
16105 ;; FIXME: can we use this for something else, like computing time differences?
16106 (defun org-get-compact-tod (s)
16107 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16108 (let* ((t1 (match-string 1 s))
16109 (h1 (string-to-number (match-string 2 s)))
16110 (m1 (string-to-number (match-string 3 s)))
16111 (t2 (and (match-end 4) (match-string 5 s)))
16112 (h2 (and t2 (string-to-number (match-string 6 s))))
16113 (m2 (and t2 (string-to-number (match-string 7 s))))
16114 dh dm)
16115 (if (not t2)
16117 (setq dh (- h2 h1) dm (- m2 m1))
16118 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16119 (concat t1 "+" (number-to-string dh)
16120 (and (/= 0 dm) (format ":%02d" dm)))))))
16122 (defun org-time-stamp-inactive (&optional arg)
16123 "Insert an inactive time stamp.
16124 An inactive time stamp is enclosed in square brackets instead of angle
16125 brackets. It is inactive in the sense that it does not trigger agenda entries,
16126 does not link to the calendar and cannot be changed with the S-cursor keys.
16127 So these are more for recording a certain time/date."
16128 (interactive "P")
16129 (org-time-stamp arg 'inactive))
16131 (defvar org-date-ovl (make-overlay 1 1))
16132 (overlay-put org-date-ovl 'face 'org-date-selected)
16133 (org-detach-overlay org-date-ovl)
16135 (defvar org-ans1) ; dynamically scoped parameter
16136 (defvar org-ans2) ; dynamically scoped parameter
16138 (defvar org-plain-time-of-day-regexp) ; defined below
16140 (defvar org-overriding-default-time nil) ; dynamically scoped
16141 (defvar org-read-date-overlay nil)
16142 (defvar org-dcst nil) ; dynamically scoped
16143 (defvar org-read-date-history nil)
16144 (defvar org-read-date-final-answer nil)
16145 (defvar org-read-date-analyze-futurep nil)
16146 (defvar org-read-date-analyze-forced-year nil)
16147 (defvar org-read-date-inactive)
16149 (defvar org-read-date-minibuffer-local-map
16150 (let* ((org-replace-disputed-keys nil)
16151 (map (make-sparse-keymap)))
16152 (set-keymap-parent map minibuffer-local-map)
16153 (org-defkey map (kbd ".")
16154 (lambda () (interactive)
16155 ;; Are we at the beginning of the prompt?
16156 (if (looking-back "^[^:]+: ")
16157 (org-eval-in-calendar '(calendar-goto-today))
16158 (insert "."))))
16159 (org-defkey map (kbd "C-.")
16160 (lambda () (interactive)
16161 (org-eval-in-calendar '(calendar-goto-today))))
16162 (org-defkey map [(meta shift left)]
16163 (lambda () (interactive)
16164 (org-eval-in-calendar '(calendar-backward-month 1))))
16165 (org-defkey map [(meta shift right)]
16166 (lambda () (interactive)
16167 (org-eval-in-calendar '(calendar-forward-month 1))))
16168 (org-defkey map [(meta shift up)]
16169 (lambda () (interactive)
16170 (org-eval-in-calendar '(calendar-backward-year 1))))
16171 (org-defkey map [(meta shift down)]
16172 (lambda () (interactive)
16173 (org-eval-in-calendar '(calendar-forward-year 1))))
16174 (org-defkey map [?\e (shift left)]
16175 (lambda () (interactive)
16176 (org-eval-in-calendar '(calendar-backward-month 1))))
16177 (org-defkey map [?\e (shift right)]
16178 (lambda () (interactive)
16179 (org-eval-in-calendar '(calendar-forward-month 1))))
16180 (org-defkey map [?\e (shift up)]
16181 (lambda () (interactive)
16182 (org-eval-in-calendar '(calendar-backward-year 1))))
16183 (org-defkey map [?\e (shift down)]
16184 (lambda () (interactive)
16185 (org-eval-in-calendar '(calendar-forward-year 1))))
16186 (org-defkey map [(shift up)]
16187 (lambda () (interactive)
16188 (org-eval-in-calendar '(calendar-backward-week 1))))
16189 (org-defkey map [(shift down)]
16190 (lambda () (interactive)
16191 (org-eval-in-calendar '(calendar-forward-week 1))))
16192 (org-defkey map [(shift left)]
16193 (lambda () (interactive)
16194 (org-eval-in-calendar '(calendar-backward-day 1))))
16195 (org-defkey map [(shift right)]
16196 (lambda () (interactive)
16197 (org-eval-in-calendar '(calendar-forward-day 1))))
16198 (org-defkey map "!"
16199 (lambda () (interactive)
16200 (org-eval-in-calendar '(diary-view-entries))
16201 (message "")))
16202 (org-defkey map ">"
16203 (lambda () (interactive)
16204 (org-eval-in-calendar '(scroll-calendar-left 1))))
16205 (org-defkey map "<"
16206 (lambda () (interactive)
16207 (org-eval-in-calendar '(scroll-calendar-right 1))))
16208 (org-defkey map "\C-v"
16209 (lambda () (interactive)
16210 (org-eval-in-calendar
16211 '(calendar-scroll-left-three-months 1))))
16212 (org-defkey map "\M-v"
16213 (lambda () (interactive)
16214 (org-eval-in-calendar
16215 '(calendar-scroll-right-three-months 1))))
16216 map)
16217 "Keymap for minibuffer commands when using `org-read-date'.")
16219 (defvar org-def)
16220 (defvar org-defdecode)
16221 (defvar org-with-time)
16223 (defun org-read-date (&optional org-with-time to-time from-string prompt
16224 default-time default-input inactive)
16225 "Read a date, possibly a time, and make things smooth for the user.
16226 The prompt will suggest to enter an ISO date, but you can also enter anything
16227 which will at least partially be understood by `parse-time-string'.
16228 Unrecognized parts of the date will default to the current day, month, year,
16229 hour and minute. If this command is called to replace a timestamp at point,
16230 or to enter the second timestamp of a range, the default time is taken
16231 from the existing stamp. Furthermore, the command prefers the future,
16232 so if you are giving a date where the year is not given, and the day-month
16233 combination is already past in the current year, it will assume you
16234 mean next year. For details, see the manual. A few examples:
16236 3-2-5 --> 2003-02-05
16237 feb 15 --> currentyear-02-15
16238 2/15 --> currentyear-02-15
16239 sep 12 9 --> 2009-09-12
16240 12:45 --> today 12:45
16241 22 sept 0:34 --> currentyear-09-22 0:34
16242 12 --> currentyear-currentmonth-12
16243 Fri --> nearest Friday after today
16244 -Tue --> last Tuesday
16245 etc.
16247 Furthermore you can specify a relative date by giving, as the *first* thing
16248 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16249 change in days weeks, months, years.
16250 With a single plus or minus, the date is relative to today. With a double
16251 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16252 +4d --> four days from today
16253 +4 --> same as above
16254 +2w --> two weeks from today
16255 ++5 --> five days from default date
16257 The function understands only English month and weekday abbreviations.
16259 While prompting, a calendar is popped up - you can also select the
16260 date with the mouse (button 1). The calendar shows a period of three
16261 months. To scroll it to other months, use the keys `>' and `<'.
16262 If you don't like the calendar, turn it off with
16263 \(setq org-read-date-popup-calendar nil)
16265 With optional argument TO-TIME, the date will immediately be converted
16266 to an internal time.
16267 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16268 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16269 still enter a time, and this function will inform the calling routine
16270 about this change. The calling routine may then choose to change the
16271 format used to insert the time stamp into the buffer to include the time.
16272 With optional argument FROM-STRING, read from this string instead from
16273 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16274 the time/date that is used for everything that is not specified by the
16275 user."
16276 (require 'parse-time)
16277 (let* ((org-time-stamp-rounding-minutes
16278 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16279 (org-dcst org-display-custom-times)
16280 (ct (org-current-time))
16281 (org-def (or org-overriding-default-time default-time ct))
16282 (org-defdecode (decode-time org-def))
16283 (dummy (progn
16284 (when (< (nth 2 org-defdecode) org-extend-today-until)
16285 (setcar (nthcdr 2 org-defdecode) -1)
16286 (setcar (nthcdr 1 org-defdecode) 59)
16287 (setq org-def (apply 'encode-time org-defdecode)
16288 org-defdecode (decode-time org-def)))))
16289 (mouse-autoselect-window nil) ; Don't let the mouse jump
16290 (calendar-frame-setup nil)
16291 (calendar-setup nil)
16292 (calendar-move-hook nil)
16293 (calendar-view-diary-initially-flag nil)
16294 (calendar-view-holidays-initially-flag nil)
16295 (timestr (format-time-string
16296 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16297 (prompt (concat (if prompt (concat prompt " ") "")
16298 (format "Date+time [%s]: " timestr)))
16299 ans (org-ans0 "") org-ans1 org-ans2 final)
16301 (cond
16302 (from-string (setq ans from-string))
16303 (org-read-date-popup-calendar
16304 (save-excursion
16305 (save-window-excursion
16306 (calendar)
16307 (org-eval-in-calendar '(setq cursor-type nil) t)
16308 (unwind-protect
16309 (progn
16310 (calendar-forward-day (- (time-to-days org-def)
16311 (calendar-absolute-from-gregorian
16312 (calendar-current-date))))
16313 (org-eval-in-calendar nil t)
16314 (let* ((old-map (current-local-map))
16315 (map (copy-keymap calendar-mode-map))
16316 (minibuffer-local-map
16317 (copy-keymap org-read-date-minibuffer-local-map)))
16318 (org-defkey map (kbd "RET") 'org-calendar-select)
16319 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16320 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16321 (unwind-protect
16322 (progn
16323 (use-local-map map)
16324 (setq org-read-date-inactive inactive)
16325 (add-hook 'post-command-hook 'org-read-date-display)
16326 (setq org-ans0 (read-string prompt default-input
16327 'org-read-date-history nil))
16328 ;; org-ans0: from prompt
16329 ;; org-ans1: from mouse click
16330 ;; org-ans2: from calendar motion
16331 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16332 (remove-hook 'post-command-hook 'org-read-date-display)
16333 (use-local-map old-map)
16334 (when org-read-date-overlay
16335 (delete-overlay org-read-date-overlay)
16336 (setq org-read-date-overlay nil)))))
16337 (bury-buffer "*Calendar*")))))
16339 (t ; Naked prompt only
16340 (unwind-protect
16341 (setq ans (read-string prompt default-input
16342 'org-read-date-history timestr))
16343 (when org-read-date-overlay
16344 (delete-overlay org-read-date-overlay)
16345 (setq org-read-date-overlay nil)))))
16347 (setq final (org-read-date-analyze ans org-def org-defdecode))
16349 (when org-read-date-analyze-forced-year
16350 (message "Year was forced into %s"
16351 (if org-read-date-force-compatible-dates
16352 "compatible range (1970-2037)"
16353 "range representable on this machine"))
16354 (ding))
16356 ;; One round trip to get rid of 34th of August and stuff like that....
16357 (setq final (decode-time (apply 'encode-time final)))
16359 (setq org-read-date-final-answer ans)
16361 (if to-time
16362 (apply 'encode-time final)
16363 (if (and (boundp 'org-time-was-given) org-time-was-given)
16364 (format "%04d-%02d-%02d %02d:%02d"
16365 (nth 5 final) (nth 4 final) (nth 3 final)
16366 (nth 2 final) (nth 1 final))
16367 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16369 (defun org-read-date-display ()
16370 "Display the current date prompt interpretation in the minibuffer."
16371 (when org-read-date-display-live
16372 (when org-read-date-overlay
16373 (delete-overlay org-read-date-overlay))
16374 (when (minibufferp (current-buffer))
16375 (save-excursion
16376 (end-of-line 1)
16377 (while (not (equal (buffer-substring
16378 (max (point-min) (- (point) 4)) (point))
16379 " "))
16380 (insert " ")))
16381 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16382 " " (or org-ans1 org-ans2)))
16383 (org-end-time-was-given nil)
16384 (f (org-read-date-analyze ans org-def org-defdecode))
16385 (fmts (if org-dcst
16386 org-time-stamp-custom-formats
16387 org-time-stamp-formats))
16388 (fmt (if (or org-with-time
16389 (and (boundp 'org-time-was-given) org-time-was-given))
16390 (cdr fmts)
16391 (car fmts)))
16392 (txt (format-time-string fmt (apply 'encode-time f)))
16393 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16394 (txt (concat "=> " txt)))
16395 (when (and org-end-time-was-given
16396 (string-match org-plain-time-of-day-regexp txt))
16397 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16398 org-end-time-was-given
16399 (substring txt (match-end 0)))))
16400 (when org-read-date-analyze-futurep
16401 (setq txt (concat txt " (=>F)")))
16402 (setq org-read-date-overlay
16403 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16404 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16406 (defun org-read-date-analyze (ans org-def org-defdecode)
16407 "Analyze the combined answer of the date prompt."
16408 ;; FIXME: cleanup and comment
16409 (let ((nowdecode (decode-time (current-time)))
16410 delta deltan deltaw deltadef year month day
16411 hour minute second wday pm h2 m2 tl wday1
16412 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16413 (setq org-read-date-analyze-futurep nil
16414 org-read-date-analyze-forced-year nil)
16415 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16416 (setq ans "+0"))
16418 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16419 (setq ans (replace-match "" t t ans)
16420 deltan (car delta)
16421 deltaw (nth 1 delta)
16422 deltadef (nth 2 delta)))
16424 ;; Check if there is an iso week date in there. If yes, store the
16425 ;; info and postpone interpreting it until the rest of the parsing
16426 ;; is done.
16427 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16428 (setq iso-year (if (match-end 1)
16429 (org-small-year-to-year
16430 (string-to-number (match-string 1 ans))))
16431 iso-weekday (if (match-end 3)
16432 (string-to-number (match-string 3 ans)))
16433 iso-week (string-to-number (match-string 2 ans)))
16434 (setq ans (replace-match "" t t ans)))
16436 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16437 (when (string-match
16438 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16439 (setq year (if (match-end 2)
16440 (string-to-number (match-string 2 ans))
16441 (progn (setq kill-year t)
16442 (string-to-number (format-time-string "%Y"))))
16443 month (string-to-number (match-string 3 ans))
16444 day (string-to-number (match-string 4 ans)))
16445 (if (< year 100) (setq year (+ 2000 year)))
16446 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16447 t nil ans)))
16449 ;; Help matching dotted european dates
16450 (when (string-match
16451 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16452 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16453 (setq kill-year t)
16454 (string-to-number (format-time-string "%Y")))
16455 day (string-to-number (match-string 1 ans))
16456 month (string-to-number (match-string 2 ans))
16457 ans (replace-match (format "%04d-%02d-%02d" year month day)
16458 t nil ans)))
16460 ;; Help matching american dates, like 5/30 or 5/30/7
16461 (when (string-match
16462 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16463 (setq year (if (match-end 4)
16464 (string-to-number (match-string 4 ans))
16465 (progn (setq kill-year t)
16466 (string-to-number (format-time-string "%Y"))))
16467 month (string-to-number (match-string 1 ans))
16468 day (string-to-number (match-string 2 ans)))
16469 (if (< year 100) (setq year (+ 2000 year)))
16470 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16471 t nil ans)))
16472 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16473 ;; If there is a time with am/pm, and *no* time without it, we convert
16474 ;; so that matching will be successful.
16475 (loop for i from 1 to 2 do ; twice, for end time as well
16476 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16477 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16478 (setq hour (string-to-number (match-string 1 ans))
16479 minute (if (match-end 3)
16480 (string-to-number (match-string 3 ans))
16482 pm (equal ?p
16483 (string-to-char (downcase (match-string 4 ans)))))
16484 (if (and (= hour 12) (not pm))
16485 (setq hour 0)
16486 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16487 (setq ans (replace-match (format "%02d:%02d" hour minute)
16488 t t ans))))
16490 ;; Check if a time range is given as a duration
16491 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16492 (setq hour (string-to-number (match-string 1 ans))
16493 h2 (+ hour (string-to-number (match-string 3 ans)))
16494 minute (string-to-number (match-string 2 ans))
16495 m2 (+ minute (if (match-end 5) (string-to-number
16496 (match-string 5 ans))0)))
16497 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16498 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16499 t t ans)))
16501 ;; Check if there is a time range
16502 (when (boundp 'org-end-time-was-given)
16503 (setq org-time-was-given nil)
16504 (when (and (string-match org-plain-time-of-day-regexp ans)
16505 (match-end 8))
16506 (setq org-end-time-was-given (match-string 8 ans))
16507 (setq ans (concat (substring ans 0 (match-beginning 7))
16508 (substring ans (match-end 7))))))
16510 (setq tl (parse-time-string ans)
16511 day (or (nth 3 tl) (nth 3 org-defdecode))
16512 month (or (nth 4 tl)
16513 (if (and org-read-date-prefer-future
16514 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16515 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16516 (nth 4 org-defdecode)))
16517 year (or (and (not kill-year) (nth 5 tl))
16518 (if (and org-read-date-prefer-future
16519 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16520 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16521 (nth 5 org-defdecode)))
16522 hour (or (nth 2 tl) (nth 2 org-defdecode))
16523 minute (or (nth 1 tl) (nth 1 org-defdecode))
16524 second (or (nth 0 tl) 0)
16525 wday (nth 6 tl))
16527 (when (and (eq org-read-date-prefer-future 'time)
16528 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16529 (equal day (nth 3 nowdecode))
16530 (equal month (nth 4 nowdecode))
16531 (equal year (nth 5 nowdecode))
16532 (nth 2 tl)
16533 (or (< (nth 2 tl) (nth 2 nowdecode))
16534 (and (= (nth 2 tl) (nth 2 nowdecode))
16535 (nth 1 tl)
16536 (< (nth 1 tl) (nth 1 nowdecode)))))
16537 (setq day (1+ day)
16538 futurep t))
16540 ;; Special date definitions below
16541 (cond
16542 (iso-week
16543 ;; There was an iso week
16544 (require 'cal-iso)
16545 (setq futurep nil)
16546 (setq year (or iso-year year)
16547 day (or iso-weekday wday 1)
16548 wday nil ; to make sure that the trigger below does not match
16549 iso-date (calendar-gregorian-from-absolute
16550 (calendar-absolute-from-iso
16551 (list iso-week day year))))
16552 ; FIXME: Should we also push ISO weeks into the future?
16553 ; (when (and org-read-date-prefer-future
16554 ; (not iso-year)
16555 ; (< (calendar-absolute-from-gregorian iso-date)
16556 ; (time-to-days (current-time))))
16557 ; (setq year (1+ year)
16558 ; iso-date (calendar-gregorian-from-absolute
16559 ; (calendar-absolute-from-iso
16560 ; (list iso-week day year)))))
16561 (setq month (car iso-date)
16562 year (nth 2 iso-date)
16563 day (nth 1 iso-date)))
16564 (deltan
16565 (setq futurep nil)
16566 (unless deltadef
16567 (let ((now (decode-time (current-time))))
16568 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16569 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16570 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16571 ((equal deltaw "m") (setq month (+ month deltan)))
16572 ((equal deltaw "y") (setq year (+ year deltan)))))
16573 ((and wday (not (nth 3 tl)))
16574 ;; Weekday was given, but no day, so pick that day in the week
16575 ;; on or after the derived date.
16576 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16577 (unless (equal wday wday1)
16578 (setq day (+ day (% (- wday wday1 -7) 7))))))
16579 (if (and (boundp 'org-time-was-given)
16580 (nth 2 tl))
16581 (setq org-time-was-given t))
16582 (if (< year 100) (setq year (+ 2000 year)))
16583 ;; Check of the date is representable
16584 (if org-read-date-force-compatible-dates
16585 (progn
16586 (if (< year 1970)
16587 (setq year 1970 org-read-date-analyze-forced-year t))
16588 (if (> year 2037)
16589 (setq year 2037 org-read-date-analyze-forced-year t)))
16590 (condition-case nil
16591 (ignore (encode-time second minute hour day month year))
16592 (error
16593 (setq year (nth 5 org-defdecode))
16594 (setq org-read-date-analyze-forced-year t))))
16595 (setq org-read-date-analyze-futurep futurep)
16596 (list second minute hour day month year)))
16598 (defvar parse-time-weekdays)
16599 (defun org-read-date-get-relative (s today default)
16600 "Check string S for special relative date string.
16601 TODAY and DEFAULT are internal times, for today and for a default.
16602 Return shift list (N what def-flag)
16603 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16604 N is the number of WHATs to shift.
16605 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16606 the DEFAULT date rather than TODAY."
16607 (require 'parse-time)
16608 (when (and
16609 (string-match
16610 (concat
16611 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16612 "\\([0-9]+\\)?"
16613 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16614 "\\([ \t]\\|$\\)") s)
16615 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16616 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16617 (string-to-char (substring (match-string 1 s) -1))
16618 ?+))
16619 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16620 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16621 (what (if (match-end 3) (match-string 3 s) "d"))
16622 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16623 (date (if rel default today))
16624 (wday (nth 6 (decode-time date)))
16625 delta)
16626 (if wday1
16627 (progn
16628 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16629 (if (= delta 0) (setq delta 7))
16630 (if (= dir ?-)
16631 (progn
16632 (setq delta (- delta 7))
16633 (if (= delta 0) (setq delta -7))))
16634 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16635 (list delta "d" rel))
16636 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16638 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16639 "Turn a user-specified date into the internal representation.
16640 The internal representation needed by the calendar is (month day year).
16641 This is a wrapper to handle the brain-dead convention in calendar that
16642 user function argument order change dependent on argument order."
16643 (if (boundp 'calendar-date-style)
16644 (cond
16645 ((eq calendar-date-style 'american)
16646 (list arg1 arg2 arg3))
16647 ((eq calendar-date-style 'european)
16648 (list arg2 arg1 arg3))
16649 ((eq calendar-date-style 'iso)
16650 (list arg2 arg3 arg1)))
16651 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16652 (if (org-bound-and-true-p european-calendar-style)
16653 (list arg2 arg1 arg3)
16654 (list arg1 arg2 arg3)))))
16656 (defun org-eval-in-calendar (form &optional keepdate)
16657 "Eval FORM in the calendar window and return to current window.
16658 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16659 otherwise stick to the current value of `org-ans2'."
16660 (let ((sf (selected-frame))
16661 (sw (selected-window)))
16662 (select-window (get-buffer-window "*Calendar*" t))
16663 (eval form)
16664 (when (and (not keepdate) (calendar-cursor-to-date))
16665 (let* ((date (calendar-cursor-to-date))
16666 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16667 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16668 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16669 (select-window sw)
16670 (org-select-frame-set-input-focus sf)))
16672 (defun org-calendar-select ()
16673 "Return to `org-read-date' with the date currently selected.
16674 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16675 (interactive)
16676 (when (calendar-cursor-to-date)
16677 (let* ((date (calendar-cursor-to-date))
16678 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16679 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16680 (if (active-minibuffer-window) (exit-minibuffer))))
16682 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16683 "Insert a date stamp for the date given by the internal TIME.
16684 WITH-HM means use the stamp format that includes the time of the day.
16685 INACTIVE means use square brackets instead of angular ones, so that the
16686 stamp will not contribute to the agenda.
16687 PRE and POST are optional strings to be inserted before and after the
16688 stamp.
16689 The command returns the inserted time stamp."
16690 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16691 stamp)
16692 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16693 (insert-before-markers (or pre ""))
16694 (when (listp extra)
16695 (setq extra (car extra))
16696 (if (and (stringp extra)
16697 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16698 (setq extra (format "-%02d:%02d"
16699 (string-to-number (match-string 1 extra))
16700 (string-to-number (match-string 2 extra))))
16701 (setq extra nil)))
16702 (when extra
16703 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16704 (insert-before-markers (setq stamp (format-time-string fmt time)))
16705 (insert-before-markers (or post ""))
16706 (setq org-last-inserted-timestamp stamp)))
16708 (defun org-toggle-time-stamp-overlays ()
16709 "Toggle the use of custom time stamp formats."
16710 (interactive)
16711 (setq org-display-custom-times (not org-display-custom-times))
16712 (unless org-display-custom-times
16713 (let ((p (point-min)) (bmp (buffer-modified-p)))
16714 (while (setq p (next-single-property-change p 'display))
16715 (if (and (get-text-property p 'display)
16716 (eq (get-text-property p 'face) 'org-date))
16717 (remove-text-properties
16718 p (setq p (next-single-property-change p 'display))
16719 '(display t))))
16720 (set-buffer-modified-p bmp)))
16721 (if (featurep 'xemacs)
16722 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16723 (org-restart-font-lock)
16724 (setq org-table-may-need-update t)
16725 (if org-display-custom-times
16726 (message "Time stamps are overlaid with custom format")
16727 (message "Time stamp overlays removed")))
16729 (defun org-display-custom-time (beg end)
16730 "Overlay modified time stamp format over timestamp between BEG and END."
16731 (let* ((ts (buffer-substring beg end))
16732 t1 w1 with-hm tf time str w2 (off 0))
16733 (save-match-data
16734 (setq t1 (org-parse-time-string ts t))
16735 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16736 (setq off (- (match-end 0) (match-beginning 0)))))
16737 (setq end (- end off))
16738 (setq w1 (- end beg)
16739 with-hm (and (nth 1 t1) (nth 2 t1))
16740 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16741 time (org-fix-decoded-time t1)
16742 str (org-add-props
16743 (format-time-string
16744 (substring tf 1 -1) (apply 'encode-time time))
16745 nil 'mouse-face 'highlight)
16746 w2 (length str))
16747 (if (not (= w2 w1))
16748 (add-text-properties (1+ beg) (+ 2 beg)
16749 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16750 (if (featurep 'xemacs)
16751 (progn
16752 (put-text-property beg end 'invisible t)
16753 (put-text-property beg end 'end-glyph (make-glyph str)))
16754 (put-text-property beg end 'display str))))
16756 (defun org-translate-time (string)
16757 "Translate all timestamps in STRING to custom format.
16758 But do this only if the variable `org-display-custom-times' is set."
16759 (when org-display-custom-times
16760 (save-match-data
16761 (let* ((start 0)
16762 (re org-ts-regexp-both)
16763 t1 with-hm inactive tf time str beg end)
16764 (while (setq start (string-match re string start))
16765 (setq beg (match-beginning 0)
16766 end (match-end 0)
16767 t1 (save-match-data
16768 (org-parse-time-string (substring string beg end) t))
16769 with-hm (and (nth 1 t1) (nth 2 t1))
16770 inactive (equal (substring string beg (1+ beg)) "[")
16771 tf (funcall (if with-hm 'cdr 'car)
16772 org-time-stamp-custom-formats)
16773 time (org-fix-decoded-time t1)
16774 str (format-time-string
16775 (concat
16776 (if inactive "[" "<") (substring tf 1 -1)
16777 (if inactive "]" ">"))
16778 (apply 'encode-time time))
16779 string (replace-match str t t string)
16780 start (+ start (length str)))))))
16781 string)
16783 (defun org-fix-decoded-time (time)
16784 "Set 0 instead of nil for the first 6 elements of time.
16785 Don't touch the rest."
16786 (let ((n 0))
16787 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16789 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16791 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16792 "Difference between TIMESTAMP-STRING and now in days.
16793 If SECONDS is non-nil, return the difference in seconds."
16794 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16795 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16796 (funcall fdiff (current-time)))))
16798 (defun org-deadline-close (timestamp-string &optional ndays)
16799 "Is the time in TIMESTAMP-STRING close to the current date?"
16800 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16801 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16802 (not (org-entry-is-done-p))))
16804 (defun org-get-wdays (ts &optional delay zero-delay)
16805 "Get the deadline lead time appropriate for timestring TS.
16806 When DELAY is non-nil, get the delay time for scheduled items
16807 instead of the deadline lead time. When ZERO-DELAY is non-nil
16808 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16809 don't try to find the delay cookie in the scheduled timestamp."
16810 (let ((tv (if delay org-scheduled-delay-days
16811 org-deadline-warning-days)))
16812 (cond
16813 ((or (and delay (< tv 0))
16814 (and delay zero-delay (<= tv 0))
16815 (and (not delay) (<= tv 0)))
16816 ;; Enforce this value no matter what
16817 (- tv))
16818 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
16819 ;; lead time is specified.
16820 (floor (* (string-to-number (match-string 1 ts))
16821 (cdr (assoc (match-string 2 ts)
16822 '(("d" . 1) ("w" . 7)
16823 ("m" . 30.4) ("y" . 365.25)
16824 ("h" . 0.041667)))))))
16825 ;; go for the default.
16826 (t tv))))
16828 (defun org-calendar-select-mouse (ev)
16829 "Return to `org-read-date' with the date currently selected.
16830 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16831 (interactive "e")
16832 (mouse-set-point ev)
16833 (when (calendar-cursor-to-date)
16834 (let* ((date (calendar-cursor-to-date))
16835 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16836 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16837 (if (active-minibuffer-window) (exit-minibuffer))))
16839 (defun org-check-deadlines (ndays)
16840 "Check if there are any deadlines due or past due.
16841 A deadline is considered due if it happens within `org-deadline-warning-days'
16842 days from today's date. If the deadline appears in an entry marked DONE,
16843 it is not shown. The prefix arg NDAYS can be used to test that many
16844 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
16845 (interactive "P")
16846 (let* ((org-warn-days
16847 (cond
16848 ((equal ndays '(4)) 100000)
16849 (ndays (prefix-numeric-value ndays))
16850 (t (abs org-deadline-warning-days))))
16851 (case-fold-search nil)
16852 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16853 (callback
16854 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16856 (message "%d deadlines past-due or due within %d days"
16857 (org-occur regexp nil callback)
16858 org-warn-days)))
16860 (defsubst org-re-timestamp (type)
16861 "Return a regexp for timestamp TYPE.
16862 Allowed values for TYPE are:
16864 all: all timestamps
16865 active: only active timestamps (<...>)
16866 inactive: only inactive timestamps ([...])
16867 scheduled: only scheduled timestamps
16868 deadline: only deadline timestamps
16869 closed: only closed time-stamps
16871 When TYPE is nil, fall back on returning a regexp that matches
16872 both scheduled and deadline timestamps."
16873 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16874 ((eq type 'active) org-ts-regexp)
16875 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
16876 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
16877 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16878 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
16879 ((eq type 'scheduled-or-deadline)
16880 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
16882 (defun org-check-before-date (date)
16883 "Check if there are deadlines or scheduled entries before DATE."
16884 (interactive (list (org-read-date)))
16885 (let ((case-fold-search nil)
16886 (regexp (org-re-timestamp org-ts-type))
16887 (callback
16888 (lambda () (time-less-p
16889 (org-time-string-to-time (match-string 1))
16890 (org-time-string-to-time date)))))
16891 (message "%d entries before %s"
16892 (org-occur regexp nil callback) date)))
16894 (defun org-check-after-date (date)
16895 "Check if there are deadlines or scheduled entries after DATE."
16896 (interactive (list (org-read-date)))
16897 (let ((case-fold-search nil)
16898 (regexp (org-re-timestamp org-ts-type))
16899 (callback
16900 (lambda () (not
16901 (time-less-p
16902 (org-time-string-to-time (match-string 1))
16903 (org-time-string-to-time date))))))
16904 (message "%d entries after %s"
16905 (org-occur regexp nil callback) date)))
16907 (defun org-check-dates-range (start-date end-date)
16908 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16909 (interactive (list (org-read-date nil nil nil "Range starts")
16910 (org-read-date nil nil nil "Range end")))
16911 (let ((case-fold-search nil)
16912 (regexp (org-re-timestamp org-ts-type))
16913 (callback
16914 (lambda ()
16915 (let ((match (match-string 1)))
16916 (and
16917 (not (time-less-p
16918 (org-time-string-to-time match)
16919 (org-time-string-to-time start-date)))
16920 (time-less-p
16921 (org-time-string-to-time match)
16922 (org-time-string-to-time end-date)))))))
16923 (message "%d entries between %s and %s"
16924 (org-occur regexp nil callback) start-date end-date)))
16926 (defun org-evaluate-time-range (&optional to-buffer)
16927 "Evaluate a time range by computing the difference between start and end.
16928 Normally the result is just printed in the echo area, but with prefix arg
16929 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16930 If the time range is actually in a table, the result is inserted into the
16931 next column.
16932 For time difference computation, a year is assumed to be exactly 365
16933 days in order to avoid rounding problems."
16934 (interactive "P")
16936 (org-clock-update-time-maybe)
16937 (save-excursion
16938 (unless (org-at-date-range-p t)
16939 (goto-char (point-at-bol))
16940 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16941 (if (not (org-at-date-range-p t))
16942 (user-error "Not at a time-stamp range, and none found in current line")))
16943 (let* ((ts1 (match-string 1))
16944 (ts2 (match-string 2))
16945 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16946 (match-end (match-end 0))
16947 (time1 (org-time-string-to-time ts1))
16948 (time2 (org-time-string-to-time ts2))
16949 (t1 (org-float-time time1))
16950 (t2 (org-float-time time2))
16951 (diff (abs (- t2 t1)))
16952 (negative (< (- t2 t1) 0))
16953 ;; (ys (floor (* 365 24 60 60)))
16954 (ds (* 24 60 60))
16955 (hs (* 60 60))
16956 (fy "%dy %dd %02d:%02d")
16957 (fy1 "%dy %dd")
16958 (fd "%dd %02d:%02d")
16959 (fd1 "%dd")
16960 (fh "%02d:%02d")
16961 y d h m align)
16962 (if havetime
16963 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16965 d (floor (/ diff ds)) diff (mod diff ds)
16966 h (floor (/ diff hs)) diff (mod diff hs)
16967 m (floor (/ diff 60)))
16968 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16970 d (floor (+ (/ diff ds) 0.5))
16971 h 0 m 0))
16972 (if (not to-buffer)
16973 (message "%s" (org-make-tdiff-string y d h m))
16974 (if (org-at-table-p)
16975 (progn
16976 (goto-char match-end)
16977 (setq align t)
16978 (and (looking-at " *|") (goto-char (match-end 0))))
16979 (goto-char match-end))
16980 (if (looking-at
16981 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
16982 (replace-match ""))
16983 (if negative (insert " -"))
16984 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16985 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16986 (insert " " (format fh h m))))
16987 (if align (org-table-align))
16988 (message "Time difference inserted")))))
16990 (defun org-make-tdiff-string (y d h m)
16991 (let ((fmt "")
16992 (l nil))
16993 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16994 l (push y l)))
16995 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16996 l (push d l)))
16997 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16998 l (push h l)))
16999 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17000 l (push m l)))
17001 (apply 'format fmt (nreverse l))))
17003 (defun org-time-string-to-time (s &optional buffer pos)
17004 "Convert a timestamp string into internal time."
17005 (condition-case errdata
17006 (apply 'encode-time (org-parse-time-string s))
17007 (error (error "Bad timestamp `%s'%s\nError was: %s"
17008 s (if (not (and buffer pos))
17010 (format " at %d in buffer `%s'" pos buffer))
17011 (cdr errdata)))))
17013 (defun org-time-string-to-seconds (s)
17014 "Convert a timestamp string to a number of seconds."
17015 (org-float-time (org-time-string-to-time s)))
17017 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17018 "Convert a time stamp to an absolute day number.
17019 If there is a specifier for a cyclic time stamp, get the closest
17020 date to DAYNR.
17021 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17022 The variable `date' is bound by the calendar when this is called."
17023 (cond
17024 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17025 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17026 daynr
17027 (+ daynr 1000)))
17028 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17029 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17030 (time-to-days (current-time))) (match-string 0 s)
17031 prefer show-all))
17032 (t (time-to-days
17033 (condition-case errdata
17034 (apply 'encode-time (org-parse-time-string s))
17035 (error (error "Bad timestamp `%s'%s\nError was: %s"
17036 s (if (not (and buffer pos))
17038 (format " at %d in buffer `%s'" pos buffer))
17039 (cdr errdata))))))))
17041 (defun org-days-to-iso-week (days)
17042 "Return the iso week number."
17043 (require 'cal-iso)
17044 (car (calendar-iso-from-absolute days)))
17046 (defun org-small-year-to-year (year)
17047 "Convert 2-digit years into 4-digit years.
17048 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17049 The year 2000 cannot be abbreviated. Any year larger than 99
17050 is returned unchanged."
17051 (if (< year 38)
17052 (setq year (+ 2000 year))
17053 (if (< year 100)
17054 (setq year (+ 1900 year))))
17055 year)
17057 (defun org-time-from-absolute (d)
17058 "Return the time corresponding to date D.
17059 D may be an absolute day number, or a calendar-type list (month day year)."
17060 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17061 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17063 (defun org-calendar-holiday ()
17064 "List of holidays, for Diary display in Org-mode."
17065 (require 'holidays)
17066 (let ((hl (funcall
17067 (if (fboundp 'calendar-check-holidays)
17068 'calendar-check-holidays 'check-calendar-holidays) date)))
17069 (if hl (mapconcat 'identity hl "; "))))
17071 (defun org-diary-sexp-entry (sexp entry date)
17072 "Process a SEXP diary ENTRY for DATE."
17073 (require 'diary-lib)
17074 (let ((result (if calendar-debug-sexp
17075 (let ((stack-trace-on-error t))
17076 (eval (car (read-from-string sexp))))
17077 (condition-case nil
17078 (eval (car (read-from-string sexp)))
17079 (error
17080 (beep)
17081 (message "Bad sexp at line %d in %s: %s"
17082 (org-current-line)
17083 (buffer-file-name) sexp)
17084 (sleep-for 2))))))
17085 (cond ((stringp result) (split-string result "; "))
17086 ((and (consp result)
17087 (not (consp (cdr result)))
17088 (stringp (cdr result))) (cdr result))
17089 ((and (consp result)
17090 (stringp (car result))) result)
17091 (result entry))))
17093 (defun org-diary-to-ical-string (frombuf)
17094 "Get iCalendar entries from diary entries in buffer FROMBUF.
17095 This uses the icalendar.el library."
17096 (let* ((tmpdir (if (featurep 'xemacs)
17097 (temp-directory)
17098 temporary-file-directory))
17099 (tmpfile (make-temp-name
17100 (expand-file-name "orgics" tmpdir)))
17101 buf rtn b e)
17102 (with-current-buffer frombuf
17103 (icalendar-export-region (point-min) (point-max) tmpfile)
17104 (setq buf (find-buffer-visiting tmpfile))
17105 (set-buffer buf)
17106 (goto-char (point-min))
17107 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17108 (setq b (match-beginning 0)))
17109 (goto-char (point-max))
17110 (if (re-search-backward "^END:VEVENT" nil t)
17111 (setq e (match-end 0)))
17112 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17113 (kill-buffer buf)
17114 (delete-file tmpfile)
17115 rtn))
17117 (defun org-closest-date (start current change prefer show-all)
17118 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17119 When PREFER is `past', return a date that is either CURRENT or past.
17120 When PREFER is `future', return a date that is either CURRENT or future.
17121 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17122 ;; Make the proper lists from the dates
17123 (catch 'exit
17124 (let ((a1 '(("h" . hour)
17125 ("d" . day)
17126 ("w" . week)
17127 ("m" . month)
17128 ("y" . year)))
17129 (shour (nth 2 (org-parse-time-string start)))
17130 dn dw sday cday n1 n2 n0
17131 d m y y1 y2 date1 date2 nmonths nm ny m2)
17133 (setq start (org-date-to-gregorian start)
17134 current (org-date-to-gregorian
17135 (if show-all
17136 current
17137 (time-to-days (current-time))))
17138 sday (calendar-absolute-from-gregorian start)
17139 cday (calendar-absolute-from-gregorian current))
17141 (if (<= cday sday) (throw 'exit sday))
17143 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17144 (setq dn (string-to-number (match-string 1 change))
17145 dw (cdr (assoc (match-string 2 change) a1)))
17146 (user-error "Invalid change specifier: %s" change))
17147 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17148 (cond
17149 ((eq dw 'hour)
17150 (let ((missing-hours
17151 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17152 dn)))
17153 (setq n1 (if (zerop missing-hours) cday
17154 (- cday (1+ (floor (/ missing-hours 24)))))
17155 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17156 ((eq dw 'day)
17157 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17158 n2 (+ n1 dn)))
17159 ((eq dw 'year)
17160 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17161 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17162 (setq date1 (list m d y1)
17163 n1 (calendar-absolute-from-gregorian date1)
17164 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17165 n2 (calendar-absolute-from-gregorian date2)))
17166 ((eq dw 'month)
17167 ;; approx number of month between the two dates
17168 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17169 ;; How often does dn fit in there?
17170 (setq d (nth 1 start) m (car start) y (nth 2 start)
17171 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17172 m (+ m nm)
17173 ny (floor (/ m 12))
17174 y (+ y ny)
17175 m (- m (* ny 12)))
17176 (while (> m 12) (setq m (- m 12) y (1+ y)))
17177 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17178 (setq m2 (+ m dn) y2 y)
17179 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17180 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17181 (while (<= n2 cday)
17182 (setq n1 n2 m m2 y y2)
17183 (setq m2 (+ m dn) y2 y)
17184 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17185 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17186 ;; Make sure n1 is the earlier date
17187 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17188 (if show-all
17189 (cond
17190 ((eq prefer 'past) (if (= cday n2) n2 n1))
17191 ((eq prefer 'future) (if (= cday n1) n1 n2))
17192 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17193 (cond
17194 ((eq prefer 'past) (if (= cday n2) n2 n1))
17195 ((eq prefer 'future) (if (= cday n1) n1 n2))
17196 (t (if (= cday n1) n1 n2)))))))
17198 (defun org-date-to-gregorian (date)
17199 "Turn any specification of DATE into a Gregorian date for the calendar."
17200 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17201 ((and (listp date) (= (length date) 3)) date)
17202 ((stringp date)
17203 (setq date (org-parse-time-string date))
17204 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17205 ((listp date)
17206 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17208 (defun org-parse-time-string (s &optional nodefault)
17209 "Parse the standard Org-mode time string.
17210 This should be a lot faster than the normal `parse-time-string'.
17211 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17212 hour and minute fields will be nil if not given."
17213 (cond ((string-match org-ts-regexp0 s)
17214 (list 0
17215 (if (or (match-beginning 8) (not nodefault))
17216 (string-to-number (or (match-string 8 s) "0")))
17217 (if (or (match-beginning 7) (not nodefault))
17218 (string-to-number (or (match-string 7 s) "0")))
17219 (string-to-number (match-string 4 s))
17220 (string-to-number (match-string 3 s))
17221 (string-to-number (match-string 2 s))
17222 nil nil nil))
17223 ((string-match "^<[^>]+>$" s)
17224 (decode-time (seconds-to-time (org-matcher-time s))))
17225 (t (error "Not a standard Org-mode time string: %s" s))))
17227 (defun org-timestamp-up (&optional arg)
17228 "Increase the date item at the cursor by one.
17229 If the cursor is on the year, change the year. If it is on the month,
17230 the day or the time, change that.
17231 With prefix ARG, change by that many units."
17232 (interactive "p")
17233 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17235 (defun org-timestamp-down (&optional arg)
17236 "Decrease the date item at the cursor by one.
17237 If the cursor is on the year, change the year. If it is on the month,
17238 the day or the time, change that.
17239 With prefix ARG, change by that many units."
17240 (interactive "p")
17241 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17243 (defun org-timestamp-up-day (&optional arg)
17244 "Increase the date in the time stamp by one day.
17245 With prefix ARG, change that many days."
17246 (interactive "p")
17247 (if (and (not (org-at-timestamp-p t))
17248 (org-at-heading-p))
17249 (org-todo 'up)
17250 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17252 (defun org-timestamp-down-day (&optional arg)
17253 "Decrease the date in the time stamp by one day.
17254 With prefix ARG, change that many days."
17255 (interactive "p")
17256 (if (and (not (org-at-timestamp-p t))
17257 (org-at-heading-p))
17258 (org-todo 'down)
17259 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17261 (defun org-at-timestamp-p (&optional inactive-ok)
17262 "Determine if the cursor is in or at a timestamp."
17263 (interactive)
17264 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17265 (pos (point))
17266 (ans (or (looking-at tsr)
17267 (save-excursion
17268 (skip-chars-backward "^[<\n\r\t")
17269 (if (> (point) (point-min)) (backward-char 1))
17270 (and (looking-at tsr)
17271 (> (- (match-end 0) pos) -1))))))
17272 (and ans
17273 (boundp 'org-ts-what)
17274 (setq org-ts-what
17275 (cond
17276 ((= pos (match-beginning 0)) 'bracket)
17277 ;; Point is considered to be "on the bracket" whether
17278 ;; it's really on it or right after it.
17279 ((= pos (1- (match-end 0))) 'bracket)
17280 ((= pos (match-end 0)) 'after)
17281 ((org-pos-in-match-range pos 2) 'year)
17282 ((org-pos-in-match-range pos 3) 'month)
17283 ((org-pos-in-match-range pos 7) 'hour)
17284 ((org-pos-in-match-range pos 8) 'minute)
17285 ((or (org-pos-in-match-range pos 4)
17286 (org-pos-in-match-range pos 5)) 'day)
17287 ((and (> pos (or (match-end 8) (match-end 5)))
17288 (< pos (match-end 0)))
17289 (- pos (or (match-end 8) (match-end 5))))
17290 (t 'day))))
17291 ans))
17293 (defun org-toggle-timestamp-type ()
17294 "Toggle the type (<active> or [inactive]) of a time stamp."
17295 (interactive)
17296 (when (org-at-timestamp-p t)
17297 (let ((beg (match-beginning 0)) (end (match-end 0))
17298 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17299 (save-excursion
17300 (goto-char beg)
17301 (while (re-search-forward "[][<>]" end t)
17302 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17303 t t)))
17304 (message "Timestamp is now %sactive"
17305 (if (equal (char-after beg) ?<) "" "in")))))
17307 (defun org-at-clock-log-p nil
17308 "Is the cursor on the clock log line?"
17309 (save-excursion
17310 (move-beginning-of-line 1)
17311 (looking-at "^[ \t]*CLOCK:")))
17313 (defvar org-clock-history) ; defined in org-clock.el
17314 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17315 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17316 "Change the date in the time stamp at point.
17317 The date will be changed by N times WHAT. WHAT can be `day', `month',
17318 `year', `minute', `second'. If WHAT is not given, the cursor position
17319 in the timestamp determines what will be changed.
17320 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17321 (let ((origin (point)) origin-cat
17322 with-hm inactive
17323 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17324 org-ts-what
17325 extra rem
17326 ts time time0 fixnext clrgx)
17327 (if (not (org-at-timestamp-p t))
17328 (user-error "Not at a timestamp"))
17329 (if (and (not what) (eq org-ts-what 'bracket))
17330 (org-toggle-timestamp-type)
17331 ;; Point isn't on brackets. Remember the part of the time-stamp
17332 ;; the point was in. Indeed, size of time-stamps may change,
17333 ;; but point must be kept in the same category nonetheless.
17334 (setq origin-cat org-ts-what)
17335 (if (and (not what) (not (eq org-ts-what 'day))
17336 org-display-custom-times
17337 (get-text-property (point) 'display)
17338 (not (get-text-property (1- (point)) 'display)))
17339 (setq org-ts-what 'day))
17340 (setq org-ts-what (or what org-ts-what)
17341 inactive (= (char-after (match-beginning 0)) ?\[)
17342 ts (match-string 0))
17343 (replace-match "")
17344 (when (string-match
17345 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17347 (setq extra (match-string 1 ts))
17348 (if suppress-tmp-delay
17349 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17350 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17351 (setq with-hm t))
17352 (setq time0 (org-parse-time-string ts))
17353 (when (and updown
17354 (eq org-ts-what 'minute)
17355 (not current-prefix-arg))
17356 ;; This looks like s-up and s-down. Change by one rounding step.
17357 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17358 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17359 (setcar (cdr time0) (+ (nth 1 time0)
17360 (if (> n 0) (- rem) (- dm rem))))))
17361 (setq time
17362 (encode-time (or (car time0) 0)
17363 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17364 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17365 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17366 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17367 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17368 (nthcdr 6 time0)))
17369 (when (and (member org-ts-what '(hour minute))
17370 extra
17371 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17372 (setq extra (org-modify-ts-extra
17373 extra
17374 (if (eq org-ts-what 'hour) 2 5)
17375 n dm)))
17376 (when (integerp org-ts-what)
17377 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17378 (if (eq what 'calendar)
17379 (let ((cal-date (org-get-date-from-calendar)))
17380 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17381 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17382 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17383 (setcar time0 (or (car time0) 0))
17384 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17385 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17386 (setq time (apply 'encode-time time0))))
17387 ;; Insert the new time-stamp, and ensure point stays in the same
17388 ;; category as before (i.e. not after the last position in that
17389 ;; category).
17390 (let ((pos (point)))
17391 ;; Stay before inserted string. `save-excursion' is of no use.
17392 (setq org-last-changed-timestamp
17393 (org-insert-time-stamp time with-hm inactive nil nil extra))
17394 (goto-char pos))
17395 (save-match-data
17396 (looking-at org-ts-regexp3)
17397 (goto-char (cond
17398 ;; `day' category ends before `hour' if any, or at
17399 ;; the end of the day name.
17400 ((eq origin-cat 'day)
17401 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17402 ((eq origin-cat 'hour) (min (match-end 7) origin))
17403 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17404 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17405 ;; `year' and `month' have both fixed size: point
17406 ;; couldn't have moved into another part.
17407 (t origin))))
17408 ;; Update clock if on a CLOCK line.
17409 (org-clock-update-time-maybe)
17410 ;; Maybe adjust the closest clock in `org-clock-history'
17411 (when org-clock-adjust-closest
17412 (if (not (and (org-at-clock-log-p)
17413 (< 1 (length (delq nil (mapcar 'marker-position
17414 org-clock-history))))))
17415 (message "No clock to adjust")
17416 (cond ((save-excursion ; fix previous clock?
17417 (re-search-backward org-ts-regexp0 nil t)
17418 (org-looking-back (concat org-clock-string " \\[")))
17419 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17420 ((save-excursion ; fix next clock?
17421 (re-search-backward org-ts-regexp0 nil t)
17422 (looking-at (concat org-ts-regexp0 "\\] =>")))
17423 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17424 (save-window-excursion
17425 ;; Find closest clock to point, adjust the previous/next one in history
17426 (let* ((p (save-excursion (org-back-to-heading t)))
17427 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17428 (clfixnth
17429 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17430 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17431 (if (not clfixpos)
17432 (message "No clock to adjust")
17433 (save-excursion
17434 (org-goto-marker-or-bmk clfixpos)
17435 (org-show-subtree)
17436 (when (re-search-forward clrgx nil t)
17437 (goto-char (match-beginning 1))
17438 (let (org-clock-adjust-closest)
17439 (org-timestamp-change n org-ts-what updown))
17440 (message "Clock adjusted in %s for heading: %s"
17441 (file-name-nondirectory (buffer-file-name))
17442 (org-get-heading t t)))))))))
17443 ;; Try to recenter the calendar window, if any.
17444 (if (and org-calendar-follow-timestamp-change
17445 (get-buffer-window "*Calendar*" t)
17446 (memq org-ts-what '(day month year)))
17447 (org-recenter-calendar (time-to-days time))))))
17449 (defun org-modify-ts-extra (s pos n dm)
17450 "Change the different parts of the lead-time and repeat fields in timestamp."
17451 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17452 ng h m new rem)
17453 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17454 (cond
17455 ((or (org-pos-in-match-range pos 2)
17456 (org-pos-in-match-range pos 3))
17457 (setq m (string-to-number (match-string 3 s))
17458 h (string-to-number (match-string 2 s)))
17459 (if (org-pos-in-match-range pos 2)
17460 (setq h (+ h n))
17461 (setq n (* dm (org-no-warnings (signum n))))
17462 (when (not (= 0 (setq rem (% m dm))))
17463 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17464 (setq m (+ m n)))
17465 (if (< m 0) (setq m (+ m 60) h (1- h)))
17466 (if (> m 59) (setq m (- m 60) h (1+ h)))
17467 (setq h (min 24 (max 0 h)))
17468 (setq ng 1 new (format "-%02d:%02d" h m)))
17469 ((org-pos-in-match-range pos 6)
17470 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17471 ((org-pos-in-match-range pos 5)
17472 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17474 ((org-pos-in-match-range pos 9)
17475 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17476 ((org-pos-in-match-range pos 8)
17477 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17479 (when ng
17480 (setq s (concat
17481 (substring s 0 (match-beginning ng))
17483 (substring s (match-end ng))))))
17486 (defun org-recenter-calendar (date)
17487 "If the calendar is visible, recenter it to DATE."
17488 (let ((cwin (get-buffer-window "*Calendar*" t)))
17489 (when cwin
17490 (let ((calendar-move-hook nil))
17491 (with-selected-window cwin
17492 (calendar-goto-date (if (listp date) date
17493 (calendar-gregorian-from-absolute date))))))))
17495 (defun org-goto-calendar (&optional arg)
17496 "Go to the Emacs calendar at the current date.
17497 If there is a time stamp in the current line, go to that date.
17498 A prefix ARG can be used to force the current date."
17499 (interactive "P")
17500 (let ((tsr org-ts-regexp) diff
17501 (calendar-move-hook nil)
17502 (calendar-view-holidays-initially-flag nil)
17503 (calendar-view-diary-initially-flag nil))
17504 (if (or (org-at-timestamp-p)
17505 (save-excursion
17506 (beginning-of-line 1)
17507 (looking-at (concat ".*" tsr))))
17508 (let ((d1 (time-to-days (current-time)))
17509 (d2 (time-to-days
17510 (org-time-string-to-time (match-string 1)))))
17511 (setq diff (- d2 d1))))
17512 (calendar)
17513 (calendar-goto-today)
17514 (if (and diff (not arg)) (calendar-forward-day diff))))
17516 (defun org-get-date-from-calendar ()
17517 "Return a list (month day year) of date at point in calendar."
17518 (with-current-buffer "*Calendar*"
17519 (save-match-data
17520 (calendar-cursor-to-date))))
17522 (defun org-date-from-calendar ()
17523 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17524 If there is already a time stamp at the cursor position, update it."
17525 (interactive)
17526 (if (org-at-timestamp-p t)
17527 (org-timestamp-change 0 'calendar)
17528 (let ((cal-date (org-get-date-from-calendar)))
17529 (org-insert-time-stamp
17530 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17532 (defcustom org-effort-durations
17533 `(("h" . 60)
17534 ("d" . ,(* 60 8))
17535 ("w" . ,(* 60 8 5))
17536 ("m" . ,(* 60 8 5 4))
17537 ("y" . ,(* 60 8 5 40)))
17538 "Conversion factor to minutes for an effort modifier.
17540 Each entry has the form (MODIFIER . MINUTES).
17542 In an effort string, a number followed by MODIFIER is multiplied
17543 by the specified number of MINUTES to obtain an effort in
17544 minutes.
17546 For example, if the value of this variable is ((\"hours\" . 60)), then an
17547 effort string \"2hours\" is equivalent to 120 minutes."
17548 :group 'org-agenda
17549 :version "24.1"
17550 :type '(alist :key-type (string :tag "Modifier")
17551 :value-type (number :tag "Minutes")))
17553 (defun org-minutes-to-clocksum-string (m)
17554 "Format number of minutes as a clocksum string.
17555 The format is determined by `org-time-clocksum-format',
17556 `org-time-clocksum-use-fractional' and
17557 `org-time-clocksum-fractional-format' and
17558 `org-time-clocksum-use-effort-durations'."
17559 (let ((clocksum "")
17560 (m (round m)) ; Don't allow fractions of minutes
17561 h d w mo y fmt n)
17562 (setq h (if org-time-clocksum-use-effort-durations
17563 (cdr (assoc "h" org-effort-durations)) 60)
17564 d (if org-time-clocksum-use-effort-durations
17565 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17566 w (if org-time-clocksum-use-effort-durations
17567 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17568 mo (if org-time-clocksum-use-effort-durations
17569 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17570 y (if org-time-clocksum-use-effort-durations
17571 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17572 ;; fractional format
17573 (if org-time-clocksum-use-fractional
17574 (cond
17575 ;; single format string
17576 ((stringp org-time-clocksum-fractional-format)
17577 (format org-time-clocksum-fractional-format (/ m (float h))))
17578 ;; choice of fractional formats for different time units
17579 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17580 (> (/ (truncate m) (* y d h)) 0))
17581 (format fmt (/ m (* y d (float h)))))
17582 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17583 (> (/ (truncate m) (* mo d h)) 0))
17584 (format fmt (/ m (* mo d (float h)))))
17585 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17586 (> (/ (truncate m) (* w d h)) 0))
17587 (format fmt (/ m (* w d (float h)))))
17588 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17589 (> (/ (truncate m) (* d h)) 0))
17590 (format fmt (/ m (* d (float h)))))
17591 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17592 (> (/ (truncate m) h) 0))
17593 (format fmt (/ m (float h))))
17594 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17595 (format fmt m))
17596 ;; fall back to smallest time unit with a format
17597 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17598 (format fmt (/ m (float h))))
17599 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17600 (format fmt (/ m (* d (float h)))))
17601 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17602 (format fmt (/ m (* w d (float h)))))
17603 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17604 (format fmt (/ m (* mo d (float h)))))
17605 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17606 (format fmt (/ m (* y d (float h))))))
17607 ;; standard (non-fractional) format, with single format string
17608 (if (stringp org-time-clocksum-format)
17609 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17610 ;; separate formats components
17611 (and (setq fmt (plist-get org-time-clocksum-format :years))
17612 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17613 (plist-get org-time-clocksum-format :require-years))
17614 (setq clocksum (concat clocksum (format fmt n))
17615 m (- m (* n y d h))))
17616 (and (setq fmt (plist-get org-time-clocksum-format :months))
17617 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17618 (plist-get org-time-clocksum-format :require-months))
17619 (setq clocksum (concat clocksum (format fmt n))
17620 m (- m (* n mo d h))))
17621 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17622 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17623 (plist-get org-time-clocksum-format :require-weeks))
17624 (setq clocksum (concat clocksum (format fmt n))
17625 m (- m (* n w d h))))
17626 (and (setq fmt (plist-get org-time-clocksum-format :days))
17627 (or (> (setq n (/ (truncate m) (* d h))) 0)
17628 (plist-get org-time-clocksum-format :require-days))
17629 (setq clocksum (concat clocksum (format fmt n))
17630 m (- m (* n d h))))
17631 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17632 (or (> (setq n (/ (truncate m) h)) 0)
17633 (plist-get org-time-clocksum-format :require-hours))
17634 (setq clocksum (concat clocksum (format fmt n))
17635 m (- m (* n h))))
17636 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17637 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17638 (setq clocksum (concat clocksum (format fmt m))))
17639 ;; return formatted time duration
17640 clocksum))))
17642 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17643 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17644 "Org mode version 8.0")
17646 (defun org-hours-to-clocksum-string (n)
17647 (org-minutes-to-clocksum-string (* n 60)))
17649 (defun org-hh:mm-string-to-minutes (s)
17650 "Convert a string H:MM to a number of minutes.
17651 If the string is just a number, interpret it as minutes.
17652 In fact, the first hh:mm or number in the string will be taken,
17653 there can be extra stuff in the string.
17654 If no number is found, the return value is 0."
17655 (cond
17656 ((integerp s) s)
17657 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17658 (+ (* (string-to-number (match-string 1 s)) 60)
17659 (string-to-number (match-string 2 s))))
17660 ((string-match "\\([0-9]+\\)" s)
17661 (string-to-number (match-string 1 s)))
17662 (t 0)))
17664 (defcustom org-image-actual-width t
17665 "Should we use the actual width of images when inlining them?
17667 When set to `t', always use the image width.
17669 When set to a number, use imagemagick (when available) to set
17670 the image's width to this value.
17672 When set to a number in a list, try to get the width from any
17673 #+ATTR.* keyword if it matches a width specification like
17675 #+ATTR_HTML: :width 300px
17677 and fall back on that number if none is found.
17679 When set to nil, try to get the width from an #+ATTR.* keyword
17680 and fall back on the original width if none is found.
17682 This requires Emacs >= 24.1, build with imagemagick support."
17683 :group 'org-appearance
17684 :version "24.4"
17685 :package-version '(Org . "8.0")
17686 :type '(choice
17687 (const :tag "Use the image width" t)
17688 (integer :tag "Use a number of pixels")
17689 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17690 (const :tag "Use #+ATTR* or don't resize" nil)))
17692 (defcustom org-agenda-inhibit-startup nil
17693 "Inhibit startup when preparing agenda buffers.
17694 When this variable is `t' (the default), the initialization of
17695 the Org agenda buffers is inhibited: e.g. the visibility state
17696 is not set, the tables are not re-aligned, etc."
17697 :type 'boolean
17698 :version "24.3"
17699 :group 'org-agenda)
17701 (defcustom org-agenda-ignore-drawer-properties nil
17702 "Avoid updating text properties when building the agenda.
17703 Properties are used to prepare buffers for effort estimates, appointments,
17704 and subtree-local categories.
17705 If you don't use these in the agenda, you can add them to this list and
17706 agenda building will be a bit faster.
17707 The value is a list, with zero or more of the symbols `effort', `appt',
17708 or `category'."
17709 :type '(set :greedy t
17710 (const effort)
17711 (const appt)
17712 (const category))
17713 :version "24.3"
17714 :group 'org-agenda)
17716 (defun org-duration-string-to-minutes (s &optional output-to-string)
17717 "Convert a duration string S to minutes.
17719 A bare number is interpreted as minutes, modifiers can be set by
17720 customizing `org-effort-durations' (which see).
17722 Entries containing a colon are interpreted as H:MM by
17723 `org-hh:mm-string-to-minutes'."
17724 (let ((result 0)
17725 (re (concat "\\([0-9.]+\\) *\\("
17726 (regexp-opt (mapcar 'car org-effort-durations))
17727 "\\)")))
17728 (while (string-match re s)
17729 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17730 (string-to-number (match-string 1 s))))
17731 (setq s (replace-match "" nil t s)))
17732 (setq result (floor result))
17733 (incf result (org-hh:mm-string-to-minutes s))
17734 (if output-to-string (number-to-string result) result)))
17736 ;;;; Files
17738 (defun org-save-all-org-buffers ()
17739 "Save all Org-mode buffers without user confirmation."
17740 (interactive)
17741 (message "Saving all Org-mode buffers...")
17742 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17743 (when (featurep 'org-id) (org-id-locations-save))
17744 (message "Saving all Org-mode buffers... done"))
17746 (defun org-revert-all-org-buffers ()
17747 "Revert all Org-mode buffers.
17748 Prompt for confirmation when there are unsaved changes.
17749 Be sure you know what you are doing before letting this function
17750 overwrite your changes.
17752 This function is useful in a setup where one tracks org files
17753 with a version control system, to revert on one machine after pulling
17754 changes from another. I believe the procedure must be like this:
17756 1. M-x org-save-all-org-buffers
17757 2. Pull changes from the other machine, resolve conflicts
17758 3. M-x org-revert-all-org-buffers"
17759 (interactive)
17760 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17761 (user-error "Abort"))
17762 (save-excursion
17763 (save-window-excursion
17764 (mapc
17765 (lambda (b)
17766 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17767 (with-current-buffer b buffer-file-name))
17768 (org-pop-to-buffer-same-window b)
17769 (revert-buffer t 'no-confirm)))
17770 (buffer-list))
17771 (when (and (featurep 'org-id) org-id-track-globally)
17772 (org-id-locations-load)))))
17774 ;;;; Agenda files
17776 ;;;###autoload
17777 (defun org-switchb (&optional arg)
17778 "Switch between Org buffers.
17779 With one prefix argument, restrict available buffers to files.
17780 With two prefix arguments, restrict available buffers to agenda files.
17782 Defaults to `iswitchb' for buffer name completion.
17783 Set `org-completion-use-ido' to make it use ido instead."
17784 (interactive "P")
17785 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17786 ((equal arg '(16)) (org-buffer-list 'agenda))
17787 (t (org-buffer-list))))
17788 (org-completion-use-iswitchb org-completion-use-iswitchb)
17789 (org-completion-use-ido org-completion-use-ido))
17790 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17791 (setq org-completion-use-iswitchb t))
17792 (org-pop-to-buffer-same-window
17793 (org-icompleting-read "Org buffer: "
17794 (mapcar 'list (mapcar 'buffer-name blist))
17795 nil t))))
17797 ;;; Define some older names previously used for this functionality
17798 ;;;###autoload
17799 (defalias 'org-ido-switchb 'org-switchb)
17800 ;;;###autoload
17801 (defalias 'org-iswitchb 'org-switchb)
17803 (defun org-buffer-list (&optional predicate exclude-tmp)
17804 "Return a list of Org buffers.
17805 PREDICATE can be `export', `files' or `agenda'.
17807 export restrict the list to Export buffers.
17808 files restrict the list to buffers visiting Org files.
17809 agenda restrict the list to buffers visiting agenda files.
17811 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17812 (let* ((bfn nil)
17813 (agenda-files (and (eq predicate 'agenda)
17814 (mapcar 'file-truename (org-agenda-files t))))
17815 (filter
17816 (cond
17817 ((eq predicate 'files)
17818 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17819 ((eq predicate 'export)
17820 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17821 ((eq predicate 'agenda)
17822 (lambda (b)
17823 (with-current-buffer b
17824 (and (derived-mode-p 'org-mode)
17825 (setq bfn (buffer-file-name b))
17826 (member (file-truename bfn) agenda-files)))))
17827 (t (lambda (b) (with-current-buffer b
17828 (or (derived-mode-p 'org-mode)
17829 (string-match "\*Org .*Export"
17830 (buffer-name b)))))))))
17831 (delq nil
17832 (mapcar
17833 (lambda(b)
17834 (if (and (funcall filter b)
17835 (or (not exclude-tmp)
17836 (not (string-match "tmp" (buffer-name b)))))
17838 nil))
17839 (buffer-list)))))
17841 (defun org-agenda-files (&optional unrestricted archives)
17842 "Get the list of agenda files.
17843 Optional UNRESTRICTED means return the full list even if a restriction
17844 is currently in place.
17845 When ARCHIVES is t, include all archive files that are really being
17846 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17847 `org-agenda-archives-mode' is t."
17848 (let ((files
17849 (cond
17850 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17851 ((stringp org-agenda-files) (org-read-agenda-file-list))
17852 ((listp org-agenda-files) org-agenda-files)
17853 (t (error "Invalid value of `org-agenda-files'")))))
17854 (setq files (apply 'append
17855 (mapcar (lambda (f)
17856 (if (file-directory-p f)
17857 (directory-files
17858 f t org-agenda-file-regexp)
17859 (list f)))
17860 files)))
17861 (when org-agenda-skip-unavailable-files
17862 (setq files (delq nil
17863 (mapcar (function
17864 (lambda (file)
17865 (and (file-readable-p file) file)))
17866 files))))
17867 (when (or (eq archives t)
17868 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17869 (setq files (org-add-archive-files files)))
17870 files))
17872 (defun org-agenda-file-p (&optional file)
17873 "Return non-nil, if FILE is an agenda file.
17874 If FILE is omitted, use the file associated with the current
17875 buffer."
17876 (member (or file (buffer-file-name))
17877 (org-agenda-files t)))
17879 (defun org-edit-agenda-file-list ()
17880 "Edit the list of agenda files.
17881 Depending on setup, this either uses customize to edit the variable
17882 `org-agenda-files', or it visits the file that is holding the list. In the
17883 latter case, the buffer is set up in a way that saving it automatically kills
17884 the buffer and restores the previous window configuration."
17885 (interactive)
17886 (if (stringp org-agenda-files)
17887 (let ((cw (current-window-configuration)))
17888 (find-file org-agenda-files)
17889 (org-set-local 'org-window-configuration cw)
17890 (org-add-hook 'after-save-hook
17891 (lambda ()
17892 (set-window-configuration
17893 (prog1 org-window-configuration
17894 (kill-buffer (current-buffer))))
17895 (org-install-agenda-files-menu)
17896 (message "New agenda file list installed"))
17897 nil 'local)
17898 (message "%s" (substitute-command-keys
17899 "Edit list and finish with \\[save-buffer]")))
17900 (customize-variable 'org-agenda-files)))
17902 (defun org-store-new-agenda-file-list (list)
17903 "Set new value for the agenda file list and save it correctly."
17904 (if (stringp org-agenda-files)
17905 (let ((fe (org-read-agenda-file-list t)) b u)
17906 (while (setq b (find-buffer-visiting org-agenda-files))
17907 (kill-buffer b))
17908 (with-temp-file org-agenda-files
17909 (insert
17910 (mapconcat
17911 (lambda (f) ;; Keep un-expanded entries.
17912 (if (setq u (assoc f fe))
17913 (cdr u)
17915 list "\n")
17916 "\n")))
17917 (let ((org-mode-hook nil) (org-inhibit-startup t)
17918 (org-insert-mode-line-in-empty-file nil))
17919 (setq org-agenda-files list)
17920 (customize-save-variable 'org-agenda-files org-agenda-files))))
17922 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17923 "Read the list of agenda files from a file.
17924 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17925 filenames, used by `org-store-new-agenda-file-list' to write back
17926 un-expanded file names."
17927 (when (file-directory-p org-agenda-files)
17928 (error "`org-agenda-files' cannot be a single directory"))
17929 (when (stringp org-agenda-files)
17930 (with-temp-buffer
17931 (insert-file-contents org-agenda-files)
17932 (mapcar
17933 (lambda (f)
17934 (let ((e (expand-file-name (substitute-in-file-name f)
17935 org-directory)))
17936 (if pair-with-expansion
17937 (cons e f)
17938 e)))
17939 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
17941 ;;;###autoload
17942 (defun org-cycle-agenda-files ()
17943 "Cycle through the files in `org-agenda-files'.
17944 If the current buffer visits an agenda file, find the next one in the list.
17945 If the current buffer does not, find the first agenda file."
17946 (interactive)
17947 (let* ((fs (org-agenda-files t))
17948 (files (append fs (list (car fs))))
17949 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17950 file)
17951 (unless files (user-error "No agenda files"))
17952 (catch 'exit
17953 (while (setq file (pop files))
17954 (if (equal (file-truename file) tcf)
17955 (when (car files)
17956 (find-file (car files))
17957 (throw 'exit t))))
17958 (find-file (car fs)))
17959 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17961 (defun org-agenda-file-to-front (&optional to-end)
17962 "Move/add the current file to the top of the agenda file list.
17963 If the file is not present in the list, it is added to the front. If it is
17964 present, it is moved there. With optional argument TO-END, add/move to the
17965 end of the list."
17966 (interactive "P")
17967 (let ((org-agenda-skip-unavailable-files nil)
17968 (file-alist (mapcar (lambda (x)
17969 (cons (file-truename x) x))
17970 (org-agenda-files t)))
17971 (ctf (file-truename
17972 (or buffer-file-name
17973 (user-error "Please save the current buffer to a file"))))
17974 x had)
17975 (setq x (assoc ctf file-alist) had x)
17977 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17978 (if to-end
17979 (setq file-alist (append (delq x file-alist) (list x)))
17980 (setq file-alist (cons x (delq x file-alist))))
17981 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17982 (org-install-agenda-files-menu)
17983 (message "File %s to %s of agenda file list"
17984 (if had "moved" "added") (if to-end "end" "front"))))
17986 (defun org-remove-file (&optional file)
17987 "Remove current file from the list of files in variable `org-agenda-files'.
17988 These are the files which are being checked for agenda entries.
17989 Optional argument FILE means use this file instead of the current."
17990 (interactive)
17991 (let* ((org-agenda-skip-unavailable-files nil)
17992 (file (or file buffer-file-name
17993 (user-error "Current buffer does not visit a file")))
17994 (true-file (file-truename file))
17995 (afile (abbreviate-file-name file))
17996 (files (delq nil (mapcar
17997 (lambda (x)
17998 (if (equal true-file
17999 (file-truename x))
18000 nil x))
18001 (org-agenda-files t)))))
18002 (if (not (= (length files) (length (org-agenda-files t))))
18003 (progn
18004 (org-store-new-agenda-file-list files)
18005 (org-install-agenda-files-menu)
18006 (message "Removed file: %s" afile))
18007 (message "File was not in list: %s (not removed)" afile))))
18009 (defun org-file-menu-entry (file)
18010 (vector file (list 'find-file file) t))
18012 (defun org-check-agenda-file (file)
18013 "Make sure FILE exists. If not, ask user what to do."
18014 (when (not (file-exists-p file))
18015 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18016 (abbreviate-file-name file))
18017 (let ((r (downcase (read-char-exclusive))))
18018 (cond
18019 ((equal r ?r)
18020 (org-remove-file file)
18021 (throw 'nextfile t))
18022 (t (error "Abort"))))))
18024 (defun org-get-agenda-file-buffer (file)
18025 "Get a buffer visiting FILE. If the buffer needs to be created, add
18026 it to the list of buffers which might be released later."
18027 (let ((buf (org-find-base-buffer-visiting file)))
18028 (if buf
18029 buf ; just return it
18030 ;; Make a new buffer and remember it
18031 (setq buf (find-file-noselect file))
18032 (if buf (push buf org-agenda-new-buffers))
18033 buf)))
18035 (defun org-release-buffers (blist)
18036 "Release all buffers in list, asking the user for confirmation when needed.
18037 When a buffer is unmodified, it is just killed. When modified, it is saved
18038 \(if the user agrees) and then killed."
18039 (let (buf file)
18040 (while (setq buf (pop blist))
18041 (setq file (buffer-file-name buf))
18042 (when (and (buffer-modified-p buf)
18043 file
18044 (y-or-n-p (format "Save file %s? " file)))
18045 (with-current-buffer buf (save-buffer)))
18046 (kill-buffer buf))))
18048 (defun org-agenda-prepare-buffers (files)
18049 "Create buffers for all agenda files, protect archived trees and comments."
18050 (interactive)
18051 (let ((pa '(:org-archived t))
18052 (pc '(:org-comment t))
18053 (pall '(:org-archived t :org-comment t))
18054 (inhibit-read-only t)
18055 (org-inhibit-startup org-agenda-inhibit-startup)
18056 (rea (concat ":" org-archive-tag ":"))
18057 file re pos)
18058 (setq org-tag-alist-for-agenda nil
18059 org-tag-groups-alist-for-agenda nil)
18060 (save-window-excursion
18061 (save-restriction
18062 (while (setq file (pop files))
18063 (catch 'nextfile
18064 (if (bufferp file)
18065 (set-buffer file)
18066 (org-check-agenda-file file)
18067 (set-buffer (org-get-agenda-file-buffer file)))
18068 (widen)
18069 (org-set-regexps-and-options-for-tags)
18070 (setq pos (point))
18071 (goto-char (point-min))
18072 (let ((case-fold-search t))
18073 (when (search-forward "#+setupfile" nil t)
18074 ;; Don't set all regexps and options systematically as
18075 ;; this is only run for setting agenda tags from setup
18076 ;; file
18077 (org-set-regexps-and-options)))
18078 (or (memq 'category org-agenda-ignore-drawer-properties)
18079 (org-refresh-category-properties))
18080 (or (memq 'effort org-agenda-ignore-drawer-properties)
18081 (org-refresh-properties org-effort-property 'org-effort))
18082 (or (memq 'appt org-agenda-ignore-drawer-properties)
18083 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18084 (setq org-todo-keywords-for-agenda
18085 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18086 (setq org-done-keywords-for-agenda
18087 (append org-done-keywords-for-agenda org-done-keywords))
18088 (setq org-todo-keyword-alist-for-agenda
18089 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18090 (setq org-drawers-for-agenda
18091 (append org-drawers-for-agenda org-drawers))
18092 (setq org-tag-alist-for-agenda
18093 (org-uniquify
18094 (append org-tag-alist-for-agenda
18095 org-tag-alist
18096 org-tag-persistent-alist)))
18097 (if org-group-tags
18098 (setq org-tag-groups-alist-for-agenda
18099 (org-uniquify-alist
18100 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18101 (org-with-silent-modifications
18102 (save-excursion
18103 (remove-text-properties (point-min) (point-max) pall)
18104 (when org-agenda-skip-archived-trees
18105 (goto-char (point-min))
18106 (while (re-search-forward rea nil t)
18107 (if (org-at-heading-p t)
18108 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18109 (goto-char (point-min))
18110 (setq re (format org-heading-keyword-regexp-format
18111 org-comment-string))
18112 (while (re-search-forward re nil t)
18113 (add-text-properties
18114 (match-beginning 0) (org-end-of-subtree t) pc))))
18115 (goto-char pos)))))
18116 (setq org-todo-keywords-for-agenda
18117 (org-uniquify org-todo-keywords-for-agenda))
18118 (setq org-todo-keyword-alist-for-agenda
18119 (org-uniquify org-todo-keyword-alist-for-agenda))))
18122 ;;;; CDLaTeX minor mode
18124 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18125 "Keymap for the minor `org-cdlatex-mode'.")
18127 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18128 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18129 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18130 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18131 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18133 (defvar org-cdlatex-texmathp-advice-is-done nil
18134 "Flag remembering if we have applied the advice to texmathp already.")
18136 (define-minor-mode org-cdlatex-mode
18137 "Toggle the minor `org-cdlatex-mode'.
18138 This mode supports entering LaTeX environment and math in LaTeX fragments
18139 in Org-mode.
18140 \\{org-cdlatex-mode-map}"
18141 nil " OCDL" nil
18142 (when org-cdlatex-mode
18143 (require 'cdlatex)
18144 (run-hooks 'cdlatex-mode-hook)
18145 (cdlatex-compute-tables))
18146 (unless org-cdlatex-texmathp-advice-is-done
18147 (setq org-cdlatex-texmathp-advice-is-done t)
18148 (defadvice texmathp (around org-math-always-on activate)
18149 "Always return t in org-mode buffers.
18150 This is because we want to insert math symbols without dollars even outside
18151 the LaTeX math segments. If Orgmode thinks that point is actually inside
18152 an embedded LaTeX fragment, let texmathp do its job.
18153 \\[org-cdlatex-mode-map]"
18154 (interactive)
18155 (let (p)
18156 (cond
18157 ((not (derived-mode-p 'org-mode)) ad-do-it)
18158 ((eq this-command 'cdlatex-math-symbol)
18159 (setq ad-return-value t
18160 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18162 (let ((p (org-inside-LaTeX-fragment-p)))
18163 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18164 (setq ad-return-value t
18165 texmathp-why '("Org-mode embedded math" . 0))
18166 (if p ad-do-it)))))))))
18168 (defun turn-on-org-cdlatex ()
18169 "Unconditionally turn on `org-cdlatex-mode'."
18170 (org-cdlatex-mode 1))
18172 (defun org-try-cdlatex-tab ()
18173 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18174 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18175 - inside a LaTeX fragment, or
18176 - after the first word in a line, where an abbreviation expansion could
18177 insert a LaTeX environment."
18178 (when org-cdlatex-mode
18179 (cond
18180 ;; Before any word on the line: No expansion possible.
18181 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18182 ;; Just after first word on the line: Expand it. Make sure it
18183 ;; cannot happen on headlines, though.
18184 ((save-excursion
18185 (skip-chars-backward "a-zA-Z0-9*")
18186 (skip-chars-backward " \t")
18187 (and (bolp) (not (org-at-heading-p))))
18188 (cdlatex-tab) t)
18189 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18191 (defun org-cdlatex-underscore-caret (&optional arg)
18192 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18193 Revert to the normal definition outside of these fragments."
18194 (interactive "P")
18195 (if (org-inside-LaTeX-fragment-p)
18196 (call-interactively 'cdlatex-sub-superscript)
18197 (let (org-cdlatex-mode)
18198 (call-interactively (key-binding (vector last-input-event))))))
18200 (defun org-cdlatex-math-modify (&optional arg)
18201 "Execute `cdlatex-math-modify' in LaTeX fragments.
18202 Revert to the normal definition outside of these fragments."
18203 (interactive "P")
18204 (if (org-inside-LaTeX-fragment-p)
18205 (call-interactively 'cdlatex-math-modify)
18206 (let (org-cdlatex-mode)
18207 (call-interactively (key-binding (vector last-input-event))))))
18211 ;;;; LaTeX fragments
18213 (defvar org-latex-regexps
18214 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
18215 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18216 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
18217 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18218 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18219 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
18220 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
18221 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
18222 "Regular expressions for matching embedded LaTeX.")
18224 (defun org-inside-LaTeX-fragment-p ()
18225 "Test if point is inside a LaTeX fragment.
18226 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18227 sequence appearing also before point.
18228 Even though the matchers for math are configurable, this function assumes
18229 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18230 delimiters are skipped when they have been removed by customization.
18231 The return value is nil, or a cons cell with the delimiter and the
18232 position of this delimiter.
18234 This function does a reasonably good job, but can locally be fooled by
18235 for example currency specifications. For example it will assume being in
18236 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18237 fragments that are properly closed, but during editing, we have to live
18238 with the uncertainty caused by missing closing delimiters. This function
18239 looks only before point, not after."
18240 (catch 'exit
18241 (let ((pos (point))
18242 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18243 (lim (progn
18244 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18245 (point)))
18246 dd-on str (start 0) m re)
18247 (goto-char pos)
18248 (when dodollar
18249 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18250 re (nth 1 (assoc "$" org-latex-regexps)))
18251 (while (string-match re str start)
18252 (cond
18253 ((= (match-end 0) (length str))
18254 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18255 ((= (match-end 0) (- (length str) 5))
18256 (throw 'exit nil))
18257 (t (setq start (match-end 0))))))
18258 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18259 (goto-char pos)
18260 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18261 (and (match-beginning 2) (throw 'exit nil))
18262 ;; count $$
18263 (while (re-search-backward "\\$\\$" lim t)
18264 (setq dd-on (not dd-on)))
18265 (goto-char pos)
18266 (if dd-on (cons "$$" m))))))
18268 (defun org-inside-latex-macro-p ()
18269 "Is point inside a LaTeX macro or its arguments?"
18270 (save-match-data
18271 (org-in-regexp
18272 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18274 (defvar org-latex-fragment-image-overlays nil
18275 "List of overlays carrying the images of latex fragments.")
18276 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18278 (defun org-remove-latex-fragment-image-overlays ()
18279 "Remove all overlays with LaTeX fragment images in current buffer."
18280 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18281 (setq org-latex-fragment-image-overlays nil))
18283 (defun org-preview-latex-fragment (&optional subtree)
18284 "Preview the LaTeX fragment at point, or all locally or globally.
18285 If the cursor is in a LaTeX fragment, create the image and overlay
18286 it over the source code. If there is no fragment at point, display
18287 all fragments in the current text, from one headline to the next. With
18288 prefix SUBTREE, display all fragments in the current subtree. With a
18289 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18290 the cursor is before the first headline,
18291 display all fragments in the buffer.
18292 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
18293 (interactive "P")
18294 (unless buffer-file-name
18295 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18296 (when (display-graphic-p)
18297 (org-remove-latex-fragment-image-overlays)
18298 (save-excursion
18299 (save-restriction
18300 (let (beg end at msg)
18301 (cond
18302 ((or (equal subtree '(16))
18303 (not (save-excursion
18304 (re-search-backward org-outline-regexp-bol nil t))))
18305 (setq beg (point-min) end (point-max)
18306 msg "Creating images for buffer...%s"))
18307 ((equal subtree '(4))
18308 (org-back-to-heading)
18309 (setq beg (point) end (org-end-of-subtree t)
18310 msg "Creating images for subtree...%s"))
18312 (if (setq at (org-inside-LaTeX-fragment-p))
18313 (goto-char (max (point-min) (- (cdr at) 2)))
18314 (org-back-to-heading))
18315 (setq beg (point) end (progn (outline-next-heading) (point))
18316 msg (if at "Creating image...%s"
18317 "Creating images for entry...%s"))))
18318 (message msg "")
18319 (narrow-to-region beg end)
18320 (goto-char beg)
18321 (org-format-latex
18322 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18323 (file-name-nondirectory
18324 buffer-file-name)))
18325 default-directory 'overlays msg at 'forbuffer
18326 org-latex-create-formula-image-program)
18327 (message msg "done. Use `C-c C-c' to remove images."))))))
18329 (defun org-format-latex (prefix &optional dir overlays msg at
18330 forbuffer processing-type)
18331 "Replace LaTeX fragments with links to an image, and produce images.
18332 Some of the options can be changed using the variable
18333 `org-format-latex-options'."
18334 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18335 (let* ((prefixnodir (file-name-nondirectory prefix))
18336 (absprefix (expand-file-name prefix dir))
18337 (todir (file-name-directory absprefix))
18338 (opt org-format-latex-options)
18339 (optnew org-format-latex-options)
18340 (matchers (plist-get opt :matchers))
18341 (re-list org-latex-regexps)
18342 (cnt 0) txt hash link beg end re e checkdir
18343 string
18344 m n block-type block linkfile movefile ov)
18345 ;; Check the different regular expressions
18346 (while (setq e (pop re-list))
18347 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18348 block (if block-type "\n\n" ""))
18349 (when (member m matchers)
18350 (goto-char (point-min))
18351 (while (re-search-forward re nil t)
18352 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18353 (or (not overlays)
18354 (not (eq (get-char-property (match-beginning n)
18355 'org-overlay-type)
18356 'org-latex-overlay))))
18357 (cond
18358 ((eq processing-type 'verbatim))
18359 ((eq processing-type 'mathjax)
18360 ;; Prepare for MathJax processing.
18361 (setq string (match-string n))
18362 (when (member m '("$" "$1"))
18363 (save-excursion
18364 (delete-region (match-beginning n) (match-end n))
18365 (goto-char (match-beginning n))
18366 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18367 ((or (eq processing-type 'dvipng)
18368 (eq processing-type 'imagemagick))
18369 ;; Process to an image.
18370 (setq txt (match-string n)
18371 beg (match-beginning n) end (match-end n)
18372 cnt (1+ cnt))
18373 (let ((face (face-at-point))
18374 (fg (plist-get opt :foreground))
18375 (bg (plist-get opt :background))
18376 ;; Ensure full list is printed.
18377 print-length print-level)
18378 (when forbuffer
18379 ;; Get the colors from the face at point.
18380 (goto-char beg)
18381 (when (eq fg 'auto)
18382 (setq fg (face-attribute face :foreground nil 'default)))
18383 (when (eq bg 'auto)
18384 (setq bg (face-attribute face :background nil 'default)))
18385 (setq optnew (copy-sequence opt))
18386 (plist-put optnew :foreground fg)
18387 (plist-put optnew :background bg))
18388 (setq hash (sha1 (prin1-to-string
18389 (list org-format-latex-header
18390 org-latex-default-packages-alist
18391 org-latex-packages-alist
18392 org-format-latex-options
18393 forbuffer txt fg bg)))
18394 linkfile (format "%s_%s.png" prefix hash)
18395 movefile (format "%s_%s.png" absprefix hash)))
18396 (setq link (concat block "[[file:" linkfile "]]" block))
18397 (if msg (message msg cnt))
18398 (goto-char beg)
18399 (unless checkdir ; Ensure the directory exists.
18400 (setq checkdir t)
18401 (or (file-directory-p todir) (make-directory todir t)))
18402 (unless (file-exists-p movefile)
18403 (org-create-formula-image
18404 txt movefile optnew forbuffer processing-type))
18405 (if overlays
18406 (progn
18407 (mapc (lambda (o)
18408 (if (eq (overlay-get o 'org-overlay-type)
18409 'org-latex-overlay)
18410 (delete-overlay o)))
18411 (overlays-in beg end))
18412 (setq ov (make-overlay beg end))
18413 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18414 (if (featurep 'xemacs)
18415 (progn
18416 (overlay-put ov 'invisible t)
18417 (overlay-put
18418 ov 'end-glyph
18419 (make-glyph (vector 'png :file movefile))))
18420 (overlay-put
18421 ov 'display
18422 (list 'image :type 'png :file movefile :ascent 'center)))
18423 (push ov org-latex-fragment-image-overlays)
18424 (goto-char end))
18425 (delete-region beg end)
18426 (insert (org-add-props link
18427 (list 'org-latex-src
18428 (replace-regexp-in-string
18429 "\"" "" txt)
18430 'org-latex-src-embed-type
18431 (if block-type 'paragraph 'character))))))
18432 ((eq processing-type 'mathml)
18433 ;; Process to MathML
18434 (unless (save-match-data (org-format-latex-mathml-available-p))
18435 (user-error "LaTeX to MathML converter not configured"))
18436 (setq txt (match-string n)
18437 beg (match-beginning n) end (match-end n)
18438 cnt (1+ cnt))
18439 (if msg (message msg cnt))
18440 (goto-char beg)
18441 (delete-region beg end)
18442 (insert (org-format-latex-as-mathml
18443 txt block-type prefix dir)))
18445 (error "Unknown conversion type %s for LaTeX fragments"
18446 processing-type)))))))))
18448 (defun org-create-math-formula (latex-frag &optional mathml-file)
18449 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18450 Use `org-latex-to-mathml-convert-command'. If the conversion is
18451 sucessful, return the portion between \"<math...> </math>\"
18452 elements otherwise return nil. When MATHML-FILE is specified,
18453 write the results in to that file. When invoked as an
18454 interactive command, prompt for LATEX-FRAG, with initial value
18455 set to the current active region and echo the results for user
18456 inspection."
18457 (interactive (list (let ((frag (when (org-region-active-p)
18458 (buffer-substring-no-properties
18459 (region-beginning) (region-end)))))
18460 (read-string "LaTeX Fragment: " frag nil frag))))
18461 (unless latex-frag (error "Invalid LaTeX fragment"))
18462 (let* ((tmp-in-file (file-relative-name
18463 (make-temp-name (expand-file-name "ltxmathml-in"))))
18464 (ignore (write-region latex-frag nil tmp-in-file))
18465 (tmp-out-file (file-relative-name
18466 (make-temp-name (expand-file-name "ltxmathml-out"))))
18467 (cmd (format-spec
18468 org-latex-to-mathml-convert-command
18469 `((?j . ,(shell-quote-argument
18470 (expand-file-name org-latex-to-mathml-jar-file)))
18471 (?I . ,(shell-quote-argument tmp-in-file))
18472 (?o . ,(shell-quote-argument tmp-out-file)))))
18473 mathml shell-command-output)
18474 (when (org-called-interactively-p 'any)
18475 (unless (org-format-latex-mathml-available-p)
18476 (user-error "LaTeX to MathML converter not configured")))
18477 (message "Running %s" cmd)
18478 (setq shell-command-output (shell-command-to-string cmd))
18479 (setq mathml
18480 (when (file-readable-p tmp-out-file)
18481 (with-current-buffer (find-file-noselect tmp-out-file t)
18482 (goto-char (point-min))
18483 (when (re-search-forward
18484 (concat
18485 (regexp-quote
18486 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18487 "\\(.\\|\n\\)*"
18488 (regexp-quote "</math>")) nil t)
18489 (prog1 (match-string 0) (kill-buffer))))))
18490 (cond
18491 (mathml
18492 (setq mathml
18493 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18494 (when mathml-file
18495 (write-region mathml nil mathml-file))
18496 (when (org-called-interactively-p 'any)
18497 (message mathml)))
18498 ((message "LaTeX to MathML conversion failed")
18499 (message shell-command-output)))
18500 (delete-file tmp-in-file)
18501 (when (file-exists-p tmp-out-file)
18502 (delete-file tmp-out-file))
18503 mathml))
18505 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18506 prefix &optional dir)
18507 "Use `org-create-math-formula' but check local cache first."
18508 (let* ((absprefix (expand-file-name prefix dir))
18509 (print-length nil) (print-level nil)
18510 (formula-id (concat
18511 "formula-"
18512 (sha1
18513 (prin1-to-string
18514 (list latex-frag
18515 org-latex-to-mathml-convert-command)))))
18516 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18517 (formula-cache-dir (file-name-directory formula-cache)))
18519 (unless (file-directory-p formula-cache-dir)
18520 (make-directory formula-cache-dir t))
18522 (unless (file-exists-p formula-cache)
18523 (org-create-math-formula latex-frag formula-cache))
18525 (if (file-exists-p formula-cache)
18526 ;; Successful conversion. Return the link to MathML file.
18527 (org-add-props
18528 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18529 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18530 'org-latex-src-embed-type (if latex-frag-type
18531 'paragraph 'character)))
18532 ;; Failed conversion. Return the LaTeX fragment verbatim
18533 latex-frag)))
18535 (defun org-create-formula-image (string tofile options buffer &optional type)
18536 "Create an image from LaTeX source using dvipng or convert.
18537 This function calls either `org-create-formula-image-with-dvipng'
18538 or `org-create-formula-image-with-imagemagick' depending on the
18539 value of `org-latex-create-formula-image-program' or on the value
18540 of the optional TYPE variable.
18542 Note: ultimately these two function should be combined as they
18543 share a good deal of logic."
18544 (org-check-external-command
18545 "latex" "needed to convert LaTeX fragments to images")
18546 (funcall
18547 (case (or type org-latex-create-formula-image-program)
18548 ('dvipng
18549 (org-check-external-command
18550 "dvipng" "needed to convert LaTeX fragments to images")
18551 #'org-create-formula-image-with-dvipng)
18552 ('imagemagick
18553 (org-check-external-command
18554 "convert" "you need to install imagemagick")
18555 #'org-create-formula-image-with-imagemagick)
18556 (t (error
18557 "Invalid value of `org-latex-create-formula-image-program'")))
18558 string tofile options buffer))
18560 (declare-function org-export-get-backend "ox" (name))
18561 (declare-function org-export--get-global-options "ox" (&optional backend))
18562 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18563 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18564 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18565 (defun org-create-formula--latex-header ()
18566 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18567 (let ((info (org-combine-plists (org-export--get-global-options
18568 (org-export-get-backend 'latex))
18569 (org-export--get-inbuffer-options
18570 (org-export-get-backend 'latex)))))
18571 (org-latex-guess-babel-language
18572 (org-latex-guess-inputenc
18573 (org-splice-latex-header
18574 org-format-latex-header
18575 org-latex-default-packages-alist
18576 org-latex-packages-alist t
18577 (plist-get info :latex-header)))
18578 info)))
18580 ;; This function borrows from Ganesh Swami's latex2png.el
18581 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18582 "This calls dvipng."
18583 (require 'ox-latex)
18584 (let* ((tmpdir (if (featurep 'xemacs)
18585 (temp-directory)
18586 temporary-file-directory))
18587 (texfilebase (make-temp-name
18588 (expand-file-name "orgtex" tmpdir)))
18589 (texfile (concat texfilebase ".tex"))
18590 (dvifile (concat texfilebase ".dvi"))
18591 (pngfile (concat texfilebase ".png"))
18592 (fnh (if (featurep 'xemacs)
18593 (font-height (face-font 'default))
18594 (face-attribute 'default :height nil)))
18595 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18596 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18597 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18598 "Black"))
18599 (bg (or (plist-get options (if buffer :background :html-background))
18600 "Transparent")))
18601 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18602 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18603 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18604 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18605 (let ((latex-header (org-create-formula--latex-header)))
18606 (with-temp-file texfile
18607 (insert latex-header)
18608 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18609 (let ((dir default-directory))
18610 (condition-case nil
18611 (progn
18612 (cd tmpdir)
18613 (call-process "latex" nil nil nil texfile))
18614 (error nil))
18615 (cd dir))
18616 (if (not (file-exists-p dvifile))
18617 (progn (message "Failed to create dvi file from %s" texfile) nil)
18618 (condition-case nil
18619 (if (featurep 'xemacs)
18620 (call-process "dvipng" nil nil nil
18621 "-fg" fg "-bg" bg
18622 "-T" "tight"
18623 "-o" pngfile
18624 dvifile)
18625 (call-process "dvipng" nil nil nil
18626 "-fg" fg "-bg" bg
18627 "-D" dpi
18628 ;;"-x" scale "-y" scale
18629 "-T" "tight"
18630 "-o" pngfile
18631 dvifile))
18632 (error nil))
18633 (if (not (file-exists-p pngfile))
18634 (if org-format-latex-signal-error
18635 (error "Failed to create png file from %s" texfile)
18636 (message "Failed to create png file from %s" texfile)
18637 nil)
18638 ;; Use the requested file name and clean up
18639 (copy-file pngfile tofile 'replace)
18640 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18641 (if (file-exists-p (concat texfilebase e))
18642 (delete-file (concat texfilebase e))))
18643 pngfile))))
18645 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18646 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18647 "This calls convert, which is included into imagemagick."
18648 (require 'ox-latex)
18649 (let* ((tmpdir (if (featurep 'xemacs)
18650 (temp-directory)
18651 temporary-file-directory))
18652 (texfilebase (make-temp-name
18653 (expand-file-name "orgtex" tmpdir)))
18654 (texfile (concat texfilebase ".tex"))
18655 (pdffile (concat texfilebase ".pdf"))
18656 (pngfile (concat texfilebase ".png"))
18657 (fnh (if (featurep 'xemacs)
18658 (font-height (face-font 'default))
18659 (face-attribute 'default :height nil)))
18660 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18661 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18662 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18663 "black"))
18664 (bg (or (plist-get options (if buffer :background :html-background))
18665 "white")))
18666 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18667 (setq fg (org-latex-color-format fg)))
18668 (if (eq bg 'default) (setq bg (org-latex-color :background))
18669 (setq bg (org-latex-color-format
18670 (if (string= bg "Transparent") "white" bg))))
18671 (let ((latex-header (org-create-formula--latex-header)))
18672 (with-temp-file texfile
18673 (insert latex-header)
18674 (insert "\n\\begin{document}\n"
18675 "\\definecolor{fg}{rgb}{" fg "}\n"
18676 "\\definecolor{bg}{rgb}{" bg "}\n"
18677 "\n\\pagecolor{bg}\n"
18678 "\n{\\color{fg}\n"
18679 string
18680 "\n}\n"
18681 "\n\\end{document}\n")))
18682 (org-latex-compile texfile t)
18683 (if (not (file-exists-p pdffile))
18684 (progn (message "Failed to create pdf file from %s" texfile) nil)
18685 (condition-case nil
18686 (if (featurep 'xemacs)
18687 (call-process "convert" nil nil nil
18688 "-density" "96"
18689 "-trim"
18690 "-antialias"
18691 pdffile
18692 "-quality" "100"
18693 ;; "-sharpen" "0x1.0"
18694 pngfile)
18695 (call-process "convert" nil nil nil
18696 "-density" dpi
18697 "-trim"
18698 "-antialias"
18699 pdffile
18700 "-quality" "100"
18701 ;; "-sharpen" "0x1.0"
18702 pngfile))
18703 (error nil))
18704 (if (not (file-exists-p pngfile))
18705 (if org-format-latex-signal-error
18706 (error "Failed to create png file from %s" texfile)
18707 (message "Failed to create png file from %s" texfile)
18708 nil)
18709 ;; Use the requested file name and clean up
18710 (copy-file pngfile tofile 'replace)
18711 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18712 (if (file-exists-p (concat texfilebase e))
18713 (delete-file (concat texfilebase e))))
18714 pngfile))))
18716 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18717 "Fill a LaTeX header template TPL.
18718 In the template, the following place holders will be recognized:
18720 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
18721 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18722 [PACKAGES] \\usepackage statements for PKG
18723 [NO-PACKAGES] do not include PKG
18724 [EXTRA] the string EXTRA
18725 [NO-EXTRA] do not include EXTRA
18727 For backward compatibility, if both the positive and the negative place
18728 holder is missing, the positive one (without the \"NO-\") will be
18729 assumed to be present at the end of the template.
18730 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18731 EXTRA is a string.
18732 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18733 (let (rpl (end ""))
18734 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
18735 (setq rpl (if (or (match-end 1) (not def-pkg))
18736 "" (org-latex-packages-to-string def-pkg snippets-p t))
18737 tpl (replace-match rpl t t tpl))
18738 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18740 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
18741 (setq rpl (if (or (match-end 1) (not pkg))
18742 "" (org-latex-packages-to-string pkg snippets-p t))
18743 tpl (replace-match rpl t t tpl))
18744 (if pkg (setq end
18745 (concat end "\n"
18746 (org-latex-packages-to-string pkg snippets-p)))))
18748 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
18749 (setq rpl (if (or (match-end 1) (not extra))
18750 "" (concat extra "\n"))
18751 tpl (replace-match rpl t t tpl))
18752 (if (and extra (string-match "\\S-" extra))
18753 (setq end (concat end "\n" extra))))
18755 (if (string-match "\\S-" end)
18756 (concat tpl "\n" end)
18757 tpl)))
18759 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18760 "Turn an alist of packages into a string with the \\usepackage macros."
18761 (setq pkg (mapconcat (lambda(p)
18762 (cond
18763 ((stringp p) p)
18764 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18765 (format "%% Package %s omitted" (cadr p)))
18766 ((equal "" (car p))
18767 (format "\\usepackage{%s}" (cadr p)))
18769 (format "\\usepackage[%s]{%s}"
18770 (car p) (cadr p)))))
18772 "\n"))
18773 (if newline (concat pkg "\n") pkg))
18775 (defun org-dvipng-color (attr)
18776 "Return a RGB color specification for dvipng."
18777 (apply 'format "rgb %s %s %s"
18778 (mapcar 'org-normalize-color
18779 (if (featurep 'xemacs)
18780 (color-rgb-components
18781 (face-property 'default
18782 (cond ((eq attr :foreground) 'foreground)
18783 ((eq attr :background) 'background))))
18784 (color-values (face-attribute 'default attr nil))))))
18786 (defun org-dvipng-color-format (color-name)
18787 "Convert COLOR-NAME to a RGB color value for dvipng."
18788 (apply 'format "rgb %s %s %s"
18789 (mapcar 'org-normalize-color
18790 (color-values color-name))))
18792 (defun org-latex-color (attr)
18793 "Return a RGB color for the LaTeX color package."
18794 (apply 'format "%s,%s,%s"
18795 (mapcar 'org-normalize-color
18796 (if (featurep 'xemacs)
18797 (color-rgb-components
18798 (face-property 'default
18799 (cond ((eq attr :foreground) 'foreground)
18800 ((eq attr :background) 'background))))
18801 (color-values (face-attribute 'default attr nil))))))
18803 (defun org-latex-color-format (color-name)
18804 "Convert COLOR-NAME to a RGB color value."
18805 (apply 'format "%s,%s,%s"
18806 (mapcar 'org-normalize-color
18807 (color-values color-name))))
18809 (defun org-normalize-color (value)
18810 "Return string to be used as color value for an RGB component."
18811 (format "%g" (/ value 65535.0)))
18815 ;; Image display
18817 (defvar org-inline-image-overlays nil)
18818 (make-variable-buffer-local 'org-inline-image-overlays)
18820 (defun org-toggle-inline-images (&optional include-linked)
18821 "Toggle the display of inline images.
18822 INCLUDE-LINKED is passed to `org-display-inline-images'."
18823 (interactive "P")
18824 (if org-inline-image-overlays
18825 (progn
18826 (org-remove-inline-images)
18827 (message "Inline image display turned off"))
18828 (org-display-inline-images include-linked)
18829 (if (and (org-called-interactively-p)
18830 org-inline-image-overlays)
18831 (message "%d images displayed inline"
18832 (length org-inline-image-overlays))
18833 (message "No images to display inline"))))
18835 (defun org-redisplay-inline-images ()
18836 "Refresh the display of inline images."
18837 (interactive)
18838 (if (not org-inline-image-overlays)
18839 (org-toggle-inline-images)
18840 (org-toggle-inline-images)
18841 (org-toggle-inline-images)))
18843 (defun org-display-inline-images (&optional include-linked refresh beg end)
18844 "Display inline images.
18845 Normally only links without a description part are inlined, because this
18846 is how it will work for export. When INCLUDE-LINKED is set, also links
18847 with a description part will be inlined. This can be nice for a quick
18848 look at those images, but it does not reflect what exported files will look
18849 like.
18850 When REFRESH is set, refresh existing images between BEG and END.
18851 This will create new image displays only if necessary.
18852 BEG and END default to the buffer boundaries."
18853 (interactive "P")
18854 (when (display-graphic-p)
18855 (unless refresh
18856 (org-remove-inline-images)
18857 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18858 (save-excursion
18859 (save-restriction
18860 (widen)
18861 (setq beg (or beg (point-min)) end (or end (point-max)))
18862 (goto-char beg)
18863 (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
18864 (substring (org-image-file-name-regexp) 0 -2)
18865 "\\)\\]" (if include-linked "" "\\]")))
18866 (case-fold-search t)
18867 old file ov img type attrwidth width)
18868 (while (re-search-forward re end t)
18869 (setq old (get-char-property-and-overlay (match-beginning 1)
18870 'org-image-overlay)
18871 file (expand-file-name
18872 (concat (or (match-string 3) "") (match-string 4))))
18873 (when (image-type-available-p 'imagemagick)
18874 (setq attrwidth (if (or (listp org-image-actual-width)
18875 (null org-image-actual-width))
18876 (save-excursion
18877 (save-match-data
18878 (when (re-search-backward
18879 "#\\+attr.*:width[ \t]+\\([^ ]+\\)"
18880 (save-excursion
18881 (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
18882 (string-to-number (match-string 1))))))
18883 width (cond ((eq org-image-actual-width t) nil)
18884 ((null org-image-actual-width) attrwidth)
18885 ((numberp org-image-actual-width)
18886 org-image-actual-width)
18887 ((listp org-image-actual-width)
18888 (or attrwidth (car org-image-actual-width))))
18889 type (if width 'imagemagick)))
18890 (when (file-exists-p file)
18891 (if (and (car-safe old) refresh)
18892 (image-refresh (overlay-get (cdr old) 'display))
18893 (setq img (save-match-data (create-image file type nil :width width)))
18894 (when img
18895 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18896 (overlay-put ov 'display img)
18897 (overlay-put ov 'face 'default)
18898 (overlay-put ov 'org-image-overlay t)
18899 (overlay-put ov 'modification-hooks
18900 (list 'org-display-inline-remove-overlay))
18901 (push ov org-inline-image-overlays))))))))))
18903 (define-obsolete-function-alias
18904 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18906 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18907 "Remove inline-display overlay if a corresponding region is modified."
18908 (let ((inhibit-modification-hooks t))
18909 (when (and ov after)
18910 (delete ov org-inline-image-overlays)
18911 (delete-overlay ov))))
18913 (defun org-remove-inline-images ()
18914 "Remove inline display of images."
18915 (interactive)
18916 (mapc 'delete-overlay org-inline-image-overlays)
18917 (setq org-inline-image-overlays nil))
18919 ;;;; Key bindings
18921 ;; Outline functions from `outline-mode-prefix-map'
18922 ;; that can be remapped in Org:
18923 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18924 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18925 (define-key org-mode-map [remap outline-forward-same-level]
18926 'org-forward-heading-same-level)
18927 (define-key org-mode-map [remap outline-backward-same-level]
18928 'org-backward-heading-same-level)
18929 (define-key org-mode-map [remap show-branches]
18930 'org-kill-note-or-show-branches)
18931 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18932 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18933 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18935 ;; Outline functions from `outline-mode-prefix-map' that can not
18936 ;; be remapped in Org:
18938 ;; - the column "key binding" shows whether the Outline function is still
18939 ;; available in Org mode on the same key that it has been bound to in
18940 ;; Outline mode:
18941 ;; - "overridden": key used for a different functionality in Org mode
18942 ;; - else: key still bound to the same Outline function in Org mode
18944 ;; | Outline function | key binding | Org replacement |
18945 ;; |------------------------------------+-------------+-----------------------|
18946 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18947 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18948 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18949 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18950 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18951 ;; | `show-entry' | overridden | no replacement |
18952 ;; | `show-children' | `C-c C-i' | visibility cycling |
18953 ;; | `show-branches' | `C-c C-k' | still same function |
18954 ;; | `show-subtree' | overridden | visibility cycling |
18955 ;; | `show-all' | overridden | no replacement |
18956 ;; | `hide-subtree' | overridden | visibility cycling |
18957 ;; | `hide-body' | overridden | no replacement |
18958 ;; | `hide-entry' | overridden | visibility cycling |
18959 ;; | `hide-leaves' | overridden | no replacement |
18960 ;; | `hide-sublevels' | overridden | no replacement |
18961 ;; | `hide-other' | overridden | no replacement |
18963 ;; Make `C-c C-x' a prefix key
18964 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18966 ;; TAB key with modifiers
18967 (org-defkey org-mode-map "\C-i" 'org-cycle)
18968 (org-defkey org-mode-map [(tab)] 'org-cycle)
18969 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18970 (org-defkey org-mode-map "\M-\t" 'pcomplete)
18971 ;; The following line is necessary under Suse GNU/Linux
18972 (unless (featurep 'xemacs)
18973 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18974 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18975 (define-key org-mode-map [backtab] 'org-shifttab)
18977 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18978 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18979 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18981 ;; Cursor keys with modifiers
18982 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18983 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18984 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18985 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18987 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18988 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18989 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18990 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18992 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18993 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18994 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18995 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18997 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18998 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18999 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19000 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19002 ;; Babel keys
19003 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19004 (mapc (lambda (pair)
19005 (define-key org-babel-map (car pair) (cdr pair)))
19006 org-babel-key-bindings)
19008 ;;; Extra keys for tty access.
19009 ;; We only set them when really needed because otherwise the
19010 ;; menus don't show the simple keys
19012 (when (or org-use-extra-keys
19013 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19014 (not window-system))
19015 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19016 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19017 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19018 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19019 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19020 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19021 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19022 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19023 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19024 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19025 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19026 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19027 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19028 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19029 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19030 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19031 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19032 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19033 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19034 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19035 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19036 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19037 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19038 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19039 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19040 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19041 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19042 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19044 ;; All the other keys
19046 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19047 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19048 (if (boundp 'narrow-map)
19049 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19050 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19051 (if (boundp 'narrow-map)
19052 (org-defkey narrow-map "b" 'org-narrow-to-block)
19053 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19054 (if (boundp 'narrow-map)
19055 (org-defkey narrow-map "e" 'org-narrow-to-element)
19056 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19057 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19058 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19059 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19060 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19061 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19062 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19063 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19064 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19065 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19066 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19067 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19068 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19069 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19070 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19071 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19072 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19073 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19074 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19075 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19076 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19077 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19078 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19079 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19080 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19081 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19082 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19083 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19084 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19085 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19086 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19087 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19088 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19089 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19090 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19091 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19092 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19093 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19094 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19095 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19096 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19097 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19098 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19099 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19100 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19101 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19102 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19103 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19104 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19105 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19106 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19107 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19108 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19109 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19110 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19111 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19112 (org-defkey org-mode-map "\C-c^" 'org-sort)
19113 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19114 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19115 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19116 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19117 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19118 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19119 (org-defkey org-mode-map "\C-m" 'org-return)
19120 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19121 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19122 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19123 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19124 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19125 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19126 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19127 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19128 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19129 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19130 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19131 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19132 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19133 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19134 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19135 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19136 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19137 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19138 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19139 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19140 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19141 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19142 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19144 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19145 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19146 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19148 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19149 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19150 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19151 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19152 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19153 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19154 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19155 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19156 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19157 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19158 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19159 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19160 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19161 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19162 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19163 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19164 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19165 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19166 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19167 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19168 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19169 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19170 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19172 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19173 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19174 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19175 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19176 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19178 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19180 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19182 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19183 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19185 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19188 (when (featurep 'xemacs)
19189 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19192 (defconst org-speed-commands-default
19194 ("Outline Navigation")
19195 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19196 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19197 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19198 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19199 ("F" . org-next-block)
19200 ("B" . org-previous-block)
19201 ("u" . (org-speed-move-safe 'outline-up-heading))
19202 ("j" . org-goto)
19203 ("g" . (org-refile t))
19204 ("Outline Visibility")
19205 ("c" . org-cycle)
19206 ("C" . org-shifttab)
19207 (" " . org-display-outline-path)
19208 ("s" . org-narrow-to-subtree)
19209 ("=" . org-columns)
19210 ("Outline Structure Editing")
19211 ("U" . org-shiftmetaup)
19212 ("D" . org-shiftmetadown)
19213 ("r" . org-metaright)
19214 ("l" . org-metaleft)
19215 ("R" . org-shiftmetaright)
19216 ("L" . org-shiftmetaleft)
19217 ("i" . (progn (forward-char 1) (call-interactively
19218 'org-insert-heading-respect-content)))
19219 ("^" . org-sort)
19220 ("w" . org-refile)
19221 ("a" . org-archive-subtree-default-with-confirmation)
19222 ("@" . org-mark-subtree)
19223 ("#" . org-toggle-comment)
19224 ("Clock Commands")
19225 ("I" . org-clock-in)
19226 ("O" . org-clock-out)
19227 ("Meta Data Editing")
19228 ("t" . org-todo)
19229 ("," . (org-priority))
19230 ("0" . (org-priority ?\ ))
19231 ("1" . (org-priority ?A))
19232 ("2" . (org-priority ?B))
19233 ("3" . (org-priority ?C))
19234 (":" . org-set-tags-command)
19235 ("e" . org-set-effort)
19236 ("E" . org-inc-effort)
19237 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19238 (org-entry-put (point) "APPT_WARNTIME" m)))
19239 ("Agenda Views etc")
19240 ("v" . org-agenda)
19241 ("/" . org-sparse-tree)
19242 ("Misc")
19243 ("o" . org-open-at-point)
19244 ("?" . org-speed-command-help)
19245 ("<" . (org-agenda-set-restriction-lock 'subtree))
19246 (">" . (org-agenda-remove-restriction-lock))
19248 "The default speed commands.")
19250 (defun org-print-speed-command (e)
19251 (if (> (length (car e)) 1)
19252 (progn
19253 (princ "\n")
19254 (princ (car e))
19255 (princ "\n")
19256 (princ (make-string (length (car e)) ?-))
19257 (princ "\n"))
19258 (princ (car e))
19259 (princ " ")
19260 (if (symbolp (cdr e))
19261 (princ (symbol-name (cdr e)))
19262 (prin1 (cdr e)))
19263 (princ "\n")))
19265 (defun org-speed-command-help ()
19266 "Show the available speed commands."
19267 (interactive)
19268 (if (not org-use-speed-commands)
19269 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19270 (with-output-to-temp-buffer "*Help*"
19271 (princ "User-defined Speed commands\n===========================\n")
19272 (mapc 'org-print-speed-command org-speed-commands-user)
19273 (princ "\n")
19274 (princ "Built-in Speed commands\n=======================\n")
19275 (mapc 'org-print-speed-command org-speed-commands-default))
19276 (with-current-buffer "*Help*"
19277 (setq truncate-lines t))))
19279 (defun org-speed-move-safe (cmd)
19280 "Execute CMD, but make sure that the cursor always ends up in a headline.
19281 If not, return to the original position and throw an error."
19282 (interactive)
19283 (let ((pos (point)))
19284 (call-interactively cmd)
19285 (unless (and (bolp) (org-at-heading-p))
19286 (goto-char pos)
19287 (error "Boundary reached while executing %s" cmd))))
19289 (defvar org-self-insert-command-undo-counter 0)
19291 (defvar org-table-auto-blank-field) ; defined in org-table.el
19292 (defvar org-speed-command nil)
19294 (define-obsolete-function-alias
19295 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19297 (defun org-speed-command-activate (keys)
19298 "Hook for activating single-letter speed commands.
19299 `org-speed-commands-default' specifies a minimal command set.
19300 Use `org-speed-commands-user' for further customization."
19301 (when (or (and (bolp) (looking-at org-outline-regexp))
19302 (and (functionp org-use-speed-commands)
19303 (funcall org-use-speed-commands)))
19304 (cdr (assoc keys (append org-speed-commands-user
19305 org-speed-commands-default)))))
19307 (define-obsolete-function-alias
19308 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19310 (defun org-babel-speed-command-activate (keys)
19311 "Hook for activating single-letter code block commands."
19312 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19313 (cdr (assoc keys org-babel-key-bindings))))
19315 (defcustom org-speed-command-hook
19316 '(org-speed-command-default-hook org-babel-speed-command-hook)
19317 "Hook for activating speed commands at strategic locations.
19318 Hook functions are called in sequence until a valid handler is
19319 found.
19321 Each hook takes a single argument, a user-pressed command key
19322 which is also a `self-insert-command' from the global map.
19324 Within the hook, examine the cursor position and the command key
19325 and return nil or a valid handler as appropriate. Handler could
19326 be one of an interactive command, a function, or a form.
19328 Set `org-use-speed-commands' to non-nil value to enable this
19329 hook. The default setting is `org-speed-command-activate'."
19330 :group 'org-structure
19331 :version "24.1"
19332 :type 'hook)
19334 (defun org-self-insert-command (N)
19335 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19336 If the cursor is in a table looking at whitespace, the whitespace is
19337 overwritten, and the table is not marked as requiring realignment."
19338 (interactive "p")
19339 (org-check-before-invisible-edit 'insert)
19340 (cond
19341 ((and org-use-speed-commands
19342 (setq org-speed-command
19343 (run-hook-with-args-until-success
19344 'org-speed-command-hook (this-command-keys))))
19345 (cond
19346 ((commandp org-speed-command)
19347 (setq this-command org-speed-command)
19348 (call-interactively org-speed-command))
19349 ((functionp org-speed-command)
19350 (funcall org-speed-command))
19351 ((and org-speed-command (listp org-speed-command))
19352 (eval org-speed-command))
19353 (t (let (org-use-speed-commands)
19354 (call-interactively 'org-self-insert-command)))))
19355 ((and
19356 (org-table-p)
19357 (progn
19358 ;; check if we blank the field, and if that triggers align
19359 (and (featurep 'org-table) org-table-auto-blank-field
19360 (member last-command
19361 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19362 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19363 ;; got extra space, this field does not determine column width
19364 (let (org-table-may-need-update) (org-table-blank-field))
19365 ;; no extra space, this field may determine column width
19366 (org-table-blank-field)))
19368 (eq N 1)
19369 (looking-at "[^|\n]* |"))
19370 (let (org-table-may-need-update)
19371 (goto-char (1- (match-end 0)))
19372 (backward-delete-char 1)
19373 (goto-char (match-beginning 0))
19374 (self-insert-command N)))
19376 (setq org-table-may-need-update t)
19377 (self-insert-command N)
19378 (org-fix-tags-on-the-fly)
19379 (if org-self-insert-cluster-for-undo
19380 (if (not (eq last-command 'org-self-insert-command))
19381 (setq org-self-insert-command-undo-counter 1)
19382 (if (>= org-self-insert-command-undo-counter 20)
19383 (setq org-self-insert-command-undo-counter 1)
19384 (and (> org-self-insert-command-undo-counter 0)
19385 buffer-undo-list (listp buffer-undo-list)
19386 (not (cadr buffer-undo-list)) ; remove nil entry
19387 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19388 (setq org-self-insert-command-undo-counter
19389 (1+ org-self-insert-command-undo-counter))))))))
19391 (defun org-check-before-invisible-edit (kind)
19392 "Check is editing if kind KIND would be dangerous with invisible text around.
19393 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19394 ;; First, try to get out of here as quickly as possible, to reduce overhead
19395 (if (and org-catch-invisible-edits
19396 (or (not (boundp 'visible-mode)) (not visible-mode))
19397 (or (get-char-property (point) 'invisible)
19398 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19399 ;; OK, we need to take a closer look
19400 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19401 (invisible-before-point (if (bobp) nil (get-char-property
19402 (1- (point)) 'invisible)))
19403 (border-and-ok-direction
19405 ;; Check if we are acting predictably before invisible text
19406 (and invisible-at-point (not invisible-before-point)
19407 (memq kind '(insert delete-backward)))
19408 ;; Check if we are acting predictably after invisible text
19409 ;; This works not well, and I have turned it off. It seems
19410 ;; better to always show and stop after invisible text.
19411 ;; (and (not invisible-at-point) invisible-before-point
19412 ;; (memq kind '(insert delete)))
19414 (when (or (memq invisible-at-point '(outline org-hide-block t))
19415 (memq invisible-before-point '(outline org-hide-block t)))
19416 (if (eq org-catch-invisible-edits 'error)
19417 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19418 (if (and org-custom-properties-overlays
19419 (y-or-n-p "Display invisible properties in this buffer? "))
19420 (org-toggle-custom-properties-visibility)
19421 ;; Make the area visible
19422 (save-excursion
19423 (if invisible-before-point
19424 (goto-char (previous-single-char-property-change
19425 (point) 'invisible)))
19426 (org-cycle))
19427 (cond
19428 ((eq org-catch-invisible-edits 'show)
19429 ;; That's it, we do the edit after showing
19430 (message
19431 "Unfolding invisible region around point before editing")
19432 (sit-for 1))
19433 ((and (eq org-catch-invisible-edits 'smart)
19434 border-and-ok-direction)
19435 (message "Unfolding invisible region around point before editing"))
19437 ;; Don't do the edit, make the user repeat it in full visibility
19438 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19440 (defun org-fix-tags-on-the-fly ()
19441 (when (and (equal (char-after (point-at-bol)) ?*)
19442 (org-at-heading-p))
19443 (org-align-tags-here org-tags-column)))
19445 (defun org-delete-backward-char (N)
19446 "Like `delete-backward-char', insert whitespace at field end in tables.
19447 When deleting backwards, in tables this function will insert whitespace in
19448 front of the next \"|\" separator, to keep the table aligned. The table will
19449 still be marked for re-alignment if the field did fill the entire column,
19450 because, in this case the deletion might narrow the column."
19451 (interactive "p")
19452 (save-match-data
19453 (org-check-before-invisible-edit 'delete-backward)
19454 (if (and (org-table-p)
19455 (eq N 1)
19456 (string-match "|" (buffer-substring (point-at-bol) (point)))
19457 (looking-at ".*?|"))
19458 (let ((pos (point))
19459 (noalign (looking-at "[^|\n\r]* |"))
19460 (c org-table-may-need-update))
19461 (backward-delete-char N)
19462 (if (not overwrite-mode)
19463 (progn
19464 (skip-chars-forward "^|")
19465 (insert " ")
19466 (goto-char (1- pos))))
19467 ;; noalign: if there were two spaces at the end, this field
19468 ;; does not determine the width of the column.
19469 (if noalign (setq org-table-may-need-update c)))
19470 (backward-delete-char N)
19471 (org-fix-tags-on-the-fly))))
19473 (defun org-delete-char (N)
19474 "Like `delete-char', but insert whitespace at field end in tables.
19475 When deleting characters, in tables this function will insert whitespace in
19476 front of the next \"|\" separator, to keep the table aligned. The table will
19477 still be marked for re-alignment if the field did fill the entire column,
19478 because, in this case the deletion might narrow the column."
19479 (interactive "p")
19480 (save-match-data
19481 (org-check-before-invisible-edit 'delete)
19482 (if (and (org-table-p)
19483 (not (bolp))
19484 (not (= (char-after) ?|))
19485 (eq N 1))
19486 (if (looking-at ".*?|")
19487 (let ((pos (point))
19488 (noalign (looking-at "[^|\n\r]* |"))
19489 (c org-table-may-need-update))
19490 (replace-match
19491 (concat (substring (match-string 0) 1 -1) " |") nil t)
19492 (goto-char pos)
19493 ;; noalign: if there were two spaces at the end, this field
19494 ;; does not determine the width of the column.
19495 (if noalign (setq org-table-may-need-update c)))
19496 (delete-char N))
19497 (delete-char N)
19498 (org-fix-tags-on-the-fly))))
19500 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19501 (put 'org-self-insert-command 'delete-selection
19502 (lambda ()
19503 (not (run-hook-with-args-until-success
19504 'self-insert-uses-region-functions))))
19505 (put 'orgtbl-self-insert-command 'delete-selection
19506 (lambda ()
19507 (not (run-hook-with-args-until-success
19508 'self-insert-uses-region-functions))))
19509 (put 'org-delete-char 'delete-selection 'supersede)
19510 (put 'org-delete-backward-char 'delete-selection 'supersede)
19511 (put 'org-yank 'delete-selection 'yank)
19513 ;; Make `flyspell-mode' delay after some commands
19514 (put 'org-self-insert-command 'flyspell-delayed t)
19515 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19516 (put 'org-delete-char 'flyspell-delayed t)
19517 (put 'org-delete-backward-char 'flyspell-delayed t)
19519 ;; Make pabbrev-mode expand after org-mode commands
19520 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19521 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19523 (defun org-remap (map &rest commands)
19524 "In MAP, remap the functions given in COMMANDS.
19525 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19526 (let (new old)
19527 (while commands
19528 (setq old (pop commands) new (pop commands))
19529 (if (fboundp 'command-remapping)
19530 (org-defkey map (vector 'remap old) new)
19531 (substitute-key-definition old new map global-map)))))
19533 (defun org-transpose-words ()
19534 "Transpose words for Org.
19535 This uses the `org-mode-transpose-word-syntax-table' syntax
19536 table, which interprets characters in `org-emphasis-alist' as
19537 word constituents."
19538 (interactive)
19539 (with-syntax-table org-mode-transpose-word-syntax-table
19540 (call-interactively 'transpose-words)))
19541 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19543 (when (eq org-enable-table-editor 'optimized)
19544 ;; If the user wants maximum table support, we need to hijack
19545 ;; some standard editing functions
19546 (org-remap org-mode-map
19547 'self-insert-command 'org-self-insert-command
19548 'delete-char 'org-delete-char
19549 'delete-backward-char 'org-delete-backward-char)
19550 (org-defkey org-mode-map "|" 'org-force-self-insert))
19552 (defvar org-ctrl-c-ctrl-c-hook nil
19553 "Hook for functions attaching themselves to `C-c C-c'.
19555 This can be used to add additional functionality to the C-c C-c
19556 key which executes context-dependent commands. This hook is run
19557 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19558 run after the last test.
19560 Each function will be called with no arguments. The function
19561 must check if the context is appropriate for it to act. If yes,
19562 it should do its thing and then return a non-nil value. If the
19563 context is wrong, just do nothing and return nil.")
19565 (defvar org-ctrl-c-ctrl-c-final-hook nil
19566 "Hook for functions attaching themselves to `C-c C-c'.
19568 This can be used to add additional functionality to the C-c C-c
19569 key which executes context-dependent commands. This hook is run
19570 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19571 before the first test.
19573 Each function will be called with no arguments. The function
19574 must check if the context is appropriate for it to act. If yes,
19575 it should do its thing and then return a non-nil value. If the
19576 context is wrong, just do nothing and return nil.")
19578 (defvar org-tab-first-hook nil
19579 "Hook for functions to attach themselves to TAB.
19580 See `org-ctrl-c-ctrl-c-hook' for more information.
19581 This hook runs as the first action when TAB is pressed, even before
19582 `org-cycle' messes around with the `outline-regexp' to cater for
19583 inline tasks and plain list item folding.
19584 If any function in this hook returns t, any other actions that
19585 would have been caused by TAB (such as table field motion or visibility
19586 cycling) will not occur.")
19588 (defvar org-tab-after-check-for-table-hook nil
19589 "Hook for functions to attach themselves to TAB.
19590 See `org-ctrl-c-ctrl-c-hook' for more information.
19591 This hook runs after it has been established that the cursor is not in a
19592 table, but before checking if the cursor is in a headline or if global cycling
19593 should be done.
19594 If any function in this hook returns t, not other actions like visibility
19595 cycling will be done.")
19597 (defvar org-tab-after-check-for-cycling-hook nil
19598 "Hook for functions to attach themselves to TAB.
19599 See `org-ctrl-c-ctrl-c-hook' for more information.
19600 This hook runs after it has been established that not table field motion and
19601 not visibility should be done because of current context. This is probably
19602 the place where a package like yasnippets can hook in.")
19604 (defvar org-tab-before-tab-emulation-hook nil
19605 "Hook for functions to attach themselves to TAB.
19606 See `org-ctrl-c-ctrl-c-hook' for more information.
19607 This hook runs after every other options for TAB have been exhausted, but
19608 before indentation and \t insertion takes place.")
19610 (defvar org-metaleft-hook nil
19611 "Hook for functions attaching themselves to `M-left'.
19612 See `org-ctrl-c-ctrl-c-hook' for more information.")
19613 (defvar org-metaright-hook nil
19614 "Hook for functions attaching themselves to `M-right'.
19615 See `org-ctrl-c-ctrl-c-hook' for more information.")
19616 (defvar org-metaup-hook nil
19617 "Hook for functions attaching themselves to `M-up'.
19618 See `org-ctrl-c-ctrl-c-hook' for more information.")
19619 (defvar org-metadown-hook nil
19620 "Hook for functions attaching themselves to `M-down'.
19621 See `org-ctrl-c-ctrl-c-hook' for more information.")
19622 (defvar org-shiftmetaleft-hook nil
19623 "Hook for functions attaching themselves to `M-S-left'.
19624 See `org-ctrl-c-ctrl-c-hook' for more information.")
19625 (defvar org-shiftmetaright-hook nil
19626 "Hook for functions attaching themselves to `M-S-right'.
19627 See `org-ctrl-c-ctrl-c-hook' for more information.")
19628 (defvar org-shiftmetaup-hook nil
19629 "Hook for functions attaching themselves to `M-S-up'.
19630 See `org-ctrl-c-ctrl-c-hook' for more information.")
19631 (defvar org-shiftmetadown-hook nil
19632 "Hook for functions attaching themselves to `M-S-down'.
19633 See `org-ctrl-c-ctrl-c-hook' for more information.")
19634 (defvar org-metareturn-hook nil
19635 "Hook for functions attaching themselves to `M-RET'.
19636 See `org-ctrl-c-ctrl-c-hook' for more information.")
19637 (defvar org-shiftup-hook nil
19638 "Hook for functions attaching themselves to `S-up'.
19639 See `org-ctrl-c-ctrl-c-hook' for more information.")
19640 (defvar org-shiftup-final-hook nil
19641 "Hook for functions attaching themselves to `S-up'.
19642 This one runs after all other options except shift-select have been excluded.
19643 See `org-ctrl-c-ctrl-c-hook' for more information.")
19644 (defvar org-shiftdown-hook nil
19645 "Hook for functions attaching themselves to `S-down'.
19646 See `org-ctrl-c-ctrl-c-hook' for more information.")
19647 (defvar org-shiftdown-final-hook nil
19648 "Hook for functions attaching themselves to `S-down'.
19649 This one runs after all other options except shift-select have been excluded.
19650 See `org-ctrl-c-ctrl-c-hook' for more information.")
19651 (defvar org-shiftleft-hook nil
19652 "Hook for functions attaching themselves to `S-left'.
19653 See `org-ctrl-c-ctrl-c-hook' for more information.")
19654 (defvar org-shiftleft-final-hook nil
19655 "Hook for functions attaching themselves to `S-left'.
19656 This one runs after all other options except shift-select have been excluded.
19657 See `org-ctrl-c-ctrl-c-hook' for more information.")
19658 (defvar org-shiftright-hook nil
19659 "Hook for functions attaching themselves to `S-right'.
19660 See `org-ctrl-c-ctrl-c-hook' for more information.")
19661 (defvar org-shiftright-final-hook nil
19662 "Hook for functions attaching themselves to `S-right'.
19663 This one runs after all other options except shift-select have been excluded.
19664 See `org-ctrl-c-ctrl-c-hook' for more information.")
19666 (defun org-modifier-cursor-error ()
19667 "Throw an error, a modified cursor command was applied in wrong context."
19668 (user-error "This command is active in special context like tables, headlines or items"))
19670 (defun org-shiftselect-error ()
19671 "Throw an error because Shift-Cursor command was applied in wrong context."
19672 (if (and (boundp 'shift-select-mode) shift-select-mode)
19673 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19674 (user-error "This command works only in special context like headlines or timestamps")))
19676 (defun org-call-for-shift-select (cmd)
19677 (let ((this-command-keys-shift-translated t))
19678 (call-interactively cmd)))
19680 (defun org-shifttab (&optional arg)
19681 "Global visibility cycling or move to previous table field.
19682 Call `org-table-previous-field' within a table.
19683 When ARG is nil, cycle globally through visibility states.
19684 When ARG is a numeric prefix, show contents of this level."
19685 (interactive "P")
19686 (cond
19687 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19688 ((integerp arg)
19689 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19690 (message "Content view to level: %d" arg)
19691 (org-content (prefix-numeric-value arg2))
19692 (org-cycle-show-empty-lines t)
19693 (setq org-cycle-global-status 'overview)))
19694 (t (call-interactively 'org-global-cycle))))
19696 (defun org-shiftmetaleft ()
19697 "Promote subtree or delete table column.
19698 Calls `org-promote-subtree', `org-outdent-item-tree', or
19699 `org-table-delete-column', depending on context. See the
19700 individual commands for more information."
19701 (interactive)
19702 (cond
19703 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19704 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19705 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19706 ((if (not (org-region-active-p)) (org-at-item-p)
19707 (save-excursion (goto-char (region-beginning))
19708 (org-at-item-p)))
19709 (call-interactively 'org-outdent-item-tree))
19710 (t (org-modifier-cursor-error))))
19712 (defun org-shiftmetaright ()
19713 "Demote subtree or insert table column.
19714 Calls `org-demote-subtree', `org-indent-item-tree', or
19715 `org-table-insert-column', depending on context. See the
19716 individual commands for more information."
19717 (interactive)
19718 (cond
19719 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19720 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19721 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19722 ((if (not (org-region-active-p)) (org-at-item-p)
19723 (save-excursion (goto-char (region-beginning))
19724 (org-at-item-p)))
19725 (call-interactively 'org-indent-item-tree))
19726 (t (org-modifier-cursor-error))))
19728 (defun org-shiftmetaup (&optional arg)
19729 "Move subtree up or kill table row.
19730 Calls `org-move-subtree-up' or `org-table-kill-row' or
19731 `org-move-item-up' or `org-timestamp-up', depending on context.
19732 See the individual commands for more information."
19733 (interactive "P")
19734 (cond
19735 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19736 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19737 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19738 ((org-at-item-p) (call-interactively 'org-move-item-up))
19739 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19740 (call-interactively 'org-timestamp-up)))
19741 (t (call-interactively 'org-drag-line-backward))))
19743 (defun org-shiftmetadown (&optional arg)
19744 "Move subtree down or insert table row.
19745 Calls `org-move-subtree-down' or `org-table-insert-row' or
19746 `org-move-item-down' or `org-timestamp-up', depending on context.
19747 See the individual commands for more information."
19748 (interactive "P")
19749 (cond
19750 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19751 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19752 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19753 ((org-at-item-p) (call-interactively 'org-move-item-down))
19754 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19755 (call-interactively 'org-timestamp-down)))
19756 (t (call-interactively 'org-drag-line-forward))))
19758 (defsubst org-hidden-tree-error ()
19759 (user-error
19760 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19762 (defun org-metaleft (&optional arg)
19763 "Promote heading or move table column to left.
19764 Calls `org-do-promote' or `org-table-move-column', depending on context.
19765 With no specific context, calls the Emacs default `backward-word'.
19766 See the individual commands for more information."
19767 (interactive "P")
19768 (cond
19769 ((run-hook-with-args-until-success 'org-metaleft-hook))
19770 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19771 ((org-with-limited-levels
19772 (or (org-at-heading-p)
19773 (and (org-region-active-p)
19774 (save-excursion
19775 (goto-char (region-beginning))
19776 (org-at-heading-p)))))
19777 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19778 (call-interactively 'org-do-promote))
19779 ;; At an inline task.
19780 ((org-at-heading-p)
19781 (call-interactively 'org-inlinetask-promote))
19782 ((or (org-at-item-p)
19783 (and (org-region-active-p)
19784 (save-excursion
19785 (goto-char (region-beginning))
19786 (org-at-item-p))))
19787 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19788 (call-interactively 'org-outdent-item))
19789 (t (call-interactively 'backward-word))))
19791 (defun org-metaright (&optional arg)
19792 "Demote a subtree, a list item or move table column to right.
19793 In front of a drawer or a block keyword, indent it correctly.
19794 With no specific context, calls the Emacs default `forward-word'.
19795 See the individual commands for more information."
19796 (interactive "P")
19797 (cond
19798 ((run-hook-with-args-until-success 'org-metaright-hook))
19799 ((org-at-table-p) (call-interactively 'org-table-move-column))
19800 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19801 ((org-at-block-p) (call-interactively 'org-indent-block))
19802 ((org-with-limited-levels
19803 (or (org-at-heading-p)
19804 (and (org-region-active-p)
19805 (save-excursion
19806 (goto-char (region-beginning))
19807 (org-at-heading-p)))))
19808 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19809 (call-interactively 'org-do-demote))
19810 ;; At an inline task.
19811 ((org-at-heading-p)
19812 (call-interactively 'org-inlinetask-demote))
19813 ((or (org-at-item-p)
19814 (and (org-region-active-p)
19815 (save-excursion
19816 (goto-char (region-beginning))
19817 (org-at-item-p))))
19818 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19819 (call-interactively 'org-indent-item))
19820 (t (call-interactively 'forward-word))))
19822 (defun org-check-for-hidden (what)
19823 "Check if there are hidden headlines/items in the current visual line.
19824 WHAT can be either `headlines' or `items'. If the current line is
19825 an outline or item heading and it has a folded subtree below it,
19826 this function returns t, nil otherwise."
19827 (let ((re (cond
19828 ((eq what 'headlines) org-outline-regexp-bol)
19829 ((eq what 'items) (org-item-beginning-re))
19830 (t (error "This should not happen"))))
19831 beg end)
19832 (save-excursion
19833 (catch 'exit
19834 (unless (org-region-active-p)
19835 (setq beg (point-at-bol))
19836 (beginning-of-line 2)
19837 (while (and (not (eobp)) ;; this is like `next-line'
19838 (get-char-property (1- (point)) 'invisible))
19839 (beginning-of-line 2))
19840 (setq end (point))
19841 (goto-char beg)
19842 (goto-char (point-at-eol))
19843 (setq end (max end (point)))
19844 (while (re-search-forward re end t)
19845 (if (get-char-property (match-beginning 0) 'invisible)
19846 (throw 'exit t))))
19847 nil))))
19849 (defun org-metaup (&optional arg)
19850 "Move subtree up or move table row up.
19851 Calls `org-move-subtree-up' or `org-table-move-row' or
19852 `org-move-item-up', depending on context. See the individual commands
19853 for more information."
19854 (interactive "P")
19855 (cond
19856 ((run-hook-with-args-until-success 'org-metaup-hook))
19857 ((org-region-active-p)
19858 (let* ((a (min (region-beginning) (region-end)))
19859 (b (1- (max (region-beginning) (region-end))))
19860 (c (save-excursion (goto-char a)
19861 (move-beginning-of-line 0)))
19862 (d (save-excursion (goto-char a)
19863 (move-end-of-line 0) (point))))
19864 (transpose-regions a b c d)
19865 (goto-char c)))
19866 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19867 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19868 ((org-at-item-p) (call-interactively 'org-move-item-up))
19869 (t (org-drag-element-backward))))
19871 (defun org-metadown (&optional arg)
19872 "Move subtree down or move table row down.
19873 Calls `org-move-subtree-down' or `org-table-move-row' or
19874 `org-move-item-down', depending on context. See the individual
19875 commands for more information."
19876 (interactive "P")
19877 (cond
19878 ((run-hook-with-args-until-success 'org-metadown-hook))
19879 ((org-region-active-p)
19880 (let* ((a (min (region-beginning) (region-end)))
19881 (b (max (region-beginning) (region-end)))
19882 (c (save-excursion (goto-char b)
19883 (move-beginning-of-line 1)))
19884 (d (save-excursion (goto-char b)
19885 (move-end-of-line 1) (1+ (point)))))
19886 (transpose-regions a b c d)
19887 (goto-char d)))
19888 ((org-at-table-p) (call-interactively 'org-table-move-row))
19889 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19890 ((org-at-item-p) (call-interactively 'org-move-item-down))
19891 (t (org-drag-element-forward))))
19893 (defun org-shiftup (&optional arg)
19894 "Increase item in timestamp or increase priority of current headline.
19895 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19896 depending on context. See the individual commands for more information."
19897 (interactive "P")
19898 (cond
19899 ((run-hook-with-args-until-success 'org-shiftup-hook))
19900 ((and org-support-shift-select (org-region-active-p))
19901 (org-call-for-shift-select 'previous-line))
19902 ((org-at-timestamp-p t)
19903 (call-interactively (if org-edit-timestamp-down-means-later
19904 'org-timestamp-down 'org-timestamp-up)))
19905 ((and (not (eq org-support-shift-select 'always))
19906 org-enable-priority-commands
19907 (org-at-heading-p))
19908 (call-interactively 'org-priority-up))
19909 ((and (not org-support-shift-select) (org-at-item-p))
19910 (call-interactively 'org-previous-item))
19911 ((org-clocktable-try-shift 'up arg))
19912 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19913 (org-support-shift-select
19914 (org-call-for-shift-select 'previous-line))
19915 (t (org-shiftselect-error))))
19917 (defun org-shiftdown (&optional arg)
19918 "Decrease item in timestamp or decrease priority of current headline.
19919 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19920 depending on context. See the individual commands for more information."
19921 (interactive "P")
19922 (cond
19923 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19924 ((and org-support-shift-select (org-region-active-p))
19925 (org-call-for-shift-select 'next-line))
19926 ((org-at-timestamp-p t)
19927 (call-interactively (if org-edit-timestamp-down-means-later
19928 'org-timestamp-up 'org-timestamp-down)))
19929 ((and (not (eq org-support-shift-select 'always))
19930 org-enable-priority-commands
19931 (org-at-heading-p))
19932 (call-interactively 'org-priority-down))
19933 ((and (not org-support-shift-select) (org-at-item-p))
19934 (call-interactively 'org-next-item))
19935 ((org-clocktable-try-shift 'down arg))
19936 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19937 (org-support-shift-select
19938 (org-call-for-shift-select 'next-line))
19939 (t (org-shiftselect-error))))
19941 (defun org-shiftright (&optional arg)
19942 "Cycle the thing at point or in the current line, depending on context.
19943 Depending on context, this does one of the following:
19945 - switch a timestamp at point one day into the future
19946 - on a headline, switch to the next TODO keyword.
19947 - on an item, switch entire list to the next bullet type
19948 - on a property line, switch to the next allowed value
19949 - on a clocktable definition line, move time block into the future"
19950 (interactive "P")
19951 (cond
19952 ((run-hook-with-args-until-success 'org-shiftright-hook))
19953 ((and org-support-shift-select (org-region-active-p))
19954 (org-call-for-shift-select 'forward-char))
19955 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19956 ((and (not (eq org-support-shift-select 'always))
19957 (org-at-heading-p))
19958 (let ((org-inhibit-logging
19959 (not org-treat-S-cursor-todo-selection-as-state-change))
19960 (org-inhibit-blocking
19961 (not org-treat-S-cursor-todo-selection-as-state-change)))
19962 (org-call-with-arg 'org-todo 'right)))
19963 ((or (and org-support-shift-select
19964 (not (eq org-support-shift-select 'always))
19965 (org-at-item-bullet-p))
19966 (and (not org-support-shift-select) (org-at-item-p)))
19967 (org-call-with-arg 'org-cycle-list-bullet nil))
19968 ((and (not (eq org-support-shift-select 'always))
19969 (org-at-property-p))
19970 (call-interactively 'org-property-next-allowed-value))
19971 ((org-clocktable-try-shift 'right arg))
19972 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19973 (org-support-shift-select
19974 (org-call-for-shift-select 'forward-char))
19975 (t (org-shiftselect-error))))
19977 (defun org-shiftleft (&optional arg)
19978 "Cycle the thing at point or in the current line, depending on context.
19979 Depending on context, this does one of the following:
19981 - switch a timestamp at point one day into the past
19982 - on a headline, switch to the previous TODO keyword.
19983 - on an item, switch entire list to the previous bullet type
19984 - on a property line, switch to the previous allowed value
19985 - on a clocktable definition line, move time block into the past"
19986 (interactive "P")
19987 (cond
19988 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19989 ((and org-support-shift-select (org-region-active-p))
19990 (org-call-for-shift-select 'backward-char))
19991 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19992 ((and (not (eq org-support-shift-select 'always))
19993 (org-at-heading-p))
19994 (let ((org-inhibit-logging
19995 (not org-treat-S-cursor-todo-selection-as-state-change))
19996 (org-inhibit-blocking
19997 (not org-treat-S-cursor-todo-selection-as-state-change)))
19998 (org-call-with-arg 'org-todo 'left)))
19999 ((or (and org-support-shift-select
20000 (not (eq org-support-shift-select 'always))
20001 (org-at-item-bullet-p))
20002 (and (not org-support-shift-select) (org-at-item-p)))
20003 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20004 ((and (not (eq org-support-shift-select 'always))
20005 (org-at-property-p))
20006 (call-interactively 'org-property-previous-allowed-value))
20007 ((org-clocktable-try-shift 'left arg))
20008 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20009 (org-support-shift-select
20010 (org-call-for-shift-select 'backward-char))
20011 (t (org-shiftselect-error))))
20013 (defun org-shiftcontrolright ()
20014 "Switch to next TODO set."
20015 (interactive)
20016 (cond
20017 ((and org-support-shift-select (org-region-active-p))
20018 (org-call-for-shift-select 'forward-word))
20019 ((and (not (eq org-support-shift-select 'always))
20020 (org-at-heading-p))
20021 (org-call-with-arg 'org-todo 'nextset))
20022 (org-support-shift-select
20023 (org-call-for-shift-select 'forward-word))
20024 (t (org-shiftselect-error))))
20026 (defun org-shiftcontrolleft ()
20027 "Switch to previous TODO set."
20028 (interactive)
20029 (cond
20030 ((and org-support-shift-select (org-region-active-p))
20031 (org-call-for-shift-select 'backward-word))
20032 ((and (not (eq org-support-shift-select 'always))
20033 (org-at-heading-p))
20034 (org-call-with-arg 'org-todo 'previousset))
20035 (org-support-shift-select
20036 (org-call-for-shift-select 'backward-word))
20037 (t (org-shiftselect-error))))
20039 (defun org-shiftcontrolup (&optional n)
20040 "Change timestamps synchronously up in CLOCK log lines.
20041 Optional argument N tells to change by that many units."
20042 (interactive "P")
20043 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20044 (let (org-support-shift-select)
20045 (org-clock-timestamps-up n))
20046 (user-error "Not at a clock log")))
20048 (defun org-shiftcontroldown (&optional n)
20049 "Change timestamps synchronously down in CLOCK log lines.
20050 Optional argument N tells to change by that many units."
20051 (interactive "P")
20052 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20053 (let (org-support-shift-select)
20054 (org-clock-timestamps-down n))
20055 (user-error "Not at a clock log")))
20057 (defun org-ctrl-c-ret ()
20058 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20059 (interactive)
20060 (cond
20061 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20062 (t (call-interactively 'org-insert-heading))))
20064 (defun org-find-visible ()
20065 (let ((s (point)))
20066 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20067 (get-char-property s 'invisible)))
20069 (defun org-find-invisible ()
20070 (let ((s (point)))
20071 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20072 (not (get-char-property s 'invisible))))
20075 (defun org-copy-visible (beg end)
20076 "Copy the visible parts of the region."
20077 (interactive "r")
20078 (let (snippets s)
20079 (save-excursion
20080 (save-restriction
20081 (narrow-to-region beg end)
20082 (setq s (goto-char (point-min)))
20083 (while (not (= (point) (point-max)))
20084 (goto-char (org-find-invisible))
20085 (push (buffer-substring s (point)) snippets)
20086 (setq s (goto-char (org-find-visible))))))
20087 (kill-new (apply 'concat (nreverse snippets)))))
20089 (defun org-copy-special ()
20090 "Copy region in table or copy current subtree.
20091 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20092 See the individual commands for more information."
20093 (interactive)
20094 (call-interactively
20095 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20097 (defun org-cut-special ()
20098 "Cut region in table or cut current subtree.
20099 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20100 See the individual commands for more information."
20101 (interactive)
20102 (call-interactively
20103 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20105 (defun org-paste-special (arg)
20106 "Paste rectangular region into table, or past subtree relative to level.
20107 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20108 See the individual commands for more information."
20109 (interactive "P")
20110 (if (org-at-table-p)
20111 (org-table-paste-rectangle)
20112 (org-paste-subtree arg)))
20114 (defsubst org-in-fixed-width-region-p ()
20115 "Is point in a fixed-width region?"
20116 (save-match-data
20117 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20119 (defun org-edit-special (&optional arg)
20120 "Call a special editor for the element at point.
20121 When at a table, call the formula editor with `org-table-edit-formulas'.
20122 When in a source code block, call `org-edit-src-code'.
20123 When in a fixed-width region, call `org-edit-fixed-width-region'.
20124 When at an #+INCLUDE keyword, visit the included file.
20125 On a link, call `ffap' to visit the link at point.
20126 Otherwise, return a user error."
20127 (interactive "P")
20128 (let ((element (org-element-at-point)))
20129 (assert (not buffer-read-only) nil
20130 "Buffer is read-only: %s" (buffer-name))
20131 (case (org-element-type element)
20132 (src-block
20133 (if (not arg) (org-edit-src-code)
20134 (let* ((info (org-babel-get-src-block-info))
20135 (lang (nth 0 info))
20136 (params (nth 2 info))
20137 (session (cdr (assq :session params))))
20138 (if (not session) (org-edit-src-code)
20139 ;; At a src-block with a session and function called with
20140 ;; an ARG: switch to the buffer related to the inferior
20141 ;; process.
20142 (switch-to-buffer
20143 (funcall (intern (concat "org-babel-prep-session:" lang))
20144 session params))))))
20145 (keyword
20146 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20147 (find-file
20148 (org-remove-double-quotes
20149 (car (org-split-string (org-element-property :value element)))))
20150 (user-error "No special environment to edit here")))
20151 (table
20152 (if (eq (org-element-property :type element) 'table.el)
20153 (org-edit-src-code)
20154 (call-interactively 'org-table-edit-formulas)))
20155 ;; Only Org tables contain `table-row' type elements.
20156 (table-row (call-interactively 'org-table-edit-formulas))
20157 ((example-block export-block) (org-edit-src-code))
20158 (fixed-width (org-edit-fixed-width-region))
20159 (otherwise
20160 ;; No notable element at point. Though, we may be at a link,
20161 ;; which is an object. Thus, scan deeper.
20162 (if (eq (org-element-type (org-element-context element)) 'link)
20163 (call-interactively 'ffap)
20164 (user-error "No special environment to edit here"))))))
20166 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20167 (defun org-ctrl-c-ctrl-c (&optional arg)
20168 "Set tags in headline, or update according to changed information at point.
20170 This command does many different things, depending on context:
20172 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20173 this is what we do.
20175 - If the cursor is on a statistics cookie, update it.
20177 - If the cursor is in a headline, prompt for tags and insert them
20178 into the current line, aligned to `org-tags-column'. When called
20179 with prefix arg, realign all tags in the current buffer.
20181 - If the cursor is in one of the special #+KEYWORD lines, this
20182 triggers scanning the buffer for these lines and updating the
20183 information.
20185 - If the cursor is inside a table, realign the table. This command
20186 works even if the automatic table editor has been turned off.
20188 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20189 the entire table.
20191 - If the cursor is at a footnote reference or definition, jump to
20192 the corresponding definition or references, respectively.
20194 - If the cursor is a the beginning of a dynamic block, update it.
20196 - If the current buffer is a capture buffer, close note and file it.
20198 - If the cursor is on a <<<target>>>, update radio targets and
20199 corresponding links in this buffer.
20201 - If the cursor is on a numbered item in a plain list, renumber the
20202 ordered list.
20204 - If the cursor is on a checkbox, toggle it.
20206 - If the cursor is on a code block, evaluate it. The variable
20207 `org-confirm-babel-evaluate' can be used to control prompting
20208 before code block evaluation, by default every code block
20209 evaluation requires confirmation. Code block evaluation can be
20210 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20211 (interactive "P")
20212 (cond
20213 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20214 org-occur-highlights
20215 org-latex-fragment-image-overlays)
20216 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20217 (org-remove-occur-highlights)
20218 (org-remove-latex-fragment-image-overlays)
20219 (message "Temporary highlights/overlays removed from current buffer"))
20220 ((and (local-variable-p 'org-finish-function (current-buffer))
20221 (fboundp org-finish-function))
20222 (funcall org-finish-function))
20223 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20225 (let* ((context (org-element-context)) (type (org-element-type context)))
20226 ;; Test if point is within a blank line.
20227 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20228 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20229 (user-error "C-c C-c can do nothing useful at this location"))
20230 (case type
20231 ;; When at a link, act according to the parent instead.
20232 (link (setq context (org-element-property :parent context))
20233 (setq type (org-element-type context)))
20234 ;; Unsupported object types: check parent element instead.
20235 ((bold code entity export-snippet inline-babel-call inline-src-block
20236 italic latex-fragment line-break macro strike-through subscript
20237 superscript underline verbatim)
20238 (while (and (setq context (org-element-property :parent context))
20239 (not (memq (setq type (org-element-type context))
20240 '(paragraph verse-block)))))))
20241 ;; For convenience: at the first line of a paragraph on the
20242 ;; same line as an item, apply function on that item instead.
20243 (when (eq type 'paragraph)
20244 (let ((parent (org-element-property :parent context)))
20245 (when (and (eq (org-element-type parent) 'item)
20246 (= (point-at-bol) (org-element-property :begin parent)))
20247 (setq context parent type 'item))))
20248 ;; Act according to type of element or object at point.
20249 (case type
20250 (clock (org-clock-update-time-maybe))
20251 (dynamic-block
20252 (save-excursion
20253 (goto-char (org-element-property :post-affiliated context))
20254 (org-update-dblock)))
20255 (footnote-definition
20256 (goto-char (org-element-property :post-affiliated context))
20257 (call-interactively 'org-footnote-action))
20258 (footnote-reference (call-interactively 'org-footnote-action))
20259 ((headline inlinetask)
20260 (save-excursion (goto-char (org-element-property :begin context))
20261 (call-interactively 'org-set-tags)))
20262 (item
20263 ;; At an item: a double C-u set checkbox to "[-]"
20264 ;; unconditionally, whereas a single one will toggle its
20265 ;; presence. Without an universal argument, if the item
20266 ;; has a checkbox, toggle it. Otherwise repair the list.
20267 (let* ((box (org-element-property :checkbox context))
20268 (struct (org-element-property :structure context))
20269 (old-struct (copy-tree struct))
20270 (parents (org-list-parents-alist struct))
20271 (prevs (org-list-prevs-alist struct))
20272 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20273 (org-list-set-checkbox
20274 (org-element-property :begin context) struct
20275 (cond ((equal arg '(16)) "[-]")
20276 ((and (not box) (equal arg '(4))) "[ ]")
20277 ((or (not box) (equal arg '(4))) nil)
20278 ((eq box 'on) "[ ]")
20279 (t "[X]")))
20280 ;; Mimic `org-list-write-struct' but with grabbing
20281 ;; a return value from `org-list-struct-fix-box'.
20282 (org-list-struct-fix-ind struct parents 2)
20283 (org-list-struct-fix-item-end struct)
20284 (org-list-struct-fix-bul struct prevs)
20285 (org-list-struct-fix-ind struct parents)
20286 (let ((block-item
20287 (org-list-struct-fix-box struct parents prevs orderedp)))
20288 (if (and box (equal struct old-struct))
20289 (if (equal arg '(16))
20290 (message "Checkboxes already reset")
20291 (user-error "Cannot toggle this checkbox: %s"
20292 (if (eq box 'on)
20293 "all subitems checked"
20294 "unchecked subitems")))
20295 (org-list-struct-apply-struct struct old-struct)
20296 (org-update-checkbox-count-maybe))
20297 (when block-item
20298 (message "Checkboxes were removed due to empty box at line %d"
20299 (org-current-line block-item))))))
20300 (keyword
20301 (let ((org-inhibit-startup-visibility-stuff t)
20302 (org-startup-align-all-tables nil))
20303 (when (boundp 'org-table-coordinate-overlays)
20304 (mapc 'delete-overlay org-table-coordinate-overlays)
20305 (setq org-table-coordinate-overlays nil))
20306 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20307 (message "Local setup has been refreshed"))
20308 (plain-list
20309 ;; At a plain list, with a double C-u argument, set
20310 ;; checkboxes of each item to "[-]", whereas a single one
20311 ;; will toggle their presence according to the state of the
20312 ;; first item in the list. Without an argument, repair the
20313 ;; list.
20314 (let* ((begin (org-element-property :contents-begin context))
20315 (beginm (move-marker (make-marker) begin))
20316 (struct (org-element-property :structure context))
20317 (old-struct (copy-tree struct))
20318 (first-box (save-excursion
20319 (goto-char begin)
20320 (looking-at org-list-full-item-re)
20321 (match-string-no-properties 3)))
20322 (new-box (cond ((equal arg '(16)) "[-]")
20323 ((equal arg '(4)) (unless first-box "[ ]"))
20324 ((equal first-box "[X]") "[ ]")
20325 (t "[X]"))))
20326 (cond
20327 (arg
20328 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20329 (org-list-get-all-items
20330 begin struct (org-list-prevs-alist struct))))
20331 ((and first-box (eq (point) begin))
20332 ;; For convenience, when point is at bol on the first
20333 ;; item of the list and no argument is provided, simply
20334 ;; toggle checkbox of that item, if any.
20335 (org-list-set-checkbox begin struct new-box)))
20336 (org-list-write-struct
20337 struct (org-list-parents-alist struct) old-struct)
20338 (org-update-checkbox-count-maybe)
20339 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20340 ((property-drawer node-property)
20341 (call-interactively 'org-property-action))
20342 ((radio-target target)
20343 (call-interactively 'org-update-radio-target-regexp))
20344 (statistics-cookie
20345 (call-interactively 'org-update-statistics-cookies))
20346 ((table table-cell table-row)
20347 ;; At a table, recalculate every field and align it. Also
20348 ;; send the table if necessary. If the table has
20349 ;; a `table.el' type, just give up. At a table row or
20350 ;; cell, maybe recalculate line but always align table.
20351 (if (eq (org-element-property :type context) 'table.el)
20352 (message "Use C-c ' to edit table.el tables")
20353 (let ((org-enable-table-editor t))
20354 (if (or (eq type 'table)
20355 ;; Check if point is at a TBLFM line.
20356 (and (eq type 'table-row)
20357 (= (point) (org-element-property :end context))))
20358 (save-excursion
20359 (if (org-at-TBLFM-p)
20360 (progn (require 'org-table)
20361 (org-table-calc-current-TBLFM))
20362 (goto-char (org-element-property :contents-begin context))
20363 (org-call-with-arg 'org-table-recalculate (or arg t))
20364 (orgtbl-send-table 'maybe)))
20365 (org-table-maybe-eval-formula)
20366 (cond (arg (call-interactively 'org-table-recalculate))
20367 ((org-table-maybe-recalculate-line))
20368 (t (org-table-align)))))))
20369 (timestamp (org-timestamp-change 0 'day))
20370 (otherwise
20371 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20372 (user-error
20373 "C-c C-c can do nothing useful at this location")))))))))
20375 (defun org-mode-restart ()
20376 "Restart Org-mode, to scan again for special lines.
20377 Also updates the keyword regular expressions and file variables."
20378 (interactive)
20379 (funcall major-mode)
20380 (hack-local-variables)
20381 (message "%s restarted" major-mode))
20383 (defun org-kill-note-or-show-branches ()
20384 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20385 (interactive)
20386 (if (not org-finish-function)
20387 (progn
20388 (hide-subtree)
20389 (call-interactively 'show-branches))
20390 (let ((org-note-abort t))
20391 (funcall org-finish-function))))
20393 (defun org-open-line (n)
20394 "Insert a new row in tables, call `open-line' elsewhere.
20395 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20396 (interactive "*p")
20397 (cond
20398 ((not org-special-ctrl-o)
20399 (open-line n))
20400 ((org-at-table-p)
20401 (org-table-insert-row))
20403 (open-line n))))
20405 (defun org-return (&optional indent)
20406 "Goto next table row or insert a newline.
20407 Calls `org-table-next-row' or `newline', depending on context.
20408 See the individual commands for more information."
20409 (interactive)
20410 (let (org-ts-what)
20411 (cond
20412 ((or (bobp) (org-in-src-block-p))
20413 (if indent (newline-and-indent) (newline)))
20414 ((org-at-table-p)
20415 (org-table-justify-field-maybe)
20416 (call-interactively 'org-table-next-row))
20417 ;; when `newline-and-indent' is called within a list, make sure
20418 ;; text moved stays inside the item.
20419 ((and (org-in-item-p) indent)
20420 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20421 (progn
20422 (save-match-data (newline))
20423 (org-indent-line-to (length (match-string 0))))
20424 (let ((ind (org-get-indentation)))
20425 (newline)
20426 (if (org-looking-back org-list-end-re)
20427 (org-indent-line)
20428 (org-indent-line-to ind)))))
20429 ((and org-return-follows-link
20430 (org-at-timestamp-p t)
20431 (not (eq org-ts-what 'after)))
20432 (org-follow-timestamp-link))
20433 ((and org-return-follows-link
20434 (let ((tprop (get-text-property (point) 'face)))
20435 (or (eq tprop 'org-link)
20436 (and (listp tprop) (memq 'org-link tprop)))))
20437 (call-interactively 'org-open-at-point))
20438 ((and (org-at-heading-p)
20439 (looking-at
20440 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20441 (org-show-entry)
20442 (end-of-line 1)
20443 (newline))
20444 (t (if indent (newline-and-indent) (newline))))))
20446 (defun org-return-indent ()
20447 "Goto next table row or insert a newline and indent.
20448 Calls `org-table-next-row' or `newline-and-indent', depending on
20449 context. See the individual commands for more information."
20450 (interactive)
20451 (org-return t))
20453 (defun org-ctrl-c-star ()
20454 "Compute table, or change heading status of lines.
20455 Calls `org-table-recalculate' or `org-toggle-heading',
20456 depending on context."
20457 (interactive)
20458 (cond
20459 ((org-at-table-p)
20460 (call-interactively 'org-table-recalculate))
20462 ;; Convert all lines in region to list items
20463 (call-interactively 'org-toggle-heading))))
20465 (defun org-ctrl-c-minus ()
20466 "Insert separator line in table or modify bullet status of line.
20467 Also turns a plain line or a region of lines into list items.
20468 Calls `org-table-insert-hline', `org-toggle-item', or
20469 `org-cycle-list-bullet', depending on context."
20470 (interactive)
20471 (cond
20472 ((org-at-table-p)
20473 (call-interactively 'org-table-insert-hline))
20474 ((org-region-active-p)
20475 (call-interactively 'org-toggle-item))
20476 ((org-in-item-p)
20477 (call-interactively 'org-cycle-list-bullet))
20479 (call-interactively 'org-toggle-item))))
20481 (defun org-toggle-item (arg)
20482 "Convert headings or normal lines to items, items to normal lines.
20483 If there is no active region, only the current line is considered.
20485 If the first non blank line in the region is a headline, convert
20486 all headlines to items, shifting text accordingly.
20488 If it is an item, convert all items to normal lines.
20490 If it is normal text, change region into a list of items.
20491 With a prefix argument ARG, change the region in a single item."
20492 (interactive "P")
20493 (let ((shift-text
20494 (function
20495 ;; Shift text in current section to IND, from point to END.
20496 ;; The function leaves point to END line.
20497 (lambda (ind end)
20498 (let ((min-i 1000) (end (copy-marker end)))
20499 ;; First determine the minimum indentation (MIN-I) of
20500 ;; the text.
20501 (save-excursion
20502 (catch 'exit
20503 (while (< (point) end)
20504 (let ((i (org-get-indentation)))
20505 (cond
20506 ;; Skip blank lines and inline tasks.
20507 ((looking-at "^[ \t]*$"))
20508 ((looking-at org-outline-regexp-bol))
20509 ;; We can't find less than 0 indentation.
20510 ((zerop i) (throw 'exit (setq min-i 0)))
20511 ((< i min-i) (setq min-i i))))
20512 (forward-line))))
20513 ;; Then indent each line so that a line indented to
20514 ;; MIN-I becomes indented to IND. Ignore blank lines
20515 ;; and inline tasks in the process.
20516 (let ((delta (- ind min-i)))
20517 (while (< (point) end)
20518 (unless (or (looking-at "^[ \t]*$")
20519 (looking-at org-outline-regexp-bol))
20520 (org-indent-line-to (+ (org-get-indentation) delta)))
20521 (forward-line)))))))
20522 (skip-blanks
20523 (function
20524 ;; Return beginning of first non-blank line, starting from
20525 ;; line at POS.
20526 (lambda (pos)
20527 (save-excursion
20528 (goto-char pos)
20529 (skip-chars-forward " \r\t\n")
20530 (point-at-bol)))))
20531 beg end)
20532 ;; Determine boundaries of changes.
20533 (if (org-region-active-p)
20534 (setq beg (funcall skip-blanks (region-beginning))
20535 end (copy-marker (region-end)))
20536 (setq beg (funcall skip-blanks (point-at-bol))
20537 end (copy-marker (point-at-eol))))
20538 ;; Depending on the starting line, choose an action on the text
20539 ;; between BEG and END.
20540 (org-with-limited-levels
20541 (save-excursion
20542 (goto-char beg)
20543 (cond
20544 ;; Case 1. Start at an item: de-itemize. Note that it only
20545 ;; happens when a region is active: `org-ctrl-c-minus'
20546 ;; would call `org-cycle-list-bullet' otherwise.
20547 ((org-at-item-p)
20548 (while (< (point) end)
20549 (when (org-at-item-p)
20550 (skip-chars-forward " \t")
20551 (delete-region (point) (match-end 0)))
20552 (forward-line)))
20553 ;; Case 2. Start at an heading: convert to items.
20554 ((org-at-heading-p)
20555 (let* ((bul (org-list-bullet-string "-"))
20556 (bul-len (length bul))
20557 ;; Indentation of the first heading. It should be
20558 ;; relative to the indentation of its parent, if any.
20559 (start-ind (save-excursion
20560 (cond
20561 ((not org-adapt-indentation) 0)
20562 ((not (outline-previous-heading)) 0)
20563 (t (length (match-string 0))))))
20564 ;; Level of first heading. Further headings will be
20565 ;; compared to it to determine hierarchy in the list.
20566 (ref-level (org-reduced-level (org-outline-level))))
20567 (while (< (point) end)
20568 (let* ((level (org-reduced-level (org-outline-level)))
20569 (delta (max 0 (- level ref-level))))
20570 ;; If current headline is less indented than the first
20571 ;; one, set it as reference, in order to preserve
20572 ;; subtrees.
20573 (when (< level ref-level) (setq ref-level level))
20574 (replace-match bul t t)
20575 (org-indent-line-to (+ start-ind (* delta bul-len)))
20576 ;; Ensure all text down to END (or SECTION-END) belongs
20577 ;; to the newly created item.
20578 (let ((section-end (save-excursion
20579 (or (outline-next-heading) (point)))))
20580 (forward-line)
20581 (funcall shift-text
20582 (+ start-ind (* (1+ delta) bul-len))
20583 (min end section-end)))))))
20584 ;; Case 3. Normal line with ARG: make the first line of region
20585 ;; an item, and shift indentation of others lines to
20586 ;; set them as item's body.
20587 (arg (let* ((bul (org-list-bullet-string "-"))
20588 (bul-len (length bul))
20589 (ref-ind (org-get-indentation)))
20590 (skip-chars-forward " \t")
20591 (insert bul)
20592 (forward-line)
20593 (while (< (point) end)
20594 ;; Ensure that lines less indented than first one
20595 ;; still get included in item body.
20596 (funcall shift-text
20597 (+ ref-ind bul-len)
20598 (min end (save-excursion (or (outline-next-heading)
20599 (point)))))
20600 (forward-line))))
20601 ;; Case 4. Normal line without ARG: turn each non-item line
20602 ;; into an item.
20604 (while (< (point) end)
20605 (unless (or (org-at-heading-p) (org-at-item-p))
20606 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
20607 (replace-match
20608 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
20609 (forward-line))))))))
20611 (defun org-toggle-heading (&optional nstars)
20612 "Convert headings to normal text, or items or text to headings.
20613 If there is no active region, only convert the current line.
20615 With a \\[universal-argument] prefix, convert the whole list at
20616 point into heading.
20618 In a region:
20620 - If the first non blank line is a headline, remove the stars
20621 from all headlines in the region.
20623 - If it is a normal line, turn each and every normal line (i.e.,
20624 not an heading or an item) in the region into headings. If you
20625 want to convert only the first line of this region, use one
20626 universal prefix argument.
20628 - If it is a plain list item, turn all plain list items into headings.
20630 When converting a line into a heading, the number of stars is chosen
20631 such that the lines become children of the current entry. However,
20632 when a numeric prefix argument is given, its value determines the
20633 number of stars to add."
20634 (interactive "P")
20635 (let ((skip-blanks
20636 (function
20637 ;; Return beginning of first non-blank line, starting from
20638 ;; line at POS.
20639 (lambda (pos)
20640 (save-excursion
20641 (goto-char pos)
20642 (while (org-at-comment-p) (forward-line))
20643 (skip-chars-forward " \r\t\n")
20644 (point-at-bol)))))
20645 beg end toggled)
20646 ;; Determine boundaries of changes. If a universal prefix has
20647 ;; been given, put the list in a region. If region ends at a bol,
20648 ;; do not consider the last line to be in the region.
20650 (when (and current-prefix-arg (org-at-item-p))
20651 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20652 (org-mark-element))
20654 (if (org-region-active-p)
20655 (setq beg (funcall skip-blanks (region-beginning))
20656 end (copy-marker (save-excursion
20657 (goto-char (region-end))
20658 (if (bolp) (point) (point-at-eol)))))
20659 (setq beg (funcall skip-blanks (point-at-bol))
20660 end (copy-marker (point-at-eol))))
20661 ;; Ensure inline tasks don't count as headings.
20662 (org-with-limited-levels
20663 (save-excursion
20664 (goto-char beg)
20665 (cond
20666 ;; Case 1. Started at an heading: de-star headings.
20667 ((org-at-heading-p)
20668 (while (< (point) end)
20669 (when (org-at-heading-p t)
20670 (looking-at org-outline-regexp) (replace-match "")
20671 (setq toggled t))
20672 (forward-line)))
20673 ;; Case 2. Started at an item: change items into headlines.
20674 ;; One star will be added by `org-list-to-subtree'.
20675 ((org-at-item-p)
20676 (let* ((stars (make-string
20677 ;; subtract the star that will be added again by
20678 ;; `org-list-to-subtree'
20679 (if (numberp nstars) (1- nstars)
20680 (or (org-current-level) 0))
20681 ?*))
20682 (add-stars
20683 (cond (nstars "") ; stars from prefix only
20684 ((equal stars "") "") ; before first heading
20685 (org-odd-levels-only "*") ; inside heading, odd
20686 (t "")))) ; inside heading, oddeven
20687 (while (< (point) end)
20688 (when (org-at-item-p)
20689 ;; Pay attention to cases when region ends before list.
20690 (let* ((struct (org-list-struct))
20691 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20692 (save-restriction
20693 (narrow-to-region (point) list-end)
20694 (insert
20695 (org-list-to-subtree
20696 (org-list-parse-list t)
20697 '(:istart (concat stars add-stars (funcall get-stars depth))
20698 :icount (concat stars add-stars (funcall get-stars depth)))))))
20699 (setq toggled t))
20700 (forward-line))))
20701 ;; Case 3. Started at normal text: make every line an heading,
20702 ;; skipping headlines and items.
20703 (t (let* ((stars
20704 (make-string
20705 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20706 (add-stars
20707 (cond (nstars "") ; stars from prefix only
20708 ((equal stars "") "*") ; before first heading
20709 (org-odd-levels-only "**") ; inside heading, odd
20710 (t "*"))) ; inside heading, oddeven
20711 (rpl (concat stars add-stars " "))
20712 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20713 (while (< (point) (if (equal nstars '(4)) lend end))
20714 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20715 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
20716 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20717 (forward-line)))))))
20718 (unless toggled (message "Cannot toggle heading from here"))))
20720 (defun org-meta-return (&optional arg)
20721 "Insert a new heading or wrap a region in a table.
20722 Calls `org-insert-heading' or `org-table-wrap-region', depending
20723 on context. See the individual commands for more information."
20724 (interactive "P")
20725 (org-check-before-invisible-edit 'insert)
20726 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20727 (let* ((element (org-element-at-point))
20728 (type (org-element-type element)))
20729 (when (eq type 'table-row)
20730 (setq element (org-element-property :parent element))
20731 (setq type 'table))
20732 (if (and (eq type 'table)
20733 (eq (org-element-property :type element) 'org)
20734 (>= (point) (org-element-property :contents-begin element))
20735 (< (point) (org-element-property :contents-end element)))
20736 (call-interactively 'org-table-wrap-region)
20737 (call-interactively 'org-insert-heading)))))
20739 ;;; Menu entries
20741 (defsubst org-in-subtree-not-table-p ()
20742 "Are we in a subtree and not in a table?"
20743 (and (not (org-before-first-heading-p))
20744 (not (org-at-table-p))))
20746 ;; Define the Org-mode menus
20747 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20748 '("Tbl"
20749 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20750 ["Next Field" org-cycle (org-at-table-p)]
20751 ["Previous Field" org-shifttab (org-at-table-p)]
20752 ["Next Row" org-return (org-at-table-p)]
20753 "--"
20754 ["Blank Field" org-table-blank-field (org-at-table-p)]
20755 ["Edit Field" org-table-edit-field (org-at-table-p)]
20756 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20757 "--"
20758 ("Column"
20759 ["Move Column Left" org-metaleft (org-at-table-p)]
20760 ["Move Column Right" org-metaright (org-at-table-p)]
20761 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20762 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20763 ("Row"
20764 ["Move Row Up" org-metaup (org-at-table-p)]
20765 ["Move Row Down" org-metadown (org-at-table-p)]
20766 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20767 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20768 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20769 "--"
20770 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20771 ("Rectangle"
20772 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20773 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20774 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20775 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20776 "--"
20777 ("Calculate"
20778 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20779 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20780 ["Edit Formulas" org-edit-special (org-at-table-p)]
20781 "--"
20782 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20783 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20784 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20785 "--"
20786 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20787 "--"
20788 ["Sum Column/Rectangle" org-table-sum
20789 (or (org-at-table-p) (org-region-active-p))]
20790 ["Which Column?" org-table-current-column (org-at-table-p)])
20791 ["Debug Formulas"
20792 org-table-toggle-formula-debugger
20793 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20794 ["Show Col/Row Numbers"
20795 org-table-toggle-coordinate-overlays
20796 :style toggle
20797 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20798 "--"
20799 ["Create" org-table-create (and (not (org-at-table-p))
20800 org-enable-table-editor)]
20801 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20802 ["Import from File" org-table-import (not (org-at-table-p))]
20803 ["Export to File" org-table-export (org-at-table-p)]
20804 "--"
20805 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20807 (easy-menu-define org-org-menu org-mode-map "Org menu"
20808 '("Org"
20809 ("Show/Hide"
20810 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20811 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20812 ["Sparse Tree..." org-sparse-tree t]
20813 ["Reveal Context" org-reveal t]
20814 ["Show All" show-all t]
20815 "--"
20816 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20817 "--"
20818 ["New Heading" org-insert-heading t]
20819 ("Navigate Headings"
20820 ["Up" outline-up-heading t]
20821 ["Next" outline-next-visible-heading t]
20822 ["Previous" outline-previous-visible-heading t]
20823 ["Next Same Level" outline-forward-same-level t]
20824 ["Previous Same Level" outline-backward-same-level t]
20825 "--"
20826 ["Jump" org-goto t])
20827 ("Edit Structure"
20828 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20829 "--"
20830 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20831 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20832 "--"
20833 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20834 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20835 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20836 "--"
20837 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20838 "--"
20839 ["Copy visible text" org-copy-visible t]
20840 "--"
20841 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20842 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20843 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20844 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20845 "--"
20846 ["Sort Region/Children" org-sort t]
20847 "--"
20848 ["Convert to odd levels" org-convert-to-odd-levels t]
20849 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20850 ("Editing"
20851 ["Emphasis..." org-emphasize t]
20852 ["Edit Source Example" org-edit-special t]
20853 "--"
20854 ["Footnote new/jump" org-footnote-action t]
20855 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20856 ("Archive"
20857 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20858 "--"
20859 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20860 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20861 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20863 "--"
20864 ("Hyperlinks"
20865 ["Store Link (Global)" org-store-link t]
20866 ["Find existing link to here" org-occur-link-in-agenda-files t]
20867 ["Insert Link" org-insert-link t]
20868 ["Follow Link" org-open-at-point t]
20869 "--"
20870 ["Next link" org-next-link t]
20871 ["Previous link" org-previous-link t]
20872 "--"
20873 ["Descriptive Links"
20874 org-toggle-link-display
20875 :style radio
20876 :selected org-descriptive-links
20878 ["Literal Links"
20879 org-toggle-link-display
20880 :style radio
20881 :selected (not org-descriptive-links)])
20882 "--"
20883 ("TODO Lists"
20884 ["TODO/DONE/-" org-todo t]
20885 ("Select keyword"
20886 ["Next keyword" org-shiftright (org-at-heading-p)]
20887 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20888 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20889 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20890 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20891 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20892 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20893 "--"
20894 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20895 :selected org-enforce-todo-dependencies :style toggle :active t]
20896 "Settings for tree at point"
20897 ["Do Children sequentially" org-toggle-ordered-property :style radio
20898 :selected (org-entry-get nil "ORDERED")
20899 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20900 ["Do Children parallel" org-toggle-ordered-property :style radio
20901 :selected (not (org-entry-get nil "ORDERED"))
20902 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20903 "--"
20904 ["Set Priority" org-priority t]
20905 ["Priority Up" org-shiftup t]
20906 ["Priority Down" org-shiftdown t]
20907 "--"
20908 ["Get news from all feeds" org-feed-update-all t]
20909 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20910 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20911 ("TAGS and Properties"
20912 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20913 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20914 "--"
20915 ["Set property" org-set-property (not (org-before-first-heading-p))]
20916 ["Column view of properties" org-columns t]
20917 ["Insert Column View DBlock" org-insert-columns-dblock t])
20918 ("Dates and Scheduling"
20919 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20920 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20921 ("Change Date"
20922 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20923 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20924 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20925 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20926 ["Compute Time Range" org-evaluate-time-range t]
20927 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20928 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20929 "--"
20930 ["Custom time format" org-toggle-time-stamp-overlays
20931 :style radio :selected org-display-custom-times]
20932 "--"
20933 ["Goto Calendar" org-goto-calendar t]
20934 ["Date from Calendar" org-date-from-calendar t]
20935 "--"
20936 ["Start/Restart Timer" org-timer-start t]
20937 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20938 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20939 ["Insert Timer String" org-timer t]
20940 ["Insert Timer Item" org-timer-item t])
20941 ("Logging work"
20942 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20943 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20944 ["Clock out" org-clock-out t]
20945 ["Clock cancel" org-clock-cancel t]
20946 "--"
20947 ["Mark as default task" org-clock-mark-default-task t]
20948 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20949 ["Goto running clock" org-clock-goto t]
20950 "--"
20951 ["Display times" org-clock-display t]
20952 ["Create clock table" org-clock-report t]
20953 "--"
20954 ["Record DONE time"
20955 (progn (setq org-log-done (not org-log-done))
20956 (message "Switching to %s will %s record a timestamp"
20957 (car org-done-keywords)
20958 (if org-log-done "automatically" "not")))
20959 :style toggle :selected org-log-done])
20960 "--"
20961 ["Agenda Command..." org-agenda t]
20962 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20963 ("File List for Agenda")
20964 ("Special views current file"
20965 ["TODO Tree" org-show-todo-tree t]
20966 ["Check Deadlines" org-check-deadlines t]
20967 ["Timeline" org-timeline t]
20968 ["Tags/Property tree" org-match-sparse-tree t])
20969 "--"
20970 ["Export/Publish..." org-export-dispatch t]
20971 ("LaTeX"
20972 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20973 :selected org-cdlatex-mode]
20974 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20975 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20976 ["Modify math symbol" org-cdlatex-math-modify
20977 (org-inside-LaTeX-fragment-p)]
20978 ["Insert citation" org-reftex-citation t]
20979 "--"
20980 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20981 "--"
20982 ("MobileOrg"
20983 ["Push Files and Views" org-mobile-push t]
20984 ["Get Captured and Flagged" org-mobile-pull t]
20985 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20986 "--"
20987 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20988 "--"
20989 ("Documentation"
20990 ["Show Version" org-version t]
20991 ["Info Documentation" org-info t])
20992 ("Customize"
20993 ["Browse Org Group" org-customize t]
20994 "--"
20995 ["Expand This Menu" org-create-customize-menu
20996 (fboundp 'customize-menu-create)])
20997 ["Send bug report" org-submit-bug-report t]
20998 "--"
20999 ("Refresh/Reload"
21000 ["Refresh setup current buffer" org-mode-restart t]
21001 ["Reload Org (after update)" org-reload t]
21002 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21005 (defun org-info (&optional node)
21006 "Read documentation for Org-mode in the info system.
21007 With optional NODE, go directly to that node."
21008 (interactive)
21009 (info (format "(org)%s" (or node ""))))
21011 ;;;###autoload
21012 (defun org-submit-bug-report ()
21013 "Submit a bug report on Org-mode via mail.
21015 Don't hesitate to report any problems or inaccurate documentation.
21017 If you don't have setup sending mail from (X)Emacs, please copy the
21018 output buffer into your mail program, as it gives us important
21019 information about your Org-mode version and configuration."
21020 (interactive)
21021 (require 'reporter)
21022 (org-load-modules-maybe)
21023 (org-require-autoloaded-modules)
21024 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21025 (reporter-submit-bug-report
21026 "emacs-orgmode@gnu.org"
21027 (org-version nil 'full)
21028 (let (list)
21029 (save-window-excursion
21030 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21031 (delete-other-windows)
21032 (erase-buffer)
21033 (insert "You are about to submit a bug report to the Org-mode mailing list.
21035 We would like to add your full Org-mode and Outline configuration to the
21036 bug report. This greatly simplifies the work of the maintainer and
21037 other experts on the mailing list.
21039 HOWEVER, some variables you have customized may contain private
21040 information. The names of customers, colleagues, or friends, might
21041 appear in the form of file names, tags, todo states, or search strings.
21042 If you answer yes to the prompt, you might want to check and remove
21043 such private information before sending the email.")
21044 (add-text-properties (point-min) (point-max) '(face org-warning))
21045 (when (yes-or-no-p "Include your Org-mode configuration ")
21046 (mapatoms
21047 (lambda (v)
21048 (and (boundp v)
21049 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21050 (or (and (symbol-value v)
21051 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21052 (and
21053 (get v 'custom-type) (get v 'standard-value)
21054 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21055 (push v list)))))
21056 (kill-buffer (get-buffer "*Warn about privacy*"))
21057 list))
21058 nil nil
21059 "Remember to cover the basics, that is, what you expected to happen and
21060 what in fact did happen. You don't know how to make a good report? See
21062 http://orgmode.org/manual/Feedback.html#Feedback
21064 Your bug report will be posted to the Org-mode mailing list.
21065 ------------------------------------------------------------------------")
21066 (save-excursion
21067 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21068 (replace-match "\\1Bug: \\3 [\\2]")))))
21071 (defun org-install-agenda-files-menu ()
21072 (let ((bl (buffer-list)))
21073 (save-excursion
21074 (while bl
21075 (set-buffer (pop bl))
21076 (if (derived-mode-p 'org-mode) (setq bl nil)))
21077 (when (derived-mode-p 'org-mode)
21078 (easy-menu-change
21079 '("Org") "File List for Agenda"
21080 (append
21081 (list
21082 ["Edit File List" (org-edit-agenda-file-list) t]
21083 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21084 ["Remove Current File from List" org-remove-file t]
21085 ["Cycle through agenda files" org-cycle-agenda-files t]
21086 ["Occur in all agenda files" org-occur-in-agenda-files t]
21087 "--")
21088 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21090 ;;;; Documentation
21092 (defun org-require-autoloaded-modules ()
21093 (interactive)
21094 (mapc 'require
21095 '(org-agenda org-archive org-attach org-clock org-colview org-id
21096 org-table org-timer)))
21098 ;;;###autoload
21099 (defun org-reload (&optional uncompiled)
21100 "Reload all org lisp files.
21101 With prefix arg UNCOMPILED, load the uncompiled versions."
21102 (interactive "P")
21103 (require 'loadhist)
21104 (let* ((org-dir (org-find-library-dir "org"))
21105 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21106 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21107 (remove-re (mapconcat 'identity
21108 (mapcar (lambda (f) (concat "^" f "$"))
21109 (list (if (featurep 'xemacs)
21110 "org-colview"
21111 "org-colview-xemacs")
21112 "org" "org-loaddefs" "org-version"))
21113 "\\|"))
21114 (feats (delete-dups
21115 (mapcar 'file-name-sans-extension
21116 (mapcar 'file-name-nondirectory
21117 (delq nil
21118 (mapcar 'feature-file
21119 features))))))
21120 (lfeat (append
21121 (sort
21122 (setq feats
21123 (delq nil (mapcar
21124 (lambda (f)
21125 (if (and (string-match feature-re f)
21126 (not (string-match remove-re f)))
21127 f nil))
21128 feats)))
21129 'string-lessp)
21130 (list "org-version" "org")))
21131 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21132 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21133 load-uncore load-misses)
21134 (setq load-misses
21135 (delq 't
21136 (mapcar (lambda (f)
21137 (or (org-load-noerror-mustsuffix (concat org-dir f))
21138 (and (string= org-dir contrib-dir)
21139 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21140 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21141 (add-to-list 'load-uncore f 'append)
21144 lfeat)))
21145 (if load-uncore
21146 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21147 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21148 (if load-misses
21149 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21150 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21151 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21153 ;;;###autoload
21154 (defun org-customize ()
21155 "Call the customize function with org as argument."
21156 (interactive)
21157 (org-load-modules-maybe)
21158 (org-require-autoloaded-modules)
21159 (customize-browse 'org))
21161 (defun org-create-customize-menu ()
21162 "Create a full customization menu for Org-mode, insert it into the menu."
21163 (interactive)
21164 (org-load-modules-maybe)
21165 (org-require-autoloaded-modules)
21166 (if (fboundp 'customize-menu-create)
21167 (progn
21168 (easy-menu-change
21169 '("Org") "Customize"
21170 `(["Browse Org group" org-customize t]
21171 "--"
21172 ,(customize-menu-create 'org)
21173 ["Set" Custom-set t]
21174 ["Save" Custom-save t]
21175 ["Reset to Current" Custom-reset-current t]
21176 ["Reset to Saved" Custom-reset-saved t]
21177 ["Reset to Standard Settings" Custom-reset-standard t]))
21178 (message "\"Org\"-menu now contains full customization menu"))
21179 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21181 ;;;; Miscellaneous stuff
21183 ;;; Generally useful functions
21185 (defun org-get-at-bol (property)
21186 "Get text property PROPERTY at beginning of line."
21187 (get-text-property (point-at-bol) property))
21189 (defun org-find-text-property-in-string (prop s)
21190 "Return the first non-nil value of property PROP in string S."
21191 (or (get-text-property 0 prop s)
21192 (get-text-property (or (next-single-property-change 0 prop s) 0)
21193 prop s)))
21195 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21196 "Display the given MESSAGE as a warning."
21197 (if (fboundp 'display-warning)
21198 (display-warning 'org message
21199 (if (featurep 'xemacs) 'warning :warning))
21200 (let ((buf (get-buffer-create "*Org warnings*")))
21201 (with-current-buffer buf
21202 (goto-char (point-max))
21203 (insert "Warning (Org): " message)
21204 (unless (bolp)
21205 (newline)))
21206 (display-buffer buf)
21207 (sit-for 0))))
21209 (defun org-eval (form)
21210 "Eval FORM and return result."
21211 (condition-case error
21212 (eval form)
21213 (error (format "%%![Error: %s]" error))))
21215 (defun org-in-clocktable-p ()
21216 "Check if the cursor is in a clocktable."
21217 (let ((pos (point)) start)
21218 (save-excursion
21219 (end-of-line 1)
21220 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21221 (setq start (match-beginning 0))
21222 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21223 (>= (match-end 0) pos)
21224 start))))
21226 (defun org-in-commented-line ()
21227 "Is point in a line starting with `#'?"
21228 (equal (char-after (point-at-bol)) ?#))
21230 (defun org-in-indented-comment-line ()
21231 "Is point in a line starting with `#' after some white space?"
21232 (save-excursion
21233 (save-match-data
21234 (goto-char (point-at-bol))
21235 (looking-at "[ \t]*#"))))
21237 (defun org-in-verbatim-emphasis ()
21238 (save-match-data
21239 (and (org-in-regexp org-emph-re 2)
21240 (>= (point) (match-beginning 3))
21241 (<= (point) (match-end 4))
21242 (member (match-string 3) '("=" "~")))))
21244 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21245 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21246 (if (and marker (marker-buffer marker)
21247 (buffer-live-p (marker-buffer marker)))
21248 (progn
21249 (org-pop-to-buffer-same-window (marker-buffer marker))
21250 (if (or (> marker (point-max)) (< marker (point-min)))
21251 (widen))
21252 (goto-char marker)
21253 (org-show-context 'org-goto))
21254 (if bookmark
21255 (bookmark-jump bookmark)
21256 (error "Cannot find location"))))
21258 (defun org-quote-csv-field (s)
21259 "Quote field for inclusion in CSV material."
21260 (if (string-match "[\",]" s)
21261 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21264 (defun org-force-self-insert (N)
21265 "Needed to enforce self-insert under remapping."
21266 (interactive "p")
21267 (self-insert-command N))
21269 (defun org-string-width (s)
21270 "Compute width of string, ignoring invisible characters.
21271 This ignores character with invisibility property `org-link', and also
21272 characters with property `org-cwidth', because these will become invisible
21273 upon the next fontification round."
21274 (let (b l)
21275 (when (or (eq t buffer-invisibility-spec)
21276 (assq 'org-link buffer-invisibility-spec))
21277 (while (setq b (text-property-any 0 (length s)
21278 'invisible 'org-link s))
21279 (setq s (concat (substring s 0 b)
21280 (substring s (or (next-single-property-change
21281 b 'invisible s) (length s)))))))
21282 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21283 (setq s (concat (substring s 0 b)
21284 (substring s (or (next-single-property-change
21285 b 'org-cwidth s) (length s))))))
21286 (setq l (string-width s) b -1)
21287 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21288 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21291 (defun org-shorten-string (s maxlength)
21292 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21293 If the string is shorter or has length MAXLENGTH, just return the
21294 original string. If it is longer, the functions finds a space in the
21295 string, breaks this string off at that locations and adds three dots
21296 as ellipsis. Including the ellipsis, the string will not be longer
21297 than MAXLENGTH. If finding a good breaking point in the string does
21298 not work, the string is just chopped off in the middle of a word
21299 if necessary."
21300 (if (<= (length s) maxlength)
21302 (let* ((n (max (- maxlength 4) 1))
21303 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21304 (if (string-match re s)
21305 (concat (match-string 1 s) "...")
21306 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21308 (defun org-get-indentation (&optional line)
21309 "Get the indentation of the current line, interpreting tabs.
21310 When LINE is given, assume it represents a line and compute its indentation."
21311 (if line
21312 (if (string-match "^ *" (org-remove-tabs line))
21313 (match-end 0))
21314 (save-excursion
21315 (beginning-of-line 1)
21316 (skip-chars-forward " \t")
21317 (current-column))))
21319 (defun org-get-string-indentation (s)
21320 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21321 (let ((n -1) (i 0) (w tab-width) c)
21322 (catch 'exit
21323 (while (< (setq n (1+ n)) (length s))
21324 (setq c (aref s n))
21325 (cond ((= c ?\ ) (setq i (1+ i)))
21326 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21327 (t (throw 'exit t)))))
21330 (defun org-remove-tabs (s &optional width)
21331 "Replace tabulators in S with spaces.
21332 Assumes that s is a single line, starting in column 0."
21333 (setq width (or width tab-width))
21334 (while (string-match "\t" s)
21335 (setq s (replace-match
21336 (make-string
21337 (- (* width (/ (+ (match-beginning 0) width) width))
21338 (match-beginning 0)) ?\ )
21339 t t s)))
21342 (defun org-fix-indentation (line ind)
21343 "Fix indentation in LINE.
21344 IND is a cons cell with target and minimum indentation.
21345 If the current indentation in LINE is smaller than the minimum,
21346 leave it alone. If it is larger than ind, set it to the target."
21347 (let* ((l (org-remove-tabs line))
21348 (i (org-get-indentation l))
21349 (i1 (car ind)) (i2 (cdr ind)))
21350 (if (>= i i2) (setq l (substring line i2)))
21351 (if (> i1 0)
21352 (concat (make-string i1 ?\ ) l)
21353 l)))
21355 (defun org-remove-indentation (code &optional n)
21356 "Remove the maximum common indentation from the lines in CODE.
21357 N may optionally be the number of spaces to remove."
21358 (with-temp-buffer
21359 (insert code)
21360 (org-do-remove-indentation n)
21361 (buffer-string)))
21363 (defun org-do-remove-indentation (&optional n)
21364 "Remove the maximum common indentation from the buffer."
21365 (untabify (point-min) (point-max))
21366 (let ((min 10000) re)
21367 (if n
21368 (setq min n)
21369 (goto-char (point-min))
21370 (while (re-search-forward "^ *[^ \n]" nil t)
21371 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21372 (unless (or (= min 0) (= min 10000))
21373 (setq re (format "^ \\{%d\\}" min))
21374 (goto-char (point-min))
21375 (while (re-search-forward re nil t)
21376 (replace-match "")
21377 (end-of-line 1))
21378 min)))
21380 (defun org-fill-template (template alist)
21381 "Find each %key of ALIST in TEMPLATE and replace it."
21382 (let ((case-fold-search nil)
21383 entry key value)
21384 (setq alist (sort (copy-sequence alist)
21385 (lambda (a b) (< (length (car a)) (length (car b))))))
21386 (while (setq entry (pop alist))
21387 (setq template
21388 (replace-regexp-in-string
21389 (concat "%" (regexp-quote (car entry)))
21390 (or (cdr entry) "") template t t)))
21391 template))
21393 (defun org-base-buffer (buffer)
21394 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21395 (if (not buffer)
21396 buffer
21397 (or (buffer-base-buffer buffer)
21398 buffer)))
21400 (defun org-trim (s)
21401 "Remove whitespace at beginning and end of string."
21402 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
21403 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
21406 (defun org-wrap (string &optional width lines)
21407 "Wrap string to either a number of lines, or a width in characters.
21408 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21409 that costs. If there is a word longer than WIDTH, the text is actually
21410 wrapped to the length of that word.
21411 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21412 many lines, whatever width that takes.
21413 The return value is a list of lines, without newlines at the end."
21414 (let* ((words (org-split-string string "[ \t\n]+"))
21415 (maxword (apply 'max (mapcar 'org-string-width words)))
21416 w ll)
21417 (cond (width
21418 (org-do-wrap words (max maxword width)))
21419 (lines
21420 (setq w maxword)
21421 (setq ll (org-do-wrap words maxword))
21422 (if (<= (length ll) lines)
21424 (setq ll words)
21425 (while (> (length ll) lines)
21426 (setq w (1+ w))
21427 (setq ll (org-do-wrap words w)))
21428 ll))
21429 (t (error "Cannot wrap this")))))
21431 (defun org-do-wrap (words width)
21432 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21433 (let (lines line)
21434 (while words
21435 (setq line (pop words))
21436 (while (and words (< (+ (length line) (length (car words))) width))
21437 (setq line (concat line " " (pop words))))
21438 (setq lines (push line lines)))
21439 (nreverse lines)))
21441 (defun org-split-string (string &optional separators)
21442 "Splits STRING into substrings at SEPARATORS.
21443 No empty strings are returned if there are matches at the beginning
21444 and end of string."
21445 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21446 (start 0)
21447 notfirst
21448 (list nil))
21449 (while (and (string-match rexp string
21450 (if (and notfirst
21451 (= start (match-beginning 0))
21452 (< start (length string)))
21453 (1+ start) start))
21454 (< (match-beginning 0) (length string)))
21455 (setq notfirst t)
21456 (or (eq (match-beginning 0) 0)
21457 (and (eq (match-beginning 0) (match-end 0))
21458 (eq (match-beginning 0) start))
21459 (setq list
21460 (cons (substring string start (match-beginning 0))
21461 list)))
21462 (setq start (match-end 0)))
21463 (or (eq start (length string))
21464 (setq list
21465 (cons (substring string start)
21466 list)))
21467 (nreverse list)))
21469 (defun org-quote-vert (s)
21470 "Replace \"|\" with \"\\vert\"."
21471 (while (string-match "|" s)
21472 (setq s (replace-match "\\vert" t t s)))
21475 (defun org-uuidgen-p (s)
21476 "Is S an ID created by UUIDGEN?"
21477 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21479 (defun org-in-src-block-p (&optional inside)
21480 "Whether point is in a code source block.
21481 When INSIDE is non-nil, don't consider we are within a src block
21482 when point is at #+BEGIN_SRC or #+END_SRC."
21483 (let ((case-fold-search t) ov)
21484 (or (and (setq ov (overlays-at (point)))
21485 (memq 'org-block-background
21486 (overlay-properties (car ov))))
21487 (and (not inside)
21488 (save-match-data
21489 (save-excursion
21490 (beginning-of-line)
21491 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21493 (defun org-context ()
21494 "Return a list of contexts of the current cursor position.
21495 If several contexts apply, all are returned.
21496 Each context entry is a list with a symbol naming the context, and
21497 two positions indicating start and end of the context. Possible
21498 contexts are:
21500 :headline anywhere in a headline
21501 :headline-stars on the leading stars in a headline
21502 :todo-keyword on a TODO keyword (including DONE) in a headline
21503 :tags on the TAGS in a headline
21504 :priority on the priority cookie in a headline
21505 :item on the first line of a plain list item
21506 :item-bullet on the bullet/number of a plain list item
21507 :checkbox on the checkbox in a plain list item
21508 :table in an org-mode table
21509 :table-special on a special filed in a table
21510 :table-table in a table.el table
21511 :clocktable in a clocktable
21512 :src-block in a source block
21513 :link on a hyperlink
21514 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21515 :target on a <<target>>
21516 :radio-target on a <<<radio-target>>>
21517 :latex-fragment on a LaTeX fragment
21518 :latex-preview on a LaTeX fragment with overlaid preview image
21520 This function expects the position to be visible because it uses font-lock
21521 faces as a help to recognize the following contexts: :table-special, :link,
21522 and :keyword."
21523 (let* ((f (get-text-property (point) 'face))
21524 (faces (if (listp f) f (list f)))
21525 (case-fold-search t)
21526 (p (point)) clist o)
21527 ;; First the large context
21528 (cond
21529 ((org-at-heading-p t)
21530 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21531 (when (progn
21532 (beginning-of-line 1)
21533 (looking-at org-todo-line-tags-regexp))
21534 (push (org-point-in-group p 1 :headline-stars) clist)
21535 (push (org-point-in-group p 2 :todo-keyword) clist)
21536 (push (org-point-in-group p 4 :tags) clist))
21537 (goto-char p)
21538 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21539 (if (looking-at "\\[#[A-Z0-9]\\]")
21540 (push (org-point-in-group p 0 :priority) clist)))
21542 ((org-at-item-p)
21543 (push (org-point-in-group p 2 :item-bullet) clist)
21544 (push (list :item (point-at-bol)
21545 (save-excursion (org-end-of-item) (point)))
21546 clist)
21547 (and (org-at-item-checkbox-p)
21548 (push (org-point-in-group p 0 :checkbox) clist)))
21550 ((org-at-table-p)
21551 (push (list :table (org-table-begin) (org-table-end)) clist)
21552 (if (memq 'org-formula faces)
21553 (push (list :table-special
21554 (previous-single-property-change p 'face)
21555 (next-single-property-change p 'face)) clist)))
21556 ((org-at-table-p 'any)
21557 (push (list :table-table) clist)))
21558 (goto-char p)
21560 (let ((case-fold-search t))
21561 ;; New the "medium" contexts: clocktables, source blocks
21562 (cond ((org-in-clocktable-p)
21563 (push (list :clocktable
21564 (and (or (looking-at "#\\+BEGIN: clocktable")
21565 (search-backward "#+BEGIN: clocktable" nil t))
21566 (match-beginning 0))
21567 (and (re-search-forward "#\\+END:?" nil t)
21568 (match-end 0))) clist))
21569 ((org-in-src-block-p)
21570 (push (list :src-block
21571 (and (or (looking-at "#\\+BEGIN_SRC")
21572 (search-backward "#+BEGIN_SRC" nil t))
21573 (match-beginning 0))
21574 (and (search-forward "#+END_SRC" nil t)
21575 (match-beginning 0))) clist))))
21576 (goto-char p)
21578 ;; Now the small context
21579 (cond
21580 ((org-at-timestamp-p)
21581 (push (org-point-in-group p 0 :timestamp) clist))
21582 ((memq 'org-link faces)
21583 (push (list :link
21584 (previous-single-property-change p 'face)
21585 (next-single-property-change p 'face)) clist))
21586 ((memq 'org-special-keyword faces)
21587 (push (list :keyword
21588 (previous-single-property-change p 'face)
21589 (next-single-property-change p 'face)) clist))
21590 ((org-at-target-p)
21591 (push (org-point-in-group p 0 :target) clist)
21592 (goto-char (1- (match-beginning 0)))
21593 (if (looking-at org-radio-target-regexp)
21594 (push (org-point-in-group p 0 :radio-target) clist))
21595 (goto-char p))
21596 ((setq o (car (delq nil
21597 (mapcar
21598 (lambda (x)
21599 (if (memq x org-latex-fragment-image-overlays) x))
21600 (overlays-at (point))))))
21601 (push (list :latex-fragment
21602 (overlay-start o) (overlay-end o)) clist)
21603 (push (list :latex-preview
21604 (overlay-start o) (overlay-end o)) clist))
21605 ((org-inside-LaTeX-fragment-p)
21606 ;; FIXME: positions wrong.
21607 (push (list :latex-fragment (point) (point)) clist)))
21609 (setq clist (nreverse (delq nil clist)))
21610 clist))
21612 ;; FIXME: Compare with at-regexp-p Do we need both?
21613 (defun org-in-regexp (re &optional nlines visually)
21614 "Check if point is inside a match of regexp.
21615 Normally only the current line is checked, but you can include NLINES extra
21616 lines both before and after point into the search.
21617 If VISUALLY is set, require that the cursor is not after the match but
21618 really on, so that the block visually is on the match."
21619 (catch 'exit
21620 (let ((pos (point))
21621 (eol (point-at-eol (+ 1 (or nlines 0))))
21622 (inc (if visually 1 0)))
21623 (save-excursion
21624 (beginning-of-line (- 1 (or nlines 0)))
21625 (while (re-search-forward re eol t)
21626 (if (and (<= (match-beginning 0) pos)
21627 (>= (+ inc (match-end 0)) pos))
21628 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21630 (defun org-at-regexp-p (regexp)
21631 "Is point inside a match of REGEXP in the current line?"
21632 (catch 'exit
21633 (save-excursion
21634 (let ((pos (point)) (end (point-at-eol)))
21635 (beginning-of-line 1)
21636 (while (re-search-forward regexp end t)
21637 (if (and (<= (match-beginning 0) pos)
21638 (>= (match-end 0) pos))
21639 (throw 'exit t)))
21640 nil))))
21642 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21643 "Non-nil when point is between matches of START-RE and END-RE.
21645 Also return a non-nil value when point is on one of the matches.
21647 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21648 buffer positions. Default values are the positions of headlines
21649 surrounding the point.
21651 The functions returns a cons cell whose car (resp. cdr) is the
21652 position before START-RE (resp. after END-RE)."
21653 (save-match-data
21654 (let ((pos (point))
21655 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21656 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21657 beg end)
21658 (save-excursion
21659 ;; Point is on a block when on START-RE or if START-RE can be
21660 ;; found before it...
21661 (and (or (org-at-regexp-p start-re)
21662 (re-search-backward start-re limit-up t))
21663 (setq beg (match-beginning 0))
21664 ;; ... and END-RE after it...
21665 (goto-char (match-end 0))
21666 (re-search-forward end-re limit-down t)
21667 (> (setq end (match-end 0)) pos)
21668 ;; ... without another START-RE in-between.
21669 (goto-char (match-beginning 0))
21670 (not (re-search-backward start-re (1+ beg) t))
21671 ;; Return value.
21672 (cons beg end))))))
21674 (defun org-in-block-p (names)
21675 "Non-nil when point belongs to a block whose name belongs to NAMES.
21677 NAMES is a list of strings containing names of blocks.
21679 Return first block name matched, or nil. Beware that in case of
21680 nested blocks, the returned name may not belong to the closest
21681 block from point."
21682 (save-match-data
21683 (catch 'exit
21684 (let ((case-fold-search t)
21685 (lim-up (save-excursion (outline-previous-heading)))
21686 (lim-down (save-excursion (outline-next-heading))))
21687 (mapc (lambda (name)
21688 (let ((n (regexp-quote name)))
21689 (when (org-between-regexps-p
21690 (concat "^[ \t]*#\\+begin_" n)
21691 (concat "^[ \t]*#\\+end_" n)
21692 lim-up lim-down)
21693 (throw 'exit n))))
21694 names))
21695 nil)))
21697 (defun org-in-drawer-p ()
21698 "Is point within a drawer?"
21699 (save-match-data
21700 (let ((case-fold-search t)
21701 (lim-up (save-excursion (outline-previous-heading)))
21702 (lim-down (save-excursion (outline-next-heading))))
21703 (org-between-regexps-p
21704 (concat "^[ \t]*:" (regexp-opt org-drawers) ":")
21705 "^[ \t]*:end:.*$"
21706 lim-up lim-down))))
21708 (defun org-occur-in-agenda-files (regexp &optional nlines)
21709 "Call `multi-occur' with buffers for all agenda files."
21710 (interactive "sOrg-files matching: \np")
21711 (let* ((files (org-agenda-files))
21712 (tnames (mapcar 'file-truename files))
21713 (extra org-agenda-text-search-extra-files)
21715 (when (eq (car extra) 'agenda-archives)
21716 (setq extra (cdr extra))
21717 (setq files (org-add-archive-files files)))
21718 (while (setq f (pop extra))
21719 (unless (member (file-truename f) tnames)
21720 (add-to-list 'files f 'append)
21721 (add-to-list 'tnames (file-truename f) 'append)))
21722 (multi-occur
21723 (mapcar (lambda (x)
21724 (with-current-buffer
21725 (or (get-file-buffer x) (find-file-noselect x))
21726 (widen)
21727 (current-buffer)))
21728 files)
21729 regexp)))
21731 (if (boundp 'occur-mode-find-occurrence-hook)
21732 ;; Emacs 23
21733 (add-hook 'occur-mode-find-occurrence-hook
21734 (lambda ()
21735 (when (derived-mode-p 'org-mode)
21736 (org-reveal))))
21737 ;; Emacs 22
21738 (defadvice occur-mode-goto-occurrence
21739 (after org-occur-reveal activate)
21740 (and (derived-mode-p 'org-mode) (org-reveal)))
21741 (defadvice occur-mode-goto-occurrence-other-window
21742 (after org-occur-reveal activate)
21743 (and (derived-mode-p 'org-mode) (org-reveal)))
21744 (defadvice occur-mode-display-occurrence
21745 (after org-occur-reveal activate)
21746 (when (derived-mode-p 'org-mode)
21747 (let ((pos (occur-mode-find-occurrence)))
21748 (with-current-buffer (marker-buffer pos)
21749 (save-excursion
21750 (goto-char pos)
21751 (org-reveal)))))))
21753 (defun org-occur-link-in-agenda-files ()
21754 "Create a link and search for it in the agendas.
21755 The link is not stored in `org-stored-links', it is just created
21756 for the search purpose."
21757 (interactive)
21758 (let ((link (condition-case nil
21759 (org-store-link nil)
21760 (error "Unable to create a link to here"))))
21761 (org-occur-in-agenda-files (regexp-quote link))))
21763 (defun org-reverse-string (string)
21764 "Return the reverse of STRING."
21765 (apply 'string (reverse (string-to-list string))))
21767 (defsubst org-uniquify (list)
21768 "Non-destructively remove duplicate elements from LIST."
21769 (let ((res (copy-sequence list))) (delete-dups res)))
21771 (defun org-uniquify-alist (alist)
21772 "Merge elements of ALIST with the same key.
21774 For example, in this alist:
21776 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21777 => '((a 1 3) (b 2))
21779 merge (a 1) and (a 3) into (a 1 3).
21781 The function returns the new ALIST."
21782 (let (rtn)
21783 (mapc
21784 (lambda (e)
21785 (let (n)
21786 (if (not (assoc (car e) rtn))
21787 (push e rtn)
21788 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21789 (setq rtn (assq-delete-all (car e) rtn))
21790 (push n rtn))))
21791 alist)
21792 rtn))
21794 (defun org-delete-all (elts list)
21795 "Remove all elements in ELTS from LIST."
21796 (while elts
21797 (setq list (delete (pop elts) list)))
21798 list)
21800 (defun org-count (cl-item cl-seq)
21801 "Count the number of occurrences of ITEM in SEQ.
21802 Taken from `count' in cl-seq.el with all keyword arguments removed."
21803 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21804 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21805 (while (< cl-start cl-end)
21806 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21807 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21808 (setq cl-start (1+ cl-start)))
21809 cl-count))
21811 (defun org-remove-if (predicate seq)
21812 "Remove everything from SEQ that fulfills PREDICATE."
21813 (let (res e)
21814 (while seq
21815 (setq e (pop seq))
21816 (if (not (funcall predicate e)) (push e res)))
21817 (nreverse res)))
21819 (defun org-remove-if-not (predicate seq)
21820 "Remove everything from SEQ that does not fulfill PREDICATE."
21821 (let (res e)
21822 (while seq
21823 (setq e (pop seq))
21824 (if (funcall predicate e) (push e res)))
21825 (nreverse res)))
21827 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21828 "Reduce two-argument FUNCTION across SEQ.
21829 Taken from `reduce' in cl-seq.el with all keyword arguments but
21830 \":initial-value\" removed."
21831 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21832 (cadr (memq :initial-value cl-keys)))
21833 (cl-seq (pop cl-seq))
21834 (t (funcall cl-func)))))
21835 (while cl-seq
21836 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21837 cl-accum))
21839 (defun org-every (pred seq)
21840 "Return true if PREDICATE is true of every element of SEQ.
21841 Adapted from `every' in cl.el."
21842 (catch 'org-every
21843 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21846 (defun org-some (pred seq)
21847 "Return true if PREDICATE is true of any element of SEQ.
21848 Adapted from `some' in cl.el."
21849 (catch 'org-some
21850 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21851 nil))
21853 (defun org-back-over-empty-lines ()
21854 "Move backwards over whitespace, to the beginning of the first empty line.
21855 Returns the number of empty lines passed."
21856 (let ((pos (point)))
21857 (if (cdr (assoc 'heading org-blank-before-new-entry))
21858 (skip-chars-backward " \t\n\r")
21859 (unless (eobp)
21860 (forward-line -1)))
21861 (beginning-of-line 2)
21862 (goto-char (min (point) pos))
21863 (count-lines (point) pos)))
21865 (defun org-skip-whitespace ()
21866 (skip-chars-forward " \t\n\r"))
21868 (defun org-point-in-group (point group &optional context)
21869 "Check if POINT is in match-group GROUP.
21870 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21871 match. If the match group does not exist or point is not inside it,
21872 return nil."
21873 (and (match-beginning group)
21874 (>= point (match-beginning group))
21875 (<= point (match-end group))
21876 (if context
21877 (list context (match-beginning group) (match-end group))
21878 t)))
21880 (defun org-switch-to-buffer-other-window (&rest args)
21881 "Switch to buffer in a second window on the current frame.
21882 In particular, do not allow pop-up frames.
21883 Returns the newly created buffer."
21884 (org-no-popups
21885 (apply 'switch-to-buffer-other-window args)))
21887 (defun org-combine-plists (&rest plists)
21888 "Create a single property list from all plists in PLISTS.
21889 The process starts by copying the first list, and then setting properties
21890 from the other lists. Settings in the last list are the most significant
21891 ones and overrule settings in the other lists."
21892 (let ((rtn (copy-sequence (pop plists)))
21893 p v ls)
21894 (while plists
21895 (setq ls (pop plists))
21896 (while ls
21897 (setq p (pop ls) v (pop ls))
21898 (setq rtn (plist-put rtn p v))))
21899 rtn))
21901 (defun org-replace-escapes (string table)
21902 "Replace %-escapes in STRING with values in TABLE.
21903 TABLE is an association list with keys like \"%a\" and string values.
21904 The sequences in STRING may contain normal field width and padding information,
21905 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
21906 so values can contain further %-escapes if they are define later in TABLE."
21907 (let ((tbl (copy-alist table))
21908 (case-fold-search nil)
21909 (pchg 0)
21910 e re rpl)
21911 (while (setq e (pop tbl))
21912 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21913 (when (and (cdr e) (string-match re (cdr e)))
21914 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21915 (safe "SREF"))
21916 (add-text-properties 0 3 (list 'sref sref) safe)
21917 (setcdr e (replace-match safe t t (cdr e)))))
21918 (while (string-match re string)
21919 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21920 (cdr e)))
21921 (setq string (replace-match rpl t t string))))
21922 (while (setq pchg (next-property-change pchg string))
21923 (let ((sref (get-text-property pchg 'sref string)))
21924 (when (and sref (string-match "SREF" string pchg))
21925 (setq string (replace-match sref t t string)))))
21926 string))
21928 (defun org-sublist (list start end)
21929 "Return a section of LIST, from START to END.
21930 Counting starts at 1."
21931 (let (rtn (c start))
21932 (setq list (nthcdr (1- start) list))
21933 (while (and list (<= c end))
21934 (push (pop list) rtn)
21935 (setq c (1+ c)))
21936 (nreverse rtn)))
21938 (defun org-find-base-buffer-visiting (file)
21939 "Like `find-buffer-visiting' but always return the base buffer and
21940 not an indirect buffer."
21941 (let ((buf (or (get-file-buffer file)
21942 (find-buffer-visiting file))))
21943 (if buf
21944 (or (buffer-base-buffer buf) buf)
21945 nil)))
21947 (defun org-image-file-name-regexp (&optional extensions)
21948 "Return regexp matching the file names of images.
21949 If EXTENSIONS is given, only match these."
21950 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21951 (image-file-name-regexp)
21952 (let ((image-file-name-extensions
21953 (or extensions
21954 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21955 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21956 (concat "\\."
21957 (regexp-opt (nconc (mapcar 'upcase
21958 image-file-name-extensions)
21959 image-file-name-extensions)
21961 "\\'"))))
21963 (defun org-file-image-p (file &optional extensions)
21964 "Return non-nil if FILE is an image."
21965 (save-match-data
21966 (string-match (org-image-file-name-regexp extensions) file)))
21968 (defun org-get-cursor-date (&optional with-time)
21969 "Return the date at cursor in as a time.
21970 This works in the calendar and in the agenda, anywhere else it just
21971 returns the current time.
21972 If WITH-TIME is non-nil, returns the time of the event at point (in
21973 the agenda) or the current time of the day."
21974 (let (date day defd tp tm hod mod)
21975 (when with-time
21976 (setq tp (get-text-property (point) 'time))
21977 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
21978 (setq hod (string-to-number (match-string 1 tp))
21979 mod (string-to-number (match-string 2 tp))))
21980 (or tp (setq hod (nth 2 (decode-time (current-time)))
21981 mod (nth 1 (decode-time (current-time))))))
21982 (cond
21983 ((eq major-mode 'calendar-mode)
21984 (setq date (calendar-cursor-to-date)
21985 defd (encode-time 0 (or mod 0) (or hod 0)
21986 (nth 1 date) (nth 0 date) (nth 2 date))))
21987 ((eq major-mode 'org-agenda-mode)
21988 (setq day (get-text-property (point) 'day))
21989 (if day
21990 (setq date (calendar-gregorian-from-absolute day)
21991 defd (encode-time 0 (or mod 0) (or hod 0)
21992 (nth 1 date) (nth 0 date) (nth 2 date))))))
21993 (or defd (current-time))))
21995 (defun org-mark-subtree (&optional up)
21996 "Mark the current subtree.
21997 This puts point at the start of the current subtree, and mark at
21998 the end. If a numeric prefix UP is given, move up into the
21999 hierarchy of headlines by UP levels before marking the subtree."
22000 (interactive "P")
22001 (org-with-limited-levels
22002 (cond ((org-at-heading-p) (beginning-of-line))
22003 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22004 (t (outline-previous-visible-heading 1))))
22005 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22006 (if (org-called-interactively-p 'any)
22007 (call-interactively 'org-mark-element)
22008 (org-mark-element)))
22011 ;;; Indentation
22013 (defun org-indent-line ()
22014 "Indent line depending on context."
22015 (interactive)
22016 (let* ((pos (point))
22017 (itemp (org-at-item-p))
22018 (case-fold-search t)
22019 (org-drawer-regexp (or org-drawer-regexp "\000"))
22020 (inline-task-p (and (featurep 'org-inlinetask)
22021 (org-inlinetask-in-task-p)))
22022 (inline-re (and inline-task-p
22023 (org-inlinetask-outline-regexp)))
22024 column)
22025 (if (and orgstruct-is-++ (eq pos (point)))
22026 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22027 (indent-according-to-mode))
22028 (beginning-of-line 1)
22029 (cond
22030 ;; Headings
22031 ((looking-at org-outline-regexp) (setq column 0))
22032 ;; Footnote definition
22033 ((looking-at org-footnote-definition-re) (setq column 0))
22034 ;; Literal examples
22035 ((looking-at "[ \t]*:\\( \\|$\\)")
22036 (setq column (org-get-indentation))) ; do nothing
22037 ;; Lists
22038 ((ignore-errors (goto-char (org-in-item-p)))
22039 (setq column (if itemp
22040 (org-get-indentation)
22041 (org-list-item-body-column (point))))
22042 (goto-char pos))
22043 ;; Drawers
22044 ((and (looking-at "[ \t]*:END:")
22045 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22046 (save-excursion
22047 (goto-char (1- (match-beginning 1)))
22048 (setq column (current-column))))
22049 ;; Special blocks
22050 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
22051 (save-excursion
22052 (re-search-backward
22053 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
22054 (setq column (org-get-indentation (match-string 0))))
22055 ((and (not (looking-at "[ \t]*#\\+begin_"))
22056 (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
22057 (save-excursion
22058 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
22059 (setq column
22060 (cond ((equal (downcase (match-string 1)) "src")
22061 ;; src blocks: let `org-edit-src-exit' handle them
22062 (org-get-indentation))
22063 ((equal (downcase (match-string 1)) "example")
22064 (max (org-get-indentation)
22065 (org-get-indentation (match-string 0))))
22067 (org-get-indentation (match-string 0))))))
22068 ;; This line has nothing special, look at the previous relevant
22069 ;; line to compute indentation
22071 (beginning-of-line 0)
22072 (while (and (not (bobp))
22073 (not (looking-at org-table-line-regexp))
22074 (not (looking-at org-drawer-regexp))
22075 ;; When point started in an inline task, do not move
22076 ;; above task starting line.
22077 (not (and inline-task-p (looking-at inline-re)))
22078 ;; Skip drawers, blocks, empty lines, verbatim,
22079 ;; comments, tables, footnotes definitions, lists,
22080 ;; inline tasks.
22081 (or (and (looking-at "[ \t]*:END:")
22082 (re-search-backward org-drawer-regexp nil t))
22083 (and (looking-at "[ \t]*#\\+end_")
22084 (re-search-backward "[ \t]*#\\+begin_"nil t))
22085 (looking-at "[ \t]*[\n:#|]")
22086 (looking-at org-footnote-definition-re)
22087 (and (not inline-task-p)
22088 (featurep 'org-inlinetask)
22089 (org-inlinetask-in-task-p)
22090 (or (org-inlinetask-goto-beginning) t))))
22091 (beginning-of-line 0))
22092 (cond
22093 ;; There was a list item above.
22094 ((ignore-errors (goto-char (org-in-item-p)))
22095 (goto-char (org-list-get-top-point (org-list-struct)))
22096 (setq column (org-get-indentation)))
22097 ;; There was an heading above.
22098 ((looking-at "\\*+[ \t]+")
22099 (if (not org-adapt-indentation)
22100 (setq column 0)
22101 (goto-char (match-end 0))
22102 (setq column (current-column))))
22103 ;; A drawer had started and is unfinished
22104 ((looking-at org-drawer-regexp)
22105 (goto-char (1- (match-beginning 1)))
22106 (setq column (current-column)))
22107 ;; Else, nothing noticeable found: get indentation and go on.
22108 (t (setq column (org-get-indentation))))))
22109 ;; Now apply indentation and move cursor accordingly
22110 (goto-char pos)
22111 (if (<= (current-column) (current-indentation))
22112 (org-indent-line-to column)
22113 (save-excursion (org-indent-line-to column)))
22114 ;; Special polishing for properties, see `org-property-format'
22115 (setq column (current-column))
22116 (beginning-of-line 1)
22117 (if (looking-at org-property-re)
22118 (replace-match (concat (match-string 4)
22119 (format org-property-format
22120 (match-string 1) (match-string 3)))
22121 t t))
22122 (org-move-to-column column))))
22124 (defun org-indent-drawer ()
22125 "Indent the drawer at point."
22126 (interactive)
22127 (let ((p (point))
22128 (e (and (save-excursion (re-search-forward ":END:" nil t))
22129 (match-end 0)))
22130 (folded
22131 (save-excursion
22132 (end-of-line)
22133 (when (overlays-at (point))
22134 (member 'invisible (overlay-properties
22135 (car (overlays-at (point)))))))))
22136 (when folded (org-cycle))
22137 (indent-for-tab-command)
22138 (while (and (move-beginning-of-line 2) (< (point) e))
22139 (indent-for-tab-command))
22140 (goto-char p)
22141 (when folded (org-cycle)))
22142 (message "Drawer at point indented"))
22144 (defun org-indent-block ()
22145 "Indent the block at point."
22146 (interactive)
22147 (let ((p (point))
22148 (case-fold-search t)
22149 (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
22150 (match-end 0)))
22151 (folded
22152 (save-excursion
22153 (end-of-line)
22154 (when (overlays-at (point))
22155 (member 'invisible (overlay-properties
22156 (car (overlays-at (point)))))))))
22157 (when folded (org-cycle))
22158 (indent-for-tab-command)
22159 (while (and (move-beginning-of-line 2) (< (point) e))
22160 (indent-for-tab-command))
22161 (goto-char p)
22162 (when folded (org-cycle)))
22163 (message "Block at point indented"))
22165 (defun org-indent-region (start end)
22166 "Indent region."
22167 (interactive "r")
22168 (save-excursion
22169 (let ((line-end (org-current-line end)))
22170 (goto-char start)
22171 (while (< (org-current-line) line-end)
22172 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22173 (t (call-interactively 'org-indent-line)))
22174 (move-beginning-of-line 2)))))
22177 ;;; Filling
22179 ;; We use our own fill-paragraph and auto-fill functions.
22181 ;; `org-fill-paragraph' relies on adaptive filling and context
22182 ;; checking. Appropriate `fill-prefix' is computed with
22183 ;; `org-adaptive-fill-function'.
22185 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22186 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22187 ;; `org-adaptive-fill-function' value. Internally,
22188 ;; `org-comment-line-break-function' breaks the line.
22190 ;; `org-setup-filling' installs filling and auto-filling related
22191 ;; variables during `org-mode' initialization.
22193 (defvar org-element-paragraph-separate) ; org-element.el
22194 (defun org-setup-filling ()
22195 (require 'org-element)
22196 ;; Prevent auto-fill from inserting unwanted new items.
22197 (when (boundp 'fill-nobreak-predicate)
22198 (org-set-local
22199 'fill-nobreak-predicate
22200 (org-uniquify
22201 (append fill-nobreak-predicate
22202 '(org-fill-line-break-nobreak-p
22203 org-fill-paragraph-with-timestamp-nobreak-p)))))
22204 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22205 (org-set-local 'paragraph-start paragraph-ending)
22206 (org-set-local 'paragraph-separate paragraph-ending))
22207 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22208 (org-set-local 'auto-fill-inhibit-regexp nil)
22209 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22210 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22211 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22213 (defun org-fill-line-break-nobreak-p ()
22214 "Non-nil when a new line at point would create an Org line break."
22215 (save-excursion
22216 (skip-chars-backward "[ \t]")
22217 (skip-chars-backward "\\\\")
22218 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22220 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22221 "Non-nil when a new line at point would split a timestamp."
22222 (and (org-at-timestamp-p t)
22223 (not (looking-at org-ts-regexp-both))))
22225 (declare-function message-in-body-p "message" ())
22226 (defvar orgtbl-line-start-regexp) ; From org-table.el
22227 (defun org-adaptive-fill-function ()
22228 "Compute a fill prefix for the current line.
22229 Return fill prefix, as a string, or nil if current line isn't
22230 meant to be filled. For convenience, if `adaptive-fill-regexp'
22231 matches in paragraphs or comments, use it."
22232 (catch 'exit
22233 (when (derived-mode-p 'message-mode)
22234 (save-excursion
22235 (beginning-of-line)
22236 (cond ((or (not (message-in-body-p))
22237 (looking-at orgtbl-line-start-regexp))
22238 (throw 'exit nil))
22239 ((looking-at message-cite-prefix-regexp)
22240 (throw 'exit (match-string-no-properties 0)))
22241 ((looking-at org-outline-regexp)
22242 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22243 (org-with-wide-buffer
22244 (let* ((p (line-beginning-position))
22245 (element (save-excursion
22246 (beginning-of-line)
22247 (or (ignore-errors (org-element-at-point))
22248 (user-error "An element cannot be parsed line %d"
22249 (line-number-at-pos (point))))))
22250 (type (org-element-type element))
22251 (post-affiliated (org-element-property :post-affiliated element)))
22252 (unless (and post-affiliated (< p post-affiliated))
22253 (case type
22254 (comment
22255 (save-excursion
22256 (beginning-of-line)
22257 (looking-at "[ \t]*")
22258 (concat (match-string 0) "# ")))
22259 (footnote-definition "")
22260 ((item plain-list)
22261 (make-string (org-list-item-body-column
22262 (or post-affiliated
22263 (org-element-property :begin element)))
22264 ? ))
22265 (paragraph
22266 ;; Fill prefix is usually the same as the current line,
22267 ;; unless the paragraph is at the beginning of an item.
22268 (let ((parent (org-element-property :parent element)))
22269 (save-excursion
22270 (beginning-of-line)
22271 (cond ((eq (org-element-type parent) 'item)
22272 (make-string (org-list-item-body-column
22273 (org-element-property :begin parent))
22274 ? ))
22275 ((and adaptive-fill-regexp
22276 ;; Locally disable
22277 ;; `adaptive-fill-function' to let
22278 ;; `fill-context-prefix' handle
22279 ;; `adaptive-fill-regexp' variable.
22280 (let (adaptive-fill-function)
22281 (fill-context-prefix
22282 post-affiliated
22283 (org-element-property :end element)))))
22284 ((looking-at "[ \t]+") (match-string 0))
22285 (t "")))))
22286 (comment-block
22287 ;; Only fill contents if P is within block boundaries.
22288 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22289 (forward-line)
22290 (point)))
22291 (cend (save-excursion
22292 (goto-char (org-element-property :end element))
22293 (skip-chars-backward " \r\t\n")
22294 (line-beginning-position))))
22295 (when (and (>= p cbeg) (< p cend))
22296 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22297 (match-string 0)
22298 ""))))))))))
22300 (declare-function message-goto-body "message" ())
22301 (defvar message-cite-prefix-regexp) ; From message.el
22302 (defun org-fill-paragraph (&optional justify)
22303 "Fill element at point, when applicable.
22305 This function only applies to comment blocks, comments, example
22306 blocks and paragraphs. Also, as a special case, re-align table
22307 when point is at one.
22309 If JUSTIFY is non-nil (interactively, with prefix argument),
22310 justify as well. If `sentence-end-double-space' is non-nil, then
22311 period followed by one space does not end a sentence, so don't
22312 break a line there. The variable `fill-column' controls the
22313 width for filling.
22315 For convenience, when point is at a plain list, an item or
22316 a footnote definition, try to fill the first paragraph within."
22317 (interactive)
22318 (if (and (derived-mode-p 'message-mode)
22319 (or (not (message-in-body-p))
22320 (save-excursion (move-beginning-of-line 1)
22321 (looking-at message-cite-prefix-regexp))))
22322 ;; First ensure filling is correct in message-mode.
22323 (let ((fill-paragraph-function
22324 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22325 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22326 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22327 (paragraph-separate
22328 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22329 (fill-paragraph nil))
22330 (with-syntax-table org-mode-transpose-word-syntax-table
22331 ;; Move to end of line in order to get the first paragraph
22332 ;; within a plain list or a footnote definition.
22333 (let ((element (save-excursion
22334 (end-of-line)
22335 (or (ignore-errors (org-element-at-point))
22336 (user-error "An element cannot be parsed line %d"
22337 (line-number-at-pos (point)))))))
22338 ;; First check if point is in a blank line at the beginning of
22339 ;; the buffer. In that case, ignore filling.
22340 (case (org-element-type element)
22341 ;; Use major mode filling function is src blocks.
22342 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22343 ;; Align Org tables, leave table.el tables as-is.
22344 (table-row (org-table-align) t)
22345 (table
22346 (when (eq (org-element-property :type element) 'org)
22347 (save-excursion
22348 (goto-char (org-element-property :post-affiliated element))
22349 (org-table-align)))
22351 (paragraph
22352 ;; Paragraphs may contain `line-break' type objects.
22353 (let ((beg (max (point-min)
22354 (org-element-property :contents-begin element)))
22355 (end (min (point-max)
22356 (org-element-property :contents-end element))))
22357 ;; Do nothing if point is at an affiliated keyword.
22358 (if (< (line-end-position) beg) t
22359 (when (derived-mode-p 'message-mode)
22360 ;; In `message-mode', do not fill following citation
22361 ;; in current paragraph nor text before message body.
22362 (let ((body-start (save-excursion (message-goto-body))))
22363 (when body-start (setq beg (max body-start beg))))
22364 (when (save-excursion
22365 (re-search-forward
22366 (concat "^" message-cite-prefix-regexp) end t))
22367 (setq end (match-beginning 0))))
22368 ;; Fill paragraph, taking line breaks into account.
22369 ;; For that, slice the paragraph using line breaks as
22370 ;; separators, and fill the parts in reverse order to
22371 ;; avoid messing with markers.
22372 (save-excursion
22373 (goto-char end)
22374 (mapc
22375 (lambda (pos)
22376 (fill-region-as-paragraph pos (point) justify)
22377 (goto-char pos))
22378 ;; Find the list of ending positions for line breaks
22379 ;; in the current paragraph. Add paragraph
22380 ;; beginning to include first slice.
22381 (nreverse
22382 (cons beg
22383 (org-element-map
22384 (org-element--parse-objects
22385 beg end nil (org-element-restriction 'paragraph))
22386 'line-break
22387 (lambda (lb) (org-element-property :end lb)))))))
22388 t)))
22389 ;; Contents of `comment-block' type elements should be
22390 ;; filled as plain text, but only if point is within block
22391 ;; markers.
22392 (comment-block
22393 (let* ((case-fold-search t)
22394 (beg (save-excursion
22395 (goto-char (org-element-property :begin element))
22396 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22397 (forward-line)
22398 (point)))
22399 (end (save-excursion
22400 (goto-char (org-element-property :end element))
22401 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22402 (line-beginning-position))))
22403 (if (or (< (point) beg) (> (point) end)) t
22404 (fill-region-as-paragraph
22405 (save-excursion (end-of-line)
22406 (re-search-backward "^[ \t]*$" beg 'move)
22407 (line-beginning-position))
22408 (save-excursion (beginning-of-line)
22409 (re-search-forward "^[ \t]*$" end 'move)
22410 (line-beginning-position))
22411 justify))))
22412 ;; Fill comments.
22413 (comment
22414 (let ((begin (org-element-property :post-affiliated element))
22415 (end (org-element-property :end element)))
22416 (when (and (>= (point) begin) (<= (point) end))
22417 (let ((begin (save-excursion
22418 (end-of-line)
22419 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22420 (progn (forward-line) (point))
22421 begin)))
22422 (end (save-excursion
22423 (end-of-line)
22424 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22425 (1- (line-beginning-position))
22426 (skip-chars-backward " \r\t\n")
22427 (line-end-position)))))
22428 ;; Do not fill comments when at a blank line.
22429 (when (> end begin)
22430 (let ((fill-prefix
22431 (save-excursion
22432 (beginning-of-line)
22433 (looking-at "[ \t]*#")
22434 (let ((comment-prefix (match-string 0)))
22435 (goto-char (match-end 0))
22436 (if (looking-at adaptive-fill-regexp)
22437 (concat comment-prefix (match-string 0))
22438 (concat comment-prefix " "))))))
22439 (save-excursion
22440 (fill-region-as-paragraph begin end justify))))))
22442 ;; Ignore every other element.
22443 (otherwise t))))))
22445 (defun org-auto-fill-function ()
22446 "Auto-fill function."
22447 ;; Check if auto-filling is meaningful.
22448 (let ((fc (current-fill-column)))
22449 (when (and fc (> (current-column) fc))
22450 (let* ((fill-prefix (org-adaptive-fill-function))
22451 ;; Enforce empty fill prefix, if required. Otherwise, it
22452 ;; will be computed again.
22453 (adaptive-fill-mode (not (equal fill-prefix ""))))
22454 (when fill-prefix (do-auto-fill))))))
22456 (defun org-comment-line-break-function (&optional soft)
22457 "Break line at point and indent, continuing comment if within one.
22458 The inserted newline is marked hard if variable
22459 `use-hard-newlines' is true, unless optional argument SOFT is
22460 non-nil."
22461 (if soft (insert-and-inherit ?\n) (newline 1))
22462 (save-excursion (forward-char -1) (delete-horizontal-space))
22463 (delete-horizontal-space)
22464 (indent-to-left-margin)
22465 (insert-before-markers-and-inherit fill-prefix))
22468 ;;; Comments
22470 ;; Org comments syntax is quite complex. It requires the entire line
22471 ;; to be just a comment. Also, even with the right syntax at the
22472 ;; beginning of line, some some elements (i.e. verse-block or
22473 ;; example-block) don't accept comments. Usual Emacs comment commands
22474 ;; cannot cope with those requirements. Therefore, Org replaces them.
22476 ;; Org still relies on `comment-dwim', but cannot trust
22477 ;; `comment-only-p'. So, `comment-region-function' and
22478 ;; `uncomment-region-function' both point
22479 ;; to`org-comment-or-uncomment-region'. Eventually,
22480 ;; `org-insert-comment' takes care of insertion of comments at the
22481 ;; beginning of line.
22483 ;; `org-setup-comments-handling' install comments related variables
22484 ;; during `org-mode' initialization.
22486 (defun org-setup-comments-handling ()
22487 (interactive)
22488 (org-set-local 'comment-use-syntax nil)
22489 (org-set-local 'comment-start "# ")
22490 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
22491 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22492 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22493 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22495 (defun org-insert-comment ()
22496 "Insert an empty comment above current line.
22497 If the line is empty, insert comment at its beginning."
22498 (beginning-of-line)
22499 (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
22500 (org-indent-line)
22501 (insert "# "))
22503 (defvar comment-empty-lines) ; From newcomment.el.
22504 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22505 "Comment or uncomment each non-blank line in the region.
22506 Uncomment each non-blank line between BEG and END if it only
22507 contains commented lines. Otherwise, comment them."
22508 (save-restriction
22509 ;; Restrict region
22510 (narrow-to-region (save-excursion (goto-char beg)
22511 (skip-chars-forward " \r\t\n" end)
22512 (line-beginning-position))
22513 (save-excursion (goto-char end)
22514 (skip-chars-backward " \r\t\n" beg)
22515 (line-end-position)))
22516 (let ((uncommentp
22517 ;; UNCOMMENTP is non-nil when every non blank line between
22518 ;; BEG and END is a comment.
22519 (save-excursion
22520 (goto-char (point-min))
22521 (while (and (not (eobp))
22522 (let ((element (org-element-at-point)))
22523 (and (eq (org-element-type element) 'comment)
22524 (goto-char (min (point-max)
22525 (org-element-property
22526 :end element)))))))
22527 (eobp))))
22528 (if uncommentp
22529 ;; Only blank lines and comments in region: uncomment it.
22530 (save-excursion
22531 (goto-char (point-min))
22532 (while (not (eobp))
22533 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
22534 (replace-match "" nil nil nil 1))
22535 (forward-line)))
22536 ;; Comment each line in region.
22537 (let ((min-indent (point-max)))
22538 ;; First find the minimum indentation across all lines.
22539 (save-excursion
22540 (goto-char (point-min))
22541 (while (and (not (eobp)) (not (zerop min-indent)))
22542 (unless (looking-at "[ \t]*$")
22543 (setq min-indent (min min-indent (current-indentation))))
22544 (forward-line)))
22545 ;; Then loop over all lines.
22546 (save-excursion
22547 (goto-char (point-min))
22548 (while (not (eobp))
22549 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
22550 ;; Don't get fooled by invisible text (e.g. link path)
22551 ;; when moving to column MIN-INDENT.
22552 (let ((buffer-invisibility-spec nil))
22553 (org-move-to-column min-indent t))
22554 (insert comment-start))
22555 (forward-line))))))))
22558 ;;; Planning
22560 ;; This section contains tools to operate on timestamp objects, as
22561 ;; returned by, e.g. `org-element-context'.
22563 (defun org-timestamp-has-time-p (timestamp)
22564 "Non-nil when TIMESTAMP has a time specified."
22565 (org-element-property :hour-start timestamp))
22567 (defun org-timestamp-format (timestamp format &optional end utc)
22568 "Format a TIMESTAMP element into a string.
22570 FORMAT is a format specifier to be passed to
22571 `format-time-string'.
22573 When optional argument END is non-nil, use end of date-range or
22574 time-range, if possible.
22576 When optional argument UTC is non-nil, time will be expressed as
22577 Universal Time."
22578 (format-time-string
22579 format
22580 (apply 'encode-time
22581 (cons 0
22582 (mapcar
22583 (lambda (prop) (or (org-element-property prop timestamp) 0))
22584 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22585 '(:minute-start :hour-start :day-start :month-start
22586 :year-start)))))
22587 utc))
22589 (defun org-timestamp-split-range (timestamp &optional end)
22590 "Extract a timestamp object from a date or time range.
22592 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22593 the end of the range. Otherwise, extract its start.
22595 Return a new timestamp object sharing the same parent as
22596 TIMESTAMP."
22597 (let ((type (org-element-property :type timestamp)))
22598 (if (memq type '(active inactive diary)) timestamp
22599 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22600 ;; Set new type.
22601 (org-element-put-property
22602 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22603 ;; Copy start properties over end properties if END is
22604 ;; non-nil. Otherwise, copy end properties over `start' ones.
22605 (let ((p-alist '((:minute-start . :minute-end)
22606 (:hour-start . :hour-end)
22607 (:day-start . :day-end)
22608 (:month-start . :month-end)
22609 (:year-start . :year-end))))
22610 (dolist (p-cell p-alist)
22611 (org-element-put-property
22612 split-ts
22613 (funcall (if end 'car 'cdr) p-cell)
22614 (org-element-property
22615 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22616 ;; Eventually refresh `:raw-value'.
22617 (org-element-put-property split-ts :raw-value nil)
22618 (org-element-put-property
22619 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22621 (defun org-timestamp-translate (timestamp &optional boundary)
22622 "Apply `org-translate-time' on a TIMESTAMP object.
22623 When optional argument BOUNDARY is non-nil, it is either the
22624 symbol `start' or `end'. In this case, only translate the
22625 starting or ending part of TIMESTAMP if it is a date or time
22626 range. Otherwise, translate both parts."
22627 (if (and (not boundary)
22628 (memq (org-element-property :type timestamp)
22629 '(active-range inactive-range)))
22630 (concat
22631 (org-translate-time
22632 (org-element-property :raw-value
22633 (org-timestamp-split-range timestamp)))
22634 "--"
22635 (org-translate-time
22636 (org-element-property :raw-value
22637 (org-timestamp-split-range timestamp t))))
22638 (org-translate-time
22639 (org-element-property
22640 :raw-value
22641 (if (not boundary) timestamp
22642 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22646 ;;; Other stuff.
22648 (defun org-toggle-fixed-width-section (arg)
22649 "Toggle the fixed-width export.
22650 If there is no active region, the QUOTE keyword at the current headline is
22651 inserted or removed. When present, it causes the text between this headline
22652 and the next to be exported as fixed-width text, and unmodified.
22653 If there is an active region, this command adds or removes a colon as the
22654 first character of this line. If the first character of a line is a colon,
22655 this line is also exported in fixed-width font."
22656 (interactive "P")
22657 (let* ((cc 0)
22658 (regionp (org-region-active-p))
22659 (beg (if regionp (region-beginning) (point)))
22660 (end (if regionp (region-end)))
22661 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22662 (case-fold-search nil)
22663 (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
22664 off)
22665 (if regionp
22666 (save-excursion
22667 (goto-char beg)
22668 (setq cc (current-column))
22669 (beginning-of-line 1)
22670 (setq off (looking-at re))
22671 (while (> nlines 0)
22672 (setq nlines (1- nlines))
22673 (beginning-of-line 1)
22674 (cond
22675 (arg
22676 (org-move-to-column cc t)
22677 (insert ": \n")
22678 (forward-line -1))
22679 ((and off (looking-at re))
22680 (replace-match "" t t nil 1))
22681 ((not off) (org-move-to-column cc t) (insert ": ")))
22682 (forward-line 1)))
22683 (save-excursion
22684 (org-back-to-heading)
22685 (cond
22686 ((looking-at (format org-heading-keyword-regexp-format
22687 org-quote-string))
22688 (goto-char (match-end 1))
22689 (looking-at (concat " +" org-quote-string))
22690 (replace-match "" t t)
22691 (when (eolp) (insert " ")))
22692 ((looking-at org-outline-regexp)
22693 (goto-char (match-end 0))
22694 (insert org-quote-string " ")))))))
22696 (defun org-reftex-citation ()
22697 "Use reftex-citation to insert a citation into the buffer.
22698 This looks for a line like
22700 #+BIBLIOGRAPHY: foo plain option:-d
22702 and derives from it that foo.bib is the bibliography file relevant
22703 for this document. It then installs the necessary environment for RefTeX
22704 to work in this buffer and calls `reftex-citation' to insert a citation
22705 into the buffer.
22707 Export of such citations to both LaTeX and HTML is handled by the contributed
22708 package ox-bibtex by Taru Karttunen."
22709 (interactive)
22710 (let ((reftex-docstruct-symbol 'rds)
22711 (reftex-cite-format "\\cite{%l}")
22712 rds bib)
22713 (save-excursion
22714 (save-restriction
22715 (widen)
22716 (let ((case-fold-search t)
22717 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
22718 (if (not (save-excursion
22719 (or (re-search-forward re nil t)
22720 (re-search-backward re nil t))))
22721 (error "No bibliography defined in file")
22722 (setq bib (concat (match-string 1) ".bib")
22723 rds (list (list 'bib bib)))))))
22724 (call-interactively 'reftex-citation)))
22726 ;;;; Functions extending outline functionality
22728 (defun org-beginning-of-line (&optional arg)
22729 "Go to the beginning of the current line. If that is invisible, continue
22730 to a visible line beginning. This makes the function of C-a more intuitive.
22731 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22732 first attempt, and only move to after the tags when the cursor is already
22733 beyond the end of the headline."
22734 (interactive "P")
22735 (let ((pos (point))
22736 (special (if (consp org-special-ctrl-a/e)
22737 (car org-special-ctrl-a/e)
22738 org-special-ctrl-a/e))
22739 deactivate-mark refpos)
22740 (if (org-bound-and-true-p visual-line-mode)
22741 (beginning-of-visual-line 1)
22742 (beginning-of-line 1))
22743 (if (and arg (fboundp 'move-beginning-of-line))
22744 (call-interactively 'move-beginning-of-line)
22745 (if (bobp)
22747 (backward-char 1)
22748 (if (org-truely-invisible-p)
22749 (while (and (not (bobp)) (org-truely-invisible-p))
22750 (backward-char 1)
22751 (beginning-of-line 1))
22752 (forward-char 1))))
22753 (when special
22754 (cond
22755 ((and (looking-at org-complex-heading-regexp)
22756 (= (char-after (match-end 1)) ?\ ))
22757 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22758 (point-at-eol)))
22759 (goto-char
22760 (if (eq special t)
22761 (cond ((> pos refpos) refpos)
22762 ((= pos (point)) refpos)
22763 (t (point)))
22764 (cond ((> pos (point)) (point))
22765 ((not (eq last-command this-command)) (point))
22766 (t refpos)))))
22767 ((org-at-item-p)
22768 ;; Being at an item and not looking at an the item means point
22769 ;; was previously moved to beginning of a visual line, which
22770 ;; doesn't contain the item. Therefore, do nothing special,
22771 ;; just stay here.
22772 (when (looking-at org-list-full-item-re)
22773 ;; Set special position at first white space character after
22774 ;; bullet, and check-box, if any.
22775 (let ((after-bullet
22776 (let ((box (match-end 3)))
22777 (if (not box) (match-end 1)
22778 (let ((after (char-after box)))
22779 (if (and after (= after ? )) (1+ box) box))))))
22780 ;; Special case: Move point to special position when
22781 ;; currently after it or at beginning of line.
22782 (if (eq special t)
22783 (when (or (> pos after-bullet) (= (point) pos))
22784 (goto-char after-bullet))
22785 ;; Reversed case: Move point to special position when
22786 ;; point was already at beginning of line and command is
22787 ;; repeated.
22788 (when (and (= (point) pos) (eq last-command this-command))
22789 (goto-char after-bullet))))))))
22790 (org-no-warnings
22791 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22792 (setq disable-point-adjustment
22793 (or (not (invisible-p (point)))
22794 (not (invisible-p (max (point-min) (1- (point))))))))
22796 (defun org-end-of-line (&optional arg)
22797 "Go to the end of the line.
22798 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22799 tags on the first attempt, and only move to after the tags when
22800 the cursor is already beyond the end of the headline."
22801 (interactive "P")
22802 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22803 org-special-ctrl-a/e))
22804 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22805 'end-of-visual-line)
22806 ((fboundp 'move-end-of-line) 'move-end-of-line)
22807 (t 'end-of-line)))
22808 deactivate-mark)
22809 (if (or (not special) arg) (call-interactively move-fun)
22810 (let* ((element (save-excursion (beginning-of-line)
22811 (org-element-at-point)))
22812 (type (org-element-type element)))
22813 (cond
22814 ((memq type '(headline inlinetask))
22815 (let ((pos (point)))
22816 (beginning-of-line 1)
22817 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
22818 (if (eq special t)
22819 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22820 (goto-char (match-beginning 1))
22821 (goto-char (match-end 0)))
22822 (if (or (< pos (match-end 0))
22823 (not (eq this-command last-command)))
22824 (goto-char (match-end 0))
22825 (goto-char (match-beginning 1))))
22826 (call-interactively move-fun))))
22827 ((org-element-property :hiddenp element)
22828 ;; If element is hidden, `move-end-of-line' would put point
22829 ;; after it. Use `end-of-line' to stay on current line.
22830 (call-interactively 'end-of-line))
22831 (t (call-interactively move-fun)))))
22832 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22833 (setq disable-point-adjustment
22834 (or (not (invisible-p (point)))
22835 (not (invisible-p (max (point-min) (1- (point))))))))
22837 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22838 (define-key org-mode-map "\C-e" 'org-end-of-line)
22840 (defun org-backward-sentence (&optional arg)
22841 "Go to beginning of sentence, or beginning of table field.
22842 This will call `backward-sentence' or `org-table-beginning-of-field',
22843 depending on context."
22844 (interactive "P")
22845 (cond
22846 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22847 (t (call-interactively 'backward-sentence))))
22849 (defun org-forward-sentence (&optional arg)
22850 "Go to end of sentence, or end of table field.
22851 This will call `forward-sentence' or `org-table-end-of-field',
22852 depending on context."
22853 (interactive "P")
22854 (cond
22855 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22856 (t (call-interactively 'forward-sentence))))
22858 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22859 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22861 (defun org-kill-line (&optional arg)
22862 "Kill line, to tags or end of line."
22863 (interactive "P")
22864 (cond
22865 ((or (not org-special-ctrl-k)
22866 (bolp)
22867 (not (org-at-heading-p)))
22868 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22869 org-ctrl-k-protect-subtree)
22870 (if (or (eq org-ctrl-k-protect-subtree 'error)
22871 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22872 (user-error "C-k aborted as it would kill a hidden subtree")))
22873 (call-interactively
22874 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22875 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
22876 (kill-region (point) (match-beginning 1))
22877 (org-set-tags nil t))
22878 (t (kill-region (point) (point-at-eol)))))
22880 (define-key org-mode-map "\C-k" 'org-kill-line)
22882 (defun org-yank (&optional arg)
22883 "Yank. If the kill is a subtree, treat it specially.
22884 This command will look at the current kill and check if is a single
22885 subtree, or a series of subtrees[1]. If it passes the test, and if the
22886 cursor is at the beginning of a line or after the stars of a currently
22887 empty headline, then the yank is handled specially. How exactly depends
22888 on the value of the following variables, both set by default.
22890 org-yank-folded-subtrees
22891 When set, the subtree(s) will be folded after insertion, but only
22892 if doing so would now swallow text after the yanked text.
22894 org-yank-adjusted-subtrees
22895 When set, the subtree will be promoted or demoted in order to
22896 fit into the local outline tree structure, which means that the level
22897 will be adjusted so that it becomes the smaller one of the two
22898 *visible* surrounding headings.
22900 Any prefix to this command will cause `yank' to be called directly with
22901 no special treatment. In particular, a simple \\[universal-argument] prefix \
22902 will just
22903 plainly yank the text as it is.
22905 \[1] The test checks if the first non-white line is a heading
22906 and if there are no other headings with fewer stars."
22907 (interactive "P")
22908 (org-yank-generic 'yank arg))
22910 (defun org-yank-generic (command arg)
22911 "Perform some yank-like command.
22913 This function implements the behavior described in the `org-yank'
22914 documentation. However, it has been generalized to work for any
22915 interactive command with similar behavior."
22917 ;; pretend to be command COMMAND
22918 (setq this-command command)
22920 (if arg
22921 (call-interactively command)
22923 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22924 (and (org-kill-is-subtree-p)
22925 (or (bolp)
22926 (and (looking-at "[ \t]*$")
22927 (string-match
22928 "\\`\\*+\\'"
22929 (buffer-substring (point-at-bol) (point)))))))
22930 swallowp)
22931 (cond
22932 ((and subtreep org-yank-folded-subtrees)
22933 (let ((beg (point))
22934 end)
22935 (if (and subtreep org-yank-adjusted-subtrees)
22936 (org-paste-subtree nil nil 'for-yank)
22937 (call-interactively command))
22939 (setq end (point))
22940 (goto-char beg)
22941 (when (and (bolp) subtreep
22942 (not (setq swallowp
22943 (org-yank-folding-would-swallow-text beg end))))
22944 (org-with-limited-levels
22945 (or (looking-at org-outline-regexp)
22946 (re-search-forward org-outline-regexp-bol end t))
22947 (while (and (< (point) end) (looking-at org-outline-regexp))
22948 (hide-subtree)
22949 (org-cycle-show-empty-lines 'folded)
22950 (condition-case nil
22951 (outline-forward-same-level 1)
22952 (error (goto-char end))))))
22953 (when swallowp
22954 (message
22955 "Inserted text not folded because that would swallow text"))
22957 (goto-char end)
22958 (skip-chars-forward " \t\n\r")
22959 (beginning-of-line 1)
22960 (push-mark beg 'nomsg)))
22961 ((and subtreep org-yank-adjusted-subtrees)
22962 (let ((beg (point-at-bol)))
22963 (org-paste-subtree nil nil 'for-yank)
22964 (push-mark beg 'nomsg)))
22966 (call-interactively command))))))
22968 (defun org-yank-folding-would-swallow-text (beg end)
22969 "Would hide-subtree at BEG swallow any text after END?"
22970 (let (level)
22971 (org-with-limited-levels
22972 (save-excursion
22973 (goto-char beg)
22974 (when (or (looking-at org-outline-regexp)
22975 (re-search-forward org-outline-regexp-bol end t))
22976 (setq level (org-outline-level)))
22977 (goto-char end)
22978 (skip-chars-forward " \t\r\n\v\f")
22979 (if (or (eobp)
22980 (and (bolp) (looking-at org-outline-regexp)
22981 (<= (org-outline-level) level)))
22982 nil ; Nothing would be swallowed
22983 t))))) ; something would swallow
22985 (define-key org-mode-map "\C-y" 'org-yank)
22987 (defun org-truely-invisible-p ()
22988 "Check if point is at a character currently not visible.
22989 This version does not only check the character property, but also
22990 `visible-mode'."
22991 ;; Early versions of noutline don't have `outline-invisible-p'.
22992 (if (org-bound-and-true-p visible-mode)
22994 (outline-invisible-p)))
22996 (defun org-invisible-p2 ()
22997 "Check if point is at a character currently not visible."
22998 (save-excursion
22999 (if (and (eolp) (not (bobp))) (backward-char 1))
23000 ;; Early versions of noutline don't have `outline-invisible-p'.
23001 (outline-invisible-p)))
23003 (defun org-back-to-heading (&optional invisible-ok)
23004 "Call `outline-back-to-heading', but provide a better error message."
23005 (condition-case nil
23006 (outline-back-to-heading invisible-ok)
23007 (error (error "Before first headline at position %d in buffer %s"
23008 (point) (current-buffer)))))
23010 (defun org-before-first-heading-p ()
23011 "Before first heading?"
23012 (save-excursion
23013 (end-of-line)
23014 (null (re-search-backward org-outline-regexp-bol nil t))))
23016 (defun org-at-heading-p (&optional ignored)
23017 (outline-on-heading-p t))
23018 ;; Compatibility alias with Org versions < 7.8.03
23019 (defalias 'org-on-heading-p 'org-at-heading-p)
23021 (defun org-at-comment-p nil
23022 "Is cursor in a line starting with a # character?"
23023 (save-excursion
23024 (beginning-of-line)
23025 (looking-at "^#")))
23027 (defun org-at-drawer-p nil
23028 "Is cursor at a drawer keyword?"
23029 (save-excursion
23030 (move-beginning-of-line 1)
23031 (looking-at org-drawer-regexp)))
23033 (defun org-at-block-p nil
23034 "Is cursor at a block keyword?"
23035 (save-excursion
23036 (move-beginning-of-line 1)
23037 (looking-at org-block-regexp)))
23039 (defun org-point-at-end-of-empty-headline ()
23040 "If point is at the end of an empty headline, return t, else nil.
23041 If the heading only contains a TODO keyword, it is still still considered
23042 empty."
23043 (and (looking-at "[ \t]*$")
23044 (when org-todo-line-regexp
23045 (save-excursion
23046 (beginning-of-line 1)
23047 (let ((case-fold-search nil))
23048 (looking-at org-todo-line-regexp)
23049 (string= (match-string 3) ""))))))
23051 (defun org-at-heading-or-item-p ()
23052 (or (org-at-heading-p) (org-at-item-p)))
23054 (defun org-at-target-p ()
23055 (or (org-in-regexp org-radio-target-regexp)
23056 (org-in-regexp org-target-regexp)))
23057 ;; Compatibility alias with Org versions < 7.8.03
23058 (defalias 'org-on-target-p 'org-at-target-p)
23060 (defun org-up-heading-all (arg)
23061 "Move to the heading line of which the present line is a subheading.
23062 This function considers both visible and invisible heading lines.
23063 With argument, move up ARG levels."
23064 (if (fboundp 'outline-up-heading-all)
23065 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23066 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23068 (defun org-up-heading-safe ()
23069 "Move to the heading line of which the present line is a subheading.
23070 This version will not throw an error. It will return the level of the
23071 headline found, or nil if no higher level is found.
23073 Also, this function will be a lot faster than `outline-up-heading',
23074 because it relies on stars being the outline starters. This can really
23075 make a significant difference in outlines with very many siblings."
23076 (let (start-level re)
23077 (org-back-to-heading t)
23078 (setq start-level (funcall outline-level))
23079 (if (equal start-level 1)
23081 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
23082 (if (re-search-backward re nil t)
23083 (funcall outline-level)))))
23085 (defun org-first-sibling-p ()
23086 "Is this heading the first child of its parents?"
23087 (interactive)
23088 (let ((re org-outline-regexp-bol)
23089 level l)
23090 (unless (org-at-heading-p t)
23091 (user-error "Not at a heading"))
23092 (setq level (funcall outline-level))
23093 (save-excursion
23094 (if (not (re-search-backward re nil t))
23096 (setq l (funcall outline-level))
23097 (< l level)))))
23099 (defun org-goto-sibling (&optional previous)
23100 "Goto the next sibling, even if it is invisible.
23101 When PREVIOUS is set, go to the previous sibling instead. Returns t
23102 when a sibling was found. When none is found, return nil and don't
23103 move point."
23104 (let ((fun (if previous 're-search-backward 're-search-forward))
23105 (pos (point))
23106 (re org-outline-regexp-bol)
23107 level l)
23108 (when (condition-case nil (org-back-to-heading t) (error nil))
23109 (setq level (funcall outline-level))
23110 (catch 'exit
23111 (or previous (forward-char 1))
23112 (while (funcall fun re nil t)
23113 (setq l (funcall outline-level))
23114 (when (< l level) (goto-char pos) (throw 'exit nil))
23115 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23116 (goto-char pos)
23117 nil))))
23119 (defun org-show-siblings ()
23120 "Show all siblings of the current headline."
23121 (save-excursion
23122 (while (org-goto-sibling) (org-flag-heading nil)))
23123 (save-excursion
23124 (while (org-goto-sibling 'previous)
23125 (org-flag-heading nil))))
23127 (defun org-goto-first-child ()
23128 "Goto the first child, even if it is invisible.
23129 Return t when a child was found. Otherwise don't move point and
23130 return nil."
23131 (let (level (pos (point)) (re org-outline-regexp-bol))
23132 (when (condition-case nil (org-back-to-heading t) (error nil))
23133 (setq level (outline-level))
23134 (forward-char 1)
23135 (if (and (re-search-forward re nil t) (> (outline-level) level))
23136 (progn (goto-char (match-beginning 0)) t)
23137 (goto-char pos) nil))))
23139 (defun org-show-hidden-entry ()
23140 "Show an entry where even the heading is hidden."
23141 (save-excursion
23142 (org-show-entry)))
23144 (defun org-flag-heading (flag &optional entry)
23145 "Flag the current heading. FLAG non-nil means make invisible.
23146 When ENTRY is non-nil, show the entire entry."
23147 (save-excursion
23148 (org-back-to-heading t)
23149 ;; Check if we should show the entire entry
23150 (if entry
23151 (progn
23152 (org-show-entry)
23153 (save-excursion
23154 (and (outline-next-heading)
23155 (org-flag-heading nil))))
23156 (outline-flag-region (max (point-min) (1- (point)))
23157 (save-excursion (outline-end-of-heading) (point))
23158 flag))))
23160 (defun org-get-next-sibling ()
23161 "Move to next heading of the same level, and return point.
23162 If there is no such heading, return nil.
23163 This is like outline-next-sibling, but invisible headings are ok."
23164 (let ((level (funcall outline-level)))
23165 (outline-next-heading)
23166 (while (and (not (eobp)) (> (funcall outline-level) level))
23167 (outline-next-heading))
23168 (if (or (eobp) (< (funcall outline-level) level))
23170 (point))))
23172 (defun org-get-last-sibling ()
23173 "Move to previous heading of the same level, and return point.
23174 If there is no such heading, return nil."
23175 (let ((opoint (point))
23176 (level (funcall outline-level)))
23177 (outline-previous-heading)
23178 (when (and (/= (point) opoint) (outline-on-heading-p t))
23179 (while (and (> (funcall outline-level) level)
23180 (not (bobp)))
23181 (outline-previous-heading))
23182 (if (< (funcall outline-level) level)
23184 (point)))))
23186 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23187 "Goto to the end of a subtree."
23188 ;; This contains an exact copy of the original function, but it uses
23189 ;; `org-back-to-heading', to make it work also in invisible
23190 ;; trees. And is uses an invisible-ok argument.
23191 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23192 ;; Furthermore, when used inside Org, finding the end of a large subtree
23193 ;; with many children and grandchildren etc, this can be much faster
23194 ;; than the outline version.
23195 (org-back-to-heading invisible-ok)
23196 (let ((first t)
23197 (level (funcall outline-level)))
23198 (if (and (derived-mode-p 'org-mode) (< level 1000))
23199 ;; A true heading (not a plain list item), in Org-mode
23200 ;; This means we can easily find the end by looking
23201 ;; only for the right number of stars. Using a regexp to do
23202 ;; this is so much faster than using a Lisp loop.
23203 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23204 (forward-char 1)
23205 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23206 ;; something else, do it the slow way
23207 (while (and (not (eobp))
23208 (or first (> (funcall outline-level) level)))
23209 (setq first nil)
23210 (outline-next-heading)))
23211 (unless to-heading
23212 (if (memq (preceding-char) '(?\n ?\^M))
23213 (progn
23214 ;; Go to end of line before heading
23215 (forward-char -1)
23216 (if (memq (preceding-char) '(?\n ?\^M))
23217 ;; leave blank line before heading
23218 (forward-char -1))))))
23219 (point))
23221 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23222 "Use Org version in org-mode, for dramatic speed-up."
23223 (if (derived-mode-p 'org-mode)
23224 (progn
23225 (org-end-of-subtree nil t)
23226 (unless (eobp) (backward-char 1)))
23227 ad-do-it))
23229 (defun org-end-of-meta-data-and-drawers ()
23230 "Jump to the first text after meta data and drawers in the current entry.
23231 This will move over empty lines, lines with planning time stamps,
23232 clocking lines, and drawers."
23233 (org-back-to-heading t)
23234 (let ((end (save-excursion (outline-next-heading) (point)))
23235 (re (concat "\\(" org-drawer-regexp "\\)"
23236 "\\|" "[ \t]*" org-keyword-time-regexp)))
23237 (forward-line 1)
23238 (while (re-search-forward re end t)
23239 (if (not (match-end 1))
23240 ;; empty or planning line
23241 (forward-line 1)
23242 ;; a drawer, find the end
23243 (re-search-forward "^[ \t]*:END:" end 'move)
23244 (forward-line 1)))
23245 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23246 (point)))
23248 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23249 "Move forward to the ARG'th subheading at same level as this one.
23250 Stop at the first and last subheadings of a superior heading.
23251 Normally this only looks at visible headings, but when INVISIBLE-OK is
23252 non-nil it will also look at invisible ones."
23253 (interactive "p")
23254 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23255 (if (and arg (< arg 0))
23256 (goto-char (point-min))
23257 (outline-next-heading))
23258 (org-at-heading-p)
23259 (let ((level (- (match-end 0) (match-beginning 0) 1))
23260 (f (if (and arg (< arg 0))
23261 're-search-backward
23262 're-search-forward))
23263 (count (if arg (abs arg) 1))
23264 (result (point)))
23265 (while (and (prog1 (> count 0)
23266 (forward-char (if (and arg (< arg 0)) -1 1)))
23267 (funcall f org-outline-regexp-bol nil 'move))
23268 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23269 (cond ((< l level) (setq count 0))
23270 ((and (= l level)
23271 (or invisible-ok
23272 (progn
23273 (goto-char (line-beginning-position))
23274 (not (outline-invisible-p)))))
23275 (setq count (1- count))
23276 (when (eq l level)
23277 (setq result (point)))))))
23278 (goto-char result))
23279 (beginning-of-line 1)))
23281 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23282 "Move backward to the ARG'th subheading at same level as this one.
23283 Stop at the first and last subheadings of a superior heading."
23284 (interactive "p")
23285 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23287 (defun org-next-block (arg &optional backward block-regexp)
23288 "Jump to the next block.
23289 With a prefix argument ARG, jump forward ARG many source blocks.
23290 When BACKWARD is non-nil, jump to the previous block.
23291 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23292 (interactive "p")
23293 (let ((re (or block-regexp org-block-regexp))
23294 (re-search-fn (or (and backward 're-search-backward)
23295 're-search-forward)))
23296 (if (looking-at re) (forward-char 1))
23297 (condition-case nil
23298 (funcall re-search-fn re nil nil arg)
23299 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23300 (goto-char (match-beginning 0)) (org-show-context)))
23302 (defun org-previous-block (arg &optional block-regexp)
23303 "Jump to the previous block.
23304 With a prefix argument ARG, jump backward ARG many source blocks.
23305 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23306 (interactive "p")
23307 (org-next-block arg t block-regexp))
23309 (defun org-forward-paragraph ()
23310 "Move forward to beginning of next paragraph or equivalent.
23312 The function moves point to the beginning of the next visible
23313 structural element, which can be a paragraph, a table, a list
23314 item, etc. It also provides some special moves for convenience:
23316 - On an affiliated keyword, jump to the beginning of the
23317 relative element.
23318 - On an item or a footnote definition, move to the second
23319 element inside, if any.
23320 - On a table or a property drawer, jump after it.
23321 - On a verse or source block, stop after blank lines."
23322 (interactive)
23323 (when (eobp) (user-error "Cannot move further down"))
23324 (let* ((deactivate-mark nil)
23325 (element (org-element-at-point))
23326 (type (org-element-type element))
23327 (post-affiliated (org-element-property :post-affiliated element))
23328 (contents-begin (org-element-property :contents-begin element))
23329 (contents-end (org-element-property :contents-end element))
23330 (end (let ((end (org-element-property :end element)) (parent element))
23331 (while (and (setq parent (org-element-property :parent parent))
23332 (= (org-element-property :contents-end parent) end))
23333 (setq end (org-element-property :end parent)))
23334 end)))
23335 (cond ((not element)
23336 (skip-chars-forward " \r\t\n")
23337 (or (eobp) (beginning-of-line)))
23338 ;; On affiliated keywords, move to element's beginning.
23339 ((and post-affiliated (< (point) post-affiliated))
23340 (goto-char post-affiliated))
23341 ;; At a table row, move to the end of the table. Similarly,
23342 ;; at a node property, move to the end of the property
23343 ;; drawer.
23344 ((memq type '(node-property table-row))
23345 (goto-char (org-element-property
23346 :end (org-element-property :parent element))))
23347 ((memq type '(property-drawer table)) (goto-char end))
23348 ;; Consider blank lines as separators in verse and source
23349 ;; blocks to ease editing.
23350 ((memq type '(src-block verse-block))
23351 (when (eq type 'src-block)
23352 (setq contents-end
23353 (save-excursion (goto-char end)
23354 (skip-chars-backward " \r\t\n")
23355 (line-beginning-position))))
23356 (beginning-of-line)
23357 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23358 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23359 (goto-char end)
23360 (skip-chars-forward " \r\t\n")
23361 (if (= (point) contents-end) (goto-char end)
23362 (beginning-of-line))))
23363 ;; With no contents, just skip element.
23364 ((not contents-begin) (goto-char end))
23365 ;; If contents are invisible, skip the element altogether.
23366 ((outline-invisible-p (line-end-position))
23367 (case type
23368 (headline
23369 (org-with-limited-levels (outline-next-visible-heading 1)))
23370 ;; At a plain list, make sure we move to the next item
23371 ;; instead of skipping the whole list.
23372 (plain-list (forward-char)
23373 (org-forward-paragraph))
23374 (otherwise (goto-char end))))
23375 ((>= (point) contents-end) (goto-char end))
23376 ((>= (point) contents-begin)
23377 ;; This can only happen on paragraphs and plain lists.
23378 (case type
23379 (paragraph (goto-char end))
23380 ;; At a plain list, try to move to second element in
23381 ;; first item, if possible.
23382 (plain-list (end-of-line)
23383 (org-forward-paragraph))))
23384 ;; When contents start on the middle of a line (e.g. in
23385 ;; items and footnote definitions), try to reach first
23386 ;; element starting after current line.
23387 ((> (line-end-position) contents-begin)
23388 (end-of-line)
23389 (org-forward-paragraph))
23390 (t (goto-char contents-begin)))))
23392 (defun org-backward-paragraph ()
23393 "Move backward to start of previous paragraph or equivalent.
23395 The function moves point to the beginning of the current
23396 structural element, which can be a paragraph, a table, a list
23397 item, etc., or to the beginning of the previous visible one if
23398 point is already there. It also provides some special moves for
23399 convenience:
23401 - On an affiliated keyword, jump to the first one.
23402 - On a table or a property drawer, move to its beginning.
23403 - On a verse or source block, stop before blank lines."
23404 (interactive)
23405 (when (bobp) (user-error "Cannot move further up"))
23406 (let* ((deactivate-mark nil)
23407 (element (org-element-at-point))
23408 (type (org-element-type element))
23409 (contents-begin (org-element-property :contents-begin element))
23410 (contents-end (org-element-property :contents-end element))
23411 (post-affiliated (org-element-property :post-affiliated element))
23412 (begin (org-element-property :begin element)))
23413 (cond
23414 ((not element) (goto-char (point-min)))
23415 ((= (point) begin)
23416 (backward-char)
23417 (org-backward-paragraph))
23418 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23419 ((memq type '(node-property table-row))
23420 (goto-char (org-element-property
23421 :post-affiliated (org-element-property :parent element))))
23422 ((memq type '(property-drawer table)) (goto-char begin))
23423 ((memq type '(src-block verse-block))
23424 (when (eq type 'src-block)
23425 (setq contents-begin
23426 (save-excursion (goto-char begin) (forward-line) (point))))
23427 (if (= (point) contents-begin) (goto-char post-affiliated)
23428 ;; Inside a verse block, see blank lines as paragraph
23429 ;; separators.
23430 (let ((origin (point)))
23431 (skip-chars-backward " \r\t\n" contents-begin)
23432 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
23433 (skip-chars-forward " \r\t\n" origin)
23434 (if (= (point) origin) (goto-char contents-begin)
23435 (beginning-of-line))))))
23436 ((not contents-begin) (goto-char (or post-affiliated begin)))
23437 ((eq type 'paragraph)
23438 (goto-char contents-begin)
23439 ;; When at first paragraph in an item or a footnote definition,
23440 ;; move directly to beginning of line.
23441 (let ((parent-contents
23442 (org-element-property
23443 :contents-begin (org-element-property :parent element))))
23444 (when (and parent-contents (= parent-contents contents-begin))
23445 (beginning-of-line))))
23446 ;; At the end of a greater element, move to the beginning of the
23447 ;; last element within.
23448 ((>= (point) contents-end)
23449 (goto-char (1- contents-end))
23450 (org-backward-paragraph))
23451 (t (goto-char (or post-affiliated begin))))
23452 ;; Ensure we never leave point invisible.
23453 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23455 (defun org-forward-element ()
23456 "Move forward by one element.
23457 Move to the next element at the same level, when possible."
23458 (interactive)
23459 (cond ((eobp) (user-error "Cannot move further down"))
23460 ((org-with-limited-levels (org-at-heading-p))
23461 (let ((origin (point)))
23462 (goto-char (org-end-of-subtree nil t))
23463 (unless (org-with-limited-levels (org-at-heading-p))
23464 (goto-char origin)
23465 (user-error "Cannot move further down"))))
23467 (let* ((elem (org-element-at-point))
23468 (end (org-element-property :end elem))
23469 (parent (org-element-property :parent elem)))
23470 (cond ((and parent (= (org-element-property :contents-end parent) end))
23471 (goto-char (org-element-property :end parent)))
23472 ((integer-or-marker-p end) (goto-char end))
23473 (t (message "No element at point")))))))
23475 (defun org-backward-element ()
23476 "Move backward by one element.
23477 Move to the previous element at the same level, when possible."
23478 (interactive)
23479 (cond ((bobp) (user-error "Cannot move further up"))
23480 ((org-with-limited-levels (org-at-heading-p))
23481 ;; At a headline, move to the previous one, if any, or stay
23482 ;; here.
23483 (let ((origin (point)))
23484 (org-with-limited-levels (org-backward-heading-same-level 1))
23485 ;; When current headline has no sibling above, move to its
23486 ;; parent.
23487 (when (= (point) origin)
23488 (or (org-with-limited-levels (org-up-heading-safe))
23489 (progn (goto-char origin)
23490 (user-error "Cannot move further up"))))))
23492 (let* ((trail (org-element-at-point 'keep-trail))
23493 (elem (car trail))
23494 (prev-elem (nth 1 trail))
23495 (beg (org-element-property :begin elem)))
23496 (cond
23497 ;; Move to beginning of current element if point isn't
23498 ;; there already.
23499 ((null beg) (message "No element at point"))
23500 ((/= (point) beg) (goto-char beg))
23501 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23502 ((org-before-first-heading-p) (goto-char (point-min)))
23503 (t (org-back-to-heading)))))))
23505 (defun org-up-element ()
23506 "Move to upper element."
23507 (interactive)
23508 (if (org-with-limited-levels (org-at-heading-p))
23509 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23510 (let* ((elem (org-element-at-point))
23511 (parent (org-element-property :parent elem)))
23512 (if parent (goto-char (org-element-property :begin parent))
23513 (if (org-with-limited-levels (org-before-first-heading-p))
23514 (user-error "No surrounding element")
23515 (org-with-limited-levels (org-back-to-heading)))))))
23517 (defvar org-element-greater-elements)
23518 (defun org-down-element ()
23519 "Move to inner element."
23520 (interactive)
23521 (let ((element (org-element-at-point)))
23522 (cond
23523 ((memq (org-element-type element) '(plain-list table))
23524 (goto-char (org-element-property :contents-begin element))
23525 (forward-char))
23526 ((memq (org-element-type element) org-element-greater-elements)
23527 ;; If contents are hidden, first disclose them.
23528 (when (org-element-property :hiddenp element) (org-cycle))
23529 (goto-char (or (org-element-property :contents-begin element)
23530 (user-error "No content for this element"))))
23531 (t (user-error "No inner element")))))
23533 (defun org-drag-element-backward ()
23534 "Move backward element at point."
23535 (interactive)
23536 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23537 (let* ((trail (org-element-at-point 'keep-trail))
23538 (elem (car trail))
23539 (prev-elem (nth 1 trail)))
23540 ;; Error out if no previous element or previous element is
23541 ;; a parent of the current one.
23542 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23543 (user-error "Cannot drag element backward")
23544 (let ((pos (point)))
23545 (org-element-swap-A-B prev-elem elem)
23546 (goto-char (+ (org-element-property :begin prev-elem)
23547 (- pos (org-element-property :begin elem)))))))))
23549 (defun org-drag-element-forward ()
23550 "Move forward element at point."
23551 (interactive)
23552 (let* ((pos (point))
23553 (elem (org-element-at-point)))
23554 (when (= (point-max) (org-element-property :end elem))
23555 (user-error "Cannot drag element forward"))
23556 (goto-char (org-element-property :end elem))
23557 (let ((next-elem (org-element-at-point)))
23558 (when (or (org-element-nested-p elem next-elem)
23559 (and (eq (org-element-type next-elem) 'headline)
23560 (not (eq (org-element-type elem) 'headline))))
23561 (goto-char pos)
23562 (user-error "Cannot drag element forward"))
23563 ;; Compute new position of point: it's shifted by NEXT-ELEM
23564 ;; body's length (without final blanks) and by the length of
23565 ;; blanks between ELEM and NEXT-ELEM.
23566 (let ((size-next (- (save-excursion
23567 (goto-char (org-element-property :end next-elem))
23568 (skip-chars-backward " \r\t\n")
23569 (forward-line)
23570 ;; Small correction if buffer doesn't end
23571 ;; with a newline character.
23572 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23573 (org-element-property :begin next-elem)))
23574 (size-blank (- (org-element-property :end elem)
23575 (save-excursion
23576 (goto-char (org-element-property :end elem))
23577 (skip-chars-backward " \r\t\n")
23578 (forward-line)
23579 (point)))))
23580 (org-element-swap-A-B elem next-elem)
23581 (goto-char (+ pos size-next size-blank))))))
23583 (defun org-drag-line-forward (arg)
23584 "Drag the line at point ARG lines forward."
23585 (interactive "p")
23586 (dotimes (n (abs arg))
23587 (let ((c (current-column)))
23588 (if (< 0 arg)
23589 (progn
23590 (beginning-of-line 2)
23591 (transpose-lines 1)
23592 (beginning-of-line 0))
23593 (transpose-lines 1)
23594 (beginning-of-line -1))
23595 (org-move-to-column c))))
23597 (defun org-drag-line-backward (arg)
23598 "Drag the line at point ARG lines backward."
23599 (interactive "p")
23600 (org-drag-line-forward (- arg)))
23602 (defun org-mark-element ()
23603 "Put point at beginning of this element, mark at end.
23605 Interactively, if this command is repeated or (in Transient Mark
23606 mode) if the mark is active, it marks the next element after the
23607 ones already marked."
23608 (interactive)
23609 (let (deactivate-mark)
23610 (if (and (org-called-interactively-p 'any)
23611 (or (and (eq last-command this-command) (mark t))
23612 (and transient-mark-mode mark-active)))
23613 (set-mark
23614 (save-excursion
23615 (goto-char (mark))
23616 (goto-char (org-element-property :end (org-element-at-point)))))
23617 (let ((element (org-element-at-point)))
23618 (end-of-line)
23619 (push-mark (org-element-property :end element) t t)
23620 (goto-char (org-element-property :begin element))))))
23622 (defun org-narrow-to-element ()
23623 "Narrow buffer to current element."
23624 (interactive)
23625 (let ((elem (org-element-at-point)))
23626 (cond
23627 ((eq (car elem) 'headline)
23628 (narrow-to-region
23629 (org-element-property :begin elem)
23630 (org-element-property :end elem)))
23631 ((memq (car elem) org-element-greater-elements)
23632 (narrow-to-region
23633 (org-element-property :contents-begin elem)
23634 (org-element-property :contents-end elem)))
23636 (narrow-to-region
23637 (org-element-property :begin elem)
23638 (org-element-property :end elem))))))
23640 (defun org-transpose-element ()
23641 "Transpose current and previous elements, keeping blank lines between.
23642 Point is moved after both elements."
23643 (interactive)
23644 (org-skip-whitespace)
23645 (let ((end (org-element-property :end (org-element-at-point))))
23646 (org-drag-element-backward)
23647 (goto-char end)))
23649 (defun org-unindent-buffer ()
23650 "Un-indent the visible part of the buffer.
23651 Relative indentation (between items, inside blocks, etc.) isn't
23652 modified."
23653 (interactive)
23654 (unless (eq major-mode 'org-mode)
23655 (user-error "Cannot un-indent a buffer not in Org mode"))
23656 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23657 unindent-tree ; For byte-compiler.
23658 (unindent-tree
23659 (function
23660 (lambda (contents)
23661 (mapc
23662 (lambda (element)
23663 (if (memq (org-element-type element) '(headline section))
23664 (funcall unindent-tree (org-element-contents element))
23665 (save-excursion
23666 (save-restriction
23667 (narrow-to-region
23668 (org-element-property :begin element)
23669 (org-element-property :end element))
23670 (org-do-remove-indentation)))))
23671 (reverse contents))))))
23672 (funcall unindent-tree (org-element-contents parse-tree))))
23674 (defun org-show-subtree ()
23675 "Show everything after this heading at deeper levels."
23676 (interactive)
23677 (outline-flag-region
23678 (point)
23679 (save-excursion
23680 (org-end-of-subtree t t))
23681 nil))
23683 (defun org-show-entry ()
23684 "Show the body directly following this heading.
23685 Show the heading too, if it is currently invisible."
23686 (interactive)
23687 (save-excursion
23688 (condition-case nil
23689 (progn
23690 (org-back-to-heading t)
23691 (outline-flag-region
23692 (max (point-min) (1- (point)))
23693 (save-excursion
23694 (if (re-search-forward
23695 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
23696 (match-beginning 1)
23697 (point-max)))
23698 nil)
23699 (org-cycle-hide-drawers 'children))
23700 (error nil))))
23702 (defun org-make-options-regexp (kwds &optional extra)
23703 "Make a regular expression for keyword lines."
23704 (concat
23705 "^#\\+\\("
23706 (mapconcat 'regexp-quote kwds "\\|")
23707 (if extra (concat "\\|" extra))
23708 "\\):[ \t]*\\(.*\\)"))
23710 ;; Make isearch reveal the necessary context
23711 (defun org-isearch-end ()
23712 "Reveal context after isearch exits."
23713 (when isearch-success ; only if search was successful
23714 (if (featurep 'xemacs)
23715 ;; Under XEmacs, the hook is run in the correct place,
23716 ;; we directly show the context.
23717 (org-show-context 'isearch)
23718 ;; In Emacs the hook runs *before* restoring the overlays.
23719 ;; So we have to use a one-time post-command-hook to do this.
23720 ;; (Emacs 22 has a special variable, see function `org-mode')
23721 (unless (and (boundp 'isearch-mode-end-hook-quit)
23722 isearch-mode-end-hook-quit)
23723 ;; Only when the isearch was not quitted.
23724 (org-add-hook 'post-command-hook 'org-isearch-post-command
23725 'append 'local)))
23726 (org-fix-ellipsis-at-bol)))
23728 (defun org-isearch-post-command ()
23729 "Remove self from hook, and show context."
23730 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23731 (org-show-context 'isearch))
23734 ;;;; Integration with and fixes for other packages
23736 ;;; Imenu support
23738 (defvar org-imenu-markers nil
23739 "All markers currently used by Imenu.")
23740 (make-variable-buffer-local 'org-imenu-markers)
23742 (defun org-imenu-new-marker (&optional pos)
23743 "Return a new marker for use by Imenu, and remember the marker."
23744 (let ((m (make-marker)))
23745 (move-marker m (or pos (point)))
23746 (push m org-imenu-markers)
23749 (defun org-imenu-get-tree ()
23750 "Produce the index for Imenu."
23751 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23752 (setq org-imenu-markers nil)
23753 (let* ((n org-imenu-depth)
23754 (re (concat "^" (org-get-limited-outline-regexp)))
23755 (subs (make-vector (1+ n) nil))
23756 (last-level 0)
23757 m level head0 head)
23758 (save-excursion
23759 (save-restriction
23760 (widen)
23761 (goto-char (point-max))
23762 (while (re-search-backward re nil t)
23763 (setq level (org-reduced-level (funcall outline-level)))
23764 (when (and (<= level n)
23765 (looking-at org-complex-heading-regexp)
23766 (setq head0 (org-match-string-no-properties 4)))
23767 (setq head (org-link-display-format head0)
23768 m (org-imenu-new-marker))
23769 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23770 (if (>= level last-level)
23771 (push (cons head m) (aref subs level))
23772 (push (cons head (aref subs (1+ level))) (aref subs level))
23773 (loop for i from (1+ level) to n do (aset subs i nil)))
23774 (setq last-level level)))))
23775 (aref subs 1)))
23777 (eval-after-load "imenu"
23778 '(progn
23779 (add-hook 'imenu-after-jump-hook
23780 (lambda ()
23781 (if (derived-mode-p 'org-mode)
23782 (org-show-context 'org-goto))))))
23784 (defun org-link-display-format (link)
23785 "Replace a link with its the description.
23786 If there is no description, use the link target."
23787 (save-match-data
23788 (if (string-match org-bracket-link-analytic-regexp link)
23789 (replace-match (if (match-end 5)
23790 (match-string 5 link)
23791 (concat (match-string 1 link)
23792 (match-string 3 link)))
23793 nil t link)
23794 link)))
23796 (defun org-toggle-link-display ()
23797 "Toggle the literal or descriptive display of links."
23798 (interactive)
23799 (if org-descriptive-links
23800 (progn (org-remove-from-invisibility-spec '(org-link))
23801 (org-restart-font-lock)
23802 (setq org-descriptive-links nil))
23803 (progn (add-to-invisibility-spec '(org-link))
23804 (org-restart-font-lock)
23805 (setq org-descriptive-links t))))
23807 ;; Speedbar support
23809 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23810 "Overlay marking the agenda restriction line in speedbar.")
23811 (overlay-put org-speedbar-restriction-lock-overlay
23812 'face 'org-agenda-restriction-lock)
23813 (overlay-put org-speedbar-restriction-lock-overlay
23814 'help-echo "Agendas are currently limited to this item.")
23815 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23817 (defun org-speedbar-set-agenda-restriction ()
23818 "Restrict future agenda commands to the location at point in speedbar.
23819 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
23820 (interactive)
23821 (require 'org-agenda)
23822 (let (p m tp np dir txt)
23823 (cond
23824 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23825 'org-imenu t))
23826 (setq m (get-text-property p 'org-imenu-marker))
23827 (with-current-buffer (marker-buffer m)
23828 (goto-char m)
23829 (org-agenda-set-restriction-lock 'subtree)))
23830 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23831 'speedbar-function 'speedbar-find-file))
23832 (setq tp (previous-single-property-change
23833 (1+ p) 'speedbar-function)
23834 np (next-single-property-change
23835 tp 'speedbar-function)
23836 dir (speedbar-line-directory)
23837 txt (buffer-substring-no-properties (or tp (point-min))
23838 (or np (point-max))))
23839 (with-current-buffer (find-file-noselect
23840 (let ((default-directory dir))
23841 (expand-file-name txt)))
23842 (unless (derived-mode-p 'org-mode)
23843 (user-error "Cannot restrict to non-Org-mode file"))
23844 (org-agenda-set-restriction-lock 'file)))
23845 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23846 (move-overlay org-speedbar-restriction-lock-overlay
23847 (point-at-bol) (point-at-eol))
23848 (setq current-prefix-arg nil)
23849 (org-agenda-maybe-redo)))
23851 (defvar speedbar-file-key-map)
23852 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23853 (eval-after-load "speedbar"
23854 '(progn
23855 (speedbar-add-supported-extension ".org")
23856 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23857 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23858 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23859 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23860 (add-hook 'speedbar-visiting-tag-hook
23861 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23863 ;;; Fixes and Hacks for problems with other packages
23865 ;; Make flyspell not check words in links, to not mess up our keymap
23866 (defvar org-element-affiliated-keywords) ; From org-element.el
23867 (defvar org-element-block-name-alist) ; From org-element.el
23868 (defun org-mode-flyspell-verify ()
23869 "Don't let flyspell put overlays at active buttons, or on
23870 {todo,all-time,additional-option-like}-keywords."
23871 (require 'org-element) ; For `org-element-affiliated-keywords'
23872 (let ((pos (max (1- (point)) (point-min)))
23873 (word (thing-at-point 'word)))
23874 (and (not (get-text-property pos 'keymap))
23875 (not (get-text-property pos 'org-no-flyspell))
23876 (not (member word org-todo-keywords-1))
23877 (not (member word org-all-time-keywords))
23878 (not (member word org-options-keywords))
23879 (not (member word (mapcar 'car org-startup-options)))
23880 (not (member-ignore-case word org-element-affiliated-keywords))
23881 (not (member-ignore-case word (org-get-export-keywords)))
23882 (not (member-ignore-case
23883 word (mapcar 'car org-element-block-name-alist)))
23884 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23885 (not (org-in-src-block-p)))))
23887 (defun org-remove-flyspell-overlays-in (beg end)
23888 "Remove flyspell overlays in region."
23889 (and (org-bound-and-true-p flyspell-mode)
23890 (fboundp 'flyspell-delete-region-overlays)
23891 (flyspell-delete-region-overlays beg end))
23892 (add-text-properties beg end '(org-no-flyspell t)))
23894 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23895 (eval-after-load "bookmark"
23896 '(if (boundp 'bookmark-after-jump-hook)
23897 ;; We can use the hook
23898 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23899 ;; Hook not available, use advice
23900 (defadvice bookmark-jump (after org-make-visible activate)
23901 "Make the position visible."
23902 (org-bookmark-jump-unhide))))
23904 ;; Make sure saveplace shows the location if it was hidden
23905 (eval-after-load "saveplace"
23906 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23907 "Make the position visible."
23908 (org-bookmark-jump-unhide)))
23910 ;; Make sure ecb shows the location if it was hidden
23911 (eval-after-load "ecb"
23912 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23913 "Make hierarchy visible when jumping into location from ECB tree buffer."
23914 (if (derived-mode-p 'org-mode)
23915 (org-show-context))))
23917 (defun org-bookmark-jump-unhide ()
23918 "Unhide the current position, to show the bookmark location."
23919 (and (derived-mode-p 'org-mode)
23920 (or (outline-invisible-p)
23921 (save-excursion (goto-char (max (point-min) (1- (point))))
23922 (outline-invisible-p)))
23923 (org-show-context 'bookmark-jump)))
23925 ;; Make session.el ignore our circular variable
23926 (defvar session-globals-exclude)
23927 (eval-after-load "session"
23928 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23930 ;;;; Finish up
23932 (provide 'org)
23934 (run-hooks 'org-load-hook)
23936 ;;; org.el ends here