Allow C-c C-c on blank lines within src blocks
[org-mode/org-tableheadings.git] / lisp / org.el
blob7f68dcbfe276ecfa6a43e21f850ad8b72844798b
1 ;;; org.el --- Outline-based notes management and organizer -*- lexical-binding: t; -*-
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2017 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 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
32 ;; contain information about projects as plain text. Org mode is
33 ;; implemented on top of outline-mode, which makes it possible to keep
34 ;; the content of large files well structured. Visibility cycling and
35 ;; structure editing help to work with the tree. Tables are easily
36 ;; created with a built-in table editor. Org mode supports ToDo
37 ;; items, deadlines, time stamps, and scheduling. It dynamically
38 ;; compiles entries into an agenda that utilizes and smoothly
39 ;; integrates much of the Emacs calendar and diary. Plain text
40 ;; URL-like links connect to websites, emails, Usenet messages, BBDB
41 ;; entries, and any files related to the projects. For printing and
42 ;; sharing of notes, an Org file can be exported as a structured ASCII
43 ;; file, as HTML, or (todo and agenda items only) as an iCalendar
44 ;; file. It can also serve as a publishing tool for a set of linked
45 ;; webpages.
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
51 ;; http://orgmode.org/org.html#Installation
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the doc/ directory.
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
64 ;;; Code:
66 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
67 (defvar-local org-table-formula-constants-local nil
68 "Local version of `org-table-formula-constants'.")
70 ;;;; Require other packages
72 (require 'cl-lib)
74 (eval-when-compile (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (or (eq 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 (declare-function calendar-check-holidays "holidays" (date))
114 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
115 (declare-function isearch-no-upper-case-p "isearch" (string regexp-flag))
116 (declare-function org-add-archive-files "org-archive" (files))
117 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
118 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span with-hour))
119 (declare-function org-agenda-redo "org-agenda" (&optional all))
120 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body) t)
121 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
122 (declare-function org-beamer-mode "ox-beamer" (&optional prefix) t)
123 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
124 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
125 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
126 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
127 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
128 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
129 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
130 (declare-function org-clock-update-time-maybe "org-clock" ())
131 (declare-function org-clocktable-shift "org-clock" (dir n))
132 (declare-function org-element-at-point "org-element" ())
133 (declare-function org-element-cache-refresh "org-element" (pos))
134 (declare-function org-element-cache-reset "org-element" (&optional all))
135 (declare-function org-element-contents "org-element" (element))
136 (declare-function org-element-context "org-element" (&optional element))
137 (declare-function org-element-copy "org-element" (datum))
138 (declare-function org-element-interpret-data "org-element" (data))
139 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
140 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
141 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
142 (declare-function org-element-property "org-element" (property element))
143 (declare-function org-element-put-property "org-element" (element property value))
144 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
145 (declare-function org-element-type "org-element" (element))
146 (declare-function org-element-update-syntax "org-element" ())
147 (declare-function org-id-find-id-file "org-id" (id))
148 (declare-function org-id-get-create "org-id" (&optional force))
149 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
150 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
151 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
152 (declare-function org-plot/gnuplot "org-plot" (&optional params))
153 (declare-function org-table-align "org-table" ())
154 (declare-function org-table-begin "org-table" (&optional table-type))
155 (declare-function org-table-beginning-of-field "org-table" (&optional n))
156 (declare-function org-table-blank-field "org-table" ())
157 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
158 (declare-function org-table-copy-region "org-table" (beg end &optional cut))
159 (declare-function org-table-cut-region "org-table" (beg end))
160 (declare-function org-table-edit-field "org-table" (arg))
161 (declare-function org-table-end "org-table" (&optional table-type))
162 (declare-function org-table-end-of-field "org-table" (&optional n))
163 (declare-function org-table-insert-row "org-table" (&optional arg))
164 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
165 (declare-function org-table-maybe-eval-formula "org-table" ())
166 (declare-function org-table-maybe-recalculate-line "org-table" ())
167 (declare-function org-table-next-row "org-table" ())
168 (declare-function org-table-paste-rectangle "org-table" ())
169 (declare-function org-table-recalculate "org-table" (&optional all noalign))
170 (declare-function org-table-wrap-region "org-table" (arg))
171 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
172 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
173 (declare-function orgtbl-mode "org-table" (&optional arg))
174 (declare-function org-export-get-backend "ox" (name))
175 (declare-function org-export-get-environment "ox" (&optional backend subtreep ext-plist))
176 (declare-function org-latex-make-preamble "ox-latex" (info &optional template))
178 (defsubst org-uniquify (list)
179 "Non-destructively remove duplicate elements from LIST."
180 (let ((res (copy-sequence list))) (delete-dups res)))
182 (defsubst org-get-at-bol (property)
183 "Get text property PROPERTY at the beginning of line."
184 (get-text-property (point-at-bol) property))
186 (defsubst org-trim (s &optional keep-lead)
187 "Remove whitespace at the beginning and the end of string S.
188 When optional argument KEEP-LEAD is non-nil, removing blank lines
189 at the beginning of the string does not affect leading indentation."
190 (replace-regexp-in-string
191 (if keep-lead "\\`\\([ \t]*\n\\)+" "\\`[ \t\n\r]+") ""
192 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
194 ;; load languages based on value of `org-babel-load-languages'
195 (defvar org-babel-load-languages)
197 ;;;###autoload
198 (defun org-babel-do-load-languages (sym value)
199 "Load the languages defined in `org-babel-load-languages'."
200 (set-default sym value)
201 (dolist (pair org-babel-load-languages)
202 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
203 (if active
204 (require (intern (concat "ob-" lang)))
205 (funcall 'fmakunbound
206 (intern (concat "org-babel-execute:" lang)))
207 (funcall 'fmakunbound
208 (intern (concat "org-babel-expand-body:" lang)))))))
210 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
211 ;;;###autoload
212 (defun org-babel-load-file (file &optional compile)
213 "Load Emacs Lisp source code blocks in the Org FILE.
214 This function exports the source code using `org-babel-tangle'
215 and then loads the resulting file using `load-file'. With prefix
216 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
217 file to byte-code before it is loaded."
218 (interactive "fFile to load: \nP")
219 (let* ((age (lambda (file)
220 (float-time
221 (time-subtract (current-time)
222 (nth 5 (or (file-attributes (file-truename file))
223 (file-attributes file)))))))
224 (base-name (file-name-sans-extension file))
225 (exported-file (concat base-name ".el")))
226 ;; tangle if the Org file is newer than the elisp file
227 (unless (and (file-exists-p exported-file)
228 (> (funcall age file) (funcall age exported-file)))
229 ;; Tangle-file traversal returns reversed list of tangled files
230 ;; and we want to evaluate the first target.
231 (setq exported-file
232 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
233 (message "%s %s"
234 (if compile
235 (progn (byte-compile-file exported-file 'load)
236 "Compiled and loaded")
237 (progn (load-file exported-file) "Loaded"))
238 exported-file)))
240 (defcustom org-babel-load-languages '((emacs-lisp . t))
241 "Languages which can be evaluated in Org buffers.
242 This list can be used to load support for any of the languages
243 below, note that each language will depend on a different set of
244 system executables and/or Emacs modes. When a language is
245 \"loaded\", then code blocks in that language can be evaluated
246 with `org-babel-execute-src-block' bound by default to C-c
247 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
248 be set to remove code block evaluation from the C-c C-c
249 keybinding. By default only Emacs Lisp (which has no
250 requirements) is loaded."
251 :group 'org-babel
252 :set 'org-babel-do-load-languages
253 :version "24.1"
254 :type '(alist :tag "Babel Languages"
255 :key-type
256 (choice
257 (const :tag "Awk" awk)
258 (const :tag "C" C)
259 (const :tag "R" R)
260 (const :tag "Asymptote" asymptote)
261 (const :tag "Calc" calc)
262 (const :tag "Clojure" clojure)
263 (const :tag "CSS" css)
264 (const :tag "Ditaa" ditaa)
265 (const :tag "Dot" dot)
266 (const :tag "Emacs Lisp" emacs-lisp)
267 (const :tag "Forth" forth)
268 (const :tag "Fortran" fortran)
269 (const :tag "Gnuplot" gnuplot)
270 (const :tag "Haskell" haskell)
271 (const :tag "IO" io)
272 (const :tag "J" J)
273 (const :tag "Java" java)
274 (const :tag "Javascript" js)
275 (const :tag "LaTeX" latex)
276 (const :tag "Ledger" ledger)
277 (const :tag "Lilypond" lilypond)
278 (const :tag "Lisp" lisp)
279 (const :tag "Makefile" makefile)
280 (const :tag "Maxima" maxima)
281 (const :tag "Matlab" matlab)
282 (const :tag "Mscgen" mscgen)
283 (const :tag "Ocaml" ocaml)
284 (const :tag "Octave" octave)
285 (const :tag "Org" org)
286 (const :tag "Perl" perl)
287 (const :tag "Pico Lisp" picolisp)
288 (const :tag "PlantUML" plantuml)
289 (const :tag "Python" python)
290 (const :tag "Ruby" ruby)
291 (const :tag "Sass" sass)
292 (const :tag "Scala" scala)
293 (const :tag "Scheme" scheme)
294 (const :tag "Screen" screen)
295 (const :tag "Shell Script" shell)
296 (const :tag "Shen" shen)
297 (const :tag "Sql" sql)
298 (const :tag "Sqlite" sqlite)
299 (const :tag "Stan" stan)
300 (const :tag "ebnf2ps" ebnf2ps))
301 :value-type (boolean :tag "Activate" :value t)))
303 ;;;; Customization variables
304 (defcustom org-clone-delete-id nil
305 "Remove ID property of clones of a subtree.
306 When non-nil, clones of a subtree don't inherit the ID property.
307 Otherwise they inherit the ID property with a new unique
308 identifier."
309 :type 'boolean
310 :version "24.1"
311 :group 'org-id)
313 ;;; Version
314 (org-check-version)
316 ;;;###autoload
317 (defun org-version (&optional here full message)
318 "Show the Org version.
319 Interactively, or when MESSAGE is non-nil, show it in echo area.
320 With prefix argument, or when HERE is non-nil, insert it at point.
321 In non-interactive uses, a reduced version string is output unless
322 FULL is given."
323 (interactive (list current-prefix-arg t (not current-prefix-arg)))
324 (let ((org-dir (ignore-errors (org-find-library-dir "org")))
325 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
326 (load-suffixes (list ".el"))
327 (org-install-dir
328 (ignore-errors (org-find-library-dir "org-loaddefs"))))
329 (unless (and (fboundp 'org-release) (fboundp 'org-git-version))
330 (org-load-noerror-mustsuffix (concat org-dir "org-version")))
331 (let* ((load-suffixes save-load-suffixes)
332 (release (org-release))
333 (git-version (org-git-version))
334 (version (format "Org mode version %s (%s @ %s)"
335 release
336 git-version
337 (if org-install-dir
338 (if (string= org-dir org-install-dir)
339 org-install-dir
340 (concat "mixed installation! "
341 org-install-dir
342 " and "
343 org-dir))
344 "org-loaddefs.el can not be found!")))
345 (version1 (if full version release)))
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 \\<org-mode-map>
379 A deadline is this string, followed by a time stamp. It must be
380 a word, terminated by a colon. You can insert a schedule keyword
381 and a timestamp with `\\[org-deadline]'.")
383 (defvar org-scheduled-string "SCHEDULED:"
384 "String to mark scheduled TODO entries.
385 \\<org-mode-map>
386 A schedule is this string, followed by a time stamp. It must be
387 a word, terminated by a colon. You can insert a schedule keyword
388 and a timestamp with `\\[org-schedule]'.")
390 (defconst org-ds-keyword-length
391 (+ 2
392 (apply #'max
393 (mapcar #'length
394 (list org-deadline-string org-scheduled-string
395 org-clock-string org-closed-string))))
396 "Maximum length of the DEADLINE and SCHEDULED keywords.")
398 (defconst org-planning-line-re
399 (concat "^[ \t]*"
400 (regexp-opt
401 (list org-closed-string org-deadline-string org-scheduled-string)
403 "Matches a line with planning info.
404 Matched keyword is in group 1.")
406 (defconst org-clock-line-re
407 (concat "^[ \t]*" org-clock-string)
408 "Matches a line with clock info.")
410 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
411 "Matches the DEADLINE keyword.")
413 (defconst org-deadline-time-regexp
414 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
415 "Matches the DEADLINE keyword together with a time stamp.")
417 (defconst org-deadline-time-hour-regexp
418 (concat "\\<" org-deadline-string
419 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
420 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
422 (defconst org-deadline-line-regexp
423 (concat "\\<\\(" org-deadline-string "\\).*")
424 "Matches the DEADLINE keyword and the rest of the line.")
426 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
427 "Matches the SCHEDULED keyword.")
429 (defconst org-scheduled-time-regexp
430 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
431 "Matches the SCHEDULED keyword together with a time stamp.")
433 (defconst org-scheduled-time-hour-regexp
434 (concat "\\<" org-scheduled-string
435 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
436 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
438 (defconst org-closed-time-regexp
439 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
440 "Matches the CLOSED keyword together with a time stamp.")
442 (defconst org-keyword-time-regexp
443 (concat "\\<"
444 (regexp-opt
445 (list org-scheduled-string org-deadline-string org-closed-string
446 org-clock-string)
448 " *[[<]\\([^]>]+\\)[]>]")
449 "Matches any of the 4 keywords, together with the time stamp.")
451 (defconst org-keyword-time-not-clock-regexp
452 (concat
453 "\\<"
454 (regexp-opt
455 (list org-scheduled-string org-deadline-string org-closed-string) t)
456 " *[[<]\\([^]>]+\\)[]>]")
457 "Matches any of the 3 keywords, together with the time stamp.")
459 (defconst org-maybe-keyword-time-regexp
460 (concat "\\(\\<"
461 (regexp-opt
462 (list org-scheduled-string org-deadline-string org-closed-string
463 org-clock-string)
465 "\\)?"
466 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
467 "\\|"
468 "<%%([^\r\n>]*>\\)")
469 "Matches a timestamp, possibly preceded by a keyword.")
471 (defconst org-all-time-keywords
472 (mapcar (lambda (w) (substring w 0 -1))
473 (list org-scheduled-string org-deadline-string
474 org-clock-string org-closed-string))
475 "List of time keywords.")
477 ;;;; Drawer
479 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
480 "Matches first or last line of a hidden block.
481 Group 1 contains drawer's name or \"END\".")
483 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
484 "Regular expression matching the first line of a property drawer.")
486 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
487 "Regular expression matching the last line of a property drawer.")
489 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
490 "Regular expression matching the first line of a clock drawer.")
492 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
493 "Regular expression matching the last line of a clock drawer.")
495 (defconst org-property-drawer-re
496 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
497 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*?"
498 "[ \t]*:END:[ \t]*$")
499 "Matches an entire property drawer.")
501 (defconst org-clock-drawer-re
502 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
503 org-clock-drawer-end-re "\\)\n?")
504 "Matches an entire clock drawer.")
506 ;;;; Headline
508 (defconst org-heading-keyword-regexp-format
509 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
510 "Printf format for a regexp matching a headline with some keyword.
511 This regexp will match the headline of any node which has the
512 exact keyword that is put into the format. The keyword isn't in
513 any group by default, but the stars and the body are.")
515 (defconst org-heading-keyword-maybe-regexp-format
516 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
517 "Printf format for a regexp matching a headline, possibly with some keyword.
518 This regexp can match any headline with the specified keyword, or
519 without a keyword. The keyword isn't in any group by default,
520 but the stars and the body are.")
522 (defconst org-archive-tag "ARCHIVE"
523 "The tag that marks a subtree as archived.
524 An archived subtree does not open during visibility cycling, and does
525 not contribute to the agenda listings.")
527 (defconst org-comment-string "COMMENT"
528 "Entries starting with this keyword will never be exported.
529 \\<org-mode-map>
530 An entry can be toggled between COMMENT and normal with
531 `\\[org-toggle-comment]'.")
534 ;;;; LaTeX Environments and Fragments
536 (defconst org-latex-regexps
537 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
538 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
539 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
540 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
541 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
542 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
543 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
544 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
545 "Regular expressions for matching embedded LaTeX.")
547 ;;;; Node Property
549 (defconst org-effort-property "Effort"
550 "The property that is being used to keep track of effort estimates.
551 Effort estimates given in this property need to have the format H:MM.")
553 ;;;; Table
555 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
556 "Detect an org-type or table-type table.")
558 (defconst org-table-line-regexp "^[ \t]*|"
559 "Detect an org-type table line.")
561 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
562 "Detect an org-type table line.")
564 (defconst org-table-hline-regexp "^[ \t]*|-"
565 "Detect an org-type table hline.")
567 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
568 "Detect a table-type table hline.")
570 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
571 "Detect the first line outside a table when searching from within it.
572 This works for both table types.")
574 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
575 "Detect a #+TBLFM line.")
577 ;;;; Timestamp
579 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
580 "Regular expression for fast time stamp matching.")
582 (defconst org-ts-regexp-inactive
583 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
584 "Regular expression for fast inactive time stamp matching.")
586 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
587 "Regular expression for fast time stamp matching.")
589 (defconst org-ts-regexp0
590 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
591 "Regular expression matching time strings for analysis.
592 This one does not require the space after the date, so it can be used
593 on a string that terminates immediately after the date.")
595 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
596 "Regular expression matching time strings for analysis.")
598 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
599 "Regular expression matching time stamps, with groups.")
601 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
602 "Regular expression matching time stamps (also [..]), with groups.")
604 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
605 "Regular expression matching a time stamp range.")
607 (defconst org-tr-regexp-both
608 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
609 "Regular expression matching a time stamp range.")
611 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
612 org-ts-regexp "\\)?")
613 "Regular expression matching a time stamp or time stamp range.")
615 (defconst org-tsr-regexp-both
616 (concat org-ts-regexp-both "\\(--?-?"
617 org-ts-regexp-both "\\)?")
618 "Regular expression matching a time stamp or time stamp range.
619 The time stamps may be either active or inactive.")
621 (defconst org-repeat-re
622 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
623 "Regular expression for specifying repeated events.
624 After a match, group 1 contains the repeat expression.")
626 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
627 "Formats for `format-time-string' which are used for time stamps.")
630 ;;; The custom variables
632 (defgroup org nil
633 "Outline-based notes management and organizer."
634 :tag "Org"
635 :group 'outlines
636 :group 'calendar)
638 (defcustom org-mode-hook nil
639 "Mode hook for Org mode, run after the mode was turned on."
640 :group 'org
641 :type 'hook)
643 (defcustom org-load-hook nil
644 "Hook that is run after org.el has been loaded."
645 :group 'org
646 :type 'hook)
648 (defcustom org-log-buffer-setup-hook nil
649 "Hook that is run after an Org log buffer is created."
650 :group 'org
651 :version "24.1"
652 :type 'hook)
654 (defvar org-modules) ; defined below
655 (defvar org-modules-loaded nil
656 "Have the modules been loaded already?")
658 (defun org-load-modules-maybe (&optional force)
659 "Load all extensions listed in `org-modules'."
660 (when (or force (not org-modules-loaded))
661 (dolist (ext org-modules)
662 (condition-case nil (require ext)
663 (error (message "Problems while trying to load feature `%s'" ext))))
664 (setq org-modules-loaded t)))
666 (defun org-set-modules (var value)
667 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
668 (set var value)
669 (when (featurep 'org)
670 (org-load-modules-maybe 'force)
671 (org-element-cache-reset 'all)))
673 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
674 "Modules that should always be loaded together with org.el.
676 If a description starts with <C>, the file is not part of Emacs
677 and loading it will require that you have downloaded and properly
678 installed the Org mode distribution.
680 You can also use this system to load external packages (i.e. neither Org
681 core modules, nor modules from the CONTRIB directory). Just add symbols
682 to the end of the list. If the package is called org-xyz.el, then you need
683 to add the symbol `xyz', and the package must have a call to:
685 (provide \\='org-xyz)
687 For export specific modules, see also `org-export-backends'."
688 :group 'org
689 :set 'org-set-modules
690 :version "24.4"
691 :package-version '(Org . "8.0")
692 :type
693 '(set :greedy t
694 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
695 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
696 (const :tag " crypt: Encryption of subtrees" org-crypt)
697 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
698 (const :tag " docview: Links to doc-view buffers" org-docview)
699 (const :tag " eww: Store link to url of eww" org-eww)
700 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
701 (const :tag " habit: Track your consistency with habits" org-habit)
702 (const :tag " id: Global IDs for identifying entries" org-id)
703 (const :tag " info: Links to Info nodes" org-info)
704 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
705 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
706 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
707 (const :tag " mouse: Additional mouse support" org-mouse)
708 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
709 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
710 (const :tag " w3m: Special cut/paste from w3m to Org mode." org-w3m)
712 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
713 (const :tag "C bookmark: Org links to bookmarks" org-bookmark)
714 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
715 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
716 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
717 (const :tag "C collector: Collect properties into tables" org-collector)
718 (const :tag "C depend: TODO dependencies for Org mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
719 (const :tag "C drill: Flashcards and spaced repetition for Org mode" org-drill)
720 (const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
721 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
722 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
723 (const :tag "C eval: Include command output as text" org-eval)
724 (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
725 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
726 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
727 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
728 (const :tag "C invoice: Help manage client invoices in Org mode" org-invoice)
729 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
730 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
731 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
732 (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
733 (const :tag "C man: Support for links to manpages in Org mode" org-man)
734 (const :tag "C mew: Links to Mew folders/messages" org-mew)
735 (const :tag "C mtags: Support for muse-like tags" org-mtags)
736 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
737 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
738 (const :tag "C registry: A registry for Org links" org-registry)
739 (const :tag "C screen: Visit screen sessions through Org links" org-screen)
740 (const :tag "C secretary: Team management with org-mode" org-secretary)
741 (const :tag "C sqlinsert: Convert Org tables to SQL insertions" orgtbl-sqlinsert)
742 (const :tag "C toc: Table of contents for Org buffer" org-toc)
743 (const :tag "C track: Keep up with Org mode development" org-track)
744 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
745 (const :tag "C vm: Links to VM folders/messages" org-vm)
746 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
747 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
748 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
750 (defvar org-export-registered-backends) ; From ox.el.
751 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
752 (declare-function org-export-backend-name "ox" (backend) t)
753 (defcustom org-export-backends '(ascii html icalendar latex odt)
754 "List of export back-ends that should be always available.
756 If a description starts with <C>, the file is not part of Emacs
757 and loading it will require that you have downloaded and properly
758 installed the Org mode distribution.
760 Unlike to `org-modules', libraries in this list will not be
761 loaded along with Org, but only once the export framework is
762 needed.
764 This variable needs to be set before org.el is loaded. If you
765 need to make a change while Emacs is running, use the customize
766 interface or run the following code, where VAL stands for the new
767 value of the variable, after updating it:
769 (progn
770 (setq org-export-registered-backends
771 (cl-remove-if-not
772 (lambda (backend)
773 (let ((name (org-export-backend-name backend)))
774 (or (memq name val)
775 (catch \\='parentp
776 (dolist (b val)
777 (and (org-export-derived-backend-p b name)
778 (throw \\='parentp t)))))))
779 org-export-registered-backends))
780 (let ((new-list (mapcar #\\='org-export-backend-name
781 org-export-registered-backends)))
782 (dolist (backend val)
783 (cond
784 ((not (load (format \"ox-%s\" backend) t t))
785 (message \"Problems while trying to load export back-end \\=`%s\\='\"
786 backend))
787 ((not (memq backend new-list)) (push backend new-list))))
788 (set-default \\='org-export-backends new-list)))
790 Adding a back-end to this list will also pull the back-end it
791 depends on, if any."
792 :group 'org
793 :group 'org-export
794 :version "26.1"
795 :package-version '(Org . "9.0")
796 :initialize 'custom-initialize-set
797 :set (lambda (var val)
798 (if (not (featurep 'ox)) (set-default var val)
799 ;; Any back-end not required anymore (not present in VAL and not
800 ;; a parent of any back-end in the new value) is removed from the
801 ;; list of registered back-ends.
802 (setq org-export-registered-backends
803 (cl-remove-if-not
804 (lambda (backend)
805 (let ((name (org-export-backend-name backend)))
806 (or (memq name val)
807 (catch 'parentp
808 (dolist (b val)
809 (and (org-export-derived-backend-p b name)
810 (throw 'parentp t)))))))
811 org-export-registered-backends))
812 ;; Now build NEW-LIST of both new back-ends and required
813 ;; parents.
814 (let ((new-list (mapcar #'org-export-backend-name
815 org-export-registered-backends)))
816 (dolist (backend val)
817 (cond
818 ((not (load (format "ox-%s" backend) t t))
819 (message "Problems while trying to load export back-end `%s'"
820 backend))
821 ((not (memq backend new-list)) (push backend new-list))))
822 ;; Set VAR to that list with fixed dependencies.
823 (set-default var new-list))))
824 :type '(set :greedy t
825 (const :tag " ascii Export buffer to ASCII format" ascii)
826 (const :tag " beamer Export buffer to Beamer presentation" beamer)
827 (const :tag " html Export buffer to HTML format" html)
828 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
829 (const :tag " latex Export buffer to LaTeX format" latex)
830 (const :tag " man Export buffer to MAN format" man)
831 (const :tag " md Export buffer to Markdown format" md)
832 (const :tag " odt Export buffer to ODT format" odt)
833 (const :tag " org Export buffer to Org format" org)
834 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
835 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
836 (const :tag "C deck Export buffer to deck.js presentations" deck)
837 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
838 (const :tag "C groff Export buffer to Groff format" groff)
839 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
840 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
841 (const :tag "C s5 Export buffer to s5 presentations" s5)
842 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
844 (eval-after-load 'ox
845 '(dolist (backend org-export-backends)
846 (condition-case nil (require (intern (format "ox-%s" backend)))
847 (error (message "Problems while trying to load export back-end `%s'"
848 backend)))))
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."
889 :group 'org
890 :type '(choice
891 (const :tag "Never" nil)
892 (const :tag "When outside special context" t)
893 (const :tag "Everywhere except timestamps" always)))
895 (defcustom org-loop-over-headlines-in-active-region nil
896 "Shall some commands act upon headlines in the active region?
898 When set to t, some commands will be performed in all headlines
899 within the active region.
901 When set to `start-level', some commands will be performed in all
902 headlines within the active region, provided that these headlines
903 are of the same level than the first one.
905 When set to a string, those commands will be performed on the
906 matching headlines within the active region. Such string must be
907 a tags/property/todo match as it is used in the agenda tags view.
909 The list of commands is: `org-schedule', `org-deadline',
910 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
911 `org-archive-to-archive-sibling'. The archiving commands skip
912 already archived entries."
913 :type '(choice (const :tag "Don't loop" nil)
914 (const :tag "All headlines in active region" t)
915 (const :tag "In active region, headlines at the same level than the first one" start-level)
916 (string :tag "Tags/Property/Todo matcher"))
917 :version "24.1"
918 :group 'org-todo
919 :group 'org-archive)
921 (defgroup org-startup nil
922 "Options concerning startup of Org mode."
923 :tag "Org Startup"
924 :group 'org)
926 (defcustom org-startup-folded t
927 "Non-nil means entering Org mode will switch to OVERVIEW.
929 This can also be configured on a per-file basis by adding one of
930 the following lines anywhere in the buffer:
932 #+STARTUP: fold (or `overview', this is equivalent)
933 #+STARTUP: nofold (or `showall', this is equivalent)
934 #+STARTUP: content
935 #+STARTUP: showeverything
937 Set `org-agenda-inhibit-startup' to a non-nil value if you want
938 to ignore this option when Org opens agenda files for the first
939 time."
940 :group 'org-startup
941 :type '(choice
942 (const :tag "nofold: show all" nil)
943 (const :tag "fold: overview" t)
944 (const :tag "content: all headlines" content)
945 (const :tag "show everything, even drawers" showeverything)))
947 (defcustom org-startup-truncated t
948 "Non-nil means entering Org mode will set `truncate-lines'.
949 This is useful since some lines containing links can be very long and
950 uninteresting. Also tables look terrible when wrapped.
952 The variable `org-startup-truncated' allows to configure
953 truncation for Org mode different to the other modes that use the
954 variable `truncate-lines' and as a shortcut instead of putting
955 the variable `truncate-lines' into the `org-mode-hook'. If one
956 wants to configure truncation for Org mode not statically but
957 dynamically e. g. in a hook like `ediff-prepare-buffer-hook' then
958 the variable `truncate-lines' has to be used because in such a
959 case it is too late to set the variable `org-startup-truncated'."
960 :group 'org-startup
961 :type 'boolean)
963 (defcustom org-startup-indented nil
964 "Non-nil means turn on `org-indent-mode' on startup.
965 This can also be configured on a per-file basis by adding one of
966 the following lines anywhere in the buffer:
968 #+STARTUP: indent
969 #+STARTUP: noindent"
970 :group 'org-structure
971 :type '(choice
972 (const :tag "Not" nil)
973 (const :tag "Globally (slow on startup in large files)" t)))
975 (defcustom org-use-sub-superscripts t
976 "Non-nil means interpret \"_\" and \"^\" for display.
978 If you want to control how Org exports those characters, see
979 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
980 used to be an alias for `org-export-with-sub-superscripts' in
981 Org <8.0, it is not anymore.
983 When this option is turned on, you can use TeX-like syntax for
984 sub- and superscripts within the buffer. Several characters after
985 \"_\" or \"^\" will be considered as a single item - so grouping
986 with {} is normally not needed. For example, the following things
987 will be parsed as single sub- or superscripts:
989 10^24 or 10^tau several digits will be considered 1 item.
990 10^-12 or 10^-tau a leading sign with digits or a word
991 x^2-y^3 will be read as x^2 - y^3, because items are
992 terminated by almost any nonword/nondigit char.
993 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
995 Still, ambiguity is possible. So when in doubt, use {} to enclose
996 the sub/superscript. If you set this variable to the symbol `{}',
997 the braces are *required* in order to trigger interpretations as
998 sub/superscript. This can be helpful in documents that need \"_\"
999 frequently in plain text."
1000 :group 'org-startup
1001 :version "24.4"
1002 :package-version '(Org . "8.0")
1003 :type '(choice
1004 (const :tag "Always interpret" t)
1005 (const :tag "Only with braces" {})
1006 (const :tag "Never interpret" nil)))
1008 (defcustom org-startup-with-beamer-mode nil
1009 "Non-nil means turn on `org-beamer-mode' on startup.
1010 This can also be configured on a per-file basis by adding one of
1011 the following lines anywhere in the buffer:
1013 #+STARTUP: beamer"
1014 :group 'org-startup
1015 :version "24.1"
1016 :type 'boolean)
1018 (defcustom org-startup-align-all-tables nil
1019 "Non-nil means align all tables when visiting a file.
1020 This is useful when the column width in tables is forced with <N> cookies
1021 in table fields. Such tables will look correct only after the first re-align.
1022 This can also be configured on a per-file basis by adding one of
1023 the following lines anywhere in the buffer:
1024 #+STARTUP: align
1025 #+STARTUP: noalign"
1026 :group 'org-startup
1027 :type 'boolean)
1029 (defcustom org-startup-with-inline-images nil
1030 "Non-nil means show inline images when loading a new Org file.
1031 This can also be configured on a per-file basis by adding one of
1032 the following lines anywhere in the buffer:
1033 #+STARTUP: inlineimages
1034 #+STARTUP: noinlineimages"
1035 :group 'org-startup
1036 :version "24.1"
1037 :type 'boolean)
1039 (defcustom org-startup-with-latex-preview nil
1040 "Non-nil means preview LaTeX fragments when loading a new Org file.
1042 This can also be configured on a per-file basis by adding one of
1043 the following lines anywhere in the buffer:
1044 #+STARTUP: latexpreview
1045 #+STARTUP: nolatexpreview"
1046 :group 'org-startup
1047 :version "24.4"
1048 :package-version '(Org . "8.0")
1049 :type 'boolean)
1051 (defcustom org-insert-mode-line-in-empty-file nil
1052 "Non-nil means insert the first line setting Org mode in empty files.
1053 When the function `org-mode' is called interactively in an empty file, this
1054 normally means that the file name does not automatically trigger Org mode.
1055 To ensure that the file will always be in Org mode in the future, a
1056 line enforcing Org mode will be inserted into the buffer, if this option
1057 has been set."
1058 :group 'org-startup
1059 :type 'boolean)
1061 (defcustom org-replace-disputed-keys nil
1062 "Non-nil means use alternative key bindings for some keys.
1063 Org mode uses S-<cursor> keys for changing timestamps and priorities.
1064 These keys are also used by other packages like shift-selection-mode'
1065 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1066 If you want to use Org mode together with one of these other modes,
1067 or more generally if you would like to move some Org mode commands to
1068 other keys, set this variable and configure the keys with the variable
1069 `org-disputed-keys'.
1071 This option is only relevant at load-time of Org mode, and must be set
1072 *before* org.el is loaded. Changing it requires a restart of Emacs to
1073 become effective."
1074 :group 'org-startup
1075 :type 'boolean)
1077 (defcustom org-use-extra-keys nil
1078 "Non-nil means use extra key sequence definitions for certain commands.
1079 This happens automatically if `window-system' is nil. This
1080 variable lets you do the same manually. You must set it before
1081 loading Org."
1082 :group 'org-startup
1083 :type 'boolean)
1085 (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1087 (defcustom org-disputed-keys
1088 '(([(shift up)] . [(meta p)])
1089 ([(shift down)] . [(meta n)])
1090 ([(shift left)] . [(meta -)])
1091 ([(shift right)] . [(meta +)])
1092 ([(control shift right)] . [(meta shift +)])
1093 ([(control shift left)] . [(meta shift -)]))
1094 "Keys for which Org mode and other modes compete.
1095 This is an alist, cars are the default keys, second element specifies
1096 the alternative to use when `org-replace-disputed-keys' is t.
1098 Keys can be specified in any syntax supported by `define-key'.
1099 The value of this option takes effect only at Org mode startup,
1100 therefore you'll have to restart Emacs to apply it after changing."
1101 :group 'org-startup
1102 :type 'alist)
1104 (defun org-key (key)
1105 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1106 Or return the original if not disputed."
1107 (when org-replace-disputed-keys
1108 (let* ((nkey (key-description key))
1109 (x (cl-find-if (lambda (x) (equal (key-description (car x)) nkey))
1110 org-disputed-keys)))
1111 (setq key (if x (cdr x) key))))
1112 key)
1114 (defun org-defkey (keymap key def)
1115 "Define a key, possibly translated, as returned by `org-key'."
1116 (define-key keymap (org-key key) def))
1118 (defcustom org-ellipsis nil
1119 "The ellipsis to use in the Org mode outline.
1121 When nil, just use the standard three dots.
1122 When a string, use that string instead.
1124 The change affects only Org mode (which will then use its own display table).
1125 Changing this requires executing `\\[org-mode]' in a buffer to become
1126 effective."
1127 :group 'org-startup
1128 :type '(choice (const :tag "Default" nil)
1129 (string :tag "String" :value "...#"))
1130 :safe #'string-or-null-p)
1132 (defvar org-display-table nil
1133 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1135 (defgroup org-keywords nil
1136 "Keywords in Org mode."
1137 :tag "Org Keywords"
1138 :group 'org)
1140 (defcustom org-closed-keep-when-no-todo nil
1141 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1142 :group 'org-todo
1143 :group 'org-keywords
1144 :version "24.4"
1145 :package-version '(Org . "8.0")
1146 :type 'boolean)
1148 (defgroup org-structure nil
1149 "Options concerning the general structure of Org files."
1150 :tag "Org Structure"
1151 :group 'org)
1153 (defgroup org-reveal-location nil
1154 "Options about how to make context of a location visible."
1155 :tag "Org Reveal Location"
1156 :group 'org-structure)
1158 (defcustom org-show-context-detail '((agenda . local)
1159 (bookmark-jump . lineage)
1160 (isearch . lineage)
1161 (default . ancestors))
1162 "Alist between context and visibility span when revealing a location.
1164 \\<org-mode-map>Some actions may move point into invisible
1165 locations. As a consequence, Org always expose a neighborhood
1166 around point. How much is shown depends on the initial action,
1167 or context. Valid contexts are
1169 agenda when exposing an entry from the agenda
1170 org-goto when using the command `org-goto' (`\\[org-goto]')
1171 occur-tree when using the command `org-occur' (`\\[org-sparse-tree] /')
1172 tags-tree when constructing a sparse tree based on tags matches
1173 link-search when exposing search matches associated with a link
1174 mark-goto when exposing the jump goal of a mark
1175 bookmark-jump when exposing a bookmark location
1176 isearch when exiting from an incremental search
1177 default default for all contexts not set explicitly
1179 Allowed visibility spans are
1181 minimal show current headline; if point is not on headline,
1182 also show entry
1184 local show current headline, entry and next headline
1186 ancestors show current headline and its direct ancestors; if
1187 point is not on headline, also show entry
1189 lineage show current headline, its direct ancestors and all
1190 their children; if point is not on headline, also show
1191 entry and first child
1193 tree show current headline, its direct ancestors and all
1194 their children; if point is not on headline, also show
1195 entry and all children
1197 canonical show current headline, its direct ancestors along with
1198 their entries and children; if point is not located on
1199 the headline, also show current entry and all children
1201 As special cases, a nil or t value means show all contexts in
1202 `minimal' or `canonical' view, respectively.
1204 Some views can make displayed information very compact, but also
1205 make it harder to edit the location of the match. In such
1206 a case, use the command `org-reveal' (`\\[org-reveal]') to show
1207 more context."
1208 :group 'org-reveal-location
1209 :version "26.1"
1210 :package-version '(Org . "9.0")
1211 :type '(choice
1212 (const :tag "Canonical" t)
1213 (const :tag "Minimal" nil)
1214 (repeat :greedy t :tag "Individual contexts"
1215 (cons
1216 (choice :tag "Context"
1217 (const agenda)
1218 (const org-goto)
1219 (const occur-tree)
1220 (const tags-tree)
1221 (const link-search)
1222 (const mark-goto)
1223 (const bookmark-jump)
1224 (const isearch)
1225 (const default))
1226 (choice :tag "Detail level"
1227 (const minimal)
1228 (const local)
1229 (const ancestors)
1230 (const lineage)
1231 (const tree)
1232 (const canonical))))))
1234 (defcustom org-indirect-buffer-display 'other-window
1235 "How should indirect tree buffers be displayed?
1237 This applies to indirect buffers created with the commands
1238 `org-tree-to-indirect-buffer' and `org-agenda-tree-to-indirect-buffer'.
1240 Valid values are:
1241 current-window Display in the current window
1242 other-window Just display in another window.
1243 dedicated-frame Create one new frame, and re-use it each time.
1244 new-frame Make a new frame each time. Note that in this case
1245 previously-made indirect buffers are kept, and you need to
1246 kill these buffers yourself."
1247 :group 'org-structure
1248 :group 'org-agenda-windows
1249 :type '(choice
1250 (const :tag "In current window" current-window)
1251 (const :tag "In current frame, other window" other-window)
1252 (const :tag "Each time a new frame" new-frame)
1253 (const :tag "One dedicated frame" dedicated-frame)))
1255 (defcustom org-use-speed-commands nil
1256 "Non-nil means activate single letter commands at beginning of a headline.
1257 This may also be a function to test for appropriate locations where speed
1258 commands should be active.
1260 For example, to activate speed commands when the point is on any
1261 star at the beginning of the headline, you can do this:
1263 (setq org-use-speed-commands
1264 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1265 :group 'org-structure
1266 :type '(choice
1267 (const :tag "Never" nil)
1268 (const :tag "At beginning of headline stars" t)
1269 (function)))
1271 (defcustom org-speed-commands-user nil
1272 "Alist of additional speed commands.
1273 This list will be checked before `org-speed-commands-default'
1274 when the variable `org-use-speed-commands' is non-nil
1275 and when the cursor is at the beginning of a headline.
1276 The car if each entry is a string with a single letter, which must
1277 be assigned to `self-insert-command' in the global map.
1278 The cdr is either a command to be called interactively, a function
1279 to be called, or a form to be evaluated.
1280 An entry that is just a list with a single string will be interpreted
1281 as a descriptive headline that will be added when listing the speed
1282 commands in the Help buffer using the `?' speed command."
1283 :group 'org-structure
1284 :type '(repeat :value ("k" . ignore)
1285 (choice :value ("k" . ignore)
1286 (list :tag "Descriptive Headline" (string :tag "Headline"))
1287 (cons :tag "Letter and Command"
1288 (string :tag "Command letter")
1289 (choice
1290 (function)
1291 (sexp))))))
1293 (defcustom org-bookmark-names-plist
1294 '(:last-capture "org-capture-last-stored"
1295 :last-refile "org-refile-last-stored"
1296 :last-capture-marker "org-capture-last-stored-marker")
1297 "Names for bookmarks automatically set by some Org commands.
1298 This can provide strings as names for a number of bookmarks Org sets
1299 automatically. The following keys are currently implemented:
1300 :last-capture
1301 :last-capture-marker
1302 :last-refile
1303 When a key does not show up in the property list, the corresponding bookmark
1304 is not set."
1305 :group 'org-structure
1306 :type 'plist)
1308 (defgroup org-cycle nil
1309 "Options concerning visibility cycling in Org mode."
1310 :tag "Org Cycle"
1311 :group 'org-structure)
1313 (defcustom org-cycle-skip-children-state-if-no-children t
1314 "Non-nil means skip CHILDREN state in entries that don't have any."
1315 :group 'org-cycle
1316 :type 'boolean)
1318 (defcustom org-cycle-max-level nil
1319 "Maximum level which should still be subject to visibility cycling.
1320 Levels higher than this will, for cycling, be treated as text, not a headline.
1321 When `org-odd-levels-only' is set, a value of N in this variable actually
1322 means 2N-1 stars as the limiting headline.
1323 When nil, cycle all levels.
1324 Note that the limiting level of cycling is also influenced by
1325 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1326 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1327 than its value."
1328 :group 'org-cycle
1329 :type '(choice
1330 (const :tag "No limit" nil)
1331 (integer :tag "Maximum level")))
1333 (defcustom org-hide-block-startup nil
1334 "Non-nil means entering Org mode will fold all blocks.
1335 This can also be set in on a per-file basis with
1337 #+STARTUP: hideblocks
1338 #+STARTUP: showblocks"
1339 :group 'org-startup
1340 :group 'org-cycle
1341 :type 'boolean)
1343 (defcustom org-cycle-global-at-bob nil
1344 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1346 This makes it possible to do global cycling without having to use `S-TAB'
1347 or `\\[universal-argument] TAB'. For this special case to work, the first \
1348 line of the buffer
1349 must not be a headline -- it may be empty or some other text.
1351 When used in this way, `org-cycle-hook' is disabled temporarily to make
1352 sure the cursor stays at the beginning of the buffer.
1354 When this option is nil, don't do anything special at the beginning of
1355 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 "26.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 (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 \\<org-mode-map>
1618 When nil, the new heading is created directly after the current line.
1619 The commands `\\[org-insert-heading-respect-content]' and \
1620 `\\[org-insert-todo-heading-respect-content]' turn this variable on
1621 for the duration of the command."
1622 :group 'org-structure
1623 :type 'boolean)
1625 (defcustom org-blank-before-new-entry '((heading . auto)
1626 (plain-list-item . auto))
1627 "Should `org-insert-heading' leave a blank line before new heading/item?
1628 The value is an alist, with `heading' and `plain-list-item' as CAR,
1629 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1630 which case Org will look at the surrounding headings/items and try to
1631 make an intelligent decision whether to insert a blank line or not."
1632 :group 'org-edit-structure
1633 :type '(list
1634 (cons (const heading)
1635 (choice (const :tag "Never" nil)
1636 (const :tag "Always" t)
1637 (const :tag "Auto" auto)))
1638 (cons (const plain-list-item)
1639 (choice (const :tag "Never" nil)
1640 (const :tag "Always" t)
1641 (const :tag "Auto" auto)))))
1643 (defcustom org-insert-heading-hook nil
1644 "Hook being run after inserting a new heading."
1645 :group 'org-edit-structure
1646 :type 'hook)
1648 (defcustom org-enable-fixed-width-editor t
1649 "Non-nil means lines starting with \":\" are treated as fixed-width.
1650 This currently only means they are never auto-wrapped.
1651 When nil, such lines will be treated like ordinary lines."
1652 :group 'org-edit-structure
1653 :type 'boolean)
1655 (defcustom org-goto-auto-isearch t
1656 "Non-nil means typing characters in `org-goto' starts incremental search.
1657 When nil, you can use these keybindings to navigate the buffer:
1659 q Quit the org-goto interface
1660 n Go to the next visible heading
1661 p Go to the previous visible heading
1662 f Go one heading forward on same level
1663 b Go one heading backward on same level
1664 u Go one heading up"
1665 :group 'org-edit-structure
1666 :type 'boolean)
1668 (defgroup org-sparse-trees nil
1669 "Options concerning sparse trees in Org mode."
1670 :tag "Org Sparse Trees"
1671 :group 'org-structure)
1673 (defcustom org-highlight-sparse-tree-matches t
1674 "Non-nil means highlight all matches that define a sparse tree.
1675 The highlights will automatically disappear the next time the buffer is
1676 changed by an edit command."
1677 :group 'org-sparse-trees
1678 :type 'boolean)
1680 (defcustom org-remove-highlights-with-change t
1681 "Non-nil means any change to the buffer will remove temporary highlights.
1682 \\<org-mode-map>\
1683 Such highlights are created by `org-occur' and `org-clock-display'.
1684 When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
1685 to get rid of the highlights.
1686 The highlights created by `org-toggle-latex-fragment' always need
1687 `\\[org-toggle-latex-fragment]' to be removed."
1688 :group 'org-sparse-trees
1689 :group 'org-time
1690 :type 'boolean)
1692 (defcustom org-occur-case-fold-search t
1693 "Non-nil means `org-occur' should be case-insensitive.
1694 If set to `smart' the search will be case-insensitive only if it
1695 doesn't specify any upper case character."
1696 :group 'org-sparse-trees
1697 :version "26.1"
1698 :type '(choice
1699 (const :tag "Case-sensitive" nil)
1700 (const :tag "Case-insensitive" t)
1701 (const :tag "Case-insensitive for lower case searches only" 'smart)))
1703 (defcustom org-occur-hook '(org-first-headline-recenter)
1704 "Hook that is run after `org-occur' has constructed a sparse tree.
1705 This can be used to recenter the window to show as much of the structure
1706 as possible."
1707 :group 'org-sparse-trees
1708 :type 'hook)
1710 (defgroup org-imenu-and-speedbar nil
1711 "Options concerning imenu and speedbar in Org mode."
1712 :tag "Org Imenu and Speedbar"
1713 :group 'org-structure)
1715 (defcustom org-imenu-depth 2
1716 "The maximum level for Imenu access to Org headlines.
1717 This also applied for speedbar access."
1718 :group 'org-imenu-and-speedbar
1719 :type 'integer)
1721 (defgroup org-table nil
1722 "Options concerning tables in Org mode."
1723 :tag "Org Table"
1724 :group 'org)
1726 (defcustom org-enable-table-editor 'optimized
1727 "Non-nil means lines starting with \"|\" are handled by the table editor.
1728 When nil, such lines will be treated like ordinary lines.
1730 When equal to the symbol `optimized', the table editor will be optimized to
1731 do the following:
1732 - Automatic overwrite mode in front of whitespace in table fields.
1733 This makes the structure of the table stay in tact as long as the edited
1734 field does not exceed the column width.
1735 - Minimize the number of realigns. Normally, the table is aligned each time
1736 TAB or RET are pressed to move to another field. With optimization this
1737 happens only if changes to a field might have changed the column width.
1738 Optimization requires replacing the functions `self-insert-command',
1739 `delete-char', and `backward-delete-char' in Org buffers, with a
1740 slight (in fact: unnoticeable) speed impact for normal typing. Org is very
1741 good at guessing when a re-align will be necessary, but you can always
1742 force one with `\\[org-ctrl-c-ctrl-c]'.
1744 If you would like to use the optimized version in Org mode, but the
1745 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1747 This variable can be used to turn on and off the table editor during a session,
1748 but in order to toggle optimization, a restart is required.
1750 See also the variable `org-table-auto-blank-field'."
1751 :group 'org-table
1752 :type '(choice
1753 (const :tag "off" nil)
1754 (const :tag "on" t)
1755 (const :tag "on, optimized" optimized)))
1757 (defcustom org-self-insert-cluster-for-undo nil
1758 "Non-nil means cluster self-insert commands for undo when possible.
1759 If this is set, then, like in the Emacs command loop, 20 consecutive
1760 characters will be undone together.
1761 This is configurable, because there is some impact on typing performance."
1762 :group 'org-table
1763 :type 'boolean)
1765 (defcustom org-table-tab-recognizes-table.el t
1766 "Non-nil means TAB will automatically notice a table.el table.
1767 When it sees such a table, it moves point into it and - if necessary -
1768 calls `table-recognize-table'."
1769 :group 'org-table-editing
1770 :type 'boolean)
1772 (defgroup org-link nil
1773 "Options concerning links in Org mode."
1774 :tag "Org Link"
1775 :group 'org)
1777 (defvar-local org-link-abbrev-alist-local nil
1778 "Buffer-local version of `org-link-abbrev-alist', which see.
1779 The value of this is taken from the #+LINK lines.")
1781 (defcustom org-link-parameters
1782 '(("doi" :follow org--open-doi-link)
1783 ("elisp" :follow org--open-elisp-link)
1784 ("file" :complete org-file-complete-link)
1785 ("ftp" :follow (lambda (path) (browse-url (concat "ftp:" path))))
1786 ("help" :follow org--open-help-link)
1787 ("http" :follow (lambda (path) (browse-url (concat "http:" path))))
1788 ("https" :follow (lambda (path) (browse-url (concat "https:" path))))
1789 ("mailto" :follow (lambda (path) (browse-url (concat "mailto:" path))))
1790 ("message" :follow (lambda (path) (browse-url (concat "message:" path))))
1791 ("news" :follow (lambda (path) (browse-url (concat "news:" path))))
1792 ("shell" :follow org--open-shell-link))
1793 "An alist of properties that defines all the links in Org mode.
1794 The key in each association is a string of the link type.
1795 Subsequent optional elements make up a p-list of link properties.
1797 :follow - A function that takes the link path as an argument.
1799 :export - A function that takes the link path, description and
1800 export-backend as arguments.
1802 :store - A function responsible for storing the link. See the
1803 function `org-store-link-functions'.
1805 :complete - A function that inserts a link with completion. The
1806 function takes one optional prefix arg.
1808 :face - A face for the link, or a function that returns a face.
1809 The function takes one argument which is the link path. The
1810 default face is `org-link'.
1812 :mouse-face - The mouse-face. The default is `highlight'.
1814 :display - `full' will not fold the link in descriptive
1815 display. Default is `org-link'.
1817 :help-echo - A string or function that takes (window object position)
1818 as arguments and returns a string.
1820 :keymap - A keymap that is active on the link. The default is
1821 `org-mouse-map'.
1823 :htmlize-link - A function for the htmlize-link. Defaults
1824 to (list :uri \"type:path\")
1826 :activate-func - A function to run at the end of font-lock
1827 activation. The function must accept (link-start link-end path bracketp)
1828 as arguments."
1829 :group 'org-link
1830 :type '(alist :tag "Link display parameters"
1831 :value-type plist))
1833 (defun org-link-get-parameter (type key)
1834 "Get TYPE link property for KEY.
1835 TYPE is a string and KEY is a plist keyword."
1836 (plist-get
1837 (cdr (assoc type org-link-parameters))
1838 key))
1840 (defun org-link-set-parameters (type &rest parameters)
1841 "Set link TYPE properties to PARAMETERS.
1842 PARAMETERS should be :key val pairs."
1843 (let ((data (assoc type org-link-parameters)))
1844 (if data (setcdr data (org-combine-plists (cdr data) parameters))
1845 (push (cons type parameters) org-link-parameters)
1846 (org-make-link-regexps)
1847 (org-element-update-syntax))))
1849 (defun org-link-types ()
1850 "Return a list of known link types."
1851 (mapcar #'car org-link-parameters))
1853 (defcustom org-link-abbrev-alist nil
1854 "Alist of link abbreviations.
1855 The car of each element is a string, to be replaced at the start of a link.
1856 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1857 links in Org buffers can have an optional tag after a double colon, e.g.,
1859 [[linkkey:tag][description]]
1861 The `linkkey' must be a single word, starting with a letter, followed
1862 by letters, numbers, `-' or `_'.
1864 If REPLACE is a string, the tag will simply be appended to create the link.
1865 If the string contains \"%s\", the tag will be inserted there. If the string
1866 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1867 at that point (see the function `url-hexify-string'). If the string contains
1868 the specifier \"%(my-function)\", then the custom function `my-function' will
1869 be invoked: this function takes the tag as its only argument and must return
1870 a string.
1872 REPLACE may also be a function that will be called with the tag as the
1873 only argument to create the link, which should be returned as a string.
1875 See the manual for examples."
1876 :group 'org-link
1877 :type '(repeat
1878 (cons
1879 (string :tag "Protocol")
1880 (choice
1881 (string :tag "Format")
1882 (function)))))
1884 (defcustom org-descriptive-links t
1885 "Non-nil means Org will display descriptive links.
1886 E.g. [[http://orgmode.org][Org website]] will be displayed as
1887 \"Org Website\", hiding the link itself and just displaying its
1888 description. When set to nil, Org will display the full links
1889 literally.
1891 You can interactively set the value of this variable by calling
1892 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1893 :group 'org-link
1894 :type 'boolean)
1896 (defcustom org-link-file-path-type 'adaptive
1897 "How the path name in file links should be stored.
1898 Valid values are:
1900 relative Relative to the current directory, i.e. the directory of the file
1901 into which the link is being inserted.
1902 absolute Absolute path, if possible with ~ for home directory.
1903 noabbrev Absolute path, no abbreviation of home directory.
1904 adaptive Use relative path for files in the current directory and sub-
1905 directories of it. For other files, use an absolute path."
1906 :group 'org-link
1907 :type '(choice
1908 (const relative)
1909 (const absolute)
1910 (const noabbrev)
1911 (const adaptive)))
1913 (defvaralias 'org-activate-links 'org-highlight-links)
1914 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1915 "Types of links that should be highlighted in Org files.
1917 This is a list of symbols, each one of them leading to the
1918 highlighting of a certain link type.
1920 You can still open links that are not highlighted.
1922 In principle, it does not hurt to turn on highlighting for all
1923 link types. There may be a small gain when turning off unused
1924 link types. The types are:
1926 bracket The recommended [[link][description]] or [[link]] links with hiding.
1927 angle Links in angular brackets that may contain whitespace like
1928 <bbdb:Carsten Dominik>.
1929 plain Plain links in normal text, no whitespace, like http://google.com.
1930 radio Text that is matched by a radio target, see manual for details.
1931 tag Tag settings in a headline (link to tag search).
1932 date Time stamps (link to calendar).
1933 footnote Footnote labels.
1935 If you set this variable during an Emacs session, use `org-mode-restart'
1936 in the Org buffer so that the change takes effect."
1937 :group 'org-link
1938 :group 'org-appearance
1939 :type '(set :greedy t
1940 (const :tag "Double bracket links" bracket)
1941 (const :tag "Angular bracket links" angle)
1942 (const :tag "Plain text links" plain)
1943 (const :tag "Radio target matches" radio)
1944 (const :tag "Tags" tag)
1945 (const :tag "Timestamps" date)
1946 (const :tag "Footnotes" footnote)))
1948 (defcustom org-make-link-description-function nil
1949 "Function to use for generating link descriptions from links.
1950 When nil, the link location will be used. This function must take
1951 two parameters: the first one is the link, the second one is the
1952 description generated by `org-insert-link'. The function should
1953 return the description to use."
1954 :group 'org-link
1955 :type '(choice (const nil) (function)))
1957 (defgroup org-link-store nil
1958 "Options concerning storing links in Org mode."
1959 :tag "Org Store Link"
1960 :group 'org-link)
1962 (defcustom org-url-hexify-p t
1963 "When non-nil, hexify URL when creating a link."
1964 :type 'boolean
1965 :version "24.3"
1966 :group 'org-link-store)
1968 (defcustom org-email-link-description-format "Email %c: %.30s"
1969 "Format of the description part of a link to an email or usenet message.
1970 The following %-escapes will be replaced by corresponding information:
1972 %F full \"From\" field
1973 %f name, taken from \"From\" field, address if no name
1974 %T full \"To\" field
1975 %t first name in \"To\" field, address if no name
1976 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1977 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1978 %s subject
1979 %d date
1980 %m message-id.
1982 You may use normal field width specification between the % and the letter.
1983 This is for example useful to limit the length of the subject.
1985 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1986 :group 'org-link-store
1987 :type 'string)
1989 (defcustom org-from-is-user-regexp
1990 (let (r1 r2)
1991 (when (and user-mail-address (not (string= user-mail-address "")))
1992 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1993 (when (and user-full-name (not (string= user-full-name "")))
1994 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1995 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1996 "Regexp matched against the \"From:\" header of an email or usenet message.
1997 It should match if the message is from the user him/herself."
1998 :group 'org-link-store
1999 :type 'regexp)
2001 (defcustom org-context-in-file-links t
2002 "Non-nil means file links from `org-store-link' contain context.
2003 \\<org-mode-map>
2004 A search string will be added to the file name with :: as separator
2005 and used to find the context when the link is activated by the command
2006 `org-open-at-point'. When this option is t, the entire active region
2007 will be placed in the search string of the file link. If set to a
2008 positive integer, only the first n lines of context will be stored.
2010 Using a prefix arg to the command `org-store-link' (`\\[universal-argument] \
2011 \\[org-store-link]')
2012 negates this setting for the duration of the command."
2013 :group 'org-link-store
2014 :type '(choice boolean integer))
2016 (defcustom org-keep-stored-link-after-insertion nil
2017 "Non-nil means keep link in list for entire session.
2018 \\<org-mode-map>
2019 The command `org-store-link' adds a link pointing to the current
2020 location to an internal list. These links accumulate during a session.
2021 The command `org-insert-link' can be used to insert links into any
2022 Org file (offering completion for all stored links).
2024 When this option is nil, every link which has been inserted once using
2025 `\\[org-insert-link]' will be removed from the list, to make completing the \
2026 unused
2027 links more efficient."
2028 :group 'org-link-store
2029 :type 'boolean)
2031 (defgroup org-link-follow nil
2032 "Options concerning following links in Org mode."
2033 :tag "Org Follow Link"
2034 :group 'org-link)
2036 (defcustom org-link-translation-function nil
2037 "Function to translate links with different syntax to Org syntax.
2038 This can be used to translate links created for example by the Planner
2039 or emacs-wiki packages to Org syntax.
2040 The function must accept two parameters, a TYPE containing the link
2041 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
2042 which is everything after the link protocol. It should return a cons
2043 with possibly modified values of type and path.
2044 Org contains a function for this, so if you set this variable to
2045 `org-translate-link-from-planner', you should be able follow many
2046 links created by planner."
2047 :group 'org-link-follow
2048 :type '(choice (const nil) (function)))
2050 (defcustom org-follow-link-hook nil
2051 "Hook that is run after a link has been followed."
2052 :group 'org-link-follow
2053 :type 'hook)
2055 (defcustom org-tab-follows-link nil
2056 "Non-nil means on links TAB will follow the link.
2057 Needs to be set before org.el is loaded.
2058 This really should not be used, it does not make sense, and the
2059 implementation is bad."
2060 :group 'org-link-follow
2061 :type 'boolean)
2063 (defcustom org-return-follows-link nil
2064 "Non-nil means on links RET will follow the link.
2065 In tables, the special behavior of RET has precedence."
2066 :group 'org-link-follow
2067 :type 'boolean)
2069 (defcustom org-mouse-1-follows-link
2070 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
2071 "Non-nil means mouse-1 on a link will follow the link.
2072 A longer mouse click will still set point. Needs to be set
2073 before org.el is loaded."
2074 :group 'org-link-follow
2075 :version "24.4"
2076 :package-version '(Org . "8.3")
2077 :type '(choice
2078 (const :tag "A double click follows the link" double)
2079 (const :tag "Unconditionally follow the link with mouse-1" t)
2080 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2082 (defcustom org-mark-ring-length 4
2083 "Number of different positions to be recorded in the ring.
2084 Changing this requires a restart of Emacs to work correctly."
2085 :group 'org-link-follow
2086 :type 'integer)
2088 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2089 "Non-nil means internal fuzzy links can only match headlines.
2091 When nil, the a fuzzy link may point to a target or a named
2092 construct in the document. When set to the special value
2093 `query-to-create', offer to create a new headline when none
2094 matched.
2096 Spaces and statistics cookies are ignored during heading searches."
2097 :group 'org-link-follow
2098 :version "24.1"
2099 :type '(choice
2100 (const :tag "Use fuzzy text search" nil)
2101 (const :tag "Match only exact headline" t)
2102 (const :tag "Match exact headline or query to create it"
2103 query-to-create))
2104 :safe #'symbolp)
2106 (defcustom org-link-frame-setup
2107 '((vm . vm-visit-folder-other-frame)
2108 (vm-imap . vm-visit-imap-folder-other-frame)
2109 (gnus . org-gnus-no-new-news)
2110 (file . find-file-other-window)
2111 (wl . wl-other-frame))
2112 "Setup the frame configuration for following links.
2113 When following a link with Emacs, it may often be useful to display
2114 this link in another window or frame. This variable can be used to
2115 set this up for the different types of links.
2116 For VM, use any of
2117 `vm-visit-folder'
2118 `vm-visit-folder-other-window'
2119 `vm-visit-folder-other-frame'
2120 For Gnus, use any of
2121 `gnus'
2122 `gnus-other-frame'
2123 `org-gnus-no-new-news'
2124 For FILE, use any of
2125 `find-file'
2126 `find-file-other-window'
2127 `find-file-other-frame'
2128 For Wanderlust use any of
2129 `wl'
2130 `wl-other-frame'
2131 For the calendar, use the variable `calendar-setup'.
2132 For BBDB, it is currently only possible to display the matches in
2133 another window."
2134 :group 'org-link-follow
2135 :type '(list
2136 (cons (const vm)
2137 (choice
2138 (const vm-visit-folder)
2139 (const vm-visit-folder-other-window)
2140 (const vm-visit-folder-other-frame)))
2141 (cons (const vm-imap)
2142 (choice
2143 (const vm-visit-imap-folder)
2144 (const vm-visit-imap-folder-other-window)
2145 (const vm-visit-imap-folder-other-frame)))
2146 (cons (const gnus)
2147 (choice
2148 (const gnus)
2149 (const gnus-other-frame)
2150 (const org-gnus-no-new-news)))
2151 (cons (const file)
2152 (choice
2153 (const find-file)
2154 (const find-file-other-window)
2155 (const find-file-other-frame)))
2156 (cons (const wl)
2157 (choice
2158 (const wl)
2159 (const wl-other-frame)))))
2161 (defcustom org-display-internal-link-with-indirect-buffer nil
2162 "Non-nil means use indirect buffer to display infile links.
2163 Activating internal links (from one location in a file to another location
2164 in the same file) normally just jumps to the location. When the link is
2165 activated with a `\\[universal-argument]' prefix (or with mouse-3), the link \
2166 is displayed in
2167 another window. When this option is set, the other window actually displays
2168 an indirect buffer clone of the current buffer, to avoid any visibility
2169 changes to the current buffer."
2170 :group 'org-link-follow
2171 :type 'boolean)
2173 (defcustom org-open-non-existing-files nil
2174 "Non-nil means `org-open-file' will open non-existing files.
2175 When nil, an error will be generated.
2176 This variable applies only to external applications because they
2177 might choke on non-existing files. If the link is to a file that
2178 will be opened in Emacs, the variable is ignored."
2179 :group 'org-link-follow
2180 :type 'boolean)
2182 (defcustom org-open-directory-means-index-dot-org nil
2183 "Non-nil means a link to a directory really means to index.org.
2184 When nil, following a directory link will run dired or open a finder/explorer
2185 window on that directory."
2186 :group 'org-link-follow
2187 :type 'boolean)
2189 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2190 "Non-nil means ask for confirmation before executing shell links.
2191 Shell links can be dangerous: just think about a link
2193 [[shell:rm -rf ~/*][Google Search]]
2195 This link would show up in your Org document as \"Google Search\",
2196 but really it would remove your entire home directory.
2197 Therefore we advise against setting this variable to nil.
2198 Just change it to `y-or-n-p' if you want to confirm with a
2199 single keystroke rather than having to type \"yes\"."
2200 :group 'org-link-follow
2201 :type '(choice
2202 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2203 (const :tag "with y-or-n (faster)" y-or-n-p)
2204 (const :tag "no confirmation (dangerous)" nil)))
2205 (put 'org-confirm-shell-link-function
2206 'safe-local-variable
2207 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2209 (defcustom org-confirm-shell-link-not-regexp ""
2210 "A regexp to skip confirmation for shell links."
2211 :group 'org-link-follow
2212 :version "24.1"
2213 :type 'regexp)
2215 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2216 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2217 Elisp links can be dangerous: just think about a link
2219 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2221 This link would show up in your Org document as \"Google Search\",
2222 but really it would remove your entire home directory.
2223 Therefore we advise against setting this variable to nil.
2224 Just change it to `y-or-n-p' if you want to confirm with a
2225 single keystroke rather than having to type \"yes\"."
2226 :group 'org-link-follow
2227 :type '(choice
2228 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2229 (const :tag "with y-or-n (faster)" y-or-n-p)
2230 (const :tag "no confirmation (dangerous)" nil)))
2231 (put 'org-confirm-shell-link-function
2232 'safe-local-variable
2233 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2235 (defcustom org-confirm-elisp-link-not-regexp ""
2236 "A regexp to skip confirmation for Elisp links."
2237 :group 'org-link-follow
2238 :version "24.1"
2239 :type 'regexp)
2241 (defconst org-file-apps-defaults-gnu
2242 '((remote . emacs)
2243 (system . mailcap)
2244 (t . mailcap))
2245 "Default file applications on a UNIX or GNU/Linux system.
2246 See `org-file-apps'.")
2248 (defconst org-file-apps-defaults-macosx
2249 '((remote . emacs)
2250 (system . "open %s")
2251 ("ps.gz" . "gv %s")
2252 ("eps.gz" . "gv %s")
2253 ("dvi" . "xdvi %s")
2254 ("fig" . "xfig %s")
2255 (t . "open %s"))
2256 "Default file applications on a macOS system.
2257 The system \"open\" is known as a default, but we use X11 applications
2258 for some files for which the OS does not have a good default.
2259 See `org-file-apps'.")
2261 (defconst org-file-apps-defaults-windowsnt
2262 (list '(remote . emacs)
2263 (cons 'system (lambda (file _path)
2264 (with-no-warnings (w32-shell-execute "open" file))))
2265 (cons t (lambda (file _path)
2266 (with-no-warnings (w32-shell-execute "open" file)))))
2267 "Default file applications on a Windows NT system.
2268 The system \"open\" is used for most files.
2269 See `org-file-apps'.")
2271 (defcustom org-file-apps
2272 '((auto-mode . emacs)
2273 ("\\.mm\\'" . default)
2274 ("\\.x?html?\\'" . default)
2275 ("\\.pdf\\'" . default))
2276 "External applications for opening `file:path' items in a document.
2277 \\<org-mode-map>\
2279 Org mode uses system defaults for different file types, but
2280 you can use this variable to set the application for a given file
2281 extension. The entries in this list are cons cells where the car identifies
2282 files and the cdr the corresponding command.
2284 Possible values for the file identifier are:
2286 \"string\" A string as a file identifier can be interpreted in different
2287 ways, depending on its contents:
2289 - Alphanumeric characters only:
2290 Match links with this file extension.
2291 Example: (\"pdf\" . \"evince %s\")
2292 to open PDFs with evince.
2294 - Regular expression: Match links where the
2295 filename matches the regexp. If you want to
2296 use groups here, use shy groups.
2298 Example: (\"\\\\.x?html\\\\\\='\" . \"firefox %s\")
2299 (\"\\\\(?:xhtml\\\\|html\\\\)\\\\\\='\" . \"firefox %s\")
2300 to open *.html and *.xhtml with firefox.
2302 - Regular expression which contains (non-shy) groups:
2303 Match links where the whole link, including \"::\", and
2304 anything after that, matches the regexp.
2305 In a custom command string, %1, %2, etc. are replaced with
2306 the parts of the link that were matched by the groups.
2307 For backwards compatibility, if a command string is given
2308 that does not use any of the group matches, this case is
2309 handled identically to the second one (i.e. match against
2310 file name only).
2311 In a custom function, you can access the group matches with
2312 (match-string n link).
2314 Example: (\"\\\\.pdf::\\\\(\\\\d+\\\\)\\\\\\='\" . \
2315 \"evince -p %1 %s\")
2316 to open [[file:document.pdf::5]] with evince at page 5.
2318 `directory' Matches a directory
2319 `remote' Matches a remote file, accessible through tramp or efs.
2320 Remote files most likely should be visited through Emacs
2321 because external applications cannot handle such paths.
2322 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2323 so all files Emacs knows how to handle. Using this with
2324 command `emacs' will open most files in Emacs. Beware that this
2325 will also open html files inside Emacs, unless you add
2326 (\"html\" . default) to the list as well.
2327 `system' The system command to open files, like `open' on Windows
2328 and macOS, and mailcap under GNU/Linux. This is the command
2329 that will be selected if you call `org-open-at-point' with a
2330 double prefix argument (`\\[universal-argument] \
2331 \\[universal-argument] \\[org-open-at-point]').
2332 t Default for files not matched by any of the other options.
2334 Possible values for the command are:
2336 `emacs' The file will be visited by the current Emacs process.
2337 `default' Use the default application for this file type, which is the
2338 association for t in the list, most likely in the system-specific
2339 part. This can be used to overrule an unwanted setting in the
2340 system-specific variable.
2341 `system' Use the system command for opening files, like \"open\".
2342 This command is specified by the entry whose car is `system'.
2343 Most likely, the system-specific version of this variable
2344 does define this command, but you can overrule/replace it
2345 here.
2346 `mailcap' Use command specified in the mailcaps.
2347 string A command to be executed by a shell; %s will be replaced
2348 by the path to the file.
2349 function A Lisp function, which will be called with two arguments:
2350 the file path and the original link string, without the
2351 \"file:\" prefix.
2353 For more examples, see the system specific constants
2354 `org-file-apps-defaults-macosx'
2355 `org-file-apps-defaults-windowsnt'
2356 `org-file-apps-defaults-gnu'."
2357 :group 'org-link-follow
2358 :type '(repeat
2359 (cons (choice :value ""
2360 (string :tag "Extension")
2361 (const :tag "System command to open files" system)
2362 (const :tag "Default for unrecognized files" t)
2363 (const :tag "Remote file" remote)
2364 (const :tag "Links to a directory" directory)
2365 (const :tag "Any files that have Emacs modes"
2366 auto-mode))
2367 (choice :value ""
2368 (const :tag "Visit with Emacs" emacs)
2369 (const :tag "Use default" default)
2370 (const :tag "Use the system command" system)
2371 (string :tag "Command")
2372 (function :tag "Function")))))
2374 (defcustom org-doi-server-url "http://dx.doi.org/"
2375 "The URL of the DOI server."
2376 :type 'string
2377 :version "24.3"
2378 :group 'org-link-follow)
2380 (defgroup org-refile nil
2381 "Options concerning refiling entries in Org mode."
2382 :tag "Org Refile"
2383 :group 'org)
2385 (defcustom org-directory "~/org"
2386 "Directory with Org files.
2387 This is just a default location to look for Org files. There is no need
2388 at all to put your files into this directory. It is used in the
2389 following situations:
2391 1. When a capture template specifies a target file that is not an
2392 absolute path. The path will then be interpreted relative to
2393 `org-directory'
2394 2. When the value of variable `org-agenda-files' is a single file, any
2395 relative paths in this file will be taken as relative to
2396 `org-directory'."
2397 :group 'org-refile
2398 :group 'org-capture
2399 :type 'directory)
2401 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2402 "Default target for storing notes.
2403 Used as a fall back file for org-capture.el, for templates that
2404 do not specify a target file."
2405 :group 'org-refile
2406 :group 'org-capture
2407 :type 'file)
2409 (defcustom org-goto-interface 'outline
2410 "The default interface to be used for `org-goto'.
2411 Allowed values are:
2412 outline The interface shows an outline of the relevant file
2413 and the correct heading is found by moving through
2414 the outline or by searching with incremental search.
2415 outline-path-completion Headlines in the current buffer are offered via
2416 completion. This is the interface also used by
2417 the refile command."
2418 :group 'org-refile
2419 :type '(choice
2420 (const :tag "Outline" outline)
2421 (const :tag "Outline-path-completion" outline-path-completion)))
2423 (defcustom org-goto-max-level 5
2424 "Maximum target level when running `org-goto' with refile interface."
2425 :group 'org-refile
2426 :type 'integer)
2428 (defcustom org-reverse-note-order nil
2429 "Non-nil means store new notes at the beginning of a file or entry.
2430 When nil, new notes will be filed to the end of a file or entry.
2431 This can also be a list with cons cells of regular expressions that
2432 are matched against file names, and values."
2433 :group 'org-capture
2434 :group 'org-refile
2435 :type '(choice
2436 (const :tag "Reverse always" t)
2437 (const :tag "Reverse never" nil)
2438 (repeat :tag "By file name regexp"
2439 (cons regexp boolean))))
2441 (defcustom org-log-refile nil
2442 "Information to record when a task is refiled.
2444 Possible values are:
2446 nil Don't add anything
2447 time Add a time stamp to the task
2448 note Prompt for a note and add it with template `org-log-note-headings'
2450 This option can also be set with on a per-file-basis with
2452 #+STARTUP: nologrefile
2453 #+STARTUP: logrefile
2454 #+STARTUP: lognoterefile
2456 You can have local logging settings for a subtree by setting the LOGGING
2457 property to one or more of these keywords.
2459 When bulk-refiling from the agenda, the value `note' is forbidden and
2460 will temporarily be changed to `time'."
2461 :group 'org-refile
2462 :group 'org-progress
2463 :version "24.1"
2464 :type '(choice
2465 (const :tag "No logging" nil)
2466 (const :tag "Record timestamp" time)
2467 (const :tag "Record timestamp with note." note)))
2469 (defcustom org-refile-targets nil
2470 "Targets for refiling entries with `\\[org-refile]'.
2471 This is a list of cons cells. Each cell contains:
2472 - a specification of the files to be considered, either a list of files,
2473 or a symbol whose function or variable value will be used to retrieve
2474 a file name or a list of file names. If you use `org-agenda-files' for
2475 that, all agenda files will be scanned for targets. Nil means consider
2476 headings in the current buffer.
2477 - A specification of how to find candidate refile targets. This may be
2478 any of:
2479 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2480 This tag has to be present in all target headlines, inheritance will
2481 not be considered.
2482 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2483 todo keyword.
2484 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2485 headlines that are refiling targets.
2486 - a cons cell (:level . N). Any headline of level N is considered a target.
2487 Note that, when `org-odd-levels-only' is set, level corresponds to
2488 order in hierarchy, not to the number of stars.
2489 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2490 Note that, when `org-odd-levels-only' is set, level corresponds to
2491 order in hierarchy, not to the number of stars.
2493 Each element of this list generates a set of possible targets.
2494 The union of these sets is presented (with completion) to
2495 the user by `org-refile'.
2497 You can set the variable `org-refile-target-verify-function' to a function
2498 to verify each headline found by the simple criteria above.
2500 When this variable is nil, all top-level headlines in the current buffer
2501 are used, equivalent to the value `((nil . (:level . 1))'."
2502 :group 'org-refile
2503 :type '(repeat
2504 (cons
2505 (choice :value org-agenda-files
2506 (const :tag "All agenda files" org-agenda-files)
2507 (const :tag "Current buffer" nil)
2508 (function) (variable) (file))
2509 (choice :tag "Identify target headline by"
2510 (cons :tag "Specific tag" (const :value :tag) (string))
2511 (cons :tag "TODO keyword" (const :value :todo) (string))
2512 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2513 (cons :tag "Level number" (const :value :level) (integer))
2514 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2516 (defcustom org-refile-target-verify-function nil
2517 "Function to verify if the headline at point should be a refile target.
2518 The function will be called without arguments, with point at the
2519 beginning of the headline. It should return t and leave point
2520 where it is if the headline is a valid target for refiling.
2522 If the target should not be selected, the function must return nil.
2523 In addition to this, it may move point to a place from where the search
2524 should be continued. For example, the function may decide that the entire
2525 subtree of the current entry should be excluded and move point to the end
2526 of the subtree."
2527 :group 'org-refile
2528 :type '(choice
2529 (const nil)
2530 (function)))
2532 (defcustom org-refile-use-cache nil
2533 "Non-nil means cache refile targets to speed up the process.
2534 \\<org-mode-map>\
2535 The cache for a particular file will be updated automatically when
2536 the buffer has been killed, or when any of the marker used for flagging
2537 refile targets no longer points at a live buffer.
2538 If you have added new entries to a buffer that might themselves be targets,
2539 you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
2540 if you find that easier, \
2541 `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
2542 \\[org-refile]'."
2543 :group 'org-refile
2544 :version "24.1"
2545 :type 'boolean)
2547 (defcustom org-refile-use-outline-path nil
2548 "Non-nil means provide refile targets as paths.
2549 So a level 3 headline will be available as level1/level2/level3.
2551 When the value is `file', also include the file name (without directory)
2552 into the path. In this case, you can also stop the completion after
2553 the file name, to get entries inserted as top level in the file.
2555 When `full-file-path', include the full file path."
2556 :group 'org-refile
2557 :type '(choice
2558 (const :tag "Not" nil)
2559 (const :tag "Yes" t)
2560 (const :tag "Start with file name" file)
2561 (const :tag "Start with full file path" full-file-path)))
2563 (defcustom org-outline-path-complete-in-steps t
2564 "Non-nil means complete the outline path in hierarchical steps.
2565 When Org uses the refile interface to select an outline path (see
2566 `org-refile-use-outline-path'), the completion of the path can be
2567 done in a single go, or it can be done in steps down the headline
2568 hierarchy. Going in steps is probably the best if you do not use
2569 a special completion package like `ido' or `icicles'. However,
2570 when using these packages, going in one step can be very fast,
2571 while still showing the whole path to the entry."
2572 :group 'org-refile
2573 :type 'boolean)
2575 (defcustom org-refile-allow-creating-parent-nodes nil
2576 "Non-nil means allow the creation of new nodes as refile targets.
2577 New nodes are then created by adding \"/new node name\" to the completion
2578 of an existing node. When the value of this variable is `confirm',
2579 new node creation must be confirmed by the user (recommended).
2580 When nil, the completion must match an existing entry.
2582 Note that, if the new heading is not seen by the criteria
2583 listed in `org-refile-targets', multiple instances of the same
2584 heading would be created by trying again to file under the new
2585 heading."
2586 :group 'org-refile
2587 :type '(choice
2588 (const :tag "Never" nil)
2589 (const :tag "Always" t)
2590 (const :tag "Prompt for confirmation" confirm)))
2592 (defcustom org-refile-active-region-within-subtree nil
2593 "Non-nil means also refile active region within a subtree.
2595 By default `org-refile' doesn't allow refiling regions if they
2596 don't contain a set of subtrees, but it might be convenient to
2597 do so sometimes: in that case, the first line of the region is
2598 converted to a headline before refiling."
2599 :group 'org-refile
2600 :version "24.1"
2601 :type 'boolean)
2603 (defgroup org-todo nil
2604 "Options concerning TODO items in Org mode."
2605 :tag "Org TODO"
2606 :group 'org)
2608 (defgroup org-progress nil
2609 "Options concerning Progress logging in Org mode."
2610 :tag "Org Progress"
2611 :group 'org-time)
2613 (defvar org-todo-interpretation-widgets
2614 '((:tag "Sequence (cycling hits every state)" sequence)
2615 (:tag "Type (cycling directly to DONE)" type))
2616 "The available interpretation symbols for customizing `org-todo-keywords'.
2617 Interested libraries should add to this list.")
2619 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2620 "List of TODO entry keyword sequences and their interpretation.
2621 \\<org-mode-map>This is a list of sequences.
2623 Each sequence starts with a symbol, either `sequence' or `type',
2624 indicating if the keywords should be interpreted as a sequence of
2625 action steps, or as different types of TODO items. The first
2626 keywords are states requiring action - these states will select a headline
2627 for inclusion into the global TODO list Org produces. If one of the
2628 \"keywords\" is the vertical bar, \"|\", the remaining keywords
2629 signify that no further action is necessary. If \"|\" is not found,
2630 the last keyword is treated as the only DONE state of the sequence.
2632 The command `\\[org-todo]' cycles an entry through these states, and one
2633 additional state where no keyword is present. For details about this
2634 cycling, see the manual.
2636 TODO keywords and interpretation can also be set on a per-file basis with
2637 the special #+SEQ_TODO and #+TYP_TODO lines.
2639 Each keyword can optionally specify a character for fast state selection
2640 \(in combination with the variable `org-use-fast-todo-selection')
2641 and specifiers for state change logging, using the same syntax that
2642 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2643 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2644 indicates to record a time stamp each time this state is selected.
2646 Each keyword may also specify if a timestamp or a note should be
2647 recorded when entering or leaving the state, by adding additional
2648 characters in the parenthesis after the keyword. This looks like this:
2649 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2650 record only the time of the state change. With X and Y being either
2651 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2652 Y when leaving the state if and only if the *target* state does not
2653 define X. You may omit any of the fast-selection key or X or /Y,
2654 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2656 For backward compatibility, this variable may also be just a list
2657 of keywords. In this case the interpretation (sequence or type) will be
2658 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2659 :group 'org-todo
2660 :group 'org-keywords
2661 :type '(choice
2662 (repeat :tag "Old syntax, just keywords"
2663 (string :tag "Keyword"))
2664 (repeat :tag "New syntax"
2665 (cons
2666 (choice
2667 :tag "Interpretation"
2668 ;;Quick and dirty way to see
2669 ;;`org-todo-interpretations'. This takes the
2670 ;;place of item arguments
2671 :convert-widget
2672 (lambda (widget)
2673 (widget-put widget
2674 :args (mapcar
2675 (lambda (x)
2676 (widget-convert
2677 (cons 'const x)))
2678 org-todo-interpretation-widgets))
2679 widget))
2680 (repeat
2681 (string :tag "Keyword"))))))
2683 (defvar-local org-todo-keywords-1 nil
2684 "All TODO and DONE keywords active in a buffer.")
2685 (defvar org-todo-keywords-for-agenda nil)
2686 (defvar org-done-keywords-for-agenda nil)
2687 (defvar org-todo-keyword-alist-for-agenda nil)
2688 (defvar org-tag-alist-for-agenda nil
2689 "Alist of all tags from all agenda files.")
2690 (defvar org-tag-groups-alist-for-agenda nil
2691 "Alist of all groups tags from all current agenda files.")
2692 (defvar-local org-tag-groups-alist nil)
2693 (defvar org-agenda-contributing-files nil)
2694 (defvar-local org-current-tag-alist nil
2695 "Alist of all tag groups in current buffer.
2696 This variable takes into consideration `org-tag-alist',
2697 `org-tag-persistent-alist' and TAGS keywords in the buffer.")
2698 (defvar-local org-not-done-keywords nil)
2699 (defvar-local org-done-keywords nil)
2700 (defvar-local org-todo-heads nil)
2701 (defvar-local org-todo-sets nil)
2702 (defvar-local org-todo-log-states nil)
2703 (defvar-local org-todo-kwd-alist nil)
2704 (defvar-local org-todo-key-alist nil)
2705 (defvar-local org-todo-key-trigger nil)
2707 (defcustom org-todo-interpretation 'sequence
2708 "Controls how TODO keywords are interpreted.
2709 This variable is in principle obsolete and is only used for
2710 backward compatibility, if the interpretation of todo keywords is
2711 not given already in `org-todo-keywords'. See that variable for
2712 more information."
2713 :group 'org-todo
2714 :group 'org-keywords
2715 :type '(choice (const sequence)
2716 (const type)))
2718 (defcustom org-use-fast-todo-selection t
2719 "\\<org-mode-map>\
2720 Non-nil means use the fast todo selection scheme with `\\[org-todo]'.
2721 This variable describes if and under what circumstances the cycling
2722 mechanism for TODO keywords will be replaced by a single-key, direct
2723 selection scheme.
2725 When nil, fast selection is never used.
2727 When the symbol `prefix', it will be used when `org-todo' is called
2728 with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
2729 in an Org buffer, and
2730 `\\[universal-argument] t' in an agenda buffer.
2732 When t, fast selection is used by default. In this case, the prefix
2733 argument forces cycling instead.
2735 In all cases, the special interface is only used if access keys have
2736 actually been assigned by the user, i.e. if keywords in the configuration
2737 are followed by a letter in parenthesis, like TODO(t)."
2738 :group 'org-todo
2739 :type '(choice
2740 (const :tag "Never" nil)
2741 (const :tag "By default" t)
2742 (const :tag "Only with C-u C-c C-t" prefix)))
2744 (defcustom org-provide-todo-statistics t
2745 "Non-nil means update todo statistics after insert and toggle.
2746 ALL-HEADLINES means update todo statistics by including headlines
2747 with no TODO keyword as well, counting them as not done.
2748 A list of TODO keywords means the same, but skip keywords that are
2749 not in this list.
2750 When set to a list of two lists, the first list contains keywords
2751 to consider as TODO keywords, the second list contains keywords
2752 to consider as DONE keywords.
2754 When this is set, todo statistics is updated in the parent of the
2755 current entry each time a todo state is changed."
2756 :group 'org-todo
2757 :type '(choice
2758 (const :tag "Yes, only for TODO entries" t)
2759 (const :tag "Yes, including all entries" all-headlines)
2760 (repeat :tag "Yes, for TODOs in this list"
2761 (string :tag "TODO keyword"))
2762 (list :tag "Yes, for TODOs and DONEs in these lists"
2763 (repeat (string :tag "TODO keyword"))
2764 (repeat (string :tag "DONE keyword")))
2765 (other :tag "No TODO statistics" nil)))
2767 (defcustom org-hierarchical-todo-statistics t
2768 "Non-nil means TODO statistics covers just direct children.
2769 When nil, all entries in the subtree are considered.
2770 This has only an effect if `org-provide-todo-statistics' is set.
2771 To set this to nil for only a single subtree, use a COOKIE_DATA
2772 property and include the word \"recursive\" into the value."
2773 :group 'org-todo
2774 :type 'boolean)
2776 (defcustom org-after-todo-state-change-hook nil
2777 "Hook which is run after the state of a TODO item was changed.
2778 The new state (a string with a TODO keyword, or nil) is available in the
2779 Lisp variable `org-state'."
2780 :group 'org-todo
2781 :type 'hook)
2783 (defvar org-blocker-hook nil
2784 "Hook for functions that are allowed to block a state change.
2786 Functions in this hook should not modify the buffer.
2787 Each function gets as its single argument a property list,
2788 see `org-trigger-hook' for more information about this list.
2790 If any of the functions in this hook returns nil, the state change
2791 is blocked.")
2793 (defvar org-trigger-hook nil
2794 "Hook for functions that are triggered by a state change.
2796 Each function gets as its single argument a property list with at
2797 least the following elements:
2799 (:type type-of-change :position pos-at-entry-start
2800 :from old-state :to new-state)
2802 Depending on the type, more properties may be present.
2804 This mechanism is currently implemented for:
2806 TODO state changes
2807 ------------------
2808 :type todo-state-change
2809 :from previous state (keyword as a string), or nil, or a symbol
2810 `todo' or `done', to indicate the general type of state.
2811 :to new state, like in :from")
2813 (defcustom org-enforce-todo-dependencies nil
2814 "Non-nil means undone TODO entries will block switching the parent to DONE.
2815 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2816 be blocked if any prior sibling is not yet done.
2817 Finally, if the parent is blocked because of ordered siblings of its own,
2818 the child will also be blocked."
2819 :set (lambda (var val)
2820 (set var val)
2821 (if val
2822 (add-hook 'org-blocker-hook
2823 'org-block-todo-from-children-or-siblings-or-parent)
2824 (remove-hook 'org-blocker-hook
2825 'org-block-todo-from-children-or-siblings-or-parent)))
2826 :group 'org-todo
2827 :type 'boolean)
2829 (defcustom org-enforce-todo-checkbox-dependencies nil
2830 "Non-nil means unchecked boxes will block switching the parent to DONE.
2831 When this is nil, checkboxes have no influence on switching TODO states.
2832 When non-nil, you first need to check off all check boxes before the TODO
2833 entry can be switched to DONE.
2834 This variable needs to be set before org.el is loaded, and you need to
2835 restart Emacs after a change to make the change effective. The only way
2836 to change is while Emacs is running is through the customize interface."
2837 :set (lambda (var val)
2838 (set var val)
2839 (if val
2840 (add-hook 'org-blocker-hook
2841 'org-block-todo-from-checkboxes)
2842 (remove-hook 'org-blocker-hook
2843 'org-block-todo-from-checkboxes)))
2844 :group 'org-todo
2845 :type 'boolean)
2847 (defcustom org-treat-insert-todo-heading-as-state-change nil
2848 "Non-nil means inserting a TODO heading is treated as state change.
2849 So when the command `\\[org-insert-todo-heading]' is used, state change
2850 logging will apply if appropriate. When nil, the new TODO item will
2851 be inserted directly, and no logging will take place."
2852 :group 'org-todo
2853 :type 'boolean)
2855 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2856 "Non-nil means switching TODO states with S-cursor counts as state change.
2857 This is the default behavior. However, setting this to nil allows a
2858 convenient way to select a TODO state and bypass any logging associated
2859 with that."
2860 :group 'org-todo
2861 :type 'boolean)
2863 (defcustom org-todo-state-tags-triggers nil
2864 "Tag changes that should be triggered by TODO state changes.
2865 This is a list. Each entry is
2867 (state-change (tag . flag) .......)
2869 State-change can be a string with a state, and empty string to indicate the
2870 state that has no TODO keyword, or it can be one of the symbols `todo'
2871 or `done', meaning any not-done or done state, respectively."
2872 :group 'org-todo
2873 :group 'org-tags
2874 :type '(repeat
2875 (cons (choice :tag "When changing to"
2876 (const :tag "Not-done state" todo)
2877 (const :tag "Done state" done)
2878 (string :tag "State"))
2879 (repeat
2880 (cons :tag "Tag action"
2881 (string :tag "Tag")
2882 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2884 (defcustom org-log-done nil
2885 "Information to record when a task moves to the DONE state.
2887 Possible values are:
2889 nil Don't add anything, just change the keyword
2890 time Add a time stamp to the task
2891 note Prompt for a note and add it with template `org-log-note-headings'
2893 This option can also be set with on a per-file-basis with
2895 #+STARTUP: nologdone
2896 #+STARTUP: logdone
2897 #+STARTUP: lognotedone
2899 You can have local logging settings for a subtree by setting the LOGGING
2900 property to one or more of these keywords."
2901 :group 'org-todo
2902 :group 'org-progress
2903 :type '(choice
2904 (const :tag "No logging" nil)
2905 (const :tag "Record CLOSED timestamp" time)
2906 (const :tag "Record CLOSED timestamp with note." note)))
2908 ;; Normalize old uses of org-log-done.
2909 (cond
2910 ((eq org-log-done t) (setq org-log-done 'time))
2911 ((and (listp org-log-done) (memq 'done org-log-done))
2912 (setq org-log-done 'note)))
2914 (defcustom org-log-reschedule nil
2915 "Information to record when the scheduling date of a tasks is modified.
2917 Possible values are:
2919 nil Don't add anything, just change the date
2920 time Add a time stamp to the task
2921 note Prompt for a note and add it with template `org-log-note-headings'
2923 This option can also be set with on a per-file-basis with
2925 #+STARTUP: nologreschedule
2926 #+STARTUP: logreschedule
2927 #+STARTUP: lognotereschedule"
2928 :group 'org-todo
2929 :group 'org-progress
2930 :type '(choice
2931 (const :tag "No logging" nil)
2932 (const :tag "Record timestamp" time)
2933 (const :tag "Record timestamp with note." note)))
2935 (defcustom org-log-redeadline nil
2936 "Information to record when the deadline date of a tasks is modified.
2938 Possible values are:
2940 nil Don't add anything, just change the date
2941 time Add a time stamp to the task
2942 note Prompt for a note and add it with template `org-log-note-headings'
2944 This option can also be set with on a per-file-basis with
2946 #+STARTUP: nologredeadline
2947 #+STARTUP: logredeadline
2948 #+STARTUP: lognoteredeadline
2950 You can have local logging settings for a subtree by setting the LOGGING
2951 property to one or more of these keywords."
2952 :group 'org-todo
2953 :group 'org-progress
2954 :type '(choice
2955 (const :tag "No logging" nil)
2956 (const :tag "Record timestamp" time)
2957 (const :tag "Record timestamp with note." note)))
2959 (defcustom org-log-note-clock-out nil
2960 "Non-nil means record a note when clocking out of an item.
2961 This can also be configured on a per-file basis by adding one of
2962 the following lines anywhere in the buffer:
2964 #+STARTUP: lognoteclock-out
2965 #+STARTUP: nolognoteclock-out"
2966 :group 'org-todo
2967 :group 'org-progress
2968 :type 'boolean)
2970 (defcustom org-log-done-with-time t
2971 "Non-nil means the CLOSED time stamp will contain date and time.
2972 When nil, only the date will be recorded."
2973 :group 'org-progress
2974 :type 'boolean)
2976 (defcustom org-log-note-headings
2977 '((done . "CLOSING NOTE %t")
2978 (state . "State %-12s from %-12S %t")
2979 (note . "Note taken on %t")
2980 (reschedule . "Rescheduled from %S on %t")
2981 (delschedule . "Not scheduled, was %S on %t")
2982 (redeadline . "New deadline from %S on %t")
2983 (deldeadline . "Removed deadline, was %S on %t")
2984 (refile . "Refiled on %t")
2985 (clock-out . ""))
2986 "Headings for notes added to entries.
2988 The value is an alist, with the car being a symbol indicating the
2989 note context, and the cdr is the heading to be used. The heading
2990 may also be the empty string. The following placeholders can be
2991 used:
2993 %t a time stamp.
2994 %T an active time stamp instead the default inactive one
2995 %d a short-format time stamp.
2996 %D an active short-format time stamp.
2997 %s the new TODO state or time stamp (inactive), in double quotes.
2998 %S the old TODO state or time stamp (inactive), in double quotes.
2999 %u the user name.
3000 %U full user name.
3002 In fact, it is not a good idea to change the `state' entry,
3003 because Agenda Log mode depends on the format of these entries."
3004 :group 'org-todo
3005 :group 'org-progress
3006 :type '(list :greedy t
3007 (cons (const :tag "Heading when closing an item" done) string)
3008 (cons (const :tag
3009 "Heading when changing todo state (todo sequence only)"
3010 state) string)
3011 (cons (const :tag "Heading when just taking a note" note) string)
3012 (cons (const :tag "Heading when rescheduling" reschedule) string)
3013 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
3014 (cons (const :tag "Heading when changing deadline" redeadline) string)
3015 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
3016 (cons (const :tag "Heading when refiling" refile) string)
3017 (cons (const :tag "Heading when clocking out" clock-out) string)))
3019 (unless (assq 'note org-log-note-headings)
3020 (push '(note . "%t") org-log-note-headings))
3022 (defcustom org-log-into-drawer nil
3023 "Non-nil means insert state change notes and time stamps into a drawer.
3024 When nil, state changes notes will be inserted after the headline and
3025 any scheduling and clock lines, but not inside a drawer.
3027 The value of this variable should be the name of the drawer to use.
3028 LOGBOOK is proposed as the default drawer for this purpose, you can
3029 also set this to a string to define the drawer of your choice.
3031 A value of t is also allowed, representing \"LOGBOOK\".
3033 A value of t or nil can also be set with on a per-file-basis with
3035 #+STARTUP: logdrawer
3036 #+STARTUP: nologdrawer
3038 If this variable is set, `org-log-state-notes-insert-after-drawers'
3039 will be ignored.
3041 You can set the property LOG_INTO_DRAWER to overrule this setting for
3042 a subtree.
3044 Do not check directly this variable in a Lisp program. Call
3045 function `org-log-into-drawer' instead."
3046 :group 'org-todo
3047 :group 'org-progress
3048 :type '(choice
3049 (const :tag "Not into a drawer" nil)
3050 (const :tag "LOGBOOK" t)
3051 (string :tag "Other")))
3053 (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
3055 (defun org-log-into-drawer ()
3056 "Name of the log drawer, as a string, or nil.
3057 This is the value of `org-log-into-drawer'. However, if the
3058 current entry has or inherits a LOG_INTO_DRAWER property, it will
3059 be used instead of the default value."
3060 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
3061 (cond ((equal p "nil") nil)
3062 ((equal p "t") "LOGBOOK")
3063 ((stringp p) p)
3064 (p "LOGBOOK")
3065 ((stringp org-log-into-drawer) org-log-into-drawer)
3066 (org-log-into-drawer "LOGBOOK"))))
3068 (defcustom org-log-state-notes-insert-after-drawers nil
3069 "Non-nil means insert state change notes after any drawers in entry.
3070 Only the drawers that *immediately* follow the headline and the
3071 deadline/scheduled line are skipped.
3072 When nil, insert notes right after the heading and perhaps the line
3073 with deadline/scheduling if present.
3075 This variable will have no effect if `org-log-into-drawer' is
3076 set."
3077 :group 'org-todo
3078 :group 'org-progress
3079 :type 'boolean)
3081 (defcustom org-log-states-order-reversed t
3082 "Non-nil means the latest state note will be directly after heading.
3083 When nil, the state change notes will be ordered according to time.
3085 This option can also be set with on a per-file-basis with
3087 #+STARTUP: logstatesreversed
3088 #+STARTUP: nologstatesreversed"
3089 :group 'org-todo
3090 :group 'org-progress
3091 :type 'boolean)
3093 (defcustom org-todo-repeat-to-state nil
3094 "The TODO state to which a repeater should return the repeating task.
3095 By default this is the first task in a TODO sequence, or the previous state
3096 in a TODO_TYP set. But you can specify another task here.
3097 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3098 :group 'org-todo
3099 :version "24.1"
3100 :type '(choice (const :tag "Head of sequence" nil)
3101 (string :tag "Specific state")))
3103 (defcustom org-log-repeat 'time
3104 "Non-nil means record moving through the DONE state when triggering repeat.
3105 An auto-repeating task is immediately switched back to TODO when
3106 marked DONE. If you are not logging state changes (by adding \"@\"
3107 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3108 record a closing note, there will be no record of the task moving
3109 through DONE. This variable forces taking a note anyway.
3111 nil Don't force a record
3112 time Record a time stamp
3113 note Prompt for a note and add it with template `org-log-note-headings'
3115 This option can also be set with on a per-file-basis with
3117 #+STARTUP: nologrepeat
3118 #+STARTUP: logrepeat
3119 #+STARTUP: lognoterepeat
3121 You can have local logging settings for a subtree by setting the LOGGING
3122 property to one or more of these keywords."
3123 :group 'org-todo
3124 :group 'org-progress
3125 :type '(choice
3126 (const :tag "Don't force a record" nil)
3127 (const :tag "Force recording the DONE state" time)
3128 (const :tag "Force recording a note with the DONE state" note)))
3131 (defgroup org-priorities nil
3132 "Priorities in Org mode."
3133 :tag "Org Priorities"
3134 :group 'org-todo)
3136 (defcustom org-enable-priority-commands t
3137 "Non-nil means priority commands are active.
3138 When nil, these commands will be disabled, so that you never accidentally
3139 set a priority."
3140 :group 'org-priorities
3141 :type 'boolean)
3143 (defcustom org-highest-priority ?A
3144 "The highest priority of TODO items. A character like ?A, ?B etc.
3145 Must have a smaller ASCII number than `org-lowest-priority'."
3146 :group 'org-priorities
3147 :type 'character)
3149 (defcustom org-lowest-priority ?C
3150 "The lowest priority of TODO items. A character like ?A, ?B etc.
3151 Must have a larger ASCII number than `org-highest-priority'."
3152 :group 'org-priorities
3153 :type 'character)
3155 (defcustom org-default-priority ?B
3156 "The default priority of TODO items.
3157 This is the priority an item gets if no explicit priority is given.
3158 When starting to cycle on an empty priority the first step in the cycle
3159 depends on `org-priority-start-cycle-with-default'. The resulting first
3160 step priority must not exceed the range from `org-highest-priority' to
3161 `org-lowest-priority' which means that `org-default-priority' has to be
3162 in this range exclusive or inclusive the range boundaries. Else the
3163 first step refuses to set the default and the second will fall back
3164 to (depending on the command used) the highest or lowest priority."
3165 :group 'org-priorities
3166 :type 'character)
3168 (defcustom org-priority-start-cycle-with-default t
3169 "Non-nil means start with default priority when starting to cycle.
3170 When this is nil, the first step in the cycle will be (depending on the
3171 command used) one higher or lower than the default priority.
3172 See also `org-default-priority'."
3173 :group 'org-priorities
3174 :type 'boolean)
3176 (defcustom org-get-priority-function nil
3177 "Function to extract the priority from a string.
3178 The string is normally the headline. If this is nil Org computes the
3179 priority from the priority cookie like [#A] in the headline. It returns
3180 an integer, increasing by 1000 for each priority level.
3181 The user can set a different function here, which should take a string
3182 as an argument and return the numeric priority."
3183 :group 'org-priorities
3184 :version "24.1"
3185 :type '(choice
3186 (const nil)
3187 (function)))
3189 (defgroup org-time nil
3190 "Options concerning time stamps and deadlines in Org mode."
3191 :tag "Org Time"
3192 :group 'org)
3194 (defcustom org-time-stamp-rounding-minutes '(0 5)
3195 "Number of minutes to round time stamps to.
3196 \\<org-mode-map>\
3197 These are two values, the first applies when first creating a time stamp.
3198 The second applies when changing it with the commands `S-up' and `S-down'.
3199 When changing the time stamp, this means that it will change in steps
3200 of N minutes, as given by the second value.
3202 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3203 numbers should be factors of 60, so for example 5, 10, 15.
3205 When this is larger than 1, you can still force an exact time stamp by using
3206 a double prefix argument to a time stamp command like \
3207 `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
3208 and by using a prefix arg to `S-up/down' to specify the exact number
3209 of minutes to shift."
3210 :group 'org-time
3211 :get (lambda (var) ; Make sure both elements are there
3212 (if (integerp (default-value var))
3213 (list (default-value var) 5)
3214 (default-value var)))
3215 :type '(list
3216 (integer :tag "when inserting times")
3217 (integer :tag "when modifying times")))
3219 ;; Normalize old customizations of this variable.
3220 (when (integerp org-time-stamp-rounding-minutes)
3221 (setq org-time-stamp-rounding-minutes
3222 (list org-time-stamp-rounding-minutes
3223 org-time-stamp-rounding-minutes)))
3225 (defcustom org-display-custom-times nil
3226 "Non-nil means overlay custom formats over all time stamps.
3227 The formats are defined through the variable `org-time-stamp-custom-formats'.
3228 To turn this on on a per-file basis, insert anywhere in the file:
3229 #+STARTUP: customtime"
3230 :group 'org-time
3231 :set 'set-default
3232 :type 'sexp)
3233 (make-variable-buffer-local 'org-display-custom-times)
3235 (defcustom org-time-stamp-custom-formats
3236 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3237 "Custom formats for time stamps. See `format-time-string' for the syntax.
3238 These are overlaid over the default ISO format if the variable
3239 `org-display-custom-times' is set. Time like %H:%M should be at the
3240 end of the second format. The custom formats are also honored by export
3241 commands, if custom time display is turned on at the time of export."
3242 :group 'org-time
3243 :type 'sexp)
3245 (defun org-time-stamp-format (&optional long inactive)
3246 "Get the right format for a time string."
3247 (let ((f (if long (cdr org-time-stamp-formats)
3248 (car org-time-stamp-formats))))
3249 (if inactive
3250 (concat "[" (substring f 1 -1) "]")
3251 f)))
3253 (defcustom org-time-clocksum-format
3254 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3255 "The format string used when creating CLOCKSUM lines.
3256 This is also used when Org mode generates a time duration.
3258 The value can be a single format string containing two
3259 %-sequences, which will be filled with the number of hours and
3260 minutes in that order.
3262 Alternatively, the value can be a plist associating any of the
3263 keys :years, :months, :weeks, :days, :hours or :minutes with
3264 format strings. The time duration is formatted using only the
3265 time components that are needed and concatenating the results.
3266 If a time unit in absent, it falls back to the next smallest
3267 unit.
3269 The keys :require-years, :require-months, :require-days,
3270 :require-weeks, :require-hours, :require-minutes are also
3271 meaningful. A non-nil value for these keys indicates that the
3272 corresponding time component should always be included, even if
3273 its value is 0.
3276 For example,
3278 (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3279 :require-minutes t)
3281 means durations longer than a day will be expressed in days,
3282 hours and minutes, and durations less than a day will always be
3283 expressed in hours and minutes (even for durations less than an
3284 hour).
3286 The value
3288 (:days \"%dd\" :minutes \"%dm\")
3290 means durations longer than a day will be expressed in days and
3291 minutes, and durations less than a day will be expressed entirely
3292 in minutes (even for durations longer than an hour)."
3293 :group 'org-time
3294 :group 'org-clock
3295 :version "24.4"
3296 :package-version '(Org . "8.0")
3297 :type '(choice (string :tag "Format string")
3298 (set :tag "Plist"
3299 (group :inline t (const :tag "Years" :years)
3300 (string :tag "Format string"))
3301 (group :inline t
3302 (const :tag "Always show years" :require-years)
3303 (const t))
3304 (group :inline t (const :tag "Months" :months)
3305 (string :tag "Format string"))
3306 (group :inline t
3307 (const :tag "Always show months" :require-months)
3308 (const t))
3309 (group :inline t (const :tag "Weeks" :weeks)
3310 (string :tag "Format string"))
3311 (group :inline t
3312 (const :tag "Always show weeks" :require-weeks)
3313 (const t))
3314 (group :inline t (const :tag "Days" :days)
3315 (string :tag "Format string"))
3316 (group :inline t
3317 (const :tag "Always show days" :require-days)
3318 (const t))
3319 (group :inline t (const :tag "Hours" :hours)
3320 (string :tag "Format string"))
3321 (group :inline t
3322 (const :tag "Always show hours" :require-hours)
3323 (const t))
3324 (group :inline t (const :tag "Minutes" :minutes)
3325 (string :tag "Format string"))
3326 (group :inline t
3327 (const :tag "Always show minutes" :require-minutes)
3328 (const t)))))
3330 (defcustom org-time-clocksum-use-fractional nil
3331 "When non-nil, `\\[org-clock-display]' uses fractional times.
3332 See `org-time-clocksum-format' for more on time clock formats."
3333 :group 'org-time
3334 :group 'org-clock
3335 :version "24.3"
3336 :type 'boolean)
3338 (defcustom org-time-clocksum-use-effort-durations nil
3339 "When non-nil, `\\[org-clock-display]' uses effort durations.
3340 E.g. by default, one day is considered to be a 8 hours effort,
3341 so a task that has been clocked for 16 hours will be displayed
3342 as during 2 days in the clock display or in the clocktable.
3344 See `org-effort-durations' on how to set effort durations
3345 and `org-time-clocksum-format' for more on time clock formats."
3346 :group 'org-time
3347 :group 'org-clock
3348 :version "24.4"
3349 :package-version '(Org . "8.0")
3350 :type 'boolean)
3352 (defcustom org-time-clocksum-fractional-format "%.2f"
3353 "The format string used when creating CLOCKSUM lines,
3354 or when Org mode generates a time duration, if
3355 `org-time-clocksum-use-fractional' is enabled.
3357 The value can be a single format string containing one
3358 %-sequence, which will be filled with the number of hours as
3359 a float.
3361 Alternatively, the value can be a plist associating any of the
3362 keys :years, :months, :weeks, :days, :hours or :minutes with
3363 a format string. The time duration is formatted using the
3364 largest time unit which gives a non-zero integer part. If all
3365 specified formats have zero integer part, the smallest time unit
3366 is used."
3367 :group 'org-time
3368 :type '(choice (string :tag "Format string")
3369 (set (group :inline t (const :tag "Years" :years)
3370 (string :tag "Format string"))
3371 (group :inline t (const :tag "Months" :months)
3372 (string :tag "Format string"))
3373 (group :inline t (const :tag "Weeks" :weeks)
3374 (string :tag "Format string"))
3375 (group :inline t (const :tag "Days" :days)
3376 (string :tag "Format string"))
3377 (group :inline t (const :tag "Hours" :hours)
3378 (string :tag "Format string"))
3379 (group :inline t (const :tag "Minutes" :minutes)
3380 (string :tag "Format string")))))
3382 (defcustom org-deadline-warning-days 14
3383 "Number of days before expiration during which a deadline becomes active.
3384 This variable governs the display in sparse trees and in the agenda.
3385 When 0 or negative, it means use this number (the absolute value of it)
3386 even if a deadline has a different individual lead time specified.
3388 Custom commands can set this variable in the options section."
3389 :group 'org-time
3390 :group 'org-agenda-daily/weekly
3391 :type 'integer)
3393 (defcustom org-scheduled-delay-days 0
3394 "Number of days before a scheduled item becomes active.
3395 This variable governs the display in sparse trees and in the agenda.
3396 The default value (i.e. 0) means: don't delay scheduled item.
3397 When negative, it means use this number (the absolute value of it)
3398 even if a scheduled item has a different individual delay time
3399 specified.
3401 Custom commands can set this variable in the options section."
3402 :group 'org-time
3403 :group 'org-agenda-daily/weekly
3404 :version "24.4"
3405 :package-version '(Org . "8.0")
3406 :type 'integer)
3408 (defcustom org-read-date-prefer-future t
3409 "Non-nil means assume future for incomplete date input from user.
3410 This affects the following situations:
3411 1. The user gives a month but not a year.
3412 For example, if it is April and you enter \"feb 2\", this will be read
3413 as Feb 2, *next* year. \"May 5\", however, will be this year.
3414 2. The user gives a day, but no month.
3415 For example, if today is the 15th, and you enter \"3\", Org will read
3416 this as the third of *next* month. However, if you enter \"17\",
3417 it will be considered as *this* month.
3419 If you set this variable to the symbol `time', then also the following
3420 will work:
3422 3. If the user gives a time.
3423 If the time is before now, it will be interpreted as tomorrow.
3425 Currently none of this works for ISO week specifications.
3427 When this option is nil, the current day, month and year will always be
3428 used as defaults.
3430 See also `org-agenda-jump-prefer-future'."
3431 :group 'org-time
3432 :type '(choice
3433 (const :tag "Never" nil)
3434 (const :tag "Check month and day" t)
3435 (const :tag "Check month, day, and time" time)))
3437 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3438 "Should the agenda jump command prefer the future for incomplete dates?
3439 The default is to do the same as configured in `org-read-date-prefer-future'.
3440 But you can also set a deviating value here.
3441 This may t or nil, or the symbol `org-read-date-prefer-future'."
3442 :group 'org-agenda
3443 :group 'org-time
3444 :version "24.1"
3445 :type '(choice
3446 (const :tag "Use org-read-date-prefer-future"
3447 org-read-date-prefer-future)
3448 (const :tag "Never" nil)
3449 (const :tag "Always" t)))
3451 (defcustom org-read-date-force-compatible-dates t
3452 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3454 Depending on the system Emacs is running on, certain dates cannot
3455 be represented with the type used internally to represent time.
3456 Dates between 1970-1-1 and 2038-1-1 can always be represented
3457 correctly. Some systems allow for earlier dates, some for later,
3458 some for both. One way to find out it to insert any date into an
3459 Org buffer, putting the cursor on the year and hitting S-up and
3460 S-down to test the range.
3462 When this variable is set to t, the date/time prompt will not let
3463 you specify dates outside the 1970-2037 range, so it is certain that
3464 these dates will work in whatever version of Emacs you are
3465 running, and also that you can move a file from one Emacs implementation
3466 to another. WHenever Org is forcing the year for you, it will display
3467 a message and beep.
3469 When this variable is nil, Org will check if the date is
3470 representable in the specific Emacs implementation you are using.
3471 If not, it will force a year, usually the current year, and beep
3472 to remind you. Currently this setting is not recommended because
3473 the likelihood that you will open your Org files in an Emacs that
3474 has limited date range is not negligible.
3476 A workaround for this problem is to use diary sexp dates for time
3477 stamps outside of this range."
3478 :group 'org-time
3479 :version "24.1"
3480 :type 'boolean)
3482 (defcustom org-read-date-display-live t
3483 "Non-nil means display current interpretation of date prompt live.
3484 This display will be in an overlay, in the minibuffer."
3485 :group 'org-time
3486 :type 'boolean)
3488 (defcustom org-read-date-popup-calendar t
3489 "Non-nil means pop up a calendar when prompting for a date.
3490 In the calendar, the date can be selected with mouse-1. However, the
3491 minibuffer will also be active, and you can simply enter the date as well.
3492 When nil, only the minibuffer will be available."
3493 :group 'org-time
3494 :type 'boolean)
3495 (defvaralias 'org-popup-calendar-for-date-prompt
3496 'org-read-date-popup-calendar)
3498 (defcustom org-extend-today-until 0
3499 "The hour when your day really ends. Must be an integer.
3500 This has influence for the following applications:
3501 - When switching the agenda to \"today\". It it is still earlier than
3502 the time given here, the day recognized as TODAY is actually yesterday.
3503 - When a date is read from the user and it is still before the time given
3504 here, the current date and time will be assumed to be yesterday, 23:59.
3505 Also, timestamps inserted in capture templates follow this rule.
3507 IMPORTANT: This is a feature whose implementation is and likely will
3508 remain incomplete. Really, it is only here because past midnight seems to
3509 be the favorite working time of John Wiegley :-)"
3510 :group 'org-time
3511 :type 'integer)
3513 (defcustom org-use-effective-time nil
3514 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3515 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3516 \"effective time\" of any timestamps between midnight and 8am will be
3517 23:59 of the previous day."
3518 :group 'org-time
3519 :version "24.1"
3520 :type 'boolean)
3522 (defcustom org-use-last-clock-out-time-as-effective-time nil
3523 "When non-nil, use the last clock out time for `org-todo'.
3524 Note that this option has precedence over the combined use of
3525 `org-use-effective-time' and `org-extend-today-until'."
3526 :group 'org-time
3527 :version "24.4"
3528 :package-version '(Org . "8.0")
3529 :type 'boolean)
3531 (defcustom org-edit-timestamp-down-means-later nil
3532 "Non-nil means S-down will increase the time in a time stamp.
3533 When nil, S-up will increase."
3534 :group 'org-time
3535 :type 'boolean)
3537 (defcustom org-calendar-follow-timestamp-change t
3538 "Non-nil means make the calendar window follow timestamp changes.
3539 When a timestamp is modified and the calendar window is visible, it will be
3540 moved to the new date."
3541 :group 'org-time
3542 :type 'boolean)
3544 (defgroup org-tags nil
3545 "Options concerning tags in Org mode."
3546 :tag "Org Tags"
3547 :group 'org)
3549 (defcustom org-tag-alist nil
3550 "Default tags available in Org files.
3552 The value of this variable is an alist. Associations either:
3554 (TAG)
3555 (TAG . SELECT)
3556 (SPECIAL)
3558 where TAG is a tag as a string, SELECT is character, used to
3559 select that tag through the fast tag selection interface, and
3560 SPECIAL is one of the following keywords: `:startgroup',
3561 `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
3562 `:newline'. These keywords are used to define a hierarchy of
3563 tags. See manual for details.
3565 When this variable is nil, Org mode bases tag input on what is
3566 already in the buffer. The value can be overridden locally by
3567 using a TAGS keyword, e.g.,
3569 #+TAGS: tag1 tag2
3571 See also `org-tag-persistent-alist' to sidestep this behavior."
3572 :group 'org-tags
3573 :type '(repeat
3574 (choice
3575 (cons (string :tag "Tag name")
3576 (character :tag "Access char"))
3577 (const :tag "Start radio group" (:startgroup))
3578 (const :tag "Start tag group, non distinct" (:startgrouptag))
3579 (const :tag "Group tags delimiter" (:grouptags))
3580 (const :tag "End radio group" (:endgroup))
3581 (const :tag "End tag group, non distinct" (:endgrouptag))
3582 (const :tag "New line" (:newline)))))
3584 (defcustom org-tag-persistent-alist nil
3585 "Tags always available in Org files.
3587 The value of this variable is an alist. Associations either:
3589 (TAG)
3590 (TAG . SELECT)
3591 (SPECIAL)
3593 where TAG is a tag as a string, SELECT is a character, used to
3594 select that tag through the fast tag selection interface, and
3595 SPECIAL is one of the following keywords: `:startgroup',
3596 `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
3597 `:newline'. These keywords are used to define a hierarchy of
3598 tags. See manual for details.
3600 Unlike to `org-tag-alist', tags defined in this variable do not
3601 depend on a local TAGS keyword. Instead, to disable these tags
3602 on a per-file basis, insert anywhere in the file:
3604 #+STARTUP: noptag"
3605 :group 'org-tags
3606 :type '(repeat
3607 (choice
3608 (cons (string :tag "Tag name")
3609 (character :tag "Access char"))
3610 (const :tag "Start radio group" (:startgroup))
3611 (const :tag "Start tag group, non distinct" (:startgrouptag))
3612 (const :tag "Group tags delimiter" (:grouptags))
3613 (const :tag "End radio group" (:endgroup))
3614 (const :tag "End tag group, non distinct" (:endgrouptag))
3615 (const :tag "New line" (:newline)))))
3617 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3618 "If non-nil, always offer completion for all tags of all agenda files.
3619 Instead of customizing this variable directly, you might want to
3620 set it locally for capture buffers, because there no list of
3621 tags in that file can be created dynamically (there are none).
3623 (add-hook \\='org-capture-mode-hook
3624 (lambda ()
3625 (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
3626 :group 'org-tags
3627 :version "24.1"
3628 :type 'boolean)
3630 (defvar org-file-tags nil
3631 "List of tags that can be inherited by all entries in the file.
3632 The tags will be inherited if the variable `org-use-tag-inheritance'
3633 says they should be.
3634 This variable is populated from #+FILETAGS lines.")
3636 (defcustom org-use-fast-tag-selection 'auto
3637 "Non-nil means use fast tag selection scheme.
3638 This is a special interface to select and deselect tags with single keys.
3639 When nil, fast selection is never used.
3640 When the symbol `auto', fast selection is used if and only if selection
3641 characters for tags have been configured, either through the variable
3642 `org-tag-alist' or through a #+TAGS line in the buffer.
3643 When t, fast selection is always used and selection keys are assigned
3644 automatically if necessary."
3645 :group 'org-tags
3646 :type '(choice
3647 (const :tag "Always" t)
3648 (const :tag "Never" nil)
3649 (const :tag "When selection characters are configured" auto)))
3651 (defcustom org-fast-tag-selection-single-key nil
3652 "Non-nil means fast tag selection exits after first change.
3653 When nil, you have to press RET to exit it.
3654 During fast tag selection, you can toggle this flag with `C-c'.
3655 This variable can also have the value `expert'. In this case, the window
3656 displaying the tags menu is not even shown, until you press C-c again."
3657 :group 'org-tags
3658 :type '(choice
3659 (const :tag "No" nil)
3660 (const :tag "Yes" t)
3661 (const :tag "Expert" expert)))
3663 (defvar org-fast-tag-selection-include-todo nil
3664 "Non-nil means fast tags selection interface will also offer TODO states.
3665 This is an undocumented feature, you should not rely on it.")
3667 (defcustom org-tags-column -77
3668 "The column to which tags should be indented in a headline.
3669 If this number is positive, it specifies the column. If it is negative,
3670 it means that the tags should be flushright to that column. For example,
3671 -80 works well for a normal 80 character screen.
3672 When 0, place tags directly after headline text, with only one space in
3673 between."
3674 :group 'org-tags
3675 :type 'integer)
3677 (defcustom org-auto-align-tags t
3678 "Non-nil keeps tags aligned when modifying headlines.
3679 Some operations (i.e. demoting) change the length of a headline and
3680 therefore shift the tags around. With this option turned on, after
3681 each such operation the tags are again aligned to `org-tags-column'."
3682 :group 'org-tags
3683 :type 'boolean)
3685 (defcustom org-use-tag-inheritance t
3686 "Non-nil means tags in levels apply also for sublevels.
3687 When nil, only the tags directly given in a specific line apply there.
3688 This may also be a list of tags that should be inherited, or a regexp that
3689 matches tags that should be inherited. Additional control is possible
3690 with the variable `org-tags-exclude-from-inheritance' which gives an
3691 explicit list of tags to be excluded from inheritance, even if the value of
3692 `org-use-tag-inheritance' would select it for inheritance.
3694 If this option is t, a match early-on in a tree can lead to a large
3695 number of matches in the subtree when constructing the agenda or creating
3696 a sparse tree. If you only want to see the first match in a tree during
3697 a search, check out the variable `org-tags-match-list-sublevels'."
3698 :group 'org-tags
3699 :type '(choice
3700 (const :tag "Not" nil)
3701 (const :tag "Always" t)
3702 (repeat :tag "Specific tags" (string :tag "Tag"))
3703 (regexp :tag "Tags matched by regexp")))
3705 (defcustom org-tags-exclude-from-inheritance nil
3706 "List of tags that should never be inherited.
3707 This is a way to exclude a few tags from inheritance. For way to do
3708 the opposite, to actively allow inheritance for selected tags,
3709 see the variable `org-use-tag-inheritance'."
3710 :group 'org-tags
3711 :type '(repeat (string :tag "Tag")))
3713 (defun org-tag-inherit-p (tag)
3714 "Check if TAG is one that should be inherited."
3715 (cond
3716 ((member tag org-tags-exclude-from-inheritance) nil)
3717 ((eq org-use-tag-inheritance t) t)
3718 ((not org-use-tag-inheritance) nil)
3719 ((stringp org-use-tag-inheritance)
3720 (string-match org-use-tag-inheritance tag))
3721 ((listp org-use-tag-inheritance)
3722 (member tag org-use-tag-inheritance))
3723 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3725 (defcustom org-tags-match-list-sublevels t
3726 "Non-nil means list also sublevels of headlines matching a search.
3727 This variable applies to tags/property searches, and also to stuck
3728 projects because this search is based on a tags match as well.
3730 When set to the symbol `indented', sublevels are indented with
3731 leading dots.
3733 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3734 the sublevels of a headline matching a tag search often also match
3735 the same search. Listing all of them can create very long lists.
3736 Setting this variable to nil causes subtrees of a match to be skipped.
3738 This variable is semi-obsolete and probably should always be true. It
3739 is better to limit inheritance to certain tags using the variables
3740 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3741 :group 'org-tags
3742 :type '(choice
3743 (const :tag "No, don't list them" nil)
3744 (const :tag "Yes, do list them" t)
3745 (const :tag "List them, indented with leading dots" indented)))
3747 (defcustom org-tags-sort-function nil
3748 "When set, tags are sorted using this function as a comparator."
3749 :group 'org-tags
3750 :type '(choice
3751 (const :tag "No sorting" nil)
3752 (const :tag "Alphabetical" string<)
3753 (const :tag "Reverse alphabetical" string>)
3754 (function :tag "Custom function" nil)))
3756 (defvar org-tags-history nil
3757 "History of minibuffer reads for tags.")
3758 (defvar org-last-tags-completion-table nil
3759 "The last used completion table for tags.")
3760 (defvar org-after-tags-change-hook nil
3761 "Hook that is run after the tags in a line have changed.")
3763 (defgroup org-properties nil
3764 "Options concerning properties in Org mode."
3765 :tag "Org Properties"
3766 :group 'org)
3768 (defcustom org-property-format "%-10s %s"
3769 "How property key/value pairs should be formatted by `indent-line'.
3770 When `indent-line' hits a property definition, it will format the line
3771 according to this format, mainly to make sure that the values are
3772 lined-up with respect to each other."
3773 :group 'org-properties
3774 :type 'string)
3776 (defcustom org-properties-postprocess-alist nil
3777 "Alist of properties and functions to adjust inserted values.
3778 Elements of this alist must be of the form
3780 ([string] [function])
3782 where [string] must be a property name and [function] must be a
3783 lambda expression: this lambda expression must take one argument,
3784 the value to adjust, and return the new value as a string.
3786 For example, this element will allow the property \"Remaining\"
3787 to be updated wrt the relation between the \"Effort\" property
3788 and the clock summary:
3790 ((\"Remaining\" (lambda(value)
3791 (let ((clocksum (org-clock-sum-current-item))
3792 (effort (org-duration-string-to-minutes
3793 (org-entry-get (point) \"Effort\"))))
3794 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3795 :group 'org-properties
3796 :version "24.1"
3797 :type '(alist :key-type (string :tag "Property")
3798 :value-type (function :tag "Function")))
3800 (defcustom org-use-property-inheritance nil
3801 "Non-nil means properties apply also for sublevels.
3803 This setting is chiefly used during property searches. Turning it on can
3804 cause significant overhead when doing a search, which is why it is not
3805 on by default.
3807 When nil, only the properties directly given in the current entry count.
3808 When t, every property is inherited. The value may also be a list of
3809 properties that should have inheritance, or a regular expression matching
3810 properties that should be inherited.
3812 However, note that some special properties use inheritance under special
3813 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3814 and the properties ending in \"_ALL\" when they are used as descriptor
3815 for valid values of a property.
3817 Note for programmers:
3818 When querying an entry with `org-entry-get', you can control if inheritance
3819 should be used. By default, `org-entry-get' looks only at the local
3820 properties. You can request inheritance by setting the inherit argument
3821 to t (to force inheritance) or to `selective' (to respect the setting
3822 in this variable)."
3823 :group 'org-properties
3824 :type '(choice
3825 (const :tag "Not" nil)
3826 (const :tag "Always" t)
3827 (repeat :tag "Specific properties" (string :tag "Property"))
3828 (regexp :tag "Properties matched by regexp")))
3830 (defun org-property-inherit-p (property)
3831 "Return a non-nil value if PROPERTY should be inherited."
3832 (cond
3833 ((eq org-use-property-inheritance t) t)
3834 ((not org-use-property-inheritance) nil)
3835 ((stringp org-use-property-inheritance)
3836 (string-match org-use-property-inheritance property))
3837 ((listp org-use-property-inheritance)
3838 (member-ignore-case property org-use-property-inheritance))
3839 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3841 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3842 "The default column format, if no other format has been defined.
3843 This variable can be set on the per-file basis by inserting a line
3845 #+COLUMNS: %25ITEM ....."
3846 :group 'org-properties
3847 :type 'string)
3849 (defcustom org-columns-ellipses ".."
3850 "The ellipses to be used when a field in column view is truncated.
3851 When this is the empty string, as many characters as possible are shown,
3852 but then there will be no visual indication that the field has been truncated.
3853 When this is a string of length N, the last N characters of a truncated
3854 field are replaced by this string. If the column is narrower than the
3855 ellipses string, only part of the ellipses string will be shown."
3856 :group 'org-properties
3857 :type 'string)
3859 (defconst org-global-properties-fixed
3860 '(("VISIBILITY_ALL" . "folded children content all")
3861 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3862 "List of property/value pairs that can be inherited by any entry.
3864 These are fixed values, for the preset properties. The user variable
3865 that can be used to add to this list is `org-global-properties'.
3867 The entries in this list are cons cells where the car is a property
3868 name and cdr is a string with the value. If the value represents
3869 multiple items like an \"_ALL\" property, separate the items by
3870 spaces.")
3872 (defcustom org-global-properties nil
3873 "List of property/value pairs that can be inherited by any entry.
3875 This list will be combined with the constant `org-global-properties-fixed'.
3877 The entries in this list are cons cells where the car is a property
3878 name and cdr is a string with the value.
3880 You can set buffer-local values for the same purpose in the variable
3881 `org-file-properties' this by adding lines like
3883 #+PROPERTY: NAME VALUE"
3884 :group 'org-properties
3885 :type '(repeat
3886 (cons (string :tag "Property")
3887 (string :tag "Value"))))
3889 (defvar-local org-file-properties nil
3890 "List of property/value pairs that can be inherited by any entry.
3891 Valid for the current buffer.
3892 This variable is populated from #+PROPERTY lines.")
3894 (defgroup org-agenda nil
3895 "Options concerning agenda views in Org mode."
3896 :tag "Org Agenda"
3897 :group 'org)
3899 (defvar-local org-category nil
3900 "Variable used by org files to set a category for agenda display.
3901 Such files should use a file variable to set it, for example
3903 # -*- mode: org; org-category: \"ELisp\"
3905 or contain a special line
3907 #+CATEGORY: ELisp
3909 If the file does not specify a category, then file's base name
3910 is used instead.")
3911 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3913 (defcustom org-agenda-files nil
3914 "The files to be used for agenda display.
3916 If an entry is a directory, all files in that directory that are matched
3917 by `org-agenda-file-regexp' will be part of the file list.
3919 If the value of the variable is not a list but a single file name, then
3920 the list of agenda files is actually stored and maintained in that file,
3921 one agenda file per line. In this file paths can be given relative to
3922 `org-directory'. Tilde expansion and environment variable substitution
3923 are also made.
3925 Entries may be added to this list with `\\[org-agenda-file-to-front]'
3926 and removed with `\\[org-remove-file]'."
3927 :group 'org-agenda
3928 :type '(choice
3929 (repeat :tag "List of files and directories" file)
3930 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3932 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3933 "Regular expression to match files for `org-agenda-files'.
3934 If any element in the list in that variable contains a directory instead
3935 of a normal file, all files in that directory that are matched by this
3936 regular expression will be included."
3937 :group 'org-agenda
3938 :type 'regexp)
3940 (defcustom org-agenda-text-search-extra-files nil
3941 "List of extra files to be searched by text search commands.
3942 These files will be searched in addition to the agenda files by the
3943 commands `org-search-view' (`\\[org-agenda] s') \
3944 and `org-occur-in-agenda-files'.
3945 Note that these files will only be searched for text search commands,
3946 not for the other agenda views like todo lists, tag searches or the weekly
3947 agenda. This variable is intended to list notes and possibly archive files
3948 that should also be searched by these two commands.
3949 In fact, if the first element in the list is the symbol `agenda-archives',
3950 then all archive files of all agenda files will be added to the search
3951 scope."
3952 :group 'org-agenda
3953 :type '(set :greedy t
3954 (const :tag "Agenda Archives" agenda-archives)
3955 (repeat :inline t (file))))
3957 (defvaralias 'org-agenda-multi-occur-extra-files
3958 'org-agenda-text-search-extra-files)
3960 (defcustom org-agenda-skip-unavailable-files nil
3961 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3962 A nil value means to remove them, after a query, from the list."
3963 :group 'org-agenda
3964 :type 'boolean)
3966 (defcustom org-calendar-to-agenda-key [?c]
3967 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3968 The command `org-calendar-goto-agenda' will be bound to this key. The
3969 default is the character `c' because then `c' can be used to switch back and
3970 forth between agenda and calendar."
3971 :group 'org-agenda
3972 :type 'sexp)
3974 (defcustom org-calendar-insert-diary-entry-key [?i]
3975 "The key to be installed in `calendar-mode-map' for adding diary entries.
3976 This option is irrelevant until `org-agenda-diary-file' has been configured
3977 to point to an Org file. When that is the case, the command
3978 `org-agenda-diary-entry' will be bound to the key given here, by default
3979 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3980 if you want to continue doing this, you need to change this to a different
3981 key."
3982 :group 'org-agenda
3983 :type 'sexp)
3985 (defcustom org-agenda-diary-file 'diary-file
3986 "File to which to add new entries with the `i' key in agenda and calendar.
3987 When this is the symbol `diary-file', the functionality in the Emacs
3988 calendar will be used to add entries to the `diary-file'. But when this
3989 points to a file, `org-agenda-diary-entry' will be used instead."
3990 :group 'org-agenda
3991 :type '(choice
3992 (const :tag "The standard Emacs diary file" diary-file)
3993 (file :tag "Special Org file diary entries")))
3995 (eval-after-load "calendar"
3996 '(progn
3997 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3998 'org-calendar-goto-agenda)
3999 (add-hook 'calendar-mode-hook
4000 (lambda ()
4001 (unless (eq org-agenda-diary-file 'diary-file)
4002 (define-key calendar-mode-map
4003 org-calendar-insert-diary-entry-key
4004 'org-agenda-diary-entry))))))
4006 (defgroup org-latex nil
4007 "Options for embedding LaTeX code into Org mode."
4008 :tag "Org LaTeX"
4009 :group 'org)
4011 (defcustom org-format-latex-options
4012 '(:foreground default :background default :scale 1.0
4013 :html-foreground "Black" :html-background "Transparent"
4014 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
4015 "Options for creating images from LaTeX fragments.
4016 This is a property list with the following properties:
4017 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
4018 `default' means use the foreground of the default face.
4019 `auto' means use the foreground from the text face.
4020 :background the background color, or \"Transparent\".
4021 `default' means use the background of the default face.
4022 `auto' means use the background from the text face.
4023 :scale a scaling factor for the size of the images, to get more pixels
4024 :html-foreground, :html-background, :html-scale
4025 the same numbers for HTML export.
4026 :matchers a list indicating which matchers should be used to
4027 find LaTeX fragments. Valid members of this list are:
4028 \"begin\" find environments
4029 \"$1\" find single characters surrounded by $.$
4030 \"$\" find math expressions surrounded by $...$
4031 \"$$\" find math expressions surrounded by $$....$$
4032 \"\\(\" find math expressions surrounded by \\(...\\)
4033 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
4034 :group 'org-latex
4035 :type 'plist)
4037 (defcustom org-format-latex-signal-error t
4038 "Non-nil means signal an error when image creation of LaTeX snippets fails.
4039 When nil, just push out a message."
4040 :group 'org-latex
4041 :version "24.1"
4042 :type 'boolean)
4044 (defcustom org-latex-to-mathml-jar-file nil
4045 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
4046 Use this to specify additional executable file say a jar file.
4048 When using MathToWeb as the converter, specify the full-path to
4049 your mathtoweb.jar file."
4050 :group 'org-latex
4051 :version "24.1"
4052 :type '(choice
4053 (const :tag "None" nil)
4054 (file :tag "JAR file" :must-match t)))
4056 (defcustom org-latex-to-mathml-convert-command nil
4057 "Command to convert LaTeX fragments to MathML.
4058 Replace format-specifiers in the command as noted below and use
4059 `shell-command' to convert LaTeX to MathML.
4060 %j: Executable file in fully expanded form as specified by
4061 `org-latex-to-mathml-jar-file'.
4062 %I: Input LaTeX file in fully expanded form.
4063 %i: The latex fragment to be converted.
4064 %o: Output MathML file.
4066 This command is used by `org-create-math-formula'.
4068 When using MathToWeb as the converter, set this option to
4069 \"java -jar %j -unicode -force -df %o %I\".
4071 When using LaTeXML set this option to
4072 \"latexmlmath \"%i\" --presentationmathml=%o\"."
4073 :group 'org-latex
4074 :version "24.1"
4075 :type '(choice
4076 (const :tag "None" nil)
4077 (string :tag "\nShell command")))
4079 (defcustom org-preview-latex-default-process 'dvipng
4080 "The default process to convert LaTeX fragments to image files.
4081 All available processes and theirs documents can be found in
4082 `org-preview-latex-process-alist', which see."
4083 :group 'org-latex
4084 :version "26.1"
4085 :package-version '(Org . "9.0")
4086 :type 'symbol)
4088 (defcustom org-preview-latex-process-alist
4089 '((dvipng
4090 :programs ("latex" "dvipng")
4091 :description "dvi > png"
4092 :message "you need to install the programs: latex and dvipng."
4093 :image-input-type "dvi"
4094 :image-output-type "png"
4095 :image-size-adjust (1.0 . 1.0)
4096 :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
4097 :image-converter ("dvipng -fg %F -bg %B -D %D -T tight -o %O %f"))
4098 (dvisvgm
4099 :programs ("latex" "dvisvgm")
4100 :description "dvi > svg"
4101 :message "you need to install the programs: latex and dvisvgm."
4102 :use-xcolor t
4103 :image-input-type "dvi"
4104 :image-output-type "svg"
4105 :image-size-adjust (1.7 . 1.5)
4106 :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
4107 :image-converter ("dvisvgm %f -n -b min -c %S -o %O"))
4108 (imagemagick
4109 :programs ("latex" "convert")
4110 :description "pdf > png"
4111 :message "you need to install the programs: latex and imagemagick."
4112 :use-xcolor t
4113 :image-input-type "pdf"
4114 :image-output-type "png"
4115 :image-size-adjust (1.0 . 1.0)
4116 :latex-compiler ("pdflatex -interaction nonstopmode -output-directory %o %f")
4117 :image-converter
4118 ("convert -density %D -trim -antialias %f -quality 100 %O")))
4119 "Definitions of external processes for LaTeX previewing.
4120 Org mode can use some external commands to generate TeX snippet's images for
4121 previewing or inserting into HTML files, e.g., \"dvipng\". This variable tells
4122 `org-create-formula-image' how to call them.
4124 The value is an alist with the pattern (NAME . PROPERTIES). NAME is a symbol.
4125 PROPERTIES accepts the following attributes:
4127 :programs list of strings, required programs.
4128 :description string, describe the process.
4129 :message string, message it when required programs cannot be found.
4130 :image-input-type string, input file type of image converter (e.g., \"dvi\").
4131 :image-output-type string, output file type of image converter (e.g., \"png\").
4132 :use-xcolor boolean, when non-nil, LaTeX \"xcolor\" macro is used to
4133 deal with background and foreground color of image.
4134 Otherwise, dvipng style background and foregroud color
4135 format are generated. You may then refer to them in
4136 command options with \"%F\" and \"%B\".
4137 :image-size-adjust cons of numbers, the car element is used to adjust LaTeX
4138 image size showed in buffer and the cdr element is for
4139 HTML file. This option is only useful for process
4140 developers, users should use variable
4141 `org-format-latex-options' instead.
4142 :post-clean list of strings, files matched are to be cleaned up once
4143 the image is generated. When nil, the files with \".dvi\",
4144 \".xdv\", \".pdf\", \".tex\", \".aux\", \".log\", \".svg\",
4145 \".png\", \".jpg\", \".jpeg\" or \".out\" extension will
4146 be cleaned up.
4147 :latex-header list of strings, the LaTeX header of the snippet file.
4148 When nil, the fallback value is used instead, which is
4149 controlled by `org-format-latex-header',
4150 `org-latex-default-packages-alist' and
4151 `org-latex-packages-alist', which see.
4152 :latex-compiler list of LaTeX commands, as strings. Each of them is given
4153 to the shell. Place-holders \"%t\", \"%b\" and \"%o\" are
4154 replaced with values defined below.
4155 :image-converter list of image converter commands strings. Each of them is
4156 given to the shell and supports any of the following
4157 place-holders defined below.
4159 Place-holders used by `:image-converter' and `:latex-compiler':
4161 %f input file name
4162 %b base name of input file
4163 %o base directory of input file
4164 %O absolute output file name
4166 Place-holders only used by `:image-converter':
4168 %F foreground of image
4169 %B background of image
4170 %D dpi, which is used to adjust image size by some processing commands.
4171 %S the image size scale ratio, which is used to adjust image size by some
4172 processing commands."
4173 :group 'org-latex
4174 :version "26.1"
4175 :package-version '(Org . "9.0")
4176 :type '(alist :tag "LaTeX to image backends"
4177 :value-type (plist)))
4179 (defcustom org-preview-latex-image-directory "ltximg/"
4180 "Path to store latex preview images.
4181 A relative path here creates many directories relative to the
4182 processed org files paths. An absolute path puts all preview
4183 images at the same place."
4184 :group 'org-latex
4185 :version "26.1"
4186 :package-version '(Org . "9.0")
4187 :type 'string)
4189 (defun org-format-latex-mathml-available-p ()
4190 "Return t if `org-latex-to-mathml-convert-command' is usable."
4191 (save-match-data
4192 (when (and (boundp 'org-latex-to-mathml-convert-command)
4193 org-latex-to-mathml-convert-command)
4194 (let ((executable (car (split-string
4195 org-latex-to-mathml-convert-command))))
4196 (when (executable-find executable)
4197 (if (string-match
4198 "%j" org-latex-to-mathml-convert-command)
4199 (file-readable-p org-latex-to-mathml-jar-file)
4200 t))))))
4202 (defcustom org-format-latex-header "\\documentclass{article}
4203 \\usepackage[usenames]{color}
4204 \[PACKAGES]
4205 \[DEFAULT-PACKAGES]
4206 \\pagestyle{empty} % do not remove
4207 % The settings below are copied from fullpage.sty
4208 \\setlength{\\textwidth}{\\paperwidth}
4209 \\addtolength{\\textwidth}{-3cm}
4210 \\setlength{\\oddsidemargin}{1.5cm}
4211 \\addtolength{\\oddsidemargin}{-2.54cm}
4212 \\setlength{\\evensidemargin}{\\oddsidemargin}
4213 \\setlength{\\textheight}{\\paperheight}
4214 \\addtolength{\\textheight}{-\\headheight}
4215 \\addtolength{\\textheight}{-\\headsep}
4216 \\addtolength{\\textheight}{-\\footskip}
4217 \\addtolength{\\textheight}{-3cm}
4218 \\setlength{\\topmargin}{1.5cm}
4219 \\addtolength{\\topmargin}{-2.54cm}"
4220 "The document header used for processing LaTeX fragments.
4221 It is imperative that this header make sure that no page number
4222 appears on the page. The package defined in the variables
4223 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4224 will either replace the placeholder \"[PACKAGES]\" in this
4225 header, or they will be appended."
4226 :group 'org-latex
4227 :type 'string)
4229 (defun org-set-packages-alist (var val)
4230 "Set the packages alist and make sure it has 3 elements per entry."
4231 (set var (mapcar (lambda (x)
4232 (if (and (consp x) (= (length x) 2))
4233 (list (car x) (nth 1 x) t)
4235 val)))
4237 (defun org-get-packages-alist (var)
4238 "Get the packages alist and make sure it has 3 elements per entry."
4239 (mapcar (lambda (x)
4240 (if (and (consp x) (= (length x) 2))
4241 (list (car x) (nth 1 x) t)
4243 (default-value var)))
4245 (defcustom org-latex-default-packages-alist
4246 '(("AUTO" "inputenc" t ("pdflatex"))
4247 ("T1" "fontenc" t ("pdflatex"))
4248 ("" "graphicx" t)
4249 ("" "grffile" t)
4250 ("" "longtable" nil)
4251 ("" "wrapfig" nil)
4252 ("" "rotating" nil)
4253 ("normalem" "ulem" t)
4254 ("" "amsmath" t)
4255 ("" "textcomp" t)
4256 ("" "amssymb" t)
4257 ("" "capt-of" nil)
4258 ("" "hyperref" nil))
4259 "Alist of default packages to be inserted in the header.
4261 Change this only if one of the packages here causes an
4262 incompatibility with another package you are using.
4264 The packages in this list are needed by one part or another of
4265 Org mode to function properly:
4267 - inputenc, fontenc: for basic font and character selection
4268 - graphicx: for including images
4269 - grffile: allow periods and spaces in graphics file names
4270 - longtable: For multipage tables
4271 - wrapfig: for figure placement
4272 - rotating: for sideways figures and tables
4273 - ulem: for underline and strike-through
4274 - amsmath: for subscript and superscript and math environments
4275 - textcomp, amssymb: for various symbols used
4276 for interpreting the entities in `org-entities'. You can skip
4277 some of these packages if you don't use any of their symbols.
4278 - capt-of: for captions outside of floats
4279 - hyperref: for cross references
4281 Therefore you should not modify this variable unless you know
4282 what you are doing. The one reason to change it anyway is that
4283 you might be loading some other package that conflicts with one
4284 of the default packages. Each element is either a cell or
4285 a string.
4287 A cell is of the format
4289 (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
4291 If SNIPPET-FLAG is non-nil, the package also needs to be included
4292 when compiling LaTeX snippets into images for inclusion into
4293 non-LaTeX output. COMPILERS is a list of compilers that should
4294 include the package, see `org-latex-compiler'. If the document
4295 compiler is not in the list, and the list is non-nil, the package
4296 will not be inserted in the final document.
4298 A string will be inserted as-is in the header of the document."
4299 :group 'org-latex
4300 :group 'org-export-latex
4301 :set 'org-set-packages-alist
4302 :get 'org-get-packages-alist
4303 :version "26.1"
4304 :package-version '(Org . "8.3")
4305 :type '(repeat
4306 (choice
4307 (list :tag "options/package pair"
4308 (string :tag "options")
4309 (string :tag "package")
4310 (boolean :tag "Snippet"))
4311 (string :tag "A line of LaTeX"))))
4313 (defcustom org-latex-packages-alist nil
4314 "Alist of packages to be inserted in every LaTeX header.
4316 These will be inserted after `org-latex-default-packages-alist'.
4317 Each element is either a cell or a string.
4319 A cell is of the format:
4321 (\"options\" \"package\" SNIPPET-FLAG)
4323 SNIPPET-FLAG, when non-nil, indicates that this package is also
4324 needed when turning LaTeX snippets into images for inclusion into
4325 non-LaTeX output.
4327 A string will be inserted as-is in the header of the document.
4329 Make sure that you only list packages here which:
4331 - you want in every file;
4332 - do not conflict with the setup in `org-format-latex-header';
4333 - do not conflict with the default packages in
4334 `org-latex-default-packages-alist'."
4335 :group 'org-latex
4336 :group 'org-export-latex
4337 :set 'org-set-packages-alist
4338 :get 'org-get-packages-alist
4339 :type '(repeat
4340 (choice
4341 (list :tag "options/package pair"
4342 (string :tag "options")
4343 (string :tag "package")
4344 (boolean :tag "Snippet"))
4345 (string :tag "A line of LaTeX"))))
4347 (defgroup org-appearance nil
4348 "Settings for Org mode appearance."
4349 :tag "Org Appearance"
4350 :group 'org)
4352 (defcustom org-level-color-stars-only nil
4353 "Non-nil means fontify only the stars in each headline.
4354 When nil, the entire headline is fontified.
4355 Changing it requires restart of `font-lock-mode' to become effective
4356 also in regions already fontified."
4357 :group 'org-appearance
4358 :type 'boolean)
4360 (defcustom org-hide-leading-stars nil
4361 "Non-nil means hide the first N-1 stars in a headline.
4362 This works by using the face `org-hide' for these stars. This
4363 face is white for a light background, and black for a dark
4364 background. You may have to customize the face `org-hide' to
4365 make this work.
4366 Changing it requires restart of `font-lock-mode' to become effective
4367 also in regions already fontified.
4368 You may also set this on a per-file basis by adding one of the following
4369 lines to the buffer:
4371 #+STARTUP: hidestars
4372 #+STARTUP: showstars"
4373 :group 'org-appearance
4374 :type 'boolean)
4376 (defcustom org-hidden-keywords nil
4377 "List of symbols corresponding to keywords to be hidden the org buffer.
4378 For example, a value \\='(title) for this list will make the document's title
4379 appear in the buffer without the initial #+TITLE: keyword."
4380 :group 'org-appearance
4381 :version "24.1"
4382 :type '(set (const :tag "#+AUTHOR" author)
4383 (const :tag "#+DATE" date)
4384 (const :tag "#+EMAIL" email)
4385 (const :tag "#+TITLE" title)))
4387 (defcustom org-custom-properties nil
4388 "List of properties (as strings) with a special meaning.
4389 The default use of these custom properties is to let the user
4390 hide them with `org-toggle-custom-properties-visibility'."
4391 :group 'org-properties
4392 :group 'org-appearance
4393 :version "24.3"
4394 :type '(repeat (string :tag "Property Name")))
4396 (defcustom org-fontify-done-headline nil
4397 "Non-nil means change the face of a headline if it is marked DONE.
4398 Normally, only the TODO/DONE keyword indicates the state of a headline.
4399 When this is non-nil, the headline after the keyword is set to the
4400 `org-headline-done' as an additional indication."
4401 :group 'org-appearance
4402 :type 'boolean)
4404 (defcustom org-fontify-emphasized-text t
4405 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4406 Changing this variable requires a restart of Emacs to take effect."
4407 :group 'org-appearance
4408 :type 'boolean)
4410 (defcustom org-fontify-whole-heading-line nil
4411 "Non-nil means fontify the whole line for headings.
4412 This is useful when setting a background color for the
4413 org-level-* faces."
4414 :group 'org-appearance
4415 :type 'boolean)
4417 (defcustom org-highlight-latex-and-related nil
4418 "Non-nil means highlight LaTeX related syntax in the buffer.
4419 When non nil, the value should be a list containing any of the
4420 following symbols:
4421 `latex' Highlight LaTeX snippets and environments.
4422 `script' Highlight subscript and superscript.
4423 `entities' Highlight entities."
4424 :group 'org-appearance
4425 :version "24.4"
4426 :package-version '(Org . "8.0")
4427 :type '(choice
4428 (const :tag "No highlighting" nil)
4429 (set :greedy t :tag "Highlight"
4430 (const :tag "LaTeX snippets and environments" latex)
4431 (const :tag "Subscript and superscript" script)
4432 (const :tag "Entities" entities))))
4434 (defcustom org-hide-emphasis-markers nil
4435 "Non-nil mean font-lock should hide the emphasis marker characters."
4436 :group 'org-appearance
4437 :type 'boolean)
4439 (defcustom org-hide-macro-markers nil
4440 "Non-nil mean font-lock should hide the brackets marking macro calls."
4441 :group 'org-appearance
4442 :type 'boolean)
4444 (defcustom org-pretty-entities nil
4445 "Non-nil means show entities as UTF8 characters.
4446 When nil, the \\name form remains in the buffer."
4447 :group 'org-appearance
4448 :version "24.1"
4449 :type 'boolean)
4451 (defcustom org-pretty-entities-include-sub-superscripts t
4452 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4453 :group 'org-appearance
4454 :version "24.1"
4455 :type 'boolean)
4457 (defvar org-emph-re nil
4458 "Regular expression for matching emphasis.
4459 After a match, the match groups contain these elements:
4460 0 The match of the full regular expression, including the characters
4461 before and after the proper match
4462 1 The character before the proper match, or empty at beginning of line
4463 2 The proper match, including the leading and trailing markers
4464 3 The leading marker like * or /, indicating the type of highlighting
4465 4 The text between the emphasis markers, not including the markers
4466 5 The character after the match, empty at the end of a line")
4467 (defvar org-verbatim-re nil
4468 "Regular expression for matching verbatim text.")
4469 (defvar org-emphasis-regexp-components) ; defined just below
4470 (defvar org-emphasis-alist) ; defined just below
4471 (defun org-set-emph-re (var val)
4472 "Set variable and compute the emphasis regular expression."
4473 (set var val)
4474 (when (and (boundp 'org-emphasis-alist)
4475 (boundp 'org-emphasis-regexp-components)
4476 org-emphasis-alist org-emphasis-regexp-components)
4477 (let* ((e org-emphasis-regexp-components)
4478 (pre (car e))
4479 (post (nth 1 e))
4480 (border (nth 2 e))
4481 (body (nth 3 e))
4482 (nl (nth 4 e))
4483 (body1 (concat body "*?"))
4484 (markers (mapconcat 'car org-emphasis-alist ""))
4485 (vmarkers (mapconcat
4486 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4487 org-emphasis-alist "")))
4488 ;; make sure special characters appear at the right position in the class
4489 (if (string-match "\\^" markers)
4490 (setq markers (concat (replace-match "" t t markers) "^")))
4491 (if (string-match "-" markers)
4492 (setq markers (concat (replace-match "" t t markers) "-")))
4493 (if (string-match "\\^" vmarkers)
4494 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4495 (if (string-match "-" vmarkers)
4496 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4497 (if (> nl 0)
4498 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4499 (int-to-string nl) "\\}")))
4500 ;; Make the regexp
4501 (setq org-emph-re
4502 (concat "\\([" pre "]\\|^\\)"
4503 "\\("
4504 "\\([" markers "]\\)"
4505 "\\("
4506 "[^" border "]\\|"
4507 "[^" border "]"
4508 body1
4509 "[^" border "]"
4510 "\\)"
4511 "\\3\\)"
4512 "\\([" post "]\\|$\\)"))
4513 (setq org-verbatim-re
4514 (concat "\\([" pre "]\\|^\\)"
4515 "\\("
4516 "\\([" vmarkers "]\\)"
4517 "\\("
4518 "[^" border "]\\|"
4519 "[^" border "]"
4520 body1
4521 "[^" border "]"
4522 "\\)"
4523 "\\3\\)"
4524 "\\([" post "]\\|$\\)")))))
4526 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4527 ;; set this option proved cumbersome. See this message/thread:
4528 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4529 (defvar org-emphasis-regexp-components
4530 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n" "." 1)
4531 "Components used to build the regular expression for emphasis.
4532 This is a list with five entries. Terminology: In an emphasis string
4533 like \" *strong word* \", we call the initial space PREMATCH, the final
4534 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4535 and \"trong wor\" is the body. The different components in this variable
4536 specify what is allowed/forbidden in each part:
4538 pre Chars allowed as prematch. Beginning of line will be allowed too.
4539 post Chars allowed as postmatch. End of line will be allowed too.
4540 border The chars *forbidden* as border characters.
4541 body-regexp A regexp like \".\" to match a body character. Don't use
4542 non-shy groups here, and don't allow newline here.
4543 newline The maximum number of newlines allowed in an emphasis exp.
4545 You need to reload Org or to restart Emacs after customizing this.")
4547 (defcustom org-emphasis-alist
4548 '(("*" bold)
4549 ("/" italic)
4550 ("_" underline)
4551 ("=" org-verbatim verbatim)
4552 ("~" org-code verbatim)
4553 ("+" (:strike-through t)))
4554 "Alist of characters and faces to emphasize text.
4555 Text starting and ending with a special character will be emphasized,
4556 for example *bold*, _underlined_ and /italic/. This variable sets the
4557 marker characters and the face to be used by font-lock for highlighting
4558 in Org buffers.
4560 You need to reload Org or to restart Emacs after customizing this."
4561 :group 'org-appearance
4562 :set 'org-set-emph-re
4563 :version "24.4"
4564 :package-version '(Org . "8.0")
4565 :type '(repeat
4566 (list
4567 (string :tag "Marker character")
4568 (choice
4569 (face :tag "Font-lock-face")
4570 (plist :tag "Face property list"))
4571 (option (const verbatim)))))
4573 (defvar org-protecting-blocks '("src" "example" "export")
4574 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4575 This is needed for font-lock setup.")
4577 ;;; Functions and variables from their packages
4578 ;; Declared here to avoid compiler warnings
4579 (defvar mark-active)
4581 ;; Various packages
4582 (declare-function calc-eval "calc" (str &optional separator &rest args))
4583 (declare-function calendar-forward-day "cal-move" (arg))
4584 (declare-function calendar-goto-date "cal-move" (date))
4585 (declare-function calendar-goto-today "cal-move" ())
4586 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4587 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4588 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4589 (declare-function cdlatex-tab "ext:cdlatex" ())
4590 (declare-function dired-get-filename
4591 "dired"
4592 (&optional localp no-error-if-not-filep))
4593 (declare-function iswitchb-read-buffer
4594 "iswitchb"
4595 (prompt &optional
4596 default require-match _predicate start matches-set))
4597 (declare-function org-agenda-change-all-lines
4598 "org-agenda"
4599 (newhead hdmarker &optional fixface just-this))
4600 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4601 "org-agenda"
4602 (&optional end))
4603 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4604 (declare-function org-agenda-format-item
4605 "org-agenda"
4606 (extra txt &optional level category tags dotime
4607 remove-re habitp))
4608 (declare-function org-agenda-maybe-redo "org-agenda" ())
4609 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4610 (declare-function org-agenda-save-markers-for-cut-and-paste
4611 "org-agenda"
4612 (beg end))
4613 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4614 (declare-function org-agenda-skip "org-agenda" ())
4615 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4616 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4617 (declare-function org-indent-mode "org-indent" (&optional arg))
4618 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4619 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4620 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4621 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4622 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4623 (declare-function parse-time-string "parse-time" (string))
4624 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4626 (defvar align-mode-rules-list)
4627 (defvar calc-embedded-close-formula)
4628 (defvar calc-embedded-open-formula)
4629 (defvar calc-embedded-open-mode)
4630 (defvar font-lock-unfontify-region-function)
4631 (defvar iswitchb-temp-buflist)
4632 (defvar org-agenda-tags-todo-honor-ignore-options)
4633 (defvar remember-data-file)
4634 (defvar texmathp-why)
4636 ;;;###autoload
4637 (defun turn-on-orgtbl ()
4638 "Unconditionally turn on `orgtbl-mode'."
4639 (require 'org-table)
4640 (orgtbl-mode 1))
4642 (defun org-at-table-p (&optional table-type)
4643 "Non-nil if the cursor is inside an Org table.
4644 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4645 If `org-enable-table-editor' is nil, return nil unconditionally."
4646 (and
4647 org-enable-table-editor
4648 (save-excursion
4649 (beginning-of-line)
4650 (looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4651 (or (not (derived-mode-p 'org-mode))
4652 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4653 (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4655 (defun org-at-table.el-p ()
4656 "Non-nil when point is at a table.el table."
4657 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4658 (let ((element (org-element-at-point)))
4659 (and (eq (org-element-type element) 'table)
4660 (eq (org-element-property :type element) 'table.el)))))
4662 (defun org-at-table-hline-p ()
4663 "Non-nil when point is inside a hline in a table.
4664 Assume point is already in a table. If `org-enable-table-editor'
4665 is nil, return nil unconditionally."
4666 (and org-enable-table-editor
4667 (save-excursion
4668 (beginning-of-line)
4669 (looking-at org-table-hline-regexp))))
4671 (defun org-table-map-tables (function &optional quietly)
4672 "Apply FUNCTION to the start of all tables in the buffer."
4673 (org-with-wide-buffer
4674 (goto-char (point-min))
4675 (while (re-search-forward org-table-any-line-regexp nil t)
4676 (unless quietly
4677 (message "Mapping tables: %d%%"
4678 (floor (* 100.0 (point)) (buffer-size))))
4679 (beginning-of-line 1)
4680 (when (and (looking-at org-table-line-regexp)
4681 ;; Exclude tables in src/example/verbatim/clocktable blocks
4682 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4683 (save-excursion (funcall function))
4684 (or (looking-at org-table-line-regexp)
4685 (forward-char 1)))
4686 (re-search-forward org-table-any-border-regexp nil 1)))
4687 (unless quietly (message "Mapping tables: done")))
4689 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4690 (declare-function org-clock-update-mode-line "org-clock" ())
4691 (declare-function org-resolve-clocks "org-clock"
4692 (&optional also-non-dangling-p prompt last-valid))
4694 (defun org-at-TBLFM-p (&optional pos)
4695 "Non-nil when point (or POS) is in #+TBLFM line."
4696 (save-excursion
4697 (goto-char (or pos (point)))
4698 (beginning-of-line)
4699 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4700 (eq (org-element-type (org-element-at-point)) 'table))))
4702 (defvar org-clock-start-time)
4703 (defvar org-clock-marker (make-marker)
4704 "Marker recording the last clock-in.")
4705 (defvar org-clock-hd-marker (make-marker)
4706 "Marker recording the last clock-in, but the headline position.")
4707 (defvar org-clock-heading ""
4708 "The heading of the current clock entry.")
4709 (defun org-clock-is-active ()
4710 "Return the buffer where the clock is currently running.
4711 Return nil if no clock is running."
4712 (marker-buffer org-clock-marker))
4714 (defun org-check-running-clock ()
4715 "Check if the current buffer contains the running clock.
4716 If yes, offer to stop it and to save the buffer with the changes."
4717 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4718 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4719 (buffer-name))))
4720 (org-clock-out)
4721 (when (y-or-n-p "Save changed buffer?")
4722 (save-buffer))))
4724 (defun org-clocktable-try-shift (dir n)
4725 "Check if this line starts a clock table, if yes, shift the time block."
4726 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4727 (org-clocktable-shift dir n)))
4729 ;;;###autoload
4730 (defun org-clock-persistence-insinuate ()
4731 "Set up hooks for clock persistence."
4732 (require 'org-clock)
4733 (add-hook 'org-mode-hook 'org-clock-load)
4734 (add-hook 'kill-emacs-hook 'org-clock-save))
4736 (defgroup org-archive nil
4737 "Options concerning archiving in Org mode."
4738 :tag "Org Archive"
4739 :group 'org-structure)
4741 (defcustom org-archive-location "%s_archive::"
4742 "The location where subtrees should be archived.
4744 The value of this variable is a string, consisting of two parts,
4745 separated by a double-colon. The first part is a filename and
4746 the second part is a headline.
4748 When the filename is omitted, archiving happens in the same file.
4749 %s in the filename will be replaced by the current file
4750 name (without the directory part). Archiving to a different file
4751 is useful to keep archived entries from contributing to the
4752 Org Agenda.
4754 The archived entries will be filed as subtrees of the specified
4755 headline. When the headline is omitted, the subtrees are simply
4756 filed away at the end of the file, as top-level entries. Also in
4757 the heading you can use %s to represent the file name, this can be
4758 useful when using the same archive for a number of different files.
4760 Here are a few examples:
4761 \"%s_archive::\"
4762 If the current file is Projects.org, archive in file
4763 Projects.org_archive, as top-level trees. This is the default.
4765 \"::* Archived Tasks\"
4766 Archive in the current file, under the top-level headline
4767 \"* Archived Tasks\".
4769 \"~/org/archive.org::\"
4770 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4772 \"~/org/archive.org::* From %s\"
4773 Archive in file ~/org/archive.org (absolute path), under headlines
4774 \"From FILENAME\" where file name is the current file name.
4776 \"~/org/datetree.org::datetree/* Finished Tasks\"
4777 The \"datetree/\" string is special, signifying to archive
4778 items to the datetree. Items are placed in either the CLOSED
4779 date of the item, or the current date if there is no CLOSED date.
4780 The heading will be a subentry to the current date. There doesn't
4781 need to be a heading, but there always needs to be a slash after
4782 datetree. For example, to store archived items directly in the
4783 datetree, use \"~/org/datetree.org::datetree/\".
4785 \"basement::** Finished Tasks\"
4786 Archive in file ./basement (relative path), as level 3 trees
4787 below the level 2 heading \"** Finished Tasks\".
4789 You may set this option on a per-file basis by adding to the buffer a
4790 line like
4792 #+ARCHIVE: basement::** Finished Tasks
4794 You may also define it locally for a subtree by setting an ARCHIVE property
4795 in the entry. If such a property is found in an entry, or anywhere up
4796 the hierarchy, it will be used."
4797 :group 'org-archive
4798 :type 'string)
4800 (defcustom org-agenda-skip-archived-trees t
4801 "Non-nil means the agenda will skip any items located in archived trees.
4802 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4803 variable is no longer recommended, you should leave it at the value t.
4804 Instead, use the key `v' to cycle the archives-mode in the agenda."
4805 :group 'org-archive
4806 :group 'org-agenda-skip
4807 :type 'boolean)
4809 (defcustom org-columns-skip-archived-trees t
4810 "Non-nil means ignore archived trees when creating column view."
4811 :group 'org-archive
4812 :group 'org-properties
4813 :type 'boolean)
4815 (defcustom org-cycle-open-archived-trees nil
4816 "Non-nil means `org-cycle' will open archived trees.
4817 An archived tree is a tree marked with the tag ARCHIVE.
4818 When nil, archived trees will stay folded. You can still open them with
4819 normal outline commands like `show-all', but not with the cycling commands."
4820 :group 'org-archive
4821 :group 'org-cycle
4822 :type 'boolean)
4824 (defcustom org-sparse-tree-open-archived-trees nil
4825 "Non-nil means sparse tree construction shows matches in archived trees.
4826 When nil, matches in these trees are highlighted, but the trees are kept in
4827 collapsed state."
4828 :group 'org-archive
4829 :group 'org-sparse-trees
4830 :type 'boolean)
4832 (defcustom org-sparse-tree-default-date-type nil
4833 "The default date type when building a sparse tree.
4834 When this is nil, a date is a scheduled or a deadline timestamp.
4835 Otherwise, these types are allowed:
4837 all: all timestamps
4838 active: only active timestamps (<...>)
4839 inactive: only inactive timestamps ([...])
4840 scheduled: only scheduled timestamps
4841 deadline: only deadline timestamps"
4842 :type '(choice (const :tag "Scheduled or deadline" nil)
4843 (const :tag "All timestamps" all)
4844 (const :tag "Only active timestamps" active)
4845 (const :tag "Only inactive timestamps" inactive)
4846 (const :tag "Only scheduled timestamps" scheduled)
4847 (const :tag "Only deadline timestamps" deadline)
4848 (const :tag "Only closed timestamps" closed))
4849 :version "26.1"
4850 :package-version '(Org . "8.3")
4851 :group 'org-sparse-trees)
4853 (defun org-cycle-hide-archived-subtrees (state)
4854 "Re-hide all archived subtrees after a visibility state change."
4855 (when (and (not org-cycle-open-archived-trees)
4856 (not (memq state '(overview folded))))
4857 (save-excursion
4858 (let* ((globalp (memq state '(contents all)))
4859 (beg (if globalp (point-min) (point)))
4860 (end (if globalp (point-max) (org-end-of-subtree t))))
4861 (org-hide-archived-subtrees beg end)
4862 (goto-char beg)
4863 (when (looking-at-p (concat ".*:" org-archive-tag ":"))
4864 (message "%s" (substitute-command-keys
4865 "Subtree is archived and stays closed. Use \
4866 `\\[org-force-cycle-archived]' to cycle it anyway.")))))))
4868 (defun org-force-cycle-archived ()
4869 "Cycle subtree even if it is archived."
4870 (interactive)
4871 (setq this-command 'org-cycle)
4872 (let ((org-cycle-open-archived-trees t))
4873 (call-interactively 'org-cycle)))
4875 (defun org-hide-archived-subtrees (beg end)
4876 "Re-hide all archived subtrees after a visibility state change."
4877 (org-with-wide-buffer
4878 (let ((case-fold-search nil)
4879 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4880 (goto-char beg)
4881 ;; Include headline point is currently on.
4882 (beginning-of-line)
4883 (while (and (< (point) end) (re-search-forward re end t))
4884 (when (member org-archive-tag (org-get-tags))
4885 (org-flag-subtree t)
4886 (org-end-of-subtree t))))))
4888 (declare-function outline-end-of-heading "outline" ())
4889 (declare-function outline-flag-region "outline" (from to flag))
4890 (defun org-flag-subtree (flag)
4891 (save-excursion
4892 (org-back-to-heading t)
4893 (outline-end-of-heading)
4894 (outline-flag-region (point)
4895 (progn (org-end-of-subtree t) (point))
4896 flag)))
4898 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4900 ;; Declare Column View Code
4902 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4903 (declare-function org-columns-compute "org-colview" (property))
4905 ;; Declare ID code
4907 (declare-function org-id-store-link "org-id")
4908 (declare-function org-id-locations-load "org-id")
4909 (declare-function org-id-locations-save "org-id")
4910 (defvar org-id-track-globally)
4912 ;;; Variables for pre-computed regular expressions, all buffer local
4914 (defvar-local org-todo-regexp nil
4915 "Matches any of the TODO state keywords.
4916 Since TODO keywords are case-sensitive, `case-fold-search' is
4917 expected to be bound to nil when matching against this regexp.")
4919 (defvar-local org-not-done-regexp nil
4920 "Matches any of the TODO state keywords except the last one.
4921 Since TODO keywords are case-sensitive, `case-fold-search' is
4922 expected to be bound to nil when matching against this regexp.")
4924 (defvar-local org-not-done-heading-regexp nil
4925 "Matches a TODO headline that is not done.
4926 Since TODO keywords are case-sensitive, `case-fold-search' is
4927 expected to be bound to nil when matching against this regexp.")
4929 (defvar-local org-todo-line-regexp nil
4930 "Matches a headline and puts TODO state into group 2 if present.
4931 Since TODO keywords are case-sensitive, `case-fold-search' is
4932 expected to be bound to nil when matching against this regexp.")
4934 (defvar-local org-complex-heading-regexp nil
4935 "Matches a headline and puts everything into groups:
4937 group 1: Stars
4938 group 2: The TODO keyword, maybe
4939 group 3: Priority cookie
4940 group 4: True headline
4941 group 5: Tags
4943 Since TODO keywords are case-sensitive, `case-fold-search' is
4944 expected to be bound to nil when matching against this regexp.")
4946 (defvar-local org-complex-heading-regexp-format nil
4947 "Printf format to make regexp to match an exact headline.
4948 This regexp will match the headline of any node which has the
4949 exact headline text that is put into the format, but may have any
4950 TODO state, priority and tags.")
4952 (defvar-local org-todo-line-tags-regexp nil
4953 "Matches a headline and puts TODO state into group 2 if present.
4954 Also put tags into group 4 if tags are present.")
4956 (defconst org-plain-time-of-day-regexp
4957 (concat
4958 "\\(\\<[012]?[0-9]"
4959 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4960 "\\(--?"
4961 "\\(\\<[012]?[0-9]"
4962 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4963 "\\)?")
4964 "Regular expression to match a plain time or time range.
4965 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4966 groups carry important information:
4967 0 the full match
4968 1 the first time, range or not
4969 8 the second time, if it is a range.")
4971 (defconst org-plain-time-extension-regexp
4972 (concat
4973 "\\(\\<[012]?[0-9]"
4974 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4975 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4976 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4977 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4978 groups carry important information:
4979 0 the full match
4980 7 hours of duration
4981 9 minutes of duration")
4983 (defconst org-stamp-time-of-day-regexp
4984 (concat
4985 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4986 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4987 "\\(--?"
4988 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4989 "Regular expression to match a timestamp time or time range.
4990 After a match, the following groups carry important information:
4991 0 the full match
4992 1 date plus weekday, for back referencing to make sure both times are on the same day
4993 2 the first time, range or not
4994 4 the second time, if it is a range.")
4996 (defconst org-startup-options
4997 '(("fold" org-startup-folded t)
4998 ("overview" org-startup-folded t)
4999 ("nofold" org-startup-folded nil)
5000 ("showall" org-startup-folded nil)
5001 ("showeverything" org-startup-folded showeverything)
5002 ("content" org-startup-folded content)
5003 ("indent" org-startup-indented t)
5004 ("noindent" org-startup-indented nil)
5005 ("hidestars" org-hide-leading-stars t)
5006 ("showstars" org-hide-leading-stars nil)
5007 ("odd" org-odd-levels-only t)
5008 ("oddeven" org-odd-levels-only nil)
5009 ("align" org-startup-align-all-tables t)
5010 ("noalign" org-startup-align-all-tables nil)
5011 ("inlineimages" org-startup-with-inline-images t)
5012 ("noinlineimages" org-startup-with-inline-images nil)
5013 ("latexpreview" org-startup-with-latex-preview t)
5014 ("nolatexpreview" org-startup-with-latex-preview nil)
5015 ("customtime" org-display-custom-times t)
5016 ("logdone" org-log-done time)
5017 ("lognotedone" org-log-done note)
5018 ("nologdone" org-log-done nil)
5019 ("lognoteclock-out" org-log-note-clock-out t)
5020 ("nolognoteclock-out" org-log-note-clock-out nil)
5021 ("logrepeat" org-log-repeat state)
5022 ("lognoterepeat" org-log-repeat note)
5023 ("logdrawer" org-log-into-drawer t)
5024 ("nologdrawer" org-log-into-drawer nil)
5025 ("logstatesreversed" org-log-states-order-reversed t)
5026 ("nologstatesreversed" org-log-states-order-reversed nil)
5027 ("nologrepeat" org-log-repeat nil)
5028 ("logreschedule" org-log-reschedule time)
5029 ("lognotereschedule" org-log-reschedule note)
5030 ("nologreschedule" org-log-reschedule nil)
5031 ("logredeadline" org-log-redeadline time)
5032 ("lognoteredeadline" org-log-redeadline note)
5033 ("nologredeadline" org-log-redeadline nil)
5034 ("logrefile" org-log-refile time)
5035 ("lognoterefile" org-log-refile note)
5036 ("nologrefile" org-log-refile nil)
5037 ("fninline" org-footnote-define-inline t)
5038 ("nofninline" org-footnote-define-inline nil)
5039 ("fnlocal" org-footnote-section nil)
5040 ("fnauto" org-footnote-auto-label t)
5041 ("fnprompt" org-footnote-auto-label nil)
5042 ("fnconfirm" org-footnote-auto-label confirm)
5043 ("fnplain" org-footnote-auto-label plain)
5044 ("fnadjust" org-footnote-auto-adjust t)
5045 ("nofnadjust" org-footnote-auto-adjust nil)
5046 ("constcgs" constants-unit-system cgs)
5047 ("constSI" constants-unit-system SI)
5048 ("noptag" org-tag-persistent-alist nil)
5049 ("hideblocks" org-hide-block-startup t)
5050 ("nohideblocks" org-hide-block-startup nil)
5051 ("beamer" org-startup-with-beamer-mode t)
5052 ("entitiespretty" org-pretty-entities t)
5053 ("entitiesplain" org-pretty-entities nil))
5054 "Variable associated with STARTUP options for org-mode.
5055 Each element is a list of three items: the startup options (as written
5056 in the #+STARTUP line), the corresponding variable, and the value to set
5057 this variable to if the option is found. An optional forth element PUSH
5058 means to push this value onto the list in the variable.")
5060 (defcustom org-group-tags t
5061 "When non-nil (the default), use group tags.
5062 This can be turned on/off through `org-toggle-tags-groups'."
5063 :group 'org-tags
5064 :group 'org-startup
5065 :type 'boolean)
5067 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
5069 (defun org-toggle-tags-groups ()
5070 "Toggle support for group tags.
5071 Support for group tags is controlled by the option
5072 `org-group-tags', which is non-nil by default."
5073 (interactive)
5074 (setq org-group-tags (not org-group-tags))
5075 (cond ((and (derived-mode-p 'org-agenda-mode)
5076 org-group-tags)
5077 (org-agenda-redo))
5078 ((derived-mode-p 'org-mode)
5079 (let ((org-inhibit-startup t)) (org-mode))))
5080 (message "Groups tags support has been turned %s"
5081 (if org-group-tags "on" "off")))
5083 (defun org-set-regexps-and-options (&optional tags-only)
5084 "Precompute regular expressions used in the current buffer.
5085 When optional argument TAGS-ONLY is non-nil, only compute tags
5086 related expressions."
5087 (when (derived-mode-p 'org-mode)
5088 (let ((alist (org--setup-collect-keywords
5089 (org-make-options-regexp
5090 (append '("FILETAGS" "TAGS" "SETUPFILE")
5091 (and (not tags-only)
5092 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
5093 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
5094 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
5095 ;; Startup options. Get this early since it does change
5096 ;; behavior for other options (e.g., tags).
5097 (let ((startup (cdr (assq 'startup alist))))
5098 (dolist (option startup)
5099 (let ((entry (assoc-string option org-startup-options t)))
5100 (when entry
5101 (let ((var (nth 1 entry))
5102 (val (nth 2 entry)))
5103 (if (not (nth 3 entry)) (set (make-local-variable var) val)
5104 (unless (listp (symbol-value var))
5105 (set (make-local-variable var) nil))
5106 (add-to-list var val)))))))
5107 (setq-local org-file-tags
5108 (mapcar #'org-add-prop-inherited
5109 (cdr (assq 'filetags alist))))
5110 (setq org-current-tag-alist
5111 (append org-tag-persistent-alist
5112 (let ((tags (cdr (assq 'tags alist))))
5113 (if tags (org-tag-string-to-alist tags)
5114 org-tag-alist))))
5115 (setq org-tag-groups-alist
5116 (org-tag-alist-to-groups org-current-tag-alist))
5117 (unless tags-only
5118 ;; File properties.
5119 (setq-local org-file-properties (cdr (assq 'property alist)))
5120 ;; Archive location.
5121 (let ((archive (cdr (assq 'archive alist))))
5122 (when archive (setq-local org-archive-location archive)))
5123 ;; Category.
5124 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
5125 (when cat
5126 (setq-local org-category (intern cat))
5127 (setq-local org-file-properties
5128 (org--update-property-plist
5129 "CATEGORY" cat org-file-properties))))
5130 ;; Columns.
5131 (let ((column (cdr (assq 'columns alist))))
5132 (when column (setq-local org-columns-default-format column)))
5133 ;; Constants.
5134 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
5135 ;; Link abbreviations.
5136 (let ((links (cdr (assq 'link alist))))
5137 (when links (setq org-link-abbrev-alist-local (nreverse links))))
5138 ;; Priorities.
5139 (let ((priorities (cdr (assq 'priorities alist))))
5140 (when priorities
5141 (setq-local org-highest-priority (nth 0 priorities))
5142 (setq-local org-lowest-priority (nth 1 priorities))
5143 (setq-local org-default-priority (nth 2 priorities))))
5144 ;; Scripts.
5145 (let ((scripts (assq 'scripts alist)))
5146 (when scripts
5147 (setq-local org-use-sub-superscripts (cdr scripts))))
5148 ;; TODO keywords.
5149 (setq-local org-todo-kwd-alist nil)
5150 (setq-local org-todo-key-alist nil)
5151 (setq-local org-todo-key-trigger nil)
5152 (setq-local org-todo-keywords-1 nil)
5153 (setq-local org-done-keywords nil)
5154 (setq-local org-todo-heads nil)
5155 (setq-local org-todo-sets nil)
5156 (setq-local org-todo-log-states nil)
5157 (let ((todo-sequences
5158 (or (nreverse (cdr (assq 'todo alist)))
5159 (let ((d (default-value 'org-todo-keywords)))
5160 (if (not (stringp (car d))) d
5161 ;; XXX: Backward compatibility code.
5162 (list (cons org-todo-interpretation d)))))))
5163 (dolist (sequence todo-sequences)
5164 (let* ((sequence (or (run-hook-with-args-until-success
5165 'org-todo-setup-filter-hook sequence)
5166 sequence))
5167 (sequence-type (car sequence))
5168 (keywords (cdr sequence))
5169 (sep (member "|" keywords))
5170 names alist)
5171 (dolist (k (remove "|" keywords))
5172 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5174 (error "Invalid TODO keyword %s" k))
5175 (let ((name (match-string 1 k))
5176 (key (match-string 2 k))
5177 (log (org-extract-log-state-settings k)))
5178 (push name names)
5179 (push (cons name (and key (string-to-char key))) alist)
5180 (when log (push log org-todo-log-states))))
5181 (let* ((names (nreverse names))
5182 (done (if sep (org-remove-keyword-keys (cdr sep))
5183 (last names)))
5184 (head (car names))
5185 (tail (list sequence-type head (car done) (org-last done))))
5186 (add-to-list 'org-todo-heads head 'append)
5187 (push names org-todo-sets)
5188 (setq org-done-keywords (append org-done-keywords done nil))
5189 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5190 (setq org-todo-key-alist
5191 (append org-todo-key-alist
5192 (and alist
5193 (append '((:startgroup))
5194 (nreverse alist)
5195 '((:endgroup))))))
5196 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5197 (setq org-todo-sets (nreverse org-todo-sets)
5198 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5199 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5200 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5201 ;; Compute the regular expressions and other local variables.
5202 ;; Using `org-outline-regexp-bol' would complicate them much,
5203 ;; because of the fixed white space at the end of that string.
5204 (unless org-done-keywords
5205 (setq org-done-keywords
5206 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5207 (setq org-not-done-keywords
5208 (org-delete-all org-done-keywords
5209 (copy-sequence org-todo-keywords-1))
5210 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5211 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5212 org-not-done-heading-regexp
5213 (format org-heading-keyword-regexp-format org-not-done-regexp)
5214 org-todo-line-regexp
5215 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5216 org-complex-heading-regexp
5217 (concat "^\\(\\*+\\)"
5218 "\\(?: +" org-todo-regexp "\\)?"
5219 "\\(?: +\\(\\[#.\\]\\)\\)?"
5220 "\\(?: +\\(.*?\\)\\)??"
5221 "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?"
5222 "[ \t]*$")
5223 org-complex-heading-regexp-format
5224 (concat "^\\(\\*+\\)"
5225 "\\(?: +" org-todo-regexp "\\)?"
5226 "\\(?: +\\(\\[#.\\]\\)\\)?"
5227 "\\(?: +"
5228 ;; Stats cookies can be stuck to body.
5229 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5230 "\\(%s\\)"
5231 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5232 "\\)"
5233 "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?"
5234 "[ \t]*$")
5235 org-todo-line-tags-regexp
5236 (concat "^\\(\\*+\\)"
5237 "\\(?: +" org-todo-regexp "\\)?"
5238 "\\(?: +\\(.*?\\)\\)??"
5239 "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?"
5240 "[ \t]*$"))
5241 (org-compute-latex-and-related-regexp)))))
5243 (defun org--setup-collect-keywords (regexp &optional files alist)
5244 "Return setup keywords values as an alist.
5246 REGEXP matches a subset of setup keywords. FILES is a list of
5247 file names already visited. It is used to avoid circular setup
5248 files. ALIST, when non-nil, is the alist computed so far.
5250 Return value contains the following keys: `archive', `category',
5251 `columns', `constants', `filetags', `link', `priorities',
5252 `property', `scripts', `startup', `tags' and `todo'."
5253 (org-with-wide-buffer
5254 (goto-char (point-min))
5255 (let ((case-fold-search t))
5256 (while (re-search-forward regexp nil t)
5257 (let ((element (org-element-at-point)))
5258 (when (eq (org-element-type element) 'keyword)
5259 (let ((key (org-element-property :key element))
5260 (value (org-element-property :value element)))
5261 (cond
5262 ((equal key "ARCHIVE")
5263 (when (org-string-nw-p value)
5264 (push (cons 'archive value) alist)))
5265 ((equal key "CATEGORY") (push (cons 'category value) alist))
5266 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5267 ((equal key "CONSTANTS")
5268 (let* ((constants (assq 'constants alist))
5269 (store (cdr constants)))
5270 (dolist (pair (org-split-string value))
5271 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5272 pair)
5273 (let* ((name (match-string 1 pair))
5274 (value (match-string 2 pair))
5275 (old (assoc name store)))
5276 (if old (setcdr old value)
5277 (push (cons name value) store)))))
5278 (if constants (setcdr constants store)
5279 (push (cons 'constants store) alist))))
5280 ((equal key "FILETAGS")
5281 (when (org-string-nw-p value)
5282 (let ((old (assq 'filetags alist))
5283 (new (apply #'nconc
5284 (mapcar (lambda (x) (org-split-string x ":"))
5285 (org-split-string value)))))
5286 (if old (setcdr old (append new (cdr old)))
5287 (push (cons 'filetags new) alist)))))
5288 ((equal key "LINK")
5289 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5290 (let ((links (assq 'link alist))
5291 (pair (cons (match-string-no-properties 1 value)
5292 (match-string-no-properties 2 value))))
5293 (if links (push pair (cdr links))
5294 (push (list 'link pair) alist)))))
5295 ((equal key "OPTIONS")
5296 (when (and (org-string-nw-p value)
5297 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5298 (push (cons 'scripts (read (match-string 1 value))) alist)))
5299 ((equal key "PRIORITIES")
5300 (push (cons 'priorities
5301 (let ((prio (org-split-string value)))
5302 (if (< (length prio) 3) '(?A ?C ?B)
5303 (mapcar #'string-to-char prio))))
5304 alist))
5305 ((equal key "PROPERTY")
5306 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5307 (let* ((property (assq 'property alist))
5308 (value (org--update-property-plist
5309 (match-string-no-properties 1 value)
5310 (match-string-no-properties 2 value)
5311 (cdr property))))
5312 (if property (setcdr property value)
5313 (push (cons 'property value) alist)))))
5314 ((equal key "STARTUP")
5315 (let ((startup (assq 'startup alist)))
5316 (if startup
5317 (setcdr startup
5318 (append (cdr startup) (org-split-string value)))
5319 (push (cons 'startup (org-split-string value)) alist))))
5320 ((equal key "TAGS")
5321 (let ((tag-cell (assq 'tags alist)))
5322 (if tag-cell
5323 (setcdr tag-cell (concat (cdr tag-cell) "\n" value))
5324 (push (cons 'tags value) alist))))
5325 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5326 (let ((todo (assq 'todo alist))
5327 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5328 (org-split-string value))))
5329 (if todo (push value (cdr todo))
5330 (push (list 'todo value) alist))))
5331 ((equal key "SETUPFILE")
5332 (unless buffer-read-only ; Do not check in Gnus messages.
5333 (let ((f (and (org-string-nw-p value)
5334 (expand-file-name
5335 (org-unbracket-string "\"" "\"" value)))))
5336 (when (and f (file-readable-p f) (not (member f files)))
5337 (with-temp-buffer
5338 (setq default-directory (file-name-directory f))
5339 (insert-file-contents f)
5340 (setq alist
5341 ;; Fake Org mode to benefit from cache
5342 ;; without recurring needlessly.
5343 (let ((major-mode 'org-mode))
5344 (org--setup-collect-keywords
5345 regexp (cons f files) alist)))))))))))))))
5346 alist)
5348 (defun org-tag-string-to-alist (s)
5349 "Return tag alist associated to string S.
5350 S is a value for TAGS keyword or produced with
5351 `org-tag-alist-to-string'. Return value is an alist suitable for
5352 `org-tag-alist' or `org-tag-persistent-alist'."
5353 (let ((lines (mapcar #'split-string (split-string s "\n" t)))
5354 (tag-re (concat "\\`\\([[:alnum:]_@#%]+"
5355 "\\|{.+?}\\)" ; regular expression
5356 "\\(?:(\\(.\\))\\)?\\'"))
5357 alist group-flag)
5358 (dolist (tokens lines (cdr (nreverse alist)))
5359 (push '(:newline) alist)
5360 (while tokens
5361 (let ((token (pop tokens)))
5362 (pcase token
5363 ("{"
5364 (push '(:startgroup) alist)
5365 (when (equal (nth 1 tokens) ":") (setq group-flag t)))
5366 ("}"
5367 (push '(:endgroup) alist)
5368 (setq group-flag nil))
5369 ("["
5370 (push '(:startgrouptag) alist)
5371 (when (equal (nth 1 tokens) ":") (setq group-flag t)))
5372 ("]"
5373 (push '(:endgrouptag) alist)
5374 (setq group-flag nil))
5375 (":"
5376 (push '(:grouptags) alist))
5377 ((guard (string-match tag-re token))
5378 (let ((tag (match-string 1 token))
5379 (key (and (match-beginning 2)
5380 (string-to-char (match-string 2 token)))))
5381 ;; Push all tags in groups, no matter if they already
5382 ;; appear somewhere else in the list.
5383 (when (or group-flag (not (assoc tag alist)))
5384 (push (cons tag key) alist))))))))))
5386 (defun org-tag-alist-to-string (alist &optional skip-key)
5387 "Return tag string associated to ALIST.
5389 ALIST is an alist, as defined in `org-tag-alist' or
5390 `org-tag-persistent-alist', or produced with
5391 `org-tag-string-to-alist'.
5393 Return value is a string suitable as a value for \"TAGS\"
5394 keyword.
5396 When optional argument SKIP-KEY is non-nil, skip selection keys
5397 next to tags."
5398 (mapconcat (lambda (token)
5399 (pcase token
5400 (`(:startgroup) "{")
5401 (`(:endgroup) "}")
5402 (`(:startgrouptag) "[")
5403 (`(:endgrouptag) "]")
5404 (`(:grouptags) ":")
5405 (`(:newline) "\\n")
5406 ((and
5407 (guard (not skip-key))
5408 `(,(and tag (pred stringp)) . ,(and key (pred characterp))))
5409 (format "%s(%c)" tag key))
5410 (`(,(and tag (pred stringp)) . ,_) tag)
5411 (_ (user-error "Invalid tag token: %S" token))))
5412 alist
5413 " "))
5415 (defun org-tag-alist-to-groups (alist)
5416 "Return group alist from tag ALIST.
5417 ALIST is an alist, as defined in `org-tag-alist' or
5418 `org-tag-persistent-alist', or produced with
5419 `org-tag-string-to-alist'. Return value is an alist following
5420 the pattern (GROUP-TAG TAGS) where GROUP-TAG is the tag, as
5421 a string, summarizing TAGS, as a list of strings."
5422 (let (groups group-status current-group)
5423 (dolist (token alist (nreverse groups))
5424 (pcase token
5425 (`(,(or :startgroup :startgrouptag)) (setq group-status t))
5426 (`(,(or :endgroup :endgrouptag))
5427 (when (eq group-status 'append)
5428 (push (nreverse current-group) groups))
5429 (setq group-status nil))
5430 (`(:grouptags) (setq group-status 'append))
5431 ((and `(,tag . ,_) (guard group-status))
5432 (if (eq group-status 'append) (push tag current-group)
5433 (setq current-group (list tag))))
5434 (_ nil)))))
5436 (defun org-file-contents (file &optional noerror)
5437 "Return the contents of FILE, as a string."
5438 (if (and file (file-readable-p file))
5439 (with-temp-buffer
5440 (insert-file-contents file)
5441 (buffer-string))
5442 (funcall (if noerror 'message 'error)
5443 "Cannot read file \"%s\"%s"
5444 file
5445 (let ((from (buffer-file-name (buffer-base-buffer))))
5446 (if from (concat " (referenced in file \"" from "\")") "")))))
5448 (defun org-extract-log-state-settings (x)
5449 "Extract the log state setting from a TODO keyword string.
5450 This will extract info from a string like \"WAIT(w@/!)\"."
5451 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5452 (let ((kw (match-string 1 x))
5453 (log1 (and (match-end 3) (match-string 3 x)))
5454 (log2 (and (match-end 4) (match-string 4 x))))
5455 (and (or log1 log2)
5456 (list kw
5457 (and log1 (if (equal log1 "!") 'time 'note))
5458 (and log2 (if (equal log2 "!") 'time 'note)))))))
5460 (defun org-remove-keyword-keys (list)
5461 "Remove a pair of parenthesis at the end of each string in LIST."
5462 (mapcar (lambda (x)
5463 (if (string-match "(.*)$" x)
5464 (substring x 0 (match-beginning 0))
5466 list))
5468 (defun org-assign-fast-keys (alist)
5469 "Assign fast keys to a keyword-key alist.
5470 Respect keys that are already there."
5471 (let (new e (alt ?0))
5472 (while (setq e (pop alist))
5473 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5474 (cdr e)) ;; Key already assigned.
5475 (push e new)
5476 (let ((clist (string-to-list (downcase (car e))))
5477 (used (append new alist)))
5478 (when (= (car clist) ?@)
5479 (pop clist))
5480 (while (and clist (rassoc (car clist) used))
5481 (pop clist))
5482 (unless clist
5483 (while (rassoc alt used)
5484 (cl-incf alt)))
5485 (push (cons (car e) (or (car clist) alt)) new))))
5486 (nreverse new)))
5488 ;;; Some variables used in various places
5490 (defvar org-window-configuration nil
5491 "Used in various places to store a window configuration.")
5492 (defvar org-selected-window nil
5493 "Used in various places to store a window configuration.")
5494 (defvar org-finish-function nil
5495 "Function to be called when `C-c C-c' is used.
5496 This is for getting out of special buffers like capture.")
5497 (defvar org-last-state)
5499 ;; Defined somewhere in this file, but used before definition.
5500 (defvar org-entities) ;; defined in org-entities.el
5501 (defvar org-struct-menu)
5502 (defvar org-org-menu)
5503 (defvar org-tbl-menu)
5505 ;;;; Define the Org mode
5507 ;; We use a before-change function to check if a table might need
5508 ;; an update.
5509 (defvar org-table-may-need-update t
5510 "Indicates that a table might need an update.
5511 This variable is set by `org-before-change-function'.
5512 `org-table-align' sets it back to nil.")
5513 (defun org-before-change-function (_beg _end)
5514 "Every change indicates that a table might need an update."
5515 (setq org-table-may-need-update t))
5516 (defvar org-mode-map)
5517 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5518 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5519 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5520 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5521 (defvar org-table-buffer-is-an nil)
5523 (defvar bidi-paragraph-direction)
5524 (defvar buffer-face-mode-face)
5526 (require 'outline)
5528 ;; Other stuff we need.
5529 (require 'time-date)
5530 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5531 (require 'easymenu)
5532 (autoload 'easy-menu-add "easymenu")
5533 (require 'overlay)
5535 ;; (require 'org-macs) moved higher up in the file before it is first used
5536 (require 'org-entities)
5537 ;; (require 'org-compat) moved higher up in the file before it is first used
5538 (require 'org-faces)
5539 (require 'org-list)
5540 (require 'org-pcomplete)
5541 (require 'org-src)
5542 (require 'org-footnote)
5543 (require 'org-macro)
5545 ;; babel
5546 (require 'ob)
5548 ;;;###autoload
5549 (define-derived-mode org-mode outline-mode "Org"
5550 "Outline-based notes management and organizer, alias
5551 \"Carsten's outline-mode for keeping track of everything.\"
5553 Org mode develops organizational tasks around a NOTES file which
5554 contains information about projects as plain text. Org mode is
5555 implemented on top of Outline mode, which is ideal to keep the content
5556 of large files well structured. It supports ToDo items, deadlines and
5557 time stamps, which magically appear in the diary listing of the Emacs
5558 calendar. Tables are easily created with a built-in table editor.
5559 Plain text URL-like links connect to websites, emails (VM), Usenet
5560 messages (Gnus), BBDB entries, and any files related to the project.
5561 For printing and sharing of notes, an Org file (or a part of it)
5562 can be exported as a structured ASCII or HTML file.
5564 The following commands are available:
5566 \\{org-mode-map}"
5568 ;; Get rid of Outline menus, they are not needed
5569 ;; Need to do this here because define-derived-mode sets up
5570 ;; the keymap so late. Still, it is a waste to call this each time
5571 ;; we switch another buffer into Org mode.
5572 (define-key org-mode-map [menu-bar headings] 'undefined)
5573 (define-key org-mode-map [menu-bar hide] 'undefined)
5574 (define-key org-mode-map [menu-bar show] 'undefined)
5576 (org-load-modules-maybe)
5577 (org-install-agenda-files-menu)
5578 (when org-descriptive-links (add-to-invisibility-spec '(org-link)))
5579 (add-to-invisibility-spec '(org-cwidth))
5580 (add-to-invisibility-spec '(org-hide-block . t))
5581 (setq-local outline-regexp org-outline-regexp)
5582 (setq-local outline-level 'org-outline-level)
5583 (setq bidi-paragraph-direction 'left-to-right)
5584 (when (and org-ellipsis
5585 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5586 (fboundp 'make-glyph-code))
5587 (unless org-display-table
5588 (setq org-display-table (make-display-table)))
5589 (set-display-table-slot
5590 org-display-table 4
5591 (vconcat (mapcar (lambda (c) (make-glyph-code c 'org-ellipsis))
5592 (if (stringp org-ellipsis) org-ellipsis "..."))))
5593 (setq buffer-display-table org-display-table))
5594 (org-set-regexps-and-options)
5595 (org-set-font-lock-defaults)
5596 (when (and org-tag-faces (not org-tags-special-faces-re))
5597 ;; tag faces set outside customize.... force initialization.
5598 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5599 ;; Calc embedded
5600 (setq-local calc-embedded-open-mode "# ")
5601 ;; Modify a few syntax entries
5602 (modify-syntax-entry ?@ "w")
5603 (modify-syntax-entry ?\" "\"")
5604 (modify-syntax-entry ?\\ "_")
5605 (modify-syntax-entry ?~ "_")
5606 (setq-local font-lock-unfontify-region-function 'org-unfontify-region)
5607 ;; Activate before-change-function
5608 (setq-local org-table-may-need-update t)
5609 (add-hook 'before-change-functions 'org-before-change-function nil 'local)
5610 ;; Check for running clock before killing a buffer
5611 (add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5612 ;; Initialize macros templates.
5613 (org-macro-initialize-templates)
5614 ;; Initialize radio targets.
5615 (org-update-radio-target-regexp)
5616 ;; Indentation.
5617 (setq-local indent-line-function 'org-indent-line)
5618 (setq-local indent-region-function 'org-indent-region)
5619 ;; Filling and auto-filling.
5620 (org-setup-filling)
5621 ;; Comments.
5622 (org-setup-comments-handling)
5623 ;; Initialize cache.
5624 (org-element-cache-reset)
5625 ;; Beginning/end of defun
5626 (setq-local beginning-of-defun-function 'org-backward-element)
5627 (setq-local end-of-defun-function
5628 (lambda ()
5629 (if (not (org-at-heading-p))
5630 (org-forward-element)
5631 (org-forward-element)
5632 (forward-char -1))))
5633 ;; Next error for sparse trees
5634 (setq-local next-error-function 'org-occur-next-match)
5635 ;; Make sure dependence stuff works reliably, even for users who set it
5636 ;; too late :-(
5637 (if org-enforce-todo-dependencies
5638 (add-hook 'org-blocker-hook
5639 'org-block-todo-from-children-or-siblings-or-parent)
5640 (remove-hook 'org-blocker-hook
5641 'org-block-todo-from-children-or-siblings-or-parent))
5642 (if org-enforce-todo-checkbox-dependencies
5643 (add-hook 'org-blocker-hook
5644 'org-block-todo-from-checkboxes)
5645 (remove-hook 'org-blocker-hook
5646 'org-block-todo-from-checkboxes))
5648 ;; Align options lines
5649 (setq-local
5650 align-mode-rules-list
5651 '((org-in-buffer-settings
5652 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5653 (modes . '(org-mode)))))
5655 ;; Imenu
5656 (setq-local imenu-create-index-function 'org-imenu-get-tree)
5658 ;; Make isearch reveal context
5659 (setq-local outline-isearch-open-invisible-function
5660 (lambda (&rest _) (org-show-context 'isearch)))
5662 ;; Setup the pcomplete hooks
5663 (setq-local pcomplete-command-completion-function 'org-pcomplete-initial)
5664 (setq-local pcomplete-command-name-function 'org-command-at-point)
5665 (setq-local pcomplete-default-completion-function 'ignore)
5666 (setq-local pcomplete-parse-arguments-function 'org-parse-arguments)
5667 (setq-local pcomplete-termination-string "")
5668 (setq-local buffer-face-mode-face 'org-default)
5670 ;; If empty file that did not turn on Org mode automatically, make
5671 ;; it to.
5672 (when (and org-insert-mode-line-in-empty-file
5673 (called-interactively-p 'any)
5674 (= (point-min) (point-max)))
5675 (insert "# -*- mode: org -*-\n\n"))
5676 (unless org-inhibit-startup
5677 (org-unmodified
5678 (when org-startup-with-beamer-mode (org-beamer-mode))
5679 (when org-startup-align-all-tables
5680 (org-table-map-tables #'org-table-align t))
5681 (when org-startup-with-inline-images (org-display-inline-images))
5682 (when org-startup-with-latex-preview (org-toggle-latex-fragment))
5683 (unless org-inhibit-startup-visibility-stuff (org-set-startup-visibility))
5684 (when org-startup-truncated (setq truncate-lines t))
5685 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5686 (org-refresh-effort-properties)))
5687 ;; Try to set `org-hide' face correctly.
5688 (let ((foreground (org-find-invisible-foreground)))
5689 (when foreground
5690 (set-face-foreground 'org-hide foreground))))
5692 ;; Update `customize-package-emacs-version-alist'
5693 (add-to-list 'customize-package-emacs-version-alist
5694 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5695 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5696 ("8.2.6" . "24.4") ("8.2.10" . "24.5")
5697 ("9.0" . "26.1")))
5699 (defvar org-mode-transpose-word-syntax-table
5700 (let ((st (make-syntax-table text-mode-syntax-table)))
5701 (dolist (c org-emphasis-alist st)
5702 (modify-syntax-entry (string-to-char (car c)) "w p" st))))
5704 (when (fboundp 'abbrev-table-put)
5705 (abbrev-table-put org-mode-abbrev-table
5706 :parents (list text-mode-abbrev-table)))
5708 (defun org-find-invisible-foreground ()
5709 (let ((candidates (remove
5710 "unspecified-bg"
5711 (nconc
5712 (list (face-background 'default)
5713 (face-background 'org-default))
5714 (mapcar
5715 (lambda (alist)
5716 (when (boundp alist)
5717 (cdr (assq 'background-color (symbol-value alist)))))
5718 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5719 (list (face-foreground 'org-hide))))))
5720 (car (remove nil candidates))))
5722 (defun org-current-time (&optional rounding-minutes past)
5723 "Current time, possibly rounded to ROUNDING-MINUTES.
5724 When ROUNDING-MINUTES is not an integer, fall back on the car of
5725 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5726 the rounding returns a past time."
5727 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5728 (car org-time-stamp-rounding-minutes)))
5729 (time (decode-time)) res)
5730 (if (< r 1)
5731 (current-time)
5732 (setq res
5733 (apply 'encode-time
5734 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5735 (nthcdr 2 time))))
5736 (if (and past (< (float-time (time-subtract (current-time) res)) 0))
5737 (seconds-to-time (- (float-time res) (* r 60)))
5738 res))))
5740 (defun org-today ()
5741 "Return today date, considering `org-extend-today-until'."
5742 (time-to-days
5743 (time-subtract (current-time)
5744 (list 0 (* 3600 org-extend-today-until) 0))))
5746 ;;;; Font-Lock stuff, including the activators
5748 (defvar org-mouse-map (make-sparse-keymap))
5749 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5750 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5751 (when org-mouse-1-follows-link
5752 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5753 (when org-tab-follows-link
5754 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5755 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5757 (require 'font-lock)
5759 (defconst org-non-link-chars "]\t\n\r<>")
5760 (defvar org-link-types-re nil
5761 "Matches a link that has a url-like prefix like \"http:\"")
5762 (defvar org-link-re-with-space nil
5763 "Matches a link with spaces, optional angular brackets around it.")
5764 (defvar org-link-re-with-space2 nil
5765 "Matches a link with spaces, optional angular brackets around it.")
5766 (defvar org-link-re-with-space3 nil
5767 "Matches a link with spaces, only for internal part in bracket links.")
5768 (defvar org-angle-link-re nil
5769 "Matches link with angular brackets, spaces are allowed.")
5770 (defvar org-plain-link-re nil
5771 "Matches plain link, without spaces.")
5772 (defvar org-bracket-link-regexp nil
5773 "Matches a link in double brackets.")
5774 (defvar org-bracket-link-analytic-regexp nil
5775 "Regular expression used to analyze links.
5776 Here is what the match groups contain after a match:
5777 1: http:
5778 2: http
5779 3: path
5780 4: [desc]
5781 5: desc")
5782 (defvar org-bracket-link-analytic-regexp++ nil
5783 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5784 (defvar org-any-link-re nil
5785 "Regular expression matching any link.")
5787 (defconst org-match-sexp-depth 3
5788 "Number of stacked braces for sub/superscript matching.")
5790 (defun org-create-multibrace-regexp (left right n)
5791 "Create a regular expression which will match a balanced sexp.
5792 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5793 as single character strings.
5794 The regexp returned will match the entire expression including the
5795 delimiters. It will also define a single group which contains the
5796 match except for the outermost delimiters. The maximum depth of
5797 stacked delimiters is N. Escaping delimiters is not possible."
5798 (let* ((nothing (concat "[^" left right "]*?"))
5799 (or "\\|")
5800 (re nothing)
5801 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5802 (while (> n 1)
5803 (setq n (1- n)
5804 re (concat re or next)
5805 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5806 (concat left "\\(" re "\\)" right)))
5808 (defconst org-match-substring-regexp
5809 (concat
5810 "\\(\\S-\\)\\([_^]\\)\\("
5811 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5812 "\\|"
5813 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5814 "\\|"
5815 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5816 "The regular expression matching a sub- or superscript.")
5818 (defconst org-match-substring-with-braces-regexp
5819 (concat
5820 "\\(\\S-\\)\\([_^]\\)"
5821 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5822 "The regular expression matching a sub- or superscript, forcing braces.")
5824 (defun org-make-link-regexps ()
5825 "Update the link regular expressions.
5826 This should be called after the variable `org-link-parameters' has changed."
5827 (let ((types-re (regexp-opt (org-link-types) t)))
5828 (setq org-link-types-re
5829 (concat "\\`" types-re ":")
5830 org-link-re-with-space
5831 (concat "<?" types-re ":"
5832 "\\([^" org-non-link-chars " ]"
5833 "[^" org-non-link-chars "]*"
5834 "[^" org-non-link-chars " ]\\)>?")
5835 org-link-re-with-space2
5836 (concat "<?" types-re ":"
5837 "\\([^" org-non-link-chars " ]"
5838 "[^\t\n\r]*"
5839 "[^" org-non-link-chars " ]\\)>?")
5840 org-link-re-with-space3
5841 (concat "<?" types-re ":"
5842 "\\([^" org-non-link-chars " ]"
5843 "[^\t\n\r]*\\)")
5844 org-angle-link-re
5845 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
5846 types-re)
5847 org-plain-link-re
5848 (concat
5849 "\\<" types-re ":"
5850 "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)")
5851 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5852 org-bracket-link-regexp
5853 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5854 org-bracket-link-analytic-regexp
5855 (concat
5856 "\\[\\["
5857 "\\(" types-re ":\\)?"
5858 "\\([^]]+\\)"
5859 "\\]"
5860 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5861 "\\]")
5862 org-bracket-link-analytic-regexp++
5863 (concat
5864 "\\[\\["
5865 "\\(" (regexp-opt (cons "coderef" (org-link-types)) t) ":\\)?"
5866 "\\([^]]+\\)"
5867 "\\]"
5868 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5869 "\\]")
5870 org-any-link-re
5871 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5872 org-angle-link-re "\\)\\|\\("
5873 org-plain-link-re "\\)"))))
5875 (org-make-link-regexps)
5877 (defvar org-emph-face nil)
5879 (defun org-do-emphasis-faces (limit)
5880 "Run through the buffer and emphasize strings."
5881 (let (rtn a)
5882 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5883 (let* ((border (char-after (match-beginning 3)))
5884 (bre (regexp-quote (char-to-string border))))
5885 (when (and (not (= border (char-after (match-beginning 4))))
5886 (not (string-match-p (concat bre ".*" bre)
5887 (replace-regexp-in-string
5888 "\n" " "
5889 (substring (match-string 2) 1 -1)))))
5890 (setq rtn t)
5891 (setq a (assoc (match-string 3) org-emphasis-alist))
5892 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5893 'face
5894 (nth 1 a))
5895 (and (nth 2 a)
5896 (org-remove-flyspell-overlays-in
5897 (match-beginning 0) (match-end 0)))
5898 (add-text-properties (match-beginning 2) (match-end 2)
5899 '(font-lock-multiline t org-emphasis t))
5900 (when org-hide-emphasis-markers
5901 (add-text-properties (match-end 4) (match-beginning 5)
5902 '(invisible org-link))
5903 (add-text-properties (match-beginning 3) (match-end 3)
5904 '(invisible org-link)))))
5905 (goto-char (1+ (match-beginning 0))))
5906 rtn))
5908 (defun org-emphasize (&optional char)
5909 "Insert or change an emphasis, i.e. a font like bold or italic.
5910 If there is an active region, change that region to a new emphasis.
5911 If there is no region, just insert the marker characters and position
5912 the cursor between them.
5913 CHAR should be the marker character. If it is a space, it means to
5914 remove the emphasis of the selected region.
5915 If CHAR is not given (for example in an interactive call) it will be
5916 prompted for."
5917 (interactive)
5918 (let ((erc org-emphasis-regexp-components)
5919 (string "") beg end move s)
5920 (if (org-region-active-p)
5921 (setq beg (region-beginning)
5922 end (region-end)
5923 string (buffer-substring beg end))
5924 (setq move t))
5926 (unless char
5927 (message "Emphasis marker or tag: [%s]"
5928 (mapconcat #'car org-emphasis-alist ""))
5929 (setq char (read-char-exclusive)))
5930 (if (equal char ?\s)
5931 (setq s ""
5932 move nil)
5933 (unless (assoc (char-to-string char) org-emphasis-alist)
5934 (user-error "No such emphasis marker: \"%c\"" char))
5935 (setq s (char-to-string char)))
5936 (while (and (> (length string) 1)
5937 (equal (substring string 0 1) (substring string -1))
5938 (assoc (substring string 0 1) org-emphasis-alist))
5939 (setq string (substring string 1 -1)))
5940 (setq string (concat s string s))
5941 (when beg (delete-region beg end))
5942 (unless (or (bolp)
5943 (string-match (concat "[" (nth 0 erc) "\n]")
5944 (char-to-string (char-before (point)))))
5945 (insert " "))
5946 (unless (or (eobp)
5947 (string-match (concat "[" (nth 1 erc) "\n]")
5948 (char-to-string (char-after (point)))))
5949 (insert " ") (backward-char 1))
5950 (insert string)
5951 (and move (backward-char 1))))
5953 (defconst org-nonsticky-props
5954 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5956 (defsubst org-rear-nonsticky-at (pos)
5957 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5959 (defun org-activate-plain-links (limit)
5960 "Add link properties for plain links."
5961 (when (and (re-search-forward org-plain-link-re limit t)
5962 (not (org-in-src-block-p)))
5964 (let* ((face (get-text-property (max (1- (match-beginning 0)) (point-min))
5965 'face))
5966 (link (match-string-no-properties 0))
5967 (type (match-string-no-properties 1))
5968 (path (match-string-no-properties 2))
5969 (link-start (match-beginning 0))
5970 (link-end (match-end 0))
5971 (link-face (org-link-get-parameter type :face))
5972 (help-echo (org-link-get-parameter type :help-echo))
5973 (htmlize-link (org-link-get-parameter type :htmlize-link))
5974 (activate-func (org-link-get-parameter type :activate-func)))
5975 (unless (if (consp face) (memq 'org-tag face) (eq 'org-tag face))
5976 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5977 (add-text-properties (match-beginning 0) (match-end 0)
5978 (list
5979 'mouse-face (or (org-link-get-parameter type :mouse-face)
5980 'highlight)
5981 'face (cond
5982 ;; A function that returns a face
5983 ((functionp link-face)
5984 (funcall link-face path))
5985 ;; a face
5986 ((facep link-face)
5987 link-face)
5988 ;; An anonymous face
5989 ((consp link-face)
5990 link-face)
5991 ;; default
5993 'org-link))
5994 'help-echo (cond
5995 ((stringp help-echo)
5996 help-echo)
5997 ((functionp help-echo)
5998 help-echo)
6000 (concat "LINK: "
6001 (save-match-data
6002 (org-link-unescape link)))))
6003 'htmlize-link (cond
6004 ((functionp htmlize-link)
6005 (funcall htmlize-link path))
6007 `(:uri ,link)))
6008 'keymap (or (org-link-get-parameter type :keymap)
6009 org-mouse-map)
6010 'org-link-start (match-beginning 0)))
6011 (org-rear-nonsticky-at (match-end 0))
6012 (when activate-func
6013 (funcall activate-func link-start link-end path nil))
6014 t))))
6016 (defun org-activate-code (limit)
6017 (when (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
6018 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6019 (remove-text-properties (match-beginning 0) (match-end 0)
6020 '(display t invisible t intangible t))
6023 (defcustom org-src-fontify-natively t
6024 "When non-nil, fontify code in code blocks.
6025 See also the `org-block' face."
6026 :type 'boolean
6027 :version "24.4"
6028 :package-version '(Org . "8.3")
6029 :group 'org-appearance
6030 :group 'org-babel)
6032 (defcustom org-allow-promoting-top-level-subtree nil
6033 "When non-nil, allow promoting a top level subtree.
6034 The leading star of the top level headline will be replaced
6035 by a #."
6036 :type 'boolean
6037 :version "24.1"
6038 :group 'org-appearance)
6040 (defun org-fontify-meta-lines-and-blocks (limit)
6041 (condition-case nil
6042 (org-fontify-meta-lines-and-blocks-1 limit)
6043 (error (message "org-mode fontification error in %S at %d"
6044 (current-buffer)
6045 (line-number-at-pos)))))
6047 (defun org-fontify-meta-lines-and-blocks-1 (limit)
6048 "Fontify #+ lines and blocks."
6049 (let ((case-fold-search t))
6050 (when (re-search-forward
6051 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
6052 limit t)
6053 (let ((beg (match-beginning 0))
6054 (block-start (match-end 0))
6055 (block-end nil)
6056 (lang (match-string 7))
6057 (beg1 (line-beginning-position 2))
6058 (dc1 (downcase (match-string 2)))
6059 (dc3 (downcase (match-string 3)))
6060 end end1 quoting block-type)
6061 (cond
6062 ((and (match-end 4) (equal dc3 "+begin"))
6063 ;; Truly a block
6064 (setq block-type (downcase (match-string 5))
6065 quoting (member block-type org-protecting-blocks))
6066 (when (re-search-forward
6067 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
6068 nil t) ;; on purpose, we look further than LIMIT
6069 (setq end (min (point-max) (match-end 0))
6070 end1 (min (point-max) (1- (match-beginning 0))))
6071 (setq block-end (match-beginning 0))
6072 (when quoting
6073 (org-remove-flyspell-overlays-in beg1 end1)
6074 (remove-text-properties beg end
6075 '(display t invisible t intangible t)))
6076 (add-text-properties
6077 beg end '(font-lock-fontified t font-lock-multiline t))
6078 (add-text-properties beg beg1 '(face org-meta-line))
6079 (org-remove-flyspell-overlays-in beg beg1)
6080 (add-text-properties ; For end_src
6081 end1 (min (point-max) (1+ end)) '(face org-meta-line))
6082 (org-remove-flyspell-overlays-in end1 end)
6083 (cond
6084 ((and lang (not (string= lang "")) org-src-fontify-natively)
6085 (org-src-font-lock-fontify-block lang block-start block-end)
6086 (add-text-properties beg1 block-end '(src-block t)))
6087 (quoting
6088 (add-text-properties beg1 (min (point-max) (1+ end1))
6089 (list 'face
6090 (list :inherit
6091 (let ((face-name
6092 (intern (format "org-block-%s" lang))))
6093 (append (and (facep face-name) (list face-name))
6094 '(org-block))))))) ; end of source block
6095 ((not org-fontify-quote-and-verse-blocks))
6096 ((string= block-type "quote")
6097 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
6098 ((string= block-type "verse")
6099 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
6100 (add-text-properties beg beg1 '(face org-block-begin-line))
6101 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
6102 '(face org-block-end-line))
6104 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
6105 (org-remove-flyspell-overlays-in
6106 (match-beginning 0)
6107 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
6108 (add-text-properties
6109 beg (match-end 3)
6110 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
6111 '(font-lock-fontified t invisible t)
6112 '(font-lock-fontified t face org-document-info-keyword)))
6113 (add-text-properties
6114 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
6115 (if (string-equal dc1 "+title:")
6116 '(font-lock-fontified t face org-document-title)
6117 '(font-lock-fontified t face org-document-info))))
6118 ((string-prefix-p "+caption" dc1)
6119 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
6120 (remove-text-properties (match-beginning 0) (match-end 0)
6121 '(display t invisible t intangible t))
6122 ;; Handle short captions.
6123 (save-excursion
6124 (beginning-of-line)
6125 (looking-at "\\([ \t]*#\\+caption\\(?:\\[.*\\]\\)?:\\)[ \t]*"))
6126 (add-text-properties (line-beginning-position) (match-end 1)
6127 '(font-lock-fontified t face org-meta-line))
6128 (add-text-properties (match-end 0) (line-end-position)
6129 '(font-lock-fontified t face org-block))
6131 ((member dc3 '(" " ""))
6132 (org-remove-flyspell-overlays-in beg (match-end 0))
6133 (add-text-properties
6134 beg (match-end 0)
6135 '(font-lock-fontified t face font-lock-comment-face)))
6136 (t ;; just any other in-buffer setting, but not indented
6137 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6138 (remove-text-properties (match-beginning 0) (match-end 0)
6139 '(display t invisible t intangible t))
6140 (add-text-properties beg (match-end 0)
6141 '(font-lock-fontified t face org-meta-line))
6142 t))))))
6144 (defun org-fontify-drawers (limit)
6145 "Fontify drawers."
6146 (when (re-search-forward org-drawer-regexp limit t)
6147 (add-text-properties
6148 (match-beginning 0) (match-end 0)
6149 '(font-lock-fontified t face org-special-keyword))
6150 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6153 (defun org-fontify-macros (limit)
6154 "Fontify macros."
6155 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
6156 (add-text-properties
6157 (match-beginning 0) (match-end 0)
6158 '(font-lock-fontified t face org-macro))
6159 (when org-hide-macro-markers
6160 (add-text-properties (match-end 2) (match-beginning 2)
6161 '(invisible t))
6162 (add-text-properties (match-beginning 1) (match-end 1)
6163 '(invisible t)))
6164 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6167 (defun org-activate-angle-links (limit)
6168 "Add text properties for angle links."
6169 (when (and (re-search-forward org-angle-link-re limit t)
6170 (not (org-in-src-block-p)))
6171 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6172 (add-text-properties (match-beginning 0) (match-end 0)
6173 (list 'mouse-face 'highlight
6174 'keymap org-mouse-map
6175 'font-lock-multiline t))
6176 (org-rear-nonsticky-at (match-end 0))
6179 (defun org-activate-footnote-links (limit)
6180 "Add text properties for footnotes."
6181 (let ((fn (org-footnote-next-reference-or-definition limit)))
6182 (when fn
6183 (let* ((beg (nth 1 fn))
6184 (end (nth 2 fn))
6185 (label (car fn))
6186 (referencep (/= (line-beginning-position) beg)))
6187 (when (and referencep (nth 3 fn))
6188 (save-excursion
6189 (goto-char beg)
6190 (search-forward (or label "fn:"))
6191 (org-remove-flyspell-overlays-in beg (match-end 0))))
6192 (add-text-properties beg end
6193 (list 'mouse-face 'highlight
6194 'keymap org-mouse-map
6195 'help-echo
6196 (if referencep "Footnote reference"
6197 "Footnote definition")
6198 'font-lock-fontified t
6199 'font-lock-multiline t
6200 'face 'org-footnote))))))
6202 (defun org-activate-bracket-links (limit)
6203 "Add text properties for bracketed links."
6204 (when (and (re-search-forward org-bracket-link-regexp limit t)
6205 (not (org-in-src-block-p)))
6206 (let* ((hl (save-match-data
6207 (org-link-expand-abbrev (match-string-no-properties 1))))
6208 (type (save-match-data
6209 (and (string-match org-plain-link-re hl)
6210 (match-string-no-properties 1 hl))))
6211 (path (save-match-data
6212 (and (string-match org-plain-link-re hl)
6213 (match-string-no-properties 2 hl))))
6214 (link-start (match-beginning 0))
6215 (link-end (match-end 0))
6216 (bracketp t)
6217 (help-echo (org-link-get-parameter type :help-echo))
6218 (help (cond
6219 ((stringp help-echo)
6220 help-echo)
6221 ((functionp help-echo)
6222 help-echo)
6224 (concat "LINK: "
6225 (save-match-data
6226 (org-link-unescape hl))))))
6227 (link-face (org-link-get-parameter type :face))
6228 (face (cond
6229 ;; A function that returns a face
6230 ((functionp link-face)
6231 (funcall link-face path))
6232 ;; a face
6233 ((facep link-face)
6234 link-face)
6235 ;; An anonymous face
6236 ((consp link-face)
6237 link-face)
6238 ;; default
6240 'org-link)))
6241 (keymap (or (org-link-get-parameter type :keymap)
6242 org-mouse-map))
6243 (mouse-face (or (org-link-get-parameter type :mouse-face)
6244 'highlight))
6245 (htmlize (org-link-get-parameter type :htmlize-link))
6246 (htmlize-link (cond
6247 ((functionp htmlize)
6248 (funcall htmlize))
6250 `(:uri ,(format "%s:%s" type path)))))
6251 (activate-func (org-link-get-parameter type :activate-func))
6252 ;; invisible part
6253 (ip (list 'invisible (or
6254 (org-link-get-parameter type :display)
6255 'org-link)
6256 'face face
6257 'keymap keymap
6258 'mouse-face mouse-face
6259 'font-lock-multiline t
6260 'help-echo help
6261 'htmlize-link htmlize-link))
6262 ;; visible part
6263 (vp (list 'keymap keymap
6264 'face face
6265 'mouse-face mouse-face
6266 'font-lock-multiline t
6267 'help-echo help
6268 'htmlize-link htmlize-link)))
6269 ;; We need to remove the invisible property here. Table narrowing
6270 ;; may have made some of this invisible.
6271 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6272 (remove-text-properties (match-beginning 0) (match-end 0)
6273 '(invisible nil))
6274 (if (match-end 3)
6275 (progn
6276 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6277 (org-rear-nonsticky-at (match-beginning 3))
6278 (add-text-properties (match-beginning 3) (match-end 3) vp)
6279 (org-rear-nonsticky-at (match-end 3))
6280 (add-text-properties (match-end 3) (match-end 0) ip)
6281 (org-rear-nonsticky-at (match-end 0)))
6282 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6283 (org-rear-nonsticky-at (match-beginning 1))
6284 (add-text-properties (match-beginning 1) (match-end 1) vp)
6285 (org-rear-nonsticky-at (match-end 1))
6286 (add-text-properties (match-end 1) (match-end 0) ip)
6287 (org-rear-nonsticky-at (match-end 0)))
6288 (when activate-func
6289 (funcall activate-func link-start link-end path bracketp))
6290 t)))
6292 (defun org-activate-dates (limit)
6293 "Add text properties for dates."
6294 (when (and (re-search-forward org-tsr-regexp-both limit t)
6295 (not (equal (char-before (match-beginning 0)) 91)))
6296 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6297 (add-text-properties (match-beginning 0) (match-end 0)
6298 (list 'mouse-face 'highlight
6299 'keymap org-mouse-map))
6300 (org-rear-nonsticky-at (match-end 0))
6301 (when org-display-custom-times
6302 (if (match-end 3)
6303 (org-display-custom-time (match-beginning 3) (match-end 3))
6304 (org-display-custom-time (match-beginning 1) (match-end 1))))
6307 (defvar-local org-target-link-regexp nil
6308 "Regular expression matching radio targets in plain text.")
6310 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6311 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6312 border border border))
6313 "Regular expression matching a link target.")
6315 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6316 "Regular expression matching a radio target.")
6318 (defconst org-any-target-regexp
6319 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6320 "Regular expression matching any target.")
6322 (defun org-activate-target-links (limit)
6323 "Add text properties for target matches."
6324 (when org-target-link-regexp
6325 (let ((case-fold-search t))
6326 (when (re-search-forward org-target-link-regexp limit t)
6327 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6328 (add-text-properties (match-beginning 1) (match-end 1)
6329 (list 'mouse-face 'highlight
6330 'keymap org-mouse-map
6331 'help-echo "Radio target link"
6332 'org-linked-text t))
6333 (org-rear-nonsticky-at (match-end 1))
6334 t))))
6336 (defun org-update-radio-target-regexp ()
6337 "Find all radio targets in this file and update the regular expression.
6338 Also refresh fontification if needed."
6339 (interactive)
6340 (let ((old-regexp org-target-link-regexp)
6341 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6342 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6343 (targets
6344 (org-with-wide-buffer
6345 (goto-char (point-min))
6346 (let (rtn)
6347 (while (re-search-forward org-radio-target-regexp nil t)
6348 ;; Make sure point is really within the object.
6349 (backward-char)
6350 (let ((obj (org-element-context)))
6351 (when (eq (org-element-type obj) 'radio-target)
6352 (cl-pushnew (org-element-property :value obj) rtn
6353 :test #'equal))))
6354 rtn))))
6355 (setq org-target-link-regexp
6356 (and targets
6357 (concat before-re
6358 (mapconcat
6359 (lambda (x)
6360 (replace-regexp-in-string
6361 " +" "\\s-+" (regexp-quote x) t t))
6362 targets
6363 "\\|")
6364 after-re)))
6365 (unless (equal old-regexp org-target-link-regexp)
6366 ;; Clean-up cache.
6367 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6368 ((not org-target-link-regexp) old-regexp)
6370 (concat before-re
6371 (mapconcat
6372 (lambda (re)
6373 (substring re (length before-re)
6374 (- (length after-re))))
6375 (list old-regexp org-target-link-regexp)
6376 "\\|")
6377 after-re)))))
6378 (org-with-wide-buffer
6379 (goto-char (point-min))
6380 (while (re-search-forward regexp nil t)
6381 (org-element-cache-refresh (match-beginning 1)))))
6382 ;; Re fontify buffer.
6383 (when (memq 'radio org-highlight-links)
6384 (org-restart-font-lock)))))
6386 (defun org-hide-wide-columns (limit)
6387 (let (s e)
6388 (setq s (text-property-any (point) (or limit (point-max))
6389 'org-cwidth t))
6390 (when s
6391 (setq e (next-single-property-change s 'org-cwidth))
6392 (add-text-properties s e '(invisible org-cwidth))
6393 (goto-char e)
6394 t)))
6396 (defvar org-latex-and-related-regexp nil
6397 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6399 (defun org-compute-latex-and-related-regexp ()
6400 "Compute regular expression for LaTeX, entities and sub/superscript.
6401 Result depends on variable `org-highlight-latex-and-related'."
6402 (setq-local
6403 org-latex-and-related-regexp
6404 (let* ((re-sub
6405 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6406 ((eq org-use-sub-superscripts '{})
6407 (list org-match-substring-with-braces-regexp))
6408 (org-use-sub-superscripts (list org-match-substring-regexp))))
6409 (re-latex
6410 (when (memq 'latex org-highlight-latex-and-related)
6411 (let ((matchers (plist-get org-format-latex-options :matchers)))
6412 (delq nil
6413 (mapcar (lambda (x)
6414 (and (member (car x) matchers) (nth 1 x)))
6415 org-latex-regexps)))))
6416 (re-entities
6417 (when (memq 'entities org-highlight-latex-and-related)
6418 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6419 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6421 (defun org-do-latex-and-related (limit)
6422 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6423 LIMIT bounds the search for syntax to highlight. Stop at first
6424 highlighted object, if any. Return t if some highlighting was
6425 done, nil otherwise."
6426 (when (org-string-nw-p org-latex-and-related-regexp)
6427 (catch 'found
6428 (while (re-search-forward org-latex-and-related-regexp limit t)
6429 (unless
6430 (cl-some
6431 (lambda (f)
6432 (memq f '(org-code org-verbatim underline org-special-keyword)))
6433 (save-excursion
6434 (goto-char (1+ (match-beginning 0)))
6435 (face-at-point nil t)))
6436 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6437 '(?_ ?^))
6439 0)))
6440 (font-lock-prepend-text-property
6441 (+ offset (match-beginning 0)) (match-end 0)
6442 'face 'org-latex-and-related)
6443 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6444 '(font-lock-multiline t)))
6445 (throw 'found t)))
6446 nil)))
6448 (defun org-restart-font-lock ()
6449 "Restart `font-lock-mode', to force refontification."
6450 (when (and (boundp 'font-lock-mode) font-lock-mode)
6451 (font-lock-mode -1)
6452 (font-lock-mode 1)))
6454 (defun org-activate-tags (limit)
6455 (when (re-search-forward
6456 "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" limit t)
6457 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6458 (add-text-properties (match-beginning 1) (match-end 1)
6459 (list 'mouse-face 'highlight
6460 'keymap org-mouse-map))
6461 (org-rear-nonsticky-at (match-end 1))
6464 (defun org-outline-level ()
6465 "Compute the outline level of the heading at point.
6467 If this is called at a normal headline, the level is the number
6468 of stars. Use `org-reduced-level' to remove the effect of
6469 `org-odd-levels'. Unlike to `org-current-level', this function
6470 takes into consideration inlinetasks."
6471 (org-with-wide-buffer
6472 (end-of-line)
6473 (if (re-search-backward org-outline-regexp-bol nil t)
6474 (1- (- (match-end 0) (match-beginning 0)))
6475 0)))
6477 (defvar org-font-lock-keywords nil)
6479 (defsubst org-re-property (property &optional literal allow-null value)
6480 "Return a regexp matching a PROPERTY line.
6482 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6483 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6484 non-nil, match properties even without a value.
6486 Match group 3 is set to the value when it exists. If there is no
6487 value and ALLOW-NULL is non-nil, it is set to the empty string.
6489 With optional argument VALUE, match only property lines with
6490 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6491 unless LITERAL is non-nil."
6492 (concat
6493 "^\\(?4:[ \t]*\\)"
6494 (format "\\(?1::\\(?2:%s\\):\\)"
6495 (if literal property (regexp-quote property)))
6496 (cond (value
6497 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6498 (if literal value (regexp-quote value))))
6499 (allow-null
6500 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6502 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6504 (defconst org-property-re
6505 (org-re-property "\\S-+" 'literal t)
6506 "Regular expression matching a property line.
6507 There are four matching groups:
6508 1: :PROPKEY: including the leading and trailing colon,
6509 2: PROPKEY without the leading and trailing colon,
6510 3: PROPVAL without leading or trailing spaces,
6511 4: the indentation of the current line,
6512 5: trailing whitespace.")
6514 (defvar org-font-lock-hook nil
6515 "Functions to be called for special font lock stuff.")
6517 (defvar org-font-lock-extra-keywords nil) ;Dynamically scoped.
6519 (defvar org-font-lock-set-keywords-hook nil
6520 "Functions that can manipulate `org-font-lock-extra-keywords'.
6521 This is called after `org-font-lock-extra-keywords' is defined, but before
6522 it is installed to be used by font lock. This can be useful if something
6523 needs to be inserted at a specific position in the font-lock sequence.")
6525 (defun org-font-lock-hook (limit)
6526 "Run `org-font-lock-hook' within LIMIT."
6527 (run-hook-with-args 'org-font-lock-hook limit))
6529 (defun org-set-font-lock-defaults ()
6530 "Set font lock defaults for the current buffer."
6531 (let* ((em org-fontify-emphasized-text)
6532 (lk org-highlight-links)
6533 (org-font-lock-extra-keywords
6534 (list
6535 ;; Call the hook
6536 '(org-font-lock-hook)
6537 ;; Headlines
6538 `(,(if org-fontify-whole-heading-line
6539 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6540 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6541 (1 (org-get-level-face 1))
6542 (2 (org-get-level-face 2))
6543 (3 (org-get-level-face 3)))
6544 ;; Table lines
6545 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6546 (1 'org-table t))
6547 ;; Table internals
6548 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6549 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6550 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6551 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6552 ;; Drawers
6553 '(org-fontify-drawers)
6554 ;; Properties
6555 (list org-property-re
6556 '(1 'org-special-keyword t)
6557 '(3 'org-property-value t))
6558 ;; Links
6559 (when (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6560 (when (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6561 (when (memq 'plain lk) '(org-activate-plain-links (0 'org-link)))
6562 (when (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link)))
6563 (when (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6564 (when (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6565 (when (memq 'footnote lk) '(org-activate-footnote-links))
6566 ;; Targets.
6567 (list org-any-target-regexp '(0 'org-target t))
6568 ;; Diary sexps.
6569 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6570 ;; Macro
6571 '(org-fontify-macros)
6572 '(org-hide-wide-columns (0 nil append))
6573 ;; TODO keyword
6574 (list (format org-heading-keyword-regexp-format
6575 org-todo-regexp)
6576 '(2 (org-get-todo-face 2) t))
6577 ;; DONE
6578 (if org-fontify-done-headline
6579 (list (format org-heading-keyword-regexp-format
6580 (concat
6581 "\\(?:"
6582 (mapconcat 'regexp-quote org-done-keywords "\\|")
6583 "\\)"))
6584 '(2 'org-headline-done t))
6585 nil)
6586 ;; Priorities
6587 '(org-font-lock-add-priority-faces)
6588 ;; Tags
6589 '(org-font-lock-add-tag-faces)
6590 ;; Tags groups
6591 (when (and org-group-tags org-tag-groups-alist)
6592 (list (concat org-outline-regexp-bol ".+\\(:"
6593 (regexp-opt (mapcar 'car org-tag-groups-alist))
6594 ":\\).*$")
6595 '(1 'org-tag-group prepend)))
6596 ;; Special keywords
6597 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6598 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6599 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6600 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6601 ;; Emphasis
6602 (when em '(org-do-emphasis-faces))
6603 ;; Checkboxes
6604 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6605 1 'org-checkbox prepend)
6606 (when (cdr (assq 'checkbox org-list-automatic-rules))
6607 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6608 (0 (org-get-checkbox-statistics-face) t)))
6609 ;; Description list items
6610 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6611 1 'org-list-dt prepend)
6612 ;; ARCHIVEd headings
6613 (list (concat
6614 org-outline-regexp-bol
6615 "\\(.*:" org-archive-tag ":.*\\)")
6616 '(1 'org-archived prepend))
6617 ;; Specials
6618 '(org-do-latex-and-related)
6619 '(org-fontify-entities)
6620 '(org-raise-scripts)
6621 ;; Code
6622 '(org-activate-code (1 'org-code t))
6623 ;; COMMENT
6624 (list (format
6625 "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6626 org-todo-regexp
6627 org-comment-string)
6628 '(9 'org-special-keyword t))
6629 ;; Blocks and meta lines
6630 '(org-fontify-meta-lines-and-blocks))))
6631 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6632 (run-hooks 'org-font-lock-set-keywords-hook)
6633 ;; Now set the full font-lock-keywords
6634 (setq-local org-font-lock-keywords org-font-lock-extra-keywords)
6635 (setq-local font-lock-defaults
6636 '(org-font-lock-keywords t nil nil backward-paragraph))
6637 (kill-local-variable 'font-lock-keywords)
6638 nil))
6640 (defun org-toggle-pretty-entities ()
6641 "Toggle the composition display of entities as UTF8 characters."
6642 (interactive)
6643 (setq-local org-pretty-entities (not org-pretty-entities))
6644 (org-restart-font-lock)
6645 (if org-pretty-entities
6646 (message "Entities are now displayed as UTF8 characters")
6647 (save-restriction
6648 (widen)
6649 (decompose-region (point-min) (point-max))
6650 (message "Entities are now displayed as plain text"))))
6652 (defvar-local org-custom-properties-overlays nil
6653 "List of overlays used for custom properties.")
6655 (defun org-toggle-custom-properties-visibility ()
6656 "Display or hide properties in `org-custom-properties'."
6657 (interactive)
6658 (if org-custom-properties-overlays
6659 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6660 (setq org-custom-properties-overlays nil))
6661 (when org-custom-properties
6662 (org-with-wide-buffer
6663 (goto-char (point-min))
6664 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6665 (while (re-search-forward regexp nil t)
6666 (let ((end (cdr (save-match-data (org-get-property-block)))))
6667 (when (and end (< (point) end))
6668 ;; Hide first custom property in current drawer.
6669 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6670 (overlay-put o 'invisible t)
6671 (overlay-put o 'org-custom-property t)
6672 (push o org-custom-properties-overlays))
6673 ;; Hide additional custom properties in the same drawer.
6674 (while (re-search-forward regexp end t)
6675 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6676 (overlay-put o 'invisible t)
6677 (overlay-put o 'org-custom-property t)
6678 (push o org-custom-properties-overlays)))))
6679 ;; Each entry is limited to a single property drawer.
6680 (outline-next-heading)))))))
6682 (defun org-fontify-entities (limit)
6683 "Find an entity to fontify."
6684 (let (ee)
6685 (when org-pretty-entities
6686 (catch 'match
6687 ;; "\_ "-family is left out on purpose. Only the first one,
6688 ;; i.e., "\_ ", could be fontified anyway, and it would be
6689 ;; confusing when adding a second white space character.
6690 (while (re-search-forward
6691 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6692 limit t)
6693 (when (and (not (org-at-comment-p))
6694 (setq ee (org-entity-get (match-string 1)))
6695 (= (length (nth 6 ee)) 1))
6696 (let* ((end (if (equal (match-string 2) "{}")
6697 (match-end 2)
6698 (match-end 1))))
6699 (add-text-properties
6700 (match-beginning 0) end
6701 (list 'font-lock-fontified t))
6702 (compose-region (match-beginning 0) end
6703 (nth 6 ee) nil)
6704 (backward-char 1)
6705 (throw 'match t))))
6706 nil))))
6708 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6709 "Fontify string S like in Org mode."
6710 (with-temp-buffer
6711 (insert s)
6712 (let ((org-odd-levels-only odd-levels))
6713 (org-mode)
6714 (org-font-lock-ensure)
6715 (buffer-string))))
6717 (defvar org-m nil)
6718 (defvar org-l nil)
6719 (defvar org-f nil)
6720 (defun org-get-level-face (n)
6721 "Get the right face for match N in font-lock matching of headlines."
6722 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6723 (when org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6724 (if org-cycle-level-faces
6725 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6726 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6727 (cond
6728 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6729 ((eq n 2) org-f)
6730 (t (unless org-level-color-stars-only org-f))))
6732 (defun org-face-from-face-or-color (context inherit face-or-color)
6733 "Create a face list that inherits INHERIT, but sets the foreground color.
6734 When FACE-OR-COLOR is not a string, just return it."
6735 (if (stringp face-or-color)
6736 (list :inherit inherit
6737 (cdr (assoc context org-faces-easy-properties))
6738 face-or-color)
6739 face-or-color))
6741 (defun org-get-todo-face (kwd)
6742 "Get the right face for a TODO keyword KWD.
6743 If KWD is a number, get the corresponding match group."
6744 (when (numberp kwd) (setq kwd (match-string kwd)))
6745 (or (org-face-from-face-or-color
6746 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6747 (and (member kwd org-done-keywords) 'org-done)
6748 'org-todo))
6750 (defun org-get-priority-face (priority)
6751 "Get the right face for PRIORITY.
6752 PRIORITY is a character."
6753 (or (org-face-from-face-or-color
6754 'priority 'org-priority (cdr (assq priority org-priority-faces)))
6755 'org-priority))
6757 (defun org-get-tag-face (tag)
6758 "Get the right face for TAG.
6759 If TAG is a number, get the corresponding match group."
6760 (let ((tag (if (wholenump tag) (match-string tag) tag)))
6761 (or (org-face-from-face-or-color
6762 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
6763 'org-tag)))
6765 (defun org-font-lock-add-priority-faces (limit)
6766 "Add the special priority faces."
6767 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
6768 (add-text-properties
6769 (match-beginning 1) (match-end 1)
6770 (list 'face (org-get-priority-face (string-to-char (match-string 2)))
6771 'font-lock-fontified t))))
6773 (defun org-font-lock-add-tag-faces (limit)
6774 "Add the special tag faces."
6775 (when (and org-tag-faces org-tags-special-faces-re)
6776 (while (re-search-forward org-tags-special-faces-re limit t)
6777 (add-text-properties (match-beginning 1) (match-end 1)
6778 (list 'face (org-get-tag-face 1)
6779 'font-lock-fontified t))
6780 (backward-char 1))))
6782 (defun org-unfontify-region (beg end &optional _maybe_loudly)
6783 "Remove fontification and activation overlays from links."
6784 (font-lock-default-unfontify-region beg end)
6785 (let* ((buffer-undo-list t)
6786 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6787 (inhibit-modification-hooks t)
6788 deactivate-mark buffer-file-name buffer-file-truename)
6789 (decompose-region beg end)
6790 (remove-text-properties beg end
6791 '(mouse-face t keymap t org-linked-text t
6792 invisible t intangible t
6793 org-emphasis t))
6794 (org-remove-font-lock-display-properties beg end)))
6796 (defconst org-script-display '(((raise -0.3) (height 0.7))
6797 ((raise 0.3) (height 0.7))
6798 ((raise -0.5))
6799 ((raise 0.5)))
6800 "Display properties for showing superscripts and subscripts.")
6802 (defun org-remove-font-lock-display-properties (beg end)
6803 "Remove specific display properties that have been added by font lock.
6804 The will remove the raise properties that are used to show superscripts
6805 and subscripts."
6806 (let (next prop)
6807 (while (< beg end)
6808 (setq next (next-single-property-change beg 'display nil end)
6809 prop (get-text-property beg 'display))
6810 (when (member prop org-script-display)
6811 (put-text-property beg next 'display nil))
6812 (setq beg next))))
6814 (defun org-raise-scripts (limit)
6815 "Add raise properties to sub/superscripts."
6816 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
6817 (re-search-forward
6818 (if (eq org-use-sub-superscripts t)
6819 org-match-substring-regexp
6820 org-match-substring-with-braces-regexp)
6821 limit t))
6822 (let* ((pos (point)) table-p comment-p
6823 (mpos (match-beginning 3))
6824 (emph-p (get-text-property mpos 'org-emphasis))
6825 (link-p (get-text-property mpos 'mouse-face))
6826 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6827 (goto-char (point-at-bol))
6828 (setq table-p (looking-at-p org-table-dataline-regexp)
6829 comment-p (looking-at-p "^[ \t]*#[ +]"))
6830 (goto-char pos)
6831 ;; Handle a_b^c
6832 (when (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6833 (unless (or comment-p emph-p link-p keyw-p)
6834 (put-text-property (match-beginning 3) (match-end 0)
6835 'display
6836 (if (equal (char-after (match-beginning 2)) ?^)
6837 (nth (if table-p 3 1) org-script-display)
6838 (nth (if table-p 2 0) org-script-display)))
6839 (add-text-properties (match-beginning 2) (match-end 2)
6840 (list 'invisible t
6841 'org-dwidth t 'org-dwidth-n 1))
6842 (if (and (eq (char-after (match-beginning 3)) ?{)
6843 (eq (char-before (match-end 3)) ?}))
6844 (progn
6845 (add-text-properties
6846 (match-beginning 3) (1+ (match-beginning 3))
6847 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6848 (add-text-properties
6849 (1- (match-end 3)) (match-end 3)
6850 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1)))))
6851 t)))
6853 ;;;; Visibility cycling, including org-goto and indirect buffer
6855 ;;; Cycling
6857 (defvar-local org-cycle-global-status nil)
6858 (put 'org-cycle-global-status 'org-state t)
6859 (defvar-local org-cycle-subtree-status nil)
6860 (put 'org-cycle-subtree-status 'org-state t)
6862 (defvar org-inlinetask-min-level)
6864 (defun org-unlogged-message (&rest args)
6865 "Display a message, but avoid logging it in the *Messages* buffer."
6866 (let ((message-log-max nil))
6867 (apply 'message args)))
6869 ;;;###autoload
6870 (defun org-cycle (&optional arg)
6871 "TAB-action and visibility cycling for Org mode.
6873 This is the command invoked in Org mode by the `TAB' key. Its main
6874 purpose is outline visibility cycling, but it also invokes other actions
6875 in special contexts.
6877 When this function is called with a `\\[universal-argument]' prefix, rotate \
6878 the entire
6879 buffer through 3 states (global cycling)
6880 1. OVERVIEW: Show only top-level headlines.
6881 2. CONTENTS: Show all headlines of all levels, but no body text.
6882 3. SHOW ALL: Show everything.
6884 With a `\\[universal-argument] \\[universal-argument]' prefix argument, \
6885 switch to the startup visibility,
6886 determined by the variable `org-startup-folded', and by any VISIBILITY
6887 properties in the buffer.
6889 With a `\\[universal-argument] \\[universal-argument] \
6890 \\[universal-argument]' prefix argument, show the entire buffer, including
6891 any drawers.
6893 When inside a table, re-align the table and move to the next field.
6895 When point is at the beginning of a headline, rotate the subtree started
6896 by this line through 3 different states (local cycling)
6897 1. FOLDED: Only the main headline is shown.
6898 2. CHILDREN: The main headline and the direct children are shown.
6899 From this state, you can move to one of the children
6900 and zoom in further.
6901 3. SUBTREE: Show the entire subtree, including body text.
6902 If there is no subtree, switch directly from CHILDREN to FOLDED.
6904 When point is at the beginning of an empty headline and the variable
6905 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6906 of the headline by demoting and promoting it to likely levels. This
6907 speeds up creation document structure by pressing `TAB' once or several
6908 times right after creating a new headline.
6910 When there is a numeric prefix, go up to a heading with level ARG, do
6911 a `show-subtree' and return to the previous cursor position. If ARG
6912 is negative, go up that many levels.
6914 When point is not at the beginning of a headline, execute the global
6915 binding for `TAB', which is re-indenting the line. See the option
6916 `org-cycle-emulate-tab' for details.
6918 As a special case, if point is at the beginning of the buffer and there is
6919 no headline in line 1, this function will act as if called with prefix arg
6920 \(`\\[universal-argument] TAB', same as `S-TAB') also when called without \
6921 prefix arg, but only
6922 if the variable `org-cycle-global-at-bob' is t."
6923 (interactive "P")
6924 (org-load-modules-maybe)
6925 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6926 (and org-cycle-level-after-item/entry-creation
6927 (or (org-cycle-level)
6928 (org-cycle-item-indentation))))
6929 (let* ((limit-level
6930 (or org-cycle-max-level
6931 (and (boundp 'org-inlinetask-min-level)
6932 org-inlinetask-min-level
6933 (1- org-inlinetask-min-level))))
6934 (nstars (and limit-level
6935 (if org-odd-levels-only
6936 (and limit-level (1- (* limit-level 2)))
6937 limit-level)))
6938 (org-outline-regexp
6939 (if (not (derived-mode-p 'org-mode))
6940 outline-regexp
6941 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6942 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6943 (not (looking-at org-outline-regexp))))
6944 (org-cycle-hook
6945 (if bob-special
6946 (delq 'org-optimize-window-after-visibility-change
6947 (copy-sequence org-cycle-hook))
6948 org-cycle-hook))
6949 (pos (point)))
6951 (cond
6953 ((equal arg '(16))
6954 (setq last-command 'dummy)
6955 (org-set-startup-visibility)
6956 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6958 ((equal arg '(64))
6959 (outline-show-all)
6960 (org-unlogged-message "Entire buffer visible, including drawers"))
6962 ((equal arg '(4)) (org-cycle-internal-global))
6964 ;; Try hiding block at point.
6965 ((org-hide-block-toggle-maybe))
6967 ;; Try cdlatex TAB completion
6968 ((org-try-cdlatex-tab))
6970 ;; Table: enter it or move to the next field.
6971 ((org-at-table-p 'any)
6972 (if (org-at-table.el-p)
6973 (message "%s" (substitute-command-keys "\\<org-mode-map>\
6974 Use `\\[org-edit-special]' to edit table.el tables"))
6975 (if arg (org-table-edit-field t)
6976 (org-table-justify-field-maybe)
6977 (call-interactively 'org-table-next-field))))
6979 ((run-hook-with-args-until-success 'org-tab-after-check-for-table-hook))
6981 ;; Global cycling: delegate to `org-cycle-internal-global'.
6982 (bob-special (org-cycle-internal-global))
6984 ;; Drawers: delegate to `org-flag-drawer'.
6985 ((save-excursion
6986 (beginning-of-line 1)
6987 (looking-at org-drawer-regexp))
6988 (org-flag-drawer ; toggle block visibility
6989 (not (get-char-property (match-end 0) 'invisible))))
6991 ;; Show-subtree, ARG levels up from here.
6992 ((integerp arg)
6993 (save-excursion
6994 (org-back-to-heading)
6995 (outline-up-heading (if (< arg 0) (- arg)
6996 (- (funcall outline-level) arg)))
6997 (org-show-subtree)))
6999 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
7000 ((and (featurep 'org-inlinetask)
7001 (org-inlinetask-at-task-p)
7002 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
7003 (org-inlinetask-toggle-visibility))
7005 ;; At an item/headline: delegate to `org-cycle-internal-local'.
7006 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
7007 (save-excursion (move-beginning-of-line 1)
7008 (looking-at org-outline-regexp)))
7009 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
7010 (org-cycle-internal-local))
7012 ;; From there: TAB emulation and template completion.
7013 (buffer-read-only (org-back-to-heading))
7015 ((run-hook-with-args-until-success
7016 'org-tab-after-check-for-cycling-hook))
7018 ((org-try-structure-completion))
7020 ((run-hook-with-args-until-success
7021 'org-tab-before-tab-emulation-hook))
7023 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
7024 (or (not (bolp))
7025 (not (looking-at org-outline-regexp))))
7026 (call-interactively (global-key-binding "\t")))
7028 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
7029 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
7030 (or (and (eq org-cycle-emulate-tab 'white)
7031 (= (match-end 0) (point-at-eol)))
7032 (and (eq org-cycle-emulate-tab 'whitestart)
7033 (>= (match-end 0) pos))))
7035 (eq org-cycle-emulate-tab t))
7036 (call-interactively (global-key-binding "\t")))
7038 (t (save-excursion
7039 (org-back-to-heading)
7040 (org-cycle)))))))
7042 (defun org-cycle-internal-global ()
7043 "Do the global cycling action."
7044 ;; Hack to avoid display of messages for .org attachments in Gnus
7045 (let ((ga (string-match "\\*fontification" (buffer-name))))
7046 (cond
7047 ((and (eq last-command this-command)
7048 (eq org-cycle-global-status 'overview))
7049 ;; We just created the overview - now do table of contents
7050 ;; This can be slow in very large buffers, so indicate action
7051 (run-hook-with-args 'org-pre-cycle-hook 'contents)
7052 (unless ga (org-unlogged-message "CONTENTS..."))
7053 (org-content)
7054 (unless ga (org-unlogged-message "CONTENTS...done"))
7055 (setq org-cycle-global-status 'contents)
7056 (run-hook-with-args 'org-cycle-hook 'contents))
7058 ((and (eq last-command this-command)
7059 (eq org-cycle-global-status 'contents))
7060 ;; We just showed the table of contents - now show everything
7061 (run-hook-with-args 'org-pre-cycle-hook 'all)
7062 (outline-show-all)
7063 (unless ga (org-unlogged-message "SHOW ALL"))
7064 (setq org-cycle-global-status 'all)
7065 (run-hook-with-args 'org-cycle-hook 'all))
7068 ;; Default action: go to overview
7069 (run-hook-with-args 'org-pre-cycle-hook 'overview)
7070 (org-overview)
7071 (unless ga (org-unlogged-message "OVERVIEW"))
7072 (setq org-cycle-global-status 'overview)
7073 (run-hook-with-args 'org-cycle-hook 'overview)))))
7075 (defvar org-called-with-limited-levels nil
7076 "Non-nil when `org-with-limited-levels' is currently active.")
7078 (defun org-cycle-internal-local ()
7079 "Do the local cycling action."
7080 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
7081 ;; First, determine end of headline (EOH), end of subtree or item
7082 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
7083 (save-excursion
7084 (if (org-at-item-p)
7085 (progn
7086 (beginning-of-line)
7087 (setq struct (org-list-struct))
7088 (setq eoh (point-at-eol))
7089 (setq eos (org-list-get-item-end-before-blank (point) struct))
7090 (setq has-children (org-list-has-child-p (point) struct)))
7091 (org-back-to-heading)
7092 (setq eoh (save-excursion (outline-end-of-heading) (point)))
7093 (setq eos (save-excursion (org-end-of-subtree t t)
7094 (when (bolp) (backward-char)) (point)))
7095 (setq has-children
7096 (or (save-excursion
7097 (let ((level (funcall outline-level)))
7098 (outline-next-heading)
7099 (and (org-at-heading-p t)
7100 (> (funcall outline-level) level))))
7101 (save-excursion
7102 (org-list-search-forward (org-item-beginning-re) eos t)))))
7103 ;; Determine end invisible part of buffer (EOL)
7104 (beginning-of-line 2)
7105 (while (and (not (eobp)) ;This is like `next-line'.
7106 (get-char-property (1- (point)) 'invisible))
7107 (goto-char (next-single-char-property-change (point) 'invisible))
7108 (and (eolp) (beginning-of-line 2)))
7109 (setq eol (point)))
7110 ;; Find out what to do next and set `this-command'
7111 (cond
7112 ((= eos eoh)
7113 ;; Nothing is hidden behind this heading
7114 (unless (org-before-first-heading-p)
7115 (run-hook-with-args 'org-pre-cycle-hook 'empty))
7116 (org-unlogged-message "EMPTY ENTRY")
7117 (setq org-cycle-subtree-status nil)
7118 (save-excursion
7119 (goto-char eos)
7120 (outline-next-heading)
7121 (when (outline-invisible-p) (org-flag-heading nil))))
7122 ((and (or (>= eol eos)
7123 (not (string-match "\\S-" (buffer-substring eol eos))))
7124 (or has-children
7125 (not (setq children-skipped
7126 org-cycle-skip-children-state-if-no-children))))
7127 ;; Entire subtree is hidden in one line: children view
7128 (unless (org-before-first-heading-p)
7129 (run-hook-with-args 'org-pre-cycle-hook 'children))
7130 (if (org-at-item-p)
7131 (org-list-set-item-visibility (point-at-bol) struct 'children)
7132 (org-show-entry)
7133 (org-with-limited-levels (org-show-children))
7134 ;; FIXME: This slows down the func way too much.
7135 ;; How keep drawers hidden in subtree anyway?
7136 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
7137 ;; (org-cycle-hide-drawers 'subtree))
7139 ;; Fold every list in subtree to top-level items.
7140 (when (eq org-cycle-include-plain-lists 'integrate)
7141 (save-excursion
7142 (org-back-to-heading)
7143 (while (org-list-search-forward (org-item-beginning-re) eos t)
7144 (beginning-of-line 1)
7145 (let* ((struct (org-list-struct))
7146 (prevs (org-list-prevs-alist struct))
7147 (end (org-list-get-bottom-point struct)))
7148 (dolist (e (org-list-get-all-items (point) struct prevs))
7149 (org-list-set-item-visibility e struct 'folded))
7150 (goto-char (if (< end eos) end eos)))))))
7151 (org-unlogged-message "CHILDREN")
7152 (save-excursion
7153 (goto-char eos)
7154 (outline-next-heading)
7155 (when (outline-invisible-p) (org-flag-heading nil)))
7156 (setq org-cycle-subtree-status 'children)
7157 (unless (org-before-first-heading-p)
7158 (run-hook-with-args 'org-cycle-hook 'children)))
7159 ((or children-skipped
7160 (and (eq last-command this-command)
7161 (eq org-cycle-subtree-status 'children)))
7162 ;; We just showed the children, or no children are there,
7163 ;; now show everything.
7164 (unless (org-before-first-heading-p)
7165 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
7166 (outline-flag-region eoh eos nil)
7167 (org-unlogged-message
7168 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
7169 (setq org-cycle-subtree-status 'subtree)
7170 (unless (org-before-first-heading-p)
7171 (run-hook-with-args 'org-cycle-hook 'subtree)))
7173 ;; Default action: hide the subtree.
7174 (run-hook-with-args 'org-pre-cycle-hook 'folded)
7175 (outline-flag-region eoh eos t)
7176 (org-unlogged-message "FOLDED")
7177 (setq org-cycle-subtree-status 'folded)
7178 (unless (org-before-first-heading-p)
7179 (run-hook-with-args 'org-cycle-hook 'folded))))))
7181 ;;;###autoload
7182 (defun org-global-cycle (&optional arg)
7183 "Cycle the global visibility. For details see `org-cycle'.
7184 With `\\[universal-argument]' prefix ARG, switch to startup visibility.
7185 With a numeric prefix, show all headlines up to that level."
7186 (interactive "P")
7187 (let ((org-cycle-include-plain-lists
7188 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
7189 (cond
7190 ((integerp arg)
7191 (outline-show-all)
7192 (outline-hide-sublevels arg)
7193 (setq org-cycle-global-status 'contents))
7194 ((equal arg '(4))
7195 (org-set-startup-visibility)
7196 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
7198 (org-cycle '(4))))))
7200 (defun org-set-startup-visibility ()
7201 "Set the visibility required by startup options and properties."
7202 (cond
7203 ((eq org-startup-folded t)
7204 (org-overview))
7205 ((eq org-startup-folded 'content)
7206 (org-content))
7207 ((or (eq org-startup-folded 'showeverything)
7208 (eq org-startup-folded nil))
7209 (outline-show-all)))
7210 (unless (eq org-startup-folded 'showeverything)
7211 (when org-hide-block-startup (org-hide-block-all))
7212 (org-set-visibility-according-to-property 'no-cleanup)
7213 (org-cycle-hide-archived-subtrees 'all)
7214 (org-cycle-hide-drawers 'all)
7215 (org-cycle-show-empty-lines t)))
7217 (defun org-set-visibility-according-to-property (&optional no-cleanup)
7218 "Switch subtree visibilities according to :VISIBILITY: property."
7219 (interactive)
7220 (org-with-wide-buffer
7221 (goto-char (point-min))
7222 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
7223 (if (not (org-at-property-p)) (outline-next-heading)
7224 (let ((state (match-string 3)))
7225 (save-excursion
7226 (org-back-to-heading t)
7227 (outline-hide-subtree)
7228 (org-reveal)
7229 (cond
7230 ((equal state "folded")
7231 (outline-hide-subtree))
7232 ((equal state "children")
7233 (org-show-hidden-entry)
7234 (org-show-children))
7235 ((equal state "content")
7236 (save-excursion
7237 (save-restriction
7238 (org-narrow-to-subtree)
7239 (org-content))))
7240 ((member state '("all" "showall"))
7241 (outline-show-subtree)))))))
7242 (unless no-cleanup
7243 (org-cycle-hide-archived-subtrees 'all)
7244 (org-cycle-hide-drawers 'all)
7245 (org-cycle-show-empty-lines 'all))))
7247 ;; This function uses outline-regexp instead of the more fundamental
7248 ;; org-outline-regexp so that org-cycle-global works outside of Org
7249 ;; buffers, where outline-regexp is needed.
7250 (defun org-overview ()
7251 "Switch to overview mode, showing only top-level headlines.
7252 This shows all headlines with a level equal or greater than the level
7253 of the first headline in the buffer. This is important, because if the
7254 first headline is not level one, then (hide-sublevels 1) gives confusing
7255 results."
7256 (interactive)
7257 (save-excursion
7258 (let ((level
7259 (save-excursion
7260 (goto-char (point-min))
7261 (when (re-search-forward (concat "^" outline-regexp) nil t)
7262 (goto-char (match-beginning 0))
7263 (funcall outline-level)))))
7264 (and level (outline-hide-sublevels level)))))
7266 (defun org-content (&optional arg)
7267 "Show all headlines in the buffer, like a table of contents.
7268 With numerical argument N, show content up to level N."
7269 (interactive "P")
7270 (org-overview)
7271 (save-excursion
7272 ;; Visit all headings and show their offspring
7273 (and (integerp arg) (org-overview))
7274 (goto-char (point-max))
7275 (catch 'exit
7276 (while (and (progn (condition-case nil
7277 (outline-previous-visible-heading 1)
7278 (error (goto-char (point-min))))
7280 (looking-at org-outline-regexp))
7281 (if (integerp arg)
7282 (org-show-children (1- arg))
7283 (outline-show-branches))
7284 (when (bobp) (throw 'exit nil))))))
7286 (defun org-optimize-window-after-visibility-change (state)
7287 "Adjust the window after a change in outline visibility.
7288 This function is the default value of the hook `org-cycle-hook'."
7289 (when (get-buffer-window (current-buffer))
7290 (cond
7291 ((eq state 'content) nil)
7292 ((eq state 'all) nil)
7293 ((eq state 'folded) nil)
7294 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7295 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7297 (defun org-remove-empty-overlays-at (pos)
7298 "Remove outline overlays that do not contain non-white stuff."
7299 (dolist (o (overlays-at pos))
7300 (and (eq 'outline (overlay-get o 'invisible))
7301 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7302 (overlay-end o))))
7303 (delete-overlay o))))
7305 (defun org-clean-visibility-after-subtree-move ()
7306 "Fix visibility issues after moving a subtree."
7307 ;; First, find a reasonable region to look at:
7308 ;; Start two siblings above, end three below
7309 (let* ((beg (save-excursion
7310 (and (org-get-last-sibling)
7311 (org-get-last-sibling))
7312 (point)))
7313 (end (save-excursion
7314 (and (org-get-next-sibling)
7315 (org-get-next-sibling)
7316 (org-get-next-sibling))
7317 (if (org-at-heading-p)
7318 (point-at-eol)
7319 (point))))
7320 (level (looking-at "\\*+"))
7321 (re (when level (concat "^" (regexp-quote (match-string 0)) " "))))
7322 (save-excursion
7323 (save-restriction
7324 (narrow-to-region beg end)
7325 (when re
7326 ;; Properly fold already folded siblings
7327 (goto-char (point-min))
7328 (while (re-search-forward re nil t)
7329 (when (and (not (outline-invisible-p))
7330 (save-excursion
7331 (goto-char (point-at-eol)) (outline-invisible-p)))
7332 (outline-hide-entry))))
7333 (org-cycle-show-empty-lines 'overview)
7334 (org-cycle-hide-drawers 'overview)))))
7336 (defun org-cycle-show-empty-lines (state)
7337 "Show empty lines above all visible headlines.
7338 The region to be covered depends on STATE when called through
7339 `org-cycle-hook'. Lisp program can use t for STATE to get the
7340 entire buffer covered. Note that an empty line is only shown if there
7341 are at least `org-cycle-separator-lines' empty lines before the headline."
7342 (when (/= org-cycle-separator-lines 0)
7343 (save-excursion
7344 (let* ((n (abs org-cycle-separator-lines))
7345 (re (cond
7346 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7347 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7348 (t (let ((ns (number-to-string (- n 2))))
7349 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7350 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7351 beg end)
7352 (cond
7353 ((memq state '(overview contents t))
7354 (setq beg (point-min) end (point-max)))
7355 ((memq state '(children folded))
7356 (setq beg (point)
7357 end (progn (org-end-of-subtree t t)
7358 (line-beginning-position 2)))))
7359 (when beg
7360 (goto-char beg)
7361 (while (re-search-forward re end t)
7362 (unless (get-char-property (match-end 1) 'invisible)
7363 (let ((e (match-end 1))
7364 (b (if (>= org-cycle-separator-lines 0)
7365 (match-beginning 1)
7366 (save-excursion
7367 (goto-char (match-beginning 0))
7368 (skip-chars-backward " \t\n")
7369 (line-end-position)))))
7370 (outline-flag-region b e nil))))))))
7371 ;; Never hide empty lines at the end of the file.
7372 (save-excursion
7373 (goto-char (point-max))
7374 (outline-previous-heading)
7375 (outline-end-of-heading)
7376 (when (and (looking-at "[ \t\n]+")
7377 (= (match-end 0) (point-max)))
7378 (outline-flag-region (point) (match-end 0) nil))))
7380 (defun org-show-empty-lines-in-parent ()
7381 "Move to the parent and re-show empty lines before visible headlines."
7382 (save-excursion
7383 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7384 (org-cycle-show-empty-lines context))))
7386 (defun org-files-list ()
7387 "Return `org-agenda-files' list, plus all open Org files.
7388 This is useful for operations that need to scan all of a user's
7389 open and agenda-wise Org files."
7390 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7391 (dolist (buf (buffer-list))
7392 (with-current-buffer buf
7393 (when (and (derived-mode-p 'org-mode) (buffer-file-name))
7394 (cl-pushnew (expand-file-name (buffer-file-name)) files))))
7395 files))
7397 (defsubst org-entry-beginning-position ()
7398 "Return the beginning position of the current entry."
7399 (save-excursion (org-back-to-heading t) (point)))
7401 (defsubst org-entry-end-position ()
7402 "Return the end position of the current entry."
7403 (save-excursion (outline-next-heading) (point)))
7405 (defun org-cycle-hide-drawers (state &optional exceptions)
7406 "Re-hide all drawers after a visibility state change.
7407 When non-nil, optional argument EXCEPTIONS is a list of strings
7408 specifying which drawers should not be hidden."
7409 (when (and (derived-mode-p 'org-mode)
7410 (not (memq state '(overview folded contents))))
7411 (save-excursion
7412 (let* ((globalp (memq state '(contents all)))
7413 (beg (if globalp (point-min) (point)))
7414 (end (if globalp (point-max)
7415 (if (eq state 'children)
7416 (save-excursion (outline-next-heading) (point))
7417 (org-end-of-subtree t)))))
7418 (goto-char beg)
7419 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7420 (unless (member-ignore-case (match-string 1) exceptions)
7421 (let ((drawer (org-element-at-point)))
7422 (when (memq (org-element-type drawer) '(drawer property-drawer))
7423 (org-flag-drawer t drawer)
7424 ;; Make sure to skip drawer entirely or we might flag
7425 ;; it another time when matching its ending line with
7426 ;; `org-drawer-regexp'.
7427 (goto-char (org-element-property :end drawer))))))))))
7429 (defun org-flag-drawer (flag &optional element)
7430 "When FLAG is non-nil, hide the drawer we are at.
7431 Otherwise make it visible. When optional argument ELEMENT is
7432 a parsed drawer, as returned by `org-element-at-point', hide or
7433 show that drawer instead."
7434 (let ((drawer (or element
7435 (and (save-excursion
7436 (beginning-of-line)
7437 (looking-at-p org-drawer-regexp))
7438 (org-element-at-point)))))
7439 (when (memq (org-element-type drawer) '(drawer property-drawer))
7440 (let ((post (org-element-property :post-affiliated drawer)))
7441 (save-excursion
7442 (outline-flag-region
7443 (progn (goto-char post) (line-end-position))
7444 (progn (goto-char (org-element-property :end drawer))
7445 (skip-chars-backward " \r\t\n")
7446 (line-end-position))
7447 flag))
7448 ;; When the drawer is hidden away, make sure point lies in
7449 ;; a visible part of the buffer.
7450 (when (and flag (> (line-beginning-position) post))
7451 (goto-char post))))))
7453 (defun org-subtree-end-visible-p ()
7454 "Is the end of the current subtree visible?"
7455 (pos-visible-in-window-p
7456 (save-excursion (org-end-of-subtree t) (point))))
7458 (defun org-first-headline-recenter ()
7459 "Move cursor to the first headline and recenter the headline."
7460 (let ((window (get-buffer-window)))
7461 (when window
7462 (goto-char (point-min))
7463 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7464 (set-window-start window (line-beginning-position))))))
7466 ;;; Saving and restoring visibility
7468 (defun org-outline-overlay-data (&optional use-markers)
7469 "Return a list of the locations of all outline overlays.
7470 These are overlays with the `invisible' property value `outline'.
7471 The return value is a list of cons cells, with start and stop
7472 positions for each overlay.
7473 If USE-MARKERS is set, return the positions as markers."
7474 (let (beg end)
7475 (org-with-wide-buffer
7476 (delq nil
7477 (mapcar (lambda (o)
7478 (when (eq (overlay-get o 'invisible) 'outline)
7479 (setq beg (overlay-start o)
7480 end (overlay-end o))
7481 (and beg end (> end beg)
7482 (if use-markers
7483 (cons (copy-marker beg)
7484 (copy-marker end t))
7485 (cons beg end)))))
7486 (overlays-in (point-min) (point-max)))))))
7488 (defun org-set-outline-overlay-data (data)
7489 "Create visibility overlays for all positions in DATA.
7490 DATA should have been made by `org-outline-overlay-data'."
7491 (org-with-wide-buffer
7492 (outline-show-all)
7493 (dolist (c data) (outline-flag-region (car c) (cdr c) t))))
7495 ;;; Folding of blocks
7497 (defvar-local org-hide-block-overlays nil
7498 "Overlays hiding blocks.")
7500 (defun org-block-map (function &optional start end)
7501 "Call FUNCTION at the head of all source blocks in the current buffer.
7502 Optional arguments START and END can be used to limit the range."
7503 (let ((start (or start (point-min)))
7504 (end (or end (point-max))))
7505 (save-excursion
7506 (goto-char start)
7507 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7508 (save-excursion
7509 (save-match-data
7510 (goto-char (match-beginning 0))
7511 (funcall function)))))))
7513 (defun org-hide-block-toggle-all ()
7514 "Toggle the visibility of all blocks in the current buffer."
7515 (org-block-map 'org-hide-block-toggle))
7517 (defun org-hide-block-all ()
7518 "Fold all blocks in the current buffer."
7519 (interactive)
7520 (org-show-block-all)
7521 (org-block-map 'org-hide-block-toggle-maybe))
7523 (defun org-show-block-all ()
7524 "Unfold all blocks in the current buffer."
7525 (interactive)
7526 (mapc #'delete-overlay org-hide-block-overlays)
7527 (setq org-hide-block-overlays nil))
7529 (defun org-hide-block-toggle-maybe ()
7530 "Toggle visibility of block at point.
7531 Unlike to `org-hide-block-toggle', this function does not throw
7532 an error. Return a non-nil value when toggling is successful."
7533 (interactive)
7534 (ignore-errors (org-hide-block-toggle)))
7536 (defun org-hide-block-toggle (&optional force)
7537 "Toggle the visibility of the current block.
7538 When optional argument FORCE is `off', make block visible. If it
7539 is non-nil, hide it unconditionally. Throw an error when not at
7540 a block. Return a non-nil value when toggling is successful."
7541 (interactive)
7542 (let ((element (org-element-at-point)))
7543 (unless (memq (org-element-type element)
7544 '(center-block comment-block dynamic-block example-block
7545 export-block quote-block special-block
7546 src-block verse-block))
7547 (user-error "Not at a block"))
7548 (let* ((start (save-excursion
7549 (goto-char (org-element-property :post-affiliated element))
7550 (line-end-position)))
7551 (end (save-excursion
7552 (goto-char (org-element-property :end element))
7553 (skip-chars-backward " \r\t\n")
7554 (line-end-position)))
7555 (overlays (overlays-at start)))
7556 (cond
7557 ;; Do nothing when not before or at the block opening line or
7558 ;; at the block closing line.
7559 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7560 ((and (not (eq force 'off))
7561 (not (memq t (mapcar
7562 (lambda (o)
7563 (eq (overlay-get o 'invisible) 'org-hide-block))
7564 overlays))))
7565 (let ((ov (make-overlay start end)))
7566 (overlay-put ov 'invisible 'org-hide-block)
7567 ;; Make the block accessible to `isearch'.
7568 (overlay-put
7569 ov 'isearch-open-invisible
7570 (lambda (ov)
7571 (when (memq ov org-hide-block-overlays)
7572 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7573 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7574 (delete-overlay ov))))
7575 (push ov org-hide-block-overlays)
7576 ;; When the block is hidden away, make sure point is left in
7577 ;; a visible part of the buffer.
7578 (when (> (line-beginning-position) start)
7579 (goto-char start)
7580 (beginning-of-line))
7581 ;; Signal successful toggling.
7583 ((or (not force) (eq force 'off))
7584 (dolist (ov overlays t)
7585 (when (memq ov org-hide-block-overlays)
7586 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7587 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7588 (delete-overlay ov))))))))
7590 ;; Remove overlays when changing major mode
7591 (add-hook 'org-mode-hook
7592 (lambda () (add-hook 'change-major-mode-hook
7593 'org-show-block-all 'append 'local)))
7595 ;;; Org-goto
7597 (defvar org-goto-window-configuration nil)
7598 (defvar org-goto-marker nil)
7599 (defvar org-goto-map)
7600 (defun org-goto-map ()
7601 "Set the keymap `org-goto'."
7602 (setq org-goto-map
7603 (let ((map (make-sparse-keymap)))
7604 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7605 mouse-drag-region universal-argument org-occur)))
7606 (dolist (cmd cmds)
7607 (substitute-key-definition cmd cmd map global-map)))
7608 (suppress-keymap map)
7609 (org-defkey map "\C-m" 'org-goto-ret)
7610 (org-defkey map [(return)] 'org-goto-ret)
7611 (org-defkey map [(left)] 'org-goto-left)
7612 (org-defkey map [(right)] 'org-goto-right)
7613 (org-defkey map [(control ?g)] 'org-goto-quit)
7614 (org-defkey map "\C-i" 'org-cycle)
7615 (org-defkey map [(tab)] 'org-cycle)
7616 (org-defkey map [(down)] 'outline-next-visible-heading)
7617 (org-defkey map [(up)] 'outline-previous-visible-heading)
7618 (if org-goto-auto-isearch
7619 (if (fboundp 'define-key-after)
7620 (define-key-after map [t] 'org-goto-local-auto-isearch)
7621 nil)
7622 (org-defkey map "q" 'org-goto-quit)
7623 (org-defkey map "n" 'outline-next-visible-heading)
7624 (org-defkey map "p" 'outline-previous-visible-heading)
7625 (org-defkey map "f" 'outline-forward-same-level)
7626 (org-defkey map "b" 'outline-backward-same-level)
7627 (org-defkey map "u" 'outline-up-heading))
7628 (org-defkey map "/" 'org-occur)
7629 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7630 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7631 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7632 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7633 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7634 map)))
7636 (defconst org-goto-help
7637 "Browse buffer copy, to find location or copy text.%s
7638 RET=jump to location C-g=quit and return to previous location
7639 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7641 (defvar org-goto-start-pos) ; dynamically scoped parameter
7643 (defun org-goto (&optional alternative-interface)
7644 "Look up a different location in the current file, keeping current visibility.
7646 When you want look-up or go to a different location in a
7647 document, the fastest way is often to fold the entire buffer and
7648 then dive into the tree. This method has the disadvantage, that
7649 the previous location will be folded, which may not be what you
7650 want.
7652 This command works around this by showing a copy of the current
7653 buffer in an indirect buffer, in overview mode. You can dive
7654 into the tree in that copy, use org-occur and incremental search
7655 to find a location. When pressing RET or `Q', the command
7656 returns to the original buffer in which the visibility is still
7657 unchanged. After RET it will also jump to the location selected
7658 in the indirect buffer and expose the headline hierarchy above.
7660 With a prefix argument, use the alternative interface: e.g., if
7661 `org-goto-interface' is `outline' use `outline-path-completion'."
7662 (interactive "P")
7663 (org-goto-map)
7664 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7665 (org-refile-use-outline-path t)
7666 (org-refile-target-verify-function nil)
7667 (interface
7668 (if (not alternative-interface)
7669 org-goto-interface
7670 (if (eq org-goto-interface 'outline)
7671 'outline-path-completion
7672 'outline)))
7673 (org-goto-start-pos (point))
7674 (selected-point
7675 (if (eq interface 'outline)
7676 (car (org-get-location (current-buffer) org-goto-help))
7677 (let ((pa (org-refile-get-location "Goto")))
7678 (org-refile-check-position pa)
7679 (nth 3 pa)))))
7680 (if selected-point
7681 (progn
7682 (org-mark-ring-push org-goto-start-pos)
7683 (goto-char selected-point)
7684 (when (or (outline-invisible-p) (org-invisible-p2))
7685 (org-show-context 'org-goto)))
7686 (message "Quit"))))
7688 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7689 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7690 (defvar org-goto-local-auto-isearch-map) ; defined below
7692 (defun org-get-location (_buf help)
7693 "Let the user select a location in current buffer.
7694 This function uses a recursive edit. It returns the selected position
7695 or nil."
7696 (org-no-popups
7697 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7698 (isearch-hide-immediately nil)
7699 (isearch-search-fun-function
7700 (lambda () 'org-goto-local-search-headings))
7701 (org-goto-selected-point org-goto-exit-command))
7702 (save-excursion
7703 (save-window-excursion
7704 (delete-other-windows)
7705 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7706 (pop-to-buffer-same-window
7707 (condition-case nil
7708 (make-indirect-buffer (current-buffer) "*org-goto*")
7709 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7710 (with-output-to-temp-buffer "*Org Help*"
7711 (princ (format help (if org-goto-auto-isearch
7712 " Just type for auto-isearch."
7713 " n/p/f/b/u to navigate, q to quit."))))
7714 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7715 (setq buffer-read-only nil)
7716 (let ((org-startup-truncated t)
7717 (org-startup-folded nil)
7718 (org-startup-align-all-tables nil))
7719 (org-mode)
7720 (org-overview))
7721 (setq buffer-read-only t)
7722 (if (and (boundp 'org-goto-start-pos)
7723 (integer-or-marker-p org-goto-start-pos))
7724 (progn (goto-char org-goto-start-pos)
7725 (when (outline-invisible-p)
7726 (org-show-set-visibility 'lineage)))
7727 (goto-char (point-min)))
7728 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7729 (message "Select location and press RET")
7730 (use-local-map org-goto-map)
7731 (recursive-edit)))
7732 (kill-buffer "*org-goto*")
7733 (cons org-goto-selected-point org-goto-exit-command))))
7735 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7736 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7737 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7738 (if (fboundp 'isearch-other-control-char)
7739 (progn
7740 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7741 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7742 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7743 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7744 (define-key org-goto-local-auto-isearch-map [return] nil))
7746 (defun org-goto-local-search-headings (string bound noerror)
7747 "Search and make sure that any matches are in headlines."
7748 (catch 'return
7749 (while (if isearch-forward
7750 (search-forward string bound noerror)
7751 (search-backward string bound noerror))
7752 (when (save-match-data
7753 (and (save-excursion
7754 (beginning-of-line)
7755 (looking-at org-complex-heading-regexp))
7756 (or (not (match-beginning 5))
7757 (< (point) (match-beginning 5)))))
7758 (throw 'return (point))))))
7760 (defun org-goto-local-auto-isearch ()
7761 "Start isearch."
7762 (interactive)
7763 (goto-char (point-min))
7764 (let ((keys (this-command-keys)))
7765 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7766 (isearch-mode t)
7767 (isearch-process-search-char (string-to-char keys)))))
7769 (defun org-goto-ret (&optional _arg)
7770 "Finish `org-goto' by going to the new location."
7771 (interactive "P")
7772 (setq org-goto-selected-point (point))
7773 (setq org-goto-exit-command 'return)
7774 (throw 'exit nil))
7776 (defun org-goto-left ()
7777 "Finish `org-goto' by going to the new location."
7778 (interactive)
7779 (if (org-at-heading-p)
7780 (progn
7781 (beginning-of-line 1)
7782 (setq org-goto-selected-point (point)
7783 org-goto-exit-command 'left)
7784 (throw 'exit nil))
7785 (user-error "Not on a heading")))
7787 (defun org-goto-right ()
7788 "Finish `org-goto' by going to the new location."
7789 (interactive)
7790 (if (org-at-heading-p)
7791 (progn
7792 (setq org-goto-selected-point (point)
7793 org-goto-exit-command 'right)
7794 (throw 'exit nil))
7795 (user-error "Not on a heading")))
7797 (defun org-goto-quit ()
7798 "Finish `org-goto' without cursor motion."
7799 (interactive)
7800 (setq org-goto-selected-point nil)
7801 (setq org-goto-exit-command 'quit)
7802 (throw 'exit nil))
7804 ;;; Indirect buffer display of subtrees
7806 (defvar org-indirect-dedicated-frame nil
7807 "This is the frame being used for indirect tree display.")
7808 (defvar org-last-indirect-buffer nil)
7810 (defun org-tree-to-indirect-buffer (&optional arg)
7811 "Create indirect buffer and narrow it to current subtree.
7813 With a numerical prefix ARG, go up to this level and then take that tree.
7814 If ARG is negative, go up that many levels.
7816 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7817 indirect buffer previously made with this command, to avoid proliferation of
7818 indirect buffers. However, when you call the command with a \
7819 `\\[universal-argument]' prefix, or
7820 when `org-indirect-buffer-display' is `new-frame', the last buffer is kept
7821 so that you can work with several indirect buffers at the same time. If
7822 `org-indirect-buffer-display' is `dedicated-frame', the \
7823 `\\[universal-argument]' prefix also
7824 requests that a new frame be made for the new buffer, so that the dedicated
7825 frame is not changed."
7826 (interactive "P")
7827 (let ((cbuf (current-buffer))
7828 (cwin (selected-window))
7829 (pos (point))
7830 beg end level heading ibuf)
7831 (save-excursion
7832 (org-back-to-heading t)
7833 (when (numberp arg)
7834 (setq level (org-outline-level))
7835 (when (< arg 0) (setq arg (+ level arg)))
7836 (while (> (setq level (org-outline-level)) arg)
7837 (org-up-heading-safe)))
7838 (setq beg (point)
7839 heading (org-get-heading 'no-tags))
7840 (org-end-of-subtree t t)
7841 (when (org-at-heading-p) (backward-char 1))
7842 (setq end (point)))
7843 (when (and (buffer-live-p org-last-indirect-buffer)
7844 (not (eq org-indirect-buffer-display 'new-frame))
7845 (not arg))
7846 (kill-buffer org-last-indirect-buffer))
7847 (setq ibuf (org-get-indirect-buffer cbuf heading)
7848 org-last-indirect-buffer ibuf)
7849 (cond
7850 ((or (eq org-indirect-buffer-display 'new-frame)
7851 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7852 (select-frame (make-frame))
7853 (delete-other-windows)
7854 (pop-to-buffer-same-window ibuf)
7855 (org-set-frame-title heading))
7856 ((eq org-indirect-buffer-display 'dedicated-frame)
7857 (raise-frame
7858 (select-frame (or (and org-indirect-dedicated-frame
7859 (frame-live-p org-indirect-dedicated-frame)
7860 org-indirect-dedicated-frame)
7861 (setq org-indirect-dedicated-frame (make-frame)))))
7862 (delete-other-windows)
7863 (pop-to-buffer-same-window ibuf)
7864 (org-set-frame-title (concat "Indirect: " heading)))
7865 ((eq org-indirect-buffer-display 'current-window)
7866 (pop-to-buffer-same-window ibuf))
7867 ((eq org-indirect-buffer-display 'other-window)
7868 (pop-to-buffer ibuf))
7869 (t (error "Invalid value")))
7870 (narrow-to-region beg end)
7871 (outline-show-all)
7872 (goto-char pos)
7873 (run-hook-with-args 'org-cycle-hook 'all)
7874 (and (window-live-p cwin) (select-window cwin))))
7876 (defun org-get-indirect-buffer (&optional buffer heading)
7877 (setq buffer (or buffer (current-buffer)))
7878 (let ((n 1) (base (buffer-name buffer)) bname)
7879 (while (buffer-live-p
7880 (get-buffer
7881 (setq bname
7882 (concat base "-"
7883 (if heading (concat heading "-" (number-to-string n))
7884 (number-to-string n))))))
7885 (setq n (1+ n)))
7886 (condition-case nil
7887 (make-indirect-buffer buffer bname 'clone)
7888 (error (make-indirect-buffer buffer bname)))))
7890 (defun org-set-frame-title (title)
7891 "Set the title of the current frame to the string TITLE."
7892 (modify-frame-parameters (selected-frame) (list (cons 'name title))))
7894 ;;;; Structure editing
7896 ;;; Inserting headlines
7898 (defun org--line-empty-p (n)
7899 "Is the Nth next line empty?
7901 Counts the current line as N = 1 and the previous line as N = 0;
7902 see `beginning-of-line'."
7903 (save-excursion
7904 (and (not (bobp))
7905 (or (beginning-of-line n) t)
7906 (save-match-data
7907 (looking-at "[ \t]*$")))))
7909 (defun org-previous-line-empty-p ()
7910 "Is the previous line a blank line?
7911 When NEXT is non-nil, check the next line instead."
7912 (org--line-empty-p 0))
7914 (defun org-next-line-empty-p ()
7915 "Is the previous line a blank line?
7916 When NEXT is non-nil, check the next line instead."
7917 (org--line-empty-p 2))
7919 (defun org-insert-heading (&optional arg invisible-ok top)
7920 "Insert a new heading or an item with the same depth at point.
7922 If point is at the beginning of a heading or a list item, insert
7923 a new heading or a new item above the current one. When at the
7924 beginning of a regular line of text, turn it into a heading.
7926 If point is in the middle of a line, split it and create a new
7927 headline/item with the text in the current line after point (see
7928 `org-M-RET-may-split-line' on how to modify this behavior). As
7929 a special case, on a headline, splitting can only happen on the
7930 title itself. E.g., this excludes breaking stars or tags.
7932 With a `\\[universal-argument]' prefix, set \
7933 `org-insert-heading-respect-content' to
7934 a non-nil value for the duration of the command. This forces the
7935 insertion of a heading after the current subtree, independently
7936 on the location of point.
7938 With a `\\[universal-argument] \\[universal-argument]' prefix, \
7939 insert the heading at the end of the tree
7940 above the current heading. For example, if point is within a
7941 2nd-level heading, then it will insert a 2nd-level heading at
7942 the end of the 1st-level parent subtree.
7944 When INVISIBLE-OK is set, stop at invisible headlines when going
7945 back. This is important for non-interactive uses of the
7946 command.
7948 When optional argument TOP is non-nil, insert a level 1 heading,
7949 unconditionally."
7950 (interactive "P")
7951 (let ((itemp (and (not top) (org-in-item-p)))
7952 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7953 (respect-content (or org-insert-heading-respect-content
7954 (equal arg '(4))))
7955 (initial-content ""))
7957 (cond
7959 ((or (= (buffer-size) 0)
7960 (and (not (save-excursion
7961 (and (ignore-errors (org-back-to-heading invisible-ok))
7962 (org-at-heading-p))))
7963 (or arg (not itemp))))
7964 ;; At beginning of buffer or so high up that only a heading
7965 ;; makes sense.
7966 (cond ((and (bolp) (not respect-content)) (insert "* "))
7967 ((not respect-content)
7968 (unless may-split (end-of-line))
7969 (insert "\n* "))
7970 ((re-search-forward org-outline-regexp-bol nil t)
7971 (beginning-of-line)
7972 (insert "* \n")
7973 (backward-char))
7974 (t (goto-char (point-max))
7975 (insert "\n* ")))
7976 (run-hooks 'org-insert-heading-hook))
7978 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7981 ;; Maybe move at the end of the subtree
7982 (when (equal arg '(16))
7983 (org-up-heading-safe)
7984 (org-end-of-subtree t))
7985 ;; Insert a heading
7986 (save-restriction
7987 (widen)
7988 (let* ((level nil)
7989 (on-heading (org-at-heading-p))
7990 (empty-line-p (if on-heading
7991 (org-previous-line-empty-p)
7992 ;; We will decide later
7993 nil))
7994 ;; Get a level string to fall back on.
7995 (fix-level
7996 (if (org-before-first-heading-p) "*"
7997 (save-excursion
7998 (org-back-to-heading t)
7999 (when (org-previous-line-empty-p) (setq empty-line-p t))
8000 (looking-at org-outline-regexp)
8001 (make-string (1- (length (match-string 0))) ?*))))
8002 (stars
8003 (save-excursion
8004 (condition-case nil
8005 (if top "* "
8006 (org-back-to-heading invisible-ok)
8007 (when (and (not on-heading)
8008 (featurep 'org-inlinetask)
8009 (integerp org-inlinetask-min-level)
8010 (>= (length (match-string 0))
8011 org-inlinetask-min-level))
8012 ;; Find a heading level before the inline
8013 ;; task.
8014 (while (and (setq level (org-up-heading-safe))
8015 (>= level org-inlinetask-min-level)))
8016 (if (org-at-heading-p)
8017 (org-back-to-heading invisible-ok)
8018 (error "This should not happen")))
8019 (unless (and (save-excursion
8020 (save-match-data
8021 (org-backward-heading-same-level
8022 1 invisible-ok))
8023 (= (point) (match-beginning 0)))
8024 (not (org-next-line-empty-p)))
8025 (setq empty-line-p (or empty-line-p
8026 (org-previous-line-empty-p))))
8027 (match-string 0))
8028 (error (or fix-level "* ")))))
8029 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
8030 (blank (if (eq blank-a 'auto) empty-line-p blank-a)))
8032 ;; If we insert after content, move there and clean up
8033 ;; whitespace.
8034 (when respect-content
8035 (if (not (org-before-first-heading-p))
8036 (org-end-of-subtree nil t)
8037 (re-search-forward org-outline-regexp-bol)
8038 (beginning-of-line 0))
8039 (skip-chars-backward " \r\t\n")
8040 (and (not (looking-back "^\\*+" (line-beginning-position)))
8041 (looking-at "[ \t]+") (replace-match ""))
8042 (unless (eobp) (forward-char 1))
8043 (when (looking-at "^\\*")
8044 (unless (bobp) (backward-char 1))
8045 (insert "\n")))
8047 ;; If we are splitting, grab the text that should be moved
8048 ;; to the new headline.
8049 (when may-split
8050 (if (org-at-heading-p)
8051 ;; This is a heading: split intelligently (keeping
8052 ;; tags).
8053 (let ((pos (point)))
8054 (beginning-of-line)
8055 (let ((case-fold-search nil))
8056 (unless (looking-at org-complex-heading-regexp)
8057 (error "This should not happen")))
8058 (when (and (match-beginning 4)
8059 (> pos (match-beginning 4))
8060 (< pos (match-end 4)))
8061 (setq initial-content (buffer-substring pos (match-end 4)))
8062 (goto-char pos)
8063 (delete-region (point) (match-end 4))
8064 (if (looking-at "[ \t]*$")
8065 (replace-match "")
8066 (insert (make-string (length initial-content) ?\s)))
8067 (setq initial-content (org-trim initial-content)))
8068 (goto-char pos))
8069 ;; A normal line.
8070 (setq initial-content
8071 (org-trim
8072 (delete-and-extract-region (point) (line-end-position))))))
8074 ;; If we are at the beginning of the line, insert before it.
8075 ;; Otherwise, after it.
8076 (cond
8077 ((and (bolp) (looking-at "[ \t]*$")))
8078 ((bolp) (save-excursion (insert "\n")))
8079 (t (end-of-line)
8080 (insert "\n")))
8082 ;; Insert the new heading
8083 (insert stars)
8084 (just-one-space)
8085 (insert initial-content)
8086 (unless (and blank (org-previous-line-empty-p))
8087 (org-N-empty-lines-before-current (if blank 1 0)))
8088 ;; Adjust visibility, which may be messed up if we removed
8089 ;; blank lines while previous entry was hidden.
8090 (let ((bol (line-beginning-position)))
8091 (dolist (o (overlays-at (1- bol)))
8092 (when (and (eq (overlay-get o 'invisible) 'outline)
8093 (eq (overlay-end o) bol))
8094 (move-overlay o (overlay-start o) (1- bol)))))
8095 (run-hooks 'org-insert-heading-hook)))))))
8097 (defun org-N-empty-lines-before-current (N)
8098 "Make the number of empty lines before current exactly N.
8099 So this will delete or add empty lines."
8100 (save-excursion
8101 (beginning-of-line)
8102 (let ((p (point)))
8103 (skip-chars-backward " \r\t\n")
8104 (unless (bolp) (forward-line))
8105 (delete-region (point) p))
8106 (when (> N 0) (insert (make-string N ?\n)))))
8108 (defun org-get-heading (&optional no-tags no-todo)
8109 "Return the heading of the current entry, without the stars.
8110 When NO-TAGS is non-nil, don't include tags.
8111 When NO-TODO is non-nil, don't include TODO keywords."
8112 (save-excursion
8113 (org-back-to-heading t)
8114 (let ((case-fold-search nil))
8115 (cond
8116 ((and no-tags no-todo)
8117 (looking-at org-complex-heading-regexp)
8118 ;; Return value has to be a string, but match group 4 is
8119 ;; optional.
8120 (or (match-string 4) ""))
8121 (no-tags
8122 (looking-at (concat org-outline-regexp
8123 "\\(.*?\\)"
8124 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
8125 (match-string 1))
8126 (no-todo
8127 (looking-at org-todo-line-regexp)
8128 (match-string 3))
8129 (t (looking-at org-heading-regexp)
8130 (match-string 2))))))
8132 (defvar orgstruct-mode) ; defined below
8134 (defun org-heading-components ()
8135 "Return the components of the current heading.
8136 This is a list with the following elements:
8137 - the level as an integer
8138 - the reduced level, different if `org-odd-levels-only' is set.
8139 - the TODO keyword, or nil
8140 - the priority character, like ?A, or nil if no priority is given
8141 - the headline text itself, or the tags string if no headline text
8142 - the tags string, or nil."
8143 (save-excursion
8144 (org-back-to-heading t)
8145 (when (let (case-fold-search)
8146 (looking-at
8147 (if orgstruct-mode
8148 org-heading-regexp
8149 org-complex-heading-regexp)))
8150 (if orgstruct-mode
8151 (list (length (match-string 1))
8152 (org-reduced-level (length (match-string 1)))
8155 (match-string 2)
8156 nil)
8157 (list (length (match-string 1))
8158 (org-reduced-level (length (match-string 1)))
8159 (match-string-no-properties 2)
8160 (and (match-end 3) (aref (match-string 3) 2))
8161 (match-string-no-properties 4)
8162 (match-string-no-properties 5))))))
8164 (defun org-get-entry ()
8165 "Get the entry text, after heading, entire subtree."
8166 (save-excursion
8167 (org-back-to-heading t)
8168 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
8170 (defun org-edit-headline (&optional heading)
8171 "Edit the current headline.
8172 Set it to HEADING when provided."
8173 (interactive)
8174 (org-with-wide-buffer
8175 (org-back-to-heading t)
8176 (let ((case-fold-search nil))
8177 (when (looking-at org-complex-heading-regexp)
8178 (let* ((old (match-string-no-properties 4))
8179 (new (save-match-data
8180 (org-trim (or heading (read-string "Edit: " old))))))
8181 (unless (equal old new)
8182 (if old (replace-match new t t nil 4)
8183 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
8184 (insert " " new))
8185 (org-set-tags nil t)
8186 (when (looking-at "[ \t]*$") (replace-match ""))))))))
8188 (defun org-insert-heading-after-current ()
8189 "Insert a new heading with same level as current, after current subtree."
8190 (interactive)
8191 (org-back-to-heading)
8192 (org-insert-heading)
8193 (org-move-subtree-down)
8194 (end-of-line 1))
8196 (defun org-insert-heading-respect-content (&optional invisible-ok)
8197 "Insert heading with `org-insert-heading-respect-content' set to t."
8198 (interactive)
8199 (org-insert-heading '(4) invisible-ok))
8201 (defun org-insert-todo-heading-respect-content (&optional force-state)
8202 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
8203 (interactive)
8204 (org-insert-todo-heading force-state '(4)))
8206 (defun org-insert-todo-heading (arg &optional force-heading)
8207 "Insert a new heading with the same level and TODO state as current heading.
8209 If the heading has no TODO state, or if the state is DONE, use
8210 the first state (TODO by default). Also with one prefix arg,
8211 force first state. With two prefix args, force inserting at the
8212 end of the parent subtree.
8214 When called at a plain list item, insert a new item with an
8215 unchecked check box."
8216 (interactive "P")
8217 (when (or force-heading (not (org-insert-item 'checkbox)))
8218 (org-insert-heading (or (and (equal arg '(16)) '(16))
8219 force-heading))
8220 (save-excursion
8221 (org-back-to-heading)
8222 (outline-previous-heading)
8223 (let ((case-fold-search nil)) (looking-at org-todo-line-regexp)))
8224 (let* ((new-mark-x
8225 (if (or (equal arg '(4))
8226 (not (match-beginning 2))
8227 (member (match-string 2) org-done-keywords))
8228 (car org-todo-keywords-1)
8229 (match-string 2)))
8230 (new-mark
8232 (run-hook-with-args-until-success
8233 'org-todo-get-default-hook new-mark-x nil)
8234 new-mark-x)))
8235 (beginning-of-line 1)
8236 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8237 (if org-treat-insert-todo-heading-as-state-change
8238 (org-todo new-mark)
8239 (insert new-mark " "))))
8240 (when org-provide-todo-statistics
8241 (org-update-parent-todo-statistics))))
8243 (defun org-insert-subheading (arg)
8244 "Insert a new subheading and demote it.
8245 Works for outline headings and for plain lists alike."
8246 (interactive "P")
8247 (org-insert-heading arg)
8248 (cond
8249 ((org-at-heading-p) (org-do-demote))
8250 ((org-at-item-p) (org-indent-item))))
8252 (defun org-insert-todo-subheading (arg)
8253 "Insert a new subheading with TODO keyword or checkbox and demote it.
8254 Works for outline headings and for plain lists alike."
8255 (interactive "P")
8256 (org-insert-todo-heading arg)
8257 (cond
8258 ((org-at-heading-p) (org-do-demote))
8259 ((org-at-item-p) (org-indent-item))))
8261 ;;; Promotion and Demotion
8263 (defvar org-after-demote-entry-hook nil
8264 "Hook run after an entry has been demoted.
8265 The cursor will be at the beginning of the entry.
8266 When a subtree is being demoted, the hook will be called for each node.")
8268 (defvar org-after-promote-entry-hook nil
8269 "Hook run after an entry has been promoted.
8270 The cursor will be at the beginning of the entry.
8271 When a subtree is being promoted, the hook will be called for each node.")
8273 (defun org-promote-subtree ()
8274 "Promote the entire subtree.
8275 See also `org-promote'."
8276 (interactive)
8277 (save-excursion
8278 (org-with-limited-levels (org-map-tree 'org-promote)))
8279 (org-fix-position-after-promote))
8281 (defun org-demote-subtree ()
8282 "Demote the entire subtree.
8283 See `org-demote' and `org-promote'."
8284 (interactive)
8285 (save-excursion
8286 (org-with-limited-levels (org-map-tree 'org-demote)))
8287 (org-fix-position-after-promote))
8289 (defun org-do-promote ()
8290 "Promote the current heading higher up the tree.
8291 If the region is active in `transient-mark-mode', promote all
8292 headings in the region."
8293 (interactive)
8294 (save-excursion
8295 (if (org-region-active-p)
8296 (org-map-region 'org-promote (region-beginning) (region-end))
8297 (org-promote)))
8298 (org-fix-position-after-promote))
8300 (defun org-do-demote ()
8301 "Demote the current heading lower down the tree.
8302 If the region is active in `transient-mark-mode', demote all
8303 headings in the region."
8304 (interactive)
8305 (save-excursion
8306 (if (org-region-active-p)
8307 (org-map-region 'org-demote (region-beginning) (region-end))
8308 (org-demote)))
8309 (org-fix-position-after-promote))
8311 (defun org-fix-position-after-promote ()
8312 "Fix cursor position and indentation after demoting/promoting."
8313 (let ((pos (point)))
8314 (when (save-excursion
8315 (beginning-of-line)
8316 (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
8317 (or (eq pos (match-end 1)) (eq pos (match-end 2))))
8318 (cond ((eobp) (insert " "))
8319 ((eolp) (insert " "))
8320 ((equal (char-after) ?\s) (forward-char 1))))))
8322 (defun org-current-level ()
8323 "Return the level of the current entry, or nil if before the first headline.
8324 The level is the number of stars at the beginning of the
8325 headline. Use `org-reduced-level' to remove the effect of
8326 `org-odd-levels'. Unlike to `org-outline-level', this function
8327 ignores inlinetasks."
8328 (let ((level (org-with-limited-levels (org-outline-level))))
8329 (and (> level 0) level)))
8331 (defun org-get-previous-line-level ()
8332 "Return the outline depth of the last headline before the current line.
8333 Returns 0 for the first headline in the buffer, and nil if before the
8334 first headline."
8335 (and (org-current-level)
8336 (or (and (/= (line-beginning-position) (point-min))
8337 (save-excursion (beginning-of-line 0) (org-current-level)))
8338 0)))
8340 (defun org-reduced-level (l)
8341 "Compute the effective level of a heading.
8342 This takes into account the setting of `org-odd-levels-only'."
8343 (cond
8344 ((zerop l) 0)
8345 (org-odd-levels-only (1+ (floor (/ l 2))))
8346 (t l)))
8348 (defun org-level-increment ()
8349 "Return the number of stars that will be added or removed at a
8350 time to headlines when structure editing, based on the value of
8351 `org-odd-levels-only'."
8352 (if org-odd-levels-only 2 1))
8354 (defun org-get-valid-level (level &optional change)
8355 "Rectify a level change under the influence of `org-odd-levels-only'
8356 LEVEL is a current level, CHANGE is by how much the level should be
8357 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8358 even level numbers will become the next higher odd number."
8359 (if org-odd-levels-only
8360 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8361 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8362 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8363 (max 1 (+ level (or change 0)))))
8365 (defun org-promote ()
8366 "Promote the current heading higher up the tree."
8367 (org-with-wide-buffer
8368 (org-back-to-heading t)
8369 (let* ((after-change-functions (remq 'flyspell-after-change-function
8370 after-change-functions))
8371 (level (save-match-data (funcall outline-level)))
8372 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8373 (diff (abs (- level (length up-head) -1))))
8374 (cond
8375 ((and (= level 1) org-allow-promoting-top-level-subtree)
8376 (replace-match "# " nil t))
8377 ((= level 1)
8378 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8379 (t (replace-match up-head nil t)))
8380 (unless (= level 1)
8381 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8382 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8383 (run-hooks 'org-after-promote-entry-hook))))
8385 (defun org-demote ()
8386 "Demote the current heading lower down the tree."
8387 (org-with-wide-buffer
8388 (org-back-to-heading t)
8389 (let* ((after-change-functions (remq 'flyspell-after-change-function
8390 after-change-functions))
8391 (level (save-match-data (funcall outline-level)))
8392 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8393 (diff (abs (- level (length down-head) -1))))
8394 (replace-match down-head nil t)
8395 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8396 (when org-adapt-indentation (org-fixup-indentation diff))
8397 (run-hooks 'org-after-demote-entry-hook))))
8399 (defun org-cycle-level ()
8400 "Cycle the level of an empty headline through possible states.
8401 This goes first to child, then to parent, level, then up the hierarchy.
8402 After top level, it switches back to sibling level."
8403 (interactive)
8404 (let ((org-adapt-indentation nil))
8405 (when (org-point-at-end-of-empty-headline)
8406 (setq this-command 'org-cycle-level) ; Only needed for caching
8407 (let ((cur-level (org-current-level))
8408 (prev-level (org-get-previous-line-level)))
8409 (cond
8410 ;; If first headline in file, promote to top-level.
8411 ((= prev-level 0)
8412 (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
8413 do (org-do-promote)))
8414 ;; If same level as prev, demote one.
8415 ((= prev-level cur-level)
8416 (org-do-demote))
8417 ;; If parent is top-level, promote to top level if not already.
8418 ((= prev-level 1)
8419 (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
8420 do (org-do-promote)))
8421 ;; If top-level, return to prev-level.
8422 ((= cur-level 1)
8423 (cl-loop repeat (/ (- prev-level 1) (org-level-increment))
8424 do (org-do-demote)))
8425 ;; If less than prev-level, promote one.
8426 ((< cur-level prev-level)
8427 (org-do-promote))
8428 ;; If deeper than prev-level, promote until higher than
8429 ;; prev-level.
8430 ((> cur-level prev-level)
8431 (cl-loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8432 do (org-do-promote))))
8433 t))))
8435 (defun org-map-tree (fun)
8436 "Call FUN for every heading underneath the current one."
8437 (org-back-to-heading t)
8438 (let ((level (funcall outline-level)))
8439 (save-excursion
8440 (funcall fun)
8441 (while (and (progn
8442 (outline-next-heading)
8443 (> (funcall outline-level) level))
8444 (not (eobp)))
8445 (funcall fun)))))
8447 (defun org-map-region (fun beg end)
8448 "Call FUN for every heading between BEG and END."
8449 (let ((org-ignore-region t))
8450 (save-excursion
8451 (setq end (copy-marker end))
8452 (goto-char beg)
8453 (when (and (re-search-forward org-outline-regexp-bol nil t)
8454 (< (point) end))
8455 (funcall fun))
8456 (while (and (progn
8457 (outline-next-heading)
8458 (< (point) end))
8459 (not (eobp)))
8460 (funcall fun)))))
8462 (defun org-fixup-indentation (diff)
8463 "Change the indentation in the current entry by DIFF.
8465 DIFF is an integer. Indentation is done according to the
8466 following rules:
8468 - Planning information and property drawers are always indented
8469 according to the new level of the headline;
8471 - Footnote definitions and their contents are ignored;
8473 - Inlinetasks' boundaries are not shifted;
8475 - Empty lines are ignored;
8477 - Other lines' indentation are shifted by DIFF columns, unless
8478 it would introduce a structural change in the document, in
8479 which case no shifting is done at all.
8481 Assume point is at a heading or an inlinetask beginning."
8482 (org-with-wide-buffer
8483 (narrow-to-region (line-beginning-position)
8484 (save-excursion
8485 (if (org-with-limited-levels (org-at-heading-p))
8486 (org-with-limited-levels (outline-next-heading))
8487 (org-inlinetask-goto-end))
8488 (point)))
8489 (forward-line)
8490 ;; Indent properly planning info and property drawer.
8491 (when (looking-at-p org-planning-line-re)
8492 (org-indent-line)
8493 (forward-line))
8494 (when (looking-at org-property-drawer-re)
8495 (goto-char (match-end 0))
8496 (forward-line)
8497 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8498 (catch 'no-shift
8499 (when (zerop diff) (throw 'no-shift nil))
8500 ;; If DIFF is negative, first check if a shift is possible at all
8501 ;; (e.g., it doesn't break structure). This can only happen if
8502 ;; some contents are not properly indented.
8503 (let ((case-fold-search t))
8504 (when (< diff 0)
8505 (let ((diff (- diff))
8506 (forbidden-re (concat org-outline-regexp
8507 "\\|"
8508 (substring org-footnote-definition-re 1))))
8509 (save-excursion
8510 (while (not (eobp))
8511 (cond
8512 ((looking-at-p "[ \t]*$") (forward-line))
8513 ((and (looking-at-p org-footnote-definition-re)
8514 (let ((e (org-element-at-point)))
8515 (and (eq (org-element-type e) 'footnote-definition)
8516 (goto-char (org-element-property :end e))))))
8517 ((looking-at-p org-outline-regexp) (forward-line))
8518 ;; Give up if shifting would move before column 0 or
8519 ;; if it would introduce a headline or a footnote
8520 ;; definition.
8522 (skip-chars-forward " \t")
8523 (let ((ind (current-column)))
8524 (when (or (< ind diff)
8525 (and (= ind diff) (looking-at-p forbidden-re)))
8526 (throw 'no-shift nil)))
8527 ;; Ignore contents of example blocks and source
8528 ;; blocks if their indentation is meant to be
8529 ;; preserved. Jump to block's closing line.
8530 (beginning-of-line)
8531 (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8532 (let ((e (org-element-at-point)))
8533 (and (memq (org-element-type e)
8534 '(example-block src-block))
8535 (or org-src-preserve-indentation
8536 (org-element-property :preserve-indent e))
8537 (goto-char (org-element-property :end e))
8538 (progn (skip-chars-backward " \r\t\n")
8539 (beginning-of-line)
8540 t))))
8541 (forward-line))))))))
8542 ;; Shift lines but footnote definitions, inlinetasks boundaries
8543 ;; by DIFF. Also skip contents of source or example blocks
8544 ;; when indentation is meant to be preserved.
8545 (while (not (eobp))
8546 (cond
8547 ((and (looking-at-p org-footnote-definition-re)
8548 (let ((e (org-element-at-point)))
8549 (and (eq (org-element-type e) 'footnote-definition)
8550 (goto-char (org-element-property :end e))))))
8551 ((looking-at-p org-outline-regexp) (forward-line))
8552 ((looking-at-p "[ \t]*$") (forward-line))
8554 (indent-line-to (+ (org-get-indentation) diff))
8555 (beginning-of-line)
8556 (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8557 (let ((e (org-element-at-point)))
8558 (and (memq (org-element-type e)
8559 '(example-block src-block))
8560 (or org-src-preserve-indentation
8561 (org-element-property :preserve-indent e))
8562 (goto-char (org-element-property :end e))
8563 (progn (skip-chars-backward " \r\t\n")
8564 (beginning-of-line)
8565 t))))
8566 (forward-line)))))))))
8568 (defun org-convert-to-odd-levels ()
8569 "Convert an Org file with all levels allowed to one with odd levels.
8570 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8571 level 5 etc."
8572 (interactive)
8573 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8574 (let ((outline-level 'org-outline-level)
8575 (org-odd-levels-only nil) n)
8576 (save-excursion
8577 (goto-char (point-min))
8578 (while (re-search-forward "^\\*\\*+ " nil t)
8579 (setq n (- (length (match-string 0)) 2))
8580 (while (>= (setq n (1- n)) 0)
8581 (org-demote))
8582 (end-of-line 1))))))
8584 (defun org-convert-to-oddeven-levels ()
8585 "Convert an Org file with only odd levels to one with odd/even levels.
8586 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8587 file contains a section with an even level, conversion would
8588 destroy the structure of the file. An error is signaled in this
8589 case."
8590 (interactive)
8591 (goto-char (point-min))
8592 ;; First check if there are no even levels
8593 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8594 (org-show-set-visibility 'canonical)
8595 (error "Not all levels are odd in this file. Conversion not possible"))
8596 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8597 (let ((outline-regexp org-outline-regexp)
8598 (outline-level 'org-outline-level)
8599 (org-odd-levels-only nil) n)
8600 (save-excursion
8601 (goto-char (point-min))
8602 (while (re-search-forward "^\\*\\*+ " nil t)
8603 (setq n (/ (1- (length (match-string 0))) 2))
8604 (while (>= (setq n (1- n)) 0)
8605 (org-promote))
8606 (end-of-line 1))))))
8608 (defun org-tr-level (n)
8609 "Make N odd if required."
8610 (if org-odd-levels-only (1+ (/ n 2)) n))
8612 ;;; Vertical tree motion, cutting and pasting of subtrees
8614 (defun org-move-subtree-up (&optional arg)
8615 "Move the current subtree up past ARG headlines of the same level."
8616 (interactive "p")
8617 (org-move-subtree-down (- (prefix-numeric-value arg))))
8619 (defun org-move-subtree-down (&optional arg)
8620 "Move the current subtree down past ARG headlines of the same level."
8621 (interactive "p")
8622 (setq arg (prefix-numeric-value arg))
8623 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8624 'org-get-last-sibling))
8625 (ins-point (make-marker))
8626 (cnt (abs arg))
8627 (col (current-column))
8628 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8629 ;; Select the tree
8630 (org-back-to-heading)
8631 (setq beg0 (point))
8632 (save-excursion
8633 (setq ne-beg (org-back-over-empty-lines))
8634 (setq beg (point)))
8635 (save-match-data
8636 (save-excursion (outline-end-of-heading)
8637 (setq folded (outline-invisible-p)))
8638 (progn (org-end-of-subtree nil t)
8639 (unless (eobp) (backward-char))))
8640 (outline-next-heading)
8641 (setq ne-end (org-back-over-empty-lines))
8642 (setq end (point))
8643 (goto-char beg0)
8644 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8645 ;; include less whitespace
8646 (save-excursion
8647 (goto-char beg)
8648 (forward-line (- ne-beg ne-end))
8649 (setq beg (point))))
8650 ;; Find insertion point, with error handling
8651 (while (> cnt 0)
8652 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8653 (progn (goto-char beg0)
8654 (user-error "Cannot move past superior level or buffer limit")))
8655 (setq cnt (1- cnt)))
8656 (when (> arg 0)
8657 ;; Moving forward - still need to move over subtree
8658 (org-end-of-subtree t t)
8659 (save-excursion
8660 (org-back-over-empty-lines)
8661 (or (bolp) (newline))))
8662 (setq ne-ins (org-back-over-empty-lines))
8663 (move-marker ins-point (point))
8664 (setq txt (buffer-substring beg end))
8665 (org-save-markers-in-region beg end)
8666 (delete-region beg end)
8667 (org-remove-empty-overlays-at beg)
8668 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8669 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8670 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8671 (let ((bbb (point)))
8672 (insert-before-markers txt)
8673 (org-reinstall-markers-in-region bbb)
8674 (move-marker ins-point bbb))
8675 (or (bolp) (insert "\n"))
8676 (setq ins-end (point))
8677 (goto-char ins-point)
8678 (org-skip-whitespace)
8679 (when (and (< arg 0)
8680 (org-first-sibling-p)
8681 (> ne-ins ne-beg))
8682 ;; Move whitespace back to beginning
8683 (save-excursion
8684 (goto-char ins-end)
8685 (let ((kill-whole-line t))
8686 (kill-line (- ne-ins ne-beg)) (point)))
8687 (insert (make-string (- ne-ins ne-beg) ?\n)))
8688 (move-marker ins-point nil)
8689 (if folded
8690 (outline-hide-subtree)
8691 (org-show-entry)
8692 (org-show-children)
8693 (org-cycle-hide-drawers 'children))
8694 (org-clean-visibility-after-subtree-move)
8695 ;; move back to the initial column we were at
8696 (move-to-column col)))
8698 (defvar org-subtree-clip ""
8699 "Clipboard for cut and paste of subtrees.
8700 This is actually only a copy of the kill, because we use the normal kill
8701 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8703 (defvar org-subtree-clip-folded nil
8704 "Was the last copied subtree folded?
8705 This is used to fold the tree back after pasting.")
8707 (defun org-cut-subtree (&optional n)
8708 "Cut the current subtree into the clipboard.
8709 With prefix arg N, cut this many sequential subtrees.
8710 This is a short-hand for marking the subtree and then cutting it."
8711 (interactive "p")
8712 (org-copy-subtree n 'cut))
8714 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8715 "Copy the current subtree it in the clipboard.
8716 With prefix arg N, copy this many sequential subtrees.
8717 This is a short-hand for marking the subtree and then copying it.
8718 If CUT is non-nil, actually cut the subtree.
8719 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8720 of some markers in the region, even if CUT is non-nil. This is
8721 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8722 (interactive "p")
8723 (let (beg end folded (beg0 (point)))
8724 (if (called-interactively-p 'any)
8725 (org-back-to-heading nil) ; take what looks like a subtree
8726 (org-back-to-heading t)) ; take what is really there
8727 (setq beg (point))
8728 (skip-chars-forward " \t\r\n")
8729 (save-match-data
8730 (if nosubtrees
8731 (outline-next-heading)
8732 (save-excursion (outline-end-of-heading)
8733 (setq folded (outline-invisible-p)))
8734 (ignore-errors (org-forward-heading-same-level (1- n) t))
8735 (org-end-of-subtree t t)))
8736 ;; Include the end of an inlinetask
8737 (when (and (featurep 'org-inlinetask)
8738 (looking-at-p (concat (org-inlinetask-outline-regexp)
8739 "END[ \t]*$")))
8740 (end-of-line))
8741 (setq end (point))
8742 (goto-char beg0)
8743 (when (> end beg)
8744 (setq org-subtree-clip-folded folded)
8745 (when (or cut force-store-markers)
8746 (org-save-markers-in-region beg end))
8747 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8748 (setq org-subtree-clip (current-kill 0))
8749 (message "%s: Subtree(s) with %d characters"
8750 (if cut "Cut" "Copied")
8751 (length org-subtree-clip)))))
8753 (defun org-paste-subtree (&optional level tree for-yank remove)
8754 "Paste the clipboard as a subtree, with modification of headline level.
8755 The entire subtree is promoted or demoted in order to match a new headline
8756 level.
8758 If the cursor is at the beginning of a headline, the same level as
8759 that headline is used to paste the tree.
8761 If not, the new level is derived from the *visible* headings
8762 before and after the insertion point, and taken to be the inferior headline
8763 level of the two. So if the previous visible heading is level 3 and the
8764 next is level 4 (or vice versa), level 4 will be used for insertion.
8765 This makes sure that the subtree remains an independent subtree and does
8766 not swallow low level entries.
8768 You can also force a different level, either by using a numeric prefix
8769 argument, or by inserting the heading marker by hand. For example, if the
8770 cursor is after \"*****\", then the tree will be shifted to level 5.
8772 If optional TREE is given, use this text instead of the kill ring.
8774 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8775 move back over whitespace before inserting, and move point to the end of
8776 the inserted text when done.
8778 When REMOVE is non-nil, remove the subtree from the clipboard."
8779 (interactive "P")
8780 (setq tree (or tree (and kill-ring (current-kill 0))))
8781 (unless (org-kill-is-subtree-p tree)
8782 (user-error "%s"
8783 (substitute-command-keys
8784 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8785 (org-with-limited-levels
8786 (let* ((visp (not (outline-invisible-p)))
8787 (txt tree)
8788 (^re_ "\\(\\*+\\)[ \t]*")
8789 (old-level (if (string-match org-outline-regexp-bol txt)
8790 (- (match-end 0) (match-beginning 0) 1)
8791 -1))
8792 (force-level (cond (level (prefix-numeric-value level))
8793 ((and (looking-at "[ \t]*$")
8794 (string-match
8795 "^\\*+$" (buffer-substring
8796 (point-at-bol) (point))))
8797 (- (match-end 0) (match-beginning 0)))
8798 ((and (bolp)
8799 (looking-at org-outline-regexp))
8800 (- (match-end 0) (point) 1))))
8801 (previous-level (save-excursion
8802 (condition-case nil
8803 (progn
8804 (outline-previous-visible-heading 1)
8805 (if (looking-at ^re_)
8806 (- (match-end 0) (match-beginning 0) 1)
8808 (error 1))))
8809 (next-level (save-excursion
8810 (condition-case nil
8811 (progn
8812 (or (looking-at org-outline-regexp)
8813 (outline-next-visible-heading 1))
8814 (if (looking-at ^re_)
8815 (- (match-end 0) (match-beginning 0) 1)
8817 (error 1))))
8818 (new-level (or force-level (max previous-level next-level)))
8819 (shift (if (or (= old-level -1)
8820 (= new-level -1)
8821 (= old-level new-level))
8823 (- new-level old-level)))
8824 (delta (if (> shift 0) -1 1))
8825 (func (if (> shift 0) 'org-demote 'org-promote))
8826 (org-odd-levels-only nil)
8827 beg end newend)
8828 ;; Remove the forced level indicator
8829 (when force-level
8830 (delete-region (point-at-bol) (point)))
8831 ;; Paste
8832 (beginning-of-line (if (bolp) 1 2))
8833 (setq beg (point))
8834 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8835 (insert-before-markers txt)
8836 (unless (string-suffix-p "\n" txt) (insert "\n"))
8837 (setq newend (point))
8838 (org-reinstall-markers-in-region beg)
8839 (setq end (point))
8840 (goto-char beg)
8841 (skip-chars-forward " \t\n\r")
8842 (setq beg (point))
8843 (when (and (outline-invisible-p) visp)
8844 (save-excursion (outline-show-heading)))
8845 ;; Shift if necessary
8846 (unless (= shift 0)
8847 (save-restriction
8848 (narrow-to-region beg end)
8849 (while (not (= shift 0))
8850 (org-map-region func (point-min) (point-max))
8851 (setq shift (+ delta shift)))
8852 (goto-char (point-min))
8853 (setq newend (point-max))))
8854 (when (or (called-interactively-p 'interactive) for-yank)
8855 (message "Clipboard pasted as level %d subtree" new-level))
8856 (when (and (not for-yank) ; in this case, org-yank will decide about folding
8857 kill-ring
8858 (eq org-subtree-clip (current-kill 0))
8859 org-subtree-clip-folded)
8860 ;; The tree was folded before it was killed/copied
8861 (outline-hide-subtree))
8862 (and for-yank (goto-char newend))
8863 (and remove (setq kill-ring (cdr kill-ring))))))
8865 (defun org-kill-is-subtree-p (&optional txt)
8866 "Check if the current kill is an outline subtree, or a set of trees.
8867 Returns nil if kill does not start with a headline, or if the first
8868 headline level is not the largest headline level in the tree.
8869 So this will actually accept several entries of equal levels as well,
8870 which is OK for `org-paste-subtree'.
8871 If optional TXT is given, check this string instead of the current kill."
8872 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8873 (re (org-get-limited-outline-regexp))
8874 (^re (concat "^" re))
8875 (start-level (and kill
8876 (string-match
8877 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8878 kill)
8879 (- (match-end 2) (match-beginning 2) 1)))
8880 (start (1+ (or (match-beginning 2) -1))))
8881 (if (not start-level)
8882 (progn
8883 nil) ;; does not even start with a heading
8884 (catch 'exit
8885 (while (setq start (string-match ^re kill (1+ start)))
8886 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8887 (throw 'exit nil)))
8888 t))))
8890 (defvar org-markers-to-move nil
8891 "Markers that should be moved with a cut-and-paste operation.
8892 Those markers are stored together with their positions relative to
8893 the start of the region.")
8895 (defun org-save-markers-in-region (beg end)
8896 "Check markers in region.
8897 If these markers are between BEG and END, record their position relative
8898 to BEG, so that after moving the block of text, we can put the markers back
8899 into place.
8900 This function gets called just before an entry or tree gets cut from the
8901 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8902 called immediately, to move the markers with the entries."
8903 (setq org-markers-to-move nil)
8904 (when (featurep 'org-clock)
8905 (org-clock-save-markers-for-cut-and-paste beg end))
8906 (when (featurep 'org-agenda)
8907 (org-agenda-save-markers-for-cut-and-paste beg end)))
8909 (defun org-check-and-save-marker (marker beg end)
8910 "Check if MARKER is between BEG and END.
8911 If yes, remember the marker and the distance to BEG."
8912 (when (and (marker-buffer marker)
8913 (equal (marker-buffer marker) (current-buffer))
8914 (>= marker beg) (< marker end))
8915 (push (cons marker (- marker beg)) org-markers-to-move)))
8917 (defun org-reinstall-markers-in-region (beg)
8918 "Move all remembered markers to their position relative to BEG."
8919 (dolist (x org-markers-to-move)
8920 (move-marker (car x) (+ beg (cdr x))))
8921 (setq org-markers-to-move nil))
8923 (defun org-narrow-to-subtree ()
8924 "Narrow buffer to the current subtree."
8925 (interactive)
8926 (save-excursion
8927 (save-match-data
8928 (org-with-limited-levels
8929 (narrow-to-region
8930 (progn (org-back-to-heading t) (point))
8931 (progn (org-end-of-subtree t t)
8932 (when (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8933 (point)))))))
8935 (defun org-narrow-to-block ()
8936 "Narrow buffer to the current block."
8937 (interactive)
8938 (let* ((case-fold-search t)
8939 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8940 "^[ \t]*#\\+end_.*")))
8941 (if blockp
8942 (narrow-to-region (car blockp) (cdr blockp))
8943 (user-error "Not in a block"))))
8945 (defun org-clone-subtree-with-time-shift (n &optional shift)
8946 "Clone the task (subtree) at point N times.
8947 The clones will be inserted as siblings.
8949 In interactive use, the user will be prompted for the number of
8950 clones to be produced. If the entry has a timestamp, the user
8951 will also be prompted for a time shift, which may be a repeater
8952 as used in time stamps, for example `+3d'. To disable this,
8953 you can call the function with a universal prefix argument.
8955 When a valid repeater is given and the entry contains any time
8956 stamps, the clones will become a sequence in time, with time
8957 stamps in the subtree shifted for each clone produced. If SHIFT
8958 is nil or the empty string, time stamps will be left alone. The
8959 ID property of the original subtree is removed.
8961 In each clone, all the CLOCK entries will be removed. This
8962 prevents Org from considering that the clocked times overlap.
8964 If the original subtree did contain time stamps with a repeater,
8965 the following will happen:
8966 - the repeater will be removed in each clone
8967 - an additional clone will be produced, with the current, unshifted
8968 date(s) in the entry.
8969 - the original entry will be placed *after* all the clones, with
8970 repeater intact.
8971 - the start days in the repeater in the original entry will be shifted
8972 to past the last clone.
8973 In this way you can spell out a number of instances of a repeating task,
8974 and still retain the repeater to cover future instances of the task.
8976 As described above, N+1 clones are produced when the original
8977 subtree has a repeater. Setting N to 0, then, can be used to
8978 remove the repeater from a subtree and create a shifted clone
8979 with the original repeater."
8980 (interactive "nNumber of clones to produce: ")
8981 (unless (wholenump n) (user-error "Invalid number of replications %s" n))
8982 (when (org-before-first-heading-p) (user-error "No subtree to clone"))
8983 (let* ((beg (save-excursion (org-back-to-heading t) (point)))
8984 (end-of-tree (save-excursion (org-end-of-subtree t t) (point)))
8985 (shift
8986 (or shift
8987 (if (and (not (equal current-prefix-arg '(4)))
8988 (save-excursion
8989 (goto-char beg)
8990 (re-search-forward org-ts-regexp-both end-of-tree t)))
8991 (read-from-minibuffer
8992 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8993 ""))) ;No time shift
8994 (doshift
8995 (and (org-string-nw-p shift)
8996 (or (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
8997 shift)
8998 (user-error "Invalid shift specification %s" shift)))))
8999 (goto-char end-of-tree)
9000 (unless (bolp) (insert "\n"))
9001 (let* ((end (point))
9002 (template (buffer-substring beg end))
9003 (shift-n (and doshift (string-to-number (match-string 1 shift))))
9004 (shift-what (pcase (and doshift (match-string 2 shift))
9005 (`nil nil)
9006 ("d" 'day)
9007 ("w" (setq shift-n (* 7 shift-n)) 'day)
9008 ("m" 'month)
9009 ("y" 'year)
9010 (_ (error "Unsupported time unit"))))
9011 (nmin 1)
9012 (nmax n)
9013 (n-no-remove -1)
9014 (idprop (org-entry-get nil "ID")))
9015 (when (and doshift
9016 (string-match-p "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>"
9017 template))
9018 (delete-region beg end)
9019 (setq end beg)
9020 (setq nmin 0)
9021 (setq nmax (1+ nmax))
9022 (setq n-no-remove nmax))
9023 (goto-char end)
9024 (cl-loop for n from nmin to nmax do
9025 (insert
9026 ;; Prepare clone.
9027 (with-temp-buffer
9028 (insert template)
9029 (org-mode)
9030 (goto-char (point-min))
9031 (org-show-subtree)
9032 (and idprop (if org-clone-delete-id
9033 (org-entry-delete nil "ID")
9034 (org-id-get-create t)))
9035 (unless (= n 0)
9036 (while (re-search-forward org-clock-line-re nil t)
9037 (delete-region (line-beginning-position)
9038 (line-beginning-position 2)))
9039 (goto-char (point-min))
9040 (while (re-search-forward org-drawer-regexp nil t)
9041 (org-remove-empty-drawer-at (point))))
9042 (goto-char (point-min))
9043 (when doshift
9044 (while (re-search-forward org-ts-regexp-both nil t)
9045 (org-timestamp-change (* n shift-n) shift-what))
9046 (unless (= n n-no-remove)
9047 (goto-char (point-min))
9048 (while (re-search-forward org-ts-regexp nil t)
9049 (save-excursion
9050 (goto-char (match-beginning 0))
9051 (when (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
9052 (delete-region (match-beginning 1) (match-end 1)))))))
9053 (buffer-string)))))
9054 (goto-char beg)))
9056 ;;; Outline Sorting
9058 (defun org-sort (with-case)
9059 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
9060 Optional argument WITH-CASE means sort case-sensitively."
9061 (interactive "P")
9062 (cond
9063 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
9064 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
9066 (org-call-with-arg 'org-sort-entries with-case))))
9068 (defun org-sort-remove-invisible (s)
9069 "Remove invisible links from string S."
9070 (remove-text-properties 0 (length s) org-rm-props s)
9071 (while (string-match org-bracket-link-regexp s)
9072 (setq s (replace-match (if (match-end 2)
9073 (match-string 3 s)
9074 (match-string 1 s))
9075 t t s)))
9076 (let ((st (format " %s " s)))
9077 (while (string-match org-emph-re st)
9078 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
9079 (setq s (substring st 1 -1)))
9082 (defvar org-priority-regexp) ; defined later in the file
9084 (defvar org-after-sorting-entries-or-items-hook nil
9085 "Hook that is run after a bunch of entries or items have been sorted.
9086 When children are sorted, the cursor is in the parent line when this
9087 hook gets called. When a region or a plain list is sorted, the cursor
9088 will be in the first entry of the sorted region/list.")
9090 (defun org-sort-entries
9091 (&optional with-case sorting-type getkey-func compare-func property)
9092 "Sort entries on a certain level of an outline tree.
9093 If there is an active region, the entries in the region are sorted.
9094 Else, if the cursor is before the first entry, sort the top-level items.
9095 Else, the children of the entry at point are sorted.
9097 Sorting can be alphabetically, numerically, by date/time as given by
9098 a time stamp, by a property, by priority order, or by a custom function.
9100 The command prompts for the sorting type unless it has been given to the
9101 function through the SORTING-TYPE argument, which needs to be a character,
9102 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
9103 the precise meaning of each character:
9105 a Alphabetically, ignoring the TODO keyword and the priority, if any.
9106 c By creation time, which is assumed to be the first inactive time stamp
9107 at the beginning of a line.
9108 d By deadline date/time.
9109 k By clocking time.
9110 n Numerically, by converting the beginning of the entry/item to a number.
9111 o By order of TODO keywords.
9112 p By priority according to the cookie.
9113 r By the value of a property.
9114 s By scheduled date/time.
9115 t By date/time, either the first active time stamp in the entry, or, if
9116 none exist, by the first inactive one.
9118 Capital letters will reverse the sort order.
9120 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
9121 called with point at the beginning of the record. It must return either
9122 a string or a number that should serve as the sorting key for that record.
9124 Comparing entries ignores case by default. However, with an optional argument
9125 WITH-CASE, the sorting considers case as well.
9127 Sorting is done against the visible part of the headlines, it ignores hidden
9128 links.
9130 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
9131 (interactive "P")
9132 (let ((case-func (if with-case 'identity 'downcase))
9133 (cmstr
9134 ;; The clock marker is lost when using `sort-subr', let's
9135 ;; store the clocking string.
9136 (when (equal (marker-buffer org-clock-marker) (current-buffer))
9137 (save-excursion
9138 (goto-char org-clock-marker)
9139 (buffer-substring-no-properties (line-beginning-position)
9140 (point)))))
9141 start beg end stars re re2
9142 txt what tmp)
9143 ;; Find beginning and end of region to sort
9144 (cond
9145 ((org-region-active-p)
9146 ;; we will sort the region
9147 (setq end (region-end)
9148 what "region")
9149 (goto-char (region-beginning))
9150 (unless (org-at-heading-p) (outline-next-heading))
9151 (setq start (point)))
9152 ((or (org-at-heading-p)
9153 (ignore-errors (progn (org-back-to-heading) t)))
9154 ;; we will sort the children of the current headline
9155 (org-back-to-heading)
9156 (setq start (point)
9157 end (progn (org-end-of-subtree t t)
9158 (or (bolp) (insert "\n"))
9159 (when (>= (org-back-over-empty-lines) 1)
9160 (forward-line 1))
9161 (point))
9162 what "children")
9163 (goto-char start)
9164 (outline-show-subtree)
9165 (outline-next-heading))
9167 ;; we will sort the top-level entries in this file
9168 (goto-char (point-min))
9169 (or (org-at-heading-p) (outline-next-heading))
9170 (setq start (point))
9171 (goto-char (point-max))
9172 (beginning-of-line 1)
9173 (when (looking-at ".*?\\S-")
9174 ;; File ends in a non-white line
9175 (end-of-line 1)
9176 (insert "\n"))
9177 (setq end (point-max))
9178 (setq what "top-level")
9179 (goto-char start)
9180 (outline-show-all)))
9182 (setq beg (point))
9183 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
9185 (looking-at "\\(\\*+\\)")
9186 (setq stars (match-string 1)
9187 re (concat "^" (regexp-quote stars) " +")
9188 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
9189 txt (buffer-substring beg end))
9190 (unless (equal (substring txt -1) "\n") (setq txt (concat txt "\n")))
9191 (when (and (not (equal stars "*")) (string-match re2 txt))
9192 (user-error "Region to sort contains a level above the first entry"))
9194 (unless sorting-type
9195 (message
9196 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
9197 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
9198 A/N/P/R/O/F/T/S/D/C/K means reversed:"
9199 what)
9200 (setq sorting-type (read-char-exclusive))
9202 (unless getkey-func
9203 (and (= (downcase sorting-type) ?f)
9204 (setq getkey-func
9205 (completing-read "Sort using function: "
9206 obarray 'fboundp t nil nil))
9207 (setq getkey-func (intern getkey-func))))
9209 (and (= (downcase sorting-type) ?r)
9210 (not property)
9211 (setq property
9212 (completing-read "Property: "
9213 (mapcar #'list (org-buffer-property-keys t))
9214 nil t))))
9216 (when (member sorting-type '(?k ?K)) (org-clock-sum))
9217 (message "Sorting entries...")
9219 (save-restriction
9220 (narrow-to-region start end)
9221 (let ((dcst (downcase sorting-type))
9222 (case-fold-search nil)
9223 (now (current-time)))
9224 (sort-subr
9225 (/= dcst sorting-type)
9226 ;; This function moves to the beginning character of the "record" to
9227 ;; be sorted.
9228 (lambda nil
9229 (if (re-search-forward re nil t)
9230 (goto-char (match-beginning 0))
9231 (goto-char (point-max))))
9232 ;; This function moves to the last character of the "record" being
9233 ;; sorted.
9234 (lambda nil
9235 (save-match-data
9236 (condition-case nil
9237 (outline-forward-same-level 1)
9238 (error
9239 (goto-char (point-max))))))
9240 ;; This function returns the value that gets sorted against.
9241 (lambda nil
9242 (cond
9243 ((= dcst ?n)
9244 (if (looking-at org-complex-heading-regexp)
9245 (string-to-number (org-sort-remove-invisible (match-string 4)))
9246 nil))
9247 ((= dcst ?a)
9248 (if (looking-at org-complex-heading-regexp)
9249 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9250 nil))
9251 ((= dcst ?k)
9252 (or (get-text-property (point) :org-clock-minutes) 0))
9253 ((= dcst ?t)
9254 (let ((end (save-excursion (outline-next-heading) (point))))
9255 (if (or (re-search-forward org-ts-regexp end t)
9256 (re-search-forward org-ts-regexp-both end t))
9257 (org-time-string-to-seconds (match-string 0))
9258 (float-time now))))
9259 ((= dcst ?c)
9260 (let ((end (save-excursion (outline-next-heading) (point))))
9261 (if (re-search-forward
9262 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9263 end t)
9264 (org-time-string-to-seconds (match-string 0))
9265 (float-time now))))
9266 ((= dcst ?s)
9267 (let ((end (save-excursion (outline-next-heading) (point))))
9268 (if (re-search-forward org-scheduled-time-regexp end t)
9269 (org-time-string-to-seconds (match-string 1))
9270 (float-time now))))
9271 ((= dcst ?d)
9272 (let ((end (save-excursion (outline-next-heading) (point))))
9273 (if (re-search-forward org-deadline-time-regexp end t)
9274 (org-time-string-to-seconds (match-string 1))
9275 (float-time now))))
9276 ((= dcst ?p)
9277 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9278 (string-to-char (match-string 2))
9279 org-default-priority))
9280 ((= dcst ?r)
9281 (or (org-entry-get nil property) ""))
9282 ((= dcst ?o)
9283 (when (looking-at org-complex-heading-regexp)
9284 (let* ((m (match-string 2))
9285 (s (if (member m org-done-keywords) '- '+)))
9286 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9287 ((= dcst ?f)
9288 (if getkey-func
9289 (progn
9290 (setq tmp (funcall getkey-func))
9291 (when (stringp tmp) (setq tmp (funcall case-func tmp)))
9292 tmp)
9293 (error "Invalid key function `%s'" getkey-func)))
9294 (t (error "Invalid sorting type `%c'" sorting-type))))
9296 (cond
9297 ((= dcst ?a) 'string<)
9298 ((= dcst ?f) compare-func)
9299 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9300 (run-hooks 'org-after-sorting-entries-or-items-hook)
9301 ;; Reset the clock marker if needed
9302 (when cmstr
9303 (save-excursion
9304 (goto-char start)
9305 (search-forward cmstr nil t)
9306 (move-marker org-clock-marker (point))))
9307 (message "Sorting entries...done")))
9309 ;;; The orgstruct minor mode
9311 ;; Define a minor mode which can be used in other modes in order to
9312 ;; integrate the Org mode structure editing commands.
9314 ;; This is really a hack, because the Org mode structure commands use
9315 ;; keys which normally belong to the major mode. Here is how it
9316 ;; works: The minor mode defines all the keys necessary to operate the
9317 ;; structure commands, but wraps the commands into a function which
9318 ;; tests if the cursor is currently at a headline or a plain list
9319 ;; item. If that is the case, the structure command is used,
9320 ;; temporarily setting many Org mode variables like regular
9321 ;; expressions for filling etc. However, when any of those keys is
9322 ;; used at a different location, function uses `key-binding' to look
9323 ;; up if the key has an associated command in another currently active
9324 ;; keymap (minor modes, major mode, global), and executes that
9325 ;; command. There might be problems if any of the keys is otherwise
9326 ;; used as a prefix key.
9328 (defcustom orgstruct-heading-prefix-regexp ""
9329 "Regexp that matches the custom prefix of Org headlines in
9330 orgstruct(++)-mode."
9331 :group 'org
9332 :version "24.4"
9333 :package-version '(Org . "8.3")
9334 :type 'regexp)
9335 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9337 (defcustom orgstruct-setup-hook nil
9338 "Hook run after orgstruct-mode-map is filled."
9339 :group 'org
9340 :version "24.4"
9341 :package-version '(Org . "8.0")
9342 :type 'hook)
9344 (defvar orgstruct-initialized nil)
9346 (defvar org-local-vars nil
9347 "List of local variables, for use by `orgstruct-mode'.")
9349 ;;;###autoload
9350 (define-minor-mode orgstruct-mode
9351 "Toggle the minor mode `orgstruct-mode'.
9352 This mode is for using Org mode structure commands in other
9353 modes. The following keys behave as if Org mode were active, if
9354 the cursor is on a headline, or on a plain list item (both as
9355 defined by Org mode)."
9356 nil " OrgStruct" (make-sparse-keymap)
9357 (funcall (if orgstruct-mode
9358 'add-to-invisibility-spec
9359 'remove-from-invisibility-spec)
9360 '(outline . t))
9361 (when orgstruct-mode
9362 (org-load-modules-maybe)
9363 (unless orgstruct-initialized
9364 (orgstruct-setup)
9365 (setq orgstruct-initialized t))))
9367 ;;;###autoload
9368 (defun turn-on-orgstruct ()
9369 "Unconditionally turn on `orgstruct-mode'."
9370 (orgstruct-mode 1))
9372 (defvar-local orgstruct-is-++ nil
9373 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9374 (defvar-local org-fb-vars nil)
9375 (defun orgstruct++-mode (&optional arg)
9376 "Toggle `orgstruct-mode', the enhanced version of it.
9377 In addition to setting orgstruct-mode, this also exports all
9378 indentation and autofilling variables from Org mode into the
9379 buffer. It will also recognize item context in multiline items."
9380 (interactive "P")
9381 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9382 (if (< arg 1)
9383 (progn (orgstruct-mode -1)
9384 (dolist (v org-fb-vars)
9385 (set (make-local-variable (car v))
9386 (if (eq (car-safe (cadr v)) 'quote)
9387 (cl-cadadr v)
9388 (nth 1 v)))))
9389 (orgstruct-mode 1)
9390 (setq org-fb-vars nil)
9391 (unless org-local-vars
9392 (setq org-local-vars (org-get-local-variables)))
9393 (let (var val)
9394 (dolist (x org-local-vars)
9395 (when (string-match
9396 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\
9397 \\|fill-prefix\\|indent-\\)"
9398 (symbol-name (car x)))
9399 (setq var (car x) val (nth 1 x))
9400 (push (list var `(quote ,(eval var))) org-fb-vars)
9401 (set (make-local-variable var)
9402 (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9403 (setq-local orgstruct-is-++ t))))
9405 ;;;###autoload
9406 (defun turn-on-orgstruct++ ()
9407 "Unconditionally turn on `orgstruct++-mode'."
9408 (orgstruct++-mode 1))
9410 (defun orgstruct-error ()
9411 "Error when there is no default binding for a structure key."
9412 (interactive)
9413 (funcall (if (fboundp 'user-error)
9414 'user-error
9415 'error)
9416 "This key has no function outside structure elements"))
9418 (defun orgstruct-setup ()
9419 "Setup orgstruct keymap."
9420 (dolist (cell '((org-demote . t)
9421 (org-metaleft . t)
9422 (org-metaright . t)
9423 (org-promote . t)
9424 (org-shiftmetaleft . t)
9425 (org-shiftmetaright . t)
9426 org-backward-element
9427 org-backward-heading-same-level
9428 org-ctrl-c-ret
9429 org-ctrl-c-minus
9430 org-ctrl-c-star
9431 org-cycle
9432 org-force-cycle-archived
9433 org-forward-heading-same-level
9434 org-insert-heading
9435 org-insert-heading-respect-content
9436 org-kill-note-or-show-branches
9437 org-mark-subtree
9438 org-meta-return
9439 org-metadown
9440 org-metaup
9441 org-narrow-to-subtree
9442 org-promote-subtree
9443 org-reveal
9444 org-shiftdown
9445 org-shiftleft
9446 org-shiftmetadown
9447 org-shiftmetaup
9448 org-shiftright
9449 org-shifttab
9450 org-shifttab
9451 org-shiftup
9452 org-show-children
9453 org-show-subtree
9454 org-sort
9455 org-up-element
9456 outline-demote
9457 outline-next-visible-heading
9458 outline-previous-visible-heading
9459 outline-promote
9460 outline-up-heading))
9461 (let ((f (or (car-safe cell) cell))
9462 (disable-when-heading-prefix (cdr-safe cell)))
9463 (when (fboundp f)
9464 (let ((new-bindings))
9465 (dolist (binding (nconc (where-is-internal f org-mode-map)
9466 (where-is-internal f outline-mode-map)))
9467 (push binding new-bindings)
9468 ;; TODO use local-function-key-map
9469 (dolist (rep '(("<tab>" . "TAB")
9470 ("<return>" . "RET")
9471 ("<escape>" . "ESC")
9472 ("<delete>" . "DEL")))
9473 (setq binding (read-kbd-macro
9474 (let ((case-fold-search))
9475 (replace-regexp-in-string
9476 (regexp-quote (cdr rep))
9477 (car rep)
9478 (key-description binding)))))
9479 (cl-pushnew binding new-bindings :test 'equal)))
9480 (dolist (binding new-bindings)
9481 (let ((key (lookup-key orgstruct-mode-map binding)))
9482 (when (or (not key) (numberp key))
9483 (ignore-errors
9484 (org-defkey orgstruct-mode-map
9485 binding
9486 (orgstruct-make-binding
9487 f binding disable-when-heading-prefix))))))))))
9488 (run-hooks 'orgstruct-setup-hook))
9490 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9491 "Create a function for binding in the structure minor mode.
9492 FUN is the command to call inside a table. KEY is the key that
9493 should be checked in for a command to execute outside of tables.
9494 Non-nil `disable-when-heading-prefix' means to disable the command
9495 if `orgstruct-heading-prefix-regexp' is not empty."
9496 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9497 (let ((nname name)
9498 (i 0))
9499 (while (fboundp (intern nname))
9500 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9501 (setq name (intern nname)))
9502 (eval
9503 (let ((bindings '((org-heading-regexp
9504 (concat "^"
9505 orgstruct-heading-prefix-regexp
9506 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9507 (org-outline-regexp
9508 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9509 (org-outline-regexp-bol
9510 (concat "^" org-outline-regexp))
9511 (outline-regexp org-outline-regexp)
9512 (outline-heading-end-regexp "\n")
9513 (outline-level 'org-outline-level)
9514 (outline-heading-alist))))
9515 `(defun ,name (arg)
9516 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9517 "Outside of structure, run the binding of `"
9518 (key-description key) "'."
9519 (when disable-when-heading-prefix
9520 (concat
9521 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9522 "back to the default binding due to limitations of Org's implementation of\n"
9523 "`" (symbol-name fun) "'.")))
9524 (interactive "p")
9525 (let* ((disable
9526 ,(and disable-when-heading-prefix
9527 '(not (string= orgstruct-heading-prefix-regexp ""))))
9528 (fallback
9529 (or disable
9530 (not
9531 (let* ,bindings
9532 (org-context-p 'headline 'item
9533 ,(when (memq fun
9534 '(org-insert-heading
9535 org-insert-heading-respect-content
9536 org-meta-return))
9537 '(when orgstruct-is-++
9538 'item-body))))))))
9539 (if fallback
9540 (let* ((orgstruct-mode)
9541 (binding
9542 (let ((key ,key))
9543 (catch 'exit
9544 (dolist
9545 (rep
9546 '(nil
9547 ("<\\([^>]*\\)tab>" . "\\1TAB")
9548 ("<\\([^>]*\\)return>" . "\\1RET")
9549 ("<\\([^>]*\\)escape>" . "\\1ESC")
9550 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9551 nil)
9552 (when rep
9553 (setq key (read-kbd-macro
9554 (let ((case-fold-search))
9555 (replace-regexp-in-string
9556 (car rep)
9557 (cdr rep)
9558 (key-description key))))))
9559 (when (key-binding key)
9560 (throw 'exit (key-binding key))))))))
9561 (if (keymapp binding)
9562 (org-set-transient-map binding)
9563 (let ((func (or binding
9564 (unless disable
9565 'orgstruct-error))))
9566 (when func
9567 (call-interactively func)))))
9568 (org-run-like-in-org-mode
9569 (lambda ()
9570 (interactive)
9571 (let* ,bindings
9572 (call-interactively ',fun)))))))))
9573 name))
9575 (defun org-contextualize-keys (alist contexts)
9576 "Return valid elements in ALIST depending on CONTEXTS.
9578 `org-agenda-custom-commands' or `org-capture-templates' are the
9579 values used for ALIST, and `org-agenda-custom-commands-contexts'
9580 or `org-capture-templates-contexts' are the associated contexts
9581 definitions."
9582 (let ((contexts
9583 ;; normalize contexts
9584 (mapcar
9585 (lambda(c) (cond ((listp (cadr c))
9586 (list (car c) (car c) (nth 1 c)))
9587 ((string= "" (cadr c))
9588 (list (car c) (car c) (nth 2 c)))
9589 (t c)))
9590 contexts))
9591 (a alist) r s)
9592 ;; loop over all commands or templates
9593 (dolist (c a)
9594 (let (vrules repl)
9595 (cond
9596 ((not (assoc (car c) contexts))
9597 (push c r))
9598 ((and (assoc (car c) contexts)
9599 (setq vrules (org-contextualize-validate-key
9600 (car c) contexts)))
9601 (mapc (lambda (vr)
9602 (unless (equal (car vr) (cadr vr))
9603 (setq repl vr)))
9604 vrules)
9605 (if (not repl) (push c r)
9606 (push (cadr repl) s)
9607 (push
9608 (cons (car c)
9609 (cdr (or (assoc (cadr repl) alist)
9610 (error "Undefined key `%s' as contextual replacement for `%s'"
9611 (cadr repl) (car c)))))
9612 r))))))
9613 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9614 (delq
9616 (delete-dups
9617 (mapcar (lambda (x)
9618 (let ((tpl (car x)))
9619 (unless (delq
9621 (mapcar (lambda (y)
9622 (equal y tpl))
9624 x)))
9625 (reverse r))))))
9627 (defun org-contextualize-validate-key (key contexts)
9628 "Check CONTEXTS for agenda or capture KEY."
9629 (let (res)
9630 (dolist (r contexts)
9631 (dolist (rr (car (last r)))
9632 (when
9633 (and (equal key (car r))
9634 (if (functionp rr) (funcall rr)
9635 (or (and (eq (car rr) 'in-file)
9636 (buffer-file-name)
9637 (string-match (cdr rr) (buffer-file-name)))
9638 (and (eq (car rr) 'in-mode)
9639 (string-match (cdr rr) (symbol-name major-mode)))
9640 (and (eq (car rr) 'in-buffer)
9641 (string-match (cdr rr) (buffer-name)))
9642 (when (and (eq (car rr) 'not-in-file)
9643 (buffer-file-name))
9644 (not (string-match (cdr rr) (buffer-file-name))))
9645 (when (eq (car rr) 'not-in-mode)
9646 (not (string-match (cdr rr) (symbol-name major-mode))))
9647 (when (eq (car rr) 'not-in-buffer)
9648 (not (string-match (cdr rr) (buffer-name)))))))
9649 (push r res))))
9650 (delete-dups (delq nil res))))
9652 (defun org-context-p (&rest contexts)
9653 "Check if local context is any of CONTEXTS.
9654 Possible values in the list of contexts are `table', `headline', and `item'."
9655 (let ((pos (point)))
9656 (goto-char (point-at-bol))
9657 (prog1 (or (and (memq 'table contexts)
9658 (looking-at "[ \t]*|"))
9659 (and (memq 'headline contexts)
9660 (looking-at org-outline-regexp))
9661 (and (memq 'item contexts)
9662 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9663 (and (memq 'item-body contexts)
9664 (org-in-item-p)))
9665 (goto-char pos))))
9667 (defconst org-unique-local-variables
9668 '(org-element--cache
9669 org-element--cache-objects
9670 org-element--cache-sync-keys
9671 org-element--cache-sync-requests
9672 org-element--cache-sync-timer)
9673 "List of local variables that cannot be transferred to another buffer.")
9675 (defun org-get-local-variables ()
9676 "Return a list of all local variables in an Org mode buffer."
9677 (delq nil
9678 (mapcar
9679 (lambda (x)
9680 (let* ((binding (if (symbolp x) (list x) (list (car x) (cdr x))))
9681 (name (car binding)))
9682 (and (not (get name 'org-state))
9683 (not (memq name org-unique-local-variables))
9684 (string-match-p
9685 "\\`\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|\
9686 auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9687 (symbol-name name))
9688 binding)))
9689 (with-temp-buffer
9690 (org-mode)
9691 (buffer-local-variables)))))
9693 (defun org-clone-local-variables (from-buffer &optional regexp)
9694 "Clone local variables from FROM-BUFFER.
9695 Optional argument REGEXP selects variables to clone."
9696 (dolist (pair (buffer-local-variables from-buffer))
9697 (let ((name (car pair)))
9698 (when (and (symbolp name)
9699 (not (memq name org-unique-local-variables))
9700 (or (null regexp) (string-match regexp (symbol-name name))))
9701 (set (make-local-variable name) (cdr pair))))))
9703 ;;;###autoload
9704 (defun org-run-like-in-org-mode (cmd)
9705 "Run a command, pretending that the current buffer is in Org mode.
9706 This will temporarily bind local variables that are typically bound in
9707 Org mode to the values they have in Org mode, and then interactively
9708 call CMD."
9709 (org-load-modules-maybe)
9710 (unless org-local-vars
9711 (setq org-local-vars (org-get-local-variables)))
9712 (let (binds)
9713 (dolist (var org-local-vars)
9714 (when (or (not (boundp (car var)))
9715 (eq (symbol-value (car var))
9716 (default-value (car var))))
9717 (push (list (car var) `(quote ,(cadr var))) binds)))
9718 (eval `(let ,binds
9719 (call-interactively (quote ,cmd))))))
9721 (defun org-get-category (&optional pos force-refresh)
9722 "Get the category applying to position POS."
9723 (save-match-data
9724 (when force-refresh (org-refresh-category-properties))
9725 (let ((pos (or pos (point))))
9726 (or (get-text-property pos 'org-category)
9727 (progn (org-refresh-category-properties)
9728 (get-text-property pos 'org-category))))))
9730 ;;; Refresh properties
9732 (defun org-refresh-properties (dprop tprop)
9733 "Refresh buffer text properties.
9734 DPROP is the drawer property and TPROP is either the
9735 corresponding text property to set, or an alist with each element
9736 being a text property (as a symbol) and a function to apply to
9737 the value of the drawer property."
9738 (let* ((case-fold-search t)
9739 (inhibit-read-only t)
9740 (inherit? (org-property-inherit-p dprop))
9741 (property-re (org-re-property (concat (regexp-quote dprop) "\\+?") t))
9742 (global (and inherit? (org--property-global-value dprop nil))))
9743 (org-with-silent-modifications
9744 (org-with-point-at 1
9745 ;; Set global values (e.g., values defined through
9746 ;; "#+PROPERTY:" keywords) to the whole buffer.
9747 (when global (put-text-property (point-min) (point-max) tprop global))
9748 ;; Set local values.
9749 (while (re-search-forward property-re nil t)
9750 (when (org-at-property-p)
9751 (org-refresh-property tprop (org-entry-get (point) dprop) inherit?))
9752 (outline-next-heading))))))
9754 (defun org-refresh-property (tprop p &optional inherit)
9755 "Refresh the buffer text property TPROP from the drawer property P.
9756 The refresh happens only for the current headline, or the whole
9757 sub-tree if optional argument INHERIT is non-nil."
9758 (unless (org-before-first-heading-p)
9759 (save-excursion
9760 (org-back-to-heading t)
9761 (let ((start (point))
9762 (end (save-excursion
9763 (if inherit (org-end-of-subtree t t)
9764 (or (outline-next-heading) (point-max))))))
9765 (if (symbolp tprop)
9766 ;; TPROP is a text property symbol.
9767 (put-text-property start end tprop p)
9768 ;; TPROP is an alist with (property . function) elements.
9769 (pcase-dolist (`(,prop . ,f) tprop)
9770 (put-text-property start end prop (funcall f p))))))))
9772 (defun org-refresh-category-properties ()
9773 "Refresh category text properties in the buffer."
9774 (let ((case-fold-search t)
9775 (inhibit-read-only t)
9776 (default-category
9777 (cond ((null org-category)
9778 (if buffer-file-name
9779 (file-name-sans-extension
9780 (file-name-nondirectory buffer-file-name))
9781 "???"))
9782 ((symbolp org-category) (symbol-name org-category))
9783 (t org-category))))
9784 (org-with-silent-modifications
9785 (org-with-wide-buffer
9786 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9787 ;; This is the default category for the buffer. If none is
9788 ;; found, fall-back to `org-category' or buffer file name.
9789 (put-text-property
9790 (point-min) (point-max)
9791 'org-category
9792 (catch 'buffer-category
9793 (goto-char (point-max))
9794 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9795 (let ((element (org-element-at-point)))
9796 (when (eq (org-element-type element) 'keyword)
9797 (throw 'buffer-category
9798 (org-element-property :value element)))))
9799 default-category))
9800 ;; Set sub-tree specific categories.
9801 (goto-char (point-min))
9802 (let ((regexp (org-re-property "CATEGORY")))
9803 (while (re-search-forward regexp nil t)
9804 (let ((value (match-string-no-properties 3)))
9805 (when (org-at-property-p)
9806 (put-text-property
9807 (save-excursion (org-back-to-heading t) (point))
9808 (save-excursion (org-end-of-subtree t t) (point))
9809 'org-category
9810 value)))))))))
9812 (defun org-refresh-stats-properties ()
9813 "Refresh stats text properties in the buffer."
9814 (let (stats)
9815 (org-with-silent-modifications
9816 (org-with-wide-buffer
9817 (goto-char (point-min))
9818 (while (re-search-forward
9819 (concat org-outline-regexp-bol ".*"
9820 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9821 nil t)
9822 (setq stats (cond ((equal (match-string 3) "0") 0)
9823 ((match-string 2)
9824 (/ (* (string-to-number (match-string 2)) 100)
9825 (string-to-number (match-string 3))))
9826 (t (string-to-number (match-string 1)))))
9827 (org-back-to-heading t)
9828 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9829 'org-stats stats))))))
9831 (defun org-refresh-effort-properties ()
9832 "Refresh effort properties"
9833 (org-refresh-properties
9834 org-effort-property
9835 '((effort . identity)
9836 (effort-minutes . org-duration-string-to-minutes))))
9838 ;;;; Link Stuff
9840 ;;; Link abbreviations
9842 (defun org-link-expand-abbrev (link)
9843 "Apply replacements as defined in `org-link-abbrev-alist'."
9844 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9845 (let* ((key (match-string 1 link))
9846 (as (or (assoc key org-link-abbrev-alist-local)
9847 (assoc key org-link-abbrev-alist)))
9848 (tag (and (match-end 2) (match-string 3 link)))
9849 rpl)
9850 (if (not as)
9851 link
9852 (setq rpl (cdr as))
9853 (cond
9854 ((symbolp rpl) (funcall rpl tag))
9855 ((string-match "%(\\([^)]+\\))" rpl)
9856 (replace-match
9857 (save-match-data
9858 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9859 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9860 ((string-match "%h" rpl)
9861 (replace-match (url-hexify-string (or tag "")) t t rpl))
9862 (t (concat rpl tag)))))
9863 link))
9865 ;;; Storing and inserting links
9867 (defvar org-insert-link-history nil
9868 "Minibuffer history for links inserted with `org-insert-link'.")
9870 (defvar org-stored-links nil
9871 "Contains the links stored with `org-store-link'.")
9873 (defvar org-store-link-plist nil
9874 "Plist with info about the most recently link created with `org-store-link'.")
9876 (defun org-store-link-functions ()
9877 "Return a list of functions that are called to create and store a link.
9878 The functions defined in the :store property of
9879 `org-link-parameters'.
9881 Each function will be called in turn until one returns a non-nil
9882 value. Each function should check if it is responsible for
9883 creating this link (for example by looking at the major mode).
9884 If not, it must exit and return nil. If yes, it should return
9885 a non-nil value after calling `org-store-link-props' with a list
9886 of properties and values. Special properties are:
9888 :type The link prefix, like \"http\". This must be given.
9889 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9890 This is obligatory as well.
9891 :description Optional default description for the second pair
9892 of brackets in an Org mode link. The user can still change
9893 this when inserting this link into an Org mode buffer.
9895 In addition to these, any additional properties can be specified
9896 and then used in capture templates."
9897 (cl-loop for link in org-link-parameters
9898 with store-func
9899 do (setq store-func (org-link-get-parameter (car link) :store))
9900 if store-func
9901 collect store-func))
9903 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9904 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9906 ;;;###autoload
9907 (defun org-store-link (arg)
9908 "Store an org-link to the current location.
9909 \\<org-mode-map>
9910 This link is added to `org-stored-links' and can later be inserted
9911 into an Org buffer with `org-insert-link' (`\\[org-insert-link]').
9913 For some link types, a `\\[universal-argument]' prefix ARG is interpreted.
9914 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9915 For file links, ARG negates `org-context-in-file-links'.
9917 A `\\[universal-argument] \\[universal-argument]' prefix ARG forces \
9918 skipping storing functions that are not
9919 part of Org core.
9921 A `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
9922 prefix ARG forces storing a link for each line in the
9923 active region."
9924 (interactive "P")
9925 (org-load-modules-maybe)
9926 (if (and (equal arg '(64)) (org-region-active-p))
9927 (save-excursion
9928 (let ((end (region-end)))
9929 (goto-char (region-beginning))
9930 (set-mark (point))
9931 (while (< (point-at-eol) end)
9932 (move-end-of-line 1) (activate-mark)
9933 (let (current-prefix-arg)
9934 (call-interactively 'org-store-link))
9935 (move-beginning-of-line 2)
9936 (set-mark (point)))))
9937 (setq org-store-link-plist nil)
9938 (let (link cpltxt desc description search
9939 txt custom-id agenda-link sfuns sfunsn)
9940 (cond
9942 ;; Store a link using an external link type
9943 ((and (not (equal arg '(16)))
9944 (setq sfuns
9945 (delq
9946 nil (mapcar (lambda (f)
9947 (let (fs) (if (funcall f) (push f fs))))
9948 (org-store-link-functions)))
9949 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9950 (or (and (cdr sfuns)
9951 (funcall (intern
9952 (completing-read
9953 "Which function for creating the link? "
9954 sfunsn nil t (car sfunsn)))))
9955 (funcall (caar sfuns)))
9956 (setq link (plist-get org-store-link-plist :link)
9957 desc (or (plist-get org-store-link-plist
9958 :description)
9959 link))))
9961 ;; Store a link from a source code buffer.
9962 ((org-src-edit-buffer-p)
9963 (let ((coderef-format (org-src-coderef-format)))
9964 (cond ((save-excursion
9965 (beginning-of-line)
9966 (looking-at (org-src-coderef-regexp coderef-format)))
9967 (setq link (format "(%s)" (match-string-no-properties 3))))
9968 ((called-interactively-p 'any)
9969 (let ((label (read-string "Code line label: ")))
9970 (end-of-line)
9971 (setq link (format coderef-format label))
9972 (let ((gc (- 79 (length link))))
9973 (if (< (current-column) gc)
9974 (org-move-to-column gc t)
9975 (insert " ")))
9976 (insert link)
9977 (setq link (concat "(" label ")"))
9978 (setq desc nil)))
9979 (t (setq link nil)))))
9981 ;; We are in the agenda, link to referenced location
9982 ((equal (bound-and-true-p org-agenda-buffer-name) (buffer-name))
9983 (let ((m (or (get-text-property (point) 'org-hd-marker)
9984 (get-text-property (point) 'org-marker))))
9985 (when m
9986 (org-with-point-at m
9987 (setq agenda-link
9988 (if (called-interactively-p 'any)
9989 (call-interactively 'org-store-link)
9990 (org-store-link nil)))))))
9992 ((eq major-mode 'calendar-mode)
9993 (let ((cd (calendar-cursor-to-date)))
9994 (setq link
9995 (format-time-string
9996 (car org-time-stamp-formats)
9997 (apply 'encode-time
9998 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9999 nil nil nil))))
10000 (org-store-link-props :type "calendar" :date cd)))
10002 ((eq major-mode 'help-mode)
10003 (setq link (concat "help:" (save-excursion
10004 (goto-char (point-min))
10005 (looking-at "^[^ ]+")
10006 (match-string 0))))
10007 (org-store-link-props :type "help"))
10009 ((eq major-mode 'w3-mode)
10010 (setq cpltxt (if (and (buffer-name)
10011 (not (string-match "Untitled" (buffer-name))))
10012 (buffer-name)
10013 (url-view-url t))
10014 link (url-view-url t))
10015 (org-store-link-props :type "w3" :url (url-view-url t)))
10017 ((eq major-mode 'image-mode)
10018 (setq cpltxt (concat "file:"
10019 (abbreviate-file-name buffer-file-name))
10020 link cpltxt)
10021 (org-store-link-props :type "image" :file buffer-file-name))
10023 ;; In dired, store a link to the file of the current line
10024 ((derived-mode-p 'dired-mode)
10025 (let ((file (dired-get-filename nil t)))
10026 (setq file (if file
10027 (abbreviate-file-name
10028 (expand-file-name (dired-get-filename nil t)))
10029 ;; otherwise, no file so use current directory.
10030 default-directory))
10031 (setq cpltxt (concat "file:" file)
10032 link cpltxt)))
10034 ((setq search (run-hook-with-args-until-success
10035 'org-create-file-search-functions))
10036 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
10037 "::" search))
10038 (setq cpltxt (or description link)))
10040 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
10041 (org-with-limited-levels
10042 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
10043 (cond
10044 ;; Store a link using the target at point
10045 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
10046 (setq cpltxt
10047 (concat "file:"
10048 (abbreviate-file-name
10049 (buffer-file-name (buffer-base-buffer)))
10050 "::" (match-string 1))
10051 link cpltxt))
10052 ((and (featurep 'org-id)
10053 (or (eq org-id-link-to-org-use-id t)
10054 (and (called-interactively-p 'any)
10055 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
10056 (and (eq org-id-link-to-org-use-id
10057 'create-if-interactive-and-no-custom-id)
10058 (not custom-id))))
10059 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
10060 ;; Store a link using the ID at point
10061 (setq link (condition-case nil
10062 (prog1 (org-id-store-link)
10063 (setq desc (or (plist-get org-store-link-plist
10064 :description)
10065 "")))
10066 (error
10067 ;; Probably before first headline, link only to file
10068 (concat "file:"
10069 (abbreviate-file-name
10070 (buffer-file-name (buffer-base-buffer))))))))
10072 ;; Just link to current headline
10073 (setq cpltxt (concat "file:"
10074 (abbreviate-file-name
10075 (buffer-file-name (buffer-base-buffer)))))
10076 ;; Add a context search string
10077 (when (org-xor org-context-in-file-links arg)
10078 (let* ((element (org-element-at-point))
10079 (name (org-element-property :name element)))
10080 (setq txt (cond
10081 ((org-at-heading-p) nil)
10082 (name)
10083 ((org-region-active-p)
10084 (buffer-substring (region-beginning) (region-end)))))
10085 (when (or (null txt) (string-match "\\S-" txt))
10086 (setq cpltxt
10087 (concat cpltxt "::"
10088 (condition-case nil
10089 (org-make-org-heading-search-string txt)
10090 (error "")))
10091 desc (or name
10092 (nth 4 (ignore-errors (org-heading-components)))
10093 "NONE")))))
10094 (when (string-match "::\\'" cpltxt)
10095 (setq cpltxt (substring cpltxt 0 -2)))
10096 (setq link cpltxt)))))
10098 ((buffer-file-name (buffer-base-buffer))
10099 ;; Just link to this file here.
10100 (setq cpltxt (concat "file:"
10101 (abbreviate-file-name
10102 (buffer-file-name (buffer-base-buffer)))))
10103 ;; Add a context string.
10104 (when (org-xor org-context-in-file-links arg)
10105 (setq txt (if (org-region-active-p)
10106 (buffer-substring (region-beginning) (region-end))
10107 (buffer-substring (point-at-bol) (point-at-eol))))
10108 ;; Only use search option if there is some text.
10109 (when (string-match "\\S-" txt)
10110 (setq cpltxt
10111 (concat cpltxt "::" (org-make-org-heading-search-string txt))
10112 desc "NONE")))
10113 (setq link cpltxt))
10115 ((called-interactively-p 'interactive)
10116 (user-error "No method for storing a link from this buffer"))
10118 (t (setq link nil)))
10120 ;; We're done setting link and desc, clean up
10121 (when (consp link) (setq cpltxt (car link) link (cdr link)))
10122 (setq link (or link cpltxt)
10123 desc (or desc cpltxt))
10124 (cond ((not desc))
10125 ((equal desc "NONE") (setq desc nil))
10126 (t (setq desc
10127 (replace-regexp-in-string
10128 org-bracket-link-analytic-regexp
10129 (lambda (m) (or (match-string 5 m) (match-string 3 m)))
10130 desc))))
10131 ;; Return the link
10132 (if (not (and (or (called-interactively-p 'any)
10133 executing-kbd-macro)
10134 link))
10135 (or agenda-link (and link (org-make-link-string link desc)))
10136 (push (list link desc) org-stored-links)
10137 (message "Stored: %s" (or desc link))
10138 (when custom-id
10139 (setq link (concat "file:" (abbreviate-file-name
10140 (buffer-file-name)) "::#" custom-id))
10141 (push (list link desc) org-stored-links))
10142 (car org-stored-links)))))
10144 (defun org-store-link-props (&rest plist)
10145 "Store link properties, extract names, addresses and dates."
10146 (let ((x (plist-get plist :from)))
10147 (when x
10148 (let ((adr (mail-extract-address-components x)))
10149 (setq plist (plist-put plist :fromname (car adr)))
10150 (setq plist (plist-put plist :fromaddress (nth 1 adr))))))
10151 (let ((x (plist-get plist :to)))
10152 (when x
10153 (let ((adr (mail-extract-address-components x)))
10154 (setq plist (plist-put plist :toname (car adr)))
10155 (setq plist (plist-put plist :toaddress (nth 1 adr))))))
10156 (let ((x (ignore-errors (date-to-time (plist-get plist :date)))))
10157 (when x
10158 (setq plist (plist-put plist :date-timestamp
10159 (format-time-string
10160 (org-time-stamp-format t) x)))
10161 (setq plist (plist-put plist :date-timestamp-inactive
10162 (format-time-string
10163 (org-time-stamp-format t t) x)))))
10164 (let ((from (plist-get plist :from))
10165 (to (plist-get plist :to)))
10166 (when (and from to org-from-is-user-regexp)
10167 (setq plist
10168 (plist-put plist :fromto
10169 (if (string-match org-from-is-user-regexp from)
10170 (concat "to %t")
10171 (concat "from %f"))))))
10172 (setq org-store-link-plist plist))
10174 (defun org-add-link-props (&rest plist)
10175 "Add these properties to the link property list."
10176 (let (key value)
10177 (while plist
10178 (setq key (pop plist) value (pop plist))
10179 (setq org-store-link-plist
10180 (plist-put org-store-link-plist key value)))))
10182 (defun org-email-link-description (&optional fmt)
10183 "Return the description part of an email link.
10184 This takes information from `org-store-link-plist' and formats it
10185 according to FMT (default from `org-email-link-description-format')."
10186 (setq fmt (or fmt org-email-link-description-format))
10187 (let* ((p org-store-link-plist)
10188 (to (plist-get p :toaddress))
10189 (from (plist-get p :fromaddress))
10190 (table
10191 (list
10192 (cons "%c" (plist-get p :fromto))
10193 (cons "%F" (plist-get p :from))
10194 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10195 (cons "%T" (plist-get p :to))
10196 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10197 (cons "%s" (plist-get p :subject))
10198 (cons "%d" (plist-get p :date))
10199 (cons "%m" (plist-get p :message-id)))))
10200 (when (string-match "%c" fmt)
10201 ;; Check if the user wrote this message
10202 (if (and org-from-is-user-regexp from to
10203 (save-match-data (string-match org-from-is-user-regexp from)))
10204 (setq fmt (replace-match "to %t" t t fmt))
10205 (setq fmt (replace-match "from %f" t t fmt))))
10206 (org-replace-escapes fmt table)))
10208 (defun org-make-org-heading-search-string (&optional string)
10209 "Make search string for the current headline or STRING."
10210 (let ((s (or string
10211 (and (derived-mode-p 'org-mode)
10212 (save-excursion
10213 (org-back-to-heading t)
10214 (org-element-property :raw-value (org-element-at-point))))))
10215 (lines org-context-in-file-links))
10216 (or string (setq s (concat "*" s))) ; Add * for headlines
10217 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10218 (when (and string (integerp lines) (> lines 0))
10219 (let ((slines (org-split-string s "\n")))
10220 (when (< lines (length slines))
10221 (setq s (mapconcat
10222 'identity
10223 (reverse (nthcdr (- (length slines) lines)
10224 (reverse slines))) "\n")))))
10225 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10227 (defun org-make-link-string (link &optional description)
10228 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10229 (unless (org-string-nw-p link) (error "Empty link"))
10230 (let ((uri (cond ((string-match org-link-types-re link)
10231 (concat (match-string 1 link)
10232 (org-link-escape (substring link (match-end 1)))))
10233 ;; For readability, url-encode internal links only
10234 ;; when absolutely needed (i.e, when they contain
10235 ;; square brackets). File links however, are
10236 ;; encoded since, e.g., spaces are significant.
10237 ((or (file-name-absolute-p link)
10238 (string-match-p "\\`\\.\\.?/\\|[][]" link))
10239 (org-link-escape link))
10240 (t link)))
10241 (description
10242 (and (org-string-nw-p description)
10243 ;; Remove brackets from description, as they are fatal.
10244 (replace-regexp-in-string
10245 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10246 (org-trim description)))))
10247 (format "[[%s]%s]"
10249 (if description (format "[%s]" description) ""))))
10251 (defconst org-link-escape-chars
10252 ;;%20 %5B %5D %25
10253 '(?\s ?\[ ?\] ?%)
10254 "List of characters that should be escaped in a link when stored to Org.
10255 This is the list that is used for internal purposes.")
10257 (defun org-link-escape (text &optional table merge)
10258 "Return percent escaped representation of TEXT.
10259 TEXT is a string with the text to escape.
10260 Optional argument TABLE is a list with characters that should be
10261 escaped. When nil, `org-link-escape-chars' is used.
10262 If optional argument MERGE is set, merge TABLE into
10263 `org-link-escape-chars'."
10264 (let ((characters-to-encode
10265 (cond ((null table) org-link-escape-chars)
10266 (merge (append org-link-escape-chars table))
10267 (t table))))
10268 (mapconcat
10269 (lambda (c)
10270 (if (or (memq c characters-to-encode)
10271 (and org-url-hexify-p (or (< c 32) (> c 126))))
10272 (mapconcat (lambda (e) (format "%%%.2X" e))
10273 (or (encode-coding-char c 'utf-8)
10274 (error "Unable to percent escape character: %c" c))
10276 (char-to-string c)))
10277 text "")))
10279 (defun org-link-unescape (str)
10280 "Unhex hexified Unicode parts in string STR.
10281 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10282 reciprocal of `org-link-escape', which see."
10283 (if (org-string-nw-p str)
10284 (replace-regexp-in-string
10285 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10286 str))
10288 (defun org-link-unescape-compound (hex)
10289 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10290 Note: this function also decodes single byte encodings like
10291 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10292 (save-match-data
10293 (let* ((bytes (cdr (split-string hex "%")))
10294 (ret "")
10295 (eat 0)
10296 (sum 0))
10297 (while bytes
10298 (let* ((val (string-to-number (pop bytes) 16))
10299 (shift-xor
10300 (if (= 0 eat)
10301 (cond
10302 ((>= val 252) (cons 6 252))
10303 ((>= val 248) (cons 5 248))
10304 ((>= val 240) (cons 4 240))
10305 ((>= val 224) (cons 3 224))
10306 ((>= val 192) (cons 2 192))
10307 (t (cons 0 0)))
10308 (cons 6 128))))
10309 (when (>= val 192) (setq eat (car shift-xor)))
10310 (setq val (logxor val (cdr shift-xor)))
10311 (setq sum (+ (lsh sum (car shift-xor)) val))
10312 (when (> eat 0) (setq eat (- eat 1)))
10313 (cond
10314 ((= 0 eat) ;multi byte
10315 (setq ret (concat ret (char-to-string sum)))
10316 (setq sum 0))
10317 ((not bytes) ; single byte(s)
10318 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10319 ret)))
10321 (defun org-link-unescape-single-byte-sequence (hex)
10322 "Unhexify hex-encoded single byte character sequences."
10323 (mapconcat (lambda (byte)
10324 (char-to-string (string-to-number byte 16)))
10325 (cdr (split-string hex "%")) ""))
10327 (defun org-xor (a b)
10328 "Exclusive or."
10329 (if a (not b) b))
10331 (defun org-fixup-message-id-for-http (s)
10332 "Replace special characters in a message id, so it can be used in an http query."
10333 (when (string-match "%" s)
10334 (setq s (mapconcat (lambda (c)
10335 (if (eq c ?%)
10336 "%25"
10337 (char-to-string c)))
10338 s "")))
10339 (while (string-match "<" s)
10340 (setq s (replace-match "%3C" t t s)))
10341 (while (string-match ">" s)
10342 (setq s (replace-match "%3E" t t s)))
10343 (while (string-match "@" s)
10344 (setq s (replace-match "%40" t t s)))
10347 (defun org-link-prettify (link)
10348 "Return a human-readable representation of LINK.
10349 The car of LINK must be a raw link.
10350 The cdr of LINK must be either a link description or nil."
10351 (let ((desc (or (cadr link) "<no description>")))
10352 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10353 "<" (car link) ">")))
10355 ;;;###autoload
10356 (defun org-insert-link-global ()
10357 "Insert a link like Org mode does.
10358 This command can be called in any mode to insert a link in Org syntax."
10359 (interactive)
10360 (org-load-modules-maybe)
10361 (org-run-like-in-org-mode 'org-insert-link))
10363 (defun org-insert-all-links (arg &optional pre post)
10364 "Insert all links in `org-stored-links'.
10365 When a universal prefix, do not delete the links from `org-stored-links'.
10366 When `ARG' is a number, insert the last N link(s).
10367 `PRE' and `POST' are optional arguments to define a string to
10368 prepend or to append."
10369 (interactive "P")
10370 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10371 (links (copy-sequence org-stored-links))
10372 (pr (or pre "- "))
10373 (po (or post "\n"))
10374 (cnt 1) l)
10375 (if (null org-stored-links)
10376 (message "No link to insert")
10377 (while (and (or (listp arg) (>= arg cnt))
10378 (setq l (if (listp arg)
10379 (pop links)
10380 (pop org-stored-links))))
10381 (setq cnt (1+ cnt))
10382 (insert pr)
10383 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10384 (insert po)))))
10386 (defun org-insert-last-stored-link (arg)
10387 "Insert the last link stored in `org-stored-links'."
10388 (interactive "p")
10389 (org-insert-all-links arg "" "\n"))
10391 (defun org-link-fontify-links-to-this-file ()
10392 "Fontify links to the current file in `org-stored-links'."
10393 (let ((f (buffer-file-name)) a b)
10394 (setq a (mapcar (lambda(l)
10395 (let ((ll (car l)))
10396 (when (and (string-match "^file:\\(.+\\)::" ll)
10397 (equal f (expand-file-name (match-string 1 ll))))
10398 ll)))
10399 org-stored-links))
10400 (when (featurep 'org-id)
10401 (setq b (mapcar (lambda(l)
10402 (let ((ll (car l)))
10403 (when (and (string-match "^id:\\(.+\\)$" ll)
10404 (equal f (expand-file-name
10405 (or (org-id-find-id-file
10406 (match-string 1 ll)) ""))))
10407 ll)))
10408 org-stored-links)))
10409 (mapcar (lambda(l)
10410 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10411 (delq nil (append a b)))))
10413 (defvar org--links-history nil)
10414 (defun org-insert-link (&optional complete-file link-location default-description)
10415 "Insert a link. At the prompt, enter the link.
10417 Completion can be used to insert any of the link protocol prefixes in use.
10419 The history can be used to select a link previously stored with
10420 `org-store-link'. When the empty string is entered (i.e. if you just
10421 press `RET' at the prompt), the link defaults to the most recently
10422 stored link. As `SPC' triggers completion in the minibuffer, you need to
10423 use `M-SPC' or `C-q SPC' to force the insertion of a space character.
10425 You will also be prompted for a description, and if one is given, it will
10426 be displayed in the buffer instead of the link.
10428 If there is already a link at point, this command will allow you to edit
10429 link and description parts.
10431 With a `\\[universal-argument]' prefix, prompts for a file to link to. The \
10432 file name can be
10433 selected using completion. The path to the file will be relative to the
10434 current directory if the file is in the current directory or a subdirectory.
10435 Otherwise, the link will be the absolute path as completed in the minibuffer
10436 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10437 option `org-link-file-path-type'.
10439 With a `\\[universal-argument] \\[universal-argument]' prefix, enforce an \
10440 absolute path even if the file is in
10441 the current directory or below.
10443 A `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
10444 prefix negates `org-keep-stored-link-after-insertion'.
10446 If `org-make-link-description-function' is non-nil, this function will be
10447 called with the link target, and the result will be the default
10448 link description.
10450 If the LINK-LOCATION parameter is non-nil, this value will be used as
10451 the link location instead of reading one interactively.
10453 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will be used
10454 as the default description."
10455 (interactive "P")
10456 (let* ((wcf (current-window-configuration))
10457 (origbuf (current-buffer))
10458 (region (when (org-region-active-p)
10459 (buffer-substring (region-beginning) (region-end))))
10460 (remove (and region (list (region-beginning) (region-end))))
10461 (desc region)
10462 (link link-location)
10463 (abbrevs org-link-abbrev-alist-local)
10464 entry all-prefixes auto-desc)
10465 (cond
10466 (link-location) ; specified by arg, just use it.
10467 ((org-in-regexp org-bracket-link-regexp 1)
10468 ;; We do have a link at point, and we are going to edit it.
10469 (setq remove (list (match-beginning 0) (match-end 0)))
10470 (setq desc (when (match-end 3) (match-string-no-properties 3)))
10471 (setq link (read-string "Link: "
10472 (org-link-unescape
10473 (match-string-no-properties 1)))))
10474 ((or (org-in-regexp org-angle-link-re)
10475 (org-in-regexp org-plain-link-re))
10476 ;; Convert to bracket link
10477 (setq remove (list (match-beginning 0) (match-end 0))
10478 link (read-string "Link: "
10479 (org-unbracket-string "<" ">" (match-string 0)))))
10480 ((member complete-file '((4) (16)))
10481 ;; Completing read for file names.
10482 (setq link (org-file-complete-link complete-file)))
10484 ;; Read link, with completion for stored links.
10485 (org-link-fontify-links-to-this-file)
10486 (org-switch-to-buffer-other-window "*Org Links*")
10487 (with-current-buffer "*Org Links*"
10488 (erase-buffer)
10489 (insert "Insert a link.
10490 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10491 (when org-stored-links
10492 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10493 (insert (mapconcat 'org-link-prettify
10494 (reverse org-stored-links) "\n")))
10495 (goto-char (point-min)))
10496 (let ((cw (selected-window)))
10497 (select-window (get-buffer-window "*Org Links*" 'visible))
10498 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10499 (unless (pos-visible-in-window-p (point-max))
10500 (org-fit-window-to-buffer))
10501 (and (window-live-p cw) (select-window cw)))
10502 (setq all-prefixes (append (mapcar 'car abbrevs)
10503 (mapcar 'car org-link-abbrev-alist)
10504 (org-link-types)))
10505 (unwind-protect
10506 ;; Fake a link history, containing the stored links.
10507 (let ((org--links-history
10508 (append (mapcar #'car org-stored-links)
10509 org-insert-link-history)))
10510 (setq link
10511 (org-completing-read
10512 "Link: "
10513 (append
10514 (mapcar (lambda (x) (concat x ":")) all-prefixes)
10515 (mapcar #'car org-stored-links))
10516 nil nil nil
10517 'org--links-history
10518 (caar org-stored-links)))
10519 (unless (org-string-nw-p link) (user-error "No link selected"))
10520 (dolist (l org-stored-links)
10521 (when (equal link (cadr l))
10522 (setq link (car l))
10523 (setq auto-desc t)))
10524 (when (or (member link all-prefixes)
10525 (and (equal ":" (substring link -1))
10526 (member (substring link 0 -1) all-prefixes)
10527 (setq link (substring link 0 -1))))
10528 (setq link (with-current-buffer origbuf
10529 (org-link-try-special-completion link)))))
10530 (set-window-configuration wcf)
10531 (kill-buffer "*Org Links*"))
10532 (setq entry (assoc link org-stored-links))
10533 (or entry (push link org-insert-link-history))
10534 (setq desc (or desc (nth 1 entry)))))
10536 (when (funcall (if (equal complete-file '(64)) 'not 'identity)
10537 (not org-keep-stored-link-after-insertion))
10538 (setq org-stored-links (delq (assoc link org-stored-links)
10539 org-stored-links)))
10541 (when (and (string-match org-plain-link-re link)
10542 (not (string-match org-ts-regexp link)))
10543 ;; URL-like link, normalize the use of angular brackets.
10544 (setq link (org-unbracket-string "<" ">" link)))
10546 ;; Check if we are linking to the current file with a search
10547 ;; option If yes, simplify the link by using only the search
10548 ;; option.
10549 (when (and buffer-file-name
10550 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10551 (let* ((path (match-string 1 link))
10552 (case-fold-search nil)
10553 (search (match-string 2 link)))
10554 (save-match-data
10555 (when (equal (file-truename buffer-file-name) (file-truename path))
10556 ;; We are linking to this same file, with a search option
10557 (setq link search)))))
10559 ;; Check if we can/should use a relative path. If yes, simplify the link
10560 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10561 (let* ((type (match-string 1 link))
10562 (path (match-string 2 link))
10563 (origpath path)
10564 (case-fold-search nil))
10565 (cond
10566 ((or (eq org-link-file-path-type 'absolute)
10567 (equal complete-file '(16)))
10568 (setq path (abbreviate-file-name (expand-file-name path))))
10569 ((eq org-link-file-path-type 'noabbrev)
10570 (setq path (expand-file-name path)))
10571 ((eq org-link-file-path-type 'relative)
10572 (setq path (file-relative-name path)))
10574 (save-match-data
10575 (if (string-match (concat "^" (regexp-quote
10576 (expand-file-name
10577 (file-name-as-directory
10578 default-directory))))
10579 (expand-file-name path))
10580 ;; We are linking a file with relative path name.
10581 (setq path (substring (expand-file-name path)
10582 (match-end 0)))
10583 (setq path (abbreviate-file-name (expand-file-name path)))))))
10584 (setq link (concat type path))
10585 (when (equal desc origpath)
10586 (setq desc path))))
10588 (if org-make-link-description-function
10589 (setq desc
10590 (or (condition-case nil
10591 (funcall org-make-link-description-function link desc)
10592 (error (progn (message "Can't get link description from `%s'"
10593 (symbol-name org-make-link-description-function))
10594 (sit-for 2) nil)))
10595 (read-string "Description: " default-description)))
10596 (if default-description (setq desc default-description)
10597 (setq desc (or (and auto-desc desc)
10598 (read-string "Description: " desc)))))
10600 (unless (string-match "\\S-" desc) (setq desc nil))
10601 (when remove (apply 'delete-region remove))
10602 (insert (org-make-link-string link desc))
10603 ;; Redisplay so as the new link has proper invisible characters.
10604 (sit-for 0)))
10606 (defun org-link-try-special-completion (type)
10607 "If there is completion support for link type TYPE, offer it."
10608 (let ((fun (org-link-get-parameter type :complete)))
10609 (if (functionp fun)
10610 (funcall fun)
10611 (read-string "Link (no completion support): " (concat type ":")))))
10613 (defun org-file-complete-link (&optional arg)
10614 "Create a file link using completion."
10615 (let ((file (read-file-name "File: "))
10616 (pwd (file-name-as-directory (expand-file-name ".")))
10617 (pwd1 (file-name-as-directory (abbreviate-file-name
10618 (expand-file-name ".")))))
10619 (cond ((equal arg '(16))
10620 (concat "file:"
10621 (abbreviate-file-name (expand-file-name file))))
10622 ((string-match
10623 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10624 (concat "file:" (match-string 1 file)))
10625 ((string-match
10626 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10627 (expand-file-name file))
10628 (concat "file:"
10629 (match-string 1 (expand-file-name file))))
10630 (t (concat "file:" file)))))
10632 (defun org-completing-read (&rest args)
10633 "Completing-read with SPACE being a normal character."
10634 (let ((enable-recursive-minibuffers t)
10635 (minibuffer-local-completion-map
10636 (copy-keymap minibuffer-local-completion-map)))
10637 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10638 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10639 (org-defkey minibuffer-local-completion-map (kbd "C-c !")
10640 'org-time-stamp-inactive)
10641 (apply #'completing-read args)))
10643 ;;; Opening/following a link
10645 (defvar org-link-search-failed nil)
10647 (defvar org-open-link-functions nil
10648 "Hook for functions finding a plain text link.
10649 These functions must take a single argument, the link content.
10650 They will be called for links that look like [[link text][description]]
10651 when LINK TEXT does not have a protocol like \"http:\" and does not look
10652 like a filename (e.g. \"./blue.png\").
10654 These functions will be called *before* Org attempts to resolve the
10655 link by doing text searches in the current buffer - so if you want a
10656 link \"[[target]]\" to still find \"<<target>>\", your function should
10657 handle this as a special case.
10659 When the function does handle the link, it must return a non-nil value.
10660 If it decides that it is not responsible for this link, it must return
10661 nil to indicate that that Org can continue with other options like
10662 exact and fuzzy text search.")
10664 (defun org-next-link (&optional search-backward)
10665 "Move forward to the next link.
10666 If the link is in hidden text, expose it."
10667 (interactive "P")
10668 (when (and org-link-search-failed (eq this-command last-command))
10669 (goto-char (point-min))
10670 (message "Link search wrapped back to beginning of buffer"))
10671 (setq org-link-search-failed nil)
10672 (let* ((pos (point))
10673 (ct (org-context))
10674 (a (assq :link ct))
10675 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10676 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10677 ((looking-at org-any-link-re)
10678 ;; Don't stay stuck at link without an org-link face
10679 (forward-char (if search-backward -1 1))))
10680 (if (funcall srch-fun org-any-link-re nil t)
10681 (progn
10682 (goto-char (match-beginning 0))
10683 (when (outline-invisible-p) (org-show-context)))
10684 (goto-char pos)
10685 (setq org-link-search-failed t)
10686 (message "No further link found"))))
10688 (defun org-previous-link ()
10689 "Move backward to the previous link.
10690 If the link is in hidden text, expose it."
10691 (interactive)
10692 (funcall 'org-next-link t))
10694 (defun org-translate-link (s)
10695 "Translate a link string if a translation function has been defined."
10696 (with-temp-buffer
10697 (insert (org-trim s))
10698 (org-trim (org-element-interpret-data (org-element-context)))))
10700 (defun org-translate-link-from-planner (type path)
10701 "Translate a link from Emacs Planner syntax so that Org can follow it.
10702 This is still an experimental function, your mileage may vary."
10703 (cond
10704 ((member type '("http" "https" "news" "ftp"))
10705 ;; standard Internet links are the same.
10706 nil)
10707 ((and (equal type "irc") (string-match "^//" path))
10708 ;; Planner has two / at the beginning of an irc link, we have 1.
10709 ;; We should have zero, actually....
10710 (setq path (substring path 1)))
10711 ((and (equal type "lisp") (string-match "^/" path))
10712 ;; Planner has a slash, we do not.
10713 (setq type "elisp" path (substring path 1)))
10714 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10715 ;; A typical message link. Planner has the id after the final slash,
10716 ;; we separate it with a hash mark
10717 (setq path (concat (match-string 1 path) "#"
10718 (org-unbracket-string "<" ">" (match-string 2 path))))))
10719 (cons type path))
10721 (defun org-find-file-at-mouse (ev)
10722 "Open file link or URL at mouse."
10723 (interactive "e")
10724 (mouse-set-point ev)
10725 (org-open-at-point 'in-emacs))
10727 (defun org-open-at-mouse (ev)
10728 "Open file link or URL at mouse.
10729 See the docstring of `org-open-file' for details."
10730 (interactive "e")
10731 (mouse-set-point ev)
10732 (when (eq major-mode 'org-agenda-mode)
10733 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10734 (org-open-at-point))
10736 (defvar org-window-config-before-follow-link nil
10737 "The window configuration before following a link.
10738 This is saved in case the need arises to restore it.")
10740 ;;;###autoload
10741 (defun org-open-at-point-global ()
10742 "Follow a link or time-stamp like Org mode does.
10743 This command can be called in any mode to follow an external link
10744 or a time-stamp that has Org mode syntax. Its behavior is
10745 undefined when called on internal links (e.g., fuzzy links).
10746 Raise an error when there is nothing to follow. "
10747 (interactive)
10748 (cond ((org-in-regexp org-any-link-re)
10749 (org-open-link-from-string (match-string-no-properties 0)))
10750 ((or (org-in-regexp org-ts-regexp-both nil t)
10751 (org-in-regexp org-tsr-regexp-both nil t))
10752 (org-follow-timestamp-link))
10753 (t (user-error "No link found"))))
10755 ;;;###autoload
10756 (defun org-open-link-from-string (s &optional arg reference-buffer)
10757 "Open a link in the string S, as if it was in Org mode."
10758 (interactive "sLink: \nP")
10759 (let ((reference-buffer (or reference-buffer (current-buffer))))
10760 (with-temp-buffer
10761 (let ((org-inhibit-startup (not reference-buffer)))
10762 (org-mode)
10763 (insert s)
10764 (goto-char (point-min))
10765 (when reference-buffer
10766 (setq org-link-abbrev-alist-local
10767 (with-current-buffer reference-buffer
10768 org-link-abbrev-alist-local)))
10769 (org-open-at-point arg reference-buffer)))))
10771 (defvar org-open-at-point-functions nil
10772 "Hook that is run when following a link at point.
10774 Functions in this hook must return t if they identify and follow
10775 a link at point. If they don't find anything interesting at point,
10776 they must return nil.")
10778 (defvar org-link-search-inhibit-query nil)
10779 (defvar clean-buffer-list-kill-buffer-names) ;Defined in midnight.el
10780 (defun org--open-doi-link (path)
10781 "Open a \"doi\" type link.
10782 PATH is a the path to search for, as a string."
10783 (browse-url (url-encode-url (concat org-doi-server-url path))))
10785 (defun org--open-elisp-link (path)
10786 "Open a \"elisp\" type link.
10787 PATH is the sexp to evaluate, as a string."
10788 (let ((cmd path))
10789 (if (or (and (org-string-nw-p
10790 org-confirm-elisp-link-not-regexp)
10791 (string-match-p org-confirm-elisp-link-not-regexp cmd))
10792 (not org-confirm-elisp-link-function)
10793 (funcall org-confirm-elisp-link-function
10794 (format "Execute \"%s\" as elisp? "
10795 (org-add-props cmd nil 'face 'org-warning))))
10796 (message "%s => %s" cmd
10797 (if (eq (string-to-char cmd) ?\()
10798 (eval (read cmd))
10799 (call-interactively (read cmd))))
10800 (user-error "Abort"))))
10802 (defun org--open-help-link (path)
10803 "Open a \"help\" type link.
10804 PATH is a symbol name, as a string."
10805 (pcase (intern path)
10806 ((and (pred fboundp) variable) (describe-function variable))
10807 ((and (pred boundp) function) (describe-variable function))
10808 (name (user-error "Unknown function or variable: %s" name))))
10810 (defun org--open-shell-link (path)
10811 "Open a \"shell\" type link.
10812 PATH is the command to execute, as a string."
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"))))
10833 (defun org-open-at-point (&optional arg reference-buffer)
10834 "Open link, timestamp, footnote or tags at point.
10836 When point is on a link, follow it. Normally, files will be
10837 opened by an appropriate application. If the optional prefix
10838 argument ARG is non-nil, Emacs will visit the file. With
10839 a double prefix argument, try to open outside of Emacs, in the
10840 application the system uses for this file type.
10842 When point is on a timestamp, open the agenda at the day
10843 specified.
10845 When point is a footnote definition, move to the first reference
10846 found. If it is on a reference, move to the associated
10847 definition.
10849 When point is on a headline, display a list of every link in the
10850 entry, so it is possible to pick one, or all, of them. If point
10851 is on a tag, call `org-tags-view' instead.
10853 When optional argument REFERENCE-BUFFER is non-nil, it should
10854 specify a buffer from where the link search should happen. This
10855 is used internally by `org-open-link-from-string'.
10857 On top of syntactically correct links, this function will open
10858 the link at point in comments or comment blocks and the first
10859 link in a property drawer line."
10860 (interactive "P")
10861 ;; On a code block, open block's results.
10862 (unless (call-interactively 'org-babel-open-src-block-result)
10863 (org-load-modules-maybe)
10864 (setq org-window-config-before-follow-link (current-window-configuration))
10865 (org-remove-occur-highlights nil nil t)
10866 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10867 (let* ((context
10868 ;; Only consider supported types, even if they are not
10869 ;; the closest one.
10870 (org-element-lineage
10871 (org-element-context)
10872 '(clock comment comment-block footnote-definition
10873 footnote-reference headline inlinetask keyword link
10874 node-property timestamp)
10876 (type (org-element-type context))
10877 (value (org-element-property :value context)))
10878 (cond
10879 ((not context) (user-error "No link found"))
10880 ;; Exception: open timestamps and links in properties
10881 ;; drawers, keywords and comments.
10882 ((memq type '(comment comment-block keyword node-property))
10883 (call-interactively #'org-open-at-point-global))
10884 ;; On a headline or an inlinetask, but not on a timestamp,
10885 ;; a link, a footnote reference or on tags.
10886 ((and (memq type '(headline inlinetask))
10887 ;; Not on tags.
10888 (let ((case-fold-search nil))
10889 (save-excursion
10890 (beginning-of-line)
10891 (looking-at org-complex-heading-regexp))
10892 (or (not (match-beginning 5))
10893 (< (point) (match-beginning 5)))))
10894 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10895 (links (car data))
10896 (links-end (cdr data)))
10897 (if links
10898 (dolist (link (if (stringp links) (list links) links))
10899 (search-forward link nil links-end)
10900 (goto-char (match-beginning 0))
10901 (org-open-at-point))
10902 (require 'org-attach)
10903 (org-attach-reveal 'if-exists))))
10904 ;; On a clock line, make sure point is on the timestamp
10905 ;; before opening it.
10906 ((and (eq type 'clock)
10907 value
10908 (>= (point) (org-element-property :begin value))
10909 (<= (point) (org-element-property :end value)))
10910 (org-follow-timestamp-link))
10911 ;; Do nothing on white spaces after an object.
10912 ((>= (point)
10913 (save-excursion
10914 (goto-char (org-element-property :end context))
10915 (skip-chars-backward " \t")
10916 (point)))
10917 (user-error "No link found"))
10918 ((eq type 'timestamp) (org-follow-timestamp-link))
10919 ;; On tags within a headline or an inlinetask.
10920 ((and (memq type '(headline inlinetask))
10921 (let ((case-fold-search nil))
10922 (save-excursion (beginning-of-line)
10923 (looking-at org-complex-heading-regexp))
10924 (and (match-beginning 5)
10925 (>= (point) (match-beginning 5)))))
10926 (org-tags-view arg (substring (match-string 5) 0 -1)))
10927 ((eq type 'link)
10928 ;; When link is located within the description of another
10929 ;; link (e.g., an inline image), always open the parent
10930 ;; link.
10931 (let* ((link (let ((up (org-element-property :parent context)))
10932 (if (eq (org-element-type up) 'link) up context)))
10933 (type (org-element-property :type link))
10934 (path (org-link-unescape (org-element-property :path link))))
10935 ;; Switch back to REFERENCE-BUFFER needed when called in
10936 ;; a temporary buffer through `org-open-link-from-string'.
10937 (with-current-buffer (or reference-buffer (current-buffer))
10938 (cond
10939 ((equal type "file")
10940 (if (string-match "[*?{]" (file-name-nondirectory path))
10941 (dired path)
10942 ;; Look into `org-link-parameters' in order to find
10943 ;; a DEDICATED-FUNCTION to open file. The function
10944 ;; will be applied on raw link instead of parsed
10945 ;; link due to the limitation in `org-add-link-type'
10946 ;; ("open" function called with a single argument).
10947 ;; If no such function is found, fallback to
10948 ;; `org-open-file'.
10949 (let* ((option (org-element-property :search-option link))
10950 (app (org-element-property :application link))
10951 (dedicated-function
10952 (org-link-get-parameter
10953 (if app (concat type "+" app) type)
10954 :follow)))
10955 (if dedicated-function
10956 (funcall dedicated-function
10957 (concat path
10958 (and option (concat "::" option))))
10959 (apply #'org-open-file
10960 path
10961 (cond (arg)
10962 ((equal app "emacs") 'emacs)
10963 ((equal app "sys") 'system))
10964 (cond ((not option) nil)
10965 ((string-match-p "\\`[0-9]+\\'" option)
10966 (list (string-to-number option)))
10967 (t (list nil
10968 (org-link-unescape option)))))))))
10969 ((functionp (org-link-get-parameter type :follow))
10970 (funcall (org-link-get-parameter type :follow) path))
10971 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10972 (unless (run-hook-with-args-until-success
10973 'org-open-link-functions path)
10974 (if (not arg) (org-mark-ring-push)
10975 (switch-to-buffer-other-window
10976 (org-get-buffer-for-internal-link (current-buffer))))
10977 (let ((destination
10978 (org-with-wide-buffer
10979 (if (equal type "radio")
10980 (org-search-radio-target
10981 (org-element-property :path link))
10982 (org-link-search
10983 (if (member type '("custom-id" "coderef"))
10984 (org-element-property :raw-link link)
10985 path)
10986 ;; Prevent fuzzy links from matching
10987 ;; themselves.
10988 (and (equal type "fuzzy")
10989 (+ 2 (org-element-property :begin link)))))
10990 (point))))
10991 (unless (and (<= (point-min) destination)
10992 (>= (point-max) destination))
10993 (widen))
10994 (goto-char destination))))
10995 (t (browse-url-at-point))))))
10996 ;; On a footnote reference or at a footnote definition's label.
10997 ((or (eq type 'footnote-reference)
10998 (and (eq type 'footnote-definition)
10999 (save-excursion
11000 ;; Do not validate action when point is on the
11001 ;; spaces right after the footnote label, in
11002 ;; order to be on par with behaviour on links.
11003 (skip-chars-forward " \t")
11004 (let ((begin
11005 (org-element-property :contents-begin context)))
11006 (if begin (< (point) begin)
11007 (= (org-element-property :post-affiliated context)
11008 (line-beginning-position)))))))
11009 (org-footnote-action))
11010 (t (user-error "No link found")))))
11011 (run-hook-with-args 'org-follow-link-hook)))
11013 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
11014 "Offer links in the current entry and return the selected link.
11015 If there is only one link, return it.
11016 If NTH is an integer, return the NTH link found.
11017 If ZERO is a string, check also this string for a link, and if
11018 there is one, return it."
11019 (with-current-buffer buffer
11020 (org-with-wide-buffer
11021 (goto-char marker)
11022 (let ((cnt ?0)
11023 have-zero end links link c)
11024 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
11025 (push (match-string 0 zero) links)
11026 (setq cnt (1- cnt) have-zero t))
11027 (save-excursion
11028 (org-back-to-heading t)
11029 (setq end (save-excursion (outline-next-heading) (point)))
11030 (while (re-search-forward org-any-link-re end t)
11031 (push (match-string 0) links))
11032 (setq links (org-uniquify (reverse links))))
11033 (cond
11034 ((null links)
11035 (message "No links"))
11036 ((equal (length links) 1)
11037 (setq link (car links)))
11038 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
11039 (setq link (nth (if have-zero nth (1- nth)) links)))
11040 (t ; we have to select a link
11041 (save-excursion
11042 (save-window-excursion
11043 (delete-other-windows)
11044 (with-output-to-temp-buffer "*Select Link*"
11045 (dolist (l links)
11046 (cond
11047 ((not (string-match org-bracket-link-regexp l))
11048 (princ (format "[%c] %s\n" (cl-incf cnt)
11049 (org-unbracket-string "<" ">" l))))
11050 ((match-end 3)
11051 (princ (format "[%c] %s (%s)\n" (cl-incf cnt)
11052 (match-string 3 l) (match-string 1 l))))
11053 (t (princ (format "[%c] %s\n" (cl-incf cnt)
11054 (match-string 1 l)))))))
11055 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
11056 (message "Select link to open, RET to open all:")
11057 (setq c (read-char-exclusive))
11058 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
11059 (when (equal c ?q) (user-error "Abort"))
11060 (if (equal c ?\C-m)
11061 (setq link links)
11062 (setq nth (- c ?0))
11063 (when have-zero (setq nth (1+ nth)))
11064 (unless (and (integerp nth) (>= (length links) nth))
11065 (user-error "Invalid link selection"))
11066 (setq link (nth (1- nth) links)))))
11067 (cons link end)))))
11069 ;; TODO: These functions are deprecated since `org-open-at-point'
11070 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
11071 (defun org-open-file-with-system (path)
11072 "Open file at PATH using the system way of opening it."
11073 (org-open-file path 'system))
11074 (defun org-open-file-with-emacs (path)
11075 "Open file at PATH in Emacs."
11076 (org-open-file path 'emacs))
11079 ;;; File search
11081 (defvar org-create-file-search-functions nil
11082 "List of functions to construct the right search string for a file link.
11083 These functions are called in turn with point at the location to
11084 which the link should point.
11086 A function in the hook should first test if it would like to
11087 handle this file type, for example by checking the `major-mode'
11088 or the file extension. If it decides not to handle this file, it
11089 should just return nil to give other functions a chance. If it
11090 does handle the file, it must return the search string to be used
11091 when following the link. The search string will be part of the
11092 file link, given after a double colon, and `org-open-at-point'
11093 will automatically search for it. If special measures must be
11094 taken to make the search successful, another function should be
11095 added to the companion hook `org-execute-file-search-functions',
11096 which see.
11098 A function in this hook may also use `setq' to set the variable
11099 `description' to provide a suggestion for the descriptive text to
11100 be used for this link when it gets inserted into an Org buffer
11101 with \\[org-insert-link].")
11103 (defvar org-execute-file-search-functions nil
11104 "List of functions to execute a file search triggered by a link.
11106 Functions added to this hook must accept a single argument, the
11107 search string that was part of the file link, the part after the
11108 double colon. The function must first check if it would like to
11109 handle this search, for example by checking the `major-mode' or
11110 the file extension. If it decides not to handle this search, it
11111 should just return nil to give other functions a chance. If it
11112 does handle the search, it must return a non-nil value to keep
11113 other functions from trying.
11115 Each function can access the current prefix argument through the
11116 variable `current-prefix-arg'. Note that a single prefix is used
11117 to force opening a link in Emacs, so it may be good to only use a
11118 numeric or double prefix to guide the search function.
11120 In case this is needed, a function in this hook can also restore
11121 the window configuration before `org-open-at-point' was called using:
11123 (set-window-configuration org-window-config-before-follow-link)")
11125 (defun org-search-radio-target (target)
11126 "Search a radio target matching TARGET in current buffer.
11127 White spaces are not significant."
11128 (let ((re (format "<<<%s>>>"
11129 (mapconcat #'regexp-quote
11130 (org-split-string target "[ \t\n]+")
11131 "[ \t]+\\(?:\n[ \t]*\\)?")))
11132 (origin (point)))
11133 (goto-char (point-min))
11134 (catch :radio-match
11135 (while (re-search-forward re nil t)
11136 (backward-char)
11137 (let ((object (org-element-context)))
11138 (when (eq (org-element-type object) 'radio-target)
11139 (goto-char (org-element-property :begin object))
11140 (org-show-context 'link-search)
11141 (throw :radio-match nil))))
11142 (goto-char origin)
11143 (user-error "No match for radio target: %s" target))))
11145 (defun org-link-search (s &optional avoid-pos stealth)
11146 "Search for a search string S.
11148 If S starts with \"#\", it triggers a custom ID search.
11150 If S is enclosed within parenthesis, it initiates a coderef
11151 search.
11153 If S is surrounded by forward slashes, it is interpreted as
11154 a regular expression. In Org mode files, this will create an
11155 `org-occur' sparse tree. In ordinary files, `occur' will be used
11156 to list matches. If the current buffer is in `dired-mode', grep
11157 will be used to search in all files.
11159 When AVOID-POS is given, ignore matches near that position.
11161 When optional argument STEALTH is non-nil, do not modify
11162 visibility around point, thus ignoring `org-show-context-detail'
11163 variable.
11165 Search is case-insensitive and ignores white spaces. Return type
11166 of matched result, which is either `dedicated' or `fuzzy'."
11167 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11168 (let* ((case-fold-search t)
11169 (origin (point))
11170 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11171 (starred (eq (string-to-char normalized) ?*))
11172 (words (split-string (if starred (substring s 1) s)))
11173 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11174 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11175 type)
11176 (cond
11177 ;; Check if there are any special search functions.
11178 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11179 ((eq (string-to-char s) ?#)
11180 ;; Look for a custom ID S if S starts with "#".
11181 (let* ((id (substring normalized 1))
11182 (match (org-find-property "CUSTOM_ID" id)))
11183 (if match (progn (goto-char match) (setf type 'dedicated))
11184 (error "No match for custom ID: %s" id))))
11185 ((string-match "\\`(\\(.*\\))\\'" normalized)
11186 ;; Look for coderef targets if S is enclosed within parenthesis.
11187 (let ((coderef (match-string-no-properties 1 normalized))
11188 (re (substring s-single-re 1 -1)))
11189 (goto-char (point-min))
11190 (catch :coderef-match
11191 (while (re-search-forward re nil t)
11192 (let ((element (org-element-at-point)))
11193 (when (and (memq (org-element-type element)
11194 '(example-block src-block))
11195 ;; Build proper regexp according to current
11196 ;; block's label format.
11197 (let ((label-fmt
11198 (regexp-quote
11199 (or (org-element-property :label-fmt element)
11200 org-coderef-label-format))))
11201 (save-excursion
11202 (beginning-of-line)
11203 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11204 (format label-fmt coderef))))))
11205 (setq type 'dedicated)
11206 (goto-char (match-beginning 1))
11207 (throw :coderef-match nil))))
11208 (goto-char origin)
11209 (error "No match for coderef: %s" coderef))))
11210 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11211 ;; Look for a regular expression.
11212 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11213 (match-string 1 s)))
11214 ;; From here, we handle fuzzy links.
11216 ;; Look for targets, only if not in a headline search.
11217 ((and (not starred)
11218 (let ((target (format "<<%s>>" s-multi-re)))
11219 (catch :target-match
11220 (goto-char (point-min))
11221 (while (re-search-forward target nil t)
11222 (backward-char)
11223 (let ((context (org-element-context)))
11224 (when (eq (org-element-type context) 'target)
11225 (setq type 'dedicated)
11226 (goto-char (org-element-property :begin context))
11227 (throw :target-match t))))
11228 nil))))
11229 ;; Look for elements named after S, only if not in a headline
11230 ;; search.
11231 ((and (not starred)
11232 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11233 (catch :name-match
11234 (goto-char (point-min))
11235 (while (re-search-forward name nil t)
11236 (let ((element (org-element-at-point)))
11237 (when (equal words
11238 (split-string
11239 (org-element-property :name element)))
11240 (setq type 'dedicated)
11241 (beginning-of-line)
11242 (throw :name-match t))))
11243 nil))))
11244 ;; Regular text search. Prefer headlines in Org mode buffers.
11245 ;; Ignore COMMENT keyword, TODO keywords, priority cookies,
11246 ;; statistics cookies and tags.
11247 ((and (derived-mode-p 'org-mode)
11248 (let ((title-re
11249 (format "%s.*\\(?:%s[ \t]\\)?.*%s"
11250 org-outline-regexp-bol
11251 org-comment-string
11252 (mapconcat #'regexp-quote words ".+")))
11253 (cookie-re "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]")
11254 (comment-re (format "\\`%s[ \t]+" org-comment-string)))
11255 (goto-char (point-min))
11256 (catch :found
11257 (while (re-search-forward title-re nil t)
11258 (when (equal words
11259 (split-string
11260 (replace-regexp-in-string
11261 cookie-re ""
11262 (replace-regexp-in-string
11263 comment-re "" (org-get-heading t t)))))
11264 (throw :found t)))
11265 nil)))
11266 (beginning-of-line)
11267 (setq type 'dedicated))
11268 ;; Offer to create non-existent headline depending on
11269 ;; `org-link-search-must-match-exact-headline'.
11270 ((and (derived-mode-p 'org-mode)
11271 (not org-link-search-inhibit-query)
11272 (eq org-link-search-must-match-exact-headline 'query-to-create)
11273 (yes-or-no-p "No match - create this as a new heading? "))
11274 (goto-char (point-max))
11275 (unless (bolp) (newline))
11276 (org-insert-heading nil t t)
11277 (insert s "\n")
11278 (beginning-of-line 0))
11279 ;; Only headlines are looked after. No need to process
11280 ;; further: throw an error.
11281 ((and (derived-mode-p 'org-mode)
11282 (or starred org-link-search-must-match-exact-headline))
11283 (goto-char origin)
11284 (error "No match for fuzzy expression: %s" normalized))
11285 ;; Regular text search.
11286 ((catch :fuzzy-match
11287 (goto-char (point-min))
11288 (while (re-search-forward s-multi-re nil t)
11289 ;; Skip match if it contains AVOID-POS or it is included in
11290 ;; a link with a description but outside the description.
11291 (unless (or (and avoid-pos
11292 (<= (match-beginning 0) avoid-pos)
11293 (> (match-end 0) avoid-pos))
11294 (and (save-match-data
11295 (org-in-regexp org-bracket-link-regexp))
11296 (match-beginning 3)
11297 (or (> (match-beginning 3) (point))
11298 (<= (match-end 3) (point)))
11299 (org-element-lineage
11300 (save-match-data (org-element-context))
11301 '(link) t)))
11302 (goto-char (match-beginning 0))
11303 (setq type 'fuzzy)
11304 (throw :fuzzy-match t)))
11305 nil))
11306 ;; All failed. Throw an error.
11307 (t (goto-char origin)
11308 (error "No match for fuzzy expression: %s" normalized)))
11309 ;; Disclose surroundings of match, if appropriate.
11310 (when (and (derived-mode-p 'org-mode) (not stealth))
11311 (org-show-context 'link-search))
11312 type))
11314 (defun org-get-buffer-for-internal-link (buffer)
11315 "Return a buffer to be used for displaying the link target of internal links."
11316 (cond
11317 ((not org-display-internal-link-with-indirect-buffer)
11318 buffer)
11319 ((string-suffix-p "(Clone)" (buffer-name buffer))
11320 (message "Buffer is already a clone, not making another one")
11321 ;; we also do not modify visibility in this case
11322 buffer)
11323 (t ; make a new indirect buffer for displaying the link
11324 (let* ((bn (buffer-name buffer))
11325 (ibn (concat bn "(Clone)"))
11326 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11327 (with-current-buffer ib (org-overview))
11328 ib))))
11330 (defun org-do-occur (regexp &optional cleanup)
11331 "Call the Emacs command `occur'.
11332 If CLEANUP is non-nil, remove the printout of the regular expression
11333 in the *Occur* buffer. This is useful if the regex is long and not useful
11334 to read."
11335 (occur regexp)
11336 (when cleanup
11337 (let ((cwin (selected-window)) win beg end)
11338 (when (setq win (get-buffer-window "*Occur*"))
11339 (select-window win))
11340 (goto-char (point-min))
11341 (when (re-search-forward "match[a-z]+" nil t)
11342 (setq beg (match-end 0))
11343 (when (re-search-forward "^[ \t]*[0-9]+" nil t)
11344 (setq end (1- (match-beginning 0)))))
11345 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11346 (goto-char (point-min))
11347 (select-window cwin))))
11349 ;;; The mark ring for links jumps
11351 (defvar org-mark-ring nil
11352 "Mark ring for positions before jumps in Org mode.")
11353 (defvar org-mark-ring-last-goto nil
11354 "Last position in the mark ring used to go back.")
11355 ;; Fill and close the ring
11356 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11357 (dotimes (_ org-mark-ring-length)
11358 (push (make-marker) org-mark-ring))
11359 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11360 org-mark-ring)
11362 (defun org-mark-ring-push (&optional pos buffer)
11363 "Put the current position or POS into the mark ring and rotate it."
11364 (interactive)
11365 (setq pos (or pos (point)))
11366 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11367 (move-marker (car org-mark-ring)
11368 (or pos (point))
11369 (or buffer (current-buffer)))
11370 (message "%s"
11371 (substitute-command-keys
11372 "Position saved to mark ring, go back with \
11373 `\\[org-mark-ring-goto]'.")))
11375 (defun org-mark-ring-goto (&optional n)
11376 "Jump to the previous position in the mark ring.
11377 With prefix arg N, jump back that many stored positions. When
11378 called several times in succession, walk through the entire ring.
11379 Org mode commands jumping to a different position in the current file,
11380 or to another Org file, automatically push the old position onto the ring."
11381 (interactive "p")
11382 (let (p m)
11383 (if (eq last-command this-command)
11384 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11385 (setq p org-mark-ring))
11386 (setq org-mark-ring-last-goto p)
11387 (setq m (car p))
11388 (pop-to-buffer-same-window (marker-buffer m))
11389 (goto-char m)
11390 (when (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11392 (defun org-add-angle-brackets (s)
11393 (unless (equal (substring s 0 1) "<") (setq s (concat "<" s)))
11394 (unless (equal (substring s -1) ">") (setq s (concat s ">")))
11397 ;;; Following specific links
11399 (defvar org-agenda-buffer-tmp-name)
11400 (defvar org-agenda-start-on-weekday)
11401 (defun org-follow-timestamp-link ()
11402 "Open an agenda view for the time-stamp date/range at point."
11403 (cond
11404 ((org-at-date-range-p t)
11405 (let ((org-agenda-start-on-weekday)
11406 (t1 (match-string 1))
11407 (t2 (match-string 2)) tt1 tt2)
11408 (setq tt1 (time-to-days (org-time-string-to-time t1))
11409 tt2 (time-to-days (org-time-string-to-time t2)))
11410 (let ((org-agenda-buffer-tmp-name
11411 (format "*Org Agenda(a:%s)"
11412 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11413 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11414 ((org-at-timestamp-p t)
11415 (let ((org-agenda-buffer-tmp-name
11416 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11417 (org-agenda-list nil (time-to-days (org-time-string-to-time
11418 (substring (match-string 1) 0 10)))
11419 1)))
11420 (t (error "This should not happen"))))
11423 ;;; Following file links
11424 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11425 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11426 (declare-function mailcap-mime-info
11427 "mailcap" (string &optional request no-decode))
11428 (defvar org-wait nil)
11429 (defun org-open-file (path &optional in-emacs line search)
11430 "Open the file at PATH.
11431 First, this expands any special file name abbreviations. Then the
11432 configuration variable `org-file-apps' is checked if it contains an
11433 entry for this file type, and if yes, the corresponding command is launched.
11435 If no application is found, Emacs simply visits the file.
11437 With optional prefix argument IN-EMACS, Emacs will visit the file.
11438 With a double \\[universal-argument] \\[universal-argument] \
11439 prefix arg, Org tries to avoid opening in Emacs
11440 and to use an external application to visit the file.
11442 Optional LINE specifies a line to go to, optional SEARCH a string
11443 to search for. If LINE or SEARCH is given, the file will be
11444 opened in Emacs, unless an entry from org-file-apps that makes
11445 use of groups in a regexp matches.
11447 If you want to change the way frames are used when following a
11448 link, please customize `org-link-frame-setup'.
11450 If the file does not exist, an error is thrown."
11451 (let* ((file (if (equal path "")
11452 buffer-file-name
11453 (substitute-in-file-name (expand-file-name path))))
11454 (file-apps (append org-file-apps (org-default-apps)))
11455 (apps (cl-remove-if
11456 'org-file-apps-entry-match-against-dlink-p file-apps))
11457 (apps-dlink (cl-remove-if-not
11458 'org-file-apps-entry-match-against-dlink-p file-apps))
11459 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11460 (dirp (unless remp (file-directory-p file)))
11461 (file (if (and dirp org-open-directory-means-index-dot-org)
11462 (concat (file-name-as-directory file) "index.org")
11463 file))
11464 (a-m-a-p (assq 'auto-mode apps))
11465 (dfile (downcase file))
11466 ;; Reconstruct the original link from the PATH, LINE and
11467 ;; SEARCH args.
11468 (link (cond (line (concat file "::" (number-to-string line)))
11469 (search (concat file "::" search))
11470 (t file)))
11471 (dlink (downcase link))
11472 (old-buffer (current-buffer))
11473 (old-pos (point))
11474 (old-mode major-mode)
11475 (ext
11476 (and (string-match "\\`.*?\\.\\([a-zA-Z0-9]+\\(\\.gz\\)?\\)\\'" dfile)
11477 (match-string 1 dfile)))
11478 cmd link-match-data)
11479 (cond
11480 ((member in-emacs '((16) system))
11481 (setq cmd (cdr (assq 'system apps))))
11482 (in-emacs (setq cmd 'emacs))
11484 (setq cmd (or (and remp (cdr (assq 'remote apps)))
11485 (and dirp (cdr (assq 'directory apps)))
11486 ;; First, try matching against apps-dlink if we
11487 ;; get a match here, store the match data for
11488 ;; later.
11489 (let ((match (assoc-default dlink apps-dlink
11490 'string-match)))
11491 (if match
11492 (progn (setq link-match-data (match-data))
11493 match)
11494 (progn (setq in-emacs (or in-emacs line search))
11495 nil))) ; if we have no match in apps-dlink,
11496 ; always open the file in emacs if line or search
11497 ; is given (for backwards compatibility)
11498 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11499 'string-match)
11500 (cdr (assoc ext apps))
11501 (cdr (assq t apps))))))
11502 (when (eq cmd 'system)
11503 (setq cmd (cdr (assq 'system apps))))
11504 (when (eq cmd 'default)
11505 (setq cmd (cdr (assoc t apps))))
11506 (when (eq cmd 'mailcap)
11507 (require 'mailcap)
11508 (mailcap-parse-mailcaps)
11509 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11510 (command (mailcap-mime-info mime-type)))
11511 (if (stringp command)
11512 (setq cmd command)
11513 (setq cmd 'emacs))))
11514 (when (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11515 (not (file-exists-p file))
11516 (not org-open-non-existing-files))
11517 (user-error "No such file: %s" file))
11518 (cond
11519 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11520 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11521 (while (string-match "['\"]%s['\"]" cmd)
11522 (setq cmd (replace-match "%s" t t cmd)))
11523 (setq cmd (replace-regexp-in-string
11524 "%s"
11525 (shell-quote-argument (convert-standard-filename file))
11527 nil t))
11529 ;; Replace "%1", "%2" etc. in command with group matches from regex
11530 (save-match-data
11531 (let ((match-index 1)
11532 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11533 (set-match-data link-match-data)
11534 (while (<= match-index number-of-groups)
11535 (let ((regex (concat "%" (number-to-string match-index)))
11536 (replace-with (match-string match-index dlink)))
11537 (while (string-match regex cmd)
11538 (setq cmd (replace-match replace-with t t cmd))))
11539 (setq match-index (+ match-index 1)))))
11541 (save-window-excursion
11542 (message "Running %s...done" cmd)
11543 (start-process-shell-command cmd nil cmd)
11544 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11545 ((or (stringp cmd)
11546 (eq cmd 'emacs))
11547 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11548 (widen)
11549 (cond (line (org-goto-line line)
11550 (when (derived-mode-p 'org-mode) (org-reveal)))
11551 (search (org-link-search search))))
11552 ((functionp cmd)
11553 (save-match-data
11554 (set-match-data link-match-data)
11555 (condition-case nil
11556 (funcall cmd file link)
11557 ;; FIXME: Remove this check when most default installations
11558 ;; of Emacs have at least Org 9.0.
11559 ((debug wrong-number-of-arguments wrong-type-argument
11560 invalid-function)
11561 (user-error "Please see Org News for version 9.0 about \
11562 `org-file-apps'--Lisp error: %S" cmd)))))
11563 ((consp cmd)
11564 ;; FIXME: Remove this check when most default installations of
11565 ;; Emacs have at least Org 9.0.
11566 ;; Heads-up instead of silently fall back to
11567 ;; `org-link-frame-setup' for an old usage of `org-file-apps'
11568 ;; with sexp instead of a function for `cmd'.
11569 (user-error "Please see Org News for version 9.0 about \
11570 `org-file-apps'--Error: Deprecated usage of %S" cmd))
11571 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11572 (and (derived-mode-p 'org-mode)
11573 (eq old-mode 'org-mode)
11574 (or (not (eq old-buffer (current-buffer)))
11575 (not (eq old-pos (point))))
11576 (org-mark-ring-push old-pos old-buffer))))
11578 (defun org-file-apps-entry-match-against-dlink-p (entry)
11579 "This function returns non-nil if `entry' uses a regular
11580 expression which should be matched against the whole link by
11581 org-open-file.
11583 It assumes that is the case when the entry uses a regular
11584 expression which has at least one grouping construct and the
11585 action is either a lisp form or a command string containing
11586 `%1', i.e. using at least one subexpression match as a
11587 parameter."
11588 (let ((selector (car entry))
11589 (action (cdr entry)))
11590 (if (stringp selector)
11591 (and (> (regexp-opt-depth selector) 0)
11592 (or (and (stringp action)
11593 (string-match "%[0-9]" action))
11594 (consp action)))
11595 nil)))
11597 (defun org-default-apps ()
11598 "Return the default applications for this operating system."
11599 (cond
11600 ((eq system-type 'darwin)
11601 org-file-apps-defaults-macosx)
11602 ((eq system-type 'windows-nt)
11603 org-file-apps-defaults-windowsnt)
11604 (t org-file-apps-defaults-gnu)))
11606 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11607 "Convert extensions to regular expressions in the cars of LIST.
11608 Also, weed out any non-string entries, because the return value is used
11609 only for regexp matching.
11610 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11611 point to the symbol `emacs', indicating that the file should
11612 be opened in Emacs."
11613 (append
11614 (delq nil
11615 (mapcar (lambda (x)
11616 (unless (not (stringp (car x)))
11617 (if (string-match "\\W" (car x))
11619 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11620 list))
11621 (when add-auto-mode
11622 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11624 (defvar ange-ftp-name-format)
11625 (defun org-file-remote-p (file)
11626 "Test whether FILE specifies a location on a remote system.
11627 Return non-nil if the location is indeed remote.
11629 For example, the filename \"/user@host:/foo\" specifies a location
11630 on the system \"/user@host:\"."
11631 (cond ((fboundp 'file-remote-p)
11632 (file-remote-p file))
11633 ((fboundp 'tramp-handle-file-remote-p)
11634 (tramp-handle-file-remote-p file))
11635 ((and (boundp 'ange-ftp-name-format)
11636 (string-match (car ange-ftp-name-format) file))
11637 t)))
11640 ;;;; Refiling
11642 (defun org-get-org-file ()
11643 "Read a filename, with default directory `org-directory'."
11644 (let ((default (or org-default-notes-file remember-data-file)))
11645 (read-file-name (format "File name [%s]: " default)
11646 (file-name-as-directory org-directory)
11647 default)))
11649 (defun org-notes-order-reversed-p ()
11650 "Check if the current file should receive notes in reversed order."
11651 (cond
11652 ((not org-reverse-note-order) nil)
11653 ((eq t org-reverse-note-order) t)
11654 ((not (listp org-reverse-note-order)) nil)
11655 (t (catch 'exit
11656 (dolist (entry org-reverse-note-order)
11657 (when (string-match (car entry) buffer-file-name)
11658 (throw 'exit (cdr entry))))))))
11660 (defvar org-refile-target-table nil
11661 "The list of refile targets, created by `org-refile'.")
11663 (defvar org-agenda-new-buffers nil
11664 "Buffers created to visit agenda files.")
11666 (defvar org-refile-cache nil
11667 "Cache for refile targets.")
11669 (defvar org-refile-markers nil
11670 "All the markers used for caching refile locations.")
11672 (defun org-refile-marker (pos)
11673 "Get a new refile marker, but only if caching is in use."
11674 (if (not org-refile-use-cache)
11676 (let ((m (make-marker)))
11677 (move-marker m pos)
11678 (push m org-refile-markers)
11679 m)))
11681 (defun org-refile-cache-clear ()
11682 "Clear the refile cache and disable all the markers."
11683 (dolist (m org-refile-markers) (move-marker m nil))
11684 (setq org-refile-markers nil)
11685 (setq org-refile-cache nil)
11686 (message "Refile cache has been cleared"))
11688 (defun org-refile-cache-check-set (set)
11689 "Check if all the markers in the cache still have live buffers."
11690 (let (marker)
11691 (catch 'exit
11692 (while (and set (setq marker (nth 3 (pop set))))
11693 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11694 (when (and marker (null (marker-buffer marker)))
11695 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11696 (sit-for 3)
11697 (throw 'exit nil)))
11698 t)))
11700 (defun org-refile-cache-put (set &rest identifiers)
11701 "Push the refile targets SET into the cache, under IDENTIFIERS."
11702 (let* ((key (sha1 (prin1-to-string identifiers)))
11703 (entry (assoc key org-refile-cache)))
11704 (if entry
11705 (setcdr entry set)
11706 (push (cons key set) org-refile-cache))))
11708 (defun org-refile-cache-get (&rest identifiers)
11709 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11710 (cond
11711 ((not org-refile-cache) nil)
11712 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11714 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11715 org-refile-cache))))
11716 (and set (org-refile-cache-check-set set) set)))))
11718 (defvar org-outline-path-cache nil
11719 "Alist between buffer positions and outline paths.
11720 It value is an alist (POSITION . PATH) where POSITION is the
11721 buffer position at the beginning of an entry and PATH is a list
11722 of strings describing the outline path for that entry, in reverse
11723 order.")
11725 (defun org-refile-get-targets (&optional default-buffer)
11726 "Produce a table with refile targets."
11727 (let ((case-fold-search nil)
11728 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11729 (entries (or org-refile-targets '((nil . (:level . 1)))))
11730 targets tgs files desc descre)
11731 (message "Getting targets...")
11732 (with-current-buffer (or default-buffer (current-buffer))
11733 (dolist (entry entries)
11734 (setq files (car entry) desc (cdr entry))
11735 (cond
11736 ((null files) (setq files (list (current-buffer))))
11737 ((eq files 'org-agenda-files)
11738 (setq files (org-agenda-files 'unrestricted)))
11739 ((and (symbolp files) (fboundp files))
11740 (setq files (funcall files)))
11741 ((and (symbolp files) (boundp files))
11742 (setq files (symbol-value files))))
11743 (when (stringp files) (setq files (list files)))
11744 (cond
11745 ((eq (car desc) :tag)
11746 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11747 ((eq (car desc) :todo)
11748 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11749 ((eq (car desc) :regexp)
11750 (setq descre (cdr desc)))
11751 ((eq (car desc) :level)
11752 (setq descre (concat "^\\*\\{" (number-to-string
11753 (if org-odd-levels-only
11754 (1- (* 2 (cdr desc)))
11755 (cdr desc)))
11756 "\\}[ \t]")))
11757 ((eq (car desc) :maxlevel)
11758 (setq descre (concat "^\\*\\{1," (number-to-string
11759 (if org-odd-levels-only
11760 (1- (* 2 (cdr desc)))
11761 (cdr desc)))
11762 "\\}[ \t]")))
11763 (t (error "Bad refiling target description %s" desc)))
11764 (dolist (f files)
11765 (with-current-buffer (if (bufferp f) f (org-get-agenda-file-buffer f))
11767 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11768 (progn
11769 (when (bufferp f)
11770 (setq f (buffer-file-name (buffer-base-buffer f))))
11771 (setq f (and f (expand-file-name f)))
11772 (when (eq org-refile-use-outline-path 'file)
11773 (push (list (file-name-nondirectory f) f nil nil) tgs))
11774 (org-with-wide-buffer
11775 (goto-char (point-min))
11776 (setq org-outline-path-cache nil)
11777 (while (re-search-forward descre nil t)
11778 (beginning-of-line)
11779 (let ((case-fold-search nil))
11780 (looking-at org-complex-heading-regexp))
11781 (let ((begin (point))
11782 (heading (match-string-no-properties 4)))
11783 (unless (or (and
11784 org-refile-target-verify-function
11785 (not
11786 (funcall org-refile-target-verify-function)))
11787 (not heading))
11788 (let ((re (format org-complex-heading-regexp-format
11789 (regexp-quote heading)))
11790 (target
11791 (if (not org-refile-use-outline-path) heading
11792 (mapconcat
11793 #'org-protect-slash
11794 (append
11795 (pcase org-refile-use-outline-path
11796 (`file (list (file-name-nondirectory
11797 (buffer-file-name
11798 (buffer-base-buffer)))))
11799 (`full-file-path
11800 (list (buffer-file-name
11801 (buffer-base-buffer))))
11802 (_ nil))
11803 (org-get-outline-path t t))
11804 "/"))))
11805 (push (list target f re (org-refile-marker (point)))
11806 tgs)))
11807 (when (= (point) begin)
11808 ;; Verification function has not moved point.
11809 (end-of-line)))))))
11810 (when org-refile-use-cache
11811 (org-refile-cache-put tgs (buffer-file-name) descre))
11812 (setq targets (append tgs targets))))))
11813 (message "Getting targets...done")
11814 (nreverse targets)))
11816 (defun org-protect-slash (s)
11817 (replace-regexp-in-string "/" "\\/" s nil t))
11819 (defun org--get-outline-path-1 (&optional use-cache)
11820 "Return outline path to current headline.
11822 Outline path is a list of strings, in reverse order. When
11823 optional argument USE-CACHE is non-nil, make use of a cache. See
11824 `org-get-outline-path' for details.
11826 Assume buffer is widened and point is on a headline."
11827 (or (and use-cache (cdr (assq (point) org-outline-path-cache)))
11828 (let ((p (point))
11829 (heading (let ((case-fold-search nil))
11830 (looking-at org-complex-heading-regexp)
11831 (if (not (match-end 4)) ""
11832 ;; Remove statistics cookies.
11833 (org-trim
11834 (org-link-display-format
11835 (replace-regexp-in-string
11836 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11837 (match-string-no-properties 4))))))))
11838 (if (org-up-heading-safe)
11839 (let ((path (cons heading (org--get-outline-path-1 use-cache))))
11840 (when use-cache
11841 (push (cons p path) org-outline-path-cache))
11842 path)
11843 ;; This is a new root node. Since we assume we are moving
11844 ;; forward, we can drop previous cache so as to limit number
11845 ;; of associations there.
11846 (let ((path (list heading)))
11847 (when use-cache (setq org-outline-path-cache (list (cons p path))))
11848 path)))))
11850 (defun org-get-outline-path (&optional with-self use-cache)
11851 "Return the outline path to the current entry.
11853 An outline path is a list of ancestors for current headline, as
11854 a list of strings. Statistics cookies are removed and links are
11855 replaced with their description, if any, or their path otherwise.
11857 When optional argument WITH-SELF is non-nil, the path also
11858 includes the current headline.
11860 When optional argument USE-CACHE is non-nil, cache outline paths
11861 between calls to this function so as to avoid backtracking. This
11862 argument is useful when planning to find more than one outline
11863 path in the same document. In that case, there are two
11864 conditions to satisfy:
11865 - `org-outline-path-cache' is set to nil before starting the
11866 process;
11867 - outline paths are computed by increasing buffer positions."
11868 (org-with-wide-buffer
11869 (and (or (and with-self (org-back-to-heading t))
11870 (org-up-heading-safe))
11871 (reverse (org--get-outline-path-1 use-cache)))))
11873 (defun org-format-outline-path (path &optional width prefix separator)
11874 "Format the outline path PATH for display.
11875 WIDTH is the maximum number of characters that is available.
11876 PREFIX is a prefix to be included in the returned string,
11877 such as the file name.
11878 SEPARATOR is inserted between the different parts of the path,
11879 the default is \"/\"."
11880 (setq width (or width 79))
11881 (setq path (delq nil path))
11882 (unless (> width 0)
11883 (user-error "Argument `width' must be positive"))
11884 (setq separator (or separator "/"))
11885 (let* ((org-odd-levels-only nil)
11886 (fpath (concat
11887 prefix (and prefix path separator)
11888 (mapconcat
11889 (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
11890 (cl-loop for head in path
11891 for n from 0
11892 collect (org-add-props
11893 head nil 'face
11894 (nth (% n org-n-level-faces) org-level-faces)))
11895 separator))))
11896 (when (> (length fpath) width)
11897 (if (< width 7)
11898 ;; It's unlikely that `width' will be this small, but don't
11899 ;; waste characters by adding ".." if it is.
11900 (setq fpath (substring fpath 0 width))
11901 (setf (substring fpath (- width 2)) "..")))
11902 fpath))
11904 (defun org-display-outline-path (&optional file current separator just-return-string)
11905 "Display the current outline path in the echo area.
11907 If FILE is non-nil, prepend the output with the file name.
11908 If CURRENT is non-nil, append the current heading to the output.
11909 SEPARATOR is passed through to `org-format-outline-path'. It separates
11910 the different parts of the path and defaults to \"/\".
11911 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11912 (interactive "P")
11913 (let* (case-fold-search
11914 (bfn (buffer-file-name (buffer-base-buffer)))
11915 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11916 res)
11917 (when current (setq path (append path
11918 (save-excursion
11919 (org-back-to-heading t)
11920 (when (looking-at org-complex-heading-regexp)
11921 (list (match-string 4)))))))
11922 (setq res
11923 (org-format-outline-path
11924 path
11925 (1- (frame-width))
11926 (and file bfn (concat (file-name-nondirectory bfn) separator))
11927 separator))
11928 (if just-return-string
11929 (org-no-properties res)
11930 (org-unlogged-message "%s" res))))
11932 (defvar org-refile-history nil
11933 "History for refiling operations.")
11935 (defvar org-after-refile-insert-hook nil
11936 "Hook run after `org-refile' has inserted its stuff at the new location.
11937 Note that this is still *before* the stuff will be removed from
11938 the *old* location.")
11940 (defvar org-capture-last-stored-marker)
11941 (defvar org-refile-keep nil
11942 "Non-nil means `org-refile' will copy instead of refile.")
11944 (defun org-copy ()
11945 "Like `org-refile', but copy."
11946 (interactive)
11947 (let ((org-refile-keep t))
11948 (funcall 'org-refile nil nil nil "Copy")))
11950 (defun org-refile (&optional arg default-buffer rfloc msg)
11951 "Move the entry or entries at point to another heading.
11953 The list of target headings is compiled using the information in
11954 `org-refile-targets', which see.
11956 At the target location, the entry is filed as a subitem of the
11957 target heading. Depending on `org-reverse-note-order', the new
11958 subitem will either be the first or the last subitem.
11960 If there is an active region, all entries in that region will be
11961 refiled. However, the region must fulfill the requirement that
11962 the first heading sets the top-level of the moved text.
11964 With a `\\[universal-argument]' ARG, the command will only visit the target \
11965 location
11966 and not actually move anything.
11968 With a prefix `\\[universal-argument] \\[universal-argument]', go to the \
11969 location where the last
11970 refiling operation has put the subtree.
11972 With a numeric prefix argument of `2', refile to the running clock.
11974 With a numeric prefix argument of `3', emulate `org-refile-keep'
11975 being set to t and copy to the target location, don't move it.
11976 Beware that keeping refiled entries may result in duplicated ID
11977 properties.
11979 RFLOC can be a refile location obtained in a different way.
11981 MSG is a string to replace \"Refile\" in the default prompt with
11982 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11984 See also `org-refile-use-outline-path'.
11986 If you are using target caching (see `org-refile-use-cache'), you
11987 have to clear the target cache in order to find new targets.
11988 This can be done with a `0' prefix (`C-0 C-c C-w') or a triple
11989 prefix argument (`C-u C-u C-u C-c C-w')."
11990 (interactive "P")
11991 (if (member arg '(0 (64)))
11992 (org-refile-cache-clear)
11993 (let* ((actionmsg (cond (msg msg)
11994 ((equal arg 3) "Refile (and keep)")
11995 (t "Refile")))
11996 (regionp (org-region-active-p))
11997 (region-start (and regionp (region-beginning)))
11998 (region-end (and regionp (region-end)))
11999 (org-refile-keep (if (equal arg 3) t org-refile-keep))
12000 pos it nbuf file level reversed)
12001 (setq last-command nil)
12002 (when regionp
12003 (goto-char region-start)
12004 (or (bolp) (goto-char (point-at-bol)))
12005 (setq region-start (point))
12006 (unless (or (org-kill-is-subtree-p
12007 (buffer-substring region-start region-end))
12008 (prog1 org-refile-active-region-within-subtree
12009 (let ((s (point-at-eol)))
12010 (org-toggle-heading)
12011 (setq region-end (+ (- (point-at-eol) s) region-end)))))
12012 (user-error "The region is not a (sequence of) subtree(s)")))
12013 (if (equal arg '(16))
12014 (org-refile-goto-last-stored)
12015 (when (or
12016 (and (equal arg 2)
12017 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
12018 (prog1
12019 (setq it (list (or org-clock-heading "running clock")
12020 (buffer-file-name
12021 (marker-buffer org-clock-hd-marker))
12023 (marker-position org-clock-hd-marker)))
12024 (setq arg nil)))
12025 (setq it
12026 (or rfloc
12027 (let (heading-text)
12028 (save-excursion
12029 (unless (and arg (listp arg))
12030 (org-back-to-heading t)
12031 (setq heading-text
12032 (replace-regexp-in-string
12033 org-bracket-link-regexp
12034 "\\3"
12035 (or (nth 4 (org-heading-components))
12036 ""))))
12037 (org-refile-get-location
12038 (cond ((and arg (listp arg)) "Goto")
12039 (regionp (concat actionmsg " region to"))
12040 (t (concat actionmsg " subtree \""
12041 heading-text "\" to")))
12042 default-buffer
12043 (and (not (equal '(4) arg))
12044 org-refile-allow-creating-parent-nodes)))))))
12045 (setq file (nth 1 it)
12046 pos (nth 3 it))
12047 (when (and (not arg)
12049 (equal (buffer-file-name) file)
12050 (if regionp
12051 (and (>= pos region-start)
12052 (<= pos region-end))
12053 (and (>= pos (point))
12054 (< pos (save-excursion
12055 (org-end-of-subtree t t))))))
12056 (error "Cannot refile to position inside the tree or region"))
12057 (setq nbuf (or (find-buffer-visiting file)
12058 (find-file-noselect file)))
12059 (if (and arg (not (equal arg 3)))
12060 (progn
12061 (pop-to-buffer-same-window nbuf)
12062 (goto-char pos)
12063 (org-show-context 'org-goto))
12064 (if regionp
12065 (progn
12066 (org-kill-new (buffer-substring region-start region-end))
12067 (org-save-markers-in-region region-start region-end))
12068 (org-copy-subtree 1 nil t))
12069 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
12070 (find-file-noselect file)))
12071 (setq reversed (org-notes-order-reversed-p))
12072 (org-with-wide-buffer
12073 (if pos
12074 (progn
12075 (goto-char pos)
12076 (looking-at org-outline-regexp)
12077 (setq level (org-get-valid-level (funcall outline-level) 1))
12078 (goto-char
12079 (if reversed
12080 (or (outline-next-heading) (point-max))
12081 (or (save-excursion (org-get-next-sibling))
12082 (org-end-of-subtree t t)
12083 (point-max)))))
12084 (setq level 1)
12085 (if (not reversed)
12086 (goto-char (point-max))
12087 (goto-char (point-min))
12088 (or (outline-next-heading) (goto-char (point-max)))))
12089 (unless (bolp) (newline))
12090 (org-paste-subtree level nil nil t)
12091 (when org-log-refile
12092 (org-add-log-setup 'refile nil nil org-log-refile)
12093 (unless (eq org-log-refile 'note)
12094 (save-excursion (org-add-log-note))))
12095 (and org-auto-align-tags
12096 (let ((org-loop-over-headlines-in-active-region nil))
12097 (org-set-tags nil t)))
12098 (let ((bookmark-name (plist-get org-bookmark-names-plist
12099 :last-refile)))
12100 (when bookmark-name
12101 (with-demoted-errors
12102 (bookmark-set bookmark-name))))
12103 ;; If we are refiling for capture, make sure that the
12104 ;; last-capture pointers point here
12105 (when (bound-and-true-p org-capture-is-refiling)
12106 (let ((bookmark-name (plist-get org-bookmark-names-plist
12107 :last-capture-marker)))
12108 (when bookmark-name
12109 (with-demoted-errors
12110 (bookmark-set bookmark-name))))
12111 (move-marker org-capture-last-stored-marker (point)))
12112 (when (fboundp 'deactivate-mark) (deactivate-mark))
12113 (run-hooks 'org-after-refile-insert-hook)))
12114 (unless org-refile-keep
12115 (if regionp
12116 (delete-region (point) (+ (point) (- region-end region-start)))
12117 (delete-region
12118 (and (org-back-to-heading t) (point))
12119 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
12120 (when (featurep 'org-inlinetask)
12121 (org-inlinetask-remove-END-maybe))
12122 (setq org-markers-to-move nil)
12123 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
12125 (defun org-refile-goto-last-stored ()
12126 "Go to the location where the last refile was stored."
12127 (interactive)
12128 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12129 (message "This is the location of the last refile"))
12131 (defun org-refile--get-location (refloc tbl)
12132 "When user refile to REFLOC, find the associated target in TBL.
12133 Also check `org-refile-target-table'."
12134 (car (delq
12136 (mapcar
12137 (lambda (r) (or (assoc r tbl)
12138 (assoc r org-refile-target-table)))
12139 (list (replace-regexp-in-string "/$" "" refloc)
12140 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12142 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
12143 "Prompt the user for a refile location, using PROMPT.
12144 PROMPT should not be suffixed with a colon and a space, because
12145 this function appends the default value from
12146 `org-refile-history' automatically, if that is not empty."
12147 (let ((org-refile-targets org-refile-targets)
12148 (org-refile-use-outline-path org-refile-use-outline-path))
12149 (setq org-refile-target-table (org-refile-get-targets default-buffer)))
12150 (unless org-refile-target-table
12151 (user-error "No refile targets"))
12152 (let* ((cbuf (current-buffer))
12153 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12154 (cfunc (if (and org-refile-use-outline-path
12155 org-outline-path-complete-in-steps)
12156 #'org-olpath-completing-read
12157 #'completing-read))
12158 (extra (if org-refile-use-outline-path "/" ""))
12159 (cbnex (concat (buffer-name) extra))
12160 (filename (and cfn (expand-file-name cfn)))
12161 (tbl (mapcar
12162 (lambda (x)
12163 (if (and (not (member org-refile-use-outline-path
12164 '(file full-file-path)))
12165 (not (equal filename (nth 1 x))))
12166 (cons (concat (car x) extra " ("
12167 (file-name-nondirectory (nth 1 x)) ")")
12168 (cdr x))
12169 (cons (concat (car x) extra) (cdr x))))
12170 org-refile-target-table))
12171 (completion-ignore-case t)
12172 cdef
12173 (prompt (concat prompt
12174 (or (and (car org-refile-history)
12175 (concat " (default " (car org-refile-history) ")"))
12176 (and (assoc cbnex tbl) (setq cdef cbnex)
12177 (concat " (default " cbnex ")"))) ": "))
12178 pa answ parent-target child parent old-hist)
12179 (setq old-hist org-refile-history)
12180 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12181 nil 'org-refile-history (or cdef (car org-refile-history))))
12182 (if (setq pa (org-refile--get-location answ tbl))
12183 (progn
12184 (org-refile-check-position pa)
12185 (when (or (not org-refile-history)
12186 (not (eq old-hist org-refile-history))
12187 (not (equal (car pa) (car org-refile-history))))
12188 (setq org-refile-history
12189 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12190 org-refile-history
12191 (cdr org-refile-history))))
12192 (when (equal (car org-refile-history) (nth 1 org-refile-history))
12193 (pop org-refile-history)))
12195 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12196 (progn
12197 (setq parent (match-string 1 answ)
12198 child (match-string 2 answ))
12199 (setq parent-target (org-refile--get-location parent tbl))
12200 (when (and parent-target
12201 (or (eq new-nodes t)
12202 (and (eq new-nodes 'confirm)
12203 (y-or-n-p (format "Create new node \"%s\"? "
12204 child)))))
12205 (org-refile-new-child parent-target child)))
12206 (user-error "Invalid target location")))))
12208 (declare-function org-string-nw-p "org-macs" (s))
12209 (defun org-refile-check-position (refile-pointer)
12210 "Check if the refile pointer matches the headline to which it points."
12211 (let* ((file (nth 1 refile-pointer))
12212 (re (nth 2 refile-pointer))
12213 (pos (nth 3 refile-pointer))
12214 buffer)
12215 (if (and (not (markerp pos)) (not file))
12216 (user-error "Please indicate a target file in the refile path")
12217 (when (org-string-nw-p re)
12218 (setq buffer (if (markerp pos)
12219 (marker-buffer pos)
12220 (or (find-buffer-visiting file)
12221 (find-file-noselect file))))
12222 (with-current-buffer buffer
12223 (org-with-wide-buffer
12224 (goto-char pos)
12225 (beginning-of-line 1)
12226 (unless (looking-at-p re)
12227 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
12229 (defun org-refile-new-child (parent-target child)
12230 "Use refile target PARENT-TARGET to add new CHILD below it."
12231 (unless parent-target
12232 (error "Cannot find parent for new node"))
12233 (let ((file (nth 1 parent-target))
12234 (pos (nth 3 parent-target))
12235 level)
12236 (with-current-buffer (or (find-buffer-visiting file)
12237 (find-file-noselect file))
12238 (org-with-wide-buffer
12239 (if pos
12240 (goto-char pos)
12241 (goto-char (point-max))
12242 (unless (bolp) (newline)))
12243 (when (looking-at org-outline-regexp)
12244 (setq level (funcall outline-level))
12245 (org-end-of-subtree t t))
12246 (org-back-over-empty-lines)
12247 (insert "\n" (make-string
12248 (if pos (org-get-valid-level level 1) 1) ?*)
12249 " " child "\n")
12250 (beginning-of-line 0)
12251 (list (concat (car parent-target) "/" child) file "" (point))))))
12253 (defun org-olpath-completing-read (prompt collection &rest args)
12254 "Read an outline path like a file name."
12255 (let ((thetable collection))
12256 (apply #'completing-read
12257 prompt
12258 (lambda (string predicate &optional flag)
12259 (cond
12260 ((eq flag nil) (try-completion string thetable))
12261 ((eq flag t)
12262 (let ((l (length string)))
12263 (mapcar (lambda (x)
12264 (let ((r (substring x l))
12265 (f (if (string-match " ([^)]*)$" x)
12266 (match-string 0 x)
12267 "")))
12268 (if (string-match "/" r)
12269 (concat string (substring r 0 (match-end 0)) f)
12270 x)))
12271 (all-completions string thetable predicate))))
12272 ;; Exact match?
12273 ((eq flag 'lambda) (assoc string thetable))))
12274 args)))
12276 ;;;; Dynamic blocks
12278 (defun org-find-dblock (name)
12279 "Find the first dynamic block with name NAME in the buffer.
12280 If not found, stay at current position and return nil."
12281 (let ((case-fold-search t) pos)
12282 (save-excursion
12283 (goto-char (point-min))
12284 (setq pos (and (re-search-forward
12285 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12286 (match-beginning 0))))
12287 (when pos (goto-char pos))
12288 pos))
12290 (defun org-create-dblock (plist)
12291 "Create a dynamic block section, with parameters taken from PLIST.
12292 PLIST must contain a :name entry which is used as the name of the block."
12293 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12294 (end-of-line 1)
12295 (newline))
12296 (let ((col (current-column))
12297 (name (plist-get plist :name)))
12298 (insert "#+BEGIN: " name)
12299 (while plist
12300 (if (eq (car plist) :name)
12301 (setq plist (cddr plist))
12302 (insert " " (prin1-to-string (pop plist)))))
12303 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12304 (beginning-of-line -2)))
12306 (defun org-prepare-dblock ()
12307 "Prepare dynamic block for refresh.
12308 This empties the block, puts the cursor at the insert position and returns
12309 the property list including an extra property :name with the block name."
12310 (unless (looking-at org-dblock-start-re)
12311 (user-error "Not at a dynamic block"))
12312 (let* ((begdel (1+ (match-end 0)))
12313 (name (org-no-properties (match-string 1)))
12314 (params (append (list :name name)
12315 (read (concat "(" (match-string 3) ")")))))
12316 (save-excursion
12317 (beginning-of-line 1)
12318 (skip-chars-forward " \t")
12319 (setq params (plist-put params :indentation-column (current-column))))
12320 (unless (re-search-forward org-dblock-end-re nil t)
12321 (error "Dynamic block not terminated"))
12322 (setq params
12323 (append params
12324 (list :content (buffer-substring
12325 begdel (match-beginning 0)))))
12326 (delete-region begdel (match-beginning 0))
12327 (goto-char begdel)
12328 (open-line 1)
12329 params))
12331 (defun org-map-dblocks (&optional command)
12332 "Apply COMMAND to all dynamic blocks in the current buffer.
12333 If COMMAND is not given, use `org-update-dblock'."
12334 (let ((cmd (or command 'org-update-dblock)))
12335 (save-excursion
12336 (goto-char (point-min))
12337 (while (re-search-forward org-dblock-start-re nil t)
12338 (goto-char (match-beginning 0))
12339 (save-excursion
12340 (condition-case nil
12341 (funcall cmd)
12342 (error (message "Error during update of dynamic block"))))
12343 (unless (re-search-forward org-dblock-end-re nil t)
12344 (error "Dynamic block not terminated"))))))
12346 (defun org-dblock-update (&optional arg)
12347 "User command for updating dynamic blocks.
12348 Update the dynamic block at point. With prefix ARG, update all dynamic
12349 blocks in the buffer."
12350 (interactive "P")
12351 (if arg
12352 (org-update-all-dblocks)
12353 (or (looking-at org-dblock-start-re)
12354 (org-beginning-of-dblock))
12355 (org-update-dblock)))
12357 (defun org-update-dblock ()
12358 "Update the dynamic block at point.
12359 This means to empty the block, parse for parameters and then call
12360 the correct writing function."
12361 (interactive)
12362 (save-excursion
12363 (let* ((win (selected-window))
12364 (pos (point))
12365 (line (org-current-line))
12366 (params (org-prepare-dblock))
12367 (name (plist-get params :name))
12368 (indent (plist-get params :indentation-column))
12369 (cmd (intern (concat "org-dblock-write:" name))))
12370 (message "Updating dynamic block `%s' at line %d..." name line)
12371 (funcall cmd params)
12372 (message "Updating dynamic block `%s' at line %d...done" name line)
12373 (goto-char pos)
12374 (when (and indent (> indent 0))
12375 (setq indent (make-string indent ?\ ))
12376 (save-excursion
12377 (select-window win)
12378 (org-beginning-of-dblock)
12379 (forward-line 1)
12380 (while (not (looking-at org-dblock-end-re))
12381 (insert indent)
12382 (beginning-of-line 2))
12383 (when (looking-at org-dblock-end-re)
12384 (and (looking-at "[ \t]+")
12385 (replace-match ""))
12386 (insert indent)))))))
12388 (defun org-beginning-of-dblock ()
12389 "Find the beginning of the dynamic block at point.
12390 Error if there is no such block at point."
12391 (let ((pos (point))
12392 beg)
12393 (end-of-line 1)
12394 (if (and (re-search-backward org-dblock-start-re nil t)
12395 (setq beg (match-beginning 0))
12396 (re-search-forward org-dblock-end-re nil t)
12397 (> (match-end 0) pos))
12398 (goto-char beg)
12399 (goto-char pos)
12400 (error "Not in a dynamic block"))))
12402 (defun org-update-all-dblocks ()
12403 "Update all dynamic blocks in the buffer.
12404 This function can be used in a hook."
12405 (interactive)
12406 (when (derived-mode-p 'org-mode)
12407 (org-map-dblocks 'org-update-dblock)))
12410 ;;;; Completion
12412 (declare-function org-export-backend-options "ox" (cl-x) t)
12413 (defun org-get-export-keywords ()
12414 "Return a list of all currently understood export keywords.
12415 Export keywords include options, block names, attributes and
12416 keywords relative to each registered export back-end."
12417 (let (keywords)
12418 (dolist (backend
12419 (bound-and-true-p org-export-registered-backends)
12420 (delq nil keywords))
12421 ;; Back-end name (for keywords, like #+LATEX:)
12422 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12423 (dolist (option-entry (org-export-backend-options backend))
12424 ;; Back-end options.
12425 (push (nth 1 option-entry) keywords)))))
12427 (defconst org-options-keywords
12428 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12429 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12430 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12431 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12432 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12434 (defcustom org-structure-template-alist
12435 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12436 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12437 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12438 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12439 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12440 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12441 ("l" "#+BEGIN_EXPORT latex\n?\n#+END_EXPORT")
12442 ("L" "#+LaTeX: ")
12443 ("h" "#+BEGIN_EXPORT html\n?\n#+END_EXPORT")
12444 ("H" "#+HTML: ")
12445 ("a" "#+BEGIN_EXPORT ascii\n?\n#+END_EXPORT")
12446 ("A" "#+ASCII: ")
12447 ("i" "#+INDEX: ?")
12448 ("I" "#+INCLUDE: %file ?"))
12449 "Structure completion elements.
12450 This is a list of abbreviation keys and values. The value gets inserted
12451 if you type `<' followed by the key and then press the completion key,
12452 usually `TAB'. %file will be replaced by a file name after prompting
12453 for the file using completion. The cursor will be placed at the position
12454 of the `?' in the template.
12455 There are two templates for each key, the first uses the original Org syntax,
12456 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12457 the default when the /org-mtags.el/ module has been loaded. See also the
12458 variable `org-mtags-prefer-muse-templates'."
12459 :group 'org-completion
12460 :type '(repeat
12461 (list
12462 (string :tag "Key")
12463 (string :tag "Template")))
12464 :version "26.1"
12465 :package-version '(Org . "8.3"))
12467 (defun org-try-structure-completion ()
12468 "Try to complete a structure template before point.
12469 This looks for strings like \"<e\" on an otherwise empty line and
12470 expands them."
12471 (let ((l (buffer-substring (point-at-bol) (point)))
12473 (when (and (looking-at "[ \t]*$")
12474 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12475 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12476 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12477 (match-beginning 1)) a)
12478 t)))
12480 (defun org-complete-expand-structure-template (start cell)
12481 "Expand a structure template."
12482 (let ((rpl (nth 1 cell))
12483 (ind ""))
12484 (delete-region start (point))
12485 (when (string-match "\\`[ \t]*#\\+" rpl)
12486 (cond
12487 ((bolp))
12488 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12489 (setq ind (buffer-substring (point-at-bol) (point))))
12490 (t (newline))))
12491 (setq start (point))
12492 (when (string-match "%file" rpl)
12493 (setq rpl (replace-match
12494 (concat
12495 "\""
12496 (save-match-data
12497 (abbreviate-file-name (read-file-name "Include file: ")))
12498 "\"")
12499 t t rpl)))
12500 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12501 (concat "\n" ind)))
12502 (insert rpl)
12503 (when (re-search-backward "\\?" start t) (delete-char 1))))
12505 ;;;; TODO, DEADLINE, Comments
12507 (defun org-toggle-comment ()
12508 "Change the COMMENT state of an entry."
12509 (interactive)
12510 (save-excursion
12511 (org-back-to-heading)
12512 (let ((case-fold-search nil))
12513 (looking-at org-complex-heading-regexp))
12514 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12515 (skip-chars-forward " \t")
12516 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12517 (if (org-in-commented-heading-p t)
12518 (delete-region (point)
12519 (progn (search-forward " " (line-end-position) 'move)
12520 (skip-chars-forward " \t")
12521 (point)))
12522 (insert org-comment-string)
12523 (unless (eolp) (insert " ")))))
12525 (defvar org-last-todo-state-is-todo nil
12526 "This is non-nil when the last TODO state change led to a TODO state.
12527 If the last change removed the TODO tag or switched to DONE, then
12528 this is nil.")
12530 (defvar org-setting-tags nil) ; dynamically skipped
12532 (defvar org-todo-setup-filter-hook nil
12533 "Hook for functions that pre-filter todo specs.
12534 Each function takes a todo spec and returns either nil or the spec
12535 transformed into canonical form." )
12537 (defvar org-todo-get-default-hook nil
12538 "Hook for functions that get a default item for todo.
12539 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12540 nil or a string to be used for the todo mark." )
12542 (defvar org-agenda-headline-snapshot-before-repeat)
12544 (defun org-current-effective-time ()
12545 "Return current time adjusted for `org-extend-today-until' variable."
12546 (let* ((ct (org-current-time))
12547 (dct (decode-time ct))
12548 (ct1
12549 (cond
12550 (org-use-last-clock-out-time-as-effective-time
12551 (or (org-clock-get-last-clock-out-time) ct))
12552 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12553 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12554 (t ct))))
12555 ct1))
12557 (defun org-todo-yesterday (&optional arg)
12558 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12559 (interactive "P")
12560 (if (eq major-mode 'org-agenda-mode)
12561 (apply 'org-agenda-todo-yesterday arg)
12562 (let* ((org-use-effective-time t)
12563 (hour (nth 2 (decode-time (org-current-time))))
12564 (org-extend-today-until (1+ hour)))
12565 (org-todo arg))))
12567 (defvar org-block-entry-blocking ""
12568 "First entry preventing the TODO state change.")
12570 (defun org-cancel-repeater ()
12571 "Cancel a repeater by setting its numeric value to zero."
12572 (interactive)
12573 (save-excursion
12574 (org-back-to-heading t)
12575 (let ((bound1 (point))
12576 (bound0 (save-excursion (outline-next-heading) (point))))
12577 (when (and (re-search-forward
12578 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12579 org-deadline-time-regexp "\\)\\|\\("
12580 org-ts-regexp "\\)")
12581 bound0 t)
12582 (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]"
12583 bound1 t))
12584 (replace-match "0" t nil nil 1)))))
12586 (defvar org-state) ;; dynamically scoped into this function
12587 (defun org-todo (&optional arg)
12588 "Change the TODO state of an item.
12590 The state of an item is given by a keyword at the start of the heading,
12591 like
12592 *** TODO Write paper
12593 *** DONE Call mom
12595 The different keywords are specified in the variable `org-todo-keywords'.
12596 By default the available states are \"TODO\" and \"DONE\". So, for this
12597 example: when the item starts with TODO, it is changed to DONE.
12598 When it starts with DONE, the DONE is removed. And when neither TODO nor
12599 DONE are present, add TODO at the beginning of the heading.
12601 With `\\[universal-argument]' prefix ARG, use completion to determine the new \
12602 state.
12603 With numeric prefix ARG, switch to that state.
12604 With a `\\[universal-argument] \\[universal-argument]' prefix, switch to the \
12605 next set of TODO \
12606 keywords (nextset).
12607 With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
12608 prefix, circumvent any state blocking.
12609 With a numeric prefix arg of 0, inhibit note taking for the change.
12610 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12612 When called through ELisp, arg is also interpreted in the following way:
12613 `none' -> empty state
12614 \"\" -> switch to empty state
12615 `done' -> switch to DONE
12616 `nextset' -> switch to the next set of keywords
12617 `previousset' -> switch to the previous set of keywords
12618 \"WAITING\" -> switch to the specified keyword, but only if it
12619 really is a member of `org-todo-keywords'."
12620 (interactive "P")
12621 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12622 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12623 'region-start-level 'region))
12624 org-loop-over-headlines-in-active-region)
12625 (org-map-entries
12626 `(org-todo ,arg)
12627 org-loop-over-headlines-in-active-region
12628 cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
12629 (when (equal arg '(16)) (setq arg 'nextset))
12630 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12631 (let ((org-blocker-hook org-blocker-hook)
12632 commentp
12633 case-fold-search)
12634 (when (equal arg '(64))
12635 (setq arg nil org-blocker-hook nil))
12636 (when (and org-blocker-hook
12637 (or org-inhibit-blocking
12638 (org-entry-get nil "NOBLOCKING")))
12639 (setq org-blocker-hook nil))
12640 (save-excursion
12641 (catch 'exit
12642 (org-back-to-heading t)
12643 (when (org-in-commented-heading-p t)
12644 (org-toggle-comment)
12645 (setq commentp t))
12646 (when (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12647 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12648 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12649 (let* ((match-data (match-data))
12650 (startpos (point-at-bol))
12651 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12652 (org-log-done org-log-done)
12653 (org-log-repeat org-log-repeat)
12654 (org-todo-log-states org-todo-log-states)
12655 (org-inhibit-logging
12656 (if (equal arg 0)
12657 (progn (setq arg nil) 'note) org-inhibit-logging))
12658 (this (match-string 1))
12659 (hl-pos (match-beginning 0))
12660 (head (org-get-todo-sequence-head this))
12661 (ass (assoc head org-todo-kwd-alist))
12662 (interpret (nth 1 ass))
12663 (done-word (nth 3 ass))
12664 (final-done-word (nth 4 ass))
12665 (org-last-state (or this ""))
12666 (completion-ignore-case t)
12667 (member (member this org-todo-keywords-1))
12668 (tail (cdr member))
12669 (org-state (cond
12670 ((and org-todo-key-trigger
12671 (or (and (equal arg '(4))
12672 (eq org-use-fast-todo-selection 'prefix))
12673 (and (not arg) org-use-fast-todo-selection
12674 (not (eq org-use-fast-todo-selection
12675 'prefix)))))
12676 ;; Use fast selection
12677 (org-fast-todo-selection))
12678 ((and (equal arg '(4))
12679 (or (not org-use-fast-todo-selection)
12680 (not org-todo-key-trigger)))
12681 ;; Read a state with completion
12682 (completing-read
12683 "State: " (mapcar #'list org-todo-keywords-1)
12684 nil t))
12685 ((eq arg 'right)
12686 (if this
12687 (if tail (car tail) nil)
12688 (car org-todo-keywords-1)))
12689 ((eq arg 'left)
12690 (unless (equal member org-todo-keywords-1)
12691 (if this
12692 (nth (- (length org-todo-keywords-1)
12693 (length tail) 2)
12694 org-todo-keywords-1)
12695 (org-last org-todo-keywords-1))))
12696 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12697 (setq arg nil))) ; hack to fall back to cycling
12698 (arg
12699 ;; user or caller requests a specific state
12700 (cond
12701 ((equal arg "") nil)
12702 ((eq arg 'none) nil)
12703 ((eq arg 'done) (or done-word (car org-done-keywords)))
12704 ((eq arg 'nextset)
12705 (or (car (cdr (member head org-todo-heads)))
12706 (car org-todo-heads)))
12707 ((eq arg 'previousset)
12708 (let ((org-todo-heads (reverse org-todo-heads)))
12709 (or (car (cdr (member head org-todo-heads)))
12710 (car org-todo-heads))))
12711 ((car (member arg org-todo-keywords-1)))
12712 ((stringp arg)
12713 (user-error "State `%s' not valid in this file" arg))
12714 ((nth (1- (prefix-numeric-value arg))
12715 org-todo-keywords-1))))
12716 ((null member) (or head (car org-todo-keywords-1)))
12717 ((equal this final-done-word) nil) ;; -> make empty
12718 ((null tail) nil) ;; -> first entry
12719 ((memq interpret '(type priority))
12720 (if (eq this-command last-command)
12721 (car tail)
12722 (if (> (length tail) 0)
12723 (or done-word (car org-done-keywords))
12724 nil)))
12726 (car tail))))
12727 (org-state (or
12728 (run-hook-with-args-until-success
12729 'org-todo-get-default-hook org-state org-last-state)
12730 org-state))
12731 (next (if org-state (concat " " org-state " ") " "))
12732 (change-plist (list :type 'todo-state-change :from this :to org-state
12733 :position startpos))
12734 dolog now-done-p)
12735 (when org-blocker-hook
12736 (setq org-last-todo-state-is-todo
12737 (not (member this org-done-keywords)))
12738 (unless (save-excursion
12739 (save-match-data
12740 (org-with-wide-buffer
12741 (run-hook-with-args-until-failure
12742 'org-blocker-hook change-plist))))
12743 (if (called-interactively-p 'interactive)
12744 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12745 this org-state org-block-entry-blocking)
12746 ;; fail silently
12747 (message "TODO state change from %s to %s blocked (by \"%s\")"
12748 this org-state org-block-entry-blocking)
12749 (throw 'exit nil))))
12750 (store-match-data match-data)
12751 (replace-match next t t)
12752 (cond ((equal this org-state)
12753 (message "TODO state was already %s" (org-trim next)))
12754 ((pos-visible-in-window-p hl-pos)
12755 (message "TODO state changed to %s" (org-trim next))))
12756 (unless head
12757 (setq head (org-get-todo-sequence-head org-state)
12758 ass (assoc head org-todo-kwd-alist)
12759 interpret (nth 1 ass)
12760 done-word (nth 3 ass)
12761 final-done-word (nth 4 ass)))
12762 (when (memq arg '(nextset previousset))
12763 (message "Keyword-Set %d/%d: %s"
12764 (- (length org-todo-sets) -1
12765 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12766 (length org-todo-sets)
12767 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12768 (setq org-last-todo-state-is-todo
12769 (not (member org-state org-done-keywords)))
12770 (setq now-done-p (and (member org-state org-done-keywords)
12771 (not (member this org-done-keywords))))
12772 (and logging (org-local-logging logging))
12773 (when (and (or org-todo-log-states org-log-done)
12774 (not (eq org-inhibit-logging t))
12775 (not (memq arg '(nextset previousset))))
12776 ;; we need to look at recording a time and note
12777 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12778 (nth 2 (assoc this org-todo-log-states))))
12779 (when (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12780 (setq dolog 'time))
12781 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12782 (and org-state
12783 (member org-state org-not-done-keywords)
12784 (not (member this org-not-done-keywords))))
12785 ;; This is now a todo state and was not one before
12786 ;; If there was a CLOSED time stamp, get rid of it.
12787 (org-add-planning-info nil nil 'closed))
12788 (when (and now-done-p org-log-done)
12789 ;; It is now done, and it was not done before
12790 (org-add-planning-info 'closed (org-current-effective-time))
12791 (when (and (not dolog) (eq 'note org-log-done))
12792 (org-add-log-setup 'done org-state this 'note)))
12793 (when (and org-state dolog)
12794 ;; This is a non-nil state, and we need to log it
12795 (org-add-log-setup 'state org-state this dolog)))
12796 ;; Fixup tag positioning
12797 (org-todo-trigger-tag-changes org-state)
12798 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12799 (when org-provide-todo-statistics
12800 (org-update-parent-todo-statistics))
12801 (run-hooks 'org-after-todo-state-change-hook)
12802 (when (and arg (not (member org-state org-done-keywords)))
12803 (setq head (org-get-todo-sequence-head org-state)))
12804 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12805 ;; Do we need to trigger a repeat?
12806 (when now-done-p
12807 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12808 ;; This is for the agenda, take a snapshot of the headline.
12809 (save-match-data
12810 (setq org-agenda-headline-snapshot-before-repeat
12811 (org-get-heading))))
12812 (org-auto-repeat-maybe org-state))
12813 ;; Fixup cursor location if close to the keyword
12814 (when (and (outline-on-heading-p)
12815 (not (bolp))
12816 (save-excursion (beginning-of-line 1)
12817 (looking-at org-todo-line-regexp))
12818 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12819 (goto-char (or (match-end 2) (match-end 1)))
12820 (and (looking-at " ") (just-one-space)))
12821 (when org-trigger-hook
12822 (save-excursion
12823 (run-hook-with-args 'org-trigger-hook change-plist)))
12824 (when commentp (org-toggle-comment))))))))
12826 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12827 "Block turning an entry into a TODO, using the hierarchy.
12828 This checks whether the current task should be blocked from state
12829 changes. Such blocking occurs when:
12831 1. The task has children which are not all in a completed state.
12833 2. A task has a parent with the property :ORDERED:, and there
12834 are siblings prior to the current task with incomplete
12835 status.
12837 3. The parent of the task is blocked because it has siblings that should
12838 be done first, or is child of a block grandparent TODO entry."
12840 (if (not org-enforce-todo-dependencies)
12841 t ; if locally turned off don't block
12842 (catch 'dont-block
12843 ;; If this is not a todo state change, or if this entry is already DONE,
12844 ;; do not block
12845 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12846 (member (plist-get change-plist :from)
12847 (cons 'done org-done-keywords))
12848 (member (plist-get change-plist :to)
12849 (cons 'todo org-not-done-keywords))
12850 (not (plist-get change-plist :to)))
12851 (throw 'dont-block t))
12852 ;; If this task has children, and any are undone, it's blocked
12853 (save-excursion
12854 (org-back-to-heading t)
12855 (let ((this-level (funcall outline-level)))
12856 (outline-next-heading)
12857 (let ((child-level (funcall outline-level)))
12858 (while (and (not (eobp))
12859 (> child-level this-level))
12860 ;; this todo has children, check whether they are all
12861 ;; completed
12862 (when (and (not (org-entry-is-done-p))
12863 (org-entry-is-todo-p))
12864 (setq org-block-entry-blocking (org-get-heading))
12865 (throw 'dont-block nil))
12866 (outline-next-heading)
12867 (setq child-level (funcall outline-level))))))
12868 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12869 ;; any previous siblings are undone, it's blocked
12870 (save-excursion
12871 (org-back-to-heading t)
12872 (let* ((pos (point))
12873 (parent-pos (and (org-up-heading-safe) (point)))
12874 (case-fold-search nil))
12875 (unless parent-pos (throw 'dont-block t)) ; no parent
12876 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12877 (forward-line 1)
12878 (re-search-forward org-not-done-heading-regexp pos t))
12879 (setq org-block-entry-blocking (match-string 0))
12880 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12881 ;; Search further up the hierarchy, to see if an ancestor is blocked
12882 (while t
12883 (goto-char parent-pos)
12884 (unless (looking-at org-not-done-heading-regexp)
12885 (throw 'dont-block t)) ; do not block, parent is not a TODO
12886 (setq pos (point))
12887 (setq parent-pos (and (org-up-heading-safe) (point)))
12888 (unless parent-pos (throw 'dont-block t)) ; no parent
12889 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12890 (forward-line 1)
12891 (re-search-forward org-not-done-heading-regexp pos t)
12892 (setq org-block-entry-blocking (org-get-heading)))
12893 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12895 (defcustom org-track-ordered-property-with-tag nil
12896 "Should the ORDERED property also be shown as a tag?
12897 The ORDERED property decides if an entry should require subtasks to be
12898 completed in sequence. Since a property is not very visible, setting
12899 this option means that toggling the ORDERED property with the command
12900 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12901 not relevant for the behavior, but it makes things more visible.
12903 Note that toggling the tag with tags commands will not change the property
12904 and therefore not influence behavior!
12906 This can be t, meaning the tag ORDERED should be used, It can also be a
12907 string to select a different tag for this task."
12908 :group 'org-todo
12909 :type '(choice
12910 (const :tag "No tracking" nil)
12911 (const :tag "Track with ORDERED tag" t)
12912 (string :tag "Use other tag")))
12914 (defun org-toggle-ordered-property ()
12915 "Toggle the ORDERED property of the current entry.
12916 For better visibility, you can track the value of this property with a tag.
12917 See variable `org-track-ordered-property-with-tag'."
12918 (interactive)
12919 (let* ((t1 org-track-ordered-property-with-tag)
12920 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12921 (save-excursion
12922 (org-back-to-heading)
12923 (if (org-entry-get nil "ORDERED")
12924 (progn
12925 (org-delete-property "ORDERED")
12926 (and tag (org-toggle-tag tag 'off))
12927 (message "Subtasks can be completed in arbitrary order"))
12928 (org-entry-put nil "ORDERED" "t")
12929 (and tag (org-toggle-tag tag 'on))
12930 (message "Subtasks must be completed in sequence")))))
12932 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12933 (defun org-block-todo-from-checkboxes (change-plist)
12934 "Block turning an entry into a TODO, using checkboxes.
12935 This checks whether the current task should be blocked from state
12936 changes because there are unchecked boxes in this entry."
12937 (if (not org-enforce-todo-checkbox-dependencies)
12938 t ; if locally turned off don't block
12939 (catch 'dont-block
12940 ;; If this is not a todo state change, or if this entry is already DONE,
12941 ;; do not block
12942 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12943 (member (plist-get change-plist :from)
12944 (cons 'done org-done-keywords))
12945 (member (plist-get change-plist :to)
12946 (cons 'todo org-not-done-keywords))
12947 (not (plist-get change-plist :to)))
12948 (throw 'dont-block t))
12949 ;; If this task has checkboxes that are not checked, it's blocked
12950 (save-excursion
12951 (org-back-to-heading t)
12952 (let ((beg (point)) end)
12953 (outline-next-heading)
12954 (setq end (point))
12955 (goto-char beg)
12956 (when (org-list-search-forward
12957 (concat (org-item-beginning-re)
12958 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12959 "\\[[- ]\\]")
12960 end t)
12961 (when (boundp 'org-blocked-by-checkboxes)
12962 (setq org-blocked-by-checkboxes t))
12963 (throw 'dont-block nil))))
12964 t))) ; do not block
12966 (defun org-entry-blocked-p ()
12967 "Non-nil if entry at point is blocked."
12968 (and (not (org-entry-get nil "NOBLOCKING"))
12969 (member (org-entry-get nil "TODO") org-not-done-keywords)
12970 (not (run-hook-with-args-until-failure
12971 'org-blocker-hook
12972 (list :type 'todo-state-change
12973 :position (point)
12974 :from 'todo
12975 :to 'done)))))
12977 (defun org-update-statistics-cookies (all)
12978 "Update the statistics cookie, either from TODO or from checkboxes.
12979 This should be called with the cursor in a line with a statistics
12980 cookie. When called with a \\[universal-argument] prefix, update
12981 all statistics cookies in the buffer."
12982 (interactive "P")
12983 (if all
12984 (progn
12985 (org-update-checkbox-count 'all)
12986 (org-map-entries 'org-update-parent-todo-statistics))
12987 (if (not (org-at-heading-p))
12988 (org-update-checkbox-count)
12989 (let ((pos (point-marker))
12990 end l1 l2)
12991 (ignore-errors (org-back-to-heading t))
12992 (if (not (org-at-heading-p))
12993 (org-update-checkbox-count)
12994 (setq l1 (org-outline-level))
12995 (setq end (save-excursion
12996 (outline-next-heading)
12997 (when (org-at-heading-p) (setq l2 (org-outline-level)))
12998 (point)))
12999 (if (and (save-excursion
13000 (re-search-forward
13001 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
13002 (not (save-excursion (re-search-forward
13003 ":COOKIE_DATA:.*\\<todo\\>" end t))))
13004 (org-update-checkbox-count)
13005 (if (and l2 (> l2 l1))
13006 (progn
13007 (goto-char end)
13008 (org-update-parent-todo-statistics))
13009 (goto-char pos)
13010 (beginning-of-line 1)
13011 (while (re-search-forward
13012 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
13013 (point-at-eol) t)
13014 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
13015 (goto-char pos)
13016 (move-marker pos nil)))))
13018 (defvar org-entry-property-inherited-from) ;; defined below
13019 (defun org-update-parent-todo-statistics ()
13020 "Update any statistics cookie in the parent of the current headline.
13021 When `org-hierarchical-todo-statistics' is nil, statistics will cover
13022 the entire subtree and this will travel up the hierarchy and update
13023 statistics everywhere."
13024 (let* ((prop (save-excursion (org-up-heading-safe)
13025 (org-entry-get nil "COOKIE_DATA" 'inherit)))
13026 (recursive (or (not org-hierarchical-todo-statistics)
13027 (and prop (string-match "\\<recursive\\>" prop))))
13028 (lim (or (and prop (marker-position org-entry-property-inherited-from))
13030 (first t)
13031 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
13032 level ltoggle l1 new ndel
13033 (cnt-all 0) (cnt-done 0) is-percent kwd
13034 checkbox-beg cookie-present)
13035 (catch 'exit
13036 (save-excursion
13037 (beginning-of-line 1)
13038 (setq ltoggle (funcall outline-level))
13039 ;; Three situations are to consider:
13041 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
13042 ;; to the top-level ancestor on the headline;
13044 ;; 2. If parent has "recursive" property, repeat up to the
13045 ;; headline setting that property, taking inheritance into
13046 ;; account;
13048 ;; 3. Else, move up to direct parent and proceed only once.
13049 (while (and (setq level (org-up-heading-safe))
13050 (or recursive first)
13051 (>= (point) lim))
13052 (setq first nil cookie-present nil)
13053 (unless (and level
13054 (not (string-match
13055 "\\<checkbox\\>"
13056 (downcase (or (org-entry-get nil "COOKIE_DATA")
13057 "")))))
13058 (throw 'exit nil))
13059 (while (re-search-forward box-re (point-at-eol) t)
13060 (setq cnt-all 0 cnt-done 0 cookie-present t)
13061 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
13062 (save-match-data
13063 (unless (outline-next-heading) (throw 'exit nil))
13064 (while (and (looking-at org-complex-heading-regexp)
13065 (> (setq l1 (length (match-string 1))) level))
13066 (setq kwd (and (or recursive (= l1 ltoggle))
13067 (match-string 2)))
13068 (if (or (eq org-provide-todo-statistics 'all-headlines)
13069 (and (eq org-provide-todo-statistics t)
13070 (or (member kwd org-done-keywords)))
13071 (and (listp org-provide-todo-statistics)
13072 (stringp (car org-provide-todo-statistics))
13073 (or (member kwd org-provide-todo-statistics)
13074 (member kwd org-done-keywords)))
13075 (and (listp org-provide-todo-statistics)
13076 (listp (car org-provide-todo-statistics))
13077 (or (member kwd (car org-provide-todo-statistics))
13078 (and (member kwd org-done-keywords)
13079 (member kwd (cadr org-provide-todo-statistics))))))
13080 (setq cnt-all (1+ cnt-all))
13081 (and (eq org-provide-todo-statistics t)
13083 (setq cnt-all (1+ cnt-all))))
13084 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
13085 (member kwd org-done-keywords))
13086 (and (listp org-provide-todo-statistics)
13087 (listp (car org-provide-todo-statistics))
13088 (member kwd org-done-keywords)
13089 (member kwd (cadr org-provide-todo-statistics)))
13090 (and (listp org-provide-todo-statistics)
13091 (stringp (car org-provide-todo-statistics))
13092 (member kwd org-done-keywords)))
13093 (setq cnt-done (1+ cnt-done)))
13094 (outline-next-heading)))
13095 (setq new
13096 (if is-percent
13097 (format "[%d%%]" (floor (* 100.0 cnt-done)
13098 (max 1 cnt-all)))
13099 (format "[%d/%d]" cnt-done cnt-all))
13100 ndel (- (match-end 0) checkbox-beg))
13101 (goto-char checkbox-beg)
13102 (insert new)
13103 (delete-region (point) (+ (point) ndel))
13104 (when org-auto-align-tags (org-fix-tags-on-the-fly)))
13105 (when cookie-present
13106 (run-hook-with-args 'org-after-todo-statistics-hook
13107 cnt-done (- cnt-all cnt-done))))))
13108 (run-hooks 'org-todo-statistics-hook)))
13110 (defvar org-after-todo-statistics-hook nil
13111 "Hook that is called after a TODO statistics cookie has been updated.
13112 Each function is called with two arguments: the number of not-done entries
13113 and the number of done entries.
13115 For example, the following function, when added to this hook, will switch
13116 an entry to DONE when all children are done, and back to TODO when new
13117 entries are set to a TODO status. Note that this hook is only called
13118 when there is a statistics cookie in the headline!
13120 (defun org-summary-todo (n-done n-not-done)
13121 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13122 (let (org-log-done org-log-states) ; turn off logging
13123 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13126 (defvar org-todo-statistics-hook nil
13127 "Hook that is run whenever Org thinks TODO statistics should be updated.
13128 This hook runs even if there is no statistics cookie present, in which case
13129 `org-after-todo-statistics-hook' would not run.")
13131 (defun org-todo-trigger-tag-changes (state)
13132 "Apply the changes defined in `org-todo-state-tags-triggers'."
13133 (let ((l org-todo-state-tags-triggers)
13134 changes)
13135 (when (or (not state) (equal state ""))
13136 (setq changes (append changes (cdr (assoc "" l)))))
13137 (when (and (stringp state) (> (length state) 0))
13138 (setq changes (append changes (cdr (assoc state l)))))
13139 (when (member state org-not-done-keywords)
13140 (setq changes (append changes (cdr (assq 'todo l)))))
13141 (when (member state org-done-keywords)
13142 (setq changes (append changes (cdr (assq 'done l)))))
13143 (dolist (c changes)
13144 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13146 (defun org-local-logging (value)
13147 "Get logging settings from a property VALUE."
13148 ;; Directly set the variables, they are already local.
13149 (setq org-log-done nil
13150 org-log-repeat nil
13151 org-todo-log-states nil)
13152 (dolist (w (org-split-string value))
13153 (let (a)
13154 (cond
13155 ((setq a (assoc w org-startup-options))
13156 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13157 (set (nth 1 a) (nth 2 a))))
13158 ((setq a (org-extract-log-state-settings w))
13159 (and (member (car a) org-todo-keywords-1)
13160 (push a org-todo-log-states)))))))
13162 (defun org-get-todo-sequence-head (kwd)
13163 "Return the head of the TODO sequence to which KWD belongs.
13164 If KWD is not set, check if there is a text property remembering the
13165 right sequence."
13166 (let (p)
13167 (cond
13168 ((not kwd)
13169 (or (get-text-property (point-at-bol) 'org-todo-head)
13170 (progn
13171 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13172 nil (point-at-eol)))
13173 (get-text-property p 'org-todo-head))))
13174 ((not (member kwd org-todo-keywords-1))
13175 (car org-todo-keywords-1))
13176 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13178 (defun org-fast-todo-selection ()
13179 "Fast TODO keyword selection with single keys.
13180 Returns the new TODO keyword, or nil if no state change should occur."
13181 (let* ((fulltable org-todo-key-alist)
13182 (done-keywords org-done-keywords) ;; needed for the faces.
13183 (maxlen (apply 'max (mapcar
13184 (lambda (x)
13185 (if (stringp (car x)) (string-width (car x)) 0))
13186 fulltable)))
13187 (expert nil)
13188 (fwidth (+ maxlen 3 1 3))
13189 (ncol (/ (- (window-width) 4) fwidth))
13190 tg cnt e c tbl
13191 groups ingroup)
13192 (save-excursion
13193 (save-window-excursion
13194 (if expert
13195 (set-buffer (get-buffer-create " *Org todo*"))
13196 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13197 (erase-buffer)
13198 (setq-local org-done-keywords done-keywords)
13199 (setq tbl fulltable cnt 0)
13200 (while (setq e (pop tbl))
13201 (cond
13202 ((equal e '(:startgroup))
13203 (push '() groups) (setq ingroup t)
13204 (unless (= cnt 0)
13205 (setq cnt 0)
13206 (insert "\n"))
13207 (insert "{ "))
13208 ((equal e '(:endgroup))
13209 (setq ingroup nil cnt 0)
13210 (insert "}\n"))
13211 ((equal e '(:newline))
13212 (unless (= cnt 0)
13213 (setq cnt 0)
13214 (insert "\n")
13215 (setq e (car tbl))
13216 (while (equal (car tbl) '(:newline))
13217 (insert "\n")
13218 (setq tbl (cdr tbl)))))
13220 (setq tg (car e) c (cdr e))
13221 (when ingroup (push tg (car groups)))
13222 (setq tg (org-add-props tg nil 'face
13223 (org-get-todo-face tg)))
13224 (when (and (= cnt 0) (not ingroup)) (insert " "))
13225 (insert "[" c "] " tg (make-string
13226 (- fwidth 4 (length tg)) ?\ ))
13227 (when (= (setq cnt (1+ cnt)) ncol)
13228 (insert "\n")
13229 (when ingroup (insert " "))
13230 (setq cnt 0)))))
13231 (insert "\n")
13232 (goto-char (point-min))
13233 (unless expert (org-fit-window-to-buffer))
13234 (message "[a-z..]:Set [SPC]:clear")
13235 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13236 (cond
13237 ((or (= c ?\C-g)
13238 (and (= c ?q) (not (rassoc c fulltable))))
13239 (setq quit-flag t))
13240 ((= c ?\ ) nil)
13241 ((setq e (rassoc c fulltable) tg (car e))
13243 (t (setq quit-flag t)))))))
13245 (defun org-entry-is-todo-p ()
13246 (member (org-get-todo-state) org-not-done-keywords))
13248 (defun org-entry-is-done-p ()
13249 (member (org-get-todo-state) org-done-keywords))
13251 (defun org-get-todo-state ()
13252 "Return the TODO keyword of the current subtree."
13253 (save-excursion
13254 (org-back-to-heading t)
13255 (and (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
13256 (match-end 2)
13257 (match-string 2))))
13259 (defun org-at-date-range-p (&optional inactive-ok)
13260 "Non-nil if point is inside a date range.
13262 When optional argument INACTIVE-OK is non-nil, also consider
13263 inactive time ranges.
13265 When this function returns a non-nil value, match data is set
13266 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13267 on INACTIVE-OK."
13268 (interactive)
13269 (save-excursion
13270 (catch 'exit
13271 (let ((pos (point)))
13272 (skip-chars-backward "^[<\r\n")
13273 (skip-chars-backward "<[")
13274 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13275 (>= (match-end 0) pos)
13276 (throw 'exit t))
13277 (skip-chars-backward "^<[\r\n")
13278 (skip-chars-backward "<[")
13279 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13280 (>= (match-end 0) pos)
13281 (throw 'exit t)))
13282 nil)))
13284 (defun org-get-repeat (&optional tagline)
13285 "Check if there is a deadline/schedule with repeater in this entry."
13286 (save-match-data
13287 (save-excursion
13288 (org-back-to-heading t)
13289 (and (re-search-forward (if tagline
13290 (concat tagline "\\s-*" org-repeat-re)
13291 org-repeat-re)
13292 (org-entry-end-position) t)
13293 (match-string-no-properties 1)))))
13295 (defvar org-last-changed-timestamp)
13296 (defvar org-last-inserted-timestamp)
13297 (defvar org-log-post-message)
13298 (defvar org-log-note-purpose)
13299 (defvar org-log-note-how nil)
13300 (defvar org-log-note-extra)
13301 (defun org-auto-repeat-maybe (done-word)
13302 "Check if the current headline contains a repeated time-stamp.
13304 If yes, set TODO state back to what it was and change the base date
13305 of repeating deadline/scheduled time stamps to new date.
13307 This function is run automatically after each state change to a DONE state."
13308 (let* ((repeat (org-get-repeat))
13309 (aa (assoc org-last-state org-todo-kwd-alist))
13310 (interpret (nth 1 aa))
13311 (head (nth 2 aa))
13312 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13313 (msg "Entry repeats: ")
13314 (org-log-done nil)
13315 (org-todo-log-states nil))
13316 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13317 (when (eq org-log-repeat t) (setq org-log-repeat 'state))
13318 (let ((to-state (or (org-entry-get nil "REPEAT_TO_STATE" 'selective)
13319 org-todo-repeat-to-state)))
13320 (unless (and to-state (member to-state org-todo-keywords-1))
13321 (setq to-state (if (eq interpret 'type) org-last-state head)))
13322 (org-todo to-state))
13323 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13324 (org-entry-put nil "LAST_REPEAT" (format-time-string
13325 (org-time-stamp-format t t))))
13326 (when org-log-repeat
13327 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13328 (memq 'org-add-log-note post-command-hook))
13329 ;; We are already setup for some record.
13330 (when (eq org-log-repeat 'note)
13331 ;; Make sure we take a note, not only a time stamp.
13332 (setq org-log-note-how 'note))
13333 ;; Set up for taking a record.
13334 (org-add-log-setup 'state
13335 (or done-word (car org-done-keywords))
13336 org-last-state
13337 org-log-repeat)))
13338 (org-back-to-heading t)
13339 (org-add-planning-info nil nil 'closed)
13340 (let ((end (save-excursion (outline-next-heading) (point)))
13341 (planning-re (regexp-opt
13342 (list org-scheduled-string org-deadline-string))))
13343 (while (re-search-forward org-ts-regexp end t)
13344 (let* ((ts (match-string 0))
13345 (planning? (org-at-planning-p))
13346 (type (if (not planning?) "Plain:"
13347 (save-excursion
13348 (re-search-backward
13349 planning-re (line-beginning-position) t)
13350 (match-string 0)))))
13351 (cond
13352 ;; Ignore fake time-stamps (e.g., within comments).
13353 ((and (not planning?)
13354 (not (org-at-property-p))
13355 (not (eq 'timestamp
13356 (org-element-type (save-excursion
13357 (backward-char)
13358 (org-element-context)))))))
13359 ;; Time-stamps without a repeater are usually skipped.
13360 ;; However, a SCHEDULED time-stamp without one is
13361 ;; removed, as it is considered as no longer relevant.
13362 ((not (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))
13363 (when (equal type org-scheduled-string)
13364 (org-remove-timestamp-with-keyword type)))
13366 (let ((n (string-to-number (match-string 2 ts)))
13367 (what (match-string 3 ts)))
13368 (when (equal what "w") (setq n (* n 7) what "d"))
13369 (when (and (equal what "h")
13370 (not (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}"
13371 ts)))
13372 (user-error
13373 "Cannot repeat in Repeat in %d hour(s) because no hour \
13374 has been set"
13376 ;; Preparation, see if we need to modify the start
13377 ;; date for the change.
13378 (when (match-end 1)
13379 (let ((time (save-match-data (org-time-string-to-time ts))))
13380 (cond
13381 ((equal (match-string 1 ts) ".")
13382 ;; Shift starting date to today
13383 (org-timestamp-change
13384 (- (org-today) (time-to-days time))
13385 'day))
13386 ((equal (match-string 1 ts) "+")
13387 (let ((nshiftmax 10)
13388 (nshift 0))
13389 (while (or (= nshift 0)
13390 (not (time-less-p (current-time) time)))
13391 (when (= (cl-incf nshift) nshiftmax)
13392 (or (y-or-n-p
13393 (format "%d repeater intervals were not \
13394 enough to shift date past today. Continue? "
13395 nshift))
13396 (user-error "Abort")))
13397 (org-timestamp-change n (cdr (assoc what whata)))
13398 (org-at-timestamp-p t)
13399 (setq ts (match-string 1))
13400 (setq time
13401 (save-match-data
13402 (org-time-string-to-time ts)))))
13403 (org-timestamp-change (- n) (cdr (assoc what whata)))
13404 ;; Rematch, so that we have everything in place
13405 ;; for the real shift.
13406 (org-at-timestamp-p t)
13407 (setq ts (match-string 1))
13408 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)"
13409 ts)))))
13410 (save-excursion
13411 (org-timestamp-change n (cdr (assoc what whata)) nil t))
13412 (setq msg
13413 (concat
13414 msg type " " org-last-changed-timestamp " "))))))))
13415 (setq org-log-post-message msg)
13416 (message "%s" msg))))
13418 (defun org-show-todo-tree (arg)
13419 "Make a compact tree which shows all headlines marked with TODO.
13420 The tree will show the lines where the regexp matches, and all higher
13421 headlines above the match.
13422 With a `\\[universal-argument]' prefix, prompt for a regexp to match.
13423 With a numeric prefix N, construct a sparse tree for the Nth element
13424 of `org-todo-keywords-1'."
13425 (interactive "P")
13426 (let ((case-fold-search nil)
13427 (kwd-re
13428 (cond ((null arg) org-not-done-regexp)
13429 ((equal arg '(4))
13430 (let ((kwd
13431 (completing-read "Keyword (or KWD1|KWD2|...): "
13432 (mapcar #'list org-todo-keywords-1))))
13433 (concat "\\("
13434 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13435 "\\)\\>")))
13436 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13437 (regexp-quote (nth (1- (prefix-numeric-value arg))
13438 org-todo-keywords-1)))
13439 (t (user-error "Invalid prefix argument: %s" arg)))))
13440 (message "%d TODO entries found"
13441 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13443 (defun org--deadline-or-schedule (arg type time)
13444 "Insert DEADLINE or SCHEDULE information in current entry.
13445 TYPE is either `deadline' or `scheduled'. See `org-deadline' or
13446 `org-schedule' for information about ARG and TIME arguments."
13447 (let* ((deadline? (eq type 'deadline))
13448 (keyword (if deadline? org-deadline-string org-scheduled-string))
13449 (log (if deadline? org-log-redeadline org-log-reschedule))
13450 (old-date (org-entry-get nil (if deadline? "DEADLINE" "SCHEDULED")))
13451 (old-date-time (and old-date (org-time-string-to-time old-date)))
13452 ;; Save repeater cookie from either TIME or current scheduled
13453 ;; time stamp. We are going to insert it back at the end of
13454 ;; the process.
13455 (repeater (or (and (org-string-nw-p time)
13456 ;; We use `org-repeat-re' because we need
13457 ;; to tell the difference between a real
13458 ;; repeater and a time delta, e.g. "+2d".
13459 (string-match org-repeat-re time)
13460 (match-string 1 time))
13461 (and (org-string-nw-p old-date)
13462 (string-match "\\([.+-]+[0-9]+ [hdwmy]\
13463 \\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\)"
13464 old-date)
13465 (match-string 1 old-date)))))
13466 (pcase arg
13467 (`(4)
13468 (when (and old-date log)
13469 (org-add-log-setup (if deadline? 'deldeadline 'delschedule)
13470 nil old-date log))
13471 (org-remove-timestamp-with-keyword keyword)
13472 (message (if deadline? "Item no longer has a deadline."
13473 "Item is no longer scheduled.")))
13474 (`(16)
13475 (save-excursion
13476 (org-back-to-heading t)
13477 (let ((regexp (if deadline? org-deadline-time-regexp
13478 org-scheduled-time-regexp)))
13479 (if (not (re-search-forward regexp (line-end-position 2) t))
13480 (user-error (if deadline? "No deadline information to update"
13481 "No scheduled information to update"))
13482 (let* ((rpl0 (match-string 1))
13483 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0))
13484 (msg (if deadline? "Warn starting from" "Delay until")))
13485 (replace-match
13486 (concat keyword
13487 " <" rpl
13488 (format " -%dd"
13489 (abs (- (time-to-days
13490 (save-match-data
13491 (org-read-date
13492 nil t nil msg old-date-time)))
13493 (time-to-days old-date-time))))
13494 ">") t t))))))
13496 (org-add-planning-info type time 'closed)
13497 (when (and old-date
13499 (not (equal old-date org-last-inserted-timestamp)))
13500 (org-add-log-setup (if deadline? 'redeadline 'reschedule)
13501 org-last-inserted-timestamp
13502 old-date
13503 log))
13504 (when repeater
13505 (save-excursion
13506 (org-back-to-heading t)
13507 (when (re-search-forward
13508 (concat keyword " " org-last-inserted-timestamp)
13509 (line-end-position 2)
13511 (goto-char (1- (match-end 0)))
13512 (insert " " repeater)
13513 (setq org-last-inserted-timestamp
13514 (concat (substring org-last-inserted-timestamp 0 -1)
13515 " " repeater
13516 (substring org-last-inserted-timestamp -1))))))
13517 (message (if deadline? "Deadline on %s" "Scheduled to %s")
13518 org-last-inserted-timestamp)))))
13520 (defun org-deadline (arg &optional time)
13521 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13522 With one universal prefix argument, remove any deadline from the item.
13523 With two universal prefix arguments, prompt for a warning delay.
13524 With argument TIME, set the deadline at the corresponding date. TIME
13525 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13526 (interactive "P")
13527 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13528 (org-map-entries
13529 (lambda () (org--deadline-or-schedule arg 'deadline time))
13531 (if (eq org-loop-over-headlines-in-active-region 'start-level)
13532 'region-start-level
13533 'region)
13534 (lambda () (when (outline-invisible-p) (org-end-of-subtree nil t))))
13535 (org--deadline-or-schedule arg 'deadline time)))
13537 (defun org-schedule (arg &optional time)
13538 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13539 With one universal prefix argument, remove any scheduling date from the item.
13540 With two universal prefix arguments, prompt for a delay cookie.
13541 With argument TIME, scheduled at the corresponding date. TIME can
13542 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13543 (interactive "P")
13544 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13545 (org-map-entries
13546 (lambda () (org--deadline-or-schedule arg 'scheduled time))
13548 (if (eq org-loop-over-headlines-in-active-region 'start-level)
13549 'region-start-level
13550 'region)
13551 (lambda () (when (outline-invisible-p) (org-end-of-subtree nil t))))
13552 (org--deadline-or-schedule arg 'scheduled time)))
13554 (defun org-get-scheduled-time (pom &optional inherit)
13555 "Get the scheduled time as a time tuple, of a format suitable
13556 for calling org-schedule with, or if there is no scheduling,
13557 returns nil."
13558 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13559 (when time
13560 (apply 'encode-time (org-parse-time-string time)))))
13562 (defun org-get-deadline-time (pom &optional inherit)
13563 "Get the deadline as a time tuple, of a format suitable for
13564 calling org-deadline with, or if there is no scheduling, returns
13565 nil."
13566 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13567 (when time
13568 (apply 'encode-time (org-parse-time-string time)))))
13570 (defun org-remove-timestamp-with-keyword (keyword)
13571 "Remove all time stamps with KEYWORD in the current entry."
13572 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13573 beg)
13574 (save-excursion
13575 (org-back-to-heading t)
13576 (setq beg (point))
13577 (outline-next-heading)
13578 (while (re-search-backward re beg t)
13579 (replace-match "")
13580 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13581 (equal (char-before) ?\ ))
13582 (backward-delete-char 1)
13583 (when (string-match "^[ \t]*$" (buffer-substring
13584 (point-at-bol) (point-at-eol)))
13585 (delete-region (point-at-bol)
13586 (min (point-max) (1+ (point-at-eol))))))))))
13588 (defvar org-time-was-given) ; dynamically scoped parameter
13589 (defvar org-end-time-was-given) ; dynamically scoped parameter
13591 (defun org-at-planning-p ()
13592 "Non-nil when point is on a planning info line."
13593 ;; This is as accurate and faster than `org-element-at-point' since
13594 ;; planning info location is fixed in the section.
13595 (org-with-wide-buffer
13596 (beginning-of-line)
13597 (and (looking-at-p org-planning-line-re)
13598 (eq (point)
13599 (ignore-errors
13600 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13601 (org-back-to-heading t)
13602 (org-with-limited-levels (org-back-to-heading t)))
13603 (line-beginning-position 2))))))
13605 (defun org-add-planning-info (what &optional time &rest remove)
13606 "Insert new timestamp with keyword in the planning line.
13607 WHAT indicates what kind of time stamp to add. It is a symbol
13608 among `closed', `deadline', `scheduled' and nil. TIME indicates
13609 the time to use. If none is given, the user is prompted for
13610 a date. REMOVE indicates what kind of entries to remove. An old
13611 WHAT entry will also be removed."
13612 (let (org-time-was-given org-end-time-was-given default-time default-input)
13613 (catch 'exit
13614 (when (and (memq what '(scheduled deadline))
13615 (or (not time)
13616 (and (stringp time)
13617 (string-match "^[-+]+[0-9]" time))))
13618 ;; Try to get a default date/time from existing timestamp
13619 (save-excursion
13620 (org-back-to-heading t)
13621 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13622 (when (re-search-forward (if (eq what 'scheduled)
13623 org-scheduled-time-regexp
13624 org-deadline-time-regexp)
13625 end t)
13626 (setq ts (match-string 1)
13627 default-time (apply 'encode-time (org-parse-time-string ts))
13628 default-input (and ts (org-get-compact-tod ts)))))))
13629 (when what
13630 (setq time
13631 (if (stringp time)
13632 ;; This is a string (relative or absolute), set
13633 ;; proper date.
13634 (apply #'encode-time
13635 (org-read-date-analyze
13636 time default-time (decode-time default-time)))
13637 ;; If necessary, get the time from the user
13638 (or time (org-read-date nil 'to-time nil nil
13639 default-time default-input)))))
13641 (org-with-wide-buffer
13642 (org-back-to-heading t)
13643 (forward-line)
13644 (unless (bolp) (insert "\n"))
13645 (cond ((looking-at-p org-planning-line-re)
13646 ;; Move to current indentation.
13647 (skip-chars-forward " \t")
13648 ;; Check if we have to remove something.
13649 (dolist (type (if what (cons what remove) remove))
13650 (save-excursion
13651 (when (re-search-forward
13652 (cl-case type
13653 (closed org-closed-time-regexp)
13654 (deadline org-deadline-time-regexp)
13655 (scheduled org-scheduled-time-regexp)
13656 (otherwise
13657 (error "Invalid planning type: %s" type)))
13658 (line-end-position) t)
13659 ;; Delete until next keyword or end of line.
13660 (delete-region
13661 (match-beginning 0)
13662 (if (re-search-forward org-keyword-time-not-clock-regexp
13663 (line-end-position)
13665 (match-beginning 0)
13666 (line-end-position))))))
13667 ;; If there is nothing more to add and no more keyword
13668 ;; is left, remove the line completely.
13669 (if (and (looking-at-p "[ \t]*$") (not what))
13670 (delete-region (line-beginning-position)
13671 (line-beginning-position 2))
13672 ;; If we removed last keyword, do not leave trailing
13673 ;; white space at the end of line.
13674 (let ((p (point)))
13675 (save-excursion
13676 (end-of-line)
13677 (unless (= (skip-chars-backward " \t" p) 0)
13678 (delete-region (point) (line-end-position)))))))
13679 ((not what) (throw 'exit nil)) ; Nothing to do.
13680 (t (insert-before-markers "\n")
13681 (backward-char 1)
13682 (when org-adapt-indentation
13683 (indent-to-column (1+ (org-outline-level))))))
13684 (when what
13685 ;; Insert planning keyword.
13686 (insert (cl-case what
13687 (closed org-closed-string)
13688 (deadline org-deadline-string)
13689 (scheduled org-scheduled-string)
13690 (otherwise (error "Invalid planning type: %s" what)))
13691 " ")
13692 ;; Insert associated timestamp.
13693 (let ((ts (org-insert-time-stamp
13694 time
13695 (or org-time-was-given
13696 (and (eq what 'closed) org-log-done-with-time))
13697 (eq what 'closed)
13698 nil nil (list org-end-time-was-given))))
13699 (unless (eolp) (insert " "))
13700 ts))))))
13702 (defvar org-log-note-marker (make-marker)
13703 "Marker pointing at the entry where the note is to be inserted.")
13704 (defvar org-log-note-purpose nil)
13705 (defvar org-log-note-state nil)
13706 (defvar org-log-note-previous-state nil)
13707 (defvar org-log-note-extra nil)
13708 (defvar org-log-note-window-configuration nil)
13709 (defvar org-log-note-return-to (make-marker))
13710 (defvar org-log-note-effective-time nil
13711 "Remembered current time so that dynamically scoped
13712 `org-extend-today-until' affects timestamps in state change log")
13714 (defvar org-log-post-message nil
13715 "Message to be displayed after a log note has been stored.
13716 The auto-repeater uses this.")
13718 (defun org-add-note ()
13719 "Add a note to the current entry.
13720 This is done in the same way as adding a state change note."
13721 (interactive)
13722 (org-add-log-setup 'note))
13724 (defun org-log-beginning (&optional create)
13725 "Return expected start of log notes in current entry.
13726 When optional argument CREATE is non-nil, the function creates
13727 a drawer to store notes, if necessary. Returned position ignores
13728 narrowing."
13729 (org-with-wide-buffer
13730 (let ((drawer (org-log-into-drawer)))
13731 (cond
13732 (drawer
13733 (org-end-of-meta-data)
13734 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13735 (end (if (org-at-heading-p) (point)
13736 (save-excursion (outline-next-heading) (point))))
13737 (case-fold-search t))
13738 (catch 'exit
13739 ;; Try to find existing drawer.
13740 (while (re-search-forward regexp end t)
13741 (let ((element (org-element-at-point)))
13742 (when (eq (org-element-type element) 'drawer)
13743 (let ((cend (org-element-property :contents-end element)))
13744 (when (and (not org-log-states-order-reversed) cend)
13745 (goto-char cend)))
13746 (throw 'exit nil))))
13747 ;; No drawer found. Create one, if permitted.
13748 (when create
13749 (unless (bolp) (insert "\n"))
13750 (let ((beg (point)))
13751 (insert ":" drawer ":\n:END:\n")
13752 (org-indent-region beg (point)))
13753 (end-of-line -1)))))
13755 (org-end-of-meta-data org-log-state-notes-insert-after-drawers)
13756 (skip-chars-forward " \t\n")
13757 (beginning-of-line)
13758 (unless org-log-states-order-reversed
13759 (org-skip-over-state-notes)
13760 (skip-chars-backward " \t\n")
13761 (forward-line)))))
13762 (if (bolp) (point) (line-beginning-position 2))))
13764 (defun org-add-log-setup (&optional purpose state prev-state how extra)
13765 "Set up the post command hook to take a note.
13766 If this is about to TODO state change, the new state is expected in STATE.
13767 HOW is an indicator what kind of note should be created.
13768 EXTRA is additional text that will be inserted into the notes buffer."
13769 (move-marker org-log-note-marker (point))
13770 (setq org-log-note-purpose purpose
13771 org-log-note-state state
13772 org-log-note-previous-state prev-state
13773 org-log-note-how how
13774 org-log-note-extra extra
13775 org-log-note-effective-time (org-current-effective-time))
13776 (add-hook 'post-command-hook 'org-add-log-note 'append))
13778 (defun org-skip-over-state-notes ()
13779 "Skip past the list of State notes in an entry."
13780 (when (ignore-errors (goto-char (org-in-item-p)))
13781 (let* ((struct (org-list-struct))
13782 (prevs (org-list-prevs-alist struct))
13783 (regexp
13784 (concat "[ \t]*- +"
13785 (replace-regexp-in-string
13786 " +" " +"
13787 (org-replace-escapes
13788 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13789 `(("%d" . ,org-ts-regexp-inactive)
13790 ("%D" . ,org-ts-regexp)
13791 ("%s" . "\"\\S-+\"")
13792 ("%S" . "\"\\S-+\"")
13793 ("%t" . ,org-ts-regexp-inactive)
13794 ("%T" . ,org-ts-regexp)
13795 ("%u" . ".*?")
13796 ("%U" . ".*?")))))))
13797 (while (looking-at-p regexp)
13798 (goto-char (or (org-list-get-next-item (point) struct prevs)
13799 (org-list-get-item-end (point) struct)))))))
13801 (defun org-add-log-note (&optional _purpose)
13802 "Pop up a window for taking a note, and add this note later."
13803 (remove-hook 'post-command-hook 'org-add-log-note)
13804 (setq org-log-note-window-configuration (current-window-configuration))
13805 (delete-other-windows)
13806 (move-marker org-log-note-return-to (point))
13807 (pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13808 (goto-char org-log-note-marker)
13809 (org-switch-to-buffer-other-window "*Org Note*")
13810 (erase-buffer)
13811 (if (memq org-log-note-how '(time state))
13812 (let (current-prefix-arg) (org-store-log-note))
13813 (let ((org-inhibit-startup t)) (org-mode))
13814 (insert (format "# Insert note for %s.
13815 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13816 (cond
13817 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13818 ((eq org-log-note-purpose 'done) "closed todo item")
13819 ((eq org-log-note-purpose 'state)
13820 (format "state change from \"%s\" to \"%s\""
13821 (or org-log-note-previous-state "")
13822 (or org-log-note-state "")))
13823 ((eq org-log-note-purpose 'reschedule)
13824 "rescheduling")
13825 ((eq org-log-note-purpose 'delschedule)
13826 "no longer scheduled")
13827 ((eq org-log-note-purpose 'redeadline)
13828 "changing deadline")
13829 ((eq org-log-note-purpose 'deldeadline)
13830 "removing deadline")
13831 ((eq org-log-note-purpose 'refile)
13832 "refiling")
13833 ((eq org-log-note-purpose 'note)
13834 "this entry")
13835 (t (error "This should not happen")))))
13836 (when org-log-note-extra (insert org-log-note-extra))
13837 (setq-local org-finish-function 'org-store-log-note)
13838 (run-hooks 'org-log-buffer-setup-hook)))
13840 (defvar org-note-abort nil) ; dynamically scoped
13841 (defun org-store-log-note ()
13842 "Finish taking a log note, and insert it to where it belongs."
13843 (let ((txt (prog1 (buffer-string)
13844 (kill-buffer)))
13845 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
13846 lines)
13847 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13848 (setq txt (replace-match "" t t txt)))
13849 (when (string-match "\\s-+\\'" txt)
13850 (setq txt (replace-match "" t t txt)))
13851 (setq lines (org-split-string txt "\n"))
13852 (when (org-string-nw-p note)
13853 (setq note
13854 (org-replace-escapes
13855 note
13856 (list (cons "%u" (user-login-name))
13857 (cons "%U" user-full-name)
13858 (cons "%t" (format-time-string
13859 (org-time-stamp-format 'long 'inactive)
13860 org-log-note-effective-time))
13861 (cons "%T" (format-time-string
13862 (org-time-stamp-format 'long nil)
13863 org-log-note-effective-time))
13864 (cons "%d" (format-time-string
13865 (org-time-stamp-format nil 'inactive)
13866 org-log-note-effective-time))
13867 (cons "%D" (format-time-string
13868 (org-time-stamp-format nil nil)
13869 org-log-note-effective-time))
13870 (cons "%s" (cond
13871 ((not org-log-note-state) "")
13872 ((string-match-p org-ts-regexp
13873 org-log-note-state)
13874 (format "\"[%s]\""
13875 (substring org-log-note-state 1 -1)))
13876 (t (format "\"%s\"" org-log-note-state))))
13877 (cons "%S"
13878 (cond
13879 ((not org-log-note-previous-state) "")
13880 ((string-match-p org-ts-regexp
13881 org-log-note-previous-state)
13882 (format "\"[%s]\""
13883 (substring
13884 org-log-note-previous-state 1 -1)))
13885 (t (format "\"%s\""
13886 org-log-note-previous-state)))))))
13887 (when lines (setq note (concat note " \\\\")))
13888 (push note lines))
13889 (when (and lines (not (or current-prefix-arg org-note-abort)))
13890 (with-current-buffer (marker-buffer org-log-note-marker)
13891 (org-with-wide-buffer
13892 ;; Find location for the new note.
13893 (goto-char org-log-note-marker)
13894 (set-marker org-log-note-marker nil)
13895 (goto-char (org-log-beginning t))
13896 ;; Make sure point is at the beginning of an empty line.
13897 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13898 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13899 ;; In an existing list, add a new item at the top level.
13900 ;; Otherwise, indent line like a regular one.
13901 (let ((itemp (org-in-item-p)))
13902 (if itemp
13903 (indent-line-to
13904 (let ((struct (save-excursion
13905 (goto-char itemp) (org-list-struct))))
13906 (org-list-get-ind (org-list-get-top-point struct) struct)))
13907 (org-indent-line)))
13908 (insert (org-list-bullet-string "-") (pop lines))
13909 (let ((ind (org-list-item-body-column (line-beginning-position))))
13910 (dolist (line lines)
13911 (insert "\n")
13912 (indent-line-to ind)
13913 (insert line)))
13914 (message "Note stored")
13915 (org-back-to-heading t)
13916 (org-cycle-hide-drawers 'children))
13917 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13918 ;; from within `org-add-log-note' because `buffer-undo-list'
13919 ;; is then modified outside of `org-with-remote-undo'.
13920 (when (eq this-command 'org-agenda-todo)
13921 (setcdr buffer-undo-list (cddr buffer-undo-list))))))
13922 ;; Don't add undo information when called from `org-agenda-todo'.
13923 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13924 (set-window-configuration org-log-note-window-configuration)
13925 (with-current-buffer (marker-buffer org-log-note-return-to)
13926 (goto-char org-log-note-return-to))
13927 (move-marker org-log-note-return-to nil)
13928 (when org-log-post-message (message "%s" org-log-post-message))))
13930 (defun org-remove-empty-drawer-at (pos)
13931 "Remove an empty drawer at position POS.
13932 POS may also be a marker."
13933 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13934 (org-with-wide-buffer
13935 (goto-char pos)
13936 (let ((drawer (org-element-at-point)))
13937 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13938 (not (org-element-property :contents-begin drawer)))
13939 (delete-region (org-element-property :begin drawer)
13940 (progn (goto-char (org-element-property :end drawer))
13941 (skip-chars-backward " \r\t\n")
13942 (forward-line)
13943 (point))))))))
13945 (defvar org-ts-type nil)
13946 (defun org-sparse-tree (&optional arg type)
13947 "Create a sparse tree, prompt for the details.
13948 This command can create sparse trees. You first need to select the type
13949 of match used to create the tree:
13951 t Show all TODO entries.
13952 T Show entries with a specific TODO keyword.
13953 m Show entries selected by a tags/property match.
13954 p Enter a property name and its value (both with completion on existing
13955 names/values) and show entries with that property.
13956 r Show entries matching a regular expression (`/' can be used as well).
13957 b Show deadlines and scheduled items before a date.
13958 a Show deadlines and scheduled items after a date.
13959 d Show deadlines due within `org-deadline-warning-days'.
13960 D Show deadlines and scheduled items between a date range."
13961 (interactive "P")
13962 (setq type (or type org-sparse-tree-default-date-type))
13963 (setq org-ts-type type)
13964 (message "Sparse tree: [r]egexp [t]odo [T]odo-kwd [m]atch [p]roperty
13965 \[d]eadlines [b]efore-date [a]fter-date [D]ates range
13966 \[c]ycle through date types: %s"
13967 (cl-case type
13968 (all "all timestamps")
13969 (scheduled "only scheduled")
13970 (deadline "only deadline")
13971 (active "only active timestamps")
13972 (inactive "only inactive timestamps")
13973 (closed "with a closed time-stamp")
13974 (otherwise "scheduled/deadline")))
13975 (let ((answer (read-char-exclusive)))
13976 (cl-case answer
13978 (org-sparse-tree
13980 (cadr
13981 (memq type '(nil all scheduled deadline active inactive closed)))))
13982 (?d (call-interactively 'org-check-deadlines))
13983 (?b (call-interactively 'org-check-before-date))
13984 (?a (call-interactively 'org-check-after-date))
13985 (?D (call-interactively 'org-check-dates-range))
13986 (?t (call-interactively 'org-show-todo-tree))
13987 (?T (org-show-todo-tree '(4)))
13988 (?m (call-interactively 'org-match-sparse-tree))
13989 ((?p ?P)
13990 (let* ((kwd (completing-read
13991 "Property: " (mapcar #'list (org-buffer-property-keys))))
13992 (value (completing-read
13993 "Value: " (mapcar #'list (org-property-values kwd)))))
13994 (unless (string-match "\\`{.*}\\'" value)
13995 (setq value (concat "\"" value "\"")))
13996 (org-match-sparse-tree arg (concat kwd "=" value))))
13997 ((?r ?R ?/) (call-interactively 'org-occur))
13998 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
14000 (defvar-local org-occur-highlights nil
14001 "List of overlays used for occur matches.")
14002 (defvar-local org-occur-parameters nil
14003 "Parameters of the active org-occur calls.
14004 This is a list, each call to org-occur pushes as cons cell,
14005 containing the regular expression and the callback, onto the list.
14006 The list can contain several entries if `org-occur' has been called
14007 several time with the KEEP-PREVIOUS argument. Otherwise, this list
14008 will only contain one set of parameters. When the highlights are
14009 removed (for example with `C-c C-c', or with the next edit (depending
14010 on `org-remove-highlights-with-change'), this variable is emptied
14011 as well.")
14013 (defun org-occur (regexp &optional keep-previous callback)
14014 "Make a compact tree which shows all matches of REGEXP.
14016 The tree will show the lines where the regexp matches, and any other context
14017 defined in `org-show-context-detail', which see.
14019 When optional argument KEEP-PREVIOUS is non-nil, highlighting and exposing
14020 done by a previous call to `org-occur' will be kept, to allow stacking of
14021 calls to this command.
14023 Optional argument CALLBACK can be a function of no argument. In this case,
14024 it is called with point at the end of the match, match data being set
14025 accordingly. Current match is shown only if the return value is non-nil.
14026 The function must neither move point nor alter narrowing."
14027 (interactive "sRegexp: \nP")
14028 (when (equal regexp "")
14029 (user-error "Regexp cannot be empty"))
14030 (unless keep-previous
14031 (org-remove-occur-highlights nil nil t))
14032 (push (cons regexp callback) org-occur-parameters)
14033 (let ((cnt 0))
14034 (save-excursion
14035 (goto-char (point-min))
14036 (when (or (not keep-previous) ; do not want to keep
14037 (not org-occur-highlights)) ; no previous matches
14038 ;; hide everything
14039 (org-overview))
14040 (let ((case-fold-search (if (eq org-occur-case-fold-search 'smart)
14041 (isearch-no-upper-case-p regexp t)
14042 org-occur-case-fold-search)))
14043 (while (re-search-forward regexp nil t)
14044 (when (or (not callback)
14045 (save-match-data (funcall callback)))
14046 (setq cnt (1+ cnt))
14047 (when org-highlight-sparse-tree-matches
14048 (org-highlight-new-match (match-beginning 0) (match-end 0)))
14049 (org-show-context 'occur-tree)))))
14050 (when org-remove-highlights-with-change
14051 (add-hook 'before-change-functions 'org-remove-occur-highlights
14052 nil 'local))
14053 (unless org-sparse-tree-open-archived-trees
14054 (org-hide-archived-subtrees (point-min) (point-max)))
14055 (run-hooks 'org-occur-hook)
14056 (when (called-interactively-p 'interactive)
14057 (message "%d match(es) for regexp %s" cnt regexp))
14058 cnt))
14060 (defun org-occur-next-match (&optional n _reset)
14061 "Function for `next-error-function' to find sparse tree matches.
14062 N is the number of matches to move, when negative move backwards.
14063 This function always goes back to the starting point when no
14064 match is found."
14065 (let* ((limit (if (< n 0) (point-min) (point-max)))
14066 (search-func (if (< n 0)
14067 'previous-single-char-property-change
14068 'next-single-char-property-change))
14069 (n (abs n))
14070 (pos (point))
14072 (catch 'exit
14073 (while (setq p1 (funcall search-func (point) 'org-type))
14074 (when (equal p1 limit)
14075 (goto-char pos)
14076 (user-error "No more matches"))
14077 (when (equal (get-char-property p1 'org-type) 'org-occur)
14078 (setq n (1- n))
14079 (when (= n 0)
14080 (goto-char p1)
14081 (throw 'exit (point))))
14082 (goto-char p1))
14083 (goto-char p1)
14084 (user-error "No more matches"))))
14086 (defun org-show-context (&optional key)
14087 "Make sure point and context are visible.
14088 Optional argument KEY, when non-nil, is a symbol. See
14089 `org-show-context-detail' for allowed values and how much is to
14090 be shown."
14091 (org-show-set-visibility
14092 (cond ((symbolp org-show-context-detail) org-show-context-detail)
14093 ((cdr (assq key org-show-context-detail)))
14094 (t (cdr (assq 'default org-show-context-detail))))))
14096 (defun org-show-set-visibility (detail)
14097 "Set visibility around point according to DETAIL.
14098 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
14099 `tree', `canonical' or t. See `org-show-context-detail' for more
14100 information."
14101 ;; Show current heading and possibly its entry, following headline
14102 ;; or all children.
14103 (if (and (org-at-heading-p) (not (eq detail 'local)))
14104 (org-flag-heading nil)
14105 (org-show-entry)
14106 ;; If point is hidden within a drawer or a block, make sure to
14107 ;; expose it.
14108 (dolist (o (overlays-at (point)))
14109 (when (memq (overlay-get o 'invisible) '(org-hide-block outline))
14110 (delete-overlay o)))
14111 (unless (org-before-first-heading-p)
14112 (org-with-limited-levels
14113 (cl-case detail
14114 ((tree canonical t) (org-show-children))
14115 ((nil minimal ancestors))
14116 (t (save-excursion
14117 (outline-next-heading)
14118 (org-flag-heading nil)))))))
14119 ;; Show all siblings.
14120 (when (eq detail 'lineage) (org-show-siblings))
14121 ;; Show ancestors, possibly with their children.
14122 (when (memq detail '(ancestors lineage tree canonical t))
14123 (save-excursion
14124 (while (org-up-heading-safe)
14125 (org-flag-heading nil)
14126 (when (memq detail '(canonical t)) (org-show-entry))
14127 (when (memq detail '(tree canonical t)) (org-show-children))))))
14129 (defvar org-reveal-start-hook nil
14130 "Hook run before revealing a location.")
14132 (defun org-reveal (&optional siblings)
14133 "Show current entry, hierarchy above it, and the following headline.
14135 This can be used to show a consistent set of context around
14136 locations exposed with `org-show-context'.
14138 With optional argument SIBLINGS, on each level of the hierarchy all
14139 siblings are shown. This repairs the tree structure to what it would
14140 look like when opened with hierarchical calls to `org-cycle'.
14142 With a \\[universal-argument] \\[universal-argument] prefix, \
14143 go to the parent and show the entire tree."
14144 (interactive "P")
14145 (run-hooks 'org-reveal-start-hook)
14146 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14147 ((equal siblings '(16))
14148 (save-excursion
14149 (when (org-up-heading-safe)
14150 (org-show-subtree)
14151 (run-hook-with-args 'org-cycle-hook 'subtree))))
14152 (t (org-show-set-visibility 'lineage))))
14154 (defun org-highlight-new-match (beg end)
14155 "Highlight from BEG to END and mark the highlight is an occur headline."
14156 (let ((ov (make-overlay beg end)))
14157 (overlay-put ov 'face 'secondary-selection)
14158 (overlay-put ov 'org-type 'org-occur)
14159 (push ov org-occur-highlights)))
14161 (defun org-remove-occur-highlights (&optional _beg _end noremove)
14162 "Remove the occur highlights from the buffer.
14163 BEG and END are ignored. If NOREMOVE is nil, remove this function
14164 from the `before-change-functions' in the current buffer."
14165 (interactive)
14166 (unless org-inhibit-highlight-removal
14167 (mapc #'delete-overlay org-occur-highlights)
14168 (setq org-occur-highlights nil)
14169 (setq org-occur-parameters nil)
14170 (unless noremove
14171 (remove-hook 'before-change-functions
14172 'org-remove-occur-highlights 'local))))
14174 ;;;; Priorities
14176 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14177 "Regular expression matching the priority indicator.")
14179 (defvar org-remove-priority-next-time nil)
14181 (defun org-priority-up ()
14182 "Increase the priority of the current item."
14183 (interactive)
14184 (org-priority 'up))
14186 (defun org-priority-down ()
14187 "Decrease the priority of the current item."
14188 (interactive)
14189 (org-priority 'down))
14191 (defun org-priority (&optional action _show)
14192 "Change the priority of an item.
14193 ACTION can be `set', `up', `down', or a character."
14194 (interactive "P")
14195 (if (equal action '(4))
14196 (org-show-priority)
14197 (unless org-enable-priority-commands
14198 (user-error "Priority commands are disabled"))
14199 (setq action (or action 'set))
14200 (let (current new news have remove)
14201 (save-excursion
14202 (org-back-to-heading t)
14203 (when (looking-at org-priority-regexp)
14204 (setq current (string-to-char (match-string 2))
14205 have t))
14206 (cond
14207 ((eq action 'remove)
14208 (setq remove t new ?\ ))
14209 ((or (eq action 'set)
14210 (integerp action))
14211 (if (not (eq action 'set))
14212 (setq new action)
14213 (message "Priority %c-%c, SPC to remove: "
14214 org-highest-priority org-lowest-priority)
14215 (save-match-data
14216 (setq new (read-char-exclusive))))
14217 (when (and (= (upcase org-highest-priority) org-highest-priority)
14218 (= (upcase org-lowest-priority) org-lowest-priority))
14219 (setq new (upcase new)))
14220 (cond ((equal new ?\ ) (setq remove t))
14221 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14222 (user-error "Priority must be between `%c' and `%c'"
14223 org-highest-priority org-lowest-priority))))
14224 ((eq action 'up)
14225 (setq new (if have
14226 (1- current) ; normal cycling
14227 ;; last priority was empty
14228 (if (eq last-command this-command)
14229 org-lowest-priority ; wrap around empty to lowest
14230 ;; default
14231 (if org-priority-start-cycle-with-default
14232 org-default-priority
14233 (1- org-default-priority))))))
14234 ((eq action 'down)
14235 (setq new (if have
14236 (1+ current) ; normal cycling
14237 ;; last priority was empty
14238 (if (eq last-command this-command)
14239 org-highest-priority ; wrap around empty to highest
14240 ;; default
14241 (if org-priority-start-cycle-with-default
14242 org-default-priority
14243 (1+ org-default-priority))))))
14244 (t (user-error "Invalid action")))
14245 (when (or (< (upcase new) org-highest-priority)
14246 (> (upcase new) org-lowest-priority))
14247 (if (and (memq action '(up down))
14248 (not have) (not (eq last-command this-command)))
14249 ;; `new' is from default priority
14250 (error
14251 "The default can not be set, see `org-default-priority' why")
14252 ;; normal cycling: `new' is beyond highest/lowest priority
14253 ;; and is wrapped around to the empty priority
14254 (setq remove t)))
14255 (setq news (format "%c" new))
14256 (if have
14257 (if remove
14258 (replace-match "" t t nil 1)
14259 (replace-match news t t nil 2))
14260 (if remove
14261 (user-error "No priority cookie found in line")
14262 (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
14263 (if (match-end 2)
14264 (progn
14265 (goto-char (match-end 2))
14266 (insert " [#" news "]"))
14267 (goto-char (match-beginning 3))
14268 (insert "[#" news "] "))))
14269 (org-set-tags nil 'align))
14270 (if remove
14271 (message "Priority removed")
14272 (message "Priority of current item set to %s" news)))))
14274 (defun org-show-priority ()
14275 "Show the priority of the current item.
14276 This priority is composed of the main priority given with the [#A] cookies,
14277 and by additional input from the age of a schedules or deadline entry."
14278 (interactive)
14279 (let ((pri (if (eq major-mode 'org-agenda-mode)
14280 (org-get-at-bol 'priority)
14281 (save-excursion
14282 (save-match-data
14283 (beginning-of-line)
14284 (and (looking-at org-heading-regexp)
14285 (org-get-priority (match-string 0))))))))
14286 (message "Priority is %d" (if pri pri -1000))))
14288 (defun org-get-priority (s)
14289 "Find priority cookie and return priority."
14290 (save-match-data
14291 (if (functionp org-get-priority-function)
14292 (funcall org-get-priority-function)
14293 (if (not (string-match org-priority-regexp s))
14294 (* 1000 (- org-lowest-priority org-default-priority))
14295 (* 1000 (- org-lowest-priority
14296 (string-to-char (match-string 2 s))))))))
14298 ;;;; Tags
14300 (defvar org-agenda-archives-mode)
14301 (defvar org-map-continue-from nil
14302 "Position from where mapping should continue.
14303 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14305 (defvar org-scanner-tags nil
14306 "The current tag list while the tags scanner is running.")
14308 (defvar org-trust-scanner-tags nil
14309 "Should `org-get-tags-at' use the tags for the scanner.
14310 This is for internal dynamical scoping only.
14311 When this is non-nil, the function `org-get-tags-at' will return the value
14312 of `org-scanner-tags' instead of building the list by itself. This
14313 can lead to large speed-ups when the tags scanner is used in a file with
14314 many entries, and when the list of tags is retrieved, for example to
14315 obtain a list of properties. Building the tags list for each entry in such
14316 a file becomes an N^2 operation - but with this variable set, it scales
14317 as N.")
14319 (defvar org--matcher-tags-todo-only nil)
14321 (defun org-scan-tags (action matcher todo-only &optional start-level)
14322 "Scan headline tags with inheritance and produce output ACTION.
14324 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14325 or `agenda' to produce an entry list for an agenda view. It can also be
14326 a Lisp form or a function that should be called at each matched headline, in
14327 this case the return value is a list of all return values from these calls.
14329 MATCHER is a function accepting three arguments, returning
14330 a non-nil value whenever a given set of tags qualifies a headline
14331 for inclusion. See `org-make-tags-matcher' for more information.
14332 As a special case, it can also be set to t (respectively nil) in
14333 order to match all (respectively none) headline.
14335 When TODO-ONLY is non-nil, only lines with a not-done TODO
14336 keyword are included in the output.
14338 START-LEVEL can be a string with asterisks, reducing the scope to
14339 headlines matching this string."
14340 (require 'org-agenda)
14341 (let* ((re (concat "^"
14342 (if start-level
14343 ;; Get the correct level to match
14344 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14345 org-outline-regexp)
14346 " *\\(\\<\\("
14347 (mapconcat #'regexp-quote org-todo-keywords-1 "\\|")
14348 "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
14349 (props (list 'face 'default
14350 'done-face 'org-agenda-done
14351 'undone-face 'default
14352 'mouse-face 'highlight
14353 'org-not-done-regexp org-not-done-regexp
14354 'org-todo-regexp org-todo-regexp
14355 'org-complex-heading-regexp org-complex-heading-regexp
14356 'help-echo
14357 (format "mouse-2 or RET jump to org file %s"
14358 (abbreviate-file-name
14359 (or (buffer-file-name (buffer-base-buffer))
14360 (buffer-name (buffer-base-buffer)))))))
14361 (org-map-continue-from nil)
14362 lspos tags tags-list
14363 (tags-alist (list (cons 0 org-file-tags)))
14364 (llast 0) rtn rtn1 level category i txt
14365 todo marker entry priority
14366 ts-date ts-date-type ts-date-pair)
14367 (unless (or (member action '(agenda sparse-tree)) (functionp action))
14368 (setq action (list 'lambda nil action)))
14369 (save-excursion
14370 (goto-char (point-min))
14371 (when (eq action 'sparse-tree)
14372 (org-overview)
14373 (org-remove-occur-highlights))
14374 (while (let (case-fold-search)
14375 (re-search-forward re nil t))
14376 (setq org-map-continue-from nil)
14377 (catch :skip
14378 (setq todo
14379 ;; TODO: is the 1-2 difference a bug?
14380 (when (match-end 1) (match-string-no-properties 2))
14381 tags (when (match-end 4) (match-string-no-properties 4)))
14382 (goto-char (setq lspos (match-beginning 0)))
14383 (setq level (org-reduced-level (org-outline-level))
14384 category (org-get-category))
14385 (when (eq action 'agenda)
14386 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14387 ts-date (car ts-date-pair)
14388 ts-date-type (cdr ts-date-pair)))
14389 (setq i llast llast level)
14390 ;; remove tag lists from same and sublevels
14391 (while (>= i level)
14392 (when (setq entry (assoc i tags-alist))
14393 (setq tags-alist (delete entry tags-alist)))
14394 (setq i (1- i)))
14395 ;; add the next tags
14396 (when tags
14397 (setq tags (org-split-string tags ":")
14398 tags-alist
14399 (cons (cons level tags) tags-alist)))
14400 ;; compile tags for current headline
14401 (setq tags-list
14402 (if org-use-tag-inheritance
14403 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14404 tags)
14405 org-scanner-tags tags-list)
14406 (when org-use-tag-inheritance
14407 (setcdr (car tags-alist)
14408 (mapcar (lambda (x)
14409 (setq x (copy-sequence x))
14410 (org-add-prop-inherited x))
14411 (cdar tags-alist))))
14412 (when (and tags org-use-tag-inheritance
14413 (or (not (eq t org-use-tag-inheritance))
14414 org-tags-exclude-from-inheritance))
14415 ;; Selective inheritance, remove uninherited ones.
14416 (setcdr (car tags-alist)
14417 (org-remove-uninherited-tags (cdar tags-alist))))
14418 (when (and
14420 ;; eval matcher only when the todo condition is OK
14421 (and (or (not todo-only) (member todo org-not-done-keywords))
14422 (if (functionp matcher)
14423 (let ((case-fold-search t) (org-trust-scanner-tags t))
14424 (funcall matcher todo tags-list level))
14425 matcher))
14427 ;; Call the skipper, but return t if it does not
14428 ;; skip, so that the `and' form continues evaluating.
14429 (progn
14430 (unless (eq action 'sparse-tree) (org-agenda-skip))
14433 ;; Check if timestamps are deselecting this entry
14434 (or (not todo-only)
14435 (and (member todo org-not-done-keywords)
14436 (or (not org-agenda-tags-todo-honor-ignore-options)
14437 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14439 ;; select this headline
14440 (cond
14441 ((eq action 'sparse-tree)
14442 (and org-highlight-sparse-tree-matches
14443 (org-get-heading) (match-end 0)
14444 (org-highlight-new-match
14445 (match-beginning 1) (match-end 1)))
14446 (org-show-context 'tags-tree))
14447 ((eq action 'agenda)
14448 (setq txt (org-agenda-format-item
14450 (concat
14451 (if (eq org-tags-match-list-sublevels 'indented)
14452 (make-string (1- level) ?.) "")
14453 (org-get-heading))
14454 (make-string level ?\s)
14455 category
14456 tags-list)
14457 priority (org-get-priority txt))
14458 (goto-char lspos)
14459 (setq marker (org-agenda-new-marker))
14460 (org-add-props txt props
14461 'org-marker marker 'org-hd-marker marker 'org-category category
14462 'todo-state todo
14463 'ts-date ts-date
14464 'priority priority
14465 'type (concat "tagsmatch" ts-date-type))
14466 (push txt rtn))
14467 ((functionp action)
14468 (setq org-map-continue-from nil)
14469 (save-excursion
14470 (setq rtn1 (funcall action))
14471 (push rtn1 rtn)))
14472 (t (user-error "Invalid action")))
14474 ;; if we are to skip sublevels, jump to end of subtree
14475 (unless org-tags-match-list-sublevels
14476 (org-end-of-subtree t)
14477 (backward-char 1))))
14478 ;; Get the correct position from where to continue
14479 (if org-map-continue-from
14480 (goto-char org-map-continue-from)
14481 (and (= (point) lspos) (end-of-line 1)))))
14482 (when (and (eq action 'sparse-tree)
14483 (not org-sparse-tree-open-archived-trees))
14484 (org-hide-archived-subtrees (point-min) (point-max)))
14485 (nreverse rtn)))
14487 (defun org-remove-uninherited-tags (tags)
14488 "Remove all tags that are not inherited from the list TAGS."
14489 (cond
14490 ((eq org-use-tag-inheritance t)
14491 (if org-tags-exclude-from-inheritance
14492 (org-delete-all org-tags-exclude-from-inheritance tags)
14493 tags))
14494 ((not org-use-tag-inheritance) nil)
14495 ((stringp org-use-tag-inheritance)
14496 (delq nil (mapcar
14497 (lambda (x)
14498 (if (and (string-match org-use-tag-inheritance x)
14499 (not (member x org-tags-exclude-from-inheritance)))
14500 x nil))
14501 tags)))
14502 ((listp org-use-tag-inheritance)
14503 (delq nil (mapcar
14504 (lambda (x)
14505 (if (member x org-use-tag-inheritance) x nil))
14506 tags)))))
14508 (defun org-match-sparse-tree (&optional todo-only match)
14509 "Create a sparse tree according to tags string MATCH.
14511 MATCH is a string with match syntax. It can contain a selection
14512 of tags (\"+work+urgent-boss\"), properties (\"LEVEL>3\"), and
14513 TODO keywords (\"TODO=\\\"WAITING\\\"\") or a combination of
14514 those. See the manual for details.
14516 If optional argument TODO-ONLY is non-nil, only select lines that
14517 are also TODO tasks."
14518 (interactive "P")
14519 (org-agenda-prepare-buffers (list (current-buffer)))
14520 (let ((org--matcher-tags-todo-only todo-only))
14521 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match))
14522 org--matcher-tags-todo-only)))
14524 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14526 (defvar org-cached-props nil)
14527 (defun org-cached-entry-get (pom property)
14528 (if (or (eq t org-use-property-inheritance)
14529 (and (stringp org-use-property-inheritance)
14530 (let ((case-fold-search t))
14531 (string-match-p org-use-property-inheritance property)))
14532 (and (listp org-use-property-inheritance)
14533 (member-ignore-case property org-use-property-inheritance)))
14534 ;; Caching is not possible, check it directly.
14535 (org-entry-get pom property 'inherit)
14536 ;; Get all properties, so we can do complicated checks easily.
14537 (cdr (assoc-string property
14538 (or org-cached-props
14539 (setq org-cached-props (org-entry-properties pom)))
14540 t))))
14542 (defun org-global-tags-completion-table (&optional files)
14543 "Return the list of all tags in all agenda buffer/files.
14544 Optional FILES argument is a list of files which can be used
14545 instead of the agenda files."
14546 (save-excursion
14547 (org-uniquify
14548 (delq nil
14549 (apply #'append
14550 (mapcar
14551 (lambda (file)
14552 (set-buffer (find-file-noselect file))
14553 (mapcar (lambda (x)
14554 (and (stringp (car-safe x))
14555 (list (car-safe x))))
14556 (or org-current-tag-alist (org-get-buffer-tags))))
14557 (if (car-safe files) files
14558 (org-agenda-files))))))))
14560 (defun org-make-tags-matcher (match)
14561 "Create the TAGS/TODO matcher form for the selection string MATCH.
14563 Returns a cons of the selection string MATCH and a function
14564 implementing the matcher.
14566 The matcher is to be called at an Org entry, with point on the
14567 headline, and returns non-nil if the entry matches the selection
14568 string MATCH. It must be called with three arguments: the TODO
14569 keyword at the entry (or nil if none), the list of all tags at
14570 the entry including inherited ones and the reduced level of the
14571 headline. Additionally, the category of the entry, if any, must
14572 be specified as the text property `org-category' on the headline.
14574 This function sets the variable `org--matcher-tags-todo-only' to
14575 a non-nil value if the matcher restricts matching to TODO
14576 entries, otherwise it is not touched.
14578 See also `org-scan-tags'."
14579 (unless match
14580 ;; Get a new match request, with completion against the global
14581 ;; tags table and the local tags in current buffer.
14582 (let ((org-last-tags-completion-table
14583 (org-uniquify
14584 (delq nil (append (org-get-buffer-tags)
14585 (org-global-tags-completion-table))))))
14586 (setq match
14587 (completing-read
14588 "Match: "
14589 'org-tags-completion-function nil nil nil 'org-tags-history))))
14591 (let ((match0 match)
14592 (re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)")
14593 (start 0)
14594 tagsmatch todomatch tagsmatcher todomatcher)
14596 ;; Expand group tags.
14597 (setq match (org-tags-expand match))
14599 ;; Check if there is a TODO part of this match, which would be the
14600 ;; part after a "/". To make sure that this slash is not part of
14601 ;; a property value to be matched against, we also check that
14602 ;; there is no / after that slash. First, find the last slash.
14603 (let ((s 0))
14604 (while (string-match "/+" match s)
14605 (setq start (match-beginning 0))
14606 (setq s (match-end 0))))
14607 (if (and (string-match "/+" match start)
14608 (not (string-match-p "\"" match start)))
14609 ;; Match contains also a TODO-matching request.
14610 (progn
14611 (setq tagsmatch (substring match 0 (match-beginning 0)))
14612 (setq todomatch (substring match (match-end 0)))
14613 (when (string-prefix-p "!" todomatch)
14614 (setq org--matcher-tags-todo-only t)
14615 (setq todomatch (substring todomatch 1)))
14616 (when (string-match "\\`\\s-*\\'" todomatch)
14617 (setq todomatch nil)))
14618 ;; Only matching tags.
14619 (setq tagsmatch match)
14620 (setq todomatch nil))
14622 ;; Make the tags matcher.
14623 (when (org-string-nw-p tagsmatch)
14624 (let ((orlist nil)
14625 (orterms (org-split-string tagsmatch "|"))
14626 term)
14627 (while (setq term (pop orterms))
14628 (while (and (equal (substring term -1) "\\") orterms)
14629 (setq term (concat term "|" (pop orterms)))) ;repair bad split.
14630 (while (string-match re term)
14631 (let* ((rest (substring term (match-end 0)))
14632 (minus (and (match-end 1)
14633 (equal (match-string 1 term) "-")))
14634 (tag (save-match-data
14635 (replace-regexp-in-string
14636 "\\\\-" "-" (match-string 2 term))))
14637 (regexp (eq (string-to-char tag) ?{))
14638 (levelp (match-end 4))
14639 (propp (match-end 5))
14641 (cond
14642 (regexp `(org-match-any-p ,(substring tag 1 -1) tags-list))
14643 (levelp
14644 `(,(org-op-to-function (match-string 3 term))
14645 level
14646 ,(string-to-number (match-string 4 term))))
14647 (propp
14648 (let* ((gv (pcase (upcase (match-string 5 term))
14649 ("CATEGORY"
14650 '(get-text-property (point) 'org-category))
14651 ("TODO" 'todo)
14652 (p `(org-cached-entry-get nil ,p))))
14653 (pv (match-string 7 term))
14654 (regexp (eq (string-to-char pv) ?{))
14655 (strp (eq (string-to-char pv) ?\"))
14656 (timep (string-match-p "^\"[[<].*[]>]\"$" pv))
14657 (po (org-op-to-function (match-string 6 term)
14658 (if timep 'time strp))))
14659 (setq pv (if (or regexp strp) (substring pv 1 -1) pv))
14660 (when timep (setq pv (org-matcher-time pv)))
14661 (cond ((and regexp (eq po 'org<>))
14662 `(not (string-match ,pv (or ,gv ""))))
14663 (regexp `(string-match ,pv (or ,gv "")))
14664 (strp `(,po (or ,gv "") ,pv))
14666 `(,po
14667 (string-to-number (or ,gv ""))
14668 ,(string-to-number pv))))))
14669 (t `(member ,tag tags-list)))))
14670 (push (if minus `(not ,mm) mm) tagsmatcher)
14671 (setq term rest)))
14672 (push `(and ,@tagsmatcher) orlist)
14673 (setq tagsmatcher nil))
14674 (setq tagsmatcher `(progn (setq org-cached-props nil) (or ,@orlist)))))
14676 ;; Make the TODO matcher.
14677 (when (org-string-nw-p todomatch)
14678 (let ((orlist nil))
14679 (dolist (term (org-split-string todomatch "|"))
14680 (while (string-match re term)
14681 (let* ((minus (and (match-end 1)
14682 (equal (match-string 1 term) "-")))
14683 (kwd (match-string 2 term))
14684 (regexp (eq (string-to-char kwd) ?{))
14685 (mm (if regexp `(string-match ,(substring kwd 1 -1) todo)
14686 `(equal todo ,kwd))))
14687 (push (if minus `(not ,mm) mm) todomatcher))
14688 (setq term (substring term (match-end 0))))
14689 (push (if (> (length todomatcher) 1)
14690 (cons 'and todomatcher)
14691 (car todomatcher))
14692 orlist)
14693 (setq todomatcher nil))
14694 (setq todomatcher (cons 'or orlist))))
14696 ;; Return the string and function of the matcher. If no
14697 ;; tags-specific or todo-specific matcher exists, match
14698 ;; everything.
14699 (let ((matcher (if (and tagsmatcher todomatcher)
14700 `(and ,tagsmatcher ,todomatcher)
14701 (or tagsmatcher todomatcher t))))
14702 (when org--matcher-tags-todo-only
14703 (setq matcher `(and (member todo org-not-done-keywords) ,matcher)))
14704 (cons match0 `(lambda (todo tags-list level) ,matcher)))))
14706 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14707 "Expand group tags in MATCH.
14709 This replaces every group tag in MATCH with a regexp tag search.
14710 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14711 will be replaced like this:
14713 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14714 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14715 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14717 Replacing by a regexp preserves the structure of the match.
14718 E.g., this expansion
14720 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14722 will match anything tagged with \"Lab\" and \"Home\", or tagged
14723 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14725 A group tag in MATCH can contain regular expressions of its own.
14726 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14727 will be replaced like this:
14729 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14731 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14732 assumed to be a single group tag, and the function will return
14733 the list of tags in this group.
14735 When DOWNCASE is non-nil, expand downcased TAGS."
14736 (if org-group-tags
14737 (let* ((case-fold-search t)
14738 (stable org-mode-syntax-table)
14739 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14740 (taggroups (if downcased
14741 (mapcar (lambda (tg) (mapcar #'downcase tg))
14742 taggroups)
14743 taggroups))
14744 (taggroups-keys (mapcar #'car taggroups))
14745 (return-match (if downcased (downcase match) match))
14746 (count 0)
14747 (work-already-expanded tags-already-expanded)
14748 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14749 ;; @ and _ are allowed as word-components in tags.
14750 (modify-syntax-entry ?@ "w" stable)
14751 (modify-syntax-entry ?_ "w" stable)
14752 ;; Temporarily replace regexp-expressions in the match-expression.
14753 (while (string-match "{.+?}" return-match)
14754 (cl-incf count)
14755 (push (match-string 0 return-match) regexps-in-match)
14756 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14757 (while (and taggroups-keys
14758 (with-syntax-table stable
14759 (string-match
14760 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14761 (regexp-opt taggroups-keys) "\\>\\)")
14762 return-match)))
14763 (let* ((dir (match-string 1 return-match))
14764 (tag (match-string 2 return-match))
14765 (tag (if downcased (downcase tag) tag)))
14766 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14767 (member tag work-already-expanded))
14768 (setq tags-in-group (assoc tag taggroups))
14769 (push tag work-already-expanded)
14770 ;; Recursively expand each tag in the group, if the tag hasn't
14771 ;; already been expanded. Restore the match-data after all recursive calls.
14772 (save-match-data
14773 (let (tags-expanded)
14774 (dolist (x (cdr tags-in-group))
14775 (if (and (member x taggroups-keys)
14776 (not (member x work-already-expanded)))
14777 (setq tags-expanded
14778 (delete-dups
14779 (append
14780 (org-tags-expand x t downcased
14781 work-already-expanded)
14782 tags-expanded)))
14783 (setq tags-expanded
14784 (append (list x) tags-expanded)))
14785 (setq work-already-expanded
14786 (delete-dups
14787 (append tags-expanded
14788 work-already-expanded))))
14789 (setq tags-in-group
14790 (delete-dups (cons (car tags-in-group)
14791 tags-expanded)))))
14792 ;; Filter tag-regexps from tags.
14793 (setq regexp-in-group-escaped
14794 (delq nil (mapcar (lambda (x)
14795 (if (stringp x)
14796 (and (equal "{" (substring x 0 1))
14797 (equal "}" (substring x -1))
14800 tags-in-group))
14801 regexp-in-group
14802 (mapcar (lambda (x)
14803 (substring x 1 -1))
14804 regexp-in-group-escaped)
14805 tags-in-group
14806 (delq nil (mapcar (lambda (x)
14807 (if (stringp x)
14808 (and (not (equal "{" (substring x 0 1)))
14809 (not (equal "}" (substring x -1)))
14812 tags-in-group)))
14813 ;; If single-as-list, do no more in the while-loop.
14814 (if (not single-as-list)
14815 (progn
14816 (when regexp-in-group
14817 (setq regexp-in-group
14818 (concat "\\|"
14819 (mapconcat 'identity regexp-in-group
14820 "\\|"))))
14821 (setq tags-in-group
14822 (concat dir
14823 "{\\<"
14824 (regexp-opt tags-in-group)
14825 "\\>"
14826 regexp-in-group
14827 "}"))
14828 (when (stringp tags-in-group)
14829 (org-add-props tags-in-group '(grouptag t)))
14830 (setq return-match
14831 (replace-match tags-in-group t t return-match)))
14832 (setq tags-in-group
14833 (append regexp-in-group-escaped tags-in-group))))
14834 (setq taggroups-keys (delete tag taggroups-keys))))
14835 ;; Add the regular expressions back into the match-expression again.
14836 (while regexps-in-match
14837 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14838 (pop regexps-in-match)
14839 return-match t t))
14840 (cl-decf count))
14841 (if single-as-list
14842 (if tags-in-group tags-in-group (list return-match))
14843 return-match))
14844 (if single-as-list
14845 (list (if downcased (downcase match) match))
14846 match)))
14848 (defun org-op-to-function (op &optional stringp)
14849 "Turn an operator into the appropriate function."
14850 (setq op
14851 (cond
14852 ((equal op "<" ) '(< string< org-time<))
14853 ((equal op ">" ) '(> org-string> org-time>))
14854 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14855 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14856 ((member op '("=" "==")) '(= string= org-time=))
14857 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14858 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14860 (defun org<> (a b) (not (= a b)))
14861 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14862 (defun org-string>= (a b) (not (string< a b)))
14863 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14864 (defun org-string<> (a b) (not (string= a b)))
14865 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14866 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14867 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14868 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14869 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14870 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14871 (defun org-2ft (s)
14872 "Convert S to a floating point time.
14873 If S is already a number, just return it. If it is a string, parse
14874 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14875 (cond
14876 ((numberp s) s)
14877 ((stringp s)
14878 (condition-case nil
14879 (float-time (apply 'encode-time (org-parse-time-string s)))
14880 (error 0.)))
14881 (t 0.)))
14883 (defun org-time-today ()
14884 "Time in seconds today at 0:00.
14885 Returns the float number of seconds since the beginning of the
14886 epoch to the beginning of today (00:00)."
14887 (float-time (apply 'encode-time
14888 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14890 (defun org-matcher-time (s)
14891 "Interpret a time comparison value."
14892 (save-match-data
14893 (cond
14894 ((string= s "<now>") (float-time))
14895 ((string= s "<today>") (org-time-today))
14896 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14897 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14898 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14899 (+ (org-time-today)
14900 (* (string-to-number (match-string 1 s))
14901 (cdr (assoc (match-string 2 s)
14902 '(("d" . 86400.0) ("w" . 604800.0)
14903 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14904 (t (org-2ft s)))))
14906 (defun org-match-any-p (re list)
14907 "Does re match any element of list?"
14908 (setq list (mapcar (lambda (x) (string-match re x)) list))
14909 (delq nil list))
14911 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14912 (defvar org-tags-overlay (make-overlay 1 1))
14913 (delete-overlay org-tags-overlay)
14915 (defun org-get-local-tags-at (&optional pos)
14916 "Get a list of tags defined in the current headline."
14917 (org-get-tags-at pos 'local))
14919 (defun org-get-local-tags ()
14920 "Get a list of tags defined in the current headline."
14921 (org-get-tags-at nil 'local))
14923 (defun org-get-tags-at (&optional pos local)
14924 "Get a list of all headline tags applicable at POS.
14925 POS defaults to point. If tags are inherited, the list contains
14926 the targets in the same sequence as the headlines appear, i.e.
14927 the tags of the current headline come last.
14928 When LOCAL is non-nil, only return tags from the current headline,
14929 ignore inherited ones."
14930 (interactive)
14931 (if (and org-trust-scanner-tags
14932 (or (not pos) (equal pos (point)))
14933 (not local))
14934 org-scanner-tags
14935 (let (tags ltags lastpos parent)
14936 (save-excursion
14937 (save-restriction
14938 (widen)
14939 (goto-char (or pos (point)))
14940 (save-match-data
14941 (catch 'done
14942 (condition-case nil
14943 (progn
14944 (org-back-to-heading t)
14945 (while (not (equal lastpos (point)))
14946 (setq lastpos (point))
14947 (when (looking-at ".+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14948 (setq ltags (org-split-string
14949 (match-string-no-properties 1) ":"))
14950 (when parent
14951 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14952 (setq tags (append
14953 (if parent
14954 (org-remove-uninherited-tags ltags)
14955 ltags)
14956 tags)))
14957 (or org-use-tag-inheritance (throw 'done t))
14958 (when local (throw 'done t))
14959 (or (org-up-heading-safe) (error nil))
14960 (setq parent t)))
14961 (error nil)))))
14962 (if local
14963 tags
14964 (reverse (delete-dups
14965 (reverse (append
14966 (org-remove-uninherited-tags
14967 org-file-tags)
14968 tags)))))))))
14970 (defun org-add-prop-inherited (s)
14971 (add-text-properties 0 (length s) '(inherited t) s)
14974 (defun org-toggle-tag (tag &optional onoff)
14975 "Toggle the tag TAG for the current line.
14976 If ONOFF is `on' or `off', don't toggle but set to this state."
14977 (let (res current)
14978 (save-excursion
14979 (org-back-to-heading t)
14980 (if (re-search-forward "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$"
14981 (point-at-eol) t)
14982 (progn
14983 (setq current (match-string 1))
14984 (replace-match ""))
14985 (setq current ""))
14986 (setq current (nreverse (org-split-string current ":")))
14987 (cond
14988 ((eq onoff 'on)
14989 (setq res t)
14990 (or (member tag current) (push tag current)))
14991 ((eq onoff 'off)
14992 (or (not (member tag current)) (setq current (delete tag current))))
14993 (t (if (member tag current)
14994 (setq current (delete tag current))
14995 (setq res t)
14996 (push tag current))))
14997 (end-of-line 1)
14998 (if current
14999 (progn
15000 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
15001 (org-set-tags nil t))
15002 (delete-horizontal-space))
15003 (run-hooks 'org-after-tags-change-hook))
15004 res))
15006 (defun org--align-tags-here (to-col)
15007 "Align tags on the current headline to TO-COL.
15008 Assume point is on a headline."
15009 (let ((pos (point)))
15010 (beginning-of-line)
15011 (if (or (not (looking-at ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15012 (>= pos (match-beginning 2)))
15013 ;; No tags or point within tags: do not align.
15014 (goto-char pos)
15015 (goto-char (match-beginning 1))
15016 (let ((shift (max (- (if (>= to-col 0) to-col
15017 (- (abs to-col) (string-width (match-string 2))))
15018 (current-column))
15019 1)))
15020 (replace-match (make-string shift ?\s) nil nil nil 1)
15021 ;; Preserve initial position, if possible. In any case, stop
15022 ;; before tags.
15023 (when (< pos (point)) (goto-char pos))))))
15025 (defun org-set-tags-command (&optional arg just-align)
15026 "Call the set-tags command for the current entry."
15027 (interactive "P")
15028 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
15029 (org-set-tags arg just-align)
15030 (save-excursion
15031 (unless (and (org-region-active-p)
15032 org-loop-over-headlines-in-active-region)
15033 (org-back-to-heading t))
15034 (org-set-tags arg just-align))))
15036 (defun org-set-tags-to (data)
15037 "Set the tags of the current entry to DATA, replacing the current tags.
15038 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
15039 If DATA is nil or the empty string, any tags will be removed."
15040 (interactive "sTags: ")
15041 (setq data
15042 (cond
15043 ((eq data nil) "")
15044 ((equal data "") "")
15045 ((stringp data)
15046 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
15047 ":"))
15048 ((listp data)
15049 (concat ":" (mapconcat 'identity data ":") ":"))))
15050 (when data
15051 (save-excursion
15052 (org-back-to-heading t)
15053 (when (let ((case-fold-search nil))
15054 (looking-at org-complex-heading-regexp))
15055 (if (match-end 5)
15056 (progn
15057 (goto-char (match-beginning 5))
15058 (insert data)
15059 (delete-region (point) (point-at-eol))
15060 (org-set-tags nil 'align))
15061 (goto-char (point-at-eol))
15062 (insert " " data)
15063 (org-set-tags nil 'align)))
15064 (beginning-of-line 1)
15065 (when (looking-at ".*?\\([ \t]+\\)$")
15066 (delete-region (match-beginning 1) (match-end 1))))))
15068 (defun org-align-all-tags ()
15069 "Align the tags in all headings."
15070 (interactive)
15071 (save-excursion
15072 (or (ignore-errors (org-back-to-heading t))
15073 (outline-next-heading))
15074 (if (org-at-heading-p)
15075 (org-set-tags t)
15076 (message "No headings"))))
15078 (defvar org-indent-indentation-per-level)
15079 (defun org-set-tags (&optional arg just-align)
15080 "Set the tags for the current headline.
15081 With prefix ARG, realign all tags in headings in the current buffer.
15082 When JUST-ALIGN is non-nil, only align tags."
15083 (interactive "P")
15084 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
15085 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
15086 'region-start-level
15087 'region))
15088 org-loop-over-headlines-in-active-region)
15089 (org-map-entries
15090 ;; We don't use ARG and JUST-ALIGN here because these args
15091 ;; are not useful when looping over headlines.
15092 #'org-set-tags
15093 org-loop-over-headlines-in-active-region
15095 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
15096 (let ((org-setting-tags t))
15097 (if arg
15098 (save-excursion
15099 (goto-char (point-min))
15100 (while (re-search-forward org-outline-regexp-bol nil t)
15101 (org-set-tags nil t)
15102 (end-of-line))
15103 (message "All tags realigned to column %d" org-tags-column))
15104 (let* ((current (org-get-tags-string))
15105 (tags
15106 (if just-align current
15107 ;; Get a new set of tags from the user.
15108 (save-excursion
15109 (let* ((seen)
15110 (table
15111 (setq
15112 org-last-tags-completion-table
15113 ;; Uniquify tags in alists, yet preserve
15114 ;; structure (i.e., keywords).
15115 (delq nil
15116 (mapcar
15117 (lambda (pair)
15118 (let ((head (car pair)))
15119 (cond ((symbolp head) pair)
15120 ((member head seen) nil)
15121 (t (push head seen)
15122 pair))))
15123 (append
15124 (or org-current-tag-alist
15125 (org-get-buffer-tags))
15126 (and
15127 org-complete-tags-always-offer-all-agenda-tags
15128 (org-global-tags-completion-table
15129 (org-agenda-files))))))))
15130 (current-tags (org-split-string current ":"))
15131 (inherited-tags
15132 (nreverse (nthcdr (length current-tags)
15133 (nreverse (org-get-tags-at))))))
15134 (replace-regexp-in-string
15135 "\\([-+&]+\\|,\\)"
15137 (if (or (eq t org-use-fast-tag-selection)
15138 (and org-use-fast-tag-selection
15139 (delq nil (mapcar #'cdr table))))
15140 (org-fast-tag-selection
15141 current-tags inherited-tags table
15142 (and org-fast-tag-selection-include-todo
15143 org-todo-key-alist))
15144 (let ((org-add-colon-after-tag-completion
15145 (< 1 (length table))))
15146 (org-trim
15147 (completing-read
15148 "Tags: "
15149 #'org-tags-completion-function
15150 nil nil current 'org-tags-history))))))))))
15152 (when org-tags-sort-function
15153 (setq tags
15154 (mapconcat
15155 #'identity
15156 (sort (org-split-string tags "[^[:alnum:]_@#%]+")
15157 org-tags-sort-function)
15158 ":")))
15160 (if (not (org-string-nw-p tags)) (setq tags "")
15161 (unless (string-suffix-p ":" tags) (setq tags (concat tags ":")))
15162 (unless (string-prefix-p ":" tags) (setq tags (concat ":" tags))))
15164 ;; Insert new tags at the correct column.
15165 (unless (equal current tags)
15166 (save-excursion
15167 (beginning-of-line)
15168 (let ((case-fold-search nil))
15169 (looking-at org-complex-heading-regexp))
15170 ;; Remove current tags, if any.
15171 (when (match-end 5) (replace-match "" nil nil nil 5))
15172 ;; Insert new tags, if any. Otherwise, remove trailing
15173 ;; white spaces.
15174 (end-of-line)
15175 (if (not (equal tags ""))
15176 ;; When text is being inserted on an invisible
15177 ;; region boundary, it can be inadvertently sucked
15178 ;; into invisibility.
15179 (outline-flag-region (point) (progn (insert " " tags) (point)) nil)
15180 (skip-chars-backward " \t")
15181 (delete-region (point) (line-end-position)))))
15182 ;; Align tags, if any. Fix tags column if `org-indent-mode'
15183 ;; is on.
15184 (unless (equal tags "")
15185 (let* ((level (save-excursion
15186 (beginning-of-line)
15187 (skip-chars-forward "\\*")))
15188 (offset (if (bound-and-true-p org-indent-mode)
15189 (* (1- org-indent-indentation-per-level)
15190 (1- level))
15192 (tags-column
15193 (+ org-tags-column
15194 (if (> org-tags-column 0) (- offset) offset))))
15195 (org--align-tags-here tags-column))))
15196 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15198 (defun org-change-tag-in-region (beg end tag off)
15199 "Add or remove TAG for each entry in the region.
15200 This works in the agenda, and also in an Org buffer."
15201 (interactive
15202 (list (region-beginning) (region-end)
15203 (let ((org-last-tags-completion-table
15204 (if (derived-mode-p 'org-mode)
15205 (org-uniquify
15206 (delq nil (append (org-get-buffer-tags)
15207 (org-global-tags-completion-table))))
15208 (org-global-tags-completion-table))))
15209 (completing-read
15210 "Tag: " 'org-tags-completion-function nil nil nil
15211 'org-tags-history))
15212 (progn
15213 (message "[s]et or [r]emove? ")
15214 (equal (read-char-exclusive) ?r))))
15215 (when (fboundp 'deactivate-mark) (deactivate-mark))
15216 (let ((agendap (equal major-mode 'org-agenda-mode))
15217 l1 l2 m buf pos newhead (cnt 0))
15218 (goto-char end)
15219 (setq l2 (1- (org-current-line)))
15220 (goto-char beg)
15221 (setq l1 (org-current-line))
15222 (cl-loop for l from l1 to l2 do
15223 (org-goto-line l)
15224 (setq m (get-text-property (point) 'org-hd-marker))
15225 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15226 (and agendap m))
15227 (setq buf (if agendap (marker-buffer m) (current-buffer))
15228 pos (if agendap m (point)))
15229 (with-current-buffer buf
15230 (save-excursion
15231 (save-restriction
15232 (goto-char pos)
15233 (setq cnt (1+ cnt))
15234 (org-toggle-tag tag (if off 'off 'on))
15235 (setq newhead (org-get-heading)))))
15236 (and agendap (org-agenda-change-all-lines newhead m))))
15237 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15239 (defun org-tags-completion-function (string _predicate &optional flag)
15240 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15241 (confirm (lambda (x) (stringp (car x)))))
15242 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15243 (setq s1 (match-string 1 string)
15244 s2 (match-string 2 string))
15245 (setq s1 "" s2 string))
15246 (cond
15247 ((eq flag nil)
15248 ;; try completion
15249 (setq rtn (try-completion s2 ctable confirm))
15250 (when (stringp rtn)
15251 (setq rtn
15252 (concat s1 s2 (substring rtn (length s2))
15253 (if (and org-add-colon-after-tag-completion
15254 (assoc rtn ctable))
15255 ":" ""))))
15256 rtn)
15257 ((eq flag t)
15258 ;; all-completions
15259 (all-completions s2 ctable confirm))
15260 ((eq flag 'lambda)
15261 ;; exact match?
15262 (assoc s2 ctable)))))
15264 (defun org-fast-tag-insert (kwd tags face &optional end)
15265 "Insert KDW, and the TAGS, the latter with face FACE.
15266 Also insert END."
15267 (insert (format "%-12s" (concat kwd ":"))
15268 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15269 (or end "")))
15271 (defun org-fast-tag-show-exit (flag)
15272 (save-excursion
15273 (org-goto-line 3)
15274 (when (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15275 (replace-match ""))
15276 (when flag
15277 (end-of-line 1)
15278 (org-move-to-column (- (window-width) 19) t)
15279 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15281 (defun org-set-current-tags-overlay (current prefix)
15282 "Add an overlay to CURRENT tag with PREFIX."
15283 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15284 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15285 (org-overlay-display org-tags-overlay (concat prefix s))))
15287 (defvar org-last-tag-selection-key nil)
15288 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15289 "Fast tag selection with single keys.
15290 CURRENT is the current list of tags in the headline, INHERITED is the
15291 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15292 possibly with grouping information. TODO-TABLE is a similar table with
15293 TODO keywords, should these have keys assigned to them.
15294 If the keys are nil, a-z are automatically assigned.
15295 Returns the new tags string, or nil to not change the current settings."
15296 (let* ((fulltable (append table todo-table))
15297 (maxlen (apply 'max (mapcar
15298 (lambda (x)
15299 (if (stringp (car x)) (string-width (car x)) 0))
15300 fulltable)))
15301 (buf (current-buffer))
15302 (expert (eq org-fast-tag-selection-single-key 'expert))
15303 (buffer-tags nil)
15304 (fwidth (+ maxlen 3 1 3))
15305 (ncol (/ (- (window-width) 4) fwidth))
15306 (i-face 'org-done)
15307 (c-face 'org-todo)
15308 tg cnt e c char c1 c2 ntable tbl rtn
15309 ov-start ov-end ov-prefix
15310 (exit-after-next org-fast-tag-selection-single-key)
15311 (done-keywords org-done-keywords)
15312 groups ingroup intaggroup)
15313 (save-excursion
15314 (beginning-of-line 1)
15315 (if (looking-at ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
15316 (setq ov-start (match-beginning 1)
15317 ov-end (match-end 1)
15318 ov-prefix "")
15319 (setq ov-start (1- (point-at-eol))
15320 ov-end (1+ ov-start))
15321 (skip-chars-forward "^\n\r")
15322 (setq ov-prefix
15323 (concat
15324 (buffer-substring (1- (point)) (point))
15325 (if (> (current-column) org-tags-column)
15327 (make-string (- org-tags-column (current-column)) ?\ ))))))
15328 (move-overlay org-tags-overlay ov-start ov-end)
15329 (save-window-excursion
15330 (if expert
15331 (set-buffer (get-buffer-create " *Org tags*"))
15332 (delete-other-windows)
15333 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15334 (org-switch-to-buffer-other-window " *Org tags*"))
15335 (erase-buffer)
15336 (setq-local org-done-keywords done-keywords)
15337 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15338 (org-fast-tag-insert "Current" current c-face "\n\n")
15339 (org-fast-tag-show-exit exit-after-next)
15340 (org-set-current-tags-overlay current ov-prefix)
15341 (setq tbl fulltable char ?a cnt 0)
15342 (while (setq e (pop tbl))
15343 (cond
15344 ((eq (car e) :startgroup)
15345 (push '() groups) (setq ingroup t)
15346 (unless (zerop cnt)
15347 (setq cnt 0)
15348 (insert "\n"))
15349 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15350 ((eq (car e) :endgroup)
15351 (setq ingroup nil cnt 0)
15352 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15353 ((eq (car e) :startgrouptag)
15354 (setq intaggroup t)
15355 (unless (zerop cnt)
15356 (setq cnt 0)
15357 (insert "\n"))
15358 (insert "[ "))
15359 ((eq (car e) :endgrouptag)
15360 (setq intaggroup nil cnt 0)
15361 (insert "]\n"))
15362 ((equal e '(:newline))
15363 (unless (zerop cnt)
15364 (setq cnt 0)
15365 (insert "\n")
15366 (setq e (car tbl))
15367 (while (equal (car tbl) '(:newline))
15368 (insert "\n")
15369 (setq tbl (cdr tbl)))))
15370 ((equal e '(:grouptags)) (insert " : "))
15372 (setq tg (copy-sequence (car e)) c2 nil)
15373 (if (cdr e)
15374 (setq c (cdr e))
15375 ;; automatically assign a character.
15376 (setq c1 (string-to-char
15377 (downcase (substring
15378 tg (if (= (string-to-char tg) ?@) 1 0)))))
15379 (if (or (rassoc c1 ntable) (rassoc c1 table))
15380 (while (or (rassoc char ntable) (rassoc char table))
15381 (setq char (1+ char)))
15382 (setq c2 c1))
15383 (setq c (or c2 char)))
15384 (when ingroup (push tg (car groups)))
15385 (setq tg (org-add-props tg nil 'face
15386 (cond
15387 ((not (assoc tg table))
15388 (org-get-todo-face tg))
15389 ((member tg current) c-face)
15390 ((member tg inherited) i-face))))
15391 (when (equal (caar tbl) :grouptags)
15392 (org-add-props tg nil 'face 'org-tag-group))
15393 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15394 (insert "[" c "] " tg (make-string
15395 (- fwidth 4 (length tg)) ?\ ))
15396 (push (cons tg c) ntable)
15397 (when (= (cl-incf cnt) ncol)
15398 (insert "\n")
15399 (when (or ingroup intaggroup) (insert " "))
15400 (setq cnt 0)))))
15401 (setq ntable (nreverse ntable))
15402 (insert "\n")
15403 (goto-char (point-min))
15404 (unless expert (org-fit-window-to-buffer))
15405 (setq rtn
15406 (catch 'exit
15407 (while t
15408 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15409 (if (not groups) "no " "")
15410 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15411 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15412 (setq org-last-tag-selection-key c)
15413 (cond
15414 ((= c ?\r) (throw 'exit t))
15415 ((= c ?!)
15416 (setq groups (not groups))
15417 (goto-char (point-min))
15418 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15419 ((= c ?\C-c)
15420 (if (not expert)
15421 (org-fast-tag-show-exit
15422 (setq exit-after-next (not exit-after-next)))
15423 (setq expert nil)
15424 (delete-other-windows)
15425 (set-window-buffer (split-window-vertically) " *Org tags*")
15426 (org-switch-to-buffer-other-window " *Org tags*")
15427 (org-fit-window-to-buffer)))
15428 ((or (= c ?\C-g)
15429 (and (= c ?q) (not (rassoc c ntable))))
15430 (delete-overlay org-tags-overlay)
15431 (setq quit-flag t))
15432 ((= c ?\ )
15433 (setq current nil)
15434 (when exit-after-next (setq exit-after-next 'now)))
15435 ((= c ?\t)
15436 (condition-case nil
15437 (setq tg (completing-read
15438 "Tag: "
15439 (or buffer-tags
15440 (with-current-buffer buf
15441 (setq buffer-tags
15442 (org-get-buffer-tags))))))
15443 (quit (setq tg "")))
15444 (when (string-match "\\S-" tg)
15445 (cl-pushnew (list tg) buffer-tags :test #'equal)
15446 (if (member tg current)
15447 (setq current (delete tg current))
15448 (push tg current)))
15449 (when exit-after-next (setq exit-after-next 'now)))
15450 ((setq e (rassoc c todo-table) tg (car e))
15451 (with-current-buffer buf
15452 (save-excursion (org-todo tg)))
15453 (when exit-after-next (setq exit-after-next 'now)))
15454 ((setq e (rassoc c ntable) tg (car e))
15455 (if (member tg current)
15456 (setq current (delete tg current))
15457 (cl-loop for g in groups do
15458 (when (member tg g)
15459 (dolist (x g) (setq current (delete x current)))))
15460 (push tg current))
15461 (when exit-after-next (setq exit-after-next 'now))))
15463 ;; Create a sorted list
15464 (setq current
15465 (sort current
15466 (lambda (a b)
15467 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15468 (when (eq exit-after-next 'now) (throw 'exit t))
15469 (goto-char (point-min))
15470 (beginning-of-line 2)
15471 (delete-region (point) (point-at-eol))
15472 (org-fast-tag-insert "Current" current c-face)
15473 (org-set-current-tags-overlay current ov-prefix)
15474 (while (re-search-forward "\\[.\\] \\([[:alnum:]_@#%]+\\)" nil t)
15475 (setq tg (match-string 1))
15476 (add-text-properties
15477 (match-beginning 1) (match-end 1)
15478 (list 'face
15479 (cond
15480 ((member tg current) c-face)
15481 ((member tg inherited) i-face)
15482 (t (get-text-property (match-beginning 1) 'face))))))
15483 (goto-char (point-min)))))
15484 (delete-overlay org-tags-overlay)
15485 (if rtn
15486 (mapconcat 'identity current ":")
15487 nil))))
15489 (defun org-get-tags-string ()
15490 "Get the TAGS string in the current headline."
15491 (unless (org-at-heading-p t)
15492 (user-error "Not on a heading"))
15493 (save-excursion
15494 (beginning-of-line 1)
15495 (if (looking-at ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
15496 (match-string-no-properties 1)
15497 "")))
15499 (defun org-get-tags ()
15500 "Get the list of tags specified in the current headline."
15501 (org-split-string (org-get-tags-string) ":"))
15503 (defun org-get-buffer-tags ()
15504 "Get a table of all tags used in the buffer, for completion."
15505 (org-with-wide-buffer
15506 (goto-char (point-min))
15507 (let ((tag-re (concat org-outline-regexp-bol
15508 "\\(?:.*?[ \t]\\)?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
15509 tags)
15510 (while (re-search-forward tag-re nil t)
15511 (dolist (tag (org-split-string (match-string-no-properties 1) ":"))
15512 (push tag tags)))
15513 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15515 ;;;; The mapping API
15517 (defvar org-agenda-skip-comment-trees)
15518 (defvar org-agenda-skip-function)
15519 (defun org-map-entries (func &optional match scope &rest skip)
15520 "Call FUNC at each headline selected by MATCH in SCOPE.
15522 FUNC is a function or a lisp form. The function will be called without
15523 arguments, with the cursor positioned at the beginning of the headline.
15524 The return values of all calls to the function will be collected and
15525 returned as a list.
15527 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15528 does not need to preserve point. After evaluation, the cursor will be
15529 moved to the end of the line (presumably of the headline of the
15530 processed entry) and search continues from there. Under some
15531 circumstances, this may not produce the wanted results. For example,
15532 if you have removed (e.g. archived) the current (sub)tree it could
15533 mean that the next entry will be skipped entirely. In such cases, you
15534 can specify the position from where search should continue by making
15535 FUNC set the variable `org-map-continue-from' to the desired buffer
15536 position.
15538 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15539 Only headlines that are matched by this query will be considered during
15540 the iteration. When MATCH is nil or t, all headlines will be
15541 visited by the iteration.
15543 SCOPE determines the scope of this command. It can be any of:
15545 nil The current buffer, respecting the restriction if any
15546 tree The subtree started with the entry at point
15547 region The entries within the active region, if any
15548 region-start-level
15549 The entries within the active region, but only those at
15550 the same level than the first one.
15551 file The current buffer, without restriction
15552 file-with-archives
15553 The current buffer, and any archives associated with it
15554 agenda All agenda files
15555 agenda-with-archives
15556 All agenda files with any archive files associated with them
15557 \(file1 file2 ...)
15558 If this is a list, all files in the list will be scanned
15560 The remaining args are treated as settings for the skipping facilities of
15561 the scanner. The following items can be given here:
15563 archive skip trees with the archive tag
15564 comment skip trees with the COMMENT keyword
15565 function or Emacs Lisp form:
15566 will be used as value for `org-agenda-skip-function', so
15567 whenever the function returns a position, FUNC will not be
15568 called for that entry and search will continue from the
15569 position returned
15571 If your function needs to retrieve the tags including inherited tags
15572 at the *current* entry, you can use the value of the variable
15573 `org-scanner-tags' which will be much faster than getting the value
15574 with `org-get-tags-at'. If your function gets properties with
15575 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15576 to t around the call to `org-entry-properties' to get the same speedup.
15577 Note that if your function moves around to retrieve tags and properties at
15578 a *different* entry, you cannot use these techniques."
15579 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15580 (not (org-region-active-p)))
15581 (let* ((org-agenda-archives-mode nil) ; just to make sure
15582 (org-agenda-skip-archived-trees (memq 'archive skip))
15583 (org-agenda-skip-comment-trees (memq 'comment skip))
15584 (org-agenda-skip-function
15585 (car (org-delete-all '(comment archive) skip)))
15586 (org-tags-match-list-sublevels t)
15587 (start-level (eq scope 'region-start-level))
15588 matcher res
15589 org-todo-keywords-for-agenda
15590 org-done-keywords-for-agenda
15591 org-todo-keyword-alist-for-agenda
15592 org-tag-alist-for-agenda
15593 org--matcher-tags-todo-only)
15595 (cond
15596 ((eq match t) (setq matcher t))
15597 ((eq match nil) (setq matcher t))
15598 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15600 (save-excursion
15601 (save-restriction
15602 (cond ((eq scope 'tree)
15603 (org-back-to-heading t)
15604 (org-narrow-to-subtree)
15605 (setq scope nil))
15606 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15607 (org-region-active-p))
15608 ;; If needed, set start-level to a string like "2"
15609 (when start-level
15610 (save-excursion
15611 (goto-char (region-beginning))
15612 (unless (org-at-heading-p) (outline-next-heading))
15613 (setq start-level (org-current-level))))
15614 (narrow-to-region (region-beginning)
15615 (save-excursion
15616 (goto-char (region-end))
15617 (unless (and (bolp) (org-at-heading-p))
15618 (outline-next-heading))
15619 (point)))
15620 (setq scope nil)))
15622 (if (not scope)
15623 (progn
15624 (org-agenda-prepare-buffers
15625 (and buffer-file-name (list buffer-file-name)))
15626 (setq res
15627 (org-scan-tags
15628 func matcher org--matcher-tags-todo-only start-level)))
15629 ;; Get the right scope
15630 (cond
15631 ((and scope (listp scope) (symbolp (car scope)))
15632 (setq scope (eval scope)))
15633 ((eq scope 'agenda)
15634 (setq scope (org-agenda-files t)))
15635 ((eq scope 'agenda-with-archives)
15636 (setq scope (org-agenda-files t))
15637 (setq scope (org-add-archive-files scope)))
15638 ((eq scope 'file)
15639 (setq scope (and buffer-file-name (list buffer-file-name))))
15640 ((eq scope 'file-with-archives)
15641 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15642 (org-agenda-prepare-buffers scope)
15643 (dolist (file scope)
15644 (with-current-buffer (org-find-base-buffer-visiting file)
15645 (org-with-wide-buffer
15646 (goto-char (point-min))
15647 (setq res
15648 (append
15650 (org-scan-tags
15651 func matcher org--matcher-tags-todo-only)))))))))
15652 res)))
15654 ;;; Properties API
15656 (defconst org-special-properties
15657 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15658 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15659 "The special properties valid in Org mode.
15660 These are properties that are not defined in the property drawer,
15661 but in some other way.")
15663 (defconst org-default-properties
15664 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15665 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15666 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15667 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15668 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15669 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15670 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15671 "Some properties that are used by Org mode for various purposes.
15672 Being in this list makes sure that they are offered for completion.")
15674 (defun org--valid-property-p (property)
15675 "Non nil when string PROPERTY is a valid property name."
15676 (not
15677 (or (equal property "")
15678 (string-match-p "\\s-" property))))
15680 (defun org--update-property-plist (key val props)
15681 "Associate KEY to VAL in alist PROPS.
15682 Modifications are made by side-effect. Return new alist."
15683 (let* ((appending (string= (substring key -1) "+"))
15684 (key (if appending (substring key 0 -1) key))
15685 (old (assoc-string key props t)))
15686 (if (not old) (cons (cons key val) props)
15687 (setcdr old (if appending (concat (cdr old) " " val) val))
15688 props)))
15690 (defun org-get-property-block (&optional beg force)
15691 "Return the (beg . end) range of the body of the property drawer.
15692 BEG is the beginning of the current subtree, or of the part
15693 before the first headline. If it is not given, it will be found.
15694 If the drawer does not exist, create it if FORCE is non-nil, or
15695 return nil."
15696 (org-with-wide-buffer
15697 (when beg (goto-char beg))
15698 (unless (org-before-first-heading-p)
15699 (let ((beg (cond (beg)
15700 ((or (not (featurep 'org-inlinetask))
15701 (org-inlinetask-in-task-p))
15702 (org-back-to-heading t))
15703 (t (org-with-limited-levels (org-back-to-heading t))))))
15704 (forward-line)
15705 (when (looking-at-p org-planning-line-re) (forward-line))
15706 (cond ((looking-at org-property-drawer-re)
15707 (forward-line)
15708 (cons (point) (progn (goto-char (match-end 0))
15709 (line-beginning-position))))
15710 (force
15711 (goto-char beg)
15712 (org-insert-property-drawer)
15713 (let ((pos (save-excursion (search-forward ":END:")
15714 (line-beginning-position))))
15715 (cons pos pos))))))))
15717 (defun org-at-property-p ()
15718 "Non-nil when point is inside a property drawer.
15719 See `org-property-re' for match data, if applicable."
15720 (save-excursion
15721 (beginning-of-line)
15722 (and (looking-at org-property-re)
15723 (let ((property-drawer (save-match-data (org-get-property-block))))
15724 (and property-drawer
15725 (>= (point) (car property-drawer))
15726 (< (point) (cdr property-drawer)))))))
15728 (defun org-property-action ()
15729 "Do an action on properties."
15730 (interactive)
15731 (unless (org-at-property-p) (user-error "Not at a property"))
15732 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15733 (let ((c (read-char-exclusive)))
15734 (cl-case c
15735 (?s (call-interactively #'org-set-property))
15736 (?d (call-interactively #'org-delete-property))
15737 (?D (call-interactively #'org-delete-property-globally))
15738 (?c (call-interactively #'org-compute-property-at-point))
15739 (otherwise (user-error "No such property action %c" c)))))
15741 (defun org-inc-effort ()
15742 "Increment the value of the effort property in the current entry."
15743 (interactive)
15744 (org-set-effort nil t))
15746 (defvar org-clock-effort) ; Defined in org-clock.el.
15747 (defvar org-clock-current-task) ; Defined in org-clock.el.
15748 (defun org-set-effort (&optional value increment)
15749 "Set the effort property of the current entry.
15750 With numerical prefix arg, use the nth allowed value, 0 stands for the
15751 10th allowed value.
15753 When INCREMENT is non-nil, set the property to the next allowed value."
15754 (interactive "P")
15755 (when (equal value 0) (setq value 10))
15756 (let* ((completion-ignore-case t)
15757 (prop org-effort-property)
15758 (cur (org-entry-get nil prop))
15759 (allowed (org-property-get-allowed-values nil prop 'table))
15760 (existing (mapcar 'list (org-property-values prop)))
15761 (heading (nth 4 (org-heading-components)))
15763 (val (cond
15764 ((stringp value) value)
15765 ((and allowed (integerp value))
15766 (or (car (nth (1- value) allowed))
15767 (car (org-last allowed))))
15768 ((and allowed increment)
15769 (or (cl-caadr (member (list cur) allowed))
15770 (user-error "Allowed effort values are not set")))
15771 (allowed
15772 (message "Select 1-9,0, [RET%s]: %s"
15773 (if cur (concat "=" cur) "")
15774 (mapconcat 'car allowed " "))
15775 (setq rpl (read-char-exclusive))
15776 (if (equal rpl ?\r)
15778 (setq rpl (- rpl ?0))
15779 (when (equal rpl 0) (setq rpl 10))
15780 (if (and (> rpl 0) (<= rpl (length allowed)))
15781 (car (nth (1- rpl) allowed))
15782 (org-completing-read "Effort: " allowed nil))))
15784 (org-completing-read
15785 (concat "Effort" (and cur (string-match "\\S-" cur)
15786 (concat " [" cur "]"))
15787 ": ")
15788 existing nil nil "" nil cur)))))
15789 (unless (equal (org-entry-get nil prop) val)
15790 (org-entry-put nil prop val))
15791 (org-refresh-property
15792 '((effort . identity)
15793 (effort-minutes . org-duration-string-to-minutes))
15794 val)
15795 (when (equal heading (bound-and-true-p org-clock-current-task))
15796 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15797 (org-clock-update-mode-line))
15798 (message "%s is now %s" prop val)))
15800 (defun org-entry-properties (&optional pom which)
15801 "Get all properties of the current entry.
15803 When POM is a buffer position, get all properties from the entry
15804 there instead.
15806 This includes the TODO keyword, the tags, time strings for
15807 deadline, scheduled, and clocking, and any additional properties
15808 defined in the entry.
15810 If WHICH is nil or `all', get all properties. If WHICH is
15811 `special' or `standard', only get that subclass. If WHICH is
15812 a string, only get that property.
15814 Return value is an alist. Keys are properties, as upcased
15815 strings."
15816 (org-with-point-at pom
15817 (when (and (derived-mode-p 'org-mode)
15818 (ignore-errors (org-back-to-heading t)))
15819 (catch 'exit
15820 (let* ((beg (point))
15821 (specific (and (stringp which) (upcase which)))
15822 (which (cond ((not specific) which)
15823 ((member specific org-special-properties) 'special)
15824 (t 'standard)))
15825 props)
15826 ;; Get the special properties, like TODO and TAGS.
15827 (when (memq which '(nil all special))
15828 (when (or (not specific) (string= specific "CLOCKSUM"))
15829 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15830 (when clocksum
15831 (push (cons "CLOCKSUM"
15832 (org-minutes-to-clocksum-string clocksum))
15833 props)))
15834 (when specific (throw 'exit props)))
15835 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15836 (let ((clocksumt (get-text-property (point)
15837 :org-clock-minutes-today)))
15838 (when clocksumt
15839 (push (cons "CLOCKSUM_T"
15840 (org-minutes-to-clocksum-string clocksumt))
15841 props)))
15842 (when specific (throw 'exit props)))
15843 (when (or (not specific) (string= specific "ITEM"))
15844 (let ((case-fold-search nil))
15845 (when (looking-at org-complex-heading-regexp)
15846 (push (cons "ITEM"
15847 (let ((title (match-string-no-properties 4)))
15848 (if (org-string-nw-p title)
15849 (org-remove-tabs title)
15850 "")))
15851 props)))
15852 (when specific (throw 'exit props)))
15853 (when (or (not specific) (string= specific "TODO"))
15854 (let ((case-fold-search nil))
15855 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15856 (push (cons "TODO" (match-string-no-properties 2)) props)))
15857 (when specific (throw 'exit props)))
15858 (when (or (not specific) (string= specific "PRIORITY"))
15859 (push (cons "PRIORITY"
15860 (if (looking-at org-priority-regexp)
15861 (match-string-no-properties 2)
15862 (char-to-string org-default-priority)))
15863 props)
15864 (when specific (throw 'exit props)))
15865 (when (or (not specific) (string= specific "FILE"))
15866 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15867 props)
15868 (when specific (throw 'exit props)))
15869 (when (or (not specific) (string= specific "TAGS"))
15870 (let ((value (org-string-nw-p (org-get-tags-string))))
15871 (when value (push (cons "TAGS" value) props)))
15872 (when specific (throw 'exit props)))
15873 (when (or (not specific) (string= specific "ALLTAGS"))
15874 (let ((value (org-get-tags-at)))
15875 (when value
15876 (push (cons "ALLTAGS"
15877 (format ":%s:" (mapconcat #'identity value ":")))
15878 props)))
15879 (when specific (throw 'exit props)))
15880 (when (or (not specific) (string= specific "BLOCKED"))
15881 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15882 (when specific (throw 'exit props)))
15883 (when (or (not specific)
15884 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15885 (forward-line)
15886 (when (looking-at-p org-planning-line-re)
15887 (end-of-line)
15888 (let ((bol (line-beginning-position))
15889 ;; Backward compatibility: time keywords used to
15890 ;; be configurable (before 8.3). Make sure we
15891 ;; get the correct keyword.
15892 (key-assoc `(("CLOSED" . ,org-closed-string)
15893 ("DEADLINE" . ,org-deadline-string)
15894 ("SCHEDULED" . ,org-scheduled-string))))
15895 (dolist (pair (if specific (list (assoc specific key-assoc))
15896 key-assoc))
15897 (save-excursion
15898 (when (search-backward (cdr pair) bol t)
15899 (goto-char (match-end 0))
15900 (skip-chars-forward " \t")
15901 (and (looking-at org-ts-regexp-both)
15902 (push (cons (car pair)
15903 (match-string-no-properties 0))
15904 props)))))))
15905 (when specific (throw 'exit props)))
15906 (when (or (not specific)
15907 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15908 (let ((find-ts
15909 (lambda (end ts)
15910 ;; Fix next time-stamp before END. TS is the
15911 ;; list of time-stamps found so far.
15912 (let ((ts ts)
15913 (regexp (cond
15914 ((string= specific "TIMESTAMP")
15915 org-ts-regexp)
15916 ((string= specific "TIMESTAMP_IA")
15917 org-ts-regexp-inactive)
15918 ((assoc "TIMESTAMP_IA" ts)
15919 org-ts-regexp)
15920 ((assoc "TIMESTAMP" ts)
15921 org-ts-regexp-inactive)
15922 (t org-ts-regexp-both))))
15923 (catch 'next
15924 (while (re-search-forward regexp end t)
15925 (backward-char)
15926 (let ((object (org-element-context)))
15927 ;; Accept to match timestamps in node
15928 ;; properties, too.
15929 (when (memq (org-element-type object)
15930 '(node-property timestamp))
15931 (let ((type
15932 (org-element-property :type object)))
15933 (cond
15934 ((and (memq type '(active active-range))
15935 (not (equal specific "TIMESTAMP_IA")))
15936 (unless (assoc "TIMESTAMP" ts)
15937 (push (cons "TIMESTAMP"
15938 (org-element-property
15939 :raw-value object))
15941 (when specific (throw 'exit ts))))
15942 ((and (memq type '(inactive inactive-range))
15943 (not (string= specific "TIMESTAMP")))
15944 (unless (assoc "TIMESTAMP_IA" ts)
15945 (push (cons "TIMESTAMP_IA"
15946 (org-element-property
15947 :raw-value object))
15949 (when specific (throw 'exit ts))))))
15950 ;; Both timestamp types are found,
15951 ;; move to next part.
15952 (when (= (length ts) 2) (throw 'next ts)))))
15953 ts)))))
15954 (goto-char beg)
15955 ;; First look for timestamps within headline.
15956 (let ((ts (funcall find-ts (line-end-position) nil)))
15957 (if (= (length ts) 2) (setq props (nconc ts props))
15958 ;; Then find timestamps in the section, skipping
15959 ;; planning line.
15960 (let ((end (save-excursion (outline-next-heading))))
15961 (forward-line)
15962 (when (looking-at-p org-planning-line-re) (forward-line))
15963 (setq props (nconc (funcall find-ts end ts) props))))))))
15964 ;; Get the standard properties, like :PROP:.
15965 (when (memq which '(nil all standard))
15966 ;; If we are looking after a specific property, delegate
15967 ;; to `org-entry-get', which is faster. However, make an
15968 ;; exception for "CATEGORY", since it can be also set
15969 ;; through keywords (i.e. #+CATEGORY).
15970 (if (and specific (not (equal specific "CATEGORY")))
15971 (let ((value (org-entry-get beg specific nil t)))
15972 (throw 'exit (and value (list (cons specific value)))))
15973 (let ((range (org-get-property-block beg)))
15974 (when range
15975 (let ((end (cdr range)) seen-base)
15976 (goto-char (car range))
15977 ;; Unlike to `org--update-property-plist', we
15978 ;; handle the case where base values is found
15979 ;; after its extension. We also forbid standard
15980 ;; properties to be named as special properties.
15981 (while (re-search-forward org-property-re end t)
15982 (let* ((key (upcase (match-string-no-properties 2)))
15983 (extendp (string-match-p "\\+\\'" key))
15984 (key-base (if extendp (substring key 0 -1) key))
15985 (value (match-string-no-properties 3)))
15986 (cond
15987 ((member-ignore-case key-base org-special-properties))
15988 (extendp
15989 (setq props
15990 (org--update-property-plist key value props)))
15991 ((member key seen-base))
15992 (t (push key seen-base)
15993 (let ((p (assoc-string key props t)))
15994 (if p (setcdr p (concat value " " (cdr p)))
15995 (push (cons key value) props))))))))))))
15996 (unless (assoc "CATEGORY" props)
15997 (push (cons "CATEGORY" (org-get-category beg)) props)
15998 (when (string= specific "CATEGORY") (throw 'exit props)))
15999 ;; Return value.
16000 props)))))
16002 (defun org--property-local-values (property literal-nil)
16003 "Return value for PROPERTY in current entry.
16004 Value is a list whose car is the base value for PROPERTY and cdr
16005 a list of accumulated values. Return nil if neither is found in
16006 the entry. Also return nil when PROPERTY is set to \"nil\",
16007 unless LITERAL-NIL is non-nil."
16008 (let ((range (org-get-property-block)))
16009 (when range
16010 (goto-char (car range))
16011 (let* ((case-fold-search t)
16012 (end (cdr range))
16013 (value
16014 ;; Base value.
16015 (save-excursion
16016 (let ((v (and (re-search-forward
16017 (org-re-property property nil t) end t)
16018 (match-string-no-properties 3))))
16019 (list (if literal-nil v (org-not-nil v)))))))
16020 ;; Find additional values.
16021 (let* ((property+ (org-re-property (concat property "+") nil t)))
16022 (while (re-search-forward property+ end t)
16023 (push (match-string-no-properties 3) value)))
16024 ;; Return final values.
16025 (and (not (equal value '(nil))) (nreverse value))))))
16027 (defun org--property-global-value (property literal-nil)
16028 "Return value for PROPERTY in current buffer.
16029 Return value is a string. Return nil if property is not set
16030 globally. Also return nil when PROPERTY is set to \"nil\",
16031 unless LITERAL-NIL is non-nil."
16032 (let ((global
16033 (cdr (or (assoc-string property org-file-properties t)
16034 (assoc-string property org-global-properties t)
16035 (assoc-string property org-global-properties-fixed t)))))
16036 (if literal-nil global (org-not-nil global))))
16038 (defun org-entry-get (pom property &optional inherit literal-nil)
16039 "Get value of PROPERTY for entry or content at point-or-marker POM.
16041 If INHERIT is non-nil and the entry does not have the property,
16042 then also check higher levels of the hierarchy. If INHERIT is
16043 the symbol `selective', use inheritance only if the setting in
16044 `org-use-property-inheritance' selects PROPERTY for inheritance.
16046 If the property is present but empty, the return value is the
16047 empty string. If the property is not present at all, nil is
16048 returned. In any other case, return the value as a string.
16049 Search is case-insensitive.
16051 If LITERAL-NIL is set, return the string value \"nil\" as
16052 a string, do not interpret it as the list atom nil. This is used
16053 for inheritance when a \"nil\" value can supersede a non-nil
16054 value higher up the hierarchy."
16055 (org-with-point-at pom
16056 (cond
16057 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
16058 ;; We need a special property. Use `org-entry-properties' to
16059 ;; retrieve it, but specify the wanted property.
16060 (cdr (assoc-string property (org-entry-properties nil property))))
16061 ((and inherit
16062 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
16063 (org-entry-get-with-inheritance property literal-nil))
16065 (let* ((local (org--property-local-values property literal-nil))
16066 (value (and local (mapconcat #'identity (delq nil local) " "))))
16067 (if literal-nil value (org-not-nil value)))))))
16069 (defun org-property-or-variable-value (var &optional inherit)
16070 "Check if there is a property fixing the value of VAR.
16071 If yes, return this value. If not, return the current value of the variable."
16072 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
16073 (if (and prop (stringp prop) (string-match "\\S-" prop))
16074 (read prop)
16075 (symbol-value var))))
16077 (defun org-entry-delete (pom property)
16078 "Delete PROPERTY from entry at point-or-marker POM.
16079 Accumulated properties, i.e. PROPERTY+, are also removed. Return
16080 non-nil when a property was removed."
16081 (org-with-point-at pom
16082 (pcase (org-get-property-block)
16083 (`(,begin . ,origin)
16084 (let* ((end (copy-marker origin))
16085 (re (org-re-property
16086 (concat (regexp-quote property) "\\+?") t t)))
16087 (goto-char begin)
16088 (while (re-search-forward re end t)
16089 (delete-region (match-beginning 0) (line-beginning-position 2)))
16090 ;; If drawer is empty, remove it altogether.
16091 (when (= begin end)
16092 (delete-region (line-beginning-position 0)
16093 (line-beginning-position 2)))
16094 ;; Return non-nil if some property was removed.
16095 (prog1 (/= end origin) (set-marker end nil))))
16096 (_ nil))))
16098 ;; Multi-values properties are properties that contain multiple values
16099 ;; These values are assumed to be single words, separated by whitespace.
16100 (defun org-entry-add-to-multivalued-property (pom property value)
16101 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16102 (let* ((old (org-entry-get pom property))
16103 (values (and old (org-split-string old "[ \t]"))))
16104 (setq value (org-entry-protect-space value))
16105 (unless (member value values)
16106 (setq values (append values (list value)))
16107 (org-entry-put pom property
16108 (mapconcat 'identity values " ")))))
16110 (defun org-entry-remove-from-multivalued-property (pom property value)
16111 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16112 (let* ((old (org-entry-get pom property))
16113 (values (and old (org-split-string old "[ \t]"))))
16114 (setq value (org-entry-protect-space value))
16115 (when (member value values)
16116 (setq values (delete value values))
16117 (org-entry-put pom property
16118 (mapconcat 'identity values " ")))))
16120 (defun org-entry-member-in-multivalued-property (pom property value)
16121 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16122 (let* ((old (org-entry-get pom property))
16123 (values (and old (org-split-string old "[ \t]"))))
16124 (setq value (org-entry-protect-space value))
16125 (member value values)))
16127 (defun org-entry-get-multivalued-property (pom property)
16128 "Return a list of values in a multivalued property."
16129 (let* ((value (org-entry-get pom property))
16130 (values (and value (org-split-string value "[ \t]"))))
16131 (mapcar 'org-entry-restore-space values)))
16133 (defun org-entry-put-multivalued-property (pom property &rest values)
16134 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
16135 VALUES should be a list of strings. Spaces will be protected."
16136 (org-entry-put pom property
16137 (mapconcat 'org-entry-protect-space values " "))
16138 (let* ((value (org-entry-get pom property))
16139 (values (and value (org-split-string value "[ \t]"))))
16140 (mapcar 'org-entry-restore-space values)))
16142 (defun org-entry-protect-space (s)
16143 "Protect spaces and newline in string S."
16144 (while (string-match " " s)
16145 (setq s (replace-match "%20" t t s)))
16146 (while (string-match "\n" s)
16147 (setq s (replace-match "%0A" t t s)))
16150 (defun org-entry-restore-space (s)
16151 "Restore spaces and newline in string S."
16152 (while (string-match "%20" s)
16153 (setq s (replace-match " " t t s)))
16154 (while (string-match "%0A" s)
16155 (setq s (replace-match "\n" t t s)))
16158 (defvar org-entry-property-inherited-from (make-marker)
16159 "Marker pointing to the entry from where a property was inherited.
16160 Each call to `org-entry-get-with-inheritance' will set this marker to the
16161 location of the entry where the inheritance search matched. If there was
16162 no match, the marker will point nowhere.
16163 Note that also `org-entry-get' calls this function, if the INHERIT flag
16164 is set.")
16166 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16167 "Get PROPERTY of entry or content at point, search higher levels if needed.
16168 The search will stop at the first ancestor which has the property defined.
16169 If the value found is \"nil\", return nil to show that the property
16170 should be considered as undefined (this is the meaning of nil here).
16171 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16172 (move-marker org-entry-property-inherited-from nil)
16173 (org-with-wide-buffer
16174 (let (value)
16175 (catch 'exit
16176 (while t
16177 (let ((v (org--property-local-values property literal-nil)))
16178 (when v
16179 (setq value
16180 (concat (mapconcat #'identity (delq nil v) " ")
16181 (and value " ")
16182 value)))
16183 (cond
16184 ((car v)
16185 (org-back-to-heading t)
16186 (move-marker org-entry-property-inherited-from (point))
16187 (throw 'exit nil))
16188 ((org-up-heading-safe))
16190 (let ((global (org--property-global-value property literal-nil)))
16191 (cond ((not global))
16192 (value (setq value (concat global " " value)))
16193 (t (setq value global))))
16194 (throw 'exit nil))))))
16195 (if literal-nil value (org-not-nil value)))))
16197 (defvar org-property-changed-functions nil
16198 "Hook called when the value of a property has changed.
16199 Each hook function should accept two arguments, the name of the property
16200 and the new value.")
16202 (defun org-entry-put (pom property value)
16203 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16205 If the value is nil, it is converted to the empty string. If it
16206 is not a string, an error is raised. Also raise an error on
16207 invalid property names.
16209 PROPERTY can be any regular property (see
16210 `org-special-properties'). It can also be \"TODO\",
16211 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16213 For the last two properties, VALUE may have any of the special
16214 values \"earlier\" and \"later\". The function then increases or
16215 decreases scheduled or deadline date by one day."
16216 (cond ((null value) (setq value ""))
16217 ((not (stringp value)) (error "Properties values should be strings"))
16218 ((not (org--valid-property-p property))
16219 (user-error "Invalid property name: \"%s\"" property)))
16220 (org-with-point-at pom
16221 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16222 (org-back-to-heading t)
16223 (org-with-limited-levels (org-back-to-heading t)))
16224 (let ((beg (point)))
16225 (cond
16226 ((equal property "TODO")
16227 (cond ((not (org-string-nw-p value)) (setq value 'none))
16228 ((not (member value org-todo-keywords-1))
16229 (user-error "\"%s\" is not a valid TODO state" value)))
16230 (org-todo value)
16231 (org-set-tags nil 'align))
16232 ((equal property "PRIORITY")
16233 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16234 (org-set-tags nil 'align))
16235 ((equal property "SCHEDULED")
16236 (forward-line)
16237 (if (and (looking-at-p org-planning-line-re)
16238 (re-search-forward
16239 org-scheduled-time-regexp (line-end-position) t))
16240 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16241 ((string= value "later") (org-timestamp-change 1 'day))
16242 ((string= value "") (org-schedule '(4)))
16243 (t (org-schedule nil value)))
16244 (if (member value '("earlier" "later" ""))
16245 (call-interactively #'org-schedule)
16246 (org-schedule nil value))))
16247 ((equal property "DEADLINE")
16248 (forward-line)
16249 (if (and (looking-at-p org-planning-line-re)
16250 (re-search-forward
16251 org-deadline-time-regexp (line-end-position) t))
16252 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16253 ((string= value "later") (org-timestamp-change 1 'day))
16254 ((string= value "") (org-deadline '(4)))
16255 (t (org-deadline nil value)))
16256 (if (member value '("earlier" "later" ""))
16257 (call-interactively #'org-deadline)
16258 (org-deadline nil value))))
16259 ((member property org-special-properties)
16260 (error "The %s property cannot be set with `org-entry-put'" property))
16262 (let* ((range (org-get-property-block beg 'force))
16263 (end (cdr range))
16264 (case-fold-search t))
16265 (goto-char (car range))
16266 (if (re-search-forward (org-re-property property nil t) end t)
16267 (progn (delete-region (match-beginning 0) (match-end 0))
16268 (goto-char (match-beginning 0)))
16269 (goto-char end)
16270 (insert "\n")
16271 (backward-char))
16272 (insert ":" property ":")
16273 (when value (insert " " value))
16274 (org-indent-line)))))
16275 (run-hook-with-args 'org-property-changed-functions property value)))
16277 (defun org-buffer-property-keys
16278 (&optional specials defaults columns ignore-malformed)
16279 "Get all property keys in the current buffer.
16281 When SPECIALS is non-nil, also list the special properties that
16282 reflect things like tags and TODO state.
16284 When DEFAULTS is non-nil, also include properties that has
16285 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16286 DESCRIPTION, LOCATION, and LOGGING and others.
16288 When COLUMNS in non-nil, also include property names given in
16289 COLUMN formats in the current buffer.
16291 When IGNORE-MALFORMED is non-nil, malformed drawer repair will not be
16292 automatically performed, such drawers will be silently ignored."
16293 (let ((case-fold-search t)
16294 (props (append
16295 (and specials org-special-properties)
16296 (and defaults (cons org-effort-property org-default-properties))
16297 nil)))
16298 (org-with-wide-buffer
16299 (goto-char (point-min))
16300 (while (re-search-forward org-property-start-re nil t)
16301 (let ((range (org-get-property-block)))
16302 (catch 'skip
16303 (unless range
16304 (when (and (not ignore-malformed)
16305 (not (org-before-first-heading-p))
16306 (y-or-n-p (format "Malformed drawer at %d, repair?"
16307 (line-beginning-position))))
16308 (org-get-property-block nil t))
16309 (throw 'skip nil))
16310 (goto-char (car range))
16311 (let ((begin (car range))
16312 (end (cdr range)))
16313 ;; Make sure that found property block is not located
16314 ;; before current point, as it would generate an infloop.
16315 ;; It can happen, for example, in the following
16316 ;; situation:
16318 ;; * Headline
16319 ;; :PROPERTIES:
16320 ;; ...
16321 ;; :END:
16322 ;; *************** Inlinetask
16323 ;; #+BEGIN_EXAMPLE
16324 ;; :PROPERTIES:
16325 ;; #+END_EXAMPLE
16327 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16328 (while (< (point) end)
16329 (let ((p (progn (looking-at org-property-re)
16330 (match-string-no-properties 2))))
16331 ;; Only add true property name, not extension symbol.
16332 (push (if (not (string-match-p "\\+\\'" p)) p
16333 (substring p 0 -1))
16334 props))
16335 (forward-line))))
16336 (outline-next-heading)))
16337 (when columns
16338 (goto-char (point-min))
16339 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16340 (let ((element (org-element-at-point)))
16341 (when (memq (org-element-type element) '(keyword node-property))
16342 (let ((value (org-element-property :value element))
16343 (start 0))
16344 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16345 (setq start (match-end 0))
16346 (let ((p (match-string-no-properties 1 value)))
16347 (unless (member-ignore-case p org-special-properties)
16348 (push p props))))))))))
16349 (sort (delete-dups props) (lambda (a b) (string< (upcase a) (upcase b))))))
16351 (defun org-property-values (key)
16352 "List all non-nil values of property KEY in current buffer."
16353 (org-with-wide-buffer
16354 (goto-char (point-min))
16355 (let ((case-fold-search t)
16356 (re (org-re-property key))
16357 values)
16358 (while (re-search-forward re nil t)
16359 (push (org-entry-get (point) key) values))
16360 (delete-dups values))))
16362 (defun org-insert-property-drawer ()
16363 "Insert a property drawer into the current entry."
16364 (org-with-wide-buffer
16365 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16366 (org-back-to-heading t)
16367 (org-with-limited-levels (org-back-to-heading t)))
16368 (forward-line)
16369 (when (looking-at-p org-planning-line-re) (forward-line))
16370 (unless (looking-at-p org-property-drawer-re)
16371 ;; Make sure we start editing a line from current entry, not from
16372 ;; next one. It prevents extending text properties or overlays
16373 ;; belonging to the latter.
16374 (when (bolp) (backward-char))
16375 (let ((begin (1+ (point)))
16376 (inhibit-read-only t))
16377 (insert "\n:PROPERTIES:\n:END:")
16378 (when (eobp) (insert "\n"))
16379 (org-indent-region begin (point))))))
16381 (defun org-insert-drawer (&optional arg drawer)
16382 "Insert a drawer at point.
16384 When optional argument ARG is non-nil, insert a property drawer.
16386 Optional argument DRAWER, when non-nil, is a string representing
16387 drawer's name. Otherwise, the user is prompted for a name.
16389 If a region is active, insert the drawer around that region
16390 instead.
16392 Point is left between drawer's boundaries."
16393 (interactive "P")
16394 (let* ((drawer (if arg "PROPERTIES"
16395 (or drawer (read-from-minibuffer "Drawer: ")))))
16396 (cond
16397 ;; With C-u, fall back on `org-insert-property-drawer'
16398 (arg (org-insert-property-drawer))
16399 ;; Check validity of suggested drawer's name.
16400 ((not (string-match-p org-drawer-regexp (format ":%s:" drawer)))
16401 (user-error "Invalid drawer name"))
16402 ;; With an active region, insert a drawer at point.
16403 ((not (org-region-active-p))
16404 (progn
16405 (unless (bolp) (insert "\n"))
16406 (insert (format ":%s:\n\n:END:\n" drawer))
16407 (forward-line -2)))
16408 ;; Otherwise, insert the drawer at point
16410 (let ((rbeg (region-beginning))
16411 (rend (copy-marker (region-end))))
16412 (unwind-protect
16413 (progn
16414 (goto-char rbeg)
16415 (beginning-of-line)
16416 (when (save-excursion
16417 (re-search-forward org-outline-regexp-bol rend t))
16418 (user-error "Drawers cannot contain headlines"))
16419 ;; Position point at the beginning of the first
16420 ;; non-blank line in region. Insert drawer's opening
16421 ;; there, then indent it.
16422 (org-skip-whitespace)
16423 (beginning-of-line)
16424 (insert ":" drawer ":\n")
16425 (forward-line -1)
16426 (indent-for-tab-command)
16427 ;; Move point to the beginning of the first blank line
16428 ;; after the last non-blank line in region. Insert
16429 ;; drawer's closing, then indent it.
16430 (goto-char rend)
16431 (skip-chars-backward " \r\t\n")
16432 (insert "\n:END:")
16433 (deactivate-mark t)
16434 (indent-for-tab-command)
16435 (unless (eolp) (insert "\n")))
16436 ;; Clear marker, whatever the outcome of insertion is.
16437 (set-marker rend nil)))))))
16439 (defvar org-property-set-functions-alist nil
16440 "Property set function alist.
16441 Each entry should have the following format:
16443 (PROPERTY . READ-FUNCTION)
16445 The read function will be called with the same argument as
16446 `org-completing-read'.")
16448 (defun org-set-property-function (property)
16449 "Get the function that should be used to set PROPERTY.
16450 This is computed according to `org-property-set-functions-alist'."
16451 (or (cdr (assoc property org-property-set-functions-alist))
16452 'org-completing-read))
16454 (defun org-read-property-value (property)
16455 "Read PROPERTY value from user."
16456 (let* ((completion-ignore-case t)
16457 (allowed (org-property-get-allowed-values nil property 'table))
16458 (cur (org-entry-get nil property))
16459 (prompt (concat property " value"
16460 (if (and cur (string-match "\\S-" cur))
16461 (concat " [" cur "]") "") ": "))
16462 (set-function (org-set-property-function property))
16463 (val (if allowed
16464 (funcall set-function prompt allowed nil
16465 (not (get-text-property 0 'org-unrestricted
16466 (caar allowed))))
16467 (funcall set-function prompt
16468 (mapcar 'list (org-property-values property))
16469 nil nil "" nil cur))))
16470 (org-trim val)))
16472 (defvar org-last-set-property nil)
16473 (defvar org-last-set-property-value nil)
16474 (defun org-read-property-name ()
16475 "Read a property name."
16476 (let ((completion-ignore-case t)
16477 (default-prop (or (and (org-at-property-p)
16478 (match-string-no-properties 2))
16479 org-last-set-property)))
16480 (org-completing-read
16481 (concat "Property"
16482 (if default-prop (concat " [" default-prop "]") "")
16483 ": ")
16484 (mapcar #'list (org-buffer-property-keys nil t t))
16485 nil nil nil nil default-prop)))
16487 (defun org-set-property-and-value (use-last)
16488 "Allow to set [PROPERTY]: [value] direction from prompt.
16489 When use-default, don't even ask, just use the last
16490 \"[PROPERTY]: [value]\" string from the history."
16491 (interactive "P")
16492 (let* ((completion-ignore-case t)
16493 (pv (or (and use-last org-last-set-property-value)
16494 (org-completing-read
16495 "Enter a \"[Property]: [value]\" pair: "
16496 nil nil nil nil nil
16497 org-last-set-property-value)))
16498 prop val)
16499 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16500 (setq prop (match-string 1 pv)
16501 val (match-string 2 pv))
16502 (org-set-property prop val))))
16504 (defun org-set-property (property value)
16505 "In the current entry, set PROPERTY to VALUE.
16507 When called interactively, this will prompt for a property name, offering
16508 completion on existing and default properties. And then it will prompt
16509 for a value, offering completion either on allowed values (via an inherited
16510 xxx_ALL property) or on existing values in other instances of this property
16511 in the current file.
16513 Throw an error when trying to set a property with an invalid name."
16514 (interactive (list nil nil))
16515 (let ((property (or property (org-read-property-name))))
16516 ;; `org-entry-put' also makes the following check, but this one
16517 ;; avoids polluting `org-last-set-property' and
16518 ;; `org-last-set-property-value' needlessly.
16519 (unless (org--valid-property-p property)
16520 (user-error "Invalid property name: \"%s\"" property))
16521 (let ((value (or value (org-read-property-value property)))
16522 (fn (cdr (assoc-string property org-properties-postprocess-alist t))))
16523 (setq org-last-set-property property)
16524 (setq org-last-set-property-value (concat property ": " value))
16525 ;; Possibly postprocess the inserted value:
16526 (when fn (setq value (funcall fn value)))
16527 (unless (equal (org-entry-get nil property) value)
16528 (org-entry-put nil property value)))))
16530 (defun org-find-property (property &optional value)
16531 "Find first entry in buffer that sets PROPERTY.
16533 When optional argument VALUE is non-nil, only consider an entry
16534 if it contains PROPERTY set to this value. If PROPERTY should be
16535 explicitly set to nil, use string \"nil\" for VALUE.
16537 Return position where the entry begins, or nil if there is no
16538 such entry. If narrowing is in effect, only search the visible
16539 part of the buffer."
16540 (save-excursion
16541 (goto-char (point-min))
16542 (let ((case-fold-search t)
16543 (re (org-re-property property nil (not value) value)))
16544 (catch 'exit
16545 (while (re-search-forward re nil t)
16546 (when (if value (org-at-property-p)
16547 (org-entry-get (point) property nil t))
16548 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16550 (defun org-delete-property (property)
16551 "In the current entry, delete PROPERTY."
16552 (interactive
16553 (let* ((completion-ignore-case t)
16554 (cat (org-entry-get (point) "CATEGORY"))
16555 (props0 (org-entry-properties nil 'standard))
16556 (props (if cat props0
16557 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16558 (prop (if (< 1 (length props))
16559 (completing-read "Property: " props nil t)
16560 (caar props))))
16561 (list prop)))
16562 (if (not property)
16563 (message "No property to delete in this entry")
16564 (org-entry-delete nil property)
16565 (message "Property \"%s\" deleted" property)))
16567 (defun org-delete-property-globally (property)
16568 "Remove PROPERTY globally, from all entries.
16569 This function ignores narrowing, if any."
16570 (interactive
16571 (let* ((completion-ignore-case t)
16572 (prop (completing-read
16573 "Globally remove property: "
16574 (mapcar #'list (org-buffer-property-keys)))))
16575 (list prop)))
16576 (org-with-wide-buffer
16577 (goto-char (point-min))
16578 (let ((count 0)
16579 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16580 (while (re-search-forward re nil t)
16581 (when (org-entry-delete (point) property) (cl-incf count)))
16582 (message "Property \"%s\" removed from %d entries" property count))))
16584 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16586 (defun org-compute-property-at-point ()
16587 "Compute the property at point.
16588 This looks for an enclosing column format, extracts the operator and
16589 then applies it to the property in the column format's scope."
16590 (interactive)
16591 (unless (org-at-property-p)
16592 (user-error "Not at a property"))
16593 (let ((prop (match-string-no-properties 2)))
16594 (org-columns-get-format-and-top-level)
16595 (unless (nth 3 (assoc-string prop org-columns-current-fmt-compiled t))
16596 (user-error "No operator defined for property %s" prop))
16597 (org-columns-compute prop)))
16599 (defvar org-property-allowed-value-functions nil
16600 "Hook for functions supplying allowed values for a specific property.
16601 The functions must take a single argument, the name of the property, and
16602 return a flat list of allowed values. If \":ETC\" is one of
16603 the values, this means that these values are intended as defaults for
16604 completion, but that other values should be allowed too.
16605 The functions must return nil if they are not responsible for this
16606 property.")
16608 (defun org-property-get-allowed-values (pom property &optional table)
16609 "Get allowed values for the property PROPERTY.
16610 When TABLE is non-nil, return an alist that can directly be used for
16611 completion."
16612 (let (vals)
16613 (cond
16614 ((equal property "TODO")
16615 (setq vals (org-with-point-at pom
16616 (append org-todo-keywords-1 '("")))))
16617 ((equal property "PRIORITY")
16618 (let ((n org-lowest-priority))
16619 (while (>= n org-highest-priority)
16620 (push (char-to-string n) vals)
16621 (setq n (1- n)))))
16622 ((equal property "CATEGORY"))
16623 ((member property org-special-properties))
16624 ((setq vals (run-hook-with-args-until-success
16625 'org-property-allowed-value-functions property)))
16627 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16628 (when (and vals (string-match "\\S-" vals))
16629 (setq vals (car (read-from-string (concat "(" vals ")"))))
16630 (setq vals (mapcar (lambda (x)
16631 (cond ((stringp x) x)
16632 ((numberp x) (number-to-string x))
16633 ((symbolp x) (symbol-name x))
16634 (t "???")))
16635 vals)))))
16636 (when (member ":ETC" vals)
16637 (setq vals (remove ":ETC" vals))
16638 (org-add-props (car vals) '(org-unrestricted t)))
16639 (if table (mapcar 'list vals) vals)))
16641 (defun org-property-previous-allowed-value (&optional _previous)
16642 "Switch to the next allowed value for this property."
16643 (interactive)
16644 (org-property-next-allowed-value t))
16646 (defun org-property-next-allowed-value (&optional previous)
16647 "Switch to the next allowed value for this property."
16648 (interactive)
16649 (unless (org-at-property-p)
16650 (user-error "Not at a property"))
16651 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16652 (key (match-string 2))
16653 (value (match-string 3))
16654 (allowed (or (org-property-get-allowed-values (point) key)
16655 (and (member value '("[ ]" "[-]" "[X]"))
16656 '("[ ]" "[X]"))))
16657 (heading (save-match-data (nth 4 (org-heading-components))))
16658 nval)
16659 (unless allowed
16660 (user-error "Allowed values for this property have not been defined"))
16661 (when previous (setq allowed (reverse allowed)))
16662 (when (member value allowed)
16663 (setq nval (car (cdr (member value allowed)))))
16664 (setq nval (or nval (car allowed)))
16665 (when (equal nval value)
16666 (user-error "Only one allowed value for this property"))
16667 (org-at-property-p)
16668 (replace-match (concat " :" key ": " nval) t t)
16669 (org-indent-line)
16670 (beginning-of-line 1)
16671 (skip-chars-forward " \t")
16672 (when (equal prop org-effort-property)
16673 (org-refresh-property
16674 '((effort . identity)
16675 (effort-minutes . org-duration-string-to-minutes))
16676 nval)
16677 (when (string= org-clock-current-task heading)
16678 (setq org-clock-effort nval)
16679 (org-clock-update-mode-line)))
16680 (run-hook-with-args 'org-property-changed-functions key nval)))
16682 (defun org-find-olp (path &optional this-buffer)
16683 "Return a marker pointing to the entry at outline path OLP.
16684 If anything goes wrong, throw an error.
16685 You can wrap this call to catch the error like this:
16687 (condition-case msg
16688 (org-mobile-locate-entry (match-string 4))
16689 (error (nth 1 msg)))
16691 The return value will then be either a string with the error message,
16692 or a marker if everything is OK.
16694 If THIS-BUFFER is set, the outline path does not contain a file,
16695 only headings."
16696 (let* ((file (if this-buffer buffer-file-name (pop path)))
16697 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16698 (level 1)
16699 (lmin 1)
16700 (lmax 1)
16701 end found flevel)
16702 (unless buffer (error "File not found :%s" file))
16703 (with-current-buffer buffer
16704 (org-with-wide-buffer
16705 (goto-char (point-min))
16706 (dolist (heading path)
16707 (let ((re (format org-complex-heading-regexp-format
16708 (regexp-quote heading)))
16709 (cnt 0))
16710 (while (re-search-forward re end t)
16711 (setq level (- (match-end 1) (match-beginning 1)))
16712 (when (and (>= level lmin) (<= level lmax))
16713 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16714 (when (= cnt 0)
16715 (error "Heading not found on level %d: %s" lmax heading))
16716 (when (> cnt 1)
16717 (error "Heading not unique on level %d: %s" lmax heading))
16718 (goto-char found)
16719 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16720 (setq end (save-excursion (org-end-of-subtree t t)))))
16721 (when (org-at-heading-p)
16722 (point-marker))))))
16724 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16725 "Find node HEADING in BUFFER.
16726 Return a marker to the heading if it was found, or nil if not.
16727 If POS-ONLY is set, return just the position instead of a marker.
16729 The heading text must match exact, but it may have a TODO keyword,
16730 a priority cookie and tags in the standard locations."
16731 (with-current-buffer (or buffer (current-buffer))
16732 (org-with-wide-buffer
16733 (goto-char (point-min))
16734 (let (case-fold-search)
16735 (when (re-search-forward
16736 (format org-complex-heading-regexp-format
16737 (regexp-quote heading)) nil t)
16738 (if pos-only
16739 (match-beginning 0)
16740 (move-marker (make-marker) (match-beginning 0))))))))
16742 (defun org-find-exact-heading-in-directory (heading &optional dir)
16743 "Find Org node headline HEADING in all .org files in directory DIR.
16744 When the target headline is found, return a marker to this location."
16745 (let ((files (directory-files (or dir default-directory)
16746 t "\\`[^.#].*\\.org\\'"))
16747 visiting m buffer)
16748 (catch 'found
16749 (dolist (file files)
16750 (message "trying %s" file)
16751 (setq visiting (org-find-base-buffer-visiting file))
16752 (setq buffer (or visiting (find-file-noselect file)))
16753 (setq m (org-find-exact-headline-in-buffer
16754 heading buffer))
16755 (when (and (not m) (not visiting)) (kill-buffer buffer))
16756 (and m (throw 'found m))))))
16758 (defun org-find-entry-with-id (ident)
16759 "Locate the entry that contains the ID property with exact value IDENT.
16760 IDENT can be a string, a symbol or a number, this function will search for
16761 the string representation of it.
16762 Return the position where this entry starts, or nil if there is no such entry."
16763 (interactive "sID: ")
16764 (let ((id (cond
16765 ((stringp ident) ident)
16766 ((symbolp ident) (symbol-name ident))
16767 ((numberp ident) (number-to-string ident))
16768 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16769 (org-with-wide-buffer (org-find-property "ID" id))))
16771 ;;;; Timestamps
16773 (defvar org-last-changed-timestamp nil)
16774 (defvar org-last-inserted-timestamp nil
16775 "The last time stamp inserted with `org-insert-time-stamp'.")
16776 (defvar org-ts-what) ; dynamically scoped parameter
16778 (defun org-time-stamp (arg &optional inactive)
16779 "Prompt for a date/time and insert a time stamp.
16781 If the user specifies a time like HH:MM or if this command is
16782 called with at least one prefix argument, the time stamp contains
16783 the date and the time. Otherwise, only the date is included.
16785 All parts of a date not specified by the user are filled in from
16786 the timestamp at point, if any, or the current date/time
16787 otherwise.
16789 If there is already a timestamp at the cursor, it is replaced.
16791 With two universal prefix arguments, insert an active timestamp
16792 with the current time without prompting the user.
16794 When called from lisp, the timestamp is inactive if INACTIVE is
16795 non-nil."
16796 (interactive "P")
16797 (let* ((ts (cond
16798 ((org-at-date-range-p t)
16799 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16800 ((org-at-timestamp-p t) (match-string 0))))
16801 ;; Default time is either the timestamp at point or today.
16802 ;; When entering a range, only the range start is considered.
16803 (default-time (if (not ts) (current-time)
16804 (apply #'encode-time (org-parse-time-string ts))))
16805 (default-input (and ts (org-get-compact-tod ts)))
16806 (repeater (and ts
16807 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16808 (match-string 0 ts)))
16809 org-time-was-given
16810 org-end-time-was-given
16811 (time
16812 (and (if (equal arg '(16)) (current-time)
16813 ;; Preserve `this-command' and `last-command'.
16814 (let ((this-command this-command)
16815 (last-command last-command))
16816 (org-read-date
16817 arg 'totime nil nil default-time default-input
16818 inactive))))))
16819 (cond
16820 ((and ts
16821 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16822 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16823 (insert "--")
16824 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16826 ;; Make sure we're on a timestamp. When in the middle of a date
16827 ;; range, move arbitrarily to range end.
16828 (unless (org-at-timestamp-p t)
16829 (skip-chars-forward "-")
16830 (org-at-timestamp-p t))
16831 (replace-match "")
16832 (setq org-last-changed-timestamp
16833 (org-insert-time-stamp
16834 time (or org-time-was-given arg)
16835 inactive nil nil (list org-end-time-was-given)))
16836 (when repeater
16837 (backward-char)
16838 (insert " " repeater)
16839 (setq org-last-changed-timestamp
16840 (concat (substring org-last-inserted-timestamp 0 -1)
16841 " " repeater ">")))
16842 (message "Timestamp updated"))
16843 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16844 (t (org-insert-time-stamp
16845 time (or org-time-was-given arg) inactive nil nil
16846 (list org-end-time-was-given))))))
16848 ;; FIXME: can we use this for something else, like computing time differences?
16849 (defun org-get-compact-tod (s)
16850 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16851 (let* ((t1 (match-string 1 s))
16852 (h1 (string-to-number (match-string 2 s)))
16853 (m1 (string-to-number (match-string 3 s)))
16854 (t2 (and (match-end 4) (match-string 5 s)))
16855 (h2 (and t2 (string-to-number (match-string 6 s))))
16856 (m2 (and t2 (string-to-number (match-string 7 s))))
16857 dh dm)
16858 (if (not t2)
16860 (setq dh (- h2 h1) dm (- m2 m1))
16861 (when (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16862 (concat t1 "+" (number-to-string dh)
16863 (and (/= 0 dm) (format ":%02d" dm)))))))
16865 (defun org-time-stamp-inactive (&optional arg)
16866 "Insert an inactive time stamp.
16867 An inactive time stamp is enclosed in square brackets instead of angle
16868 brackets. It is inactive in the sense that it does not trigger agenda entries,
16869 does not link to the calendar and cannot be changed with the S-cursor keys.
16870 So these are more for recording a certain time/date."
16871 (interactive "P")
16872 (org-time-stamp arg 'inactive))
16874 (defvar org-date-ovl (make-overlay 1 1))
16875 (overlay-put org-date-ovl 'face 'org-date-selected)
16876 (delete-overlay org-date-ovl)
16878 (defvar org-ans1) ; dynamically scoped parameter
16879 (defvar org-ans2) ; dynamically scoped parameter
16881 (defvar org-plain-time-of-day-regexp) ; defined below
16883 (defvar org-overriding-default-time nil) ; dynamically scoped
16884 (defvar org-read-date-overlay nil)
16885 (defvar org-dcst nil) ; dynamically scoped
16886 (defvar org-read-date-history nil)
16887 (defvar org-read-date-final-answer nil)
16888 (defvar org-read-date-analyze-futurep nil)
16889 (defvar org-read-date-analyze-forced-year nil)
16890 (defvar org-read-date-inactive)
16892 (defvar org-read-date-minibuffer-local-map
16893 (let* ((map (make-sparse-keymap)))
16894 (set-keymap-parent map minibuffer-local-map)
16895 (org-defkey map (kbd ".")
16896 (lambda () (interactive)
16897 ;; Are we at the beginning of the prompt?
16898 (if (looking-back "^[^:]+: "
16899 (let ((inhibit-field-text-motion t))
16900 (line-beginning-position)))
16901 (org-eval-in-calendar '(calendar-goto-today))
16902 (insert "."))))
16903 (org-defkey map (kbd "C-.")
16904 (lambda () (interactive)
16905 (org-eval-in-calendar '(calendar-goto-today))))
16906 (org-defkey map [(meta shift left)]
16907 (lambda () (interactive)
16908 (org-eval-in-calendar '(calendar-backward-month 1))))
16909 (org-defkey map [(meta shift right)]
16910 (lambda () (interactive)
16911 (org-eval-in-calendar '(calendar-forward-month 1))))
16912 (org-defkey map [(meta shift up)]
16913 (lambda () (interactive)
16914 (org-eval-in-calendar '(calendar-backward-year 1))))
16915 (org-defkey map [(meta shift down)]
16916 (lambda () (interactive)
16917 (org-eval-in-calendar '(calendar-forward-year 1))))
16918 (org-defkey map [?\e (shift left)]
16919 (lambda () (interactive)
16920 (org-eval-in-calendar '(calendar-backward-month 1))))
16921 (org-defkey map [?\e (shift right)]
16922 (lambda () (interactive)
16923 (org-eval-in-calendar '(calendar-forward-month 1))))
16924 (org-defkey map [?\e (shift up)]
16925 (lambda () (interactive)
16926 (org-eval-in-calendar '(calendar-backward-year 1))))
16927 (org-defkey map [?\e (shift down)]
16928 (lambda () (interactive)
16929 (org-eval-in-calendar '(calendar-forward-year 1))))
16930 (org-defkey map [(shift up)]
16931 (lambda () (interactive)
16932 (org-eval-in-calendar '(calendar-backward-week 1))))
16933 (org-defkey map [(shift down)]
16934 (lambda () (interactive)
16935 (org-eval-in-calendar '(calendar-forward-week 1))))
16936 (org-defkey map [(shift left)]
16937 (lambda () (interactive)
16938 (org-eval-in-calendar '(calendar-backward-day 1))))
16939 (org-defkey map [(shift right)]
16940 (lambda () (interactive)
16941 (org-eval-in-calendar '(calendar-forward-day 1))))
16942 (org-defkey map "!"
16943 (lambda () (interactive)
16944 (org-eval-in-calendar '(diary-view-entries))
16945 (message "")))
16946 (org-defkey map ">"
16947 (lambda () (interactive)
16948 (org-eval-in-calendar '(calendar-scroll-left 1))))
16949 (org-defkey map "<"
16950 (lambda () (interactive)
16951 (org-eval-in-calendar '(calendar-scroll-right 1))))
16952 (org-defkey map "\C-v"
16953 (lambda () (interactive)
16954 (org-eval-in-calendar
16955 '(calendar-scroll-left-three-months 1))))
16956 (org-defkey map "\M-v"
16957 (lambda () (interactive)
16958 (org-eval-in-calendar
16959 '(calendar-scroll-right-three-months 1))))
16960 map)
16961 "Keymap for minibuffer commands when using `org-read-date'.")
16963 (defvar org-def)
16964 (defvar org-defdecode)
16965 (defvar org-with-time)
16967 (defvar calendar-setup) ; Dynamically scoped.
16968 (defun org-read-date (&optional with-time to-time from-string prompt
16969 default-time default-input inactive)
16970 "Read a date, possibly a time, and make things smooth for the user.
16971 The prompt will suggest to enter an ISO date, but you can also enter anything
16972 which will at least partially be understood by `parse-time-string'.
16973 Unrecognized parts of the date will default to the current day, month, year,
16974 hour and minute. If this command is called to replace a timestamp at point,
16975 or to enter the second timestamp of a range, the default time is taken
16976 from the existing stamp. Furthermore, the command prefers the future,
16977 so if you are giving a date where the year is not given, and the day-month
16978 combination is already past in the current year, it will assume you
16979 mean next year. For details, see the manual. A few examples:
16981 3-2-5 --> 2003-02-05
16982 feb 15 --> currentyear-02-15
16983 2/15 --> currentyear-02-15
16984 sep 12 9 --> 2009-09-12
16985 12:45 --> today 12:45
16986 22 sept 0:34 --> currentyear-09-22 0:34
16987 12 --> currentyear-currentmonth-12
16988 Fri --> nearest Friday after today
16989 -Tue --> last Tuesday
16990 etc.
16992 Furthermore you can specify a relative date by giving, as the *first* thing
16993 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16994 change in days weeks, months, years.
16995 With a single plus or minus, the date is relative to today. With a double
16996 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16997 +4d --> four days from today
16998 +4 --> same as above
16999 +2w --> two weeks from today
17000 ++5 --> five days from default date
17002 The function understands only English month and weekday abbreviations.
17004 While prompting, a calendar is popped up - you can also select the
17005 date with the mouse (button 1). The calendar shows a period of three
17006 months. To scroll it to other months, use the keys `>' and `<'.
17007 If you don't like the calendar, turn it off with
17008 (setq org-read-date-popup-calendar nil)
17010 With optional argument TO-TIME, the date will immediately be converted
17011 to an internal time.
17012 With an optional argument WITH-TIME, the prompt will suggest to
17013 also insert a time. Note that when WITH-TIME is not set, you can
17014 still enter a time, and this function will inform the calling routine
17015 about this change. The calling routine may then choose to change the
17016 format used to insert the time stamp into the buffer to include the time.
17017 With optional argument FROM-STRING, read from this string instead from
17018 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17019 the time/date that is used for everything that is not specified by the
17020 user."
17021 (require 'parse-time)
17022 (let* ((org-with-time with-time)
17023 (org-time-stamp-rounding-minutes
17024 (if (equal org-with-time '(16))
17025 '(0 0)
17026 org-time-stamp-rounding-minutes))
17027 (org-dcst org-display-custom-times)
17028 (ct (org-current-time))
17029 (org-def (or org-overriding-default-time default-time ct))
17030 (org-defdecode (decode-time org-def))
17031 (cur-frame (selected-frame))
17032 (mouse-autoselect-window nil) ; Don't let the mouse jump
17033 (calendar-setup
17034 (and (eq calendar-setup 'calendar-only) 'calendar-only))
17035 (calendar-move-hook nil)
17036 (calendar-view-diary-initially-flag nil)
17037 (calendar-view-holidays-initially-flag nil)
17038 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
17039 ;; Rationalize `org-def' and `org-defdecode', if required.
17040 (when (< (nth 2 org-defdecode) org-extend-today-until)
17041 (setf (nth 2 org-defdecode) -1)
17042 (setf (nth 1 org-defdecode) 59)
17043 (setq org-def (apply #'encode-time org-defdecode))
17044 (setq org-defdecode (decode-time org-def)))
17045 (let* ((timestr (format-time-string
17046 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d")
17047 org-def))
17048 (prompt (concat (if prompt (concat prompt " ") "")
17049 (format "Date+time [%s]: " timestr))))
17050 (cond
17051 (from-string (setq ans from-string))
17052 (org-read-date-popup-calendar
17053 (save-excursion
17054 (save-window-excursion
17055 (calendar)
17056 (when (eq calendar-setup 'calendar-only)
17057 (setq cal-frame
17058 (window-frame (get-buffer-window "*Calendar*" 'visible)))
17059 (select-frame cal-frame))
17060 (org-eval-in-calendar '(setq cursor-type nil) t)
17061 (unwind-protect
17062 (progn
17063 (calendar-forward-day (- (time-to-days org-def)
17064 (calendar-absolute-from-gregorian
17065 (calendar-current-date))))
17066 (org-eval-in-calendar nil t)
17067 (let* ((old-map (current-local-map))
17068 (map (copy-keymap calendar-mode-map))
17069 (minibuffer-local-map
17070 (copy-keymap org-read-date-minibuffer-local-map)))
17071 (org-defkey map (kbd "RET") 'org-calendar-select)
17072 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
17073 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
17074 (unwind-protect
17075 (progn
17076 (use-local-map map)
17077 (setq org-read-date-inactive inactive)
17078 (add-hook 'post-command-hook 'org-read-date-display)
17079 (setq org-ans0
17080 (read-string prompt
17081 default-input
17082 'org-read-date-history
17083 nil))
17084 ;; org-ans0: from prompt
17085 ;; org-ans1: from mouse click
17086 ;; org-ans2: from calendar motion
17087 (setq ans
17088 (concat org-ans0 " " (or org-ans1 org-ans2))))
17089 (remove-hook 'post-command-hook 'org-read-date-display)
17090 (use-local-map old-map)
17091 (when org-read-date-overlay
17092 (delete-overlay org-read-date-overlay)
17093 (setq org-read-date-overlay nil)))))
17094 (bury-buffer "*Calendar*")
17095 (when cal-frame
17096 (delete-frame cal-frame)
17097 (select-frame-set-input-focus cur-frame))))))
17099 (t ; Naked prompt only
17100 (unwind-protect
17101 (setq ans (read-string prompt default-input
17102 'org-read-date-history timestr))
17103 (when org-read-date-overlay
17104 (delete-overlay org-read-date-overlay)
17105 (setq org-read-date-overlay nil))))))
17107 (setq final (org-read-date-analyze ans org-def org-defdecode))
17109 (when org-read-date-analyze-forced-year
17110 (message "Year was forced into %s"
17111 (if org-read-date-force-compatible-dates
17112 "compatible range (1970-2037)"
17113 "range representable on this machine"))
17114 (ding))
17116 ;; One round trip to get rid of 34th of August and stuff like that....
17117 (setq final (decode-time (apply 'encode-time final)))
17119 (setq org-read-date-final-answer ans)
17121 (if to-time
17122 (apply 'encode-time final)
17123 (if (and (boundp 'org-time-was-given) org-time-was-given)
17124 (format "%04d-%02d-%02d %02d:%02d"
17125 (nth 5 final) (nth 4 final) (nth 3 final)
17126 (nth 2 final) (nth 1 final))
17127 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
17129 (defun org-read-date-display ()
17130 "Display the current date prompt interpretation in the minibuffer."
17131 (when org-read-date-display-live
17132 (when org-read-date-overlay
17133 (delete-overlay org-read-date-overlay))
17134 (when (minibufferp (current-buffer))
17135 (save-excursion
17136 (end-of-line 1)
17137 (while (not (equal (buffer-substring
17138 (max (point-min) (- (point) 4)) (point))
17139 " "))
17140 (insert " ")))
17141 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
17142 " " (or org-ans1 org-ans2)))
17143 (org-end-time-was-given nil)
17144 (f (org-read-date-analyze ans org-def org-defdecode))
17145 (fmts (if org-dcst
17146 org-time-stamp-custom-formats
17147 org-time-stamp-formats))
17148 (fmt (if (or org-with-time
17149 (and (boundp 'org-time-was-given) org-time-was-given))
17150 (cdr fmts)
17151 (car fmts)))
17152 (txt (format-time-string fmt (apply 'encode-time f)))
17153 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
17154 (txt (concat "=> " txt)))
17155 (when (and org-end-time-was-given
17156 (string-match org-plain-time-of-day-regexp txt))
17157 (setq txt (concat (substring txt 0 (match-end 0)) "-"
17158 org-end-time-was-given
17159 (substring txt (match-end 0)))))
17160 (when org-read-date-analyze-futurep
17161 (setq txt (concat txt " (=>F)")))
17162 (setq org-read-date-overlay
17163 (make-overlay (1- (point-at-eol)) (point-at-eol)))
17164 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
17166 (defun org-read-date-analyze (ans def defdecode)
17167 "Analyze the combined answer of the date prompt."
17168 ;; FIXME: cleanup and comment
17169 ;; Pass `current-time' result to `decode-time' (instead of calling
17170 ;; without arguments) so that only `current-time' has to be
17171 ;; overriden in tests.
17172 (let ((org-def def)
17173 (org-defdecode defdecode)
17174 (nowdecode (decode-time (current-time)))
17175 delta deltan deltaw deltadef year month day
17176 hour minute second wday pm h2 m2 tl wday1
17177 iso-year iso-weekday iso-week iso-date futurep kill-year)
17178 (setq org-read-date-analyze-futurep nil
17179 org-read-date-analyze-forced-year nil)
17180 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17181 (setq ans "+0"))
17183 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17184 (setq ans (replace-match "" t t ans)
17185 deltan (car delta)
17186 deltaw (nth 1 delta)
17187 deltadef (nth 2 delta)))
17189 ;; Check if there is an iso week date in there. If yes, store the
17190 ;; info and postpone interpreting it until the rest of the parsing
17191 ;; is done.
17192 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17193 (setq iso-year (when (match-end 1)
17194 (org-small-year-to-year
17195 (string-to-number (match-string 1 ans))))
17196 iso-weekday (when (match-end 3)
17197 (string-to-number (match-string 3 ans)))
17198 iso-week (string-to-number (match-string 2 ans)))
17199 (setq ans (replace-match "" t t ans)))
17201 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17202 (when (string-match
17203 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17204 (setq year (if (match-end 2)
17205 (string-to-number (match-string 2 ans))
17206 (progn (setq kill-year t)
17207 (string-to-number (format-time-string "%Y"))))
17208 month (string-to-number (match-string 3 ans))
17209 day (string-to-number (match-string 4 ans)))
17210 (setq year (org-small-year-to-year year))
17211 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17212 t nil ans)))
17214 ;; Help matching dotted european dates
17215 (when (string-match
17216 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17217 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17218 (setq kill-year t)
17219 (string-to-number (format-time-string "%Y")))
17220 day (string-to-number (match-string 1 ans))
17221 month (string-to-number (match-string 2 ans))
17222 ans (replace-match (format "%04d-%02d-%02d" year month day)
17223 t nil ans)))
17225 ;; Help matching american dates, like 5/30 or 5/30/7
17226 (when (string-match
17227 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17228 (setq year (if (match-end 4)
17229 (string-to-number (match-string 4 ans))
17230 (progn (setq kill-year t)
17231 (string-to-number (format-time-string "%Y"))))
17232 month (string-to-number (match-string 1 ans))
17233 day (string-to-number (match-string 2 ans)))
17234 (setq year (org-small-year-to-year year))
17235 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17236 t nil ans)))
17237 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17238 ;; If there is a time with am/pm, and *no* time without it, we convert
17239 ;; so that matching will be successful.
17240 (cl-loop for i from 1 to 2 do ; twice, for end time as well
17241 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17242 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17243 (setq hour (string-to-number (match-string 1 ans))
17244 minute (if (match-end 3)
17245 (string-to-number (match-string 3 ans))
17247 pm (equal ?p
17248 (string-to-char (downcase (match-string 4 ans)))))
17249 (if (and (= hour 12) (not pm))
17250 (setq hour 0)
17251 (when (and pm (< hour 12)) (setq hour (+ 12 hour))))
17252 (setq ans (replace-match (format "%02d:%02d" hour minute)
17253 t t ans))))
17255 ;; Check if a time range is given as a duration
17256 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17257 (setq hour (string-to-number (match-string 1 ans))
17258 h2 (+ hour (string-to-number (match-string 3 ans)))
17259 minute (string-to-number (match-string 2 ans))
17260 m2 (+ minute (if (match-end 5) (string-to-number
17261 (match-string 5 ans))0)))
17262 (when (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17263 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17264 t t ans)))
17266 ;; Check if there is a time range
17267 (when (boundp 'org-end-time-was-given)
17268 (setq org-time-was-given nil)
17269 (when (and (string-match org-plain-time-of-day-regexp ans)
17270 (match-end 8))
17271 (setq org-end-time-was-given (match-string 8 ans))
17272 (setq ans (concat (substring ans 0 (match-beginning 7))
17273 (substring ans (match-end 7))))))
17275 (setq tl (parse-time-string ans)
17276 day (or (nth 3 tl) (nth 3 org-defdecode))
17277 month
17278 (cond ((nth 4 tl))
17279 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17280 ;; Day was specified. Make sure DAY+MONTH
17281 ;; combination happens in the future.
17282 ((nth 3 tl)
17283 (setq futurep t)
17284 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17285 (nth 4 nowdecode)))
17286 (t (nth 4 org-defdecode)))
17287 year
17288 (cond ((and (not kill-year) (nth 5 tl)))
17289 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17290 ;; Month was guessed in the future and is at least
17291 ;; equal to NOWDECODE's. Fix year accordingly.
17292 (futurep
17293 (if (or (> month (nth 4 nowdecode))
17294 (>= day (nth 3 nowdecode)))
17295 (nth 5 nowdecode)
17296 (1+ (nth 5 nowdecode))))
17297 ;; Month was specified. Make sure MONTH+YEAR
17298 ;; combination happens in the future.
17299 ((nth 4 tl)
17300 (setq futurep t)
17301 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17302 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17303 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17304 (t (nth 5 nowdecode))))
17305 (t (nth 5 org-defdecode)))
17306 hour (or (nth 2 tl) (nth 2 org-defdecode))
17307 minute (or (nth 1 tl) (nth 1 org-defdecode))
17308 second (or (nth 0 tl) 0)
17309 wday (nth 6 tl))
17311 (when (and (eq org-read-date-prefer-future 'time)
17312 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17313 (equal day (nth 3 nowdecode))
17314 (equal month (nth 4 nowdecode))
17315 (equal year (nth 5 nowdecode))
17316 (nth 2 tl)
17317 (or (< (nth 2 tl) (nth 2 nowdecode))
17318 (and (= (nth 2 tl) (nth 2 nowdecode))
17319 (nth 1 tl)
17320 (< (nth 1 tl) (nth 1 nowdecode)))))
17321 (setq day (1+ day)
17322 futurep t))
17324 ;; Special date definitions below
17325 (cond
17326 (iso-week
17327 ;; There was an iso week
17328 (require 'cal-iso)
17329 (setq futurep nil)
17330 (setq year (or iso-year year)
17331 day (or iso-weekday wday 1)
17332 wday nil ; to make sure that the trigger below does not match
17333 iso-date (calendar-gregorian-from-absolute
17334 (calendar-iso-to-absolute
17335 (list iso-week day year))))
17336 ; FIXME: Should we also push ISO weeks into the future?
17337 ; (when (and org-read-date-prefer-future
17338 ; (not iso-year)
17339 ; (< (calendar-absolute-from-gregorian iso-date)
17340 ; (time-to-days (current-time))))
17341 ; (setq year (1+ year)
17342 ; iso-date (calendar-gregorian-from-absolute
17343 ; (calendar-iso-to-absolute
17344 ; (list iso-week day year)))))
17345 (setq month (car iso-date)
17346 year (nth 2 iso-date)
17347 day (nth 1 iso-date)))
17348 (deltan
17349 (setq futurep nil)
17350 (unless deltadef
17351 ;; Pass `current-time' result to `decode-time' (instead of
17352 ;; calling without arguments) so that only `current-time' has
17353 ;; to be overriden in tests.
17354 (let ((now (decode-time (current-time))))
17355 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17356 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17357 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17358 ((equal deltaw "m") (setq month (+ month deltan)))
17359 ((equal deltaw "y") (setq year (+ year deltan)))))
17360 ((and wday (not (nth 3 tl)))
17361 ;; Weekday was given, but no day, so pick that day in the week
17362 ;; on or after the derived date.
17363 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17364 (unless (equal wday wday1)
17365 (setq day (+ day (% (- wday wday1 -7) 7))))))
17366 (when (and (boundp 'org-time-was-given)
17367 (nth 2 tl))
17368 (setq org-time-was-given t))
17369 (when (< year 100) (setq year (+ 2000 year)))
17370 ;; Check of the date is representable
17371 (if org-read-date-force-compatible-dates
17372 (progn
17373 (when (< year 1970)
17374 (setq year 1970 org-read-date-analyze-forced-year t))
17375 (when (> year 2037)
17376 (setq year 2037 org-read-date-analyze-forced-year t)))
17377 (condition-case nil
17378 (ignore (encode-time second minute hour day month year))
17379 (error
17380 (setq year (nth 5 org-defdecode))
17381 (setq org-read-date-analyze-forced-year t))))
17382 (setq org-read-date-analyze-futurep futurep)
17383 (list second minute hour day month year)))
17385 (defvar parse-time-weekdays)
17386 (defun org-read-date-get-relative (s today default)
17387 "Check string S for special relative date string.
17388 TODAY and DEFAULT are internal times, for today and for a default.
17389 Return shift list (N what def-flag)
17390 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17391 N is the number of WHATs to shift.
17392 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17393 the DEFAULT date rather than TODAY."
17394 (require 'parse-time)
17395 (when (and
17396 (string-match
17397 (concat
17398 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17399 "\\([0-9]+\\)?"
17400 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17401 "\\([ \t]\\|$\\)") s)
17402 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17403 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17404 (string-to-char (substring (match-string 1 s) -1))
17405 ?+))
17406 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17407 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17408 (what (if (match-end 3) (match-string 3 s) "d"))
17409 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17410 (date (if rel default today))
17411 (wday (nth 6 (decode-time date)))
17412 delta)
17413 (if wday1
17414 (progn
17415 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17416 (when (= delta 0) (setq delta 7))
17417 (when (= dir ?-)
17418 (setq delta (- delta 7))
17419 (when (= delta 0) (setq delta -7)))
17420 (when (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17421 (list delta "d" rel))
17422 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17424 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17425 "Turn a user-specified date into the internal representation.
17426 The internal representation needed by the calendar is (month day year).
17427 This is a wrapper to handle the brain-dead convention in calendar that
17428 user function argument order change dependent on argument order."
17429 (pcase calendar-date-style
17430 (`american (list arg1 arg2 arg3))
17431 (`european (list arg2 arg1 arg3))
17432 (`iso (list arg2 arg3 arg1))))
17434 (defun org-eval-in-calendar (form &optional keepdate)
17435 "Eval FORM in the calendar window and return to current window.
17436 Unless KEEPDATE is non-nil, update `org-ans2' to the cursor date."
17437 (let ((sf (selected-frame))
17438 (sw (selected-window)))
17439 (select-window (get-buffer-window "*Calendar*" t))
17440 (eval form)
17441 (when (and (not keepdate) (calendar-cursor-to-date))
17442 (let* ((date (calendar-cursor-to-date))
17443 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17444 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17445 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17446 (select-window sw)
17447 (select-frame-set-input-focus sf)))
17449 (defun org-calendar-select ()
17450 "Return to `org-read-date' with the date currently selected.
17451 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17452 (interactive)
17453 (when (calendar-cursor-to-date)
17454 (let* ((date (calendar-cursor-to-date))
17455 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17456 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17457 (when (active-minibuffer-window) (exit-minibuffer))))
17459 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17460 "Insert a date stamp for the date given by the internal TIME.
17461 See `format-time-string' for the format of TIME.
17462 WITH-HM means use the stamp format that includes the time of the day.
17463 INACTIVE means use square brackets instead of angular ones, so that the
17464 stamp will not contribute to the agenda.
17465 PRE and POST are optional strings to be inserted before and after the
17466 stamp.
17467 The command returns the inserted time stamp."
17468 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17469 stamp)
17470 (when inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17471 (insert-before-markers (or pre ""))
17472 (when (listp extra)
17473 (setq extra (car extra))
17474 (if (and (stringp extra)
17475 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17476 (setq extra (format "-%02d:%02d"
17477 (string-to-number (match-string 1 extra))
17478 (string-to-number (match-string 2 extra))))
17479 (setq extra nil)))
17480 (when extra
17481 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17482 (insert-before-markers (setq stamp (format-time-string fmt time)))
17483 (insert-before-markers (or post ""))
17484 (setq org-last-inserted-timestamp stamp)))
17486 (defun org-toggle-time-stamp-overlays ()
17487 "Toggle the use of custom time stamp formats."
17488 (interactive)
17489 (setq org-display-custom-times (not org-display-custom-times))
17490 (unless org-display-custom-times
17491 (let ((p (point-min)) (bmp (buffer-modified-p)))
17492 (while (setq p (next-single-property-change p 'display))
17493 (when (and (get-text-property p 'display)
17494 (eq (get-text-property p 'face) 'org-date))
17495 (remove-text-properties
17496 p (setq p (next-single-property-change p 'display))
17497 '(display t))))
17498 (set-buffer-modified-p bmp)))
17499 (org-restart-font-lock)
17500 (setq org-table-may-need-update t)
17501 (if org-display-custom-times
17502 (message "Time stamps are overlaid with custom format")
17503 (message "Time stamp overlays removed")))
17505 (defun org-display-custom-time (beg end)
17506 "Overlay modified time stamp format over timestamp between BEG and END."
17507 (let* ((ts (buffer-substring beg end))
17508 t1 w1 with-hm tf time str w2 (off 0))
17509 (save-match-data
17510 (setq t1 (org-parse-time-string ts t))
17511 (when (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17512 (setq off (- (match-end 0) (match-beginning 0)))))
17513 (setq end (- end off))
17514 (setq w1 (- end beg)
17515 with-hm (and (nth 1 t1) (nth 2 t1))
17516 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17517 time (org-fix-decoded-time t1)
17518 str (org-add-props
17519 (format-time-string
17520 (substring tf 1 -1) (apply 'encode-time time))
17521 nil 'mouse-face 'highlight)
17522 w2 (length str))
17523 (unless (= w2 w1)
17524 (add-text-properties (1+ beg) (+ 2 beg)
17525 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17526 (put-text-property beg end 'display str)))
17528 (defun org-fix-decoded-time (time)
17529 "Set 0 instead of nil for the first 6 elements of time.
17530 Don't touch the rest."
17531 (let ((n 0))
17532 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17534 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17535 "Difference between TIMESTAMP-STRING and now in days.
17536 If SECONDS is non-nil, return the difference in seconds."
17537 (let ((fdiff (if seconds #'float-time #'time-to-days)))
17538 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17539 (funcall fdiff (current-time)))))
17541 (defun org-deadline-close-p (timestamp-string &optional ndays)
17542 "Is the time in TIMESTAMP-STRING close to the current date?"
17543 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17544 (and (<= (org-time-stamp-to-now timestamp-string) ndays)
17545 (not (org-entry-is-done-p))))
17547 (defun org-get-wdays (ts &optional delay zero-delay)
17548 "Get the deadline lead time appropriate for timestring TS.
17549 When DELAY is non-nil, get the delay time for scheduled items
17550 instead of the deadline lead time. When ZERO-DELAY is non-nil
17551 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17552 don't try to find the delay cookie in the scheduled timestamp."
17553 (let ((tv (if delay org-scheduled-delay-days
17554 org-deadline-warning-days)))
17555 (cond
17556 ((or (and delay (< tv 0))
17557 (and delay zero-delay (<= tv 0))
17558 (and (not delay) (<= tv 0)))
17559 ;; Enforce this value no matter what
17560 (- tv))
17561 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17562 ;; lead time is specified.
17563 (floor (* (string-to-number (match-string 1 ts))
17564 (cdr (assoc (match-string 2 ts)
17565 '(("d" . 1) ("w" . 7)
17566 ("m" . 30.4) ("y" . 365.25)
17567 ("h" . 0.041667)))))))
17568 ;; go for the default.
17569 (t tv))))
17571 (defun org-calendar-select-mouse (ev)
17572 "Return to `org-read-date' with the date currently selected.
17573 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17574 (interactive "e")
17575 (mouse-set-point ev)
17576 (when (calendar-cursor-to-date)
17577 (let* ((date (calendar-cursor-to-date))
17578 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17579 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17580 (when (active-minibuffer-window) (exit-minibuffer))))
17582 (defun org-check-deadlines (ndays)
17583 "Check if there are any deadlines due or past due.
17584 A deadline is considered due if it happens within `org-deadline-warning-days'
17585 days from today's date. If the deadline appears in an entry marked DONE,
17586 it is not shown. A numeric prefix argument NDAYS can be used to test that
17587 many days. If the prefix is a raw `\\[universal-argument]', all deadlines \
17588 are shown."
17589 (interactive "P")
17590 (let* ((org-warn-days
17591 (cond
17592 ((equal ndays '(4)) 100000)
17593 (ndays (prefix-numeric-value ndays))
17594 (t (abs org-deadline-warning-days))))
17595 (case-fold-search nil)
17596 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17597 (callback
17598 (lambda () (org-deadline-close-p (match-string 1) org-warn-days))))
17599 (message "%d deadlines past-due or due within %d days"
17600 (org-occur regexp nil callback)
17601 org-warn-days)))
17603 (defsubst org-re-timestamp (type)
17604 "Return a regexp for timestamp TYPE.
17605 Allowed values for TYPE are:
17607 all: all timestamps
17608 active: only active timestamps (<...>)
17609 inactive: only inactive timestamps ([...])
17610 scheduled: only scheduled timestamps
17611 deadline: only deadline timestamps
17612 closed: only closed time-stamps
17614 When TYPE is nil, fall back on returning a regexp that matches
17615 both scheduled and deadline timestamps."
17616 (cl-case type
17617 (all org-ts-regexp-both)
17618 (active org-ts-regexp)
17619 (inactive org-ts-regexp-inactive)
17620 (scheduled org-scheduled-time-regexp)
17621 (deadline org-deadline-time-regexp)
17622 (closed org-closed-time-regexp)
17623 (otherwise
17624 (concat "\\<"
17625 (regexp-opt (list org-deadline-string org-scheduled-string))
17626 " *<\\([^>]+\\)>"))))
17628 (defun org-check-before-date (d)
17629 "Check if there are deadlines or scheduled entries before date D."
17630 (interactive (list (org-read-date)))
17631 (let* ((case-fold-search nil)
17632 (regexp (org-re-timestamp org-ts-type))
17633 (ts-type org-ts-type)
17634 (callback
17635 (lambda ()
17636 (let ((match (match-string 1)))
17637 (and (if (memq ts-type '(active inactive all))
17638 (eq (org-element-type (save-excursion
17639 (backward-char)
17640 (org-element-context)))
17641 'timestamp)
17642 (org-at-planning-p))
17643 (time-less-p
17644 (org-time-string-to-time match)
17645 (org-time-string-to-time d)))))))
17646 (message "%d entries before %s"
17647 (org-occur regexp nil callback)
17648 d)))
17650 (defun org-check-after-date (d)
17651 "Check if there are deadlines or scheduled entries after date D."
17652 (interactive (list (org-read-date)))
17653 (let* ((case-fold-search nil)
17654 (regexp (org-re-timestamp org-ts-type))
17655 (ts-type org-ts-type)
17656 (callback
17657 (lambda ()
17658 (let ((match (match-string 1)))
17659 (and (if (memq ts-type '(active inactive all))
17660 (eq (org-element-type (save-excursion
17661 (backward-char)
17662 (org-element-context)))
17663 'timestamp)
17664 (org-at-planning-p))
17665 (not (time-less-p
17666 (org-time-string-to-time match)
17667 (org-time-string-to-time d))))))))
17668 (message "%d entries after %s"
17669 (org-occur regexp nil callback)
17670 d)))
17672 (defun org-check-dates-range (start-date end-date)
17673 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17674 (interactive (list (org-read-date nil nil nil "Range starts")
17675 (org-read-date nil nil nil "Range end")))
17676 (let ((case-fold-search nil)
17677 (regexp (org-re-timestamp org-ts-type))
17678 (callback
17679 (let ((type org-ts-type))
17680 (lambda ()
17681 (let ((match (match-string 1)))
17682 (and
17683 (if (memq type '(active inactive all))
17684 (eq (org-element-type (save-excursion
17685 (backward-char)
17686 (org-element-context)))
17687 'timestamp)
17688 (org-at-planning-p))
17689 (not (time-less-p
17690 (org-time-string-to-time match)
17691 (org-time-string-to-time start-date)))
17692 (time-less-p
17693 (org-time-string-to-time match)
17694 (org-time-string-to-time end-date))))))))
17695 (message "%d entries between %s and %s"
17696 (org-occur regexp nil callback) start-date end-date)))
17698 (defun org-evaluate-time-range (&optional to-buffer)
17699 "Evaluate a time range by computing the difference between start and end.
17700 Normally the result is just printed in the echo area, but with prefix arg
17701 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17702 If the time range is actually in a table, the result is inserted into the
17703 next column.
17704 For time difference computation, a year is assumed to be exactly 365
17705 days in order to avoid rounding problems."
17706 (interactive "P")
17708 (org-clock-update-time-maybe)
17709 (save-excursion
17710 (unless (org-at-date-range-p t)
17711 (goto-char (point-at-bol))
17712 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17713 (unless (org-at-date-range-p t)
17714 (user-error "Not at a time-stamp range, and none found in current line")))
17715 (let* ((ts1 (match-string 1))
17716 (ts2 (match-string 2))
17717 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17718 (match-end (match-end 0))
17719 (time1 (org-time-string-to-time ts1))
17720 (time2 (org-time-string-to-time ts2))
17721 (t1 (float-time time1))
17722 (t2 (float-time time2))
17723 (diff (abs (- t2 t1)))
17724 (negative (< (- t2 t1) 0))
17725 ;; (ys (floor (* 365 24 60 60)))
17726 (ds (* 24 60 60))
17727 (hs (* 60 60))
17728 (fy "%dy %dd %02d:%02d")
17729 (fy1 "%dy %dd")
17730 (fd "%dd %02d:%02d")
17731 (fd1 "%dd")
17732 (fh "%02d:%02d")
17733 y d h m align)
17734 (if havetime
17735 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17737 d (floor (/ diff ds)) diff (mod diff ds)
17738 h (floor (/ diff hs)) diff (mod diff hs)
17739 m (floor (/ diff 60)))
17740 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17742 d (floor (+ (/ diff ds) 0.5))
17743 h 0 m 0))
17744 (if (not to-buffer)
17745 (message "%s" (org-make-tdiff-string y d h m))
17746 (if (org-at-table-p)
17747 (progn
17748 (goto-char match-end)
17749 (setq align t)
17750 (and (looking-at " *|") (goto-char (match-end 0))))
17751 (goto-char match-end))
17752 (when (looking-at
17753 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17754 (replace-match ""))
17755 (when negative (insert " -"))
17756 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17757 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17758 (insert " " (format fh h m))))
17759 (when align (org-table-align))
17760 (message "Time difference inserted")))))
17762 (defun org-make-tdiff-string (y d h m)
17763 (let ((fmt "")
17764 (l nil))
17765 (when (> y 0)
17766 (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " "))
17767 (push y l))
17768 (when (> d 0)
17769 (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " "))
17770 (push d l))
17771 (when (> h 0)
17772 (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " "))
17773 (push h l))
17774 (when (> m 0)
17775 (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " "))
17776 (push m l))
17777 (apply 'format fmt (nreverse l))))
17779 (defun org-time-string-to-time (s &optional buffer pos)
17780 "Convert a timestamp string into internal time."
17781 (condition-case errdata
17782 (apply 'encode-time (org-parse-time-string s))
17783 (error (error "Bad timestamp `%s'%s\nError was: %s"
17784 s (if (not (and buffer pos))
17786 (format-message " at %d in buffer `%s'" pos buffer))
17787 (cdr errdata)))))
17789 (defun org-time-string-to-seconds (s)
17790 "Convert a timestamp string to a number of seconds."
17791 (float-time (org-time-string-to-time s)))
17793 (org-define-error 'org-diary-sexp-no-match "Unable to match diary sexp")
17795 (defun org-time-string-to-absolute (s &optional daynr prefer buffer pos)
17796 "Convert time stamp S to an absolute day number.
17798 If DAYNR in non-nil, and there is a specifier for a cyclic time
17799 stamp, get the closest date to DAYNR. If PREFER is
17800 `past' (respectively `future') return a date past (respectively
17801 after) or equal to DAYNR.
17803 POS is the location of time stamp S, as a buffer position in
17804 BUFFER.
17806 Diary sexp timestamps are matched against DAYNR, when non-nil.
17807 If matching fails or DAYNR is nil, `org-diary-sexp-no-match' is
17808 signalled."
17809 (cond
17810 ((string-match "\\`%%\\((.*)\\)" s)
17811 ;; Sexp timestamp: try to match DAYNR, if available, since we're
17812 ;; only able to match individual dates. If it fails, raise an
17813 ;; error.
17814 (if (and daynr
17815 (org-diary-sexp-entry
17816 (match-string 1 s) "" (calendar-gregorian-from-absolute daynr)))
17817 daynr
17818 (signal 'org-diary-sexp-no-match (list s))))
17819 (daynr (org-closest-date s daynr prefer))
17820 (t (time-to-days
17821 (condition-case errdata
17822 (apply #'encode-time (org-parse-time-string s))
17823 (error (error "Bad timestamp `%s'%s\nError was: %s"
17825 (if (not (and buffer pos)) ""
17826 (format-message " at %d in buffer `%s'" pos buffer))
17827 (cdr errdata))))))))
17829 (defun org-days-to-iso-week (days)
17830 "Return the iso week number."
17831 (require 'cal-iso)
17832 (car (calendar-iso-from-absolute days)))
17834 (defun org-small-year-to-year (year)
17835 "Convert 2-digit years into 4-digit years.
17836 YEAR is expanded into one of the 30 next years, if possible, or
17837 into a past one. Any year larger than 99 is returned unchanged."
17838 (if (>= year 100) year
17839 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17840 (century (/ current 100))
17841 (offset (- year (% current 100))))
17842 (cond ((> offset 30) (+ (* (1- century) 100) year))
17843 ((> offset -70) (+ (* century 100) year))
17844 (t (+ (* (1+ century) 100) year))))))
17846 (defun org-time-from-absolute (d)
17847 "Return the time corresponding to date D.
17848 D may be an absolute day number, or a calendar-type list (month day year)."
17849 (when (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17850 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17852 (defvar org-agenda-current-date)
17853 (defun org-calendar-holiday ()
17854 "List of holidays, for Diary display in Org mode."
17855 (require 'holidays)
17856 (let ((hl (calendar-check-holidays org-agenda-current-date)))
17857 (and hl (mapconcat #'identity hl "; "))))
17859 (defun org-diary-sexp-entry (sexp entry d)
17860 "Process a SEXP diary ENTRY for date D."
17861 (require 'diary-lib)
17862 ;; `org-anniversary' and alike expect ENTRY and DATE to be bound
17863 ;; dynamically.
17864 (let* ((sexp `(let ((entry ,entry)
17865 (date ',d))
17866 ,(car (read-from-string sexp))))
17867 (result (if calendar-debug-sexp (eval sexp)
17868 (condition-case nil
17869 (eval sexp)
17870 (error
17871 (beep)
17872 (message "Bad sexp at line %d in %s: %s"
17873 (org-current-line)
17874 (buffer-file-name) sexp)
17875 (sleep-for 2))))))
17876 (cond ((stringp result) (split-string result "; "))
17877 ((and (consp result)
17878 (not (consp (cdr result)))
17879 (stringp (cdr result))) (cdr result))
17880 ((and (consp result)
17881 (stringp (car result))) result)
17882 (result entry))))
17884 (defun org-diary-to-ical-string (frombuf)
17885 "Get iCalendar entries from diary entries in buffer FROMBUF.
17886 This uses the icalendar.el library."
17887 (let* ((tmpdir temporary-file-directory)
17888 (tmpfile (make-temp-name
17889 (expand-file-name "orgics" tmpdir)))
17890 buf rtn b e)
17891 (with-current-buffer frombuf
17892 (icalendar-export-region (point-min) (point-max) tmpfile)
17893 (setq buf (find-buffer-visiting tmpfile))
17894 (set-buffer buf)
17895 (goto-char (point-min))
17896 (when (re-search-forward "^BEGIN:VEVENT" nil t)
17897 (setq b (match-beginning 0)))
17898 (goto-char (point-max))
17899 (when (re-search-backward "^END:VEVENT" nil t)
17900 (setq e (match-end 0)))
17901 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17902 (kill-buffer buf)
17903 (delete-file tmpfile)
17904 rtn))
17906 (defun org-closest-date (start current prefer)
17907 "Return closest date to CURRENT starting from START.
17909 CURRENT and START are both time stamps.
17911 When PREFER is `past', return a date that is either CURRENT or
17912 past. When PREFER is `future', return a date that is either
17913 CURRENT or future.
17915 Only time stamps with a repeater are modified. Any other time
17916 stamp stay unchanged. In any case, return value is an absolute
17917 day number."
17918 (if (not (string-match "\\+\\([0-9]+\\)\\([hdwmy]\\)" start))
17919 ;; No repeater. Do not shift time stamp.
17920 (time-to-days (apply #'encode-time (org-parse-time-string start)))
17921 (let ((value (string-to-number (match-string 1 start)))
17922 (type (match-string 2 start)))
17923 (if (= 0 value)
17924 ;; Repeater with a 0-value is considered as void.
17925 (time-to-days (apply #'encode-time (org-parse-time-string start)))
17926 (let* ((base (org-date-to-gregorian start))
17927 (target (org-date-to-gregorian current))
17928 (sday (calendar-absolute-from-gregorian base))
17929 (cday (calendar-absolute-from-gregorian target))
17930 n1 n2)
17931 ;; If START is already past CURRENT, just return START.
17932 (if (<= cday sday) sday
17933 ;; Compute closest date before (N1) and closest date past
17934 ;; (N2) CURRENT.
17935 (pcase type
17936 ("h"
17937 (let ((missing-hours
17938 (mod (+ (- (* 24 (- cday sday))
17939 (nth 2 (org-parse-time-string start)))
17940 org-extend-today-until)
17941 value)))
17942 (setf n1 (if (= missing-hours 0) cday
17943 (- cday (1+ (/ missing-hours 24)))))
17944 (setf n2 (+ cday (/ (- value missing-hours) 24)))))
17945 ((or "d" "w")
17946 (let ((value (if (equal type "w") (* 7 value) value)))
17947 (setf n1 (+ sday (* value (/ (- cday sday) value))))
17948 (setf n2 (+ n1 value))))
17949 ("m"
17950 (let* ((add-months
17951 (lambda (d n)
17952 ;; Add N months to gregorian date D, i.e.,
17953 ;; a list (MONTH DAY YEAR). Return a valid
17954 ;; gregorian date.
17955 (let ((m (+ (nth 0 d) n)))
17956 (list (mod m 12)
17957 (nth 1 d)
17958 (+ (/ m 12) (nth 2 d))))))
17959 (months ; Complete months to TARGET.
17960 (* (/ (+ (* 12 (- (nth 2 target) (nth 2 base)))
17961 (- (nth 0 target) (nth 0 base))
17962 ;; If START's day is greater than
17963 ;; TARGET's, remove incomplete month.
17964 (if (> (nth 1 target) (nth 1 base)) 0 -1))
17965 value)
17966 value))
17967 (before (funcall add-months base months)))
17968 (setf n1 (calendar-absolute-from-gregorian before))
17969 (setf n2
17970 (calendar-absolute-from-gregorian
17971 (funcall add-months before value)))))
17973 (let* ((d (nth 1 base))
17974 (m (nth 0 base))
17975 (y (nth 2 base))
17976 (years ; Complete years to TARGET.
17977 (* (/ (- (nth 2 target)
17979 ;; If START's month and day are
17980 ;; greater than TARGET's, remove
17981 ;; incomplete year.
17982 (if (or (> (nth 0 target) m)
17983 (and (= (nth 0 target) m)
17984 (> (nth 1 target) d)))
17987 value)
17988 value))
17989 (before (list m d (+ y years))))
17990 (setf n1 (calendar-absolute-from-gregorian before))
17991 (setf n2 (calendar-absolute-from-gregorian
17992 (list m d (+ (nth 2 before) value)))))))
17993 ;; Handle PREFER parameter, if any.
17994 (cond
17995 ((eq prefer 'past) (if (= cday n2) n2 n1))
17996 ((eq prefer 'future) (if (= cday n1) n1 n2))
17997 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))))))))
17999 (defun org-date-to-gregorian (d)
18000 "Turn any specification of date D into a Gregorian date for the calendar."
18001 (cond ((integerp d) (calendar-gregorian-from-absolute d))
18002 ((and (listp d) (= (length d) 3)) d)
18003 ((stringp d)
18004 (let ((d (org-parse-time-string d)))
18005 (list (nth 4 d) (nth 3 d) (nth 5 d))))
18006 ((listp d) (list (nth 4 d) (nth 3 d) (nth 5 d)))))
18008 (defun org-parse-time-string (s &optional nodefault)
18009 "Parse the standard Org time string.
18010 This should be a lot faster than the normal `parse-time-string'.
18011 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18012 hour and minute fields will be nil if not given."
18013 (cond ((string-match org-ts-regexp0 s)
18014 (list 0
18015 (when (or (match-beginning 8) (not nodefault))
18016 (string-to-number (or (match-string 8 s) "0")))
18017 (when (or (match-beginning 7) (not nodefault))
18018 (string-to-number (or (match-string 7 s) "0")))
18019 (string-to-number (match-string 4 s))
18020 (string-to-number (match-string 3 s))
18021 (string-to-number (match-string 2 s))
18022 nil nil nil))
18023 ((string-match "^<[^>]+>$" s)
18024 (decode-time (seconds-to-time (org-matcher-time s))))
18025 (t (error "Not a standard Org time string: %s" s))))
18027 (defun org-timestamp-up (&optional arg)
18028 "Increase the date item at the cursor by one.
18029 If the cursor is on the year, change the year. If it is on the month,
18030 the day or the time, change that.
18031 With prefix ARG, change by that many units."
18032 (interactive "p")
18033 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
18035 (defun org-timestamp-down (&optional arg)
18036 "Decrease the date item at the cursor by one.
18037 If the cursor is on the year, change the year. If it is on the month,
18038 the day or the time, change that.
18039 With prefix ARG, change by that many units."
18040 (interactive "p")
18041 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
18043 (defun org-timestamp-up-day (&optional arg)
18044 "Increase the date in the time stamp by one day.
18045 With prefix ARG, change that many days."
18046 (interactive "p")
18047 (if (and (not (org-at-timestamp-p t))
18048 (org-at-heading-p))
18049 (org-todo 'up)
18050 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
18052 (defun org-timestamp-down-day (&optional arg)
18053 "Decrease the date in the time stamp by one day.
18054 With prefix ARG, change that many days."
18055 (interactive "p")
18056 (if (and (not (org-at-timestamp-p t))
18057 (org-at-heading-p))
18058 (org-todo 'down)
18059 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
18061 (defun org-at-timestamp-p (&optional inactive-ok)
18062 "Non-nil if point is inside a timestamp.
18064 When optional argument INACTIVE-OK is non-nil, also consider
18065 inactive timestamps.
18067 When this function returns a non-nil value, match data is set
18068 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
18069 INACTIVE-OK."
18070 (interactive)
18071 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
18072 (pos (point))
18073 (ans (or (looking-at tsr)
18074 (save-excursion
18075 (skip-chars-backward "^[<\n\r\t")
18076 (when (> (point) (point-min)) (backward-char 1))
18077 (and (looking-at tsr)
18078 (> (- (match-end 0) pos) -1))))))
18079 (and ans
18080 (boundp 'org-ts-what)
18081 (setq org-ts-what
18082 (cond
18083 ((= pos (match-beginning 0)) 'bracket)
18084 ;; Point is considered to be "on the bracket" whether
18085 ;; it's really on it or right after it.
18086 ((= pos (1- (match-end 0))) 'bracket)
18087 ((= pos (match-end 0)) 'after)
18088 ((org-pos-in-match-range pos 2) 'year)
18089 ((org-pos-in-match-range pos 3) 'month)
18090 ((org-pos-in-match-range pos 7) 'hour)
18091 ((org-pos-in-match-range pos 8) 'minute)
18092 ((or (org-pos-in-match-range pos 4)
18093 (org-pos-in-match-range pos 5)) 'day)
18094 ((and (> pos (or (match-end 8) (match-end 5)))
18095 (< pos (match-end 0)))
18096 (- pos (or (match-end 8) (match-end 5))))
18097 (t 'day))))
18098 ans))
18100 (defun org-toggle-timestamp-type ()
18101 "Toggle the type (<active> or [inactive]) of a time stamp."
18102 (interactive)
18103 (when (org-at-timestamp-p t)
18104 (let ((beg (match-beginning 0)) (end (match-end 0))
18105 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
18106 (save-excursion
18107 (goto-char beg)
18108 (while (re-search-forward "[][<>]" end t)
18109 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
18110 t t)))
18111 (message "Timestamp is now %sactive"
18112 (if (equal (char-after beg) ?<) "" "in")))))
18114 (defun org-at-clock-log-p nil
18115 "Is the cursor on the clock log line?"
18116 (save-excursion
18117 (beginning-of-line)
18118 (looking-at org-clock-line-re)))
18120 (defvar org-clock-history) ; defined in org-clock.el
18121 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
18122 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
18123 "Change the date in the time stamp at point.
18124 The date will be changed by N times WHAT. WHAT can be `day', `month',
18125 `year', `minute', `second'. If WHAT is not given, the cursor position
18126 in the timestamp determines what will be changed.
18127 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
18128 (let ((origin (point)) origin-cat
18129 with-hm inactive
18130 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
18131 org-ts-what
18132 extra rem
18133 ts time time0 fixnext clrgx)
18134 (unless (org-at-timestamp-p t)
18135 (user-error "Not at a timestamp"))
18136 (if (and (not what) (eq org-ts-what 'bracket))
18137 (org-toggle-timestamp-type)
18138 ;; Point isn't on brackets. Remember the part of the time-stamp
18139 ;; the point was in. Indeed, size of time-stamps may change,
18140 ;; but point must be kept in the same category nonetheless.
18141 (setq origin-cat org-ts-what)
18142 (when (and (not what) (not (eq org-ts-what 'day))
18143 org-display-custom-times
18144 (get-text-property (point) 'display)
18145 (not (get-text-property (1- (point)) 'display)))
18146 (setq org-ts-what 'day))
18147 (setq org-ts-what (or what org-ts-what)
18148 inactive (= (char-after (match-beginning 0)) ?\[)
18149 ts (match-string 0))
18150 (replace-match "")
18151 (when (string-match
18152 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
18154 (setq extra (match-string 1 ts))
18155 (when suppress-tmp-delay
18156 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
18157 (when (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
18158 (setq with-hm t))
18159 (setq time0 (org-parse-time-string ts))
18160 (when (and updown
18161 (eq org-ts-what 'minute)
18162 (not current-prefix-arg))
18163 ;; This looks like s-up and s-down. Change by one rounding step.
18164 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
18165 (unless (= 0 (setq rem (% (nth 1 time0) dm)))
18166 (setcar (cdr time0) (+ (nth 1 time0)
18167 (if (> n 0) (- rem) (- dm rem))))))
18168 (setq time
18169 (apply #'encode-time
18170 (or (car time0) 0)
18171 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
18172 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
18173 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
18174 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
18175 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
18176 (nthcdr 6 time0)))
18177 (when (and (member org-ts-what '(hour minute))
18178 extra
18179 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
18180 (setq extra (org-modify-ts-extra
18181 extra
18182 (if (eq org-ts-what 'hour) 2 5)
18183 n dm)))
18184 (when (integerp org-ts-what)
18185 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
18186 (when (eq what 'calendar)
18187 (let ((cal-date (org-get-date-from-calendar)))
18188 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
18189 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
18190 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
18191 (setcar time0 (or (car time0) 0))
18192 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18193 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18194 (setq time (apply 'encode-time time0))))
18195 ;; Insert the new time-stamp, and ensure point stays in the same
18196 ;; category as before (i.e. not after the last position in that
18197 ;; category).
18198 (let ((pos (point)))
18199 ;; Stay before inserted string. `save-excursion' is of no use.
18200 (setq org-last-changed-timestamp
18201 (org-insert-time-stamp time with-hm inactive nil nil extra))
18202 (goto-char pos))
18203 (save-match-data
18204 (looking-at org-ts-regexp3)
18205 (goto-char
18206 (pcase origin-cat
18207 ;; `day' category ends before `hour' if any, or at the end
18208 ;; of the day name.
18209 (`day (min (or (match-beginning 7) (1- (match-end 5))) origin))
18210 (`hour (min (match-end 7) origin))
18211 (`minute (min (1- (match-end 8)) origin))
18212 ((pred integerp) (min (1- (match-end 0)) origin))
18213 ;; Point was right after the time-stamp. However, the
18214 ;; time-stamp length might have changed, so refer to
18215 ;; (match-end 0) instead.
18216 (`after (match-end 0))
18217 ;; `year' and `month' have both fixed size: point couldn't
18218 ;; have moved into another part.
18219 (_ origin))))
18220 ;; Update clock if on a CLOCK line.
18221 (org-clock-update-time-maybe)
18222 ;; Maybe adjust the closest clock in `org-clock-history'
18223 (when org-clock-adjust-closest
18224 (if (not (and (org-at-clock-log-p)
18225 (< 1 (length (delq nil (mapcar 'marker-position
18226 org-clock-history))))))
18227 (message "No clock to adjust")
18228 (cond ((save-excursion ; fix previous clock?
18229 (re-search-backward org-ts-regexp0 nil t)
18230 (looking-back (concat org-clock-string " \\[")
18231 (line-beginning-position)))
18232 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18233 ((save-excursion ; fix next clock?
18234 (re-search-backward org-ts-regexp0 nil t)
18235 (looking-at (concat org-ts-regexp0 "\\] =>")))
18236 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18237 (save-window-excursion
18238 ;; Find closest clock to point, adjust the previous/next one in history
18239 (let* ((p (save-excursion (org-back-to-heading t)))
18240 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18241 (clfixnth
18242 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18243 (clfixpos (unless (> 0 clfixnth) (nth clfixnth org-clock-history))))
18244 (if (not clfixpos)
18245 (message "No clock to adjust")
18246 (save-excursion
18247 (org-goto-marker-or-bmk clfixpos)
18248 (org-show-subtree)
18249 (when (re-search-forward clrgx nil t)
18250 (goto-char (match-beginning 1))
18251 (let (org-clock-adjust-closest)
18252 (org-timestamp-change n org-ts-what updown))
18253 (message "Clock adjusted in %s for heading: %s"
18254 (file-name-nondirectory (buffer-file-name))
18255 (org-get-heading t t)))))))))
18256 ;; Try to recenter the calendar window, if any.
18257 (when (and org-calendar-follow-timestamp-change
18258 (get-buffer-window "*Calendar*" t)
18259 (memq org-ts-what '(day month year)))
18260 (org-recenter-calendar (time-to-days time))))))
18262 (defun org-modify-ts-extra (s pos n dm)
18263 "Change the different parts of the lead-time and repeat fields in timestamp."
18264 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18265 ng h m new rem)
18266 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18267 (cond
18268 ((or (org-pos-in-match-range pos 2)
18269 (org-pos-in-match-range pos 3))
18270 (setq m (string-to-number (match-string 3 s))
18271 h (string-to-number (match-string 2 s)))
18272 (if (org-pos-in-match-range pos 2)
18273 (setq h (+ h n))
18274 (setq n (* dm (with-no-warnings (signum n))))
18275 (unless (= 0 (setq rem (% m dm)))
18276 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18277 (setq m (+ m n)))
18278 (when (< m 0) (setq m (+ m 60) h (1- h)))
18279 (when (> m 59) (setq m (- m 60) h (1+ h)))
18280 (setq h (mod h 24))
18281 (setq ng 1 new (format "-%02d:%02d" h m)))
18282 ((org-pos-in-match-range pos 6)
18283 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18284 ((org-pos-in-match-range pos 5)
18285 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18287 ((org-pos-in-match-range pos 9)
18288 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18289 ((org-pos-in-match-range pos 8)
18290 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18292 (when ng
18293 (setq s (concat
18294 (substring s 0 (match-beginning ng))
18296 (substring s (match-end ng))))))
18299 (defun org-recenter-calendar (d)
18300 "If the calendar is visible, recenter it to date D."
18301 (let ((cwin (get-buffer-window "*Calendar*" t)))
18302 (when cwin
18303 (let ((calendar-move-hook nil))
18304 (with-selected-window cwin
18305 (calendar-goto-date
18306 (if (listp d) d (calendar-gregorian-from-absolute d))))))))
18308 (defun org-goto-calendar (&optional arg)
18309 "Go to the Emacs calendar at the current date.
18310 If there is a time stamp in the current line, go to that date.
18311 A prefix ARG can be used to force the current date."
18312 (interactive "P")
18313 (let ((tsr org-ts-regexp) diff
18314 (calendar-move-hook nil)
18315 (calendar-view-holidays-initially-flag nil)
18316 (calendar-view-diary-initially-flag nil))
18317 (when (or (org-at-timestamp-p)
18318 (save-excursion
18319 (beginning-of-line 1)
18320 (looking-at (concat ".*" tsr))))
18321 (let ((d1 (time-to-days (current-time)))
18322 (d2 (time-to-days
18323 (org-time-string-to-time (match-string 1)))))
18324 (setq diff (- d2 d1))))
18325 (calendar)
18326 (calendar-goto-today)
18327 (when (and diff (not arg)) (calendar-forward-day diff))))
18329 (defun org-get-date-from-calendar ()
18330 "Return a list (month day year) of date at point in calendar."
18331 (with-current-buffer "*Calendar*"
18332 (save-match-data
18333 (calendar-cursor-to-date))))
18335 (defun org-date-from-calendar ()
18336 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18337 If there is already a time stamp at the cursor position, update it."
18338 (interactive)
18339 (if (org-at-timestamp-p t)
18340 (org-timestamp-change 0 'calendar)
18341 (let ((cal-date (org-get-date-from-calendar)))
18342 (org-insert-time-stamp
18343 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18345 (defcustom org-effort-durations
18346 `(("min" . 1)
18347 ("h" . 60)
18348 ("d" . ,(* 60 8))
18349 ("w" . ,(* 60 8 5))
18350 ("m" . ,(* 60 8 5 4))
18351 ("y" . ,(* 60 8 5 40)))
18352 "Conversion factor to minutes for an effort modifier.
18354 Each entry has the form (MODIFIER . MINUTES).
18356 In an effort string, a number followed by MODIFIER is multiplied
18357 by the specified number of MINUTES to obtain an effort in
18358 minutes.
18360 For example, if the value of this variable is ((\"hours\" . 60)), then an
18361 effort string \"2hours\" is equivalent to 120 minutes."
18362 :group 'org-agenda
18363 :version "26.1"
18364 :package-version '(Org . "8.3")
18365 :type '(alist :key-type (string :tag "Modifier")
18366 :value-type (number :tag "Minutes")))
18368 (defun org-minutes-to-clocksum-string (m)
18369 "Format number of minutes as a clocksum string.
18370 The format is determined by `org-time-clocksum-format',
18371 `org-time-clocksum-use-fractional' and
18372 `org-time-clocksum-fractional-format' and
18373 `org-time-clocksum-use-effort-durations'."
18374 (let ((clocksum "")
18375 (m (round m)) ; Don't allow fractions of minutes
18376 h d w mo y fmt n)
18377 (setq h (if org-time-clocksum-use-effort-durations
18378 (cdr (assoc "h" org-effort-durations)) 60)
18379 d (if org-time-clocksum-use-effort-durations
18380 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18381 w (if org-time-clocksum-use-effort-durations
18382 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18383 mo (if org-time-clocksum-use-effort-durations
18384 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18385 y (if org-time-clocksum-use-effort-durations
18386 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18387 ;; fractional format
18388 (if org-time-clocksum-use-fractional
18389 (cond
18390 ;; single format string
18391 ((stringp org-time-clocksum-fractional-format)
18392 (format org-time-clocksum-fractional-format (/ m (float h))))
18393 ;; choice of fractional formats for different time units
18394 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18395 (> (/ (truncate m) (* y d h)) 0))
18396 (format fmt (/ m (* y d (float h)))))
18397 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18398 (> (/ (truncate m) (* mo d h)) 0))
18399 (format fmt (/ m (* mo d (float h)))))
18400 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18401 (> (/ (truncate m) (* w d h)) 0))
18402 (format fmt (/ m (* w d (float h)))))
18403 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18404 (> (/ (truncate m) (* d h)) 0))
18405 (format fmt (/ m (* d (float h)))))
18406 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18407 (> (/ (truncate m) h) 0))
18408 (format fmt (/ m (float h))))
18409 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18410 (format fmt m))
18411 ;; fall back to smallest time unit with a format
18412 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18413 (format fmt (/ m (float h))))
18414 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18415 (format fmt (/ m (* d (float h)))))
18416 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18417 (format fmt (/ m (* w d (float h)))))
18418 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18419 (format fmt (/ m (* mo d (float h)))))
18420 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18421 (format fmt (/ m (* y d (float h))))))
18422 ;; standard (non-fractional) format, with single format string
18423 (if (stringp org-time-clocksum-format)
18424 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18425 ;; separate formats components
18426 (and (setq fmt (plist-get org-time-clocksum-format :years))
18427 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18428 (plist-get org-time-clocksum-format :require-years))
18429 (setq clocksum (concat clocksum (format fmt n))
18430 m (- m (* n y d h))))
18431 (and (setq fmt (plist-get org-time-clocksum-format :months))
18432 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18433 (plist-get org-time-clocksum-format :require-months))
18434 (setq clocksum (concat clocksum (format fmt n))
18435 m (- m (* n mo d h))))
18436 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18437 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18438 (plist-get org-time-clocksum-format :require-weeks))
18439 (setq clocksum (concat clocksum (format fmt n))
18440 m (- m (* n w d h))))
18441 (and (setq fmt (plist-get org-time-clocksum-format :days))
18442 (or (> (setq n (/ (truncate m) (* d h))) 0)
18443 (plist-get org-time-clocksum-format :require-days))
18444 (setq clocksum (concat clocksum (format fmt n))
18445 m (- m (* n d h))))
18446 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18447 (or (> (setq n (/ (truncate m) h)) 0)
18448 (plist-get org-time-clocksum-format :require-hours))
18449 (setq clocksum (concat clocksum (format fmt n))
18450 m (- m (* n h))))
18451 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18452 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18453 (setq clocksum (concat clocksum (format fmt m))))
18454 ;; return formatted time duration
18455 clocksum))))
18457 (defun org-hours-to-clocksum-string (n)
18458 (org-minutes-to-clocksum-string (* n 60)))
18460 (defun org-hh:mm-string-to-minutes (s)
18461 "Convert a string H:MM to a number of minutes.
18462 If the string is just a number, interpret it as minutes.
18463 In fact, the first hh:mm or number in the string will be taken,
18464 there can be extra stuff in the string.
18465 If no number is found, the return value is 0."
18466 (cond
18467 ((integerp s) s)
18468 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18469 (+ (* (string-to-number (match-string 1 s)) 60)
18470 (string-to-number (match-string 2 s))))
18471 ((string-match "\\([0-9]+\\)" s)
18472 (string-to-number (match-string 1 s)))
18473 (t 0)))
18475 (defcustom org-image-actual-width t
18476 "Should we use the actual width of images when inlining them?
18478 When set to t, always use the image width.
18480 When set to a number, use imagemagick (when available) to set
18481 the image's width to this value.
18483 When set to a number in a list, try to get the width from any
18484 #+ATTR.* keyword if it matches a width specification like
18486 #+ATTR_HTML: :width 300px
18488 and fall back on that number if none is found.
18490 When set to nil, try to get the width from an #+ATTR.* keyword
18491 and fall back on the original width if none is found.
18493 This requires Emacs >= 24.1, build with imagemagick support."
18494 :group 'org-appearance
18495 :version "24.4"
18496 :package-version '(Org . "8.0")
18497 :type '(choice
18498 (const :tag "Use the image width" t)
18499 (integer :tag "Use a number of pixels")
18500 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18501 (const :tag "Use #+ATTR* or don't resize" nil)))
18503 (defcustom org-agenda-inhibit-startup nil
18504 "Inhibit startup when preparing agenda buffers.
18505 When this variable is t, the initialization of the Org agenda
18506 buffers is inhibited: e.g. the visibility state is not set, the
18507 tables are not re-aligned, etc."
18508 :type 'boolean
18509 :version "24.3"
18510 :group 'org-agenda)
18512 (defcustom org-agenda-ignore-properties nil
18513 "Avoid updating text properties when building the agenda.
18514 Properties are used to prepare buffers for effort estimates,
18515 appointments, statistics and subtree-local categories.
18516 If you don't use these in the agenda, you can add them to this
18517 list and agenda building will be a bit faster.
18518 The value is a list, with zero or more of the symbols `effort', `appt',
18519 `stats' or `category'."
18520 :type '(set :greedy t
18521 (const effort)
18522 (const appt)
18523 (const stats)
18524 (const category))
18525 :version "26.1"
18526 :package-version '(Org . "8.3")
18527 :group 'org-agenda)
18529 (defun org-duration-string-to-minutes (s &optional output-to-string)
18530 "Convert a duration string S to minutes.
18532 A bare number is interpreted as minutes, modifiers can be set by
18533 customizing `org-effort-durations' (which see).
18535 Entries containing a colon are interpreted as H:MM by
18536 `org-hh:mm-string-to-minutes'."
18537 (let ((result 0)
18538 (re (concat "\\([0-9.]+\\) *\\("
18539 (regexp-opt (mapcar 'car org-effort-durations))
18540 "\\)")))
18541 (while (string-match re s)
18542 (cl-incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18543 (string-to-number (match-string 1 s))))
18544 (setq s (replace-match "" nil t s)))
18545 (setq result (floor result))
18546 (cl-incf result (org-hh:mm-string-to-minutes s))
18547 (if output-to-string (number-to-string result) result)))
18549 ;;;; Files
18551 (defun org-save-all-org-buffers ()
18552 "Save all Org buffers without user confirmation."
18553 (interactive)
18554 (message "Saving all Org buffers...")
18555 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18556 (when (featurep 'org-id) (org-id-locations-save))
18557 (message "Saving all Org buffers... done"))
18559 (defun org-revert-all-org-buffers ()
18560 "Revert all Org buffers.
18561 Prompt for confirmation when there are unsaved changes.
18562 Be sure you know what you are doing before letting this function
18563 overwrite your changes.
18565 This function is useful in a setup where one tracks org files
18566 with a version control system, to revert on one machine after pulling
18567 changes from another. I believe the procedure must be like this:
18569 1. M-x org-save-all-org-buffers
18570 2. Pull changes from the other machine, resolve conflicts
18571 3. M-x org-revert-all-org-buffers"
18572 (interactive)
18573 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18574 (user-error "Abort"))
18575 (save-excursion
18576 (save-window-excursion
18577 (dolist (b (buffer-list))
18578 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18579 (with-current-buffer b buffer-file-name))
18580 (pop-to-buffer-same-window b)
18581 (revert-buffer t 'no-confirm)))
18582 (when (and (featurep 'org-id) org-id-track-globally)
18583 (org-id-locations-load)))))
18585 ;;;; Agenda files
18587 ;;;###autoload
18588 (defun org-switchb (&optional arg)
18589 "Switch between Org buffers.
18591 With `\\[universal-argument]' prefix, restrict available buffers to files.
18593 With `\\[universal-argument] \\[universal-argument]' \
18594 prefix, restrict available buffers to agenda files."
18595 (interactive "P")
18596 (let ((blist (org-buffer-list
18597 (cond ((equal arg '(4)) 'files)
18598 ((equal arg '(16)) 'agenda)))))
18599 (pop-to-buffer-same-window
18600 (completing-read "Org buffer: "
18601 (mapcar #'list (mapcar #'buffer-name blist))
18602 nil t))))
18604 (defun org-buffer-list (&optional predicate exclude-tmp)
18605 "Return a list of Org buffers.
18606 PREDICATE can be `export', `files' or `agenda'.
18608 export restrict the list to Export buffers.
18609 files restrict the list to buffers visiting Org files.
18610 agenda restrict the list to buffers visiting agenda files.
18612 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18613 (let* ((bfn nil)
18614 (agenda-files (and (eq predicate 'agenda)
18615 (mapcar 'file-truename (org-agenda-files t))))
18616 (filter
18617 (cond
18618 ((eq predicate 'files)
18619 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18620 ((eq predicate 'export)
18621 (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
18622 ((eq predicate 'agenda)
18623 (lambda (b)
18624 (with-current-buffer b
18625 (and (derived-mode-p 'org-mode)
18626 (setq bfn (buffer-file-name b))
18627 (member (file-truename bfn) agenda-files)))))
18628 (t (lambda (b) (with-current-buffer b
18629 (or (derived-mode-p 'org-mode)
18630 (string-match "\\*Org .*Export"
18631 (buffer-name b)))))))))
18632 (delq nil
18633 (mapcar
18634 (lambda(b)
18635 (if (and (funcall filter b)
18636 (or (not exclude-tmp)
18637 (not (string-match "tmp" (buffer-name b)))))
18639 nil))
18640 (buffer-list)))))
18642 (defun org-agenda-files (&optional unrestricted archives)
18643 "Get the list of agenda files.
18644 Optional UNRESTRICTED means return the full list even if a restriction
18645 is currently in place.
18646 When ARCHIVES is t, include all archive files that are really being
18647 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18648 `org-agenda-archives-mode' is t."
18649 (let ((files
18650 (cond
18651 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18652 ((stringp org-agenda-files) (org-read-agenda-file-list))
18653 ((listp org-agenda-files) org-agenda-files)
18654 (t (error "Invalid value of `org-agenda-files'")))))
18655 (setq files (apply 'append
18656 (mapcar (lambda (f)
18657 (if (file-directory-p f)
18658 (directory-files
18659 f t org-agenda-file-regexp)
18660 (list f)))
18661 files)))
18662 (when org-agenda-skip-unavailable-files
18663 (setq files (delq nil
18664 (mapcar (function
18665 (lambda (file)
18666 (and (file-readable-p file) file)))
18667 files))))
18668 (when (or (eq archives t)
18669 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18670 (setq files (org-add-archive-files files)))
18671 files))
18673 (defun org-agenda-file-p (&optional file)
18674 "Return non-nil, if FILE is an agenda file.
18675 If FILE is omitted, use the file associated with the current
18676 buffer."
18677 (let ((fname (or file (buffer-file-name))))
18678 (and fname
18679 (member (file-truename fname)
18680 (mapcar #'file-truename (org-agenda-files t))))))
18682 (defun org-edit-agenda-file-list ()
18683 "Edit the list of agenda files.
18684 Depending on setup, this either uses customize to edit the variable
18685 `org-agenda-files', or it visits the file that is holding the list. In the
18686 latter case, the buffer is set up in a way that saving it automatically kills
18687 the buffer and restores the previous window configuration."
18688 (interactive)
18689 (if (stringp org-agenda-files)
18690 (let ((cw (current-window-configuration)))
18691 (find-file org-agenda-files)
18692 (setq-local org-window-configuration cw)
18693 (add-hook 'after-save-hook
18694 (lambda ()
18695 (set-window-configuration
18696 (prog1 org-window-configuration
18697 (kill-buffer (current-buffer))))
18698 (org-install-agenda-files-menu)
18699 (message "New agenda file list installed"))
18700 nil 'local)
18701 (message "%s" (substitute-command-keys
18702 "Edit list and finish with \\[save-buffer]")))
18703 (customize-variable 'org-agenda-files)))
18705 (defun org-store-new-agenda-file-list (list)
18706 "Set new value for the agenda file list and save it correctly."
18707 (if (stringp org-agenda-files)
18708 (let ((fe (org-read-agenda-file-list t)) b u)
18709 (while (setq b (find-buffer-visiting org-agenda-files))
18710 (kill-buffer b))
18711 (with-temp-file org-agenda-files
18712 (insert
18713 (mapconcat
18714 (lambda (f) ;; Keep un-expanded entries.
18715 (if (setq u (assoc f fe))
18716 (cdr u)
18718 list "\n")
18719 "\n")))
18720 (let ((org-mode-hook nil) (org-inhibit-startup t)
18721 (org-insert-mode-line-in-empty-file nil))
18722 (setq org-agenda-files list)
18723 (customize-save-variable 'org-agenda-files org-agenda-files))))
18725 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18726 "Read the list of agenda files from a file.
18727 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18728 filenames, used by `org-store-new-agenda-file-list' to write back
18729 un-expanded file names."
18730 (when (file-directory-p org-agenda-files)
18731 (error "`org-agenda-files' cannot be a single directory"))
18732 (when (stringp org-agenda-files)
18733 (with-temp-buffer
18734 (insert-file-contents org-agenda-files)
18735 (mapcar
18736 (lambda (f)
18737 (let ((e (expand-file-name (substitute-in-file-name f)
18738 org-directory)))
18739 (if pair-with-expansion
18740 (cons e f)
18741 e)))
18742 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18744 ;;;###autoload
18745 (defun org-cycle-agenda-files ()
18746 "Cycle through the files in `org-agenda-files'.
18747 If the current buffer visits an agenda file, find the next one in the list.
18748 If the current buffer does not, find the first agenda file."
18749 (interactive)
18750 (let* ((fs (or (org-agenda-files t)
18751 (user-error "No agenda files")))
18752 (files (copy-sequence fs))
18753 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18754 file)
18755 (when tcf
18756 (while (and (setq file (pop files))
18757 (not (equal (file-truename file) tcf)))))
18758 (find-file (car (or files fs)))
18759 (when (buffer-base-buffer) (pop-to-buffer-same-window (buffer-base-buffer)))))
18761 (defun org-agenda-file-to-front (&optional to-end)
18762 "Move/add the current file to the top of the agenda file list.
18763 If the file is not present in the list, it is added to the front. If it is
18764 present, it is moved there. With optional argument TO-END, add/move to the
18765 end of the list."
18766 (interactive "P")
18767 (let ((org-agenda-skip-unavailable-files nil)
18768 (file-alist (mapcar (lambda (x)
18769 (cons (file-truename x) x))
18770 (org-agenda-files t)))
18771 (ctf (file-truename
18772 (or buffer-file-name
18773 (user-error "Please save the current buffer to a file"))))
18774 x had)
18775 (setq x (assoc ctf file-alist) had x)
18777 (unless x (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18778 (if to-end
18779 (setq file-alist (append (delq x file-alist) (list x)))
18780 (setq file-alist (cons x (delq x file-alist))))
18781 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18782 (org-install-agenda-files-menu)
18783 (message "File %s to %s of agenda file list"
18784 (if had "moved" "added") (if to-end "end" "front"))))
18786 (defun org-remove-file (&optional file)
18787 "Remove current file from the list of files in variable `org-agenda-files'.
18788 These are the files which are being checked for agenda entries.
18789 Optional argument FILE means use this file instead of the current."
18790 (interactive)
18791 (let* ((org-agenda-skip-unavailable-files nil)
18792 (file (or file buffer-file-name
18793 (user-error "Current buffer does not visit a file")))
18794 (true-file (file-truename file))
18795 (afile (abbreviate-file-name file))
18796 (files (delq nil (mapcar
18797 (lambda (x)
18798 (unless (equal true-file
18799 (file-truename x))
18801 (org-agenda-files t)))))
18802 (if (not (= (length files) (length (org-agenda-files t))))
18803 (progn
18804 (org-store-new-agenda-file-list files)
18805 (org-install-agenda-files-menu)
18806 (message "Removed from Org Agenda list: %s" afile))
18807 (message "File was not in list: %s (not removed)" afile))))
18809 (defun org-file-menu-entry (file)
18810 (vector file (list 'find-file file) t))
18812 (defun org-check-agenda-file (file)
18813 "Make sure FILE exists. If not, ask user what to do."
18814 (unless (file-exists-p file)
18815 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18816 (abbreviate-file-name file))
18817 (let ((r (downcase (read-char-exclusive))))
18818 (cond
18819 ((equal r ?r)
18820 (org-remove-file file)
18821 (throw 'nextfile t))
18822 (t (user-error "Abort"))))))
18824 (defun org-get-agenda-file-buffer (file)
18825 "Get an agenda buffer visiting FILE.
18826 If the buffer needs to be created, add it to the list of buffers
18827 which might be released later."
18828 (let ((buf (org-find-base-buffer-visiting file)))
18829 (if buf
18830 buf ; just return it
18831 ;; Make a new buffer and remember it
18832 (setq buf (find-file-noselect file))
18833 (when buf (push buf org-agenda-new-buffers))
18834 buf)))
18836 (defun org-release-buffers (blist)
18837 "Release all buffers in list, asking the user for confirmation when needed.
18838 When a buffer is unmodified, it is just killed. When modified, it is saved
18839 \(if the user agrees) and then killed."
18840 (let (file)
18841 (dolist (buf blist)
18842 (setq file (buffer-file-name buf))
18843 (when (and (buffer-modified-p buf)
18844 file
18845 (y-or-n-p (format "Save file %s? " file)))
18846 (with-current-buffer buf (save-buffer)))
18847 (kill-buffer buf))))
18849 (defun org-agenda-prepare-buffers (files)
18850 "Create buffers for all agenda files, protect archived trees and comments."
18851 (interactive)
18852 (let ((pa '(:org-archived t))
18853 (pc '(:org-comment t))
18854 (pall '(:org-archived t :org-comment t))
18855 (inhibit-read-only t)
18856 (org-inhibit-startup org-agenda-inhibit-startup)
18857 (rea (concat ":" org-archive-tag ":"))
18858 re pos)
18859 (setq org-tag-alist-for-agenda nil
18860 org-tag-groups-alist-for-agenda nil)
18861 (save-excursion
18862 (save-restriction
18863 (dolist (file files)
18864 (catch 'nextfile
18865 (if (bufferp file)
18866 (set-buffer file)
18867 (org-check-agenda-file file)
18868 (set-buffer (org-get-agenda-file-buffer file)))
18869 (widen)
18870 (org-set-regexps-and-options 'tags-only)
18871 (setq pos (point))
18872 (or (memq 'category org-agenda-ignore-properties)
18873 (org-refresh-category-properties))
18874 (or (memq 'stats org-agenda-ignore-properties)
18875 (org-refresh-stats-properties))
18876 (or (memq 'effort org-agenda-ignore-properties)
18877 (org-refresh-effort-properties))
18878 (or (memq 'appt org-agenda-ignore-properties)
18879 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18880 (setq org-todo-keywords-for-agenda
18881 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18882 (setq org-done-keywords-for-agenda
18883 (append org-done-keywords-for-agenda org-done-keywords))
18884 (setq org-todo-keyword-alist-for-agenda
18885 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18886 (setq org-tag-alist-for-agenda
18887 (org-uniquify
18888 (append org-tag-alist-for-agenda
18889 org-current-tag-alist)))
18890 ;; Merge current file's tag groups into global
18891 ;; `org-tag-groups-alist-for-agenda'.
18892 (when org-group-tags
18893 (dolist (alist org-tag-groups-alist)
18894 (let ((old (assoc (car alist) org-tag-groups-alist-for-agenda)))
18895 (if old
18896 (setcdr old (org-uniquify (append (cdr old) (cdr alist))))
18897 (push alist org-tag-groups-alist-for-agenda)))))
18898 (org-with-silent-modifications
18899 (save-excursion
18900 (remove-text-properties (point-min) (point-max) pall)
18901 (when org-agenda-skip-archived-trees
18902 (goto-char (point-min))
18903 (while (re-search-forward rea nil t)
18904 (when (org-at-heading-p t)
18905 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18906 (goto-char (point-min))
18907 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18908 (while (re-search-forward re nil t)
18909 (when (save-match-data (org-in-commented-heading-p t))
18910 (add-text-properties
18911 (match-beginning 0) (org-end-of-subtree t) pc)))))
18912 (goto-char pos)))))
18913 (setq org-todo-keywords-for-agenda
18914 (org-uniquify org-todo-keywords-for-agenda))
18915 (setq org-todo-keyword-alist-for-agenda
18916 (org-uniquify org-todo-keyword-alist-for-agenda))))
18919 ;;;; CDLaTeX minor mode
18921 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18922 "Keymap for the minor `org-cdlatex-mode'.")
18924 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18925 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18926 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18927 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18928 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18930 (defvar org-cdlatex-texmathp-advice-is-done nil
18931 "Flag remembering if we have applied the advice to texmathp already.")
18933 (define-minor-mode org-cdlatex-mode
18934 "Toggle the minor `org-cdlatex-mode'.
18935 This mode supports entering LaTeX environment and math in LaTeX fragments
18936 in Org mode.
18937 \\{org-cdlatex-mode-map}"
18938 nil " OCDL" nil
18939 (when org-cdlatex-mode
18940 (require 'cdlatex)
18941 (run-hooks 'cdlatex-mode-hook)
18942 (cdlatex-compute-tables))
18943 (unless org-cdlatex-texmathp-advice-is-done
18944 (setq org-cdlatex-texmathp-advice-is-done t)
18945 (defadvice texmathp (around org-math-always-on activate)
18946 "Always return t in Org buffers.
18947 This is because we want to insert math symbols without dollars even outside
18948 the LaTeX math segments. If Org mode thinks that point is actually inside
18949 an embedded LaTeX fragment, let `texmathp' do its job.
18950 `\\[org-cdlatex-mode-map]'"
18951 (interactive)
18952 (let (p)
18953 (cond
18954 ((not (derived-mode-p 'org-mode)) ad-do-it)
18955 ((eq this-command 'cdlatex-math-symbol)
18956 (setq ad-return-value t
18957 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18959 (let ((p (org-inside-LaTeX-fragment-p)))
18960 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18961 (setq ad-return-value t
18962 texmathp-why '("Org mode embedded math" . 0))
18963 (when p ad-do-it)))))))))
18965 (defun turn-on-org-cdlatex ()
18966 "Unconditionally turn on `org-cdlatex-mode'."
18967 (org-cdlatex-mode 1))
18969 (defun org-try-cdlatex-tab ()
18970 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18971 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18972 - inside a LaTeX fragment, or
18973 - after the first word in a line, where an abbreviation expansion could
18974 insert a LaTeX environment."
18975 (when org-cdlatex-mode
18976 (cond
18977 ;; Before any word on the line: No expansion possible.
18978 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18979 ;; Just after first word on the line: Expand it. Make sure it
18980 ;; cannot happen on headlines, though.
18981 ((save-excursion
18982 (skip-chars-backward "a-zA-Z0-9*")
18983 (skip-chars-backward " \t")
18984 (and (bolp) (not (org-at-heading-p))))
18985 (cdlatex-tab) t)
18986 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18988 (defun org-cdlatex-underscore-caret (&optional _arg)
18989 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18990 Revert to the normal definition outside of these fragments."
18991 (interactive "P")
18992 (if (org-inside-LaTeX-fragment-p)
18993 (call-interactively 'cdlatex-sub-superscript)
18994 (let (org-cdlatex-mode)
18995 (call-interactively (key-binding (vector last-input-event))))))
18997 (defun org-cdlatex-math-modify (&optional _arg)
18998 "Execute `cdlatex-math-modify' in LaTeX fragments.
18999 Revert to the normal definition outside of these fragments."
19000 (interactive "P")
19001 (if (org-inside-LaTeX-fragment-p)
19002 (call-interactively 'cdlatex-math-modify)
19003 (let (org-cdlatex-mode)
19004 (call-interactively (key-binding (vector last-input-event))))))
19006 (defun org-cdlatex-environment-indent (&optional environment item)
19007 "Execute `cdlatex-environment' and indent the inserted environment.
19009 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
19011 The inserted environment is indented to current indentation
19012 unless point is at the beginning of the line, in which the
19013 environment remains unintended."
19014 (interactive)
19015 ;; cdlatex-environment always return nil. Therefore, capture output
19016 ;; first and determine if an environment was selected.
19017 (let* ((beg (point-marker))
19018 (end (copy-marker (point) t))
19019 (inserted (progn
19020 (ignore-errors (cdlatex-environment environment item))
19021 (< beg end)))
19022 ;; Figure out how many lines to move forward after the
19023 ;; environment has been inserted.
19024 (lines (when inserted
19025 (save-excursion
19026 (- (cl-loop while (< beg (point))
19027 with x = 0
19028 do (forward-line -1)
19029 (cl-incf x)
19030 finally return x)
19031 (if (progn (goto-char beg)
19032 (and (progn (skip-chars-forward " \t") (eolp))
19033 (progn (skip-chars-backward " \t") (bolp))))
19034 1 0)))))
19035 (env (org-trim (delete-and-extract-region beg end))))
19036 (when inserted
19037 ;; Get indentation of next line unless at column 0.
19038 (let ((ind (if (bolp) 0
19039 (save-excursion
19040 (org-return-indent)
19041 (prog1 (org-get-indentation)
19042 (when (progn (skip-chars-forward " \t") (eolp))
19043 (delete-region beg (point)))))))
19044 (bol (progn (skip-chars-backward " \t") (bolp))))
19045 ;; Insert a newline before environment unless at column zero
19046 ;; to "escape" the current line. Insert a newline if
19047 ;; something is one the same line as \end{ENVIRONMENT}.
19048 (insert
19049 (concat (unless bol "\n") env
19050 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
19051 (unless (zerop ind)
19052 (save-excursion
19053 (goto-char beg)
19054 (while (< (point) end)
19055 (unless (eolp) (indent-line-to ind))
19056 (forward-line))))
19057 (goto-char beg)
19058 (forward-line lines)
19059 (indent-line-to ind)))
19060 (set-marker beg nil)
19061 (set-marker end nil)))
19064 ;;;; LaTeX fragments
19066 (defun org-inside-LaTeX-fragment-p ()
19067 "Test if point is inside a LaTeX fragment.
19068 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
19069 sequence appearing also before point.
19070 Even though the matchers for math are configurable, this function assumes
19071 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
19072 delimiters are skipped when they have been removed by customization.
19073 The return value is nil, or a cons cell with the delimiter and the
19074 position of this delimiter.
19076 This function does a reasonably good job, but can locally be fooled by
19077 for example currency specifications. For example it will assume being in
19078 inline math after \"$22.34\". The LaTeX fragment formatter will only format
19079 fragments that are properly closed, but during editing, we have to live
19080 with the uncertainty caused by missing closing delimiters. This function
19081 looks only before point, not after."
19082 (catch 'exit
19083 (let ((pos (point))
19084 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
19085 (lim (progn
19086 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
19087 (point)))
19088 dd-on str (start 0) m re)
19089 (goto-char pos)
19090 (when dodollar
19091 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
19092 re (nth 1 (assoc "$" org-latex-regexps)))
19093 (while (string-match re str start)
19094 (cond
19095 ((= (match-end 0) (length str))
19096 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
19097 ((= (match-end 0) (- (length str) 5))
19098 (throw 'exit nil))
19099 (t (setq start (match-end 0))))))
19100 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
19101 (goto-char pos)
19102 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
19103 (and (match-beginning 2) (throw 'exit nil))
19104 ;; count $$
19105 (while (re-search-backward "\\$\\$" lim t)
19106 (setq dd-on (not dd-on)))
19107 (goto-char pos)
19108 (when dd-on (cons "$$" m))))))
19110 (defun org-inside-latex-macro-p ()
19111 "Is point inside a LaTeX macro or its arguments?"
19112 (save-match-data
19113 (org-in-regexp
19114 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
19116 (defun org--format-latex-make-overlay (beg end image &optional imagetype)
19117 "Build an overlay between BEG and END using IMAGE file.
19118 Argument IMAGETYPE is the extension of the displayed image,
19119 as a string. It defaults to \"png\"."
19120 (let ((ov (make-overlay beg end))
19121 (imagetype (or (intern imagetype) 'png)))
19122 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
19123 (overlay-put ov 'evaporate t)
19124 (overlay-put ov
19125 'modification-hooks
19126 (list (lambda (o _flag _beg _end &optional _l)
19127 (delete-overlay o))))
19128 (overlay-put ov
19129 'display
19130 (list 'image :type imagetype :file image :ascent 'center))))
19132 (defun org--list-latex-overlays (&optional beg end)
19133 "List all Org LaTeX overlays in current buffer.
19134 Limit to overlays between BEG and END when those are provided."
19135 (cl-remove-if-not
19136 (lambda (o) (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay))
19137 (overlays-in (or beg (point-min)) (or end (point-max)))))
19139 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
19140 "Remove all overlays with LaTeX fragment images in current buffer.
19141 When optional arguments BEG and END are non-nil, remove all
19142 overlays between them instead. Return a non-nil value when some
19143 overlays were removed, nil otherwise."
19144 (let ((overlays (org--list-latex-overlays beg end)))
19145 (mapc #'delete-overlay overlays)
19146 overlays))
19148 (defun org-toggle-latex-fragment (&optional arg)
19149 "Preview the LaTeX fragment at point, or all locally or globally.
19151 If the cursor is on a LaTeX fragment, create the image and overlay
19152 it over the source code, if there is none. Remove it otherwise.
19153 If there is no fragment at point, display all fragments in the
19154 current section.
19156 With prefix ARG, preview or clear image for all fragments in the
19157 current subtree or in the whole buffer when used before the first
19158 headline. With a prefix ARG `\\[universal-argument] \
19159 \\[universal-argument]' preview or clear images
19160 for all fragments in the buffer."
19161 (interactive "P")
19162 (when (display-graphic-p)
19163 (catch 'exit
19164 (save-excursion
19165 (let (beg end msg)
19166 (cond
19167 ((or (equal arg '(16))
19168 (and (equal arg '(4))
19169 (org-with-limited-levels (org-before-first-heading-p))))
19170 (if (org-remove-latex-fragment-image-overlays)
19171 (progn (message "LaTeX fragments images removed from buffer")
19172 (throw 'exit nil))
19173 (setq msg "Creating images for buffer...")))
19174 ((equal arg '(4))
19175 (org-with-limited-levels (org-back-to-heading t))
19176 (setq beg (point))
19177 (setq end (progn (org-end-of-subtree t) (point)))
19178 (if (org-remove-latex-fragment-image-overlays beg end)
19179 (progn
19180 (message "LaTeX fragment images removed from subtree")
19181 (throw 'exit nil))
19182 (setq msg "Creating images for subtree...")))
19183 ((let ((datum (org-element-context)))
19184 (when (memq (org-element-type datum)
19185 '(latex-environment latex-fragment))
19186 (setq beg (org-element-property :begin datum))
19187 (setq end (org-element-property :end datum))
19188 (if (org-remove-latex-fragment-image-overlays beg end)
19189 (progn (message "LaTeX fragment image removed")
19190 (throw 'exit nil))
19191 (setq msg "Creating image...")))))
19193 (org-with-limited-levels
19194 (setq beg (if (org-at-heading-p) (line-beginning-position)
19195 (outline-previous-heading)
19196 (point)))
19197 (setq end (progn (outline-next-heading) (point)))
19198 (if (org-remove-latex-fragment-image-overlays beg end)
19199 (progn
19200 (message "LaTeX fragment images removed from section")
19201 (throw 'exit nil))
19202 (setq msg "Creating images for section...")))))
19203 (let ((file (buffer-file-name (buffer-base-buffer))))
19204 (org-format-latex
19205 (concat org-preview-latex-image-directory "org-ltximg")
19206 beg end
19207 ;; Emacs cannot overlay images from remote hosts. Create
19208 ;; it in `temporary-file-directory' instead.
19209 (if (or (not file) (file-remote-p file))
19210 temporary-file-directory
19211 default-directory)
19212 'overlays msg 'forbuffer org-preview-latex-default-process))
19213 (message (concat msg "done")))))))
19215 (defun org-format-latex
19216 (prefix &optional beg end dir overlays msg forbuffer processing-type)
19217 "Replace LaTeX fragments with links to an image.
19219 The function takes care of creating the replacement image.
19221 Only consider fragments between BEG and END when those are
19222 provided.
19224 When optional argument OVERLAYS is non-nil, display the image on
19225 top of the fragment instead of replacing it.
19227 PROCESSING-TYPE is the conversion method to use, as a symbol.
19229 Some of the options can be changed using the variable
19230 `org-format-latex-options', which see."
19231 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19232 (unless (eq processing-type 'verbatim)
19233 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19234 (cnt 0)
19235 checkdir-flag)
19236 (goto-char (or beg (point-min)))
19237 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19238 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19239 (overlay-recenter (or end (point-max))))
19240 (while (re-search-forward math-regexp end t)
19241 (unless (and overlays
19242 (eq (get-char-property (point) 'org-overlay-type)
19243 'org-latex-overlay))
19244 (let* ((context (org-element-context))
19245 (type (org-element-type context)))
19246 (when (memq type '(latex-environment latex-fragment))
19247 (let ((block-type (eq type 'latex-environment))
19248 (value (org-element-property :value context))
19249 (beg (org-element-property :begin context))
19250 (end (save-excursion
19251 (goto-char (org-element-property :end context))
19252 (skip-chars-backward " \r\t\n")
19253 (point))))
19254 (cond
19255 ((eq processing-type 'mathjax)
19256 ;; Prepare for MathJax processing.
19257 (if (not (string-match "\\`\\$\\$?" value))
19258 (goto-char end)
19259 (delete-region beg end)
19260 (if (string= (match-string 0 value) "$$")
19261 (insert "\\[" (substring value 2 -2) "\\]")
19262 (insert "\\(" (substring value 1 -1) "\\)"))))
19263 ((assq processing-type org-preview-latex-process-alist)
19264 ;; Process to an image.
19265 (cl-incf cnt)
19266 (goto-char beg)
19267 (let* ((processing-info
19268 (cdr (assq processing-type org-preview-latex-process-alist)))
19269 (face (face-at-point))
19270 ;; Get the colors from the face at point.
19272 (let ((color (plist-get org-format-latex-options
19273 :foreground)))
19274 (if (and forbuffer (eq color 'auto))
19275 (face-attribute face :foreground nil 'default)
19276 color)))
19278 (let ((color (plist-get org-format-latex-options
19279 :background)))
19280 (if (and forbuffer (eq color 'auto))
19281 (face-attribute face :background nil 'default)
19282 color)))
19283 (hash (sha1 (prin1-to-string
19284 (list org-format-latex-header
19285 org-latex-default-packages-alist
19286 org-latex-packages-alist
19287 org-format-latex-options
19288 forbuffer value fg bg))))
19289 (imagetype (or (plist-get processing-info :image-output-type) "png"))
19290 (absprefix (expand-file-name prefix dir))
19291 (linkfile (format "%s_%s.%s" prefix hash imagetype))
19292 (movefile (format "%s_%s.%s" absprefix hash imagetype))
19293 (sep (and block-type "\n\n"))
19294 (link (concat sep "[[file:" linkfile "]]" sep))
19295 (options
19296 (org-combine-plists
19297 org-format-latex-options
19298 `(:foreground ,fg :background ,bg))))
19299 (when msg (message msg cnt))
19300 (unless checkdir-flag ; Ensure the directory exists.
19301 (setq checkdir-flag t)
19302 (let ((todir (file-name-directory absprefix)))
19303 (unless (file-directory-p todir)
19304 (make-directory todir t))))
19305 (unless (file-exists-p movefile)
19306 (org-create-formula-image
19307 value movefile options forbuffer processing-type))
19308 (if overlays
19309 (progn
19310 (dolist (o (overlays-in beg end))
19311 (when (eq (overlay-get o 'org-overlay-type)
19312 'org-latex-overlay)
19313 (delete-overlay o)))
19314 (org--format-latex-make-overlay beg end movefile imagetype)
19315 (goto-char end))
19316 (delete-region beg end)
19317 (insert
19318 (org-add-props link
19319 (list 'org-latex-src
19320 (replace-regexp-in-string "\"" "" value)
19321 'org-latex-src-embed-type
19322 (if block-type 'paragraph 'character)))))))
19323 ((eq processing-type 'mathml)
19324 ;; Process to MathML.
19325 (unless (org-format-latex-mathml-available-p)
19326 (user-error "LaTeX to MathML converter not configured"))
19327 (cl-incf cnt)
19328 (when msg (message msg cnt))
19329 (goto-char beg)
19330 (delete-region beg end)
19331 (insert (org-format-latex-as-mathml
19332 value block-type prefix dir)))
19334 (error "Unknown conversion process %s for LaTeX fragments"
19335 processing-type)))))))))))
19337 (defun org-create-math-formula (latex-frag &optional mathml-file)
19338 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19339 Use `org-latex-to-mathml-convert-command'. If the conversion is
19340 sucessful, return the portion between \"<math...> </math>\"
19341 elements otherwise return nil. When MATHML-FILE is specified,
19342 write the results in to that file. When invoked as an
19343 interactive command, prompt for LATEX-FRAG, with initial value
19344 set to the current active region and echo the results for user
19345 inspection."
19346 (interactive (list (let ((frag (when (org-region-active-p)
19347 (buffer-substring-no-properties
19348 (region-beginning) (region-end)))))
19349 (read-string "LaTeX Fragment: " frag nil frag))))
19350 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19351 (let* ((tmp-in-file
19352 (let ((file (file-relative-name
19353 (make-temp-name (expand-file-name "ltxmathml-in")))))
19354 (write-region latex-frag nil file)
19355 file))
19356 (tmp-out-file (file-relative-name
19357 (make-temp-name (expand-file-name "ltxmathml-out"))))
19358 (cmd (format-spec
19359 org-latex-to-mathml-convert-command
19360 `((?j . ,(and org-latex-to-mathml-jar-file
19361 (shell-quote-argument
19362 (expand-file-name
19363 org-latex-to-mathml-jar-file))))
19364 (?I . ,(shell-quote-argument tmp-in-file))
19365 (?i . ,latex-frag)
19366 (?o . ,(shell-quote-argument tmp-out-file)))))
19367 mathml shell-command-output)
19368 (when (called-interactively-p 'any)
19369 (unless (org-format-latex-mathml-available-p)
19370 (user-error "LaTeX to MathML converter not configured")))
19371 (message "Running %s" cmd)
19372 (setq shell-command-output (shell-command-to-string cmd))
19373 (setq mathml
19374 (when (file-readable-p tmp-out-file)
19375 (with-current-buffer (find-file-noselect tmp-out-file t)
19376 (goto-char (point-min))
19377 (when (re-search-forward
19378 (format "<math[^>]*?%s[^>]*?>\\(.\\|\n\\)*</math>"
19379 (regexp-quote
19380 "xmlns=\"http://www.w3.org/1998/Math/MathML\""))
19381 nil t)
19382 (prog1 (match-string 0) (kill-buffer))))))
19383 (cond
19384 (mathml
19385 (setq mathml
19386 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19387 (when mathml-file
19388 (write-region mathml nil mathml-file))
19389 (when (called-interactively-p 'any)
19390 (message mathml)))
19391 ((message "LaTeX to MathML conversion failed")
19392 (message shell-command-output)))
19393 (delete-file tmp-in-file)
19394 (when (file-exists-p tmp-out-file)
19395 (delete-file tmp-out-file))
19396 mathml))
19398 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19399 prefix &optional dir)
19400 "Use `org-create-math-formula' but check local cache first."
19401 (let* ((absprefix (expand-file-name prefix dir))
19402 (print-length nil) (print-level nil)
19403 (formula-id (concat
19404 "formula-"
19405 (sha1
19406 (prin1-to-string
19407 (list latex-frag
19408 org-latex-to-mathml-convert-command)))))
19409 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19410 (formula-cache-dir (file-name-directory formula-cache)))
19412 (unless (file-directory-p formula-cache-dir)
19413 (make-directory formula-cache-dir t))
19415 (unless (file-exists-p formula-cache)
19416 (org-create-math-formula latex-frag formula-cache))
19418 (if (file-exists-p formula-cache)
19419 ;; Successful conversion. Return the link to MathML file.
19420 (org-add-props
19421 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19422 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19423 'org-latex-src-embed-type (if latex-frag-type
19424 'paragraph 'character)))
19425 ;; Failed conversion. Return the LaTeX fragment verbatim
19426 latex-frag)))
19428 (defun org--get-display-dpi ()
19429 "Get the DPI of the display.
19430 The function assumes that the display has the same pixel width in
19431 the horizontal and vertical directions."
19432 (if (display-graphic-p)
19433 (round (/ (display-pixel-height)
19434 (/ (display-mm-height) 25.4)))
19435 (error "Attempt to calculate the dpi of a non-graphic display")))
19437 (defun org-create-formula-image
19438 (string tofile options buffer &optional processing-type)
19439 "Create an image from LaTeX source using external processes.
19441 The LaTeX STRING is saved to a temporary LaTeX file, then
19442 converted to an image file by process PROCESSING-TYPE defined in
19443 `org-preview-latex-process-alist'. A nil value defaults to
19444 `org-preview-latex-default-process'.
19446 The generated image file is eventually moved to TOFILE.
19448 The OPTIONS argument controls the size, foreground color and
19449 background color of the generated image.
19451 When BUFFER non-nil, this function is used for LaTeX previewing.
19452 Otherwise, it is used to deal with LaTeX snippets showed in
19453 a HTML file."
19454 (let* ((processing-type (or processing-type
19455 org-preview-latex-default-process))
19456 (processing-info
19457 (cdr (assq processing-type org-preview-latex-process-alist)))
19458 (programs (plist-get processing-info :programs))
19459 (error-message (or (plist-get processing-info :message) ""))
19460 (use-xcolor (plist-get processing-info :use-xcolor))
19461 (image-input-type (plist-get processing-info :image-input-type))
19462 (image-output-type (plist-get processing-info :image-output-type))
19463 (post-clean (or (plist-get processing-info :post-clean)
19464 '(".dvi" ".xdv" ".pdf" ".tex" ".aux" ".log"
19465 ".svg" ".png" ".jpg" ".jpeg" ".out")))
19466 (latex-header
19467 (or (plist-get processing-info :latex-header)
19468 (org-latex-make-preamble
19469 (org-export-get-environment (org-export-get-backend 'latex))
19470 org-format-latex-header)))
19471 (latex-compiler (plist-get processing-info :latex-compiler))
19472 (image-converter (plist-get processing-info :image-converter))
19473 (tmpdir temporary-file-directory)
19474 (texfilebase (make-temp-name
19475 (expand-file-name "orgtex" tmpdir)))
19476 (texfile (concat texfilebase ".tex"))
19477 (image-size-adjust (or (plist-get processing-info :image-size-adjust)
19478 '(1.0 . 1.0)))
19479 (scale (* (if buffer (car image-size-adjust) (cdr image-size-adjust))
19480 (or (plist-get options (if buffer :scale :html-scale)) 1.0)))
19481 (dpi (* scale (if buffer (org--get-display-dpi) 140.0)))
19482 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19483 "Black"))
19484 (bg (or (plist-get options (if buffer :background :html-background))
19485 "Transparent"))
19486 (log-buf (get-buffer-create "*Org Preview LaTeX Output*"))
19487 (resize-mini-windows nil)) ;Fix Emacs flicker when creating image.
19488 (dolist (program programs)
19489 (org-check-external-command program error-message))
19490 (if use-xcolor
19491 (progn (if (eq fg 'default)
19492 (setq fg (org-latex-color :foreground))
19493 (setq fg (org-latex-color-format fg)))
19494 (if (eq bg 'default)
19495 (setq bg (org-latex-color :background))
19496 (setq bg (org-latex-color-format
19497 (if (string= bg "Transparent") "white" bg))))
19498 (with-temp-file texfile
19499 (insert latex-header)
19500 (insert "\n\\begin{document}\n"
19501 "\\definecolor{fg}{rgb}{" fg "}\n"
19502 "\\definecolor{bg}{rgb}{" bg "}\n"
19503 "\n\\pagecolor{bg}\n"
19504 "\n{\\color{fg}\n"
19505 string
19506 "\n}\n"
19507 "\n\\end{document}\n")))
19508 (if (eq fg 'default)
19509 (setq fg (org-dvipng-color :foreground))
19510 (unless (string= fg "Transparent")
19511 (setq fg (org-dvipng-color-format fg))))
19512 (if (eq bg 'default)
19513 (setq bg (org-dvipng-color :background))
19514 (unless (string= bg "Transparent")
19515 (setq bg (org-dvipng-color-format bg))))
19516 (with-temp-file texfile
19517 (insert latex-header)
19518 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19520 (let* ((err-msg (format "Please adjust '%s' part of \
19521 `org-preview-latex-process-alist'."
19522 processing-type))
19523 (image-input-file
19524 (org-compile-file
19525 texfile latex-compiler image-input-type err-msg log-buf))
19526 (image-output-file
19527 (org-compile-file
19528 image-input-file image-converter image-output-type err-msg log-buf
19529 `((?F . ,(shell-quote-argument fg))
19530 (?B . ,(shell-quote-argument bg))
19531 (?D . ,(shell-quote-argument (format "%s" dpi)))
19532 (?S . ,(shell-quote-argument (format "%s" (/ dpi 140.0))))))))
19533 (copy-file image-output-file tofile 'replace)
19534 (dolist (e post-clean)
19535 (when (file-exists-p (concat texfilebase e))
19536 (delete-file (concat texfilebase e))))
19537 image-output-file)))
19539 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19540 "Fill a LaTeX header template TPL.
19541 In the template, the following place holders will be recognized:
19543 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19544 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19545 [PACKAGES] \\usepackage statements for PKG
19546 [NO-PACKAGES] do not include PKG
19547 [EXTRA] the string EXTRA
19548 [NO-EXTRA] do not include EXTRA
19550 For backward compatibility, if both the positive and the negative place
19551 holder is missing, the positive one (without the \"NO-\") will be
19552 assumed to be present at the end of the template.
19553 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19554 EXTRA is a string.
19555 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19556 (let (rpl (end ""))
19557 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19558 (setq rpl (if (or (match-end 1) (not def-pkg))
19559 "" (org-latex-packages-to-string def-pkg snippets-p t))
19560 tpl (replace-match rpl t t tpl))
19561 (when def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19563 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19564 (setq rpl (if (or (match-end 1) (not pkg))
19565 "" (org-latex-packages-to-string pkg snippets-p t))
19566 tpl (replace-match rpl t t tpl))
19567 (when pkg (setq end
19568 (concat end "\n"
19569 (org-latex-packages-to-string pkg snippets-p)))))
19571 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19572 (setq rpl (if (or (match-end 1) (not extra))
19573 "" (concat extra "\n"))
19574 tpl (replace-match rpl t t tpl))
19575 (when (and extra (string-match "\\S-" extra))
19576 (setq end (concat end "\n" extra))))
19578 (if (string-match "\\S-" end)
19579 (concat tpl "\n" end)
19580 tpl)))
19582 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19583 "Turn an alist of packages into a string with the \\usepackage macros."
19584 (setq pkg (mapconcat (lambda(p)
19585 (cond
19586 ((stringp p) p)
19587 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19588 (format "%% Package %s omitted" (cadr p)))
19589 ((equal "" (car p))
19590 (format "\\usepackage{%s}" (cadr p)))
19592 (format "\\usepackage[%s]{%s}"
19593 (car p) (cadr p)))))
19595 "\n"))
19596 (if newline (concat pkg "\n") pkg))
19598 (defun org-dvipng-color (attr)
19599 "Return a RGB color specification for dvipng."
19600 (org-dvipng-color-format (face-attribute 'default attr nil)))
19602 (defun org-dvipng-color-format (color-name)
19603 "Convert COLOR-NAME to a RGB color value for dvipng."
19604 (apply #'format "rgb %s %s %s"
19605 (mapcar 'org-normalize-color
19606 (color-values color-name))))
19608 (defun org-latex-color (attr)
19609 "Return a RGB color for the LaTeX color package."
19610 (org-latex-color-format (face-attribute 'default attr nil)))
19612 (defun org-latex-color-format (color-name)
19613 "Convert COLOR-NAME to a RGB color value."
19614 (apply #'format "%s,%s,%s"
19615 (mapcar 'org-normalize-color
19616 (color-values color-name))))
19618 (defun org-normalize-color (value)
19619 "Return string to be used as color value for an RGB component."
19620 (format "%g" (/ value 65535.0)))
19624 ;; Image display
19626 (defvar-local org-inline-image-overlays nil)
19628 (defun org-toggle-inline-images (&optional include-linked)
19629 "Toggle the display of inline images.
19630 INCLUDE-LINKED is passed to `org-display-inline-images'."
19631 (interactive "P")
19632 (if org-inline-image-overlays
19633 (progn
19634 (org-remove-inline-images)
19635 (when (called-interactively-p 'interactive)
19636 (message "Inline image display turned off")))
19637 (org-display-inline-images include-linked)
19638 (when (called-interactively-p 'interactive)
19639 (message (if org-inline-image-overlays
19640 (format "%d images displayed inline"
19641 (length org-inline-image-overlays))
19642 "No images to display inline")))))
19644 (defun org-redisplay-inline-images ()
19645 "Refresh the display of inline images."
19646 (interactive)
19647 (if (not org-inline-image-overlays)
19648 (org-toggle-inline-images)
19649 (org-toggle-inline-images)
19650 (org-toggle-inline-images)))
19652 (defun org-display-inline-images (&optional include-linked refresh beg end)
19653 "Display inline images.
19655 An inline image is a link which follows either of these
19656 conventions:
19658 1. Its path is a file with an extension matching return value
19659 from `image-file-name-regexp' and it has no contents.
19661 2. Its description consists in a single link of the previous
19662 type.
19664 When optional argument INCLUDE-LINKED is non-nil, also links with
19665 a text description part will be inlined. This can be nice for
19666 a quick look at those images, but it does not reflect what
19667 exported files will look like.
19669 When optional argument REFRESH is non-nil, refresh existing
19670 images between BEG and END. This will create new image displays
19671 only if necessary. BEG and END default to the buffer
19672 boundaries."
19673 (interactive "P")
19674 (when (display-graphic-p)
19675 (unless refresh
19676 (org-remove-inline-images)
19677 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19678 (org-with-wide-buffer
19679 (goto-char (or beg (point-min)))
19680 (let ((case-fold-search t)
19681 (file-extension-re (image-file-name-regexp)))
19682 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19683 (let ((link (save-match-data (org-element-context))))
19684 ;; Check if we're at an inline image.
19685 (when (and (equal (org-element-property :type link) "file")
19686 (or include-linked
19687 (not (org-element-property :contents-begin link)))
19688 (let ((parent (org-element-property :parent link)))
19689 (or (not (eq (org-element-type parent) 'link))
19690 (not (cdr (org-element-contents parent)))))
19691 (string-match-p file-extension-re
19692 (org-element-property :path link)))
19693 (let ((file (expand-file-name
19694 (org-link-unescape
19695 (org-element-property :path link)))))
19696 (when (file-exists-p file)
19697 (let ((width
19698 ;; Apply `org-image-actual-width' specifications.
19699 (cond
19700 ((not (image-type-available-p 'imagemagick)) nil)
19701 ((eq org-image-actual-width t) nil)
19702 ((listp org-image-actual-width)
19704 ;; First try to find a width among
19705 ;; attributes associated to the paragraph
19706 ;; containing link.
19707 (let ((paragraph
19708 (let ((e link))
19709 (while (and (setq e (org-element-property
19710 :parent e))
19711 (not (eq (org-element-type e)
19712 'paragraph))))
19713 e)))
19714 (when paragraph
19715 (save-excursion
19716 (goto-char (org-element-property :begin paragraph))
19717 (when
19718 (re-search-forward
19719 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19720 (org-element-property
19721 :post-affiliated paragraph)
19723 (string-to-number (match-string 1))))))
19724 ;; Otherwise, fall-back to provided number.
19725 (car org-image-actual-width)))
19726 ((numberp org-image-actual-width)
19727 org-image-actual-width)))
19728 (old (get-char-property-and-overlay
19729 (org-element-property :begin link)
19730 'org-image-overlay)))
19731 (if (and (car-safe old) refresh)
19732 (image-refresh (overlay-get (cdr old) 'display))
19733 (let ((image (create-image file
19734 (and width 'imagemagick)
19736 :width width)))
19737 (when image
19738 (let* ((link
19739 ;; If inline image is the description
19740 ;; of another link, be sure to
19741 ;; consider the latter as the one to
19742 ;; apply the overlay on.
19743 (let ((parent
19744 (org-element-property :parent link)))
19745 (if (eq (org-element-type parent) 'link)
19746 parent
19747 link)))
19748 (ov (make-overlay
19749 (org-element-property :begin link)
19750 (progn
19751 (goto-char
19752 (org-element-property :end link))
19753 (skip-chars-backward " \t")
19754 (point)))))
19755 (overlay-put ov 'display image)
19756 (overlay-put ov 'face 'default)
19757 (overlay-put ov 'org-image-overlay t)
19758 (overlay-put
19759 ov 'modification-hooks
19760 (list 'org-display-inline-remove-overlay))
19761 (push ov org-inline-image-overlays)))))))))))))))
19763 (defun org-display-inline-remove-overlay (ov after _beg _end &optional _len)
19764 "Remove inline-display overlay if a corresponding region is modified."
19765 (let ((inhibit-modification-hooks t))
19766 (when (and ov after)
19767 (delete ov org-inline-image-overlays)
19768 (delete-overlay ov))))
19770 (defun org-remove-inline-images ()
19771 "Remove inline display of images."
19772 (interactive)
19773 (mapc #'delete-overlay org-inline-image-overlays)
19774 (setq org-inline-image-overlays nil))
19776 ;;;; Key bindings
19778 ;; Outline functions from `outline-mode-prefix-map'
19779 ;; that can be remapped in Org:
19780 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19781 (define-key org-mode-map [remap outline-show-subtree] 'org-show-subtree)
19782 (define-key org-mode-map [remap outline-forward-same-level]
19783 'org-forward-heading-same-level)
19784 (define-key org-mode-map [remap outline-backward-same-level]
19785 'org-backward-heading-same-level)
19786 (define-key org-mode-map [remap outline-show-branches]
19787 'org-kill-note-or-show-branches)
19788 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19789 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19790 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19791 (define-key org-mode-map [remap outline-next-visible-heading]
19792 'org-next-visible-heading)
19793 (define-key org-mode-map [remap outline-previous-visible-heading]
19794 'org-previous-visible-heading)
19795 (define-key org-mode-map [remap show-children] 'org-show-children)
19797 ;; Outline functions from `outline-mode-prefix-map' that can not
19798 ;; be remapped in Org:
19800 ;; - the column "key binding" shows whether the Outline function is still
19801 ;; available in Org mode on the same key that it has been bound to in
19802 ;; Outline mode:
19803 ;; - "overridden": key used for a different functionality in Org mode
19804 ;; - else: key still bound to the same Outline function in Org mode
19806 ;; | Outline function | key binding | Org replacement |
19807 ;; |------------------------------------+-------------+--------------------------|
19808 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19809 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19810 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19811 ;; | `show-entry' | overridden | no replacement |
19812 ;; | `show-branches' | `C-c C-k' | still same function |
19813 ;; | `show-subtree' | overridden | visibility cycling |
19814 ;; | `show-all' | overridden | no replacement |
19815 ;; | `hide-subtree' | overridden | visibility cycling |
19816 ;; | `hide-body' | overridden | no replacement |
19817 ;; | `hide-entry' | overridden | visibility cycling |
19818 ;; | `hide-leaves' | overridden | no replacement |
19819 ;; | `hide-sublevels' | overridden | no replacement |
19820 ;; | `hide-other' | overridden | no replacement |
19822 ;; Make `C-c C-x' a prefix key
19823 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19825 ;; TAB key with modifiers
19826 (org-defkey org-mode-map "\C-i" 'org-cycle)
19827 (org-defkey org-mode-map [(tab)] 'org-cycle)
19828 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19829 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19830 ;; The following line is necessary under Suse GNU/Linux
19831 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab)
19832 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19833 (define-key org-mode-map [backtab] 'org-shifttab)
19835 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19836 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19837 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19839 ;; Cursor keys with modifiers
19840 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19841 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19842 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19843 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19845 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19846 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19847 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19848 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19849 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19850 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19852 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19853 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19854 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19855 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19857 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19858 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19859 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19860 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19862 ;; Babel keys
19863 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19864 (dolist (pair org-babel-key-bindings)
19865 (define-key org-babel-map (car pair) (cdr pair)))
19867 ;;; Extra keys for tty access.
19868 ;; We only set them when really needed because otherwise the
19869 ;; menus don't show the simple keys
19871 (when (or org-use-extra-keys (not window-system))
19872 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19873 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19874 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19875 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19876 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19877 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19878 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19879 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19880 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19881 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19882 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19883 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19884 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19885 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19886 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19887 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19888 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19889 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19890 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19891 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19892 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19893 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19894 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19895 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19896 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19897 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19898 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19899 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19901 ;; All the other keys
19903 (org-defkey org-mode-map "\C-c\C-a" 'outline-show-all) ; in case allout messed up.
19904 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19905 (if (boundp 'narrow-map)
19906 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19907 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19908 (if (boundp 'narrow-map)
19909 (org-defkey narrow-map "b" 'org-narrow-to-block)
19910 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19911 (if (boundp 'narrow-map)
19912 (org-defkey narrow-map "e" 'org-narrow-to-element)
19913 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19914 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19915 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19916 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19917 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19918 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19919 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19920 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19921 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19922 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19923 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19924 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19925 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19926 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19927 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19928 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19929 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19930 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19931 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19932 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19933 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19934 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19935 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19936 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19937 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19938 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19939 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19940 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19941 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19942 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19943 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19944 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19945 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19946 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19947 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19948 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19949 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19950 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19951 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19952 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19953 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19954 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19955 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19956 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19957 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19958 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19959 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19960 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19961 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19962 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19963 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19964 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19965 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19966 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19967 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19968 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19969 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19970 (org-defkey org-mode-map "\C-c^" 'org-sort)
19971 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19972 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19973 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19974 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19975 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19976 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19977 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19978 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19979 (org-defkey org-mode-map "\C-m" 'org-return)
19980 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19981 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19982 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19983 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19984 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19985 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19986 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19987 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19988 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19989 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19990 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19991 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19992 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19993 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19994 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19995 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19996 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19997 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19998 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19999 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
20000 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
20001 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
20002 (org-defkey org-mode-map "\M-h" 'org-mark-element)
20003 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
20004 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
20006 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
20007 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
20008 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
20010 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
20011 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
20012 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
20013 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
20014 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
20015 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
20016 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
20017 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
20018 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
20019 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
20020 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
20021 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
20022 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
20023 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
20024 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
20025 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
20026 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
20027 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
20028 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
20029 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
20030 (org-defkey org-mode-map "\C-c\C-xi" 'org-columns-insert-dblock)
20031 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
20033 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
20034 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
20035 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
20036 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
20037 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
20039 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
20041 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
20043 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
20044 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
20046 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
20049 (defconst org-speed-commands-default
20051 ("Outline Navigation")
20052 ("n" . (org-speed-move-safe 'org-next-visible-heading))
20053 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
20054 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
20055 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
20056 ("F" . org-next-block)
20057 ("B" . org-previous-block)
20058 ("u" . (org-speed-move-safe 'outline-up-heading))
20059 ("j" . org-goto)
20060 ("g" . (org-refile t))
20061 ("Outline Visibility")
20062 ("c" . org-cycle)
20063 ("C" . org-shifttab)
20064 (" " . org-display-outline-path)
20065 ("s" . org-narrow-to-subtree)
20066 ("=" . org-columns)
20067 ("Outline Structure Editing")
20068 ("U" . org-metaup)
20069 ("D" . org-metadown)
20070 ("r" . org-metaright)
20071 ("l" . org-metaleft)
20072 ("R" . org-shiftmetaright)
20073 ("L" . org-shiftmetaleft)
20074 ("i" . (progn (forward-char 1) (call-interactively
20075 'org-insert-heading-respect-content)))
20076 ("^" . org-sort)
20077 ("w" . org-refile)
20078 ("a" . org-archive-subtree-default-with-confirmation)
20079 ("@" . org-mark-subtree)
20080 ("#" . org-toggle-comment)
20081 ("Clock Commands")
20082 ("I" . org-clock-in)
20083 ("O" . org-clock-out)
20084 ("Meta Data Editing")
20085 ("t" . org-todo)
20086 ("," . (org-priority))
20087 ("0" . (org-priority ?\ ))
20088 ("1" . (org-priority ?A))
20089 ("2" . (org-priority ?B))
20090 ("3" . (org-priority ?C))
20091 (":" . org-set-tags-command)
20092 ("e" . org-set-effort)
20093 ("E" . org-inc-effort)
20094 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20095 (org-entry-put (point) "APPT_WARNTIME" m)))
20096 ("Agenda Views etc")
20097 ("v" . org-agenda)
20098 ("/" . org-sparse-tree)
20099 ("Misc")
20100 ("o" . org-open-at-point)
20101 ("?" . org-speed-command-help)
20102 ("<" . (org-agenda-set-restriction-lock 'subtree))
20103 (">" . (org-agenda-remove-restriction-lock))
20105 "The default speed commands.")
20107 (defun org-print-speed-command (e)
20108 (if (> (length (car e)) 1)
20109 (progn
20110 (princ "\n")
20111 (princ (car e))
20112 (princ "\n")
20113 (princ (make-string (length (car e)) ?-))
20114 (princ "\n"))
20115 (princ (car e))
20116 (princ " ")
20117 (if (symbolp (cdr e))
20118 (princ (symbol-name (cdr e)))
20119 (prin1 (cdr e)))
20120 (princ "\n")))
20122 (defun org-speed-command-help ()
20123 "Show the available speed commands."
20124 (interactive)
20125 (if (not org-use-speed-commands)
20126 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20127 (with-output-to-temp-buffer "*Help*"
20128 (princ "User-defined Speed commands\n===========================\n")
20129 (mapc #'org-print-speed-command org-speed-commands-user)
20130 (princ "\n")
20131 (princ "Built-in Speed commands\n=======================\n")
20132 (mapc #'org-print-speed-command org-speed-commands-default))
20133 (with-current-buffer "*Help*"
20134 (setq truncate-lines t))))
20136 (defun org-speed-move-safe (cmd)
20137 "Execute CMD, but make sure that the cursor always ends up in a headline.
20138 If not, return to the original position and throw an error."
20139 (interactive)
20140 (let ((pos (point)))
20141 (call-interactively cmd)
20142 (unless (and (bolp) (org-at-heading-p))
20143 (goto-char pos)
20144 (error "Boundary reached while executing %s" cmd))))
20146 (defvar org-self-insert-command-undo-counter 0)
20148 (defvar org-table-auto-blank-field) ; defined in org-table.el
20149 (defvar org-speed-command nil)
20151 (defun org-speed-command-activate (keys)
20152 "Hook for activating single-letter speed commands.
20153 `org-speed-commands-default' specifies a minimal command set.
20154 Use `org-speed-commands-user' for further customization."
20155 (when (or (and (bolp) (looking-at org-outline-regexp))
20156 (and (functionp org-use-speed-commands)
20157 (funcall org-use-speed-commands)))
20158 (cdr (assoc keys (append org-speed-commands-user
20159 org-speed-commands-default)))))
20161 (defun org-babel-speed-command-activate (keys)
20162 "Hook for activating single-letter code block commands."
20163 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20164 (cdr (assoc keys org-babel-key-bindings))))
20166 (defcustom org-speed-command-hook
20167 '(org-speed-command-default-hook org-babel-speed-command-hook)
20168 "Hook for activating speed commands at strategic locations.
20169 Hook functions are called in sequence until a valid handler is
20170 found.
20172 Each hook takes a single argument, a user-pressed command key
20173 which is also a `self-insert-command' from the global map.
20175 Within the hook, examine the cursor position and the command key
20176 and return nil or a valid handler as appropriate. Handler could
20177 be one of an interactive command, a function, or a form.
20179 Set `org-use-speed-commands' to non-nil value to enable this
20180 hook. The default setting is `org-speed-command-activate'."
20181 :group 'org-structure
20182 :version "24.1"
20183 :type 'hook)
20185 (defun org-self-insert-command (N)
20186 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20187 If the cursor is in a table looking at whitespace, the whitespace is
20188 overwritten, and the table is not marked as requiring realignment."
20189 (interactive "p")
20190 (org-check-before-invisible-edit 'insert)
20191 (cond
20192 ((and org-use-speed-commands
20193 (let ((kv (this-command-keys-vector)))
20194 (setq org-speed-command
20195 (run-hook-with-args-until-success
20196 'org-speed-command-hook
20197 (make-string 1 (aref kv (1- (length kv))))))))
20198 (cond
20199 ((commandp org-speed-command)
20200 (setq this-command org-speed-command)
20201 (call-interactively org-speed-command))
20202 ((functionp org-speed-command)
20203 (funcall org-speed-command))
20204 ((and org-speed-command (listp org-speed-command))
20205 (eval org-speed-command))
20206 (t (let (org-use-speed-commands)
20207 (call-interactively 'org-self-insert-command)))))
20208 ((and
20209 (org-at-table-p)
20210 (progn
20211 ;; Check if we blank the field, and if that triggers align.
20212 (and (featurep 'org-table) org-table-auto-blank-field
20213 (memq last-command
20214 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20215 (if (or (eq (char-after) ?\s) (looking-at "[^|\n]* |"))
20216 ;; Got extra space, this field does not determine
20217 ;; column width.
20218 (let (org-table-may-need-update) (org-table-blank-field))
20219 ;; No extra space, this field may determine column
20220 ;; width.
20221 (org-table-blank-field)))
20223 (eq N 1)
20224 (looking-at "[^|\n]* \\( \\)|"))
20225 ;; There is room for insertion without re-aligning the table.
20226 (delete-region (match-beginning 1) (match-end 1))
20227 (self-insert-command N))
20229 (setq org-table-may-need-update t)
20230 (self-insert-command N)
20231 (org-fix-tags-on-the-fly)
20232 (when org-self-insert-cluster-for-undo
20233 (if (not (eq last-command 'org-self-insert-command))
20234 (setq org-self-insert-command-undo-counter 1)
20235 (if (>= org-self-insert-command-undo-counter 20)
20236 (setq org-self-insert-command-undo-counter 1)
20237 (and (> org-self-insert-command-undo-counter 0)
20238 buffer-undo-list (listp buffer-undo-list)
20239 (not (cadr buffer-undo-list)) ; remove nil entry
20240 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20241 (setq org-self-insert-command-undo-counter
20242 (1+ org-self-insert-command-undo-counter))))))))
20244 (defun org-check-before-invisible-edit (kind)
20245 "Check is editing if kind KIND would be dangerous with invisible text around.
20246 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20247 ;; First, try to get out of here as quickly as possible, to reduce overhead
20248 (when (and org-catch-invisible-edits
20249 (or (not (boundp 'visible-mode)) (not visible-mode))
20250 (or (get-char-property (point) 'invisible)
20251 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20252 ;; OK, we need to take a closer look
20253 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20254 (invisible-before-point (unless (bobp) (get-char-property
20255 (1- (point)) 'invisible)))
20256 (border-and-ok-direction
20258 ;; Check if we are acting predictably before invisible text
20259 (and invisible-at-point (not invisible-before-point)
20260 (memq kind '(insert delete-backward)))
20261 ;; Check if we are acting predictably after invisible text
20262 ;; This works not well, and I have turned it off. It seems
20263 ;; better to always show and stop after invisible text.
20264 ;; (and (not invisible-at-point) invisible-before-point
20265 ;; (memq kind '(insert delete)))
20267 (when (or (memq invisible-at-point '(outline org-hide-block t))
20268 (memq invisible-before-point '(outline org-hide-block t)))
20269 (when (eq org-catch-invisible-edits 'error)
20270 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20271 (if (and org-custom-properties-overlays
20272 (y-or-n-p "Display invisible properties in this buffer? "))
20273 (org-toggle-custom-properties-visibility)
20274 ;; Make the area visible
20275 (save-excursion
20276 (when invisible-before-point
20277 (goto-char (previous-single-char-property-change
20278 (point) 'invisible)))
20279 (outline-show-subtree))
20280 (cond
20281 ((eq org-catch-invisible-edits 'show)
20282 ;; That's it, we do the edit after showing
20283 (message
20284 "Unfolding invisible region around point before editing")
20285 (sit-for 1))
20286 ((and (eq org-catch-invisible-edits 'smart)
20287 border-and-ok-direction)
20288 (message "Unfolding invisible region around point before editing"))
20290 ;; Don't do the edit, make the user repeat it in full visibility
20291 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20293 (defun org-fix-tags-on-the-fly ()
20294 "Align tags in headline at point.
20295 Unlike to `org-set-tags', it ignores region and sorting."
20296 (when (and (eq (char-after (line-beginning-position)) ?*) ;short-circuit
20297 (org-at-heading-p))
20298 (let ((org-ignore-region t)
20299 (org-tags-sort-function nil))
20300 (org-set-tags nil t))))
20302 (defun org-delete-backward-char (N)
20303 "Like `delete-backward-char', insert whitespace at field end in tables.
20304 When deleting backwards, in tables this function will insert whitespace in
20305 front of the next \"|\" separator, to keep the table aligned. The table will
20306 still be marked for re-alignment if the field did fill the entire column,
20307 because, in this case the deletion might narrow the column."
20308 (interactive "p")
20309 (save-match-data
20310 (org-check-before-invisible-edit 'delete-backward)
20311 (if (and (org-at-table-p)
20312 (eq N 1)
20313 (string-match "|" (buffer-substring (point-at-bol) (point)))
20314 (looking-at ".*?|"))
20315 (let ((pos (point))
20316 (noalign (looking-at "[^|\n\r]* |"))
20317 (c org-table-may-need-update))
20318 (backward-delete-char N)
20319 (unless overwrite-mode
20320 (skip-chars-forward "^|")
20321 (insert " ")
20322 (goto-char (1- pos)))
20323 ;; noalign: if there were two spaces at the end, this field
20324 ;; does not determine the width of the column.
20325 (when noalign (setq org-table-may-need-update c)))
20326 (backward-delete-char N)
20327 (org-fix-tags-on-the-fly))))
20329 (defun org-delete-char (N)
20330 "Like `delete-char', but insert whitespace at field end in tables.
20331 When deleting characters, in tables this function will insert whitespace in
20332 front of the next \"|\" separator, to keep the table aligned. The table will
20333 still be marked for re-alignment if the field did fill the entire column,
20334 because, in this case the deletion might narrow the column."
20335 (interactive "p")
20336 (save-match-data
20337 (org-check-before-invisible-edit 'delete)
20338 (if (and (org-at-table-p)
20339 (not (bolp))
20340 (not (= (char-after) ?|))
20341 (eq N 1))
20342 (if (looking-at ".*?|")
20343 (let ((pos (point))
20344 (noalign (looking-at "[^|\n\r]* |"))
20345 (c org-table-may-need-update))
20346 (replace-match
20347 (concat (substring (match-string 0) 1 -1) " |") nil t)
20348 (goto-char pos)
20349 ;; noalign: if there were two spaces at the end, this field
20350 ;; does not determine the width of the column.
20351 (when noalign (setq org-table-may-need-update c)))
20352 (delete-char N))
20353 (delete-char N)
20354 (org-fix-tags-on-the-fly))))
20356 ;; Make `delete-selection-mode' work with Org mode and Orgtbl mode
20357 (put 'org-self-insert-command 'delete-selection
20358 (lambda ()
20359 (not (run-hook-with-args-until-success
20360 'self-insert-uses-region-functions))))
20361 (put 'orgtbl-self-insert-command 'delete-selection
20362 (lambda ()
20363 (not (run-hook-with-args-until-success
20364 'self-insert-uses-region-functions))))
20365 (put 'org-delete-char 'delete-selection 'supersede)
20366 (put 'org-delete-backward-char 'delete-selection 'supersede)
20367 (put 'org-yank 'delete-selection 'yank)
20369 ;; Make `flyspell-mode' delay after some commands
20370 (put 'org-self-insert-command 'flyspell-delayed t)
20371 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20372 (put 'org-delete-char 'flyspell-delayed t)
20373 (put 'org-delete-backward-char 'flyspell-delayed t)
20375 ;; Make pabbrev-mode expand after Org mode commands
20376 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20377 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20379 (defun org-remap (map &rest commands)
20380 "In MAP, remap the functions given in COMMANDS.
20381 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20382 (let (new old)
20383 (while commands
20384 (setq old (pop commands) new (pop commands))
20385 (org-defkey map (vector 'remap old) new))))
20387 (defun org-transpose-words ()
20388 "Transpose words for Org.
20389 This uses the `org-mode-transpose-word-syntax-table' syntax
20390 table, which interprets characters in `org-emphasis-alist' as
20391 word constituents."
20392 (interactive)
20393 (with-syntax-table org-mode-transpose-word-syntax-table
20394 (call-interactively 'transpose-words)))
20395 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20397 (when (eq org-enable-table-editor 'optimized)
20398 ;; If the user wants maximum table support, we need to hijack
20399 ;; some standard editing functions
20400 (org-remap org-mode-map
20401 'self-insert-command 'org-self-insert-command
20402 'delete-char 'org-delete-char
20403 'delete-backward-char 'org-delete-backward-char)
20404 (org-defkey org-mode-map "|" 'org-force-self-insert))
20406 (defvar org-ctrl-c-ctrl-c-hook nil
20407 "Hook for functions attaching themselves to `C-c C-c'.
20409 This can be used to add additional functionality to the C-c C-c
20410 key which executes context-dependent commands. This hook is run
20411 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20412 run after the last test.
20414 Each function will be called with no arguments. The function
20415 must check if the context is appropriate for it to act. If yes,
20416 it should do its thing and then return a non-nil value. If the
20417 context is wrong, just do nothing and return nil.")
20419 (defvar org-ctrl-c-ctrl-c-final-hook nil
20420 "Hook for functions attaching themselves to `C-c C-c'.
20422 This can be used to add additional functionality to the C-c C-c
20423 key which executes context-dependent commands. This hook is run
20424 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20425 before the first test.
20427 Each function will be called with no arguments. The function
20428 must check if the context is appropriate for it to act. If yes,
20429 it should do its thing and then return a non-nil value. If the
20430 context is wrong, just do nothing and return nil.")
20432 (defvar org-tab-first-hook nil
20433 "Hook for functions to attach themselves to TAB.
20434 See `org-ctrl-c-ctrl-c-hook' for more information.
20435 This hook runs as the first action when TAB is pressed, even before
20436 `org-cycle' messes around with the `outline-regexp' to cater for
20437 inline tasks and plain list item folding.
20438 If any function in this hook returns t, any other actions that
20439 would have been caused by TAB (such as table field motion or visibility
20440 cycling) will not occur.")
20442 (defvar org-tab-after-check-for-table-hook nil
20443 "Hook for functions to attach themselves to TAB.
20444 See `org-ctrl-c-ctrl-c-hook' for more information.
20445 This hook runs after it has been established that the cursor is not in a
20446 table, but before checking if the cursor is in a headline or if global cycling
20447 should be done.
20448 If any function in this hook returns t, not other actions like visibility
20449 cycling will be done.")
20451 (defvar org-tab-after-check-for-cycling-hook nil
20452 "Hook for functions to attach themselves to TAB.
20453 See `org-ctrl-c-ctrl-c-hook' for more information.
20454 This hook runs after it has been established that not table field motion and
20455 not visibility should be done because of current context. This is probably
20456 the place where a package like yasnippets can hook in.")
20458 (defvar org-tab-before-tab-emulation-hook nil
20459 "Hook for functions to attach themselves to TAB.
20460 See `org-ctrl-c-ctrl-c-hook' for more information.
20461 This hook runs after every other options for TAB have been exhausted, but
20462 before indentation and \t insertion takes place.")
20464 (defvar org-metaleft-hook nil
20465 "Hook for functions attaching themselves to `M-left'.
20466 See `org-ctrl-c-ctrl-c-hook' for more information.")
20467 (defvar org-metaright-hook nil
20468 "Hook for functions attaching themselves to `M-right'.
20469 See `org-ctrl-c-ctrl-c-hook' for more information.")
20470 (defvar org-metaup-hook nil
20471 "Hook for functions attaching themselves to `M-up'.
20472 See `org-ctrl-c-ctrl-c-hook' for more information.")
20473 (defvar org-metadown-hook nil
20474 "Hook for functions attaching themselves to `M-down'.
20475 See `org-ctrl-c-ctrl-c-hook' for more information.")
20476 (defvar org-shiftmetaleft-hook nil
20477 "Hook for functions attaching themselves to `M-S-left'.
20478 See `org-ctrl-c-ctrl-c-hook' for more information.")
20479 (defvar org-shiftmetaright-hook nil
20480 "Hook for functions attaching themselves to `M-S-right'.
20481 See `org-ctrl-c-ctrl-c-hook' for more information.")
20482 (defvar org-shiftmetaup-hook nil
20483 "Hook for functions attaching themselves to `M-S-up'.
20484 See `org-ctrl-c-ctrl-c-hook' for more information.")
20485 (defvar org-shiftmetadown-hook nil
20486 "Hook for functions attaching themselves to `M-S-down'.
20487 See `org-ctrl-c-ctrl-c-hook' for more information.")
20488 (defvar org-metareturn-hook nil
20489 "Hook for functions attaching themselves to `M-RET'.
20490 See `org-ctrl-c-ctrl-c-hook' for more information.")
20491 (defvar org-shiftup-hook nil
20492 "Hook for functions attaching themselves to `S-up'.
20493 See `org-ctrl-c-ctrl-c-hook' for more information.")
20494 (defvar org-shiftup-final-hook nil
20495 "Hook for functions attaching themselves to `S-up'.
20496 This one runs after all other options except shift-select have been excluded.
20497 See `org-ctrl-c-ctrl-c-hook' for more information.")
20498 (defvar org-shiftdown-hook nil
20499 "Hook for functions attaching themselves to `S-down'.
20500 See `org-ctrl-c-ctrl-c-hook' for more information.")
20501 (defvar org-shiftdown-final-hook nil
20502 "Hook for functions attaching themselves to `S-down'.
20503 This one runs after all other options except shift-select have been excluded.
20504 See `org-ctrl-c-ctrl-c-hook' for more information.")
20505 (defvar org-shiftleft-hook nil
20506 "Hook for functions attaching themselves to `S-left'.
20507 See `org-ctrl-c-ctrl-c-hook' for more information.")
20508 (defvar org-shiftleft-final-hook nil
20509 "Hook for functions attaching themselves to `S-left'.
20510 This one runs after all other options except shift-select have been excluded.
20511 See `org-ctrl-c-ctrl-c-hook' for more information.")
20512 (defvar org-shiftright-hook nil
20513 "Hook for functions attaching themselves to `S-right'.
20514 See `org-ctrl-c-ctrl-c-hook' for more information.")
20515 (defvar org-shiftright-final-hook nil
20516 "Hook for functions attaching themselves to `S-right'.
20517 This one runs after all other options except shift-select have been excluded.
20518 See `org-ctrl-c-ctrl-c-hook' for more information.")
20520 (defun org-modifier-cursor-error ()
20521 "Throw an error, a modified cursor command was applied in wrong context."
20522 (user-error "This command is active in special context like tables, headlines or items"))
20524 (defun org-shiftselect-error ()
20525 "Throw an error because Shift-Cursor command was applied in wrong context."
20526 (if (and (boundp 'shift-select-mode) shift-select-mode)
20527 (user-error "To use shift-selection with Org mode, customize `org-support-shift-select'")
20528 (user-error "This command works only in special context like headlines or timestamps")))
20530 (defun org-call-for-shift-select (cmd)
20531 (let ((this-command-keys-shift-translated t))
20532 (call-interactively cmd)))
20534 (defun org-shifttab (&optional arg)
20535 "Global visibility cycling or move to previous table field.
20536 Call `org-table-previous-field' within a table.
20537 When ARG is nil, cycle globally through visibility states.
20538 When ARG is a numeric prefix, show contents of this level."
20539 (interactive "P")
20540 (cond
20541 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20542 ((integerp arg)
20543 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20544 (message "Content view to level: %d" arg)
20545 (org-content (prefix-numeric-value arg2))
20546 (org-cycle-show-empty-lines t)
20547 (setq org-cycle-global-status 'overview)))
20548 (t (call-interactively 'org-global-cycle))))
20550 (defun org-shiftmetaleft ()
20551 "Promote subtree or delete table column.
20552 Calls `org-promote-subtree', `org-outdent-item-tree', or
20553 `org-table-delete-column', depending on context. See the
20554 individual commands for more information."
20555 (interactive)
20556 (cond
20557 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20558 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20559 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20560 ((if (not (org-region-active-p)) (org-at-item-p)
20561 (save-excursion (goto-char (region-beginning))
20562 (org-at-item-p)))
20563 (call-interactively 'org-outdent-item-tree))
20564 (t (org-modifier-cursor-error))))
20566 (defun org-shiftmetaright ()
20567 "Demote subtree or insert table column.
20568 Calls `org-demote-subtree', `org-indent-item-tree', or
20569 `org-table-insert-column', depending on context. See the
20570 individual commands for more information."
20571 (interactive)
20572 (cond
20573 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20574 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20575 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20576 ((if (not (org-region-active-p)) (org-at-item-p)
20577 (save-excursion (goto-char (region-beginning))
20578 (org-at-item-p)))
20579 (call-interactively 'org-indent-item-tree))
20580 (t (org-modifier-cursor-error))))
20582 (defun org-shiftmetaup (&optional _arg)
20583 "Drag the line at point up.
20584 In a table, kill the current row.
20585 On a clock timestamp, update the value of the timestamp like `S-<up>'
20586 but also adjust the previous clocked item in the clock history.
20587 Everywhere else, drag the line at point up."
20588 (interactive "P")
20589 (cond
20590 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20591 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20592 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20593 (call-interactively 'org-timestamp-up)))
20594 (t (call-interactively 'org-drag-line-backward))))
20596 (defun org-shiftmetadown (&optional _arg)
20597 "Drag the line at point down.
20598 In a table, insert an empty row at the current line.
20599 On a clock timestamp, update the value of the timestamp like `S-<down>'
20600 but also adjust the previous clocked item in the clock history.
20601 Everywhere else, drag the line at point down."
20602 (interactive "P")
20603 (cond
20604 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20605 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20606 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20607 (call-interactively 'org-timestamp-down)))
20608 (t (call-interactively 'org-drag-line-forward))))
20610 (defsubst org-hidden-tree-error ()
20611 (user-error
20612 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20614 (defun org-metaleft (&optional _arg)
20615 "Promote heading, list item at point or move table column left.
20617 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20618 depending on context. With no specific context, calls the Emacs
20619 default `backward-word'. See the individual commands for more
20620 information.
20622 This function runs the hook `org-metaleft-hook' as a first step,
20623 and returns at first non-nil value."
20624 (interactive "P")
20625 (cond
20626 ((run-hook-with-args-until-success 'org-metaleft-hook))
20627 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20628 ((org-with-limited-levels
20629 (or (org-at-heading-p)
20630 (and (org-region-active-p)
20631 (save-excursion
20632 (goto-char (region-beginning))
20633 (org-at-heading-p)))))
20634 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20635 (call-interactively 'org-do-promote))
20636 ;; At an inline task.
20637 ((org-at-heading-p)
20638 (call-interactively 'org-inlinetask-promote))
20639 ((or (org-at-item-p)
20640 (and (org-region-active-p)
20641 (save-excursion
20642 (goto-char (region-beginning))
20643 (org-at-item-p))))
20644 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20645 (call-interactively 'org-outdent-item))
20646 (t (call-interactively 'backward-word))))
20648 (defun org-metaright (&optional _arg)
20649 "Demote heading, list item at point or move table column right.
20651 In front of a drawer or a block keyword, indent it correctly.
20653 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20654 `org-indent-drawer' or `org-indent-block' depending on context.
20655 With no specific context, calls the Emacs default `forward-word'.
20656 See the individual commands for more information.
20658 This function runs the hook `org-metaright-hook' as a first step,
20659 and returns at first non-nil value."
20660 (interactive "P")
20661 (cond
20662 ((run-hook-with-args-until-success 'org-metaright-hook))
20663 ((org-at-table-p) (call-interactively 'org-table-move-column))
20664 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20665 ((org-at-block-p) (call-interactively 'org-indent-block))
20666 ((org-with-limited-levels
20667 (or (org-at-heading-p)
20668 (and (org-region-active-p)
20669 (save-excursion
20670 (goto-char (region-beginning))
20671 (org-at-heading-p)))))
20672 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20673 (call-interactively 'org-do-demote))
20674 ;; At an inline task.
20675 ((org-at-heading-p)
20676 (call-interactively 'org-inlinetask-demote))
20677 ((or (org-at-item-p)
20678 (and (org-region-active-p)
20679 (save-excursion
20680 (goto-char (region-beginning))
20681 (org-at-item-p))))
20682 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20683 (call-interactively 'org-indent-item))
20684 (t (call-interactively 'forward-word))))
20686 (defun org-check-for-hidden (what)
20687 "Check if there are hidden headlines/items in the current visual line.
20688 WHAT can be either `headlines' or `items'. If the current line is
20689 an outline or item heading and it has a folded subtree below it,
20690 this function returns t, nil otherwise."
20691 (let ((re (cond
20692 ((eq what 'headlines) org-outline-regexp-bol)
20693 ((eq what 'items) (org-item-beginning-re))
20694 (t (error "This should not happen"))))
20695 beg end)
20696 (save-excursion
20697 (catch 'exit
20698 (unless (org-region-active-p)
20699 (setq beg (point-at-bol))
20700 (beginning-of-line 2)
20701 (while (and (not (eobp)) ;; this is like `next-line'
20702 (get-char-property (1- (point)) 'invisible))
20703 (beginning-of-line 2))
20704 (setq end (point))
20705 (goto-char beg)
20706 (goto-char (point-at-eol))
20707 (setq end (max end (point)))
20708 (while (re-search-forward re end t)
20709 (when (get-char-property (match-beginning 0) 'invisible)
20710 (throw 'exit t))))
20711 nil))))
20713 (defun org-metaup (&optional _arg)
20714 "Move subtree up or move table row up.
20715 Calls `org-move-subtree-up' or `org-table-move-row' or
20716 `org-move-item-up', depending on context. See the individual commands
20717 for more information."
20718 (interactive "P")
20719 (cond
20720 ((run-hook-with-args-until-success 'org-metaup-hook))
20721 ((org-region-active-p)
20722 (let* ((a (min (region-beginning) (region-end)))
20723 (b (1- (max (region-beginning) (region-end))))
20724 (c (save-excursion (goto-char a)
20725 (move-beginning-of-line 0)))
20726 (d (save-excursion (goto-char a)
20727 (move-end-of-line 0) (point))))
20728 (transpose-regions a b c d)
20729 (goto-char c)))
20730 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20731 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20732 ((org-at-item-p) (call-interactively 'org-move-item-up))
20733 (t (org-drag-element-backward))))
20735 (defun org-metadown (&optional _arg)
20736 "Move subtree down or move table row down.
20737 Calls `org-move-subtree-down' or `org-table-move-row' or
20738 `org-move-item-down', depending on context. See the individual
20739 commands for more information."
20740 (interactive "P")
20741 (cond
20742 ((run-hook-with-args-until-success 'org-metadown-hook))
20743 ((org-region-active-p)
20744 (let* ((a (min (region-beginning) (region-end)))
20745 (b (max (region-beginning) (region-end)))
20746 (c (save-excursion (goto-char b)
20747 (move-beginning-of-line 1)))
20748 (d (save-excursion (goto-char b)
20749 (move-end-of-line 1) (1+ (point)))))
20750 (transpose-regions a b c d)
20751 (goto-char d)))
20752 ((org-at-table-p) (call-interactively 'org-table-move-row))
20753 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20754 ((org-at-item-p) (call-interactively 'org-move-item-down))
20755 (t (org-drag-element-forward))))
20757 (defun org-shiftup (&optional arg)
20758 "Increase item in timestamp or increase priority of current headline.
20759 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20760 depending on context. See the individual commands for more information."
20761 (interactive "P")
20762 (cond
20763 ((run-hook-with-args-until-success 'org-shiftup-hook))
20764 ((and org-support-shift-select (org-region-active-p))
20765 (org-call-for-shift-select 'previous-line))
20766 ((org-at-timestamp-p t)
20767 (call-interactively (if org-edit-timestamp-down-means-later
20768 'org-timestamp-down 'org-timestamp-up)))
20769 ((and (not (eq org-support-shift-select 'always))
20770 org-enable-priority-commands
20771 (org-at-heading-p))
20772 (call-interactively 'org-priority-up))
20773 ((and (not org-support-shift-select) (org-at-item-p))
20774 (call-interactively 'org-previous-item))
20775 ((org-clocktable-try-shift 'up arg))
20776 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20777 (org-support-shift-select
20778 (org-call-for-shift-select 'previous-line))
20779 (t (org-shiftselect-error))))
20781 (defun org-shiftdown (&optional arg)
20782 "Decrease item in timestamp or decrease priority of current headline.
20783 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20784 depending on context. See the individual commands for more information."
20785 (interactive "P")
20786 (cond
20787 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20788 ((and org-support-shift-select (org-region-active-p))
20789 (org-call-for-shift-select 'next-line))
20790 ((org-at-timestamp-p t)
20791 (call-interactively (if org-edit-timestamp-down-means-later
20792 'org-timestamp-up 'org-timestamp-down)))
20793 ((and (not (eq org-support-shift-select 'always))
20794 org-enable-priority-commands
20795 (org-at-heading-p))
20796 (call-interactively 'org-priority-down))
20797 ((and (not org-support-shift-select) (org-at-item-p))
20798 (call-interactively 'org-next-item))
20799 ((org-clocktable-try-shift 'down arg))
20800 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20801 (org-support-shift-select
20802 (org-call-for-shift-select 'next-line))
20803 (t (org-shiftselect-error))))
20805 (defun org-shiftright (&optional arg)
20806 "Cycle the thing at point or in the current line, depending on context.
20807 Depending on context, this does one of the following:
20809 - switch a timestamp at point one day into the future
20810 - on a headline, switch to the next TODO keyword.
20811 - on an item, switch entire list to the next bullet type
20812 - on a property line, switch to the next allowed value
20813 - on a clocktable definition line, move time block into the future"
20814 (interactive "P")
20815 (cond
20816 ((run-hook-with-args-until-success 'org-shiftright-hook))
20817 ((and org-support-shift-select (org-region-active-p))
20818 (org-call-for-shift-select 'forward-char))
20819 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20820 ((and (not (eq org-support-shift-select 'always))
20821 (org-at-heading-p))
20822 (let ((org-inhibit-logging
20823 (not org-treat-S-cursor-todo-selection-as-state-change))
20824 (org-inhibit-blocking
20825 (not org-treat-S-cursor-todo-selection-as-state-change)))
20826 (org-call-with-arg 'org-todo 'right)))
20827 ((or (and org-support-shift-select
20828 (not (eq org-support-shift-select 'always))
20829 (org-at-item-bullet-p))
20830 (and (not org-support-shift-select) (org-at-item-p)))
20831 (org-call-with-arg 'org-cycle-list-bullet nil))
20832 ((and (not (eq org-support-shift-select 'always))
20833 (org-at-property-p))
20834 (call-interactively 'org-property-next-allowed-value))
20835 ((org-clocktable-try-shift 'right arg))
20836 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20837 (org-support-shift-select
20838 (org-call-for-shift-select 'forward-char))
20839 (t (org-shiftselect-error))))
20841 (defun org-shiftleft (&optional arg)
20842 "Cycle the thing at point or in the current line, depending on context.
20843 Depending on context, this does one of the following:
20845 - switch a timestamp at point one day into the past
20846 - on a headline, switch to the previous TODO keyword.
20847 - on an item, switch entire list to the previous bullet type
20848 - on a property line, switch to the previous allowed value
20849 - on a clocktable definition line, move time block into the past"
20850 (interactive "P")
20851 (cond
20852 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20853 ((and org-support-shift-select (org-region-active-p))
20854 (org-call-for-shift-select 'backward-char))
20855 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20856 ((and (not (eq org-support-shift-select 'always))
20857 (org-at-heading-p))
20858 (let ((org-inhibit-logging
20859 (not org-treat-S-cursor-todo-selection-as-state-change))
20860 (org-inhibit-blocking
20861 (not org-treat-S-cursor-todo-selection-as-state-change)))
20862 (org-call-with-arg 'org-todo 'left)))
20863 ((or (and org-support-shift-select
20864 (not (eq org-support-shift-select 'always))
20865 (org-at-item-bullet-p))
20866 (and (not org-support-shift-select) (org-at-item-p)))
20867 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20868 ((and (not (eq org-support-shift-select 'always))
20869 (org-at-property-p))
20870 (call-interactively 'org-property-previous-allowed-value))
20871 ((org-clocktable-try-shift 'left arg))
20872 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20873 (org-support-shift-select
20874 (org-call-for-shift-select 'backward-char))
20875 (t (org-shiftselect-error))))
20877 (defun org-shiftcontrolright ()
20878 "Switch to next TODO set."
20879 (interactive)
20880 (cond
20881 ((and org-support-shift-select (org-region-active-p))
20882 (org-call-for-shift-select 'forward-word))
20883 ((and (not (eq org-support-shift-select 'always))
20884 (org-at-heading-p))
20885 (org-call-with-arg 'org-todo 'nextset))
20886 (org-support-shift-select
20887 (org-call-for-shift-select 'forward-word))
20888 (t (org-shiftselect-error))))
20890 (defun org-shiftcontrolleft ()
20891 "Switch to previous TODO set."
20892 (interactive)
20893 (cond
20894 ((and org-support-shift-select (org-region-active-p))
20895 (org-call-for-shift-select 'backward-word))
20896 ((and (not (eq org-support-shift-select 'always))
20897 (org-at-heading-p))
20898 (org-call-with-arg 'org-todo 'previousset))
20899 (org-support-shift-select
20900 (org-call-for-shift-select 'backward-word))
20901 (t (org-shiftselect-error))))
20903 (defun org-shiftcontrolup (&optional n)
20904 "Change timestamps synchronously up in CLOCK log lines.
20905 Optional argument N tells to change by that many units."
20906 (interactive "P")
20907 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20908 (let (org-support-shift-select)
20909 (org-clock-timestamps-up n))
20910 (user-error "Not at a clock log")))
20912 (defun org-shiftcontroldown (&optional n)
20913 "Change timestamps synchronously down in CLOCK log lines.
20914 Optional argument N tells to change by that many units."
20915 (interactive "P")
20916 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20917 (let (org-support-shift-select)
20918 (org-clock-timestamps-down n))
20919 (user-error "Not at a clock log")))
20921 (defun org-increase-number-at-point (&optional inc)
20922 "Increment the number at point.
20923 With an optional prefix numeric argument INC, increment using
20924 this numeric value."
20925 (interactive "p")
20926 (if (not (number-at-point))
20927 (user-error "Not on a number")
20928 (unless inc (setq inc 1))
20929 (let ((pos (point))
20930 (beg (skip-chars-backward "-+^/*0-9eE."))
20931 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20932 (setq nap (buffer-substring-no-properties
20933 (+ pos beg) (+ pos beg end)))
20934 (delete-region (+ pos beg) (+ pos beg end))
20935 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20936 (when (org-at-table-p)
20937 (org-table-align)
20938 (org-table-end-of-field 1))))
20940 (defun org-decrease-number-at-point (&optional inc)
20941 "Decrement the number at point.
20942 With an optional prefix numeric argument INC, decrement using
20943 this numeric value."
20944 (interactive "p")
20945 (org-increase-number-at-point (- (or inc 1))))
20947 (defun org-ctrl-c-ret ()
20948 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20949 (interactive)
20950 (cond
20951 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20952 (t (call-interactively 'org-insert-heading))))
20954 (defun org-find-visible ()
20955 (let ((s (point)))
20956 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20957 (get-char-property s 'invisible)))
20959 (defun org-find-invisible ()
20960 (let ((s (point)))
20961 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20962 (not (get-char-property s 'invisible))))
20965 (defun org-copy-visible (beg end)
20966 "Copy the visible parts of the region."
20967 (interactive "r")
20968 (let (snippets s)
20969 (save-excursion
20970 (save-restriction
20971 (narrow-to-region beg end)
20972 (setq s (goto-char (point-min)))
20973 (while (not (= (point) (point-max)))
20974 (goto-char (org-find-invisible))
20975 (push (buffer-substring s (point)) snippets)
20976 (setq s (goto-char (org-find-visible))))))
20977 (kill-new (apply 'concat (nreverse snippets)))))
20979 (defun org-copy-special ()
20980 "Copy region in table or copy current subtree.
20981 Calls `org-table-copy-region' or `org-copy-subtree', depending on
20982 context. See the individual commands for more information."
20983 (interactive)
20984 (call-interactively
20985 (if (org-at-table-p) #'org-table-copy-region #'org-copy-subtree)))
20987 (defun org-cut-special ()
20988 "Cut region in table or cut current subtree.
20989 Calls `org-table-cut-region' or `org-cut-subtree', depending on
20990 context. See the individual commands for more information."
20991 (interactive)
20992 (call-interactively
20993 (if (org-at-table-p) #'org-table-cut-region #'org-cut-subtree)))
20995 (defun org-paste-special (arg)
20996 "Paste rectangular region into table, or past subtree relative to level.
20997 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20998 See the individual commands for more information."
20999 (interactive "P")
21000 (if (org-at-table-p)
21001 (org-table-paste-rectangle)
21002 (org-paste-subtree arg)))
21004 (defun org-edit-special (&optional arg)
21005 "Call a special editor for the element at point.
21006 When at a table, call the formula editor with `org-table-edit-formulas'.
21007 When in a source code block, call `org-edit-src-code'.
21008 When in a fixed-width region, call `org-edit-fixed-width-region'.
21009 When in an export block, call `org-edit-export-block'.
21010 When at an #+INCLUDE keyword, visit the included file.
21011 When at a footnote reference, call `org-edit-footnote-reference'
21012 On a link, call `ffap' to visit the link at point.
21013 Otherwise, return a user error."
21014 (interactive "P")
21015 (let ((element (org-element-at-point)))
21016 (barf-if-buffer-read-only)
21017 (pcase (org-element-type element)
21018 (`src-block
21019 (if (not arg) (org-edit-src-code)
21020 (let* ((info (org-babel-get-src-block-info))
21021 (lang (nth 0 info))
21022 (params (nth 2 info))
21023 (session (cdr (assq :session params))))
21024 (if (not session) (org-edit-src-code)
21025 ;; At a src-block with a session and function called with
21026 ;; an ARG: switch to the buffer related to the inferior
21027 ;; process.
21028 (switch-to-buffer
21029 (funcall (intern (concat "org-babel-prep-session:" lang))
21030 session params))))))
21031 (`keyword
21032 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
21033 (org-open-link-from-string
21034 (format "[[%s]]"
21035 (expand-file-name
21036 (let ((value (org-element-property :value element)))
21037 (cond ((not (org-string-nw-p value))
21038 (user-error "No file to edit"))
21039 ((string-match "\\`\"\\(.*?\\)\"" value)
21040 (match-string 1 value))
21041 ((string-match "\\`[^ \t\"]\\S-*" value)
21042 (match-string 0 value))
21043 (t (user-error "No valid file specified")))))))
21044 (user-error "No special environment to edit here")))
21045 (`table
21046 (if (eq (org-element-property :type element) 'table.el)
21047 (org-edit-table.el)
21048 (call-interactively 'org-table-edit-formulas)))
21049 ;; Only Org tables contain `table-row' type elements.
21050 (`table-row (call-interactively 'org-table-edit-formulas))
21051 (`example-block (org-edit-src-code))
21052 (`export-block (org-edit-export-block))
21053 (`fixed-width (org-edit-fixed-width-region))
21055 ;; No notable element at point. Though, we may be at a link or
21056 ;; a footnote reference, which are objects. Thus, scan deeper.
21057 (let ((context (org-element-context element)))
21058 (pcase (org-element-type context)
21059 (`footnote-reference (org-edit-footnote-reference))
21060 (`inline-src-block (org-edit-inline-src-code))
21061 (`link (call-interactively #'ffap))
21062 (_ (user-error "No special environment to edit here"))))))))
21064 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21065 (defun org-ctrl-c-ctrl-c (&optional arg)
21066 "Set tags in headline, or update according to changed information at point.
21068 This command does many different things, depending on context:
21070 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21071 this is what we do.
21073 - If the cursor is on a statistics cookie, update it.
21075 - If the cursor is in a headline, prompt for tags and insert them
21076 into the current line, aligned to `org-tags-column'. When called
21077 with prefix arg, realign all tags in the current buffer.
21079 - If the cursor is in one of the special #+KEYWORD lines, this
21080 triggers scanning the buffer for these lines and updating the
21081 information.
21083 - If the cursor is inside a table, realign the table. This command
21084 works even if the automatic table editor has been turned off.
21086 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21087 the entire table.
21089 - If the cursor is at a footnote reference or definition, jump to
21090 the corresponding definition or references, respectively.
21092 - If the cursor is a the beginning of a dynamic block, update it.
21094 - If the current buffer is a capture buffer, close note and file it.
21096 - If the cursor is on a <<<target>>>, update radio targets and
21097 corresponding links in this buffer.
21099 - If the cursor is on a numbered item in a plain list, renumber the
21100 ordered list.
21102 - If the cursor is on a checkbox, toggle it.
21104 - If the cursor is on a code block, evaluate it. The variable
21105 `org-confirm-babel-evaluate' can be used to control prompting
21106 before code block evaluation, by default every code block
21107 evaluation requires confirmation. Code block evaluation can be
21108 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21109 (interactive "P")
21110 (cond
21111 ((or (bound-and-true-p org-clock-overlays) org-occur-highlights)
21112 (when (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21113 (org-remove-occur-highlights)
21114 (message "Temporary highlights/overlays removed from current buffer"))
21115 ((and (local-variable-p 'org-finish-function)
21116 (fboundp org-finish-function))
21117 (funcall org-finish-function))
21118 ((org-babel-hash-at-point))
21119 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21121 (let* ((context
21122 (org-element-lineage
21123 (org-element-context)
21124 ;; Limit to supported contexts.
21125 '(babel-call clock dynamic-block footnote-definition
21126 footnote-reference inline-babel-call inline-src-block
21127 inlinetask item keyword node-property paragraph
21128 plain-list property-drawer radio-target src-block
21129 statistics-cookie table table-cell table-row
21130 timestamp)
21132 (type (org-element-type context)))
21133 ;; For convenience: at the first line of a paragraph on the same
21134 ;; line as an item, apply function on that item instead.
21135 (when (eq type 'paragraph)
21136 (let ((parent (org-element-property :parent context)))
21137 (when (and (eq (org-element-type parent) 'item)
21138 (= (line-beginning-position)
21139 (org-element-property :begin parent)))
21140 (setq context parent)
21141 (setq type 'item))))
21142 ;; Act according to type of element or object at point.
21144 ;; Do nothing on a blank line, except if it is contained in
21145 ;; a src block. Hence, we first check if point is in such
21146 ;; a block and then if it is at a blank line.
21147 (pcase type
21148 ((or `inline-src-block `src-block)
21149 (unless org-babel-no-eval-on-ctrl-c-ctrl-c
21150 (org-babel-eval-wipe-error-buffer)
21151 (org-babel-execute-src-block
21152 current-prefix-arg (org-babel-get-src-block-info nil context))))
21153 ((guard (org-match-line "[ \t]*$"))
21154 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21155 (user-error
21156 (substitute-command-keys
21157 "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))
21158 ((or `babel-call `inline-babel-call)
21159 (let ((info (org-babel-lob-get-info context)))
21160 (when info (org-babel-execute-src-block nil info))))
21161 (`clock (org-clock-update-time-maybe))
21162 (`dynamic-block
21163 (save-excursion
21164 (goto-char (org-element-property :post-affiliated context))
21165 (org-update-dblock)))
21166 (`footnote-definition
21167 (goto-char (org-element-property :post-affiliated context))
21168 (call-interactively 'org-footnote-action))
21169 (`footnote-reference (call-interactively #'org-footnote-action))
21170 ((or `headline `inlinetask)
21171 (save-excursion (goto-char (org-element-property :begin context))
21172 (call-interactively #'org-set-tags)))
21173 (`item
21174 ;; At an item: `C-u C-u' sets checkbox to "[-]"
21175 ;; unconditionally, whereas `C-u' will toggle its presence.
21176 ;; Without a universal argument, if the item has a checkbox,
21177 ;; toggle it. Otherwise repair the list.
21178 (let* ((box (org-element-property :checkbox context))
21179 (struct (org-element-property :structure context))
21180 (old-struct (copy-tree struct))
21181 (parents (org-list-parents-alist struct))
21182 (prevs (org-list-prevs-alist struct))
21183 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21184 (org-list-set-checkbox
21185 (org-element-property :begin context) struct
21186 (cond ((equal arg '(16)) "[-]")
21187 ((and (not box) (equal arg '(4))) "[ ]")
21188 ((or (not box) (equal arg '(4))) nil)
21189 ((eq box 'on) "[ ]")
21190 (t "[X]")))
21191 ;; Mimic `org-list-write-struct' but with grabbing a return
21192 ;; value from `org-list-struct-fix-box'.
21193 (org-list-struct-fix-ind struct parents 2)
21194 (org-list-struct-fix-item-end struct)
21195 (org-list-struct-fix-bul struct prevs)
21196 (org-list-struct-fix-ind struct parents)
21197 (let ((block-item
21198 (org-list-struct-fix-box struct parents prevs orderedp)))
21199 (if (and box (equal struct old-struct))
21200 (if (equal arg '(16))
21201 (message "Checkboxes already reset")
21202 (user-error "Cannot toggle this checkbox: %s"
21203 (if (eq box 'on)
21204 "all subitems checked"
21205 "unchecked subitems")))
21206 (org-list-struct-apply-struct struct old-struct)
21207 (org-update-checkbox-count-maybe))
21208 (when block-item
21209 (message "Checkboxes were removed due to empty box at line %d"
21210 (org-current-line block-item))))))
21211 (`keyword
21212 (let ((org-inhibit-startup-visibility-stuff t)
21213 (org-startup-align-all-tables nil))
21214 (when (boundp 'org-table-coordinate-overlays)
21215 (mapc #'delete-overlay org-table-coordinate-overlays)
21216 (setq org-table-coordinate-overlays nil))
21217 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21218 (message "Local setup has been refreshed"))
21219 (`plain-list
21220 ;; At a plain list, with a double C-u argument, set
21221 ;; checkboxes of each item to "[-]", whereas a single one
21222 ;; will toggle their presence according to the state of the
21223 ;; first item in the list. Without an argument, repair the
21224 ;; list.
21225 (let* ((begin (org-element-property :contents-begin context))
21226 (beginm (move-marker (make-marker) begin))
21227 (struct (org-element-property :structure context))
21228 (old-struct (copy-tree struct))
21229 (first-box (save-excursion
21230 (goto-char begin)
21231 (looking-at org-list-full-item-re)
21232 (match-string-no-properties 3)))
21233 (new-box (cond ((equal arg '(16)) "[-]")
21234 ((equal arg '(4)) (unless first-box "[ ]"))
21235 ((equal first-box "[X]") "[ ]")
21236 (t "[X]"))))
21237 (cond
21238 (arg
21239 (dolist (pos
21240 (org-list-get-all-items
21241 begin struct (org-list-prevs-alist struct)))
21242 (org-list-set-checkbox pos struct new-box)))
21243 ((and first-box (eq (point) begin))
21244 ;; For convenience, when point is at bol on the first
21245 ;; item of the list and no argument is provided, simply
21246 ;; toggle checkbox of that item, if any.
21247 (org-list-set-checkbox begin struct new-box)))
21248 (org-list-write-struct
21249 struct (org-list-parents-alist struct) old-struct)
21250 (org-update-checkbox-count-maybe)
21251 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21252 ((or `property-drawer `node-property)
21253 (call-interactively #'org-property-action))
21254 (`radio-target
21255 (call-interactively #'org-update-radio-target-regexp))
21256 (`statistics-cookie
21257 (call-interactively #'org-update-statistics-cookies))
21258 ((or `table `table-cell `table-row)
21259 ;; At a table, recalculate every field and align it. Also
21260 ;; send the table if necessary. If the table has
21261 ;; a `table.el' type, just give up. At a table row or cell,
21262 ;; maybe recalculate line but always align table.
21263 (if (eq (org-element-property :type context) 'table.el)
21264 (message "%s" (substitute-command-keys "\\<org-mode-map>\
21265 Use `\\[org-edit-special]' to edit table.el tables"))
21266 (let ((org-enable-table-editor t))
21267 (if (or (eq type 'table)
21268 ;; Check if point is at a TBLFM line.
21269 (and (eq type 'table-row)
21270 (= (point) (org-element-property :end context))))
21271 (save-excursion
21272 (if (org-at-TBLFM-p)
21273 (progn (require 'org-table)
21274 (org-table-calc-current-TBLFM))
21275 (goto-char (org-element-property :contents-begin context))
21276 (org-call-with-arg 'org-table-recalculate (or arg t))
21277 (orgtbl-send-table 'maybe)))
21278 (org-table-maybe-eval-formula)
21279 (cond (arg (call-interactively #'org-table-recalculate))
21280 ((org-table-maybe-recalculate-line))
21281 (t (org-table-align)))))))
21282 (`timestamp (org-timestamp-change 0 'day))
21283 ((and `nil (guard (org-at-heading-p)))
21284 ;; When point is on an unsupported object type, we can miss
21285 ;; the fact that it also is at a heading. Handle it here.
21286 (call-interactively #'org-set-tags))
21287 ((guard
21288 (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)))
21290 (user-error
21291 (substitute-command-keys
21292 "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))))))
21294 (defun org-mode-restart ()
21295 (interactive)
21296 (let ((indent-status (bound-and-true-p org-indent-mode)))
21297 (funcall major-mode)
21298 (hack-local-variables)
21299 (when (and indent-status (not (bound-and-true-p org-indent-mode)))
21300 (org-indent-mode -1)))
21301 (message "%s restarted" major-mode))
21303 (defun org-kill-note-or-show-branches ()
21304 "Abort storing current note, or call `outline-show-branches'."
21305 (interactive)
21306 (if (not org-finish-function)
21307 (progn
21308 (outline-hide-subtree)
21309 (call-interactively 'outline-show-branches))
21310 (let ((org-note-abort t))
21311 (funcall org-finish-function))))
21313 (defun org-delete-indentation (&optional arg)
21314 "Join current line to previous and fix whitespace at join.
21316 If previous line is a headline add to headline title. Otherwise
21317 the function calls `delete-indentation'.
21319 With a non-nil optional argument, join it to the following one."
21320 (interactive "*P")
21321 (if (save-excursion
21322 (beginning-of-line (if arg 1 0))
21323 (let ((case-fold-search nil))
21324 (looking-at org-complex-heading-regexp)))
21325 ;; At headline.
21326 (let ((tags-column (when (match-beginning 5)
21327 (save-excursion (goto-char (match-beginning 5))
21328 (current-column))))
21329 (string (concat " " (progn (when arg (forward-line 1))
21330 (org-trim (delete-and-extract-region
21331 (line-beginning-position)
21332 (line-end-position)))))))
21333 (unless (bobp) (delete-region (point) (1- (point))))
21334 (goto-char (or (match-end 4)
21335 (match-beginning 5)
21336 (match-end 0)))
21337 (skip-chars-backward " \t")
21338 (save-excursion (insert string))
21339 ;; Adjust alignment of tags.
21340 (cond
21341 ((not tags-column)) ;no tags
21342 (org-auto-align-tags (org-set-tags nil t))
21343 (t (org--align-tags-here tags-column)))) ;preserve tags column
21344 (delete-indentation arg)))
21346 (defun org-open-line (n)
21347 "Insert a new row in tables, call `open-line' elsewhere.
21348 If `org-special-ctrl-o' is nil, just call `open-line' everywhere.
21349 As a special case, when a document starts with a table, allow to
21350 call `open-line' on the very first character."
21351 (interactive "*p")
21352 (if (and org-special-ctrl-o (/= (point) 1) (org-at-table-p))
21353 (org-table-insert-row)
21354 (open-line n)))
21356 (defun org-return (&optional indent)
21357 "Goto next table row or insert a newline.
21359 Calls `org-table-next-row' or `newline', depending on context.
21361 When optional INDENT argument is non-nil, call
21362 `newline-and-indent' instead of `newline'.
21364 When `org-return-follows-link' is non-nil and point is on
21365 a timestamp or a link, call `org-open-at-point'. However, it
21366 will not happen if point is in a table or on a \"dead\"
21367 object (e.g., within a comment). In these case, you need to use
21368 `org-open-at-point' directly."
21369 (interactive)
21370 (let ((context (if org-return-follows-link (org-element-context)
21371 (org-element-at-point))))
21372 (cond
21373 ;; In a table, call `org-table-next-row'.
21374 ((or (and (eq (org-element-type context) 'table)
21375 (>= (point) (org-element-property :contents-begin context))
21376 (< (point) (org-element-property :contents-end context)))
21377 (org-element-lineage context '(table-row table-cell) t))
21378 (org-table-justify-field-maybe)
21379 (call-interactively #'org-table-next-row))
21380 ;; On a link or a timestamp, call `org-open-at-point' if
21381 ;; `org-return-follows-link' allows it. Tolerate fuzzy
21382 ;; locations, e.g., in a comment, as `org-open-at-point'.
21383 ((and org-return-follows-link
21384 (or (org-in-regexp org-ts-regexp-both nil t)
21385 (org-in-regexp org-tsr-regexp-both nil t)
21386 (org-in-regexp org-any-link-re nil t)))
21387 (call-interactively #'org-open-at-point))
21388 ;; Insert newline in heading, but preserve tags.
21389 ((and (not (bolp))
21390 (save-excursion (beginning-of-line)
21391 (let ((case-fold-search nil))
21392 (looking-at org-complex-heading-regexp))))
21393 ;; At headline. Split line. However, if point is on keyword,
21394 ;; priority cookie or tags, do not break any of them: add
21395 ;; a newline after the headline instead.
21396 (let ((tags-column (and (match-beginning 5)
21397 (save-excursion (goto-char (match-beginning 5))
21398 (current-column))))
21399 (string
21400 (when (and (match-end 4) (org-point-in-group (point) 4))
21401 (delete-and-extract-region (point) (match-end 4)))))
21402 ;; Adjust tag alignment.
21403 (cond
21404 ((not (and tags-column string)))
21405 (org-auto-align-tags (org-set-tags nil t))
21406 (t (org--align-tags-here tags-column))) ;preserve tags column
21407 (end-of-line)
21408 (org-show-entry)
21409 (if indent (newline-and-indent) (newline))
21410 (when string (save-excursion (insert (org-trim string))))))
21411 ;; In a list, make sure indenting keeps trailing text within.
21412 ((and indent
21413 (not (eolp))
21414 (org-element-lineage context '(item)))
21415 (let ((trailing-data
21416 (delete-and-extract-region (point) (line-end-position))))
21417 (newline-and-indent)
21418 (save-excursion (insert trailing-data))))
21419 (t (if indent (newline-and-indent) (newline))))))
21421 (defun org-return-indent ()
21422 "Goto next table row or insert a newline and indent.
21423 Calls `org-table-next-row' or `newline-and-indent', depending on
21424 context. See the individual commands for more information."
21425 (interactive)
21426 (org-return t))
21428 (defun org-ctrl-c-star ()
21429 "Compute table, or change heading status of lines.
21430 Calls `org-table-recalculate' or `org-toggle-heading',
21431 depending on context."
21432 (interactive)
21433 (cond
21434 ((org-at-table-p)
21435 (call-interactively 'org-table-recalculate))
21437 ;; Convert all lines in region to list items
21438 (call-interactively 'org-toggle-heading))))
21440 (defun org-ctrl-c-minus ()
21441 "Insert separator line in table or modify bullet status of line.
21442 Also turns a plain line or a region of lines into list items.
21443 Calls `org-table-insert-hline', `org-toggle-item', or
21444 `org-cycle-list-bullet', depending on context."
21445 (interactive)
21446 (cond
21447 ((org-at-table-p)
21448 (call-interactively 'org-table-insert-hline))
21449 ((org-region-active-p)
21450 (call-interactively 'org-toggle-item))
21451 ((org-in-item-p)
21452 (call-interactively 'org-cycle-list-bullet))
21454 (call-interactively 'org-toggle-item))))
21456 (defun org-toggle-heading (&optional nstars)
21457 "Convert headings to normal text, or items or text to headings.
21458 If there is no active region, only convert the current line.
21460 With a `\\[universal-argument]' prefix, convert the whole list at
21461 point into heading.
21463 In a region:
21465 - If the first non blank line is a headline, remove the stars
21466 from all headlines in the region.
21468 - If it is a normal line, turn each and every normal line (i.e.,
21469 not an heading or an item) in the region into headings. If you
21470 want to convert only the first line of this region, use one
21471 universal prefix argument.
21473 - If it is a plain list item, turn all plain list items into headings.
21475 When converting a line into a heading, the number of stars is chosen
21476 such that the lines become children of the current entry. However,
21477 when a numeric prefix argument is given, its value determines the
21478 number of stars to add."
21479 (interactive "P")
21480 (let ((skip-blanks
21481 (function
21482 ;; Return beginning of first non-blank line, starting from
21483 ;; line at POS.
21484 (lambda (pos)
21485 (save-excursion
21486 (goto-char pos)
21487 (while (org-at-comment-p) (forward-line))
21488 (skip-chars-forward " \r\t\n")
21489 (point-at-bol)))))
21490 beg end toggled)
21491 ;; Determine boundaries of changes. If a universal prefix has
21492 ;; been given, put the list in a region. If region ends at a bol,
21493 ;; do not consider the last line to be in the region.
21495 (when (and current-prefix-arg (org-at-item-p))
21496 (when (listp current-prefix-arg) (setq current-prefix-arg 1))
21497 (org-mark-element))
21499 (if (org-region-active-p)
21500 (setq beg (funcall skip-blanks (region-beginning))
21501 end (copy-marker (save-excursion
21502 (goto-char (region-end))
21503 (if (bolp) (point) (point-at-eol)))))
21504 (setq beg (funcall skip-blanks (point-at-bol))
21505 end (copy-marker (point-at-eol))))
21506 ;; Ensure inline tasks don't count as headings.
21507 (org-with-limited-levels
21508 (save-excursion
21509 (goto-char beg)
21510 (cond
21511 ;; Case 1. Started at an heading: de-star headings.
21512 ((org-at-heading-p)
21513 (while (< (point) end)
21514 (when (org-at-heading-p t)
21515 (looking-at org-outline-regexp) (replace-match "")
21516 (setq toggled t))
21517 (forward-line)))
21518 ;; Case 2. Started at an item: change items into headlines.
21519 ;; One star will be added by `org-list-to-subtree'.
21520 ((org-at-item-p)
21521 (while (< (point) end)
21522 (when (org-at-item-p)
21523 ;; Pay attention to cases when region ends before list.
21524 (let* ((struct (org-list-struct))
21525 (list-end
21526 (min (org-list-get-bottom-point struct) (1+ end))))
21527 (save-restriction
21528 (narrow-to-region (point) list-end)
21529 (insert (org-list-to-subtree (org-list-to-lisp t)) "\n")))
21530 (setq toggled t))
21531 (forward-line)))
21532 ;; Case 3. Started at normal text: make every line an heading,
21533 ;; skipping headlines and items.
21534 (t (let* ((stars
21535 (make-string
21536 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21537 (add-stars
21538 (cond (nstars "") ; stars from prefix only
21539 ((equal stars "") "*") ; before first heading
21540 (org-odd-levels-only "**") ; inside heading, odd
21541 (t "*"))) ; inside heading, oddeven
21542 (rpl (concat stars add-stars " "))
21543 (lend (when (listp nstars) (save-excursion (end-of-line) (point)))))
21544 (while (< (point) (if (equal nstars '(4)) lend end))
21545 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21546 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21547 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21548 (forward-line)))))))
21549 (unless toggled (message "Cannot toggle heading from here"))))
21551 (defun org-meta-return (&optional _arg)
21552 "Insert a new heading or wrap a region in a table.
21553 Calls `org-insert-heading' or `org-table-wrap-region', depending
21554 on context. See the individual commands for more information."
21555 (interactive)
21556 (org-check-before-invisible-edit 'insert)
21557 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21558 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21559 #'org-insert-heading))))
21561 ;;; Menu entries
21563 (defsubst org-in-subtree-not-table-p ()
21564 "Are we in a subtree and not in a table?"
21565 (and (not (org-before-first-heading-p))
21566 (not (org-at-table-p))))
21568 ;; Define the Org mode menus
21569 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21570 '("Tbl"
21571 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21572 ["Next Field" org-cycle (org-at-table-p)]
21573 ["Previous Field" org-shifttab (org-at-table-p)]
21574 ["Next Row" org-return (org-at-table-p)]
21575 "--"
21576 ["Blank Field" org-table-blank-field (org-at-table-p)]
21577 ["Edit Field" org-table-edit-field (org-at-table-p)]
21578 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21579 "--"
21580 ("Column"
21581 ["Move Column Left" org-metaleft (org-at-table-p)]
21582 ["Move Column Right" org-metaright (org-at-table-p)]
21583 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21584 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21585 ("Row"
21586 ["Move Row Up" org-metaup (org-at-table-p)]
21587 ["Move Row Down" org-metadown (org-at-table-p)]
21588 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21589 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21590 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21591 "--"
21592 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21593 ("Rectangle"
21594 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21595 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21596 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21597 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21598 "--"
21599 ("Calculate"
21600 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21601 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21602 ["Edit Formulas" org-edit-special (org-at-table-p)]
21603 "--"
21604 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21605 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21606 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21607 "--"
21608 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21609 "--"
21610 ["Sum Column/Rectangle" org-table-sum
21611 (or (org-at-table-p) (org-region-active-p))]
21612 ["Which Column?" org-table-current-column (org-at-table-p)])
21613 ["Debug Formulas"
21614 org-table-toggle-formula-debugger
21615 :style toggle :selected (bound-and-true-p org-table-formula-debug)]
21616 ["Show Col/Row Numbers"
21617 org-table-toggle-coordinate-overlays
21618 :style toggle
21619 :selected (bound-and-true-p org-table-overlay-coordinates)]
21620 "--"
21621 ["Create" org-table-create (and (not (org-at-table-p))
21622 org-enable-table-editor)]
21623 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21624 ["Import from File" org-table-import (not (org-at-table-p))]
21625 ["Export to File" org-table-export (org-at-table-p)]
21626 "--"
21627 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21628 "--"
21629 ("Plot"
21630 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21631 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21633 (easy-menu-define org-org-menu org-mode-map "Org menu"
21634 '("Org"
21635 ("Show/Hide"
21636 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21637 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21638 ["Sparse Tree..." org-sparse-tree t]
21639 ["Reveal Context" org-reveal t]
21640 ["Show All" outline-show-all t]
21641 "--"
21642 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21643 "--"
21644 ["New Heading" org-insert-heading t]
21645 ("Navigate Headings"
21646 ["Up" outline-up-heading t]
21647 ["Next" outline-next-visible-heading t]
21648 ["Previous" outline-previous-visible-heading t]
21649 ["Next Same Level" outline-forward-same-level t]
21650 ["Previous Same Level" outline-backward-same-level t]
21651 "--"
21652 ["Jump" org-goto t])
21653 ("Edit Structure"
21654 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21655 "--"
21656 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21657 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21658 "--"
21659 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21660 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21661 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21662 "--"
21663 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21664 "--"
21665 ["Copy visible text" org-copy-visible t]
21666 "--"
21667 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21668 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21669 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21670 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21671 "--"
21672 ["Sort Region/Children" org-sort t]
21673 "--"
21674 ["Convert to odd levels" org-convert-to-odd-levels t]
21675 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21676 ("Editing"
21677 ["Emphasis..." org-emphasize t]
21678 ["Edit Source Example" org-edit-special t]
21679 "--"
21680 ["Footnote new/jump" org-footnote-action t]
21681 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21682 ("Archive"
21683 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21684 "--"
21685 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21686 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21687 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21689 "--"
21690 ("Hyperlinks"
21691 ["Store Link (Global)" org-store-link t]
21692 ["Find existing link to here" org-occur-link-in-agenda-files t]
21693 ["Insert Link" org-insert-link t]
21694 ["Follow Link" org-open-at-point t]
21695 "--"
21696 ["Next link" org-next-link t]
21697 ["Previous link" org-previous-link t]
21698 "--"
21699 ["Descriptive Links"
21700 org-toggle-link-display
21701 :style radio
21702 :selected org-descriptive-links
21704 ["Literal Links"
21705 org-toggle-link-display
21706 :style radio
21707 :selected (not org-descriptive-links)])
21708 "--"
21709 ("TODO Lists"
21710 ["TODO/DONE/-" org-todo t]
21711 ("Select keyword"
21712 ["Next keyword" org-shiftright (org-at-heading-p)]
21713 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21714 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21715 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21716 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21717 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21718 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21719 "--"
21720 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21721 :selected org-enforce-todo-dependencies :style toggle :active t]
21722 "Settings for tree at point"
21723 ["Do Children sequentially" org-toggle-ordered-property :style radio
21724 :selected (org-entry-get nil "ORDERED")
21725 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21726 ["Do Children parallel" org-toggle-ordered-property :style radio
21727 :selected (not (org-entry-get nil "ORDERED"))
21728 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21729 "--"
21730 ["Set Priority" org-priority t]
21731 ["Priority Up" org-shiftup t]
21732 ["Priority Down" org-shiftdown t]
21733 "--"
21734 ["Get news from all feeds" org-feed-update-all t]
21735 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21736 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21737 ("TAGS and Properties"
21738 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21739 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21740 "--"
21741 ["Set property" org-set-property (not (org-before-first-heading-p))]
21742 ["Column view of properties" org-columns t]
21743 ["Insert Column View DBlock" org-columns-insert-dblock t])
21744 ("Dates and Scheduling"
21745 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21746 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21747 ("Change Date"
21748 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21749 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21750 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21751 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21752 ["Compute Time Range" org-evaluate-time-range t]
21753 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21754 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21755 "--"
21756 ["Custom time format" org-toggle-time-stamp-overlays
21757 :style radio :selected org-display-custom-times]
21758 "--"
21759 ["Goto Calendar" org-goto-calendar t]
21760 ["Date from Calendar" org-date-from-calendar t]
21761 "--"
21762 ["Start/Restart Timer" org-timer-start t]
21763 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21764 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21765 ["Insert Timer String" org-timer t]
21766 ["Insert Timer Item" org-timer-item t])
21767 ("Logging work"
21768 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21769 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21770 ["Clock out" org-clock-out t]
21771 ["Clock cancel" org-clock-cancel t]
21772 "--"
21773 ["Mark as default task" org-clock-mark-default-task t]
21774 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21775 ["Goto running clock" org-clock-goto t]
21776 "--"
21777 ["Display times" org-clock-display t]
21778 ["Create clock table" org-clock-report t]
21779 "--"
21780 ["Record DONE time"
21781 (progn (setq org-log-done (not org-log-done))
21782 (message "Switching to %s will %s record a timestamp"
21783 (car org-done-keywords)
21784 (if org-log-done "automatically" "not")))
21785 :style toggle :selected org-log-done])
21786 "--"
21787 ["Agenda Command..." org-agenda t]
21788 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21789 ("File List for Agenda")
21790 ("Special views current file"
21791 ["TODO Tree" org-show-todo-tree t]
21792 ["Check Deadlines" org-check-deadlines t]
21793 ["Timeline" org-timeline t]
21794 ["Tags/Property tree" org-match-sparse-tree t])
21795 "--"
21796 ["Export/Publish..." org-export-dispatch t]
21797 ("LaTeX"
21798 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21799 :selected org-cdlatex-mode]
21800 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21801 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21802 ["Modify math symbol" org-cdlatex-math-modify
21803 (org-inside-LaTeX-fragment-p)]
21804 ["Insert citation" org-reftex-citation t])
21805 "--"
21806 ("MobileOrg"
21807 ["Push Files and Views" org-mobile-push t]
21808 ["Get Captured and Flagged" org-mobile-pull t]
21809 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21810 "--"
21811 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21812 "--"
21813 ("Documentation"
21814 ["Show Version" org-version t]
21815 ["Info Documentation" org-info t])
21816 ("Customize"
21817 ["Browse Org Group" org-customize t]
21818 "--"
21819 ["Expand This Menu" org-create-customize-menu
21820 (fboundp 'customize-menu-create)])
21821 ["Send bug report" org-submit-bug-report t]
21822 "--"
21823 ("Refresh/Reload"
21824 ["Refresh setup current buffer" org-mode-restart t]
21825 ["Reload Org (after update)" org-reload t]
21826 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21829 (defun org-info (&optional node)
21830 "Read documentation for Org in the info system.
21831 With optional NODE, go directly to that node."
21832 (interactive)
21833 (info (format "(org)%s" (or node ""))))
21835 ;;;###autoload
21836 (defun org-submit-bug-report ()
21837 "Submit a bug report on Org via mail.
21839 Don't hesitate to report any problems or inaccurate documentation.
21841 If you don't have setup sending mail from (X)Emacs, please copy the
21842 output buffer into your mail program, as it gives us important
21843 information about your Org version and configuration."
21844 (interactive)
21845 (require 'reporter)
21846 (defvar reporter-prompt-for-summary-p)
21847 (org-load-modules-maybe)
21848 (org-require-autoloaded-modules)
21849 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21850 (reporter-submit-bug-report
21851 "emacs-orgmode@gnu.org"
21852 (org-version nil 'full)
21853 (let (list)
21854 (save-window-excursion
21855 (pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21856 (delete-other-windows)
21857 (erase-buffer)
21858 (insert "You are about to submit a bug report to the Org mailing list.
21860 We would like to add your full Org and Outline configuration to the
21861 bug report. This greatly simplifies the work of the maintainer and
21862 other experts on the mailing list.
21864 HOWEVER, some variables you have customized may contain private
21865 information. The names of customers, colleagues, or friends, might
21866 appear in the form of file names, tags, todo states, or search strings.
21867 If you answer yes to the prompt, you might want to check and remove
21868 such private information before sending the email.")
21869 (add-text-properties (point-min) (point-max) '(face org-warning))
21870 (when (yes-or-no-p "Include your Org configuration ")
21871 (mapatoms
21872 (lambda (v)
21873 (and (boundp v)
21874 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21875 (or (and (symbol-value v)
21876 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21877 (and
21878 (get v 'custom-type) (get v 'standard-value)
21879 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21880 (push v list)))))
21881 (kill-buffer (get-buffer "*Warn about privacy*"))
21882 list))
21883 nil nil
21884 "Remember to cover the basics, that is, what you expected to happen and
21885 what in fact did happen. You don't know how to make a good report? See
21887 http://orgmode.org/manual/Feedback.html#Feedback
21889 Your bug report will be posted to the Org mailing list.
21890 ------------------------------------------------------------------------")
21891 (save-excursion
21892 (when (re-search-backward "^\\(Subject: \\)Org mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21893 (replace-match "\\1Bug: \\3 [\\2]")))))
21896 (defun org-install-agenda-files-menu ()
21897 (let ((bl (buffer-list)))
21898 (save-excursion
21899 (while bl
21900 (set-buffer (pop bl))
21901 (when (derived-mode-p 'org-mode) (setq bl nil)))
21902 (when (derived-mode-p 'org-mode)
21903 (easy-menu-change
21904 '("Org") "File List for Agenda"
21905 (append
21906 (list
21907 ["Edit File List" (org-edit-agenda-file-list) t]
21908 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21909 ["Remove Current File from List" org-remove-file t]
21910 ["Cycle through agenda files" org-cycle-agenda-files t]
21911 ["Occur in all agenda files" org-occur-in-agenda-files t]
21912 "--")
21913 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21915 ;;;; Documentation
21917 (defun org-require-autoloaded-modules ()
21918 (interactive)
21919 (mapc #'require
21920 '(org-agenda org-archive org-attach org-clock org-colview org-id
21921 org-table org-timer)))
21923 ;;;###autoload
21924 (defun org-reload (&optional uncompiled)
21925 "Reload all org lisp files.
21926 With prefix arg UNCOMPILED, load the uncompiled versions."
21927 (interactive "P")
21928 (require 'loadhist)
21929 (let* ((org-dir (org-find-library-dir "org"))
21930 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21931 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21932 (remove-re (format "\\`%s\\'"
21933 (regexp-opt '("org" "org-loaddefs" "org-version"))))
21934 (feats (delete-dups
21935 (mapcar 'file-name-sans-extension
21936 (mapcar 'file-name-nondirectory
21937 (delq nil
21938 (mapcar 'feature-file
21939 features))))))
21940 (lfeat (append
21941 (sort
21942 (setq feats
21943 (delq nil (mapcar
21944 (lambda (f)
21945 (if (and (string-match feature-re f)
21946 (not (string-match remove-re f)))
21947 f nil))
21948 feats)))
21949 'string-lessp)
21950 (list "org-version" "org")))
21951 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21952 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21953 load-uncore load-misses)
21954 (setq load-misses
21955 (delq 't
21956 (mapcar (lambda (f)
21957 (or (org-load-noerror-mustsuffix (concat org-dir f))
21958 (and (string= org-dir contrib-dir)
21959 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21960 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21961 (add-to-list 'load-uncore f 'append)
21964 lfeat)))
21965 (when load-uncore
21966 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21967 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21968 (if load-misses
21969 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21970 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21971 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21973 ;;;###autoload
21974 (defun org-customize ()
21975 "Call the customize function with org as argument."
21976 (interactive)
21977 (org-load-modules-maybe)
21978 (org-require-autoloaded-modules)
21979 (customize-browse 'org))
21981 (defun org-create-customize-menu ()
21982 "Create a full customization menu for Org mode, insert it into the menu."
21983 (interactive)
21984 (org-load-modules-maybe)
21985 (org-require-autoloaded-modules)
21986 (if (fboundp 'customize-menu-create)
21987 (progn
21988 (easy-menu-change
21989 '("Org") "Customize"
21990 `(["Browse Org group" org-customize t]
21991 "--"
21992 ,(customize-menu-create 'org)
21993 ["Set" Custom-set t]
21994 ["Save" Custom-save t]
21995 ["Reset to Current" Custom-reset-current t]
21996 ["Reset to Saved" Custom-reset-saved t]
21997 ["Reset to Standard Settings" Custom-reset-standard t]))
21998 (message "\"Org\"-menu now contains full customization menu"))
21999 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22001 ;;;; Miscellaneous stuff
22003 ;;; Generally useful functions
22005 (defun org-get-at-eol (property n)
22006 "Get text property PROPERTY at the end of line less N characters."
22007 (get-text-property (- (point-at-eol) n) property))
22009 (defun org-find-text-property-in-string (prop s)
22010 "Return the first non-nil value of property PROP in string S."
22011 (or (get-text-property 0 prop s)
22012 (get-text-property (or (next-single-property-change 0 prop s) 0)
22013 prop s)))
22015 (defun org-display-warning (message)
22016 "Display the given MESSAGE as a warning."
22017 (display-warning 'org message :warning))
22019 (defun org-eval (form)
22020 "Eval FORM and return result."
22021 (condition-case error
22022 (eval form)
22023 (error (format "%%![Error: %s]" error))))
22025 (defun org-in-clocktable-p ()
22026 "Check if the cursor is in a clocktable."
22027 (let ((pos (point)) start)
22028 (save-excursion
22029 (end-of-line 1)
22030 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22031 (setq start (match-beginning 0))
22032 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22033 (>= (match-end 0) pos)
22034 start))))
22036 (defun org-in-verbatim-emphasis ()
22037 (save-match-data
22038 (and (org-in-regexp org-emph-re 2)
22039 (>= (point) (match-beginning 3))
22040 (<= (point) (match-end 4))
22041 (member (match-string 3) '("=" "~")))))
22043 (defun org-overlay-display (ovl text &optional face evap)
22044 "Make overlay OVL display TEXT with face FACE."
22045 (overlay-put ovl 'display text)
22046 (if face (overlay-put ovl 'face face))
22047 (if evap (overlay-put ovl 'evaporate t)))
22049 (defun org-overlay-before-string (ovl text &optional face evap)
22050 "Make overlay OVL display TEXT with face FACE."
22051 (if face (org-add-props text nil 'face face))
22052 (overlay-put ovl 'before-string text)
22053 (if evap (overlay-put ovl 'evaporate t)))
22055 (defun org-find-overlays (prop &optional pos delete)
22056 "Find all overlays specifying PROP at POS or point.
22057 If DELETE is non-nil, delete all those overlays."
22058 (let (found)
22059 (dolist (ov (overlays-at (or pos (point))) found)
22060 (cond ((not (overlay-get ov prop)))
22061 (delete (delete-overlay ov))
22062 (t (push ov found))))))
22064 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22065 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22066 (if (and marker (marker-buffer marker)
22067 (buffer-live-p (marker-buffer marker)))
22068 (progn
22069 (pop-to-buffer-same-window (marker-buffer marker))
22070 (when (or (> marker (point-max)) (< marker (point-min)))
22071 (widen))
22072 (goto-char marker)
22073 (org-show-context 'org-goto))
22074 (if bookmark
22075 (bookmark-jump bookmark)
22076 (error "Cannot find location"))))
22078 (defun org-quote-csv-field (s)
22079 "Quote field for inclusion in CSV material."
22080 (if (string-match "[\",]" s)
22081 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22084 (defun org-force-self-insert (N)
22085 "Needed to enforce self-insert under remapping."
22086 (interactive "p")
22087 (self-insert-command N))
22089 (defun org-string-width (s)
22090 "Compute width of string, ignoring invisible characters.
22091 This ignores character with invisibility property `org-link', and also
22092 characters with property `org-cwidth', because these will become invisible
22093 upon the next fontification round."
22094 (let (b l)
22095 (when (or (eq t buffer-invisibility-spec)
22096 (assq 'org-link buffer-invisibility-spec))
22097 (while (setq b (text-property-any 0 (length s)
22098 'invisible 'org-link s))
22099 (setq s (concat (substring s 0 b)
22100 (substring s (or (next-single-property-change
22101 b 'invisible s)
22102 (length s)))))))
22103 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22104 (setq s (concat (substring s 0 b)
22105 (substring s (or (next-single-property-change
22106 b 'org-cwidth s)
22107 (length s))))))
22108 (setq l (string-width s) b -1)
22109 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22110 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22113 (defun org-shorten-string (s maxlength)
22114 "Shorten string S so that it is no longer than MAXLENGTH characters.
22115 If the string is shorter or has length MAXLENGTH, just return the
22116 original string. If it is longer, the functions finds a space in the
22117 string, breaks this string off at that locations and adds three dots
22118 as ellipsis. Including the ellipsis, the string will not be longer
22119 than MAXLENGTH. If finding a good breaking point in the string does
22120 not work, the string is just chopped off in the middle of a word
22121 if necessary."
22122 (if (<= (length s) maxlength)
22124 (let* ((n (max (- maxlength 4) 1))
22125 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22126 (if (string-match re s)
22127 (concat (match-string 1 s) "...")
22128 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22130 (defun org-get-indentation (&optional line)
22131 "Get the indentation of the current line, interpreting tabs.
22132 When LINE is given, assume it represents a line and compute its indentation."
22133 (if line
22134 (when (string-match "^ *" (org-remove-tabs line))
22135 (match-end 0))
22136 (save-excursion
22137 (beginning-of-line 1)
22138 (skip-chars-forward " \t")
22139 (current-column))))
22141 (defun org-get-string-indentation (s)
22142 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22143 (let ((n -1) (i 0) (w tab-width) c)
22144 (catch 'exit
22145 (while (< (setq n (1+ n)) (length s))
22146 (setq c (aref s n))
22147 (cond ((= c ?\ ) (setq i (1+ i)))
22148 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22149 (t (throw 'exit t)))))
22152 (defun org-remove-tabs (s &optional width)
22153 "Replace tabulators in S with spaces.
22154 Assumes that s is a single line, starting in column 0."
22155 (setq width (or width tab-width))
22156 (while (string-match "\t" s)
22157 (setq s (replace-match
22158 (make-string
22159 (- (* width (/ (+ (match-beginning 0) width) width))
22160 (match-beginning 0)) ?\ )
22161 t t s)))
22164 (defun org-fix-indentation (line ind)
22165 "Fix indentation in LINE.
22166 IND is a cons cell with target and minimum indentation.
22167 If the current indentation in LINE is smaller than the minimum,
22168 leave it alone. If it is larger than ind, set it to the target."
22169 (let* ((l (org-remove-tabs line))
22170 (i (org-get-indentation l))
22171 (i1 (car ind)) (i2 (cdr ind)))
22172 (when (>= i i2) (setq l (substring line i2)))
22173 (if (> i1 0)
22174 (concat (make-string i1 ?\ ) l)
22175 l)))
22177 (defun org-remove-indentation (code &optional n)
22178 "Remove maximum common indentation in string CODE and return it.
22179 N may optionally be the number of columns to remove. Return CODE
22180 as-is if removal failed."
22181 (with-temp-buffer
22182 (insert code)
22183 (if (org-do-remove-indentation n) (buffer-string) code)))
22185 (defun org-do-remove-indentation (&optional n)
22186 "Remove the maximum common indentation from the buffer.
22187 When optional argument N is a positive integer, remove exactly
22188 that much characters from indentation, if possible. Return nil
22189 if it fails."
22190 (catch :exit
22191 (goto-char (point-min))
22192 ;; Find maximum common indentation, if not specified.
22193 (let ((n (or n
22194 (let ((min-ind (point-max)))
22195 (save-excursion
22196 (while (re-search-forward "^[ \t]*\\S-" nil t)
22197 (let ((ind (1- (current-column))))
22198 (if (zerop ind) (throw :exit nil)
22199 (setq min-ind (min min-ind ind))))))
22200 min-ind))))
22201 (if (zerop n) (throw :exit nil)
22202 ;; Remove exactly N indentation, but give up if not possible.
22203 (while (not (eobp))
22204 (let ((ind (progn (skip-chars-forward " \t") (current-column))))
22205 (cond ((eolp) (delete-region (line-beginning-position) (point)))
22206 ((< ind n) (throw :exit nil))
22207 (t (indent-line-to (- ind n))))
22208 (forward-line)))
22209 ;; Signal success.
22210 t))))
22212 (defun org-fill-template (template alist)
22213 "Find each %key of ALIST in TEMPLATE and replace it."
22214 (let ((case-fold-search nil))
22215 (dolist (entry (sort (copy-sequence alist)
22216 (lambda (a b) (< (length (car a)) (length (car b))))))
22217 (setq template
22218 (replace-regexp-in-string
22219 (concat "%" (regexp-quote (car entry)))
22220 (or (cdr entry) "") template t t)))
22221 template))
22223 (defun org-base-buffer (buffer)
22224 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22225 (if (not buffer)
22226 buffer
22227 (or (buffer-base-buffer buffer)
22228 buffer)))
22230 (defun org-wrap (string &optional width lines)
22231 "Wrap string to either a number of lines, or a width in characters.
22232 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22233 that costs. If there is a word longer than WIDTH, the text is actually
22234 wrapped to the length of that word.
22235 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22236 many lines, whatever width that takes.
22237 The return value is a list of lines, without newlines at the end."
22238 (let* ((words (org-split-string string "[ \t\n]+"))
22239 (maxword (apply 'max (mapcar 'org-string-width words)))
22240 w ll)
22241 (cond (width
22242 (org-do-wrap words (max maxword width)))
22243 (lines
22244 (setq w maxword)
22245 (setq ll (org-do-wrap words maxword))
22246 (if (<= (length ll) lines)
22248 (setq ll words)
22249 (while (> (length ll) lines)
22250 (setq w (1+ w))
22251 (setq ll (org-do-wrap words w)))
22252 ll))
22253 (t (error "Cannot wrap this")))))
22255 (defun org-do-wrap (words width)
22256 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22257 (let (lines line)
22258 (while words
22259 (setq line (pop words))
22260 (while (and words (< (+ (length line) (length (car words))) width))
22261 (setq line (concat line " " (pop words))))
22262 (setq lines (push line lines)))
22263 (nreverse lines)))
22265 (defun org-split-string (string &optional separators)
22266 "Splits STRING into substrings at SEPARATORS.
22267 SEPARATORS is a regular expression.
22268 No empty strings are returned if there are matches at the beginning
22269 and end of string."
22270 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22271 (let ((start 0) notfirst list)
22272 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22273 (if (and notfirst
22274 (= start (match-beginning 0))
22275 (< start (length string)))
22276 (1+ start) start))
22277 (< (match-beginning 0) (length string)))
22278 (setq notfirst t)
22279 (or (eq (match-beginning 0) 0)
22280 (and (eq (match-beginning 0) (match-end 0))
22281 (eq (match-beginning 0) start))
22282 (push (substring string start (match-beginning 0)) list))
22283 (setq start (match-end 0)))
22284 (or (eq start (length string))
22285 (push (substring string start) list))
22286 (nreverse list)))
22288 (defun org-quote-vert (s)
22289 "Replace \"|\" with \"\\vert\"."
22290 (while (string-match "|" s)
22291 (setq s (replace-match "\\vert" t t s)))
22294 (defun org-uuidgen-p (s)
22295 "Is S an ID created by UUIDGEN?"
22296 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22298 (defun org-in-src-block-p (&optional inside)
22299 "Whether point is in a code source block.
22300 When INSIDE is non-nil, don't consider we are within a src block
22301 when point is at #+BEGIN_SRC or #+END_SRC."
22302 (let ((case-fold-search t))
22303 (or (and (eq (get-char-property (point) 'src-block) t))
22304 (and (not inside)
22305 (save-match-data
22306 (save-excursion
22307 (beginning-of-line)
22308 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22310 (defun org-context ()
22311 "Return a list of contexts of the current cursor position.
22312 If several contexts apply, all are returned.
22313 Each context entry is a list with a symbol naming the context, and
22314 two positions indicating start and end of the context. Possible
22315 contexts are:
22317 :headline anywhere in a headline
22318 :headline-stars on the leading stars in a headline
22319 :todo-keyword on a TODO keyword (including DONE) in a headline
22320 :tags on the TAGS in a headline
22321 :priority on the priority cookie in a headline
22322 :item on the first line of a plain list item
22323 :item-bullet on the bullet/number of a plain list item
22324 :checkbox on the checkbox in a plain list item
22325 :table in an Org table
22326 :table-special on a special filed in a table
22327 :table-table in a table.el table
22328 :clocktable in a clocktable
22329 :src-block in a source block
22330 :link on a hyperlink
22331 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22332 :target on a <<target>>
22333 :radio-target on a <<<radio-target>>>
22334 :latex-fragment on a LaTeX fragment
22335 :latex-preview on a LaTeX fragment with overlaid preview image
22337 This function expects the position to be visible because it uses font-lock
22338 faces as a help to recognize the following contexts: :table-special, :link,
22339 and :keyword."
22340 (let* ((f (get-text-property (point) 'face))
22341 (faces (if (listp f) f (list f)))
22342 (case-fold-search t)
22343 (p (point)) clist o)
22344 ;; First the large context
22345 (cond
22346 ((org-at-heading-p t)
22347 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22348 (when (progn
22349 (beginning-of-line 1)
22350 (looking-at org-todo-line-tags-regexp))
22351 (push (org-point-in-group p 1 :headline-stars) clist)
22352 (push (org-point-in-group p 2 :todo-keyword) clist)
22353 (push (org-point-in-group p 4 :tags) clist))
22354 (goto-char p)
22355 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22356 (when (looking-at "\\[#[A-Z0-9]\\]")
22357 (push (org-point-in-group p 0 :priority) clist)))
22359 ((org-at-item-p)
22360 (push (org-point-in-group p 2 :item-bullet) clist)
22361 (push (list :item (point-at-bol)
22362 (save-excursion (org-end-of-item) (point)))
22363 clist)
22364 (and (org-at-item-checkbox-p)
22365 (push (org-point-in-group p 0 :checkbox) clist)))
22367 ((org-at-table-p)
22368 (push (list :table (org-table-begin) (org-table-end)) clist)
22369 (when (memq 'org-formula faces)
22370 (push (list :table-special
22371 (previous-single-property-change p 'face)
22372 (next-single-property-change p 'face)) clist)))
22373 ((org-at-table-p 'any)
22374 (push (list :table-table) clist)))
22375 (goto-char p)
22377 (let ((case-fold-search t))
22378 ;; New the "medium" contexts: clocktables, source blocks
22379 (cond ((org-in-clocktable-p)
22380 (push (list :clocktable
22381 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22382 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22383 (match-beginning 1))
22384 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22385 (match-end 0))) clist))
22386 ((org-in-src-block-p)
22387 (push (list :src-block
22388 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22389 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22390 (match-beginning 1))
22391 (and (search-forward "#+END_SRC" nil t)
22392 (match-beginning 0))) clist))))
22393 (goto-char p)
22395 ;; Now the small context
22396 (cond
22397 ((org-at-timestamp-p)
22398 (push (org-point-in-group p 0 :timestamp) clist))
22399 ((memq 'org-link faces)
22400 (push (list :link
22401 (previous-single-property-change p 'face)
22402 (next-single-property-change p 'face)) clist))
22403 ((memq 'org-special-keyword faces)
22404 (push (list :keyword
22405 (previous-single-property-change p 'face)
22406 (next-single-property-change p 'face)) clist))
22407 ((org-at-target-p)
22408 (push (org-point-in-group p 0 :target) clist)
22409 (goto-char (1- (match-beginning 0)))
22410 (when (looking-at org-radio-target-regexp)
22411 (push (org-point-in-group p 0 :radio-target) clist))
22412 (goto-char p))
22413 ((setq o (cl-some
22414 (lambda (o)
22415 (and (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay)
22417 (overlays-at (point))))
22418 (push (list :latex-fragment
22419 (overlay-start o) (overlay-end o)) clist)
22420 (push (list :latex-preview
22421 (overlay-start o) (overlay-end o)) clist))
22422 ((org-inside-LaTeX-fragment-p)
22423 ;; FIXME: positions wrong.
22424 (push (list :latex-fragment (point) (point)) clist)))
22426 (setq clist (nreverse (delq nil clist)))
22427 clist))
22429 (defun org-in-regexp (regexp &optional nlines visually)
22430 "Check if point is inside a match of REGEXP.
22432 Normally only the current line is checked, but you can include
22433 NLINES extra lines around point into the search. If VISUALLY is
22434 set, require that the cursor is not after the match but really
22435 on, so that the block visually is on the match.
22437 Return nil or a cons cell (BEG . END) where BEG and END are,
22438 respectively, the positions at the beginning and the end of the
22439 match."
22440 (catch :exit
22441 (let ((pos (point))
22442 (eol (line-end-position (if nlines (1+ nlines) 1))))
22443 (save-excursion
22444 (beginning-of-line (- 1 (or nlines 0)))
22445 (while (and (re-search-forward regexp eol t)
22446 (<= (match-beginning 0) pos))
22447 (let ((end (match-end 0)))
22448 (when (or (> end pos) (and (= end pos) (not visually)))
22449 (throw :exit (cons (match-beginning 0) (match-end 0))))))))))
22451 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22452 "Non-nil when point is between matches of START-RE and END-RE.
22454 Also return a non-nil value when point is on one of the matches.
22456 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22457 buffer positions. Default values are the positions of headlines
22458 surrounding the point.
22460 The functions returns a cons cell whose car (resp. cdr) is the
22461 position before START-RE (resp. after END-RE)."
22462 (save-match-data
22463 (let ((pos (point))
22464 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22465 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22466 beg end)
22467 (save-excursion
22468 ;; Point is on a block when on START-RE or if START-RE can be
22469 ;; found before it...
22470 (and (or (org-in-regexp start-re)
22471 (re-search-backward start-re limit-up t))
22472 (setq beg (match-beginning 0))
22473 ;; ... and END-RE after it...
22474 (goto-char (match-end 0))
22475 (re-search-forward end-re limit-down t)
22476 (> (setq end (match-end 0)) pos)
22477 ;; ... without another START-RE in-between.
22478 (goto-char (match-beginning 0))
22479 (not (re-search-backward start-re (1+ beg) t))
22480 ;; Return value.
22481 (cons beg end))))))
22483 (defun org-in-block-p (names)
22484 "Non-nil when point belongs to a block whose name belongs to NAMES.
22486 NAMES is a list of strings containing names of blocks.
22488 Return first block name matched, or nil. Beware that in case of
22489 nested blocks, the returned name may not belong to the closest
22490 block from point."
22491 (save-match-data
22492 (catch 'exit
22493 (let ((case-fold-search t)
22494 (lim-up (save-excursion (outline-previous-heading)))
22495 (lim-down (save-excursion (outline-next-heading))))
22496 (dolist (name names)
22497 (let ((n (regexp-quote name)))
22498 (when (org-between-regexps-p
22499 (concat "^[ \t]*#\\+begin_" n)
22500 (concat "^[ \t]*#\\+end_" n)
22501 lim-up lim-down)
22502 (throw 'exit n)))))
22503 nil)))
22505 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22506 "Call `multi-occur' with buffers for all agenda files."
22507 (interactive "sOrg-files matching: ")
22508 (let* ((files (org-agenda-files))
22509 (tnames (mapcar #'file-truename files))
22510 (extra org-agenda-text-search-extra-files))
22511 (when (eq (car extra) 'agenda-archives)
22512 (setq extra (cdr extra))
22513 (setq files (org-add-archive-files files)))
22514 (dolist (f extra)
22515 (unless (member (file-truename f) tnames)
22516 (unless (member f files) (setq files (append files (list f))))
22517 (setq tnames (append tnames (list (file-truename f))))))
22518 (multi-occur
22519 (mapcar (lambda (x)
22520 (with-current-buffer
22521 ;; FIXME: Why not just (find-file-noselect x)?
22522 ;; Is it to avoid the "revert buffer" prompt?
22523 (or (get-file-buffer x) (find-file-noselect x))
22524 (widen)
22525 (current-buffer)))
22526 files)
22527 regexp)))
22529 (add-hook 'occur-mode-find-occurrence-hook
22530 (lambda () (when (derived-mode-p 'org-mode) (org-reveal))))
22532 (defun org-occur-link-in-agenda-files ()
22533 "Create a link and search for it in the agendas.
22534 The link is not stored in `org-stored-links', it is just created
22535 for the search purpose."
22536 (interactive)
22537 (let ((link (condition-case nil
22538 (org-store-link nil)
22539 (error "Unable to create a link to here"))))
22540 (org-occur-in-agenda-files (regexp-quote link))))
22542 (defun org-reverse-string (string)
22543 "Return the reverse of STRING."
22544 (apply 'string (reverse (string-to-list string))))
22546 ;; defsubst org-uniquify must be defined before first use
22548 (defun org-uniquify-alist (alist)
22549 "Merge elements of ALIST with the same key.
22551 For example, in this alist:
22553 \(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
22554 => \\='((a 1 3) (b 2))
22556 merge (a 1) and (a 3) into (a 1 3).
22558 The function returns the new ALIST."
22559 (let (rtn)
22560 (dolist (e alist rtn)
22561 (let (n)
22562 (if (not (assoc (car e) rtn))
22563 (push e rtn)
22564 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22565 (setq rtn (assq-delete-all (car e) rtn))
22566 (push n rtn))))))
22568 (defun org-delete-all (elts list)
22569 "Remove all elements in ELTS from LIST.
22570 Comparison is done with `equal'. It is a destructive operation
22571 that may remove elements by altering the list structure."
22572 (while elts
22573 (setq list (delete (pop elts) list)))
22574 list)
22576 (defun org-back-over-empty-lines ()
22577 "Move backwards over whitespace, to the beginning of the first empty line.
22578 Returns the number of empty lines passed."
22579 (let ((pos (point)))
22580 (if (cdr (assq 'heading org-blank-before-new-entry))
22581 (skip-chars-backward " \t\n\r")
22582 (unless (eobp)
22583 (forward-line -1)))
22584 (beginning-of-line 2)
22585 (goto-char (min (point) pos))
22586 (count-lines (point) pos)))
22588 (defun org-skip-whitespace ()
22589 (skip-chars-forward " \t\n\r"))
22591 (defun org-point-in-group (point group &optional context)
22592 "Check if POINT is in match-group GROUP.
22593 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22594 match. If the match group does not exist or point is not inside it,
22595 return nil."
22596 (and (match-beginning group)
22597 (>= point (match-beginning group))
22598 (<= point (match-end group))
22599 (if context
22600 (list context (match-beginning group) (match-end group))
22601 t)))
22603 (defun org-switch-to-buffer-other-window (&rest args)
22604 "Switch to buffer in a second window on the current frame.
22605 In particular, do not allow pop-up frames.
22606 Returns the newly created buffer."
22607 (org-no-popups
22608 (apply 'switch-to-buffer-other-window args)))
22610 (defun org-combine-plists (&rest plists)
22611 "Create a single property list from all plists in PLISTS.
22612 The process starts by copying the first list, and then setting properties
22613 from the other lists. Settings in the last list are the most significant
22614 ones and overrule settings in the other lists."
22615 (let ((rtn (copy-sequence (pop plists)))
22616 p v ls)
22617 (while plists
22618 (setq ls (pop plists))
22619 (while ls
22620 (setq p (pop ls) v (pop ls))
22621 (setq rtn (plist-put rtn p v))))
22622 rtn))
22624 (defun org-replace-escapes (string table)
22625 "Replace %-escapes in STRING with values in TABLE.
22626 TABLE is an association list with keys like \"%a\" and string values.
22627 The sequences in STRING may contain normal field width and padding information,
22628 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22629 so values can contain further %-escapes if they are define later in TABLE."
22630 (let ((tbl (copy-alist table))
22631 (case-fold-search nil)
22632 (pchg 0)
22633 re rpl)
22634 (dolist (e tbl)
22635 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22636 (when (and (cdr e) (string-match re (cdr e)))
22637 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22638 (safe "SREF"))
22639 (add-text-properties 0 3 (list 'sref sref) safe)
22640 (setcdr e (replace-match safe t t (cdr e)))))
22641 (while (string-match re string)
22642 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22643 (cdr e)))
22644 (setq string (replace-match rpl t t string))))
22645 (while (setq pchg (next-property-change pchg string))
22646 (let ((sref (get-text-property pchg 'sref string)))
22647 (when (and sref (string-match "SREF" string pchg))
22648 (setq string (replace-match sref t t string)))))
22649 string))
22651 (defun org-find-base-buffer-visiting (file)
22652 "Like `find-buffer-visiting' but always return the base buffer and
22653 not an indirect buffer."
22654 (let ((buf (or (get-file-buffer file)
22655 (find-buffer-visiting file))))
22656 (if buf
22657 (or (buffer-base-buffer buf) buf)
22658 nil)))
22660 ;;; TODO: Only called once, from ox-odt which should probably use
22661 ;;; org-export-inline-image-p or something.
22662 (defun org-file-image-p (file)
22663 "Return non-nil if FILE is an image."
22664 (save-match-data
22665 (string-match (image-file-name-regexp) file)))
22667 (defun org-get-cursor-date (&optional with-time)
22668 "Return the date at cursor in as a time.
22669 This works in the calendar and in the agenda, anywhere else it just
22670 returns the current time.
22671 If WITH-TIME is non-nil, returns the time of the event at point (in
22672 the agenda) or the current time of the day."
22673 (let (date day defd tp hod mod)
22674 (when with-time
22675 (setq tp (get-text-property (point) 'time))
22676 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22677 (setq hod (string-to-number (match-string 1 tp))
22678 mod (string-to-number (match-string 2 tp))))
22679 (or tp (let ((now (decode-time)))
22680 (setq hod (nth 2 now)
22681 mod (nth 1 now)))))
22682 (cond
22683 ((eq major-mode 'calendar-mode)
22684 (setq date (calendar-cursor-to-date)
22685 defd (encode-time 0 (or mod 0) (or hod 0)
22686 (nth 1 date) (nth 0 date) (nth 2 date))))
22687 ((eq major-mode 'org-agenda-mode)
22688 (setq day (get-text-property (point) 'day))
22689 (when day
22690 (setq date (calendar-gregorian-from-absolute day)
22691 defd (encode-time 0 (or mod 0) (or hod 0)
22692 (nth 1 date) (nth 0 date) (nth 2 date))))))
22693 (or defd (current-time))))
22695 (defun org-mark-subtree (&optional up)
22696 "Mark the current subtree.
22697 This puts point at the start of the current subtree, and mark at
22698 the end. If a numeric prefix UP is given, move up into the
22699 hierarchy of headlines by UP levels before marking the subtree."
22700 (interactive "P")
22701 (org-with-limited-levels
22702 (cond ((org-at-heading-p) (beginning-of-line))
22703 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22704 (t (outline-previous-visible-heading 1))))
22705 (when up (while (and (> up 0) (org-up-heading-safe)) (cl-decf up)))
22706 (if (called-interactively-p 'any)
22707 (call-interactively 'org-mark-element)
22708 (org-mark-element)))
22710 (defun org-file-newer-than-p (file time)
22711 "Non-nil if FILE is newer than TIME.
22712 FILE is a filename, as a string, TIME is a list of integers, as
22713 returned by, e.g., `current-time'."
22714 (and (file-exists-p file)
22715 ;; Only compare times up to whole seconds as some file-systems
22716 ;; (e.g. HFS+) do not retain any finer granularity. As
22717 ;; a consequence, make sure we return non-nil when the two
22718 ;; times are equal.
22719 (not (time-less-p (cl-subseq (nth 5 (file-attributes file)) 0 2)
22720 (cl-subseq time 0 2)))))
22722 (defun org-compile-file (source process ext &optional err-msg log-buf spec)
22723 "Compile a SOURCE file using PROCESS.
22725 PROCESS is either a function or a list of shell commands, as
22726 strings. EXT is a file extension, without the leading dot, as
22727 a string. It is used to check if the process actually succeeded.
22729 PROCESS must create a file with the same base name and directory
22730 as SOURCE, but ending with EXT. The function then returns its
22731 filename. Otherwise, it raises an error. The error message can
22732 then be refined by providing string ERR-MSG, which is appended to
22733 the standard message.
22735 If PROCESS is a function, it is called with a single argument:
22736 the SOURCE file.
22738 If it is a list of commands, each of them is called using
22739 `shell-command'. By default, in each command, %b, %f, %F, %o and
22740 %O are replaced with, respectively, SOURCE base name, name, full
22741 name, directory and absolute output file name. It is possible,
22742 however, to use more place-holders by specifying them in optional
22743 argument SPEC, as an alist following the pattern
22745 (CHARACTER . REPLACEMENT-STRING).
22747 When PROCESS is a list of commands, optional argument LOG-BUF can
22748 be set to a buffer or a buffer name. `shell-command' then uses
22749 it for output."
22750 (let* ((base-name (file-name-base source))
22751 (full-name (file-truename source))
22752 (out-dir (or (file-name-directory source) "./"))
22753 (output (expand-file-name (concat base-name "." ext) out-dir))
22754 (time (current-time))
22755 (err-msg (if (stringp err-msg) (concat ". " err-msg) "")))
22756 (save-window-excursion
22757 (pcase process
22758 ((pred functionp) (funcall process (shell-quote-argument source)))
22759 ((pred consp)
22760 (let ((log-buf (and log-buf (get-buffer-create log-buf)))
22761 (spec (append spec
22762 `((?b . ,(shell-quote-argument base-name))
22763 (?f . ,(shell-quote-argument source))
22764 (?F . ,(shell-quote-argument full-name))
22765 (?o . ,(shell-quote-argument out-dir))
22766 (?O . ,(shell-quote-argument output))))))
22767 (dolist (command process)
22768 (shell-command (format-spec command spec) log-buf))))
22769 (_ (error "No valid command to process %S%s" source err-msg))))
22770 ;; Check for process failure. Output file is expected to be
22771 ;; located in the same directory as SOURCE.
22772 (unless (org-file-newer-than-p output time)
22773 (error (format "File %S wasn't produced%s" output err-msg)))
22774 output))
22776 ;;; Indentation
22778 (defun org--get-expected-indentation (element contentsp)
22779 "Expected indentation column for current line, according to ELEMENT.
22780 ELEMENT is an element containing point. CONTENTSP is non-nil
22781 when indentation is to be computed according to contents of
22782 ELEMENT."
22783 (let ((type (org-element-type element))
22784 (start (org-element-property :begin element))
22785 (post-affiliated (org-element-property :post-affiliated element)))
22786 (org-with-wide-buffer
22787 (cond
22788 (contentsp
22789 (cl-case type
22790 ((diary-sexp footnote-definition) 0)
22791 ((headline inlinetask nil)
22792 (if (not org-adapt-indentation) 0
22793 (let ((level (org-current-level)))
22794 (if level (1+ level) 0))))
22795 ((item plain-list) (org-list-item-body-column post-affiliated))
22797 (goto-char start)
22798 (org-get-indentation))))
22799 ((memq type '(headline inlinetask nil))
22800 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22801 (org--get-expected-indentation element t)
22803 ((memq type '(diary-sexp footnote-definition)) 0)
22804 ;; First paragraph of a footnote definition or an item.
22805 ;; Indent like parent.
22806 ((< (line-beginning-position) start)
22807 (org--get-expected-indentation
22808 (org-element-property :parent element) t))
22809 ;; At first line: indent according to previous sibling, if any,
22810 ;; ignoring footnote definitions and inline tasks, or parent's
22811 ;; contents.
22812 ((= (line-beginning-position) start)
22813 (catch 'exit
22814 (while t
22815 (if (= (point-min) start) (throw 'exit 0)
22816 (goto-char (1- start))
22817 (let* ((previous (org-element-at-point))
22818 (parent previous))
22819 (while (and parent (<= (org-element-property :end parent) start))
22820 (setq previous parent
22821 parent (org-element-property :parent parent)))
22822 (cond
22823 ((not previous) (throw 'exit 0))
22824 ((> (org-element-property :end previous) start)
22825 (throw 'exit (org--get-expected-indentation previous t)))
22826 ((memq (org-element-type previous)
22827 '(footnote-definition inlinetask))
22828 (setq start (org-element-property :begin previous)))
22829 (t (goto-char (org-element-property :begin previous))
22830 (throw 'exit
22831 (if (bolp) (org-get-indentation)
22832 ;; At first paragraph in an item or
22833 ;; a footnote definition.
22834 (org--get-expected-indentation
22835 (org-element-property :parent previous) t))))))))))
22836 ;; Otherwise, move to the first non-blank line above.
22838 (beginning-of-line)
22839 (let ((pos (point)))
22840 (skip-chars-backward " \r\t\n")
22841 (cond
22842 ;; Two blank lines end a footnote definition or a plain
22843 ;; list. When we indent an empty line after them, the
22844 ;; containing list or footnote definition is over, so it
22845 ;; qualifies as a previous sibling. Therefore, we indent
22846 ;; like its first line.
22847 ((and (memq type '(footnote-definition plain-list))
22848 (> (count-lines (point) pos) 2))
22849 (goto-char start)
22850 (org-get-indentation))
22851 ;; Line above is the first one of a paragraph at the
22852 ;; beginning of an item or a footnote definition. Indent
22853 ;; like parent.
22854 ((< (line-beginning-position) start)
22855 (org--get-expected-indentation
22856 (org-element-property :parent element) t))
22857 ;; Line above is the beginning of an element, i.e., point
22858 ;; was originally on the blank lines between element's start
22859 ;; and contents.
22860 ((= (line-beginning-position) post-affiliated)
22861 (org--get-expected-indentation element t))
22862 ;; POS is after contents in a greater element. Indent like
22863 ;; the beginning of the element.
22865 ;; As a special case, if point is at the end of a footnote
22866 ;; definition or an item, indent like the very last element
22867 ;; within. If that last element is an item, indent like its
22868 ;; contents.
22869 ((and (not (eq type 'paragraph))
22870 (let ((cend (org-element-property :contents-end element)))
22871 (and cend (<= cend pos))))
22872 (if (memq type '(footnote-definition item plain-list))
22873 (let ((last (org-element-at-point)))
22874 (org--get-expected-indentation
22875 last (eq (org-element-type last) 'item)))
22876 (goto-char start)
22877 (org-get-indentation)))
22878 ;; In any other case, indent like the current line.
22879 (t (org-get-indentation)))))))))
22881 (defun org--align-node-property ()
22882 "Align node property at point.
22883 Alignment is done according to `org-property-format', which see."
22884 (when (save-excursion
22885 (beginning-of-line)
22886 (looking-at org-property-re))
22887 (replace-match
22888 (concat (match-string 4)
22889 (org-trim
22890 (format org-property-format (match-string 1) (match-string 3))))
22891 t t)))
22893 (defun org-indent-line ()
22894 "Indent line depending on context.
22896 Indentation is done according to the following rules:
22898 - Footnote definitions, diary sexps, headlines and inline tasks
22899 have to start at column 0.
22901 - On the very first line of an element, consider, in order, the
22902 next rules until one matches:
22904 1. If there's a sibling element before, ignoring footnote
22905 definitions and inline tasks, indent like its first line.
22907 2. If element has a parent, indent like its contents. More
22908 precisely, if parent is an item, indent after the
22909 description part, if any, or the bullet (see
22910 `org-list-description-max-indent'). Else, indent like
22911 parent's first line.
22913 3. Otherwise, indent relatively to current level, if
22914 `org-adapt-indentation' is non-nil, or to left margin.
22916 - On a blank line at the end of an element, indent according to
22917 the type of the element. More precisely
22919 1. If element is a plain list, an item, or a footnote
22920 definition, indent like the very last element within.
22922 2. If element is a paragraph, indent like its last non blank
22923 line.
22925 3. Otherwise, indent like its very first line.
22927 - In the code part of a source block, use language major mode
22928 to indent current line if `org-src-tab-acts-natively' is
22929 non-nil. If it is nil, do nothing.
22931 - Otherwise, indent like the first non-blank line above.
22933 The function doesn't indent an item as it could break the whole
22934 list structure. Instead, use \\<org-mode-map>`\\[org-shiftmetaleft]' or \
22935 `\\[org-shiftmetaright]'.
22937 Also align node properties according to `org-property-format'."
22938 (interactive)
22939 (cond
22940 (orgstruct-is-++
22941 (let ((indent-line-function
22942 (cl-cadadr (assq 'indent-line-function org-fb-vars))))
22943 (indent-according-to-mode)))
22944 ((org-at-heading-p) 'noindent)
22946 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22947 (type (org-element-type element)))
22948 (cond ((and (memq type '(plain-list item))
22949 (= (line-beginning-position)
22950 (org-element-property :post-affiliated element)))
22951 'noindent)
22952 ((and (eq type 'src-block)
22953 org-src-tab-acts-natively
22954 (> (line-beginning-position)
22955 (org-element-property :post-affiliated element))
22956 (< (line-beginning-position)
22957 (org-with-wide-buffer
22958 (goto-char (org-element-property :end element))
22959 (skip-chars-backward " \r\t\n")
22960 (line-beginning-position))))
22961 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22963 (let ((column (org--get-expected-indentation element nil)))
22964 ;; Preserve current column.
22965 (if (<= (current-column) (current-indentation))
22966 (indent-line-to column)
22967 (save-excursion (indent-line-to column))))
22968 ;; Align node property. Also preserve current column.
22969 (when (eq type 'node-property)
22970 (let ((column (current-column)))
22971 (org--align-node-property)
22972 (org-move-to-column column)))))))))
22974 (defun org-indent-region (start end)
22975 "Indent each non-blank line in the region.
22976 Called from a program, START and END specify the region to
22977 indent. The function will not indent contents of example blocks,
22978 verse blocks and export blocks as leading white spaces are
22979 assumed to be significant there."
22980 (interactive "r")
22981 (save-excursion
22982 (goto-char start)
22983 (skip-chars-forward " \r\t\n")
22984 (unless (eobp) (beginning-of-line))
22985 (let ((indent-to
22986 (lambda (ind pos)
22987 ;; Set IND as indentation for all lines between point and
22988 ;; POS. Blank lines are ignored. Leave point after POS
22989 ;; once done.
22990 (let ((limit (copy-marker pos)))
22991 (while (< (point) limit)
22992 (unless (looking-at-p "[ \t]*$") (indent-line-to ind))
22993 (forward-line))
22994 (set-marker limit nil))))
22995 (end (copy-marker end)))
22996 (while (< (point) end)
22997 (if (or (looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22998 (let* ((element (org-element-at-point))
22999 (type (org-element-type element))
23000 (element-end (copy-marker (org-element-property :end element)))
23001 (ind (org--get-expected-indentation element nil)))
23002 (cond
23003 ((or (memq type '(paragraph table table-row))
23004 (not (or (org-element-property :contents-begin element)
23005 (memq type
23006 '(example-block export-block src-block)))))
23007 ;; Elements here are indented as a single block. Also
23008 ;; align node properties.
23009 (when (eq type 'node-property)
23010 (org--align-node-property)
23011 (beginning-of-line))
23012 (funcall indent-to ind (min element-end end)))
23014 ;; Elements in this category consist of three parts:
23015 ;; before the contents, the contents, and after the
23016 ;; contents. The contents are treated specially,
23017 ;; according to the element type, or not indented at
23018 ;; all. Other parts are indented as a single block.
23019 (let* ((post (copy-marker
23020 (org-element-property :post-affiliated element)))
23021 (cbeg
23022 (copy-marker
23023 (cond
23024 ((not (org-element-property :contents-begin element))
23025 ;; Fake contents for source blocks.
23026 (org-with-wide-buffer
23027 (goto-char post)
23028 (forward-line)
23029 (point)))
23030 ((memq type '(footnote-definition item plain-list))
23031 ;; Contents in these elements could start on
23032 ;; the same line as the beginning of the
23033 ;; element. Make sure we start indenting
23034 ;; from the second line.
23035 (org-with-wide-buffer
23036 (goto-char post)
23037 (end-of-line)
23038 (skip-chars-forward " \r\t\n")
23039 (if (eobp) (point) (line-beginning-position))))
23040 (t (org-element-property :contents-begin element)))))
23041 (cend (copy-marker
23042 (or (org-element-property :contents-end element)
23043 ;; Fake contents for source blocks.
23044 (org-with-wide-buffer
23045 (goto-char element-end)
23046 (skip-chars-backward " \r\t\n")
23047 (line-beginning-position)))
23048 t)))
23049 ;; Do not change items indentation individually as it
23050 ;; might break the list as a whole. On the other
23051 ;; hand, when at a plain list, indent it as a whole.
23052 (cond ((eq type 'plain-list)
23053 (let ((offset (- ind (org-get-indentation))))
23054 (unless (zerop offset)
23055 (indent-rigidly (org-element-property :begin element)
23056 (org-element-property :end element)
23057 offset))
23058 (goto-char cbeg)))
23059 ((eq type 'item) (goto-char cbeg))
23060 (t (funcall indent-to ind (min cbeg end))))
23061 (when (< (point) end)
23062 (cl-case type
23063 ((example-block export-block verse-block))
23064 (src-block
23065 ;; In a source block, indent source code
23066 ;; according to language major mode, but only if
23067 ;; `org-src-tab-acts-natively' is non-nil.
23068 (when (and (< (point) end) org-src-tab-acts-natively)
23069 (ignore-errors
23070 (org-babel-do-in-edit-buffer
23071 (indent-region (point-min) (point-max))))))
23072 (t (org-indent-region (point) (min cend end))))
23073 (goto-char (min cend end))
23074 (when (< (point) end)
23075 (funcall indent-to ind (min element-end end))))
23076 (set-marker post nil)
23077 (set-marker cbeg nil)
23078 (set-marker cend nil))))
23079 (set-marker element-end nil))))
23080 (set-marker end nil))))
23082 (defun org-indent-drawer ()
23083 "Indent the drawer at point."
23084 (interactive)
23085 (unless (save-excursion
23086 (beginning-of-line)
23087 (looking-at-p org-drawer-regexp))
23088 (user-error "Not at a drawer"))
23089 (let ((element (org-element-at-point)))
23090 (unless (memq (org-element-type element) '(drawer property-drawer))
23091 (user-error "Not at a drawer"))
23092 (org-with-wide-buffer
23093 (org-indent-region (org-element-property :begin element)
23094 (org-element-property :end element))))
23095 (message "Drawer at point indented"))
23097 (defun org-indent-block ()
23098 "Indent the block at point."
23099 (interactive)
23100 (unless (save-excursion
23101 (beginning-of-line)
23102 (let ((case-fold-search t))
23103 (looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23104 (user-error "Not at a block"))
23105 (let ((element (org-element-at-point)))
23106 (unless (memq (org-element-type element)
23107 '(comment-block center-block dynamic-block example-block
23108 export-block quote-block special-block
23109 src-block verse-block))
23110 (user-error "Not at a block"))
23111 (org-with-wide-buffer
23112 (org-indent-region (org-element-property :begin element)
23113 (org-element-property :end element))))
23114 (message "Block at point indented"))
23117 ;;; Filling
23119 ;; We use our own fill-paragraph and auto-fill functions.
23121 ;; `org-fill-paragraph' relies on adaptive filling and context
23122 ;; checking. Appropriate `fill-prefix' is computed with
23123 ;; `org-adaptive-fill-function'.
23125 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23126 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23127 ;; `org-adaptive-fill-function' value. Internally,
23128 ;; `org-comment-line-break-function' breaks the line.
23130 ;; `org-setup-filling' installs filling and auto-filling related
23131 ;; variables during `org-mode' initialization.
23133 (defvar org-element-paragraph-separate) ; org-element.el
23134 (defun org-setup-filling ()
23135 (require 'org-element)
23136 ;; Prevent auto-fill from inserting unwanted new items.
23137 (when (boundp 'fill-nobreak-predicate)
23138 (setq-local
23139 fill-nobreak-predicate
23140 (org-uniquify
23141 (append fill-nobreak-predicate
23142 '(org-fill-line-break-nobreak-p
23143 org-fill-paragraph-with-timestamp-nobreak-p)))))
23144 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23145 (setq-local paragraph-start paragraph-ending)
23146 (setq-local paragraph-separate paragraph-ending))
23147 (setq-local fill-paragraph-function 'org-fill-paragraph)
23148 (setq-local auto-fill-inhibit-regexp nil)
23149 (setq-local adaptive-fill-function 'org-adaptive-fill-function)
23150 (setq-local normal-auto-fill-function 'org-auto-fill-function)
23151 (setq-local comment-line-break-function 'org-comment-line-break-function))
23153 (defun org-fill-line-break-nobreak-p ()
23154 "Non-nil when a new line at point would create an Org line break."
23155 (save-excursion
23156 (skip-chars-backward "[ \t]")
23157 (skip-chars-backward "\\\\")
23158 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23160 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23161 "Non-nil when a new line at point would split a timestamp."
23162 (and (org-at-timestamp-p t)
23163 (not (looking-at org-ts-regexp-both))))
23165 (declare-function message-in-body-p "message" ())
23166 (defvar orgtbl-line-start-regexp) ; From org-table.el
23167 (defun org-adaptive-fill-function ()
23168 "Compute a fill prefix for the current line.
23169 Return fill prefix, as a string, or nil if current line isn't
23170 meant to be filled. For convenience, if `adaptive-fill-regexp'
23171 matches in paragraphs or comments, use it."
23172 (catch 'exit
23173 (when (derived-mode-p 'message-mode)
23174 (save-excursion
23175 (beginning-of-line)
23176 (cond ((not (message-in-body-p)) (throw 'exit nil))
23177 ((looking-at-p org-table-line-regexp) (throw 'exit nil))
23178 ((looking-at message-cite-prefix-regexp)
23179 (throw 'exit (match-string-no-properties 0)))
23180 ((looking-at org-outline-regexp)
23181 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23182 (org-with-wide-buffer
23183 (unless (org-at-heading-p)
23184 (let* ((p (line-beginning-position))
23185 (element (save-excursion
23186 (beginning-of-line)
23187 (org-element-at-point)))
23188 (type (org-element-type element))
23189 (post-affiliated (org-element-property :post-affiliated element)))
23190 (unless (< p post-affiliated)
23191 (cl-case type
23192 (comment
23193 (save-excursion
23194 (beginning-of-line)
23195 (looking-at "[ \t]*")
23196 (concat (match-string 0) "# ")))
23197 (footnote-definition "")
23198 ((item plain-list)
23199 (make-string (org-list-item-body-column post-affiliated) ?\s))
23200 (paragraph
23201 ;; Fill prefix is usually the same as the current line,
23202 ;; unless the paragraph is at the beginning of an item.
23203 (let ((parent (org-element-property :parent element)))
23204 (save-excursion
23205 (beginning-of-line)
23206 (cond ((eq (org-element-type parent) 'item)
23207 (make-string (org-list-item-body-column
23208 (org-element-property :begin parent))
23209 ?\s))
23210 ((and adaptive-fill-regexp
23211 ;; Locally disable
23212 ;; `adaptive-fill-function' to let
23213 ;; `fill-context-prefix' handle
23214 ;; `adaptive-fill-regexp' variable.
23215 (let (adaptive-fill-function)
23216 (fill-context-prefix
23217 post-affiliated
23218 (org-element-property :end element)))))
23219 ((looking-at "[ \t]+") (match-string 0))
23220 (t "")))))
23221 (comment-block
23222 ;; Only fill contents if P is within block boundaries.
23223 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23224 (forward-line)
23225 (point)))
23226 (cend (save-excursion
23227 (goto-char (org-element-property :end element))
23228 (skip-chars-backward " \r\t\n")
23229 (line-beginning-position))))
23230 (when (and (>= p cbeg) (< p cend))
23231 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23232 (match-string 0)
23233 "")))))))))))
23235 (declare-function message-goto-body "message" ())
23236 (defvar message-cite-prefix-regexp) ; From message.el
23237 (defun org-fill-paragraph (&optional justify)
23238 "Fill element at point, when applicable.
23240 This function only applies to comment blocks, comments, example
23241 blocks and paragraphs. Also, as a special case, re-align table
23242 when point is at one.
23244 If JUSTIFY is non-nil (interactively, with prefix argument),
23245 justify as well. If `sentence-end-double-space' is non-nil, then
23246 period followed by one space does not end a sentence, so don't
23247 break a line there. The variable `fill-column' controls the
23248 width for filling.
23250 For convenience, when point is at a plain list, an item or
23251 a footnote definition, try to fill the first paragraph within."
23252 (interactive)
23253 (if (and (derived-mode-p 'message-mode)
23254 (or (not (message-in-body-p))
23255 (save-excursion (move-beginning-of-line 1)
23256 (looking-at message-cite-prefix-regexp))))
23257 ;; First ensure filling is correct in message-mode.
23258 (let ((fill-paragraph-function
23259 (cl-cadadr (assq 'fill-paragraph-function org-fb-vars)))
23260 (fill-prefix (cl-cadadr (assq 'fill-prefix org-fb-vars)))
23261 (paragraph-start (cl-cadadr (assq 'paragraph-start org-fb-vars)))
23262 (paragraph-separate
23263 (cl-cadadr (assq 'paragraph-separate org-fb-vars))))
23264 (fill-paragraph nil))
23265 (with-syntax-table org-mode-transpose-word-syntax-table
23266 ;; Move to end of line in order to get the first paragraph
23267 ;; within a plain list or a footnote definition.
23268 (let ((element (save-excursion
23269 (end-of-line)
23270 (or (ignore-errors (org-element-at-point))
23271 (user-error "An element cannot be parsed line %d"
23272 (line-number-at-pos (point)))))))
23273 ;; First check if point is in a blank line at the beginning of
23274 ;; the buffer. In that case, ignore filling.
23275 (cl-case (org-element-type element)
23276 ;; Use major mode filling function is src blocks.
23277 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23278 ;; Align Org tables, leave table.el tables as-is.
23279 (table-row (org-table-align) t)
23280 (table
23281 (when (eq (org-element-property :type element) 'org)
23282 (save-excursion
23283 (goto-char (org-element-property :post-affiliated element))
23284 (org-table-align)))
23286 (paragraph
23287 ;; Paragraphs may contain `line-break' type objects.
23288 (let ((beg (max (point-min)
23289 (org-element-property :contents-begin element)))
23290 (end (min (point-max)
23291 (org-element-property :contents-end element))))
23292 ;; Do nothing if point is at an affiliated keyword.
23293 (if (< (line-end-position) beg) t
23294 (when (derived-mode-p 'message-mode)
23295 ;; In `message-mode', do not fill following citation
23296 ;; in current paragraph nor text before message body.
23297 (let ((body-start (save-excursion (message-goto-body))))
23298 (when body-start (setq beg (max body-start beg))))
23299 (when (save-excursion
23300 (re-search-forward
23301 (concat "^" message-cite-prefix-regexp) end t))
23302 (setq end (match-beginning 0))))
23303 ;; Fill paragraph, taking line breaks into account.
23304 (save-excursion
23305 (goto-char beg)
23306 (let ((cuts (list beg)))
23307 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23308 (when (eq 'line-break
23309 (org-element-type
23310 (save-excursion (backward-char)
23311 (org-element-context))))
23312 (push (point) cuts)))
23313 (dolist (c (delq end cuts))
23314 (fill-region-as-paragraph c end justify)
23315 (setq end c))))
23316 t)))
23317 ;; Contents of `comment-block' type elements should be
23318 ;; filled as plain text, but only if point is within block
23319 ;; markers.
23320 (comment-block
23321 (let* ((case-fold-search t)
23322 (beg (save-excursion
23323 (goto-char (org-element-property :begin element))
23324 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23325 (forward-line)
23326 (point)))
23327 (end (save-excursion
23328 (goto-char (org-element-property :end element))
23329 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23330 (line-beginning-position))))
23331 (if (or (< (point) beg) (> (point) end)) t
23332 (fill-region-as-paragraph
23333 (save-excursion (end-of-line)
23334 (re-search-backward "^[ \t]*$" beg 'move)
23335 (line-beginning-position))
23336 (save-excursion (beginning-of-line)
23337 (re-search-forward "^[ \t]*$" end 'move)
23338 (line-beginning-position))
23339 justify))))
23340 ;; Fill comments.
23341 (comment
23342 (let ((begin (org-element-property :post-affiliated element))
23343 (end (org-element-property :end element)))
23344 (when (and (>= (point) begin) (<= (point) end))
23345 (let ((begin (save-excursion
23346 (end-of-line)
23347 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23348 (progn (forward-line) (point))
23349 begin)))
23350 (end (save-excursion
23351 (end-of-line)
23352 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23353 (1- (line-beginning-position))
23354 (skip-chars-backward " \r\t\n")
23355 (line-end-position)))))
23356 ;; Do not fill comments when at a blank line.
23357 (when (> end begin)
23358 (let ((fill-prefix
23359 (save-excursion
23360 (beginning-of-line)
23361 (looking-at "[ \t]*#")
23362 (let ((comment-prefix (match-string 0)))
23363 (goto-char (match-end 0))
23364 (if (looking-at adaptive-fill-regexp)
23365 (concat comment-prefix (match-string 0))
23366 (concat comment-prefix " "))))))
23367 (save-excursion
23368 (fill-region-as-paragraph begin end justify))))))
23370 ;; Ignore every other element.
23371 (otherwise t))))))
23373 (defun org-auto-fill-function ()
23374 "Auto-fill function."
23375 ;; Check if auto-filling is meaningful.
23376 (let ((fc (current-fill-column)))
23377 (when (and fc (> (current-column) fc))
23378 (let* ((fill-prefix (org-adaptive-fill-function))
23379 ;; Enforce empty fill prefix, if required. Otherwise, it
23380 ;; will be computed again.
23381 (adaptive-fill-mode (not (equal fill-prefix ""))))
23382 (when fill-prefix (do-auto-fill))))))
23384 (defun org-comment-line-break-function (&optional soft)
23385 "Break line at point and indent, continuing comment if within one.
23386 The inserted newline is marked hard if variable
23387 `use-hard-newlines' is true, unless optional argument SOFT is
23388 non-nil."
23389 (if soft (insert-and-inherit ?\n) (newline 1))
23390 (save-excursion (forward-char -1) (delete-horizontal-space))
23391 (delete-horizontal-space)
23392 (indent-to-left-margin)
23393 (insert-before-markers-and-inherit fill-prefix))
23396 ;;; Fixed Width Areas
23398 (defun org-toggle-fixed-width ()
23399 "Toggle fixed-width markup.
23401 Add or remove fixed-width markup on current line, whenever it
23402 makes sense. Return an error otherwise.
23404 If a region is active and if it contains only fixed-width areas
23405 or blank lines, remove all fixed-width markup in it. If the
23406 region contains anything else, convert all non-fixed-width lines
23407 to fixed-width ones.
23409 Blank lines at the end of the region are ignored unless the
23410 region only contains such lines."
23411 (interactive)
23412 (if (not (org-region-active-p))
23413 ;; No region:
23415 ;; Remove fixed width marker only in a fixed-with element.
23417 ;; Add fixed width maker in paragraphs, in blank lines after
23418 ;; elements or at the beginning of a headline or an inlinetask,
23419 ;; and before any one-line elements (e.g., a clock).
23420 (progn
23421 (beginning-of-line)
23422 (let* ((element (org-element-at-point))
23423 (type (org-element-type element)))
23424 (cond
23425 ((and (eq type 'fixed-width)
23426 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23427 (replace-match
23428 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23429 ((and (memq type '(babel-call clock comment diary-sexp headline
23430 horizontal-rule keyword paragraph
23431 planning))
23432 (<= (org-element-property :post-affiliated element) (point)))
23433 (skip-chars-forward " \t")
23434 (insert ": "))
23435 ((and (looking-at-p "[ \t]*$")
23436 (or (eq type 'inlinetask)
23437 (save-excursion
23438 (skip-chars-forward " \r\t\n")
23439 (<= (org-element-property :end element) (point)))))
23440 (delete-region (point) (line-end-position))
23441 (org-indent-line)
23442 (insert ": "))
23443 (t (user-error "Cannot insert a fixed-width line here")))))
23444 ;; Region active.
23445 (let* ((begin (save-excursion
23446 (goto-char (region-beginning))
23447 (line-beginning-position)))
23448 (end (copy-marker
23449 (save-excursion
23450 (goto-char (region-end))
23451 (unless (eolp) (beginning-of-line))
23452 (if (save-excursion (re-search-backward "\\S-" begin t))
23453 (progn (skip-chars-backward " \r\t\n") (point))
23454 (point)))))
23455 (all-fixed-width-p
23456 (catch 'not-all-p
23457 (save-excursion
23458 (goto-char begin)
23459 (skip-chars-forward " \r\t\n")
23460 (when (eobp) (throw 'not-all-p nil))
23461 (while (< (point) end)
23462 (let ((element (org-element-at-point)))
23463 (if (eq (org-element-type element) 'fixed-width)
23464 (goto-char (org-element-property :end element))
23465 (throw 'not-all-p nil))))
23466 t))))
23467 (if all-fixed-width-p
23468 (save-excursion
23469 (goto-char begin)
23470 (while (< (point) end)
23471 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23472 (replace-match
23473 "" nil nil nil
23474 (if (= (line-end-position) (match-end 0)) 0 1)))
23475 (forward-line)))
23476 (let ((min-ind (point-max)))
23477 ;; Find minimum indentation across all lines.
23478 (save-excursion
23479 (goto-char begin)
23480 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23481 (setq min-ind 0)
23482 (catch 'zerop
23483 (while (< (point) end)
23484 (unless (looking-at-p "[ \t]*$")
23485 (let ((ind (org-get-indentation)))
23486 (setq min-ind (min min-ind ind))
23487 (when (zerop ind) (throw 'zerop t))))
23488 (forward-line)))))
23489 ;; Loop over all lines and add fixed-width markup everywhere
23490 ;; but in fixed-width lines.
23491 (save-excursion
23492 (goto-char begin)
23493 (while (< (point) end)
23494 (cond
23495 ((org-at-heading-p)
23496 (insert ": ")
23497 (forward-line)
23498 (while (and (< (point) end) (looking-at-p "[ \t]*$"))
23499 (insert ":")
23500 (forward-line)))
23501 ((looking-at-p "[ \t]*:\\( \\|$\\)")
23502 (let* ((element (org-element-at-point))
23503 (element-end (org-element-property :end element)))
23504 (if (eq (org-element-type element) 'fixed-width)
23505 (progn (goto-char element-end)
23506 (skip-chars-backward " \r\t\n")
23507 (forward-line))
23508 (let ((limit (min end element-end)))
23509 (while (< (point) limit)
23510 (org-move-to-column min-ind t)
23511 (insert ": ")
23512 (forward-line))))))
23514 (org-move-to-column min-ind t)
23515 (insert ": ")
23516 (forward-line)))))))
23517 (set-marker end nil))))
23520 ;;; Comments
23522 ;; Org comments syntax is quite complex. It requires the entire line
23523 ;; to be just a comment. Also, even with the right syntax at the
23524 ;; beginning of line, some some elements (i.e. verse-block or
23525 ;; example-block) don't accept comments. Usual Emacs comment commands
23526 ;; cannot cope with those requirements. Therefore, Org replaces them.
23528 ;; Org still relies on `comment-dwim', but cannot trust
23529 ;; `comment-only-p'. So, `comment-region-function' and
23530 ;; `uncomment-region-function' both point
23531 ;; to`org-comment-or-uncomment-region'. Eventually,
23532 ;; `org-insert-comment' takes care of insertion of comments at the
23533 ;; beginning of line.
23535 ;; `org-setup-comments-handling' install comments related variables
23536 ;; during `org-mode' initialization.
23538 (defun org-setup-comments-handling ()
23539 (interactive)
23540 (setq-local comment-use-syntax nil)
23541 (setq-local comment-start "# ")
23542 (setq-local comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23543 (setq-local comment-insert-comment-function 'org-insert-comment)
23544 (setq-local comment-region-function 'org-comment-or-uncomment-region)
23545 (setq-local uncomment-region-function 'org-comment-or-uncomment-region))
23547 (defun org-insert-comment ()
23548 "Insert an empty comment above current line.
23549 If the line is empty, insert comment at its beginning. When
23550 point is within a source block, comment according to the related
23551 major mode."
23552 (if (let ((element (org-element-at-point)))
23553 (and (eq (org-element-type element) 'src-block)
23554 (< (save-excursion
23555 (goto-char (org-element-property :post-affiliated element))
23556 (line-end-position))
23557 (point))
23558 (> (save-excursion
23559 (goto-char (org-element-property :end element))
23560 (skip-chars-backward " \r\t\n")
23561 (line-beginning-position))
23562 (point))))
23563 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23564 (beginning-of-line)
23565 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23566 (open-line 1))
23567 (org-indent-line)
23568 (insert "# ")))
23570 (defvar comment-empty-lines) ; From newcomment.el.
23571 (defun org-comment-or-uncomment-region (beg end &rest _)
23572 "Comment or uncomment each non-blank line in the region.
23573 Uncomment each non-blank line between BEG and END if it only
23574 contains commented lines. Otherwise, comment them. If region is
23575 strictly within a source block, use appropriate comment syntax."
23576 (if (let ((element (org-element-at-point)))
23577 (and (eq (org-element-type element) 'src-block)
23578 (< (save-excursion
23579 (goto-char (org-element-property :post-affiliated element))
23580 (line-end-position))
23581 beg)
23582 (>= (save-excursion
23583 (goto-char (org-element-property :end element))
23584 (skip-chars-backward " \r\t\n")
23585 (line-beginning-position))
23586 end)))
23587 ;; Translate region boundaries for the Org buffer to the source
23588 ;; buffer.
23589 (let ((offset (- end beg)))
23590 (save-excursion
23591 (goto-char beg)
23592 (org-babel-do-in-edit-buffer
23593 (comment-or-uncomment-region (point) (+ offset (point))))))
23594 (save-restriction
23595 ;; Restrict region
23596 (narrow-to-region (save-excursion (goto-char beg)
23597 (skip-chars-forward " \r\t\n" end)
23598 (line-beginning-position))
23599 (save-excursion (goto-char end)
23600 (skip-chars-backward " \r\t\n" beg)
23601 (line-end-position)))
23602 (let ((uncommentp
23603 ;; UNCOMMENTP is non-nil when every non blank line between
23604 ;; BEG and END is a comment.
23605 (save-excursion
23606 (goto-char (point-min))
23607 (while (and (not (eobp))
23608 (let ((element (org-element-at-point)))
23609 (and (eq (org-element-type element) 'comment)
23610 (goto-char (min (point-max)
23611 (org-element-property
23612 :end element)))))))
23613 (eobp))))
23614 (if uncommentp
23615 ;; Only blank lines and comments in region: uncomment it.
23616 (save-excursion
23617 (goto-char (point-min))
23618 (while (not (eobp))
23619 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23620 (replace-match "" nil nil nil 1))
23621 (forward-line)))
23622 ;; Comment each line in region.
23623 (let ((min-indent (point-max)))
23624 ;; First find the minimum indentation across all lines.
23625 (save-excursion
23626 (goto-char (point-min))
23627 (while (and (not (eobp)) (not (zerop min-indent)))
23628 (unless (looking-at "[ \t]*$")
23629 (setq min-indent (min min-indent (current-indentation))))
23630 (forward-line)))
23631 ;; Then loop over all lines.
23632 (save-excursion
23633 (goto-char (point-min))
23634 (while (not (eobp))
23635 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23636 ;; Don't get fooled by invisible text (e.g. link path)
23637 ;; when moving to column MIN-INDENT.
23638 (let ((buffer-invisibility-spec nil))
23639 (org-move-to-column min-indent t))
23640 (insert comment-start))
23641 (forward-line)))))))))
23643 (defun org-comment-dwim (_arg)
23644 "Call `comment-dwim' within a source edit buffer if needed."
23645 (interactive "*P")
23646 (if (org-in-src-block-p)
23647 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23648 (call-interactively 'comment-dwim)))
23651 ;;; Timestamps API
23653 ;; This section contains tools to operate on timestamp objects, as
23654 ;; returned by, e.g. `org-element-context'.
23656 (defun org-timestamp--to-internal-time (timestamp &optional end)
23657 "Encode TIMESTAMP object into Emacs internal time.
23658 Use end of date range or time range when END is non-nil."
23659 (apply #'encode-time
23660 (cons 0
23661 (mapcar
23662 (lambda (prop) (or (org-element-property prop timestamp) 0))
23663 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23664 '(:minute-start :hour-start :day-start :month-start
23665 :year-start))))))
23667 (defun org-timestamp-has-time-p (timestamp)
23668 "Non-nil when TIMESTAMP has a time specified."
23669 (org-element-property :hour-start timestamp))
23671 (defun org-timestamp-format (timestamp format &optional end utc)
23672 "Format a TIMESTAMP object into a string.
23674 FORMAT is a format specifier to be passed to
23675 `format-time-string'.
23677 When optional argument END is non-nil, use end of date-range or
23678 time-range, if possible.
23680 When optional argument UTC is non-nil, time will be expressed as
23681 Universal Time."
23682 (format-time-string
23683 format (org-timestamp--to-internal-time timestamp end)
23684 (and utc t)))
23686 (defun org-timestamp-split-range (timestamp &optional end)
23687 "Extract a TIMESTAMP object from a date or time range.
23689 END, when non-nil, means extract the end of the range.
23690 Otherwise, extract its start.
23692 Return a new timestamp object."
23693 (let ((type (org-element-property :type timestamp)))
23694 (if (memq type '(active inactive diary)) timestamp
23695 (let ((split-ts (org-element-copy timestamp)))
23696 ;; Set new type.
23697 (org-element-put-property
23698 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23699 ;; Copy start properties over end properties if END is
23700 ;; non-nil. Otherwise, copy end properties over `start' ones.
23701 (let ((p-alist '((:minute-start . :minute-end)
23702 (:hour-start . :hour-end)
23703 (:day-start . :day-end)
23704 (:month-start . :month-end)
23705 (:year-start . :year-end))))
23706 (dolist (p-cell p-alist)
23707 (org-element-put-property
23708 split-ts
23709 (funcall (if end #'car #'cdr) p-cell)
23710 (org-element-property
23711 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23712 ;; Eventually refresh `:raw-value'.
23713 (org-element-put-property split-ts :raw-value nil)
23714 (org-element-put-property
23715 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23717 (defun org-timestamp-translate (timestamp &optional boundary)
23718 "Translate TIMESTAMP object to custom format.
23720 Format string is defined in `org-time-stamp-custom-formats',
23721 which see.
23723 When optional argument BOUNDARY is non-nil, it is either the
23724 symbol `start' or `end'. In this case, only translate the
23725 starting or ending part of TIMESTAMP if it is a date or time
23726 range. Otherwise, translate both parts.
23728 Return timestamp as-is if `org-display-custom-times' is nil or if
23729 it has a `diary' type."
23730 (let ((type (org-element-property :type timestamp)))
23731 (if (or (not org-display-custom-times) (eq type 'diary))
23732 (org-element-interpret-data timestamp)
23733 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23734 org-time-stamp-custom-formats)))
23735 (if (and (not boundary) (memq type '(active-range inactive-range)))
23736 (concat (org-timestamp-format timestamp fmt)
23737 "--"
23738 (org-timestamp-format timestamp fmt t))
23739 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23743 ;;; Other stuff.
23745 (defvar reftex-docstruct-symbol)
23746 (defvar org--rds)
23748 (defun org-reftex-citation ()
23749 "Use reftex-citation to insert a citation into the buffer.
23750 This looks for a line like
23752 #+BIBLIOGRAPHY: foo plain option:-d
23754 and derives from it that foo.bib is the bibliography file relevant
23755 for this document. It then installs the necessary environment for RefTeX
23756 to work in this buffer and calls `reftex-citation' to insert a citation
23757 into the buffer.
23759 Export of such citations to both LaTeX and HTML is handled by the contributed
23760 package ox-bibtex by Taru Karttunen."
23761 (interactive)
23762 (let ((reftex-docstruct-symbol 'org--rds)
23763 org--rds bib)
23764 (org-with-wide-buffer
23765 (let ((case-fold-search t)
23766 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23767 (if (not (save-excursion
23768 (or (re-search-forward re nil t)
23769 (re-search-backward re nil t))))
23770 (user-error "No bibliography defined in file")
23771 (setq bib (concat (match-string 1) ".bib")
23772 org--rds (list (list 'bib bib))))))
23773 (call-interactively 'reftex-citation)))
23775 ;;;; Functions extending outline functionality
23777 (defun org-beginning-of-line (&optional n)
23778 "Go to the beginning of the current visible line.
23780 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23781 tags on the first attempt, and only move to after the tags when
23782 the cursor is already beyond the end of the headline.
23784 With argument N not nil or 1, move forward N - 1 lines first."
23785 (interactive "^p")
23786 (let ((origin (point))
23787 (special (pcase org-special-ctrl-a/e
23788 (`(,C-a . ,_) C-a) (_ org-special-ctrl-a/e)))
23789 deactivate-mark)
23790 ;; First move to a visible line.
23791 (if (bound-and-true-p visual-line-mode)
23792 (beginning-of-visual-line n)
23793 (move-beginning-of-line n)
23794 ;; `move-beginning-of-line' may leave point after invisible
23795 ;; characters if line starts with such of these (e.g., with
23796 ;; a link at column 0). Really move to the beginning of the
23797 ;; current visible line.
23798 (beginning-of-line))
23799 (cond
23800 ;; No special behavior. Point is already at the beginning of
23801 ;; a line, logical or visual.
23802 ((not special))
23803 ;; `beginning-of-visual-line' left point before logical beginning
23804 ;; of line: point is at the beginning of a visual line. Bail
23805 ;; out.
23806 ((and (bound-and-true-p visual-line-mode) (not (bolp))))
23807 ((let ((case-fold-search nil)) (looking-at org-complex-heading-regexp))
23808 ;; At a headline, special position is before the title, but
23809 ;; after any TODO keyword or priority cookie.
23810 (let ((refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23811 (line-end-position)))
23812 (bol (point)))
23813 (if (eq special 'reversed)
23814 (when (and (= origin bol) (eq last-command this-command))
23815 (goto-char refpos))
23816 (when (or (> origin refpos) (= origin bol))
23817 (goto-char refpos)))))
23818 ((and (looking-at org-list-full-item-re)
23819 (memq (org-element-type (save-match-data (org-element-at-point)))
23820 '(item plain-list)))
23821 ;; Set special position at first white space character after
23822 ;; bullet, and check-box, if any.
23823 (let ((after-bullet
23824 (let ((box (match-end 3)))
23825 (cond ((not box) (match-end 1))
23826 ((eq (char-after box) ?\s) (1+ box))
23827 (t box)))))
23828 (if (eq special 'reversed)
23829 (when (and (= (point) origin) (eq last-command this-command))
23830 (goto-char after-bullet))
23831 (when (or (> origin after-bullet) (= (point) origin))
23832 (goto-char after-bullet)))))
23833 ;; No special context. Point is already at beginning of line.
23834 (t nil))))
23836 (defun org-end-of-line (&optional n)
23837 "Go to the end of the line, but before ellipsis, if any.
23839 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23840 tags on the first attempt, and only move to after the tags when
23841 the cursor is already beyond the end of the headline.
23843 With argument N not nil or 1, move forward N - 1 lines first."
23844 (interactive "^p")
23845 (let ((origin (point))
23846 (special (pcase org-special-ctrl-a/e
23847 (`(,_ . ,C-e) C-e) (_ org-special-ctrl-a/e)))
23848 deactivate-mark)
23849 ;; First move to a visible line.
23850 (if (bound-and-true-p visual-line-mode)
23851 (beginning-of-visual-line n)
23852 (move-beginning-of-line n))
23853 (cond
23854 ;; At a headline, with tags.
23855 ((and special
23856 (save-excursion
23857 (beginning-of-line)
23858 (let ((case-fold-search nil))
23859 (looking-at org-complex-heading-regexp)))
23860 (match-end 5))
23861 (let ((tags (save-excursion
23862 (goto-char (match-beginning 5))
23863 (skip-chars-backward " \t")
23864 (point)))
23865 (visual-end (and (bound-and-true-p visual-line-mode)
23866 (save-excursion
23867 (end-of-visual-line)
23868 (point)))))
23869 ;; If `end-of-visual-line' brings us before end of line or
23870 ;; even tags, i.e., the headline spans over multiple visual
23871 ;; lines, move there.
23872 (cond ((and visual-end
23873 (< visual-end tags)
23874 (<= origin visual-end))
23875 (goto-char visual-end))
23876 ((eq special 'reversed)
23877 (if (and (= origin (line-end-position))
23878 (eq this-command last-command))
23879 (goto-char tags)
23880 (end-of-line)))
23882 (if (or (< origin tags) (= origin (line-end-position)))
23883 (goto-char tags)
23884 (end-of-line))))))
23885 ((bound-and-true-p visual-line-mode)
23886 (let ((bol (line-beginning-position)))
23887 (end-of-visual-line)
23888 ;; If `end-of-visual-line' gets us past the ellipsis at the
23889 ;; end of a line, backtrack and use `end-of-line' instead.
23890 (when (/= bol (line-beginning-position))
23891 (goto-char bol)
23892 (end-of-line))))
23893 (t (end-of-line)))))
23895 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23896 (define-key org-mode-map "\C-e" 'org-end-of-line)
23898 (defun org-backward-sentence (&optional _arg)
23899 "Go to beginning of sentence, or beginning of table field.
23900 This will call `backward-sentence' or `org-table-beginning-of-field',
23901 depending on context."
23902 (interactive)
23903 (let* ((element (org-element-at-point))
23904 (contents-begin (org-element-property :contents-begin element))
23905 (table (org-element-lineage element '(table) t)))
23906 (if (and table
23907 (> (point) contents-begin)
23908 (<= (point) (org-element-property :contents-end table)))
23909 (call-interactively #'org-table-beginning-of-field)
23910 (save-restriction
23911 (when (and contents-begin
23912 (< (point-min) contents-begin)
23913 (> (point) contents-begin))
23914 (narrow-to-region contents-begin
23915 (org-element-property :contents-end element)))
23916 (call-interactively #'backward-sentence)))))
23918 (defun org-forward-sentence (&optional _arg)
23919 "Go to end of sentence, or end of table field.
23920 This will call `forward-sentence' or `org-table-end-of-field',
23921 depending on context."
23922 (interactive)
23923 (let* ((element (org-element-at-point))
23924 (contents-end (org-element-property :contents-end element))
23925 (table (org-element-lineage element '(table) t)))
23926 (if (and table
23927 (>= (point) (org-element-property :contents-begin table))
23928 (< (point) contents-end))
23929 (call-interactively #'org-table-end-of-field)
23930 (save-restriction
23931 (when (and contents-end
23932 (> (point-max) contents-end)
23933 ;; Skip blank lines between elements.
23934 (< (org-element-property :end element)
23935 (save-excursion (goto-char contents-end)
23936 (skip-chars-forward " \r\t\n"))))
23937 (narrow-to-region (org-element-property :contents-begin element)
23938 contents-end))
23939 (call-interactively #'forward-sentence)))))
23941 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23942 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23944 (defun org-kill-line (&optional _arg)
23945 "Kill line, to tags or end of line."
23946 (interactive)
23947 (cond
23948 ((or (not org-special-ctrl-k)
23949 (bolp)
23950 (not (org-at-heading-p)))
23951 (when (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23952 org-ctrl-k-protect-subtree
23953 (or (eq org-ctrl-k-protect-subtree 'error)
23954 (not (y-or-n-p "Kill hidden subtree along with headline? "))))
23955 (user-error "C-k aborted as it would kill a hidden subtree"))
23956 (call-interactively
23957 (if (bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23958 ((looking-at ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")
23959 (kill-region (point) (match-beginning 1))
23960 (org-set-tags nil t))
23961 (t (kill-region (point) (point-at-eol)))))
23963 (define-key org-mode-map "\C-k" 'org-kill-line)
23965 (defun org-yank (&optional arg)
23966 "Yank. If the kill is a subtree, treat it specially.
23967 This command will look at the current kill and check if is a single
23968 subtree, or a series of subtrees[1]. If it passes the test, and if the
23969 cursor is at the beginning of a line or after the stars of a currently
23970 empty headline, then the yank is handled specially. How exactly depends
23971 on the value of the following variables.
23973 `org-yank-folded-subtrees'
23974 By default, this variable is non-nil, which results in
23975 subtree(s) being folded after insertion, except if doing so
23976 would swallow text after the yanked text.
23978 `org-yank-adjusted-subtrees'
23979 When non-nil (the default value is nil), the subtree will be
23980 promoted or demoted in order to fit into the local outline tree
23981 structure, which means that the level will be adjusted so that it
23982 becomes the smaller one of the two *visible* surrounding headings.
23984 Any prefix to this command will cause `yank' to be called directly with
23985 no special treatment. In particular, a simple `\\[universal-argument]' prefix \
23986 will just
23987 plainly yank the text as it is.
23989 \[1] The test checks if the first non-white line is a heading
23990 and if there are no other headings with fewer stars."
23991 (interactive "P")
23992 (org-yank-generic 'yank arg))
23994 (defun org-yank-generic (command arg)
23995 "Perform some yank-like command.
23997 This function implements the behavior described in the `org-yank'
23998 documentation. However, it has been generalized to work for any
23999 interactive command with similar behavior."
24001 ;; pretend to be command COMMAND
24002 (setq this-command command)
24004 (if arg
24005 (call-interactively command)
24007 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24008 (and (org-kill-is-subtree-p)
24009 (or (bolp)
24010 (and (looking-at "[ \t]*$")
24011 (string-match
24012 "\\`\\*+\\'"
24013 (buffer-substring (point-at-bol) (point)))))))
24014 swallowp)
24015 (cond
24016 ((and subtreep org-yank-folded-subtrees)
24017 (let ((beg (point))
24018 end)
24019 (if (and subtreep org-yank-adjusted-subtrees)
24020 (org-paste-subtree nil nil 'for-yank)
24021 (call-interactively command))
24023 (setq end (point))
24024 (goto-char beg)
24025 (when (and (bolp) subtreep
24026 (not (setq swallowp
24027 (org-yank-folding-would-swallow-text beg end))))
24028 (org-with-limited-levels
24029 (or (looking-at org-outline-regexp)
24030 (re-search-forward org-outline-regexp-bol end t))
24031 (while (and (< (point) end) (looking-at org-outline-regexp))
24032 (outline-hide-subtree)
24033 (org-cycle-show-empty-lines 'folded)
24034 (condition-case nil
24035 (outline-forward-same-level 1)
24036 (error (goto-char end))))))
24037 (when swallowp
24038 (message
24039 "Inserted text not folded because that would swallow text"))
24041 (goto-char end)
24042 (skip-chars-forward " \t\n\r")
24043 (beginning-of-line 1)
24044 (push-mark beg 'nomsg)))
24045 ((and subtreep org-yank-adjusted-subtrees)
24046 (let ((beg (point-at-bol)))
24047 (org-paste-subtree nil nil 'for-yank)
24048 (push-mark beg 'nomsg)))
24050 (call-interactively command))))))
24052 (defun org-yank-folding-would-swallow-text (beg end)
24053 "Would hide-subtree at BEG swallow any text after END?"
24054 (let (level)
24055 (org-with-limited-levels
24056 (save-excursion
24057 (goto-char beg)
24058 (when (or (looking-at org-outline-regexp)
24059 (re-search-forward org-outline-regexp-bol end t))
24060 (setq level (org-outline-level)))
24061 (goto-char end)
24062 (skip-chars-forward " \t\r\n\v\f")
24063 (not (or (eobp)
24064 (and (bolp) (looking-at-p org-outline-regexp)
24065 (<= (org-outline-level) level))))))))
24067 (define-key org-mode-map "\C-y" 'org-yank)
24069 (defun org-truely-invisible-p ()
24070 "Check if point is at a character currently not visible.
24071 This version does not only check the character property, but also
24072 `visible-mode'."
24073 ;; Early versions of noutline don't have `outline-invisible-p'.
24074 (unless (bound-and-true-p visible-mode)
24075 (outline-invisible-p)))
24077 (defun org-invisible-p2 ()
24078 "Check if point is at a character currently not visible."
24079 (save-excursion
24080 (when (and (eolp) (not (bobp))) (backward-char 1))
24081 ;; Early versions of noutline don't have `outline-invisible-p'.
24082 (outline-invisible-p)))
24084 (defun org-back-to-heading (&optional invisible-ok)
24085 "Call `outline-back-to-heading', but provide a better error message."
24086 (condition-case nil
24087 (outline-back-to-heading invisible-ok)
24088 (error (error "Before first headline at position %d in buffer %s"
24089 (point) (current-buffer)))))
24091 (defun org-before-first-heading-p ()
24092 "Before first heading?"
24093 (save-excursion
24094 (end-of-line)
24095 (null (re-search-backward org-outline-regexp-bol nil t))))
24097 (defun org-at-heading-p (&optional ignored)
24098 (outline-on-heading-p t))
24100 (defun org-in-commented-heading-p (&optional no-inheritance)
24101 "Non-nil if point is under a commented heading.
24102 This function also checks ancestors of the current headline,
24103 unless optional argument NO-INHERITANCE is non-nil."
24104 (cond
24105 ((org-before-first-heading-p) nil)
24106 ((let ((headline (nth 4 (org-heading-components))))
24107 (and headline
24108 (let ((case-fold-search nil))
24109 (string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24110 headline)))))
24111 (no-inheritance nil)
24113 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24115 (defun org-at-comment-p nil
24116 "Is cursor in a commented line?"
24117 (save-excursion
24118 (save-match-data
24119 (beginning-of-line)
24120 (looking-at "^[ \t]*# "))))
24122 (defun org-at-drawer-p nil
24123 "Is cursor at a drawer keyword?"
24124 (save-excursion
24125 (move-beginning-of-line 1)
24126 (looking-at org-drawer-regexp)))
24128 (defun org-at-block-p nil
24129 "Is cursor at a block keyword?"
24130 (save-excursion
24131 (move-beginning-of-line 1)
24132 (looking-at org-block-regexp)))
24134 (defun org-point-at-end-of-empty-headline ()
24135 "If point is at the end of an empty headline, return t, else nil.
24136 If the heading only contains a TODO keyword, it is still still considered
24137 empty."
24138 (let ((case-fold-search nil))
24139 (and (looking-at "[ \t]*$")
24140 org-todo-line-regexp
24141 (save-excursion
24142 (beginning-of-line)
24143 (looking-at org-todo-line-regexp)
24144 (string= (match-string 3) "")))))
24146 (defun org-at-heading-or-item-p ()
24147 (or (org-at-heading-p) (org-at-item-p)))
24149 (defun org-at-target-p ()
24150 (or (org-in-regexp org-radio-target-regexp)
24151 (org-in-regexp org-target-regexp)))
24152 ;; Compatibility alias with Org versions < 7.8.03
24153 (defalias 'org-on-target-p 'org-at-target-p)
24155 (defun org-up-heading-all (arg)
24156 "Move to the heading line of which the present line is a subheading.
24157 This function considers both visible and invisible heading lines.
24158 With argument, move up ARG levels."
24159 (outline-up-heading arg t))
24161 (defun org-up-heading-safe ()
24162 "Move to the heading line of which the present line is a subheading.
24163 This version will not throw an error. It will return the level of the
24164 headline found, or nil if no higher level is found.
24166 Also, this function will be a lot faster than `outline-up-heading',
24167 because it relies on stars being the outline starters. This can really
24168 make a significant difference in outlines with very many siblings."
24169 (when (ignore-errors (org-back-to-heading t))
24170 (let ((level-up (1- (funcall outline-level))))
24171 (and (> level-up 0)
24172 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24173 (funcall outline-level)))))
24175 (defun org-first-sibling-p ()
24176 "Is this heading the first child of its parents?"
24177 (interactive)
24178 (let ((re org-outline-regexp-bol)
24179 level l)
24180 (unless (org-at-heading-p t)
24181 (user-error "Not at a heading"))
24182 (setq level (funcall outline-level))
24183 (save-excursion
24184 (if (not (re-search-backward re nil t))
24186 (setq l (funcall outline-level))
24187 (< l level)))))
24189 (defun org-goto-sibling (&optional previous)
24190 "Goto the next sibling, even if it is invisible.
24191 When PREVIOUS is set, go to the previous sibling instead. Returns t
24192 when a sibling was found. When none is found, return nil and don't
24193 move point."
24194 (let ((fun (if previous 're-search-backward 're-search-forward))
24195 (pos (point))
24196 (re org-outline-regexp-bol)
24197 level l)
24198 (when (ignore-errors (org-back-to-heading t))
24199 (setq level (funcall outline-level))
24200 (catch 'exit
24201 (or previous (forward-char 1))
24202 (while (funcall fun re nil t)
24203 (setq l (funcall outline-level))
24204 (when (< l level) (goto-char pos) (throw 'exit nil))
24205 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24206 (goto-char pos)
24207 nil))))
24209 (defun org-show-siblings ()
24210 "Show all siblings of the current headline."
24211 (save-excursion
24212 (while (org-goto-sibling) (org-flag-heading nil)))
24213 (save-excursion
24214 (while (org-goto-sibling 'previous)
24215 (org-flag-heading nil))))
24217 (defun org-goto-first-child ()
24218 "Goto the first child, even if it is invisible.
24219 Return t when a child was found. Otherwise don't move point and
24220 return nil."
24221 (let (level (pos (point)) (re org-outline-regexp-bol))
24222 (when (ignore-errors (org-back-to-heading t))
24223 (setq level (outline-level))
24224 (forward-char 1)
24225 (if (and (re-search-forward re nil t) (> (outline-level) level))
24226 (progn (goto-char (match-beginning 0)) t)
24227 (goto-char pos) nil))))
24229 (defun org-show-hidden-entry ()
24230 "Show an entry where even the heading is hidden."
24231 (save-excursion
24232 (org-show-entry)))
24234 (defun org-flag-heading (flag &optional entry)
24235 "Flag the current heading. FLAG non-nil means make invisible.
24236 When ENTRY is non-nil, show the entire entry."
24237 (save-excursion
24238 (org-back-to-heading t)
24239 ;; Check if we should show the entire entry
24240 (if entry
24241 (progn
24242 (org-show-entry)
24243 (save-excursion
24244 (and (outline-next-heading)
24245 (org-flag-heading nil))))
24246 (outline-flag-region (max (point-min) (1- (point)))
24247 (save-excursion (outline-end-of-heading) (point))
24248 flag))))
24250 (defun org-get-next-sibling ()
24251 "Move to next heading of the same level, and return point.
24252 If there is no such heading, return nil.
24253 This is like outline-next-sibling, but invisible headings are ok."
24254 (let ((level (funcall outline-level)))
24255 (outline-next-heading)
24256 (while (and (not (eobp)) (> (funcall outline-level) level))
24257 (outline-next-heading))
24258 (unless (or (eobp) (< (funcall outline-level) level))
24259 (point))))
24261 (defun org-get-last-sibling ()
24262 "Move to previous heading of the same level, and return point.
24263 If there is no such heading, return nil."
24264 (let ((opoint (point))
24265 (level (funcall outline-level)))
24266 (outline-previous-heading)
24267 (when (and (/= (point) opoint) (outline-on-heading-p t))
24268 (while (and (> (funcall outline-level) level)
24269 (not (bobp)))
24270 (outline-previous-heading))
24271 (unless (< (funcall outline-level) level)
24272 (point)))))
24274 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24275 "Goto to the end of a subtree."
24276 ;; This contains an exact copy of the original function, but it uses
24277 ;; `org-back-to-heading', to make it work also in invisible
24278 ;; trees. And is uses an invisible-ok argument.
24279 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24280 ;; Furthermore, when used inside Org, finding the end of a large subtree
24281 ;; with many children and grandchildren etc, this can be much faster
24282 ;; than the outline version.
24283 (org-back-to-heading invisible-ok)
24284 (let ((first t)
24285 (level (funcall outline-level)))
24286 (if (and (derived-mode-p 'org-mode) (< level 1000))
24287 ;; A true heading (not a plain list item), in Org
24288 ;; This means we can easily find the end by looking
24289 ;; only for the right number of stars. Using a regexp to do
24290 ;; this is so much faster than using a Lisp loop.
24291 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24292 (forward-char 1)
24293 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24294 ;; something else, do it the slow way
24295 (while (and (not (eobp))
24296 (or first (> (funcall outline-level) level)))
24297 (setq first nil)
24298 (outline-next-heading)))
24299 (unless to-heading
24300 (when (memq (preceding-char) '(?\n ?\^M))
24301 ;; Go to end of line before heading
24302 (forward-char -1)
24303 (when (memq (preceding-char) '(?\n ?\^M))
24304 ;; leave blank line before heading
24305 (forward-char -1)))))
24306 (point))
24308 (defun org-end-of-meta-data (&optional full)
24309 "Skip planning line and properties drawer in current entry.
24310 When optional argument FULL is non-nil, also skip empty lines,
24311 clocking lines and regular drawers at the beginning of the
24312 entry."
24313 (org-back-to-heading t)
24314 (forward-line)
24315 (when (looking-at-p org-planning-line-re) (forward-line))
24316 (when (looking-at org-property-drawer-re)
24317 (goto-char (match-end 0))
24318 (forward-line))
24319 (when (and full (not (org-at-heading-p)))
24320 (catch 'exit
24321 (let ((end (save-excursion (outline-next-heading) (point)))
24322 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24323 (while (not (eobp))
24324 (cond ((looking-at-p org-drawer-regexp)
24325 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24326 (forward-line)
24327 (throw 'exit t)))
24328 ((looking-at-p re) (forward-line))
24329 (t (throw 'exit t))))))))
24331 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24332 "Move forward to the ARG'th subheading at same level as this one.
24333 Stop at the first and last subheadings of a superior heading.
24334 Normally this only looks at visible headings, but when INVISIBLE-OK is
24335 non-nil it will also look at invisible ones."
24336 (interactive "p")
24337 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24338 (if (and arg (< arg 0))
24339 (goto-char (point-min))
24340 (outline-next-heading))
24341 (org-at-heading-p)
24342 (let ((level (- (match-end 0) (match-beginning 0) 1))
24343 (f (if (and arg (< arg 0))
24344 're-search-backward
24345 're-search-forward))
24346 (count (if arg (abs arg) 1))
24347 (result (point)))
24348 (while (and (prog1 (> count 0)
24349 (forward-char (if (and arg (< arg 0)) -1 1)))
24350 (funcall f org-outline-regexp-bol nil 'move))
24351 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24352 (cond ((< l level) (setq count 0))
24353 ((and (= l level)
24354 (or invisible-ok
24355 (progn
24356 (goto-char (line-beginning-position))
24357 (not (outline-invisible-p)))))
24358 (setq count (1- count))
24359 (when (eq l level)
24360 (setq result (point)))))))
24361 (goto-char result))
24362 (beginning-of-line 1)))
24364 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24365 "Move backward to the ARG'th subheading at same level as this one.
24366 Stop at the first and last subheadings of a superior heading."
24367 (interactive "p")
24368 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24370 (defun org-next-visible-heading (arg)
24371 "Move to the next visible heading.
24373 This function wraps `outline-next-visible-heading' with
24374 `org-with-limited-levels' in order to skip over inline tasks and
24375 respect customization of `org-odd-levels-only'."
24376 (interactive "p")
24377 (org-with-limited-levels
24378 (outline-next-visible-heading arg)))
24380 (defun org-previous-visible-heading (arg)
24381 "Move to the previous visible heading.
24383 This function wraps `outline-previous-visible-heading' with
24384 `org-with-limited-levels' in order to skip over inline tasks and
24385 respect customization of `org-odd-levels-only'."
24386 (interactive "p")
24387 (org-with-limited-levels
24388 (outline-previous-visible-heading arg)))
24390 (defun org-next-block (arg &optional backward block-regexp)
24391 "Jump to the next block.
24393 With a prefix argument ARG, jump forward ARG many blocks.
24395 When BACKWARD is non-nil, jump to the previous block.
24397 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24398 Match data is set according to this regexp when the function
24399 returns.
24401 Return point at beginning of the opening line of found block.
24402 Throw an error if no block is found."
24403 (interactive "p")
24404 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24405 (case-fold-search t)
24406 (search-fn (if backward #'re-search-backward #'re-search-forward))
24407 (count (or arg 1))
24408 (origin (point))
24409 last-element)
24410 (if backward (beginning-of-line) (end-of-line))
24411 (while (and (> count 0) (funcall search-fn re nil t))
24412 (let ((element (save-excursion
24413 (goto-char (match-beginning 0))
24414 (save-match-data (org-element-at-point)))))
24415 (when (and (memq (org-element-type element)
24416 '(center-block comment-block dynamic-block
24417 example-block export-block quote-block
24418 special-block src-block verse-block))
24419 (<= (match-beginning 0)
24420 (org-element-property :post-affiliated element)))
24421 (setq last-element element)
24422 (cl-decf count))))
24423 (if (= count 0)
24424 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24425 (save-match-data (org-show-context)))
24426 (goto-char origin)
24427 (user-error "No %s code blocks" (if backward "previous" "further")))))
24429 (defun org-previous-block (arg &optional block-regexp)
24430 "Jump to the previous block.
24431 With a prefix argument ARG, jump backward ARG many source blocks.
24432 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24433 (interactive "p")
24434 (org-next-block arg t block-regexp))
24436 (defun org-forward-paragraph ()
24437 "Move forward to beginning of next paragraph or equivalent.
24439 The function moves point to the beginning of the next visible
24440 structural element, which can be a paragraph, a table, a list
24441 item, etc. It also provides some special moves for convenience:
24443 - On an affiliated keyword, jump to the beginning of the
24444 relative element.
24445 - On an item or a footnote definition, move to the second
24446 element inside, if any.
24447 - On a table or a property drawer, jump after it.
24448 - On a verse or source block, stop after blank lines."
24449 (interactive)
24450 (when (eobp) (user-error "Cannot move further down"))
24451 (let* ((deactivate-mark nil)
24452 (element (org-element-at-point))
24453 (type (org-element-type element))
24454 (post-affiliated (org-element-property :post-affiliated element))
24455 (contents-begin (org-element-property :contents-begin element))
24456 (contents-end (org-element-property :contents-end element))
24457 (end (let ((end (org-element-property :end element)) (parent element))
24458 (while (and (setq parent (org-element-property :parent parent))
24459 (= (org-element-property :contents-end parent) end))
24460 (setq end (org-element-property :end parent)))
24461 end)))
24462 (cond ((not element)
24463 (skip-chars-forward " \r\t\n")
24464 (or (eobp) (beginning-of-line)))
24465 ;; On affiliated keywords, move to element's beginning.
24466 ((< (point) post-affiliated)
24467 (goto-char post-affiliated))
24468 ;; At a table row, move to the end of the table. Similarly,
24469 ;; at a node property, move to the end of the property
24470 ;; drawer.
24471 ((memq type '(node-property table-row))
24472 (goto-char (org-element-property
24473 :end (org-element-property :parent element))))
24474 ((memq type '(property-drawer table)) (goto-char end))
24475 ;; Consider blank lines as separators in verse and source
24476 ;; blocks to ease editing.
24477 ((memq type '(src-block verse-block))
24478 (when (eq type 'src-block)
24479 (setq contents-end
24480 (save-excursion (goto-char end)
24481 (skip-chars-backward " \r\t\n")
24482 (line-beginning-position))))
24483 (beginning-of-line)
24484 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24485 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24486 (goto-char end)
24487 (skip-chars-forward " \r\t\n")
24488 (if (= (point) contents-end) (goto-char end)
24489 (beginning-of-line))))
24490 ;; With no contents, just skip element.
24491 ((not contents-begin) (goto-char end))
24492 ;; If contents are invisible, skip the element altogether.
24493 ((outline-invisible-p (line-end-position))
24494 (cl-case type
24495 (headline
24496 (org-with-limited-levels (outline-next-visible-heading 1)))
24497 ;; At a plain list, make sure we move to the next item
24498 ;; instead of skipping the whole list.
24499 (plain-list (forward-char)
24500 (org-forward-paragraph))
24501 (otherwise (goto-char end))))
24502 ((>= (point) contents-end) (goto-char end))
24503 ((>= (point) contents-begin)
24504 ;; This can only happen on paragraphs and plain lists.
24505 (cl-case type
24506 (paragraph (goto-char end))
24507 ;; At a plain list, try to move to second element in
24508 ;; first item, if possible.
24509 (plain-list (end-of-line)
24510 (org-forward-paragraph))))
24511 ;; When contents start on the middle of a line (e.g. in
24512 ;; items and footnote definitions), try to reach first
24513 ;; element starting after current line.
24514 ((> (line-end-position) contents-begin)
24515 (end-of-line)
24516 (org-forward-paragraph))
24517 (t (goto-char contents-begin)))))
24519 (defun org-backward-paragraph ()
24520 "Move backward to start of previous paragraph or equivalent.
24522 The function moves point to the beginning of the current
24523 structural element, which can be a paragraph, a table, a list
24524 item, etc., or to the beginning of the previous visible one if
24525 point is already there. It also provides some special moves for
24526 convenience:
24528 - On an affiliated keyword, jump to the first one.
24529 - On a table or a property drawer, move to its beginning.
24530 - On a verse or source block, stop before blank lines."
24531 (interactive)
24532 (when (bobp) (user-error "Cannot move further up"))
24533 (let* ((deactivate-mark nil)
24534 (element (org-element-at-point))
24535 (type (org-element-type element))
24536 (contents-begin (org-element-property :contents-begin element))
24537 (contents-end (org-element-property :contents-end element))
24538 (post-affiliated (org-element-property :post-affiliated element))
24539 (begin (org-element-property :begin element)))
24540 (cond
24541 ((not element) (goto-char (point-min)))
24542 ((= (point) begin)
24543 (backward-char)
24544 (org-backward-paragraph))
24545 ((<= (point) post-affiliated) (goto-char begin))
24546 ((memq type '(node-property table-row))
24547 (goto-char (org-element-property
24548 :post-affiliated (org-element-property :parent element))))
24549 ((memq type '(property-drawer table)) (goto-char begin))
24550 ((memq type '(src-block verse-block))
24551 (when (eq type 'src-block)
24552 (setq contents-begin
24553 (save-excursion (goto-char begin) (forward-line) (point))))
24554 (if (= (point) contents-begin) (goto-char post-affiliated)
24555 ;; Inside a verse block, see blank lines as paragraph
24556 ;; separators.
24557 (let ((origin (point)))
24558 (skip-chars-backward " \r\t\n" contents-begin)
24559 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24560 (skip-chars-forward " \r\t\n" origin)
24561 (if (= (point) origin) (goto-char contents-begin)
24562 (beginning-of-line))))))
24563 ((not contents-begin) (goto-char (or post-affiliated begin)))
24564 ((eq type 'paragraph)
24565 (goto-char contents-begin)
24566 ;; When at first paragraph in an item or a footnote definition,
24567 ;; move directly to beginning of line.
24568 (let ((parent-contents
24569 (org-element-property
24570 :contents-begin (org-element-property :parent element))))
24571 (when (and parent-contents (= parent-contents contents-begin))
24572 (beginning-of-line))))
24573 ;; At the end of a greater element, move to the beginning of the
24574 ;; last element within.
24575 ((>= (point) contents-end)
24576 (goto-char (1- contents-end))
24577 (org-backward-paragraph))
24578 (t (goto-char (or post-affiliated begin))))
24579 ;; Ensure we never leave point invisible.
24580 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24582 (defun org-forward-element ()
24583 "Move forward by one element.
24584 Move to the next element at the same level, when possible."
24585 (interactive)
24586 (cond ((eobp) (user-error "Cannot move further down"))
24587 ((org-with-limited-levels (org-at-heading-p))
24588 (let ((origin (point)))
24589 (goto-char (org-end-of-subtree nil t))
24590 (unless (org-with-limited-levels (org-at-heading-p))
24591 (goto-char origin)
24592 (user-error "Cannot move further down"))))
24594 (let* ((elem (org-element-at-point))
24595 (end (org-element-property :end elem))
24596 (parent (org-element-property :parent elem)))
24597 (cond ((and parent (= (org-element-property :contents-end parent) end))
24598 (goto-char (org-element-property :end parent)))
24599 ((integer-or-marker-p end) (goto-char end))
24600 (t (message "No element at point")))))))
24602 (defun org-backward-element ()
24603 "Move backward by one element.
24604 Move to the previous element at the same level, when possible."
24605 (interactive)
24606 (cond ((bobp) (user-error "Cannot move further up"))
24607 ((org-with-limited-levels (org-at-heading-p))
24608 ;; At a headline, move to the previous one, if any, or stay
24609 ;; here.
24610 (let ((origin (point)))
24611 (org-with-limited-levels (org-backward-heading-same-level 1))
24612 ;; When current headline has no sibling above, move to its
24613 ;; parent.
24614 (when (= (point) origin)
24615 (or (org-with-limited-levels (org-up-heading-safe))
24616 (progn (goto-char origin)
24617 (user-error "Cannot move further up"))))))
24619 (let* ((elem (org-element-at-point))
24620 (beg (org-element-property :begin elem)))
24621 (cond
24622 ;; Move to beginning of current element if point isn't
24623 ;; there already.
24624 ((null beg) (message "No element at point"))
24625 ((/= (point) beg) (goto-char beg))
24626 (t (goto-char beg)
24627 (skip-chars-backward " \r\t\n")
24628 (unless (bobp)
24629 (let ((prev (org-element-at-point)))
24630 (goto-char (org-element-property :begin prev))
24631 (while (and (setq prev (org-element-property :parent prev))
24632 (<= (org-element-property :end prev) beg))
24633 (goto-char (org-element-property :begin prev)))))))))))
24635 (defun org-up-element ()
24636 "Move to upper element."
24637 (interactive)
24638 (if (org-with-limited-levels (org-at-heading-p))
24639 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24640 (let* ((elem (org-element-at-point))
24641 (parent (org-element-property :parent elem)))
24642 (if parent (goto-char (org-element-property :begin parent))
24643 (if (org-with-limited-levels (org-before-first-heading-p))
24644 (user-error "No surrounding element")
24645 (org-with-limited-levels (org-back-to-heading)))))))
24647 (defvar org-element-greater-elements)
24648 (defun org-down-element ()
24649 "Move to inner element."
24650 (interactive)
24651 (let ((element (org-element-at-point)))
24652 (cond
24653 ((memq (org-element-type element) '(plain-list table))
24654 (goto-char (org-element-property :contents-begin element))
24655 (forward-char))
24656 ((memq (org-element-type element) org-element-greater-elements)
24657 ;; If contents are hidden, first disclose them.
24658 (when (outline-invisible-p (line-end-position)) (org-cycle))
24659 (goto-char (or (org-element-property :contents-begin element)
24660 (user-error "No content for this element"))))
24661 (t (user-error "No inner element")))))
24663 (defun org-drag-element-backward ()
24664 "Move backward element at point."
24665 (interactive)
24666 (let ((elem (or (org-element-at-point)
24667 (user-error "No element at point"))))
24668 (if (eq (org-element-type elem) 'headline)
24669 ;; Preserve point when moving a whole tree, even if point was
24670 ;; on blank lines below the headline.
24671 (let ((offset (skip-chars-backward " \t\n")))
24672 (unwind-protect (org-move-subtree-up)
24673 (forward-char (- offset))))
24674 (let ((prev-elem
24675 (save-excursion
24676 (goto-char (org-element-property :begin elem))
24677 (skip-chars-backward " \r\t\n")
24678 (unless (bobp)
24679 (let* ((beg (org-element-property :begin elem))
24680 (prev (org-element-at-point))
24681 (up prev))
24682 (while (and (setq up (org-element-property :parent up))
24683 (<= (org-element-property :end up) beg))
24684 (setq prev up))
24685 prev)))))
24686 ;; Error out if no previous element or previous element is
24687 ;; a parent of the current one.
24688 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24689 (user-error "Cannot drag element backward")
24690 (let ((pos (point)))
24691 (org-element-swap-A-B prev-elem elem)
24692 (goto-char (+ (org-element-property :begin prev-elem)
24693 (- pos (org-element-property :begin elem))))))))))
24695 (defun org-drag-element-forward ()
24696 "Move forward element at point."
24697 (interactive)
24698 (let* ((pos (point))
24699 (elem (or (org-element-at-point)
24700 (user-error "No element at point"))))
24701 (when (= (point-max) (org-element-property :end elem))
24702 (user-error "Cannot drag element forward"))
24703 (goto-char (org-element-property :end elem))
24704 (let ((next-elem (org-element-at-point)))
24705 (when (or (org-element-nested-p elem next-elem)
24706 (and (eq (org-element-type next-elem) 'headline)
24707 (not (eq (org-element-type elem) 'headline))))
24708 (goto-char pos)
24709 (user-error "Cannot drag element forward"))
24710 ;; Compute new position of point: it's shifted by NEXT-ELEM
24711 ;; body's length (without final blanks) and by the length of
24712 ;; blanks between ELEM and NEXT-ELEM.
24713 (let ((size-next (- (save-excursion
24714 (goto-char (org-element-property :end next-elem))
24715 (skip-chars-backward " \r\t\n")
24716 (forward-line)
24717 ;; Small correction if buffer doesn't end
24718 ;; with a newline character.
24719 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24720 (org-element-property :begin next-elem)))
24721 (size-blank (- (org-element-property :end elem)
24722 (save-excursion
24723 (goto-char (org-element-property :end elem))
24724 (skip-chars-backward " \r\t\n")
24725 (forward-line)
24726 (point)))))
24727 (org-element-swap-A-B elem next-elem)
24728 (goto-char (+ pos size-next size-blank))))))
24730 (defun org-drag-line-forward (arg)
24731 "Drag the line at point ARG lines forward."
24732 (interactive "p")
24733 (dotimes (_ (abs arg))
24734 (let ((c (current-column)))
24735 (if (< 0 arg)
24736 (progn
24737 (beginning-of-line 2)
24738 (transpose-lines 1)
24739 (beginning-of-line 0))
24740 (transpose-lines 1)
24741 (beginning-of-line -1))
24742 (org-move-to-column c))))
24744 (defun org-drag-line-backward (arg)
24745 "Drag the line at point ARG lines backward."
24746 (interactive "p")
24747 (org-drag-line-forward (- arg)))
24749 (defun org-mark-element ()
24750 "Put point at beginning of this element, mark at end.
24752 Interactively, if this command is repeated or (in Transient Mark
24753 mode) if the mark is active, it marks the next element after the
24754 ones already marked."
24755 (interactive)
24756 (let (deactivate-mark)
24757 (if (and (called-interactively-p 'any)
24758 (or (and (eq last-command this-command) (mark t))
24759 (and transient-mark-mode mark-active)))
24760 (set-mark
24761 (save-excursion
24762 (goto-char (mark))
24763 (goto-char (org-element-property :end (org-element-at-point)))))
24764 (let ((element (org-element-at-point)))
24765 (end-of-line)
24766 (push-mark (org-element-property :end element) t t)
24767 (goto-char (org-element-property :begin element))))))
24769 (defun org-narrow-to-element ()
24770 "Narrow buffer to current element."
24771 (interactive)
24772 (let ((elem (org-element-at-point)))
24773 (cond
24774 ((eq (car elem) 'headline)
24775 (narrow-to-region
24776 (org-element-property :begin elem)
24777 (org-element-property :end elem)))
24778 ((memq (car elem) org-element-greater-elements)
24779 (narrow-to-region
24780 (org-element-property :contents-begin elem)
24781 (org-element-property :contents-end elem)))
24783 (narrow-to-region
24784 (org-element-property :begin elem)
24785 (org-element-property :end elem))))))
24787 (defun org-transpose-element ()
24788 "Transpose current and previous elements, keeping blank lines between.
24789 Point is moved after both elements."
24790 (interactive)
24791 (org-skip-whitespace)
24792 (let ((end (org-element-property :end (org-element-at-point))))
24793 (org-drag-element-backward)
24794 (goto-char end)))
24796 (defun org-unindent-buffer ()
24797 "Un-indent the visible part of the buffer.
24798 Relative indentation (between items, inside blocks, etc.) isn't
24799 modified."
24800 (interactive)
24801 (unless (eq major-mode 'org-mode)
24802 (user-error "Cannot un-indent a buffer not in Org mode"))
24803 (letrec ((parse-tree (org-element-parse-buffer 'greater-element))
24804 (unindent-tree
24805 (lambda (contents)
24806 (dolist (element (reverse contents))
24807 (if (memq (org-element-type element) '(headline section))
24808 (funcall unindent-tree (org-element-contents element))
24809 (save-excursion
24810 (save-restriction
24811 (narrow-to-region
24812 (org-element-property :begin element)
24813 (org-element-property :end element))
24814 (org-do-remove-indentation))))))))
24815 (funcall unindent-tree (org-element-contents parse-tree))))
24817 (defun org-show-children (&optional level)
24818 "Show all direct subheadings of this heading.
24819 Prefix arg LEVEL is how many levels below the current level
24820 should be shown. Default is enough to cause the following
24821 heading to appear."
24822 (interactive "p")
24823 ;; If `orgstruct-mode' is active, use the slower version.
24824 (if orgstruct-mode (call-interactively #'outline-show-children)
24825 (save-excursion
24826 (org-back-to-heading t)
24827 (let* ((current-level (funcall outline-level))
24828 (max-level (org-get-valid-level
24829 current-level
24830 (if level (prefix-numeric-value level) 1)))
24831 (end (save-excursion (org-end-of-subtree t t)))
24832 (regexp-fmt "^\\*\\{%d,%s\\}\\(?: \\|$\\)")
24833 (past-first-child nil)
24834 ;; Make sure to skip inlinetasks.
24835 (re (format regexp-fmt
24836 current-level
24837 (cond
24838 ((not (featurep 'org-inlinetask)) "")
24839 (org-odd-levels-only (- (* 2 org-inlinetask-min-level)
24841 (t (1- org-inlinetask-min-level))))))
24842 ;; Display parent heading.
24843 (outline-flag-region (line-end-position 0) (line-end-position) nil)
24844 (forward-line)
24845 ;; Display children. First child may be deeper than expected
24846 ;; MAX-LEVEL. Since we want to display it anyway, adjust
24847 ;; MAX-LEVEL accordingly.
24848 (while (re-search-forward re end t)
24849 (unless past-first-child
24850 (setq re (format regexp-fmt
24851 current-level
24852 (max (funcall outline-level) max-level)))
24853 (setq past-first-child t))
24854 (outline-flag-region
24855 (line-end-position 0) (line-end-position) nil))))))
24857 (defun org-show-subtree ()
24858 "Show everything after this heading at deeper levels."
24859 (interactive)
24860 (outline-flag-region
24861 (point)
24862 (save-excursion
24863 (org-end-of-subtree t t))
24864 nil))
24866 (defun org-show-entry ()
24867 "Show the body directly following this heading.
24868 Show the heading too, if it is currently invisible."
24869 (interactive)
24870 (save-excursion
24871 (ignore-errors
24872 (org-back-to-heading t)
24873 (outline-flag-region
24874 (max (point-min) (1- (point)))
24875 (save-excursion
24876 (if (re-search-forward
24877 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24878 (match-beginning 1)
24879 (point-max)))
24880 nil)
24881 (org-cycle-hide-drawers 'children))))
24883 (defun org-make-options-regexp (kwds &optional extra)
24884 "Make a regular expression for keyword lines.
24885 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24886 when non-nil, is a regexp matching keywords names."
24887 (concat "^[ \t]*#\\+\\("
24888 (regexp-opt kwds)
24889 (and extra (concat (and kwds "\\|") extra))
24890 "\\):[ \t]*\\(.*\\)"))
24892 ;;;; Integration with and fixes for other packages
24894 ;;; Imenu support
24896 (defvar-local org-imenu-markers nil
24897 "All markers currently used by Imenu.")
24899 (defun org-imenu-new-marker (&optional pos)
24900 "Return a new marker for use by Imenu, and remember the marker."
24901 (let ((m (make-marker)))
24902 (move-marker m (or pos (point)))
24903 (push m org-imenu-markers)
24906 (defun org-imenu-get-tree ()
24907 "Produce the index for Imenu."
24908 (dolist (x org-imenu-markers) (move-marker x nil))
24909 (setq org-imenu-markers nil)
24910 (let* ((case-fold-search nil)
24911 (n org-imenu-depth)
24912 (re (concat "^" (org-get-limited-outline-regexp)))
24913 (subs (make-vector (1+ n) nil))
24914 (last-level 0)
24915 m level head0 head)
24916 (org-with-wide-buffer
24917 (goto-char (point-max))
24918 (while (re-search-backward re nil t)
24919 (setq level (org-reduced-level (funcall outline-level)))
24920 (when (and (<= level n)
24921 (looking-at org-complex-heading-regexp)
24922 (setq head0 (match-string-no-properties 4)))
24923 (setq head (org-link-display-format head0)
24924 m (org-imenu-new-marker))
24925 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24926 (if (>= level last-level)
24927 (push (cons head m) (aref subs level))
24928 (push (cons head (aref subs (1+ level))) (aref subs level))
24929 (cl-loop for i from (1+ level) to n do (aset subs i nil)))
24930 (setq last-level level))))
24931 (aref subs 1)))
24933 (eval-after-load "imenu"
24934 '(progn
24935 (add-hook 'imenu-after-jump-hook
24936 (lambda ()
24937 (when (derived-mode-p 'org-mode)
24938 (org-show-context 'org-goto))))))
24940 (defun org-link-display-format (s)
24941 "Replace links in string S with their description.
24942 If there is no description, use the link target."
24943 (save-match-data
24944 (replace-regexp-in-string
24945 org-bracket-link-analytic-regexp
24946 (lambda (m)
24947 (if (match-end 5) (match-string 5 m)
24948 (concat (match-string 1 m) (match-string 3 m))))
24949 s nil t)))
24951 (defun org-toggle-link-display ()
24952 "Toggle the literal or descriptive display of links."
24953 (interactive)
24954 (if org-descriptive-links
24955 (progn (org-remove-from-invisibility-spec '(org-link))
24956 (org-restart-font-lock)
24957 (setq org-descriptive-links nil))
24958 (progn (add-to-invisibility-spec '(org-link))
24959 (org-restart-font-lock)
24960 (setq org-descriptive-links t))))
24962 ;; Speedbar support
24964 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24965 "Overlay marking the agenda restriction line in speedbar.")
24966 (overlay-put org-speedbar-restriction-lock-overlay
24967 'face 'org-agenda-restriction-lock)
24968 (overlay-put org-speedbar-restriction-lock-overlay
24969 'help-echo "Agendas are currently limited to this item.")
24970 (delete-overlay org-speedbar-restriction-lock-overlay)
24972 (defun org-speedbar-set-agenda-restriction ()
24973 "Restrict future agenda commands to the location at point in speedbar.
24974 To get rid of the restriction, use `\\[org-agenda-remove-restriction-lock]'."
24975 (interactive)
24976 (require 'org-agenda)
24977 (let (p m tp np dir txt)
24978 (cond
24979 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24980 'org-imenu t))
24981 (setq m (get-text-property p 'org-imenu-marker))
24982 (with-current-buffer (marker-buffer m)
24983 (goto-char m)
24984 (org-agenda-set-restriction-lock 'subtree)))
24985 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24986 'speedbar-function 'speedbar-find-file))
24987 (setq tp (previous-single-property-change
24988 (1+ p) 'speedbar-function)
24989 np (next-single-property-change
24990 tp 'speedbar-function)
24991 dir (speedbar-line-directory)
24992 txt (buffer-substring-no-properties (or tp (point-min))
24993 (or np (point-max))))
24994 (with-current-buffer (find-file-noselect
24995 (let ((default-directory dir))
24996 (expand-file-name txt)))
24997 (unless (derived-mode-p 'org-mode)
24998 (user-error "Cannot restrict to non-Org mode file"))
24999 (org-agenda-set-restriction-lock 'file)))
25000 (t (user-error "Don't know how to restrict Org mode agenda")))
25001 (move-overlay org-speedbar-restriction-lock-overlay
25002 (point-at-bol) (point-at-eol))
25003 (setq current-prefix-arg nil)
25004 (org-agenda-maybe-redo)))
25006 (defvar speedbar-file-key-map)
25007 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25008 (eval-after-load "speedbar"
25009 '(progn
25010 (speedbar-add-supported-extension ".org")
25011 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25012 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25013 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25014 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25015 (add-hook 'speedbar-visiting-tag-hook
25016 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25018 ;;; Fixes and Hacks for problems with other packages
25020 (defun org--flyspell-object-check-p (element)
25021 "Non-nil when Flyspell can check object at point.
25022 ELEMENT is the element at point."
25023 (let ((object (save-excursion
25024 (when (looking-at-p "\\>") (backward-char))
25025 (org-element-context element))))
25026 (cl-case (org-element-type object)
25027 ;; Prevent checks in links due to keybinding conflict with
25028 ;; Flyspell.
25029 ((code entity export-snippet inline-babel-call
25030 inline-src-block line-break latex-fragment link macro
25031 statistics-cookie target timestamp verbatim)
25032 nil)
25033 (footnote-reference
25034 ;; Only in inline footnotes, within the definition.
25035 (and (eq (org-element-property :type object) 'inline)
25036 (< (save-excursion
25037 (goto-char (org-element-property :begin object))
25038 (search-forward ":" nil t 2))
25039 (point))))
25040 (otherwise t))))
25042 (defun org-mode-flyspell-verify ()
25043 "Function used for `flyspell-generic-check-word-predicate'."
25044 (if (org-at-heading-p)
25045 ;; At a headline or an inlinetask, check title only. This is
25046 ;; faster than relying on `org-element-at-point'.
25047 (and (save-excursion (beginning-of-line)
25048 (and (let ((case-fold-search t))
25049 (not (looking-at-p "\\*+ END[ \t]*$")))
25050 (let ((case-fold-search nil))
25051 (looking-at org-complex-heading-regexp))))
25052 (match-beginning 4)
25053 (>= (point) (match-beginning 4))
25054 (or (not (match-beginning 5))
25055 (< (point) (match-beginning 5))))
25056 (let* ((element (org-element-at-point))
25057 (post-affiliated (org-element-property :post-affiliated element)))
25058 (cond
25059 ;; Ignore checks in all affiliated keywords but captions.
25060 ((< (point) post-affiliated)
25061 (and (save-excursion
25062 (beginning-of-line)
25063 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25064 (> (point) (match-end 0))
25065 (org--flyspell-object-check-p element)))
25066 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25067 ((let ((log (org-log-into-drawer)))
25068 (and log
25069 (let ((drawer (org-element-lineage element '(drawer))))
25070 (and drawer
25071 (eq (compare-strings
25072 log nil nil
25073 (org-element-property :drawer-name drawer) nil nil t)
25074 t)))))
25075 nil)
25077 (cl-case (org-element-type element)
25078 ((comment quote-section) t)
25079 (comment-block
25080 ;; Allow checks between block markers, not on them.
25081 (and (> (line-beginning-position) post-affiliated)
25082 (save-excursion
25083 (end-of-line)
25084 (skip-chars-forward " \r\t\n")
25085 (< (point) (org-element-property :end element)))))
25086 ;; Arbitrary list of keywords where checks are meaningful.
25087 ;; Make sure point is on the value part of the element.
25088 (keyword
25089 (and (member (org-element-property :key element)
25090 '("DESCRIPTION" "TITLE"))
25091 (save-excursion
25092 (search-backward ":" (line-beginning-position) t))))
25093 ;; Check is globally allowed in paragraphs verse blocks and
25094 ;; table rows (after affiliated keywords) but some objects
25095 ;; must not be affected.
25096 ((paragraph table-row verse-block)
25097 (let ((cbeg (org-element-property :contents-begin element))
25098 (cend (org-element-property :contents-end element)))
25099 (and cbeg (>= (point) cbeg) (< (point) cend)
25100 (org--flyspell-object-check-p element))))))))))
25101 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25103 (defun org-remove-flyspell-overlays-in (beg end)
25104 "Remove flyspell overlays in region."
25105 (and (bound-and-true-p flyspell-mode)
25106 (fboundp 'flyspell-delete-region-overlays)
25107 (flyspell-delete-region-overlays beg end)))
25109 (defvar flyspell-delayed-commands)
25110 (eval-after-load "flyspell"
25111 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25113 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25114 (eval-after-load "bookmark"
25115 '(if (boundp 'bookmark-after-jump-hook)
25116 ;; We can use the hook
25117 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25118 ;; Hook not available, use advice
25119 (defadvice bookmark-jump (after org-make-visible activate)
25120 "Make the position visible."
25121 (org-bookmark-jump-unhide))))
25123 ;; Make sure saveplace shows the location if it was hidden
25124 (eval-after-load "saveplace"
25125 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25126 "Make the position visible."
25127 (org-bookmark-jump-unhide)))
25129 ;; Make sure ecb shows the location if it was hidden
25130 (eval-after-load "ecb"
25131 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25132 "Make hierarchy visible when jumping into location from ECB tree buffer."
25133 (when (derived-mode-p 'org-mode)
25134 (org-show-context))))
25136 (defun org-bookmark-jump-unhide ()
25137 "Unhide the current position, to show the bookmark location."
25138 (and (derived-mode-p 'org-mode)
25139 (or (outline-invisible-p)
25140 (save-excursion (goto-char (max (point-min) (1- (point))))
25141 (outline-invisible-p)))
25142 (org-show-context 'bookmark-jump)))
25144 (defun org-mark-jump-unhide ()
25145 "Make the point visible with `org-show-context' after jumping to the mark."
25146 (when (and (derived-mode-p 'org-mode)
25147 (outline-invisible-p))
25148 (org-show-context 'mark-goto)))
25150 (eval-after-load "simple"
25151 '(defadvice pop-to-mark-command (after org-make-visible activate)
25152 "Make the point visible with `org-show-context'."
25153 (org-mark-jump-unhide)))
25155 (eval-after-load "simple"
25156 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25157 "Make the point visible with `org-show-context'."
25158 (org-mark-jump-unhide)))
25160 (eval-after-load "simple"
25161 '(defadvice pop-global-mark (after org-make-visible activate)
25162 "Make the point visible with `org-show-context'."
25163 (org-mark-jump-unhide)))
25165 ;; Make session.el ignore our circular variable
25166 (defvar session-globals-exclude)
25167 (eval-after-load "session"
25168 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25170 ;;;; Finish up
25172 (provide 'org)
25174 (run-hooks 'org-load-hook)
25176 ;;; org.el ends here