org.el (org-store-link): Fix bugs
[org-mode.git] / lisp / org.el
bloba6ab3199b366ef09495c40d6d2fc2cc613734610
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-verbatim verbatim)
4124 ("~" org-code 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 (defgroup org-archive nil
4386 "Options concerning archiving in Org-mode."
4387 :tag "Org Archive"
4388 :group 'org-structure)
4390 (defcustom org-archive-location "%s_archive::"
4391 "The location where subtrees should be archived.
4393 The value of this variable is a string, consisting of two parts,
4394 separated by a double-colon. The first part is a filename and
4395 the second part is a headline.
4397 When the filename is omitted, archiving happens in the same file.
4398 %s in the filename will be replaced by the current file
4399 name (without the directory part). Archiving to a different file
4400 is useful to keep archived entries from contributing to the
4401 Org-mode Agenda.
4403 The archived entries will be filed as subtrees of the specified
4404 headline. When the headline is omitted, the subtrees are simply
4405 filed away at the end of the file, as top-level entries. Also in
4406 the heading you can use %s to represent the file name, this can be
4407 useful when using the same archive for a number of different files.
4409 Here are a few examples:
4410 \"%s_archive::\"
4411 If the current file is Projects.org, archive in file
4412 Projects.org_archive, as top-level trees. This is the default.
4414 \"::* Archived Tasks\"
4415 Archive in the current file, under the top-level headline
4416 \"* Archived Tasks\".
4418 \"~/org/archive.org::\"
4419 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4421 \"~/org/archive.org::* From %s\"
4422 Archive in file ~/org/archive.org (absolute path), under headlines
4423 \"From FILENAME\" where file name is the current file name.
4425 \"~/org/datetree.org::datetree/* Finished Tasks\"
4426 The \"datetree/\" string is special, signifying to archive
4427 items to the datetree. Items are placed in either the CLOSED
4428 date of the item, or the current date if there is no CLOSED date.
4429 The heading will be a subentry to the current date. There doesn't
4430 need to be a heading, but there always needs to be a slash after
4431 datetree. For example, to store archived items directly in the
4432 datetree, use \"~/org/datetree.org::datetree/\".
4434 \"basement::** Finished Tasks\"
4435 Archive in file ./basement (relative path), as level 3 trees
4436 below the level 2 heading \"** Finished Tasks\".
4438 You may set this option on a per-file basis by adding to the buffer a
4439 line like
4441 #+ARCHIVE: basement::** Finished Tasks
4443 You may also define it locally for a subtree by setting an ARCHIVE property
4444 in the entry. If such a property is found in an entry, or anywhere up
4445 the hierarchy, it will be used."
4446 :group 'org-archive
4447 :type 'string)
4449 (defcustom org-archive-tag "ARCHIVE"
4450 "The tag that marks a subtree as archived.
4451 An archived subtree does not open during visibility cycling, and does
4452 not contribute to the agenda listings.
4453 After changing this, font-lock must be restarted in the relevant buffers to
4454 get the proper fontification."
4455 :group 'org-archive
4456 :group 'org-keywords
4457 :type 'string)
4459 (defcustom org-agenda-skip-archived-trees t
4460 "Non-nil means the agenda will skip any items located in archived trees.
4461 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4462 variable is no longer recommended, you should leave it at the value t.
4463 Instead, use the key `v' to cycle the archives-mode in the agenda."
4464 :group 'org-archive
4465 :group 'org-agenda-skip
4466 :type 'boolean)
4468 (defcustom org-columns-skip-archived-trees t
4469 "Non-nil means ignore archived trees when creating column view."
4470 :group 'org-archive
4471 :group 'org-properties
4472 :type 'boolean)
4474 (defcustom org-cycle-open-archived-trees nil
4475 "Non-nil means `org-cycle' will open archived trees.
4476 An archived tree is a tree marked with the tag ARCHIVE.
4477 When nil, archived trees will stay folded. You can still open them with
4478 normal outline commands like `show-all', but not with the cycling commands."
4479 :group 'org-archive
4480 :group 'org-cycle
4481 :type 'boolean)
4483 (defcustom org-sparse-tree-open-archived-trees nil
4484 "Non-nil means sparse tree construction shows matches in archived trees.
4485 When nil, matches in these trees are highlighted, but the trees are kept in
4486 collapsed state."
4487 :group 'org-archive
4488 :group 'org-sparse-trees
4489 :type 'boolean)
4491 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4492 "The default date type when building a sparse tree.
4493 When this is nil, a date is a scheduled or a deadline timestamp.
4494 Otherwise, these types are allowed:
4496 all: all timestamps
4497 active: only active timestamps (<...>)
4498 inactive: only inactive timestamps (<...)
4499 scheduled: only scheduled timestamps
4500 deadline: only deadline timestamps"
4501 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4502 (const :tag "All timestamps" all)
4503 (const :tag "Only active timestamps" active)
4504 (const :tag "Only inactive timestamps" inactive)
4505 (const :tag "Only scheduled timestamps" scheduled)
4506 (const :tag "Only deadline timestamps" deadline)
4507 (const :tag "Only closed timestamps" closed))
4508 :version "24.3"
4509 :group 'org-sparse-trees)
4511 (defun org-cycle-hide-archived-subtrees (state)
4512 "Re-hide all archived subtrees after a visibility state change."
4513 (when (and (not org-cycle-open-archived-trees)
4514 (not (memq state '(overview folded))))
4515 (save-excursion
4516 (let* ((globalp (memq state '(contents all)))
4517 (beg (if globalp (point-min) (point)))
4518 (end (if globalp (point-max) (org-end-of-subtree t))))
4519 (org-hide-archived-subtrees beg end)
4520 (goto-char beg)
4521 (if (looking-at (concat ".*:" org-archive-tag ":"))
4522 (message "%s" (substitute-command-keys
4523 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4525 (defun org-force-cycle-archived ()
4526 "Cycle subtree even if it is archived."
4527 (interactive)
4528 (setq this-command 'org-cycle)
4529 (let ((org-cycle-open-archived-trees t))
4530 (call-interactively 'org-cycle)))
4532 (defun org-hide-archived-subtrees (beg end)
4533 "Re-hide all archived subtrees after a visibility state change."
4534 (save-excursion
4535 (let* ((re (concat ":" org-archive-tag ":")))
4536 (goto-char beg)
4537 (while (re-search-forward re end t)
4538 (when (org-at-heading-p)
4539 (org-flag-subtree t)
4540 (org-end-of-subtree t))))))
4542 (declare-function outline-end-of-heading "outline" ())
4543 (declare-function outline-flag-region "outline" (from to flag))
4544 (defun org-flag-subtree (flag)
4545 (save-excursion
4546 (org-back-to-heading t)
4547 (outline-end-of-heading)
4548 (outline-flag-region (point)
4549 (progn (org-end-of-subtree t) (point))
4550 flag)))
4552 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4554 ;; Declare Column View Code
4556 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4557 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4558 (declare-function org-columns-compute "org-colview" (property))
4560 ;; Declare ID code
4562 (declare-function org-id-store-link "org-id")
4563 (declare-function org-id-locations-load "org-id")
4564 (declare-function org-id-locations-save "org-id")
4565 (defvar org-id-track-globally)
4567 ;;; Variables for pre-computed regular expressions, all buffer local
4569 (defvar org-drawer-regexp "^[ \t]*:PROPERTIES:[ \t]*$"
4570 "Matches first line of a hidden block.")
4571 (make-variable-buffer-local 'org-drawer-regexp)
4572 (defvar org-todo-regexp nil
4573 "Matches any of the TODO state keywords.")
4574 (make-variable-buffer-local 'org-todo-regexp)
4575 (defvar org-not-done-regexp nil
4576 "Matches any of the TODO state keywords except the last one.")
4577 (make-variable-buffer-local 'org-not-done-regexp)
4578 (defvar org-not-done-heading-regexp nil
4579 "Matches a TODO headline that is not done.")
4580 (make-variable-buffer-local 'org-not-done-regexp)
4581 (defvar org-todo-line-regexp nil
4582 "Matches a headline and puts TODO state into group 2 if present.")
4583 (make-variable-buffer-local 'org-todo-line-regexp)
4584 (defvar org-complex-heading-regexp nil
4585 "Matches a headline and puts everything into groups:
4586 group 1: the stars
4587 group 2: The todo keyword, maybe
4588 group 3: Priority cookie
4589 group 4: True headline
4590 group 5: Tags")
4591 (make-variable-buffer-local 'org-complex-heading-regexp)
4592 (defvar org-complex-heading-regexp-format nil
4593 "Printf format to make regexp to match an exact headline.
4594 This regexp will match the headline of any node which has the
4595 exact headline text that is put into the format, but may have any
4596 TODO state, priority and tags.")
4597 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4598 (defvar org-todo-line-tags-regexp nil
4599 "Matches a headline and puts TODO state into group 2 if present.
4600 Also put tags into group 4 if tags are present.")
4601 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4602 (defvar org-ds-keyword-length 12
4603 "Maximum length of the DEADLINE and SCHEDULED keywords.")
4604 (make-variable-buffer-local 'org-ds-keyword-length)
4605 (defvar org-deadline-regexp nil
4606 "Matches the DEADLINE keyword.")
4607 (make-variable-buffer-local 'org-deadline-regexp)
4608 (defvar org-deadline-time-regexp nil
4609 "Matches the DEADLINE keyword together with a time stamp.")
4610 (make-variable-buffer-local 'org-deadline-time-regexp)
4611 (defvar org-deadline-time-hour-regexp nil
4612 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
4613 (make-variable-buffer-local 'org-deadline-time-hour-regexp)
4614 (defvar org-deadline-line-regexp nil
4615 "Matches the DEADLINE keyword and the rest of the line.")
4616 (make-variable-buffer-local 'org-deadline-line-regexp)
4617 (defvar org-scheduled-regexp nil
4618 "Matches the SCHEDULED keyword.")
4619 (make-variable-buffer-local 'org-scheduled-regexp)
4620 (defvar org-scheduled-time-regexp nil
4621 "Matches the SCHEDULED keyword together with a time stamp.")
4622 (make-variable-buffer-local 'org-scheduled-time-regexp)
4623 (defvar org-scheduled-time-hour-regexp nil
4624 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
4625 (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
4626 (defvar org-closed-time-regexp nil
4627 "Matches the CLOSED keyword together with a time stamp.")
4628 (make-variable-buffer-local 'org-closed-time-regexp)
4630 (defvar org-keyword-time-regexp nil
4631 "Matches any of the 4 keywords, together with the time stamp.")
4632 (make-variable-buffer-local 'org-keyword-time-regexp)
4633 (defvar org-keyword-time-not-clock-regexp nil
4634 "Matches any of the 3 keywords, together with the time stamp.")
4635 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
4636 (defvar org-maybe-keyword-time-regexp nil
4637 "Matches a timestamp, possibly preceded by a keyword.")
4638 (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
4639 (defvar org-all-time-keywords nil
4640 "List of time keywords.")
4641 (make-variable-buffer-local 'org-all-time-keywords)
4643 (defconst org-plain-time-of-day-regexp
4644 (concat
4645 "\\(\\<[012]?[0-9]"
4646 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4647 "\\(--?"
4648 "\\(\\<[012]?[0-9]"
4649 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4650 "\\)?")
4651 "Regular expression to match a plain time or time range.
4652 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4653 groups carry important information:
4654 0 the full match
4655 1 the first time, range or not
4656 8 the second time, if it is a range.")
4658 (defconst org-plain-time-extension-regexp
4659 (concat
4660 "\\(\\<[012]?[0-9]"
4661 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4662 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4663 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4664 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4665 groups carry important information:
4666 0 the full match
4667 7 hours of duration
4668 9 minutes of duration")
4670 (defconst org-stamp-time-of-day-regexp
4671 (concat
4672 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4673 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4674 "\\(--?"
4675 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4676 "Regular expression to match a timestamp time or time range.
4677 After a match, the following groups carry important information:
4678 0 the full match
4679 1 date plus weekday, for back referencing to make sure both times are on the same day
4680 2 the first time, range or not
4681 4 the second time, if it is a range.")
4683 (defconst org-startup-options
4684 '(("fold" org-startup-folded t)
4685 ("overview" org-startup-folded t)
4686 ("nofold" org-startup-folded nil)
4687 ("showall" org-startup-folded nil)
4688 ("showeverything" org-startup-folded showeverything)
4689 ("content" org-startup-folded content)
4690 ("indent" org-startup-indented t)
4691 ("noindent" org-startup-indented nil)
4692 ("hidestars" org-hide-leading-stars t)
4693 ("showstars" org-hide-leading-stars nil)
4694 ("odd" org-odd-levels-only t)
4695 ("oddeven" org-odd-levels-only nil)
4696 ("align" org-startup-align-all-tables t)
4697 ("noalign" org-startup-align-all-tables nil)
4698 ("inlineimages" org-startup-with-inline-images t)
4699 ("noinlineimages" org-startup-with-inline-images nil)
4700 ("latexpreview" org-startup-with-latex-preview t)
4701 ("nolatexpreview" org-startup-with-latex-preview nil)
4702 ("customtime" org-display-custom-times t)
4703 ("logdone" org-log-done time)
4704 ("lognotedone" org-log-done note)
4705 ("nologdone" org-log-done nil)
4706 ("lognoteclock-out" org-log-note-clock-out t)
4707 ("nolognoteclock-out" org-log-note-clock-out nil)
4708 ("logrepeat" org-log-repeat state)
4709 ("lognoterepeat" org-log-repeat note)
4710 ("logdrawer" org-log-into-drawer t)
4711 ("nologdrawer" org-log-into-drawer nil)
4712 ("logstatesreversed" org-log-states-order-reversed t)
4713 ("nologstatesreversed" org-log-states-order-reversed nil)
4714 ("nologrepeat" org-log-repeat nil)
4715 ("logreschedule" org-log-reschedule time)
4716 ("lognotereschedule" org-log-reschedule note)
4717 ("nologreschedule" org-log-reschedule nil)
4718 ("logredeadline" org-log-redeadline time)
4719 ("lognoteredeadline" org-log-redeadline note)
4720 ("nologredeadline" org-log-redeadline nil)
4721 ("logrefile" org-log-refile time)
4722 ("lognoterefile" org-log-refile note)
4723 ("nologrefile" org-log-refile nil)
4724 ("fninline" org-footnote-define-inline t)
4725 ("nofninline" org-footnote-define-inline nil)
4726 ("fnlocal" org-footnote-section nil)
4727 ("fnauto" org-footnote-auto-label t)
4728 ("fnprompt" org-footnote-auto-label nil)
4729 ("fnconfirm" org-footnote-auto-label confirm)
4730 ("fnplain" org-footnote-auto-label plain)
4731 ("fnadjust" org-footnote-auto-adjust t)
4732 ("nofnadjust" org-footnote-auto-adjust nil)
4733 ("constcgs" constants-unit-system cgs)
4734 ("constSI" constants-unit-system SI)
4735 ("noptag" org-tag-persistent-alist nil)
4736 ("hideblocks" org-hide-block-startup t)
4737 ("nohideblocks" org-hide-block-startup nil)
4738 ("beamer" org-startup-with-beamer-mode t)
4739 ("entitiespretty" org-pretty-entities t)
4740 ("entitiesplain" org-pretty-entities nil))
4741 "Variable associated with STARTUP options for org-mode.
4742 Each element is a list of three items: the startup options (as written
4743 in the #+STARTUP line), the corresponding variable, and the value to set
4744 this variable to if the option is found. An optional forth element PUSH
4745 means to push this value onto the list in the variable.")
4747 (defun org-update-property-plist (key val props)
4748 "Update PROPS with KEY and VAL."
4749 (let* ((appending (string= "+" (substring key (- (length key) 1))))
4750 (key (if appending (substring key 0 (- (length key) 1)) key))
4751 (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
4752 (previous (cdr (assoc key props))))
4753 (if appending
4754 (cons (cons key (if previous (concat previous " " val) val)) remainder)
4755 (cons (cons key val) remainder))))
4757 (defconst org-block-regexp
4758 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
4759 "Regular expression for hiding blocks.")
4760 (defconst org-heading-keyword-regexp-format
4761 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
4762 "Printf format for a regexp matching a headline with some keyword.
4763 This regexp will match the headline of any node which has the
4764 exact keyword that is put into the format. The keyword isn't in
4765 any group by default, but the stars and the body are.")
4766 (defconst org-heading-keyword-maybe-regexp-format
4767 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
4768 "Printf format for a regexp matching a headline, possibly with some keyword.
4769 This regexp can match any headline with the specified keyword, or
4770 without a keyword. The keyword isn't in any group by default,
4771 but the stars and the body are.")
4773 (defcustom org-group-tags t
4774 "When non-nil (the default), use group tags.
4775 This can be turned on/off through `org-toggle-tags-groups'."
4776 :group 'org-tags
4777 :group 'org-startup
4778 :type 'boolean)
4780 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4782 (defun org-toggle-tags-groups ()
4783 "Toggle support for group tags.
4784 Support for group tags is controlled by the option
4785 `org-group-tags', which is non-nil by default."
4786 (interactive)
4787 (setq org-group-tags (not org-group-tags))
4788 (cond ((and (derived-mode-p 'org-agenda-mode)
4789 org-group-tags)
4790 (org-agenda-redo))
4791 ((derived-mode-p 'org-mode)
4792 (let ((org-inhibit-startup t)) (org-mode))))
4793 (message "Groups tags support has been turned %s"
4794 (if org-group-tags "on" "off")))
4796 (defun org-set-regexps-and-options-for-tags ()
4797 "Precompute variables used for tags."
4798 (when (derived-mode-p 'org-mode)
4799 (org-set-local 'org-file-tags nil)
4800 (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
4801 (splitre "[ \t]+")
4802 (start 0)
4803 tags ftags key value)
4804 (save-excursion
4805 (save-restriction
4806 (widen)
4807 (goto-char (point-min))
4808 (while (re-search-forward re nil t)
4809 (setq key (upcase (org-match-string-no-properties 1))
4810 value (org-match-string-no-properties 2))
4811 (if (stringp value) (setq value (org-trim value)))
4812 (cond
4813 ((equal key "TAGS")
4814 (setq tags (append tags (if tags '("\\n") nil)
4815 (org-split-string value splitre))))
4816 ((equal key "FILETAGS")
4817 (when (string-match "\\S-" value)
4818 (setq ftags
4819 (append
4820 ftags
4821 (apply 'append
4822 (mapcar (lambda (x) (org-split-string x ":"))
4823 (org-split-string value)))))))))))
4824 ;; Process the file tags.
4825 (and ftags (org-set-local 'org-file-tags
4826 (mapcar 'org-add-prop-inherited ftags)))
4827 (org-set-local 'org-tag-groups-alist nil)
4828 ;; Process the tags.
4829 (when (and (not tags) org-tag-alist)
4830 (setq tags
4831 (mapcar
4832 (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
4833 ((eq (car tg) :endgroup) "}")
4834 ((eq (car tg) :grouptags) ":")
4835 ((eq (car tg) :newline) "\n")
4836 (t (concat (car tg)
4837 (if (characterp (cdr tg))
4838 (format "(%s)" (char-to-string (cdr tg))) "")))))
4839 org-tag-alist)))
4840 (let (e tgs g)
4841 (while (setq e (pop tags))
4842 (cond
4843 ((equal e "{")
4844 (progn (push '(:startgroup) tgs)
4845 (when (equal (nth 1 tags) ":")
4846 (push (list (replace-regexp-in-string
4847 "(.+)$" "" (nth 0 tags)))
4848 org-tag-groups-alist)
4849 (setq g 0))))
4850 ((equal e ":") (push '(:grouptags) tgs))
4851 ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
4852 ((equal e "\\n") (push '(:newline) tgs))
4853 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
4854 (push (cons (match-string 1 e)
4855 (string-to-char (match-string 2 e))) tgs)
4856 (if (and g (> g 0))
4857 (setcar org-tag-groups-alist
4858 (append (car org-tag-groups-alist)
4859 (list (match-string 1 e)))))
4860 (if g (setq g (1+ g))))
4861 (t (push (list e) tgs)
4862 (if (and g (> g 0))
4863 (setcar org-tag-groups-alist
4864 (append (car org-tag-groups-alist) (list e))))
4865 (if g (setq g (1+ g))))))
4866 (org-set-local 'org-tag-alist nil)
4867 (while (setq e (pop tgs))
4868 (or (and (stringp (car e))
4869 (assoc (car e) org-tag-alist))
4870 (push e org-tag-alist)))
4871 ;; Return a list with tag variables
4872 (list org-file-tags org-tag-alist org-tag-groups-alist)))))
4874 (defvar org-ota nil)
4875 (defun org-set-regexps-and-options ()
4876 "Precompute regular expressions used in the current buffer."
4877 (when (derived-mode-p 'org-mode)
4878 (org-set-local 'org-todo-kwd-alist nil)
4879 (org-set-local 'org-todo-key-alist nil)
4880 (org-set-local 'org-todo-key-trigger nil)
4881 (org-set-local 'org-todo-keywords-1 nil)
4882 (org-set-local 'org-done-keywords nil)
4883 (org-set-local 'org-todo-heads nil)
4884 (org-set-local 'org-todo-sets nil)
4885 (org-set-local 'org-todo-log-states nil)
4886 (org-set-local 'org-file-properties nil)
4887 (let ((re (org-make-options-regexp
4888 '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
4889 "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
4890 "SETUPFILE" "OPTIONS")
4891 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
4892 (splitre "[ \t]+")
4893 (scripts org-use-sub-superscripts)
4894 kwds kws0 kwsa key log value cat arch const links hw dws
4895 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4896 (start 0))
4897 (save-excursion
4898 (save-restriction
4899 (widen)
4900 (goto-char (point-min))
4901 (while
4902 (or (and
4903 ext-setup-or-nil
4904 (not org-ota)
4905 (let (ret)
4906 (with-temp-buffer
4907 (insert ext-setup-or-nil)
4908 (let ((major-mode 'org-mode) org-ota)
4909 (setq ret (save-match-data
4910 (org-set-regexps-and-options-for-tags)))))
4911 ;; Append setupfile tags to existing tags
4912 (setq org-ota t)
4913 (setq org-file-tags
4914 (delq nil (append org-file-tags (nth 0 ret)))
4915 org-tag-alist
4916 (delq nil (append org-tag-alist (nth 1 ret)))
4917 org-tag-groups-alist
4918 (delq nil (append org-tag-groups-alist (nth 2 ret))))))
4919 (and ext-setup-or-nil
4920 (string-match re ext-setup-or-nil start)
4921 (setq start (match-end 0)))
4922 (and (setq ext-setup-or-nil nil start 0)
4923 (re-search-forward re nil t)))
4924 (setq key (upcase (match-string 1 ext-setup-or-nil))
4925 value (org-match-string-no-properties 2 ext-setup-or-nil))
4926 (if (stringp value) (setq value (org-trim value)))
4927 (cond
4928 ((equal key "CATEGORY")
4929 (setq cat value))
4930 ((member key '("SEQ_TODO" "TODO"))
4931 (push (cons 'sequence (org-split-string value splitre)) kwds))
4932 ((equal key "TYP_TODO")
4933 (push (cons 'type (org-split-string value splitre)) kwds))
4934 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
4935 ;; general TODO-like setup
4936 (push (cons (intern (downcase (match-string 1 key)))
4937 (org-split-string value splitre)) kwds))
4938 ((equal key "COLUMNS")
4939 (org-set-local 'org-columns-default-format value))
4940 ((equal key "LINK")
4941 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
4942 (push (cons (match-string 1 value)
4943 (org-trim (match-string 2 value)))
4944 links)))
4945 ((equal key "PRIORITIES")
4946 (setq prio (org-split-string value " +")))
4947 ((equal key "PROPERTY")
4948 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
4949 (setq props (org-update-property-plist (match-string 1 value)
4950 (match-string 2 value)
4951 props))))
4952 ((equal key "DRAWERS")
4953 (setq drawers (delete-dups (append org-drawers (org-split-string value splitre)))))
4954 ((equal key "CONSTANTS")
4955 (org-table-set-constants))
4956 ((equal key "STARTUP")
4957 (let ((opts (org-split-string value splitre))
4958 l var val)
4959 (while (setq l (pop opts))
4960 (when (setq l (assoc l org-startup-options))
4961 (setq var (nth 1 l) val (nth 2 l))
4962 (if (not (nth 3 l))
4963 (set (make-local-variable var) val)
4964 (if (not (listp (symbol-value var)))
4965 (set (make-local-variable var) nil))
4966 (set (make-local-variable var) (symbol-value var))
4967 (add-to-list var val))))))
4968 ((equal key "ARCHIVE")
4969 (setq arch value)
4970 (remove-text-properties 0 (length arch)
4971 '(face t fontified t) arch))
4972 ((equal key "OPTIONS")
4973 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
4974 (setq scripts (read (match-string 2 value)))))
4975 ((and (equal key "SETUPFILE")
4976 ;; Prevent checking in Gnus messages
4977 (not buffer-read-only))
4978 (setq setup-contents (org-file-contents
4979 (expand-file-name
4980 (org-remove-double-quotes value))
4981 'noerror))
4982 (if (not ext-setup-or-nil)
4983 (setq ext-setup-or-nil setup-contents start 0)
4984 (setq ext-setup-or-nil
4985 (concat (substring ext-setup-or-nil 0 start)
4986 "\n" setup-contents "\n"
4987 (substring ext-setup-or-nil start)))))))
4988 ;; search for property blocks
4989 (goto-char (point-min))
4990 (while (re-search-forward org-block-regexp nil t)
4991 (when (equal "PROPERTY" (upcase (match-string 1)))
4992 (setq value (replace-regexp-in-string
4993 "[\n\r]" " " (match-string 4)))
4994 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
4995 (setq props (org-update-property-plist (match-string 1 value)
4996 (match-string 2 value)
4997 props)))))))
4998 (org-set-local 'org-use-sub-superscripts scripts)
4999 (when cat
5000 (org-set-local 'org-category (intern cat))
5001 (push (cons "CATEGORY" cat) props))
5002 (when prio
5003 (if (< (length prio) 3) (setq prio '("A" "C" "B")))
5004 (setq prio (mapcar 'string-to-char prio))
5005 (org-set-local 'org-highest-priority (nth 0 prio))
5006 (org-set-local 'org-lowest-priority (nth 1 prio))
5007 (org-set-local 'org-default-priority (nth 2 prio)))
5008 (and props (org-set-local 'org-file-properties (nreverse props)))
5009 (and drawers (org-set-local 'org-drawers drawers))
5010 (and arch (org-set-local 'org-archive-location arch))
5011 (and links (setq org-link-abbrev-alist-local (nreverse links)))
5012 ;; Process the TODO keywords
5013 (unless kwds
5014 ;; Use the global values as if they had been given locally.
5015 (setq kwds (default-value 'org-todo-keywords))
5016 (if (stringp (car kwds))
5017 (setq kwds (list (cons org-todo-interpretation
5018 (default-value 'org-todo-keywords)))))
5019 (setq kwds (reverse kwds)))
5020 (setq kwds (nreverse kwds))
5021 (let (inter kws kw)
5022 (while (setq kws (pop kwds))
5023 (let ((kws (or
5024 (run-hook-with-args-until-success
5025 'org-todo-setup-filter-hook kws)
5026 kws)))
5027 (setq inter (pop kws) sep (member "|" kws)
5028 kws0 (delete "|" (copy-sequence kws))
5029 kwsa nil
5030 kws1 (mapcar
5031 (lambda (x)
5032 ;; 1 2
5033 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
5034 (progn
5035 (setq kw (match-string 1 x)
5036 key (and (match-end 2) (match-string 2 x))
5037 log (org-extract-log-state-settings x))
5038 (push (cons kw (and key (string-to-char key))) kwsa)
5039 (and log (push log org-todo-log-states))
5041 (error "Invalid TODO keyword %s" x)))
5042 kws0)
5043 kwsa (if kwsa (append '((:startgroup))
5044 (nreverse kwsa)
5045 '((:endgroup))))
5046 hw (car kws1)
5047 dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
5048 tail (list inter hw (car dws) (org-last dws))))
5049 (add-to-list 'org-todo-heads hw 'append)
5050 (push kws1 org-todo-sets)
5051 (setq org-done-keywords (append org-done-keywords dws nil))
5052 (setq org-todo-key-alist (append org-todo-key-alist kwsa))
5053 (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
5054 (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
5055 (setq org-todo-sets (nreverse org-todo-sets)
5056 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5057 org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
5058 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
5059 ;; Compute the regular expressions and other local variables.
5060 ;; Using `org-outline-regexp-bol' would complicate them much,
5061 ;; because of the fixed white space at the end of that string.
5062 (if (not org-done-keywords)
5063 (setq org-done-keywords (and org-todo-keywords-1
5064 (list (org-last org-todo-keywords-1)))))
5065 (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
5066 (length org-scheduled-string)
5067 (length org-clock-string)
5068 (length org-closed-string)))
5069 org-drawer-regexp
5070 (concat "^[ \t]*:\\("
5071 (mapconcat 'regexp-quote org-drawers "\\|")
5072 "\\):[ \t]*$")
5073 org-not-done-keywords
5074 (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
5075 org-todo-regexp
5076 (concat "\\("
5077 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
5078 "\\)")
5079 org-not-done-regexp
5080 (concat "\\("
5081 (mapconcat 'regexp-quote org-not-done-keywords "\\|")
5082 "\\)")
5083 org-not-done-heading-regexp
5084 (format org-heading-keyword-regexp-format org-not-done-regexp)
5085 org-todo-line-regexp
5086 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5087 org-complex-heading-regexp
5088 (concat "^\\(\\*+\\)"
5089 "\\(?: +" org-todo-regexp "\\)?"
5090 "\\(?: +\\(\\[#.\\]\\)\\)?"
5091 "\\(?: +\\(.*?\\)\\)??"
5092 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5093 "[ \t]*$")
5094 org-complex-heading-regexp-format
5095 (concat "^\\(\\*+\\)"
5096 "\\(?: +" org-todo-regexp "\\)?"
5097 "\\(?: +\\(\\[#.\\]\\)\\)?"
5098 "\\(?: +"
5099 ;; Stats cookies can be stuck to body.
5100 "\\(?:\\[[0-9%%/]+\\] *\\)?"
5101 "\\(%s\\)"
5102 "\\(?: *\\[[0-9%%/]+\\]\\)?"
5103 "\\)"
5104 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5105 "[ \t]*$")
5106 org-todo-line-tags-regexp
5107 (concat "^\\(\\*+\\)"
5108 "\\(?: +" org-todo-regexp "\\)?"
5109 "\\(?: +\\(.*?\\)\\)??"
5110 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5111 "[ \t]*$")
5112 org-deadline-regexp (concat "\\<" org-deadline-string)
5113 org-deadline-time-regexp
5114 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
5115 org-deadline-time-hour-regexp
5116 (concat "\\<" org-deadline-string
5117 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5118 org-deadline-line-regexp
5119 (concat "\\<\\(" org-deadline-string "\\).*")
5120 org-scheduled-regexp
5121 (concat "\\<" org-scheduled-string)
5122 org-scheduled-time-regexp
5123 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
5124 org-scheduled-time-hour-regexp
5125 (concat "\\<" org-scheduled-string
5126 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5127 org-closed-time-regexp
5128 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
5129 org-keyword-time-regexp
5130 (concat "\\<\\(" org-scheduled-string
5131 "\\|" org-deadline-string
5132 "\\|" org-closed-string
5133 "\\|" org-clock-string "\\)"
5134 " *[[<]\\([^]>]+\\)[]>]")
5135 org-keyword-time-not-clock-regexp
5136 (concat "\\<\\(" org-scheduled-string
5137 "\\|" org-deadline-string
5138 "\\|" org-closed-string
5139 "\\)"
5140 " *[[<]\\([^]>]+\\)[]>]")
5141 org-maybe-keyword-time-regexp
5142 (concat "\\(\\<\\(" org-scheduled-string
5143 "\\|" org-deadline-string
5144 "\\|" org-closed-string
5145 "\\|" org-clock-string "\\)\\)?"
5146 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
5147 org-all-time-keywords
5148 (mapcar (lambda (w) (substring w 0 -1))
5149 (list org-scheduled-string org-deadline-string
5150 org-clock-string org-closed-string)))
5151 (setq org-ota nil)
5152 (org-compute-latex-and-related-regexp))))
5154 (defun org-file-contents (file &optional noerror)
5155 "Return the contents of FILE, as a string."
5156 (if (or (not file) (not (file-readable-p file)))
5157 (if (not noerror)
5158 (error "Cannot read file \"%s\"" file)
5159 (message "Cannot read file \"%s\"" file)
5161 (with-temp-buffer
5162 (insert-file-contents file)
5163 (buffer-string))))
5165 (defun org-extract-log-state-settings (x)
5166 "Extract the log state setting from a TODO keyword string.
5167 This will extract info from a string like \"WAIT(w@/!)\"."
5168 (let (kw key log1 log2)
5169 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5170 (setq kw (match-string 1 x)
5171 key (and (match-end 2) (match-string 2 x))
5172 log1 (and (match-end 3) (match-string 3 x))
5173 log2 (and (match-end 4) (match-string 4 x)))
5174 (and (or log1 log2)
5175 (list kw
5176 (and log1 (if (equal log1 "!") 'time 'note))
5177 (and log2 (if (equal log2 "!") 'time 'note)))))))
5179 (defun org-remove-keyword-keys (list)
5180 "Remove a pair of parenthesis at the end of each string in LIST."
5181 (mapcar (lambda (x)
5182 (if (string-match "(.*)$" x)
5183 (substring x 0 (match-beginning 0))
5185 list))
5187 (defun org-assign-fast-keys (alist)
5188 "Assign fast keys to a keyword-key alist.
5189 Respect keys that are already there."
5190 (let (new e (alt ?0))
5191 (while (setq e (pop alist))
5192 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5193 (cdr e)) ;; Key already assigned.
5194 (push e new)
5195 (let ((clist (string-to-list (downcase (car e))))
5196 (used (append new alist)))
5197 (when (= (car clist) ?@)
5198 (pop clist))
5199 (while (and clist (rassoc (car clist) used))
5200 (pop clist))
5201 (unless clist
5202 (while (rassoc alt used)
5203 (incf alt)))
5204 (push (cons (car e) (or (car clist) alt)) new))))
5205 (nreverse new)))
5207 ;;; Some variables used in various places
5209 (defvar org-window-configuration nil
5210 "Used in various places to store a window configuration.")
5211 (defvar org-selected-window nil
5212 "Used in various places to store a window configuration.")
5213 (defvar org-finish-function nil
5214 "Function to be called when `C-c C-c' is used.
5215 This is for getting out of special buffers like capture.")
5218 ;; FIXME: Occasionally check by commenting these, to make sure
5219 ;; no other functions uses these, forgetting to let-bind them.
5220 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5221 (defvar org-last-state)
5222 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5224 ;; Defined somewhere in this file, but used before definition.
5225 (defvar org-entities) ;; defined in org-entities.el
5226 (defvar org-struct-menu)
5227 (defvar org-org-menu)
5228 (defvar org-tbl-menu)
5230 ;;;; Define the Org-mode
5232 ;; We use a before-change function to check if a table might need
5233 ;; an update.
5234 (defvar org-table-may-need-update t
5235 "Indicates that a table might need an update.
5236 This variable is set by `org-before-change-function'.
5237 `org-table-align' sets it back to nil.")
5238 (defun org-before-change-function (beg end)
5239 "Every change indicates that a table might need an update."
5240 (setq org-table-may-need-update t))
5241 (defvar org-mode-map)
5242 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5243 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5244 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5245 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5246 (defvar org-table-buffer-is-an nil)
5248 (defvar bidi-paragraph-direction)
5249 (defvar buffer-face-mode-face)
5251 (require 'outline)
5252 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5253 (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"))
5254 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5256 ;; Other stuff we need.
5257 (require 'time-date)
5258 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5259 (require 'easymenu)
5260 (require 'overlay)
5262 ;; (require 'org-macs) moved higher up in the file before it is first used
5263 (require 'org-entities)
5264 ;; (require 'org-compat) moved higher up in the file before it is first used
5265 (require 'org-faces)
5266 (require 'org-list)
5267 (require 'org-pcomplete)
5268 (require 'org-src)
5269 (require 'org-footnote)
5270 (require 'org-macro)
5272 ;; babel
5273 (require 'ob)
5275 ;;;###autoload
5276 (define-derived-mode org-mode outline-mode "Org"
5277 "Outline-based notes management and organizer, alias
5278 \"Carsten's outline-mode for keeping track of everything.\"
5280 Org-mode develops organizational tasks around a NOTES file which
5281 contains information about projects as plain text. Org-mode is
5282 implemented on top of outline-mode, which is ideal to keep the content
5283 of large files well structured. It supports ToDo items, deadlines and
5284 time stamps, which magically appear in the diary listing of the Emacs
5285 calendar. Tables are easily created with a built-in table editor.
5286 Plain text URL-like links connect to websites, emails (VM), Usenet
5287 messages (Gnus), BBDB entries, and any files related to the project.
5288 For printing and sharing of notes, an Org-mode file (or a part of it)
5289 can be exported as a structured ASCII or HTML file.
5291 The following commands are available:
5293 \\{org-mode-map}"
5295 ;; Get rid of Outline menus, they are not needed
5296 ;; Need to do this here because define-derived-mode sets up
5297 ;; the keymap so late. Still, it is a waste to call this each time
5298 ;; we switch another buffer into org-mode.
5299 (if (featurep 'xemacs)
5300 (when (boundp 'outline-mode-menu-heading)
5301 ;; Assume this is Greg's port, it uses easymenu
5302 (easy-menu-remove outline-mode-menu-heading)
5303 (easy-menu-remove outline-mode-menu-show)
5304 (easy-menu-remove outline-mode-menu-hide))
5305 (define-key org-mode-map [menu-bar headings] 'undefined)
5306 (define-key org-mode-map [menu-bar hide] 'undefined)
5307 (define-key org-mode-map [menu-bar show] 'undefined))
5309 (org-load-modules-maybe)
5310 (easy-menu-add org-org-menu)
5311 (easy-menu-add org-tbl-menu)
5312 (org-install-agenda-files-menu)
5313 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5314 (add-to-invisibility-spec '(org-cwidth))
5315 (add-to-invisibility-spec '(org-hide-block . t))
5316 (when (featurep 'xemacs)
5317 (org-set-local 'line-move-ignore-invisible t))
5318 (org-set-local 'outline-regexp org-outline-regexp)
5319 (org-set-local 'outline-level 'org-outline-level)
5320 (setq bidi-paragraph-direction 'left-to-right)
5321 (when (and org-ellipsis
5322 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5323 (fboundp 'make-glyph-code))
5324 (unless org-display-table
5325 (setq org-display-table (make-display-table)))
5326 (set-display-table-slot
5327 org-display-table 4
5328 (vconcat (mapcar
5329 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5330 org-ellipsis)))
5331 (if (stringp org-ellipsis) org-ellipsis "..."))))
5332 (setq buffer-display-table org-display-table))
5333 (org-set-regexps-and-options-for-tags)
5334 (org-set-regexps-and-options)
5335 (org-set-font-lock-defaults)
5336 (when (and org-tag-faces (not org-tags-special-faces-re))
5337 ;; tag faces set outside customize.... force initialization.
5338 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5339 ;; Calc embedded
5340 (org-set-local 'calc-embedded-open-mode "# ")
5341 ;; Modify a few syntax entries
5342 (modify-syntax-entry ?@ "w")
5343 (modify-syntax-entry ?\" "\"")
5344 (if org-startup-truncated (setq truncate-lines t))
5345 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5346 (org-set-local 'font-lock-unfontify-region-function
5347 'org-unfontify-region)
5348 ;; Activate before-change-function
5349 (org-set-local 'org-table-may-need-update t)
5350 (org-add-hook 'before-change-functions 'org-before-change-function nil
5351 'local)
5352 ;; Check for running clock before killing a buffer
5353 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5354 ;; Initialize macros templates.
5355 (org-macro-initialize-templates)
5356 ;; Initialize radio targets.
5357 (org-update-radio-target-regexp)
5358 ;; Indentation.
5359 (org-set-local 'indent-line-function 'org-indent-line)
5360 (org-set-local 'indent-region-function 'org-indent-region)
5361 ;; Filling and auto-filling.
5362 (org-setup-filling)
5363 ;; Comments.
5364 (org-setup-comments-handling)
5365 ;; Beginning/end of defun
5366 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5367 (org-set-local 'end-of-defun-function 'org-forward-element)
5368 ;; Next error for sparse trees
5369 (org-set-local 'next-error-function 'org-occur-next-match)
5370 ;; Make sure dependence stuff works reliably, even for users who set it
5371 ;; too late :-(
5372 (if org-enforce-todo-dependencies
5373 (add-hook 'org-blocker-hook
5374 'org-block-todo-from-children-or-siblings-or-parent)
5375 (remove-hook 'org-blocker-hook
5376 'org-block-todo-from-children-or-siblings-or-parent))
5377 (if org-enforce-todo-checkbox-dependencies
5378 (add-hook 'org-blocker-hook
5379 'org-block-todo-from-checkboxes)
5380 (remove-hook 'org-blocker-hook
5381 'org-block-todo-from-checkboxes))
5383 ;; Align options lines
5384 (org-set-local
5385 'align-mode-rules-list
5386 '((org-in-buffer-settings
5387 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5388 (modes . '(org-mode)))))
5390 ;; Imenu
5391 (org-set-local 'imenu-create-index-function
5392 'org-imenu-get-tree)
5394 ;; Make isearch reveal context
5395 (if (or (featurep 'xemacs)
5396 (not (boundp 'outline-isearch-open-invisible-function)))
5397 ;; Emacs 21 and XEmacs make use of the hook
5398 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5399 ;; Emacs 22 deals with this through a special variable
5400 (org-set-local 'outline-isearch-open-invisible-function
5401 (lambda (&rest ignore) (org-show-context 'isearch)))
5402 (org-add-hook 'isearch-mode-end-hook 'org-fix-ellipsis-at-bol 'append 'local))
5404 ;; Setup the pcomplete hooks
5405 (set (make-local-variable 'pcomplete-command-completion-function)
5406 'org-pcomplete-initial)
5407 (set (make-local-variable 'pcomplete-command-name-function)
5408 'org-command-at-point)
5409 (set (make-local-variable 'pcomplete-default-completion-function)
5410 'ignore)
5411 (set (make-local-variable 'pcomplete-parse-arguments-function)
5412 'org-parse-arguments)
5413 (set (make-local-variable 'pcomplete-termination-string) "")
5414 (when (>= emacs-major-version 23)
5415 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5417 ;; If empty file that did not turn on org-mode automatically, make it to.
5418 (if (and org-insert-mode-line-in-empty-file
5419 (org-called-interactively-p 'any)
5420 (= (point-min) (point-max)))
5421 (insert "# -*- mode: org -*-\n\n"))
5422 (unless org-inhibit-startup
5423 (org-unmodified
5424 (and org-startup-with-beamer-mode (org-beamer-mode))
5425 (when org-startup-align-all-tables
5426 (org-table-map-tables 'org-table-align 'quietly))
5427 (when org-startup-with-inline-images
5428 (org-display-inline-images))
5429 (when org-startup-with-latex-preview
5430 (org-preview-latex-fragment))
5431 (unless org-inhibit-startup-visibility-stuff
5432 (org-set-startup-visibility))))
5433 ;; Try to set org-hide correctly
5434 (set-face-foreground 'org-hide (org-find-invisible-foreground)))
5436 ;; Update `customize-package-emacs-version-alist'
5437 (add-to-list 'customize-package-emacs-version-alist
5438 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5439 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5440 ("8.2.6" . "24.4")))
5442 (defvar org-mode-transpose-word-syntax-table
5443 (let ((st (make-syntax-table)))
5444 (mapc (lambda(c) (modify-syntax-entry
5445 (string-to-char (car c)) "w p" st))
5446 org-emphasis-alist)
5447 st))
5449 (when (fboundp 'abbrev-table-put)
5450 (abbrev-table-put org-mode-abbrev-table
5451 :parents (list text-mode-abbrev-table)))
5453 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
5455 (defsubst org-fix-ellipsis-at-bol ()
5456 (save-excursion (goto-char (window-start)) (recenter 0)))
5458 (defun org-find-invisible-foreground ()
5459 (let ((candidates (remove
5460 "unspecified-bg"
5461 (nconc
5462 (list (face-background 'default)
5463 (face-background 'org-default))
5464 (mapcar
5465 (lambda (alist)
5466 (when (boundp alist)
5467 (cdr (assoc 'background-color (symbol-value alist)))))
5468 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5469 (list (face-foreground 'org-hide))))))
5470 (car (remove nil candidates))))
5472 (defun org-current-time (&optional rounding-minutes past)
5473 "Current time, possibly rounded to ROUNDING-MINUTES.
5474 When ROUNDING-MINUTES is not an integer, fall back on the car of
5475 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5476 the rounding returns a past time."
5477 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5478 (car org-time-stamp-rounding-minutes)))
5479 (time (decode-time)) res)
5480 (if (< r 1)
5481 (current-time)
5482 (setq res
5483 (apply 'encode-time
5484 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5485 (nthcdr 2 time))))
5486 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5487 (seconds-to-time (- (org-float-time res) (* r 60)))
5488 res))))
5490 (defun org-today ()
5491 "Return today date, considering `org-extend-today-until'."
5492 (time-to-days
5493 (time-subtract (current-time)
5494 (list 0 (* 3600 org-extend-today-until) 0))))
5496 ;;;; Font-Lock stuff, including the activators
5498 (defvar org-mouse-map (make-sparse-keymap))
5499 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5500 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5501 (when org-mouse-1-follows-link
5502 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5503 (when org-tab-follows-link
5504 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5505 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5507 (require 'font-lock)
5509 (defconst org-non-link-chars "]\t\n\r<>")
5510 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
5511 "shell" "elisp" "doi" "message"))
5512 (defvar org-link-types-re nil
5513 "Matches a link that has a url-like prefix like \"http:\"")
5514 (defvar org-link-re-with-space nil
5515 "Matches a link with spaces, optional angular brackets around it.")
5516 (defvar org-link-re-with-space2 nil
5517 "Matches a link with spaces, optional angular brackets around it.")
5518 (defvar org-link-re-with-space3 nil
5519 "Matches a link with spaces, only for internal part in bracket links.")
5520 (defvar org-angle-link-re nil
5521 "Matches link with angular brackets, spaces are allowed.")
5522 (defvar org-plain-link-re nil
5523 "Matches plain link, without spaces.")
5524 (defvar org-bracket-link-regexp nil
5525 "Matches a link in double brackets.")
5526 (defvar org-bracket-link-analytic-regexp nil
5527 "Regular expression used to analyze links.
5528 Here is what the match groups contain after a match:
5529 1: http:
5530 2: http
5531 3: path
5532 4: [desc]
5533 5: desc")
5534 (defvar org-bracket-link-analytic-regexp++ nil
5535 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5536 (defvar org-any-link-re nil
5537 "Regular expression matching any link.")
5539 (defconst org-match-sexp-depth 3
5540 "Number of stacked braces for sub/superscript matching.")
5542 (defun org-create-multibrace-regexp (left right n)
5543 "Create a regular expression which will match a balanced sexp.
5544 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5545 as single character strings.
5546 The regexp returned will match the entire expression including the
5547 delimiters. It will also define a single group which contains the
5548 match except for the outermost delimiters. The maximum depth of
5549 stacked delimiters is N. Escaping delimiters is not possible."
5550 (let* ((nothing (concat "[^" left right "]*?"))
5551 (or "\\|")
5552 (re nothing)
5553 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5554 (while (> n 1)
5555 (setq n (1- n)
5556 re (concat re or next)
5557 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5558 (concat left "\\(" re "\\)" right)))
5560 (defvar org-match-substring-regexp
5561 (concat
5562 "\\(\\S-\\)\\([_^]\\)\\("
5563 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5564 "\\|"
5565 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5566 "\\|"
5567 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
5568 "The regular expression matching a sub- or superscript.")
5570 (defvar org-match-substring-with-braces-regexp
5571 (concat
5572 "\\(\\S-\\)\\([_^]\\)\\("
5573 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5574 "\\)")
5575 "The regular expression matching a sub- or superscript, forcing braces.")
5577 (defun org-make-link-regexps ()
5578 "Update the link regular expressions.
5579 This should be called after the variable `org-link-types' has changed."
5580 (setq org-link-types-re
5581 (concat
5582 "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
5583 org-link-re-with-space
5584 (concat
5585 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5586 "\\([^" org-non-link-chars " ]"
5587 "[^" org-non-link-chars "]*"
5588 "[^" org-non-link-chars " ]\\)>?")
5589 org-link-re-with-space2
5590 (concat
5591 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5592 "\\([^" org-non-link-chars " ]"
5593 "[^\t\n\r]*"
5594 "[^" org-non-link-chars " ]\\)>?")
5595 org-link-re-with-space3
5596 (concat
5597 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5598 "\\([^" org-non-link-chars " ]"
5599 "[^\t\n\r]*\\)")
5600 org-angle-link-re
5601 (concat
5602 "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5603 "\\([^" org-non-link-chars " ]"
5604 "[^" org-non-link-chars "]*"
5605 "\\)>")
5606 org-plain-link-re
5607 (concat
5608 "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5609 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5610 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5611 org-bracket-link-regexp
5612 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5613 org-bracket-link-analytic-regexp
5614 (concat
5615 "\\[\\["
5616 "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
5617 "\\([^]]+\\)"
5618 "\\]"
5619 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5620 "\\]")
5621 org-bracket-link-analytic-regexp++
5622 (concat
5623 "\\[\\["
5624 "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
5625 "\\([^]]+\\)"
5626 "\\]"
5627 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5628 "\\]")
5629 org-any-link-re
5630 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5631 org-angle-link-re "\\)\\|\\("
5632 org-plain-link-re "\\)")))
5634 (org-make-link-regexps)
5636 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
5637 "Regular expression for fast time stamp matching.")
5638 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5639 "Regular expression for fast time stamp matching.")
5640 (defconst org-ts-regexp0
5641 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5642 "Regular expression matching time strings for analysis.
5643 This one does not require the space after the date, so it can be used
5644 on a string that terminates immediately after the date.")
5645 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5646 "Regular expression matching time strings for analysis.")
5647 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
5648 "Regular expression matching time stamps, with groups.")
5649 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
5650 "Regular expression matching time stamps (also [..]), with groups.")
5651 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
5652 "Regular expression matching a time stamp range.")
5653 (defconst org-tr-regexp-both
5654 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
5655 "Regular expression matching a time stamp range.")
5656 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
5657 org-ts-regexp "\\)?")
5658 "Regular expression matching a time stamp or time stamp range.")
5659 (defconst org-tsr-regexp-both
5660 (concat org-ts-regexp-both "\\(--?-?"
5661 org-ts-regexp-both "\\)?")
5662 "Regular expression matching a time stamp or time stamp range.
5663 The time stamps may be either active or inactive.")
5665 (defvar org-emph-face nil)
5667 (defun org-do-emphasis-faces (limit)
5668 "Run through the buffer and add overlays to emphasized strings."
5669 (let (rtn a)
5670 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5671 (if (not (= (char-after (match-beginning 3))
5672 (char-after (match-beginning 4))))
5673 (progn
5674 (setq rtn t)
5675 (setq a (assoc (match-string 3) org-emphasis-alist))
5676 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5677 'face
5678 (nth 1 a))
5679 (and (nth 2 a)
5680 (org-remove-flyspell-overlays-in
5681 (match-beginning 0) (match-end 0)))
5682 (add-text-properties (match-beginning 2) (match-end 2)
5683 '(font-lock-multiline t org-emphasis t))
5684 (when org-hide-emphasis-markers
5685 (add-text-properties (match-end 4) (match-beginning 5)
5686 '(invisible org-link))
5687 (add-text-properties (match-beginning 3) (match-end 3)
5688 '(invisible org-link)))))
5689 (goto-char (1+ (match-beginning 0))))
5690 rtn))
5692 (defun org-emphasize (&optional char)
5693 "Insert or change an emphasis, i.e. a font like bold or italic.
5694 If there is an active region, change that region to a new emphasis.
5695 If there is no region, just insert the marker characters and position
5696 the cursor between them.
5697 CHAR should be the marker character. If it is a space, it means to
5698 remove the emphasis of the selected region.
5699 If CHAR is not given (for example in an interactive call) it will be
5700 prompted for."
5701 (interactive)
5702 (let ((erc org-emphasis-regexp-components)
5703 (prompt "")
5704 (string "") beg end move c s)
5705 (if (org-region-active-p)
5706 (setq beg (region-beginning) end (region-end)
5707 string (buffer-substring beg end))
5708 (setq move t))
5710 (unless char
5711 (message "Emphasis marker or tag: [%s]"
5712 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5713 (setq char (read-char-exclusive)))
5714 (if (equal char ?\ )
5715 (setq s "" move nil)
5716 (unless (assoc (char-to-string char) org-emphasis-alist)
5717 (user-error "No such emphasis marker: \"%c\"" char))
5718 (setq s (char-to-string char)))
5719 (while (and (> (length string) 1)
5720 (equal (substring string 0 1) (substring string -1))
5721 (assoc (substring string 0 1) org-emphasis-alist))
5722 (setq string (substring string 1 -1)))
5723 (setq string (concat s string s))
5724 (if beg (delete-region beg end))
5725 (unless (or (bolp)
5726 (string-match (concat "[" (nth 0 erc) "\n]")
5727 (char-to-string (char-before (point)))))
5728 (insert " "))
5729 (unless (or (eobp)
5730 (string-match (concat "[" (nth 1 erc) "\n]")
5731 (char-to-string (char-after (point)))))
5732 (insert " ") (backward-char 1))
5733 (insert string)
5734 (and move (backward-char 1))))
5736 (defconst org-nonsticky-props
5737 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5739 (defsubst org-rear-nonsticky-at (pos)
5740 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5742 (defun org-activate-plain-links (limit)
5743 "Run through the buffer and add overlays to links."
5744 (let (f hl)
5745 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5746 (not (org-in-src-block-p)))
5747 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5748 (setq f (get-text-property (match-beginning 0) 'face))
5749 (setq hl (org-match-string-no-properties 0))
5750 (if (or (eq f 'org-tag)
5751 (and (listp f) (memq 'org-tag f)))
5753 (add-text-properties (match-beginning 0) (match-end 0)
5754 (list 'mouse-face 'highlight
5755 'face 'org-link
5756 'htmlize-link `(:uri ,hl)
5757 'keymap org-mouse-map))
5758 (org-rear-nonsticky-at (match-end 0)))
5759 t)))
5761 (defun org-activate-code (limit)
5762 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5763 (progn
5764 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5765 (remove-text-properties (match-beginning 0) (match-end 0)
5766 '(display t invisible t intangible t))
5767 t)))
5769 (defcustom org-src-fontify-natively nil
5770 "When non-nil, fontify code in code blocks."
5771 :type 'boolean
5772 :version "24.1"
5773 :group 'org-appearance
5774 :group 'org-babel)
5776 (defcustom org-allow-promoting-top-level-subtree nil
5777 "When non-nil, allow promoting a top level subtree.
5778 The leading star of the top level headline will be replaced
5779 by a #."
5780 :type 'boolean
5781 :version "24.1"
5782 :group 'org-appearance)
5784 (defun org-fontify-meta-lines-and-blocks (limit)
5785 (condition-case nil
5786 (org-fontify-meta-lines-and-blocks-1 limit)
5787 (error (message "org-mode fontification error"))))
5789 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5790 "Fontify #+ lines and blocks."
5791 (let ((case-fold-search t))
5792 (if (re-search-forward
5793 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5794 limit t)
5795 (let ((beg (match-beginning 0))
5796 (block-start (match-end 0))
5797 (block-end nil)
5798 (lang (match-string 7))
5799 (beg1 (line-beginning-position 2))
5800 (dc1 (downcase (match-string 2)))
5801 (dc3 (downcase (match-string 3)))
5802 end end1 quoting block-type ovl)
5803 (cond
5804 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5805 ;; a single line of backend-specific content
5806 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5807 (remove-text-properties (match-beginning 0) (match-end 0)
5808 '(display t invisible t intangible t))
5809 (add-text-properties (match-beginning 1) (match-end 3)
5810 '(font-lock-fontified t face org-meta-line))
5811 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5812 '(font-lock-fontified t face org-block))
5813 ; for backend-specific code
5815 ((and (match-end 4) (equal dc3 "+begin"))
5816 ;; Truly a block
5817 (setq block-type (downcase (match-string 5))
5818 quoting (member block-type org-protecting-blocks))
5819 (when (re-search-forward
5820 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5821 nil t) ;; on purpose, we look further than LIMIT
5822 (setq end (min (point-max) (match-end 0))
5823 end1 (min (point-max) (1- (match-beginning 0))))
5824 (setq block-end (match-beginning 0))
5825 (when quoting
5826 (remove-text-properties beg end
5827 '(display t invisible t intangible t)))
5828 (add-text-properties
5829 beg end
5830 '(font-lock-fontified t font-lock-multiline t))
5831 (add-text-properties beg beg1 '(face org-meta-line))
5832 (add-text-properties end1 (min (point-max) (1+ end))
5833 '(face org-meta-line)) ; for end_src
5834 (cond
5835 ((and lang (not (string= lang "")) org-src-fontify-natively)
5836 (org-src-font-lock-fontify-block lang block-start block-end)
5837 ;; remove old background overlays
5838 (mapc (lambda (ov)
5839 (if (eq (overlay-get ov 'face) 'org-block-background)
5840 (delete-overlay ov)))
5841 (overlays-at (/ (+ beg1 block-end) 2)))
5842 ;; add a background overlay
5843 (setq ovl (make-overlay beg1 block-end))
5844 (overlay-put ovl 'face 'org-block-background)
5845 (overlay-put ovl 'evaporate t)) ;; make it go away when empty
5846 (quoting
5847 (add-text-properties beg1 (min (point-max) (1+ end1))
5848 '(face org-block))) ; end of source block
5849 ((not org-fontify-quote-and-verse-blocks))
5850 ((string= block-type "quote")
5851 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5852 ((string= block-type "verse")
5853 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5854 (add-text-properties beg beg1 '(face org-block-begin-line))
5855 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5856 '(face org-block-end-line))
5858 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5859 (add-text-properties
5860 beg (match-end 3)
5861 (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
5862 '(font-lock-fontified t invisible t)
5863 '(font-lock-fontified t face org-document-info-keyword)))
5864 (add-text-properties
5865 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5866 (if (string-equal dc1 "+title:")
5867 '(font-lock-fontified t face org-document-title)
5868 '(font-lock-fontified t face org-document-info))))
5869 ((or (equal dc1 "+results")
5870 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5871 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5872 "+call:" "+header:" "+headers:" "+name:"))
5873 (and (match-end 4) (equal dc3 "+attr")))
5874 (add-text-properties
5875 beg (match-end 0)
5876 '(font-lock-fontified t face org-meta-line))
5878 ((member dc3 '(" " ""))
5879 (add-text-properties
5880 beg (match-end 0)
5881 '(font-lock-fontified t face font-lock-comment-face)))
5882 ((not (member (char-after beg) '(?\ ?\t)))
5883 ;; just any other in-buffer setting, but not indented
5884 (add-text-properties
5885 beg (match-end 0)
5886 '(font-lock-fontified t face org-meta-line))
5888 (t nil))))))
5890 (defun org-activate-angle-links (limit)
5891 "Run through the buffer and add overlays to links."
5892 (if (and (re-search-forward org-angle-link-re limit t)
5893 (not (org-in-src-block-p)))
5894 (progn
5895 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5896 (add-text-properties (match-beginning 0) (match-end 0)
5897 (list 'mouse-face 'highlight
5898 'keymap org-mouse-map))
5899 (org-rear-nonsticky-at (match-end 0))
5900 t)))
5902 (defun org-activate-footnote-links (limit)
5903 "Run through the buffer and add overlays to footnotes."
5904 (let ((fn (org-footnote-next-reference-or-definition limit)))
5905 (when fn
5906 (let ((beg (nth 1 fn)) (end (nth 2 fn)))
5907 (org-remove-flyspell-overlays-in beg end)
5908 (add-text-properties beg end
5909 (list 'mouse-face 'highlight
5910 'keymap org-mouse-map
5911 'help-echo
5912 (if (= (point-at-bol) beg)
5913 "Footnote definition"
5914 "Footnote reference")
5915 'font-lock-fontified t
5916 'font-lock-multiline t
5917 'face 'org-footnote))))))
5919 (defun org-activate-bracket-links (limit)
5920 "Run through the buffer and add overlays to bracketed links."
5921 (if (and (re-search-forward org-bracket-link-regexp limit t)
5922 (not (org-in-src-block-p)))
5923 (let* ((hl (org-match-string-no-properties 1))
5924 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
5925 (ip (org-maybe-intangible
5926 (list 'invisible 'org-link
5927 'keymap org-mouse-map 'mouse-face 'highlight
5928 'font-lock-multiline t 'help-echo help
5929 'htmlize-link `(:uri ,hl))))
5930 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
5931 'font-lock-multiline t 'help-echo help
5932 'htmlize-link `(:uri ,hl))))
5933 ;; We need to remove the invisible property here. Table narrowing
5934 ;; may have made some of this invisible.
5935 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5936 (remove-text-properties (match-beginning 0) (match-end 0)
5937 '(invisible nil))
5938 (if (match-end 3)
5939 (progn
5940 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
5941 (org-rear-nonsticky-at (match-beginning 3))
5942 (add-text-properties (match-beginning 3) (match-end 3) vp)
5943 (org-rear-nonsticky-at (match-end 3))
5944 (add-text-properties (match-end 3) (match-end 0) ip)
5945 (org-rear-nonsticky-at (match-end 0)))
5946 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
5947 (org-rear-nonsticky-at (match-beginning 1))
5948 (add-text-properties (match-beginning 1) (match-end 1) vp)
5949 (org-rear-nonsticky-at (match-end 1))
5950 (add-text-properties (match-end 1) (match-end 0) ip)
5951 (org-rear-nonsticky-at (match-end 0)))
5952 t)))
5954 (defun org-activate-dates (limit)
5955 "Run through the buffer and add overlays to dates."
5956 (if (and (re-search-forward org-tsr-regexp-both limit t)
5957 (not (equal (char-before (match-beginning 0)) 91)))
5958 (progn
5959 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5960 (add-text-properties (match-beginning 0) (match-end 0)
5961 (list 'mouse-face 'highlight
5962 'keymap org-mouse-map))
5963 (org-rear-nonsticky-at (match-end 0))
5964 (when org-display-custom-times
5965 (if (match-end 3)
5966 (org-display-custom-time (match-beginning 3) (match-end 3)))
5967 (org-display-custom-time (match-beginning 1) (match-end 1)))
5968 t)))
5970 (defvar org-target-link-regexp nil
5971 "Regular expression matching radio targets in plain text.")
5972 (make-variable-buffer-local 'org-target-link-regexp)
5973 (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
5974 "Regular expression matching a link target.")
5975 (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
5976 "Regular expression matching a radio target.")
5977 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5978 "Regular expression matching any target.")
5980 (defun org-activate-target-links (limit)
5981 "Run through the buffer and add overlays to target matches."
5982 (when org-target-link-regexp
5983 (let ((case-fold-search t))
5984 (if (re-search-forward org-target-link-regexp limit t)
5985 (progn
5986 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5987 (add-text-properties (match-beginning 0) (match-end 0)
5988 (list 'mouse-face 'highlight
5989 'keymap org-mouse-map
5990 'help-echo "Radio target link"
5991 'org-linked-text t))
5992 (org-rear-nonsticky-at (match-end 0))
5993 t)))))
5995 (defun org-update-radio-target-regexp ()
5996 "Find all radio targets in this file and update the regular expression."
5997 (interactive)
5998 (when (memq 'radio org-activate-links)
5999 (setq org-target-link-regexp
6000 (org-make-target-link-regexp (org-all-targets 'radio)))
6001 (org-restart-font-lock)))
6003 (defun org-hide-wide-columns (limit)
6004 (let (s e)
6005 (setq s (text-property-any (point) (or limit (point-max))
6006 'org-cwidth t))
6007 (when s
6008 (setq e (next-single-property-change s 'org-cwidth))
6009 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6010 (goto-char e)
6011 t)))
6013 (defvar org-latex-and-related-regexp nil
6014 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6015 (defvar org-match-substring-regexp)
6016 (defvar org-match-substring-with-braces-regexp)
6018 (defun org-compute-latex-and-related-regexp ()
6019 "Compute regular expression for LaTeX, entities and sub/superscript.
6020 Result depends on variable `org-highlight-latex-and-related'."
6021 (org-set-local
6022 'org-latex-and-related-regexp
6023 (let* ((re-sub
6024 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6025 ((eq org-use-sub-superscripts '{})
6026 (list org-match-substring-with-braces-regexp))
6027 (org-use-sub-superscripts (list org-match-substring-regexp))))
6028 (re-latex
6029 (when (memq 'latex org-highlight-latex-and-related)
6030 (let ((matchers (plist-get org-format-latex-options :matchers)))
6031 (delq nil
6032 (mapcar (lambda (x)
6033 (and (member (car x) matchers) (nth 1 x)))
6034 org-latex-regexps)))))
6035 (re-entities
6036 (when (memq 'entities org-highlight-latex-and-related)
6037 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6038 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6040 (defun org-do-latex-and-related (limit)
6041 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6042 LIMIT bounds the search for syntax to highlight. Stop at first
6043 highlighted object, if any. Return t if some highlighting was
6044 done, nil otherwise."
6045 (when (org-string-nw-p org-latex-and-related-regexp)
6046 (catch 'found
6047 (while (re-search-forward org-latex-and-related-regexp limit t)
6048 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6049 'face))
6050 '(org-code org-verbatim underline))
6051 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6052 '(?_ ?^))
6054 0)))
6055 (font-lock-prepend-text-property
6056 (+ offset (match-beginning 0)) (match-end 0)
6057 'face 'org-latex-and-related)
6058 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6059 '(font-lock-multiline t)))
6060 (throw 'found t)))
6061 nil)))
6063 (defun org-restart-font-lock ()
6064 "Restart `font-lock-mode', to force refontification."
6065 (when (and (boundp 'font-lock-mode) font-lock-mode)
6066 (font-lock-mode -1)
6067 (font-lock-mode 1)))
6069 (defun org-all-targets (&optional radio)
6070 "Return a list of all targets in this file.
6071 When optional argument RADIO is non-nil, only find radio
6072 targets."
6073 (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
6074 (save-excursion
6075 (goto-char (point-min))
6076 (while (re-search-forward re nil t)
6077 ;; Make sure point is really within the object.
6078 (backward-char)
6079 (let ((obj (org-element-context)))
6080 (when (memq (org-element-type obj) '(radio-target target))
6081 (add-to-list 'rtn (downcase (org-element-property :value obj))))))
6082 rtn)))
6084 (defun org-make-target-link-regexp (targets)
6085 "Make regular expression matching all strings in TARGETS.
6086 The regular expression finds the targets also if there is a line break
6087 between words."
6088 (and targets
6089 (concat
6090 "\\<\\("
6091 (mapconcat
6092 (lambda (x)
6093 (setq x (regexp-quote x))
6094 (while (string-match " +" x)
6095 (setq x (replace-match "\\s-+" t t x)))
6097 targets
6098 "\\|")
6099 "\\)\\>")))
6101 (defun org-activate-tags (limit)
6102 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6103 (progn
6104 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6105 (add-text-properties (match-beginning 1) (match-end 1)
6106 (list 'mouse-face 'highlight
6107 'keymap org-mouse-map))
6108 (org-rear-nonsticky-at (match-end 1))
6109 t)))
6111 (defun org-outline-level ()
6112 "Compute the outline level of the heading at point.
6113 If this is called at a normal headline, the level is the number of stars.
6114 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6115 (save-excursion
6116 (if (not (condition-case nil
6117 (org-back-to-heading t)
6118 (error nil)))
6120 (looking-at org-outline-regexp)
6121 (1- (- (match-end 0) (match-beginning 0))))))
6123 (defvar org-font-lock-keywords nil)
6125 (defsubst org-re-property (property &optional literal)
6126 "Return a regexp matching a PROPERTY line.
6127 Match group 3 will be set to the value if it exists."
6128 (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
6129 (if literal property (regexp-quote property))
6130 "\\):\\)[ \t]+\\(?3:[^ \t\r\n].*?\\)\\(?5:[ \t]*\\)$"))
6132 (defconst org-property-re
6133 (org-re-property ".*?" 'literal)
6134 "Regular expression matching a property line.
6135 There are four matching groups:
6136 1: :PROPKEY: including the leading and trailing colon,
6137 2: PROPKEY without the leading and trailing colon,
6138 3: PROPVAL without leading or trailing spaces,
6139 4: the indentation of the current line,
6140 5: trailing whitespace.")
6142 (defvar org-font-lock-hook nil
6143 "Functions to be called for special font lock stuff.")
6145 (defvar org-font-lock-set-keywords-hook nil
6146 "Functions that can manipulate `org-font-lock-extra-keywords'.
6147 This is called after `org-font-lock-extra-keywords' is defined, but before
6148 it is installed to be used by font lock. This can be useful if something
6149 needs to be inserted at a specific position in the font-lock sequence.")
6151 (defun org-font-lock-hook (limit)
6152 "Run `org-font-lock-hook' within LIMIT."
6153 (run-hook-with-args 'org-font-lock-hook limit))
6155 (defun org-set-font-lock-defaults ()
6156 "Set font lock defaults for the current buffer."
6157 (let* ((em org-fontify-emphasized-text)
6158 (lk org-activate-links)
6159 (org-font-lock-extra-keywords
6160 (list
6161 ;; Call the hook
6162 '(org-font-lock-hook)
6163 ;; Headlines
6164 `(,(if org-fontify-whole-heading-line
6165 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6166 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6167 (1 (org-get-level-face 1))
6168 (2 (org-get-level-face 2))
6169 (3 (org-get-level-face 3)))
6170 ;; Table lines
6171 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6172 (1 'org-table t))
6173 ;; Table internals
6174 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6175 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6176 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6177 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6178 ;; Drawers
6179 (list org-drawer-regexp '(0 'org-special-keyword t))
6180 (list "^[ \t]*:END:" '(0 'org-special-keyword t))
6181 ;; Properties
6182 (list org-property-re
6183 '(1 'org-special-keyword t)
6184 '(3 'org-property-value t))
6185 ;; Links
6186 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6187 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6188 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6189 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6190 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
6191 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6192 (if (memq 'footnote lk) '(org-activate-footnote-links))
6193 ;; Targets.
6194 (list org-any-target-regexp '(0 'org-target t))
6195 ;; Diary sexps.
6196 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6197 ;; Macro
6198 '("{{{.+}}}" (0 'org-macro t))
6199 '(org-hide-wide-columns (0 nil append))
6200 ;; TODO keyword
6201 (list (format org-heading-keyword-regexp-format
6202 org-todo-regexp)
6203 '(2 (org-get-todo-face 2) t))
6204 ;; DONE
6205 (if org-fontify-done-headline
6206 (list (format org-heading-keyword-regexp-format
6207 (concat
6208 "\\(?:"
6209 (mapconcat 'regexp-quote org-done-keywords "\\|")
6210 "\\)"))
6211 '(2 'org-headline-done t))
6212 nil)
6213 ;; Priorities
6214 '(org-font-lock-add-priority-faces)
6215 ;; Tags
6216 '(org-font-lock-add-tag-faces)
6217 ;; Tags groups
6218 (if (and org-group-tags org-tag-groups-alist)
6219 (list (concat org-outline-regexp-bol ".+\\(:"
6220 (regexp-opt (mapcar 'car org-tag-groups-alist))
6221 ":\\).*$")
6222 '(1 'org-tag-group prepend)))
6223 ;; Special keywords
6224 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6225 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6226 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6227 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6228 ;; Emphasis
6229 (if em
6230 (if (featurep 'xemacs)
6231 '(org-do-emphasis-faces (0 nil append))
6232 '(org-do-emphasis-faces)))
6233 ;; Checkboxes
6234 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6235 1 'org-checkbox prepend)
6236 (if (cdr (assq 'checkbox org-list-automatic-rules))
6237 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6238 (0 (org-get-checkbox-statistics-face) t)))
6239 ;; Description list items
6240 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6241 1 'org-list-dt prepend)
6242 ;; ARCHIVEd headings
6243 (list (concat
6244 org-outline-regexp-bol
6245 "\\(.*:" org-archive-tag ":.*\\)")
6246 '(1 'org-archived prepend))
6247 ;; Specials
6248 '(org-do-latex-and-related)
6249 '(org-fontify-entities)
6250 '(org-raise-scripts)
6251 ;; Code
6252 '(org-activate-code (1 'org-code t))
6253 ;; COMMENT
6254 (list (format org-heading-keyword-regexp-format
6255 (concat "\\("
6256 org-comment-string "\\|" org-quote-string
6257 "\\)"))
6258 '(2 'org-special-keyword t))
6259 ;; Blocks and meta lines
6260 '(org-fontify-meta-lines-and-blocks))))
6261 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6262 (run-hooks 'org-font-lock-set-keywords-hook)
6263 ;; Now set the full font-lock-keywords
6264 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6265 (org-set-local 'font-lock-defaults
6266 '(org-font-lock-keywords t nil nil backward-paragraph))
6267 (kill-local-variable 'font-lock-keywords) nil))
6269 (defun org-toggle-pretty-entities ()
6270 "Toggle the composition display of entities as UTF8 characters."
6271 (interactive)
6272 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6273 (org-restart-font-lock)
6274 (if org-pretty-entities
6275 (message "Entities are now displayed as UTF8 characters")
6276 (save-restriction
6277 (widen)
6278 (org-decompose-region (point-min) (point-max))
6279 (message "Entities are now displayed as plain text"))))
6281 (defvar org-custom-properties-overlays nil
6282 "List of overlays used for custom properties.")
6283 (make-variable-buffer-local 'org-custom-properties-overlays)
6285 (defun org-toggle-custom-properties-visibility ()
6286 "Display or hide properties in `org-custom-properties'."
6287 (interactive)
6288 (if org-custom-properties-overlays
6289 (progn (mapc 'delete-overlay org-custom-properties-overlays)
6290 (setq org-custom-properties-overlays nil))
6291 (unless (not org-custom-properties)
6292 (save-excursion
6293 (save-restriction
6294 (widen)
6295 (goto-char (point-min))
6296 (while (re-search-forward org-property-re nil t)
6297 (mapc (lambda(p)
6298 (when (equal p (substring (match-string 1) 1 -1))
6299 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6300 (overlay-put o 'invisible t)
6301 (overlay-put o 'org-custom-property t)
6302 (push o org-custom-properties-overlays))))
6303 org-custom-properties)))))))
6305 (defun org-fontify-entities (limit)
6306 "Find an entity to fontify."
6307 (let (ee)
6308 (when org-pretty-entities
6309 (catch 'match
6310 (while (re-search-forward
6311 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6312 limit t)
6313 (if (and (not (org-in-indented-comment-line))
6314 (setq ee (org-entity-get (match-string 1)))
6315 (= (length (nth 6 ee)) 1))
6316 (let*
6317 ((end (if (equal (match-string 2) "{}")
6318 (match-end 2)
6319 (match-end 1))))
6320 (add-text-properties
6321 (match-beginning 0) end
6322 (list 'font-lock-fontified t))
6323 (compose-region (match-beginning 0) end
6324 (nth 6 ee) nil)
6325 (backward-char 1)
6326 (throw 'match t))))
6327 nil))))
6329 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6330 "Fontify string S like in Org-mode."
6331 (with-temp-buffer
6332 (insert s)
6333 (let ((org-odd-levels-only odd-levels))
6334 (org-mode)
6335 (font-lock-fontify-buffer)
6336 (buffer-string))))
6338 (defvar org-m nil)
6339 (defvar org-l nil)
6340 (defvar org-f nil)
6341 (defun org-get-level-face (n)
6342 "Get the right face for match N in font-lock matching of headlines."
6343 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6344 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6345 (if org-cycle-level-faces
6346 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6347 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6348 (cond
6349 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6350 ((eq n 2) org-f)
6351 (t (if org-level-color-stars-only nil org-f))))
6354 (defun org-get-todo-face (kwd)
6355 "Get the right face for a TODO keyword KWD.
6356 If KWD is a number, get the corresponding match group."
6357 (if (numberp kwd) (setq kwd (match-string kwd)))
6358 (or (org-face-from-face-or-color
6359 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6360 (and (member kwd org-done-keywords) 'org-done)
6361 'org-todo))
6363 (defun org-face-from-face-or-color (context inherit face-or-color)
6364 "Create a face list that inherits INHERIT, but sets the foreground color.
6365 When FACE-OR-COLOR is not a string, just return it."
6366 (if (stringp face-or-color)
6367 (list :inherit inherit
6368 (cdr (assoc context org-faces-easy-properties))
6369 face-or-color)
6370 face-or-color))
6372 (defun org-font-lock-add-tag-faces (limit)
6373 "Add the special tag faces."
6374 (when (and org-tag-faces org-tags-special-faces-re)
6375 (while (re-search-forward org-tags-special-faces-re limit t)
6376 (add-text-properties (match-beginning 1) (match-end 1)
6377 (list 'face (org-get-tag-face 1)
6378 'font-lock-fontified t))
6379 (backward-char 1))))
6381 (defun org-font-lock-add-priority-faces (limit)
6382 "Add the special priority faces."
6383 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6384 (when (save-match-data (org-at-heading-p))
6385 (add-text-properties
6386 (match-beginning 0) (match-end 0)
6387 (list 'face (or (org-face-from-face-or-color
6388 'priority 'org-priority
6389 (cdr (assoc (char-after (match-beginning 1))
6390 org-priority-faces)))
6391 'org-priority)
6392 'font-lock-fontified t)))))
6394 (defun org-get-tag-face (kwd)
6395 "Get the right face for a TODO keyword KWD.
6396 If KWD is a number, get the corresponding match group."
6397 (if (numberp kwd) (setq kwd (match-string kwd)))
6398 (or (org-face-from-face-or-color
6399 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6400 'org-tag))
6402 (defun org-unfontify-region (beg end &optional maybe_loudly)
6403 "Remove fontification and activation overlays from links."
6404 (font-lock-default-unfontify-region beg end)
6405 (let* ((buffer-undo-list t)
6406 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6407 (inhibit-modification-hooks t)
6408 deactivate-mark buffer-file-name buffer-file-truename)
6409 (org-decompose-region beg end)
6410 (remove-text-properties beg end
6411 '(mouse-face t keymap t org-linked-text t
6412 invisible t intangible t
6413 org-no-flyspell t org-emphasis t))
6414 (org-remove-font-lock-display-properties beg end)))
6416 (defconst org-script-display '(((raise -0.3) (height 0.7))
6417 ((raise 0.3) (height 0.7))
6418 ((raise -0.5))
6419 ((raise 0.5)))
6420 "Display properties for showing superscripts and subscripts.")
6422 (defun org-remove-font-lock-display-properties (beg end)
6423 "Remove specific display properties that have been added by font lock.
6424 The will remove the raise properties that are used to show superscripts
6425 and subscripts."
6426 (let (next prop)
6427 (while (< beg end)
6428 (setq next (next-single-property-change beg 'display nil end)
6429 prop (get-text-property beg 'display))
6430 (if (member prop org-script-display)
6431 (put-text-property beg next 'display nil))
6432 (setq beg next))))
6434 (defun org-raise-scripts (limit)
6435 "Add raise properties to sub/superscripts."
6436 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6437 (if (re-search-forward
6438 (if (eq org-use-sub-superscripts t)
6439 org-match-substring-regexp
6440 org-match-substring-with-braces-regexp)
6441 limit t)
6442 (let* ((pos (point)) table-p comment-p
6443 (mpos (match-beginning 3))
6444 (emph-p (get-text-property mpos 'org-emphasis))
6445 (link-p (get-text-property mpos 'mouse-face))
6446 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6447 (goto-char (point-at-bol))
6448 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6449 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6450 (goto-char pos)
6451 ;; Handle a_b^c
6452 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6453 (if (or comment-p emph-p link-p keyw-p)
6455 (put-text-property (match-beginning 3) (match-end 0)
6456 'display
6457 (if (equal (char-after (match-beginning 2)) ?^)
6458 (nth (if table-p 3 1) org-script-display)
6459 (nth (if table-p 2 0) org-script-display)))
6460 (add-text-properties (match-beginning 2) (match-end 2)
6461 (list 'invisible t
6462 'org-dwidth t 'org-dwidth-n 1))
6463 (if (and (eq (char-after (match-beginning 3)) ?{)
6464 (eq (char-before (match-end 3)) ?}))
6465 (progn
6466 (add-text-properties
6467 (match-beginning 3) (1+ (match-beginning 3))
6468 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6469 (add-text-properties
6470 (1- (match-end 3)) (match-end 3)
6471 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6472 t)))))
6474 ;;;; Visibility cycling, including org-goto and indirect buffer
6476 ;;; Cycling
6478 (defvar org-cycle-global-status nil)
6479 (make-variable-buffer-local 'org-cycle-global-status)
6480 (put 'org-cycle-global-status 'org-state t)
6481 (defvar org-cycle-subtree-status nil)
6482 (make-variable-buffer-local 'org-cycle-subtree-status)
6483 (put 'org-cycle-subtree-status 'org-state t)
6485 (defvar org-inlinetask-min-level)
6487 (defun org-unlogged-message (&rest args)
6488 "Display a message, but avoid logging it in the *Messages* buffer."
6489 (let ((message-log-max nil))
6490 (apply 'message args)))
6492 ;;;###autoload
6493 (defun org-cycle (&optional arg)
6494 "TAB-action and visibility cycling for Org-mode.
6496 This is the command invoked in Org-mode by the TAB key. Its main purpose
6497 is outline visibility cycling, but it also invokes other actions
6498 in special contexts.
6500 - When this function is called with a prefix argument, rotate the entire
6501 buffer through 3 states (global cycling)
6502 1. OVERVIEW: Show only top-level headlines.
6503 2. CONTENTS: Show all headlines of all levels, but no body text.
6504 3. SHOW ALL: Show everything.
6505 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6506 determined by the variable `org-startup-folded', and by any VISIBILITY
6507 properties in the buffer.
6508 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6509 including any drawers.
6511 - When inside a table, re-align the table and move to the next field.
6513 - When point is at the beginning of a headline, rotate the subtree started
6514 by this line through 3 different states (local cycling)
6515 1. FOLDED: Only the main headline is shown.
6516 2. CHILDREN: The main headline and the direct children are shown.
6517 From this state, you can move to one of the children
6518 and zoom in further.
6519 3. SUBTREE: Show the entire subtree, including body text.
6520 If there is no subtree, switch directly from CHILDREN to FOLDED.
6522 - When point is at the beginning of an empty headline and the variable
6523 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6524 of the headline by demoting and promoting it to likely levels. This
6525 speeds up creation document structure by pressing TAB once or several
6526 times right after creating a new headline.
6528 - When there is a numeric prefix, go up to a heading with level ARG, do
6529 a `show-subtree' and return to the previous cursor position. If ARG
6530 is negative, go up that many levels.
6532 - When point is not at the beginning of a headline, execute the global
6533 binding for TAB, which is re-indenting the line. See the option
6534 `org-cycle-emulate-tab' for details.
6536 - Special case: if point is at the beginning of the buffer and there is
6537 no headline in line 1, this function will act as if called with prefix arg
6538 (C-u TAB, same as S-TAB) also when called without prefix arg.
6539 But only if also the variable `org-cycle-global-at-bob' is t."
6540 (interactive "P")
6541 (org-load-modules-maybe)
6542 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6543 (and org-cycle-level-after-item/entry-creation
6544 (or (org-cycle-level)
6545 (org-cycle-item-indentation))))
6546 (let* ((limit-level
6547 (or org-cycle-max-level
6548 (and (boundp 'org-inlinetask-min-level)
6549 org-inlinetask-min-level
6550 (1- org-inlinetask-min-level))))
6551 (nstars (and limit-level
6552 (if org-odd-levels-only
6553 (and limit-level (1- (* limit-level 2)))
6554 limit-level)))
6555 (org-outline-regexp
6556 (if (not (derived-mode-p 'org-mode))
6557 outline-regexp
6558 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6559 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6560 (not (looking-at org-outline-regexp))))
6561 (org-cycle-hook
6562 (if bob-special
6563 (delq 'org-optimize-window-after-visibility-change
6564 (copy-sequence org-cycle-hook))
6565 org-cycle-hook))
6566 (pos (point)))
6568 (if (or bob-special (equal arg '(4)))
6569 ;; special case: use global cycling
6570 (setq arg t))
6572 (cond
6574 ((equal arg '(16))
6575 (setq last-command 'dummy)
6576 (org-set-startup-visibility)
6577 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6579 ((equal arg '(64))
6580 (show-all)
6581 (org-unlogged-message "Entire buffer visible, including drawers"))
6583 ;; Table: enter it or move to the next field.
6584 ((org-at-table-p 'any)
6585 (if (org-at-table.el-p)
6586 (message "Use C-c ' to edit table.el tables")
6587 (if arg (org-table-edit-field t)
6588 (org-table-justify-field-maybe)
6589 (call-interactively 'org-table-next-field))))
6591 ((run-hook-with-args-until-success
6592 'org-tab-after-check-for-table-hook))
6594 ;; Global cycling: delegate to `org-cycle-internal-global'.
6595 ((eq arg t) (org-cycle-internal-global))
6597 ;; Drawers: delegate to `org-flag-drawer'.
6598 ((and org-drawers org-drawer-regexp
6599 (save-excursion
6600 (beginning-of-line 1)
6601 (looking-at org-drawer-regexp)))
6602 (org-flag-drawer ; toggle block visibility
6603 (not (get-char-property (match-end 0) 'invisible))))
6605 ;; Show-subtree, ARG levels up from here.
6606 ((integerp arg)
6607 (save-excursion
6608 (org-back-to-heading)
6609 (outline-up-heading (if (< arg 0) (- arg)
6610 (- (funcall outline-level) arg)))
6611 (org-show-subtree)))
6613 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6614 ((and (featurep 'org-inlinetask)
6615 (org-inlinetask-at-task-p)
6616 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6617 (org-inlinetask-toggle-visibility))
6619 ((org-try-cdlatex-tab))
6621 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6622 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6623 (save-excursion (beginning-of-line 1)
6624 (looking-at org-outline-regexp)))
6625 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6626 (org-cycle-internal-local))
6628 ;; From there: TAB emulation and template completion.
6629 (buffer-read-only (org-back-to-heading))
6631 ((run-hook-with-args-until-success
6632 'org-tab-after-check-for-cycling-hook))
6634 ((org-try-structure-completion))
6636 ((run-hook-with-args-until-success
6637 'org-tab-before-tab-emulation-hook))
6639 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6640 (or (not (bolp))
6641 (not (looking-at org-outline-regexp))))
6642 (call-interactively (global-key-binding "\t")))
6644 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6645 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6646 (or (and (eq org-cycle-emulate-tab 'white)
6647 (= (match-end 0) (point-at-eol)))
6648 (and (eq org-cycle-emulate-tab 'whitestart)
6649 (>= (match-end 0) pos))))
6651 (eq org-cycle-emulate-tab t))
6652 (call-interactively (global-key-binding "\t")))
6654 (t (save-excursion
6655 (org-back-to-heading)
6656 (org-cycle)))))))
6658 (defun org-cycle-internal-global ()
6659 "Do the global cycling action."
6660 ;; Hack to avoid display of messages for .org attachments in Gnus
6661 (let ((ga (string-match "\\*fontification" (buffer-name))))
6662 (cond
6663 ((and (eq last-command this-command)
6664 (eq org-cycle-global-status 'overview))
6665 ;; We just created the overview - now do table of contents
6666 ;; This can be slow in very large buffers, so indicate action
6667 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6668 (unless ga (org-unlogged-message "CONTENTS..."))
6669 (org-content)
6670 (unless ga (org-unlogged-message "CONTENTS...done"))
6671 (setq org-cycle-global-status 'contents)
6672 (run-hook-with-args 'org-cycle-hook 'contents))
6674 ((and (eq last-command this-command)
6675 (eq org-cycle-global-status 'contents))
6676 ;; We just showed the table of contents - now show everything
6677 (run-hook-with-args 'org-pre-cycle-hook 'all)
6678 (show-all)
6679 (unless ga (org-unlogged-message "SHOW ALL"))
6680 (setq org-cycle-global-status 'all)
6681 (run-hook-with-args 'org-cycle-hook 'all))
6684 ;; Default action: go to overview
6685 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6686 (org-overview)
6687 (unless ga (org-unlogged-message "OVERVIEW"))
6688 (setq org-cycle-global-status 'overview)
6689 (run-hook-with-args 'org-cycle-hook 'overview)))))
6691 (defvar org-called-with-limited-levels);Dyn-bound in ̀org-with-limited-levels'.
6693 (defun org-cycle-internal-local ()
6694 "Do the local cycling action."
6695 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6696 ;; First, determine end of headline (EOH), end of subtree or item
6697 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6698 (save-excursion
6699 (if (org-at-item-p)
6700 (progn
6701 (beginning-of-line)
6702 (setq struct (org-list-struct))
6703 (setq eoh (point-at-eol))
6704 (setq eos (org-list-get-item-end-before-blank (point) struct))
6705 (setq has-children (org-list-has-child-p (point) struct)))
6706 (org-back-to-heading)
6707 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6708 (setq eos (save-excursion (1- (org-end-of-subtree t t))))
6709 (setq has-children
6710 (or (save-excursion
6711 (let ((level (funcall outline-level)))
6712 (outline-next-heading)
6713 (and (org-at-heading-p t)
6714 (> (funcall outline-level) level))))
6715 (save-excursion
6716 (org-list-search-forward (org-item-beginning-re) eos t)))))
6717 ;; Determine end invisible part of buffer (EOL)
6718 (beginning-of-line 2)
6719 ;; XEmacs doesn't have `next-single-char-property-change'
6720 (if (featurep 'xemacs)
6721 (while (and (not (eobp)) ;; this is like `next-line'
6722 (get-char-property (1- (point)) 'invisible))
6723 (beginning-of-line 2))
6724 (while (and (not (eobp)) ;; this is like `next-line'
6725 (get-char-property (1- (point)) 'invisible))
6726 (goto-char (next-single-char-property-change (point) 'invisible))
6727 (and (eolp) (beginning-of-line 2))))
6728 (setq eol (point)))
6729 ;; Find out what to do next and set `this-command'
6730 (cond
6731 ((= eos eoh)
6732 ;; Nothing is hidden behind this heading
6733 (unless (org-before-first-heading-p)
6734 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6735 (org-unlogged-message "EMPTY ENTRY")
6736 (setq org-cycle-subtree-status nil)
6737 (save-excursion
6738 (goto-char eos)
6739 (outline-next-heading)
6740 (if (outline-invisible-p) (org-flag-heading nil))))
6741 ((and (or (>= eol eos)
6742 (not (string-match "\\S-" (buffer-substring eol eos))))
6743 (or has-children
6744 (not (setq children-skipped
6745 org-cycle-skip-children-state-if-no-children))))
6746 ;; Entire subtree is hidden in one line: children view
6747 (unless (org-before-first-heading-p)
6748 (run-hook-with-args 'org-pre-cycle-hook 'children))
6749 (if (org-at-item-p)
6750 (org-list-set-item-visibility (point-at-bol) struct 'children)
6751 (org-show-entry)
6752 (org-with-limited-levels (show-children))
6753 ;; FIXME: This slows down the func way too much.
6754 ;; How keep drawers hidden in subtree anyway?
6755 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6756 ;; (org-cycle-hide-drawers 'subtree))
6758 ;; Fold every list in subtree to top-level items.
6759 (when (eq org-cycle-include-plain-lists 'integrate)
6760 (save-excursion
6761 (org-back-to-heading)
6762 (while (org-list-search-forward (org-item-beginning-re) eos t)
6763 (beginning-of-line 1)
6764 (let* ((struct (org-list-struct))
6765 (prevs (org-list-prevs-alist struct))
6766 (end (org-list-get-bottom-point struct)))
6767 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6768 (org-list-get-all-items (point) struct prevs))
6769 (goto-char (if (< end eos) end eos)))))))
6770 (org-unlogged-message "CHILDREN")
6771 (save-excursion
6772 (goto-char eos)
6773 (outline-next-heading)
6774 (if (outline-invisible-p) (org-flag-heading nil)))
6775 (setq org-cycle-subtree-status 'children)
6776 (unless (org-before-first-heading-p)
6777 (run-hook-with-args 'org-cycle-hook 'children)))
6778 ((or children-skipped
6779 (and (eq last-command this-command)
6780 (eq org-cycle-subtree-status 'children)))
6781 ;; We just showed the children, or no children are there,
6782 ;; now show everything.
6783 (unless (org-before-first-heading-p)
6784 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6785 (outline-flag-region eoh eos nil)
6786 (org-unlogged-message
6787 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6788 (setq org-cycle-subtree-status 'subtree)
6789 (unless (org-before-first-heading-p)
6790 (run-hook-with-args 'org-cycle-hook 'subtree)))
6792 ;; Default action: hide the subtree.
6793 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6794 (outline-flag-region eoh eos t)
6795 (org-unlogged-message "FOLDED")
6796 (setq org-cycle-subtree-status 'folded)
6797 (unless (org-before-first-heading-p)
6798 (run-hook-with-args 'org-cycle-hook 'folded))))))
6800 ;;;###autoload
6801 (defun org-global-cycle (&optional arg)
6802 "Cycle the global visibility. For details see `org-cycle'.
6803 With \\[universal-argument] prefix arg, switch to startup visibility.
6804 With a numeric prefix, show all headlines up to that level."
6805 (interactive "P")
6806 (let ((org-cycle-include-plain-lists
6807 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6808 (cond
6809 ((integerp arg)
6810 (show-all)
6811 (hide-sublevels arg)
6812 (setq org-cycle-global-status 'contents))
6813 ((equal arg '(4))
6814 (org-set-startup-visibility)
6815 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6817 (org-cycle '(4))))))
6819 (defun org-set-startup-visibility ()
6820 "Set the visibility required by startup options and properties."
6821 (cond
6822 ((eq org-startup-folded t)
6823 (org-overview))
6824 ((eq org-startup-folded 'content)
6825 (org-content))
6826 ((or (eq org-startup-folded 'showeverything)
6827 (eq org-startup-folded nil))
6828 (show-all)))
6829 (unless (eq org-startup-folded 'showeverything)
6830 (if org-hide-block-startup (org-hide-block-all))
6831 (org-set-visibility-according-to-property 'no-cleanup)
6832 (org-cycle-hide-archived-subtrees 'all)
6833 (org-cycle-hide-drawers 'all)
6834 (org-cycle-show-empty-lines t)))
6836 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6837 "Switch subtree visibilities according to :VISIBILITY: property."
6838 (interactive)
6839 (let (org-show-entry-below state)
6840 (save-excursion
6841 (goto-char (point-min))
6842 (while (re-search-forward
6843 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6844 nil t)
6845 (setq state (match-string 1))
6846 (save-excursion
6847 (org-back-to-heading t)
6848 (hide-subtree)
6849 (org-reveal)
6850 (cond
6851 ((equal state '("fold" "folded"))
6852 (hide-subtree))
6853 ((equal state "children")
6854 (org-show-hidden-entry)
6855 (show-children))
6856 ((equal state "content")
6857 (save-excursion
6858 (save-restriction
6859 (org-narrow-to-subtree)
6860 (org-content))))
6861 ((member state '("all" "showall"))
6862 (show-subtree)))))
6863 (unless no-cleanup
6864 (org-cycle-hide-archived-subtrees 'all)
6865 (org-cycle-hide-drawers 'all)
6866 (org-cycle-show-empty-lines 'all)))))
6868 ;; This function uses outline-regexp instead of the more fundamental
6869 ;; org-outline-regexp so that org-cycle-global works outside of Org
6870 ;; buffers, where outline-regexp is needed.
6871 (defun org-overview ()
6872 "Switch to overview mode, showing only top-level headlines.
6873 Really, this shows all headlines with level equal or greater than the level
6874 of the first headline in the buffer. This is important, because if the
6875 first headline is not level one, then (hide-sublevels 1) gives confusing
6876 results."
6877 (interactive)
6878 (let ((pos (point))
6879 (level (save-excursion
6880 (goto-char (point-min))
6881 (if (re-search-forward (concat "^" outline-regexp) nil t)
6882 (progn
6883 (goto-char (match-beginning 0))
6884 (funcall outline-level))))))
6885 (and level (hide-sublevels level))
6886 (recenter '(4))
6887 (goto-char pos)))
6889 (defun org-content (&optional arg)
6890 "Show all headlines in the buffer, like a table of contents.
6891 With numerical argument N, show content up to level N."
6892 (interactive "P")
6893 (org-overview)
6894 (save-excursion
6895 ;; Visit all headings and show their offspring
6896 (and (integerp arg) (org-overview))
6897 (goto-char (point-max))
6898 (catch 'exit
6899 (while (and (progn (condition-case nil
6900 (outline-previous-visible-heading 1)
6901 (error (goto-char (point-min))))
6903 (looking-at org-outline-regexp))
6904 (if (integerp arg)
6905 (show-children (1- arg))
6906 (show-branches))
6907 (if (bobp) (throw 'exit nil))))))
6909 (defun org-optimize-window-after-visibility-change (state)
6910 "Adjust the window after a change in outline visibility.
6911 This function is the default value of the hook `org-cycle-hook'."
6912 (when (get-buffer-window (current-buffer))
6913 (cond
6914 ((eq state 'content) nil)
6915 ((eq state 'all) nil)
6916 ((eq state 'folded) nil)
6917 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6918 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6920 (defun org-remove-empty-overlays-at (pos)
6921 "Remove outline overlays that do not contain non-white stuff."
6922 (mapc
6923 (lambda (o)
6924 (and (eq 'outline (overlay-get o 'invisible))
6925 (not (string-match "\\S-" (buffer-substring (overlay-start o)
6926 (overlay-end o))))
6927 (delete-overlay o)))
6928 (overlays-at pos)))
6930 (defun org-clean-visibility-after-subtree-move ()
6931 "Fix visibility issues after moving a subtree."
6932 ;; First, find a reasonable region to look at:
6933 ;; Start two siblings above, end three below
6934 (let* ((beg (save-excursion
6935 (and (org-get-last-sibling)
6936 (org-get-last-sibling))
6937 (point)))
6938 (end (save-excursion
6939 (and (org-get-next-sibling)
6940 (org-get-next-sibling)
6941 (org-get-next-sibling))
6942 (if (org-at-heading-p)
6943 (point-at-eol)
6944 (point))))
6945 (level (looking-at "\\*+"))
6946 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
6947 (save-excursion
6948 (save-restriction
6949 (narrow-to-region beg end)
6950 (when re
6951 ;; Properly fold already folded siblings
6952 (goto-char (point-min))
6953 (while (re-search-forward re nil t)
6954 (if (and (not (outline-invisible-p))
6955 (save-excursion
6956 (goto-char (point-at-eol)) (outline-invisible-p)))
6957 (hide-entry))))
6958 (org-cycle-show-empty-lines 'overview)
6959 (org-cycle-hide-drawers 'overview)))))
6961 (defun org-cycle-show-empty-lines (state)
6962 "Show empty lines above all visible headlines.
6963 The region to be covered depends on STATE when called through
6964 `org-cycle-hook'. Lisp program can use t for STATE to get the
6965 entire buffer covered. Note that an empty line is only shown if there
6966 are at least `org-cycle-separator-lines' empty lines before the headline."
6967 (when (not (= org-cycle-separator-lines 0))
6968 (save-excursion
6969 (let* ((n (abs org-cycle-separator-lines))
6970 (re (cond
6971 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
6972 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
6973 (t (let ((ns (number-to-string (- n 2))))
6974 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
6975 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
6976 beg end b e)
6977 (cond
6978 ((memq state '(overview contents t))
6979 (setq beg (point-min) end (point-max)))
6980 ((memq state '(children folded))
6981 (setq beg (point) end (progn (org-end-of-subtree t t)
6982 (beginning-of-line 2)
6983 (point)))))
6984 (when beg
6985 (goto-char beg)
6986 (while (re-search-forward re end t)
6987 (unless (get-char-property (match-end 1) 'invisible)
6988 (setq e (match-end 1))
6989 (if (< org-cycle-separator-lines 0)
6990 (setq b (save-excursion
6991 (goto-char (match-beginning 0))
6992 (org-back-over-empty-lines)
6993 (if (save-excursion
6994 (goto-char (max (point-min) (1- (point))))
6995 (org-at-heading-p))
6996 (1- (point))
6997 (point))))
6998 (setq b (match-beginning 1)))
6999 (outline-flag-region b e nil)))))))
7000 ;; Never hide empty lines at the end of the file.
7001 (save-excursion
7002 (goto-char (point-max))
7003 (outline-previous-heading)
7004 (outline-end-of-heading)
7005 (if (and (looking-at "[ \t\n]+")
7006 (= (match-end 0) (point-max)))
7007 (outline-flag-region (point) (match-end 0) nil))))
7009 (defun org-show-empty-lines-in-parent ()
7010 "Move to the parent and re-show empty lines before visible headlines."
7011 (save-excursion
7012 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7013 (org-cycle-show-empty-lines context))))
7015 (defun org-files-list ()
7016 "Return `org-agenda-files' list, plus all open org-mode files.
7017 This is useful for operations that need to scan all of a user's
7018 open and agenda-wise Org files."
7019 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7020 (dolist (buf (buffer-list))
7021 (with-current-buffer buf
7022 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7023 (let ((file (expand-file-name (buffer-file-name))))
7024 (unless (member file files)
7025 (push file files))))))
7026 files))
7028 (defsubst org-entry-beginning-position ()
7029 "Return the beginning position of the current entry."
7030 (save-excursion (outline-back-to-heading t) (point)))
7032 (defsubst org-entry-end-position ()
7033 "Return the end position of the current entry."
7034 (save-excursion (outline-next-heading) (point)))
7036 (defun org-cycle-hide-drawers (state)
7037 "Re-hide all drawers after a visibility state change."
7038 (when (and (derived-mode-p 'org-mode)
7039 (not (memq state '(overview folded contents))))
7040 (save-excursion
7041 (let* ((globalp (memq state '(contents all)))
7042 (beg (if globalp (point-min) (point)))
7043 (end (if globalp (point-max)
7044 (if (eq state 'children)
7045 (save-excursion (outline-next-heading) (point))
7046 (org-end-of-subtree t)))))
7047 (goto-char beg)
7048 (while (re-search-forward org-drawer-regexp end t)
7049 (org-flag-drawer t))))))
7051 (defun org-cycle-hide-inline-tasks (state)
7052 "Re-hide inline tasks when switching to 'contents or 'children
7053 visibility state."
7054 (case state
7055 (contents
7056 (when (org-bound-and-true-p org-inlinetask-min-level)
7057 (hide-sublevels (1- org-inlinetask-min-level))))
7058 (children
7059 (when (featurep 'org-inlinetask)
7060 (save-excursion
7061 (while (and (outline-next-heading)
7062 (org-inlinetask-at-task-p))
7063 (org-inlinetask-toggle-visibility)
7064 (org-inlinetask-goto-end)))))))
7066 (defun org-flag-drawer (flag)
7067 "When FLAG is non-nil, hide the drawer we are within.
7068 Otherwise make it visible."
7069 (save-excursion
7070 (beginning-of-line 1)
7071 (when (looking-at "^[ \t]*:[a-zA-Z][a-zA-Z0-9]*:")
7072 (let ((b (match-end 0)))
7073 (if (re-search-forward
7074 "^[ \t]*:END:"
7075 (save-excursion (outline-next-heading) (point)) t)
7076 (outline-flag-region b (point-at-eol) flag)
7077 (user-error ":END: line missing at position %s" b))))))
7079 (defun org-subtree-end-visible-p ()
7080 "Is the end of the current subtree visible?"
7081 (pos-visible-in-window-p
7082 (save-excursion (org-end-of-subtree t) (point))))
7084 (defun org-first-headline-recenter (&optional N)
7085 "Move cursor to the first headline and recenter the headline.
7086 Optional argument N means put the headline into the Nth line of the window."
7087 (goto-char (point-min))
7088 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7089 (beginning-of-line)
7090 (recenter (prefix-numeric-value N))))
7092 ;;; Saving and restoring visibility
7094 (defun org-outline-overlay-data (&optional use-markers)
7095 "Return a list of the locations of all outline overlays.
7096 These are overlays with the `invisible' property value `outline'.
7097 The return value is a list of cons cells, with start and stop
7098 positions for each overlay.
7099 If USE-MARKERS is set, return the positions as markers."
7100 (let (beg end)
7101 (save-excursion
7102 (save-restriction
7103 (widen)
7104 (delq nil
7105 (mapcar (lambda (o)
7106 (when (eq (overlay-get o 'invisible) 'outline)
7107 (setq beg (overlay-start o)
7108 end (overlay-end o))
7109 (and beg end (> end beg)
7110 (if use-markers
7111 (cons (move-marker (make-marker) beg)
7112 (move-marker (make-marker) end))
7113 (cons beg end)))))
7114 (overlays-in (point-min) (point-max))))))))
7116 (defun org-set-outline-overlay-data (data)
7117 "Create visibility overlays for all positions in DATA.
7118 DATA should have been made by `org-outline-overlay-data'."
7119 (let (o)
7120 (save-excursion
7121 (save-restriction
7122 (widen)
7123 (show-all)
7124 (mapc (lambda (c)
7125 (outline-flag-region (car c) (cdr c) t))
7126 data)))))
7128 ;;; Folding of blocks
7130 (defvar org-hide-block-overlays nil
7131 "Overlays hiding blocks.")
7132 (make-variable-buffer-local 'org-hide-block-overlays)
7134 (defun org-block-map (function &optional start end)
7135 "Call FUNCTION at the head of all source blocks in the current buffer.
7136 Optional arguments START and END can be used to limit the range."
7137 (let ((start (or start (point-min)))
7138 (end (or end (point-max))))
7139 (save-excursion
7140 (goto-char start)
7141 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7142 (save-excursion
7143 (save-match-data
7144 (goto-char (match-beginning 0))
7145 (funcall function)))))))
7147 (defun org-hide-block-toggle-all ()
7148 "Toggle the visibility of all blocks in the current buffer."
7149 (org-block-map #'org-hide-block-toggle))
7151 (defun org-hide-block-all ()
7152 "Fold all blocks in the current buffer."
7153 (interactive)
7154 (org-show-block-all)
7155 (org-block-map #'org-hide-block-toggle-maybe))
7157 (defun org-show-block-all ()
7158 "Unfold all blocks in the current buffer."
7159 (interactive)
7160 (mapc 'delete-overlay org-hide-block-overlays)
7161 (setq org-hide-block-overlays nil))
7163 (defun org-hide-block-toggle-maybe ()
7164 "Toggle visibility of block at point."
7165 (interactive)
7166 (let ((case-fold-search t))
7167 (if (save-excursion
7168 (beginning-of-line 1)
7169 (looking-at org-block-regexp))
7170 (progn (org-hide-block-toggle)
7171 t) ;; to signal that we took action
7172 nil))) ;; to signal that we did not
7174 (defun org-hide-block-toggle (&optional force)
7175 "Toggle the visibility of the current block."
7176 (interactive)
7177 (save-excursion
7178 (beginning-of-line)
7179 (if (re-search-forward org-block-regexp nil t)
7180 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
7181 (end (match-end 0)) ;; end of entire body
7183 (if (memq t (mapcar (lambda (overlay)
7184 (eq (overlay-get overlay 'invisible)
7185 'org-hide-block))
7186 (overlays-at start)))
7187 (if (or (not force) (eq force 'off))
7188 (mapc (lambda (ov)
7189 (when (member ov org-hide-block-overlays)
7190 (setq org-hide-block-overlays
7191 (delq ov org-hide-block-overlays)))
7192 (when (eq (overlay-get ov 'invisible)
7193 'org-hide-block)
7194 (delete-overlay ov)))
7195 (overlays-at start)))
7196 (setq ov (make-overlay start end))
7197 (overlay-put ov 'invisible 'org-hide-block)
7198 ;; make the block accessible to isearch
7199 (overlay-put
7200 ov 'isearch-open-invisible
7201 (lambda (ov)
7202 (when (member ov org-hide-block-overlays)
7203 (setq org-hide-block-overlays
7204 (delq ov org-hide-block-overlays)))
7205 (when (eq (overlay-get ov 'invisible)
7206 'org-hide-block)
7207 (delete-overlay ov))))
7208 (push ov org-hide-block-overlays)))
7209 (user-error "Not looking at a source block"))))
7211 ;; org-tab-after-check-for-cycling-hook
7212 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7213 ;; Remove overlays when changing major mode
7214 (add-hook 'org-mode-hook
7215 (lambda () (org-add-hook 'change-major-mode-hook
7216 'org-show-block-all 'append 'local)))
7218 ;;; Org-goto
7220 (defvar org-goto-window-configuration nil)
7221 (defvar org-goto-marker nil)
7222 (defvar org-goto-map)
7223 (defun org-goto-map ()
7224 "Set the keymap `org-goto'."
7225 (setq org-goto-map
7226 (let ((map (make-sparse-keymap)))
7227 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7228 mouse-drag-region universal-argument org-occur))
7229 cmd)
7230 (while (setq cmd (pop cmds))
7231 (substitute-key-definition cmd cmd map global-map)))
7232 (suppress-keymap map)
7233 (org-defkey map "\C-m" 'org-goto-ret)
7234 (org-defkey map [(return)] 'org-goto-ret)
7235 (org-defkey map [(left)] 'org-goto-left)
7236 (org-defkey map [(right)] 'org-goto-right)
7237 (org-defkey map [(control ?g)] 'org-goto-quit)
7238 (org-defkey map "\C-i" 'org-cycle)
7239 (org-defkey map [(tab)] 'org-cycle)
7240 (org-defkey map [(down)] 'outline-next-visible-heading)
7241 (org-defkey map [(up)] 'outline-previous-visible-heading)
7242 (if org-goto-auto-isearch
7243 (if (fboundp 'define-key-after)
7244 (define-key-after map [t] 'org-goto-local-auto-isearch)
7245 nil)
7246 (org-defkey map "q" 'org-goto-quit)
7247 (org-defkey map "n" 'outline-next-visible-heading)
7248 (org-defkey map "p" 'outline-previous-visible-heading)
7249 (org-defkey map "f" 'outline-forward-same-level)
7250 (org-defkey map "b" 'outline-backward-same-level)
7251 (org-defkey map "u" 'outline-up-heading))
7252 (org-defkey map "/" 'org-occur)
7253 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7254 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7255 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7256 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7257 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7258 map)))
7260 (defconst org-goto-help
7261 "Browse buffer copy, to find location or copy text.%s
7262 RET=jump to location C-g=quit and return to previous location
7263 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7265 (defvar org-goto-start-pos) ; dynamically scoped parameter
7267 (defun org-goto (&optional alternative-interface)
7268 "Look up a different location in the current file, keeping current visibility.
7270 When you want look-up or go to a different location in a
7271 document, the fastest way is often to fold the entire buffer and
7272 then dive into the tree. This method has the disadvantage, that
7273 the previous location will be folded, which may not be what you
7274 want.
7276 This command works around this by showing a copy of the current
7277 buffer in an indirect buffer, in overview mode. You can dive
7278 into the tree in that copy, use org-occur and incremental search
7279 to find a location. When pressing RET or `Q', the command
7280 returns to the original buffer in which the visibility is still
7281 unchanged. After RET it will also jump to the location selected
7282 in the indirect buffer and expose the headline hierarchy above.
7284 With a prefix argument, use the alternative interface: e.g. if
7285 `org-goto-interface' is 'outline use 'outline-path-completion."
7286 (interactive "P")
7287 (org-goto-map)
7288 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7289 (org-refile-use-outline-path t)
7290 (org-refile-target-verify-function nil)
7291 (interface
7292 (if (not alternative-interface)
7293 org-goto-interface
7294 (if (eq org-goto-interface 'outline)
7295 'outline-path-completion
7296 'outline)))
7297 (org-goto-start-pos (point))
7298 (selected-point
7299 (if (eq interface 'outline)
7300 (car (org-get-location (current-buffer) org-goto-help))
7301 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7302 (org-refile-check-position pa)
7303 (nth 3 pa)))))
7304 (if selected-point
7305 (progn
7306 (org-mark-ring-push org-goto-start-pos)
7307 (goto-char selected-point)
7308 (if (or (outline-invisible-p) (org-invisible-p2))
7309 (org-show-context 'org-goto)))
7310 (message "Quit"))))
7312 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7313 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7314 (defvar org-goto-local-auto-isearch-map) ; defined below
7316 (defun org-get-location (buf help)
7317 "Let the user select a location in the Org-mode buffer BUF.
7318 This function uses a recursive edit. It returns the selected position
7319 or nil."
7320 (org-no-popups
7321 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7322 (isearch-hide-immediately nil)
7323 (isearch-search-fun-function
7324 (lambda () 'org-goto-local-search-headings))
7325 (org-goto-selected-point org-goto-exit-command))
7326 (save-excursion
7327 (save-window-excursion
7328 (delete-other-windows)
7329 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7330 (org-pop-to-buffer-same-window
7331 (condition-case nil
7332 (make-indirect-buffer (current-buffer) "*org-goto*")
7333 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7334 (with-output-to-temp-buffer "*Org Help*"
7335 (princ (format help (if org-goto-auto-isearch
7336 " Just type for auto-isearch."
7337 " n/p/f/b/u to navigate, q to quit."))))
7338 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7339 (setq buffer-read-only nil)
7340 (let ((org-startup-truncated t)
7341 (org-startup-folded nil)
7342 (org-startup-align-all-tables nil))
7343 (org-mode)
7344 (org-overview))
7345 (setq buffer-read-only t)
7346 (if (and (boundp 'org-goto-start-pos)
7347 (integer-or-marker-p org-goto-start-pos))
7348 (let ((org-show-hierarchy-above t)
7349 (org-show-siblings t)
7350 (org-show-following-heading t))
7351 (goto-char org-goto-start-pos)
7352 (and (outline-invisible-p) (org-show-context)))
7353 (goto-char (point-min)))
7354 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7355 (message "Select location and press RET")
7356 (use-local-map org-goto-map)
7357 (recursive-edit)))
7358 (kill-buffer "*org-goto*")
7359 (cons org-goto-selected-point org-goto-exit-command))))
7361 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7362 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7363 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7364 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7366 (defun org-goto-local-search-headings (string bound noerror)
7367 "Search and make sure that any matches are in headlines."
7368 (catch 'return
7369 (while (if isearch-forward
7370 (search-forward string bound noerror)
7371 (search-backward string bound noerror))
7372 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7373 (and (member :headline context)
7374 (not (member :tags context))))
7375 (throw 'return (point))))))
7377 (defun org-goto-local-auto-isearch ()
7378 "Start isearch."
7379 (interactive)
7380 (goto-char (point-min))
7381 (let ((keys (this-command-keys)))
7382 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7383 (isearch-mode t)
7384 (isearch-process-search-char (string-to-char keys)))))
7386 (defun org-goto-ret (&optional arg)
7387 "Finish `org-goto' by going to the new location."
7388 (interactive "P")
7389 (setq org-goto-selected-point (point)
7390 org-goto-exit-command 'return)
7391 (throw 'exit nil))
7393 (defun org-goto-left ()
7394 "Finish `org-goto' by going to the new location."
7395 (interactive)
7396 (if (org-at-heading-p)
7397 (progn
7398 (beginning-of-line 1)
7399 (setq org-goto-selected-point (point)
7400 org-goto-exit-command 'left)
7401 (throw 'exit nil))
7402 (user-error "Not on a heading")))
7404 (defun org-goto-right ()
7405 "Finish `org-goto' by going to the new location."
7406 (interactive)
7407 (if (org-at-heading-p)
7408 (progn
7409 (setq org-goto-selected-point (point)
7410 org-goto-exit-command 'right)
7411 (throw 'exit nil))
7412 (user-error "Not on a heading")))
7414 (defun org-goto-quit ()
7415 "Finish `org-goto' without cursor motion."
7416 (interactive)
7417 (setq org-goto-selected-point nil)
7418 (setq org-goto-exit-command 'quit)
7419 (throw 'exit nil))
7421 ;;; Indirect buffer display of subtrees
7423 (defvar org-indirect-dedicated-frame nil
7424 "This is the frame being used for indirect tree display.")
7425 (defvar org-last-indirect-buffer nil)
7427 (defun org-tree-to-indirect-buffer (&optional arg)
7428 "Create indirect buffer and narrow it to current subtree.
7429 With a numerical prefix ARG, go up to this level and then take that tree.
7430 If ARG is negative, go up that many levels.
7432 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7433 indirect buffer previously made with this command, to avoid proliferation of
7434 indirect buffers. However, when you call the command with a \
7435 \\[universal-argument] prefix, or
7436 when `org-indirect-buffer-display' is `new-frame', the last buffer
7437 is kept so that you can work with several indirect buffers at the same time.
7438 If `org-indirect-buffer-display' is `dedicated-frame', the \
7439 \\[universal-argument] prefix also
7440 requests that a new frame be made for the new buffer, so that the dedicated
7441 frame is not changed."
7442 (interactive "P")
7443 (let ((cbuf (current-buffer))
7444 (cwin (selected-window))
7445 (pos (point))
7446 beg end level heading ibuf)
7447 (save-excursion
7448 (org-back-to-heading t)
7449 (when (numberp arg)
7450 (setq level (org-outline-level))
7451 (if (< arg 0) (setq arg (+ level arg)))
7452 (while (> (setq level (org-outline-level)) arg)
7453 (org-up-heading-safe)))
7454 (setq beg (point)
7455 heading (org-get-heading))
7456 (org-end-of-subtree t t)
7457 (if (org-at-heading-p) (backward-char 1))
7458 (setq end (point)))
7459 (if (and (buffer-live-p org-last-indirect-buffer)
7460 (not (eq org-indirect-buffer-display 'new-frame))
7461 (not arg))
7462 (kill-buffer org-last-indirect-buffer))
7463 (setq ibuf (org-get-indirect-buffer cbuf)
7464 org-last-indirect-buffer ibuf)
7465 (cond
7466 ((or (eq org-indirect-buffer-display 'new-frame)
7467 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7468 (select-frame (make-frame))
7469 (delete-other-windows)
7470 (org-pop-to-buffer-same-window ibuf)
7471 (org-set-frame-title heading))
7472 ((eq org-indirect-buffer-display 'dedicated-frame)
7473 (raise-frame
7474 (select-frame (or (and org-indirect-dedicated-frame
7475 (frame-live-p org-indirect-dedicated-frame)
7476 org-indirect-dedicated-frame)
7477 (setq org-indirect-dedicated-frame (make-frame)))))
7478 (delete-other-windows)
7479 (org-pop-to-buffer-same-window ibuf)
7480 (org-set-frame-title (concat "Indirect: " heading)))
7481 ((eq org-indirect-buffer-display 'current-window)
7482 (org-pop-to-buffer-same-window ibuf))
7483 ((eq org-indirect-buffer-display 'other-window)
7484 (pop-to-buffer ibuf))
7485 (t (error "Invalid value")))
7486 (if (featurep 'xemacs)
7487 (save-excursion (org-mode) (turn-on-font-lock)))
7488 (narrow-to-region beg end)
7489 (show-all)
7490 (goto-char pos)
7491 (run-hook-with-args 'org-cycle-hook 'all)
7492 (and (window-live-p cwin) (select-window cwin))))
7494 (defun org-get-indirect-buffer (&optional buffer)
7495 (setq buffer (or buffer (current-buffer)))
7496 (let ((n 1) (base (buffer-name buffer)) bname)
7497 (while (buffer-live-p
7498 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7499 (setq n (1+ n)))
7500 (condition-case nil
7501 (make-indirect-buffer buffer bname 'clone)
7502 (error (make-indirect-buffer buffer bname)))))
7504 (defun org-set-frame-title (title)
7505 "Set the title of the current frame to the string TITLE."
7506 ;; FIXME: how to name a single frame in XEmacs???
7507 (unless (featurep 'xemacs)
7508 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7510 ;;;; Structure editing
7512 ;;; Inserting headlines
7514 (defun org-previous-line-empty-p (&optional next)
7515 "Is the previous line a blank line?
7516 When NEXT is non-nil, check the next line instead."
7517 (save-excursion
7518 (and (not (bobp))
7519 (or (beginning-of-line (if next 2 0)) t)
7520 (save-match-data
7521 (looking-at "[ \t]*$")))))
7523 (defun org-insert-heading (&optional arg invisible-ok)
7524 "Insert a new heading or item with same depth at point.
7525 If point is in a plain list and ARG is nil, create a new list item.
7526 With one universal prefix argument, insert a heading even in lists.
7527 With two universal prefix arguments, insert the heading at the end
7528 of the parent subtree.
7530 If point is at the beginning of a headline, insert a sibling before
7531 the current headline. If point is not at the beginning, split the line
7532 and create a new headline with the text in the current line after point
7533 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7535 If point is at the beginning of a normal line, turn this line into
7536 a heading.
7538 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7539 This is important for non-interactive uses of the command."
7540 (interactive "P")
7541 (if (org-called-interactively-p 'any) (org-reveal))
7542 (let ((itemp (org-in-item-p))
7543 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7544 (respect-content (or org-insert-heading-respect-content
7545 (equal arg '(4))))
7546 (initial-content "")
7547 (adjust-empty-lines t))
7549 (cond
7551 ((or (= (buffer-size) 0)
7552 (and (not (save-excursion
7553 (and (ignore-errors (org-back-to-heading invisible-ok))
7554 (org-at-heading-p))))
7555 (or arg (not itemp))))
7556 ;; At beginning of buffer or so high up that only a heading
7557 ;; makes sense.
7558 (insert
7559 (if (or (bobp) (org-previous-line-empty-p)) "" "\n")
7560 (if (org-in-src-block-p) ",* " "* "))
7561 (run-hooks 'org-insert-heading-hook))
7563 ((and itemp (not (equal arg '(4))))
7564 ;; Insert an item
7565 (org-insert-item))
7568 ;; Maybe move at the end of the subtree
7569 (when (equal arg '(16))
7570 (org-up-heading-safe)
7571 (org-end-of-subtree t))
7572 ;; Insert a heading
7573 (save-restriction
7574 (widen)
7575 (let* ((level nil)
7576 (on-heading (org-at-heading-p))
7577 (empty-line-p (if on-heading
7578 (org-previous-line-empty-p)
7579 ;; We will decide later
7580 nil))
7581 ;; Get a level string to fall back on
7582 (fix-level
7583 (save-excursion
7584 (org-back-to-heading t)
7585 (if (org-previous-line-empty-p) (setq empty-line-p t))
7586 (looking-at org-outline-regexp)
7587 (make-string (1- (length (match-string 0))) ?*)))
7588 (stars
7589 (save-excursion
7590 (condition-case nil
7591 (progn
7592 (org-back-to-heading invisible-ok)
7593 (when (and (not on-heading)
7594 (featurep 'org-inlinetask)
7595 (integerp org-inlinetask-min-level)
7596 (>= (length (match-string 0))
7597 org-inlinetask-min-level))
7598 ;; Find a heading level before the inline task
7599 (while (and (setq level (org-up-heading-safe))
7600 (>= level org-inlinetask-min-level)))
7601 (if (org-at-heading-p)
7602 (org-back-to-heading invisible-ok)
7603 (error "This should not happen")))
7604 (unless (and (save-excursion
7605 (save-match-data
7606 (org-backward-heading-same-level
7607 1 invisible-ok))
7608 (= (point) (match-beginning 0)))
7609 (not (org-previous-line-empty-p t)))
7610 (setq empty-line-p (or empty-line-p
7611 (org-previous-line-empty-p))))
7612 (match-string 0))
7613 (error (or fix-level "* ")))))
7614 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7615 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7616 pos hide-previous previous-pos)
7618 ;; If we insert after content, move there and clean up whitespace
7619 (when respect-content
7620 (org-end-of-subtree nil t)
7621 (skip-chars-backward " \r\n")
7622 (and (looking-at "[ \t]+") (replace-match ""))
7623 (unless (eobp) (forward-char 1))
7624 (when (looking-at "^\\*")
7625 (unless (bobp) (backward-char 1))
7626 (insert "\n")))
7628 ;; If we are splitting, grab the text that should be moved to the new headline
7629 (when may-split
7630 (if (org-on-heading-p)
7631 ;; This is a heading, we split intelligently (keeping tags)
7632 (let ((pos (point)))
7633 (goto-char (point-at-bol))
7634 (unless (looking-at org-complex-heading-regexp)
7635 (error "This should not happen"))
7636 (when (and (match-beginning 4)
7637 (> pos (match-beginning 4))
7638 (< pos (match-end 4)))
7639 (setq initial-content (buffer-substring pos (match-end 4)))
7640 (goto-char pos)
7641 (delete-region (point) (match-end 4))
7642 (if (looking-at "[ \t]*$")
7643 (replace-match "")
7644 (insert (make-string (length initial-content) ?\ )))
7645 (setq initial-content (org-trim initial-content)))
7646 (goto-char pos))
7647 ;; a normal line
7648 (unless (bolp)
7649 (setq initial-content (buffer-substring (point) (point-at-eol)))
7650 (delete-region (point) (point-at-eol))
7651 (setq initial-content (org-trim initial-content)))))
7653 ;; If we are at the beginning of the line, insert before it. Else after
7654 (cond
7655 ((and (bolp) (looking-at "[ \t]*$")))
7656 ((and (bolp) (not (looking-at "[ \t]*$")))
7657 (open-line 1))
7659 (goto-char (point-at-eol))
7660 (insert "\n")))
7662 ;; Insert the new heading
7663 (insert stars)
7664 (just-one-space)
7665 (insert initial-content)
7666 (when adjust-empty-lines
7667 (if (or (not blank)
7668 (and blank (not (org-previous-line-empty-p))))
7669 (org-N-empty-lines-before-current (if blank 1 0))))
7670 (run-hooks 'org-insert-heading-hook)))))))
7672 (defun org-N-empty-lines-before-current (N)
7673 "Make the number of empty lines before current exactly N.
7674 So this will delete or add empty lines."
7675 (save-excursion
7676 (goto-char (point-at-bol))
7677 (if (looking-back "\\s-+" nil 'greedy)
7678 (replace-match ""))
7679 (or (bobp) (insert "\n"))
7680 (while (> N 0)
7681 (insert "\n")
7682 (setq N (1- N)))))
7684 (defun org-get-heading (&optional no-tags no-todo)
7685 "Return the heading of the current entry, without the stars.
7686 When NO-TAGS is non-nil, don't include tags.
7687 When NO-TODO is non-nil, don't include TODO keywords."
7688 (save-excursion
7689 (org-back-to-heading t)
7690 (cond
7691 ((and no-tags no-todo)
7692 (looking-at org-complex-heading-regexp)
7693 (match-string 4))
7694 (no-tags
7695 (looking-at (concat org-outline-regexp
7696 "\\(.*?\\)"
7697 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7698 (match-string 1))
7699 (no-todo
7700 (looking-at org-todo-line-regexp)
7701 (match-string 3))
7702 (t (looking-at org-heading-regexp)
7703 (match-string 2)))))
7705 (defvar orgstruct-mode) ; defined below
7707 (defun org-heading-components ()
7708 "Return the components of the current heading.
7709 This is a list with the following elements:
7710 - the level as an integer
7711 - the reduced level, different if `org-odd-levels-only' is set.
7712 - the TODO keyword, or nil
7713 - the priority character, like ?A, or nil if no priority is given
7714 - the headline text itself, or the tags string if no headline text
7715 - the tags string, or nil."
7716 (save-excursion
7717 (org-back-to-heading t)
7718 (if (let (case-fold-search)
7719 (looking-at
7720 (if orgstruct-mode
7721 org-heading-regexp
7722 org-complex-heading-regexp)))
7723 (if orgstruct-mode
7724 (list (length (match-string 1))
7725 (org-reduced-level (length (match-string 1)))
7728 (match-string 2)
7729 nil)
7730 (list (length (match-string 1))
7731 (org-reduced-level (length (match-string 1)))
7732 (org-match-string-no-properties 2)
7733 (and (match-end 3) (aref (match-string 3) 2))
7734 (org-match-string-no-properties 4)
7735 (org-match-string-no-properties 5))))))
7737 (defun org-get-entry ()
7738 "Get the entry text, after heading, entire subtree."
7739 (save-excursion
7740 (org-back-to-heading t)
7741 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7743 (defun org-insert-heading-after-current ()
7744 "Insert a new heading with same level as current, after current subtree."
7745 (interactive)
7746 (org-back-to-heading)
7747 (org-insert-heading)
7748 (org-move-subtree-down)
7749 (end-of-line 1))
7751 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7752 "Insert heading with `org-insert-heading-respect-content' set to t."
7753 (interactive "P")
7754 (let ((org-insert-heading-respect-content t))
7755 (org-insert-heading '(4) invisible-ok)))
7757 (defun org-insert-todo-heading-respect-content (&optional force-state)
7758 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7759 (interactive "P")
7760 (let ((org-insert-heading-respect-content t))
7761 (org-insert-todo-heading force-state '(4))))
7763 (defun org-insert-todo-heading (arg &optional force-heading)
7764 "Insert a new heading with the same level and TODO state as current heading.
7765 If the heading has no TODO state, or if the state is DONE, use the first
7766 state (TODO by default). Also with one prefix arg, force first state. With
7767 two prefix args, force inserting at the end of the parent subtree."
7768 (interactive "P")
7769 (when (or force-heading (not (org-insert-item 'checkbox)))
7770 (org-insert-heading (or (and (equal arg '(16)) '(16))
7771 force-heading))
7772 (save-excursion
7773 (org-back-to-heading)
7774 (outline-previous-heading)
7775 (looking-at org-todo-line-regexp))
7776 (let*
7777 ((new-mark-x
7778 (if (or (equal arg '(4))
7779 (not (match-beginning 2))
7780 (member (match-string 2) org-done-keywords))
7781 (car org-todo-keywords-1)
7782 (match-string 2)))
7783 (new-mark
7785 (run-hook-with-args-until-success
7786 'org-todo-get-default-hook new-mark-x nil)
7787 new-mark-x)))
7788 (beginning-of-line 1)
7789 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7790 (if org-treat-insert-todo-heading-as-state-change
7791 (org-todo new-mark)
7792 (insert new-mark " "))))
7793 (when org-provide-todo-statistics
7794 (org-update-parent-todo-statistics))))
7796 (defun org-insert-subheading (arg)
7797 "Insert a new subheading and demote it.
7798 Works for outline headings and for plain lists alike."
7799 (interactive "P")
7800 (org-insert-heading arg)
7801 (cond
7802 ((org-at-heading-p) (org-do-demote))
7803 ((org-at-item-p) (org-indent-item))))
7805 (defun org-insert-todo-subheading (arg)
7806 "Insert a new subheading with TODO keyword or checkbox and demote it.
7807 Works for outline headings and for plain lists alike."
7808 (interactive "P")
7809 (org-insert-todo-heading arg)
7810 (cond
7811 ((org-at-heading-p) (org-do-demote))
7812 ((org-at-item-p) (org-indent-item))))
7814 ;;; Promotion and Demotion
7816 (defvar org-after-demote-entry-hook nil
7817 "Hook run after an entry has been demoted.
7818 The cursor will be at the beginning of the entry.
7819 When a subtree is being demoted, the hook will be called for each node.")
7821 (defvar org-after-promote-entry-hook nil
7822 "Hook run after an entry has been promoted.
7823 The cursor will be at the beginning of the entry.
7824 When a subtree is being promoted, the hook will be called for each node.")
7826 (defun org-promote-subtree ()
7827 "Promote the entire subtree.
7828 See also `org-promote'."
7829 (interactive)
7830 (save-excursion
7831 (org-with-limited-levels (org-map-tree 'org-promote)))
7832 (org-fix-position-after-promote))
7834 (defun org-demote-subtree ()
7835 "Demote the entire subtree. See `org-demote'.
7836 See also `org-promote'."
7837 (interactive)
7838 (save-excursion
7839 (org-with-limited-levels (org-map-tree 'org-demote)))
7840 (org-fix-position-after-promote))
7843 (defun org-do-promote ()
7844 "Promote the current heading higher up the tree.
7845 If the region is active in `transient-mark-mode', promote all headings
7846 in the region."
7847 (interactive)
7848 (save-excursion
7849 (if (org-region-active-p)
7850 (org-map-region 'org-promote (region-beginning) (region-end))
7851 (org-promote)))
7852 (org-fix-position-after-promote))
7854 (defun org-do-demote ()
7855 "Demote the current heading lower down the tree.
7856 If the region is active in `transient-mark-mode', demote all headings
7857 in the region."
7858 (interactive)
7859 (save-excursion
7860 (if (org-region-active-p)
7861 (org-map-region 'org-demote (region-beginning) (region-end))
7862 (org-demote)))
7863 (org-fix-position-after-promote))
7865 (defun org-fix-position-after-promote ()
7866 "Make sure that after pro/demotion cursor position is right."
7867 (let ((pos (point)))
7868 (when (save-excursion
7869 (beginning-of-line 1)
7870 (looking-at org-todo-line-regexp)
7871 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7872 (cond ((eobp) (insert " "))
7873 ((eolp) (insert " "))
7874 ((equal (char-after) ?\ ) (forward-char 1))))))
7876 (defun org-current-level ()
7877 "Return the level of the current entry, or nil if before the first headline.
7878 The level is the number of stars at the beginning of the headline."
7879 (save-excursion
7880 (org-with-limited-levels
7881 (if (ignore-errors (org-back-to-heading t))
7882 (funcall outline-level)))))
7884 (defun org-get-previous-line-level ()
7885 "Return the outline depth of the last headline before the current line.
7886 Returns 0 for the first headline in the buffer, and nil if before the
7887 first headline."
7888 (and (org-current-level)
7889 (or (and (/= (line-beginning-position) (point-min))
7890 (save-excursion (beginning-of-line 0) (org-current-level)))
7891 0)))
7893 (defun org-reduced-level (l)
7894 "Compute the effective level of a heading.
7895 This takes into account the setting of `org-odd-levels-only'."
7896 (cond
7897 ((zerop l) 0)
7898 (org-odd-levels-only (1+ (floor (/ l 2))))
7899 (t l)))
7901 (defun org-level-increment ()
7902 "Return the number of stars that will be added or removed at a
7903 time to headlines when structure editing, based on the value of
7904 `org-odd-levels-only'."
7905 (if org-odd-levels-only 2 1))
7907 (defun org-get-valid-level (level &optional change)
7908 "Rectify a level change under the influence of `org-odd-levels-only'
7909 LEVEL is a current level, CHANGE is by how much the level should be
7910 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7911 even level numbers will become the next higher odd number."
7912 (if org-odd-levels-only
7913 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7914 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7915 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7916 (max 1 (+ level (or change 0)))))
7918 (if (boundp 'define-obsolete-function-alias)
7919 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7920 (define-obsolete-function-alias 'org-get-legal-level
7921 'org-get-valid-level)
7922 (define-obsolete-function-alias 'org-get-legal-level
7923 'org-get-valid-level "23.1")))
7925 (defun org-promote ()
7926 "Promote the current heading higher up the tree.
7927 If the region is active in `transient-mark-mode', promote all headings
7928 in the region."
7929 (org-back-to-heading t)
7930 (let* ((level (save-match-data (funcall outline-level)))
7931 (after-change-functions (remove 'flyspell-after-change-function
7932 after-change-functions))
7933 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7934 (diff (abs (- level (length up-head) -1))))
7935 (cond ((and (= level 1) org-called-with-limited-levels
7936 org-allow-promoting-top-level-subtree)
7937 (replace-match "# " nil t))
7938 ((= level 1)
7939 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
7940 (t (replace-match up-head nil t)))
7941 ;; Fixup tag positioning
7942 (unless (= level 1)
7943 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
7944 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7945 (run-hooks 'org-after-promote-entry-hook)))
7947 (defun org-demote ()
7948 "Demote the current heading lower down the tree.
7949 If the region is active in `transient-mark-mode', demote all headings
7950 in the region."
7951 (org-back-to-heading t)
7952 (let* ((level (save-match-data (funcall outline-level)))
7953 (after-change-functions (remove 'flyspell-after-change-function
7954 after-change-functions))
7955 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7956 (diff (abs (- level (length down-head) -1))))
7957 (replace-match down-head nil t)
7958 ;; Fixup tag positioning
7959 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
7960 (if org-adapt-indentation (org-fixup-indentation diff))
7961 (run-hooks 'org-after-demote-entry-hook)))
7963 (defun org-cycle-level ()
7964 "Cycle the level of an empty headline through possible states.
7965 This goes first to child, then to parent, level, then up the hierarchy.
7966 After top level, it switches back to sibling level."
7967 (interactive)
7968 (let ((org-adapt-indentation nil))
7969 (when (org-point-at-end-of-empty-headline)
7970 (setq this-command 'org-cycle-level) ; Only needed for caching
7971 (let ((cur-level (org-current-level))
7972 (prev-level (org-get-previous-line-level)))
7973 (cond
7974 ;; If first headline in file, promote to top-level.
7975 ((= prev-level 0)
7976 (loop repeat (/ (- cur-level 1) (org-level-increment))
7977 do (org-do-promote)))
7978 ;; If same level as prev, demote one.
7979 ((= prev-level cur-level)
7980 (org-do-demote))
7981 ;; If parent is top-level, promote to top level if not already.
7982 ((= prev-level 1)
7983 (loop repeat (/ (- cur-level 1) (org-level-increment))
7984 do (org-do-promote)))
7985 ;; If top-level, return to prev-level.
7986 ((= cur-level 1)
7987 (loop repeat (/ (- prev-level 1) (org-level-increment))
7988 do (org-do-demote)))
7989 ;; If less than prev-level, promote one.
7990 ((< cur-level prev-level)
7991 (org-do-promote))
7992 ;; If deeper than prev-level, promote until higher than
7993 ;; prev-level.
7994 ((> cur-level prev-level)
7995 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7996 do (org-do-promote))))
7997 t))))
7999 (defun org-map-tree (fun)
8000 "Call FUN for every heading underneath the current one."
8001 (org-back-to-heading)
8002 (let ((level (funcall outline-level)))
8003 (save-excursion
8004 (funcall fun)
8005 (while (and (progn
8006 (outline-next-heading)
8007 (> (funcall outline-level) level))
8008 (not (eobp)))
8009 (funcall fun)))))
8011 (defun org-map-region (fun beg end)
8012 "Call FUN for every heading between BEG and END."
8013 (let ((org-ignore-region t))
8014 (save-excursion
8015 (setq end (copy-marker end))
8016 (goto-char beg)
8017 (if (and (re-search-forward org-outline-regexp-bol nil t)
8018 (< (point) end))
8019 (funcall fun))
8020 (while (and (progn
8021 (outline-next-heading)
8022 (< (point) end))
8023 (not (eobp)))
8024 (funcall fun)))))
8026 (defvar org-property-end-re) ; silence byte-compiler
8027 (defun org-fixup-indentation (diff)
8028 "Change the indentation in the current entry by DIFF.
8029 However, if any line in the current entry has no indentation, or if it
8030 would end up with no indentation after the change, nothing at all is done."
8031 (save-excursion
8032 (let ((end (save-excursion (outline-next-heading)
8033 (point-marker)))
8034 (prohibit (if (> diff 0)
8035 "^\\S-"
8036 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8037 col)
8038 (unless (save-excursion (end-of-line 1)
8039 (re-search-forward prohibit end t))
8040 (while (and (< (point) end)
8041 (re-search-forward "^[ \t]+" end t))
8042 (goto-char (match-end 0))
8043 (setq col (current-column))
8044 (if (< diff 0) (replace-match ""))
8045 (org-indent-to-column (+ diff col))))
8046 (move-marker end nil))))
8048 (defun org-convert-to-odd-levels ()
8049 "Convert an org-mode file with all levels allowed to one with odd levels.
8050 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8051 level 5 etc."
8052 (interactive)
8053 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8054 (let ((outline-level 'org-outline-level)
8055 (org-odd-levels-only nil) n)
8056 (save-excursion
8057 (goto-char (point-min))
8058 (while (re-search-forward "^\\*\\*+ " nil t)
8059 (setq n (- (length (match-string 0)) 2))
8060 (while (>= (setq n (1- n)) 0)
8061 (org-demote))
8062 (end-of-line 1))))))
8064 (defun org-convert-to-oddeven-levels ()
8065 "Convert an org-mode file with only odd levels to one with odd/even levels.
8066 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8067 file contains a section with an even level, conversion would
8068 destroy the structure of the file. An error is signaled in this
8069 case."
8070 (interactive)
8071 (goto-char (point-min))
8072 ;; First check if there are no even levels
8073 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8074 (org-show-context t)
8075 (error "Not all levels are odd in this file. Conversion not possible"))
8076 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8077 (let ((outline-regexp org-outline-regexp)
8078 (outline-level 'org-outline-level)
8079 (org-odd-levels-only nil) n)
8080 (save-excursion
8081 (goto-char (point-min))
8082 (while (re-search-forward "^\\*\\*+ " nil t)
8083 (setq n (/ (1- (length (match-string 0))) 2))
8084 (while (>= (setq n (1- n)) 0)
8085 (org-promote))
8086 (end-of-line 1))))))
8088 (defun org-tr-level (n)
8089 "Make N odd if required."
8090 (if org-odd-levels-only (1+ (/ n 2)) n))
8092 ;;; Vertical tree motion, cutting and pasting of subtrees
8094 (defun org-move-subtree-up (&optional arg)
8095 "Move the current subtree up past ARG headlines of the same level."
8096 (interactive "p")
8097 (org-move-subtree-down (- (prefix-numeric-value arg))))
8099 (defun org-move-subtree-down (&optional arg)
8100 "Move the current subtree down past ARG headlines of the same level."
8101 (interactive "p")
8102 (setq arg (prefix-numeric-value arg))
8103 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8104 'org-get-last-sibling))
8105 (ins-point (make-marker))
8106 (cnt (abs arg))
8107 (col (current-column))
8108 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8109 ;; Select the tree
8110 (org-back-to-heading)
8111 (setq beg0 (point))
8112 (save-excursion
8113 (setq ne-beg (org-back-over-empty-lines))
8114 (setq beg (point)))
8115 (save-match-data
8116 (save-excursion (outline-end-of-heading)
8117 (setq folded (outline-invisible-p)))
8118 (outline-end-of-subtree))
8119 (outline-next-heading)
8120 (setq ne-end (org-back-over-empty-lines))
8121 (setq end (point))
8122 (goto-char beg0)
8123 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8124 ;; include less whitespace
8125 (save-excursion
8126 (goto-char beg)
8127 (forward-line (- ne-beg ne-end))
8128 (setq beg (point))))
8129 ;; Find insertion point, with error handling
8130 (while (> cnt 0)
8131 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8132 (progn (goto-char beg0)
8133 (user-error "Cannot move past superior level or buffer limit")))
8134 (setq cnt (1- cnt)))
8135 (if (> arg 0)
8136 ;; Moving forward - still need to move over subtree
8137 (progn (org-end-of-subtree t t)
8138 (save-excursion
8139 (org-back-over-empty-lines)
8140 (or (bolp) (newline)))))
8141 (setq ne-ins (org-back-over-empty-lines))
8142 (move-marker ins-point (point))
8143 (setq txt (buffer-substring beg end))
8144 (org-save-markers-in-region beg end)
8145 (delete-region beg end)
8146 (org-remove-empty-overlays-at beg)
8147 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8148 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8149 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8150 (let ((bbb (point)))
8151 (insert-before-markers txt)
8152 (org-reinstall-markers-in-region bbb)
8153 (move-marker ins-point bbb))
8154 (or (bolp) (insert "\n"))
8155 (setq ins-end (point))
8156 (goto-char ins-point)
8157 (org-skip-whitespace)
8158 (when (and (< arg 0)
8159 (org-first-sibling-p)
8160 (> ne-ins ne-beg))
8161 ;; Move whitespace back to beginning
8162 (save-excursion
8163 (goto-char ins-end)
8164 (let ((kill-whole-line t))
8165 (kill-line (- ne-ins ne-beg)) (point)))
8166 (insert (make-string (- ne-ins ne-beg) ?\n)))
8167 (move-marker ins-point nil)
8168 (if folded
8169 (hide-subtree)
8170 (org-show-entry)
8171 (show-children)
8172 (org-cycle-hide-drawers 'children))
8173 (org-clean-visibility-after-subtree-move)
8174 ;; move back to the initial column we were at
8175 (move-to-column col)))
8177 (defvar org-subtree-clip ""
8178 "Clipboard for cut and paste of subtrees.
8179 This is actually only a copy of the kill, because we use the normal kill
8180 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8182 (defvar org-subtree-clip-folded nil
8183 "Was the last copied subtree folded?
8184 This is used to fold the tree back after pasting.")
8186 (defun org-cut-subtree (&optional n)
8187 "Cut the current subtree into the clipboard.
8188 With prefix arg N, cut this many sequential subtrees.
8189 This is a short-hand for marking the subtree and then cutting it."
8190 (interactive "p")
8191 (org-copy-subtree n 'cut))
8193 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8194 "Copy the current subtree it in the clipboard.
8195 With prefix arg N, copy this many sequential subtrees.
8196 This is a short-hand for marking the subtree and then copying it.
8197 If CUT is non-nil, actually cut the subtree.
8198 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8199 of some markers in the region, even if CUT is non-nil. This is
8200 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8201 (interactive "p")
8202 (let (beg end folded (beg0 (point)))
8203 (if (org-called-interactively-p 'any)
8204 (org-back-to-heading nil) ; take what looks like a subtree
8205 (org-back-to-heading t)) ; take what is really there
8206 (setq beg (point))
8207 (skip-chars-forward " \t\r\n")
8208 (save-match-data
8209 (if nosubtrees
8210 (outline-next-heading)
8211 (save-excursion (outline-end-of-heading)
8212 (setq folded (outline-invisible-p)))
8213 (condition-case nil
8214 (org-forward-heading-same-level (1- n) t)
8215 (error nil))
8216 (org-end-of-subtree t t)))
8217 (setq end (point))
8218 (goto-char beg0)
8219 (when (> end beg)
8220 (setq org-subtree-clip-folded folded)
8221 (when (or cut force-store-markers)
8222 (org-save-markers-in-region beg end))
8223 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8224 (setq org-subtree-clip (current-kill 0))
8225 (message "%s: Subtree(s) with %d characters"
8226 (if cut "Cut" "Copied")
8227 (length org-subtree-clip)))))
8229 (defun org-paste-subtree (&optional level tree for-yank)
8230 "Paste the clipboard as a subtree, with modification of headline level.
8231 The entire subtree is promoted or demoted in order to match a new headline
8232 level.
8234 If the cursor is at the beginning of a headline, the same level as
8235 that headline is used to paste the tree.
8237 If not, the new level is derived from the *visible* headings
8238 before and after the insertion point, and taken to be the inferior headline
8239 level of the two. So if the previous visible heading is level 3 and the
8240 next is level 4 (or vice versa), level 4 will be used for insertion.
8241 This makes sure that the subtree remains an independent subtree and does
8242 not swallow low level entries.
8244 You can also force a different level, either by using a numeric prefix
8245 argument, or by inserting the heading marker by hand. For example, if the
8246 cursor is after \"*****\", then the tree will be shifted to level 5.
8248 If optional TREE is given, use this text instead of the kill ring.
8250 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8251 move back over whitespace before inserting, and move point to the end of
8252 the inserted text when done."
8253 (interactive "P")
8254 (setq tree (or tree (and kill-ring (current-kill 0))))
8255 (unless (org-kill-is-subtree-p tree)
8256 (user-error "%s"
8257 (substitute-command-keys
8258 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8259 (org-with-limited-levels
8260 (let* ((visp (not (outline-invisible-p)))
8261 (txt tree)
8262 (^re_ "\\(\\*+\\)[ \t]*")
8263 (old-level (if (string-match org-outline-regexp-bol txt)
8264 (- (match-end 0) (match-beginning 0) 1)
8265 -1))
8266 (force-level (cond (level (prefix-numeric-value level))
8267 ((and (looking-at "[ \t]*$")
8268 (string-match
8269 "^\\*+$" (buffer-substring
8270 (point-at-bol) (point))))
8271 (- (match-end 1) (match-beginning 1)))
8272 ((and (bolp)
8273 (looking-at org-outline-regexp))
8274 (- (match-end 0) (point) 1))))
8275 (previous-level (save-excursion
8276 (condition-case nil
8277 (progn
8278 (outline-previous-visible-heading 1)
8279 (if (looking-at ^re_)
8280 (- (match-end 0) (match-beginning 0) 1)
8282 (error 1))))
8283 (next-level (save-excursion
8284 (condition-case nil
8285 (progn
8286 (or (looking-at org-outline-regexp)
8287 (outline-next-visible-heading 1))
8288 (if (looking-at ^re_)
8289 (- (match-end 0) (match-beginning 0) 1)
8291 (error 1))))
8292 (new-level (or force-level (max previous-level next-level)))
8293 (shift (if (or (= old-level -1)
8294 (= new-level -1)
8295 (= old-level new-level))
8297 (- new-level old-level)))
8298 (delta (if (> shift 0) -1 1))
8299 (func (if (> shift 0) 'org-demote 'org-promote))
8300 (org-odd-levels-only nil)
8301 beg end newend)
8302 ;; Remove the forced level indicator
8303 (if force-level
8304 (delete-region (point-at-bol) (point)))
8305 ;; Paste
8306 (beginning-of-line (if (bolp) 1 2))
8307 (setq beg (point))
8308 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8309 (insert-before-markers txt)
8310 (unless (string-match "\n\\'" txt) (insert "\n"))
8311 (setq newend (point))
8312 (org-reinstall-markers-in-region beg)
8313 (setq end (point))
8314 (goto-char beg)
8315 (skip-chars-forward " \t\n\r")
8316 (setq beg (point))
8317 (if (and (outline-invisible-p) visp)
8318 (save-excursion (outline-show-heading)))
8319 ;; Shift if necessary
8320 (unless (= shift 0)
8321 (save-restriction
8322 (narrow-to-region beg end)
8323 (while (not (= shift 0))
8324 (org-map-region func (point-min) (point-max))
8325 (setq shift (+ delta shift)))
8326 (goto-char (point-min))
8327 (setq newend (point-max))))
8328 (when (or (org-called-interactively-p 'interactive) for-yank)
8329 (message "Clipboard pasted as level %d subtree" new-level))
8330 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8331 kill-ring
8332 (eq org-subtree-clip (current-kill 0))
8333 org-subtree-clip-folded)
8334 ;; The tree was folded before it was killed/copied
8335 (hide-subtree))
8336 (and for-yank (goto-char newend)))))
8338 (defun org-kill-is-subtree-p (&optional txt)
8339 "Check if the current kill is an outline subtree, or a set of trees.
8340 Returns nil if kill does not start with a headline, or if the first
8341 headline level is not the largest headline level in the tree.
8342 So this will actually accept several entries of equal levels as well,
8343 which is OK for `org-paste-subtree'.
8344 If optional TXT is given, check this string instead of the current kill."
8345 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8346 (re (org-get-limited-outline-regexp))
8347 (^re (concat "^" re))
8348 (start-level (and kill
8349 (string-match
8350 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8351 kill)
8352 (- (match-end 2) (match-beginning 2) 1)))
8353 (start (1+ (or (match-beginning 2) -1))))
8354 (if (not start-level)
8355 (progn
8356 nil) ;; does not even start with a heading
8357 (catch 'exit
8358 (while (setq start (string-match ^re kill (1+ start)))
8359 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8360 (throw 'exit nil)))
8361 t))))
8363 (defvar org-markers-to-move nil
8364 "Markers that should be moved with a cut-and-paste operation.
8365 Those markers are stored together with their positions relative to
8366 the start of the region.")
8368 (defun org-save-markers-in-region (beg end)
8369 "Check markers in region.
8370 If these markers are between BEG and END, record their position relative
8371 to BEG, so that after moving the block of text, we can put the markers back
8372 into place.
8373 This function gets called just before an entry or tree gets cut from the
8374 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8375 called immediately, to move the markers with the entries."
8376 (setq org-markers-to-move nil)
8377 (when (featurep 'org-clock)
8378 (org-clock-save-markers-for-cut-and-paste beg end))
8379 (when (featurep 'org-agenda)
8380 (org-agenda-save-markers-for-cut-and-paste beg end)))
8382 (defun org-check-and-save-marker (marker beg end)
8383 "Check if MARKER is between BEG and END.
8384 If yes, remember the marker and the distance to BEG."
8385 (when (and (marker-buffer marker)
8386 (equal (marker-buffer marker) (current-buffer)))
8387 (if (and (>= marker beg) (< marker end))
8388 (push (cons marker (- marker beg)) org-markers-to-move))))
8390 (defun org-reinstall-markers-in-region (beg)
8391 "Move all remembered markers to their position relative to BEG."
8392 (mapc (lambda (x)
8393 (move-marker (car x) (+ beg (cdr x))))
8394 org-markers-to-move)
8395 (setq org-markers-to-move nil))
8397 (defun org-narrow-to-subtree ()
8398 "Narrow buffer to the current subtree."
8399 (interactive)
8400 (save-excursion
8401 (save-match-data
8402 (org-with-limited-levels
8403 (narrow-to-region
8404 (progn (org-back-to-heading t) (point))
8405 (progn (org-end-of-subtree t t)
8406 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8407 (point)))))))
8409 (defun org-narrow-to-block ()
8410 "Narrow buffer to the current block."
8411 (interactive)
8412 (let* ((case-fold-search t)
8413 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8414 "^[ \t]*#\\+end_.*")))
8415 (if blockp
8416 (narrow-to-region (car blockp) (cdr blockp))
8417 (user-error "Not in a block"))))
8419 (eval-when-compile
8420 (defvar org-property-drawer-re))
8422 (defvar org-property-start-re) ;; defined below
8423 (defun org-clone-subtree-with-time-shift (n &optional shift)
8424 "Clone the task (subtree) at point N times.
8425 The clones will be inserted as siblings.
8427 In interactive use, the user will be prompted for the number of
8428 clones to be produced. If the entry has a timestamp, the user
8429 will also be prompted for a time shift, which may be a repeater
8430 as used in time stamps, for example `+3d'. To disable this,
8431 you can call the function with a universal prefix argument.
8433 When a valid repeater is given and the entry contains any time
8434 stamps, the clones will become a sequence in time, with time
8435 stamps in the subtree shifted for each clone produced. If SHIFT
8436 is nil or the empty string, time stamps will be left alone. The
8437 ID property of the original subtree is removed.
8439 If the original subtree did contain time stamps with a repeater,
8440 the following will happen:
8441 - the repeater will be removed in each clone
8442 - an additional clone will be produced, with the current, unshifted
8443 date(s) in the entry.
8444 - the original entry will be placed *after* all the clones, with
8445 repeater intact.
8446 - the start days in the repeater in the original entry will be shifted
8447 to past the last clone.
8448 In this way you can spell out a number of instances of a repeating task,
8449 and still retain the repeater to cover future instances of the task."
8450 (interactive "nNumber of clones to produce: ")
8451 (let ((shift
8452 (or shift
8453 (if (and (not (equal current-prefix-arg '(4)))
8454 (save-excursion
8455 (re-search-forward org-ts-regexp-both
8456 (save-excursion
8457 (org-end-of-subtree t)
8458 (point)) t)))
8459 (read-from-minibuffer
8460 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8461 ""))) ;; No time shift
8462 (n-no-remove -1)
8463 (drawer-re org-drawer-regexp)
8464 beg end template task idprop
8465 shift-n shift-what doshift nmin nmax)
8466 (if (not (and (integerp n) (> n 0)))
8467 (error "Invalid number of replications %s" n))
8468 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8469 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8470 shift)))
8471 (error "Invalid shift specification %s" shift))
8472 (when doshift
8473 (setq shift-n (string-to-number (match-string 1 shift))
8474 shift-what (cdr (assoc (match-string 2 shift)
8475 '(("d" . day) ("w" . week)
8476 ("m" . month) ("y" . year))))))
8477 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8478 (setq nmin 1 nmax n)
8479 (org-back-to-heading t)
8480 (setq beg (point))
8481 (setq idprop (org-entry-get nil "ID"))
8482 (org-end-of-subtree t t)
8483 (or (bolp) (insert "\n"))
8484 (setq end (point))
8485 (setq template (buffer-substring beg end))
8486 (when (and doshift
8487 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8488 (delete-region beg end)
8489 (setq end beg)
8490 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8491 (goto-char end)
8492 (loop for n from nmin to nmax do
8493 ;; prepare clone
8494 (with-temp-buffer
8495 (insert template)
8496 (org-mode)
8497 (goto-char (point-min))
8498 (org-show-subtree)
8499 (and idprop (if org-clone-delete-id
8500 (org-entry-delete nil "ID")
8501 (org-id-get-create t)))
8502 (unless (= n 0)
8503 (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
8504 (kill-whole-line))
8505 (goto-char (point-min))
8506 (while (re-search-forward drawer-re nil t)
8507 (mapc (lambda (d)
8508 (org-remove-empty-drawer-at d (point))) org-drawers)))
8509 (goto-char (point-min))
8510 (when doshift
8511 (while (re-search-forward org-ts-regexp-both nil t)
8512 (org-timestamp-change (* n shift-n) shift-what))
8513 (unless (= n n-no-remove)
8514 (goto-char (point-min))
8515 (while (re-search-forward org-ts-regexp nil t)
8516 (save-excursion
8517 (goto-char (match-beginning 0))
8518 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8519 (delete-region (match-beginning 1) (match-end 1)))))))
8520 (setq task (buffer-string)))
8521 (insert task))
8522 (goto-char beg)))
8524 ;;; Outline Sorting
8526 (defun org-sort (with-case)
8527 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8528 Optional argument WITH-CASE means sort case-sensitively."
8529 (interactive "P")
8530 (cond
8531 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8532 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8534 (org-call-with-arg 'org-sort-entries with-case))))
8536 (defun org-sort-remove-invisible (s)
8537 "Remove invisible links from string S."
8538 (remove-text-properties 0 (length s) org-rm-props s)
8539 (while (string-match org-bracket-link-regexp s)
8540 (setq s (replace-match (if (match-end 2)
8541 (match-string 3 s)
8542 (match-string 1 s)) t t s)))
8543 (let ((st (format " %s " s)))
8544 (while (string-match org-emph-re st)
8545 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8546 (setq s (substring st 1 -1)))
8549 (defvar org-priority-regexp) ; defined later in the file
8551 (defvar org-after-sorting-entries-or-items-hook nil
8552 "Hook that is run after a bunch of entries or items have been sorted.
8553 When children are sorted, the cursor is in the parent line when this
8554 hook gets called. When a region or a plain list is sorted, the cursor
8555 will be in the first entry of the sorted region/list.")
8557 (defun org-sort-entries
8558 (&optional with-case sorting-type getkey-func compare-func property)
8559 "Sort entries on a certain level of an outline tree.
8560 If there is an active region, the entries in the region are sorted.
8561 Else, if the cursor is before the first entry, sort the top-level items.
8562 Else, the children of the entry at point are sorted.
8564 Sorting can be alphabetically, numerically, by date/time as given by
8565 a time stamp, by a property, by priority order, or by a custom function.
8567 The command prompts for the sorting type unless it has been given to the
8568 function through the SORTING-TYPE argument, which needs to be a character,
8569 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8570 precise meaning of each character:
8572 n Numerically, by converting the beginning of the entry/item to a number.
8573 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8574 o By order of TODO keywords.
8575 t By date/time, either the first active time stamp in the entry, or, if
8576 none exist, by the first inactive one.
8577 s By the scheduled date/time.
8578 d By deadline date/time.
8579 c By creation time, which is assumed to be the first inactive time stamp
8580 at the beginning of a line.
8581 p By priority according to the cookie.
8582 r By the value of a property.
8584 Capital letters will reverse the sort order.
8586 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8587 called with point at the beginning of the record. It must return either
8588 a string or a number that should serve as the sorting key for that record.
8590 Comparing entries ignores case by default. However, with an optional argument
8591 WITH-CASE, the sorting considers case as well.
8593 Sorting is done against the visible part of the headlines, it ignores hidden
8594 links."
8595 (interactive "P")
8596 (let ((case-func (if with-case 'identity 'downcase))
8597 (cmstr
8598 ;; The clock marker is lost when using `sort-subr', let's
8599 ;; store the clocking string.
8600 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8601 (save-excursion
8602 (goto-char org-clock-marker)
8603 (looking-back "^.*") (match-string-no-properties 0))))
8604 start beg end stars re re2
8605 txt what tmp)
8606 ;; Find beginning and end of region to sort
8607 (cond
8608 ((org-region-active-p)
8609 ;; we will sort the region
8610 (setq end (region-end)
8611 what "region")
8612 (goto-char (region-beginning))
8613 (if (not (org-at-heading-p)) (outline-next-heading))
8614 (setq start (point)))
8615 ((or (org-at-heading-p)
8616 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8617 ;; we will sort the children of the current headline
8618 (org-back-to-heading)
8619 (setq start (point)
8620 end (progn (org-end-of-subtree t t)
8621 (or (bolp) (insert "\n"))
8622 (org-back-over-empty-lines)
8623 (point))
8624 what "children")
8625 (goto-char start)
8626 (show-subtree)
8627 (outline-next-heading))
8629 ;; we will sort the top-level entries in this file
8630 (goto-char (point-min))
8631 (or (org-at-heading-p) (outline-next-heading))
8632 (setq start (point))
8633 (goto-char (point-max))
8634 (beginning-of-line 1)
8635 (when (looking-at ".*?\\S-")
8636 ;; File ends in a non-white line
8637 (end-of-line 1)
8638 (insert "\n"))
8639 (setq end (point-max))
8640 (setq what "top-level")
8641 (goto-char start)
8642 (show-all)))
8644 (setq beg (point))
8645 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8647 (looking-at "\\(\\*+\\)")
8648 (setq stars (match-string 1)
8649 re (concat "^" (regexp-quote stars) " +")
8650 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8651 txt (buffer-substring beg end))
8652 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8653 (if (and (not (equal stars "*")) (string-match re2 txt))
8654 (user-error "Region to sort contains a level above the first entry"))
8656 (unless sorting-type
8657 (message
8658 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8659 [t]ime [s]cheduled [d]eadline [c]reated
8660 A/N/P/R/O/F/T/S/D/C means reversed:"
8661 what)
8662 (setq sorting-type (read-char-exclusive))
8664 (unless getkey-func
8665 (and (= (downcase sorting-type) ?f)
8666 (setq getkey-func
8667 (org-icompleting-read "Sort using function: "
8668 obarray 'fboundp t nil nil))
8669 (setq getkey-func (intern getkey-func))))
8671 (and (= (downcase sorting-type) ?r)
8672 (not property)
8673 (setq property
8674 (org-icompleting-read "Property: "
8675 (mapcar 'list (org-buffer-property-keys t))
8676 nil t))))
8678 (message "Sorting entries...")
8680 (save-restriction
8681 (narrow-to-region start end)
8682 (let ((dcst (downcase sorting-type))
8683 (case-fold-search nil)
8684 (now (current-time)))
8685 (sort-subr
8686 (/= dcst sorting-type)
8687 ;; This function moves to the beginning character of the "record" to
8688 ;; be sorted.
8689 (lambda nil
8690 (if (re-search-forward re nil t)
8691 (goto-char (match-beginning 0))
8692 (goto-char (point-max))))
8693 ;; This function moves to the last character of the "record" being
8694 ;; sorted.
8695 (lambda nil
8696 (save-match-data
8697 (condition-case nil
8698 (outline-forward-same-level 1)
8699 (error
8700 (goto-char (point-max))))))
8701 ;; This function returns the value that gets sorted against.
8702 (lambda nil
8703 (cond
8704 ((= dcst ?n)
8705 (if (looking-at org-complex-heading-regexp)
8706 (string-to-number (org-sort-remove-invisible (match-string 4)))
8707 nil))
8708 ((= dcst ?a)
8709 (if (looking-at org-complex-heading-regexp)
8710 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8711 nil))
8712 ((= dcst ?t)
8713 (let ((end (save-excursion (outline-next-heading) (point))))
8714 (if (or (re-search-forward org-ts-regexp end t)
8715 (re-search-forward org-ts-regexp-both end t))
8716 (org-time-string-to-seconds (match-string 0))
8717 (org-float-time now))))
8718 ((= dcst ?c)
8719 (let ((end (save-excursion (outline-next-heading) (point))))
8720 (if (re-search-forward
8721 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8722 end t)
8723 (org-time-string-to-seconds (match-string 0))
8724 (org-float-time now))))
8725 ((= dcst ?s)
8726 (let ((end (save-excursion (outline-next-heading) (point))))
8727 (if (re-search-forward org-scheduled-time-regexp end t)
8728 (org-time-string-to-seconds (match-string 1))
8729 (org-float-time now))))
8730 ((= dcst ?d)
8731 (let ((end (save-excursion (outline-next-heading) (point))))
8732 (if (re-search-forward org-deadline-time-regexp end t)
8733 (org-time-string-to-seconds (match-string 1))
8734 (org-float-time now))))
8735 ((= dcst ?p)
8736 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8737 (string-to-char (match-string 2))
8738 org-default-priority))
8739 ((= dcst ?r)
8740 (or (org-entry-get nil property) ""))
8741 ((= dcst ?o)
8742 (if (looking-at org-complex-heading-regexp)
8743 (- 9999 (length (member (match-string 2)
8744 org-todo-keywords-1)))))
8745 ((= dcst ?f)
8746 (if getkey-func
8747 (progn
8748 (setq tmp (funcall getkey-func))
8749 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8750 tmp)
8751 (error "Invalid key function `%s'" getkey-func)))
8752 (t (error "Invalid sorting type `%c'" sorting-type))))
8754 (cond
8755 ((= dcst ?a) 'string<)
8756 ((= dcst ?f) compare-func)
8757 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8758 (run-hooks 'org-after-sorting-entries-or-items-hook)
8759 ;; Reset the clock marker if needed
8760 (when cmstr
8761 (save-excursion
8762 (goto-char start)
8763 (search-forward cmstr nil t)
8764 (move-marker org-clock-marker (point))))
8765 (message "Sorting entries...done")))
8767 (defun org-do-sort (table what &optional with-case sorting-type)
8768 "Sort TABLE of WHAT according to SORTING-TYPE.
8769 The user will be prompted for the SORTING-TYPE if the call to this
8770 function does not specify it. WHAT is only for the prompt, to indicate
8771 what is being sorted. The sorting key will be extracted from
8772 the car of the elements of the table.
8773 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8774 (unless sorting-type
8775 (message
8776 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8777 what)
8778 (setq sorting-type (read-char-exclusive)))
8779 (let ((dcst (downcase sorting-type))
8780 extractfun comparefun)
8781 ;; Define the appropriate functions
8782 (cond
8783 ((= dcst ?n)
8784 (setq extractfun 'string-to-number
8785 comparefun (if (= dcst sorting-type) '< '>)))
8786 ((= dcst ?a)
8787 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8788 (lambda(x) (downcase (org-sort-remove-invisible x))))
8789 comparefun (if (= dcst sorting-type)
8790 'string<
8791 (lambda (a b) (and (not (string< a b))
8792 (not (string= a b)))))))
8793 ((= dcst ?t)
8794 (setq extractfun
8795 (lambda (x)
8796 (if (or (string-match org-ts-regexp x)
8797 (string-match org-ts-regexp-both x))
8798 (org-float-time
8799 (org-time-string-to-time (match-string 0 x)))
8801 comparefun (if (= dcst sorting-type) '< '>)))
8802 (t (error "Invalid sorting type `%c'" sorting-type)))
8804 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8805 table)
8806 (lambda (a b) (funcall comparefun (car a) (car b))))))
8809 ;;; The orgstruct minor mode
8811 ;; Define a minor mode which can be used in other modes in order to
8812 ;; integrate the org-mode structure editing commands.
8814 ;; This is really a hack, because the org-mode structure commands use
8815 ;; keys which normally belong to the major mode. Here is how it
8816 ;; works: The minor mode defines all the keys necessary to operate the
8817 ;; structure commands, but wraps the commands into a function which
8818 ;; tests if the cursor is currently at a headline or a plain list
8819 ;; item. If that is the case, the structure command is used,
8820 ;; temporarily setting many Org-mode variables like regular
8821 ;; expressions for filling etc. However, when any of those keys is
8822 ;; used at a different location, function uses `key-binding' to look
8823 ;; up if the key has an associated command in another currently active
8824 ;; keymap (minor modes, major mode, global), and executes that
8825 ;; command. There might be problems if any of the keys is otherwise
8826 ;; used as a prefix key.
8828 (defcustom orgstruct-heading-prefix-regexp ""
8829 "Regexp that matches the custom prefix of Org headlines in
8830 orgstruct(++)-mode."
8831 :group 'org
8832 :version "24.4"
8833 :package-version '(Org . "8.3")
8834 :type 'regexp)
8835 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8837 (defcustom orgstruct-setup-hook nil
8838 "Hook run after orgstruct-mode-map is filled."
8839 :group 'org
8840 :version "24.4"
8841 :package-version '(Org . "8.0")
8842 :type 'hook)
8844 (defvar orgstruct-initialized nil)
8846 (defvar org-local-vars nil
8847 "List of local variables, for use by `orgstruct-mode'.")
8849 ;;;###autoload
8850 (define-minor-mode orgstruct-mode
8851 "Toggle the minor mode `orgstruct-mode'.
8852 This mode is for using Org-mode structure commands in other
8853 modes. The following keys behave as if Org-mode were active, if
8854 the cursor is on a headline, or on a plain list item (both as
8855 defined by Org-mode)."
8856 nil " OrgStruct" (make-sparse-keymap)
8857 (funcall (if orgstruct-mode
8858 'add-to-invisibility-spec
8859 'remove-from-invisibility-spec)
8860 '(outline . t))
8861 (when orgstruct-mode
8862 (org-load-modules-maybe)
8863 (unless orgstruct-initialized
8864 (orgstruct-setup)
8865 (setq orgstruct-initialized t))))
8867 ;;;###autoload
8868 (defun turn-on-orgstruct ()
8869 "Unconditionally turn on `orgstruct-mode'."
8870 (orgstruct-mode 1))
8872 (defvar org-fb-vars nil)
8873 (make-variable-buffer-local 'org-fb-vars)
8874 (defun orgstruct++-mode (&optional arg)
8875 "Toggle `orgstruct-mode', the enhanced version of it.
8876 In addition to setting orgstruct-mode, this also exports all
8877 indentation and autofilling variables from org-mode into the
8878 buffer. It will also recognize item context in multiline items."
8879 (interactive "P")
8880 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8881 (if (< arg 1)
8882 (progn (orgstruct-mode -1)
8883 (mapc (lambda(v)
8884 (org-set-local (car v)
8885 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8886 org-fb-vars))
8887 (orgstruct-mode 1)
8888 (setq org-fb-vars nil)
8889 (unless org-local-vars
8890 (setq org-local-vars (org-get-local-variables)))
8891 (let (var val)
8892 (mapc
8893 (lambda (x)
8894 (when (string-match
8895 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
8896 (symbol-name (car x)))
8897 (setq var (car x) val (nth 1 x))
8898 (push (list var `(quote ,(eval var))) org-fb-vars)
8899 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8900 org-local-vars)
8901 (org-set-local 'orgstruct-is-++ t))))
8903 (defvar orgstruct-is-++ nil
8904 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8905 (make-variable-buffer-local 'orgstruct-is-++)
8907 ;;;###autoload
8908 (defun turn-on-orgstruct++ ()
8909 "Unconditionally turn on `orgstruct++-mode'."
8910 (orgstruct++-mode 1))
8912 (defun orgstruct-error ()
8913 "Error when there is no default binding for a structure key."
8914 (interactive)
8915 (funcall (if (fboundp 'user-error)
8916 'user-error
8917 'error)
8918 "This key has no function outside structure elements"))
8920 (defun orgstruct-setup ()
8921 "Setup orgstruct keymap."
8922 (dolist (cell '((org-demote . t)
8923 (org-metaleft . t)
8924 (org-metaright . t)
8925 (org-promote . t)
8926 (org-shiftmetaleft . t)
8927 (org-shiftmetaright . t)
8928 org-backward-element
8929 org-backward-heading-same-level
8930 org-ctrl-c-ret
8931 org-ctrl-c-minus
8932 org-ctrl-c-star
8933 org-cycle
8934 org-forward-heading-same-level
8935 org-insert-heading
8936 org-insert-heading-respect-content
8937 org-kill-note-or-show-branches
8938 org-mark-subtree
8939 org-meta-return
8940 org-metadown
8941 org-metaup
8942 org-narrow-to-subtree
8943 org-promote-subtree
8944 org-reveal
8945 org-shiftdown
8946 org-shiftleft
8947 org-shiftmetadown
8948 org-shiftmetaup
8949 org-shiftright
8950 org-shifttab
8951 org-shifttab
8952 org-shiftup
8953 org-show-subtree
8954 org-sort
8955 org-up-element
8956 outline-demote
8957 outline-next-visible-heading
8958 outline-previous-visible-heading
8959 outline-promote
8960 outline-up-heading
8961 show-children))
8962 (let ((f (or (car-safe cell) cell))
8963 (disable-when-heading-prefix (cdr-safe cell)))
8964 (when (fboundp f)
8965 (let ((new-bindings))
8966 (dolist (binding (nconc (where-is-internal f org-mode-map)
8967 (where-is-internal f outline-mode-map)))
8968 (push binding new-bindings)
8969 ;; TODO use local-function-key-map
8970 (dolist (rep '(("<tab>" . "TAB")
8971 ("<return>" . "RET")
8972 ("<escape>" . "ESC")
8973 ("<delete>" . "DEL")))
8974 (setq binding (read-kbd-macro
8975 (let ((case-fold-search))
8976 (replace-regexp-in-string
8977 (regexp-quote (cdr rep))
8978 (car rep)
8979 (key-description binding)))))
8980 (pushnew binding new-bindings :test 'equal)))
8981 (dolist (binding new-bindings)
8982 (let ((key (lookup-key orgstruct-mode-map binding)))
8983 (when (or (not key) (numberp key))
8984 (condition-case nil
8985 (org-defkey orgstruct-mode-map
8986 binding
8987 (orgstruct-make-binding f binding disable-when-heading-prefix))
8988 (error nil)))))))))
8989 (run-hooks 'orgstruct-setup-hook))
8991 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
8992 "Create a function for binding in the structure minor mode.
8993 FUN is the command to call inside a table. KEY is the key that
8994 should be checked in for a command to execute outside of tables.
8995 Non-nil `disable-when-heading-prefix' means to disable the command
8996 if `orgstruct-heading-prefix-regexp' is not empty."
8997 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
8998 (let ((nname name)
8999 (i 0))
9000 (while (fboundp (intern nname))
9001 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9002 (setq name (intern nname)))
9003 (eval
9004 (let ((bindings '((org-heading-regexp
9005 (concat "^"
9006 orgstruct-heading-prefix-regexp
9007 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9008 (org-outline-regexp
9009 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9010 (org-outline-regexp-bol
9011 (concat "^" org-outline-regexp))
9012 (outline-regexp org-outline-regexp)
9013 (outline-heading-end-regexp "\n")
9014 (outline-level 'org-outline-level)
9015 (outline-heading-alist))))
9016 `(defun ,name (arg)
9017 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9018 "Outside of structure, run the binding of `"
9019 (key-description key) "'."
9020 (when disable-when-heading-prefix
9021 (concat
9022 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9023 "back to the default binding due to limitations of Org's implementation of\n"
9024 "`" (symbol-name fun) "'.")))
9025 (interactive "p")
9026 (let* ((disable
9027 ,(and disable-when-heading-prefix
9028 '(not (string= orgstruct-heading-prefix-regexp ""))))
9029 (fallback
9030 (or disable
9031 (not
9032 (let* ,bindings
9033 (org-context-p 'headline 'item
9034 ,(when (memq fun
9035 '(org-insert-heading
9036 org-insert-heading-respect-content
9037 org-meta-return))
9038 '(when orgstruct-is-++
9039 'item-body))))))))
9040 (if fallback
9041 (let* ((orgstruct-mode)
9042 (binding
9043 (loop with key = ,key
9044 for rep in
9045 '(nil
9046 ("<\\([^>]*\\)tab>" . "\\1TAB")
9047 ("<\\([^>]*\\)return>" . "\\1RET")
9048 ("<\\([^>]*\\)escape>" . "\\1ESC")
9049 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9051 (when rep
9052 (setq key (read-kbd-macro
9053 (let ((case-fold-search))
9054 (replace-regexp-in-string
9055 (car rep)
9056 (cdr rep)
9057 (key-description key))))))
9058 thereis (key-binding key))))
9059 (if (keymapp binding)
9060 (org-set-transient-map binding)
9061 (let ((func (or binding
9062 (unless disable
9063 'orgstruct-error))))
9064 (when func
9065 (call-interactively func)))))
9066 (org-run-like-in-org-mode
9067 (lambda ()
9068 (interactive)
9069 (let* ,bindings
9070 (call-interactively ',fun)))))))))
9071 name))
9073 (defun org-contextualize-keys (alist contexts)
9074 "Return valid elements in ALIST depending on CONTEXTS.
9076 `org-agenda-custom-commands' or `org-capture-templates' are the
9077 values used for ALIST, and `org-agenda-custom-commands-contexts'
9078 or `org-capture-templates-contexts' are the associated contexts
9079 definitions."
9080 (let ((contexts
9081 ;; normalize contexts
9082 (mapcar
9083 (lambda(c) (cond ((listp (cadr c))
9084 (list (car c) (car c) (cadr c)))
9085 ((string= "" (cadr c))
9086 (list (car c) (car c) (caddr c)))
9087 (t c))) contexts))
9088 (a alist) c r s)
9089 ;; loop over all commands or templates
9090 (while (setq c (pop a))
9091 (let (vrules repl)
9092 (cond
9093 ((not (assoc (car c) contexts))
9094 (push c r))
9095 ((and (assoc (car c) contexts)
9096 (setq vrules (org-contextualize-validate-key
9097 (car c) contexts)))
9098 (mapc (lambda (vr)
9099 (when (not (equal (car vr) (cadr vr)))
9100 (setq repl vr))) vrules)
9101 (if (not repl) (push c r)
9102 (push (cadr repl) s)
9103 (push
9104 (cons (car c)
9105 (cdr (or (assoc (cadr repl) alist)
9106 (error "Undefined key `%s' as contextual replacement for `%s'"
9107 (cadr repl) (car c)))))
9108 r))))))
9109 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9110 (delq
9112 (delete-dups
9113 (mapcar (lambda (x)
9114 (let ((tpl (car x)))
9115 (when (not (delq
9117 (mapcar (lambda(y)
9118 (equal y tpl)) s))) x)))
9119 (reverse r))))))
9121 (defun org-contextualize-validate-key (key contexts)
9122 "Check CONTEXTS for agenda or capture KEY."
9123 (let (r rr res)
9124 (while (setq r (pop contexts))
9125 (mapc
9126 (lambda (rr)
9127 (when
9128 (and (equal key (car r))
9129 (if (functionp rr) (funcall rr)
9130 (or (and (eq (car rr) 'in-file)
9131 (buffer-file-name)
9132 (string-match (cdr rr) (buffer-file-name)))
9133 (and (eq (car rr) 'in-mode)
9134 (string-match (cdr rr) (symbol-name major-mode)))
9135 (and (eq (car rr) 'in-buffer)
9136 (string-match (cdr rr) (buffer-name)))
9137 (if (and (eq (car rr) 'not-in-file)
9138 (buffer-file-name))
9139 (not (string-match (cdr rr) (buffer-file-name)))
9141 (when (eq (car rr) 'not-in-mode)
9142 (not (string-match (cdr rr) (symbol-name major-mode))))
9143 (when (eq (car rr) 'not-in-buffer)
9144 (not (string-match (cdr rr) (buffer-name)))))))
9145 (push r res)))
9146 (car (last r))))
9147 (delete-dups (delq nil res))))
9149 (defun org-context-p (&rest contexts)
9150 "Check if local context is any of CONTEXTS.
9151 Possible values in the list of contexts are `table', `headline', and `item'."
9152 (let ((pos (point)))
9153 (goto-char (point-at-bol))
9154 (prog1 (or (and (memq 'table contexts)
9155 (looking-at "[ \t]*|"))
9156 (and (memq 'headline contexts)
9157 (looking-at org-outline-regexp))
9158 (and (memq 'item contexts)
9159 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9160 (and (memq 'item-body contexts)
9161 (org-in-item-p)))
9162 (goto-char pos))))
9164 (defun org-get-local-variables ()
9165 "Return a list of all local variables in an Org mode buffer."
9166 (let (varlist)
9167 (with-current-buffer (get-buffer-create "*Org tmp*")
9168 (erase-buffer)
9169 (org-mode)
9170 (setq varlist (buffer-local-variables)))
9171 (kill-buffer "*Org tmp*")
9172 (delq nil
9173 (mapcar
9174 (lambda (x)
9175 (setq x
9176 (if (symbolp x)
9177 (list x)
9178 (list (car x) (cdr x))))
9179 (if (and (not (get (car x) 'org-state))
9180 (string-match
9181 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9182 (symbol-name (car x))))
9183 x nil))
9184 varlist))))
9186 (defun org-clone-local-variables (from-buffer &optional regexp)
9187 "Clone local variables from FROM-BUFFER.
9188 Optional argument REGEXP selects variables to clone."
9189 (mapc
9190 (lambda (pair)
9191 (and (symbolp (car pair))
9192 (or (null regexp)
9193 (string-match regexp (symbol-name (car pair))))
9194 (set (make-local-variable (car pair))
9195 (cdr pair))))
9196 (buffer-local-variables from-buffer)))
9198 ;;;###autoload
9199 (defun org-run-like-in-org-mode (cmd)
9200 "Run a command, pretending that the current buffer is in Org-mode.
9201 This will temporarily bind local variables that are typically bound in
9202 Org-mode to the values they have in Org-mode, and then interactively
9203 call CMD."
9204 (org-load-modules-maybe)
9205 (unless org-local-vars
9206 (setq org-local-vars (org-get-local-variables)))
9207 (let (binds)
9208 (dolist (var org-local-vars)
9209 (when (or (not (boundp (car var)))
9210 (eq (symbol-value (car var))
9211 (default-value (car var))))
9212 (push (list (car var) `(quote ,(cadr var))) binds)))
9213 (eval `(let ,binds
9214 (call-interactively (quote ,cmd))))))
9216 ;;;; Archiving
9218 (defun org-get-category (&optional pos force-refresh)
9219 "Get the category applying to position POS."
9220 (save-match-data
9221 (if force-refresh (org-refresh-category-properties))
9222 (let ((pos (or pos (point))))
9223 (or (get-text-property pos 'org-category)
9224 (progn (org-refresh-category-properties)
9225 (get-text-property pos 'org-category))))))
9227 (defun org-refresh-category-properties ()
9228 "Refresh category text properties in the buffer."
9229 (let ((case-fold-search t)
9230 (inhibit-read-only t)
9231 (def-cat (cond
9232 ((null org-category)
9233 (if buffer-file-name
9234 (file-name-sans-extension
9235 (file-name-nondirectory buffer-file-name))
9236 "???"))
9237 ((symbolp org-category) (symbol-name org-category))
9238 (t org-category)))
9239 beg end cat pos optionp)
9240 (org-with-silent-modifications
9241 (save-excursion
9242 (save-restriction
9243 (widen)
9244 (goto-char (point-min))
9245 (put-text-property (point) (point-max) 'org-category def-cat)
9246 (while (re-search-forward
9247 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
9248 (setq pos (match-end 0)
9249 optionp (equal (char-after (match-beginning 0)) ?#)
9250 cat (org-trim (match-string 2)))
9251 (if optionp
9252 (setq beg (point-at-bol) end (point-max))
9253 (org-back-to-heading t)
9254 (setq beg (point) end (org-end-of-subtree t t)))
9255 (put-text-property beg end 'org-category cat)
9256 (put-text-property beg end 'org-category-position beg)
9257 (goto-char pos)))))))
9259 (defun org-refresh-properties (dprop tprop)
9260 "Refresh buffer text properties.
9261 DPROP is the drawer property and TPROP is the corresponding text
9262 property to set."
9263 (let ((case-fold-search t)
9264 (inhibit-read-only t) p)
9265 (org-with-silent-modifications
9266 (save-excursion
9267 (save-restriction
9268 (widen)
9269 (goto-char (point-min))
9270 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9271 (setq p (org-match-string-no-properties 1))
9272 (save-excursion
9273 (org-back-to-heading t)
9274 (put-text-property
9275 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9278 ;;;; Link Stuff
9280 ;;; Link abbreviations
9282 (defun org-link-expand-abbrev (link)
9283 "Apply replacements as defined in `org-link-abbrev-alist'."
9284 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9285 (let* ((key (match-string 1 link))
9286 (as (or (assoc key org-link-abbrev-alist-local)
9287 (assoc key org-link-abbrev-alist)))
9288 (tag (and (match-end 2) (match-string 3 link)))
9289 rpl)
9290 (if (not as)
9291 link
9292 (setq rpl (cdr as))
9293 (cond
9294 ((symbolp rpl) (funcall rpl tag))
9295 ((string-match "%(\\([^)]+\\))" rpl)
9296 (replace-match
9297 (save-match-data
9298 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9299 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9300 ((string-match "%h" rpl)
9301 (replace-match (url-hexify-string (or tag "")) t t rpl))
9302 (t (concat rpl tag)))))
9303 link))
9305 ;;; Storing and inserting links
9307 (defvar org-insert-link-history nil
9308 "Minibuffer history for links inserted with `org-insert-link'.")
9310 (defvar org-stored-links nil
9311 "Contains the links stored with `org-store-link'.")
9313 (defvar org-store-link-plist nil
9314 "Plist with info about the most recently link created with `org-store-link'.")
9316 (defvar org-link-protocols nil
9317 "Link protocols added to Org-mode using `org-add-link-type'.")
9319 (defvar org-store-link-functions nil
9320 "List of functions that are called to create and store a link.
9321 Each function will be called in turn until one returns a non-nil
9322 value. Each function should check if it is responsible for creating
9323 this link (for example by looking at the major mode).
9324 If not, it must exit and return nil.
9325 If yes, it should return a non-nil value after a calling
9326 `org-store-link-props' with a list of properties and values.
9327 Special properties are:
9329 :type The link prefix, like \"http\". This must be given.
9330 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9331 This is obligatory as well.
9332 :description Optional default description for the second pair
9333 of brackets in an Org-mode link. The user can still change
9334 this when inserting this link into an Org-mode buffer.
9336 In addition to these, any additional properties can be specified
9337 and then used in capture templates.")
9339 (defun org-add-link-type (type &optional follow export)
9340 "Add TYPE to the list of `org-link-types'.
9341 Re-compute all regular expressions depending on `org-link-types'
9343 FOLLOW and EXPORT are two functions.
9345 FOLLOW should take the link path as the single argument and do whatever
9346 is necessary to follow the link, for example find a file or display
9347 a mail message.
9349 EXPORT should format the link path for export to one of the export formats.
9350 It should be a function accepting three arguments:
9352 path the path of the link, the text after the prefix (like \"http:\")
9353 desc the description of the link, if any, or a description added by
9354 org-export-normalize-links if there is none
9355 format the export format, a symbol like `html' or `latex' or `ascii'..
9357 The function may use the FORMAT information to return different values
9358 depending on the format. The return value will be put literally into
9359 the exported file. If the return value is nil, this means Org should
9360 do what it normally does with links which do not have EXPORT defined.
9362 Org-mode has a built-in default for exporting links. If you are happy with
9363 this default, there is no need to define an export function for the link
9364 type. For a simple example of an export function, see `org-bbdb.el'."
9365 (add-to-list 'org-link-types type t)
9366 (org-make-link-regexps)
9367 (if (assoc type org-link-protocols)
9368 (setcdr (assoc type org-link-protocols) (list follow export))
9369 (push (list type follow export) org-link-protocols)))
9371 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9372 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9374 ;;;###autoload
9375 (defun org-store-link (arg)
9376 "\\<org-mode-map>Store an org-link to the current location.
9377 This link is added to `org-stored-links' and can later be inserted
9378 into an org-buffer with \\[org-insert-link].
9380 For some link types, a prefix arg is interpreted.
9381 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9382 For file links, arg negates `org-context-in-file-links'.
9384 A double prefix arg force skipping storing functions that are not
9385 part of Org's core.
9387 A triple prefix arg force storing a link for each line in the
9388 active region."
9389 (interactive "P")
9390 (org-load-modules-maybe)
9391 (if (and (equal arg '(64)) (org-region-active-p))
9392 (save-excursion
9393 (let ((end (region-end)))
9394 (goto-char (region-beginning))
9395 (set-mark (point))
9396 (while (< (point-at-eol) end)
9397 (move-end-of-line 1) (activate-mark)
9398 (let (current-prefix-arg)
9399 (call-interactively 'org-store-link))
9400 (move-beginning-of-line 2)
9401 (set-mark (point)))))
9402 (org-with-limited-levels
9403 (setq org-store-link-plist nil)
9404 (let (link cpltxt desc description search
9405 txt custom-id agenda-link sfuns sfunsn)
9406 (cond
9408 ;; Store a link using an external link type
9409 ((and (not (equal arg '(16)))
9410 (setq sfuns
9411 (delq
9412 nil (mapcar (lambda (f)
9413 (let (fs) (if (funcall f) (push f fs))))
9414 org-store-link-functions))
9415 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9416 (or (and (cdr sfuns)
9417 (funcall (intern
9418 (completing-read
9419 "Which function for creating the link? "
9420 sfunsn nil t (car sfunsn)))))
9421 (funcall (caar sfuns)))
9422 (setq link (plist-get org-store-link-plist :link)
9423 desc (or (plist-get org-store-link-plist
9424 :description) link))))
9426 ;; Store a link from a source code buffer
9427 ((org-src-edit-buffer-p)
9428 (let (label gc)
9429 (while (or (not label)
9430 (save-excursion
9431 (save-restriction
9432 (widen)
9433 (goto-char (point-min))
9434 (re-search-forward
9435 (regexp-quote (format org-coderef-label-format label))
9436 nil t))))
9437 (when label (message "Label exists already") (sit-for 2))
9438 (setq label (read-string "Code line label: " label)))
9439 (end-of-line 1)
9440 (setq link (format org-coderef-label-format label))
9441 (setq gc (- 79 (length link)))
9442 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9443 (insert link)
9444 (setq link (concat "(" label ")") desc nil)))
9446 ;; We are in the agenda, link to referenced location
9447 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9448 (let ((m (or (get-text-property (point) 'org-hd-marker)
9449 (get-text-property (point) 'org-marker))))
9450 (when m
9451 (org-with-point-at m
9452 (setq agenda-link
9453 (if (org-called-interactively-p 'any)
9454 (call-interactively 'org-store-link)
9455 (org-store-link nil)))))))
9457 ((eq major-mode 'calendar-mode)
9458 (let ((cd (calendar-cursor-to-date)))
9459 (setq link
9460 (format-time-string
9461 (car org-time-stamp-formats)
9462 (apply 'encode-time
9463 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9464 nil nil nil))))
9465 (org-store-link-props :type "calendar" :date cd)))
9467 ((eq major-mode 'help-mode)
9468 (setq link (concat "help:" (save-excursion
9469 (goto-char (point-min))
9470 (looking-at "^[^ ]+")
9471 (match-string 0))))
9472 (org-store-link-props :type "help"))
9474 ((eq major-mode 'w3-mode)
9475 (setq cpltxt (if (and (buffer-name)
9476 (not (string-match "Untitled" (buffer-name))))
9477 (buffer-name)
9478 (url-view-url t))
9479 link (url-view-url t))
9480 (org-store-link-props :type "w3" :url (url-view-url t)))
9482 ((eq major-mode 'image-mode)
9483 (setq cpltxt (concat "file:"
9484 (abbreviate-file-name buffer-file-name))
9485 link cpltxt)
9486 (org-store-link-props :type "image" :file buffer-file-name))
9488 ;; In dired, store a link to the file of the current line
9489 ((eq major-mode 'dired-mode)
9490 (let ((file (dired-get-filename nil t)))
9491 (setq file (if file
9492 (abbreviate-file-name
9493 (expand-file-name (dired-get-filename nil t)))
9494 ;; otherwise, no file so use current directory.
9495 default-directory))
9496 (setq cpltxt (concat "file:" file)
9497 link cpltxt)))
9499 ((setq search (run-hook-with-args-until-success
9500 'org-create-file-search-functions))
9501 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9502 "::" search))
9503 (setq cpltxt (or description link)))
9505 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9506 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9507 (cond
9508 ;; Store a link using the target at point
9509 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9510 (setq cpltxt
9511 (concat "file:"
9512 (abbreviate-file-name
9513 (buffer-file-name (buffer-base-buffer)))
9514 "::" (match-string 1))
9515 link cpltxt))
9516 ((and (featurep 'org-id)
9517 (or (eq org-id-link-to-org-use-id t)
9518 (and (org-called-interactively-p 'any)
9519 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9520 (and (eq org-id-link-to-org-use-id
9521 'create-if-interactive-and-no-custom-id)
9522 (not custom-id))))
9523 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9524 ;; Store a link using the ID at point
9525 (setq link (condition-case nil
9526 (prog1 (org-id-store-link)
9527 (setq desc (or (plist-get org-store-link-plist
9528 :description)
9529 "")))
9530 (error
9531 ;; Probably before first headline, link only to file
9532 (concat "file:"
9533 (abbreviate-file-name
9534 (buffer-file-name (buffer-base-buffer))))))))
9536 ;; Just link to current headline
9537 (setq cpltxt (concat "file:"
9538 (abbreviate-file-name
9539 (buffer-file-name (buffer-base-buffer)))))
9540 ;; Add a context search string
9541 (when (org-xor org-context-in-file-links arg)
9542 (let* ((ee (org-element-at-point))
9543 (et (org-element-type ee))
9544 (ev (plist-get (cadr ee) :value))
9545 (ek (plist-get (cadr ee) :key))
9546 (eok (and (stringp ek) (string-match "name" ek))))
9547 (setq txt (cond
9548 ((org-at-heading-p) nil)
9549 ((and (eq et 'keyword) eok) ev)
9550 ((org-region-active-p)
9551 (buffer-substring (region-beginning) (region-end)))))
9552 (when (or (null txt) (string-match "\\S-" txt))
9553 (setq cpltxt
9554 (concat cpltxt "::"
9555 (condition-case nil
9556 (org-make-org-heading-search-string txt)
9557 (error "")))
9558 desc (or (and (eq et 'keyword) eok ev)
9559 (nth 4 (ignore-errors (org-heading-components)))
9560 "NONE")))))
9561 (if (string-match "::\\'" cpltxt)
9562 (setq cpltxt (substring cpltxt 0 -2)))
9563 (setq link cpltxt))))
9565 ((buffer-file-name (buffer-base-buffer))
9566 ;; Just link to this file here.
9567 (setq cpltxt (concat "file:"
9568 (abbreviate-file-name
9569 (buffer-file-name (buffer-base-buffer)))))
9570 ;; Add a context string.
9571 (when (org-xor org-context-in-file-links arg)
9572 (setq txt (if (org-region-active-p)
9573 (buffer-substring (region-beginning) (region-end))
9574 (buffer-substring (point-at-bol) (point-at-eol))))
9575 ;; Only use search option if there is some text.
9576 (when (string-match "\\S-" txt)
9577 (setq cpltxt
9578 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9579 desc "NONE")))
9580 (setq link cpltxt))
9582 ((org-called-interactively-p 'interactive)
9583 (user-error "No method for storing a link from this buffer"))
9585 (t (setq link nil)))
9587 ;; We're done setting link and desc, clean up
9588 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9589 (setq link (or link cpltxt)
9590 desc (or desc cpltxt))
9591 (cond ((equal desc "NONE") (setq desc nil))
9592 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9593 (let ((d0 (match-string 3 desc))
9594 (p0 (match-string 5 desc)))
9595 (setq desc
9596 (replace-regexp-in-string
9597 org-bracket-link-regexp
9598 (concat (or p0 d0)
9599 (if (equal (length (match-string 0 desc))
9600 (length desc)) "*" "")) desc)))))
9602 ;; Return the link
9603 (if (not (and (or (org-called-interactively-p 'any)
9604 executing-kbd-macro) link))
9605 (or agenda-link (and link (org-make-link-string link desc)))
9606 (push (list link desc) org-stored-links)
9607 (message "Stored: %s" (or desc link))
9608 (when custom-id
9609 (setq link (concat "file:" (abbreviate-file-name
9610 (buffer-file-name)) "::#" custom-id))
9611 (push (list link desc) org-stored-links))
9612 (car org-stored-links))))))
9614 (defun org-store-link-props (&rest plist)
9615 "Store link properties, extract names and addresses."
9616 (let (x adr)
9617 (when (setq x (plist-get plist :from))
9618 (setq adr (mail-extract-address-components x))
9619 (setq plist (plist-put plist :fromname (car adr)))
9620 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9621 (when (setq x (plist-get plist :to))
9622 (setq adr (mail-extract-address-components x))
9623 (setq plist (plist-put plist :toname (car adr)))
9624 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9625 (let ((from (plist-get plist :from))
9626 (to (plist-get plist :to)))
9627 (when (and from to org-from-is-user-regexp)
9628 (setq plist
9629 (plist-put plist :fromto
9630 (if (string-match org-from-is-user-regexp from)
9631 (concat "to %t")
9632 (concat "from %f"))))))
9633 (setq org-store-link-plist plist))
9635 (defun org-add-link-props (&rest plist)
9636 "Add these properties to the link property list."
9637 (let (key value)
9638 (while plist
9639 (setq key (pop plist) value (pop plist))
9640 (setq org-store-link-plist
9641 (plist-put org-store-link-plist key value)))))
9643 (defun org-email-link-description (&optional fmt)
9644 "Return the description part of an email link.
9645 This takes information from `org-store-link-plist' and formats it
9646 according to FMT (default from `org-email-link-description-format')."
9647 (setq fmt (or fmt org-email-link-description-format))
9648 (let* ((p org-store-link-plist)
9649 (to (plist-get p :toaddress))
9650 (from (plist-get p :fromaddress))
9651 (table
9652 (list
9653 (cons "%c" (plist-get p :fromto))
9654 (cons "%F" (plist-get p :from))
9655 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9656 (cons "%T" (plist-get p :to))
9657 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9658 (cons "%s" (plist-get p :subject))
9659 (cons "%d" (plist-get p :date))
9660 (cons "%m" (plist-get p :message-id)))))
9661 (when (string-match "%c" fmt)
9662 ;; Check if the user wrote this message
9663 (if (and org-from-is-user-regexp from to
9664 (save-match-data (string-match org-from-is-user-regexp from)))
9665 (setq fmt (replace-match "to %t" t t fmt))
9666 (setq fmt (replace-match "from %f" t t fmt))))
9667 (org-replace-escapes fmt table)))
9669 (defun org-make-org-heading-search-string (&optional string)
9670 "Make search string for the current headline or STRING."
9671 (let ((s (or string
9672 (and (derived-mode-p 'org-mode)
9673 (save-excursion
9674 (org-back-to-heading t)
9675 (org-element-property :raw-value (org-element-at-point))))))
9676 (lines org-context-in-file-links))
9677 (or string (setq s (concat "*" s))) ; Add * for headlines
9678 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9679 (when (and string (integerp lines) (> lines 0))
9680 (let ((slines (org-split-string s "\n")))
9681 (when (< lines (length slines))
9682 (setq s (mapconcat
9683 'identity
9684 (reverse (nthcdr (- (length slines) lines)
9685 (reverse slines))) "\n")))))
9686 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9688 (defun org-make-link-string (link &optional description)
9689 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9690 (unless (string-match "\\S-" link)
9691 (error "Empty link"))
9692 (when (and description
9693 (stringp description)
9694 (not (string-match "\\S-" description)))
9695 (setq description nil))
9696 (when (stringp description)
9697 ;; Remove brackets from the description, they are fatal.
9698 (while (string-match "\\[" description)
9699 (setq description (replace-match "{" t t description)))
9700 (while (string-match "\\]" description)
9701 (setq description (replace-match "}" t t description))))
9702 (when (equal link description)
9703 ;; No description needed, it is identical
9704 (setq description nil))
9705 (when (and (not description)
9706 (not (string-match (org-image-file-name-regexp) link))
9707 (not (equal link (org-link-escape link))))
9708 (setq description (org-extract-attributes link)))
9709 (setq link
9710 (cond ((string-match (org-image-file-name-regexp) link) link)
9711 ((string-match org-link-types-re link)
9712 (concat (match-string 1 link)
9713 (org-link-escape (substring link (match-end 1)))))
9714 (t (org-link-escape link))))
9715 (concat "[[" link "]"
9716 (if description (concat "[" description "]") "")
9717 "]"))
9719 (defconst org-link-escape-chars
9720 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9721 "List of characters that should be escaped in link.
9722 This is the list that is used for internal purposes.")
9724 (defconst org-link-escape-chars-browser
9725 '(?\ ?\")
9726 "List of escapes for characters that are problematic in links.
9727 This is the list that is used before handing over to the browser.")
9729 (defun org-link-escape (text &optional table merge)
9730 "Return percent escaped representation of TEXT.
9731 TEXT is a string with the text to escape.
9732 Optional argument TABLE is a list with characters that should be
9733 escaped. When nil, `org-link-escape-chars' is used.
9734 If optional argument MERGE is set, merge TABLE into
9735 `org-link-escape-chars'."
9736 (cond
9737 ((and table merge)
9738 (mapc (lambda (defchr)
9739 (unless (member defchr table)
9740 (setq table (cons defchr table)))) org-link-escape-chars))
9741 ((null table)
9742 (setq table org-link-escape-chars)))
9743 (mapconcat
9744 (lambda (char)
9745 (if (or (member char table)
9746 (and (or (< char 32) (= char 37) (> char 126))
9747 org-url-hexify-p))
9748 (mapconcat (lambda (sequence-element)
9749 (format "%%%.2X" sequence-element))
9750 (or (encode-coding-char char 'utf-8)
9751 (error "Unable to percent escape character: %s"
9752 (char-to-string char))) "")
9753 (char-to-string char))) text ""))
9755 (defun org-link-unescape (str)
9756 "Unhex hexified Unicode strings as returned from the JavaScript function
9757 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9758 (unless (and (null str) (string= "" str))
9759 (let ((pos 0) (case-fold-search t) unhexed)
9760 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
9761 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9762 (setq str (replace-match unhexed t t str))
9763 (setq pos (+ pos (length unhexed))))))
9764 str)
9766 (defun org-link-unescape-compound (hex)
9767 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9768 Note: this function also decodes single byte encodings like
9769 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9770 (save-match-data
9771 (let* ((bytes (cdr (split-string hex "%")))
9772 (ret "")
9773 (eat 0)
9774 (sum 0))
9775 (while bytes
9776 (let* ((val (string-to-number (pop bytes) 16))
9777 (shift-xor
9778 (if (= 0 eat)
9779 (cond
9780 ((>= val 252) (cons 6 252))
9781 ((>= val 248) (cons 5 248))
9782 ((>= val 240) (cons 4 240))
9783 ((>= val 224) (cons 3 224))
9784 ((>= val 192) (cons 2 192))
9785 (t (cons 0 0)))
9786 (cons 6 128))))
9787 (if (>= val 192) (setq eat (car shift-xor)))
9788 (setq val (logxor val (cdr shift-xor)))
9789 (setq sum (+ (lsh sum (car shift-xor)) val))
9790 (if (> eat 0) (setq eat (- eat 1)))
9791 (cond
9792 ((= 0 eat) ;multi byte
9793 (setq ret (concat ret (org-char-to-string sum)))
9794 (setq sum 0))
9795 ((not bytes) ; single byte(s)
9796 (setq ret (org-link-unescape-single-byte-sequence hex))))
9797 )) ;; end (while bytes
9798 ret )))
9800 (defun org-link-unescape-single-byte-sequence (hex)
9801 "Unhexify hex-encoded single byte character sequences."
9802 (mapconcat (lambda (byte)
9803 (char-to-string (string-to-number byte 16)))
9804 (cdr (split-string hex "%")) ""))
9806 (defun org-xor (a b)
9807 "Exclusive or."
9808 (if a (not b) b))
9810 (defun org-fixup-message-id-for-http (s)
9811 "Replace special characters in a message id, so it can be used in an http query."
9812 (when (string-match "%" s)
9813 (setq s (mapconcat (lambda (c)
9814 (if (eq c ?%)
9815 "%25"
9816 (char-to-string c)))
9817 s "")))
9818 (while (string-match "<" s)
9819 (setq s (replace-match "%3C" t t s)))
9820 (while (string-match ">" s)
9821 (setq s (replace-match "%3E" t t s)))
9822 (while (string-match "@" s)
9823 (setq s (replace-match "%40" t t s)))
9826 (defun org-link-prettify (link)
9827 "Return a human-readable representation of LINK.
9828 The car of LINK must be a raw link the cdr of LINK must be either
9829 a link description or nil."
9830 (let ((desc (or (cadr link) "<no description>")))
9831 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9832 "<" (car link) ">")))
9834 ;;;###autoload
9835 (defun org-insert-link-global ()
9836 "Insert a link like Org-mode does.
9837 This command can be called in any mode to insert a link in Org-mode syntax."
9838 (interactive)
9839 (org-load-modules-maybe)
9840 (org-run-like-in-org-mode 'org-insert-link))
9842 (defun org-insert-all-links (&optional keep)
9843 "Insert all links in `org-stored-links'."
9844 (interactive "P")
9845 (let ((links (copy-sequence org-stored-links)) l)
9846 (while (setq l (if keep (pop links) (pop org-stored-links)))
9847 (insert "- ")
9848 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9849 (insert "\n"))))
9851 (defun org-link-fontify-links-to-this-file ()
9852 "Fontify links to the current file in `org-stored-links'."
9853 (let ((f (buffer-file-name)) a b)
9854 (setq a (mapcar (lambda(l)
9855 (let ((ll (car l)))
9856 (when (and (string-match "^file:\\(.+\\)::" ll)
9857 (equal f (expand-file-name (match-string 1 ll))))
9858 ll)))
9859 org-stored-links))
9860 (when (featurep 'org-id)
9861 (setq b (mapcar (lambda(l)
9862 (let ((ll (car l)))
9863 (when (and (string-match "^id:\\(.+\\)$" ll)
9864 (equal f (expand-file-name
9865 (or (org-id-find-id-file
9866 (match-string 1 ll)) ""))))
9867 ll)))
9868 org-stored-links)))
9869 (mapcar (lambda(l)
9870 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9871 (delq nil (append a b)))))
9873 (defvar org-link-links-in-this-file nil)
9874 (defun org-insert-link (&optional complete-file link-location default-description)
9875 "Insert a link. At the prompt, enter the link.
9877 Completion can be used to insert any of the link protocol prefixes like
9878 http or ftp in use.
9880 The history can be used to select a link previously stored with
9881 `org-store-link'. When the empty string is entered (i.e. if you just
9882 press RET at the prompt), the link defaults to the most recently
9883 stored link. As SPC triggers completion in the minibuffer, you need to
9884 use M-SPC or C-q SPC to force the insertion of a space character.
9886 You will also be prompted for a description, and if one is given, it will
9887 be displayed in the buffer instead of the link.
9889 If there is already a link at point, this command will allow you to edit link
9890 and description parts.
9892 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
9893 be selected using completion. The path to the file will be relative to the
9894 current directory if the file is in the current directory or a subdirectory.
9895 Otherwise, the link will be the absolute path as completed in the minibuffer
9896 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9897 option `org-link-file-path-type'.
9899 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
9900 the current directory or below.
9902 With three \\[universal-argument] prefixes, negate the meaning of
9903 `org-keep-stored-link-after-insertion'.
9905 If `org-make-link-description-function' is non-nil, this function will be
9906 called with the link target, and the result will be the default
9907 link description.
9909 If the LINK-LOCATION parameter is non-nil, this value will be
9910 used as the link location instead of reading one interactively.
9912 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9913 be used as the default description."
9914 (interactive "P")
9915 (let* ((wcf (current-window-configuration))
9916 (origbuf (current-buffer))
9917 (region (if (org-region-active-p)
9918 (buffer-substring (region-beginning) (region-end))))
9919 (remove (and region (list (region-beginning) (region-end))))
9920 (desc region)
9921 tmphist ; byte-compile incorrectly complains about this
9922 (link link-location)
9923 (abbrevs org-link-abbrev-alist-local)
9924 entry file all-prefixes auto-desc)
9925 (cond
9926 (link-location) ; specified by arg, just use it.
9927 ((org-in-regexp org-bracket-link-regexp 1)
9928 ;; We do have a link at point, and we are going to edit it.
9929 (setq remove (list (match-beginning 0) (match-end 0)))
9930 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9931 (setq link (read-string "Link: "
9932 (org-link-unescape
9933 (org-match-string-no-properties 1)))))
9934 ((or (org-in-regexp org-angle-link-re)
9935 (org-in-regexp org-plain-link-re))
9936 ;; Convert to bracket link
9937 (setq remove (list (match-beginning 0) (match-end 0))
9938 link (read-string "Link: "
9939 (org-remove-angle-brackets (match-string 0)))))
9940 ((member complete-file '((4) (16)))
9941 ;; Completing read for file names.
9942 (setq link (org-file-complete-link complete-file)))
9944 ;; Read link, with completion for stored links.
9945 (org-link-fontify-links-to-this-file)
9946 (org-switch-to-buffer-other-window "*Org Links*")
9947 (with-current-buffer "*Org Links*"
9948 (erase-buffer)
9949 (insert "Insert a link.
9950 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
9951 (when org-stored-links
9952 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
9953 (insert (mapconcat 'org-link-prettify
9954 (reverse org-stored-links) "\n")))
9955 (goto-char (point-min)))
9956 (let ((cw (selected-window)))
9957 (select-window (get-buffer-window "*Org Links*" 'visible))
9958 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9959 (unless (pos-visible-in-window-p (point-max))
9960 (org-fit-window-to-buffer))
9961 (and (window-live-p cw) (select-window cw)))
9962 ;; Fake a link history, containing the stored links.
9963 (setq tmphist (append (mapcar 'car org-stored-links)
9964 org-insert-link-history))
9965 (setq all-prefixes (append (mapcar 'car abbrevs)
9966 (mapcar 'car org-link-abbrev-alist)
9967 org-link-types))
9968 (unwind-protect
9969 (progn
9970 (setq link
9971 (org-completing-read
9972 "Link: "
9973 (append
9974 (mapcar (lambda (x) (concat x ":"))
9975 all-prefixes)
9976 (mapcar 'car org-stored-links))
9977 nil nil nil
9978 'tmphist
9979 (caar org-stored-links)))
9980 (if (not (string-match "\\S-" link))
9981 (user-error "No link selected"))
9982 (mapc (lambda(l)
9983 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9984 org-stored-links)
9985 (if (or (member link all-prefixes)
9986 (and (equal ":" (substring link -1))
9987 (member (substring link 0 -1) all-prefixes)
9988 (setq link (substring link 0 -1))))
9989 (setq link (with-current-buffer origbuf
9990 (org-link-try-special-completion link)))))
9991 (set-window-configuration wcf)
9992 (kill-buffer "*Org Links*"))
9993 (setq entry (assoc link org-stored-links))
9994 (or entry (push link org-insert-link-history))
9995 (setq desc (or desc (nth 1 entry)))))
9997 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9998 (not org-keep-stored-link-after-insertion))
9999 (setq org-stored-links (delq (assoc link org-stored-links)
10000 org-stored-links)))
10002 (if (and (string-match org-plain-link-re link)
10003 (not (string-match org-ts-regexp link)))
10004 ;; URL-like link, normalize the use of angular brackets.
10005 (setq link (org-remove-angle-brackets link)))
10007 ;; Check if we are linking to the current file with a search
10008 ;; option If yes, simplify the link by using only the search
10009 ;; option.
10010 (when (and buffer-file-name
10011 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10012 (let* ((path (match-string 1 link))
10013 (case-fold-search nil)
10014 (search (match-string 2 link)))
10015 (save-match-data
10016 (if (equal (file-truename buffer-file-name) (file-truename path))
10017 ;; We are linking to this same file, with a search option
10018 (setq link search)))))
10020 ;; Check if we can/should use a relative path. If yes, simplify the link
10021 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10022 (let* ((type (match-string 1 link))
10023 (path (match-string 2 link))
10024 (origpath path)
10025 (case-fold-search nil))
10026 (cond
10027 ((or (eq org-link-file-path-type 'absolute)
10028 (equal complete-file '(16)))
10029 (setq path (abbreviate-file-name (expand-file-name path))))
10030 ((eq org-link-file-path-type 'noabbrev)
10031 (setq path (expand-file-name path)))
10032 ((eq org-link-file-path-type 'relative)
10033 (setq path (file-relative-name path)))
10035 (save-match-data
10036 (if (string-match (concat "^" (regexp-quote
10037 (expand-file-name
10038 (file-name-as-directory
10039 default-directory))))
10040 (expand-file-name path))
10041 ;; We are linking a file with relative path name.
10042 (setq path (substring (expand-file-name path)
10043 (match-end 0)))
10044 (setq path (abbreviate-file-name (expand-file-name path)))))))
10045 (setq link (concat type path))
10046 (if (equal desc origpath)
10047 (setq desc path))))
10049 (if org-make-link-description-function
10050 (setq desc
10051 (or (condition-case nil
10052 (funcall org-make-link-description-function link desc)
10053 (error (progn (message "Can't get link description from `%s'"
10054 (symbol-name org-make-link-description-function))
10055 (sit-for 2) nil)))
10056 (read-string "Description: " default-description)))
10057 (if default-description (setq desc default-description)
10058 (setq desc (or (and auto-desc desc)
10059 (read-string "Description: " desc)))))
10061 (unless (string-match "\\S-" desc) (setq desc nil))
10062 (if remove (apply 'delete-region remove))
10063 (insert (org-make-link-string link desc))))
10065 (defun org-link-try-special-completion (type)
10066 "If there is completion support for link type TYPE, offer it."
10067 (let ((fun (intern (concat "org-" type "-complete-link"))))
10068 (if (functionp fun)
10069 (funcall fun)
10070 (read-string "Link (no completion support): " (concat type ":")))))
10072 (defun org-file-complete-link (&optional arg)
10073 "Create a file link using completion."
10074 (let (file link)
10075 (setq file (org-iread-file-name "File: "))
10076 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10077 (pwd1 (file-name-as-directory (abbreviate-file-name
10078 (expand-file-name ".")))))
10079 (cond
10080 ((equal arg '(16))
10081 (setq link (concat
10082 "file:"
10083 (abbreviate-file-name (expand-file-name file)))))
10084 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10085 (setq link (concat "file:" (match-string 1 file))))
10086 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10087 (expand-file-name file))
10088 (setq link (concat
10089 "file:" (match-string 1 (expand-file-name file)))))
10090 (t (setq link (concat "file:" file)))))
10091 link))
10093 (defun org-iread-file-name (&rest args)
10094 "Read-file-name using `ido-mode' speedup if available.
10095 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10096 See `read-file-name' for a description of parameters."
10097 (org-without-partial-completion
10098 (if (and org-completion-use-ido
10099 (fboundp 'ido-read-file-name)
10100 (boundp 'ido-mode) ido-mode
10101 (listp (second args)))
10102 (let ((ido-enter-matching-directory nil))
10103 (apply 'ido-read-file-name args))
10104 (apply 'read-file-name args))))
10106 (defun org-completing-read (&rest args)
10107 "Completing-read with SPACE being a normal character."
10108 (let ((enable-recursive-minibuffers t)
10109 (minibuffer-local-completion-map
10110 (copy-keymap minibuffer-local-completion-map)))
10111 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10112 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10113 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10114 (apply 'org-icompleting-read args)))
10116 (defun org-completing-read-no-i (&rest args)
10117 (let (org-completion-use-ido org-completion-use-iswitchb)
10118 (apply 'org-completing-read args)))
10120 (defun org-iswitchb-completing-read (prompt choices &rest args)
10121 "Use iswitch as a completing-read replacement to choose from choices.
10122 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10123 from."
10124 (let* ((iswitchb-use-virtual-buffers nil)
10125 (iswitchb-make-buflist-hook
10126 (lambda ()
10127 (setq iswitchb-temp-buflist choices))))
10128 (iswitchb-read-buffer prompt)))
10130 (defun org-icompleting-read (&rest args)
10131 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10132 (org-without-partial-completion
10133 (if (and org-completion-use-ido
10134 (fboundp 'ido-completing-read)
10135 (boundp 'ido-mode) ido-mode
10136 (listp (second args)))
10137 (let ((ido-enter-matching-directory nil))
10138 (apply 'ido-completing-read (concat (car args))
10139 (if (consp (car (nth 1 args)))
10140 (mapcar 'car (nth 1 args))
10141 (nth 1 args))
10142 (cddr args)))
10143 (if (and org-completion-use-iswitchb
10144 (boundp 'iswitchb-mode) iswitchb-mode
10145 (listp (second args)))
10146 (apply 'org-iswitchb-completing-read (concat (car args))
10147 (if (consp (car (nth 1 args)))
10148 (mapcar 'car (nth 1 args))
10149 (nth 1 args))
10150 (cddr args))
10151 (apply 'completing-read args)))))
10153 (defun org-extract-attributes (s)
10154 "Extract the attributes cookie from a string and set as text property."
10155 (let (a attr (start 0) key value)
10156 (save-match-data
10157 (when (string-match "{{\\([^}]+\\)}}$" s)
10158 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10159 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10160 (setq key (match-string 1 a) value (match-string 2 a)
10161 start (match-end 0)
10162 attr (plist-put attr (intern key) value))))
10163 (org-add-props s nil 'org-attr attr))
10166 ;;; Opening/following a link
10168 (defvar org-link-search-failed nil)
10170 (defvar org-open-link-functions nil
10171 "Hook for functions finding a plain text link.
10172 These functions must take a single argument, the link content.
10173 They will be called for links that look like [[link text][description]]
10174 when LINK TEXT does not have a protocol like \"http:\" and does not look
10175 like a filename (e.g. \"./blue.png\").
10177 These functions will be called *before* Org attempts to resolve the
10178 link by doing text searches in the current buffer - so if you want a
10179 link \"[[target]]\" to still find \"<<target>>\", your function should
10180 handle this as a special case.
10182 When the function does handle the link, it must return a non-nil value.
10183 If it decides that it is not responsible for this link, it must return
10184 nil to indicate that that Org-mode can continue with other options
10185 like exact and fuzzy text search.")
10187 (defun org-next-link (&optional search-backward)
10188 "Move forward to the next link.
10189 If the link is in hidden text, expose it."
10190 (interactive "P")
10191 (when (and org-link-search-failed (eq this-command last-command))
10192 (goto-char (point-min))
10193 (message "Link search wrapped back to beginning of buffer"))
10194 (setq org-link-search-failed nil)
10195 (let* ((pos (point))
10196 (ct (org-context))
10197 (a (assoc :link ct))
10198 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10199 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10200 ((looking-at org-any-link-re)
10201 ;; Don't stay stuck at link without an org-link face
10202 (forward-char (if search-backward -1 1))))
10203 (if (funcall srch-fun org-any-link-re nil t)
10204 (progn
10205 (goto-char (match-beginning 0))
10206 (if (outline-invisible-p) (org-show-context)))
10207 (goto-char pos)
10208 (setq org-link-search-failed t)
10209 (message "No further link found"))))
10211 (defun org-previous-link ()
10212 "Move backward to the previous link.
10213 If the link is in hidden text, expose it."
10214 (interactive)
10215 (funcall 'org-next-link t))
10217 (defun org-translate-link (s)
10218 "Translate a link string if a translation function has been defined."
10219 (if (and org-link-translation-function
10220 (fboundp org-link-translation-function)
10221 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10222 (progn
10223 (setq s (funcall org-link-translation-function
10224 (match-string 1 s) (match-string 2 s)))
10225 (concat (car s) ":" (cdr s)))
10228 (defun org-translate-link-from-planner (type path)
10229 "Translate a link from Emacs Planner syntax so that Org can follow it.
10230 This is still an experimental function, your mileage may vary."
10231 (cond
10232 ((member type '("http" "https" "news" "ftp"))
10233 ;; standard Internet links are the same.
10234 nil)
10235 ((and (equal type "irc") (string-match "^//" path))
10236 ;; Planner has two / at the beginning of an irc link, we have 1.
10237 ;; We should have zero, actually....
10238 (setq path (substring path 1)))
10239 ((and (equal type "lisp") (string-match "^/" path))
10240 ;; Planner has a slash, we do not.
10241 (setq type "elisp" path (substring path 1)))
10242 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10243 ;; A typical message link. Planner has the id after the final slash,
10244 ;; we separate it with a hash mark
10245 (setq path (concat (match-string 1 path) "#"
10246 (org-remove-angle-brackets (match-string 2 path))))))
10247 (cons type path))
10249 (defun org-find-file-at-mouse (ev)
10250 "Open file link or URL at mouse."
10251 (interactive "e")
10252 (mouse-set-point ev)
10253 (org-open-at-point 'in-emacs))
10255 (defun org-open-at-mouse (ev)
10256 "Open file link or URL at mouse.
10257 See the docstring of `org-open-file' for details."
10258 (interactive "e")
10259 (mouse-set-point ev)
10260 (if (eq major-mode 'org-agenda-mode)
10261 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10262 (org-open-at-point))
10264 (defvar org-window-config-before-follow-link nil
10265 "The window configuration before following a link.
10266 This is saved in case the need arises to restore it.")
10268 (defvar org-open-link-marker (make-marker)
10269 "Marker pointing to the location where `org-open-at-point' was called.")
10271 ;;;###autoload
10272 (defun org-open-at-point-global ()
10273 "Follow a link like Org-mode does.
10274 This command can be called in any mode to follow a link that has
10275 Org-mode syntax."
10276 (interactive)
10277 (org-run-like-in-org-mode 'org-open-at-point))
10279 ;;;###autoload
10280 (defun org-open-link-from-string (s &optional arg reference-buffer)
10281 "Open a link in the string S, as if it was in Org-mode."
10282 (interactive "sLink: \nP")
10283 (let ((reference-buffer (or reference-buffer (current-buffer))))
10284 (with-temp-buffer
10285 (let ((org-inhibit-startup (not reference-buffer)))
10286 (org-mode)
10287 (insert s)
10288 (goto-char (point-min))
10289 (when reference-buffer
10290 (setq org-link-abbrev-alist-local
10291 (with-current-buffer reference-buffer
10292 org-link-abbrev-alist-local)))
10293 (org-open-at-point arg reference-buffer)))))
10295 (defvar org-open-at-point-functions nil
10296 "Hook that is run when following a link at point.
10298 Functions in this hook must return t if they identify and follow
10299 a link at point. If they don't find anything interesting at point,
10300 they must return nil.")
10302 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10303 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10304 (defun org-open-at-point (&optional arg reference-buffer)
10305 "Open link at or after point.
10306 If there is no link at point, this function will search forward up to
10307 the end of the current line.
10308 Normally, files will be opened by an appropriate application. If the
10309 optional prefix argument ARG is non-nil, Emacs will visit the file.
10310 With a double prefix argument, try to open outside of Emacs, in the
10311 application the system uses for this file type."
10312 (interactive "P")
10313 ;; if in a code block, then open the block's results
10314 (unless (call-interactively #'org-babel-open-src-block-result)
10315 (org-load-modules-maybe)
10316 (move-marker org-open-link-marker (point))
10317 (setq org-window-config-before-follow-link (current-window-configuration))
10318 (org-remove-occur-highlights nil nil t)
10319 (cond
10320 ((and (org-at-heading-p)
10321 (not (org-at-timestamp-p t))
10322 (not (org-in-regexp
10323 (concat org-plain-link-re "\\|"
10324 org-bracket-link-regexp "\\|"
10325 org-angle-link-re "\\|"
10326 "[ \t]:[^ \t\n]+:[ \t]*$")))
10327 (not (get-text-property (point) 'org-linked-text)))
10328 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10329 (lk0 (car lkall))
10330 (lk (if (stringp lk0) (list lk0) lk0))
10331 (lkend (cdr lkall)))
10332 (mapcar (lambda(l)
10333 (search-forward l nil lkend)
10334 (goto-char (match-beginning 0))
10335 (org-open-at-point))
10336 lk))
10337 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10338 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10339 ((and (org-at-timestamp-p t)
10340 (not (org-in-regexp org-bracket-link-regexp)))
10341 (org-follow-timestamp-link))
10342 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10343 (not (org-in-regexp org-any-link-re)))
10344 (org-footnote-action))
10346 (let (type path link line search (pos (point)))
10347 (catch 'match
10348 (save-excursion
10349 (or (org-in-regexp org-plain-link-re)
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 (save-match-data
10389 (progn
10390 (goto-char (car match))
10391 (not (org-in-regexp org-bracket-link-regexp)))))))
10392 (let ((line_ending (save-excursion (end-of-line) (point))))
10393 ;; We are in a line before a plain or bracket link
10394 (or (re-search-forward org-plain-link-re line_ending t)
10395 (re-search-forward org-bracket-link-regexp line_ending t))))
10396 (setq type (match-string 1)
10397 path (org-link-unescape (match-string 2)))
10398 (throw 'match t)))
10399 (save-excursion
10400 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
10401 (setq type "tags"
10402 path (match-string 1))
10403 (while (string-match ":" path)
10404 (setq path (replace-match "+" t t path)))
10405 (throw 'match t)))
10406 (when (org-in-regexp "<\\([^><\n]+\\)>")
10407 (setq type "tree-match"
10408 path (match-string 1))
10409 (throw 'match t)))
10410 (unless path
10411 (user-error "No link found"))
10413 ;; switch back to reference buffer
10414 ;; needed when if called in a temporary buffer through
10415 ;; org-open-link-from-string
10416 (with-current-buffer (or reference-buffer (current-buffer))
10418 ;; Remove any trailing spaces in path
10419 (if (string-match " +\\'" path)
10420 (setq path (replace-match "" t t path)))
10421 (if (and org-link-translation-function
10422 (fboundp org-link-translation-function))
10423 ;; Check if we need to translate the link
10424 (let ((tmp (funcall org-link-translation-function type path)))
10425 (setq type (car tmp) path (cdr tmp))))
10427 (cond
10429 ((assoc type org-link-protocols)
10430 (funcall (nth 1 (assoc type org-link-protocols)) path))
10432 ((equal type "help")
10433 (let ((f-or-v (intern path)))
10434 (cond ((fboundp f-or-v)
10435 (describe-function f-or-v))
10436 ((boundp f-or-v)
10437 (describe-variable f-or-v))
10438 (t (error "Not a known function or variable")))))
10440 ((equal type "mailto")
10441 (let ((cmd (car org-link-mailto-program))
10442 (args (cdr org-link-mailto-program)) args1
10443 (address path) (subject "") a)
10444 (if (string-match "\\(.*\\)::\\(.*\\)" path)
10445 (setq address (match-string 1 path)
10446 subject (org-link-escape (match-string 2 path))))
10447 (while args
10448 (cond
10449 ((not (stringp (car args))) (push (pop args) args1))
10450 (t (setq a (pop args))
10451 (if (string-match "%a" a)
10452 (setq a (replace-match address t t a)))
10453 (if (string-match "%s" a)
10454 (setq a (replace-match subject t t a)))
10455 (push a args1))))
10456 (apply cmd (nreverse args1))))
10458 ((member type '("http" "https" "ftp" "news"))
10459 (browse-url
10460 (concat type ":"
10461 (if (org-string-match-p
10462 (concat "[[:nonascii:]"
10463 org-link-escape-chars-browser "]")
10464 path)
10465 (org-link-escape path org-link-escape-chars-browser)
10466 path))))
10468 ((string= type "doi")
10469 (browse-url
10470 (concat org-doi-server-url
10471 (if (org-string-match-p
10472 (concat "[[:nonascii:]"
10473 org-link-escape-chars-browser "]")
10474 path)
10475 (org-link-escape path org-link-escape-chars-browser)
10476 path))))
10478 ((member type '("message"))
10479 (browse-url (concat type ":" path)))
10481 ((string= type "tags")
10482 (org-tags-view arg path))
10484 ((string= type "tree-match")
10485 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
10487 ((string= type "file")
10488 (if (string-match "::\\([0-9]+\\)\\'" path)
10489 (setq line (string-to-number (match-string 1 path))
10490 path (substring path 0 (match-beginning 0)))
10491 (if (string-match "::\\(.+\\)\\'" path)
10492 (setq search (match-string 1 path)
10493 path (substring path 0 (match-beginning 0)))))
10494 (if (string-match "[*?{]" (file-name-nondirectory path))
10495 (dired path)
10496 (org-open-file path arg line search)))
10498 ((string= type "shell")
10499 (let ((buf (generate-new-buffer "*Org Shell Output"))
10500 (cmd path))
10501 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10502 (string-match org-confirm-shell-link-not-regexp cmd))
10503 (not org-confirm-shell-link-function)
10504 (funcall org-confirm-shell-link-function
10505 (format "Execute \"%s\" in shell? "
10506 (org-add-props cmd nil
10507 'face 'org-warning))))
10508 (progn
10509 (message "Executing %s" cmd)
10510 (shell-command cmd buf)
10511 (if (featurep 'midnight)
10512 (setq clean-buffer-list-kill-buffer-names
10513 (cons buf clean-buffer-list-kill-buffer-names))))
10514 (error "Abort"))))
10516 ((string= type "elisp")
10517 (let ((cmd path))
10518 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10519 (string-match org-confirm-elisp-link-not-regexp cmd))
10520 (not org-confirm-elisp-link-function)
10521 (funcall org-confirm-elisp-link-function
10522 (format "Execute \"%s\" as elisp? "
10523 (org-add-props cmd nil
10524 'face 'org-warning))))
10525 (message "%s => %s" cmd
10526 (if (equal (string-to-char cmd) ?\()
10527 (eval (read cmd))
10528 (call-interactively (read cmd))))
10529 (error "Abort"))))
10531 ((and (string= type "thisfile")
10532 (or (run-hook-with-args-until-success
10533 'org-open-link-functions path)
10534 (and link
10535 (string-match "^id:" link)
10536 (or (featurep 'org-id) (require 'org-id))
10537 (progn
10538 (funcall (nth 1 (assoc "id" org-link-protocols))
10539 (substring path 3))
10540 t)))))
10542 ((string= type "thisfile")
10543 (if arg
10544 (switch-to-buffer-other-window
10545 (org-get-buffer-for-internal-link (current-buffer)))
10546 (org-mark-ring-push))
10547 (let ((cmd `(org-link-search
10548 ,path
10549 ,(cond ((equal arg '(4)) ''occur)
10550 ((equal arg '(16)) ''org-occur))
10551 ,pos)))
10552 (condition-case nil (let ((org-link-search-inhibit-query t))
10553 (eval cmd))
10554 (error (progn (widen) (eval cmd))))))
10556 (t (browse-url-at-point)))))))
10557 (move-marker org-open-link-marker nil)
10558 (run-hook-with-args 'org-follow-link-hook)))
10560 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10561 "Offer links in the current entry and return the selected link.
10562 If there is only one link, return it.
10563 If NTH is an integer, return the NTH link found.
10564 If ZERO is a string, check also this string for a link, and if
10565 there is one, return it."
10566 (with-current-buffer buffer
10567 (save-excursion
10568 (save-restriction
10569 (widen)
10570 (goto-char marker)
10571 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
10572 "\\(" org-angle-link-re "\\)\\|"
10573 "\\(" org-plain-link-re "\\)"))
10574 (cnt ?0)
10575 (in-emacs (if (integerp nth) nil nth))
10576 have-zero end links link c)
10577 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10578 (push (match-string 0 zero) links)
10579 (setq cnt (1- cnt) have-zero t))
10580 (save-excursion
10581 (org-back-to-heading t)
10582 (setq end (save-excursion (outline-next-heading) (point)))
10583 (while (re-search-forward re end t)
10584 (push (match-string 0) links))
10585 (setq links (org-uniquify (reverse links))))
10586 (cond
10587 ((null links)
10588 (message "No links"))
10589 ((equal (length links) 1)
10590 (setq link (car links)))
10591 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10592 (setq link (nth (if have-zero nth (1- nth)) links)))
10593 (t ; we have to select a link
10594 (save-excursion
10595 (save-window-excursion
10596 (delete-other-windows)
10597 (with-output-to-temp-buffer "*Select Link*"
10598 (mapc (lambda (l)
10599 (if (not (string-match org-bracket-link-regexp l))
10600 (princ (format "[%c] %s\n" (incf cnt)
10601 (org-remove-angle-brackets l)))
10602 (if (match-end 3)
10603 (princ (format "[%c] %s (%s)\n" (incf cnt)
10604 (match-string 3 l) (match-string 1 l)))
10605 (princ (format "[%c] %s\n" (incf cnt)
10606 (match-string 1 l))))))
10607 links))
10608 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10609 (message "Select link to open, RET to open all:")
10610 (setq c (read-char-exclusive))
10611 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10612 (when (equal c ?q) (error "Abort"))
10613 (if (equal c ?\C-m)
10614 (setq link links)
10615 (setq nth (- c ?0))
10616 (if have-zero (setq nth (1+ nth)))
10617 (unless (and (integerp nth) (>= (length links) nth))
10618 (user-error "Invalid link selection"))
10619 (setq link (nth (1- nth) links)))))
10620 (cons link end))))))
10622 ;; Add special file links that specify the way of opening
10624 (org-add-link-type "file+sys" 'org-open-file-with-system)
10625 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10626 (defun org-open-file-with-system (path)
10627 "Open file at PATH using the system way of opening it."
10628 (org-open-file path 'system))
10629 (defun org-open-file-with-emacs (path)
10630 "Open file at PATH in Emacs."
10631 (org-open-file path 'emacs))
10634 ;;; File search
10636 (defvar org-create-file-search-functions nil
10637 "List of functions to construct the right search string for a file link.
10638 These functions are called in turn with point at the location to
10639 which the link should point.
10641 A function in the hook should first test if it would like to
10642 handle this file type, for example by checking the `major-mode'
10643 or the file extension. If it decides not to handle this file, it
10644 should just return nil to give other functions a chance. If it
10645 does handle the file, it must return the search string to be used
10646 when following the link. The search string will be part of the
10647 file link, given after a double colon, and `org-open-at-point'
10648 will automatically search for it. If special measures must be
10649 taken to make the search successful, another function should be
10650 added to the companion hook `org-execute-file-search-functions',
10651 which see.
10653 A function in this hook may also use `setq' to set the variable
10654 `description' to provide a suggestion for the descriptive text to
10655 be used for this link when it gets inserted into an Org-mode
10656 buffer with \\[org-insert-link].")
10658 (defvar org-execute-file-search-functions nil
10659 "List of functions to execute a file search triggered by a link.
10661 Functions added to this hook must accept a single argument, the
10662 search string that was part of the file link, the part after the
10663 double colon. The function must first check if it would like to
10664 handle this search, for example by checking the `major-mode' or
10665 the file extension. If it decides not to handle this search, it
10666 should just return nil to give other functions a chance. If it
10667 does handle the search, it must return a non-nil value to keep
10668 other functions from trying.
10670 Each function can access the current prefix argument through the
10671 variable `current-prefix-arg'. Note that a single prefix is used
10672 to force opening a link in Emacs, so it may be good to only use a
10673 numeric or double prefix to guide the search function.
10675 In case this is needed, a function in this hook can also restore
10676 the window configuration before `org-open-at-point' was called using:
10678 (set-window-configuration org-window-config-before-follow-link)")
10680 (defun org-link-search (s &optional type avoid-pos stealth)
10681 "Search for a link search option.
10682 If S is surrounded by forward slashes, it is interpreted as a
10683 regular expression. In org-mode files, this will create an `org-occur'
10684 sparse tree. In ordinary files, `occur' will be used to list matches.
10685 If the current buffer is in `dired-mode', grep will be used to search
10686 in all files. If AVOID-POS is given, ignore matches near that position.
10688 When optional argument STEALTH is non-nil, do not modify
10689 visibility around point, thus ignoring
10690 `org-show-hierarchy-above', `org-show-following-heading' and
10691 `org-show-siblings' variables."
10692 (let ((case-fold-search t)
10693 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10694 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10695 (append '(("") (" ") ("\t") ("\n"))
10696 org-emphasis-alist)
10697 "\\|") "\\)"))
10698 (pos (point))
10699 (pre nil) (post nil)
10700 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10701 (cond
10702 ;; First check if there are any special search functions
10703 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10704 ;; Now try the builtin stuff
10705 ((and (equal (string-to-char s0) ?#)
10706 (> (length s0) 1)
10707 (save-excursion
10708 (goto-char (point-min))
10709 (and
10710 (re-search-forward
10711 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10712 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10713 (setq type 'dedicated
10714 pos (match-beginning 0))))
10715 ;; There is an exact target for this
10716 (goto-char pos)
10717 (org-back-to-heading t)))
10718 ((save-excursion
10719 (goto-char (point-min))
10720 (and
10721 (re-search-forward
10722 (concat "<<" (regexp-quote s0) ">>") nil t)
10723 (setq type 'dedicated
10724 pos (match-beginning 0))))
10725 ;; There is an exact target for this
10726 (goto-char pos))
10727 ((save-excursion
10728 (goto-char (point-min))
10729 (and
10730 (re-search-forward
10731 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
10732 (setq type 'dedicated pos (match-beginning 0))))
10733 ;; Found an element with a matching #+name affiliated keyword.
10734 (goto-char pos))
10735 ((and (string-match "^(\\(.*\\))$" s0)
10736 (save-excursion
10737 (goto-char (point-min))
10738 (and
10739 (re-search-forward
10740 (concat "[^[]" (regexp-quote
10741 (format org-coderef-label-format
10742 (match-string 1 s0))))
10743 nil t)
10744 (setq type 'dedicated
10745 pos (1+ (match-beginning 0))))))
10746 ;; There is a coderef target for this
10747 (goto-char pos))
10748 ((string-match "^/\\(.*\\)/$" s)
10749 ;; A regular expression
10750 (cond
10751 ((derived-mode-p 'org-mode)
10752 (org-occur (match-string 1 s)))
10753 (t (org-do-occur (match-string 1 s)))))
10754 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10755 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10756 (goto-char (point-min))
10757 (cond
10758 ((let (case-fold-search)
10759 (re-search-forward (format org-complex-heading-regexp-format
10760 (regexp-quote s))
10761 nil t))
10762 ;; OK, found a match
10763 (setq type 'dedicated)
10764 (goto-char (match-beginning 0)))
10765 ((and (not org-link-search-inhibit-query)
10766 (eq org-link-search-must-match-exact-headline 'query-to-create)
10767 (y-or-n-p "No match - create this as a new heading? "))
10768 (goto-char (point-max))
10769 (or (bolp) (newline))
10770 (insert "* " s "\n")
10771 (beginning-of-line 0))
10773 (goto-char pos)
10774 (error "No match"))))
10776 ;; A normal search string
10777 (when (equal (string-to-char s) ?*)
10778 ;; Anchor on headlines, post may include tags.
10779 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
10780 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
10781 s (substring s 1)))
10782 (remove-text-properties
10783 0 (length s)
10784 '(face nil mouse-face nil keymap nil fontified nil) s)
10785 ;; Make a series of regular expressions to find a match
10786 (setq words (org-split-string s "[ \n\r\t]+")
10788 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
10789 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
10790 "\\)" markers)
10791 re2a_ (concat "\\(" (mapconcat 'downcase words
10792 "[ \t\r\n]+") "\\)[ \t\r\n]")
10793 re2a (concat "[ \t\r\n]" re2a_)
10794 re4_ (concat "\\(" (mapconcat 'downcase words
10795 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
10796 re4 (concat "[^a-zA-Z_]" re4_)
10798 re1 (concat pre re2 post)
10799 re3 (concat pre (if pre re4_ re4) post)
10800 re5 (concat pre ".*" re4)
10801 re2 (concat pre re2)
10802 re2a (concat pre (if pre re2a_ re2a))
10803 re4 (concat pre (if pre re4_ re4))
10804 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
10805 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
10806 re5 "\\)"))
10807 (cond
10808 ((eq type 'org-occur) (org-occur reall))
10809 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10810 (t (goto-char (point-min))
10811 (setq type 'fuzzy)
10812 (if (or (and (org-search-not-self 1 re0 nil t)
10813 (setq type 'dedicated))
10814 (org-search-not-self 1 re1 nil t)
10815 (org-search-not-self 1 re2 nil t)
10816 (org-search-not-self 1 re2a nil t)
10817 (org-search-not-self 1 re3 nil t)
10818 (org-search-not-self 1 re4 nil t)
10819 (org-search-not-self 1 re5 nil t))
10820 (goto-char (match-beginning 1))
10821 (goto-char pos)
10822 (error "No match"))))))
10823 (and (derived-mode-p 'org-mode)
10824 (not stealth)
10825 (org-show-context 'link-search))
10826 type))
10828 (defun org-search-not-self (group &rest args)
10829 "Execute `re-search-forward', but only accept matches that do not
10830 enclose the position of `org-open-link-marker'."
10831 (let ((m org-open-link-marker))
10832 (catch 'exit
10833 (while (apply 're-search-forward args)
10834 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10835 (goto-char (match-end group))
10836 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10837 (> (match-beginning 0) (marker-position m))
10838 (< (match-end 0) (marker-position m)))
10839 (save-match-data
10840 (or (not (org-in-regexp
10841 org-bracket-link-analytic-regexp 1))
10842 (not (match-end 4)) ; no description
10843 (and (<= (match-beginning 4) (point))
10844 (>= (match-end 4) (point))))))
10845 (throw 'exit (point))))))))
10847 (defun org-get-buffer-for-internal-link (buffer)
10848 "Return a buffer to be used for displaying the link target of internal links."
10849 (cond
10850 ((not org-display-internal-link-with-indirect-buffer)
10851 buffer)
10852 ((string-match "(Clone)$" (buffer-name buffer))
10853 (message "Buffer is already a clone, not making another one")
10854 ;; we also do not modify visibility in this case
10855 buffer)
10856 (t ; make a new indirect buffer for displaying the link
10857 (let* ((bn (buffer-name buffer))
10858 (ibn (concat bn "(Clone)"))
10859 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10860 (with-current-buffer ib (org-overview))
10861 ib))))
10863 (defun org-do-occur (regexp &optional cleanup)
10864 "Call the Emacs command `occur'.
10865 If CLEANUP is non-nil, remove the printout of the regular expression
10866 in the *Occur* buffer. This is useful if the regex is long and not useful
10867 to read."
10868 (occur regexp)
10869 (when cleanup
10870 (let ((cwin (selected-window)) win beg end)
10871 (when (setq win (get-buffer-window "*Occur*"))
10872 (select-window win))
10873 (goto-char (point-min))
10874 (when (re-search-forward "match[a-z]+" nil t)
10875 (setq beg (match-end 0))
10876 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
10877 (setq end (1- (match-beginning 0)))))
10878 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10879 (goto-char (point-min))
10880 (select-window cwin))))
10882 ;;; The mark ring for links jumps
10884 (defvar org-mark-ring nil
10885 "Mark ring for positions before jumps in Org-mode.")
10886 (defvar org-mark-ring-last-goto nil
10887 "Last position in the mark ring used to go back.")
10888 ;; Fill and close the ring
10889 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10890 (loop for i from 1 to org-mark-ring-length do
10891 (push (make-marker) org-mark-ring))
10892 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10893 org-mark-ring)
10895 (defun org-mark-ring-push (&optional pos buffer)
10896 "Put the current position or POS into the mark ring and rotate it."
10897 (interactive)
10898 (setq pos (or pos (point)))
10899 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10900 (move-marker (car org-mark-ring)
10901 (or pos (point))
10902 (or buffer (current-buffer)))
10903 (message "%s"
10904 (substitute-command-keys
10905 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
10907 (defun org-mark-ring-goto (&optional n)
10908 "Jump to the previous position in the mark ring.
10909 With prefix arg N, jump back that many stored positions. When
10910 called several times in succession, walk through the entire ring.
10911 Org-mode commands jumping to a different position in the current file,
10912 or to another Org-mode file, automatically push the old position
10913 onto the ring."
10914 (interactive "p")
10915 (let (p m)
10916 (if (eq last-command this-command)
10917 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10918 (setq p org-mark-ring))
10919 (setq org-mark-ring-last-goto p)
10920 (setq m (car p))
10921 (org-pop-to-buffer-same-window (marker-buffer m))
10922 (goto-char m)
10923 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10925 (defun org-remove-angle-brackets (s)
10926 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10927 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10929 (defun org-add-angle-brackets (s)
10930 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10931 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10933 (defun org-remove-double-quotes (s)
10934 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
10935 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
10938 ;;; Following specific links
10940 (defun org-follow-timestamp-link ()
10941 "Open an agenda view for the time-stamp date/range at point."
10942 (cond
10943 ((org-at-date-range-p t)
10944 (let ((org-agenda-start-on-weekday)
10945 (t1 (match-string 1))
10946 (t2 (match-string 2)) tt1 tt2)
10947 (setq tt1 (time-to-days (org-time-string-to-time t1))
10948 tt2 (time-to-days (org-time-string-to-time t2)))
10949 (let ((org-agenda-buffer-tmp-name
10950 (format "*Org Agenda(a:%s)"
10951 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10952 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10953 ((org-at-timestamp-p t)
10954 (let ((org-agenda-buffer-tmp-name
10955 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10956 (org-agenda-list nil (time-to-days (org-time-string-to-time
10957 (substring (match-string 1) 0 10)))
10958 1)))
10959 (t (error "This should not happen"))))
10962 ;;; Following file links
10963 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10964 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10965 (declare-function mailcap-mime-info
10966 "mailcap" (string &optional request no-decode))
10967 (defvar org-wait nil)
10968 (defun org-open-file (path &optional in-emacs line search)
10969 "Open the file at PATH.
10970 First, this expands any special file name abbreviations. Then the
10971 configuration variable `org-file-apps' is checked if it contains an
10972 entry for this file type, and if yes, the corresponding command is launched.
10974 If no application is found, Emacs simply visits the file.
10976 With optional prefix argument IN-EMACS, Emacs will visit the file.
10977 With a double \\[universal-argument] \\[universal-argument] \
10978 prefix arg, Org tries to avoid opening in Emacs
10979 and to use an external application to visit the file.
10981 Optional LINE specifies a line to go to, optional SEARCH a string
10982 to search for. If LINE or SEARCH is given, the file will be
10983 opened in Emacs, unless an entry from org-file-apps that makes
10984 use of groups in a regexp matches.
10986 If you want to change the way frames are used when following a
10987 link, please customize `org-link-frame-setup'.
10989 If the file does not exist, an error is thrown."
10990 (let* ((file (if (equal path "")
10991 buffer-file-name
10992 (substitute-in-file-name (expand-file-name path))))
10993 (file-apps (append org-file-apps (org-default-apps)))
10994 (apps (org-remove-if
10995 'org-file-apps-entry-match-against-dlink-p file-apps))
10996 (apps-dlink (org-remove-if-not
10997 'org-file-apps-entry-match-against-dlink-p file-apps))
10998 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10999 (dirp (if remp nil (file-directory-p file)))
11000 (file (if (and dirp org-open-directory-means-index-dot-org)
11001 (concat (file-name-as-directory file) "index.org")
11002 file))
11003 (a-m-a-p (assq 'auto-mode apps))
11004 (dfile (downcase file))
11005 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11006 (link (cond ((and (eq line nil)
11007 (eq search nil))
11008 file)
11009 (line
11010 (concat file "::" (number-to-string line)))
11011 (search
11012 (concat file "::" search))))
11013 (dlink (downcase link))
11014 (old-buffer (current-buffer))
11015 (old-pos (point))
11016 (old-mode major-mode)
11017 ext cmd link-match-data)
11018 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11019 (setq ext (match-string 1 dfile))
11020 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11021 (setq ext (match-string 1 dfile))))
11022 (cond
11023 ((member in-emacs '((16) system))
11024 (setq cmd (cdr (assoc 'system apps))))
11025 (in-emacs (setq cmd 'emacs))
11027 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11028 (and dirp (cdr (assoc 'directory apps)))
11029 ; first, try matching against apps-dlink
11030 ; if we get a match here, store the match data for later
11031 (let ((match (assoc-default dlink apps-dlink
11032 'string-match)))
11033 (if match
11034 (progn (setq link-match-data (match-data))
11035 match)
11036 (progn (setq in-emacs (or in-emacs line search))
11037 nil))) ; if we have no match in apps-dlink,
11038 ; always open the file in emacs if line or search
11039 ; is given (for backwards compatibility)
11040 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11041 'string-match)
11042 (cdr (assoc ext apps))
11043 (cdr (assoc t apps))))))
11044 (when (eq cmd 'system)
11045 (setq cmd (cdr (assoc 'system apps))))
11046 (when (eq cmd 'default)
11047 (setq cmd (cdr (assoc t apps))))
11048 (when (eq cmd 'mailcap)
11049 (require 'mailcap)
11050 (mailcap-parse-mailcaps)
11051 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11052 (command (mailcap-mime-info mime-type)))
11053 (if (stringp command)
11054 (setq cmd command)
11055 (setq cmd 'emacs))))
11056 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11057 (not (file-exists-p file))
11058 (not org-open-non-existing-files))
11059 (user-error "No such file: %s" file))
11060 (cond
11061 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11062 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11063 (while (string-match "['\"]%s['\"]" cmd)
11064 (setq cmd (replace-match "%s" t t cmd)))
11065 (while (string-match "%s" cmd)
11066 (setq cmd (replace-match
11067 (save-match-data
11068 (shell-quote-argument
11069 (convert-standard-filename file)))
11070 t t cmd)))
11072 ;; Replace "%1", "%2" etc. in command with group matches from regex
11073 (save-match-data
11074 (let ((match-index 1)
11075 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11076 (set-match-data link-match-data)
11077 (while (<= match-index number-of-groups)
11078 (let ((regex (concat "%" (number-to-string match-index)))
11079 (replace-with (match-string match-index dlink)))
11080 (while (string-match regex cmd)
11081 (setq cmd (replace-match replace-with t t cmd))))
11082 (setq match-index (+ match-index 1)))))
11084 (save-window-excursion
11085 (message "Running %s...done" cmd)
11086 (start-process-shell-command cmd nil cmd)
11087 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11088 ((or (stringp cmd)
11089 (eq cmd 'emacs))
11090 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11091 (widen)
11092 (if line (org-goto-line line)
11093 (if search (org-link-search search))))
11094 ((consp cmd)
11095 (let ((file (convert-standard-filename file)))
11096 (save-match-data
11097 (set-match-data link-match-data)
11098 (eval cmd))))
11099 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11100 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11101 (or (not (equal old-buffer (current-buffer)))
11102 (not (equal old-pos (point))))
11103 (org-mark-ring-push old-pos old-buffer))))
11105 (defun org-file-apps-entry-match-against-dlink-p (entry)
11106 "This function returns non-nil if `entry' uses a regular
11107 expression which should be matched against the whole link by
11108 org-open-file.
11110 It assumes that is the case when the entry uses a regular
11111 expression which has at least one grouping construct and the
11112 action is either a lisp form or a command string containing
11113 '%1', i.e. using at least one subexpression match as a
11114 parameter."
11115 (let ((selector (car entry))
11116 (action (cdr entry)))
11117 (if (stringp selector)
11118 (and (> (regexp-opt-depth selector) 0)
11119 (or (and (stringp action)
11120 (string-match "%[0-9]" action))
11121 (consp action)))
11122 nil)))
11124 (defun org-default-apps ()
11125 "Return the default applications for this operating system."
11126 (cond
11127 ((eq system-type 'darwin)
11128 org-file-apps-defaults-macosx)
11129 ((eq system-type 'windows-nt)
11130 org-file-apps-defaults-windowsnt)
11131 (t org-file-apps-defaults-gnu)))
11133 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11134 "Convert extensions to regular expressions in the cars of LIST.
11135 Also, weed out any non-string entries, because the return value is used
11136 only for regexp matching.
11137 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11138 point to the symbol `emacs', indicating that the file should
11139 be opened in Emacs."
11140 (append
11141 (delq nil
11142 (mapcar (lambda (x)
11143 (if (not (stringp (car x)))
11145 (if (string-match "\\W" (car x))
11147 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11148 list))
11149 (if add-auto-mode
11150 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11152 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11153 (defun org-file-remote-p (file)
11154 "Test whether FILE specifies a location on a remote system.
11155 Return non-nil if the location is indeed remote.
11157 For example, the filename \"/user@host:/foo\" specifies a location
11158 on the system \"/user@host:\"."
11159 (cond ((fboundp 'file-remote-p)
11160 (file-remote-p file))
11161 ((fboundp 'tramp-handle-file-remote-p)
11162 (tramp-handle-file-remote-p file))
11163 ((and (boundp 'ange-ftp-name-format)
11164 (string-match (car ange-ftp-name-format) file))
11165 t)))
11168 ;;;; Refiling
11170 (defun org-get-org-file ()
11171 "Read a filename, with default directory `org-directory'."
11172 (let ((default (or org-default-notes-file remember-data-file)))
11173 (read-file-name (format "File name [%s]: " default)
11174 (file-name-as-directory org-directory)
11175 default)))
11177 (defun org-notes-order-reversed-p ()
11178 "Check if the current file should receive notes in reversed order."
11179 (cond
11180 ((not org-reverse-note-order) nil)
11181 ((eq t org-reverse-note-order) t)
11182 ((not (listp org-reverse-note-order)) nil)
11183 (t (catch 'exit
11184 (let ((all org-reverse-note-order)
11185 entry)
11186 (while (setq entry (pop all))
11187 (if (string-match (car entry) buffer-file-name)
11188 (throw 'exit (cdr entry))))
11189 nil)))))
11191 (defvar org-refile-target-table nil
11192 "The list of refile targets, created by `org-refile'.")
11194 (defvar org-agenda-new-buffers nil
11195 "Buffers created to visit agenda files.")
11197 (defvar org-refile-cache nil
11198 "Cache for refile targets.")
11200 (defvar org-refile-markers nil
11201 "All the markers used for caching refile locations.")
11203 (defun org-refile-marker (pos)
11204 "Get a new refile marker, but only if caching is in use."
11205 (if (not org-refile-use-cache)
11207 (let ((m (make-marker)))
11208 (move-marker m pos)
11209 (push m org-refile-markers)
11210 m)))
11212 (defun org-refile-cache-clear ()
11213 "Clear the refile cache and disable all the markers."
11214 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11215 (setq org-refile-markers nil)
11216 (setq org-refile-cache nil)
11217 (message "Refile cache has been cleared"))
11219 (defun org-refile-cache-check-set (set)
11220 "Check if all the markers in the cache still have live buffers."
11221 (let (marker)
11222 (catch 'exit
11223 (while (and set (setq marker (nth 3 (pop set))))
11224 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11225 (when (and marker (null (marker-buffer marker)))
11226 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11227 (sit-for 3)
11228 (throw 'exit nil)))
11229 t)))
11231 (defun org-refile-cache-put (set &rest identifiers)
11232 "Push the refile targets SET into the cache, under IDENTIFIERS."
11233 (let* ((key (sha1 (prin1-to-string identifiers)))
11234 (entry (assoc key org-refile-cache)))
11235 (if entry
11236 (setcdr entry set)
11237 (push (cons key set) org-refile-cache))))
11239 (defun org-refile-cache-get (&rest identifiers)
11240 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11241 (cond
11242 ((not org-refile-cache) nil)
11243 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11245 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11246 org-refile-cache))))
11247 (and set (org-refile-cache-check-set set) set)))))
11249 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11250 "Produce a table with refile targets."
11251 (let ((case-fold-search nil)
11252 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11253 (entries (or org-refile-targets '((nil . (:level . 1)))))
11254 targets tgs txt re files f desc descre fast-path-p level pos0)
11255 (message "Getting targets...")
11256 (with-current-buffer (or default-buffer (current-buffer))
11257 (while (setq entry (pop entries))
11258 (setq files (car entry) desc (cdr entry))
11259 (setq fast-path-p nil)
11260 (cond
11261 ((null files) (setq files (list (current-buffer))))
11262 ((eq files 'org-agenda-files)
11263 (setq files (org-agenda-files 'unrestricted)))
11264 ((and (symbolp files) (fboundp files))
11265 (setq files (funcall files)))
11266 ((and (symbolp files) (boundp files))
11267 (setq files (symbol-value files))))
11268 (if (stringp files) (setq files (list files)))
11269 (cond
11270 ((eq (car desc) :tag)
11271 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11272 ((eq (car desc) :todo)
11273 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11274 ((eq (car desc) :regexp)
11275 (setq descre (cdr desc)))
11276 ((eq (car desc) :level)
11277 (setq descre (concat "^\\*\\{" (number-to-string
11278 (if org-odd-levels-only
11279 (1- (* 2 (cdr desc)))
11280 (cdr desc)))
11281 "\\}[ \t]")))
11282 ((eq (car desc) :maxlevel)
11283 (setq fast-path-p t)
11284 (setq descre (concat "^\\*\\{1," (number-to-string
11285 (if org-odd-levels-only
11286 (1- (* 2 (cdr desc)))
11287 (cdr desc)))
11288 "\\}[ \t]")))
11289 (t (error "Bad refiling target description %s" desc)))
11290 (while (setq f (pop files))
11291 (with-current-buffer
11292 (if (bufferp f) f (org-get-agenda-file-buffer f))
11294 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11295 (progn
11296 (if (bufferp f) (setq f (buffer-file-name
11297 (buffer-base-buffer f))))
11298 (setq f (and f (expand-file-name f)))
11299 (if (eq org-refile-use-outline-path 'file)
11300 (push (list (file-name-nondirectory f) f nil nil) tgs))
11301 (save-excursion
11302 (save-restriction
11303 (widen)
11304 (goto-char (point-min))
11305 (while (re-search-forward descre nil t)
11306 (goto-char (setq pos0 (point-at-bol)))
11307 (catch 'next
11308 (when org-refile-target-verify-function
11309 (save-match-data
11310 (or (funcall org-refile-target-verify-function)
11311 (throw 'next t))))
11312 (when (and (looking-at org-complex-heading-regexp)
11313 (not (member (match-string 4) excluded-entries))
11314 (match-string 4))
11315 (setq level (org-reduced-level
11316 (- (match-end 1) (match-beginning 1)))
11317 txt (org-link-display-format (match-string 4))
11318 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11319 re (format org-complex-heading-regexp-format
11320 (regexp-quote (match-string 4))))
11321 (when org-refile-use-outline-path
11322 (setq txt (mapconcat
11323 'org-protect-slash
11324 (append
11325 (if (eq org-refile-use-outline-path
11326 'file)
11327 (list (file-name-nondirectory
11328 (buffer-file-name
11329 (buffer-base-buffer))))
11330 (if (eq org-refile-use-outline-path
11331 'full-file-path)
11332 (list (buffer-file-name
11333 (buffer-base-buffer)))))
11334 (org-get-outline-path fast-path-p
11335 level txt)
11336 (list txt))
11337 "/")))
11338 (push (list txt f re (org-refile-marker (point)))
11339 tgs)))
11340 (when (= (point) pos0)
11341 ;; verification function has not moved point
11342 (goto-char (point-at-eol))))))))
11343 (when org-refile-use-cache
11344 (org-refile-cache-put tgs (buffer-file-name) descre))
11345 (setq targets (append tgs targets))))))
11346 (message "Getting targets...done")
11347 (nreverse targets)))
11349 (defun org-protect-slash (s)
11350 (while (string-match "/" s)
11351 (setq s (replace-match "\\" t t s)))
11354 (defvar org-olpa (make-vector 20 nil))
11356 (defun org-get-outline-path (&optional fastp level heading)
11357 "Return the outline path to the current entry, as a list.
11359 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11360 routine which makes outline path derivations for an entire file,
11361 avoiding backtracing. Refile target collection makes use of that."
11362 (if fastp
11363 (progn
11364 (if (> level 19)
11365 (error "Outline path failure, more than 19 levels"))
11366 (loop for i from level upto 19 do
11367 (aset org-olpa i nil))
11368 (prog1
11369 (delq nil (append org-olpa nil))
11370 (aset org-olpa level heading)))
11371 (let (rtn case-fold-search)
11372 (save-excursion
11373 (save-restriction
11374 (widen)
11375 (while (org-up-heading-safe)
11376 (when (looking-at org-complex-heading-regexp)
11377 (push (org-trim
11378 (replace-regexp-in-string
11379 ;; Remove statistical/checkboxes cookies
11380 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11381 (org-match-string-no-properties 4)))
11382 rtn)))
11383 rtn)))))
11385 (defun org-format-outline-path (path &optional width prefix separator)
11386 "Format the outline path PATH for display.
11387 WIDTH is the maximum number of characters that is available.
11388 PREFIX is a prefix to be included in the returned string,
11389 such as the file name.
11390 SEPARATOR is inserted between the different parts of the path,
11391 the default is \"/\"."
11392 (setq width (or width 79))
11393 (if prefix (setq width (- width (length prefix))))
11394 (if (not path)
11395 (or prefix "")
11396 (let* ((nsteps (length path))
11397 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11398 (maxwidth (if (<= total-width width)
11399 10000 ;; everything fits
11400 ;; we need to shorten the level headings
11401 (/ (- width nsteps) nsteps)))
11402 (org-odd-levels-only nil)
11403 (n 0)
11404 (total (1+ (length prefix))))
11405 (setq maxwidth (max maxwidth 10))
11406 (concat prefix
11407 (if prefix (or separator "/"))
11408 (mapconcat
11409 (lambda (h)
11410 (setq n (1+ n))
11411 (if (and (= n nsteps) (< maxwidth 10000))
11412 (setq maxwidth (- total-width total)))
11413 (if (< (length h) maxwidth)
11414 (progn (setq total (+ total (length h) 1)) h)
11415 (setq h (substring h 0 (- maxwidth 2))
11416 total (+ total maxwidth 1))
11417 (if (string-match "[ \t]+\\'" h)
11418 (setq h (substring h 0 (match-beginning 0))))
11419 (setq h (concat h "..")))
11420 (org-add-props h nil 'face
11421 (nth (% (1- n) org-n-level-faces)
11422 org-level-faces))
11424 path (or separator "/"))))))
11426 (defun org-display-outline-path (&optional file current separator just-return-string)
11427 "Display the current outline path in the echo area.
11429 If FILE is non-nil, prepend the output with the file name.
11430 If CURRENT is non-nil, append the current heading to the output.
11431 SEPARATOR is passed through to `org-format-outline-path'. It separates
11432 the different parts of the path and defaults to \"/\".
11433 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11434 (interactive "P")
11435 (let* (case-fold-search
11436 (bfn (buffer-file-name (buffer-base-buffer)))
11437 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11438 res)
11439 (if current (setq path (append path
11440 (save-excursion
11441 (org-back-to-heading t)
11442 (if (looking-at org-complex-heading-regexp)
11443 (list (match-string 4)))))))
11444 (setq res
11445 (org-format-outline-path
11446 path
11447 (1- (frame-width))
11448 (and file bfn (concat (file-name-nondirectory bfn) separator))
11449 separator))
11450 (if just-return-string
11451 (org-no-properties res)
11452 (org-unlogged-message "%s" res))))
11454 (defvar org-refile-history nil
11455 "History for refiling operations.")
11457 (defvar org-after-refile-insert-hook nil
11458 "Hook run after `org-refile' has inserted its stuff at the new location.
11459 Note that this is still *before* the stuff will be removed from
11460 the *old* location.")
11462 (defvar org-capture-last-stored-marker)
11463 (defvar org-refile-keep nil
11464 "Non-nil means `org-refile' will copy instead of refile.")
11466 (defun org-copy ()
11467 "Like `org-refile', but copy."
11468 (interactive)
11469 (let ((org-refile-keep t))
11470 (funcall 'org-refile nil nil nil "Copy")))
11472 (defun org-refile (&optional goto default-buffer rfloc msg)
11473 "Move the entry or entries at point to another heading.
11474 The list of target headings is compiled using the information in
11475 `org-refile-targets', which see.
11477 At the target location, the entry is filed as a subitem of the target
11478 heading. Depending on `org-reverse-note-order', the new subitem will
11479 either be the first or the last subitem.
11481 If there is an active region, all entries in that region will be moved.
11482 However, the region must fulfill the requirement that the first heading
11483 is the first one sets the top-level of the moved text - at most siblings
11484 below it are allowed.
11486 With prefix arg GOTO, the command will only visit the target location
11487 and not actually move anything.
11489 With a double prefix arg \\[universal-argument] \\[universal-argument], \
11490 go to the location where the last refiling operation has put the subtree.
11492 With a numeric prefix argument of `2', refile to the running clock.
11494 With a numeric prefix argument of `3', emulate `org-refile-keep'
11495 being set to `t' and copy to the target location, don't move it.
11496 Beware that keeping refiled entries may result in duplicated ID
11497 properties.
11499 RFLOC can be a refile location obtained in a different way.
11501 MSG is a string to replace \"Refile\" in the default prompt with
11502 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11504 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11506 If you are using target caching (see `org-refile-use-cache'),
11507 you have to clear the target cache in order to find new targets.
11508 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11509 prefix argument (`C-u C-u C-u C-c C-w')."
11511 (interactive "P")
11512 (if (member goto '(0 (64)))
11513 (org-refile-cache-clear)
11514 (let* ((actionmsg (or msg "Refile"))
11515 (cbuf (current-buffer))
11516 (regionp (org-region-active-p))
11517 (region-start (and regionp (region-beginning)))
11518 (region-end (and regionp (region-end)))
11519 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11520 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11521 pos it nbuf file re level reversed)
11522 (setq last-command nil)
11523 (when regionp
11524 (goto-char region-start)
11525 (or (bolp) (goto-char (point-at-bol)))
11526 (setq region-start (point))
11527 (unless (or (org-kill-is-subtree-p
11528 (buffer-substring region-start region-end))
11529 (prog1 org-refile-active-region-within-subtree
11530 (let ((s (point-at-eol)))
11531 (org-toggle-heading)
11532 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11533 (user-error "The region is not a (sequence of) subtree(s)")))
11534 (if (equal goto '(16))
11535 (org-refile-goto-last-stored)
11536 (when (or
11537 (and (equal goto 2)
11538 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11539 (prog1
11540 (setq it (list (or org-clock-heading "running clock")
11541 (buffer-file-name
11542 (marker-buffer org-clock-hd-marker))
11544 (marker-position org-clock-hd-marker)))
11545 (setq goto nil)))
11546 (setq it (or rfloc
11547 (let (heading-text)
11548 (save-excursion
11549 (unless goto
11550 (org-back-to-heading t)
11551 (setq heading-text
11552 (nth 4 (org-heading-components))))
11554 (org-refile-get-location
11555 (cond (goto "Goto")
11556 (regionp (concat actionmsg " region to"))
11557 (t (concat actionmsg " subtree \""
11558 heading-text "\" to")))
11559 default-buffer
11560 (and (not (equal '(4) goto))
11561 org-refile-allow-creating-parent-nodes)
11562 goto))))))
11563 (setq file (nth 1 it)
11564 re (nth 2 it)
11565 pos (nth 3 it))
11566 (if (and (not goto)
11568 (equal (buffer-file-name) file)
11569 (if regionp
11570 (and (>= pos region-start)
11571 (<= pos region-end))
11572 (and (>= pos (point))
11573 (< pos (save-excursion
11574 (org-end-of-subtree t t))))))
11575 (error "Cannot refile to position inside the tree or region"))
11577 (setq nbuf (or (find-buffer-visiting file)
11578 (find-file-noselect file)))
11579 (if (and goto (not (equal goto 3)))
11580 (progn
11581 (org-pop-to-buffer-same-window nbuf)
11582 (goto-char pos)
11583 (org-show-context 'org-goto))
11584 (if regionp
11585 (progn
11586 (org-kill-new (buffer-substring region-start region-end))
11587 (org-save-markers-in-region region-start region-end))
11588 (org-copy-subtree 1 nil t))
11589 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11590 (find-file-noselect file)))
11591 (setq reversed (org-notes-order-reversed-p))
11592 (save-excursion
11593 (save-restriction
11594 (widen)
11595 (if pos
11596 (progn
11597 (goto-char pos)
11598 (looking-at org-outline-regexp)
11599 (setq level (org-get-valid-level (funcall outline-level) 1))
11600 (goto-char
11601 (if reversed
11602 (or (outline-next-heading) (point-max))
11603 (or (save-excursion (org-get-next-sibling))
11604 (org-end-of-subtree t t)
11605 (point-max)))))
11606 (setq level 1)
11607 (if (not reversed)
11608 (goto-char (point-max))
11609 (goto-char (point-min))
11610 (or (outline-next-heading) (goto-char (point-max)))))
11611 (if (not (bolp)) (newline))
11612 (org-paste-subtree level)
11613 (when org-log-refile
11614 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11615 (unless (eq org-log-refile 'note)
11616 (save-excursion (org-add-log-note))))
11617 (and org-auto-align-tags
11618 (let ((org-loop-over-headlines-in-active-region nil))
11619 (org-set-tags nil t)))
11620 (let ((bookmark-name (plist-get org-bookmark-names-plist
11621 :last-refile)))
11622 (when bookmark-name
11623 (with-demoted-errors
11624 (bookmark-set bookmark-name))))
11625 ;; If we are refiling for capture, make sure that the
11626 ;; last-capture pointers point here
11627 (when (org-bound-and-true-p org-refile-for-capture)
11628 (let ((bookmark-name (plist-get org-bookmark-names-plist
11629 :last-capture-marker)))
11630 (when bookmark-name
11631 (with-demoted-errors
11632 (bookmark-set bookmark-name))))
11633 (move-marker org-capture-last-stored-marker (point)))
11634 (if (fboundp 'deactivate-mark) (deactivate-mark))
11635 (run-hooks 'org-after-refile-insert-hook))))
11636 (unless org-refile-keep
11637 (if regionp
11638 (delete-region (point) (+ (point) (- region-end region-start)))
11639 (delete-region
11640 (and (org-back-to-heading t) (point))
11641 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11642 (when (featurep 'org-inlinetask)
11643 (org-inlinetask-remove-END-maybe))
11644 (setq org-markers-to-move nil)
11645 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11647 (defun org-refile-goto-last-stored ()
11648 "Go to the location where the last refile was stored."
11649 (interactive)
11650 (bookmark-jump "org-refile-last-stored")
11651 (message "This is the location of the last refile"))
11653 (defun org-refile--get-location (refloc tbl)
11654 "When user refile to REFLOC, find the associated target in TBL.
11655 Also check `org-refile-target-table'."
11656 (car (delq
11658 (mapcar
11659 (lambda (r) (or (assoc r tbl)
11660 (assoc r org-refile-target-table)))
11661 (list (replace-regexp-in-string "/$" "" refloc)
11662 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11664 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11665 no-exclude)
11666 "Prompt the user for a refile location, using PROMPT.
11667 PROMPT should not be suffixed with a colon and a space, because
11668 this function appends the default value from
11669 `org-refile-history' automatically, if that is not empty.
11670 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11671 this is used for the GOTO interface."
11672 (let ((org-refile-targets org-refile-targets)
11673 (org-refile-use-outline-path org-refile-use-outline-path)
11674 excluded-entries)
11675 (when (and (derived-mode-p 'org-mode)
11676 (not org-refile-use-cache)
11677 (not no-exclude))
11678 (org-map-tree
11679 (lambda()
11680 (setq excluded-entries
11681 (append excluded-entries (list (org-get-heading t t)))))))
11682 (setq org-refile-target-table
11683 (org-refile-get-targets default-buffer excluded-entries)))
11684 (unless org-refile-target-table
11685 (user-error "No refile targets"))
11686 (let* ((cbuf (current-buffer))
11687 (partial-completion-mode nil)
11688 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11689 (cfunc (if (and org-refile-use-outline-path
11690 org-outline-path-complete-in-steps)
11691 'org-olpath-completing-read
11692 'org-icompleting-read))
11693 (extra (if org-refile-use-outline-path "/" ""))
11694 (cbnex (concat (buffer-name) extra))
11695 (filename (and cfn (expand-file-name cfn)))
11696 (tbl (mapcar
11697 (lambda (x)
11698 (if (and (not (member org-refile-use-outline-path
11699 '(file full-file-path)))
11700 (not (equal filename (nth 1 x))))
11701 (cons (concat (car x) extra " ("
11702 (file-name-nondirectory (nth 1 x)) ")")
11703 (cdr x))
11704 (cons (concat (car x) extra) (cdr x))))
11705 org-refile-target-table))
11706 (completion-ignore-case t)
11707 cdef
11708 (prompt (concat prompt
11709 (or (and (car org-refile-history)
11710 (concat " (default " (car org-refile-history) ")"))
11711 (and (assoc cbnex tbl) (setq cdef cbnex)
11712 (concat " (default " cbnex ")"))) ": "))
11713 pa answ parent-target child parent old-hist)
11714 (setq old-hist org-refile-history)
11715 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11716 nil 'org-refile-history (or cdef (car org-refile-history))))
11717 (if (setq pa (org-refile--get-location answ tbl))
11718 (progn
11719 (org-refile-check-position pa)
11720 (when (or (not org-refile-history)
11721 (not (eq old-hist org-refile-history))
11722 (not (equal (car pa) (car org-refile-history))))
11723 (setq org-refile-history
11724 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11725 org-refile-history
11726 (cdr org-refile-history))))
11727 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11728 (pop org-refile-history)))
11730 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
11731 (progn
11732 (setq parent (match-string 1 answ)
11733 child (match-string 2 answ))
11734 (setq parent-target (org-refile--get-location parent tbl))
11735 (when (and parent-target
11736 (or (eq new-nodes t)
11737 (and (eq new-nodes 'confirm)
11738 (y-or-n-p (format "Create new node \"%s\"? "
11739 child)))))
11740 (org-refile-new-child parent-target child)))
11741 (user-error "Invalid target location")))))
11743 (declare-function org-string-nw-p "org-macs" (s))
11744 (defun org-refile-check-position (refile-pointer)
11745 "Check if the refile pointer matches the headline to which it points."
11746 (let* ((file (nth 1 refile-pointer))
11747 (re (nth 2 refile-pointer))
11748 (pos (nth 3 refile-pointer))
11749 buffer)
11750 (if (and (not (markerp pos)) (not file))
11751 (user-error "Please save the buffer to a file before refiling")
11752 (when (org-string-nw-p re)
11753 (setq buffer (if (markerp pos)
11754 (marker-buffer pos)
11755 (or (find-buffer-visiting file)
11756 (find-file-noselect file))))
11757 (with-current-buffer buffer
11758 (save-excursion
11759 (save-restriction
11760 (widen)
11761 (goto-char pos)
11762 (beginning-of-line 1)
11763 (unless (org-looking-at-p re)
11764 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11766 (defun org-refile-new-child (parent-target child)
11767 "Use refile target PARENT-TARGET to add new CHILD below it."
11768 (unless parent-target
11769 (error "Cannot find parent for new node"))
11770 (let ((file (nth 1 parent-target))
11771 (pos (nth 3 parent-target))
11772 level)
11773 (with-current-buffer (or (find-buffer-visiting file)
11774 (find-file-noselect file))
11775 (save-excursion
11776 (save-restriction
11777 (widen)
11778 (if pos
11779 (goto-char pos)
11780 (goto-char (point-max))
11781 (if (not (bolp)) (newline)))
11782 (when (looking-at org-outline-regexp)
11783 (setq level (funcall outline-level))
11784 (org-end-of-subtree t t))
11785 (org-back-over-empty-lines)
11786 (insert "\n" (make-string
11787 (if pos (org-get-valid-level level 1) 1) ?*)
11788 " " child "\n")
11789 (beginning-of-line 0)
11790 (list (concat (car parent-target) "/" child) file "" (point)))))))
11792 (defun org-olpath-completing-read (prompt collection &rest args)
11793 "Read an outline path like a file name."
11794 (let ((thetable collection)
11795 (org-completion-use-ido nil) ; does not work with ido.
11796 (org-completion-use-iswitchb nil)) ; or iswitchb
11797 (apply
11798 'org-icompleting-read prompt
11799 (lambda (string predicate &optional flag)
11800 (let (rtn r f (l (length string)))
11801 (cond
11802 ((eq flag nil)
11803 ;; try completion
11804 (try-completion string thetable))
11805 ((eq flag t)
11806 ;; all-completions
11807 (setq rtn (all-completions string thetable predicate))
11808 (mapcar
11809 (lambda (x)
11810 (setq r (substring x l))
11811 (if (string-match " ([^)]*)$" x)
11812 (setq f (match-string 0 x))
11813 (setq f ""))
11814 (if (string-match "/" r)
11815 (concat string (substring r 0 (match-end 0)) f)
11817 rtn))
11818 ((eq flag 'lambda)
11819 ;; exact match?
11820 (assoc string thetable)))))
11821 args)))
11823 ;;;; Dynamic blocks
11825 (defun org-find-dblock (name)
11826 "Find the first dynamic block with name NAME in the buffer.
11827 If not found, stay at current position and return nil."
11828 (let ((case-fold-search t) pos)
11829 (save-excursion
11830 (goto-char (point-min))
11831 (setq pos (and (re-search-forward
11832 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
11833 (match-beginning 0))))
11834 (if pos (goto-char pos))
11835 pos))
11837 (defconst org-dblock-start-re
11838 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
11839 "Matches the start line of a dynamic block, with parameters.")
11841 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
11842 "Matches the end of a dynamic block.")
11844 (defun org-create-dblock (plist)
11845 "Create a dynamic block section, with parameters taken from PLIST.
11846 PLIST must contain a :name entry which is used as name of the block."
11847 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
11848 (end-of-line 1)
11849 (newline))
11850 (let ((col (current-column))
11851 (name (plist-get plist :name)))
11852 (insert "#+BEGIN: " name)
11853 (while plist
11854 (if (eq (car plist) :name)
11855 (setq plist (cddr plist))
11856 (insert " " (prin1-to-string (pop plist)))))
11857 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
11858 (beginning-of-line -2)))
11860 (defun org-prepare-dblock ()
11861 "Prepare dynamic block for refresh.
11862 This empties the block, puts the cursor at the insert position and returns
11863 the property list including an extra property :name with the block name."
11864 (unless (looking-at org-dblock-start-re)
11865 (user-error "Not at a dynamic block"))
11866 (let* ((begdel (1+ (match-end 0)))
11867 (name (org-no-properties (match-string 1)))
11868 (params (append (list :name name)
11869 (read (concat "(" (match-string 3) ")")))))
11870 (save-excursion
11871 (beginning-of-line 1)
11872 (skip-chars-forward " \t")
11873 (setq params (plist-put params :indentation-column (current-column))))
11874 (unless (re-search-forward org-dblock-end-re nil t)
11875 (error "Dynamic block not terminated"))
11876 (setq params
11877 (append params
11878 (list :content (buffer-substring
11879 begdel (match-beginning 0)))))
11880 (delete-region begdel (match-beginning 0))
11881 (goto-char begdel)
11882 (open-line 1)
11883 params))
11885 (defun org-map-dblocks (&optional command)
11886 "Apply COMMAND to all dynamic blocks in the current buffer.
11887 If COMMAND is not given, use `org-update-dblock'."
11888 (let ((cmd (or command 'org-update-dblock)))
11889 (save-excursion
11890 (goto-char (point-min))
11891 (while (re-search-forward org-dblock-start-re nil t)
11892 (goto-char (match-beginning 0))
11893 (save-excursion
11894 (condition-case nil
11895 (funcall cmd)
11896 (error (message "Error during update of dynamic block"))))
11897 (unless (re-search-forward org-dblock-end-re nil t)
11898 (error "Dynamic block not terminated"))))))
11900 (defun org-dblock-update (&optional arg)
11901 "User command for updating dynamic blocks.
11902 Update the dynamic block at point. With prefix ARG, update all dynamic
11903 blocks in the buffer."
11904 (interactive "P")
11905 (if arg
11906 (org-update-all-dblocks)
11907 (or (looking-at org-dblock-start-re)
11908 (org-beginning-of-dblock))
11909 (org-update-dblock)))
11911 (defun org-update-dblock ()
11912 "Update the dynamic block at point.
11913 This means to empty the block, parse for parameters and then call
11914 the correct writing function."
11915 (interactive)
11916 (save-window-excursion
11917 (let* ((pos (point))
11918 (line (org-current-line))
11919 (params (org-prepare-dblock))
11920 (name (plist-get params :name))
11921 (indent (plist-get params :indentation-column))
11922 (cmd (intern (concat "org-dblock-write:" name))))
11923 (message "Updating dynamic block `%s' at line %d..." name line)
11924 (funcall cmd params)
11925 (message "Updating dynamic block `%s' at line %d...done" name line)
11926 (goto-char pos)
11927 (when (and indent (> indent 0))
11928 (setq indent (make-string indent ?\ ))
11929 (save-excursion
11930 (org-beginning-of-dblock)
11931 (forward-line 1)
11932 (while (not (looking-at org-dblock-end-re))
11933 (insert indent)
11934 (beginning-of-line 2))
11935 (when (looking-at org-dblock-end-re)
11936 (and (looking-at "[ \t]+")
11937 (replace-match ""))
11938 (insert indent)))))))
11940 (defun org-beginning-of-dblock ()
11941 "Find the beginning of the dynamic block at point.
11942 Error if there is no such block at point."
11943 (let ((pos (point))
11944 beg)
11945 (end-of-line 1)
11946 (if (and (re-search-backward org-dblock-start-re nil t)
11947 (setq beg (match-beginning 0))
11948 (re-search-forward org-dblock-end-re nil t)
11949 (> (match-end 0) pos))
11950 (goto-char beg)
11951 (goto-char pos)
11952 (error "Not in a dynamic block"))))
11954 (defun org-update-all-dblocks ()
11955 "Update all dynamic blocks in the buffer.
11956 This function can be used in a hook."
11957 (interactive)
11958 (when (derived-mode-p 'org-mode)
11959 (org-map-dblocks 'org-update-dblock)))
11962 ;;;; Completion
11964 (declare-function org-export-backend-name "org-export" (cl-x))
11965 (declare-function org-export-backend-options "org-export" (cl-x))
11966 (defun org-get-export-keywords ()
11967 "Return a list of all currently understood export keywords.
11968 Export keywords include options, block names, attributes and
11969 keywords relative to each registered export back-end."
11970 (let (keywords)
11971 (dolist (backend
11972 (org-bound-and-true-p org-export--registered-backends)
11973 (delq nil keywords))
11974 ;; Back-end name (for keywords, like #+LATEX:)
11975 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
11976 (dolist (option-entry (org-export-backend-options backend))
11977 ;; Back-end options.
11978 (push (nth 1 option-entry) keywords)))))
11980 (defconst org-options-keywords
11981 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11982 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11983 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11984 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11985 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11987 (defcustom org-structure-template-alist
11988 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
11989 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
11990 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
11991 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
11992 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
11993 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
11994 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
11995 "<literal style=\"latex\">\n?\n</literal>")
11996 ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
11997 ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
11998 "<literal style=\"html\">\n?\n</literal>")
11999 ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
12000 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
12001 ("A" "#+ASCII: " "")
12002 ("i" "#+INDEX: ?" "#+INDEX: ?")
12003 ("I" "#+INCLUDE: %file ?"
12004 "<include file=%file markup=\"?\">"))
12005 "Structure completion elements.
12006 This is a list of abbreviation keys and values. The value gets inserted
12007 if you type `<' followed by the key and then press the completion key,
12008 usually `M-TAB'. %file will be replaced by a file name after prompting
12009 for the file using completion. The cursor will be placed at the position
12010 of the `?` in the template.
12011 There are two templates for each key, the first uses the original Org syntax,
12012 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12013 the default when the /org-mtags.el/ module has been loaded. See also the
12014 variable `org-mtags-prefer-muse-templates'."
12015 :group 'org-completion
12016 :type '(repeat
12017 (list
12018 (string :tag "Key")
12019 (string :tag "Template")
12020 (string :tag "Muse Template"))))
12022 (defun org-try-structure-completion ()
12023 "Try to complete a structure template before point.
12024 This looks for strings like \"<e\" on an otherwise empty line and
12025 expands them."
12026 (let ((l (buffer-substring (point-at-bol) (point)))
12028 (when (and (looking-at "[ \t]*$")
12029 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12030 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12031 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12032 (match-beginning 1)) a)
12033 t)))
12035 (defun org-complete-expand-structure-template (start cell)
12036 "Expand a structure template."
12037 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12038 (rpl (nth (if musep 2 1) cell))
12039 (ind ""))
12040 (delete-region start (point))
12041 (when (string-match "\\`#\\+" rpl)
12042 (cond
12043 ((bolp))
12044 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12045 (setq ind (buffer-substring (point-at-bol) (point))))
12046 (t (newline))))
12047 (setq start (point))
12048 (if (string-match "%file" rpl)
12049 (setq rpl (replace-match
12050 (concat
12051 "\""
12052 (save-match-data
12053 (abbreviate-file-name (read-file-name "Include file: ")))
12054 "\"")
12055 t t rpl)))
12056 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12057 (concat "\n" ind)))
12058 (insert rpl)
12059 (if (re-search-backward "\\?" start t) (delete-char 1))))
12061 ;;;; TODO, DEADLINE, Comments
12063 (defun org-toggle-comment ()
12064 "Change the COMMENT state of an entry."
12065 (interactive)
12066 (save-excursion
12067 (org-back-to-heading)
12068 (let (case-fold-search)
12069 (cond
12070 ((looking-at (format org-heading-keyword-regexp-format
12071 org-comment-string))
12072 (goto-char (match-end 1))
12073 (looking-at (concat " +" org-comment-string))
12074 (replace-match "" t t)
12075 (when (eolp) (insert " ")))
12076 ((looking-at org-outline-regexp)
12077 (goto-char (match-end 0))
12078 (insert org-comment-string " "))))))
12080 (defvar org-last-todo-state-is-todo nil
12081 "This is non-nil when the last TODO state change led to a TODO state.
12082 If the last change removed the TODO tag or switched to DONE, then
12083 this is nil.")
12085 (defvar org-setting-tags nil) ; dynamically skipped
12087 (defvar org-todo-setup-filter-hook nil
12088 "Hook for functions that pre-filter todo specs.
12089 Each function takes a todo spec and returns either nil or the spec
12090 transformed into canonical form." )
12092 (defvar org-todo-get-default-hook nil
12093 "Hook for functions that get a default item for todo.
12094 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12095 nil or a string to be used for the todo mark." )
12097 (defvar org-agenda-headline-snapshot-before-repeat)
12099 (defun org-current-effective-time ()
12100 "Return current time adjusted for `org-extend-today-until' variable."
12101 (let* ((ct (org-current-time))
12102 (dct (decode-time ct))
12103 (ct1
12104 (cond
12105 (org-use-last-clock-out-time-as-effective-time
12106 (or (org-clock-get-last-clock-out-time) ct))
12107 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12108 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12109 (t ct))))
12110 ct1))
12112 (defun org-todo-yesterday (&optional arg)
12113 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12114 (interactive "P")
12115 (if (eq major-mode 'org-agenda-mode)
12116 (apply 'org-agenda-todo-yesterday arg)
12117 (let* ((hour (third (decode-time
12118 (org-current-time))))
12119 (org-extend-today-until (1+ hour)))
12120 (org-todo arg))))
12122 (defvar org-block-entry-blocking ""
12123 "First entry preventing the TODO state change.")
12125 (defun org-todo (&optional arg)
12126 "Change the TODO state of an item.
12127 The state of an item is given by a keyword at the start of the heading,
12128 like
12129 *** TODO Write paper
12130 *** DONE Call mom
12132 The different keywords are specified in the variable `org-todo-keywords'.
12133 By default the available states are \"TODO\" and \"DONE\".
12134 So for this example: when the item starts with TODO, it is changed to DONE.
12135 When it starts with DONE, the DONE is removed. And when neither TODO nor
12136 DONE are present, add TODO at the beginning of the heading.
12138 With \\[universal-argument] prefix arg, use completion to determine the new \
12139 state.
12140 With numeric prefix arg, switch to that state.
12141 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12142 keywords (nextset).
12143 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12144 With a numeric prefix arg of 0, inhibit note taking for the change.
12146 For calling through lisp, arg is also interpreted in the following way:
12147 'none -> empty state
12148 \"\"(empty string) -> switch to empty state
12149 'done -> switch to DONE
12150 'nextset -> switch to the next set of keywords
12151 'previousset -> switch to the previous set of keywords
12152 \"WAITING\" -> switch to the specified keyword, but only if it
12153 really is a member of `org-todo-keywords'."
12154 (interactive "P")
12155 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12156 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12157 'region-start-level 'region))
12158 org-loop-over-headlines-in-active-region)
12159 (org-map-entries
12160 `(org-todo ,arg)
12161 org-loop-over-headlines-in-active-region
12162 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12163 (if (equal arg '(16)) (setq arg 'nextset))
12164 (let ((org-blocker-hook org-blocker-hook)
12165 commentp
12166 case-fold-search)
12167 (when (equal arg '(64))
12168 (setq arg nil org-blocker-hook nil))
12169 (when (and org-blocker-hook
12170 (or org-inhibit-blocking
12171 (org-entry-get nil "NOBLOCKING")))
12172 (setq org-blocker-hook nil))
12173 (save-excursion
12174 (catch 'exit
12175 (org-back-to-heading t)
12176 (when (looking-at (concat "^\\*+ " org-comment-string))
12177 (org-toggle-comment)
12178 (setq commentp t))
12179 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12180 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12181 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12182 (let* ((match-data (match-data))
12183 (startpos (point-at-bol))
12184 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12185 (org-log-done org-log-done)
12186 (org-log-repeat org-log-repeat)
12187 (org-todo-log-states org-todo-log-states)
12188 (org-inhibit-logging
12189 (if (equal arg 0)
12190 (progn (setq arg nil) 'note) org-inhibit-logging))
12191 (this (match-string 1))
12192 (hl-pos (match-beginning 0))
12193 (head (org-get-todo-sequence-head this))
12194 (ass (assoc head org-todo-kwd-alist))
12195 (interpret (nth 1 ass))
12196 (done-word (nth 3 ass))
12197 (final-done-word (nth 4 ass))
12198 (org-last-state (or this ""))
12199 (completion-ignore-case t)
12200 (member (member this org-todo-keywords-1))
12201 (tail (cdr member))
12202 (org-state (cond
12203 ((and org-todo-key-trigger
12204 (or (and (equal arg '(4))
12205 (eq org-use-fast-todo-selection 'prefix))
12206 (and (not arg) org-use-fast-todo-selection
12207 (not (eq org-use-fast-todo-selection
12208 'prefix)))))
12209 ;; Use fast selection
12210 (org-fast-todo-selection))
12211 ((and (equal arg '(4))
12212 (or (not org-use-fast-todo-selection)
12213 (not org-todo-key-trigger)))
12214 ;; Read a state with completion
12215 (org-icompleting-read
12216 "State: " (mapcar 'list org-todo-keywords-1)
12217 nil t))
12218 ((eq arg 'right)
12219 (if this
12220 (if tail (car tail) nil)
12221 (car org-todo-keywords-1)))
12222 ((eq arg 'left)
12223 (if (equal member org-todo-keywords-1)
12225 (if this
12226 (nth (- (length org-todo-keywords-1)
12227 (length tail) 2)
12228 org-todo-keywords-1)
12229 (org-last org-todo-keywords-1))))
12230 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12231 (setq arg nil))) ; hack to fall back to cycling
12232 (arg
12233 ;; user or caller requests a specific state
12234 (cond
12235 ((equal arg "") nil)
12236 ((eq arg 'none) nil)
12237 ((eq arg 'done) (or done-word (car org-done-keywords)))
12238 ((eq arg 'nextset)
12239 (or (car (cdr (member head org-todo-heads)))
12240 (car org-todo-heads)))
12241 ((eq arg 'previousset)
12242 (let ((org-todo-heads (reverse org-todo-heads)))
12243 (or (car (cdr (member head org-todo-heads)))
12244 (car org-todo-heads))))
12245 ((car (member arg org-todo-keywords-1)))
12246 ((stringp arg)
12247 (user-error "State `%s' not valid in this file" arg))
12248 ((nth (1- (prefix-numeric-value arg))
12249 org-todo-keywords-1))))
12250 ((null member) (or head (car org-todo-keywords-1)))
12251 ((equal this final-done-word) nil) ;; -> make empty
12252 ((null tail) nil) ;; -> first entry
12253 ((memq interpret '(type priority))
12254 (if (eq this-command last-command)
12255 (car tail)
12256 (if (> (length tail) 0)
12257 (or done-word (car org-done-keywords))
12258 nil)))
12260 (car tail))))
12261 (org-state (or
12262 (run-hook-with-args-until-success
12263 'org-todo-get-default-hook org-state org-last-state)
12264 org-state))
12265 (next (if org-state (concat " " org-state " ") " "))
12266 (change-plist (list :type 'todo-state-change :from this :to org-state
12267 :position startpos))
12268 dolog now-done-p)
12269 (when org-blocker-hook
12270 (setq org-last-todo-state-is-todo
12271 (not (member this org-done-keywords)))
12272 (unless (save-excursion
12273 (save-match-data
12274 (org-with-wide-buffer
12275 (run-hook-with-args-until-failure
12276 'org-blocker-hook change-plist))))
12277 (if (org-called-interactively-p 'interactive)
12278 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12279 this org-state org-block-entry-blocking)
12280 ;; fail silently
12281 (message "TODO state change from %s to %s blocked (by \"%s\")"
12282 this org-state org-block-entry-blocking)
12283 (throw 'exit nil))))
12284 (store-match-data match-data)
12285 (replace-match next t t)
12286 (unless (pos-visible-in-window-p hl-pos)
12287 (message "TODO state changed to %s" (org-trim next)))
12288 (unless head
12289 (setq head (org-get-todo-sequence-head org-state)
12290 ass (assoc head org-todo-kwd-alist)
12291 interpret (nth 1 ass)
12292 done-word (nth 3 ass)
12293 final-done-word (nth 4 ass)))
12294 (when (memq arg '(nextset previousset))
12295 (message "Keyword-Set %d/%d: %s"
12296 (- (length org-todo-sets) -1
12297 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12298 (length org-todo-sets)
12299 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12300 (setq org-last-todo-state-is-todo
12301 (not (member org-state org-done-keywords)))
12302 (setq now-done-p (and (member org-state org-done-keywords)
12303 (not (member this org-done-keywords))))
12304 (and logging (org-local-logging logging))
12305 (when (and (or org-todo-log-states org-log-done)
12306 (not (eq org-inhibit-logging t))
12307 (not (memq arg '(nextset previousset))))
12308 ;; we need to look at recording a time and note
12309 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12310 (nth 2 (assoc this org-todo-log-states))))
12311 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12312 (setq dolog 'time))
12313 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12314 (and org-state
12315 (member org-state org-not-done-keywords)
12316 (not (member this org-not-done-keywords))))
12317 ;; This is now a todo state and was not one before
12318 ;; If there was a CLOSED time stamp, get rid of it.
12319 (org-add-planning-info nil nil 'closed))
12320 (when (and now-done-p org-log-done)
12321 ;; It is now done, and it was not done before
12322 (org-add-planning-info 'closed (org-current-effective-time))
12323 (if (and (not dolog) (eq 'note org-log-done))
12324 (org-add-log-setup 'done org-state this 'findpos 'note)))
12325 (when (and org-state dolog)
12326 ;; This is a non-nil state, and we need to log it
12327 (org-add-log-setup 'state org-state this 'findpos dolog)))
12328 ;; Fixup tag positioning
12329 (org-todo-trigger-tag-changes org-state)
12330 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12331 (when org-provide-todo-statistics
12332 (org-update-parent-todo-statistics))
12333 (run-hooks 'org-after-todo-state-change-hook)
12334 (if (and arg (not (member org-state org-done-keywords)))
12335 (setq head (org-get-todo-sequence-head org-state)))
12336 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12337 ;; Do we need to trigger a repeat?
12338 (when now-done-p
12339 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12340 ;; This is for the agenda, take a snapshot of the headline.
12341 (save-match-data
12342 (setq org-agenda-headline-snapshot-before-repeat
12343 (org-get-heading))))
12344 (org-auto-repeat-maybe org-state))
12345 ;; Fixup cursor location if close to the keyword
12346 (if (and (outline-on-heading-p)
12347 (not (bolp))
12348 (save-excursion (beginning-of-line 1)
12349 (looking-at org-todo-line-regexp))
12350 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12351 (progn
12352 (goto-char (or (match-end 2) (match-end 1)))
12353 (and (looking-at " ") (just-one-space))))
12354 (when org-trigger-hook
12355 (save-excursion
12356 (run-hook-with-args 'org-trigger-hook change-plist)))
12357 (when commentp (org-toggle-comment))))))))
12359 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12360 "Block turning an entry into a TODO, using the hierarchy.
12361 This checks whether the current task should be blocked from state
12362 changes. Such blocking occurs when:
12364 1. The task has children which are not all in a completed state.
12366 2. A task has a parent with the property :ORDERED:, and there
12367 are siblings prior to the current task with incomplete
12368 status.
12370 3. The parent of the task is blocked because it has siblings that should
12371 be done first, or is child of a block grandparent TODO entry."
12373 (if (not org-enforce-todo-dependencies)
12374 t ; if locally turned off don't block
12375 (catch 'dont-block
12376 ;; If this is not a todo state change, or if this entry is already DONE,
12377 ;; do not block
12378 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12379 (member (plist-get change-plist :from)
12380 (cons 'done org-done-keywords))
12381 (member (plist-get change-plist :to)
12382 (cons 'todo org-not-done-keywords))
12383 (not (plist-get change-plist :to)))
12384 (throw 'dont-block t))
12385 ;; If this task has children, and any are undone, it's blocked
12386 (save-excursion
12387 (org-back-to-heading t)
12388 (let ((this-level (funcall outline-level)))
12389 (outline-next-heading)
12390 (let ((child-level (funcall outline-level)))
12391 (while (and (not (eobp))
12392 (> child-level this-level))
12393 ;; this todo has children, check whether they are all
12394 ;; completed
12395 (if (and (not (org-entry-is-done-p))
12396 (org-entry-is-todo-p))
12397 (progn (setq org-block-entry-blocking (org-get-heading))
12398 (throw 'dont-block nil)))
12399 (outline-next-heading)
12400 (setq child-level (funcall outline-level))))))
12401 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12402 ;; any previous siblings are undone, it's blocked
12403 (save-excursion
12404 (org-back-to-heading t)
12405 (let* ((pos (point))
12406 (parent-pos (and (org-up-heading-safe) (point))))
12407 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12408 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12409 (forward-line 1)
12410 (re-search-forward org-not-done-heading-regexp pos t))
12411 (setq org-block-entry-blocking (match-string 0))
12412 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12413 ;; Search further up the hierarchy, to see if an ancestor is blocked
12414 (while t
12415 (goto-char parent-pos)
12416 (if (not (looking-at org-not-done-heading-regexp))
12417 (throw 'dont-block t)) ; do not block, parent is not a TODO
12418 (setq pos (point))
12419 (setq parent-pos (and (org-up-heading-safe) (point)))
12420 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12421 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12422 (forward-line 1)
12423 (re-search-forward org-not-done-heading-regexp pos t)
12424 (setq org-block-entry-blocking (org-get-heading)))
12425 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12427 (defcustom org-track-ordered-property-with-tag nil
12428 "Should the ORDERED property also be shown as a tag?
12429 The ORDERED property decides if an entry should require subtasks to be
12430 completed in sequence. Since a property is not very visible, setting
12431 this option means that toggling the ORDERED property with the command
12432 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12433 not relevant for the behavior, but it makes things more visible.
12435 Note that toggling the tag with tags commands will not change the property
12436 and therefore not influence behavior!
12438 This can be t, meaning the tag ORDERED should be used, It can also be a
12439 string to select a different tag for this task."
12440 :group 'org-todo
12441 :type '(choice
12442 (const :tag "No tracking" nil)
12443 (const :tag "Track with ORDERED tag" t)
12444 (string :tag "Use other tag")))
12446 (defun org-toggle-ordered-property ()
12447 "Toggle the ORDERED property of the current entry.
12448 For better visibility, you can track the value of this property with a tag.
12449 See variable `org-track-ordered-property-with-tag'."
12450 (interactive)
12451 (let* ((t1 org-track-ordered-property-with-tag)
12452 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12453 (save-excursion
12454 (org-back-to-heading)
12455 (if (org-entry-get nil "ORDERED")
12456 (progn
12457 (org-delete-property "ORDERED" "PROPERTIES")
12458 (and tag (org-toggle-tag tag 'off))
12459 (message "Subtasks can be completed in arbitrary order"))
12460 (org-entry-put nil "ORDERED" "t")
12461 (and tag (org-toggle-tag tag 'on))
12462 (message "Subtasks must be completed in sequence")))))
12464 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12465 (defun org-block-todo-from-checkboxes (change-plist)
12466 "Block turning an entry into a TODO, using checkboxes.
12467 This checks whether the current task should be blocked from state
12468 changes because there are unchecked boxes in this entry."
12469 (if (not org-enforce-todo-checkbox-dependencies)
12470 t ; if locally turned off don't block
12471 (catch 'dont-block
12472 ;; If this is not a todo state change, or if this entry is already DONE,
12473 ;; do not block
12474 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12475 (member (plist-get change-plist :from)
12476 (cons 'done org-done-keywords))
12477 (member (plist-get change-plist :to)
12478 (cons 'todo org-not-done-keywords))
12479 (not (plist-get change-plist :to)))
12480 (throw 'dont-block t))
12481 ;; If this task has checkboxes that are not checked, it's blocked
12482 (save-excursion
12483 (org-back-to-heading t)
12484 (let ((beg (point)) end)
12485 (outline-next-heading)
12486 (setq end (point))
12487 (goto-char beg)
12488 (if (org-list-search-forward
12489 (concat (org-item-beginning-re)
12490 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12491 "\\[[- ]\\]")
12492 end t)
12493 (progn
12494 (if (boundp 'org-blocked-by-checkboxes)
12495 (setq org-blocked-by-checkboxes t))
12496 (throw 'dont-block nil)))))
12497 t))) ; do not block
12499 (defun org-entry-blocked-p ()
12500 "Is the current entry blocked?"
12501 (org-with-silent-modifications
12502 (if (org-entry-get nil "NOBLOCKING")
12503 nil ;; Never block this entry
12504 (not (run-hook-with-args-until-failure
12505 'org-blocker-hook
12506 (list :type 'todo-state-change
12507 :position (point)
12508 :from 'todo
12509 :to 'done))))))
12511 (defun org-update-statistics-cookies (all)
12512 "Update the statistics cookie, either from TODO or from checkboxes.
12513 This should be called with the cursor in a line with a statistics cookie."
12514 (interactive "P")
12515 (if all
12516 (progn
12517 (org-update-checkbox-count 'all)
12518 (org-map-entries 'org-update-parent-todo-statistics))
12519 (if (not (org-at-heading-p))
12520 (org-update-checkbox-count)
12521 (let ((pos (point-marker))
12522 end l1 l2)
12523 (ignore-errors (org-back-to-heading t))
12524 (if (not (org-at-heading-p))
12525 (org-update-checkbox-count)
12526 (setq l1 (org-outline-level))
12527 (setq end (save-excursion
12528 (outline-next-heading)
12529 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12530 (point)))
12531 (if (and (save-excursion
12532 (re-search-forward
12533 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12534 (not (save-excursion (re-search-forward
12535 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12536 (org-update-checkbox-count)
12537 (if (and l2 (> l2 l1))
12538 (progn
12539 (goto-char end)
12540 (org-update-parent-todo-statistics))
12541 (goto-char pos)
12542 (beginning-of-line 1)
12543 (while (re-search-forward
12544 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12545 (point-at-eol) t)
12546 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12547 (goto-char pos)
12548 (move-marker pos nil)))))
12550 (defvar org-entry-property-inherited-from) ;; defined below
12551 (defun org-update-parent-todo-statistics ()
12552 "Update any statistics cookie in the parent of the current headline.
12553 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12554 the entire subtree and this will travel up the hierarchy and update
12555 statistics everywhere."
12556 (let* ((prop (save-excursion (org-up-heading-safe)
12557 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12558 (recursive (or (not org-hierarchical-todo-statistics)
12559 (and prop (string-match "\\<recursive\\>" prop))))
12560 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12562 (first t)
12563 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12564 level ltoggle l1 new ndel
12565 (cnt-all 0) (cnt-done 0) is-percent kwd
12566 checkbox-beg ov ovs ove cookie-present)
12567 (catch 'exit
12568 (save-excursion
12569 (beginning-of-line 1)
12570 (setq ltoggle (funcall outline-level))
12571 ;; Three situations are to consider:
12573 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12574 ;; to the top-level ancestor on the headline;
12576 ;; 2. If parent has "recursive" property, repeat up to the
12577 ;; headline setting that property, taking inheritance into
12578 ;; account;
12580 ;; 3. Else, move up to direct parent and proceed only once.
12581 (while (and (setq level (org-up-heading-safe))
12582 (or recursive first)
12583 (>= (point) lim))
12584 (setq first nil cookie-present nil)
12585 (unless (and level
12586 (not (string-match
12587 "\\<checkbox\\>"
12588 (downcase (or (org-entry-get nil "COOKIE_DATA")
12589 "")))))
12590 (throw 'exit nil))
12591 (while (re-search-forward box-re (point-at-eol) t)
12592 (setq cnt-all 0 cnt-done 0 cookie-present t)
12593 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12594 (save-match-data
12595 (unless (outline-next-heading) (throw 'exit nil))
12596 (while (and (looking-at org-complex-heading-regexp)
12597 (> (setq l1 (length (match-string 1))) level))
12598 (setq kwd (and (or recursive (= l1 ltoggle))
12599 (match-string 2)))
12600 (if (or (eq org-provide-todo-statistics 'all-headlines)
12601 (and (listp org-provide-todo-statistics)
12602 (or (member kwd org-provide-todo-statistics)
12603 (member kwd org-done-keywords))))
12604 (setq cnt-all (1+ cnt-all))
12605 (if (eq org-provide-todo-statistics t)
12606 (and kwd (setq cnt-all (1+ cnt-all)))))
12607 (and (member kwd org-done-keywords)
12608 (setq cnt-done (1+ cnt-done)))
12609 (outline-next-heading)))
12610 (setq new
12611 (if is-percent
12612 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12613 (format "[%d/%d]" cnt-done cnt-all))
12614 ndel (- (match-end 0) checkbox-beg))
12615 ;; handle overlays when updating cookie from column view
12616 (when (setq ov (car (overlays-at checkbox-beg)))
12617 (setq ovs (overlay-start ov) ove (overlay-end ov))
12618 (delete-overlay ov))
12619 (goto-char checkbox-beg)
12620 (insert new)
12621 (delete-region (point) (+ (point) ndel))
12622 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12623 (when ov (move-overlay ov ovs ove)))
12624 (when cookie-present
12625 (run-hook-with-args 'org-after-todo-statistics-hook
12626 cnt-done (- cnt-all cnt-done))))))
12627 (run-hooks 'org-todo-statistics-hook)))
12629 (defvar org-after-todo-statistics-hook nil
12630 "Hook that is called after a TODO statistics cookie has been updated.
12631 Each function is called with two arguments: the number of not-done entries
12632 and the number of done entries.
12634 For example, the following function, when added to this hook, will switch
12635 an entry to DONE when all children are done, and back to TODO when new
12636 entries are set to a TODO status. Note that this hook is only called
12637 when there is a statistics cookie in the headline!
12639 (defun org-summary-todo (n-done n-not-done)
12640 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12641 (let (org-log-done org-log-states) ; turn off logging
12642 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12645 (defvar org-todo-statistics-hook nil
12646 "Hook that is run whenever Org thinks TODO statistics should be updated.
12647 This hook runs even if there is no statistics cookie present, in which case
12648 `org-after-todo-statistics-hook' would not run.")
12650 (defun org-todo-trigger-tag-changes (state)
12651 "Apply the changes defined in `org-todo-state-tags-triggers'."
12652 (let ((l org-todo-state-tags-triggers)
12653 changes)
12654 (when (or (not state) (equal state ""))
12655 (setq changes (append changes (cdr (assoc "" l)))))
12656 (when (and (stringp state) (> (length state) 0))
12657 (setq changes (append changes (cdr (assoc state l)))))
12658 (when (member state org-not-done-keywords)
12659 (setq changes (append changes (cdr (assoc 'todo l)))))
12660 (when (member state org-done-keywords)
12661 (setq changes (append changes (cdr (assoc 'done l)))))
12662 (dolist (c changes)
12663 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12665 (defun org-local-logging (value)
12666 "Get logging settings from a property VALUE."
12667 (let* (words w a)
12668 ;; directly set the variables, they are already local.
12669 (setq org-log-done nil
12670 org-log-repeat nil
12671 org-todo-log-states nil)
12672 (setq words (org-split-string value))
12673 (while (setq w (pop words))
12674 (cond
12675 ((setq a (assoc w org-startup-options))
12676 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12677 (set (nth 1 a) (nth 2 a))))
12678 ((setq a (org-extract-log-state-settings w))
12679 (and (member (car a) org-todo-keywords-1)
12680 (push a org-todo-log-states)))))))
12682 (defun org-get-todo-sequence-head (kwd)
12683 "Return the head of the TODO sequence to which KWD belongs.
12684 If KWD is not set, check if there is a text property remembering the
12685 right sequence."
12686 (let (p)
12687 (cond
12688 ((not kwd)
12689 (or (get-text-property (point-at-bol) 'org-todo-head)
12690 (progn
12691 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12692 nil (point-at-eol)))
12693 (get-text-property p 'org-todo-head))))
12694 ((not (member kwd org-todo-keywords-1))
12695 (car org-todo-keywords-1))
12696 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12698 (defun org-fast-todo-selection ()
12699 "Fast TODO keyword selection with single keys.
12700 Returns the new TODO keyword, or nil if no state change should occur."
12701 (let* ((fulltable org-todo-key-alist)
12702 (done-keywords org-done-keywords) ;; needed for the faces.
12703 (maxlen (apply 'max (mapcar
12704 (lambda (x)
12705 (if (stringp (car x)) (string-width (car x)) 0))
12706 fulltable)))
12707 (expert nil)
12708 (fwidth (+ maxlen 3 1 3))
12709 (ncol (/ (- (window-width) 4) fwidth))
12710 tg cnt e c tbl
12711 groups ingroup)
12712 (save-excursion
12713 (save-window-excursion
12714 (if expert
12715 (set-buffer (get-buffer-create " *Org todo*"))
12716 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12717 (erase-buffer)
12718 (org-set-local 'org-done-keywords done-keywords)
12719 (setq tbl fulltable cnt 0)
12720 (while (setq e (pop tbl))
12721 (cond
12722 ((equal e '(:startgroup))
12723 (push '() groups) (setq ingroup t)
12724 (when (not (= cnt 0))
12725 (setq cnt 0)
12726 (insert "\n"))
12727 (insert "{ "))
12728 ((equal e '(:endgroup))
12729 (setq ingroup nil cnt 0)
12730 (insert "}\n"))
12731 ((equal e '(:newline))
12732 (when (not (= cnt 0))
12733 (setq cnt 0)
12734 (insert "\n")
12735 (setq e (car tbl))
12736 (while (equal (car tbl) '(:newline))
12737 (insert "\n")
12738 (setq tbl (cdr tbl)))))
12740 (setq tg (car e) c (cdr e))
12741 (if ingroup (push tg (car groups)))
12742 (setq tg (org-add-props tg nil 'face
12743 (org-get-todo-face tg)))
12744 (if (and (= cnt 0) (not ingroup)) (insert " "))
12745 (insert "[" c "] " tg (make-string
12746 (- fwidth 4 (length tg)) ?\ ))
12747 (when (= (setq cnt (1+ cnt)) ncol)
12748 (insert "\n")
12749 (if ingroup (insert " "))
12750 (setq cnt 0)))))
12751 (insert "\n")
12752 (goto-char (point-min))
12753 (if (not expert) (org-fit-window-to-buffer))
12754 (message "[a-z..]:Set [SPC]:clear")
12755 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12756 (cond
12757 ((or (= c ?\C-g)
12758 (and (= c ?q) (not (rassoc c fulltable))))
12759 (setq quit-flag t))
12760 ((= c ?\ ) nil)
12761 ((setq e (rassoc c fulltable) tg (car e))
12763 (t (setq quit-flag t)))))))
12765 (defun org-entry-is-todo-p ()
12766 (member (org-get-todo-state) org-not-done-keywords))
12768 (defun org-entry-is-done-p ()
12769 (member (org-get-todo-state) org-done-keywords))
12771 (defun org-get-todo-state ()
12772 "Return the TODO keyword of the current subtree."
12773 (save-excursion
12774 (org-back-to-heading t)
12775 (and (looking-at org-todo-line-regexp)
12776 (match-end 2)
12777 (match-string 2))))
12779 (defun org-at-date-range-p (&optional inactive-ok)
12780 "Is the cursor inside a date range?"
12781 (interactive)
12782 (save-excursion
12783 (catch 'exit
12784 (let ((pos (point)))
12785 (skip-chars-backward "^[<\r\n")
12786 (skip-chars-backward "<[")
12787 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12788 (>= (match-end 0) pos)
12789 (throw 'exit t))
12790 (skip-chars-backward "^<[\r\n")
12791 (skip-chars-backward "<[")
12792 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12793 (>= (match-end 0) pos)
12794 (throw 'exit t)))
12795 nil)))
12797 (defun org-get-repeat (&optional tagline)
12798 "Check if there is a deadline/schedule with repeater in this entry."
12799 (save-match-data
12800 (save-excursion
12801 (org-back-to-heading t)
12802 (and (re-search-forward (if tagline
12803 (concat tagline "\\s-*" org-repeat-re)
12804 org-repeat-re)
12805 (org-entry-end-position) t)
12806 (match-string-no-properties 1)))))
12808 (defvar org-last-changed-timestamp)
12809 (defvar org-last-inserted-timestamp)
12810 (defvar org-log-post-message)
12811 (defvar org-log-note-purpose)
12812 (defvar org-log-note-how)
12813 (defvar org-log-note-extra)
12814 (defun org-auto-repeat-maybe (done-word)
12815 "Check if the current headline contains a repeated deadline/schedule.
12816 If yes, set TODO state back to what it was and change the base date
12817 of repeating deadline/scheduled time stamps to new date.
12818 This function is run automatically after each state change to a DONE state."
12819 ;; last-state is dynamically scoped into this function
12820 (let* ((repeat (org-get-repeat))
12821 (aa (assoc org-last-state org-todo-kwd-alist))
12822 (interpret (nth 1 aa))
12823 (head (nth 2 aa))
12824 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12825 (msg "Entry repeats: ")
12826 (org-log-done nil)
12827 (org-todo-log-states nil)
12828 re type n what ts time to-state)
12829 (when repeat
12830 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12831 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12832 org-todo-repeat-to-state))
12833 (unless (and to-state (member to-state org-todo-keywords-1))
12834 (setq to-state (if (eq interpret 'type) org-last-state head)))
12835 (org-todo to-state)
12836 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12837 (org-entry-put nil "LAST_REPEAT" (format-time-string
12838 (org-time-stamp-format t t))))
12839 (when org-log-repeat
12840 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12841 (memq 'org-add-log-note post-command-hook))
12842 ;; OK, we are already setup for some record
12843 (if (eq org-log-repeat 'note)
12844 ;; make sure we take a note, not only a time stamp
12845 (setq org-log-note-how 'note))
12846 ;; Set up for taking a record
12847 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12848 org-last-state
12849 'findpos org-log-repeat)))
12850 (org-back-to-heading t)
12851 (org-add-planning-info nil nil 'closed)
12852 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12853 org-deadline-time-regexp "\\)\\|\\("
12854 org-ts-regexp "\\)"))
12855 (while (re-search-forward
12856 re (save-excursion (outline-next-heading) (point)) t)
12857 (setq type (if (match-end 1) org-scheduled-string
12858 (if (match-end 3) org-deadline-string "Plain:"))
12859 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12860 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
12861 (setq n (string-to-number (match-string 2 ts))
12862 what (match-string 3 ts))
12863 (if (equal what "w") (setq n (* n 7) what "d"))
12864 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
12865 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12866 ;; Preparation, see if we need to modify the start date for the change
12867 (when (match-end 1)
12868 (setq time (save-match-data (org-time-string-to-time ts)))
12869 (cond
12870 ((equal (match-string 1 ts) ".")
12871 ;; Shift starting date to today
12872 (org-timestamp-change
12873 (- (org-today) (time-to-days time))
12874 'day))
12875 ((equal (match-string 1 ts) "+")
12876 (let ((nshiftmax 10) (nshift 0))
12877 (while (or (= nshift 0)
12878 (<= (time-to-days time)
12879 (time-to-days (current-time))))
12880 (when (= (incf nshift) nshiftmax)
12881 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12882 (error "Abort")))
12883 (org-timestamp-change n (cdr (assoc what whata)))
12884 (org-at-timestamp-p t)
12885 (setq ts (match-string 1))
12886 (setq time (save-match-data (org-time-string-to-time ts)))))
12887 (org-timestamp-change (- n) (cdr (assoc what whata)))
12888 ;; rematch, so that we have everything in place for the real shift
12889 (org-at-timestamp-p t)
12890 (setq ts (match-string 1))
12891 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
12892 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12893 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12894 (setq org-log-post-message msg)
12895 (message "%s" msg))))
12897 (defun org-show-todo-tree (arg)
12898 "Make a compact tree which shows all headlines marked with TODO.
12899 The tree will show the lines where the regexp matches, and all higher
12900 headlines above the match.
12901 With a \\[universal-argument] prefix, prompt for a regexp to match.
12902 With a numeric prefix N, construct a sparse tree for the Nth element
12903 of `org-todo-keywords-1'."
12904 (interactive "P")
12905 (let ((case-fold-search nil)
12906 (kwd-re
12907 (cond ((null arg) org-not-done-regexp)
12908 ((equal arg '(4))
12909 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12910 (mapcar 'list org-todo-keywords-1))))
12911 (concat "\\("
12912 (mapconcat 'identity (org-split-string kwd "|") "\\|")
12913 "\\)\\>")))
12914 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12915 (regexp-quote (nth (1- (prefix-numeric-value arg))
12916 org-todo-keywords-1)))
12917 (t (user-error "Invalid prefix argument: %s" arg)))))
12918 (message "%d TODO entries found"
12919 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12921 (defun org-deadline (arg &optional time)
12922 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
12923 With one universal prefix argument, remove any deadline from the item.
12924 With two universal prefix arguments, prompt for a warning delay.
12925 With argument TIME, set the deadline at the corresponding date. TIME
12926 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
12927 (interactive "P")
12928 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12929 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12930 'region-start-level 'region))
12931 org-loop-over-headlines-in-active-region)
12932 (org-map-entries
12933 `(org-deadline ',arg ,time)
12934 org-loop-over-headlines-in-active-region
12935 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12936 (let* ((old-date (org-entry-get nil "DEADLINE"))
12937 (old-date-time (if old-date (org-time-string-to-time old-date)))
12938 (repeater (and old-date
12939 (string-match
12940 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
12941 old-date)
12942 (match-string 1 old-date))))
12943 (cond
12944 ((equal arg '(4))
12945 (when (and old-date org-log-redeadline)
12946 (org-add-log-setup 'deldeadline nil old-date 'findpos
12947 org-log-redeadline))
12948 (org-remove-timestamp-with-keyword org-deadline-string)
12949 (message "Item no longer has a deadline."))
12950 ((equal arg '(16))
12951 (save-excursion
12952 (org-back-to-heading t)
12953 (if (re-search-forward
12954 org-deadline-time-regexp
12955 (save-excursion (outline-next-heading) (point)) t)
12956 (let* ((rpl0 (match-string 1))
12957 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12958 (replace-match
12959 (concat org-deadline-string
12960 " <" rpl
12961 (format " -%dd"
12962 (abs
12963 (- (time-to-days
12964 (save-match-data
12965 (org-read-date nil t nil "Warn starting from" old-date-time)))
12966 (time-to-days old-date-time))))
12967 ">") t t))
12968 (user-error "No deadline information to update"))))
12970 (org-add-planning-info 'deadline time 'closed)
12971 (when (and old-date org-log-redeadline
12972 (not (equal old-date
12973 (substring org-last-inserted-timestamp 1 -1))))
12974 (org-add-log-setup 'redeadline nil old-date 'findpos
12975 org-log-redeadline))
12976 (when repeater
12977 (save-excursion
12978 (org-back-to-heading t)
12979 (when (re-search-forward (concat org-deadline-string " "
12980 org-last-inserted-timestamp)
12981 (save-excursion
12982 (outline-next-heading) (point)) t)
12983 (goto-char (1- (match-end 0)))
12984 (insert " " repeater)
12985 (setq org-last-inserted-timestamp
12986 (concat (substring org-last-inserted-timestamp 0 -1)
12987 " " repeater
12988 (substring org-last-inserted-timestamp -1))))))
12989 (message "Deadline on %s" org-last-inserted-timestamp))))))
12991 (defun org-schedule (arg &optional time)
12992 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12993 With one universal prefix argument, remove any scheduling date from the item.
12994 With two universal prefix arguments, prompt for a delay cookie.
12995 With argument TIME, scheduled at the corresponding date. TIME can
12996 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
12997 (interactive "P")
12998 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12999 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13000 'region-start-level 'region))
13001 org-loop-over-headlines-in-active-region)
13002 (org-map-entries
13003 `(org-schedule ',arg ,time)
13004 org-loop-over-headlines-in-active-region
13005 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13006 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13007 (old-date-time (if old-date (org-time-string-to-time old-date)))
13008 (repeater (and old-date
13009 (string-match
13010 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13011 old-date)
13012 (match-string 1 old-date))))
13013 (cond
13014 ((equal arg '(4))
13015 (progn
13016 (when (and old-date org-log-reschedule)
13017 (org-add-log-setup 'delschedule nil old-date 'findpos
13018 org-log-reschedule))
13019 (org-remove-timestamp-with-keyword org-scheduled-string)
13020 (message "Item is no longer scheduled.")))
13021 ((equal arg '(16))
13022 (save-excursion
13023 (org-back-to-heading t)
13024 (if (re-search-forward
13025 org-scheduled-time-regexp
13026 (save-excursion (outline-next-heading) (point)) t)
13027 (let* ((rpl0 (match-string 1))
13028 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13029 (replace-match
13030 (concat org-scheduled-string
13031 " <" rpl
13032 (format " -%dd"
13033 (abs
13034 (- (time-to-days
13035 (save-match-data
13036 (org-read-date nil t nil "Delay until" old-date-time)))
13037 (time-to-days old-date-time))))
13038 ">") t t))
13039 (user-error "No scheduled information to update"))))
13041 (org-add-planning-info 'scheduled time 'closed)
13042 (when (and old-date org-log-reschedule
13043 (not (equal old-date
13044 (substring org-last-inserted-timestamp 1 -1))))
13045 (org-add-log-setup 'reschedule nil old-date 'findpos
13046 org-log-reschedule))
13047 (when repeater
13048 (save-excursion
13049 (org-back-to-heading t)
13050 (when (re-search-forward (concat org-scheduled-string " "
13051 org-last-inserted-timestamp)
13052 (save-excursion
13053 (outline-next-heading) (point)) t)
13054 (goto-char (1- (match-end 0)))
13055 (insert " " repeater)
13056 (setq org-last-inserted-timestamp
13057 (concat (substring org-last-inserted-timestamp 0 -1)
13058 " " repeater
13059 (substring org-last-inserted-timestamp -1))))))
13060 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13062 (defun org-get-scheduled-time (pom &optional inherit)
13063 "Get the scheduled time as a time tuple, of a format suitable
13064 for calling org-schedule with, or if there is no scheduling,
13065 returns nil."
13066 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13067 (when time
13068 (apply 'encode-time (org-parse-time-string time)))))
13070 (defun org-get-deadline-time (pom &optional inherit)
13071 "Get the deadline as a time tuple, of a format suitable for
13072 calling org-deadline with, or if there is no scheduling, returns
13073 nil."
13074 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13075 (when time
13076 (apply 'encode-time (org-parse-time-string time)))))
13078 (defun org-remove-timestamp-with-keyword (keyword)
13079 "Remove all time stamps with KEYWORD in the current entry."
13080 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13081 beg)
13082 (save-excursion
13083 (org-back-to-heading t)
13084 (setq beg (point))
13085 (outline-next-heading)
13086 (while (re-search-backward re beg t)
13087 (replace-match "")
13088 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13089 (equal (char-before) ?\ ))
13090 (backward-delete-char 1)
13091 (if (string-match "^[ \t]*$" (buffer-substring
13092 (point-at-bol) (point-at-eol)))
13093 (delete-region (point-at-bol)
13094 (min (point-max) (1+ (point-at-eol))))))))))
13096 (defvar org-time-was-given) ; dynamically scoped parameter
13097 (defvar org-end-time-was-given) ; dynamically scoped parameter
13099 (defun org-add-planning-info (what &optional time &rest remove)
13100 "Insert new timestamp with keyword in the line directly after the headline.
13101 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13102 If non is given, the user is prompted for a date.
13103 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13104 be removed."
13105 (interactive)
13106 (let (org-time-was-given org-end-time-was-given ts
13107 end default-time default-input)
13109 (catch 'exit
13110 (when (and (memq what '(scheduled deadline))
13111 (or (not time)
13112 (and (stringp time)
13113 (string-match "^[-+]+[0-9]" time))))
13114 ;; Try to get a default date/time from existing timestamp
13115 (save-excursion
13116 (org-back-to-heading t)
13117 (setq end (save-excursion (outline-next-heading) (point)))
13118 (when (re-search-forward (if (eq what 'scheduled)
13119 org-scheduled-time-regexp
13120 org-deadline-time-regexp)
13121 end t)
13122 (setq ts (match-string 1)
13123 default-time
13124 (apply 'encode-time (org-parse-time-string ts))
13125 default-input (and ts (org-get-compact-tod ts))))))
13126 (when what
13127 (setq time
13128 (if (stringp time)
13129 ;; This is a string (relative or absolute), set proper date
13130 (apply 'encode-time
13131 (org-read-date-analyze
13132 time default-time (decode-time default-time)))
13133 ;; If necessary, get the time from the user
13134 (or time (org-read-date nil 'to-time nil nil
13135 default-time default-input)))))
13137 (when (and org-insert-labeled-timestamps-at-point
13138 (member what '(scheduled deadline)))
13139 (insert
13140 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13141 (org-insert-time-stamp time org-time-was-given
13142 nil nil nil (list org-end-time-was-given))
13143 (setq what nil))
13144 (save-excursion
13145 (save-restriction
13146 (let (col list elt ts buffer-invisibility-spec)
13147 (org-back-to-heading t)
13148 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13149 (goto-char (match-end 1))
13150 (setq col (current-column))
13151 (goto-char (match-end 0))
13152 (if (eobp) (insert "\n") (forward-char 1))
13153 (when (and (not what)
13154 (not (looking-at
13155 (concat "[ \t]*"
13156 org-keyword-time-not-clock-regexp))))
13157 ;; Nothing to add, nothing to remove...... :-)
13158 (throw 'exit nil))
13159 (if (and (not (looking-at org-outline-regexp))
13160 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13161 "[^\r\n]*"))
13162 (not (equal (match-string 1) org-clock-string)))
13163 (narrow-to-region (match-beginning 0) (match-end 0))
13164 (insert-before-markers "\n")
13165 (backward-char 1)
13166 (narrow-to-region (point) (point))
13167 (and org-adapt-indentation (org-indent-to-column col)))
13168 ;; Check if we have to remove something.
13169 (setq list (cons what remove))
13170 (while list
13171 (setq elt (pop list))
13172 (when (or (and (eq elt 'scheduled)
13173 (re-search-forward org-scheduled-time-regexp nil t))
13174 (and (eq elt 'deadline)
13175 (re-search-forward org-deadline-time-regexp nil t))
13176 (and (eq elt 'closed)
13177 (re-search-forward org-closed-time-regexp nil t)))
13178 (replace-match "")
13179 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13180 (and (looking-at "[ \t]+") (replace-match ""))
13181 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13182 (when what
13183 (insert
13184 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13185 (cond ((eq what 'scheduled) org-scheduled-string)
13186 ((eq what 'deadline) org-deadline-string)
13187 ((eq what 'closed) org-closed-string))
13188 " ")
13189 (setq ts (org-insert-time-stamp
13190 time
13191 (or org-time-was-given
13192 (and (eq what 'closed) org-log-done-with-time))
13193 (eq what 'closed)
13194 nil nil (list org-end-time-was-given)))
13195 (insert
13196 (if (not (or (bolp) (eq (char-before) ?\ )
13197 (memq (char-after) '(32 10))
13198 (eobp))) " " ""))
13199 (end-of-line 1))
13200 (goto-char (point-min))
13201 (widen)
13202 (if (and (looking-at "[ \t]*\n")
13203 (equal (char-before) ?\n))
13204 (delete-region (1- (point)) (point-at-eol)))
13205 ts))))))
13207 (defvar org-log-note-marker (make-marker))
13208 (defvar org-log-note-purpose nil)
13209 (defvar org-log-note-state nil)
13210 (defvar org-log-note-previous-state nil)
13211 (defvar org-log-note-how nil)
13212 (defvar org-log-note-extra nil)
13213 (defvar org-log-note-window-configuration nil)
13214 (defvar org-log-note-return-to (make-marker))
13215 (defvar org-log-note-effective-time nil
13216 "Remembered current time so that dynamically scoped
13217 `org-extend-today-until' affects tha timestamps in state change
13218 log")
13220 (defvar org-log-post-message nil
13221 "Message to be displayed after a log note has been stored.
13222 The auto-repeater uses this.")
13224 (defun org-add-note ()
13225 "Add a note to the current entry.
13226 This is done in the same way as adding a state change note."
13227 (interactive)
13228 (org-add-log-setup 'note nil nil 'findpos nil))
13230 (defvar org-property-end-re)
13231 (defun org-add-log-setup (&optional purpose state prev-state
13232 findpos how extra)
13233 "Set up the post command hook to take a note.
13234 If this is about to TODO state change, the new state is expected in STATE.
13235 When FINDPOS is non-nil, find the correct position for the note in
13236 the current entry. If not, assume that it can be inserted at point.
13237 HOW is an indicator what kind of note should be created.
13238 EXTRA is additional text that will be inserted into the notes buffer."
13239 (let* ((org-log-into-drawer (org-log-into-drawer))
13240 (drawer (cond ((stringp org-log-into-drawer)
13241 org-log-into-drawer)
13242 (org-log-into-drawer "LOGBOOK"))))
13243 (save-restriction
13244 (save-excursion
13245 (when findpos
13246 (org-back-to-heading t)
13247 (narrow-to-region (point) (save-excursion
13248 (outline-next-heading) (point)))
13249 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13250 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13251 "[^\r\n]*\\)?"))
13252 (goto-char (match-end 0))
13253 (cond
13254 (drawer
13255 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13256 nil t)
13257 (progn
13258 (goto-char (match-end 0))
13259 (or org-log-states-order-reversed
13260 (and (re-search-forward org-property-end-re nil t)
13261 (goto-char (1- (match-beginning 0))))))
13262 (insert "\n:" drawer ":\n:END:")
13263 (beginning-of-line 0)
13264 (org-indent-line)
13265 (beginning-of-line 2)
13266 (org-indent-line)
13267 (end-of-line 0)))
13268 ((and org-log-state-notes-insert-after-drawers
13269 (save-excursion
13270 (forward-line) (looking-at org-drawer-regexp)))
13271 (forward-line)
13272 (while (looking-at org-drawer-regexp)
13273 (goto-char (match-end 0))
13274 (re-search-forward org-property-end-re (point-max) t)
13275 (forward-line))
13276 (forward-line -1)))
13277 (unless org-log-states-order-reversed
13278 (and (= (char-after) ?\n) (forward-char 1))
13279 (org-skip-over-state-notes)
13280 (skip-chars-backward " \t\n\r")))
13281 (move-marker org-log-note-marker (point))
13282 (setq org-log-note-purpose purpose
13283 org-log-note-state state
13284 org-log-note-previous-state prev-state
13285 org-log-note-how how
13286 org-log-note-extra extra
13287 org-log-note-effective-time (org-current-effective-time))
13288 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13290 (defun org-skip-over-state-notes ()
13291 "Skip past the list of State notes in an entry."
13292 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13293 (when (ignore-errors (goto-char (org-in-item-p)))
13294 (let* ((struct (org-list-struct))
13295 (prevs (org-list-prevs-alist struct)))
13296 (while (looking-at "[ \t]*- State")
13297 (goto-char (or (org-list-get-next-item (point) struct prevs)
13298 (org-list-get-item-end (point) struct)))))))
13300 (defun org-add-log-note (&optional purpose)
13301 "Pop up a window for taking a note, and add this note later at point."
13302 (remove-hook 'post-command-hook 'org-add-log-note)
13303 (setq org-log-note-window-configuration (current-window-configuration))
13304 (delete-other-windows)
13305 (move-marker org-log-note-return-to (point))
13306 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13307 (goto-char org-log-note-marker)
13308 (org-switch-to-buffer-other-window "*Org Note*")
13309 (erase-buffer)
13310 (if (memq org-log-note-how '(time state))
13311 (let (current-prefix-arg) (org-store-log-note))
13312 (let ((org-inhibit-startup t)) (org-mode))
13313 (insert (format "# Insert note for %s.
13314 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13315 (cond
13316 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13317 ((eq org-log-note-purpose 'done) "closed todo item")
13318 ((eq org-log-note-purpose 'state)
13319 (format "state change from \"%s\" to \"%s\""
13320 (or org-log-note-previous-state "")
13321 (or org-log-note-state "")))
13322 ((eq org-log-note-purpose 'reschedule)
13323 "rescheduling")
13324 ((eq org-log-note-purpose 'delschedule)
13325 "no longer scheduled")
13326 ((eq org-log-note-purpose 'redeadline)
13327 "changing deadline")
13328 ((eq org-log-note-purpose 'deldeadline)
13329 "removing deadline")
13330 ((eq org-log-note-purpose 'refile)
13331 "refiling")
13332 ((eq org-log-note-purpose 'note)
13333 "this entry")
13334 (t (error "This should not happen")))))
13335 (if org-log-note-extra (insert org-log-note-extra))
13336 (org-set-local 'org-finish-function 'org-store-log-note)
13337 (run-hooks 'org-log-buffer-setup-hook)))
13339 (defvar org-note-abort nil) ; dynamically scoped
13340 (defun org-store-log-note ()
13341 "Finish taking a log note, and insert it to where it belongs."
13342 (let ((txt (buffer-string)))
13343 (kill-buffer (current-buffer))
13344 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13345 lines ind bul)
13346 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13347 (setq txt (replace-match "" t t txt)))
13348 (if (string-match "\\s-+\\'" txt)
13349 (setq txt (replace-match "" t t txt)))
13350 (setq lines (org-split-string txt "\n"))
13351 (when (and note (string-match "\\S-" note))
13352 (setq note
13353 (org-replace-escapes
13354 note
13355 (list (cons "%u" (user-login-name))
13356 (cons "%U" user-full-name)
13357 (cons "%t" (format-time-string
13358 (org-time-stamp-format 'long 'inactive)
13359 org-log-note-effective-time))
13360 (cons "%T" (format-time-string
13361 (org-time-stamp-format 'long nil)
13362 org-log-note-effective-time))
13363 (cons "%d" (format-time-string
13364 (org-time-stamp-format nil 'inactive)
13365 org-log-note-effective-time))
13366 (cons "%D" (format-time-string
13367 (org-time-stamp-format nil nil)
13368 org-log-note-effective-time))
13369 (cons "%s" (if org-log-note-state
13370 (concat "\"" org-log-note-state "\"")
13371 ""))
13372 (cons "%S" (if org-log-note-previous-state
13373 (concat "\"" org-log-note-previous-state "\"")
13374 "\"\"")))))
13375 (if lines (setq note (concat note " \\\\")))
13376 (push note lines))
13377 (when (or current-prefix-arg org-note-abort)
13378 (when org-log-into-drawer
13379 (org-remove-empty-drawer-at
13380 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13381 org-log-note-marker))
13382 (setq lines nil))
13383 (when lines
13384 (with-current-buffer (marker-buffer org-log-note-marker)
13385 (save-excursion
13386 (goto-char org-log-note-marker)
13387 (move-marker org-log-note-marker nil)
13388 (end-of-line 1)
13389 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13390 (setq ind (save-excursion
13391 (if (ignore-errors (goto-char (org-in-item-p)))
13392 (let ((struct (org-list-struct)))
13393 (org-list-get-ind
13394 (org-list-get-top-point struct) struct))
13395 (skip-chars-backward " \r\t\n")
13396 (cond
13397 ((and (org-at-heading-p)
13398 org-adapt-indentation)
13399 (1+ (org-current-level)))
13400 ((org-at-heading-p) 0)
13401 (t (org-get-indentation))))))
13402 (setq bul (org-list-bullet-string "-"))
13403 (org-indent-line-to ind)
13404 (insert bul (pop lines))
13405 (let ((ind-body (+ (length bul) ind)))
13406 (while lines
13407 (insert "\n")
13408 (org-indent-line-to ind-body)
13409 (insert (pop lines))))
13410 (message "Note stored")
13411 (org-back-to-heading t)
13412 (org-cycle-hide-drawers 'children))
13413 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13414 ;; from within `org-add-log-note' because `buffer-undo-list'
13415 ;; is then modified outside of `org-with-remote-undo'.
13416 (when (eq this-command 'org-agenda-todo)
13417 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13418 ;; Don't add undo information when called from `org-agenda-todo'
13419 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13420 (set-window-configuration org-log-note-window-configuration)
13421 (with-current-buffer (marker-buffer org-log-note-return-to)
13422 (goto-char org-log-note-return-to))
13423 (move-marker org-log-note-return-to nil)
13424 (and org-log-post-message (message "%s" org-log-post-message))))
13426 (defun org-remove-empty-drawer-at (drawer pos)
13427 "Remove an empty drawer DRAWER at position POS.
13428 POS may also be a marker."
13429 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13430 (save-excursion
13431 (save-restriction
13432 (widen)
13433 (goto-char pos)
13434 (if (org-in-regexp
13435 (concat "^[ \t]*:" drawer ":[ \t]*\n[ \t]*:END:[ \t]*\n?") 2)
13436 (replace-match ""))))))
13438 (defvar org-ts-type nil)
13439 (defun org-sparse-tree (&optional arg type)
13440 "Create a sparse tree, prompt for the details.
13441 This command can create sparse trees. You first need to select the type
13442 of match used to create the tree:
13444 t Show all TODO entries.
13445 T Show entries with a specific TODO keyword.
13446 m Show entries selected by a tags/property match.
13447 p Enter a property name and its value (both with completion on existing
13448 names/values) and show entries with that property.
13449 r Show entries matching a regular expression (`/' can be used as well).
13450 b Show deadlines and scheduled items before a date.
13451 a Show deadlines and scheduled items after a date.
13452 d Show deadlines due within `org-deadline-warning-days'.
13453 D Show deadlines and scheduled items between a date range."
13454 (interactive "P")
13455 (let (ans kwd value ts-type)
13456 (setq type (or type org-sparse-tree-default-date-type))
13457 (setq org-ts-type type)
13458 (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"
13459 (cond ((eq type 'all) "all timestamps")
13460 ((eq type 'scheduled) "only scheduled")
13461 ((eq type 'deadline) "only deadline")
13462 ((eq type 'active) "only active timestamps")
13463 ((eq type 'inactive) "only inactive timestamps")
13464 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13465 ((eq type 'closed) "with a closed time-stamp")
13466 (t "scheduled/deadline")))
13467 (setq ans (read-char-exclusive))
13468 (cond
13469 ((equal ans ?c)
13470 (org-sparse-tree
13471 arg (cadr (member type '(scheduled-or-deadline
13472 all scheduled deadline active inactive closed)))))
13473 ((equal ans ?d)
13474 (call-interactively 'org-check-deadlines))
13475 ((equal ans ?b)
13476 (call-interactively 'org-check-before-date))
13477 ((equal ans ?a)
13478 (call-interactively 'org-check-after-date))
13479 ((equal ans ?D)
13480 (call-interactively 'org-check-dates-range))
13481 ((equal ans ?t)
13482 (call-interactively 'org-show-todo-tree))
13483 ((equal ans ?T)
13484 (org-show-todo-tree '(4)))
13485 ((member ans '(?T ?m))
13486 (call-interactively 'org-match-sparse-tree))
13487 ((member ans '(?p ?P))
13488 (setq kwd (org-icompleting-read "Property: "
13489 (mapcar 'list (org-buffer-property-keys))))
13490 (setq value (org-icompleting-read "Value: "
13491 (mapcar 'list (org-property-values kwd))))
13492 (unless (string-match "\\`{.*}\\'" value)
13493 (setq value (concat "\"" value "\"")))
13494 (org-match-sparse-tree arg (concat kwd "=" value)))
13495 ((member ans '(?r ?R ?/))
13496 (call-interactively 'org-occur))
13497 (t (user-error "No such sparse tree command \"%c\"" ans)))))
13499 (defvar org-occur-highlights nil
13500 "List of overlays used for occur matches.")
13501 (make-variable-buffer-local 'org-occur-highlights)
13502 (defvar org-occur-parameters nil
13503 "Parameters of the active org-occur calls.
13504 This is a list, each call to org-occur pushes as cons cell,
13505 containing the regular expression and the callback, onto the list.
13506 The list can contain several entries if `org-occur' has been called
13507 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13508 will only contain one set of parameters. When the highlights are
13509 removed (for example with `C-c C-c', or with the next edit (depending
13510 on `org-remove-highlights-with-change'), this variable is emptied
13511 as well.")
13512 (make-variable-buffer-local 'org-occur-parameters)
13514 (defun org-occur (regexp &optional keep-previous callback)
13515 "Make a compact tree which shows all matches of REGEXP.
13516 The tree will show the lines where the regexp matches, and all higher
13517 headlines above the match. It will also show the heading after the match,
13518 to make sure editing the matching entry is easy.
13519 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13520 call to `org-occur' will be kept, to allow stacking of calls to this
13521 command.
13522 If CALLBACK is non-nil, it is a function which is called to confirm
13523 that the match should indeed be shown."
13524 (interactive "sRegexp: \nP")
13525 (when (equal regexp "")
13526 (user-error "Regexp cannot be empty"))
13527 (unless keep-previous
13528 (org-remove-occur-highlights nil nil t))
13529 (push (cons regexp callback) org-occur-parameters)
13530 (let ((cnt 0))
13531 (save-excursion
13532 (goto-char (point-min))
13533 (if (or (not keep-previous) ; do not want to keep
13534 (not org-occur-highlights)) ; no previous matches
13535 ;; hide everything
13536 (org-overview))
13537 (while (re-search-forward regexp nil t)
13538 (when (or (not callback)
13539 (save-match-data (funcall callback)))
13540 (setq cnt (1+ cnt))
13541 (when org-highlight-sparse-tree-matches
13542 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13543 (org-show-context 'occur-tree))))
13544 (when org-remove-highlights-with-change
13545 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13546 nil 'local))
13547 (unless org-sparse-tree-open-archived-trees
13548 (org-hide-archived-subtrees (point-min) (point-max)))
13549 (run-hooks 'org-occur-hook)
13550 (if (org-called-interactively-p 'interactive)
13551 (message "%d match(es) for regexp %s" cnt regexp))
13552 cnt))
13554 (defun org-occur-next-match (&optional n reset)
13555 "Function for `next-error-function' to find sparse tree matches.
13556 N is the number of matches to move, when negative move backwards.
13557 RESET is entirely ignored - this function always goes back to the
13558 starting point when no match is found."
13559 (let* ((limit (if (< n 0) (point-min) (point-max)))
13560 (search-func (if (< n 0)
13561 'previous-single-char-property-change
13562 'next-single-char-property-change))
13563 (n (abs n))
13564 (pos (point))
13566 (catch 'exit
13567 (while (setq p1 (funcall search-func (point) 'org-type))
13568 (when (equal p1 limit)
13569 (goto-char pos)
13570 (error "No more matches"))
13571 (when (equal (get-char-property p1 'org-type) 'org-occur)
13572 (setq n (1- n))
13573 (when (= n 0)
13574 (goto-char p1)
13575 (throw 'exit (point))))
13576 (goto-char p1))
13577 (goto-char p1)
13578 (error "No more matches"))))
13580 (defun org-show-context (&optional key)
13581 "Make sure point and context are visible.
13582 How much context is shown depends upon the variables
13583 `org-show-hierarchy-above', `org-show-following-heading',
13584 `org-show-entry-below' and `org-show-siblings'."
13585 (let ((heading-p (org-at-heading-p t))
13586 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13587 (following-p (org-get-alist-option org-show-following-heading key))
13588 (entry-p (org-get-alist-option org-show-entry-below key))
13589 (siblings-p (org-get-alist-option org-show-siblings key)))
13590 ;; Show heading or entry text
13591 (if (and heading-p (not entry-p))
13592 (org-flag-heading nil) ; only show the heading
13593 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13594 (org-show-hidden-entry))) ; show entire entry
13595 (when following-p
13596 ;; Show next sibling, or heading below text
13597 (save-excursion
13598 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13599 (org-flag-heading nil))))
13600 (when siblings-p (org-show-siblings))
13601 (when hierarchy-p
13602 ;; show all higher headings, possibly with siblings
13603 (save-excursion
13604 (while (and (condition-case nil
13605 (progn (org-up-heading-all 1) t)
13606 (error nil))
13607 (not (bobp)))
13608 (org-flag-heading nil)
13609 (when siblings-p (org-show-siblings)))))
13610 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13612 (defvar org-reveal-start-hook nil
13613 "Hook run before revealing a location.")
13615 (defun org-reveal (&optional siblings)
13616 "Show current entry, hierarchy above it, and the following headline.
13617 This can be used to show a consistent set of context around locations
13618 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13619 not t for the search context.
13621 With optional argument SIBLINGS, on each level of the hierarchy all
13622 siblings are shown. This repairs the tree structure to what it would
13623 look like when opened with hierarchical calls to `org-cycle'.
13624 With double optional argument \\[universal-argument] \\[universal-argument], \
13625 go to the parent and show the
13626 entire tree."
13627 (interactive "P")
13628 (run-hooks 'org-reveal-start-hook)
13629 (let ((org-show-hierarchy-above t)
13630 (org-show-following-heading t)
13631 (org-show-siblings (if siblings t org-show-siblings)))
13632 (org-show-context nil))
13633 (when (equal siblings '(16))
13634 (save-excursion
13635 (when (org-up-heading-safe)
13636 (org-show-subtree)
13637 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13639 (defun org-highlight-new-match (beg end)
13640 "Highlight from BEG to END and mark the highlight is an occur headline."
13641 (let ((ov (make-overlay beg end)))
13642 (overlay-put ov 'face 'secondary-selection)
13643 (overlay-put ov 'org-type 'org-occur)
13644 (push ov org-occur-highlights)))
13646 (defun org-remove-occur-highlights (&optional beg end noremove)
13647 "Remove the occur highlights from the buffer.
13648 BEG and END are ignored. If NOREMOVE is nil, remove this function
13649 from the `before-change-functions' in the current buffer."
13650 (interactive)
13651 (unless org-inhibit-highlight-removal
13652 (mapc 'delete-overlay org-occur-highlights)
13653 (setq org-occur-highlights nil)
13654 (setq org-occur-parameters nil)
13655 (unless noremove
13656 (remove-hook 'before-change-functions
13657 'org-remove-occur-highlights 'local))))
13659 ;;;; Priorities
13661 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13662 "Regular expression matching the priority indicator.")
13664 (defvar org-remove-priority-next-time nil)
13666 (defun org-priority-up ()
13667 "Increase the priority of the current item."
13668 (interactive)
13669 (org-priority 'up))
13671 (defun org-priority-down ()
13672 "Decrease the priority of the current item."
13673 (interactive)
13674 (org-priority 'down))
13676 (defun org-priority (&optional action show)
13677 "Change the priority of an item.
13678 ACTION can be `set', `up', `down', or a character."
13679 (interactive "P")
13680 (if (equal action '(4))
13681 (org-show-priority)
13682 (unless org-enable-priority-commands
13683 (user-error "Priority commands are disabled"))
13684 (setq action (or action 'set))
13685 (let (current new news have remove)
13686 (save-excursion
13687 (org-back-to-heading t)
13688 (if (looking-at org-priority-regexp)
13689 (setq current (string-to-char (match-string 2))
13690 have t))
13691 (cond
13692 ((eq action 'remove)
13693 (setq remove t new ?\ ))
13694 ((or (eq action 'set)
13695 (if (featurep 'xemacs) (characterp action) (integerp action)))
13696 (if (not (eq action 'set))
13697 (setq new action)
13698 (message "Priority %c-%c, SPC to remove: "
13699 org-highest-priority org-lowest-priority)
13700 (save-match-data
13701 (setq new (read-char-exclusive))))
13702 (if (and (= (upcase org-highest-priority) org-highest-priority)
13703 (= (upcase org-lowest-priority) org-lowest-priority))
13704 (setq new (upcase new)))
13705 (cond ((equal new ?\ ) (setq remove t))
13706 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13707 (user-error "Priority must be between `%c' and `%c'"
13708 org-highest-priority org-lowest-priority))))
13709 ((eq action 'up)
13710 (setq new (if have
13711 (1- current) ; normal cycling
13712 ;; last priority was empty
13713 (if (eq last-command this-command)
13714 org-lowest-priority ; wrap around empty to lowest
13715 ;; default
13716 (if org-priority-start-cycle-with-default
13717 org-default-priority
13718 (1- org-default-priority))))))
13719 ((eq action 'down)
13720 (setq new (if have
13721 (1+ current) ; normal cycling
13722 ;; last priority was empty
13723 (if (eq last-command this-command)
13724 org-highest-priority ; wrap around empty to highest
13725 ;; default
13726 (if org-priority-start-cycle-with-default
13727 org-default-priority
13728 (1+ org-default-priority))))))
13729 (t (user-error "Invalid action")))
13730 (if (or (< (upcase new) org-highest-priority)
13731 (> (upcase new) org-lowest-priority))
13732 (if (and (memq action '(up down))
13733 (not have) (not (eq last-command this-command)))
13734 ;; `new' is from default priority
13735 (error
13736 "The default can not be set, see `org-default-priority' why")
13737 ;; normal cycling: `new' is beyond highest/lowest priority
13738 ;; and is wrapped around to the empty priority
13739 (setq remove t)))
13740 (setq news (format "%c" new))
13741 (if have
13742 (if remove
13743 (replace-match "" t t nil 1)
13744 (replace-match news t t nil 2))
13745 (if remove
13746 (user-error "No priority cookie found in line")
13747 (let ((case-fold-search nil))
13748 (looking-at org-todo-line-regexp))
13749 (if (match-end 2)
13750 (progn
13751 (goto-char (match-end 2))
13752 (insert " [#" news "]"))
13753 (goto-char (match-beginning 3))
13754 (insert "[#" news "] "))))
13755 (org-preserve-lc (org-set-tags nil 'align)))
13756 (if remove
13757 (message "Priority removed")
13758 (message "Priority of current item set to %s" news)))))
13760 (defun org-show-priority ()
13761 "Show the priority of the current item.
13762 This priority is composed of the main priority given with the [#A] cookies,
13763 and by additional input from the age of a schedules or deadline entry."
13764 (interactive)
13765 (let ((pri (if (eq major-mode 'org-agenda-mode)
13766 (org-get-at-bol 'priority)
13767 (save-excursion
13768 (save-match-data
13769 (beginning-of-line)
13770 (and (looking-at org-heading-regexp)
13771 (org-get-priority (match-string 0))))))))
13772 (message "Priority is %d" (if pri pri -1000))))
13774 (defun org-get-priority (s)
13775 "Find priority cookie and return priority."
13776 (save-match-data
13777 (if (functionp org-get-priority-function)
13778 (funcall org-get-priority-function)
13779 (if (not (string-match org-priority-regexp s))
13780 (* 1000 (- org-lowest-priority org-default-priority))
13781 (* 1000 (- org-lowest-priority
13782 (string-to-char (match-string 2 s))))))))
13784 ;;;; Tags
13786 (defvar org-agenda-archives-mode)
13787 (defvar org-map-continue-from nil
13788 "Position from where mapping should continue.
13789 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13791 (defvar org-scanner-tags nil
13792 "The current tag list while the tags scanner is running.")
13793 (defvar org-trust-scanner-tags nil
13794 "Should `org-get-tags-at' use the tags for the scanner.
13795 This is for internal dynamical scoping only.
13796 When this is non-nil, the function `org-get-tags-at' will return the value
13797 of `org-scanner-tags' instead of building the list by itself. This
13798 can lead to large speed-ups when the tags scanner is used in a file with
13799 many entries, and when the list of tags is retrieved, for example to
13800 obtain a list of properties. Building the tags list for each entry in such
13801 a file becomes an N^2 operation - but with this variable set, it scales
13802 as N.")
13804 (defun org-scan-tags (action matcher todo-only &optional start-level)
13805 "Sca headline tags with inheritance and produce output ACTION.
13807 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13808 or `agenda' to produce an entry list for an agenda view. It can also be
13809 a Lisp form or a function that should be called at each matched headline, in
13810 this case the return value is a list of all return values from these calls.
13812 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13813 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13814 only lines with a not-done TODO keyword are included in the output.
13815 This should be the same variable that was scoped into
13816 and set by `org-make-tags-matcher' when it constructed MATCHER.
13818 START-LEVEL can be a string with asterisks, reducing the scope to
13819 headlines matching this string."
13820 (require 'org-agenda)
13821 (let* ((re (concat "^"
13822 (if start-level
13823 ;; Get the correct level to match
13824 (concat "\\*\\{" (number-to-string start-level) "\\} ")
13825 org-outline-regexp)
13826 " *\\(\\<\\("
13827 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
13828 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
13829 (props (list 'face 'default
13830 'done-face 'org-agenda-done
13831 'undone-face 'default
13832 'mouse-face 'highlight
13833 'org-not-done-regexp org-not-done-regexp
13834 'org-todo-regexp org-todo-regexp
13835 'org-complex-heading-regexp org-complex-heading-regexp
13836 'help-echo
13837 (format "mouse-2 or RET jump to org file %s"
13838 (abbreviate-file-name
13839 (or (buffer-file-name (buffer-base-buffer))
13840 (buffer-name (buffer-base-buffer)))))))
13841 (org-map-continue-from nil)
13842 lspos tags tags-list
13843 (tags-alist (list (cons 0 org-file-tags)))
13844 (llast 0) rtn rtn1 level category i txt
13845 todo marker entry priority)
13846 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13847 (setq action (list 'lambda nil action)))
13848 (save-excursion
13849 (goto-char (point-min))
13850 (when (eq action 'sparse-tree)
13851 (org-overview)
13852 (org-remove-occur-highlights))
13853 (while (let (case-fold-search)
13854 (re-search-forward re nil t))
13855 (setq org-map-continue-from nil)
13856 (catch :skip
13857 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13858 tags (if (match-end 4) (org-match-string-no-properties 4)))
13859 (goto-char (setq lspos (match-beginning 0)))
13860 (setq level (org-reduced-level (org-outline-level))
13861 category (org-get-category))
13862 (setq i llast llast level)
13863 ;; remove tag lists from same and sublevels
13864 (while (>= i level)
13865 (when (setq entry (assoc i tags-alist))
13866 (setq tags-alist (delete entry tags-alist)))
13867 (setq i (1- i)))
13868 ;; add the next tags
13869 (when tags
13870 (setq tags (org-split-string tags ":")
13871 tags-alist
13872 (cons (cons level tags) tags-alist)))
13873 ;; compile tags for current headline
13874 (setq tags-list
13875 (if org-use-tag-inheritance
13876 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13877 tags)
13878 org-scanner-tags tags-list)
13879 (when org-use-tag-inheritance
13880 (setcdr (car tags-alist)
13881 (mapcar (lambda (x)
13882 (setq x (copy-sequence x))
13883 (org-add-prop-inherited x))
13884 (cdar tags-alist))))
13885 (when (and tags org-use-tag-inheritance
13886 (or (not (eq t org-use-tag-inheritance))
13887 org-tags-exclude-from-inheritance))
13888 ;; selective inheritance, remove uninherited ones
13889 (setcdr (car tags-alist)
13890 (org-remove-uninherited-tags (cdar tags-alist))))
13891 (when (and
13893 ;; eval matcher only when the todo condition is OK
13894 (and (or (not todo-only) (member todo org-not-done-keywords))
13895 (let ((case-fold-search t) (org-trust-scanner-tags t))
13896 (eval matcher)))
13898 ;; Call the skipper, but return t if it does not skip,
13899 ;; so that the `and' form continues evaluating
13900 (progn
13901 (unless (eq action 'sparse-tree) (org-agenda-skip))
13904 ;; Check if timestamps are deselecting this entry
13905 (or (not todo-only)
13906 (and (member todo org-not-done-keywords)
13907 (or (not org-agenda-tags-todo-honor-ignore-options)
13908 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13910 ;; select this headline
13911 (cond
13912 ((eq action 'sparse-tree)
13913 (and org-highlight-sparse-tree-matches
13914 (org-get-heading) (match-end 0)
13915 (org-highlight-new-match
13916 (match-beginning 1) (match-end 1)))
13917 (org-show-context 'tags-tree))
13918 ((eq action 'agenda)
13919 (setq txt (org-agenda-format-item
13921 (concat
13922 (if (eq org-tags-match-list-sublevels 'indented)
13923 (make-string (1- level) ?.) "")
13924 (org-get-heading))
13925 level category
13926 tags-list)
13927 priority (org-get-priority txt))
13928 (goto-char lspos)
13929 (setq marker (org-agenda-new-marker))
13930 (org-add-props txt props
13931 'org-marker marker 'org-hd-marker marker 'org-category category
13932 'todo-state todo
13933 'priority priority 'type "tagsmatch")
13934 (push txt rtn))
13935 ((functionp action)
13936 (setq org-map-continue-from nil)
13937 (save-excursion
13938 (setq rtn1 (funcall action))
13939 (push rtn1 rtn)))
13940 (t (user-error "Invalid action")))
13942 ;; if we are to skip sublevels, jump to end of subtree
13943 (unless org-tags-match-list-sublevels
13944 (org-end-of-subtree t)
13945 (backward-char 1))))
13946 ;; Get the correct position from where to continue
13947 (if org-map-continue-from
13948 (goto-char org-map-continue-from)
13949 (and (= (point) lspos) (end-of-line 1)))))
13950 (when (and (eq action 'sparse-tree)
13951 (not org-sparse-tree-open-archived-trees))
13952 (org-hide-archived-subtrees (point-min) (point-max)))
13953 (nreverse rtn)))
13955 (defun org-remove-uninherited-tags (tags)
13956 "Remove all tags that are not inherited from the list TAGS."
13957 (cond
13958 ((eq org-use-tag-inheritance t)
13959 (if org-tags-exclude-from-inheritance
13960 (org-delete-all org-tags-exclude-from-inheritance tags)
13961 tags))
13962 ((not org-use-tag-inheritance) nil)
13963 ((stringp org-use-tag-inheritance)
13964 (delq nil (mapcar
13965 (lambda (x)
13966 (if (and (string-match org-use-tag-inheritance x)
13967 (not (member x org-tags-exclude-from-inheritance)))
13968 x nil))
13969 tags)))
13970 ((listp org-use-tag-inheritance)
13971 (delq nil (mapcar
13972 (lambda (x)
13973 (if (member x org-use-tag-inheritance) x nil))
13974 tags)))))
13976 (defun org-match-sparse-tree (&optional todo-only match)
13977 "Create a sparse tree according to tags string MATCH.
13978 MATCH can contain positive and negative selection of tags, like
13979 \"+WORK+URGENT-WITHBOSS\".
13980 If optional argument TODO-ONLY is non-nil, only select lines that are
13981 also TODO lines."
13982 (interactive "P")
13983 (org-agenda-prepare-buffers (list (current-buffer)))
13984 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13986 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13988 (defvar org-cached-props nil)
13989 (defun org-cached-entry-get (pom property)
13990 (if (or (eq t org-use-property-inheritance)
13991 (and (stringp org-use-property-inheritance)
13992 (string-match org-use-property-inheritance property))
13993 (and (listp org-use-property-inheritance)
13994 (member property org-use-property-inheritance)))
13995 ;; Caching is not possible, check it directly
13996 (org-entry-get pom property 'inherit)
13997 ;; Get all properties, so that we can do complicated checks easily
13998 (cdr (assoc property (or org-cached-props
13999 (setq org-cached-props
14000 (org-entry-properties pom)))))))
14002 (defun org-global-tags-completion-table (&optional files)
14003 "Return the list of all tags in all agenda buffer/files.
14004 Optional FILES argument is a list of files which can be used
14005 instead of the agenda files."
14006 (save-excursion
14007 (org-uniquify
14008 (delq nil
14009 (apply 'append
14010 (mapcar
14011 (lambda (file)
14012 (set-buffer (find-file-noselect file))
14013 (append (org-get-buffer-tags)
14014 (mapcar (lambda (x) (if (stringp (car-safe x))
14015 (list (car-safe x)) nil))
14016 org-tag-alist)))
14017 (if (and files (car files))
14018 files
14019 (org-agenda-files))))))))
14021 (defun org-make-tags-matcher (match)
14022 "Create the TAGS/TODO matcher form for the selection string MATCH.
14024 The variable `todo-only' is scoped dynamically into this function.
14025 It will be set to t if the matcher restricts matching to TODO entries,
14026 otherwise will not be touched.
14028 Returns a cons of the selection string MATCH and the constructed
14029 lisp form implementing the matcher. The matcher is to be evaluated
14030 at an Org entry, with point on the headline, and returns t if the
14031 entry matches the selection string MATCH. The returned lisp form
14032 references two variables with information about the entry, which
14033 must be bound around the form's evaluation: todo, the TODO keyword
14034 at the entry (or nil of none); and tags-list, the list of all tags
14035 at the entry including inherited ones. Additionally, the category
14036 of the entry (if any) must be specified as the text property
14037 'org-category on the headline.
14039 See also `org-scan-tags'.
14041 (declare (special todo-only))
14042 (unless (boundp 'todo-only)
14043 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14044 (unless match
14045 ;; Get a new match request, with completion against the global
14046 ;; tags table and the local tags in current buffer
14047 (let ((org-last-tags-completion-table
14048 (org-uniquify
14049 (delq nil (append (org-get-buffer-tags)
14050 (org-global-tags-completion-table))))))
14051 (setq match (org-completing-read-no-i
14052 "Match: " 'org-tags-completion-function nil nil nil
14053 'org-tags-history))))
14055 ;; Parse the string and create a lisp form
14056 (let ((match0 match)
14057 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14058 minus tag mm
14059 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14060 orterms term orlist re-p str-p level-p level-op time-p
14061 prop-p pn pv po gv rest (start 0) (ss 0))
14062 ;; Expand group tags
14063 (setq match (org-tags-expand match))
14065 ;; Check if there is a TODO part of this match, which would be the
14066 ;; part after a "/". TO make sure that this slash is not part of
14067 ;; a property value to be matched against, we also check that there
14068 ;; is no " after that slash.
14069 ;; First, find the last slash
14070 (while (string-match "/+" match ss)
14071 (setq start (match-beginning 0) ss (match-end 0)))
14072 (if (and (string-match "/+" match start)
14073 (not (save-match-data (string-match "\"" match start))))
14074 ;; match contains also a todo-matching request
14075 (progn
14076 (setq tagsmatch (substring match 0 (match-beginning 0))
14077 todomatch (substring match (match-end 0)))
14078 (if (string-match "^!" todomatch)
14079 (setq todo-only t todomatch (substring todomatch 1)))
14080 (if (string-match "^\\s-*$" todomatch)
14081 (setq todomatch nil)))
14082 ;; only matching tags
14083 (setq tagsmatch match todomatch nil))
14085 ;; Make the tags matcher
14086 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14087 (setq tagsmatcher t)
14088 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14089 (while (setq term (pop orterms))
14090 (while (and (equal (substring term -1) "\\") orterms)
14091 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14092 (while (string-match re term)
14093 (setq rest (substring term (match-end 0))
14094 minus (and (match-end 1)
14095 (equal (match-string 1 term) "-"))
14096 tag (save-match-data (replace-regexp-in-string
14097 "\\\\-" "-"
14098 (match-string 2 term)))
14099 re-p (equal (string-to-char tag) ?{)
14100 level-p (match-end 4)
14101 prop-p (match-end 5)
14102 mm (cond
14103 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14104 (level-p
14105 (setq level-op (org-op-to-function (match-string 3 term)))
14106 `(,level-op level ,(string-to-number
14107 (match-string 4 term))))
14108 (prop-p
14109 (setq pn (match-string 5 term)
14110 po (match-string 6 term)
14111 pv (match-string 7 term)
14112 re-p (equal (string-to-char pv) ?{)
14113 str-p (equal (string-to-char pv) ?\")
14114 time-p (save-match-data
14115 (string-match "^\"[[<].*[]>]\"$" pv))
14116 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14117 (if time-p (setq pv (org-matcher-time pv)))
14118 (setq po (org-op-to-function po (if time-p 'time str-p)))
14119 (cond
14120 ((equal pn "CATEGORY")
14121 (setq gv '(get-text-property (point) 'org-category)))
14122 ((equal pn "TODO")
14123 (setq gv 'todo))
14125 (setq gv `(org-cached-entry-get nil ,pn))))
14126 (if re-p
14127 (if (eq po 'org<>)
14128 `(not (string-match ,pv (or ,gv "")))
14129 `(string-match ,pv (or ,gv "")))
14130 (if str-p
14131 `(,po (or ,gv "") ,pv)
14132 `(,po (string-to-number (or ,gv ""))
14133 ,(string-to-number pv) ))))
14134 (t `(member ,tag tags-list)))
14135 mm (if minus (list 'not mm) mm)
14136 term rest)
14137 (push mm tagsmatcher))
14138 (push (if (> (length tagsmatcher) 1)
14139 (cons 'and tagsmatcher)
14140 (car tagsmatcher))
14141 orlist)
14142 (setq tagsmatcher nil))
14143 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14144 (setq tagsmatcher
14145 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14146 ;; Make the todo matcher
14147 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14148 (setq todomatcher t)
14149 (setq orterms (org-split-string todomatch "|") orlist nil)
14150 (while (setq term (pop orterms))
14151 (while (string-match re term)
14152 (setq minus (and (match-end 1)
14153 (equal (match-string 1 term) "-"))
14154 kwd (match-string 2 term)
14155 re-p (equal (string-to-char kwd) ?{)
14156 term (substring term (match-end 0))
14157 mm (if re-p
14158 `(string-match ,(substring kwd 1 -1) todo)
14159 (list 'equal 'todo kwd))
14160 mm (if minus (list 'not mm) mm))
14161 (push mm todomatcher))
14162 (push (if (> (length todomatcher) 1)
14163 (cons 'and todomatcher)
14164 (car todomatcher))
14165 orlist)
14166 (setq todomatcher nil))
14167 (setq todomatcher (if (> (length orlist) 1)
14168 (cons 'or orlist) (car orlist))))
14170 ;; Return the string and lisp forms of the matcher
14171 (setq matcher (if todomatcher
14172 (list 'and tagsmatcher todomatcher)
14173 tagsmatcher))
14174 (when todo-only
14175 (setq matcher (list 'and '(member todo org-not-done-keywords)
14176 matcher)))
14177 (cons match0 matcher)))
14179 (defun org-tags-expand (match &optional single-as-list downcased)
14180 "Expand group tags in MATCH.
14182 This replaces every group tag in MATCH with a regexp tag search.
14183 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14184 will be replaced like this:
14186 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14187 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14188 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14190 Replacing by a regexp preserves the structure of the match.
14191 E.g., this expansion
14193 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14195 will match anything tagged with \"Lab\" and \"Home\", or tagged
14196 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14198 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14199 assumed to be a single group tag, and the function will return
14200 the list of tags in this group.
14202 When DOWNCASE is non-nil, expand downcased TAGS."
14203 (if org-group-tags
14204 (let* ((case-fold-search t)
14205 (stable org-mode-syntax-table)
14206 (tal (or org-tag-groups-alist-for-agenda
14207 org-tag-groups-alist))
14208 (tal (if downcased
14209 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14210 (tml (mapcar 'car tal))
14211 (rtnmatch match) rpl)
14212 ;; @ and _ are allowed as word-components in tags
14213 (modify-syntax-entry ?@ "w" stable)
14214 (modify-syntax-entry ?_ "w" stable)
14215 (while (and tml
14216 (with-syntax-table stable
14217 (string-match
14218 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14219 (regexp-opt tml) "\\>\\)") rtnmatch)))
14220 (let* ((dir (match-string 1 rtnmatch))
14221 (tag (match-string 2 rtnmatch))
14222 (tag (if downcased (downcase tag) tag)))
14223 (setq tml (delete tag tml))
14224 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14225 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14226 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14227 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14228 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14229 (if single-as-list
14230 (or (reverse rpl) (list rtnmatch))
14231 rtnmatch))
14232 (if single-as-list (list (if downcased (downcase match) match))
14233 match)))
14235 (defun org-op-to-function (op &optional stringp)
14236 "Turn an operator into the appropriate function."
14237 (setq op
14238 (cond
14239 ((equal op "<" ) '(< string< org-time<))
14240 ((equal op ">" ) '(> org-string> org-time>))
14241 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14242 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14243 ((member op '("=" "==")) '(= string= org-time=))
14244 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14245 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14247 (defun org<> (a b) (not (= a b)))
14248 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14249 (defun org-string>= (a b) (not (string< a b)))
14250 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14251 (defun org-string<> (a b) (not (string= a b)))
14252 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14253 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14254 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14255 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14256 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14257 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14258 (defun org-2ft (s)
14259 "Convert S to a floating point time.
14260 If S is already a number, just return it. If it is a string, parse
14261 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14262 (cond
14263 ((numberp s) s)
14264 ((stringp s)
14265 (condition-case nil
14266 (float-time (apply 'encode-time (org-parse-time-string s)))
14267 (error 0.)))
14268 (t 0.)))
14270 (defun org-time-today ()
14271 "Time in seconds today at 0:00.
14272 Returns the float number of seconds since the beginning of the
14273 epoch to the beginning of today (00:00)."
14274 (float-time (apply 'encode-time
14275 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14277 (defun org-matcher-time (s)
14278 "Interpret a time comparison value."
14279 (save-match-data
14280 (cond
14281 ((string= s "<now>") (float-time))
14282 ((string= s "<today>") (org-time-today))
14283 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14284 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14285 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14286 (+ (org-time-today)
14287 (* (string-to-number (match-string 1 s))
14288 (cdr (assoc (match-string 2 s)
14289 '(("d" . 86400.0) ("w" . 604800.0)
14290 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14291 (t (org-2ft s)))))
14293 (defun org-match-any-p (re list)
14294 "Does re match any element of list?"
14295 (setq list (mapcar (lambda (x) (string-match re x)) list))
14296 (delq nil list))
14298 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14299 (defvar org-tags-overlay (make-overlay 1 1))
14300 (org-detach-overlay org-tags-overlay)
14302 (defun org-get-local-tags-at (&optional pos)
14303 "Get a list of tags defined in the current headline."
14304 (org-get-tags-at pos 'local))
14306 (defun org-get-local-tags ()
14307 "Get a list of tags defined in the current headline."
14308 (org-get-tags-at nil 'local))
14310 (defun org-get-tags-at (&optional pos local)
14311 "Get a list of all headline tags applicable at POS.
14312 POS defaults to point. If tags are inherited, the list contains
14313 the targets in the same sequence as the headlines appear, i.e.
14314 the tags of the current headline come last.
14315 When LOCAL is non-nil, only return tags from the current headline,
14316 ignore inherited ones."
14317 (interactive)
14318 (if (and org-trust-scanner-tags
14319 (or (not pos) (equal pos (point)))
14320 (not local))
14321 org-scanner-tags
14322 (let (tags ltags lastpos parent)
14323 (save-excursion
14324 (save-restriction
14325 (widen)
14326 (goto-char (or pos (point)))
14327 (save-match-data
14328 (catch 'done
14329 (condition-case nil
14330 (progn
14331 (org-back-to-heading t)
14332 (while (not (equal lastpos (point)))
14333 (setq lastpos (point))
14334 (when (looking-at
14335 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14336 (setq ltags (org-split-string
14337 (org-match-string-no-properties 1) ":"))
14338 (when parent
14339 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14340 (setq tags (append
14341 (if parent
14342 (org-remove-uninherited-tags ltags)
14343 ltags)
14344 tags)))
14345 (or org-use-tag-inheritance (throw 'done t))
14346 (if local (throw 'done t))
14347 (or (org-up-heading-safe) (error nil))
14348 (setq parent t)))
14349 (error nil)))))
14350 (if local
14351 tags
14352 (reverse (delete-dups
14353 (reverse (append
14354 (org-remove-uninherited-tags
14355 org-file-tags) tags)))))))))
14357 (defun org-add-prop-inherited (s)
14358 (add-text-properties 0 (length s) '(inherited t) s)
14361 (defun org-toggle-tag (tag &optional onoff)
14362 "Toggle the tag TAG for the current line.
14363 If ONOFF is `on' or `off', don't toggle but set to this state."
14364 (let (res current)
14365 (save-excursion
14366 (org-back-to-heading t)
14367 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14368 (point-at-eol) t)
14369 (progn
14370 (setq current (match-string 1))
14371 (replace-match ""))
14372 (setq current ""))
14373 (setq current (nreverse (org-split-string current ":")))
14374 (cond
14375 ((eq onoff 'on)
14376 (setq res t)
14377 (or (member tag current) (push tag current)))
14378 ((eq onoff 'off)
14379 (or (not (member tag current)) (setq current (delete tag current))))
14380 (t (if (member tag current)
14381 (setq current (delete tag current))
14382 (setq res t)
14383 (push tag current))))
14384 (end-of-line 1)
14385 (if current
14386 (progn
14387 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14388 (org-set-tags nil t))
14389 (delete-horizontal-space))
14390 (run-hooks 'org-after-tags-change-hook))
14391 res))
14393 (defun org-align-tags-here (to-col)
14394 ;; Assumes that this is a headline
14395 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14396 (beginning-of-line 1)
14397 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14398 (< pos (match-beginning 2)))
14399 (progn
14400 (setq tags-l (- (match-end 2) (match-beginning 2)))
14401 (goto-char (match-beginning 1))
14402 (insert " ")
14403 (delete-region (point) (1+ (match-beginning 2)))
14404 (setq ncol (max (current-column)
14405 (1+ col)
14406 (if (> to-col 0)
14407 to-col
14408 (- (abs to-col) tags-l))))
14409 (setq p (point))
14410 (insert (make-string (- ncol (current-column)) ?\ ))
14411 (setq ncol (current-column))
14412 (when indent-tabs-mode (tabify p (point-at-eol)))
14413 (org-move-to-column (min ncol col) t nil t))
14414 (goto-char pos))))
14416 (defun org-set-tags-command (&optional arg just-align)
14417 "Call the set-tags command for the current entry."
14418 (interactive "P")
14419 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14420 (org-set-tags arg just-align)
14421 (save-excursion
14422 (unless (and (org-region-active-p)
14423 org-loop-over-headlines-in-active-region)
14424 (org-back-to-heading t))
14425 (org-set-tags arg just-align))))
14427 (defun org-set-tags-to (data)
14428 "Set the tags of the current entry to DATA, replacing the current tags.
14429 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14430 If DATA is nil or the empty string, any tags will be removed."
14431 (interactive "sTags: ")
14432 (setq data
14433 (cond
14434 ((eq data nil) "")
14435 ((equal data "") "")
14436 ((stringp data)
14437 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14438 ":"))
14439 ((listp data)
14440 (concat ":" (mapconcat 'identity data ":") ":"))))
14441 (when data
14442 (save-excursion
14443 (org-back-to-heading t)
14444 (when (looking-at org-complex-heading-regexp)
14445 (if (match-end 5)
14446 (progn
14447 (goto-char (match-beginning 5))
14448 (insert data)
14449 (delete-region (point) (point-at-eol))
14450 (org-set-tags nil 'align))
14451 (goto-char (point-at-eol))
14452 (insert " " data)
14453 (org-set-tags nil 'align)))
14454 (beginning-of-line 1)
14455 (if (looking-at ".*?\\([ \t]+\\)$")
14456 (delete-region (match-beginning 1) (match-end 1))))))
14458 (defun org-align-all-tags ()
14459 "Align the tags i all headings."
14460 (interactive)
14461 (save-excursion
14462 (or (ignore-errors (org-back-to-heading t))
14463 (outline-next-heading))
14464 (if (org-at-heading-p)
14465 (org-set-tags t)
14466 (message "No headings"))))
14468 (defvar org-indent-indentation-per-level)
14469 (defun org-set-tags (&optional arg just-align)
14470 "Set the tags for the current headline.
14471 With prefix ARG, realign all tags in headings in the current buffer.
14472 When JUST-ALIGN is non-nil, only align tags.
14473 When JUST-ALIGN is 'ignore-column, align tags without trying to set
14474 the column by ignoring invisible text."
14475 (interactive "P")
14476 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14477 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14478 'region-start-level 'region))
14479 org-loop-over-headlines-in-active-region)
14480 (org-map-entries
14481 ;; We don't use ARG and JUST-ALIGN here because these args
14482 ;; are not useful when looping over headlines.
14483 `(org-set-tags)
14484 org-loop-over-headlines-in-active-region
14485 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14486 (let* ((re org-outline-regexp-bol)
14487 (current (unless arg (org-get-tags-string)))
14488 (col (current-column))
14489 (org-setting-tags t)
14490 table current-tags inherited-tags ; computed below when needed
14491 tags p0 c0 c1 rpl di tc level)
14492 (if arg
14493 (save-excursion
14494 (goto-char (point-min))
14495 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14496 (while (re-search-forward re nil t)
14497 (org-set-tags nil t)
14498 (end-of-line 1)))
14499 (message "All tags realigned to column %d" org-tags-column))
14500 (if just-align
14501 (setq tags current)
14502 ;; Get a new set of tags from the user
14503 (save-excursion
14504 (setq table (append org-tag-persistent-alist
14505 (or org-tag-alist (org-get-buffer-tags))
14506 (and
14507 org-complete-tags-always-offer-all-agenda-tags
14508 (org-global-tags-completion-table
14509 (org-agenda-files))))
14510 org-last-tags-completion-table table
14511 current-tags (org-split-string current ":")
14512 inherited-tags (nreverse
14513 (nthcdr (length current-tags)
14514 (nreverse (org-get-tags-at))))
14515 tags
14516 (if (or (eq t org-use-fast-tag-selection)
14517 (and org-use-fast-tag-selection
14518 (delq nil (mapcar 'cdr table))))
14519 (org-fast-tag-selection
14520 current-tags inherited-tags table
14521 (if org-fast-tag-selection-include-todo
14522 org-todo-key-alist))
14523 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14524 (org-trim
14525 (org-icompleting-read "Tags: "
14526 'org-tags-completion-function
14527 nil nil current 'org-tags-history))))))
14528 (while (string-match "[-+&]+" tags)
14529 ;; No boolean logic, just a list
14530 (setq tags (replace-match ":" t t tags))))
14532 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14534 (if org-tags-sort-function
14535 (setq tags (mapconcat 'identity
14536 (sort (org-split-string
14537 tags (org-re "[^[:alnum:]_@#%]+"))
14538 org-tags-sort-function) ":")))
14540 (if (string-match "\\`[\t ]*\\'" tags)
14541 (setq tags "")
14542 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14543 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14545 ;; Insert new tags at the correct column
14546 (beginning-of-line 1)
14547 (setq level (or (and (looking-at org-outline-regexp)
14548 (- (match-end 0) (point) 1))
14550 (cond
14551 ((and (equal current "") (equal tags "")))
14552 ((re-search-forward
14553 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14554 (point-at-eol) t)
14555 (if (equal tags "")
14556 (setq rpl "")
14557 (goto-char (match-beginning 0))
14558 (setq c0 (current-column)
14559 ;; compute offset for the case of org-indent-mode active
14560 di (if (org-bound-and-true-p org-indent-mode)
14561 (* (1- org-indent-indentation-per-level) (1- level))
14563 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14564 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14565 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14566 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14567 (replace-match rpl t t)
14568 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14569 tags)
14570 (t (error "Tags alignment failed")))
14571 (org-move-to-column col nil nil (not (eq just-align 'ignore-column)))
14572 (unless just-align
14573 (run-hooks 'org-after-tags-change-hook))))))
14575 (defun org-change-tag-in-region (beg end tag off)
14576 "Add or remove TAG for each entry in the region.
14577 This works in the agenda, and also in an org-mode buffer."
14578 (interactive
14579 (list (region-beginning) (region-end)
14580 (let ((org-last-tags-completion-table
14581 (if (derived-mode-p 'org-mode)
14582 (org-uniquify
14583 (delq nil (append (org-get-buffer-tags)
14584 (org-global-tags-completion-table))))
14585 (org-global-tags-completion-table))))
14586 (org-icompleting-read
14587 "Tag: " 'org-tags-completion-function nil nil nil
14588 'org-tags-history))
14589 (progn
14590 (message "[s]et or [r]emove? ")
14591 (equal (read-char-exclusive) ?r))))
14592 (if (fboundp 'deactivate-mark) (deactivate-mark))
14593 (let ((agendap (equal major-mode 'org-agenda-mode))
14594 l1 l2 m buf pos newhead (cnt 0))
14595 (goto-char end)
14596 (setq l2 (1- (org-current-line)))
14597 (goto-char beg)
14598 (setq l1 (org-current-line))
14599 (loop for l from l1 to l2 do
14600 (org-goto-line l)
14601 (setq m (get-text-property (point) 'org-hd-marker))
14602 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14603 (and agendap m))
14604 (setq buf (if agendap (marker-buffer m) (current-buffer))
14605 pos (if agendap m (point)))
14606 (with-current-buffer buf
14607 (save-excursion
14608 (save-restriction
14609 (goto-char pos)
14610 (setq cnt (1+ cnt))
14611 (org-toggle-tag tag (if off 'off 'on))
14612 (setq newhead (org-get-heading)))))
14613 (and agendap (org-agenda-change-all-lines newhead m))))
14614 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14616 (defun org-tags-completion-function (string predicate &optional flag)
14617 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14618 (confirm (lambda (x) (stringp (car x)))))
14619 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14620 (setq s1 (match-string 1 string)
14621 s2 (match-string 2 string))
14622 (setq s1 "" s2 string))
14623 (cond
14624 ((eq flag nil)
14625 ;; try completion
14626 (setq rtn (try-completion s2 ctable confirm))
14627 (if (stringp rtn)
14628 (setq rtn
14629 (concat s1 s2 (substring rtn (length s2))
14630 (if (and org-add-colon-after-tag-completion
14631 (assoc rtn ctable))
14632 ":" ""))))
14633 rtn)
14634 ((eq flag t)
14635 ;; all-completions
14636 (all-completions s2 ctable confirm))
14637 ((eq flag 'lambda)
14638 ;; exact match?
14639 (assoc s2 ctable)))))
14641 (defun org-fast-tag-insert (kwd tags face &optional end)
14642 "Insert KDW, and the TAGS, the latter with face FACE.
14643 Also insert END."
14644 (insert (format "%-12s" (concat kwd ":"))
14645 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14646 (or end "")))
14648 (defun org-fast-tag-show-exit (flag)
14649 (save-excursion
14650 (org-goto-line 3)
14651 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14652 (replace-match ""))
14653 (when flag
14654 (end-of-line 1)
14655 (org-move-to-column (- (window-width) 19) t)
14656 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14658 (defun org-set-current-tags-overlay (current prefix)
14659 "Add an overlay to CURRENT tag with PREFIX."
14660 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14661 (if (featurep 'xemacs)
14662 (org-overlay-display org-tags-overlay (concat prefix s)
14663 'secondary-selection)
14664 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14665 (org-overlay-display org-tags-overlay (concat prefix s)))))
14667 (defvar org-last-tag-selection-key nil)
14668 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14669 "Fast tag selection with single keys.
14670 CURRENT is the current list of tags in the headline, INHERITED is the
14671 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14672 possibly with grouping information. TODO-TABLE is a similar table with
14673 TODO keywords, should these have keys assigned to them.
14674 If the keys are nil, a-z are automatically assigned.
14675 Returns the new tags string, or nil to not change the current settings."
14676 (let* ((fulltable (append table todo-table))
14677 (maxlen (apply 'max (mapcar
14678 (lambda (x)
14679 (if (stringp (car x)) (string-width (car x)) 0))
14680 fulltable)))
14681 (buf (current-buffer))
14682 (expert (eq org-fast-tag-selection-single-key 'expert))
14683 (buffer-tags nil)
14684 (fwidth (+ maxlen 3 1 3))
14685 (ncol (/ (- (window-width) 4) fwidth))
14686 (i-face 'org-done)
14687 (c-face 'org-todo)
14688 tg cnt e c char c1 c2 ntable tbl rtn
14689 ov-start ov-end ov-prefix
14690 (exit-after-next org-fast-tag-selection-single-key)
14691 (done-keywords org-done-keywords)
14692 groups ingroup)
14693 (save-excursion
14694 (beginning-of-line 1)
14695 (if (looking-at
14696 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14697 (setq ov-start (match-beginning 1)
14698 ov-end (match-end 1)
14699 ov-prefix "")
14700 (setq ov-start (1- (point-at-eol))
14701 ov-end (1+ ov-start))
14702 (skip-chars-forward "^\n\r")
14703 (setq ov-prefix
14704 (concat
14705 (buffer-substring (1- (point)) (point))
14706 (if (> (current-column) org-tags-column)
14708 (make-string (- org-tags-column (current-column)) ?\ ))))))
14709 (move-overlay org-tags-overlay ov-start ov-end)
14710 (save-window-excursion
14711 (if expert
14712 (set-buffer (get-buffer-create " *Org tags*"))
14713 (delete-other-windows)
14714 (split-window-vertically)
14715 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14716 (erase-buffer)
14717 (org-set-local 'org-done-keywords done-keywords)
14718 (org-fast-tag-insert "Inherited" inherited i-face "\n")
14719 (org-fast-tag-insert "Current" current c-face "\n\n")
14720 (org-fast-tag-show-exit exit-after-next)
14721 (org-set-current-tags-overlay current ov-prefix)
14722 (setq tbl fulltable char ?a cnt 0)
14723 (while (setq e (pop tbl))
14724 (cond
14725 ((equal (car e) :startgroup)
14726 (push '() groups) (setq ingroup t)
14727 (when (not (= cnt 0))
14728 (setq cnt 0)
14729 (insert "\n"))
14730 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14731 ((equal (car e) :endgroup)
14732 (setq ingroup nil cnt 0)
14733 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
14734 ((equal e '(:newline))
14735 (when (not (= cnt 0))
14736 (setq cnt 0)
14737 (insert "\n")
14738 (setq e (car tbl))
14739 (while (equal (car tbl) '(:newline))
14740 (insert "\n")
14741 (setq tbl (cdr tbl)))))
14742 ((equal e '(:grouptags)) nil)
14744 (setq tg (copy-sequence (car e)) c2 nil)
14745 (if (cdr e)
14746 (setq c (cdr e))
14747 ;; automatically assign a character.
14748 (setq c1 (string-to-char
14749 (downcase (substring
14750 tg (if (= (string-to-char tg) ?@) 1 0)))))
14751 (if (or (rassoc c1 ntable) (rassoc c1 table))
14752 (while (or (rassoc char ntable) (rassoc char table))
14753 (setq char (1+ char)))
14754 (setq c2 c1))
14755 (setq c (or c2 char)))
14756 (if ingroup (push tg (car groups)))
14757 (setq tg (org-add-props tg nil 'face
14758 (cond
14759 ((not (assoc tg table))
14760 (org-get-todo-face tg))
14761 ((member tg current) c-face)
14762 ((member tg inherited) i-face))))
14763 (if (equal (caar tbl) :grouptags)
14764 (org-add-props tg nil 'face 'org-tag-group))
14765 (if (and (= cnt 0) (not ingroup)) (insert " "))
14766 (insert "[" c "] " tg (make-string
14767 (- fwidth 4 (length tg)) ?\ ))
14768 (push (cons tg c) ntable)
14769 (when (= (setq cnt (1+ cnt)) ncol)
14770 (insert "\n")
14771 (if ingroup (insert " "))
14772 (setq cnt 0)))))
14773 (setq ntable (nreverse ntable))
14774 (insert "\n")
14775 (goto-char (point-min))
14776 (if (not expert) (org-fit-window-to-buffer))
14777 (setq rtn
14778 (catch 'exit
14779 (while t
14780 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14781 (if (not groups) "no " "")
14782 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14783 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14784 (setq org-last-tag-selection-key c)
14785 (cond
14786 ((= c ?\r) (throw 'exit t))
14787 ((= c ?!)
14788 (setq groups (not groups))
14789 (goto-char (point-min))
14790 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14791 ((= c ?\C-c)
14792 (if (not expert)
14793 (org-fast-tag-show-exit
14794 (setq exit-after-next (not exit-after-next)))
14795 (setq expert nil)
14796 (delete-other-windows)
14797 (set-window-buffer (split-window-vertically) " *Org tags*")
14798 (org-switch-to-buffer-other-window " *Org tags*")
14799 (org-fit-window-to-buffer)))
14800 ((or (= c ?\C-g)
14801 (and (= c ?q) (not (rassoc c ntable))))
14802 (org-detach-overlay org-tags-overlay)
14803 (setq quit-flag t))
14804 ((= c ?\ )
14805 (setq current nil)
14806 (if exit-after-next (setq exit-after-next 'now)))
14807 ((= c ?\t)
14808 (condition-case nil
14809 (setq tg (org-icompleting-read
14810 "Tag: "
14811 (or buffer-tags
14812 (with-current-buffer buf
14813 (org-get-buffer-tags)))))
14814 (quit (setq tg "")))
14815 (when (string-match "\\S-" tg)
14816 (add-to-list 'buffer-tags (list tg))
14817 (if (member tg current)
14818 (setq current (delete tg current))
14819 (push tg current)))
14820 (if exit-after-next (setq exit-after-next 'now)))
14821 ((setq e (rassoc c todo-table) tg (car e))
14822 (with-current-buffer buf
14823 (save-excursion (org-todo tg)))
14824 (if exit-after-next (setq exit-after-next 'now)))
14825 ((setq e (rassoc c ntable) tg (car e))
14826 (if (member tg current)
14827 (setq current (delete tg current))
14828 (loop for g in groups do
14829 (if (member tg g)
14830 (mapc (lambda (x)
14831 (setq current (delete x current)))
14832 g)))
14833 (push tg current))
14834 (if exit-after-next (setq exit-after-next 'now))))
14836 ;; Create a sorted list
14837 (setq current
14838 (sort current
14839 (lambda (a b)
14840 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14841 (if (eq exit-after-next 'now) (throw 'exit t))
14842 (goto-char (point-min))
14843 (beginning-of-line 2)
14844 (delete-region (point) (point-at-eol))
14845 (org-fast-tag-insert "Current" current c-face)
14846 (org-set-current-tags-overlay current ov-prefix)
14847 (while (re-search-forward
14848 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
14849 (setq tg (match-string 1))
14850 (add-text-properties
14851 (match-beginning 1) (match-end 1)
14852 (list 'face
14853 (cond
14854 ((member tg current) c-face)
14855 ((member tg inherited) i-face)
14856 (t (get-text-property (match-beginning 1) 'face))))))
14857 (goto-char (point-min)))))
14858 (org-detach-overlay org-tags-overlay)
14859 (if rtn
14860 (mapconcat 'identity current ":")
14861 nil))))
14863 (defun org-get-tags-string ()
14864 "Get the TAGS string in the current headline."
14865 (unless (org-at-heading-p t)
14866 (user-error "Not on a heading"))
14867 (save-excursion
14868 (beginning-of-line 1)
14869 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14870 (org-match-string-no-properties 1)
14871 "")))
14873 (defun org-get-tags ()
14874 "Get the list of tags specified in the current headline."
14875 (org-split-string (org-get-tags-string) ":"))
14877 (defun org-get-buffer-tags ()
14878 "Get a table of all tags used in the buffer, for completion."
14879 (let (tags)
14880 (save-excursion
14881 (goto-char (point-min))
14882 (while (re-search-forward
14883 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
14884 (when (equal (char-after (point-at-bol 0)) ?*)
14885 (mapc (lambda (x) (add-to-list 'tags x))
14886 (org-split-string (org-match-string-no-properties 1) ":")))))
14887 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14888 (mapcar 'list tags)))
14890 ;;;; The mapping API
14892 (defun org-map-entries (func &optional match scope &rest skip)
14893 "Call FUNC at each headline selected by MATCH in SCOPE.
14895 FUNC is a function or a lisp form. The function will be called without
14896 arguments, with the cursor positioned at the beginning of the headline.
14897 The return values of all calls to the function will be collected and
14898 returned as a list.
14900 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14901 does not need to preserve point. After evaluation, the cursor will be
14902 moved to the end of the line (presumably of the headline of the
14903 processed entry) and search continues from there. Under some
14904 circumstances, this may not produce the wanted results. For example,
14905 if you have removed (e.g. archived) the current (sub)tree it could
14906 mean that the next entry will be skipped entirely. In such cases, you
14907 can specify the position from where search should continue by making
14908 FUNC set the variable `org-map-continue-from' to the desired buffer
14909 position.
14911 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14912 Only headlines that are matched by this query will be considered during
14913 the iteration. When MATCH is nil or t, all headlines will be
14914 visited by the iteration.
14916 SCOPE determines the scope of this command. It can be any of:
14918 nil The current buffer, respecting the restriction if any
14919 tree The subtree started with the entry at point
14920 region The entries within the active region, if any
14921 region-start-level
14922 The entries within the active region, but only those at
14923 the same level than the first one.
14924 file The current buffer, without restriction
14925 file-with-archives
14926 The current buffer, and any archives associated with it
14927 agenda All agenda files
14928 agenda-with-archives
14929 All agenda files with any archive files associated with them
14930 \(file1 file2 ...)
14931 If this is a list, all files in the list will be scanned
14933 The remaining args are treated as settings for the skipping facilities of
14934 the scanner. The following items can be given here:
14936 archive skip trees with the archive tag
14937 comment skip trees with the COMMENT keyword
14938 function or Emacs Lisp form:
14939 will be used as value for `org-agenda-skip-function', so
14940 whenever the function returns a position, FUNC will not be
14941 called for that entry and search will continue from the
14942 position returned
14944 If your function needs to retrieve the tags including inherited tags
14945 at the *current* entry, you can use the value of the variable
14946 `org-scanner-tags' which will be much faster than getting the value
14947 with `org-get-tags-at'. If your function gets properties with
14948 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14949 to t around the call to `org-entry-properties' to get the same speedup.
14950 Note that if your function moves around to retrieve tags and properties at
14951 a *different* entry, you cannot use these techniques."
14952 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14953 (not (org-region-active-p)))
14954 (let* ((org-agenda-archives-mode nil) ; just to make sure
14955 (org-agenda-skip-archived-trees (memq 'archive skip))
14956 (org-agenda-skip-comment-trees (memq 'comment skip))
14957 (org-agenda-skip-function
14958 (car (org-delete-all '(comment archive) skip)))
14959 (org-tags-match-list-sublevels t)
14960 (start-level (eq scope 'region-start-level))
14961 matcher file res
14962 org-todo-keywords-for-agenda
14963 org-done-keywords-for-agenda
14964 org-todo-keyword-alist-for-agenda
14965 org-drawers-for-agenda
14966 org-tag-alist-for-agenda
14967 todo-only)
14969 (cond
14970 ((eq match t) (setq matcher t))
14971 ((eq match nil) (setq matcher t))
14972 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14974 (save-excursion
14975 (save-restriction
14976 (cond ((eq scope 'tree)
14977 (org-back-to-heading t)
14978 (org-narrow-to-subtree)
14979 (setq scope nil))
14980 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14981 (org-region-active-p))
14982 ;; If needed, set start-level to a string like "2"
14983 (when start-level
14984 (save-excursion
14985 (goto-char (region-beginning))
14986 (unless (org-at-heading-p) (outline-next-heading))
14987 (setq start-level (org-current-level))))
14988 (narrow-to-region (region-beginning)
14989 (save-excursion
14990 (goto-char (region-end))
14991 (unless (and (bolp) (org-at-heading-p))
14992 (outline-next-heading))
14993 (point)))
14994 (setq scope nil)))
14996 (if (not scope)
14997 (progn
14998 (org-agenda-prepare-buffers
14999 (list (buffer-file-name (current-buffer))))
15000 (setq res (org-scan-tags func matcher todo-only start-level)))
15001 ;; Get the right scope
15002 (cond
15003 ((and scope (listp scope) (symbolp (car scope)))
15004 (setq scope (eval scope)))
15005 ((eq scope 'agenda)
15006 (setq scope (org-agenda-files t)))
15007 ((eq scope 'agenda-with-archives)
15008 (setq scope (org-agenda-files t))
15009 (setq scope (org-add-archive-files scope)))
15010 ((eq scope 'file)
15011 (setq scope (list (buffer-file-name))))
15012 ((eq scope 'file-with-archives)
15013 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15014 (org-agenda-prepare-buffers scope)
15015 (while (setq file (pop scope))
15016 (with-current-buffer (org-find-base-buffer-visiting file)
15017 (save-excursion
15018 (save-restriction
15019 (widen)
15020 (goto-char (point-min))
15021 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15022 res)))
15024 ;;;; Properties
15026 ;;; Setting and retrieving properties
15028 (defconst org-special-properties
15029 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15030 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15031 "The special properties valid in Org-mode.
15033 These are properties that are not defined in the property drawer,
15034 but in some other way.")
15036 (defconst org-default-properties
15037 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15038 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15039 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15040 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15041 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15042 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15043 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15044 "Some properties that are used by Org-mode for various purposes.
15045 Being in this list makes sure that they are offered for completion.")
15047 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
15048 "Regular expression matching the first line of a property drawer.")
15050 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
15051 "Regular expression matching the last line of a property drawer.")
15053 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
15054 "Regular expression matching the first line of a property drawer.")
15056 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
15057 "Regular expression matching the first line of a property drawer.")
15059 (defconst org-property-drawer-re
15060 (concat "\\(" org-property-start-re "\\)[^\000]*\\("
15061 org-property-end-re "\\)\n?")
15062 "Matches an entire property drawer.")
15064 (defconst org-clock-drawer-re
15065 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*\\("
15066 org-property-end-re "\\)\n?")
15067 "Matches an entire clock drawer.")
15069 (defun org-property-action ()
15070 "Do an action on properties."
15071 (interactive)
15072 (let (c)
15073 (org-at-property-p)
15074 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15075 (setq c (read-char-exclusive))
15076 (cond
15077 ((equal c ?s)
15078 (call-interactively 'org-set-property))
15079 ((equal c ?d)
15080 (call-interactively 'org-delete-property))
15081 ((equal c ?D)
15082 (call-interactively 'org-delete-property-globally))
15083 ((equal c ?c)
15084 (call-interactively 'org-compute-property-at-point))
15085 (t (user-error "No such property action %c" c)))))
15087 (defun org-inc-effort ()
15088 "Increment the value of the effort property in the current entry."
15089 (interactive)
15090 (org-set-effort nil t))
15092 (defvar org-clock-effort) ;; Defined in org-clock.el
15093 (defvar org-clock-current-task) ;; Defined in org-clock.el
15094 (defun org-set-effort (&optional value increment)
15095 "Set the effort property of the current entry.
15096 With numerical prefix arg, use the nth allowed value, 0 stands for the
15097 10th allowed value.
15099 When INCREMENT is non-nil, set the property to the next allowed value."
15100 (interactive "P")
15101 (if (equal value 0) (setq value 10))
15102 (let* ((completion-ignore-case t)
15103 (prop org-effort-property)
15104 (cur (org-entry-get nil prop))
15105 (allowed (org-property-get-allowed-values nil prop 'table))
15106 (existing (mapcar 'list (org-property-values prop)))
15107 (heading (nth 4 (org-heading-components)))
15109 (val (cond
15110 ((stringp value) value)
15111 ((and allowed (integerp value))
15112 (or (car (nth (1- value) allowed))
15113 (car (org-last allowed))))
15114 ((and allowed increment)
15115 (or (caadr (member (list cur) allowed))
15116 (user-error "Allowed effort values are not set")))
15117 (allowed
15118 (message "Select 1-9,0, [RET%s]: %s"
15119 (if cur (concat "=" cur) "")
15120 (mapconcat 'car allowed " "))
15121 (setq rpl (read-char-exclusive))
15122 (if (equal rpl ?\r)
15124 (setq rpl (- rpl ?0))
15125 (if (equal rpl 0) (setq rpl 10))
15126 (if (and (> rpl 0) (<= rpl (length allowed)))
15127 (car (nth (1- rpl) allowed))
15128 (org-completing-read "Effort: " allowed nil))))
15130 (let (org-completion-use-ido org-completion-use-iswitchb)
15131 (org-completing-read
15132 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15133 (concat "[" cur "]") "")
15134 ": ")
15135 existing nil nil "" nil cur))))))
15136 (unless (equal (org-entry-get nil prop) val)
15137 (org-entry-put nil prop val))
15138 (save-excursion
15139 (org-back-to-heading t)
15140 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15141 (when (string= heading org-clock-current-task)
15142 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15143 (org-clock-update-mode-line))
15144 (message "%s is now %s" prop val)))
15146 (defun org-at-property-p ()
15147 "Is cursor inside a property drawer?"
15148 (save-excursion
15149 (when (equal 'node-property (car (org-element-at-point)))
15150 (beginning-of-line 1)
15151 (looking-at org-property-re))))
15153 (defun org-get-property-block (&optional beg end force)
15154 "Return the (beg . end) range of the body of the property drawer.
15155 BEG and END are the beginning and end of the current subtree, or of
15156 the part before the first headline. If they are not given, they will
15157 be found. If the drawer does not exist and FORCE is non-nil, create
15158 the drawer."
15159 (catch 'exit
15160 (save-excursion
15161 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15162 (progn (org-back-to-heading t) (point))))
15163 (end (or end (and (not (outline-next-heading)) (point-max))
15164 (point))))
15165 (goto-char beg)
15166 (if (re-search-forward org-property-start-re end t)
15167 (setq beg (1+ (match-end 0)))
15168 (if force
15169 (save-excursion
15170 (org-insert-property-drawer)
15171 (setq end (progn (outline-next-heading) (point))))
15172 (throw 'exit nil))
15173 (goto-char beg)
15174 (if (re-search-forward org-property-start-re end t)
15175 (setq beg (1+ (match-end 0)))))
15176 (if (re-search-forward org-property-end-re end t)
15177 (setq end (match-beginning 0))
15178 (or force (throw 'exit nil))
15179 (goto-char beg)
15180 (setq end beg)
15181 (org-indent-line)
15182 (insert ":END:\n"))
15183 (cons beg end)))))
15185 (defun org-entry-properties (&optional pom which specific)
15186 "Get all properties of the entry at point-or-marker POM.
15187 This includes the TODO keyword, the tags, time strings for deadline,
15188 scheduled, and clocking, and any additional properties defined in the
15189 entry. The return value is an alist, keys may occur multiple times
15190 if the property key was used several times.
15191 POM may also be nil, in which case the current entry is used.
15192 If WHICH is nil or `all', get all properties. If WHICH is
15193 `special' or `standard', only get that subclass. If WHICH
15194 is a string only get exactly this property. SPECIFIC can be a string, the
15195 specific property we are interested in. Specifying it can speed
15196 things up because then unnecessary parsing is avoided."
15197 (setq which (or which 'all))
15198 (org-with-wide-buffer
15199 (org-with-point-at pom
15200 (let ((clockstr (substring org-clock-string 0 -1))
15201 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15202 (case-fold-search nil)
15203 beg end range props sum-props key key1 value string clocksum clocksumt)
15204 (when (and (derived-mode-p 'org-mode)
15205 (ignore-errors (org-back-to-heading t)))
15206 (setq beg (point))
15207 (setq sum-props (get-text-property (point) 'org-summaries))
15208 (setq clocksum (get-text-property (point) :org-clock-minutes)
15209 clocksumt (get-text-property (point) :org-clock-minutes-today))
15210 (outline-next-heading)
15211 (setq end (point))
15212 (when (memq which '(all special))
15213 ;; Get the special properties, like TODO and tags
15214 (goto-char beg)
15215 (when (and (or (not specific) (string= specific "TODO"))
15216 (looking-at org-todo-line-regexp) (match-end 2))
15217 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15218 (when (and (or (not specific) (string= specific "PRIORITY"))
15219 (looking-at org-priority-regexp))
15220 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15221 (when (or (not specific) (string= specific "FILE"))
15222 (push (cons "FILE" buffer-file-name) props))
15223 (when (and (or (not specific) (string= specific "TAGS"))
15224 (setq value (org-get-tags-string))
15225 (string-match "\\S-" value))
15226 (push (cons "TAGS" value) props))
15227 (when (and (or (not specific) (string= specific "ALLTAGS"))
15228 (setq value (org-get-tags-at)))
15229 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15230 ":"))
15231 props))
15232 (when (or (not specific) (string= specific "BLOCKED"))
15233 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15234 (when (or (not specific)
15235 (member specific
15236 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15237 "TIMESTAMP" "TIMESTAMP_IA")))
15238 (catch 'match
15239 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15240 (setq key (if (match-end 1)
15241 (substring (org-match-string-no-properties 1)
15242 0 -1))
15243 string (if (equal key clockstr)
15244 (org-trim
15245 (buffer-substring-no-properties
15246 (match-beginning 3) (goto-char
15247 (point-at-eol))))
15248 (substring (org-match-string-no-properties 3)
15249 1 -1)))
15250 ;; Get the correct property name from the key. This is
15251 ;; necessary if the user has configured time keywords.
15252 (setq key1 (concat key ":"))
15253 (cond
15254 ((not key)
15255 (setq key
15256 (if (= (char-after (match-beginning 3)) ?\[)
15257 "TIMESTAMP_IA" "TIMESTAMP")))
15258 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15259 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15260 ((equal key1 org-closed-string) (setq key "CLOSED"))
15261 ((equal key1 org-clock-string) (setq key "CLOCK")))
15262 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15263 (progn
15264 (push (cons key string) props)
15265 ;; no need to search further if match is found
15266 (throw 'match t))
15267 (when (or (equal key "CLOCK") (not (assoc key props)))
15268 (push (cons key string) props)))))))
15270 (when (memq which '(all standard))
15271 ;; Get the standard properties, like :PROP: ...
15272 (setq range (org-get-property-block beg end))
15273 (when range
15274 (goto-char (car range))
15275 (while (re-search-forward org-property-re
15276 (cdr range) t)
15277 (setq key (org-match-string-no-properties 2)
15278 value (org-trim (or (org-match-string-no-properties 3) "")))
15279 (unless (member key excluded)
15280 (push (cons key (or value "")) props)))))
15281 (if clocksum
15282 (push (cons "CLOCKSUM"
15283 (org-columns-number-to-string (/ (float clocksum) 60.)
15284 'add_times))
15285 props))
15286 (if clocksumt
15287 (push (cons "CLOCKSUM_T"
15288 (org-columns-number-to-string (/ (float clocksumt) 60.)
15289 'add_times))
15290 props))
15291 (unless (assoc "CATEGORY" props)
15292 (push (cons "CATEGORY" (org-get-category)) props))
15293 (append sum-props (nreverse props)))))))
15295 (defun org-entry-get (pom property &optional inherit literal-nil)
15296 "Get value of PROPERTY for entry or content at point-or-marker POM.
15297 If INHERIT is non-nil and the entry does not have the property,
15298 then also check higher levels of the hierarchy.
15299 If INHERIT is the symbol `selective', use inheritance only if the setting
15300 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15301 If the property is present but empty, the return value is the empty string.
15302 If the property is not present at all, nil is returned.
15304 Return the value as a string.
15306 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15307 do not interpret it as the list atom nil. This is used for inheritance
15308 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15309 (org-with-point-at pom
15310 (if (and inherit (if (eq inherit 'selective)
15311 (org-property-inherit-p property)
15313 (org-entry-get-with-inheritance property literal-nil)
15314 (if (member property org-special-properties)
15315 ;; We need a special property. Use `org-entry-properties'
15316 ;; to retrieve it, but specify the wanted property
15317 (cdr (assoc property (org-entry-properties nil 'special property)))
15318 (org-with-wide-buffer
15319 (let ((range (org-get-property-block)))
15320 (when (and range (not (eq (car range) (cdr range))))
15321 (let* ((props
15322 (list (or (assoc property org-file-properties)
15323 (assoc property org-global-properties)
15324 (assoc property org-global-properties-fixed))))
15325 (ap (lambda (key)
15326 (when (re-search-forward
15327 (org-re-property key) (cdr range) t)
15328 (setq props
15329 (org-update-property-plist
15331 (if (match-end 3)
15332 (org-match-string-no-properties 3) "")
15333 props)))))
15334 val)
15335 (goto-char (car range))
15336 (funcall ap property)
15337 (goto-char (car range))
15338 (while (funcall ap (concat property "+")))
15339 (setq val (cdr (assoc property props)))
15340 (when val (if literal-nil val (org-not-nil val)))))))))))
15342 (defun org-property-or-variable-value (var &optional inherit)
15343 "Check if there is a property fixing the value of VAR.
15344 If yes, return this value. If not, return the current value of the variable."
15345 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15346 (if (and prop (stringp prop) (string-match "\\S-" prop))
15347 (read prop)
15348 (symbol-value var))))
15350 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15351 "Delete the property PROPERTY from entry at point-or-marker POM.
15352 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15353 an empty drawer to delete."
15354 (org-with-point-at pom
15355 (if (member property org-special-properties)
15356 nil ; cannot delete these properties.
15357 (let ((range (org-get-property-block)))
15358 (if (and range
15359 (goto-char (car range))
15360 (re-search-forward
15361 (org-re-property property)
15362 (cdr range) t))
15363 (progn
15364 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15365 (and delete-empty-drawer
15366 (org-remove-empty-drawer-at
15367 delete-empty-drawer (car range)))
15369 nil)))))
15371 ;; Multi-values properties are properties that contain multiple values
15372 ;; These values are assumed to be single words, separated by whitespace.
15373 (defun org-entry-add-to-multivalued-property (pom property value)
15374 "Add VALUE to the 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 (unless (member value values)
15379 (setq values (append values (list value)))
15380 (org-entry-put pom property
15381 (mapconcat 'identity values " ")))))
15383 (defun org-entry-remove-from-multivalued-property (pom property value)
15384 "Remove VALUE from 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 (when (member value values)
15389 (setq values (delete value values))
15390 (org-entry-put pom property
15391 (mapconcat 'identity values " ")))))
15393 (defun org-entry-member-in-multivalued-property (pom property value)
15394 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15395 (let* ((old (org-entry-get pom property))
15396 (values (and old (org-split-string old "[ \t]"))))
15397 (setq value (org-entry-protect-space value))
15398 (member value values)))
15400 (defun org-entry-get-multivalued-property (pom property)
15401 "Return a list of values in a multivalued property."
15402 (let* ((value (org-entry-get pom property))
15403 (values (and value (org-split-string value "[ \t]"))))
15404 (mapcar 'org-entry-restore-space values)))
15406 (defun org-entry-put-multivalued-property (pom property &rest values)
15407 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15408 VALUES should be a list of strings. Spaces will be protected."
15409 (org-entry-put pom property
15410 (mapconcat 'org-entry-protect-space values " "))
15411 (let* ((value (org-entry-get pom property))
15412 (values (and value (org-split-string value "[ \t]"))))
15413 (mapcar 'org-entry-restore-space values)))
15415 (defun org-entry-protect-space (s)
15416 "Protect spaces and newline in string S."
15417 (while (string-match " " s)
15418 (setq s (replace-match "%20" t t s)))
15419 (while (string-match "\n" s)
15420 (setq s (replace-match "%0A" t t s)))
15423 (defun org-entry-restore-space (s)
15424 "Restore spaces and newline in string S."
15425 (while (string-match "%20" s)
15426 (setq s (replace-match " " t t s)))
15427 (while (string-match "%0A" s)
15428 (setq s (replace-match "\n" t t s)))
15431 (defvar org-entry-property-inherited-from (make-marker)
15432 "Marker pointing to the entry from where a property was inherited.
15433 Each call to `org-entry-get-with-inheritance' will set this marker to the
15434 location of the entry where the inheritance search matched. If there was
15435 no match, the marker will point nowhere.
15436 Note that also `org-entry-get' calls this function, if the INHERIT flag
15437 is set.")
15439 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15440 "Get PROPERTY of entry or content at point, search higher levels if needed.
15441 The search will stop at the first ancestor which has the property defined.
15442 If the value found is \"nil\", return nil to show that the property
15443 should be considered as undefined (this is the meaning of nil here).
15444 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15445 (move-marker org-entry-property-inherited-from nil)
15446 (let (tmp)
15447 (save-excursion
15448 (save-restriction
15449 (widen)
15450 (catch 'ex
15451 (while t
15452 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15453 (or (ignore-errors (org-back-to-heading t))
15454 (goto-char (point-min)))
15455 (move-marker org-entry-property-inherited-from (point))
15456 (throw 'ex tmp))
15457 (or (ignore-errors (org-up-heading-safe))
15458 (throw 'ex nil))))))
15459 (setq tmp (or tmp
15460 (cdr (assoc property org-file-properties))
15461 (cdr (assoc property org-global-properties))
15462 (cdr (assoc property org-global-properties-fixed))))
15463 (if literal-nil tmp (org-not-nil tmp))))
15465 (defvar org-property-changed-functions nil
15466 "Hook called when the value of a property has changed.
15467 Each hook function should accept two arguments, the name of the property
15468 and the new value.")
15470 (defun org-entry-put (pom property value)
15471 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15472 If the value is `nil', it is converted to the empty string.
15473 If it is not a string, an error is raised."
15474 (cond ((null value) (setq value ""))
15475 ((not (stringp value))
15476 (error "Properties values should be strings.")))
15477 (org-with-point-at pom
15478 (org-back-to-heading t)
15479 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15480 range)
15481 (cond
15482 ((equal property "TODO")
15483 (when (and (string-match "\\S-" value)
15484 (not (member value org-todo-keywords-1)))
15485 (user-error "\"%s\" is not a valid TODO state" value))
15486 (if (or (not value)
15487 (not (string-match "\\S-" value)))
15488 (setq value 'none))
15489 (org-todo value)
15490 (org-set-tags nil 'align))
15491 ((equal property "PRIORITY")
15492 (org-priority (if (and value (string-match "\\S-" value))
15493 (string-to-char value) ?\ ))
15494 (org-set-tags nil 'align))
15495 ((equal property "CLOCKSUM")
15496 (if (not (re-search-forward
15497 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15498 (error "Cannot find a clock log")
15499 (goto-char (- (match-end 1) 2))
15500 (cond
15501 ((eq value 'earlier) (org-timestamp-down))
15502 ((eq value 'later) (org-timestamp-up)))
15503 (org-clock-sum-current-item)))
15504 ((equal property "SCHEDULED")
15505 (if (re-search-forward org-scheduled-time-regexp end t)
15506 (cond
15507 ((eq value 'earlier) (org-timestamp-change -1 'day))
15508 ((eq value 'later) (org-timestamp-change 1 'day))
15509 (t (call-interactively 'org-schedule)))
15510 (call-interactively 'org-schedule)))
15511 ((equal property "DEADLINE")
15512 (if (re-search-forward org-deadline-time-regexp end t)
15513 (cond
15514 ((eq value 'earlier) (org-timestamp-change -1 'day))
15515 ((eq value 'later) (org-timestamp-change 1 'day))
15516 (t (call-interactively 'org-deadline)))
15517 (call-interactively 'org-deadline)))
15518 ((member property org-special-properties)
15519 (error "The %s property can not yet be set with `org-entry-put'"
15520 property))
15521 (t ; a non-special property
15522 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15523 (setq range (org-get-property-block beg end 'force))
15524 (goto-char (car range))
15525 (if (re-search-forward
15526 (org-re-property property) (cdr range) t)
15527 (progn
15528 (delete-region (match-beginning 0) (match-end 0))
15529 (goto-char (match-beginning 0)))
15530 (goto-char (cdr range))
15531 (insert "\n")
15532 (backward-char 1)
15533 (org-indent-line))
15534 (insert ":" property ":")
15535 (and value (insert " " value))
15536 (org-indent-line)))))
15537 (run-hook-with-args 'org-property-changed-functions property value)))
15539 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15540 "Get all property keys in the current buffer.
15541 With INCLUDE-SPECIALS, also list the special properties that reflect things
15542 like tags and TODO state.
15543 With INCLUDE-DEFAULTS, also include properties that has special meaning
15544 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15545 and others.
15546 With INCLUDE-COLUMNS, also include property names given in COLUMN
15547 formats in the current buffer."
15548 (let (rtn range cfmt s p)
15549 (save-excursion
15550 (save-restriction
15551 (widen)
15552 (goto-char (point-min))
15553 (while (re-search-forward org-property-start-re nil t)
15554 (setq range (org-get-property-block))
15555 (goto-char (car range))
15556 (while (re-search-forward org-property-re
15557 (cdr range) t)
15558 (add-to-list 'rtn (org-match-string-no-properties 2)))
15559 (outline-next-heading))))
15561 (when include-specials
15562 (setq rtn (append org-special-properties rtn)))
15564 (when include-defaults
15565 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15566 (add-to-list 'rtn org-effort-property))
15568 (when include-columns
15569 (save-excursion
15570 (save-restriction
15571 (widen)
15572 (goto-char (point-min))
15573 (while (re-search-forward
15574 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15575 nil t)
15576 (setq cfmt (match-string 2) s 0)
15577 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15578 cfmt s)
15579 (setq s (match-end 0)
15580 p (match-string 1 cfmt))
15581 (unless (or (equal p "ITEM")
15582 (member p org-special-properties))
15583 (add-to-list 'rtn (match-string 1 cfmt))))))))
15585 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15587 (defun org-property-values (key)
15588 "Return a list of all values of property KEY in the current buffer."
15589 (save-excursion
15590 (save-restriction
15591 (widen)
15592 (goto-char (point-min))
15593 (let ((re (org-re-property key))
15594 values)
15595 (while (re-search-forward re nil t)
15596 (add-to-list 'values (org-trim (match-string 3))))
15597 (delete "" values)))))
15599 (defun org-insert-property-drawer ()
15600 "Insert a property drawer into the current entry."
15601 (org-back-to-heading t)
15602 (looking-at org-outline-regexp)
15603 (let ((indent (if org-adapt-indentation
15604 (- (match-end 0) (match-beginning 0))
15606 (beg (point))
15607 (re (concat "^[ \t]*" org-keyword-time-regexp))
15608 end hiddenp)
15609 (outline-next-heading)
15610 (setq end (point))
15611 (goto-char beg)
15612 (while (re-search-forward re end t))
15613 (setq hiddenp (outline-invisible-p))
15614 (end-of-line 1)
15615 (and (equal (char-after) ?\n) (forward-char 1))
15616 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
15617 (if (member (match-string 1) '("CLOCK:" ":END:"))
15618 ;; just skip this line
15619 (beginning-of-line 2)
15620 ;; Drawer start, find the end
15621 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15622 (beginning-of-line 1)))
15623 (org-skip-over-state-notes)
15624 (skip-chars-backward " \t\n\r")
15625 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15626 (forward-char 1))
15627 (goto-char (point-at-eol))
15628 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15629 (beginning-of-line 0)
15630 (org-indent-to-column indent)
15631 (beginning-of-line 2)
15632 (org-indent-to-column indent)
15633 (beginning-of-line 0)
15634 (if hiddenp
15635 (save-excursion
15636 (org-back-to-heading t)
15637 (hide-entry))
15638 (org-flag-drawer t))))
15640 (defun org-insert-drawer (&optional arg drawer)
15641 "Insert a drawer at point.
15643 Optional argument DRAWER, when non-nil, is a string representing
15644 drawer's name. Otherwise, the user is prompted for a name.
15646 If a region is active, insert the drawer around that region
15647 instead.
15649 Point is left between drawer's boundaries."
15650 (interactive "P")
15651 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15652 "LOGBOOK"))
15653 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15654 ;; internally by Org. They are meant to be inserted
15655 ;; automatically.
15656 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15657 ;; Remove system drawers from list. Note: For some reason,
15658 ;; `org-completing-read' ignores the predicate while
15659 ;; `completing-read' handles it fine.
15660 (drawer (if arg "PROPERTIES"
15661 (or drawer
15662 (completing-read
15663 "Drawer: " org-drawers
15664 (lambda (d) (not (member d system-drawers))))))))
15665 (cond
15666 ;; With C-u, fall back on `org-insert-property-drawer'
15667 (arg (org-insert-property-drawer))
15668 ;; With an active region, insert a drawer at point.
15669 ((not (org-region-active-p))
15670 (progn
15671 (unless (bolp) (insert "\n"))
15672 (insert (format ":%s:\n\n:END:\n" drawer))
15673 (forward-line -2)))
15674 ;; Otherwise, insert the drawer at point
15676 (let ((rbeg (region-beginning))
15677 (rend (copy-marker (region-end))))
15678 (unwind-protect
15679 (progn
15680 (goto-char rbeg)
15681 (beginning-of-line)
15682 (when (save-excursion
15683 (re-search-forward org-outline-regexp-bol rend t))
15684 (user-error "Drawers cannot contain headlines"))
15685 ;; Position point at the beginning of the first
15686 ;; non-blank line in region. Insert drawer's opening
15687 ;; there, then indent it.
15688 (org-skip-whitespace)
15689 (beginning-of-line)
15690 (insert ":" drawer ":\n")
15691 (forward-line -1)
15692 (indent-for-tab-command)
15693 ;; Move point to the beginning of the first blank line
15694 ;; after the last non-blank line in region. Insert
15695 ;; drawer's closing, then indent it.
15696 (goto-char rend)
15697 (skip-chars-backward " \r\t\n")
15698 (insert "\n:END:")
15699 (deactivate-mark t)
15700 (indent-for-tab-command)
15701 (unless (eolp) (insert "\n")))
15702 ;; Clear marker, whatever the outcome of insertion is.
15703 (set-marker rend nil)))))))
15705 (defvar org-property-set-functions-alist nil
15706 "Property set function alist.
15707 Each entry should have the following format:
15709 (PROPERTY . READ-FUNCTION)
15711 The read function will be called with the same argument as
15712 `org-completing-read'.")
15714 (defun org-set-property-function (property)
15715 "Get the function that should be used to set PROPERTY.
15716 This is computed according to `org-property-set-functions-alist'."
15717 (or (cdr (assoc property org-property-set-functions-alist))
15718 'org-completing-read))
15720 (defun org-read-property-value (property)
15721 "Read PROPERTY value from user."
15722 (let* ((completion-ignore-case t)
15723 (allowed (org-property-get-allowed-values nil property 'table))
15724 (cur (org-entry-get nil property))
15725 (prompt (concat property " value"
15726 (if (and cur (string-match "\\S-" cur))
15727 (concat " [" cur "]") "") ": "))
15728 (set-function (org-set-property-function property))
15729 (val (if allowed
15730 (funcall set-function prompt allowed nil
15731 (not (get-text-property 0 'org-unrestricted
15732 (caar allowed))))
15733 (let (org-completion-use-ido org-completion-use-iswitchb)
15734 (funcall set-function prompt
15735 (mapcar 'list (org-property-values property))
15736 nil nil "" nil cur)))))
15737 (if (equal val "")
15739 val)))
15741 (defvar org-last-set-property nil)
15742 (defvar org-last-set-property-value nil)
15743 (defun org-read-property-name ()
15744 "Read a property name."
15745 (let* ((completion-ignore-case t)
15746 (keys (org-buffer-property-keys nil t t))
15747 (default-prop (or (save-excursion
15748 (save-match-data
15749 (beginning-of-line)
15750 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
15751 (null (string= (match-string 1) "END"))
15752 (match-string 1))))
15753 org-last-set-property))
15754 (property (org-icompleting-read
15755 (concat "Property"
15756 (if default-prop (concat " [" default-prop "]") "")
15757 ": ")
15758 (mapcar 'list keys)
15759 nil nil nil nil
15760 default-prop)))
15761 (if (member property keys)
15762 property
15763 (or (cdr (assoc (downcase property)
15764 (mapcar (lambda (x) (cons (downcase x) x))
15765 keys)))
15766 property))))
15768 (defun org-set-property-and-value (use-last)
15769 "Allow to set [PROPERTY]: [value] direction from prompt.
15770 When use-default, don't even ask, just use the last
15771 \"[PROPERTY]: [value]\" string from the history."
15772 (interactive "P")
15773 (let* ((completion-ignore-case t)
15774 (pv (or (and use-last org-last-set-property-value)
15775 (org-completing-read
15776 "Enter a \"[Property]: [value]\" pair: "
15777 nil nil nil nil nil
15778 org-last-set-property-value)))
15779 prop val)
15780 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
15781 (setq prop (match-string 1 pv)
15782 val (match-string 2 pv))
15783 (org-set-property prop val))))
15785 (defun org-set-property (property value)
15786 "In the current entry, set PROPERTY to VALUE.
15787 When called interactively, this will prompt for a property name, offering
15788 completion on existing and default properties. And then it will prompt
15789 for a value, offering completion either on allowed values (via an inherited
15790 xxx_ALL property) or on existing values in other instances of this property
15791 in the current file."
15792 (interactive (list nil nil))
15793 (let* ((property (or property (org-read-property-name)))
15794 (value (or value (org-read-property-value property)))
15795 (fn (cdr (assoc property org-properties-postprocess-alist))))
15796 (setq org-last-set-property property)
15797 (setq org-last-set-property-value (concat property ": " value))
15798 ;; Possibly postprocess the inserted value:
15799 (when fn (setq value (funcall fn value)))
15800 (unless (equal (org-entry-get nil property) value)
15801 (org-entry-put nil property value))))
15803 (defun org-delete-property (property &optional delete-empty-drawer)
15804 "In the current entry, delete PROPERTY.
15805 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15806 an empty drawer to delete."
15807 (interactive
15808 (let* ((completion-ignore-case t)
15809 (cat (org-entry-get (point) "CATEGORY"))
15810 (props0 (org-entry-properties nil 'standard))
15811 (props (if cat props0
15812 (delete `("CATEGORY" . ,(org-get-category)) props0)))
15813 (prop (if (< 1 (length props))
15814 (org-icompleting-read "Property: " props nil t)
15815 (caar props))))
15816 (list prop)))
15817 (if (org-entry-delete nil property delete-empty-drawer)
15818 (message "Property %s deleted" property)))
15820 (defun org-delete-property-globally (property)
15821 "Remove PROPERTY globally, from all entries."
15822 (interactive
15823 (let* ((completion-ignore-case t)
15824 (prop (org-icompleting-read
15825 "Globally remove property: "
15826 (mapcar 'list (org-buffer-property-keys)))))
15827 (list prop)))
15828 (save-excursion
15829 (save-restriction
15830 (widen)
15831 (goto-char (point-min))
15832 (let ((cnt 0))
15833 (while (re-search-forward
15834 (org-re-property property)
15835 nil t)
15836 (setq cnt (1+ cnt))
15837 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15838 (message "Property \"%s\" removed from %d entries" property cnt)))))
15840 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15842 (defun org-compute-property-at-point ()
15843 "Compute the property at point.
15844 This looks for an enclosing column format, extracts the operator and
15845 then applies it to the property in the column format's scope."
15846 (interactive)
15847 (unless (org-at-property-p)
15848 (user-error "Not at a property"))
15849 (let ((prop (org-match-string-no-properties 2)))
15850 (org-columns-get-format-and-top-level)
15851 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15852 (user-error "No operator defined for property %s" prop))
15853 (org-columns-compute prop)))
15855 (defvar org-property-allowed-value-functions nil
15856 "Hook for functions supplying allowed values for a specific property.
15857 The functions must take a single argument, the name of the property, and
15858 return a flat list of allowed values. If \":ETC\" is one of
15859 the values, this means that these values are intended as defaults for
15860 completion, but that other values should be allowed too.
15861 The functions must return nil if they are not responsible for this
15862 property.")
15864 (defun org-property-get-allowed-values (pom property &optional table)
15865 "Get allowed values for the property PROPERTY.
15866 When TABLE is non-nil, return an alist that can directly be used for
15867 completion."
15868 (let (vals)
15869 (cond
15870 ((equal property "TODO")
15871 (setq vals (org-with-point-at pom
15872 (append org-todo-keywords-1 '("")))))
15873 ((equal property "PRIORITY")
15874 (let ((n org-lowest-priority))
15875 (while (>= n org-highest-priority)
15876 (push (char-to-string n) vals)
15877 (setq n (1- n)))))
15878 ((member property org-special-properties))
15879 ((setq vals (run-hook-with-args-until-success
15880 'org-property-allowed-value-functions property)))
15882 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15883 (when (and vals (string-match "\\S-" vals))
15884 (setq vals (car (read-from-string (concat "(" vals ")"))))
15885 (setq vals (mapcar (lambda (x)
15886 (cond ((stringp x) x)
15887 ((numberp x) (number-to-string x))
15888 ((symbolp x) (symbol-name x))
15889 (t "???")))
15890 vals)))))
15891 (when (member ":ETC" vals)
15892 (setq vals (remove ":ETC" vals))
15893 (org-add-props (car vals) '(org-unrestricted t)))
15894 (if table (mapcar 'list vals) vals)))
15896 (defun org-property-previous-allowed-value (&optional previous)
15897 "Switch to the next allowed value for this property."
15898 (interactive)
15899 (org-property-next-allowed-value t))
15901 (defun org-property-next-allowed-value (&optional previous)
15902 "Switch to the next allowed value for this property."
15903 (interactive)
15904 (unless (org-at-property-p)
15905 (user-error "Not at a property"))
15906 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15907 (key (match-string 2))
15908 (value (match-string 3))
15909 (allowed (or (org-property-get-allowed-values (point) key)
15910 (and (member value '("[ ]" "[-]" "[X]"))
15911 '("[ ]" "[X]"))))
15912 (heading (save-match-data (nth 4 (org-heading-components))))
15913 nval)
15914 (unless allowed
15915 (user-error "Allowed values for this property have not been defined"))
15916 (if previous (setq allowed (reverse allowed)))
15917 (if (member value allowed)
15918 (setq nval (car (cdr (member value allowed)))))
15919 (setq nval (or nval (car allowed)))
15920 (if (equal nval value)
15921 (user-error "Only one allowed value for this property"))
15922 (org-at-property-p)
15923 (replace-match (concat " :" key ": " nval) t t)
15924 (org-indent-line)
15925 (beginning-of-line 1)
15926 (skip-chars-forward " \t")
15927 (when (equal prop org-effort-property)
15928 (save-excursion
15929 (org-back-to-heading t)
15930 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15931 (when (string= org-clock-current-task heading)
15932 (setq org-clock-effort nval)
15933 (org-clock-update-mode-line)))
15934 (run-hook-with-args 'org-property-changed-functions key nval)))
15936 (defun org-find-olp (path &optional this-buffer)
15937 "Return a marker pointing to the entry at outline path OLP.
15938 If anything goes wrong, throw an error.
15939 You can wrap this call to catch the error like this:
15941 (condition-case msg
15942 (org-mobile-locate-entry (match-string 4))
15943 (error (nth 1 msg)))
15945 The return value will then be either a string with the error message,
15946 or a marker if everything is OK.
15948 If THIS-BUFFER is set, the outline path does not contain a file,
15949 only headings."
15950 (let* ((file (if this-buffer buffer-file-name (pop path)))
15951 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15952 (level 1)
15953 (lmin 1)
15954 (lmax 1)
15955 limit re end found pos heading cnt flevel)
15956 (unless buffer (error "File not found :%s" file))
15957 (with-current-buffer buffer
15958 (save-excursion
15959 (save-restriction
15960 (widen)
15961 (setq limit (point-max))
15962 (goto-char (point-min))
15963 (while (setq heading (pop path))
15964 (setq re (format org-complex-heading-regexp-format
15965 (regexp-quote heading)))
15966 (setq cnt 0 pos (point))
15967 (while (re-search-forward re end t)
15968 (setq level (- (match-end 1) (match-beginning 1)))
15969 (if (and (>= level lmin) (<= level lmax))
15970 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15971 (when (= cnt 0) (error "Heading not found on level %d: %s"
15972 lmax heading))
15973 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15974 lmax heading))
15975 (goto-char found)
15976 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15977 (setq end (save-excursion (org-end-of-subtree t t))))
15978 (when (org-at-heading-p)
15979 (point-marker)))))))
15981 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15982 "Find node HEADING in BUFFER.
15983 Return a marker to the heading if it was found, or nil if not.
15984 If POS-ONLY is set, return just the position instead of a marker.
15986 The heading text must match exact, but it may have a TODO keyword,
15987 a priority cookie and tags in the standard locations."
15988 (with-current-buffer (or buffer (current-buffer))
15989 (save-excursion
15990 (save-restriction
15991 (widen)
15992 (goto-char (point-min))
15993 (let (case-fold-search)
15994 (if (re-search-forward
15995 (format org-complex-heading-regexp-format
15996 (regexp-quote heading)) nil t)
15997 (if pos-only
15998 (match-beginning 0)
15999 (move-marker (make-marker) (match-beginning 0)))))))))
16001 (defun org-find-exact-heading-in-directory (heading &optional dir)
16002 "Find Org node headline HEADING in all .org files in directory DIR.
16003 When the target headline is found, return a marker to this location."
16004 (let ((files (directory-files (or dir default-directory)
16005 nil "\\`[^.#].*\\.org\\'"))
16006 file visiting m buffer)
16007 (catch 'found
16008 (while (setq file (pop files))
16009 (message "trying %s" file)
16010 (setq visiting (org-find-base-buffer-visiting file))
16011 (setq buffer (or visiting (find-file-noselect file)))
16012 (setq m (org-find-exact-headline-in-buffer
16013 heading buffer))
16014 (when (and (not m) (not visiting)) (kill-buffer buffer))
16015 (and m (throw 'found m))))))
16017 (defun org-find-entry-with-id (ident)
16018 "Locate the entry that contains the ID property with exact value IDENT.
16019 IDENT can be a string, a symbol or a number, this function will search for
16020 the string representation of it.
16021 Return the position where this entry starts, or nil if there is no such entry."
16022 (interactive "sID: ")
16023 (let ((id (cond
16024 ((stringp ident) ident)
16025 ((symbol-name ident) (symbol-name ident))
16026 ((numberp ident) (number-to-string ident))
16027 (t (error "IDENT %s must be a string, symbol or number" ident))))
16028 (case-fold-search nil))
16029 (save-excursion
16030 (save-restriction
16031 (widen)
16032 (goto-char (point-min))
16033 (when (re-search-forward
16034 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16035 nil t)
16036 (org-back-to-heading t)
16037 (point))))))
16039 ;;;; Timestamps
16041 (defvar org-last-changed-timestamp nil)
16042 (defvar org-last-inserted-timestamp nil
16043 "The last time stamp inserted with `org-insert-time-stamp'.")
16044 (defvar org-ts-what) ; dynamically scoped parameter
16046 (defun org-time-stamp (arg &optional inactive)
16047 "Prompt for a date/time and insert a time stamp.
16048 If the user specifies a time like HH:MM or if this command is
16049 called with at least one prefix argument, the time stamp contains
16050 the date and the time. Otherwise, only the date is be included.
16052 All parts of a date not specified by the user is filled in from
16053 the current date/time. So if you just press return without
16054 typing anything, the time stamp will represent the current
16055 date/time.
16057 If there is already a timestamp at the cursor, it will be
16058 modified.
16060 With two universal prefix arguments, insert an active timestamp
16061 with the current time without prompting the user.
16063 When called from lisp, the timestamp is inactive if INACTIVE is
16064 non-nil."
16065 (interactive "P")
16066 (let* ((ts nil)
16067 (default-time
16068 ;; Default time is either today, or, when entering a range,
16069 ;; the range start.
16070 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16071 (save-excursion
16072 (re-search-backward
16073 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16074 (- (point) 20) t)))
16075 (apply 'encode-time (org-parse-time-string (match-string 1)))
16076 (current-time)))
16077 (default-input (and ts (org-get-compact-tod ts)))
16078 (repeater (save-excursion
16079 (save-match-data
16080 (beginning-of-line)
16081 (when (re-search-forward
16082 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16083 (save-excursion (progn (end-of-line) (point))) t)
16084 (match-string 0)))))
16085 org-time-was-given org-end-time-was-given time)
16086 (cond
16087 ((and (org-at-timestamp-p t)
16088 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16089 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16090 (insert "--")
16091 (setq time (let ((this-command this-command))
16092 (org-read-date arg 'totime nil nil
16093 default-time default-input inactive)))
16094 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16095 ((org-at-timestamp-p t)
16096 (setq time (let ((this-command this-command))
16097 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16098 (when (org-at-timestamp-p t) ; just to get the match data
16099 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16100 (replace-match "")
16101 (setq org-last-changed-timestamp
16102 (org-insert-time-stamp
16103 time (or org-time-was-given arg)
16104 inactive nil nil (list org-end-time-was-given)))
16105 (when repeater (goto-char (1- (point))) (insert " " repeater)
16106 (setq org-last-changed-timestamp
16107 (concat (substring org-last-inserted-timestamp 0 -1)
16108 " " repeater ">"))))
16109 (message "Timestamp updated"))
16110 ((equal arg '(16))
16111 (org-insert-time-stamp (current-time) t inactive))
16113 (setq time (let ((this-command this-command))
16114 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16115 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16116 nil nil (list org-end-time-was-given))))))
16118 ;; FIXME: can we use this for something else, like computing time differences?
16119 (defun org-get-compact-tod (s)
16120 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16121 (let* ((t1 (match-string 1 s))
16122 (h1 (string-to-number (match-string 2 s)))
16123 (m1 (string-to-number (match-string 3 s)))
16124 (t2 (and (match-end 4) (match-string 5 s)))
16125 (h2 (and t2 (string-to-number (match-string 6 s))))
16126 (m2 (and t2 (string-to-number (match-string 7 s))))
16127 dh dm)
16128 (if (not t2)
16130 (setq dh (- h2 h1) dm (- m2 m1))
16131 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16132 (concat t1 "+" (number-to-string dh)
16133 (and (/= 0 dm) (format ":%02d" dm)))))))
16135 (defun org-time-stamp-inactive (&optional arg)
16136 "Insert an inactive time stamp.
16137 An inactive time stamp is enclosed in square brackets instead of angle
16138 brackets. It is inactive in the sense that it does not trigger agenda entries,
16139 does not link to the calendar and cannot be changed with the S-cursor keys.
16140 So these are more for recording a certain time/date."
16141 (interactive "P")
16142 (org-time-stamp arg 'inactive))
16144 (defvar org-date-ovl (make-overlay 1 1))
16145 (overlay-put org-date-ovl 'face 'org-date-selected)
16146 (org-detach-overlay org-date-ovl)
16148 (defvar org-ans1) ; dynamically scoped parameter
16149 (defvar org-ans2) ; dynamically scoped parameter
16151 (defvar org-plain-time-of-day-regexp) ; defined below
16153 (defvar org-overriding-default-time nil) ; dynamically scoped
16154 (defvar org-read-date-overlay nil)
16155 (defvar org-dcst nil) ; dynamically scoped
16156 (defvar org-read-date-history nil)
16157 (defvar org-read-date-final-answer nil)
16158 (defvar org-read-date-analyze-futurep nil)
16159 (defvar org-read-date-analyze-forced-year nil)
16160 (defvar org-read-date-inactive)
16162 (defvar org-read-date-minibuffer-local-map
16163 (let* ((org-replace-disputed-keys nil)
16164 (map (make-sparse-keymap)))
16165 (set-keymap-parent map minibuffer-local-map)
16166 (org-defkey map (kbd ".")
16167 (lambda () (interactive)
16168 ;; Are we at the beginning of the prompt?
16169 (if (looking-back "^[^:]+: ")
16170 (org-eval-in-calendar '(calendar-goto-today))
16171 (insert "."))))
16172 (org-defkey map (kbd "C-.")
16173 (lambda () (interactive)
16174 (org-eval-in-calendar '(calendar-goto-today))))
16175 (org-defkey map [(meta shift left)]
16176 (lambda () (interactive)
16177 (org-eval-in-calendar '(calendar-backward-month 1))))
16178 (org-defkey map [(meta shift right)]
16179 (lambda () (interactive)
16180 (org-eval-in-calendar '(calendar-forward-month 1))))
16181 (org-defkey map [(meta shift up)]
16182 (lambda () (interactive)
16183 (org-eval-in-calendar '(calendar-backward-year 1))))
16184 (org-defkey map [(meta shift down)]
16185 (lambda () (interactive)
16186 (org-eval-in-calendar '(calendar-forward-year 1))))
16187 (org-defkey map [?\e (shift left)]
16188 (lambda () (interactive)
16189 (org-eval-in-calendar '(calendar-backward-month 1))))
16190 (org-defkey map [?\e (shift right)]
16191 (lambda () (interactive)
16192 (org-eval-in-calendar '(calendar-forward-month 1))))
16193 (org-defkey map [?\e (shift up)]
16194 (lambda () (interactive)
16195 (org-eval-in-calendar '(calendar-backward-year 1))))
16196 (org-defkey map [?\e (shift down)]
16197 (lambda () (interactive)
16198 (org-eval-in-calendar '(calendar-forward-year 1))))
16199 (org-defkey map [(shift up)]
16200 (lambda () (interactive)
16201 (org-eval-in-calendar '(calendar-backward-week 1))))
16202 (org-defkey map [(shift down)]
16203 (lambda () (interactive)
16204 (org-eval-in-calendar '(calendar-forward-week 1))))
16205 (org-defkey map [(shift left)]
16206 (lambda () (interactive)
16207 (org-eval-in-calendar '(calendar-backward-day 1))))
16208 (org-defkey map [(shift right)]
16209 (lambda () (interactive)
16210 (org-eval-in-calendar '(calendar-forward-day 1))))
16211 (org-defkey map "!"
16212 (lambda () (interactive)
16213 (org-eval-in-calendar '(diary-view-entries))
16214 (message "")))
16215 (org-defkey map ">"
16216 (lambda () (interactive)
16217 (org-eval-in-calendar '(scroll-calendar-left 1))))
16218 (org-defkey map "<"
16219 (lambda () (interactive)
16220 (org-eval-in-calendar '(scroll-calendar-right 1))))
16221 (org-defkey map "\C-v"
16222 (lambda () (interactive)
16223 (org-eval-in-calendar
16224 '(calendar-scroll-left-three-months 1))))
16225 (org-defkey map "\M-v"
16226 (lambda () (interactive)
16227 (org-eval-in-calendar
16228 '(calendar-scroll-right-three-months 1))))
16229 map)
16230 "Keymap for minibuffer commands when using `org-read-date'.")
16232 (defvar org-def)
16233 (defvar org-defdecode)
16234 (defvar org-with-time)
16236 (defun org-read-date (&optional org-with-time to-time from-string prompt
16237 default-time default-input inactive)
16238 "Read a date, possibly a time, and make things smooth for the user.
16239 The prompt will suggest to enter an ISO date, but you can also enter anything
16240 which will at least partially be understood by `parse-time-string'.
16241 Unrecognized parts of the date will default to the current day, month, year,
16242 hour and minute. If this command is called to replace a timestamp at point,
16243 or to enter the second timestamp of a range, the default time is taken
16244 from the existing stamp. Furthermore, the command prefers the future,
16245 so if you are giving a date where the year is not given, and the day-month
16246 combination is already past in the current year, it will assume you
16247 mean next year. For details, see the manual. A few examples:
16249 3-2-5 --> 2003-02-05
16250 feb 15 --> currentyear-02-15
16251 2/15 --> currentyear-02-15
16252 sep 12 9 --> 2009-09-12
16253 12:45 --> today 12:45
16254 22 sept 0:34 --> currentyear-09-22 0:34
16255 12 --> currentyear-currentmonth-12
16256 Fri --> nearest Friday after today
16257 -Tue --> last Tuesday
16258 etc.
16260 Furthermore you can specify a relative date by giving, as the *first* thing
16261 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16262 change in days weeks, months, years.
16263 With a single plus or minus, the date is relative to today. With a double
16264 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16265 +4d --> four days from today
16266 +4 --> same as above
16267 +2w --> two weeks from today
16268 ++5 --> five days from default date
16270 The function understands only English month and weekday abbreviations.
16272 While prompting, a calendar is popped up - you can also select the
16273 date with the mouse (button 1). The calendar shows a period of three
16274 months. To scroll it to other months, use the keys `>' and `<'.
16275 If you don't like the calendar, turn it off with
16276 \(setq org-read-date-popup-calendar nil)
16278 With optional argument TO-TIME, the date will immediately be converted
16279 to an internal time.
16280 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16281 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16282 still enter a time, and this function will inform the calling routine
16283 about this change. The calling routine may then choose to change the
16284 format used to insert the time stamp into the buffer to include the time.
16285 With optional argument FROM-STRING, read from this string instead from
16286 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16287 the time/date that is used for everything that is not specified by the
16288 user."
16289 (require 'parse-time)
16290 (let* ((org-time-stamp-rounding-minutes
16291 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16292 (org-dcst org-display-custom-times)
16293 (ct (org-current-time))
16294 (org-def (or org-overriding-default-time default-time ct))
16295 (org-defdecode (decode-time org-def))
16296 (dummy (progn
16297 (when (< (nth 2 org-defdecode) org-extend-today-until)
16298 (setcar (nthcdr 2 org-defdecode) -1)
16299 (setcar (nthcdr 1 org-defdecode) 59)
16300 (setq org-def (apply 'encode-time org-defdecode)
16301 org-defdecode (decode-time org-def)))))
16302 (mouse-autoselect-window nil) ; Don't let the mouse jump
16303 (calendar-frame-setup nil)
16304 (calendar-setup nil)
16305 (calendar-move-hook nil)
16306 (calendar-view-diary-initially-flag nil)
16307 (calendar-view-holidays-initially-flag nil)
16308 (timestr (format-time-string
16309 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16310 (prompt (concat (if prompt (concat prompt " ") "")
16311 (format "Date+time [%s]: " timestr)))
16312 ans (org-ans0 "") org-ans1 org-ans2 final)
16314 (cond
16315 (from-string (setq ans from-string))
16316 (org-read-date-popup-calendar
16317 (save-excursion
16318 (save-window-excursion
16319 (calendar)
16320 (org-eval-in-calendar '(setq cursor-type nil) t)
16321 (unwind-protect
16322 (progn
16323 (calendar-forward-day (- (time-to-days org-def)
16324 (calendar-absolute-from-gregorian
16325 (calendar-current-date))))
16326 (org-eval-in-calendar nil t)
16327 (let* ((old-map (current-local-map))
16328 (map (copy-keymap calendar-mode-map))
16329 (minibuffer-local-map
16330 (copy-keymap org-read-date-minibuffer-local-map)))
16331 (org-defkey map (kbd "RET") 'org-calendar-select)
16332 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16333 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16334 (unwind-protect
16335 (progn
16336 (use-local-map map)
16337 (setq org-read-date-inactive inactive)
16338 (add-hook 'post-command-hook 'org-read-date-display)
16339 (setq org-ans0 (read-string prompt default-input
16340 'org-read-date-history nil))
16341 ;; org-ans0: from prompt
16342 ;; org-ans1: from mouse click
16343 ;; org-ans2: from calendar motion
16344 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16345 (remove-hook 'post-command-hook 'org-read-date-display)
16346 (use-local-map old-map)
16347 (when org-read-date-overlay
16348 (delete-overlay org-read-date-overlay)
16349 (setq org-read-date-overlay nil)))))
16350 (bury-buffer "*Calendar*")))))
16352 (t ; Naked prompt only
16353 (unwind-protect
16354 (setq ans (read-string prompt default-input
16355 'org-read-date-history timestr))
16356 (when org-read-date-overlay
16357 (delete-overlay org-read-date-overlay)
16358 (setq org-read-date-overlay nil)))))
16360 (setq final (org-read-date-analyze ans org-def org-defdecode))
16362 (when org-read-date-analyze-forced-year
16363 (message "Year was forced into %s"
16364 (if org-read-date-force-compatible-dates
16365 "compatible range (1970-2037)"
16366 "range representable on this machine"))
16367 (ding))
16369 ;; One round trip to get rid of 34th of August and stuff like that....
16370 (setq final (decode-time (apply 'encode-time final)))
16372 (setq org-read-date-final-answer ans)
16374 (if to-time
16375 (apply 'encode-time final)
16376 (if (and (boundp 'org-time-was-given) org-time-was-given)
16377 (format "%04d-%02d-%02d %02d:%02d"
16378 (nth 5 final) (nth 4 final) (nth 3 final)
16379 (nth 2 final) (nth 1 final))
16380 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16382 (defun org-read-date-display ()
16383 "Display the current date prompt interpretation in the minibuffer."
16384 (when org-read-date-display-live
16385 (when org-read-date-overlay
16386 (delete-overlay org-read-date-overlay))
16387 (when (minibufferp (current-buffer))
16388 (save-excursion
16389 (end-of-line 1)
16390 (while (not (equal (buffer-substring
16391 (max (point-min) (- (point) 4)) (point))
16392 " "))
16393 (insert " ")))
16394 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16395 " " (or org-ans1 org-ans2)))
16396 (org-end-time-was-given nil)
16397 (f (org-read-date-analyze ans org-def org-defdecode))
16398 (fmts (if org-dcst
16399 org-time-stamp-custom-formats
16400 org-time-stamp-formats))
16401 (fmt (if (or org-with-time
16402 (and (boundp 'org-time-was-given) org-time-was-given))
16403 (cdr fmts)
16404 (car fmts)))
16405 (txt (format-time-string fmt (apply 'encode-time f)))
16406 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16407 (txt (concat "=> " txt)))
16408 (when (and org-end-time-was-given
16409 (string-match org-plain-time-of-day-regexp txt))
16410 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16411 org-end-time-was-given
16412 (substring txt (match-end 0)))))
16413 (when org-read-date-analyze-futurep
16414 (setq txt (concat txt " (=>F)")))
16415 (setq org-read-date-overlay
16416 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16417 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16419 (defun org-read-date-analyze (ans org-def org-defdecode)
16420 "Analyze the combined answer of the date prompt."
16421 ;; FIXME: cleanup and comment
16422 (let ((nowdecode (decode-time (current-time)))
16423 delta deltan deltaw deltadef year month day
16424 hour minute second wday pm h2 m2 tl wday1
16425 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16426 (setq org-read-date-analyze-futurep nil
16427 org-read-date-analyze-forced-year nil)
16428 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16429 (setq ans "+0"))
16431 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16432 (setq ans (replace-match "" t t ans)
16433 deltan (car delta)
16434 deltaw (nth 1 delta)
16435 deltadef (nth 2 delta)))
16437 ;; Check if there is an iso week date in there. If yes, store the
16438 ;; info and postpone interpreting it until the rest of the parsing
16439 ;; is done.
16440 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16441 (setq iso-year (if (match-end 1)
16442 (org-small-year-to-year
16443 (string-to-number (match-string 1 ans))))
16444 iso-weekday (if (match-end 3)
16445 (string-to-number (match-string 3 ans)))
16446 iso-week (string-to-number (match-string 2 ans)))
16447 (setq ans (replace-match "" t t ans)))
16449 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16450 (when (string-match
16451 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16452 (setq year (if (match-end 2)
16453 (string-to-number (match-string 2 ans))
16454 (progn (setq kill-year t)
16455 (string-to-number (format-time-string "%Y"))))
16456 month (string-to-number (match-string 3 ans))
16457 day (string-to-number (match-string 4 ans)))
16458 (if (< year 100) (setq year (+ 2000 year)))
16459 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16460 t nil ans)))
16462 ;; Help matching dotted european dates
16463 (when (string-match
16464 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16465 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16466 (setq kill-year t)
16467 (string-to-number (format-time-string "%Y")))
16468 day (string-to-number (match-string 1 ans))
16469 month (string-to-number (match-string 2 ans))
16470 ans (replace-match (format "%04d-%02d-%02d" year month day)
16471 t nil ans)))
16473 ;; Help matching american dates, like 5/30 or 5/30/7
16474 (when (string-match
16475 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16476 (setq year (if (match-end 4)
16477 (string-to-number (match-string 4 ans))
16478 (progn (setq kill-year t)
16479 (string-to-number (format-time-string "%Y"))))
16480 month (string-to-number (match-string 1 ans))
16481 day (string-to-number (match-string 2 ans)))
16482 (if (< year 100) (setq year (+ 2000 year)))
16483 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16484 t nil ans)))
16485 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16486 ;; If there is a time with am/pm, and *no* time without it, we convert
16487 ;; so that matching will be successful.
16488 (loop for i from 1 to 2 do ; twice, for end time as well
16489 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16490 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16491 (setq hour (string-to-number (match-string 1 ans))
16492 minute (if (match-end 3)
16493 (string-to-number (match-string 3 ans))
16495 pm (equal ?p
16496 (string-to-char (downcase (match-string 4 ans)))))
16497 (if (and (= hour 12) (not pm))
16498 (setq hour 0)
16499 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16500 (setq ans (replace-match (format "%02d:%02d" hour minute)
16501 t t ans))))
16503 ;; Check if a time range is given as a duration
16504 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16505 (setq hour (string-to-number (match-string 1 ans))
16506 h2 (+ hour (string-to-number (match-string 3 ans)))
16507 minute (string-to-number (match-string 2 ans))
16508 m2 (+ minute (if (match-end 5) (string-to-number
16509 (match-string 5 ans))0)))
16510 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16511 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16512 t t ans)))
16514 ;; Check if there is a time range
16515 (when (boundp 'org-end-time-was-given)
16516 (setq org-time-was-given nil)
16517 (when (and (string-match org-plain-time-of-day-regexp ans)
16518 (match-end 8))
16519 (setq org-end-time-was-given (match-string 8 ans))
16520 (setq ans (concat (substring ans 0 (match-beginning 7))
16521 (substring ans (match-end 7))))))
16523 (setq tl (parse-time-string ans)
16524 day (or (nth 3 tl) (nth 3 org-defdecode))
16525 month (or (nth 4 tl)
16526 (if (and org-read-date-prefer-future
16527 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16528 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16529 (nth 4 org-defdecode)))
16530 year (or (and (not kill-year) (nth 5 tl))
16531 (if (and org-read-date-prefer-future
16532 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16533 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16534 (nth 5 org-defdecode)))
16535 hour (or (nth 2 tl) (nth 2 org-defdecode))
16536 minute (or (nth 1 tl) (nth 1 org-defdecode))
16537 second (or (nth 0 tl) 0)
16538 wday (nth 6 tl))
16540 (when (and (eq org-read-date-prefer-future 'time)
16541 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16542 (equal day (nth 3 nowdecode))
16543 (equal month (nth 4 nowdecode))
16544 (equal year (nth 5 nowdecode))
16545 (nth 2 tl)
16546 (or (< (nth 2 tl) (nth 2 nowdecode))
16547 (and (= (nth 2 tl) (nth 2 nowdecode))
16548 (nth 1 tl)
16549 (< (nth 1 tl) (nth 1 nowdecode)))))
16550 (setq day (1+ day)
16551 futurep t))
16553 ;; Special date definitions below
16554 (cond
16555 (iso-week
16556 ;; There was an iso week
16557 (require 'cal-iso)
16558 (setq futurep nil)
16559 (setq year (or iso-year year)
16560 day (or iso-weekday wday 1)
16561 wday nil ; to make sure that the trigger below does not match
16562 iso-date (calendar-gregorian-from-absolute
16563 (calendar-absolute-from-iso
16564 (list iso-week day year))))
16565 ; FIXME: Should we also push ISO weeks into the future?
16566 ; (when (and org-read-date-prefer-future
16567 ; (not iso-year)
16568 ; (< (calendar-absolute-from-gregorian iso-date)
16569 ; (time-to-days (current-time))))
16570 ; (setq year (1+ year)
16571 ; iso-date (calendar-gregorian-from-absolute
16572 ; (calendar-absolute-from-iso
16573 ; (list iso-week day year)))))
16574 (setq month (car iso-date)
16575 year (nth 2 iso-date)
16576 day (nth 1 iso-date)))
16577 (deltan
16578 (setq futurep nil)
16579 (unless deltadef
16580 (let ((now (decode-time (current-time))))
16581 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16582 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16583 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16584 ((equal deltaw "m") (setq month (+ month deltan)))
16585 ((equal deltaw "y") (setq year (+ year deltan)))))
16586 ((and wday (not (nth 3 tl)))
16587 ;; Weekday was given, but no day, so pick that day in the week
16588 ;; on or after the derived date.
16589 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16590 (unless (equal wday wday1)
16591 (setq day (+ day (% (- wday wday1 -7) 7))))))
16592 (if (and (boundp 'org-time-was-given)
16593 (nth 2 tl))
16594 (setq org-time-was-given t))
16595 (if (< year 100) (setq year (+ 2000 year)))
16596 ;; Check of the date is representable
16597 (if org-read-date-force-compatible-dates
16598 (progn
16599 (if (< year 1970)
16600 (setq year 1970 org-read-date-analyze-forced-year t))
16601 (if (> year 2037)
16602 (setq year 2037 org-read-date-analyze-forced-year t)))
16603 (condition-case nil
16604 (ignore (encode-time second minute hour day month year))
16605 (error
16606 (setq year (nth 5 org-defdecode))
16607 (setq org-read-date-analyze-forced-year t))))
16608 (setq org-read-date-analyze-futurep futurep)
16609 (list second minute hour day month year)))
16611 (defvar parse-time-weekdays)
16612 (defun org-read-date-get-relative (s today default)
16613 "Check string S for special relative date string.
16614 TODAY and DEFAULT are internal times, for today and for a default.
16615 Return shift list (N what def-flag)
16616 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16617 N is the number of WHATs to shift.
16618 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16619 the DEFAULT date rather than TODAY."
16620 (require 'parse-time)
16621 (when (and
16622 (string-match
16623 (concat
16624 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16625 "\\([0-9]+\\)?"
16626 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16627 "\\([ \t]\\|$\\)") s)
16628 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16629 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16630 (string-to-char (substring (match-string 1 s) -1))
16631 ?+))
16632 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16633 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16634 (what (if (match-end 3) (match-string 3 s) "d"))
16635 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16636 (date (if rel default today))
16637 (wday (nth 6 (decode-time date)))
16638 delta)
16639 (if wday1
16640 (progn
16641 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16642 (if (= delta 0) (setq delta 7))
16643 (if (= dir ?-)
16644 (progn
16645 (setq delta (- delta 7))
16646 (if (= delta 0) (setq delta -7))))
16647 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16648 (list delta "d" rel))
16649 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16651 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16652 "Turn a user-specified date into the internal representation.
16653 The internal representation needed by the calendar is (month day year).
16654 This is a wrapper to handle the brain-dead convention in calendar that
16655 user function argument order change dependent on argument order."
16656 (if (boundp 'calendar-date-style)
16657 (cond
16658 ((eq calendar-date-style 'american)
16659 (list arg1 arg2 arg3))
16660 ((eq calendar-date-style 'european)
16661 (list arg2 arg1 arg3))
16662 ((eq calendar-date-style 'iso)
16663 (list arg2 arg3 arg1)))
16664 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16665 (if (org-bound-and-true-p european-calendar-style)
16666 (list arg2 arg1 arg3)
16667 (list arg1 arg2 arg3)))))
16669 (defun org-eval-in-calendar (form &optional keepdate)
16670 "Eval FORM in the calendar window and return to current window.
16671 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16672 otherwise stick to the current value of `org-ans2'."
16673 (let ((sf (selected-frame))
16674 (sw (selected-window)))
16675 (select-window (get-buffer-window "*Calendar*" t))
16676 (eval form)
16677 (when (and (not keepdate) (calendar-cursor-to-date))
16678 (let* ((date (calendar-cursor-to-date))
16679 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16680 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16681 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16682 (select-window sw)
16683 (org-select-frame-set-input-focus sf)))
16685 (defun org-calendar-select ()
16686 "Return to `org-read-date' with the date currently selected.
16687 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16688 (interactive)
16689 (when (calendar-cursor-to-date)
16690 (let* ((date (calendar-cursor-to-date))
16691 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16692 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16693 (if (active-minibuffer-window) (exit-minibuffer))))
16695 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16696 "Insert a date stamp for the date given by the internal TIME.
16697 WITH-HM means use the stamp format that includes the time of the day.
16698 INACTIVE means use square brackets instead of angular ones, so that the
16699 stamp will not contribute to the agenda.
16700 PRE and POST are optional strings to be inserted before and after the
16701 stamp.
16702 The command returns the inserted time stamp."
16703 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16704 stamp)
16705 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16706 (insert-before-markers (or pre ""))
16707 (when (listp extra)
16708 (setq extra (car extra))
16709 (if (and (stringp extra)
16710 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16711 (setq extra (format "-%02d:%02d"
16712 (string-to-number (match-string 1 extra))
16713 (string-to-number (match-string 2 extra))))
16714 (setq extra nil)))
16715 (when extra
16716 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16717 (insert-before-markers (setq stamp (format-time-string fmt time)))
16718 (insert-before-markers (or post ""))
16719 (setq org-last-inserted-timestamp stamp)))
16721 (defun org-toggle-time-stamp-overlays ()
16722 "Toggle the use of custom time stamp formats."
16723 (interactive)
16724 (setq org-display-custom-times (not org-display-custom-times))
16725 (unless org-display-custom-times
16726 (let ((p (point-min)) (bmp (buffer-modified-p)))
16727 (while (setq p (next-single-property-change p 'display))
16728 (if (and (get-text-property p 'display)
16729 (eq (get-text-property p 'face) 'org-date))
16730 (remove-text-properties
16731 p (setq p (next-single-property-change p 'display))
16732 '(display t))))
16733 (set-buffer-modified-p bmp)))
16734 (if (featurep 'xemacs)
16735 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16736 (org-restart-font-lock)
16737 (setq org-table-may-need-update t)
16738 (if org-display-custom-times
16739 (message "Time stamps are overlaid with custom format")
16740 (message "Time stamp overlays removed")))
16742 (defun org-display-custom-time (beg end)
16743 "Overlay modified time stamp format over timestamp between BEG and END."
16744 (let* ((ts (buffer-substring beg end))
16745 t1 w1 with-hm tf time str w2 (off 0))
16746 (save-match-data
16747 (setq t1 (org-parse-time-string ts t))
16748 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16749 (setq off (- (match-end 0) (match-beginning 0)))))
16750 (setq end (- end off))
16751 (setq w1 (- end beg)
16752 with-hm (and (nth 1 t1) (nth 2 t1))
16753 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16754 time (org-fix-decoded-time t1)
16755 str (org-add-props
16756 (format-time-string
16757 (substring tf 1 -1) (apply 'encode-time time))
16758 nil 'mouse-face 'highlight)
16759 w2 (length str))
16760 (if (not (= w2 w1))
16761 (add-text-properties (1+ beg) (+ 2 beg)
16762 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16763 (if (featurep 'xemacs)
16764 (progn
16765 (put-text-property beg end 'invisible t)
16766 (put-text-property beg end 'end-glyph (make-glyph str)))
16767 (put-text-property beg end 'display str))))
16769 (defun org-translate-time (string)
16770 "Translate all timestamps in STRING to custom format.
16771 But do this only if the variable `org-display-custom-times' is set."
16772 (when org-display-custom-times
16773 (save-match-data
16774 (let* ((start 0)
16775 (re org-ts-regexp-both)
16776 t1 with-hm inactive tf time str beg end)
16777 (while (setq start (string-match re string start))
16778 (setq beg (match-beginning 0)
16779 end (match-end 0)
16780 t1 (save-match-data
16781 (org-parse-time-string (substring string beg end) t))
16782 with-hm (and (nth 1 t1) (nth 2 t1))
16783 inactive (equal (substring string beg (1+ beg)) "[")
16784 tf (funcall (if with-hm 'cdr 'car)
16785 org-time-stamp-custom-formats)
16786 time (org-fix-decoded-time t1)
16787 str (format-time-string
16788 (concat
16789 (if inactive "[" "<") (substring tf 1 -1)
16790 (if inactive "]" ">"))
16791 (apply 'encode-time time))
16792 string (replace-match str t t string)
16793 start (+ start (length str)))))))
16794 string)
16796 (defun org-fix-decoded-time (time)
16797 "Set 0 instead of nil for the first 6 elements of time.
16798 Don't touch the rest."
16799 (let ((n 0))
16800 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16802 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16804 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16805 "Difference between TIMESTAMP-STRING and now in days.
16806 If SECONDS is non-nil, return the difference in seconds."
16807 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16808 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16809 (funcall fdiff (current-time)))))
16811 (defun org-deadline-close (timestamp-string &optional ndays)
16812 "Is the time in TIMESTAMP-STRING close to the current date?"
16813 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16814 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16815 (not (org-entry-is-done-p))))
16817 (defun org-get-wdays (ts &optional delay zero-delay)
16818 "Get the deadline lead time appropriate for timestring TS.
16819 When DELAY is non-nil, get the delay time for scheduled items
16820 instead of the deadline lead time. When ZERO-DELAY is non-nil
16821 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16822 don't try to find the delay cookie in the scheduled timestamp."
16823 (let ((tv (if delay org-scheduled-delay-days
16824 org-deadline-warning-days)))
16825 (cond
16826 ((or (and delay (< tv 0))
16827 (and delay zero-delay (<= tv 0))
16828 (and (not delay) (<= tv 0)))
16829 ;; Enforce this value no matter what
16830 (- tv))
16831 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
16832 ;; lead time is specified.
16833 (floor (* (string-to-number (match-string 1 ts))
16834 (cdr (assoc (match-string 2 ts)
16835 '(("d" . 1) ("w" . 7)
16836 ("m" . 30.4) ("y" . 365.25)
16837 ("h" . 0.041667)))))))
16838 ;; go for the default.
16839 (t tv))))
16841 (defun org-calendar-select-mouse (ev)
16842 "Return to `org-read-date' with the date currently selected.
16843 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16844 (interactive "e")
16845 (mouse-set-point ev)
16846 (when (calendar-cursor-to-date)
16847 (let* ((date (calendar-cursor-to-date))
16848 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16849 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16850 (if (active-minibuffer-window) (exit-minibuffer))))
16852 (defun org-check-deadlines (ndays)
16853 "Check if there are any deadlines due or past due.
16854 A deadline is considered due if it happens within `org-deadline-warning-days'
16855 days from today's date. If the deadline appears in an entry marked DONE,
16856 it is not shown. The prefix arg NDAYS can be used to test that many
16857 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
16858 (interactive "P")
16859 (let* ((org-warn-days
16860 (cond
16861 ((equal ndays '(4)) 100000)
16862 (ndays (prefix-numeric-value ndays))
16863 (t (abs org-deadline-warning-days))))
16864 (case-fold-search nil)
16865 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16866 (callback
16867 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16869 (message "%d deadlines past-due or due within %d days"
16870 (org-occur regexp nil callback)
16871 org-warn-days)))
16873 (defsubst org-re-timestamp (type)
16874 "Return a regexp for timestamp TYPE.
16875 Allowed values for TYPE are:
16877 all: all timestamps
16878 active: only active timestamps (<...>)
16879 inactive: only inactive timestamps ([...])
16880 scheduled: only scheduled timestamps
16881 deadline: only deadline timestamps
16882 closed: only closed time-stamps
16884 When TYPE is nil, fall back on returning a regexp that matches
16885 both scheduled and deadline timestamps."
16886 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16887 ((eq type 'active) org-ts-regexp)
16888 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
16889 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
16890 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16891 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
16892 ((eq type 'scheduled-or-deadline)
16893 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
16895 (defun org-check-before-date (date)
16896 "Check if there are deadlines or scheduled entries before DATE."
16897 (interactive (list (org-read-date)))
16898 (let ((case-fold-search nil)
16899 (regexp (org-re-timestamp org-ts-type))
16900 (callback
16901 (lambda () (time-less-p
16902 (org-time-string-to-time (match-string 1))
16903 (org-time-string-to-time date)))))
16904 (message "%d entries before %s"
16905 (org-occur regexp nil callback) date)))
16907 (defun org-check-after-date (date)
16908 "Check if there are deadlines or scheduled entries after DATE."
16909 (interactive (list (org-read-date)))
16910 (let ((case-fold-search nil)
16911 (regexp (org-re-timestamp org-ts-type))
16912 (callback
16913 (lambda () (not
16914 (time-less-p
16915 (org-time-string-to-time (match-string 1))
16916 (org-time-string-to-time date))))))
16917 (message "%d entries after %s"
16918 (org-occur regexp nil callback) date)))
16920 (defun org-check-dates-range (start-date end-date)
16921 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16922 (interactive (list (org-read-date nil nil nil "Range starts")
16923 (org-read-date nil nil nil "Range end")))
16924 (let ((case-fold-search nil)
16925 (regexp (org-re-timestamp org-ts-type))
16926 (callback
16927 (lambda ()
16928 (let ((match (match-string 1)))
16929 (and
16930 (not (time-less-p
16931 (org-time-string-to-time match)
16932 (org-time-string-to-time start-date)))
16933 (time-less-p
16934 (org-time-string-to-time match)
16935 (org-time-string-to-time end-date)))))))
16936 (message "%d entries between %s and %s"
16937 (org-occur regexp nil callback) start-date end-date)))
16939 (defun org-evaluate-time-range (&optional to-buffer)
16940 "Evaluate a time range by computing the difference between start and end.
16941 Normally the result is just printed in the echo area, but with prefix arg
16942 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16943 If the time range is actually in a table, the result is inserted into the
16944 next column.
16945 For time difference computation, a year is assumed to be exactly 365
16946 days in order to avoid rounding problems."
16947 (interactive "P")
16949 (org-clock-update-time-maybe)
16950 (save-excursion
16951 (unless (org-at-date-range-p t)
16952 (goto-char (point-at-bol))
16953 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16954 (if (not (org-at-date-range-p t))
16955 (user-error "Not at a time-stamp range, and none found in current line")))
16956 (let* ((ts1 (match-string 1))
16957 (ts2 (match-string 2))
16958 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16959 (match-end (match-end 0))
16960 (time1 (org-time-string-to-time ts1))
16961 (time2 (org-time-string-to-time ts2))
16962 (t1 (org-float-time time1))
16963 (t2 (org-float-time time2))
16964 (diff (abs (- t2 t1)))
16965 (negative (< (- t2 t1) 0))
16966 ;; (ys (floor (* 365 24 60 60)))
16967 (ds (* 24 60 60))
16968 (hs (* 60 60))
16969 (fy "%dy %dd %02d:%02d")
16970 (fy1 "%dy %dd")
16971 (fd "%dd %02d:%02d")
16972 (fd1 "%dd")
16973 (fh "%02d:%02d")
16974 y d h m align)
16975 (if havetime
16976 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16978 d (floor (/ diff ds)) diff (mod diff ds)
16979 h (floor (/ diff hs)) diff (mod diff hs)
16980 m (floor (/ diff 60)))
16981 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16983 d (floor (+ (/ diff ds) 0.5))
16984 h 0 m 0))
16985 (if (not to-buffer)
16986 (message "%s" (org-make-tdiff-string y d h m))
16987 (if (org-at-table-p)
16988 (progn
16989 (goto-char match-end)
16990 (setq align t)
16991 (and (looking-at " *|") (goto-char (match-end 0))))
16992 (goto-char match-end))
16993 (if (looking-at
16994 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
16995 (replace-match ""))
16996 (if negative (insert " -"))
16997 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16998 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16999 (insert " " (format fh h m))))
17000 (if align (org-table-align))
17001 (message "Time difference inserted")))))
17003 (defun org-make-tdiff-string (y d h m)
17004 (let ((fmt "")
17005 (l nil))
17006 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17007 l (push y l)))
17008 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17009 l (push d l)))
17010 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17011 l (push h l)))
17012 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17013 l (push m l)))
17014 (apply 'format fmt (nreverse l))))
17016 (defun org-time-string-to-time (s &optional buffer pos)
17017 "Convert a timestamp string into internal time."
17018 (condition-case errdata
17019 (apply 'encode-time (org-parse-time-string s))
17020 (error (error "Bad timestamp `%s'%s\nError was: %s"
17021 s (if (not (and buffer pos))
17023 (format " at %d in buffer `%s'" pos buffer))
17024 (cdr errdata)))))
17026 (defun org-time-string-to-seconds (s)
17027 "Convert a timestamp string to a number of seconds."
17028 (org-float-time (org-time-string-to-time s)))
17030 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17031 "Convert a time stamp to an absolute day number.
17032 If there is a specifier for a cyclic time stamp, get the closest
17033 date to DAYNR.
17034 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17035 The variable `date' is bound by the calendar when this is called."
17036 (cond
17037 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17038 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17039 daynr
17040 (+ daynr 1000)))
17041 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17042 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17043 (time-to-days (current-time))) (match-string 0 s)
17044 prefer show-all))
17045 (t (time-to-days
17046 (condition-case errdata
17047 (apply 'encode-time (org-parse-time-string s))
17048 (error (error "Bad timestamp `%s'%s\nError was: %s"
17049 s (if (not (and buffer pos))
17051 (format " at %d in buffer `%s'" pos buffer))
17052 (cdr errdata))))))))
17054 (defun org-days-to-iso-week (days)
17055 "Return the iso week number."
17056 (require 'cal-iso)
17057 (car (calendar-iso-from-absolute days)))
17059 (defun org-small-year-to-year (year)
17060 "Convert 2-digit years into 4-digit years.
17061 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17062 The year 2000 cannot be abbreviated. Any year larger than 99
17063 is returned unchanged."
17064 (if (< year 38)
17065 (setq year (+ 2000 year))
17066 (if (< year 100)
17067 (setq year (+ 1900 year))))
17068 year)
17070 (defun org-time-from-absolute (d)
17071 "Return the time corresponding to date D.
17072 D may be an absolute day number, or a calendar-type list (month day year)."
17073 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17074 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17076 (defun org-calendar-holiday ()
17077 "List of holidays, for Diary display in Org-mode."
17078 (require 'holidays)
17079 (let ((hl (funcall
17080 (if (fboundp 'calendar-check-holidays)
17081 'calendar-check-holidays 'check-calendar-holidays) date)))
17082 (if hl (mapconcat 'identity hl "; "))))
17084 (defun org-diary-sexp-entry (sexp entry date)
17085 "Process a SEXP diary ENTRY for DATE."
17086 (require 'diary-lib)
17087 (let ((result (if calendar-debug-sexp
17088 (let ((stack-trace-on-error t))
17089 (eval (car (read-from-string sexp))))
17090 (condition-case nil
17091 (eval (car (read-from-string sexp)))
17092 (error
17093 (beep)
17094 (message "Bad sexp at line %d in %s: %s"
17095 (org-current-line)
17096 (buffer-file-name) sexp)
17097 (sleep-for 2))))))
17098 (cond ((stringp result) (split-string result "; "))
17099 ((and (consp result)
17100 (not (consp (cdr result)))
17101 (stringp (cdr result))) (cdr result))
17102 ((and (consp result)
17103 (stringp (car result))) result)
17104 (result entry))))
17106 (defun org-diary-to-ical-string (frombuf)
17107 "Get iCalendar entries from diary entries in buffer FROMBUF.
17108 This uses the icalendar.el library."
17109 (let* ((tmpdir (if (featurep 'xemacs)
17110 (temp-directory)
17111 temporary-file-directory))
17112 (tmpfile (make-temp-name
17113 (expand-file-name "orgics" tmpdir)))
17114 buf rtn b e)
17115 (with-current-buffer frombuf
17116 (icalendar-export-region (point-min) (point-max) tmpfile)
17117 (setq buf (find-buffer-visiting tmpfile))
17118 (set-buffer buf)
17119 (goto-char (point-min))
17120 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17121 (setq b (match-beginning 0)))
17122 (goto-char (point-max))
17123 (if (re-search-backward "^END:VEVENT" nil t)
17124 (setq e (match-end 0)))
17125 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17126 (kill-buffer buf)
17127 (delete-file tmpfile)
17128 rtn))
17130 (defun org-closest-date (start current change prefer show-all)
17131 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17132 When PREFER is `past', return a date that is either CURRENT or past.
17133 When PREFER is `future', return a date that is either CURRENT or future.
17134 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17135 ;; Make the proper lists from the dates
17136 (catch 'exit
17137 (let ((a1 '(("h" . hour)
17138 ("d" . day)
17139 ("w" . week)
17140 ("m" . month)
17141 ("y" . year)))
17142 (shour (nth 2 (org-parse-time-string start)))
17143 dn dw sday cday n1 n2 n0
17144 d m y y1 y2 date1 date2 nmonths nm ny m2)
17146 (setq start (org-date-to-gregorian start)
17147 current (org-date-to-gregorian
17148 (if show-all
17149 current
17150 (time-to-days (current-time))))
17151 sday (calendar-absolute-from-gregorian start)
17152 cday (calendar-absolute-from-gregorian current))
17154 (if (<= cday sday) (throw 'exit sday))
17156 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17157 (setq dn (string-to-number (match-string 1 change))
17158 dw (cdr (assoc (match-string 2 change) a1)))
17159 (user-error "Invalid change specifier: %s" change))
17160 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17161 (cond
17162 ((eq dw 'hour)
17163 (let ((missing-hours
17164 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17165 dn)))
17166 (setq n1 (if (zerop missing-hours) cday
17167 (- cday (1+ (floor (/ missing-hours 24)))))
17168 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17169 ((eq dw 'day)
17170 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17171 n2 (+ n1 dn)))
17172 ((eq dw 'year)
17173 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17174 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17175 (setq date1 (list m d y1)
17176 n1 (calendar-absolute-from-gregorian date1)
17177 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17178 n2 (calendar-absolute-from-gregorian date2)))
17179 ((eq dw 'month)
17180 ;; approx number of month between the two dates
17181 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17182 ;; How often does dn fit in there?
17183 (setq d (nth 1 start) m (car start) y (nth 2 start)
17184 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17185 m (+ m nm)
17186 ny (floor (/ m 12))
17187 y (+ y ny)
17188 m (- m (* ny 12)))
17189 (while (> m 12) (setq m (- m 12) y (1+ y)))
17190 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17191 (setq m2 (+ m dn) y2 y)
17192 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17193 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17194 (while (<= n2 cday)
17195 (setq n1 n2 m m2 y y2)
17196 (setq m2 (+ m dn) y2 y)
17197 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17198 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17199 ;; Make sure n1 is the earlier date
17200 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17201 (if show-all
17202 (cond
17203 ((eq prefer 'past) (if (= cday n2) n2 n1))
17204 ((eq prefer 'future) (if (= cday n1) n1 n2))
17205 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17206 (cond
17207 ((eq prefer 'past) (if (= cday n2) n2 n1))
17208 ((eq prefer 'future) (if (= cday n1) n1 n2))
17209 (t (if (= cday n1) n1 n2)))))))
17211 (defun org-date-to-gregorian (date)
17212 "Turn any specification of DATE into a Gregorian date for the calendar."
17213 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17214 ((and (listp date) (= (length date) 3)) date)
17215 ((stringp date)
17216 (setq date (org-parse-time-string date))
17217 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17218 ((listp date)
17219 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17221 (defun org-parse-time-string (s &optional nodefault)
17222 "Parse the standard Org-mode time string.
17223 This should be a lot faster than the normal `parse-time-string'.
17224 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17225 hour and minute fields will be nil if not given."
17226 (cond ((string-match org-ts-regexp0 s)
17227 (list 0
17228 (if (or (match-beginning 8) (not nodefault))
17229 (string-to-number (or (match-string 8 s) "0")))
17230 (if (or (match-beginning 7) (not nodefault))
17231 (string-to-number (or (match-string 7 s) "0")))
17232 (string-to-number (match-string 4 s))
17233 (string-to-number (match-string 3 s))
17234 (string-to-number (match-string 2 s))
17235 nil nil nil))
17236 ((string-match "^<[^>]+>$" s)
17237 (decode-time (seconds-to-time (org-matcher-time s))))
17238 (t (error "Not a standard Org-mode time string: %s" s))))
17240 (defun org-timestamp-up (&optional arg)
17241 "Increase the date item at the cursor by one.
17242 If the cursor is on the year, change the year. If it is on the month,
17243 the day or the time, change that.
17244 With prefix ARG, change by that many units."
17245 (interactive "p")
17246 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17248 (defun org-timestamp-down (&optional arg)
17249 "Decrease the date item at the cursor by one.
17250 If the cursor is on the year, change the year. If it is on the month,
17251 the day or the time, change that.
17252 With prefix ARG, change by that many units."
17253 (interactive "p")
17254 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17256 (defun org-timestamp-up-day (&optional arg)
17257 "Increase the date in the time stamp by one day.
17258 With prefix ARG, change that many days."
17259 (interactive "p")
17260 (if (and (not (org-at-timestamp-p t))
17261 (org-at-heading-p))
17262 (org-todo 'up)
17263 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17265 (defun org-timestamp-down-day (&optional arg)
17266 "Decrease the date in the time stamp by one day.
17267 With prefix ARG, change that many days."
17268 (interactive "p")
17269 (if (and (not (org-at-timestamp-p t))
17270 (org-at-heading-p))
17271 (org-todo 'down)
17272 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17274 (defun org-at-timestamp-p (&optional inactive-ok)
17275 "Determine if the cursor is in or at a timestamp."
17276 (interactive)
17277 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17278 (pos (point))
17279 (ans (or (looking-at tsr)
17280 (save-excursion
17281 (skip-chars-backward "^[<\n\r\t")
17282 (if (> (point) (point-min)) (backward-char 1))
17283 (and (looking-at tsr)
17284 (> (- (match-end 0) pos) -1))))))
17285 (and ans
17286 (boundp 'org-ts-what)
17287 (setq org-ts-what
17288 (cond
17289 ((= pos (match-beginning 0)) 'bracket)
17290 ;; Point is considered to be "on the bracket" whether
17291 ;; it's really on it or right after it.
17292 ((= pos (1- (match-end 0))) 'bracket)
17293 ((= pos (match-end 0)) 'after)
17294 ((org-pos-in-match-range pos 2) 'year)
17295 ((org-pos-in-match-range pos 3) 'month)
17296 ((org-pos-in-match-range pos 7) 'hour)
17297 ((org-pos-in-match-range pos 8) 'minute)
17298 ((or (org-pos-in-match-range pos 4)
17299 (org-pos-in-match-range pos 5)) 'day)
17300 ((and (> pos (or (match-end 8) (match-end 5)))
17301 (< pos (match-end 0)))
17302 (- pos (or (match-end 8) (match-end 5))))
17303 (t 'day))))
17304 ans))
17306 (defun org-toggle-timestamp-type ()
17307 "Toggle the type (<active> or [inactive]) of a time stamp."
17308 (interactive)
17309 (when (org-at-timestamp-p t)
17310 (let ((beg (match-beginning 0)) (end (match-end 0))
17311 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17312 (save-excursion
17313 (goto-char beg)
17314 (while (re-search-forward "[][<>]" end t)
17315 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17316 t t)))
17317 (message "Timestamp is now %sactive"
17318 (if (equal (char-after beg) ?<) "" "in")))))
17320 (defun org-at-clock-log-p nil
17321 "Is the cursor on the clock log line?"
17322 (save-excursion
17323 (move-beginning-of-line 1)
17324 (looking-at "^[ \t]*CLOCK:")))
17326 (defvar org-clock-history) ; defined in org-clock.el
17327 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17328 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17329 "Change the date in the time stamp at point.
17330 The date will be changed by N times WHAT. WHAT can be `day', `month',
17331 `year', `minute', `second'. If WHAT is not given, the cursor position
17332 in the timestamp determines what will be changed.
17333 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17334 (let ((origin (point)) origin-cat
17335 with-hm inactive
17336 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17337 org-ts-what
17338 extra rem
17339 ts time time0 fixnext clrgx)
17340 (if (not (org-at-timestamp-p t))
17341 (user-error "Not at a timestamp"))
17342 (if (and (not what) (eq org-ts-what 'bracket))
17343 (org-toggle-timestamp-type)
17344 ;; Point isn't on brackets. Remember the part of the time-stamp
17345 ;; the point was in. Indeed, size of time-stamps may change,
17346 ;; but point must be kept in the same category nonetheless.
17347 (setq origin-cat org-ts-what)
17348 (if (and (not what) (not (eq org-ts-what 'day))
17349 org-display-custom-times
17350 (get-text-property (point) 'display)
17351 (not (get-text-property (1- (point)) 'display)))
17352 (setq org-ts-what 'day))
17353 (setq org-ts-what (or what org-ts-what)
17354 inactive (= (char-after (match-beginning 0)) ?\[)
17355 ts (match-string 0))
17356 (replace-match "")
17357 (when (string-match
17358 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17360 (setq extra (match-string 1 ts))
17361 (if suppress-tmp-delay
17362 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17363 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17364 (setq with-hm t))
17365 (setq time0 (org-parse-time-string ts))
17366 (when (and updown
17367 (eq org-ts-what 'minute)
17368 (not current-prefix-arg))
17369 ;; This looks like s-up and s-down. Change by one rounding step.
17370 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17371 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17372 (setcar (cdr time0) (+ (nth 1 time0)
17373 (if (> n 0) (- rem) (- dm rem))))))
17374 (setq time
17375 (encode-time (or (car time0) 0)
17376 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17377 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17378 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17379 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17380 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17381 (nthcdr 6 time0)))
17382 (when (and (member org-ts-what '(hour minute))
17383 extra
17384 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17385 (setq extra (org-modify-ts-extra
17386 extra
17387 (if (eq org-ts-what 'hour) 2 5)
17388 n dm)))
17389 (when (integerp org-ts-what)
17390 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17391 (if (eq what 'calendar)
17392 (let ((cal-date (org-get-date-from-calendar)))
17393 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17394 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17395 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17396 (setcar time0 (or (car time0) 0))
17397 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17398 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17399 (setq time (apply 'encode-time time0))))
17400 ;; Insert the new time-stamp, and ensure point stays in the same
17401 ;; category as before (i.e. not after the last position in that
17402 ;; category).
17403 (let ((pos (point)))
17404 ;; Stay before inserted string. `save-excursion' is of no use.
17405 (setq org-last-changed-timestamp
17406 (org-insert-time-stamp time with-hm inactive nil nil extra))
17407 (goto-char pos))
17408 (save-match-data
17409 (looking-at org-ts-regexp3)
17410 (goto-char (cond
17411 ;; `day' category ends before `hour' if any, or at
17412 ;; the end of the day name.
17413 ((eq origin-cat 'day)
17414 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17415 ((eq origin-cat 'hour) (min (match-end 7) origin))
17416 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17417 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17418 ;; `year' and `month' have both fixed size: point
17419 ;; couldn't have moved into another part.
17420 (t origin))))
17421 ;; Update clock if on a CLOCK line.
17422 (org-clock-update-time-maybe)
17423 ;; Maybe adjust the closest clock in `org-clock-history'
17424 (when org-clock-adjust-closest
17425 (if (not (and (org-at-clock-log-p)
17426 (< 1 (length (delq nil (mapcar 'marker-position
17427 org-clock-history))))))
17428 (message "No clock to adjust")
17429 (cond ((save-excursion ; fix previous clock?
17430 (re-search-backward org-ts-regexp0 nil t)
17431 (org-looking-back (concat org-clock-string " \\[")))
17432 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17433 ((save-excursion ; fix next clock?
17434 (re-search-backward org-ts-regexp0 nil t)
17435 (looking-at (concat org-ts-regexp0 "\\] =>")))
17436 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17437 (save-window-excursion
17438 ;; Find closest clock to point, adjust the previous/next one in history
17439 (let* ((p (save-excursion (org-back-to-heading t)))
17440 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17441 (clfixnth
17442 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17443 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17444 (if (not clfixpos)
17445 (message "No clock to adjust")
17446 (save-excursion
17447 (org-goto-marker-or-bmk clfixpos)
17448 (org-show-subtree)
17449 (when (re-search-forward clrgx nil t)
17450 (goto-char (match-beginning 1))
17451 (let (org-clock-adjust-closest)
17452 (org-timestamp-change n org-ts-what updown))
17453 (message "Clock adjusted in %s for heading: %s"
17454 (file-name-nondirectory (buffer-file-name))
17455 (org-get-heading t t)))))))))
17456 ;; Try to recenter the calendar window, if any.
17457 (if (and org-calendar-follow-timestamp-change
17458 (get-buffer-window "*Calendar*" t)
17459 (memq org-ts-what '(day month year)))
17460 (org-recenter-calendar (time-to-days time))))))
17462 (defun org-modify-ts-extra (s pos n dm)
17463 "Change the different parts of the lead-time and repeat fields in timestamp."
17464 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17465 ng h m new rem)
17466 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17467 (cond
17468 ((or (org-pos-in-match-range pos 2)
17469 (org-pos-in-match-range pos 3))
17470 (setq m (string-to-number (match-string 3 s))
17471 h (string-to-number (match-string 2 s)))
17472 (if (org-pos-in-match-range pos 2)
17473 (setq h (+ h n))
17474 (setq n (* dm (org-no-warnings (signum n))))
17475 (when (not (= 0 (setq rem (% m dm))))
17476 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17477 (setq m (+ m n)))
17478 (if (< m 0) (setq m (+ m 60) h (1- h)))
17479 (if (> m 59) (setq m (- m 60) h (1+ h)))
17480 (setq h (min 24 (max 0 h)))
17481 (setq ng 1 new (format "-%02d:%02d" h m)))
17482 ((org-pos-in-match-range pos 6)
17483 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17484 ((org-pos-in-match-range pos 5)
17485 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17487 ((org-pos-in-match-range pos 9)
17488 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17489 ((org-pos-in-match-range pos 8)
17490 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17492 (when ng
17493 (setq s (concat
17494 (substring s 0 (match-beginning ng))
17496 (substring s (match-end ng))))))
17499 (defun org-recenter-calendar (date)
17500 "If the calendar is visible, recenter it to DATE."
17501 (let ((cwin (get-buffer-window "*Calendar*" t)))
17502 (when cwin
17503 (let ((calendar-move-hook nil))
17504 (with-selected-window cwin
17505 (calendar-goto-date (if (listp date) date
17506 (calendar-gregorian-from-absolute date))))))))
17508 (defun org-goto-calendar (&optional arg)
17509 "Go to the Emacs calendar at the current date.
17510 If there is a time stamp in the current line, go to that date.
17511 A prefix ARG can be used to force the current date."
17512 (interactive "P")
17513 (let ((tsr org-ts-regexp) diff
17514 (calendar-move-hook nil)
17515 (calendar-view-holidays-initially-flag nil)
17516 (calendar-view-diary-initially-flag nil))
17517 (if (or (org-at-timestamp-p)
17518 (save-excursion
17519 (beginning-of-line 1)
17520 (looking-at (concat ".*" tsr))))
17521 (let ((d1 (time-to-days (current-time)))
17522 (d2 (time-to-days
17523 (org-time-string-to-time (match-string 1)))))
17524 (setq diff (- d2 d1))))
17525 (calendar)
17526 (calendar-goto-today)
17527 (if (and diff (not arg)) (calendar-forward-day diff))))
17529 (defun org-get-date-from-calendar ()
17530 "Return a list (month day year) of date at point in calendar."
17531 (with-current-buffer "*Calendar*"
17532 (save-match-data
17533 (calendar-cursor-to-date))))
17535 (defun org-date-from-calendar ()
17536 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17537 If there is already a time stamp at the cursor position, update it."
17538 (interactive)
17539 (if (org-at-timestamp-p t)
17540 (org-timestamp-change 0 'calendar)
17541 (let ((cal-date (org-get-date-from-calendar)))
17542 (org-insert-time-stamp
17543 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17545 (defcustom org-effort-durations
17546 `(("h" . 60)
17547 ("d" . ,(* 60 8))
17548 ("w" . ,(* 60 8 5))
17549 ("m" . ,(* 60 8 5 4))
17550 ("y" . ,(* 60 8 5 40)))
17551 "Conversion factor to minutes for an effort modifier.
17553 Each entry has the form (MODIFIER . MINUTES).
17555 In an effort string, a number followed by MODIFIER is multiplied
17556 by the specified number of MINUTES to obtain an effort in
17557 minutes.
17559 For example, if the value of this variable is ((\"hours\" . 60)), then an
17560 effort string \"2hours\" is equivalent to 120 minutes."
17561 :group 'org-agenda
17562 :version "24.1"
17563 :type '(alist :key-type (string :tag "Modifier")
17564 :value-type (number :tag "Minutes")))
17566 (defun org-minutes-to-clocksum-string (m)
17567 "Format number of minutes as a clocksum string.
17568 The format is determined by `org-time-clocksum-format',
17569 `org-time-clocksum-use-fractional' and
17570 `org-time-clocksum-fractional-format' and
17571 `org-time-clocksum-use-effort-durations'."
17572 (let ((clocksum "")
17573 (m (round m)) ; Don't allow fractions of minutes
17574 h d w mo y fmt n)
17575 (setq h (if org-time-clocksum-use-effort-durations
17576 (cdr (assoc "h" org-effort-durations)) 60)
17577 d (if org-time-clocksum-use-effort-durations
17578 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17579 w (if org-time-clocksum-use-effort-durations
17580 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17581 mo (if org-time-clocksum-use-effort-durations
17582 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17583 y (if org-time-clocksum-use-effort-durations
17584 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17585 ;; fractional format
17586 (if org-time-clocksum-use-fractional
17587 (cond
17588 ;; single format string
17589 ((stringp org-time-clocksum-fractional-format)
17590 (format org-time-clocksum-fractional-format (/ m (float h))))
17591 ;; choice of fractional formats for different time units
17592 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17593 (> (/ (truncate m) (* y d h)) 0))
17594 (format fmt (/ m (* y d (float h)))))
17595 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17596 (> (/ (truncate m) (* mo d h)) 0))
17597 (format fmt (/ m (* mo d (float h)))))
17598 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17599 (> (/ (truncate m) (* w d h)) 0))
17600 (format fmt (/ m (* w d (float h)))))
17601 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17602 (> (/ (truncate m) (* d h)) 0))
17603 (format fmt (/ m (* d (float h)))))
17604 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17605 (> (/ (truncate m) h) 0))
17606 (format fmt (/ m (float h))))
17607 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17608 (format fmt m))
17609 ;; fall back to smallest time unit with a format
17610 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17611 (format fmt (/ m (float h))))
17612 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17613 (format fmt (/ m (* d (float h)))))
17614 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17615 (format fmt (/ m (* w d (float h)))))
17616 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17617 (format fmt (/ m (* mo d (float h)))))
17618 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17619 (format fmt (/ m (* y d (float h))))))
17620 ;; standard (non-fractional) format, with single format string
17621 (if (stringp org-time-clocksum-format)
17622 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17623 ;; separate formats components
17624 (and (setq fmt (plist-get org-time-clocksum-format :years))
17625 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17626 (plist-get org-time-clocksum-format :require-years))
17627 (setq clocksum (concat clocksum (format fmt n))
17628 m (- m (* n y d h))))
17629 (and (setq fmt (plist-get org-time-clocksum-format :months))
17630 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17631 (plist-get org-time-clocksum-format :require-months))
17632 (setq clocksum (concat clocksum (format fmt n))
17633 m (- m (* n mo d h))))
17634 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17635 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17636 (plist-get org-time-clocksum-format :require-weeks))
17637 (setq clocksum (concat clocksum (format fmt n))
17638 m (- m (* n w d h))))
17639 (and (setq fmt (plist-get org-time-clocksum-format :days))
17640 (or (> (setq n (/ (truncate m) (* d h))) 0)
17641 (plist-get org-time-clocksum-format :require-days))
17642 (setq clocksum (concat clocksum (format fmt n))
17643 m (- m (* n d h))))
17644 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17645 (or (> (setq n (/ (truncate m) h)) 0)
17646 (plist-get org-time-clocksum-format :require-hours))
17647 (setq clocksum (concat clocksum (format fmt n))
17648 m (- m (* n h))))
17649 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17650 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17651 (setq clocksum (concat clocksum (format fmt m))))
17652 ;; return formatted time duration
17653 clocksum))))
17655 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17656 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17657 "Org mode version 8.0")
17659 (defun org-hours-to-clocksum-string (n)
17660 (org-minutes-to-clocksum-string (* n 60)))
17662 (defun org-hh:mm-string-to-minutes (s)
17663 "Convert a string H:MM to a number of minutes.
17664 If the string is just a number, interpret it as minutes.
17665 In fact, the first hh:mm or number in the string will be taken,
17666 there can be extra stuff in the string.
17667 If no number is found, the return value is 0."
17668 (cond
17669 ((integerp s) s)
17670 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17671 (+ (* (string-to-number (match-string 1 s)) 60)
17672 (string-to-number (match-string 2 s))))
17673 ((string-match "\\([0-9]+\\)" s)
17674 (string-to-number (match-string 1 s)))
17675 (t 0)))
17677 (defcustom org-image-actual-width t
17678 "Should we use the actual width of images when inlining them?
17680 When set to `t', always use the image width.
17682 When set to a number, use imagemagick (when available) to set
17683 the image's width to this value.
17685 When set to a number in a list, try to get the width from any
17686 #+ATTR.* keyword if it matches a width specification like
17688 #+ATTR_HTML: :width 300px
17690 and fall back on that number if none is found.
17692 When set to nil, try to get the width from an #+ATTR.* keyword
17693 and fall back on the original width if none is found.
17695 This requires Emacs >= 24.1, build with imagemagick support."
17696 :group 'org-appearance
17697 :version "24.4"
17698 :package-version '(Org . "8.0")
17699 :type '(choice
17700 (const :tag "Use the image width" t)
17701 (integer :tag "Use a number of pixels")
17702 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17703 (const :tag "Use #+ATTR* or don't resize" nil)))
17705 (defcustom org-agenda-inhibit-startup nil
17706 "Inhibit startup when preparing agenda buffers.
17707 When this variable is `t' (the default), the initialization of
17708 the Org agenda buffers is inhibited: e.g. the visibility state
17709 is not set, the tables are not re-aligned, etc."
17710 :type 'boolean
17711 :version "24.3"
17712 :group 'org-agenda)
17714 (defcustom org-agenda-ignore-drawer-properties nil
17715 "Avoid updating text properties when building the agenda.
17716 Properties are used to prepare buffers for effort estimates, appointments,
17717 and subtree-local categories.
17718 If you don't use these in the agenda, you can add them to this list and
17719 agenda building will be a bit faster.
17720 The value is a list, with zero or more of the symbols `effort', `appt',
17721 or `category'."
17722 :type '(set :greedy t
17723 (const effort)
17724 (const appt)
17725 (const category))
17726 :version "24.3"
17727 :group 'org-agenda)
17729 (defun org-duration-string-to-minutes (s &optional output-to-string)
17730 "Convert a duration string S to minutes.
17732 A bare number is interpreted as minutes, modifiers can be set by
17733 customizing `org-effort-durations' (which see).
17735 Entries containing a colon are interpreted as H:MM by
17736 `org-hh:mm-string-to-minutes'."
17737 (let ((result 0)
17738 (re (concat "\\([0-9.]+\\) *\\("
17739 (regexp-opt (mapcar 'car org-effort-durations))
17740 "\\)")))
17741 (while (string-match re s)
17742 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17743 (string-to-number (match-string 1 s))))
17744 (setq s (replace-match "" nil t s)))
17745 (setq result (floor result))
17746 (incf result (org-hh:mm-string-to-minutes s))
17747 (if output-to-string (number-to-string result) result)))
17749 ;;;; Files
17751 (defun org-save-all-org-buffers ()
17752 "Save all Org-mode buffers without user confirmation."
17753 (interactive)
17754 (message "Saving all Org-mode buffers...")
17755 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17756 (when (featurep 'org-id) (org-id-locations-save))
17757 (message "Saving all Org-mode buffers... done"))
17759 (defun org-revert-all-org-buffers ()
17760 "Revert all Org-mode buffers.
17761 Prompt for confirmation when there are unsaved changes.
17762 Be sure you know what you are doing before letting this function
17763 overwrite your changes.
17765 This function is useful in a setup where one tracks org files
17766 with a version control system, to revert on one machine after pulling
17767 changes from another. I believe the procedure must be like this:
17769 1. M-x org-save-all-org-buffers
17770 2. Pull changes from the other machine, resolve conflicts
17771 3. M-x org-revert-all-org-buffers"
17772 (interactive)
17773 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17774 (user-error "Abort"))
17775 (save-excursion
17776 (save-window-excursion
17777 (mapc
17778 (lambda (b)
17779 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17780 (with-current-buffer b buffer-file-name))
17781 (org-pop-to-buffer-same-window b)
17782 (revert-buffer t 'no-confirm)))
17783 (buffer-list))
17784 (when (and (featurep 'org-id) org-id-track-globally)
17785 (org-id-locations-load)))))
17787 ;;;; Agenda files
17789 ;;;###autoload
17790 (defun org-switchb (&optional arg)
17791 "Switch between Org buffers.
17792 With one prefix argument, restrict available buffers to files.
17793 With two prefix arguments, restrict available buffers to agenda files.
17795 Defaults to `iswitchb' for buffer name completion.
17796 Set `org-completion-use-ido' to make it use ido instead."
17797 (interactive "P")
17798 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17799 ((equal arg '(16)) (org-buffer-list 'agenda))
17800 (t (org-buffer-list))))
17801 (org-completion-use-iswitchb org-completion-use-iswitchb)
17802 (org-completion-use-ido org-completion-use-ido))
17803 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17804 (setq org-completion-use-iswitchb t))
17805 (org-pop-to-buffer-same-window
17806 (org-icompleting-read "Org buffer: "
17807 (mapcar 'list (mapcar 'buffer-name blist))
17808 nil t))))
17810 ;;; Define some older names previously used for this functionality
17811 ;;;###autoload
17812 (defalias 'org-ido-switchb 'org-switchb)
17813 ;;;###autoload
17814 (defalias 'org-iswitchb 'org-switchb)
17816 (defun org-buffer-list (&optional predicate exclude-tmp)
17817 "Return a list of Org buffers.
17818 PREDICATE can be `export', `files' or `agenda'.
17820 export restrict the list to Export buffers.
17821 files restrict the list to buffers visiting Org files.
17822 agenda restrict the list to buffers visiting agenda files.
17824 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17825 (let* ((bfn nil)
17826 (agenda-files (and (eq predicate 'agenda)
17827 (mapcar 'file-truename (org-agenda-files t))))
17828 (filter
17829 (cond
17830 ((eq predicate 'files)
17831 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17832 ((eq predicate 'export)
17833 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17834 ((eq predicate 'agenda)
17835 (lambda (b)
17836 (with-current-buffer b
17837 (and (derived-mode-p 'org-mode)
17838 (setq bfn (buffer-file-name b))
17839 (member (file-truename bfn) agenda-files)))))
17840 (t (lambda (b) (with-current-buffer b
17841 (or (derived-mode-p 'org-mode)
17842 (string-match "\*Org .*Export"
17843 (buffer-name b)))))))))
17844 (delq nil
17845 (mapcar
17846 (lambda(b)
17847 (if (and (funcall filter b)
17848 (or (not exclude-tmp)
17849 (not (string-match "tmp" (buffer-name b)))))
17851 nil))
17852 (buffer-list)))))
17854 (defun org-agenda-files (&optional unrestricted archives)
17855 "Get the list of agenda files.
17856 Optional UNRESTRICTED means return the full list even if a restriction
17857 is currently in place.
17858 When ARCHIVES is t, include all archive files that are really being
17859 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17860 `org-agenda-archives-mode' is t."
17861 (let ((files
17862 (cond
17863 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17864 ((stringp org-agenda-files) (org-read-agenda-file-list))
17865 ((listp org-agenda-files) org-agenda-files)
17866 (t (error "Invalid value of `org-agenda-files'")))))
17867 (setq files (apply 'append
17868 (mapcar (lambda (f)
17869 (if (file-directory-p f)
17870 (directory-files
17871 f t org-agenda-file-regexp)
17872 (list f)))
17873 files)))
17874 (when org-agenda-skip-unavailable-files
17875 (setq files (delq nil
17876 (mapcar (function
17877 (lambda (file)
17878 (and (file-readable-p file) file)))
17879 files))))
17880 (when (or (eq archives t)
17881 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17882 (setq files (org-add-archive-files files)))
17883 files))
17885 (defun org-agenda-file-p (&optional file)
17886 "Return non-nil, if FILE is an agenda file.
17887 If FILE is omitted, use the file associated with the current
17888 buffer."
17889 (member (or file (buffer-file-name))
17890 (org-agenda-files t)))
17892 (defun org-edit-agenda-file-list ()
17893 "Edit the list of agenda files.
17894 Depending on setup, this either uses customize to edit the variable
17895 `org-agenda-files', or it visits the file that is holding the list. In the
17896 latter case, the buffer is set up in a way that saving it automatically kills
17897 the buffer and restores the previous window configuration."
17898 (interactive)
17899 (if (stringp org-agenda-files)
17900 (let ((cw (current-window-configuration)))
17901 (find-file org-agenda-files)
17902 (org-set-local 'org-window-configuration cw)
17903 (org-add-hook 'after-save-hook
17904 (lambda ()
17905 (set-window-configuration
17906 (prog1 org-window-configuration
17907 (kill-buffer (current-buffer))))
17908 (org-install-agenda-files-menu)
17909 (message "New agenda file list installed"))
17910 nil 'local)
17911 (message "%s" (substitute-command-keys
17912 "Edit list and finish with \\[save-buffer]")))
17913 (customize-variable 'org-agenda-files)))
17915 (defun org-store-new-agenda-file-list (list)
17916 "Set new value for the agenda file list and save it correctly."
17917 (if (stringp org-agenda-files)
17918 (let ((fe (org-read-agenda-file-list t)) b u)
17919 (while (setq b (find-buffer-visiting org-agenda-files))
17920 (kill-buffer b))
17921 (with-temp-file org-agenda-files
17922 (insert
17923 (mapconcat
17924 (lambda (f) ;; Keep un-expanded entries.
17925 (if (setq u (assoc f fe))
17926 (cdr u)
17928 list "\n")
17929 "\n")))
17930 (let ((org-mode-hook nil) (org-inhibit-startup t)
17931 (org-insert-mode-line-in-empty-file nil))
17932 (setq org-agenda-files list)
17933 (customize-save-variable 'org-agenda-files org-agenda-files))))
17935 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17936 "Read the list of agenda files from a file.
17937 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17938 filenames, used by `org-store-new-agenda-file-list' to write back
17939 un-expanded file names."
17940 (when (file-directory-p org-agenda-files)
17941 (error "`org-agenda-files' cannot be a single directory"))
17942 (when (stringp org-agenda-files)
17943 (with-temp-buffer
17944 (insert-file-contents org-agenda-files)
17945 (mapcar
17946 (lambda (f)
17947 (let ((e (expand-file-name (substitute-in-file-name f)
17948 org-directory)))
17949 (if pair-with-expansion
17950 (cons e f)
17951 e)))
17952 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
17954 ;;;###autoload
17955 (defun org-cycle-agenda-files ()
17956 "Cycle through the files in `org-agenda-files'.
17957 If the current buffer visits an agenda file, find the next one in the list.
17958 If the current buffer does not, find the first agenda file."
17959 (interactive)
17960 (let* ((fs (org-agenda-files t))
17961 (files (append fs (list (car fs))))
17962 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17963 file)
17964 (unless files (user-error "No agenda files"))
17965 (catch 'exit
17966 (while (setq file (pop files))
17967 (if (equal (file-truename file) tcf)
17968 (when (car files)
17969 (find-file (car files))
17970 (throw 'exit t))))
17971 (find-file (car fs)))
17972 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17974 (defun org-agenda-file-to-front (&optional to-end)
17975 "Move/add the current file to the top of the agenda file list.
17976 If the file is not present in the list, it is added to the front. If it is
17977 present, it is moved there. With optional argument TO-END, add/move to the
17978 end of the list."
17979 (interactive "P")
17980 (let ((org-agenda-skip-unavailable-files nil)
17981 (file-alist (mapcar (lambda (x)
17982 (cons (file-truename x) x))
17983 (org-agenda-files t)))
17984 (ctf (file-truename
17985 (or buffer-file-name
17986 (user-error "Please save the current buffer to a file"))))
17987 x had)
17988 (setq x (assoc ctf file-alist) had x)
17990 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17991 (if to-end
17992 (setq file-alist (append (delq x file-alist) (list x)))
17993 (setq file-alist (cons x (delq x file-alist))))
17994 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17995 (org-install-agenda-files-menu)
17996 (message "File %s to %s of agenda file list"
17997 (if had "moved" "added") (if to-end "end" "front"))))
17999 (defun org-remove-file (&optional file)
18000 "Remove current file from the list of files in variable `org-agenda-files'.
18001 These are the files which are being checked for agenda entries.
18002 Optional argument FILE means use this file instead of the current."
18003 (interactive)
18004 (let* ((org-agenda-skip-unavailable-files nil)
18005 (file (or file buffer-file-name
18006 (user-error "Current buffer does not visit a file")))
18007 (true-file (file-truename file))
18008 (afile (abbreviate-file-name file))
18009 (files (delq nil (mapcar
18010 (lambda (x)
18011 (if (equal true-file
18012 (file-truename x))
18013 nil x))
18014 (org-agenda-files t)))))
18015 (if (not (= (length files) (length (org-agenda-files t))))
18016 (progn
18017 (org-store-new-agenda-file-list files)
18018 (org-install-agenda-files-menu)
18019 (message "Removed file: %s" afile))
18020 (message "File was not in list: %s (not removed)" afile))))
18022 (defun org-file-menu-entry (file)
18023 (vector file (list 'find-file file) t))
18025 (defun org-check-agenda-file (file)
18026 "Make sure FILE exists. If not, ask user what to do."
18027 (when (not (file-exists-p file))
18028 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18029 (abbreviate-file-name file))
18030 (let ((r (downcase (read-char-exclusive))))
18031 (cond
18032 ((equal r ?r)
18033 (org-remove-file file)
18034 (throw 'nextfile t))
18035 (t (error "Abort"))))))
18037 (defun org-get-agenda-file-buffer (file)
18038 "Get a buffer visiting FILE. If the buffer needs to be created, add
18039 it to the list of buffers which might be released later."
18040 (let ((buf (org-find-base-buffer-visiting file)))
18041 (if buf
18042 buf ; just return it
18043 ;; Make a new buffer and remember it
18044 (setq buf (find-file-noselect file))
18045 (if buf (push buf org-agenda-new-buffers))
18046 buf)))
18048 (defun org-release-buffers (blist)
18049 "Release all buffers in list, asking the user for confirmation when needed.
18050 When a buffer is unmodified, it is just killed. When modified, it is saved
18051 \(if the user agrees) and then killed."
18052 (let (buf file)
18053 (while (setq buf (pop blist))
18054 (setq file (buffer-file-name buf))
18055 (when (and (buffer-modified-p buf)
18056 file
18057 (y-or-n-p (format "Save file %s? " file)))
18058 (with-current-buffer buf (save-buffer)))
18059 (kill-buffer buf))))
18061 (defun org-agenda-prepare-buffers (files)
18062 "Create buffers for all agenda files, protect archived trees and comments."
18063 (interactive)
18064 (let ((pa '(:org-archived t))
18065 (pc '(:org-comment t))
18066 (pall '(:org-archived t :org-comment t))
18067 (inhibit-read-only t)
18068 (org-inhibit-startup org-agenda-inhibit-startup)
18069 (rea (concat ":" org-archive-tag ":"))
18070 file re pos)
18071 (setq org-tag-alist-for-agenda nil
18072 org-tag-groups-alist-for-agenda nil)
18073 (save-excursion
18074 (save-restriction
18075 (while (setq file (pop files))
18076 (catch 'nextfile
18077 (if (bufferp file)
18078 (set-buffer file)
18079 (org-check-agenda-file file)
18080 (set-buffer (org-get-agenda-file-buffer file)))
18081 (widen)
18082 (org-set-regexps-and-options-for-tags)
18083 (setq pos (point))
18084 (goto-char (point-min))
18085 (let ((case-fold-search t))
18086 (when (search-forward "#+setupfile" nil t)
18087 ;; Don't set all regexps and options systematically as
18088 ;; this is only run for setting agenda tags from setup
18089 ;; file
18090 (org-set-regexps-and-options)))
18091 (or (memq 'category org-agenda-ignore-drawer-properties)
18092 (org-refresh-category-properties))
18093 (or (memq 'effort org-agenda-ignore-drawer-properties)
18094 (org-refresh-properties org-effort-property 'org-effort))
18095 (or (memq 'appt org-agenda-ignore-drawer-properties)
18096 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18097 (setq org-todo-keywords-for-agenda
18098 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18099 (setq org-done-keywords-for-agenda
18100 (append org-done-keywords-for-agenda org-done-keywords))
18101 (setq org-todo-keyword-alist-for-agenda
18102 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18103 (setq org-drawers-for-agenda
18104 (append org-drawers-for-agenda org-drawers))
18105 (setq org-tag-alist-for-agenda
18106 (org-uniquify
18107 (append org-tag-alist-for-agenda
18108 org-tag-alist
18109 org-tag-persistent-alist)))
18110 (if org-group-tags
18111 (setq org-tag-groups-alist-for-agenda
18112 (org-uniquify-alist
18113 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18114 (org-with-silent-modifications
18115 (save-excursion
18116 (remove-text-properties (point-min) (point-max) pall)
18117 (when org-agenda-skip-archived-trees
18118 (goto-char (point-min))
18119 (while (re-search-forward rea nil t)
18120 (if (org-at-heading-p t)
18121 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18122 (goto-char (point-min))
18123 (setq re (format org-heading-keyword-regexp-format
18124 org-comment-string))
18125 (while (re-search-forward re nil t)
18126 (add-text-properties
18127 (match-beginning 0) (org-end-of-subtree t) pc))))
18128 (goto-char pos)))))
18129 (setq org-todo-keywords-for-agenda
18130 (org-uniquify org-todo-keywords-for-agenda))
18131 (setq org-todo-keyword-alist-for-agenda
18132 (org-uniquify org-todo-keyword-alist-for-agenda))))
18135 ;;;; CDLaTeX minor mode
18137 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18138 "Keymap for the minor `org-cdlatex-mode'.")
18140 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18141 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18142 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18143 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18144 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18146 (defvar org-cdlatex-texmathp-advice-is-done nil
18147 "Flag remembering if we have applied the advice to texmathp already.")
18149 (define-minor-mode org-cdlatex-mode
18150 "Toggle the minor `org-cdlatex-mode'.
18151 This mode supports entering LaTeX environment and math in LaTeX fragments
18152 in Org-mode.
18153 \\{org-cdlatex-mode-map}"
18154 nil " OCDL" nil
18155 (when org-cdlatex-mode
18156 (require 'cdlatex)
18157 (run-hooks 'cdlatex-mode-hook)
18158 (cdlatex-compute-tables))
18159 (unless org-cdlatex-texmathp-advice-is-done
18160 (setq org-cdlatex-texmathp-advice-is-done t)
18161 (defadvice texmathp (around org-math-always-on activate)
18162 "Always return t in org-mode buffers.
18163 This is because we want to insert math symbols without dollars even outside
18164 the LaTeX math segments. If Orgmode thinks that point is actually inside
18165 an embedded LaTeX fragment, let texmathp do its job.
18166 \\[org-cdlatex-mode-map]"
18167 (interactive)
18168 (let (p)
18169 (cond
18170 ((not (derived-mode-p 'org-mode)) ad-do-it)
18171 ((eq this-command 'cdlatex-math-symbol)
18172 (setq ad-return-value t
18173 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18175 (let ((p (org-inside-LaTeX-fragment-p)))
18176 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18177 (setq ad-return-value t
18178 texmathp-why '("Org-mode embedded math" . 0))
18179 (if p ad-do-it)))))))))
18181 (defun turn-on-org-cdlatex ()
18182 "Unconditionally turn on `org-cdlatex-mode'."
18183 (org-cdlatex-mode 1))
18185 (defun org-try-cdlatex-tab ()
18186 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18187 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18188 - inside a LaTeX fragment, or
18189 - after the first word in a line, where an abbreviation expansion could
18190 insert a LaTeX environment."
18191 (when org-cdlatex-mode
18192 (cond
18193 ;; Before any word on the line: No expansion possible.
18194 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18195 ;; Just after first word on the line: Expand it. Make sure it
18196 ;; cannot happen on headlines, though.
18197 ((save-excursion
18198 (skip-chars-backward "a-zA-Z0-9*")
18199 (skip-chars-backward " \t")
18200 (and (bolp) (not (org-at-heading-p))))
18201 (cdlatex-tab) t)
18202 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18204 (defun org-cdlatex-underscore-caret (&optional arg)
18205 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18206 Revert to the normal definition outside of these fragments."
18207 (interactive "P")
18208 (if (org-inside-LaTeX-fragment-p)
18209 (call-interactively 'cdlatex-sub-superscript)
18210 (let (org-cdlatex-mode)
18211 (call-interactively (key-binding (vector last-input-event))))))
18213 (defun org-cdlatex-math-modify (&optional arg)
18214 "Execute `cdlatex-math-modify' in LaTeX fragments.
18215 Revert to the normal definition outside of these fragments."
18216 (interactive "P")
18217 (if (org-inside-LaTeX-fragment-p)
18218 (call-interactively 'cdlatex-math-modify)
18219 (let (org-cdlatex-mode)
18220 (call-interactively (key-binding (vector last-input-event))))))
18224 ;;;; LaTeX fragments
18226 (defvar org-latex-regexps
18227 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
18228 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18229 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
18230 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18231 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18232 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
18233 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
18234 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
18235 "Regular expressions for matching embedded LaTeX.")
18237 (defun org-inside-LaTeX-fragment-p ()
18238 "Test if point is inside a LaTeX fragment.
18239 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18240 sequence appearing also before point.
18241 Even though the matchers for math are configurable, this function assumes
18242 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18243 delimiters are skipped when they have been removed by customization.
18244 The return value is nil, or a cons cell with the delimiter and the
18245 position of this delimiter.
18247 This function does a reasonably good job, but can locally be fooled by
18248 for example currency specifications. For example it will assume being in
18249 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18250 fragments that are properly closed, but during editing, we have to live
18251 with the uncertainty caused by missing closing delimiters. This function
18252 looks only before point, not after."
18253 (catch 'exit
18254 (let ((pos (point))
18255 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18256 (lim (progn
18257 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18258 (point)))
18259 dd-on str (start 0) m re)
18260 (goto-char pos)
18261 (when dodollar
18262 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18263 re (nth 1 (assoc "$" org-latex-regexps)))
18264 (while (string-match re str start)
18265 (cond
18266 ((= (match-end 0) (length str))
18267 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18268 ((= (match-end 0) (- (length str) 5))
18269 (throw 'exit nil))
18270 (t (setq start (match-end 0))))))
18271 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18272 (goto-char pos)
18273 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18274 (and (match-beginning 2) (throw 'exit nil))
18275 ;; count $$
18276 (while (re-search-backward "\\$\\$" lim t)
18277 (setq dd-on (not dd-on)))
18278 (goto-char pos)
18279 (if dd-on (cons "$$" m))))))
18281 (defun org-inside-latex-macro-p ()
18282 "Is point inside a LaTeX macro or its arguments?"
18283 (save-match-data
18284 (org-in-regexp
18285 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18287 (defvar org-latex-fragment-image-overlays nil
18288 "List of overlays carrying the images of latex fragments.")
18289 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18291 (defun org-remove-latex-fragment-image-overlays ()
18292 "Remove all overlays with LaTeX fragment images in current buffer."
18293 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18294 (setq org-latex-fragment-image-overlays nil))
18296 (defun org-preview-latex-fragment (&optional subtree)
18297 "Preview the LaTeX fragment at point, or all locally or globally.
18298 If the cursor is in a LaTeX fragment, create the image and overlay
18299 it over the source code. If there is no fragment at point, display
18300 all fragments in the current text, from one headline to the next. With
18301 prefix SUBTREE, display all fragments in the current subtree. With a
18302 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18303 the cursor is before the first headline,
18304 display all fragments in the buffer.
18305 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
18306 (interactive "P")
18307 (unless buffer-file-name
18308 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18309 (when (display-graphic-p)
18310 (org-remove-latex-fragment-image-overlays)
18311 (save-excursion
18312 (save-restriction
18313 (let (beg end at msg)
18314 (cond
18315 ((or (equal subtree '(16))
18316 (not (save-excursion
18317 (re-search-backward org-outline-regexp-bol nil t))))
18318 (setq beg (point-min) end (point-max)
18319 msg "Creating images for buffer...%s"))
18320 ((equal subtree '(4))
18321 (org-back-to-heading)
18322 (setq beg (point) end (org-end-of-subtree t)
18323 msg "Creating images for subtree...%s"))
18325 (if (setq at (org-inside-LaTeX-fragment-p))
18326 (goto-char (max (point-min) (- (cdr at) 2)))
18327 (org-back-to-heading))
18328 (setq beg (point) end (progn (outline-next-heading) (point))
18329 msg (if at "Creating image...%s"
18330 "Creating images for entry...%s"))))
18331 (message msg "")
18332 (narrow-to-region beg end)
18333 (goto-char beg)
18334 (org-format-latex
18335 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18336 (file-name-nondirectory
18337 buffer-file-name)))
18338 default-directory 'overlays msg at 'forbuffer
18339 org-latex-create-formula-image-program)
18340 (message msg "done. Use `C-c C-c' to remove images."))))))
18342 (defun org-format-latex (prefix &optional dir overlays msg at
18343 forbuffer processing-type)
18344 "Replace LaTeX fragments with links to an image, and produce images.
18345 Some of the options can be changed using the variable
18346 `org-format-latex-options'."
18347 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18348 (let* ((prefixnodir (file-name-nondirectory prefix))
18349 (absprefix (expand-file-name prefix dir))
18350 (todir (file-name-directory absprefix))
18351 (opt org-format-latex-options)
18352 (optnew org-format-latex-options)
18353 (matchers (plist-get opt :matchers))
18354 (re-list org-latex-regexps)
18355 (cnt 0) txt hash link beg end re e checkdir
18356 string
18357 m n block-type block linkfile movefile ov)
18358 ;; Check the different regular expressions
18359 (while (setq e (pop re-list))
18360 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18361 block (if block-type "\n\n" ""))
18362 (when (member m matchers)
18363 (goto-char (point-min))
18364 (while (re-search-forward re nil t)
18365 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18366 (or (not overlays)
18367 (not (eq (get-char-property (match-beginning n)
18368 'org-overlay-type)
18369 'org-latex-overlay))))
18370 (cond
18371 ((eq processing-type 'verbatim))
18372 ((eq processing-type 'mathjax)
18373 ;; Prepare for MathJax processing.
18374 (setq string (match-string n))
18375 (when (member m '("$" "$1"))
18376 (save-excursion
18377 (delete-region (match-beginning n) (match-end n))
18378 (goto-char (match-beginning n))
18379 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18380 ((or (eq processing-type 'dvipng)
18381 (eq processing-type 'imagemagick))
18382 ;; Process to an image.
18383 (setq txt (match-string n)
18384 beg (match-beginning n) end (match-end n)
18385 cnt (1+ cnt))
18386 (let ((face (face-at-point))
18387 (fg (plist-get opt :foreground))
18388 (bg (plist-get opt :background))
18389 ;; Ensure full list is printed.
18390 print-length print-level)
18391 (when forbuffer
18392 ;; Get the colors from the face at point.
18393 (goto-char beg)
18394 (when (eq fg 'auto)
18395 (setq fg (face-attribute face :foreground nil 'default)))
18396 (when (eq bg 'auto)
18397 (setq bg (face-attribute face :background nil 'default)))
18398 (setq optnew (copy-sequence opt))
18399 (plist-put optnew :foreground fg)
18400 (plist-put optnew :background bg))
18401 (setq hash (sha1 (prin1-to-string
18402 (list org-format-latex-header
18403 org-latex-default-packages-alist
18404 org-latex-packages-alist
18405 org-format-latex-options
18406 forbuffer txt fg bg)))
18407 linkfile (format "%s_%s.png" prefix hash)
18408 movefile (format "%s_%s.png" absprefix hash)))
18409 (setq link (concat block "[[file:" linkfile "]]" block))
18410 (if msg (message msg cnt))
18411 (goto-char beg)
18412 (unless checkdir ; Ensure the directory exists.
18413 (setq checkdir t)
18414 (or (file-directory-p todir) (make-directory todir t)))
18415 (unless (file-exists-p movefile)
18416 (org-create-formula-image
18417 txt movefile optnew forbuffer processing-type))
18418 (if overlays
18419 (progn
18420 (mapc (lambda (o)
18421 (if (eq (overlay-get o 'org-overlay-type)
18422 'org-latex-overlay)
18423 (delete-overlay o)))
18424 (overlays-in beg end))
18425 (setq ov (make-overlay beg end))
18426 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18427 (if (featurep 'xemacs)
18428 (progn
18429 (overlay-put ov 'invisible t)
18430 (overlay-put
18431 ov 'end-glyph
18432 (make-glyph (vector 'png :file movefile))))
18433 (overlay-put
18434 ov 'display
18435 (list 'image :type 'png :file movefile :ascent 'center)))
18436 (push ov org-latex-fragment-image-overlays)
18437 (goto-char end))
18438 (delete-region beg end)
18439 (insert (org-add-props link
18440 (list 'org-latex-src
18441 (replace-regexp-in-string
18442 "\"" "" txt)
18443 'org-latex-src-embed-type
18444 (if block-type 'paragraph 'character))))))
18445 ((eq processing-type 'mathml)
18446 ;; Process to MathML
18447 (unless (save-match-data (org-format-latex-mathml-available-p))
18448 (user-error "LaTeX to MathML converter not configured"))
18449 (setq txt (match-string n)
18450 beg (match-beginning n) end (match-end n)
18451 cnt (1+ cnt))
18452 (if msg (message msg cnt))
18453 (goto-char beg)
18454 (delete-region beg end)
18455 (insert (org-format-latex-as-mathml
18456 txt block-type prefix dir)))
18458 (error "Unknown conversion type %s for LaTeX fragments"
18459 processing-type)))))))))
18461 (defun org-create-math-formula (latex-frag &optional mathml-file)
18462 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18463 Use `org-latex-to-mathml-convert-command'. If the conversion is
18464 sucessful, return the portion between \"<math...> </math>\"
18465 elements otherwise return nil. When MATHML-FILE is specified,
18466 write the results in to that file. When invoked as an
18467 interactive command, prompt for LATEX-FRAG, with initial value
18468 set to the current active region and echo the results for user
18469 inspection."
18470 (interactive (list (let ((frag (when (org-region-active-p)
18471 (buffer-substring-no-properties
18472 (region-beginning) (region-end)))))
18473 (read-string "LaTeX Fragment: " frag nil frag))))
18474 (unless latex-frag (error "Invalid LaTeX fragment"))
18475 (let* ((tmp-in-file (file-relative-name
18476 (make-temp-name (expand-file-name "ltxmathml-in"))))
18477 (ignore (write-region latex-frag nil tmp-in-file))
18478 (tmp-out-file (file-relative-name
18479 (make-temp-name (expand-file-name "ltxmathml-out"))))
18480 (cmd (format-spec
18481 org-latex-to-mathml-convert-command
18482 `((?j . ,(shell-quote-argument
18483 (expand-file-name org-latex-to-mathml-jar-file)))
18484 (?I . ,(shell-quote-argument tmp-in-file))
18485 (?o . ,(shell-quote-argument tmp-out-file)))))
18486 mathml shell-command-output)
18487 (when (org-called-interactively-p 'any)
18488 (unless (org-format-latex-mathml-available-p)
18489 (user-error "LaTeX to MathML converter not configured")))
18490 (message "Running %s" cmd)
18491 (setq shell-command-output (shell-command-to-string cmd))
18492 (setq mathml
18493 (when (file-readable-p tmp-out-file)
18494 (with-current-buffer (find-file-noselect tmp-out-file t)
18495 (goto-char (point-min))
18496 (when (re-search-forward
18497 (concat
18498 (regexp-quote
18499 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18500 "\\(.\\|\n\\)*"
18501 (regexp-quote "</math>")) nil t)
18502 (prog1 (match-string 0) (kill-buffer))))))
18503 (cond
18504 (mathml
18505 (setq mathml
18506 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18507 (when mathml-file
18508 (write-region mathml nil mathml-file))
18509 (when (org-called-interactively-p 'any)
18510 (message mathml)))
18511 ((message "LaTeX to MathML conversion failed")
18512 (message shell-command-output)))
18513 (delete-file tmp-in-file)
18514 (when (file-exists-p tmp-out-file)
18515 (delete-file tmp-out-file))
18516 mathml))
18518 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18519 prefix &optional dir)
18520 "Use `org-create-math-formula' but check local cache first."
18521 (let* ((absprefix (expand-file-name prefix dir))
18522 (print-length nil) (print-level nil)
18523 (formula-id (concat
18524 "formula-"
18525 (sha1
18526 (prin1-to-string
18527 (list latex-frag
18528 org-latex-to-mathml-convert-command)))))
18529 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18530 (formula-cache-dir (file-name-directory formula-cache)))
18532 (unless (file-directory-p formula-cache-dir)
18533 (make-directory formula-cache-dir t))
18535 (unless (file-exists-p formula-cache)
18536 (org-create-math-formula latex-frag formula-cache))
18538 (if (file-exists-p formula-cache)
18539 ;; Successful conversion. Return the link to MathML file.
18540 (org-add-props
18541 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18542 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18543 'org-latex-src-embed-type (if latex-frag-type
18544 'paragraph 'character)))
18545 ;; Failed conversion. Return the LaTeX fragment verbatim
18546 latex-frag)))
18548 (defun org-create-formula-image (string tofile options buffer &optional type)
18549 "Create an image from LaTeX source using dvipng or convert.
18550 This function calls either `org-create-formula-image-with-dvipng'
18551 or `org-create-formula-image-with-imagemagick' depending on the
18552 value of `org-latex-create-formula-image-program' or on the value
18553 of the optional TYPE variable.
18555 Note: ultimately these two function should be combined as they
18556 share a good deal of logic."
18557 (org-check-external-command
18558 "latex" "needed to convert LaTeX fragments to images")
18559 (funcall
18560 (case (or type org-latex-create-formula-image-program)
18561 ('dvipng
18562 (org-check-external-command
18563 "dvipng" "needed to convert LaTeX fragments to images")
18564 #'org-create-formula-image-with-dvipng)
18565 ('imagemagick
18566 (org-check-external-command
18567 "convert" "you need to install imagemagick")
18568 #'org-create-formula-image-with-imagemagick)
18569 (t (error
18570 "Invalid value of `org-latex-create-formula-image-program'")))
18571 string tofile options buffer))
18573 (declare-function org-export-get-backend "ox" (name))
18574 (declare-function org-export--get-global-options "ox" (&optional backend))
18575 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18576 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18577 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18578 (defun org-create-formula--latex-header ()
18579 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18580 (let ((info (org-combine-plists (org-export--get-global-options
18581 (org-export-get-backend 'latex))
18582 (org-export--get-inbuffer-options
18583 (org-export-get-backend 'latex)))))
18584 (org-latex-guess-babel-language
18585 (org-latex-guess-inputenc
18586 (org-splice-latex-header
18587 org-format-latex-header
18588 org-latex-default-packages-alist
18589 org-latex-packages-alist t
18590 (plist-get info :latex-header)))
18591 info)))
18593 ;; This function borrows from Ganesh Swami's latex2png.el
18594 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18595 "This calls dvipng."
18596 (require 'ox-latex)
18597 (let* ((tmpdir (if (featurep 'xemacs)
18598 (temp-directory)
18599 temporary-file-directory))
18600 (texfilebase (make-temp-name
18601 (expand-file-name "orgtex" tmpdir)))
18602 (texfile (concat texfilebase ".tex"))
18603 (dvifile (concat texfilebase ".dvi"))
18604 (pngfile (concat texfilebase ".png"))
18605 (fnh (if (featurep 'xemacs)
18606 (font-height (face-font 'default))
18607 (face-attribute 'default :height nil)))
18608 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18609 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18610 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18611 "Black"))
18612 (bg (or (plist-get options (if buffer :background :html-background))
18613 "Transparent")))
18614 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18615 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18616 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18617 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18618 (let ((latex-header (org-create-formula--latex-header)))
18619 (with-temp-file texfile
18620 (insert latex-header)
18621 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18622 (let ((dir default-directory))
18623 (condition-case nil
18624 (progn
18625 (cd tmpdir)
18626 (call-process "latex" nil nil nil texfile))
18627 (error nil))
18628 (cd dir))
18629 (if (not (file-exists-p dvifile))
18630 (progn (message "Failed to create dvi file from %s" texfile) nil)
18631 (condition-case nil
18632 (if (featurep 'xemacs)
18633 (call-process "dvipng" nil nil nil
18634 "-fg" fg "-bg" bg
18635 "-T" "tight"
18636 "-o" pngfile
18637 dvifile)
18638 (call-process "dvipng" nil nil nil
18639 "-fg" fg "-bg" bg
18640 "-D" dpi
18641 ;;"-x" scale "-y" scale
18642 "-T" "tight"
18643 "-o" pngfile
18644 dvifile))
18645 (error nil))
18646 (if (not (file-exists-p pngfile))
18647 (if org-format-latex-signal-error
18648 (error "Failed to create png file from %s" texfile)
18649 (message "Failed to create png file from %s" texfile)
18650 nil)
18651 ;; Use the requested file name and clean up
18652 (copy-file pngfile tofile 'replace)
18653 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18654 (if (file-exists-p (concat texfilebase e))
18655 (delete-file (concat texfilebase e))))
18656 pngfile))))
18658 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18659 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18660 "This calls convert, which is included into imagemagick."
18661 (require 'ox-latex)
18662 (let* ((tmpdir (if (featurep 'xemacs)
18663 (temp-directory)
18664 temporary-file-directory))
18665 (texfilebase (make-temp-name
18666 (expand-file-name "orgtex" tmpdir)))
18667 (texfile (concat texfilebase ".tex"))
18668 (pdffile (concat texfilebase ".pdf"))
18669 (pngfile (concat texfilebase ".png"))
18670 (fnh (if (featurep 'xemacs)
18671 (font-height (face-font 'default))
18672 (face-attribute 'default :height nil)))
18673 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18674 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18675 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18676 "black"))
18677 (bg (or (plist-get options (if buffer :background :html-background))
18678 "white")))
18679 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18680 (setq fg (org-latex-color-format fg)))
18681 (if (eq bg 'default) (setq bg (org-latex-color :background))
18682 (setq bg (org-latex-color-format
18683 (if (string= bg "Transparent") "white" bg))))
18684 (let ((latex-header (org-create-formula--latex-header)))
18685 (with-temp-file texfile
18686 (insert latex-header)
18687 (insert "\n\\begin{document}\n"
18688 "\\definecolor{fg}{rgb}{" fg "}\n"
18689 "\\definecolor{bg}{rgb}{" bg "}\n"
18690 "\n\\pagecolor{bg}\n"
18691 "\n{\\color{fg}\n"
18692 string
18693 "\n}\n"
18694 "\n\\end{document}\n")))
18695 (org-latex-compile texfile t)
18696 (if (not (file-exists-p pdffile))
18697 (progn (message "Failed to create pdf file from %s" texfile) nil)
18698 (condition-case nil
18699 (if (featurep 'xemacs)
18700 (call-process "convert" nil nil nil
18701 "-density" "96"
18702 "-trim"
18703 "-antialias"
18704 pdffile
18705 "-quality" "100"
18706 ;; "-sharpen" "0x1.0"
18707 pngfile)
18708 (call-process "convert" nil nil nil
18709 "-density" dpi
18710 "-trim"
18711 "-antialias"
18712 pdffile
18713 "-quality" "100"
18714 ;; "-sharpen" "0x1.0"
18715 pngfile))
18716 (error nil))
18717 (if (not (file-exists-p pngfile))
18718 (if org-format-latex-signal-error
18719 (error "Failed to create png file from %s" texfile)
18720 (message "Failed to create png file from %s" texfile)
18721 nil)
18722 ;; Use the requested file name and clean up
18723 (copy-file pngfile tofile 'replace)
18724 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18725 (if (file-exists-p (concat texfilebase e))
18726 (delete-file (concat texfilebase e))))
18727 pngfile))))
18729 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18730 "Fill a LaTeX header template TPL.
18731 In the template, the following place holders will be recognized:
18733 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
18734 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18735 [PACKAGES] \\usepackage statements for PKG
18736 [NO-PACKAGES] do not include PKG
18737 [EXTRA] the string EXTRA
18738 [NO-EXTRA] do not include EXTRA
18740 For backward compatibility, if both the positive and the negative place
18741 holder is missing, the positive one (without the \"NO-\") will be
18742 assumed to be present at the end of the template.
18743 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18744 EXTRA is a string.
18745 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18746 (let (rpl (end ""))
18747 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
18748 (setq rpl (if (or (match-end 1) (not def-pkg))
18749 "" (org-latex-packages-to-string def-pkg snippets-p t))
18750 tpl (replace-match rpl t t tpl))
18751 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18753 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
18754 (setq rpl (if (or (match-end 1) (not pkg))
18755 "" (org-latex-packages-to-string pkg snippets-p t))
18756 tpl (replace-match rpl t t tpl))
18757 (if pkg (setq end
18758 (concat end "\n"
18759 (org-latex-packages-to-string pkg snippets-p)))))
18761 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
18762 (setq rpl (if (or (match-end 1) (not extra))
18763 "" (concat extra "\n"))
18764 tpl (replace-match rpl t t tpl))
18765 (if (and extra (string-match "\\S-" extra))
18766 (setq end (concat end "\n" extra))))
18768 (if (string-match "\\S-" end)
18769 (concat tpl "\n" end)
18770 tpl)))
18772 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18773 "Turn an alist of packages into a string with the \\usepackage macros."
18774 (setq pkg (mapconcat (lambda(p)
18775 (cond
18776 ((stringp p) p)
18777 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18778 (format "%% Package %s omitted" (cadr p)))
18779 ((equal "" (car p))
18780 (format "\\usepackage{%s}" (cadr p)))
18782 (format "\\usepackage[%s]{%s}"
18783 (car p) (cadr p)))))
18785 "\n"))
18786 (if newline (concat pkg "\n") pkg))
18788 (defun org-dvipng-color (attr)
18789 "Return a RGB color specification for dvipng."
18790 (apply 'format "rgb %s %s %s"
18791 (mapcar 'org-normalize-color
18792 (if (featurep 'xemacs)
18793 (color-rgb-components
18794 (face-property 'default
18795 (cond ((eq attr :foreground) 'foreground)
18796 ((eq attr :background) 'background))))
18797 (color-values (face-attribute 'default attr nil))))))
18799 (defun org-dvipng-color-format (color-name)
18800 "Convert COLOR-NAME to a RGB color value for dvipng."
18801 (apply 'format "rgb %s %s %s"
18802 (mapcar 'org-normalize-color
18803 (color-values color-name))))
18805 (defun org-latex-color (attr)
18806 "Return a RGB color for the LaTeX color package."
18807 (apply 'format "%s,%s,%s"
18808 (mapcar 'org-normalize-color
18809 (if (featurep 'xemacs)
18810 (color-rgb-components
18811 (face-property 'default
18812 (cond ((eq attr :foreground) 'foreground)
18813 ((eq attr :background) 'background))))
18814 (color-values (face-attribute 'default attr nil))))))
18816 (defun org-latex-color-format (color-name)
18817 "Convert COLOR-NAME to a RGB color value."
18818 (apply 'format "%s,%s,%s"
18819 (mapcar 'org-normalize-color
18820 (color-values color-name))))
18822 (defun org-normalize-color (value)
18823 "Return string to be used as color value for an RGB component."
18824 (format "%g" (/ value 65535.0)))
18828 ;; Image display
18830 (defvar org-inline-image-overlays nil)
18831 (make-variable-buffer-local 'org-inline-image-overlays)
18833 (defun org-toggle-inline-images (&optional include-linked)
18834 "Toggle the display of inline images.
18835 INCLUDE-LINKED is passed to `org-display-inline-images'."
18836 (interactive "P")
18837 (if org-inline-image-overlays
18838 (progn
18839 (org-remove-inline-images)
18840 (message "Inline image display turned off"))
18841 (org-display-inline-images include-linked)
18842 (if (and (org-called-interactively-p)
18843 org-inline-image-overlays)
18844 (message "%d images displayed inline"
18845 (length org-inline-image-overlays))
18846 (message "No images to display inline"))))
18848 (defun org-redisplay-inline-images ()
18849 "Refresh the display of inline images."
18850 (interactive)
18851 (if (not org-inline-image-overlays)
18852 (org-toggle-inline-images)
18853 (org-toggle-inline-images)
18854 (org-toggle-inline-images)))
18856 (defun org-display-inline-images (&optional include-linked refresh beg end)
18857 "Display inline images.
18858 Normally only links without a description part are inlined, because this
18859 is how it will work for export. When INCLUDE-LINKED is set, also links
18860 with a description part will be inlined. This can be nice for a quick
18861 look at those images, but it does not reflect what exported files will look
18862 like.
18863 When REFRESH is set, refresh existing images between BEG and END.
18864 This will create new image displays only if necessary.
18865 BEG and END default to the buffer boundaries."
18866 (interactive "P")
18867 (when (display-graphic-p)
18868 (unless refresh
18869 (org-remove-inline-images)
18870 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18871 (save-excursion
18872 (save-restriction
18873 (widen)
18874 (setq beg (or beg (point-min)) end (or end (point-max)))
18875 (goto-char beg)
18876 (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([^]\n]+?"
18877 (substring (org-image-file-name-regexp) 0 -2)
18878 "\\)\\]" (if include-linked "" "\\]")))
18879 (case-fold-search t)
18880 old file ov img type attrwidth width)
18881 (while (re-search-forward re end t)
18882 (setq old (get-char-property-and-overlay (match-beginning 1)
18883 'org-image-overlay)
18884 file (expand-file-name
18885 (concat (or (match-string 3) "") (match-string 4))))
18886 (when (image-type-available-p 'imagemagick)
18887 (setq attrwidth (if (or (listp org-image-actual-width)
18888 (null org-image-actual-width))
18889 (save-excursion
18890 (save-match-data
18891 (when (re-search-backward
18892 "#\\+attr.*:width[ \t]+\\([^ ]+\\)"
18893 (save-excursion
18894 (re-search-backward "^[ \t]*$\\|\\`" nil t)) t)
18895 (string-to-number (match-string 1))))))
18896 width (cond ((eq org-image-actual-width t) nil)
18897 ((null org-image-actual-width) attrwidth)
18898 ((numberp org-image-actual-width)
18899 org-image-actual-width)
18900 ((listp org-image-actual-width)
18901 (or attrwidth (car org-image-actual-width))))
18902 type (if width 'imagemagick)))
18903 (when (file-exists-p file)
18904 (if (and (car-safe old) refresh)
18905 (image-refresh (overlay-get (cdr old) 'display))
18906 (setq img (save-match-data (create-image file type nil :width width)))
18907 (when img
18908 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18909 (overlay-put ov 'display img)
18910 (overlay-put ov 'face 'default)
18911 (overlay-put ov 'org-image-overlay t)
18912 (overlay-put ov 'modification-hooks
18913 (list 'org-display-inline-remove-overlay))
18914 (push ov org-inline-image-overlays))))))))))
18916 (define-obsolete-function-alias
18917 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18919 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18920 "Remove inline-display overlay if a corresponding region is modified."
18921 (let ((inhibit-modification-hooks t))
18922 (when (and ov after)
18923 (delete ov org-inline-image-overlays)
18924 (delete-overlay ov))))
18926 (defun org-remove-inline-images ()
18927 "Remove inline display of images."
18928 (interactive)
18929 (mapc 'delete-overlay org-inline-image-overlays)
18930 (setq org-inline-image-overlays nil))
18932 ;;;; Key bindings
18934 ;; Outline functions from `outline-mode-prefix-map'
18935 ;; that can be remapped in Org:
18936 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18937 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18938 (define-key org-mode-map [remap outline-forward-same-level]
18939 'org-forward-heading-same-level)
18940 (define-key org-mode-map [remap outline-backward-same-level]
18941 'org-backward-heading-same-level)
18942 (define-key org-mode-map [remap show-branches]
18943 'org-kill-note-or-show-branches)
18944 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18945 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18946 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18948 ;; Outline functions from `outline-mode-prefix-map' that can not
18949 ;; be remapped in Org:
18951 ;; - the column "key binding" shows whether the Outline function is still
18952 ;; available in Org mode on the same key that it has been bound to in
18953 ;; Outline mode:
18954 ;; - "overridden": key used for a different functionality in Org mode
18955 ;; - else: key still bound to the same Outline function in Org mode
18957 ;; | Outline function | key binding | Org replacement |
18958 ;; |------------------------------------+-------------+-----------------------|
18959 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18960 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18961 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18962 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18963 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18964 ;; | `show-entry' | overridden | no replacement |
18965 ;; | `show-children' | `C-c C-i' | visibility cycling |
18966 ;; | `show-branches' | `C-c C-k' | still same function |
18967 ;; | `show-subtree' | overridden | visibility cycling |
18968 ;; | `show-all' | overridden | no replacement |
18969 ;; | `hide-subtree' | overridden | visibility cycling |
18970 ;; | `hide-body' | overridden | no replacement |
18971 ;; | `hide-entry' | overridden | visibility cycling |
18972 ;; | `hide-leaves' | overridden | no replacement |
18973 ;; | `hide-sublevels' | overridden | no replacement |
18974 ;; | `hide-other' | overridden | no replacement |
18976 ;; Make `C-c C-x' a prefix key
18977 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18979 ;; TAB key with modifiers
18980 (org-defkey org-mode-map "\C-i" 'org-cycle)
18981 (org-defkey org-mode-map [(tab)] 'org-cycle)
18982 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18983 (org-defkey org-mode-map "\M-\t" 'pcomplete)
18984 ;; The following line is necessary under Suse GNU/Linux
18985 (unless (featurep 'xemacs)
18986 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18987 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18988 (define-key org-mode-map [backtab] 'org-shifttab)
18990 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18991 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18992 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18994 ;; Cursor keys with modifiers
18995 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18996 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18997 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18998 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19000 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19001 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19002 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19003 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19005 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19006 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19007 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19008 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19010 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19011 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19012 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19013 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19015 ;; Babel keys
19016 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19017 (mapc (lambda (pair)
19018 (define-key org-babel-map (car pair) (cdr pair)))
19019 org-babel-key-bindings)
19021 ;;; Extra keys for tty access.
19022 ;; We only set them when really needed because otherwise the
19023 ;; menus don't show the simple keys
19025 (when (or org-use-extra-keys
19026 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19027 (not window-system))
19028 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19029 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19030 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19031 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19032 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19033 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19034 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19035 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19036 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19037 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19038 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19039 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19040 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19041 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19042 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19043 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19044 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19045 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19046 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19047 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19048 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19049 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19050 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19051 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19052 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19053 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19054 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19055 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19057 ;; All the other keys
19059 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19060 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19061 (if (boundp 'narrow-map)
19062 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19063 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19064 (if (boundp 'narrow-map)
19065 (org-defkey narrow-map "b" 'org-narrow-to-block)
19066 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19067 (if (boundp 'narrow-map)
19068 (org-defkey narrow-map "e" 'org-narrow-to-element)
19069 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19070 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19071 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19072 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19073 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19074 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19075 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19076 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19077 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19078 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19079 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19080 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19081 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19082 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19083 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19084 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19085 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19086 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19087 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19088 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19089 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19090 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19091 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19092 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19093 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19094 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19095 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19096 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19097 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19098 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19099 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19100 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19101 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19102 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19103 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19104 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19105 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19106 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19107 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19108 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19109 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19110 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19111 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19112 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19113 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19114 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19115 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19116 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19117 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19118 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19119 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19120 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19121 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19122 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19123 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19124 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19125 (org-defkey org-mode-map "\C-c^" 'org-sort)
19126 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19127 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19128 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19129 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19130 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19131 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19132 (org-defkey org-mode-map "\C-m" 'org-return)
19133 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19134 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19135 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19136 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19137 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19138 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19139 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19140 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19141 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19142 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19143 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19144 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19145 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19146 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19147 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19148 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19149 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19150 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19151 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19152 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19153 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19154 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19155 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19157 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19158 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19159 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19161 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19162 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19163 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19164 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19165 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19166 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19167 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19168 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19169 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19170 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19171 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19172 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19173 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19174 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19175 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19176 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19177 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19178 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19179 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19180 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19181 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19182 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19183 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19185 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19186 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19187 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19188 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19189 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19191 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19193 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19195 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19196 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19198 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19201 (when (featurep 'xemacs)
19202 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19205 (defconst org-speed-commands-default
19207 ("Outline Navigation")
19208 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19209 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19210 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19211 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19212 ("F" . org-next-block)
19213 ("B" . org-previous-block)
19214 ("u" . (org-speed-move-safe 'outline-up-heading))
19215 ("j" . org-goto)
19216 ("g" . (org-refile t))
19217 ("Outline Visibility")
19218 ("c" . org-cycle)
19219 ("C" . org-shifttab)
19220 (" " . org-display-outline-path)
19221 ("s" . org-narrow-to-subtree)
19222 ("=" . org-columns)
19223 ("Outline Structure Editing")
19224 ("U" . org-shiftmetaup)
19225 ("D" . org-shiftmetadown)
19226 ("r" . org-metaright)
19227 ("l" . org-metaleft)
19228 ("R" . org-shiftmetaright)
19229 ("L" . org-shiftmetaleft)
19230 ("i" . (progn (forward-char 1) (call-interactively
19231 'org-insert-heading-respect-content)))
19232 ("^" . org-sort)
19233 ("w" . org-refile)
19234 ("a" . org-archive-subtree-default-with-confirmation)
19235 ("@" . org-mark-subtree)
19236 ("#" . org-toggle-comment)
19237 ("Clock Commands")
19238 ("I" . org-clock-in)
19239 ("O" . org-clock-out)
19240 ("Meta Data Editing")
19241 ("t" . org-todo)
19242 ("," . (org-priority))
19243 ("0" . (org-priority ?\ ))
19244 ("1" . (org-priority ?A))
19245 ("2" . (org-priority ?B))
19246 ("3" . (org-priority ?C))
19247 (":" . org-set-tags-command)
19248 ("e" . org-set-effort)
19249 ("E" . org-inc-effort)
19250 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19251 (org-entry-put (point) "APPT_WARNTIME" m)))
19252 ("Agenda Views etc")
19253 ("v" . org-agenda)
19254 ("/" . org-sparse-tree)
19255 ("Misc")
19256 ("o" . org-open-at-point)
19257 ("?" . org-speed-command-help)
19258 ("<" . (org-agenda-set-restriction-lock 'subtree))
19259 (">" . (org-agenda-remove-restriction-lock))
19261 "The default speed commands.")
19263 (defun org-print-speed-command (e)
19264 (if (> (length (car e)) 1)
19265 (progn
19266 (princ "\n")
19267 (princ (car e))
19268 (princ "\n")
19269 (princ (make-string (length (car e)) ?-))
19270 (princ "\n"))
19271 (princ (car e))
19272 (princ " ")
19273 (if (symbolp (cdr e))
19274 (princ (symbol-name (cdr e)))
19275 (prin1 (cdr e)))
19276 (princ "\n")))
19278 (defun org-speed-command-help ()
19279 "Show the available speed commands."
19280 (interactive)
19281 (if (not org-use-speed-commands)
19282 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19283 (with-output-to-temp-buffer "*Help*"
19284 (princ "User-defined Speed commands\n===========================\n")
19285 (mapc 'org-print-speed-command org-speed-commands-user)
19286 (princ "\n")
19287 (princ "Built-in Speed commands\n=======================\n")
19288 (mapc 'org-print-speed-command org-speed-commands-default))
19289 (with-current-buffer "*Help*"
19290 (setq truncate-lines t))))
19292 (defun org-speed-move-safe (cmd)
19293 "Execute CMD, but make sure that the cursor always ends up in a headline.
19294 If not, return to the original position and throw an error."
19295 (interactive)
19296 (let ((pos (point)))
19297 (call-interactively cmd)
19298 (unless (and (bolp) (org-at-heading-p))
19299 (goto-char pos)
19300 (error "Boundary reached while executing %s" cmd))))
19302 (defvar org-self-insert-command-undo-counter 0)
19304 (defvar org-table-auto-blank-field) ; defined in org-table.el
19305 (defvar org-speed-command nil)
19307 (define-obsolete-function-alias
19308 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19310 (defun org-speed-command-activate (keys)
19311 "Hook for activating single-letter speed commands.
19312 `org-speed-commands-default' specifies a minimal command set.
19313 Use `org-speed-commands-user' for further customization."
19314 (when (or (and (bolp) (looking-at org-outline-regexp))
19315 (and (functionp org-use-speed-commands)
19316 (funcall org-use-speed-commands)))
19317 (cdr (assoc keys (append org-speed-commands-user
19318 org-speed-commands-default)))))
19320 (define-obsolete-function-alias
19321 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19323 (defun org-babel-speed-command-activate (keys)
19324 "Hook for activating single-letter code block commands."
19325 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19326 (cdr (assoc keys org-babel-key-bindings))))
19328 (defcustom org-speed-command-hook
19329 '(org-speed-command-default-hook org-babel-speed-command-hook)
19330 "Hook for activating speed commands at strategic locations.
19331 Hook functions are called in sequence until a valid handler is
19332 found.
19334 Each hook takes a single argument, a user-pressed command key
19335 which is also a `self-insert-command' from the global map.
19337 Within the hook, examine the cursor position and the command key
19338 and return nil or a valid handler as appropriate. Handler could
19339 be one of an interactive command, a function, or a form.
19341 Set `org-use-speed-commands' to non-nil value to enable this
19342 hook. The default setting is `org-speed-command-activate'."
19343 :group 'org-structure
19344 :version "24.1"
19345 :type 'hook)
19347 (defun org-self-insert-command (N)
19348 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19349 If the cursor is in a table looking at whitespace, the whitespace is
19350 overwritten, and the table is not marked as requiring realignment."
19351 (interactive "p")
19352 (org-check-before-invisible-edit 'insert)
19353 (cond
19354 ((and org-use-speed-commands
19355 (setq org-speed-command
19356 (run-hook-with-args-until-success
19357 'org-speed-command-hook (this-command-keys))))
19358 (cond
19359 ((commandp org-speed-command)
19360 (setq this-command org-speed-command)
19361 (call-interactively org-speed-command))
19362 ((functionp org-speed-command)
19363 (funcall org-speed-command))
19364 ((and org-speed-command (listp org-speed-command))
19365 (eval org-speed-command))
19366 (t (let (org-use-speed-commands)
19367 (call-interactively 'org-self-insert-command)))))
19368 ((and
19369 (org-table-p)
19370 (progn
19371 ;; check if we blank the field, and if that triggers align
19372 (and (featurep 'org-table) org-table-auto-blank-field
19373 (member last-command
19374 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19375 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19376 ;; got extra space, this field does not determine column width
19377 (let (org-table-may-need-update) (org-table-blank-field))
19378 ;; no extra space, this field may determine column width
19379 (org-table-blank-field)))
19381 (eq N 1)
19382 (looking-at "[^|\n]* |"))
19383 (let (org-table-may-need-update)
19384 (goto-char (1- (match-end 0)))
19385 (backward-delete-char 1)
19386 (goto-char (match-beginning 0))
19387 (self-insert-command N)))
19389 (setq org-table-may-need-update t)
19390 (self-insert-command N)
19391 (org-fix-tags-on-the-fly)
19392 (if org-self-insert-cluster-for-undo
19393 (if (not (eq last-command 'org-self-insert-command))
19394 (setq org-self-insert-command-undo-counter 1)
19395 (if (>= org-self-insert-command-undo-counter 20)
19396 (setq org-self-insert-command-undo-counter 1)
19397 (and (> org-self-insert-command-undo-counter 0)
19398 buffer-undo-list (listp buffer-undo-list)
19399 (not (cadr buffer-undo-list)) ; remove nil entry
19400 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19401 (setq org-self-insert-command-undo-counter
19402 (1+ org-self-insert-command-undo-counter))))))))
19404 (defun org-check-before-invisible-edit (kind)
19405 "Check is editing if kind KIND would be dangerous with invisible text around.
19406 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19407 ;; First, try to get out of here as quickly as possible, to reduce overhead
19408 (if (and org-catch-invisible-edits
19409 (or (not (boundp 'visible-mode)) (not visible-mode))
19410 (or (get-char-property (point) 'invisible)
19411 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19412 ;; OK, we need to take a closer look
19413 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19414 (invisible-before-point (if (bobp) nil (get-char-property
19415 (1- (point)) 'invisible)))
19416 (border-and-ok-direction
19418 ;; Check if we are acting predictably before invisible text
19419 (and invisible-at-point (not invisible-before-point)
19420 (memq kind '(insert delete-backward)))
19421 ;; Check if we are acting predictably after invisible text
19422 ;; This works not well, and I have turned it off. It seems
19423 ;; better to always show and stop after invisible text.
19424 ;; (and (not invisible-at-point) invisible-before-point
19425 ;; (memq kind '(insert delete)))
19427 (when (or (memq invisible-at-point '(outline org-hide-block t))
19428 (memq invisible-before-point '(outline org-hide-block t)))
19429 (if (eq org-catch-invisible-edits 'error)
19430 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19431 (if (and org-custom-properties-overlays
19432 (y-or-n-p "Display invisible properties in this buffer? "))
19433 (org-toggle-custom-properties-visibility)
19434 ;; Make the area visible
19435 (save-excursion
19436 (if invisible-before-point
19437 (goto-char (previous-single-char-property-change
19438 (point) 'invisible)))
19439 (org-cycle))
19440 (cond
19441 ((eq org-catch-invisible-edits 'show)
19442 ;; That's it, we do the edit after showing
19443 (message
19444 "Unfolding invisible region around point before editing")
19445 (sit-for 1))
19446 ((and (eq org-catch-invisible-edits 'smart)
19447 border-and-ok-direction)
19448 (message "Unfolding invisible region around point before editing"))
19450 ;; Don't do the edit, make the user repeat it in full visibility
19451 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19453 (defun org-fix-tags-on-the-fly ()
19454 (when (and (equal (char-after (point-at-bol)) ?*)
19455 (org-at-heading-p))
19456 (org-align-tags-here org-tags-column)))
19458 (defun org-delete-backward-char (N)
19459 "Like `delete-backward-char', insert whitespace at field end in tables.
19460 When deleting backwards, in tables this function will insert whitespace in
19461 front of the next \"|\" separator, to keep the table aligned. The table will
19462 still be marked for re-alignment if the field did fill the entire column,
19463 because, in this case the deletion might narrow the column."
19464 (interactive "p")
19465 (save-match-data
19466 (org-check-before-invisible-edit 'delete-backward)
19467 (if (and (org-table-p)
19468 (eq N 1)
19469 (string-match "|" (buffer-substring (point-at-bol) (point)))
19470 (looking-at ".*?|"))
19471 (let ((pos (point))
19472 (noalign (looking-at "[^|\n\r]* |"))
19473 (c org-table-may-need-update))
19474 (backward-delete-char N)
19475 (if (not overwrite-mode)
19476 (progn
19477 (skip-chars-forward "^|")
19478 (insert " ")
19479 (goto-char (1- pos))))
19480 ;; noalign: if there were two spaces at the end, this field
19481 ;; does not determine the width of the column.
19482 (if noalign (setq org-table-may-need-update c)))
19483 (backward-delete-char N)
19484 (org-fix-tags-on-the-fly))))
19486 (defun org-delete-char (N)
19487 "Like `delete-char', but insert whitespace at field end in tables.
19488 When deleting characters, in tables this function will insert whitespace in
19489 front of the next \"|\" separator, to keep the table aligned. The table will
19490 still be marked for re-alignment if the field did fill the entire column,
19491 because, in this case the deletion might narrow the column."
19492 (interactive "p")
19493 (save-match-data
19494 (org-check-before-invisible-edit 'delete)
19495 (if (and (org-table-p)
19496 (not (bolp))
19497 (not (= (char-after) ?|))
19498 (eq N 1))
19499 (if (looking-at ".*?|")
19500 (let ((pos (point))
19501 (noalign (looking-at "[^|\n\r]* |"))
19502 (c org-table-may-need-update))
19503 (replace-match
19504 (concat (substring (match-string 0) 1 -1) " |") nil t)
19505 (goto-char pos)
19506 ;; noalign: if there were two spaces at the end, this field
19507 ;; does not determine the width of the column.
19508 (if noalign (setq org-table-may-need-update c)))
19509 (delete-char N))
19510 (delete-char N)
19511 (org-fix-tags-on-the-fly))))
19513 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19514 (put 'org-self-insert-command 'delete-selection
19515 (lambda ()
19516 (not (run-hook-with-args-until-success
19517 'self-insert-uses-region-functions))))
19518 (put 'orgtbl-self-insert-command 'delete-selection
19519 (lambda ()
19520 (not (run-hook-with-args-until-success
19521 'self-insert-uses-region-functions))))
19522 (put 'org-delete-char 'delete-selection 'supersede)
19523 (put 'org-delete-backward-char 'delete-selection 'supersede)
19524 (put 'org-yank 'delete-selection 'yank)
19526 ;; Make `flyspell-mode' delay after some commands
19527 (put 'org-self-insert-command 'flyspell-delayed t)
19528 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19529 (put 'org-delete-char 'flyspell-delayed t)
19530 (put 'org-delete-backward-char 'flyspell-delayed t)
19532 ;; Make pabbrev-mode expand after org-mode commands
19533 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19534 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19536 (defun org-remap (map &rest commands)
19537 "In MAP, remap the functions given in COMMANDS.
19538 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19539 (let (new old)
19540 (while commands
19541 (setq old (pop commands) new (pop commands))
19542 (if (fboundp 'command-remapping)
19543 (org-defkey map (vector 'remap old) new)
19544 (substitute-key-definition old new map global-map)))))
19546 (defun org-transpose-words ()
19547 "Transpose words for Org.
19548 This uses the `org-mode-transpose-word-syntax-table' syntax
19549 table, which interprets characters in `org-emphasis-alist' as
19550 word constituents."
19551 (interactive)
19552 (with-syntax-table org-mode-transpose-word-syntax-table
19553 (call-interactively 'transpose-words)))
19554 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19556 (when (eq org-enable-table-editor 'optimized)
19557 ;; If the user wants maximum table support, we need to hijack
19558 ;; some standard editing functions
19559 (org-remap org-mode-map
19560 'self-insert-command 'org-self-insert-command
19561 'delete-char 'org-delete-char
19562 'delete-backward-char 'org-delete-backward-char)
19563 (org-defkey org-mode-map "|" 'org-force-self-insert))
19565 (defvar org-ctrl-c-ctrl-c-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 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19571 run after the last 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-ctrl-c-ctrl-c-final-hook nil
19579 "Hook for functions attaching themselves to `C-c C-c'.
19581 This can be used to add additional functionality to the C-c C-c
19582 key which executes context-dependent commands. This hook is run
19583 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19584 before the first test.
19586 Each function will be called with no arguments. The function
19587 must check if the context is appropriate for it to act. If yes,
19588 it should do its thing and then return a non-nil value. If the
19589 context is wrong, just do nothing and return nil.")
19591 (defvar org-tab-first-hook nil
19592 "Hook for functions to attach themselves to TAB.
19593 See `org-ctrl-c-ctrl-c-hook' for more information.
19594 This hook runs as the first action when TAB is pressed, even before
19595 `org-cycle' messes around with the `outline-regexp' to cater for
19596 inline tasks and plain list item folding.
19597 If any function in this hook returns t, any other actions that
19598 would have been caused by TAB (such as table field motion or visibility
19599 cycling) will not occur.")
19601 (defvar org-tab-after-check-for-table-hook nil
19602 "Hook for functions to attach themselves to TAB.
19603 See `org-ctrl-c-ctrl-c-hook' for more information.
19604 This hook runs after it has been established that the cursor is not in a
19605 table, but before checking if the cursor is in a headline or if global cycling
19606 should be done.
19607 If any function in this hook returns t, not other actions like visibility
19608 cycling will be done.")
19610 (defvar org-tab-after-check-for-cycling-hook nil
19611 "Hook for functions to attach themselves to TAB.
19612 See `org-ctrl-c-ctrl-c-hook' for more information.
19613 This hook runs after it has been established that not table field motion and
19614 not visibility should be done because of current context. This is probably
19615 the place where a package like yasnippets can hook in.")
19617 (defvar org-tab-before-tab-emulation-hook nil
19618 "Hook for functions to attach themselves to TAB.
19619 See `org-ctrl-c-ctrl-c-hook' for more information.
19620 This hook runs after every other options for TAB have been exhausted, but
19621 before indentation and \t insertion takes place.")
19623 (defvar org-metaleft-hook nil
19624 "Hook for functions attaching themselves to `M-left'.
19625 See `org-ctrl-c-ctrl-c-hook' for more information.")
19626 (defvar org-metaright-hook nil
19627 "Hook for functions attaching themselves to `M-right'.
19628 See `org-ctrl-c-ctrl-c-hook' for more information.")
19629 (defvar org-metaup-hook nil
19630 "Hook for functions attaching themselves to `M-up'.
19631 See `org-ctrl-c-ctrl-c-hook' for more information.")
19632 (defvar org-metadown-hook nil
19633 "Hook for functions attaching themselves to `M-down'.
19634 See `org-ctrl-c-ctrl-c-hook' for more information.")
19635 (defvar org-shiftmetaleft-hook nil
19636 "Hook for functions attaching themselves to `M-S-left'.
19637 See `org-ctrl-c-ctrl-c-hook' for more information.")
19638 (defvar org-shiftmetaright-hook nil
19639 "Hook for functions attaching themselves to `M-S-right'.
19640 See `org-ctrl-c-ctrl-c-hook' for more information.")
19641 (defvar org-shiftmetaup-hook nil
19642 "Hook for functions attaching themselves to `M-S-up'.
19643 See `org-ctrl-c-ctrl-c-hook' for more information.")
19644 (defvar org-shiftmetadown-hook nil
19645 "Hook for functions attaching themselves to `M-S-down'.
19646 See `org-ctrl-c-ctrl-c-hook' for more information.")
19647 (defvar org-metareturn-hook nil
19648 "Hook for functions attaching themselves to `M-RET'.
19649 See `org-ctrl-c-ctrl-c-hook' for more information.")
19650 (defvar org-shiftup-hook nil
19651 "Hook for functions attaching themselves to `S-up'.
19652 See `org-ctrl-c-ctrl-c-hook' for more information.")
19653 (defvar org-shiftup-final-hook nil
19654 "Hook for functions attaching themselves to `S-up'.
19655 This one runs after all other options except shift-select have been excluded.
19656 See `org-ctrl-c-ctrl-c-hook' for more information.")
19657 (defvar org-shiftdown-hook nil
19658 "Hook for functions attaching themselves to `S-down'.
19659 See `org-ctrl-c-ctrl-c-hook' for more information.")
19660 (defvar org-shiftdown-final-hook nil
19661 "Hook for functions attaching themselves to `S-down'.
19662 This one runs after all other options except shift-select have been excluded.
19663 See `org-ctrl-c-ctrl-c-hook' for more information.")
19664 (defvar org-shiftleft-hook nil
19665 "Hook for functions attaching themselves to `S-left'.
19666 See `org-ctrl-c-ctrl-c-hook' for more information.")
19667 (defvar org-shiftleft-final-hook nil
19668 "Hook for functions attaching themselves to `S-left'.
19669 This one runs after all other options except shift-select have been excluded.
19670 See `org-ctrl-c-ctrl-c-hook' for more information.")
19671 (defvar org-shiftright-hook nil
19672 "Hook for functions attaching themselves to `S-right'.
19673 See `org-ctrl-c-ctrl-c-hook' for more information.")
19674 (defvar org-shiftright-final-hook nil
19675 "Hook for functions attaching themselves to `S-right'.
19676 This one runs after all other options except shift-select have been excluded.
19677 See `org-ctrl-c-ctrl-c-hook' for more information.")
19679 (defun org-modifier-cursor-error ()
19680 "Throw an error, a modified cursor command was applied in wrong context."
19681 (user-error "This command is active in special context like tables, headlines or items"))
19683 (defun org-shiftselect-error ()
19684 "Throw an error because Shift-Cursor command was applied in wrong context."
19685 (if (and (boundp 'shift-select-mode) shift-select-mode)
19686 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19687 (user-error "This command works only in special context like headlines or timestamps")))
19689 (defun org-call-for-shift-select (cmd)
19690 (let ((this-command-keys-shift-translated t))
19691 (call-interactively cmd)))
19693 (defun org-shifttab (&optional arg)
19694 "Global visibility cycling or move to previous table field.
19695 Call `org-table-previous-field' within a table.
19696 When ARG is nil, cycle globally through visibility states.
19697 When ARG is a numeric prefix, show contents of this level."
19698 (interactive "P")
19699 (cond
19700 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19701 ((integerp arg)
19702 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19703 (message "Content view to level: %d" arg)
19704 (org-content (prefix-numeric-value arg2))
19705 (org-cycle-show-empty-lines t)
19706 (setq org-cycle-global-status 'overview)))
19707 (t (call-interactively 'org-global-cycle))))
19709 (defun org-shiftmetaleft ()
19710 "Promote subtree or delete table column.
19711 Calls `org-promote-subtree', `org-outdent-item-tree', or
19712 `org-table-delete-column', depending on context. See the
19713 individual commands for more information."
19714 (interactive)
19715 (cond
19716 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19717 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19718 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19719 ((if (not (org-region-active-p)) (org-at-item-p)
19720 (save-excursion (goto-char (region-beginning))
19721 (org-at-item-p)))
19722 (call-interactively 'org-outdent-item-tree))
19723 (t (org-modifier-cursor-error))))
19725 (defun org-shiftmetaright ()
19726 "Demote subtree or insert table column.
19727 Calls `org-demote-subtree', `org-indent-item-tree', or
19728 `org-table-insert-column', depending on context. See the
19729 individual commands for more information."
19730 (interactive)
19731 (cond
19732 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19733 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19734 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19735 ((if (not (org-region-active-p)) (org-at-item-p)
19736 (save-excursion (goto-char (region-beginning))
19737 (org-at-item-p)))
19738 (call-interactively 'org-indent-item-tree))
19739 (t (org-modifier-cursor-error))))
19741 (defun org-shiftmetaup (&optional arg)
19742 "Move subtree up or kill table row.
19743 Calls `org-move-subtree-up' or `org-table-kill-row' or
19744 `org-move-item-up' or `org-timestamp-up', depending on context.
19745 See the individual commands for more information."
19746 (interactive "P")
19747 (cond
19748 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19749 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19750 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19751 ((org-at-item-p) (call-interactively 'org-move-item-up))
19752 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19753 (call-interactively 'org-timestamp-up)))
19754 (t (call-interactively 'org-drag-line-backward))))
19756 (defun org-shiftmetadown (&optional arg)
19757 "Move subtree down or insert table row.
19758 Calls `org-move-subtree-down' or `org-table-insert-row' or
19759 `org-move-item-down' or `org-timestamp-up', depending on context.
19760 See the individual commands for more information."
19761 (interactive "P")
19762 (cond
19763 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19764 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19765 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19766 ((org-at-item-p) (call-interactively 'org-move-item-down))
19767 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19768 (call-interactively 'org-timestamp-down)))
19769 (t (call-interactively 'org-drag-line-forward))))
19771 (defsubst org-hidden-tree-error ()
19772 (user-error
19773 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19775 (defun org-metaleft (&optional arg)
19776 "Promote heading or move table column to left.
19777 Calls `org-do-promote' or `org-table-move-column', depending on context.
19778 With no specific context, calls the Emacs default `backward-word'.
19779 See the individual commands for more information."
19780 (interactive "P")
19781 (cond
19782 ((run-hook-with-args-until-success 'org-metaleft-hook))
19783 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19784 ((org-with-limited-levels
19785 (or (org-at-heading-p)
19786 (and (org-region-active-p)
19787 (save-excursion
19788 (goto-char (region-beginning))
19789 (org-at-heading-p)))))
19790 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19791 (call-interactively 'org-do-promote))
19792 ;; At an inline task.
19793 ((org-at-heading-p)
19794 (call-interactively 'org-inlinetask-promote))
19795 ((or (org-at-item-p)
19796 (and (org-region-active-p)
19797 (save-excursion
19798 (goto-char (region-beginning))
19799 (org-at-item-p))))
19800 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19801 (call-interactively 'org-outdent-item))
19802 (t (call-interactively 'backward-word))))
19804 (defun org-metaright (&optional arg)
19805 "Demote a subtree, a list item or move table column to right.
19806 In front of a drawer or a block keyword, indent it correctly.
19807 With no specific context, calls the Emacs default `forward-word'.
19808 See the individual commands for more information."
19809 (interactive "P")
19810 (cond
19811 ((run-hook-with-args-until-success 'org-metaright-hook))
19812 ((org-at-table-p) (call-interactively 'org-table-move-column))
19813 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19814 ((org-at-block-p) (call-interactively 'org-indent-block))
19815 ((org-with-limited-levels
19816 (or (org-at-heading-p)
19817 (and (org-region-active-p)
19818 (save-excursion
19819 (goto-char (region-beginning))
19820 (org-at-heading-p)))))
19821 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19822 (call-interactively 'org-do-demote))
19823 ;; At an inline task.
19824 ((org-at-heading-p)
19825 (call-interactively 'org-inlinetask-demote))
19826 ((or (org-at-item-p)
19827 (and (org-region-active-p)
19828 (save-excursion
19829 (goto-char (region-beginning))
19830 (org-at-item-p))))
19831 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19832 (call-interactively 'org-indent-item))
19833 (t (call-interactively 'forward-word))))
19835 (defun org-check-for-hidden (what)
19836 "Check if there are hidden headlines/items in the current visual line.
19837 WHAT can be either `headlines' or `items'. If the current line is
19838 an outline or item heading and it has a folded subtree below it,
19839 this function returns t, nil otherwise."
19840 (let ((re (cond
19841 ((eq what 'headlines) org-outline-regexp-bol)
19842 ((eq what 'items) (org-item-beginning-re))
19843 (t (error "This should not happen"))))
19844 beg end)
19845 (save-excursion
19846 (catch 'exit
19847 (unless (org-region-active-p)
19848 (setq beg (point-at-bol))
19849 (beginning-of-line 2)
19850 (while (and (not (eobp)) ;; this is like `next-line'
19851 (get-char-property (1- (point)) 'invisible))
19852 (beginning-of-line 2))
19853 (setq end (point))
19854 (goto-char beg)
19855 (goto-char (point-at-eol))
19856 (setq end (max end (point)))
19857 (while (re-search-forward re end t)
19858 (if (get-char-property (match-beginning 0) 'invisible)
19859 (throw 'exit t))))
19860 nil))))
19862 (defun org-metaup (&optional arg)
19863 "Move subtree up or move table row up.
19864 Calls `org-move-subtree-up' or `org-table-move-row' or
19865 `org-move-item-up', depending on context. See the individual commands
19866 for more information."
19867 (interactive "P")
19868 (cond
19869 ((run-hook-with-args-until-success 'org-metaup-hook))
19870 ((org-region-active-p)
19871 (let* ((a (min (region-beginning) (region-end)))
19872 (b (1- (max (region-beginning) (region-end))))
19873 (c (save-excursion (goto-char a)
19874 (move-beginning-of-line 0)))
19875 (d (save-excursion (goto-char a)
19876 (move-end-of-line 0) (point))))
19877 (transpose-regions a b c d)
19878 (goto-char c)))
19879 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19880 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19881 ((org-at-item-p) (call-interactively 'org-move-item-up))
19882 (t (org-drag-element-backward))))
19884 (defun org-metadown (&optional arg)
19885 "Move subtree down or move table row down.
19886 Calls `org-move-subtree-down' or `org-table-move-row' or
19887 `org-move-item-down', depending on context. See the individual
19888 commands for more information."
19889 (interactive "P")
19890 (cond
19891 ((run-hook-with-args-until-success 'org-metadown-hook))
19892 ((org-region-active-p)
19893 (let* ((a (min (region-beginning) (region-end)))
19894 (b (max (region-beginning) (region-end)))
19895 (c (save-excursion (goto-char b)
19896 (move-beginning-of-line 1)))
19897 (d (save-excursion (goto-char b)
19898 (move-end-of-line 1) (1+ (point)))))
19899 (transpose-regions a b c d)
19900 (goto-char d)))
19901 ((org-at-table-p) (call-interactively 'org-table-move-row))
19902 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19903 ((org-at-item-p) (call-interactively 'org-move-item-down))
19904 (t (org-drag-element-forward))))
19906 (defun org-shiftup (&optional arg)
19907 "Increase item in timestamp or increase priority of current headline.
19908 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19909 depending on context. See the individual commands for more information."
19910 (interactive "P")
19911 (cond
19912 ((run-hook-with-args-until-success 'org-shiftup-hook))
19913 ((and org-support-shift-select (org-region-active-p))
19914 (org-call-for-shift-select 'previous-line))
19915 ((org-at-timestamp-p t)
19916 (call-interactively (if org-edit-timestamp-down-means-later
19917 'org-timestamp-down 'org-timestamp-up)))
19918 ((and (not (eq org-support-shift-select 'always))
19919 org-enable-priority-commands
19920 (org-at-heading-p))
19921 (call-interactively 'org-priority-up))
19922 ((and (not org-support-shift-select) (org-at-item-p))
19923 (call-interactively 'org-previous-item))
19924 ((org-clocktable-try-shift 'up arg))
19925 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19926 (org-support-shift-select
19927 (org-call-for-shift-select 'previous-line))
19928 (t (org-shiftselect-error))))
19930 (defun org-shiftdown (&optional arg)
19931 "Decrease item in timestamp or decrease priority of current headline.
19932 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19933 depending on context. See the individual commands for more information."
19934 (interactive "P")
19935 (cond
19936 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19937 ((and org-support-shift-select (org-region-active-p))
19938 (org-call-for-shift-select 'next-line))
19939 ((org-at-timestamp-p t)
19940 (call-interactively (if org-edit-timestamp-down-means-later
19941 'org-timestamp-up 'org-timestamp-down)))
19942 ((and (not (eq org-support-shift-select 'always))
19943 org-enable-priority-commands
19944 (org-at-heading-p))
19945 (call-interactively 'org-priority-down))
19946 ((and (not org-support-shift-select) (org-at-item-p))
19947 (call-interactively 'org-next-item))
19948 ((org-clocktable-try-shift 'down arg))
19949 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19950 (org-support-shift-select
19951 (org-call-for-shift-select 'next-line))
19952 (t (org-shiftselect-error))))
19954 (defun org-shiftright (&optional arg)
19955 "Cycle the thing at point or in the current line, depending on context.
19956 Depending on context, this does one of the following:
19958 - switch a timestamp at point one day into the future
19959 - on a headline, switch to the next TODO keyword.
19960 - on an item, switch entire list to the next bullet type
19961 - on a property line, switch to the next allowed value
19962 - on a clocktable definition line, move time block into the future"
19963 (interactive "P")
19964 (cond
19965 ((run-hook-with-args-until-success 'org-shiftright-hook))
19966 ((and org-support-shift-select (org-region-active-p))
19967 (org-call-for-shift-select 'forward-char))
19968 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19969 ((and (not (eq org-support-shift-select 'always))
19970 (org-at-heading-p))
19971 (let ((org-inhibit-logging
19972 (not org-treat-S-cursor-todo-selection-as-state-change))
19973 (org-inhibit-blocking
19974 (not org-treat-S-cursor-todo-selection-as-state-change)))
19975 (org-call-with-arg 'org-todo 'right)))
19976 ((or (and org-support-shift-select
19977 (not (eq org-support-shift-select 'always))
19978 (org-at-item-bullet-p))
19979 (and (not org-support-shift-select) (org-at-item-p)))
19980 (org-call-with-arg 'org-cycle-list-bullet nil))
19981 ((and (not (eq org-support-shift-select 'always))
19982 (org-at-property-p))
19983 (call-interactively 'org-property-next-allowed-value))
19984 ((org-clocktable-try-shift 'right arg))
19985 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19986 (org-support-shift-select
19987 (org-call-for-shift-select 'forward-char))
19988 (t (org-shiftselect-error))))
19990 (defun org-shiftleft (&optional arg)
19991 "Cycle the thing at point or in the current line, depending on context.
19992 Depending on context, this does one of the following:
19994 - switch a timestamp at point one day into the past
19995 - on a headline, switch to the previous TODO keyword.
19996 - on an item, switch entire list to the previous bullet type
19997 - on a property line, switch to the previous allowed value
19998 - on a clocktable definition line, move time block into the past"
19999 (interactive "P")
20000 (cond
20001 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20002 ((and org-support-shift-select (org-region-active-p))
20003 (org-call-for-shift-select 'backward-char))
20004 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20005 ((and (not (eq org-support-shift-select 'always))
20006 (org-at-heading-p))
20007 (let ((org-inhibit-logging
20008 (not org-treat-S-cursor-todo-selection-as-state-change))
20009 (org-inhibit-blocking
20010 (not org-treat-S-cursor-todo-selection-as-state-change)))
20011 (org-call-with-arg 'org-todo 'left)))
20012 ((or (and org-support-shift-select
20013 (not (eq org-support-shift-select 'always))
20014 (org-at-item-bullet-p))
20015 (and (not org-support-shift-select) (org-at-item-p)))
20016 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20017 ((and (not (eq org-support-shift-select 'always))
20018 (org-at-property-p))
20019 (call-interactively 'org-property-previous-allowed-value))
20020 ((org-clocktable-try-shift 'left arg))
20021 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20022 (org-support-shift-select
20023 (org-call-for-shift-select 'backward-char))
20024 (t (org-shiftselect-error))))
20026 (defun org-shiftcontrolright ()
20027 "Switch to next TODO set."
20028 (interactive)
20029 (cond
20030 ((and org-support-shift-select (org-region-active-p))
20031 (org-call-for-shift-select 'forward-word))
20032 ((and (not (eq org-support-shift-select 'always))
20033 (org-at-heading-p))
20034 (org-call-with-arg 'org-todo 'nextset))
20035 (org-support-shift-select
20036 (org-call-for-shift-select 'forward-word))
20037 (t (org-shiftselect-error))))
20039 (defun org-shiftcontrolleft ()
20040 "Switch to previous TODO set."
20041 (interactive)
20042 (cond
20043 ((and org-support-shift-select (org-region-active-p))
20044 (org-call-for-shift-select 'backward-word))
20045 ((and (not (eq org-support-shift-select 'always))
20046 (org-at-heading-p))
20047 (org-call-with-arg 'org-todo 'previousset))
20048 (org-support-shift-select
20049 (org-call-for-shift-select 'backward-word))
20050 (t (org-shiftselect-error))))
20052 (defun org-shiftcontrolup (&optional n)
20053 "Change timestamps synchronously up in CLOCK log lines.
20054 Optional argument N tells to change by that many units."
20055 (interactive "P")
20056 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20057 (let (org-support-shift-select)
20058 (org-clock-timestamps-up n))
20059 (user-error "Not at a clock log")))
20061 (defun org-shiftcontroldown (&optional n)
20062 "Change timestamps synchronously down in CLOCK log lines.
20063 Optional argument N tells to change by that many units."
20064 (interactive "P")
20065 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20066 (let (org-support-shift-select)
20067 (org-clock-timestamps-down n))
20068 (user-error "Not at a clock log")))
20070 (defun org-ctrl-c-ret ()
20071 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20072 (interactive)
20073 (cond
20074 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20075 (t (call-interactively 'org-insert-heading))))
20077 (defun org-find-visible ()
20078 (let ((s (point)))
20079 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20080 (get-char-property s 'invisible)))
20082 (defun org-find-invisible ()
20083 (let ((s (point)))
20084 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20085 (not (get-char-property s 'invisible))))
20088 (defun org-copy-visible (beg end)
20089 "Copy the visible parts of the region."
20090 (interactive "r")
20091 (let (snippets s)
20092 (save-excursion
20093 (save-restriction
20094 (narrow-to-region beg end)
20095 (setq s (goto-char (point-min)))
20096 (while (not (= (point) (point-max)))
20097 (goto-char (org-find-invisible))
20098 (push (buffer-substring s (point)) snippets)
20099 (setq s (goto-char (org-find-visible))))))
20100 (kill-new (apply 'concat (nreverse snippets)))))
20102 (defun org-copy-special ()
20103 "Copy region in table or copy current subtree.
20104 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20105 See the individual commands for more information."
20106 (interactive)
20107 (call-interactively
20108 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20110 (defun org-cut-special ()
20111 "Cut region in table or cut current subtree.
20112 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20113 See the individual commands for more information."
20114 (interactive)
20115 (call-interactively
20116 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20118 (defun org-paste-special (arg)
20119 "Paste rectangular region into table, or past subtree relative to level.
20120 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20121 See the individual commands for more information."
20122 (interactive "P")
20123 (if (org-at-table-p)
20124 (org-table-paste-rectangle)
20125 (org-paste-subtree arg)))
20127 (defsubst org-in-fixed-width-region-p ()
20128 "Is point in a fixed-width region?"
20129 (save-match-data
20130 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20132 (defun org-edit-special (&optional arg)
20133 "Call a special editor for the element at point.
20134 When at a table, call the formula editor with `org-table-edit-formulas'.
20135 When in a source code block, call `org-edit-src-code'.
20136 When in a fixed-width region, call `org-edit-fixed-width-region'.
20137 When at an #+INCLUDE keyword, visit the included file.
20138 On a link, call `ffap' to visit the link at point.
20139 Otherwise, return a user error."
20140 (interactive "P")
20141 (let ((element (org-element-at-point)))
20142 (assert (not buffer-read-only) nil
20143 "Buffer is read-only: %s" (buffer-name))
20144 (case (org-element-type element)
20145 (src-block
20146 (if (not arg) (org-edit-src-code)
20147 (let* ((info (org-babel-get-src-block-info))
20148 (lang (nth 0 info))
20149 (params (nth 2 info))
20150 (session (cdr (assq :session params))))
20151 (if (not session) (org-edit-src-code)
20152 ;; At a src-block with a session and function called with
20153 ;; an ARG: switch to the buffer related to the inferior
20154 ;; process.
20155 (switch-to-buffer
20156 (funcall (intern (concat "org-babel-prep-session:" lang))
20157 session params))))))
20158 (keyword
20159 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20160 (find-file
20161 (org-remove-double-quotes
20162 (car (org-split-string (org-element-property :value element)))))
20163 (user-error "No special environment to edit here")))
20164 (table
20165 (if (eq (org-element-property :type element) 'table.el)
20166 (org-edit-src-code)
20167 (call-interactively 'org-table-edit-formulas)))
20168 ;; Only Org tables contain `table-row' type elements.
20169 (table-row (call-interactively 'org-table-edit-formulas))
20170 ((example-block export-block) (org-edit-src-code))
20171 (fixed-width (org-edit-fixed-width-region))
20172 (otherwise
20173 ;; No notable element at point. Though, we may be at a link,
20174 ;; which is an object. Thus, scan deeper.
20175 (if (eq (org-element-type (org-element-context element)) 'link)
20176 (call-interactively 'ffap)
20177 (user-error "No special environment to edit here"))))))
20179 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20180 (defun org-ctrl-c-ctrl-c (&optional arg)
20181 "Set tags in headline, or update according to changed information at point.
20183 This command does many different things, depending on context:
20185 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20186 this is what we do.
20188 - If the cursor is on a statistics cookie, update it.
20190 - If the cursor is in a headline, prompt for tags and insert them
20191 into the current line, aligned to `org-tags-column'. When called
20192 with prefix arg, realign all tags in the current buffer.
20194 - If the cursor is in one of the special #+KEYWORD lines, this
20195 triggers scanning the buffer for these lines and updating the
20196 information.
20198 - If the cursor is inside a table, realign the table. This command
20199 works even if the automatic table editor has been turned off.
20201 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20202 the entire table.
20204 - If the cursor is at a footnote reference or definition, jump to
20205 the corresponding definition or references, respectively.
20207 - If the cursor is a the beginning of a dynamic block, update it.
20209 - If the current buffer is a capture buffer, close note and file it.
20211 - If the cursor is on a <<<target>>>, update radio targets and
20212 corresponding links in this buffer.
20214 - If the cursor is on a numbered item in a plain list, renumber the
20215 ordered list.
20217 - If the cursor is on a checkbox, toggle it.
20219 - If the cursor is on a code block, evaluate it. The variable
20220 `org-confirm-babel-evaluate' can be used to control prompting
20221 before code block evaluation, by default every code block
20222 evaluation requires confirmation. Code block evaluation can be
20223 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20224 (interactive "P")
20225 (cond
20226 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20227 org-occur-highlights
20228 org-latex-fragment-image-overlays)
20229 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20230 (org-remove-occur-highlights)
20231 (org-remove-latex-fragment-image-overlays)
20232 (message "Temporary highlights/overlays removed from current buffer"))
20233 ((and (local-variable-p 'org-finish-function (current-buffer))
20234 (fboundp org-finish-function))
20235 (funcall org-finish-function))
20236 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20238 (let* ((context (org-element-context)) (type (org-element-type context)))
20239 ;; Test if point is within a blank line.
20240 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20241 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20242 (user-error "C-c C-c can do nothing useful at this location"))
20243 (case type
20244 ;; When at a link, act according to the parent instead.
20245 (link (setq context (org-element-property :parent context))
20246 (setq type (org-element-type context)))
20247 ;; Unsupported object types: check parent element instead.
20248 ((bold code entity export-snippet inline-babel-call inline-src-block
20249 italic latex-fragment line-break macro strike-through subscript
20250 superscript underline verbatim)
20251 (while (and (setq context (org-element-property :parent context))
20252 (not (memq (setq type (org-element-type context))
20253 '(paragraph verse-block table-cell)))))))
20254 ;; For convenience: at the first line of a paragraph on the
20255 ;; same line as an item, apply function on that item instead.
20256 (when (eq type 'paragraph)
20257 (let ((parent (org-element-property :parent context)))
20258 (when (and (eq (org-element-type parent) 'item)
20259 (= (point-at-bol) (org-element-property :begin parent)))
20260 (setq context parent type 'item))))
20261 ;; Act according to type of element or object at point.
20262 (case type
20263 (clock (org-clock-update-time-maybe))
20264 (dynamic-block
20265 (save-excursion
20266 (goto-char (org-element-property :post-affiliated context))
20267 (org-update-dblock)))
20268 (footnote-definition
20269 (goto-char (org-element-property :post-affiliated context))
20270 (call-interactively 'org-footnote-action))
20271 (footnote-reference (call-interactively 'org-footnote-action))
20272 ((headline inlinetask)
20273 (save-excursion (goto-char (org-element-property :begin context))
20274 (call-interactively 'org-set-tags)))
20275 (item
20276 ;; At an item: a double C-u set checkbox to "[-]"
20277 ;; unconditionally, whereas a single one will toggle its
20278 ;; presence. Without an universal argument, if the item
20279 ;; has a checkbox, toggle it. Otherwise repair the list.
20280 (let* ((box (org-element-property :checkbox context))
20281 (struct (org-element-property :structure context))
20282 (old-struct (copy-tree struct))
20283 (parents (org-list-parents-alist struct))
20284 (prevs (org-list-prevs-alist struct))
20285 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20286 (org-list-set-checkbox
20287 (org-element-property :begin context) struct
20288 (cond ((equal arg '(16)) "[-]")
20289 ((and (not box) (equal arg '(4))) "[ ]")
20290 ((or (not box) (equal arg '(4))) nil)
20291 ((eq box 'on) "[ ]")
20292 (t "[X]")))
20293 ;; Mimic `org-list-write-struct' but with grabbing
20294 ;; a return value from `org-list-struct-fix-box'.
20295 (org-list-struct-fix-ind struct parents 2)
20296 (org-list-struct-fix-item-end struct)
20297 (org-list-struct-fix-bul struct prevs)
20298 (org-list-struct-fix-ind struct parents)
20299 (let ((block-item
20300 (org-list-struct-fix-box struct parents prevs orderedp)))
20301 (if (and box (equal struct old-struct))
20302 (if (equal arg '(16))
20303 (message "Checkboxes already reset")
20304 (user-error "Cannot toggle this checkbox: %s"
20305 (if (eq box 'on)
20306 "all subitems checked"
20307 "unchecked subitems")))
20308 (org-list-struct-apply-struct struct old-struct)
20309 (org-update-checkbox-count-maybe))
20310 (when block-item
20311 (message "Checkboxes were removed due to empty box at line %d"
20312 (org-current-line block-item))))))
20313 (keyword
20314 (let ((org-inhibit-startup-visibility-stuff t)
20315 (org-startup-align-all-tables nil))
20316 (when (boundp 'org-table-coordinate-overlays)
20317 (mapc 'delete-overlay org-table-coordinate-overlays)
20318 (setq org-table-coordinate-overlays nil))
20319 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20320 (message "Local setup has been refreshed"))
20321 (plain-list
20322 ;; At a plain list, with a double C-u argument, set
20323 ;; checkboxes of each item to "[-]", whereas a single one
20324 ;; will toggle their presence according to the state of the
20325 ;; first item in the list. Without an argument, repair the
20326 ;; list.
20327 (let* ((begin (org-element-property :contents-begin context))
20328 (beginm (move-marker (make-marker) begin))
20329 (struct (org-element-property :structure context))
20330 (old-struct (copy-tree struct))
20331 (first-box (save-excursion
20332 (goto-char begin)
20333 (looking-at org-list-full-item-re)
20334 (match-string-no-properties 3)))
20335 (new-box (cond ((equal arg '(16)) "[-]")
20336 ((equal arg '(4)) (unless first-box "[ ]"))
20337 ((equal first-box "[X]") "[ ]")
20338 (t "[X]"))))
20339 (cond
20340 (arg
20341 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20342 (org-list-get-all-items
20343 begin struct (org-list-prevs-alist struct))))
20344 ((and first-box (eq (point) begin))
20345 ;; For convenience, when point is at bol on the first
20346 ;; item of the list and no argument is provided, simply
20347 ;; toggle checkbox of that item, if any.
20348 (org-list-set-checkbox begin struct new-box)))
20349 (org-list-write-struct
20350 struct (org-list-parents-alist struct) old-struct)
20351 (org-update-checkbox-count-maybe)
20352 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20353 ((property-drawer node-property)
20354 (call-interactively 'org-property-action))
20355 ((radio-target target)
20356 (call-interactively 'org-update-radio-target-regexp))
20357 (statistics-cookie
20358 (call-interactively 'org-update-statistics-cookies))
20359 ((table table-cell table-row)
20360 ;; At a table, recalculate every field and align it. Also
20361 ;; send the table if necessary. If the table has
20362 ;; a `table.el' type, just give up. At a table row or
20363 ;; cell, maybe recalculate line but always align table.
20364 (if (eq (org-element-property :type context) 'table.el)
20365 (message "Use C-c ' to edit table.el tables")
20366 (let ((org-enable-table-editor t))
20367 (if (or (eq type 'table)
20368 ;; Check if point is at a TBLFM line.
20369 (and (eq type 'table-row)
20370 (= (point) (org-element-property :end context))))
20371 (save-excursion
20372 (if (org-at-TBLFM-p)
20373 (progn (require 'org-table)
20374 (org-table-calc-current-TBLFM))
20375 (goto-char (org-element-property :contents-begin context))
20376 (org-call-with-arg 'org-table-recalculate (or arg t))
20377 (orgtbl-send-table 'maybe)))
20378 (org-table-maybe-eval-formula)
20379 (cond (arg (call-interactively 'org-table-recalculate))
20380 ((org-table-maybe-recalculate-line))
20381 (t (org-table-align)))))))
20382 (timestamp (org-timestamp-change 0 'day))
20383 (otherwise
20384 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20385 (user-error
20386 "C-c C-c can do nothing useful at this location")))))))))
20388 (defun org-mode-restart ()
20389 (interactive)
20390 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20391 (funcall major-mode)
20392 (hack-local-variables)
20393 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20394 (org-indent-mode -1)))
20395 (message "%s restarted" major-mode))
20397 (defun org-kill-note-or-show-branches ()
20398 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20399 (interactive)
20400 (if (not org-finish-function)
20401 (progn
20402 (hide-subtree)
20403 (call-interactively 'show-branches))
20404 (let ((org-note-abort t))
20405 (funcall org-finish-function))))
20407 (defun org-open-line (n)
20408 "Insert a new row in tables, call `open-line' elsewhere.
20409 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20410 (interactive "*p")
20411 (cond
20412 ((not org-special-ctrl-o)
20413 (open-line n))
20414 ((org-at-table-p)
20415 (org-table-insert-row))
20417 (open-line n))))
20419 (defun org-return (&optional indent)
20420 "Goto next table row or insert a newline.
20421 Calls `org-table-next-row' or `newline', depending on context.
20422 See the individual commands for more information."
20423 (interactive)
20424 (let (org-ts-what)
20425 (cond
20426 ((or (bobp) (org-in-src-block-p))
20427 (if indent (newline-and-indent) (newline)))
20428 ((org-at-table-p)
20429 (org-table-justify-field-maybe)
20430 (call-interactively 'org-table-next-row))
20431 ;; when `newline-and-indent' is called within a list, make sure
20432 ;; text moved stays inside the item.
20433 ((and (org-in-item-p) indent)
20434 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20435 (progn
20436 (save-match-data (newline))
20437 (org-indent-line-to (length (match-string 0))))
20438 (let ((ind (org-get-indentation)))
20439 (newline)
20440 (if (org-looking-back org-list-end-re)
20441 (org-indent-line)
20442 (org-indent-line-to ind)))))
20443 ((and org-return-follows-link
20444 (org-at-timestamp-p t)
20445 (not (eq org-ts-what 'after)))
20446 (org-follow-timestamp-link))
20447 ((and org-return-follows-link
20448 (let ((tprop (get-text-property (point) 'face)))
20449 (or (eq tprop 'org-link)
20450 (and (listp tprop) (memq 'org-link tprop)))))
20451 (call-interactively 'org-open-at-point))
20452 ((and (org-at-heading-p)
20453 (looking-at
20454 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20455 (org-show-entry)
20456 (end-of-line 1)
20457 (newline))
20458 (t (if indent (newline-and-indent) (newline))))))
20460 (defun org-return-indent ()
20461 "Goto next table row or insert a newline and indent.
20462 Calls `org-table-next-row' or `newline-and-indent', depending on
20463 context. See the individual commands for more information."
20464 (interactive)
20465 (org-return t))
20467 (defun org-ctrl-c-star ()
20468 "Compute table, or change heading status of lines.
20469 Calls `org-table-recalculate' or `org-toggle-heading',
20470 depending on context."
20471 (interactive)
20472 (cond
20473 ((org-at-table-p)
20474 (call-interactively 'org-table-recalculate))
20476 ;; Convert all lines in region to list items
20477 (call-interactively 'org-toggle-heading))))
20479 (defun org-ctrl-c-minus ()
20480 "Insert separator line in table or modify bullet status of line.
20481 Also turns a plain line or a region of lines into list items.
20482 Calls `org-table-insert-hline', `org-toggle-item', or
20483 `org-cycle-list-bullet', depending on context."
20484 (interactive)
20485 (cond
20486 ((org-at-table-p)
20487 (call-interactively 'org-table-insert-hline))
20488 ((org-region-active-p)
20489 (call-interactively 'org-toggle-item))
20490 ((org-in-item-p)
20491 (call-interactively 'org-cycle-list-bullet))
20493 (call-interactively 'org-toggle-item))))
20495 (defun org-toggle-item (arg)
20496 "Convert headings or normal lines to items, items to normal lines.
20497 If there is no active region, only the current line is considered.
20499 If the first non blank line in the region is a headline, convert
20500 all headlines to items, shifting text accordingly.
20502 If it is an item, convert all items to normal lines.
20504 If it is normal text, change region into a list of items.
20505 With a prefix argument ARG, change the region in a single item."
20506 (interactive "P")
20507 (let ((shift-text
20508 (function
20509 ;; Shift text in current section to IND, from point to END.
20510 ;; The function leaves point to END line.
20511 (lambda (ind end)
20512 (let ((min-i 1000) (end (copy-marker end)))
20513 ;; First determine the minimum indentation (MIN-I) of
20514 ;; the text.
20515 (save-excursion
20516 (catch 'exit
20517 (while (< (point) end)
20518 (let ((i (org-get-indentation)))
20519 (cond
20520 ;; Skip blank lines and inline tasks.
20521 ((looking-at "^[ \t]*$"))
20522 ((looking-at org-outline-regexp-bol))
20523 ;; We can't find less than 0 indentation.
20524 ((zerop i) (throw 'exit (setq min-i 0)))
20525 ((< i min-i) (setq min-i i))))
20526 (forward-line))))
20527 ;; Then indent each line so that a line indented to
20528 ;; MIN-I becomes indented to IND. Ignore blank lines
20529 ;; and inline tasks in the process.
20530 (let ((delta (- ind min-i)))
20531 (while (< (point) end)
20532 (unless (or (looking-at "^[ \t]*$")
20533 (looking-at org-outline-regexp-bol))
20534 (org-indent-line-to (+ (org-get-indentation) delta)))
20535 (forward-line)))))))
20536 (skip-blanks
20537 (function
20538 ;; Return beginning of first non-blank line, starting from
20539 ;; line at POS.
20540 (lambda (pos)
20541 (save-excursion
20542 (goto-char pos)
20543 (skip-chars-forward " \r\t\n")
20544 (point-at-bol)))))
20545 beg end)
20546 ;; Determine boundaries of changes.
20547 (if (org-region-active-p)
20548 (setq beg (funcall skip-blanks (region-beginning))
20549 end (copy-marker (region-end)))
20550 (setq beg (funcall skip-blanks (point-at-bol))
20551 end (copy-marker (point-at-eol))))
20552 ;; Depending on the starting line, choose an action on the text
20553 ;; between BEG and END.
20554 (org-with-limited-levels
20555 (save-excursion
20556 (goto-char beg)
20557 (cond
20558 ;; Case 1. Start at an item: de-itemize. Note that it only
20559 ;; happens when a region is active: `org-ctrl-c-minus'
20560 ;; would call `org-cycle-list-bullet' otherwise.
20561 ((org-at-item-p)
20562 (while (< (point) end)
20563 (when (org-at-item-p)
20564 (skip-chars-forward " \t")
20565 (delete-region (point) (match-end 0)))
20566 (forward-line)))
20567 ;; Case 2. Start at an heading: convert to items.
20568 ((org-at-heading-p)
20569 (let* ((bul (org-list-bullet-string "-"))
20570 (bul-len (length bul))
20571 ;; Indentation of the first heading. It should be
20572 ;; relative to the indentation of its parent, if any.
20573 (start-ind (save-excursion
20574 (cond
20575 ((not org-adapt-indentation) 0)
20576 ((not (outline-previous-heading)) 0)
20577 (t (length (match-string 0))))))
20578 ;; Level of first heading. Further headings will be
20579 ;; compared to it to determine hierarchy in the list.
20580 (ref-level (org-reduced-level (org-outline-level))))
20581 (while (< (point) end)
20582 (let* ((level (org-reduced-level (org-outline-level)))
20583 (delta (max 0 (- level ref-level))))
20584 ;; If current headline is less indented than the first
20585 ;; one, set it as reference, in order to preserve
20586 ;; subtrees.
20587 (when (< level ref-level) (setq ref-level level))
20588 (replace-match bul t t)
20589 (org-indent-line-to (+ start-ind (* delta bul-len)))
20590 ;; Ensure all text down to END (or SECTION-END) belongs
20591 ;; to the newly created item.
20592 (let ((section-end (save-excursion
20593 (or (outline-next-heading) (point)))))
20594 (forward-line)
20595 (funcall shift-text
20596 (+ start-ind (* (1+ delta) bul-len))
20597 (min end section-end)))))))
20598 ;; Case 3. Normal line with ARG: make the first line of region
20599 ;; an item, and shift indentation of others lines to
20600 ;; set them as item's body.
20601 (arg (let* ((bul (org-list-bullet-string "-"))
20602 (bul-len (length bul))
20603 (ref-ind (org-get-indentation)))
20604 (skip-chars-forward " \t")
20605 (insert bul)
20606 (forward-line)
20607 (while (< (point) end)
20608 ;; Ensure that lines less indented than first one
20609 ;; still get included in item body.
20610 (funcall shift-text
20611 (+ ref-ind bul-len)
20612 (min end (save-excursion (or (outline-next-heading)
20613 (point)))))
20614 (forward-line))))
20615 ;; Case 4. Normal line without ARG: turn each non-item line
20616 ;; into an item.
20618 (while (< (point) end)
20619 (unless (or (org-at-heading-p) (org-at-item-p))
20620 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
20621 (replace-match
20622 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
20623 (forward-line))))))))
20625 (defun org-toggle-heading (&optional nstars)
20626 "Convert headings to normal text, or items or text to headings.
20627 If there is no active region, only convert the current line.
20629 With a \\[universal-argument] prefix, convert the whole list at
20630 point into heading.
20632 In a region:
20634 - If the first non blank line is a headline, remove the stars
20635 from all headlines in the region.
20637 - If it is a normal line, turn each and every normal line (i.e.,
20638 not an heading or an item) in the region into headings. If you
20639 want to convert only the first line of this region, use one
20640 universal prefix argument.
20642 - If it is a plain list item, turn all plain list items into headings.
20644 When converting a line into a heading, the number of stars is chosen
20645 such that the lines become children of the current entry. However,
20646 when a numeric prefix argument is given, its value determines the
20647 number of stars to add."
20648 (interactive "P")
20649 (let ((skip-blanks
20650 (function
20651 ;; Return beginning of first non-blank line, starting from
20652 ;; line at POS.
20653 (lambda (pos)
20654 (save-excursion
20655 (goto-char pos)
20656 (while (org-at-comment-p) (forward-line))
20657 (skip-chars-forward " \r\t\n")
20658 (point-at-bol)))))
20659 beg end toggled)
20660 ;; Determine boundaries of changes. If a universal prefix has
20661 ;; been given, put the list in a region. If region ends at a bol,
20662 ;; do not consider the last line to be in the region.
20664 (when (and current-prefix-arg (org-at-item-p))
20665 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20666 (org-mark-element))
20668 (if (org-region-active-p)
20669 (setq beg (funcall skip-blanks (region-beginning))
20670 end (copy-marker (save-excursion
20671 (goto-char (region-end))
20672 (if (bolp) (point) (point-at-eol)))))
20673 (setq beg (funcall skip-blanks (point-at-bol))
20674 end (copy-marker (point-at-eol))))
20675 ;; Ensure inline tasks don't count as headings.
20676 (org-with-limited-levels
20677 (save-excursion
20678 (goto-char beg)
20679 (cond
20680 ;; Case 1. Started at an heading: de-star headings.
20681 ((org-at-heading-p)
20682 (while (< (point) end)
20683 (when (org-at-heading-p t)
20684 (looking-at org-outline-regexp) (replace-match "")
20685 (setq toggled t))
20686 (forward-line)))
20687 ;; Case 2. Started at an item: change items into headlines.
20688 ;; One star will be added by `org-list-to-subtree'.
20689 ((org-at-item-p)
20690 (let* ((stars (make-string
20691 ;; subtract the star that will be added again by
20692 ;; `org-list-to-subtree'
20693 (if (numberp nstars) (1- nstars)
20694 (or (org-current-level) 0))
20695 ?*))
20696 (add-stars
20697 (cond (nstars "") ; stars from prefix only
20698 ((equal stars "") "") ; before first heading
20699 (org-odd-levels-only "*") ; inside heading, odd
20700 (t "")))) ; inside heading, oddeven
20701 (while (< (point) end)
20702 (when (org-at-item-p)
20703 ;; Pay attention to cases when region ends before list.
20704 (let* ((struct (org-list-struct))
20705 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20706 (save-restriction
20707 (narrow-to-region (point) list-end)
20708 (insert
20709 (org-list-to-subtree
20710 (org-list-parse-list t)
20711 '(:istart (concat stars add-stars (funcall get-stars depth))
20712 :icount (concat stars add-stars (funcall get-stars depth)))))))
20713 (setq toggled t))
20714 (forward-line))))
20715 ;; Case 3. Started at normal text: make every line an heading,
20716 ;; skipping headlines and items.
20717 (t (let* ((stars
20718 (make-string
20719 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20720 (add-stars
20721 (cond (nstars "") ; stars from prefix only
20722 ((equal stars "") "*") ; before first heading
20723 (org-odd-levels-only "**") ; inside heading, odd
20724 (t "*"))) ; inside heading, oddeven
20725 (rpl (concat stars add-stars " "))
20726 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20727 (while (< (point) (if (equal nstars '(4)) lend end))
20728 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20729 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
20730 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20731 (forward-line)))))))
20732 (unless toggled (message "Cannot toggle heading from here"))))
20734 (defun org-meta-return (&optional arg)
20735 "Insert a new heading or wrap a region in a table.
20736 Calls `org-insert-heading' or `org-table-wrap-region', depending
20737 on context. See the individual commands for more information."
20738 (interactive "P")
20739 (org-check-before-invisible-edit 'insert)
20740 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20741 (let* ((element (org-element-at-point))
20742 (type (org-element-type element)))
20743 (when (eq type 'table-row)
20744 (setq element (org-element-property :parent element))
20745 (setq type 'table))
20746 (if (and (eq type 'table)
20747 (eq (org-element-property :type element) 'org)
20748 (>= (point) (org-element-property :contents-begin element))
20749 (< (point) (org-element-property :contents-end element)))
20750 (call-interactively 'org-table-wrap-region)
20751 (call-interactively 'org-insert-heading)))))
20753 ;;; Menu entries
20755 (defsubst org-in-subtree-not-table-p ()
20756 "Are we in a subtree and not in a table?"
20757 (and (not (org-before-first-heading-p))
20758 (not (org-at-table-p))))
20760 ;; Define the Org-mode menus
20761 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20762 '("Tbl"
20763 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20764 ["Next Field" org-cycle (org-at-table-p)]
20765 ["Previous Field" org-shifttab (org-at-table-p)]
20766 ["Next Row" org-return (org-at-table-p)]
20767 "--"
20768 ["Blank Field" org-table-blank-field (org-at-table-p)]
20769 ["Edit Field" org-table-edit-field (org-at-table-p)]
20770 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20771 "--"
20772 ("Column"
20773 ["Move Column Left" org-metaleft (org-at-table-p)]
20774 ["Move Column Right" org-metaright (org-at-table-p)]
20775 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20776 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20777 ("Row"
20778 ["Move Row Up" org-metaup (org-at-table-p)]
20779 ["Move Row Down" org-metadown (org-at-table-p)]
20780 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20781 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20782 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20783 "--"
20784 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20785 ("Rectangle"
20786 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20787 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20788 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20789 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20790 "--"
20791 ("Calculate"
20792 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20793 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20794 ["Edit Formulas" org-edit-special (org-at-table-p)]
20795 "--"
20796 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20797 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20798 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20799 "--"
20800 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20801 "--"
20802 ["Sum Column/Rectangle" org-table-sum
20803 (or (org-at-table-p) (org-region-active-p))]
20804 ["Which Column?" org-table-current-column (org-at-table-p)])
20805 ["Debug Formulas"
20806 org-table-toggle-formula-debugger
20807 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20808 ["Show Col/Row Numbers"
20809 org-table-toggle-coordinate-overlays
20810 :style toggle
20811 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20812 "--"
20813 ["Create" org-table-create (and (not (org-at-table-p))
20814 org-enable-table-editor)]
20815 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20816 ["Import from File" org-table-import (not (org-at-table-p))]
20817 ["Export to File" org-table-export (org-at-table-p)]
20818 "--"
20819 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20821 (easy-menu-define org-org-menu org-mode-map "Org menu"
20822 '("Org"
20823 ("Show/Hide"
20824 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20825 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20826 ["Sparse Tree..." org-sparse-tree t]
20827 ["Reveal Context" org-reveal t]
20828 ["Show All" show-all t]
20829 "--"
20830 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20831 "--"
20832 ["New Heading" org-insert-heading t]
20833 ("Navigate Headings"
20834 ["Up" outline-up-heading t]
20835 ["Next" outline-next-visible-heading t]
20836 ["Previous" outline-previous-visible-heading t]
20837 ["Next Same Level" outline-forward-same-level t]
20838 ["Previous Same Level" outline-backward-same-level t]
20839 "--"
20840 ["Jump" org-goto t])
20841 ("Edit Structure"
20842 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20843 "--"
20844 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20845 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20846 "--"
20847 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20848 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20849 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20850 "--"
20851 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20852 "--"
20853 ["Copy visible text" org-copy-visible t]
20854 "--"
20855 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20856 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20857 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20858 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20859 "--"
20860 ["Sort Region/Children" org-sort t]
20861 "--"
20862 ["Convert to odd levels" org-convert-to-odd-levels t]
20863 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20864 ("Editing"
20865 ["Emphasis..." org-emphasize t]
20866 ["Edit Source Example" org-edit-special t]
20867 "--"
20868 ["Footnote new/jump" org-footnote-action t]
20869 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20870 ("Archive"
20871 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20872 "--"
20873 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20874 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20875 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20877 "--"
20878 ("Hyperlinks"
20879 ["Store Link (Global)" org-store-link t]
20880 ["Find existing link to here" org-occur-link-in-agenda-files t]
20881 ["Insert Link" org-insert-link t]
20882 ["Follow Link" org-open-at-point t]
20883 "--"
20884 ["Next link" org-next-link t]
20885 ["Previous link" org-previous-link t]
20886 "--"
20887 ["Descriptive Links"
20888 org-toggle-link-display
20889 :style radio
20890 :selected org-descriptive-links
20892 ["Literal Links"
20893 org-toggle-link-display
20894 :style radio
20895 :selected (not org-descriptive-links)])
20896 "--"
20897 ("TODO Lists"
20898 ["TODO/DONE/-" org-todo t]
20899 ("Select keyword"
20900 ["Next keyword" org-shiftright (org-at-heading-p)]
20901 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20902 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20903 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20904 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20905 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20906 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20907 "--"
20908 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20909 :selected org-enforce-todo-dependencies :style toggle :active t]
20910 "Settings for tree at point"
20911 ["Do Children sequentially" org-toggle-ordered-property :style radio
20912 :selected (org-entry-get nil "ORDERED")
20913 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20914 ["Do Children parallel" org-toggle-ordered-property :style radio
20915 :selected (not (org-entry-get nil "ORDERED"))
20916 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20917 "--"
20918 ["Set Priority" org-priority t]
20919 ["Priority Up" org-shiftup t]
20920 ["Priority Down" org-shiftdown t]
20921 "--"
20922 ["Get news from all feeds" org-feed-update-all t]
20923 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20924 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20925 ("TAGS and Properties"
20926 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20927 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20928 "--"
20929 ["Set property" org-set-property (not (org-before-first-heading-p))]
20930 ["Column view of properties" org-columns t]
20931 ["Insert Column View DBlock" org-insert-columns-dblock t])
20932 ("Dates and Scheduling"
20933 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20934 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20935 ("Change Date"
20936 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20937 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20938 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20939 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20940 ["Compute Time Range" org-evaluate-time-range t]
20941 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20942 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20943 "--"
20944 ["Custom time format" org-toggle-time-stamp-overlays
20945 :style radio :selected org-display-custom-times]
20946 "--"
20947 ["Goto Calendar" org-goto-calendar t]
20948 ["Date from Calendar" org-date-from-calendar t]
20949 "--"
20950 ["Start/Restart Timer" org-timer-start t]
20951 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20952 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20953 ["Insert Timer String" org-timer t]
20954 ["Insert Timer Item" org-timer-item t])
20955 ("Logging work"
20956 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20957 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20958 ["Clock out" org-clock-out t]
20959 ["Clock cancel" org-clock-cancel t]
20960 "--"
20961 ["Mark as default task" org-clock-mark-default-task t]
20962 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20963 ["Goto running clock" org-clock-goto t]
20964 "--"
20965 ["Display times" org-clock-display t]
20966 ["Create clock table" org-clock-report t]
20967 "--"
20968 ["Record DONE time"
20969 (progn (setq org-log-done (not org-log-done))
20970 (message "Switching to %s will %s record a timestamp"
20971 (car org-done-keywords)
20972 (if org-log-done "automatically" "not")))
20973 :style toggle :selected org-log-done])
20974 "--"
20975 ["Agenda Command..." org-agenda t]
20976 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20977 ("File List for Agenda")
20978 ("Special views current file"
20979 ["TODO Tree" org-show-todo-tree t]
20980 ["Check Deadlines" org-check-deadlines t]
20981 ["Timeline" org-timeline t]
20982 ["Tags/Property tree" org-match-sparse-tree t])
20983 "--"
20984 ["Export/Publish..." org-export-dispatch t]
20985 ("LaTeX"
20986 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20987 :selected org-cdlatex-mode]
20988 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20989 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20990 ["Modify math symbol" org-cdlatex-math-modify
20991 (org-inside-LaTeX-fragment-p)]
20992 ["Insert citation" org-reftex-citation t]
20993 "--"
20994 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20995 "--"
20996 ("MobileOrg"
20997 ["Push Files and Views" org-mobile-push t]
20998 ["Get Captured and Flagged" org-mobile-pull t]
20999 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21000 "--"
21001 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21002 "--"
21003 ("Documentation"
21004 ["Show Version" org-version t]
21005 ["Info Documentation" org-info t])
21006 ("Customize"
21007 ["Browse Org Group" org-customize t]
21008 "--"
21009 ["Expand This Menu" org-create-customize-menu
21010 (fboundp 'customize-menu-create)])
21011 ["Send bug report" org-submit-bug-report t]
21012 "--"
21013 ("Refresh/Reload"
21014 ["Refresh setup current buffer" org-mode-restart t]
21015 ["Reload Org (after update)" org-reload t]
21016 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21019 (defun org-info (&optional node)
21020 "Read documentation for Org-mode in the info system.
21021 With optional NODE, go directly to that node."
21022 (interactive)
21023 (info (format "(org)%s" (or node ""))))
21025 ;;;###autoload
21026 (defun org-submit-bug-report ()
21027 "Submit a bug report on Org-mode via mail.
21029 Don't hesitate to report any problems or inaccurate documentation.
21031 If you don't have setup sending mail from (X)Emacs, please copy the
21032 output buffer into your mail program, as it gives us important
21033 information about your Org-mode version and configuration."
21034 (interactive)
21035 (require 'reporter)
21036 (org-load-modules-maybe)
21037 (org-require-autoloaded-modules)
21038 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21039 (reporter-submit-bug-report
21040 "emacs-orgmode@gnu.org"
21041 (org-version nil 'full)
21042 (let (list)
21043 (save-window-excursion
21044 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21045 (delete-other-windows)
21046 (erase-buffer)
21047 (insert "You are about to submit a bug report to the Org-mode mailing list.
21049 We would like to add your full Org-mode and Outline configuration to the
21050 bug report. This greatly simplifies the work of the maintainer and
21051 other experts on the mailing list.
21053 HOWEVER, some variables you have customized may contain private
21054 information. The names of customers, colleagues, or friends, might
21055 appear in the form of file names, tags, todo states, or search strings.
21056 If you answer yes to the prompt, you might want to check and remove
21057 such private information before sending the email.")
21058 (add-text-properties (point-min) (point-max) '(face org-warning))
21059 (when (yes-or-no-p "Include your Org-mode configuration ")
21060 (mapatoms
21061 (lambda (v)
21062 (and (boundp v)
21063 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21064 (or (and (symbol-value v)
21065 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21066 (and
21067 (get v 'custom-type) (get v 'standard-value)
21068 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21069 (push v list)))))
21070 (kill-buffer (get-buffer "*Warn about privacy*"))
21071 list))
21072 nil nil
21073 "Remember to cover the basics, that is, what you expected to happen and
21074 what in fact did happen. You don't know how to make a good report? See
21076 http://orgmode.org/manual/Feedback.html#Feedback
21078 Your bug report will be posted to the Org-mode mailing list.
21079 ------------------------------------------------------------------------")
21080 (save-excursion
21081 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21082 (replace-match "\\1Bug: \\3 [\\2]")))))
21085 (defun org-install-agenda-files-menu ()
21086 (let ((bl (buffer-list)))
21087 (save-excursion
21088 (while bl
21089 (set-buffer (pop bl))
21090 (if (derived-mode-p 'org-mode) (setq bl nil)))
21091 (when (derived-mode-p 'org-mode)
21092 (easy-menu-change
21093 '("Org") "File List for Agenda"
21094 (append
21095 (list
21096 ["Edit File List" (org-edit-agenda-file-list) t]
21097 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21098 ["Remove Current File from List" org-remove-file t]
21099 ["Cycle through agenda files" org-cycle-agenda-files t]
21100 ["Occur in all agenda files" org-occur-in-agenda-files t]
21101 "--")
21102 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21104 ;;;; Documentation
21106 (defun org-require-autoloaded-modules ()
21107 (interactive)
21108 (mapc 'require
21109 '(org-agenda org-archive org-attach org-clock org-colview org-id
21110 org-table org-timer)))
21112 ;;;###autoload
21113 (defun org-reload (&optional uncompiled)
21114 "Reload all org lisp files.
21115 With prefix arg UNCOMPILED, load the uncompiled versions."
21116 (interactive "P")
21117 (require 'loadhist)
21118 (let* ((org-dir (org-find-library-dir "org"))
21119 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21120 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21121 (remove-re (mapconcat 'identity
21122 (mapcar (lambda (f) (concat "^" f "$"))
21123 (list (if (featurep 'xemacs)
21124 "org-colview"
21125 "org-colview-xemacs")
21126 "org" "org-loaddefs" "org-version"))
21127 "\\|"))
21128 (feats (delete-dups
21129 (mapcar 'file-name-sans-extension
21130 (mapcar 'file-name-nondirectory
21131 (delq nil
21132 (mapcar 'feature-file
21133 features))))))
21134 (lfeat (append
21135 (sort
21136 (setq feats
21137 (delq nil (mapcar
21138 (lambda (f)
21139 (if (and (string-match feature-re f)
21140 (not (string-match remove-re f)))
21141 f nil))
21142 feats)))
21143 'string-lessp)
21144 (list "org-version" "org")))
21145 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21146 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21147 load-uncore load-misses)
21148 (setq load-misses
21149 (delq 't
21150 (mapcar (lambda (f)
21151 (or (org-load-noerror-mustsuffix (concat org-dir f))
21152 (and (string= org-dir contrib-dir)
21153 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21154 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21155 (add-to-list 'load-uncore f 'append)
21158 lfeat)))
21159 (if load-uncore
21160 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21161 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21162 (if load-misses
21163 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21164 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21165 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21167 ;;;###autoload
21168 (defun org-customize ()
21169 "Call the customize function with org as argument."
21170 (interactive)
21171 (org-load-modules-maybe)
21172 (org-require-autoloaded-modules)
21173 (customize-browse 'org))
21175 (defun org-create-customize-menu ()
21176 "Create a full customization menu for Org-mode, insert it into the menu."
21177 (interactive)
21178 (org-load-modules-maybe)
21179 (org-require-autoloaded-modules)
21180 (if (fboundp 'customize-menu-create)
21181 (progn
21182 (easy-menu-change
21183 '("Org") "Customize"
21184 `(["Browse Org group" org-customize t]
21185 "--"
21186 ,(customize-menu-create 'org)
21187 ["Set" Custom-set t]
21188 ["Save" Custom-save t]
21189 ["Reset to Current" Custom-reset-current t]
21190 ["Reset to Saved" Custom-reset-saved t]
21191 ["Reset to Standard Settings" Custom-reset-standard t]))
21192 (message "\"Org\"-menu now contains full customization menu"))
21193 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21195 ;;;; Miscellaneous stuff
21197 ;;; Generally useful functions
21199 (defun org-get-at-bol (property)
21200 "Get text property PROPERTY at beginning of line."
21201 (get-text-property (point-at-bol) property))
21203 (defun org-find-text-property-in-string (prop s)
21204 "Return the first non-nil value of property PROP in string S."
21205 (or (get-text-property 0 prop s)
21206 (get-text-property (or (next-single-property-change 0 prop s) 0)
21207 prop s)))
21209 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21210 "Display the given MESSAGE as a warning."
21211 (if (fboundp 'display-warning)
21212 (display-warning 'org message
21213 (if (featurep 'xemacs) 'warning :warning))
21214 (let ((buf (get-buffer-create "*Org warnings*")))
21215 (with-current-buffer buf
21216 (goto-char (point-max))
21217 (insert "Warning (Org): " message)
21218 (unless (bolp)
21219 (newline)))
21220 (display-buffer buf)
21221 (sit-for 0))))
21223 (defun org-eval (form)
21224 "Eval FORM and return result."
21225 (condition-case error
21226 (eval form)
21227 (error (format "%%![Error: %s]" error))))
21229 (defun org-in-clocktable-p ()
21230 "Check if the cursor is in a clocktable."
21231 (let ((pos (point)) start)
21232 (save-excursion
21233 (end-of-line 1)
21234 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21235 (setq start (match-beginning 0))
21236 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21237 (>= (match-end 0) pos)
21238 start))))
21240 (defun org-in-commented-line ()
21241 "Is point in a line starting with `#'?"
21242 (equal (char-after (point-at-bol)) ?#))
21244 (defun org-in-indented-comment-line ()
21245 "Is point in a line starting with `#' after some white space?"
21246 (save-excursion
21247 (save-match-data
21248 (goto-char (point-at-bol))
21249 (looking-at "[ \t]*#"))))
21251 (defun org-in-verbatim-emphasis ()
21252 (save-match-data
21253 (and (org-in-regexp org-emph-re 2)
21254 (>= (point) (match-beginning 3))
21255 (<= (point) (match-end 4))
21256 (member (match-string 3) '("=" "~")))))
21258 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21259 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21260 (if (and marker (marker-buffer marker)
21261 (buffer-live-p (marker-buffer marker)))
21262 (progn
21263 (org-pop-to-buffer-same-window (marker-buffer marker))
21264 (if (or (> marker (point-max)) (< marker (point-min)))
21265 (widen))
21266 (goto-char marker)
21267 (org-show-context 'org-goto))
21268 (if bookmark
21269 (bookmark-jump bookmark)
21270 (error "Cannot find location"))))
21272 (defun org-quote-csv-field (s)
21273 "Quote field for inclusion in CSV material."
21274 (if (string-match "[\",]" s)
21275 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21278 (defun org-force-self-insert (N)
21279 "Needed to enforce self-insert under remapping."
21280 (interactive "p")
21281 (self-insert-command N))
21283 (defun org-string-width (s)
21284 "Compute width of string, ignoring invisible characters.
21285 This ignores character with invisibility property `org-link', and also
21286 characters with property `org-cwidth', because these will become invisible
21287 upon the next fontification round."
21288 (let (b l)
21289 (when (or (eq t buffer-invisibility-spec)
21290 (assq 'org-link buffer-invisibility-spec))
21291 (while (setq b (text-property-any 0 (length s)
21292 'invisible 'org-link s))
21293 (setq s (concat (substring s 0 b)
21294 (substring s (or (next-single-property-change
21295 b 'invisible s) (length s)))))))
21296 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21297 (setq s (concat (substring s 0 b)
21298 (substring s (or (next-single-property-change
21299 b 'org-cwidth s) (length s))))))
21300 (setq l (string-width s) b -1)
21301 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21302 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21305 (defun org-shorten-string (s maxlength)
21306 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21307 If the string is shorter or has length MAXLENGTH, just return the
21308 original string. If it is longer, the functions finds a space in the
21309 string, breaks this string off at that locations and adds three dots
21310 as ellipsis. Including the ellipsis, the string will not be longer
21311 than MAXLENGTH. If finding a good breaking point in the string does
21312 not work, the string is just chopped off in the middle of a word
21313 if necessary."
21314 (if (<= (length s) maxlength)
21316 (let* ((n (max (- maxlength 4) 1))
21317 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21318 (if (string-match re s)
21319 (concat (match-string 1 s) "...")
21320 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21322 (defun org-get-indentation (&optional line)
21323 "Get the indentation of the current line, interpreting tabs.
21324 When LINE is given, assume it represents a line and compute its indentation."
21325 (if line
21326 (if (string-match "^ *" (org-remove-tabs line))
21327 (match-end 0))
21328 (save-excursion
21329 (beginning-of-line 1)
21330 (skip-chars-forward " \t")
21331 (current-column))))
21333 (defun org-get-string-indentation (s)
21334 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21335 (let ((n -1) (i 0) (w tab-width) c)
21336 (catch 'exit
21337 (while (< (setq n (1+ n)) (length s))
21338 (setq c (aref s n))
21339 (cond ((= c ?\ ) (setq i (1+ i)))
21340 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21341 (t (throw 'exit t)))))
21344 (defun org-remove-tabs (s &optional width)
21345 "Replace tabulators in S with spaces.
21346 Assumes that s is a single line, starting in column 0."
21347 (setq width (or width tab-width))
21348 (while (string-match "\t" s)
21349 (setq s (replace-match
21350 (make-string
21351 (- (* width (/ (+ (match-beginning 0) width) width))
21352 (match-beginning 0)) ?\ )
21353 t t s)))
21356 (defun org-fix-indentation (line ind)
21357 "Fix indentation in LINE.
21358 IND is a cons cell with target and minimum indentation.
21359 If the current indentation in LINE is smaller than the minimum,
21360 leave it alone. If it is larger than ind, set it to the target."
21361 (let* ((l (org-remove-tabs line))
21362 (i (org-get-indentation l))
21363 (i1 (car ind)) (i2 (cdr ind)))
21364 (if (>= i i2) (setq l (substring line i2)))
21365 (if (> i1 0)
21366 (concat (make-string i1 ?\ ) l)
21367 l)))
21369 (defun org-remove-indentation (code &optional n)
21370 "Remove the maximum common indentation from the lines in CODE.
21371 N may optionally be the number of spaces to remove."
21372 (with-temp-buffer
21373 (insert code)
21374 (org-do-remove-indentation n)
21375 (buffer-string)))
21377 (defun org-do-remove-indentation (&optional n)
21378 "Remove the maximum common indentation from the buffer."
21379 (untabify (point-min) (point-max))
21380 (let ((min 10000) re)
21381 (if n
21382 (setq min n)
21383 (goto-char (point-min))
21384 (while (re-search-forward "^ *[^ \n]" nil t)
21385 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21386 (unless (or (= min 0) (= min 10000))
21387 (setq re (format "^ \\{%d\\}" min))
21388 (goto-char (point-min))
21389 (while (re-search-forward re nil t)
21390 (replace-match "")
21391 (end-of-line 1))
21392 min)))
21394 (defun org-fill-template (template alist)
21395 "Find each %key of ALIST in TEMPLATE and replace it."
21396 (let ((case-fold-search nil)
21397 entry key value)
21398 (setq alist (sort (copy-sequence alist)
21399 (lambda (a b) (< (length (car a)) (length (car b))))))
21400 (while (setq entry (pop alist))
21401 (setq template
21402 (replace-regexp-in-string
21403 (concat "%" (regexp-quote (car entry)))
21404 (or (cdr entry) "") template t t)))
21405 template))
21407 (defun org-base-buffer (buffer)
21408 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21409 (if (not buffer)
21410 buffer
21411 (or (buffer-base-buffer buffer)
21412 buffer)))
21414 (defun org-trim (s)
21415 "Remove whitespace at beginning and end of string."
21416 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
21417 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
21420 (defun org-wrap (string &optional width lines)
21421 "Wrap string to either a number of lines, or a width in characters.
21422 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21423 that costs. If there is a word longer than WIDTH, the text is actually
21424 wrapped to the length of that word.
21425 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21426 many lines, whatever width that takes.
21427 The return value is a list of lines, without newlines at the end."
21428 (let* ((words (org-split-string string "[ \t\n]+"))
21429 (maxword (apply 'max (mapcar 'org-string-width words)))
21430 w ll)
21431 (cond (width
21432 (org-do-wrap words (max maxword width)))
21433 (lines
21434 (setq w maxword)
21435 (setq ll (org-do-wrap words maxword))
21436 (if (<= (length ll) lines)
21438 (setq ll words)
21439 (while (> (length ll) lines)
21440 (setq w (1+ w))
21441 (setq ll (org-do-wrap words w)))
21442 ll))
21443 (t (error "Cannot wrap this")))))
21445 (defun org-do-wrap (words width)
21446 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21447 (let (lines line)
21448 (while words
21449 (setq line (pop words))
21450 (while (and words (< (+ (length line) (length (car words))) width))
21451 (setq line (concat line " " (pop words))))
21452 (setq lines (push line lines)))
21453 (nreverse lines)))
21455 (defun org-split-string (string &optional separators)
21456 "Splits STRING into substrings at SEPARATORS.
21457 No empty strings are returned if there are matches at the beginning
21458 and end of string."
21459 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21460 (start 0)
21461 notfirst
21462 (list nil))
21463 (while (and (string-match rexp string
21464 (if (and notfirst
21465 (= start (match-beginning 0))
21466 (< start (length string)))
21467 (1+ start) start))
21468 (< (match-beginning 0) (length string)))
21469 (setq notfirst t)
21470 (or (eq (match-beginning 0) 0)
21471 (and (eq (match-beginning 0) (match-end 0))
21472 (eq (match-beginning 0) start))
21473 (setq list
21474 (cons (substring string start (match-beginning 0))
21475 list)))
21476 (setq start (match-end 0)))
21477 (or (eq start (length string))
21478 (setq list
21479 (cons (substring string start)
21480 list)))
21481 (nreverse list)))
21483 (defun org-quote-vert (s)
21484 "Replace \"|\" with \"\\vert\"."
21485 (while (string-match "|" s)
21486 (setq s (replace-match "\\vert" t t s)))
21489 (defun org-uuidgen-p (s)
21490 "Is S an ID created by UUIDGEN?"
21491 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21493 (defun org-in-src-block-p (&optional inside)
21494 "Whether point is in a code source block.
21495 When INSIDE is non-nil, don't consider we are within a src block
21496 when point is at #+BEGIN_SRC or #+END_SRC."
21497 (let ((case-fold-search t) ov)
21498 (or (and (setq ov (overlays-at (point)))
21499 (memq 'org-block-background
21500 (overlay-properties (car ov))))
21501 (and (not inside)
21502 (save-match-data
21503 (save-excursion
21504 (beginning-of-line)
21505 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21507 (defun org-context ()
21508 "Return a list of contexts of the current cursor position.
21509 If several contexts apply, all are returned.
21510 Each context entry is a list with a symbol naming the context, and
21511 two positions indicating start and end of the context. Possible
21512 contexts are:
21514 :headline anywhere in a headline
21515 :headline-stars on the leading stars in a headline
21516 :todo-keyword on a TODO keyword (including DONE) in a headline
21517 :tags on the TAGS in a headline
21518 :priority on the priority cookie in a headline
21519 :item on the first line of a plain list item
21520 :item-bullet on the bullet/number of a plain list item
21521 :checkbox on the checkbox in a plain list item
21522 :table in an org-mode table
21523 :table-special on a special filed in a table
21524 :table-table in a table.el table
21525 :clocktable in a clocktable
21526 :src-block in a source block
21527 :link on a hyperlink
21528 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21529 :target on a <<target>>
21530 :radio-target on a <<<radio-target>>>
21531 :latex-fragment on a LaTeX fragment
21532 :latex-preview on a LaTeX fragment with overlaid preview image
21534 This function expects the position to be visible because it uses font-lock
21535 faces as a help to recognize the following contexts: :table-special, :link,
21536 and :keyword."
21537 (let* ((f (get-text-property (point) 'face))
21538 (faces (if (listp f) f (list f)))
21539 (case-fold-search t)
21540 (p (point)) clist o)
21541 ;; First the large context
21542 (cond
21543 ((org-at-heading-p t)
21544 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21545 (when (progn
21546 (beginning-of-line 1)
21547 (looking-at org-todo-line-tags-regexp))
21548 (push (org-point-in-group p 1 :headline-stars) clist)
21549 (push (org-point-in-group p 2 :todo-keyword) clist)
21550 (push (org-point-in-group p 4 :tags) clist))
21551 (goto-char p)
21552 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21553 (if (looking-at "\\[#[A-Z0-9]\\]")
21554 (push (org-point-in-group p 0 :priority) clist)))
21556 ((org-at-item-p)
21557 (push (org-point-in-group p 2 :item-bullet) clist)
21558 (push (list :item (point-at-bol)
21559 (save-excursion (org-end-of-item) (point)))
21560 clist)
21561 (and (org-at-item-checkbox-p)
21562 (push (org-point-in-group p 0 :checkbox) clist)))
21564 ((org-at-table-p)
21565 (push (list :table (org-table-begin) (org-table-end)) clist)
21566 (if (memq 'org-formula faces)
21567 (push (list :table-special
21568 (previous-single-property-change p 'face)
21569 (next-single-property-change p 'face)) clist)))
21570 ((org-at-table-p 'any)
21571 (push (list :table-table) clist)))
21572 (goto-char p)
21574 (let ((case-fold-search t))
21575 ;; New the "medium" contexts: clocktables, source blocks
21576 (cond ((org-in-clocktable-p)
21577 (push (list :clocktable
21578 (and (or (looking-at "#\\+BEGIN: clocktable")
21579 (search-backward "#+BEGIN: clocktable" nil t))
21580 (match-beginning 0))
21581 (and (re-search-forward "#\\+END:?" nil t)
21582 (match-end 0))) clist))
21583 ((org-in-src-block-p)
21584 (push (list :src-block
21585 (and (or (looking-at "#\\+BEGIN_SRC")
21586 (search-backward "#+BEGIN_SRC" nil t))
21587 (match-beginning 0))
21588 (and (search-forward "#+END_SRC" nil t)
21589 (match-beginning 0))) clist))))
21590 (goto-char p)
21592 ;; Now the small context
21593 (cond
21594 ((org-at-timestamp-p)
21595 (push (org-point-in-group p 0 :timestamp) clist))
21596 ((memq 'org-link faces)
21597 (push (list :link
21598 (previous-single-property-change p 'face)
21599 (next-single-property-change p 'face)) clist))
21600 ((memq 'org-special-keyword faces)
21601 (push (list :keyword
21602 (previous-single-property-change p 'face)
21603 (next-single-property-change p 'face)) clist))
21604 ((org-at-target-p)
21605 (push (org-point-in-group p 0 :target) clist)
21606 (goto-char (1- (match-beginning 0)))
21607 (if (looking-at org-radio-target-regexp)
21608 (push (org-point-in-group p 0 :radio-target) clist))
21609 (goto-char p))
21610 ((setq o (car (delq nil
21611 (mapcar
21612 (lambda (x)
21613 (if (memq x org-latex-fragment-image-overlays) x))
21614 (overlays-at (point))))))
21615 (push (list :latex-fragment
21616 (overlay-start o) (overlay-end o)) clist)
21617 (push (list :latex-preview
21618 (overlay-start o) (overlay-end o)) clist))
21619 ((org-inside-LaTeX-fragment-p)
21620 ;; FIXME: positions wrong.
21621 (push (list :latex-fragment (point) (point)) clist)))
21623 (setq clist (nreverse (delq nil clist)))
21624 clist))
21626 ;; FIXME: Compare with at-regexp-p Do we need both?
21627 (defun org-in-regexp (re &optional nlines visually)
21628 "Check if point is inside a match of regexp.
21629 Normally only the current line is checked, but you can include NLINES extra
21630 lines both before and after point into the search.
21631 If VISUALLY is set, require that the cursor is not after the match but
21632 really on, so that the block visually is on the match."
21633 (catch 'exit
21634 (let ((pos (point))
21635 (eol (point-at-eol (+ 1 (or nlines 0))))
21636 (inc (if visually 1 0)))
21637 (save-excursion
21638 (beginning-of-line (- 1 (or nlines 0)))
21639 (while (re-search-forward re eol t)
21640 (if (and (<= (match-beginning 0) pos)
21641 (>= (+ inc (match-end 0)) pos))
21642 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21644 (defun org-at-regexp-p (regexp)
21645 "Is point inside a match of REGEXP in the current line?"
21646 (catch 'exit
21647 (save-excursion
21648 (let ((pos (point)) (end (point-at-eol)))
21649 (beginning-of-line 1)
21650 (while (re-search-forward regexp end t)
21651 (if (and (<= (match-beginning 0) pos)
21652 (>= (match-end 0) pos))
21653 (throw 'exit t)))
21654 nil))))
21656 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21657 "Non-nil when point is between matches of START-RE and END-RE.
21659 Also return a non-nil value when point is on one of the matches.
21661 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21662 buffer positions. Default values are the positions of headlines
21663 surrounding the point.
21665 The functions returns a cons cell whose car (resp. cdr) is the
21666 position before START-RE (resp. after END-RE)."
21667 (save-match-data
21668 (let ((pos (point))
21669 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21670 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21671 beg end)
21672 (save-excursion
21673 ;; Point is on a block when on START-RE or if START-RE can be
21674 ;; found before it...
21675 (and (or (org-at-regexp-p start-re)
21676 (re-search-backward start-re limit-up t))
21677 (setq beg (match-beginning 0))
21678 ;; ... and END-RE after it...
21679 (goto-char (match-end 0))
21680 (re-search-forward end-re limit-down t)
21681 (> (setq end (match-end 0)) pos)
21682 ;; ... without another START-RE in-between.
21683 (goto-char (match-beginning 0))
21684 (not (re-search-backward start-re (1+ beg) t))
21685 ;; Return value.
21686 (cons beg end))))))
21688 (defun org-in-block-p (names)
21689 "Non-nil when point belongs to a block whose name belongs to NAMES.
21691 NAMES is a list of strings containing names of blocks.
21693 Return first block name matched, or nil. Beware that in case of
21694 nested blocks, the returned name may not belong to the closest
21695 block from point."
21696 (save-match-data
21697 (catch 'exit
21698 (let ((case-fold-search t)
21699 (lim-up (save-excursion (outline-previous-heading)))
21700 (lim-down (save-excursion (outline-next-heading))))
21701 (mapc (lambda (name)
21702 (let ((n (regexp-quote name)))
21703 (when (org-between-regexps-p
21704 (concat "^[ \t]*#\\+begin_" n)
21705 (concat "^[ \t]*#\\+end_" n)
21706 lim-up lim-down)
21707 (throw 'exit n))))
21708 names))
21709 nil)))
21711 (defun org-in-drawer-p ()
21712 "Is point within a drawer?"
21713 (save-match-data
21714 (let ((case-fold-search t)
21715 (lim-up (save-excursion (outline-previous-heading)))
21716 (lim-down (save-excursion (outline-next-heading))))
21717 (org-between-regexps-p
21718 (concat "^[ \t]*:" (regexp-opt org-drawers) ":")
21719 "^[ \t]*:end:.*$"
21720 lim-up lim-down))))
21722 (defun org-occur-in-agenda-files (regexp &optional nlines)
21723 "Call `multi-occur' with buffers for all agenda files."
21724 (interactive "sOrg-files matching: \np")
21725 (let* ((files (org-agenda-files))
21726 (tnames (mapcar 'file-truename files))
21727 (extra org-agenda-text-search-extra-files)
21729 (when (eq (car extra) 'agenda-archives)
21730 (setq extra (cdr extra))
21731 (setq files (org-add-archive-files files)))
21732 (while (setq f (pop extra))
21733 (unless (member (file-truename f) tnames)
21734 (add-to-list 'files f 'append)
21735 (add-to-list 'tnames (file-truename f) 'append)))
21736 (multi-occur
21737 (mapcar (lambda (x)
21738 (with-current-buffer
21739 (or (get-file-buffer x) (find-file-noselect x))
21740 (widen)
21741 (current-buffer)))
21742 files)
21743 regexp)))
21745 (if (boundp 'occur-mode-find-occurrence-hook)
21746 ;; Emacs 23
21747 (add-hook 'occur-mode-find-occurrence-hook
21748 (lambda ()
21749 (when (derived-mode-p 'org-mode)
21750 (org-reveal))))
21751 ;; Emacs 22
21752 (defadvice occur-mode-goto-occurrence
21753 (after org-occur-reveal activate)
21754 (and (derived-mode-p 'org-mode) (org-reveal)))
21755 (defadvice occur-mode-goto-occurrence-other-window
21756 (after org-occur-reveal activate)
21757 (and (derived-mode-p 'org-mode) (org-reveal)))
21758 (defadvice occur-mode-display-occurrence
21759 (after org-occur-reveal activate)
21760 (when (derived-mode-p 'org-mode)
21761 (let ((pos (occur-mode-find-occurrence)))
21762 (with-current-buffer (marker-buffer pos)
21763 (save-excursion
21764 (goto-char pos)
21765 (org-reveal)))))))
21767 (defun org-occur-link-in-agenda-files ()
21768 "Create a link and search for it in the agendas.
21769 The link is not stored in `org-stored-links', it is just created
21770 for the search purpose."
21771 (interactive)
21772 (let ((link (condition-case nil
21773 (org-store-link nil)
21774 (error "Unable to create a link to here"))))
21775 (org-occur-in-agenda-files (regexp-quote link))))
21777 (defun org-reverse-string (string)
21778 "Return the reverse of STRING."
21779 (apply 'string (reverse (string-to-list string))))
21781 (defsubst org-uniquify (list)
21782 "Non-destructively remove duplicate elements from LIST."
21783 (let ((res (copy-sequence list))) (delete-dups res)))
21785 (defun org-uniquify-alist (alist)
21786 "Merge elements of ALIST with the same key.
21788 For example, in this alist:
21790 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21791 => '((a 1 3) (b 2))
21793 merge (a 1) and (a 3) into (a 1 3).
21795 The function returns the new ALIST."
21796 (let (rtn)
21797 (mapc
21798 (lambda (e)
21799 (let (n)
21800 (if (not (assoc (car e) rtn))
21801 (push e rtn)
21802 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21803 (setq rtn (assq-delete-all (car e) rtn))
21804 (push n rtn))))
21805 alist)
21806 rtn))
21808 (defun org-delete-all (elts list)
21809 "Remove all elements in ELTS from LIST."
21810 (while elts
21811 (setq list (delete (pop elts) list)))
21812 list)
21814 (defun org-count (cl-item cl-seq)
21815 "Count the number of occurrences of ITEM in SEQ.
21816 Taken from `count' in cl-seq.el with all keyword arguments removed."
21817 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21818 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21819 (while (< cl-start cl-end)
21820 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21821 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21822 (setq cl-start (1+ cl-start)))
21823 cl-count))
21825 (defun org-remove-if (predicate seq)
21826 "Remove everything from SEQ that fulfills PREDICATE."
21827 (let (res e)
21828 (while seq
21829 (setq e (pop seq))
21830 (if (not (funcall predicate e)) (push e res)))
21831 (nreverse res)))
21833 (defun org-remove-if-not (predicate seq)
21834 "Remove everything from SEQ that does not fulfill PREDICATE."
21835 (let (res e)
21836 (while seq
21837 (setq e (pop seq))
21838 (if (funcall predicate e) (push e res)))
21839 (nreverse res)))
21841 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21842 "Reduce two-argument FUNCTION across SEQ.
21843 Taken from `reduce' in cl-seq.el with all keyword arguments but
21844 \":initial-value\" removed."
21845 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21846 (cadr (memq :initial-value cl-keys)))
21847 (cl-seq (pop cl-seq))
21848 (t (funcall cl-func)))))
21849 (while cl-seq
21850 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21851 cl-accum))
21853 (defun org-every (pred seq)
21854 "Return true if PREDICATE is true of every element of SEQ.
21855 Adapted from `every' in cl.el."
21856 (catch 'org-every
21857 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21860 (defun org-some (pred seq)
21861 "Return true if PREDICATE is true of any element of SEQ.
21862 Adapted from `some' in cl.el."
21863 (catch 'org-some
21864 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21865 nil))
21867 (defun org-back-over-empty-lines ()
21868 "Move backwards over whitespace, to the beginning of the first empty line.
21869 Returns the number of empty lines passed."
21870 (let ((pos (point)))
21871 (if (cdr (assoc 'heading org-blank-before-new-entry))
21872 (skip-chars-backward " \t\n\r")
21873 (unless (eobp)
21874 (forward-line -1)))
21875 (beginning-of-line 2)
21876 (goto-char (min (point) pos))
21877 (count-lines (point) pos)))
21879 (defun org-skip-whitespace ()
21880 (skip-chars-forward " \t\n\r"))
21882 (defun org-point-in-group (point group &optional context)
21883 "Check if POINT is in match-group GROUP.
21884 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21885 match. If the match group does not exist or point is not inside it,
21886 return nil."
21887 (and (match-beginning group)
21888 (>= point (match-beginning group))
21889 (<= point (match-end group))
21890 (if context
21891 (list context (match-beginning group) (match-end group))
21892 t)))
21894 (defun org-switch-to-buffer-other-window (&rest args)
21895 "Switch to buffer in a second window on the current frame.
21896 In particular, do not allow pop-up frames.
21897 Returns the newly created buffer."
21898 (org-no-popups
21899 (apply 'switch-to-buffer-other-window args)))
21901 (defun org-combine-plists (&rest plists)
21902 "Create a single property list from all plists in PLISTS.
21903 The process starts by copying the first list, and then setting properties
21904 from the other lists. Settings in the last list are the most significant
21905 ones and overrule settings in the other lists."
21906 (let ((rtn (copy-sequence (pop plists)))
21907 p v ls)
21908 (while plists
21909 (setq ls (pop plists))
21910 (while ls
21911 (setq p (pop ls) v (pop ls))
21912 (setq rtn (plist-put rtn p v))))
21913 rtn))
21915 (defun org-replace-escapes (string table)
21916 "Replace %-escapes in STRING with values in TABLE.
21917 TABLE is an association list with keys like \"%a\" and string values.
21918 The sequences in STRING may contain normal field width and padding information,
21919 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
21920 so values can contain further %-escapes if they are define later in TABLE."
21921 (let ((tbl (copy-alist table))
21922 (case-fold-search nil)
21923 (pchg 0)
21924 e re rpl)
21925 (while (setq e (pop tbl))
21926 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21927 (when (and (cdr e) (string-match re (cdr e)))
21928 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21929 (safe "SREF"))
21930 (add-text-properties 0 3 (list 'sref sref) safe)
21931 (setcdr e (replace-match safe t t (cdr e)))))
21932 (while (string-match re string)
21933 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21934 (cdr e)))
21935 (setq string (replace-match rpl t t string))))
21936 (while (setq pchg (next-property-change pchg string))
21937 (let ((sref (get-text-property pchg 'sref string)))
21938 (when (and sref (string-match "SREF" string pchg))
21939 (setq string (replace-match sref t t string)))))
21940 string))
21942 (defun org-sublist (list start end)
21943 "Return a section of LIST, from START to END.
21944 Counting starts at 1."
21945 (let (rtn (c start))
21946 (setq list (nthcdr (1- start) list))
21947 (while (and list (<= c end))
21948 (push (pop list) rtn)
21949 (setq c (1+ c)))
21950 (nreverse rtn)))
21952 (defun org-find-base-buffer-visiting (file)
21953 "Like `find-buffer-visiting' but always return the base buffer and
21954 not an indirect buffer."
21955 (let ((buf (or (get-file-buffer file)
21956 (find-buffer-visiting file))))
21957 (if buf
21958 (or (buffer-base-buffer buf) buf)
21959 nil)))
21961 (defun org-image-file-name-regexp (&optional extensions)
21962 "Return regexp matching the file names of images.
21963 If EXTENSIONS is given, only match these."
21964 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21965 (image-file-name-regexp)
21966 (let ((image-file-name-extensions
21967 (or extensions
21968 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21969 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21970 (concat "\\."
21971 (regexp-opt (nconc (mapcar 'upcase
21972 image-file-name-extensions)
21973 image-file-name-extensions)
21975 "\\'"))))
21977 (defun org-file-image-p (file &optional extensions)
21978 "Return non-nil if FILE is an image."
21979 (save-match-data
21980 (string-match (org-image-file-name-regexp extensions) file)))
21982 (defun org-get-cursor-date (&optional with-time)
21983 "Return the date at cursor in as a time.
21984 This works in the calendar and in the agenda, anywhere else it just
21985 returns the current time.
21986 If WITH-TIME is non-nil, returns the time of the event at point (in
21987 the agenda) or the current time of the day."
21988 (let (date day defd tp tm hod mod)
21989 (when with-time
21990 (setq tp (get-text-property (point) 'time))
21991 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
21992 (setq hod (string-to-number (match-string 1 tp))
21993 mod (string-to-number (match-string 2 tp))))
21994 (or tp (setq hod (nth 2 (decode-time (current-time)))
21995 mod (nth 1 (decode-time (current-time))))))
21996 (cond
21997 ((eq major-mode 'calendar-mode)
21998 (setq date (calendar-cursor-to-date)
21999 defd (encode-time 0 (or mod 0) (or hod 0)
22000 (nth 1 date) (nth 0 date) (nth 2 date))))
22001 ((eq major-mode 'org-agenda-mode)
22002 (setq day (get-text-property (point) 'day))
22003 (if day
22004 (setq date (calendar-gregorian-from-absolute day)
22005 defd (encode-time 0 (or mod 0) (or hod 0)
22006 (nth 1 date) (nth 0 date) (nth 2 date))))))
22007 (or defd (current-time))))
22009 (defun org-mark-subtree (&optional up)
22010 "Mark the current subtree.
22011 This puts point at the start of the current subtree, and mark at
22012 the end. If a numeric prefix UP is given, move up into the
22013 hierarchy of headlines by UP levels before marking the subtree."
22014 (interactive "P")
22015 (org-with-limited-levels
22016 (cond ((org-at-heading-p) (beginning-of-line))
22017 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22018 (t (outline-previous-visible-heading 1))))
22019 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22020 (if (org-called-interactively-p 'any)
22021 (call-interactively 'org-mark-element)
22022 (org-mark-element)))
22025 ;;; Indentation
22027 (defun org-indent-line ()
22028 "Indent line depending on context."
22029 (interactive)
22030 (let* ((pos (point))
22031 (itemp (org-at-item-p))
22032 (case-fold-search t)
22033 (org-drawer-regexp (or org-drawer-regexp "\000"))
22034 (inline-task-p (and (featurep 'org-inlinetask)
22035 (org-inlinetask-in-task-p)))
22036 (inline-re (and inline-task-p
22037 (org-inlinetask-outline-regexp)))
22038 column)
22039 (if (and orgstruct-is-++ (eq pos (point)))
22040 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22041 (indent-according-to-mode))
22042 (beginning-of-line 1)
22043 (cond
22044 ;; Headings
22045 ((looking-at org-outline-regexp) (setq column 0))
22046 ;; Footnote definition
22047 ((looking-at org-footnote-definition-re) (setq column 0))
22048 ;; Literal examples
22049 ((looking-at "[ \t]*:\\( \\|$\\)")
22050 (setq column (org-get-indentation))) ; do nothing
22051 ;; Lists
22052 ((ignore-errors (goto-char (org-in-item-p)))
22053 (setq column (if itemp
22054 (org-get-indentation)
22055 (org-list-item-body-column (point))))
22056 (goto-char pos))
22057 ;; Drawers
22058 ((and (looking-at "[ \t]*:END:")
22059 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22060 (save-excursion
22061 (goto-char (1- (match-beginning 1)))
22062 (setq column (current-column))))
22063 ;; Special blocks
22064 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
22065 (save-excursion
22066 (re-search-backward
22067 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
22068 (setq column (org-get-indentation (match-string 0))))
22069 ((and (not (looking-at "[ \t]*#\\+begin_"))
22070 (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
22071 (save-excursion
22072 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
22073 (setq column
22074 (cond ((equal (downcase (match-string 1)) "src")
22075 ;; src blocks: let `org-edit-src-exit' handle them
22076 (org-get-indentation))
22077 ((equal (downcase (match-string 1)) "example")
22078 (max (org-get-indentation)
22079 (org-get-indentation (match-string 0))))
22081 (org-get-indentation (match-string 0))))))
22082 ;; This line has nothing special, look at the previous relevant
22083 ;; line to compute indentation
22085 (beginning-of-line 0)
22086 (while (and (not (bobp))
22087 (not (looking-at org-table-line-regexp))
22088 (not (looking-at org-drawer-regexp))
22089 ;; When point started in an inline task, do not move
22090 ;; above task starting line.
22091 (not (and inline-task-p (looking-at inline-re)))
22092 ;; Skip drawers, blocks, empty lines, verbatim,
22093 ;; comments, tables, footnotes definitions, lists,
22094 ;; inline tasks.
22095 (or (and (looking-at "[ \t]*:END:")
22096 (re-search-backward org-drawer-regexp nil t))
22097 (and (looking-at "[ \t]*#\\+end_")
22098 (re-search-backward "[ \t]*#\\+begin_"nil t))
22099 (looking-at "[ \t]*[\n:#|]")
22100 (looking-at org-footnote-definition-re)
22101 (and (not inline-task-p)
22102 (featurep 'org-inlinetask)
22103 (org-inlinetask-in-task-p)
22104 (or (org-inlinetask-goto-beginning) t))))
22105 (beginning-of-line 0))
22106 (cond
22107 ;; There was a list item above.
22108 ((ignore-errors (goto-char (org-in-item-p)))
22109 (goto-char (org-list-get-top-point (org-list-struct)))
22110 (setq column (org-get-indentation)))
22111 ;; There was an heading above.
22112 ((looking-at "\\*+[ \t]+")
22113 (if (not org-adapt-indentation)
22114 (setq column 0)
22115 (goto-char (match-end 0))
22116 (setq column (current-column))))
22117 ;; A drawer had started and is unfinished
22118 ((looking-at org-drawer-regexp)
22119 (goto-char (1- (match-beginning 1)))
22120 (setq column (current-column)))
22121 ;; Else, nothing noticeable found: get indentation and go on.
22122 (t (setq column (org-get-indentation))))))
22123 ;; Now apply indentation and move cursor accordingly
22124 (goto-char pos)
22125 (if (<= (current-column) (current-indentation))
22126 (org-indent-line-to column)
22127 (save-excursion (org-indent-line-to column)))
22128 ;; Special polishing for properties, see `org-property-format'
22129 (setq column (current-column))
22130 (beginning-of-line 1)
22131 (if (looking-at org-property-re)
22132 (replace-match (concat (match-string 4)
22133 (format org-property-format
22134 (match-string 1) (match-string 3)))
22135 t t))
22136 (org-move-to-column column))))
22138 (defun org-indent-drawer ()
22139 "Indent the drawer at point."
22140 (interactive)
22141 (let ((p (point))
22142 (e (and (save-excursion (re-search-forward ":END:" nil t))
22143 (match-end 0)))
22144 (folded
22145 (save-excursion
22146 (end-of-line)
22147 (when (overlays-at (point))
22148 (member 'invisible (overlay-properties
22149 (car (overlays-at (point)))))))))
22150 (when folded (org-cycle))
22151 (indent-for-tab-command)
22152 (while (and (move-beginning-of-line 2) (< (point) e))
22153 (indent-for-tab-command))
22154 (goto-char p)
22155 (when folded (org-cycle)))
22156 (message "Drawer at point indented"))
22158 (defun org-indent-block ()
22159 "Indent the block at point."
22160 (interactive)
22161 (let ((p (point))
22162 (case-fold-search t)
22163 (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
22164 (match-end 0)))
22165 (folded
22166 (save-excursion
22167 (end-of-line)
22168 (when (overlays-at (point))
22169 (member 'invisible (overlay-properties
22170 (car (overlays-at (point)))))))))
22171 (when folded (org-cycle))
22172 (indent-for-tab-command)
22173 (while (and (move-beginning-of-line 2) (< (point) e))
22174 (indent-for-tab-command))
22175 (goto-char p)
22176 (when folded (org-cycle)))
22177 (message "Block at point indented"))
22179 (defun org-indent-region (start end)
22180 "Indent region."
22181 (interactive "r")
22182 (save-excursion
22183 (let ((line-end (org-current-line end)))
22184 (goto-char start)
22185 (while (< (org-current-line) line-end)
22186 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22187 (t (call-interactively 'org-indent-line)))
22188 (move-beginning-of-line 2)))))
22191 ;;; Filling
22193 ;; We use our own fill-paragraph and auto-fill functions.
22195 ;; `org-fill-paragraph' relies on adaptive filling and context
22196 ;; checking. Appropriate `fill-prefix' is computed with
22197 ;; `org-adaptive-fill-function'.
22199 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22200 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22201 ;; `org-adaptive-fill-function' value. Internally,
22202 ;; `org-comment-line-break-function' breaks the line.
22204 ;; `org-setup-filling' installs filling and auto-filling related
22205 ;; variables during `org-mode' initialization.
22207 (defvar org-element-paragraph-separate) ; org-element.el
22208 (defun org-setup-filling ()
22209 (require 'org-element)
22210 ;; Prevent auto-fill from inserting unwanted new items.
22211 (when (boundp 'fill-nobreak-predicate)
22212 (org-set-local
22213 'fill-nobreak-predicate
22214 (org-uniquify
22215 (append fill-nobreak-predicate
22216 '(org-fill-line-break-nobreak-p
22217 org-fill-paragraph-with-timestamp-nobreak-p)))))
22218 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22219 (org-set-local 'paragraph-start paragraph-ending)
22220 (org-set-local 'paragraph-separate paragraph-ending))
22221 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22222 (org-set-local 'auto-fill-inhibit-regexp nil)
22223 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22224 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22225 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22227 (defun org-fill-line-break-nobreak-p ()
22228 "Non-nil when a new line at point would create an Org line break."
22229 (save-excursion
22230 (skip-chars-backward "[ \t]")
22231 (skip-chars-backward "\\\\")
22232 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22234 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22235 "Non-nil when a new line at point would split a timestamp."
22236 (and (org-at-timestamp-p t)
22237 (not (looking-at org-ts-regexp-both))))
22239 (declare-function message-in-body-p "message" ())
22240 (defvar orgtbl-line-start-regexp) ; From org-table.el
22241 (defun org-adaptive-fill-function ()
22242 "Compute a fill prefix for the current line.
22243 Return fill prefix, as a string, or nil if current line isn't
22244 meant to be filled. For convenience, if `adaptive-fill-regexp'
22245 matches in paragraphs or comments, use it."
22246 (catch 'exit
22247 (when (derived-mode-p 'message-mode)
22248 (save-excursion
22249 (beginning-of-line)
22250 (cond ((or (not (message-in-body-p))
22251 (looking-at orgtbl-line-start-regexp))
22252 (throw 'exit nil))
22253 ((looking-at message-cite-prefix-regexp)
22254 (throw 'exit (match-string-no-properties 0)))
22255 ((looking-at org-outline-regexp)
22256 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22257 (org-with-wide-buffer
22258 (let* ((p (line-beginning-position))
22259 (element (save-excursion
22260 (beginning-of-line)
22261 (or (ignore-errors (org-element-at-point))
22262 (user-error "An element cannot be parsed line %d"
22263 (line-number-at-pos (point))))))
22264 (type (org-element-type element))
22265 (post-affiliated (org-element-property :post-affiliated element)))
22266 (unless (and post-affiliated (< p post-affiliated))
22267 (case type
22268 (comment
22269 (save-excursion
22270 (beginning-of-line)
22271 (looking-at "[ \t]*")
22272 (concat (match-string 0) "# ")))
22273 (footnote-definition "")
22274 ((item plain-list)
22275 (make-string (org-list-item-body-column
22276 (or post-affiliated
22277 (org-element-property :begin element)))
22278 ? ))
22279 (paragraph
22280 ;; Fill prefix is usually the same as the current line,
22281 ;; unless the paragraph is at the beginning of an item.
22282 (let ((parent (org-element-property :parent element)))
22283 (save-excursion
22284 (beginning-of-line)
22285 (cond ((eq (org-element-type parent) 'item)
22286 (make-string (org-list-item-body-column
22287 (org-element-property :begin parent))
22288 ? ))
22289 ((and adaptive-fill-regexp
22290 ;; Locally disable
22291 ;; `adaptive-fill-function' to let
22292 ;; `fill-context-prefix' handle
22293 ;; `adaptive-fill-regexp' variable.
22294 (let (adaptive-fill-function)
22295 (fill-context-prefix
22296 post-affiliated
22297 (org-element-property :end element)))))
22298 ((looking-at "[ \t]+") (match-string 0))
22299 (t "")))))
22300 (comment-block
22301 ;; Only fill contents if P is within block boundaries.
22302 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22303 (forward-line)
22304 (point)))
22305 (cend (save-excursion
22306 (goto-char (org-element-property :end element))
22307 (skip-chars-backward " \r\t\n")
22308 (line-beginning-position))))
22309 (when (and (>= p cbeg) (< p cend))
22310 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22311 (match-string 0)
22312 ""))))))))))
22314 (declare-function message-goto-body "message" ())
22315 (defvar message-cite-prefix-regexp) ; From message.el
22316 (defun org-fill-paragraph (&optional justify)
22317 "Fill element at point, when applicable.
22319 This function only applies to comment blocks, comments, example
22320 blocks and paragraphs. Also, as a special case, re-align table
22321 when point is at one.
22323 If JUSTIFY is non-nil (interactively, with prefix argument),
22324 justify as well. If `sentence-end-double-space' is non-nil, then
22325 period followed by one space does not end a sentence, so don't
22326 break a line there. The variable `fill-column' controls the
22327 width for filling.
22329 For convenience, when point is at a plain list, an item or
22330 a footnote definition, try to fill the first paragraph within."
22331 (interactive)
22332 (if (and (derived-mode-p 'message-mode)
22333 (or (not (message-in-body-p))
22334 (save-excursion (move-beginning-of-line 1)
22335 (looking-at message-cite-prefix-regexp))))
22336 ;; First ensure filling is correct in message-mode.
22337 (let ((fill-paragraph-function
22338 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22339 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22340 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22341 (paragraph-separate
22342 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22343 (fill-paragraph nil))
22344 (with-syntax-table org-mode-transpose-word-syntax-table
22345 ;; Move to end of line in order to get the first paragraph
22346 ;; within a plain list or a footnote definition.
22347 (let ((element (save-excursion
22348 (end-of-line)
22349 (or (ignore-errors (org-element-at-point))
22350 (user-error "An element cannot be parsed line %d"
22351 (line-number-at-pos (point)))))))
22352 ;; First check if point is in a blank line at the beginning of
22353 ;; the buffer. In that case, ignore filling.
22354 (case (org-element-type element)
22355 ;; Use major mode filling function is src blocks.
22356 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22357 ;; Align Org tables, leave table.el tables as-is.
22358 (table-row (org-table-align) t)
22359 (table
22360 (when (eq (org-element-property :type element) 'org)
22361 (save-excursion
22362 (goto-char (org-element-property :post-affiliated element))
22363 (org-table-align)))
22365 (paragraph
22366 ;; Paragraphs may contain `line-break' type objects.
22367 (let ((beg (max (point-min)
22368 (org-element-property :contents-begin element)))
22369 (end (min (point-max)
22370 (org-element-property :contents-end element))))
22371 ;; Do nothing if point is at an affiliated keyword.
22372 (if (< (line-end-position) beg) t
22373 (when (derived-mode-p 'message-mode)
22374 ;; In `message-mode', do not fill following citation
22375 ;; in current paragraph nor text before message body.
22376 (let ((body-start (save-excursion (message-goto-body))))
22377 (when body-start (setq beg (max body-start beg))))
22378 (when (save-excursion
22379 (re-search-forward
22380 (concat "^" message-cite-prefix-regexp) end t))
22381 (setq end (match-beginning 0))))
22382 ;; Fill paragraph, taking line breaks into account.
22383 ;; For that, slice the paragraph using line breaks as
22384 ;; separators, and fill the parts in reverse order to
22385 ;; avoid messing with markers.
22386 (save-excursion
22387 (goto-char end)
22388 (mapc
22389 (lambda (pos)
22390 (fill-region-as-paragraph pos (point) justify)
22391 (goto-char pos))
22392 ;; Find the list of ending positions for line breaks
22393 ;; in the current paragraph. Add paragraph
22394 ;; beginning to include first slice.
22395 (nreverse
22396 (cons beg
22397 (org-element-map
22398 (org-element--parse-objects
22399 beg end nil (org-element-restriction 'paragraph))
22400 'line-break
22401 (lambda (lb) (org-element-property :end lb)))))))
22402 t)))
22403 ;; Contents of `comment-block' type elements should be
22404 ;; filled as plain text, but only if point is within block
22405 ;; markers.
22406 (comment-block
22407 (let* ((case-fold-search t)
22408 (beg (save-excursion
22409 (goto-char (org-element-property :begin element))
22410 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22411 (forward-line)
22412 (point)))
22413 (end (save-excursion
22414 (goto-char (org-element-property :end element))
22415 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22416 (line-beginning-position))))
22417 (if (or (< (point) beg) (> (point) end)) t
22418 (fill-region-as-paragraph
22419 (save-excursion (end-of-line)
22420 (re-search-backward "^[ \t]*$" beg 'move)
22421 (line-beginning-position))
22422 (save-excursion (beginning-of-line)
22423 (re-search-forward "^[ \t]*$" end 'move)
22424 (line-beginning-position))
22425 justify))))
22426 ;; Fill comments.
22427 (comment
22428 (let ((begin (org-element-property :post-affiliated element))
22429 (end (org-element-property :end element)))
22430 (when (and (>= (point) begin) (<= (point) end))
22431 (let ((begin (save-excursion
22432 (end-of-line)
22433 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22434 (progn (forward-line) (point))
22435 begin)))
22436 (end (save-excursion
22437 (end-of-line)
22438 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22439 (1- (line-beginning-position))
22440 (skip-chars-backward " \r\t\n")
22441 (line-end-position)))))
22442 ;; Do not fill comments when at a blank line.
22443 (when (> end begin)
22444 (let ((fill-prefix
22445 (save-excursion
22446 (beginning-of-line)
22447 (looking-at "[ \t]*#")
22448 (let ((comment-prefix (match-string 0)))
22449 (goto-char (match-end 0))
22450 (if (looking-at adaptive-fill-regexp)
22451 (concat comment-prefix (match-string 0))
22452 (concat comment-prefix " "))))))
22453 (save-excursion
22454 (fill-region-as-paragraph begin end justify))))))
22456 ;; Ignore every other element.
22457 (otherwise t))))))
22459 (defun org-auto-fill-function ()
22460 "Auto-fill function."
22461 ;; Check if auto-filling is meaningful.
22462 (let ((fc (current-fill-column)))
22463 (when (and fc (> (current-column) fc))
22464 (let* ((fill-prefix (org-adaptive-fill-function))
22465 ;; Enforce empty fill prefix, if required. Otherwise, it
22466 ;; will be computed again.
22467 (adaptive-fill-mode (not (equal fill-prefix ""))))
22468 (when fill-prefix (do-auto-fill))))))
22470 (defun org-comment-line-break-function (&optional soft)
22471 "Break line at point and indent, continuing comment if within one.
22472 The inserted newline is marked hard if variable
22473 `use-hard-newlines' is true, unless optional argument SOFT is
22474 non-nil."
22475 (if soft (insert-and-inherit ?\n) (newline 1))
22476 (save-excursion (forward-char -1) (delete-horizontal-space))
22477 (delete-horizontal-space)
22478 (indent-to-left-margin)
22479 (insert-before-markers-and-inherit fill-prefix))
22482 ;;; Comments
22484 ;; Org comments syntax is quite complex. It requires the entire line
22485 ;; to be just a comment. Also, even with the right syntax at the
22486 ;; beginning of line, some some elements (i.e. verse-block or
22487 ;; example-block) don't accept comments. Usual Emacs comment commands
22488 ;; cannot cope with those requirements. Therefore, Org replaces them.
22490 ;; Org still relies on `comment-dwim', but cannot trust
22491 ;; `comment-only-p'. So, `comment-region-function' and
22492 ;; `uncomment-region-function' both point
22493 ;; to`org-comment-or-uncomment-region'. Eventually,
22494 ;; `org-insert-comment' takes care of insertion of comments at the
22495 ;; beginning of line.
22497 ;; `org-setup-comments-handling' install comments related variables
22498 ;; during `org-mode' initialization.
22500 (defun org-setup-comments-handling ()
22501 (interactive)
22502 (org-set-local 'comment-use-syntax nil)
22503 (org-set-local 'comment-start "# ")
22504 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
22505 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22506 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22507 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22509 (defun org-insert-comment ()
22510 "Insert an empty comment above current line.
22511 If the line is empty, insert comment at its beginning."
22512 (beginning-of-line)
22513 (if (looking-at "\\s-*$") (replace-match "") (open-line 1))
22514 (org-indent-line)
22515 (insert "# "))
22517 (defvar comment-empty-lines) ; From newcomment.el.
22518 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22519 "Comment or uncomment each non-blank line in the region.
22520 Uncomment each non-blank line between BEG and END if it only
22521 contains commented lines. Otherwise, comment them."
22522 (save-restriction
22523 ;; Restrict region
22524 (narrow-to-region (save-excursion (goto-char beg)
22525 (skip-chars-forward " \r\t\n" end)
22526 (line-beginning-position))
22527 (save-excursion (goto-char end)
22528 (skip-chars-backward " \r\t\n" beg)
22529 (line-end-position)))
22530 (let ((uncommentp
22531 ;; UNCOMMENTP is non-nil when every non blank line between
22532 ;; BEG and END is a comment.
22533 (save-excursion
22534 (goto-char (point-min))
22535 (while (and (not (eobp))
22536 (let ((element (org-element-at-point)))
22537 (and (eq (org-element-type element) 'comment)
22538 (goto-char (min (point-max)
22539 (org-element-property
22540 :end element)))))))
22541 (eobp))))
22542 (if uncommentp
22543 ;; Only blank lines and comments in region: uncomment it.
22544 (save-excursion
22545 (goto-char (point-min))
22546 (while (not (eobp))
22547 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
22548 (replace-match "" nil nil nil 1))
22549 (forward-line)))
22550 ;; Comment each line in region.
22551 (let ((min-indent (point-max)))
22552 ;; First find the minimum indentation across all lines.
22553 (save-excursion
22554 (goto-char (point-min))
22555 (while (and (not (eobp)) (not (zerop min-indent)))
22556 (unless (looking-at "[ \t]*$")
22557 (setq min-indent (min min-indent (current-indentation))))
22558 (forward-line)))
22559 ;; Then loop over all lines.
22560 (save-excursion
22561 (goto-char (point-min))
22562 (while (not (eobp))
22563 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
22564 ;; Don't get fooled by invisible text (e.g. link path)
22565 ;; when moving to column MIN-INDENT.
22566 (let ((buffer-invisibility-spec nil))
22567 (org-move-to-column min-indent t))
22568 (insert comment-start))
22569 (forward-line))))))))
22572 ;;; Planning
22574 ;; This section contains tools to operate on timestamp objects, as
22575 ;; returned by, e.g. `org-element-context'.
22577 (defun org-timestamp-has-time-p (timestamp)
22578 "Non-nil when TIMESTAMP has a time specified."
22579 (org-element-property :hour-start timestamp))
22581 (defun org-timestamp-format (timestamp format &optional end utc)
22582 "Format a TIMESTAMP element into a string.
22584 FORMAT is a format specifier to be passed to
22585 `format-time-string'.
22587 When optional argument END is non-nil, use end of date-range or
22588 time-range, if possible.
22590 When optional argument UTC is non-nil, time will be expressed as
22591 Universal Time."
22592 (format-time-string
22593 format
22594 (apply 'encode-time
22595 (cons 0
22596 (mapcar
22597 (lambda (prop) (or (org-element-property prop timestamp) 0))
22598 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22599 '(:minute-start :hour-start :day-start :month-start
22600 :year-start)))))
22601 utc))
22603 (defun org-timestamp-split-range (timestamp &optional end)
22604 "Extract a timestamp object from a date or time range.
22606 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22607 the end of the range. Otherwise, extract its start.
22609 Return a new timestamp object sharing the same parent as
22610 TIMESTAMP."
22611 (let ((type (org-element-property :type timestamp)))
22612 (if (memq type '(active inactive diary)) timestamp
22613 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22614 ;; Set new type.
22615 (org-element-put-property
22616 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22617 ;; Copy start properties over end properties if END is
22618 ;; non-nil. Otherwise, copy end properties over `start' ones.
22619 (let ((p-alist '((:minute-start . :minute-end)
22620 (:hour-start . :hour-end)
22621 (:day-start . :day-end)
22622 (:month-start . :month-end)
22623 (:year-start . :year-end))))
22624 (dolist (p-cell p-alist)
22625 (org-element-put-property
22626 split-ts
22627 (funcall (if end 'car 'cdr) p-cell)
22628 (org-element-property
22629 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22630 ;; Eventually refresh `:raw-value'.
22631 (org-element-put-property split-ts :raw-value nil)
22632 (org-element-put-property
22633 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22635 (defun org-timestamp-translate (timestamp &optional boundary)
22636 "Apply `org-translate-time' on a TIMESTAMP object.
22637 When optional argument BOUNDARY is non-nil, it is either the
22638 symbol `start' or `end'. In this case, only translate the
22639 starting or ending part of TIMESTAMP if it is a date or time
22640 range. Otherwise, translate both parts."
22641 (if (and (not boundary)
22642 (memq (org-element-property :type timestamp)
22643 '(active-range inactive-range)))
22644 (concat
22645 (org-translate-time
22646 (org-element-property :raw-value
22647 (org-timestamp-split-range timestamp)))
22648 "--"
22649 (org-translate-time
22650 (org-element-property :raw-value
22651 (org-timestamp-split-range timestamp t))))
22652 (org-translate-time
22653 (org-element-property
22654 :raw-value
22655 (if (not boundary) timestamp
22656 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22660 ;;; Other stuff.
22662 (defun org-toggle-fixed-width-section (arg)
22663 "Toggle the fixed-width export.
22664 If there is no active region, the QUOTE keyword at the current headline is
22665 inserted or removed. When present, it causes the text between this headline
22666 and the next to be exported as fixed-width text, and unmodified.
22667 If there is an active region, this command adds or removes a colon as the
22668 first character of this line. If the first character of a line is a colon,
22669 this line is also exported in fixed-width font."
22670 (interactive "P")
22671 (let* ((cc 0)
22672 (regionp (org-region-active-p))
22673 (beg (if regionp (region-beginning) (point)))
22674 (end (if regionp (region-end)))
22675 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22676 (case-fold-search nil)
22677 (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
22678 off)
22679 (if regionp
22680 (save-excursion
22681 (goto-char beg)
22682 (setq cc (current-column))
22683 (beginning-of-line 1)
22684 (setq off (looking-at re))
22685 (while (> nlines 0)
22686 (setq nlines (1- nlines))
22687 (beginning-of-line 1)
22688 (cond
22689 (arg
22690 (org-move-to-column cc t)
22691 (insert ": \n")
22692 (forward-line -1))
22693 ((and off (looking-at re))
22694 (replace-match "" t t nil 1))
22695 ((not off) (org-move-to-column cc t) (insert ": ")))
22696 (forward-line 1)))
22697 (save-excursion
22698 (org-back-to-heading)
22699 (cond
22700 ((looking-at (format org-heading-keyword-regexp-format
22701 org-quote-string))
22702 (goto-char (match-end 1))
22703 (looking-at (concat " +" org-quote-string))
22704 (replace-match "" t t)
22705 (when (eolp) (insert " ")))
22706 ((looking-at org-outline-regexp)
22707 (goto-char (match-end 0))
22708 (insert org-quote-string " ")))))))
22710 (defun org-reftex-citation ()
22711 "Use reftex-citation to insert a citation into the buffer.
22712 This looks for a line like
22714 #+BIBLIOGRAPHY: foo plain option:-d
22716 and derives from it that foo.bib is the bibliography file relevant
22717 for this document. It then installs the necessary environment for RefTeX
22718 to work in this buffer and calls `reftex-citation' to insert a citation
22719 into the buffer.
22721 Export of such citations to both LaTeX and HTML is handled by the contributed
22722 package ox-bibtex by Taru Karttunen."
22723 (interactive)
22724 (let ((reftex-docstruct-symbol 'rds)
22725 (reftex-cite-format "\\cite{%l}")
22726 rds bib)
22727 (save-excursion
22728 (save-restriction
22729 (widen)
22730 (let ((case-fold-search t)
22731 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
22732 (if (not (save-excursion
22733 (or (re-search-forward re nil t)
22734 (re-search-backward re nil t))))
22735 (error "No bibliography defined in file")
22736 (setq bib (concat (match-string 1) ".bib")
22737 rds (list (list 'bib bib)))))))
22738 (call-interactively 'reftex-citation)))
22740 ;;;; Functions extending outline functionality
22742 (defun org-beginning-of-line (&optional arg)
22743 "Go to the beginning of the current line. If that is invisible, continue
22744 to a visible line beginning. This makes the function of C-a more intuitive.
22745 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22746 first attempt, and only move to after the tags when the cursor is already
22747 beyond the end of the headline."
22748 (interactive "P")
22749 (let ((pos (point))
22750 (special (if (consp org-special-ctrl-a/e)
22751 (car org-special-ctrl-a/e)
22752 org-special-ctrl-a/e))
22753 deactivate-mark refpos)
22754 (if (org-bound-and-true-p visual-line-mode)
22755 (beginning-of-visual-line 1)
22756 (beginning-of-line 1))
22757 (if (and arg (fboundp 'move-beginning-of-line))
22758 (call-interactively 'move-beginning-of-line)
22759 (if (bobp)
22761 (backward-char 1)
22762 (if (org-truely-invisible-p)
22763 (while (and (not (bobp)) (org-truely-invisible-p))
22764 (backward-char 1)
22765 (beginning-of-line 1))
22766 (forward-char 1))))
22767 (when special
22768 (cond
22769 ((and (looking-at org-complex-heading-regexp)
22770 (= (char-after (match-end 1)) ?\ ))
22771 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22772 (point-at-eol)))
22773 (goto-char
22774 (if (eq special t)
22775 (cond ((> pos refpos) refpos)
22776 ((= pos (point)) refpos)
22777 (t (point)))
22778 (cond ((> pos (point)) (point))
22779 ((not (eq last-command this-command)) (point))
22780 (t refpos)))))
22781 ((org-at-item-p)
22782 ;; Being at an item and not looking at an the item means point
22783 ;; was previously moved to beginning of a visual line, which
22784 ;; doesn't contain the item. Therefore, do nothing special,
22785 ;; just stay here.
22786 (when (looking-at org-list-full-item-re)
22787 ;; Set special position at first white space character after
22788 ;; bullet, and check-box, if any.
22789 (let ((after-bullet
22790 (let ((box (match-end 3)))
22791 (if (not box) (match-end 1)
22792 (let ((after (char-after box)))
22793 (if (and after (= after ? )) (1+ box) box))))))
22794 ;; Special case: Move point to special position when
22795 ;; currently after it or at beginning of line.
22796 (if (eq special t)
22797 (when (or (> pos after-bullet) (= (point) pos))
22798 (goto-char after-bullet))
22799 ;; Reversed case: Move point to special position when
22800 ;; point was already at beginning of line and command is
22801 ;; repeated.
22802 (when (and (= (point) pos) (eq last-command this-command))
22803 (goto-char after-bullet))))))))
22804 (org-no-warnings
22805 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22806 (setq disable-point-adjustment
22807 (or (not (invisible-p (point)))
22808 (not (invisible-p (max (point-min) (1- (point))))))))
22810 (defun org-end-of-line (&optional arg)
22811 "Go to the end of the line.
22812 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22813 tags on the first attempt, and only move to after the tags when
22814 the cursor is already beyond the end of the headline."
22815 (interactive "P")
22816 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22817 org-special-ctrl-a/e))
22818 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22819 'end-of-visual-line)
22820 ((fboundp 'move-end-of-line) 'move-end-of-line)
22821 (t 'end-of-line)))
22822 deactivate-mark)
22823 (if (or (not special) arg) (call-interactively move-fun)
22824 (let* ((element (save-excursion (beginning-of-line)
22825 (org-element-at-point)))
22826 (type (org-element-type element)))
22827 (cond
22828 ((memq type '(headline inlinetask))
22829 (let ((pos (point)))
22830 (beginning-of-line 1)
22831 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
22832 (if (eq special t)
22833 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22834 (goto-char (match-beginning 1))
22835 (goto-char (match-end 0)))
22836 (if (or (< pos (match-end 0))
22837 (not (eq this-command last-command)))
22838 (goto-char (match-end 0))
22839 (goto-char (match-beginning 1))))
22840 (call-interactively move-fun))))
22841 ((org-element-property :hiddenp element)
22842 ;; If element is hidden, `move-end-of-line' would put point
22843 ;; after it. Use `end-of-line' to stay on current line.
22844 (call-interactively 'end-of-line))
22845 (t (call-interactively move-fun)))))
22846 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22847 (setq disable-point-adjustment
22848 (or (not (invisible-p (point)))
22849 (not (invisible-p (max (point-min) (1- (point))))))))
22851 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22852 (define-key org-mode-map "\C-e" 'org-end-of-line)
22854 (defun org-backward-sentence (&optional arg)
22855 "Go to beginning of sentence, or beginning of table field.
22856 This will call `backward-sentence' or `org-table-beginning-of-field',
22857 depending on context."
22858 (interactive "P")
22859 (cond
22860 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22861 (t (call-interactively 'backward-sentence))))
22863 (defun org-forward-sentence (&optional arg)
22864 "Go to end of sentence, or end of table field.
22865 This will call `forward-sentence' or `org-table-end-of-field',
22866 depending on context."
22867 (interactive "P")
22868 (cond
22869 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22870 (t (call-interactively 'forward-sentence))))
22872 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22873 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22875 (defun org-kill-line (&optional arg)
22876 "Kill line, to tags or end of line."
22877 (interactive "P")
22878 (cond
22879 ((or (not org-special-ctrl-k)
22880 (bolp)
22881 (not (org-at-heading-p)))
22882 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22883 org-ctrl-k-protect-subtree)
22884 (if (or (eq org-ctrl-k-protect-subtree 'error)
22885 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22886 (user-error "C-k aborted as it would kill a hidden subtree")))
22887 (call-interactively
22888 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22889 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
22890 (kill-region (point) (match-beginning 1))
22891 (org-set-tags nil t))
22892 (t (kill-region (point) (point-at-eol)))))
22894 (define-key org-mode-map "\C-k" 'org-kill-line)
22896 (defun org-yank (&optional arg)
22897 "Yank. If the kill is a subtree, treat it specially.
22898 This command will look at the current kill and check if is a single
22899 subtree, or a series of subtrees[1]. If it passes the test, and if the
22900 cursor is at the beginning of a line or after the stars of a currently
22901 empty headline, then the yank is handled specially. How exactly depends
22902 on the value of the following variables, both set by default.
22904 org-yank-folded-subtrees
22905 When set, the subtree(s) will be folded after insertion, but only
22906 if doing so would now swallow text after the yanked text.
22908 org-yank-adjusted-subtrees
22909 When set, the subtree will be promoted or demoted in order to
22910 fit into the local outline tree structure, which means that the level
22911 will be adjusted so that it becomes the smaller one of the two
22912 *visible* surrounding headings.
22914 Any prefix to this command will cause `yank' to be called directly with
22915 no special treatment. In particular, a simple \\[universal-argument] prefix \
22916 will just
22917 plainly yank the text as it is.
22919 \[1] The test checks if the first non-white line is a heading
22920 and if there are no other headings with fewer stars."
22921 (interactive "P")
22922 (org-yank-generic 'yank arg))
22924 (defun org-yank-generic (command arg)
22925 "Perform some yank-like command.
22927 This function implements the behavior described in the `org-yank'
22928 documentation. However, it has been generalized to work for any
22929 interactive command with similar behavior."
22931 ;; pretend to be command COMMAND
22932 (setq this-command command)
22934 (if arg
22935 (call-interactively command)
22937 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22938 (and (org-kill-is-subtree-p)
22939 (or (bolp)
22940 (and (looking-at "[ \t]*$")
22941 (string-match
22942 "\\`\\*+\\'"
22943 (buffer-substring (point-at-bol) (point)))))))
22944 swallowp)
22945 (cond
22946 ((and subtreep org-yank-folded-subtrees)
22947 (let ((beg (point))
22948 end)
22949 (if (and subtreep org-yank-adjusted-subtrees)
22950 (org-paste-subtree nil nil 'for-yank)
22951 (call-interactively command))
22953 (setq end (point))
22954 (goto-char beg)
22955 (when (and (bolp) subtreep
22956 (not (setq swallowp
22957 (org-yank-folding-would-swallow-text beg end))))
22958 (org-with-limited-levels
22959 (or (looking-at org-outline-regexp)
22960 (re-search-forward org-outline-regexp-bol end t))
22961 (while (and (< (point) end) (looking-at org-outline-regexp))
22962 (hide-subtree)
22963 (org-cycle-show-empty-lines 'folded)
22964 (condition-case nil
22965 (outline-forward-same-level 1)
22966 (error (goto-char end))))))
22967 (when swallowp
22968 (message
22969 "Inserted text not folded because that would swallow text"))
22971 (goto-char end)
22972 (skip-chars-forward " \t\n\r")
22973 (beginning-of-line 1)
22974 (push-mark beg 'nomsg)))
22975 ((and subtreep org-yank-adjusted-subtrees)
22976 (let ((beg (point-at-bol)))
22977 (org-paste-subtree nil nil 'for-yank)
22978 (push-mark beg 'nomsg)))
22980 (call-interactively command))))))
22982 (defun org-yank-folding-would-swallow-text (beg end)
22983 "Would hide-subtree at BEG swallow any text after END?"
22984 (let (level)
22985 (org-with-limited-levels
22986 (save-excursion
22987 (goto-char beg)
22988 (when (or (looking-at org-outline-regexp)
22989 (re-search-forward org-outline-regexp-bol end t))
22990 (setq level (org-outline-level)))
22991 (goto-char end)
22992 (skip-chars-forward " \t\r\n\v\f")
22993 (if (or (eobp)
22994 (and (bolp) (looking-at org-outline-regexp)
22995 (<= (org-outline-level) level)))
22996 nil ; Nothing would be swallowed
22997 t))))) ; something would swallow
22999 (define-key org-mode-map "\C-y" 'org-yank)
23001 (defun org-truely-invisible-p ()
23002 "Check if point is at a character currently not visible.
23003 This version does not only check the character property, but also
23004 `visible-mode'."
23005 ;; Early versions of noutline don't have `outline-invisible-p'.
23006 (if (org-bound-and-true-p visible-mode)
23008 (outline-invisible-p)))
23010 (defun org-invisible-p2 ()
23011 "Check if point is at a character currently not visible."
23012 (save-excursion
23013 (if (and (eolp) (not (bobp))) (backward-char 1))
23014 ;; Early versions of noutline don't have `outline-invisible-p'.
23015 (outline-invisible-p)))
23017 (defun org-back-to-heading (&optional invisible-ok)
23018 "Call `outline-back-to-heading', but provide a better error message."
23019 (condition-case nil
23020 (outline-back-to-heading invisible-ok)
23021 (error (error "Before first headline at position %d in buffer %s"
23022 (point) (current-buffer)))))
23024 (defun org-before-first-heading-p ()
23025 "Before first heading?"
23026 (save-excursion
23027 (end-of-line)
23028 (null (re-search-backward org-outline-regexp-bol nil t))))
23030 (defun org-at-heading-p (&optional ignored)
23031 (outline-on-heading-p t))
23032 ;; Compatibility alias with Org versions < 7.8.03
23033 (defalias 'org-on-heading-p 'org-at-heading-p)
23035 (defun org-at-comment-p nil
23036 "Is cursor in a line starting with a # character?"
23037 (save-excursion
23038 (beginning-of-line)
23039 (looking-at "^#")))
23041 (defun org-at-drawer-p nil
23042 "Is cursor at a drawer keyword?"
23043 (save-excursion
23044 (move-beginning-of-line 1)
23045 (looking-at org-drawer-regexp)))
23047 (defun org-at-block-p nil
23048 "Is cursor at a block keyword?"
23049 (save-excursion
23050 (move-beginning-of-line 1)
23051 (looking-at org-block-regexp)))
23053 (defun org-point-at-end-of-empty-headline ()
23054 "If point is at the end of an empty headline, return t, else nil.
23055 If the heading only contains a TODO keyword, it is still still considered
23056 empty."
23057 (and (looking-at "[ \t]*$")
23058 (when org-todo-line-regexp
23059 (save-excursion
23060 (beginning-of-line 1)
23061 (let ((case-fold-search nil))
23062 (looking-at org-todo-line-regexp)
23063 (string= (match-string 3) ""))))))
23065 (defun org-at-heading-or-item-p ()
23066 (or (org-at-heading-p) (org-at-item-p)))
23068 (defun org-at-target-p ()
23069 (or (org-in-regexp org-radio-target-regexp)
23070 (org-in-regexp org-target-regexp)))
23071 ;; Compatibility alias with Org versions < 7.8.03
23072 (defalias 'org-on-target-p 'org-at-target-p)
23074 (defun org-up-heading-all (arg)
23075 "Move to the heading line of which the present line is a subheading.
23076 This function considers both visible and invisible heading lines.
23077 With argument, move up ARG levels."
23078 (if (fboundp 'outline-up-heading-all)
23079 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23080 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23082 (defun org-up-heading-safe ()
23083 "Move to the heading line of which the present line is a subheading.
23084 This version will not throw an error. It will return the level of the
23085 headline found, or nil if no higher level is found.
23087 Also, this function will be a lot faster than `outline-up-heading',
23088 because it relies on stars being the outline starters. This can really
23089 make a significant difference in outlines with very many siblings."
23090 (let (start-level re)
23091 (org-back-to-heading t)
23092 (setq start-level (funcall outline-level))
23093 (if (equal start-level 1)
23095 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
23096 (if (re-search-backward re nil t)
23097 (funcall outline-level)))))
23099 (defun org-first-sibling-p ()
23100 "Is this heading the first child of its parents?"
23101 (interactive)
23102 (let ((re org-outline-regexp-bol)
23103 level l)
23104 (unless (org-at-heading-p t)
23105 (user-error "Not at a heading"))
23106 (setq level (funcall outline-level))
23107 (save-excursion
23108 (if (not (re-search-backward re nil t))
23110 (setq l (funcall outline-level))
23111 (< l level)))))
23113 (defun org-goto-sibling (&optional previous)
23114 "Goto the next sibling, even if it is invisible.
23115 When PREVIOUS is set, go to the previous sibling instead. Returns t
23116 when a sibling was found. When none is found, return nil and don't
23117 move point."
23118 (let ((fun (if previous 're-search-backward 're-search-forward))
23119 (pos (point))
23120 (re org-outline-regexp-bol)
23121 level l)
23122 (when (condition-case nil (org-back-to-heading t) (error nil))
23123 (setq level (funcall outline-level))
23124 (catch 'exit
23125 (or previous (forward-char 1))
23126 (while (funcall fun re nil t)
23127 (setq l (funcall outline-level))
23128 (when (< l level) (goto-char pos) (throw 'exit nil))
23129 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23130 (goto-char pos)
23131 nil))))
23133 (defun org-show-siblings ()
23134 "Show all siblings of the current headline."
23135 (save-excursion
23136 (while (org-goto-sibling) (org-flag-heading nil)))
23137 (save-excursion
23138 (while (org-goto-sibling 'previous)
23139 (org-flag-heading nil))))
23141 (defun org-goto-first-child ()
23142 "Goto the first child, even if it is invisible.
23143 Return t when a child was found. Otherwise don't move point and
23144 return nil."
23145 (let (level (pos (point)) (re org-outline-regexp-bol))
23146 (when (condition-case nil (org-back-to-heading t) (error nil))
23147 (setq level (outline-level))
23148 (forward-char 1)
23149 (if (and (re-search-forward re nil t) (> (outline-level) level))
23150 (progn (goto-char (match-beginning 0)) t)
23151 (goto-char pos) nil))))
23153 (defun org-show-hidden-entry ()
23154 "Show an entry where even the heading is hidden."
23155 (save-excursion
23156 (org-show-entry)))
23158 (defun org-flag-heading (flag &optional entry)
23159 "Flag the current heading. FLAG non-nil means make invisible.
23160 When ENTRY is non-nil, show the entire entry."
23161 (save-excursion
23162 (org-back-to-heading t)
23163 ;; Check if we should show the entire entry
23164 (if entry
23165 (progn
23166 (org-show-entry)
23167 (save-excursion
23168 (and (outline-next-heading)
23169 (org-flag-heading nil))))
23170 (outline-flag-region (max (point-min) (1- (point)))
23171 (save-excursion (outline-end-of-heading) (point))
23172 flag))))
23174 (defun org-get-next-sibling ()
23175 "Move to next heading of the same level, and return point.
23176 If there is no such heading, return nil.
23177 This is like outline-next-sibling, but invisible headings are ok."
23178 (let ((level (funcall outline-level)))
23179 (outline-next-heading)
23180 (while (and (not (eobp)) (> (funcall outline-level) level))
23181 (outline-next-heading))
23182 (if (or (eobp) (< (funcall outline-level) level))
23184 (point))))
23186 (defun org-get-last-sibling ()
23187 "Move to previous heading of the same level, and return point.
23188 If there is no such heading, return nil."
23189 (let ((opoint (point))
23190 (level (funcall outline-level)))
23191 (outline-previous-heading)
23192 (when (and (/= (point) opoint) (outline-on-heading-p t))
23193 (while (and (> (funcall outline-level) level)
23194 (not (bobp)))
23195 (outline-previous-heading))
23196 (if (< (funcall outline-level) level)
23198 (point)))))
23200 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23201 "Goto to the end of a subtree."
23202 ;; This contains an exact copy of the original function, but it uses
23203 ;; `org-back-to-heading', to make it work also in invisible
23204 ;; trees. And is uses an invisible-ok argument.
23205 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23206 ;; Furthermore, when used inside Org, finding the end of a large subtree
23207 ;; with many children and grandchildren etc, this can be much faster
23208 ;; than the outline version.
23209 (org-back-to-heading invisible-ok)
23210 (let ((first t)
23211 (level (funcall outline-level)))
23212 (if (and (derived-mode-p 'org-mode) (< level 1000))
23213 ;; A true heading (not a plain list item), in Org-mode
23214 ;; This means we can easily find the end by looking
23215 ;; only for the right number of stars. Using a regexp to do
23216 ;; this is so much faster than using a Lisp loop.
23217 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23218 (forward-char 1)
23219 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23220 ;; something else, do it the slow way
23221 (while (and (not (eobp))
23222 (or first (> (funcall outline-level) level)))
23223 (setq first nil)
23224 (outline-next-heading)))
23225 (unless to-heading
23226 (if (memq (preceding-char) '(?\n ?\^M))
23227 (progn
23228 ;; Go to end of line before heading
23229 (forward-char -1)
23230 (if (memq (preceding-char) '(?\n ?\^M))
23231 ;; leave blank line before heading
23232 (forward-char -1))))))
23233 (point))
23235 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23236 "Use Org version in org-mode, for dramatic speed-up."
23237 (if (derived-mode-p 'org-mode)
23238 (progn
23239 (org-end-of-subtree nil t)
23240 (unless (eobp) (backward-char 1)))
23241 ad-do-it))
23243 (defun org-end-of-meta-data-and-drawers ()
23244 "Jump to the first text after meta data and drawers in the current entry.
23245 This will move over empty lines, lines with planning time stamps,
23246 clocking lines, and drawers."
23247 (org-back-to-heading t)
23248 (let ((end (save-excursion (outline-next-heading) (point)))
23249 (re (concat "\\(" org-drawer-regexp "\\)"
23250 "\\|" "[ \t]*" org-keyword-time-regexp)))
23251 (forward-line 1)
23252 (while (re-search-forward re end t)
23253 (if (not (match-end 1))
23254 ;; empty or planning line
23255 (forward-line 1)
23256 ;; a drawer, find the end
23257 (re-search-forward "^[ \t]*:END:" end 'move)
23258 (forward-line 1)))
23259 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23260 (point)))
23262 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23263 "Move forward to the ARG'th subheading at same level as this one.
23264 Stop at the first and last subheadings of a superior heading.
23265 Normally this only looks at visible headings, but when INVISIBLE-OK is
23266 non-nil it will also look at invisible ones."
23267 (interactive "p")
23268 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23269 (if (and arg (< arg 0))
23270 (goto-char (point-min))
23271 (outline-next-heading))
23272 (org-at-heading-p)
23273 (let ((level (- (match-end 0) (match-beginning 0) 1))
23274 (f (if (and arg (< arg 0))
23275 're-search-backward
23276 're-search-forward))
23277 (count (if arg (abs arg) 1))
23278 (result (point)))
23279 (while (and (prog1 (> count 0)
23280 (forward-char (if (and arg (< arg 0)) -1 1)))
23281 (funcall f org-outline-regexp-bol nil 'move))
23282 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23283 (cond ((< l level) (setq count 0))
23284 ((and (= l level)
23285 (or invisible-ok
23286 (progn
23287 (goto-char (line-beginning-position))
23288 (not (outline-invisible-p)))))
23289 (setq count (1- count))
23290 (when (eq l level)
23291 (setq result (point)))))))
23292 (goto-char result))
23293 (beginning-of-line 1)))
23295 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23296 "Move backward to the ARG'th subheading at same level as this one.
23297 Stop at the first and last subheadings of a superior heading."
23298 (interactive "p")
23299 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23301 (defun org-next-block (arg &optional backward block-regexp)
23302 "Jump to the next block.
23303 With a prefix argument ARG, jump forward ARG many source blocks.
23304 When BACKWARD is non-nil, jump to the previous block.
23305 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23306 (interactive "p")
23307 (let ((re (or block-regexp org-block-regexp))
23308 (re-search-fn (or (and backward 're-search-backward)
23309 're-search-forward)))
23310 (if (looking-at re) (forward-char 1))
23311 (condition-case nil
23312 (funcall re-search-fn re nil nil arg)
23313 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23314 (goto-char (match-beginning 0)) (org-show-context)))
23316 (defun org-previous-block (arg &optional block-regexp)
23317 "Jump to the previous block.
23318 With a prefix argument ARG, jump backward ARG many source blocks.
23319 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23320 (interactive "p")
23321 (org-next-block arg t block-regexp))
23323 (defun org-forward-paragraph ()
23324 "Move forward to beginning of next paragraph or equivalent.
23326 The function moves point to the beginning of the next visible
23327 structural element, which can be a paragraph, a table, a list
23328 item, etc. It also provides some special moves for convenience:
23330 - On an affiliated keyword, jump to the beginning of the
23331 relative element.
23332 - On an item or a footnote definition, move to the second
23333 element inside, if any.
23334 - On a table or a property drawer, jump after it.
23335 - On a verse or source block, stop after blank lines."
23336 (interactive)
23337 (when (eobp) (user-error "Cannot move further down"))
23338 (let* ((deactivate-mark nil)
23339 (element (org-element-at-point))
23340 (type (org-element-type element))
23341 (post-affiliated (org-element-property :post-affiliated element))
23342 (contents-begin (org-element-property :contents-begin element))
23343 (contents-end (org-element-property :contents-end element))
23344 (end (let ((end (org-element-property :end element)) (parent element))
23345 (while (and (setq parent (org-element-property :parent parent))
23346 (= (org-element-property :contents-end parent) end))
23347 (setq end (org-element-property :end parent)))
23348 end)))
23349 (cond ((not element)
23350 (skip-chars-forward " \r\t\n")
23351 (or (eobp) (beginning-of-line)))
23352 ;; On affiliated keywords, move to element's beginning.
23353 ((and post-affiliated (< (point) post-affiliated))
23354 (goto-char post-affiliated))
23355 ;; At a table row, move to the end of the table. Similarly,
23356 ;; at a node property, move to the end of the property
23357 ;; drawer.
23358 ((memq type '(node-property table-row))
23359 (goto-char (org-element-property
23360 :end (org-element-property :parent element))))
23361 ((memq type '(property-drawer table)) (goto-char end))
23362 ;; Consider blank lines as separators in verse and source
23363 ;; blocks to ease editing.
23364 ((memq type '(src-block verse-block))
23365 (when (eq type 'src-block)
23366 (setq contents-end
23367 (save-excursion (goto-char end)
23368 (skip-chars-backward " \r\t\n")
23369 (line-beginning-position))))
23370 (beginning-of-line)
23371 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23372 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23373 (goto-char end)
23374 (skip-chars-forward " \r\t\n")
23375 (if (= (point) contents-end) (goto-char end)
23376 (beginning-of-line))))
23377 ;; With no contents, just skip element.
23378 ((not contents-begin) (goto-char end))
23379 ;; If contents are invisible, skip the element altogether.
23380 ((outline-invisible-p (line-end-position))
23381 (case type
23382 (headline
23383 (org-with-limited-levels (outline-next-visible-heading 1)))
23384 ;; At a plain list, make sure we move to the next item
23385 ;; instead of skipping the whole list.
23386 (plain-list (forward-char)
23387 (org-forward-paragraph))
23388 (otherwise (goto-char end))))
23389 ((>= (point) contents-end) (goto-char end))
23390 ((>= (point) contents-begin)
23391 ;; This can only happen on paragraphs and plain lists.
23392 (case type
23393 (paragraph (goto-char end))
23394 ;; At a plain list, try to move to second element in
23395 ;; first item, if possible.
23396 (plain-list (end-of-line)
23397 (org-forward-paragraph))))
23398 ;; When contents start on the middle of a line (e.g. in
23399 ;; items and footnote definitions), try to reach first
23400 ;; element starting after current line.
23401 ((> (line-end-position) contents-begin)
23402 (end-of-line)
23403 (org-forward-paragraph))
23404 (t (goto-char contents-begin)))))
23406 (defun org-backward-paragraph ()
23407 "Move backward to start of previous paragraph or equivalent.
23409 The function moves point to the beginning of the current
23410 structural element, which can be a paragraph, a table, a list
23411 item, etc., or to the beginning of the previous visible one if
23412 point is already there. It also provides some special moves for
23413 convenience:
23415 - On an affiliated keyword, jump to the first one.
23416 - On a table or a property drawer, move to its beginning.
23417 - On a verse or source block, stop before blank lines."
23418 (interactive)
23419 (when (bobp) (user-error "Cannot move further up"))
23420 (let* ((deactivate-mark nil)
23421 (element (org-element-at-point))
23422 (type (org-element-type element))
23423 (contents-begin (org-element-property :contents-begin element))
23424 (contents-end (org-element-property :contents-end element))
23425 (post-affiliated (org-element-property :post-affiliated element))
23426 (begin (org-element-property :begin element)))
23427 (cond
23428 ((not element) (goto-char (point-min)))
23429 ((= (point) begin)
23430 (backward-char)
23431 (org-backward-paragraph))
23432 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23433 ((memq type '(node-property table-row))
23434 (goto-char (org-element-property
23435 :post-affiliated (org-element-property :parent element))))
23436 ((memq type '(property-drawer table)) (goto-char begin))
23437 ((memq type '(src-block verse-block))
23438 (when (eq type 'src-block)
23439 (setq contents-begin
23440 (save-excursion (goto-char begin) (forward-line) (point))))
23441 (if (= (point) contents-begin) (goto-char post-affiliated)
23442 ;; Inside a verse block, see blank lines as paragraph
23443 ;; separators.
23444 (let ((origin (point)))
23445 (skip-chars-backward " \r\t\n" contents-begin)
23446 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
23447 (skip-chars-forward " \r\t\n" origin)
23448 (if (= (point) origin) (goto-char contents-begin)
23449 (beginning-of-line))))))
23450 ((not contents-begin) (goto-char (or post-affiliated begin)))
23451 ((eq type 'paragraph)
23452 (goto-char contents-begin)
23453 ;; When at first paragraph in an item or a footnote definition,
23454 ;; move directly to beginning of line.
23455 (let ((parent-contents
23456 (org-element-property
23457 :contents-begin (org-element-property :parent element))))
23458 (when (and parent-contents (= parent-contents contents-begin))
23459 (beginning-of-line))))
23460 ;; At the end of a greater element, move to the beginning of the
23461 ;; last element within.
23462 ((>= (point) contents-end)
23463 (goto-char (1- contents-end))
23464 (org-backward-paragraph))
23465 (t (goto-char (or post-affiliated begin))))
23466 ;; Ensure we never leave point invisible.
23467 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23469 (defun org-forward-element ()
23470 "Move forward by one element.
23471 Move to the next element at the same level, when possible."
23472 (interactive)
23473 (cond ((eobp) (user-error "Cannot move further down"))
23474 ((org-with-limited-levels (org-at-heading-p))
23475 (let ((origin (point)))
23476 (goto-char (org-end-of-subtree nil t))
23477 (unless (org-with-limited-levels (org-at-heading-p))
23478 (goto-char origin)
23479 (user-error "Cannot move further down"))))
23481 (let* ((elem (org-element-at-point))
23482 (end (org-element-property :end elem))
23483 (parent (org-element-property :parent elem)))
23484 (cond ((and parent (= (org-element-property :contents-end parent) end))
23485 (goto-char (org-element-property :end parent)))
23486 ((integer-or-marker-p end) (goto-char end))
23487 (t (message "No element at point")))))))
23489 (defun org-backward-element ()
23490 "Move backward by one element.
23491 Move to the previous element at the same level, when possible."
23492 (interactive)
23493 (cond ((bobp) (user-error "Cannot move further up"))
23494 ((org-with-limited-levels (org-at-heading-p))
23495 ;; At a headline, move to the previous one, if any, or stay
23496 ;; here.
23497 (let ((origin (point)))
23498 (org-with-limited-levels (org-backward-heading-same-level 1))
23499 ;; When current headline has no sibling above, move to its
23500 ;; parent.
23501 (when (= (point) origin)
23502 (or (org-with-limited-levels (org-up-heading-safe))
23503 (progn (goto-char origin)
23504 (user-error "Cannot move further up"))))))
23506 (let* ((trail (org-element-at-point 'keep-trail))
23507 (elem (car trail))
23508 (prev-elem (nth 1 trail))
23509 (beg (org-element-property :begin elem)))
23510 (cond
23511 ;; Move to beginning of current element if point isn't
23512 ;; there already.
23513 ((null beg) (message "No element at point"))
23514 ((/= (point) beg) (goto-char beg))
23515 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23516 ((org-before-first-heading-p) (goto-char (point-min)))
23517 (t (org-back-to-heading)))))))
23519 (defun org-up-element ()
23520 "Move to upper element."
23521 (interactive)
23522 (if (org-with-limited-levels (org-at-heading-p))
23523 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23524 (let* ((elem (org-element-at-point))
23525 (parent (org-element-property :parent elem)))
23526 (if parent (goto-char (org-element-property :begin parent))
23527 (if (org-with-limited-levels (org-before-first-heading-p))
23528 (user-error "No surrounding element")
23529 (org-with-limited-levels (org-back-to-heading)))))))
23531 (defvar org-element-greater-elements)
23532 (defun org-down-element ()
23533 "Move to inner element."
23534 (interactive)
23535 (let ((element (org-element-at-point)))
23536 (cond
23537 ((memq (org-element-type element) '(plain-list table))
23538 (goto-char (org-element-property :contents-begin element))
23539 (forward-char))
23540 ((memq (org-element-type element) org-element-greater-elements)
23541 ;; If contents are hidden, first disclose them.
23542 (when (org-element-property :hiddenp element) (org-cycle))
23543 (goto-char (or (org-element-property :contents-begin element)
23544 (user-error "No content for this element"))))
23545 (t (user-error "No inner element")))))
23547 (defun org-drag-element-backward ()
23548 "Move backward element at point."
23549 (interactive)
23550 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23551 (let* ((trail (org-element-at-point 'keep-trail))
23552 (elem (car trail))
23553 (prev-elem (nth 1 trail)))
23554 ;; Error out if no previous element or previous element is
23555 ;; a parent of the current one.
23556 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23557 (user-error "Cannot drag element backward")
23558 (let ((pos (point)))
23559 (org-element-swap-A-B prev-elem elem)
23560 (goto-char (+ (org-element-property :begin prev-elem)
23561 (- pos (org-element-property :begin elem)))))))))
23563 (defun org-drag-element-forward ()
23564 "Move forward element at point."
23565 (interactive)
23566 (let* ((pos (point))
23567 (elem (org-element-at-point)))
23568 (when (= (point-max) (org-element-property :end elem))
23569 (user-error "Cannot drag element forward"))
23570 (goto-char (org-element-property :end elem))
23571 (let ((next-elem (org-element-at-point)))
23572 (when (or (org-element-nested-p elem next-elem)
23573 (and (eq (org-element-type next-elem) 'headline)
23574 (not (eq (org-element-type elem) 'headline))))
23575 (goto-char pos)
23576 (user-error "Cannot drag element forward"))
23577 ;; Compute new position of point: it's shifted by NEXT-ELEM
23578 ;; body's length (without final blanks) and by the length of
23579 ;; blanks between ELEM and NEXT-ELEM.
23580 (let ((size-next (- (save-excursion
23581 (goto-char (org-element-property :end next-elem))
23582 (skip-chars-backward " \r\t\n")
23583 (forward-line)
23584 ;; Small correction if buffer doesn't end
23585 ;; with a newline character.
23586 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23587 (org-element-property :begin next-elem)))
23588 (size-blank (- (org-element-property :end elem)
23589 (save-excursion
23590 (goto-char (org-element-property :end elem))
23591 (skip-chars-backward " \r\t\n")
23592 (forward-line)
23593 (point)))))
23594 (org-element-swap-A-B elem next-elem)
23595 (goto-char (+ pos size-next size-blank))))))
23597 (defun org-drag-line-forward (arg)
23598 "Drag the line at point ARG lines forward."
23599 (interactive "p")
23600 (dotimes (n (abs arg))
23601 (let ((c (current-column)))
23602 (if (< 0 arg)
23603 (progn
23604 (beginning-of-line 2)
23605 (transpose-lines 1)
23606 (beginning-of-line 0))
23607 (transpose-lines 1)
23608 (beginning-of-line -1))
23609 (org-move-to-column c))))
23611 (defun org-drag-line-backward (arg)
23612 "Drag the line at point ARG lines backward."
23613 (interactive "p")
23614 (org-drag-line-forward (- arg)))
23616 (defun org-mark-element ()
23617 "Put point at beginning of this element, mark at end.
23619 Interactively, if this command is repeated or (in Transient Mark
23620 mode) if the mark is active, it marks the next element after the
23621 ones already marked."
23622 (interactive)
23623 (let (deactivate-mark)
23624 (if (and (org-called-interactively-p 'any)
23625 (or (and (eq last-command this-command) (mark t))
23626 (and transient-mark-mode mark-active)))
23627 (set-mark
23628 (save-excursion
23629 (goto-char (mark))
23630 (goto-char (org-element-property :end (org-element-at-point)))))
23631 (let ((element (org-element-at-point)))
23632 (end-of-line)
23633 (push-mark (org-element-property :end element) t t)
23634 (goto-char (org-element-property :begin element))))))
23636 (defun org-narrow-to-element ()
23637 "Narrow buffer to current element."
23638 (interactive)
23639 (let ((elem (org-element-at-point)))
23640 (cond
23641 ((eq (car elem) 'headline)
23642 (narrow-to-region
23643 (org-element-property :begin elem)
23644 (org-element-property :end elem)))
23645 ((memq (car elem) org-element-greater-elements)
23646 (narrow-to-region
23647 (org-element-property :contents-begin elem)
23648 (org-element-property :contents-end elem)))
23650 (narrow-to-region
23651 (org-element-property :begin elem)
23652 (org-element-property :end elem))))))
23654 (defun org-transpose-element ()
23655 "Transpose current and previous elements, keeping blank lines between.
23656 Point is moved after both elements."
23657 (interactive)
23658 (org-skip-whitespace)
23659 (let ((end (org-element-property :end (org-element-at-point))))
23660 (org-drag-element-backward)
23661 (goto-char end)))
23663 (defun org-unindent-buffer ()
23664 "Un-indent the visible part of the buffer.
23665 Relative indentation (between items, inside blocks, etc.) isn't
23666 modified."
23667 (interactive)
23668 (unless (eq major-mode 'org-mode)
23669 (user-error "Cannot un-indent a buffer not in Org mode"))
23670 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23671 unindent-tree ; For byte-compiler.
23672 (unindent-tree
23673 (function
23674 (lambda (contents)
23675 (mapc
23676 (lambda (element)
23677 (if (memq (org-element-type element) '(headline section))
23678 (funcall unindent-tree (org-element-contents element))
23679 (save-excursion
23680 (save-restriction
23681 (narrow-to-region
23682 (org-element-property :begin element)
23683 (org-element-property :end element))
23684 (org-do-remove-indentation)))))
23685 (reverse contents))))))
23686 (funcall unindent-tree (org-element-contents parse-tree))))
23688 (defun org-show-subtree ()
23689 "Show everything after this heading at deeper levels."
23690 (interactive)
23691 (outline-flag-region
23692 (point)
23693 (save-excursion
23694 (org-end-of-subtree t t))
23695 nil))
23697 (defun org-show-entry ()
23698 "Show the body directly following this heading.
23699 Show the heading too, if it is currently invisible."
23700 (interactive)
23701 (save-excursion
23702 (condition-case nil
23703 (progn
23704 (org-back-to-heading t)
23705 (outline-flag-region
23706 (max (point-min) (1- (point)))
23707 (save-excursion
23708 (if (re-search-forward
23709 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
23710 (match-beginning 1)
23711 (point-max)))
23712 nil)
23713 (org-cycle-hide-drawers 'children))
23714 (error nil))))
23716 (defun org-make-options-regexp (kwds &optional extra)
23717 "Make a regular expression for keyword lines."
23718 (concat
23719 "^#\\+\\("
23720 (mapconcat 'regexp-quote kwds "\\|")
23721 (if extra (concat "\\|" extra))
23722 "\\):[ \t]*\\(.*\\)"))
23724 ;; Make isearch reveal the necessary context
23725 (defun org-isearch-end ()
23726 "Reveal context after isearch exits."
23727 (when isearch-success ; only if search was successful
23728 (if (featurep 'xemacs)
23729 ;; Under XEmacs, the hook is run in the correct place,
23730 ;; we directly show the context.
23731 (org-show-context 'isearch)
23732 ;; In Emacs the hook runs *before* restoring the overlays.
23733 ;; So we have to use a one-time post-command-hook to do this.
23734 ;; (Emacs 22 has a special variable, see function `org-mode')
23735 (unless (and (boundp 'isearch-mode-end-hook-quit)
23736 isearch-mode-end-hook-quit)
23737 ;; Only when the isearch was not quitted.
23738 (org-add-hook 'post-command-hook 'org-isearch-post-command
23739 'append 'local)))
23740 (org-fix-ellipsis-at-bol)))
23742 (defun org-isearch-post-command ()
23743 "Remove self from hook, and show context."
23744 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23745 (org-show-context 'isearch))
23748 ;;;; Integration with and fixes for other packages
23750 ;;; Imenu support
23752 (defvar org-imenu-markers nil
23753 "All markers currently used by Imenu.")
23754 (make-variable-buffer-local 'org-imenu-markers)
23756 (defun org-imenu-new-marker (&optional pos)
23757 "Return a new marker for use by Imenu, and remember the marker."
23758 (let ((m (make-marker)))
23759 (move-marker m (or pos (point)))
23760 (push m org-imenu-markers)
23763 (defun org-imenu-get-tree ()
23764 "Produce the index for Imenu."
23765 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23766 (setq org-imenu-markers nil)
23767 (let* ((n org-imenu-depth)
23768 (re (concat "^" (org-get-limited-outline-regexp)))
23769 (subs (make-vector (1+ n) nil))
23770 (last-level 0)
23771 m level head0 head)
23772 (save-excursion
23773 (save-restriction
23774 (widen)
23775 (goto-char (point-max))
23776 (while (re-search-backward re nil t)
23777 (setq level (org-reduced-level (funcall outline-level)))
23778 (when (and (<= level n)
23779 (looking-at org-complex-heading-regexp)
23780 (setq head0 (org-match-string-no-properties 4)))
23781 (setq head (org-link-display-format head0)
23782 m (org-imenu-new-marker))
23783 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23784 (if (>= level last-level)
23785 (push (cons head m) (aref subs level))
23786 (push (cons head (aref subs (1+ level))) (aref subs level))
23787 (loop for i from (1+ level) to n do (aset subs i nil)))
23788 (setq last-level level)))))
23789 (aref subs 1)))
23791 (eval-after-load "imenu"
23792 '(progn
23793 (add-hook 'imenu-after-jump-hook
23794 (lambda ()
23795 (if (derived-mode-p 'org-mode)
23796 (org-show-context 'org-goto))))))
23798 (defun org-link-display-format (link)
23799 "Replace a link with its the description.
23800 If there is no description, use the link target."
23801 (save-match-data
23802 (if (string-match org-bracket-link-analytic-regexp link)
23803 (replace-match (if (match-end 5)
23804 (match-string 5 link)
23805 (concat (match-string 1 link)
23806 (match-string 3 link)))
23807 nil t link)
23808 link)))
23810 (defun org-toggle-link-display ()
23811 "Toggle the literal or descriptive display of links."
23812 (interactive)
23813 (if org-descriptive-links
23814 (progn (org-remove-from-invisibility-spec '(org-link))
23815 (org-restart-font-lock)
23816 (setq org-descriptive-links nil))
23817 (progn (add-to-invisibility-spec '(org-link))
23818 (org-restart-font-lock)
23819 (setq org-descriptive-links t))))
23821 ;; Speedbar support
23823 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23824 "Overlay marking the agenda restriction line in speedbar.")
23825 (overlay-put org-speedbar-restriction-lock-overlay
23826 'face 'org-agenda-restriction-lock)
23827 (overlay-put org-speedbar-restriction-lock-overlay
23828 'help-echo "Agendas are currently limited to this item.")
23829 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23831 (defun org-speedbar-set-agenda-restriction ()
23832 "Restrict future agenda commands to the location at point in speedbar.
23833 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
23834 (interactive)
23835 (require 'org-agenda)
23836 (let (p m tp np dir txt)
23837 (cond
23838 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23839 'org-imenu t))
23840 (setq m (get-text-property p 'org-imenu-marker))
23841 (with-current-buffer (marker-buffer m)
23842 (goto-char m)
23843 (org-agenda-set-restriction-lock 'subtree)))
23844 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23845 'speedbar-function 'speedbar-find-file))
23846 (setq tp (previous-single-property-change
23847 (1+ p) 'speedbar-function)
23848 np (next-single-property-change
23849 tp 'speedbar-function)
23850 dir (speedbar-line-directory)
23851 txt (buffer-substring-no-properties (or tp (point-min))
23852 (or np (point-max))))
23853 (with-current-buffer (find-file-noselect
23854 (let ((default-directory dir))
23855 (expand-file-name txt)))
23856 (unless (derived-mode-p 'org-mode)
23857 (user-error "Cannot restrict to non-Org-mode file"))
23858 (org-agenda-set-restriction-lock 'file)))
23859 (t (user-error "Don't know how to restrict Org-mode's agenda")))
23860 (move-overlay org-speedbar-restriction-lock-overlay
23861 (point-at-bol) (point-at-eol))
23862 (setq current-prefix-arg nil)
23863 (org-agenda-maybe-redo)))
23865 (defvar speedbar-file-key-map)
23866 (declare-function speedbar-add-supported-extension "speedbar" (extension))
23867 (eval-after-load "speedbar"
23868 '(progn
23869 (speedbar-add-supported-extension ".org")
23870 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23871 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23872 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23873 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23874 (add-hook 'speedbar-visiting-tag-hook
23875 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23877 ;;; Fixes and Hacks for problems with other packages
23879 ;; Make flyspell not check words in links, to not mess up our keymap
23880 (defvar org-element-affiliated-keywords) ; From org-element.el
23881 (defvar org-element-block-name-alist) ; From org-element.el
23882 (defun org-mode-flyspell-verify ()
23883 "Don't let flyspell put overlays at active buttons, or on
23884 {todo,all-time,additional-option-like}-keywords."
23885 (require 'org-element) ; For `org-element-affiliated-keywords'
23886 (let ((pos (max (1- (point)) (point-min)))
23887 (word (thing-at-point 'word)))
23888 (and (not (get-text-property pos 'keymap))
23889 (not (get-text-property pos 'org-no-flyspell))
23890 (not (member word org-todo-keywords-1))
23891 (not (member word org-all-time-keywords))
23892 (not (member word org-options-keywords))
23893 (not (member word (mapcar 'car org-startup-options)))
23894 (not (member-ignore-case word org-element-affiliated-keywords))
23895 (not (member-ignore-case word (org-get-export-keywords)))
23896 (not (member-ignore-case
23897 word (mapcar 'car org-element-block-name-alist)))
23898 (not (member-ignore-case word '("BEGIN" "END" "ATTR")))
23899 (not (org-in-src-block-p)))))
23901 (defun org-remove-flyspell-overlays-in (beg end)
23902 "Remove flyspell overlays in region."
23903 (and (org-bound-and-true-p flyspell-mode)
23904 (fboundp 'flyspell-delete-region-overlays)
23905 (flyspell-delete-region-overlays beg end))
23906 (add-text-properties beg end '(org-no-flyspell t)))
23908 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23909 (eval-after-load "bookmark"
23910 '(if (boundp 'bookmark-after-jump-hook)
23911 ;; We can use the hook
23912 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23913 ;; Hook not available, use advice
23914 (defadvice bookmark-jump (after org-make-visible activate)
23915 "Make the position visible."
23916 (org-bookmark-jump-unhide))))
23918 ;; Make sure saveplace shows the location if it was hidden
23919 (eval-after-load "saveplace"
23920 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23921 "Make the position visible."
23922 (org-bookmark-jump-unhide)))
23924 ;; Make sure ecb shows the location if it was hidden
23925 (eval-after-load "ecb"
23926 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23927 "Make hierarchy visible when jumping into location from ECB tree buffer."
23928 (if (derived-mode-p 'org-mode)
23929 (org-show-context))))
23931 (defun org-bookmark-jump-unhide ()
23932 "Unhide the current position, to show the bookmark location."
23933 (and (derived-mode-p 'org-mode)
23934 (or (outline-invisible-p)
23935 (save-excursion (goto-char (max (point-min) (1- (point))))
23936 (outline-invisible-p)))
23937 (org-show-context 'bookmark-jump)))
23939 ;; Make session.el ignore our circular variable
23940 (defvar session-globals-exclude)
23941 (eval-after-load "session"
23942 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23944 ;;;; Finish up
23946 (provide 'org)
23948 (run-hooks 'org-load-hook)
23950 ;;; org.el ends here