Fix (wrong-type-argument listp org-link) error
[org-mode.git] / lisp / org.el
blob7676f6053a59b83bf01437bd984cd73785d0a288
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2016 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 (or (equal this-command 'eval-buffer)
81 (condition-case nil
82 (load (concat (file-name-directory load-file-name)
83 "org-loaddefs.el")
84 nil t t t)
85 (error
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
87 (sit-for 3)
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
89 (sit-for 3))))
91 (require 'org-macs)
92 (require 'org-compat)
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp "\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol "^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (unless (boundp 'calendar-view-holidays-initially-flag)
115 (org-defvaralias 'calendar-view-holidays-initially-flag
116 'view-calendar-holidays-initially))
117 (unless (boundp 'calendar-view-diary-initially-flag)
118 (org-defvaralias 'calendar-view-diary-initially-flag
119 'view-diary-entries-initially))
120 (unless (boundp 'diary-fancy-buffer)
121 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
123 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
124 (declare-function org-add-archive-files "org-archive" (files))
125 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
126 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
127 (declare-function org-agenda-redo "org-agenda" (&optional all))
128 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
129 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
130 (declare-function org-beamer-mode "ox-beamer" ())
131 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
132 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
133 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
134 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
135 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
136 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
137 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
138 (declare-function org-clock-update-time-maybe "org-clock" ())
139 (declare-function org-clocktable-shift "org-clock" (dir n))
140 (declare-function org-element-at-point "org-element" ())
141 (declare-function org-element-cache-refresh "org-element" (pos))
142 (declare-function org-element-cache-reset "org-element" (&optional all))
143 (declare-function org-element-contents "org-element" (element))
144 (declare-function org-element-context "org-element" (&optional element))
145 (declare-function org-element-copy "org-element" (datum))
146 (declare-function org-element-interpret-data "org-element" (data &optional parent))
147 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
148 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
149 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
150 (declare-function org-element-property "org-element" (property element))
151 (declare-function org-element-put-property "org-element" (element property value))
152 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
153 (declare-function org-element-type "org-element" (element))
154 (declare-function org-element-update-syntax "org-element" ())
155 (declare-function org-id-find-id-file "org-id" (id))
156 (declare-function org-id-get-create "org-id" (&optional force))
157 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
158 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
159 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
160 (declare-function org-plot/gnuplot "org-plot" (&optional params))
161 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
162 (declare-function org-table-align "org-table" ())
163 (declare-function org-table-begin "org-table" (&optional table-type))
164 (declare-function org-table-beginning-of-field "org-table" (&optional n))
165 (declare-function org-table-blank-field "org-table" ())
166 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
167 (declare-function org-table-edit-field "org-table" (arg))
168 (declare-function org-table-end "org-table" (&optional table-type))
169 (declare-function org-table-end-of-field "org-table" (&optional n))
170 (declare-function org-table-insert-row "org-table" (&optional arg))
171 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
172 (declare-function org-table-maybe-eval-formula "org-table" ())
173 (declare-function org-table-maybe-recalculate-line "org-table" ())
174 (declare-function org-table-next-row "org-table" ())
175 (declare-function org-table-paste-rectangle "org-table" ())
176 (declare-function org-table-wrap-region "org-table" (arg))
177 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
178 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
179 (declare-function orgtbl-mode "org-table" (&optional arg))
181 (defsubst org-uniquify (list)
182 "Non-destructively remove duplicate elements from LIST."
183 (let ((res (copy-sequence list))) (delete-dups res)))
185 (defsubst org-get-at-bol (property)
186 "Get text property PROPERTY at the beginning of line."
187 (get-text-property (point-at-bol) property))
189 (defsubst org-trim (s)
190 "Remove whitespace at the beginning and the end of string S."
191 (replace-regexp-in-string
192 "\\`[ \t\n\r]+" ""
193 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
195 ;; load languages based on value of `org-babel-load-languages'
196 (defvar org-babel-load-languages)
198 ;;;###autoload
199 (defun org-babel-do-load-languages (sym value)
200 "Load the languages defined in `org-babel-load-languages'."
201 (set-default sym value)
202 (mapc (lambda (pair)
203 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
204 (if active
205 (progn
206 (require (intern (concat "ob-" lang))))
207 (progn
208 (funcall 'fmakunbound
209 (intern (concat "org-babel-execute:" lang)))
210 (funcall 'fmakunbound
211 (intern (concat "org-babel-expand-body:" lang)))))))
212 org-babel-load-languages))
214 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
215 ;;;###autoload
216 (defun org-babel-load-file (file &optional compile)
217 "Load Emacs Lisp source code blocks in the Org-mode FILE.
218 This function exports the source code using `org-babel-tangle'
219 and then loads the resulting file using `load-file'. With prefix
220 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
221 file to byte-code before it is loaded."
222 (interactive "fFile to load: \nP")
223 (let* ((age (lambda (file)
224 (float-time
225 (time-subtract (current-time)
226 (nth 5 (or (file-attributes (file-truename file))
227 (file-attributes file)))))))
228 (base-name (file-name-sans-extension file))
229 (exported-file (concat base-name ".el")))
230 ;; tangle if the org-mode file is newer than the elisp file
231 (unless (and (file-exists-p exported-file)
232 (> (funcall age file) (funcall age exported-file)))
233 ;; Tangle-file traversal returns reversed list of tangled files
234 ;; and we want to evaluate the first target.
235 (setq exported-file
236 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
237 (message "%s %s"
238 (if compile
239 (progn (byte-compile-file exported-file 'load)
240 "Compiled and loaded")
241 (progn (load-file exported-file) "Loaded"))
242 exported-file)))
244 (defcustom org-babel-load-languages '((emacs-lisp . t))
245 "Languages which can be evaluated in Org-mode buffers.
246 This list can be used to load support for any of the languages
247 below, note that each language will depend on a different set of
248 system executables and/or Emacs modes. When a language is
249 \"loaded\", then code blocks in that language can be evaluated
250 with `org-babel-execute-src-block' bound by default to C-c
251 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
252 be set to remove code block evaluation from the C-c C-c
253 keybinding. By default only Emacs Lisp (which has no
254 requirements) is loaded."
255 :group 'org-babel
256 :set 'org-babel-do-load-languages
257 :version "24.1"
258 :type '(alist :tag "Babel Languages"
259 :key-type
260 (choice
261 (const :tag "Awk" awk)
262 (const :tag "C" C)
263 (const :tag "R" R)
264 (const :tag "Asymptote" asymptote)
265 (const :tag "Calc" calc)
266 (const :tag "Clojure" clojure)
267 (const :tag "CSS" css)
268 (const :tag "Ditaa" ditaa)
269 (const :tag "Dot" dot)
270 (const :tag "Emacs Lisp" emacs-lisp)
271 (const :tag "Forth" forth)
272 (const :tag "Fortran" fortran)
273 (const :tag "Gnuplot" gnuplot)
274 (const :tag "Haskell" haskell)
275 (const :tag "IO" io)
276 (const :tag "J" J)
277 (const :tag "Java" java)
278 (const :tag "Javascript" js)
279 (const :tag "LaTeX" latex)
280 (const :tag "Ledger" ledger)
281 (const :tag "Lilypond" lilypond)
282 (const :tag "Lisp" lisp)
283 (const :tag "Makefile" makefile)
284 (const :tag "Maxima" maxima)
285 (const :tag "Matlab" matlab)
286 (const :tag "Mscgen" mscgen)
287 (const :tag "Ocaml" ocaml)
288 (const :tag "Octave" octave)
289 (const :tag "Org" org)
290 (const :tag "Perl" perl)
291 (const :tag "Pico Lisp" picolisp)
292 (const :tag "PlantUML" plantuml)
293 (const :tag "Python" python)
294 (const :tag "Ruby" ruby)
295 (const :tag "Sass" sass)
296 (const :tag "Scala" scala)
297 (const :tag "Scheme" scheme)
298 (const :tag "Screen" screen)
299 (const :tag "Shell Script" shell)
300 (const :tag "Shen" shen)
301 (const :tag "Sql" sql)
302 (const :tag "Sqlite" sqlite)
303 (const :tag "ebnf2ps" ebnf2ps))
304 :value-type (boolean :tag "Activate" :value t)))
306 ;;;; Customization variables
307 (defcustom org-clone-delete-id nil
308 "Remove ID property of clones of a subtree.
309 When non-nil, clones of a subtree don't inherit the ID property.
310 Otherwise they inherit the ID property with a new unique
311 identifier."
312 :type 'boolean
313 :version "24.1"
314 :group 'org-id)
316 ;;; Version
317 (org-check-version)
319 ;;;###autoload
320 (defun org-version (&optional here full message)
321 "Show the org-mode version.
322 Interactively, or when MESSAGE is non-nil, show it in echo area.
323 With prefix argument, or when HERE is non-nil, insert it at point.
324 In non-interactive uses, a reduced version string is output unless
325 FULL is given."
326 (interactive (list current-prefix-arg t (not current-prefix-arg)))
327 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
328 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
329 (load-suffixes (list ".el"))
330 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
331 (org-trash (or
332 (and (fboundp 'org-release) (fboundp 'org-git-version))
333 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
334 (load-suffixes save-load-suffixes)
335 (org-version (org-release))
336 (git-version (org-git-version))
337 (version (format "Org-mode version %s (%s @ %s)"
338 org-version
339 git-version
340 (if org-install-dir
341 (if (string= org-dir org-install-dir)
342 org-install-dir
343 (concat "mixed installation! " org-install-dir " and " org-dir))
344 "org-loaddefs.el can not be found!")))
345 (version1 (if full version org-version)))
346 (when here (insert version1))
347 (when message (message "%s" version1))
348 version1))
350 (defconst org-version (org-version))
353 ;;; Syntax Constants
355 ;;;; Block
357 (defconst org-block-regexp
358 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
359 "Regular expression for hiding blocks.")
361 (defconst org-dblock-start-re
362 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
363 "Matches the start line of a dynamic block, with parameters.")
365 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
366 "Matches the end of a dynamic block.")
368 ;;;; Clock and Planning
370 (defconst org-clock-string "CLOCK:"
371 "String used as prefix for timestamps clocking work hours on an item.")
373 (defvar org-closed-string "CLOSED:"
374 "String used as the prefix for timestamps logging closing a TODO entry.")
376 (defvar org-deadline-string "DEADLINE:"
377 "String to mark deadline entries.
378 A deadline is this string, followed by a time stamp. Should be a word,
379 terminated by a colon. You can insert a schedule keyword and
380 a timestamp with \\[org-deadline].")
382 (defvar org-scheduled-string "SCHEDULED:"
383 "String to mark scheduled TODO entries.
384 A schedule is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-schedule].")
388 (defconst org-ds-keyword-length
389 (+ 2
390 (apply #'max
391 (mapcar #'length
392 (list org-deadline-string org-scheduled-string
393 org-clock-string org-closed-string))))
394 "Maximum length of the DEADLINE and SCHEDULED keywords.")
396 (defconst org-planning-line-re
397 (concat "^[ \t]*"
398 (regexp-opt
399 (list org-closed-string org-deadline-string org-scheduled-string)
401 "Matches a line with planning info.
402 Matched keyword is in group 1.")
404 (defconst org-clock-line-re
405 (concat "^[ \t]*" org-clock-string)
406 "Matches a line with clock info.")
408 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
409 "Matches the DEADLINE keyword.")
411 (defconst org-deadline-time-regexp
412 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
413 "Matches the DEADLINE keyword together with a time stamp.")
415 (defconst org-deadline-time-hour-regexp
416 (concat "\\<" org-deadline-string
417 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
418 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
420 (defconst org-deadline-line-regexp
421 (concat "\\<\\(" org-deadline-string "\\).*")
422 "Matches the DEADLINE keyword and the rest of the line.")
424 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
425 "Matches the SCHEDULED keyword.")
427 (defconst org-scheduled-time-regexp
428 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
429 "Matches the SCHEDULED keyword together with a time stamp.")
431 (defconst org-scheduled-time-hour-regexp
432 (concat "\\<" org-scheduled-string
433 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
434 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
436 (defconst org-closed-time-regexp
437 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
438 "Matches the CLOSED keyword together with a time stamp.")
440 (defconst org-keyword-time-regexp
441 (concat "\\<"
442 (regexp-opt
443 (list org-scheduled-string org-deadline-string org-closed-string
444 org-clock-string)
446 " *[[<]\\([^]>]+\\)[]>]")
447 "Matches any of the 4 keywords, together with the time stamp.")
449 (defconst org-keyword-time-not-clock-regexp
450 (concat
451 "\\<"
452 (regexp-opt
453 (list org-scheduled-string org-deadline-string org-closed-string) t)
454 " *[[<]\\([^]>]+\\)[]>]")
455 "Matches any of the 3 keywords, together with the time stamp.")
457 (defconst org-maybe-keyword-time-regexp
458 (concat "\\(\\<"
459 (regexp-opt
460 (list org-scheduled-string org-deadline-string org-closed-string
461 org-clock-string)
463 "\\)?"
464 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
465 "\\|"
466 "<%%([^\r\n>]*>\\)")
467 "Matches a timestamp, possibly preceded by a keyword.")
469 (defconst org-all-time-keywords
470 (mapcar (lambda (w) (substring w 0 -1))
471 (list org-scheduled-string org-deadline-string
472 org-clock-string org-closed-string))
473 "List of time keywords.")
475 ;;;; Drawer
477 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
478 "Matches first or last line of a hidden block.
479 Group 1 contains drawer's name or \"END\".")
481 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
482 "Regular expression matching the first line of a property drawer.")
484 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
485 "Regular expression matching the last line of a property drawer.")
487 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
488 "Regular expression matching the first line of a clock drawer.")
490 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a clock drawer.")
493 (defconst org-property-drawer-re
494 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
495 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*?"
496 "[ \t]*:END:[ \t]*$")
497 "Matches an entire property drawer.")
499 (defconst org-clock-drawer-re
500 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
501 org-clock-drawer-end-re "\\)\n?")
502 "Matches an entire clock drawer.")
504 ;;;; Headline
506 (defconst org-heading-keyword-regexp-format
507 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
508 "Printf format for a regexp matching a headline with some keyword.
509 This regexp will match the headline of any node which has the
510 exact keyword that is put into the format. The keyword isn't in
511 any group by default, but the stars and the body are.")
513 (defconst org-heading-keyword-maybe-regexp-format
514 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
515 "Printf format for a regexp matching a headline, possibly with some keyword.
516 This regexp can match any headline with the specified keyword, or
517 without a keyword. The keyword isn't in any group by default,
518 but the stars and the body are.")
520 (defconst org-archive-tag "ARCHIVE"
521 "The tag that marks a subtree as archived.
522 An archived subtree does not open during visibility cycling, and does
523 not contribute to the agenda listings.")
525 (defconst org-comment-string "COMMENT"
526 "Entries starting with this keyword will never be exported.
527 An entry can be toggled between COMMENT and normal with
528 \\[org-toggle-comment].")
531 ;;;; LaTeX Environments and Fragments
533 (defconst org-latex-regexps
534 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
535 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
536 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
537 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
538 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
539 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
540 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
541 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
542 "Regular expressions for matching embedded LaTeX.")
544 ;;;; Node Property
546 (defconst org-effort-property "Effort"
547 "The property that is being used to keep track of effort estimates.
548 Effort estimates given in this property need to have the format H:MM.")
550 ;;;; Table
552 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
553 "Detect an org-type or table-type table.")
555 (defconst org-table-line-regexp "^[ \t]*|"
556 "Detect an org-type table line.")
558 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
559 "Detect an org-type table line.")
561 (defconst org-table-hline-regexp "^[ \t]*|-"
562 "Detect an org-type table hline.")
564 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
565 "Detect a table-type table hline.")
567 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
568 "Detect the first line outside a table when searching from within it.
569 This works for both table types.")
571 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
572 "Detect a #+TBLFM line.")
574 ;;;; Timestamp
576 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
577 "Regular expression for fast time stamp matching.")
579 (defconst org-ts-regexp-inactive
580 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
581 "Regular expression for fast inactive time stamp matching.")
583 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
584 "Regular expression for fast time stamp matching.")
586 (defconst org-ts-regexp0
587 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
588 "Regular expression matching time strings for analysis.
589 This one does not require the space after the date, so it can be used
590 on a string that terminates immediately after the date.")
592 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
593 "Regular expression matching time strings for analysis.")
595 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
596 "Regular expression matching time stamps, with groups.")
598 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
599 "Regular expression matching time stamps (also [..]), with groups.")
601 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
602 "Regular expression matching a time stamp range.")
604 (defconst org-tr-regexp-both
605 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
606 "Regular expression matching a time stamp range.")
608 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
609 org-ts-regexp "\\)?")
610 "Regular expression matching a time stamp or time stamp range.")
612 (defconst org-tsr-regexp-both
613 (concat org-ts-regexp-both "\\(--?-?"
614 org-ts-regexp-both "\\)?")
615 "Regular expression matching a time stamp or time stamp range.
616 The time stamps may be either active or inactive.")
618 (defconst org-repeat-re
619 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
620 "Regular expression for specifying repeated events.
621 After a match, group 1 contains the repeat expression.")
623 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
624 "Formats for `format-time-string' which are used for time stamps.")
627 ;;; The custom variables
629 (defgroup org nil
630 "Outline-based notes management and organizer."
631 :tag "Org"
632 :group 'outlines
633 :group 'calendar)
635 (defcustom org-mode-hook nil
636 "Mode hook for Org-mode, run after the mode was turned on."
637 :group 'org
638 :type 'hook)
640 (defcustom org-load-hook nil
641 "Hook that is run after org.el has been loaded."
642 :group 'org
643 :type 'hook)
645 (defcustom org-log-buffer-setup-hook nil
646 "Hook that is run after an Org log buffer is created."
647 :group 'org
648 :version "24.1"
649 :type 'hook)
651 (defvar org-modules) ; defined below
652 (defvar org-modules-loaded nil
653 "Have the modules been loaded already?")
655 (defun org-load-modules-maybe (&optional force)
656 "Load all extensions listed in `org-modules'."
657 (when (or force (not org-modules-loaded))
658 (mapc (lambda (ext)
659 (condition-case nil (require ext)
660 (error (message "Problems while trying to load feature `%s'" ext))))
661 org-modules)
662 (setq org-modules-loaded t)))
664 (defun org-set-modules (var value)
665 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
666 (set var value)
667 (when (featurep 'org)
668 (org-load-modules-maybe 'force)
669 (org-element-cache-reset 'all)))
671 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
672 "Modules that should always be loaded together with org.el.
674 If a description starts with <C>, the file is not part of Emacs
675 and loading it will require that you have downloaded and properly
676 installed the Org mode distribution.
678 You can also use this system to load external packages (i.e. neither Org
679 core modules, nor modules from the CONTRIB directory). Just add symbols
680 to the end of the list. If the package is called org-xyz.el, then you need
681 to add the symbol `xyz', and the package must have a call to:
683 (provide \\='org-xyz)
685 For export specific modules, see also `org-export-backends'."
686 :group 'org
687 :set 'org-set-modules
688 :version "24.4"
689 :package-version '(Org . "8.0")
690 :type
691 '(set :greedy t
692 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
693 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
694 (const :tag " crypt: Encryption of subtrees" org-crypt)
695 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
696 (const :tag " docview: Links to doc-view buffers" org-docview)
697 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
698 (const :tag " habit: Track your consistency with habits" org-habit)
699 (const :tag " id: Global IDs for identifying entries" org-id)
700 (const :tag " info: Links to Info nodes" org-info)
701 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
702 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
703 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
704 (const :tag " mouse: Additional mouse support" org-mouse)
705 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
706 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
707 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
709 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
710 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
711 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
712 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
713 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
714 (const :tag "C collector: Collect properties into tables" org-collector)
715 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
716 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
717 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
718 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
719 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
720 (const :tag "C eval: Include command output as text" org-eval)
721 (const :tag "C eww: Store link to url of eww" org-eww)
722 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
723 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
724 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
725 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
726 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
727 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
728 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
729 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
730 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
731 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
732 (const :tag "C mew: Links to Mew folders/messages" org-mew)
733 (const :tag "C mtags: Support for muse-like tags" org-mtags)
734 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
735 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
736 (const :tag "C registry: A registry for Org-mode links" org-registry)
737 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
738 (const :tag "C secretary: Team management with org-mode" org-secretary)
739 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
740 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
741 (const :tag "C track: Keep up with Org-mode development" org-track)
742 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
743 (const :tag "C vm: Links to VM folders/messages" org-vm)
744 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
745 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
746 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
748 (defvar org-export-registered-backends) ; From ox.el.
749 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
750 (declare-function org-export-backend-name "ox" (backend))
751 (defcustom org-export-backends '(ascii html icalendar latex)
752 "List of export back-ends that should be always available.
754 If a description starts with <C>, the file is not part of Emacs
755 and loading it will require that you have downloaded and properly
756 installed the Org mode distribution.
758 Unlike to `org-modules', libraries in this list will not be
759 loaded along with Org, but only once the export framework is
760 needed.
762 This variable needs to be set before org.el is loaded. If you
763 need to make a change while Emacs is running, use the customize
764 interface or run the following code, where VAL stands for the new
765 value of the variable, after updating it:
767 (progn
768 (setq org-export-registered-backends
769 (org-remove-if-not
770 (lambda (backend)
771 (let ((name (org-export-backend-name backend)))
772 (or (memq name val)
773 (catch \\='parentp
774 (dolist (b val)
775 (and (org-export-derived-backend-p b name)
776 (throw \\='parentp t)))))))
777 org-export-registered-backends))
778 (let ((new-list (mapcar #\\='org-export-backend-name
779 org-export-registered-backends)))
780 (dolist (backend val)
781 (cond
782 ((not (load (format \"ox-%s\" backend) t t))
783 (message \"Problems while trying to load export back-end \\=`%s\\='\"
784 backend))
785 ((not (memq backend new-list)) (push backend new-list))))
786 (set-default \\='org-export-backends new-list)))
788 Adding a back-end to this list will also pull the back-end it
789 depends on, if any."
790 :group 'org
791 :group 'org-export
792 :version "24.4"
793 :package-version '(Org . "8.0")
794 :initialize 'custom-initialize-set
795 :set (lambda (var val)
796 (if (not (featurep 'ox)) (set-default var val)
797 ;; Any back-end not required anymore (not present in VAL and not
798 ;; a parent of any back-end in the new value) is removed from the
799 ;; list of registered back-ends.
800 (setq org-export-registered-backends
801 (org-remove-if-not
802 (lambda (backend)
803 (let ((name (org-export-backend-name backend)))
804 (or (memq name val)
805 (catch 'parentp
806 (dolist (b val)
807 (and (org-export-derived-backend-p b name)
808 (throw 'parentp t)))))))
809 org-export-registered-backends))
810 ;; Now build NEW-LIST of both new back-ends and required
811 ;; parents.
812 (let ((new-list (mapcar #'org-export-backend-name
813 org-export-registered-backends)))
814 (dolist (backend val)
815 (cond
816 ((not (load (format "ox-%s" backend) t t))
817 (message "Problems while trying to load export back-end `%s'"
818 backend))
819 ((not (memq backend new-list)) (push backend new-list))))
820 ;; Set VAR to that list with fixed dependencies.
821 (set-default var new-list))))
822 :type '(set :greedy t
823 (const :tag " ascii Export buffer to ASCII format" ascii)
824 (const :tag " beamer Export buffer to Beamer presentation" beamer)
825 (const :tag " html Export buffer to HTML format" html)
826 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
827 (const :tag " latex Export buffer to LaTeX format" latex)
828 (const :tag " man Export buffer to MAN format" man)
829 (const :tag " md Export buffer to Markdown format" md)
830 (const :tag " odt Export buffer to ODT format" odt)
831 (const :tag " org Export buffer to Org format" org)
832 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
833 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
834 (const :tag "C deck Export buffer to deck.js presentations" deck)
835 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
836 (const :tag "C groff Export buffer to Groff format" groff)
837 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
838 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
839 (const :tag "C s5 Export buffer to s5 presentations" s5)
840 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
842 (eval-after-load 'ox
843 '(mapc
844 (lambda (backend)
845 (condition-case nil (require (intern (format "ox-%s" backend)))
846 (error (message "Problems while trying to load export back-end `%s'"
847 backend))))
848 org-export-backends))
850 (defcustom org-support-shift-select nil
851 "Non-nil means make shift-cursor commands select text when possible.
852 \\<org-mode-map>\
854 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
855 start selecting a region, or enlarge regions started in this way.
856 In Org-mode, in special contexts, these same keys are used for
857 other purposes, important enough to compete with shift selection.
858 Org tries to balance these needs by supporting `shift-select-mode'
859 outside these special contexts, under control of this variable.
861 The default of this variable is nil, to avoid confusing behavior. Shifted
862 cursor keys will then execute Org commands in the following contexts:
863 - on a headline, changing TODO state (left/right) and priority (up/down)
864 - on a time stamp, changing the time
865 - in a plain list item, changing the bullet type
866 - in a property definition line, switching between allowed values
867 - in the BEGIN line of a clock table (changing the time block).
868 Outside these contexts, the commands will throw an error.
870 When this variable is t and the cursor is not in a special
871 context, Org-mode will support shift-selection for making and
872 enlarging regions. To make this more effective, the bullet
873 cycling will no longer happen anywhere in an item line, but only
874 if the cursor is exactly on the bullet.
876 If you set this variable to the symbol `always', then the keys
877 will not be special in headlines, property lines, and item lines,
878 to make shift selection work there as well. If this is what you
879 want, you can use the following alternative commands:
880 `\\[org-todo]' and `\\[org-priority]' \
881 to change TODO state and priority,
882 `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
883 can be used to switch TODO sets,
884 `\\[org-ctrl-c-minus]' to cycle item bullet types,
885 and properties can be edited by hand or in column view.
887 However, when the cursor is on a timestamp, shift-cursor commands
888 will still edit the time stamp - this is just too good to give up.
890 XEmacs user should have this variable set to nil, because
891 `shift-select-mode' is in Emacs 23 or later only."
892 :group 'org
893 :type '(choice
894 (const :tag "Never" nil)
895 (const :tag "When outside special context" t)
896 (const :tag "Everywhere except timestamps" always)))
898 (defcustom org-loop-over-headlines-in-active-region nil
899 "Shall some commands act upon headlines in the active region?
901 When set to t, some commands will be performed in all headlines
902 within the active region.
904 When set to `start-level', some commands will be performed in all
905 headlines within the active region, provided that these headlines
906 are of the same level than the first one.
908 When set to a string, those commands will be performed on the
909 matching headlines within the active region. Such string must be
910 a tags/property/todo match as it is used in the agenda tags view.
912 The list of commands is: `org-schedule', `org-deadline',
913 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
914 `org-archive-to-archive-sibling'. The archiving commands skip
915 already archived entries."
916 :type '(choice (const :tag "Don't loop" nil)
917 (const :tag "All headlines in active region" t)
918 (const :tag "In active region, headlines at the same level than the first one" start-level)
919 (string :tag "Tags/Property/Todo matcher"))
920 :version "24.1"
921 :group 'org-todo
922 :group 'org-archive)
924 (defgroup org-startup nil
925 "Options concerning startup of Org-mode."
926 :tag "Org Startup"
927 :group 'org)
929 (defcustom org-startup-folded t
930 "Non-nil means entering Org-mode will switch to OVERVIEW.
931 This can also be configured on a per-file basis by adding one of
932 the following lines anywhere in the buffer:
934 #+STARTUP: fold (or `overview', this is equivalent)
935 #+STARTUP: nofold (or `showall', this is equivalent)
936 #+STARTUP: content
937 #+STARTUP: showeverything
939 By default, this option is ignored when Org opens agenda files
940 for the first time. If you want the agenda to honor the startup
941 option, set `org-agenda-inhibit-startup' to nil."
942 :group 'org-startup
943 :type '(choice
944 (const :tag "nofold: show all" nil)
945 (const :tag "fold: overview" t)
946 (const :tag "content: all headlines" content)
947 (const :tag "show everything, even drawers" showeverything)))
949 (defcustom org-startup-truncated t
950 "Non-nil means entering Org-mode will set `truncate-lines'.
951 This is useful since some lines containing links can be very long and
952 uninteresting. Also tables look terrible when wrapped."
953 :group 'org-startup
954 :type 'boolean)
956 (defcustom org-startup-indented nil
957 "Non-nil means turn on `org-indent-mode' on startup.
958 This can also be configured on a per-file basis by adding one of
959 the following lines anywhere in the buffer:
961 #+STARTUP: indent
962 #+STARTUP: noindent"
963 :group 'org-structure
964 :type '(choice
965 (const :tag "Not" nil)
966 (const :tag "Globally (slow on startup in large files)" t)))
968 (defcustom org-use-sub-superscripts t
969 "Non-nil means interpret \"_\" and \"^\" for display.
971 If you want to control how Org exports those characters, see
972 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
973 used to be an alias for `org-export-with-sub-superscripts' in
974 Org <8.0, it is not anymore.
976 When this option is turned on, you can use TeX-like syntax for
977 sub- and superscripts within the buffer. Several characters after
978 \"_\" or \"^\" will be considered as a single item - so grouping
979 with {} is normally not needed. For example, the following things
980 will be parsed as single sub- or superscripts:
982 10^24 or 10^tau several digits will be considered 1 item.
983 10^-12 or 10^-tau a leading sign with digits or a word
984 x^2-y^3 will be read as x^2 - y^3, because items are
985 terminated by almost any nonword/nondigit char.
986 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
988 Still, ambiguity is possible. So when in doubt, use {} to enclose
989 the sub/superscript. If you set this variable to the symbol `{}',
990 the braces are *required* in order to trigger interpretations as
991 sub/superscript. This can be helpful in documents that need \"_\"
992 frequently in plain text."
993 :group 'org-startup
994 :version "24.4"
995 :package-version '(Org . "8.0")
996 :type '(choice
997 (const :tag "Always interpret" t)
998 (const :tag "Only with braces" {})
999 (const :tag "Never interpret" nil)))
1001 (defcustom org-startup-with-beamer-mode nil
1002 "Non-nil means turn on `org-beamer-mode' on startup.
1003 This can also be configured on a per-file basis by adding one of
1004 the following lines anywhere in the buffer:
1006 #+STARTUP: beamer"
1007 :group 'org-startup
1008 :version "24.1"
1009 :type 'boolean)
1011 (defcustom org-startup-align-all-tables nil
1012 "Non-nil means align all tables when visiting a file.
1013 This is useful when the column width in tables is forced with <N> cookies
1014 in table fields. Such tables will look correct only after the first re-align.
1015 This can also be configured on a per-file basis by adding one of
1016 the following lines anywhere in the buffer:
1017 #+STARTUP: align
1018 #+STARTUP: noalign"
1019 :group 'org-startup
1020 :type 'boolean)
1022 (defcustom org-startup-with-inline-images nil
1023 "Non-nil means show inline images when loading a new Org file.
1024 This can also be configured on a per-file basis by adding one of
1025 the following lines anywhere in the buffer:
1026 #+STARTUP: inlineimages
1027 #+STARTUP: noinlineimages"
1028 :group 'org-startup
1029 :version "24.1"
1030 :type 'boolean)
1032 (defcustom org-startup-with-latex-preview nil
1033 "Non-nil means preview LaTeX fragments when loading a new Org file.
1035 This can also be configured on a per-file basis by adding one of
1036 the following lines anywhere in the buffer:
1037 #+STARTUP: latexpreview
1038 #+STARTUP: nolatexpreview"
1039 :group 'org-startup
1040 :version "24.4"
1041 :package-version '(Org . "8.0")
1042 :type 'boolean)
1044 (defcustom org-insert-mode-line-in-empty-file nil
1045 "Non-nil means insert the first line setting Org-mode in empty files.
1046 When the function `org-mode' is called interactively in an empty file, this
1047 normally means that the file name does not automatically trigger Org-mode.
1048 To ensure that the file will always be in Org-mode in the future, a
1049 line enforcing Org-mode will be inserted into the buffer, if this option
1050 has been set."
1051 :group 'org-startup
1052 :type 'boolean)
1054 (defcustom org-replace-disputed-keys nil
1055 "Non-nil means use alternative key bindings for some keys.
1056 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1057 These keys are also used by other packages like shift-selection-mode'
1058 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1059 If you want to use Org-mode together with one of these other modes,
1060 or more generally if you would like to move some Org-mode commands to
1061 other keys, set this variable and configure the keys with the variable
1062 `org-disputed-keys'.
1064 This option is only relevant at load-time of Org-mode, and must be set
1065 *before* org.el is loaded. Changing it requires a restart of Emacs to
1066 become effective."
1067 :group 'org-startup
1068 :type 'boolean)
1070 (defcustom org-use-extra-keys nil
1071 "Non-nil means use extra key sequence definitions for certain commands.
1072 This happens automatically if you run XEmacs or if `window-system'
1073 is nil. This variable lets you do the same manually. You must
1074 set it before loading org.
1076 Example: on Carbon Emacs 22 running graphically, with an external
1077 keyboard on a Powerbook, the default way of setting M-left might
1078 not work for either Alt or ESC. Setting this variable will make
1079 it work for ESC."
1080 :group 'org-startup
1081 :type 'boolean)
1083 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1085 (defcustom org-disputed-keys
1086 '(([(shift up)] . [(meta p)])
1087 ([(shift down)] . [(meta n)])
1088 ([(shift left)] . [(meta -)])
1089 ([(shift right)] . [(meta +)])
1090 ([(control shift right)] . [(meta shift +)])
1091 ([(control shift left)] . [(meta shift -)]))
1092 "Keys for which Org-mode and other modes compete.
1093 This is an alist, cars are the default keys, second element specifies
1094 the alternative to use when `org-replace-disputed-keys' is t.
1096 Keys can be specified in any syntax supported by `define-key'.
1097 The value of this option takes effect only at Org-mode's startup,
1098 therefore you'll have to restart Emacs to apply it after changing."
1099 :group 'org-startup
1100 :type 'alist)
1102 (defun org-key (key)
1103 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1104 Or return the original if not disputed.
1105 Also apply the translations defined in `org-xemacs-key-equivalents'."
1106 (when org-replace-disputed-keys
1107 (let* ((nkey (key-description key))
1108 (x (org-find-if (lambda (x)
1109 (equal (key-description (car x)) nkey))
1110 org-disputed-keys)))
1111 (setq key (if x (cdr x) key))))
1112 (when (featurep 'xemacs)
1113 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1114 key)
1116 (defun org-find-if (predicate seq)
1117 (catch 'exit
1118 (while seq
1119 (if (funcall predicate (car seq))
1120 (throw 'exit (car seq))
1121 (pop seq)))))
1123 (defun org-defkey (keymap key def)
1124 "Define a key, possibly translated, as returned by `org-key'."
1125 (define-key keymap (org-key key) def))
1127 (defcustom org-ellipsis nil
1128 "The ellipsis to use in the Org-mode outline.
1129 When nil, just use the standard three dots.
1130 When a string, use that string instead.
1131 When a face, use the standard 3 dots, but with the specified face.
1132 The change affects only Org-mode (which will then use its own display table).
1133 Changing this requires executing \\[org-mode] in a buffer to become
1134 effective."
1135 :group 'org-startup
1136 :type '(choice (const :tag "Default" nil)
1137 (face :tag "Face" :value org-warning)
1138 (string :tag "String" :value "...#")))
1140 (defvar org-display-table nil
1141 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1143 (defgroup org-keywords nil
1144 "Keywords in Org-mode."
1145 :tag "Org Keywords"
1146 :group 'org)
1148 (defcustom org-closed-keep-when-no-todo nil
1149 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1150 :group 'org-todo
1151 :group 'org-keywords
1152 :version "24.4"
1153 :package-version '(Org . "8.0")
1154 :type 'boolean)
1156 (defgroup org-structure nil
1157 "Options concerning the general structure of Org-mode files."
1158 :tag "Org Structure"
1159 :group 'org)
1161 (defgroup org-reveal-location nil
1162 "Options about how to make context of a location visible."
1163 :tag "Org Reveal Location"
1164 :group 'org-structure)
1166 (defcustom org-show-context-detail '((isearch . lineage)
1167 (bookmark-jump . lineage)
1168 (default . ancestors))
1169 "Alist between context and visibility span when revealing a location.
1171 \\<org-mode-map>Some actions may move point into invisible
1172 locations. As a consequence, Org always expose a neighborhood
1173 around point. How much is shown depends on the initial action,
1174 or context. Valid contexts are
1176 agenda when exposing an entry from the agenda
1177 org-goto when using the command `org-goto' (\\[org-goto])
1178 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1179 tags-tree when constructing a sparse tree based on tags matches
1180 link-search when exposing search matches associated with a link
1181 mark-goto when exposing the jump goal of a mark
1182 bookmark-jump when exposing a bookmark location
1183 isearch when exiting from an incremental search
1184 default default for all contexts not set explicitly
1186 Allowed visibility spans are
1188 minimal show current headline; if point is not on headline,
1189 also show entry
1191 local show current headline, entry and next headline
1193 ancestors show current headline and its direct ancestors; if
1194 point is not on headline, also show entry
1196 lineage show current headline, its direct ancestors and all
1197 their children; if point is not on headline, also show
1198 entry and first child
1200 tree show current headline, its direct ancestors and all
1201 their children; if point is not on headline, also show
1202 entry and all children
1204 canonical show current headline, its direct ancestors along with
1205 their entries and children; if point is not located on
1206 the headline, also show current entry and all children
1208 As special cases, a nil or t value means show all contexts in
1209 `minimal' or `canonical' view, respectively.
1211 Some views can make displayed information very compact, but also
1212 make it harder to edit the location of the match. In such
1213 a case, use the command `org-reveal' (\\[org-reveal]) to show
1214 more context."
1215 :group 'org-reveal-location
1216 :version "25.1"
1217 :package-version '(Org . "8.3")
1218 :type '(choice
1219 (const :tag "Canonical" t)
1220 (const :tag "Minimal" nil)
1221 (repeat :greedy t :tag "Individual contexts"
1222 (cons
1223 (choice :tag "Context"
1224 (const agenda)
1225 (const org-goto)
1226 (const occur-tree)
1227 (const tags-tree)
1228 (const link-search)
1229 (const mark-goto)
1230 (const bookmark-jump)
1231 (const isearch)
1232 (const default))
1233 (choice :tag "Detail level"
1234 (const minimal)
1235 (const local)
1236 (const ancestors)
1237 (const lineage)
1238 (const tree)
1239 (const canonical))))))
1241 (defcustom org-indirect-buffer-display 'other-window
1242 "How should indirect tree buffers be displayed?
1243 This applies to indirect buffers created with the commands
1244 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1245 Valid values are:
1246 current-window Display in the current window
1247 other-window Just display in another window.
1248 dedicated-frame Create one new frame, and re-use it each time.
1249 new-frame Make a new frame each time. Note that in this case
1250 previously-made indirect buffers are kept, and you need to
1251 kill these buffers yourself."
1252 :group 'org-structure
1253 :group 'org-agenda-windows
1254 :type '(choice
1255 (const :tag "In current window" current-window)
1256 (const :tag "In current frame, other window" other-window)
1257 (const :tag "Each time a new frame" new-frame)
1258 (const :tag "One dedicated frame" dedicated-frame)))
1260 (defcustom org-use-speed-commands nil
1261 "Non-nil means activate single letter commands at beginning of a headline.
1262 This may also be a function to test for appropriate locations where speed
1263 commands should be active.
1265 For example, to activate speed commands when the point is on any
1266 star at the beginning of the headline, you can do this:
1268 (setq org-use-speed-commands
1269 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1270 :group 'org-structure
1271 :type '(choice
1272 (const :tag "Never" nil)
1273 (const :tag "At beginning of headline stars" t)
1274 (function)))
1276 (defcustom org-speed-commands-user nil
1277 "Alist of additional speed commands.
1278 This list will be checked before `org-speed-commands-default'
1279 when the variable `org-use-speed-commands' is non-nil
1280 and when the cursor is at the beginning of a headline.
1281 The car if each entry is a string with a single letter, which must
1282 be assigned to `self-insert-command' in the global map.
1283 The cdr is either a command to be called interactively, a function
1284 to be called, or a form to be evaluated.
1285 An entry that is just a list with a single string will be interpreted
1286 as a descriptive headline that will be added when listing the speed
1287 commands in the Help buffer using the `?' speed command."
1288 :group 'org-structure
1289 :type '(repeat :value ("k" . ignore)
1290 (choice :value ("k" . ignore)
1291 (list :tag "Descriptive Headline" (string :tag "Headline"))
1292 (cons :tag "Letter and Command"
1293 (string :tag "Command letter")
1294 (choice
1295 (function)
1296 (sexp))))))
1298 (defcustom org-bookmark-names-plist
1299 '(:last-capture "org-capture-last-stored"
1300 :last-refile "org-refile-last-stored"
1301 :last-capture-marker "org-capture-last-stored-marker")
1302 "Names for bookmarks automatically set by some Org commands.
1303 This can provide strings as names for a number of bookmarks Org sets
1304 automatically. The following keys are currently implemented:
1305 :last-capture
1306 :last-capture-marker
1307 :last-refile
1308 When a key does not show up in the property list, the corresponding bookmark
1309 is not set."
1310 :group 'org-structure
1311 :type 'plist)
1313 (defgroup org-cycle nil
1314 "Options concerning visibility cycling in Org-mode."
1315 :tag "Org Cycle"
1316 :group 'org-structure)
1318 (defcustom org-cycle-skip-children-state-if-no-children t
1319 "Non-nil means skip CHILDREN state in entries that don't have any."
1320 :group 'org-cycle
1321 :type 'boolean)
1323 (defcustom org-cycle-max-level nil
1324 "Maximum level which should still be subject to visibility cycling.
1325 Levels higher than this will, for cycling, be treated as text, not a headline.
1326 When `org-odd-levels-only' is set, a value of N in this variable actually
1327 means 2N-1 stars as the limiting headline.
1328 When nil, cycle all levels.
1329 Note that the limiting level of cycling is also influenced by
1330 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1331 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1332 than its value."
1333 :group 'org-cycle
1334 :type '(choice
1335 (const :tag "No limit" nil)
1336 (integer :tag "Maximum level")))
1338 (defcustom org-hide-block-startup nil
1339 "Non-nil means entering Org-mode will fold all blocks.
1340 This can also be set in on a per-file basis with
1342 #+STARTUP: hideblocks
1343 #+STARTUP: showblocks"
1344 :group 'org-startup
1345 :group 'org-cycle
1346 :type 'boolean)
1348 (defcustom org-cycle-global-at-bob nil
1349 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1350 This makes it possible to do global cycling without having to use S-TAB or
1351 \\[universal-argument] TAB. For this special case to work, the first line
1352 of the buffer must not be a headline -- it may be empty or some other text.
1353 When used in this way, `org-cycle-hook' is disabled temporarily to make
1354 sure the cursor stays at the beginning of the buffer. When this option is
1355 nil, don't do anything special at the beginning of the buffer."
1356 :group 'org-cycle
1357 :type 'boolean)
1359 (defcustom org-cycle-level-after-item/entry-creation t
1360 "Non-nil means cycle entry level or item indentation in new empty entries.
1362 When the cursor is at the end of an empty headline, i.e., with only stars
1363 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1364 and then all possible ancestor states, before returning to the original state.
1365 This makes data entry extremely fast: M-RET to create a new headline,
1366 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1368 When the cursor is at the end of an empty plain list item, one TAB will
1369 make it a subitem, two or more tabs will back up to make this an item
1370 higher up in the item hierarchy."
1371 :group 'org-cycle
1372 :type 'boolean)
1374 (defcustom org-cycle-emulate-tab t
1375 "Where should `org-cycle' emulate TAB.
1376 nil Never
1377 white Only in completely white lines
1378 whitestart Only at the beginning of lines, before the first non-white char
1379 t Everywhere except in headlines
1380 exc-hl-bol Everywhere except at the start of a headline
1381 If TAB is used in a place where it does not emulate TAB, the current subtree
1382 visibility is cycled."
1383 :group 'org-cycle
1384 :type '(choice (const :tag "Never" nil)
1385 (const :tag "Only in completely white lines" white)
1386 (const :tag "Before first char in a line" whitestart)
1387 (const :tag "Everywhere except in headlines" t)
1388 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1390 (defcustom org-cycle-separator-lines 2
1391 "Number of empty lines needed to keep an empty line between collapsed trees.
1392 If you leave an empty line between the end of a subtree and the following
1393 headline, this empty line is hidden when the subtree is folded.
1394 Org-mode will leave (exactly) one empty line visible if the number of
1395 empty lines is equal or larger to the number given in this variable.
1396 So the default 2 means at least 2 empty lines after the end of a subtree
1397 are needed to produce free space between a collapsed subtree and the
1398 following headline.
1400 If the number is negative, and the number of empty lines is at least -N,
1401 all empty lines are shown.
1403 Special case: when 0, never leave empty lines in collapsed view."
1404 :group 'org-cycle
1405 :type 'integer)
1406 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1408 (defcustom org-pre-cycle-hook nil
1409 "Hook that is run before visibility cycling is happening.
1410 The function(s) in this hook must accept a single argument which indicates
1411 the new state that will be set right after running this hook. The
1412 argument is a symbol. Before a global state change, it can have the values
1413 `overview', `content', or `all'. Before a local state change, it can have
1414 the values `folded', `children', or `subtree'."
1415 :group 'org-cycle
1416 :type 'hook)
1418 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1419 org-cycle-hide-drawers
1420 org-cycle-show-empty-lines
1421 org-optimize-window-after-visibility-change)
1422 "Hook that is run after `org-cycle' has changed the buffer visibility.
1423 The function(s) in this hook must accept a single argument which indicates
1424 the new state that was set by the most recent `org-cycle' command. The
1425 argument is a symbol. After a global state change, it can have the values
1426 `overview', `contents', or `all'. After a local state change, it can have
1427 the values `folded', `children', or `subtree'."
1428 :group 'org-cycle
1429 :type 'hook
1430 :version "25.1"
1431 :package-version '(Org . "8.3"))
1433 (defgroup org-edit-structure nil
1434 "Options concerning structure editing in Org-mode."
1435 :tag "Org Edit Structure"
1436 :group 'org-structure)
1438 (defcustom org-odd-levels-only nil
1439 "Non-nil means skip even levels and only use odd levels for the outline.
1440 This has the effect that two stars are being added/taken away in
1441 promotion/demotion commands. It also influences how levels are
1442 handled by the exporters.
1443 Changing it requires restart of `font-lock-mode' to become effective
1444 for fontification also in regions already fontified.
1445 You may also set this on a per-file basis by adding one of the following
1446 lines to the buffer:
1448 #+STARTUP: odd
1449 #+STARTUP: oddeven"
1450 :group 'org-edit-structure
1451 :group 'org-appearance
1452 :type 'boolean)
1454 (defcustom org-adapt-indentation t
1455 "Non-nil means adapt indentation to outline node level.
1457 When this variable is set, Org assumes that you write outlines by
1458 indenting text in each node to align with the headline (after the
1459 stars). The following issues are influenced by this variable:
1461 - The indentation is increased by one space in a demotion
1462 command, and decreased by one in a promotion command. However,
1463 in the latter case, if shifting some line in the entry body
1464 would alter document structure (e.g., insert a new headline),
1465 indentation is not changed at all.
1467 - Property drawers and planning information is inserted indented
1468 when this variable is set. When nil, they will not be indented.
1470 - TAB indents a line relative to current level. The lines below
1471 a headline will be indented when this variable is set.
1473 Note that this is all about true indentation, by adding and
1474 removing space characters. See also `org-indent.el' which does
1475 level-dependent indentation in a virtual way, i.e. at display
1476 time in Emacs."
1477 :group 'org-edit-structure
1478 :type 'boolean)
1480 (defcustom org-special-ctrl-a/e nil
1481 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1483 When t, `C-a' will bring back the cursor to the beginning of the
1484 headline text, i.e. after the stars and after a possible TODO
1485 keyword. In an item, this will be the position after bullet and
1486 check-box, if any. When the cursor is already at that position,
1487 another `C-a' will bring it to the beginning of the line.
1489 `C-e' will jump to the end of the headline, ignoring the presence
1490 of tags in the headline. A second `C-e' will then jump to the
1491 true end of the line, after any tags. This also means that, when
1492 this variable is non-nil, `C-e' also will never jump beyond the
1493 end of the heading of a folded section, i.e. not after the
1494 ellipses.
1496 When set to the symbol `reversed', the first `C-a' or `C-e' works
1497 normally, going to the true line boundary first. Only a directly
1498 following, identical keypress will bring the cursor to the
1499 special positions.
1501 This may also be a cons cell where the behavior for `C-a' and
1502 `C-e' is set separately."
1503 :group 'org-edit-structure
1504 :type '(choice
1505 (const :tag "off" nil)
1506 (const :tag "on: after stars/bullet and before tags first" t)
1507 (const :tag "reversed: true line boundary first" reversed)
1508 (cons :tag "Set C-a and C-e separately"
1509 (choice :tag "Special C-a"
1510 (const :tag "off" nil)
1511 (const :tag "on: after stars/bullet first" t)
1512 (const :tag "reversed: before stars/bullet first" reversed))
1513 (choice :tag "Special C-e"
1514 (const :tag "off" nil)
1515 (const :tag "on: before tags first" t)
1516 (const :tag "reversed: after tags first" reversed)))))
1517 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1519 (defcustom org-special-ctrl-k nil
1520 "Non-nil means `C-k' will behave specially in headlines.
1521 When nil, `C-k' will call the default `kill-line' command.
1522 When t, the following will happen while the cursor is in the headline:
1524 - When the cursor is at the beginning of a headline, kill the entire
1525 line and possible the folded subtree below the line.
1526 - When in the middle of the headline text, kill the headline up to the tags.
1527 - When after the headline text, kill the tags."
1528 :group 'org-edit-structure
1529 :type 'boolean)
1531 (defcustom org-ctrl-k-protect-subtree nil
1532 "Non-nil means, do not delete a hidden subtree with C-k.
1533 When set to the symbol `error', simply throw an error when C-k is
1534 used to kill (part-of) a headline that has hidden text behind it.
1535 Any other non-nil value will result in a query to the user, if it is
1536 OK to kill that hidden subtree. When nil, kill without remorse."
1537 :group 'org-edit-structure
1538 :version "24.1"
1539 :type '(choice
1540 (const :tag "Do not protect hidden subtrees" nil)
1541 (const :tag "Protect hidden subtrees with a security query" t)
1542 (const :tag "Never kill a hidden subtree with C-k" error)))
1544 (defcustom org-special-ctrl-o t
1545 "Non-nil means, make `C-o' insert a row in tables."
1546 :group 'org-edit-structure
1547 :type 'boolean)
1549 (defcustom org-catch-invisible-edits nil
1550 "Check if in invisible region before inserting or deleting a character.
1551 Valid values are:
1553 nil Do not check, so just do invisible edits.
1554 error Throw an error and do nothing.
1555 show Make point visible, and do the requested edit.
1556 show-and-error Make point visible, then throw an error and abort the edit.
1557 smart Make point visible, and do insertion/deletion if it is
1558 adjacent to visible text and the change feels predictable.
1559 Never delete a previously invisible character or add in the
1560 middle or right after an invisible region. Basically, this
1561 allows insertion and backward-delete right before ellipses.
1562 FIXME: maybe in this case we should not even show?"
1563 :group 'org-edit-structure
1564 :version "24.1"
1565 :type '(choice
1566 (const :tag "Do not check" nil)
1567 (const :tag "Throw error when trying to edit" error)
1568 (const :tag "Unhide, but do not do the edit" show-and-error)
1569 (const :tag "Show invisible part and do the edit" show)
1570 (const :tag "Be smart and do the right thing" smart)))
1572 (defcustom org-yank-folded-subtrees t
1573 "Non-nil means when yanking subtrees, fold them.
1574 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1575 it starts with a heading and all other headings in it are either children
1576 or siblings, then fold all the subtrees. However, do this only if no
1577 text after the yank would be swallowed into a folded tree by this action."
1578 :group 'org-edit-structure
1579 :type 'boolean)
1581 (defcustom org-yank-adjusted-subtrees nil
1582 "Non-nil means when yanking subtrees, adjust the level.
1583 With this setting, `org-paste-subtree' is used to insert the subtree, see
1584 this function for details."
1585 :group 'org-edit-structure
1586 :type 'boolean)
1588 (defcustom org-M-RET-may-split-line '((default . t))
1589 "Non-nil means M-RET will split the line at the cursor position.
1590 When nil, it will go to the end of the line before making a
1591 new line.
1592 You may also set this option in a different way for different
1593 contexts. Valid contexts are:
1595 headline when creating a new headline
1596 item when creating a new item
1597 table in a table field
1598 default the value to be used for all contexts not explicitly
1599 customized"
1600 :group 'org-structure
1601 :group 'org-table
1602 :type '(choice
1603 (const :tag "Always" t)
1604 (const :tag "Never" nil)
1605 (repeat :greedy t :tag "Individual contexts"
1606 (cons
1607 (choice :tag "Context"
1608 (const headline)
1609 (const item)
1610 (const table)
1611 (const default))
1612 (boolean)))))
1615 (defcustom org-insert-heading-respect-content nil
1616 "Non-nil means insert new headings after the current subtree.
1617 When nil, the new heading is created directly after the current line.
1618 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1619 this variable on for the duration of the command."
1620 :group 'org-structure
1621 :type 'boolean)
1623 (defcustom org-blank-before-new-entry '((heading . auto)
1624 (plain-list-item . auto))
1625 "Should `org-insert-heading' leave a blank line before new heading/item?
1626 The value is an alist, with `heading' and `plain-list-item' as CAR,
1627 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1628 which case Org will look at the surrounding headings/items and try to
1629 make an intelligent decision whether to insert a blank line or not.
1631 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1632 the setting here is ignored and no empty line is inserted to avoid breaking
1633 the list structure."
1634 :group 'org-edit-structure
1635 :type '(list
1636 (cons (const heading)
1637 (choice (const :tag "Never" nil)
1638 (const :tag "Always" t)
1639 (const :tag "Auto" auto)))
1640 (cons (const plain-list-item)
1641 (choice (const :tag "Never" nil)
1642 (const :tag "Always" t)
1643 (const :tag "Auto" auto)))))
1645 (defcustom org-insert-heading-hook nil
1646 "Hook being run after inserting a new heading."
1647 :group 'org-edit-structure
1648 :type 'hook)
1650 (defcustom org-enable-fixed-width-editor t
1651 "Non-nil means lines starting with \":\" are treated as fixed-width.
1652 This currently only means they are never auto-wrapped.
1653 When nil, such lines will be treated like ordinary lines."
1654 :group 'org-edit-structure
1655 :type 'boolean)
1657 (defcustom org-goto-auto-isearch t
1658 "Non-nil means typing characters in `org-goto' starts incremental search.
1659 When nil, you can use these keybindings to navigate the buffer:
1661 q Quit the org-goto interface
1662 n Go to the next visible heading
1663 p Go to the previous visible heading
1664 f Go one heading forward on same level
1665 b Go one heading backward on same level
1666 u Go one heading up"
1667 :group 'org-edit-structure
1668 :type 'boolean)
1670 (defgroup org-sparse-trees nil
1671 "Options concerning sparse trees in Org-mode."
1672 :tag "Org Sparse Trees"
1673 :group 'org-structure)
1675 (defcustom org-highlight-sparse-tree-matches t
1676 "Non-nil means highlight all matches that define a sparse tree.
1677 The highlights will automatically disappear the next time the buffer is
1678 changed by an edit command."
1679 :group 'org-sparse-trees
1680 :type 'boolean)
1682 (defcustom org-remove-highlights-with-change t
1683 "Non-nil means any change to the buffer will remove temporary highlights.
1684 \\<org-mode-map>\
1685 Such highlights are created by `org-occur' and `org-clock-display'.
1686 When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
1687 to get rid of the highlights.
1688 The highlights created by `org-toggle-latex-fragment' always need
1689 `\\[org-toggle-latex-fragment]' to be removed."
1690 :group 'org-sparse-trees
1691 :group 'org-time
1692 :type 'boolean)
1695 (defcustom org-occur-hook '(org-first-headline-recenter)
1696 "Hook that is run after `org-occur' has constructed a sparse tree.
1697 This can be used to recenter the window to show as much of the structure
1698 as possible."
1699 :group 'org-sparse-trees
1700 :type 'hook)
1702 (defgroup org-imenu-and-speedbar nil
1703 "Options concerning imenu and speedbar in Org-mode."
1704 :tag "Org Imenu and Speedbar"
1705 :group 'org-structure)
1707 (defcustom org-imenu-depth 2
1708 "The maximum level for Imenu access to Org-mode headlines.
1709 This also applied for speedbar access."
1710 :group 'org-imenu-and-speedbar
1711 :type 'integer)
1713 (defgroup org-table nil
1714 "Options concerning tables in Org-mode."
1715 :tag "Org Table"
1716 :group 'org)
1718 (defcustom org-enable-table-editor 'optimized
1719 "Non-nil means lines starting with \"|\" are handled by the table editor.
1720 When nil, such lines will be treated like ordinary lines.
1722 When equal to the symbol `optimized', the table editor will be optimized to
1723 do the following:
1724 - Automatic overwrite mode in front of whitespace in table fields.
1725 This makes the structure of the table stay in tact as long as the edited
1726 field does not exceed the column width.
1727 - Minimize the number of realigns. Normally, the table is aligned each time
1728 TAB or RET are pressed to move to another field. With optimization this
1729 happens only if changes to a field might have changed the column width.
1730 Optimization requires replacing the functions `self-insert-command',
1731 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1732 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1733 very good at guessing when a re-align will be necessary, but you can always
1734 force one with \\[org-ctrl-c-ctrl-c].
1736 If you would like to use the optimized version in Org-mode, but the
1737 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1739 This variable can be used to turn on and off the table editor during a session,
1740 but in order to toggle optimization, a restart is required.
1742 See also the variable `org-table-auto-blank-field'."
1743 :group 'org-table
1744 :type '(choice
1745 (const :tag "off" nil)
1746 (const :tag "on" t)
1747 (const :tag "on, optimized" optimized)))
1749 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1750 (version<= emacs-version "24.1"))
1751 "Non-nil means cluster self-insert commands for undo when possible.
1752 If this is set, then, like in the Emacs command loop, 20 consecutive
1753 characters will be undone together.
1754 This is configurable, because there is some impact on typing performance."
1755 :group 'org-table
1756 :type 'boolean)
1758 (defcustom org-table-tab-recognizes-table.el t
1759 "Non-nil means TAB will automatically notice a table.el table.
1760 When it sees such a table, it moves point into it and - if necessary -
1761 calls `table-recognize-table'."
1762 :group 'org-table-editing
1763 :type 'boolean)
1765 (defgroup org-link nil
1766 "Options concerning links in Org-mode."
1767 :tag "Org Link"
1768 :group 'org)
1770 (defvar org-link-abbrev-alist-local nil
1771 "Buffer-local version of `org-link-abbrev-alist', which see.
1772 The value of this is taken from the #+LINK lines.")
1773 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1775 (defcustom org-link-abbrev-alist nil
1776 "Alist of link abbreviations.
1777 The car of each element is a string, to be replaced at the start of a link.
1778 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1779 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1781 [[linkkey:tag][description]]
1783 The `linkkey' must be a word word, starting with a letter, followed
1784 by letters, numbers, `-' or `_'.
1786 If REPLACE is a string, the tag will simply be appended to create the link.
1787 If the string contains \"%s\", the tag will be inserted there. If the string
1788 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1789 at that point (see the function `url-hexify-string'). If the string contains
1790 the specifier \"%(my-function)\", then the custom function `my-function' will
1791 be invoked: this function takes the tag as its only argument and must return
1792 a string.
1794 REPLACE may also be a function that will be called with the tag as the
1795 only argument to create the link, which should be returned as a string.
1797 See the manual for examples."
1798 :group 'org-link
1799 :type '(repeat
1800 (cons
1801 (string :tag "Protocol")
1802 (choice
1803 (string :tag "Format")
1804 (function)))))
1806 (defcustom org-descriptive-links t
1807 "Non-nil means Org will display descriptive links.
1808 E.g. [[http://orgmode.org][Org website]] will be displayed as
1809 \"Org Website\", hiding the link itself and just displaying its
1810 description. When set to nil, Org will display the full links
1811 literally.
1813 You can interactively set the value of this variable by calling
1814 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1815 :group 'org-link
1816 :type 'boolean)
1818 (defcustom org-link-file-path-type 'adaptive
1819 "How the path name in file links should be stored.
1820 Valid values are:
1822 relative Relative to the current directory, i.e. the directory of the file
1823 into which the link is being inserted.
1824 absolute Absolute path, if possible with ~ for home directory.
1825 noabbrev Absolute path, no abbreviation of home directory.
1826 adaptive Use relative path for files in the current directory and sub-
1827 directories of it. For other files, use an absolute path."
1828 :group 'org-link
1829 :type '(choice
1830 (const relative)
1831 (const absolute)
1832 (const noabbrev)
1833 (const adaptive)))
1835 (defvaralias 'org-activate-links 'org-highlight-links)
1836 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1837 "Types of links that should be highlighted in Org-mode files.
1839 This is a list of symbols, each one of them leading to the
1840 highlighting of a certain link type.
1842 You can still open links that are not highlighted.
1844 In principle, it does not hurt to turn on highlighting for all
1845 link types. There may be a small gain when turning off unused
1846 link types. The types are:
1848 bracket The recommended [[link][description]] or [[link]] links with hiding.
1849 angle Links in angular brackets that may contain whitespace like
1850 <bbdb:Carsten Dominik>.
1851 plain Plain links in normal text, no whitespace, like http://google.com.
1852 radio Text that is matched by a radio target, see manual for details.
1853 tag Tag settings in a headline (link to tag search).
1854 date Time stamps (link to calendar).
1855 footnote Footnote labels.
1857 If you set this variable during an Emacs session, use `org-mode-restart'
1858 in the Org buffer so that the change takes effect."
1859 :group 'org-link
1860 :group 'org-appearance
1861 :type '(set :greedy t
1862 (const :tag "Double bracket links" bracket)
1863 (const :tag "Angular bracket links" angle)
1864 (const :tag "Plain text links" plain)
1865 (const :tag "Radio target matches" radio)
1866 (const :tag "Tags" tag)
1867 (const :tag "Timestamps" date)
1868 (const :tag "Footnotes" footnote)))
1870 (defcustom org-make-link-description-function nil
1871 "Function to use for generating link descriptions from links.
1872 When nil, the link location will be used. This function must take
1873 two parameters: the first one is the link, the second one is the
1874 description generated by `org-insert-link'. The function should
1875 return the description to use."
1876 :group 'org-link
1877 :type '(choice (const nil) (function)))
1879 (defgroup org-link-store nil
1880 "Options concerning storing links in Org-mode."
1881 :tag "Org Store Link"
1882 :group 'org-link)
1884 (defcustom org-url-hexify-p t
1885 "When non-nil, hexify URL when creating a link."
1886 :type 'boolean
1887 :version "24.3"
1888 :group 'org-link-store)
1890 (defcustom org-email-link-description-format "Email %c: %.30s"
1891 "Format of the description part of a link to an email or usenet message.
1892 The following %-escapes will be replaced by corresponding information:
1894 %F full \"From\" field
1895 %f name, taken from \"From\" field, address if no name
1896 %T full \"To\" field
1897 %t first name in \"To\" field, address if no name
1898 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1899 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1900 %s subject
1901 %d date
1902 %m message-id.
1904 You may use normal field width specification between the % and the letter.
1905 This is for example useful to limit the length of the subject.
1907 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1908 :group 'org-link-store
1909 :type 'string)
1911 (defcustom org-from-is-user-regexp
1912 (let (r1 r2)
1913 (when (and user-mail-address (not (string= user-mail-address "")))
1914 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1915 (when (and user-full-name (not (string= user-full-name "")))
1916 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1917 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1918 "Regexp matched against the \"From:\" header of an email or usenet message.
1919 It should match if the message is from the user him/herself."
1920 :group 'org-link-store
1921 :type 'regexp)
1923 (defcustom org-context-in-file-links t
1924 "Non-nil means file links from `org-store-link' contain context.
1925 A search string will be added to the file name with :: as separator and
1926 used to find the context when the link is activated by the command
1927 `org-open-at-point'. When this option is t, the entire active region
1928 will be placed in the search string of the file link. If set to a
1929 positive integer, only the first n lines of context will be stored.
1931 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1932 negates this setting for the duration of the command."
1933 :group 'org-link-store
1934 :type '(choice boolean integer))
1936 (defcustom org-keep-stored-link-after-insertion nil
1937 "Non-nil means keep link in list for entire session.
1939 The command `org-store-link' adds a link pointing to the current
1940 location to an internal list. These links accumulate during a session.
1941 The command `org-insert-link' can be used to insert links into any
1942 Org-mode file (offering completion for all stored links). When this
1943 option is nil, every link which has been inserted once using \\[org-insert-link]
1944 will be removed from the list, to make completing the unused links
1945 more efficient."
1946 :group 'org-link-store
1947 :type 'boolean)
1949 (defgroup org-link-follow nil
1950 "Options concerning following links in Org-mode."
1951 :tag "Org Follow Link"
1952 :group 'org-link)
1954 (defcustom org-link-translation-function nil
1955 "Function to translate links with different syntax to Org syntax.
1956 This can be used to translate links created for example by the Planner
1957 or emacs-wiki packages to Org syntax.
1958 The function must accept two parameters, a TYPE containing the link
1959 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1960 which is everything after the link protocol. It should return a cons
1961 with possibly modified values of type and path.
1962 Org contains a function for this, so if you set this variable to
1963 `org-translate-link-from-planner', you should be able follow many
1964 links created by planner."
1965 :group 'org-link-follow
1966 :type '(choice (const nil) (function)))
1968 (defcustom org-follow-link-hook nil
1969 "Hook that is run after a link has been followed."
1970 :group 'org-link-follow
1971 :type 'hook)
1973 (defcustom org-tab-follows-link nil
1974 "Non-nil means on links TAB will follow the link.
1975 Needs to be set before org.el is loaded.
1976 This really should not be used, it does not make sense, and the
1977 implementation is bad."
1978 :group 'org-link-follow
1979 :type 'boolean)
1981 (defcustom org-return-follows-link nil
1982 "Non-nil means on links RET will follow the link.
1983 In tables, the special behavior of RET has precedence."
1984 :group 'org-link-follow
1985 :type 'boolean)
1987 (defcustom org-mouse-1-follows-link
1988 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1989 "Non-nil means mouse-1 on a link will follow the link.
1990 A longer mouse click will still set point. Does not work on XEmacs.
1991 Needs to be set before org.el is loaded."
1992 :group 'org-link-follow
1993 :version "24.4"
1994 :package-version '(Org . "8.3")
1995 :type '(choice
1996 (const :tag "A double click follows the link" double)
1997 (const :tag "Unconditionally follow the link with mouse-1" t)
1998 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2000 (defcustom org-mark-ring-length 4
2001 "Number of different positions to be recorded in the ring.
2002 Changing this requires a restart of Emacs to work correctly."
2003 :group 'org-link-follow
2004 :type 'integer)
2006 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2007 "Non-nil means internal links in Org files must exactly match a headline.
2008 When nil, the link search tries to match a phrase with all words
2009 in the search text."
2010 :group 'org-link-follow
2011 :version "24.1"
2012 :type '(choice
2013 (const :tag "Use fuzzy text search" nil)
2014 (const :tag "Match only exact headline" t)
2015 (const :tag "Match exact headline or query to create it"
2016 query-to-create)))
2018 (defcustom org-link-frame-setup
2019 '((vm . vm-visit-folder-other-frame)
2020 (vm-imap . vm-visit-imap-folder-other-frame)
2021 (gnus . org-gnus-no-new-news)
2022 (file . find-file-other-window)
2023 (wl . wl-other-frame))
2024 "Setup the frame configuration for following links.
2025 When following a link with Emacs, it may often be useful to display
2026 this link in another window or frame. This variable can be used to
2027 set this up for the different types of links.
2028 For VM, use any of
2029 `vm-visit-folder'
2030 `vm-visit-folder-other-window'
2031 `vm-visit-folder-other-frame'
2032 For Gnus, use any of
2033 `gnus'
2034 `gnus-other-frame'
2035 `org-gnus-no-new-news'
2036 For FILE, use any of
2037 `find-file'
2038 `find-file-other-window'
2039 `find-file-other-frame'
2040 For Wanderlust use any of
2041 `wl'
2042 `wl-other-frame'
2043 For the calendar, use the variable `calendar-setup'.
2044 For BBDB, it is currently only possible to display the matches in
2045 another window."
2046 :group 'org-link-follow
2047 :type '(list
2048 (cons (const vm)
2049 (choice
2050 (const vm-visit-folder)
2051 (const vm-visit-folder-other-window)
2052 (const vm-visit-folder-other-frame)))
2053 (cons (const vm-imap)
2054 (choice
2055 (const vm-visit-imap-folder)
2056 (const vm-visit-imap-folder-other-window)
2057 (const vm-visit-imap-folder-other-frame)))
2058 (cons (const gnus)
2059 (choice
2060 (const gnus)
2061 (const gnus-other-frame)
2062 (const org-gnus-no-new-news)))
2063 (cons (const file)
2064 (choice
2065 (const find-file)
2066 (const find-file-other-window)
2067 (const find-file-other-frame)))
2068 (cons (const wl)
2069 (choice
2070 (const wl)
2071 (const wl-other-frame)))))
2073 (defcustom org-display-internal-link-with-indirect-buffer nil
2074 "Non-nil means use indirect buffer to display infile links.
2075 Activating internal links (from one location in a file to another location
2076 in the same file) normally just jumps to the location. When the link is
2077 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2078 is displayed in
2079 another window. When this option is set, the other window actually displays
2080 an indirect buffer clone of the current buffer, to avoid any visibility
2081 changes to the current buffer."
2082 :group 'org-link-follow
2083 :type 'boolean)
2085 (defcustom org-open-non-existing-files nil
2086 "Non-nil means `org-open-file' will open non-existing files.
2087 When nil, an error will be generated.
2088 This variable applies only to external applications because they
2089 might choke on non-existing files. If the link is to a file that
2090 will be opened in Emacs, the variable is ignored."
2091 :group 'org-link-follow
2092 :type 'boolean)
2094 (defcustom org-open-directory-means-index-dot-org nil
2095 "Non-nil means a link to a directory really means to index.org.
2096 When nil, following a directory link will run dired or open a finder/explorer
2097 window on that directory."
2098 :group 'org-link-follow
2099 :type 'boolean)
2101 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2102 "Non-nil means ask for confirmation before executing shell links.
2103 Shell links can be dangerous: just think about a link
2105 [[shell:rm -rf ~/*][Google Search]]
2107 This link would show up in your Org-mode document as \"Google Search\",
2108 but really it would remove your entire home directory.
2109 Therefore we advise against setting this variable to nil.
2110 Just change it to `y-or-n-p' if you want to confirm with a
2111 single keystroke rather than having to type \"yes\"."
2112 :group 'org-link-follow
2113 :type '(choice
2114 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2115 (const :tag "with y-or-n (faster)" y-or-n-p)
2116 (const :tag "no confirmation (dangerous)" nil)))
2117 (put 'org-confirm-shell-link-function
2118 'safe-local-variable
2119 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2121 (defcustom org-confirm-shell-link-not-regexp ""
2122 "A regexp to skip confirmation for shell links."
2123 :group 'org-link-follow
2124 :version "24.1"
2125 :type 'regexp)
2127 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2128 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2129 Elisp links can be dangerous: just think about a link
2131 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2133 This link would show up in your Org-mode document as \"Google Search\",
2134 but really it would remove your entire home directory.
2135 Therefore we advise against setting this variable to nil.
2136 Just change it to `y-or-n-p' if you want to confirm with a
2137 single keystroke rather than having to type \"yes\"."
2138 :group 'org-link-follow
2139 :type '(choice
2140 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2141 (const :tag "with y-or-n (faster)" y-or-n-p)
2142 (const :tag "no confirmation (dangerous)" nil)))
2143 (put 'org-confirm-shell-link-function
2144 'safe-local-variable
2145 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2147 (defcustom org-confirm-elisp-link-not-regexp ""
2148 "A regexp to skip confirmation for Elisp links."
2149 :group 'org-link-follow
2150 :version "24.1"
2151 :type 'regexp)
2153 (defconst org-file-apps-defaults-gnu
2154 '((remote . emacs)
2155 (system . mailcap)
2156 (t . mailcap))
2157 "Default file applications on a UNIX or GNU/Linux system.
2158 See `org-file-apps'.")
2160 (defconst org-file-apps-defaults-macosx
2161 '((remote . emacs)
2162 (t . "open %s")
2163 (system . "open %s")
2164 ("ps.gz" . "gv %s")
2165 ("eps.gz" . "gv %s")
2166 ("dvi" . "xdvi %s")
2167 ("fig" . "xfig %s"))
2168 "Default file applications on a MacOS X system.
2169 The system \"open\" is known as a default, but we use X11 applications
2170 for some files for which the OS does not have a good default.
2171 See `org-file-apps'.")
2173 (defconst org-file-apps-defaults-windowsnt
2174 (list
2175 '(remote . emacs)
2176 (cons t
2177 (list (if (featurep 'xemacs)
2178 'mswindows-shell-execute
2179 'w32-shell-execute)
2180 "open" 'file))
2181 (cons 'system
2182 (list (if (featurep 'xemacs)
2183 'mswindows-shell-execute
2184 'w32-shell-execute)
2185 "open" 'file)))
2186 "Default file applications on a Windows NT system.
2187 The system \"open\" is used for most files.
2188 See `org-file-apps'.")
2190 (defcustom org-file-apps
2191 '((auto-mode . emacs)
2192 ("\\.mm\\'" . default)
2193 ("\\.x?html?\\'" . default)
2194 ("\\.pdf\\'" . default))
2195 "External applications for opening `file:path' items in a document.
2196 Org-mode uses system defaults for different file types, but
2197 you can use this variable to set the application for a given file
2198 extension. The entries in this list are cons cells where the car identifies
2199 files and the cdr the corresponding command. Possible values for the
2200 file identifier are
2201 \"string\" A string as a file identifier can be interpreted in different
2202 ways, depending on its contents:
2204 - Alphanumeric characters only:
2205 Match links with this file extension.
2206 Example: (\"pdf\" . \"evince %s\")
2207 to open PDFs with evince.
2209 - Regular expression: Match links where the
2210 filename matches the regexp. If you want to
2211 use groups here, use shy groups.
2213 Example: (\"\\.x?html\\\\='\" . \"firefox %s\")
2214 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2215 to open *.html and *.xhtml with firefox.
2217 - Regular expression which contains (non-shy) groups:
2218 Match links where the whole link, including \"::\", and
2219 anything after that, matches the regexp.
2220 In a custom command string, %1, %2, etc. are replaced with
2221 the parts of the link that were matched by the groups.
2222 For backwards compatibility, if a command string is given
2223 that does not use any of the group matches, this case is
2224 handled identically to the second one (i.e. match against
2225 file name only).
2226 In a custom lisp form, you can access the group matches with
2227 (match-string n link).
2229 Example: (\"\\.pdf::\\(\\d+\\)\\\\='\" . \"evince -p %1 %s\")
2230 to open [[file:document.pdf::5]] with evince at page 5.
2232 `directory' Matches a directory
2233 `remote' Matches a remote file, accessible through tramp or efs.
2234 Remote files most likely should be visited through Emacs
2235 because external applications cannot handle such paths.
2236 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2237 so all files Emacs knows how to handle. Using this with
2238 command `emacs' will open most files in Emacs. Beware that this
2239 will also open html files inside Emacs, unless you add
2240 (\"html\" . default) to the list as well.
2241 t Default for files not matched by any of the other options.
2242 `system' The system command to open files, like `open' on Windows
2243 and Mac OS X, and mailcap under GNU/Linux. This is the command
2244 that will be selected if you call `C-c C-o' with a double
2245 \\[universal-argument] \\[universal-argument] prefix.
2247 Possible values for the command are:
2248 `emacs' The file will be visited by the current Emacs process.
2249 `default' Use the default application for this file type, which is the
2250 association for t in the list, most likely in the system-specific
2251 part.
2252 This can be used to overrule an unwanted setting in the
2253 system-specific variable.
2254 `system' Use the system command for opening files, like \"open\".
2255 This command is specified by the entry whose car is `system'.
2256 Most likely, the system-specific version of this variable
2257 does define this command, but you can overrule/replace it
2258 here.
2259 string A command to be executed by a shell; %s will be replaced
2260 by the path to the file.
2261 sexp A Lisp form which will be evaluated. The file path will
2262 be available in the Lisp variable `file'.
2263 For more examples, see the system specific constants
2264 `org-file-apps-defaults-macosx'
2265 `org-file-apps-defaults-windowsnt'
2266 `org-file-apps-defaults-gnu'."
2267 :group 'org-link-follow
2268 :type '(repeat
2269 (cons (choice :value ""
2270 (string :tag "Extension")
2271 (const :tag "System command to open files" system)
2272 (const :tag "Default for unrecognized files" t)
2273 (const :tag "Remote file" remote)
2274 (const :tag "Links to a directory" directory)
2275 (const :tag "Any files that have Emacs modes"
2276 auto-mode))
2277 (choice :value ""
2278 (const :tag "Visit with Emacs" emacs)
2279 (const :tag "Use default" default)
2280 (const :tag "Use the system command" system)
2281 (string :tag "Command")
2282 (sexp :tag "Lisp form")))))
2284 (defcustom org-doi-server-url "http://dx.doi.org/"
2285 "The URL of the DOI server."
2286 :type 'string
2287 :version "24.3"
2288 :group 'org-link-follow)
2290 (defgroup org-refile nil
2291 "Options concerning refiling entries in Org-mode."
2292 :tag "Org Refile"
2293 :group 'org)
2295 (defcustom org-directory "~/org"
2296 "Directory with Org files.
2297 This is just a default location to look for Org files. There is no need
2298 at all to put your files into this directory. It is used in the
2299 following situations:
2301 1. When a capture template specifies a target file that is not an
2302 absolute path. The path will then be interpreted relative to
2303 `org-directory'
2304 2. When the value of variable `org-agenda-files' is a single file, any
2305 relative paths in this file will be taken as relative to
2306 `org-directory'."
2307 :group 'org-refile
2308 :group 'org-capture
2309 :type 'directory)
2311 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2312 "Default target for storing notes.
2313 Used as a fall back file for org-capture.el, for templates that
2314 do not specify a target file."
2315 :group 'org-refile
2316 :group 'org-capture
2317 :type 'file)
2319 (defcustom org-goto-interface 'outline
2320 "The default interface to be used for `org-goto'.
2321 Allowed values are:
2322 outline The interface shows an outline of the relevant file
2323 and the correct heading is found by moving through
2324 the outline or by searching with incremental search.
2325 outline-path-completion Headlines in the current buffer are offered via
2326 completion. This is the interface also used by
2327 the refile command."
2328 :group 'org-refile
2329 :type '(choice
2330 (const :tag "Outline" outline)
2331 (const :tag "Outline-path-completion" outline-path-completion)))
2333 (defcustom org-goto-max-level 5
2334 "Maximum target level when running `org-goto' with refile interface."
2335 :group 'org-refile
2336 :type 'integer)
2338 (defcustom org-reverse-note-order nil
2339 "Non-nil means store new notes at the beginning of a file or entry.
2340 When nil, new notes will be filed to the end of a file or entry.
2341 This can also be a list with cons cells of regular expressions that
2342 are matched against file names, and values."
2343 :group 'org-capture
2344 :group 'org-refile
2345 :type '(choice
2346 (const :tag "Reverse always" t)
2347 (const :tag "Reverse never" nil)
2348 (repeat :tag "By file name regexp"
2349 (cons regexp boolean))))
2351 (defcustom org-log-refile nil
2352 "Information to record when a task is refiled.
2354 Possible values are:
2356 nil Don't add anything
2357 time Add a time stamp to the task
2358 note Prompt for a note and add it with template `org-log-note-headings'
2360 This option can also be set with on a per-file-basis with
2362 #+STARTUP: nologrefile
2363 #+STARTUP: logrefile
2364 #+STARTUP: lognoterefile
2366 You can have local logging settings for a subtree by setting the LOGGING
2367 property to one or more of these keywords.
2369 When bulk-refiling from the agenda, the value `note' is forbidden and
2370 will temporarily be changed to `time'."
2371 :group 'org-refile
2372 :group 'org-progress
2373 :version "24.1"
2374 :type '(choice
2375 (const :tag "No logging" nil)
2376 (const :tag "Record timestamp" time)
2377 (const :tag "Record timestamp with note." note)))
2379 (defcustom org-refile-targets nil
2380 "Targets for refiling entries with \\[org-refile].
2381 This is a list of cons cells. Each cell contains:
2382 - a specification of the files to be considered, either a list of files,
2383 or a symbol whose function or variable value will be used to retrieve
2384 a file name or a list of file names. If you use `org-agenda-files' for
2385 that, all agenda files will be scanned for targets. Nil means consider
2386 headings in the current buffer.
2387 - A specification of how to find candidate refile targets. This may be
2388 any of:
2389 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2390 This tag has to be present in all target headlines, inheritance will
2391 not be considered.
2392 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2393 todo keyword.
2394 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2395 headlines that are refiling targets.
2396 - a cons cell (:level . N). Any headline of level N is considered a target.
2397 Note that, when `org-odd-levels-only' is set, level corresponds to
2398 order in hierarchy, not to the number of stars.
2399 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2400 Note that, when `org-odd-levels-only' is set, level corresponds to
2401 order in hierarchy, not to the number of stars.
2403 Each element of this list generates a set of possible targets.
2404 The union of these sets is presented (with completion) to
2405 the user by `org-refile'.
2407 You can set the variable `org-refile-target-verify-function' to a function
2408 to verify each headline found by the simple criteria above.
2410 When this variable is nil, all top-level headlines in the current buffer
2411 are used, equivalent to the value `((nil . (:level . 1))'."
2412 :group 'org-refile
2413 :type '(repeat
2414 (cons
2415 (choice :value org-agenda-files
2416 (const :tag "All agenda files" org-agenda-files)
2417 (const :tag "Current buffer" nil)
2418 (function) (variable) (file))
2419 (choice :tag "Identify target headline by"
2420 (cons :tag "Specific tag" (const :value :tag) (string))
2421 (cons :tag "TODO keyword" (const :value :todo) (string))
2422 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2423 (cons :tag "Level number" (const :value :level) (integer))
2424 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2426 (defcustom org-refile-target-verify-function nil
2427 "Function to verify if the headline at point should be a refile target.
2428 The function will be called without arguments, with point at the
2429 beginning of the headline. It should return t and leave point
2430 where it is if the headline is a valid target for refiling.
2432 If the target should not be selected, the function must return nil.
2433 In addition to this, it may move point to a place from where the search
2434 should be continued. For example, the function may decide that the entire
2435 subtree of the current entry should be excluded and move point to the end
2436 of the subtree."
2437 :group 'org-refile
2438 :type '(choice
2439 (const nil)
2440 (function)))
2442 (defcustom org-refile-use-cache nil
2443 "Non-nil means cache refile targets to speed up the process.
2444 \\<org-mode-map>\
2445 The cache for a particular file will be updated automatically when
2446 the buffer has been killed, or when any of the marker used for flagging
2447 refile targets no longer points at a live buffer.
2448 If you have added new entries to a buffer that might themselves be targets,
2449 you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
2450 if you find that easier, \
2451 `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
2452 \\[org-refile]'."
2453 :group 'org-refile
2454 :version "24.1"
2455 :type 'boolean)
2457 (defcustom org-refile-use-outline-path nil
2458 "Non-nil means provide refile targets as paths.
2459 So a level 3 headline will be available as level1/level2/level3.
2461 When the value is `file', also include the file name (without directory)
2462 into the path. In this case, you can also stop the completion after
2463 the file name, to get entries inserted as top level in the file.
2465 When `full-file-path', include the full file path."
2466 :group 'org-refile
2467 :type '(choice
2468 (const :tag "Not" nil)
2469 (const :tag "Yes" t)
2470 (const :tag "Start with file name" file)
2471 (const :tag "Start with full file path" full-file-path)))
2473 (defcustom org-outline-path-complete-in-steps t
2474 "Non-nil means complete the outline path in hierarchical steps.
2475 When Org-mode uses the refile interface to select an outline path
2476 \(see variable `org-refile-use-outline-path'), the completion of
2477 the path can be done in a single go, or it can be done in steps down
2478 the headline hierarchy. Going in steps is probably the best if you
2479 do not use a special completion package like `ido' or `icicles'.
2480 However, when using these packages, going in one step can be very
2481 fast, while still showing the whole path to the entry."
2482 :group 'org-refile
2483 :type 'boolean)
2485 (defcustom org-refile-allow-creating-parent-nodes nil
2486 "Non-nil means allow the creation of new nodes as refile targets.
2487 New nodes are then created by adding \"/new node name\" to the completion
2488 of an existing node. When the value of this variable is `confirm',
2489 new node creation must be confirmed by the user (recommended).
2490 When nil, the completion must match an existing entry.
2492 Note that, if the new heading is not seen by the criteria
2493 listed in `org-refile-targets', multiple instances of the same
2494 heading would be created by trying again to file under the new
2495 heading."
2496 :group 'org-refile
2497 :type '(choice
2498 (const :tag "Never" nil)
2499 (const :tag "Always" t)
2500 (const :tag "Prompt for confirmation" confirm)))
2502 (defcustom org-refile-active-region-within-subtree nil
2503 "Non-nil means also refile active region within a subtree.
2505 By default `org-refile' doesn't allow refiling regions if they
2506 don't contain a set of subtrees, but it might be convenient to
2507 do so sometimes: in that case, the first line of the region is
2508 converted to a headline before refiling."
2509 :group 'org-refile
2510 :version "24.1"
2511 :type 'boolean)
2513 (defgroup org-todo nil
2514 "Options concerning TODO items in Org-mode."
2515 :tag "Org TODO"
2516 :group 'org)
2518 (defgroup org-progress nil
2519 "Options concerning Progress logging in Org-mode."
2520 :tag "Org Progress"
2521 :group 'org-time)
2523 (defvar org-todo-interpretation-widgets
2524 '((:tag "Sequence (cycling hits every state)" sequence)
2525 (:tag "Type (cycling directly to DONE)" type))
2526 "The available interpretation symbols for customizing `org-todo-keywords'.
2527 Interested libraries should add to this list.")
2529 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2530 "List of TODO entry keyword sequences and their interpretation.
2531 \\<org-mode-map>This is a list of sequences.
2533 Each sequence starts with a symbol, either `sequence' or `type',
2534 indicating if the keywords should be interpreted as a sequence of
2535 action steps, or as different types of TODO items. The first
2536 keywords are states requiring action - these states will select a headline
2537 for inclusion into the global TODO list Org-mode produces. If one of
2538 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2539 signify that no further action is necessary. If \"|\" is not found,
2540 the last keyword is treated as the only DONE state of the sequence.
2542 The command \\[org-todo] cycles an entry through these states, and one
2543 additional state where no keyword is present. For details about this
2544 cycling, see the manual.
2546 TODO keywords and interpretation can also be set on a per-file basis with
2547 the special #+SEQ_TODO and #+TYP_TODO lines.
2549 Each keyword can optionally specify a character for fast state selection
2550 \(in combination with the variable `org-use-fast-todo-selection')
2551 and specifiers for state change logging, using the same syntax that
2552 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2553 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2554 indicates to record a time stamp each time this state is selected.
2556 Each keyword may also specify if a timestamp or a note should be
2557 recorded when entering or leaving the state, by adding additional
2558 characters in the parenthesis after the keyword. This looks like this:
2559 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2560 record only the time of the state change. With X and Y being either
2561 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2562 Y when leaving the state if and only if the *target* state does not
2563 define X. You may omit any of the fast-selection key or X or /Y,
2564 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2566 For backward compatibility, this variable may also be just a list
2567 of keywords. In this case the interpretation (sequence or type) will be
2568 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2569 :group 'org-todo
2570 :group 'org-keywords
2571 :type '(choice
2572 (repeat :tag "Old syntax, just keywords"
2573 (string :tag "Keyword"))
2574 (repeat :tag "New syntax"
2575 (cons
2576 (choice
2577 :tag "Interpretation"
2578 ;;Quick and dirty way to see
2579 ;;`org-todo-interpretations'. This takes the
2580 ;;place of item arguments
2581 :convert-widget
2582 (lambda (widget)
2583 (widget-put widget
2584 :args (mapcar
2585 (lambda (x)
2586 (widget-convert
2587 (cons 'const x)))
2588 org-todo-interpretation-widgets))
2589 widget))
2590 (repeat
2591 (string :tag "Keyword"))))))
2593 (defvar org-todo-keywords-1 nil
2594 "All TODO and DONE keywords active in a buffer.")
2595 (make-variable-buffer-local 'org-todo-keywords-1)
2596 (defvar org-todo-keywords-for-agenda nil)
2597 (defvar org-done-keywords-for-agenda nil)
2598 (defvar org-todo-keyword-alist-for-agenda nil)
2599 (defvar org-tag-alist-for-agenda nil
2600 "Alist of all tags from all agenda files.")
2601 (defvar org-tag-groups-alist-for-agenda nil
2602 "Alist of all groups tags from all current agenda files.")
2603 (defvar org-tag-groups-alist nil)
2604 (make-variable-buffer-local 'org-tag-groups-alist)
2605 (defvar org-agenda-contributing-files nil)
2606 (defvar org-not-done-keywords nil)
2607 (make-variable-buffer-local 'org-not-done-keywords)
2608 (defvar org-done-keywords nil)
2609 (make-variable-buffer-local 'org-done-keywords)
2610 (defvar org-todo-heads nil)
2611 (make-variable-buffer-local 'org-todo-heads)
2612 (defvar org-todo-sets nil)
2613 (make-variable-buffer-local 'org-todo-sets)
2614 (defvar org-todo-log-states nil)
2615 (make-variable-buffer-local 'org-todo-log-states)
2616 (defvar org-todo-kwd-alist nil)
2617 (make-variable-buffer-local 'org-todo-kwd-alist)
2618 (defvar org-todo-key-alist nil)
2619 (make-variable-buffer-local 'org-todo-key-alist)
2620 (defvar org-todo-key-trigger nil)
2621 (make-variable-buffer-local 'org-todo-key-trigger)
2623 (defcustom org-todo-interpretation 'sequence
2624 "Controls how TODO keywords are interpreted.
2625 This variable is in principle obsolete and is only used for
2626 backward compatibility, if the interpretation of todo keywords is
2627 not given already in `org-todo-keywords'. See that variable for
2628 more information."
2629 :group 'org-todo
2630 :group 'org-keywords
2631 :type '(choice (const sequence)
2632 (const type)))
2634 (defcustom org-use-fast-todo-selection t
2635 "\\<org-mode-map>\
2636 Non-nil means use the fast todo selection scheme with \\[org-todo].
2637 This variable describes if and under what circumstances the cycling
2638 mechanism for TODO keywords will be replaced by a single-key, direct
2639 selection scheme.
2641 When nil, fast selection is never used.
2643 When the symbol `prefix', it will be used when `org-todo' is called
2644 with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
2645 in an Org-mode buffer, and
2646 `\\[universal-argument] t' in an agenda buffer.
2648 When t, fast selection is used by default. In this case, the prefix
2649 argument forces cycling instead.
2651 In all cases, the special interface is only used if access keys have
2652 actually been assigned by the user, i.e. if keywords in the configuration
2653 are followed by a letter in parenthesis, like TODO(t)."
2654 :group 'org-todo
2655 :type '(choice
2656 (const :tag "Never" nil)
2657 (const :tag "By default" t)
2658 (const :tag "Only with C-u C-c C-t" prefix)))
2660 (defcustom org-provide-todo-statistics t
2661 "Non-nil means update todo statistics after insert and toggle.
2662 ALL-HEADLINES means update todo statistics by including headlines
2663 with no TODO keyword as well, counting them as not done.
2664 A list of TODO keywords means the same, but skip keywords that are
2665 not in this list.
2666 When set to a list of two lists, the first list contains keywords
2667 to consider as TODO keywords, the second list contains keywords
2668 to consider as DONE keywords.
2670 When this is set, todo statistics is updated in the parent of the
2671 current entry each time a todo state is changed."
2672 :group 'org-todo
2673 :type '(choice
2674 (const :tag "Yes, only for TODO entries" t)
2675 (const :tag "Yes, including all entries" all-headlines)
2676 (repeat :tag "Yes, for TODOs in this list"
2677 (string :tag "TODO keyword"))
2678 (list :tag "Yes, for TODOs and DONEs in these lists"
2679 (repeat (string :tag "TODO keyword"))
2680 (repeat (string :tag "DONE keyword")))
2681 (other :tag "No TODO statistics" nil)))
2683 (defcustom org-hierarchical-todo-statistics t
2684 "Non-nil means TODO statistics covers just direct children.
2685 When nil, all entries in the subtree are considered.
2686 This has only an effect if `org-provide-todo-statistics' is set.
2687 To set this to nil for only a single subtree, use a COOKIE_DATA
2688 property and include the word \"recursive\" into the value."
2689 :group 'org-todo
2690 :type 'boolean)
2692 (defcustom org-after-todo-state-change-hook nil
2693 "Hook which is run after the state of a TODO item was changed.
2694 The new state (a string with a TODO keyword, or nil) is available in the
2695 Lisp variable `org-state'."
2696 :group 'org-todo
2697 :type 'hook)
2699 (defvar org-blocker-hook nil
2700 "Hook for functions that are allowed to block a state change.
2702 Functions in this hook should not modify the buffer.
2703 Each function gets as its single argument a property list,
2704 see `org-trigger-hook' for more information about this list.
2706 If any of the functions in this hook returns nil, the state change
2707 is blocked.")
2709 (defvar org-trigger-hook nil
2710 "Hook for functions that are triggered by a state change.
2712 Each function gets as its single argument a property list with at
2713 least the following elements:
2715 (:type type-of-change :position pos-at-entry-start
2716 :from old-state :to new-state)
2718 Depending on the type, more properties may be present.
2720 This mechanism is currently implemented for:
2722 TODO state changes
2723 ------------------
2724 :type todo-state-change
2725 :from previous state (keyword as a string), or nil, or a symbol
2726 `todo' or `done', to indicate the general type of state.
2727 :to new state, like in :from")
2729 (defcustom org-enforce-todo-dependencies nil
2730 "Non-nil means undone TODO entries will block switching the parent to DONE.
2731 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2732 be blocked if any prior sibling is not yet done.
2733 Finally, if the parent is blocked because of ordered siblings of its own,
2734 the child will also be blocked."
2735 :set (lambda (var val)
2736 (set var val)
2737 (if val
2738 (add-hook 'org-blocker-hook
2739 'org-block-todo-from-children-or-siblings-or-parent)
2740 (remove-hook 'org-blocker-hook
2741 'org-block-todo-from-children-or-siblings-or-parent)))
2742 :group 'org-todo
2743 :type 'boolean)
2745 (defcustom org-enforce-todo-checkbox-dependencies nil
2746 "Non-nil means unchecked boxes will block switching the parent to DONE.
2747 When this is nil, checkboxes have no influence on switching TODO states.
2748 When non-nil, you first need to check off all check boxes before the TODO
2749 entry can be switched to DONE.
2750 This variable needs to be set before org.el is loaded, and you need to
2751 restart Emacs after a change to make the change effective. The only way
2752 to change is while Emacs is running is through the customize interface."
2753 :set (lambda (var val)
2754 (set var val)
2755 (if val
2756 (add-hook 'org-blocker-hook
2757 'org-block-todo-from-checkboxes)
2758 (remove-hook 'org-blocker-hook
2759 'org-block-todo-from-checkboxes)))
2760 :group 'org-todo
2761 :type 'boolean)
2763 (defcustom org-treat-insert-todo-heading-as-state-change nil
2764 "Non-nil means inserting a TODO heading is treated as state change.
2765 So when the command \\[org-insert-todo-heading] is used, state change
2766 logging will apply if appropriate. When nil, the new TODO item will
2767 be inserted directly, and no logging will take place."
2768 :group 'org-todo
2769 :type 'boolean)
2771 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2772 "Non-nil means switching TODO states with S-cursor counts as state change.
2773 This is the default behavior. However, setting this to nil allows a
2774 convenient way to select a TODO state and bypass any logging associated
2775 with that."
2776 :group 'org-todo
2777 :type 'boolean)
2779 (defcustom org-todo-state-tags-triggers nil
2780 "Tag changes that should be triggered by TODO state changes.
2781 This is a list. Each entry is
2783 (state-change (tag . flag) .......)
2785 State-change can be a string with a state, and empty string to indicate the
2786 state that has no TODO keyword, or it can be one of the symbols `todo'
2787 or `done', meaning any not-done or done state, respectively."
2788 :group 'org-todo
2789 :group 'org-tags
2790 :type '(repeat
2791 (cons (choice :tag "When changing to"
2792 (const :tag "Not-done state" todo)
2793 (const :tag "Done state" done)
2794 (string :tag "State"))
2795 (repeat
2796 (cons :tag "Tag action"
2797 (string :tag "Tag")
2798 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2800 (defcustom org-log-done nil
2801 "Information to record when a task moves to the DONE state.
2803 Possible values are:
2805 nil Don't add anything, just change the keyword
2806 time Add a time stamp to the task
2807 note Prompt for a note and add it with template `org-log-note-headings'
2809 This option can also be set with on a per-file-basis with
2811 #+STARTUP: nologdone
2812 #+STARTUP: logdone
2813 #+STARTUP: lognotedone
2815 You can have local logging settings for a subtree by setting the LOGGING
2816 property to one or more of these keywords."
2817 :group 'org-todo
2818 :group 'org-progress
2819 :type '(choice
2820 (const :tag "No logging" nil)
2821 (const :tag "Record CLOSED timestamp" time)
2822 (const :tag "Record CLOSED timestamp with note." note)))
2824 ;; Normalize old uses of org-log-done.
2825 (cond
2826 ((eq org-log-done t) (setq org-log-done 'time))
2827 ((and (listp org-log-done) (memq 'done org-log-done))
2828 (setq org-log-done 'note)))
2830 (defcustom org-log-reschedule nil
2831 "Information to record when the scheduling date of a tasks is modified.
2833 Possible values are:
2835 nil Don't add anything, just change the date
2836 time Add a time stamp to the task
2837 note Prompt for a note and add it with template `org-log-note-headings'
2839 This option can also be set with on a per-file-basis with
2841 #+STARTUP: nologreschedule
2842 #+STARTUP: logreschedule
2843 #+STARTUP: lognotereschedule"
2844 :group 'org-todo
2845 :group 'org-progress
2846 :type '(choice
2847 (const :tag "No logging" nil)
2848 (const :tag "Record timestamp" time)
2849 (const :tag "Record timestamp with note." note)))
2851 (defcustom org-log-redeadline nil
2852 "Information to record when the deadline date of a tasks is modified.
2854 Possible values are:
2856 nil Don't add anything, just change the date
2857 time Add a time stamp to the task
2858 note Prompt for a note and add it with template `org-log-note-headings'
2860 This option can also be set with on a per-file-basis with
2862 #+STARTUP: nologredeadline
2863 #+STARTUP: logredeadline
2864 #+STARTUP: lognoteredeadline
2866 You can have local logging settings for a subtree by setting the LOGGING
2867 property to one or more of these keywords."
2868 :group 'org-todo
2869 :group 'org-progress
2870 :type '(choice
2871 (const :tag "No logging" nil)
2872 (const :tag "Record timestamp" time)
2873 (const :tag "Record timestamp with note." note)))
2875 (defcustom org-log-note-clock-out nil
2876 "Non-nil means record a note when clocking out of an item.
2877 This can also be configured on a per-file basis by adding one of
2878 the following lines anywhere in the buffer:
2880 #+STARTUP: lognoteclock-out
2881 #+STARTUP: nolognoteclock-out"
2882 :group 'org-todo
2883 :group 'org-progress
2884 :type 'boolean)
2886 (defcustom org-log-done-with-time t
2887 "Non-nil means the CLOSED time stamp will contain date and time.
2888 When nil, only the date will be recorded."
2889 :group 'org-progress
2890 :type 'boolean)
2892 (defcustom org-log-note-headings
2893 '((done . "CLOSING NOTE %t")
2894 (state . "State %-12s from %-12S %t")
2895 (note . "Note taken on %t")
2896 (reschedule . "Rescheduled from %S on %t")
2897 (delschedule . "Not scheduled, was %S on %t")
2898 (redeadline . "New deadline from %S on %t")
2899 (deldeadline . "Removed deadline, was %S on %t")
2900 (refile . "Refiled on %t")
2901 (clock-out . ""))
2902 "Headings for notes added to entries.
2904 The value is an alist, with the car being a symbol indicating the
2905 note context, and the cdr is the heading to be used. The heading
2906 may also be the empty string. The following placeholders can be
2907 used:
2909 %t a time stamp.
2910 %T an active time stamp instead the default inactive one
2911 %d a short-format time stamp.
2912 %D an active short-format time stamp.
2913 %s the new TODO state or time stamp (inactive), in double quotes.
2914 %S the old TODO state or time stamp (inactive), in double quotes.
2915 %u the user name.
2916 %U full user name.
2918 In fact, it is not a good idea to change the `state' entry,
2919 because Agenda Log mode depends on the format of these entries."
2920 :group 'org-todo
2921 :group 'org-progress
2922 :type '(list :greedy t
2923 (cons (const :tag "Heading when closing an item" done) string)
2924 (cons (const :tag
2925 "Heading when changing todo state (todo sequence only)"
2926 state) string)
2927 (cons (const :tag "Heading when just taking a note" note) string)
2928 (cons (const :tag "Heading when rescheduling" reschedule) string)
2929 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2930 (cons (const :tag "Heading when changing deadline" redeadline) string)
2931 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2932 (cons (const :tag "Heading when refiling" refile) string)
2933 (cons (const :tag "Heading when clocking out" clock-out) string)))
2935 (unless (assq 'note org-log-note-headings)
2936 (push '(note . "%t") org-log-note-headings))
2938 (defcustom org-log-into-drawer nil
2939 "Non-nil means insert state change notes and time stamps into a drawer.
2940 When nil, state changes notes will be inserted after the headline and
2941 any scheduling and clock lines, but not inside a drawer.
2943 The value of this variable should be the name of the drawer to use.
2944 LOGBOOK is proposed as the default drawer for this purpose, you can
2945 also set this to a string to define the drawer of your choice.
2947 A value of t is also allowed, representing \"LOGBOOK\".
2949 A value of t or nil can also be set with on a per-file-basis with
2951 #+STARTUP: logdrawer
2952 #+STARTUP: nologdrawer
2954 If this variable is set, `org-log-state-notes-insert-after-drawers'
2955 will be ignored.
2957 You can set the property LOG_INTO_DRAWER to overrule this setting for
2958 a subtree.
2960 Do not check directly this variable in a Lisp program. Call
2961 function `org-log-into-drawer' instead."
2962 :group 'org-todo
2963 :group 'org-progress
2964 :type '(choice
2965 (const :tag "Not into a drawer" nil)
2966 (const :tag "LOGBOOK" t)
2967 (string :tag "Other")))
2969 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2971 (defun org-log-into-drawer ()
2972 "Name of the log drawer, as a string, or nil.
2973 This is the value of `org-log-into-drawer'. However, if the
2974 current entry has or inherits a LOG_INTO_DRAWER property, it will
2975 be used instead of the default value."
2976 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2977 (cond ((equal p "nil") nil)
2978 ((equal p "t") "LOGBOOK")
2979 ((stringp p) p)
2980 (p "LOGBOOK")
2981 ((stringp org-log-into-drawer) org-log-into-drawer)
2982 (org-log-into-drawer "LOGBOOK"))))
2984 (defcustom org-log-state-notes-insert-after-drawers nil
2985 "Non-nil means insert state change notes after any drawers in entry.
2986 Only the drawers that *immediately* follow the headline and the
2987 deadline/scheduled line are skipped.
2988 When nil, insert notes right after the heading and perhaps the line
2989 with deadline/scheduling if present.
2991 This variable will have no effect if `org-log-into-drawer' is
2992 set."
2993 :group 'org-todo
2994 :group 'org-progress
2995 :type 'boolean)
2997 (defcustom org-log-states-order-reversed t
2998 "Non-nil means the latest state note will be directly after heading.
2999 When nil, the state change notes will be ordered according to time.
3001 This option can also be set with on a per-file-basis with
3003 #+STARTUP: logstatesreversed
3004 #+STARTUP: nologstatesreversed"
3005 :group 'org-todo
3006 :group 'org-progress
3007 :type 'boolean)
3009 (defcustom org-todo-repeat-to-state nil
3010 "The TODO state to which a repeater should return the repeating task.
3011 By default this is the first task in a TODO sequence, or the previous state
3012 in a TODO_TYP set. But you can specify another task here.
3013 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3014 :group 'org-todo
3015 :version "24.1"
3016 :type '(choice (const :tag "Head of sequence" nil)
3017 (string :tag "Specific state")))
3019 (defcustom org-log-repeat 'time
3020 "Non-nil means record moving through the DONE state when triggering repeat.
3021 An auto-repeating task is immediately switched back to TODO when
3022 marked DONE. If you are not logging state changes (by adding \"@\"
3023 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3024 record a closing note, there will be no record of the task moving
3025 through DONE. This variable forces taking a note anyway.
3027 nil Don't force a record
3028 time Record a time stamp
3029 note Prompt for a note and add it with template `org-log-note-headings'
3031 This option can also be set with on a per-file-basis with
3033 #+STARTUP: nologrepeat
3034 #+STARTUP: logrepeat
3035 #+STARTUP: lognoterepeat
3037 You can have local logging settings for a subtree by setting the LOGGING
3038 property to one or more of these keywords."
3039 :group 'org-todo
3040 :group 'org-progress
3041 :type '(choice
3042 (const :tag "Don't force a record" nil)
3043 (const :tag "Force recording the DONE state" time)
3044 (const :tag "Force recording a note with the DONE state" note)))
3047 (defgroup org-priorities nil
3048 "Priorities in Org-mode."
3049 :tag "Org Priorities"
3050 :group 'org-todo)
3052 (defcustom org-enable-priority-commands t
3053 "Non-nil means priority commands are active.
3054 When nil, these commands will be disabled, so that you never accidentally
3055 set a priority."
3056 :group 'org-priorities
3057 :type 'boolean)
3059 (defcustom org-highest-priority ?A
3060 "The highest priority of TODO items. A character like ?A, ?B etc.
3061 Must have a smaller ASCII number than `org-lowest-priority'."
3062 :group 'org-priorities
3063 :type 'character)
3065 (defcustom org-lowest-priority ?C
3066 "The lowest priority of TODO items. A character like ?A, ?B etc.
3067 Must have a larger ASCII number than `org-highest-priority'."
3068 :group 'org-priorities
3069 :type 'character)
3071 (defcustom org-default-priority ?B
3072 "The default priority of TODO items.
3073 This is the priority an item gets if no explicit priority is given.
3074 When starting to cycle on an empty priority the first step in the cycle
3075 depends on `org-priority-start-cycle-with-default'. The resulting first
3076 step priority must not exceed the range from `org-highest-priority' to
3077 `org-lowest-priority' which means that `org-default-priority' has to be
3078 in this range exclusive or inclusive the range boundaries. Else the
3079 first step refuses to set the default and the second will fall back
3080 to (depending on the command used) the highest or lowest priority."
3081 :group 'org-priorities
3082 :type 'character)
3084 (defcustom org-priority-start-cycle-with-default t
3085 "Non-nil means start with default priority when starting to cycle.
3086 When this is nil, the first step in the cycle will be (depending on the
3087 command used) one higher or lower than the default priority.
3088 See also `org-default-priority'."
3089 :group 'org-priorities
3090 :type 'boolean)
3092 (defcustom org-get-priority-function nil
3093 "Function to extract the priority from a string.
3094 The string is normally the headline. If this is nil Org computes the
3095 priority from the priority cookie like [#A] in the headline. It returns
3096 an integer, increasing by 1000 for each priority level.
3097 The user can set a different function here, which should take a string
3098 as an argument and return the numeric priority."
3099 :group 'org-priorities
3100 :version "24.1"
3101 :type '(choice
3102 (const nil)
3103 (function)))
3105 (defgroup org-time nil
3106 "Options concerning time stamps and deadlines in Org-mode."
3107 :tag "Org Time"
3108 :group 'org)
3110 (defcustom org-time-stamp-rounding-minutes '(0 5)
3111 "Number of minutes to round time stamps to.
3112 \\<org-mode-map>\
3113 These are two values, the first applies when first creating a time stamp.
3114 The second applies when changing it with the commands `S-up' and `S-down'.
3115 When changing the time stamp, this means that it will change in steps
3116 of N minutes, as given by the second value.
3118 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3119 numbers should be factors of 60, so for example 5, 10, 15.
3121 When this is larger than 1, you can still force an exact time stamp by using
3122 a double prefix argument to a time stamp command like \
3123 `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
3124 and by using a prefix arg to `S-up/down' to specify the exact number
3125 of minutes to shift."
3126 :group 'org-time
3127 :get (lambda (var) ; Make sure both elements are there
3128 (if (integerp (default-value var))
3129 (list (default-value var) 5)
3130 (default-value var)))
3131 :type '(list
3132 (integer :tag "when inserting times")
3133 (integer :tag "when modifying times")))
3135 ;; Normalize old customizations of this variable.
3136 (when (integerp org-time-stamp-rounding-minutes)
3137 (setq org-time-stamp-rounding-minutes
3138 (list org-time-stamp-rounding-minutes
3139 org-time-stamp-rounding-minutes)))
3141 (defcustom org-display-custom-times nil
3142 "Non-nil means overlay custom formats over all time stamps.
3143 The formats are defined through the variable `org-time-stamp-custom-formats'.
3144 To turn this on on a per-file basis, insert anywhere in the file:
3145 #+STARTUP: customtime"
3146 :group 'org-time
3147 :set 'set-default
3148 :type 'sexp)
3149 (make-variable-buffer-local 'org-display-custom-times)
3151 (defcustom org-time-stamp-custom-formats
3152 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3153 "Custom formats for time stamps. See `format-time-string' for the syntax.
3154 These are overlaid over the default ISO format if the variable
3155 `org-display-custom-times' is set. Time like %H:%M should be at the
3156 end of the second format. The custom formats are also honored by export
3157 commands, if custom time display is turned on at the time of export."
3158 :group 'org-time
3159 :type 'sexp)
3161 (defun org-time-stamp-format (&optional long inactive)
3162 "Get the right format for a time string."
3163 (let ((f (if long (cdr org-time-stamp-formats)
3164 (car org-time-stamp-formats))))
3165 (if inactive
3166 (concat "[" (substring f 1 -1) "]")
3167 f)))
3169 (defcustom org-time-clocksum-format
3170 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3171 "The format string used when creating CLOCKSUM lines.
3172 This is also used when Org mode generates a time duration.
3174 The value can be a single format string containing two
3175 %-sequences, which will be filled with the number of hours and
3176 minutes in that order.
3178 Alternatively, the value can be a plist associating any of the
3179 keys :years, :months, :weeks, :days, :hours or :minutes with
3180 format strings. The time duration is formatted using only the
3181 time components that are needed and concatenating the results.
3182 If a time unit in absent, it falls back to the next smallest
3183 unit.
3185 The keys :require-years, :require-months, :require-days,
3186 :require-weeks, :require-hours, :require-minutes are also
3187 meaningful. A non-nil value for these keys indicates that the
3188 corresponding time component should always be included, even if
3189 its value is 0.
3192 For example,
3194 (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3195 :require-minutes t)
3197 means durations longer than a day will be expressed in days,
3198 hours and minutes, and durations less than a day will always be
3199 expressed in hours and minutes (even for durations less than an
3200 hour).
3202 The value
3204 (:days \"%dd\" :minutes \"%dm\")
3206 means durations longer than a day will be expressed in days and
3207 minutes, and durations less than a day will be expressed entirely
3208 in minutes (even for durations longer than an hour)."
3209 :group 'org-time
3210 :group 'org-clock
3211 :version "24.4"
3212 :package-version '(Org . "8.0")
3213 :type '(choice (string :tag "Format string")
3214 (set :tag "Plist"
3215 (group :inline t (const :tag "Years" :years)
3216 (string :tag "Format string"))
3217 (group :inline t
3218 (const :tag "Always show years" :require-years)
3219 (const t))
3220 (group :inline t (const :tag "Months" :months)
3221 (string :tag "Format string"))
3222 (group :inline t
3223 (const :tag "Always show months" :require-months)
3224 (const t))
3225 (group :inline t (const :tag "Weeks" :weeks)
3226 (string :tag "Format string"))
3227 (group :inline t
3228 (const :tag "Always show weeks" :require-weeks)
3229 (const t))
3230 (group :inline t (const :tag "Days" :days)
3231 (string :tag "Format string"))
3232 (group :inline t
3233 (const :tag "Always show days" :require-days)
3234 (const t))
3235 (group :inline t (const :tag "Hours" :hours)
3236 (string :tag "Format string"))
3237 (group :inline t
3238 (const :tag "Always show hours" :require-hours)
3239 (const t))
3240 (group :inline t (const :tag "Minutes" :minutes)
3241 (string :tag "Format string"))
3242 (group :inline t
3243 (const :tag "Always show minutes" :require-minutes)
3244 (const t)))))
3246 (defcustom org-time-clocksum-use-fractional nil
3247 "When non-nil, \\[org-clock-display] uses fractional times.
3248 See `org-time-clocksum-format' for more on time clock formats."
3249 :group 'org-time
3250 :group 'org-clock
3251 :version "24.3"
3252 :type 'boolean)
3254 (defcustom org-time-clocksum-use-effort-durations nil
3255 "When non-nil, \\[org-clock-display] uses effort durations.
3256 E.g. by default, one day is considered to be a 8 hours effort,
3257 so a task that has been clocked for 16 hours will be displayed
3258 as during 2 days in the clock display or in the clocktable.
3260 See `org-effort-durations' on how to set effort durations
3261 and `org-time-clocksum-format' for more on time clock formats."
3262 :group 'org-time
3263 :group 'org-clock
3264 :version "24.4"
3265 :package-version '(Org . "8.0")
3266 :type 'boolean)
3268 (defcustom org-time-clocksum-fractional-format "%.2f"
3269 "The format string used when creating CLOCKSUM lines,
3270 or when Org mode generates a time duration, if
3271 `org-time-clocksum-use-fractional' is enabled.
3273 The value can be a single format string containing one
3274 %-sequence, which will be filled with the number of hours as
3275 a float.
3277 Alternatively, the value can be a plist associating any of the
3278 keys :years, :months, :weeks, :days, :hours or :minutes with
3279 a format string. The time duration is formatted using the
3280 largest time unit which gives a non-zero integer part. If all
3281 specified formats have zero integer part, the smallest time unit
3282 is used."
3283 :group 'org-time
3284 :type '(choice (string :tag "Format string")
3285 (set (group :inline t (const :tag "Years" :years)
3286 (string :tag "Format string"))
3287 (group :inline t (const :tag "Months" :months)
3288 (string :tag "Format string"))
3289 (group :inline t (const :tag "Weeks" :weeks)
3290 (string :tag "Format string"))
3291 (group :inline t (const :tag "Days" :days)
3292 (string :tag "Format string"))
3293 (group :inline t (const :tag "Hours" :hours)
3294 (string :tag "Format string"))
3295 (group :inline t (const :tag "Minutes" :minutes)
3296 (string :tag "Format string")))))
3298 (defcustom org-deadline-warning-days 14
3299 "Number of days before expiration during which a deadline becomes active.
3300 This variable governs the display in sparse trees and in the agenda.
3301 When 0 or negative, it means use this number (the absolute value of it)
3302 even if a deadline has a different individual lead time specified.
3304 Custom commands can set this variable in the options section."
3305 :group 'org-time
3306 :group 'org-agenda-daily/weekly
3307 :type 'integer)
3309 (defcustom org-scheduled-delay-days 0
3310 "Number of days before a scheduled item becomes active.
3311 This variable governs the display in sparse trees and in the agenda.
3312 The default value (i.e. 0) means: don't delay scheduled item.
3313 When negative, it means use this number (the absolute value of it)
3314 even if a scheduled item has a different individual delay time
3315 specified.
3317 Custom commands can set this variable in the options section."
3318 :group 'org-time
3319 :group 'org-agenda-daily/weekly
3320 :version "24.4"
3321 :package-version '(Org . "8.0")
3322 :type 'integer)
3324 (defcustom org-read-date-prefer-future t
3325 "Non-nil means assume future for incomplete date input from user.
3326 This affects the following situations:
3327 1. The user gives a month but not a year.
3328 For example, if it is April and you enter \"feb 2\", this will be read
3329 as Feb 2, *next* year. \"May 5\", however, will be this year.
3330 2. The user gives a day, but no month.
3331 For example, if today is the 15th, and you enter \"3\", Org-mode will
3332 read this as the third of *next* month. However, if you enter \"17\",
3333 it will be considered as *this* month.
3335 If you set this variable to the symbol `time', then also the following
3336 will work:
3338 3. If the user gives a time.
3339 If the time is before now, it will be interpreted as tomorrow.
3341 Currently none of this works for ISO week specifications.
3343 When this option is nil, the current day, month and year will always be
3344 used as defaults.
3346 See also `org-agenda-jump-prefer-future'."
3347 :group 'org-time
3348 :type '(choice
3349 (const :tag "Never" nil)
3350 (const :tag "Check month and day" t)
3351 (const :tag "Check month, day, and time" time)))
3353 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3354 "Should the agenda jump command prefer the future for incomplete dates?
3355 The default is to do the same as configured in `org-read-date-prefer-future'.
3356 But you can also set a deviating value here.
3357 This may t or nil, or the symbol `org-read-date-prefer-future'."
3358 :group 'org-agenda
3359 :group 'org-time
3360 :version "24.1"
3361 :type '(choice
3362 (const :tag "Use org-read-date-prefer-future"
3363 org-read-date-prefer-future)
3364 (const :tag "Never" nil)
3365 (const :tag "Always" t)))
3367 (defcustom org-read-date-force-compatible-dates t
3368 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3370 Depending on the system Emacs is running on, certain dates cannot
3371 be represented with the type used internally to represent time.
3372 Dates between 1970-1-1 and 2038-1-1 can always be represented
3373 correctly. Some systems allow for earlier dates, some for later,
3374 some for both. One way to find out it to insert any date into an
3375 Org buffer, putting the cursor on the year and hitting S-up and
3376 S-down to test the range.
3378 When this variable is set to t, the date/time prompt will not let
3379 you specify dates outside the 1970-2037 range, so it is certain that
3380 these dates will work in whatever version of Emacs you are
3381 running, and also that you can move a file from one Emacs implementation
3382 to another. WHenever Org is forcing the year for you, it will display
3383 a message and beep.
3385 When this variable is nil, Org will check if the date is
3386 representable in the specific Emacs implementation you are using.
3387 If not, it will force a year, usually the current year, and beep
3388 to remind you. Currently this setting is not recommended because
3389 the likelihood that you will open your Org files in an Emacs that
3390 has limited date range is not negligible.
3392 A workaround for this problem is to use diary sexp dates for time
3393 stamps outside of this range."
3394 :group 'org-time
3395 :version "24.1"
3396 :type 'boolean)
3398 (defcustom org-read-date-display-live t
3399 "Non-nil means display current interpretation of date prompt live.
3400 This display will be in an overlay, in the minibuffer."
3401 :group 'org-time
3402 :type 'boolean)
3404 (defcustom org-read-date-popup-calendar t
3405 "Non-nil means pop up a calendar when prompting for a date.
3406 In the calendar, the date can be selected with mouse-1. However, the
3407 minibuffer will also be active, and you can simply enter the date as well.
3408 When nil, only the minibuffer will be available."
3409 :group 'org-time
3410 :type 'boolean)
3411 (org-defvaralias 'org-popup-calendar-for-date-prompt
3412 'org-read-date-popup-calendar)
3414 (make-obsolete-variable
3415 'org-read-date-minibuffer-setup-hook
3416 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3417 (defcustom org-read-date-minibuffer-setup-hook nil
3418 "Hook to be used to set up keys for the date/time interface.
3419 Add key definitions to `minibuffer-local-map', which will be a
3420 temporary copy.
3422 WARNING: This option is obsolete, you should use
3423 `org-read-date-minibuffer-local-map' to set up keys."
3424 :group 'org-time
3425 :type 'hook)
3427 (defcustom org-extend-today-until 0
3428 "The hour when your day really ends. Must be an integer.
3429 This has influence for the following applications:
3430 - When switching the agenda to \"today\". It it is still earlier than
3431 the time given here, the day recognized as TODAY is actually yesterday.
3432 - When a date is read from the user and it is still before the time given
3433 here, the current date and time will be assumed to be yesterday, 23:59.
3434 Also, timestamps inserted in capture templates follow this rule.
3436 IMPORTANT: This is a feature whose implementation is and likely will
3437 remain incomplete. Really, it is only here because past midnight seems to
3438 be the favorite working time of John Wiegley :-)"
3439 :group 'org-time
3440 :type 'integer)
3442 (defcustom org-use-effective-time nil
3443 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3444 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3445 \"effective time\" of any timestamps between midnight and 8am will be
3446 23:59 of the previous day."
3447 :group 'org-time
3448 :version "24.1"
3449 :type 'boolean)
3451 (defcustom org-use-last-clock-out-time-as-effective-time nil
3452 "When non-nil, use the last clock out time for `org-todo'.
3453 Note that this option has precedence over the combined use of
3454 `org-use-effective-time' and `org-extend-today-until'."
3455 :group 'org-time
3456 :version "24.4"
3457 :package-version '(Org . "8.0")
3458 :type 'boolean)
3460 (defcustom org-edit-timestamp-down-means-later nil
3461 "Non-nil means S-down will increase the time in a time stamp.
3462 When nil, S-up will increase."
3463 :group 'org-time
3464 :type 'boolean)
3466 (defcustom org-calendar-follow-timestamp-change t
3467 "Non-nil means make the calendar window follow timestamp changes.
3468 When a timestamp is modified and the calendar window is visible, it will be
3469 moved to the new date."
3470 :group 'org-time
3471 :type 'boolean)
3473 (defgroup org-tags nil
3474 "Options concerning tags in Org-mode."
3475 :tag "Org Tags"
3476 :group 'org)
3478 (defcustom org-tag-alist nil
3479 "List of tags allowed in Org-mode files.
3480 When this list is nil, Org-mode will base TAG input on what is already in the
3481 buffer.
3482 The value of this variable is an alist, the car of each entry must be a
3483 keyword as a string, the cdr may be a character that is used to select
3484 that tag through the fast-tag-selection interface.
3485 See the manual for details."
3486 :group 'org-tags
3487 :type '(repeat
3488 (choice
3489 (cons (string :tag "Tag name")
3490 (character :tag "Access char"))
3491 (list :tag "Start radio group"
3492 (const :startgroup)
3493 (option (string :tag "Group description")))
3494 (list :tag "Start tag group, non distinct"
3495 (const :startgrouptag)
3496 (option (string :tag "Group description")))
3497 (list :tag "Group tags delimiter"
3498 (const :grouptags))
3499 (list :tag "End radio group"
3500 (const :endgroup)
3501 (option (string :tag "Group description")))
3502 (list :tag "End tag group, non distinct"
3503 (const :endgrouptag)
3504 (option (string :tag "Group description")))
3505 (const :tag "New line" (:newline)))))
3507 (defcustom org-tag-persistent-alist nil
3508 "List of tags that will always appear in all Org-mode files.
3509 This is in addition to any in buffer settings or customizations
3510 of `org-tag-alist'.
3511 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3512 The value of this variable is an alist, the car of each entry must be a
3513 keyword as a string, the cdr may be a character that is used to select
3514 that tag through the fast-tag-selection interface.
3515 See the manual for details.
3516 To disable these tags on a per-file basis, insert anywhere in the file:
3517 #+STARTUP: noptag"
3518 :group 'org-tags
3519 :type '(repeat
3520 (choice
3521 (cons (string :tag "Tag name")
3522 (character :tag "Access char"))
3523 (const :tag "Start radio group" (:startgroup))
3524 (const :tag "Group tags delimiter" (:grouptags))
3525 (const :tag "End radio group" (:endgroup))
3526 (const :tag "New line" (:newline)))))
3528 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3529 "If non-nil, always offer completion for all tags of all agenda files.
3530 Instead of customizing this variable directly, you might want to
3531 set it locally for capture buffers, because there no list of
3532 tags in that file can be created dynamically (there are none).
3534 (add-hook \\='org-capture-mode-hook
3535 (lambda ()
3536 (set (make-local-variable
3537 \\='org-complete-tags-always-offer-all-agenda-tags)
3538 t)))"
3539 :group 'org-tags
3540 :version "24.1"
3541 :type 'boolean)
3543 (defvar org-file-tags nil
3544 "List of tags that can be inherited by all entries in the file.
3545 The tags will be inherited if the variable `org-use-tag-inheritance'
3546 says they should be.
3547 This variable is populated from #+FILETAGS lines.")
3549 (defcustom org-use-fast-tag-selection 'auto
3550 "Non-nil means use fast tag selection scheme.
3551 This is a special interface to select and deselect tags with single keys.
3552 When nil, fast selection is never used.
3553 When the symbol `auto', fast selection is used if and only if selection
3554 characters for tags have been configured, either through the variable
3555 `org-tag-alist' or through a #+TAGS line in the buffer.
3556 When t, fast selection is always used and selection keys are assigned
3557 automatically if necessary."
3558 :group 'org-tags
3559 :type '(choice
3560 (const :tag "Always" t)
3561 (const :tag "Never" nil)
3562 (const :tag "When selection characters are configured" auto)))
3564 (defcustom org-fast-tag-selection-single-key nil
3565 "Non-nil means fast tag selection exits after first change.
3566 When nil, you have to press RET to exit it.
3567 During fast tag selection, you can toggle this flag with `C-c'.
3568 This variable can also have the value `expert'. In this case, the window
3569 displaying the tags menu is not even shown, until you press C-c again."
3570 :group 'org-tags
3571 :type '(choice
3572 (const :tag "No" nil)
3573 (const :tag "Yes" t)
3574 (const :tag "Expert" expert)))
3576 (defvar org-fast-tag-selection-include-todo nil
3577 "Non-nil means fast tags selection interface will also offer TODO states.
3578 This is an undocumented feature, you should not rely on it.")
3580 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3581 "The column to which tags should be indented in a headline.
3582 If this number is positive, it specifies the column. If it is negative,
3583 it means that the tags should be flushright to that column. For example,
3584 -80 works well for a normal 80 character screen.
3585 When 0, place tags directly after headline text, with only one space in
3586 between."
3587 :group 'org-tags
3588 :type 'integer)
3590 (defcustom org-auto-align-tags t
3591 "Non-nil keeps tags aligned when modifying headlines.
3592 Some operations (i.e. demoting) change the length of a headline and
3593 therefore shift the tags around. With this option turned on, after
3594 each such operation the tags are again aligned to `org-tags-column'."
3595 :group 'org-tags
3596 :type 'boolean)
3598 (defcustom org-use-tag-inheritance t
3599 "Non-nil means tags in levels apply also for sublevels.
3600 When nil, only the tags directly given in a specific line apply there.
3601 This may also be a list of tags that should be inherited, or a regexp that
3602 matches tags that should be inherited. Additional control is possible
3603 with the variable `org-tags-exclude-from-inheritance' which gives an
3604 explicit list of tags to be excluded from inheritance, even if the value of
3605 `org-use-tag-inheritance' would select it for inheritance.
3607 If this option is t, a match early-on in a tree can lead to a large
3608 number of matches in the subtree when constructing the agenda or creating
3609 a sparse tree. If you only want to see the first match in a tree during
3610 a search, check out the variable `org-tags-match-list-sublevels'."
3611 :group 'org-tags
3612 :type '(choice
3613 (const :tag "Not" nil)
3614 (const :tag "Always" t)
3615 (repeat :tag "Specific tags" (string :tag "Tag"))
3616 (regexp :tag "Tags matched by regexp")))
3618 (defcustom org-tags-exclude-from-inheritance nil
3619 "List of tags that should never be inherited.
3620 This is a way to exclude a few tags from inheritance. For way to do
3621 the opposite, to actively allow inheritance for selected tags,
3622 see the variable `org-use-tag-inheritance'."
3623 :group 'org-tags
3624 :type '(repeat (string :tag "Tag")))
3626 (defun org-tag-inherit-p (tag)
3627 "Check if TAG is one that should be inherited."
3628 (cond
3629 ((member tag org-tags-exclude-from-inheritance) nil)
3630 ((eq org-use-tag-inheritance t) t)
3631 ((not org-use-tag-inheritance) nil)
3632 ((stringp org-use-tag-inheritance)
3633 (string-match org-use-tag-inheritance tag))
3634 ((listp org-use-tag-inheritance)
3635 (member tag org-use-tag-inheritance))
3636 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3638 (defcustom org-tags-match-list-sublevels t
3639 "Non-nil means list also sublevels of headlines matching a search.
3640 This variable applies to tags/property searches, and also to stuck
3641 projects because this search is based on a tags match as well.
3643 When set to the symbol `indented', sublevels are indented with
3644 leading dots.
3646 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3647 the sublevels of a headline matching a tag search often also match
3648 the same search. Listing all of them can create very long lists.
3649 Setting this variable to nil causes subtrees of a match to be skipped.
3651 This variable is semi-obsolete and probably should always be true. It
3652 is better to limit inheritance to certain tags using the variables
3653 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3654 :group 'org-tags
3655 :type '(choice
3656 (const :tag "No, don't list them" nil)
3657 (const :tag "Yes, do list them" t)
3658 (const :tag "List them, indented with leading dots" indented)))
3660 (defcustom org-tags-sort-function nil
3661 "When set, tags are sorted using this function as a comparator."
3662 :group 'org-tags
3663 :type '(choice
3664 (const :tag "No sorting" nil)
3665 (const :tag "Alphabetical" string<)
3666 (const :tag "Reverse alphabetical" string>)
3667 (function :tag "Custom function" nil)))
3669 (defvar org-tags-history nil
3670 "History of minibuffer reads for tags.")
3671 (defvar org-last-tags-completion-table nil
3672 "The last used completion table for tags.")
3673 (defvar org-after-tags-change-hook nil
3674 "Hook that is run after the tags in a line have changed.")
3676 (defgroup org-properties nil
3677 "Options concerning properties in Org-mode."
3678 :tag "Org Properties"
3679 :group 'org)
3681 (defcustom org-property-format "%-10s %s"
3682 "How property key/value pairs should be formatted by `indent-line'.
3683 When `indent-line' hits a property definition, it will format the line
3684 according to this format, mainly to make sure that the values are
3685 lined-up with respect to each other."
3686 :group 'org-properties
3687 :type 'string)
3689 (defcustom org-properties-postprocess-alist nil
3690 "Alist of properties and functions to adjust inserted values.
3691 Elements of this alist must be of the form
3693 ([string] [function])
3695 where [string] must be a property name and [function] must be a
3696 lambda expression: this lambda expression must take one argument,
3697 the value to adjust, and return the new value as a string.
3699 For example, this element will allow the property \"Remaining\"
3700 to be updated wrt the relation between the \"Effort\" property
3701 and the clock summary:
3703 ((\"Remaining\" (lambda(value)
3704 (let ((clocksum (org-clock-sum-current-item))
3705 (effort (org-duration-string-to-minutes
3706 (org-entry-get (point) \"Effort\"))))
3707 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3708 :group 'org-properties
3709 :version "24.1"
3710 :type '(alist :key-type (string :tag "Property")
3711 :value-type (function :tag "Function")))
3713 (defcustom org-use-property-inheritance nil
3714 "Non-nil means properties apply also for sublevels.
3716 This setting is chiefly used during property searches. Turning it on can
3717 cause significant overhead when doing a search, which is why it is not
3718 on by default.
3720 When nil, only the properties directly given in the current entry count.
3721 When t, every property is inherited. The value may also be a list of
3722 properties that should have inheritance, or a regular expression matching
3723 properties that should be inherited.
3725 However, note that some special properties use inheritance under special
3726 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3727 and the properties ending in \"_ALL\" when they are used as descriptor
3728 for valid values of a property.
3730 Note for programmers:
3731 When querying an entry with `org-entry-get', you can control if inheritance
3732 should be used. By default, `org-entry-get' looks only at the local
3733 properties. You can request inheritance by setting the inherit argument
3734 to t (to force inheritance) or to `selective' (to respect the setting
3735 in this variable)."
3736 :group 'org-properties
3737 :type '(choice
3738 (const :tag "Not" nil)
3739 (const :tag "Always" t)
3740 (repeat :tag "Specific properties" (string :tag "Property"))
3741 (regexp :tag "Properties matched by regexp")))
3743 (defun org-property-inherit-p (property)
3744 "Check if PROPERTY is one that should be inherited."
3745 (cond
3746 ((eq org-use-property-inheritance t) t)
3747 ((not org-use-property-inheritance) nil)
3748 ((stringp org-use-property-inheritance)
3749 (string-match org-use-property-inheritance property))
3750 ((listp org-use-property-inheritance)
3751 (member property org-use-property-inheritance))
3752 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3754 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3755 "The default column format, if no other format has been defined.
3756 This variable can be set on the per-file basis by inserting a line
3758 #+COLUMNS: %25ITEM ....."
3759 :group 'org-properties
3760 :type 'string)
3762 (defcustom org-columns-ellipses ".."
3763 "The ellipses to be used when a field in column view is truncated.
3764 When this is the empty string, as many characters as possible are shown,
3765 but then there will be no visual indication that the field has been truncated.
3766 When this is a string of length N, the last N characters of a truncated
3767 field are replaced by this string. If the column is narrower than the
3768 ellipses string, only part of the ellipses string will be shown."
3769 :group 'org-properties
3770 :type 'string)
3772 (defcustom org-columns-modify-value-for-display-function nil
3773 "Function that modifies values for display in column view.
3774 For example, it can be used to cut out a certain part from a time stamp.
3775 The function must take 2 arguments:
3777 column-title The title of the column (*not* the property name)
3778 value The value that should be modified.
3780 The function should return the value that should be displayed,
3781 or nil if the normal value should be used."
3782 :group 'org-properties
3783 :type '(choice (const nil) (function)))
3785 (defconst org-global-properties-fixed
3786 '(("VISIBILITY_ALL" . "folded children content all")
3787 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3788 "List of property/value pairs that can be inherited by any entry.
3790 These are fixed values, for the preset properties. The user variable
3791 that can be used to add to this list is `org-global-properties'.
3793 The entries in this list are cons cells where the car is a property
3794 name and cdr is a string with the value. If the value represents
3795 multiple items like an \"_ALL\" property, separate the items by
3796 spaces.")
3798 (defcustom org-global-properties nil
3799 "List of property/value pairs that can be inherited by any entry.
3801 This list will be combined with the constant `org-global-properties-fixed'.
3803 The entries in this list are cons cells where the car is a property
3804 name and cdr is a string with the value.
3806 You can set buffer-local values for the same purpose in the variable
3807 `org-file-properties' this by adding lines like
3809 #+PROPERTY: NAME VALUE"
3810 :group 'org-properties
3811 :type '(repeat
3812 (cons (string :tag "Property")
3813 (string :tag "Value"))))
3815 (defvar org-file-properties nil
3816 "List of property/value pairs that can be inherited by any entry.
3817 Valid for the current buffer.
3818 This variable is populated from #+PROPERTY lines.")
3819 (make-variable-buffer-local 'org-file-properties)
3821 (defgroup org-agenda nil
3822 "Options concerning agenda views in Org-mode."
3823 :tag "Org Agenda"
3824 :group 'org)
3826 (defvar org-category nil
3827 "Variable used by org files to set a category for agenda display.
3828 Such files should use a file variable to set it, for example
3830 # -*- mode: org; org-category: \"ELisp\"
3832 or contain a special line
3834 #+CATEGORY: ELisp
3836 If the file does not specify a category, then file's base name
3837 is used instead.")
3838 (make-variable-buffer-local 'org-category)
3839 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3841 (defcustom org-agenda-files nil
3842 "The files to be used for agenda display.
3843 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3844 \\[org-remove-file]. You can also use customize to edit the list.
3846 If an entry is a directory, all files in that directory that are matched by
3847 `org-agenda-file-regexp' will be part of the file list.
3849 If the value of the variable is not a list but a single file name, then
3850 the list of agenda files is actually stored and maintained in that file, one
3851 agenda file per line. In this file paths can be given relative to
3852 `org-directory'. Tilde expansion and environment variable substitution
3853 are also made."
3854 :group 'org-agenda
3855 :type '(choice
3856 (repeat :tag "List of files and directories" file)
3857 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3859 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3860 "Regular expression to match files for `org-agenda-files'.
3861 If any element in the list in that variable contains a directory instead
3862 of a normal file, all files in that directory that are matched by this
3863 regular expression will be included."
3864 :group 'org-agenda
3865 :type 'regexp)
3867 (defcustom org-agenda-text-search-extra-files nil
3868 "List of extra files to be searched by text search commands.
3869 These files will be searched in addition to the agenda files by the
3870 commands `org-search-view' (`\\[org-agenda] s') \
3871 and `org-occur-in-agenda-files'.
3872 Note that these files will only be searched for text search commands,
3873 not for the other agenda views like todo lists, tag searches or the weekly
3874 agenda. This variable is intended to list notes and possibly archive files
3875 that should also be searched by these two commands.
3876 In fact, if the first element in the list is the symbol `agenda-archives',
3877 then all archive files of all agenda files will be added to the search
3878 scope."
3879 :group 'org-agenda
3880 :type '(set :greedy t
3881 (const :tag "Agenda Archives" agenda-archives)
3882 (repeat :inline t (file))))
3884 (org-defvaralias 'org-agenda-multi-occur-extra-files
3885 'org-agenda-text-search-extra-files)
3887 (defcustom org-agenda-skip-unavailable-files nil
3888 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3889 A nil value means to remove them, after a query, from the list."
3890 :group 'org-agenda
3891 :type 'boolean)
3893 (defcustom org-calendar-to-agenda-key [?c]
3894 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3895 The command `org-calendar-goto-agenda' will be bound to this key. The
3896 default is the character `c' because then `c' can be used to switch back and
3897 forth between agenda and calendar."
3898 :group 'org-agenda
3899 :type 'sexp)
3901 (defcustom org-calendar-insert-diary-entry-key [?i]
3902 "The key to be installed in `calendar-mode-map' for adding diary entries.
3903 This option is irrelevant until `org-agenda-diary-file' has been configured
3904 to point to an Org-mode file. When that is the case, the command
3905 `org-agenda-diary-entry' will be bound to the key given here, by default
3906 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3907 if you want to continue doing this, you need to change this to a different
3908 key."
3909 :group 'org-agenda
3910 :type 'sexp)
3912 (defcustom org-agenda-diary-file 'diary-file
3913 "File to which to add new entries with the `i' key in agenda and calendar.
3914 When this is the symbol `diary-file', the functionality in the Emacs
3915 calendar will be used to add entries to the `diary-file'. But when this
3916 points to a file, `org-agenda-diary-entry' will be used instead."
3917 :group 'org-agenda
3918 :type '(choice
3919 (const :tag "The standard Emacs diary file" diary-file)
3920 (file :tag "Special Org file diary entries")))
3922 (eval-after-load "calendar"
3923 '(progn
3924 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3925 'org-calendar-goto-agenda)
3926 (add-hook 'calendar-mode-hook
3927 (lambda ()
3928 (unless (eq org-agenda-diary-file 'diary-file)
3929 (define-key calendar-mode-map
3930 org-calendar-insert-diary-entry-key
3931 'org-agenda-diary-entry))))))
3933 (defgroup org-latex nil
3934 "Options for embedding LaTeX code into Org-mode."
3935 :tag "Org LaTeX"
3936 :group 'org)
3938 (defcustom org-format-latex-options
3939 '(:foreground default :background default :scale 1.0
3940 :html-foreground "Black" :html-background "Transparent"
3941 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3942 "Options for creating images from LaTeX fragments.
3943 This is a property list with the following properties:
3944 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3945 `default' means use the foreground of the default face.
3946 `auto' means use the foreground from the text face.
3947 :background the background color, or \"Transparent\".
3948 `default' means use the background of the default face.
3949 `auto' means use the background from the text face.
3950 :scale a scaling factor for the size of the images, to get more pixels
3951 :html-foreground, :html-background, :html-scale
3952 the same numbers for HTML export.
3953 :matchers a list indicating which matchers should be used to
3954 find LaTeX fragments. Valid members of this list are:
3955 \"begin\" find environments
3956 \"$1\" find single characters surrounded by $.$
3957 \"$\" find math expressions surrounded by $...$
3958 \"$$\" find math expressions surrounded by $$....$$
3959 \"\\(\" find math expressions surrounded by \\(...\\)
3960 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3961 :group 'org-latex
3962 :type 'plist)
3964 (defcustom org-format-latex-signal-error t
3965 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3966 When nil, just push out a message."
3967 :group 'org-latex
3968 :version "24.1"
3969 :type 'boolean)
3971 (defcustom org-latex-to-mathml-jar-file nil
3972 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3973 Use this to specify additional executable file say a jar file.
3975 When using MathToWeb as the converter, specify the full-path to
3976 your mathtoweb.jar file."
3977 :group 'org-latex
3978 :version "24.1"
3979 :type '(choice
3980 (const :tag "None" nil)
3981 (file :tag "JAR file" :must-match t)))
3983 (defcustom org-latex-to-mathml-convert-command nil
3984 "Command to convert LaTeX fragments to MathML.
3985 Replace format-specifiers in the command as noted below and use
3986 `shell-command' to convert LaTeX to MathML.
3987 %j: Executable file in fully expanded form as specified by
3988 `org-latex-to-mathml-jar-file'.
3989 %I: Input LaTeX file in fully expanded form.
3990 %i: The latex fragment to be converted.
3991 %o: Output MathML file.
3993 This command is used by `org-create-math-formula'.
3995 When using MathToWeb as the converter, set this option to
3996 \"java -jar %j -unicode -force -df %o %I\".
3998 When using LaTeXML set this option to
3999 \"latexmlmath \"%i\" --presentationmathml=%o\"."
4000 :group 'org-latex
4001 :version "24.1"
4002 :type '(choice
4003 (const :tag "None" nil)
4004 (string :tag "\nShell command")))
4006 (defcustom org-latex-create-formula-image-program 'dvipng
4007 "Program to convert LaTeX fragments with.
4009 dvipng Process the LaTeX fragments to dvi file, then convert
4010 dvi files to png files using dvipng.
4011 This will also include processing of non-math environments.
4012 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
4013 to convert pdf files to png files"
4014 :group 'org-latex
4015 :version "24.1"
4016 :type '(choice
4017 (const :tag "dvipng" dvipng)
4018 (const :tag "imagemagick" imagemagick)))
4020 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4021 "Path to store latex preview images.
4022 A relative path here creates many directories relative to the
4023 processed org files paths. An absolute path puts all preview
4024 images at the same place."
4025 :group 'org-latex
4026 :version "24.3"
4027 :type 'string)
4029 (defun org-format-latex-mathml-available-p ()
4030 "Return t if `org-latex-to-mathml-convert-command' is usable."
4031 (save-match-data
4032 (when (and (boundp 'org-latex-to-mathml-convert-command)
4033 org-latex-to-mathml-convert-command)
4034 (let ((executable (car (split-string
4035 org-latex-to-mathml-convert-command))))
4036 (when (executable-find executable)
4037 (if (string-match
4038 "%j" org-latex-to-mathml-convert-command)
4039 (file-readable-p org-latex-to-mathml-jar-file)
4040 t))))))
4042 (defcustom org-format-latex-header "\\documentclass{article}
4043 \\usepackage[usenames]{color}
4044 \[PACKAGES]
4045 \[DEFAULT-PACKAGES]
4046 \\pagestyle{empty} % do not remove
4047 % The settings below are copied from fullpage.sty
4048 \\setlength{\\textwidth}{\\paperwidth}
4049 \\addtolength{\\textwidth}{-3cm}
4050 \\setlength{\\oddsidemargin}{1.5cm}
4051 \\addtolength{\\oddsidemargin}{-2.54cm}
4052 \\setlength{\\evensidemargin}{\\oddsidemargin}
4053 \\setlength{\\textheight}{\\paperheight}
4054 \\addtolength{\\textheight}{-\\headheight}
4055 \\addtolength{\\textheight}{-\\headsep}
4056 \\addtolength{\\textheight}{-\\footskip}
4057 \\addtolength{\\textheight}{-3cm}
4058 \\setlength{\\topmargin}{1.5cm}
4059 \\addtolength{\\topmargin}{-2.54cm}"
4060 "The document header used for processing LaTeX fragments.
4061 It is imperative that this header make sure that no page number
4062 appears on the page. The package defined in the variables
4063 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4064 will either replace the placeholder \"[PACKAGES]\" in this
4065 header, or they will be appended."
4066 :group 'org-latex
4067 :type 'string)
4069 (defun org-set-packages-alist (var val)
4070 "Set the packages alist and make sure it has 3 elements per entry."
4071 (set var (mapcar (lambda (x)
4072 (if (and (consp x) (= (length x) 2))
4073 (list (car x) (nth 1 x) t)
4075 val)))
4077 (defun org-get-packages-alist (var)
4078 "Get the packages alist and make sure it has 3 elements per entry."
4079 (mapcar (lambda (x)
4080 (if (and (consp x) (= (length x) 2))
4081 (list (car x) (nth 1 x) t)
4083 (default-value var)))
4085 (defcustom org-latex-default-packages-alist
4086 '(("AUTO" "inputenc" t)
4087 ("T1" "fontenc" t)
4088 ("" "fixltx2e" nil)
4089 ("" "graphicx" t)
4090 ("" "grffile" t)
4091 ("" "longtable" nil)
4092 ("" "wrapfig" nil)
4093 ("" "rotating" nil)
4094 ("normalem" "ulem" t)
4095 ("" "amsmath" t)
4096 ("" "textcomp" t)
4097 ("" "amssymb" t)
4098 ("" "capt-of" nil)
4099 ("" "hyperref" nil))
4100 "Alist of default packages to be inserted in the header.
4102 Change this only if one of the packages here causes an
4103 incompatibility with another package you are using.
4105 The packages in this list are needed by one part or another of
4106 Org mode to function properly:
4108 - inputenc, fontenc: for basic font and character selection
4109 - fixltx2e: Important patches of LaTeX itself
4110 - graphicx: for including images
4111 - grffile: allow periods and spaces in graphics file names
4112 - longtable: For multipage tables
4113 - wrapfig: for figure placement
4114 - rotating: for sideways figures and tables
4115 - ulem: for underline and strike-through
4116 - amsmath: for subscript and superscript and math environments
4117 - textcomp, amssymb: for various symbols used
4118 for interpreting the entities in `org-entities'. You can skip
4119 some of these packages if you don't use any of their symbols.
4120 - capt-of: for captions outside of floats
4121 - hyperref: for cross references
4123 Therefore you should not modify this variable unless you know
4124 what you are doing. The one reason to change it anyway is that
4125 you might be loading some other package that conflicts with one
4126 of the default packages. Each element is either a cell or
4127 a string.
4129 A cell is of the format
4131 (\"options\" \"package\" SNIPPET-FLAG)
4133 If SNIPPET-FLAG is non-nil, the package also needs to be included
4134 when compiling LaTeX snippets into images for inclusion into
4135 non-LaTeX output.
4137 A string will be inserted as-is in the header of the document."
4138 :group 'org-latex
4139 :group 'org-export-latex
4140 :set 'org-set-packages-alist
4141 :get 'org-get-packages-alist
4142 :version "25.1"
4143 :package-version '(Org . "8.3")
4144 :type '(repeat
4145 (choice
4146 (list :tag "options/package pair"
4147 (string :tag "options")
4148 (string :tag "package")
4149 (boolean :tag "Snippet"))
4150 (string :tag "A line of LaTeX"))))
4152 (defcustom org-latex-packages-alist nil
4153 "Alist of packages to be inserted in every LaTeX header.
4155 These will be inserted after `org-latex-default-packages-alist'.
4156 Each element is either a cell or a string.
4158 A cell is of the format:
4160 (\"options\" \"package\" SNIPPET-FLAG)
4162 SNIPPET-FLAG, when non-nil, indicates that this package is also
4163 needed when turning LaTeX snippets into images for inclusion into
4164 non-LaTeX output.
4166 A string will be inserted as-is in the header of the document.
4168 Make sure that you only list packages here which:
4170 - you want in every file;
4171 - do not conflict with the setup in `org-format-latex-header';
4172 - do not conflict with the default packages in
4173 `org-latex-default-packages-alist'."
4174 :group 'org-latex
4175 :group 'org-export-latex
4176 :set 'org-set-packages-alist
4177 :get 'org-get-packages-alist
4178 :type '(repeat
4179 (choice
4180 (list :tag "options/package pair"
4181 (string :tag "options")
4182 (string :tag "package")
4183 (boolean :tag "Snippet"))
4184 (string :tag "A line of LaTeX"))))
4186 (defgroup org-appearance nil
4187 "Settings for Org-mode appearance."
4188 :tag "Org Appearance"
4189 :group 'org)
4191 (defcustom org-level-color-stars-only nil
4192 "Non-nil means fontify only the stars in each headline.
4193 When nil, the entire headline is fontified.
4194 Changing it requires restart of `font-lock-mode' to become effective
4195 also in regions already fontified."
4196 :group 'org-appearance
4197 :type 'boolean)
4199 (defcustom org-hide-leading-stars nil
4200 "Non-nil means hide the first N-1 stars in a headline.
4201 This works by using the face `org-hide' for these stars. This
4202 face is white for a light background, and black for a dark
4203 background. You may have to customize the face `org-hide' to
4204 make this work.
4205 Changing it requires restart of `font-lock-mode' to become effective
4206 also in regions already fontified.
4207 You may also set this on a per-file basis by adding one of the following
4208 lines to the buffer:
4210 #+STARTUP: hidestars
4211 #+STARTUP: showstars"
4212 :group 'org-appearance
4213 :type 'boolean)
4215 (defcustom org-hidden-keywords nil
4216 "List of symbols corresponding to keywords to be hidden the org buffer.
4217 For example, a value \\='(title) for this list will make the document's title
4218 appear in the buffer without the initial #+TITLE: keyword."
4219 :group 'org-appearance
4220 :version "24.1"
4221 :type '(set (const :tag "#+AUTHOR" author)
4222 (const :tag "#+DATE" date)
4223 (const :tag "#+EMAIL" email)
4224 (const :tag "#+TITLE" title)))
4226 (defcustom org-custom-properties nil
4227 "List of properties (as strings) with a special meaning.
4228 The default use of these custom properties is to let the user
4229 hide them with `org-toggle-custom-properties-visibility'."
4230 :group 'org-properties
4231 :group 'org-appearance
4232 :version "24.3"
4233 :type '(repeat (string :tag "Property Name")))
4235 (defcustom org-fontify-done-headline nil
4236 "Non-nil means change the face of a headline if it is marked DONE.
4237 Normally, only the TODO/DONE keyword indicates the state of a headline.
4238 When this is non-nil, the headline after the keyword is set to the
4239 `org-headline-done' as an additional indication."
4240 :group 'org-appearance
4241 :type 'boolean)
4243 (defcustom org-fontify-emphasized-text t
4244 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4245 Changing this variable requires a restart of Emacs to take effect."
4246 :group 'org-appearance
4247 :type 'boolean)
4249 (defcustom org-fontify-whole-heading-line nil
4250 "Non-nil means fontify the whole line for headings.
4251 This is useful when setting a background color for the
4252 org-level-* faces."
4253 :group 'org-appearance
4254 :type 'boolean)
4256 (defcustom org-highlight-latex-and-related nil
4257 "Non-nil means highlight LaTeX related syntax in the buffer.
4258 When non nil, the value should be a list containing any of the
4259 following symbols:
4260 `latex' Highlight LaTeX snippets and environments.
4261 `script' Highlight subscript and superscript.
4262 `entities' Highlight entities."
4263 :group 'org-appearance
4264 :version "24.4"
4265 :package-version '(Org . "8.0")
4266 :type '(choice
4267 (const :tag "No highlighting" nil)
4268 (set :greedy t :tag "Highlight"
4269 (const :tag "LaTeX snippets and environments" latex)
4270 (const :tag "Subscript and superscript" script)
4271 (const :tag "Entities" entities))))
4273 (defcustom org-hide-emphasis-markers nil
4274 "Non-nil mean font-lock should hide the emphasis marker characters."
4275 :group 'org-appearance
4276 :type 'boolean)
4278 (defcustom org-hide-macro-markers nil
4279 "Non-nil mean font-lock should hide the brackets marking macro calls."
4280 :group 'org-appearance
4281 :type 'boolean)
4283 (defcustom org-pretty-entities nil
4284 "Non-nil means show entities as UTF8 characters.
4285 When nil, the \\name form remains in the buffer."
4286 :group 'org-appearance
4287 :version "24.1"
4288 :type 'boolean)
4290 (defcustom org-pretty-entities-include-sub-superscripts t
4291 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4292 :group 'org-appearance
4293 :version "24.1"
4294 :type 'boolean)
4296 (defvar org-emph-re nil
4297 "Regular expression for matching emphasis.
4298 After a match, the match groups contain these elements:
4299 0 The match of the full regular expression, including the characters
4300 before and after the proper match
4301 1 The character before the proper match, or empty at beginning of line
4302 2 The proper match, including the leading and trailing markers
4303 3 The leading marker like * or /, indicating the type of highlighting
4304 4 The text between the emphasis markers, not including the markers
4305 5 The character after the match, empty at the end of a line")
4306 (defvar org-verbatim-re nil
4307 "Regular expression for matching verbatim text.")
4308 (defvar org-emphasis-regexp-components) ; defined just below
4309 (defvar org-emphasis-alist) ; defined just below
4310 (defun org-set-emph-re (var val)
4311 "Set variable and compute the emphasis regular expression."
4312 (set var val)
4313 (when (and (boundp 'org-emphasis-alist)
4314 (boundp 'org-emphasis-regexp-components)
4315 org-emphasis-alist org-emphasis-regexp-components)
4316 (let* ((e org-emphasis-regexp-components)
4317 (pre (car e))
4318 (post (nth 1 e))
4319 (border (nth 2 e))
4320 (body (nth 3 e))
4321 (nl (nth 4 e))
4322 (body1 (concat body "*?"))
4323 (markers (mapconcat 'car org-emphasis-alist ""))
4324 (vmarkers (mapconcat
4325 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4326 org-emphasis-alist "")))
4327 ;; make sure special characters appear at the right position in the class
4328 (if (string-match "\\^" markers)
4329 (setq markers (concat (replace-match "" t t markers) "^")))
4330 (if (string-match "-" markers)
4331 (setq markers (concat (replace-match "" t t markers) "-")))
4332 (if (string-match "\\^" vmarkers)
4333 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4334 (if (string-match "-" vmarkers)
4335 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4336 (if (> nl 0)
4337 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4338 (int-to-string nl) "\\}")))
4339 ;; Make the regexp
4340 (setq org-emph-re
4341 (concat "\\([" pre "]\\|^\\)"
4342 "\\("
4343 "\\([" markers "]\\)"
4344 "\\("
4345 "[^" border "]\\|"
4346 "[^" border "]"
4347 body1
4348 "[^" border "]"
4349 "\\)"
4350 "\\3\\)"
4351 "\\([" post "]\\|$\\)"))
4352 (setq org-verbatim-re
4353 (concat "\\([" pre "]\\|^\\)"
4354 "\\("
4355 "\\([" vmarkers "]\\)"
4356 "\\("
4357 "[^" border "]\\|"
4358 "[^" border "]"
4359 body1
4360 "[^" border "]"
4361 "\\)"
4362 "\\3\\)"
4363 "\\([" post "]\\|$\\)")))))
4365 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4366 ;; set this option proved cumbersome. See this message/thread:
4367 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4368 (defvar org-emphasis-regexp-components
4369 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4370 "Components used to build the regular expression for emphasis.
4371 This is a list with five entries. Terminology: In an emphasis string
4372 like \" *strong word* \", we call the initial space PREMATCH, the final
4373 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4374 and \"trong wor\" is the body. The different components in this variable
4375 specify what is allowed/forbidden in each part:
4377 pre Chars allowed as prematch. Beginning of line will be allowed too.
4378 post Chars allowed as postmatch. End of line will be allowed too.
4379 border The chars *forbidden* as border characters.
4380 body-regexp A regexp like \".\" to match a body character. Don't use
4381 non-shy groups here, and don't allow newline here.
4382 newline The maximum number of newlines allowed in an emphasis exp.
4384 You need to reload Org or to restart Emacs after customizing this.")
4386 (defcustom org-emphasis-alist
4387 `(("*" bold)
4388 ("/" italic)
4389 ("_" underline)
4390 ("=" org-verbatim verbatim)
4391 ("~" org-code verbatim)
4392 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4393 "Alist of characters and faces to emphasize text.
4394 Text starting and ending with a special character will be emphasized,
4395 for example *bold*, _underlined_ and /italic/. This variable sets the
4396 marker characters and the face to be used by font-lock for highlighting
4397 in Org-mode Emacs buffers.
4399 You need to reload Org or to restart Emacs after customizing this."
4400 :group 'org-appearance
4401 :set 'org-set-emph-re
4402 :version "24.4"
4403 :package-version '(Org . "8.0")
4404 :type '(repeat
4405 (list
4406 (string :tag "Marker character")
4407 (choice
4408 (face :tag "Font-lock-face")
4409 (plist :tag "Face property list"))
4410 (option (const verbatim)))))
4412 (defvar org-protecting-blocks
4413 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4414 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4415 This is needed for font-lock setup.")
4417 ;;; Miscellaneous options
4419 (defgroup org-completion nil
4420 "Completion in Org-mode."
4421 :tag "Org Completion"
4422 :group 'org)
4424 (defcustom org-completion-use-ido nil
4425 "Non-nil means use ido completion wherever possible.
4426 Note that `ido-mode' must be active for this variable to be relevant.
4427 If you decide to turn this variable on, you might well want to turn off
4428 `org-outline-path-complete-in-steps'.
4429 See also `org-completion-use-iswitchb'."
4430 :group 'org-completion
4431 :type 'boolean)
4433 (defcustom org-completion-use-iswitchb nil
4434 "Non-nil means use iswitchb completion wherever possible.
4435 Note that `iswitchb-mode' must be active for this variable to be relevant.
4436 If you decide to turn this variable on, you might well want to turn off
4437 `org-outline-path-complete-in-steps'.
4438 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4439 :group 'org-completion
4440 :type 'boolean)
4442 (defcustom org-completion-fallback-command 'hippie-expand
4443 "The expansion command called by \\[pcomplete] in normal context.
4444 Normal means, no org-mode-specific context."
4445 :group 'org-completion
4446 :type 'function)
4448 ;;; Functions and variables from their packages
4449 ;; Declared here to avoid compiler warnings
4451 ;; XEmacs only
4452 (defvar outline-mode-menu-heading)
4453 (defvar outline-mode-menu-show)
4454 (defvar outline-mode-menu-hide)
4455 (defvar zmacs-regions) ; XEmacs regions
4457 ;; Emacs only
4458 (defvar mark-active)
4460 ;; Various packages
4461 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4462 (declare-function calendar-forward-day "cal-move" (arg))
4463 (declare-function calendar-goto-date "cal-move" (date))
4464 (declare-function calendar-goto-today "cal-move" ())
4465 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4466 (defvar calc-embedded-close-formula)
4467 (defvar calc-embedded-open-formula)
4468 (declare-function cdlatex-tab "ext:cdlatex" ())
4469 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4470 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4471 (defvar font-lock-unfontify-region-function)
4472 (declare-function iswitchb-read-buffer "iswitchb"
4473 (prompt &optional default require-match start matches-set))
4474 (defvar iswitchb-temp-buflist)
4475 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4476 (defvar org-agenda-tags-todo-honor-ignore-options)
4477 (declare-function org-agenda-skip "org-agenda" ())
4478 (declare-function
4479 org-agenda-format-item "org-agenda"
4480 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4481 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4482 (declare-function org-agenda-change-all-lines "org-agenda"
4483 (newhead hdmarker &optional fixface just-this))
4484 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4485 (declare-function org-agenda-maybe-redo "org-agenda" ())
4486 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4487 (beg end))
4488 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4489 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4490 "org-agenda" (&optional end))
4491 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4492 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4493 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4494 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4495 (declare-function org-indent-mode "org-indent" (&optional arg))
4496 (declare-function parse-time-string "parse-time" (string))
4497 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4498 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4499 (defvar remember-data-file)
4500 (defvar texmathp-why)
4501 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4502 (declare-function table--at-cell-p "table" (position &optional object at-column))
4503 (declare-function calc-eval "calc" (str &optional separator &rest args))
4505 ;;;###autoload
4506 (defun turn-on-orgtbl ()
4507 "Unconditionally turn on `orgtbl-mode'."
4508 (require 'org-table)
4509 (orgtbl-mode 1))
4511 (defun org-at-table-p (&optional table-type)
4512 "Non-nil if the cursor is inside an Org table.
4513 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4514 If `org-enable-table-editor' is nil, return nil unconditionally."
4515 (and
4516 org-enable-table-editor
4517 (save-excursion
4518 (beginning-of-line)
4519 (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4520 (or (not (derived-mode-p 'org-mode))
4521 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4522 (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4523 (defsubst org-table-p () (org-at-table-p))
4525 (defun org-at-table.el-p ()
4526 "Non-nil when point is at a table.el table."
4527 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4528 (let ((element (org-element-at-point)))
4529 (and (eq (org-element-type element) 'table)
4530 (eq (org-element-property :type element) 'table.el)))))
4532 (defun org-table-recognize-table.el ()
4533 "If there is a table.el table nearby, recognize it and move into it."
4534 (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4535 (beginning-of-line)
4536 (unless (or (looking-at org-table-dataline-regexp)
4537 (not (looking-at org-table1-hline-regexp)))
4538 (forward-line)
4539 (when (looking-at org-table-any-border-regexp)
4540 (forward-line -2)))
4541 (if (re-search-forward "|" (org-table-end t) t)
4542 (progn
4543 (require 'table)
4544 (if (table--at-cell-p (point)) t
4545 (message "recognizing table.el table...")
4546 (table-recognize-table)
4547 (message "recognizing table.el table...done")))
4548 (error "This should not happen"))))
4550 (defun org-at-table-hline-p ()
4551 "Non-nil when point is inside a hline in a table.
4552 Assume point is already in a table. If `org-enable-table-editor'
4553 is nil, return nil unconditionally."
4554 (and org-enable-table-editor
4555 (save-excursion
4556 (beginning-of-line)
4557 (looking-at org-table-hline-regexp))))
4559 (defun org-table-map-tables (function &optional quietly)
4560 "Apply FUNCTION to the start of all tables in the buffer."
4561 (save-excursion
4562 (save-restriction
4563 (widen)
4564 (goto-char (point-min))
4565 (while (re-search-forward org-table-any-line-regexp nil t)
4566 (unless quietly
4567 (message "Mapping tables: %d%%"
4568 (floor (* 100.0 (point)) (buffer-size))))
4569 (beginning-of-line 1)
4570 (when (and (looking-at org-table-line-regexp)
4571 ;; Exclude tables in src/example/verbatim/clocktable blocks
4572 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4573 (save-excursion (funcall function))
4574 (or (looking-at org-table-line-regexp)
4575 (forward-char 1)))
4576 (re-search-forward org-table-any-border-regexp nil 1))))
4577 (unless quietly (message "Mapping tables: done")))
4579 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4580 (declare-function org-clock-update-mode-line "org-clock" ())
4581 (declare-function org-resolve-clocks "org-clock"
4582 (&optional also-non-dangling-p prompt last-valid))
4584 (defun org-at-TBLFM-p (&optional pos)
4585 "Non-nil when point (or POS) is in #+TBLFM line."
4586 (save-excursion
4587 (goto-char (or pos (point)))
4588 (beginning-of-line)
4589 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4590 (eq (org-element-type (org-element-at-point)) 'table))))
4592 (defvar org-clock-start-time)
4593 (defvar org-clock-marker (make-marker)
4594 "Marker recording the last clock-in.")
4595 (defvar org-clock-hd-marker (make-marker)
4596 "Marker recording the last clock-in, but the headline position.")
4597 (defvar org-clock-heading ""
4598 "The heading of the current clock entry.")
4599 (defun org-clock-is-active ()
4600 "Return the buffer where the clock is currently running.
4601 Return nil if no clock is running."
4602 (marker-buffer org-clock-marker))
4604 (defun org-check-running-clock ()
4605 "Check if the current buffer contains the running clock.
4606 If yes, offer to stop it and to save the buffer with the changes."
4607 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4608 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4609 (buffer-name))))
4610 (org-clock-out)
4611 (when (y-or-n-p "Save changed buffer?")
4612 (save-buffer))))
4614 (defun org-clocktable-try-shift (dir n)
4615 "Check if this line starts a clock table, if yes, shift the time block."
4616 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4617 (org-clocktable-shift dir n)))
4619 ;;;###autoload
4620 (defun org-clock-persistence-insinuate ()
4621 "Set up hooks for clock persistence."
4622 (require 'org-clock)
4623 (add-hook 'org-mode-hook 'org-clock-load)
4624 (add-hook 'kill-emacs-hook 'org-clock-save))
4626 (defgroup org-archive nil
4627 "Options concerning archiving in Org-mode."
4628 :tag "Org Archive"
4629 :group 'org-structure)
4631 (defcustom org-archive-location "%s_archive::"
4632 "The location where subtrees should be archived.
4634 The value of this variable is a string, consisting of two parts,
4635 separated by a double-colon. The first part is a filename and
4636 the second part is a headline.
4638 When the filename is omitted, archiving happens in the same file.
4639 %s in the filename will be replaced by the current file
4640 name (without the directory part). Archiving to a different file
4641 is useful to keep archived entries from contributing to the
4642 Org-mode Agenda.
4644 The archived entries will be filed as subtrees of the specified
4645 headline. When the headline is omitted, the subtrees are simply
4646 filed away at the end of the file, as top-level entries. Also in
4647 the heading you can use %s to represent the file name, this can be
4648 useful when using the same archive for a number of different files.
4650 Here are a few examples:
4651 \"%s_archive::\"
4652 If the current file is Projects.org, archive in file
4653 Projects.org_archive, as top-level trees. This is the default.
4655 \"::* Archived Tasks\"
4656 Archive in the current file, under the top-level headline
4657 \"* Archived Tasks\".
4659 \"~/org/archive.org::\"
4660 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4662 \"~/org/archive.org::* From %s\"
4663 Archive in file ~/org/archive.org (absolute path), under headlines
4664 \"From FILENAME\" where file name is the current file name.
4666 \"~/org/datetree.org::datetree/* Finished Tasks\"
4667 The \"datetree/\" string is special, signifying to archive
4668 items to the datetree. Items are placed in either the CLOSED
4669 date of the item, or the current date if there is no CLOSED date.
4670 The heading will be a subentry to the current date. There doesn't
4671 need to be a heading, but there always needs to be a slash after
4672 datetree. For example, to store archived items directly in the
4673 datetree, use \"~/org/datetree.org::datetree/\".
4675 \"basement::** Finished Tasks\"
4676 Archive in file ./basement (relative path), as level 3 trees
4677 below the level 2 heading \"** Finished Tasks\".
4679 You may set this option on a per-file basis by adding to the buffer a
4680 line like
4682 #+ARCHIVE: basement::** Finished Tasks
4684 You may also define it locally for a subtree by setting an ARCHIVE property
4685 in the entry. If such a property is found in an entry, or anywhere up
4686 the hierarchy, it will be used."
4687 :group 'org-archive
4688 :type 'string)
4690 (defcustom org-agenda-skip-archived-trees t
4691 "Non-nil means the agenda will skip any items located in archived trees.
4692 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4693 variable is no longer recommended, you should leave it at the value t.
4694 Instead, use the key `v' to cycle the archives-mode in the agenda."
4695 :group 'org-archive
4696 :group 'org-agenda-skip
4697 :type 'boolean)
4699 (defcustom org-columns-skip-archived-trees t
4700 "Non-nil means ignore archived trees when creating column view."
4701 :group 'org-archive
4702 :group 'org-properties
4703 :type 'boolean)
4705 (defcustom org-cycle-open-archived-trees nil
4706 "Non-nil means `org-cycle' will open archived trees.
4707 An archived tree is a tree marked with the tag ARCHIVE.
4708 When nil, archived trees will stay folded. You can still open them with
4709 normal outline commands like `show-all', but not with the cycling commands."
4710 :group 'org-archive
4711 :group 'org-cycle
4712 :type 'boolean)
4714 (defcustom org-sparse-tree-open-archived-trees nil
4715 "Non-nil means sparse tree construction shows matches in archived trees.
4716 When nil, matches in these trees are highlighted, but the trees are kept in
4717 collapsed state."
4718 :group 'org-archive
4719 :group 'org-sparse-trees
4720 :type 'boolean)
4722 (defcustom org-sparse-tree-default-date-type nil
4723 "The default date type when building a sparse tree.
4724 When this is nil, a date is a scheduled or a deadline timestamp.
4725 Otherwise, these types are allowed:
4727 all: all timestamps
4728 active: only active timestamps (<...>)
4729 inactive: only inactive timestamps ([...])
4730 scheduled: only scheduled timestamps
4731 deadline: only deadline timestamps"
4732 :type '(choice (const :tag "Scheduled or deadline" nil)
4733 (const :tag "All timestamps" all)
4734 (const :tag "Only active timestamps" active)
4735 (const :tag "Only inactive timestamps" inactive)
4736 (const :tag "Only scheduled timestamps" scheduled)
4737 (const :tag "Only deadline timestamps" deadline)
4738 (const :tag "Only closed timestamps" closed))
4739 :version "25.1"
4740 :package-version '(Org . "8.3")
4741 :group 'org-sparse-trees)
4743 (defun org-cycle-hide-archived-subtrees (state)
4744 "Re-hide all archived subtrees after a visibility state change."
4745 (when (and (not org-cycle-open-archived-trees)
4746 (not (memq state '(overview folded))))
4747 (save-excursion
4748 (let* ((globalp (memq state '(contents all)))
4749 (beg (if globalp (point-min) (point)))
4750 (end (if globalp (point-max) (org-end-of-subtree t))))
4751 (org-hide-archived-subtrees beg end)
4752 (goto-char beg)
4753 (if (looking-at (concat ".*:" org-archive-tag ":"))
4754 (message "%s" (substitute-command-keys
4755 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4757 (defun org-force-cycle-archived ()
4758 "Cycle subtree even if it is archived."
4759 (interactive)
4760 (setq this-command 'org-cycle)
4761 (let ((org-cycle-open-archived-trees t))
4762 (call-interactively 'org-cycle)))
4764 (defun org-hide-archived-subtrees (beg end)
4765 "Re-hide all archived subtrees after a visibility state change."
4766 (org-with-wide-buffer
4767 (let ((case-fold-search nil)
4768 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4769 (goto-char beg)
4770 ;; Include headline point is currently on.
4771 (beginning-of-line)
4772 (while (and (< (point) end) (re-search-forward re end t))
4773 (when (member org-archive-tag (org-get-tags))
4774 (org-flag-subtree t)
4775 (org-end-of-subtree t))))))
4777 (declare-function outline-end-of-heading "outline" ())
4778 (declare-function outline-flag-region "outline" (from to flag))
4779 (defun org-flag-subtree (flag)
4780 (save-excursion
4781 (org-back-to-heading t)
4782 (outline-end-of-heading)
4783 (outline-flag-region (point)
4784 (progn (org-end-of-subtree t) (point))
4785 flag)))
4787 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4789 ;; Declare Column View Code
4791 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4792 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4793 (declare-function org-columns-compute "org-colview" (property))
4795 ;; Declare ID code
4797 (declare-function org-id-store-link "org-id")
4798 (declare-function org-id-locations-load "org-id")
4799 (declare-function org-id-locations-save "org-id")
4800 (defvar org-id-track-globally)
4802 ;;; Variables for pre-computed regular expressions, all buffer local
4804 (defvar org-todo-regexp nil
4805 "Matches any of the TODO state keywords.")
4806 (make-variable-buffer-local 'org-todo-regexp)
4807 (defvar org-not-done-regexp nil
4808 "Matches any of the TODO state keywords except the last one.")
4809 (make-variable-buffer-local 'org-not-done-regexp)
4810 (defvar org-not-done-heading-regexp nil
4811 "Matches a TODO headline that is not done.")
4812 (make-variable-buffer-local 'org-not-done-heading-regexp)
4813 (defvar org-todo-line-regexp nil
4814 "Matches a headline and puts TODO state into group 2 if present.")
4815 (make-variable-buffer-local 'org-todo-line-regexp)
4816 (defvar org-complex-heading-regexp nil
4817 "Matches a headline and puts everything into groups:
4818 group 1: the stars
4819 group 2: The todo keyword, maybe
4820 group 3: Priority cookie
4821 group 4: True headline
4822 group 5: Tags")
4823 (make-variable-buffer-local 'org-complex-heading-regexp)
4824 (defvar org-complex-heading-regexp-format nil
4825 "Printf format to make regexp to match an exact headline.
4826 This regexp will match the headline of any node which has the
4827 exact headline text that is put into the format, but may have any
4828 TODO state, priority and tags.")
4829 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4830 (defvar org-todo-line-tags-regexp nil
4831 "Matches a headline and puts TODO state into group 2 if present.
4832 Also put tags into group 4 if tags are present.")
4833 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4835 (defconst org-plain-time-of-day-regexp
4836 (concat
4837 "\\(\\<[012]?[0-9]"
4838 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4839 "\\(--?"
4840 "\\(\\<[012]?[0-9]"
4841 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4842 "\\)?")
4843 "Regular expression to match a plain time or time range.
4844 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4845 groups carry important information:
4846 0 the full match
4847 1 the first time, range or not
4848 8 the second time, if it is a range.")
4850 (defconst org-plain-time-extension-regexp
4851 (concat
4852 "\\(\\<[012]?[0-9]"
4853 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4854 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4855 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4856 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4857 groups carry important information:
4858 0 the full match
4859 7 hours of duration
4860 9 minutes of duration")
4862 (defconst org-stamp-time-of-day-regexp
4863 (concat
4864 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4865 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4866 "\\(--?"
4867 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4868 "Regular expression to match a timestamp time or time range.
4869 After a match, the following groups carry important information:
4870 0 the full match
4871 1 date plus weekday, for back referencing to make sure both times are on the same day
4872 2 the first time, range or not
4873 4 the second time, if it is a range.")
4875 (defconst org-startup-options
4876 '(("fold" org-startup-folded t)
4877 ("overview" org-startup-folded t)
4878 ("nofold" org-startup-folded nil)
4879 ("showall" org-startup-folded nil)
4880 ("showeverything" org-startup-folded showeverything)
4881 ("content" org-startup-folded content)
4882 ("indent" org-startup-indented t)
4883 ("noindent" org-startup-indented nil)
4884 ("hidestars" org-hide-leading-stars t)
4885 ("showstars" org-hide-leading-stars nil)
4886 ("odd" org-odd-levels-only t)
4887 ("oddeven" org-odd-levels-only nil)
4888 ("align" org-startup-align-all-tables t)
4889 ("noalign" org-startup-align-all-tables nil)
4890 ("inlineimages" org-startup-with-inline-images t)
4891 ("noinlineimages" org-startup-with-inline-images nil)
4892 ("latexpreview" org-startup-with-latex-preview t)
4893 ("nolatexpreview" org-startup-with-latex-preview nil)
4894 ("customtime" org-display-custom-times t)
4895 ("logdone" org-log-done time)
4896 ("lognotedone" org-log-done note)
4897 ("nologdone" org-log-done nil)
4898 ("lognoteclock-out" org-log-note-clock-out t)
4899 ("nolognoteclock-out" org-log-note-clock-out nil)
4900 ("logrepeat" org-log-repeat state)
4901 ("lognoterepeat" org-log-repeat note)
4902 ("logdrawer" org-log-into-drawer t)
4903 ("nologdrawer" org-log-into-drawer nil)
4904 ("logstatesreversed" org-log-states-order-reversed t)
4905 ("nologstatesreversed" org-log-states-order-reversed nil)
4906 ("nologrepeat" org-log-repeat nil)
4907 ("logreschedule" org-log-reschedule time)
4908 ("lognotereschedule" org-log-reschedule note)
4909 ("nologreschedule" org-log-reschedule nil)
4910 ("logredeadline" org-log-redeadline time)
4911 ("lognoteredeadline" org-log-redeadline note)
4912 ("nologredeadline" org-log-redeadline nil)
4913 ("logrefile" org-log-refile time)
4914 ("lognoterefile" org-log-refile note)
4915 ("nologrefile" org-log-refile nil)
4916 ("fninline" org-footnote-define-inline t)
4917 ("nofninline" org-footnote-define-inline nil)
4918 ("fnlocal" org-footnote-section nil)
4919 ("fnauto" org-footnote-auto-label t)
4920 ("fnprompt" org-footnote-auto-label nil)
4921 ("fnconfirm" org-footnote-auto-label confirm)
4922 ("fnplain" org-footnote-auto-label plain)
4923 ("fnadjust" org-footnote-auto-adjust t)
4924 ("nofnadjust" org-footnote-auto-adjust nil)
4925 ("constcgs" constants-unit-system cgs)
4926 ("constSI" constants-unit-system SI)
4927 ("noptag" org-tag-persistent-alist nil)
4928 ("hideblocks" org-hide-block-startup t)
4929 ("nohideblocks" org-hide-block-startup nil)
4930 ("beamer" org-startup-with-beamer-mode t)
4931 ("entitiespretty" org-pretty-entities t)
4932 ("entitiesplain" org-pretty-entities nil))
4933 "Variable associated with STARTUP options for org-mode.
4934 Each element is a list of three items: the startup options (as written
4935 in the #+STARTUP line), the corresponding variable, and the value to set
4936 this variable to if the option is found. An optional forth element PUSH
4937 means to push this value onto the list in the variable.")
4939 (defcustom org-group-tags t
4940 "When non-nil (the default), use group tags.
4941 This can be turned on/off through `org-toggle-tags-groups'."
4942 :group 'org-tags
4943 :group 'org-startup
4944 :type 'boolean)
4946 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4948 (defun org-toggle-tags-groups ()
4949 "Toggle support for group tags.
4950 Support for group tags is controlled by the option
4951 `org-group-tags', which is non-nil by default."
4952 (interactive)
4953 (setq org-group-tags (not org-group-tags))
4954 (cond ((and (derived-mode-p 'org-agenda-mode)
4955 org-group-tags)
4956 (org-agenda-redo))
4957 ((derived-mode-p 'org-mode)
4958 (let ((org-inhibit-startup t)) (org-mode))))
4959 (message "Groups tags support has been turned %s"
4960 (if org-group-tags "on" "off")))
4962 (defun org-set-regexps-and-options (&optional tags-only)
4963 "Precompute regular expressions used in the current buffer.
4964 When optional argument TAGS-ONLY is non-nil, only compute tags
4965 related expressions."
4966 (when (derived-mode-p 'org-mode)
4967 (let ((alist (org--setup-collect-keywords
4968 (org-make-options-regexp
4969 (append '("FILETAGS" "TAGS" "SETUPFILE")
4970 (and (not tags-only)
4971 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4972 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4973 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4974 (org--setup-process-tags
4975 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4976 (unless tags-only
4977 ;; File properties.
4978 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4979 ;; Archive location.
4980 (let ((archive (cdr (assq 'archive alist))))
4981 (when archive (org-set-local 'org-archive-location archive)))
4982 ;; Category.
4983 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4984 (when cat
4985 (org-set-local 'org-category (intern cat))
4986 (org-set-local 'org-file-properties
4987 (org--update-property-plist
4988 "CATEGORY" cat org-file-properties))))
4989 ;; Columns.
4990 (let ((column (cdr (assq 'columns alist))))
4991 (when column (org-set-local 'org-columns-default-format column)))
4992 ;; Constants.
4993 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4994 ;; Link abbreviations.
4995 (let ((links (cdr (assq 'link alist))))
4996 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4997 ;; Priorities.
4998 (let ((priorities (cdr (assq 'priorities alist))))
4999 (when priorities
5000 (org-set-local 'org-highest-priority (nth 0 priorities))
5001 (org-set-local 'org-lowest-priority (nth 1 priorities))
5002 (org-set-local 'org-default-priority (nth 2 priorities))))
5003 ;; Scripts.
5004 (let ((scripts (assq 'scripts alist)))
5005 (when scripts
5006 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
5007 ;; Startup options.
5008 (let ((startup (cdr (assq 'startup alist))))
5009 (dolist (option startup)
5010 (let ((entry (assoc-string option org-startup-options t)))
5011 (when entry
5012 (let ((var (nth 1 entry))
5013 (val (nth 2 entry)))
5014 (if (not (nth 3 entry)) (org-set-local var val)
5015 (unless (listp (symbol-value var))
5016 (org-set-local var nil))
5017 (add-to-list var val)))))))
5018 ;; TODO keywords.
5019 (org-set-local 'org-todo-kwd-alist nil)
5020 (org-set-local 'org-todo-key-alist nil)
5021 (org-set-local 'org-todo-key-trigger nil)
5022 (org-set-local 'org-todo-keywords-1 nil)
5023 (org-set-local 'org-done-keywords nil)
5024 (org-set-local 'org-todo-heads nil)
5025 (org-set-local 'org-todo-sets nil)
5026 (org-set-local 'org-todo-log-states nil)
5027 (let ((todo-sequences
5028 (or (nreverse (cdr (assq 'todo alist)))
5029 (let ((d (default-value 'org-todo-keywords)))
5030 (if (not (stringp (car d))) d
5031 ;; XXX: Backward compatibility code.
5032 (list (cons org-todo-interpretation d)))))))
5033 (dolist (sequence todo-sequences)
5034 (let* ((sequence (or (run-hook-with-args-until-success
5035 'org-todo-setup-filter-hook sequence)
5036 sequence))
5037 (sequence-type (car sequence))
5038 (keywords (cdr sequence))
5039 (sep (member "|" keywords))
5040 names alist)
5041 (dolist (k (remove "|" keywords))
5042 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5044 (error "Invalid TODO keyword %s" k))
5045 (let ((name (match-string 1 k))
5046 (key (match-string 2 k))
5047 (log (org-extract-log-state-settings k)))
5048 (push name names)
5049 (push (cons name (and key (string-to-char key))) alist)
5050 (when log (push log org-todo-log-states))))
5051 (let* ((names (nreverse names))
5052 (done (if sep (org-remove-keyword-keys (cdr sep))
5053 (last names)))
5054 (head (car names))
5055 (tail (list sequence-type head (car done) (org-last done))))
5056 (add-to-list 'org-todo-heads head 'append)
5057 (push names org-todo-sets)
5058 (setq org-done-keywords (append org-done-keywords done nil))
5059 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5060 (setq org-todo-key-alist
5061 (append org-todo-key-alist
5062 (and alist
5063 (append '((:startgroup))
5064 (nreverse alist)
5065 '((:endgroup))))))
5066 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5067 (setq org-todo-sets (nreverse org-todo-sets)
5068 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5069 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5070 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5071 ;; Compute the regular expressions and other local variables.
5072 ;; Using `org-outline-regexp-bol' would complicate them much,
5073 ;; because of the fixed white space at the end of that string.
5074 (if (not org-done-keywords)
5075 (setq org-done-keywords
5076 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5077 (setq org-not-done-keywords
5078 (org-delete-all org-done-keywords
5079 (copy-sequence org-todo-keywords-1))
5080 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5081 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5082 org-not-done-heading-regexp
5083 (format org-heading-keyword-regexp-format org-not-done-regexp)
5084 org-todo-line-regexp
5085 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5086 org-complex-heading-regexp
5087 (concat "^\\(\\*+\\)"
5088 "\\(?: +" org-todo-regexp "\\)?"
5089 "\\(?: +\\(\\[#.\\]\\)\\)?"
5090 "\\(?: +\\(.*?\\)\\)??"
5091 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5092 "[ \t]*$")
5093 org-complex-heading-regexp-format
5094 (concat "^\\(\\*+\\)"
5095 "\\(?: +" org-todo-regexp "\\)?"
5096 "\\(?: +\\(\\[#.\\]\\)\\)?"
5097 "\\(?: +"
5098 ;; Stats cookies can be stuck to body.
5099 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5100 "\\(%s\\)"
5101 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5102 "\\)"
5103 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5104 "[ \t]*$")
5105 org-todo-line-tags-regexp
5106 (concat "^\\(\\*+\\)"
5107 "\\(?: +" org-todo-regexp "\\)?"
5108 "\\(?: +\\(.*?\\)\\)??"
5109 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5110 "[ \t]*$"))
5111 (org-compute-latex-and-related-regexp)))))
5113 (defun org--setup-collect-keywords (regexp &optional files alist)
5114 "Return setup keywords values as an alist.
5116 REGEXP matches a subset of setup keywords. FILES is a list of
5117 file names already visited. It is used to avoid circular setup
5118 files. ALIST, when non-nil, is the alist computed so far.
5120 Return value contains the following keys: `archive', `category',
5121 `columns', `constants', `filetags', `link', `priorities',
5122 `property', `scripts', `startup', `tags' and `todo'."
5123 (org-with-wide-buffer
5124 (goto-char (point-min))
5125 (let ((case-fold-search t))
5126 (while (re-search-forward regexp nil t)
5127 (let ((element (org-element-at-point)))
5128 (when (eq (org-element-type element) 'keyword)
5129 (let ((key (org-element-property :key element))
5130 (value (org-element-property :value element)))
5131 (cond
5132 ((equal key "ARCHIVE")
5133 (when (org-string-nw-p value)
5134 (push (cons 'archive value) alist)))
5135 ((equal key "CATEGORY") (push (cons 'category value) alist))
5136 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5137 ((equal key "CONSTANTS")
5138 (let* ((constants (assq 'constants alist))
5139 (store (cdr constants)))
5140 (dolist (pair (org-split-string value))
5141 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5142 pair)
5143 (let* ((name (match-string 1 pair))
5144 (value (match-string 2 pair))
5145 (old (assoc name store)))
5146 (if old (setcdr old value)
5147 (push (cons name value) store)))))
5148 (if constants (setcdr constants store)
5149 (push (cons 'constants store) alist))))
5150 ((equal key "FILETAGS")
5151 (when (org-string-nw-p value)
5152 (let ((old (assq 'filetags alist))
5153 (new (apply #'nconc
5154 (mapcar (lambda (x) (org-split-string x ":"))
5155 (org-split-string value)))))
5156 (if old (setcdr old (append new (cdr old)))
5157 (push (cons 'filetags new) alist)))))
5158 ((equal key "LINK")
5159 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5160 (let ((links (assq 'link alist))
5161 (pair (cons (org-match-string-no-properties 1 value)
5162 (org-match-string-no-properties 2 value))))
5163 (if links (push pair (cdr links))
5164 (push (list 'link pair) alist)))))
5165 ((equal key "OPTIONS")
5166 (when (and (org-string-nw-p value)
5167 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5168 (push (cons 'scripts (read (match-string 1 value))) alist)))
5169 ((equal key "PRIORITIES")
5170 (push (cons 'priorities
5171 (let ((prio (org-split-string value)))
5172 (if (< (length prio) 3) '(?A ?C ?B)
5173 (mapcar #'string-to-char prio))))
5174 alist))
5175 ((equal key "PROPERTY")
5176 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5177 (let* ((property (assq 'property alist))
5178 (value (org--update-property-plist
5179 (org-match-string-no-properties 1 value)
5180 (org-match-string-no-properties 2 value)
5181 (cdr property))))
5182 (if property (setcdr property value)
5183 (push (cons 'property value) alist)))))
5184 ((equal key "STARTUP")
5185 (let ((startup (assq 'startup alist)))
5186 (if startup
5187 (setcdr startup
5188 (append (cdr startup) (org-split-string value)))
5189 (push (cons 'startup (org-split-string value)) alist))))
5190 ((equal key "TAGS")
5191 (let ((tag-cell (assq 'tags alist)))
5192 (if tag-cell
5193 (setcdr tag-cell
5194 (append (cdr tag-cell)
5195 '("\\n")
5196 (org-split-string value)))
5197 (push (cons 'tags (org-split-string value)) alist))))
5198 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5199 (let ((todo (assq 'todo alist))
5200 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5201 (org-split-string value))))
5202 (if todo (push value (cdr todo))
5203 (push (list 'todo value) alist))))
5204 ((equal key "SETUPFILE")
5205 (unless buffer-read-only ; Do not check in Gnus messages.
5206 (let ((f (and (org-string-nw-p value)
5207 (expand-file-name
5208 (org-remove-double-quotes value)))))
5209 (when (and f (file-readable-p f) (not (member f files)))
5210 (with-temp-buffer
5211 (setq default-directory (file-name-directory f))
5212 (insert-file-contents f)
5213 (setq alist
5214 ;; Fake Org mode to benefit from cache
5215 ;; without recurring needlessly.
5216 (let ((major-mode 'org-mode))
5217 (org--setup-collect-keywords
5218 regexp (cons f files) alist)))))))))))))))
5219 alist)
5221 (defun org--setup-process-tags (tags filetags)
5222 "Precompute variables used for tags.
5223 TAGS is a list of tags and tag group symbols, as strings.
5224 FILETAGS is a list of tags, as strings."
5225 ;; Process the file tags.
5226 (org-set-local 'org-file-tags
5227 (mapcar #'org-add-prop-inherited filetags))
5228 ;; Provide default tags if no local tags are found.
5229 (when (and (not tags) org-tag-alist)
5230 (setq tags
5231 (mapcar (lambda (tag)
5232 (case (car tag)
5233 (:startgroup "{")
5234 (:endgroup "}")
5235 (:startgrouptag "[")
5236 (:endgrouptag "]")
5237 (:grouptags ":")
5238 (:newline "\\n")
5239 (otherwise (concat (car tag)
5240 (and (characterp (cdr tag))
5241 (format "(%c)" (cdr tag)))))))
5242 org-tag-alist)))
5243 ;; Process the tags.
5244 (org-set-local 'org-tag-groups-alist nil)
5245 (org-set-local 'org-tag-alist nil)
5246 (let (group-flag)
5247 (while tags
5248 (let ((e (car tags)))
5249 (setq tags (cdr tags))
5250 (cond
5251 ((equal e "{")
5252 (push '(:startgroup) org-tag-alist)
5253 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5254 ((equal e "}")
5255 (push '(:endgroup) org-tag-alist)
5256 (setq group-flag nil))
5257 ((equal e "[")
5258 (push '(:startgrouptag) org-tag-alist)
5259 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5260 ((equal e "]")
5261 (push '(:endgrouptag) org-tag-alist)
5262 (setq group-flag nil))
5263 ((equal e ":")
5264 (push '(:grouptags) org-tag-alist)
5265 (setq group-flag 'append))
5266 ((equal e "\\n") (push '(:newline) org-tag-alist))
5267 ((string-match
5268 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5269 "\\|{.+?}\\)" ; regular expression
5270 "\\(?:(\\(.\\))\\)?\\'")) e)
5271 (let ((tag (match-string 1 e))
5272 (key (and (match-beginning 2)
5273 (string-to-char (match-string 2 e)))))
5274 (cond ((eq group-flag 'append)
5275 (setcar org-tag-groups-alist
5276 (append (car org-tag-groups-alist) (list tag))))
5277 (group-flag (push (list tag) org-tag-groups-alist)))
5278 ;; Push all tags in groups, no matter if they already exist.
5279 (unless (and (not group-flag) (assoc tag org-tag-alist))
5280 (push (cons tag key) org-tag-alist))))))))
5281 (setq org-tag-alist (nreverse org-tag-alist)))
5283 (defun org-file-contents (file &optional noerror)
5284 "Return the contents of FILE, as a string."
5285 (if (and file (file-readable-p file))
5286 (with-temp-buffer
5287 (insert-file-contents file)
5288 (buffer-string))
5289 (funcall (if noerror 'message 'error)
5290 "Cannot read file \"%s\"%s"
5291 file
5292 (let ((from (buffer-file-name (buffer-base-buffer))))
5293 (if from (concat " (referenced in file \"" from "\")") "")))))
5295 (defun org-extract-log-state-settings (x)
5296 "Extract the log state setting from a TODO keyword string.
5297 This will extract info from a string like \"WAIT(w@/!)\"."
5298 (let (kw key log1 log2)
5299 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5300 (setq kw (match-string 1 x)
5301 key (and (match-end 2) (match-string 2 x))
5302 log1 (and (match-end 3) (match-string 3 x))
5303 log2 (and (match-end 4) (match-string 4 x)))
5304 (and (or log1 log2)
5305 (list kw
5306 (and log1 (if (equal log1 "!") 'time 'note))
5307 (and log2 (if (equal log2 "!") 'time 'note)))))))
5309 (defun org-remove-keyword-keys (list)
5310 "Remove a pair of parenthesis at the end of each string in LIST."
5311 (mapcar (lambda (x)
5312 (if (string-match "(.*)$" x)
5313 (substring x 0 (match-beginning 0))
5315 list))
5317 (defun org-assign-fast-keys (alist)
5318 "Assign fast keys to a keyword-key alist.
5319 Respect keys that are already there."
5320 (let (new e (alt ?0))
5321 (while (setq e (pop alist))
5322 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5323 (cdr e)) ;; Key already assigned.
5324 (push e new)
5325 (let ((clist (string-to-list (downcase (car e))))
5326 (used (append new alist)))
5327 (when (= (car clist) ?@)
5328 (pop clist))
5329 (while (and clist (rassoc (car clist) used))
5330 (pop clist))
5331 (unless clist
5332 (while (rassoc alt used)
5333 (incf alt)))
5334 (push (cons (car e) (or (car clist) alt)) new))))
5335 (nreverse new)))
5337 ;;; Some variables used in various places
5339 (defvar org-window-configuration nil
5340 "Used in various places to store a window configuration.")
5341 (defvar org-selected-window nil
5342 "Used in various places to store a window configuration.")
5343 (defvar org-finish-function nil
5344 "Function to be called when `C-c C-c' is used.
5345 This is for getting out of special buffers like capture.")
5348 ;; FIXME: Occasionally check by commenting these, to make sure
5349 ;; no other functions uses these, forgetting to let-bind them.
5350 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5351 (defvar org-last-state)
5352 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5354 ;; Defined somewhere in this file, but used before definition.
5355 (defvar org-entities) ;; defined in org-entities.el
5356 (defvar org-struct-menu)
5357 (defvar org-org-menu)
5358 (defvar org-tbl-menu)
5360 ;;;; Define the Org-mode
5362 ;; We use a before-change function to check if a table might need
5363 ;; an update.
5364 (defvar org-table-may-need-update t
5365 "Indicates that a table might need an update.
5366 This variable is set by `org-before-change-function'.
5367 `org-table-align' sets it back to nil.")
5368 (defun org-before-change-function (beg end)
5369 "Every change indicates that a table might need an update."
5370 (setq org-table-may-need-update t))
5371 (defvar org-mode-map)
5372 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5373 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5374 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5375 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5376 (defvar org-table-buffer-is-an nil)
5378 (defvar bidi-paragraph-direction)
5379 (defvar buffer-face-mode-face)
5381 (require 'outline)
5382 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5383 (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"))
5384 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5386 ;; Other stuff we need.
5387 (require 'time-date)
5388 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5389 (require 'easymenu)
5390 (autoload 'easy-menu-add "easymenu")
5391 (require 'overlay)
5393 ;; (require 'org-macs) moved higher up in the file before it is first used
5394 (require 'org-entities)
5395 ;; (require 'org-compat) moved higher up in the file before it is first used
5396 (require 'org-faces)
5397 (require 'org-list)
5398 (require 'org-pcomplete)
5399 (require 'org-src)
5400 (require 'org-footnote)
5401 (require 'org-macro)
5403 ;; babel
5404 (require 'ob)
5406 ;;;###autoload
5407 (define-derived-mode org-mode outline-mode "Org"
5408 "Outline-based notes management and organizer, alias
5409 \"Carsten's outline-mode for keeping track of everything.\"
5411 Org-mode develops organizational tasks around a NOTES file which
5412 contains information about projects as plain text. Org-mode is
5413 implemented on top of outline-mode, which is ideal to keep the content
5414 of large files well structured. It supports ToDo items, deadlines and
5415 time stamps, which magically appear in the diary listing of the Emacs
5416 calendar. Tables are easily created with a built-in table editor.
5417 Plain text URL-like links connect to websites, emails (VM), Usenet
5418 messages (Gnus), BBDB entries, and any files related to the project.
5419 For printing and sharing of notes, an Org-mode file (or a part of it)
5420 can be exported as a structured ASCII or HTML file.
5422 The following commands are available:
5424 \\{org-mode-map}"
5426 ;; Get rid of Outline menus, they are not needed
5427 ;; Need to do this here because define-derived-mode sets up
5428 ;; the keymap so late. Still, it is a waste to call this each time
5429 ;; we switch another buffer into org-mode.
5430 (if (featurep 'xemacs)
5431 (when (boundp 'outline-mode-menu-heading)
5432 ;; Assume this is Greg's port, it uses easymenu
5433 (easy-menu-remove outline-mode-menu-heading)
5434 (easy-menu-remove outline-mode-menu-show)
5435 (easy-menu-remove outline-mode-menu-hide))
5436 (define-key org-mode-map [menu-bar headings] 'undefined)
5437 (define-key org-mode-map [menu-bar hide] 'undefined)
5438 (define-key org-mode-map [menu-bar show] 'undefined))
5440 (org-load-modules-maybe)
5441 (when (featurep 'xemacs)
5442 (easy-menu-add org-org-menu)
5443 (easy-menu-add org-tbl-menu))
5444 (org-install-agenda-files-menu)
5445 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5446 (add-to-invisibility-spec '(org-cwidth))
5447 (add-to-invisibility-spec '(org-hide-block . t))
5448 (when (featurep 'xemacs)
5449 (org-set-local 'line-move-ignore-invisible t))
5450 (org-set-local 'outline-regexp org-outline-regexp)
5451 (org-set-local 'outline-level 'org-outline-level)
5452 (setq bidi-paragraph-direction 'left-to-right)
5453 (when (and org-ellipsis
5454 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5455 (fboundp 'make-glyph-code))
5456 (unless org-display-table
5457 (setq org-display-table (make-display-table)))
5458 (set-display-table-slot
5459 org-display-table 4
5460 (vconcat (mapcar
5461 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5462 org-ellipsis)))
5463 (if (stringp org-ellipsis) org-ellipsis "..."))))
5464 (setq buffer-display-table org-display-table))
5465 (org-set-regexps-and-options)
5466 (org-set-font-lock-defaults)
5467 (when (and org-tag-faces (not org-tags-special-faces-re))
5468 ;; tag faces set outside customize.... force initialization.
5469 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5470 ;; Calc embedded
5471 (org-set-local 'calc-embedded-open-mode "# ")
5472 ;; Modify a few syntax entries
5473 (modify-syntax-entry ?@ "w")
5474 (modify-syntax-entry ?\" "\"")
5475 (modify-syntax-entry ?\\ "_")
5476 (modify-syntax-entry ?~ "_")
5477 (if org-startup-truncated (setq truncate-lines t))
5478 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5479 (org-set-local 'font-lock-unfontify-region-function
5480 'org-unfontify-region)
5481 ;; Activate before-change-function
5482 (org-set-local 'org-table-may-need-update t)
5483 (org-add-hook 'before-change-functions 'org-before-change-function nil
5484 'local)
5485 ;; Check for running clock before killing a buffer
5486 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5487 ;; Initialize macros templates.
5488 (org-macro-initialize-templates)
5489 ;; Initialize radio targets.
5490 (org-update-radio-target-regexp)
5491 ;; Indentation.
5492 (org-set-local 'indent-line-function 'org-indent-line)
5493 (org-set-local 'indent-region-function 'org-indent-region)
5494 ;; Filling and auto-filling.
5495 (org-setup-filling)
5496 ;; Comments.
5497 (org-setup-comments-handling)
5498 ;; Initialize cache.
5499 (org-element-cache-reset)
5500 ;; Beginning/end of defun
5501 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5502 (org-set-local 'end-of-defun-function
5503 (lambda ()
5504 (if (not (org-at-heading-p))
5505 (org-forward-element)
5506 (org-forward-element)
5507 (forward-char -1))))
5508 ;; Next error for sparse trees
5509 (org-set-local 'next-error-function 'org-occur-next-match)
5510 ;; Make sure dependence stuff works reliably, even for users who set it
5511 ;; too late :-(
5512 (if org-enforce-todo-dependencies
5513 (add-hook 'org-blocker-hook
5514 'org-block-todo-from-children-or-siblings-or-parent)
5515 (remove-hook 'org-blocker-hook
5516 'org-block-todo-from-children-or-siblings-or-parent))
5517 (if org-enforce-todo-checkbox-dependencies
5518 (add-hook 'org-blocker-hook
5519 'org-block-todo-from-checkboxes)
5520 (remove-hook 'org-blocker-hook
5521 'org-block-todo-from-checkboxes))
5523 ;; Align options lines
5524 (org-set-local
5525 'align-mode-rules-list
5526 '((org-in-buffer-settings
5527 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5528 (modes . '(org-mode)))))
5530 ;; Imenu
5531 (org-set-local 'imenu-create-index-function
5532 'org-imenu-get-tree)
5534 ;; Make isearch reveal context
5535 (if (or (featurep 'xemacs)
5536 (not (boundp 'outline-isearch-open-invisible-function)))
5537 ;; Emacs 21 and XEmacs make use of the hook
5538 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5539 ;; Emacs 22 deals with this through a special variable
5540 (org-set-local 'outline-isearch-open-invisible-function
5541 (lambda (&rest ignore) (org-show-context 'isearch))))
5543 ;; Setup the pcomplete hooks
5544 (set (make-local-variable 'pcomplete-command-completion-function)
5545 'org-pcomplete-initial)
5546 (set (make-local-variable 'pcomplete-command-name-function)
5547 'org-command-at-point)
5548 (set (make-local-variable 'pcomplete-default-completion-function)
5549 'ignore)
5550 (set (make-local-variable 'pcomplete-parse-arguments-function)
5551 'org-parse-arguments)
5552 (set (make-local-variable 'pcomplete-termination-string) "")
5553 (when (>= emacs-major-version 23)
5554 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5556 ;; If empty file that did not turn on org-mode automatically, make it to.
5557 (if (and org-insert-mode-line-in-empty-file
5558 (org-called-interactively-p 'any)
5559 (= (point-min) (point-max)))
5560 (insert "# -*- mode: org -*-\n\n"))
5561 (unless org-inhibit-startup
5562 (org-unmodified
5563 (and org-startup-with-beamer-mode (org-beamer-mode))
5564 (when org-startup-align-all-tables
5565 (org-table-map-tables 'org-table-align 'quietly))
5566 (when org-startup-with-inline-images
5567 (org-display-inline-images))
5568 (when org-startup-with-latex-preview
5569 (org-toggle-latex-fragment))
5570 (unless org-inhibit-startup-visibility-stuff
5571 (org-set-startup-visibility))
5572 (org-refresh-effort-properties)))
5573 ;; Try to set org-hide correctly
5574 (let ((foreground (org-find-invisible-foreground)))
5575 (if foreground
5576 (set-face-foreground 'org-hide foreground))))
5578 ;; Update `customize-package-emacs-version-alist'
5579 (add-to-list 'customize-package-emacs-version-alist
5580 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5581 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5582 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5584 (defvar org-mode-transpose-word-syntax-table
5585 (let ((st (make-syntax-table text-mode-syntax-table)))
5586 (mapc (lambda(c) (modify-syntax-entry
5587 (string-to-char (car c)) "w p" st))
5588 org-emphasis-alist)
5589 st))
5591 (when (fboundp 'abbrev-table-put)
5592 (abbrev-table-put org-mode-abbrev-table
5593 :parents (list text-mode-abbrev-table)))
5595 (defun org-find-invisible-foreground ()
5596 (let ((candidates (remove
5597 "unspecified-bg"
5598 (nconc
5599 (list (face-background 'default)
5600 (face-background 'org-default))
5601 (mapcar
5602 (lambda (alist)
5603 (when (boundp alist)
5604 (cdr (assoc 'background-color (symbol-value alist)))))
5605 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5606 (list (face-foreground 'org-hide))))))
5607 (car (remove nil candidates))))
5609 (defun org-current-time (&optional rounding-minutes past)
5610 "Current time, possibly rounded to ROUNDING-MINUTES.
5611 When ROUNDING-MINUTES is not an integer, fall back on the car of
5612 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5613 the rounding returns a past time."
5614 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5615 (car org-time-stamp-rounding-minutes)))
5616 (time (decode-time)) res)
5617 (if (< r 1)
5618 (current-time)
5619 (setq res
5620 (apply 'encode-time
5621 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5622 (nthcdr 2 time))))
5623 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5624 (seconds-to-time (- (org-float-time res) (* r 60)))
5625 res))))
5627 (defun org-today ()
5628 "Return today date, considering `org-extend-today-until'."
5629 (time-to-days
5630 (time-subtract (current-time)
5631 (list 0 (* 3600 org-extend-today-until) 0))))
5633 ;;;; Font-Lock stuff, including the activators
5635 (defvar org-mouse-map (make-sparse-keymap))
5636 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5637 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5638 (when org-mouse-1-follows-link
5639 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5640 (when org-tab-follows-link
5641 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5642 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5644 (require 'font-lock)
5646 (defconst org-non-link-chars "]\t\n\r<>")
5647 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5648 "file+sys" "news" "shell" "elisp" "doi" "message"
5649 "help"))
5650 (defvar org-link-types-re nil
5651 "Matches a link that has a url-like prefix like \"http:\"")
5652 (defvar org-link-re-with-space nil
5653 "Matches a link with spaces, optional angular brackets around it.")
5654 (defvar org-link-re-with-space2 nil
5655 "Matches a link with spaces, optional angular brackets around it.")
5656 (defvar org-link-re-with-space3 nil
5657 "Matches a link with spaces, only for internal part in bracket links.")
5658 (defvar org-angle-link-re nil
5659 "Matches link with angular brackets, spaces are allowed.")
5660 (defvar org-plain-link-re nil
5661 "Matches plain link, without spaces.")
5662 (defvar org-bracket-link-regexp nil
5663 "Matches a link in double brackets.")
5664 (defvar org-bracket-link-analytic-regexp nil
5665 "Regular expression used to analyze links.
5666 Here is what the match groups contain after a match:
5667 1: http:
5668 2: http
5669 3: path
5670 4: [desc]
5671 5: desc")
5672 (defvar org-bracket-link-analytic-regexp++ nil
5673 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5674 (defvar org-any-link-re nil
5675 "Regular expression matching any link.")
5677 (defconst org-match-sexp-depth 3
5678 "Number of stacked braces for sub/superscript matching.")
5680 (defun org-create-multibrace-regexp (left right n)
5681 "Create a regular expression which will match a balanced sexp.
5682 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5683 as single character strings.
5684 The regexp returned will match the entire expression including the
5685 delimiters. It will also define a single group which contains the
5686 match except for the outermost delimiters. The maximum depth of
5687 stacked delimiters is N. Escaping delimiters is not possible."
5688 (let* ((nothing (concat "[^" left right "]*?"))
5689 (or "\\|")
5690 (re nothing)
5691 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5692 (while (> n 1)
5693 (setq n (1- n)
5694 re (concat re or next)
5695 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5696 (concat left "\\(" re "\\)" right)))
5698 (defconst org-match-substring-regexp
5699 (concat
5700 "\\(\\S-\\)\\([_^]\\)\\("
5701 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5702 "\\|"
5703 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5704 "\\|"
5705 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5706 "The regular expression matching a sub- or superscript.")
5708 (defconst org-match-substring-with-braces-regexp
5709 (concat
5710 "\\(\\S-\\)\\([_^]\\)"
5711 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5712 "The regular expression matching a sub- or superscript, forcing braces.")
5714 (defun org-make-link-regexps ()
5715 "Update the link regular expressions.
5716 This should be called after the variable `org-link-types' has changed."
5717 (let ((types-re (regexp-opt org-link-types t)))
5718 (setq org-link-types-re
5719 (concat "\\`" types-re ":")
5720 org-link-re-with-space
5721 (concat "<?" types-re ":"
5722 "\\([^" org-non-link-chars " ]"
5723 "[^" org-non-link-chars "]*"
5724 "[^" org-non-link-chars " ]\\)>?")
5725 org-link-re-with-space2
5726 (concat "<?" types-re ":"
5727 "\\([^" org-non-link-chars " ]"
5728 "[^\t\n\r]*"
5729 "[^" org-non-link-chars " ]\\)>?")
5730 org-link-re-with-space3
5731 (concat "<?" types-re ":"
5732 "\\([^" org-non-link-chars " ]"
5733 "[^\t\n\r]*\\)")
5734 org-angle-link-re
5735 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
5736 types-re)
5737 org-plain-link-re
5738 (concat
5739 "\\<" types-re ":"
5740 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5741 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5742 org-bracket-link-regexp
5743 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5744 org-bracket-link-analytic-regexp
5745 (concat
5746 "\\[\\["
5747 "\\(" types-re ":\\)?"
5748 "\\([^]]+\\)"
5749 "\\]"
5750 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5751 "\\]")
5752 org-bracket-link-analytic-regexp++
5753 (concat
5754 "\\[\\["
5755 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5756 "\\([^]]+\\)"
5757 "\\]"
5758 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5759 "\\]")
5760 org-any-link-re
5761 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5762 org-angle-link-re "\\)\\|\\("
5763 org-plain-link-re "\\)"))))
5765 (org-make-link-regexps)
5767 (defvar org-emph-face nil)
5769 (defun org-do-emphasis-faces (limit)
5770 "Run through the buffer and emphasize strings."
5771 (let (rtn a)
5772 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5773 (let* ((border (char-after (match-beginning 3)))
5774 (bre (regexp-quote (char-to-string border))))
5775 (if (and (not (= border (char-after (match-beginning 4))))
5776 (not (save-match-data
5777 (string-match (concat bre ".*" bre)
5778 (replace-regexp-in-string
5779 "\n" " "
5780 (substring (match-string 2) 1 -1))))))
5781 (progn
5782 (setq rtn t)
5783 (setq a (assoc (match-string 3) org-emphasis-alist))
5784 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5785 'face
5786 (nth 1 a))
5787 (and (nth 2 a)
5788 (org-remove-flyspell-overlays-in
5789 (match-beginning 0) (match-end 0)))
5790 (add-text-properties (match-beginning 2) (match-end 2)
5791 '(font-lock-multiline t org-emphasis t))
5792 (when org-hide-emphasis-markers
5793 (add-text-properties (match-end 4) (match-beginning 5)
5794 '(invisible org-link))
5795 (add-text-properties (match-beginning 3) (match-end 3)
5796 '(invisible org-link))))))
5797 (goto-char (1+ (match-beginning 0))))
5798 rtn))
5800 (defun org-emphasize (&optional char)
5801 "Insert or change an emphasis, i.e. a font like bold or italic.
5802 If there is an active region, change that region to a new emphasis.
5803 If there is no region, just insert the marker characters and position
5804 the cursor between them.
5805 CHAR should be the marker character. If it is a space, it means to
5806 remove the emphasis of the selected region.
5807 If CHAR is not given (for example in an interactive call) it will be
5808 prompted for."
5809 (interactive)
5810 (let ((erc org-emphasis-regexp-components)
5811 (prompt "")
5812 (string "") beg end move c s)
5813 (if (org-region-active-p)
5814 (setq beg (region-beginning) end (region-end)
5815 string (buffer-substring beg end))
5816 (setq move t))
5818 (unless char
5819 (message "Emphasis marker or tag: [%s]"
5820 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5821 (setq char (read-char-exclusive)))
5822 (if (equal char ?\ )
5823 (setq s "" move nil)
5824 (unless (assoc (char-to-string char) org-emphasis-alist)
5825 (user-error "No such emphasis marker: \"%c\"" char))
5826 (setq s (char-to-string char)))
5827 (while (and (> (length string) 1)
5828 (equal (substring string 0 1) (substring string -1))
5829 (assoc (substring string 0 1) org-emphasis-alist))
5830 (setq string (substring string 1 -1)))
5831 (setq string (concat s string s))
5832 (if beg (delete-region beg end))
5833 (unless (or (bolp)
5834 (string-match (concat "[" (nth 0 erc) "\n]")
5835 (char-to-string (char-before (point)))))
5836 (insert " "))
5837 (unless (or (eobp)
5838 (string-match (concat "[" (nth 1 erc) "\n]")
5839 (char-to-string (char-after (point)))))
5840 (insert " ") (backward-char 1))
5841 (insert string)
5842 (and move (backward-char 1))))
5844 (defconst org-nonsticky-props
5845 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5847 (defsubst org-rear-nonsticky-at (pos)
5848 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5850 (defun org-activate-plain-links (limit)
5851 "Add link properties for plain links."
5852 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5853 (not (org-in-src-block-p)))
5854 (let ((face (get-text-property (max (1- (match-beginning 0)) (point-min))
5855 'face))
5856 (link (org-match-string-no-properties 0)))
5857 (when (if (consp face) (memq 'org-tag face) (eq 'org-tag face))
5858 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5859 (add-text-properties (match-beginning 0) (match-end 0)
5860 (list 'mouse-face 'highlight
5861 'face 'org-link
5862 'htmlize-link `(:uri ,link)
5863 'keymap org-mouse-map))
5864 (org-rear-nonsticky-at (match-end 0))
5865 t))))
5867 (defun org-activate-code (limit)
5868 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5869 (progn
5870 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5871 (remove-text-properties (match-beginning 0) (match-end 0)
5872 '(display t invisible t intangible t))
5873 t)))
5875 (defcustom org-src-fontify-natively t
5876 "When non-nil, fontify code in code blocks."
5877 :type 'boolean
5878 :version "24.4"
5879 :package-version '(Org . "8.3")
5880 :group 'org-appearance
5881 :group 'org-babel)
5883 (defcustom org-allow-promoting-top-level-subtree nil
5884 "When non-nil, allow promoting a top level subtree.
5885 The leading star of the top level headline will be replaced
5886 by a #."
5887 :type 'boolean
5888 :version "24.1"
5889 :group 'org-appearance)
5891 (defun org-fontify-meta-lines-and-blocks (limit)
5892 (condition-case nil
5893 (org-fontify-meta-lines-and-blocks-1 limit)
5894 (error (message "org-mode fontification error"))))
5896 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5897 "Fontify #+ lines and blocks."
5898 (let ((case-fold-search t))
5899 (if (re-search-forward
5900 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5901 limit t)
5902 (let ((beg (match-beginning 0))
5903 (block-start (match-end 0))
5904 (block-end nil)
5905 (lang (match-string 7))
5906 (beg1 (line-beginning-position 2))
5907 (dc1 (downcase (match-string 2)))
5908 (dc3 (downcase (match-string 3)))
5909 end end1 quoting block-type ovl)
5910 (cond
5911 ((and (match-end 4) (equal dc3 "+begin"))
5912 ;; Truly a block
5913 (setq block-type (downcase (match-string 5))
5914 quoting (member block-type org-protecting-blocks))
5915 (when (re-search-forward
5916 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5917 nil t) ;; on purpose, we look further than LIMIT
5918 (setq end (min (point-max) (match-end 0))
5919 end1 (min (point-max) (1- (match-beginning 0))))
5920 (setq block-end (match-beginning 0))
5921 (when quoting
5922 (org-remove-flyspell-overlays-in beg1 end1)
5923 (remove-text-properties beg end
5924 '(display t invisible t intangible t)))
5925 (add-text-properties
5926 beg end '(font-lock-fontified t font-lock-multiline t))
5927 (add-text-properties beg beg1 '(face org-meta-line))
5928 (org-remove-flyspell-overlays-in beg beg1)
5929 (add-text-properties ; For end_src
5930 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5931 (org-remove-flyspell-overlays-in end1 end)
5932 (cond
5933 ((and lang (not (string= lang "")) org-src-fontify-natively)
5934 (org-src-font-lock-fontify-block lang block-start block-end)
5935 (add-text-properties beg1 block-end '(src-block t)))
5936 (quoting
5937 (add-text-properties beg1 (min (point-max) (1+ end1))
5938 '(face org-block))) ; end of source block
5939 ((not org-fontify-quote-and-verse-blocks))
5940 ((string= block-type "quote")
5941 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5942 ((string= block-type "verse")
5943 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5944 (add-text-properties beg beg1 '(face org-block-begin-line))
5945 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5946 '(face org-block-end-line))
5948 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5949 (org-remove-flyspell-overlays-in
5950 (match-beginning 0)
5951 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5952 (add-text-properties
5953 beg (match-end 3)
5954 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5955 '(font-lock-fontified t invisible t)
5956 '(font-lock-fontified t face org-document-info-keyword)))
5957 (add-text-properties
5958 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5959 (if (string-equal dc1 "+title:")
5960 '(font-lock-fontified t face org-document-title)
5961 '(font-lock-fontified t face org-document-info))))
5962 ((equal dc1 "+caption:")
5963 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5964 (remove-text-properties (match-beginning 0) (match-end 0)
5965 '(display t invisible t intangible t))
5966 (add-text-properties (match-beginning 1) (match-end 3)
5967 '(font-lock-fontified t face org-meta-line))
5968 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5969 '(font-lock-fontified t face org-block))
5971 ((member dc3 '(" " ""))
5972 (org-remove-flyspell-overlays-in beg (match-end 0))
5973 (add-text-properties
5974 beg (match-end 0)
5975 '(font-lock-fontified t face font-lock-comment-face)))
5976 (t ;; just any other in-buffer setting, but not indented
5977 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5978 (remove-text-properties (match-beginning 0) (match-end 0)
5979 '(display t invisible t intangible t))
5980 (add-text-properties beg (match-end 0)
5981 '(font-lock-fontified t face org-meta-line))
5982 t))))))
5984 (defun org-fontify-drawers (limit)
5985 "Fontify drawers."
5986 (when (re-search-forward org-drawer-regexp limit t)
5987 (add-text-properties
5988 (match-beginning 0) (match-end 0)
5989 '(font-lock-fontified t face org-special-keyword))
5990 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5993 (defun org-fontify-macros (limit)
5994 "Fontify macros."
5995 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5996 (add-text-properties
5997 (match-beginning 0) (match-end 0)
5998 '(font-lock-fontified t face org-macro))
5999 (when org-hide-macro-markers
6000 (add-text-properties (match-end 2) (match-beginning 2)
6001 '(invisible t))
6002 (add-text-properties (match-beginning 1) (match-end 1)
6003 '(invisible t)))
6004 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6007 (defun org-activate-angle-links (limit)
6008 "Add text properties for angle links."
6009 (if (and (re-search-forward org-angle-link-re limit t)
6010 (not (org-in-src-block-p)))
6011 (progn
6012 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6013 (add-text-properties (match-beginning 0) (match-end 0)
6014 (list 'mouse-face 'highlight
6015 'keymap org-mouse-map
6016 'font-lock-multiline t))
6017 (org-rear-nonsticky-at (match-end 0))
6018 t)))
6020 (defun org-activate-footnote-links (limit)
6021 "Add text properties for footnotes."
6022 (let ((fn (org-footnote-next-reference-or-definition limit)))
6023 (when fn
6024 (let* ((beg (nth 1 fn))
6025 (end (nth 2 fn))
6026 (label (car fn))
6027 (referencep (/= (line-beginning-position) beg)))
6028 (when (and referencep (nth 3 fn))
6029 (save-excursion
6030 (goto-char beg)
6031 (search-forward (or label "fn:"))
6032 (org-remove-flyspell-overlays-in beg (match-end 0))))
6033 (add-text-properties beg end
6034 (list 'mouse-face 'highlight
6035 'keymap org-mouse-map
6036 'help-echo
6037 (if referencep "Footnote reference"
6038 "Footnote definition")
6039 'font-lock-fontified t
6040 'font-lock-multiline t
6041 'face 'org-footnote))))))
6043 (defun org-activate-bracket-links (limit)
6044 "Add text properties for bracketed links."
6045 (if (and (re-search-forward org-bracket-link-regexp limit t)
6046 (not (org-in-src-block-p)))
6047 (let* ((hl (org-match-string-no-properties 1))
6048 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6049 (ip (org-maybe-intangible
6050 (list 'invisible 'org-link
6051 'keymap org-mouse-map 'mouse-face 'highlight
6052 'font-lock-multiline t 'help-echo help
6053 'htmlize-link `(:uri ,hl))))
6054 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6055 'font-lock-multiline t 'help-echo help
6056 'htmlize-link `(:uri ,hl))))
6057 ;; We need to remove the invisible property here. Table narrowing
6058 ;; may have made some of this invisible.
6059 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6060 (remove-text-properties (match-beginning 0) (match-end 0)
6061 '(invisible nil))
6062 (if (match-end 3)
6063 (progn
6064 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6065 (org-rear-nonsticky-at (match-beginning 3))
6066 (add-text-properties (match-beginning 3) (match-end 3) vp)
6067 (org-rear-nonsticky-at (match-end 3))
6068 (add-text-properties (match-end 3) (match-end 0) ip)
6069 (org-rear-nonsticky-at (match-end 0)))
6070 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6071 (org-rear-nonsticky-at (match-beginning 1))
6072 (add-text-properties (match-beginning 1) (match-end 1) vp)
6073 (org-rear-nonsticky-at (match-end 1))
6074 (add-text-properties (match-end 1) (match-end 0) ip)
6075 (org-rear-nonsticky-at (match-end 0)))
6076 t)))
6078 (defun org-activate-dates (limit)
6079 "Add text properties for dates."
6080 (if (and (re-search-forward org-tsr-regexp-both limit t)
6081 (not (equal (char-before (match-beginning 0)) 91)))
6082 (progn
6083 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6084 (add-text-properties (match-beginning 0) (match-end 0)
6085 (list 'mouse-face 'highlight
6086 'keymap org-mouse-map))
6087 (org-rear-nonsticky-at (match-end 0))
6088 (when org-display-custom-times
6089 (if (match-end 3)
6090 (org-display-custom-time (match-beginning 3) (match-end 3)))
6091 (org-display-custom-time (match-beginning 1) (match-end 1)))
6092 t)))
6094 (defvar org-target-link-regexp nil
6095 "Regular expression matching radio targets in plain text.")
6096 (make-variable-buffer-local 'org-target-link-regexp)
6098 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6099 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6100 border border border))
6101 "Regular expression matching a link target.")
6103 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6104 "Regular expression matching a radio target.")
6106 (defconst org-any-target-regexp
6107 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6108 "Regular expression matching any target.")
6110 (defun org-activate-target-links (limit)
6111 "Add text properties for target matches."
6112 (when org-target-link-regexp
6113 (let ((case-fold-search t))
6114 (if (re-search-forward org-target-link-regexp limit t)
6115 (progn
6116 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6117 (add-text-properties (match-beginning 1) (match-end 1)
6118 (list 'mouse-face 'highlight
6119 'keymap org-mouse-map
6120 'help-echo "Radio target link"
6121 'org-linked-text t))
6122 (org-rear-nonsticky-at (match-end 1))
6123 t)))))
6125 (defun org-update-radio-target-regexp ()
6126 "Find all radio targets in this file and update the regular expression.
6127 Also refresh fontification if needed."
6128 (interactive)
6129 (let ((old-regexp org-target-link-regexp)
6130 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6131 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6132 (targets
6133 (org-with-wide-buffer
6134 (goto-char (point-min))
6135 (let (rtn)
6136 (while (re-search-forward org-radio-target-regexp nil t)
6137 ;; Make sure point is really within the object.
6138 (backward-char)
6139 (let ((obj (org-element-context)))
6140 (when (eq (org-element-type obj) 'radio-target)
6141 (add-to-list 'rtn (org-element-property :value obj)))))
6142 rtn))))
6143 (setq org-target-link-regexp
6144 (and targets
6145 (concat before-re
6146 (mapconcat
6147 (lambda (x)
6148 (replace-regexp-in-string
6149 " +" "\\s-+" (regexp-quote x) t t))
6150 targets
6151 "\\|")
6152 after-re)))
6153 (unless (equal old-regexp org-target-link-regexp)
6154 ;; Clean-up cache.
6155 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6156 ((not org-target-link-regexp) old-regexp)
6158 (concat before-re
6159 (mapconcat
6160 (lambda (re)
6161 (substring re (length before-re)
6162 (- (length after-re))))
6163 (list old-regexp org-target-link-regexp)
6164 "\\|")
6165 after-re)))))
6166 (org-with-wide-buffer
6167 (goto-char (point-min))
6168 (while (re-search-forward regexp nil t)
6169 (org-element-cache-refresh (match-beginning 1)))))
6170 ;; Re fontify buffer.
6171 (when (memq 'radio org-highlight-links)
6172 (org-restart-font-lock)))))
6174 (defun org-hide-wide-columns (limit)
6175 (let (s e)
6176 (setq s (text-property-any (point) (or limit (point-max))
6177 'org-cwidth t))
6178 (when s
6179 (setq e (next-single-property-change s 'org-cwidth))
6180 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6181 (goto-char e)
6182 t)))
6184 (defvar org-latex-and-related-regexp nil
6185 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6187 (defun org-compute-latex-and-related-regexp ()
6188 "Compute regular expression for LaTeX, entities and sub/superscript.
6189 Result depends on variable `org-highlight-latex-and-related'."
6190 (org-set-local
6191 'org-latex-and-related-regexp
6192 (let* ((re-sub
6193 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6194 ((eq org-use-sub-superscripts '{})
6195 (list org-match-substring-with-braces-regexp))
6196 (org-use-sub-superscripts (list org-match-substring-regexp))))
6197 (re-latex
6198 (when (memq 'latex org-highlight-latex-and-related)
6199 (let ((matchers (plist-get org-format-latex-options :matchers)))
6200 (delq nil
6201 (mapcar (lambda (x)
6202 (and (member (car x) matchers) (nth 1 x)))
6203 org-latex-regexps)))))
6204 (re-entities
6205 (when (memq 'entities org-highlight-latex-and-related)
6206 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6207 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6209 (defun org-do-latex-and-related (limit)
6210 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6211 LIMIT bounds the search for syntax to highlight. Stop at first
6212 highlighted object, if any. Return t if some highlighting was
6213 done, nil otherwise."
6214 (when (org-string-nw-p org-latex-and-related-regexp)
6215 (catch 'found
6216 (while (re-search-forward org-latex-and-related-regexp limit t)
6217 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6218 'face))
6219 '(org-code org-verbatim underline))
6220 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6221 '(?_ ?^))
6223 0)))
6224 (font-lock-prepend-text-property
6225 (+ offset (match-beginning 0)) (match-end 0)
6226 'face 'org-latex-and-related)
6227 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6228 '(font-lock-multiline t)))
6229 (throw 'found t)))
6230 nil)))
6232 (defun org-restart-font-lock ()
6233 "Restart `font-lock-mode', to force refontification."
6234 (when (and (boundp 'font-lock-mode) font-lock-mode)
6235 (font-lock-mode -1)
6236 (font-lock-mode 1)))
6238 (defun org-activate-tags (limit)
6239 (when (re-search-forward
6240 (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") limit t)
6241 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6242 (add-text-properties (match-beginning 1) (match-end 1)
6243 (list 'mouse-face 'highlight
6244 'keymap org-mouse-map))
6245 (org-rear-nonsticky-at (match-end 1))
6248 (defun org-outline-level ()
6249 "Compute the outline level of the heading at point.
6251 If this is called at a normal headline, the level is the number
6252 of stars. Use `org-reduced-level' to remove the effect of
6253 `org-odd-levels'. Unlike to `org-current-level', this function
6254 takes into consideration inlinetasks."
6255 (org-with-wide-buffer
6256 (end-of-line)
6257 (if (re-search-backward org-outline-regexp-bol nil t)
6258 (1- (- (match-end 0) (match-beginning 0)))
6259 0)))
6261 (defvar org-font-lock-keywords nil)
6263 (defsubst org-re-property (property &optional literal allow-null value)
6264 "Return a regexp matching a PROPERTY line.
6266 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6267 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6268 non-nil, match properties even without a value.
6270 Match group 3 is set to the value when it exists. If there is no
6271 value and ALLOW-NULL is non-nil, it is set to the empty string.
6273 With optional argument VALUE, match only property lines with
6274 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6275 unless LITERAL is non-nil."
6276 (concat
6277 "^\\(?4:[ \t]*\\)"
6278 (format "\\(?1::\\(?2:%s\\):\\)"
6279 (if literal property (regexp-quote property)))
6280 (cond (value
6281 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6282 (if literal value (regexp-quote value))))
6283 (allow-null
6284 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6286 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6288 (defconst org-property-re
6289 (org-re-property "\\S-+" 'literal t)
6290 "Regular expression matching a property line.
6291 There are four matching groups:
6292 1: :PROPKEY: including the leading and trailing colon,
6293 2: PROPKEY without the leading and trailing colon,
6294 3: PROPVAL without leading or trailing spaces,
6295 4: the indentation of the current line,
6296 5: trailing whitespace.")
6298 (defvar org-font-lock-hook nil
6299 "Functions to be called for special font lock stuff.")
6301 (defvar org-font-lock-set-keywords-hook nil
6302 "Functions that can manipulate `org-font-lock-extra-keywords'.
6303 This is called after `org-font-lock-extra-keywords' is defined, but before
6304 it is installed to be used by font lock. This can be useful if something
6305 needs to be inserted at a specific position in the font-lock sequence.")
6307 (defun org-font-lock-hook (limit)
6308 "Run `org-font-lock-hook' within LIMIT."
6309 (run-hook-with-args 'org-font-lock-hook limit))
6311 (defun org-set-font-lock-defaults ()
6312 "Set font lock defaults for the current buffer."
6313 (let* ((em org-fontify-emphasized-text)
6314 (lk org-highlight-links)
6315 (org-font-lock-extra-keywords
6316 (list
6317 ;; Call the hook
6318 '(org-font-lock-hook)
6319 ;; Headlines
6320 `(,(if org-fontify-whole-heading-line
6321 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6322 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6323 (1 (org-get-level-face 1))
6324 (2 (org-get-level-face 2))
6325 (3 (org-get-level-face 3)))
6326 ;; Table lines
6327 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6328 (1 'org-table t))
6329 ;; Table internals
6330 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6331 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6332 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6333 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6334 ;; Drawers
6335 '(org-fontify-drawers)
6336 ;; Properties
6337 (list org-property-re
6338 '(1 'org-special-keyword t)
6339 '(3 'org-property-value t))
6340 ;; Links
6341 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6342 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6343 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6344 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6345 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6346 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6347 (if (memq 'footnote lk) '(org-activate-footnote-links))
6348 ;; Targets.
6349 (list org-any-target-regexp '(0 'org-target t))
6350 ;; Diary sexps.
6351 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6352 ;; Macro
6353 '(org-fontify-macros)
6354 '(org-hide-wide-columns (0 nil append))
6355 ;; TODO keyword
6356 (list (format org-heading-keyword-regexp-format
6357 org-todo-regexp)
6358 '(2 (org-get-todo-face 2) t))
6359 ;; DONE
6360 (if org-fontify-done-headline
6361 (list (format org-heading-keyword-regexp-format
6362 (concat
6363 "\\(?:"
6364 (mapconcat 'regexp-quote org-done-keywords "\\|")
6365 "\\)"))
6366 '(2 'org-headline-done t))
6367 nil)
6368 ;; Priorities
6369 '(org-font-lock-add-priority-faces)
6370 ;; Tags
6371 '(org-font-lock-add-tag-faces)
6372 ;; Tags groups
6373 (if (and org-group-tags org-tag-groups-alist)
6374 (list (concat org-outline-regexp-bol ".+\\(:"
6375 (regexp-opt (mapcar 'car org-tag-groups-alist))
6376 ":\\).*$")
6377 '(1 'org-tag-group prepend)))
6378 ;; Special keywords
6379 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6380 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6381 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6382 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6383 ;; Emphasis
6384 (if em
6385 (if (featurep 'xemacs)
6386 '(org-do-emphasis-faces (0 nil append))
6387 '(org-do-emphasis-faces)))
6388 ;; Checkboxes
6389 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6390 1 'org-checkbox prepend)
6391 (if (cdr (assq 'checkbox org-list-automatic-rules))
6392 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6393 (0 (org-get-checkbox-statistics-face) t)))
6394 ;; Description list items
6395 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6396 1 'org-list-dt prepend)
6397 ;; ARCHIVEd headings
6398 (list (concat
6399 org-outline-regexp-bol
6400 "\\(.*:" org-archive-tag ":.*\\)")
6401 '(1 'org-archived prepend))
6402 ;; Specials
6403 '(org-do-latex-and-related)
6404 '(org-fontify-entities)
6405 '(org-raise-scripts)
6406 ;; Code
6407 '(org-activate-code (1 'org-code t))
6408 ;; COMMENT
6409 (list (format
6410 "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6411 org-todo-regexp
6412 org-comment-string)
6413 '(9 'org-special-keyword t))
6414 ;; Blocks and meta lines
6415 '(org-fontify-meta-lines-and-blocks))))
6416 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6417 (run-hooks 'org-font-lock-set-keywords-hook)
6418 ;; Now set the full font-lock-keywords
6419 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6420 (org-set-local 'font-lock-defaults
6421 '(org-font-lock-keywords t nil nil backward-paragraph))
6422 (kill-local-variable 'font-lock-keywords) nil))
6424 (defun org-toggle-pretty-entities ()
6425 "Toggle the composition display of entities as UTF8 characters."
6426 (interactive)
6427 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6428 (org-restart-font-lock)
6429 (if org-pretty-entities
6430 (message "Entities are now displayed as UTF8 characters")
6431 (save-restriction
6432 (widen)
6433 (org-decompose-region (point-min) (point-max))
6434 (message "Entities are now displayed as plain text"))))
6436 (defvar org-custom-properties-overlays nil
6437 "List of overlays used for custom properties.")
6438 (make-variable-buffer-local 'org-custom-properties-overlays)
6440 (defun org-toggle-custom-properties-visibility ()
6441 "Display or hide properties in `org-custom-properties'."
6442 (interactive)
6443 (if org-custom-properties-overlays
6444 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6445 (setq org-custom-properties-overlays nil))
6446 (when org-custom-properties
6447 (org-with-wide-buffer
6448 (goto-char (point-min))
6449 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6450 (while (re-search-forward regexp nil t)
6451 (let ((end (cdr (save-match-data (org-get-property-block)))))
6452 (when (and end (< (point) end))
6453 ;; Hide first custom property in current drawer.
6454 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6455 (overlay-put o 'invisible t)
6456 (overlay-put o 'org-custom-property t)
6457 (push o org-custom-properties-overlays))
6458 ;; Hide additional custom properties in the same drawer.
6459 (while (re-search-forward regexp end t)
6460 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6461 (overlay-put o 'invisible t)
6462 (overlay-put o 'org-custom-property t)
6463 (push o org-custom-properties-overlays)))))
6464 ;; Each entry is limited to a single property drawer.
6465 (outline-next-heading)))))))
6467 (defun org-fontify-entities (limit)
6468 "Find an entity to fontify."
6469 (let (ee)
6470 (when org-pretty-entities
6471 (catch 'match
6472 ;; "\_ "-family is left out on purpose. Only the first one,
6473 ;; i.e., "\_ ", could be fontified anyway, and it would be
6474 ;; confusing when adding a second white space character.
6475 (while (re-search-forward
6476 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6477 limit t)
6478 (if (and (not (org-at-comment-p))
6479 (setq ee (org-entity-get (match-string 1)))
6480 (= (length (nth 6 ee)) 1))
6481 (let*
6482 ((end (if (equal (match-string 2) "{}")
6483 (match-end 2)
6484 (match-end 1))))
6485 (add-text-properties
6486 (match-beginning 0) end
6487 (list 'font-lock-fontified t))
6488 (compose-region (match-beginning 0) end
6489 (nth 6 ee) nil)
6490 (backward-char 1)
6491 (throw 'match t))))
6492 nil))))
6494 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6495 "Fontify string S like in Org-mode."
6496 (with-temp-buffer
6497 (insert s)
6498 (let ((org-odd-levels-only odd-levels))
6499 (org-mode)
6500 (font-lock-ensure)
6501 (buffer-string))))
6503 (defvar org-m nil)
6504 (defvar org-l nil)
6505 (defvar org-f nil)
6506 (defun org-get-level-face (n)
6507 "Get the right face for match N in font-lock matching of headlines."
6508 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6509 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6510 (if org-cycle-level-faces
6511 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6512 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6513 (cond
6514 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6515 ((eq n 2) org-f)
6516 (t (if org-level-color-stars-only nil org-f))))
6518 (defun org-face-from-face-or-color (context inherit face-or-color)
6519 "Create a face list that inherits INHERIT, but sets the foreground color.
6520 When FACE-OR-COLOR is not a string, just return it."
6521 (if (stringp face-or-color)
6522 (list :inherit inherit
6523 (cdr (assoc context org-faces-easy-properties))
6524 face-or-color)
6525 face-or-color))
6527 (defun org-get-todo-face (kwd)
6528 "Get the right face for a TODO keyword KWD.
6529 If KWD is a number, get the corresponding match group."
6530 (if (numberp kwd) (setq kwd (match-string kwd)))
6531 (or (org-face-from-face-or-color
6532 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6533 (and (member kwd org-done-keywords) 'org-done)
6534 'org-todo))
6536 (defun org-get-priority-face (priority)
6537 "Get the right face for PRIORITY.
6538 PRIORITY is a character."
6539 (or (org-face-from-face-or-color
6540 'priority 'org-priority (cdr (assq priority org-priority-faces)))
6541 'org-priority))
6543 (defun org-get-tag-face (tag)
6544 "Get the right face for TAG.
6545 If TAG is a number, get the corresponding match group."
6546 (let ((tag (if (wholenump tag) (match-string tag) tag)))
6547 (or (org-face-from-face-or-color
6548 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
6549 'org-tag)))
6551 (defun org-font-lock-add-priority-faces (limit)
6552 "Add the special priority faces."
6553 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
6554 (add-text-properties
6555 (match-beginning 1) (match-end 1)
6556 (list 'face (org-get-priority-face (string-to-char (match-string 2)))
6557 'font-lock-fontified t))))
6559 (defun org-font-lock-add-tag-faces (limit)
6560 "Add the special tag faces."
6561 (when (and org-tag-faces org-tags-special-faces-re)
6562 (while (re-search-forward org-tags-special-faces-re limit t)
6563 (add-text-properties (match-beginning 1) (match-end 1)
6564 (list 'face (org-get-tag-face 1)
6565 'font-lock-fontified t))
6566 (backward-char 1))))
6568 (defun org-unfontify-region (beg end &optional maybe_loudly)
6569 "Remove fontification and activation overlays from links."
6570 (font-lock-default-unfontify-region beg end)
6571 (let* ((buffer-undo-list t)
6572 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6573 (inhibit-modification-hooks t)
6574 deactivate-mark buffer-file-name buffer-file-truename)
6575 (org-decompose-region beg end)
6576 (remove-text-properties beg end
6577 '(mouse-face t keymap t org-linked-text t
6578 invisible t intangible t
6579 org-emphasis t))
6580 (org-remove-font-lock-display-properties beg end)))
6582 (defconst org-script-display '(((raise -0.3) (height 0.7))
6583 ((raise 0.3) (height 0.7))
6584 ((raise -0.5))
6585 ((raise 0.5)))
6586 "Display properties for showing superscripts and subscripts.")
6588 (defun org-remove-font-lock-display-properties (beg end)
6589 "Remove specific display properties that have been added by font lock.
6590 The will remove the raise properties that are used to show superscripts
6591 and subscripts."
6592 (let (next prop)
6593 (while (< beg end)
6594 (setq next (next-single-property-change beg 'display nil end)
6595 prop (get-text-property beg 'display))
6596 (if (member prop org-script-display)
6597 (put-text-property beg next 'display nil))
6598 (setq beg next))))
6600 (defun org-raise-scripts (limit)
6601 "Add raise properties to sub/superscripts."
6602 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6603 (if (re-search-forward
6604 (if (eq org-use-sub-superscripts t)
6605 org-match-substring-regexp
6606 org-match-substring-with-braces-regexp)
6607 limit t)
6608 (let* ((pos (point)) table-p comment-p
6609 (mpos (match-beginning 3))
6610 (emph-p (get-text-property mpos 'org-emphasis))
6611 (link-p (get-text-property mpos 'mouse-face))
6612 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6613 (goto-char (point-at-bol))
6614 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6615 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6616 (goto-char pos)
6617 ;; Handle a_b^c
6618 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6619 (if (or comment-p emph-p link-p keyw-p)
6621 (put-text-property (match-beginning 3) (match-end 0)
6622 'display
6623 (if (equal (char-after (match-beginning 2)) ?^)
6624 (nth (if table-p 3 1) org-script-display)
6625 (nth (if table-p 2 0) org-script-display)))
6626 (add-text-properties (match-beginning 2) (match-end 2)
6627 (list 'invisible t
6628 'org-dwidth t 'org-dwidth-n 1))
6629 (if (and (eq (char-after (match-beginning 3)) ?{)
6630 (eq (char-before (match-end 3)) ?}))
6631 (progn
6632 (add-text-properties
6633 (match-beginning 3) (1+ (match-beginning 3))
6634 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6635 (add-text-properties
6636 (1- (match-end 3)) (match-end 3)
6637 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6638 t)))))
6640 ;;;; Visibility cycling, including org-goto and indirect buffer
6642 ;;; Cycling
6644 (defvar org-cycle-global-status nil)
6645 (make-variable-buffer-local 'org-cycle-global-status)
6646 (put 'org-cycle-global-status 'org-state t)
6647 (defvar org-cycle-subtree-status nil)
6648 (make-variable-buffer-local 'org-cycle-subtree-status)
6649 (put 'org-cycle-subtree-status 'org-state t)
6651 (defvar org-inlinetask-min-level)
6653 (defun org-unlogged-message (&rest args)
6654 "Display a message, but avoid logging it in the *Messages* buffer."
6655 (let ((message-log-max nil))
6656 (apply 'message args)))
6658 ;;;###autoload
6659 (defun org-cycle (&optional arg)
6660 "TAB-action and visibility cycling for Org-mode.
6662 This is the command invoked in Org-mode by the TAB key. Its main purpose
6663 is outline visibility cycling, but it also invokes other actions
6664 in special contexts.
6666 - When this function is called with a prefix argument, rotate the entire
6667 buffer through 3 states (global cycling)
6668 1. OVERVIEW: Show only top-level headlines.
6669 2. CONTENTS: Show all headlines of all levels, but no body text.
6670 3. SHOW ALL: Show everything.
6671 With a double \\[universal-argument] prefix argument, \
6672 switch to the startup visibility,
6673 determined by the variable `org-startup-folded', and by any VISIBILITY
6674 properties in the buffer.
6675 With a triple \\[universal-argument] prefix argument, \
6676 show the entire buffer, including any drawers.
6678 - When inside a table, re-align the table and move to the next field.
6680 - When point is at the beginning of a headline, rotate the subtree started
6681 by this line through 3 different states (local cycling)
6682 1. FOLDED: Only the main headline is shown.
6683 2. CHILDREN: The main headline and the direct children are shown.
6684 From this state, you can move to one of the children
6685 and zoom in further.
6686 3. SUBTREE: Show the entire subtree, including body text.
6687 If there is no subtree, switch directly from CHILDREN to FOLDED.
6689 - When point is at the beginning of an empty headline and the variable
6690 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6691 of the headline by demoting and promoting it to likely levels. This
6692 speeds up creation document structure by pressing TAB once or several
6693 times right after creating a new headline.
6695 - When there is a numeric prefix, go up to a heading with level ARG, do
6696 a `show-subtree' and return to the previous cursor position. If ARG
6697 is negative, go up that many levels.
6699 - When point is not at the beginning of a headline, execute the global
6700 binding for TAB, which is re-indenting the line. See the option
6701 `org-cycle-emulate-tab' for details.
6703 - Special case: if point is at the beginning of the buffer and there is
6704 no headline in line 1, this function will act as if called with prefix arg
6705 (\\[universal-argument] TAB, same as S-TAB) also when called without prefix arg.
6706 But only if also the variable `org-cycle-global-at-bob' is t."
6707 (interactive "P")
6708 (org-load-modules-maybe)
6709 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6710 (and org-cycle-level-after-item/entry-creation
6711 (or (org-cycle-level)
6712 (org-cycle-item-indentation))))
6713 (let* ((limit-level
6714 (or org-cycle-max-level
6715 (and (boundp 'org-inlinetask-min-level)
6716 org-inlinetask-min-level
6717 (1- org-inlinetask-min-level))))
6718 (nstars (and limit-level
6719 (if org-odd-levels-only
6720 (and limit-level (1- (* limit-level 2)))
6721 limit-level)))
6722 (org-outline-regexp
6723 (if (not (derived-mode-p 'org-mode))
6724 outline-regexp
6725 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6726 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6727 (not (looking-at org-outline-regexp))))
6728 (org-cycle-hook
6729 (if bob-special
6730 (delq 'org-optimize-window-after-visibility-change
6731 (copy-sequence org-cycle-hook))
6732 org-cycle-hook))
6733 (pos (point)))
6735 (if (or bob-special (equal arg '(4)))
6736 ;; special case: use global cycling
6737 (setq arg t))
6739 (cond
6741 ((equal arg '(16))
6742 (setq last-command 'dummy)
6743 (org-set-startup-visibility)
6744 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6746 ((equal arg '(64))
6747 (outline-show-all)
6748 (org-unlogged-message "Entire buffer visible, including drawers"))
6750 ;; Try cdlatex TAB completion
6751 ((org-try-cdlatex-tab))
6753 ;; Table: enter it or move to the next field.
6754 ((org-at-table-p 'any)
6755 (if (org-at-table.el-p)
6756 (message "%s" (substitute-command-keys "\\<org-mode-map>\
6757 Use \\[org-edit-special] to edit table.el tables"))
6758 (if arg (org-table-edit-field t)
6759 (org-table-justify-field-maybe)
6760 (call-interactively 'org-table-next-field))))
6762 ((run-hook-with-args-until-success
6763 'org-tab-after-check-for-table-hook))
6765 ;; Global cycling: delegate to `org-cycle-internal-global'.
6766 ((eq arg t) (org-cycle-internal-global))
6768 ;; Drawers: delegate to `org-flag-drawer'.
6769 ((save-excursion
6770 (beginning-of-line 1)
6771 (looking-at org-drawer-regexp))
6772 (org-flag-drawer ; toggle block visibility
6773 (not (get-char-property (match-end 0) 'invisible))))
6775 ;; Show-subtree, ARG levels up from here.
6776 ((integerp arg)
6777 (save-excursion
6778 (org-back-to-heading)
6779 (outline-up-heading (if (< arg 0) (- arg)
6780 (- (funcall outline-level) arg)))
6781 (org-show-subtree)))
6783 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6784 ((and (featurep 'org-inlinetask)
6785 (org-inlinetask-at-task-p)
6786 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6787 (org-inlinetask-toggle-visibility))
6789 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6790 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6791 (save-excursion (move-beginning-of-line 1)
6792 (looking-at org-outline-regexp)))
6793 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6794 (org-cycle-internal-local))
6796 ;; From there: TAB emulation and template completion.
6797 (buffer-read-only (org-back-to-heading))
6799 ((run-hook-with-args-until-success
6800 'org-tab-after-check-for-cycling-hook))
6802 ((org-try-structure-completion))
6804 ((run-hook-with-args-until-success
6805 'org-tab-before-tab-emulation-hook))
6807 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6808 (or (not (bolp))
6809 (not (looking-at org-outline-regexp))))
6810 (call-interactively (global-key-binding "\t")))
6812 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6813 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6814 (or (and (eq org-cycle-emulate-tab 'white)
6815 (= (match-end 0) (point-at-eol)))
6816 (and (eq org-cycle-emulate-tab 'whitestart)
6817 (>= (match-end 0) pos))))
6819 (eq org-cycle-emulate-tab t))
6820 (call-interactively (global-key-binding "\t")))
6822 (t (save-excursion
6823 (org-back-to-heading)
6824 (org-cycle)))))))
6826 (defun org-cycle-internal-global ()
6827 "Do the global cycling action."
6828 ;; Hack to avoid display of messages for .org attachments in Gnus
6829 (let ((ga (string-match "\\*fontification" (buffer-name))))
6830 (cond
6831 ((and (eq last-command this-command)
6832 (eq org-cycle-global-status 'overview))
6833 ;; We just created the overview - now do table of contents
6834 ;; This can be slow in very large buffers, so indicate action
6835 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6836 (unless ga (org-unlogged-message "CONTENTS..."))
6837 (org-content)
6838 (unless ga (org-unlogged-message "CONTENTS...done"))
6839 (setq org-cycle-global-status 'contents)
6840 (run-hook-with-args 'org-cycle-hook 'contents))
6842 ((and (eq last-command this-command)
6843 (eq org-cycle-global-status 'contents))
6844 ;; We just showed the table of contents - now show everything
6845 (run-hook-with-args 'org-pre-cycle-hook 'all)
6846 (outline-show-all)
6847 (unless ga (org-unlogged-message "SHOW ALL"))
6848 (setq org-cycle-global-status 'all)
6849 (run-hook-with-args 'org-cycle-hook 'all))
6852 ;; Default action: go to overview
6853 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6854 (org-overview)
6855 (unless ga (org-unlogged-message "OVERVIEW"))
6856 (setq org-cycle-global-status 'overview)
6857 (run-hook-with-args 'org-cycle-hook 'overview)))))
6859 (defvar org-called-with-limited-levels nil
6860 "Non-nil when `org-with-limited-levels' is currently active.")
6862 (defun org-cycle-internal-local ()
6863 "Do the local cycling action."
6864 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6865 ;; First, determine end of headline (EOH), end of subtree or item
6866 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6867 (save-excursion
6868 (if (org-at-item-p)
6869 (progn
6870 (beginning-of-line)
6871 (setq struct (org-list-struct))
6872 (setq eoh (point-at-eol))
6873 (setq eos (org-list-get-item-end-before-blank (point) struct))
6874 (setq has-children (org-list-has-child-p (point) struct)))
6875 (org-back-to-heading)
6876 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6877 (setq eos (save-excursion (org-end-of-subtree t t)
6878 (when (bolp) (backward-char)) (point)))
6879 (setq has-children
6880 (or (save-excursion
6881 (let ((level (funcall outline-level)))
6882 (outline-next-heading)
6883 (and (org-at-heading-p t)
6884 (> (funcall outline-level) level))))
6885 (save-excursion
6886 (org-list-search-forward (org-item-beginning-re) eos t)))))
6887 ;; Determine end invisible part of buffer (EOL)
6888 (beginning-of-line 2)
6889 ;; XEmacs doesn't have `next-single-char-property-change'
6890 (if (featurep 'xemacs)
6891 (while (and (not (eobp)) ;; this is like `next-line'
6892 (get-char-property (1- (point)) 'invisible))
6893 (beginning-of-line 2))
6894 (while (and (not (eobp)) ;; this is like `next-line'
6895 (get-char-property (1- (point)) 'invisible))
6896 (goto-char (next-single-char-property-change (point) 'invisible))
6897 (and (eolp) (beginning-of-line 2))))
6898 (setq eol (point)))
6899 ;; Find out what to do next and set `this-command'
6900 (cond
6901 ((= eos eoh)
6902 ;; Nothing is hidden behind this heading
6903 (unless (org-before-first-heading-p)
6904 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6905 (org-unlogged-message "EMPTY ENTRY")
6906 (setq org-cycle-subtree-status nil)
6907 (save-excursion
6908 (goto-char eos)
6909 (outline-next-heading)
6910 (if (outline-invisible-p) (org-flag-heading nil))))
6911 ((and (or (>= eol eos)
6912 (not (string-match "\\S-" (buffer-substring eol eos))))
6913 (or has-children
6914 (not (setq children-skipped
6915 org-cycle-skip-children-state-if-no-children))))
6916 ;; Entire subtree is hidden in one line: children view
6917 (unless (org-before-first-heading-p)
6918 (run-hook-with-args 'org-pre-cycle-hook 'children))
6919 (if (org-at-item-p)
6920 (org-list-set-item-visibility (point-at-bol) struct 'children)
6921 (org-show-entry)
6922 (org-with-limited-levels (outline-show-children))
6923 ;; FIXME: This slows down the func way too much.
6924 ;; How keep drawers hidden in subtree anyway?
6925 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6926 ;; (org-cycle-hide-drawers 'subtree))
6928 ;; Fold every list in subtree to top-level items.
6929 (when (eq org-cycle-include-plain-lists 'integrate)
6930 (save-excursion
6931 (org-back-to-heading)
6932 (while (org-list-search-forward (org-item-beginning-re) eos t)
6933 (beginning-of-line 1)
6934 (let* ((struct (org-list-struct))
6935 (prevs (org-list-prevs-alist struct))
6936 (end (org-list-get-bottom-point struct)))
6937 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6938 (org-list-get-all-items (point) struct prevs))
6939 (goto-char (if (< end eos) end eos)))))))
6940 (org-unlogged-message "CHILDREN")
6941 (save-excursion
6942 (goto-char eos)
6943 (outline-next-heading)
6944 (if (outline-invisible-p) (org-flag-heading nil)))
6945 (setq org-cycle-subtree-status 'children)
6946 (unless (org-before-first-heading-p)
6947 (run-hook-with-args 'org-cycle-hook 'children)))
6948 ((or children-skipped
6949 (and (eq last-command this-command)
6950 (eq org-cycle-subtree-status 'children)))
6951 ;; We just showed the children, or no children are there,
6952 ;; now show everything.
6953 (unless (org-before-first-heading-p)
6954 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6955 (outline-flag-region eoh eos nil)
6956 (org-unlogged-message
6957 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6958 (setq org-cycle-subtree-status 'subtree)
6959 (unless (org-before-first-heading-p)
6960 (run-hook-with-args 'org-cycle-hook 'subtree)))
6962 ;; Default action: hide the subtree.
6963 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6964 (outline-flag-region eoh eos t)
6965 (org-unlogged-message "FOLDED")
6966 (setq org-cycle-subtree-status 'folded)
6967 (unless (org-before-first-heading-p)
6968 (run-hook-with-args 'org-cycle-hook 'folded))))))
6970 ;;;###autoload
6971 (defun org-global-cycle (&optional arg)
6972 "Cycle the global visibility. For details see `org-cycle'.
6973 With \\[universal-argument] prefix arg, switch to startup visibility.
6974 With a numeric prefix, show all headlines up to that level."
6975 (interactive "P")
6976 (let ((org-cycle-include-plain-lists
6977 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6978 (cond
6979 ((integerp arg)
6980 (outline-show-all)
6981 (outline-hide-sublevels arg)
6982 (setq org-cycle-global-status 'contents))
6983 ((equal arg '(4))
6984 (org-set-startup-visibility)
6985 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6987 (org-cycle '(4))))))
6989 (defun org-set-startup-visibility ()
6990 "Set the visibility required by startup options and properties."
6991 (cond
6992 ((eq org-startup-folded t)
6993 (org-overview))
6994 ((eq org-startup-folded 'content)
6995 (org-content))
6996 ((or (eq org-startup-folded 'showeverything)
6997 (eq org-startup-folded nil))
6998 (outline-show-all)))
6999 (unless (eq org-startup-folded 'showeverything)
7000 (if org-hide-block-startup (org-hide-block-all))
7001 (org-set-visibility-according-to-property 'no-cleanup)
7002 (org-cycle-hide-archived-subtrees 'all)
7003 (org-cycle-hide-drawers 'all)
7004 (org-cycle-show-empty-lines t)))
7006 (defun org-set-visibility-according-to-property (&optional no-cleanup)
7007 "Switch subtree visibilities according to :VISIBILITY: property."
7008 (interactive)
7009 (let (org-show-entry-below)
7010 (org-with-wide-buffer
7011 (goto-char (point-min))
7012 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
7013 (if (not (org-at-property-p)) (outline-next-heading)
7014 (let ((state (match-string 3)))
7015 (save-excursion
7016 (org-back-to-heading t)
7017 (outline-hide-subtree)
7018 (org-reveal)
7019 (cond
7020 ((equal state "folded")
7021 (outline-hide-subtree))
7022 ((equal state "children")
7023 (org-show-hidden-entry)
7024 (outline-show-children))
7025 ((equal state "content")
7026 (save-excursion
7027 (save-restriction
7028 (org-narrow-to-subtree)
7029 (org-content))))
7030 ((member state '("all" "showall"))
7031 (outline-show-subtree)))))))
7032 (unless no-cleanup
7033 (org-cycle-hide-archived-subtrees 'all)
7034 (org-cycle-hide-drawers 'all)
7035 (org-cycle-show-empty-lines 'all)))))
7037 ;; This function uses outline-regexp instead of the more fundamental
7038 ;; org-outline-regexp so that org-cycle-global works outside of Org
7039 ;; buffers, where outline-regexp is needed.
7040 (defun org-overview ()
7041 "Switch to overview mode, showing only top-level headlines.
7042 This shows all headlines with a level equal or greater than the level
7043 of the first headline in the buffer. This is important, because if the
7044 first headline is not level one, then (hide-sublevels 1) gives confusing
7045 results."
7046 (interactive)
7047 (save-excursion
7048 (let ((level
7049 (save-excursion
7050 (goto-char (point-min))
7051 (if (re-search-forward (concat "^" outline-regexp) nil t)
7052 (progn
7053 (goto-char (match-beginning 0))
7054 (funcall outline-level))))))
7055 (and level (outline-hide-sublevels level)))))
7057 (defun org-content (&optional arg)
7058 "Show all headlines in the buffer, like a table of contents.
7059 With numerical argument N, show content up to level N."
7060 (interactive "P")
7061 (org-overview)
7062 (save-excursion
7063 ;; Visit all headings and show their offspring
7064 (and (integerp arg) (org-overview))
7065 (goto-char (point-max))
7066 (catch 'exit
7067 (while (and (progn (condition-case nil
7068 (outline-previous-visible-heading 1)
7069 (error (goto-char (point-min))))
7071 (looking-at org-outline-regexp))
7072 (if (integerp arg)
7073 (outline-show-children (1- arg))
7074 (outline-show-branches))
7075 (if (bobp) (throw 'exit nil))))))
7077 (defun org-optimize-window-after-visibility-change (state)
7078 "Adjust the window after a change in outline visibility.
7079 This function is the default value of the hook `org-cycle-hook'."
7080 (when (get-buffer-window (current-buffer))
7081 (cond
7082 ((eq state 'content) nil)
7083 ((eq state 'all) nil)
7084 ((eq state 'folded) nil)
7085 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7086 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7088 (defun org-remove-empty-overlays-at (pos)
7089 "Remove outline overlays that do not contain non-white stuff."
7090 (mapc
7091 (lambda (o)
7092 (and (eq 'outline (overlay-get o 'invisible))
7093 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7094 (overlay-end o))))
7095 (delete-overlay o)))
7096 (overlays-at pos)))
7098 (defun org-clean-visibility-after-subtree-move ()
7099 "Fix visibility issues after moving a subtree."
7100 ;; First, find a reasonable region to look at:
7101 ;; Start two siblings above, end three below
7102 (let* ((beg (save-excursion
7103 (and (org-get-last-sibling)
7104 (org-get-last-sibling))
7105 (point)))
7106 (end (save-excursion
7107 (and (org-get-next-sibling)
7108 (org-get-next-sibling)
7109 (org-get-next-sibling))
7110 (if (org-at-heading-p)
7111 (point-at-eol)
7112 (point))))
7113 (level (looking-at "\\*+"))
7114 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7115 (save-excursion
7116 (save-restriction
7117 (narrow-to-region beg end)
7118 (when re
7119 ;; Properly fold already folded siblings
7120 (goto-char (point-min))
7121 (while (re-search-forward re nil t)
7122 (if (and (not (outline-invisible-p))
7123 (save-excursion
7124 (goto-char (point-at-eol)) (outline-invisible-p)))
7125 (outline-hide-entry))))
7126 (org-cycle-show-empty-lines 'overview)
7127 (org-cycle-hide-drawers 'overview)))))
7129 (defun org-cycle-show-empty-lines (state)
7130 "Show empty lines above all visible headlines.
7131 The region to be covered depends on STATE when called through
7132 `org-cycle-hook'. Lisp program can use t for STATE to get the
7133 entire buffer covered. Note that an empty line is only shown if there
7134 are at least `org-cycle-separator-lines' empty lines before the headline."
7135 (when (/= org-cycle-separator-lines 0)
7136 (save-excursion
7137 (let* ((n (abs org-cycle-separator-lines))
7138 (re (cond
7139 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7140 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7141 (t (let ((ns (number-to-string (- n 2))))
7142 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7143 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7144 beg end)
7145 (cond
7146 ((memq state '(overview contents t))
7147 (setq beg (point-min) end (point-max)))
7148 ((memq state '(children folded))
7149 (setq beg (point)
7150 end (progn (org-end-of-subtree t t)
7151 (line-beginning-position 2)))))
7152 (when beg
7153 (goto-char beg)
7154 (while (re-search-forward re end t)
7155 (unless (get-char-property (match-end 1) 'invisible)
7156 (let ((e (match-end 1))
7157 (b (if (>= org-cycle-separator-lines 0)
7158 (match-beginning 1)
7159 (save-excursion
7160 (goto-char (match-beginning 0))
7161 (skip-chars-backward " \t\n")
7162 (line-end-position)))))
7163 (outline-flag-region b e nil))))))))
7164 ;; Never hide empty lines at the end of the file.
7165 (save-excursion
7166 (goto-char (point-max))
7167 (outline-previous-heading)
7168 (outline-end-of-heading)
7169 (if (and (looking-at "[ \t\n]+")
7170 (= (match-end 0) (point-max)))
7171 (outline-flag-region (point) (match-end 0) nil))))
7173 (defun org-show-empty-lines-in-parent ()
7174 "Move to the parent and re-show empty lines before visible headlines."
7175 (save-excursion
7176 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7177 (org-cycle-show-empty-lines context))))
7179 (defun org-files-list ()
7180 "Return `org-agenda-files' list, plus all open org-mode files.
7181 This is useful for operations that need to scan all of a user's
7182 open and agenda-wise Org files."
7183 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7184 (dolist (buf (buffer-list))
7185 (with-current-buffer buf
7186 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7187 (let ((file (expand-file-name (buffer-file-name))))
7188 (unless (member file files)
7189 (push file files))))))
7190 files))
7192 (defsubst org-entry-beginning-position ()
7193 "Return the beginning position of the current entry."
7194 (save-excursion (org-back-to-heading t) (point)))
7196 (defsubst org-entry-end-position ()
7197 "Return the end position of the current entry."
7198 (save-excursion (outline-next-heading) (point)))
7200 (defun org-cycle-hide-drawers (state &optional exceptions)
7201 "Re-hide all drawers after a visibility state change.
7202 When non-nil, optional argument EXCEPTIONS is a list of strings
7203 specifying which drawers should not be hidden."
7204 (when (and (derived-mode-p 'org-mode)
7205 (not (memq state '(overview folded contents))))
7206 (save-excursion
7207 (let* ((globalp (memq state '(contents all)))
7208 (beg (if globalp (point-min) (point)))
7209 (end (if globalp (point-max)
7210 (if (eq state 'children)
7211 (save-excursion (outline-next-heading) (point))
7212 (org-end-of-subtree t)))))
7213 (goto-char beg)
7214 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7215 (unless (member-ignore-case (match-string 1) exceptions)
7216 (let ((drawer (org-element-at-point)))
7217 (when (memq (org-element-type drawer) '(drawer property-drawer))
7218 (org-flag-drawer t drawer)
7219 ;; Make sure to skip drawer entirely or we might flag
7220 ;; it another time when matching its ending line with
7221 ;; `org-drawer-regexp'.
7222 (goto-char (org-element-property :end drawer))))))))))
7224 (defun org-flag-drawer (flag &optional element)
7225 "When FLAG is non-nil, hide the drawer we are at.
7226 Otherwise make it visible. When optional argument ELEMENT is
7227 a parsed drawer, as returned by `org-element-at-point', hide or
7228 show that drawer instead."
7229 (when (save-excursion
7230 (beginning-of-line)
7231 (org-looking-at-p org-drawer-regexp))
7232 (let ((drawer (or element (org-element-at-point))))
7233 (when (memq (org-element-type drawer) '(drawer property-drawer))
7234 (let ((post (org-element-property :post-affiliated drawer)))
7235 (save-excursion
7236 (outline-flag-region
7237 (progn (goto-char post) (line-end-position))
7238 (progn (goto-char (org-element-property :end drawer))
7239 (skip-chars-backward " \r\t\n")
7240 (line-end-position))
7241 flag))
7242 ;; When the drawer is hidden away, make sure point lies in
7243 ;; a visible part of the buffer.
7244 (when (and flag (> (line-beginning-position) post))
7245 (goto-char post)))))))
7247 (defun org-subtree-end-visible-p ()
7248 "Is the end of the current subtree visible?"
7249 (pos-visible-in-window-p
7250 (save-excursion (org-end-of-subtree t) (point))))
7252 (defun org-first-headline-recenter ()
7253 "Move cursor to the first headline and recenter the headline."
7254 (goto-char (point-min))
7255 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7256 (set-window-start (selected-window) (point-at-bol))))
7258 ;;; Saving and restoring visibility
7260 (defun org-outline-overlay-data (&optional use-markers)
7261 "Return a list of the locations of all outline overlays.
7262 These are overlays with the `invisible' property value `outline'.
7263 The return value is a list of cons cells, with start and stop
7264 positions for each overlay.
7265 If USE-MARKERS is set, return the positions as markers."
7266 (let (beg end)
7267 (save-excursion
7268 (save-restriction
7269 (widen)
7270 (delq nil
7271 (mapcar (lambda (o)
7272 (when (eq (overlay-get o 'invisible) 'outline)
7273 (setq beg (overlay-start o)
7274 end (overlay-end o))
7275 (and beg end (> end beg)
7276 (if use-markers
7277 (cons (copy-marker beg)
7278 (copy-marker end t))
7279 (cons beg end)))))
7280 (overlays-in (point-min) (point-max))))))))
7282 (defun org-set-outline-overlay-data (data)
7283 "Create visibility overlays for all positions in DATA.
7284 DATA should have been made by `org-outline-overlay-data'."
7285 (let (o)
7286 (save-excursion
7287 (save-restriction
7288 (widen)
7289 (outline-show-all)
7290 (mapc (lambda (c)
7291 (outline-flag-region (car c) (cdr c) t))
7292 data)))))
7294 ;;; Folding of blocks
7296 (defvar org-hide-block-overlays nil
7297 "Overlays hiding blocks.")
7298 (make-variable-buffer-local 'org-hide-block-overlays)
7300 (defun org-block-map (function &optional start end)
7301 "Call FUNCTION at the head of all source blocks in the current buffer.
7302 Optional arguments START and END can be used to limit the range."
7303 (let ((start (or start (point-min)))
7304 (end (or end (point-max))))
7305 (save-excursion
7306 (goto-char start)
7307 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7308 (save-excursion
7309 (save-match-data
7310 (goto-char (match-beginning 0))
7311 (funcall function)))))))
7313 (defun org-hide-block-toggle-all ()
7314 "Toggle the visibility of all blocks in the current buffer."
7315 (org-block-map 'org-hide-block-toggle))
7317 (defun org-hide-block-all ()
7318 "Fold all blocks in the current buffer."
7319 (interactive)
7320 (org-show-block-all)
7321 (org-block-map 'org-hide-block-toggle-maybe))
7323 (defun org-show-block-all ()
7324 "Unfold all blocks in the current buffer."
7325 (interactive)
7326 (mapc 'delete-overlay org-hide-block-overlays)
7327 (setq org-hide-block-overlays nil))
7329 (defun org-hide-block-toggle-maybe ()
7330 "Toggle visibility of block at point.
7331 Unlike to `org-hide-block-toggle', this function does not throw
7332 an error. Return a non-nil value when toggling is successful."
7333 (interactive)
7334 (ignore-errors (org-hide-block-toggle)))
7336 (defun org-hide-block-toggle (&optional force)
7337 "Toggle the visibility of the current block.
7338 When optional argument FORCE is `off', make block visible. If it
7339 is non-nil, hide it unconditionally. Throw an error when not at
7340 a block. Return a non-nil value when toggling is successful."
7341 (interactive)
7342 (let ((element (org-element-at-point)))
7343 (unless (memq (org-element-type element)
7344 '(center-block comment-block dynamic-block example-block
7345 export-block quote-block special-block
7346 src-block verse-block))
7347 (user-error "Not at a block"))
7348 (let* ((start (save-excursion
7349 (goto-char (org-element-property :post-affiliated element))
7350 (line-end-position)))
7351 (end (save-excursion
7352 (goto-char (org-element-property :end element))
7353 (skip-chars-backward " \r\t\n")
7354 (line-end-position)))
7355 (overlays (overlays-at start)))
7356 (cond
7357 ;; Do nothing when not before or at the block opening line or
7358 ;; at the block closing line.
7359 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7360 ((and (not (eq force 'off))
7361 (not (memq t (mapcar
7362 (lambda (o)
7363 (eq (overlay-get o 'invisible) 'org-hide-block))
7364 overlays))))
7365 (let ((ov (make-overlay start end)))
7366 (overlay-put ov 'invisible 'org-hide-block)
7367 ;; Make the block accessible to `isearch'.
7368 (overlay-put
7369 ov 'isearch-open-invisible
7370 (lambda (ov)
7371 (when (memq ov org-hide-block-overlays)
7372 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7373 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7374 (delete-overlay ov))))
7375 (push ov org-hide-block-overlays)
7376 ;; When the block is hidden away, make sure point is left in
7377 ;; a visible part of the buffer.
7378 (when (> (line-beginning-position) start)
7379 (goto-char start)
7380 (beginning-of-line))
7381 ;; Signal successful toggling.
7383 ((or (not force) (eq force 'off))
7384 (dolist (ov overlays t)
7385 (when (memq ov org-hide-block-overlays)
7386 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7387 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7388 (delete-overlay ov))))))))
7390 ;; org-tab-after-check-for-cycling-hook
7391 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7392 ;; Remove overlays when changing major mode
7393 (add-hook 'org-mode-hook
7394 (lambda () (org-add-hook 'change-major-mode-hook
7395 'org-show-block-all 'append 'local)))
7397 ;;; Org-goto
7399 (defvar org-goto-window-configuration nil)
7400 (defvar org-goto-marker nil)
7401 (defvar org-goto-map)
7402 (defun org-goto-map ()
7403 "Set the keymap `org-goto'."
7404 (setq org-goto-map
7405 (let ((map (make-sparse-keymap)))
7406 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7407 mouse-drag-region universal-argument org-occur)))
7408 (dolist (cmd cmds)
7409 (substitute-key-definition cmd cmd map global-map)))
7410 (suppress-keymap map)
7411 (org-defkey map "\C-m" 'org-goto-ret)
7412 (org-defkey map [(return)] 'org-goto-ret)
7413 (org-defkey map [(left)] 'org-goto-left)
7414 (org-defkey map [(right)] 'org-goto-right)
7415 (org-defkey map [(control ?g)] 'org-goto-quit)
7416 (org-defkey map "\C-i" 'org-cycle)
7417 (org-defkey map [(tab)] 'org-cycle)
7418 (org-defkey map [(down)] 'outline-next-visible-heading)
7419 (org-defkey map [(up)] 'outline-previous-visible-heading)
7420 (if org-goto-auto-isearch
7421 (if (fboundp 'define-key-after)
7422 (define-key-after map [t] 'org-goto-local-auto-isearch)
7423 nil)
7424 (org-defkey map "q" 'org-goto-quit)
7425 (org-defkey map "n" 'outline-next-visible-heading)
7426 (org-defkey map "p" 'outline-previous-visible-heading)
7427 (org-defkey map "f" 'outline-forward-same-level)
7428 (org-defkey map "b" 'outline-backward-same-level)
7429 (org-defkey map "u" 'outline-up-heading))
7430 (org-defkey map "/" 'org-occur)
7431 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7432 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7433 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7434 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7435 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7436 map)))
7438 (defconst org-goto-help
7439 "Browse buffer copy, to find location or copy text.%s
7440 RET=jump to location C-g=quit and return to previous location
7441 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7443 (defvar org-goto-start-pos) ; dynamically scoped parameter
7445 (defun org-goto (&optional alternative-interface)
7446 "Look up a different location in the current file, keeping current visibility.
7448 When you want look-up or go to a different location in a
7449 document, the fastest way is often to fold the entire buffer and
7450 then dive into the tree. This method has the disadvantage, that
7451 the previous location will be folded, which may not be what you
7452 want.
7454 This command works around this by showing a copy of the current
7455 buffer in an indirect buffer, in overview mode. You can dive
7456 into the tree in that copy, use org-occur and incremental search
7457 to find a location. When pressing RET or `Q', the command
7458 returns to the original buffer in which the visibility is still
7459 unchanged. After RET it will also jump to the location selected
7460 in the indirect buffer and expose the headline hierarchy above.
7462 With a prefix argument, use the alternative interface: e.g., if
7463 `org-goto-interface' is `outline' use `outline-path-completion'."
7464 (interactive "P")
7465 (org-goto-map)
7466 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7467 (org-refile-use-outline-path t)
7468 (org-refile-target-verify-function nil)
7469 (interface
7470 (if (not alternative-interface)
7471 org-goto-interface
7472 (if (eq org-goto-interface 'outline)
7473 'outline-path-completion
7474 'outline)))
7475 (org-goto-start-pos (point))
7476 (selected-point
7477 (if (eq interface 'outline)
7478 (car (org-get-location (current-buffer) org-goto-help))
7479 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7480 (org-refile-check-position pa)
7481 (nth 3 pa)))))
7482 (if selected-point
7483 (progn
7484 (org-mark-ring-push org-goto-start-pos)
7485 (goto-char selected-point)
7486 (if (or (outline-invisible-p) (org-invisible-p2))
7487 (org-show-context 'org-goto)))
7488 (message "Quit"))))
7490 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7491 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7492 (defvar org-goto-local-auto-isearch-map) ; defined below
7494 (defun org-get-location (buf help)
7495 "Let the user select a location in the Org-mode buffer BUF.
7496 This function uses a recursive edit. It returns the selected position
7497 or nil."
7498 (org-no-popups
7499 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7500 (isearch-hide-immediately nil)
7501 (isearch-search-fun-function
7502 (lambda () 'org-goto-local-search-headings))
7503 (org-goto-selected-point org-goto-exit-command))
7504 (save-excursion
7505 (save-window-excursion
7506 (delete-other-windows)
7507 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7508 (org-pop-to-buffer-same-window
7509 (condition-case nil
7510 (make-indirect-buffer (current-buffer) "*org-goto*")
7511 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7512 (with-output-to-temp-buffer "*Org Help*"
7513 (princ (format help (if org-goto-auto-isearch
7514 " Just type for auto-isearch."
7515 " n/p/f/b/u to navigate, q to quit."))))
7516 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7517 (setq buffer-read-only nil)
7518 (let ((org-startup-truncated t)
7519 (org-startup-folded nil)
7520 (org-startup-align-all-tables nil))
7521 (org-mode)
7522 (org-overview))
7523 (setq buffer-read-only t)
7524 (if (and (boundp 'org-goto-start-pos)
7525 (integer-or-marker-p org-goto-start-pos))
7526 (progn (goto-char org-goto-start-pos)
7527 (when (outline-invisible-p)
7528 (org-show-set-visibility 'lineage)))
7529 (goto-char (point-min)))
7530 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7531 (message "Select location and press RET")
7532 (use-local-map org-goto-map)
7533 (recursive-edit)))
7534 (kill-buffer "*org-goto*")
7535 (cons org-goto-selected-point org-goto-exit-command))))
7537 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7538 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7539 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7540 (if (fboundp 'isearch-other-control-char)
7541 (progn
7542 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7543 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7544 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7545 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7546 (define-key org-goto-local-auto-isearch-map [return] nil))
7548 (defun org-goto-local-search-headings (string bound noerror)
7549 "Search and make sure that any matches are in headlines."
7550 (catch 'return
7551 (while (if isearch-forward
7552 (search-forward string bound noerror)
7553 (search-backward string bound noerror))
7554 (when (save-match-data
7555 (and (save-excursion
7556 (beginning-of-line)
7557 (looking-at org-complex-heading-regexp))
7558 (or (not (match-beginning 5))
7559 (< (point) (match-beginning 5)))))
7560 (throw 'return (point))))))
7562 (defun org-goto-local-auto-isearch ()
7563 "Start isearch."
7564 (interactive)
7565 (goto-char (point-min))
7566 (let ((keys (this-command-keys)))
7567 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7568 (isearch-mode t)
7569 (isearch-process-search-char (string-to-char keys)))))
7571 (defun org-goto-ret (&optional arg)
7572 "Finish `org-goto' by going to the new location."
7573 (interactive "P")
7574 (setq org-goto-selected-point (point)
7575 org-goto-exit-command 'return)
7576 (throw 'exit nil))
7578 (defun org-goto-left ()
7579 "Finish `org-goto' by going to the new location."
7580 (interactive)
7581 (if (org-at-heading-p)
7582 (progn
7583 (beginning-of-line 1)
7584 (setq org-goto-selected-point (point)
7585 org-goto-exit-command 'left)
7586 (throw 'exit nil))
7587 (user-error "Not on a heading")))
7589 (defun org-goto-right ()
7590 "Finish `org-goto' by going to the new location."
7591 (interactive)
7592 (if (org-at-heading-p)
7593 (progn
7594 (setq org-goto-selected-point (point)
7595 org-goto-exit-command 'right)
7596 (throw 'exit nil))
7597 (user-error "Not on a heading")))
7599 (defun org-goto-quit ()
7600 "Finish `org-goto' without cursor motion."
7601 (interactive)
7602 (setq org-goto-selected-point nil)
7603 (setq org-goto-exit-command 'quit)
7604 (throw 'exit nil))
7606 ;;; Indirect buffer display of subtrees
7608 (defvar org-indirect-dedicated-frame nil
7609 "This is the frame being used for indirect tree display.")
7610 (defvar org-last-indirect-buffer nil)
7612 (defun org-tree-to-indirect-buffer (&optional arg)
7613 "Create indirect buffer and narrow it to current subtree.
7614 With a numerical prefix ARG, go up to this level and then take that tree.
7615 If ARG is negative, go up that many levels.
7617 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7618 indirect buffer previously made with this command, to avoid proliferation of
7619 indirect buffers. However, when you call the command with a \
7620 \\[universal-argument] prefix, or
7621 when `org-indirect-buffer-display' is `new-frame', the last buffer
7622 is kept so that you can work with several indirect buffers at the same time.
7623 If `org-indirect-buffer-display' is `dedicated-frame', the \
7624 \\[universal-argument] prefix also
7625 requests that a new frame be made for the new buffer, so that the dedicated
7626 frame is not changed."
7627 (interactive "P")
7628 (let ((cbuf (current-buffer))
7629 (cwin (selected-window))
7630 (pos (point))
7631 beg end level heading ibuf)
7632 (save-excursion
7633 (org-back-to-heading t)
7634 (when (numberp arg)
7635 (setq level (org-outline-level))
7636 (if (< arg 0) (setq arg (+ level arg)))
7637 (while (> (setq level (org-outline-level)) arg)
7638 (org-up-heading-safe)))
7639 (setq beg (point)
7640 heading (org-get-heading))
7641 (org-end-of-subtree t t)
7642 (if (org-at-heading-p) (backward-char 1))
7643 (setq end (point)))
7644 (if (and (buffer-live-p org-last-indirect-buffer)
7645 (not (eq org-indirect-buffer-display 'new-frame))
7646 (not arg))
7647 (kill-buffer org-last-indirect-buffer))
7648 (setq ibuf (org-get-indirect-buffer cbuf heading)
7649 org-last-indirect-buffer ibuf)
7650 (cond
7651 ((or (eq org-indirect-buffer-display 'new-frame)
7652 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7653 (select-frame (make-frame))
7654 (delete-other-windows)
7655 (org-pop-to-buffer-same-window ibuf)
7656 (org-set-frame-title heading))
7657 ((eq org-indirect-buffer-display 'dedicated-frame)
7658 (raise-frame
7659 (select-frame (or (and org-indirect-dedicated-frame
7660 (frame-live-p org-indirect-dedicated-frame)
7661 org-indirect-dedicated-frame)
7662 (setq org-indirect-dedicated-frame (make-frame)))))
7663 (delete-other-windows)
7664 (org-pop-to-buffer-same-window ibuf)
7665 (org-set-frame-title (concat "Indirect: " heading)))
7666 ((eq org-indirect-buffer-display 'current-window)
7667 (org-pop-to-buffer-same-window ibuf))
7668 ((eq org-indirect-buffer-display 'other-window)
7669 (pop-to-buffer ibuf))
7670 (t (error "Invalid value")))
7671 (if (featurep 'xemacs)
7672 (save-excursion (org-mode) (turn-on-font-lock)))
7673 (narrow-to-region beg end)
7674 (outline-show-all)
7675 (goto-char pos)
7676 (run-hook-with-args 'org-cycle-hook 'all)
7677 (and (window-live-p cwin) (select-window cwin))))
7679 (defun org-get-indirect-buffer (&optional buffer heading)
7680 (setq buffer (or buffer (current-buffer)))
7681 (let ((n 1) (base (buffer-name buffer)) bname)
7682 (while (buffer-live-p
7683 (get-buffer
7684 (setq bname
7685 (concat base "-"
7686 (if heading (concat heading "-" (number-to-string n))
7687 (number-to-string n))))))
7688 (setq n (1+ n)))
7689 (condition-case nil
7690 (make-indirect-buffer buffer bname 'clone)
7691 (error (make-indirect-buffer buffer bname)))))
7693 (defun org-set-frame-title (title)
7694 "Set the title of the current frame to the string TITLE."
7695 ;; FIXME: how to name a single frame in XEmacs???
7696 (unless (featurep 'xemacs)
7697 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7699 ;;;; Structure editing
7701 ;;; Inserting headlines
7703 (defun org-previous-line-empty-p (&optional next)
7704 "Is the previous line a blank line?
7705 When NEXT is non-nil, check the next line instead."
7706 (save-excursion
7707 (and (not (bobp))
7708 (or (beginning-of-line (if next 2 0)) t)
7709 (save-match-data
7710 (looking-at "[ \t]*$")))))
7712 (defun org-insert-heading (&optional arg invisible-ok top-level)
7713 "Insert a new heading or an item with the same depth at point.
7715 If point is at the beginning of a heading or a list item, insert
7716 a new heading or a new item above the current one. If point is
7717 at the beginning of a normal line, turn the line into a heading.
7719 If point is in the middle of a headline or a list item, split the
7720 headline or the item and create a new headline/item with the text
7721 in the current line after point \(see `org-M-RET-may-split-line'
7722 on how to modify this behavior).
7724 With one universal prefix argument, set the user option
7725 `org-insert-heading-respect-content' to t for the duration of
7726 the command. This modifies the behavior described above in this
7727 ways: on list items and at the beginning of normal lines, force
7728 the insertion of a heading after the current subtree.
7730 With two universal prefix arguments, insert the heading at the
7731 end of the grandparent subtree. For example, if point is within
7732 a 2nd-level heading, then it will insert a 2nd-level heading at
7733 the end of the 1st-level parent heading.
7735 If point is at the beginning of a headline, insert a sibling
7736 before the current headline. If point is not at the beginning,
7737 split the line and create a new headline with the text in the
7738 current line after point \(see `org-M-RET-may-split-line' on how
7739 to modify this behavior).
7741 If point is at the beginning of a normal line, turn this line
7742 into a heading.
7744 When INVISIBLE-OK is set, stop at invisible headlines when going
7745 back. This is important for non-interactive uses of the
7746 command.
7748 When optional argument TOP-LEVEL is non-nil, insert a level 1
7749 heading, unconditionally."
7750 (interactive "P")
7751 (if (org-called-interactively-p 'any) (org-reveal))
7752 (let ((itemp (and (not top-level) (org-in-item-p)))
7753 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7754 (respect-content (or org-insert-heading-respect-content
7755 (equal arg '(4))))
7756 (initial-content ""))
7758 (cond
7760 ((or (= (buffer-size) 0)
7761 (and (not (save-excursion
7762 (and (ignore-errors (org-back-to-heading invisible-ok))
7763 (org-at-heading-p))))
7764 (or arg (not itemp))))
7765 ;; At beginning of buffer or so high up that only a heading
7766 ;; makes sense.
7767 (cond ((and (bolp) (not respect-content)) (insert "* "))
7768 ((not respect-content)
7769 (unless may-split (end-of-line))
7770 (insert "\n* "))
7771 ((re-search-forward org-outline-regexp-bol nil t)
7772 (beginning-of-line)
7773 (insert "* \n")
7774 (backward-char))
7775 (t (goto-char (point-max))
7776 (insert "\n* ")))
7777 (run-hooks 'org-insert-heading-hook))
7779 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7782 ;; Maybe move at the end of the subtree
7783 (when (equal arg '(16))
7784 (org-up-heading-safe)
7785 (org-end-of-subtree t))
7786 ;; Insert a heading
7787 (save-restriction
7788 (widen)
7789 (let* ((level nil)
7790 (on-heading (org-at-heading-p))
7791 (empty-line-p (if on-heading
7792 (org-previous-line-empty-p)
7793 ;; We will decide later
7794 nil))
7795 ;; Get a level string to fall back on.
7796 (fix-level
7797 (if (org-before-first-heading-p) "*"
7798 (save-excursion
7799 (org-back-to-heading t)
7800 (if (org-previous-line-empty-p) (setq empty-line-p t))
7801 (looking-at org-outline-regexp)
7802 (make-string (1- (length (match-string 0))) ?*))))
7803 (stars
7804 (save-excursion
7805 (condition-case nil
7806 (if top-level "* "
7807 (org-back-to-heading invisible-ok)
7808 (when (and (not on-heading)
7809 (featurep 'org-inlinetask)
7810 (integerp org-inlinetask-min-level)
7811 (>= (length (match-string 0))
7812 org-inlinetask-min-level))
7813 ;; Find a heading level before the inline
7814 ;; task.
7815 (while (and (setq level (org-up-heading-safe))
7816 (>= level org-inlinetask-min-level)))
7817 (if (org-at-heading-p)
7818 (org-back-to-heading invisible-ok)
7819 (error "This should not happen")))
7820 (unless (and (save-excursion
7821 (save-match-data
7822 (org-backward-heading-same-level
7823 1 invisible-ok))
7824 (= (point) (match-beginning 0)))
7825 (not (org-previous-line-empty-p t)))
7826 (setq empty-line-p (or empty-line-p
7827 (org-previous-line-empty-p))))
7828 (match-string 0))
7829 (error (or fix-level "* ")))))
7830 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7831 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7832 pos hide-previous previous-pos)
7834 ;; If we insert after content, move there and clean up
7835 ;; whitespace.
7836 (when (and respect-content
7837 (not (org-looking-at-p org-outline-regexp-bol)))
7838 (if (not (org-before-first-heading-p))
7839 (org-end-of-subtree nil t)
7840 (re-search-forward org-outline-regexp-bol)
7841 (beginning-of-line 0))
7842 (skip-chars-backward " \r\t\n")
7843 (and (not (org-looking-back "^\\*+" (line-beginning-position)))
7844 (looking-at "[ \t]+") (replace-match ""))
7845 (unless (eobp) (forward-char 1))
7846 (when (looking-at "^\\*")
7847 (unless (bobp) (backward-char 1))
7848 (insert "\n")))
7850 ;; If we are splitting, grab the text that should be moved
7851 ;; to the new headline.
7852 (when may-split
7853 (if (org-on-heading-p)
7854 ;; This is a heading: split intelligently (keeping
7855 ;; tags).
7856 (let ((pos (point)))
7857 (beginning-of-line)
7858 (unless (looking-at org-complex-heading-regexp)
7859 (error "This should not happen"))
7860 (when (and (match-beginning 4)
7861 (> pos (match-beginning 4))
7862 (< pos (match-end 4)))
7863 (setq initial-content (buffer-substring pos (match-end 4)))
7864 (goto-char pos)
7865 (delete-region (point) (match-end 4))
7866 (if (looking-at "[ \t]*$")
7867 (replace-match "")
7868 (insert (make-string (length initial-content) ?\s)))
7869 (setq initial-content (org-trim initial-content)))
7870 (goto-char pos))
7871 ;; A normal line.
7872 (setq initial-content
7873 (org-trim
7874 (delete-and-extract-region (point) (line-end-position))))))
7876 ;; If we are at the beginning of the line, insert before it.
7877 ;; Otherwise, after it.
7878 (cond
7879 ((and (bolp) (looking-at "[ \t]*$")))
7880 ((bolp) (save-excursion (insert "\n")))
7881 (t (end-of-line)
7882 (insert "\n")))
7884 ;; Insert the new heading
7885 (insert stars)
7886 (just-one-space)
7887 (insert initial-content)
7888 (unless (and blank (org-previous-line-empty-p))
7889 (org-N-empty-lines-before-current (if blank 1 0)))
7890 ;; Adjust visibility, which may be messed up if we removed
7891 ;; blank lines while previous entry was hidden.
7892 (let ((bol (line-beginning-position)))
7893 (dolist (o (overlays-at (1- bol)))
7894 (when (and (eq (overlay-get o 'invisible) 'outline)
7895 (eq (overlay-end o) bol))
7896 (move-overlay o (overlay-start o) (1- bol)))))
7897 (run-hooks 'org-insert-heading-hook)))))))
7899 (defun org-N-empty-lines-before-current (N)
7900 "Make the number of empty lines before current exactly N.
7901 So this will delete or add empty lines."
7902 (save-excursion
7903 (beginning-of-line)
7904 (let ((p (point)))
7905 (skip-chars-backward " \r\t\n")
7906 (unless (bolp) (forward-line))
7907 (delete-region (point) p))
7908 (when (> N 0) (insert (make-string N ?\n)))))
7910 (defun org-get-heading (&optional no-tags no-todo)
7911 "Return the heading of the current entry, without the stars.
7912 When NO-TAGS is non-nil, don't include tags.
7913 When NO-TODO is non-nil, don't include TODO keywords."
7914 (save-excursion
7915 (org-back-to-heading t)
7916 (cond
7917 ((and no-tags no-todo)
7918 (looking-at org-complex-heading-regexp)
7919 (match-string 4))
7920 (no-tags
7921 (looking-at (concat org-outline-regexp
7922 "\\(.*?\\)"
7923 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7924 (match-string 1))
7925 (no-todo
7926 (looking-at org-todo-line-regexp)
7927 (match-string 3))
7928 (t (looking-at org-heading-regexp)
7929 (match-string 2)))))
7931 (defvar orgstruct-mode) ; defined below
7933 (defun org-heading-components ()
7934 "Return the components of the current heading.
7935 This is a list with the following elements:
7936 - the level as an integer
7937 - the reduced level, different if `org-odd-levels-only' is set.
7938 - the TODO keyword, or nil
7939 - the priority character, like ?A, or nil if no priority is given
7940 - the headline text itself, or the tags string if no headline text
7941 - the tags string, or nil."
7942 (save-excursion
7943 (org-back-to-heading t)
7944 (if (let (case-fold-search)
7945 (looking-at
7946 (if orgstruct-mode
7947 org-heading-regexp
7948 org-complex-heading-regexp)))
7949 (if orgstruct-mode
7950 (list (length (match-string 1))
7951 (org-reduced-level (length (match-string 1)))
7954 (match-string 2)
7955 nil)
7956 (list (length (match-string 1))
7957 (org-reduced-level (length (match-string 1)))
7958 (org-match-string-no-properties 2)
7959 (and (match-end 3) (aref (match-string 3) 2))
7960 (org-match-string-no-properties 4)
7961 (org-match-string-no-properties 5))))))
7963 (defun org-get-entry ()
7964 "Get the entry text, after heading, entire subtree."
7965 (save-excursion
7966 (org-back-to-heading t)
7967 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7969 (defun org-insert-heading-after-current ()
7970 "Insert a new heading with same level as current, after current subtree."
7971 (interactive)
7972 (org-back-to-heading)
7973 (org-insert-heading)
7974 (org-move-subtree-down)
7975 (end-of-line 1))
7977 (defun org-insert-heading-respect-content (&optional invisible-ok)
7978 "Insert heading with `org-insert-heading-respect-content' set to t."
7979 (interactive)
7980 (org-insert-heading '(4) invisible-ok))
7982 (defun org-insert-todo-heading-respect-content (&optional force-state)
7983 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7984 (interactive)
7985 (org-insert-todo-heading force-state '(4)))
7987 (defun org-insert-todo-heading (arg &optional force-heading)
7988 "Insert a new heading with the same level and TODO state as current heading.
7989 If the heading has no TODO state, or if the state is DONE, use the first
7990 state (TODO by default). Also with one prefix arg, force first state. With
7991 two prefix args, force inserting at the end of the parent subtree."
7992 (interactive "P")
7993 (when (or force-heading (not (org-insert-item 'checkbox)))
7994 (org-insert-heading (or (and (equal arg '(16)) '(16))
7995 force-heading))
7996 (save-excursion
7997 (org-back-to-heading)
7998 (outline-previous-heading)
7999 (looking-at org-todo-line-regexp))
8000 (let*
8001 ((new-mark-x
8002 (if (or (equal arg '(4))
8003 (not (match-beginning 2))
8004 (member (match-string 2) org-done-keywords))
8005 (car org-todo-keywords-1)
8006 (match-string 2)))
8007 (new-mark
8009 (run-hook-with-args-until-success
8010 'org-todo-get-default-hook new-mark-x nil)
8011 new-mark-x)))
8012 (beginning-of-line 1)
8013 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8014 (if org-treat-insert-todo-heading-as-state-change
8015 (org-todo new-mark)
8016 (insert new-mark " "))))
8017 (when org-provide-todo-statistics
8018 (org-update-parent-todo-statistics))))
8020 (defun org-insert-subheading (arg)
8021 "Insert a new subheading and demote it.
8022 Works for outline headings and for plain lists alike."
8023 (interactive "P")
8024 (org-insert-heading arg)
8025 (cond
8026 ((org-at-heading-p) (org-do-demote))
8027 ((org-at-item-p) (org-indent-item))))
8029 (defun org-insert-todo-subheading (arg)
8030 "Insert a new subheading with TODO keyword or checkbox and demote it.
8031 Works for outline headings and for plain lists alike."
8032 (interactive "P")
8033 (org-insert-todo-heading arg)
8034 (cond
8035 ((org-at-heading-p) (org-do-demote))
8036 ((org-at-item-p) (org-indent-item))))
8038 ;;; Promotion and Demotion
8040 (defvar org-after-demote-entry-hook nil
8041 "Hook run after an entry has been demoted.
8042 The cursor will be at the beginning of the entry.
8043 When a subtree is being demoted, the hook will be called for each node.")
8045 (defvar org-after-promote-entry-hook nil
8046 "Hook run after an entry has been promoted.
8047 The cursor will be at the beginning of the entry.
8048 When a subtree is being promoted, the hook will be called for each node.")
8050 (defun org-promote-subtree ()
8051 "Promote the entire subtree.
8052 See also `org-promote'."
8053 (interactive)
8054 (save-excursion
8055 (org-with-limited-levels (org-map-tree 'org-promote)))
8056 (org-fix-position-after-promote))
8058 (defun org-demote-subtree ()
8059 "Demote the entire subtree.
8060 See `org-demote' and `org-promote'."
8061 (interactive)
8062 (save-excursion
8063 (org-with-limited-levels (org-map-tree 'org-demote)))
8064 (org-fix-position-after-promote))
8066 (defun org-do-promote ()
8067 "Promote the current heading higher up the tree.
8068 If the region is active in `transient-mark-mode', promote all
8069 headings in the region."
8070 (interactive)
8071 (save-excursion
8072 (if (org-region-active-p)
8073 (org-map-region 'org-promote (region-beginning) (region-end))
8074 (org-promote)))
8075 (org-fix-position-after-promote))
8077 (defun org-do-demote ()
8078 "Demote the current heading lower down the tree.
8079 If the region is active in `transient-mark-mode', demote all
8080 headings in the region."
8081 (interactive)
8082 (save-excursion
8083 (if (org-region-active-p)
8084 (org-map-region 'org-demote (region-beginning) (region-end))
8085 (org-demote)))
8086 (org-fix-position-after-promote))
8088 (defun org-fix-position-after-promote ()
8089 "Fix cursor position and indentation after demoting/promoting."
8090 (let ((pos (point)))
8091 (when (save-excursion
8092 (beginning-of-line 1)
8093 (looking-at org-todo-line-regexp)
8094 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8095 (cond ((eobp) (insert " "))
8096 ((eolp) (insert " "))
8097 ((equal (char-after) ?\ ) (forward-char 1))))))
8099 (defun org-current-level ()
8100 "Return the level of the current entry, or nil if before the first headline.
8101 The level is the number of stars at the beginning of the
8102 headline. Use `org-reduced-level' to remove the effect of
8103 `org-odd-levels'. Unlike to `org-outline-level', this function
8104 ignores inlinetasks."
8105 (let ((level (org-with-limited-levels (org-outline-level))))
8106 (and (> level 0) level)))
8108 (defun org-get-previous-line-level ()
8109 "Return the outline depth of the last headline before the current line.
8110 Returns 0 for the first headline in the buffer, and nil if before the
8111 first headline."
8112 (and (org-current-level)
8113 (or (and (/= (line-beginning-position) (point-min))
8114 (save-excursion (beginning-of-line 0) (org-current-level)))
8115 0)))
8117 (defun org-reduced-level (l)
8118 "Compute the effective level of a heading.
8119 This takes into account the setting of `org-odd-levels-only'."
8120 (cond
8121 ((zerop l) 0)
8122 (org-odd-levels-only (1+ (floor (/ l 2))))
8123 (t l)))
8125 (defun org-level-increment ()
8126 "Return the number of stars that will be added or removed at a
8127 time to headlines when structure editing, based on the value of
8128 `org-odd-levels-only'."
8129 (if org-odd-levels-only 2 1))
8131 (defun org-get-valid-level (level &optional change)
8132 "Rectify a level change under the influence of `org-odd-levels-only'
8133 LEVEL is a current level, CHANGE is by how much the level should be
8134 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8135 even level numbers will become the next higher odd number."
8136 (if org-odd-levels-only
8137 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8138 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8139 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8140 (max 1 (+ level (or change 0)))))
8142 (if (boundp 'define-obsolete-function-alias)
8143 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8144 (define-obsolete-function-alias 'org-get-legal-level
8145 'org-get-valid-level)
8146 (define-obsolete-function-alias 'org-get-legal-level
8147 'org-get-valid-level "23.1")))
8149 (defun org-promote ()
8150 "Promote the current heading higher up the tree."
8151 (org-with-wide-buffer
8152 (org-back-to-heading t)
8153 (let* ((after-change-functions (remq 'flyspell-after-change-function
8154 after-change-functions))
8155 (level (save-match-data (funcall outline-level)))
8156 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8157 (diff (abs (- level (length up-head) -1))))
8158 (cond
8159 ((and (= level 1) org-allow-promoting-top-level-subtree)
8160 (replace-match "# " nil t))
8161 ((= level 1)
8162 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8163 (t (replace-match up-head nil t)))
8164 (unless (= level 1)
8165 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8166 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8167 (run-hooks 'org-after-promote-entry-hook))))
8169 (defun org-demote ()
8170 "Demote the current heading lower down the tree."
8171 (org-with-wide-buffer
8172 (org-back-to-heading t)
8173 (let* ((after-change-functions (remq 'flyspell-after-change-function
8174 after-change-functions))
8175 (level (save-match-data (funcall outline-level)))
8176 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8177 (diff (abs (- level (length down-head) -1))))
8178 (replace-match down-head nil t)
8179 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8180 (when org-adapt-indentation (org-fixup-indentation diff))
8181 (run-hooks 'org-after-demote-entry-hook))))
8183 (defun org-cycle-level ()
8184 "Cycle the level of an empty headline through possible states.
8185 This goes first to child, then to parent, level, then up the hierarchy.
8186 After top level, it switches back to sibling level."
8187 (interactive)
8188 (let ((org-adapt-indentation nil))
8189 (when (org-point-at-end-of-empty-headline)
8190 (setq this-command 'org-cycle-level) ; Only needed for caching
8191 (let ((cur-level (org-current-level))
8192 (prev-level (org-get-previous-line-level)))
8193 (cond
8194 ;; If first headline in file, promote to top-level.
8195 ((= prev-level 0)
8196 (loop repeat (/ (- cur-level 1) (org-level-increment))
8197 do (org-do-promote)))
8198 ;; If same level as prev, demote one.
8199 ((= prev-level cur-level)
8200 (org-do-demote))
8201 ;; If parent is top-level, promote to top level if not already.
8202 ((= prev-level 1)
8203 (loop repeat (/ (- cur-level 1) (org-level-increment))
8204 do (org-do-promote)))
8205 ;; If top-level, return to prev-level.
8206 ((= cur-level 1)
8207 (loop repeat (/ (- prev-level 1) (org-level-increment))
8208 do (org-do-demote)))
8209 ;; If less than prev-level, promote one.
8210 ((< cur-level prev-level)
8211 (org-do-promote))
8212 ;; If deeper than prev-level, promote until higher than
8213 ;; prev-level.
8214 ((> cur-level prev-level)
8215 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8216 do (org-do-promote))))
8217 t))))
8219 (defun org-map-tree (fun)
8220 "Call FUN for every heading underneath the current one."
8221 (org-back-to-heading)
8222 (let ((level (funcall outline-level)))
8223 (save-excursion
8224 (funcall fun)
8225 (while (and (progn
8226 (outline-next-heading)
8227 (> (funcall outline-level) level))
8228 (not (eobp)))
8229 (funcall fun)))))
8231 (defun org-map-region (fun beg end)
8232 "Call FUN for every heading between BEG and END."
8233 (let ((org-ignore-region t))
8234 (save-excursion
8235 (setq end (copy-marker end))
8236 (goto-char beg)
8237 (if (and (re-search-forward org-outline-regexp-bol nil t)
8238 (< (point) end))
8239 (funcall fun))
8240 (while (and (progn
8241 (outline-next-heading)
8242 (< (point) end))
8243 (not (eobp)))
8244 (funcall fun)))))
8246 (defun org-fixup-indentation (diff)
8247 "Change the indentation in the current entry by DIFF.
8249 DIFF is an integer. Indentation is done according to the
8250 following rules:
8252 - Planning information and property drawers are always indented
8253 according to the new level of the headline;
8255 - Footnote definitions and their contents are ignored;
8257 - Inlinetasks' boundaries are not shifted;
8259 - Empty lines are ignored;
8261 - Other lines' indentation are shifted by DIFF columns, unless
8262 it would introduce a structural change in the document, in
8263 which case no shifting is done at all.
8265 Assume point is at a heading or an inlinetask beginning."
8266 (org-with-wide-buffer
8267 (narrow-to-region (line-beginning-position)
8268 (save-excursion
8269 (if (org-with-limited-levels (org-at-heading-p))
8270 (org-with-limited-levels (outline-next-heading))
8271 (org-inlinetask-goto-end))
8272 (point)))
8273 (forward-line)
8274 ;; Indent properly planning info and property drawer.
8275 (when (org-looking-at-p org-planning-line-re)
8276 (org-indent-line)
8277 (forward-line))
8278 (when (looking-at org-property-drawer-re)
8279 (goto-char (match-end 0))
8280 (forward-line)
8281 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8282 (catch 'no-shift
8283 (when (zerop diff) (throw 'no-shift nil))
8284 ;; If DIFF is negative, first check if a shift is possible at all
8285 ;; (e.g., it doesn't break structure). This can only happen if
8286 ;; some contents are not properly indented.
8287 (let ((case-fold-search t))
8288 (when (< diff 0)
8289 (let ((diff (- diff))
8290 (forbidden-re (concat org-outline-regexp
8291 "\\|"
8292 (substring org-footnote-definition-re 1))))
8293 (save-excursion
8294 (while (not (eobp))
8295 (cond
8296 ((org-looking-at-p "[ \t]*$") (forward-line))
8297 ((and (org-looking-at-p org-footnote-definition-re)
8298 (let ((e (org-element-at-point)))
8299 (and (eq (org-element-type e) 'footnote-definition)
8300 (goto-char (org-element-property :end e))))))
8301 ((org-looking-at-p org-outline-regexp) (forward-line))
8302 ;; Give up if shifting would move before column 0 or
8303 ;; if it would introduce a headline or a footnote
8304 ;; definition.
8306 (skip-chars-forward " \t")
8307 (let ((ind (current-column)))
8308 (when (or (< ind diff)
8309 (and (= ind diff) (org-looking-at-p forbidden-re)))
8310 (throw 'no-shift nil)))
8311 ;; Ignore contents of example blocks and source
8312 ;; blocks if their indentation is meant to be
8313 ;; preserved. Jump to block's closing line.
8314 (beginning-of-line)
8315 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8316 (let ((e (org-element-at-point)))
8317 (and (memq (org-element-type e)
8318 '(example-block src-block))
8319 (or org-src-preserve-indentation
8320 (org-element-property :preserve-indent e))
8321 (goto-char (org-element-property :end e))
8322 (progn (skip-chars-backward " \r\t\n")
8323 (beginning-of-line)
8324 t))))
8325 (forward-line))))))))
8326 ;; Shift lines but footnote definitions, inlinetasks boundaries
8327 ;; by DIFF. Also skip contents of source or example blocks
8328 ;; when indentation is meant to be preserved.
8329 (while (not (eobp))
8330 (cond
8331 ((and (org-looking-at-p org-footnote-definition-re)
8332 (let ((e (org-element-at-point)))
8333 (and (eq (org-element-type e) 'footnote-definition)
8334 (goto-char (org-element-property :end e))))))
8335 ((org-looking-at-p org-outline-regexp) (forward-line))
8336 ((org-looking-at-p "[ \t]*$") (forward-line))
8338 (org-indent-line-to (+ (org-get-indentation) diff))
8339 (beginning-of-line)
8340 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8341 (let ((e (org-element-at-point)))
8342 (and (memq (org-element-type e)
8343 '(example-block src-block))
8344 (or org-src-preserve-indentation
8345 (org-element-property :preserve-indent e))
8346 (goto-char (org-element-property :end e))
8347 (progn (skip-chars-backward " \r\t\n")
8348 (beginning-of-line)
8349 t))))
8350 (forward-line)))))))))
8352 (defun org-convert-to-odd-levels ()
8353 "Convert an org-mode file with all levels allowed to one with odd levels.
8354 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8355 level 5 etc."
8356 (interactive)
8357 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8358 (let ((outline-level 'org-outline-level)
8359 (org-odd-levels-only nil) n)
8360 (save-excursion
8361 (goto-char (point-min))
8362 (while (re-search-forward "^\\*\\*+ " nil t)
8363 (setq n (- (length (match-string 0)) 2))
8364 (while (>= (setq n (1- n)) 0)
8365 (org-demote))
8366 (end-of-line 1))))))
8368 (defun org-convert-to-oddeven-levels ()
8369 "Convert an org-mode file with only odd levels to one with odd/even levels.
8370 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8371 file contains a section with an even level, conversion would
8372 destroy the structure of the file. An error is signaled in this
8373 case."
8374 (interactive)
8375 (goto-char (point-min))
8376 ;; First check if there are no even levels
8377 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8378 (org-show-set-visibility 'canonical)
8379 (error "Not all levels are odd in this file. Conversion not possible"))
8380 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8381 (let ((outline-regexp org-outline-regexp)
8382 (outline-level 'org-outline-level)
8383 (org-odd-levels-only nil) n)
8384 (save-excursion
8385 (goto-char (point-min))
8386 (while (re-search-forward "^\\*\\*+ " nil t)
8387 (setq n (/ (1- (length (match-string 0))) 2))
8388 (while (>= (setq n (1- n)) 0)
8389 (org-promote))
8390 (end-of-line 1))))))
8392 (defun org-tr-level (n)
8393 "Make N odd if required."
8394 (if org-odd-levels-only (1+ (/ n 2)) n))
8396 ;;; Vertical tree motion, cutting and pasting of subtrees
8398 (defun org-move-subtree-up (&optional arg)
8399 "Move the current subtree up past ARG headlines of the same level."
8400 (interactive "p")
8401 (org-move-subtree-down (- (prefix-numeric-value arg))))
8403 (defun org-move-subtree-down (&optional arg)
8404 "Move the current subtree down past ARG headlines of the same level."
8405 (interactive "p")
8406 (setq arg (prefix-numeric-value arg))
8407 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8408 'org-get-last-sibling))
8409 (ins-point (make-marker))
8410 (cnt (abs arg))
8411 (col (current-column))
8412 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8413 ;; Select the tree
8414 (org-back-to-heading)
8415 (setq beg0 (point))
8416 (save-excursion
8417 (setq ne-beg (org-back-over-empty-lines))
8418 (setq beg (point)))
8419 (save-match-data
8420 (save-excursion (outline-end-of-heading)
8421 (setq folded (outline-invisible-p)))
8422 (progn (org-end-of-subtree nil t)
8423 (unless (eobp) (backward-char))))
8424 (outline-next-heading)
8425 (setq ne-end (org-back-over-empty-lines))
8426 (setq end (point))
8427 (goto-char beg0)
8428 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8429 ;; include less whitespace
8430 (save-excursion
8431 (goto-char beg)
8432 (forward-line (- ne-beg ne-end))
8433 (setq beg (point))))
8434 ;; Find insertion point, with error handling
8435 (while (> cnt 0)
8436 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8437 (progn (goto-char beg0)
8438 (user-error "Cannot move past superior level or buffer limit")))
8439 (setq cnt (1- cnt)))
8440 (if (> arg 0)
8441 ;; Moving forward - still need to move over subtree
8442 (progn (org-end-of-subtree t t)
8443 (save-excursion
8444 (org-back-over-empty-lines)
8445 (or (bolp) (newline)))))
8446 (setq ne-ins (org-back-over-empty-lines))
8447 (move-marker ins-point (point))
8448 (setq txt (buffer-substring beg end))
8449 (org-save-markers-in-region beg end)
8450 (delete-region beg end)
8451 (org-remove-empty-overlays-at beg)
8452 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8453 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8454 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8455 (let ((bbb (point)))
8456 (insert-before-markers txt)
8457 (org-reinstall-markers-in-region bbb)
8458 (move-marker ins-point bbb))
8459 (or (bolp) (insert "\n"))
8460 (setq ins-end (point))
8461 (goto-char ins-point)
8462 (org-skip-whitespace)
8463 (when (and (< arg 0)
8464 (org-first-sibling-p)
8465 (> ne-ins ne-beg))
8466 ;; Move whitespace back to beginning
8467 (save-excursion
8468 (goto-char ins-end)
8469 (let ((kill-whole-line t))
8470 (kill-line (- ne-ins ne-beg)) (point)))
8471 (insert (make-string (- ne-ins ne-beg) ?\n)))
8472 (move-marker ins-point nil)
8473 (if folded
8474 (outline-hide-subtree)
8475 (org-show-entry)
8476 (outline-show-children)
8477 (org-cycle-hide-drawers 'children))
8478 (org-clean-visibility-after-subtree-move)
8479 ;; move back to the initial column we were at
8480 (move-to-column col)))
8482 (defvar org-subtree-clip ""
8483 "Clipboard for cut and paste of subtrees.
8484 This is actually only a copy of the kill, because we use the normal kill
8485 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8487 (defvar org-subtree-clip-folded nil
8488 "Was the last copied subtree folded?
8489 This is used to fold the tree back after pasting.")
8491 (defun org-cut-subtree (&optional n)
8492 "Cut the current subtree into the clipboard.
8493 With prefix arg N, cut this many sequential subtrees.
8494 This is a short-hand for marking the subtree and then cutting it."
8495 (interactive "p")
8496 (org-copy-subtree n 'cut))
8498 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8499 "Copy the current subtree it in the clipboard.
8500 With prefix arg N, copy this many sequential subtrees.
8501 This is a short-hand for marking the subtree and then copying it.
8502 If CUT is non-nil, actually cut the subtree.
8503 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8504 of some markers in the region, even if CUT is non-nil. This is
8505 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8506 (interactive "p")
8507 (let (beg end folded (beg0 (point)))
8508 (if (org-called-interactively-p 'any)
8509 (org-back-to-heading nil) ; take what looks like a subtree
8510 (org-back-to-heading t)) ; take what is really there
8511 (setq beg (point))
8512 (skip-chars-forward " \t\r\n")
8513 (save-match-data
8514 (if nosubtrees
8515 (outline-next-heading)
8516 (save-excursion (outline-end-of-heading)
8517 (setq folded (outline-invisible-p)))
8518 (ignore-errors (org-forward-heading-same-level (1- n) t))
8519 (org-end-of-subtree t t)))
8520 ;; Include the end of an inlinetask
8521 (when (and (featurep 'org-inlinetask)
8522 (looking-at-p (concat (org-inlinetask-outline-regexp)
8523 "END[ \t]*$")))
8524 (end-of-line))
8525 (setq end (point))
8526 (goto-char beg0)
8527 (when (> end beg)
8528 (setq org-subtree-clip-folded folded)
8529 (when (or cut force-store-markers)
8530 (org-save-markers-in-region beg end))
8531 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8532 (setq org-subtree-clip (current-kill 0))
8533 (message "%s: Subtree(s) with %d characters"
8534 (if cut "Cut" "Copied")
8535 (length org-subtree-clip)))))
8537 (defun org-paste-subtree (&optional level tree for-yank remove)
8538 "Paste the clipboard as a subtree, with modification of headline level.
8539 The entire subtree is promoted or demoted in order to match a new headline
8540 level.
8542 If the cursor is at the beginning of a headline, the same level as
8543 that headline is used to paste the tree.
8545 If not, the new level is derived from the *visible* headings
8546 before and after the insertion point, and taken to be the inferior headline
8547 level of the two. So if the previous visible heading is level 3 and the
8548 next is level 4 (or vice versa), level 4 will be used for insertion.
8549 This makes sure that the subtree remains an independent subtree and does
8550 not swallow low level entries.
8552 You can also force a different level, either by using a numeric prefix
8553 argument, or by inserting the heading marker by hand. For example, if the
8554 cursor is after \"*****\", then the tree will be shifted to level 5.
8556 If optional TREE is given, use this text instead of the kill ring.
8558 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8559 move back over whitespace before inserting, and move point to the end of
8560 the inserted text when done.
8562 When REMOVE is non-nil, remove the subtree from the clipboard."
8563 (interactive "P")
8564 (setq tree (or tree (and kill-ring (current-kill 0))))
8565 (unless (org-kill-is-subtree-p tree)
8566 (user-error "%s"
8567 (substitute-command-keys
8568 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8569 (org-with-limited-levels
8570 (let* ((visp (not (outline-invisible-p)))
8571 (txt tree)
8572 (^re_ "\\(\\*+\\)[ \t]*")
8573 (old-level (if (string-match org-outline-regexp-bol txt)
8574 (- (match-end 0) (match-beginning 0) 1)
8575 -1))
8576 (force-level (cond (level (prefix-numeric-value level))
8577 ((and (looking-at "[ \t]*$")
8578 (string-match
8579 "^\\*+$" (buffer-substring
8580 (point-at-bol) (point))))
8581 (- (match-end 0) (match-beginning 0)))
8582 ((and (bolp)
8583 (looking-at org-outline-regexp))
8584 (- (match-end 0) (point) 1))))
8585 (previous-level (save-excursion
8586 (condition-case nil
8587 (progn
8588 (outline-previous-visible-heading 1)
8589 (if (looking-at ^re_)
8590 (- (match-end 0) (match-beginning 0) 1)
8592 (error 1))))
8593 (next-level (save-excursion
8594 (condition-case nil
8595 (progn
8596 (or (looking-at org-outline-regexp)
8597 (outline-next-visible-heading 1))
8598 (if (looking-at ^re_)
8599 (- (match-end 0) (match-beginning 0) 1)
8601 (error 1))))
8602 (new-level (or force-level (max previous-level next-level)))
8603 (shift (if (or (= old-level -1)
8604 (= new-level -1)
8605 (= old-level new-level))
8607 (- new-level old-level)))
8608 (delta (if (> shift 0) -1 1))
8609 (func (if (> shift 0) 'org-demote 'org-promote))
8610 (org-odd-levels-only nil)
8611 beg end newend)
8612 ;; Remove the forced level indicator
8613 (if force-level
8614 (delete-region (point-at-bol) (point)))
8615 ;; Paste
8616 (beginning-of-line (if (bolp) 1 2))
8617 (setq beg (point))
8618 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8619 (insert-before-markers txt)
8620 (unless (string-match "\n\\'" txt) (insert "\n"))
8621 (setq newend (point))
8622 (org-reinstall-markers-in-region beg)
8623 (setq end (point))
8624 (goto-char beg)
8625 (skip-chars-forward " \t\n\r")
8626 (setq beg (point))
8627 (if (and (outline-invisible-p) visp)
8628 (save-excursion (outline-show-heading)))
8629 ;; Shift if necessary
8630 (unless (= shift 0)
8631 (save-restriction
8632 (narrow-to-region beg end)
8633 (while (not (= shift 0))
8634 (org-map-region func (point-min) (point-max))
8635 (setq shift (+ delta shift)))
8636 (goto-char (point-min))
8637 (setq newend (point-max))))
8638 (when (or (org-called-interactively-p 'interactive) for-yank)
8639 (message "Clipboard pasted as level %d subtree" new-level))
8640 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8641 kill-ring
8642 (eq org-subtree-clip (current-kill 0))
8643 org-subtree-clip-folded)
8644 ;; The tree was folded before it was killed/copied
8645 (outline-hide-subtree))
8646 (and for-yank (goto-char newend))
8647 (and remove (setq kill-ring (cdr kill-ring))))))
8649 (defun org-kill-is-subtree-p (&optional txt)
8650 "Check if the current kill is an outline subtree, or a set of trees.
8651 Returns nil if kill does not start with a headline, or if the first
8652 headline level is not the largest headline level in the tree.
8653 So this will actually accept several entries of equal levels as well,
8654 which is OK for `org-paste-subtree'.
8655 If optional TXT is given, check this string instead of the current kill."
8656 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8657 (re (org-get-limited-outline-regexp))
8658 (^re (concat "^" re))
8659 (start-level (and kill
8660 (string-match
8661 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8662 kill)
8663 (- (match-end 2) (match-beginning 2) 1)))
8664 (start (1+ (or (match-beginning 2) -1))))
8665 (if (not start-level)
8666 (progn
8667 nil) ;; does not even start with a heading
8668 (catch 'exit
8669 (while (setq start (string-match ^re kill (1+ start)))
8670 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8671 (throw 'exit nil)))
8672 t))))
8674 (defvar org-markers-to-move nil
8675 "Markers that should be moved with a cut-and-paste operation.
8676 Those markers are stored together with their positions relative to
8677 the start of the region.")
8679 (defun org-save-markers-in-region (beg end)
8680 "Check markers in region.
8681 If these markers are between BEG and END, record their position relative
8682 to BEG, so that after moving the block of text, we can put the markers back
8683 into place.
8684 This function gets called just before an entry or tree gets cut from the
8685 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8686 called immediately, to move the markers with the entries."
8687 (setq org-markers-to-move nil)
8688 (when (featurep 'org-clock)
8689 (org-clock-save-markers-for-cut-and-paste beg end))
8690 (when (featurep 'org-agenda)
8691 (org-agenda-save-markers-for-cut-and-paste beg end)))
8693 (defun org-check-and-save-marker (marker beg end)
8694 "Check if MARKER is between BEG and END.
8695 If yes, remember the marker and the distance to BEG."
8696 (when (and (marker-buffer marker)
8697 (equal (marker-buffer marker) (current-buffer)))
8698 (if (and (>= marker beg) (< marker end))
8699 (push (cons marker (- marker beg)) org-markers-to-move))))
8701 (defun org-reinstall-markers-in-region (beg)
8702 "Move all remembered markers to their position relative to BEG."
8703 (mapc (lambda (x)
8704 (move-marker (car x) (+ beg (cdr x))))
8705 org-markers-to-move)
8706 (setq org-markers-to-move nil))
8708 (defun org-narrow-to-subtree ()
8709 "Narrow buffer to the current subtree."
8710 (interactive)
8711 (save-excursion
8712 (save-match-data
8713 (org-with-limited-levels
8714 (narrow-to-region
8715 (progn (org-back-to-heading t) (point))
8716 (progn (org-end-of-subtree t t)
8717 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8718 (point)))))))
8720 (defun org-narrow-to-block ()
8721 "Narrow buffer to the current block."
8722 (interactive)
8723 (let* ((case-fold-search t)
8724 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8725 "^[ \t]*#\\+end_.*")))
8726 (if blockp
8727 (narrow-to-region (car blockp) (cdr blockp))
8728 (user-error "Not in a block"))))
8730 (defun org-clone-subtree-with-time-shift (n &optional shift)
8731 "Clone the task (subtree) at point N times.
8732 The clones will be inserted as siblings.
8734 In interactive use, the user will be prompted for the number of
8735 clones to be produced. If the entry has a timestamp, the user
8736 will also be prompted for a time shift, which may be a repeater
8737 as used in time stamps, for example `+3d'. To disable this,
8738 you can call the function with a universal prefix argument.
8740 When a valid repeater is given and the entry contains any time
8741 stamps, the clones will become a sequence in time, with time
8742 stamps in the subtree shifted for each clone produced. If SHIFT
8743 is nil or the empty string, time stamps will be left alone. The
8744 ID property of the original subtree is removed.
8746 If the original subtree did contain time stamps with a repeater,
8747 the following will happen:
8748 - the repeater will be removed in each clone
8749 - an additional clone will be produced, with the current, unshifted
8750 date(s) in the entry.
8751 - the original entry will be placed *after* all the clones, with
8752 repeater intact.
8753 - the start days in the repeater in the original entry will be shifted
8754 to past the last clone.
8755 In this way you can spell out a number of instances of a repeating task,
8756 and still retain the repeater to cover future instances of the task.
8758 As described above, N+1 clones are produced when the original
8759 subtree has a repeater. Setting N to 0, then, can be used to
8760 remove the repeater from a subtree and create a shifted clone
8761 with the original repeater."
8762 (interactive "nNumber of clones to produce: ")
8763 (let ((shift
8764 (or shift
8765 (if (and (not (equal current-prefix-arg '(4)))
8766 (save-excursion
8767 (re-search-forward org-ts-regexp-both
8768 (save-excursion
8769 (org-end-of-subtree t)
8770 (point)) t)))
8771 (read-from-minibuffer
8772 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8773 ""))) ;; No time shift
8774 (n-no-remove -1)
8775 (drawer-re org-drawer-regexp)
8776 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8777 beg end template task idprop
8778 shift-n shift-what doshift nmin nmax)
8779 (unless (wholenump n)
8780 (user-error "Invalid number of replications %s" n))
8781 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8782 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8783 shift)))
8784 (user-error "Invalid shift specification %s" shift))
8785 (when doshift
8786 (setq shift-n (string-to-number (match-string 1 shift))
8787 shift-what (cdr (assoc (match-string 2 shift)
8788 '(("d" . day) ("w" . week)
8789 ("m" . month) ("y" . year))))))
8790 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8791 (setq nmin 1 nmax n)
8792 (org-back-to-heading t)
8793 (setq beg (point))
8794 (setq idprop (org-entry-get nil "ID"))
8795 (org-end-of-subtree t t)
8796 (or (bolp) (insert "\n"))
8797 (setq end (point))
8798 (setq template (buffer-substring beg end))
8799 (when (and doshift
8800 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8801 (delete-region beg end)
8802 (setq end beg)
8803 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8804 (goto-char end)
8805 (loop for n from nmin to nmax do
8806 ;; prepare clone
8807 (with-temp-buffer
8808 (insert template)
8809 (org-mode)
8810 (goto-char (point-min))
8811 (org-show-subtree)
8812 (and idprop (if org-clone-delete-id
8813 (org-entry-delete nil "ID")
8814 (org-id-get-create t)))
8815 (unless (= n 0)
8816 (while (re-search-forward org-clock-re nil t)
8817 (kill-whole-line))
8818 (goto-char (point-min))
8819 (while (re-search-forward drawer-re nil t)
8820 (org-remove-empty-drawer-at (point))))
8821 (goto-char (point-min))
8822 (when doshift
8823 (while (re-search-forward org-ts-regexp-both nil t)
8824 (org-timestamp-change (* n shift-n) shift-what))
8825 (unless (= n n-no-remove)
8826 (goto-char (point-min))
8827 (while (re-search-forward org-ts-regexp nil t)
8828 (save-excursion
8829 (goto-char (match-beginning 0))
8830 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8831 (delete-region (match-beginning 1) (match-end 1)))))))
8832 (setq task (buffer-string)))
8833 (insert task))
8834 (goto-char beg)))
8836 ;;; Outline Sorting
8838 (defun org-sort (with-case)
8839 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8840 Optional argument WITH-CASE means sort case-sensitively."
8841 (interactive "P")
8842 (cond
8843 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8844 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8846 (org-call-with-arg 'org-sort-entries with-case))))
8848 (defun org-sort-remove-invisible (s)
8849 "Remove invisible links from string S."
8850 (remove-text-properties 0 (length s) org-rm-props s)
8851 (while (string-match org-bracket-link-regexp s)
8852 (setq s (replace-match (if (match-end 2)
8853 (match-string 3 s)
8854 (match-string 1 s))
8855 t t s)))
8856 (let ((st (format " %s " s)))
8857 (while (string-match org-emph-re st)
8858 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8859 (setq s (substring st 1 -1)))
8862 (defvar org-priority-regexp) ; defined later in the file
8864 (defvar org-after-sorting-entries-or-items-hook nil
8865 "Hook that is run after a bunch of entries or items have been sorted.
8866 When children are sorted, the cursor is in the parent line when this
8867 hook gets called. When a region or a plain list is sorted, the cursor
8868 will be in the first entry of the sorted region/list.")
8870 (defun org-sort-entries
8871 (&optional with-case sorting-type getkey-func compare-func property)
8872 "Sort entries on a certain level of an outline tree.
8873 If there is an active region, the entries in the region are sorted.
8874 Else, if the cursor is before the first entry, sort the top-level items.
8875 Else, the children of the entry at point are sorted.
8877 Sorting can be alphabetically, numerically, by date/time as given by
8878 a time stamp, by a property, by priority order, or by a custom function.
8880 The command prompts for the sorting type unless it has been given to the
8881 function through the SORTING-TYPE argument, which needs to be a character,
8882 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8883 the precise meaning of each character:
8885 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8886 c By creation time, which is assumed to be the first inactive time stamp
8887 at the beginning of a line.
8888 d By deadline date/time.
8889 k By clocking time.
8890 n Numerically, by converting the beginning of the entry/item to a number.
8891 o By order of TODO keywords.
8892 p By priority according to the cookie.
8893 r By the value of a property.
8894 s By scheduled date/time.
8895 t By date/time, either the first active time stamp in the entry, or, if
8896 none exist, by the first inactive one.
8898 Capital letters will reverse the sort order.
8900 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8901 called with point at the beginning of the record. It must return either
8902 a string or a number that should serve as the sorting key for that record.
8904 Comparing entries ignores case by default. However, with an optional argument
8905 WITH-CASE, the sorting considers case as well.
8907 Sorting is done against the visible part of the headlines, it ignores hidden
8908 links.
8910 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8911 (interactive "P")
8912 (let ((case-func (if with-case 'identity 'downcase))
8913 (cmstr
8914 ;; The clock marker is lost when using `sort-subr', let's
8915 ;; store the clocking string.
8916 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8917 (save-excursion
8918 (goto-char org-clock-marker)
8919 (buffer-substring-no-properties (line-beginning-position)
8920 (point)))))
8921 start beg end stars re re2
8922 txt what tmp)
8923 ;; Find beginning and end of region to sort
8924 (cond
8925 ((org-region-active-p)
8926 ;; we will sort the region
8927 (setq end (region-end)
8928 what "region")
8929 (goto-char (region-beginning))
8930 (if (not (org-at-heading-p)) (outline-next-heading))
8931 (setq start (point)))
8932 ((or (org-at-heading-p)
8933 (ignore-errors (progn (org-back-to-heading) t)))
8934 ;; we will sort the children of the current headline
8935 (org-back-to-heading)
8936 (setq start (point)
8937 end (progn (org-end-of-subtree t t)
8938 (or (bolp) (insert "\n"))
8939 (when (>= (org-back-over-empty-lines) 1)
8940 (forward-line 1))
8941 (point))
8942 what "children")
8943 (goto-char start)
8944 (outline-show-subtree)
8945 (outline-next-heading))
8947 ;; we will sort the top-level entries in this file
8948 (goto-char (point-min))
8949 (or (org-at-heading-p) (outline-next-heading))
8950 (setq start (point))
8951 (goto-char (point-max))
8952 (beginning-of-line 1)
8953 (when (looking-at ".*?\\S-")
8954 ;; File ends in a non-white line
8955 (end-of-line 1)
8956 (insert "\n"))
8957 (setq end (point-max))
8958 (setq what "top-level")
8959 (goto-char start)
8960 (outline-show-all)))
8962 (setq beg (point))
8963 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8965 (looking-at "\\(\\*+\\)")
8966 (setq stars (match-string 1)
8967 re (concat "^" (regexp-quote stars) " +")
8968 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8969 txt (buffer-substring beg end))
8970 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8971 (if (and (not (equal stars "*")) (string-match re2 txt))
8972 (user-error "Region to sort contains a level above the first entry"))
8974 (unless sorting-type
8975 (message
8976 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8977 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8978 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8979 what)
8980 (setq sorting-type (read-char-exclusive))
8982 (unless getkey-func
8983 (and (= (downcase sorting-type) ?f)
8984 (setq getkey-func
8985 (org-icompleting-read "Sort using function: "
8986 obarray 'fboundp t nil nil))
8987 (setq getkey-func (intern getkey-func))))
8989 (and (= (downcase sorting-type) ?r)
8990 (not property)
8991 (setq property
8992 (org-icompleting-read "Property: "
8993 (mapcar 'list (org-buffer-property-keys t))
8994 nil t))))
8996 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8997 (message "Sorting entries...")
8999 (save-restriction
9000 (narrow-to-region start end)
9001 (let ((dcst (downcase sorting-type))
9002 (case-fold-search nil)
9003 (now (current-time)))
9004 (sort-subr
9005 (/= dcst sorting-type)
9006 ;; This function moves to the beginning character of the "record" to
9007 ;; be sorted.
9008 (lambda nil
9009 (if (re-search-forward re nil t)
9010 (goto-char (match-beginning 0))
9011 (goto-char (point-max))))
9012 ;; This function moves to the last character of the "record" being
9013 ;; sorted.
9014 (lambda nil
9015 (save-match-data
9016 (condition-case nil
9017 (outline-forward-same-level 1)
9018 (error
9019 (goto-char (point-max))))))
9020 ;; This function returns the value that gets sorted against.
9021 (lambda nil
9022 (cond
9023 ((= dcst ?n)
9024 (if (looking-at org-complex-heading-regexp)
9025 (string-to-number (org-sort-remove-invisible (match-string 4)))
9026 nil))
9027 ((= dcst ?a)
9028 (if (looking-at org-complex-heading-regexp)
9029 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9030 nil))
9031 ((= dcst ?k)
9032 (or (get-text-property (point) :org-clock-minutes) 0))
9033 ((= dcst ?t)
9034 (let ((end (save-excursion (outline-next-heading) (point))))
9035 (if (or (re-search-forward org-ts-regexp end t)
9036 (re-search-forward org-ts-regexp-both end t))
9037 (org-time-string-to-seconds (match-string 0))
9038 (org-float-time now))))
9039 ((= dcst ?c)
9040 (let ((end (save-excursion (outline-next-heading) (point))))
9041 (if (re-search-forward
9042 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9043 end t)
9044 (org-time-string-to-seconds (match-string 0))
9045 (org-float-time now))))
9046 ((= dcst ?s)
9047 (let ((end (save-excursion (outline-next-heading) (point))))
9048 (if (re-search-forward org-scheduled-time-regexp end t)
9049 (org-time-string-to-seconds (match-string 1))
9050 (org-float-time now))))
9051 ((= dcst ?d)
9052 (let ((end (save-excursion (outline-next-heading) (point))))
9053 (if (re-search-forward org-deadline-time-regexp end t)
9054 (org-time-string-to-seconds (match-string 1))
9055 (org-float-time now))))
9056 ((= dcst ?p)
9057 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9058 (string-to-char (match-string 2))
9059 org-default-priority))
9060 ((= dcst ?r)
9061 (or (org-entry-get nil property) ""))
9062 ((= dcst ?o)
9063 (if (looking-at org-complex-heading-regexp)
9064 (let* ((m (match-string 2))
9065 (s (if (member m org-done-keywords) '- '+)))
9066 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9067 ((= dcst ?f)
9068 (if getkey-func
9069 (progn
9070 (setq tmp (funcall getkey-func))
9071 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9072 tmp)
9073 (error "Invalid key function `%s'" getkey-func)))
9074 (t (error "Invalid sorting type `%c'" sorting-type))))
9076 (cond
9077 ((= dcst ?a) 'string<)
9078 ((= dcst ?f) compare-func)
9079 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9080 (run-hooks 'org-after-sorting-entries-or-items-hook)
9081 ;; Reset the clock marker if needed
9082 (when cmstr
9083 (save-excursion
9084 (goto-char start)
9085 (search-forward cmstr nil t)
9086 (move-marker org-clock-marker (point))))
9087 (message "Sorting entries...done")))
9089 ;;; The orgstruct minor mode
9091 ;; Define a minor mode which can be used in other modes in order to
9092 ;; integrate the org-mode structure editing commands.
9094 ;; This is really a hack, because the org-mode structure commands use
9095 ;; keys which normally belong to the major mode. Here is how it
9096 ;; works: The minor mode defines all the keys necessary to operate the
9097 ;; structure commands, but wraps the commands into a function which
9098 ;; tests if the cursor is currently at a headline or a plain list
9099 ;; item. If that is the case, the structure command is used,
9100 ;; temporarily setting many Org-mode variables like regular
9101 ;; expressions for filling etc. However, when any of those keys is
9102 ;; used at a different location, function uses `key-binding' to look
9103 ;; up if the key has an associated command in another currently active
9104 ;; keymap (minor modes, major mode, global), and executes that
9105 ;; command. There might be problems if any of the keys is otherwise
9106 ;; used as a prefix key.
9108 (defcustom orgstruct-heading-prefix-regexp ""
9109 "Regexp that matches the custom prefix of Org headlines in
9110 orgstruct(++)-mode."
9111 :group 'org
9112 :version "24.4"
9113 :package-version '(Org . "8.3")
9114 :type 'regexp)
9115 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9117 (defcustom orgstruct-setup-hook nil
9118 "Hook run after orgstruct-mode-map is filled."
9119 :group 'org
9120 :version "24.4"
9121 :package-version '(Org . "8.0")
9122 :type 'hook)
9124 (defvar orgstruct-initialized nil)
9126 (defvar org-local-vars nil
9127 "List of local variables, for use by `orgstruct-mode'.")
9129 ;;;###autoload
9130 (define-minor-mode orgstruct-mode
9131 "Toggle the minor mode `orgstruct-mode'.
9132 This mode is for using Org-mode structure commands in other
9133 modes. The following keys behave as if Org-mode were active, if
9134 the cursor is on a headline, or on a plain list item (both as
9135 defined by Org-mode)."
9136 nil " OrgStruct" (make-sparse-keymap)
9137 (funcall (if orgstruct-mode
9138 'add-to-invisibility-spec
9139 'remove-from-invisibility-spec)
9140 '(outline . t))
9141 (when orgstruct-mode
9142 (org-load-modules-maybe)
9143 (unless orgstruct-initialized
9144 (orgstruct-setup)
9145 (setq orgstruct-initialized t))))
9147 ;;;###autoload
9148 (defun turn-on-orgstruct ()
9149 "Unconditionally turn on `orgstruct-mode'."
9150 (orgstruct-mode 1))
9152 (defvar org-fb-vars nil)
9153 (make-variable-buffer-local 'org-fb-vars)
9154 (defun orgstruct++-mode (&optional arg)
9155 "Toggle `orgstruct-mode', the enhanced version of it.
9156 In addition to setting orgstruct-mode, this also exports all
9157 indentation and autofilling variables from org-mode into the
9158 buffer. It will also recognize item context in multiline items."
9159 (interactive "P")
9160 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9161 (if (< arg 1)
9162 (progn (orgstruct-mode -1)
9163 (mapc (lambda(v)
9164 (org-set-local (car v)
9165 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9166 org-fb-vars))
9167 (orgstruct-mode 1)
9168 (setq org-fb-vars nil)
9169 (unless org-local-vars
9170 (setq org-local-vars (org-get-local-variables)))
9171 (let (var val)
9172 (mapc
9173 (lambda (x)
9174 (when (string-match
9175 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9176 (symbol-name (car x)))
9177 (setq var (car x) val (nth 1 x))
9178 (push (list var `(quote ,(eval var))) org-fb-vars)
9179 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9180 org-local-vars)
9181 (org-set-local 'orgstruct-is-++ t))))
9183 (defvar orgstruct-is-++ nil
9184 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9185 (make-variable-buffer-local 'orgstruct-is-++)
9187 ;;;###autoload
9188 (defun turn-on-orgstruct++ ()
9189 "Unconditionally turn on `orgstruct++-mode'."
9190 (orgstruct++-mode 1))
9192 (defun orgstruct-error ()
9193 "Error when there is no default binding for a structure key."
9194 (interactive)
9195 (funcall (if (fboundp 'user-error)
9196 'user-error
9197 'error)
9198 "This key has no function outside structure elements"))
9200 (defun orgstruct-setup ()
9201 "Setup orgstruct keymap."
9202 (dolist (cell '((org-demote . t)
9203 (org-metaleft . t)
9204 (org-metaright . t)
9205 (org-promote . t)
9206 (org-shiftmetaleft . t)
9207 (org-shiftmetaright . t)
9208 org-backward-element
9209 org-backward-heading-same-level
9210 org-ctrl-c-ret
9211 org-ctrl-c-minus
9212 org-ctrl-c-star
9213 org-cycle
9214 org-forward-heading-same-level
9215 org-insert-heading
9216 org-insert-heading-respect-content
9217 org-kill-note-or-show-branches
9218 org-mark-subtree
9219 org-meta-return
9220 org-metadown
9221 org-metaup
9222 org-narrow-to-subtree
9223 org-promote-subtree
9224 org-reveal
9225 org-shiftdown
9226 org-shiftleft
9227 org-shiftmetadown
9228 org-shiftmetaup
9229 org-shiftright
9230 org-shifttab
9231 org-shifttab
9232 org-shiftup
9233 org-show-subtree
9234 org-sort
9235 org-up-element
9236 outline-demote
9237 outline-next-visible-heading
9238 outline-previous-visible-heading
9239 outline-promote
9240 outline-up-heading
9241 outline-show-children))
9242 (let ((f (or (car-safe cell) cell))
9243 (disable-when-heading-prefix (cdr-safe cell)))
9244 (when (fboundp f)
9245 (let ((new-bindings))
9246 (dolist (binding (nconc (where-is-internal f org-mode-map)
9247 (where-is-internal f outline-mode-map)))
9248 (push binding new-bindings)
9249 ;; TODO use local-function-key-map
9250 (dolist (rep '(("<tab>" . "TAB")
9251 ("<return>" . "RET")
9252 ("<escape>" . "ESC")
9253 ("<delete>" . "DEL")))
9254 (setq binding (read-kbd-macro
9255 (let ((case-fold-search))
9256 (replace-regexp-in-string
9257 (regexp-quote (cdr rep))
9258 (car rep)
9259 (key-description binding)))))
9260 (pushnew binding new-bindings :test 'equal)))
9261 (dolist (binding new-bindings)
9262 (let ((key (lookup-key orgstruct-mode-map binding)))
9263 (when (or (not key) (numberp key))
9264 (ignore-errors
9265 (org-defkey orgstruct-mode-map
9266 binding
9267 (orgstruct-make-binding
9268 f binding disable-when-heading-prefix))))))))))
9269 (run-hooks 'orgstruct-setup-hook))
9271 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9272 "Create a function for binding in the structure minor mode.
9273 FUN is the command to call inside a table. KEY is the key that
9274 should be checked in for a command to execute outside of tables.
9275 Non-nil `disable-when-heading-prefix' means to disable the command
9276 if `orgstruct-heading-prefix-regexp' is not empty."
9277 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9278 (let ((nname name)
9279 (i 0))
9280 (while (fboundp (intern nname))
9281 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9282 (setq name (intern nname)))
9283 (eval
9284 (let ((bindings '((org-heading-regexp
9285 (concat "^"
9286 orgstruct-heading-prefix-regexp
9287 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9288 (org-outline-regexp
9289 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9290 (org-outline-regexp-bol
9291 (concat "^" org-outline-regexp))
9292 (outline-regexp org-outline-regexp)
9293 (outline-heading-end-regexp "\n")
9294 (outline-level 'org-outline-level)
9295 (outline-heading-alist))))
9296 `(defun ,name (arg)
9297 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9298 "Outside of structure, run the binding of `"
9299 (key-description key) "'."
9300 (when disable-when-heading-prefix
9301 (concat
9302 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9303 "back to the default binding due to limitations of Org's implementation of\n"
9304 "`" (symbol-name fun) "'.")))
9305 (interactive "p")
9306 (let* ((disable
9307 ,(and disable-when-heading-prefix
9308 '(not (string= orgstruct-heading-prefix-regexp ""))))
9309 (fallback
9310 (or disable
9311 (not
9312 (let* ,bindings
9313 (org-context-p 'headline 'item
9314 ,(when (memq fun
9315 '(org-insert-heading
9316 org-insert-heading-respect-content
9317 org-meta-return))
9318 '(when orgstruct-is-++
9319 'item-body))))))))
9320 (if fallback
9321 (let* ((orgstruct-mode)
9322 (binding
9323 (let ((key ,key))
9324 (catch 'exit
9325 (dolist
9326 (rep
9327 '(nil
9328 ("<\\([^>]*\\)tab>" . "\\1TAB")
9329 ("<\\([^>]*\\)return>" . "\\1RET")
9330 ("<\\([^>]*\\)escape>" . "\\1ESC")
9331 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9332 nil)
9333 (when rep
9334 (setq key (read-kbd-macro
9335 (let ((case-fold-search))
9336 (replace-regexp-in-string
9337 (car rep)
9338 (cdr rep)
9339 (key-description key))))))
9340 (when (key-binding key)
9341 (throw 'exit (key-binding key))))))))
9342 (if (keymapp binding)
9343 (org-set-transient-map binding)
9344 (let ((func (or binding
9345 (unless disable
9346 'orgstruct-error))))
9347 (when func
9348 (call-interactively func)))))
9349 (org-run-like-in-org-mode
9350 (lambda ()
9351 (interactive)
9352 (let* ,bindings
9353 (call-interactively ',fun)))))))))
9354 name))
9356 (defun org-contextualize-keys (alist contexts)
9357 "Return valid elements in ALIST depending on CONTEXTS.
9359 `org-agenda-custom-commands' or `org-capture-templates' are the
9360 values used for ALIST, and `org-agenda-custom-commands-contexts'
9361 or `org-capture-templates-contexts' are the associated contexts
9362 definitions."
9363 (let ((contexts
9364 ;; normalize contexts
9365 (mapcar
9366 (lambda(c) (cond ((listp (cadr c))
9367 (list (car c) (car c) (cadr c)))
9368 ((string= "" (cadr c))
9369 (list (car c) (car c) (caddr c)))
9370 (t c)))
9371 contexts))
9372 (a alist) r s)
9373 ;; loop over all commands or templates
9374 (dolist (c a)
9375 (let (vrules repl)
9376 (cond
9377 ((not (assoc (car c) contexts))
9378 (push c r))
9379 ((and (assoc (car c) contexts)
9380 (setq vrules (org-contextualize-validate-key
9381 (car c) contexts)))
9382 (mapc (lambda (vr)
9383 (when (not (equal (car vr) (cadr vr)))
9384 (setq repl vr)))
9385 vrules)
9386 (if (not repl) (push c r)
9387 (push (cadr repl) s)
9388 (push
9389 (cons (car c)
9390 (cdr (or (assoc (cadr repl) alist)
9391 (error "Undefined key `%s' as contextual replacement for `%s'"
9392 (cadr repl) (car c)))))
9393 r))))))
9394 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9395 (delq
9397 (delete-dups
9398 (mapcar (lambda (x)
9399 (let ((tpl (car x)))
9400 (when (not (delq
9402 (mapcar (lambda (y)
9403 (equal y tpl))
9404 s)))
9405 x)))
9406 (reverse r))))))
9408 (defun org-contextualize-validate-key (key contexts)
9409 "Check CONTEXTS for agenda or capture KEY."
9410 (let (rr res)
9411 (dolist (r contexts)
9412 (mapc
9413 (lambda (rr)
9414 (when
9415 (and (equal key (car r))
9416 (if (functionp rr) (funcall rr)
9417 (or (and (eq (car rr) 'in-file)
9418 (buffer-file-name)
9419 (string-match (cdr rr) (buffer-file-name)))
9420 (and (eq (car rr) 'in-mode)
9421 (string-match (cdr rr) (symbol-name major-mode)))
9422 (and (eq (car rr) 'in-buffer)
9423 (string-match (cdr rr) (buffer-name)))
9424 (when (and (eq (car rr) 'not-in-file)
9425 (buffer-file-name))
9426 (not (string-match (cdr rr) (buffer-file-name))))
9427 (when (eq (car rr) 'not-in-mode)
9428 (not (string-match (cdr rr) (symbol-name major-mode))))
9429 (when (eq (car rr) 'not-in-buffer)
9430 (not (string-match (cdr rr) (buffer-name)))))))
9431 (push r res)))
9432 (car (last r))))
9433 (delete-dups (delq nil res))))
9435 (defun org-context-p (&rest contexts)
9436 "Check if local context is any of CONTEXTS.
9437 Possible values in the list of contexts are `table', `headline', and `item'."
9438 (let ((pos (point)))
9439 (goto-char (point-at-bol))
9440 (prog1 (or (and (memq 'table contexts)
9441 (looking-at "[ \t]*|"))
9442 (and (memq 'headline contexts)
9443 (looking-at org-outline-regexp))
9444 (and (memq 'item contexts)
9445 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9446 (and (memq 'item-body contexts)
9447 (org-in-item-p)))
9448 (goto-char pos))))
9450 (defun org-get-local-variables ()
9451 "Return a list of all local variables in an Org mode buffer."
9452 (let (varlist)
9453 (with-current-buffer (get-buffer-create "*Org tmp*")
9454 (erase-buffer)
9455 (org-mode)
9456 (setq varlist (buffer-local-variables)))
9457 (kill-buffer "*Org tmp*")
9458 (delq nil
9459 (mapcar
9460 (lambda (x)
9461 (setq x
9462 (if (symbolp x)
9463 (list x)
9464 (list (car x) (cdr x))))
9465 (if (and (not (get (car x) 'org-state))
9466 (string-match
9467 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9468 (symbol-name (car x))))
9469 x nil))
9470 varlist))))
9472 (defun org-clone-local-variables (from-buffer &optional regexp)
9473 "Clone local variables from FROM-BUFFER.
9474 Optional argument REGEXP selects variables to clone."
9475 (mapc
9476 (lambda (pair)
9477 (and (symbolp (car pair))
9478 (or (null regexp)
9479 (string-match regexp (symbol-name (car pair))))
9480 (set (make-local-variable (car pair))
9481 (cdr pair))))
9482 (buffer-local-variables from-buffer)))
9484 ;;;###autoload
9485 (defun org-run-like-in-org-mode (cmd)
9486 "Run a command, pretending that the current buffer is in Org-mode.
9487 This will temporarily bind local variables that are typically bound in
9488 Org-mode to the values they have in Org-mode, and then interactively
9489 call CMD."
9490 (org-load-modules-maybe)
9491 (unless org-local-vars
9492 (setq org-local-vars (org-get-local-variables)))
9493 (let (binds)
9494 (dolist (var org-local-vars)
9495 (when (or (not (boundp (car var)))
9496 (eq (symbol-value (car var))
9497 (default-value (car var))))
9498 (push (list (car var) `(quote ,(cadr var))) binds)))
9499 (eval `(let ,binds
9500 (call-interactively (quote ,cmd))))))
9502 (defun org-get-category (&optional pos force-refresh)
9503 "Get the category applying to position POS."
9504 (save-match-data
9505 (if force-refresh (org-refresh-category-properties))
9506 (let ((pos (or pos (point))))
9507 (or (get-text-property pos 'org-category)
9508 (progn (org-refresh-category-properties)
9509 (get-text-property pos 'org-category))))))
9511 ;;; Refresh properties
9513 (defun org-refresh-properties (dprop tprop)
9514 "Refresh buffer text properties.
9515 DPROP is the drawer property and TPROP is either the
9516 corresponding text property to set, or an alist with each element
9517 being a text property (as a symbol) and a function to apply to
9518 the value of the drawer property."
9519 (let ((case-fold-search t)
9520 (inhibit-read-only t))
9521 (org-with-silent-modifications
9522 (save-excursion
9523 (save-restriction
9524 (widen)
9525 (goto-char (point-min))
9526 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9527 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9529 (defun org-refresh-property (tprop p)
9530 "Refresh the buffer text property TPROP from the drawer property P.
9531 The refresh happens only for the current tree (not subtree)."
9532 (unless (org-before-first-heading-p)
9533 (save-excursion
9534 (org-back-to-heading t)
9535 (if (symbolp tprop)
9536 ;; TPROP is a text property symbol
9537 (put-text-property
9538 (point) (or (outline-next-heading) (point-max)) tprop p)
9539 ;; TPROP is an alist with (properties . function) elements
9540 (dolist (al tprop)
9541 (save-excursion
9542 (put-text-property
9543 (line-beginning-position) (or (outline-next-heading) (point-max))
9544 (car al)
9545 (funcall (cdr al) p))))))))
9547 (defun org-refresh-category-properties ()
9548 "Refresh category text properties in the buffer."
9549 (let ((case-fold-search t)
9550 (inhibit-read-only t)
9551 (default-category
9552 (cond ((null org-category)
9553 (if buffer-file-name
9554 (file-name-sans-extension
9555 (file-name-nondirectory buffer-file-name))
9556 "???"))
9557 ((symbolp org-category) (symbol-name org-category))
9558 (t org-category))))
9559 (org-with-silent-modifications
9560 (org-with-wide-buffer
9561 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9562 ;; This is the default category for the buffer. If none is
9563 ;; found, fall-back to `org-category' or buffer file name.
9564 (put-text-property
9565 (point-min) (point-max)
9566 'org-category
9567 (catch 'buffer-category
9568 (goto-char (point-max))
9569 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9570 (let ((element (org-element-at-point)))
9571 (when (eq (org-element-type element) 'keyword)
9572 (throw 'buffer-category
9573 (org-element-property :value element)))))
9574 default-category))
9575 ;; Set sub-tree specific categories.
9576 (goto-char (point-min))
9577 (let ((regexp (org-re-property "CATEGORY")))
9578 (while (re-search-forward regexp nil t)
9579 (let ((value (org-match-string-no-properties 3)))
9580 (when (org-at-property-p)
9581 (put-text-property
9582 (save-excursion (org-back-to-heading t) (point))
9583 (save-excursion (org-end-of-subtree t t) (point))
9584 'org-category
9585 value)))))))))
9587 (defun org-refresh-stats-properties ()
9588 "Refresh stats text properties in the buffer."
9589 (let (stats)
9590 (org-with-silent-modifications
9591 (save-excursion
9592 (save-restriction
9593 (widen)
9594 (goto-char (point-min))
9595 (while (re-search-forward
9596 (concat org-outline-regexp-bol ".*"
9597 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9598 nil t)
9599 (setq stats (cond ((equal (match-string 3) "0") 0)
9600 ((match-string 2)
9601 (/ (* (string-to-number (match-string 2)) 100)
9602 (string-to-number (match-string 3))))
9603 (t (string-to-number (match-string 1)))))
9604 (org-back-to-heading t)
9605 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9606 'org-stats stats)))))))
9608 (defun org-refresh-effort-properties ()
9609 "Refresh effort properties"
9610 (org-refresh-properties
9611 org-effort-property
9612 '((effort . identity)
9613 (effort-minutes . org-duration-string-to-minutes))))
9615 ;;;; Link Stuff
9617 ;;; Link abbreviations
9619 (defun org-link-expand-abbrev (link)
9620 "Apply replacements as defined in `org-link-abbrev-alist'."
9621 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9622 (let* ((key (match-string 1 link))
9623 (as (or (assoc key org-link-abbrev-alist-local)
9624 (assoc key org-link-abbrev-alist)))
9625 (tag (and (match-end 2) (match-string 3 link)))
9626 rpl)
9627 (if (not as)
9628 link
9629 (setq rpl (cdr as))
9630 (cond
9631 ((symbolp rpl) (funcall rpl tag))
9632 ((string-match "%(\\([^)]+\\))" rpl)
9633 (replace-match
9634 (save-match-data
9635 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9636 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9637 ((string-match "%h" rpl)
9638 (replace-match (url-hexify-string (or tag "")) t t rpl))
9639 (t (concat rpl tag)))))
9640 link))
9642 ;;; Storing and inserting links
9644 (defvar org-insert-link-history nil
9645 "Minibuffer history for links inserted with `org-insert-link'.")
9647 (defvar org-stored-links nil
9648 "Contains the links stored with `org-store-link'.")
9650 (defvar org-store-link-plist nil
9651 "Plist with info about the most recently link created with `org-store-link'.")
9653 (defvar org-link-protocols nil
9654 "Link protocols added to Org-mode using `org-add-link-type'.")
9656 (defvar org-store-link-functions nil
9657 "List of functions that are called to create and store a link.
9658 Each function will be called in turn until one returns a non-nil
9659 value. Each function should check if it is responsible for creating
9660 this link (for example by looking at the major mode).
9661 If not, it must exit and return nil.
9662 If yes, it should return a non-nil value after a calling
9663 `org-store-link-props' with a list of properties and values.
9664 Special properties are:
9666 :type The link prefix, like \"http\". This must be given.
9667 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9668 This is obligatory as well.
9669 :description Optional default description for the second pair
9670 of brackets in an Org-mode link. The user can still change
9671 this when inserting this link into an Org-mode buffer.
9673 In addition to these, any additional properties can be specified
9674 and then used in capture templates.")
9676 (defun org-add-link-type (type &optional follow export)
9677 "Add TYPE to the list of `org-link-types'.
9678 Re-compute all regular expressions depending on `org-link-types'
9680 FOLLOW and EXPORT are two functions.
9682 FOLLOW should take the link path as the single argument and do whatever
9683 is necessary to follow the link, for example find a file or display
9684 a mail message.
9686 EXPORT should format the link path for export to one of the export formats.
9687 It should be a function accepting three arguments:
9689 path the path of the link, the text after the prefix (like \"http:\")
9690 desc the description of the link, if any
9691 format the export format, a symbol like `html' or `latex' or `ascii'.
9693 The function may use the FORMAT information to return different values
9694 depending on the format. The return value will be put literally into
9695 the exported file. If the return value is nil, this means Org should
9696 do what it normally does with links which do not have EXPORT defined.
9698 Org mode has a built-in default for exporting links. If you are happy with
9699 this default, there is no need to define an export function for the link
9700 type. For a simple example of an export function, see `org-bbdb.el'."
9701 (add-to-list 'org-link-types type t)
9702 (org-make-link-regexps)
9703 (org-element-update-syntax)
9704 (if (assoc type org-link-protocols)
9705 (setcdr (assoc type org-link-protocols) (list follow export))
9706 (push (list type follow export) org-link-protocols)))
9708 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9709 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9711 ;;;###autoload
9712 (defun org-store-link (arg)
9713 "\\<org-mode-map>Store an org-link to the current location.
9714 This link is added to `org-stored-links' and can later be inserted
9715 into an Org buffer with \\[org-insert-link].
9717 For some link types, a prefix ARG is interpreted.
9718 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9719 For file links, ARG negates `org-context-in-file-links'.
9721 A double prefix ARG force skipping storing functions that are not
9722 part of Org's core.
9724 A triple prefix ARG force storing a link for each line in the
9725 active region."
9726 (interactive "P")
9727 (org-load-modules-maybe)
9728 (if (and (equal arg '(64)) (org-region-active-p))
9729 (save-excursion
9730 (let ((end (region-end)))
9731 (goto-char (region-beginning))
9732 (set-mark (point))
9733 (while (< (point-at-eol) end)
9734 (move-end-of-line 1) (activate-mark)
9735 (let (current-prefix-arg)
9736 (call-interactively 'org-store-link))
9737 (move-beginning-of-line 2)
9738 (set-mark (point)))))
9739 (org-with-limited-levels
9740 (setq org-store-link-plist nil)
9741 (let (link cpltxt desc description search
9742 txt custom-id agenda-link sfuns sfunsn)
9743 (cond
9745 ;; Store a link using an external link type
9746 ((and (not (equal arg '(16)))
9747 (setq sfuns
9748 (delq
9749 nil (mapcar (lambda (f)
9750 (let (fs) (if (funcall f) (push f fs))))
9751 org-store-link-functions))
9752 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9753 (or (and (cdr sfuns)
9754 (funcall (intern
9755 (completing-read
9756 "Which function for creating the link? "
9757 sfunsn nil t (car sfunsn)))))
9758 (funcall (caar sfuns)))
9759 (setq link (plist-get org-store-link-plist :link)
9760 desc (or (plist-get org-store-link-plist
9761 :description)
9762 link))))
9764 ;; Store a link from a source code buffer.
9765 ((org-src-edit-buffer-p)
9766 (cond
9767 ((save-excursion
9768 (beginning-of-line)
9769 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9770 "[ \t]*$")))
9771 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9772 ((org-called-interactively-p 'any)
9773 (let (label)
9774 (while (or (not label)
9775 (org-with-wide-buffer
9776 (goto-char (point-min))
9777 (re-search-forward
9778 (regexp-quote (format org-coderef-label-format label))
9779 nil t)))
9780 (when label (message "Label exists already") (sit-for 2))
9781 (setq label (read-string "Code line label: " label)))
9782 (end-of-line)
9783 (setq link (format org-coderef-label-format label))
9784 (let ((gc (- 79 (length link))))
9785 (if (< (current-column) gc) (org-move-to-column gc t)
9786 (insert " ")))
9787 (insert link)
9788 (setq link (concat "(" label ")") desc nil)))
9789 (t (setq link nil))))
9791 ;; We are in the agenda, link to referenced location
9792 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9793 (let ((m (or (get-text-property (point) 'org-hd-marker)
9794 (get-text-property (point) 'org-marker))))
9795 (when m
9796 (org-with-point-at m
9797 (setq agenda-link
9798 (if (org-called-interactively-p 'any)
9799 (call-interactively 'org-store-link)
9800 (org-store-link nil)))))))
9802 ((eq major-mode 'calendar-mode)
9803 (let ((cd (calendar-cursor-to-date)))
9804 (setq link
9805 (format-time-string
9806 (car org-time-stamp-formats)
9807 (apply 'encode-time
9808 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9809 nil nil nil))))
9810 (org-store-link-props :type "calendar" :date cd)))
9812 ((eq major-mode 'help-mode)
9813 (setq link (concat "help:" (save-excursion
9814 (goto-char (point-min))
9815 (looking-at "^[^ ]+")
9816 (match-string 0))))
9817 (org-store-link-props :type "help"))
9819 ((eq major-mode 'w3-mode)
9820 (setq cpltxt (if (and (buffer-name)
9821 (not (string-match "Untitled" (buffer-name))))
9822 (buffer-name)
9823 (url-view-url t))
9824 link (url-view-url t))
9825 (org-store-link-props :type "w3" :url (url-view-url t)))
9827 ((eq major-mode 'image-mode)
9828 (setq cpltxt (concat "file:"
9829 (abbreviate-file-name buffer-file-name))
9830 link cpltxt)
9831 (org-store-link-props :type "image" :file buffer-file-name))
9833 ;; In dired, store a link to the file of the current line
9834 ((derived-mode-p 'dired-mode)
9835 (let ((file (dired-get-filename nil t)))
9836 (setq file (if file
9837 (abbreviate-file-name
9838 (expand-file-name (dired-get-filename nil t)))
9839 ;; otherwise, no file so use current directory.
9840 default-directory))
9841 (setq cpltxt (concat "file:" file)
9842 link cpltxt)))
9844 ((setq search (run-hook-with-args-until-success
9845 'org-create-file-search-functions))
9846 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9847 "::" search))
9848 (setq cpltxt (or description link)))
9850 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9851 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9852 (cond
9853 ;; Store a link using the target at point
9854 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9855 (setq cpltxt
9856 (concat "file:"
9857 (abbreviate-file-name
9858 (buffer-file-name (buffer-base-buffer)))
9859 "::" (match-string 1))
9860 link cpltxt))
9861 ((and (featurep 'org-id)
9862 (or (eq org-id-link-to-org-use-id t)
9863 (and (org-called-interactively-p 'any)
9864 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9865 (and (eq org-id-link-to-org-use-id
9866 'create-if-interactive-and-no-custom-id)
9867 (not custom-id))))
9868 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9869 ;; Store a link using the ID at point
9870 (setq link (condition-case nil
9871 (prog1 (org-id-store-link)
9872 (setq desc (or (plist-get org-store-link-plist
9873 :description)
9874 "")))
9875 (error
9876 ;; Probably before first headline, link only to file
9877 (concat "file:"
9878 (abbreviate-file-name
9879 (buffer-file-name (buffer-base-buffer))))))))
9881 ;; Just link to current headline
9882 (setq cpltxt (concat "file:"
9883 (abbreviate-file-name
9884 (buffer-file-name (buffer-base-buffer)))))
9885 ;; Add a context search string
9886 (when (org-xor org-context-in-file-links arg)
9887 (let* ((ee (org-element-at-point))
9888 (et (org-element-type ee))
9889 (ev (plist-get (cadr ee) :value))
9890 (ek (plist-get (cadr ee) :key))
9891 (eok (and (stringp ek) (string-match "name" ek))))
9892 (setq txt (cond
9893 ((org-at-heading-p) nil)
9894 ((and (eq et 'keyword) eok) ev)
9895 ((org-region-active-p)
9896 (buffer-substring (region-beginning) (region-end)))))
9897 (when (or (null txt) (string-match "\\S-" txt))
9898 (setq cpltxt
9899 (concat cpltxt "::"
9900 (condition-case nil
9901 (org-make-org-heading-search-string txt)
9902 (error "")))
9903 desc (or (and (eq et 'keyword) eok ev)
9904 (nth 4 (ignore-errors (org-heading-components)))
9905 "NONE")))))
9906 (if (string-match "::\\'" cpltxt)
9907 (setq cpltxt (substring cpltxt 0 -2)))
9908 (setq link cpltxt))))
9910 ((buffer-file-name (buffer-base-buffer))
9911 ;; Just link to this file here.
9912 (setq cpltxt (concat "file:"
9913 (abbreviate-file-name
9914 (buffer-file-name (buffer-base-buffer)))))
9915 ;; Add a context string.
9916 (when (org-xor org-context-in-file-links arg)
9917 (setq txt (if (org-region-active-p)
9918 (buffer-substring (region-beginning) (region-end))
9919 (buffer-substring (point-at-bol) (point-at-eol))))
9920 ;; Only use search option if there is some text.
9921 (when (string-match "\\S-" txt)
9922 (setq cpltxt
9923 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9924 desc "NONE")))
9925 (setq link cpltxt))
9927 ((org-called-interactively-p 'interactive)
9928 (user-error "No method for storing a link from this buffer"))
9930 (t (setq link nil)))
9932 ;; We're done setting link and desc, clean up
9933 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9934 (setq link (or link cpltxt)
9935 desc (or desc cpltxt))
9936 (cond ((equal desc "NONE") (setq desc nil))
9937 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9938 (let ((d0 (match-string 3 desc))
9939 (p0 (match-string 5 desc)))
9940 (setq desc
9941 (replace-regexp-in-string
9942 org-bracket-link-regexp
9943 (concat (or p0 d0)
9944 (if (equal (length (match-string 0 desc))
9945 (length desc)) "*" "")) desc)))))
9947 ;; Return the link
9948 (if (not (and (or (org-called-interactively-p 'any)
9949 executing-kbd-macro)
9950 link))
9951 (or agenda-link (and link (org-make-link-string link desc)))
9952 (push (list link desc) org-stored-links)
9953 (message "Stored: %s" (or desc link))
9954 (when custom-id
9955 (setq link (concat "file:" (abbreviate-file-name
9956 (buffer-file-name)) "::#" custom-id))
9957 (push (list link desc) org-stored-links))
9958 (car org-stored-links))))))
9960 (defun org-store-link-props (&rest plist)
9961 "Store link properties, extract names and addresses."
9962 (let (x adr)
9963 (when (setq x (plist-get plist :from))
9964 (setq adr (mail-extract-address-components x))
9965 (setq plist (plist-put plist :fromname (car adr)))
9966 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9967 (when (setq x (plist-get plist :to))
9968 (setq adr (mail-extract-address-components x))
9969 (setq plist (plist-put plist :toname (car adr)))
9970 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9971 (let ((from (plist-get plist :from))
9972 (to (plist-get plist :to)))
9973 (when (and from to org-from-is-user-regexp)
9974 (setq plist
9975 (plist-put plist :fromto
9976 (if (string-match org-from-is-user-regexp from)
9977 (concat "to %t")
9978 (concat "from %f"))))))
9979 (setq org-store-link-plist plist))
9981 (defun org-add-link-props (&rest plist)
9982 "Add these properties to the link property list."
9983 (let (key value)
9984 (while plist
9985 (setq key (pop plist) value (pop plist))
9986 (setq org-store-link-plist
9987 (plist-put org-store-link-plist key value)))))
9989 (defun org-email-link-description (&optional fmt)
9990 "Return the description part of an email link.
9991 This takes information from `org-store-link-plist' and formats it
9992 according to FMT (default from `org-email-link-description-format')."
9993 (setq fmt (or fmt org-email-link-description-format))
9994 (let* ((p org-store-link-plist)
9995 (to (plist-get p :toaddress))
9996 (from (plist-get p :fromaddress))
9997 (table
9998 (list
9999 (cons "%c" (plist-get p :fromto))
10000 (cons "%F" (plist-get p :from))
10001 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10002 (cons "%T" (plist-get p :to))
10003 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10004 (cons "%s" (plist-get p :subject))
10005 (cons "%d" (plist-get p :date))
10006 (cons "%m" (plist-get p :message-id)))))
10007 (when (string-match "%c" fmt)
10008 ;; Check if the user wrote this message
10009 (if (and org-from-is-user-regexp from to
10010 (save-match-data (string-match org-from-is-user-regexp from)))
10011 (setq fmt (replace-match "to %t" t t fmt))
10012 (setq fmt (replace-match "from %f" t t fmt))))
10013 (org-replace-escapes fmt table)))
10015 (defun org-make-org-heading-search-string (&optional string)
10016 "Make search string for the current headline or STRING."
10017 (let ((s (or string
10018 (and (derived-mode-p 'org-mode)
10019 (save-excursion
10020 (org-back-to-heading t)
10021 (org-element-property :raw-value (org-element-at-point))))))
10022 (lines org-context-in-file-links))
10023 (or string (setq s (concat "*" s))) ; Add * for headlines
10024 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10025 (when (and string (integerp lines) (> lines 0))
10026 (let ((slines (org-split-string s "\n")))
10027 (when (< lines (length slines))
10028 (setq s (mapconcat
10029 'identity
10030 (reverse (nthcdr (- (length slines) lines)
10031 (reverse slines))) "\n")))))
10032 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10034 (defun org-make-link-string (link &optional description)
10035 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10036 (unless (org-string-nw-p link) (error "Empty link"))
10037 (let ((uri (cond ((string-match org-link-types-re link)
10038 (concat (match-string 1 link)
10039 (org-link-escape (substring link (match-end 1)))))
10040 ;; For readability, url-encode internal links only
10041 ;; when absolutely needed (i.e, when they contain
10042 ;; square brackets). File links however, are
10043 ;; encoded since, e.g., spaces are significant.
10044 ((or (file-name-absolute-p link)
10045 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10046 (org-link-escape link))
10047 (t link)))
10048 (description
10049 (and (org-string-nw-p description)
10050 ;; Remove brackets from description, as they are fatal.
10051 (replace-regexp-in-string
10052 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10053 (org-trim description)))))
10054 (format "[[%s]%s]"
10056 (if description (format "[%s]" description) ""))))
10058 (defconst org-link-escape-chars
10059 ;;%20 %5B %5D %25
10060 '(?\s ?\[ ?\] ?%)
10061 "List of characters that should be escaped in a link when stored to Org.
10062 This is the list that is used for internal purposes.")
10064 (defconst org-link-escape-chars-browser
10065 ;;%20 %22
10066 '(?\s ?\")
10067 "List of characters to be escaped before handing over to the browser.
10068 If you consider using this constant then you probably want to use
10069 the function `org-link-escape-browser' instead. See there why
10070 this constant is a candidate to be removed once Org drops support
10071 for Emacs 24.1 and 24.2.")
10073 (defun org-link-escape (text &optional table merge)
10074 "Return percent escaped representation of TEXT.
10075 TEXT is a string with the text to escape.
10076 Optional argument TABLE is a list with characters that should be
10077 escaped. When nil, `org-link-escape-chars' is used.
10078 If optional argument MERGE is set, merge TABLE into
10079 `org-link-escape-chars'."
10080 (let ((characters-to-encode
10081 (cond ((null table) org-link-escape-chars)
10082 (merge (append org-link-escape-chars table))
10083 (t table))))
10084 (mapconcat
10085 (lambda (c)
10086 (if (or (memq c characters-to-encode)
10087 (and org-url-hexify-p (or (< c 32) (> c 126))))
10088 (mapconcat (lambda (e) (format "%%%.2X" e))
10089 (or (encode-coding-char c 'utf-8)
10090 (error "Unable to percent escape character: %c" c))
10092 (char-to-string c)))
10093 text "")))
10095 (defun org-link-escape-browser (text)
10096 "Escape some characters before handing over to the browser.
10097 This function is a candidate to be removed together with the
10098 constant `org-link-escape-chars-browser' once Org drops support
10099 for Emacs 24.1 and 24.2. All calls to this function will have to
10100 be replaced with `url-encode-url' which is available since Emacs
10101 24.3.1."
10102 ;; Example with the Org link
10103 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10104 ;; to open the browser with +subject:"Release 8.2" filled into the
10105 ;; query field: In this case the variable TEXT contains the
10106 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10107 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10108 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10109 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10110 (if (fboundp 'url-encode-url)
10111 (url-encode-url text)
10112 (if (org-string-match-p
10113 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10114 text)
10115 (org-link-escape text org-link-escape-chars-browser)
10116 text)))
10118 (defun org-link-unescape (str)
10119 "Unhex hexified Unicode parts in string STR.
10120 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10121 reciprocal of `org-link-escape', which see."
10122 (if (org-string-nw-p str)
10123 (replace-regexp-in-string
10124 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10125 str))
10127 (defun org-link-unescape-compound (hex)
10128 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10129 Note: this function also decodes single byte encodings like
10130 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10131 (save-match-data
10132 (let* ((bytes (cdr (split-string hex "%")))
10133 (ret "")
10134 (eat 0)
10135 (sum 0))
10136 (while bytes
10137 (let* ((val (string-to-number (pop bytes) 16))
10138 (shift-xor
10139 (if (= 0 eat)
10140 (cond
10141 ((>= val 252) (cons 6 252))
10142 ((>= val 248) (cons 5 248))
10143 ((>= val 240) (cons 4 240))
10144 ((>= val 224) (cons 3 224))
10145 ((>= val 192) (cons 2 192))
10146 (t (cons 0 0)))
10147 (cons 6 128))))
10148 (if (>= val 192) (setq eat (car shift-xor)))
10149 (setq val (logxor val (cdr shift-xor)))
10150 (setq sum (+ (lsh sum (car shift-xor)) val))
10151 (if (> eat 0) (setq eat (- eat 1)))
10152 (cond
10153 ((= 0 eat) ;multi byte
10154 (setq ret (concat ret (org-char-to-string sum)))
10155 (setq sum 0))
10156 ((not bytes) ; single byte(s)
10157 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10158 ret)))
10160 (defun org-link-unescape-single-byte-sequence (hex)
10161 "Unhexify hex-encoded single byte character sequences."
10162 (mapconcat (lambda (byte)
10163 (char-to-string (string-to-number byte 16)))
10164 (cdr (split-string hex "%")) ""))
10166 (defun org-xor (a b)
10167 "Exclusive or."
10168 (if a (not b) b))
10170 (defun org-fixup-message-id-for-http (s)
10171 "Replace special characters in a message id, so it can be used in an http query."
10172 (when (string-match "%" s)
10173 (setq s (mapconcat (lambda (c)
10174 (if (eq c ?%)
10175 "%25"
10176 (char-to-string c)))
10177 s "")))
10178 (while (string-match "<" s)
10179 (setq s (replace-match "%3C" t t s)))
10180 (while (string-match ">" s)
10181 (setq s (replace-match "%3E" t t s)))
10182 (while (string-match "@" s)
10183 (setq s (replace-match "%40" t t s)))
10186 (defun org-link-prettify (link)
10187 "Return a human-readable representation of LINK.
10188 The car of LINK must be a raw link.
10189 The cdr of LINK must be either a link description or nil."
10190 (let ((desc (or (cadr link) "<no description>")))
10191 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10192 "<" (car link) ">")))
10194 ;;;###autoload
10195 (defun org-insert-link-global ()
10196 "Insert a link like Org-mode does.
10197 This command can be called in any mode to insert a link in Org-mode syntax."
10198 (interactive)
10199 (org-load-modules-maybe)
10200 (org-run-like-in-org-mode 'org-insert-link))
10202 (defun org-insert-all-links (arg &optional pre post)
10203 "Insert all links in `org-stored-links'.
10204 When a universal prefix, do not delete the links from `org-stored-links'.
10205 When `ARG' is a number, insert the last N link(s).
10206 `PRE' and `POST' are optional arguments to define a string to
10207 prepend or to append."
10208 (interactive "P")
10209 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10210 (links (copy-seq org-stored-links))
10211 (pr (or pre "- "))
10212 (po (or post "\n"))
10213 (cnt 1) l)
10214 (if (null org-stored-links)
10215 (message "No link to insert")
10216 (while (and (or (listp arg) (>= arg cnt))
10217 (setq l (if (listp arg)
10218 (pop links)
10219 (pop org-stored-links))))
10220 (setq cnt (1+ cnt))
10221 (insert pr)
10222 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10223 (insert po)))))
10225 (defun org-insert-last-stored-link (arg)
10226 "Insert the last link stored in `org-stored-links'."
10227 (interactive "p")
10228 (org-insert-all-links arg "" "\n"))
10230 (defun org-link-fontify-links-to-this-file ()
10231 "Fontify links to the current file in `org-stored-links'."
10232 (let ((f (buffer-file-name)) a b)
10233 (setq a (mapcar (lambda(l)
10234 (let ((ll (car l)))
10235 (when (and (string-match "^file:\\(.+\\)::" ll)
10236 (equal f (expand-file-name (match-string 1 ll))))
10237 ll)))
10238 org-stored-links))
10239 (when (featurep 'org-id)
10240 (setq b (mapcar (lambda(l)
10241 (let ((ll (car l)))
10242 (when (and (string-match "^id:\\(.+\\)$" ll)
10243 (equal f (expand-file-name
10244 (or (org-id-find-id-file
10245 (match-string 1 ll)) ""))))
10246 ll)))
10247 org-stored-links)))
10248 (mapcar (lambda(l)
10249 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10250 (delq nil (append a b)))))
10252 (defvar org-link-links-in-this-file nil)
10253 (defun org-insert-link (&optional complete-file link-location default-description)
10254 "Insert a link. At the prompt, enter the link.
10256 Completion can be used to insert any of the link protocol prefixes like
10257 http or ftp in use.
10259 The history can be used to select a link previously stored with
10260 `org-store-link'. When the empty string is entered (i.e. if you just
10261 press RET at the prompt), the link defaults to the most recently
10262 stored link. As SPC triggers completion in the minibuffer, you need to
10263 use M-SPC or C-q SPC to force the insertion of a space character.
10265 You will also be prompted for a description, and if one is given, it will
10266 be displayed in the buffer instead of the link.
10268 If there is already a link at point, this command will allow you to edit link
10269 and description parts.
10271 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10272 be selected using completion. The path to the file will be relative to the
10273 current directory if the file is in the current directory or a subdirectory.
10274 Otherwise, the link will be the absolute path as completed in the minibuffer
10275 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10276 option `org-link-file-path-type'.
10278 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10279 the current directory or below.
10281 With three \\[universal-argument] prefixes, negate the meaning of
10282 `org-keep-stored-link-after-insertion'.
10284 If `org-make-link-description-function' is non-nil, this function will be
10285 called with the link target, and the result will be the default
10286 link description.
10288 If the LINK-LOCATION parameter is non-nil, this value will be
10289 used as the link location instead of reading one interactively.
10291 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10292 be used as the default description."
10293 (interactive "P")
10294 (let* ((wcf (current-window-configuration))
10295 (origbuf (current-buffer))
10296 (region (if (org-region-active-p)
10297 (buffer-substring (region-beginning) (region-end))))
10298 (remove (and region (list (region-beginning) (region-end))))
10299 (desc region)
10300 tmphist ; byte-compile incorrectly complains about this
10301 (link link-location)
10302 (abbrevs org-link-abbrev-alist-local)
10303 entry file all-prefixes auto-desc)
10304 (cond
10305 (link-location) ; specified by arg, just use it.
10306 ((org-in-regexp org-bracket-link-regexp 1)
10307 ;; We do have a link at point, and we are going to edit it.
10308 (setq remove (list (match-beginning 0) (match-end 0)))
10309 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10310 (setq link (read-string "Link: "
10311 (org-link-unescape
10312 (org-match-string-no-properties 1)))))
10313 ((or (org-in-regexp org-angle-link-re)
10314 (org-in-regexp org-plain-link-re))
10315 ;; Convert to bracket link
10316 (setq remove (list (match-beginning 0) (match-end 0))
10317 link (read-string "Link: "
10318 (org-remove-angle-brackets (match-string 0)))))
10319 ((member complete-file '((4) (16)))
10320 ;; Completing read for file names.
10321 (setq link (org-file-complete-link complete-file)))
10323 ;; Read link, with completion for stored links.
10324 (org-link-fontify-links-to-this-file)
10325 (org-switch-to-buffer-other-window "*Org Links*")
10326 (with-current-buffer "*Org Links*"
10327 (erase-buffer)
10328 (insert "Insert a link.
10329 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10330 (when org-stored-links
10331 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10332 (insert (mapconcat 'org-link-prettify
10333 (reverse org-stored-links) "\n")))
10334 (goto-char (point-min)))
10335 (let ((cw (selected-window)))
10336 (select-window (get-buffer-window "*Org Links*" 'visible))
10337 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10338 (unless (pos-visible-in-window-p (point-max))
10339 (org-fit-window-to-buffer))
10340 (and (window-live-p cw) (select-window cw)))
10341 ;; Fake a link history, containing the stored links.
10342 (setq tmphist (append (mapcar 'car org-stored-links)
10343 org-insert-link-history))
10344 (setq all-prefixes (append (mapcar 'car abbrevs)
10345 (mapcar 'car org-link-abbrev-alist)
10346 org-link-types))
10347 (unwind-protect
10348 (progn
10349 (setq link
10350 (org-completing-read
10351 "Link: "
10352 (append
10353 (mapcar (lambda (x) (concat x ":"))
10354 all-prefixes)
10355 (mapcar 'car org-stored-links))
10356 nil nil nil
10357 'tmphist
10358 (caar org-stored-links)))
10359 (if (not (string-match "\\S-" link))
10360 (user-error "No link selected"))
10361 (mapc (lambda(l)
10362 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10363 org-stored-links)
10364 (if (or (member link all-prefixes)
10365 (and (equal ":" (substring link -1))
10366 (member (substring link 0 -1) all-prefixes)
10367 (setq link (substring link 0 -1))))
10368 (setq link (with-current-buffer origbuf
10369 (org-link-try-special-completion link)))))
10370 (set-window-configuration wcf)
10371 (kill-buffer "*Org Links*"))
10372 (setq entry (assoc link org-stored-links))
10373 (or entry (push link org-insert-link-history))
10374 (setq desc (or desc (nth 1 entry)))))
10376 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10377 (not org-keep-stored-link-after-insertion))
10378 (setq org-stored-links (delq (assoc link org-stored-links)
10379 org-stored-links)))
10381 (if (and (string-match org-plain-link-re link)
10382 (not (string-match org-ts-regexp link)))
10383 ;; URL-like link, normalize the use of angular brackets.
10384 (setq link (org-remove-angle-brackets link)))
10386 ;; Check if we are linking to the current file with a search
10387 ;; option If yes, simplify the link by using only the search
10388 ;; option.
10389 (when (and buffer-file-name
10390 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10391 (let* ((path (match-string 1 link))
10392 (case-fold-search nil)
10393 (search (match-string 2 link)))
10394 (save-match-data
10395 (if (equal (file-truename buffer-file-name) (file-truename path))
10396 ;; We are linking to this same file, with a search option
10397 (setq link search)))))
10399 ;; Check if we can/should use a relative path. If yes, simplify the link
10400 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10401 (let* ((type (match-string 1 link))
10402 (path (match-string 2 link))
10403 (origpath path)
10404 (case-fold-search nil))
10405 (cond
10406 ((or (eq org-link-file-path-type 'absolute)
10407 (equal complete-file '(16)))
10408 (setq path (abbreviate-file-name (expand-file-name path))))
10409 ((eq org-link-file-path-type 'noabbrev)
10410 (setq path (expand-file-name path)))
10411 ((eq org-link-file-path-type 'relative)
10412 (setq path (file-relative-name path)))
10414 (save-match-data
10415 (if (string-match (concat "^" (regexp-quote
10416 (expand-file-name
10417 (file-name-as-directory
10418 default-directory))))
10419 (expand-file-name path))
10420 ;; We are linking a file with relative path name.
10421 (setq path (substring (expand-file-name path)
10422 (match-end 0)))
10423 (setq path (abbreviate-file-name (expand-file-name path)))))))
10424 (setq link (concat type path))
10425 (if (equal desc origpath)
10426 (setq desc path))))
10428 (if org-make-link-description-function
10429 (setq desc
10430 (or (condition-case nil
10431 (funcall org-make-link-description-function link desc)
10432 (error (progn (message "Can't get link description from `%s'"
10433 (symbol-name org-make-link-description-function))
10434 (sit-for 2) nil)))
10435 (read-string "Description: " default-description)))
10436 (if default-description (setq desc default-description)
10437 (setq desc (or (and auto-desc desc)
10438 (read-string "Description: " desc)))))
10440 (unless (string-match "\\S-" desc) (setq desc nil))
10441 (if remove (apply 'delete-region remove))
10442 (insert (org-make-link-string link desc))
10443 ;; Redisplay so as the new link has proper invisible characters.
10444 (sit-for 0)))
10446 (defun org-link-try-special-completion (type)
10447 "If there is completion support for link type TYPE, offer it."
10448 (let ((fun (intern (concat "org-" type "-complete-link"))))
10449 (if (functionp fun)
10450 (funcall fun)
10451 (read-string "Link (no completion support): " (concat type ":")))))
10453 (defun org-file-complete-link (&optional arg)
10454 "Create a file link using completion."
10455 (let ((file (org-iread-file-name "File: "))
10456 (pwd (file-name-as-directory (expand-file-name ".")))
10457 (pwd1 (file-name-as-directory (abbreviate-file-name
10458 (expand-file-name ".")))))
10459 (cond ((equal arg '(16))
10460 (concat "file:"
10461 (abbreviate-file-name (expand-file-name file))))
10462 ((string-match
10463 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10464 (concat "file:" (match-string 1 file)))
10465 ((string-match
10466 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10467 (expand-file-name file))
10468 (concat "file:"
10469 (match-string 1 (expand-file-name file))))
10470 (t (concat "file:" file)))))
10472 (defun org-iread-file-name (&rest args)
10473 "Read-file-name using `ido-mode' speedup if available.
10474 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10475 See `read-file-name' for a description of parameters."
10476 (org-without-partial-completion
10477 (if (and org-completion-use-ido
10478 (fboundp 'ido-read-file-name)
10479 (org-bound-and-true-p ido-mode)
10480 (listp (nth 1 args)))
10481 (let ((ido-enter-matching-directory nil))
10482 (apply #'ido-read-file-name args))
10483 (apply #'read-file-name args))))
10485 (defun org-completing-read (&rest args)
10486 "Completing-read with SPACE being a normal character."
10487 (let ((enable-recursive-minibuffers t)
10488 (minibuffer-local-completion-map
10489 (copy-keymap minibuffer-local-completion-map)))
10490 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10491 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10492 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10493 (apply 'org-icompleting-read args)))
10495 (defun org-completing-read-no-i (&rest args)
10496 (let (org-completion-use-ido org-completion-use-iswitchb)
10497 (apply 'org-completing-read args)))
10499 (defun org-iswitchb-completing-read (prompt choices &rest args)
10500 "Use iswitch as a completing-read replacement to choose from choices.
10501 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10502 from."
10503 (let* ((iswitchb-use-virtual-buffers nil)
10504 (iswitchb-make-buflist-hook
10505 (lambda ()
10506 (setq iswitchb-temp-buflist choices))))
10507 (iswitchb-read-buffer prompt)))
10509 (defun org-icompleting-read (&rest args)
10510 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10511 Should be called like `completing-read'."
10512 (org-without-partial-completion
10513 (if (not (listp (nth 1 args)))
10514 ;; Ido only supports lists as the COLLECTION argument. Use
10515 ;; default completion function when second argument is not
10516 ;; a list.
10517 (apply #'completing-read args)
10518 (let ((ido-enter-matching-directory nil))
10519 (apply (cond ((and org-completion-use-ido
10520 (fboundp 'ido-completing-read)
10521 (org-bound-and-true-p ido-mode))
10522 #'ido-completing-read)
10523 ((and org-completion-use-iswitchb
10524 (org-bound-and-true-p iswitchb-mode))
10525 #'org-iswitchb-completing-read)
10526 (t #'completing-read))
10527 args)))))
10529 ;;; Opening/following a link
10531 (defvar org-link-search-failed nil)
10533 (defvar org-open-link-functions nil
10534 "Hook for functions finding a plain text link.
10535 These functions must take a single argument, the link content.
10536 They will be called for links that look like [[link text][description]]
10537 when LINK TEXT does not have a protocol like \"http:\" and does not look
10538 like a filename (e.g. \"./blue.png\").
10540 These functions will be called *before* Org attempts to resolve the
10541 link by doing text searches in the current buffer - so if you want a
10542 link \"[[target]]\" to still find \"<<target>>\", your function should
10543 handle this as a special case.
10545 When the function does handle the link, it must return a non-nil value.
10546 If it decides that it is not responsible for this link, it must return
10547 nil to indicate that that Org-mode can continue with other options
10548 like exact and fuzzy text search.")
10550 (defun org-next-link (&optional search-backward)
10551 "Move forward to the next link.
10552 If the link is in hidden text, expose it."
10553 (interactive "P")
10554 (when (and org-link-search-failed (eq this-command last-command))
10555 (goto-char (point-min))
10556 (message "Link search wrapped back to beginning of buffer"))
10557 (setq org-link-search-failed nil)
10558 (let* ((pos (point))
10559 (ct (org-context))
10560 (a (assoc :link ct))
10561 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10562 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10563 ((looking-at org-any-link-re)
10564 ;; Don't stay stuck at link without an org-link face
10565 (forward-char (if search-backward -1 1))))
10566 (if (funcall srch-fun org-any-link-re nil t)
10567 (progn
10568 (goto-char (match-beginning 0))
10569 (if (outline-invisible-p) (org-show-context)))
10570 (goto-char pos)
10571 (setq org-link-search-failed t)
10572 (message "No further link found"))))
10574 (defun org-previous-link ()
10575 "Move backward to the previous link.
10576 If the link is in hidden text, expose it."
10577 (interactive)
10578 (funcall 'org-next-link t))
10580 (defun org-translate-link (s)
10581 "Translate a link string if a translation function has been defined."
10582 (with-temp-buffer
10583 (insert (org-trim s))
10584 (org-trim (org-element-interpret-data (org-element-context)))))
10586 (defun org-translate-link-from-planner (type path)
10587 "Translate a link from Emacs Planner syntax so that Org can follow it.
10588 This is still an experimental function, your mileage may vary."
10589 (cond
10590 ((member type '("http" "https" "news" "ftp"))
10591 ;; standard Internet links are the same.
10592 nil)
10593 ((and (equal type "irc") (string-match "^//" path))
10594 ;; Planner has two / at the beginning of an irc link, we have 1.
10595 ;; We should have zero, actually....
10596 (setq path (substring path 1)))
10597 ((and (equal type "lisp") (string-match "^/" path))
10598 ;; Planner has a slash, we do not.
10599 (setq type "elisp" path (substring path 1)))
10600 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10601 ;; A typical message link. Planner has the id after the final slash,
10602 ;; we separate it with a hash mark
10603 (setq path (concat (match-string 1 path) "#"
10604 (org-remove-angle-brackets (match-string 2 path))))))
10605 (cons type path))
10607 (defun org-find-file-at-mouse (ev)
10608 "Open file link or URL at mouse."
10609 (interactive "e")
10610 (mouse-set-point ev)
10611 (org-open-at-point 'in-emacs))
10613 (defun org-open-at-mouse (ev)
10614 "Open file link or URL at mouse.
10615 See the docstring of `org-open-file' for details."
10616 (interactive "e")
10617 (mouse-set-point ev)
10618 (if (eq major-mode 'org-agenda-mode)
10619 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10620 (org-open-at-point))
10622 (defvar org-window-config-before-follow-link nil
10623 "The window configuration before following a link.
10624 This is saved in case the need arises to restore it.")
10626 ;;;###autoload
10627 (defun org-open-at-point-global ()
10628 "Follow a link like Org-mode does.
10629 This command can be called in any mode to follow a link that has
10630 Org-mode syntax."
10631 (interactive)
10632 (org-run-like-in-org-mode 'org-open-at-point))
10634 ;;;###autoload
10635 (defun org-open-link-from-string (s &optional arg reference-buffer)
10636 "Open a link in the string S, as if it was in Org-mode."
10637 (interactive "sLink: \nP")
10638 (let ((reference-buffer (or reference-buffer (current-buffer))))
10639 (with-temp-buffer
10640 (let ((org-inhibit-startup (not reference-buffer)))
10641 (org-mode)
10642 (insert s)
10643 (goto-char (point-min))
10644 (when reference-buffer
10645 (setq org-link-abbrev-alist-local
10646 (with-current-buffer reference-buffer
10647 org-link-abbrev-alist-local)))
10648 (org-open-at-point arg reference-buffer)))))
10650 (defvar org-open-at-point-functions nil
10651 "Hook that is run when following a link at point.
10653 Functions in this hook must return t if they identify and follow
10654 a link at point. If they don't find anything interesting at point,
10655 they must return nil.")
10657 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10658 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10659 (defun org-open-at-point (&optional arg reference-buffer)
10660 "Open link, timestamp, footnote or tags at point.
10662 When point is on a link, follow it. Normally, files will be
10663 opened by an appropriate application. If the optional prefix
10664 argument ARG is non-nil, Emacs will visit the file. With
10665 a double prefix argument, try to open outside of Emacs, in the
10666 application the system uses for this file type.
10668 When point is on a timestamp, open the agenda at the day
10669 specified.
10671 When point is a footnote definition, move to the first reference
10672 found. If it is on a reference, move to the associated
10673 definition.
10675 When point is on a headline, display a list of every link in the
10676 entry, so it is possible to pick one, or all, of them. If point
10677 is on a tag, call `org-tags-view' instead.
10679 When optional argument REFERENCE-BUFFER is non-nil, it should
10680 specify a buffer from where the link search should happen. This
10681 is used internally by `org-open-link-from-string'.
10683 On top of syntactically correct links, this function will open
10684 the link at point in comments or comment blocks and the first
10685 link in a property drawer line."
10686 (interactive "P")
10687 ;; On a code block, open block's results.
10688 (unless (call-interactively 'org-babel-open-src-block-result)
10689 (org-load-modules-maybe)
10690 (setq org-window-config-before-follow-link (current-window-configuration))
10691 (org-remove-occur-highlights nil nil t)
10692 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10693 (let* ((context
10694 ;; Only consider supported types, even if they are not
10695 ;; the closest one.
10696 (org-element-lineage
10697 (org-element-context)
10698 '(clock comment comment-block footnote-definition
10699 footnote-reference headline inlinetask keyword link
10700 node-property timestamp)
10702 (type (org-element-type context))
10703 (value (org-element-property :value context)))
10704 (cond
10705 ((not context) (user-error "No link found"))
10706 ;; Exception: open timestamps and links in properties
10707 ;; drawers, keywords and comments.
10708 ((memq type '(comment comment-block keyword node-property))
10709 (cond ((org-in-regexp org-any-link-re)
10710 (org-open-link-from-string (match-string-no-properties 0)))
10711 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10712 (org-follow-timestamp-link))
10713 (t (user-error "No link found"))))
10714 ;; On a headline or an inlinetask, but not on a timestamp,
10715 ;; a link, a footnote reference or on tags.
10716 ((and (memq type '(headline inlinetask))
10717 ;; Not on tags.
10718 (progn (save-excursion (beginning-of-line)
10719 (looking-at org-complex-heading-regexp))
10720 (or (not (match-beginning 5))
10721 (< (point) (match-beginning 5)))))
10722 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10723 (links (car data))
10724 (links-end (cdr data)))
10725 (if links
10726 (dolist (link (if (stringp links) (list links) links))
10727 (search-forward link nil links-end)
10728 (goto-char (match-beginning 0))
10729 (org-open-at-point))
10730 (require 'org-attach)
10731 (org-attach-reveal 'if-exists))))
10732 ;; On a clock line, make sure point is on the timestamp
10733 ;; before opening it.
10734 ((and (eq type 'clock)
10735 value
10736 (>= (point) (org-element-property :begin value))
10737 (<= (point) (org-element-property :end value)))
10738 (org-follow-timestamp-link))
10739 ;; Do nothing on white spaces after an object, unless point
10740 ;; is right after it.
10741 ((> (point)
10742 (save-excursion
10743 (goto-char (org-element-property :end context))
10744 (skip-chars-backward " \t")
10745 (point)))
10746 (user-error "No link found"))
10747 ((eq type 'timestamp) (org-follow-timestamp-link))
10748 ;; On tags within a headline or an inlinetask.
10749 ((and (memq type '(headline inlinetask))
10750 (progn (save-excursion (beginning-of-line)
10751 (looking-at org-complex-heading-regexp))
10752 (and (match-beginning 5)
10753 (>= (point) (match-beginning 5)))))
10754 (org-tags-view arg (substring (match-string 5) 0 -1)))
10755 ((eq type 'link)
10756 ;; When link is located within the description of another
10757 ;; link (e.g., an inline image), always open the parent
10758 ;; link.
10759 (let*((link (let ((up (org-element-property :parent context)))
10760 (if (eq (org-element-type up) 'link) up context)))
10761 (type (org-element-property :type link))
10762 (path (org-link-unescape (org-element-property :path link))))
10763 ;; Switch back to REFERENCE-BUFFER needed when called in
10764 ;; a temporary buffer through `org-open-link-from-string'.
10765 (with-current-buffer (or reference-buffer (current-buffer))
10766 (cond
10767 ((equal type "file")
10768 (if (string-match "[*?{]" (file-name-nondirectory path))
10769 (dired path)
10770 ;; Look into `org-link-protocols' in order to find
10771 ;; a DEDICATED-FUNCTION to open file. The function
10772 ;; will be applied on raw link instead of parsed
10773 ;; link due to the limitation in `org-add-link-type'
10774 ;; ("open" function called with a single argument).
10775 ;; If no such function is found, fallback to
10776 ;; `org-open-file'.
10778 ;; Note : "file+emacs" and "file+sys" types are
10779 ;; hard-coded in order to escape the previous
10780 ;; limitation.
10781 (let* ((option (org-element-property :search-option link))
10782 (app (org-element-property :application link))
10783 (dedicated-function
10784 (nth 1 (assoc app org-link-protocols))))
10785 (if dedicated-function
10786 (funcall dedicated-function
10787 (concat path
10788 (and option (concat "::" option))))
10789 (apply #'org-open-file
10790 path
10791 (cond (arg)
10792 ((equal app "emacs") 'emacs)
10793 ((equal app "sys") 'system))
10794 (cond ((not option) nil)
10795 ((org-string-match-p "\\`[0-9]+\\'" option)
10796 (list (string-to-number option)))
10797 (t (list nil
10798 (org-link-unescape option)))))))))
10799 ((assoc type org-link-protocols)
10800 (funcall (nth 1 (assoc type org-link-protocols)) path))
10801 ((equal type "help")
10802 (let ((f-or-v (intern path)))
10803 (cond ((fboundp f-or-v) (describe-function f-or-v))
10804 ((boundp f-or-v) (describe-variable f-or-v))
10805 (t (error "Not a known function or variable")))))
10806 ((member type '("http" "https" "ftp" "mailto" "news"))
10807 (browse-url (org-link-escape-browser (concat type ":" path))))
10808 ((equal type "doi")
10809 (browse-url
10810 (org-link-escape-browser (concat org-doi-server-url path))))
10811 ((equal type "message") (browse-url (concat type ":" path)))
10812 ((equal type "shell")
10813 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10814 (cmd path))
10815 (if (or (and (org-string-nw-p
10816 org-confirm-shell-link-not-regexp)
10817 (string-match
10818 org-confirm-shell-link-not-regexp cmd))
10819 (not org-confirm-shell-link-function)
10820 (funcall org-confirm-shell-link-function
10821 (format "Execute \"%s\" in shell? "
10822 (org-add-props cmd nil
10823 'face 'org-warning))))
10824 (progn
10825 (message "Executing %s" cmd)
10826 (shell-command cmd buf)
10827 (when (featurep 'midnight)
10828 (setq clean-buffer-list-kill-buffer-names
10829 (cons (buffer-name buf)
10830 clean-buffer-list-kill-buffer-names))))
10831 (user-error "Abort"))))
10832 ((equal type "elisp")
10833 (let ((cmd path))
10834 (if (or (and (org-string-nw-p
10835 org-confirm-elisp-link-not-regexp)
10836 (org-string-match-p
10837 org-confirm-elisp-link-not-regexp cmd))
10838 (not org-confirm-elisp-link-function)
10839 (funcall org-confirm-elisp-link-function
10840 (format "Execute \"%s\" as elisp? "
10841 (org-add-props cmd nil
10842 'face 'org-warning))))
10843 (message "%s => %s" cmd
10844 (if (eq (string-to-char cmd) ?\()
10845 (eval (read cmd))
10846 (call-interactively (read cmd))))
10847 (user-error "Abort"))))
10848 ((equal type "id")
10849 (require 'org-id)
10850 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10851 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10852 (unless (run-hook-with-args-until-success
10853 'org-open-link-functions path)
10854 (if (not arg) (org-mark-ring-push)
10855 (switch-to-buffer-other-window
10856 (org-get-buffer-for-internal-link (current-buffer))))
10857 (let ((destination
10858 (org-with-wide-buffer
10859 (if (equal type "radio")
10860 (org-search-radio-target
10861 (org-element-property :path link))
10862 (org-link-search
10863 (if (member type '("custom-id" "coderef"))
10864 (org-element-property :raw-link link)
10865 path)
10866 ;; Prevent fuzzy links from matching
10867 ;; themselves.
10868 (and (equal type "fuzzy")
10869 (+ 2 (org-element-property :begin link)))))
10870 (point))))
10871 (unless (and (<= (point-min) destination)
10872 (>= (point-max) destination))
10873 (widen))
10874 (goto-char destination))))
10875 (t (browse-url-at-point))))))
10876 ;; On a footnote reference or at a footnote definition's label.
10877 ((or (eq type 'footnote-reference)
10878 (and (eq type 'footnote-definition)
10879 (save-excursion
10880 ;; Do not validate action when point is on the
10881 ;; spaces right after the footnote label, in
10882 ;; order to be on par with behaviour on links.
10883 (skip-chars-forward " \t")
10884 (let ((begin
10885 (org-element-property :contents-begin context)))
10886 (if begin (< (point) begin)
10887 (= (org-element-property :post-affiliated context)
10888 (line-beginning-position)))))))
10889 (org-footnote-action))
10890 (t (user-error "No link found")))))
10891 (run-hook-with-args 'org-follow-link-hook)))
10893 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10894 "Offer links in the current entry and return the selected link.
10895 If there is only one link, return it.
10896 If NTH is an integer, return the NTH link found.
10897 If ZERO is a string, check also this string for a link, and if
10898 there is one, return it."
10899 (with-current-buffer buffer
10900 (save-excursion
10901 (save-restriction
10902 (widen)
10903 (goto-char marker)
10904 (let ((cnt ?0)
10905 (in-emacs (if (integerp nth) nil nth))
10906 have-zero end links link c)
10907 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10908 (push (match-string 0 zero) links)
10909 (setq cnt (1- cnt) have-zero t))
10910 (save-excursion
10911 (org-back-to-heading t)
10912 (setq end (save-excursion (outline-next-heading) (point)))
10913 (while (re-search-forward org-any-link-re end t)
10914 (push (match-string 0) links))
10915 (setq links (org-uniquify (reverse links))))
10916 (cond
10917 ((null links)
10918 (message "No links"))
10919 ((equal (length links) 1)
10920 (setq link (car links)))
10921 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10922 (setq link (nth (if have-zero nth (1- nth)) links)))
10923 (t ; we have to select a link
10924 (save-excursion
10925 (save-window-excursion
10926 (delete-other-windows)
10927 (with-output-to-temp-buffer "*Select Link*"
10928 (mapc (lambda (l)
10929 (if (not (string-match org-bracket-link-regexp l))
10930 (princ (format "[%c] %s\n" (incf cnt)
10931 (org-remove-angle-brackets l)))
10932 (if (match-end 3)
10933 (princ (format "[%c] %s (%s)\n" (incf cnt)
10934 (match-string 3 l) (match-string 1 l)))
10935 (princ (format "[%c] %s\n" (incf cnt)
10936 (match-string 1 l))))))
10937 links))
10938 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10939 (message "Select link to open, RET to open all:")
10940 (setq c (read-char-exclusive))
10941 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10942 (when (equal c ?q) (user-error "Abort"))
10943 (if (equal c ?\C-m)
10944 (setq link links)
10945 (setq nth (- c ?0))
10946 (if have-zero (setq nth (1+ nth)))
10947 (unless (and (integerp nth) (>= (length links) nth))
10948 (user-error "Invalid link selection"))
10949 (setq link (nth (1- nth) links)))))
10950 (cons link end))))))
10952 ;; TODO: These functions are deprecated since `org-open-at-point'
10953 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10954 (defun org-open-file-with-system (path)
10955 "Open file at PATH using the system way of opening it."
10956 (org-open-file path 'system))
10957 (defun org-open-file-with-emacs (path)
10958 "Open file at PATH in Emacs."
10959 (org-open-file path 'emacs))
10962 ;;; File search
10964 (defvar org-create-file-search-functions nil
10965 "List of functions to construct the right search string for a file link.
10966 These functions are called in turn with point at the location to
10967 which the link should point.
10969 A function in the hook should first test if it would like to
10970 handle this file type, for example by checking the `major-mode'
10971 or the file extension. If it decides not to handle this file, it
10972 should just return nil to give other functions a chance. If it
10973 does handle the file, it must return the search string to be used
10974 when following the link. The search string will be part of the
10975 file link, given after a double colon, and `org-open-at-point'
10976 will automatically search for it. If special measures must be
10977 taken to make the search successful, another function should be
10978 added to the companion hook `org-execute-file-search-functions',
10979 which see.
10981 A function in this hook may also use `setq' to set the variable
10982 `description' to provide a suggestion for the descriptive text to
10983 be used for this link when it gets inserted into an Org-mode
10984 buffer with \\[org-insert-link].")
10986 (defvar org-execute-file-search-functions nil
10987 "List of functions to execute a file search triggered by a link.
10989 Functions added to this hook must accept a single argument, the
10990 search string that was part of the file link, the part after the
10991 double colon. The function must first check if it would like to
10992 handle this search, for example by checking the `major-mode' or
10993 the file extension. If it decides not to handle this search, it
10994 should just return nil to give other functions a chance. If it
10995 does handle the search, it must return a non-nil value to keep
10996 other functions from trying.
10998 Each function can access the current prefix argument through the
10999 variable `current-prefix-arg'. Note that a single prefix is used
11000 to force opening a link in Emacs, so it may be good to only use a
11001 numeric or double prefix to guide the search function.
11003 In case this is needed, a function in this hook can also restore
11004 the window configuration before `org-open-at-point' was called using:
11006 (set-window-configuration org-window-config-before-follow-link)")
11008 (defun org-search-radio-target (target)
11009 "Search a radio target matching TARGET in current buffer.
11010 White spaces are not significant."
11011 (let ((re (format "<<<%s>>>"
11012 (mapconcat #'regexp-quote
11013 (org-split-string target "[ \t\n]+")
11014 "[ \t]+\\(?:\n[ \t]*\\)?")))
11015 (origin (point)))
11016 (goto-char (point-min))
11017 (catch :radio-match
11018 (while (re-search-forward re nil t)
11019 (backward-char)
11020 (let ((object (org-element-context)))
11021 (when (eq (org-element-type object) 'radio-target)
11022 (goto-char (org-element-property :begin object))
11023 (org-show-context 'link-search)
11024 (throw :radio-match nil))))
11025 (goto-char origin)
11026 (user-error "No match for radio target: %s" target))))
11028 (defun org-link-search (s &optional avoid-pos stealth)
11029 "Search for a search string S.
11031 If S starts with \"#\", it triggers a custom ID search.
11033 If S is enclosed within parenthesis, it initiates a coderef
11034 search.
11036 If S is surrounded by forward slashes, it is interpreted as
11037 a regular expression. In Org mode files, this will create an
11038 `org-occur' sparse tree. In ordinary files, `occur' will be used
11039 to list matches. If the current buffer is in `dired-mode', grep
11040 will be used to search in all files.
11042 When AVOID-POS is given, ignore matches near that position.
11044 When optional argument STEALTH is non-nil, do not modify
11045 visibility around point, thus ignoring `org-show-context-detail'
11046 variable.
11048 Search is case-insensitive and ignores white spaces. Return type
11049 of matched result, with is either `dedicated' or `fuzzy'."
11050 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11051 (let* ((case-fold-search t)
11052 (origin (point))
11053 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11054 (words (org-split-string s "[ \t\n]+"))
11055 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11056 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11057 type)
11058 (cond
11059 ;; Check if there are any special search functions.
11060 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11061 ((eq (string-to-char s) ?#)
11062 ;; Look for a custom ID S if S starts with "#".
11063 (let* ((id (substring normalized 1))
11064 (match (org-find-property "CUSTOM_ID" id)))
11065 (if match (progn (goto-char match) (setf type 'dedicated))
11066 (error "No match for custom ID: %s" id))))
11067 ((string-match "\\`(\\(.*\\))\\'" normalized)
11068 ;; Look for coderef targets if S is enclosed within parenthesis.
11069 (let ((coderef (match-string-no-properties 1 normalized))
11070 (re (substring s-single-re 1 -1)))
11071 (goto-char (point-min))
11072 (catch :coderef-match
11073 (while (re-search-forward re nil t)
11074 (let ((element (org-element-at-point)))
11075 (when (and (memq (org-element-type element)
11076 '(example-block src-block))
11077 ;; Build proper regexp according to current
11078 ;; block's label format.
11079 (let ((label-fmt
11080 (regexp-quote
11081 (or (org-element-property :label-fmt element)
11082 org-coderef-label-format))))
11083 (save-excursion
11084 (beginning-of-line)
11085 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11086 (format label-fmt coderef))))))
11087 (setq type 'dedicated)
11088 (goto-char (match-beginning 1))
11089 (throw :coderef-match nil))))
11090 (goto-char origin)
11091 (error "No match for coderef: %s" coderef))))
11092 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11093 ;; Look for a regular expression.
11094 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11095 (match-string 1 s)))
11096 ;; Fuzzy links.
11098 (let* ((starred (eq (string-to-char normalized) ?*))
11099 (headline-search (and (derived-mode-p 'org-mode)
11100 (or org-link-search-must-match-exact-headline
11101 starred))))
11102 (cond
11103 ;; Look for targets, only if not in a headline search.
11104 ((and (not starred)
11105 (let ((target (format "<<%s>>" s-multi-re)))
11106 (catch :target-match
11107 (goto-char (point-min))
11108 (while (re-search-forward target nil t)
11109 (backward-char)
11110 (let ((context (org-element-context)))
11111 (when (eq (org-element-type context) 'target)
11112 (setq type 'dedicated)
11113 (goto-char (org-element-property :begin context))
11114 (throw :target-match t))))
11115 nil))))
11116 ;; Look for elements named after S, only if not in a headline
11117 ;; search.
11118 ((and (not starred)
11119 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11120 (catch :name-match
11121 (goto-char (point-min))
11122 (while (re-search-forward name nil t)
11123 (let ((element (org-element-at-point)))
11124 (when (equal (org-split-string
11125 (org-element-property :name element)
11126 "[ \t]+")
11127 words)
11128 (setq type 'dedicated)
11129 (beginning-of-line)
11130 (throw :name-match t))))
11131 nil))))
11132 ;; Regular text search. Prefer headlines in Org mode
11133 ;; buffers.
11134 ((and (derived-mode-p 'org-mode)
11135 (let* ((wspace "[ \t]")
11136 (wspaceopt (concat wspace "*"))
11137 (cookie (concat "\\(?:"
11138 wspaceopt
11139 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11140 wspaceopt
11141 "\\)"))
11142 (sep (concat "\\(?:\\(?:" wspace "\\|" cookie "\\)+\\)"))
11143 (re (concat
11144 org-outline-regexp-bol
11145 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11146 "\\(?:\\[#.\\][ \t]+\\)?"
11147 "\\(?:" org-comment-string "[ \t]+\\)?"
11148 sep "?"
11149 (let ((title (mapconcat #'regexp-quote
11150 words
11151 sep)))
11152 (if starred (substring title 1) title))
11153 sep "?"
11154 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11155 "[ \t]*$")))
11156 (goto-char (point-min))
11157 (re-search-forward re nil t)))
11158 (goto-char (match-beginning 0))
11159 (setq type 'dedicated))
11160 ;; Offer to create non-existent headline depending on
11161 ;; `org-link-search-must-match-exact-headline'.
11162 ((and (derived-mode-p 'org-mode)
11163 (not org-link-search-inhibit-query)
11164 (eq org-link-search-must-match-exact-headline 'query-to-create)
11165 (yes-or-no-p "No match - create this as a new heading? "))
11166 (goto-char (point-max))
11167 (unless (bolp) (newline))
11168 (org-insert-heading nil t t)
11169 (insert s "\n")
11170 (beginning-of-line 0))
11171 ;; Only headlines are looked after. No need to process
11172 ;; further: throw an error.
11173 ((and (derived-mode-p 'org-mode)
11174 (or starred org-link-search-must-match-exact-headline))
11175 (goto-char origin)
11176 (error "No match for fuzzy expression: %s" normalized))
11177 ;; Regular text search.
11178 ((catch :fuzzy-match
11179 (goto-char (point-min))
11180 (while (re-search-forward s-multi-re nil t)
11181 ;; Skip match if it contains AVOID-POS or it is included
11182 ;; in a link with a description but outside the
11183 ;; description.
11184 (unless (or (and avoid-pos
11185 (<= (match-beginning 0) avoid-pos)
11186 (> (match-end 0) avoid-pos))
11187 (and (save-match-data
11188 (org-in-regexp org-bracket-link-regexp))
11189 (match-beginning 3)
11190 (or (> (match-beginning 3) (point))
11191 (<= (match-end 3) (point)))
11192 (org-element-lineage
11193 (save-match-data (org-element-context))
11194 '(link) t)))
11195 (goto-char (match-beginning 0))
11196 (setq type 'fuzzy)
11197 (throw :fuzzy-match t)))
11198 nil))
11199 ;; All failed. Throw an error.
11200 (t (goto-char origin)
11201 (error "No match for fuzzy expression: %s" normalized))))))
11202 ;; Disclose surroundings of match, if appropriate.
11203 (when (and (derived-mode-p 'org-mode) (not stealth))
11204 (org-show-context 'link-search))
11205 type))
11207 (defun org-get-buffer-for-internal-link (buffer)
11208 "Return a buffer to be used for displaying the link target of internal links."
11209 (cond
11210 ((not org-display-internal-link-with-indirect-buffer)
11211 buffer)
11212 ((string-match "(Clone)$" (buffer-name buffer))
11213 (message "Buffer is already a clone, not making another one")
11214 ;; we also do not modify visibility in this case
11215 buffer)
11216 (t ; make a new indirect buffer for displaying the link
11217 (let* ((bn (buffer-name buffer))
11218 (ibn (concat bn "(Clone)"))
11219 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11220 (with-current-buffer ib (org-overview))
11221 ib))))
11223 (defun org-do-occur (regexp &optional cleanup)
11224 "Call the Emacs command `occur'.
11225 If CLEANUP is non-nil, remove the printout of the regular expression
11226 in the *Occur* buffer. This is useful if the regex is long and not useful
11227 to read."
11228 (occur regexp)
11229 (when cleanup
11230 (let ((cwin (selected-window)) win beg end)
11231 (when (setq win (get-buffer-window "*Occur*"))
11232 (select-window win))
11233 (goto-char (point-min))
11234 (when (re-search-forward "match[a-z]+" nil t)
11235 (setq beg (match-end 0))
11236 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11237 (setq end (1- (match-beginning 0)))))
11238 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11239 (goto-char (point-min))
11240 (select-window cwin))))
11242 ;;; The mark ring for links jumps
11244 (defvar org-mark-ring nil
11245 "Mark ring for positions before jumps in Org-mode.")
11246 (defvar org-mark-ring-last-goto nil
11247 "Last position in the mark ring used to go back.")
11248 ;; Fill and close the ring
11249 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11250 (loop for i from 1 to org-mark-ring-length do
11251 (push (make-marker) org-mark-ring))
11252 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11253 org-mark-ring)
11255 (defun org-mark-ring-push (&optional pos buffer)
11256 "Put the current position or POS into the mark ring and rotate it."
11257 (interactive)
11258 (setq pos (or pos (point)))
11259 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11260 (move-marker (car org-mark-ring)
11261 (or pos (point))
11262 (or buffer (current-buffer)))
11263 (message "%s"
11264 (substitute-command-keys
11265 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11267 (defun org-mark-ring-goto (&optional n)
11268 "Jump to the previous position in the mark ring.
11269 With prefix arg N, jump back that many stored positions. When
11270 called several times in succession, walk through the entire ring.
11271 Org-mode commands jumping to a different position in the current file,
11272 or to another Org-mode file, automatically push the old position
11273 onto the ring."
11274 (interactive "p")
11275 (let (p m)
11276 (if (eq last-command this-command)
11277 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11278 (setq p org-mark-ring))
11279 (setq org-mark-ring-last-goto p)
11280 (setq m (car p))
11281 (org-pop-to-buffer-same-window (marker-buffer m))
11282 (goto-char m)
11283 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11285 (defun org-remove-angle-brackets (s)
11286 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11287 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11289 (defun org-add-angle-brackets (s)
11290 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11291 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11293 (defun org-remove-double-quotes (s)
11294 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11295 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11298 ;;; Following specific links
11300 (defun org-follow-timestamp-link ()
11301 "Open an agenda view for the time-stamp date/range at point."
11302 (cond
11303 ((org-at-date-range-p t)
11304 (let ((org-agenda-start-on-weekday)
11305 (t1 (match-string 1))
11306 (t2 (match-string 2)) tt1 tt2)
11307 (setq tt1 (time-to-days (org-time-string-to-time t1))
11308 tt2 (time-to-days (org-time-string-to-time t2)))
11309 (let ((org-agenda-buffer-tmp-name
11310 (format "*Org Agenda(a:%s)"
11311 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11312 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11313 ((org-at-timestamp-p t)
11314 (let ((org-agenda-buffer-tmp-name
11315 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11316 (org-agenda-list nil (time-to-days (org-time-string-to-time
11317 (substring (match-string 1) 0 10)))
11318 1)))
11319 (t (error "This should not happen"))))
11322 ;;; Following file links
11323 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11324 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11325 (declare-function mailcap-mime-info
11326 "mailcap" (string &optional request no-decode))
11327 (defvar org-wait nil)
11328 (defun org-open-file (path &optional in-emacs line search)
11329 "Open the file at PATH.
11330 First, this expands any special file name abbreviations. Then the
11331 configuration variable `org-file-apps' is checked if it contains an
11332 entry for this file type, and if yes, the corresponding command is launched.
11334 If no application is found, Emacs simply visits the file.
11336 With optional prefix argument IN-EMACS, Emacs will visit the file.
11337 With a double \\[universal-argument] \\[universal-argument] \
11338 prefix arg, Org tries to avoid opening in Emacs
11339 and to use an external application to visit the file.
11341 Optional LINE specifies a line to go to, optional SEARCH a string
11342 to search for. If LINE or SEARCH is given, the file will be
11343 opened in Emacs, unless an entry from org-file-apps that makes
11344 use of groups in a regexp matches.
11346 If you want to change the way frames are used when following a
11347 link, please customize `org-link-frame-setup'.
11349 If the file does not exist, an error is thrown."
11350 (let* ((file (if (equal path "")
11351 buffer-file-name
11352 (substitute-in-file-name (expand-file-name path))))
11353 (file-apps (append org-file-apps (org-default-apps)))
11354 (apps (org-remove-if
11355 'org-file-apps-entry-match-against-dlink-p file-apps))
11356 (apps-dlink (org-remove-if-not
11357 'org-file-apps-entry-match-against-dlink-p file-apps))
11358 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11359 (dirp (if remp nil (file-directory-p file)))
11360 (file (if (and dirp org-open-directory-means-index-dot-org)
11361 (concat (file-name-as-directory file) "index.org")
11362 file))
11363 (a-m-a-p (assq 'auto-mode apps))
11364 (dfile (downcase file))
11365 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11366 (link (cond ((and (eq line nil)
11367 (eq search nil))
11368 file)
11369 (line
11370 (concat file "::" (number-to-string line)))
11371 (search
11372 (concat file "::" search))))
11373 (dlink (downcase link))
11374 (old-buffer (current-buffer))
11375 (old-pos (point))
11376 (old-mode major-mode)
11377 ext cmd link-match-data)
11378 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11379 (setq ext (match-string 1 dfile))
11380 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11381 (setq ext (match-string 1 dfile))))
11382 (cond
11383 ((member in-emacs '((16) system))
11384 (setq cmd (cdr (assoc 'system apps))))
11385 (in-emacs (setq cmd 'emacs))
11387 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11388 (and dirp (cdr (assoc 'directory apps)))
11389 ; first, try matching against apps-dlink
11390 ; if we get a match here, store the match data for later
11391 (let ((match (assoc-default dlink apps-dlink
11392 'string-match)))
11393 (if match
11394 (progn (setq link-match-data (match-data))
11395 match)
11396 (progn (setq in-emacs (or in-emacs line search))
11397 nil))) ; if we have no match in apps-dlink,
11398 ; always open the file in emacs if line or search
11399 ; is given (for backwards compatibility)
11400 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11401 'string-match)
11402 (cdr (assoc ext apps))
11403 (cdr (assoc t apps))))))
11404 (when (eq cmd 'system)
11405 (setq cmd (cdr (assoc 'system apps))))
11406 (when (eq cmd 'default)
11407 (setq cmd (cdr (assoc t apps))))
11408 (when (eq cmd 'mailcap)
11409 (require 'mailcap)
11410 (mailcap-parse-mailcaps)
11411 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11412 (command (mailcap-mime-info mime-type)))
11413 (if (stringp command)
11414 (setq cmd command)
11415 (setq cmd 'emacs))))
11416 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11417 (not (file-exists-p file))
11418 (not org-open-non-existing-files))
11419 (user-error "No such file: %s" file))
11420 (cond
11421 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11422 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11423 (while (string-match "['\"]%s['\"]" cmd)
11424 (setq cmd (replace-match "%s" t t cmd)))
11425 (while (string-match "%s" cmd)
11426 (setq cmd (replace-match
11427 (save-match-data
11428 (shell-quote-argument
11429 (convert-standard-filename file)))
11430 t t cmd)))
11432 ;; Replace "%1", "%2" etc. in command with group matches from regex
11433 (save-match-data
11434 (let ((match-index 1)
11435 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11436 (set-match-data link-match-data)
11437 (while (<= match-index number-of-groups)
11438 (let ((regex (concat "%" (number-to-string match-index)))
11439 (replace-with (match-string match-index dlink)))
11440 (while (string-match regex cmd)
11441 (setq cmd (replace-match replace-with t t cmd))))
11442 (setq match-index (+ match-index 1)))))
11444 (save-window-excursion
11445 (message "Running %s...done" cmd)
11446 (start-process-shell-command cmd nil cmd)
11447 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11448 ((or (stringp cmd)
11449 (eq cmd 'emacs))
11450 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11451 (widen)
11452 (if line (progn (org-goto-line line)
11453 (if (derived-mode-p 'org-mode)
11454 (org-reveal)))
11455 (if search (org-link-search search))))
11456 ((consp cmd)
11457 (let ((file (convert-standard-filename file)))
11458 (save-match-data
11459 (set-match-data link-match-data)
11460 (eval cmd))))
11461 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11462 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11463 (or (not (equal old-buffer (current-buffer)))
11464 (not (equal old-pos (point))))
11465 (org-mark-ring-push old-pos old-buffer))))
11467 (defun org-file-apps-entry-match-against-dlink-p (entry)
11468 "This function returns non-nil if `entry' uses a regular
11469 expression which should be matched against the whole link by
11470 org-open-file.
11472 It assumes that is the case when the entry uses a regular
11473 expression which has at least one grouping construct and the
11474 action is either a lisp form or a command string containing
11475 `%1', i.e. using at least one subexpression match as a
11476 parameter."
11477 (let ((selector (car entry))
11478 (action (cdr entry)))
11479 (if (stringp selector)
11480 (and (> (regexp-opt-depth selector) 0)
11481 (or (and (stringp action)
11482 (string-match "%[0-9]" action))
11483 (consp action)))
11484 nil)))
11486 (defun org-default-apps ()
11487 "Return the default applications for this operating system."
11488 (cond
11489 ((eq system-type 'darwin)
11490 org-file-apps-defaults-macosx)
11491 ((eq system-type 'windows-nt)
11492 org-file-apps-defaults-windowsnt)
11493 (t org-file-apps-defaults-gnu)))
11495 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11496 "Convert extensions to regular expressions in the cars of LIST.
11497 Also, weed out any non-string entries, because the return value is used
11498 only for regexp matching.
11499 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11500 point to the symbol `emacs', indicating that the file should
11501 be opened in Emacs."
11502 (append
11503 (delq nil
11504 (mapcar (lambda (x)
11505 (if (not (stringp (car x)))
11507 (if (string-match "\\W" (car x))
11509 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11510 list))
11511 (if add-auto-mode
11512 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11514 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11515 (defun org-file-remote-p (file)
11516 "Test whether FILE specifies a location on a remote system.
11517 Return non-nil if the location is indeed remote.
11519 For example, the filename \"/user@host:/foo\" specifies a location
11520 on the system \"/user@host:\"."
11521 (cond ((fboundp 'file-remote-p)
11522 (file-remote-p file))
11523 ((fboundp 'tramp-handle-file-remote-p)
11524 (tramp-handle-file-remote-p file))
11525 ((and (boundp 'ange-ftp-name-format)
11526 (string-match (car ange-ftp-name-format) file))
11527 t)))
11530 ;;;; Refiling
11532 (defun org-get-org-file ()
11533 "Read a filename, with default directory `org-directory'."
11534 (let ((default (or org-default-notes-file remember-data-file)))
11535 (read-file-name (format "File name [%s]: " default)
11536 (file-name-as-directory org-directory)
11537 default)))
11539 (defun org-notes-order-reversed-p ()
11540 "Check if the current file should receive notes in reversed order."
11541 (cond
11542 ((not org-reverse-note-order) nil)
11543 ((eq t org-reverse-note-order) t)
11544 ((not (listp org-reverse-note-order)) nil)
11545 (t (catch 'exit
11546 (dolist (entry org-reverse-note-order)
11547 (if (string-match (car entry) buffer-file-name)
11548 (throw 'exit (cdr entry))))))))
11550 (defvar org-refile-target-table nil
11551 "The list of refile targets, created by `org-refile'.")
11553 (defvar org-agenda-new-buffers nil
11554 "Buffers created to visit agenda files.")
11556 (defvar org-refile-cache nil
11557 "Cache for refile targets.")
11559 (defvar org-refile-markers nil
11560 "All the markers used for caching refile locations.")
11562 (defun org-refile-marker (pos)
11563 "Get a new refile marker, but only if caching is in use."
11564 (if (not org-refile-use-cache)
11566 (let ((m (make-marker)))
11567 (move-marker m pos)
11568 (push m org-refile-markers)
11569 m)))
11571 (defun org-refile-cache-clear ()
11572 "Clear the refile cache and disable all the markers."
11573 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11574 (setq org-refile-markers nil)
11575 (setq org-refile-cache nil)
11576 (message "Refile cache has been cleared"))
11578 (defun org-refile-cache-check-set (set)
11579 "Check if all the markers in the cache still have live buffers."
11580 (let (marker)
11581 (catch 'exit
11582 (while (and set (setq marker (nth 3 (pop set))))
11583 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11584 (when (and marker (null (marker-buffer marker)))
11585 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11586 (sit-for 3)
11587 (throw 'exit nil)))
11588 t)))
11590 (defun org-refile-cache-put (set &rest identifiers)
11591 "Push the refile targets SET into the cache, under IDENTIFIERS."
11592 (let* ((key (sha1 (prin1-to-string identifiers)))
11593 (entry (assoc key org-refile-cache)))
11594 (if entry
11595 (setcdr entry set)
11596 (push (cons key set) org-refile-cache))))
11598 (defun org-refile-cache-get (&rest identifiers)
11599 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11600 (cond
11601 ((not org-refile-cache) nil)
11602 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11604 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11605 org-refile-cache))))
11606 (and set (org-refile-cache-check-set set) set)))))
11608 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11609 "Produce a table with refile targets."
11610 (let ((case-fold-search nil)
11611 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11612 (entries (or org-refile-targets '((nil . (:level . 1)))))
11613 targets tgs txt re files desc descre fast-path-p level pos0)
11614 (message "Getting targets...")
11615 (with-current-buffer (or default-buffer (current-buffer))
11616 (dolist (entry entries)
11617 (setq files (car entry) desc (cdr entry))
11618 (setq fast-path-p nil)
11619 (cond
11620 ((null files) (setq files (list (current-buffer))))
11621 ((eq files 'org-agenda-files)
11622 (setq files (org-agenda-files 'unrestricted)))
11623 ((and (symbolp files) (fboundp files))
11624 (setq files (funcall files)))
11625 ((and (symbolp files) (boundp files))
11626 (setq files (symbol-value files))))
11627 (if (stringp files) (setq files (list files)))
11628 (cond
11629 ((eq (car desc) :tag)
11630 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11631 ((eq (car desc) :todo)
11632 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11633 ((eq (car desc) :regexp)
11634 (setq descre (cdr desc)))
11635 ((eq (car desc) :level)
11636 (setq descre (concat "^\\*\\{" (number-to-string
11637 (if org-odd-levels-only
11638 (1- (* 2 (cdr desc)))
11639 (cdr desc)))
11640 "\\}[ \t]")))
11641 ((eq (car desc) :maxlevel)
11642 (setq fast-path-p t)
11643 (setq descre (concat "^\\*\\{1," (number-to-string
11644 (if org-odd-levels-only
11645 (1- (* 2 (cdr desc)))
11646 (cdr desc)))
11647 "\\}[ \t]")))
11648 (t (error "Bad refiling target description %s" desc)))
11649 (dolist (f files)
11650 (with-current-buffer
11651 (if (bufferp f) f (org-get-agenda-file-buffer f))
11653 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11654 (progn
11655 (if (bufferp f) (setq f (buffer-file-name
11656 (buffer-base-buffer f))))
11657 (setq f (and f (expand-file-name f)))
11658 (if (eq org-refile-use-outline-path 'file)
11659 (push (list (file-name-nondirectory f) f nil nil) tgs))
11660 (save-excursion
11661 (save-restriction
11662 (widen)
11663 (goto-char (point-min))
11664 (while (re-search-forward descre nil t)
11665 (goto-char (setq pos0 (point-at-bol)))
11666 (catch 'next
11667 (when org-refile-target-verify-function
11668 (save-match-data
11669 (or (funcall org-refile-target-verify-function)
11670 (throw 'next t))))
11671 (when (and (looking-at org-complex-heading-regexp)
11672 (not (member (match-string 4) excluded-entries))
11673 (match-string 4))
11674 (setq level (org-reduced-level
11675 (- (match-end 1) (match-beginning 1)))
11676 txt (org-link-display-format (match-string 4))
11677 txt (replace-regexp-in-string "\\( *[[0-9]+/?[0-9]*%?]\\)+$" "" txt)
11678 re (format org-complex-heading-regexp-format
11679 (regexp-quote (match-string 4))))
11680 (when org-refile-use-outline-path
11681 (setq txt (mapconcat
11682 'org-protect-slash
11683 (append
11684 (if (eq org-refile-use-outline-path
11685 'file)
11686 (list (file-name-nondirectory
11687 (buffer-file-name
11688 (buffer-base-buffer))))
11689 (if (eq org-refile-use-outline-path
11690 'full-file-path)
11691 (list (buffer-file-name
11692 (buffer-base-buffer)))))
11693 (org-get-outline-path fast-path-p
11694 level txt)
11695 (list txt))
11696 "/")))
11697 (push (list txt f re (org-refile-marker (point)))
11698 tgs)))
11699 (when (= (point) pos0)
11700 ;; verification function has not moved point
11701 (goto-char (point-at-eol))))))))
11702 (when org-refile-use-cache
11703 (org-refile-cache-put tgs (buffer-file-name) descre))
11704 (setq targets (append tgs targets))))))
11705 (message "Getting targets...done")
11706 (nreverse targets)))
11708 (defun org-protect-slash (s)
11709 (while (string-match "/" s)
11710 (setq s (replace-match "\\" t t s)))
11713 (defvar org-olpa (make-vector 20 nil))
11715 (defun org-get-outline-path (&optional fastp level heading)
11716 "Return the outline path to the current entry, as a list.
11718 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11719 routine which makes outline path derivations for an entire file,
11720 avoiding backtracing. Refile target collection makes use of that."
11721 (if fastp
11722 (progn
11723 (if (> level 19)
11724 (error "Outline path failure, more than 19 levels"))
11725 (loop for i from level upto 19 do
11726 (aset org-olpa i nil))
11727 (prog1
11728 (delq nil (append org-olpa nil))
11729 (aset org-olpa level heading)))
11730 (let (rtn case-fold-search)
11731 (save-excursion
11732 (save-restriction
11733 (widen)
11734 (while (org-up-heading-safe)
11735 (when (looking-at org-complex-heading-regexp)
11736 (push (org-trim
11737 (replace-regexp-in-string
11738 ;; Remove statistical/checkboxes cookies
11739 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11740 (org-match-string-no-properties 4)))
11741 rtn)))
11742 rtn)))))
11744 (defun org-format-outline-path (path &optional width prefix separator)
11745 "Format the outline path PATH for display.
11746 WIDTH is the maximum number of characters that is available.
11747 PREFIX is a prefix to be included in the returned string,
11748 such as the file name.
11749 SEPARATOR is inserted between the different parts of the path,
11750 the default is \"/\"."
11751 (setq width (or width 79))
11752 (setq path (delq nil path))
11753 (unless (> width 0)
11754 (user-error "Argument `width' must be positive"))
11755 (setq separator (or separator "/"))
11756 (let* ((org-odd-levels-only nil)
11757 (fpath (concat
11758 prefix (and prefix path separator)
11759 (mapconcat
11760 (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
11761 (loop for head in path
11762 for n from 0
11763 collect (org-add-props
11764 head nil 'face
11765 (nth (% n org-n-level-faces) org-level-faces)))
11766 separator))))
11767 (when (> (length fpath) width)
11768 (if (< width 7)
11769 ;; It's unlikely that `width' will be this small, but don't
11770 ;; waste characters by adding ".." if it is.
11771 (setq fpath (substring fpath 0 width))
11772 (setf (substring fpath (- width 2)) "..")))
11773 fpath))
11775 (defun org-display-outline-path (&optional file current separator just-return-string)
11776 "Display the current outline path in the echo area.
11778 If FILE is non-nil, prepend the output with the file name.
11779 If CURRENT is non-nil, append the current heading to the output.
11780 SEPARATOR is passed through to `org-format-outline-path'. It separates
11781 the different parts of the path and defaults to \"/\".
11782 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11783 (interactive "P")
11784 (let* (case-fold-search
11785 (bfn (buffer-file-name (buffer-base-buffer)))
11786 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11787 res)
11788 (if current (setq path (append path
11789 (save-excursion
11790 (org-back-to-heading t)
11791 (if (looking-at org-complex-heading-regexp)
11792 (list (match-string 4)))))))
11793 (setq res
11794 (org-format-outline-path
11795 path
11796 (1- (frame-width))
11797 (and file bfn (concat (file-name-nondirectory bfn) separator))
11798 separator))
11799 (if just-return-string
11800 (org-no-properties res)
11801 (org-unlogged-message "%s" res))))
11803 (defvar org-refile-history nil
11804 "History for refiling operations.")
11806 (defvar org-after-refile-insert-hook nil
11807 "Hook run after `org-refile' has inserted its stuff at the new location.
11808 Note that this is still *before* the stuff will be removed from
11809 the *old* location.")
11811 (defvar org-capture-last-stored-marker)
11812 (defvar org-refile-keep nil
11813 "Non-nil means `org-refile' will copy instead of refile.")
11815 (defun org-copy ()
11816 "Like `org-refile', but copy."
11817 (interactive)
11818 (let ((org-refile-keep t))
11819 (funcall 'org-refile nil nil nil "Copy")))
11821 (defun org-refile (&optional arg default-buffer rfloc msg)
11822 "Move the entry or entries at point to another heading.
11823 The list of target headings is compiled using the information in
11824 `org-refile-targets', which see.
11826 At the target location, the entry is filed as a subitem of the
11827 target heading. Depending on `org-reverse-note-order', the new
11828 subitem will either be the first or the last subitem.
11830 If there is an active region, all entries in that region will be
11831 refiled. However, the region must fulfill the requirement that
11832 the first heading sets the top-level of the moved text.
11834 With prefix arg ARG, the command will only visit the target
11835 location and not actually move anything.
11837 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11838 refiling operation has put the subtree.
11840 With a numeric prefix argument of `2', refile to the running clock.
11842 With a numeric prefix argument of `3', emulate `org-refile-keep'
11843 being set to t and copy to the target location, don't move it.
11844 Beware that keeping refiled entries may result in duplicated ID
11845 properties.
11847 RFLOC can be a refile location obtained in a different way.
11849 MSG is a string to replace \"Refile\" in the default prompt with
11850 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11852 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11854 If you are using target caching (see `org-refile-use-cache'), you
11855 have to clear the target cache in order to find new targets.
11856 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11857 prefix argument (`C-u C-u C-u C-c C-w')."
11858 (interactive "P")
11859 (if (member arg '(0 (64)))
11860 (org-refile-cache-clear)
11861 (let* ((actionmsg (cond (msg msg)
11862 ((equal arg 3) "Refile (and keep)")
11863 (t "Refile")))
11864 (cbuf (current-buffer))
11865 (regionp (org-region-active-p))
11866 (region-start (and regionp (region-beginning)))
11867 (region-end (and regionp (region-end)))
11868 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11869 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11870 pos it nbuf file re level reversed)
11871 (setq last-command nil)
11872 (when regionp
11873 (goto-char region-start)
11874 (or (bolp) (goto-char (point-at-bol)))
11875 (setq region-start (point))
11876 (unless (or (org-kill-is-subtree-p
11877 (buffer-substring region-start region-end))
11878 (prog1 org-refile-active-region-within-subtree
11879 (let ((s (point-at-eol)))
11880 (org-toggle-heading)
11881 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11882 (user-error "The region is not a (sequence of) subtree(s)")))
11883 (if (equal arg '(16))
11884 (org-refile-goto-last-stored)
11885 (when (or
11886 (and (equal arg 2)
11887 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11888 (prog1
11889 (setq it (list (or org-clock-heading "running clock")
11890 (buffer-file-name
11891 (marker-buffer org-clock-hd-marker))
11893 (marker-position org-clock-hd-marker)))
11894 (setq arg nil)))
11895 (setq it (or rfloc
11896 (let (heading-text)
11897 (save-excursion
11898 (unless (and arg (listp arg))
11899 (org-back-to-heading t)
11900 (setq heading-text
11901 (replace-regexp-in-string
11902 org-bracket-link-regexp
11903 "\\3"
11904 (nth 4 (org-heading-components)))))
11905 (org-refile-get-location
11906 (cond ((and arg (listp arg)) "Goto")
11907 (regionp (concat actionmsg " region to"))
11908 (t (concat actionmsg " subtree \""
11909 heading-text "\" to")))
11910 default-buffer
11911 (and (not (equal '(4) arg))
11912 org-refile-allow-creating-parent-nodes)
11913 arg))))))
11914 (setq file (nth 1 it)
11915 re (nth 2 it)
11916 pos (nth 3 it))
11917 (if (and (not arg)
11919 (equal (buffer-file-name) file)
11920 (if regionp
11921 (and (>= pos region-start)
11922 (<= pos region-end))
11923 (and (>= pos (point))
11924 (< pos (save-excursion
11925 (org-end-of-subtree t t))))))
11926 (error "Cannot refile to position inside the tree or region"))
11927 (setq nbuf (or (find-buffer-visiting file)
11928 (find-file-noselect file)))
11929 (if (and arg (not (equal arg 3)))
11930 (progn
11931 (org-pop-to-buffer-same-window nbuf)
11932 (goto-char pos)
11933 (org-show-context 'org-goto))
11934 (if regionp
11935 (progn
11936 (org-kill-new (buffer-substring region-start region-end))
11937 (org-save-markers-in-region region-start region-end))
11938 (org-copy-subtree 1 nil t))
11939 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11940 (find-file-noselect file)))
11941 (setq reversed (org-notes-order-reversed-p))
11942 (save-excursion
11943 (save-restriction
11944 (widen)
11945 (if pos
11946 (progn
11947 (goto-char pos)
11948 (looking-at org-outline-regexp)
11949 (setq level (org-get-valid-level (funcall outline-level) 1))
11950 (goto-char
11951 (if reversed
11952 (or (outline-next-heading) (point-max))
11953 (or (save-excursion (org-get-next-sibling))
11954 (org-end-of-subtree t t)
11955 (point-max)))))
11956 (setq level 1)
11957 (if (not reversed)
11958 (goto-char (point-max))
11959 (goto-char (point-min))
11960 (or (outline-next-heading) (goto-char (point-max)))))
11961 (if (not (bolp)) (newline))
11962 (org-paste-subtree level nil nil t)
11963 (when org-log-refile
11964 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11965 (unless (eq org-log-refile 'note)
11966 (save-excursion (org-add-log-note))))
11967 (and org-auto-align-tags
11968 (let ((org-loop-over-headlines-in-active-region nil))
11969 (org-set-tags nil t)))
11970 (let ((bookmark-name (plist-get org-bookmark-names-plist
11971 :last-refile)))
11972 (when bookmark-name
11973 (with-demoted-errors
11974 (bookmark-set bookmark-name))))
11975 ;; If we are refiling for capture, make sure that the
11976 ;; last-capture pointers point here
11977 (when (org-bound-and-true-p org-refile-for-capture)
11978 (let ((bookmark-name (plist-get org-bookmark-names-plist
11979 :last-capture-marker)))
11980 (when bookmark-name
11981 (with-demoted-errors
11982 (bookmark-set bookmark-name))))
11983 (move-marker org-capture-last-stored-marker (point)))
11984 (if (fboundp 'deactivate-mark) (deactivate-mark))
11985 (run-hooks 'org-after-refile-insert-hook))))
11986 (unless org-refile-keep
11987 (if regionp
11988 (delete-region (point) (+ (point) (- region-end region-start)))
11989 (delete-region
11990 (and (org-back-to-heading t) (point))
11991 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11992 (when (featurep 'org-inlinetask)
11993 (org-inlinetask-remove-END-maybe))
11994 (setq org-markers-to-move nil)
11995 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11997 (defun org-refile-goto-last-stored ()
11998 "Go to the location where the last refile was stored."
11999 (interactive)
12000 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12001 (message "This is the location of the last refile"))
12003 (defun org-refile--get-location (refloc tbl)
12004 "When user refile to REFLOC, find the associated target in TBL.
12005 Also check `org-refile-target-table'."
12006 (car (delq
12008 (mapcar
12009 (lambda (r) (or (assoc r tbl)
12010 (assoc r org-refile-target-table)))
12011 (list (replace-regexp-in-string "/$" "" refloc)
12012 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12014 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12015 no-exclude)
12016 "Prompt the user for a refile location, using PROMPT.
12017 PROMPT should not be suffixed with a colon and a space, because
12018 this function appends the default value from
12019 `org-refile-history' automatically, if that is not empty.
12020 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12021 this is used for the GOTO interface."
12022 (let ((org-refile-targets org-refile-targets)
12023 (org-refile-use-outline-path org-refile-use-outline-path)
12024 excluded-entries)
12025 (when (and (derived-mode-p 'org-mode)
12026 (not org-refile-use-cache)
12027 (not no-exclude))
12028 (org-map-tree
12029 (lambda()
12030 (setq excluded-entries
12031 (append excluded-entries (list (org-get-heading t t)))))))
12032 (setq org-refile-target-table
12033 (org-refile-get-targets default-buffer excluded-entries)))
12034 (unless org-refile-target-table
12035 (user-error "No refile targets"))
12036 (let* ((cbuf (current-buffer))
12037 (partial-completion-mode nil)
12038 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12039 (cfunc (if (and org-refile-use-outline-path
12040 org-outline-path-complete-in-steps)
12041 'org-olpath-completing-read
12042 'org-icompleting-read))
12043 (extra (if org-refile-use-outline-path "/" ""))
12044 (cbnex (concat (buffer-name) extra))
12045 (filename (and cfn (expand-file-name cfn)))
12046 (tbl (mapcar
12047 (lambda (x)
12048 (if (and (not (member org-refile-use-outline-path
12049 '(file full-file-path)))
12050 (not (equal filename (nth 1 x))))
12051 (cons (concat (car x) extra " ("
12052 (file-name-nondirectory (nth 1 x)) ")")
12053 (cdr x))
12054 (cons (concat (car x) extra) (cdr x))))
12055 org-refile-target-table))
12056 (completion-ignore-case t)
12057 cdef
12058 (prompt (concat prompt
12059 (or (and (car org-refile-history)
12060 (concat " (default " (car org-refile-history) ")"))
12061 (and (assoc cbnex tbl) (setq cdef cbnex)
12062 (concat " (default " cbnex ")"))) ": "))
12063 pa answ parent-target child parent old-hist)
12064 (setq old-hist org-refile-history)
12065 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12066 nil 'org-refile-history (or cdef (car org-refile-history))))
12067 (if (setq pa (org-refile--get-location answ tbl))
12068 (progn
12069 (org-refile-check-position pa)
12070 (when (or (not org-refile-history)
12071 (not (eq old-hist org-refile-history))
12072 (not (equal (car pa) (car org-refile-history))))
12073 (setq org-refile-history
12074 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12075 org-refile-history
12076 (cdr org-refile-history))))
12077 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12078 (pop org-refile-history)))
12080 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12081 (progn
12082 (setq parent (match-string 1 answ)
12083 child (match-string 2 answ))
12084 (setq parent-target (org-refile--get-location parent tbl))
12085 (when (and parent-target
12086 (or (eq new-nodes t)
12087 (and (eq new-nodes 'confirm)
12088 (y-or-n-p (format "Create new node \"%s\"? "
12089 child)))))
12090 (org-refile-new-child parent-target child)))
12091 (user-error "Invalid target location")))))
12093 (declare-function org-string-nw-p "org-macs" (s))
12094 (defun org-refile-check-position (refile-pointer)
12095 "Check if the refile pointer matches the headline to which it points."
12096 (let* ((file (nth 1 refile-pointer))
12097 (re (nth 2 refile-pointer))
12098 (pos (nth 3 refile-pointer))
12099 buffer)
12100 (if (and (not (markerp pos)) (not file))
12101 (user-error "Please indicate a target file in the refile path")
12102 (when (org-string-nw-p re)
12103 (setq buffer (if (markerp pos)
12104 (marker-buffer pos)
12105 (or (find-buffer-visiting file)
12106 (find-file-noselect file))))
12107 (with-current-buffer buffer
12108 (save-excursion
12109 (save-restriction
12110 (widen)
12111 (goto-char pos)
12112 (beginning-of-line 1)
12113 (unless (org-looking-at-p re)
12114 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12116 (defun org-refile-new-child (parent-target child)
12117 "Use refile target PARENT-TARGET to add new CHILD below it."
12118 (unless parent-target
12119 (error "Cannot find parent for new node"))
12120 (let ((file (nth 1 parent-target))
12121 (pos (nth 3 parent-target))
12122 level)
12123 (with-current-buffer (or (find-buffer-visiting file)
12124 (find-file-noselect file))
12125 (save-excursion
12126 (save-restriction
12127 (widen)
12128 (if pos
12129 (goto-char pos)
12130 (goto-char (point-max))
12131 (if (not (bolp)) (newline)))
12132 (when (looking-at org-outline-regexp)
12133 (setq level (funcall outline-level))
12134 (org-end-of-subtree t t))
12135 (org-back-over-empty-lines)
12136 (insert "\n" (make-string
12137 (if pos (org-get-valid-level level 1) 1) ?*)
12138 " " child "\n")
12139 (beginning-of-line 0)
12140 (list (concat (car parent-target) "/" child) file "" (point)))))))
12142 (defun org-olpath-completing-read (prompt collection &rest args)
12143 "Read an outline path like a file name."
12144 (let ((thetable collection)
12145 (org-completion-use-ido nil) ; does not work with ido.
12146 (org-completion-use-iswitchb nil)) ; or iswitchb
12147 (apply #'org-icompleting-read
12148 prompt
12149 (lambda (string predicate &optional flag)
12150 (cond
12151 ((eq flag nil) (try-completion string thetable))
12152 ((eq flag t)
12153 (let ((l (length string)))
12154 (mapcar (lambda (x)
12155 (let ((r (substring x l))
12156 (f (if (string-match " ([^)]*)$" x)
12157 (match-string 0 x)
12158 "")))
12159 (if (string-match "/" r)
12160 (concat string (substring r 0 (match-end 0)) f)
12161 x)))
12162 (all-completions string thetable predicate))))
12163 ;; Exact match?
12164 ((eq flag 'lambda) (assoc string thetable))))
12165 args)))
12167 ;;;; Dynamic blocks
12169 (defun org-find-dblock (name)
12170 "Find the first dynamic block with name NAME in the buffer.
12171 If not found, stay at current position and return nil."
12172 (let ((case-fold-search t) pos)
12173 (save-excursion
12174 (goto-char (point-min))
12175 (setq pos (and (re-search-forward
12176 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12177 (match-beginning 0))))
12178 (if pos (goto-char pos))
12179 pos))
12181 (defun org-create-dblock (plist)
12182 "Create a dynamic block section, with parameters taken from PLIST.
12183 PLIST must contain a :name entry which is used as the name of the block."
12184 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12185 (end-of-line 1)
12186 (newline))
12187 (let ((col (current-column))
12188 (name (plist-get plist :name)))
12189 (insert "#+BEGIN: " name)
12190 (while plist
12191 (if (eq (car plist) :name)
12192 (setq plist (cddr plist))
12193 (insert " " (prin1-to-string (pop plist)))))
12194 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12195 (beginning-of-line -2)))
12197 (defun org-prepare-dblock ()
12198 "Prepare dynamic block for refresh.
12199 This empties the block, puts the cursor at the insert position and returns
12200 the property list including an extra property :name with the block name."
12201 (unless (looking-at org-dblock-start-re)
12202 (user-error "Not at a dynamic block"))
12203 (let* ((begdel (1+ (match-end 0)))
12204 (name (org-no-properties (match-string 1)))
12205 (params (append (list :name name)
12206 (read (concat "(" (match-string 3) ")")))))
12207 (save-excursion
12208 (beginning-of-line 1)
12209 (skip-chars-forward " \t")
12210 (setq params (plist-put params :indentation-column (current-column))))
12211 (unless (re-search-forward org-dblock-end-re nil t)
12212 (error "Dynamic block not terminated"))
12213 (setq params
12214 (append params
12215 (list :content (buffer-substring
12216 begdel (match-beginning 0)))))
12217 (delete-region begdel (match-beginning 0))
12218 (goto-char begdel)
12219 (open-line 1)
12220 params))
12222 (defun org-map-dblocks (&optional command)
12223 "Apply COMMAND to all dynamic blocks in the current buffer.
12224 If COMMAND is not given, use `org-update-dblock'."
12225 (let ((cmd (or command 'org-update-dblock)))
12226 (save-excursion
12227 (goto-char (point-min))
12228 (while (re-search-forward org-dblock-start-re nil t)
12229 (goto-char (match-beginning 0))
12230 (save-excursion
12231 (condition-case nil
12232 (funcall cmd)
12233 (error (message "Error during update of dynamic block"))))
12234 (unless (re-search-forward org-dblock-end-re nil t)
12235 (error "Dynamic block not terminated"))))))
12237 (defun org-dblock-update (&optional arg)
12238 "User command for updating dynamic blocks.
12239 Update the dynamic block at point. With prefix ARG, update all dynamic
12240 blocks in the buffer."
12241 (interactive "P")
12242 (if arg
12243 (org-update-all-dblocks)
12244 (or (looking-at org-dblock-start-re)
12245 (org-beginning-of-dblock))
12246 (org-update-dblock)))
12248 (defun org-update-dblock ()
12249 "Update the dynamic block at point.
12250 This means to empty the block, parse for parameters and then call
12251 the correct writing function."
12252 (interactive)
12253 (save-excursion
12254 (let* ((win (selected-window))
12255 (pos (point))
12256 (line (org-current-line))
12257 (params (org-prepare-dblock))
12258 (name (plist-get params :name))
12259 (indent (plist-get params :indentation-column))
12260 (cmd (intern (concat "org-dblock-write:" name))))
12261 (message "Updating dynamic block `%s' at line %d..." name line)
12262 (funcall cmd params)
12263 (message "Updating dynamic block `%s' at line %d...done" name line)
12264 (goto-char pos)
12265 (when (and indent (> indent 0))
12266 (setq indent (make-string indent ?\ ))
12267 (save-excursion
12268 (select-window win)
12269 (org-beginning-of-dblock)
12270 (forward-line 1)
12271 (while (not (looking-at org-dblock-end-re))
12272 (insert indent)
12273 (beginning-of-line 2))
12274 (when (looking-at org-dblock-end-re)
12275 (and (looking-at "[ \t]+")
12276 (replace-match ""))
12277 (insert indent)))))))
12279 (defun org-beginning-of-dblock ()
12280 "Find the beginning of the dynamic block at point.
12281 Error if there is no such block at point."
12282 (let ((pos (point))
12283 beg)
12284 (end-of-line 1)
12285 (if (and (re-search-backward org-dblock-start-re nil t)
12286 (setq beg (match-beginning 0))
12287 (re-search-forward org-dblock-end-re nil t)
12288 (> (match-end 0) pos))
12289 (goto-char beg)
12290 (goto-char pos)
12291 (error "Not in a dynamic block"))))
12293 (defun org-update-all-dblocks ()
12294 "Update all dynamic blocks in the buffer.
12295 This function can be used in a hook."
12296 (interactive)
12297 (when (derived-mode-p 'org-mode)
12298 (org-map-dblocks 'org-update-dblock)))
12301 ;;;; Completion
12303 (declare-function org-export-backend-name "org-export" (cl-x))
12304 (declare-function org-export-backend-options "org-export" (cl-x))
12305 (defun org-get-export-keywords ()
12306 "Return a list of all currently understood export keywords.
12307 Export keywords include options, block names, attributes and
12308 keywords relative to each registered export back-end."
12309 (let (keywords)
12310 (dolist (backend
12311 (org-bound-and-true-p org-export-registered-backends)
12312 (delq nil keywords))
12313 ;; Back-end name (for keywords, like #+LATEX:)
12314 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12315 (dolist (option-entry (org-export-backend-options backend))
12316 ;; Back-end options.
12317 (push (nth 1 option-entry) keywords)))))
12319 (defconst org-options-keywords
12320 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12321 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12322 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12323 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12324 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12326 (defcustom org-structure-template-alist
12327 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12328 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12329 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12330 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12331 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12332 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12333 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12334 ("L" "#+LaTeX: ")
12335 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12336 ("H" "#+HTML: ")
12337 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12338 ("A" "#+ASCII: ")
12339 ("i" "#+INDEX: ?")
12340 ("I" "#+INCLUDE: %file ?"))
12341 "Structure completion elements.
12342 This is a list of abbreviation keys and values. The value gets inserted
12343 if you type `<' followed by the key and then press the completion key,
12344 usually `TAB'. %file will be replaced by a file name after prompting
12345 for the file using completion. The cursor will be placed at the position
12346 of the `?' in the template.
12347 There are two templates for each key, the first uses the original Org syntax,
12348 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12349 the default when the /org-mtags.el/ module has been loaded. See also the
12350 variable `org-mtags-prefer-muse-templates'."
12351 :group 'org-completion
12352 :type '(repeat
12353 (list
12354 (string :tag "Key")
12355 (string :tag "Template")))
12356 :version "25.1"
12357 :package-version '(Org . "8.3"))
12359 (defun org-try-structure-completion ()
12360 "Try to complete a structure template before point.
12361 This looks for strings like \"<e\" on an otherwise empty line and
12362 expands them."
12363 (let ((l (buffer-substring (point-at-bol) (point)))
12365 (when (and (looking-at "[ \t]*$")
12366 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12367 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12368 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12369 (match-beginning 1)) a)
12370 t)))
12372 (defun org-complete-expand-structure-template (start cell)
12373 "Expand a structure template."
12374 (let ((rpl (nth 1 cell))
12375 (ind ""))
12376 (delete-region start (point))
12377 (when (string-match "\\`[ \t]*#\\+" rpl)
12378 (cond
12379 ((bolp))
12380 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12381 (setq ind (buffer-substring (point-at-bol) (point))))
12382 (t (newline))))
12383 (setq start (point))
12384 (if (string-match "%file" rpl)
12385 (setq rpl (replace-match
12386 (concat
12387 "\""
12388 (save-match-data
12389 (abbreviate-file-name (read-file-name "Include file: ")))
12390 "\"")
12391 t t rpl)))
12392 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12393 (concat "\n" ind)))
12394 (insert rpl)
12395 (if (re-search-backward "\\?" start t) (delete-char 1))))
12397 ;;;; TODO, DEADLINE, Comments
12399 (defun org-toggle-comment ()
12400 "Change the COMMENT state of an entry."
12401 (interactive)
12402 (save-excursion
12403 (org-back-to-heading)
12404 (looking-at org-complex-heading-regexp)
12405 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12406 (skip-chars-forward " \t")
12407 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12408 (if (org-in-commented-heading-p t)
12409 (delete-region (point)
12410 (progn (search-forward " " (line-end-position) 'move)
12411 (skip-chars-forward " \t")
12412 (point)))
12413 (insert org-comment-string)
12414 (unless (eolp) (insert " ")))))
12416 (defvar org-last-todo-state-is-todo nil
12417 "This is non-nil when the last TODO state change led to a TODO state.
12418 If the last change removed the TODO tag or switched to DONE, then
12419 this is nil.")
12421 (defvar org-setting-tags nil) ; dynamically skipped
12423 (defvar org-todo-setup-filter-hook nil
12424 "Hook for functions that pre-filter todo specs.
12425 Each function takes a todo spec and returns either nil or the spec
12426 transformed into canonical form." )
12428 (defvar org-todo-get-default-hook nil
12429 "Hook for functions that get a default item for todo.
12430 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12431 nil or a string to be used for the todo mark." )
12433 (defvar org-agenda-headline-snapshot-before-repeat)
12435 (defun org-current-effective-time ()
12436 "Return current time adjusted for `org-extend-today-until' variable."
12437 (let* ((ct (org-current-time))
12438 (dct (decode-time ct))
12439 (ct1
12440 (cond
12441 (org-use-last-clock-out-time-as-effective-time
12442 (or (org-clock-get-last-clock-out-time) ct))
12443 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12444 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12445 (t ct))))
12446 ct1))
12448 (defun org-todo-yesterday (&optional arg)
12449 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12450 (interactive "P")
12451 (if (eq major-mode 'org-agenda-mode)
12452 (apply 'org-agenda-todo-yesterday arg)
12453 (let* ((org-use-effective-time t)
12454 (hour (third (decode-time
12455 (org-current-time))))
12456 (org-extend-today-until (1+ hour)))
12457 (org-todo arg))))
12459 (defvar org-block-entry-blocking ""
12460 "First entry preventing the TODO state change.")
12462 (defun org-cancel-repeater ()
12463 "Cancel a repeater by setting its numeric value to zero."
12464 (interactive)
12465 (save-excursion
12466 (org-back-to-heading t)
12467 (let ((bound1 (point))
12468 (bound0 (save-excursion (outline-next-heading) (point))))
12469 (when (re-search-forward
12470 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12471 org-deadline-time-regexp "\\)\\|\\("
12472 org-ts-regexp "\\)")
12473 bound0 t)
12474 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12475 (replace-match "0" t nil nil 1))))))
12477 (defun org-todo (&optional arg)
12478 "Change the TODO state of an item.
12479 The state of an item is given by a keyword at the start of the heading,
12480 like
12481 *** TODO Write paper
12482 *** DONE Call mom
12484 The different keywords are specified in the variable `org-todo-keywords'.
12485 By default the available states are \"TODO\" and \"DONE\".
12486 So for this example: when the item starts with TODO, it is changed to DONE.
12487 When it starts with DONE, the DONE is removed. And when neither TODO nor
12488 DONE are present, add TODO at the beginning of the heading.
12490 With \\[universal-argument] prefix arg, use completion to determine the new \
12491 state.
12492 With numeric prefix arg, switch to that state.
12493 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12494 keywords (nextset).
12495 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12496 With a numeric prefix arg of 0, inhibit note taking for the change.
12497 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12499 When called through ELisp, arg is also interpreted in the following way:
12500 `none' -> empty state
12501 \"\"(empty string) -> switch to empty state
12502 `done' -> switch to DONE
12503 `nextset' -> switch to the next set of keywords
12504 `previousset' -> switch to the previous set of keywords
12505 \"WAITING\" -> switch to the specified keyword, but only if it
12506 really is a member of `org-todo-keywords'."
12507 (interactive "P")
12508 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12509 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12510 'region-start-level 'region))
12511 org-loop-over-headlines-in-active-region)
12512 (org-map-entries
12513 `(org-todo ,arg)
12514 org-loop-over-headlines-in-active-region
12515 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12516 (if (equal arg '(16)) (setq arg 'nextset))
12517 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12518 (let ((org-blocker-hook org-blocker-hook)
12519 commentp
12520 case-fold-search)
12521 (when (equal arg '(64))
12522 (setq arg nil org-blocker-hook nil))
12523 (when (and org-blocker-hook
12524 (or org-inhibit-blocking
12525 (org-entry-get nil "NOBLOCKING")))
12526 (setq org-blocker-hook nil))
12527 (save-excursion
12528 (catch 'exit
12529 (org-back-to-heading t)
12530 (when (org-in-commented-heading-p t)
12531 (org-toggle-comment)
12532 (setq commentp t))
12533 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12534 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12535 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12536 (let* ((match-data (match-data))
12537 (startpos (point-at-bol))
12538 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12539 (org-log-done org-log-done)
12540 (org-log-repeat org-log-repeat)
12541 (org-todo-log-states org-todo-log-states)
12542 (org-inhibit-logging
12543 (if (equal arg 0)
12544 (progn (setq arg nil) 'note) org-inhibit-logging))
12545 (this (match-string 1))
12546 (hl-pos (match-beginning 0))
12547 (head (org-get-todo-sequence-head this))
12548 (ass (assoc head org-todo-kwd-alist))
12549 (interpret (nth 1 ass))
12550 (done-word (nth 3 ass))
12551 (final-done-word (nth 4 ass))
12552 (org-last-state (or this ""))
12553 (completion-ignore-case t)
12554 (member (member this org-todo-keywords-1))
12555 (tail (cdr member))
12556 (org-state (cond
12557 ((and org-todo-key-trigger
12558 (or (and (equal arg '(4))
12559 (eq org-use-fast-todo-selection 'prefix))
12560 (and (not arg) org-use-fast-todo-selection
12561 (not (eq org-use-fast-todo-selection
12562 'prefix)))))
12563 ;; Use fast selection
12564 (org-fast-todo-selection))
12565 ((and (equal arg '(4))
12566 (or (not org-use-fast-todo-selection)
12567 (not org-todo-key-trigger)))
12568 ;; Read a state with completion
12569 (org-icompleting-read
12570 "State: " (mapcar 'list org-todo-keywords-1)
12571 nil t))
12572 ((eq arg 'right)
12573 (if this
12574 (if tail (car tail) nil)
12575 (car org-todo-keywords-1)))
12576 ((eq arg 'left)
12577 (if (equal member org-todo-keywords-1)
12579 (if this
12580 (nth (- (length org-todo-keywords-1)
12581 (length tail) 2)
12582 org-todo-keywords-1)
12583 (org-last org-todo-keywords-1))))
12584 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12585 (setq arg nil))) ; hack to fall back to cycling
12586 (arg
12587 ;; user or caller requests a specific state
12588 (cond
12589 ((equal arg "") nil)
12590 ((eq arg 'none) nil)
12591 ((eq arg 'done) (or done-word (car org-done-keywords)))
12592 ((eq arg 'nextset)
12593 (or (car (cdr (member head org-todo-heads)))
12594 (car org-todo-heads)))
12595 ((eq arg 'previousset)
12596 (let ((org-todo-heads (reverse org-todo-heads)))
12597 (or (car (cdr (member head org-todo-heads)))
12598 (car org-todo-heads))))
12599 ((car (member arg org-todo-keywords-1)))
12600 ((stringp arg)
12601 (user-error "State `%s' not valid in this file" arg))
12602 ((nth (1- (prefix-numeric-value arg))
12603 org-todo-keywords-1))))
12604 ((null member) (or head (car org-todo-keywords-1)))
12605 ((equal this final-done-word) nil) ;; -> make empty
12606 ((null tail) nil) ;; -> first entry
12607 ((memq interpret '(type priority))
12608 (if (eq this-command last-command)
12609 (car tail)
12610 (if (> (length tail) 0)
12611 (or done-word (car org-done-keywords))
12612 nil)))
12614 (car tail))))
12615 (org-state (or
12616 (run-hook-with-args-until-success
12617 'org-todo-get-default-hook org-state org-last-state)
12618 org-state))
12619 (next (if org-state (concat " " org-state " ") " "))
12620 (change-plist (list :type 'todo-state-change :from this :to org-state
12621 :position startpos))
12622 dolog now-done-p)
12623 (when org-blocker-hook
12624 (setq org-last-todo-state-is-todo
12625 (not (member this org-done-keywords)))
12626 (unless (save-excursion
12627 (save-match-data
12628 (org-with-wide-buffer
12629 (run-hook-with-args-until-failure
12630 'org-blocker-hook change-plist))))
12631 (if (org-called-interactively-p 'interactive)
12632 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12633 this org-state org-block-entry-blocking)
12634 ;; fail silently
12635 (message "TODO state change from %s to %s blocked (by \"%s\")"
12636 this org-state org-block-entry-blocking)
12637 (throw 'exit nil))))
12638 (store-match-data match-data)
12639 (replace-match next t t)
12640 (cond ((equal this org-state)
12641 (message "TODO state was already %s" (org-trim next)))
12642 ((pos-visible-in-window-p hl-pos)
12643 (message "TODO state changed to %s" (org-trim next))))
12644 (unless head
12645 (setq head (org-get-todo-sequence-head org-state)
12646 ass (assoc head org-todo-kwd-alist)
12647 interpret (nth 1 ass)
12648 done-word (nth 3 ass)
12649 final-done-word (nth 4 ass)))
12650 (when (memq arg '(nextset previousset))
12651 (message "Keyword-Set %d/%d: %s"
12652 (- (length org-todo-sets) -1
12653 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12654 (length org-todo-sets)
12655 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12656 (setq org-last-todo-state-is-todo
12657 (not (member org-state org-done-keywords)))
12658 (setq now-done-p (and (member org-state org-done-keywords)
12659 (not (member this org-done-keywords))))
12660 (and logging (org-local-logging logging))
12661 (when (and (or org-todo-log-states org-log-done)
12662 (not (eq org-inhibit-logging t))
12663 (not (memq arg '(nextset previousset))))
12664 ;; we need to look at recording a time and note
12665 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12666 (nth 2 (assoc this org-todo-log-states))))
12667 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12668 (setq dolog 'time))
12669 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12670 (and org-state
12671 (member org-state org-not-done-keywords)
12672 (not (member this org-not-done-keywords))))
12673 ;; This is now a todo state and was not one before
12674 ;; If there was a CLOSED time stamp, get rid of it.
12675 (org-add-planning-info nil nil 'closed))
12676 (when (and now-done-p org-log-done)
12677 ;; It is now done, and it was not done before
12678 (org-add-planning-info 'closed (org-current-effective-time))
12679 (if (and (not dolog) (eq 'note org-log-done))
12680 (org-add-log-setup 'done org-state this 'findpos 'note)))
12681 (when (and org-state dolog)
12682 ;; This is a non-nil state, and we need to log it
12683 (org-add-log-setup 'state org-state this 'findpos dolog)))
12684 ;; Fixup tag positioning
12685 (org-todo-trigger-tag-changes org-state)
12686 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12687 (when org-provide-todo-statistics
12688 (org-update-parent-todo-statistics))
12689 (run-hooks 'org-after-todo-state-change-hook)
12690 (if (and arg (not (member org-state org-done-keywords)))
12691 (setq head (org-get-todo-sequence-head org-state)))
12692 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12693 ;; Do we need to trigger a repeat?
12694 (when now-done-p
12695 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12696 ;; This is for the agenda, take a snapshot of the headline.
12697 (save-match-data
12698 (setq org-agenda-headline-snapshot-before-repeat
12699 (org-get-heading))))
12700 (org-auto-repeat-maybe org-state))
12701 ;; Fixup cursor location if close to the keyword
12702 (if (and (outline-on-heading-p)
12703 (not (bolp))
12704 (save-excursion (beginning-of-line 1)
12705 (looking-at org-todo-line-regexp))
12706 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12707 (progn
12708 (goto-char (or (match-end 2) (match-end 1)))
12709 (and (looking-at " ") (just-one-space))))
12710 (when org-trigger-hook
12711 (save-excursion
12712 (run-hook-with-args 'org-trigger-hook change-plist)))
12713 (when commentp (org-toggle-comment))))))))
12715 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12716 "Block turning an entry into a TODO, using the hierarchy.
12717 This checks whether the current task should be blocked from state
12718 changes. Such blocking occurs when:
12720 1. The task has children which are not all in a completed state.
12722 2. A task has a parent with the property :ORDERED:, and there
12723 are siblings prior to the current task with incomplete
12724 status.
12726 3. The parent of the task is blocked because it has siblings that should
12727 be done first, or is child of a block grandparent TODO entry."
12729 (if (not org-enforce-todo-dependencies)
12730 t ; if locally turned off don't block
12731 (catch 'dont-block
12732 ;; If this is not a todo state change, or if this entry is already DONE,
12733 ;; do not block
12734 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12735 (member (plist-get change-plist :from)
12736 (cons 'done org-done-keywords))
12737 (member (plist-get change-plist :to)
12738 (cons 'todo org-not-done-keywords))
12739 (not (plist-get change-plist :to)))
12740 (throw 'dont-block t))
12741 ;; If this task has children, and any are undone, it's blocked
12742 (save-excursion
12743 (org-back-to-heading t)
12744 (let ((this-level (funcall outline-level)))
12745 (outline-next-heading)
12746 (let ((child-level (funcall outline-level)))
12747 (while (and (not (eobp))
12748 (> child-level this-level))
12749 ;; this todo has children, check whether they are all
12750 ;; completed
12751 (if (and (not (org-entry-is-done-p))
12752 (org-entry-is-todo-p))
12753 (progn (setq org-block-entry-blocking (org-get-heading))
12754 (throw 'dont-block nil)))
12755 (outline-next-heading)
12756 (setq child-level (funcall outline-level))))))
12757 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12758 ;; any previous siblings are undone, it's blocked
12759 (save-excursion
12760 (org-back-to-heading t)
12761 (let* ((pos (point))
12762 (parent-pos (and (org-up-heading-safe) (point))))
12763 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12764 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12765 (forward-line 1)
12766 (re-search-forward org-not-done-heading-regexp pos t))
12767 (setq org-block-entry-blocking (match-string 0))
12768 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12769 ;; Search further up the hierarchy, to see if an ancestor is blocked
12770 (while t
12771 (goto-char parent-pos)
12772 (if (not (looking-at org-not-done-heading-regexp))
12773 (throw 'dont-block t)) ; do not block, parent is not a TODO
12774 (setq pos (point))
12775 (setq parent-pos (and (org-up-heading-safe) (point)))
12776 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12777 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12778 (forward-line 1)
12779 (re-search-forward org-not-done-heading-regexp pos t)
12780 (setq org-block-entry-blocking (org-get-heading)))
12781 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12783 (defcustom org-track-ordered-property-with-tag nil
12784 "Should the ORDERED property also be shown as a tag?
12785 The ORDERED property decides if an entry should require subtasks to be
12786 completed in sequence. Since a property is not very visible, setting
12787 this option means that toggling the ORDERED property with the command
12788 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12789 not relevant for the behavior, but it makes things more visible.
12791 Note that toggling the tag with tags commands will not change the property
12792 and therefore not influence behavior!
12794 This can be t, meaning the tag ORDERED should be used, It can also be a
12795 string to select a different tag for this task."
12796 :group 'org-todo
12797 :type '(choice
12798 (const :tag "No tracking" nil)
12799 (const :tag "Track with ORDERED tag" t)
12800 (string :tag "Use other tag")))
12802 (defun org-toggle-ordered-property ()
12803 "Toggle the ORDERED property of the current entry.
12804 For better visibility, you can track the value of this property with a tag.
12805 See variable `org-track-ordered-property-with-tag'."
12806 (interactive)
12807 (let* ((t1 org-track-ordered-property-with-tag)
12808 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12809 (save-excursion
12810 (org-back-to-heading)
12811 (if (org-entry-get nil "ORDERED")
12812 (progn
12813 (org-delete-property "ORDERED")
12814 (and tag (org-toggle-tag tag 'off))
12815 (message "Subtasks can be completed in arbitrary order"))
12816 (org-entry-put nil "ORDERED" "t")
12817 (and tag (org-toggle-tag tag 'on))
12818 (message "Subtasks must be completed in sequence")))))
12820 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12821 (defun org-block-todo-from-checkboxes (change-plist)
12822 "Block turning an entry into a TODO, using checkboxes.
12823 This checks whether the current task should be blocked from state
12824 changes because there are unchecked boxes in this entry."
12825 (if (not org-enforce-todo-checkbox-dependencies)
12826 t ; if locally turned off don't block
12827 (catch 'dont-block
12828 ;; If this is not a todo state change, or if this entry is already DONE,
12829 ;; do not block
12830 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12831 (member (plist-get change-plist :from)
12832 (cons 'done org-done-keywords))
12833 (member (plist-get change-plist :to)
12834 (cons 'todo org-not-done-keywords))
12835 (not (plist-get change-plist :to)))
12836 (throw 'dont-block t))
12837 ;; If this task has checkboxes that are not checked, it's blocked
12838 (save-excursion
12839 (org-back-to-heading t)
12840 (let ((beg (point)) end)
12841 (outline-next-heading)
12842 (setq end (point))
12843 (goto-char beg)
12844 (if (org-list-search-forward
12845 (concat (org-item-beginning-re)
12846 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12847 "\\[[- ]\\]")
12848 end t)
12849 (progn
12850 (if (boundp 'org-blocked-by-checkboxes)
12851 (setq org-blocked-by-checkboxes t))
12852 (throw 'dont-block nil)))))
12853 t))) ; do not block
12855 (defun org-entry-blocked-p ()
12856 "Non-nil if entry at point is blocked."
12857 (and (not (org-entry-get nil "NOBLOCKING"))
12858 (member (org-entry-get nil "TODO") org-not-done-keywords)
12859 (not (run-hook-with-args-until-failure
12860 'org-blocker-hook
12861 (list :type 'todo-state-change
12862 :position (point)
12863 :from 'todo
12864 :to 'done)))))
12866 (defun org-update-statistics-cookies (all)
12867 "Update the statistics cookie, either from TODO or from checkboxes.
12868 This should be called with the cursor in a line with a statistics cookie."
12869 (interactive "P")
12870 (if all
12871 (progn
12872 (org-update-checkbox-count 'all)
12873 (org-map-entries 'org-update-parent-todo-statistics))
12874 (if (not (org-at-heading-p))
12875 (org-update-checkbox-count)
12876 (let ((pos (point-marker))
12877 end l1 l2)
12878 (ignore-errors (org-back-to-heading t))
12879 (if (not (org-at-heading-p))
12880 (org-update-checkbox-count)
12881 (setq l1 (org-outline-level))
12882 (setq end (save-excursion
12883 (outline-next-heading)
12884 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12885 (point)))
12886 (if (and (save-excursion
12887 (re-search-forward
12888 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12889 (not (save-excursion (re-search-forward
12890 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12891 (org-update-checkbox-count)
12892 (if (and l2 (> l2 l1))
12893 (progn
12894 (goto-char end)
12895 (org-update-parent-todo-statistics))
12896 (goto-char pos)
12897 (beginning-of-line 1)
12898 (while (re-search-forward
12899 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12900 (point-at-eol) t)
12901 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12902 (goto-char pos)
12903 (move-marker pos nil)))))
12905 (defvar org-entry-property-inherited-from) ;; defined below
12906 (defun org-update-parent-todo-statistics ()
12907 "Update any statistics cookie in the parent of the current headline.
12908 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12909 the entire subtree and this will travel up the hierarchy and update
12910 statistics everywhere."
12911 (let* ((prop (save-excursion (org-up-heading-safe)
12912 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12913 (recursive (or (not org-hierarchical-todo-statistics)
12914 (and prop (string-match "\\<recursive\\>" prop))))
12915 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12917 (first t)
12918 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12919 level ltoggle l1 new ndel
12920 (cnt-all 0) (cnt-done 0) is-percent kwd
12921 checkbox-beg ov ovs ove cookie-present)
12922 (catch 'exit
12923 (save-excursion
12924 (beginning-of-line 1)
12925 (setq ltoggle (funcall outline-level))
12926 ;; Three situations are to consider:
12928 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12929 ;; to the top-level ancestor on the headline;
12931 ;; 2. If parent has "recursive" property, repeat up to the
12932 ;; headline setting that property, taking inheritance into
12933 ;; account;
12935 ;; 3. Else, move up to direct parent and proceed only once.
12936 (while (and (setq level (org-up-heading-safe))
12937 (or recursive first)
12938 (>= (point) lim))
12939 (setq first nil cookie-present nil)
12940 (unless (and level
12941 (not (string-match
12942 "\\<checkbox\\>"
12943 (downcase (or (org-entry-get nil "COOKIE_DATA")
12944 "")))))
12945 (throw 'exit nil))
12946 (while (re-search-forward box-re (point-at-eol) t)
12947 (setq cnt-all 0 cnt-done 0 cookie-present t)
12948 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12949 (save-match-data
12950 (unless (outline-next-heading) (throw 'exit nil))
12951 (while (and (looking-at org-complex-heading-regexp)
12952 (> (setq l1 (length (match-string 1))) level))
12953 (setq kwd (and (or recursive (= l1 ltoggle))
12954 (match-string 2)))
12955 (if (or (eq org-provide-todo-statistics 'all-headlines)
12956 (and (eq org-provide-todo-statistics t)
12957 (or (member kwd org-done-keywords)))
12958 (and (listp org-provide-todo-statistics)
12959 (stringp (car org-provide-todo-statistics))
12960 (or (member kwd org-provide-todo-statistics)
12961 (member kwd org-done-keywords)))
12962 (and (listp org-provide-todo-statistics)
12963 (listp (car org-provide-todo-statistics))
12964 (or (member kwd (car org-provide-todo-statistics))
12965 (and (member kwd org-done-keywords)
12966 (member kwd (cadr org-provide-todo-statistics))))))
12967 (setq cnt-all (1+ cnt-all))
12968 (if (eq org-provide-todo-statistics t)
12969 (and kwd (setq cnt-all (1+ cnt-all)))))
12970 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12971 (member kwd org-done-keywords))
12972 (and (listp org-provide-todo-statistics)
12973 (listp (car org-provide-todo-statistics))
12974 (member kwd org-done-keywords)
12975 (member kwd (cadr org-provide-todo-statistics)))
12976 (and (listp org-provide-todo-statistics)
12977 (stringp (car org-provide-todo-statistics))
12978 (member kwd org-done-keywords)))
12979 (setq cnt-done (1+ cnt-done)))
12980 (outline-next-heading)))
12981 (setq new
12982 (if is-percent
12983 (format "[%d%%]" (floor (* 100.0 cnt-done)
12984 (max 1 cnt-all)))
12985 (format "[%d/%d]" cnt-done cnt-all))
12986 ndel (- (match-end 0) checkbox-beg))
12987 ;; handle overlays when updating cookie from column view
12988 (when (setq ov (car (overlays-at checkbox-beg)))
12989 (setq ovs (overlay-start ov) ove (overlay-end ov))
12990 (delete-overlay ov))
12991 (goto-char checkbox-beg)
12992 (insert new)
12993 (delete-region (point) (+ (point) ndel))
12994 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12995 (when ov (move-overlay ov ovs ove)))
12996 (when cookie-present
12997 (run-hook-with-args 'org-after-todo-statistics-hook
12998 cnt-done (- cnt-all cnt-done))))))
12999 (run-hooks 'org-todo-statistics-hook)))
13001 (defvar org-after-todo-statistics-hook nil
13002 "Hook that is called after a TODO statistics cookie has been updated.
13003 Each function is called with two arguments: the number of not-done entries
13004 and the number of done entries.
13006 For example, the following function, when added to this hook, will switch
13007 an entry to DONE when all children are done, and back to TODO when new
13008 entries are set to a TODO status. Note that this hook is only called
13009 when there is a statistics cookie in the headline!
13011 (defun org-summary-todo (n-done n-not-done)
13012 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13013 (let (org-log-done org-log-states) ; turn off logging
13014 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13017 (defvar org-todo-statistics-hook nil
13018 "Hook that is run whenever Org thinks TODO statistics should be updated.
13019 This hook runs even if there is no statistics cookie present, in which case
13020 `org-after-todo-statistics-hook' would not run.")
13022 (defun org-todo-trigger-tag-changes (state)
13023 "Apply the changes defined in `org-todo-state-tags-triggers'."
13024 (let ((l org-todo-state-tags-triggers)
13025 changes)
13026 (when (or (not state) (equal state ""))
13027 (setq changes (append changes (cdr (assoc "" l)))))
13028 (when (and (stringp state) (> (length state) 0))
13029 (setq changes (append changes (cdr (assoc state l)))))
13030 (when (member state org-not-done-keywords)
13031 (setq changes (append changes (cdr (assoc 'todo l)))))
13032 (when (member state org-done-keywords)
13033 (setq changes (append changes (cdr (assoc 'done l)))))
13034 (dolist (c changes)
13035 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13037 (defun org-local-logging (value)
13038 "Get logging settings from a property VALUE."
13039 ;; Directly set the variables, they are already local.
13040 (setq org-log-done nil
13041 org-log-repeat nil
13042 org-todo-log-states nil)
13043 (dolist (w (org-split-string value))
13044 (let (a)
13045 (cond
13046 ((setq a (assoc w org-startup-options))
13047 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13048 (set (nth 1 a) (nth 2 a))))
13049 ((setq a (org-extract-log-state-settings w))
13050 (and (member (car a) org-todo-keywords-1)
13051 (push a org-todo-log-states)))))))
13053 (defun org-get-todo-sequence-head (kwd)
13054 "Return the head of the TODO sequence to which KWD belongs.
13055 If KWD is not set, check if there is a text property remembering the
13056 right sequence."
13057 (let (p)
13058 (cond
13059 ((not kwd)
13060 (or (get-text-property (point-at-bol) 'org-todo-head)
13061 (progn
13062 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13063 nil (point-at-eol)))
13064 (get-text-property p 'org-todo-head))))
13065 ((not (member kwd org-todo-keywords-1))
13066 (car org-todo-keywords-1))
13067 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13069 (defun org-fast-todo-selection ()
13070 "Fast TODO keyword selection with single keys.
13071 Returns the new TODO keyword, or nil if no state change should occur."
13072 (let* ((fulltable org-todo-key-alist)
13073 (done-keywords org-done-keywords) ;; needed for the faces.
13074 (maxlen (apply 'max (mapcar
13075 (lambda (x)
13076 (if (stringp (car x)) (string-width (car x)) 0))
13077 fulltable)))
13078 (expert nil)
13079 (fwidth (+ maxlen 3 1 3))
13080 (ncol (/ (- (window-width) 4) fwidth))
13081 tg cnt e c tbl
13082 groups ingroup)
13083 (save-excursion
13084 (save-window-excursion
13085 (if expert
13086 (set-buffer (get-buffer-create " *Org todo*"))
13087 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13088 (erase-buffer)
13089 (org-set-local 'org-done-keywords done-keywords)
13090 (setq tbl fulltable cnt 0)
13091 (while (setq e (pop tbl))
13092 (cond
13093 ((equal e '(:startgroup))
13094 (push '() groups) (setq ingroup t)
13095 (when (not (= cnt 0))
13096 (setq cnt 0)
13097 (insert "\n"))
13098 (insert "{ "))
13099 ((equal e '(:endgroup))
13100 (setq ingroup nil cnt 0)
13101 (insert "}\n"))
13102 ((equal e '(:newline))
13103 (when (not (= cnt 0))
13104 (setq cnt 0)
13105 (insert "\n")
13106 (setq e (car tbl))
13107 (while (equal (car tbl) '(:newline))
13108 (insert "\n")
13109 (setq tbl (cdr tbl)))))
13111 (setq tg (car e) c (cdr e))
13112 (if ingroup (push tg (car groups)))
13113 (setq tg (org-add-props tg nil 'face
13114 (org-get-todo-face tg)))
13115 (if (and (= cnt 0) (not ingroup)) (insert " "))
13116 (insert "[" c "] " tg (make-string
13117 (- fwidth 4 (length tg)) ?\ ))
13118 (when (= (setq cnt (1+ cnt)) ncol)
13119 (insert "\n")
13120 (if ingroup (insert " "))
13121 (setq cnt 0)))))
13122 (insert "\n")
13123 (goto-char (point-min))
13124 (if (not expert) (org-fit-window-to-buffer))
13125 (message "[a-z..]:Set [SPC]:clear")
13126 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13127 (cond
13128 ((or (= c ?\C-g)
13129 (and (= c ?q) (not (rassoc c fulltable))))
13130 (setq quit-flag t))
13131 ((= c ?\ ) nil)
13132 ((setq e (rassoc c fulltable) tg (car e))
13134 (t (setq quit-flag t)))))))
13136 (defun org-entry-is-todo-p ()
13137 (member (org-get-todo-state) org-not-done-keywords))
13139 (defun org-entry-is-done-p ()
13140 (member (org-get-todo-state) org-done-keywords))
13142 (defun org-get-todo-state ()
13143 "Return the TODO keyword of the current subtree."
13144 (save-excursion
13145 (org-back-to-heading t)
13146 (and (looking-at org-todo-line-regexp)
13147 (match-end 2)
13148 (match-string 2))))
13150 (defun org-at-date-range-p (&optional inactive-ok)
13151 "Non-nil if point is inside a date range.
13153 When optional argument INACTIVE-OK is non-nil, also consider
13154 inactive time ranges.
13156 When this function returns a non-nil value, match data is set
13157 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13158 on INACTIVE-OK."
13159 (interactive)
13160 (save-excursion
13161 (catch 'exit
13162 (let ((pos (point)))
13163 (skip-chars-backward "^[<\r\n")
13164 (skip-chars-backward "<[")
13165 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13166 (>= (match-end 0) pos)
13167 (throw 'exit t))
13168 (skip-chars-backward "^<[\r\n")
13169 (skip-chars-backward "<[")
13170 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13171 (>= (match-end 0) pos)
13172 (throw 'exit t)))
13173 nil)))
13175 (defun org-get-repeat (&optional tagline)
13176 "Check if there is a deadline/schedule with repeater in this entry."
13177 (save-match-data
13178 (save-excursion
13179 (org-back-to-heading t)
13180 (and (re-search-forward (if tagline
13181 (concat tagline "\\s-*" org-repeat-re)
13182 org-repeat-re)
13183 (org-entry-end-position) t)
13184 (match-string-no-properties 1)))))
13186 (defvar org-last-changed-timestamp)
13187 (defvar org-last-inserted-timestamp)
13188 (defvar org-log-post-message)
13189 (defvar org-log-note-purpose)
13190 (defvar org-log-note-how nil)
13191 (defvar org-log-note-extra)
13192 (defun org-auto-repeat-maybe (done-word)
13193 "Check if the current headline contains a repeated deadline/schedule.
13194 If yes, set TODO state back to what it was and change the base date
13195 of repeating deadline/scheduled time stamps to new date.
13196 This function is run automatically after each state change to a DONE state."
13197 ;; last-state is dynamically scoped into this function
13198 (let* ((repeat (org-get-repeat))
13199 (aa (assoc org-last-state org-todo-kwd-alist))
13200 (interpret (nth 1 aa))
13201 (head (nth 2 aa))
13202 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13203 (msg "Entry repeats: ")
13204 (org-log-done nil)
13205 (org-todo-log-states nil)
13206 re type n what ts time to-state)
13207 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13208 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13209 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13210 org-todo-repeat-to-state))
13211 (unless (and to-state (member to-state org-todo-keywords-1))
13212 (setq to-state (if (eq interpret 'type) org-last-state head)))
13213 (org-todo to-state)
13214 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13215 (org-entry-put nil "LAST_REPEAT" (format-time-string
13216 (org-time-stamp-format t t))))
13217 (when org-log-repeat
13218 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13219 (memq 'org-add-log-note post-command-hook))
13220 ;; OK, we are already setup for some record
13221 (if (eq org-log-repeat 'note)
13222 ;; make sure we take a note, not only a time stamp
13223 (setq org-log-note-how 'note))
13224 ;; Set up for taking a record
13225 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13226 org-last-state
13227 'findpos org-log-repeat)))
13228 (org-back-to-heading t)
13229 (org-add-planning-info nil nil 'closed)
13230 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13231 org-deadline-time-regexp "\\)\\|\\("
13232 org-ts-regexp "\\)"))
13233 (while (re-search-forward
13234 re (save-excursion (outline-next-heading) (point)) t)
13235 (setq type (if (match-end 1) org-scheduled-string
13236 (if (match-end 3) org-deadline-string "Plain:"))
13237 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13238 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13239 (setq n (string-to-number (match-string 2 ts))
13240 what (match-string 3 ts))
13241 (if (equal what "w") (setq n (* n 7) what "d"))
13242 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13243 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13244 ;; Preparation, see if we need to modify the start date for the change
13245 (when (match-end 1)
13246 (setq time (save-match-data (org-time-string-to-time ts)))
13247 (cond
13248 ((equal (match-string 1 ts) ".")
13249 ;; Shift starting date to today
13250 (org-timestamp-change
13251 (- (org-today) (time-to-days time))
13252 'day))
13253 ((equal (match-string 1 ts) "+")
13254 (let ((nshiftmax 10) (nshift 0))
13255 (while (or (= nshift 0)
13256 (<= (time-to-days time)
13257 (time-to-days (current-time))))
13258 (when (= (incf nshift) nshiftmax)
13259 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13260 (user-error "Abort")))
13261 (org-timestamp-change n (cdr (assoc what whata)))
13262 (org-at-timestamp-p t)
13263 (setq ts (match-string 1))
13264 (setq time (save-match-data (org-time-string-to-time ts)))))
13265 (org-timestamp-change (- n) (cdr (assoc what whata)))
13266 ;; rematch, so that we have everything in place for the real shift
13267 (org-at-timestamp-p t)
13268 (setq ts (match-string 1))
13269 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13270 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13271 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13272 (setq org-log-post-message msg)
13273 (message "%s" msg))))
13275 (defun org-show-todo-tree (arg)
13276 "Make a compact tree which shows all headlines marked with TODO.
13277 The tree will show the lines where the regexp matches, and all higher
13278 headlines above the match.
13279 With a \\[universal-argument] prefix, prompt for a regexp to match.
13280 With a numeric prefix N, construct a sparse tree for the Nth element
13281 of `org-todo-keywords-1'."
13282 (interactive "P")
13283 (let ((case-fold-search nil)
13284 (kwd-re
13285 (cond ((null arg) org-not-done-regexp)
13286 ((equal arg '(4))
13287 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13288 (mapcar 'list org-todo-keywords-1))))
13289 (concat "\\("
13290 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13291 "\\)\\>")))
13292 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13293 (regexp-quote (nth (1- (prefix-numeric-value arg))
13294 org-todo-keywords-1)))
13295 (t (user-error "Invalid prefix argument: %s" arg)))))
13296 (message "%d TODO entries found"
13297 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13299 (defun org-deadline (arg &optional time)
13300 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13301 With one universal prefix argument, remove any deadline from the item.
13302 With two universal prefix arguments, prompt for a warning delay.
13303 With argument TIME, set the deadline at the corresponding date. TIME
13304 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13305 (interactive "P")
13306 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13307 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13308 'region-start-level 'region))
13309 org-loop-over-headlines-in-active-region)
13310 (org-map-entries
13311 `(org-deadline ',arg ,time)
13312 org-loop-over-headlines-in-active-region
13313 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13314 (let* ((old-date (org-entry-get nil "DEADLINE"))
13315 (old-date-time (if old-date (org-time-string-to-time old-date)))
13316 (repeater (and old-date
13317 (string-match
13318 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13319 old-date)
13320 (match-string 1 old-date))))
13321 (cond
13322 ((equal arg '(4))
13323 (when (and old-date org-log-redeadline)
13324 (org-add-log-setup 'deldeadline nil old-date 'findpos
13325 org-log-redeadline))
13326 (org-remove-timestamp-with-keyword org-deadline-string)
13327 (message "Item no longer has a deadline."))
13328 ((equal arg '(16))
13329 (save-excursion
13330 (org-back-to-heading t)
13331 (if (re-search-forward
13332 org-deadline-time-regexp
13333 (save-excursion (outline-next-heading) (point)) t)
13334 (let* ((rpl0 (match-string 1))
13335 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13336 (replace-match
13337 (concat org-deadline-string
13338 " <" rpl
13339 (format " -%dd"
13340 (abs
13341 (- (time-to-days
13342 (save-match-data
13343 (org-read-date nil t nil "Warn starting from" old-date-time)))
13344 (time-to-days old-date-time))))
13345 ">") t t))
13346 (user-error "No deadline information to update"))))
13348 (org-add-planning-info 'deadline time 'closed)
13349 (when (and old-date
13350 org-log-redeadline
13351 (not (equal old-date org-last-inserted-timestamp)))
13352 (org-add-log-setup
13353 'redeadline org-last-inserted-timestamp old-date 'findpos
13354 org-log-redeadline))
13355 (when repeater
13356 (save-excursion
13357 (org-back-to-heading t)
13358 (when (re-search-forward (concat org-deadline-string " "
13359 org-last-inserted-timestamp)
13360 (save-excursion
13361 (outline-next-heading) (point)) t)
13362 (goto-char (1- (match-end 0)))
13363 (insert " " repeater)
13364 (setq org-last-inserted-timestamp
13365 (concat (substring org-last-inserted-timestamp 0 -1)
13366 " " repeater
13367 (substring org-last-inserted-timestamp -1))))))
13368 (message "Deadline on %s" org-last-inserted-timestamp))))))
13370 (defun org-schedule (arg &optional time)
13371 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13372 With one universal prefix argument, remove any scheduling date from the item.
13373 With two universal prefix arguments, prompt for a delay cookie.
13374 With argument TIME, scheduled at the corresponding date. TIME can
13375 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13376 (interactive "P")
13377 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13378 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13379 'region-start-level 'region))
13380 org-loop-over-headlines-in-active-region)
13381 (org-map-entries
13382 `(org-schedule ',arg ,time)
13383 org-loop-over-headlines-in-active-region
13384 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13385 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13386 (old-date-time (if old-date (org-time-string-to-time old-date)))
13387 (repeater (and old-date
13388 (string-match
13389 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13390 old-date)
13391 (match-string 1 old-date))))
13392 (cond
13393 ((equal arg '(4))
13394 (progn
13395 (when (and old-date org-log-reschedule)
13396 (org-add-log-setup 'delschedule nil old-date 'findpos
13397 org-log-reschedule))
13398 (org-remove-timestamp-with-keyword org-scheduled-string)
13399 (message "Item is no longer scheduled.")))
13400 ((equal arg '(16))
13401 (save-excursion
13402 (org-back-to-heading t)
13403 (if (re-search-forward
13404 org-scheduled-time-regexp
13405 (save-excursion (outline-next-heading) (point)) t)
13406 (let* ((rpl0 (match-string 1))
13407 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13408 (replace-match
13409 (concat org-scheduled-string
13410 " <" rpl
13411 (format " -%dd"
13412 (abs
13413 (- (time-to-days
13414 (save-match-data
13415 (org-read-date nil t nil "Delay until" old-date-time)))
13416 (time-to-days old-date-time))))
13417 ">") t t))
13418 (user-error "No scheduled information to update"))))
13420 (org-add-planning-info 'scheduled time 'closed)
13421 (when (and old-date
13422 org-log-reschedule
13423 (not (equal old-date org-last-inserted-timestamp)))
13424 (org-add-log-setup
13425 'reschedule org-last-inserted-timestamp old-date 'findpos
13426 org-log-reschedule))
13427 (when repeater
13428 (save-excursion
13429 (org-back-to-heading t)
13430 (when (re-search-forward (concat org-scheduled-string " "
13431 org-last-inserted-timestamp)
13432 (save-excursion
13433 (outline-next-heading) (point)) t)
13434 (goto-char (1- (match-end 0)))
13435 (insert " " repeater)
13436 (setq org-last-inserted-timestamp
13437 (concat (substring org-last-inserted-timestamp 0 -1)
13438 " " repeater
13439 (substring org-last-inserted-timestamp -1))))))
13440 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13442 (defun org-get-scheduled-time (pom &optional inherit)
13443 "Get the scheduled time as a time tuple, of a format suitable
13444 for calling org-schedule with, or if there is no scheduling,
13445 returns nil."
13446 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13447 (when time
13448 (apply 'encode-time (org-parse-time-string time)))))
13450 (defun org-get-deadline-time (pom &optional inherit)
13451 "Get the deadline as a time tuple, of a format suitable for
13452 calling org-deadline with, or if there is no scheduling, returns
13453 nil."
13454 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13455 (when time
13456 (apply 'encode-time (org-parse-time-string time)))))
13458 (defun org-remove-timestamp-with-keyword (keyword)
13459 "Remove all time stamps with KEYWORD in the current entry."
13460 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13461 beg)
13462 (save-excursion
13463 (org-back-to-heading t)
13464 (setq beg (point))
13465 (outline-next-heading)
13466 (while (re-search-backward re beg t)
13467 (replace-match "")
13468 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13469 (equal (char-before) ?\ ))
13470 (backward-delete-char 1)
13471 (if (string-match "^[ \t]*$" (buffer-substring
13472 (point-at-bol) (point-at-eol)))
13473 (delete-region (point-at-bol)
13474 (min (point-max) (1+ (point-at-eol))))))))))
13476 (defvar org-time-was-given) ; dynamically scoped parameter
13477 (defvar org-end-time-was-given) ; dynamically scoped parameter
13479 (defun org-at-planning-p ()
13480 "Non-nil when point is on a planning info line."
13481 ;; This is as accurate and faster than `org-element-at-point' since
13482 ;; planning info location is fixed in the section.
13483 (org-with-wide-buffer
13484 (beginning-of-line)
13485 (and (org-looking-at-p org-planning-line-re)
13486 (eq (point)
13487 (ignore-errors
13488 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13489 (org-back-to-heading t)
13490 (org-with-limited-levels (org-back-to-heading t)))
13491 (line-beginning-position 2))))))
13493 (defun org-add-planning-info (what &optional time &rest remove)
13494 "Insert new timestamp with keyword in the planning line.
13495 WHAT indicates what kind of time stamp to add. It is a symbol
13496 among `closed', `deadline', `scheduled' and nil. TIME indicates
13497 the time to use. If none is given, the user is prompted for
13498 a date. REMOVE indicates what kind of entries to remove. An old
13499 WHAT entry will also be removed."
13500 (let (org-time-was-given org-end-time-was-given default-time default-input)
13501 (catch 'exit
13502 (when (and (memq what '(scheduled deadline))
13503 (or (not time)
13504 (and (stringp time)
13505 (string-match "^[-+]+[0-9]" time))))
13506 ;; Try to get a default date/time from existing timestamp
13507 (save-excursion
13508 (org-back-to-heading t)
13509 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13510 (when (re-search-forward (if (eq what 'scheduled)
13511 org-scheduled-time-regexp
13512 org-deadline-time-regexp)
13513 end t)
13514 (setq ts (match-string 1)
13515 default-time (apply 'encode-time (org-parse-time-string ts))
13516 default-input (and ts (org-get-compact-tod ts)))))))
13517 (when what
13518 (setq time
13519 (if (stringp time)
13520 ;; This is a string (relative or absolute), set
13521 ;; proper date.
13522 (apply #'encode-time
13523 (org-read-date-analyze
13524 time default-time (decode-time default-time)))
13525 ;; If necessary, get the time from the user
13526 (or time (org-read-date nil 'to-time nil nil
13527 default-time default-input)))))
13529 (org-with-wide-buffer
13530 (org-back-to-heading t)
13531 (forward-line)
13532 (unless (bolp) (insert "\n"))
13533 (cond ((org-looking-at-p org-planning-line-re)
13534 ;; Move to current indentation.
13535 (skip-chars-forward " \t")
13536 ;; Check if we have to remove something.
13537 (dolist (type (if what (cons what remove) remove))
13538 (save-excursion
13539 (when (re-search-forward
13540 (case type
13541 (closed org-closed-time-regexp)
13542 (deadline org-deadline-time-regexp)
13543 (scheduled org-scheduled-time-regexp)
13544 (otherwise
13545 (error "Invalid planning type: %s" type)))
13546 (line-end-position) t)
13547 ;; Delete until next keyword or end of line.
13548 (delete-region
13549 (match-beginning 0)
13550 (if (re-search-forward org-keyword-time-not-clock-regexp
13551 (line-end-position)
13553 (match-beginning 0)
13554 (line-end-position))))))
13555 ;; If there is nothing more to add and no more keyword
13556 ;; is left, remove the line completely.
13557 (if (and (org-looking-at-p "[ \t]*$") (not what))
13558 (delete-region (line-beginning-position)
13559 (line-beginning-position 2))
13560 ;; If we removed last keyword, do not leave trailing
13561 ;; white space at the end of line.
13562 (let ((p (point)))
13563 (save-excursion
13564 (end-of-line)
13565 (unless (= (skip-chars-backward " \t" p) 0)
13566 (delete-region (point) (line-end-position)))))))
13567 ((not what) (throw 'exit nil)) ; Nothing to do.
13568 (t (insert-before-markers "\n")
13569 (backward-char 1)
13570 (when org-adapt-indentation
13571 (org-indent-to-column (1+ (org-outline-level))))))
13572 (when what
13573 ;; Insert planning keyword.
13574 (insert (case what
13575 (closed org-closed-string)
13576 (deadline org-deadline-string)
13577 (scheduled org-scheduled-string)
13578 (otherwise (error "Invalid planning type: %s" what)))
13579 " ")
13580 ;; Insert associated timestamp.
13581 (let ((ts (org-insert-time-stamp
13582 time
13583 (or org-time-was-given
13584 (and (eq what 'closed) org-log-done-with-time))
13585 (eq what 'closed)
13586 nil nil (list org-end-time-was-given))))
13587 (unless (eolp) (insert " "))
13588 ts))))))
13590 (defvar org-log-note-marker (make-marker))
13591 (defvar org-log-note-purpose nil)
13592 (defvar org-log-note-state nil)
13593 (defvar org-log-note-previous-state nil)
13594 (defvar org-log-note-extra nil)
13595 (defvar org-log-note-window-configuration nil)
13596 (defvar org-log-note-return-to (make-marker))
13597 (defvar org-log-note-effective-time nil
13598 "Remembered current time so that dynamically scoped
13599 `org-extend-today-until' affects tha timestamps in state change
13600 log")
13602 (defvar org-log-post-message nil
13603 "Message to be displayed after a log note has been stored.
13604 The auto-repeater uses this.")
13606 (defun org-add-note ()
13607 "Add a note to the current entry.
13608 This is done in the same way as adding a state change note."
13609 (interactive)
13610 (org-add-log-setup 'note nil nil 'findpos nil))
13612 (defun org-log-beginning (&optional create)
13613 "Return expected start of log notes in current entry.
13614 When optional argument CREATE is non-nil, the function creates
13615 a drawer to store notes, if necessary. Returned position ignores
13616 narrowing."
13617 (org-with-wide-buffer
13618 (org-end-of-meta-data)
13619 (let ((end (if (org-at-heading-p) (point)
13620 (save-excursion (outline-next-heading) (point))))
13621 (drawer (org-log-into-drawer)))
13622 (cond
13623 (drawer
13624 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13625 (case-fold-search t))
13626 (catch 'exit
13627 ;; Try to find existing drawer.
13628 (while (re-search-forward regexp end t)
13629 (let ((element (org-element-at-point)))
13630 (when (eq (org-element-type element) 'drawer)
13631 (let ((cend (org-element-property :contents-end element)))
13632 (when (and (not org-log-states-order-reversed) cend)
13633 (goto-char cend)))
13634 (throw 'exit nil))))
13635 ;; No drawer found. Create one, if permitted.
13636 (when create
13637 (unless (bolp) (insert "\n"))
13638 (let ((beg (point)))
13639 (insert ":" drawer ":\n:END:\n")
13640 (org-indent-region beg (point)))
13641 (end-of-line -1)))))
13642 (org-log-state-notes-insert-after-drawers
13643 (while (and (looking-at org-drawer-regexp)
13644 (progn (goto-char (match-end 0))
13645 (re-search-forward org-property-end-re end t)))
13646 (forward-line)))))
13647 (if (bolp) (point) (line-beginning-position 2))))
13649 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13650 "Set up the post command hook to take a note.
13651 If this is about to TODO state change, the new state is expected in STATE.
13652 When FINDPOS is non-nil, find the correct position for the note in
13653 the current entry. If not, assume that it can be inserted at point.
13654 HOW is an indicator what kind of note should be created.
13655 EXTRA is additional text that will be inserted into the notes buffer."
13656 (org-with-wide-buffer
13657 (when findpos
13658 (goto-char (org-log-beginning t))
13659 (unless org-log-states-order-reversed
13660 (org-skip-over-state-notes)
13661 (skip-chars-backward " \t\n\r")
13662 (forward-line)))
13663 (move-marker org-log-note-marker (point))
13664 ;; Preserve position even if a property drawer is inserted in the
13665 ;; process.
13666 (set-marker-insertion-type org-log-note-marker t)
13667 (setq org-log-note-purpose purpose
13668 org-log-note-state state
13669 org-log-note-previous-state prev-state
13670 org-log-note-how how
13671 org-log-note-extra extra
13672 org-log-note-effective-time (org-current-effective-time))
13673 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13675 (defun org-skip-over-state-notes ()
13676 "Skip past the list of State notes in an entry."
13677 (when (ignore-errors (goto-char (org-in-item-p)))
13678 (let* ((struct (org-list-struct))
13679 (prevs (org-list-prevs-alist struct))
13680 (regexp
13681 (concat "[ \t]*- +"
13682 (replace-regexp-in-string
13683 " +" " +"
13684 (org-replace-escapes
13685 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13686 `(("%d" . ,org-ts-regexp-inactive)
13687 ("%D" . ,org-ts-regexp)
13688 ("%s" . "\"\\S-+\"")
13689 ("%S" . "\"\\S-+\"")
13690 ("%t" . ,org-ts-regexp-inactive)
13691 ("%T" . ,org-ts-regexp)
13692 ("%u" . ".*?")
13693 ("%U" . ".*?")))))))
13694 (while (org-looking-at-p regexp)
13695 (goto-char (or (org-list-get-next-item (point) struct prevs)
13696 (org-list-get-item-end (point) struct)))))))
13698 (defun org-add-log-note (&optional purpose)
13699 "Pop up a window for taking a note, and add this note later at point."
13700 (remove-hook 'post-command-hook 'org-add-log-note)
13701 (setq org-log-note-window-configuration (current-window-configuration))
13702 (delete-other-windows)
13703 (move-marker org-log-note-return-to (point))
13704 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13705 (goto-char org-log-note-marker)
13706 (org-switch-to-buffer-other-window "*Org Note*")
13707 (erase-buffer)
13708 (if (memq org-log-note-how '(time state))
13709 (let (current-prefix-arg) (org-store-log-note))
13710 (let ((org-inhibit-startup t)) (org-mode))
13711 (insert (format "# Insert note for %s.
13712 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13713 (cond
13714 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13715 ((eq org-log-note-purpose 'done) "closed todo item")
13716 ((eq org-log-note-purpose 'state)
13717 (format "state change from \"%s\" to \"%s\""
13718 (or org-log-note-previous-state "")
13719 (or org-log-note-state "")))
13720 ((eq org-log-note-purpose 'reschedule)
13721 "rescheduling")
13722 ((eq org-log-note-purpose 'delschedule)
13723 "no longer scheduled")
13724 ((eq org-log-note-purpose 'redeadline)
13725 "changing deadline")
13726 ((eq org-log-note-purpose 'deldeadline)
13727 "removing deadline")
13728 ((eq org-log-note-purpose 'refile)
13729 "refiling")
13730 ((eq org-log-note-purpose 'note)
13731 "this entry")
13732 (t (error "This should not happen")))))
13733 (if org-log-note-extra (insert org-log-note-extra))
13734 (org-set-local 'org-finish-function 'org-store-log-note)
13735 (run-hooks 'org-log-buffer-setup-hook)))
13737 (defvar org-note-abort nil) ; dynamically scoped
13738 (defun org-store-log-note ()
13739 "Finish taking a log note, and insert it to where it belongs."
13740 (let ((txt (buffer-string)))
13741 (kill-buffer (current-buffer))
13742 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13743 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13744 (setq txt (replace-match "" t t txt)))
13745 (if (string-match "\\s-+\\'" txt)
13746 (setq txt (replace-match "" t t txt)))
13747 (setq lines (org-split-string txt "\n"))
13748 (when (and note (string-match "\\S-" note))
13749 (setq note
13750 (org-replace-escapes
13751 note
13752 (list (cons "%u" (user-login-name))
13753 (cons "%U" user-full-name)
13754 (cons "%t" (format-time-string
13755 (org-time-stamp-format 'long 'inactive)
13756 org-log-note-effective-time))
13757 (cons "%T" (format-time-string
13758 (org-time-stamp-format 'long nil)
13759 org-log-note-effective-time))
13760 (cons "%d" (format-time-string
13761 (org-time-stamp-format nil 'inactive)
13762 org-log-note-effective-time))
13763 (cons "%D" (format-time-string
13764 (org-time-stamp-format nil nil)
13765 org-log-note-effective-time))
13766 (cons "%s" (cond
13767 ((not org-log-note-state) "")
13768 ((org-string-match-p org-ts-regexp
13769 org-log-note-state)
13770 (format "\"[%s]\""
13771 (substring org-log-note-state 1 -1)))
13772 (t (format "\"%s\"" org-log-note-state))))
13773 (cons "%S"
13774 (cond
13775 ((not org-log-note-previous-state) "")
13776 ((org-string-match-p org-ts-regexp
13777 org-log-note-previous-state)
13778 (format "\"[%s]\""
13779 (substring
13780 org-log-note-previous-state 1 -1)))
13781 (t (format "\"%s\""
13782 org-log-note-previous-state)))))))
13783 (when lines (setq note (concat note " \\\\")))
13784 (push note lines))
13785 (when (or current-prefix-arg org-note-abort)
13786 (when (org-log-into-drawer)
13787 (org-remove-empty-drawer-at org-log-note-marker))
13788 (setq lines nil))
13789 (when lines
13790 (with-current-buffer (marker-buffer org-log-note-marker)
13791 (org-with-wide-buffer
13792 (goto-char org-log-note-marker)
13793 (move-marker org-log-note-marker nil)
13794 ;; Make sure point is at the beginning of an empty line.
13795 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13796 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13797 ;; In an existing list, add a new item at the top level.
13798 ;; Otherwise, indent line like a regular one.
13799 (let ((itemp (org-in-item-p)))
13800 (if itemp
13801 (org-indent-line-to
13802 (let ((struct (save-excursion
13803 (goto-char itemp) (org-list-struct))))
13804 (org-list-get-ind (org-list-get-top-point struct) struct)))
13805 (org-indent-line)))
13806 (insert (org-list-bullet-string "-") (pop lines))
13807 (let ((ind (org-list-item-body-column (line-beginning-position))))
13808 (dolist (line lines)
13809 (insert "\n")
13810 (org-indent-line-to ind)
13811 (insert line)))
13812 (message "Note stored")
13813 (org-back-to-heading t)
13814 (org-cycle-hide-drawers 'children))
13815 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13816 ;; from within `org-add-log-note' because `buffer-undo-list'
13817 ;; is then modified outside of `org-with-remote-undo'.
13818 (when (eq this-command 'org-agenda-todo)
13819 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13820 ;; Don't add undo information when called from `org-agenda-todo'
13821 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13822 (set-window-configuration org-log-note-window-configuration)
13823 (with-current-buffer (marker-buffer org-log-note-return-to)
13824 (goto-char org-log-note-return-to))
13825 (move-marker org-log-note-return-to nil)
13826 (and org-log-post-message (message "%s" org-log-post-message))))
13828 (defun org-remove-empty-drawer-at (pos)
13829 "Remove an empty drawer at position POS.
13830 POS may also be a marker."
13831 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13832 (org-with-wide-buffer
13833 (goto-char pos)
13834 (let ((drawer (org-element-at-point)))
13835 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13836 (not (org-element-property :contents-begin drawer)))
13837 (delete-region (org-element-property :begin drawer)
13838 (progn (goto-char (org-element-property :end drawer))
13839 (skip-chars-backward " \r\t\n")
13840 (forward-line)
13841 (point))))))))
13843 (defvar org-ts-type nil)
13844 (defun org-sparse-tree (&optional arg type)
13845 "Create a sparse tree, prompt for the details.
13846 This command can create sparse trees. You first need to select the type
13847 of match used to create the tree:
13849 t Show all TODO entries.
13850 T Show entries with a specific TODO keyword.
13851 m Show entries selected by a tags/property match.
13852 p Enter a property name and its value (both with completion on existing
13853 names/values) and show entries with that property.
13854 r Show entries matching a regular expression (`/' can be used as well).
13855 b Show deadlines and scheduled items before a date.
13856 a Show deadlines and scheduled items after a date.
13857 d Show deadlines due within `org-deadline-warning-days'.
13858 D Show deadlines and scheduled items between a date range."
13859 (interactive "P")
13860 (setq type (or type org-sparse-tree-default-date-type))
13861 (setq org-ts-type type)
13862 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13863 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13864 [c]ycle through date types: %s"
13865 (case type
13866 (all "all timestamps")
13867 (scheduled "only scheduled")
13868 (deadline "only deadline")
13869 (active "only active timestamps")
13870 (inactive "only inactive timestamps")
13871 (closed "with a closed time-stamp")
13872 (otherwise "scheduled/deadline")))
13873 (let ((answer (read-char-exclusive)))
13874 (case answer
13876 (org-sparse-tree
13878 (cadr
13879 (memq type '(nil all scheduled deadline active inactive closed)))))
13880 (?d (call-interactively 'org-check-deadlines))
13881 (?b (call-interactively 'org-check-before-date))
13882 (?a (call-interactively 'org-check-after-date))
13883 (?D (call-interactively 'org-check-dates-range))
13884 (?t (call-interactively 'org-show-todo-tree))
13885 (?T (org-show-todo-tree '(4)))
13886 (?m (call-interactively 'org-match-sparse-tree))
13887 ((?p ?P)
13888 (let* ((kwd (org-icompleting-read
13889 "Property: " (mapcar 'list (org-buffer-property-keys))))
13890 (value (org-icompleting-read
13891 "Value: " (mapcar 'list (org-property-values kwd)))))
13892 (unless (string-match "\\`{.*}\\'" value)
13893 (setq value (concat "\"" value "\"")))
13894 (org-match-sparse-tree arg (concat kwd "=" value))))
13895 ((?r ?R ?/) (call-interactively 'org-occur))
13896 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13898 (defvar org-occur-highlights nil
13899 "List of overlays used for occur matches.")
13900 (make-variable-buffer-local 'org-occur-highlights)
13901 (defvar org-occur-parameters nil
13902 "Parameters of the active org-occur calls.
13903 This is a list, each call to org-occur pushes as cons cell,
13904 containing the regular expression and the callback, onto the list.
13905 The list can contain several entries if `org-occur' has been called
13906 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13907 will only contain one set of parameters. When the highlights are
13908 removed (for example with `C-c C-c', or with the next edit (depending
13909 on `org-remove-highlights-with-change'), this variable is emptied
13910 as well.")
13911 (make-variable-buffer-local 'org-occur-parameters)
13913 (defun org-occur (regexp &optional keep-previous callback)
13914 "Make a compact tree which shows all matches of REGEXP.
13915 The tree will show the lines where the regexp matches, and all higher
13916 headlines above the match. It will also show the heading after the match,
13917 to make sure editing the matching entry is easy.
13918 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13919 call to `org-occur' will be kept, to allow stacking of calls to this
13920 command.
13921 If CALLBACK is non-nil, it is a function which is called to confirm
13922 that the match should indeed be shown."
13923 (interactive "sRegexp: \nP")
13924 (when (equal regexp "")
13925 (user-error "Regexp cannot be empty"))
13926 (unless keep-previous
13927 (org-remove-occur-highlights nil nil t))
13928 (push (cons regexp callback) org-occur-parameters)
13929 (let ((cnt 0))
13930 (save-excursion
13931 (goto-char (point-min))
13932 (if (or (not keep-previous) ; do not want to keep
13933 (not org-occur-highlights)) ; no previous matches
13934 ;; hide everything
13935 (org-overview))
13936 (while (re-search-forward regexp nil t)
13937 (backward-char) ;; FIXME: Match timestamps at the end of a headline
13938 (when (or (not callback)
13939 (save-match-data (funcall callback)))
13940 (setq cnt (1+ cnt))
13941 (when org-highlight-sparse-tree-matches
13942 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13943 (org-show-context 'occur-tree))))
13944 (when org-remove-highlights-with-change
13945 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13946 nil 'local))
13947 (unless org-sparse-tree-open-archived-trees
13948 (org-hide-archived-subtrees (point-min) (point-max)))
13949 (run-hooks 'org-occur-hook)
13950 (if (org-called-interactively-p 'interactive)
13951 (message "%d match(es) for regexp %s" cnt regexp))
13952 cnt))
13954 (defun org-occur-next-match (&optional n reset)
13955 "Function for `next-error-function' to find sparse tree matches.
13956 N is the number of matches to move, when negative move backwards.
13957 RESET is entirely ignored - this function always goes back to the
13958 starting point when no match is found."
13959 (let* ((limit (if (< n 0) (point-min) (point-max)))
13960 (search-func (if (< n 0)
13961 'previous-single-char-property-change
13962 'next-single-char-property-change))
13963 (n (abs n))
13964 (pos (point))
13966 (catch 'exit
13967 (while (setq p1 (funcall search-func (point) 'org-type))
13968 (when (equal p1 limit)
13969 (goto-char pos)
13970 (user-error "No more matches"))
13971 (when (equal (get-char-property p1 'org-type) 'org-occur)
13972 (setq n (1- n))
13973 (when (= n 0)
13974 (goto-char p1)
13975 (throw 'exit (point))))
13976 (goto-char p1))
13977 (goto-char p1)
13978 (user-error "No more matches"))))
13980 (defun org-show-context (&optional key)
13981 "Make sure point and context are visible.
13982 Optional argument KEY, when non-nil, is a symbol. See
13983 `org-show-context-detail' for allowed values and how much is to
13984 be shown."
13985 (org-show-set-visibility
13986 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13987 ((cdr (assq key org-show-context-detail)))
13988 (t (cdr (assq 'default org-show-context-detail))))))
13990 (defun org-show-set-visibility (detail)
13991 "Set visibility around point according to DETAIL.
13992 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13993 `tree', `canonical' or t. See `org-show-context-detail' for more
13994 information."
13995 (unless (org-before-first-heading-p)
13996 ;; Show current heading and possibly its entry, following headline
13997 ;; or all children.
13998 (if (and (org-at-heading-p) (not (eq detail 'local)))
13999 (org-flag-heading nil)
14000 (org-show-entry)
14001 (org-with-limited-levels
14002 (case detail
14003 ((tree canonical t) (outline-show-children))
14004 ((nil minimal ancestors))
14005 (t (save-excursion
14006 (outline-next-heading)
14007 (org-flag-heading nil))))))
14008 ;; Show all siblings.
14009 (when (eq detail 'lineage) (org-show-siblings))
14010 ;; Show ancestors, possibly with their children.
14011 (when (memq detail '(ancestors lineage tree canonical t))
14012 (save-excursion
14013 (while (org-up-heading-safe)
14014 (org-flag-heading nil)
14015 (when (memq detail '(canonical t)) (org-show-entry))
14016 (when (memq detail '(tree canonical t)) (outline-show-children)))))))
14018 (defvar org-reveal-start-hook nil
14019 "Hook run before revealing a location.")
14021 (defun org-reveal (&optional siblings)
14022 "Show current entry, hierarchy above it, and the following headline.
14024 This can be used to show a consistent set of context around
14025 locations exposed with `org-show-context'.
14027 With optional argument SIBLINGS, on each level of the hierarchy all
14028 siblings are shown. This repairs the tree structure to what it would
14029 look like when opened with hierarchical calls to `org-cycle'.
14031 With double optional argument \\[universal-argument] \\[universal-argument], \
14032 go to the parent and show the
14033 entire tree."
14034 (interactive "P")
14035 (run-hooks 'org-reveal-start-hook)
14036 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14037 ((equal siblings '(16))
14038 (save-excursion
14039 (when (org-up-heading-safe)
14040 (org-show-subtree)
14041 (run-hook-with-args 'org-cycle-hook 'subtree))))
14042 (t (org-show-set-visibility 'lineage))))
14044 (defun org-highlight-new-match (beg end)
14045 "Highlight from BEG to END and mark the highlight is an occur headline."
14046 (let ((ov (make-overlay beg end)))
14047 (overlay-put ov 'face 'secondary-selection)
14048 (overlay-put ov 'org-type 'org-occur)
14049 (push ov org-occur-highlights)))
14051 (defun org-remove-occur-highlights (&optional beg end noremove)
14052 "Remove the occur highlights from the buffer.
14053 BEG and END are ignored. If NOREMOVE is nil, remove this function
14054 from the `before-change-functions' in the current buffer."
14055 (interactive)
14056 (unless org-inhibit-highlight-removal
14057 (mapc 'delete-overlay org-occur-highlights)
14058 (setq org-occur-highlights nil)
14059 (setq org-occur-parameters nil)
14060 (unless noremove
14061 (remove-hook 'before-change-functions
14062 'org-remove-occur-highlights 'local))))
14064 ;;;; Priorities
14066 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14067 "Regular expression matching the priority indicator.")
14069 (defvar org-remove-priority-next-time nil)
14071 (defun org-priority-up ()
14072 "Increase the priority of the current item."
14073 (interactive)
14074 (org-priority 'up))
14076 (defun org-priority-down ()
14077 "Decrease the priority of the current item."
14078 (interactive)
14079 (org-priority 'down))
14081 (defun org-priority (&optional action show)
14082 "Change the priority of an item.
14083 ACTION can be `set', `up', `down', or a character."
14084 (interactive "P")
14085 (if (equal action '(4))
14086 (org-show-priority)
14087 (unless org-enable-priority-commands
14088 (user-error "Priority commands are disabled"))
14089 (setq action (or action 'set))
14090 (let (current new news have remove)
14091 (save-excursion
14092 (org-back-to-heading t)
14093 (if (looking-at org-priority-regexp)
14094 (setq current (string-to-char (match-string 2))
14095 have t))
14096 (cond
14097 ((eq action 'remove)
14098 (setq remove t new ?\ ))
14099 ((or (eq action 'set)
14100 (if (featurep 'xemacs) (characterp action) (integerp action)))
14101 (if (not (eq action 'set))
14102 (setq new action)
14103 (message "Priority %c-%c, SPC to remove: "
14104 org-highest-priority org-lowest-priority)
14105 (save-match-data
14106 (setq new (read-char-exclusive))))
14107 (if (and (= (upcase org-highest-priority) org-highest-priority)
14108 (= (upcase org-lowest-priority) org-lowest-priority))
14109 (setq new (upcase new)))
14110 (cond ((equal new ?\ ) (setq remove t))
14111 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14112 (user-error "Priority must be between `%c' and `%c'"
14113 org-highest-priority org-lowest-priority))))
14114 ((eq action 'up)
14115 (setq new (if have
14116 (1- current) ; normal cycling
14117 ;; last priority was empty
14118 (if (eq last-command this-command)
14119 org-lowest-priority ; wrap around empty to lowest
14120 ;; default
14121 (if org-priority-start-cycle-with-default
14122 org-default-priority
14123 (1- org-default-priority))))))
14124 ((eq action 'down)
14125 (setq new (if have
14126 (1+ current) ; normal cycling
14127 ;; last priority was empty
14128 (if (eq last-command this-command)
14129 org-highest-priority ; wrap around empty to highest
14130 ;; default
14131 (if org-priority-start-cycle-with-default
14132 org-default-priority
14133 (1+ org-default-priority))))))
14134 (t (user-error "Invalid action")))
14135 (if (or (< (upcase new) org-highest-priority)
14136 (> (upcase new) org-lowest-priority))
14137 (if (and (memq action '(up down))
14138 (not have) (not (eq last-command this-command)))
14139 ;; `new' is from default priority
14140 (error
14141 "The default can not be set, see `org-default-priority' why")
14142 ;; normal cycling: `new' is beyond highest/lowest priority
14143 ;; and is wrapped around to the empty priority
14144 (setq remove t)))
14145 (setq news (format "%c" new))
14146 (if have
14147 (if remove
14148 (replace-match "" t t nil 1)
14149 (replace-match news t t nil 2))
14150 (if remove
14151 (user-error "No priority cookie found in line")
14152 (let ((case-fold-search nil))
14153 (looking-at org-todo-line-regexp))
14154 (if (match-end 2)
14155 (progn
14156 (goto-char (match-end 2))
14157 (insert " [#" news "]"))
14158 (goto-char (match-beginning 3))
14159 (insert "[#" news "] "))))
14160 (org-set-tags nil 'align))
14161 (if remove
14162 (message "Priority removed")
14163 (message "Priority of current item set to %s" news)))))
14165 (defun org-show-priority ()
14166 "Show the priority of the current item.
14167 This priority is composed of the main priority given with the [#A] cookies,
14168 and by additional input from the age of a schedules or deadline entry."
14169 (interactive)
14170 (let ((pri (if (eq major-mode 'org-agenda-mode)
14171 (org-get-at-bol 'priority)
14172 (save-excursion
14173 (save-match-data
14174 (beginning-of-line)
14175 (and (looking-at org-heading-regexp)
14176 (org-get-priority (match-string 0))))))))
14177 (message "Priority is %d" (if pri pri -1000))))
14179 (defun org-get-priority (s)
14180 "Find priority cookie and return priority."
14181 (save-match-data
14182 (if (functionp org-get-priority-function)
14183 (funcall org-get-priority-function)
14184 (if (not (string-match org-priority-regexp s))
14185 (* 1000 (- org-lowest-priority org-default-priority))
14186 (* 1000 (- org-lowest-priority
14187 (string-to-char (match-string 2 s))))))))
14189 ;;;; Tags
14191 (defvar org-agenda-archives-mode)
14192 (defvar org-map-continue-from nil
14193 "Position from where mapping should continue.
14194 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14196 (defvar org-scanner-tags nil
14197 "The current tag list while the tags scanner is running.")
14198 (defvar org-trust-scanner-tags nil
14199 "Should `org-get-tags-at' use the tags for the scanner.
14200 This is for internal dynamical scoping only.
14201 When this is non-nil, the function `org-get-tags-at' will return the value
14202 of `org-scanner-tags' instead of building the list by itself. This
14203 can lead to large speed-ups when the tags scanner is used in a file with
14204 many entries, and when the list of tags is retrieved, for example to
14205 obtain a list of properties. Building the tags list for each entry in such
14206 a file becomes an N^2 operation - but with this variable set, it scales
14207 as N.")
14209 (defun org-scan-tags (action matcher todo-only &optional start-level)
14210 "Scan headline tags with inheritance and produce output ACTION.
14212 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14213 or `agenda' to produce an entry list for an agenda view. It can also be
14214 a Lisp form or a function that should be called at each matched headline, in
14215 this case the return value is a list of all return values from these calls.
14217 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14218 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14219 only lines with a not-done TODO keyword are included in the output.
14220 This should be the same variable that was scoped into
14221 and set by `org-make-tags-matcher' when it constructed MATCHER.
14223 START-LEVEL can be a string with asterisks, reducing the scope to
14224 headlines matching this string."
14225 (require 'org-agenda)
14226 (let* ((re (concat "^"
14227 (if start-level
14228 ;; Get the correct level to match
14229 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14230 org-outline-regexp)
14231 " *\\(\\<\\("
14232 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14233 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14234 (props (list 'face 'default
14235 'done-face 'org-agenda-done
14236 'undone-face 'default
14237 'mouse-face 'highlight
14238 'org-not-done-regexp org-not-done-regexp
14239 'org-todo-regexp org-todo-regexp
14240 'org-complex-heading-regexp org-complex-heading-regexp
14241 'help-echo
14242 (format "mouse-2 or RET jump to org file %s"
14243 (abbreviate-file-name
14244 (or (buffer-file-name (buffer-base-buffer))
14245 (buffer-name (buffer-base-buffer)))))))
14246 (org-map-continue-from nil)
14247 lspos tags tags-list
14248 (tags-alist (list (cons 0 org-file-tags)))
14249 (llast 0) rtn rtn1 level category i txt
14250 todo marker entry priority
14251 ts-date ts-date-type ts-date-pair)
14252 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14253 (setq action (list 'lambda nil action)))
14254 (save-excursion
14255 (goto-char (point-min))
14256 (when (eq action 'sparse-tree)
14257 (org-overview)
14258 (org-remove-occur-highlights))
14259 (while (let (case-fold-search)
14260 (re-search-forward re nil t))
14261 (setq org-map-continue-from nil)
14262 (catch :skip
14263 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14264 tags (if (match-end 4) (org-match-string-no-properties 4)))
14265 (goto-char (setq lspos (match-beginning 0)))
14266 (setq level (org-reduced-level (org-outline-level))
14267 category (org-get-category))
14268 (when (eq action 'agenda)
14269 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14270 ts-date (car ts-date-pair)
14271 ts-date-type (cdr ts-date-pair)))
14272 (setq i llast llast level)
14273 ;; remove tag lists from same and sublevels
14274 (while (>= i level)
14275 (when (setq entry (assoc i tags-alist))
14276 (setq tags-alist (delete entry tags-alist)))
14277 (setq i (1- i)))
14278 ;; add the next tags
14279 (when tags
14280 (setq tags (org-split-string tags ":")
14281 tags-alist
14282 (cons (cons level tags) tags-alist)))
14283 ;; compile tags for current headline
14284 (setq tags-list
14285 (if org-use-tag-inheritance
14286 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14287 tags)
14288 org-scanner-tags tags-list)
14289 (when org-use-tag-inheritance
14290 (setcdr (car tags-alist)
14291 (mapcar (lambda (x)
14292 (setq x (copy-sequence x))
14293 (org-add-prop-inherited x))
14294 (cdar tags-alist))))
14295 (when (and tags org-use-tag-inheritance
14296 (or (not (eq t org-use-tag-inheritance))
14297 org-tags-exclude-from-inheritance))
14298 ;; selective inheritance, remove uninherited ones
14299 (setcdr (car tags-alist)
14300 (org-remove-uninherited-tags (cdar tags-alist))))
14301 (when (and
14303 ;; eval matcher only when the todo condition is OK
14304 (and (or (not todo-only) (member todo org-not-done-keywords))
14305 (let ((case-fold-search t) (org-trust-scanner-tags t))
14306 (eval matcher)))
14308 ;; Call the skipper, but return t if it does not skip,
14309 ;; so that the `and' form continues evaluating
14310 (progn
14311 (unless (eq action 'sparse-tree) (org-agenda-skip))
14314 ;; Check if timestamps are deselecting this entry
14315 (or (not todo-only)
14316 (and (member todo org-not-done-keywords)
14317 (or (not org-agenda-tags-todo-honor-ignore-options)
14318 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14320 ;; select this headline
14321 (cond
14322 ((eq action 'sparse-tree)
14323 (and org-highlight-sparse-tree-matches
14324 (org-get-heading) (match-end 0)
14325 (org-highlight-new-match
14326 (match-beginning 1) (match-end 1)))
14327 (org-show-context 'tags-tree))
14328 ((eq action 'agenda)
14329 (setq txt (org-agenda-format-item
14331 (concat
14332 (if (eq org-tags-match-list-sublevels 'indented)
14333 (make-string (1- level) ?.) "")
14334 (org-get-heading))
14335 (make-string level ?\s)
14336 category
14337 tags-list)
14338 priority (org-get-priority txt))
14339 (goto-char lspos)
14340 (setq marker (org-agenda-new-marker))
14341 (org-add-props txt props
14342 'org-marker marker 'org-hd-marker marker 'org-category category
14343 'todo-state todo
14344 'ts-date ts-date
14345 'priority priority
14346 'type (concat "tagsmatch" ts-date-type))
14347 (push txt rtn))
14348 ((functionp action)
14349 (setq org-map-continue-from nil)
14350 (save-excursion
14351 (setq rtn1 (funcall action))
14352 (push rtn1 rtn)))
14353 (t (user-error "Invalid action")))
14355 ;; if we are to skip sublevels, jump to end of subtree
14356 (unless org-tags-match-list-sublevels
14357 (org-end-of-subtree t)
14358 (backward-char 1))))
14359 ;; Get the correct position from where to continue
14360 (if org-map-continue-from
14361 (goto-char org-map-continue-from)
14362 (and (= (point) lspos) (end-of-line 1)))))
14363 (when (and (eq action 'sparse-tree)
14364 (not org-sparse-tree-open-archived-trees))
14365 (org-hide-archived-subtrees (point-min) (point-max)))
14366 (nreverse rtn)))
14368 (defun org-remove-uninherited-tags (tags)
14369 "Remove all tags that are not inherited from the list TAGS."
14370 (cond
14371 ((eq org-use-tag-inheritance t)
14372 (if org-tags-exclude-from-inheritance
14373 (org-delete-all org-tags-exclude-from-inheritance tags)
14374 tags))
14375 ((not org-use-tag-inheritance) nil)
14376 ((stringp org-use-tag-inheritance)
14377 (delq nil (mapcar
14378 (lambda (x)
14379 (if (and (string-match org-use-tag-inheritance x)
14380 (not (member x org-tags-exclude-from-inheritance)))
14381 x nil))
14382 tags)))
14383 ((listp org-use-tag-inheritance)
14384 (delq nil (mapcar
14385 (lambda (x)
14386 (if (member x org-use-tag-inheritance) x nil))
14387 tags)))))
14389 (defun org-match-sparse-tree (&optional todo-only match)
14390 "Create a sparse tree according to tags string MATCH.
14391 MATCH can contain positive and negative selection of tags, like
14392 \"+WORK+URGENT-WITHBOSS\".
14393 If optional argument TODO-ONLY is non-nil, only select lines that are
14394 also TODO lines."
14395 (interactive "P")
14396 (org-agenda-prepare-buffers (list (current-buffer)))
14397 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14399 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14401 (defvar org-cached-props nil)
14402 (defun org-cached-entry-get (pom property)
14403 (if (or (eq t org-use-property-inheritance)
14404 (and (stringp org-use-property-inheritance)
14405 (let ((case-fold-search t))
14406 (org-string-match-p org-use-property-inheritance property)))
14407 (and (listp org-use-property-inheritance)
14408 (member-ignore-case property org-use-property-inheritance)))
14409 ;; Caching is not possible, check it directly.
14410 (org-entry-get pom property 'inherit)
14411 ;; Get all properties, so we can do complicated checks easily.
14412 (cdr (assoc-string property
14413 (or org-cached-props
14414 (setq org-cached-props (org-entry-properties pom)))
14415 t))))
14417 (defun org-global-tags-completion-table (&optional files)
14418 "Return the list of all tags in all agenda buffer/files.
14419 Optional FILES argument is a list of files which can be used
14420 instead of the agenda files."
14421 (save-excursion
14422 (org-uniquify
14423 (delq nil
14424 (apply 'append
14425 (mapcar
14426 (lambda (file)
14427 (set-buffer (find-file-noselect file))
14428 (append (org-get-buffer-tags)
14429 (mapcar (lambda (x) (if (stringp (car-safe x))
14430 (list (car-safe x)) nil))
14431 org-tag-alist)))
14432 (if (and files (car files))
14433 files
14434 (org-agenda-files))))))))
14436 (defun org-make-tags-matcher (match)
14437 "Create the TAGS/TODO matcher form for the selection string MATCH.
14439 The variable `todo-only' is scoped dynamically into this function.
14440 It will be set to t if the matcher restricts matching to TODO entries,
14441 otherwise will not be touched.
14443 Returns a cons of the selection string MATCH and the constructed
14444 lisp form implementing the matcher. The matcher is to be evaluated
14445 at an Org entry, with point on the headline, and returns t if the
14446 entry matches the selection string MATCH. The returned lisp form
14447 references two variables with information about the entry, which
14448 must be bound around the form's evaluation: todo, the TODO keyword
14449 at the entry (or nil of none); and tags-list, the list of all tags
14450 at the entry including inherited ones. Additionally, the category
14451 of the entry (if any) must be specified as the text property
14452 `org-category' on the headline.
14454 See also `org-scan-tags'.
14456 (declare (special todo-only))
14457 (unless (boundp 'todo-only)
14458 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14459 (unless match
14460 ;; Get a new match request, with completion against the global
14461 ;; tags table and the local tags in current buffer
14462 (let ((org-last-tags-completion-table
14463 (org-uniquify
14464 (delq nil (append (org-get-buffer-tags)
14465 (org-global-tags-completion-table))))))
14466 (setq match (org-completing-read-no-i
14467 "Match: " 'org-tags-completion-function nil nil nil
14468 'org-tags-history))))
14470 ;; Parse the string and create a lisp form
14471 (let ((match0 match)
14472 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14473 minus tag mm
14474 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14475 orterms term orlist re-p str-p level-p level-op time-p
14476 prop-p pn pv po gv rest (start 0) (ss 0))
14477 ;; Expand group tags
14478 (setq match (org-tags-expand match))
14480 ;; Check if there is a TODO part of this match, which would be the
14481 ;; part after a "/". TO make sure that this slash is not part of
14482 ;; a property value to be matched against, we also check that there
14483 ;; is no " after that slash.
14484 ;; First, find the last slash
14485 (while (string-match "/+" match ss)
14486 (setq start (match-beginning 0) ss (match-end 0)))
14487 (if (and (string-match "/+" match start)
14488 (not (save-match-data (string-match "\"" match start))))
14489 ;; match contains also a todo-matching request
14490 (progn
14491 (setq tagsmatch (substring match 0 (match-beginning 0))
14492 todomatch (substring match (match-end 0)))
14493 (if (string-match "^!" todomatch)
14494 (setq todo-only t todomatch (substring todomatch 1)))
14495 (if (string-match "^\\s-*$" todomatch)
14496 (setq todomatch nil)))
14497 ;; only matching tags
14498 (setq tagsmatch match todomatch nil))
14500 ;; Make the tags matcher
14501 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14502 (setq tagsmatcher t)
14503 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14504 (while (setq term (pop orterms))
14505 (while (and (equal (substring term -1) "\\") orterms)
14506 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14507 (while (string-match re term)
14508 (setq rest (substring term (match-end 0))
14509 minus (and (match-end 1)
14510 (equal (match-string 1 term) "-"))
14511 tag (save-match-data (replace-regexp-in-string
14512 "\\\\-" "-"
14513 (match-string 2 term)))
14514 re-p (equal (string-to-char tag) ?{)
14515 level-p (match-end 4)
14516 prop-p (match-end 5)
14517 mm (cond
14518 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14519 (level-p
14520 (setq level-op (org-op-to-function (match-string 3 term)))
14521 `(,level-op level ,(string-to-number
14522 (match-string 4 term))))
14523 (prop-p
14524 (setq pn (match-string 5 term)
14525 po (match-string 6 term)
14526 pv (match-string 7 term)
14527 re-p (equal (string-to-char pv) ?{)
14528 str-p (equal (string-to-char pv) ?\")
14529 time-p (save-match-data
14530 (string-match "^\"[[<].*[]>]\"$" pv))
14531 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14532 (if time-p (setq pv (org-matcher-time pv)))
14533 (setq po (org-op-to-function po (if time-p 'time str-p)))
14534 (cond
14535 ((equal pn "CATEGORY")
14536 (setq gv '(get-text-property (point) 'org-category)))
14537 ((equal pn "TODO")
14538 (setq gv 'todo))
14540 (setq gv `(org-cached-entry-get nil ,pn))))
14541 (if re-p
14542 (if (eq po 'org<>)
14543 `(not (string-match ,pv (or ,gv "")))
14544 `(string-match ,pv (or ,gv "")))
14545 (if str-p
14546 `(,po (or ,gv "") ,pv)
14547 `(,po (string-to-number (or ,gv ""))
14548 ,(string-to-number pv) ))))
14549 (t `(member ,tag tags-list)))
14550 mm (if minus (list 'not mm) mm)
14551 term rest)
14552 (push mm tagsmatcher))
14553 (push (if (> (length tagsmatcher) 1)
14554 (cons 'and tagsmatcher)
14555 (car tagsmatcher))
14556 orlist)
14557 (setq tagsmatcher nil))
14558 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14559 (setq tagsmatcher
14560 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14561 ;; Make the todo matcher
14562 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14563 (setq todomatcher t)
14564 (setq orterms (org-split-string todomatch "|") orlist nil)
14565 (dolist (term orterms)
14566 (while (string-match re term)
14567 (setq minus (and (match-end 1)
14568 (equal (match-string 1 term) "-"))
14569 kwd (match-string 2 term)
14570 re-p (equal (string-to-char kwd) ?{)
14571 term (substring term (match-end 0))
14572 mm (if re-p
14573 `(string-match ,(substring kwd 1 -1) todo)
14574 (list 'equal 'todo kwd))
14575 mm (if minus (list 'not mm) mm))
14576 (push mm todomatcher))
14577 (push (if (> (length todomatcher) 1)
14578 (cons 'and todomatcher)
14579 (car todomatcher))
14580 orlist)
14581 (setq todomatcher nil))
14582 (setq todomatcher (if (> (length orlist) 1)
14583 (cons 'or orlist) (car orlist))))
14585 ;; Return the string and lisp forms of the matcher
14586 (setq matcher (if todomatcher
14587 (list 'and tagsmatcher todomatcher)
14588 tagsmatcher))
14589 (when todo-only
14590 (setq matcher (list 'and '(member todo org-not-done-keywords)
14591 matcher)))
14592 (cons match0 matcher)))
14594 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14595 "Expand group tags in MATCH.
14597 This replaces every group tag in MATCH with a regexp tag search.
14598 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14599 will be replaced like this:
14601 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14602 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14603 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14605 Replacing by a regexp preserves the structure of the match.
14606 E.g., this expansion
14608 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14610 will match anything tagged with \"Lab\" and \"Home\", or tagged
14611 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14613 A group tag in MATCH can contain regular expressions of its own.
14614 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14615 will be replaced like this:
14617 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14619 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14620 assumed to be a single group tag, and the function will return
14621 the list of tags in this group.
14623 When DOWNCASE is non-nil, expand downcased TAGS."
14624 (if org-group-tags
14625 (let* ((case-fold-search t)
14626 (stable org-mode-syntax-table)
14627 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14628 (taggroups (if downcased
14629 (mapcar (lambda (tg) (mapcar #'downcase tg))
14630 taggroups)
14631 taggroups))
14632 (taggroups-keys (mapcar #'car taggroups))
14633 (return-match (if downcased (downcase match) match))
14634 (count 0)
14635 (work-already-expanded tags-already-expanded)
14636 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14637 ;; @ and _ are allowed as word-components in tags.
14638 (modify-syntax-entry ?@ "w" stable)
14639 (modify-syntax-entry ?_ "w" stable)
14640 ;; Temporarily replace regexp-expressions in the match-expression.
14641 (while (string-match "{.+?}" return-match)
14642 (incf count)
14643 (push (match-string 0 return-match) regexps-in-match)
14644 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14645 (while (and taggroups-keys
14646 (with-syntax-table stable
14647 (string-match
14648 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14649 (regexp-opt taggroups-keys) "\\>\\)")
14650 return-match)))
14651 (let* ((dir (match-string 1 return-match))
14652 (tag (match-string 2 return-match))
14653 (tag (if downcased (downcase tag) tag)))
14654 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14655 (member tag work-already-expanded))
14656 (setq tags-in-group (assoc tag taggroups))
14657 (push tag work-already-expanded)
14658 ;; Recursively expand each tag in the group, if the tag hasn't
14659 ;; already been expanded. Restore the match-data after all recursive calls.
14660 (save-match-data
14661 (let (tags-expanded)
14662 (dolist (x (cdr tags-in-group))
14663 (if (and (member x taggroups-keys)
14664 (not (member x work-already-expanded)))
14665 (setq tags-expanded
14666 (delete-dups
14667 (append
14668 (org-tags-expand x t downcased
14669 work-already-expanded)
14670 tags-expanded)))
14671 (setq tags-expanded
14672 (append (list x) tags-expanded)))
14673 (setq work-already-expanded
14674 (delete-dups
14675 (append tags-expanded
14676 work-already-expanded))))
14677 (setq tags-in-group
14678 (delete-dups (cons (car tags-in-group)
14679 tags-expanded)))))
14680 ;; Filter tag-regexps from tags.
14681 (setq regexp-in-group-escaped
14682 (delq nil (mapcar (lambda (x)
14683 (if (stringp x)
14684 (and (equal "{" (substring x 0 1))
14685 (equal "}" (substring x -1))
14688 tags-in-group))
14689 regexp-in-group
14690 (mapcar (lambda (x)
14691 (substring x 1 -1))
14692 regexp-in-group-escaped)
14693 tags-in-group
14694 (delq nil (mapcar (lambda (x)
14695 (if (stringp x)
14696 (and (not (equal "{" (substring x 0 1)))
14697 (not (equal "}" (substring x -1)))
14700 tags-in-group)))
14701 ;; If single-as-list, do no more in the while-loop.
14702 (if (not single-as-list)
14703 (progn
14704 (when regexp-in-group
14705 (setq regexp-in-group
14706 (concat "\\|"
14707 (mapconcat 'identity regexp-in-group
14708 "\\|"))))
14709 (setq tags-in-group
14710 (concat dir
14711 "{\\<"
14712 (regexp-opt tags-in-group)
14713 "\\>"
14714 regexp-in-group
14715 "}"))
14716 (when (stringp tags-in-group)
14717 (org-add-props tags-in-group '(grouptag t)))
14718 (setq return-match
14719 (replace-match tags-in-group t t return-match)))
14720 (setq tags-in-group
14721 (append regexp-in-group-escaped tags-in-group))))
14722 (setq taggroups-keys (delete tag taggroups-keys))))
14723 ;; Add the regular expressions back into the match-expression again.
14724 (while regexps-in-match
14725 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14726 (pop regexps-in-match)
14727 return-match t t))
14728 (decf count))
14729 (if single-as-list
14730 (if tags-in-group tags-in-group (list return-match))
14731 return-match))
14732 (if single-as-list
14733 (list (if downcased (downcase match) match))
14734 match)))
14736 (defun org-op-to-function (op &optional stringp)
14737 "Turn an operator into the appropriate function."
14738 (setq op
14739 (cond
14740 ((equal op "<" ) '(< string< org-time<))
14741 ((equal op ">" ) '(> org-string> org-time>))
14742 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14743 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14744 ((member op '("=" "==")) '(= string= org-time=))
14745 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14746 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14748 (defun org<> (a b) (not (= a b)))
14749 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14750 (defun org-string>= (a b) (not (string< a b)))
14751 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14752 (defun org-string<> (a b) (not (string= a b)))
14753 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14754 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14755 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14756 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14757 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14758 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14759 (defun org-2ft (s)
14760 "Convert S to a floating point time.
14761 If S is already a number, just return it. If it is a string, parse
14762 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14763 (cond
14764 ((numberp s) s)
14765 ((stringp s)
14766 (condition-case nil
14767 (float-time (apply 'encode-time (org-parse-time-string s)))
14768 (error 0.)))
14769 (t 0.)))
14771 (defun org-time-today ()
14772 "Time in seconds today at 0:00.
14773 Returns the float number of seconds since the beginning of the
14774 epoch to the beginning of today (00:00)."
14775 (float-time (apply 'encode-time
14776 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14778 (defun org-matcher-time (s)
14779 "Interpret a time comparison value."
14780 (save-match-data
14781 (cond
14782 ((string= s "<now>") (float-time))
14783 ((string= s "<today>") (org-time-today))
14784 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14785 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14786 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14787 (+ (org-time-today)
14788 (* (string-to-number (match-string 1 s))
14789 (cdr (assoc (match-string 2 s)
14790 '(("d" . 86400.0) ("w" . 604800.0)
14791 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14792 (t (org-2ft s)))))
14794 (defun org-match-any-p (re list)
14795 "Does re match any element of list?"
14796 (setq list (mapcar (lambda (x) (string-match re x)) list))
14797 (delq nil list))
14799 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14800 (defvar org-tags-overlay (make-overlay 1 1))
14801 (org-detach-overlay org-tags-overlay)
14803 (defun org-get-local-tags-at (&optional pos)
14804 "Get a list of tags defined in the current headline."
14805 (org-get-tags-at pos 'local))
14807 (defun org-get-local-tags ()
14808 "Get a list of tags defined in the current headline."
14809 (org-get-tags-at nil 'local))
14811 (defun org-get-tags-at (&optional pos local)
14812 "Get a list of all headline tags applicable at POS.
14813 POS defaults to point. If tags are inherited, the list contains
14814 the targets in the same sequence as the headlines appear, i.e.
14815 the tags of the current headline come last.
14816 When LOCAL is non-nil, only return tags from the current headline,
14817 ignore inherited ones."
14818 (interactive)
14819 (if (and org-trust-scanner-tags
14820 (or (not pos) (equal pos (point)))
14821 (not local))
14822 org-scanner-tags
14823 (let (tags ltags lastpos parent)
14824 (save-excursion
14825 (save-restriction
14826 (widen)
14827 (goto-char (or pos (point)))
14828 (save-match-data
14829 (catch 'done
14830 (condition-case nil
14831 (progn
14832 (org-back-to-heading t)
14833 (while (not (equal lastpos (point)))
14834 (setq lastpos (point))
14835 (when (looking-at
14836 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14837 (setq ltags (org-split-string
14838 (org-match-string-no-properties 1) ":"))
14839 (when parent
14840 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14841 (setq tags (append
14842 (if parent
14843 (org-remove-uninherited-tags ltags)
14844 ltags)
14845 tags)))
14846 (or org-use-tag-inheritance (throw 'done t))
14847 (if local (throw 'done t))
14848 (or (org-up-heading-safe) (error nil))
14849 (setq parent t)))
14850 (error nil)))))
14851 (if local
14852 tags
14853 (reverse (delete-dups
14854 (reverse (append
14855 (org-remove-uninherited-tags
14856 org-file-tags)
14857 tags)))))))))
14859 (defun org-add-prop-inherited (s)
14860 (add-text-properties 0 (length s) '(inherited t) s)
14863 (defun org-toggle-tag (tag &optional onoff)
14864 "Toggle the tag TAG for the current line.
14865 If ONOFF is `on' or `off', don't toggle but set to this state."
14866 (let (res current)
14867 (save-excursion
14868 (org-back-to-heading t)
14869 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14870 (point-at-eol) t)
14871 (progn
14872 (setq current (match-string 1))
14873 (replace-match ""))
14874 (setq current ""))
14875 (setq current (nreverse (org-split-string current ":")))
14876 (cond
14877 ((eq onoff 'on)
14878 (setq res t)
14879 (or (member tag current) (push tag current)))
14880 ((eq onoff 'off)
14881 (or (not (member tag current)) (setq current (delete tag current))))
14882 (t (if (member tag current)
14883 (setq current (delete tag current))
14884 (setq res t)
14885 (push tag current))))
14886 (end-of-line 1)
14887 (if current
14888 (progn
14889 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14890 (org-set-tags nil t))
14891 (delete-horizontal-space))
14892 (run-hooks 'org-after-tags-change-hook))
14893 res))
14895 (defun org-align-tags-here (to-col)
14896 ;; Assumes that this is a headline
14897 "Align tags on the current headline to TO-COL."
14898 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14899 (beginning-of-line 1)
14900 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14901 (< pos (match-beginning 2)))
14902 (progn
14903 (setq tags-l (- (match-end 2) (match-beginning 2)))
14904 (goto-char (match-beginning 1))
14905 (insert " ")
14906 (delete-region (point) (1+ (match-beginning 2)))
14907 (setq ncol (max (current-column)
14908 (1+ col)
14909 (if (> to-col 0)
14910 to-col
14911 (- (abs to-col) tags-l))))
14912 (setq p (point))
14913 (insert (make-string (- ncol (current-column)) ?\ ))
14914 (setq ncol (current-column))
14915 (when indent-tabs-mode (tabify p (point-at-eol)))
14916 (org-move-to-column (min ncol col)))
14917 (goto-char pos))))
14919 (defun org-set-tags-command (&optional arg just-align)
14920 "Call the set-tags command for the current entry."
14921 (interactive "P")
14922 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14923 (org-set-tags arg just-align)
14924 (save-excursion
14925 (unless (and (org-region-active-p)
14926 org-loop-over-headlines-in-active-region)
14927 (org-back-to-heading t))
14928 (org-set-tags arg just-align))))
14930 (defun org-set-tags-to (data)
14931 "Set the tags of the current entry to DATA, replacing the current tags.
14932 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14933 If DATA is nil or the empty string, any tags will be removed."
14934 (interactive "sTags: ")
14935 (setq data
14936 (cond
14937 ((eq data nil) "")
14938 ((equal data "") "")
14939 ((stringp data)
14940 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14941 ":"))
14942 ((listp data)
14943 (concat ":" (mapconcat 'identity data ":") ":"))))
14944 (when data
14945 (save-excursion
14946 (org-back-to-heading t)
14947 (when (looking-at org-complex-heading-regexp)
14948 (if (match-end 5)
14949 (progn
14950 (goto-char (match-beginning 5))
14951 (insert data)
14952 (delete-region (point) (point-at-eol))
14953 (org-set-tags nil 'align))
14954 (goto-char (point-at-eol))
14955 (insert " " data)
14956 (org-set-tags nil 'align)))
14957 (beginning-of-line 1)
14958 (if (looking-at ".*?\\([ \t]+\\)$")
14959 (delete-region (match-beginning 1) (match-end 1))))))
14961 (defun org-align-all-tags ()
14962 "Align the tags i all headings."
14963 (interactive)
14964 (save-excursion
14965 (or (ignore-errors (org-back-to-heading t))
14966 (outline-next-heading))
14967 (if (org-at-heading-p)
14968 (org-set-tags t)
14969 (message "No headings"))))
14971 (defvar org-indent-indentation-per-level)
14972 (defun org-set-tags (&optional arg just-align)
14973 "Set the tags for the current headline.
14974 With prefix ARG, realign all tags in headings in the current buffer.
14975 When JUST-ALIGN is non-nil, only align tags."
14976 (interactive "P")
14977 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14978 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14979 'region-start-level
14980 'region))
14981 org-loop-over-headlines-in-active-region)
14982 (org-map-entries
14983 ;; We don't use ARG and JUST-ALIGN here because these args
14984 ;; are not useful when looping over headlines.
14985 #'org-set-tags
14986 org-loop-over-headlines-in-active-region
14988 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14989 (let ((org-setting-tags t))
14990 (if arg
14991 (save-excursion
14992 (goto-char (point-min))
14993 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14994 (while (re-search-forward org-outline-regexp-bol nil t)
14995 (org-set-tags nil t)
14996 (end-of-line)))
14997 (message "All tags realigned to column %d" org-tags-column))
14998 (let* ((current (org-get-tags-string))
14999 (col (current-column))
15000 (tags
15001 (if just-align current
15002 ;; Get a new set of tags from the user.
15003 (save-excursion
15004 (let* ((table
15005 (setq
15006 org-last-tags-completion-table
15007 (append
15008 org-tag-persistent-alist
15009 (or org-tag-alist (org-get-buffer-tags))
15010 (and
15011 org-complete-tags-always-offer-all-agenda-tags
15012 (org-global-tags-completion-table
15013 (org-agenda-files))))))
15014 (current-tags (org-split-string current ":"))
15015 (inherited-tags
15016 (nreverse (nthcdr (length current-tags)
15017 (nreverse (org-get-tags-at))))))
15018 (replace-regexp-in-string
15019 "\\([-+&]+\\|,\\)"
15021 (if (or (eq t org-use-fast-tag-selection)
15022 (and org-use-fast-tag-selection
15023 (delq nil (mapcar #'cdr table))))
15024 (org-fast-tag-selection
15025 current-tags inherited-tags table
15026 (and org-fast-tag-selection-include-todo
15027 org-todo-key-alist))
15028 (let ((org-add-colon-after-tag-completion
15029 (< 1 (length table))))
15030 (org-trim
15031 (completing-read
15032 "Tags: "
15033 #'org-tags-completion-function
15034 nil nil current 'org-tags-history))))))))))
15036 (when org-tags-sort-function
15037 (setq tags
15038 (mapconcat
15039 #'identity
15040 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15041 org-tags-sort-function)
15042 ":")))
15044 (if (not (org-string-nw-p tags)) (setq tags "")
15045 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15046 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15048 ;; Insert new tags at the correct column
15049 (beginning-of-line)
15050 (let ((level (if (looking-at org-outline-regexp)
15051 (- (match-end 0) (point) 1)
15052 1)))
15053 (cond
15054 ((and (equal current "") (equal tags "")))
15055 ((re-search-forward
15056 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15057 (line-end-position)
15059 (if (equal tags "") (replace-match "" t t)
15060 (goto-char (match-beginning 0))
15061 (let* ((c0 (current-column))
15062 ;; Compute offset for the case of org-indent-mode
15063 ;; active.
15064 (di (if (org-bound-and-true-p org-indent-mode)
15065 (* (1- org-indent-indentation-per-level)
15066 (1- level))
15068 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15069 (tc (+ org-tags-column
15070 (if (> org-tags-column 0) (- di) di)))
15071 (c1 (max (1+ c0)
15072 (if (> tc 0) tc
15073 (- (- tc) (string-width tags)))))
15074 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15075 (replace-match rpl t t)
15076 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15077 (tabify p0 (point))))))
15078 (t (error "Tags alignment failed"))))
15079 (org-move-to-column col))
15080 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15082 (defun org-change-tag-in-region (beg end tag off)
15083 "Add or remove TAG for each entry in the region.
15084 This works in the agenda, and also in an org-mode buffer."
15085 (interactive
15086 (list (region-beginning) (region-end)
15087 (let ((org-last-tags-completion-table
15088 (if (derived-mode-p 'org-mode)
15089 (org-uniquify
15090 (delq nil (append (org-get-buffer-tags)
15091 (org-global-tags-completion-table))))
15092 (org-global-tags-completion-table))))
15093 (org-icompleting-read
15094 "Tag: " 'org-tags-completion-function nil nil nil
15095 'org-tags-history))
15096 (progn
15097 (message "[s]et or [r]emove? ")
15098 (equal (read-char-exclusive) ?r))))
15099 (if (fboundp 'deactivate-mark) (deactivate-mark))
15100 (let ((agendap (equal major-mode 'org-agenda-mode))
15101 l1 l2 m buf pos newhead (cnt 0))
15102 (goto-char end)
15103 (setq l2 (1- (org-current-line)))
15104 (goto-char beg)
15105 (setq l1 (org-current-line))
15106 (loop for l from l1 to l2 do
15107 (org-goto-line l)
15108 (setq m (get-text-property (point) 'org-hd-marker))
15109 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15110 (and agendap m))
15111 (setq buf (if agendap (marker-buffer m) (current-buffer))
15112 pos (if agendap m (point)))
15113 (with-current-buffer buf
15114 (save-excursion
15115 (save-restriction
15116 (goto-char pos)
15117 (setq cnt (1+ cnt))
15118 (org-toggle-tag tag (if off 'off 'on))
15119 (setq newhead (org-get-heading)))))
15120 (and agendap (org-agenda-change-all-lines newhead m))))
15121 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15123 (defun org-tags-completion-function (string predicate &optional flag)
15124 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15125 (confirm (lambda (x) (stringp (car x)))))
15126 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15127 (setq s1 (match-string 1 string)
15128 s2 (match-string 2 string))
15129 (setq s1 "" s2 string))
15130 (cond
15131 ((eq flag nil)
15132 ;; try completion
15133 (setq rtn (try-completion s2 ctable confirm))
15134 (if (stringp rtn)
15135 (setq rtn
15136 (concat s1 s2 (substring rtn (length s2))
15137 (if (and org-add-colon-after-tag-completion
15138 (assoc rtn ctable))
15139 ":" ""))))
15140 rtn)
15141 ((eq flag t)
15142 ;; all-completions
15143 (all-completions s2 ctable confirm))
15144 ((eq flag 'lambda)
15145 ;; exact match?
15146 (assoc s2 ctable)))))
15148 (defun org-fast-tag-insert (kwd tags face &optional end)
15149 "Insert KDW, and the TAGS, the latter with face FACE.
15150 Also insert END."
15151 (insert (format "%-12s" (concat kwd ":"))
15152 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15153 (or end "")))
15155 (defun org-fast-tag-show-exit (flag)
15156 (save-excursion
15157 (org-goto-line 3)
15158 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15159 (replace-match ""))
15160 (when flag
15161 (end-of-line 1)
15162 (org-move-to-column (- (window-width) 19) t)
15163 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15165 (defun org-set-current-tags-overlay (current prefix)
15166 "Add an overlay to CURRENT tag with PREFIX."
15167 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15168 (if (featurep 'xemacs)
15169 (org-overlay-display org-tags-overlay (concat prefix s)
15170 'secondary-selection)
15171 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15172 (org-overlay-display org-tags-overlay (concat prefix s)))))
15174 (defvar org-last-tag-selection-key nil)
15175 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15176 "Fast tag selection with single keys.
15177 CURRENT is the current list of tags in the headline, INHERITED is the
15178 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15179 possibly with grouping information. TODO-TABLE is a similar table with
15180 TODO keywords, should these have keys assigned to them.
15181 If the keys are nil, a-z are automatically assigned.
15182 Returns the new tags string, or nil to not change the current settings."
15183 (let* ((fulltable (append table todo-table))
15184 (maxlen (apply 'max (mapcar
15185 (lambda (x)
15186 (if (stringp (car x)) (string-width (car x)) 0))
15187 fulltable)))
15188 (buf (current-buffer))
15189 (expert (eq org-fast-tag-selection-single-key 'expert))
15190 (buffer-tags nil)
15191 (fwidth (+ maxlen 3 1 3))
15192 (ncol (/ (- (window-width) 4) fwidth))
15193 (i-face 'org-done)
15194 (c-face 'org-todo)
15195 tg cnt e c char c1 c2 ntable tbl rtn
15196 ov-start ov-end ov-prefix
15197 (exit-after-next org-fast-tag-selection-single-key)
15198 (done-keywords org-done-keywords)
15199 groups ingroup intaggroup)
15200 (save-excursion
15201 (beginning-of-line 1)
15202 (if (looking-at
15203 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15204 (setq ov-start (match-beginning 1)
15205 ov-end (match-end 1)
15206 ov-prefix "")
15207 (setq ov-start (1- (point-at-eol))
15208 ov-end (1+ ov-start))
15209 (skip-chars-forward "^\n\r")
15210 (setq ov-prefix
15211 (concat
15212 (buffer-substring (1- (point)) (point))
15213 (if (> (current-column) org-tags-column)
15215 (make-string (- org-tags-column (current-column)) ?\ ))))))
15216 (move-overlay org-tags-overlay ov-start ov-end)
15217 (save-window-excursion
15218 (if expert
15219 (set-buffer (get-buffer-create " *Org tags*"))
15220 (delete-other-windows)
15221 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15222 (org-switch-to-buffer-other-window " *Org tags*"))
15223 (erase-buffer)
15224 (org-set-local 'org-done-keywords done-keywords)
15225 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15226 (org-fast-tag-insert "Current" current c-face "\n\n")
15227 (org-fast-tag-show-exit exit-after-next)
15228 (org-set-current-tags-overlay current ov-prefix)
15229 (setq tbl fulltable char ?a cnt 0)
15230 (while (setq e (pop tbl))
15231 (cond
15232 ((eq (car e) :startgroup)
15233 (push '() groups) (setq ingroup t)
15234 (unless (zerop cnt)
15235 (setq cnt 0)
15236 (insert "\n"))
15237 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15238 ((eq (car e) :endgroup)
15239 (setq ingroup nil cnt 0)
15240 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15241 ((eq (car e) :startgrouptag)
15242 (setq intaggroup t)
15243 (unless (zerop cnt)
15244 (setq cnt 0)
15245 (insert "\n"))
15246 (insert "[ "))
15247 ((eq (car e) :endgrouptag)
15248 (setq intaggroup nil cnt 0)
15249 (insert "]\n"))
15250 ((equal e '(:newline))
15251 (unless (zerop cnt)
15252 (setq cnt 0)
15253 (insert "\n")
15254 (setq e (car tbl))
15255 (while (equal (car tbl) '(:newline))
15256 (insert "\n")
15257 (setq tbl (cdr tbl)))))
15258 ((equal e '(:grouptags)) (insert " : "))
15260 (setq tg (copy-sequence (car e)) c2 nil)
15261 (if (cdr e)
15262 (setq c (cdr e))
15263 ;; automatically assign a character.
15264 (setq c1 (string-to-char
15265 (downcase (substring
15266 tg (if (= (string-to-char tg) ?@) 1 0)))))
15267 (if (or (rassoc c1 ntable) (rassoc c1 table))
15268 (while (or (rassoc char ntable) (rassoc char table))
15269 (setq char (1+ char)))
15270 (setq c2 c1))
15271 (setq c (or c2 char)))
15272 (when ingroup (push tg (car groups)))
15273 (setq tg (org-add-props tg nil 'face
15274 (cond
15275 ((not (assoc tg table))
15276 (org-get-todo-face tg))
15277 ((member tg current) c-face)
15278 ((member tg inherited) i-face))))
15279 (when (equal (caar tbl) :grouptags)
15280 (org-add-props tg nil 'face 'org-tag-group))
15281 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15282 (insert "[" c "] " tg (make-string
15283 (- fwidth 4 (length tg)) ?\ ))
15284 (push (cons tg c) ntable)
15285 (when (= (incf cnt) ncol)
15286 (insert "\n")
15287 (when (or ingroup intaggroup) (insert " "))
15288 (setq cnt 0)))))
15289 (setq ntable (nreverse ntable))
15290 (insert "\n")
15291 (goto-char (point-min))
15292 (unless expert (org-fit-window-to-buffer))
15293 (setq rtn
15294 (catch 'exit
15295 (while t
15296 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15297 (if (not groups) "no " "")
15298 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15299 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15300 (setq org-last-tag-selection-key c)
15301 (cond
15302 ((= c ?\r) (throw 'exit t))
15303 ((= c ?!)
15304 (setq groups (not groups))
15305 (goto-char (point-min))
15306 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15307 ((= c ?\C-c)
15308 (if (not expert)
15309 (org-fast-tag-show-exit
15310 (setq exit-after-next (not exit-after-next)))
15311 (setq expert nil)
15312 (delete-other-windows)
15313 (set-window-buffer (split-window-vertically) " *Org tags*")
15314 (org-switch-to-buffer-other-window " *Org tags*")
15315 (org-fit-window-to-buffer)))
15316 ((or (= c ?\C-g)
15317 (and (= c ?q) (not (rassoc c ntable))))
15318 (org-detach-overlay org-tags-overlay)
15319 (setq quit-flag t))
15320 ((= c ?\ )
15321 (setq current nil)
15322 (when exit-after-next (setq exit-after-next 'now)))
15323 ((= c ?\t)
15324 (condition-case nil
15325 (setq tg (org-icompleting-read
15326 "Tag: "
15327 (or buffer-tags
15328 (with-current-buffer buf
15329 (setq buffer-tags
15330 (org-get-buffer-tags))))))
15331 (quit (setq tg "")))
15332 (when (string-match "\\S-" tg)
15333 (add-to-list 'buffer-tags (list tg))
15334 (if (member tg current)
15335 (setq current (delete tg current))
15336 (push tg current)))
15337 (when exit-after-next (setq exit-after-next 'now)))
15338 ((setq e (rassoc c todo-table) tg (car e))
15339 (with-current-buffer buf
15340 (save-excursion (org-todo tg)))
15341 (when exit-after-next (setq exit-after-next 'now)))
15342 ((setq e (rassoc c ntable) tg (car e))
15343 (if (member tg current)
15344 (setq current (delete tg current))
15345 (loop for g in groups do
15346 (when (member tg g)
15347 (dolist (x g) (setq current (delete x current)))))
15348 (push tg current))
15349 (when exit-after-next (setq exit-after-next 'now))))
15351 ;; Create a sorted list
15352 (setq current
15353 (sort current
15354 (lambda (a b)
15355 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15356 (when (eq exit-after-next 'now) (throw 'exit t))
15357 (goto-char (point-min))
15358 (beginning-of-line 2)
15359 (delete-region (point) (point-at-eol))
15360 (org-fast-tag-insert "Current" current c-face)
15361 (org-set-current-tags-overlay current ov-prefix)
15362 (while (re-search-forward
15363 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15364 (setq tg (match-string 1))
15365 (add-text-properties
15366 (match-beginning 1) (match-end 1)
15367 (list 'face
15368 (cond
15369 ((member tg current) c-face)
15370 ((member tg inherited) i-face)
15371 (t (get-text-property (match-beginning 1) 'face))))))
15372 (goto-char (point-min)))))
15373 (org-detach-overlay org-tags-overlay)
15374 (if rtn
15375 (mapconcat 'identity current ":")
15376 nil))))
15378 (defun org-get-tags-string ()
15379 "Get the TAGS string in the current headline."
15380 (unless (org-at-heading-p t)
15381 (user-error "Not on a heading"))
15382 (save-excursion
15383 (beginning-of-line 1)
15384 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15385 (org-match-string-no-properties 1)
15386 "")))
15388 (defun org-get-tags ()
15389 "Get the list of tags specified in the current headline."
15390 (org-split-string (org-get-tags-string) ":"))
15392 (defun org-get-buffer-tags ()
15393 "Get a table of all tags used in the buffer, for completion."
15394 (org-with-wide-buffer
15395 (goto-char (point-min))
15396 (let ((tag-re (concat org-outline-regexp-bol
15397 "\\(?:.*?[ \t]\\)?"
15398 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15399 tags)
15400 (while (re-search-forward tag-re nil t)
15401 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15402 (push tag tags)))
15403 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15405 ;;;; The mapping API
15407 (defun org-map-entries (func &optional match scope &rest skip)
15408 "Call FUNC at each headline selected by MATCH in SCOPE.
15410 FUNC is a function or a lisp form. The function will be called without
15411 arguments, with the cursor positioned at the beginning of the headline.
15412 The return values of all calls to the function will be collected and
15413 returned as a list.
15415 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15416 does not need to preserve point. After evaluation, the cursor will be
15417 moved to the end of the line (presumably of the headline of the
15418 processed entry) and search continues from there. Under some
15419 circumstances, this may not produce the wanted results. For example,
15420 if you have removed (e.g. archived) the current (sub)tree it could
15421 mean that the next entry will be skipped entirely. In such cases, you
15422 can specify the position from where search should continue by making
15423 FUNC set the variable `org-map-continue-from' to the desired buffer
15424 position.
15426 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15427 Only headlines that are matched by this query will be considered during
15428 the iteration. When MATCH is nil or t, all headlines will be
15429 visited by the iteration.
15431 SCOPE determines the scope of this command. It can be any of:
15433 nil The current buffer, respecting the restriction if any
15434 tree The subtree started with the entry at point
15435 region The entries within the active region, if any
15436 region-start-level
15437 The entries within the active region, but only those at
15438 the same level than the first one.
15439 file The current buffer, without restriction
15440 file-with-archives
15441 The current buffer, and any archives associated with it
15442 agenda All agenda files
15443 agenda-with-archives
15444 All agenda files with any archive files associated with them
15445 \(file1 file2 ...)
15446 If this is a list, all files in the list will be scanned
15448 The remaining args are treated as settings for the skipping facilities of
15449 the scanner. The following items can be given here:
15451 archive skip trees with the archive tag
15452 comment skip trees with the COMMENT keyword
15453 function or Emacs Lisp form:
15454 will be used as value for `org-agenda-skip-function', so
15455 whenever the function returns a position, FUNC will not be
15456 called for that entry and search will continue from the
15457 position returned
15459 If your function needs to retrieve the tags including inherited tags
15460 at the *current* entry, you can use the value of the variable
15461 `org-scanner-tags' which will be much faster than getting the value
15462 with `org-get-tags-at'. If your function gets properties with
15463 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15464 to t around the call to `org-entry-properties' to get the same speedup.
15465 Note that if your function moves around to retrieve tags and properties at
15466 a *different* entry, you cannot use these techniques."
15467 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15468 (not (org-region-active-p)))
15469 (let* ((org-agenda-archives-mode nil) ; just to make sure
15470 (org-agenda-skip-archived-trees (memq 'archive skip))
15471 (org-agenda-skip-comment-trees (memq 'comment skip))
15472 (org-agenda-skip-function
15473 (car (org-delete-all '(comment archive) skip)))
15474 (org-tags-match-list-sublevels t)
15475 (start-level (eq scope 'region-start-level))
15476 matcher file res
15477 org-todo-keywords-for-agenda
15478 org-done-keywords-for-agenda
15479 org-todo-keyword-alist-for-agenda
15480 org-tag-alist-for-agenda
15481 todo-only)
15483 (cond
15484 ((eq match t) (setq matcher t))
15485 ((eq match nil) (setq matcher t))
15486 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15488 (save-excursion
15489 (save-restriction
15490 (cond ((eq scope 'tree)
15491 (org-back-to-heading t)
15492 (org-narrow-to-subtree)
15493 (setq scope nil))
15494 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15495 (org-region-active-p))
15496 ;; If needed, set start-level to a string like "2"
15497 (when start-level
15498 (save-excursion
15499 (goto-char (region-beginning))
15500 (unless (org-at-heading-p) (outline-next-heading))
15501 (setq start-level (org-current-level))))
15502 (narrow-to-region (region-beginning)
15503 (save-excursion
15504 (goto-char (region-end))
15505 (unless (and (bolp) (org-at-heading-p))
15506 (outline-next-heading))
15507 (point)))
15508 (setq scope nil)))
15510 (if (not scope)
15511 (progn
15512 (org-agenda-prepare-buffers
15513 (and buffer-file-name (list buffer-file-name)))
15514 (setq res (org-scan-tags func matcher todo-only start-level)))
15515 ;; Get the right scope
15516 (cond
15517 ((and scope (listp scope) (symbolp (car scope)))
15518 (setq scope (eval scope)))
15519 ((eq scope 'agenda)
15520 (setq scope (org-agenda-files t)))
15521 ((eq scope 'agenda-with-archives)
15522 (setq scope (org-agenda-files t))
15523 (setq scope (org-add-archive-files scope)))
15524 ((eq scope 'file)
15525 (setq scope (and buffer-file-name (list buffer-file-name))))
15526 ((eq scope 'file-with-archives)
15527 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15528 (org-agenda-prepare-buffers scope)
15529 (dolist (file scope)
15530 (with-current-buffer (org-find-base-buffer-visiting file)
15531 (save-excursion
15532 (save-restriction
15533 (widen)
15534 (goto-char (point-min))
15535 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15536 res)))
15538 ;;; Properties API
15540 (defconst org-special-properties
15541 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15542 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15543 "The special properties valid in Org mode.
15544 These are properties that are not defined in the property drawer,
15545 but in some other way.")
15547 (defconst org-default-properties
15548 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15549 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15550 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15551 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15552 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15553 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15554 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15555 "Some properties that are used by Org mode for various purposes.
15556 Being in this list makes sure that they are offered for completion.")
15558 (defun org--valid-property-p (property)
15559 "Non nil when string PROPERTY is a valid property name."
15560 (not
15561 (or (equal property "")
15562 (org-string-match-p "\\s-" property))))
15564 (defun org--update-property-plist (key val props)
15565 "Associate KEY to VAL in alist PROPS.
15566 Modifications are made by side-effect. Return new alist."
15567 (let* ((appending (string= (substring key -1) "+"))
15568 (key (if appending (substring key 0 -1) key))
15569 (old (assoc-string key props t)))
15570 (if (not old) (cons (cons key val) props)
15571 (setcdr old (if appending (concat (cdr old) " " val) val))
15572 props)))
15574 (defun org-get-property-block (&optional beg force)
15575 "Return the (beg . end) range of the body of the property drawer.
15576 BEG is the beginning of the current subtree, or of the part
15577 before the first headline. If it is not given, it will be found.
15578 If the drawer does not exist, create it if FORCE is non-nil, or
15579 return nil."
15580 (org-with-wide-buffer
15581 (when beg (goto-char beg))
15582 (unless (org-before-first-heading-p)
15583 (let ((beg (cond (beg)
15584 ((or (not (featurep 'org-inlinetask))
15585 (org-inlinetask-in-task-p))
15586 (org-back-to-heading t))
15587 (t (org-with-limited-levels (org-back-to-heading t))))))
15588 (forward-line)
15589 (when (org-looking-at-p org-planning-line-re) (forward-line))
15590 (cond ((looking-at org-property-drawer-re)
15591 (forward-line)
15592 (cons (point) (progn (goto-char (match-end 0))
15593 (line-beginning-position))))
15594 (force
15595 (goto-char beg)
15596 (org-insert-property-drawer)
15597 (let ((pos (save-excursion (search-forward ":END:")
15598 (line-beginning-position))))
15599 (cons pos pos))))))))
15601 (defun org-at-property-p ()
15602 "Non-nil when point is inside a property drawer.
15603 See `org-property-re' for match data, if applicable."
15604 (save-excursion
15605 (beginning-of-line)
15606 (and (looking-at org-property-re)
15607 (let ((property-drawer (save-match-data (org-get-property-block))))
15608 (and property-drawer
15609 (>= (point) (car property-drawer))
15610 (< (point) (cdr property-drawer)))))))
15612 (defun org-property-action ()
15613 "Do an action on properties."
15614 (interactive)
15615 (unless (org-at-property-p) (user-error "Not at a property"))
15616 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15617 (let ((c (read-char-exclusive)))
15618 (case c
15619 (?s (call-interactively #'org-set-property))
15620 (?d (call-interactively #'org-delete-property))
15621 (?D (call-interactively #'org-delete-property-globally))
15622 (?c (call-interactively #'org-compute-property-at-point))
15623 (otherwise (user-error "No such property action %c" c)))))
15625 (defun org-inc-effort ()
15626 "Increment the value of the effort property in the current entry."
15627 (interactive)
15628 (org-set-effort nil t))
15630 (defvar org-clock-effort) ; Defined in org-clock.el.
15631 (defvar org-clock-current-task) ; Defined in org-clock.el.
15632 (defun org-set-effort (&optional value increment)
15633 "Set the effort property of the current entry.
15634 With numerical prefix arg, use the nth allowed value, 0 stands for the
15635 10th allowed value.
15637 When INCREMENT is non-nil, set the property to the next allowed value."
15638 (interactive "P")
15639 (if (equal value 0) (setq value 10))
15640 (let* ((completion-ignore-case t)
15641 (prop org-effort-property)
15642 (cur (org-entry-get nil prop))
15643 (allowed (org-property-get-allowed-values nil prop 'table))
15644 (existing (mapcar 'list (org-property-values prop)))
15645 (heading (nth 4 (org-heading-components)))
15647 (val (cond
15648 ((stringp value) value)
15649 ((and allowed (integerp value))
15650 (or (car (nth (1- value) allowed))
15651 (car (org-last allowed))))
15652 ((and allowed increment)
15653 (or (caadr (member (list cur) allowed))
15654 (user-error "Allowed effort values are not set")))
15655 (allowed
15656 (message "Select 1-9,0, [RET%s]: %s"
15657 (if cur (concat "=" cur) "")
15658 (mapconcat 'car allowed " "))
15659 (setq rpl (read-char-exclusive))
15660 (if (equal rpl ?\r)
15662 (setq rpl (- rpl ?0))
15663 (if (equal rpl 0) (setq rpl 10))
15664 (if (and (> rpl 0) (<= rpl (length allowed)))
15665 (car (nth (1- rpl) allowed))
15666 (org-completing-read "Effort: " allowed nil))))
15668 (let (org-completion-use-ido org-completion-use-iswitchb)
15669 (org-completing-read
15670 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15671 (concat "[" cur "]") "")
15672 ": ")
15673 existing nil nil "" nil cur))))))
15674 (unless (equal (org-entry-get nil prop) val)
15675 (org-entry-put nil prop val))
15676 (org-refresh-property
15677 '((effort . identity)
15678 (effort-minutes . org-duration-string-to-minutes))
15679 val)
15680 (when (string= heading org-clock-current-task)
15681 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15682 (org-clock-update-mode-line))
15683 (message "%s is now %s" prop val)))
15685 (defun org-entry-properties (&optional pom which)
15686 "Get all properties of the current entry.
15688 When POM is a buffer position, get all properties from the entry
15689 there instead.
15691 This includes the TODO keyword, the tags, time strings for
15692 deadline, scheduled, and clocking, and any additional properties
15693 defined in the entry.
15695 If WHICH is nil or `all', get all properties. If WHICH is
15696 `special' or `standard', only get that subclass. If WHICH is
15697 a string, only get that property.
15699 Return value is an alist. Keys are properties, as upcased
15700 strings."
15701 (org-with-point-at pom
15702 (when (and (derived-mode-p 'org-mode)
15703 (ignore-errors (org-back-to-heading t)))
15704 (catch 'exit
15705 (let* ((beg (point))
15706 (specific (and (stringp which) (upcase which)))
15707 (which (cond ((not specific) which)
15708 ((member specific org-special-properties) 'special)
15709 (t 'standard)))
15710 props)
15711 ;; Get the special properties, like TODO and TAGS.
15712 (when (memq which '(nil all special))
15713 (when (or (not specific) (string= specific "CLOCKSUM"))
15714 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15715 (when clocksum
15716 (push (cons "CLOCKSUM"
15717 (org-columns-number-to-string
15718 (/ (float clocksum) 60.) 'add_times))
15719 props)))
15720 (when specific (throw 'exit props)))
15721 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15722 (let ((clocksumt (get-text-property (point)
15723 :org-clock-minutes-today)))
15724 (when clocksumt
15725 (push (cons "CLOCKSUM_T"
15726 (org-columns-number-to-string
15727 (/ (float clocksumt) 60.) 'add_times))
15728 props)))
15729 (when specific (throw 'exit props)))
15730 (when (or (not specific) (string= specific "ITEM"))
15731 (when (looking-at org-complex-heading-regexp)
15732 (push (cons "ITEM"
15733 (concat
15734 (org-match-string-no-properties 1)
15735 (let ((title (org-match-string-no-properties 4)))
15736 (when (org-string-nw-p title)
15737 (concat " " (org-remove-tabs title))))))
15738 props))
15739 (when specific (throw 'exit props)))
15740 (when (or (not specific) (string= specific "TODO"))
15741 (let ((case-fold-search nil))
15742 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15743 (push (cons "TODO" (org-match-string-no-properties 2)) props)))
15744 (when specific (throw 'exit props)))
15745 (when (or (not specific) (string= specific "PRIORITY"))
15746 (push (cons "PRIORITY"
15747 (if (looking-at org-priority-regexp)
15748 (org-match-string-no-properties 2)
15749 (char-to-string org-default-priority)))
15750 props)
15751 (when specific (throw 'exit props)))
15752 (when (or (not specific) (string= specific "FILE"))
15753 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15754 props)
15755 (when specific (throw 'exit props)))
15756 (when (or (not specific) (string= specific "TAGS"))
15757 (let ((value (org-string-nw-p (org-get-tags-string))))
15758 (when value (push (cons "TAGS" value) props)))
15759 (when specific (throw 'exit props)))
15760 (when (or (not specific) (string= specific "ALLTAGS"))
15761 (let ((value (org-get-tags-at)))
15762 (when value
15763 (push (cons "ALLTAGS"
15764 (format ":%s:" (mapconcat #'identity value ":")))
15765 props)))
15766 (when specific (throw 'exit props)))
15767 (when (or (not specific) (string= specific "BLOCKED"))
15768 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15769 (when specific (throw 'exit props)))
15770 (when (or (not specific)
15771 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15772 (forward-line)
15773 (when (org-looking-at-p org-planning-line-re)
15774 (end-of-line)
15775 (let ((bol (line-beginning-position))
15776 ;; Backward compatibility: time keywords used to
15777 ;; be configurable (before 8.3). Make sure we
15778 ;; get the correct keyword.
15779 (key-assoc `(("CLOSED" . ,org-closed-string)
15780 ("DEADLINE" . ,org-deadline-string)
15781 ("SCHEDULED" . ,org-scheduled-string))))
15782 (dolist (pair (if specific (list (assoc specific key-assoc))
15783 key-assoc))
15784 (save-excursion
15785 (when (search-backward (cdr pair) bol t)
15786 (goto-char (match-end 0))
15787 (skip-chars-forward " \t")
15788 (and (looking-at org-ts-regexp-both)
15789 (push (cons (car pair)
15790 (org-match-string-no-properties 0))
15791 props)))))))
15792 (when specific (throw 'exit props)))
15793 (when (or (not specific)
15794 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15795 (let ((find-ts
15796 (lambda (end ts)
15797 (let ((regexp (cond
15798 ((string= specific "TIMESTAMP")
15799 org-ts-regexp)
15800 ((string= specific "TIMESTAMP_IA")
15801 org-ts-regexp-inactive)
15802 ((assoc "TIMESTAMP_IA" ts)
15803 org-ts-regexp)
15804 ((assoc "TIMESTAMP" ts)
15805 org-ts-regexp-inactive)
15806 (t org-ts-regexp-both))))
15807 (catch 'next
15808 (while (re-search-forward regexp end t)
15809 (backward-char)
15810 (let ((object (org-element-context)))
15811 ;; Accept to match timestamps in node
15812 ;; properties, too.
15813 (when (memq (org-element-type object)
15814 '(node-property timestamp))
15815 (let ((type
15816 (org-element-property :type object)))
15817 (cond
15818 ((and (memq type '(active active-range))
15819 (not (equal specific "TIMESTAMP_IA")))
15820 (unless (assoc "TIMESTAMP" ts)
15821 (push (cons "TIMESTAMP"
15822 (org-element-property
15823 :raw-value object))
15825 (when specific (throw 'exit ts))))
15826 ((and (memq type '(inactive inactive-range))
15827 (not (string= specific "TIMESTAMP")))
15828 (unless (assoc "TIMESTAMP_IA" ts)
15829 (push (cons "TIMESTAMP_IA"
15830 (org-element-property
15831 :raw-value object))
15833 (when specific (throw 'exit ts))))))
15834 ;; Both timestamp types are found,
15835 ;; move to next part.
15836 (when (= (length ts) 2) (throw 'next ts)))))
15837 ts)))))
15838 (goto-char beg)
15839 ;; First look for timestamps within headline.
15840 (let ((ts (funcall find-ts (line-end-position) nil)))
15841 (if (= (length ts) 2) (setq props (nconc ts props))
15842 (forward-line)
15843 ;; Then find timestamps in the section, skipping
15844 ;; planning line.
15845 (when (org-looking-at-p org-planning-line-re)
15846 (forward-line))
15847 (let ((end (save-excursion (outline-next-heading))))
15848 (setq props (nconc (funcall find-ts end ts) props))))))))
15849 ;; Get the standard properties, like :PROP:.
15850 (when (memq which '(nil all standard))
15851 ;; If we are looking after a specific property, delegate
15852 ;; to `org-entry-get', which is faster. However, make an
15853 ;; exception for "CATEGORY", since it can be also set
15854 ;; through keywords (i.e. #+CATEGORY).
15855 (if (and specific (not (equal specific "CATEGORY")))
15856 (let ((value (org-entry-get beg specific nil t)))
15857 (throw 'exit (and value (list (cons specific value)))))
15858 (let ((range (org-get-property-block beg)))
15859 (when range
15860 (let ((end (cdr range)) seen-base)
15861 (goto-char (car range))
15862 ;; Unlike to `org--update-property-plist', we
15863 ;; handle the case where base values is found
15864 ;; after its extension. We also forbid standard
15865 ;; properties to be named as special properties.
15866 (while (re-search-forward org-property-re end t)
15867 (let* ((key (upcase (org-match-string-no-properties 2)))
15868 (extendp (org-string-match-p "\\+\\'" key))
15869 (key-base (if extendp (substring key 0 -1) key))
15870 (value (org-match-string-no-properties 3)))
15871 (cond
15872 ((member-ignore-case key-base org-special-properties))
15873 (extendp
15874 (setq props
15875 (org--update-property-plist key value props)))
15876 ((member key seen-base))
15877 (t (push key seen-base)
15878 (let ((p (assoc-string key props t)))
15879 (if p (setcdr p (concat value " " (cdr p)))
15880 (push (cons key value) props))))))))))))
15881 (unless (assoc "CATEGORY" props)
15882 (push (cons "CATEGORY" (org-get-category beg)) props)
15883 (when (string= specific "CATEGORY") (throw 'exit props)))
15884 ;; Return value.
15885 props)))))
15887 (defun org-property--local-values (property literal-nil)
15888 "Return value for PROPERTY in current entry.
15889 Value is a list whose care is the base value for PROPERTY and cdr
15890 a list of accumulated values. Return nil if neither is found in
15891 the entry. Also return nil when PROPERTY is set to \"nil\",
15892 unless LITERAL-NIL is non-nil."
15893 (let ((range (org-get-property-block)))
15894 (when range
15895 (goto-char (car range))
15896 (let* ((case-fold-search t)
15897 (end (cdr range))
15898 (value
15899 ;; Base value.
15900 (save-excursion
15901 (let ((v (and (re-search-forward
15902 (org-re-property property nil t) end t)
15903 (org-match-string-no-properties 3))))
15904 (list (if literal-nil v (org-not-nil v)))))))
15905 ;; Find additional values.
15906 (let* ((property+ (org-re-property (concat property "+") nil t)))
15907 (while (re-search-forward property+ end t)
15908 (push (org-match-string-no-properties 3) value)))
15909 ;; Return final values.
15910 (and (not (equal value '(nil))) (nreverse value))))))
15912 (defun org-entry-get (pom property &optional inherit literal-nil)
15913 "Get value of PROPERTY for entry or content at point-or-marker POM.
15915 If INHERIT is non-nil and the entry does not have the property,
15916 then also check higher levels of the hierarchy. If INHERIT is
15917 the symbol `selective', use inheritance only if the setting in
15918 `org-use-property-inheritance' selects PROPERTY for inheritance.
15920 If the property is present but empty, the return value is the
15921 empty string. If the property is not present at all, nil is
15922 returned. In any other case, return the value as a string.
15923 Search is case-insensitive.
15925 If LITERAL-NIL is set, return the string value \"nil\" as
15926 a string, do not interpret it as the list atom nil. This is used
15927 for inheritance when a \"nil\" value can supersede a non-nil
15928 value higher up the hierarchy."
15929 (org-with-point-at pom
15930 (cond
15931 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15932 ;; We need a special property. Use `org-entry-properties' to
15933 ;; retrieve it, but specify the wanted property.
15934 (cdr (assoc-string property (org-entry-properties nil property))))
15935 ((and inherit
15936 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15937 (org-entry-get-with-inheritance property literal-nil))
15939 (let* ((local (org-property--local-values property literal-nil))
15940 (value (and local (mapconcat #'identity (delq nil local) " "))))
15941 (if literal-nil value (org-not-nil value)))))))
15943 (defun org-property-or-variable-value (var &optional inherit)
15944 "Check if there is a property fixing the value of VAR.
15945 If yes, return this value. If not, return the current value of the variable."
15946 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15947 (if (and prop (stringp prop) (string-match "\\S-" prop))
15948 (read prop)
15949 (symbol-value var))))
15951 (defun org-entry-delete (pom property)
15952 "Delete PROPERTY from entry at point-or-marker POM.
15953 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15954 non-nil when a property was removed."
15955 (unless (member property org-special-properties)
15956 (org-with-point-at pom
15957 (let ((range (org-get-property-block)))
15958 (when range
15959 (let* ((begin (car range))
15960 (origin (cdr range))
15961 (end (copy-marker origin))
15962 (re (org-re-property
15963 (concat (regexp-quote property) "\\+?") t t)))
15964 (goto-char begin)
15965 (while (re-search-forward re end t)
15966 (delete-region (match-beginning 0) (line-beginning-position 2)))
15967 ;; If drawer is empty, remove it altogether.
15968 (when (= begin end)
15969 (delete-region (line-beginning-position 0)
15970 (line-beginning-position 2)))
15971 ;; Return non-nil if some property was removed.
15972 (prog1 (/= end origin) (set-marker end nil))))))))
15974 ;; Multi-values properties are properties that contain multiple values
15975 ;; These values are assumed to be single words, separated by whitespace.
15976 (defun org-entry-add-to-multivalued-property (pom property value)
15977 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15978 (let* ((old (org-entry-get pom property))
15979 (values (and old (org-split-string old "[ \t]"))))
15980 (setq value (org-entry-protect-space value))
15981 (unless (member value values)
15982 (setq values (append values (list value)))
15983 (org-entry-put pom property
15984 (mapconcat 'identity values " ")))))
15986 (defun org-entry-remove-from-multivalued-property (pom property value)
15987 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15988 (let* ((old (org-entry-get pom property))
15989 (values (and old (org-split-string old "[ \t]"))))
15990 (setq value (org-entry-protect-space value))
15991 (when (member value values)
15992 (setq values (delete value values))
15993 (org-entry-put pom property
15994 (mapconcat 'identity values " ")))))
15996 (defun org-entry-member-in-multivalued-property (pom property value)
15997 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15998 (let* ((old (org-entry-get pom property))
15999 (values (and old (org-split-string old "[ \t]"))))
16000 (setq value (org-entry-protect-space value))
16001 (member value values)))
16003 (defun org-entry-get-multivalued-property (pom property)
16004 "Return a list of values in a multivalued property."
16005 (let* ((value (org-entry-get pom property))
16006 (values (and value (org-split-string value "[ \t]"))))
16007 (mapcar 'org-entry-restore-space values)))
16009 (defun org-entry-put-multivalued-property (pom property &rest values)
16010 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
16011 VALUES should be a list of strings. Spaces will be protected."
16012 (org-entry-put pom property
16013 (mapconcat 'org-entry-protect-space values " "))
16014 (let* ((value (org-entry-get pom property))
16015 (values (and value (org-split-string value "[ \t]"))))
16016 (mapcar 'org-entry-restore-space values)))
16018 (defun org-entry-protect-space (s)
16019 "Protect spaces and newline in string S."
16020 (while (string-match " " s)
16021 (setq s (replace-match "%20" t t s)))
16022 (while (string-match "\n" s)
16023 (setq s (replace-match "%0A" t t s)))
16026 (defun org-entry-restore-space (s)
16027 "Restore spaces and newline in string S."
16028 (while (string-match "%20" s)
16029 (setq s (replace-match " " t t s)))
16030 (while (string-match "%0A" s)
16031 (setq s (replace-match "\n" t t s)))
16034 (defvar org-entry-property-inherited-from (make-marker)
16035 "Marker pointing to the entry from where a property was inherited.
16036 Each call to `org-entry-get-with-inheritance' will set this marker to the
16037 location of the entry where the inheritance search matched. If there was
16038 no match, the marker will point nowhere.
16039 Note that also `org-entry-get' calls this function, if the INHERIT flag
16040 is set.")
16042 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16043 "Get PROPERTY of entry or content at point, search higher levels if needed.
16044 The search will stop at the first ancestor which has the property defined.
16045 If the value found is \"nil\", return nil to show that the property
16046 should be considered as undefined (this is the meaning of nil here).
16047 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16048 (move-marker org-entry-property-inherited-from nil)
16049 (org-with-wide-buffer
16050 (let (value)
16051 (catch 'exit
16052 (while t
16053 (let ((v (org-property--local-values property literal-nil)))
16054 (when v
16055 (setq value
16056 (concat (mapconcat #'identity (delq nil v) " ")
16057 (and value " ")
16058 value)))
16059 (cond
16060 ((car v)
16061 (org-back-to-heading t)
16062 (move-marker org-entry-property-inherited-from (point))
16063 (throw 'exit nil))
16064 ((org-up-heading-safe))
16066 (let ((global
16067 (cdr (or (assoc-string property org-file-properties t)
16068 (assoc-string property org-global-properties t)
16069 (assoc-string property org-global-properties-fixed t)))))
16070 (cond ((not global))
16071 (value (setq value (concat global " " value)))
16072 (t (setq value global))))
16073 (throw 'exit nil))))))
16074 (if literal-nil value (org-not-nil value)))))
16076 (defvar org-property-changed-functions nil
16077 "Hook called when the value of a property has changed.
16078 Each hook function should accept two arguments, the name of the property
16079 and the new value.")
16081 (defun org-entry-put (pom property value)
16082 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16084 If the value is nil, it is converted to the empty string. If it
16085 is not a string, an error is raised. Also raise an error on
16086 invalid property names.
16088 PROPERTY can be any regular property (see
16089 `org-special-properties'). It can also be \"TODO\",
16090 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16092 For the last two properties, VALUE may have any of the special
16093 values \"earlier\" and \"later\". The function then increases or
16094 decreases scheduled or deadline date by one day."
16095 (cond ((null value) (setq value ""))
16096 ((not (stringp value)) (error "Properties values should be strings"))
16097 ((not (org--valid-property-p property))
16098 (user-error "Invalid property name: \"%s\"" property)))
16099 (org-with-point-at pom
16100 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16101 (org-back-to-heading t)
16102 (org-with-limited-levels (org-back-to-heading t)))
16103 (let ((beg (point)))
16104 (cond
16105 ((equal property "TODO")
16106 (cond ((not (org-string-nw-p value)) (setq value 'none))
16107 ((not (member value org-todo-keywords-1))
16108 (user-error "\"%s\" is not a valid TODO state" value)))
16109 (org-todo value)
16110 (org-set-tags nil 'align))
16111 ((equal property "PRIORITY")
16112 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16113 (org-set-tags nil 'align))
16114 ((equal property "SCHEDULED")
16115 (forward-line)
16116 (if (and (org-looking-at-p org-planning-line-re)
16117 (re-search-forward
16118 org-scheduled-time-regexp (line-end-position) t))
16119 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16120 ((string= value "later") (org-timestamp-change 1 'day))
16121 ((string= value "") (org-schedule '(4)))
16122 (t (org-schedule nil value)))
16123 (if (member value '("earlier" "later" ""))
16124 (call-interactively #'org-schedule)
16125 (org-schedule nil value))))
16126 ((equal property "DEADLINE")
16127 (forward-line)
16128 (if (and (org-looking-at-p org-planning-line-re)
16129 (re-search-forward
16130 org-deadline-time-regexp (line-end-position) t))
16131 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16132 ((string= value "later") (org-timestamp-change 1 'day))
16133 ((string= value "") (org-deadline '(4)))
16134 (t (org-deadline nil value)))
16135 (if (member value '("earlier" "later" ""))
16136 (call-interactively #'org-deadline)
16137 (org-deadline nil value))))
16138 ((member property org-special-properties)
16139 (error "The %s property cannot be set with `org-entry-put'" property))
16141 (let* ((range (org-get-property-block beg 'force))
16142 (end (cdr range))
16143 (case-fold-search t))
16144 (goto-char (car range))
16145 (if (re-search-forward (org-re-property property nil t) end t)
16146 (progn (delete-region (match-beginning 0) (match-end 0))
16147 (goto-char (match-beginning 0)))
16148 (goto-char end)
16149 (insert "\n")
16150 (backward-char))
16151 (insert ":" property ":")
16152 (when value (insert " " value))
16153 (org-indent-line)))))
16154 (run-hook-with-args 'org-property-changed-functions property value)))
16156 (defun org-buffer-property-keys (&optional specials defaults columns)
16157 "Get all property keys in the current buffer.
16159 When SPECIALS is non-nil, also list the special properties that
16160 reflect things like tags and TODO state.
16162 When DEFAULTS is non-nil, also include properties that has
16163 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16164 DESCRIPTION, LOCATION, and LOGGING and others.
16166 When COLUMNS in non-nil, also include property names given in
16167 COLUMN formats in the current buffer."
16168 (let ((case-fold-search t)
16169 (props (append
16170 (and specials org-special-properties)
16171 (and defaults (cons org-effort-property org-default-properties))
16172 nil)))
16173 (org-with-wide-buffer
16174 (goto-char (point-min))
16175 (while (re-search-forward org-property-start-re nil t)
16176 (let ((range (org-get-property-block)))
16177 (catch 'skip
16178 (unless range
16179 (when (and (not (org-before-first-heading-p))
16180 (y-or-n-p (format "Malformed drawer at %d, repair?"
16181 (line-beginning-position))))
16182 (org-get-property-block nil t))
16183 (throw 'skip nil))
16184 (goto-char (car range))
16185 (let ((begin (car range))
16186 (end (cdr range)))
16187 ;; Make sure that found property block is not located
16188 ;; before current point, as it would generate an infloop.
16189 ;; It can happen, for example, in the following
16190 ;; situation:
16192 ;; * Headline
16193 ;; :PROPERTIES:
16194 ;; ...
16195 ;; :END:
16196 ;; *************** Inlinetask
16197 ;; #+BEGIN_EXAMPLE
16198 ;; :PROPERTIES:
16199 ;; #+END_EXAMPLE
16201 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16202 (while (< (point) end)
16203 (let ((p (progn (looking-at org-property-re)
16204 (org-match-string-no-properties 2))))
16205 ;; Only add true property name, not extension symbol.
16206 (add-to-list 'props
16207 (if (not (org-string-match-p "\\+\\'" p)) p
16208 (substring p 0 -1))))
16209 (forward-line))))
16210 (outline-next-heading)))
16211 (when columns
16212 (goto-char (point-min))
16213 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16214 (let ((element (org-element-at-point)))
16215 (when (memq (org-element-type element) '(keyword node-property))
16216 (let ((value (org-element-property :value element))
16217 (start 0))
16218 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16219 (setq start (match-end 0))
16220 (let ((p (org-match-string-no-properties 1 value)))
16221 (unless (member-ignore-case p org-special-properties)
16222 (add-to-list 'props p))))))))))
16223 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16225 (defun org-property-values (key)
16226 "List all non-nil values of property KEY in current buffer."
16227 (org-with-wide-buffer
16228 (goto-char (point-min))
16229 (let ((case-fold-search t)
16230 (re (org-re-property key))
16231 values)
16232 (while (re-search-forward re nil t)
16233 (add-to-list 'values (org-entry-get (point) key)))
16234 values)))
16236 (defun org-insert-property-drawer ()
16237 "Insert a property drawer into the current entry."
16238 (org-with-wide-buffer
16239 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16240 (org-back-to-heading t)
16241 (org-with-limited-levels (org-back-to-heading t)))
16242 (forward-line)
16243 (when (org-looking-at-p org-planning-line-re) (forward-line))
16244 (unless (org-looking-at-p org-property-drawer-re)
16245 ;; Make sure we start editing a line from current entry, not from
16246 ;; next one. It prevents extending text properties or overlays
16247 ;; belonging to the latter.
16248 (when (bolp) (backward-char))
16249 (let ((begin (1+ (point)))
16250 (inhibit-read-only t))
16251 (insert "\n:PROPERTIES:\n:END:")
16252 (when (eobp) (insert "\n"))
16253 (org-indent-region begin (point))))))
16255 (defun org-insert-drawer (&optional arg drawer)
16256 "Insert a drawer at point.
16258 When optional argument ARG is non-nil, insert a property drawer.
16260 Optional argument DRAWER, when non-nil, is a string representing
16261 drawer's name. Otherwise, the user is prompted for a name.
16263 If a region is active, insert the drawer around that region
16264 instead.
16266 Point is left between drawer's boundaries."
16267 (interactive "P")
16268 (let* ((drawer (if arg "PROPERTIES"
16269 (or drawer (read-from-minibuffer "Drawer: ")))))
16270 (cond
16271 ;; With C-u, fall back on `org-insert-property-drawer'
16272 (arg (org-insert-property-drawer))
16273 ;; Check validity of suggested drawer's name.
16274 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16275 (user-error "Invalid drawer name"))
16276 ;; With an active region, insert a drawer at point.
16277 ((not (org-region-active-p))
16278 (progn
16279 (unless (bolp) (insert "\n"))
16280 (insert (format ":%s:\n\n:END:\n" drawer))
16281 (forward-line -2)))
16282 ;; Otherwise, insert the drawer at point
16284 (let ((rbeg (region-beginning))
16285 (rend (copy-marker (region-end))))
16286 (unwind-protect
16287 (progn
16288 (goto-char rbeg)
16289 (beginning-of-line)
16290 (when (save-excursion
16291 (re-search-forward org-outline-regexp-bol rend t))
16292 (user-error "Drawers cannot contain headlines"))
16293 ;; Position point at the beginning of the first
16294 ;; non-blank line in region. Insert drawer's opening
16295 ;; there, then indent it.
16296 (org-skip-whitespace)
16297 (beginning-of-line)
16298 (insert ":" drawer ":\n")
16299 (forward-line -1)
16300 (indent-for-tab-command)
16301 ;; Move point to the beginning of the first blank line
16302 ;; after the last non-blank line in region. Insert
16303 ;; drawer's closing, then indent it.
16304 (goto-char rend)
16305 (skip-chars-backward " \r\t\n")
16306 (insert "\n:END:")
16307 (deactivate-mark t)
16308 (indent-for-tab-command)
16309 (unless (eolp) (insert "\n")))
16310 ;; Clear marker, whatever the outcome of insertion is.
16311 (set-marker rend nil)))))))
16313 (defvar org-property-set-functions-alist nil
16314 "Property set function alist.
16315 Each entry should have the following format:
16317 (PROPERTY . READ-FUNCTION)
16319 The read function will be called with the same argument as
16320 `org-completing-read'.")
16322 (defun org-set-property-function (property)
16323 "Get the function that should be used to set PROPERTY.
16324 This is computed according to `org-property-set-functions-alist'."
16325 (or (cdr (assoc property org-property-set-functions-alist))
16326 'org-completing-read))
16328 (defun org-read-property-value (property)
16329 "Read PROPERTY value from user."
16330 (let* ((completion-ignore-case t)
16331 (allowed (org-property-get-allowed-values nil property 'table))
16332 (cur (org-entry-get nil property))
16333 (prompt (concat property " value"
16334 (if (and cur (string-match "\\S-" cur))
16335 (concat " [" cur "]") "") ": "))
16336 (set-function (org-set-property-function property))
16337 (val (if allowed
16338 (funcall set-function prompt allowed nil
16339 (not (get-text-property 0 'org-unrestricted
16340 (caar allowed))))
16341 (let (org-completion-use-ido org-completion-use-iswitchb)
16342 (funcall set-function prompt
16343 (mapcar 'list (org-property-values property))
16344 nil nil "" nil cur)))))
16345 (org-trim val)))
16347 (defvar org-last-set-property nil)
16348 (defvar org-last-set-property-value nil)
16349 (defun org-read-property-name ()
16350 "Read a property name."
16351 (let ((completion-ignore-case t)
16352 (default-prop (or (and (org-at-property-p)
16353 (org-match-string-no-properties 2))
16354 org-last-set-property)))
16355 (org-completing-read
16356 (concat "Property"
16357 (if default-prop (concat " [" default-prop "]") "")
16358 ": ")
16359 (mapcar #'list (org-buffer-property-keys nil t t))
16360 nil nil nil nil default-prop)))
16362 (defun org-set-property-and-value (use-last)
16363 "Allow to set [PROPERTY]: [value] direction from prompt.
16364 When use-default, don't even ask, just use the last
16365 \"[PROPERTY]: [value]\" string from the history."
16366 (interactive "P")
16367 (let* ((completion-ignore-case t)
16368 (pv (or (and use-last org-last-set-property-value)
16369 (org-completing-read
16370 "Enter a \"[Property]: [value]\" pair: "
16371 nil nil nil nil nil
16372 org-last-set-property-value)))
16373 prop val)
16374 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16375 (setq prop (match-string 1 pv)
16376 val (match-string 2 pv))
16377 (org-set-property prop val))))
16379 (defun org-set-property (property value)
16380 "In the current entry, set PROPERTY to VALUE.
16382 When called interactively, this will prompt for a property name, offering
16383 completion on existing and default properties. And then it will prompt
16384 for a value, offering completion either on allowed values (via an inherited
16385 xxx_ALL property) or on existing values in other instances of this property
16386 in the current file.
16388 Throw an error when trying to set a property with an invalid name."
16389 (interactive (list nil nil))
16390 (let ((property (or property (org-read-property-name))))
16391 ;; `org-entry-put' also makes the following check, but this one
16392 ;; avoids polluting `org-last-set-property' and
16393 ;; `org-last-set-property-value' needlessly.
16394 (unless (org--valid-property-p property)
16395 (user-error "Invalid property name: \"%s\"" property))
16396 (let ((value (or value (org-read-property-value property)))
16397 (fn (cdr (assoc-string property org-properties-postprocess-alist t))))
16398 (setq org-last-set-property property)
16399 (setq org-last-set-property-value (concat property ": " value))
16400 ;; Possibly postprocess the inserted value:
16401 (when fn (setq value (funcall fn value)))
16402 (unless (equal (org-entry-get nil property) value)
16403 (org-entry-put nil property value)))))
16405 (defun org-find-property (property &optional value)
16406 "Find first entry in buffer that sets PROPERTY.
16408 When optional argument VALUE is non-nil, only consider an entry
16409 if it contains PROPERTY set to this value. If PROPERTY should be
16410 explicitly set to nil, use string \"nil\" for VALUE.
16412 Return position where the entry begins, or nil if there is no
16413 such entry. If narrowing is in effect, only search the visible
16414 part of the buffer."
16415 (save-excursion
16416 (goto-char (point-min))
16417 (let ((case-fold-search t)
16418 (re (org-re-property property nil (not value) value)))
16419 (catch 'exit
16420 (while (re-search-forward re nil t)
16421 (when (if value (org-at-property-p)
16422 (org-entry-get (point) property nil t))
16423 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16425 (defun org-delete-property (property)
16426 "In the current entry, delete PROPERTY."
16427 (interactive
16428 (let* ((completion-ignore-case t)
16429 (cat (org-entry-get (point) "CATEGORY"))
16430 (props0 (org-entry-properties nil 'standard))
16431 (props (if cat props0
16432 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16433 (prop (if (< 1 (length props))
16434 (org-icompleting-read "Property: " props nil t)
16435 (caar props))))
16436 (list prop)))
16437 (if (not property)
16438 (message "No property to delete in this entry")
16439 (org-entry-delete nil property)
16440 (message "Property \"%s\" deleted" property)))
16442 (defun org-delete-property-globally (property)
16443 "Remove PROPERTY globally, from all entries.
16444 This function ignores narrowing, if any."
16445 (interactive
16446 (let* ((completion-ignore-case t)
16447 (prop (org-icompleting-read
16448 "Globally remove property: "
16449 (mapcar #'list (org-buffer-property-keys)))))
16450 (list prop)))
16451 (org-with-wide-buffer
16452 (goto-char (point-min))
16453 (let ((count 0)
16454 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16455 (while (re-search-forward re nil t)
16456 (when (org-entry-delete (point) property) (incf count)))
16457 (message "Property \"%s\" removed from %d entries" property count))))
16459 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16461 (defun org-compute-property-at-point ()
16462 "Compute the property at point.
16463 This looks for an enclosing column format, extracts the operator and
16464 then applies it to the property in the column format's scope."
16465 (interactive)
16466 (unless (org-at-property-p)
16467 (user-error "Not at a property"))
16468 (let ((prop (org-match-string-no-properties 2)))
16469 (org-columns-get-format-and-top-level)
16470 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16471 (user-error "No operator defined for property %s" prop))
16472 (org-columns-compute prop)))
16474 (defvar org-property-allowed-value-functions nil
16475 "Hook for functions supplying allowed values for a specific property.
16476 The functions must take a single argument, the name of the property, and
16477 return a flat list of allowed values. If \":ETC\" is one of
16478 the values, this means that these values are intended as defaults for
16479 completion, but that other values should be allowed too.
16480 The functions must return nil if they are not responsible for this
16481 property.")
16483 (defun org-property-get-allowed-values (pom property &optional table)
16484 "Get allowed values for the property PROPERTY.
16485 When TABLE is non-nil, return an alist that can directly be used for
16486 completion."
16487 (let (vals)
16488 (cond
16489 ((equal property "TODO")
16490 (setq vals (org-with-point-at pom
16491 (append org-todo-keywords-1 '("")))))
16492 ((equal property "PRIORITY")
16493 (let ((n org-lowest-priority))
16494 (while (>= n org-highest-priority)
16495 (push (char-to-string n) vals)
16496 (setq n (1- n)))))
16497 ((equal property "CATEGORY"))
16498 ((member property org-special-properties))
16499 ((setq vals (run-hook-with-args-until-success
16500 'org-property-allowed-value-functions property)))
16502 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16503 (when (and vals (string-match "\\S-" vals))
16504 (setq vals (car (read-from-string (concat "(" vals ")"))))
16505 (setq vals (mapcar (lambda (x)
16506 (cond ((stringp x) x)
16507 ((numberp x) (number-to-string x))
16508 ((symbolp x) (symbol-name x))
16509 (t "???")))
16510 vals)))))
16511 (when (member ":ETC" vals)
16512 (setq vals (remove ":ETC" vals))
16513 (org-add-props (car vals) '(org-unrestricted t)))
16514 (if table (mapcar 'list vals) vals)))
16516 (defun org-property-previous-allowed-value (&optional previous)
16517 "Switch to the next allowed value for this property."
16518 (interactive)
16519 (org-property-next-allowed-value t))
16521 (defun org-property-next-allowed-value (&optional previous)
16522 "Switch to the next allowed value for this property."
16523 (interactive)
16524 (unless (org-at-property-p)
16525 (user-error "Not at a property"))
16526 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16527 (key (match-string 2))
16528 (value (match-string 3))
16529 (allowed (or (org-property-get-allowed-values (point) key)
16530 (and (member value '("[ ]" "[-]" "[X]"))
16531 '("[ ]" "[X]"))))
16532 (heading (save-match-data (nth 4 (org-heading-components))))
16533 nval)
16534 (unless allowed
16535 (user-error "Allowed values for this property have not been defined"))
16536 (if previous (setq allowed (reverse allowed)))
16537 (if (member value allowed)
16538 (setq nval (car (cdr (member value allowed)))))
16539 (setq nval (or nval (car allowed)))
16540 (if (equal nval value)
16541 (user-error "Only one allowed value for this property"))
16542 (org-at-property-p)
16543 (replace-match (concat " :" key ": " nval) t t)
16544 (org-indent-line)
16545 (beginning-of-line 1)
16546 (skip-chars-forward " \t")
16547 (when (equal prop org-effort-property)
16548 (org-refresh-property
16549 '((effort . identity)
16550 (effort-minutes . org-duration-string-to-minutes))
16551 nval)
16552 (when (string= org-clock-current-task heading)
16553 (setq org-clock-effort nval)
16554 (org-clock-update-mode-line)))
16555 (run-hook-with-args 'org-property-changed-functions key nval)))
16557 (defun org-find-olp (path &optional this-buffer)
16558 "Return a marker pointing to the entry at outline path OLP.
16559 If anything goes wrong, throw an error.
16560 You can wrap this call to catch the error like this:
16562 (condition-case msg
16563 (org-mobile-locate-entry (match-string 4))
16564 (error (nth 1 msg)))
16566 The return value will then be either a string with the error message,
16567 or a marker if everything is OK.
16569 If THIS-BUFFER is set, the outline path does not contain a file,
16570 only headings."
16571 (let* ((file (if this-buffer buffer-file-name (pop path)))
16572 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16573 (level 1)
16574 (lmin 1)
16575 (lmax 1)
16576 limit re end found pos heading cnt flevel)
16577 (unless buffer (error "File not found :%s" file))
16578 (with-current-buffer buffer
16579 (save-excursion
16580 (save-restriction
16581 (widen)
16582 (setq limit (point-max))
16583 (goto-char (point-min))
16584 (dolist (heading path)
16585 (setq re (format org-complex-heading-regexp-format
16586 (regexp-quote heading)))
16587 (setq cnt 0 pos (point))
16588 (while (re-search-forward re end t)
16589 (setq level (- (match-end 1) (match-beginning 1)))
16590 (if (and (>= level lmin) (<= level lmax))
16591 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16592 (when (= cnt 0) (error "Heading not found on level %d: %s"
16593 lmax heading))
16594 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16595 lmax heading))
16596 (goto-char found)
16597 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16598 (setq end (save-excursion (org-end-of-subtree t t))))
16599 (when (org-at-heading-p)
16600 (point-marker)))))))
16602 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16603 "Find node HEADING in BUFFER.
16604 Return a marker to the heading if it was found, or nil if not.
16605 If POS-ONLY is set, return just the position instead of a marker.
16607 The heading text must match exact, but it may have a TODO keyword,
16608 a priority cookie and tags in the standard locations."
16609 (with-current-buffer (or buffer (current-buffer))
16610 (save-excursion
16611 (save-restriction
16612 (widen)
16613 (goto-char (point-min))
16614 (let (case-fold-search)
16615 (if (re-search-forward
16616 (format org-complex-heading-regexp-format
16617 (regexp-quote heading)) nil t)
16618 (if pos-only
16619 (match-beginning 0)
16620 (move-marker (make-marker) (match-beginning 0)))))))))
16622 (defun org-find-exact-heading-in-directory (heading &optional dir)
16623 "Find Org node headline HEADING in all .org files in directory DIR.
16624 When the target headline is found, return a marker to this location."
16625 (let ((files (directory-files (or dir default-directory)
16626 t "\\`[^.#].*\\.org\\'"))
16627 visiting m buffer)
16628 (catch 'found
16629 (dolist (file files)
16630 (message "trying %s" file)
16631 (setq visiting (org-find-base-buffer-visiting file))
16632 (setq buffer (or visiting (find-file-noselect file)))
16633 (setq m (org-find-exact-headline-in-buffer
16634 heading buffer))
16635 (when (and (not m) (not visiting)) (kill-buffer buffer))
16636 (and m (throw 'found m))))))
16638 (defun org-find-entry-with-id (ident)
16639 "Locate the entry that contains the ID property with exact value IDENT.
16640 IDENT can be a string, a symbol or a number, this function will search for
16641 the string representation of it.
16642 Return the position where this entry starts, or nil if there is no such entry."
16643 (interactive "sID: ")
16644 (let ((id (cond
16645 ((stringp ident) ident)
16646 ((symbolp ident) (symbol-name ident))
16647 ((numberp ident) (number-to-string ident))
16648 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16649 (org-with-wide-buffer (org-find-property "ID" id))))
16651 ;;;; Timestamps
16653 (defvar org-last-changed-timestamp nil)
16654 (defvar org-last-inserted-timestamp nil
16655 "The last time stamp inserted with `org-insert-time-stamp'.")
16656 (defvar org-ts-what) ; dynamically scoped parameter
16658 (defun org-time-stamp (arg &optional inactive)
16659 "Prompt for a date/time and insert a time stamp.
16661 If the user specifies a time like HH:MM or if this command is
16662 called with at least one prefix argument, the time stamp contains
16663 the date and the time. Otherwise, only the date is included.
16665 All parts of a date not specified by the user are filled in from
16666 the timestamp at point, if any, or the current date/time
16667 otherwise.
16669 If there is already a timestamp at the cursor, it is replaced.
16671 With two universal prefix arguments, insert an active timestamp
16672 with the current time without prompting the user.
16674 When called from lisp, the timestamp is inactive if INACTIVE is
16675 non-nil."
16676 (interactive "P")
16677 (let* ((ts (cond
16678 ((org-at-date-range-p t)
16679 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16680 ((org-at-timestamp-p t) (match-string 0))))
16681 ;; Default time is either the timestamp at point or today.
16682 ;; When entering a range, only the range start is considered.
16683 (default-time (if (not ts) (current-time)
16684 (apply #'encode-time (org-parse-time-string ts))))
16685 (default-input (and ts (org-get-compact-tod ts)))
16686 (repeater (and ts
16687 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16688 (match-string 0 ts)))
16689 org-time-was-given
16690 org-end-time-was-given
16691 (time
16692 (and (if (equal arg '(16)) (current-time)
16693 ;; Preserve `this-command' and `last-command'.
16694 (let ((this-command this-command)
16695 (last-command last-command))
16696 (org-read-date
16697 arg 'totime nil nil default-time default-input
16698 inactive))))))
16699 (cond
16700 ((and ts
16701 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16702 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16703 (insert "--")
16704 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16706 ;; Make sure we're on a timestamp. When in the middle of a date
16707 ;; range, move arbitrarily to range end.
16708 (unless (org-at-timestamp-p t)
16709 (skip-chars-forward "-")
16710 (org-at-timestamp-p t))
16711 (replace-match "")
16712 (setq org-last-changed-timestamp
16713 (org-insert-time-stamp
16714 time (or org-time-was-given arg)
16715 inactive nil nil (list org-end-time-was-given)))
16716 (when repeater
16717 (backward-char)
16718 (insert " " repeater)
16719 (setq org-last-changed-timestamp
16720 (concat (substring org-last-inserted-timestamp 0 -1)
16721 " " repeater ">")))
16722 (message "Timestamp updated"))
16723 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16724 (t (org-insert-time-stamp
16725 time (or org-time-was-given arg) inactive nil nil
16726 (list org-end-time-was-given))))))
16728 ;; FIXME: can we use this for something else, like computing time differences?
16729 (defun org-get-compact-tod (s)
16730 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16731 (let* ((t1 (match-string 1 s))
16732 (h1 (string-to-number (match-string 2 s)))
16733 (m1 (string-to-number (match-string 3 s)))
16734 (t2 (and (match-end 4) (match-string 5 s)))
16735 (h2 (and t2 (string-to-number (match-string 6 s))))
16736 (m2 (and t2 (string-to-number (match-string 7 s))))
16737 dh dm)
16738 (if (not t2)
16740 (setq dh (- h2 h1) dm (- m2 m1))
16741 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16742 (concat t1 "+" (number-to-string dh)
16743 (and (/= 0 dm) (format ":%02d" dm)))))))
16745 (defun org-time-stamp-inactive (&optional arg)
16746 "Insert an inactive time stamp.
16747 An inactive time stamp is enclosed in square brackets instead of angle
16748 brackets. It is inactive in the sense that it does not trigger agenda entries,
16749 does not link to the calendar and cannot be changed with the S-cursor keys.
16750 So these are more for recording a certain time/date."
16751 (interactive "P")
16752 (org-time-stamp arg 'inactive))
16754 (defvar org-date-ovl (make-overlay 1 1))
16755 (overlay-put org-date-ovl 'face 'org-date-selected)
16756 (org-detach-overlay org-date-ovl)
16758 (defvar org-ans1) ; dynamically scoped parameter
16759 (defvar org-ans2) ; dynamically scoped parameter
16761 (defvar org-plain-time-of-day-regexp) ; defined below
16763 (defvar org-overriding-default-time nil) ; dynamically scoped
16764 (defvar org-read-date-overlay nil)
16765 (defvar org-dcst nil) ; dynamically scoped
16766 (defvar org-read-date-history nil)
16767 (defvar org-read-date-final-answer nil)
16768 (defvar org-read-date-analyze-futurep nil)
16769 (defvar org-read-date-analyze-forced-year nil)
16770 (defvar org-read-date-inactive)
16772 (defvar org-read-date-minibuffer-local-map
16773 (let* ((map (make-sparse-keymap)))
16774 (set-keymap-parent map minibuffer-local-map)
16775 (org-defkey map (kbd ".")
16776 (lambda () (interactive)
16777 ;; Are we at the beginning of the prompt?
16778 (if (org-looking-back "^[^:]+: "
16779 (let ((inhibit-field-text-motion t))
16780 (line-beginning-position)))
16781 (org-eval-in-calendar '(calendar-goto-today))
16782 (insert "."))))
16783 (org-defkey map (kbd "C-.")
16784 (lambda () (interactive)
16785 (org-eval-in-calendar '(calendar-goto-today))))
16786 (org-defkey map [(meta shift left)]
16787 (lambda () (interactive)
16788 (org-eval-in-calendar '(calendar-backward-month 1))))
16789 (org-defkey map [(meta shift right)]
16790 (lambda () (interactive)
16791 (org-eval-in-calendar '(calendar-forward-month 1))))
16792 (org-defkey map [(meta shift up)]
16793 (lambda () (interactive)
16794 (org-eval-in-calendar '(calendar-backward-year 1))))
16795 (org-defkey map [(meta shift down)]
16796 (lambda () (interactive)
16797 (org-eval-in-calendar '(calendar-forward-year 1))))
16798 (org-defkey map [?\e (shift left)]
16799 (lambda () (interactive)
16800 (org-eval-in-calendar '(calendar-backward-month 1))))
16801 (org-defkey map [?\e (shift right)]
16802 (lambda () (interactive)
16803 (org-eval-in-calendar '(calendar-forward-month 1))))
16804 (org-defkey map [?\e (shift up)]
16805 (lambda () (interactive)
16806 (org-eval-in-calendar '(calendar-backward-year 1))))
16807 (org-defkey map [?\e (shift down)]
16808 (lambda () (interactive)
16809 (org-eval-in-calendar '(calendar-forward-year 1))))
16810 (org-defkey map [(shift up)]
16811 (lambda () (interactive)
16812 (org-eval-in-calendar '(calendar-backward-week 1))))
16813 (org-defkey map [(shift down)]
16814 (lambda () (interactive)
16815 (org-eval-in-calendar '(calendar-forward-week 1))))
16816 (org-defkey map [(shift left)]
16817 (lambda () (interactive)
16818 (org-eval-in-calendar '(calendar-backward-day 1))))
16819 (org-defkey map [(shift right)]
16820 (lambda () (interactive)
16821 (org-eval-in-calendar '(calendar-forward-day 1))))
16822 (org-defkey map "!"
16823 (lambda () (interactive)
16824 (org-eval-in-calendar '(diary-view-entries))
16825 (message "")))
16826 (org-defkey map ">"
16827 (lambda () (interactive)
16828 (org-eval-in-calendar '(calendar-scroll-left 1))))
16829 (org-defkey map "<"
16830 (lambda () (interactive)
16831 (org-eval-in-calendar '(calendar-scroll-right 1))))
16832 (org-defkey map "\C-v"
16833 (lambda () (interactive)
16834 (org-eval-in-calendar
16835 '(calendar-scroll-left-three-months 1))))
16836 (org-defkey map "\M-v"
16837 (lambda () (interactive)
16838 (org-eval-in-calendar
16839 '(calendar-scroll-right-three-months 1))))
16840 map)
16841 "Keymap for minibuffer commands when using `org-read-date'.")
16843 (defvar org-def)
16844 (defvar org-defdecode)
16845 (defvar org-with-time)
16847 (defun org-read-date (&optional org-with-time to-time from-string prompt
16848 default-time default-input inactive)
16849 "Read a date, possibly a time, and make things smooth for the user.
16850 The prompt will suggest to enter an ISO date, but you can also enter anything
16851 which will at least partially be understood by `parse-time-string'.
16852 Unrecognized parts of the date will default to the current day, month, year,
16853 hour and minute. If this command is called to replace a timestamp at point,
16854 or to enter the second timestamp of a range, the default time is taken
16855 from the existing stamp. Furthermore, the command prefers the future,
16856 so if you are giving a date where the year is not given, and the day-month
16857 combination is already past in the current year, it will assume you
16858 mean next year. For details, see the manual. A few examples:
16860 3-2-5 --> 2003-02-05
16861 feb 15 --> currentyear-02-15
16862 2/15 --> currentyear-02-15
16863 sep 12 9 --> 2009-09-12
16864 12:45 --> today 12:45
16865 22 sept 0:34 --> currentyear-09-22 0:34
16866 12 --> currentyear-currentmonth-12
16867 Fri --> nearest Friday after today
16868 -Tue --> last Tuesday
16869 etc.
16871 Furthermore you can specify a relative date by giving, as the *first* thing
16872 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16873 change in days weeks, months, years.
16874 With a single plus or minus, the date is relative to today. With a double
16875 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16876 +4d --> four days from today
16877 +4 --> same as above
16878 +2w --> two weeks from today
16879 ++5 --> five days from default date
16881 The function understands only English month and weekday abbreviations.
16883 While prompting, a calendar is popped up - you can also select the
16884 date with the mouse (button 1). The calendar shows a period of three
16885 months. To scroll it to other months, use the keys `>' and `<'.
16886 If you don't like the calendar, turn it off with
16887 (setq org-read-date-popup-calendar nil)
16889 With optional argument TO-TIME, the date will immediately be converted
16890 to an internal time.
16891 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16892 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16893 still enter a time, and this function will inform the calling routine
16894 about this change. The calling routine may then choose to change the
16895 format used to insert the time stamp into the buffer to include the time.
16896 With optional argument FROM-STRING, read from this string instead from
16897 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16898 the time/date that is used for everything that is not specified by the
16899 user."
16900 (require 'parse-time)
16901 (let* ((org-time-stamp-rounding-minutes
16902 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16903 (org-dcst org-display-custom-times)
16904 (ct (org-current-time))
16905 (org-def (or org-overriding-default-time default-time ct))
16906 (org-defdecode (decode-time org-def))
16907 (dummy (progn
16908 (when (< (nth 2 org-defdecode) org-extend-today-until)
16909 (setcar (nthcdr 2 org-defdecode) -1)
16910 (setcar (nthcdr 1 org-defdecode) 59)
16911 (setq org-def (apply 'encode-time org-defdecode)
16912 org-defdecode (decode-time org-def)))))
16913 (cur-frame (selected-frame))
16914 (mouse-autoselect-window nil) ; Don't let the mouse jump
16915 (calendar-frame-setup nil)
16916 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16917 (calendar-move-hook nil)
16918 (calendar-view-diary-initially-flag nil)
16919 (calendar-view-holidays-initially-flag nil)
16920 (timestr (format-time-string
16921 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16922 (prompt (concat (if prompt (concat prompt " ") "")
16923 (format "Date+time [%s]: " timestr)))
16924 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16926 (cond
16927 (from-string (setq ans from-string))
16928 (org-read-date-popup-calendar
16929 (save-excursion
16930 (save-window-excursion
16931 (calendar)
16932 (when (eq calendar-setup 'calendar-only)
16933 (setq cal-frame
16934 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16935 (select-frame cal-frame))
16936 (org-eval-in-calendar '(setq cursor-type nil) t)
16937 (unwind-protect
16938 (progn
16939 (calendar-forward-day (- (time-to-days org-def)
16940 (calendar-absolute-from-gregorian
16941 (calendar-current-date))))
16942 (org-eval-in-calendar nil t)
16943 (let* ((old-map (current-local-map))
16944 (map (copy-keymap calendar-mode-map))
16945 (minibuffer-local-map
16946 (copy-keymap org-read-date-minibuffer-local-map)))
16947 (org-defkey map (kbd "RET") 'org-calendar-select)
16948 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16949 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16950 (unwind-protect
16951 (progn
16952 (use-local-map map)
16953 (setq org-read-date-inactive inactive)
16954 (add-hook 'post-command-hook 'org-read-date-display)
16955 (setq org-ans0 (read-string prompt default-input
16956 'org-read-date-history nil))
16957 ;; org-ans0: from prompt
16958 ;; org-ans1: from mouse click
16959 ;; org-ans2: from calendar motion
16960 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16961 (remove-hook 'post-command-hook 'org-read-date-display)
16962 (use-local-map old-map)
16963 (when org-read-date-overlay
16964 (delete-overlay org-read-date-overlay)
16965 (setq org-read-date-overlay nil)))))
16966 (bury-buffer "*Calendar*")
16967 (when cal-frame
16968 (delete-frame cal-frame)
16969 (select-frame-set-input-focus cur-frame))))))
16971 (t ; Naked prompt only
16972 (unwind-protect
16973 (setq ans (read-string prompt default-input
16974 'org-read-date-history timestr))
16975 (when org-read-date-overlay
16976 (delete-overlay org-read-date-overlay)
16977 (setq org-read-date-overlay nil)))))
16979 (setq final (org-read-date-analyze ans org-def org-defdecode))
16981 (when org-read-date-analyze-forced-year
16982 (message "Year was forced into %s"
16983 (if org-read-date-force-compatible-dates
16984 "compatible range (1970-2037)"
16985 "range representable on this machine"))
16986 (ding))
16988 ;; One round trip to get rid of 34th of August and stuff like that....
16989 (setq final (decode-time (apply 'encode-time final)))
16991 (setq org-read-date-final-answer ans)
16993 (if to-time
16994 (apply 'encode-time final)
16995 (if (and (boundp 'org-time-was-given) org-time-was-given)
16996 (format "%04d-%02d-%02d %02d:%02d"
16997 (nth 5 final) (nth 4 final) (nth 3 final)
16998 (nth 2 final) (nth 1 final))
16999 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
17001 (defun org-read-date-display ()
17002 "Display the current date prompt interpretation in the minibuffer."
17003 (when org-read-date-display-live
17004 (when org-read-date-overlay
17005 (delete-overlay org-read-date-overlay))
17006 (when (minibufferp (current-buffer))
17007 (save-excursion
17008 (end-of-line 1)
17009 (while (not (equal (buffer-substring
17010 (max (point-min) (- (point) 4)) (point))
17011 " "))
17012 (insert " ")))
17013 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
17014 " " (or org-ans1 org-ans2)))
17015 (org-end-time-was-given nil)
17016 (f (org-read-date-analyze ans org-def org-defdecode))
17017 (fmts (if org-dcst
17018 org-time-stamp-custom-formats
17019 org-time-stamp-formats))
17020 (fmt (if (or org-with-time
17021 (and (boundp 'org-time-was-given) org-time-was-given))
17022 (cdr fmts)
17023 (car fmts)))
17024 (txt (format-time-string fmt (apply 'encode-time f)))
17025 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
17026 (txt (concat "=> " txt)))
17027 (when (and org-end-time-was-given
17028 (string-match org-plain-time-of-day-regexp txt))
17029 (setq txt (concat (substring txt 0 (match-end 0)) "-"
17030 org-end-time-was-given
17031 (substring txt (match-end 0)))))
17032 (when org-read-date-analyze-futurep
17033 (setq txt (concat txt " (=>F)")))
17034 (setq org-read-date-overlay
17035 (make-overlay (1- (point-at-eol)) (point-at-eol)))
17036 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
17038 (defun org-read-date-analyze (ans org-def org-defdecode)
17039 "Analyze the combined answer of the date prompt."
17040 ;; FIXME: cleanup and comment
17041 ;; Pass `current-time' result to `decode-time' (instead of calling
17042 ;; without arguments) so that only `current-time' has to be
17043 ;; overriden in tests.
17044 (let ((nowdecode (decode-time (current-time)))
17045 delta deltan deltaw deltadef year month day
17046 hour minute second wday pm h2 m2 tl wday1
17047 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
17048 (setq org-read-date-analyze-futurep nil
17049 org-read-date-analyze-forced-year nil)
17050 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17051 (setq ans "+0"))
17053 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17054 (setq ans (replace-match "" t t ans)
17055 deltan (car delta)
17056 deltaw (nth 1 delta)
17057 deltadef (nth 2 delta)))
17059 ;; Check if there is an iso week date in there. If yes, store the
17060 ;; info and postpone interpreting it until the rest of the parsing
17061 ;; is done.
17062 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17063 (setq iso-year (if (match-end 1)
17064 (org-small-year-to-year
17065 (string-to-number (match-string 1 ans))))
17066 iso-weekday (if (match-end 3)
17067 (string-to-number (match-string 3 ans)))
17068 iso-week (string-to-number (match-string 2 ans)))
17069 (setq ans (replace-match "" t t ans)))
17071 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17072 (when (string-match
17073 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17074 (setq year (if (match-end 2)
17075 (string-to-number (match-string 2 ans))
17076 (progn (setq kill-year t)
17077 (string-to-number (format-time-string "%Y"))))
17078 month (string-to-number (match-string 3 ans))
17079 day (string-to-number (match-string 4 ans)))
17080 (if (< year 100) (setq year (+ 2000 year)))
17081 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17082 t nil ans)))
17084 ;; Help matching dotted european dates
17085 (when (string-match
17086 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17087 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17088 (setq kill-year t)
17089 (string-to-number (format-time-string "%Y")))
17090 day (string-to-number (match-string 1 ans))
17091 month (string-to-number (match-string 2 ans))
17092 ans (replace-match (format "%04d-%02d-%02d" year month day)
17093 t nil ans)))
17095 ;; Help matching american dates, like 5/30 or 5/30/7
17096 (when (string-match
17097 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17098 (setq year (if (match-end 4)
17099 (string-to-number (match-string 4 ans))
17100 (progn (setq kill-year t)
17101 (string-to-number (format-time-string "%Y"))))
17102 month (string-to-number (match-string 1 ans))
17103 day (string-to-number (match-string 2 ans)))
17104 (if (< year 100) (setq year (+ 2000 year)))
17105 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17106 t nil ans)))
17107 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17108 ;; If there is a time with am/pm, and *no* time without it, we convert
17109 ;; so that matching will be successful.
17110 (loop for i from 1 to 2 do ; twice, for end time as well
17111 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17112 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17113 (setq hour (string-to-number (match-string 1 ans))
17114 minute (if (match-end 3)
17115 (string-to-number (match-string 3 ans))
17117 pm (equal ?p
17118 (string-to-char (downcase (match-string 4 ans)))))
17119 (if (and (= hour 12) (not pm))
17120 (setq hour 0)
17121 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17122 (setq ans (replace-match (format "%02d:%02d" hour minute)
17123 t t ans))))
17125 ;; Check if a time range is given as a duration
17126 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17127 (setq hour (string-to-number (match-string 1 ans))
17128 h2 (+ hour (string-to-number (match-string 3 ans)))
17129 minute (string-to-number (match-string 2 ans))
17130 m2 (+ minute (if (match-end 5) (string-to-number
17131 (match-string 5 ans))0)))
17132 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17133 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17134 t t ans)))
17136 ;; Check if there is a time range
17137 (when (boundp 'org-end-time-was-given)
17138 (setq org-time-was-given nil)
17139 (when (and (string-match org-plain-time-of-day-regexp ans)
17140 (match-end 8))
17141 (setq org-end-time-was-given (match-string 8 ans))
17142 (setq ans (concat (substring ans 0 (match-beginning 7))
17143 (substring ans (match-end 7))))))
17145 (setq tl (parse-time-string ans)
17146 day (or (nth 3 tl) (nth 3 org-defdecode))
17147 month
17148 (cond ((nth 4 tl))
17149 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17150 ;; Day was specified. Make sure DAY+MONTH
17151 ;; combination happens in the future.
17152 ((nth 3 tl)
17153 (setq futurep t)
17154 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17155 (nth 4 nowdecode)))
17156 (t (nth 4 org-defdecode)))
17157 year
17158 (cond ((and (not kill-year) (nth 5 tl)))
17159 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17160 ;; Month was guessed in the future and is at least
17161 ;; equal to NOWDECODE's. Fix year accordingly.
17162 (futurep
17163 (if (or (> month (nth 4 nowdecode))
17164 (>= day (nth 3 nowdecode)))
17165 (nth 5 nowdecode)
17166 (1+ (nth 5 nowdecode))))
17167 ;; Month was specified. Make sure MONTH+YEAR
17168 ;; combination happens in the future.
17169 ((nth 4 tl)
17170 (setq futurep t)
17171 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17172 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17173 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17174 (t (nth 5 nowdecode))))
17175 (t (nth 5 org-defdecode)))
17176 hour (or (nth 2 tl) (nth 2 org-defdecode))
17177 minute (or (nth 1 tl) (nth 1 org-defdecode))
17178 second (or (nth 0 tl) 0)
17179 wday (nth 6 tl))
17181 (when (and (eq org-read-date-prefer-future 'time)
17182 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17183 (equal day (nth 3 nowdecode))
17184 (equal month (nth 4 nowdecode))
17185 (equal year (nth 5 nowdecode))
17186 (nth 2 tl)
17187 (or (< (nth 2 tl) (nth 2 nowdecode))
17188 (and (= (nth 2 tl) (nth 2 nowdecode))
17189 (nth 1 tl)
17190 (< (nth 1 tl) (nth 1 nowdecode)))))
17191 (setq day (1+ day)
17192 futurep t))
17194 ;; Special date definitions below
17195 (cond
17196 (iso-week
17197 ;; There was an iso week
17198 (require 'cal-iso)
17199 (setq futurep nil)
17200 (setq year (or iso-year year)
17201 day (or iso-weekday wday 1)
17202 wday nil ; to make sure that the trigger below does not match
17203 iso-date (calendar-gregorian-from-absolute
17204 (calendar-iso-to-absolute
17205 (list iso-week day year))))
17206 ; FIXME: Should we also push ISO weeks into the future?
17207 ; (when (and org-read-date-prefer-future
17208 ; (not iso-year)
17209 ; (< (calendar-absolute-from-gregorian iso-date)
17210 ; (time-to-days (current-time))))
17211 ; (setq year (1+ year)
17212 ; iso-date (calendar-gregorian-from-absolute
17213 ; (calendar-iso-to-absolute
17214 ; (list iso-week day year)))))
17215 (setq month (car iso-date)
17216 year (nth 2 iso-date)
17217 day (nth 1 iso-date)))
17218 (deltan
17219 (setq futurep nil)
17220 (unless deltadef
17221 ;; Pass `current-time' result to `decode-time' (instead of
17222 ;; calling without arguments) so that only `current-time' has
17223 ;; to be overriden in tests.
17224 (let ((now (decode-time (current-time))))
17225 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17226 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17227 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17228 ((equal deltaw "m") (setq month (+ month deltan)))
17229 ((equal deltaw "y") (setq year (+ year deltan)))))
17230 ((and wday (not (nth 3 tl)))
17231 ;; Weekday was given, but no day, so pick that day in the week
17232 ;; on or after the derived date.
17233 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17234 (unless (equal wday wday1)
17235 (setq day (+ day (% (- wday wday1 -7) 7))))))
17236 (if (and (boundp 'org-time-was-given)
17237 (nth 2 tl))
17238 (setq org-time-was-given t))
17239 (if (< year 100) (setq year (+ 2000 year)))
17240 ;; Check of the date is representable
17241 (if org-read-date-force-compatible-dates
17242 (progn
17243 (if (< year 1970)
17244 (setq year 1970 org-read-date-analyze-forced-year t))
17245 (if (> year 2037)
17246 (setq year 2037 org-read-date-analyze-forced-year t)))
17247 (condition-case nil
17248 (ignore (encode-time second minute hour day month year))
17249 (error
17250 (setq year (nth 5 org-defdecode))
17251 (setq org-read-date-analyze-forced-year t))))
17252 (setq org-read-date-analyze-futurep futurep)
17253 (list second minute hour day month year)))
17255 (defvar parse-time-weekdays)
17256 (defun org-read-date-get-relative (s today default)
17257 "Check string S for special relative date string.
17258 TODAY and DEFAULT are internal times, for today and for a default.
17259 Return shift list (N what def-flag)
17260 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17261 N is the number of WHATs to shift.
17262 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17263 the DEFAULT date rather than TODAY."
17264 (require 'parse-time)
17265 (when (and
17266 (string-match
17267 (concat
17268 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17269 "\\([0-9]+\\)?"
17270 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17271 "\\([ \t]\\|$\\)") s)
17272 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17273 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17274 (string-to-char (substring (match-string 1 s) -1))
17275 ?+))
17276 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17277 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17278 (what (if (match-end 3) (match-string 3 s) "d"))
17279 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17280 (date (if rel default today))
17281 (wday (nth 6 (decode-time date)))
17282 delta)
17283 (if wday1
17284 (progn
17285 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17286 (if (= delta 0) (setq delta 7))
17287 (if (= dir ?-)
17288 (progn
17289 (setq delta (- delta 7))
17290 (if (= delta 0) (setq delta -7))))
17291 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17292 (list delta "d" rel))
17293 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17295 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17296 "Turn a user-specified date into the internal representation.
17297 The internal representation needed by the calendar is (month day year).
17298 This is a wrapper to handle the brain-dead convention in calendar that
17299 user function argument order change dependent on argument order."
17300 (if (boundp 'calendar-date-style)
17301 (cond
17302 ((eq calendar-date-style 'american)
17303 (list arg1 arg2 arg3))
17304 ((eq calendar-date-style 'european)
17305 (list arg2 arg1 arg3))
17306 ((eq calendar-date-style 'iso)
17307 (list arg2 arg3 arg1)))
17308 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17309 (if (org-bound-and-true-p european-calendar-style)
17310 (list arg2 arg1 arg3)
17311 (list arg1 arg2 arg3)))))
17313 (defun org-eval-in-calendar (form &optional keepdate)
17314 "Eval FORM in the calendar window and return to current window.
17315 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17316 otherwise stick to the current value of `org-ans2'."
17317 (let ((sf (selected-frame))
17318 (sw (selected-window)))
17319 (select-window (get-buffer-window "*Calendar*" t))
17320 (eval form)
17321 (when (and (not keepdate) (calendar-cursor-to-date))
17322 (let* ((date (calendar-cursor-to-date))
17323 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17324 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17325 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17326 (select-window sw)
17327 (org-select-frame-set-input-focus sf)))
17329 (defun org-calendar-select ()
17330 "Return to `org-read-date' with the date currently selected.
17331 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17332 (interactive)
17333 (when (calendar-cursor-to-date)
17334 (let* ((date (calendar-cursor-to-date))
17335 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17336 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17337 (if (active-minibuffer-window) (exit-minibuffer))))
17339 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17340 "Insert a date stamp for the date given by the internal TIME.
17341 See `format-time-string' for the format of TIME.
17342 WITH-HM means use the stamp format that includes the time of the day.
17343 INACTIVE means use square brackets instead of angular ones, so that the
17344 stamp will not contribute to the agenda.
17345 PRE and POST are optional strings to be inserted before and after the
17346 stamp.
17347 The command returns the inserted time stamp."
17348 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17349 stamp)
17350 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17351 (insert-before-markers (or pre ""))
17352 (when (listp extra)
17353 (setq extra (car extra))
17354 (if (and (stringp extra)
17355 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17356 (setq extra (format "-%02d:%02d"
17357 (string-to-number (match-string 1 extra))
17358 (string-to-number (match-string 2 extra))))
17359 (setq extra nil)))
17360 (when extra
17361 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17362 (insert-before-markers (setq stamp (format-time-string fmt time)))
17363 (insert-before-markers (or post ""))
17364 (setq org-last-inserted-timestamp stamp)))
17366 (defun org-toggle-time-stamp-overlays ()
17367 "Toggle the use of custom time stamp formats."
17368 (interactive)
17369 (setq org-display-custom-times (not org-display-custom-times))
17370 (unless org-display-custom-times
17371 (let ((p (point-min)) (bmp (buffer-modified-p)))
17372 (while (setq p (next-single-property-change p 'display))
17373 (if (and (get-text-property p 'display)
17374 (eq (get-text-property p 'face) 'org-date))
17375 (remove-text-properties
17376 p (setq p (next-single-property-change p 'display))
17377 '(display t))))
17378 (set-buffer-modified-p bmp)))
17379 (if (featurep 'xemacs)
17380 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17381 (org-restart-font-lock)
17382 (setq org-table-may-need-update t)
17383 (if org-display-custom-times
17384 (message "Time stamps are overlaid with custom format")
17385 (message "Time stamp overlays removed")))
17387 (defun org-display-custom-time (beg end)
17388 "Overlay modified time stamp format over timestamp between BEG and END."
17389 (let* ((ts (buffer-substring beg end))
17390 t1 w1 with-hm tf time str w2 (off 0))
17391 (save-match-data
17392 (setq t1 (org-parse-time-string ts t))
17393 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17394 (setq off (- (match-end 0) (match-beginning 0)))))
17395 (setq end (- end off))
17396 (setq w1 (- end beg)
17397 with-hm (and (nth 1 t1) (nth 2 t1))
17398 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17399 time (org-fix-decoded-time t1)
17400 str (org-add-props
17401 (format-time-string
17402 (substring tf 1 -1) (apply 'encode-time time))
17403 nil 'mouse-face 'highlight)
17404 w2 (length str))
17405 (if (not (= w2 w1))
17406 (add-text-properties (1+ beg) (+ 2 beg)
17407 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17408 (if (featurep 'xemacs)
17409 (progn
17410 (put-text-property beg end 'invisible t)
17411 (put-text-property beg end 'end-glyph (make-glyph str)))
17412 (put-text-property beg end 'display str))))
17414 (defun org-fix-decoded-time (time)
17415 "Set 0 instead of nil for the first 6 elements of time.
17416 Don't touch the rest."
17417 (let ((n 0))
17418 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17420 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17422 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17423 "Difference between TIMESTAMP-STRING and now in days.
17424 If SECONDS is non-nil, return the difference in seconds."
17425 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17426 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17427 (funcall fdiff (current-time)))))
17429 (defun org-deadline-close (timestamp-string &optional ndays)
17430 "Is the time in TIMESTAMP-STRING close to the current date?"
17431 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17432 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17433 (not (org-entry-is-done-p))))
17435 (defun org-get-wdays (ts &optional delay zero-delay)
17436 "Get the deadline lead time appropriate for timestring TS.
17437 When DELAY is non-nil, get the delay time for scheduled items
17438 instead of the deadline lead time. When ZERO-DELAY is non-nil
17439 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17440 don't try to find the delay cookie in the scheduled timestamp."
17441 (let ((tv (if delay org-scheduled-delay-days
17442 org-deadline-warning-days)))
17443 (cond
17444 ((or (and delay (< tv 0))
17445 (and delay zero-delay (<= tv 0))
17446 (and (not delay) (<= tv 0)))
17447 ;; Enforce this value no matter what
17448 (- tv))
17449 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17450 ;; lead time is specified.
17451 (floor (* (string-to-number (match-string 1 ts))
17452 (cdr (assoc (match-string 2 ts)
17453 '(("d" . 1) ("w" . 7)
17454 ("m" . 30.4) ("y" . 365.25)
17455 ("h" . 0.041667)))))))
17456 ;; go for the default.
17457 (t tv))))
17459 (defun org-calendar-select-mouse (ev)
17460 "Return to `org-read-date' with the date currently selected.
17461 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17462 (interactive "e")
17463 (mouse-set-point ev)
17464 (when (calendar-cursor-to-date)
17465 (let* ((date (calendar-cursor-to-date))
17466 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17467 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17468 (if (active-minibuffer-window) (exit-minibuffer))))
17470 (defun org-check-deadlines (ndays)
17471 "Check if there are any deadlines due or past due.
17472 A deadline is considered due if it happens within `org-deadline-warning-days'
17473 days from today's date. If the deadline appears in an entry marked DONE,
17474 it is not shown. The prefix arg NDAYS can be used to test that many
17475 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17476 (interactive "P")
17477 (let* ((org-warn-days
17478 (cond
17479 ((equal ndays '(4)) 100000)
17480 (ndays (prefix-numeric-value ndays))
17481 (t (abs org-deadline-warning-days))))
17482 (case-fold-search nil)
17483 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17484 (callback
17485 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17486 (message "%d deadlines past-due or due within %d days"
17487 (org-occur regexp nil callback)
17488 org-warn-days)))
17490 (defsubst org-re-timestamp (type)
17491 "Return a regexp for timestamp TYPE.
17492 Allowed values for TYPE are:
17494 all: all timestamps
17495 active: only active timestamps (<...>)
17496 inactive: only inactive timestamps ([...])
17497 scheduled: only scheduled timestamps
17498 deadline: only deadline timestamps
17499 closed: only closed time-stamps
17501 When TYPE is nil, fall back on returning a regexp that matches
17502 both scheduled and deadline timestamps."
17503 (case type
17504 (all org-ts-regexp-both)
17505 (active org-ts-regexp)
17506 (inactive org-ts-regexp-inactive)
17507 (scheduled org-scheduled-time-regexp)
17508 (deadline org-deadline-time-regexp)
17509 (closed org-closed-time-regexp)
17510 (otherwise
17511 (concat "\\<"
17512 (regexp-opt (list org-deadline-string org-scheduled-string))
17513 " *<\\([^>]+\\)>"))))
17515 (defun org-check-before-date (date)
17516 "Check if there are deadlines or scheduled entries before DATE."
17517 (interactive (list (org-read-date)))
17518 (let ((case-fold-search nil)
17519 (regexp (org-re-timestamp org-ts-type))
17520 (callback
17521 `(lambda ()
17522 (let ((match (match-string 1)))
17523 (and ,(if (memq org-ts-type '(active inactive all))
17524 '(eq (org-element-type (org-element-context)) 'timestamp)
17525 '(org-at-planning-p))
17526 (time-less-p
17527 (org-time-string-to-time match)
17528 (org-time-string-to-time date)))))))
17529 (message "%d entries before %s"
17530 (org-occur regexp nil callback) date)))
17532 (defun org-check-after-date (date)
17533 "Check if there are deadlines or scheduled entries after DATE."
17534 (interactive (list (org-read-date)))
17535 (let ((case-fold-search nil)
17536 (regexp (org-re-timestamp org-ts-type))
17537 (callback
17538 `(lambda ()
17539 (let ((match (match-string 1)))
17540 (and ,(if (memq org-ts-type '(active inactive all))
17541 '(eq (org-element-type (org-element-context)) 'timestamp)
17542 '(org-at-planning-p))
17543 (not (time-less-p
17544 (org-time-string-to-time match)
17545 (org-time-string-to-time date))))))))
17546 (message "%d entries after %s"
17547 (org-occur regexp nil callback) date)))
17549 (defun org-check-dates-range (start-date end-date)
17550 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17551 (interactive (list (org-read-date nil nil nil "Range starts")
17552 (org-read-date nil nil nil "Range end")))
17553 (let ((case-fold-search nil)
17554 (regexp (org-re-timestamp org-ts-type))
17555 (callback
17556 `(lambda ()
17557 (let ((match (match-string 1)))
17558 (and
17559 ,(if (memq org-ts-type '(active inactive all))
17560 '(eq (org-element-type (org-element-context)) 'timestamp)
17561 '(org-at-planning-p))
17562 (not (time-less-p
17563 (org-time-string-to-time match)
17564 (org-time-string-to-time start-date)))
17565 (time-less-p
17566 (org-time-string-to-time match)
17567 (org-time-string-to-time end-date)))))))
17568 (message "%d entries between %s and %s"
17569 (org-occur regexp nil callback) start-date end-date)))
17571 (defun org-evaluate-time-range (&optional to-buffer)
17572 "Evaluate a time range by computing the difference between start and end.
17573 Normally the result is just printed in the echo area, but with prefix arg
17574 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17575 If the time range is actually in a table, the result is inserted into the
17576 next column.
17577 For time difference computation, a year is assumed to be exactly 365
17578 days in order to avoid rounding problems."
17579 (interactive "P")
17581 (org-clock-update-time-maybe)
17582 (save-excursion
17583 (unless (org-at-date-range-p t)
17584 (goto-char (point-at-bol))
17585 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17586 (if (not (org-at-date-range-p t))
17587 (user-error "Not at a time-stamp range, and none found in current line")))
17588 (let* ((ts1 (match-string 1))
17589 (ts2 (match-string 2))
17590 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17591 (match-end (match-end 0))
17592 (time1 (org-time-string-to-time ts1))
17593 (time2 (org-time-string-to-time ts2))
17594 (t1 (org-float-time time1))
17595 (t2 (org-float-time time2))
17596 (diff (abs (- t2 t1)))
17597 (negative (< (- t2 t1) 0))
17598 ;; (ys (floor (* 365 24 60 60)))
17599 (ds (* 24 60 60))
17600 (hs (* 60 60))
17601 (fy "%dy %dd %02d:%02d")
17602 (fy1 "%dy %dd")
17603 (fd "%dd %02d:%02d")
17604 (fd1 "%dd")
17605 (fh "%02d:%02d")
17606 y d h m align)
17607 (if havetime
17608 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17610 d (floor (/ diff ds)) diff (mod diff ds)
17611 h (floor (/ diff hs)) diff (mod diff hs)
17612 m (floor (/ diff 60)))
17613 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17615 d (floor (+ (/ diff ds) 0.5))
17616 h 0 m 0))
17617 (if (not to-buffer)
17618 (message "%s" (org-make-tdiff-string y d h m))
17619 (if (org-at-table-p)
17620 (progn
17621 (goto-char match-end)
17622 (setq align t)
17623 (and (looking-at " *|") (goto-char (match-end 0))))
17624 (goto-char match-end))
17625 (if (looking-at
17626 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17627 (replace-match ""))
17628 (if negative (insert " -"))
17629 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17630 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17631 (insert " " (format fh h m))))
17632 (if align (org-table-align))
17633 (message "Time difference inserted")))))
17635 (defun org-make-tdiff-string (y d h m)
17636 (let ((fmt "")
17637 (l nil))
17638 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17639 l (push y l)))
17640 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17641 l (push d l)))
17642 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17643 l (push h l)))
17644 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17645 l (push m l)))
17646 (apply 'format fmt (nreverse l))))
17648 (defun org-time-string-to-time (s &optional buffer pos)
17649 "Convert a timestamp string into internal time."
17650 (condition-case errdata
17651 (apply 'encode-time (org-parse-time-string s))
17652 (error (error "Bad timestamp `%s'%s\nError was: %s"
17653 s (if (not (and buffer pos))
17655 (format-message " at %d in buffer `%s'" pos buffer))
17656 (cdr errdata)))))
17658 (defun org-time-string-to-seconds (s)
17659 "Convert a timestamp string to a number of seconds."
17660 (org-float-time (org-time-string-to-time s)))
17662 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17663 "Convert a time stamp to an absolute day number.
17664 If there is a specifier for a cyclic time stamp, get the closest
17665 date to DAYNR.
17666 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17667 The variable `date' is bound by the calendar when this is called."
17668 (cond
17669 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17670 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17671 daynr
17672 (+ daynr 1000)))
17673 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17674 (> (string-to-number (match-string 1 s)) 0))
17675 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17676 (time-to-days (current-time))) (match-string 0 s)
17677 prefer show-all))
17678 (t (time-to-days
17679 (condition-case errdata
17680 (apply 'encode-time (org-parse-time-string s))
17681 (error (error "Bad timestamp `%s'%s\nError was: %s"
17682 s (if (not (and buffer pos))
17684 (format-message " at %d in buffer `%s'" pos buffer))
17685 (cdr errdata))))))))
17687 (defun org-days-to-iso-week (days)
17688 "Return the iso week number."
17689 (require 'cal-iso)
17690 (car (calendar-iso-from-absolute days)))
17692 (defun org-small-year-to-year (year)
17693 "Convert 2-digit years into 4-digit years.
17694 YEAR is expanded into one of the 30 next years, if possible, or
17695 into a past one. Any year larger than 99 is returned unchanged."
17696 (if (>= year 100) year
17697 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17698 (century (/ current 100))
17699 (offset (- year (% current 100))))
17700 (cond ((> offset 30) (+ (* (1- century) 100) year))
17701 ((> offset -70) (+ (* century 100) year))
17702 (t (+ (* (1+ century) 100) year))))))
17704 (defun org-time-from-absolute (d)
17705 "Return the time corresponding to date D.
17706 D may be an absolute day number, or a calendar-type list (month day year)."
17707 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17708 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17710 (defun org-calendar-holiday ()
17711 "List of holidays, for Diary display in Org-mode."
17712 (require 'holidays)
17713 (let ((hl (funcall
17714 (if (fboundp 'calendar-check-holidays)
17715 'calendar-check-holidays 'check-calendar-holidays) date)))
17716 (if hl (mapconcat 'identity hl "; "))))
17718 (defun org-diary-sexp-entry (sexp entry date)
17719 "Process a SEXP diary ENTRY for DATE."
17720 (require 'diary-lib)
17721 (let ((result (if calendar-debug-sexp
17722 (let ((stack-trace-on-error t))
17723 (eval (car (read-from-string sexp))))
17724 (condition-case nil
17725 (eval (car (read-from-string sexp)))
17726 (error
17727 (beep)
17728 (message "Bad sexp at line %d in %s: %s"
17729 (org-current-line)
17730 (buffer-file-name) sexp)
17731 (sleep-for 2))))))
17732 (cond ((stringp result) (split-string result "; "))
17733 ((and (consp result)
17734 (not (consp (cdr result)))
17735 (stringp (cdr result))) (cdr result))
17736 ((and (consp result)
17737 (stringp (car result))) result)
17738 (result entry))))
17740 (defun org-diary-to-ical-string (frombuf)
17741 "Get iCalendar entries from diary entries in buffer FROMBUF.
17742 This uses the icalendar.el library."
17743 (let* ((tmpdir (if (featurep 'xemacs)
17744 (temp-directory)
17745 temporary-file-directory))
17746 (tmpfile (make-temp-name
17747 (expand-file-name "orgics" tmpdir)))
17748 buf rtn b e)
17749 (with-current-buffer frombuf
17750 (icalendar-export-region (point-min) (point-max) tmpfile)
17751 (setq buf (find-buffer-visiting tmpfile))
17752 (set-buffer buf)
17753 (goto-char (point-min))
17754 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17755 (setq b (match-beginning 0)))
17756 (goto-char (point-max))
17757 (if (re-search-backward "^END:VEVENT" nil t)
17758 (setq e (match-end 0)))
17759 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17760 (kill-buffer buf)
17761 (delete-file tmpfile)
17762 rtn))
17764 (defun org-closest-date (start current change prefer show-all)
17765 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17766 When PREFER is `past', return a date that is either CURRENT or past.
17767 When PREFER is `future', return a date that is either CURRENT or future.
17768 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17769 ;; Make the proper lists from the dates
17770 (catch 'exit
17771 (let ((a1 '(("h" . hour)
17772 ("d" . day)
17773 ("w" . week)
17774 ("m" . month)
17775 ("y" . year)))
17776 (shour (nth 2 (org-parse-time-string start)))
17777 dn dw sday cday n1 n2 n0
17778 d m y y1 y2 date1 date2 nmonths nm ny m2)
17780 (setq start (org-date-to-gregorian start)
17781 current (org-date-to-gregorian
17782 (if show-all
17783 current
17784 (time-to-days (current-time))))
17785 sday (calendar-absolute-from-gregorian start)
17786 cday (calendar-absolute-from-gregorian current))
17788 (if (<= cday sday) (throw 'exit sday))
17790 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17791 (setq dn (string-to-number (match-string 1 change))
17792 dw (cdr (assoc (match-string 2 change) a1))))
17793 (unless (and dn (> dn 0))
17794 (user-error "Invalid change specifier: %s" change))
17795 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17796 (cond
17797 ((eq dw 'hour)
17798 (let ((missing-hours
17799 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17800 dn)))
17801 (setq n1 (if (zerop missing-hours) cday
17802 (- cday (1+ (floor (/ missing-hours 24)))))
17803 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17804 ((eq dw 'day)
17805 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17806 n2 (+ n1 dn)))
17807 ((eq dw 'year)
17808 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17809 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17810 (setq date1 (list m d y1)
17811 n1 (calendar-absolute-from-gregorian date1)
17812 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17813 n2 (calendar-absolute-from-gregorian date2)))
17814 ((eq dw 'month)
17815 ;; approx number of month between the two dates
17816 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17817 ;; How often does dn fit in there?
17818 (setq d (nth 1 start) m (car start) y (nth 2 start)
17819 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17820 m (+ m nm)
17821 ny (floor (/ m 12))
17822 y (+ y ny)
17823 m (- m (* ny 12)))
17824 (while (> m 12) (setq m (- m 12) y (1+ y)))
17825 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17826 (setq m2 (+ m dn) y2 y)
17827 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17828 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17829 (while (<= n2 cday)
17830 (setq n1 n2 m m2 y y2)
17831 (setq m2 (+ m dn) y2 y)
17832 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17833 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17834 ;; Make sure n1 is the earlier date
17835 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17836 (if show-all
17837 (cond
17838 ((eq prefer 'past) (if (= cday n2) n2 n1))
17839 ((eq prefer 'future) (if (= cday n1) n1 n2))
17840 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17841 (cond
17842 ((eq prefer 'past) (if (= cday n2) n2 n1))
17843 ((eq prefer 'future) (if (= cday n1) n1 n2))
17844 (t (if (= cday n1) n1 n2)))))))
17846 (defun org-date-to-gregorian (date)
17847 "Turn any specification of DATE into a Gregorian date for the calendar."
17848 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17849 ((and (listp date) (= (length date) 3)) date)
17850 ((stringp date)
17851 (setq date (org-parse-time-string date))
17852 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17853 ((listp date)
17854 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17856 (defun org-parse-time-string (s &optional nodefault)
17857 "Parse the standard Org-mode time string.
17858 This should be a lot faster than the normal `parse-time-string'.
17859 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17860 hour and minute fields will be nil if not given."
17861 (cond ((string-match org-ts-regexp0 s)
17862 (list 0
17863 (if (or (match-beginning 8) (not nodefault))
17864 (string-to-number (or (match-string 8 s) "0")))
17865 (if (or (match-beginning 7) (not nodefault))
17866 (string-to-number (or (match-string 7 s) "0")))
17867 (string-to-number (match-string 4 s))
17868 (string-to-number (match-string 3 s))
17869 (string-to-number (match-string 2 s))
17870 nil nil nil))
17871 ((string-match "^<[^>]+>$" s)
17872 (decode-time (seconds-to-time (org-matcher-time s))))
17873 (t (error "Not a standard Org-mode time string: %s" s))))
17875 (defun org-timestamp-up (&optional arg)
17876 "Increase the date item at the cursor by one.
17877 If the cursor is on the year, change the year. If it is on the month,
17878 the day or the time, change that.
17879 With prefix ARG, change by that many units."
17880 (interactive "p")
17881 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17883 (defun org-timestamp-down (&optional arg)
17884 "Decrease the date item at the cursor by one.
17885 If the cursor is on the year, change the year. If it is on the month,
17886 the day or the time, change that.
17887 With prefix ARG, change by that many units."
17888 (interactive "p")
17889 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17891 (defun org-timestamp-up-day (&optional arg)
17892 "Increase the date in the time stamp by one day.
17893 With prefix ARG, change that many days."
17894 (interactive "p")
17895 (if (and (not (org-at-timestamp-p t))
17896 (org-at-heading-p))
17897 (org-todo 'up)
17898 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17900 (defun org-timestamp-down-day (&optional arg)
17901 "Decrease the date in the time stamp by one day.
17902 With prefix ARG, change that many days."
17903 (interactive "p")
17904 (if (and (not (org-at-timestamp-p t))
17905 (org-at-heading-p))
17906 (org-todo 'down)
17907 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17909 (defun org-at-timestamp-p (&optional inactive-ok)
17910 "Non-nil if point is inside a timestamp.
17912 When optional argument INACTIVE-OK is non-nil, also consider
17913 inactive timestamps.
17915 When this function returns a non-nil value, match data is set
17916 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
17917 INACTIVE-OK."
17918 (interactive)
17919 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17920 (pos (point))
17921 (ans (or (looking-at tsr)
17922 (save-excursion
17923 (skip-chars-backward "^[<\n\r\t")
17924 (if (> (point) (point-min)) (backward-char 1))
17925 (and (looking-at tsr)
17926 (> (- (match-end 0) pos) -1))))))
17927 (and ans
17928 (boundp 'org-ts-what)
17929 (setq org-ts-what
17930 (cond
17931 ((= pos (match-beginning 0)) 'bracket)
17932 ;; Point is considered to be "on the bracket" whether
17933 ;; it's really on it or right after it.
17934 ((= pos (1- (match-end 0))) 'bracket)
17935 ((= pos (match-end 0)) 'after)
17936 ((org-pos-in-match-range pos 2) 'year)
17937 ((org-pos-in-match-range pos 3) 'month)
17938 ((org-pos-in-match-range pos 7) 'hour)
17939 ((org-pos-in-match-range pos 8) 'minute)
17940 ((or (org-pos-in-match-range pos 4)
17941 (org-pos-in-match-range pos 5)) 'day)
17942 ((and (> pos (or (match-end 8) (match-end 5)))
17943 (< pos (match-end 0)))
17944 (- pos (or (match-end 8) (match-end 5))))
17945 (t 'day))))
17946 ans))
17948 (defun org-toggle-timestamp-type ()
17949 "Toggle the type (<active> or [inactive]) of a time stamp."
17950 (interactive)
17951 (when (org-at-timestamp-p t)
17952 (let ((beg (match-beginning 0)) (end (match-end 0))
17953 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17954 (save-excursion
17955 (goto-char beg)
17956 (while (re-search-forward "[][<>]" end t)
17957 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17958 t t)))
17959 (message "Timestamp is now %sactive"
17960 (if (equal (char-after beg) ?<) "" "in")))))
17962 (defun org-at-clock-log-p nil
17963 "Is the cursor on the clock log line?"
17964 (save-excursion
17965 (move-beginning-of-line 1)
17966 (looking-at org-clock-line-re)))
17968 (defvar org-clock-history) ; defined in org-clock.el
17969 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17970 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17971 "Change the date in the time stamp at point.
17972 The date will be changed by N times WHAT. WHAT can be `day', `month',
17973 `year', `minute', `second'. If WHAT is not given, the cursor position
17974 in the timestamp determines what will be changed.
17975 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17976 (let ((origin (point)) origin-cat
17977 with-hm inactive
17978 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17979 org-ts-what
17980 extra rem
17981 ts time time0 fixnext clrgx)
17982 (if (not (org-at-timestamp-p t))
17983 (user-error "Not at a timestamp"))
17984 (if (and (not what) (eq org-ts-what 'bracket))
17985 (org-toggle-timestamp-type)
17986 ;; Point isn't on brackets. Remember the part of the time-stamp
17987 ;; the point was in. Indeed, size of time-stamps may change,
17988 ;; but point must be kept in the same category nonetheless.
17989 (setq origin-cat org-ts-what)
17990 (if (and (not what) (not (eq org-ts-what 'day))
17991 org-display-custom-times
17992 (get-text-property (point) 'display)
17993 (not (get-text-property (1- (point)) 'display)))
17994 (setq org-ts-what 'day))
17995 (setq org-ts-what (or what org-ts-what)
17996 inactive (= (char-after (match-beginning 0)) ?\[)
17997 ts (match-string 0))
17998 (replace-match "")
17999 (when (string-match
18000 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
18002 (setq extra (match-string 1 ts))
18003 (if suppress-tmp-delay
18004 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
18005 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
18006 (setq with-hm t))
18007 (setq time0 (org-parse-time-string ts))
18008 (when (and updown
18009 (eq org-ts-what 'minute)
18010 (not current-prefix-arg))
18011 ;; This looks like s-up and s-down. Change by one rounding step.
18012 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
18013 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
18014 (setcar (cdr time0) (+ (nth 1 time0)
18015 (if (> n 0) (- rem) (- dm rem))))))
18016 (setq time
18017 (encode-time (or (car time0) 0)
18018 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
18019 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
18020 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
18021 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
18022 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
18023 (nthcdr 6 time0)))
18024 (when (and (member org-ts-what '(hour minute))
18025 extra
18026 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
18027 (setq extra (org-modify-ts-extra
18028 extra
18029 (if (eq org-ts-what 'hour) 2 5)
18030 n dm)))
18031 (when (integerp org-ts-what)
18032 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
18033 (if (eq what 'calendar)
18034 (let ((cal-date (org-get-date-from-calendar)))
18035 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
18036 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
18037 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
18038 (setcar time0 (or (car time0) 0))
18039 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18040 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18041 (setq time (apply 'encode-time time0))))
18042 ;; Insert the new time-stamp, and ensure point stays in the same
18043 ;; category as before (i.e. not after the last position in that
18044 ;; category).
18045 (let ((pos (point)))
18046 ;; Stay before inserted string. `save-excursion' is of no use.
18047 (setq org-last-changed-timestamp
18048 (org-insert-time-stamp time with-hm inactive nil nil extra))
18049 (goto-char pos))
18050 (save-match-data
18051 (looking-at org-ts-regexp3)
18052 (goto-char (cond
18053 ;; `day' category ends before `hour' if any, or at
18054 ;; the end of the day name.
18055 ((eq origin-cat 'day)
18056 (min (or (match-beginning 7) (1- (match-end 5))) origin))
18057 ((eq origin-cat 'hour) (min (match-end 7) origin))
18058 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
18059 ((integerp origin-cat) (min (1- (match-end 0)) origin))
18060 ;; `year' and `month' have both fixed size: point
18061 ;; couldn't have moved into another part.
18062 (t origin))))
18063 ;; Update clock if on a CLOCK line.
18064 (org-clock-update-time-maybe)
18065 ;; Maybe adjust the closest clock in `org-clock-history'
18066 (when org-clock-adjust-closest
18067 (if (not (and (org-at-clock-log-p)
18068 (< 1 (length (delq nil (mapcar 'marker-position
18069 org-clock-history))))))
18070 (message "No clock to adjust")
18071 (cond ((save-excursion ; fix previous clock?
18072 (re-search-backward org-ts-regexp0 nil t)
18073 (org-looking-back (concat org-clock-string " \\[")
18074 (line-beginning-position)))
18075 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18076 ((save-excursion ; fix next clock?
18077 (re-search-backward org-ts-regexp0 nil t)
18078 (looking-at (concat org-ts-regexp0 "\\] =>")))
18079 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18080 (save-window-excursion
18081 ;; Find closest clock to point, adjust the previous/next one in history
18082 (let* ((p (save-excursion (org-back-to-heading t)))
18083 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18084 (clfixnth
18085 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18086 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18087 (if (not clfixpos)
18088 (message "No clock to adjust")
18089 (save-excursion
18090 (org-goto-marker-or-bmk clfixpos)
18091 (org-show-subtree)
18092 (when (re-search-forward clrgx nil t)
18093 (goto-char (match-beginning 1))
18094 (let (org-clock-adjust-closest)
18095 (org-timestamp-change n org-ts-what updown))
18096 (message "Clock adjusted in %s for heading: %s"
18097 (file-name-nondirectory (buffer-file-name))
18098 (org-get-heading t t)))))))))
18099 ;; Try to recenter the calendar window, if any.
18100 (if (and org-calendar-follow-timestamp-change
18101 (get-buffer-window "*Calendar*" t)
18102 (memq org-ts-what '(day month year)))
18103 (org-recenter-calendar (time-to-days time))))))
18105 (defun org-modify-ts-extra (s pos n dm)
18106 "Change the different parts of the lead-time and repeat fields in timestamp."
18107 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18108 ng h m new rem)
18109 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18110 (cond
18111 ((or (org-pos-in-match-range pos 2)
18112 (org-pos-in-match-range pos 3))
18113 (setq m (string-to-number (match-string 3 s))
18114 h (string-to-number (match-string 2 s)))
18115 (if (org-pos-in-match-range pos 2)
18116 (setq h (+ h n))
18117 (setq n (* dm (org-no-warnings (signum n))))
18118 (when (not (= 0 (setq rem (% m dm))))
18119 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18120 (setq m (+ m n)))
18121 (if (< m 0) (setq m (+ m 60) h (1- h)))
18122 (if (> m 59) (setq m (- m 60) h (1+ h)))
18123 (setq h (mod h 24))
18124 (setq ng 1 new (format "-%02d:%02d" h m)))
18125 ((org-pos-in-match-range pos 6)
18126 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18127 ((org-pos-in-match-range pos 5)
18128 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18130 ((org-pos-in-match-range pos 9)
18131 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18132 ((org-pos-in-match-range pos 8)
18133 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18135 (when ng
18136 (setq s (concat
18137 (substring s 0 (match-beginning ng))
18139 (substring s (match-end ng))))))
18142 (defun org-recenter-calendar (date)
18143 "If the calendar is visible, recenter it to DATE."
18144 (let ((cwin (get-buffer-window "*Calendar*" t)))
18145 (when cwin
18146 (let ((calendar-move-hook nil))
18147 (with-selected-window cwin
18148 (calendar-goto-date (if (listp date) date
18149 (calendar-gregorian-from-absolute date))))))))
18151 (defun org-goto-calendar (&optional arg)
18152 "Go to the Emacs calendar at the current date.
18153 If there is a time stamp in the current line, go to that date.
18154 A prefix ARG can be used to force the current date."
18155 (interactive "P")
18156 (let ((tsr org-ts-regexp) diff
18157 (calendar-move-hook nil)
18158 (calendar-view-holidays-initially-flag nil)
18159 (calendar-view-diary-initially-flag nil))
18160 (if (or (org-at-timestamp-p)
18161 (save-excursion
18162 (beginning-of-line 1)
18163 (looking-at (concat ".*" tsr))))
18164 (let ((d1 (time-to-days (current-time)))
18165 (d2 (time-to-days
18166 (org-time-string-to-time (match-string 1)))))
18167 (setq diff (- d2 d1))))
18168 (calendar)
18169 (calendar-goto-today)
18170 (if (and diff (not arg)) (calendar-forward-day diff))))
18172 (defun org-get-date-from-calendar ()
18173 "Return a list (month day year) of date at point in calendar."
18174 (with-current-buffer "*Calendar*"
18175 (save-match-data
18176 (calendar-cursor-to-date))))
18178 (defun org-date-from-calendar ()
18179 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18180 If there is already a time stamp at the cursor position, update it."
18181 (interactive)
18182 (if (org-at-timestamp-p t)
18183 (org-timestamp-change 0 'calendar)
18184 (let ((cal-date (org-get-date-from-calendar)))
18185 (org-insert-time-stamp
18186 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18188 (defcustom org-effort-durations
18189 `(("min" . 1)
18190 ("h" . 60)
18191 ("d" . ,(* 60 8))
18192 ("w" . ,(* 60 8 5))
18193 ("m" . ,(* 60 8 5 4))
18194 ("y" . ,(* 60 8 5 40)))
18195 "Conversion factor to minutes for an effort modifier.
18197 Each entry has the form (MODIFIER . MINUTES).
18199 In an effort string, a number followed by MODIFIER is multiplied
18200 by the specified number of MINUTES to obtain an effort in
18201 minutes.
18203 For example, if the value of this variable is ((\"hours\" . 60)), then an
18204 effort string \"2hours\" is equivalent to 120 minutes."
18205 :group 'org-agenda
18206 :version "25.1"
18207 :package-version '(Org . "8.3")
18208 :type '(alist :key-type (string :tag "Modifier")
18209 :value-type (number :tag "Minutes")))
18211 (defun org-minutes-to-clocksum-string (m)
18212 "Format number of minutes as a clocksum string.
18213 The format is determined by `org-time-clocksum-format',
18214 `org-time-clocksum-use-fractional' and
18215 `org-time-clocksum-fractional-format' and
18216 `org-time-clocksum-use-effort-durations'."
18217 (let ((clocksum "")
18218 (m (round m)) ; Don't allow fractions of minutes
18219 h d w mo y fmt n)
18220 (setq h (if org-time-clocksum-use-effort-durations
18221 (cdr (assoc "h" org-effort-durations)) 60)
18222 d (if org-time-clocksum-use-effort-durations
18223 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18224 w (if org-time-clocksum-use-effort-durations
18225 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18226 mo (if org-time-clocksum-use-effort-durations
18227 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18228 y (if org-time-clocksum-use-effort-durations
18229 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18230 ;; fractional format
18231 (if org-time-clocksum-use-fractional
18232 (cond
18233 ;; single format string
18234 ((stringp org-time-clocksum-fractional-format)
18235 (format org-time-clocksum-fractional-format (/ m (float h))))
18236 ;; choice of fractional formats for different time units
18237 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18238 (> (/ (truncate m) (* y d h)) 0))
18239 (format fmt (/ m (* y d (float h)))))
18240 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18241 (> (/ (truncate m) (* mo d h)) 0))
18242 (format fmt (/ m (* mo d (float h)))))
18243 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18244 (> (/ (truncate m) (* w d h)) 0))
18245 (format fmt (/ m (* w d (float h)))))
18246 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18247 (> (/ (truncate m) (* d h)) 0))
18248 (format fmt (/ m (* d (float h)))))
18249 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18250 (> (/ (truncate m) h) 0))
18251 (format fmt (/ m (float h))))
18252 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18253 (format fmt m))
18254 ;; fall back to smallest time unit with a format
18255 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18256 (format fmt (/ m (float h))))
18257 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18258 (format fmt (/ m (* d (float h)))))
18259 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18260 (format fmt (/ m (* w d (float h)))))
18261 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18262 (format fmt (/ m (* mo d (float h)))))
18263 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18264 (format fmt (/ m (* y d (float h))))))
18265 ;; standard (non-fractional) format, with single format string
18266 (if (stringp org-time-clocksum-format)
18267 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18268 ;; separate formats components
18269 (and (setq fmt (plist-get org-time-clocksum-format :years))
18270 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18271 (plist-get org-time-clocksum-format :require-years))
18272 (setq clocksum (concat clocksum (format fmt n))
18273 m (- m (* n y d h))))
18274 (and (setq fmt (plist-get org-time-clocksum-format :months))
18275 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18276 (plist-get org-time-clocksum-format :require-months))
18277 (setq clocksum (concat clocksum (format fmt n))
18278 m (- m (* n mo d h))))
18279 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18280 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18281 (plist-get org-time-clocksum-format :require-weeks))
18282 (setq clocksum (concat clocksum (format fmt n))
18283 m (- m (* n w d h))))
18284 (and (setq fmt (plist-get org-time-clocksum-format :days))
18285 (or (> (setq n (/ (truncate m) (* d h))) 0)
18286 (plist-get org-time-clocksum-format :require-days))
18287 (setq clocksum (concat clocksum (format fmt n))
18288 m (- m (* n d h))))
18289 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18290 (or (> (setq n (/ (truncate m) h)) 0)
18291 (plist-get org-time-clocksum-format :require-hours))
18292 (setq clocksum (concat clocksum (format fmt n))
18293 m (- m (* n h))))
18294 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18295 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18296 (setq clocksum (concat clocksum (format fmt m))))
18297 ;; return formatted time duration
18298 clocksum))))
18300 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18301 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18302 "Org mode version 8.0")
18304 (defun org-hours-to-clocksum-string (n)
18305 (org-minutes-to-clocksum-string (* n 60)))
18307 (defun org-hh:mm-string-to-minutes (s)
18308 "Convert a string H:MM to a number of minutes.
18309 If the string is just a number, interpret it as minutes.
18310 In fact, the first hh:mm or number in the string will be taken,
18311 there can be extra stuff in the string.
18312 If no number is found, the return value is 0."
18313 (cond
18314 ((integerp s) s)
18315 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18316 (+ (* (string-to-number (match-string 1 s)) 60)
18317 (string-to-number (match-string 2 s))))
18318 ((string-match "\\([0-9]+\\)" s)
18319 (string-to-number (match-string 1 s)))
18320 (t 0)))
18322 (defcustom org-image-actual-width t
18323 "Should we use the actual width of images when inlining them?
18325 When set to t, always use the image width.
18327 When set to a number, use imagemagick (when available) to set
18328 the image's width to this value.
18330 When set to a number in a list, try to get the width from any
18331 #+ATTR.* keyword if it matches a width specification like
18333 #+ATTR_HTML: :width 300px
18335 and fall back on that number if none is found.
18337 When set to nil, try to get the width from an #+ATTR.* keyword
18338 and fall back on the original width if none is found.
18340 This requires Emacs >= 24.1, build with imagemagick support."
18341 :group 'org-appearance
18342 :version "24.4"
18343 :package-version '(Org . "8.0")
18344 :type '(choice
18345 (const :tag "Use the image width" t)
18346 (integer :tag "Use a number of pixels")
18347 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18348 (const :tag "Use #+ATTR* or don't resize" nil)))
18350 (defcustom org-agenda-inhibit-startup nil
18351 "Inhibit startup when preparing agenda buffers.
18352 When this variable is t, the initialization of the Org agenda
18353 buffers is inhibited: e.g. the visibility state is not set, the
18354 tables are not re-aligned, etc."
18355 :type 'boolean
18356 :version "24.3"
18357 :group 'org-agenda)
18359 (define-obsolete-variable-alias
18360 'org-agenda-ignore-drawer-properties
18361 'org-agenda-ignore-properties "25.1")
18363 (defcustom org-agenda-ignore-properties nil
18364 "Avoid updating text properties when building the agenda.
18365 Properties are used to prepare buffers for effort estimates,
18366 appointments, statistics and subtree-local categories.
18367 If you don't use these in the agenda, you can add them to this
18368 list and agenda building will be a bit faster.
18369 The value is a list, with zero or more of the symbols `effort', `appt',
18370 `stats' or `category'."
18371 :type '(set :greedy t
18372 (const effort)
18373 (const appt)
18374 (const stats)
18375 (const category))
18376 :version "25.1"
18377 :package-version '(Org . "8.3")
18378 :group 'org-agenda)
18380 (defun org-duration-string-to-minutes (s &optional output-to-string)
18381 "Convert a duration string S to minutes.
18383 A bare number is interpreted as minutes, modifiers can be set by
18384 customizing `org-effort-durations' (which see).
18386 Entries containing a colon are interpreted as H:MM by
18387 `org-hh:mm-string-to-minutes'."
18388 (let ((result 0)
18389 (re (concat "\\([0-9.]+\\) *\\("
18390 (regexp-opt (mapcar 'car org-effort-durations))
18391 "\\)")))
18392 (while (string-match re s)
18393 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18394 (string-to-number (match-string 1 s))))
18395 (setq s (replace-match "" nil t s)))
18396 (setq result (floor result))
18397 (incf result (org-hh:mm-string-to-minutes s))
18398 (if output-to-string (number-to-string result) result)))
18400 ;;;; Files
18402 (defun org-save-all-org-buffers ()
18403 "Save all Org-mode buffers without user confirmation."
18404 (interactive)
18405 (message "Saving all Org-mode buffers...")
18406 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18407 (when (featurep 'org-id) (org-id-locations-save))
18408 (message "Saving all Org-mode buffers... done"))
18410 (defun org-revert-all-org-buffers ()
18411 "Revert all Org-mode buffers.
18412 Prompt for confirmation when there are unsaved changes.
18413 Be sure you know what you are doing before letting this function
18414 overwrite your changes.
18416 This function is useful in a setup where one tracks org files
18417 with a version control system, to revert on one machine after pulling
18418 changes from another. I believe the procedure must be like this:
18420 1. M-x org-save-all-org-buffers
18421 2. Pull changes from the other machine, resolve conflicts
18422 3. M-x org-revert-all-org-buffers"
18423 (interactive)
18424 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18425 (user-error "Abort"))
18426 (save-excursion
18427 (save-window-excursion
18428 (mapc
18429 (lambda (b)
18430 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18431 (with-current-buffer b buffer-file-name))
18432 (org-pop-to-buffer-same-window b)
18433 (revert-buffer t 'no-confirm)))
18434 (buffer-list))
18435 (when (and (featurep 'org-id) org-id-track-globally)
18436 (org-id-locations-load)))))
18438 ;;;; Agenda files
18440 ;;;###autoload
18441 (defun org-switchb (&optional arg)
18442 "Switch between Org buffers.
18443 With one prefix argument, restrict available buffers to files.
18444 With two prefix arguments, restrict available buffers to agenda files.
18446 Defaults to `iswitchb' for buffer name completion.
18447 Set `org-completion-use-ido' to make it use ido instead."
18448 (interactive "P")
18449 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18450 ((equal arg '(16)) (org-buffer-list 'agenda))
18451 (t (org-buffer-list))))
18452 (org-completion-use-iswitchb org-completion-use-iswitchb)
18453 (org-completion-use-ido org-completion-use-ido))
18454 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18455 (setq org-completion-use-iswitchb t))
18456 (org-pop-to-buffer-same-window
18457 (org-icompleting-read "Org buffer: "
18458 (mapcar 'list (mapcar 'buffer-name blist))
18459 nil t))))
18461 ;;; Define some older names previously used for this functionality
18462 ;;;###autoload
18463 (defalias 'org-ido-switchb 'org-switchb)
18464 ;;;###autoload
18465 (defalias 'org-iswitchb 'org-switchb)
18467 (defun org-buffer-list (&optional predicate exclude-tmp)
18468 "Return a list of Org buffers.
18469 PREDICATE can be `export', `files' or `agenda'.
18471 export restrict the list to Export buffers.
18472 files restrict the list to buffers visiting Org files.
18473 agenda restrict the list to buffers visiting agenda files.
18475 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18476 (let* ((bfn nil)
18477 (agenda-files (and (eq predicate 'agenda)
18478 (mapcar 'file-truename (org-agenda-files t))))
18479 (filter
18480 (cond
18481 ((eq predicate 'files)
18482 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18483 ((eq predicate 'export)
18484 (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
18485 ((eq predicate 'agenda)
18486 (lambda (b)
18487 (with-current-buffer b
18488 (and (derived-mode-p 'org-mode)
18489 (setq bfn (buffer-file-name b))
18490 (member (file-truename bfn) agenda-files)))))
18491 (t (lambda (b) (with-current-buffer b
18492 (or (derived-mode-p 'org-mode)
18493 (string-match "\\*Org .*Export"
18494 (buffer-name b)))))))))
18495 (delq nil
18496 (mapcar
18497 (lambda(b)
18498 (if (and (funcall filter b)
18499 (or (not exclude-tmp)
18500 (not (string-match "tmp" (buffer-name b)))))
18502 nil))
18503 (buffer-list)))))
18505 (defun org-agenda-files (&optional unrestricted archives)
18506 "Get the list of agenda files.
18507 Optional UNRESTRICTED means return the full list even if a restriction
18508 is currently in place.
18509 When ARCHIVES is t, include all archive files that are really being
18510 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18511 `org-agenda-archives-mode' is t."
18512 (let ((files
18513 (cond
18514 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18515 ((stringp org-agenda-files) (org-read-agenda-file-list))
18516 ((listp org-agenda-files) org-agenda-files)
18517 (t (error "Invalid value of `org-agenda-files'")))))
18518 (setq files (apply 'append
18519 (mapcar (lambda (f)
18520 (if (file-directory-p f)
18521 (directory-files
18522 f t org-agenda-file-regexp)
18523 (list f)))
18524 files)))
18525 (when org-agenda-skip-unavailable-files
18526 (setq files (delq nil
18527 (mapcar (function
18528 (lambda (file)
18529 (and (file-readable-p file) file)))
18530 files))))
18531 (when (or (eq archives t)
18532 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18533 (setq files (org-add-archive-files files)))
18534 files))
18536 (defun org-agenda-file-p (&optional file)
18537 "Return non-nil, if FILE is an agenda file.
18538 If FILE is omitted, use the file associated with the current
18539 buffer."
18540 (let ((fname (or file (buffer-file-name))))
18541 (and fname
18542 (member (file-truename fname)
18543 (mapcar #'file-truename (org-agenda-files t))))))
18545 (defun org-edit-agenda-file-list ()
18546 "Edit the list of agenda files.
18547 Depending on setup, this either uses customize to edit the variable
18548 `org-agenda-files', or it visits the file that is holding the list. In the
18549 latter case, the buffer is set up in a way that saving it automatically kills
18550 the buffer and restores the previous window configuration."
18551 (interactive)
18552 (if (stringp org-agenda-files)
18553 (let ((cw (current-window-configuration)))
18554 (find-file org-agenda-files)
18555 (org-set-local 'org-window-configuration cw)
18556 (org-add-hook 'after-save-hook
18557 (lambda ()
18558 (set-window-configuration
18559 (prog1 org-window-configuration
18560 (kill-buffer (current-buffer))))
18561 (org-install-agenda-files-menu)
18562 (message "New agenda file list installed"))
18563 nil 'local)
18564 (message "%s" (substitute-command-keys
18565 "Edit list and finish with \\[save-buffer]")))
18566 (customize-variable 'org-agenda-files)))
18568 (defun org-store-new-agenda-file-list (list)
18569 "Set new value for the agenda file list and save it correctly."
18570 (if (stringp org-agenda-files)
18571 (let ((fe (org-read-agenda-file-list t)) b u)
18572 (while (setq b (find-buffer-visiting org-agenda-files))
18573 (kill-buffer b))
18574 (with-temp-file org-agenda-files
18575 (insert
18576 (mapconcat
18577 (lambda (f) ;; Keep un-expanded entries.
18578 (if (setq u (assoc f fe))
18579 (cdr u)
18581 list "\n")
18582 "\n")))
18583 (let ((org-mode-hook nil) (org-inhibit-startup t)
18584 (org-insert-mode-line-in-empty-file nil))
18585 (setq org-agenda-files list)
18586 (customize-save-variable 'org-agenda-files org-agenda-files))))
18588 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18589 "Read the list of agenda files from a file.
18590 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18591 filenames, used by `org-store-new-agenda-file-list' to write back
18592 un-expanded file names."
18593 (when (file-directory-p org-agenda-files)
18594 (error "`org-agenda-files' cannot be a single directory"))
18595 (when (stringp org-agenda-files)
18596 (with-temp-buffer
18597 (insert-file-contents org-agenda-files)
18598 (mapcar
18599 (lambda (f)
18600 (let ((e (expand-file-name (substitute-in-file-name f)
18601 org-directory)))
18602 (if pair-with-expansion
18603 (cons e f)
18604 e)))
18605 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18607 ;;;###autoload
18608 (defun org-cycle-agenda-files ()
18609 "Cycle through the files in `org-agenda-files'.
18610 If the current buffer visits an agenda file, find the next one in the list.
18611 If the current buffer does not, find the first agenda file."
18612 (interactive)
18613 (let* ((fs (or (org-agenda-files t)
18614 (user-error "No agenda files")))
18615 (files (copy-sequence fs))
18616 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18617 file)
18618 (when tcf
18619 (while (and (setq file (pop files))
18620 (not (equal (file-truename file) tcf)))))
18621 (find-file (car (or files fs)))
18622 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18624 (defun org-agenda-file-to-front (&optional to-end)
18625 "Move/add the current file to the top of the agenda file list.
18626 If the file is not present in the list, it is added to the front. If it is
18627 present, it is moved there. With optional argument TO-END, add/move to the
18628 end of the list."
18629 (interactive "P")
18630 (let ((org-agenda-skip-unavailable-files nil)
18631 (file-alist (mapcar (lambda (x)
18632 (cons (file-truename x) x))
18633 (org-agenda-files t)))
18634 (ctf (file-truename
18635 (or buffer-file-name
18636 (user-error "Please save the current buffer to a file"))))
18637 x had)
18638 (setq x (assoc ctf file-alist) had x)
18640 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18641 (if to-end
18642 (setq file-alist (append (delq x file-alist) (list x)))
18643 (setq file-alist (cons x (delq x file-alist))))
18644 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18645 (org-install-agenda-files-menu)
18646 (message "File %s to %s of agenda file list"
18647 (if had "moved" "added") (if to-end "end" "front"))))
18649 (defun org-remove-file (&optional file)
18650 "Remove current file from the list of files in variable `org-agenda-files'.
18651 These are the files which are being checked for agenda entries.
18652 Optional argument FILE means use this file instead of the current."
18653 (interactive)
18654 (let* ((org-agenda-skip-unavailable-files nil)
18655 (file (or file buffer-file-name
18656 (user-error "Current buffer does not visit a file")))
18657 (true-file (file-truename file))
18658 (afile (abbreviate-file-name file))
18659 (files (delq nil (mapcar
18660 (lambda (x)
18661 (if (equal true-file
18662 (file-truename x))
18663 nil x))
18664 (org-agenda-files t)))))
18665 (if (not (= (length files) (length (org-agenda-files t))))
18666 (progn
18667 (org-store-new-agenda-file-list files)
18668 (org-install-agenda-files-menu)
18669 (message "Removed from Org Agenda list: %s" afile))
18670 (message "File was not in list: %s (not removed)" afile))))
18672 (defun org-file-menu-entry (file)
18673 (vector file (list 'find-file file) t))
18675 (defun org-check-agenda-file (file)
18676 "Make sure FILE exists. If not, ask user what to do."
18677 (when (not (file-exists-p file))
18678 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18679 (abbreviate-file-name file))
18680 (let ((r (downcase (read-char-exclusive))))
18681 (cond
18682 ((equal r ?r)
18683 (org-remove-file file)
18684 (throw 'nextfile t))
18685 (t (user-error "Abort"))))))
18687 (defun org-get-agenda-file-buffer (file)
18688 "Get an agenda buffer visiting FILE.
18689 If the buffer needs to be created, add it to the list of buffers
18690 which might be released later."
18691 (let ((buf (org-find-base-buffer-visiting file)))
18692 (if buf
18693 buf ; just return it
18694 ;; Make a new buffer and remember it
18695 (setq buf (find-file-noselect file))
18696 (if buf (push buf org-agenda-new-buffers))
18697 buf)))
18699 (defun org-release-buffers (blist)
18700 "Release all buffers in list, asking the user for confirmation when needed.
18701 When a buffer is unmodified, it is just killed. When modified, it is saved
18702 \(if the user agrees) and then killed."
18703 (let (file)
18704 (dolist (buf blist)
18705 (setq file (buffer-file-name buf))
18706 (when (and (buffer-modified-p buf)
18707 file
18708 (y-or-n-p (format "Save file %s? " file)))
18709 (with-current-buffer buf (save-buffer)))
18710 (kill-buffer buf))))
18712 (defun org-agenda-prepare-buffers (files)
18713 "Create buffers for all agenda files, protect archived trees and comments."
18714 (interactive)
18715 (let ((pa '(:org-archived t))
18716 (pc '(:org-comment t))
18717 (pall '(:org-archived t :org-comment t))
18718 (inhibit-read-only t)
18719 (org-inhibit-startup org-agenda-inhibit-startup)
18720 (rea (concat ":" org-archive-tag ":"))
18721 file re pos)
18722 (setq org-tag-alist-for-agenda nil
18723 org-tag-groups-alist-for-agenda nil)
18724 (save-excursion
18725 (save-restriction
18726 (dolist (file files)
18727 (catch 'nextfile
18728 (if (bufferp file)
18729 (set-buffer file)
18730 (org-check-agenda-file file)
18731 (set-buffer (org-get-agenda-file-buffer file)))
18732 (widen)
18733 (org-set-regexps-and-options 'tags-only)
18734 (setq pos (point))
18735 (or (memq 'category org-agenda-ignore-properties)
18736 (org-refresh-category-properties))
18737 (or (memq 'stats org-agenda-ignore-properties)
18738 (org-refresh-stats-properties))
18739 (or (memq 'effort org-agenda-ignore-properties)
18740 (org-refresh-effort-properties))
18741 (or (memq 'appt org-agenda-ignore-properties)
18742 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18743 (setq org-todo-keywords-for-agenda
18744 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18745 (setq org-done-keywords-for-agenda
18746 (append org-done-keywords-for-agenda org-done-keywords))
18747 (setq org-todo-keyword-alist-for-agenda
18748 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18749 (setq org-tag-alist-for-agenda
18750 (org-uniquify
18751 (append org-tag-alist-for-agenda
18752 org-tag-alist
18753 org-tag-persistent-alist)))
18754 ;; Merge current file's tag groups into global
18755 ;; `org-tag-groups-alist-for-agenda'.
18756 (when org-group-tags
18757 (dolist (alist org-tag-groups-alist)
18758 (let ((old (assoc (car alist) org-tag-groups-alist-for-agenda)))
18759 (if old
18760 (setcdr old (org-uniquify (append (cdr old) (cdr alist))))
18761 (push alist org-tag-groups-alist-for-agenda)))))
18762 (org-with-silent-modifications
18763 (save-excursion
18764 (remove-text-properties (point-min) (point-max) pall)
18765 (when org-agenda-skip-archived-trees
18766 (goto-char (point-min))
18767 (while (re-search-forward rea nil t)
18768 (if (org-at-heading-p t)
18769 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18770 (goto-char (point-min))
18771 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18772 (while (re-search-forward re nil t)
18773 (when (save-match-data (org-in-commented-heading-p t))
18774 (add-text-properties
18775 (match-beginning 0) (org-end-of-subtree t) pc)))))
18776 (goto-char pos)))))
18777 (setq org-todo-keywords-for-agenda
18778 (org-uniquify org-todo-keywords-for-agenda))
18779 (setq org-todo-keyword-alist-for-agenda
18780 (org-uniquify org-todo-keyword-alist-for-agenda))))
18783 ;;;; CDLaTeX minor mode
18785 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18786 "Keymap for the minor `org-cdlatex-mode'.")
18788 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18789 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18790 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18791 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18792 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18794 (defvar org-cdlatex-texmathp-advice-is-done nil
18795 "Flag remembering if we have applied the advice to texmathp already.")
18797 (define-minor-mode org-cdlatex-mode
18798 "Toggle the minor `org-cdlatex-mode'.
18799 This mode supports entering LaTeX environment and math in LaTeX fragments
18800 in Org-mode.
18801 \\{org-cdlatex-mode-map}"
18802 nil " OCDL" nil
18803 (when org-cdlatex-mode
18804 (require 'cdlatex)
18805 (run-hooks 'cdlatex-mode-hook)
18806 (cdlatex-compute-tables))
18807 (unless org-cdlatex-texmathp-advice-is-done
18808 (setq org-cdlatex-texmathp-advice-is-done t)
18809 (defadvice texmathp (around org-math-always-on activate)
18810 "Always return t in org-mode buffers.
18811 This is because we want to insert math symbols without dollars even outside
18812 the LaTeX math segments. If Orgmode thinks that point is actually inside
18813 an embedded LaTeX fragment, let texmathp do its job.
18814 \\[org-cdlatex-mode-map]"
18815 (interactive)
18816 (let (p)
18817 (cond
18818 ((not (derived-mode-p 'org-mode)) ad-do-it)
18819 ((eq this-command 'cdlatex-math-symbol)
18820 (setq ad-return-value t
18821 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18823 (let ((p (org-inside-LaTeX-fragment-p)))
18824 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18825 (setq ad-return-value t
18826 texmathp-why '("Org-mode embedded math" . 0))
18827 (if p ad-do-it)))))))))
18829 (defun turn-on-org-cdlatex ()
18830 "Unconditionally turn on `org-cdlatex-mode'."
18831 (org-cdlatex-mode 1))
18833 (defun org-try-cdlatex-tab ()
18834 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18835 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18836 - inside a LaTeX fragment, or
18837 - after the first word in a line, where an abbreviation expansion could
18838 insert a LaTeX environment."
18839 (when org-cdlatex-mode
18840 (cond
18841 ;; Before any word on the line: No expansion possible.
18842 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18843 ;; Just after first word on the line: Expand it. Make sure it
18844 ;; cannot happen on headlines, though.
18845 ((save-excursion
18846 (skip-chars-backward "a-zA-Z0-9*")
18847 (skip-chars-backward " \t")
18848 (and (bolp) (not (org-at-heading-p))))
18849 (cdlatex-tab) t)
18850 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18852 (defun org-cdlatex-underscore-caret (&optional arg)
18853 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18854 Revert to the normal definition outside of these fragments."
18855 (interactive "P")
18856 (if (org-inside-LaTeX-fragment-p)
18857 (call-interactively 'cdlatex-sub-superscript)
18858 (let (org-cdlatex-mode)
18859 (call-interactively (key-binding (vector last-input-event))))))
18861 (defun org-cdlatex-math-modify (&optional arg)
18862 "Execute `cdlatex-math-modify' in LaTeX fragments.
18863 Revert to the normal definition outside of these fragments."
18864 (interactive "P")
18865 (if (org-inside-LaTeX-fragment-p)
18866 (call-interactively 'cdlatex-math-modify)
18867 (let (org-cdlatex-mode)
18868 (call-interactively (key-binding (vector last-input-event))))))
18870 (defun org-cdlatex-environment-indent (&optional environment item)
18871 "Execute `cdlatex-environment' and indent the inserted environment.
18873 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18875 The inserted environment is indented to current indentation
18876 unless point is at the beginning of the line, in which the
18877 environment remains unintended."
18878 (interactive)
18879 ;; cdlatex-environment always return nil. Therefore, capture output
18880 ;; first and determine if an environment was selected.
18881 (let* ((beg (point-marker))
18882 (end (copy-marker (point) t))
18883 (inserted (progn
18884 (ignore-errors (cdlatex-environment environment item))
18885 (< beg end)))
18886 ;; Figure out how many lines to move forward after the
18887 ;; environment has been inserted.
18888 (lines (when inserted
18889 (save-excursion
18890 (- (loop while (< beg (point))
18891 with x = 0
18892 do (forward-line -1)
18893 (incf x)
18894 finally return x)
18895 (if (progn (goto-char beg)
18896 (and (progn (skip-chars-forward " \t") (eolp))
18897 (progn (skip-chars-backward " \t") (bolp))))
18898 1 0)))))
18899 (env (org-trim (delete-and-extract-region beg end))))
18900 (when inserted
18901 ;; Get indentation of next line unless at column 0.
18902 (let ((ind (if (bolp) 0
18903 (save-excursion
18904 (org-return-indent)
18905 (prog1 (org-get-indentation)
18906 (when (progn (skip-chars-forward " \t") (eolp))
18907 (delete-region beg (point)))))))
18908 (bol (progn (skip-chars-backward " \t") (bolp))))
18909 ;; Insert a newline before environment unless at column zero
18910 ;; to "escape" the current line. Insert a newline if
18911 ;; something is one the same line as \end{ENVIRONMENT}.
18912 (insert
18913 (concat (unless bol "\n") env
18914 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18915 (unless (zerop ind)
18916 (save-excursion
18917 (goto-char beg)
18918 (while (< (point) end)
18919 (unless (eolp) (org-indent-line-to ind))
18920 (forward-line))))
18921 (goto-char beg)
18922 (forward-line lines)
18923 (org-indent-line-to ind)))
18924 (set-marker beg nil)
18925 (set-marker end nil)))
18928 ;;;; LaTeX fragments
18930 (defun org-inside-LaTeX-fragment-p ()
18931 "Test if point is inside a LaTeX fragment.
18932 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18933 sequence appearing also before point.
18934 Even though the matchers for math are configurable, this function assumes
18935 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18936 delimiters are skipped when they have been removed by customization.
18937 The return value is nil, or a cons cell with the delimiter and the
18938 position of this delimiter.
18940 This function does a reasonably good job, but can locally be fooled by
18941 for example currency specifications. For example it will assume being in
18942 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18943 fragments that are properly closed, but during editing, we have to live
18944 with the uncertainty caused by missing closing delimiters. This function
18945 looks only before point, not after."
18946 (catch 'exit
18947 (let ((pos (point))
18948 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18949 (lim (progn
18950 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18951 (point)))
18952 dd-on str (start 0) m re)
18953 (goto-char pos)
18954 (when dodollar
18955 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18956 re (nth 1 (assoc "$" org-latex-regexps)))
18957 (while (string-match re str start)
18958 (cond
18959 ((= (match-end 0) (length str))
18960 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18961 ((= (match-end 0) (- (length str) 5))
18962 (throw 'exit nil))
18963 (t (setq start (match-end 0))))))
18964 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18965 (goto-char pos)
18966 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18967 (and (match-beginning 2) (throw 'exit nil))
18968 ;; count $$
18969 (while (re-search-backward "\\$\\$" lim t)
18970 (setq dd-on (not dd-on)))
18971 (goto-char pos)
18972 (if dd-on (cons "$$" m))))))
18974 (defun org-inside-latex-macro-p ()
18975 "Is point inside a LaTeX macro or its arguments?"
18976 (save-match-data
18977 (org-in-regexp
18978 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18980 (defvar org-latex-fragment-image-overlays nil
18981 "List of overlays carrying the images of latex fragments.")
18982 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18984 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18985 "Remove all overlays with LaTeX fragment images in current buffer.
18986 When optional arguments BEG and END are non-nil, remove all
18987 overlays between them instead. Return t when some overlays were
18988 removed, nil otherwise."
18989 (let (removedp)
18990 (setq org-latex-fragment-image-overlays
18991 (let ((beg (or beg (point-min)))
18992 (end (or end (point-max))))
18993 (org-remove-if
18994 (lambda (o)
18995 (cond ((not (overlay-buffer o)) (delete-overlay o) t)
18996 ((and (>= (overlay-start o) beg)
18997 (<= (overlay-end o) end))
18998 (delete-overlay o)
18999 (unless removedp (setq removedp t)))
19000 (t nil)))
19001 org-latex-fragment-image-overlays)))
19002 removedp))
19004 (define-obsolete-function-alias
19005 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
19006 (defun org-toggle-latex-fragment (&optional arg)
19007 "Preview the LaTeX fragment at point, or all locally or globally.
19009 If the cursor is on a LaTeX fragment, create the image and overlay
19010 it over the source code, if there is none. Remove it otherwise.
19011 If there is no fragment at point, display all fragments in the
19012 current section.
19014 With prefix ARG, preview or clear image for all fragments in the
19015 current subtree or in the whole buffer when used before the first
19016 headline. With a double prefix ARG \\[universal-argument] \
19017 \\[universal-argument] preview or clear images
19018 for all fragments in the buffer."
19019 (interactive "P")
19020 (unless (buffer-file-name (buffer-base-buffer))
19021 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
19022 (when (display-graphic-p)
19023 (catch 'exit
19024 (save-excursion
19025 (let ((window-start (window-start)) msg)
19026 (save-restriction
19027 (cond
19028 ((or (equal arg '(16))
19029 (and (equal arg '(4))
19030 (org-with-limited-levels (org-before-first-heading-p))))
19031 (if (org-remove-latex-fragment-image-overlays)
19032 (progn (message "LaTeX fragments images removed from buffer")
19033 (throw 'exit nil))
19034 (setq msg "Creating images for buffer...")))
19035 ((equal arg '(4))
19036 (org-with-limited-levels (org-back-to-heading t))
19037 (let ((beg (point))
19038 (end (progn (org-end-of-subtree t) (point))))
19039 (if (org-remove-latex-fragment-image-overlays beg end)
19040 (progn
19041 (message "LaTeX fragment images removed from subtree")
19042 (throw 'exit nil))
19043 (setq msg "Creating images for subtree...")
19044 (narrow-to-region beg end))))
19045 ((let ((datum (org-element-context)))
19046 (when (memq (org-element-type datum)
19047 '(latex-environment latex-fragment))
19048 (let* ((beg (org-element-property :begin datum))
19049 (end (org-element-property :end datum)))
19050 (if (org-remove-latex-fragment-image-overlays beg end)
19051 (progn (message "LaTeX fragment image removed")
19052 (throw 'exit nil))
19053 (narrow-to-region beg end)
19054 (setq msg "Creating image..."))))))
19056 (org-with-limited-levels
19057 (let ((beg (if (org-at-heading-p) (line-beginning-position)
19058 (outline-previous-heading)
19059 (point)))
19060 (end (progn (outline-next-heading) (point))))
19061 (if (org-remove-latex-fragment-image-overlays beg end)
19062 (progn
19063 (message "LaTeX fragment images removed from section")
19064 (throw 'exit nil))
19065 (setq msg "Creating images for section...")
19066 (narrow-to-region beg end))))))
19067 (let ((file (buffer-file-name (buffer-base-buffer))))
19068 (org-format-latex
19069 (concat org-latex-preview-ltxpng-directory
19070 (file-name-sans-extension (file-name-nondirectory file)))
19071 ;; Emacs cannot overlay images from remote hosts.
19072 ;; Create it in `temporary-file-directory' instead.
19073 (if (file-remote-p file) temporary-file-directory
19074 default-directory)
19075 'overlays msg 'forbuffer
19076 org-latex-create-formula-image-program)))
19077 ;; Work around a bug that doesn't restore window's start
19078 ;; when widening back the buffer.
19079 (set-window-start nil window-start)
19080 (message (concat msg "done")))))))
19082 (defun org-format-latex
19083 (prefix &optional dir overlays msg forbuffer processing-type)
19084 "Replace LaTeX fragments with links to an image, and produce images.
19086 When optional argument OVERLAYS is non-nil, display the image on
19087 top of the fragment instead of replacing it.
19089 PROCESSING-TYPE is the conversion method to use, as a symbol.
19091 Some of the options can be changed using the variable
19092 `org-format-latex-options', which see."
19093 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19094 (unless (eq processing-type 'verbatim)
19095 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19096 (cnt 0)
19097 checkdir-flag)
19098 (goto-char (point-min))
19099 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19100 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19101 (overlay-recenter (point-max)))
19102 (while (re-search-forward math-regexp nil t)
19103 (unless (and overlays
19104 (eq (get-char-property (point) 'org-overlay-type)
19105 'org-latex-overlay))
19106 (let* ((context (org-element-context))
19107 (type (org-element-type context)))
19108 (when (memq type '(latex-environment latex-fragment))
19109 (let ((block-type (eq type 'latex-environment))
19110 (value (org-element-property :value context))
19111 (beg (org-element-property :begin context))
19112 (end (save-excursion
19113 (goto-char (org-element-property :end context))
19114 (skip-chars-backward " \r\t\n")
19115 (point))))
19116 (case processing-type
19117 (mathjax
19118 ;; Prepare for MathJax processing.
19119 (if (not (string-match "\\`\\$\\$?" value))
19120 (goto-char end)
19121 (delete-region beg end)
19122 (if (string= (match-string 0 value) "$$")
19123 (insert "\\[" (substring value 2 -2) "\\]")
19124 (insert "\\(" (substring value 1 -1) "\\)"))))
19125 ((dvipng imagemagick)
19126 ;; Process to an image.
19127 (incf cnt)
19128 (goto-char beg)
19129 (let* ((face (face-at-point))
19130 ;; Get the colors from the face at point.
19132 (let ((color (plist-get org-format-latex-options
19133 :foreground)))
19134 (if (and forbuffer (eq color 'auto))
19135 (face-attribute face :foreground nil 'default)
19136 color)))
19138 (let ((color (plist-get org-format-latex-options
19139 :background)))
19140 (if (and forbuffer (eq color 'auto))
19141 (face-attribute face :background nil 'default)
19142 color)))
19143 (hash (sha1 (prin1-to-string
19144 (list org-format-latex-header
19145 org-latex-default-packages-alist
19146 org-latex-packages-alist
19147 org-format-latex-options
19148 forbuffer value fg bg))))
19149 (absprefix (expand-file-name prefix dir))
19150 (linkfile (format "%s_%s.png" prefix hash))
19151 (movefile (format "%s_%s.png" absprefix hash))
19152 (sep (and block-type "\n\n"))
19153 (link (concat sep "[[file:" linkfile "]]" sep))
19154 (options
19155 (org-combine-plists
19156 org-format-latex-options
19157 `(:foreground ,fg :background ,bg))))
19158 (when msg (message msg cnt))
19159 (unless checkdir-flag ; Ensure the directory exists.
19160 (setq checkdir-flag t)
19161 (let ((todir (file-name-directory absprefix)))
19162 (unless (file-directory-p todir)
19163 (make-directory todir t))))
19164 (unless (file-exists-p movefile)
19165 (org-create-formula-image
19166 value movefile options forbuffer processing-type))
19167 (if overlays
19168 (progn
19169 (dolist (o (overlays-in beg end))
19170 (when (eq (overlay-get o 'org-overlay-type)
19171 'org-latex-overlay)
19172 (delete-overlay o)))
19173 (let ((ov (make-overlay beg end)))
19174 (overlay-put ov
19175 'org-overlay-type
19176 'org-latex-overlay)
19177 (overlay-put ov 'evaporate t)
19178 (if (featurep 'xemacs)
19179 (progn
19180 (overlay-put ov 'invisible t)
19181 (overlay-put
19182 ov 'end-glyph
19183 (make-glyph
19184 (vector 'png :file movefile))))
19185 (overlay-put
19186 ov 'display
19187 (list 'image
19188 :type 'png
19189 :file movefile
19190 :ascent 'center)))
19191 (push ov org-latex-fragment-image-overlays))
19192 (goto-char end))
19193 (delete-region beg end)
19194 (insert
19195 (org-add-props link
19196 (list 'org-latex-src
19197 (replace-regexp-in-string "\"" "" value)
19198 'org-latex-src-embed-type
19199 (if block-type 'paragraph 'character)))))))
19200 (mathml
19201 ;; Process to MathML.
19202 (unless (org-format-latex-mathml-available-p)
19203 (user-error "LaTeX to MathML converter not configured"))
19204 (incf cnt)
19205 (when msg (message msg cnt))
19206 (goto-char beg)
19207 (delete-region beg end)
19208 (insert (org-format-latex-as-mathml
19209 value block-type prefix dir)))
19210 (otherwise
19211 (error "Unknown conversion type %s for LaTeX fragments"
19212 processing-type)))))))))))
19214 (defun org-create-math-formula (latex-frag &optional mathml-file)
19215 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19216 Use `org-latex-to-mathml-convert-command'. If the conversion is
19217 sucessful, return the portion between \"<math...> </math>\"
19218 elements otherwise return nil. When MATHML-FILE is specified,
19219 write the results in to that file. When invoked as an
19220 interactive command, prompt for LATEX-FRAG, with initial value
19221 set to the current active region and echo the results for user
19222 inspection."
19223 (interactive (list (let ((frag (when (org-region-active-p)
19224 (buffer-substring-no-properties
19225 (region-beginning) (region-end)))))
19226 (read-string "LaTeX Fragment: " frag nil frag))))
19227 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19228 (let* ((tmp-in-file (file-relative-name
19229 (make-temp-name (expand-file-name "ltxmathml-in"))))
19230 (ignore (write-region latex-frag nil tmp-in-file))
19231 (tmp-out-file (file-relative-name
19232 (make-temp-name (expand-file-name "ltxmathml-out"))))
19233 (cmd (format-spec
19234 org-latex-to-mathml-convert-command
19235 `((?j . ,(and org-latex-to-mathml-jar-file
19236 (shell-quote-argument
19237 (expand-file-name
19238 org-latex-to-mathml-jar-file))))
19239 (?I . ,(shell-quote-argument tmp-in-file))
19240 (?i . ,latex-frag)
19241 (?o . ,(shell-quote-argument tmp-out-file)))))
19242 mathml shell-command-output)
19243 (when (org-called-interactively-p 'any)
19244 (unless (org-format-latex-mathml-available-p)
19245 (user-error "LaTeX to MathML converter not configured")))
19246 (message "Running %s" cmd)
19247 (setq shell-command-output (shell-command-to-string cmd))
19248 (setq mathml
19249 (when (file-readable-p tmp-out-file)
19250 (with-current-buffer (find-file-noselect tmp-out-file t)
19251 (goto-char (point-min))
19252 (when (re-search-forward
19253 (concat
19254 (regexp-quote
19255 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19256 "[^>]*?>"
19257 "\\(.\\|\n\\)*"
19258 "</math>")
19259 nil t)
19260 (prog1 (match-string 0) (kill-buffer))))))
19261 (cond
19262 (mathml
19263 (setq mathml
19264 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19265 (when mathml-file
19266 (write-region mathml nil mathml-file))
19267 (when (org-called-interactively-p 'any)
19268 (message mathml)))
19269 ((message "LaTeX to MathML conversion failed")
19270 (message shell-command-output)))
19271 (delete-file tmp-in-file)
19272 (when (file-exists-p tmp-out-file)
19273 (delete-file tmp-out-file))
19274 mathml))
19276 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19277 prefix &optional dir)
19278 "Use `org-create-math-formula' but check local cache first."
19279 (let* ((absprefix (expand-file-name prefix dir))
19280 (print-length nil) (print-level nil)
19281 (formula-id (concat
19282 "formula-"
19283 (sha1
19284 (prin1-to-string
19285 (list latex-frag
19286 org-latex-to-mathml-convert-command)))))
19287 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19288 (formula-cache-dir (file-name-directory formula-cache)))
19290 (unless (file-directory-p formula-cache-dir)
19291 (make-directory formula-cache-dir t))
19293 (unless (file-exists-p formula-cache)
19294 (org-create-math-formula latex-frag formula-cache))
19296 (if (file-exists-p formula-cache)
19297 ;; Successful conversion. Return the link to MathML file.
19298 (org-add-props
19299 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19300 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19301 'org-latex-src-embed-type (if latex-frag-type
19302 'paragraph 'character)))
19303 ;; Failed conversion. Return the LaTeX fragment verbatim
19304 latex-frag)))
19306 (defun org-create-formula-image (string tofile options buffer &optional type)
19307 "Create an image from LaTeX source using dvipng or convert.
19308 This function calls either `org-create-formula-image-with-dvipng'
19309 or `org-create-formula-image-with-imagemagick' depending on the
19310 value of `org-latex-create-formula-image-program' or on the value
19311 of the optional TYPE variable.
19313 Note: ultimately these two function should be combined as they
19314 share a good deal of logic."
19315 (org-check-external-command
19316 "latex" "needed to convert LaTeX fragments to images")
19317 (funcall
19318 (case (or type org-latex-create-formula-image-program)
19319 (dvipng
19320 (org-check-external-command
19321 "dvipng" "needed to convert LaTeX fragments to images")
19322 #'org-create-formula-image-with-dvipng)
19323 (imagemagick
19324 (org-check-external-command
19325 "convert" "you need to install imagemagick")
19326 #'org-create-formula-image-with-imagemagick)
19327 (t (error
19328 "Invalid value of `org-latex-create-formula-image-program'")))
19329 string tofile options buffer))
19331 (declare-function org-export-get-backend "ox" (name))
19332 (declare-function org-export--get-global-options "ox" (&optional backend))
19333 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19334 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19335 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19336 (defun org-create-formula--latex-header ()
19337 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19338 (let ((info (org-combine-plists (org-export--get-global-options
19339 (org-export-get-backend 'latex))
19340 (org-export--get-inbuffer-options
19341 (org-export-get-backend 'latex)))))
19342 (org-latex-guess-babel-language
19343 (org-latex-guess-inputenc
19344 (org-splice-latex-header
19345 org-format-latex-header
19346 org-latex-default-packages-alist
19347 org-latex-packages-alist t
19348 (plist-get info :latex-header)))
19349 info)))
19351 (defun org--get-display-dpi ()
19352 "Get the DPI of the display.
19354 Assumes that the display has the same pixel width in the
19355 horizontal and vertical directions."
19356 (if (display-graphic-p)
19357 (round (/ (display-pixel-height)
19358 (/ (display-mm-height) 25.4)))
19359 (error "Attempt to calculate the dpi of a non-graphic display")))
19361 ;; This function borrows from Ganesh Swami's latex2png.el
19362 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19363 "This calls dvipng."
19364 (require 'ox-latex)
19365 (let* ((tmpdir (if (featurep 'xemacs)
19366 (temp-directory)
19367 temporary-file-directory))
19368 (texfilebase (make-temp-name
19369 (expand-file-name "orgtex" tmpdir)))
19370 (texfile (concat texfilebase ".tex"))
19371 (dvifile (concat texfilebase ".dvi"))
19372 (pngfile (concat texfilebase ".png"))
19373 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19374 ;; This assumes that the display has the same pixel width in
19375 ;; the horizontal and vertical directions
19376 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19377 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19378 "Black"))
19379 (bg (or (plist-get options (if buffer :background :html-background))
19380 "Transparent")))
19381 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19382 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19383 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19384 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19385 (let ((latex-header (org-create-formula--latex-header)))
19386 (with-temp-file texfile
19387 (insert latex-header)
19388 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19389 (let ((dir default-directory))
19390 (ignore-errors
19391 (cd tmpdir)
19392 (call-process "latex" nil nil nil texfile))
19393 (cd dir))
19394 (if (not (file-exists-p dvifile))
19395 (progn (message "Failed to create dvi file from %s" texfile) nil)
19396 (ignore-errors
19397 (if (featurep 'xemacs)
19398 (call-process "dvipng" nil nil nil
19399 "-fg" fg "-bg" bg
19400 "-T" "tight"
19401 "-o" pngfile
19402 dvifile)
19403 (call-process "dvipng" nil nil nil
19404 "-fg" fg "-bg" bg
19405 "-D" dpi
19406 ;;"-x" scale "-y" scale
19407 "-T" "tight"
19408 "-o" pngfile
19409 dvifile)))
19410 (if (not (file-exists-p pngfile))
19411 (if org-format-latex-signal-error
19412 (error "Failed to create png file from %s" texfile)
19413 (message "Failed to create png file from %s" texfile)
19414 nil)
19415 ;; Use the requested file name and clean up
19416 (copy-file pngfile tofile 'replace)
19417 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19418 (if (file-exists-p (concat texfilebase e))
19419 (delete-file (concat texfilebase e))))
19420 pngfile))))
19422 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19423 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19424 "This calls convert, which is included into imagemagick."
19425 (require 'ox-latex)
19426 (let* ((tmpdir (if (featurep 'xemacs)
19427 (temp-directory)
19428 temporary-file-directory))
19429 (texfilebase (make-temp-name
19430 (expand-file-name "orgtex" tmpdir)))
19431 (texfile (concat texfilebase ".tex"))
19432 (pdffile (concat texfilebase ".pdf"))
19433 (pngfile (concat texfilebase ".png"))
19434 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19435 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19436 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19437 "black"))
19438 (bg (or (plist-get options (if buffer :background :html-background))
19439 "white")))
19440 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19441 (setq fg (org-latex-color-format fg)))
19442 (if (eq bg 'default) (setq bg (org-latex-color :background))
19443 (setq bg (org-latex-color-format
19444 (if (string= bg "Transparent") "white" bg))))
19445 (let ((latex-header (org-create-formula--latex-header)))
19446 (with-temp-file texfile
19447 (insert latex-header)
19448 (insert "\n\\begin{document}\n"
19449 "\\definecolor{fg}{rgb}{" fg "}\n"
19450 "\\definecolor{bg}{rgb}{" bg "}\n"
19451 "\n\\pagecolor{bg}\n"
19452 "\n{\\color{fg}\n"
19453 string
19454 "\n}\n"
19455 "\n\\end{document}\n")))
19456 (org-latex-compile texfile t)
19457 (if (not (file-exists-p pdffile))
19458 (progn (message "Failed to create pdf file from %s" texfile) nil)
19459 (ignore-errors
19460 (if (featurep 'xemacs)
19461 (call-process "convert" nil nil nil
19462 "-density" "96"
19463 "-trim"
19464 "-antialias"
19465 pdffile
19466 "-quality" "100"
19467 ;; "-sharpen" "0x1.0"
19468 pngfile)
19469 (call-process "convert" nil nil nil
19470 "-density" dpi
19471 "-trim"
19472 "-antialias"
19473 pdffile
19474 "-quality" "100"
19475 ;; "-sharpen" "0x1.0"
19476 pngfile)))
19477 (if (not (file-exists-p pngfile))
19478 (if org-format-latex-signal-error
19479 (error "Failed to create png file from %s" texfile)
19480 (message "Failed to create png file from %s" texfile)
19481 nil)
19482 ;; Use the requested file name and clean up
19483 (copy-file pngfile tofile 'replace)
19484 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19485 (if (file-exists-p (concat texfilebase e))
19486 (delete-file (concat texfilebase e))))
19487 pngfile))))
19489 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19490 "Fill a LaTeX header template TPL.
19491 In the template, the following place holders will be recognized:
19493 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19494 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19495 [PACKAGES] \\usepackage statements for PKG
19496 [NO-PACKAGES] do not include PKG
19497 [EXTRA] the string EXTRA
19498 [NO-EXTRA] do not include EXTRA
19500 For backward compatibility, if both the positive and the negative place
19501 holder is missing, the positive one (without the \"NO-\") will be
19502 assumed to be present at the end of the template.
19503 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19504 EXTRA is a string.
19505 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19506 (let (rpl (end ""))
19507 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19508 (setq rpl (if (or (match-end 1) (not def-pkg))
19509 "" (org-latex-packages-to-string def-pkg snippets-p t))
19510 tpl (replace-match rpl t t tpl))
19511 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19513 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19514 (setq rpl (if (or (match-end 1) (not pkg))
19515 "" (org-latex-packages-to-string pkg snippets-p t))
19516 tpl (replace-match rpl t t tpl))
19517 (if pkg (setq end
19518 (concat end "\n"
19519 (org-latex-packages-to-string pkg snippets-p)))))
19521 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19522 (setq rpl (if (or (match-end 1) (not extra))
19523 "" (concat extra "\n"))
19524 tpl (replace-match rpl t t tpl))
19525 (if (and extra (string-match "\\S-" extra))
19526 (setq end (concat end "\n" extra))))
19528 (if (string-match "\\S-" end)
19529 (concat tpl "\n" end)
19530 tpl)))
19532 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19533 "Turn an alist of packages into a string with the \\usepackage macros."
19534 (setq pkg (mapconcat (lambda(p)
19535 (cond
19536 ((stringp p) p)
19537 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19538 (format "%% Package %s omitted" (cadr p)))
19539 ((equal "" (car p))
19540 (format "\\usepackage{%s}" (cadr p)))
19542 (format "\\usepackage[%s]{%s}"
19543 (car p) (cadr p)))))
19545 "\n"))
19546 (if newline (concat pkg "\n") pkg))
19548 (defun org-dvipng-color (attr)
19549 "Return a RGB color specification for dvipng."
19550 (apply 'format "rgb %s %s %s"
19551 (mapcar 'org-normalize-color
19552 (if (featurep 'xemacs)
19553 (color-rgb-components
19554 (face-property 'default
19555 (cond ((eq attr :foreground) 'foreground)
19556 ((eq attr :background) 'background))))
19557 (color-values (face-attribute 'default attr nil))))))
19559 (defun org-dvipng-color-format (color-name)
19560 "Convert COLOR-NAME to a RGB color value for dvipng."
19561 (apply 'format "rgb %s %s %s"
19562 (mapcar 'org-normalize-color
19563 (color-values color-name))))
19565 (defun org-latex-color (attr)
19566 "Return a RGB color for the LaTeX color package."
19567 (apply 'format "%s,%s,%s"
19568 (mapcar 'org-normalize-color
19569 (if (featurep 'xemacs)
19570 (color-rgb-components
19571 (face-property 'default
19572 (cond ((eq attr :foreground) 'foreground)
19573 ((eq attr :background) 'background))))
19574 (color-values (face-attribute 'default attr nil))))))
19576 (defun org-latex-color-format (color-name)
19577 "Convert COLOR-NAME to a RGB color value."
19578 (apply 'format "%s,%s,%s"
19579 (mapcar 'org-normalize-color
19580 (color-values color-name))))
19582 (defun org-normalize-color (value)
19583 "Return string to be used as color value for an RGB component."
19584 (format "%g" (/ value 65535.0)))
19588 ;; Image display
19590 (defvar org-inline-image-overlays nil)
19591 (make-variable-buffer-local 'org-inline-image-overlays)
19593 (defun org-toggle-inline-images (&optional include-linked)
19594 "Toggle the display of inline images.
19595 INCLUDE-LINKED is passed to `org-display-inline-images'."
19596 (interactive "P")
19597 (if org-inline-image-overlays
19598 (progn
19599 (org-remove-inline-images)
19600 (when (org-called-interactively-p 'interactive)
19601 (message "Inline image display turned off")))
19602 (org-display-inline-images include-linked)
19603 (when (org-called-interactively-p 'interactive)
19604 (message (if org-inline-image-overlays
19605 (format "%d images displayed inline"
19606 (length org-inline-image-overlays))
19607 "No images to display inline")))))
19609 (defun org-redisplay-inline-images ()
19610 "Refresh the display of inline images."
19611 (interactive)
19612 (if (not org-inline-image-overlays)
19613 (org-toggle-inline-images)
19614 (org-toggle-inline-images)
19615 (org-toggle-inline-images)))
19617 (defun org-display-inline-images (&optional include-linked refresh beg end)
19618 "Display inline images.
19620 An inline image is a link which follows either of these
19621 conventions:
19623 1. Its path is a file with an extension matching return value
19624 from `image-file-name-regexp' and it has no contents.
19626 2. Its description consists in a single link of the previous
19627 type.
19629 When optional argument INCLUDE-LINKED is non-nil, also links with
19630 a text description part will be inlined. This can be nice for
19631 a quick look at those images, but it does not reflect what
19632 exported files will look like.
19634 When optional argument REFRESH is non-nil, refresh existing
19635 images between BEG and END. This will create new image displays
19636 only if necessary. BEG and END default to the buffer
19637 boundaries."
19638 (interactive "P")
19639 (when (display-graphic-p)
19640 (unless refresh
19641 (org-remove-inline-images)
19642 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19643 (org-with-wide-buffer
19644 (goto-char (or beg (point-min)))
19645 (let ((case-fold-search t)
19646 (file-extension-re (org-image-file-name-regexp)))
19647 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19648 (let ((link (save-match-data (org-element-context))))
19649 ;; Check if we're at an inline image.
19650 (when (and (equal (org-element-property :type link) "file")
19651 (or include-linked
19652 (not (org-element-property :contents-begin link)))
19653 (let ((parent (org-element-property :parent link)))
19654 (or (not (eq (org-element-type parent) 'link))
19655 (not (cdr (org-element-contents parent)))))
19656 (org-string-match-p file-extension-re
19657 (org-element-property :path link)))
19658 (let ((file (expand-file-name
19659 (org-link-unescape
19660 (org-element-property :path link)))))
19661 (when (file-exists-p file)
19662 (let ((width
19663 ;; Apply `org-image-actual-width' specifications.
19664 (cond
19665 ((not (image-type-available-p 'imagemagick)) nil)
19666 ((eq org-image-actual-width t) nil)
19667 ((listp org-image-actual-width)
19669 ;; First try to find a width among
19670 ;; attributes associated to the paragraph
19671 ;; containing link.
19672 (let ((paragraph
19673 (let ((e link))
19674 (while (and (setq e (org-element-property
19675 :parent e))
19676 (not (eq (org-element-type e)
19677 'paragraph))))
19678 e)))
19679 (when paragraph
19680 (save-excursion
19681 (goto-char (org-element-property :begin paragraph))
19682 (when
19683 (re-search-forward
19684 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19685 (org-element-property
19686 :post-affiliated paragraph)
19688 (string-to-number (match-string 1))))))
19689 ;; Otherwise, fall-back to provided number.
19690 (car org-image-actual-width)))
19691 ((numberp org-image-actual-width)
19692 org-image-actual-width)))
19693 (old (get-char-property-and-overlay
19694 (org-element-property :begin link)
19695 'org-image-overlay)))
19696 (if (and (car-safe old) refresh)
19697 (image-refresh (overlay-get (cdr old) 'display))
19698 (let ((image (create-image file
19699 (and width 'imagemagick)
19701 :width width)))
19702 (when image
19703 (let* ((link
19704 ;; If inline image is the description
19705 ;; of another link, be sure to
19706 ;; consider the latter as the one to
19707 ;; apply the overlay on.
19708 (let ((parent
19709 (org-element-property :parent link)))
19710 (if (eq (org-element-type parent) 'link)
19711 parent
19712 link)))
19713 (ov (make-overlay
19714 (org-element-property :begin link)
19715 (progn
19716 (goto-char
19717 (org-element-property :end link))
19718 (skip-chars-backward " \t")
19719 (point)))))
19720 (overlay-put ov 'display image)
19721 (overlay-put ov 'face 'default)
19722 (overlay-put ov 'org-image-overlay t)
19723 (overlay-put
19724 ov 'modification-hooks
19725 (list 'org-display-inline-remove-overlay))
19726 (push ov org-inline-image-overlays)))))))))))))))
19728 (define-obsolete-function-alias
19729 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19731 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19732 "Remove inline-display overlay if a corresponding region is modified."
19733 (let ((inhibit-modification-hooks t))
19734 (when (and ov after)
19735 (delete ov org-inline-image-overlays)
19736 (delete-overlay ov))))
19738 (defun org-remove-inline-images ()
19739 "Remove inline display of images."
19740 (interactive)
19741 (mapc 'delete-overlay org-inline-image-overlays)
19742 (setq org-inline-image-overlays nil))
19744 ;;;; Key bindings
19746 ;; Outline functions from `outline-mode-prefix-map'
19747 ;; that can be remapped in Org:
19748 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19749 (define-key org-mode-map [remap outline-show-subtree] 'org-show-subtree)
19750 (define-key org-mode-map [remap outline-forward-same-level]
19751 'org-forward-heading-same-level)
19752 (define-key org-mode-map [remap outline-backward-same-level]
19753 'org-backward-heading-same-level)
19754 (define-key org-mode-map [remap outline-show-branches]
19755 'org-kill-note-or-show-branches)
19756 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19757 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19758 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19759 (define-key org-mode-map [remap outline-next-visible-heading]
19760 'org-next-visible-heading)
19761 (define-key org-mode-map [remap outline-previous-visible-heading]
19762 'org-previous-visible-heading)
19764 ;; Outline functions from `outline-mode-prefix-map' that can not
19765 ;; be remapped in Org:
19767 ;; - the column "key binding" shows whether the Outline function is still
19768 ;; available in Org mode on the same key that it has been bound to in
19769 ;; Outline mode:
19770 ;; - "overridden": key used for a different functionality in Org mode
19771 ;; - else: key still bound to the same Outline function in Org mode
19773 ;; | Outline function | key binding | Org replacement |
19774 ;; |------------------------------------+-------------+--------------------------|
19775 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19776 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19777 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19778 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19779 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19780 ;; | `show-entry' | overridden | no replacement |
19781 ;; | `show-children' | `C-c C-i' | visibility cycling |
19782 ;; | `show-branches' | `C-c C-k' | still same function |
19783 ;; | `show-subtree' | overridden | visibility cycling |
19784 ;; | `show-all' | overridden | no replacement |
19785 ;; | `hide-subtree' | overridden | visibility cycling |
19786 ;; | `hide-body' | overridden | no replacement |
19787 ;; | `hide-entry' | overridden | visibility cycling |
19788 ;; | `hide-leaves' | overridden | no replacement |
19789 ;; | `hide-sublevels' | overridden | no replacement |
19790 ;; | `hide-other' | overridden | no replacement |
19792 ;; Make `C-c C-x' a prefix key
19793 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19795 ;; TAB key with modifiers
19796 (org-defkey org-mode-map "\C-i" 'org-cycle)
19797 (org-defkey org-mode-map [(tab)] 'org-cycle)
19798 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19799 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19800 ;; The following line is necessary under Suse GNU/Linux
19801 (unless (featurep 'xemacs)
19802 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19803 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19804 (define-key org-mode-map [backtab] 'org-shifttab)
19806 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19807 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19808 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19810 ;; Cursor keys with modifiers
19811 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19812 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19813 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19814 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19816 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19817 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19818 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19819 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19820 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19821 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19823 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19824 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19825 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19826 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19828 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19829 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19830 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19831 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19833 ;; Babel keys
19834 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19835 (mapc (lambda (pair)
19836 (define-key org-babel-map (car pair) (cdr pair)))
19837 org-babel-key-bindings)
19839 ;;; Extra keys for tty access.
19840 ;; We only set them when really needed because otherwise the
19841 ;; menus don't show the simple keys
19843 (when (or org-use-extra-keys
19844 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19845 (not window-system))
19846 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19847 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19848 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19849 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19850 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19851 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19852 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19853 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19854 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19855 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19856 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19857 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19858 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19859 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19860 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19861 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19862 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19863 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19864 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19865 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19866 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19867 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19868 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19869 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19870 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19871 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19872 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19873 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19875 ;; All the other keys
19877 (org-defkey org-mode-map "\C-c\C-a" 'outline-show-all) ; in case allout messed up.
19878 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19879 (if (boundp 'narrow-map)
19880 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19881 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19882 (if (boundp 'narrow-map)
19883 (org-defkey narrow-map "b" 'org-narrow-to-block)
19884 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19885 (if (boundp 'narrow-map)
19886 (org-defkey narrow-map "e" 'org-narrow-to-element)
19887 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19888 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19889 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19890 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19891 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19892 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19893 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19894 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19895 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19896 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19897 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19898 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19899 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19900 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19901 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19902 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19903 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19904 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19905 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19906 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19907 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19908 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19909 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19910 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19911 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19912 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19913 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19914 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19915 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19916 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19917 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19918 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19919 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19920 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19921 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19922 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19923 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19924 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19925 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19926 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19927 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19928 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19929 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19930 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19931 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19932 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19933 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19934 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19935 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19936 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19937 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19938 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19939 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19940 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19941 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19942 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19943 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19944 (org-defkey org-mode-map "\C-c^" 'org-sort)
19945 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19946 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19947 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19948 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19949 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19950 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19951 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19952 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19953 (org-defkey org-mode-map "\C-m" 'org-return)
19954 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19955 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19956 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19957 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19958 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19959 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19960 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19961 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19962 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19963 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19964 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19965 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19966 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19967 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19968 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19969 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19970 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19971 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19972 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19973 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19974 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19975 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19976 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19977 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19978 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19980 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19981 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19982 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19984 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19985 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19986 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19987 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19988 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19989 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19990 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19991 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19992 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19993 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19994 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19995 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19996 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19997 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19998 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19999 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
20000 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
20001 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
20002 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
20003 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
20004 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
20005 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
20007 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
20008 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
20009 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
20010 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
20011 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
20013 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
20015 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
20017 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
20018 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
20020 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
20023 (when (featurep 'xemacs)
20024 (org-defkey org-mode-map 'button3 'popup-mode-menu))
20027 (defconst org-speed-commands-default
20029 ("Outline Navigation")
20030 ("n" . (org-speed-move-safe 'org-next-visible-heading))
20031 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
20032 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
20033 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
20034 ("F" . org-next-block)
20035 ("B" . org-previous-block)
20036 ("u" . (org-speed-move-safe 'outline-up-heading))
20037 ("j" . org-goto)
20038 ("g" . (org-refile t))
20039 ("Outline Visibility")
20040 ("c" . org-cycle)
20041 ("C" . org-shifttab)
20042 (" " . org-display-outline-path)
20043 ("s" . org-narrow-to-subtree)
20044 ("=" . org-columns)
20045 ("Outline Structure Editing")
20046 ("U" . org-metaup)
20047 ("D" . org-metadown)
20048 ("r" . org-metaright)
20049 ("l" . org-metaleft)
20050 ("R" . org-shiftmetaright)
20051 ("L" . org-shiftmetaleft)
20052 ("i" . (progn (forward-char 1) (call-interactively
20053 'org-insert-heading-respect-content)))
20054 ("^" . org-sort)
20055 ("w" . org-refile)
20056 ("a" . org-archive-subtree-default-with-confirmation)
20057 ("@" . org-mark-subtree)
20058 ("#" . org-toggle-comment)
20059 ("Clock Commands")
20060 ("I" . org-clock-in)
20061 ("O" . org-clock-out)
20062 ("Meta Data Editing")
20063 ("t" . org-todo)
20064 ("," . (org-priority))
20065 ("0" . (org-priority ?\ ))
20066 ("1" . (org-priority ?A))
20067 ("2" . (org-priority ?B))
20068 ("3" . (org-priority ?C))
20069 (":" . org-set-tags-command)
20070 ("e" . org-set-effort)
20071 ("E" . org-inc-effort)
20072 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20073 (org-entry-put (point) "APPT_WARNTIME" m)))
20074 ("Agenda Views etc")
20075 ("v" . org-agenda)
20076 ("/" . org-sparse-tree)
20077 ("Misc")
20078 ("o" . org-open-at-point)
20079 ("?" . org-speed-command-help)
20080 ("<" . (org-agenda-set-restriction-lock 'subtree))
20081 (">" . (org-agenda-remove-restriction-lock))
20083 "The default speed commands.")
20085 (defun org-print-speed-command (e)
20086 (if (> (length (car e)) 1)
20087 (progn
20088 (princ "\n")
20089 (princ (car e))
20090 (princ "\n")
20091 (princ (make-string (length (car e)) ?-))
20092 (princ "\n"))
20093 (princ (car e))
20094 (princ " ")
20095 (if (symbolp (cdr e))
20096 (princ (symbol-name (cdr e)))
20097 (prin1 (cdr e)))
20098 (princ "\n")))
20100 (defun org-speed-command-help ()
20101 "Show the available speed commands."
20102 (interactive)
20103 (if (not org-use-speed-commands)
20104 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20105 (with-output-to-temp-buffer "*Help*"
20106 (princ "User-defined Speed commands\n===========================\n")
20107 (mapc 'org-print-speed-command org-speed-commands-user)
20108 (princ "\n")
20109 (princ "Built-in Speed commands\n=======================\n")
20110 (mapc 'org-print-speed-command org-speed-commands-default))
20111 (with-current-buffer "*Help*"
20112 (setq truncate-lines t))))
20114 (defun org-speed-move-safe (cmd)
20115 "Execute CMD, but make sure that the cursor always ends up in a headline.
20116 If not, return to the original position and throw an error."
20117 (interactive)
20118 (let ((pos (point)))
20119 (call-interactively cmd)
20120 (unless (and (bolp) (org-at-heading-p))
20121 (goto-char pos)
20122 (error "Boundary reached while executing %s" cmd))))
20124 (defvar org-self-insert-command-undo-counter 0)
20126 (defvar org-table-auto-blank-field) ; defined in org-table.el
20127 (defvar org-speed-command nil)
20129 (define-obsolete-function-alias
20130 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20132 (defun org-speed-command-activate (keys)
20133 "Hook for activating single-letter speed commands.
20134 `org-speed-commands-default' specifies a minimal command set.
20135 Use `org-speed-commands-user' for further customization."
20136 (when (or (and (bolp) (looking-at org-outline-regexp))
20137 (and (functionp org-use-speed-commands)
20138 (funcall org-use-speed-commands)))
20139 (cdr (assoc keys (append org-speed-commands-user
20140 org-speed-commands-default)))))
20142 (define-obsolete-function-alias
20143 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20145 (defun org-babel-speed-command-activate (keys)
20146 "Hook for activating single-letter code block commands."
20147 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20148 (cdr (assoc keys org-babel-key-bindings))))
20150 (defcustom org-speed-command-hook
20151 '(org-speed-command-default-hook org-babel-speed-command-hook)
20152 "Hook for activating speed commands at strategic locations.
20153 Hook functions are called in sequence until a valid handler is
20154 found.
20156 Each hook takes a single argument, a user-pressed command key
20157 which is also a `self-insert-command' from the global map.
20159 Within the hook, examine the cursor position and the command key
20160 and return nil or a valid handler as appropriate. Handler could
20161 be one of an interactive command, a function, or a form.
20163 Set `org-use-speed-commands' to non-nil value to enable this
20164 hook. The default setting is `org-speed-command-activate'."
20165 :group 'org-structure
20166 :version "24.1"
20167 :type 'hook)
20169 (defun org-self-insert-command (N)
20170 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20171 If the cursor is in a table looking at whitespace, the whitespace is
20172 overwritten, and the table is not marked as requiring realignment."
20173 (interactive "p")
20174 (org-check-before-invisible-edit 'insert)
20175 (cond
20176 ((and org-use-speed-commands
20177 (let ((kv (this-command-keys-vector)))
20178 (setq org-speed-command
20179 (run-hook-with-args-until-success
20180 'org-speed-command-hook
20181 (make-string 1 (aref kv (1- (length kv))))))))
20182 (cond
20183 ((commandp org-speed-command)
20184 (setq this-command org-speed-command)
20185 (call-interactively org-speed-command))
20186 ((functionp org-speed-command)
20187 (funcall org-speed-command))
20188 ((and org-speed-command (listp org-speed-command))
20189 (eval org-speed-command))
20190 (t (let (org-use-speed-commands)
20191 (call-interactively 'org-self-insert-command)))))
20192 ((and
20193 (org-table-p)
20194 (progn
20195 ;; Check if we blank the field, and if that triggers align.
20196 (and (featurep 'org-table) org-table-auto-blank-field
20197 (memq last-command
20198 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20199 (if (or (eq (char-after) ?\s) (looking-at "[^|\n]* |"))
20200 ;; Got extra space, this field does not determine
20201 ;; column width.
20202 (let (org-table-may-need-update) (org-table-blank-field))
20203 ;; No extra space, this field may determine column
20204 ;; width.
20205 (org-table-blank-field)))
20207 (eq N 1)
20208 (looking-at "[^|\n]* \\( \\)|"))
20209 ;; There is room for insertion without re-aligning the table.
20210 (delete-region (match-beginning 1) (match-end 1))
20211 (self-insert-command N))
20213 (setq org-table-may-need-update t)
20214 (self-insert-command N)
20215 (org-fix-tags-on-the-fly)
20216 (if org-self-insert-cluster-for-undo
20217 (if (not (eq last-command 'org-self-insert-command))
20218 (setq org-self-insert-command-undo-counter 1)
20219 (if (>= org-self-insert-command-undo-counter 20)
20220 (setq org-self-insert-command-undo-counter 1)
20221 (and (> org-self-insert-command-undo-counter 0)
20222 buffer-undo-list (listp buffer-undo-list)
20223 (not (cadr buffer-undo-list)) ; remove nil entry
20224 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20225 (setq org-self-insert-command-undo-counter
20226 (1+ org-self-insert-command-undo-counter))))))))
20228 (defun org-check-before-invisible-edit (kind)
20229 "Check is editing if kind KIND would be dangerous with invisible text around.
20230 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20231 ;; First, try to get out of here as quickly as possible, to reduce overhead
20232 (if (and org-catch-invisible-edits
20233 (or (not (boundp 'visible-mode)) (not visible-mode))
20234 (or (get-char-property (point) 'invisible)
20235 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20236 ;; OK, we need to take a closer look
20237 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20238 (invisible-before-point (if (bobp) nil (get-char-property
20239 (1- (point)) 'invisible)))
20240 (border-and-ok-direction
20242 ;; Check if we are acting predictably before invisible text
20243 (and invisible-at-point (not invisible-before-point)
20244 (memq kind '(insert delete-backward)))
20245 ;; Check if we are acting predictably after invisible text
20246 ;; This works not well, and I have turned it off. It seems
20247 ;; better to always show and stop after invisible text.
20248 ;; (and (not invisible-at-point) invisible-before-point
20249 ;; (memq kind '(insert delete)))
20251 (when (or (memq invisible-at-point '(outline org-hide-block t))
20252 (memq invisible-before-point '(outline org-hide-block t)))
20253 (if (eq org-catch-invisible-edits 'error)
20254 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20255 (if (and org-custom-properties-overlays
20256 (y-or-n-p "Display invisible properties in this buffer? "))
20257 (org-toggle-custom-properties-visibility)
20258 ;; Make the area visible
20259 (save-excursion
20260 (if invisible-before-point
20261 (goto-char (previous-single-char-property-change
20262 (point) 'invisible)))
20263 (outline-show-subtree))
20264 (cond
20265 ((eq org-catch-invisible-edits 'show)
20266 ;; That's it, we do the edit after showing
20267 (message
20268 "Unfolding invisible region around point before editing")
20269 (sit-for 1))
20270 ((and (eq org-catch-invisible-edits 'smart)
20271 border-and-ok-direction)
20272 (message "Unfolding invisible region around point before editing"))
20274 ;; Don't do the edit, make the user repeat it in full visibility
20275 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20277 (defun org-fix-tags-on-the-fly ()
20278 (when (and (equal (char-after (point-at-bol)) ?*)
20279 (org-at-heading-p))
20280 (org-align-tags-here org-tags-column)))
20282 (defun org-delete-backward-char (N)
20283 "Like `delete-backward-char', insert whitespace at field end in tables.
20284 When deleting backwards, in tables this function will insert whitespace in
20285 front of the next \"|\" separator, to keep the table aligned. The table will
20286 still be marked for re-alignment if the field did fill the entire column,
20287 because, in this case the deletion might narrow the column."
20288 (interactive "p")
20289 (save-match-data
20290 (org-check-before-invisible-edit 'delete-backward)
20291 (if (and (org-table-p)
20292 (eq N 1)
20293 (string-match "|" (buffer-substring (point-at-bol) (point)))
20294 (looking-at ".*?|"))
20295 (let ((pos (point))
20296 (noalign (looking-at "[^|\n\r]* |"))
20297 (c org-table-may-need-update))
20298 (backward-delete-char N)
20299 (if (not overwrite-mode)
20300 (progn
20301 (skip-chars-forward "^|")
20302 (insert " ")
20303 (goto-char (1- pos))))
20304 ;; noalign: if there were two spaces at the end, this field
20305 ;; does not determine the width of the column.
20306 (if noalign (setq org-table-may-need-update c)))
20307 (backward-delete-char N)
20308 (org-fix-tags-on-the-fly))))
20310 (defun org-delete-char (N)
20311 "Like `delete-char', but insert whitespace at field end in tables.
20312 When deleting characters, in tables this function will insert whitespace in
20313 front of the next \"|\" separator, to keep the table aligned. The table will
20314 still be marked for re-alignment if the field did fill the entire column,
20315 because, in this case the deletion might narrow the column."
20316 (interactive "p")
20317 (save-match-data
20318 (org-check-before-invisible-edit 'delete)
20319 (if (and (org-table-p)
20320 (not (bolp))
20321 (not (= (char-after) ?|))
20322 (eq N 1))
20323 (if (looking-at ".*?|")
20324 (let ((pos (point))
20325 (noalign (looking-at "[^|\n\r]* |"))
20326 (c org-table-may-need-update))
20327 (replace-match
20328 (concat (substring (match-string 0) 1 -1) " |") nil t)
20329 (goto-char pos)
20330 ;; noalign: if there were two spaces at the end, this field
20331 ;; does not determine the width of the column.
20332 (if noalign (setq org-table-may-need-update c)))
20333 (delete-char N))
20334 (delete-char N)
20335 (org-fix-tags-on-the-fly))))
20337 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20338 (put 'org-self-insert-command 'delete-selection
20339 (lambda ()
20340 (not (run-hook-with-args-until-success
20341 'self-insert-uses-region-functions))))
20342 (put 'orgtbl-self-insert-command 'delete-selection
20343 (lambda ()
20344 (not (run-hook-with-args-until-success
20345 'self-insert-uses-region-functions))))
20346 (put 'org-delete-char 'delete-selection 'supersede)
20347 (put 'org-delete-backward-char 'delete-selection 'supersede)
20348 (put 'org-yank 'delete-selection 'yank)
20350 ;; Make `flyspell-mode' delay after some commands
20351 (put 'org-self-insert-command 'flyspell-delayed t)
20352 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20353 (put 'org-delete-char 'flyspell-delayed t)
20354 (put 'org-delete-backward-char 'flyspell-delayed t)
20356 ;; Make pabbrev-mode expand after org-mode commands
20357 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20358 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20360 (defun org-remap (map &rest commands)
20361 "In MAP, remap the functions given in COMMANDS.
20362 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20363 (let (new old)
20364 (while commands
20365 (setq old (pop commands) new (pop commands))
20366 (if (fboundp 'command-remapping)
20367 (org-defkey map (vector 'remap old) new)
20368 (substitute-key-definition old new map global-map)))))
20370 (defun org-transpose-words ()
20371 "Transpose words for Org.
20372 This uses the `org-mode-transpose-word-syntax-table' syntax
20373 table, which interprets characters in `org-emphasis-alist' as
20374 word constituents."
20375 (interactive)
20376 (with-syntax-table org-mode-transpose-word-syntax-table
20377 (call-interactively 'transpose-words)))
20378 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20380 (when (eq org-enable-table-editor 'optimized)
20381 ;; If the user wants maximum table support, we need to hijack
20382 ;; some standard editing functions
20383 (org-remap org-mode-map
20384 'self-insert-command 'org-self-insert-command
20385 'delete-char 'org-delete-char
20386 'delete-backward-char 'org-delete-backward-char)
20387 (org-defkey org-mode-map "|" 'org-force-self-insert))
20389 (defvar org-ctrl-c-ctrl-c-hook nil
20390 "Hook for functions attaching themselves to `C-c C-c'.
20392 This can be used to add additional functionality to the C-c C-c
20393 key which executes context-dependent commands. This hook is run
20394 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20395 run after the last test.
20397 Each function will be called with no arguments. The function
20398 must check if the context is appropriate for it to act. If yes,
20399 it should do its thing and then return a non-nil value. If the
20400 context is wrong, just do nothing and return nil.")
20402 (defvar org-ctrl-c-ctrl-c-final-hook nil
20403 "Hook for functions attaching themselves to `C-c C-c'.
20405 This can be used to add additional functionality to the C-c C-c
20406 key which executes context-dependent commands. This hook is run
20407 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20408 before the first test.
20410 Each function will be called with no arguments. The function
20411 must check if the context is appropriate for it to act. If yes,
20412 it should do its thing and then return a non-nil value. If the
20413 context is wrong, just do nothing and return nil.")
20415 (defvar org-tab-first-hook nil
20416 "Hook for functions to attach themselves to TAB.
20417 See `org-ctrl-c-ctrl-c-hook' for more information.
20418 This hook runs as the first action when TAB is pressed, even before
20419 `org-cycle' messes around with the `outline-regexp' to cater for
20420 inline tasks and plain list item folding.
20421 If any function in this hook returns t, any other actions that
20422 would have been caused by TAB (such as table field motion or visibility
20423 cycling) will not occur.")
20425 (defvar org-tab-after-check-for-table-hook nil
20426 "Hook for functions to attach themselves to TAB.
20427 See `org-ctrl-c-ctrl-c-hook' for more information.
20428 This hook runs after it has been established that the cursor is not in a
20429 table, but before checking if the cursor is in a headline or if global cycling
20430 should be done.
20431 If any function in this hook returns t, not other actions like visibility
20432 cycling will be done.")
20434 (defvar org-tab-after-check-for-cycling-hook nil
20435 "Hook for functions to attach themselves to TAB.
20436 See `org-ctrl-c-ctrl-c-hook' for more information.
20437 This hook runs after it has been established that not table field motion and
20438 not visibility should be done because of current context. This is probably
20439 the place where a package like yasnippets can hook in.")
20441 (defvar org-tab-before-tab-emulation-hook nil
20442 "Hook for functions to attach themselves to TAB.
20443 See `org-ctrl-c-ctrl-c-hook' for more information.
20444 This hook runs after every other options for TAB have been exhausted, but
20445 before indentation and \t insertion takes place.")
20447 (defvar org-metaleft-hook nil
20448 "Hook for functions attaching themselves to `M-left'.
20449 See `org-ctrl-c-ctrl-c-hook' for more information.")
20450 (defvar org-metaright-hook nil
20451 "Hook for functions attaching themselves to `M-right'.
20452 See `org-ctrl-c-ctrl-c-hook' for more information.")
20453 (defvar org-metaup-hook nil
20454 "Hook for functions attaching themselves to `M-up'.
20455 See `org-ctrl-c-ctrl-c-hook' for more information.")
20456 (defvar org-metadown-hook nil
20457 "Hook for functions attaching themselves to `M-down'.
20458 See `org-ctrl-c-ctrl-c-hook' for more information.")
20459 (defvar org-shiftmetaleft-hook nil
20460 "Hook for functions attaching themselves to `M-S-left'.
20461 See `org-ctrl-c-ctrl-c-hook' for more information.")
20462 (defvar org-shiftmetaright-hook nil
20463 "Hook for functions attaching themselves to `M-S-right'.
20464 See `org-ctrl-c-ctrl-c-hook' for more information.")
20465 (defvar org-shiftmetaup-hook nil
20466 "Hook for functions attaching themselves to `M-S-up'.
20467 See `org-ctrl-c-ctrl-c-hook' for more information.")
20468 (defvar org-shiftmetadown-hook nil
20469 "Hook for functions attaching themselves to `M-S-down'.
20470 See `org-ctrl-c-ctrl-c-hook' for more information.")
20471 (defvar org-metareturn-hook nil
20472 "Hook for functions attaching themselves to `M-RET'.
20473 See `org-ctrl-c-ctrl-c-hook' for more information.")
20474 (defvar org-shiftup-hook nil
20475 "Hook for functions attaching themselves to `S-up'.
20476 See `org-ctrl-c-ctrl-c-hook' for more information.")
20477 (defvar org-shiftup-final-hook nil
20478 "Hook for functions attaching themselves to `S-up'.
20479 This one runs after all other options except shift-select have been excluded.
20480 See `org-ctrl-c-ctrl-c-hook' for more information.")
20481 (defvar org-shiftdown-hook nil
20482 "Hook for functions attaching themselves to `S-down'.
20483 See `org-ctrl-c-ctrl-c-hook' for more information.")
20484 (defvar org-shiftdown-final-hook nil
20485 "Hook for functions attaching themselves to `S-down'.
20486 This one runs after all other options except shift-select have been excluded.
20487 See `org-ctrl-c-ctrl-c-hook' for more information.")
20488 (defvar org-shiftleft-hook nil
20489 "Hook for functions attaching themselves to `S-left'.
20490 See `org-ctrl-c-ctrl-c-hook' for more information.")
20491 (defvar org-shiftleft-final-hook nil
20492 "Hook for functions attaching themselves to `S-left'.
20493 This one runs after all other options except shift-select have been excluded.
20494 See `org-ctrl-c-ctrl-c-hook' for more information.")
20495 (defvar org-shiftright-hook nil
20496 "Hook for functions attaching themselves to `S-right'.
20497 See `org-ctrl-c-ctrl-c-hook' for more information.")
20498 (defvar org-shiftright-final-hook nil
20499 "Hook for functions attaching themselves to `S-right'.
20500 This one runs after all other options except shift-select have been excluded.
20501 See `org-ctrl-c-ctrl-c-hook' for more information.")
20503 (defun org-modifier-cursor-error ()
20504 "Throw an error, a modified cursor command was applied in wrong context."
20505 (user-error "This command is active in special context like tables, headlines or items"))
20507 (defun org-shiftselect-error ()
20508 "Throw an error because Shift-Cursor command was applied in wrong context."
20509 (if (and (boundp 'shift-select-mode) shift-select-mode)
20510 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20511 (user-error "This command works only in special context like headlines or timestamps")))
20513 (defun org-call-for-shift-select (cmd)
20514 (let ((this-command-keys-shift-translated t))
20515 (call-interactively cmd)))
20517 (defun org-shifttab (&optional arg)
20518 "Global visibility cycling or move to previous table field.
20519 Call `org-table-previous-field' within a table.
20520 When ARG is nil, cycle globally through visibility states.
20521 When ARG is a numeric prefix, show contents of this level."
20522 (interactive "P")
20523 (cond
20524 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20525 ((integerp arg)
20526 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20527 (message "Content view to level: %d" arg)
20528 (org-content (prefix-numeric-value arg2))
20529 (org-cycle-show-empty-lines t)
20530 (setq org-cycle-global-status 'overview)))
20531 (t (call-interactively 'org-global-cycle))))
20533 (defun org-shiftmetaleft ()
20534 "Promote subtree or delete table column.
20535 Calls `org-promote-subtree', `org-outdent-item-tree', or
20536 `org-table-delete-column', depending on context. See the
20537 individual commands for more information."
20538 (interactive)
20539 (cond
20540 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20541 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20542 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20543 ((if (not (org-region-active-p)) (org-at-item-p)
20544 (save-excursion (goto-char (region-beginning))
20545 (org-at-item-p)))
20546 (call-interactively 'org-outdent-item-tree))
20547 (t (org-modifier-cursor-error))))
20549 (defun org-shiftmetaright ()
20550 "Demote subtree or insert table column.
20551 Calls `org-demote-subtree', `org-indent-item-tree', or
20552 `org-table-insert-column', depending on context. See the
20553 individual commands for more information."
20554 (interactive)
20555 (cond
20556 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20557 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20558 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20559 ((if (not (org-region-active-p)) (org-at-item-p)
20560 (save-excursion (goto-char (region-beginning))
20561 (org-at-item-p)))
20562 (call-interactively 'org-indent-item-tree))
20563 (t (org-modifier-cursor-error))))
20565 (defun org-shiftmetaup (&optional arg)
20566 "Drag the line at point up.
20567 In a table, kill the current row.
20568 On a clock timestamp, update the value of the timestamp like `S-<up>'
20569 but also adjust the previous clocked item in the clock history.
20570 Everywhere else, drag the line at point up."
20571 (interactive "P")
20572 (cond
20573 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20574 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20575 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20576 (call-interactively 'org-timestamp-up)))
20577 (t (call-interactively 'org-drag-line-backward))))
20579 (defun org-shiftmetadown (&optional arg)
20580 "Drag the line at point down.
20581 In a table, insert an empty row at the current line.
20582 On a clock timestamp, update the value of the timestamp like `S-<down>'
20583 but also adjust the previous clocked item in the clock history.
20584 Everywhere else, drag the line at point down."
20585 (interactive "P")
20586 (cond
20587 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20588 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20589 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20590 (call-interactively 'org-timestamp-down)))
20591 (t (call-interactively 'org-drag-line-forward))))
20593 (defsubst org-hidden-tree-error ()
20594 (user-error
20595 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20597 (defun org-metaleft (&optional arg)
20598 "Promote heading, list item at point or move table column left.
20600 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20601 depending on context. With no specific context, calls the Emacs
20602 default `backward-word'. See the individual commands for more
20603 information.
20605 This function runs the hook `org-metaleft-hook' as a first step,
20606 and returns at first non-nil value."
20607 (interactive "P")
20608 (cond
20609 ((run-hook-with-args-until-success 'org-metaleft-hook))
20610 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20611 ((org-with-limited-levels
20612 (or (org-at-heading-p)
20613 (and (org-region-active-p)
20614 (save-excursion
20615 (goto-char (region-beginning))
20616 (org-at-heading-p)))))
20617 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20618 (call-interactively 'org-do-promote))
20619 ;; At an inline task.
20620 ((org-at-heading-p)
20621 (call-interactively 'org-inlinetask-promote))
20622 ((or (org-at-item-p)
20623 (and (org-region-active-p)
20624 (save-excursion
20625 (goto-char (region-beginning))
20626 (org-at-item-p))))
20627 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20628 (call-interactively 'org-outdent-item))
20629 (t (call-interactively 'backward-word))))
20631 (defun org-metaright (&optional arg)
20632 "Demote heading, list item at point or move table column right.
20634 In front of a drawer or a block keyword, indent it correctly.
20636 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20637 `org-indnet-drawer' or `org-indent-block' depending on context.
20638 With no specific context, calls the Emacs default `forward-word'.
20639 See the individual commands for more information.
20641 This function runs the hook `org-metaright-hook' as a first step,
20642 and returns at first non-nil value."
20643 (interactive "P")
20644 (cond
20645 ((run-hook-with-args-until-success 'org-metaright-hook))
20646 ((org-at-table-p) (call-interactively 'org-table-move-column))
20647 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20648 ((org-at-block-p) (call-interactively 'org-indent-block))
20649 ((org-with-limited-levels
20650 (or (org-at-heading-p)
20651 (and (org-region-active-p)
20652 (save-excursion
20653 (goto-char (region-beginning))
20654 (org-at-heading-p)))))
20655 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20656 (call-interactively 'org-do-demote))
20657 ;; At an inline task.
20658 ((org-at-heading-p)
20659 (call-interactively 'org-inlinetask-demote))
20660 ((or (org-at-item-p)
20661 (and (org-region-active-p)
20662 (save-excursion
20663 (goto-char (region-beginning))
20664 (org-at-item-p))))
20665 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20666 (call-interactively 'org-indent-item))
20667 (t (call-interactively 'forward-word))))
20669 (defun org-check-for-hidden (what)
20670 "Check if there are hidden headlines/items in the current visual line.
20671 WHAT can be either `headlines' or `items'. If the current line is
20672 an outline or item heading and it has a folded subtree below it,
20673 this function returns t, nil otherwise."
20674 (let ((re (cond
20675 ((eq what 'headlines) org-outline-regexp-bol)
20676 ((eq what 'items) (org-item-beginning-re))
20677 (t (error "This should not happen"))))
20678 beg end)
20679 (save-excursion
20680 (catch 'exit
20681 (unless (org-region-active-p)
20682 (setq beg (point-at-bol))
20683 (beginning-of-line 2)
20684 (while (and (not (eobp)) ;; this is like `next-line'
20685 (get-char-property (1- (point)) 'invisible))
20686 (beginning-of-line 2))
20687 (setq end (point))
20688 (goto-char beg)
20689 (goto-char (point-at-eol))
20690 (setq end (max end (point)))
20691 (while (re-search-forward re end t)
20692 (if (get-char-property (match-beginning 0) 'invisible)
20693 (throw 'exit t))))
20694 nil))))
20696 (defun org-metaup (&optional arg)
20697 "Move subtree up or move table row up.
20698 Calls `org-move-subtree-up' or `org-table-move-row' or
20699 `org-move-item-up', depending on context. See the individual commands
20700 for more information."
20701 (interactive "P")
20702 (cond
20703 ((run-hook-with-args-until-success 'org-metaup-hook))
20704 ((org-region-active-p)
20705 (let* ((a (min (region-beginning) (region-end)))
20706 (b (1- (max (region-beginning) (region-end))))
20707 (c (save-excursion (goto-char a)
20708 (move-beginning-of-line 0)))
20709 (d (save-excursion (goto-char a)
20710 (move-end-of-line 0) (point))))
20711 (transpose-regions a b c d)
20712 (goto-char c)))
20713 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20714 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20715 ((org-at-item-p) (call-interactively 'org-move-item-up))
20716 (t (org-drag-element-backward))))
20718 (defun org-metadown (&optional arg)
20719 "Move subtree down or move table row down.
20720 Calls `org-move-subtree-down' or `org-table-move-row' or
20721 `org-move-item-down', depending on context. See the individual
20722 commands for more information."
20723 (interactive "P")
20724 (cond
20725 ((run-hook-with-args-until-success 'org-metadown-hook))
20726 ((org-region-active-p)
20727 (let* ((a (min (region-beginning) (region-end)))
20728 (b (max (region-beginning) (region-end)))
20729 (c (save-excursion (goto-char b)
20730 (move-beginning-of-line 1)))
20731 (d (save-excursion (goto-char b)
20732 (move-end-of-line 1) (1+ (point)))))
20733 (transpose-regions a b c d)
20734 (goto-char d)))
20735 ((org-at-table-p) (call-interactively 'org-table-move-row))
20736 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20737 ((org-at-item-p) (call-interactively 'org-move-item-down))
20738 (t (org-drag-element-forward))))
20740 (defun org-shiftup (&optional arg)
20741 "Increase item in timestamp or increase priority of current headline.
20742 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20743 depending on context. See the individual commands for more information."
20744 (interactive "P")
20745 (cond
20746 ((run-hook-with-args-until-success 'org-shiftup-hook))
20747 ((and org-support-shift-select (org-region-active-p))
20748 (org-call-for-shift-select 'previous-line))
20749 ((org-at-timestamp-p t)
20750 (call-interactively (if org-edit-timestamp-down-means-later
20751 'org-timestamp-down 'org-timestamp-up)))
20752 ((and (not (eq org-support-shift-select 'always))
20753 org-enable-priority-commands
20754 (org-at-heading-p))
20755 (call-interactively 'org-priority-up))
20756 ((and (not org-support-shift-select) (org-at-item-p))
20757 (call-interactively 'org-previous-item))
20758 ((org-clocktable-try-shift 'up arg))
20759 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20760 (org-support-shift-select
20761 (org-call-for-shift-select 'previous-line))
20762 (t (org-shiftselect-error))))
20764 (defun org-shiftdown (&optional arg)
20765 "Decrease item in timestamp or decrease priority of current headline.
20766 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20767 depending on context. See the individual commands for more information."
20768 (interactive "P")
20769 (cond
20770 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20771 ((and org-support-shift-select (org-region-active-p))
20772 (org-call-for-shift-select 'next-line))
20773 ((org-at-timestamp-p t)
20774 (call-interactively (if org-edit-timestamp-down-means-later
20775 'org-timestamp-up 'org-timestamp-down)))
20776 ((and (not (eq org-support-shift-select 'always))
20777 org-enable-priority-commands
20778 (org-at-heading-p))
20779 (call-interactively 'org-priority-down))
20780 ((and (not org-support-shift-select) (org-at-item-p))
20781 (call-interactively 'org-next-item))
20782 ((org-clocktable-try-shift 'down arg))
20783 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20784 (org-support-shift-select
20785 (org-call-for-shift-select 'next-line))
20786 (t (org-shiftselect-error))))
20788 (defun org-shiftright (&optional arg)
20789 "Cycle the thing at point or in the current line, depending on context.
20790 Depending on context, this does one of the following:
20792 - switch a timestamp at point one day into the future
20793 - on a headline, switch to the next TODO keyword.
20794 - on an item, switch entire list to the next bullet type
20795 - on a property line, switch to the next allowed value
20796 - on a clocktable definition line, move time block into the future"
20797 (interactive "P")
20798 (cond
20799 ((run-hook-with-args-until-success 'org-shiftright-hook))
20800 ((and org-support-shift-select (org-region-active-p))
20801 (org-call-for-shift-select 'forward-char))
20802 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20803 ((and (not (eq org-support-shift-select 'always))
20804 (org-at-heading-p))
20805 (let ((org-inhibit-logging
20806 (not org-treat-S-cursor-todo-selection-as-state-change))
20807 (org-inhibit-blocking
20808 (not org-treat-S-cursor-todo-selection-as-state-change)))
20809 (org-call-with-arg 'org-todo 'right)))
20810 ((or (and org-support-shift-select
20811 (not (eq org-support-shift-select 'always))
20812 (org-at-item-bullet-p))
20813 (and (not org-support-shift-select) (org-at-item-p)))
20814 (org-call-with-arg 'org-cycle-list-bullet nil))
20815 ((and (not (eq org-support-shift-select 'always))
20816 (org-at-property-p))
20817 (call-interactively 'org-property-next-allowed-value))
20818 ((org-clocktable-try-shift 'right arg))
20819 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20820 (org-support-shift-select
20821 (org-call-for-shift-select 'forward-char))
20822 (t (org-shiftselect-error))))
20824 (defun org-shiftleft (&optional arg)
20825 "Cycle the thing at point or in the current line, depending on context.
20826 Depending on context, this does one of the following:
20828 - switch a timestamp at point one day into the past
20829 - on a headline, switch to the previous TODO keyword.
20830 - on an item, switch entire list to the previous bullet type
20831 - on a property line, switch to the previous allowed value
20832 - on a clocktable definition line, move time block into the past"
20833 (interactive "P")
20834 (cond
20835 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20836 ((and org-support-shift-select (org-region-active-p))
20837 (org-call-for-shift-select 'backward-char))
20838 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20839 ((and (not (eq org-support-shift-select 'always))
20840 (org-at-heading-p))
20841 (let ((org-inhibit-logging
20842 (not org-treat-S-cursor-todo-selection-as-state-change))
20843 (org-inhibit-blocking
20844 (not org-treat-S-cursor-todo-selection-as-state-change)))
20845 (org-call-with-arg 'org-todo 'left)))
20846 ((or (and org-support-shift-select
20847 (not (eq org-support-shift-select 'always))
20848 (org-at-item-bullet-p))
20849 (and (not org-support-shift-select) (org-at-item-p)))
20850 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20851 ((and (not (eq org-support-shift-select 'always))
20852 (org-at-property-p))
20853 (call-interactively 'org-property-previous-allowed-value))
20854 ((org-clocktable-try-shift 'left arg))
20855 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20856 (org-support-shift-select
20857 (org-call-for-shift-select 'backward-char))
20858 (t (org-shiftselect-error))))
20860 (defun org-shiftcontrolright ()
20861 "Switch to next TODO set."
20862 (interactive)
20863 (cond
20864 ((and org-support-shift-select (org-region-active-p))
20865 (org-call-for-shift-select 'forward-word))
20866 ((and (not (eq org-support-shift-select 'always))
20867 (org-at-heading-p))
20868 (org-call-with-arg 'org-todo 'nextset))
20869 (org-support-shift-select
20870 (org-call-for-shift-select 'forward-word))
20871 (t (org-shiftselect-error))))
20873 (defun org-shiftcontrolleft ()
20874 "Switch to previous TODO set."
20875 (interactive)
20876 (cond
20877 ((and org-support-shift-select (org-region-active-p))
20878 (org-call-for-shift-select 'backward-word))
20879 ((and (not (eq org-support-shift-select 'always))
20880 (org-at-heading-p))
20881 (org-call-with-arg 'org-todo 'previousset))
20882 (org-support-shift-select
20883 (org-call-for-shift-select 'backward-word))
20884 (t (org-shiftselect-error))))
20886 (defun org-shiftcontrolup (&optional n)
20887 "Change timestamps synchronously up in CLOCK log lines.
20888 Optional argument N tells to change by that many units."
20889 (interactive "P")
20890 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20891 (let (org-support-shift-select)
20892 (org-clock-timestamps-up n))
20893 (user-error "Not at a clock log")))
20895 (defun org-shiftcontroldown (&optional n)
20896 "Change timestamps synchronously down in CLOCK log lines.
20897 Optional argument N tells to change by that many units."
20898 (interactive "P")
20899 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20900 (let (org-support-shift-select)
20901 (org-clock-timestamps-down n))
20902 (user-error "Not at a clock log")))
20904 (defun org-increase-number-at-point (&optional inc)
20905 "Increment the number at point.
20906 With an optional prefix numeric argument INC, increment using
20907 this numeric value."
20908 (interactive "p")
20909 (if (not (number-at-point))
20910 (user-error "Not on a number")
20911 (unless inc (setq inc 1))
20912 (let ((pos (point))
20913 (beg (skip-chars-backward "-+^/*0-9eE."))
20914 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20915 (setq nap (buffer-substring-no-properties
20916 (+ pos beg) (+ pos beg end)))
20917 (delete-region (+ pos beg) (+ pos beg end))
20918 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20919 (when (org-at-table-p)
20920 (org-table-align)
20921 (org-table-end-of-field 1))))
20923 (defun org-decrease-number-at-point (&optional inc)
20924 "Decrement the number at point.
20925 With an optional prefix numeric argument INC, decrement using
20926 this numeric value."
20927 (interactive "p")
20928 (org-increase-number-at-point (- (or inc 1))))
20930 (defun org-ctrl-c-ret ()
20931 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20932 (interactive)
20933 (cond
20934 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20935 (t (call-interactively 'org-insert-heading))))
20937 (defun org-find-visible ()
20938 (let ((s (point)))
20939 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20940 (get-char-property s 'invisible)))
20942 (defun org-find-invisible ()
20943 (let ((s (point)))
20944 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20945 (not (get-char-property s 'invisible))))
20948 (defun org-copy-visible (beg end)
20949 "Copy the visible parts of the region."
20950 (interactive "r")
20951 (let (snippets s)
20952 (save-excursion
20953 (save-restriction
20954 (narrow-to-region beg end)
20955 (setq s (goto-char (point-min)))
20956 (while (not (= (point) (point-max)))
20957 (goto-char (org-find-invisible))
20958 (push (buffer-substring s (point)) snippets)
20959 (setq s (goto-char (org-find-visible))))))
20960 (kill-new (apply 'concat (nreverse snippets)))))
20962 (defun org-copy-special ()
20963 "Copy region in table or copy current subtree.
20964 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20965 See the individual commands for more information."
20966 (interactive)
20967 (call-interactively
20968 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20970 (defun org-cut-special ()
20971 "Cut region in table or cut current subtree.
20972 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20973 See the individual commands for more information."
20974 (interactive)
20975 (call-interactively
20976 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20978 (defun org-paste-special (arg)
20979 "Paste rectangular region into table, or past subtree relative to level.
20980 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20981 See the individual commands for more information."
20982 (interactive "P")
20983 (if (org-at-table-p)
20984 (org-table-paste-rectangle)
20985 (org-paste-subtree arg)))
20987 (defsubst org-in-fixed-width-region-p ()
20988 "Is point in a fixed-width region?"
20989 (save-match-data
20990 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20992 (defun org-edit-special (&optional arg)
20993 "Call a special editor for the element at point.
20994 When at a table, call the formula editor with `org-table-edit-formulas'.
20995 When in a source code block, call `org-edit-src-code'.
20996 When in a fixed-width region, call `org-edit-fixed-width-region'.
20997 When in an export block, call `org-edit-export-block'.
20998 When at an #+INCLUDE keyword, visit the included file.
20999 When at a footnote reference, call `org-edit-footnote-reference'
21000 On a link, call `ffap' to visit the link at point.
21001 Otherwise, return a user error."
21002 (interactive "P")
21003 (let ((element (org-element-at-point)))
21004 (assert (not buffer-read-only) nil
21005 "Buffer is read-only: %s" (buffer-name))
21006 (case (org-element-type element)
21007 (src-block
21008 (if (not arg) (org-edit-src-code)
21009 (let* ((info (org-babel-get-src-block-info))
21010 (lang (nth 0 info))
21011 (params (nth 2 info))
21012 (session (cdr (assq :session params))))
21013 (if (not session) (org-edit-src-code)
21014 ;; At a src-block with a session and function called with
21015 ;; an ARG: switch to the buffer related to the inferior
21016 ;; process.
21017 (switch-to-buffer
21018 (funcall (intern (concat "org-babel-prep-session:" lang))
21019 session params))))))
21020 (keyword
21021 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
21022 (org-open-link-from-string
21023 (format "[[%s]]"
21024 (expand-file-name
21025 (let ((value (org-element-property :value element)))
21026 (cond ((not (org-string-nw-p value))
21027 (user-error "No file to edit"))
21028 ((string-match "\\`\"\\(.*?\\)\"" value)
21029 (match-string 1 value))
21030 ((string-match "\\`[^ \t\"]\\S-*" value)
21031 (match-string 0 value))
21032 (t (user-error "No valid file specified")))))))
21033 (user-error "No special environment to edit here")))
21034 (table
21035 (if (eq (org-element-property :type element) 'table.el)
21036 (org-edit-table.el)
21037 (call-interactively 'org-table-edit-formulas)))
21038 ;; Only Org tables contain `table-row' type elements.
21039 (table-row (call-interactively 'org-table-edit-formulas))
21040 (example-block (org-edit-src-code))
21041 (export-block (org-edit-export-block))
21042 (fixed-width (org-edit-fixed-width-region))
21043 (otherwise
21044 ;; No notable element at point. Though, we may be at a link or
21045 ;; a footnote reference, which are objects. Thus, scan deeper.
21046 (let ((context (org-element-context element)))
21047 (case (org-element-type context)
21048 (link (call-interactively #'ffap))
21049 (footnote-reference (org-edit-footnote-reference))
21050 (t (user-error "No special environment to edit here"))))))))
21052 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21053 (defun org-ctrl-c-ctrl-c (&optional arg)
21054 "Set tags in headline, or update according to changed information at point.
21056 This command does many different things, depending on context:
21058 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21059 this is what we do.
21061 - If the cursor is on a statistics cookie, update it.
21063 - If the cursor is in a headline, prompt for tags and insert them
21064 into the current line, aligned to `org-tags-column'. When called
21065 with prefix arg, realign all tags in the current buffer.
21067 - If the cursor is in one of the special #+KEYWORD lines, this
21068 triggers scanning the buffer for these lines and updating the
21069 information.
21071 - If the cursor is inside a table, realign the table. This command
21072 works even if the automatic table editor has been turned off.
21074 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21075 the entire table.
21077 - If the cursor is at a footnote reference or definition, jump to
21078 the corresponding definition or references, respectively.
21080 - If the cursor is a the beginning of a dynamic block, update it.
21082 - If the current buffer is a capture buffer, close note and file it.
21084 - If the cursor is on a <<<target>>>, update radio targets and
21085 corresponding links in this buffer.
21087 - If the cursor is on a numbered item in a plain list, renumber the
21088 ordered list.
21090 - If the cursor is on a checkbox, toggle it.
21092 - If the cursor is on a code block, evaluate it. The variable
21093 `org-confirm-babel-evaluate' can be used to control prompting
21094 before code block evaluation, by default every code block
21095 evaluation requires confirmation. Code block evaluation can be
21096 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21097 (interactive "P")
21098 (cond
21099 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21100 org-occur-highlights)
21101 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21102 (org-remove-occur-highlights)
21103 (message "Temporary highlights/overlays removed from current buffer"))
21104 ((and (local-variable-p 'org-finish-function (current-buffer))
21105 (fboundp org-finish-function))
21106 (funcall org-finish-function))
21107 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21109 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21110 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21111 (user-error "C-c C-c can do nothing useful at this location"))
21112 (let* ((context (org-element-context))
21113 (type (org-element-type context)))
21114 (case type
21115 ;; When at a link, act according to the parent instead.
21116 (link (setq context (org-element-property :parent context))
21117 (setq type (org-element-type context)))
21118 ;; Unsupported object types: refer to the first supported
21119 ;; element or object containing it.
21120 ((bold code entity export-snippet inline-babel-call inline-src-block
21121 italic latex-fragment line-break macro strike-through subscript
21122 superscript underline verbatim)
21123 (setq context
21124 (org-element-lineage
21125 context '(radio-target paragraph verse-block table-cell)))))
21126 ;; For convenience: at the first line of a paragraph on the
21127 ;; same line as an item, apply function on that item instead.
21128 (when (eq type 'paragraph)
21129 (let ((parent (org-element-property :parent context)))
21130 (when (and (eq (org-element-type parent) 'item)
21131 (= (line-beginning-position)
21132 (org-element-property :begin parent)))
21133 (setq context parent type 'item))))
21134 ;; Act according to type of element or object at point.
21135 (case type
21136 (clock (org-clock-update-time-maybe))
21137 (dynamic-block
21138 (save-excursion
21139 (goto-char (org-element-property :post-affiliated context))
21140 (org-update-dblock)))
21141 (footnote-definition
21142 (goto-char (org-element-property :post-affiliated context))
21143 (call-interactively 'org-footnote-action))
21144 (footnote-reference (call-interactively 'org-footnote-action))
21145 ((headline inlinetask)
21146 (save-excursion (goto-char (org-element-property :begin context))
21147 (call-interactively 'org-set-tags)))
21148 (item
21149 ;; At an item: a double C-u set checkbox to "[-]"
21150 ;; unconditionally, whereas a single one will toggle its
21151 ;; presence. Without a universal argument, if the item
21152 ;; has a checkbox, toggle it. Otherwise repair the list.
21153 (let* ((box (org-element-property :checkbox context))
21154 (struct (org-element-property :structure context))
21155 (old-struct (copy-tree struct))
21156 (parents (org-list-parents-alist struct))
21157 (prevs (org-list-prevs-alist struct))
21158 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21159 (org-list-set-checkbox
21160 (org-element-property :begin context) struct
21161 (cond ((equal arg '(16)) "[-]")
21162 ((and (not box) (equal arg '(4))) "[ ]")
21163 ((or (not box) (equal arg '(4))) nil)
21164 ((eq box 'on) "[ ]")
21165 (t "[X]")))
21166 ;; Mimic `org-list-write-struct' but with grabbing
21167 ;; a return value from `org-list-struct-fix-box'.
21168 (org-list-struct-fix-ind struct parents 2)
21169 (org-list-struct-fix-item-end struct)
21170 (org-list-struct-fix-bul struct prevs)
21171 (org-list-struct-fix-ind struct parents)
21172 (let ((block-item
21173 (org-list-struct-fix-box struct parents prevs orderedp)))
21174 (if (and box (equal struct old-struct))
21175 (if (equal arg '(16))
21176 (message "Checkboxes already reset")
21177 (user-error "Cannot toggle this checkbox: %s"
21178 (if (eq box 'on)
21179 "all subitems checked"
21180 "unchecked subitems")))
21181 (org-list-struct-apply-struct struct old-struct)
21182 (org-update-checkbox-count-maybe))
21183 (when block-item
21184 (message "Checkboxes were removed due to empty box at line %d"
21185 (org-current-line block-item))))))
21186 (keyword
21187 (let ((org-inhibit-startup-visibility-stuff t)
21188 (org-startup-align-all-tables nil))
21189 (when (boundp 'org-table-coordinate-overlays)
21190 (mapc 'delete-overlay org-table-coordinate-overlays)
21191 (setq org-table-coordinate-overlays nil))
21192 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21193 (message "Local setup has been refreshed"))
21194 (plain-list
21195 ;; At a plain list, with a double C-u argument, set
21196 ;; checkboxes of each item to "[-]", whereas a single one
21197 ;; will toggle their presence according to the state of the
21198 ;; first item in the list. Without an argument, repair the
21199 ;; list.
21200 (let* ((begin (org-element-property :contents-begin context))
21201 (beginm (move-marker (make-marker) begin))
21202 (struct (org-element-property :structure context))
21203 (old-struct (copy-tree struct))
21204 (first-box (save-excursion
21205 (goto-char begin)
21206 (looking-at org-list-full-item-re)
21207 (match-string-no-properties 3)))
21208 (new-box (cond ((equal arg '(16)) "[-]")
21209 ((equal arg '(4)) (unless first-box "[ ]"))
21210 ((equal first-box "[X]") "[ ]")
21211 (t "[X]"))))
21212 (cond
21213 (arg
21214 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21215 (org-list-get-all-items
21216 begin struct (org-list-prevs-alist struct))))
21217 ((and first-box (eq (point) begin))
21218 ;; For convenience, when point is at bol on the first
21219 ;; item of the list and no argument is provided, simply
21220 ;; toggle checkbox of that item, if any.
21221 (org-list-set-checkbox begin struct new-box)))
21222 (org-list-write-struct
21223 struct (org-list-parents-alist struct) old-struct)
21224 (org-update-checkbox-count-maybe)
21225 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21226 ((property-drawer node-property)
21227 (call-interactively 'org-property-action))
21228 ((radio-target target)
21229 (call-interactively 'org-update-radio-target-regexp))
21230 (statistics-cookie
21231 (call-interactively 'org-update-statistics-cookies))
21232 ((table table-cell table-row)
21233 ;; At a table, recalculate every field and align it. Also
21234 ;; send the table if necessary. If the table has
21235 ;; a `table.el' type, just give up. At a table row or
21236 ;; cell, maybe recalculate line but always align table.
21237 (if (eq (org-element-property :type context) 'table.el)
21238 (message "%s" (substitute-command-keys "\\<org-mode-map>\
21239 Use \\[org-edit-special] to edit table.el tables"))
21240 (let ((org-enable-table-editor t))
21241 (if (or (eq type 'table)
21242 ;; Check if point is at a TBLFM line.
21243 (and (eq type 'table-row)
21244 (= (point) (org-element-property :end context))))
21245 (save-excursion
21246 (if (org-at-TBLFM-p)
21247 (progn (require 'org-table)
21248 (org-table-calc-current-TBLFM))
21249 (goto-char (org-element-property :contents-begin context))
21250 (org-call-with-arg 'org-table-recalculate (or arg t))
21251 (orgtbl-send-table 'maybe)))
21252 (org-table-maybe-eval-formula)
21253 (cond (arg (call-interactively 'org-table-recalculate))
21254 ((org-table-maybe-recalculate-line))
21255 (t (org-table-align)))))))
21256 (timestamp (org-timestamp-change 0 'day))
21257 (otherwise
21258 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21259 (user-error
21260 "C-c C-c can do nothing useful at this location")))))))))
21262 (defun org-mode-restart ()
21263 (interactive)
21264 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21265 (funcall major-mode)
21266 (hack-local-variables)
21267 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21268 (org-indent-mode -1)))
21269 (message "%s restarted" major-mode))
21271 (defun org-kill-note-or-show-branches ()
21272 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21273 (interactive)
21274 (if (not org-finish-function)
21275 (progn
21276 (outline-hide-subtree)
21277 (call-interactively 'outline-show-branches))
21278 (let ((org-note-abort t))
21279 (funcall org-finish-function))))
21281 (defun org-delete-indentation (&optional ARG)
21282 "Join current line to previous and fix whitespace at join.
21284 If previous line is a headline add to headline title. Otherwise
21285 the function calls `delete-indentation'.
21287 With argument, join this line to following line."
21288 (interactive "*P")
21289 (if (save-excursion
21290 (if ARG (beginning-of-line)
21291 (forward-line -1))
21292 (looking-at org-complex-heading-regexp))
21293 ;; At headline.
21294 (let ((tags-column (when (match-beginning 5)
21295 (save-excursion (goto-char (match-beginning 5))
21296 (current-column))))
21297 (string (concat " " (progn (when ARG (forward-line 1))
21298 (org-trim (delete-and-extract-region
21299 (line-beginning-position)
21300 (line-end-position)))))))
21301 (unless (bobp) (delete-region (point) (1- (point))))
21302 (goto-char (or (match-end 4)
21303 (match-beginning 5)
21304 (match-end 0)))
21305 (skip-chars-backward " \t")
21306 (save-excursion (insert string))
21307 ;; Adjust alignment of tags.
21308 (when tags-column
21309 (org-align-tags-here (if org-auto-align-tags
21310 org-tags-column
21311 tags-column))))
21312 (delete-indentation ARG)))
21314 (defun org-open-line (n)
21315 "Insert a new row in tables, call `open-line' elsewhere.
21316 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21317 (interactive "*p")
21318 (cond
21319 ((not org-special-ctrl-o)
21320 (open-line n))
21321 ((org-at-table-p)
21322 (org-table-insert-row))
21324 (open-line n))))
21326 (defun org-return (&optional indent)
21327 "Goto next table row or insert a newline.
21329 Calls `org-table-next-row' or `newline', depending on context.
21331 When optional INDENT argument is non-nil, call
21332 `newline-and-indent' instead of `newline'.
21334 When `org-return-follows-link' is non-nil and point is on
21335 a timestamp or a link, call `org-open-at-point'. However, it
21336 will not happen if point is in a table or on a \"dead\"
21337 object (e.g., within a comment). In these case, you need to use
21338 `org-open-at-point' directly."
21339 (interactive)
21340 (let ((context (if org-return-follows-link (org-element-context)
21341 (org-element-at-point))))
21342 (cond
21343 ;; In a table, call `org-table-next-row'.
21344 ((or (and (eq (org-element-type context) 'table)
21345 (>= (point) (org-element-property :contents-begin context))
21346 (< (point) (org-element-property :contents-end context)))
21347 (org-element-lineage context '(table-row table-cell) t))
21348 (org-table-justify-field-maybe)
21349 (call-interactively #'org-table-next-row))
21350 ;; On a link or a timestamp, call `org-open-line' if
21351 ;; `org-return-follows-link' allows it. Tolerate fuzzy
21352 ;; locations, e.g., in a comment, as `org-open-line'.
21353 ((and org-return-follows-link
21354 (or (org-at-timestamp-p t)
21355 (org-at-date-range-p t)
21356 (org-in-regexp org-any-link-re)))
21357 (call-interactively #'org-open-at-point))
21358 ;; Insert newline in heading, but preserve tags.
21359 ((and (not (bolp))
21360 (save-excursion (beginning-of-line)
21361 (looking-at org-complex-heading-regexp)))
21362 ;; At headline. Split line. However, if point is on keyword,
21363 ;; priority cookie or tags, do not break any of them: add
21364 ;; a newline after the headline instead.
21365 (let ((tags-column (and (match-beginning 5)
21366 (save-excursion (goto-char (match-beginning 5))
21367 (current-column))))
21368 (string
21369 (when (and (match-end 4)
21370 (>= (point)
21371 (or (match-end 3) (match-end 2) (1+ (match-end 1))))
21372 (<= (point) (match-end 4)))
21373 (delete-and-extract-region (point) (match-end 4)))))
21374 (when (and tags-column string) ; Adjust tag alignment.
21375 (org-align-tags-here
21376 (if org-auto-align-tags org-tags-column tags-column)))
21377 (end-of-line)
21378 (org-show-entry)
21379 (if indent (newline-and-indent) (newline))
21380 (when string (save-excursion (insert (org-trim string))))))
21381 ;; In a list, make sure indenting keeps trailing text within.
21382 ((and indent
21383 (not (eolp))
21384 (org-element-lineage context '(item)))
21385 (let ((trailing-data
21386 (delete-and-extract-region (point) (line-end-position))))
21387 (newline-and-indent)
21388 (save-excursion (insert trailing-data))))
21389 (t (if indent (newline-and-indent) (newline))))))
21391 (defun org-return-indent ()
21392 "Goto next table row or insert a newline and indent.
21393 Calls `org-table-next-row' or `newline-and-indent', depending on
21394 context. See the individual commands for more information."
21395 (interactive)
21396 (org-return t))
21398 (defun org-ctrl-c-star ()
21399 "Compute table, or change heading status of lines.
21400 Calls `org-table-recalculate' or `org-toggle-heading',
21401 depending on context."
21402 (interactive)
21403 (cond
21404 ((org-at-table-p)
21405 (call-interactively 'org-table-recalculate))
21407 ;; Convert all lines in region to list items
21408 (call-interactively 'org-toggle-heading))))
21410 (defun org-ctrl-c-minus ()
21411 "Insert separator line in table or modify bullet status of line.
21412 Also turns a plain line or a region of lines into list items.
21413 Calls `org-table-insert-hline', `org-toggle-item', or
21414 `org-cycle-list-bullet', depending on context."
21415 (interactive)
21416 (cond
21417 ((org-at-table-p)
21418 (call-interactively 'org-table-insert-hline))
21419 ((org-region-active-p)
21420 (call-interactively 'org-toggle-item))
21421 ((org-in-item-p)
21422 (call-interactively 'org-cycle-list-bullet))
21424 (call-interactively 'org-toggle-item))))
21426 (defun org-toggle-item (arg)
21427 "Convert headings or normal lines to items, items to normal lines.
21428 If there is no active region, only the current line is considered.
21430 If the first non blank line in the region is a headline, convert
21431 all headlines to items, shifting text accordingly.
21433 If it is an item, convert all items to normal lines.
21435 If it is normal text, change region into a list of items.
21436 With a prefix argument ARG, change the region in a single item."
21437 (interactive "P")
21438 (let ((shift-text
21439 (function
21440 ;; Shift text in current section to IND, from point to END.
21441 ;; The function leaves point to END line.
21442 (lambda (ind end)
21443 (let ((min-i 1000) (end (copy-marker end)))
21444 ;; First determine the minimum indentation (MIN-I) of
21445 ;; the text.
21446 (save-excursion
21447 (catch 'exit
21448 (while (< (point) end)
21449 (let ((i (org-get-indentation)))
21450 (cond
21451 ;; Skip blank lines and inline tasks.
21452 ((looking-at "^[ \t]*$"))
21453 ((looking-at org-outline-regexp-bol))
21454 ;; We can't find less than 0 indentation.
21455 ((zerop i) (throw 'exit (setq min-i 0)))
21456 ((< i min-i) (setq min-i i))))
21457 (forward-line))))
21458 ;; Then indent each line so that a line indented to
21459 ;; MIN-I becomes indented to IND. Ignore blank lines
21460 ;; and inline tasks in the process.
21461 (let ((delta (- ind min-i)))
21462 (while (< (point) end)
21463 (unless (or (looking-at "^[ \t]*$")
21464 (looking-at org-outline-regexp-bol))
21465 (org-indent-line-to (+ (org-get-indentation) delta)))
21466 (forward-line)))))))
21467 (skip-blanks
21468 (function
21469 ;; Return beginning of first non-blank line, starting from
21470 ;; line at POS.
21471 (lambda (pos)
21472 (save-excursion
21473 (goto-char pos)
21474 (skip-chars-forward " \r\t\n")
21475 (point-at-bol)))))
21476 beg end)
21477 ;; Determine boundaries of changes.
21478 (if (org-region-active-p)
21479 (setq beg (funcall skip-blanks (region-beginning))
21480 end (copy-marker (region-end)))
21481 (setq beg (funcall skip-blanks (point-at-bol))
21482 end (copy-marker (point-at-eol))))
21483 ;; Depending on the starting line, choose an action on the text
21484 ;; between BEG and END.
21485 (org-with-limited-levels
21486 (save-excursion
21487 (goto-char beg)
21488 (cond
21489 ;; Case 1. Start at an item: de-itemize. Note that it only
21490 ;; happens when a region is active: `org-ctrl-c-minus'
21491 ;; would call `org-cycle-list-bullet' otherwise.
21492 ((org-at-item-p)
21493 (while (< (point) end)
21494 (when (org-at-item-p)
21495 (skip-chars-forward " \t")
21496 (delete-region (point) (match-end 0)))
21497 (forward-line)))
21498 ;; Case 2. Start at an heading: convert to items.
21499 ((org-at-heading-p)
21500 (let* ((bul (org-list-bullet-string "-"))
21501 (bul-len (length bul))
21502 (done (org-entry-is-done-p))
21503 (todo (org-entry-is-todo-p))
21504 ;; Indentation of the first heading. It should be
21505 ;; relative to the indentation of its parent, if any.
21506 (start-ind (save-excursion
21507 (cond
21508 ((not org-adapt-indentation) 0)
21509 ((not (outline-previous-heading)) 0)
21510 (t (length (match-string 0))))))
21511 ;; Level of first heading. Further headings will be
21512 ;; compared to it to determine hierarchy in the list.
21513 (ref-level (org-reduced-level (org-outline-level))))
21514 (when (or done todo) (org-todo ""))
21515 (while (< (point) end)
21516 (let* ((level (org-reduced-level (org-outline-level)))
21517 (delta (max 0 (- level ref-level))))
21518 ;; If current headline is less indented than the first
21519 ;; one, set it as reference, in order to preserve
21520 ;; subtrees.
21521 (when (< level ref-level) (setq ref-level level))
21522 (replace-match bul t t)
21523 (org-indent-line-to (+ start-ind (* delta bul-len)))
21524 (when (or done todo)
21525 (let* ((struct (org-list-struct))
21526 (old (copy-tree struct)))
21527 (org-list-set-checkbox (line-beginning-position)
21528 struct
21529 (if done "[X]" "[ ]"))
21530 (org-list-write-struct struct
21531 (org-list-parents-alist struct)
21532 old)))
21533 ;; Ensure all text down to END (or SECTION-END) belongs
21534 ;; to the newly created item.
21535 (let ((section-end (save-excursion
21536 (or (outline-next-heading) (point)))))
21537 (forward-line)
21538 (funcall shift-text
21539 (+ start-ind (* (1+ delta) bul-len))
21540 (min end section-end)))))))
21541 ;; Case 3. Normal line with ARG: make the first line of region
21542 ;; an item, and shift indentation of others lines to
21543 ;; set them as item's body.
21544 (arg (let* ((bul (org-list-bullet-string "-"))
21545 (bul-len (length bul))
21546 (ref-ind (org-get-indentation)))
21547 (skip-chars-forward " \t")
21548 (insert bul)
21549 (forward-line)
21550 (while (< (point) end)
21551 ;; Ensure that lines less indented than first one
21552 ;; still get included in item body.
21553 (funcall shift-text
21554 (+ ref-ind bul-len)
21555 (min end (save-excursion (or (outline-next-heading)
21556 (point)))))
21557 (forward-line))))
21558 ;; Case 4. Normal line without ARG: turn each non-item line
21559 ;; into an item.
21561 (while (< (point) end)
21562 (unless (or (org-at-heading-p) (org-at-item-p))
21563 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21564 (replace-match
21565 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21566 (forward-line))))))))
21568 (defun org-toggle-heading (&optional nstars)
21569 "Convert headings to normal text, or items or text to headings.
21570 If there is no active region, only convert the current line.
21572 With a \\[universal-argument] prefix, convert the whole list at
21573 point into heading.
21575 In a region:
21577 - If the first non blank line is a headline, remove the stars
21578 from all headlines in the region.
21580 - If it is a normal line, turn each and every normal line (i.e.,
21581 not an heading or an item) in the region into headings. If you
21582 want to convert only the first line of this region, use one
21583 universal prefix argument.
21585 - If it is a plain list item, turn all plain list items into headings.
21587 When converting a line into a heading, the number of stars is chosen
21588 such that the lines become children of the current entry. However,
21589 when a numeric prefix argument is given, its value determines the
21590 number of stars to add."
21591 (interactive "P")
21592 (let ((skip-blanks
21593 (function
21594 ;; Return beginning of first non-blank line, starting from
21595 ;; line at POS.
21596 (lambda (pos)
21597 (save-excursion
21598 (goto-char pos)
21599 (while (org-at-comment-p) (forward-line))
21600 (skip-chars-forward " \r\t\n")
21601 (point-at-bol)))))
21602 beg end toggled)
21603 ;; Determine boundaries of changes. If a universal prefix has
21604 ;; been given, put the list in a region. If region ends at a bol,
21605 ;; do not consider the last line to be in the region.
21607 (when (and current-prefix-arg (org-at-item-p))
21608 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21609 (org-mark-element))
21611 (if (org-region-active-p)
21612 (setq beg (funcall skip-blanks (region-beginning))
21613 end (copy-marker (save-excursion
21614 (goto-char (region-end))
21615 (if (bolp) (point) (point-at-eol)))))
21616 (setq beg (funcall skip-blanks (point-at-bol))
21617 end (copy-marker (point-at-eol))))
21618 ;; Ensure inline tasks don't count as headings.
21619 (org-with-limited-levels
21620 (save-excursion
21621 (goto-char beg)
21622 (cond
21623 ;; Case 1. Started at an heading: de-star headings.
21624 ((org-at-heading-p)
21625 (while (< (point) end)
21626 (when (org-at-heading-p t)
21627 (looking-at org-outline-regexp) (replace-match "")
21628 (setq toggled t))
21629 (forward-line)))
21630 ;; Case 2. Started at an item: change items into headlines.
21631 ;; One star will be added by `org-list-to-subtree'.
21632 ((org-at-item-p)
21633 (while (< (point) end)
21634 (when (org-at-item-p)
21635 ;; Pay attention to cases when region ends before list.
21636 (let* ((struct (org-list-struct))
21637 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21638 (save-restriction
21639 (narrow-to-region (point) list-end)
21640 (insert (org-list-to-subtree (org-list-parse-list t)))))
21641 (setq toggled t))
21642 (forward-line)))
21643 ;; Case 3. Started at normal text: make every line an heading,
21644 ;; skipping headlines and items.
21645 (t (let* ((stars
21646 (make-string
21647 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21648 (add-stars
21649 (cond (nstars "") ; stars from prefix only
21650 ((equal stars "") "*") ; before first heading
21651 (org-odd-levels-only "**") ; inside heading, odd
21652 (t "*"))) ; inside heading, oddeven
21653 (rpl (concat stars add-stars " "))
21654 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21655 (while (< (point) (if (equal nstars '(4)) lend end))
21656 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21657 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21658 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21659 (forward-line)))))))
21660 (unless toggled (message "Cannot toggle heading from here"))))
21662 (defun org-meta-return (&optional _arg)
21663 "Insert a new heading or wrap a region in a table.
21664 Calls `org-insert-heading' or `org-table-wrap-region', depending
21665 on context. See the individual commands for more information."
21666 (interactive)
21667 (org-check-before-invisible-edit 'insert)
21668 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21669 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21670 #'org-insert-heading))))
21672 ;;; Menu entries
21674 (defsubst org-in-subtree-not-table-p ()
21675 "Are we in a subtree and not in a table?"
21676 (and (not (org-before-first-heading-p))
21677 (not (org-at-table-p))))
21679 ;; Define the Org-mode menus
21680 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21681 '("Tbl"
21682 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21683 ["Next Field" org-cycle (org-at-table-p)]
21684 ["Previous Field" org-shifttab (org-at-table-p)]
21685 ["Next Row" org-return (org-at-table-p)]
21686 "--"
21687 ["Blank Field" org-table-blank-field (org-at-table-p)]
21688 ["Edit Field" org-table-edit-field (org-at-table-p)]
21689 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21690 "--"
21691 ("Column"
21692 ["Move Column Left" org-metaleft (org-at-table-p)]
21693 ["Move Column Right" org-metaright (org-at-table-p)]
21694 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21695 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21696 ("Row"
21697 ["Move Row Up" org-metaup (org-at-table-p)]
21698 ["Move Row Down" org-metadown (org-at-table-p)]
21699 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21700 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21701 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21702 "--"
21703 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21704 ("Rectangle"
21705 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21706 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21707 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21708 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21709 "--"
21710 ("Calculate"
21711 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21712 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21713 ["Edit Formulas" org-edit-special (org-at-table-p)]
21714 "--"
21715 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21716 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21717 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21718 "--"
21719 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21720 "--"
21721 ["Sum Column/Rectangle" org-table-sum
21722 (or (org-at-table-p) (org-region-active-p))]
21723 ["Which Column?" org-table-current-column (org-at-table-p)])
21724 ["Debug Formulas"
21725 org-table-toggle-formula-debugger
21726 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21727 ["Show Col/Row Numbers"
21728 org-table-toggle-coordinate-overlays
21729 :style toggle
21730 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21731 "--"
21732 ["Create" org-table-create (and (not (org-at-table-p))
21733 org-enable-table-editor)]
21734 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21735 ["Import from File" org-table-import (not (org-at-table-p))]
21736 ["Export to File" org-table-export (org-at-table-p)]
21737 "--"
21738 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21739 "--"
21740 ("Plot"
21741 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21742 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21744 (easy-menu-define org-org-menu org-mode-map "Org menu"
21745 '("Org"
21746 ("Show/Hide"
21747 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21748 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21749 ["Sparse Tree..." org-sparse-tree t]
21750 ["Reveal Context" org-reveal t]
21751 ["Show All" outline-show-all t]
21752 "--"
21753 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21754 "--"
21755 ["New Heading" org-insert-heading t]
21756 ("Navigate Headings"
21757 ["Up" outline-up-heading t]
21758 ["Next" outline-next-visible-heading t]
21759 ["Previous" outline-previous-visible-heading t]
21760 ["Next Same Level" outline-forward-same-level t]
21761 ["Previous Same Level" outline-backward-same-level t]
21762 "--"
21763 ["Jump" org-goto t])
21764 ("Edit Structure"
21765 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21766 "--"
21767 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21768 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21769 "--"
21770 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21771 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21772 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21773 "--"
21774 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21775 "--"
21776 ["Copy visible text" org-copy-visible t]
21777 "--"
21778 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21779 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21780 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21781 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21782 "--"
21783 ["Sort Region/Children" org-sort t]
21784 "--"
21785 ["Convert to odd levels" org-convert-to-odd-levels t]
21786 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21787 ("Editing"
21788 ["Emphasis..." org-emphasize t]
21789 ["Edit Source Example" org-edit-special t]
21790 "--"
21791 ["Footnote new/jump" org-footnote-action t]
21792 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21793 ("Archive"
21794 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21795 "--"
21796 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21797 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21798 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21800 "--"
21801 ("Hyperlinks"
21802 ["Store Link (Global)" org-store-link t]
21803 ["Find existing link to here" org-occur-link-in-agenda-files t]
21804 ["Insert Link" org-insert-link t]
21805 ["Follow Link" org-open-at-point t]
21806 "--"
21807 ["Next link" org-next-link t]
21808 ["Previous link" org-previous-link t]
21809 "--"
21810 ["Descriptive Links"
21811 org-toggle-link-display
21812 :style radio
21813 :selected org-descriptive-links
21815 ["Literal Links"
21816 org-toggle-link-display
21817 :style radio
21818 :selected (not org-descriptive-links)])
21819 "--"
21820 ("TODO Lists"
21821 ["TODO/DONE/-" org-todo t]
21822 ("Select keyword"
21823 ["Next keyword" org-shiftright (org-at-heading-p)]
21824 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21825 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21826 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21827 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21828 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21829 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21830 "--"
21831 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21832 :selected org-enforce-todo-dependencies :style toggle :active t]
21833 "Settings for tree at point"
21834 ["Do Children sequentially" org-toggle-ordered-property :style radio
21835 :selected (org-entry-get nil "ORDERED")
21836 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21837 ["Do Children parallel" org-toggle-ordered-property :style radio
21838 :selected (not (org-entry-get nil "ORDERED"))
21839 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21840 "--"
21841 ["Set Priority" org-priority t]
21842 ["Priority Up" org-shiftup t]
21843 ["Priority Down" org-shiftdown t]
21844 "--"
21845 ["Get news from all feeds" org-feed-update-all t]
21846 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21847 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21848 ("TAGS and Properties"
21849 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21850 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21851 "--"
21852 ["Set property" org-set-property (not (org-before-first-heading-p))]
21853 ["Column view of properties" org-columns t]
21854 ["Insert Column View DBlock" org-insert-columns-dblock t])
21855 ("Dates and Scheduling"
21856 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21857 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21858 ("Change Date"
21859 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21860 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21861 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21862 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21863 ["Compute Time Range" org-evaluate-time-range t]
21864 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21865 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21866 "--"
21867 ["Custom time format" org-toggle-time-stamp-overlays
21868 :style radio :selected org-display-custom-times]
21869 "--"
21870 ["Goto Calendar" org-goto-calendar t]
21871 ["Date from Calendar" org-date-from-calendar t]
21872 "--"
21873 ["Start/Restart Timer" org-timer-start t]
21874 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21875 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21876 ["Insert Timer String" org-timer t]
21877 ["Insert Timer Item" org-timer-item t])
21878 ("Logging work"
21879 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21880 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21881 ["Clock out" org-clock-out t]
21882 ["Clock cancel" org-clock-cancel t]
21883 "--"
21884 ["Mark as default task" org-clock-mark-default-task t]
21885 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21886 ["Goto running clock" org-clock-goto t]
21887 "--"
21888 ["Display times" org-clock-display t]
21889 ["Create clock table" org-clock-report t]
21890 "--"
21891 ["Record DONE time"
21892 (progn (setq org-log-done (not org-log-done))
21893 (message "Switching to %s will %s record a timestamp"
21894 (car org-done-keywords)
21895 (if org-log-done "automatically" "not")))
21896 :style toggle :selected org-log-done])
21897 "--"
21898 ["Agenda Command..." org-agenda t]
21899 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21900 ("File List for Agenda")
21901 ("Special views current file"
21902 ["TODO Tree" org-show-todo-tree t]
21903 ["Check Deadlines" org-check-deadlines t]
21904 ["Timeline" org-timeline t]
21905 ["Tags/Property tree" org-match-sparse-tree t])
21906 "--"
21907 ["Export/Publish..." org-export-dispatch t]
21908 ("LaTeX"
21909 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21910 :selected org-cdlatex-mode]
21911 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21912 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21913 ["Modify math symbol" org-cdlatex-math-modify
21914 (org-inside-LaTeX-fragment-p)]
21915 ["Insert citation" org-reftex-citation t]
21916 "--"
21917 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21918 "--"
21919 ("MobileOrg"
21920 ["Push Files and Views" org-mobile-push t]
21921 ["Get Captured and Flagged" org-mobile-pull t]
21922 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21923 "--"
21924 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21925 "--"
21926 ("Documentation"
21927 ["Show Version" org-version t]
21928 ["Info Documentation" org-info t])
21929 ("Customize"
21930 ["Browse Org Group" org-customize t]
21931 "--"
21932 ["Expand This Menu" org-create-customize-menu
21933 (fboundp 'customize-menu-create)])
21934 ["Send bug report" org-submit-bug-report t]
21935 "--"
21936 ("Refresh/Reload"
21937 ["Refresh setup current buffer" org-mode-restart t]
21938 ["Reload Org (after update)" org-reload t]
21939 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21942 (defun org-info (&optional node)
21943 "Read documentation for Org-mode in the info system.
21944 With optional NODE, go directly to that node."
21945 (interactive)
21946 (info (format "(org)%s" (or node ""))))
21948 ;;;###autoload
21949 (defun org-submit-bug-report ()
21950 "Submit a bug report on Org-mode via mail.
21952 Don't hesitate to report any problems or inaccurate documentation.
21954 If you don't have setup sending mail from (X)Emacs, please copy the
21955 output buffer into your mail program, as it gives us important
21956 information about your Org-mode version and configuration."
21957 (interactive)
21958 (require 'reporter)
21959 (defvar reporter-prompt-for-summary-p)
21960 (org-load-modules-maybe)
21961 (org-require-autoloaded-modules)
21962 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21963 (reporter-submit-bug-report
21964 "emacs-orgmode@gnu.org"
21965 (org-version nil 'full)
21966 (let (list)
21967 (save-window-excursion
21968 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21969 (delete-other-windows)
21970 (erase-buffer)
21971 (insert "You are about to submit a bug report to the Org-mode mailing list.
21973 We would like to add your full Org-mode and Outline configuration to the
21974 bug report. This greatly simplifies the work of the maintainer and
21975 other experts on the mailing list.
21977 HOWEVER, some variables you have customized may contain private
21978 information. The names of customers, colleagues, or friends, might
21979 appear in the form of file names, tags, todo states, or search strings.
21980 If you answer yes to the prompt, you might want to check and remove
21981 such private information before sending the email.")
21982 (add-text-properties (point-min) (point-max) '(face org-warning))
21983 (when (yes-or-no-p "Include your Org-mode configuration ")
21984 (mapatoms
21985 (lambda (v)
21986 (and (boundp v)
21987 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21988 (or (and (symbol-value v)
21989 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21990 (and
21991 (get v 'custom-type) (get v 'standard-value)
21992 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21993 (push v list)))))
21994 (kill-buffer (get-buffer "*Warn about privacy*"))
21995 list))
21996 nil nil
21997 "Remember to cover the basics, that is, what you expected to happen and
21998 what in fact did happen. You don't know how to make a good report? See
22000 http://orgmode.org/manual/Feedback.html#Feedback
22002 Your bug report will be posted to the Org-mode mailing list.
22003 ------------------------------------------------------------------------")
22004 (save-excursion
22005 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
22006 (replace-match "\\1Bug: \\3 [\\2]")))))
22009 (defun org-install-agenda-files-menu ()
22010 (let ((bl (buffer-list)))
22011 (save-excursion
22012 (while bl
22013 (set-buffer (pop bl))
22014 (if (derived-mode-p 'org-mode) (setq bl nil)))
22015 (when (derived-mode-p 'org-mode)
22016 (easy-menu-change
22017 '("Org") "File List for Agenda"
22018 (append
22019 (list
22020 ["Edit File List" (org-edit-agenda-file-list) t]
22021 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
22022 ["Remove Current File from List" org-remove-file t]
22023 ["Cycle through agenda files" org-cycle-agenda-files t]
22024 ["Occur in all agenda files" org-occur-in-agenda-files t]
22025 "--")
22026 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
22028 ;;;; Documentation
22030 (defun org-require-autoloaded-modules ()
22031 (interactive)
22032 (mapc 'require
22033 '(org-agenda org-archive org-attach org-clock org-colview org-id
22034 org-table org-timer)))
22036 ;;;###autoload
22037 (defun org-reload (&optional uncompiled)
22038 "Reload all org lisp files.
22039 With prefix arg UNCOMPILED, load the uncompiled versions."
22040 (interactive "P")
22041 (require 'loadhist)
22042 (let* ((org-dir (org-find-library-dir "org"))
22043 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
22044 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
22045 (remove-re (mapconcat 'identity
22046 (mapcar (lambda (f) (concat "^" f "$"))
22047 (list (if (featurep 'xemacs)
22048 "org-colview"
22049 "org-colview-xemacs")
22050 "org" "org-loaddefs" "org-version"))
22051 "\\|"))
22052 (feats (delete-dups
22053 (mapcar 'file-name-sans-extension
22054 (mapcar 'file-name-nondirectory
22055 (delq nil
22056 (mapcar 'feature-file
22057 features))))))
22058 (lfeat (append
22059 (sort
22060 (setq feats
22061 (delq nil (mapcar
22062 (lambda (f)
22063 (if (and (string-match feature-re f)
22064 (not (string-match remove-re f)))
22065 f nil))
22066 feats)))
22067 'string-lessp)
22068 (list "org-version" "org")))
22069 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22070 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22071 load-uncore load-misses)
22072 (setq load-misses
22073 (delq 't
22074 (mapcar (lambda (f)
22075 (or (org-load-noerror-mustsuffix (concat org-dir f))
22076 (and (string= org-dir contrib-dir)
22077 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22078 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22079 (add-to-list 'load-uncore f 'append)
22082 lfeat)))
22083 (if load-uncore
22084 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22085 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22086 (if load-misses
22087 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22088 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22089 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22091 ;;;###autoload
22092 (defun org-customize ()
22093 "Call the customize function with org as argument."
22094 (interactive)
22095 (org-load-modules-maybe)
22096 (org-require-autoloaded-modules)
22097 (customize-browse 'org))
22099 (defun org-create-customize-menu ()
22100 "Create a full customization menu for Org-mode, insert it into the menu."
22101 (interactive)
22102 (org-load-modules-maybe)
22103 (org-require-autoloaded-modules)
22104 (if (fboundp 'customize-menu-create)
22105 (progn
22106 (easy-menu-change
22107 '("Org") "Customize"
22108 `(["Browse Org group" org-customize t]
22109 "--"
22110 ,(customize-menu-create 'org)
22111 ["Set" Custom-set t]
22112 ["Save" Custom-save t]
22113 ["Reset to Current" Custom-reset-current t]
22114 ["Reset to Saved" Custom-reset-saved t]
22115 ["Reset to Standard Settings" Custom-reset-standard t]))
22116 (message "\"Org\"-menu now contains full customization menu"))
22117 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22119 ;;;; Miscellaneous stuff
22121 ;;; Generally useful functions
22123 (defsubst org-get-at-eol (property n)
22124 "Get text property PROPERTY at the end of line less N characters."
22125 (get-text-property (- (point-at-eol) n) property))
22127 (defun org-find-text-property-in-string (prop s)
22128 "Return the first non-nil value of property PROP in string S."
22129 (or (get-text-property 0 prop s)
22130 (get-text-property (or (next-single-property-change 0 prop s) 0)
22131 prop s)))
22133 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22134 "Display the given MESSAGE as a warning."
22135 (if (fboundp 'display-warning)
22136 (display-warning 'org message
22137 (if (featurep 'xemacs) 'warning :warning))
22138 (let ((buf (get-buffer-create "*Org warnings*")))
22139 (with-current-buffer buf
22140 (goto-char (point-max))
22141 (insert "Warning (Org): " message)
22142 (unless (bolp)
22143 (newline)))
22144 (display-buffer buf)
22145 (sit-for 0))))
22147 (defun org-eval (form)
22148 "Eval FORM and return result."
22149 (condition-case error
22150 (eval form)
22151 (error (format "%%![Error: %s]" error))))
22153 (defun org-in-clocktable-p ()
22154 "Check if the cursor is in a clocktable."
22155 (let ((pos (point)) start)
22156 (save-excursion
22157 (end-of-line 1)
22158 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22159 (setq start (match-beginning 0))
22160 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22161 (>= (match-end 0) pos)
22162 start))))
22164 (defun org-in-verbatim-emphasis ()
22165 (save-match-data
22166 (and (org-in-regexp org-emph-re 2)
22167 (>= (point) (match-beginning 3))
22168 (<= (point) (match-end 4))
22169 (member (match-string 3) '("=" "~")))))
22171 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22172 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22173 (if (and marker (marker-buffer marker)
22174 (buffer-live-p (marker-buffer marker)))
22175 (progn
22176 (org-pop-to-buffer-same-window (marker-buffer marker))
22177 (if (or (> marker (point-max)) (< marker (point-min)))
22178 (widen))
22179 (goto-char marker)
22180 (org-show-context 'org-goto))
22181 (if bookmark
22182 (bookmark-jump bookmark)
22183 (error "Cannot find location"))))
22185 (defun org-quote-csv-field (s)
22186 "Quote field for inclusion in CSV material."
22187 (if (string-match "[\",]" s)
22188 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22191 (defun org-force-self-insert (N)
22192 "Needed to enforce self-insert under remapping."
22193 (interactive "p")
22194 (self-insert-command N))
22196 (defun org-string-width (s)
22197 "Compute width of string, ignoring invisible characters.
22198 This ignores character with invisibility property `org-link', and also
22199 characters with property `org-cwidth', because these will become invisible
22200 upon the next fontification round."
22201 (let (b l)
22202 (when (or (eq t buffer-invisibility-spec)
22203 (assq 'org-link buffer-invisibility-spec))
22204 (while (setq b (text-property-any 0 (length s)
22205 'invisible 'org-link s))
22206 (setq s (concat (substring s 0 b)
22207 (substring s (or (next-single-property-change
22208 b 'invisible s)
22209 (length s)))))))
22210 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22211 (setq s (concat (substring s 0 b)
22212 (substring s (or (next-single-property-change
22213 b 'org-cwidth s)
22214 (length s))))))
22215 (setq l (string-width s) b -1)
22216 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22217 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22220 (defun org-shorten-string (s maxlength)
22221 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22222 If the string is shorter or has length MAXLENGTH, just return the
22223 original string. If it is longer, the functions finds a space in the
22224 string, breaks this string off at that locations and adds three dots
22225 as ellipsis. Including the ellipsis, the string will not be longer
22226 than MAXLENGTH. If finding a good breaking point in the string does
22227 not work, the string is just chopped off in the middle of a word
22228 if necessary."
22229 (if (<= (length s) maxlength)
22231 (let* ((n (max (- maxlength 4) 1))
22232 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22233 (if (string-match re s)
22234 (concat (match-string 1 s) "...")
22235 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22237 (defun org-get-indentation (&optional line)
22238 "Get the indentation of the current line, interpreting tabs.
22239 When LINE is given, assume it represents a line and compute its indentation."
22240 (if line
22241 (if (string-match "^ *" (org-remove-tabs line))
22242 (match-end 0))
22243 (save-excursion
22244 (beginning-of-line 1)
22245 (skip-chars-forward " \t")
22246 (current-column))))
22248 (defun org-get-string-indentation (s)
22249 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22250 (let ((n -1) (i 0) (w tab-width) c)
22251 (catch 'exit
22252 (while (< (setq n (1+ n)) (length s))
22253 (setq c (aref s n))
22254 (cond ((= c ?\ ) (setq i (1+ i)))
22255 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22256 (t (throw 'exit t)))))
22259 (defun org-remove-tabs (s &optional width)
22260 "Replace tabulators in S with spaces.
22261 Assumes that s is a single line, starting in column 0."
22262 (setq width (or width tab-width))
22263 (while (string-match "\t" s)
22264 (setq s (replace-match
22265 (make-string
22266 (- (* width (/ (+ (match-beginning 0) width) width))
22267 (match-beginning 0)) ?\ )
22268 t t s)))
22271 (defun org-fix-indentation (line ind)
22272 "Fix indentation in LINE.
22273 IND is a cons cell with target and minimum indentation.
22274 If the current indentation in LINE is smaller than the minimum,
22275 leave it alone. If it is larger than ind, set it to the target."
22276 (let* ((l (org-remove-tabs line))
22277 (i (org-get-indentation l))
22278 (i1 (car ind)) (i2 (cdr ind)))
22279 (if (>= i i2) (setq l (substring line i2)))
22280 (if (> i1 0)
22281 (concat (make-string i1 ?\ ) l)
22282 l)))
22284 (defun org-remove-indentation (code &optional n)
22285 "Remove the maximum common indentation from the lines in CODE.
22286 N may optionally be the number of spaces to remove."
22287 (with-temp-buffer
22288 (insert code)
22289 (org-do-remove-indentation n)
22290 (buffer-string)))
22292 (defun org-do-remove-indentation (&optional n)
22293 "Remove the maximum common indentation from the buffer."
22294 (untabify (point-min) (point-max))
22295 (let ((min 10000) re)
22296 (if n
22297 (setq min n)
22298 (goto-char (point-min))
22299 (while (re-search-forward "^ *[^ \n]" nil t)
22300 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22301 (unless (or (= min 0) (= min 10000))
22302 (setq re (format "^ \\{%d\\}" min))
22303 (goto-char (point-min))
22304 (while (re-search-forward re nil t)
22305 (replace-match "")
22306 (end-of-line 1))
22307 min)))
22309 (defun org-fill-template (template alist)
22310 "Find each %key of ALIST in TEMPLATE and replace it."
22311 (let ((case-fold-search nil))
22312 (dolist (entry (sort (copy-sequence alist)
22313 (lambda (a b) (< (length (car a)) (length (car b))))))
22314 (setq template
22315 (replace-regexp-in-string
22316 (concat "%" (regexp-quote (car entry)))
22317 (or (cdr entry) "") template t t)))
22318 template))
22320 (defun org-base-buffer (buffer)
22321 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22322 (if (not buffer)
22323 buffer
22324 (or (buffer-base-buffer buffer)
22325 buffer)))
22327 (defun org-wrap (string &optional width lines)
22328 "Wrap string to either a number of lines, or a width in characters.
22329 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22330 that costs. If there is a word longer than WIDTH, the text is actually
22331 wrapped to the length of that word.
22332 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22333 many lines, whatever width that takes.
22334 The return value is a list of lines, without newlines at the end."
22335 (let* ((words (org-split-string string "[ \t\n]+"))
22336 (maxword (apply 'max (mapcar 'org-string-width words)))
22337 w ll)
22338 (cond (width
22339 (org-do-wrap words (max maxword width)))
22340 (lines
22341 (setq w maxword)
22342 (setq ll (org-do-wrap words maxword))
22343 (if (<= (length ll) lines)
22345 (setq ll words)
22346 (while (> (length ll) lines)
22347 (setq w (1+ w))
22348 (setq ll (org-do-wrap words w)))
22349 ll))
22350 (t (error "Cannot wrap this")))))
22352 (defun org-do-wrap (words width)
22353 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22354 (let (lines line)
22355 (while words
22356 (setq line (pop words))
22357 (while (and words (< (+ (length line) (length (car words))) width))
22358 (setq line (concat line " " (pop words))))
22359 (setq lines (push line lines)))
22360 (nreverse lines)))
22362 (defun org-split-string (string &optional separators)
22363 "Splits STRING into substrings at SEPARATORS.
22364 SEPARATORS is a regular expression.
22365 No empty strings are returned if there are matches at the beginning
22366 and end of string."
22367 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22368 (let ((start 0) notfirst list)
22369 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22370 (if (and notfirst
22371 (= start (match-beginning 0))
22372 (< start (length string)))
22373 (1+ start) start))
22374 (< (match-beginning 0) (length string)))
22375 (setq notfirst t)
22376 (or (eq (match-beginning 0) 0)
22377 (and (eq (match-beginning 0) (match-end 0))
22378 (eq (match-beginning 0) start))
22379 (push (substring string start (match-beginning 0)) list))
22380 (setq start (match-end 0)))
22381 (or (eq start (length string))
22382 (push (substring string start) list))
22383 (nreverse list)))
22385 (defun org-quote-vert (s)
22386 "Replace \"|\" with \"\\vert\"."
22387 (while (string-match "|" s)
22388 (setq s (replace-match "\\vert" t t s)))
22391 (defun org-uuidgen-p (s)
22392 "Is S an ID created by UUIDGEN?"
22393 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22395 (defun org-in-src-block-p (&optional inside)
22396 "Whether point is in a code source block.
22397 When INSIDE is non-nil, don't consider we are within a src block
22398 when point is at #+BEGIN_SRC or #+END_SRC."
22399 (let ((case-fold-search t) ov)
22400 (or (and (eq (get-char-property (point) 'src-block) t))
22401 (and (not inside)
22402 (save-match-data
22403 (save-excursion
22404 (beginning-of-line)
22405 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22407 (defun org-context ()
22408 "Return a list of contexts of the current cursor position.
22409 If several contexts apply, all are returned.
22410 Each context entry is a list with a symbol naming the context, and
22411 two positions indicating start and end of the context. Possible
22412 contexts are:
22414 :headline anywhere in a headline
22415 :headline-stars on the leading stars in a headline
22416 :todo-keyword on a TODO keyword (including DONE) in a headline
22417 :tags on the TAGS in a headline
22418 :priority on the priority cookie in a headline
22419 :item on the first line of a plain list item
22420 :item-bullet on the bullet/number of a plain list item
22421 :checkbox on the checkbox in a plain list item
22422 :table in an org-mode table
22423 :table-special on a special filed in a table
22424 :table-table in a table.el table
22425 :clocktable in a clocktable
22426 :src-block in a source block
22427 :link on a hyperlink
22428 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22429 :target on a <<target>>
22430 :radio-target on a <<<radio-target>>>
22431 :latex-fragment on a LaTeX fragment
22432 :latex-preview on a LaTeX fragment with overlaid preview image
22434 This function expects the position to be visible because it uses font-lock
22435 faces as a help to recognize the following contexts: :table-special, :link,
22436 and :keyword."
22437 (let* ((f (get-text-property (point) 'face))
22438 (faces (if (listp f) f (list f)))
22439 (case-fold-search t)
22440 (p (point)) clist o)
22441 ;; First the large context
22442 (cond
22443 ((org-at-heading-p t)
22444 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22445 (when (progn
22446 (beginning-of-line 1)
22447 (looking-at org-todo-line-tags-regexp))
22448 (push (org-point-in-group p 1 :headline-stars) clist)
22449 (push (org-point-in-group p 2 :todo-keyword) clist)
22450 (push (org-point-in-group p 4 :tags) clist))
22451 (goto-char p)
22452 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22453 (if (looking-at "\\[#[A-Z0-9]\\]")
22454 (push (org-point-in-group p 0 :priority) clist)))
22456 ((org-at-item-p)
22457 (push (org-point-in-group p 2 :item-bullet) clist)
22458 (push (list :item (point-at-bol)
22459 (save-excursion (org-end-of-item) (point)))
22460 clist)
22461 (and (org-at-item-checkbox-p)
22462 (push (org-point-in-group p 0 :checkbox) clist)))
22464 ((org-at-table-p)
22465 (push (list :table (org-table-begin) (org-table-end)) clist)
22466 (if (memq 'org-formula faces)
22467 (push (list :table-special
22468 (previous-single-property-change p 'face)
22469 (next-single-property-change p 'face)) clist)))
22470 ((org-at-table-p 'any)
22471 (push (list :table-table) clist)))
22472 (goto-char p)
22474 (let ((case-fold-search t))
22475 ;; New the "medium" contexts: clocktables, source blocks
22476 (cond ((org-in-clocktable-p)
22477 (push (list :clocktable
22478 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22479 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22480 (match-beginning 1))
22481 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22482 (match-end 0))) clist))
22483 ((org-in-src-block-p)
22484 (push (list :src-block
22485 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22486 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22487 (match-beginning 1))
22488 (and (search-forward "#+END_SRC" nil t)
22489 (match-beginning 0))) clist))))
22490 (goto-char p)
22492 ;; Now the small context
22493 (cond
22494 ((org-at-timestamp-p)
22495 (push (org-point-in-group p 0 :timestamp) clist))
22496 ((memq 'org-link faces)
22497 (push (list :link
22498 (previous-single-property-change p 'face)
22499 (next-single-property-change p 'face)) clist))
22500 ((memq 'org-special-keyword faces)
22501 (push (list :keyword
22502 (previous-single-property-change p 'face)
22503 (next-single-property-change p 'face)) clist))
22504 ((org-at-target-p)
22505 (push (org-point-in-group p 0 :target) clist)
22506 (goto-char (1- (match-beginning 0)))
22507 (if (looking-at org-radio-target-regexp)
22508 (push (org-point-in-group p 0 :radio-target) clist))
22509 (goto-char p))
22510 ((setq o (car (delq nil
22511 (mapcar
22512 (lambda (x)
22513 (if (memq x org-latex-fragment-image-overlays) x))
22514 (overlays-at (point))))))
22515 (push (list :latex-fragment
22516 (overlay-start o) (overlay-end o)) clist)
22517 (push (list :latex-preview
22518 (overlay-start o) (overlay-end o)) clist))
22519 ((org-inside-LaTeX-fragment-p)
22520 ;; FIXME: positions wrong.
22521 (push (list :latex-fragment (point) (point)) clist)))
22523 (setq clist (nreverse (delq nil clist)))
22524 clist))
22526 (defun org-in-regexp (re &optional nlines visually)
22527 "Check if point is inside a match of RE.
22529 Normally only the current line is checked, but you can include
22530 NLINES extra lines after point into the search. If VISUALLY is
22531 set, require that the cursor is not after the match but really
22532 on, so that the block visually is on the match."
22533 (catch 'exit
22534 (let ((pos (point))
22535 (eol (point-at-eol (+ 1 (or nlines 0))))
22536 (inc (if visually 1 0)))
22537 (save-excursion
22538 (beginning-of-line (- 1 (or nlines 0)))
22539 (while (re-search-forward re eol t)
22540 (if (and (<= (match-beginning 0) pos)
22541 (>= (+ inc (match-end 0)) pos))
22542 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22543 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22544 "Org mode 8.3")
22546 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22547 "Non-nil when point is between matches of START-RE and END-RE.
22549 Also return a non-nil value when point is on one of the matches.
22551 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22552 buffer positions. Default values are the positions of headlines
22553 surrounding the point.
22555 The functions returns a cons cell whose car (resp. cdr) is the
22556 position before START-RE (resp. after END-RE)."
22557 (save-match-data
22558 (let ((pos (point))
22559 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22560 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22561 beg end)
22562 (save-excursion
22563 ;; Point is on a block when on START-RE or if START-RE can be
22564 ;; found before it...
22565 (and (or (org-in-regexp start-re)
22566 (re-search-backward start-re limit-up t))
22567 (setq beg (match-beginning 0))
22568 ;; ... and END-RE after it...
22569 (goto-char (match-end 0))
22570 (re-search-forward end-re limit-down t)
22571 (> (setq end (match-end 0)) pos)
22572 ;; ... without another START-RE in-between.
22573 (goto-char (match-beginning 0))
22574 (not (re-search-backward start-re (1+ beg) t))
22575 ;; Return value.
22576 (cons beg end))))))
22578 (defun org-in-block-p (names)
22579 "Non-nil when point belongs to a block whose name belongs to NAMES.
22581 NAMES is a list of strings containing names of blocks.
22583 Return first block name matched, or nil. Beware that in case of
22584 nested blocks, the returned name may not belong to the closest
22585 block from point."
22586 (save-match-data
22587 (catch 'exit
22588 (let ((case-fold-search t)
22589 (lim-up (save-excursion (outline-previous-heading)))
22590 (lim-down (save-excursion (outline-next-heading))))
22591 (mapc (lambda (name)
22592 (let ((n (regexp-quote name)))
22593 (when (org-between-regexps-p
22594 (concat "^[ \t]*#\\+begin_" n)
22595 (concat "^[ \t]*#\\+end_" n)
22596 lim-up lim-down)
22597 (throw 'exit n))))
22598 names))
22599 nil)))
22601 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22602 "Call `multi-occur' with buffers for all agenda files."
22603 (interactive "sOrg-files matching: ")
22604 (let* ((files (org-agenda-files))
22605 (tnames (mapcar #'file-truename files))
22606 (extra org-agenda-text-search-extra-files))
22607 (when (eq (car extra) 'agenda-archives)
22608 (setq extra (cdr extra))
22609 (setq files (org-add-archive-files files)))
22610 (dolist (f extra)
22611 (unless (member (file-truename f) tnames)
22612 (unless (member f files) (setq files (append files (list f))))
22613 (setq tnames (append tnames (list (file-truename f))))))
22614 (multi-occur
22615 (mapcar (lambda (x)
22616 (with-current-buffer
22617 ;; FIXME: Why not just (find-file-noselect x)?
22618 ;; Is it to avoid the "revert buffer" prompt?
22619 (or (get-file-buffer x) (find-file-noselect x))
22620 (widen)
22621 (current-buffer)))
22622 files)
22623 regexp)))
22625 (if (boundp 'occur-mode-find-occurrence-hook)
22626 ;; Emacs 23
22627 (add-hook 'occur-mode-find-occurrence-hook
22628 (lambda ()
22629 (when (derived-mode-p 'org-mode)
22630 (org-reveal))))
22631 ;; Emacs 22
22632 (defadvice occur-mode-goto-occurrence
22633 (after org-occur-reveal activate)
22634 (and (derived-mode-p 'org-mode) (org-reveal)))
22635 (defadvice occur-mode-goto-occurrence-other-window
22636 (after org-occur-reveal activate)
22637 (and (derived-mode-p 'org-mode) (org-reveal)))
22638 (defadvice occur-mode-display-occurrence
22639 (after org-occur-reveal activate)
22640 (when (derived-mode-p 'org-mode)
22641 (let ((pos (occur-mode-find-occurrence)))
22642 (with-current-buffer (marker-buffer pos)
22643 (save-excursion
22644 (goto-char pos)
22645 (org-reveal)))))))
22647 (defun org-occur-link-in-agenda-files ()
22648 "Create a link and search for it in the agendas.
22649 The link is not stored in `org-stored-links', it is just created
22650 for the search purpose."
22651 (interactive)
22652 (let ((link (condition-case nil
22653 (org-store-link nil)
22654 (error "Unable to create a link to here"))))
22655 (org-occur-in-agenda-files (regexp-quote link))))
22657 (defun org-reverse-string (string)
22658 "Return the reverse of STRING."
22659 (apply 'string (reverse (string-to-list string))))
22661 ;; defsubst org-uniquify must be defined before first use
22663 (defun org-uniquify-alist (alist)
22664 "Merge elements of ALIST with the same key.
22666 For example, in this alist:
22668 \(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
22669 => \\='((a 1 3) (b 2))
22671 merge (a 1) and (a 3) into (a 1 3).
22673 The function returns the new ALIST."
22674 (let (rtn)
22675 (mapc
22676 (lambda (e)
22677 (let (n)
22678 (if (not (assoc (car e) rtn))
22679 (push e rtn)
22680 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22681 (setq rtn (assq-delete-all (car e) rtn))
22682 (push n rtn))))
22683 alist)
22684 rtn))
22686 (defun org-delete-all (elts list)
22687 "Remove all elements in ELTS from LIST."
22688 (while elts
22689 (setq list (delete (pop elts) list)))
22690 list)
22692 (defun org-count (cl-item cl-seq)
22693 "Count the number of occurrences of ITEM in SEQ.
22694 Taken from `count' in cl-seq.el with all keyword arguments removed."
22695 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22696 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22697 (while (< cl-start cl-end)
22698 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22699 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22700 (setq cl-start (1+ cl-start)))
22701 cl-count))
22703 (defun org-remove-if (predicate seq)
22704 "Remove everything from SEQ that fulfills PREDICATE."
22705 (let (res e)
22706 (while seq
22707 (setq e (pop seq))
22708 (if (not (funcall predicate e)) (push e res)))
22709 (nreverse res)))
22711 (defun org-remove-if-not (predicate seq)
22712 "Remove everything from SEQ that does not fulfill PREDICATE."
22713 (let (res e)
22714 (while seq
22715 (setq e (pop seq))
22716 (if (funcall predicate e) (push e res)))
22717 (nreverse res)))
22719 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22720 "Reduce two-argument FUNCTION across SEQ.
22721 Taken from `reduce' in cl-seq.el with all keyword arguments but
22722 \":initial-value\" removed."
22723 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22724 (cadr (memq :initial-value cl-keys)))
22725 (cl-seq (pop cl-seq))
22726 (t (funcall cl-func)))))
22727 (while cl-seq
22728 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22729 cl-accum))
22731 (defun org-every (pred seq)
22732 "Return true if PREDICATE is true of every element of SEQ.
22733 Adapted from `every' in cl.el."
22734 (catch 'org-every
22735 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22738 (defun org-some (pred seq)
22739 "Return true if PREDICATE is true of any element of SEQ.
22740 Adapted from `some' in cl.el."
22741 (catch 'org-some
22742 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22743 nil))
22745 (defun org-back-over-empty-lines ()
22746 "Move backwards over whitespace, to the beginning of the first empty line.
22747 Returns the number of empty lines passed."
22748 (let ((pos (point)))
22749 (if (cdr (assoc 'heading org-blank-before-new-entry))
22750 (skip-chars-backward " \t\n\r")
22751 (unless (eobp)
22752 (forward-line -1)))
22753 (beginning-of-line 2)
22754 (goto-char (min (point) pos))
22755 (count-lines (point) pos)))
22757 (defun org-skip-whitespace ()
22758 (skip-chars-forward " \t\n\r"))
22760 (defun org-point-in-group (point group &optional context)
22761 "Check if POINT is in match-group GROUP.
22762 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22763 match. If the match group does not exist or point is not inside it,
22764 return nil."
22765 (and (match-beginning group)
22766 (>= point (match-beginning group))
22767 (<= point (match-end group))
22768 (if context
22769 (list context (match-beginning group) (match-end group))
22770 t)))
22772 (defun org-switch-to-buffer-other-window (&rest args)
22773 "Switch to buffer in a second window on the current frame.
22774 In particular, do not allow pop-up frames.
22775 Returns the newly created buffer."
22776 (org-no-popups
22777 (apply 'switch-to-buffer-other-window args)))
22779 (defun org-combine-plists (&rest plists)
22780 "Create a single property list from all plists in PLISTS.
22781 The process starts by copying the first list, and then setting properties
22782 from the other lists. Settings in the last list are the most significant
22783 ones and overrule settings in the other lists."
22784 (let ((rtn (copy-sequence (pop plists)))
22785 p v ls)
22786 (while plists
22787 (setq ls (pop plists))
22788 (while ls
22789 (setq p (pop ls) v (pop ls))
22790 (setq rtn (plist-put rtn p v))))
22791 rtn))
22793 (defun org-replace-escapes (string table)
22794 "Replace %-escapes in STRING with values in TABLE.
22795 TABLE is an association list with keys like \"%a\" and string values.
22796 The sequences in STRING may contain normal field width and padding information,
22797 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22798 so values can contain further %-escapes if they are define later in TABLE."
22799 (let ((tbl (copy-alist table))
22800 (case-fold-search nil)
22801 (pchg 0)
22802 e re rpl)
22803 (dolist (e tbl)
22804 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22805 (when (and (cdr e) (string-match re (cdr e)))
22806 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22807 (safe "SREF"))
22808 (add-text-properties 0 3 (list 'sref sref) safe)
22809 (setcdr e (replace-match safe t t (cdr e)))))
22810 (while (string-match re string)
22811 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22812 (cdr e)))
22813 (setq string (replace-match rpl t t string))))
22814 (while (setq pchg (next-property-change pchg string))
22815 (let ((sref (get-text-property pchg 'sref string)))
22816 (when (and sref (string-match "SREF" string pchg))
22817 (setq string (replace-match sref t t string)))))
22818 string))
22820 (defun org-sublist (list start end)
22821 "Return a section of LIST, from START to END.
22822 Counting starts at 1."
22823 (let (rtn (c start))
22824 (setq list (nthcdr (1- start) list))
22825 (while (and list (<= c end))
22826 (push (pop list) rtn)
22827 (setq c (1+ c)))
22828 (nreverse rtn)))
22830 (defun org-find-base-buffer-visiting (file)
22831 "Like `find-buffer-visiting' but always return the base buffer and
22832 not an indirect buffer."
22833 (let ((buf (or (get-file-buffer file)
22834 (find-buffer-visiting file))))
22835 (if buf
22836 (or (buffer-base-buffer buf) buf)
22837 nil)))
22839 (defun org-image-file-name-regexp (&optional extensions)
22840 "Return regexp matching the file names of images.
22841 If EXTENSIONS is given, only match these."
22842 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22843 (image-file-name-regexp)
22844 (let ((image-file-name-extensions
22845 (or extensions
22846 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22847 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22848 (concat "\\."
22849 (regexp-opt (nconc (mapcar 'upcase
22850 image-file-name-extensions)
22851 image-file-name-extensions)
22853 "\\'"))))
22855 (defun org-file-image-p (file &optional extensions)
22856 "Return non-nil if FILE is an image."
22857 (save-match-data
22858 (string-match (org-image-file-name-regexp extensions) file)))
22860 (defun org-get-cursor-date (&optional with-time)
22861 "Return the date at cursor in as a time.
22862 This works in the calendar and in the agenda, anywhere else it just
22863 returns the current time.
22864 If WITH-TIME is non-nil, returns the time of the event at point (in
22865 the agenda) or the current time of the day."
22866 (let (date day defd tp hod mod)
22867 (when with-time
22868 (setq tp (get-text-property (point) 'time))
22869 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22870 (setq hod (string-to-number (match-string 1 tp))
22871 mod (string-to-number (match-string 2 tp))))
22872 (or tp (let ((now (decode-time)))
22873 (setq hod (nth 2 now)
22874 mod (nth 1 now)))))
22875 (cond
22876 ((eq major-mode 'calendar-mode)
22877 (setq date (calendar-cursor-to-date)
22878 defd (encode-time 0 (or mod 0) (or hod 0)
22879 (nth 1 date) (nth 0 date) (nth 2 date))))
22880 ((eq major-mode 'org-agenda-mode)
22881 (setq day (get-text-property (point) 'day))
22882 (if day
22883 (setq date (calendar-gregorian-from-absolute day)
22884 defd (encode-time 0 (or mod 0) (or hod 0)
22885 (nth 1 date) (nth 0 date) (nth 2 date))))))
22886 (or defd (current-time))))
22888 (defun org-mark-subtree (&optional up)
22889 "Mark the current subtree.
22890 This puts point at the start of the current subtree, and mark at
22891 the end. If a numeric prefix UP is given, move up into the
22892 hierarchy of headlines by UP levels before marking the subtree."
22893 (interactive "P")
22894 (org-with-limited-levels
22895 (cond ((org-at-heading-p) (beginning-of-line))
22896 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22897 (t (outline-previous-visible-heading 1))))
22898 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22899 (if (org-called-interactively-p 'any)
22900 (call-interactively 'org-mark-element)
22901 (org-mark-element)))
22904 ;;; Indentation
22906 (defun org--get-expected-indentation (element contentsp)
22907 "Expected indentation column for current line, according to ELEMENT.
22908 ELEMENT is an element containing point. CONTENTSP is non-nil
22909 when indentation is to be computed according to contents of
22910 ELEMENT."
22911 (let ((type (org-element-type element))
22912 (start (org-element-property :begin element))
22913 (post-affiliated (org-element-property :post-affiliated element)))
22914 (org-with-wide-buffer
22915 (cond
22916 (contentsp
22917 (case type
22918 ((diary-sexp footnote-definition) 0)
22919 ((headline inlinetask nil)
22920 (if (not org-adapt-indentation) 0
22921 (let ((level (org-current-level)))
22922 (if level (1+ level) 0))))
22923 ((item plain-list) (org-list-item-body-column post-affiliated))
22925 (goto-char start)
22926 (org-get-indentation))))
22927 ((memq type '(headline inlinetask nil))
22928 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22929 (org--get-expected-indentation element t)
22931 ((memq type '(diary-sexp footnote-definition)) 0)
22932 ;; First paragraph of a footnote definition or an item.
22933 ;; Indent like parent.
22934 ((< (line-beginning-position) start)
22935 (org--get-expected-indentation
22936 (org-element-property :parent element) t))
22937 ;; At first line: indent according to previous sibling, if any,
22938 ;; ignoring footnote definitions and inline tasks, or parent's
22939 ;; contents.
22940 ((= (line-beginning-position) start)
22941 (catch 'exit
22942 (while t
22943 (if (= (point-min) start) (throw 'exit 0)
22944 (goto-char (1- start))
22945 (let* ((previous (org-element-at-point))
22946 (parent previous))
22947 (while (and parent (<= (org-element-property :end parent) start))
22948 (setq previous parent
22949 parent (org-element-property :parent parent)))
22950 (cond
22951 ((not previous) (throw 'exit 0))
22952 ((> (org-element-property :end previous) start)
22953 (throw 'exit (org--get-expected-indentation previous t)))
22954 ((memq (org-element-type previous)
22955 '(footnote-definition inlinetask))
22956 (setq start (org-element-property :begin previous)))
22957 (t (goto-char (org-element-property :begin previous))
22958 (throw 'exit
22959 (if (bolp) (org-get-indentation)
22960 ;; At first paragraph in an item or
22961 ;; a footnote definition.
22962 (org--get-expected-indentation
22963 (org-element-property :parent previous) t))))))))))
22964 ;; Otherwise, move to the first non-blank line above.
22966 (beginning-of-line)
22967 (let ((pos (point)))
22968 (skip-chars-backward " \r\t\n")
22969 (cond
22970 ;; Two blank lines end a footnote definition or a plain
22971 ;; list. When we indent an empty line after them, the
22972 ;; containing list or footnote definition is over, so it
22973 ;; qualifies as a previous sibling. Therefore, we indent
22974 ;; like its first line.
22975 ((and (memq type '(footnote-definition plain-list))
22976 (> (count-lines (point) pos) 2))
22977 (goto-char start)
22978 (org-get-indentation))
22979 ;; Line above is the first one of a paragraph at the
22980 ;; beginning of an item or a footnote definition. Indent
22981 ;; like parent.
22982 ((< (line-beginning-position) start)
22983 (org--get-expected-indentation
22984 (org-element-property :parent element) t))
22985 ;; Line above is the beginning of an element, i.e., point
22986 ;; was originally on the blank lines between element's start
22987 ;; and contents.
22988 ((= (line-beginning-position) post-affiliated)
22989 (org--get-expected-indentation element t))
22990 ;; POS is after contents in a greater element. Indent like
22991 ;; the beginning of the element.
22993 ;; As a special case, if point is at the end of a footnote
22994 ;; definition or an item, indent like the very last element
22995 ;; within.
22996 ((and (not (eq type 'paragraph))
22997 (let ((cend (org-element-property :contents-end element)))
22998 (and cend (<= cend pos))))
22999 (if (memq type '(footnote-definition item plain-list))
23000 (let ((last (org-element-at-point)))
23001 (org--get-expected-indentation
23002 last
23003 (memq (org-element-type last)
23004 '(footnote-definition item plain-list))))
23005 (goto-char start)
23006 (org-get-indentation)))
23007 ;; In any other case, indent like the current line.
23008 (t (org-get-indentation)))))))))
23010 (defun org--align-node-property ()
23011 "Align node property at point.
23012 Alignment is done according to `org-property-format', which see."
23013 (when (save-excursion
23014 (beginning-of-line)
23015 (looking-at org-property-re))
23016 (replace-match
23017 (concat (match-string 4)
23018 (org-trim
23019 (format org-property-format (match-string 1) (match-string 3))))
23020 t t)))
23022 (defun org-indent-line ()
23023 "Indent line depending on context.
23025 Indentation is done according to the following rules:
23027 - Footnote definitions, diary sexps, headlines and inline tasks
23028 have to start at column 0.
23030 - On the very first line of an element, consider, in order, the
23031 next rules until one matches:
23033 1. If there's a sibling element before, ignoring footnote
23034 definitions and inline tasks, indent like its first line.
23036 2. If element has a parent, indent like its contents. More
23037 precisely, if parent is an item, indent after the
23038 description part, if any, or the bullet (see
23039 `org-list-description-max-indent'). Else, indent like
23040 parent's first line.
23042 3. Otherwise, indent relatively to current level, if
23043 `org-adapt-indentation' is non-nil, or to left margin.
23045 - On a blank line at the end of an element, indent according to
23046 the type of the element. More precisely
23048 1. If element is a plain list, an item, or a footnote
23049 definition, indent like the very last element within.
23051 2. If element is a paragraph, indent like its last non blank
23052 line.
23054 3. Otherwise, indent like its very first line.
23056 - In the code part of a source block, use language major mode
23057 to indent current line if `org-src-tab-acts-natively' is
23058 non-nil. If it is nil, do nothing.
23060 - Otherwise, indent like the first non-blank line above.
23062 The function doesn't indent an item as it could break the whole
23063 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
23064 \\[org-shiftmetaright].
23066 Also align node properties according to `org-property-format'."
23067 (interactive)
23068 (cond
23069 (orgstruct-is-++
23070 (let ((indent-line-function
23071 (cadadr (assq 'indent-line-function org-fb-vars))))
23072 (indent-according-to-mode)))
23073 ((org-at-heading-p) 'noindent)
23075 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23076 (type (org-element-type element)))
23077 (cond ((and (memq type '(plain-list item))
23078 (= (line-beginning-position)
23079 (org-element-property :post-affiliated element)))
23080 'noindent)
23081 ((and (eq type 'src-block)
23082 org-src-tab-acts-natively
23083 (> (line-beginning-position)
23084 (org-element-property :post-affiliated element))
23085 (< (line-beginning-position)
23086 (org-with-wide-buffer
23087 (goto-char (org-element-property :end element))
23088 (skip-chars-backward " \r\t\n")
23089 (line-beginning-position))))
23090 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23092 (let ((column (org--get-expected-indentation element nil)))
23093 ;; Preserve current column.
23094 (if (<= (current-column) (current-indentation))
23095 (org-indent-line-to column)
23096 (save-excursion (org-indent-line-to column))))
23097 ;; Align node property. Also preserve current column.
23098 (when (eq type 'node-property)
23099 (let ((column (current-column)))
23100 (org--align-node-property)
23101 (org-move-to-column column)))))))))
23103 (defun org-indent-region (start end)
23104 "Indent each non-blank line in the region.
23105 Called from a program, START and END specify the region to
23106 indent. The function will not indent contents of example blocks,
23107 verse blocks and export blocks as leading white spaces are
23108 assumed to be significant there."
23109 (interactive "r")
23110 (save-excursion
23111 (goto-char start)
23112 (skip-chars-forward " \r\t\n")
23113 (unless (eobp) (beginning-of-line))
23114 (let ((indent-to
23115 (lambda (ind pos)
23116 ;; Set IND as indentation for all lines between point and
23117 ;; POS or END, whichever comes first. Blank lines are
23118 ;; ignored. Leave point after POS once done.
23119 (let ((limit (copy-marker (min end pos))))
23120 (while (< (point) limit)
23121 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23122 (forward-line))
23123 (set-marker limit nil))))
23124 (end (copy-marker end)))
23125 (while (< (point) end)
23126 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23127 (let* ((element (org-element-at-point))
23128 (type (org-element-type element))
23129 (element-end (copy-marker (org-element-property :end element)))
23130 (ind (org--get-expected-indentation element nil)))
23131 (cond
23132 ((or (memq type '(paragraph table table-row))
23133 (not (or (org-element-property :contents-begin element)
23134 (memq type
23135 '(example-block export-block src-block)))))
23136 ;; Elements here are indented as a single block. Also
23137 ;; align node properties.
23138 (when (eq type 'node-property)
23139 (org--align-node-property)
23140 (beginning-of-line))
23141 (funcall indent-to ind element-end))
23143 ;; Elements in this category consist of three parts:
23144 ;; before the contents, the contents, and after the
23145 ;; contents. The contents are treated specially,
23146 ;; according to the element type, or not indented at
23147 ;; all. Other parts are indented as a single block.
23148 (let* ((post (copy-marker
23149 (org-element-property :post-affiliated element)))
23150 (cbeg
23151 (copy-marker
23152 (cond
23153 ((not (org-element-property :contents-begin element))
23154 ;; Fake contents for source blocks.
23155 (org-with-wide-buffer
23156 (goto-char post)
23157 (forward-line)
23158 (point)))
23159 ((memq type '(footnote-definition item plain-list))
23160 ;; Contents in these elements could start on
23161 ;; the same line as the beginning of the
23162 ;; element. Make sure we start indenting
23163 ;; from the second line.
23164 (org-with-wide-buffer
23165 (goto-char post)
23166 (end-of-line)
23167 (skip-chars-forward " \r\t\n")
23168 (if (eobp) (point) (line-beginning-position))))
23169 (t (org-element-property :contents-begin element)))))
23170 (cend (copy-marker
23171 (or (org-element-property :contents-end element)
23172 ;; Fake contents for source blocks.
23173 (org-with-wide-buffer
23174 (goto-char element-end)
23175 (skip-chars-backward " \r\t\n")
23176 (line-beginning-position)))
23177 t)))
23178 ;; Do not change items indentation individually as it
23179 ;; might break the list as a whole. On the other
23180 ;; hand, when at a plain list, indent it as a whole.
23181 (cond ((eq type 'plain-list)
23182 (let ((offset (- ind (org-get-indentation))))
23183 (unless (zerop offset)
23184 (indent-rigidly (org-element-property :begin element)
23185 (org-element-property :end element)
23186 offset))
23187 (goto-char cbeg)))
23188 ((eq type 'item) (goto-char cbeg))
23189 (t (funcall indent-to ind cbeg)))
23190 (when (< (point) end)
23191 (case type
23192 ((example-block export-block verse-block))
23193 (src-block
23194 ;; In a source block, indent source code
23195 ;; according to language major mode, but only if
23196 ;; `org-src-tab-acts-natively' is non-nil.
23197 (when (and (< (point) end) org-src-tab-acts-natively)
23198 (ignore-errors
23199 (org-babel-do-in-edit-buffer
23200 (indent-region (point-min) (point-max))))))
23201 (t (org-indent-region (point) (min cend end))))
23202 (goto-char (min cend end))
23203 (when (< (point) end) (funcall indent-to ind element-end)))
23204 (set-marker post nil)
23205 (set-marker cbeg nil)
23206 (set-marker cend nil))))
23207 (set-marker element-end nil))))
23208 (set-marker end nil))))
23210 (defun org-indent-drawer ()
23211 "Indent the drawer at point."
23212 (interactive)
23213 (unless (save-excursion
23214 (beginning-of-line)
23215 (org-looking-at-p org-drawer-regexp))
23216 (user-error "Not at a drawer"))
23217 (let ((element (org-element-at-point)))
23218 (unless (memq (org-element-type element) '(drawer property-drawer))
23219 (user-error "Not at a drawer"))
23220 (org-with-wide-buffer
23221 (org-indent-region (org-element-property :begin element)
23222 (org-element-property :end element))))
23223 (message "Drawer at point indented"))
23225 (defun org-indent-block ()
23226 "Indent the block at point."
23227 (interactive)
23228 (unless (save-excursion
23229 (beginning-of-line)
23230 (let ((case-fold-search t))
23231 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23232 (user-error "Not at a block"))
23233 (let ((element (org-element-at-point)))
23234 (unless (memq (org-element-type element)
23235 '(comment-block center-block dynamic-block example-block
23236 export-block quote-block special-block
23237 src-block verse-block))
23238 (user-error "Not at a block"))
23239 (org-with-wide-buffer
23240 (org-indent-region (org-element-property :begin element)
23241 (org-element-property :end element))))
23242 (message "Block at point indented"))
23245 ;;; Filling
23247 ;; We use our own fill-paragraph and auto-fill functions.
23249 ;; `org-fill-paragraph' relies on adaptive filling and context
23250 ;; checking. Appropriate `fill-prefix' is computed with
23251 ;; `org-adaptive-fill-function'.
23253 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23254 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23255 ;; `org-adaptive-fill-function' value. Internally,
23256 ;; `org-comment-line-break-function' breaks the line.
23258 ;; `org-setup-filling' installs filling and auto-filling related
23259 ;; variables during `org-mode' initialization.
23261 (defvar org-element-paragraph-separate) ; org-element.el
23262 (defun org-setup-filling ()
23263 (require 'org-element)
23264 ;; Prevent auto-fill from inserting unwanted new items.
23265 (when (boundp 'fill-nobreak-predicate)
23266 (org-set-local
23267 'fill-nobreak-predicate
23268 (org-uniquify
23269 (append fill-nobreak-predicate
23270 '(org-fill-line-break-nobreak-p
23271 org-fill-paragraph-with-timestamp-nobreak-p)))))
23272 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23273 (org-set-local 'paragraph-start paragraph-ending)
23274 (org-set-local 'paragraph-separate paragraph-ending))
23275 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23276 (org-set-local 'auto-fill-inhibit-regexp nil)
23277 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23278 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23279 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23281 (defun org-fill-line-break-nobreak-p ()
23282 "Non-nil when a new line at point would create an Org line break."
23283 (save-excursion
23284 (skip-chars-backward "[ \t]")
23285 (skip-chars-backward "\\\\")
23286 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23288 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23289 "Non-nil when a new line at point would split a timestamp."
23290 (and (org-at-timestamp-p t)
23291 (not (looking-at org-ts-regexp-both))))
23293 (declare-function message-in-body-p "message" ())
23294 (defvar orgtbl-line-start-regexp) ; From org-table.el
23295 (defun org-adaptive-fill-function ()
23296 "Compute a fill prefix for the current line.
23297 Return fill prefix, as a string, or nil if current line isn't
23298 meant to be filled. For convenience, if `adaptive-fill-regexp'
23299 matches in paragraphs or comments, use it."
23300 (catch 'exit
23301 (when (derived-mode-p 'message-mode)
23302 (save-excursion
23303 (beginning-of-line)
23304 (cond ((not (message-in-body-p)) (throw 'exit nil))
23305 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23306 ((looking-at message-cite-prefix-regexp)
23307 (throw 'exit (match-string-no-properties 0)))
23308 ((looking-at org-outline-regexp)
23309 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23310 (org-with-wide-buffer
23311 (unless (org-at-heading-p)
23312 (let* ((p (line-beginning-position))
23313 (element (save-excursion
23314 (beginning-of-line)
23315 (org-element-at-point)))
23316 (type (org-element-type element))
23317 (post-affiliated (org-element-property :post-affiliated element)))
23318 (unless (< p post-affiliated)
23319 (case type
23320 (comment
23321 (save-excursion
23322 (beginning-of-line)
23323 (looking-at "[ \t]*")
23324 (concat (match-string 0) "# ")))
23325 (footnote-definition "")
23326 ((item plain-list)
23327 (make-string (org-list-item-body-column post-affiliated) ?\s))
23328 (paragraph
23329 ;; Fill prefix is usually the same as the current line,
23330 ;; unless the paragraph is at the beginning of an item.
23331 (let ((parent (org-element-property :parent element)))
23332 (save-excursion
23333 (beginning-of-line)
23334 (cond ((eq (org-element-type parent) 'item)
23335 (make-string (org-list-item-body-column
23336 (org-element-property :begin parent))
23337 ?\s))
23338 ((and adaptive-fill-regexp
23339 ;; Locally disable
23340 ;; `adaptive-fill-function' to let
23341 ;; `fill-context-prefix' handle
23342 ;; `adaptive-fill-regexp' variable.
23343 (let (adaptive-fill-function)
23344 (fill-context-prefix
23345 post-affiliated
23346 (org-element-property :end element)))))
23347 ((looking-at "[ \t]+") (match-string 0))
23348 (t "")))))
23349 (comment-block
23350 ;; Only fill contents if P is within block boundaries.
23351 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23352 (forward-line)
23353 (point)))
23354 (cend (save-excursion
23355 (goto-char (org-element-property :end element))
23356 (skip-chars-backward " \r\t\n")
23357 (line-beginning-position))))
23358 (when (and (>= p cbeg) (< p cend))
23359 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23360 (match-string 0)
23361 "")))))))))))
23363 (declare-function message-goto-body "message" ())
23364 (defvar message-cite-prefix-regexp) ; From message.el
23365 (defun org-fill-paragraph (&optional justify)
23366 "Fill element at point, when applicable.
23368 This function only applies to comment blocks, comments, example
23369 blocks and paragraphs. Also, as a special case, re-align table
23370 when point is at one.
23372 If JUSTIFY is non-nil (interactively, with prefix argument),
23373 justify as well. If `sentence-end-double-space' is non-nil, then
23374 period followed by one space does not end a sentence, so don't
23375 break a line there. The variable `fill-column' controls the
23376 width for filling.
23378 For convenience, when point is at a plain list, an item or
23379 a footnote definition, try to fill the first paragraph within."
23380 (interactive)
23381 (if (and (derived-mode-p 'message-mode)
23382 (or (not (message-in-body-p))
23383 (save-excursion (move-beginning-of-line 1)
23384 (looking-at message-cite-prefix-regexp))))
23385 ;; First ensure filling is correct in message-mode.
23386 (let ((fill-paragraph-function
23387 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23388 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23389 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23390 (paragraph-separate
23391 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23392 (fill-paragraph nil))
23393 (with-syntax-table org-mode-transpose-word-syntax-table
23394 ;; Move to end of line in order to get the first paragraph
23395 ;; within a plain list or a footnote definition.
23396 (let ((element (save-excursion
23397 (end-of-line)
23398 (or (ignore-errors (org-element-at-point))
23399 (user-error "An element cannot be parsed line %d"
23400 (line-number-at-pos (point)))))))
23401 ;; First check if point is in a blank line at the beginning of
23402 ;; the buffer. In that case, ignore filling.
23403 (case (org-element-type element)
23404 ;; Use major mode filling function is src blocks.
23405 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23406 ;; Align Org tables, leave table.el tables as-is.
23407 (table-row (org-table-align) t)
23408 (table
23409 (when (eq (org-element-property :type element) 'org)
23410 (save-excursion
23411 (goto-char (org-element-property :post-affiliated element))
23412 (org-table-align)))
23414 (paragraph
23415 ;; Paragraphs may contain `line-break' type objects.
23416 (let ((beg (max (point-min)
23417 (org-element-property :contents-begin element)))
23418 (end (min (point-max)
23419 (org-element-property :contents-end element))))
23420 ;; Do nothing if point is at an affiliated keyword.
23421 (if (< (line-end-position) beg) t
23422 (when (derived-mode-p 'message-mode)
23423 ;; In `message-mode', do not fill following citation
23424 ;; in current paragraph nor text before message body.
23425 (let ((body-start (save-excursion (message-goto-body))))
23426 (when body-start (setq beg (max body-start beg))))
23427 (when (save-excursion
23428 (re-search-forward
23429 (concat "^" message-cite-prefix-regexp) end t))
23430 (setq end (match-beginning 0))))
23431 ;; Fill paragraph, taking line breaks into account.
23432 (save-excursion
23433 (goto-char beg)
23434 (let ((cuts (list beg)))
23435 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23436 (when (eq 'line-break
23437 (org-element-type
23438 (save-excursion (backward-char)
23439 (org-element-context))))
23440 (push (point) cuts)))
23441 (dolist (c (delq end cuts))
23442 (fill-region-as-paragraph c end justify)
23443 (setq end c))))
23444 t)))
23445 ;; Contents of `comment-block' type elements should be
23446 ;; filled as plain text, but only if point is within block
23447 ;; markers.
23448 (comment-block
23449 (let* ((case-fold-search t)
23450 (beg (save-excursion
23451 (goto-char (org-element-property :begin element))
23452 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23453 (forward-line)
23454 (point)))
23455 (end (save-excursion
23456 (goto-char (org-element-property :end element))
23457 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23458 (line-beginning-position))))
23459 (if (or (< (point) beg) (> (point) end)) t
23460 (fill-region-as-paragraph
23461 (save-excursion (end-of-line)
23462 (re-search-backward "^[ \t]*$" beg 'move)
23463 (line-beginning-position))
23464 (save-excursion (beginning-of-line)
23465 (re-search-forward "^[ \t]*$" end 'move)
23466 (line-beginning-position))
23467 justify))))
23468 ;; Fill comments.
23469 (comment
23470 (let ((begin (org-element-property :post-affiliated element))
23471 (end (org-element-property :end element)))
23472 (when (and (>= (point) begin) (<= (point) end))
23473 (let ((begin (save-excursion
23474 (end-of-line)
23475 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23476 (progn (forward-line) (point))
23477 begin)))
23478 (end (save-excursion
23479 (end-of-line)
23480 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23481 (1- (line-beginning-position))
23482 (skip-chars-backward " \r\t\n")
23483 (line-end-position)))))
23484 ;; Do not fill comments when at a blank line.
23485 (when (> end begin)
23486 (let ((fill-prefix
23487 (save-excursion
23488 (beginning-of-line)
23489 (looking-at "[ \t]*#")
23490 (let ((comment-prefix (match-string 0)))
23491 (goto-char (match-end 0))
23492 (if (looking-at adaptive-fill-regexp)
23493 (concat comment-prefix (match-string 0))
23494 (concat comment-prefix " "))))))
23495 (save-excursion
23496 (fill-region-as-paragraph begin end justify))))))
23498 ;; Ignore every other element.
23499 (otherwise t))))))
23501 (defun org-auto-fill-function ()
23502 "Auto-fill function."
23503 ;; Check if auto-filling is meaningful.
23504 (let ((fc (current-fill-column)))
23505 (when (and fc (> (current-column) fc))
23506 (let* ((fill-prefix (org-adaptive-fill-function))
23507 ;; Enforce empty fill prefix, if required. Otherwise, it
23508 ;; will be computed again.
23509 (adaptive-fill-mode (not (equal fill-prefix ""))))
23510 (when fill-prefix (do-auto-fill))))))
23512 (defun org-comment-line-break-function (&optional soft)
23513 "Break line at point and indent, continuing comment if within one.
23514 The inserted newline is marked hard if variable
23515 `use-hard-newlines' is true, unless optional argument SOFT is
23516 non-nil."
23517 (if soft (insert-and-inherit ?\n) (newline 1))
23518 (save-excursion (forward-char -1) (delete-horizontal-space))
23519 (delete-horizontal-space)
23520 (indent-to-left-margin)
23521 (insert-before-markers-and-inherit fill-prefix))
23524 ;;; Fixed Width Areas
23526 (defun org-toggle-fixed-width ()
23527 "Toggle fixed-width markup.
23529 Add or remove fixed-width markup on current line, whenever it
23530 makes sense. Return an error otherwise.
23532 If a region is active and if it contains only fixed-width areas
23533 or blank lines, remove all fixed-width markup in it. If the
23534 region contains anything else, convert all non-fixed-width lines
23535 to fixed-width ones.
23537 Blank lines at the end of the region are ignored unless the
23538 region only contains such lines."
23539 (interactive)
23540 (if (not (org-region-active-p))
23541 ;; No region:
23543 ;; Remove fixed width marker only in a fixed-with element.
23545 ;; Add fixed width maker in paragraphs, in blank lines after
23546 ;; elements or at the beginning of a headline or an inlinetask,
23547 ;; and before any one-line elements (e.g., a clock).
23548 (progn
23549 (beginning-of-line)
23550 (let* ((element (org-element-at-point))
23551 (type (org-element-type element)))
23552 (cond
23553 ((and (eq type 'fixed-width)
23554 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23555 (replace-match
23556 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23557 ((and (memq type '(babel-call clock comment diary-sexp headline
23558 horizontal-rule keyword paragraph
23559 planning))
23560 (<= (org-element-property :post-affiliated element) (point)))
23561 (skip-chars-forward " \t")
23562 (insert ": "))
23563 ((and (org-looking-at-p "[ \t]*$")
23564 (or (eq type 'inlinetask)
23565 (save-excursion
23566 (skip-chars-forward " \r\t\n")
23567 (<= (org-element-property :end element) (point)))))
23568 (delete-region (point) (line-end-position))
23569 (org-indent-line)
23570 (insert ": "))
23571 (t (user-error "Cannot insert a fixed-width line here")))))
23572 ;; Region active.
23573 (let* ((begin (save-excursion
23574 (goto-char (region-beginning))
23575 (line-beginning-position)))
23576 (end (copy-marker
23577 (save-excursion
23578 (goto-char (region-end))
23579 (unless (eolp) (beginning-of-line))
23580 (if (save-excursion (re-search-backward "\\S-" begin t))
23581 (progn (skip-chars-backward " \r\t\n") (point))
23582 (point)))))
23583 (all-fixed-width-p
23584 (catch 'not-all-p
23585 (save-excursion
23586 (goto-char begin)
23587 (skip-chars-forward " \r\t\n")
23588 (when (eobp) (throw 'not-all-p nil))
23589 (while (< (point) end)
23590 (let ((element (org-element-at-point)))
23591 (if (eq (org-element-type element) 'fixed-width)
23592 (goto-char (org-element-property :end element))
23593 (throw 'not-all-p nil))))
23594 t))))
23595 (if all-fixed-width-p
23596 (save-excursion
23597 (goto-char begin)
23598 (while (< (point) end)
23599 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23600 (replace-match
23601 "" nil nil nil
23602 (if (= (line-end-position) (match-end 0)) 0 1)))
23603 (forward-line)))
23604 (let ((min-ind (point-max)))
23605 ;; Find minimum indentation across all lines.
23606 (save-excursion
23607 (goto-char begin)
23608 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23609 (setq min-ind 0)
23610 (catch 'zerop
23611 (while (< (point) end)
23612 (unless (org-looking-at-p "[ \t]*$")
23613 (let ((ind (org-get-indentation)))
23614 (setq min-ind (min min-ind ind))
23615 (when (zerop ind) (throw 'zerop t))))
23616 (forward-line)))))
23617 ;; Loop over all lines and add fixed-width markup everywhere
23618 ;; but in fixed-width lines.
23619 (save-excursion
23620 (goto-char begin)
23621 (while (< (point) end)
23622 (cond
23623 ((org-at-heading-p)
23624 (insert ": ")
23625 (forward-line)
23626 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23627 (insert ":")
23628 (forward-line)))
23629 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23630 (let* ((element (org-element-at-point))
23631 (element-end (org-element-property :end element)))
23632 (if (eq (org-element-type element) 'fixed-width)
23633 (progn (goto-char element-end)
23634 (skip-chars-backward " \r\t\n")
23635 (forward-line))
23636 (let ((limit (min end element-end)))
23637 (while (< (point) limit)
23638 (org-move-to-column min-ind t)
23639 (insert ": ")
23640 (forward-line))))))
23642 (org-move-to-column min-ind t)
23643 (insert ": ")
23644 (forward-line)))))))
23645 (set-marker end nil))))
23648 ;;; Comments
23650 ;; Org comments syntax is quite complex. It requires the entire line
23651 ;; to be just a comment. Also, even with the right syntax at the
23652 ;; beginning of line, some some elements (i.e. verse-block or
23653 ;; example-block) don't accept comments. Usual Emacs comment commands
23654 ;; cannot cope with those requirements. Therefore, Org replaces them.
23656 ;; Org still relies on `comment-dwim', but cannot trust
23657 ;; `comment-only-p'. So, `comment-region-function' and
23658 ;; `uncomment-region-function' both point
23659 ;; to`org-comment-or-uncomment-region'. Eventually,
23660 ;; `org-insert-comment' takes care of insertion of comments at the
23661 ;; beginning of line.
23663 ;; `org-setup-comments-handling' install comments related variables
23664 ;; during `org-mode' initialization.
23666 (defun org-setup-comments-handling ()
23667 (interactive)
23668 (org-set-local 'comment-use-syntax nil)
23669 (org-set-local 'comment-start "# ")
23670 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23671 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23672 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23673 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23675 (defun org-insert-comment ()
23676 "Insert an empty comment above current line.
23677 If the line is empty, insert comment at its beginning. When
23678 point is within a source block, comment according to the related
23679 major mode."
23680 (if (let ((element (org-element-at-point)))
23681 (and (eq (org-element-type element) 'src-block)
23682 (< (save-excursion
23683 (goto-char (org-element-property :post-affiliated element))
23684 (line-end-position))
23685 (point))
23686 (> (save-excursion
23687 (goto-char (org-element-property :end element))
23688 (skip-chars-backward " \r\t\n")
23689 (line-beginning-position))
23690 (point))))
23691 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23692 (beginning-of-line)
23693 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23694 (open-line 1))
23695 (org-indent-line)
23696 (insert "# ")))
23698 (defvar comment-empty-lines) ; From newcomment.el.
23699 (defun org-comment-or-uncomment-region (beg end &rest _)
23700 "Comment or uncomment each non-blank line in the region.
23701 Uncomment each non-blank line between BEG and END if it only
23702 contains commented lines. Otherwise, comment them. If region is
23703 strictly within a source block, use appropriate comment syntax."
23704 (if (let ((element (org-element-at-point)))
23705 (and (eq (org-element-type element) 'src-block)
23706 (< (save-excursion
23707 (goto-char (org-element-property :post-affiliated element))
23708 (line-end-position))
23709 beg)
23710 (>= (save-excursion
23711 (goto-char (org-element-property :end element))
23712 (skip-chars-backward " \r\t\n")
23713 (line-beginning-position))
23714 end)))
23715 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23716 (save-restriction
23717 ;; Restrict region
23718 (narrow-to-region (save-excursion (goto-char beg)
23719 (skip-chars-forward " \r\t\n" end)
23720 (line-beginning-position))
23721 (save-excursion (goto-char end)
23722 (skip-chars-backward " \r\t\n" beg)
23723 (line-end-position)))
23724 (let ((uncommentp
23725 ;; UNCOMMENTP is non-nil when every non blank line between
23726 ;; BEG and END is a comment.
23727 (save-excursion
23728 (goto-char (point-min))
23729 (while (and (not (eobp))
23730 (let ((element (org-element-at-point)))
23731 (and (eq (org-element-type element) 'comment)
23732 (goto-char (min (point-max)
23733 (org-element-property
23734 :end element)))))))
23735 (eobp))))
23736 (if uncommentp
23737 ;; Only blank lines and comments in region: uncomment it.
23738 (save-excursion
23739 (goto-char (point-min))
23740 (while (not (eobp))
23741 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23742 (replace-match "" nil nil nil 1))
23743 (forward-line)))
23744 ;; Comment each line in region.
23745 (let ((min-indent (point-max)))
23746 ;; First find the minimum indentation across all lines.
23747 (save-excursion
23748 (goto-char (point-min))
23749 (while (and (not (eobp)) (not (zerop min-indent)))
23750 (unless (looking-at "[ \t]*$")
23751 (setq min-indent (min min-indent (current-indentation))))
23752 (forward-line)))
23753 ;; Then loop over all lines.
23754 (save-excursion
23755 (goto-char (point-min))
23756 (while (not (eobp))
23757 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23758 ;; Don't get fooled by invisible text (e.g. link path)
23759 ;; when moving to column MIN-INDENT.
23760 (let ((buffer-invisibility-spec nil))
23761 (org-move-to-column min-indent t))
23762 (insert comment-start))
23763 (forward-line)))))))))
23765 (defun org-comment-dwim (arg)
23766 "Call `comment-dwim' within a source edit buffer if needed."
23767 (interactive "*P")
23768 (if (org-in-src-block-p)
23769 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23770 (call-interactively 'comment-dwim)))
23773 ;;; Timestamps API
23775 ;; This section contains tools to operate on timestamp objects, as
23776 ;; returned by, e.g. `org-element-context'.
23778 (defun org-timestamp--to-internal-time (timestamp &optional end)
23779 "Encode TIMESTAMP object into Emacs internal time.
23780 Use end of date range or time range when END is non-nil."
23781 (apply #'encode-time
23782 (cons 0
23783 (mapcar
23784 (lambda (prop) (or (org-element-property prop timestamp) 0))
23785 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23786 '(:minute-start :hour-start :day-start :month-start
23787 :year-start))))))
23789 (defun org-timestamp-has-time-p (timestamp)
23790 "Non-nil when TIMESTAMP has a time specified."
23791 (org-element-property :hour-start timestamp))
23793 (defun org-timestamp-format (timestamp format &optional end utc)
23794 "Format a TIMESTAMP object into a string.
23796 FORMAT is a format specifier to be passed to
23797 `format-time-string'.
23799 When optional argument END is non-nil, use end of date-range or
23800 time-range, if possible.
23802 When optional argument UTC is non-nil, time will be expressed as
23803 Universal Time."
23804 (format-time-string
23805 format (org-timestamp--to-internal-time timestamp end) utc))
23807 (defun org-timestamp-split-range (timestamp &optional end)
23808 "Extract a TIMESTAMP object from a date or time range.
23810 END, when non-nil, means extract the end of the range.
23811 Otherwise, extract its start.
23813 Return a new timestamp object."
23814 (let ((type (org-element-property :type timestamp)))
23815 (if (memq type '(active inactive diary)) timestamp
23816 (let ((split-ts (org-element-copy timestamp)))
23817 ;; Set new type.
23818 (org-element-put-property
23819 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23820 ;; Copy start properties over end properties if END is
23821 ;; non-nil. Otherwise, copy end properties over `start' ones.
23822 (let ((p-alist '((:minute-start . :minute-end)
23823 (:hour-start . :hour-end)
23824 (:day-start . :day-end)
23825 (:month-start . :month-end)
23826 (:year-start . :year-end))))
23827 (dolist (p-cell p-alist)
23828 (org-element-put-property
23829 split-ts
23830 (funcall (if end #'car #'cdr) p-cell)
23831 (org-element-property
23832 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23833 ;; Eventually refresh `:raw-value'.
23834 (org-element-put-property split-ts :raw-value nil)
23835 (org-element-put-property
23836 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23838 (defun org-timestamp-translate (timestamp &optional boundary)
23839 "Translate TIMESTAMP object to custom format.
23841 Format string is defined in `org-time-stamp-custom-formats',
23842 which see.
23844 When optional argument BOUNDARY is non-nil, it is either the
23845 symbol `start' or `end'. In this case, only translate the
23846 starting or ending part of TIMESTAMP if it is a date or time
23847 range. Otherwise, translate both parts.
23849 Return timestamp as-is if `org-display-custom-times' is nil or if
23850 it has a `diary' type."
23851 (let ((type (org-element-property :type timestamp)))
23852 (if (or (not org-display-custom-times) (eq type 'diary))
23853 (org-element-interpret-data timestamp)
23854 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23855 org-time-stamp-custom-formats)))
23856 (if (and (not boundary) (memq type '(active-range inactive-range)))
23857 (concat (org-timestamp-format timestamp fmt)
23858 "--"
23859 (org-timestamp-format timestamp fmt t))
23860 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23864 ;;; Other stuff.
23866 (defvar reftex-docstruct-symbol)
23867 (defvar reftex-cite-format)
23868 (defvar org--rds)
23870 (defun org-reftex-citation ()
23871 "Use reftex-citation to insert a citation into the buffer.
23872 This looks for a line like
23874 #+BIBLIOGRAPHY: foo plain option:-d
23876 and derives from it that foo.bib is the bibliography file relevant
23877 for this document. It then installs the necessary environment for RefTeX
23878 to work in this buffer and calls `reftex-citation' to insert a citation
23879 into the buffer.
23881 Export of such citations to both LaTeX and HTML is handled by the contributed
23882 package ox-bibtex by Taru Karttunen."
23883 (interactive)
23884 (let ((reftex-docstruct-symbol 'org--rds)
23885 (reftex-cite-format "\\cite{%l}")
23886 org--rds bib)
23887 (save-excursion
23888 (save-restriction
23889 (widen)
23890 (let ((case-fold-search t)
23891 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23892 (if (not (save-excursion
23893 (or (re-search-forward re nil t)
23894 (re-search-backward re nil t))))
23895 (user-error "No bibliography defined in file")
23896 (setq bib (concat (match-string 1) ".bib")
23897 org--rds (list (list 'bib bib)))))))
23898 (call-interactively 'reftex-citation)))
23900 ;;;; Functions extending outline functionality
23902 (defun org-beginning-of-line (&optional arg)
23903 "Go to the beginning of the current line. If that is invisible, continue
23904 to a visible line beginning. This makes the function of C-a more intuitive.
23905 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23906 first attempt, and only move to after the tags when the cursor is already
23907 beyond the end of the headline."
23908 (interactive "P")
23909 (let ((pos (point))
23910 (special (if (consp org-special-ctrl-a/e)
23911 (car org-special-ctrl-a/e)
23912 org-special-ctrl-a/e))
23913 deactivate-mark refpos)
23914 (if (org-bound-and-true-p visual-line-mode)
23915 (beginning-of-visual-line 1)
23916 (beginning-of-line 1))
23917 (if (and arg (fboundp 'move-beginning-of-line))
23918 (call-interactively 'move-beginning-of-line)
23919 (if (bobp)
23921 (backward-char 1)
23922 (if (org-truely-invisible-p)
23923 (while (and (not (bobp)) (org-truely-invisible-p))
23924 (backward-char 1)
23925 (beginning-of-line 1))
23926 (forward-char 1))))
23927 (when special
23928 (cond
23929 ((and (looking-at org-complex-heading-regexp)
23930 (eq (char-after (match-end 1)) ?\s))
23931 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23932 (point-at-eol)))
23933 (goto-char
23934 (if (eq special t)
23935 (cond ((> pos refpos) refpos)
23936 ((= pos (point)) refpos)
23937 (t (point)))
23938 (cond ((> pos (point)) (point))
23939 ((not (eq last-command this-command)) (point))
23940 (t refpos)))))
23941 ((org-at-item-p)
23942 ;; Being at an item and not looking at an the item means point
23943 ;; was previously moved to beginning of a visual line, which
23944 ;; doesn't contain the item. Therefore, do nothing special,
23945 ;; just stay here.
23946 (when (looking-at org-list-full-item-re)
23947 ;; Set special position at first white space character after
23948 ;; bullet, and check-box, if any.
23949 (let ((after-bullet
23950 (let ((box (match-end 3)))
23951 (if (not box) (match-end 1)
23952 (let ((after (char-after box)))
23953 (if (and after (= after ? )) (1+ box) box))))))
23954 ;; Special case: Move point to special position when
23955 ;; currently after it or at beginning of line.
23956 (if (eq special t)
23957 (when (or (> pos after-bullet) (= (point) pos))
23958 (goto-char after-bullet))
23959 ;; Reversed case: Move point to special position when
23960 ;; point was already at beginning of line and command is
23961 ;; repeated.
23962 (when (and (= (point) pos) (eq last-command this-command))
23963 (goto-char after-bullet))))))))
23964 (org-no-warnings
23965 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23966 (setq disable-point-adjustment
23967 (or (not (invisible-p (point)))
23968 (not (invisible-p (max (point-min) (1- (point))))))))
23970 (defun org-end-of-line (&optional arg)
23971 "Go to the end of the line.
23972 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23973 tags on the first attempt, and only move to after the tags when
23974 the cursor is already beyond the end of the headline."
23975 (interactive "P")
23976 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23977 org-special-ctrl-a/e))
23978 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23979 'end-of-visual-line)
23980 ((fboundp 'move-end-of-line) 'move-end-of-line)
23981 (t 'end-of-line)))
23982 deactivate-mark)
23983 (if (or (not special) arg) (call-interactively move-fun)
23984 (let* ((element (save-excursion (beginning-of-line)
23985 (org-element-at-point)))
23986 (type (org-element-type element)))
23987 (cond
23988 ((memq type '(headline inlinetask))
23989 (let ((pos (point)))
23990 (beginning-of-line 1)
23991 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23992 (if (eq special t)
23993 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23994 (goto-char (match-beginning 1))
23995 (goto-char (match-end 0)))
23996 (if (or (< pos (match-end 0))
23997 (not (eq this-command last-command)))
23998 (goto-char (match-end 0))
23999 (goto-char (match-beginning 1))))
24000 (call-interactively move-fun))))
24001 ((outline-invisible-p (line-end-position))
24002 ;; If element is hidden, `move-end-of-line' would put point
24003 ;; after it. Use `end-of-line' to stay on current line.
24004 (call-interactively 'end-of-line))
24005 (t (call-interactively move-fun)))))
24006 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
24007 (setq disable-point-adjustment
24008 (or (not (invisible-p (point)))
24009 (not (invisible-p (max (point-min) (1- (point))))))))
24011 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
24012 (define-key org-mode-map "\C-e" 'org-end-of-line)
24014 (defun org-backward-sentence (&optional _arg)
24015 "Go to beginning of sentence, or beginning of table field.
24016 This will call `backward-sentence' or `org-table-beginning-of-field',
24017 depending on context."
24018 (interactive)
24019 (let* ((element (org-element-at-point))
24020 (contents-begin (org-element-property :contents-begin element))
24021 (table (org-element-lineage element '(table) t)))
24022 (if (and table
24023 (> (point) contents-begin)
24024 (<= (point) (org-element-property :contents-end table)))
24025 (call-interactively #'org-table-beginning-of-field)
24026 (save-restriction
24027 (when (and contents-begin
24028 (< (point-min) contents-begin)
24029 (> (point) contents-begin))
24030 (narrow-to-region contents-begin
24031 (org-element-property :contents-end element)))
24032 (call-interactively #'backward-sentence)))))
24034 (defun org-forward-sentence (&optional _arg)
24035 "Go to end of sentence, or end of table field.
24036 This will call `forward-sentence' or `org-table-end-of-field',
24037 depending on context."
24038 (interactive)
24039 (let* ((element (org-element-at-point))
24040 (contents-end (org-element-property :contents-end element))
24041 (table (org-element-lineage element '(table) t)))
24042 (if (and table
24043 (>= (point) (org-element-property :contents-begin table))
24044 (< (point) contents-end))
24045 (call-interactively #'org-table-end-of-field)
24046 (save-restriction
24047 (when (and contents-end
24048 (> (point-max) contents-end)
24049 ;; Skip blank lines between elements.
24050 (< (org-element-property :end element)
24051 (save-excursion (goto-char contents-end)
24052 (skip-chars-forward " \r\t\n"))))
24053 (narrow-to-region (org-element-property :contents-begin element)
24054 contents-end))
24055 (call-interactively #'forward-sentence)))))
24057 (define-key org-mode-map "\M-a" 'org-backward-sentence)
24058 (define-key org-mode-map "\M-e" 'org-forward-sentence)
24060 (defun org-kill-line (&optional _arg)
24061 "Kill line, to tags or end of line."
24062 (interactive)
24063 (cond
24064 ((or (not org-special-ctrl-k)
24065 (bolp)
24066 (not (org-at-heading-p)))
24067 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
24068 org-ctrl-k-protect-subtree)
24069 (if (or (eq org-ctrl-k-protect-subtree 'error)
24070 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
24071 (user-error "C-k aborted as it would kill a hidden subtree")))
24072 (call-interactively
24073 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24074 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24075 (kill-region (point) (match-beginning 1))
24076 (org-set-tags nil t))
24077 (t (kill-region (point) (point-at-eol)))))
24079 (define-key org-mode-map "\C-k" 'org-kill-line)
24081 (defun org-yank (&optional arg)
24082 "Yank. If the kill is a subtree, treat it specially.
24083 This command will look at the current kill and check if is a single
24084 subtree, or a series of subtrees[1]. If it passes the test, and if the
24085 cursor is at the beginning of a line or after the stars of a currently
24086 empty headline, then the yank is handled specially. How exactly depends
24087 on the value of the following variables, both set by default.
24089 `org-yank-folded-subtrees'
24090 When set, the subtree(s) will be folded after insertion, but only
24091 if doing so would now swallow text after the yanked text.
24093 `org-yank-adjusted-subtrees'
24094 When set, the subtree will be promoted or demoted in order to
24095 fit into the local outline tree structure, which means that the
24096 level will be adjusted so that it becomes the smaller one of the
24097 two *visible* surrounding headings.
24099 Any prefix to this command will cause `yank' to be called directly with
24100 no special treatment. In particular, a simple \\[universal-argument] prefix \
24101 will just
24102 plainly yank the text as it is.
24104 \[1] The test checks if the first non-white line is a heading
24105 and if there are no other headings with fewer stars."
24106 (interactive "P")
24107 (org-yank-generic 'yank arg))
24109 (defun org-yank-generic (command arg)
24110 "Perform some yank-like command.
24112 This function implements the behavior described in the `org-yank'
24113 documentation. However, it has been generalized to work for any
24114 interactive command with similar behavior."
24116 ;; pretend to be command COMMAND
24117 (setq this-command command)
24119 (if arg
24120 (call-interactively command)
24122 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24123 (and (org-kill-is-subtree-p)
24124 (or (bolp)
24125 (and (looking-at "[ \t]*$")
24126 (string-match
24127 "\\`\\*+\\'"
24128 (buffer-substring (point-at-bol) (point)))))))
24129 swallowp)
24130 (cond
24131 ((and subtreep org-yank-folded-subtrees)
24132 (let ((beg (point))
24133 end)
24134 (if (and subtreep org-yank-adjusted-subtrees)
24135 (org-paste-subtree nil nil 'for-yank)
24136 (call-interactively command))
24138 (setq end (point))
24139 (goto-char beg)
24140 (when (and (bolp) subtreep
24141 (not (setq swallowp
24142 (org-yank-folding-would-swallow-text beg end))))
24143 (org-with-limited-levels
24144 (or (looking-at org-outline-regexp)
24145 (re-search-forward org-outline-regexp-bol end t))
24146 (while (and (< (point) end) (looking-at org-outline-regexp))
24147 (outline-hide-subtree)
24148 (org-cycle-show-empty-lines 'folded)
24149 (condition-case nil
24150 (outline-forward-same-level 1)
24151 (error (goto-char end))))))
24152 (when swallowp
24153 (message
24154 "Inserted text not folded because that would swallow text"))
24156 (goto-char end)
24157 (skip-chars-forward " \t\n\r")
24158 (beginning-of-line 1)
24159 (push-mark beg 'nomsg)))
24160 ((and subtreep org-yank-adjusted-subtrees)
24161 (let ((beg (point-at-bol)))
24162 (org-paste-subtree nil nil 'for-yank)
24163 (push-mark beg 'nomsg)))
24165 (call-interactively command))))))
24167 (defun org-yank-folding-would-swallow-text (beg end)
24168 "Would hide-subtree at BEG swallow any text after END?"
24169 (let (level)
24170 (org-with-limited-levels
24171 (save-excursion
24172 (goto-char beg)
24173 (when (or (looking-at org-outline-regexp)
24174 (re-search-forward org-outline-regexp-bol end t))
24175 (setq level (org-outline-level)))
24176 (goto-char end)
24177 (skip-chars-forward " \t\r\n\v\f")
24178 (if (or (eobp)
24179 (and (bolp) (looking-at org-outline-regexp)
24180 (<= (org-outline-level) level)))
24181 nil ; Nothing would be swallowed
24182 t))))) ; something would swallow
24184 (define-key org-mode-map "\C-y" 'org-yank)
24186 (defun org-truely-invisible-p ()
24187 "Check if point is at a character currently not visible.
24188 This version does not only check the character property, but also
24189 `visible-mode'."
24190 ;; Early versions of noutline don't have `outline-invisible-p'.
24191 (if (org-bound-and-true-p visible-mode)
24193 (outline-invisible-p)))
24195 (defun org-invisible-p2 ()
24196 "Check if point is at a character currently not visible."
24197 (save-excursion
24198 (if (and (eolp) (not (bobp))) (backward-char 1))
24199 ;; Early versions of noutline don't have `outline-invisible-p'.
24200 (outline-invisible-p)))
24202 (defun org-back-to-heading (&optional invisible-ok)
24203 "Call `outline-back-to-heading', but provide a better error message."
24204 (condition-case nil
24205 (outline-back-to-heading invisible-ok)
24206 (error (error "Before first headline at position %d in buffer %s"
24207 (point) (current-buffer)))))
24209 (defun org-before-first-heading-p ()
24210 "Before first heading?"
24211 (save-excursion
24212 (end-of-line)
24213 (null (re-search-backward org-outline-regexp-bol nil t))))
24215 (defun org-at-heading-p (&optional ignored)
24216 (outline-on-heading-p t))
24217 ;; Compatibility alias with Org versions < 7.8.03
24218 (defalias 'org-on-heading-p 'org-at-heading-p)
24220 (defun org-in-commented-heading-p (&optional no-inheritance)
24221 "Non-nil if point is under a commented heading.
24222 This function also checks ancestors of the current headline,
24223 unless optional argument NO-INHERITANCE is non-nil."
24224 (cond
24225 ((org-before-first-heading-p) nil)
24226 ((let ((headline (nth 4 (org-heading-components))))
24227 (and headline
24228 (let ((case-fold-search nil))
24229 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24230 headline)))))
24231 (no-inheritance nil)
24233 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24235 (defun org-at-comment-p nil
24236 "Is cursor in a commented line?"
24237 (save-excursion
24238 (save-match-data
24239 (beginning-of-line)
24240 (looking-at "^[ \t]*# "))))
24242 (defun org-at-drawer-p nil
24243 "Is cursor at a drawer keyword?"
24244 (save-excursion
24245 (move-beginning-of-line 1)
24246 (looking-at org-drawer-regexp)))
24248 (defun org-at-block-p nil
24249 "Is cursor at a block keyword?"
24250 (save-excursion
24251 (move-beginning-of-line 1)
24252 (looking-at org-block-regexp)))
24254 (defun org-point-at-end-of-empty-headline ()
24255 "If point is at the end of an empty headline, return t, else nil.
24256 If the heading only contains a TODO keyword, it is still still considered
24257 empty."
24258 (and (looking-at "[ \t]*$")
24259 (when org-todo-line-regexp
24260 (save-excursion
24261 (beginning-of-line 1)
24262 (let ((case-fold-search nil))
24263 (looking-at org-todo-line-regexp)
24264 (string= (match-string 3) ""))))))
24266 (defun org-at-heading-or-item-p ()
24267 (or (org-at-heading-p) (org-at-item-p)))
24269 (defun org-at-target-p ()
24270 (or (org-in-regexp org-radio-target-regexp)
24271 (org-in-regexp org-target-regexp)))
24272 ;; Compatibility alias with Org versions < 7.8.03
24273 (defalias 'org-on-target-p 'org-at-target-p)
24275 (defun org-up-heading-all (arg)
24276 "Move to the heading line of which the present line is a subheading.
24277 This function considers both visible and invisible heading lines.
24278 With argument, move up ARG levels."
24279 (if (fboundp 'outline-up-heading-all)
24280 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24281 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24283 (defun org-up-heading-safe ()
24284 "Move to the heading line of which the present line is a subheading.
24285 This version will not throw an error. It will return the level of the
24286 headline found, or nil if no higher level is found.
24288 Also, this function will be a lot faster than `outline-up-heading',
24289 because it relies on stars being the outline starters. This can really
24290 make a significant difference in outlines with very many siblings."
24291 (when (ignore-errors (org-back-to-heading t))
24292 (let ((level-up (1- (funcall outline-level))))
24293 (and (> level-up 0)
24294 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24295 (funcall outline-level)))))
24297 (defun org-first-sibling-p ()
24298 "Is this heading the first child of its parents?"
24299 (interactive)
24300 (let ((re org-outline-regexp-bol)
24301 level l)
24302 (unless (org-at-heading-p t)
24303 (user-error "Not at a heading"))
24304 (setq level (funcall outline-level))
24305 (save-excursion
24306 (if (not (re-search-backward re nil t))
24308 (setq l (funcall outline-level))
24309 (< l level)))))
24311 (defun org-goto-sibling (&optional previous)
24312 "Goto the next sibling, even if it is invisible.
24313 When PREVIOUS is set, go to the previous sibling instead. Returns t
24314 when a sibling was found. When none is found, return nil and don't
24315 move point."
24316 (let ((fun (if previous 're-search-backward 're-search-forward))
24317 (pos (point))
24318 (re org-outline-regexp-bol)
24319 level l)
24320 (when (ignore-errors (org-back-to-heading t))
24321 (setq level (funcall outline-level))
24322 (catch 'exit
24323 (or previous (forward-char 1))
24324 (while (funcall fun re nil t)
24325 (setq l (funcall outline-level))
24326 (when (< l level) (goto-char pos) (throw 'exit nil))
24327 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24328 (goto-char pos)
24329 nil))))
24331 (defun org-show-siblings ()
24332 "Show all siblings of the current headline."
24333 (save-excursion
24334 (while (org-goto-sibling) (org-flag-heading nil)))
24335 (save-excursion
24336 (while (org-goto-sibling 'previous)
24337 (org-flag-heading nil))))
24339 (defun org-goto-first-child ()
24340 "Goto the first child, even if it is invisible.
24341 Return t when a child was found. Otherwise don't move point and
24342 return nil."
24343 (let (level (pos (point)) (re org-outline-regexp-bol))
24344 (when (ignore-errors (org-back-to-heading t))
24345 (setq level (outline-level))
24346 (forward-char 1)
24347 (if (and (re-search-forward re nil t) (> (outline-level) level))
24348 (progn (goto-char (match-beginning 0)) t)
24349 (goto-char pos) nil))))
24351 (defun org-show-hidden-entry ()
24352 "Show an entry where even the heading is hidden."
24353 (save-excursion
24354 (org-show-entry)))
24356 (defun org-flag-heading (flag &optional entry)
24357 "Flag the current heading. FLAG non-nil means make invisible.
24358 When ENTRY is non-nil, show the entire entry."
24359 (save-excursion
24360 (org-back-to-heading t)
24361 ;; Check if we should show the entire entry
24362 (if entry
24363 (progn
24364 (org-show-entry)
24365 (save-excursion
24366 (and (outline-next-heading)
24367 (org-flag-heading nil))))
24368 (outline-flag-region (max (point-min) (1- (point)))
24369 (save-excursion (outline-end-of-heading) (point))
24370 flag))))
24372 (defun org-get-next-sibling ()
24373 "Move to next heading of the same level, and return point.
24374 If there is no such heading, return nil.
24375 This is like outline-next-sibling, but invisible headings are ok."
24376 (let ((level (funcall outline-level)))
24377 (outline-next-heading)
24378 (while (and (not (eobp)) (> (funcall outline-level) level))
24379 (outline-next-heading))
24380 (if (or (eobp) (< (funcall outline-level) level))
24382 (point))))
24384 (defun org-get-last-sibling ()
24385 "Move to previous heading of the same level, and return point.
24386 If there is no such heading, return nil."
24387 (let ((opoint (point))
24388 (level (funcall outline-level)))
24389 (outline-previous-heading)
24390 (when (and (/= (point) opoint) (outline-on-heading-p t))
24391 (while (and (> (funcall outline-level) level)
24392 (not (bobp)))
24393 (outline-previous-heading))
24394 (if (< (funcall outline-level) level)
24396 (point)))))
24398 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24399 "Goto to the end of a subtree."
24400 ;; This contains an exact copy of the original function, but it uses
24401 ;; `org-back-to-heading', to make it work also in invisible
24402 ;; trees. And is uses an invisible-ok argument.
24403 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24404 ;; Furthermore, when used inside Org, finding the end of a large subtree
24405 ;; with many children and grandchildren etc, this can be much faster
24406 ;; than the outline version.
24407 (org-back-to-heading invisible-ok)
24408 (let ((first t)
24409 (level (funcall outline-level)))
24410 (if (and (derived-mode-p 'org-mode) (< level 1000))
24411 ;; A true heading (not a plain list item), in Org-mode
24412 ;; This means we can easily find the end by looking
24413 ;; only for the right number of stars. Using a regexp to do
24414 ;; this is so much faster than using a Lisp loop.
24415 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24416 (forward-char 1)
24417 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24418 ;; something else, do it the slow way
24419 (while (and (not (eobp))
24420 (or first (> (funcall outline-level) level)))
24421 (setq first nil)
24422 (outline-next-heading)))
24423 (unless to-heading
24424 (if (memq (preceding-char) '(?\n ?\^M))
24425 (progn
24426 ;; Go to end of line before heading
24427 (forward-char -1)
24428 (if (memq (preceding-char) '(?\n ?\^M))
24429 ;; leave blank line before heading
24430 (forward-char -1))))))
24431 (point))
24433 (defun org-end-of-meta-data (&optional full)
24434 "Skip planning line and properties drawer in current entry.
24435 When optional argument FULL is non-nil, also skip empty lines,
24436 clocking lines and regular drawers at the beginning of the
24437 entry."
24438 (org-back-to-heading t)
24439 (forward-line)
24440 (when (org-looking-at-p org-planning-line-re) (forward-line))
24441 (when (looking-at org-property-drawer-re)
24442 (goto-char (match-end 0))
24443 (forward-line))
24444 (when (and full (not (org-at-heading-p)))
24445 (catch 'exit
24446 (let ((end (save-excursion (outline-next-heading) (point)))
24447 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24448 (while (not (eobp))
24449 (cond ((org-looking-at-p org-drawer-regexp)
24450 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24451 (forward-line)
24452 (throw 'exit t)))
24453 ((org-looking-at-p re) (forward-line))
24454 (t (throw 'exit t))))))))
24456 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24457 "Move forward to the ARG'th subheading at same level as this one.
24458 Stop at the first and last subheadings of a superior heading.
24459 Normally this only looks at visible headings, but when INVISIBLE-OK is
24460 non-nil it will also look at invisible ones."
24461 (interactive "p")
24462 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24463 (if (and arg (< arg 0))
24464 (goto-char (point-min))
24465 (outline-next-heading))
24466 (org-at-heading-p)
24467 (let ((level (- (match-end 0) (match-beginning 0) 1))
24468 (f (if (and arg (< arg 0))
24469 're-search-backward
24470 're-search-forward))
24471 (count (if arg (abs arg) 1))
24472 (result (point)))
24473 (while (and (prog1 (> count 0)
24474 (forward-char (if (and arg (< arg 0)) -1 1)))
24475 (funcall f org-outline-regexp-bol nil 'move))
24476 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24477 (cond ((< l level) (setq count 0))
24478 ((and (= l level)
24479 (or invisible-ok
24480 (progn
24481 (goto-char (line-beginning-position))
24482 (not (outline-invisible-p)))))
24483 (setq count (1- count))
24484 (when (eq l level)
24485 (setq result (point)))))))
24486 (goto-char result))
24487 (beginning-of-line 1)))
24489 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24490 "Move backward to the ARG'th subheading at same level as this one.
24491 Stop at the first and last subheadings of a superior heading."
24492 (interactive "p")
24493 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24495 (defun org-next-visible-heading (arg)
24496 "Move to the next visible heading.
24498 This function wraps `outline-next-visible-heading' with
24499 `org-with-limited-levels' in order to skip over inline tasks and
24500 respect customization of `org-odd-levels-only'."
24501 (interactive "p")
24502 (org-with-limited-levels
24503 (outline-next-visible-heading arg)))
24505 (defun org-previous-visible-heading (arg)
24506 "Move to the next visible heading.
24508 This function wraps `outline-previous-visible-heading' with
24509 `org-with-limited-levels' in order to skip over inline tasks and
24510 respect customization of `org-odd-levels-only'."
24511 (interactive "p")
24512 (org-with-limited-levels
24513 (outline-previous-visible-heading arg)))
24515 (defun org-next-block (arg &optional backward block-regexp)
24516 "Jump to the next block.
24518 With a prefix argument ARG, jump forward ARG many blocks.
24520 When BACKWARD is non-nil, jump to the previous block.
24522 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24523 Match data is set according to this regexp when the function
24524 returns.
24526 Return point at beginning of the opening line of found block.
24527 Throw an error if no block is found."
24528 (interactive "p")
24529 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24530 (case-fold-search t)
24531 (search-fn (if backward #'re-search-backward #'re-search-forward))
24532 (count (or arg 1))
24533 (origin (point))
24534 last-element)
24535 (if backward (beginning-of-line) (end-of-line))
24536 (while (and (> count 0) (funcall search-fn re nil t))
24537 (let ((element (save-excursion
24538 (goto-char (match-beginning 0))
24539 (save-match-data (org-element-at-point)))))
24540 (when (and (memq (org-element-type element)
24541 '(center-block comment-block dynamic-block
24542 example-block export-block quote-block
24543 special-block src-block verse-block))
24544 (<= (match-beginning 0)
24545 (org-element-property :post-affiliated element)))
24546 (setq last-element element)
24547 (decf count))))
24548 (if (= count 0)
24549 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24550 (save-match-data (org-show-context)))
24551 (goto-char origin)
24552 (user-error "No %s code blocks" (if backward "previous" "further")))))
24554 (defun org-previous-block (arg &optional block-regexp)
24555 "Jump to the previous block.
24556 With a prefix argument ARG, jump backward ARG many source blocks.
24557 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24558 (interactive "p")
24559 (org-next-block arg t block-regexp))
24561 (defun org-forward-paragraph ()
24562 "Move forward to beginning of next paragraph or equivalent.
24564 The function moves point to the beginning of the next visible
24565 structural element, which can be a paragraph, a table, a list
24566 item, etc. It also provides some special moves for convenience:
24568 - On an affiliated keyword, jump to the beginning of the
24569 relative element.
24570 - On an item or a footnote definition, move to the second
24571 element inside, if any.
24572 - On a table or a property drawer, jump after it.
24573 - On a verse or source block, stop after blank lines."
24574 (interactive)
24575 (when (eobp) (user-error "Cannot move further down"))
24576 (let* ((deactivate-mark nil)
24577 (element (org-element-at-point))
24578 (type (org-element-type element))
24579 (post-affiliated (org-element-property :post-affiliated element))
24580 (contents-begin (org-element-property :contents-begin element))
24581 (contents-end (org-element-property :contents-end element))
24582 (end (let ((end (org-element-property :end element)) (parent element))
24583 (while (and (setq parent (org-element-property :parent parent))
24584 (= (org-element-property :contents-end parent) end))
24585 (setq end (org-element-property :end parent)))
24586 end)))
24587 (cond ((not element)
24588 (skip-chars-forward " \r\t\n")
24589 (or (eobp) (beginning-of-line)))
24590 ;; On affiliated keywords, move to element's beginning.
24591 ((< (point) post-affiliated)
24592 (goto-char post-affiliated))
24593 ;; At a table row, move to the end of the table. Similarly,
24594 ;; at a node property, move to the end of the property
24595 ;; drawer.
24596 ((memq type '(node-property table-row))
24597 (goto-char (org-element-property
24598 :end (org-element-property :parent element))))
24599 ((memq type '(property-drawer table)) (goto-char end))
24600 ;; Consider blank lines as separators in verse and source
24601 ;; blocks to ease editing.
24602 ((memq type '(src-block verse-block))
24603 (when (eq type 'src-block)
24604 (setq contents-end
24605 (save-excursion (goto-char end)
24606 (skip-chars-backward " \r\t\n")
24607 (line-beginning-position))))
24608 (beginning-of-line)
24609 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24610 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24611 (goto-char end)
24612 (skip-chars-forward " \r\t\n")
24613 (if (= (point) contents-end) (goto-char end)
24614 (beginning-of-line))))
24615 ;; With no contents, just skip element.
24616 ((not contents-begin) (goto-char end))
24617 ;; If contents are invisible, skip the element altogether.
24618 ((outline-invisible-p (line-end-position))
24619 (case type
24620 (headline
24621 (org-with-limited-levels (outline-next-visible-heading 1)))
24622 ;; At a plain list, make sure we move to the next item
24623 ;; instead of skipping the whole list.
24624 (plain-list (forward-char)
24625 (org-forward-paragraph))
24626 (otherwise (goto-char end))))
24627 ((>= (point) contents-end) (goto-char end))
24628 ((>= (point) contents-begin)
24629 ;; This can only happen on paragraphs and plain lists.
24630 (case type
24631 (paragraph (goto-char end))
24632 ;; At a plain list, try to move to second element in
24633 ;; first item, if possible.
24634 (plain-list (end-of-line)
24635 (org-forward-paragraph))))
24636 ;; When contents start on the middle of a line (e.g. in
24637 ;; items and footnote definitions), try to reach first
24638 ;; element starting after current line.
24639 ((> (line-end-position) contents-begin)
24640 (end-of-line)
24641 (org-forward-paragraph))
24642 (t (goto-char contents-begin)))))
24644 (defun org-backward-paragraph ()
24645 "Move backward to start of previous paragraph or equivalent.
24647 The function moves point to the beginning of the current
24648 structural element, which can be a paragraph, a table, a list
24649 item, etc., or to the beginning of the previous visible one if
24650 point is already there. It also provides some special moves for
24651 convenience:
24653 - On an affiliated keyword, jump to the first one.
24654 - On a table or a property drawer, move to its beginning.
24655 - On a verse or source block, stop before blank lines."
24656 (interactive)
24657 (when (bobp) (user-error "Cannot move further up"))
24658 (let* ((deactivate-mark nil)
24659 (element (org-element-at-point))
24660 (type (org-element-type element))
24661 (contents-begin (org-element-property :contents-begin element))
24662 (contents-end (org-element-property :contents-end element))
24663 (post-affiliated (org-element-property :post-affiliated element))
24664 (begin (org-element-property :begin element)))
24665 (cond
24666 ((not element) (goto-char (point-min)))
24667 ((= (point) begin)
24668 (backward-char)
24669 (org-backward-paragraph))
24670 ((<= (point) post-affiliated) (goto-char begin))
24671 ((memq type '(node-property table-row))
24672 (goto-char (org-element-property
24673 :post-affiliated (org-element-property :parent element))))
24674 ((memq type '(property-drawer table)) (goto-char begin))
24675 ((memq type '(src-block verse-block))
24676 (when (eq type 'src-block)
24677 (setq contents-begin
24678 (save-excursion (goto-char begin) (forward-line) (point))))
24679 (if (= (point) contents-begin) (goto-char post-affiliated)
24680 ;; Inside a verse block, see blank lines as paragraph
24681 ;; separators.
24682 (let ((origin (point)))
24683 (skip-chars-backward " \r\t\n" contents-begin)
24684 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24685 (skip-chars-forward " \r\t\n" origin)
24686 (if (= (point) origin) (goto-char contents-begin)
24687 (beginning-of-line))))))
24688 ((not contents-begin) (goto-char (or post-affiliated begin)))
24689 ((eq type 'paragraph)
24690 (goto-char contents-begin)
24691 ;; When at first paragraph in an item or a footnote definition,
24692 ;; move directly to beginning of line.
24693 (let ((parent-contents
24694 (org-element-property
24695 :contents-begin (org-element-property :parent element))))
24696 (when (and parent-contents (= parent-contents contents-begin))
24697 (beginning-of-line))))
24698 ;; At the end of a greater element, move to the beginning of the
24699 ;; last element within.
24700 ((>= (point) contents-end)
24701 (goto-char (1- contents-end))
24702 (org-backward-paragraph))
24703 (t (goto-char (or post-affiliated begin))))
24704 ;; Ensure we never leave point invisible.
24705 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24707 (defun org-forward-element ()
24708 "Move forward by one element.
24709 Move to the next element at the same level, when possible."
24710 (interactive)
24711 (cond ((eobp) (user-error "Cannot move further down"))
24712 ((org-with-limited-levels (org-at-heading-p))
24713 (let ((origin (point)))
24714 (goto-char (org-end-of-subtree nil t))
24715 (unless (org-with-limited-levels (org-at-heading-p))
24716 (goto-char origin)
24717 (user-error "Cannot move further down"))))
24719 (let* ((elem (org-element-at-point))
24720 (end (org-element-property :end elem))
24721 (parent (org-element-property :parent elem)))
24722 (cond ((and parent (= (org-element-property :contents-end parent) end))
24723 (goto-char (org-element-property :end parent)))
24724 ((integer-or-marker-p end) (goto-char end))
24725 (t (message "No element at point")))))))
24727 (defun org-backward-element ()
24728 "Move backward by one element.
24729 Move to the previous element at the same level, when possible."
24730 (interactive)
24731 (cond ((bobp) (user-error "Cannot move further up"))
24732 ((org-with-limited-levels (org-at-heading-p))
24733 ;; At a headline, move to the previous one, if any, or stay
24734 ;; here.
24735 (let ((origin (point)))
24736 (org-with-limited-levels (org-backward-heading-same-level 1))
24737 ;; When current headline has no sibling above, move to its
24738 ;; parent.
24739 (when (= (point) origin)
24740 (or (org-with-limited-levels (org-up-heading-safe))
24741 (progn (goto-char origin)
24742 (user-error "Cannot move further up"))))))
24744 (let* ((elem (org-element-at-point))
24745 (beg (org-element-property :begin elem)))
24746 (cond
24747 ;; Move to beginning of current element if point isn't
24748 ;; there already.
24749 ((null beg) (message "No element at point"))
24750 ((/= (point) beg) (goto-char beg))
24751 (t (goto-char beg)
24752 (skip-chars-backward " \r\t\n")
24753 (unless (bobp)
24754 (let ((prev (org-element-at-point)))
24755 (goto-char (org-element-property :begin prev))
24756 (while (and (setq prev (org-element-property :parent prev))
24757 (<= (org-element-property :end prev) beg))
24758 (goto-char (org-element-property :begin prev)))))))))))
24760 (defun org-up-element ()
24761 "Move to upper element."
24762 (interactive)
24763 (if (org-with-limited-levels (org-at-heading-p))
24764 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24765 (let* ((elem (org-element-at-point))
24766 (parent (org-element-property :parent elem)))
24767 (if parent (goto-char (org-element-property :begin parent))
24768 (if (org-with-limited-levels (org-before-first-heading-p))
24769 (user-error "No surrounding element")
24770 (org-with-limited-levels (org-back-to-heading)))))))
24772 (defvar org-element-greater-elements)
24773 (defun org-down-element ()
24774 "Move to inner element."
24775 (interactive)
24776 (let ((element (org-element-at-point)))
24777 (cond
24778 ((memq (org-element-type element) '(plain-list table))
24779 (goto-char (org-element-property :contents-begin element))
24780 (forward-char))
24781 ((memq (org-element-type element) org-element-greater-elements)
24782 ;; If contents are hidden, first disclose them.
24783 (when (outline-invisible-p (line-end-position)) (org-cycle))
24784 (goto-char (or (org-element-property :contents-begin element)
24785 (user-error "No content for this element"))))
24786 (t (user-error "No inner element")))))
24788 (defun org-drag-element-backward ()
24789 "Move backward element at point."
24790 (interactive)
24791 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24792 (let* ((elem (org-element-at-point))
24793 (prev-elem
24794 (save-excursion
24795 (goto-char (org-element-property :begin elem))
24796 (skip-chars-backward " \r\t\n")
24797 (unless (bobp)
24798 (let* ((beg (org-element-property :begin elem))
24799 (prev (org-element-at-point))
24800 (up prev))
24801 (while (and (setq up (org-element-property :parent up))
24802 (<= (org-element-property :end up) beg))
24803 (setq prev up))
24804 prev)))))
24805 ;; Error out if no previous element or previous element is
24806 ;; a parent of the current one.
24807 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24808 (user-error "Cannot drag element backward")
24809 (let ((pos (point)))
24810 (org-element-swap-A-B prev-elem elem)
24811 (goto-char (+ (org-element-property :begin prev-elem)
24812 (- pos (org-element-property :begin elem)))))))))
24814 (defun org-drag-element-forward ()
24815 "Move forward element at point."
24816 (interactive)
24817 (let* ((pos (point))
24818 (elem (org-element-at-point)))
24819 (when (= (point-max) (org-element-property :end elem))
24820 (user-error "Cannot drag element forward"))
24821 (goto-char (org-element-property :end elem))
24822 (let ((next-elem (org-element-at-point)))
24823 (when (or (org-element-nested-p elem next-elem)
24824 (and (eq (org-element-type next-elem) 'headline)
24825 (not (eq (org-element-type elem) 'headline))))
24826 (goto-char pos)
24827 (user-error "Cannot drag element forward"))
24828 ;; Compute new position of point: it's shifted by NEXT-ELEM
24829 ;; body's length (without final blanks) and by the length of
24830 ;; blanks between ELEM and NEXT-ELEM.
24831 (let ((size-next (- (save-excursion
24832 (goto-char (org-element-property :end next-elem))
24833 (skip-chars-backward " \r\t\n")
24834 (forward-line)
24835 ;; Small correction if buffer doesn't end
24836 ;; with a newline character.
24837 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24838 (org-element-property :begin next-elem)))
24839 (size-blank (- (org-element-property :end elem)
24840 (save-excursion
24841 (goto-char (org-element-property :end elem))
24842 (skip-chars-backward " \r\t\n")
24843 (forward-line)
24844 (point)))))
24845 (org-element-swap-A-B elem next-elem)
24846 (goto-char (+ pos size-next size-blank))))))
24848 (defun org-drag-line-forward (arg)
24849 "Drag the line at point ARG lines forward."
24850 (interactive "p")
24851 (dotimes (n (abs arg))
24852 (let ((c (current-column)))
24853 (if (< 0 arg)
24854 (progn
24855 (beginning-of-line 2)
24856 (transpose-lines 1)
24857 (beginning-of-line 0))
24858 (transpose-lines 1)
24859 (beginning-of-line -1))
24860 (org-move-to-column c))))
24862 (defun org-drag-line-backward (arg)
24863 "Drag the line at point ARG lines backward."
24864 (interactive "p")
24865 (org-drag-line-forward (- arg)))
24867 (defun org-mark-element ()
24868 "Put point at beginning of this element, mark at end.
24870 Interactively, if this command is repeated or (in Transient Mark
24871 mode) if the mark is active, it marks the next element after the
24872 ones already marked."
24873 (interactive)
24874 (let (deactivate-mark)
24875 (if (and (org-called-interactively-p 'any)
24876 (or (and (eq last-command this-command) (mark t))
24877 (and transient-mark-mode mark-active)))
24878 (set-mark
24879 (save-excursion
24880 (goto-char (mark))
24881 (goto-char (org-element-property :end (org-element-at-point)))))
24882 (let ((element (org-element-at-point)))
24883 (end-of-line)
24884 (push-mark (org-element-property :end element) t t)
24885 (goto-char (org-element-property :begin element))))))
24887 (defun org-narrow-to-element ()
24888 "Narrow buffer to current element."
24889 (interactive)
24890 (let ((elem (org-element-at-point)))
24891 (cond
24892 ((eq (car elem) 'headline)
24893 (narrow-to-region
24894 (org-element-property :begin elem)
24895 (org-element-property :end elem)))
24896 ((memq (car elem) org-element-greater-elements)
24897 (narrow-to-region
24898 (org-element-property :contents-begin elem)
24899 (org-element-property :contents-end elem)))
24901 (narrow-to-region
24902 (org-element-property :begin elem)
24903 (org-element-property :end elem))))))
24905 (defun org-transpose-element ()
24906 "Transpose current and previous elements, keeping blank lines between.
24907 Point is moved after both elements."
24908 (interactive)
24909 (org-skip-whitespace)
24910 (let ((end (org-element-property :end (org-element-at-point))))
24911 (org-drag-element-backward)
24912 (goto-char end)))
24914 (defun org-unindent-buffer ()
24915 "Un-indent the visible part of the buffer.
24916 Relative indentation (between items, inside blocks, etc.) isn't
24917 modified."
24918 (interactive)
24919 (unless (eq major-mode 'org-mode)
24920 (user-error "Cannot un-indent a buffer not in Org mode"))
24921 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24922 unindent-tree ; For byte-compiler.
24923 (unindent-tree
24924 (function
24925 (lambda (contents)
24926 (mapc
24927 (lambda (element)
24928 (if (memq (org-element-type element) '(headline section))
24929 (funcall unindent-tree (org-element-contents element))
24930 (save-excursion
24931 (save-restriction
24932 (narrow-to-region
24933 (org-element-property :begin element)
24934 (org-element-property :end element))
24935 (org-do-remove-indentation)))))
24936 (reverse contents))))))
24937 (funcall unindent-tree (org-element-contents parse-tree))))
24939 (defun org-show-subtree ()
24940 "Show everything after this heading at deeper levels."
24941 (interactive)
24942 (outline-flag-region
24943 (point)
24944 (save-excursion
24945 (org-end-of-subtree t t))
24946 nil))
24948 (defun org-show-entry ()
24949 "Show the body directly following this heading.
24950 Show the heading too, if it is currently invisible."
24951 (interactive)
24952 (save-excursion
24953 (ignore-errors
24954 (org-back-to-heading t)
24955 (outline-flag-region
24956 (max (point-min) (1- (point)))
24957 (save-excursion
24958 (if (re-search-forward
24959 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24960 (match-beginning 1)
24961 (point-max)))
24962 nil)
24963 (org-cycle-hide-drawers 'children))))
24965 (defun org-make-options-regexp (kwds &optional extra)
24966 "Make a regular expression for keyword lines.
24967 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24968 when non-nil, is a regexp matching keywords names."
24969 (concat "^[ \t]*#\\+\\("
24970 (regexp-opt kwds)
24971 (and extra (concat (and kwds "\\|") extra))
24972 "\\):[ \t]*\\(.*\\)"))
24974 ;; Make isearch reveal the necessary context
24975 (defun org-isearch-end ()
24976 "Reveal context after isearch exits."
24977 (when isearch-success ; only if search was successful
24978 (if (featurep 'xemacs)
24979 ;; Under XEmacs, the hook is run in the correct place,
24980 ;; we directly show the context.
24981 (org-show-context 'isearch)
24982 ;; In Emacs the hook runs *before* restoring the overlays.
24983 ;; So we have to use a one-time post-command-hook to do this.
24984 ;; (Emacs 22 has a special variable, see function `org-mode')
24985 (unless (and (boundp 'isearch-mode-end-hook-quit)
24986 isearch-mode-end-hook-quit)
24987 ;; Only when the isearch was not quitted.
24988 (org-add-hook 'post-command-hook 'org-isearch-post-command
24989 'append 'local)))))
24991 (defun org-isearch-post-command ()
24992 "Remove self from hook, and show context."
24993 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24994 (org-show-context 'isearch))
24997 ;;;; Integration with and fixes for other packages
24999 ;;; Imenu support
25001 (defvar org-imenu-markers nil
25002 "All markers currently used by Imenu.")
25003 (make-variable-buffer-local 'org-imenu-markers)
25005 (defun org-imenu-new-marker (&optional pos)
25006 "Return a new marker for use by Imenu, and remember the marker."
25007 (let ((m (make-marker)))
25008 (move-marker m (or pos (point)))
25009 (push m org-imenu-markers)
25012 (defun org-imenu-get-tree ()
25013 "Produce the index for Imenu."
25014 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
25015 (setq org-imenu-markers nil)
25016 (let* ((n org-imenu-depth)
25017 (re (concat "^" (org-get-limited-outline-regexp)))
25018 (subs (make-vector (1+ n) nil))
25019 (last-level 0)
25020 m level head0 head)
25021 (save-excursion
25022 (save-restriction
25023 (widen)
25024 (goto-char (point-max))
25025 (while (re-search-backward re nil t)
25026 (setq level (org-reduced-level (funcall outline-level)))
25027 (when (and (<= level n)
25028 (looking-at org-complex-heading-regexp)
25029 (setq head0 (org-match-string-no-properties 4)))
25030 (setq head (org-link-display-format head0)
25031 m (org-imenu-new-marker))
25032 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
25033 (if (>= level last-level)
25034 (push (cons head m) (aref subs level))
25035 (push (cons head (aref subs (1+ level))) (aref subs level))
25036 (loop for i from (1+ level) to n do (aset subs i nil)))
25037 (setq last-level level)))))
25038 (aref subs 1)))
25040 (eval-after-load "imenu"
25041 '(progn
25042 (add-hook 'imenu-after-jump-hook
25043 (lambda ()
25044 (if (derived-mode-p 'org-mode)
25045 (org-show-context 'org-goto))))))
25047 (defun org-link-display-format (link)
25048 "Replace a link with its the description.
25049 If there is no description, use the link target."
25050 (save-match-data
25051 (if (string-match org-bracket-link-analytic-regexp link)
25052 (replace-match (if (match-end 5)
25053 (match-string 5 link)
25054 (concat (match-string 1 link)
25055 (match-string 3 link)))
25056 nil t link)
25057 link)))
25059 (defun org-toggle-link-display ()
25060 "Toggle the literal or descriptive display of links."
25061 (interactive)
25062 (if org-descriptive-links
25063 (progn (org-remove-from-invisibility-spec '(org-link))
25064 (org-restart-font-lock)
25065 (setq org-descriptive-links nil))
25066 (progn (add-to-invisibility-spec '(org-link))
25067 (org-restart-font-lock)
25068 (setq org-descriptive-links t))))
25070 ;; Speedbar support
25072 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25073 "Overlay marking the agenda restriction line in speedbar.")
25074 (overlay-put org-speedbar-restriction-lock-overlay
25075 'face 'org-agenda-restriction-lock)
25076 (overlay-put org-speedbar-restriction-lock-overlay
25077 'help-echo "Agendas are currently limited to this item.")
25078 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25080 (defun org-speedbar-set-agenda-restriction ()
25081 "Restrict future agenda commands to the location at point in speedbar.
25082 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25083 (interactive)
25084 (require 'org-agenda)
25085 (let (p m tp np dir txt)
25086 (cond
25087 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25088 'org-imenu t))
25089 (setq m (get-text-property p 'org-imenu-marker))
25090 (with-current-buffer (marker-buffer m)
25091 (goto-char m)
25092 (org-agenda-set-restriction-lock 'subtree)))
25093 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25094 'speedbar-function 'speedbar-find-file))
25095 (setq tp (previous-single-property-change
25096 (1+ p) 'speedbar-function)
25097 np (next-single-property-change
25098 tp 'speedbar-function)
25099 dir (speedbar-line-directory)
25100 txt (buffer-substring-no-properties (or tp (point-min))
25101 (or np (point-max))))
25102 (with-current-buffer (find-file-noselect
25103 (let ((default-directory dir))
25104 (expand-file-name txt)))
25105 (unless (derived-mode-p 'org-mode)
25106 (user-error "Cannot restrict to non-Org-mode file"))
25107 (org-agenda-set-restriction-lock 'file)))
25108 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25109 (move-overlay org-speedbar-restriction-lock-overlay
25110 (point-at-bol) (point-at-eol))
25111 (setq current-prefix-arg nil)
25112 (org-agenda-maybe-redo)))
25114 (defvar speedbar-file-key-map)
25115 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25116 (eval-after-load "speedbar"
25117 '(progn
25118 (speedbar-add-supported-extension ".org")
25119 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25120 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25121 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25122 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25123 (add-hook 'speedbar-visiting-tag-hook
25124 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25126 ;;; Fixes and Hacks for problems with other packages
25128 (defun org--flyspell-object-check-p (element)
25129 "Non-nil when Flyspell can check object at point.
25130 ELEMENT is the element at point."
25131 (let ((object (save-excursion
25132 (when (org-looking-at-p "\\>") (backward-char))
25133 (org-element-context element))))
25134 (case (org-element-type object)
25135 ;; Prevent checks in links due to keybinding conflict with
25136 ;; Flyspell.
25137 ((code entity export-snippet inline-babel-call
25138 inline-src-block line-break latex-fragment link macro
25139 statistics-cookie target timestamp verbatim)
25140 nil)
25141 (footnote-reference
25142 ;; Only in inline footnotes, within the definition.
25143 (and (eq (org-element-property :type object) 'inline)
25144 (< (save-excursion
25145 (goto-char (org-element-property :begin object))
25146 (search-forward ":" nil t 2))
25147 (point))))
25148 (otherwise t))))
25150 (defun org-mode-flyspell-verify ()
25151 "Function used for `flyspell-generic-check-word-predicate'."
25152 (if (org-at-heading-p)
25153 ;; At a headline or an inlinetask, check title only. This is
25154 ;; faster than relying on `org-element-at-point'.
25155 (and (save-excursion (beginning-of-line)
25156 (and (let ((case-fold-search t))
25157 (not (looking-at "\\*+ END[ \t]*$")))
25158 (looking-at org-complex-heading-regexp)))
25159 (match-beginning 4)
25160 (>= (point) (match-beginning 4))
25161 (or (not (match-beginning 5))
25162 (< (point) (match-beginning 5))))
25163 (let* ((element (org-element-at-point))
25164 (post-affiliated (org-element-property :post-affiliated element)))
25165 (cond
25166 ;; Ignore checks in all affiliated keywords but captions.
25167 ((< (point) post-affiliated)
25168 (and (save-excursion
25169 (beginning-of-line)
25170 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25171 (> (point) (match-end 0))
25172 (org--flyspell-object-check-p element)))
25173 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25174 ((let ((log (org-log-into-drawer)))
25175 (and log
25176 (let ((drawer (org-element-lineage element '(drawer))))
25177 (and drawer
25178 (eq (compare-strings
25179 log nil nil
25180 (org-element-property :drawer-name drawer) nil nil t)
25181 t)))))
25182 nil)
25184 (case (org-element-type element)
25185 ((comment quote-section) t)
25186 (comment-block
25187 ;; Allow checks between block markers, not on them.
25188 (and (> (line-beginning-position) post-affiliated)
25189 (save-excursion
25190 (end-of-line)
25191 (skip-chars-forward " \r\t\n")
25192 (< (point) (org-element-property :end element)))))
25193 ;; Arbitrary list of keywords where checks are meaningful.
25194 ;; Make sure point is on the value part of the element.
25195 (keyword
25196 (and (member (org-element-property :key element)
25197 '("DESCRIPTION" "TITLE"))
25198 (save-excursion
25199 (search-backward ":" (line-beginning-position) t))))
25200 ;; Check is globally allowed in paragraphs verse blocks and
25201 ;; table rows (after affiliated keywords) but some objects
25202 ;; must not be affected.
25203 ((paragraph table-row verse-block)
25204 (let ((cbeg (org-element-property :contents-begin element))
25205 (cend (org-element-property :contents-end element)))
25206 (and cbeg (>= (point) cbeg) (< (point) cend)
25207 (org--flyspell-object-check-p element))))))))))
25208 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25210 (defun org-remove-flyspell-overlays-in (beg end)
25211 "Remove flyspell overlays in region."
25212 (and (org-bound-and-true-p flyspell-mode)
25213 (fboundp 'flyspell-delete-region-overlays)
25214 (flyspell-delete-region-overlays beg end)))
25216 (defvar flyspell-delayed-commands)
25217 (eval-after-load "flyspell"
25218 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25220 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25221 (eval-after-load "bookmark"
25222 '(if (boundp 'bookmark-after-jump-hook)
25223 ;; We can use the hook
25224 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25225 ;; Hook not available, use advice
25226 (defadvice bookmark-jump (after org-make-visible activate)
25227 "Make the position visible."
25228 (org-bookmark-jump-unhide))))
25230 ;; Make sure saveplace shows the location if it was hidden
25231 (eval-after-load "saveplace"
25232 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25233 "Make the position visible."
25234 (org-bookmark-jump-unhide)))
25236 ;; Make sure ecb shows the location if it was hidden
25237 (eval-after-load "ecb"
25238 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25239 "Make hierarchy visible when jumping into location from ECB tree buffer."
25240 (if (derived-mode-p 'org-mode)
25241 (org-show-context))))
25243 (defun org-bookmark-jump-unhide ()
25244 "Unhide the current position, to show the bookmark location."
25245 (and (derived-mode-p 'org-mode)
25246 (or (outline-invisible-p)
25247 (save-excursion (goto-char (max (point-min) (1- (point))))
25248 (outline-invisible-p)))
25249 (org-show-context 'bookmark-jump)))
25251 (defun org-mark-jump-unhide ()
25252 "Make the point visible with `org-show-context' after jumping to the mark."
25253 (when (and (derived-mode-p 'org-mode)
25254 (outline-invisible-p))
25255 (org-show-context 'mark-goto)))
25257 (eval-after-load "simple"
25258 '(defadvice pop-to-mark-command (after org-make-visible activate)
25259 "Make the point visible with `org-show-context'."
25260 (org-mark-jump-unhide)))
25262 (eval-after-load "simple"
25263 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25264 "Make the point visible with `org-show-context'."
25265 (org-mark-jump-unhide)))
25267 (eval-after-load "simple"
25268 '(defadvice pop-global-mark (after org-make-visible activate)
25269 "Make the point visible with `org-show-context'."
25270 (org-mark-jump-unhide)))
25272 ;; Make session.el ignore our circular variable
25273 (defvar session-globals-exclude)
25274 (eval-after-load "session"
25275 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25277 ;;;; Finish up
25279 (provide 'org)
25281 (run-hooks 'org-load-hook)
25283 ;;; org.el ends here