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.
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/>.
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
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
51 ;; http://orgmode.org/org.html#Installation
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
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
74 (eval-when-compile (require 'gnus-sum
))
78 (require 'format-spec
)
80 (or (eq this-command
'eval-buffer
)
82 (load (concat (file-name-directory load-file-name
)
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
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 snippet?
))
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
)
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
))))
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
))
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)
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.
232 (car (last (org-babel-tangle-file file exported-file
"emacs-lisp")))))
235 (progn (byte-compile-file exported-file
'load
)
236 "Compiled and loaded")
237 (progn (load-file exported-file
) "Loaded"))
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."
252 :set
'org-babel-do-load-languages
254 :type
'(alist :tag
"Babel Languages"
257 (const :tag
"Awk" awk
)
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
)
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
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
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"))
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)"
338 (if (string= org-dir org-install-dir
)
340 (concat "mixed installation! "
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
))
350 (defconst org-version
(org-version))
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.
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.
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
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
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
445 (list org-scheduled-string org-deadline-string org-closed-string
448 " *[[<]\\([^]>]+\\)[]>]")
449 "Matches any of the 4 keywords, together with the time stamp.")
451 (defconst org-keyword-time-not-clock-regexp
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
462 (list org-scheduled-string org-deadline-string org-closed-string
466 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\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.")
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.")
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.
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.")
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.")
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.")
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
633 "Outline-based notes management and organizer."
638 (defcustom org-mode-hook nil
639 "Mode hook for Org mode, run after the mode was turned on."
643 (defcustom org-load-hook nil
644 "Hook that is run after org.el has been loaded."
648 (defcustom org-log-buffer-setup-hook nil
649 "Hook that is run after an Org log buffer is created."
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."
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'."
689 :set
'org-set-modules
691 :package-version
'(Org .
"8.0")
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
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:
770 (setq org-export-registered-backends
773 (let ((name (org-export-backend-name backend)))
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)
784 ((not (load (format \"ox-%s\" backend) t t))
785 (message \"Problems while trying to load export back-end \\=`%s\\='\"
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
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
805 (let ((name (org-export-backend-name backend
)))
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
814 (let ((new-list (mapcar #'org-export-backend-name
815 org-export-registered-backends
)))
816 (dolist (backend val
)
818 ((not (load (format "ox-%s" backend
) t t
))
819 (message "Problems while trying to load export back-end `%s'"
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
)))
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'"
850 (defcustom org-support-shift-select nil
851 "Non-nil means make shift-cursor commands select text when possible.
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."
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"))
921 (defgroup org-startup nil
922 "Options concerning startup of Org mode."
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)
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
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'."
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:
970 :group
'org-structure
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."
1002 :package-version
'(Org .
"8.0")
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:
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:
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"
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"
1048 :package-version
'(Org .
"8.0")
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
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
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
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."
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
))))
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
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."
1140 (defcustom org-closed-keep-when-no-todo nil
1141 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1143 :group
'org-keywords
1145 :package-version
'(Org .
"8.0")
1148 (defgroup org-structure nil
1149 "Options concerning the general structure of Org files."
1150 :tag
"Org Structure"
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
)
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,
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
1208 :group
'org-reveal-location
1210 :package-version
'(Org .
"9.0")
1212 (const :tag
"Canonical" t
)
1213 (const :tag
"Minimal" nil
)
1214 (repeat :greedy t
:tag
"Individual contexts"
1216 (choice :tag
"Context"
1223 (const bookmark-jump
)
1226 (choice :tag
"Detail level"
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'.
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
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
1267 (const :tag
"Never" nil
)
1268 (const :tag
"At beginning of headline stars" t
)
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")
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:
1301 :last-capture-marker
1303 When a key does not show up in the property list, the corresponding bookmark
1305 :group
'org-structure
1308 (defgroup org-cycle nil
1309 "Options concerning visibility cycling in Org mode."
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."
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
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"
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 \
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
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."
1374 (defcustom org-cycle-emulate-tab t
1375 "Where should `org-cycle' emulate TAB.
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."
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
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."
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'."
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'."
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:
1450 :group
'org-edit-structure
1451 :group
'org-appearance
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
1477 :group
'org-edit-structure
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
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
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
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
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
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
1549 (defcustom org-catch-invisible-edits nil
1550 "Check if in invisible region before inserting or deleting a character.
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
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
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
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
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
1600 :group
'org-structure
1603 (const :tag
"Always" t
)
1604 (const :tag
"Never" nil
)
1605 (repeat :greedy t
:tag
"Individual contexts"
1607 (choice :tag
"Context"
1615 (defcustom org-insert-heading-respect-content nil
1616 "Non-nil means insert new headings after the current subtree.
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
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
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
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
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
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
1680 (defcustom org-remove-highlights-with-change t
1681 "Non-nil means any change to the buffer will remove temporary highlights.
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
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
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
1707 :group
'org-sparse-trees
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
1721 (defgroup org-table nil
1722 "Options concerning tables in Org mode."
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
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'."
1753 (const :tag
"off" nil
)
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."
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
1772 (defgroup org-link nil
1773 "Options concerning links in Org mode."
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
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)
1830 :type
'(alist :tag
"Link display parameters"
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."
1837 (cdr (assoc type org-link-parameters
))
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
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."
1879 (string :tag
"Protocol")
1881 (string :tag
"Format")
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
1891 You can interactively set the value of this variable by calling
1892 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1896 (defcustom org-link-file-path-type
'adaptive
1897 "How the path name in file links should be stored.
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."
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."
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."
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"
1962 (defcustom org-url-hexify-p t
1963 "When non-nil, hexify URL when creating a link."
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'.
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
1989 (defcustom org-from-is-user-regexp
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
2001 (defcustom org-context-in-file-links t
2002 "Non-nil means file links from `org-store-link' contain context.
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.
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 \
2027 links more efficient."
2028 :group
'org-link-store
2031 (defgroup org-link-follow nil
2032 "Options concerning following links in Org mode."
2033 :tag
"Org Follow 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
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
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
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
2076 :package-version
'(Org .
"8.3")
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
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
2096 Spaces and statistics cookies are ignored during heading searches."
2097 :group
'org-link-follow
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"
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.
2118 `vm-visit-folder-other-window'
2119 `vm-visit-folder-other-frame'
2120 For Gnus, use any of
2123 `org-gnus-no-new-news'
2124 For FILE, use any of
2126 `find-file-other-window'
2127 `find-file-other-frame'
2128 For Wanderlust use any of
2131 For the calendar, use the variable `calendar-setup'.
2132 For BBDB, it is currently only possible to display the matches in
2134 :group
'org-link-follow
2138 (const vm-visit-folder
)
2139 (const vm-visit-folder-other-window
)
2140 (const vm-visit-folder-other-frame
)))
2141 (cons (const vm-imap
)
2143 (const vm-visit-imap-folder
)
2144 (const vm-visit-imap-folder-other-window
)
2145 (const vm-visit-imap-folder-other-frame
)))
2149 (const gnus-other-frame
)
2150 (const org-gnus-no-new-news
)))
2154 (const find-file-other-window
)
2155 (const find-file-other-frame
)))
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 \
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
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
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
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
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
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
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
2241 (defconst org-file-apps-defaults-gnu
2245 "Default file applications on a UNIX or GNU/Linux system.
2246 See `org-file-apps'.")
2248 (defconst org-file-apps-defaults-macosx
2250 (system .
"open %s")
2252 ("eps.gz" .
"gv %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.
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
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
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
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
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"
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."
2378 :group
'org-link-follow
)
2380 (defgroup org-refile nil
2381 "Options concerning refiling entries in Org mode."
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
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
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."
2409 (defcustom org-goto-interface
'outline
2410 "The default interface to be used for `org-goto'.
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."
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."
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."
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'."
2462 :group
'org-progress
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
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
2482 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
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))'."
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
2532 (defcustom org-refile-use-cache nil
2533 "Non-nil means cache refile targets to speed up the process.
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] \
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."
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."
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
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."
2603 (defgroup org-todo nil
2604 "Options concerning TODO items in Org mode."
2608 (defgroup org-progress nil
2609 "Options concerning Progress logging in Org mode."
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'."
2660 :group
'org-keywords
2662 (repeat :tag
"Old syntax, just keywords"
2663 (string :tag
"Keyword"))
2664 (repeat :tag
"New syntax"
2667 :tag
"Interpretation"
2668 ;;Quick and dirty way to see
2669 ;;`org-todo-interpretations'. This takes the
2670 ;;place of item arguments
2678 org-todo-interpretation-widgets
))
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
2714 :group
'org-keywords
2715 :type
'(choice (const sequence
)
2718 (defcustom org-use-fast-todo-selection t
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
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)."
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
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."
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."
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'."
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
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:
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
)
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
)))
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
)
2840 (add-hook 'org-blocker-hook
2841 'org-block-todo-from-checkboxes
)
2842 (remove-hook 'org-blocker-hook
2843 'org-block-todo-from-checkboxes
)))
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."
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
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."
2875 (cons (choice :tag
"When changing to"
2876 (const :tag
"Not-done state" todo
)
2877 (const :tag
"Done state" done
)
2878 (string :tag
"State"))
2880 (cons :tag
"Tag action"
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
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."
2902 :group
'org-progress
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.
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"
2929 :group
'org-progress
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."
2953 :group
'org-progress
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"
2967 :group
'org-progress
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
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")
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
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.
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."
3005 :group
'org-progress
3006 :type
'(list :greedy t
3007 (cons (const :tag
"Heading when closing an item" done
) string
)
3009 "Heading when changing todo state (todo sequence only)"
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'
3041 You can set the property LOG_INTO_DRAWER to overrule this setting for
3044 Do not check directly this variable in a Lisp program. Call
3045 function `org-log-into-drawer' instead."
3047 :group
'org-progress
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")
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
3078 :group
'org-progress
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"
3090 :group
'org-progress
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."
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."
3124 :group
'org-progress
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"
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
3140 :group
'org-priorities
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
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
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
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
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
3189 (defgroup org-time nil
3190 "Options concerning time stamps and deadlines in Org mode."
3194 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3195 "Number of minutes to round time stamps to.
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."
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
)))
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"
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."
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
))))
3250 (concat "[" (substring f
1 -
1) "]")
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
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
3278 (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
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
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)."
3296 :package-version
'(Org .
"8.0")
3297 :type
'(choice (string :tag
"Format string")
3299 (group :inline t
(const :tag
"Years" :years
)
3300 (string :tag
"Format string"))
3302 (const :tag
"Always show years" :require-years
)
3304 (group :inline t
(const :tag
"Months" :months
)
3305 (string :tag
"Format string"))
3307 (const :tag
"Always show months" :require-months
)
3309 (group :inline t
(const :tag
"Weeks" :weeks
)
3310 (string :tag
"Format string"))
3312 (const :tag
"Always show weeks" :require-weeks
)
3314 (group :inline t
(const :tag
"Days" :days
)
3315 (string :tag
"Format string"))
3317 (const :tag
"Always show days" :require-days
)
3319 (group :inline t
(const :tag
"Hours" :hours
)
3320 (string :tag
"Format string"))
3322 (const :tag
"Always show hours" :require-hours
)
3324 (group :inline t
(const :tag
"Minutes" :minutes
)
3325 (string :tag
"Format string"))
3327 (const :tag
"Always show minutes" :require-minutes
)
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."
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."
3349 :package-version
'(Org .
"8.0")
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
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
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."
3390 :group
'org-agenda-daily
/weekly
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
3401 Custom commands can set this variable in the options section."
3403 :group
'org-agenda-daily
/weekly
3405 :package-version
'(Org .
"8.0")
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
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
3430 See also `org-agenda-jump-prefer-future'."
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'."
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
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."
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."
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."
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 :-)"
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."
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'."
3528 :package-version
'(Org .
"8.0")
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."
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."
3544 (defgroup org-tags nil
3545 "Options concerning tags in Org mode."
3549 (defcustom org-tag-alist nil
3550 "Default tags available in Org files.
3552 The value of this variable is an alist. Associations either:
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.,
3571 See also `org-tag-persistent-alist' to sidestep this behavior."
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:
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:
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
3625 (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
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."
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."
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
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'."
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'."
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'."
3711 :type
'(repeat (string :tag
"Tag")))
3713 (defun org-tag-inherit-p (tag)
3714 "Check if TAG is one that should be inherited."
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
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'."
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."
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"
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
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
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
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
3823 :group
'org-properties
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."
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
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
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
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
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."
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
3909 If the file does not specify a category, then file's base name
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
3925 Entries may be added to this list with `\\[org-agenda-file-to-front]'
3926 and removed with `\\[org-remove-file]'."
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."
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
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."
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."
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
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."
3992 (const :tag
"The standard Emacs diary file" diary-file
)
3993 (file :tag
"Special Org file diary entries")))
3995 (eval-after-load "calendar"
3997 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3998 'org-calendar-goto-agenda
)
3999 (add-hook 'calendar-mode-hook
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."
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 \\=\\[...\\]"
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."
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."
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\"."
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."
4085 :package-version
'(Org .
"9.0")
4088 (defcustom org-preview-latex-process-alist
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"))
4099 :programs
("latex" "dvisvgm")
4100 :description
"dvi > svg"
4101 :message
"you need to install the programs: latex and dvisvgm."
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"))
4109 :programs
("latex" "convert")
4110 :description
"pdf > png"
4111 :message
"you need to install the programs: latex and imagemagick."
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")
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
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':
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."
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."
4186 :package-version
'(Org .
"9.0")
4189 (defun org-format-latex-mathml-available-p ()
4190 "Return t if `org-latex-to-mathml-convert-command' is usable."
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
)
4198 "%j" org-latex-to-mathml-convert-command
)
4199 (file-readable-p org-latex-to-mathml-jar-file
)
4202 (defcustom org-format-latex-header
"\\documentclass{article}
4203 \\usepackage[usenames]{color}
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."
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
)
4237 (defun org-get-packages-alist (var)
4238 "Get the packages alist and make sure it has 3 elements per entry."
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"))
4250 ("" "longtable" nil
)
4253 ("normalem" "ulem" t
)
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
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."
4300 :group
'org-export-latex
4301 :set
'org-set-packages-alist
4302 :get
'org-get-packages-alist
4304 :package-version
'(Org .
"8.3")
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
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'."
4336 :group
'org-export-latex
4337 :set
'org-set-packages-alist
4338 :get
'org-get-packages-alist
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"
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
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
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
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
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
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
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
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
4414 :group
'org-appearance
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
4421 `latex' Highlight LaTeX snippets and environments.
4422 `script' Highlight subscript and superscript.
4423 `entities' Highlight entities."
4424 :group
'org-appearance
4426 :package-version
'(Org .
"8.0")
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
4439 (defcustom org-hide-macro-markers nil
4440 "Non-nil mean font-lock should hide the brackets marking macro calls."
4441 :group
'org-appearance
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
4451 (defcustom org-pretty-entities-include-sub-superscripts t
4452 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4453 :group
'org-appearance
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."
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
)
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
) "-")))
4498 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
4499 (int-to-string nl
) "\\}")))
4502 (concat "\\([" pre
"]\\|^\\)"
4504 "\\([" markers
"]\\)"
4512 "\\([" post
"]\\|$\\)"))
4513 (setq org-verbatim-re
4514 (concat "\\([" pre
"]\\|^\\)"
4516 "\\([" vmarkers
"]\\)"
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
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
4560 You need to reload Org or to restart Emacs after customizing this."
4561 :group
'org-appearance
4562 :set
'org-set-emph-re
4564 :package-version
'(Org .
"8.0")
4567 (string :tag
"Marker character")
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
)
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
4592 (&optional localp no-error-if-not-filep
))
4593 (declare-function iswitchb-read-buffer
4596 default require-match _predicate start matches-set
))
4597 (declare-function org-agenda-change-all-lines
4599 (newhead hdmarker
&optional fixface just-this
))
4600 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4603 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
4604 (declare-function org-agenda-format-item
4606 (extra txt
&optional level category tags dotime
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
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
)
4637 (defun turn-on-orgtbl ()
4638 "Unconditionally turn on `orgtbl-mode'."
4639 (require 'org-table
)
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."
4647 org-enable-table-editor
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
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
)
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
)
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."
4697 (goto-char (or pos
(point)))
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? "
4721 (when (y-or-n-p "Save changed 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
)))
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."
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
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:
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
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."
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."
4806 :group
'org-agenda-skip
4809 (defcustom org-columns-skip-archived-trees t
4810 "Non-nil means ignore archived trees when creating column view."
4812 :group
'org-properties
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."
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
4829 :group
'org-sparse-trees
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:
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
))
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
))))
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
)
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."
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
":")))
4881 ;; Include headline point is currently on.
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)
4892 (org-back-to-heading t
)
4893 (outline-end-of-heading)
4894 (outline-flag-region (point)
4895 (progn (org-end-of-subtree t
) (point))
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))
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:
4938 group 2: The TODO keyword, maybe
4939 group 3: Priority cookie
4940 group 4: True headline
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
4959 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4962 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
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:
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
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:
4981 9 minutes of duration")
4983 (defconst org-stamp-time-of-day-regexp
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>]*?\\)>"
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:
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'."
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."
5074 (setq org-group-tags
(not org-group-tags
))
5075 (cond ((and (derived-mode-p 'org-agenda-mode
)
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
)))
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
)
5115 (setq org-tag-groups-alist
5116 (org-tag-alist-to-groups org-current-tag-alist
))
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
)))
5124 (let ((cat (org-string-nw-p (cdr (assq 'category alist
)))))
5126 (setq-local org-category
(intern cat
))
5127 (setq-local org-file-properties
5128 (org--update-property-plist
5129 "CATEGORY" cat org-file-properties
))))
5131 (let ((column (cdr (assq 'columns alist
))))
5132 (when column
(setq-local org-columns-default-format column
)))
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
))))
5139 (let ((priorities (cdr (assq 'priorities alist
))))
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
))))
5145 (let ((scripts (assq 'scripts alist
)))
5147 (setq-local org-use-sub-superscripts
(cdr scripts
))))
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
)
5167 (sequence-type (car sequence
))
5168 (keywords (cdr sequence
))
5169 (sep (member "|" keywords
))
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
)))
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
))
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
5193 (append '((:startgroup
))
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:]_@#%:]+:\\)\\)?"
5223 org-complex-heading-regexp-format
5224 (concat "^\\(\\*+\\)"
5225 "\\(?: +" org-todo-regexp
"\\)?"
5226 "\\(?: +\\(\\[#.\\]\\)\\)?"
5228 ;; Stats cookies can be stuck to body.
5229 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5231 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5233 "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?"
5235 org-todo-line-tags-regexp
5236 (concat "^\\(\\*+\\)"
5237 "\\(?: +" org-todo-regexp
"\\)?"
5238 "\\(?: +\\(.*?\\)\\)??"
5239 "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?"
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
)))
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]*\\)=\\(.*\\)"
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
))
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
)))))
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
))))
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
)
5312 (if property
(setcdr property value
)
5313 (push (cons 'property value
) alist
)))))
5314 ((equal key
"STARTUP")
5315 (let ((startup (assq 'startup alist
)))
5318 (append (cdr startup
) (org-split-string value
)))
5319 (push (cons 'startup
(org-split-string value
)) alist
))))
5321 (let ((tag-cell (assq 'tags alist
)))
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
)
5335 (org-unbracket-string "\"" "\"" value
)))))
5336 (when (and f
(file-readable-p f
) (not (member f files
)))
5338 (setq default-directory
(file-name-directory f
))
5339 (insert-file-contents f
)
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
)))))))))))))))
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 "\\(?:(\\(.\\))\\)?\\'"))
5358 (dolist (tokens lines
(cdr (nreverse alist
)))
5359 (push '(:newline
) alist
)
5361 (let ((token (pop tokens
)))
5364 (push '(:startgroup
) alist
)
5365 (when (equal (nth 1 tokens
) ":") (setq group-flag t
)))
5367 (push '(:endgroup
) alist
)
5368 (setq group-flag nil
))
5370 (push '(:startgrouptag
) alist
)
5371 (when (equal (nth 1 tokens
) ":") (setq group-flag t
)))
5373 (push '(:endgrouptag
) alist
)
5374 (setq group-flag nil
))
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\"
5396 When optional argument SKIP-KEY is non-nil, skip selection keys
5398 (mapconcat (lambda (token)
5400 (`(:startgroup
) "{")
5402 (`(:startgrouptag
) "[")
5403 (`(:endgrouptag
) "]")
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
))))
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
))
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
))))
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
))
5440 (insert-file-contents file
)
5442 (funcall (if noerror
'message
'error
)
5443 "Cannot read file \"%s\"%s"
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
))))
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."
5463 (if (string-match "(.*)$" x
)
5464 (substring x
0 (match-beginning 0))
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.
5476 (let ((clist (string-to-list (downcase (car e
))))
5477 (used (append new alist
)))
5478 (when (= (car clist
) ?
@)
5480 (while (and clist
(rassoc (car clist
) used
))
5483 (while (rassoc alt used
)
5485 (push (cons (car e
) (or (car clist
) alt
)) 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
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
)
5528 ;; Other stuff we need.
5529 (require 'time-date
)
5530 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5532 (autoload 'easy-menu-add
"easymenu")
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
)
5540 (require 'org-pcomplete
)
5542 (require 'org-footnote
)
5543 (require 'org-macro
)
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:
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
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
))
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)
5617 (setq-local indent-line-function
'org-indent-line
)
5618 (setq-local indent-region-function
'org-indent-region
)
5619 ;; Filling and auto-filling.
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
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
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
5650 align-mode-rules-list
5651 '((org-in-buffer-settings
5652 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5653 (modes .
'(org-mode)))))
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
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
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 '(16)))
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)))
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")
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
5712 (list (face-background 'default
)
5713 (face-background 'org-default
))
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
)
5734 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5736 (if (and past
(< (float-time (time-subtract (current-time) res
)) 0))
5737 (seconds-to-time (- (float-time res
) (* r
60)))
5741 "Return today date, considering `org-extend-today-until'."
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:
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
"]*?"))
5801 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
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
5810 "\\(\\S-\\)\\([_^]\\)\\("
5811 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5813 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5815 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5816 "The regular expression matching a sub- or superscript.")
5818 (defconst org-match-substring-with-braces-regexp
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
" ]"
5839 "[^" org-non-link-chars
" ]\\)>?")
5840 org-link-re-with-space3
5841 (concat "<?" types-re
":"
5842 "\\([^" org-non-link-chars
" ]"
5845 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
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
5857 "\\(" types-re
":\\)?"
5860 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5862 org-bracket-link-analytic-regexp
++
5865 "\\(" (regexp-opt (cons "coderef" (org-link-types)) t
) ":\\)?"
5868 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
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."
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
5889 (substring (match-string 2) 1 -
1)))))
5891 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5892 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
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))))
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
5918 (let ((erc org-emphasis-regexp-components
)
5919 (string "") beg end move s
)
5920 (if (org-region-active-p)
5921 (setq beg
(region-beginning)
5923 string
(buffer-substring beg end
))
5927 (message "Emphasis marker or tag: [%s]"
5928 (mapconcat #'car org-emphasis-alist
""))
5929 (setq char
(read-char-exclusive)))
5930 (if (equal char ?\s
)
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
))
5943 (string-match (concat "[" (nth 0 erc
) "\n]")
5944 (char-to-string (char-before (point)))))
5947 (string-match (concat "[" (nth 1 erc
) "\n]")
5948 (char-to-string (char-after (point)))))
5949 (insert " ") (backward-char 1))
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))
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)
5979 'mouse-face
(or (org-link-get-parameter type
:mouse-face
)
5982 ;; A function that returns a face
5983 ((functionp link-face
)
5984 (funcall link-face path
))
5988 ;; An anonymous face
5995 ((stringp help-echo
)
5997 ((functionp help-echo
)
6002 (org-link-unescape link
)))))
6004 ((functionp htmlize-link
)
6005 (funcall htmlize-link path
))
6008 'keymap
(or (org-link-get-parameter type
:keymap
)
6010 'org-link-start
(match-beginning 0)))
6011 (org-rear-nonsticky-at (match-end 0))
6013 (funcall activate-func link-start link-end path nil
))
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."
6028 :package-version
'(Org .
"8.3")
6029 :group
'org-appearance
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
6038 :group
'org-appearance
)
6040 (defun org-fontify-meta-lines-and-blocks (limit)
6042 (org-fontify-meta-lines-and-blocks-1 limit
)
6043 (error (message "org-mode fontification error in %S at %d"
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]*\\(.*\\)\\)\\)"
6053 (let ((beg (match-beginning 0))
6054 (block-start (match-end 0))
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
)
6062 ((and (match-end 4) (equal dc3
"+begin"))
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))
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
)
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
)))
6088 (add-text-properties beg1
(min (point-max) (1+ end1
))
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-face-text-property
6098 beg1
(min (point-max) (1+ end1
)) 'org-quote t
))
6099 ((string= block-type
"verse")
6100 (add-face-text-property
6101 beg1
(min (point-max) (1+ end1
)) 'org-verse t
)))
6102 (add-text-properties beg beg1
'(face org-block-begin-line
))
6103 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
6104 '(face org-block-end-line
))
6106 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
6107 (org-remove-flyspell-overlays-in
6109 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
6110 (add-text-properties
6112 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
6113 '(font-lock-fontified t invisible t
)
6114 '(font-lock-fontified t face org-document-info-keyword
)))
6115 (add-text-properties
6116 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
6117 (if (string-equal dc1
"+title:")
6118 '(font-lock-fontified t face org-document-title
)
6119 '(font-lock-fontified t face org-document-info
))))
6120 ((string-prefix-p "+caption" dc1
)
6121 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
6122 (remove-text-properties (match-beginning 0) (match-end 0)
6123 '(display t invisible t intangible t
))
6124 ;; Handle short captions.
6127 (looking-at "\\([ \t]*#\\+caption\\(?:\\[.*\\]\\)?:\\)[ \t]*"))
6128 (add-text-properties (line-beginning-position) (match-end 1)
6129 '(font-lock-fontified t face org-meta-line
))
6130 (add-text-properties (match-end 0) (line-end-position)
6131 '(font-lock-fontified t face org-block
))
6133 ((member dc3
'(" " ""))
6134 (org-remove-flyspell-overlays-in beg
(match-end 0))
6135 (add-text-properties
6137 '(font-lock-fontified t face font-lock-comment-face
)))
6138 (t ;; just any other in-buffer setting, but not indented
6139 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6140 (remove-text-properties (match-beginning 0) (match-end 0)
6141 '(display t invisible t intangible t
))
6142 (add-text-properties beg
(match-end 0)
6143 '(font-lock-fontified t face org-meta-line
))
6146 (defun org-fontify-drawers (limit)
6148 (when (re-search-forward org-drawer-regexp limit t
)
6149 (add-text-properties
6150 (match-beginning 0) (match-end 0)
6151 '(font-lock-fontified t face org-special-keyword
))
6152 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6155 (defun org-fontify-macros (limit)
6157 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t
)
6158 (add-text-properties
6159 (match-beginning 0) (match-end 0)
6160 '(font-lock-fontified t face org-macro
))
6161 (when org-hide-macro-markers
6162 (add-text-properties (match-end 2) (match-beginning 2)
6164 (add-text-properties (match-beginning 1) (match-end 1)
6166 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6169 (defun org-activate-angle-links (limit)
6170 "Add text properties for angle links."
6171 (when (and (re-search-forward org-angle-link-re limit t
)
6172 (not (org-in-src-block-p)))
6173 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6174 (add-text-properties (match-beginning 0) (match-end 0)
6175 (list 'mouse-face
'highlight
6176 'keymap org-mouse-map
6177 'font-lock-multiline t
))
6178 (org-rear-nonsticky-at (match-end 0))
6181 (defun org-activate-footnote-links (limit)
6182 "Add text properties for footnotes."
6183 (let ((fn (org-footnote-next-reference-or-definition limit
)))
6185 (let* ((beg (nth 1 fn
))
6188 (referencep (/= (line-beginning-position) beg
)))
6189 (when (and referencep
(nth 3 fn
))
6192 (search-forward (or label
"fn:"))
6193 (org-remove-flyspell-overlays-in beg
(match-end 0))))
6194 (add-text-properties beg end
6195 (list 'mouse-face
'highlight
6196 'keymap org-mouse-map
6198 (if referencep
"Footnote reference"
6199 "Footnote definition")
6200 'font-lock-fontified t
6201 'font-lock-multiline t
6202 'face
'org-footnote
))))))
6204 (defun org-activate-bracket-links (limit)
6205 "Add text properties for bracketed links."
6206 (when (and (re-search-forward org-bracket-link-regexp limit t
)
6207 (not (org-in-src-block-p)))
6208 (let* ((hl (save-match-data
6209 (org-link-expand-abbrev (match-string-no-properties 1))))
6210 (type (save-match-data
6211 (and (string-match org-plain-link-re hl
)
6212 (match-string-no-properties 1 hl
))))
6213 (path (save-match-data
6214 (and (string-match org-plain-link-re hl
)
6215 (match-string-no-properties 2 hl
))))
6216 (link-start (match-beginning 0))
6217 (link-end (match-end 0))
6219 (help-echo (org-link-get-parameter type
:help-echo
))
6221 ((stringp help-echo
)
6223 ((functionp help-echo
)
6228 (org-link-unescape hl
))))))
6229 (link-face (org-link-get-parameter type
:face
))
6231 ;; A function that returns a face
6232 ((functionp link-face
)
6233 (funcall link-face path
))
6237 ;; An anonymous face
6243 (keymap (or (org-link-get-parameter type
:keymap
)
6245 (mouse-face (or (org-link-get-parameter type
:mouse-face
)
6247 (htmlize (org-link-get-parameter type
:htmlize-link
))
6249 ((functionp htmlize
)
6252 `(:uri
,(format "%s:%s" type path
)))))
6253 (activate-func (org-link-get-parameter type
:activate-func
))
6255 (ip (list 'invisible
(or
6256 (org-link-get-parameter type
:display
)
6260 'mouse-face mouse-face
6261 'font-lock-multiline t
6263 'htmlize-link htmlize-link
))
6265 (vp (list 'keymap keymap
6267 'mouse-face mouse-face
6268 'font-lock-multiline t
6270 'htmlize-link htmlize-link
)))
6271 ;; We need to remove the invisible property here. Table narrowing
6272 ;; may have made some of this invisible.
6273 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6274 (remove-text-properties (match-beginning 0) (match-end 0)
6278 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
6279 (org-rear-nonsticky-at (match-beginning 3))
6280 (add-text-properties (match-beginning 3) (match-end 3) vp
)
6281 (org-rear-nonsticky-at (match-end 3))
6282 (add-text-properties (match-end 3) (match-end 0) ip
)
6283 (org-rear-nonsticky-at (match-end 0)))
6284 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
6285 (org-rear-nonsticky-at (match-beginning 1))
6286 (add-text-properties (match-beginning 1) (match-end 1) vp
)
6287 (org-rear-nonsticky-at (match-end 1))
6288 (add-text-properties (match-end 1) (match-end 0) ip
)
6289 (org-rear-nonsticky-at (match-end 0)))
6291 (funcall activate-func link-start link-end path bracketp
))
6294 (defun org-activate-dates (limit)
6295 "Add text properties for dates."
6296 (when (and (re-search-forward org-tsr-regexp-both limit t
)
6297 (not (equal (char-before (match-beginning 0)) 91)))
6298 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6299 (add-text-properties (match-beginning 0) (match-end 0)
6300 (list 'mouse-face
'highlight
6301 'keymap org-mouse-map
))
6302 (org-rear-nonsticky-at (match-end 0))
6303 (when org-display-custom-times
6305 (org-display-custom-time (match-beginning 3) (match-end 3))
6306 (org-display-custom-time (match-beginning 1) (match-end 1))))
6309 (defvar-local org-target-link-regexp nil
6310 "Regular expression matching radio targets in plain text.")
6312 (defconst org-target-regexp
(let ((border "[^<>\n\r \t]"))
6313 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6314 border border border
))
6315 "Regular expression matching a link target.")
6317 (defconst org-radio-target-regexp
(format "<%s>" org-target-regexp
)
6318 "Regular expression matching a radio target.")
6320 (defconst org-any-target-regexp
6321 (format "%s\\|%s" org-radio-target-regexp org-target-regexp
)
6322 "Regular expression matching any target.")
6324 (defun org-activate-target-links (limit)
6325 "Add text properties for target matches."
6326 (when org-target-link-regexp
6327 (let ((case-fold-search t
))
6328 (when (re-search-forward org-target-link-regexp limit t
)
6329 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6330 (add-text-properties (match-beginning 1) (match-end 1)
6331 (list 'mouse-face
'highlight
6332 'keymap org-mouse-map
6333 'help-echo
"Radio target link"
6334 'org-linked-text t
))
6335 (org-rear-nonsticky-at (match-end 1))
6338 (defun org-update-radio-target-regexp ()
6339 "Find all radio targets in this file and update the regular expression.
6340 Also refresh fontification if needed."
6342 (let ((old-regexp org-target-link-regexp
)
6343 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6344 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6346 (org-with-wide-buffer
6347 (goto-char (point-min))
6349 (while (re-search-forward org-radio-target-regexp nil t
)
6350 ;; Make sure point is really within the object.
6352 (let ((obj (org-element-context)))
6353 (when (eq (org-element-type obj
) 'radio-target
)
6354 (cl-pushnew (org-element-property :value obj
) rtn
6357 (setq org-target-link-regexp
6362 (replace-regexp-in-string
6363 " +" "\\s-+" (regexp-quote x
) t t
))
6367 (unless (equal old-regexp org-target-link-regexp
)
6369 (let ((regexp (cond ((not old-regexp
) org-target-link-regexp
)
6370 ((not org-target-link-regexp
) old-regexp
)
6375 (substring re
(length before-re
)
6376 (- (length after-re
))))
6377 (list old-regexp org-target-link-regexp
)
6380 (org-with-wide-buffer
6381 (goto-char (point-min))
6382 (while (re-search-forward regexp nil t
)
6383 (org-element-cache-refresh (match-beginning 1)))))
6384 ;; Re fontify buffer.
6385 (when (memq 'radio org-highlight-links
)
6386 (org-restart-font-lock)))))
6388 (defun org-hide-wide-columns (limit)
6390 (setq s
(text-property-any (point) (or limit
(point-max))
6393 (setq e
(next-single-property-change s
'org-cwidth
))
6394 (add-text-properties s e
'(invisible org-cwidth
))
6398 (defvar org-latex-and-related-regexp nil
6399 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6401 (defun org-compute-latex-and-related-regexp ()
6402 "Compute regular expression for LaTeX, entities and sub/superscript.
6403 Result depends on variable `org-highlight-latex-and-related'."
6405 org-latex-and-related-regexp
6407 (cond ((not (memq 'script org-highlight-latex-and-related
)) nil
)
6408 ((eq org-use-sub-superscripts
'{})
6409 (list org-match-substring-with-braces-regexp
))
6410 (org-use-sub-superscripts (list org-match-substring-regexp
))))
6412 (when (memq 'latex org-highlight-latex-and-related
)
6413 (let ((matchers (plist-get org-format-latex-options
:matchers
)))
6416 (and (member (car x
) matchers
) (nth 1 x
)))
6417 org-latex-regexps
)))))
6419 (when (memq 'entities org-highlight-latex-and-related
)
6420 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6421 (mapconcat 'identity
(append re-latex re-entities re-sub
) "\\|"))))
6423 (defun org-do-latex-and-related (limit)
6424 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6425 LIMIT bounds the search for syntax to highlight. Stop at first
6426 highlighted object, if any. Return t if some highlighting was
6427 done, nil otherwise."
6428 (when (org-string-nw-p org-latex-and-related-regexp
)
6430 (while (re-search-forward org-latex-and-related-regexp limit t
)
6434 (memq f
'(org-code org-verbatim underline org-special-keyword
)))
6436 (goto-char (1+ (match-beginning 0)))
6437 (face-at-point nil t
)))
6438 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6442 (font-lock-prepend-text-property
6443 (+ offset
(match-beginning 0)) (match-end 0)
6444 'face
'org-latex-and-related
)
6445 (add-text-properties (+ offset
(match-beginning 0)) (match-end 0)
6446 '(font-lock-multiline t
)))
6450 (defun org-restart-font-lock ()
6451 "Restart `font-lock-mode', to force refontification."
6452 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
6454 (font-lock-mode 1)))
6456 (defun org-activate-tags (limit)
6457 (when (re-search-forward
6458 "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" limit t
)
6459 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6460 (add-text-properties (match-beginning 1) (match-end 1)
6461 (list 'mouse-face
'highlight
6462 'keymap org-mouse-map
))
6463 (org-rear-nonsticky-at (match-end 1))
6466 (defun org-outline-level ()
6467 "Compute the outline level of the heading at point.
6469 If this is called at a normal headline, the level is the number
6470 of stars. Use `org-reduced-level' to remove the effect of
6471 `org-odd-levels'. Unlike to `org-current-level', this function
6472 takes into consideration inlinetasks."
6473 (org-with-wide-buffer
6475 (if (re-search-backward org-outline-regexp-bol nil t
)
6476 (1- (- (match-end 0) (match-beginning 0)))
6479 (defvar org-font-lock-keywords nil
)
6481 (defsubst org-re-property
(property &optional literal allow-null value
)
6482 "Return a regexp matching a PROPERTY line.
6484 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6485 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6486 non-nil, match properties even without a value.
6488 Match group 3 is set to the value when it exists. If there is no
6489 value and ALLOW-NULL is non-nil, it is set to the empty string.
6491 With optional argument VALUE, match only property lines with
6492 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6493 unless LITERAL is non-nil."
6496 (format "\\(?1::\\(?2:%s\\):\\)"
6497 (if literal property
(regexp-quote property
)))
6499 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6500 (if literal value
(regexp-quote value
))))
6502 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6504 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6506 (defconst org-property-re
6507 (org-re-property "\\S-+" 'literal t
)
6508 "Regular expression matching a property line.
6509 There are four matching groups:
6510 1: :PROPKEY: including the leading and trailing colon,
6511 2: PROPKEY without the leading and trailing colon,
6512 3: PROPVAL without leading or trailing spaces,
6513 4: the indentation of the current line,
6514 5: trailing whitespace.")
6516 (defvar org-font-lock-hook nil
6517 "Functions to be called for special font lock stuff.")
6519 (defvar org-font-lock-extra-keywords nil
) ;Dynamically scoped.
6521 (defvar org-font-lock-set-keywords-hook nil
6522 "Functions that can manipulate `org-font-lock-extra-keywords'.
6523 This is called after `org-font-lock-extra-keywords' is defined, but before
6524 it is installed to be used by font lock. This can be useful if something
6525 needs to be inserted at a specific position in the font-lock sequence.")
6527 (defun org-font-lock-hook (limit)
6528 "Run `org-font-lock-hook' within LIMIT."
6529 (run-hook-with-args 'org-font-lock-hook limit
))
6531 (defun org-set-font-lock-defaults ()
6532 "Set font lock defaults for the current buffer."
6533 (let* ((em org-fontify-emphasized-text
)
6534 (lk org-highlight-links
)
6535 (org-font-lock-extra-keywords
6538 '(org-font-lock-hook)
6540 `(,(if org-fontify-whole-heading-line
6541 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6542 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6543 (1 (org-get-level-face 1))
6544 (2 (org-get-level-face 2))
6545 (3 (org-get-level-face 3)))
6547 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6550 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6551 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6552 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6553 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6555 '(org-fontify-drawers)
6557 (list org-property-re
6558 '(1 'org-special-keyword t
)
6559 '(3 'org-property-value t
))
6561 (when (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6562 (when (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6563 (when (memq 'plain lk
) '(org-activate-plain-links (0 'org-link
)))
6564 (when (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link
)))
6565 (when (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6566 (when (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6567 (when (memq 'footnote lk
) '(org-activate-footnote-links))
6569 (list org-any-target-regexp
'(0 'org-target t
))
6571 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6573 '(org-fontify-macros)
6574 '(org-hide-wide-columns (0 nil append
))
6576 (list (format org-heading-keyword-regexp-format
6578 '(2 (org-get-todo-face 2) t
))
6580 (if org-fontify-done-headline
6581 (list (format org-heading-keyword-regexp-format
6584 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6586 '(2 'org-headline-done t
))
6589 '(org-font-lock-add-priority-faces)
6591 '(org-font-lock-add-tag-faces)
6593 (when (and org-group-tags org-tag-groups-alist
)
6594 (list (concat org-outline-regexp-bol
".+\\(:"
6595 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6597 '(1 'org-tag-group prepend
)))
6599 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6600 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6601 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6602 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6604 (when em
'(org-do-emphasis-faces))
6606 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6607 1 'org-checkbox prepend
)
6608 (when (cdr (assq 'checkbox org-list-automatic-rules
))
6609 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6610 (0 (org-get-checkbox-statistics-face) t
)))
6611 ;; Description list items
6612 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6613 1 'org-list-dt prepend
)
6614 ;; ARCHIVEd headings
6616 org-outline-regexp-bol
6617 "\\(.*:" org-archive-tag
":.*\\)")
6618 '(1 'org-archived prepend
))
6620 '(org-do-latex-and-related)
6621 '(org-fontify-entities)
6622 '(org-raise-scripts)
6624 '(org-activate-code (1 'org-code t
))
6627 "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6630 '(9 'org-special-keyword t
))
6631 ;; Blocks and meta lines
6632 '(org-fontify-meta-lines-and-blocks))))
6633 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6634 (run-hooks 'org-font-lock-set-keywords-hook
)
6635 ;; Now set the full font-lock-keywords
6636 (setq-local org-font-lock-keywords org-font-lock-extra-keywords
)
6637 (setq-local font-lock-defaults
6638 '(org-font-lock-keywords t nil nil backward-paragraph
))
6639 (kill-local-variable 'font-lock-keywords
)
6642 (defun org-toggle-pretty-entities ()
6643 "Toggle the composition display of entities as UTF8 characters."
6645 (setq-local org-pretty-entities
(not org-pretty-entities
))
6646 (org-restart-font-lock)
6647 (if org-pretty-entities
6648 (message "Entities are now displayed as UTF8 characters")
6651 (decompose-region (point-min) (point-max))
6652 (message "Entities are now displayed as plain text"))))
6654 (defvar-local org-custom-properties-overlays nil
6655 "List of overlays used for custom properties.")
6657 (defun org-toggle-custom-properties-visibility ()
6658 "Display or hide properties in `org-custom-properties'."
6660 (if org-custom-properties-overlays
6661 (progn (mapc #'delete-overlay org-custom-properties-overlays
)
6662 (setq org-custom-properties-overlays nil
))
6663 (when org-custom-properties
6664 (org-with-wide-buffer
6665 (goto-char (point-min))
6666 (let ((regexp (org-re-property (regexp-opt org-custom-properties
) t t
)))
6667 (while (re-search-forward regexp nil t
)
6668 (let ((end (cdr (save-match-data (org-get-property-block)))))
6669 (when (and end
(< (point) end
))
6670 ;; Hide first custom property in current drawer.
6671 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6672 (overlay-put o
'invisible t
)
6673 (overlay-put o
'org-custom-property t
)
6674 (push o org-custom-properties-overlays
))
6675 ;; Hide additional custom properties in the same drawer.
6676 (while (re-search-forward regexp end t
)
6677 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6678 (overlay-put o
'invisible t
)
6679 (overlay-put o
'org-custom-property t
)
6680 (push o org-custom-properties-overlays
)))))
6681 ;; Each entry is limited to a single property drawer.
6682 (outline-next-heading)))))))
6684 (defun org-fontify-entities (limit)
6685 "Find an entity to fontify."
6687 (when org-pretty-entities
6689 ;; "\_ "-family is left out on purpose. Only the first one,
6690 ;; i.e., "\_ ", could be fontified anyway, and it would be
6691 ;; confusing when adding a second white space character.
6692 (while (re-search-forward
6693 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6695 (when (and (not (org-at-comment-p))
6696 (setq ee
(org-entity-get (match-string 1)))
6697 (= (length (nth 6 ee
)) 1))
6698 (let* ((end (if (equal (match-string 2) "{}")
6701 (add-text-properties
6702 (match-beginning 0) end
6703 (list 'font-lock-fontified t
))
6704 (compose-region (match-beginning 0) end
6710 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6711 "Fontify string S like in Org mode."
6714 (let ((org-odd-levels-only odd-levels
))
6716 (org-font-lock-ensure)
6722 (defun org-get-level-face (n)
6723 "Get the right face for match N in font-lock matching of headlines."
6724 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6725 (when org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6726 (if org-cycle-level-faces
6727 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6728 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6730 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6732 (t (unless org-level-color-stars-only org-f
))))
6734 (defun org-face-from-face-or-color (context inherit face-or-color
)
6735 "Create a face list that inherits INHERIT, but sets the foreground color.
6736 When FACE-OR-COLOR is not a string, just return it."
6737 (if (stringp face-or-color
)
6738 (list :inherit inherit
6739 (cdr (assoc context org-faces-easy-properties
))
6743 (defun org-get-todo-face (kwd)
6744 "Get the right face for a TODO keyword KWD.
6745 If KWD is a number, get the corresponding match group."
6746 (when (numberp kwd
) (setq kwd
(match-string kwd
)))
6747 (or (org-face-from-face-or-color
6748 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6749 (and (member kwd org-done-keywords
) 'org-done
)
6752 (defun org-get-priority-face (priority)
6753 "Get the right face for PRIORITY.
6754 PRIORITY is a character."
6755 (or (org-face-from-face-or-color
6756 'priority
'org-priority
(cdr (assq priority org-priority-faces
)))
6759 (defun org-get-tag-face (tag)
6760 "Get the right face for TAG.
6761 If TAG is a number, get the corresponding match group."
6762 (let ((tag (if (wholenump tag
) (match-string tag
) tag
)))
6763 (or (org-face-from-face-or-color
6764 'tag
'org-tag
(cdr (assoc tag org-tag-faces
)))
6767 (defun org-font-lock-add-priority-faces (limit)
6768 "Add the special priority faces."
6769 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t
)
6770 (add-text-properties
6771 (match-beginning 1) (match-end 1)
6772 (list 'face
(org-get-priority-face (string-to-char (match-string 2)))
6773 'font-lock-fontified t
))))
6775 (defun org-font-lock-add-tag-faces (limit)
6776 "Add the special tag faces."
6777 (when (and org-tag-faces org-tags-special-faces-re
)
6778 (while (re-search-forward org-tags-special-faces-re limit t
)
6779 (add-text-properties (match-beginning 1) (match-end 1)
6780 (list 'face
(org-get-tag-face 1)
6781 'font-lock-fontified t
))
6782 (backward-char 1))))
6784 (defun org-unfontify-region (beg end
&optional _maybe_loudly
)
6785 "Remove fontification and activation overlays from links."
6786 (font-lock-default-unfontify-region beg end
)
6787 (let* ((buffer-undo-list t
)
6788 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
6789 (inhibit-modification-hooks t
)
6790 deactivate-mark buffer-file-name buffer-file-truename
)
6791 (decompose-region beg end
)
6792 (remove-text-properties beg end
6793 '(mouse-face t keymap t org-linked-text t
6794 invisible t intangible t
6796 (org-remove-font-lock-display-properties beg end
)))
6798 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
6799 ((raise 0.3) (height 0.7))
6802 "Display properties for showing superscripts and subscripts.")
6804 (defun org-remove-font-lock-display-properties (beg end
)
6805 "Remove specific display properties that have been added by font lock.
6806 The will remove the raise properties that are used to show superscripts
6810 (setq next
(next-single-property-change beg
'display nil end
)
6811 prop
(get-text-property beg
'display
))
6812 (when (member prop org-script-display
)
6813 (put-text-property beg next
'display nil
))
6816 (defun org-raise-scripts (limit)
6817 "Add raise properties to sub/superscripts."
6818 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
6820 (if (eq org-use-sub-superscripts t
)
6821 org-match-substring-regexp
6822 org-match-substring-with-braces-regexp
)
6824 (let* ((pos (point)) table-p comment-p
6825 (mpos (match-beginning 3))
6826 (emph-p (get-text-property mpos
'org-emphasis
))
6827 (link-p (get-text-property mpos
'mouse-face
))
6828 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
6829 (goto-char (point-at-bol))
6830 (setq table-p
(looking-at-p org-table-dataline-regexp
)
6831 comment-p
(looking-at-p "^[ \t]*#[ +]"))
6834 (when (member (char-after) '(?_ ?^
)) (goto-char (1- pos
)))
6835 (unless (or comment-p emph-p link-p keyw-p
)
6836 (put-text-property (match-beginning 3) (match-end 0)
6838 (if (equal (char-after (match-beginning 2)) ?^
)
6839 (nth (if table-p
3 1) org-script-display
)
6840 (nth (if table-p
2 0) org-script-display
)))
6841 (add-text-properties (match-beginning 2) (match-end 2)
6843 'org-dwidth t
'org-dwidth-n
1))
6844 (if (and (eq (char-after (match-beginning 3)) ?
{)
6845 (eq (char-before (match-end 3)) ?
}))
6847 (add-text-properties
6848 (match-beginning 3) (1+ (match-beginning 3))
6849 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
6850 (add-text-properties
6851 (1- (match-end 3)) (match-end 3)
6852 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1)))))
6855 ;;;; Visibility cycling, including org-goto and indirect buffer
6859 (defvar-local org-cycle-global-status nil
)
6860 (put 'org-cycle-global-status
'org-state t
)
6861 (defvar-local org-cycle-subtree-status nil
)
6862 (put 'org-cycle-subtree-status
'org-state t
)
6864 (defvar org-inlinetask-min-level
)
6866 (defun org-unlogged-message (&rest args
)
6867 "Display a message, but avoid logging it in the *Messages* buffer."
6868 (let ((message-log-max nil
))
6869 (apply 'message args
)))
6872 (defun org-cycle (&optional arg
)
6873 "TAB-action and visibility cycling for Org mode.
6875 This is the command invoked in Org mode by the `TAB' key. Its main
6876 purpose is outline visibility cycling, but it also invokes other actions
6877 in special contexts.
6879 When this function is called with a `\\[universal-argument]' prefix, rotate \
6881 buffer through 3 states (global cycling)
6882 1. OVERVIEW: Show only top-level headlines.
6883 2. CONTENTS: Show all headlines of all levels, but no body text.
6884 3. SHOW ALL: Show everything.
6886 With a `\\[universal-argument] \\[universal-argument]' prefix argument, \
6887 switch to the startup visibility,
6888 determined by the variable `org-startup-folded', and by any VISIBILITY
6889 properties in the buffer.
6891 With a `\\[universal-argument] \\[universal-argument] \
6892 \\[universal-argument]' prefix argument, show the entire buffer, including
6895 When inside a table, re-align the table and move to the next field.
6897 When point is at the beginning of a headline, rotate the subtree started
6898 by this line through 3 different states (local cycling)
6899 1. FOLDED: Only the main headline is shown.
6900 2. CHILDREN: The main headline and the direct children are shown.
6901 From this state, you can move to one of the children
6902 and zoom in further.
6903 3. SUBTREE: Show the entire subtree, including body text.
6904 If there is no subtree, switch directly from CHILDREN to FOLDED.
6906 When point is at the beginning of an empty headline and the variable
6907 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6908 of the headline by demoting and promoting it to likely levels. This
6909 speeds up creation document structure by pressing `TAB' once or several
6910 times right after creating a new headline.
6912 When there is a numeric prefix, go up to a heading with level ARG, do
6913 a `show-subtree' and return to the previous cursor position. If ARG
6914 is negative, go up that many levels.
6916 When point is not at the beginning of a headline, execute the global
6917 binding for `TAB', which is re-indenting the line. See the option
6918 `org-cycle-emulate-tab' for details.
6920 As a special case, if point is at the beginning of the buffer and there is
6921 no headline in line 1, this function will act as if called with prefix arg
6922 \(`\\[universal-argument] TAB', same as `S-TAB') also when called without \
6923 prefix arg, but only
6924 if the variable `org-cycle-global-at-bob' is t."
6926 (org-load-modules-maybe)
6927 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
6928 (and org-cycle-level-after-item
/entry-creation
6929 (or (org-cycle-level)
6930 (org-cycle-item-indentation))))
6932 (or org-cycle-max-level
6933 (and (boundp 'org-inlinetask-min-level
)
6934 org-inlinetask-min-level
6935 (1- org-inlinetask-min-level
))))
6936 (nstars (and limit-level
6937 (if org-odd-levels-only
6938 (and limit-level
(1- (* limit-level
2)))
6941 (if (not (derived-mode-p 'org-mode
))
6943 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
6944 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
6945 (not (looking-at org-outline-regexp
))))
6948 (delq 'org-optimize-window-after-visibility-change
6949 (copy-sequence org-cycle-hook
))
6956 (setq last-command
'dummy
)
6957 (org-set-startup-visibility)
6958 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6962 (org-unlogged-message "Entire buffer visible, including drawers"))
6964 ((equal arg
'(4)) (org-cycle-internal-global))
6966 ;; Try hiding block at point.
6967 ((org-hide-block-toggle-maybe))
6969 ;; Try cdlatex TAB completion
6970 ((org-try-cdlatex-tab))
6972 ;; Table: enter it or move to the next field.
6973 ((org-at-table-p 'any
)
6974 (if (org-at-table.el-p
)
6975 (message "%s" (substitute-command-keys "\\<org-mode-map>\
6976 Use `\\[org-edit-special]' to edit table.el tables"))
6977 (if arg
(org-table-edit-field t
)
6978 (org-table-justify-field-maybe)
6979 (call-interactively 'org-table-next-field
))))
6981 ((run-hook-with-args-until-success 'org-tab-after-check-for-table-hook
))
6983 ;; Global cycling: delegate to `org-cycle-internal-global'.
6984 (bob-special (org-cycle-internal-global))
6986 ;; Drawers: delegate to `org-flag-drawer'.
6988 (beginning-of-line 1)
6989 (looking-at org-drawer-regexp
))
6990 (org-flag-drawer ; toggle block visibility
6991 (not (get-char-property (match-end 0) 'invisible
))))
6993 ;; Show-subtree, ARG levels up from here.
6996 (org-back-to-heading)
6997 (outline-up-heading (if (< arg
0) (- arg
)
6998 (- (funcall outline-level
) arg
)))
6999 (org-show-subtree)))
7001 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
7002 ((and (featurep 'org-inlinetask
)
7003 (org-inlinetask-at-task-p)
7004 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
7005 (org-inlinetask-toggle-visibility))
7007 ;; At an item/headline: delegate to `org-cycle-internal-local'.
7008 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
7009 (save-excursion (move-beginning-of-line 1)
7010 (looking-at org-outline-regexp
)))
7011 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
7012 (org-cycle-internal-local))
7014 ;; From there: TAB emulation and template completion.
7015 (buffer-read-only (org-back-to-heading))
7017 ((run-hook-with-args-until-success
7018 'org-tab-after-check-for-cycling-hook
))
7020 ((org-try-structure-completion))
7022 ((run-hook-with-args-until-success
7023 'org-tab-before-tab-emulation-hook
))
7025 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
7027 (not (looking-at org-outline-regexp
))))
7028 (call-interactively (global-key-binding "\t")))
7030 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
7031 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
7032 (or (and (eq org-cycle-emulate-tab
'white
)
7033 (= (match-end 0) (point-at-eol)))
7034 (and (eq org-cycle-emulate-tab
'whitestart
)
7035 (>= (match-end 0) pos
))))
7037 (eq org-cycle-emulate-tab t
))
7038 (call-interactively (global-key-binding "\t")))
7041 (org-back-to-heading)
7044 (defun org-cycle-internal-global ()
7045 "Do the global cycling action."
7046 ;; Hack to avoid display of messages for .org attachments in Gnus
7047 (let ((ga (string-match "\\*fontification" (buffer-name))))
7049 ((and (eq last-command this-command
)
7050 (eq org-cycle-global-status
'overview
))
7051 ;; We just created the overview - now do table of contents
7052 ;; This can be slow in very large buffers, so indicate action
7053 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
7054 (unless ga
(org-unlogged-message "CONTENTS..."))
7056 (unless ga
(org-unlogged-message "CONTENTS...done"))
7057 (setq org-cycle-global-status
'contents
)
7058 (run-hook-with-args 'org-cycle-hook
'contents
))
7060 ((and (eq last-command this-command
)
7061 (eq org-cycle-global-status
'contents
))
7062 ;; We just showed the table of contents - now show everything
7063 (run-hook-with-args 'org-pre-cycle-hook
'all
)
7065 (unless ga
(org-unlogged-message "SHOW ALL"))
7066 (setq org-cycle-global-status
'all
)
7067 (run-hook-with-args 'org-cycle-hook
'all
))
7070 ;; Default action: go to overview
7071 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
7073 (unless ga
(org-unlogged-message "OVERVIEW"))
7074 (setq org-cycle-global-status
'overview
)
7075 (run-hook-with-args 'org-cycle-hook
'overview
)))))
7077 (defvar org-called-with-limited-levels nil
7078 "Non-nil when `org-with-limited-levels' is currently active.")
7080 (defun org-cycle-internal-local ()
7081 "Do the local cycling action."
7082 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
7083 ;; First, determine end of headline (EOH), end of subtree or item
7084 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
7089 (setq struct
(org-list-struct))
7090 (setq eoh
(point-at-eol))
7091 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
7092 (setq has-children
(org-list-has-child-p (point) struct
)))
7093 (org-back-to-heading)
7094 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
7095 (setq eos
(save-excursion (org-end-of-subtree t t
)
7096 (when (bolp) (backward-char)) (point)))
7099 (let ((level (funcall outline-level
)))
7100 (outline-next-heading)
7101 (and (org-at-heading-p t
)
7102 (> (funcall outline-level
) level
))))
7104 (org-list-search-forward (org-item-beginning-re) eos t
)))))
7105 ;; Determine end invisible part of buffer (EOL)
7106 (beginning-of-line 2)
7107 (while (and (not (eobp)) ;This is like `next-line'.
7108 (get-char-property (1- (point)) 'invisible
))
7109 (goto-char (next-single-char-property-change (point) 'invisible
))
7110 (and (eolp) (beginning-of-line 2)))
7112 ;; Find out what to do next and set `this-command'
7115 ;; Nothing is hidden behind this heading
7116 (unless (org-before-first-heading-p)
7117 (run-hook-with-args 'org-pre-cycle-hook
'empty
))
7118 (org-unlogged-message "EMPTY ENTRY")
7119 (setq org-cycle-subtree-status nil
)
7122 (outline-next-heading)
7123 (when (outline-invisible-p) (org-flag-heading nil
))))
7124 ((and (or (>= eol eos
)
7125 (not (string-match "\\S-" (buffer-substring eol eos
))))
7127 (not (setq children-skipped
7128 org-cycle-skip-children-state-if-no-children
))))
7129 ;; Entire subtree is hidden in one line: children view
7130 (unless (org-before-first-heading-p)
7131 (run-hook-with-args 'org-pre-cycle-hook
'children
))
7133 (org-list-set-item-visibility (point-at-bol) struct
'children
)
7135 (org-with-limited-levels (org-show-children))
7136 ;; FIXME: This slows down the func way too much.
7137 ;; How keep drawers hidden in subtree anyway?
7138 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
7139 ;; (org-cycle-hide-drawers 'subtree))
7141 ;; Fold every list in subtree to top-level items.
7142 (when (eq org-cycle-include-plain-lists
'integrate
)
7144 (org-back-to-heading)
7145 (while (org-list-search-forward (org-item-beginning-re) eos t
)
7146 (beginning-of-line 1)
7147 (let* ((struct (org-list-struct))
7148 (prevs (org-list-prevs-alist struct
))
7149 (end (org-list-get-bottom-point struct
)))
7150 (dolist (e (org-list-get-all-items (point) struct prevs
))
7151 (org-list-set-item-visibility e struct
'folded
))
7152 (goto-char (if (< end eos
) end eos
)))))))
7153 (org-unlogged-message "CHILDREN")
7156 (outline-next-heading)
7157 (when (outline-invisible-p) (org-flag-heading nil
)))
7158 (setq org-cycle-subtree-status
'children
)
7159 (unless (org-before-first-heading-p)
7160 (run-hook-with-args 'org-cycle-hook
'children
)))
7161 ((or children-skipped
7162 (and (eq last-command this-command
)
7163 (eq org-cycle-subtree-status
'children
)))
7164 ;; We just showed the children, or no children are there,
7165 ;; now show everything.
7166 (unless (org-before-first-heading-p)
7167 (run-hook-with-args 'org-pre-cycle-hook
'subtree
))
7168 (outline-flag-region eoh eos nil
)
7169 (org-unlogged-message
7170 (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
7171 (setq org-cycle-subtree-status
'subtree
)
7172 (unless (org-before-first-heading-p)
7173 (run-hook-with-args 'org-cycle-hook
'subtree
)))
7175 ;; Default action: hide the subtree.
7176 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
7177 (outline-flag-region eoh eos t
)
7178 (org-unlogged-message "FOLDED")
7179 (setq org-cycle-subtree-status
'folded
)
7180 (unless (org-before-first-heading-p)
7181 (run-hook-with-args 'org-cycle-hook
'folded
))))))
7184 (defun org-global-cycle (&optional arg
)
7185 "Cycle the global visibility. For details see `org-cycle'.
7186 With `\\[universal-argument]' prefix ARG, switch to startup visibility.
7187 With a numeric prefix, show all headlines up to that level."
7189 (let ((org-cycle-include-plain-lists
7190 (if (derived-mode-p 'org-mode
) org-cycle-include-plain-lists nil
)))
7194 (outline-hide-sublevels arg
)
7195 (setq org-cycle-global-status
'contents
))
7197 (org-set-startup-visibility)
7198 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
7200 (org-cycle '(4))))))
7202 (defun org-set-startup-visibility ()
7203 "Set the visibility required by startup options and properties."
7205 ((eq org-startup-folded t
)
7207 ((eq org-startup-folded
'content
)
7209 ((or (eq org-startup-folded
'showeverything
)
7210 (eq org-startup-folded nil
))
7211 (outline-show-all)))
7212 (unless (eq org-startup-folded
'showeverything
)
7213 (when org-hide-block-startup
(org-hide-block-all))
7214 (org-set-visibility-according-to-property 'no-cleanup
)
7215 (org-cycle-hide-archived-subtrees 'all
)
7216 (org-cycle-hide-drawers 'all
)
7217 (org-cycle-show-empty-lines t
)))
7219 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
7220 "Switch subtree visibilities according to :VISIBILITY: property."
7222 (org-with-wide-buffer
7223 (goto-char (point-min))
7224 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t
)
7225 (if (not (org-at-property-p)) (outline-next-heading)
7226 (let ((state (match-string 3)))
7228 (org-back-to-heading t
)
7229 (outline-hide-subtree)
7232 ((equal state
"folded")
7233 (outline-hide-subtree))
7234 ((equal state
"children")
7235 (org-show-hidden-entry)
7236 (org-show-children))
7237 ((equal state
"content")
7240 (org-narrow-to-subtree)
7242 ((member state
'("all" "showall"))
7243 (outline-show-subtree)))))))
7245 (org-cycle-hide-archived-subtrees 'all
)
7246 (org-cycle-hide-drawers 'all
)
7247 (org-cycle-show-empty-lines 'all
))))
7249 ;; This function uses outline-regexp instead of the more fundamental
7250 ;; org-outline-regexp so that org-cycle-global works outside of Org
7251 ;; buffers, where outline-regexp is needed.
7252 (defun org-overview ()
7253 "Switch to overview mode, showing only top-level headlines.
7254 This shows all headlines with a level equal or greater than the level
7255 of the first headline in the buffer. This is important, because if the
7256 first headline is not level one, then (hide-sublevels 1) gives confusing
7262 (goto-char (point-min))
7263 (when (re-search-forward (concat "^" outline-regexp
) nil t
)
7264 (goto-char (match-beginning 0))
7265 (funcall outline-level
)))))
7266 (and level
(outline-hide-sublevels level
)))))
7268 (defun org-content (&optional arg
)
7269 "Show all headlines in the buffer, like a table of contents.
7270 With numerical argument N, show content up to level N."
7274 ;; Visit all headings and show their offspring
7275 (and (integerp arg
) (org-overview))
7276 (goto-char (point-max))
7278 (while (and (progn (condition-case nil
7279 (outline-previous-visible-heading 1)
7280 (error (goto-char (point-min))))
7282 (looking-at org-outline-regexp
))
7284 (org-show-children (1- arg
))
7285 (outline-show-branches))
7286 (when (bobp) (throw 'exit nil
))))))
7288 (defun org-optimize-window-after-visibility-change (state)
7289 "Adjust the window after a change in outline visibility.
7290 This function is the default value of the hook `org-cycle-hook'."
7291 (when (get-buffer-window (current-buffer))
7293 ((eq state
'content
) nil
)
7294 ((eq state
'all
) nil
)
7295 ((eq state
'folded
) nil
)
7296 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
7297 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
7299 (defun org-remove-empty-overlays-at (pos)
7300 "Remove outline overlays that do not contain non-white stuff."
7301 (dolist (o (overlays-at pos
))
7302 (and (eq 'outline
(overlay-get o
'invisible
))
7303 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
7305 (delete-overlay o
))))
7307 (defun org-clean-visibility-after-subtree-move ()
7308 "Fix visibility issues after moving a subtree."
7309 ;; First, find a reasonable region to look at:
7310 ;; Start two siblings above, end three below
7311 (let* ((beg (save-excursion
7312 (and (org-get-last-sibling)
7313 (org-get-last-sibling))
7315 (end (save-excursion
7316 (and (org-get-next-sibling)
7317 (org-get-next-sibling)
7318 (org-get-next-sibling))
7319 (if (org-at-heading-p)
7322 (level (looking-at "\\*+"))
7323 (re (when level
(concat "^" (regexp-quote (match-string 0)) " "))))
7326 (narrow-to-region beg end
)
7328 ;; Properly fold already folded siblings
7329 (goto-char (point-min))
7330 (while (re-search-forward re nil t
)
7331 (when (and (not (outline-invisible-p))
7333 (goto-char (point-at-eol)) (outline-invisible-p)))
7334 (outline-hide-entry))))
7335 (org-cycle-show-empty-lines 'overview
)
7336 (org-cycle-hide-drawers 'overview
)))))
7338 (defun org-cycle-show-empty-lines (state)
7339 "Show empty lines above all visible headlines.
7340 The region to be covered depends on STATE when called through
7341 `org-cycle-hook'. Lisp program can use t for STATE to get the
7342 entire buffer covered. Note that an empty line is only shown if there
7343 are at least `org-cycle-separator-lines' empty lines before the headline."
7344 (when (/= org-cycle-separator-lines
0)
7346 (let* ((n (abs org-cycle-separator-lines
))
7348 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
7349 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7350 (t (let ((ns (number-to-string (- n
2))))
7351 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
7352 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7355 ((memq state
'(overview contents t
))
7356 (setq beg
(point-min) end
(point-max)))
7357 ((memq state
'(children folded
))
7359 end
(progn (org-end-of-subtree t t
)
7360 (line-beginning-position 2)))))
7363 (while (re-search-forward re end t
)
7364 (unless (get-char-property (match-end 1) 'invisible
)
7365 (let ((e (match-end 1))
7366 (b (if (>= org-cycle-separator-lines
0)
7369 (goto-char (match-beginning 0))
7370 (skip-chars-backward " \t\n")
7371 (line-end-position)))))
7372 (outline-flag-region b e nil
))))))))
7373 ;; Never hide empty lines at the end of the file.
7375 (goto-char (point-max))
7376 (outline-previous-heading)
7377 (outline-end-of-heading)
7378 (when (and (looking-at "[ \t\n]+")
7379 (= (match-end 0) (point-max)))
7380 (outline-flag-region (point) (match-end 0) nil
))))
7382 (defun org-show-empty-lines-in-parent ()
7383 "Move to the parent and re-show empty lines before visible headlines."
7385 (let ((context (if (org-up-heading-safe) 'children
'overview
)))
7386 (org-cycle-show-empty-lines context
))))
7388 (defun org-files-list ()
7389 "Return `org-agenda-files' list, plus all open Org files.
7390 This is useful for operations that need to scan all of a user's
7391 open and agenda-wise Org files."
7392 (let ((files (mapcar 'expand-file-name
(org-agenda-files))))
7393 (dolist (buf (buffer-list))
7394 (with-current-buffer buf
7395 (when (and (derived-mode-p 'org-mode
) (buffer-file-name))
7396 (cl-pushnew (expand-file-name (buffer-file-name)) files
))))
7399 (defsubst org-entry-beginning-position
()
7400 "Return the beginning position of the current entry."
7401 (save-excursion (org-back-to-heading t
) (point)))
7403 (defsubst org-entry-end-position
()
7404 "Return the end position of the current entry."
7405 (save-excursion (outline-next-heading) (point)))
7407 (defun org-cycle-hide-drawers (state &optional exceptions
)
7408 "Re-hide all drawers after a visibility state change.
7409 When non-nil, optional argument EXCEPTIONS is a list of strings
7410 specifying which drawers should not be hidden."
7411 (when (and (derived-mode-p 'org-mode
)
7412 (not (memq state
'(overview folded contents
))))
7414 (let* ((globalp (memq state
'(contents all
)))
7415 (beg (if globalp
(point-min) (point)))
7416 (end (if globalp
(point-max)
7417 (if (eq state
'children
)
7418 (save-excursion (outline-next-heading) (point))
7419 (org-end-of-subtree t
)))))
7421 (while (re-search-forward org-drawer-regexp
(max end
(point)) t
)
7422 (unless (member-ignore-case (match-string 1) exceptions
)
7423 (let ((drawer (org-element-at-point)))
7424 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7425 (org-flag-drawer t drawer
)
7426 ;; Make sure to skip drawer entirely or we might flag
7427 ;; it another time when matching its ending line with
7428 ;; `org-drawer-regexp'.
7429 (goto-char (org-element-property :end drawer
))))))))))
7431 (defun org-flag-drawer (flag &optional element
)
7432 "When FLAG is non-nil, hide the drawer we are at.
7433 Otherwise make it visible. When optional argument ELEMENT is
7434 a parsed drawer, as returned by `org-element-at-point', hide or
7435 show that drawer instead."
7436 (let ((drawer (or element
7437 (and (save-excursion
7439 (looking-at-p org-drawer-regexp
))
7440 (org-element-at-point)))))
7441 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7442 (let ((post (org-element-property :post-affiliated drawer
)))
7444 (outline-flag-region
7445 (progn (goto-char post
) (line-end-position))
7446 (progn (goto-char (org-element-property :end drawer
))
7447 (skip-chars-backward " \r\t\n")
7448 (line-end-position))
7450 ;; When the drawer is hidden away, make sure point lies in
7451 ;; a visible part of the buffer.
7452 (when (and flag
(> (line-beginning-position) post
))
7453 (goto-char post
))))))
7455 (defun org-subtree-end-visible-p ()
7456 "Is the end of the current subtree visible?"
7457 (pos-visible-in-window-p
7458 (save-excursion (org-end-of-subtree t
) (point))))
7460 (defun org-first-headline-recenter ()
7461 "Move cursor to the first headline and recenter the headline."
7462 (let ((window (get-buffer-window)))
7464 (goto-char (point-min))
7465 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
7466 (set-window-start window
(line-beginning-position))))))
7468 ;;; Saving and restoring visibility
7470 (defun org-outline-overlay-data (&optional use-markers
)
7471 "Return a list of the locations of all outline overlays.
7472 These are overlays with the `invisible' property value `outline'.
7473 The return value is a list of cons cells, with start and stop
7474 positions for each overlay.
7475 If USE-MARKERS is set, return the positions as markers."
7477 (org-with-wide-buffer
7480 (when (eq (overlay-get o
'invisible
) 'outline
)
7481 (setq beg
(overlay-start o
)
7482 end
(overlay-end o
))
7483 (and beg end
(> end beg
)
7485 (cons (copy-marker beg
)
7486 (copy-marker end t
))
7488 (overlays-in (point-min) (point-max)))))))
7490 (defun org-set-outline-overlay-data (data)
7491 "Create visibility overlays for all positions in DATA.
7492 DATA should have been made by `org-outline-overlay-data'."
7493 (org-with-wide-buffer
7495 (dolist (c data
) (outline-flag-region (car c
) (cdr c
) t
))))
7497 ;;; Folding of blocks
7499 (defvar-local org-hide-block-overlays nil
7500 "Overlays hiding blocks.")
7502 (defun org-block-map (function &optional start end
)
7503 "Call FUNCTION at the head of all source blocks in the current buffer.
7504 Optional arguments START and END can be used to limit the range."
7505 (let ((start (or start
(point-min)))
7506 (end (or end
(point-max))))
7509 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
7512 (goto-char (match-beginning 0))
7513 (funcall function
)))))))
7515 (defun org-hide-block-toggle-all ()
7516 "Toggle the visibility of all blocks in the current buffer."
7517 (org-block-map 'org-hide-block-toggle
))
7519 (defun org-hide-block-all ()
7520 "Fold all blocks in the current buffer."
7522 (org-show-block-all)
7523 (org-block-map 'org-hide-block-toggle-maybe
))
7525 (defun org-show-block-all ()
7526 "Unfold all blocks in the current buffer."
7528 (mapc #'delete-overlay org-hide-block-overlays
)
7529 (setq org-hide-block-overlays nil
))
7531 (defun org-hide-block-toggle-maybe ()
7532 "Toggle visibility of block at point.
7533 Unlike to `org-hide-block-toggle', this function does not throw
7534 an error. Return a non-nil value when toggling is successful."
7536 (ignore-errors (org-hide-block-toggle)))
7538 (defun org-hide-block-toggle (&optional force
)
7539 "Toggle the visibility of the current block.
7540 When optional argument FORCE is `off', make block visible. If it
7541 is non-nil, hide it unconditionally. Throw an error when not at
7542 a block. Return a non-nil value when toggling is successful."
7544 (let ((element (org-element-at-point)))
7545 (unless (memq (org-element-type element
)
7546 '(center-block comment-block dynamic-block example-block
7547 export-block quote-block special-block
7548 src-block verse-block
))
7549 (user-error "Not at a block"))
7550 (let* ((start (save-excursion
7551 (goto-char (org-element-property :post-affiliated element
))
7552 (line-end-position)))
7553 (end (save-excursion
7554 (goto-char (org-element-property :end element
))
7555 (skip-chars-backward " \r\t\n")
7556 (line-end-position)))
7557 (overlays (overlays-at start
)))
7559 ;; Do nothing when not before or at the block opening line or
7560 ;; at the block closing line.
7561 ((let ((eol (line-end-position))) (and (> eol start
) (/= eol end
))) nil
)
7562 ((and (not (eq force
'off
))
7563 (not (memq t
(mapcar
7565 (eq (overlay-get o
'invisible
) 'org-hide-block
))
7567 (let ((ov (make-overlay start end
)))
7568 (overlay-put ov
'invisible
'org-hide-block
)
7569 ;; Make the block accessible to `isearch'.
7571 ov
'isearch-open-invisible
7573 (when (memq ov org-hide-block-overlays
)
7574 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7575 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7576 (delete-overlay ov
))))
7577 (push ov org-hide-block-overlays
)
7578 ;; When the block is hidden away, make sure point is left in
7579 ;; a visible part of the buffer.
7580 (when (> (line-beginning-position) start
)
7582 (beginning-of-line))
7583 ;; Signal successful toggling.
7585 ((or (not force
) (eq force
'off
))
7586 (dolist (ov overlays t
)
7587 (when (memq ov org-hide-block-overlays
)
7588 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7589 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7590 (delete-overlay ov
))))))))
7592 ;; Remove overlays when changing major mode
7593 (add-hook 'org-mode-hook
7594 (lambda () (add-hook 'change-major-mode-hook
7595 'org-show-block-all
'append
'local
)))
7599 (defvar org-goto-window-configuration nil
)
7600 (defvar org-goto-marker nil
)
7601 (defvar org-goto-map
)
7602 (defun org-goto-map ()
7603 "Set the keymap `org-goto'."
7605 (let ((map (make-sparse-keymap)))
7606 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7607 mouse-drag-region universal-argument org-occur
)))
7609 (substitute-key-definition cmd cmd map global-map
)))
7610 (suppress-keymap map
)
7611 (org-defkey map
"\C-m" 'org-goto-ret
)
7612 (org-defkey map
[(return)] 'org-goto-ret
)
7613 (org-defkey map
[(left)] 'org-goto-left
)
7614 (org-defkey map
[(right)] 'org-goto-right
)
7615 (org-defkey map
[(control ?g
)] 'org-goto-quit
)
7616 (org-defkey map
"\C-i" 'org-cycle
)
7617 (org-defkey map
[(tab)] 'org-cycle
)
7618 (org-defkey map
[(down)] 'outline-next-visible-heading
)
7619 (org-defkey map
[(up)] 'outline-previous-visible-heading
)
7620 (if org-goto-auto-isearch
7621 (if (fboundp 'define-key-after
)
7622 (define-key-after map
[t] 'org-goto-local-auto-isearch)
7624 (org-defkey map "q" 'org-goto-quit)
7625 (org-defkey map "n" 'outline-next-visible-heading)
7626 (org-defkey map "p" 'outline-previous-visible-heading)
7627 (org-defkey map "f" 'outline-forward-same-level)
7628 (org-defkey map "b" 'outline-backward-same-level)
7629 (org-defkey map "u" 'outline-up-heading))
7630 (org-defkey map "/" 'org-occur)
7631 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7632 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7633 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7634 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7635 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7638 (defconst org-goto-help
7639 "Browse buffer copy, to find location or copy text.%s
7640 RET=jump to location C-g=quit and return to previous location
7641 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7643 (defvar org-goto-start-pos) ; dynamically scoped parameter
7645 (defun org-goto (&optional alternative-interface)
7646 "Look up a different location in the current file, keeping current visibility.
7648 When you want look-up or go to a different location in a
7649 document, the fastest way is often to fold the entire buffer and
7650 then dive into the tree. This method has the disadvantage, that
7651 the previous location will be folded, which may not be what you
7654 This command works around this by showing a copy of the current
7655 buffer in an indirect buffer, in overview mode. You can dive
7656 into the tree in that copy, use org-occur and incremental search
7657 to find a location. When pressing RET or `Q', the command
7658 returns to the original buffer in which the visibility is still
7659 unchanged. After RET it will also jump to the location selected
7660 in the indirect buffer and expose the headline hierarchy above.
7662 With a prefix argument, use the alternative interface: e.g., if
7663 `org-goto-interface' is `outline' use `outline-path-completion'."
7666 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7667 (org-refile-use-outline-path t)
7668 (org-refile-target-verify-function nil)
7670 (if (not alternative-interface)
7672 (if (eq org-goto-interface 'outline)
7673 'outline-path-completion
7675 (org-goto-start-pos (point))
7677 (if (eq interface 'outline)
7678 (car (org-get-location (current-buffer) org-goto-help))
7679 (let ((pa (org-refile-get-location "Goto")))
7680 (org-refile-check-position pa)
7684 (org-mark-ring-push org-goto-start-pos)
7685 (goto-char selected-point)
7686 (when (or (outline-invisible-p) (org-invisible-p2))
7687 (org-show-context 'org-goto)))
7690 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7691 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7692 (defvar org-goto-local-auto-isearch-map) ; defined below
7694 (defun org-get-location (_buf help)
7695 "Let the user select a location in current buffer.
7696 This function uses a recursive edit. It returns the selected position
7699 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7700 (isearch-hide-immediately nil)
7701 (isearch-search-fun-function
7702 (lambda () 'org-goto-local-search-headings))
7703 (org-goto-selected-point org-goto-exit-command))
7705 (save-window-excursion
7706 (delete-other-windows)
7707 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7708 (pop-to-buffer-same-window
7710 (make-indirect-buffer (current-buffer) "*org-goto*")
7711 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7712 (with-output-to-temp-buffer "*Org Help*"
7713 (princ (format help (if org-goto-auto-isearch
7714 " Just type for auto-isearch."
7715 " n/p/f/b/u to navigate, q to quit."))))
7716 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7717 (setq buffer-read-only nil)
7718 (let ((org-startup-truncated t)
7719 (org-startup-folded nil)
7720 (org-startup-align-all-tables nil))
7723 (setq buffer-read-only t)
7724 (if (and (boundp 'org-goto-start-pos)
7725 (integer-or-marker-p org-goto-start-pos))
7726 (progn (goto-char org-goto-start-pos)
7727 (when (outline-invisible-p)
7728 (org-show-set-visibility 'lineage)))
7729 (goto-char (point-min)))
7730 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7731 (message "Select location and press RET")
7732 (use-local-map org-goto-map)
7734 (kill-buffer "*org-goto*")
7735 (cons org-goto-selected-point org-goto-exit-command))))
7737 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7738 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7739 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7740 (if (fboundp 'isearch-other-control-char)
7742 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7743 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7744 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7745 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7746 (define-key org-goto-local-auto-isearch-map [return] nil))
7748 (defun org-goto-local-search-headings (string bound noerror)
7749 "Search and make sure that any matches are in headlines."
7751 (while (if isearch-forward
7752 (search-forward string bound noerror)
7753 (search-backward string bound noerror))
7754 (when (save-match-data
7755 (and (save-excursion
7757 (looking-at org-complex-heading-regexp))
7758 (or (not (match-beginning 5))
7759 (< (point) (match-beginning 5)))))
7760 (throw 'return (point))))))
7762 (defun org-goto-local-auto-isearch ()
7765 (goto-char (point-min))
7766 (let ((keys (this-command-keys)))
7767 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7769 (isearch-process-search-char (string-to-char keys)))))
7771 (defun org-goto-ret (&optional _arg)
7772 "Finish `org-goto' by going to the new location."
7774 (setq org-goto-selected-point (point))
7775 (setq org-goto-exit-command 'return)
7778 (defun org-goto-left ()
7779 "Finish `org-goto' by going to the new location."
7781 (if (org-at-heading-p)
7783 (beginning-of-line 1)
7784 (setq org-goto-selected-point (point)
7785 org-goto-exit-command 'left)
7787 (user-error "Not on a heading")))
7789 (defun org-goto-right ()
7790 "Finish `org-goto' by going to the new location."
7792 (if (org-at-heading-p)
7794 (setq org-goto-selected-point (point)
7795 org-goto-exit-command 'right)
7797 (user-error "Not on a heading")))
7799 (defun org-goto-quit ()
7800 "Finish `org-goto' without cursor motion."
7802 (setq org-goto-selected-point nil)
7803 (setq org-goto-exit-command 'quit)
7806 ;;; Indirect buffer display of subtrees
7808 (defvar org-indirect-dedicated-frame nil
7809 "This is the frame being used for indirect tree display.")
7810 (defvar org-last-indirect-buffer nil)
7812 (defun org-tree-to-indirect-buffer (&optional arg)
7813 "Create indirect buffer and narrow it to current subtree.
7815 With a numerical prefix ARG, go up to this level and then take that tree.
7816 If ARG is negative, go up that many levels.
7818 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7819 indirect buffer previously made with this command, to avoid proliferation of
7820 indirect buffers. However, when you call the command with a \
7821 `\\[universal-argument]' prefix, or
7822 when `org-indirect-buffer-display' is `new-frame', the last buffer is kept
7823 so that you can work with several indirect buffers at the same time. If
7824 `org-indirect-buffer-display' is `dedicated-frame', the \
7825 `\\[universal-argument]' prefix also
7826 requests that a new frame be made for the new buffer, so that the dedicated
7827 frame is not changed."
7829 (let ((cbuf (current-buffer))
7830 (cwin (selected-window))
7832 beg end level heading ibuf)
7834 (org-back-to-heading t)
7836 (setq level (org-outline-level))
7837 (when (< arg 0) (setq arg (+ level arg)))
7838 (while (> (setq level (org-outline-level)) arg)
7839 (org-up-heading-safe)))
7841 heading (org-get-heading 'no-tags))
7842 (org-end-of-subtree t t)
7843 (when (org-at-heading-p) (backward-char 1))
7845 (when (and (buffer-live-p org-last-indirect-buffer)
7846 (not (eq org-indirect-buffer-display 'new-frame))
7848 (kill-buffer org-last-indirect-buffer))
7849 (setq ibuf (org-get-indirect-buffer cbuf heading)
7850 org-last-indirect-buffer ibuf)
7852 ((or (eq org-indirect-buffer-display 'new-frame)
7853 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7854 (select-frame (make-frame))
7855 (delete-other-windows)
7856 (pop-to-buffer-same-window ibuf)
7857 (org-set-frame-title heading))
7858 ((eq org-indirect-buffer-display 'dedicated-frame)
7860 (select-frame (or (and org-indirect-dedicated-frame
7861 (frame-live-p org-indirect-dedicated-frame)
7862 org-indirect-dedicated-frame)
7863 (setq org-indirect-dedicated-frame (make-frame)))))
7864 (delete-other-windows)
7865 (pop-to-buffer-same-window ibuf)
7866 (org-set-frame-title (concat "Indirect: " heading)))
7867 ((eq org-indirect-buffer-display 'current-window)
7868 (pop-to-buffer-same-window ibuf))
7869 ((eq org-indirect-buffer-display 'other-window)
7870 (pop-to-buffer ibuf))
7871 (t (error "Invalid value")))
7872 (narrow-to-region beg end)
7875 (run-hook-with-args 'org-cycle-hook 'all)
7876 (and (window-live-p cwin) (select-window cwin))))
7878 (defun org-get-indirect-buffer (&optional buffer heading)
7879 (setq buffer (or buffer (current-buffer)))
7880 (let ((n 1) (base (buffer-name buffer)) bname)
7881 (while (buffer-live-p
7885 (if heading (concat heading "-" (number-to-string n))
7886 (number-to-string n))))))
7889 (make-indirect-buffer buffer bname 'clone)
7890 (error (make-indirect-buffer buffer bname)))))
7892 (defun org-set-frame-title (title)
7893 "Set the title of the current frame to the string TITLE."
7894 (modify-frame-parameters (selected-frame) (list (cons 'name title))))
7896 ;;;; Structure editing
7898 ;;; Inserting headlines
7900 (defun org--line-empty-p (n)
7901 "Is the Nth next line empty?
7903 Counts the current line as N = 1 and the previous line as N = 0;
7904 see `beginning-of-line'."
7907 (or (beginning-of-line n) t)
7909 (looking-at "[ \t]*$")))))
7911 (defun org-previous-line-empty-p ()
7912 "Is the previous line a blank line?
7913 When NEXT is non-nil, check the next line instead."
7914 (org--line-empty-p 0))
7916 (defun org-next-line-empty-p ()
7917 "Is the previous line a blank line?
7918 When NEXT is non-nil, check the next line instead."
7919 (org--line-empty-p 2))
7921 (defun org-insert-heading (&optional arg invisible-ok top)
7922 "Insert a new heading or an item with the same depth at point.
7924 If point is at the beginning of a heading or a list item, insert
7925 a new heading or a new item above the current one. When at the
7926 beginning of a regular line of text, turn it into a heading.
7928 If point is in the middle of a line, split it and create a new
7929 headline/item with the text in the current line after point (see
7930 `org-M-RET-may-split-line' on how to modify this behavior). As
7931 a special case, on a headline, splitting can only happen on the
7932 title itself. E.g., this excludes breaking stars or tags.
7934 With a `\\[universal-argument]' prefix, set \
7935 `org-insert-heading-respect-content' to
7936 a non-nil value for the duration of the command. This forces the
7937 insertion of a heading after the current subtree, independently
7938 on the location of point.
7940 With a `\\[universal-argument] \\[universal-argument]' prefix, \
7941 insert the heading at the end of the tree
7942 above the current heading. For example, if point is within a
7943 2nd-level heading, then it will insert a 2nd-level heading at
7944 the end of the 1st-level parent subtree.
7946 When INVISIBLE-OK is set, stop at invisible headlines when going
7947 back. This is important for non-interactive uses of the
7950 When optional argument TOP is non-nil, insert a level 1 heading,
7953 (let ((itemp (and (not top) (org-in-item-p)))
7954 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7955 (respect-content (or org-insert-heading-respect-content
7957 (initial-content ""))
7961 ((or (= (buffer-size) 0)
7962 (and (not (save-excursion
7963 (and (ignore-errors (org-back-to-heading invisible-ok))
7964 (org-at-heading-p))))
7965 (or arg (not itemp))))
7966 ;; At beginning of buffer or so high up that only a heading
7968 (cond ((and (bolp) (not respect-content)) (insert "* "))
7969 ((not respect-content)
7970 (unless may-split (end-of-line))
7972 ((re-search-forward org-outline-regexp-bol nil t)
7976 (t (goto-char (point-max))
7978 (run-hooks 'org-insert-heading-hook))
7980 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7983 ;; Maybe move at the end of the subtree
7984 (when (equal arg '(16))
7985 (org-up-heading-safe)
7986 (org-end-of-subtree t))
7991 (on-heading (org-at-heading-p))
7992 (empty-line-p (if on-heading
7993 (org-previous-line-empty-p)
7994 ;; We will decide later
7996 ;; Get a level string to fall back on.
7998 (if (org-before-first-heading-p) "*"
8000 (org-back-to-heading t)
8001 (when (org-previous-line-empty-p) (setq empty-line-p t))
8002 (looking-at org-outline-regexp)
8003 (make-string (1- (length (match-string 0))) ?*))))
8008 (org-back-to-heading invisible-ok)
8009 (when (and (not on-heading)
8010 (featurep 'org-inlinetask)
8011 (integerp org-inlinetask-min-level)
8012 (>= (length (match-string 0))
8013 org-inlinetask-min-level))
8014 ;; Find a heading level before the inline
8016 (while (and (setq level (org-up-heading-safe))
8017 (>= level org-inlinetask-min-level)))
8018 (if (org-at-heading-p)
8019 (org-back-to-heading invisible-ok)
8020 (error "This should not happen")))
8021 (unless (and (save-excursion
8023 (org-backward-heading-same-level
8025 (= (point) (match-beginning 0)))
8026 (not (org-next-line-empty-p)))
8027 (setq empty-line-p (or empty-line-p
8028 (org-previous-line-empty-p))))
8030 (error (or fix-level "* ")))))
8031 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
8032 (blank (if (eq blank-a 'auto) empty-line-p blank-a)))
8034 ;; If we insert after content, move there and clean up
8036 (when respect-content
8037 (if (not (org-before-first-heading-p))
8038 (org-end-of-subtree nil t)
8039 (re-search-forward org-outline-regexp-bol)
8040 (beginning-of-line 0))
8041 (skip-chars-backward " \r\t\n")
8042 (and (not (looking-back "^\\*+" (line-beginning-position)))
8043 (looking-at "[ \t]+") (replace-match ""))
8044 (unless (eobp) (forward-char 1))
8045 (when (looking-at "^\\*")
8046 (unless (bobp) (backward-char 1))
8049 ;; If we are splitting, grab the text that should be moved
8050 ;; to the new headline.
8052 (if (org-at-heading-p)
8053 ;; This is a heading: split intelligently (keeping
8055 (let ((pos (point)))
8057 (let ((case-fold-search nil))
8058 (unless (looking-at org-complex-heading-regexp)
8059 (error "This should not happen")))
8060 (when (and (match-beginning 4)
8061 (> pos (match-beginning 4))
8062 (< pos (match-end 4)))
8063 (setq initial-content (buffer-substring pos (match-end 4)))
8065 (delete-region (point) (match-end 4))
8066 (if (looking-at "[ \t]*$")
8068 (insert (make-string (length initial-content) ?\s)))
8069 (setq initial-content (org-trim initial-content)))
8072 (setq initial-content
8074 (delete-and-extract-region (point) (line-end-position))))))
8076 ;; If we are at the beginning of the line, insert before it.
8077 ;; Otherwise, after it.
8079 ((and (bolp) (looking-at "[ \t]*$")))
8080 ((bolp) (save-excursion (insert "\n")))
8084 ;; Insert the new heading
8087 (insert initial-content)
8088 (unless (and blank (org-previous-line-empty-p))
8089 (org-N-empty-lines-before-current (if blank 1 0)))
8090 ;; Adjust visibility, which may be messed up if we removed
8091 ;; blank lines while previous entry was hidden.
8092 (let ((bol (line-beginning-position)))
8093 (dolist (o (overlays-at (1- bol)))
8094 (when (and (eq (overlay-get o 'invisible) 'outline)
8095 (eq (overlay-end o) bol))
8096 (move-overlay o (overlay-start o) (1- bol)))))
8097 (run-hooks 'org-insert-heading-hook)))))))
8099 (defun org-N-empty-lines-before-current (N)
8100 "Make the number of empty lines before current exactly N.
8101 So this will delete or add empty lines."
8105 (skip-chars-backward " \r\t\n")
8106 (unless (bolp) (forward-line))
8107 (delete-region (point) p))
8108 (when (> N 0) (insert (make-string N ?\n)))))
8110 (defun org-get-heading (&optional no-tags no-todo)
8111 "Return the heading of the current entry, without the stars.
8112 When NO-TAGS is non-nil, don't include tags.
8113 When NO-TODO is non-nil, don't include TODO keywords."
8115 (org-back-to-heading t)
8116 (let ((case-fold-search nil))
8118 ((and no-tags no-todo)
8119 (looking-at org-complex-heading-regexp)
8120 ;; Return value has to be a string, but match group 4 is
8122 (or (match-string 4) ""))
8124 (looking-at (concat org-outline-regexp
8126 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
8129 (looking-at org-todo-line-regexp)
8131 (t (looking-at org-heading-regexp)
8132 (match-string 2))))))
8134 (defvar orgstruct-mode) ; defined below
8136 (defun org-heading-components ()
8137 "Return the components of the current heading.
8138 This is a list with the following elements:
8139 - the level as an integer
8140 - the reduced level, different if `org-odd-levels-only' is set.
8141 - the TODO keyword, or nil
8142 - the priority character, like ?A, or nil if no priority is given
8143 - the headline text itself, or the tags string if no headline text
8144 - the tags string, or nil."
8146 (org-back-to-heading t)
8147 (when (let (case-fold-search)
8151 org-complex-heading-regexp)))
8153 (list (length (match-string 1))
8154 (org-reduced-level (length (match-string 1)))
8159 (list (length (match-string 1))
8160 (org-reduced-level (length (match-string 1)))
8161 (match-string-no-properties 2)
8162 (and (match-end 3) (aref (match-string 3) 2))
8163 (match-string-no-properties 4)
8164 (match-string-no-properties 5))))))
8166 (defun org-get-entry ()
8167 "Get the entry text, after heading, entire subtree."
8169 (org-back-to-heading t)
8170 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
8172 (defun org-edit-headline (&optional heading)
8173 "Edit the current headline.
8174 Set it to HEADING when provided."
8176 (org-with-wide-buffer
8177 (org-back-to-heading t)
8178 (let ((case-fold-search nil))
8179 (when (looking-at org-complex-heading-regexp)
8180 (let* ((old (match-string-no-properties 4))
8181 (new (save-match-data
8182 (org-trim (or heading (read-string "Edit: " old))))))
8183 (unless (equal old new)
8184 (if old (replace-match new t t nil 4)
8185 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
8187 (org-set-tags nil t)
8188 (when (looking-at "[ \t]*$") (replace-match ""))))))))
8190 (defun org-insert-heading-after-current ()
8191 "Insert a new heading with same level as current, after current subtree."
8193 (org-back-to-heading)
8194 (org-insert-heading)
8195 (org-move-subtree-down)
8198 (defun org-insert-heading-respect-content (&optional invisible-ok)
8199 "Insert heading with `org-insert-heading-respect-content' set to t."
8201 (org-insert-heading '(4) invisible-ok))
8203 (defun org-insert-todo-heading-respect-content (&optional force-state)
8204 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
8206 (org-insert-todo-heading force-state '(4)))
8208 (defun org-insert-todo-heading (arg &optional force-heading)
8209 "Insert a new heading with the same level and TODO state as current heading.
8211 If the heading has no TODO state, or if the state is DONE, use
8212 the first state (TODO by default). Also with one prefix arg,
8213 force first state. With two prefix args, force inserting at the
8214 end of the parent subtree.
8216 When called at a plain list item, insert a new item with an
8217 unchecked check box."
8219 (when (or force-heading (not (org-insert-item 'checkbox)))
8220 (org-insert-heading (or (and (equal arg '(16)) '(16))
8223 (org-back-to-heading)
8224 (outline-previous-heading)
8225 (let ((case-fold-search nil)) (looking-at org-todo-line-regexp)))
8227 (if (or (equal arg '(4))
8228 (not (match-beginning 2))
8229 (member (match-string 2) org-done-keywords))
8230 (car org-todo-keywords-1)
8234 (run-hook-with-args-until-success
8235 'org-todo-get-default-hook new-mark-x nil)
8237 (beginning-of-line 1)
8238 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8239 (if org-treat-insert-todo-heading-as-state-change
8241 (insert new-mark " "))))
8242 (when org-provide-todo-statistics
8243 (org-update-parent-todo-statistics))))
8245 (defun org-insert-subheading (arg)
8246 "Insert a new subheading and demote it.
8247 Works for outline headings and for plain lists alike."
8249 (org-insert-heading arg)
8251 ((org-at-heading-p) (org-do-demote))
8252 ((org-at-item-p) (org-indent-item))))
8254 (defun org-insert-todo-subheading (arg)
8255 "Insert a new subheading with TODO keyword or checkbox and demote it.
8256 Works for outline headings and for plain lists alike."
8258 (org-insert-todo-heading arg)
8260 ((org-at-heading-p) (org-do-demote))
8261 ((org-at-item-p) (org-indent-item))))
8263 ;;; Promotion and Demotion
8265 (defvar org-after-demote-entry-hook nil
8266 "Hook run after an entry has been demoted.
8267 The cursor will be at the beginning of the entry.
8268 When a subtree is being demoted, the hook will be called for each node.")
8270 (defvar org-after-promote-entry-hook nil
8271 "Hook run after an entry has been promoted.
8272 The cursor will be at the beginning of the entry.
8273 When a subtree is being promoted, the hook will be called for each node.")
8275 (defun org-promote-subtree ()
8276 "Promote the entire subtree.
8277 See also `org-promote'."
8280 (org-with-limited-levels (org-map-tree 'org-promote)))
8281 (org-fix-position-after-promote))
8283 (defun org-demote-subtree ()
8284 "Demote the entire subtree.
8285 See `org-demote' and `org-promote'."
8288 (org-with-limited-levels (org-map-tree 'org-demote)))
8289 (org-fix-position-after-promote))
8291 (defun org-do-promote ()
8292 "Promote the current heading higher up the tree.
8293 If the region is active in `transient-mark-mode', promote all
8294 headings in the region."
8297 (if (org-region-active-p)
8298 (org-map-region 'org-promote (region-beginning) (region-end))
8300 (org-fix-position-after-promote))
8302 (defun org-do-demote ()
8303 "Demote the current heading lower down the tree.
8304 If the region is active in `transient-mark-mode', demote all
8305 headings in the region."
8308 (if (org-region-active-p)
8309 (org-map-region 'org-demote (region-beginning) (region-end))
8311 (org-fix-position-after-promote))
8313 (defun org-fix-position-after-promote ()
8314 "Fix cursor position and indentation after demoting/promoting."
8315 (let ((pos (point)))
8316 (when (save-excursion
8318 (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
8319 (or (eq pos (match-end 1)) (eq pos (match-end 2))))
8320 (cond ((eobp) (insert " "))
8321 ((eolp) (insert " "))
8322 ((equal (char-after) ?\s) (forward-char 1))))))
8324 (defun org-current-level ()
8325 "Return the level of the current entry, or nil if before the first headline.
8326 The level is the number of stars at the beginning of the
8327 headline. Use `org-reduced-level' to remove the effect of
8328 `org-odd-levels'. Unlike to `org-outline-level', this function
8329 ignores inlinetasks."
8330 (let ((level (org-with-limited-levels (org-outline-level))))
8331 (and (> level 0) level)))
8333 (defun org-get-previous-line-level ()
8334 "Return the outline depth of the last headline before the current line.
8335 Returns 0 for the first headline in the buffer, and nil if before the
8337 (and (org-current-level)
8338 (or (and (/= (line-beginning-position) (point-min))
8339 (save-excursion (beginning-of-line 0) (org-current-level)))
8342 (defun org-reduced-level (l)
8343 "Compute the effective level of a heading.
8344 This takes into account the setting of `org-odd-levels-only'."
8347 (org-odd-levels-only (1+ (floor (/ l 2))))
8350 (defun org-level-increment ()
8351 "Return the number of stars that will be added or removed at a
8352 time to headlines when structure editing, based on the value of
8353 `org-odd-levels-only'."
8354 (if org-odd-levels-only 2 1))
8356 (defun org-get-valid-level (level &optional change)
8357 "Rectify a level change under the influence of `org-odd-levels-only'
8358 LEVEL is a current level, CHANGE is by how much the level should be
8359 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8360 even level numbers will become the next higher odd number."
8361 (if org-odd-levels-only
8362 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8363 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8364 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8365 (max 1 (+ level (or change 0)))))
8367 (defun org-promote ()
8368 "Promote the current heading higher up the tree."
8369 (org-with-wide-buffer
8370 (org-back-to-heading t)
8371 (let* ((after-change-functions (remq 'flyspell-after-change-function
8372 after-change-functions))
8373 (level (save-match-data (funcall outline-level)))
8374 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8375 (diff (abs (- level (length up-head) -1))))
8377 ((and (= level 1) org-allow-promoting-top-level-subtree)
8378 (replace-match "# " nil t))
8380 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8381 (t (replace-match up-head nil t)))
8383 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8384 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8385 (run-hooks 'org-after-promote-entry-hook))))
8387 (defun org-demote ()
8388 "Demote the current heading lower down the tree."
8389 (org-with-wide-buffer
8390 (org-back-to-heading t)
8391 (let* ((after-change-functions (remq 'flyspell-after-change-function
8392 after-change-functions))
8393 (level (save-match-data (funcall outline-level)))
8394 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8395 (diff (abs (- level (length down-head) -1))))
8396 (replace-match down-head nil t)
8397 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8398 (when org-adapt-indentation (org-fixup-indentation diff))
8399 (run-hooks 'org-after-demote-entry-hook))))
8401 (defun org-cycle-level ()
8402 "Cycle the level of an empty headline through possible states.
8403 This goes first to child, then to parent, level, then up the hierarchy.
8404 After top level, it switches back to sibling level."
8406 (let ((org-adapt-indentation nil))
8407 (when (org-point-at-end-of-empty-headline)
8408 (setq this-command 'org-cycle-level) ; Only needed for caching
8409 (let ((cur-level (org-current-level))
8410 (prev-level (org-get-previous-line-level)))
8412 ;; If first headline in file, promote to top-level.
8414 (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
8415 do (org-do-promote)))
8416 ;; If same level as prev, demote one.
8417 ((= prev-level cur-level)
8419 ;; If parent is top-level, promote to top level if not already.
8421 (cl-loop repeat (/ (- cur-level 1) (org-level-increment))
8422 do (org-do-promote)))
8423 ;; If top-level, return to prev-level.
8425 (cl-loop repeat (/ (- prev-level 1) (org-level-increment))
8426 do (org-do-demote)))
8427 ;; If less than prev-level, promote one.
8428 ((< cur-level prev-level)
8430 ;; If deeper than prev-level, promote until higher than
8432 ((> cur-level prev-level)
8433 (cl-loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8434 do (org-do-promote))))
8437 (defun org-map-tree (fun)
8438 "Call FUN for every heading underneath the current one."
8439 (org-back-to-heading t)
8440 (let ((level (funcall outline-level)))
8444 (outline-next-heading)
8445 (> (funcall outline-level) level))
8449 (defun org-map-region (fun beg end)
8450 "Call FUN for every heading between BEG and END."
8451 (let ((org-ignore-region t))
8453 (setq end (copy-marker end))
8455 (when (and (re-search-forward org-outline-regexp-bol nil t)
8459 (outline-next-heading)
8464 (defun org-fixup-indentation (diff)
8465 "Change the indentation in the current entry by DIFF.
8467 DIFF is an integer. Indentation is done according to the
8470 - Planning information and property drawers are always indented
8471 according to the new level of the headline;
8473 - Footnote definitions and their contents are ignored;
8475 - Inlinetasks' boundaries are not shifted;
8477 - Empty lines are ignored;
8479 - Other lines' indentation are shifted by DIFF columns, unless
8480 it would introduce a structural change in the document, in
8481 which case no shifting is done at all.
8483 Assume point is at a heading or an inlinetask beginning."
8484 (org-with-wide-buffer
8485 (narrow-to-region (line-beginning-position)
8487 (if (org-with-limited-levels (org-at-heading-p))
8488 (org-with-limited-levels (outline-next-heading))
8489 (org-inlinetask-goto-end))
8492 ;; Indent properly planning info and property drawer.
8493 (when (looking-at-p org-planning-line-re)
8496 (when (looking-at org-property-drawer-re)
8497 (goto-char (match-end 0))
8499 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8501 (when (zerop diff) (throw 'no-shift nil))
8502 ;; If DIFF is negative, first check if a shift is possible at all
8503 ;; (e.g., it doesn't break structure). This can only happen if
8504 ;; some contents are not properly indented.
8505 (let ((case-fold-search t))
8507 (let ((diff (- diff))
8508 (forbidden-re (concat org-outline-regexp
8510 (substring org-footnote-definition-re 1))))
8514 ((looking-at-p "[ \t]*$") (forward-line))
8515 ((and (looking-at-p org-footnote-definition-re)
8516 (let ((e (org-element-at-point)))
8517 (and (eq (org-element-type e) 'footnote-definition)
8518 (goto-char (org-element-property :end e))))))
8519 ((looking-at-p org-outline-regexp) (forward-line))
8520 ;; Give up if shifting would move before column 0 or
8521 ;; if it would introduce a headline or a footnote
8524 (skip-chars-forward " \t")
8525 (let ((ind (current-column)))
8526 (when (or (< ind diff)
8527 (and (= ind diff) (looking-at-p forbidden-re)))
8528 (throw 'no-shift nil)))
8529 ;; Ignore contents of example blocks and source
8530 ;; blocks if their indentation is meant to be
8531 ;; preserved. Jump to block's closing line.
8533 (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8534 (let ((e (org-element-at-point)))
8535 (and (memq (org-element-type e)
8536 '(example-block src-block))
8537 (or org-src-preserve-indentation
8538 (org-element-property :preserve-indent e))
8539 (goto-char (org-element-property :end e))
8540 (progn (skip-chars-backward " \r\t\n")
8543 (forward-line))))))))
8544 ;; Shift lines but footnote definitions, inlinetasks boundaries
8545 ;; by DIFF. Also skip contents of source or example blocks
8546 ;; when indentation is meant to be preserved.
8549 ((and (looking-at-p org-footnote-definition-re)
8550 (let ((e (org-element-at-point)))
8551 (and (eq (org-element-type e) 'footnote-definition)
8552 (goto-char (org-element-property :end e))))))
8553 ((looking-at-p org-outline-regexp) (forward-line))
8554 ((looking-at-p "[ \t]*$") (forward-line))
8556 (indent-line-to (+ (org-get-indentation) diff))
8558 (or (and (looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8559 (let ((e (org-element-at-point)))
8560 (and (memq (org-element-type e)
8561 '(example-block src-block))
8562 (or org-src-preserve-indentation
8563 (org-element-property :preserve-indent e))
8564 (goto-char (org-element-property :end e))
8565 (progn (skip-chars-backward " \r\t\n")
8568 (forward-line)))))))))
8570 (defun org-convert-to-odd-levels ()
8571 "Convert an Org file with all levels allowed to one with odd levels.
8572 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8575 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8576 (let ((outline-level 'org-outline-level)
8577 (org-odd-levels-only nil) n)
8579 (goto-char (point-min))
8580 (while (re-search-forward "^\\*\\*+ " nil t)
8581 (setq n (- (length (match-string 0)) 2))
8582 (while (>= (setq n (1- n)) 0)
8584 (end-of-line 1))))))
8586 (defun org-convert-to-oddeven-levels ()
8587 "Convert an Org file with only odd levels to one with odd/even levels.
8588 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8589 file contains a section with an even level, conversion would
8590 destroy the structure of the file. An error is signaled in this
8593 (goto-char (point-min))
8594 ;; First check if there are no even levels
8595 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8596 (org-show-set-visibility 'canonical)
8597 (error "Not all levels are odd in this file. Conversion not possible"))
8598 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8599 (let ((outline-regexp org-outline-regexp)
8600 (outline-level 'org-outline-level)
8601 (org-odd-levels-only nil) n)
8603 (goto-char (point-min))
8604 (while (re-search-forward "^\\*\\*+ " nil t)
8605 (setq n (/ (1- (length (match-string 0))) 2))
8606 (while (>= (setq n (1- n)) 0)
8608 (end-of-line 1))))))
8610 (defun org-tr-level (n)
8611 "Make N odd if required."
8612 (if org-odd-levels-only (1+ (/ n 2)) n))
8614 ;;; Vertical tree motion, cutting and pasting of subtrees
8616 (defun org-move-subtree-up (&optional arg)
8617 "Move the current subtree up past ARG headlines of the same level."
8619 (org-move-subtree-down (- (prefix-numeric-value arg))))
8621 (defun org-move-subtree-down (&optional arg)
8622 "Move the current subtree down past ARG headlines of the same level."
8624 (setq arg (prefix-numeric-value arg))
8625 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8626 'org-get-last-sibling))
8627 (ins-point (make-marker))
8629 (col (current-column))
8630 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8632 (org-back-to-heading)
8635 (setq ne-beg (org-back-over-empty-lines))
8638 (save-excursion (outline-end-of-heading)
8639 (setq folded (outline-invisible-p)))
8640 (progn (org-end-of-subtree nil t)
8641 (unless (eobp) (backward-char))))
8642 (outline-next-heading)
8643 (setq ne-end (org-back-over-empty-lines))
8646 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8647 ;; include less whitespace
8650 (forward-line (- ne-beg ne-end))
8651 (setq beg (point))))
8652 ;; Find insertion point, with error handling
8654 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8655 (progn (goto-char beg0)
8656 (user-error "Cannot move past superior level or buffer limit")))
8657 (setq cnt (1- cnt)))
8659 ;; Moving forward - still need to move over subtree
8660 (org-end-of-subtree t t)
8662 (org-back-over-empty-lines)
8663 (or (bolp) (newline))))
8664 (setq ne-ins (org-back-over-empty-lines))
8665 (move-marker ins-point (point))
8666 (setq txt (buffer-substring beg end))
8667 (org-save-markers-in-region beg end)
8668 (delete-region beg end)
8669 (org-remove-empty-overlays-at beg)
8670 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8671 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8672 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8673 (let ((bbb (point)))
8674 (insert-before-markers txt)
8675 (org-reinstall-markers-in-region bbb)
8676 (move-marker ins-point bbb))
8677 (or (bolp) (insert "\n"))
8678 (setq ins-end (point))
8679 (goto-char ins-point)
8680 (org-skip-whitespace)
8681 (when (and (< arg 0)
8682 (org-first-sibling-p)
8684 ;; Move whitespace back to beginning
8687 (let ((kill-whole-line t))
8688 (kill-line (- ne-ins ne-beg)) (point)))
8689 (insert (make-string (- ne-ins ne-beg) ?\n)))
8690 (move-marker ins-point nil)
8692 (outline-hide-subtree)
8695 (org-cycle-hide-drawers 'children))
8696 (org-clean-visibility-after-subtree-move)
8697 ;; move back to the initial column we were at
8698 (move-to-column col)))
8700 (defvar org-subtree-clip ""
8701 "Clipboard for cut and paste of subtrees.
8702 This is actually only a copy of the kill, because we use the normal kill
8703 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8705 (defvar org-subtree-clip-folded nil
8706 "Was the last copied subtree folded?
8707 This is used to fold the tree back after pasting.")
8709 (defun org-cut-subtree (&optional n)
8710 "Cut the current subtree into the clipboard.
8711 With prefix arg N, cut this many sequential subtrees.
8712 This is a short-hand for marking the subtree and then cutting it."
8714 (org-copy-subtree n 'cut))
8716 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8717 "Copy the current subtree it in the clipboard.
8718 With prefix arg N, copy this many sequential subtrees.
8719 This is a short-hand for marking the subtree and then copying it.
8720 If CUT is non-nil, actually cut the subtree.
8721 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8722 of some markers in the region, even if CUT is non-nil. This is
8723 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8725 (let (beg end folded (beg0 (point)))
8726 (if (called-interactively-p 'any)
8727 (org-back-to-heading nil) ; take what looks like a subtree
8728 (org-back-to-heading t)) ; take what is really there
8730 (skip-chars-forward " \t\r\n")
8733 (outline-next-heading)
8734 (save-excursion (outline-end-of-heading)
8735 (setq folded (outline-invisible-p)))
8736 (ignore-errors (org-forward-heading-same-level (1- n) t))
8737 (org-end-of-subtree t t)))
8738 ;; Include the end of an inlinetask
8739 (when (and (featurep 'org-inlinetask)
8740 (looking-at-p (concat (org-inlinetask-outline-regexp)
8746 (setq org-subtree-clip-folded folded)
8747 (when (or cut force-store-markers)
8748 (org-save-markers-in-region beg end))
8749 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8750 (setq org-subtree-clip (current-kill 0))
8751 (message "%s: Subtree(s) with %d characters"
8752 (if cut "Cut" "Copied")
8753 (length org-subtree-clip)))))
8755 (defun org-paste-subtree (&optional level tree for-yank remove)
8756 "Paste the clipboard as a subtree, with modification of headline level.
8757 The entire subtree is promoted or demoted in order to match a new headline
8760 If the cursor is at the beginning of a headline, the same level as
8761 that headline is used to paste the tree.
8763 If not, the new level is derived from the *visible* headings
8764 before and after the insertion point, and taken to be the inferior headline
8765 level of the two. So if the previous visible heading is level 3 and the
8766 next is level 4 (or vice versa), level 4 will be used for insertion.
8767 This makes sure that the subtree remains an independent subtree and does
8768 not swallow low level entries.
8770 You can also force a different level, either by using a numeric prefix
8771 argument, or by inserting the heading marker by hand. For example, if the
8772 cursor is after \"*****\", then the tree will be shifted to level 5.
8774 If optional TREE is given, use this text instead of the kill ring.
8776 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8777 move back over whitespace before inserting, and move point to the end of
8778 the inserted text when done.
8780 When REMOVE is non-nil, remove the subtree from the clipboard."
8782 (setq tree (or tree (and kill-ring (current-kill 0))))
8783 (unless (org-kill-is-subtree-p tree)
8785 (substitute-command-keys
8786 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8787 (org-with-limited-levels
8788 (let* ((visp (not (outline-invisible-p)))
8790 (^re_ "\\(\\*+\\)[ \t]*")
8791 (old-level (if (string-match org-outline-regexp-bol txt)
8792 (- (match-end 0) (match-beginning 0) 1)
8794 (force-level (cond (level (prefix-numeric-value level))
8795 ((and (looking-at "[ \t]*$")
8797 "^\\*+$" (buffer-substring
8798 (point-at-bol) (point))))
8799 (- (match-end 0) (match-beginning 0)))
8801 (looking-at org-outline-regexp))
8802 (- (match-end 0) (point) 1))))
8803 (previous-level (save-excursion
8806 (outline-previous-visible-heading 1)
8807 (if (looking-at ^re_)
8808 (- (match-end 0) (match-beginning 0) 1)
8811 (next-level (save-excursion
8814 (or (looking-at org-outline-regexp)
8815 (outline-next-visible-heading 1))
8816 (if (looking-at ^re_)
8817 (- (match-end 0) (match-beginning 0) 1)
8820 (new-level (or force-level (max previous-level next-level)))
8821 (shift (if (or (= old-level -1)
8823 (= old-level new-level))
8825 (- new-level old-level)))
8826 (delta (if (> shift 0) -1 1))
8827 (func (if (> shift 0) 'org-demote 'org-promote))
8828 (org-odd-levels-only nil)
8830 ;; Remove the forced level indicator
8832 (delete-region (point-at-bol) (point)))
8834 (beginning-of-line (if (bolp) 1 2))
8836 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8837 (insert-before-markers txt)
8838 (unless (string-suffix-p "\n" txt) (insert "\n"))
8839 (setq newend (point))
8840 (org-reinstall-markers-in-region beg)
8843 (skip-chars-forward " \t\n\r")
8845 (when (and (outline-invisible-p) visp)
8846 (save-excursion (outline-show-heading)))
8847 ;; Shift if necessary
8850 (narrow-to-region beg end)
8851 (while (not (= shift 0))
8852 (org-map-region func (point-min) (point-max))
8853 (setq shift (+ delta shift)))
8854 (goto-char (point-min))
8855 (setq newend (point-max))))
8856 (when (or (called-interactively-p 'interactive) for-yank)
8857 (message "Clipboard pasted as level %d subtree" new-level))
8858 (when (and (not for-yank) ; in this case, org-yank will decide about folding
8860 (eq org-subtree-clip (current-kill 0))
8861 org-subtree-clip-folded)
8862 ;; The tree was folded before it was killed/copied
8863 (outline-hide-subtree))
8864 (and for-yank (goto-char newend))
8865 (and remove (setq kill-ring (cdr kill-ring))))))
8867 (defun org-kill-is-subtree-p (&optional txt)
8868 "Check if the current kill is an outline subtree, or a set of trees.
8869 Returns nil if kill does not start with a headline, or if the first
8870 headline level is not the largest headline level in the tree.
8871 So this will actually accept several entries of equal levels as well,
8872 which is OK for `org-paste-subtree'.
8873 If optional TXT is given, check this string instead of the current kill."
8874 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8875 (re (org-get-limited-outline-regexp))
8876 (^re (concat "^" re))
8877 (start-level (and kill
8879 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8881 (- (match-end 2) (match-beginning 2) 1)))
8882 (start (1+ (or (match-beginning 2) -1))))
8883 (if (not start-level)
8885 nil) ;; does not even start with a heading
8887 (while (setq start (string-match ^re kill (1+ start)))
8888 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8892 (defvar org-markers-to-move nil
8893 "Markers that should be moved with a cut-and-paste operation.
8894 Those markers are stored together with their positions relative to
8895 the start of the region.")
8897 (defun org-save-markers-in-region (beg end)
8898 "Check markers in region.
8899 If these markers are between BEG and END, record their position relative
8900 to BEG, so that after moving the block of text, we can put the markers back
8902 This function gets called just before an entry or tree gets cut from the
8903 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8904 called immediately, to move the markers with the entries."
8905 (setq org-markers-to-move nil)
8906 (when (featurep 'org-clock)
8907 (org-clock-save-markers-for-cut-and-paste beg end))
8908 (when (featurep 'org-agenda)
8909 (org-agenda-save-markers-for-cut-and-paste beg end)))
8911 (defun org-check-and-save-marker (marker beg end)
8912 "Check if MARKER is between BEG and END.
8913 If yes, remember the marker and the distance to BEG."
8914 (when (and (marker-buffer marker)
8915 (equal (marker-buffer marker) (current-buffer))
8916 (>= marker beg) (< marker end))
8917 (push (cons marker (- marker beg)) org-markers-to-move)))
8919 (defun org-reinstall-markers-in-region (beg)
8920 "Move all remembered markers to their position relative to BEG."
8921 (dolist (x org-markers-to-move)
8922 (move-marker (car x) (+ beg (cdr x))))
8923 (setq org-markers-to-move nil))
8925 (defun org-narrow-to-subtree ()
8926 "Narrow buffer to the current subtree."
8930 (org-with-limited-levels
8932 (progn (org-back-to-heading t) (point))
8933 (progn (org-end-of-subtree t t)
8934 (when (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8937 (defun org-narrow-to-block ()
8938 "Narrow buffer to the current block."
8940 (let* ((case-fold-search t)
8941 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8942 "^[ \t]*#\\+end_.*")))
8944 (narrow-to-region (car blockp) (cdr blockp))
8945 (user-error "Not in a block"))))
8947 (defun org-clone-subtree-with-time-shift (n &optional shift)
8948 "Clone the task (subtree) at point N times.
8949 The clones will be inserted as siblings.
8951 In interactive use, the user will be prompted for the number of
8952 clones to be produced. If the entry has a timestamp, the user
8953 will also be prompted for a time shift, which may be a repeater
8954 as used in time stamps, for example `+3d'. To disable this,
8955 you can call the function with a universal prefix argument.
8957 When a valid repeater is given and the entry contains any time
8958 stamps, the clones will become a sequence in time, with time
8959 stamps in the subtree shifted for each clone produced. If SHIFT
8960 is nil or the empty string, time stamps will be left alone. The
8961 ID property of the original subtree is removed.
8963 In each clone, all the CLOCK entries will be removed. This
8964 prevents Org from considering that the clocked times overlap.
8966 If the original subtree did contain time stamps with a repeater,
8967 the following will happen:
8968 - the repeater will be removed in each clone
8969 - an additional clone will be produced, with the current, unshifted
8970 date(s) in the entry.
8971 - the original entry will be placed *after* all the clones, with
8973 - the start days in the repeater in the original entry will be shifted
8974 to past the last clone.
8975 In this way you can spell out a number of instances of a repeating task,
8976 and still retain the repeater to cover future instances of the task.
8978 As described above, N+1 clones are produced when the original
8979 subtree has a repeater. Setting N to 0, then, can be used to
8980 remove the repeater from a subtree and create a shifted clone
8981 with the original repeater."
8982 (interactive "nNumber of clones to produce: ")
8983 (unless (wholenump n) (user-error "Invalid number of replications %s" n))
8984 (when (org-before-first-heading-p) (user-error "No subtree to clone"))
8985 (let* ((beg (save-excursion (org-back-to-heading t) (point)))
8986 (end-of-tree (save-excursion (org-end-of-subtree t t) (point)))
8989 (if (and (not (equal current-prefix-arg '(4)))
8992 (re-search-forward org-ts-regexp-both end-of-tree t)))
8993 (read-from-minibuffer
8994 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8995 ""))) ;No time shift
8997 (and (org-string-nw-p shift)
8998 (or (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([dwmy]\\)[ \t]*\\'"
9000 (user-error "Invalid shift specification %s" shift)))))
9001 (goto-char end-of-tree)
9002 (unless (bolp) (insert "\n"))
9003 (let* ((end (point))
9004 (template (buffer-substring beg end))
9005 (shift-n (and doshift (string-to-number (match-string 1 shift))))
9006 (shift-what (pcase (and doshift (match-string 2 shift))
9009 ("w" (setq shift-n (* 7 shift-n)) 'day)
9012 (_ (error "Unsupported time unit"))))
9016 (idprop (org-entry-get nil "ID")))
9018 (string-match-p "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>"
9020 (delete-region beg end)
9023 (setq nmax (1+ nmax))
9024 (setq n-no-remove nmax))
9026 (cl-loop for n from nmin to nmax do
9032 (goto-char (point-min))
9034 (and idprop (if org-clone-delete-id
9035 (org-entry-delete nil "ID")
9036 (org-id-get-create t)))
9038 (while (re-search-forward org-clock-line-re nil t)
9039 (delete-region (line-beginning-position)
9040 (line-beginning-position 2)))
9041 (goto-char (point-min))
9042 (while (re-search-forward org-drawer-regexp nil t)
9043 (org-remove-empty-drawer-at (point))))
9044 (goto-char (point-min))
9046 (while (re-search-forward org-ts-regexp-both nil t)
9047 (org-timestamp-change (* n shift-n) shift-what))
9048 (unless (= n n-no-remove)
9049 (goto-char (point-min))
9050 (while (re-search-forward org-ts-regexp nil t)
9052 (goto-char (match-beginning 0))
9053 (when (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
9054 (delete-region (match-beginning 1) (match-end 1)))))))
9060 (defun org-sort (with-case)
9061 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
9062 Optional argument WITH-CASE means sort case-sensitively."
9065 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
9066 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
9068 (org-call-with-arg 'org-sort-entries with-case))))
9070 (defun org-sort-remove-invisible (s)
9071 "Remove invisible links from string S."
9072 (remove-text-properties 0 (length s) org-rm-props s)
9073 (while (string-match org-bracket-link-regexp s)
9074 (setq s (replace-match (if (match-end 2)
9078 (let ((st (format " %s " s)))
9079 (while (string-match org-emph-re st)
9080 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
9081 (setq s (substring st 1 -1)))
9084 (defvar org-priority-regexp) ; defined later in the file
9086 (defvar org-after-sorting-entries-or-items-hook nil
9087 "Hook that is run after a bunch of entries or items have been sorted.
9088 When children are sorted, the cursor is in the parent line when this
9089 hook gets called. When a region or a plain list is sorted, the cursor
9090 will be in the first entry of the sorted region/list.")
9092 (defun org-sort-entries
9093 (&optional with-case sorting-type getkey-func compare-func property)
9094 "Sort entries on a certain level of an outline tree.
9095 If there is an active region, the entries in the region are sorted.
9096 Else, if the cursor is before the first entry, sort the top-level items.
9097 Else, the children of the entry at point are sorted.
9099 Sorting can be alphabetically, numerically, by date/time as given by
9100 a time stamp, by a property, by priority order, or by a custom function.
9102 The command prompts for the sorting type unless it has been given to the
9103 function through the SORTING-TYPE argument, which needs to be a character,
9104 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
9105 the precise meaning of each character:
9107 a Alphabetically, ignoring the TODO keyword and the priority, if any.
9108 c By creation time, which is assumed to be the first inactive time stamp
9109 at the beginning of a line.
9110 d By deadline date/time.
9112 n Numerically, by converting the beginning of the entry/item to a number.
9113 o By order of TODO keywords.
9114 p By priority according to the cookie.
9115 r By the value of a property.
9116 s By scheduled date/time.
9117 t By date/time, either the first active time stamp in the entry, or, if
9118 none exist, by the first inactive one.
9120 Capital letters will reverse the sort order.
9122 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
9123 called with point at the beginning of the record. It must return either
9124 a string or a number that should serve as the sorting key for that record.
9126 Comparing entries ignores case by default. However, with an optional argument
9127 WITH-CASE, the sorting considers case as well.
9129 Sorting is done against the visible part of the headlines, it ignores hidden
9132 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
9134 (let ((case-func (if with-case 'identity 'downcase))
9136 ;; The clock marker is lost when using `sort-subr', let's
9137 ;; store the clocking string.
9138 (when (equal (marker-buffer org-clock-marker) (current-buffer))
9140 (goto-char org-clock-marker)
9141 (buffer-substring-no-properties (line-beginning-position)
9143 start beg end stars re re2
9145 ;; Find beginning and end of region to sort
9147 ((org-region-active-p)
9148 ;; we will sort the region
9149 (setq end (region-end)
9151 (goto-char (region-beginning))
9152 (unless (org-at-heading-p) (outline-next-heading))
9153 (setq start (point)))
9154 ((or (org-at-heading-p)
9155 (ignore-errors (progn (org-back-to-heading) t)))
9156 ;; we will sort the children of the current headline
9157 (org-back-to-heading)
9159 end (progn (org-end-of-subtree t t)
9160 (or (bolp) (insert "\n"))
9161 (when (>= (org-back-over-empty-lines) 1)
9166 (outline-show-subtree)
9167 (outline-next-heading))
9169 ;; we will sort the top-level entries in this file
9170 (goto-char (point-min))
9171 (or (org-at-heading-p) (outline-next-heading))
9172 (setq start (point))
9173 (goto-char (point-max))
9174 (beginning-of-line 1)
9175 (when (looking-at ".*?\\S-")
9176 ;; File ends in a non-white line
9179 (setq end (point-max))
9180 (setq what "top-level")
9182 (outline-show-all)))
9185 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
9187 (looking-at "\\(\\*+\\)")
9188 (setq stars (match-string 1)
9189 re (concat "^" (regexp-quote stars) " +")
9190 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
9191 txt (buffer-substring beg end))
9192 (unless (equal (substring txt -1) "\n") (setq txt (concat txt "\n")))
9193 (when (and (not (equal stars "*")) (string-match re2 txt))
9194 (user-error "Region to sort contains a level above the first entry"))
9196 (unless sorting-type
9198 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
9199 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
9200 A/N/P/R/O/F/T/S/D/C/K means reversed:"
9202 (setq sorting-type (read-char-exclusive))
9205 (and (= (downcase sorting-type) ?f)
9207 (completing-read "Sort using function: "
9208 obarray 'fboundp t nil nil))
9209 (setq getkey-func (intern getkey-func))))
9211 (and (= (downcase sorting-type) ?r)
9214 (completing-read "Property: "
9215 (mapcar #'list (org-buffer-property-keys t))
9218 (when (member sorting-type '(?k ?K)) (org-clock-sum))
9219 (message "Sorting entries...")
9222 (narrow-to-region start end)
9223 (let ((dcst (downcase sorting-type))
9224 (case-fold-search nil)
9225 (now (current-time)))
9227 (/= dcst sorting-type)
9228 ;; This function moves to the beginning character of the "record" to
9231 (if (re-search-forward re nil t)
9232 (goto-char (match-beginning 0))
9233 (goto-char (point-max))))
9234 ;; This function moves to the last character of the "record" being
9239 (outline-forward-same-level 1)
9241 (goto-char (point-max))))))
9242 ;; This function returns the value that gets sorted against.
9246 (if (looking-at org-complex-heading-regexp)
9247 (string-to-number (org-sort-remove-invisible (match-string 4)))
9250 (if (looking-at org-complex-heading-regexp)
9251 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9254 (or (get-text-property (point) :org-clock-minutes) 0))
9256 (let ((end (save-excursion (outline-next-heading) (point))))
9257 (if (or (re-search-forward org-ts-regexp end t)
9258 (re-search-forward org-ts-regexp-both end t))
9259 (org-time-string-to-seconds (match-string 0))
9262 (let ((end (save-excursion (outline-next-heading) (point))))
9263 (if (re-search-forward
9264 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9266 (org-time-string-to-seconds (match-string 0))
9269 (let ((end (save-excursion (outline-next-heading) (point))))
9270 (if (re-search-forward org-scheduled-time-regexp end t)
9271 (org-time-string-to-seconds (match-string 1))
9274 (let ((end (save-excursion (outline-next-heading) (point))))
9275 (if (re-search-forward org-deadline-time-regexp end t)
9276 (org-time-string-to-seconds (match-string 1))
9279 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9280 (string-to-char (match-string 2))
9281 org-default-priority))
9283 (or (org-entry-get nil property) ""))
9285 (when (looking-at org-complex-heading-regexp)
9286 (let* ((m (match-string 2))
9287 (s (if (member m org-done-keywords) '- '+)))
9288 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9292 (setq tmp (funcall getkey-func))
9293 (when (stringp tmp) (setq tmp (funcall case-func tmp)))
9295 (error "Invalid key function `%s'" getkey-func)))
9296 (t (error "Invalid sorting type `%c'" sorting-type))))
9299 ((= dcst ?a) 'string<)
9300 ((= dcst ?f) compare-func)
9301 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9302 (run-hooks 'org-after-sorting-entries-or-items-hook)
9303 ;; Reset the clock marker if needed
9307 (search-forward cmstr nil t)
9308 (move-marker org-clock-marker (point))))
9309 (message "Sorting entries...done")))
9311 ;;; The orgstruct minor mode
9313 ;; Define a minor mode which can be used in other modes in order to
9314 ;; integrate the Org mode structure editing commands.
9316 ;; This is really a hack, because the Org mode structure commands use
9317 ;; keys which normally belong to the major mode. Here is how it
9318 ;; works: The minor mode defines all the keys necessary to operate the
9319 ;; structure commands, but wraps the commands into a function which
9320 ;; tests if the cursor is currently at a headline or a plain list
9321 ;; item. If that is the case, the structure command is used,
9322 ;; temporarily setting many Org mode variables like regular
9323 ;; expressions for filling etc. However, when any of those keys is
9324 ;; used at a different location, function uses `key-binding' to look
9325 ;; up if the key has an associated command in another currently active
9326 ;; keymap (minor modes, major mode, global), and executes that
9327 ;; command. There might be problems if any of the keys is otherwise
9328 ;; used as a prefix key.
9330 (defcustom orgstruct-heading-prefix-regexp ""
9331 "Regexp that matches the custom prefix of Org headlines in
9332 orgstruct(++)-mode."
9335 :package-version '(Org . "8.3")
9337 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9339 (defcustom orgstruct-setup-hook nil
9340 "Hook run after orgstruct-mode-map is filled."
9343 :package-version '(Org . "8.0")
9346 (defvar orgstruct-initialized nil)
9348 (defvar org-local-vars nil
9349 "List of local variables, for use by `orgstruct-mode'.")
9352 (define-minor-mode orgstruct-mode
9353 "Toggle the minor mode `orgstruct-mode'.
9354 This mode is for using Org mode structure commands in other
9355 modes. The following keys behave as if Org mode were active, if
9356 the cursor is on a headline, or on a plain list item (both as
9357 defined by Org mode)."
9358 nil " OrgStruct" (make-sparse-keymap)
9359 (funcall (if orgstruct-mode
9360 'add-to-invisibility-spec
9361 'remove-from-invisibility-spec)
9363 (when orgstruct-mode
9364 (org-load-modules-maybe)
9365 (unless orgstruct-initialized
9367 (setq orgstruct-initialized t))))
9370 (defun turn-on-orgstruct ()
9371 "Unconditionally turn on `orgstruct-mode'."
9374 (defvar-local orgstruct-is-++ nil
9375 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9376 (defvar-local org-fb-vars nil)
9377 (defun orgstruct++-mode (&optional arg)
9378 "Toggle `orgstruct-mode', the enhanced version of it.
9379 In addition to setting orgstruct-mode, this also exports all
9380 indentation and autofilling variables from Org mode into the
9381 buffer. It will also recognize item context in multiline items."
9383 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9385 (progn (orgstruct-mode -1)
9386 (dolist (v org-fb-vars)
9387 (set (make-local-variable (car v))
9388 (if (eq (car-safe (cadr v)) 'quote)
9392 (setq org-fb-vars nil)
9393 (unless org-local-vars
9394 (setq org-local-vars (org-get-local-variables)))
9396 (dolist (x org-local-vars)
9398 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\
9399 \\|fill-prefix\\|indent-\\)"
9400 (symbol-name (car x)))
9401 (setq var (car x) val (nth 1 x))
9402 (push (list var `(quote ,(eval var))) org-fb-vars)
9403 (set (make-local-variable var)
9404 (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9405 (setq-local orgstruct-is-++ t))))
9408 (defun turn-on-orgstruct++ ()
9409 "Unconditionally turn on `orgstruct++-mode'."
9410 (orgstruct++-mode 1))
9412 (defun orgstruct-error ()
9413 "Error when there is no default binding for a structure key."
9415 (funcall (if (fboundp 'user-error)
9418 "This key has no function outside structure elements"))
9420 (defun orgstruct-setup ()
9421 "Setup orgstruct keymap."
9422 (dolist (cell '((org-demote . t)
9426 (org-shiftmetaleft . t)
9427 (org-shiftmetaright . t)
9428 org-backward-element
9429 org-backward-heading-same-level
9434 org-force-cycle-archived
9435 org-forward-heading-same-level
9437 org-insert-heading-respect-content
9438 org-kill-note-or-show-branches
9443 org-narrow-to-subtree
9459 outline-next-visible-heading
9460 outline-previous-visible-heading
9462 outline-up-heading))
9463 (let ((f (or (car-safe cell) cell))
9464 (disable-when-heading-prefix (cdr-safe cell)))
9466 (let ((new-bindings))
9467 (dolist (binding (nconc (where-is-internal f org-mode-map)
9468 (where-is-internal f outline-mode-map)))
9469 (push binding new-bindings)
9470 ;; TODO use local-function-key-map
9471 (dolist (rep '(("<tab>" . "TAB")
9472 ("<return>" . "RET")
9473 ("<escape>" . "ESC")
9474 ("<delete>" . "DEL")))
9475 (setq binding (read-kbd-macro
9476 (let ((case-fold-search))
9477 (replace-regexp-in-string
9478 (regexp-quote (cdr rep))
9480 (key-description binding)))))
9481 (cl-pushnew binding new-bindings :test 'equal)))
9482 (dolist (binding new-bindings)
9483 (let ((key (lookup-key orgstruct-mode-map binding)))
9484 (when (or (not key) (numberp key))
9486 (org-defkey orgstruct-mode-map
9488 (orgstruct-make-binding
9489 f binding disable-when-heading-prefix))))))))))
9490 (run-hooks 'orgstruct-setup-hook))
9492 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9493 "Create a function for binding in the structure minor mode.
9494 FUN is the command to call inside a table. KEY is the key that
9495 should be checked in for a command to execute outside of tables.
9496 Non-nil `disable-when-heading-prefix' means to disable the command
9497 if `orgstruct-heading-prefix-regexp' is not empty."
9498 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9501 (while (fboundp (intern nname))
9502 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9503 (setq name (intern nname)))
9505 (let ((bindings '((org-heading-regexp
9507 orgstruct-heading-prefix-regexp
9508 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9510 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9511 (org-outline-regexp-bol
9512 (concat "^" org-outline-regexp))
9513 (outline-regexp org-outline-regexp)
9514 (outline-heading-end-regexp "\n")
9515 (outline-level 'org-outline-level)
9516 (outline-heading-alist))))
9518 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9519 "Outside of structure, run the binding of `"
9520 (key-description key) "'."
9521 (when disable-when-heading-prefix
9523 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9524 "back to the default binding due to limitations of Org's implementation of\n"
9525 "`" (symbol-name fun) "'.")))
9528 ,(and disable-when-heading-prefix
9529 '(not (string= orgstruct-heading-prefix-regexp ""))))
9534 (org-context-p 'headline 'item
9536 '(org-insert-heading
9537 org-insert-heading-respect-content
9539 '(when orgstruct-is-++
9542 (let* ((orgstruct-mode)
9549 ("<\\([^>]*\\)tab>" . "\\1TAB")
9550 ("<\\([^>]*\\)return>" . "\\1RET")
9551 ("<\\([^>]*\\)escape>" . "\\1ESC")
9552 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9555 (setq key (read-kbd-macro
9556 (let ((case-fold-search))
9557 (replace-regexp-in-string
9560 (key-description key))))))
9561 (when (key-binding key)
9562 (throw 'exit (key-binding key))))))))
9563 (if (keymapp binding)
9564 (org-set-transient-map binding)
9565 (let ((func (or binding
9567 'orgstruct-error))))
9569 (call-interactively func)))))
9570 (org-run-like-in-org-mode
9574 (call-interactively ',fun)))))))))
9577 (defun org-contextualize-keys (alist contexts)
9578 "Return valid elements in ALIST depending on CONTEXTS.
9580 `org-agenda-custom-commands' or `org-capture-templates' are the
9581 values used for ALIST, and `org-agenda-custom-commands-contexts'
9582 or `org-capture-templates-contexts' are the associated contexts
9585 ;; normalize contexts
9587 (lambda(c) (cond ((listp (cadr c))
9588 (list (car c) (car c) (nth 1 c)))
9589 ((string= "" (cadr c))
9590 (list (car c) (car c) (nth 2 c)))
9594 ;; loop over all commands or templates
9598 ((not (assoc (car c) contexts))
9600 ((and (assoc (car c) contexts)
9601 (setq vrules (org-contextualize-validate-key
9604 (unless (equal (car vr) (cadr vr))
9607 (if (not repl) (push c r)
9608 (push (cadr repl) s)
9611 (cdr (or (assoc (cadr repl) alist)
9612 (error "Undefined key `%s' as contextual replacement for `%s'"
9613 (cadr repl) (car c)))))
9615 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9620 (let ((tpl (car x)))
9629 (defun org-contextualize-validate-key (key contexts)
9630 "Check CONTEXTS for agenda or capture KEY."
9632 (dolist (r contexts)
9633 (dolist (rr (car (last r)))
9635 (and (equal key (car r))
9636 (if (functionp rr) (funcall rr)
9637 (or (and (eq (car rr) 'in-file)
9639 (string-match (cdr rr) (buffer-file-name)))
9640 (and (eq (car rr) 'in-mode)
9641 (string-match (cdr rr) (symbol-name major-mode)))
9642 (and (eq (car rr) 'in-buffer)
9643 (string-match (cdr rr) (buffer-name)))
9644 (when (and (eq (car rr) 'not-in-file)
9646 (not (string-match (cdr rr) (buffer-file-name))))
9647 (when (eq (car rr) 'not-in-mode)
9648 (not (string-match (cdr rr) (symbol-name major-mode))))
9649 (when (eq (car rr) 'not-in-buffer)
9650 (not (string-match (cdr rr) (buffer-name)))))))
9652 (delete-dups (delq nil res))))
9654 (defun org-context-p (&rest contexts)
9655 "Check if local context is any of CONTEXTS.
9656 Possible values in the list of contexts are `table', `headline', and `item'."
9657 (let ((pos (point)))
9658 (goto-char (point-at-bol))
9659 (prog1 (or (and (memq 'table contexts)
9660 (looking-at "[ \t]*|"))
9661 (and (memq 'headline contexts)
9662 (looking-at org-outline-regexp))
9663 (and (memq 'item contexts)
9664 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9665 (and (memq 'item-body contexts)
9669 (defconst org-unique-local-variables
9670 '(org-element--cache
9671 org-element--cache-objects
9672 org-element--cache-sync-keys
9673 org-element--cache-sync-requests
9674 org-element--cache-sync-timer)
9675 "List of local variables that cannot be transferred to another buffer.")
9677 (defun org-get-local-variables ()
9678 "Return a list of all local variables in an Org mode buffer."
9682 (let* ((binding (if (symbolp x) (list x) (list (car x) (cdr x))))
9683 (name (car binding)))
9684 (and (not (get name 'org-state))
9685 (not (memq name org-unique-local-variables))
9687 "\\`\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|\
9688 auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9693 (buffer-local-variables)))))
9695 (defun org-clone-local-variables (from-buffer &optional regexp)
9696 "Clone local variables from FROM-BUFFER.
9697 Optional argument REGEXP selects variables to clone."
9698 (dolist (pair (buffer-local-variables from-buffer))
9699 (let ((name (car pair)))
9700 (when (and (symbolp name)
9701 (not (memq name org-unique-local-variables))
9702 (or (null regexp) (string-match regexp (symbol-name name))))
9703 (set (make-local-variable name) (cdr pair))))))
9706 (defun org-run-like-in-org-mode (cmd)
9707 "Run a command, pretending that the current buffer is in Org mode.
9708 This will temporarily bind local variables that are typically bound in
9709 Org mode to the values they have in Org mode, and then interactively
9711 (org-load-modules-maybe)
9712 (unless org-local-vars
9713 (setq org-local-vars (org-get-local-variables)))
9715 (dolist (var org-local-vars)
9716 (when (or (not (boundp (car var)))
9717 (eq (symbol-value (car var))
9718 (default-value (car var))))
9719 (push (list (car var) `(quote ,(cadr var))) binds)))
9721 (call-interactively (quote ,cmd))))))
9723 (defun org-get-category (&optional pos force-refresh)
9724 "Get the category applying to position POS."
9726 (when force-refresh (org-refresh-category-properties))
9727 (let ((pos (or pos (point))))
9728 (or (get-text-property pos 'org-category)
9729 (progn (org-refresh-category-properties)
9730 (get-text-property pos 'org-category))))))
9732 ;;; Refresh properties
9734 (defun org-refresh-properties (dprop tprop)
9735 "Refresh buffer text properties.
9736 DPROP is the drawer property and TPROP is either the
9737 corresponding text property to set, or an alist with each element
9738 being a text property (as a symbol) and a function to apply to
9739 the value of the drawer property."
9740 (let* ((case-fold-search t)
9741 (inhibit-read-only t)
9742 (inherit? (org-property-inherit-p dprop))
9743 (property-re (org-re-property (concat (regexp-quote dprop) "\\+?") t))
9744 (global (and inherit? (org--property-global-value dprop nil))))
9745 (org-with-silent-modifications
9746 (org-with-point-at 1
9747 ;; Set global values (e.g., values defined through
9748 ;; "#+PROPERTY:" keywords) to the whole buffer.
9749 (when global (put-text-property (point-min) (point-max) tprop global))
9750 ;; Set local values.
9751 (while (re-search-forward property-re nil t)
9752 (when (org-at-property-p)
9753 (org-refresh-property tprop (org-entry-get (point) dprop) inherit?))
9754 (outline-next-heading))))))
9756 (defun org-refresh-property (tprop p &optional inherit)
9757 "Refresh the buffer text property TPROP from the drawer property P.
9758 The refresh happens only for the current headline, or the whole
9759 sub-tree if optional argument INHERIT is non-nil."
9760 (unless (org-before-first-heading-p)
9762 (org-back-to-heading t)
9763 (let ((start (point))
9764 (end (save-excursion
9765 (if inherit (org-end-of-subtree t t)
9766 (or (outline-next-heading) (point-max))))))
9768 ;; TPROP is a text property symbol.
9769 (put-text-property start end tprop p)
9770 ;; TPROP is an alist with (property . function) elements.
9771 (pcase-dolist (`(,prop . ,f) tprop)
9772 (put-text-property start end prop (funcall f p))))))))
9774 (defun org-refresh-category-properties ()
9775 "Refresh category text properties in the buffer."
9776 (let ((case-fold-search t)
9777 (inhibit-read-only t)
9779 (cond ((null org-category)
9780 (if buffer-file-name
9781 (file-name-sans-extension
9782 (file-name-nondirectory buffer-file-name))
9784 ((symbolp org-category) (symbol-name org-category))
9786 (org-with-silent-modifications
9787 (org-with-wide-buffer
9788 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9789 ;; This is the default category for the buffer. If none is
9790 ;; found, fall-back to `org-category' or buffer file name.
9792 (point-min) (point-max)
9794 (catch 'buffer-category
9795 (goto-char (point-max))
9796 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9797 (let ((element (org-element-at-point)))
9798 (when (eq (org-element-type element) 'keyword)
9799 (throw 'buffer-category
9800 (org-element-property :value element)))))
9802 ;; Set sub-tree specific categories.
9803 (goto-char (point-min))
9804 (let ((regexp (org-re-property "CATEGORY")))
9805 (while (re-search-forward regexp nil t)
9806 (let ((value (match-string-no-properties 3)))
9807 (when (org-at-property-p)
9809 (save-excursion (org-back-to-heading t) (point))
9810 (save-excursion (org-end-of-subtree t t) (point))
9814 (defun org-refresh-stats-properties ()
9815 "Refresh stats text properties in the buffer."
9817 (org-with-silent-modifications
9818 (org-with-wide-buffer
9819 (goto-char (point-min))
9820 (while (re-search-forward
9821 (concat org-outline-regexp-bol ".*"
9822 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9824 (setq stats (cond ((equal (match-string 3) "0") 0)
9826 (/ (* (string-to-number (match-string 2)) 100)
9827 (string-to-number (match-string 3))))
9828 (t (string-to-number (match-string 1)))))
9829 (org-back-to-heading t)
9830 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9831 'org-stats stats))))))
9833 (defun org-refresh-effort-properties ()
9834 "Refresh effort properties"
9835 (org-refresh-properties
9837 '((effort . identity)
9838 (effort-minutes . org-duration-string-to-minutes))))
9842 ;;; Link abbreviations
9844 (defun org-link-expand-abbrev (link)
9845 "Apply replacements as defined in `org-link-abbrev-alist'."
9846 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9847 (let* ((key (match-string 1 link))
9848 (as (or (assoc key org-link-abbrev-alist-local)
9849 (assoc key org-link-abbrev-alist)))
9850 (tag (and (match-end 2) (match-string 3 link)))
9856 ((symbolp rpl) (funcall rpl tag))
9857 ((string-match "%(\\([^)]+\\))" rpl)
9860 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9861 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9862 ((string-match "%h" rpl)
9863 (replace-match (url-hexify-string (or tag "")) t t rpl))
9864 (t (concat rpl tag)))))
9867 ;;; Storing and inserting links
9869 (defvar org-insert-link-history nil
9870 "Minibuffer history for links inserted with `org-insert-link'.")
9872 (defvar org-stored-links nil
9873 "Contains the links stored with `org-store-link'.")
9875 (defvar org-store-link-plist nil
9876 "Plist with info about the most recently link created with `org-store-link'.")
9878 (defun org-store-link-functions ()
9879 "Return a list of functions that are called to create and store a link.
9880 The functions defined in the :store property of
9881 `org-link-parameters'.
9883 Each function will be called in turn until one returns a non-nil
9884 value. Each function should check if it is responsible for
9885 creating this link (for example by looking at the major mode).
9886 If not, it must exit and return nil. If yes, it should return
9887 a non-nil value after calling `org-store-link-props' with a list
9888 of properties and values. Special properties are:
9890 :type The link prefix, like \"http\". This must be given.
9891 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9892 This is obligatory as well.
9893 :description Optional default description for the second pair
9894 of brackets in an Org mode link. The user can still change
9895 this when inserting this link into an Org mode buffer.
9897 In addition to these, any additional properties can be specified
9898 and then used in capture templates."
9899 (cl-loop for link in org-link-parameters
9901 do (setq store-func (org-link-get-parameter (car link) :store))
9903 collect store-func))
9905 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9906 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9909 (defun org-store-link (arg)
9910 "Store an org-link to the current location.
9912 This link is added to `org-stored-links' and can later be inserted
9913 into an Org buffer with `org-insert-link' (`\\[org-insert-link]').
9915 For some link types, a `\\[universal-argument]' prefix ARG is interpreted.
9916 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9917 For file links, ARG negates `org-context-in-file-links'.
9919 A `\\[universal-argument] \\[universal-argument]' prefix ARG forces \
9920 skipping storing functions that are not
9923 A `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
9924 prefix ARG forces storing a link for each line in the
9927 (org-load-modules-maybe)
9928 (if (and (equal arg '(64)) (org-region-active-p))
9930 (let ((end (region-end)))
9931 (goto-char (region-beginning))
9933 (while (< (point-at-eol) end)
9934 (move-end-of-line 1) (activate-mark)
9935 (let (current-prefix-arg)
9936 (call-interactively 'org-store-link))
9937 (move-beginning-of-line 2)
9938 (set-mark (point)))))
9939 (setq org-store-link-plist nil)
9940 (let (link cpltxt desc description search
9941 txt custom-id agenda-link sfuns sfunsn)
9944 ;; Store a link using an external link type
9945 ((and (not (equal arg '(16)))
9948 nil (mapcar (lambda (f)
9949 (let (fs) (if (funcall f) (push f fs))))
9950 (org-store-link-functions)))
9951 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9952 (or (and (cdr sfuns)
9955 "Which function for creating the link? "
9956 sfunsn nil t (car sfunsn)))))
9957 (funcall (caar sfuns)))
9958 (setq link (plist-get org-store-link-plist :link)
9959 desc (or (plist-get org-store-link-plist
9963 ;; Store a link from a source code buffer.
9964 ((org-src-edit-buffer-p)
9965 (let ((coderef-format (org-src-coderef-format)))
9966 (cond ((save-excursion
9968 (looking-at (org-src-coderef-regexp coderef-format)))
9969 (setq link (format "(%s)" (match-string-no-properties 3))))
9970 ((called-interactively-p 'any)
9971 (let ((label (read-string "Code line label: ")))
9973 (setq link (format coderef-format label))
9974 (let ((gc (- 79 (length link))))
9975 (if (< (current-column) gc)
9976 (org-move-to-column gc t)
9979 (setq link (concat "(" label ")"))
9981 (t (setq link nil)))))
9983 ;; We are in the agenda, link to referenced location
9984 ((equal (bound-and-true-p org-agenda-buffer-name) (buffer-name))
9985 (let ((m (or (get-text-property (point) 'org-hd-marker)
9986 (get-text-property (point) 'org-marker))))
9988 (org-with-point-at m
9990 (if (called-interactively-p 'any)
9991 (call-interactively 'org-store-link)
9992 (org-store-link nil)))))))
9994 ((eq major-mode 'calendar-mode)
9995 (let ((cd (calendar-cursor-to-date)))
9998 (car org-time-stamp-formats)
10000 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
10002 (org-store-link-props :type "calendar" :date cd)))
10004 ((eq major-mode 'help-mode)
10005 (setq link (concat "help:" (save-excursion
10006 (goto-char (point-min))
10007 (looking-at "^[^ ]+")
10008 (match-string 0))))
10009 (org-store-link-props :type "help"))
10011 ((eq major-mode 'w3-mode)
10012 (setq cpltxt (if (and (buffer-name)
10013 (not (string-match "Untitled" (buffer-name))))
10016 link (url-view-url t))
10017 (org-store-link-props :type "w3" :url (url-view-url t)))
10019 ((eq major-mode 'image-mode)
10020 (setq cpltxt (concat "file:"
10021 (abbreviate-file-name buffer-file-name))
10023 (org-store-link-props :type "image" :file buffer-file-name))
10025 ;; In dired, store a link to the file of the current line
10026 ((derived-mode-p 'dired-mode)
10027 (let ((file (dired-get-filename nil t)))
10028 (setq file (if file
10029 (abbreviate-file-name
10030 (expand-file-name (dired-get-filename nil t)))
10031 ;; otherwise, no file so use current directory.
10032 default-directory))
10033 (setq cpltxt (concat "file:" file)
10036 ((setq search (run-hook-with-args-until-success
10037 'org-create-file-search-functions))
10038 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
10040 (setq cpltxt (or description link)))
10042 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
10043 (org-with-limited-levels
10044 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
10046 ;; Store a link using the target at point
10047 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
10050 (abbreviate-file-name
10051 (buffer-file-name (buffer-base-buffer)))
10052 "::" (match-string 1))
10054 ((and (featurep 'org-id)
10055 (or (eq org-id-link-to-org-use-id t)
10056 (and (called-interactively-p 'any)
10057 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
10058 (and (eq org-id-link-to-org-use-id
10059 'create-if-interactive-and-no-custom-id)
10061 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
10062 ;; Store a link using the ID at point
10063 (setq link (condition-case nil
10064 (prog1 (org-id-store-link)
10065 (setq desc (or (plist-get org-store-link-plist
10069 ;; Probably before first headline, link only to file
10071 (abbreviate-file-name
10072 (buffer-file-name (buffer-base-buffer))))))))
10074 ;; Just link to current headline
10075 (setq cpltxt (concat "file:"
10076 (abbreviate-file-name
10077 (buffer-file-name (buffer-base-buffer)))))
10078 ;; Add a context search string
10079 (when (org-xor org-context-in-file-links arg)
10080 (let* ((element (org-element-at-point))
10081 (name (org-element-property :name element)))
10083 ((org-at-heading-p) nil)
10085 ((org-region-active-p)
10086 (buffer-substring (region-beginning) (region-end)))))
10087 (when (or (null txt) (string-match "\\S-" txt))
10089 (concat cpltxt "::"
10090 (condition-case nil
10091 (org-make-org-heading-search-string txt)
10094 (nth 4 (ignore-errors (org-heading-components)))
10096 (when (string-match "::\\'" cpltxt)
10097 (setq cpltxt (substring cpltxt 0 -2)))
10098 (setq link cpltxt)))))
10100 ((buffer-file-name (buffer-base-buffer))
10101 ;; Just link to this file here.
10102 (setq cpltxt (concat "file:"
10103 (abbreviate-file-name
10104 (buffer-file-name (buffer-base-buffer)))))
10105 ;; Add a context string.
10106 (when (org-xor org-context-in-file-links arg)
10107 (setq txt (if (org-region-active-p)
10108 (buffer-substring (region-beginning) (region-end))
10109 (buffer-substring (point-at-bol) (point-at-eol))))
10110 ;; Only use search option if there is some text.
10111 (when (string-match "\\S-" txt)
10113 (concat cpltxt "::" (org-make-org-heading-search-string txt))
10115 (setq link cpltxt))
10117 ((called-interactively-p 'interactive)
10118 (user-error "No method for storing a link from this buffer"))
10120 (t (setq link nil)))
10122 ;; We're done setting link and desc, clean up
10123 (when (consp link) (setq cpltxt (car link) link (cdr link)))
10124 (setq link (or link cpltxt)
10125 desc (or desc cpltxt))
10127 ((equal desc "NONE") (setq desc nil))
10129 (replace-regexp-in-string
10130 org-bracket-link-analytic-regexp
10131 (lambda (m) (or (match-string 5 m) (match-string 3 m)))
10134 (if (not (and (or (called-interactively-p 'any)
10135 executing-kbd-macro)
10137 (or agenda-link (and link (org-make-link-string link desc)))
10138 (push (list link desc) org-stored-links)
10139 (message "Stored: %s" (or desc link))
10141 (setq link (concat "file:" (abbreviate-file-name
10142 (buffer-file-name)) "::#" custom-id))
10143 (push (list link desc) org-stored-links))
10144 (car org-stored-links)))))
10146 (defun org-store-link-props (&rest plist)
10147 "Store link properties, extract names, addresses and dates."
10148 (let ((x (plist-get plist :from)))
10150 (let ((adr (mail-extract-address-components x)))
10151 (setq plist (plist-put plist :fromname (car adr)))
10152 (setq plist (plist-put plist :fromaddress (nth 1 adr))))))
10153 (let ((x (plist-get plist :to)))
10155 (let ((adr (mail-extract-address-components x)))
10156 (setq plist (plist-put plist :toname (car adr)))
10157 (setq plist (plist-put plist :toaddress (nth 1 adr))))))
10158 (let ((x (ignore-errors (date-to-time (plist-get plist :date)))))
10160 (setq plist (plist-put plist :date-timestamp
10161 (format-time-string
10162 (org-time-stamp-format t) x)))
10163 (setq plist (plist-put plist :date-timestamp-inactive
10164 (format-time-string
10165 (org-time-stamp-format t t) x)))))
10166 (let ((from (plist-get plist :from))
10167 (to (plist-get plist :to)))
10168 (when (and from to org-from-is-user-regexp)
10170 (plist-put plist :fromto
10171 (if (string-match org-from-is-user-regexp from)
10173 (concat "from %f"))))))
10174 (setq org-store-link-plist plist))
10176 (defun org-add-link-props (&rest plist)
10177 "Add these properties to the link property list."
10180 (setq key (pop plist) value (pop plist))
10181 (setq org-store-link-plist
10182 (plist-put org-store-link-plist key value)))))
10184 (defun org-email-link-description (&optional fmt)
10185 "Return the description part of an email link.
10186 This takes information from `org-store-link-plist' and formats it
10187 according to FMT (default from `org-email-link-description-format')."
10188 (setq fmt (or fmt org-email-link-description-format))
10189 (let* ((p org-store-link-plist)
10190 (to (plist-get p :toaddress))
10191 (from (plist-get p :fromaddress))
10194 (cons "%c" (plist-get p :fromto))
10195 (cons "%F" (plist-get p :from))
10196 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10197 (cons "%T" (plist-get p :to))
10198 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10199 (cons "%s" (plist-get p :subject))
10200 (cons "%d" (plist-get p :date))
10201 (cons "%m" (plist-get p :message-id)))))
10202 (when (string-match "%c" fmt)
10203 ;; Check if the user wrote this message
10204 (if (and org-from-is-user-regexp from to
10205 (save-match-data (string-match org-from-is-user-regexp from)))
10206 (setq fmt (replace-match "to %t" t t fmt))
10207 (setq fmt (replace-match "from %f" t t fmt))))
10208 (org-replace-escapes fmt table)))
10210 (defun org-make-org-heading-search-string (&optional string)
10211 "Make search string for the current headline or STRING."
10212 (let ((s (or string
10213 (and (derived-mode-p 'org-mode)
10215 (org-back-to-heading t)
10216 (org-element-property :raw-value (org-element-at-point))))))
10217 (lines org-context-in-file-links))
10218 (or string (setq s (concat "*" s))) ; Add * for headlines
10219 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10220 (when (and string (integerp lines) (> lines 0))
10221 (let ((slines (org-split-string s "\n")))
10222 (when (< lines (length slines))
10225 (reverse (nthcdr (- (length slines) lines)
10226 (reverse slines))) "\n")))))
10227 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10229 (defun org-make-link-string (link &optional description)
10230 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10231 (unless (org-string-nw-p link) (error "Empty link"))
10232 (let ((uri (cond ((string-match org-link-types-re link)
10233 (concat (match-string 1 link)
10234 (org-link-escape (substring link (match-end 1)))))
10235 ;; For readability, url-encode internal links only
10236 ;; when absolutely needed (i.e, when they contain
10237 ;; square brackets). File links however, are
10238 ;; encoded since, e.g., spaces are significant.
10239 ((or (file-name-absolute-p link)
10240 (string-match-p "\\`\\.\\.?/\\|[][]" link))
10241 (org-link-escape link))
10244 (and (org-string-nw-p description)
10245 ;; Remove brackets from description, as they are fatal.
10246 (replace-regexp-in-string
10247 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10248 (org-trim description)))))
10251 (if description (format "[%s]" description) ""))))
10253 (defconst org-link-escape-chars
10256 "List of characters that should be escaped in a link when stored to Org.
10257 This is the list that is used for internal purposes.")
10259 (defun org-link-escape (text &optional table merge)
10260 "Return percent escaped representation of TEXT.
10261 TEXT is a string with the text to escape.
10262 Optional argument TABLE is a list with characters that should be
10263 escaped. When nil, `org-link-escape-chars' is used.
10264 If optional argument MERGE is set, merge TABLE into
10265 `org-link-escape-chars'."
10266 (let ((characters-to-encode
10267 (cond ((null table) org-link-escape-chars)
10268 (merge (append org-link-escape-chars table))
10272 (if (or (memq c characters-to-encode)
10273 (and org-url-hexify-p (or (< c 32) (> c 126))))
10274 (mapconcat (lambda (e) (format "%%%.2X" e))
10275 (or (encode-coding-char c 'utf-8)
10276 (error "Unable to percent escape character: %c" c))
10278 (char-to-string c)))
10281 (defun org-link-unescape (str)
10282 "Unhex hexified Unicode parts in string STR.
10283 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10284 reciprocal of `org-link-escape', which see."
10285 (if (org-string-nw-p str)
10286 (replace-regexp-in-string
10287 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10290 (defun org-link-unescape-compound (hex)
10291 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10292 Note: this function also decodes single byte encodings like
10293 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10295 (let* ((bytes (cdr (split-string hex "%")))
10300 (let* ((val (string-to-number (pop bytes) 16))
10304 ((>= val 252) (cons 6 252))
10305 ((>= val 248) (cons 5 248))
10306 ((>= val 240) (cons 4 240))
10307 ((>= val 224) (cons 3 224))
10308 ((>= val 192) (cons 2 192))
10311 (when (>= val 192) (setq eat (car shift-xor)))
10312 (setq val (logxor val (cdr shift-xor)))
10313 (setq sum (+ (lsh sum (car shift-xor)) val))
10314 (when (> eat 0) (setq eat (- eat 1)))
10316 ((= 0 eat) ;multi byte
10317 (setq ret (concat ret (char-to-string sum)))
10319 ((not bytes) ; single byte(s)
10320 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10323 (defun org-link-unescape-single-byte-sequence (hex)
10324 "Unhexify hex-encoded single byte character sequences."
10325 (mapconcat (lambda (byte)
10326 (char-to-string (string-to-number byte 16)))
10327 (cdr (split-string hex "%")) ""))
10329 (defun org-xor (a b)
10333 (defun org-fixup-message-id-for-http (s)
10334 "Replace special characters in a message id, so it can be used in an http query."
10335 (when (string-match "%" s)
10336 (setq s (mapconcat (lambda (c)
10339 (char-to-string c)))
10341 (while (string-match "<" s)
10342 (setq s (replace-match "%3C" t t s)))
10343 (while (string-match ">" s)
10344 (setq s (replace-match "%3E" t t s)))
10345 (while (string-match "@" s)
10346 (setq s (replace-match "%40" t t s)))
10349 (defun org-link-prettify (link)
10350 "Return a human-readable representation of LINK.
10351 The car of LINK must be a raw link.
10352 The cdr of LINK must be either a link description or nil."
10353 (let ((desc (or (cadr link) "<no description>")))
10354 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10355 "<" (car link) ">")))
10358 (defun org-insert-link-global ()
10359 "Insert a link like Org mode does.
10360 This command can be called in any mode to insert a link in Org syntax."
10362 (org-load-modules-maybe)
10363 (org-run-like-in-org-mode 'org-insert-link))
10365 (defun org-insert-all-links (arg &optional pre post)
10366 "Insert all links in `org-stored-links'.
10367 When a universal prefix, do not delete the links from `org-stored-links'.
10368 When `ARG' is a number, insert the last N link(s).
10369 `PRE' and `POST' are optional arguments to define a string to
10370 prepend or to append."
10372 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10373 (links (copy-sequence org-stored-links))
10375 (po (or post "\n"))
10377 (if (null org-stored-links)
10378 (message "No link to insert")
10379 (while (and (or (listp arg) (>= arg cnt))
10380 (setq l (if (listp arg)
10382 (pop org-stored-links))))
10383 (setq cnt (1+ cnt))
10385 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10388 (defun org-insert-last-stored-link (arg)
10389 "Insert the last link stored in `org-stored-links'."
10391 (org-insert-all-links arg "" "\n"))
10393 (defun org-link-fontify-links-to-this-file ()
10394 "Fontify links to the current file in `org-stored-links'."
10395 (let ((f (buffer-file-name)) a b)
10396 (setq a (mapcar (lambda(l)
10397 (let ((ll (car l)))
10398 (when (and (string-match "^file:\\(.+\\)::" ll)
10399 (equal f (expand-file-name (match-string 1 ll))))
10402 (when (featurep 'org-id)
10403 (setq b (mapcar (lambda(l)
10404 (let ((ll (car l)))
10405 (when (and (string-match "^id:\\(.+\\)$" ll)
10406 (equal f (expand-file-name
10407 (or (org-id-find-id-file
10408 (match-string 1 ll)) ""))))
10410 org-stored-links)))
10412 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10413 (delq nil (append a b)))))
10415 (defvar org--links-history nil)
10416 (defun org-insert-link (&optional complete-file link-location default-description)
10417 "Insert a link. At the prompt, enter the link.
10419 Completion can be used to insert any of the link protocol prefixes in use.
10421 The history can be used to select a link previously stored with
10422 `org-store-link'. When the empty string is entered (i.e. if you just
10423 press `RET' at the prompt), the link defaults to the most recently
10424 stored link. As `SPC' triggers completion in the minibuffer, you need to
10425 use `M-SPC' or `C-q SPC' to force the insertion of a space character.
10427 You will also be prompted for a description, and if one is given, it will
10428 be displayed in the buffer instead of the link.
10430 If there is already a link at point, this command will allow you to edit
10431 link and description parts.
10433 With a `\\[universal-argument]' prefix, prompts for a file to link to. The \
10435 selected using completion. The path to the file will be relative to the
10436 current directory if the file is in the current directory or a subdirectory.
10437 Otherwise, the link will be the absolute path as completed in the minibuffer
10438 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10439 option `org-link-file-path-type'.
10441 With a `\\[universal-argument] \\[universal-argument]' prefix, enforce an \
10442 absolute path even if the file is in
10443 the current directory or below.
10445 A `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
10446 prefix negates `org-keep-stored-link-after-insertion'.
10448 If `org-make-link-description-function' is non-nil, this function will be
10449 called with the link target, and the result will be the default
10452 If the LINK-LOCATION parameter is non-nil, this value will be used as
10453 the link location instead of reading one interactively.
10455 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will be used
10456 as the default description."
10458 (let* ((wcf (current-window-configuration))
10459 (origbuf (current-buffer))
10460 (region (when (org-region-active-p)
10461 (buffer-substring (region-beginning) (region-end))))
10462 (remove (and region (list (region-beginning) (region-end))))
10464 (link link-location)
10465 (abbrevs org-link-abbrev-alist-local)
10466 entry all-prefixes auto-desc)
10468 (link-location) ; specified by arg, just use it.
10469 ((org-in-regexp org-bracket-link-regexp 1)
10470 ;; We do have a link at point, and we are going to edit it.
10471 (setq remove (list (match-beginning 0) (match-end 0)))
10472 (setq desc (when (match-end 3) (match-string-no-properties 3)))
10473 (setq link (read-string "Link: "
10475 (match-string-no-properties 1)))))
10476 ((or (org-in-regexp org-angle-link-re)
10477 (org-in-regexp org-plain-link-re))
10478 ;; Convert to bracket link
10479 (setq remove (list (match-beginning 0) (match-end 0))
10480 link (read-string "Link: "
10481 (org-unbracket-string "<" ">" (match-string 0)))))
10482 ((member complete-file '((4) (16)))
10483 ;; Completing read for file names.
10484 (setq link (org-file-complete-link complete-file)))
10486 ;; Read link, with completion for stored links.
10487 (org-link-fontify-links-to-this-file)
10488 (org-switch-to-buffer-other-window "*Org Links*")
10489 (with-current-buffer "*Org Links*"
10491 (insert "Insert a link.
10492 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10493 (when org-stored-links
10494 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10495 (insert (mapconcat 'org-link-prettify
10496 (reverse org-stored-links) "\n")))
10497 (goto-char (point-min)))
10498 (let ((cw (selected-window)))
10499 (select-window (get-buffer-window "*Org Links*" 'visible))
10500 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10501 (unless (pos-visible-in-window-p (point-max))
10502 (org-fit-window-to-buffer))
10503 (and (window-live-p cw) (select-window cw)))
10504 (setq all-prefixes (append (mapcar 'car abbrevs)
10505 (mapcar 'car org-link-abbrev-alist)
10508 ;; Fake a link history, containing the stored links.
10509 (let ((org--links-history
10510 (append (mapcar #'car org-stored-links)
10511 org-insert-link-history)))
10513 (org-completing-read
10516 (mapcar (lambda (x) (concat x ":")) all-prefixes)
10517 (mapcar #'car org-stored-links))
10519 'org--links-history
10520 (caar org-stored-links)))
10521 (unless (org-string-nw-p link) (user-error "No link selected"))
10522 (dolist (l org-stored-links)
10523 (when (equal link (cadr l))
10524 (setq link (car l))
10525 (setq auto-desc t)))
10526 (when (or (member link all-prefixes)
10527 (and (equal ":" (substring link -1))
10528 (member (substring link 0 -1) all-prefixes)
10529 (setq link (substring link 0 -1))))
10530 (setq link (with-current-buffer origbuf
10531 (org-link-try-special-completion link)))))
10532 (set-window-configuration wcf)
10533 (kill-buffer "*Org Links*"))
10534 (setq entry (assoc link org-stored-links))
10535 (or entry (push link org-insert-link-history))
10536 (setq desc (or desc (nth 1 entry)))))
10538 (when (funcall (if (equal complete-file '(64)) 'not 'identity)
10539 (not org-keep-stored-link-after-insertion))
10540 (setq org-stored-links (delq (assoc link org-stored-links)
10541 org-stored-links)))
10543 (when (and (string-match org-plain-link-re link)
10544 (not (string-match org-ts-regexp link)))
10545 ;; URL-like link, normalize the use of angular brackets.
10546 (setq link (org-unbracket-string "<" ">" link)))
10548 ;; Check if we are linking to the current file with a search
10549 ;; option If yes, simplify the link by using only the search
10551 (when (and buffer-file-name
10552 (let ((case-fold-search nil))
10553 (string-match "\\`file:\\(.+?\\)::" link)))
10554 (let ((path (match-string-no-properties 1 link))
10555 (search (substring-no-properties link (match-end 0))))
10557 (when (equal (file-truename buffer-file-name) (file-truename path))
10558 ;; We are linking to this same file, with a search option
10559 (setq link search)))))
10561 ;; Check if we can/should use a relative path. If yes, simplify the link
10562 (let ((case-fold-search nil))
10563 (when (string-match "\\`\\(file\\|docview\\):" link)
10564 (let* ((type (match-string-no-properties 0 link))
10565 (path (substring-no-properties link (match-end 0)))
10568 ((or (eq org-link-file-path-type 'absolute)
10569 (equal complete-file '(16)))
10570 (setq path (abbreviate-file-name (expand-file-name path))))
10571 ((eq org-link-file-path-type 'noabbrev)
10572 (setq path (expand-file-name path)))
10573 ((eq org-link-file-path-type 'relative)
10574 (setq path (file-relative-name path)))
10577 (if (string-match (concat "^" (regexp-quote
10579 (file-name-as-directory
10580 default-directory))))
10581 (expand-file-name path))
10582 ;; We are linking a file with relative path name.
10583 (setq path (substring (expand-file-name path)
10585 (setq path (abbreviate-file-name (expand-file-name path)))))))
10586 (setq link (concat type path))
10587 (when (equal desc origpath)
10588 (setq desc path)))))
10590 (if org-make-link-description-function
10592 (or (condition-case nil
10593 (funcall org-make-link-description-function link desc)
10594 (error (progn (message "Can't get link description from `%s'"
10595 (symbol-name org-make-link-description-function))
10597 (read-string "Description: " default-description)))
10598 (if default-description (setq desc default-description)
10599 (setq desc (or (and auto-desc desc)
10600 (read-string "Description: " desc)))))
10602 (unless (string-match "\\S-" desc) (setq desc nil))
10603 (when remove (apply 'delete-region remove))
10604 (insert (org-make-link-string link desc))
10605 ;; Redisplay so as the new link has proper invisible characters.
10608 (defun org-link-try-special-completion (type)
10609 "If there is completion support for link type TYPE, offer it."
10610 (let ((fun (org-link-get-parameter type :complete)))
10611 (if (functionp fun)
10613 (read-string "Link (no completion support): " (concat type ":")))))
10615 (defun org-file-complete-link (&optional arg)
10616 "Create a file link using completion."
10617 (let ((file (read-file-name "File: "))
10618 (pwd (file-name-as-directory (expand-file-name ".")))
10619 (pwd1 (file-name-as-directory (abbreviate-file-name
10620 (expand-file-name ".")))))
10621 (cond ((equal arg '(16))
10623 (abbreviate-file-name (expand-file-name file))))
10625 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10626 (concat "file:" (match-string 1 file)))
10628 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10629 (expand-file-name file))
10631 (match-string 1 (expand-file-name file))))
10632 (t (concat "file:" file)))))
10634 (defun org-completing-read (&rest args)
10635 "Completing-read with SPACE being a normal character."
10636 (let ((enable-recursive-minibuffers t)
10637 (minibuffer-local-completion-map
10638 (copy-keymap minibuffer-local-completion-map)))
10639 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10640 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10641 (org-defkey minibuffer-local-completion-map (kbd "C-c !")
10642 'org-time-stamp-inactive)
10643 (apply #'completing-read args)))
10645 ;;; Opening/following a link
10647 (defvar org-link-search-failed nil)
10649 (defvar org-open-link-functions nil
10650 "Hook for functions finding a plain text link.
10651 These functions must take a single argument, the link content.
10652 They will be called for links that look like [[link text][description]]
10653 when LINK TEXT does not have a protocol like \"http:\" and does not look
10654 like a filename (e.g. \"./blue.png\").
10656 These functions will be called *before* Org attempts to resolve the
10657 link by doing text searches in the current buffer - so if you want a
10658 link \"[[target]]\" to still find \"<<target>>\", your function should
10659 handle this as a special case.
10661 When the function does handle the link, it must return a non-nil value.
10662 If it decides that it is not responsible for this link, it must return
10663 nil to indicate that that Org can continue with other options like
10664 exact and fuzzy text search.")
10666 (defun org-next-link (&optional search-backward)
10667 "Move forward to the next link.
10668 If the link is in hidden text, expose it."
10670 (when (and org-link-search-failed (eq this-command last-command))
10671 (goto-char (point-min))
10672 (message "Link search wrapped back to beginning of buffer"))
10673 (setq org-link-search-failed nil)
10674 (let* ((pos (point))
10676 (a (assq :link ct))
10677 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10678 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10679 ((looking-at org-any-link-re)
10680 ;; Don't stay stuck at link without an org-link face
10681 (forward-char (if search-backward -1 1))))
10682 (if (funcall srch-fun org-any-link-re nil t)
10684 (goto-char (match-beginning 0))
10685 (when (outline-invisible-p) (org-show-context)))
10687 (setq org-link-search-failed t)
10688 (message "No further link found"))))
10690 (defun org-previous-link ()
10691 "Move backward to the previous link.
10692 If the link is in hidden text, expose it."
10694 (funcall 'org-next-link t))
10696 (defun org-translate-link (s)
10697 "Translate a link string if a translation function has been defined."
10699 (insert (org-trim s))
10700 (org-trim (org-element-interpret-data (org-element-context)))))
10702 (defun org-translate-link-from-planner (type path)
10703 "Translate a link from Emacs Planner syntax so that Org can follow it.
10704 This is still an experimental function, your mileage may vary."
10706 ((member type '("http" "https" "news" "ftp"))
10707 ;; standard Internet links are the same.
10709 ((and (equal type "irc") (string-match "^//" path))
10710 ;; Planner has two / at the beginning of an irc link, we have 1.
10711 ;; We should have zero, actually....
10712 (setq path (substring path 1)))
10713 ((and (equal type "lisp") (string-match "^/" path))
10714 ;; Planner has a slash, we do not.
10715 (setq type "elisp" path (substring path 1)))
10716 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10717 ;; A typical message link. Planner has the id after the final slash,
10718 ;; we separate it with a hash mark
10719 (setq path (concat (match-string 1 path) "#"
10720 (org-unbracket-string "<" ">" (match-string 2 path))))))
10723 (defun org-find-file-at-mouse (ev)
10724 "Open file link or URL at mouse."
10726 (mouse-set-point ev)
10727 (org-open-at-point 'in-emacs))
10729 (defun org-open-at-mouse (ev)
10730 "Open file link or URL at mouse.
10731 See the docstring of `org-open-file' for details."
10733 (mouse-set-point ev)
10734 (when (eq major-mode 'org-agenda-mode)
10735 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10736 (org-open-at-point))
10738 (defvar org-window-config-before-follow-link nil
10739 "The window configuration before following a link.
10740 This is saved in case the need arises to restore it.")
10743 (defun org-open-at-point-global ()
10744 "Follow a link or time-stamp like Org mode does.
10745 This command can be called in any mode to follow an external link
10746 or a time-stamp that has Org mode syntax. Its behavior is
10747 undefined when called on internal links (e.g., fuzzy links).
10748 Raise an error when there is nothing to follow. "
10750 (cond ((org-in-regexp org-any-link-re)
10751 (org-open-link-from-string (match-string-no-properties 0)))
10752 ((or (org-in-regexp org-ts-regexp-both nil t)
10753 (org-in-regexp org-tsr-regexp-both nil t))
10754 (org-follow-timestamp-link))
10755 (t (user-error "No link found"))))
10758 (defun org-open-link-from-string (s &optional arg reference-buffer)
10759 "Open a link in the string S, as if it was in Org mode."
10760 (interactive "sLink: \nP")
10761 (let ((reference-buffer (or reference-buffer (current-buffer))))
10763 (let ((org-inhibit-startup (not reference-buffer)))
10766 (goto-char (point-min))
10767 (when reference-buffer
10768 (setq org-link-abbrev-alist-local
10769 (with-current-buffer reference-buffer
10770 org-link-abbrev-alist-local)))
10771 (org-open-at-point arg reference-buffer)))))
10773 (defvar org-open-at-point-functions nil
10774 "Hook that is run when following a link at point.
10776 Functions in this hook must return t if they identify and follow
10777 a link at point. If they don't find anything interesting at point,
10778 they must return nil.")
10780 (defvar org-link-search-inhibit-query nil)
10781 (defvar clean-buffer-list-kill-buffer-names) ;Defined in midnight.el
10782 (defun org--open-doi-link (path)
10783 "Open a \"doi\" type link.
10784 PATH is a the path to search for, as a string."
10785 (browse-url (url-encode-url (concat org-doi-server-url path))))
10787 (defun org--open-elisp-link (path)
10788 "Open a \"elisp\" type link.
10789 PATH is the sexp to evaluate, as a string."
10791 (if (or (and (org-string-nw-p
10792 org-confirm-elisp-link-not-regexp)
10793 (string-match-p org-confirm-elisp-link-not-regexp cmd))
10794 (not org-confirm-elisp-link-function)
10795 (funcall org-confirm-elisp-link-function
10796 (format "Execute \"%s\" as elisp? "
10797 (org-add-props cmd nil 'face 'org-warning))))
10798 (message "%s => %s" cmd
10799 (if (eq (string-to-char cmd) ?\()
10801 (call-interactively (read cmd))))
10802 (user-error "Abort"))))
10804 (defun org--open-help-link (path)
10805 "Open a \"help\" type link.
10806 PATH is a symbol name, as a string."
10807 (pcase (intern path)
10808 ((and (pred fboundp) variable) (describe-function variable))
10809 ((and (pred boundp) function) (describe-variable function))
10810 (name (user-error "Unknown function or variable: %s" name))))
10812 (defun org--open-shell-link (path)
10813 "Open a \"shell\" type link.
10814 PATH is the command to execute, as a string."
10815 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10817 (if (or (and (org-string-nw-p
10818 org-confirm-shell-link-not-regexp)
10820 org-confirm-shell-link-not-regexp cmd))
10821 (not org-confirm-shell-link-function)
10822 (funcall org-confirm-shell-link-function
10823 (format "Execute \"%s\" in shell? "
10824 (org-add-props cmd nil
10825 'face 'org-warning))))
10827 (message "Executing %s" cmd)
10828 (shell-command cmd buf)
10829 (when (featurep 'midnight)
10830 (setq clean-buffer-list-kill-buffer-names
10831 (cons (buffer-name buf)
10832 clean-buffer-list-kill-buffer-names))))
10833 (user-error "Abort"))))
10835 (defun org-open-at-point (&optional arg reference-buffer)
10836 "Open link, timestamp, footnote or tags at point.
10838 When point is on a link, follow it. Normally, files will be
10839 opened by an appropriate application. If the optional prefix
10840 argument ARG is non-nil, Emacs will visit the file. With
10841 a double prefix argument, try to open outside of Emacs, in the
10842 application the system uses for this file type.
10844 When point is on a timestamp, open the agenda at the day
10847 When point is a footnote definition, move to the first reference
10848 found. If it is on a reference, move to the associated
10851 When point is on a headline, display a list of every link in the
10852 entry, so it is possible to pick one, or all, of them. If point
10853 is on a tag, call `org-tags-view' instead.
10855 When optional argument REFERENCE-BUFFER is non-nil, it should
10856 specify a buffer from where the link search should happen. This
10857 is used internally by `org-open-link-from-string'.
10859 On top of syntactically correct links, this function will open
10860 the link at point in comments or comment blocks and the first
10861 link in a property drawer line."
10863 ;; On a code block, open block's results.
10864 (unless (call-interactively 'org-babel-open-src-block-result)
10865 (org-load-modules-maybe)
10866 (setq org-window-config-before-follow-link (current-window-configuration))
10867 (org-remove-occur-highlights nil nil t)
10868 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10870 ;; Only consider supported types, even if they are not
10871 ;; the closest one.
10872 (org-element-lineage
10873 (org-element-context)
10874 '(clock comment comment-block footnote-definition
10875 footnote-reference headline inlinetask keyword link
10876 node-property timestamp)
10878 (type (org-element-type context))
10879 (value (org-element-property :value context)))
10881 ((not context) (user-error "No link found"))
10882 ;; Exception: open timestamps and links in properties
10883 ;; drawers, keywords and comments.
10884 ((memq type '(comment comment-block keyword node-property))
10885 (call-interactively #'org-open-at-point-global))
10886 ;; On a headline or an inlinetask, but not on a timestamp,
10887 ;; a link, a footnote reference or on tags.
10888 ((and (memq type '(headline inlinetask))
10890 (let ((case-fold-search nil))
10892 (beginning-of-line)
10893 (looking-at org-complex-heading-regexp))
10894 (or (not (match-beginning 5))
10895 (< (point) (match-beginning 5)))))
10896 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10898 (links-end (cdr data)))
10900 (dolist (link (if (stringp links) (list links) links))
10901 (search-forward link nil links-end)
10902 (goto-char (match-beginning 0))
10903 (org-open-at-point))
10904 (require 'org-attach)
10905 (org-attach-reveal 'if-exists))))
10906 ;; On a clock line, make sure point is on the timestamp
10907 ;; before opening it.
10908 ((and (eq type 'clock)
10910 (>= (point) (org-element-property :begin value))
10911 (<= (point) (org-element-property :end value)))
10912 (org-follow-timestamp-link))
10913 ;; Do nothing on white spaces after an object.
10916 (goto-char (org-element-property :end context))
10917 (skip-chars-backward " \t")
10919 (user-error "No link found"))
10920 ((eq type 'timestamp) (org-follow-timestamp-link))
10921 ;; On tags within a headline or an inlinetask.
10922 ((and (memq type '(headline inlinetask))
10923 (let ((case-fold-search nil))
10924 (save-excursion (beginning-of-line)
10925 (looking-at org-complex-heading-regexp))
10926 (and (match-beginning 5)
10927 (>= (point) (match-beginning 5)))))
10928 (org-tags-view arg (substring (match-string 5) 0 -1)))
10930 ;; When link is located within the description of another
10931 ;; link (e.g., an inline image), always open the parent
10933 (let* ((link (let ((up (org-element-property :parent context)))
10934 (if (eq (org-element-type up) 'link) up context)))
10935 (type (org-element-property :type link))
10936 (path (org-link-unescape (org-element-property :path link))))
10937 ;; Switch back to REFERENCE-BUFFER needed when called in
10938 ;; a temporary buffer through `org-open-link-from-string'.
10939 (with-current-buffer (or reference-buffer (current-buffer))
10941 ((equal type "file")
10942 (if (string-match "[*?{]" (file-name-nondirectory path))
10944 ;; Look into `org-link-parameters' in order to find
10945 ;; a DEDICATED-FUNCTION to open file. The function
10946 ;; will be applied on raw link instead of parsed
10947 ;; link due to the limitation in `org-add-link-type'
10948 ;; ("open" function called with a single argument).
10949 ;; If no such function is found, fallback to
10950 ;; `org-open-file'.
10951 (let* ((option (org-element-property :search-option link))
10952 (app (org-element-property :application link))
10953 (dedicated-function
10954 (org-link-get-parameter
10955 (if app (concat type "+" app) type)
10957 (if dedicated-function
10958 (funcall dedicated-function
10960 (and option (concat "::" option))))
10961 (apply #'org-open-file
10964 ((equal app "emacs") 'emacs)
10965 ((equal app "sys") 'system))
10966 (cond ((not option) nil)
10967 ((string-match-p "\\`[0-9]+\\'" option)
10968 (list (string-to-number option)))
10970 (org-link-unescape option)))))))))
10971 ((functionp (org-link-get-parameter type :follow))
10972 (funcall (org-link-get-parameter type :follow) path))
10973 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10974 (unless (run-hook-with-args-until-success
10975 'org-open-link-functions path)
10976 (if (not arg) (org-mark-ring-push)
10977 (switch-to-buffer-other-window
10978 (org-get-buffer-for-internal-link (current-buffer))))
10980 (org-with-wide-buffer
10981 (if (equal type "radio")
10982 (org-search-radio-target
10983 (org-element-property :path link))
10985 (if (member type '("custom-id" "coderef"))
10986 (org-element-property :raw-link link)
10988 ;; Prevent fuzzy links from matching
10990 (and (equal type "fuzzy")
10991 (+ 2 (org-element-property :begin link)))))
10993 (unless (and (<= (point-min) destination)
10994 (>= (point-max) destination))
10996 (goto-char destination))))
10997 (t (browse-url-at-point))))))
10998 ;; On a footnote reference or at a footnote definition's label.
10999 ((or (eq type 'footnote-reference)
11000 (and (eq type 'footnote-definition)
11002 ;; Do not validate action when point is on the
11003 ;; spaces right after the footnote label, in
11004 ;; order to be on par with behaviour on links.
11005 (skip-chars-forward " \t")
11007 (org-element-property :contents-begin context)))
11008 (if begin (< (point) begin)
11009 (= (org-element-property :post-affiliated context)
11010 (line-beginning-position)))))))
11011 (org-footnote-action))
11012 (t (user-error "No link found")))))
11013 (run-hook-with-args 'org-follow-link-hook)))
11015 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
11016 "Offer links in the current entry and return the selected link.
11017 If there is only one link, return it.
11018 If NTH is an integer, return the NTH link found.
11019 If ZERO is a string, check also this string for a link, and if
11020 there is one, return it."
11021 (with-current-buffer buffer
11022 (org-with-wide-buffer
11025 have-zero end links link c)
11026 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
11027 (push (match-string 0 zero) links)
11028 (setq cnt (1- cnt) have-zero t))
11030 (org-back-to-heading t)
11031 (setq end (save-excursion (outline-next-heading) (point)))
11032 (while (re-search-forward org-any-link-re end t)
11033 (push (match-string 0) links))
11034 (setq links (org-uniquify (reverse links))))
11037 (message "No links"))
11038 ((equal (length links) 1)
11039 (setq link (car links)))
11040 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
11041 (setq link (nth (if have-zero nth (1- nth)) links)))
11042 (t ; we have to select a link
11044 (save-window-excursion
11045 (delete-other-windows)
11046 (with-output-to-temp-buffer "*Select Link*"
11049 ((not (string-match org-bracket-link-regexp l))
11050 (princ (format "[%c] %s\n" (cl-incf cnt)
11051 (org-unbracket-string "<" ">" l))))
11053 (princ (format "[%c] %s (%s)\n" (cl-incf cnt)
11054 (match-string 3 l) (match-string 1 l))))
11055 (t (princ (format "[%c] %s\n" (cl-incf cnt)
11056 (match-string 1 l)))))))
11057 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
11058 (message "Select link to open, RET to open all:")
11059 (setq c (read-char-exclusive))
11060 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
11061 (when (equal c ?q) (user-error "Abort"))
11062 (if (equal c ?\C-m)
11064 (setq nth (- c ?0))
11065 (when have-zero (setq nth (1+ nth)))
11066 (unless (and (integerp nth) (>= (length links) nth))
11067 (user-error "Invalid link selection"))
11068 (setq link (nth (1- nth) links)))))
11069 (cons link end)))))
11071 ;; TODO: These functions are deprecated since `org-open-at-point'
11072 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
11073 (defun org-open-file-with-system (path)
11074 "Open file at PATH using the system way of opening it."
11075 (org-open-file path 'system))
11076 (defun org-open-file-with-emacs (path)
11077 "Open file at PATH in Emacs."
11078 (org-open-file path 'emacs))
11083 (defvar org-create-file-search-functions nil
11084 "List of functions to construct the right search string for a file link.
11085 These functions are called in turn with point at the location to
11086 which the link should point.
11088 A function in the hook should first test if it would like to
11089 handle this file type, for example by checking the `major-mode'
11090 or the file extension. If it decides not to handle this file, it
11091 should just return nil to give other functions a chance. If it
11092 does handle the file, it must return the search string to be used
11093 when following the link. The search string will be part of the
11094 file link, given after a double colon, and `org-open-at-point'
11095 will automatically search for it. If special measures must be
11096 taken to make the search successful, another function should be
11097 added to the companion hook `org-execute-file-search-functions',
11100 A function in this hook may also use `setq' to set the variable
11101 `description' to provide a suggestion for the descriptive text to
11102 be used for this link when it gets inserted into an Org buffer
11103 with \\[org-insert-link].")
11105 (defvar org-execute-file-search-functions nil
11106 "List of functions to execute a file search triggered by a link.
11108 Functions added to this hook must accept a single argument, the
11109 search string that was part of the file link, the part after the
11110 double colon. The function must first check if it would like to
11111 handle this search, for example by checking the `major-mode' or
11112 the file extension. If it decides not to handle this search, it
11113 should just return nil to give other functions a chance. If it
11114 does handle the search, it must return a non-nil value to keep
11115 other functions from trying.
11117 Each function can access the current prefix argument through the
11118 variable `current-prefix-arg'. Note that a single prefix is used
11119 to force opening a link in Emacs, so it may be good to only use a
11120 numeric or double prefix to guide the search function.
11122 In case this is needed, a function in this hook can also restore
11123 the window configuration before `org-open-at-point' was called using:
11125 (set-window-configuration org-window-config-before-follow-link)")
11127 (defun org-search-radio-target (target)
11128 "Search a radio target matching TARGET in current buffer.
11129 White spaces are not significant."
11130 (let ((re (format "<<<%s>>>"
11131 (mapconcat #'regexp-quote
11132 (org-split-string target "[ \t\n]+")
11133 "[ \t]+\\(?:\n[ \t]*\\)?")))
11135 (goto-char (point-min))
11136 (catch :radio-match
11137 (while (re-search-forward re nil t)
11139 (let ((object (org-element-context)))
11140 (when (eq (org-element-type object) 'radio-target)
11141 (goto-char (org-element-property :begin object))
11142 (org-show-context 'link-search)
11143 (throw :radio-match nil))))
11145 (user-error "No match for radio target: %s" target))))
11147 (defun org-link-search (s &optional avoid-pos stealth)
11148 "Search for a search string S.
11150 If S starts with \"#\", it triggers a custom ID search.
11152 If S is enclosed within parenthesis, it initiates a coderef
11155 If S is surrounded by forward slashes, it is interpreted as
11156 a regular expression. In Org mode files, this will create an
11157 `org-occur' sparse tree. In ordinary files, `occur' will be used
11158 to list matches. If the current buffer is in `dired-mode', grep
11159 will be used to search in all files.
11161 When AVOID-POS is given, ignore matches near that position.
11163 When optional argument STEALTH is non-nil, do not modify
11164 visibility around point, thus ignoring `org-show-context-detail'
11167 Search is case-insensitive and ignores white spaces. Return type
11168 of matched result, which is either `dedicated' or `fuzzy'."
11169 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11170 (let* ((case-fold-search t)
11172 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11173 (starred (eq (string-to-char normalized) ?*))
11174 (words (split-string (if starred (substring s 1) s)))
11175 (s-multi-re (mapconcat #'regexp-quote words "\\(?:[ \t\n]+\\)"))
11176 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11179 ;; Check if there are any special search functions.
11180 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11181 ((eq (string-to-char s) ?#)
11182 ;; Look for a custom ID S if S starts with "#".
11183 (let* ((id (substring normalized 1))
11184 (match (org-find-property "CUSTOM_ID" id)))
11185 (if match (progn (goto-char match) (setf type 'dedicated))
11186 (error "No match for custom ID: %s" id))))
11187 ((string-match "\\`(\\(.*\\))\\'" normalized)
11188 ;; Look for coderef targets if S is enclosed within parenthesis.
11189 (let ((coderef (match-string-no-properties 1 normalized))
11190 (re (substring s-single-re 1 -1)))
11191 (goto-char (point-min))
11192 (catch :coderef-match
11193 (while (re-search-forward re nil t)
11194 (let ((element (org-element-at-point)))
11195 (when (and (memq (org-element-type element)
11196 '(example-block src-block))
11197 ;; Build proper regexp according to current
11198 ;; block's label format.
11201 (or (org-element-property :label-fmt element)
11202 org-coderef-label-format))))
11204 (beginning-of-line)
11205 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11206 (format label-fmt coderef))))))
11207 (setq type 'dedicated)
11208 (goto-char (match-beginning 1))
11209 (throw :coderef-match nil))))
11211 (error "No match for coderef: %s" coderef))))
11212 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11213 ;; Look for a regular expression.
11214 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11215 (match-string 1 s)))
11216 ;; From here, we handle fuzzy links.
11218 ;; Look for targets, only if not in a headline search.
11219 ((and (not starred)
11220 (let ((target (format "<<%s>>" s-multi-re)))
11221 (catch :target-match
11222 (goto-char (point-min))
11223 (while (re-search-forward target nil t)
11225 (let ((context (org-element-context)))
11226 (when (eq (org-element-type context) 'target)
11227 (setq type 'dedicated)
11228 (goto-char (org-element-property :begin context))
11229 (throw :target-match t))))
11231 ;; Look for elements named after S, only if not in a headline
11233 ((and (not starred)
11234 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11236 (goto-char (point-min))
11237 (while (re-search-forward name nil t)
11238 (let ((element (org-element-at-point)))
11241 (org-element-property :name element)))
11242 (setq type 'dedicated)
11243 (beginning-of-line)
11244 (throw :name-match t))))
11246 ;; Regular text search. Prefer headlines in Org mode buffers.
11247 ;; Ignore COMMENT keyword, TODO keywords, priority cookies,
11248 ;; statistics cookies and tags.
11249 ((and (derived-mode-p 'org-mode)
11251 (format "%s.*\\(?:%s[ \t]\\)?.*%s"
11252 org-outline-regexp-bol
11254 (mapconcat #'regexp-quote words ".+")))
11255 (cookie-re "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]")
11256 (comment-re (format "\\`%s[ \t]+" org-comment-string)))
11257 (goto-char (point-min))
11259 (while (re-search-forward title-re nil t)
11262 (replace-regexp-in-string
11264 (replace-regexp-in-string
11265 comment-re "" (org-get-heading t t)))))
11268 (beginning-of-line)
11269 (setq type 'dedicated))
11270 ;; Offer to create non-existent headline depending on
11271 ;; `org-link-search-must-match-exact-headline'.
11272 ((and (derived-mode-p 'org-mode)
11273 (not org-link-search-inhibit-query)
11274 (eq org-link-search-must-match-exact-headline 'query-to-create)
11275 (yes-or-no-p "No match - create this as a new heading? "))
11276 (goto-char (point-max))
11277 (unless (bolp) (newline))
11278 (org-insert-heading nil t t)
11280 (beginning-of-line 0))
11281 ;; Only headlines are looked after. No need to process
11282 ;; further: throw an error.
11283 ((and (derived-mode-p 'org-mode)
11284 (or starred org-link-search-must-match-exact-headline))
11286 (error "No match for fuzzy expression: %s" normalized))
11287 ;; Regular text search.
11288 ((catch :fuzzy-match
11289 (goto-char (point-min))
11290 (while (re-search-forward s-multi-re nil t)
11291 ;; Skip match if it contains AVOID-POS or it is included in
11292 ;; a link with a description but outside the description.
11293 (unless (or (and avoid-pos
11294 (<= (match-beginning 0) avoid-pos)
11295 (> (match-end 0) avoid-pos))
11296 (and (save-match-data
11297 (org-in-regexp org-bracket-link-regexp))
11298 (match-beginning 3)
11299 (or (> (match-beginning 3) (point))
11300 (<= (match-end 3) (point)))
11301 (org-element-lineage
11302 (save-match-data (org-element-context))
11304 (goto-char (match-beginning 0))
11306 (throw :fuzzy-match t)))
11308 ;; All failed. Throw an error.
11309 (t (goto-char origin)
11310 (error "No match for fuzzy expression: %s" normalized)))
11311 ;; Disclose surroundings of match, if appropriate.
11312 (when (and (derived-mode-p 'org-mode) (not stealth))
11313 (org-show-context 'link-search))
11316 (defun org-get-buffer-for-internal-link (buffer)
11317 "Return a buffer to be used for displaying the link target of internal links."
11319 ((not org-display-internal-link-with-indirect-buffer)
11321 ((string-suffix-p "(Clone)" (buffer-name buffer))
11322 (message "Buffer is already a clone, not making another one")
11323 ;; we also do not modify visibility in this case
11325 (t ; make a new indirect buffer for displaying the link
11326 (let* ((bn (buffer-name buffer))
11327 (ibn (concat bn "(Clone)"))
11328 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11329 (with-current-buffer ib (org-overview))
11332 (defun org-do-occur (regexp &optional cleanup)
11333 "Call the Emacs command `occur'.
11334 If CLEANUP is non-nil, remove the printout of the regular expression
11335 in the *Occur* buffer. This is useful if the regex is long and not useful
11339 (let ((cwin (selected-window)) win beg end)
11340 (when (setq win (get-buffer-window "*Occur*"))
11341 (select-window win))
11342 (goto-char (point-min))
11343 (when (re-search-forward "match[a-z]+" nil t)
11344 (setq beg (match-end 0))
11345 (when (re-search-forward "^[ \t]*[0-9]+" nil t)
11346 (setq end (1- (match-beginning 0)))))
11347 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11348 (goto-char (point-min))
11349 (select-window cwin))))
11351 ;;; The mark ring for links jumps
11353 (defvar org-mark-ring nil
11354 "Mark ring for positions before jumps in Org mode.")
11355 (defvar org-mark-ring-last-goto nil
11356 "Last position in the mark ring used to go back.")
11357 ;; Fill and close the ring
11358 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11359 (dotimes (_ org-mark-ring-length)
11360 (push (make-marker) org-mark-ring))
11361 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11364 (defun org-mark-ring-push (&optional pos buffer)
11365 "Put the current position or POS into the mark ring and rotate it."
11367 (setq pos (or pos (point)))
11368 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11369 (move-marker (car org-mark-ring)
11371 (or buffer (current-buffer)))
11373 (substitute-command-keys
11374 "Position saved to mark ring, go back with \
11375 `\\[org-mark-ring-goto]'.")))
11377 (defun org-mark-ring-goto (&optional n)
11378 "Jump to the previous position in the mark ring.
11379 With prefix arg N, jump back that many stored positions. When
11380 called several times in succession, walk through the entire ring.
11381 Org mode commands jumping to a different position in the current file,
11382 or to another Org file, automatically push the old position onto the ring."
11385 (if (eq last-command this-command)
11386 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11387 (setq p org-mark-ring))
11388 (setq org-mark-ring-last-goto p)
11390 (pop-to-buffer-same-window (marker-buffer m))
11392 (when (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11394 (defun org-add-angle-brackets (s)
11395 (unless (equal (substring s 0 1) "<") (setq s (concat "<" s)))
11396 (unless (equal (substring s -1) ">") (setq s (concat s ">")))
11399 ;;; Following specific links
11401 (defvar org-agenda-buffer-tmp-name)
11402 (defvar org-agenda-start-on-weekday)
11403 (defun org-follow-timestamp-link ()
11404 "Open an agenda view for the time-stamp date/range at point."
11406 ((org-at-date-range-p t)
11407 (let ((org-agenda-start-on-weekday)
11408 (t1 (match-string 1))
11409 (t2 (match-string 2)) tt1 tt2)
11410 (setq tt1 (time-to-days (org-time-string-to-time t1))
11411 tt2 (time-to-days (org-time-string-to-time t2)))
11412 (let ((org-agenda-buffer-tmp-name
11413 (format "*Org Agenda(a:%s)"
11414 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11415 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11416 ((org-at-timestamp-p t)
11417 (let ((org-agenda-buffer-tmp-name
11418 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11419 (org-agenda-list nil (time-to-days (org-time-string-to-time
11420 (substring (match-string 1) 0 10)))
11422 (t (error "This should not happen"))))
11425 ;;; Following file links
11426 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11427 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11428 (declare-function mailcap-mime-info
11429 "mailcap" (string &optional request no-decode))
11430 (defvar org-wait nil)
11431 (defun org-open-file (path &optional in-emacs line search)
11432 "Open the file at PATH.
11433 First, this expands any special file name abbreviations. Then the
11434 configuration variable `org-file-apps' is checked if it contains an
11435 entry for this file type, and if yes, the corresponding command is launched.
11437 If no application is found, Emacs simply visits the file.
11439 With optional prefix argument IN-EMACS, Emacs will visit the file.
11440 With a double \\[universal-argument] \\[universal-argument] \
11441 prefix arg, Org tries to avoid opening in Emacs
11442 and to use an external application to visit the file.
11444 Optional LINE specifies a line to go to, optional SEARCH a string
11445 to search for. If LINE or SEARCH is given, the file will be
11446 opened in Emacs, unless an entry from org-file-apps that makes
11447 use of groups in a regexp matches.
11449 If you want to change the way frames are used when following a
11450 link, please customize `org-link-frame-setup'.
11452 If the file does not exist, an error is thrown."
11453 (let* ((file (if (equal path "")
11455 (substitute-in-file-name (expand-file-name path))))
11456 (file-apps (append org-file-apps (org-default-apps)))
11457 (apps (cl-remove-if
11458 'org-file-apps-entry-match-against-dlink-p file-apps))
11459 (apps-dlink (cl-remove-if-not
11460 'org-file-apps-entry-match-against-dlink-p file-apps))
11461 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11462 (dirp (unless remp (file-directory-p file)))
11463 (file (if (and dirp org-open-directory-means-index-dot-org)
11464 (concat (file-name-as-directory file) "index.org")
11466 (a-m-a-p (assq 'auto-mode apps))
11467 (dfile (downcase file))
11468 ;; Reconstruct the original link from the PATH, LINE and
11470 (link (cond (line (concat file "::" (number-to-string line)))
11471 (search (concat file "::" search))
11473 (dlink (downcase link))
11474 (old-buffer (current-buffer))
11476 (old-mode major-mode)
11478 (and (string-match "\\`.*?\\.\\([a-zA-Z0-9]+\\(\\.gz\\)?\\)\\'" dfile)
11479 (match-string 1 dfile)))
11480 cmd link-match-data)
11482 ((member in-emacs '((16) system))
11483 (setq cmd (cdr (assq 'system apps))))
11484 (in-emacs (setq cmd 'emacs))
11486 (setq cmd (or (and remp (cdr (assq 'remote apps)))
11487 (and dirp (cdr (assq 'directory apps)))
11488 ;; First, try matching against apps-dlink if we
11489 ;; get a match here, store the match data for
11491 (let ((match (assoc-default dlink apps-dlink
11494 (progn (setq link-match-data (match-data))
11496 (progn (setq in-emacs (or in-emacs line search))
11497 nil))) ; if we have no match in apps-dlink,
11498 ; always open the file in emacs if line or search
11499 ; is given (for backwards compatibility)
11500 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11502 (cdr (assoc ext apps))
11503 (cdr (assq t apps))))))
11504 (when (eq cmd 'system)
11505 (setq cmd (cdr (assq 'system apps))))
11506 (when (eq cmd 'default)
11507 (setq cmd (cdr (assoc t apps))))
11508 (when (eq cmd 'mailcap)
11510 (mailcap-parse-mailcaps)
11511 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11512 (command (mailcap-mime-info mime-type)))
11513 (if (stringp command)
11515 (setq cmd 'emacs))))
11516 (when (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11517 (not (file-exists-p file))
11518 (not org-open-non-existing-files))
11519 (user-error "No such file: %s" file))
11521 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11522 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11523 (while (string-match "['\"]%s['\"]" cmd)
11524 (setq cmd (replace-match "%s" t t cmd)))
11525 (setq cmd (replace-regexp-in-string
11527 (shell-quote-argument (convert-standard-filename file))
11531 ;; Replace "%1", "%2" etc. in command with group matches from regex
11533 (let ((match-index 1)
11534 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11535 (set-match-data link-match-data)
11536 (while (<= match-index number-of-groups)
11537 (let ((regex (concat "%" (number-to-string match-index)))
11538 (replace-with (match-string match-index dlink)))
11539 (while (string-match regex cmd)
11540 (setq cmd (replace-match replace-with t t cmd))))
11541 (setq match-index (+ match-index 1)))))
11543 (save-window-excursion
11544 (message "Running %s...done" cmd)
11545 (start-process-shell-command cmd nil cmd)
11546 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11549 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11551 (cond (line (org-goto-line line)
11552 (when (derived-mode-p 'org-mode) (org-reveal)))
11553 (search (org-link-search search))))
11556 (set-match-data link-match-data)
11557 (condition-case nil
11558 (funcall cmd file link)
11559 ;; FIXME: Remove this check when most default installations
11560 ;; of Emacs have at least Org 9.0.
11561 ((debug wrong-number-of-arguments wrong-type-argument
11563 (user-error "Please see Org News for version 9.0 about \
11564 `org-file-apps'--Lisp error: %S" cmd)))))
11566 ;; FIXME: Remove this check when most default installations of
11567 ;; Emacs have at least Org 9.0.
11568 ;; Heads-up instead of silently fall back to
11569 ;; `org-link-frame-setup' for an old usage of `org-file-apps'
11570 ;; with sexp instead of a function for `cmd'.
11571 (user-error "Please see Org News for version 9.0 about \
11572 `org-file-apps'--Error: Deprecated usage of %S" cmd))
11573 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11574 (and (derived-mode-p 'org-mode)
11575 (eq old-mode 'org-mode)
11576 (or (not (eq old-buffer (current-buffer)))
11577 (not (eq old-pos (point))))
11578 (org-mark-ring-push old-pos old-buffer))))
11580 (defun org-file-apps-entry-match-against-dlink-p (entry)
11581 "This function returns non-nil if `entry' uses a regular
11582 expression which should be matched against the whole link by
11585 It assumes that is the case when the entry uses a regular
11586 expression which has at least one grouping construct and the
11587 action is either a lisp form or a command string containing
11588 `%1', i.e. using at least one subexpression match as a
11590 (let ((selector (car entry))
11591 (action (cdr entry)))
11592 (if (stringp selector)
11593 (and (> (regexp-opt-depth selector) 0)
11594 (or (and (stringp action)
11595 (string-match "%[0-9]" action))
11599 (defun org-default-apps ()
11600 "Return the default applications for this operating system."
11602 ((eq system-type 'darwin)
11603 org-file-apps-defaults-macosx)
11604 ((eq system-type 'windows-nt)
11605 org-file-apps-defaults-windowsnt)
11606 (t org-file-apps-defaults-gnu)))
11608 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11609 "Convert extensions to regular expressions in the cars of LIST.
11610 Also, weed out any non-string entries, because the return value is used
11611 only for regexp matching.
11612 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11613 point to the symbol `emacs', indicating that the file should
11614 be opened in Emacs."
11617 (mapcar (lambda (x)
11618 (unless (not (stringp (car x)))
11619 (if (string-match "\\W" (car x))
11621 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11623 (when add-auto-mode
11624 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11626 (defvar ange-ftp-name-format)
11627 (defun org-file-remote-p (file)
11628 "Test whether FILE specifies a location on a remote system.
11629 Return non-nil if the location is indeed remote.
11631 For example, the filename \"/user@host:/foo\" specifies a location
11632 on the system \"/user@host:\"."
11633 (cond ((fboundp 'file-remote-p)
11634 (file-remote-p file))
11635 ((fboundp 'tramp-handle-file-remote-p)
11636 (tramp-handle-file-remote-p file))
11637 ((and (boundp 'ange-ftp-name-format)
11638 (string-match (car ange-ftp-name-format) file))
11644 (defun org-get-org-file ()
11645 "Read a filename, with default directory `org-directory'."
11646 (let ((default (or org-default-notes-file remember-data-file)))
11647 (read-file-name (format "File name [%s]: " default)
11648 (file-name-as-directory org-directory)
11651 (defun org-notes-order-reversed-p ()
11652 "Check if the current file should receive notes in reversed order."
11654 ((not org-reverse-note-order) nil)
11655 ((eq t org-reverse-note-order) t)
11656 ((not (listp org-reverse-note-order)) nil)
11658 (dolist (entry org-reverse-note-order)
11659 (when (string-match (car entry) buffer-file-name)
11660 (throw 'exit (cdr entry))))))))
11662 (defvar org-refile-target-table nil
11663 "The list of refile targets, created by `org-refile'.")
11665 (defvar org-agenda-new-buffers nil
11666 "Buffers created to visit agenda files.")
11668 (defvar org-refile-cache nil
11669 "Cache for refile targets.")
11671 (defvar org-refile-markers nil
11672 "All the markers used for caching refile locations.")
11674 (defun org-refile-marker (pos)
11675 "Get a new refile marker, but only if caching is in use."
11676 (if (not org-refile-use-cache)
11678 (let ((m (make-marker)))
11679 (move-marker m pos)
11680 (push m org-refile-markers)
11683 (defun org-refile-cache-clear ()
11684 "Clear the refile cache and disable all the markers."
11685 (dolist (m org-refile-markers) (move-marker m nil))
11686 (setq org-refile-markers nil)
11687 (setq org-refile-cache nil)
11688 (message "Refile cache has been cleared"))
11690 (defun org-refile-cache-check-set (set)
11691 "Check if all the markers in the cache still have live buffers."
11694 (while (and set (setq marker (nth 3 (pop set))))
11695 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11696 (when (and marker (null (marker-buffer marker)))
11697 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11699 (throw 'exit nil)))
11702 (defun org-refile-cache-put (set &rest identifiers)
11703 "Push the refile targets SET into the cache, under IDENTIFIERS."
11704 (let* ((key (sha1 (prin1-to-string identifiers)))
11705 (entry (assoc key org-refile-cache)))
11708 (push (cons key set) org-refile-cache))))
11710 (defun org-refile-cache-get (&rest identifiers)
11711 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11713 ((not org-refile-cache) nil)
11714 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11716 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11717 org-refile-cache))))
11718 (and set (org-refile-cache-check-set set) set)))))
11720 (defvar org-outline-path-cache nil
11721 "Alist between buffer positions and outline paths.
11722 It value is an alist (POSITION . PATH) where POSITION is the
11723 buffer position at the beginning of an entry and PATH is a list
11724 of strings describing the outline path for that entry, in reverse
11727 (defun org-refile-get-targets (&optional default-buffer)
11728 "Produce a table with refile targets."
11729 (let ((case-fold-search nil)
11730 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11731 (entries (or org-refile-targets '((nil . (:level . 1)))))
11732 targets tgs files desc descre)
11733 (message "Getting targets...")
11734 (with-current-buffer (or default-buffer (current-buffer))
11735 (dolist (entry entries)
11736 (setq files (car entry) desc (cdr entry))
11738 ((null files) (setq files (list (current-buffer))))
11739 ((eq files 'org-agenda-files)
11740 (setq files (org-agenda-files 'unrestricted)))
11741 ((and (symbolp files) (fboundp files))
11742 (setq files (funcall files)))
11743 ((and (symbolp files) (boundp files))
11744 (setq files (symbol-value files))))
11745 (when (stringp files) (setq files (list files)))
11747 ((eq (car desc) :tag)
11748 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11749 ((eq (car desc) :todo)
11750 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11751 ((eq (car desc) :regexp)
11752 (setq descre (cdr desc)))
11753 ((eq (car desc) :level)
11754 (setq descre (concat "^\\*\\{" (number-to-string
11755 (if org-odd-levels-only
11756 (1- (* 2 (cdr desc)))
11759 ((eq (car desc) :maxlevel)
11760 (setq descre (concat "^\\*\\{1," (number-to-string
11761 (if org-odd-levels-only
11762 (1- (* 2 (cdr desc)))
11765 (t (error "Bad refiling target description %s" desc)))
11767 (with-current-buffer (if (bufferp f) f (org-get-agenda-file-buffer f))
11769 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11772 (setq f (buffer-file-name (buffer-base-buffer f))))
11773 (setq f (and f (expand-file-name f)))
11774 (when (eq org-refile-use-outline-path 'file)
11775 (push (list (file-name-nondirectory f) f nil nil) tgs))
11776 (org-with-wide-buffer
11777 (goto-char (point-min))
11778 (setq org-outline-path-cache nil)
11779 (while (re-search-forward descre nil t)
11780 (beginning-of-line)
11781 (let ((case-fold-search nil))
11782 (looking-at org-complex-heading-regexp))
11783 (let ((begin (point))
11784 (heading (match-string-no-properties 4)))
11786 org-refile-target-verify-function
11788 (funcall org-refile-target-verify-function)))
11790 (let ((re (format org-complex-heading-regexp-format
11791 (regexp-quote heading)))
11793 (if (not org-refile-use-outline-path) heading
11795 #'org-protect-slash
11797 (pcase org-refile-use-outline-path
11798 (`file (list (file-name-nondirectory
11800 (buffer-base-buffer)))))
11802 (list (buffer-file-name
11803 (buffer-base-buffer))))
11805 (org-get-outline-path t t))
11807 (push (list target f re (org-refile-marker (point)))
11809 (when (= (point) begin)
11810 ;; Verification function has not moved point.
11811 (end-of-line)))))))
11812 (when org-refile-use-cache
11813 (org-refile-cache-put tgs (buffer-file-name) descre))
11814 (setq targets (append tgs targets))))))
11815 (message "Getting targets...done")
11816 (nreverse targets)))
11818 (defun org-protect-slash (s)
11819 (replace-regexp-in-string "/" "\\/" s nil t))
11821 (defun org--get-outline-path-1 (&optional use-cache)
11822 "Return outline path to current headline.
11824 Outline path is a list of strings, in reverse order. When
11825 optional argument USE-CACHE is non-nil, make use of a cache. See
11826 `org-get-outline-path' for details.
11828 Assume buffer is widened and point is on a headline."
11829 (or (and use-cache (cdr (assq (point) org-outline-path-cache)))
11831 (heading (let ((case-fold-search nil))
11832 (looking-at org-complex-heading-regexp)
11833 (if (not (match-end 4)) ""
11834 ;; Remove statistics cookies.
11836 (org-link-display-format
11837 (replace-regexp-in-string
11838 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11839 (match-string-no-properties 4))))))))
11840 (if (org-up-heading-safe)
11841 (let ((path (cons heading (org--get-outline-path-1 use-cache))))
11843 (push (cons p path) org-outline-path-cache))
11845 ;; This is a new root node. Since we assume we are moving
11846 ;; forward, we can drop previous cache so as to limit number
11847 ;; of associations there.
11848 (let ((path (list heading)))
11849 (when use-cache (setq org-outline-path-cache (list (cons p path))))
11852 (defun org-get-outline-path (&optional with-self use-cache)
11853 "Return the outline path to the current entry.
11855 An outline path is a list of ancestors for current headline, as
11856 a list of strings. Statistics cookies are removed and links are
11857 replaced with their description, if any, or their path otherwise.
11859 When optional argument WITH-SELF is non-nil, the path also
11860 includes the current headline.
11862 When optional argument USE-CACHE is non-nil, cache outline paths
11863 between calls to this function so as to avoid backtracking. This
11864 argument is useful when planning to find more than one outline
11865 path in the same document. In that case, there are two
11866 conditions to satisfy:
11867 - `org-outline-path-cache' is set to nil before starting the
11869 - outline paths are computed by increasing buffer positions."
11870 (org-with-wide-buffer
11871 (and (or (and with-self (org-back-to-heading t))
11872 (org-up-heading-safe))
11873 (reverse (org--get-outline-path-1 use-cache)))))
11875 (defun org-format-outline-path (path &optional width prefix separator)
11876 "Format the outline path PATH for display.
11877 WIDTH is the maximum number of characters that is available.
11878 PREFIX is a prefix to be included in the returned string,
11879 such as the file name.
11880 SEPARATOR is inserted between the different parts of the path,
11881 the default is \"/\"."
11882 (setq width (or width 79))
11883 (setq path (delq nil path))
11884 (unless (> width 0)
11885 (user-error "Argument `width' must be positive"))
11886 (setq separator (or separator "/"))
11887 (let* ((org-odd-levels-only nil)
11889 prefix (and prefix path separator)
11891 (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
11892 (cl-loop for head in path
11894 collect (org-add-props
11896 (nth (% n org-n-level-faces) org-level-faces)))
11898 (when (> (length fpath) width)
11900 ;; It's unlikely that `width' will be this small, but don't
11901 ;; waste characters by adding ".." if it is.
11902 (setq fpath (substring fpath 0 width))
11903 (setf (substring fpath (- width 2)) "..")))
11906 (defun org-display-outline-path (&optional file current separator just-return-string)
11907 "Display the current outline path in the echo area.
11909 If FILE is non-nil, prepend the output with the file name.
11910 If CURRENT is non-nil, append the current heading to the output.
11911 SEPARATOR is passed through to `org-format-outline-path'. It separates
11912 the different parts of the path and defaults to \"/\".
11913 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11915 (let* (case-fold-search
11916 (bfn (buffer-file-name (buffer-base-buffer)))
11917 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11919 (when current (setq path (append path
11921 (org-back-to-heading t)
11922 (when (looking-at org-complex-heading-regexp)
11923 (list (match-string 4)))))))
11925 (org-format-outline-path
11928 (and file bfn (concat (file-name-nondirectory bfn) separator))
11930 (if just-return-string
11931 (org-no-properties res)
11932 (org-unlogged-message "%s" res))))
11934 (defvar org-refile-history nil
11935 "History for refiling operations.")
11937 (defvar org-after-refile-insert-hook nil
11938 "Hook run after `org-refile' has inserted its stuff at the new location.
11939 Note that this is still *before* the stuff will be removed from
11940 the *old* location.")
11942 (defvar org-capture-last-stored-marker)
11943 (defvar org-refile-keep nil
11944 "Non-nil means `org-refile' will copy instead of refile.")
11947 "Like `org-refile', but copy."
11949 (let ((org-refile-keep t))
11950 (funcall 'org-refile nil nil nil "Copy")))
11952 (defun org-refile (&optional arg default-buffer rfloc msg)
11953 "Move the entry or entries at point to another heading.
11955 The list of target headings is compiled using the information in
11956 `org-refile-targets', which see.
11958 At the target location, the entry is filed as a subitem of the
11959 target heading. Depending on `org-reverse-note-order', the new
11960 subitem will either be the first or the last subitem.
11962 If there is an active region, all entries in that region will be
11963 refiled. However, the region must fulfill the requirement that
11964 the first heading sets the top-level of the moved text.
11966 With a `\\[universal-argument]' ARG, the command will only visit the target \
11968 and not actually move anything.
11970 With a prefix `\\[universal-argument] \\[universal-argument]', go to the \
11971 location where the last
11972 refiling operation has put the subtree.
11974 With a numeric prefix argument of `2', refile to the running clock.
11976 With a numeric prefix argument of `3', emulate `org-refile-keep'
11977 being set to t and copy to the target location, don't move it.
11978 Beware that keeping refiled entries may result in duplicated ID
11981 RFLOC can be a refile location obtained in a different way.
11983 MSG is a string to replace \"Refile\" in the default prompt with
11984 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11986 See also `org-refile-use-outline-path'.
11988 If you are using target caching (see `org-refile-use-cache'), you
11989 have to clear the target cache in order to find new targets.
11990 This can be done with a `0' prefix (`C-0 C-c C-w') or a triple
11991 prefix argument (`C-u C-u C-u C-c C-w')."
11993 (if (member arg '(0 (64)))
11994 (org-refile-cache-clear)
11995 (let* ((actionmsg (cond (msg msg)
11996 ((equal arg 3) "Refile (and keep)")
11998 (regionp (org-region-active-p))
11999 (region-start (and regionp (region-beginning)))
12000 (region-end (and regionp (region-end)))
12001 (org-refile-keep (if (equal arg 3) t org-refile-keep))
12002 pos it nbuf file level reversed)
12003 (setq last-command nil)
12005 (goto-char region-start)
12006 (or (bolp) (goto-char (point-at-bol)))
12007 (setq region-start (point))
12008 (unless (or (org-kill-is-subtree-p
12009 (buffer-substring region-start region-end))
12010 (prog1 org-refile-active-region-within-subtree
12011 (let ((s (point-at-eol)))
12012 (org-toggle-heading)
12013 (setq region-end (+ (- (point-at-eol) s) region-end)))))
12014 (user-error "The region is not a (sequence of) subtree(s)")))
12015 (if (equal arg '(16))
12016 (org-refile-goto-last-stored)
12019 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
12021 (setq it (list (or org-clock-heading "running clock")
12023 (marker-buffer org-clock-hd-marker))
12025 (marker-position org-clock-hd-marker)))
12029 (let (heading-text)
12031 (unless (and arg (listp arg))
12032 (org-back-to-heading t)
12034 (replace-regexp-in-string
12035 org-bracket-link-regexp
12037 (or (nth 4 (org-heading-components))
12039 (org-refile-get-location
12040 (cond ((and arg (listp arg)) "Goto")
12041 (regionp (concat actionmsg " region to"))
12042 (t (concat actionmsg " subtree \""
12043 heading-text "\" to")))
12045 (and (not (equal '(4) arg))
12046 org-refile-allow-creating-parent-nodes)))))))
12047 (setq file (nth 1 it)
12049 (when (and (not arg)
12051 (equal (buffer-file-name) file)
12053 (and (>= pos region-start)
12054 (<= pos region-end))
12055 (and (>= pos (point))
12056 (< pos (save-excursion
12057 (org-end-of-subtree t t))))))
12058 (error "Cannot refile to position inside the tree or region"))
12059 (setq nbuf (or (find-buffer-visiting file)
12060 (find-file-noselect file)))
12061 (if (and arg (not (equal arg 3)))
12063 (pop-to-buffer-same-window nbuf)
12065 (org-show-context 'org-goto))
12068 (org-kill-new (buffer-substring region-start region-end))
12069 (org-save-markers-in-region region-start region-end))
12070 (org-copy-subtree 1 nil t))
12071 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
12072 (find-file-noselect file)))
12073 (setq reversed (org-notes-order-reversed-p))
12074 (org-with-wide-buffer
12078 (looking-at org-outline-regexp)
12079 (setq level (org-get-valid-level (funcall outline-level) 1))
12082 (or (outline-next-heading) (point-max))
12083 (or (save-excursion (org-get-next-sibling))
12084 (org-end-of-subtree t t)
12088 (goto-char (point-max))
12089 (goto-char (point-min))
12090 (or (outline-next-heading) (goto-char (point-max)))))
12091 (unless (bolp) (newline))
12092 (org-paste-subtree level nil nil t)
12093 (when org-log-refile
12094 (org-add-log-setup 'refile nil nil org-log-refile)
12095 (unless (eq org-log-refile 'note)
12096 (save-excursion (org-add-log-note))))
12097 (and org-auto-align-tags
12098 (let ((org-loop-over-headlines-in-active-region nil))
12099 (org-set-tags nil t)))
12100 (let ((bookmark-name (plist-get org-bookmark-names-plist
12102 (when bookmark-name
12103 (with-demoted-errors
12104 (bookmark-set bookmark-name))))
12105 ;; If we are refiling for capture, make sure that the
12106 ;; last-capture pointers point here
12107 (when (bound-and-true-p org-capture-is-refiling)
12108 (let ((bookmark-name (plist-get org-bookmark-names-plist
12109 :last-capture-marker)))
12110 (when bookmark-name
12111 (with-demoted-errors
12112 (bookmark-set bookmark-name))))
12113 (move-marker org-capture-last-stored-marker (point)))
12114 (when (fboundp 'deactivate-mark) (deactivate-mark))
12115 (run-hooks 'org-after-refile-insert-hook)))
12116 (unless org-refile-keep
12118 (delete-region (point) (+ (point) (- region-end region-start)))
12120 (and (org-back-to-heading t) (point))
12121 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
12122 (when (featurep 'org-inlinetask)
12123 (org-inlinetask-remove-END-maybe))
12124 (setq org-markers-to-move nil)
12125 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
12127 (defun org-refile-goto-last-stored ()
12128 "Go to the location where the last refile was stored."
12130 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12131 (message "This is the location of the last refile"))
12133 (defun org-refile--get-location (refloc tbl)
12134 "When user refile to REFLOC, find the associated target in TBL.
12135 Also check `org-refile-target-table'."
12139 (lambda (r) (or (assoc r tbl)
12140 (assoc r org-refile-target-table)))
12141 (list (replace-regexp-in-string "/$" "" refloc)
12142 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12144 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
12145 "Prompt the user for a refile location, using PROMPT.
12146 PROMPT should not be suffixed with a colon and a space, because
12147 this function appends the default value from
12148 `org-refile-history' automatically, if that is not empty."
12149 (let ((org-refile-targets org-refile-targets)
12150 (org-refile-use-outline-path org-refile-use-outline-path))
12151 (setq org-refile-target-table (org-refile-get-targets default-buffer)))
12152 (unless org-refile-target-table
12153 (user-error "No refile targets"))
12154 (let* ((cbuf (current-buffer))
12155 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12156 (cfunc (if (and org-refile-use-outline-path
12157 org-outline-path-complete-in-steps)
12158 #'org-olpath-completing-read
12159 #'completing-read))
12160 (extra (if org-refile-use-outline-path "/" ""))
12161 (cbnex (concat (buffer-name) extra))
12162 (filename (and cfn (expand-file-name cfn)))
12165 (if (and (not (member org-refile-use-outline-path
12166 '(file full-file-path)))
12167 (not (equal filename (nth 1 x))))
12168 (cons (concat (car x) extra " ("
12169 (file-name-nondirectory (nth 1 x)) ")")
12171 (cons (concat (car x) extra) (cdr x))))
12172 org-refile-target-table))
12173 (completion-ignore-case t)
12175 (prompt (concat prompt
12176 (or (and (car org-refile-history)
12177 (concat " (default " (car org-refile-history) ")"))
12178 (and (assoc cbnex tbl) (setq cdef cbnex)
12179 (concat " (default " cbnex ")"))) ": "))
12180 pa answ parent-target child parent old-hist)
12181 (setq old-hist org-refile-history)
12182 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12183 nil 'org-refile-history (or cdef (car org-refile-history))))
12184 (if (setq pa (org-refile--get-location answ tbl))
12186 (org-refile-check-position pa)
12187 (when (or (not org-refile-history)
12188 (not (eq old-hist org-refile-history))
12189 (not (equal (car pa) (car org-refile-history))))
12190 (setq org-refile-history
12191 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12193 (cdr org-refile-history))))
12194 (when (equal (car org-refile-history) (nth 1 org-refile-history))
12195 (pop org-refile-history)))
12197 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12199 (setq parent (match-string 1 answ)
12200 child (match-string 2 answ))
12201 (setq parent-target (org-refile--get-location parent tbl))
12202 (when (and parent-target
12203 (or (eq new-nodes t)
12204 (and (eq new-nodes 'confirm)
12205 (y-or-n-p (format "Create new node \"%s\"? "
12207 (org-refile-new-child parent-target child)))
12208 (user-error "Invalid target location")))))
12210 (declare-function org-string-nw-p "org-macs" (s))
12211 (defun org-refile-check-position (refile-pointer)
12212 "Check if the refile pointer matches the headline to which it points."
12213 (let* ((file (nth 1 refile-pointer))
12214 (re (nth 2 refile-pointer))
12215 (pos (nth 3 refile-pointer))
12217 (if (and (not (markerp pos)) (not file))
12218 (user-error "Please indicate a target file in the refile path")
12219 (when (org-string-nw-p re)
12220 (setq buffer (if (markerp pos)
12221 (marker-buffer pos)
12222 (or (find-buffer-visiting file)
12223 (find-file-noselect file))))
12224 (with-current-buffer buffer
12225 (org-with-wide-buffer
12227 (beginning-of-line 1)
12228 (unless (looking-at-p re)
12229 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
12231 (defun org-refile-new-child (parent-target child)
12232 "Use refile target PARENT-TARGET to add new CHILD below it."
12233 (unless parent-target
12234 (error "Cannot find parent for new node"))
12235 (let ((file (nth 1 parent-target))
12236 (pos (nth 3 parent-target))
12238 (with-current-buffer (or (find-buffer-visiting file)
12239 (find-file-noselect file))
12240 (org-with-wide-buffer
12243 (goto-char (point-max))
12244 (unless (bolp) (newline)))
12245 (when (looking-at org-outline-regexp)
12246 (setq level (funcall outline-level))
12247 (org-end-of-subtree t t))
12248 (org-back-over-empty-lines)
12249 (insert "\n" (make-string
12250 (if pos (org-get-valid-level level 1) 1) ?*)
12252 (beginning-of-line 0)
12253 (list (concat (car parent-target) "/" child) file "" (point))))))
12255 (defun org-olpath-completing-read (prompt collection &rest args)
12256 "Read an outline path like a file name."
12257 (let ((thetable collection))
12258 (apply #'completing-read
12260 (lambda (string predicate &optional flag)
12262 ((eq flag nil) (try-completion string thetable))
12264 (let ((l (length string)))
12265 (mapcar (lambda (x)
12266 (let ((r (substring x l))
12267 (f (if (string-match " ([^)]*)$" x)
12270 (if (string-match "/" r)
12271 (concat string (substring r 0 (match-end 0)) f)
12273 (all-completions string thetable predicate))))
12275 ((eq flag 'lambda) (assoc string thetable))))
12278 ;;;; Dynamic blocks
12280 (defun org-find-dblock (name)
12281 "Find the first dynamic block with name NAME in the buffer.
12282 If not found, stay at current position and return nil."
12283 (let ((case-fold-search t) pos)
12285 (goto-char (point-min))
12286 (setq pos (and (re-search-forward
12287 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12288 (match-beginning 0))))
12289 (when pos (goto-char pos))
12292 (defun org-create-dblock (plist)
12293 "Create a dynamic block section, with parameters taken from PLIST.
12294 PLIST must contain a :name entry which is used as the name of the block."
12295 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12298 (let ((col (current-column))
12299 (name (plist-get plist :name)))
12300 (insert "#+BEGIN: " name)
12302 (if (eq (car plist) :name)
12303 (setq plist (cddr plist))
12304 (insert " " (prin1-to-string (pop plist)))))
12305 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12306 (beginning-of-line -2)))
12308 (defun org-prepare-dblock ()
12309 "Prepare dynamic block for refresh.
12310 This empties the block, puts the cursor at the insert position and returns
12311 the property list including an extra property :name with the block name."
12312 (unless (looking-at org-dblock-start-re)
12313 (user-error "Not at a dynamic block"))
12314 (let* ((begdel (1+ (match-end 0)))
12315 (name (org-no-properties (match-string 1)))
12316 (params (append (list :name name)
12317 (read (concat "(" (match-string 3) ")")))))
12319 (beginning-of-line 1)
12320 (skip-chars-forward " \t")
12321 (setq params (plist-put params :indentation-column (current-column))))
12322 (unless (re-search-forward org-dblock-end-re nil t)
12323 (error "Dynamic block not terminated"))
12326 (list :content (buffer-substring
12327 begdel (match-beginning 0)))))
12328 (delete-region begdel (match-beginning 0))
12333 (defun org-map-dblocks (&optional command)
12334 "Apply COMMAND to all dynamic blocks in the current buffer.
12335 If COMMAND is not given, use `org-update-dblock'."
12336 (let ((cmd (or command 'org-update-dblock)))
12338 (goto-char (point-min))
12339 (while (re-search-forward org-dblock-start-re nil t)
12340 (goto-char (match-beginning 0))
12342 (condition-case nil
12344 (error (message "Error during update of dynamic block"))))
12345 (unless (re-search-forward org-dblock-end-re nil t)
12346 (error "Dynamic block not terminated"))))))
12348 (defun org-dblock-update (&optional arg)
12349 "User command for updating dynamic blocks.
12350 Update the dynamic block at point. With prefix ARG, update all dynamic
12351 blocks in the buffer."
12354 (org-update-all-dblocks)
12355 (or (looking-at org-dblock-start-re)
12356 (org-beginning-of-dblock))
12357 (org-update-dblock)))
12359 (defun org-update-dblock ()
12360 "Update the dynamic block at point.
12361 This means to empty the block, parse for parameters and then call
12362 the correct writing function."
12365 (let* ((win (selected-window))
12367 (line (org-current-line))
12368 (params (org-prepare-dblock))
12369 (name (plist-get params :name))
12370 (indent (plist-get params :indentation-column))
12371 (cmd (intern (concat "org-dblock-write:" name))))
12372 (message "Updating dynamic block `%s' at line %d..." name line)
12373 (funcall cmd params)
12374 (message "Updating dynamic block `%s' at line %d...done" name line)
12376 (when (and indent (> indent 0))
12377 (setq indent (make-string indent ?\ ))
12379 (select-window win)
12380 (org-beginning-of-dblock)
12382 (while (not (looking-at org-dblock-end-re))
12384 (beginning-of-line 2))
12385 (when (looking-at org-dblock-end-re)
12386 (and (looking-at "[ \t]+")
12387 (replace-match ""))
12388 (insert indent)))))))
12390 (defun org-beginning-of-dblock ()
12391 "Find the beginning of the dynamic block at point.
12392 Error if there is no such block at point."
12393 (let ((pos (point))
12396 (if (and (re-search-backward org-dblock-start-re nil t)
12397 (setq beg (match-beginning 0))
12398 (re-search-forward org-dblock-end-re nil t)
12399 (> (match-end 0) pos))
12402 (error "Not in a dynamic block"))))
12404 (defun org-update-all-dblocks ()
12405 "Update all dynamic blocks in the buffer.
12406 This function can be used in a hook."
12408 (when (derived-mode-p 'org-mode)
12409 (org-map-dblocks 'org-update-dblock)))
12414 (declare-function org-export-backend-options "ox" (cl-x) t)
12415 (defun org-get-export-keywords ()
12416 "Return a list of all currently understood export keywords.
12417 Export keywords include options, block names, attributes and
12418 keywords relative to each registered export back-end."
12421 (bound-and-true-p org-export-registered-backends)
12422 (delq nil keywords))
12423 ;; Back-end name (for keywords, like #+LATEX:)
12424 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12425 (dolist (option-entry (org-export-backend-options backend))
12426 ;; Back-end options.
12427 (push (nth 1 option-entry) keywords)))))
12429 (defconst org-options-keywords
12430 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12431 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12432 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12433 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12434 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12436 (defcustom org-structure-template-alist
12437 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12438 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12439 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12440 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12441 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12442 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12443 ("l" "#+BEGIN_EXPORT latex\n?\n#+END_EXPORT")
12445 ("h" "#+BEGIN_EXPORT html\n?\n#+END_EXPORT")
12447 ("a" "#+BEGIN_EXPORT ascii\n?\n#+END_EXPORT")
12450 ("I" "#+INCLUDE: %file ?"))
12451 "Structure completion elements.
12452 This is a list of abbreviation keys and values. The value gets inserted
12453 if you type `<' followed by the key and then press the completion key,
12454 usually `TAB'. %file will be replaced by a file name after prompting
12455 for the file using completion. The cursor will be placed at the position
12456 of the `?' in the template.
12457 There are two templates for each key, the first uses the original Org syntax,
12458 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12459 the default when the /org-mtags.el/ module has been loaded. See also the
12460 variable `org-mtags-prefer-muse-templates'."
12461 :group 'org-completion
12464 (string :tag "Key")
12465 (string :tag "Template")))
12467 :package-version '(Org . "8.3"))
12469 (defun org-try-structure-completion ()
12470 "Try to complete a structure template before point.
12471 This looks for strings like \"<e\" on an otherwise empty line and
12473 (let ((l (buffer-substring (point-at-bol) (point)))
12475 (when (and (looking-at "[ \t]*$")
12476 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12477 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12478 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12479 (match-beginning 1)) a)
12482 (defun org-complete-expand-structure-template (start cell)
12483 "Expand a structure template."
12484 (let ((rpl (nth 1 cell))
12486 (delete-region start (point))
12487 (when (string-match "\\`[ \t]*#\\+" rpl)
12490 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12491 (setq ind (buffer-substring (point-at-bol) (point))))
12493 (setq start (point))
12494 (when (string-match "%file" rpl)
12495 (setq rpl (replace-match
12499 (abbreviate-file-name (read-file-name "Include file: ")))
12502 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12503 (concat "\n" ind)))
12505 (when (re-search-backward "\\?" start t) (delete-char 1))))
12507 ;;;; TODO, DEADLINE, Comments
12509 (defun org-toggle-comment ()
12510 "Change the COMMENT state of an entry."
12513 (org-back-to-heading)
12514 (let ((case-fold-search nil))
12515 (looking-at org-complex-heading-regexp))
12516 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12517 (skip-chars-forward " \t")
12518 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12519 (if (org-in-commented-heading-p t)
12520 (delete-region (point)
12521 (progn (search-forward " " (line-end-position) 'move)
12522 (skip-chars-forward " \t")
12524 (insert org-comment-string)
12525 (unless (eolp) (insert " ")))))
12527 (defvar org-last-todo-state-is-todo nil
12528 "This is non-nil when the last TODO state change led to a TODO state.
12529 If the last change removed the TODO tag or switched to DONE, then
12532 (defvar org-setting-tags nil) ; dynamically skipped
12534 (defvar org-todo-setup-filter-hook nil
12535 "Hook for functions that pre-filter todo specs.
12536 Each function takes a todo spec and returns either nil or the spec
12537 transformed into canonical form." )
12539 (defvar org-todo-get-default-hook nil
12540 "Hook for functions that get a default item for todo.
12541 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12542 nil or a string to be used for the todo mark." )
12544 (defvar org-agenda-headline-snapshot-before-repeat)
12546 (defun org-current-effective-time ()
12547 "Return current time adjusted for `org-extend-today-until' variable."
12548 (let* ((ct (org-current-time))
12549 (dct (decode-time ct))
12552 (org-use-last-clock-out-time-as-effective-time
12553 (or (org-clock-get-last-clock-out-time) ct))
12554 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12555 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12559 (defun org-todo-yesterday (&optional arg)
12560 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12562 (if (eq major-mode 'org-agenda-mode)
12563 (apply 'org-agenda-todo-yesterday arg)
12564 (let* ((org-use-effective-time t)
12565 (hour (nth 2 (decode-time (org-current-time))))
12566 (org-extend-today-until (1+ hour)))
12569 (defvar org-block-entry-blocking ""
12570 "First entry preventing the TODO state change.")
12572 (defun org-cancel-repeater ()
12573 "Cancel a repeater by setting its numeric value to zero."
12576 (org-back-to-heading t)
12577 (let ((bound1 (point))
12578 (bound0 (save-excursion (outline-next-heading) (point))))
12579 (when (and (re-search-forward
12580 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12581 org-deadline-time-regexp "\\)\\|\\("
12582 org-ts-regexp "\\)")
12584 (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]"
12586 (replace-match "0" t nil nil 1)))))
12589 (defvar org-blocked-by-checkboxes)
12590 (defun org-todo (&optional arg)
12591 "Change the TODO state of an item.
12593 The state of an item is given by a keyword at the start of the heading,
12595 *** TODO Write paper
12598 The different keywords are specified in the variable `org-todo-keywords'.
12599 By default the available states are \"TODO\" and \"DONE\". So, for this
12600 example: when the item starts with TODO, it is changed to DONE.
12601 When it starts with DONE, the DONE is removed. And when neither TODO nor
12602 DONE are present, add TODO at the beginning of the heading.
12604 With `\\[universal-argument]' prefix ARG, use completion to determine the new \
12606 With numeric prefix ARG, switch to that state.
12607 With a `\\[universal-argument] \\[universal-argument]' prefix, switch to the \
12609 keywords (nextset).
12610 With a `\\[universal-argument] \\[universal-argument] \\[universal-argument]' \
12611 prefix, circumvent any state blocking.
12612 With a numeric prefix arg of 0, inhibit note taking for the change.
12613 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12615 When called through ELisp, arg is also interpreted in the following way:
12616 `none' -> empty state
12617 \"\" -> switch to empty state
12618 `done' -> switch to DONE
12619 `nextset' -> switch to the next set of keywords
12620 `previousset' -> switch to the previous set of keywords
12621 \"WAITING\" -> switch to the specified keyword, but only if it
12622 really is a member of `org-todo-keywords'."
12624 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12625 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12626 'region-start-level 'region))
12627 org-loop-over-headlines-in-active-region)
12630 org-loop-over-headlines-in-active-region
12631 cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
12632 (when (equal arg '(16)) (setq arg 'nextset))
12633 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12634 (let ((org-blocker-hook org-blocker-hook)
12637 (when (equal arg '(64))
12638 (setq arg nil org-blocker-hook nil))
12639 (when (and org-blocker-hook
12640 (or org-inhibit-blocking
12641 (org-entry-get nil "NOBLOCKING")))
12642 (setq org-blocker-hook nil))
12645 (org-back-to-heading t)
12646 (when (org-in-commented-heading-p t)
12647 (org-toggle-comment)
12649 (when (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12650 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12651 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12652 (let* ((match-data (match-data))
12653 (startpos (point-at-bol))
12654 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12655 (org-log-done org-log-done)
12656 (org-log-repeat org-log-repeat)
12657 (org-todo-log-states org-todo-log-states)
12658 (org-inhibit-logging
12660 (progn (setq arg nil) 'note) org-inhibit-logging))
12661 (this (match-string 1))
12662 (hl-pos (match-beginning 0))
12663 (head (org-get-todo-sequence-head this))
12664 (ass (assoc head org-todo-kwd-alist))
12665 (interpret (nth 1 ass))
12666 (done-word (nth 3 ass))
12667 (final-done-word (nth 4 ass))
12668 (org-last-state (or this ""))
12669 (completion-ignore-case t)
12670 (member (member this org-todo-keywords-1))
12671 (tail (cdr member))
12673 ((and org-todo-key-trigger
12674 (or (and (equal arg '(4))
12675 (eq org-use-fast-todo-selection 'prefix))
12676 (and (not arg) org-use-fast-todo-selection
12677 (not (eq org-use-fast-todo-selection
12679 ;; Use fast selection.
12680 (org-fast-todo-selection))
12681 ((and (equal arg '(4))
12682 (or (not org-use-fast-todo-selection)
12683 (not org-todo-key-trigger)))
12684 ;; Read a state with completion.
12686 "State: " (mapcar #'list org-todo-keywords-1)
12690 (if tail (car tail) nil)
12691 (car org-todo-keywords-1)))
12693 (unless (equal member org-todo-keywords-1)
12695 (nth (- (length org-todo-keywords-1)
12697 org-todo-keywords-1)
12698 (org-last org-todo-keywords-1))))
12699 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12700 (setq arg nil))) ;hack to fall back to cycling
12702 ;; User or caller requests a specific state.
12704 ((equal arg "") nil)
12705 ((eq arg 'none) nil)
12706 ((eq arg 'done) (or done-word (car org-done-keywords)))
12708 (or (car (cdr (member head org-todo-heads)))
12709 (car org-todo-heads)))
12710 ((eq arg 'previousset)
12711 (let ((org-todo-heads (reverse org-todo-heads)))
12712 (or (car (cdr (member head org-todo-heads)))
12713 (car org-todo-heads))))
12714 ((car (member arg org-todo-keywords-1)))
12716 (user-error "State `%s' not valid in this file" arg))
12717 ((nth (1- (prefix-numeric-value arg))
12718 org-todo-keywords-1))))
12719 ((null member) (or head (car org-todo-keywords-1)))
12720 ((equal this final-done-word) nil) ;-> make empty
12721 ((null tail) nil) ;-> first entry
12722 ((memq interpret '(type priority))
12723 (if (eq this-command last-command)
12725 (if (> (length tail) 0)
12726 (or done-word (car org-done-keywords))
12731 (run-hook-with-args-until-success
12732 'org-todo-get-default-hook org-state org-last-state)
12734 (next (if org-state (concat " " org-state " ") " "))
12735 (change-plist (list :type 'todo-state-change :from this :to org-state
12736 :position startpos))
12738 (when org-blocker-hook
12739 (let (org-blocked-by-checkboxes block-reason)
12740 (setq org-last-todo-state-is-todo
12741 (not (member this org-done-keywords)))
12742 (unless (save-excursion
12744 (org-with-wide-buffer
12745 (run-hook-with-args-until-failure
12746 'org-blocker-hook change-plist))))
12747 (setq block-reason (if org-blocked-by-checkboxes
12748 "contained checkboxes"
12749 (format "\"%s\"" org-block-entry-blocking)))
12750 (if (called-interactively-p 'interactive)
12751 (user-error "TODO state change from %s to %s blocked (by %s)"
12752 this org-state block-reason)
12754 (message "TODO state change from %s to %s blocked (by %s)"
12755 this org-state block-reason)
12756 (throw 'exit nil)))))
12757 (store-match-data match-data)
12758 (replace-match next t t)
12759 (cond ((equal this org-state)
12760 (message "TODO state was already %s" (org-trim next)))
12761 ((pos-visible-in-window-p hl-pos)
12762 (message "TODO state changed to %s" (org-trim next))))
12764 (setq head (org-get-todo-sequence-head org-state)
12765 ass (assoc head org-todo-kwd-alist)
12766 interpret (nth 1 ass)
12767 done-word (nth 3 ass)
12768 final-done-word (nth 4 ass)))
12769 (when (memq arg '(nextset previousset))
12770 (message "Keyword-Set %d/%d: %s"
12771 (- (length org-todo-sets) -1
12772 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12773 (length org-todo-sets)
12774 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12775 (setq org-last-todo-state-is-todo
12776 (not (member org-state org-done-keywords)))
12777 (setq now-done-p (and (member org-state org-done-keywords)
12778 (not (member this org-done-keywords))))
12779 (and logging (org-local-logging logging))
12780 (when (and (or org-todo-log-states org-log-done)
12781 (not (eq org-inhibit-logging t))
12782 (not (memq arg '(nextset previousset))))
12783 ;; We need to look at recording a time and note.
12784 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12785 (nth 2 (assoc this org-todo-log-states))))
12786 (when (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12787 (setq dolog 'time))
12788 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12790 (member org-state org-not-done-keywords)
12791 (not (member this org-not-done-keywords))))
12792 ;; This is now a todo state and was not one before
12793 ;; If there was a CLOSED time stamp, get rid of it.
12794 (org-add-planning-info nil nil 'closed))
12795 (when (and now-done-p org-log-done)
12796 ;; It is now done, and it was not done before.
12797 (org-add-planning-info 'closed (org-current-effective-time))
12798 (when (and (not dolog) (eq 'note org-log-done))
12799 (org-add-log-setup 'done org-state this 'note)))
12800 (when (and org-state dolog)
12801 ;; This is a non-nil state, and we need to log it.
12802 (org-add-log-setup 'state org-state this dolog)))
12803 ;; Fixup tag positioning.
12804 (org-todo-trigger-tag-changes org-state)
12805 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12806 (when org-provide-todo-statistics
12807 (org-update-parent-todo-statistics))
12808 (run-hooks 'org-after-todo-state-change-hook)
12809 (when (and arg (not (member org-state org-done-keywords)))
12810 (setq head (org-get-todo-sequence-head org-state)))
12811 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12812 ;; Do we need to trigger a repeat?
12814 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12815 ;; This is for the agenda, take a snapshot of the headline.
12817 (setq org-agenda-headline-snapshot-before-repeat
12818 (org-get-heading))))
12819 (org-auto-repeat-maybe org-state))
12820 ;; Fixup cursor location if close to the keyword.
12821 (when (and (outline-on-heading-p)
12823 (save-excursion (beginning-of-line 1)
12824 (looking-at org-todo-line-regexp))
12825 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12826 (goto-char (or (match-end 2) (match-end 1)))
12827 (and (looking-at " ") (just-one-space)))
12828 (when org-trigger-hook
12830 (run-hook-with-args 'org-trigger-hook change-plist)))
12831 (when commentp (org-toggle-comment))))))))
12833 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12834 "Block turning an entry into a TODO, using the hierarchy.
12835 This checks whether the current task should be blocked from state
12836 changes. Such blocking occurs when:
12838 1. The task has children which are not all in a completed state.
12840 2. A task has a parent with the property :ORDERED:, and there
12841 are siblings prior to the current task with incomplete
12844 3. The parent of the task is blocked because it has siblings that should
12845 be done first, or is child of a block grandparent TODO entry."
12847 (if (not org-enforce-todo-dependencies)
12848 t ; if locally turned off don't block
12850 ;; If this is not a todo state change, or if this entry is already DONE,
12852 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12853 (member (plist-get change-plist :from)
12854 (cons 'done org-done-keywords))
12855 (member (plist-get change-plist :to)
12856 (cons 'todo org-not-done-keywords))
12857 (not (plist-get change-plist :to)))
12858 (throw 'dont-block t))
12859 ;; If this task has children, and any are undone, it's blocked
12861 (org-back-to-heading t)
12862 (let ((this-level (funcall outline-level)))
12863 (outline-next-heading)
12864 (let ((child-level (funcall outline-level)))
12865 (while (and (not (eobp))
12866 (> child-level this-level))
12867 ;; this todo has children, check whether they are all
12869 (when (and (not (org-entry-is-done-p))
12870 (org-entry-is-todo-p))
12871 (setq org-block-entry-blocking (org-get-heading))
12872 (throw 'dont-block nil))
12873 (outline-next-heading)
12874 (setq child-level (funcall outline-level))))))
12875 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12876 ;; any previous siblings are undone, it's blocked
12878 (org-back-to-heading t)
12879 (let* ((pos (point))
12880 (parent-pos (and (org-up-heading-safe) (point)))
12881 (case-fold-search nil))
12882 (unless parent-pos (throw 'dont-block t)) ; no parent
12883 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12885 (re-search-forward org-not-done-heading-regexp pos t))
12886 (setq org-block-entry-blocking (match-string 0))
12887 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12888 ;; Search further up the hierarchy, to see if an ancestor is blocked
12890 (goto-char parent-pos)
12891 (unless (looking-at org-not-done-heading-regexp)
12892 (throw 'dont-block t)) ; do not block, parent is not a TODO
12894 (setq parent-pos (and (org-up-heading-safe) (point)))
12895 (unless parent-pos (throw 'dont-block t)) ; no parent
12896 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12898 (re-search-forward org-not-done-heading-regexp pos t)
12899 (setq org-block-entry-blocking (org-get-heading)))
12900 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12902 (defcustom org-track-ordered-property-with-tag nil
12903 "Should the ORDERED property also be shown as a tag?
12904 The ORDERED property decides if an entry should require subtasks to be
12905 completed in sequence. Since a property is not very visible, setting
12906 this option means that toggling the ORDERED property with the command
12907 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12908 not relevant for the behavior, but it makes things more visible.
12910 Note that toggling the tag with tags commands will not change the property
12911 and therefore not influence behavior!
12913 This can be t, meaning the tag ORDERED should be used, It can also be a
12914 string to select a different tag for this task."
12917 (const :tag "No tracking" nil)
12918 (const :tag "Track with ORDERED tag" t)
12919 (string :tag "Use other tag")))
12921 (defun org-toggle-ordered-property ()
12922 "Toggle the ORDERED property of the current entry.
12923 For better visibility, you can track the value of this property with a tag.
12924 See variable `org-track-ordered-property-with-tag'."
12926 (let* ((t1 org-track-ordered-property-with-tag)
12927 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12929 (org-back-to-heading)
12930 (if (org-entry-get nil "ORDERED")
12932 (org-delete-property "ORDERED")
12933 (and tag (org-toggle-tag tag 'off))
12934 (message "Subtasks can be completed in arbitrary order"))
12935 (org-entry-put nil "ORDERED" "t")
12936 (and tag (org-toggle-tag tag 'on))
12937 (message "Subtasks must be completed in sequence")))))
12939 (defun org-block-todo-from-checkboxes (change-plist)
12940 "Block turning an entry into a TODO, using checkboxes.
12941 This checks whether the current task should be blocked from state
12942 changes because there are unchecked boxes in this entry."
12943 (if (not org-enforce-todo-checkbox-dependencies)
12944 t ; if locally turned off don't block
12946 ;; If this is not a todo state change, or if this entry is already DONE,
12948 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12949 (member (plist-get change-plist :from)
12950 (cons 'done org-done-keywords))
12951 (member (plist-get change-plist :to)
12952 (cons 'todo org-not-done-keywords))
12953 (not (plist-get change-plist :to)))
12954 (throw 'dont-block t))
12955 ;; If this task has checkboxes that are not checked, it's blocked
12957 (org-back-to-heading t)
12958 (let ((beg (point)) end)
12959 (outline-next-heading)
12962 (when (org-list-search-forward
12963 (concat (org-item-beginning-re)
12964 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12967 (when (boundp 'org-blocked-by-checkboxes)
12968 (setq org-blocked-by-checkboxes t))
12969 (throw 'dont-block nil))))
12970 t))) ; do not block
12972 (defun org-entry-blocked-p ()
12973 "Non-nil if entry at point is blocked."
12974 (and (not (org-entry-get nil "NOBLOCKING"))
12975 (member (org-entry-get nil "TODO") org-not-done-keywords)
12976 (not (run-hook-with-args-until-failure
12978 (list :type 'todo-state-change
12983 (defun org-update-statistics-cookies (all)
12984 "Update the statistics cookie, either from TODO or from checkboxes.
12985 This should be called with the cursor in a line with a statistics
12986 cookie. When called with a \\[universal-argument] prefix, update
12987 all statistics cookies in the buffer."
12991 (org-update-checkbox-count 'all)
12992 (org-map-entries 'org-update-parent-todo-statistics))
12993 (if (not (org-at-heading-p))
12994 (org-update-checkbox-count)
12995 (let ((pos (point-marker))
12997 (ignore-errors (org-back-to-heading t))
12998 (if (not (org-at-heading-p))
12999 (org-update-checkbox-count)
13000 (setq l1 (org-outline-level))
13001 (setq end (save-excursion
13002 (outline-next-heading)
13003 (when (org-at-heading-p) (setq l2 (org-outline-level)))
13005 (if (and (save-excursion
13007 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
13008 (not (save-excursion (re-search-forward
13009 ":COOKIE_DATA:.*\\<todo\\>" end t))))
13010 (org-update-checkbox-count)
13011 (if (and l2 (> l2 l1))
13014 (org-update-parent-todo-statistics))
13016 (beginning-of-line 1)
13017 (while (re-search-forward
13018 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
13020 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
13022 (move-marker pos nil)))))
13024 (defvar org-entry-property-inherited-from) ;; defined below
13025 (defun org-update-parent-todo-statistics ()
13026 "Update any statistics cookie in the parent of the current headline.
13027 When `org-hierarchical-todo-statistics' is nil, statistics will cover
13028 the entire subtree and this will travel up the hierarchy and update
13029 statistics everywhere."
13030 (let* ((prop (save-excursion (org-up-heading-safe)
13031 (org-entry-get nil "COOKIE_DATA" 'inherit)))
13032 (recursive (or (not org-hierarchical-todo-statistics)
13033 (and prop (string-match "\\<recursive\\>" prop))))
13034 (lim (or (and prop (marker-position org-entry-property-inherited-from))
13037 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
13038 level ltoggle l1 new ndel
13039 (cnt-all 0) (cnt-done 0) is-percent kwd
13040 checkbox-beg cookie-present)
13043 (beginning-of-line 1)
13044 (setq ltoggle (funcall outline-level))
13045 ;; Three situations are to consider:
13047 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
13048 ;; to the top-level ancestor on the headline;
13050 ;; 2. If parent has "recursive" property, repeat up to the
13051 ;; headline setting that property, taking inheritance into
13054 ;; 3. Else, move up to direct parent and proceed only once.
13055 (while (and (setq level (org-up-heading-safe))
13056 (or recursive first)
13058 (setq first nil cookie-present nil)
13062 (downcase (or (org-entry-get nil "COOKIE_DATA")
13065 (while (re-search-forward box-re (point-at-eol) t)
13066 (setq cnt-all 0 cnt-done 0 cookie-present t)
13067 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
13069 (unless (outline-next-heading) (throw 'exit nil))
13070 (while (and (looking-at org-complex-heading-regexp)
13071 (> (setq l1 (length (match-string 1))) level))
13072 (setq kwd (and (or recursive (= l1 ltoggle))
13074 (if (or (eq org-provide-todo-statistics 'all-headlines)
13075 (and (eq org-provide-todo-statistics t)
13076 (or (member kwd org-done-keywords)))
13077 (and (listp org-provide-todo-statistics)
13078 (stringp (car org-provide-todo-statistics))
13079 (or (member kwd org-provide-todo-statistics)
13080 (member kwd org-done-keywords)))
13081 (and (listp org-provide-todo-statistics)
13082 (listp (car org-provide-todo-statistics))
13083 (or (member kwd (car org-provide-todo-statistics))
13084 (and (member kwd org-done-keywords)
13085 (member kwd (cadr org-provide-todo-statistics))))))
13086 (setq cnt-all (1+ cnt-all))
13087 (and (eq org-provide-todo-statistics t)
13089 (setq cnt-all (1+ cnt-all))))
13090 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
13091 (member kwd org-done-keywords))
13092 (and (listp org-provide-todo-statistics)
13093 (listp (car org-provide-todo-statistics))
13094 (member kwd org-done-keywords)
13095 (member kwd (cadr org-provide-todo-statistics)))
13096 (and (listp org-provide-todo-statistics)
13097 (stringp (car org-provide-todo-statistics))
13098 (member kwd org-done-keywords)))
13099 (setq cnt-done (1+ cnt-done)))
13100 (outline-next-heading)))
13103 (format "[%d%%]" (floor (* 100.0 cnt-done)
13105 (format "[%d/%d]" cnt-done cnt-all))
13106 ndel (- (match-end 0) checkbox-beg))
13107 (goto-char checkbox-beg)
13109 (delete-region (point) (+ (point) ndel))
13110 (when org-auto-align-tags (org-fix-tags-on-the-fly)))
13111 (when cookie-present
13112 (run-hook-with-args 'org-after-todo-statistics-hook
13113 cnt-done (- cnt-all cnt-done))))))
13114 (run-hooks 'org-todo-statistics-hook)))
13116 (defvar org-after-todo-statistics-hook nil
13117 "Hook that is called after a TODO statistics cookie has been updated.
13118 Each function is called with two arguments: the number of not-done entries
13119 and the number of done entries.
13121 For example, the following function, when added to this hook, will switch
13122 an entry to DONE when all children are done, and back to TODO when new
13123 entries are set to a TODO status. Note that this hook is only called
13124 when there is a statistics cookie in the headline!
13126 (defun org-summary-todo (n-done n-not-done)
13127 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13128 (let (org-log-done org-log-states) ; turn off logging
13129 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13132 (defvar org-todo-statistics-hook nil
13133 "Hook that is run whenever Org thinks TODO statistics should be updated.
13134 This hook runs even if there is no statistics cookie present, in which case
13135 `org-after-todo-statistics-hook' would not run.")
13137 (defun org-todo-trigger-tag-changes (state)
13138 "Apply the changes defined in `org-todo-state-tags-triggers'."
13139 (let ((l org-todo-state-tags-triggers)
13141 (when (or (not state) (equal state ""))
13142 (setq changes (append changes (cdr (assoc "" l)))))
13143 (when (and (stringp state) (> (length state) 0))
13144 (setq changes (append changes (cdr (assoc state l)))))
13145 (when (member state org-not-done-keywords)
13146 (setq changes (append changes (cdr (assq 'todo l)))))
13147 (when (member state org-done-keywords)
13148 (setq changes (append changes (cdr (assq 'done l)))))
13149 (dolist (c changes)
13150 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13152 (defun org-local-logging (value)
13153 "Get logging settings from a property VALUE."
13154 ;; Directly set the variables, they are already local.
13155 (setq org-log-done nil
13157 org-todo-log-states nil)
13158 (dolist (w (org-split-string value))
13161 ((setq a (assoc w org-startup-options))
13162 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13163 (set (nth 1 a) (nth 2 a))))
13164 ((setq a (org-extract-log-state-settings w))
13165 (and (member (car a) org-todo-keywords-1)
13166 (push a org-todo-log-states)))))))
13168 (defun org-get-todo-sequence-head (kwd)
13169 "Return the head of the TODO sequence to which KWD belongs.
13170 If KWD is not set, check if there is a text property remembering the
13175 (or (get-text-property (point-at-bol) 'org-todo-head)
13177 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13178 nil (point-at-eol)))
13179 (get-text-property p 'org-todo-head))))
13180 ((not (member kwd org-todo-keywords-1))
13181 (car org-todo-keywords-1))
13182 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13184 (defun org-fast-todo-selection ()
13185 "Fast TODO keyword selection with single keys.
13186 Returns the new TODO keyword, or nil if no state change should occur."
13187 (let* ((fulltable org-todo-key-alist)
13188 (done-keywords org-done-keywords) ;; needed for the faces.
13189 (maxlen (apply 'max (mapcar
13191 (if (stringp (car x)) (string-width (car x)) 0))
13194 (fwidth (+ maxlen 3 1 3))
13195 (ncol (/ (- (window-width) 4) fwidth))
13199 (save-window-excursion
13201 (set-buffer (get-buffer-create " *Org todo*"))
13202 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13204 (setq-local org-done-keywords done-keywords)
13205 (setq tbl fulltable cnt 0)
13206 (while (setq e (pop tbl))
13208 ((equal e '(:startgroup))
13209 (push '() groups) (setq ingroup t)
13214 ((equal e '(:endgroup))
13215 (setq ingroup nil cnt 0)
13217 ((equal e '(:newline))
13222 (while (equal (car tbl) '(:newline))
13224 (setq tbl (cdr tbl)))))
13226 (setq tg (car e) c (cdr e))
13227 (when ingroup (push tg (car groups)))
13228 (setq tg (org-add-props tg nil 'face
13229 (org-get-todo-face tg)))
13230 (when (and (= cnt 0) (not ingroup)) (insert " "))
13231 (insert "[" c "] " tg (make-string
13232 (- fwidth 4 (length tg)) ?\ ))
13233 (when (= (setq cnt (1+ cnt)) ncol)
13235 (when ingroup (insert " "))
13238 (goto-char (point-min))
13239 (unless expert (org-fit-window-to-buffer))
13240 (message "[a-z..]:Set [SPC]:clear")
13241 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13244 (and (= c ?q) (not (rassoc c fulltable))))
13245 (setq quit-flag t))
13247 ((setq e (rassoc c fulltable) tg (car e))
13249 (t (setq quit-flag t)))))))
13251 (defun org-entry-is-todo-p ()
13252 (member (org-get-todo-state) org-not-done-keywords))
13254 (defun org-entry-is-done-p ()
13255 (member (org-get-todo-state) org-done-keywords))
13257 (defun org-get-todo-state ()
13258 "Return the TODO keyword of the current subtree."
13260 (org-back-to-heading t)
13261 (and (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
13263 (match-string 2))))
13265 (defun org-at-date-range-p (&optional inactive-ok)
13266 "Non-nil if point is inside a date range.
13268 When optional argument INACTIVE-OK is non-nil, also consider
13269 inactive time ranges.
13271 When this function returns a non-nil value, match data is set
13272 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13277 (let ((pos (point)))
13278 (skip-chars-backward "^[<\r\n")
13279 (skip-chars-backward "<[")
13280 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13281 (>= (match-end 0) pos)
13283 (skip-chars-backward "^<[\r\n")
13284 (skip-chars-backward "<[")
13285 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13286 (>= (match-end 0) pos)
13290 (defun org-get-repeat (&optional tagline)
13291 "Check if there is a deadline/schedule with repeater in this entry."
13294 (org-back-to-heading t)
13295 (and (re-search-forward (if tagline
13296 (concat tagline "\\s-*" org-repeat-re)
13298 (org-entry-end-position) t)
13299 (match-string-no-properties 1)))))
13301 (defvar org-last-changed-timestamp)
13302 (defvar org-last-inserted-timestamp)
13303 (defvar org-log-post-message)
13304 (defvar org-log-note-purpose)
13305 (defvar org-log-note-how nil)
13306 (defvar org-log-note-extra)
13307 (defun org-auto-repeat-maybe (done-word)
13308 "Check if the current headline contains a repeated time-stamp.
13310 If yes, set TODO state back to what it was and change the base date
13311 of repeating deadline/scheduled time stamps to new date.
13313 This function is run automatically after each state change to a DONE state."
13314 (let* ((repeat (org-get-repeat))
13315 (aa (assoc org-last-state org-todo-kwd-alist))
13316 (interpret (nth 1 aa))
13318 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13319 (msg "Entry repeats: ")
13321 (org-todo-log-states nil))
13322 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13323 (when (eq org-log-repeat t) (setq org-log-repeat 'state))
13324 (let ((to-state (or (org-entry-get nil "REPEAT_TO_STATE" 'selective)
13325 org-todo-repeat-to-state)))
13326 (org-todo (cond ((and to-state (member to-state org-todo-keywords-1))
13328 ((eq interpret 'type) org-last-state)
13331 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13332 (org-entry-put nil "LAST_REPEAT" (format-time-string
13333 (org-time-stamp-format t t))))
13334 (when org-log-repeat
13335 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13336 (memq 'org-add-log-note post-command-hook))
13337 ;; We are already setup for some record.
13338 (when (eq org-log-repeat 'note)
13339 ;; Make sure we take a note, not only a time stamp.
13340 (setq org-log-note-how 'note))
13341 ;; Set up for taking a record.
13342 (org-add-log-setup 'state
13343 (or done-word (car org-done-keywords))
13346 (org-back-to-heading t)
13347 (org-add-planning-info nil nil 'closed)
13348 (let ((end (save-excursion (outline-next-heading) (point)))
13349 (planning-re (regexp-opt
13350 (list org-scheduled-string org-deadline-string))))
13351 (while (re-search-forward org-ts-regexp end t)
13352 (let* ((ts (match-string 0))
13353 (planning? (org-at-planning-p))
13354 (type (if (not planning?) "Plain:"
13356 (re-search-backward
13357 planning-re (line-beginning-position) t)
13358 (match-string 0)))))
13360 ;; Ignore fake time-stamps (e.g., within comments).
13361 ((and (not planning?)
13362 (not (org-at-property-p))
13363 (not (eq 'timestamp
13364 (org-element-type (save-excursion
13366 (org-element-context)))))))
13367 ;; Time-stamps without a repeater are usually skipped.
13368 ;; However, a SCHEDULED time-stamp without one is
13369 ;; removed, as it is considered as no longer relevant.
13370 ((not (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))
13371 (when (equal type org-scheduled-string)
13372 (org-remove-timestamp-with-keyword type)))
13374 (let ((n (string-to-number (match-string 2 ts)))
13375 (what (match-string 3 ts)))
13376 (when (equal what "w") (setq n (* n 7) what "d"))
13377 (when (and (equal what "h")
13378 (not (string-match-p "[0-9]\\{1,2\\}:[0-9]\\{2\\}"
13381 "Cannot repeat in Repeat in %d hour(s) because no hour \
13384 ;; Preparation, see if we need to modify the start
13385 ;; date for the change.
13386 (when (match-end 1)
13387 (let ((time (save-match-data (org-time-string-to-time ts))))
13389 ((equal (match-string 1 ts) ".")
13390 ;; Shift starting date to today
13391 (org-timestamp-change
13392 (- (org-today) (time-to-days time))
13394 ((equal (match-string 1 ts) "+")
13395 (let ((nshiftmax 10)
13397 (while (or (= nshift 0)
13398 (not (time-less-p (current-time) time)))
13399 (when (= (cl-incf nshift) nshiftmax)
13401 (format "%d repeater intervals were not \
13402 enough to shift date past today. Continue? "
13404 (user-error "Abort")))
13405 (org-timestamp-change n (cdr (assoc what whata)))
13406 (org-at-timestamp-p t)
13407 (setq ts (match-string 1))
13410 (org-time-string-to-time ts)))))
13411 (org-timestamp-change (- n) (cdr (assoc what whata)))
13412 ;; Rematch, so that we have everything in place
13413 ;; for the real shift.
13414 (org-at-timestamp-p t)
13415 (setq ts (match-string 1))
13416 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)"
13419 (org-timestamp-change n (cdr (assoc what whata)) nil t))
13422 msg type " " org-last-changed-timestamp " "))))))))
13423 (setq org-log-post-message msg)
13424 (message "%s" msg))))
13426 (defun org-show-todo-tree (arg)
13427 "Make a compact tree which shows all headlines marked with TODO.
13428 The tree will show the lines where the regexp matches, and all higher
13429 headlines above the match.
13430 With a `\\[universal-argument]' prefix, prompt for a regexp to match.
13431 With a numeric prefix N, construct a sparse tree for the Nth element
13432 of `org-todo-keywords-1'."
13434 (let ((case-fold-search nil)
13436 (cond ((null arg) org-not-done-regexp)
13439 (completing-read "Keyword (or KWD1|KWD2|...): "
13440 (mapcar #'list org-todo-keywords-1))))
13442 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13444 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13445 (regexp-quote (nth (1- (prefix-numeric-value arg))
13446 org-todo-keywords-1)))
13447 (t (user-error "Invalid prefix argument: %s" arg)))))
13448 (message "%d TODO entries found"
13449 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13451 (defun org--deadline-or-schedule (arg type time)
13452 "Insert DEADLINE or SCHEDULE information in current entry.
13453 TYPE is either `deadline' or `scheduled'. See `org-deadline' or
13454 `org-schedule' for information about ARG and TIME arguments."
13455 (let* ((deadline? (eq type 'deadline))
13456 (keyword (if deadline? org-deadline-string org-scheduled-string))
13457 (log (if deadline? org-log-redeadline org-log-reschedule))
13458 (old-date (org-entry-get nil (if deadline? "DEADLINE" "SCHEDULED")))
13459 (old-date-time (and old-date (org-time-string-to-time old-date)))
13460 ;; Save repeater cookie from either TIME or current scheduled
13461 ;; time stamp. We are going to insert it back at the end of
13463 (repeater (or (and (org-string-nw-p time)
13464 ;; We use `org-repeat-re' because we need
13465 ;; to tell the difference between a real
13466 ;; repeater and a time delta, e.g. "+2d".
13467 (string-match org-repeat-re time)
13468 (match-string 1 time))
13469 (and (org-string-nw-p old-date)
13470 (string-match "\\([.+-]+[0-9]+[hdwmy]\
13471 \\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\)"
13473 (match-string 1 old-date)))))
13476 (when (and old-date log)
13477 (org-add-log-setup (if deadline? 'deldeadline 'delschedule)
13479 (org-remove-timestamp-with-keyword keyword)
13480 (message (if deadline? "Item no longer has a deadline."
13481 "Item is no longer scheduled.")))
13484 (org-back-to-heading t)
13485 (let ((regexp (if deadline? org-deadline-time-regexp
13486 org-scheduled-time-regexp)))
13487 (if (not (re-search-forward regexp (line-end-position 2) t))
13488 (user-error (if deadline? "No deadline information to update"
13489 "No scheduled information to update"))
13490 (let* ((rpl0 (match-string 1))
13491 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0))
13492 (msg (if deadline? "Warn starting from" "Delay until")))
13497 (abs (- (time-to-days
13500 nil t nil msg old-date-time)))
13501 (time-to-days old-date-time))))
13504 (org-add-planning-info type time 'closed)
13505 (when (and old-date
13507 (not (equal old-date org-last-inserted-timestamp)))
13508 (org-add-log-setup (if deadline? 'redeadline 'reschedule)
13509 org-last-inserted-timestamp
13514 (org-back-to-heading t)
13515 (when (re-search-forward
13516 (concat keyword " " org-last-inserted-timestamp)
13517 (line-end-position 2)
13519 (goto-char (1- (match-end 0)))
13520 (insert " " repeater)
13521 (setq org-last-inserted-timestamp
13522 (concat (substring org-last-inserted-timestamp 0 -1)
13524 (substring org-last-inserted-timestamp -1))))))
13525 (message (if deadline? "Deadline on %s" "Scheduled to %s")
13526 org-last-inserted-timestamp)))))
13528 (defun org-deadline (arg &optional time)
13529 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13530 With one universal prefix argument, remove any deadline from the item.
13531 With two universal prefix arguments, prompt for a warning delay.
13532 With argument TIME, set the deadline at the corresponding date. TIME
13533 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13535 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13537 (lambda () (org--deadline-or-schedule arg 'deadline time))
13539 (if (eq org-loop-over-headlines-in-active-region 'start-level)
13540 'region-start-level
13542 (lambda () (when (outline-invisible-p) (org-end-of-subtree nil t))))
13543 (org--deadline-or-schedule arg 'deadline time)))
13545 (defun org-schedule (arg &optional time)
13546 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13547 With one universal prefix argument, remove any scheduling date from the item.
13548 With two universal prefix arguments, prompt for a delay cookie.
13549 With argument TIME, scheduled at the corresponding date. TIME can
13550 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13552 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13554 (lambda () (org--deadline-or-schedule arg 'scheduled time))
13556 (if (eq org-loop-over-headlines-in-active-region 'start-level)
13557 'region-start-level
13559 (lambda () (when (outline-invisible-p) (org-end-of-subtree nil t))))
13560 (org--deadline-or-schedule arg 'scheduled time)))
13562 (defun org-get-scheduled-time (pom &optional inherit)
13563 "Get the scheduled time as a time tuple, of a format suitable
13564 for calling org-schedule with, or if there is no scheduling,
13566 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13568 (apply 'encode-time (org-parse-time-string time)))))
13570 (defun org-get-deadline-time (pom &optional inherit)
13571 "Get the deadline as a time tuple, of a format suitable for
13572 calling org-deadline with, or if there is no scheduling, returns
13574 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13576 (apply 'encode-time (org-parse-time-string time)))))
13578 (defun org-remove-timestamp-with-keyword (keyword)
13579 "Remove all time stamps with KEYWORD in the current entry."
13580 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13583 (org-back-to-heading t)
13585 (outline-next-heading)
13586 (while (re-search-backward re beg t)
13588 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13589 (equal (char-before) ?\ ))
13590 (backward-delete-char 1)
13591 (when (string-match "^[ \t]*$" (buffer-substring
13592 (point-at-bol) (point-at-eol)))
13593 (delete-region (point-at-bol)
13594 (min (point-max) (1+ (point-at-eol))))))))))
13596 (defvar org-time-was-given) ; dynamically scoped parameter
13597 (defvar org-end-time-was-given) ; dynamically scoped parameter
13599 (defun org-at-planning-p ()
13600 "Non-nil when point is on a planning info line."
13601 ;; This is as accurate and faster than `org-element-at-point' since
13602 ;; planning info location is fixed in the section.
13603 (org-with-wide-buffer
13604 (beginning-of-line)
13605 (and (looking-at-p org-planning-line-re)
13608 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13609 (org-back-to-heading t)
13610 (org-with-limited-levels (org-back-to-heading t)))
13611 (line-beginning-position 2))))))
13613 (defun org-add-planning-info (what &optional time &rest remove)
13614 "Insert new timestamp with keyword in the planning line.
13615 WHAT indicates what kind of time stamp to add. It is a symbol
13616 among `closed', `deadline', `scheduled' and nil. TIME indicates
13617 the time to use. If none is given, the user is prompted for
13618 a date. REMOVE indicates what kind of entries to remove. An old
13619 WHAT entry will also be removed."
13620 (let (org-time-was-given org-end-time-was-given default-time default-input)
13622 (when (and (memq what '(scheduled deadline))
13624 (and (stringp time)
13625 (string-match "^[-+]+[0-9]" time))))
13626 ;; Try to get a default date/time from existing timestamp
13628 (org-back-to-heading t)
13629 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13630 (when (re-search-forward (if (eq what 'scheduled)
13631 org-scheduled-time-regexp
13632 org-deadline-time-regexp)
13634 (setq ts (match-string 1)
13635 default-time (apply 'encode-time (org-parse-time-string ts))
13636 default-input (and ts (org-get-compact-tod ts)))))))
13640 ;; This is a string (relative or absolute), set
13642 (apply #'encode-time
13643 (org-read-date-analyze
13644 time default-time (decode-time default-time)))
13645 ;; If necessary, get the time from the user
13646 (or time (org-read-date nil 'to-time nil nil
13647 default-time default-input)))))
13649 (org-with-wide-buffer
13650 (org-back-to-heading t)
13652 (unless (bolp) (insert "\n"))
13653 (cond ((looking-at-p org-planning-line-re)
13654 ;; Move to current indentation.
13655 (skip-chars-forward " \t")
13656 ;; Check if we have to remove something.
13657 (dolist (type (if what (cons what remove) remove))
13659 (when (re-search-forward
13661 (closed org-closed-time-regexp)
13662 (deadline org-deadline-time-regexp)
13663 (scheduled org-scheduled-time-regexp)
13665 (error "Invalid planning type: %s" type)))
13666 (line-end-position) t)
13667 ;; Delete until next keyword or end of line.
13669 (match-beginning 0)
13670 (if (re-search-forward org-keyword-time-not-clock-regexp
13671 (line-end-position)
13673 (match-beginning 0)
13674 (line-end-position))))))
13675 ;; If there is nothing more to add and no more keyword
13676 ;; is left, remove the line completely.
13677 (if (and (looking-at-p "[ \t]*$") (not what))
13678 (delete-region (line-beginning-position)
13679 (line-beginning-position 2))
13680 ;; If we removed last keyword, do not leave trailing
13681 ;; white space at the end of line.
13685 (unless (= (skip-chars-backward " \t" p) 0)
13686 (delete-region (point) (line-end-position)))))))
13687 ((not what) (throw 'exit nil)) ; Nothing to do.
13688 (t (insert-before-markers "\n")
13690 (when org-adapt-indentation
13691 (indent-to-column (1+ (org-outline-level))))))
13693 ;; Insert planning keyword.
13694 (insert (cl-case what
13695 (closed org-closed-string)
13696 (deadline org-deadline-string)
13697 (scheduled org-scheduled-string)
13698 (otherwise (error "Invalid planning type: %s" what)))
13700 ;; Insert associated timestamp.
13701 (let ((ts (org-insert-time-stamp
13703 (or org-time-was-given
13704 (and (eq what 'closed) org-log-done-with-time))
13706 nil nil (list org-end-time-was-given))))
13707 (unless (eolp) (insert " "))
13710 (defvar org-log-note-marker (make-marker)
13711 "Marker pointing at the entry where the note is to be inserted.")
13712 (defvar org-log-note-purpose nil)
13713 (defvar org-log-note-state nil)
13714 (defvar org-log-note-previous-state nil)
13715 (defvar org-log-note-extra nil)
13716 (defvar org-log-note-window-configuration nil)
13717 (defvar org-log-note-return-to (make-marker))
13718 (defvar org-log-note-effective-time nil
13719 "Remembered current time so that dynamically scoped
13720 `org-extend-today-until' affects timestamps in state change log")
13722 (defvar org-log-post-message nil
13723 "Message to be displayed after a log note has been stored.
13724 The auto-repeater uses this.")
13726 (defun org-add-note ()
13727 "Add a note to the current entry.
13728 This is done in the same way as adding a state change note."
13730 (org-add-log-setup 'note))
13732 (defun org-log-beginning (&optional create)
13733 "Return expected start of log notes in current entry.
13734 When optional argument CREATE is non-nil, the function creates
13735 a drawer to store notes, if necessary. Returned position ignores
13737 (org-with-wide-buffer
13738 (let ((drawer (org-log-into-drawer)))
13741 (org-end-of-meta-data)
13742 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13743 (end (if (org-at-heading-p) (point)
13744 (save-excursion (outline-next-heading) (point))))
13745 (case-fold-search t))
13747 ;; Try to find existing drawer.
13748 (while (re-search-forward regexp end t)
13749 (let ((element (org-element-at-point)))
13750 (when (eq (org-element-type element) 'drawer)
13751 (let ((cend (org-element-property :contents-end element)))
13752 (when (and (not org-log-states-order-reversed) cend)
13754 (throw 'exit nil))))
13755 ;; No drawer found. Create one, if permitted.
13757 (unless (bolp) (insert "\n"))
13758 (let ((beg (point)))
13759 (insert ":" drawer ":\n:END:\n")
13760 (org-indent-region beg (point)))
13761 (end-of-line -1)))))
13763 (org-end-of-meta-data org-log-state-notes-insert-after-drawers)
13764 (skip-chars-forward " \t\n")
13765 (beginning-of-line)
13766 (unless org-log-states-order-reversed
13767 (org-skip-over-state-notes)
13768 (skip-chars-backward " \t\n")
13770 (if (bolp) (point) (line-beginning-position 2))))
13772 (defun org-add-log-setup (&optional purpose state prev-state how extra)
13773 "Set up the post command hook to take a note.
13774 If this is about to TODO state change, the new state is expected in STATE.
13775 HOW is an indicator what kind of note should be created.
13776 EXTRA is additional text that will be inserted into the notes buffer."
13777 (move-marker org-log-note-marker (point))
13778 (setq org-log-note-purpose purpose
13779 org-log-note-state state
13780 org-log-note-previous-state prev-state
13781 org-log-note-how how
13782 org-log-note-extra extra
13783 org-log-note-effective-time (org-current-effective-time))
13784 (add-hook 'post-command-hook 'org-add-log-note 'append))
13786 (defun org-skip-over-state-notes ()
13787 "Skip past the list of State notes in an entry."
13788 (when (ignore-errors (goto-char (org-in-item-p)))
13789 (let* ((struct (org-list-struct))
13790 (prevs (org-list-prevs-alist struct))
13792 (concat "[ \t]*- +"
13793 (replace-regexp-in-string
13795 (org-replace-escapes
13796 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13797 `(("%d" . ,org-ts-regexp-inactive)
13798 ("%D" . ,org-ts-regexp)
13799 ("%s" . "\"\\S-+\"")
13800 ("%S" . "\"\\S-+\"")
13801 ("%t" . ,org-ts-regexp-inactive)
13802 ("%T" . ,org-ts-regexp)
13804 ("%U" . ".*?")))))))
13805 (while (looking-at-p regexp)
13806 (goto-char (or (org-list-get-next-item (point) struct prevs)
13807 (org-list-get-item-end (point) struct)))))))
13809 (defun org-add-log-note (&optional _purpose)
13810 "Pop up a window for taking a note, and add this note later."
13811 (remove-hook 'post-command-hook 'org-add-log-note)
13812 (setq org-log-note-window-configuration (current-window-configuration))
13813 (delete-other-windows)
13814 (move-marker org-log-note-return-to (point))
13815 (pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13816 (goto-char org-log-note-marker)
13817 (org-switch-to-buffer-other-window "*Org Note*")
13819 (if (memq org-log-note-how '(time state))
13820 (let (current-prefix-arg) (org-store-log-note))
13821 (let ((org-inhibit-startup t)) (org-mode))
13822 (insert (format "# Insert note for %s.
13823 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13825 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13826 ((eq org-log-note-purpose 'done) "closed todo item")
13827 ((eq org-log-note-purpose 'state)
13828 (format "state change from \"%s\" to \"%s\""
13829 (or org-log-note-previous-state "")
13830 (or org-log-note-state "")))
13831 ((eq org-log-note-purpose 'reschedule)
13833 ((eq org-log-note-purpose 'delschedule)
13834 "no longer scheduled")
13835 ((eq org-log-note-purpose 'redeadline)
13836 "changing deadline")
13837 ((eq org-log-note-purpose 'deldeadline)
13838 "removing deadline")
13839 ((eq org-log-note-purpose 'refile)
13841 ((eq org-log-note-purpose 'note)
13843 (t (error "This should not happen")))))
13844 (when org-log-note-extra (insert org-log-note-extra))
13845 (setq-local org-finish-function 'org-store-log-note)
13846 (run-hooks 'org-log-buffer-setup-hook)))
13848 (defvar org-note-abort nil) ; dynamically scoped
13849 (defun org-store-log-note ()
13850 "Finish taking a log note, and insert it to where it belongs."
13851 (let ((txt (prog1 (buffer-string)
13853 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
13855 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13856 (setq txt (replace-match "" t t txt)))
13857 (when (string-match "\\s-+\\'" txt)
13858 (setq txt (replace-match "" t t txt)))
13859 (setq lines (org-split-string txt "\n"))
13860 (when (org-string-nw-p note)
13862 (org-replace-escapes
13864 (list (cons "%u" (user-login-name))
13865 (cons "%U" user-full-name)
13866 (cons "%t" (format-time-string
13867 (org-time-stamp-format 'long 'inactive)
13868 org-log-note-effective-time))
13869 (cons "%T" (format-time-string
13870 (org-time-stamp-format 'long nil)
13871 org-log-note-effective-time))
13872 (cons "%d" (format-time-string
13873 (org-time-stamp-format nil 'inactive)
13874 org-log-note-effective-time))
13875 (cons "%D" (format-time-string
13876 (org-time-stamp-format nil nil)
13877 org-log-note-effective-time))
13879 ((not org-log-note-state) "")
13880 ((string-match-p org-ts-regexp
13881 org-log-note-state)
13883 (substring org-log-note-state 1 -1)))
13884 (t (format "\"%s\"" org-log-note-state))))
13887 ((not org-log-note-previous-state) "")
13888 ((string-match-p org-ts-regexp
13889 org-log-note-previous-state)
13892 org-log-note-previous-state 1 -1)))
13893 (t (format "\"%s\""
13894 org-log-note-previous-state)))))))
13895 (when lines (setq note (concat note " \\\\")))
13897 (when (and lines (not (or current-prefix-arg org-note-abort)))
13898 (with-current-buffer (marker-buffer org-log-note-marker)
13899 (org-with-wide-buffer
13900 ;; Find location for the new note.
13901 (goto-char org-log-note-marker)
13902 (set-marker org-log-note-marker nil)
13903 ;; Note associated to a clock is to be located right after
13904 ;; the clock. Do not move point.
13905 (unless (eq org-log-note-purpose 'clock-out)
13906 (goto-char (org-log-beginning t)))
13907 ;; Make sure point is at the beginning of an empty line.
13908 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13909 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13910 ;; In an existing list, add a new item at the top level.
13911 ;; Otherwise, indent line like a regular one.
13912 (let ((itemp (org-in-item-p)))
13915 (let ((struct (save-excursion
13916 (goto-char itemp) (org-list-struct))))
13917 (org-list-get-ind (org-list-get-top-point struct) struct)))
13918 (org-indent-line)))
13919 (insert (org-list-bullet-string "-") (pop lines))
13920 (let ((ind (org-list-item-body-column (line-beginning-position))))
13921 (dolist (line lines)
13923 (indent-line-to ind)
13925 (message "Note stored")
13926 (org-back-to-heading t)
13927 (org-cycle-hide-drawers 'children))
13928 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13929 ;; from within `org-add-log-note' because `buffer-undo-list'
13930 ;; is then modified outside of `org-with-remote-undo'.
13931 (when (eq this-command 'org-agenda-todo)
13932 (setcdr buffer-undo-list (cddr buffer-undo-list))))))
13933 ;; Don't add undo information when called from `org-agenda-todo'.
13934 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13935 (set-window-configuration org-log-note-window-configuration)
13936 (with-current-buffer (marker-buffer org-log-note-return-to)
13937 (goto-char org-log-note-return-to))
13938 (move-marker org-log-note-return-to nil)
13939 (when org-log-post-message (message "%s" org-log-post-message))))
13941 (defun org-remove-empty-drawer-at (pos)
13942 "Remove an empty drawer at position POS.
13943 POS may also be a marker."
13944 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13945 (org-with-wide-buffer
13947 (let ((drawer (org-element-at-point)))
13948 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13949 (not (org-element-property :contents-begin drawer)))
13950 (delete-region (org-element-property :begin drawer)
13951 (progn (goto-char (org-element-property :end drawer))
13952 (skip-chars-backward " \r\t\n")
13956 (defvar org-ts-type nil)
13957 (defun org-sparse-tree (&optional arg type)
13958 "Create a sparse tree, prompt for the details.
13959 This command can create sparse trees. You first need to select the type
13960 of match used to create the tree:
13962 t Show all TODO entries.
13963 T Show entries with a specific TODO keyword.
13964 m Show entries selected by a tags/property match.
13965 p Enter a property name and its value (both with completion on existing
13966 names/values) and show entries with that property.
13967 r Show entries matching a regular expression (`/' can be used as well).
13968 b Show deadlines and scheduled items before a date.
13969 a Show deadlines and scheduled items after a date.
13970 d Show deadlines due within `org-deadline-warning-days'.
13971 D Show deadlines and scheduled items between a date range."
13973 (setq type (or type org-sparse-tree-default-date-type))
13974 (setq org-ts-type type)
13975 (message "Sparse tree: [r]egexp [t]odo [T]odo-kwd [m]atch [p]roperty
13976 \[d]eadlines [b]efore-date [a]fter-date [D]ates range
13977 \[c]ycle through date types: %s"
13979 (all "all timestamps")
13980 (scheduled "only scheduled")
13981 (deadline "only deadline")
13982 (active "only active timestamps")
13983 (inactive "only inactive timestamps")
13984 (closed "with a closed time-stamp")
13985 (otherwise "scheduled/deadline")))
13986 (let ((answer (read-char-exclusive)))
13992 (memq type '(nil all scheduled deadline active inactive closed)))))
13993 (?d (call-interactively 'org-check-deadlines))
13994 (?b (call-interactively 'org-check-before-date))
13995 (?a (call-interactively 'org-check-after-date))
13996 (?D (call-interactively 'org-check-dates-range))
13997 (?t (call-interactively 'org-show-todo-tree))
13998 (?T (org-show-todo-tree '(4)))
13999 (?m (call-interactively 'org-match-sparse-tree))
14001 (let* ((kwd (completing-read
14002 "Property: " (mapcar #'list (org-buffer-property-keys))))
14003 (value (completing-read
14004 "Value: " (mapcar #'list (org-property-values kwd)))))
14005 (unless (string-match "\\`{.*}\\'" value)
14006 (setq value (concat "\"" value "\"")))
14007 (org-match-sparse-tree arg (concat kwd "=" value))))
14008 ((?r ?R ?/) (call-interactively 'org-occur))
14009 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
14011 (defvar-local org-occur-highlights nil
14012 "List of overlays used for occur matches.")
14013 (defvar-local org-occur-parameters nil
14014 "Parameters of the active org-occur calls.
14015 This is a list, each call to org-occur pushes as cons cell,
14016 containing the regular expression and the callback, onto the list.
14017 The list can contain several entries if `org-occur' has been called
14018 several time with the KEEP-PREVIOUS argument. Otherwise, this list
14019 will only contain one set of parameters. When the highlights are
14020 removed (for example with `C-c C-c', or with the next edit (depending
14021 on `org-remove-highlights-with-change'), this variable is emptied
14024 (defun org-occur (regexp &optional keep-previous callback)
14025 "Make a compact tree which shows all matches of REGEXP.
14027 The tree will show the lines where the regexp matches, and any other context
14028 defined in `org-show-context-detail', which see.
14030 When optional argument KEEP-PREVIOUS is non-nil, highlighting and exposing
14031 done by a previous call to `org-occur' will be kept, to allow stacking of
14032 calls to this command.
14034 Optional argument CALLBACK can be a function of no argument. In this case,
14035 it is called with point at the end of the match, match data being set
14036 accordingly. Current match is shown only if the return value is non-nil.
14037 The function must neither move point nor alter narrowing."
14038 (interactive "sRegexp: \nP")
14039 (when (equal regexp "")
14040 (user-error "Regexp cannot be empty"))
14041 (unless keep-previous
14042 (org-remove-occur-highlights nil nil t))
14043 (push (cons regexp callback) org-occur-parameters)
14046 (goto-char (point-min))
14047 (when (or (not keep-previous) ; do not want to keep
14048 (not org-occur-highlights)) ; no previous matches
14051 (let ((case-fold-search (if (eq org-occur-case-fold-search 'smart)
14052 (isearch-no-upper-case-p regexp t)
14053 org-occur-case-fold-search)))
14054 (while (re-search-forward regexp nil t)
14055 (when (or (not callback)
14056 (save-match-data (funcall callback)))
14057 (setq cnt (1+ cnt))
14058 (when org-highlight-sparse-tree-matches
14059 (org-highlight-new-match (match-beginning 0) (match-end 0)))
14060 (org-show-context 'occur-tree)))))
14061 (when org-remove-highlights-with-change
14062 (add-hook 'before-change-functions 'org-remove-occur-highlights
14064 (unless org-sparse-tree-open-archived-trees
14065 (org-hide-archived-subtrees (point-min) (point-max)))
14066 (run-hooks 'org-occur-hook)
14067 (when (called-interactively-p 'interactive)
14068 (message "%d match(es) for regexp %s" cnt regexp))
14071 (defun org-occur-next-match (&optional n _reset)
14072 "Function for `next-error-function' to find sparse tree matches.
14073 N is the number of matches to move, when negative move backwards.
14074 This function always goes back to the starting point when no
14076 (let* ((limit (if (< n 0) (point-min) (point-max)))
14077 (search-func (if (< n 0)
14078 'previous-single-char-property-change
14079 'next-single-char-property-change))
14084 (while (setq p1 (funcall search-func (point) 'org-type))
14085 (when (equal p1 limit)
14087 (user-error "No more matches"))
14088 (when (equal (get-char-property p1 'org-type) 'org-occur)
14092 (throw 'exit (point))))
14095 (user-error "No more matches"))))
14097 (defun org-show-context (&optional key)
14098 "Make sure point and context are visible.
14099 Optional argument KEY, when non-nil, is a symbol. See
14100 `org-show-context-detail' for allowed values and how much is to
14102 (org-show-set-visibility
14103 (cond ((symbolp org-show-context-detail) org-show-context-detail)
14104 ((cdr (assq key org-show-context-detail)))
14105 (t (cdr (assq 'default org-show-context-detail))))))
14107 (defun org-show-set-visibility (detail)
14108 "Set visibility around point according to DETAIL.
14109 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
14110 `tree', `canonical' or t. See `org-show-context-detail' for more
14112 ;; Show current heading and possibly its entry, following headline
14113 ;; or all children.
14114 (if (and (org-at-heading-p) (not (eq detail 'local)))
14115 (org-flag-heading nil)
14117 ;; If point is hidden within a drawer or a block, make sure to
14119 (dolist (o (overlays-at (point)))
14120 (when (memq (overlay-get o 'invisible) '(org-hide-block outline))
14121 (delete-overlay o)))
14122 (unless (org-before-first-heading-p)
14123 (org-with-limited-levels
14125 ((tree canonical t) (org-show-children))
14126 ((nil minimal ancestors))
14128 (outline-next-heading)
14129 (org-flag-heading nil)))))))
14130 ;; Show all siblings.
14131 (when (eq detail 'lineage) (org-show-siblings))
14132 ;; Show ancestors, possibly with their children.
14133 (when (memq detail '(ancestors lineage tree canonical t))
14135 (while (org-up-heading-safe)
14136 (org-flag-heading nil)
14137 (when (memq detail '(canonical t)) (org-show-entry))
14138 (when (memq detail '(tree canonical t)) (org-show-children))))))
14140 (defvar org-reveal-start-hook nil
14141 "Hook run before revealing a location.")
14143 (defun org-reveal (&optional siblings)
14144 "Show current entry, hierarchy above it, and the following headline.
14146 This can be used to show a consistent set of context around
14147 locations exposed with `org-show-context'.
14149 With optional argument SIBLINGS, on each level of the hierarchy all
14150 siblings are shown. This repairs the tree structure to what it would
14151 look like when opened with hierarchical calls to `org-cycle'.
14153 With a \\[universal-argument] \\[universal-argument] prefix, \
14154 go to the parent and show the entire tree."
14156 (run-hooks 'org-reveal-start-hook)
14157 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14158 ((equal siblings '(16))
14160 (when (org-up-heading-safe)
14162 (run-hook-with-args 'org-cycle-hook 'subtree))))
14163 (t (org-show-set-visibility 'lineage))))
14165 (defun org-highlight-new-match (beg end)
14166 "Highlight from BEG to END and mark the highlight is an occur headline."
14167 (let ((ov (make-overlay beg end)))
14168 (overlay-put ov 'face 'secondary-selection)
14169 (overlay-put ov 'org-type 'org-occur)
14170 (push ov org-occur-highlights)))
14172 (defun org-remove-occur-highlights (&optional _beg _end noremove)
14173 "Remove the occur highlights from the buffer.
14174 BEG and END are ignored. If NOREMOVE is nil, remove this function
14175 from the `before-change-functions' in the current buffer."
14177 (unless org-inhibit-highlight-removal
14178 (mapc #'delete-overlay org-occur-highlights)
14179 (setq org-occur-highlights nil)
14180 (setq org-occur-parameters nil)
14182 (remove-hook 'before-change-functions
14183 'org-remove-occur-highlights 'local))))
14187 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14188 "Regular expression matching the priority indicator.")
14190 (defvar org-remove-priority-next-time nil)
14192 (defun org-priority-up ()
14193 "Increase the priority of the current item."
14195 (org-priority 'up))
14197 (defun org-priority-down ()
14198 "Decrease the priority of the current item."
14200 (org-priority 'down))
14202 (defun org-priority (&optional action _show)
14203 "Change the priority of an item.
14204 ACTION can be `set', `up', `down', or a character."
14206 (if (equal action '(4))
14207 (org-show-priority)
14208 (unless org-enable-priority-commands
14209 (user-error "Priority commands are disabled"))
14210 (setq action (or action 'set))
14211 (let (current new news have remove)
14213 (org-back-to-heading t)
14214 (when (looking-at org-priority-regexp)
14215 (setq current (string-to-char (match-string 2))
14218 ((eq action 'remove)
14219 (setq remove t new ?\ ))
14220 ((or (eq action 'set)
14222 (if (not (eq action 'set))
14224 (message "Priority %c-%c, SPC to remove: "
14225 org-highest-priority org-lowest-priority)
14227 (setq new (read-char-exclusive))))
14228 (when (and (= (upcase org-highest-priority) org-highest-priority)
14229 (= (upcase org-lowest-priority) org-lowest-priority))
14230 (setq new (upcase new)))
14231 (cond ((equal new ?\ ) (setq remove t))
14232 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14233 (user-error "Priority must be between `%c' and `%c'"
14234 org-highest-priority org-lowest-priority))))
14237 (1- current) ; normal cycling
14238 ;; last priority was empty
14239 (if (eq last-command this-command)
14240 org-lowest-priority ; wrap around empty to lowest
14242 (if org-priority-start-cycle-with-default
14243 org-default-priority
14244 (1- org-default-priority))))))
14247 (1+ current) ; normal cycling
14248 ;; last priority was empty
14249 (if (eq last-command this-command)
14250 org-highest-priority ; wrap around empty to highest
14252 (if org-priority-start-cycle-with-default
14253 org-default-priority
14254 (1+ org-default-priority))))))
14255 (t (user-error "Invalid action")))
14256 (when (or (< (upcase new) org-highest-priority)
14257 (> (upcase new) org-lowest-priority))
14258 (if (and (memq action '(up down))
14259 (not have) (not (eq last-command this-command)))
14260 ;; `new' is from default priority
14262 "The default can not be set, see `org-default-priority' why")
14263 ;; normal cycling: `new' is beyond highest/lowest priority
14264 ;; and is wrapped around to the empty priority
14266 (setq news (format "%c" new))
14269 (replace-match "" t t nil 1)
14270 (replace-match news t t nil 2))
14272 (user-error "No priority cookie found in line")
14273 (let ((case-fold-search nil)) (looking-at org-todo-line-regexp))
14276 (goto-char (match-end 2))
14277 (insert " [#" news "]"))
14278 (goto-char (match-beginning 3))
14279 (insert "[#" news "] "))))
14280 (org-set-tags nil 'align))
14282 (message "Priority removed")
14283 (message "Priority of current item set to %s" news)))))
14285 (defun org-show-priority ()
14286 "Show the priority of the current item.
14287 This priority is composed of the main priority given with the [#A] cookies,
14288 and by additional input from the age of a schedules or deadline entry."
14290 (let ((pri (if (eq major-mode 'org-agenda-mode)
14291 (org-get-at-bol 'priority)
14294 (beginning-of-line)
14295 (and (looking-at org-heading-regexp)
14296 (org-get-priority (match-string 0))))))))
14297 (message "Priority is %d" (if pri pri -1000))))
14299 (defun org-get-priority (s)
14300 "Find priority cookie and return priority."
14302 (if (functionp org-get-priority-function)
14303 (funcall org-get-priority-function)
14304 (if (not (string-match org-priority-regexp s))
14305 (* 1000 (- org-lowest-priority org-default-priority))
14306 (* 1000 (- org-lowest-priority
14307 (string-to-char (match-string 2 s))))))))
14311 (defvar org-agenda-archives-mode)
14312 (defvar org-map-continue-from nil
14313 "Position from where mapping should continue.
14314 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14316 (defvar org-scanner-tags nil
14317 "The current tag list while the tags scanner is running.")
14319 (defvar org-trust-scanner-tags nil
14320 "Should `org-get-tags-at' use the tags for the scanner.
14321 This is for internal dynamical scoping only.
14322 When this is non-nil, the function `org-get-tags-at' will return the value
14323 of `org-scanner-tags' instead of building the list by itself. This
14324 can lead to large speed-ups when the tags scanner is used in a file with
14325 many entries, and when the list of tags is retrieved, for example to
14326 obtain a list of properties. Building the tags list for each entry in such
14327 a file becomes an N^2 operation - but with this variable set, it scales
14330 (defvar org--matcher-tags-todo-only nil)
14332 (defun org-scan-tags (action matcher todo-only &optional start-level)
14333 "Scan headline tags with inheritance and produce output ACTION.
14335 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14336 or `agenda' to produce an entry list for an agenda view. It can also be
14337 a Lisp form or a function that should be called at each matched headline, in
14338 this case the return value is a list of all return values from these calls.
14340 MATCHER is a function accepting three arguments, returning
14341 a non-nil value whenever a given set of tags qualifies a headline
14342 for inclusion. See `org-make-tags-matcher' for more information.
14343 As a special case, it can also be set to t (respectively nil) in
14344 order to match all (respectively none) headline.
14346 When TODO-ONLY is non-nil, only lines with a not-done TODO
14347 keyword are included in the output.
14349 START-LEVEL can be a string with asterisks, reducing the scope to
14350 headlines matching this string."
14351 (require 'org-agenda)
14352 (let* ((re (concat "^"
14354 ;; Get the correct level to match
14355 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14356 org-outline-regexp)
14358 (mapconcat #'regexp-quote org-todo-keywords-1 "\\|")
14359 "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
14360 (props (list 'face 'default
14361 'done-face 'org-agenda-done
14362 'undone-face 'default
14363 'mouse-face 'highlight
14364 'org-not-done-regexp org-not-done-regexp
14365 'org-todo-regexp org-todo-regexp
14366 'org-complex-heading-regexp org-complex-heading-regexp
14368 (format "mouse-2 or RET jump to org file %s"
14369 (abbreviate-file-name
14370 (or (buffer-file-name (buffer-base-buffer))
14371 (buffer-name (buffer-base-buffer)))))))
14372 (org-map-continue-from nil)
14373 lspos tags tags-list
14374 (tags-alist (list (cons 0 org-file-tags)))
14375 (llast 0) rtn rtn1 level category i txt
14376 todo marker entry priority
14377 ts-date ts-date-type ts-date-pair)
14378 (unless (or (member action '(agenda sparse-tree)) (functionp action))
14379 (setq action (list 'lambda nil action)))
14381 (goto-char (point-min))
14382 (when (eq action 'sparse-tree)
14384 (org-remove-occur-highlights))
14385 (while (let (case-fold-search)
14386 (re-search-forward re nil t))
14387 (setq org-map-continue-from nil)
14390 ;; TODO: is the 1-2 difference a bug?
14391 (when (match-end 1) (match-string-no-properties 2))
14392 tags (when (match-end 4) (match-string-no-properties 4)))
14393 (goto-char (setq lspos (match-beginning 0)))
14394 (setq level (org-reduced-level (org-outline-level))
14395 category (org-get-category))
14396 (when (eq action 'agenda)
14397 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14398 ts-date (car ts-date-pair)
14399 ts-date-type (cdr ts-date-pair)))
14400 (setq i llast llast level)
14401 ;; remove tag lists from same and sublevels
14402 (while (>= i level)
14403 (when (setq entry (assoc i tags-alist))
14404 (setq tags-alist (delete entry tags-alist)))
14406 ;; add the next tags
14408 (setq tags (org-split-string tags ":")
14410 (cons (cons level tags) tags-alist)))
14411 ;; compile tags for current headline
14413 (if org-use-tag-inheritance
14414 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14416 org-scanner-tags tags-list)
14417 (when org-use-tag-inheritance
14418 (setcdr (car tags-alist)
14419 (mapcar (lambda (x)
14420 (setq x (copy-sequence x))
14421 (org-add-prop-inherited x))
14422 (cdar tags-alist))))
14423 (when (and tags org-use-tag-inheritance
14424 (or (not (eq t org-use-tag-inheritance))
14425 org-tags-exclude-from-inheritance))
14426 ;; Selective inheritance, remove uninherited ones.
14427 (setcdr (car tags-alist)
14428 (org-remove-uninherited-tags (cdar tags-alist))))
14431 ;; eval matcher only when the todo condition is OK
14432 (and (or (not todo-only) (member todo org-not-done-keywords))
14433 (if (functionp matcher)
14434 (let ((case-fold-search t) (org-trust-scanner-tags t))
14435 (funcall matcher todo tags-list level))
14438 ;; Call the skipper, but return t if it does not
14439 ;; skip, so that the `and' form continues evaluating.
14441 (unless (eq action 'sparse-tree) (org-agenda-skip))
14444 ;; Check if timestamps are deselecting this entry
14445 (or (not todo-only)
14446 (and (member todo org-not-done-keywords)
14447 (or (not org-agenda-tags-todo-honor-ignore-options)
14448 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14450 ;; select this headline
14452 ((eq action 'sparse-tree)
14453 (and org-highlight-sparse-tree-matches
14454 (org-get-heading) (match-end 0)
14455 (org-highlight-new-match
14456 (match-beginning 1) (match-end 1)))
14457 (org-show-context 'tags-tree))
14458 ((eq action 'agenda)
14459 (setq txt (org-agenda-format-item
14462 (if (eq org-tags-match-list-sublevels 'indented)
14463 (make-string (1- level) ?.) "")
14465 (make-string level ?\s)
14468 priority (org-get-priority txt))
14470 (setq marker (org-agenda-new-marker))
14471 (org-add-props txt props
14472 'org-marker marker 'org-hd-marker marker 'org-category category
14476 'type (concat "tagsmatch" ts-date-type))
14478 ((functionp action)
14479 (setq org-map-continue-from nil)
14481 (setq rtn1 (funcall action))
14483 (t (user-error "Invalid action")))
14485 ;; if we are to skip sublevels, jump to end of subtree
14486 (unless org-tags-match-list-sublevels
14487 (org-end-of-subtree t)
14488 (backward-char 1))))
14489 ;; Get the correct position from where to continue
14490 (if org-map-continue-from
14491 (goto-char org-map-continue-from)
14492 (and (= (point) lspos) (end-of-line 1)))))
14493 (when (and (eq action 'sparse-tree)
14494 (not org-sparse-tree-open-archived-trees))
14495 (org-hide-archived-subtrees (point-min) (point-max)))
14498 (defun org-remove-uninherited-tags (tags)
14499 "Remove all tags that are not inherited from the list TAGS."
14501 ((eq org-use-tag-inheritance t)
14502 (if org-tags-exclude-from-inheritance
14503 (org-delete-all org-tags-exclude-from-inheritance tags)
14505 ((not org-use-tag-inheritance) nil)
14506 ((stringp org-use-tag-inheritance)
14509 (if (and (string-match org-use-tag-inheritance x)
14510 (not (member x org-tags-exclude-from-inheritance)))
14513 ((listp org-use-tag-inheritance)
14516 (if (member x org-use-tag-inheritance) x nil))
14519 (defun org-match-sparse-tree (&optional todo-only match)
14520 "Create a sparse tree according to tags string MATCH.
14522 MATCH is a string with match syntax. It can contain a selection
14523 of tags (\"+work+urgent-boss\"), properties (\"LEVEL>3\"), and
14524 TODO keywords (\"TODO=\\\"WAITING\\\"\") or a combination of
14525 those. See the manual for details.
14527 If optional argument TODO-ONLY is non-nil, only select lines that
14528 are also TODO tasks."
14530 (org-agenda-prepare-buffers (list (current-buffer)))
14531 (let ((org--matcher-tags-todo-only todo-only))
14532 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match))
14533 org--matcher-tags-todo-only)))
14535 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14537 (defvar org-cached-props nil)
14538 (defun org-cached-entry-get (pom property)
14539 (if (or (eq t org-use-property-inheritance)
14540 (and (stringp org-use-property-inheritance)
14541 (let ((case-fold-search t))
14542 (string-match-p org-use-property-inheritance property)))
14543 (and (listp org-use-property-inheritance)
14544 (member-ignore-case property org-use-property-inheritance)))
14545 ;; Caching is not possible, check it directly.
14546 (org-entry-get pom property 'inherit)
14547 ;; Get all properties, so we can do complicated checks easily.
14548 (cdr (assoc-string property
14549 (or org-cached-props
14550 (setq org-cached-props (org-entry-properties pom)))
14553 (defun org-global-tags-completion-table (&optional files)
14554 "Return the list of all tags in all agenda buffer/files.
14555 Optional FILES argument is a list of files which can be used
14556 instead of the agenda files."
14563 (set-buffer (find-file-noselect file))
14564 (mapcar (lambda (x)
14565 (and (stringp (car-safe x))
14566 (list (car-safe x))))
14567 (or org-current-tag-alist (org-get-buffer-tags))))
14568 (if (car-safe files) files
14569 (org-agenda-files))))))))
14571 (defun org-make-tags-matcher (match)
14572 "Create the TAGS/TODO matcher form for the selection string MATCH.
14574 Returns a cons of the selection string MATCH and a function
14575 implementing the matcher.
14577 The matcher is to be called at an Org entry, with point on the
14578 headline, and returns non-nil if the entry matches the selection
14579 string MATCH. It must be called with three arguments: the TODO
14580 keyword at the entry (or nil if none), the list of all tags at
14581 the entry including inherited ones and the reduced level of the
14582 headline. Additionally, the category of the entry, if any, must
14583 be specified as the text property `org-category' on the headline.
14585 This function sets the variable `org--matcher-tags-todo-only' to
14586 a non-nil value if the matcher restricts matching to TODO
14587 entries, otherwise it is not touched.
14589 See also `org-scan-tags'."
14591 ;; Get a new match request, with completion against the global
14592 ;; tags table and the local tags in current buffer.
14593 (let ((org-last-tags-completion-table
14595 (delq nil (append (org-get-buffer-tags)
14596 (org-global-tags-completion-table))))))
14600 'org-tags-completion-function nil nil nil 'org-tags-history))))
14602 (let ((match0 match)
14603 (re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)")
14605 tagsmatch todomatch tagsmatcher todomatcher)
14607 ;; Expand group tags.
14608 (setq match (org-tags-expand match))
14610 ;; Check if there is a TODO part of this match, which would be the
14611 ;; part after a "/". To make sure that this slash is not part of
14612 ;; a property value to be matched against, we also check that
14613 ;; there is no / after that slash. First, find the last slash.
14615 (while (string-match "/+" match s)
14616 (setq start (match-beginning 0))
14617 (setq s (match-end 0))))
14618 (if (and (string-match "/+" match start)
14619 (not (string-match-p "\"" match start)))
14620 ;; Match contains also a TODO-matching request.
14622 (setq tagsmatch (substring match 0 (match-beginning 0)))
14623 (setq todomatch (substring match (match-end 0)))
14624 (when (string-prefix-p "!" todomatch)
14625 (setq org--matcher-tags-todo-only t)
14626 (setq todomatch (substring todomatch 1)))
14627 (when (string-match "\\`\\s-*\\'" todomatch)
14628 (setq todomatch nil)))
14629 ;; Only matching tags.
14630 (setq tagsmatch match)
14631 (setq todomatch nil))
14633 ;; Make the tags matcher.
14634 (when (org-string-nw-p tagsmatch)
14636 (orterms (org-split-string tagsmatch "|"))
14638 (while (setq term (pop orterms))
14639 (while (and (equal (substring term -1) "\\") orterms)
14640 (setq term (concat term "|" (pop orterms)))) ;repair bad split.
14641 (while (string-match re term)
14642 (let* ((rest (substring term (match-end 0)))
14643 (minus (and (match-end 1)
14644 (equal (match-string 1 term) "-")))
14645 (tag (save-match-data
14646 (replace-regexp-in-string
14647 "\\\\-" "-" (match-string 2 term))))
14648 (regexp (eq (string-to-char tag) ?{))
14649 (levelp (match-end 4))
14650 (propp (match-end 5))
14653 (regexp `(org-match-any-p ,(substring tag 1 -1) tags-list))
14655 `(,(org-op-to-function (match-string 3 term))
14657 ,(string-to-number (match-string 4 term))))
14659 (let* ((gv (pcase (upcase (match-string 5 term))
14661 '(get-text-property (point) 'org-category))
14663 (p `(org-cached-entry-get nil ,p))))
14664 (pv (match-string 7 term))
14665 (regexp (eq (string-to-char pv) ?{))
14666 (strp (eq (string-to-char pv) ?\"))
14667 (timep (string-match-p "^\"[[<].*[]>]\"$" pv))
14668 (po (org-op-to-function (match-string 6 term)
14669 (if timep 'time strp))))
14670 (setq pv (if (or regexp strp) (substring pv 1 -1) pv))
14671 (when timep (setq pv (org-matcher-time pv)))
14672 (cond ((and regexp (eq po 'org<>))
14673 `(not (string-match ,pv (or ,gv ""))))
14674 (regexp `(string-match ,pv (or ,gv "")))
14675 (strp `(,po (or ,gv "") ,pv))
14678 (string-to-number (or ,gv ""))
14679 ,(string-to-number pv))))))
14680 (t `(member ,tag tags-list)))))
14681 (push (if minus `(not ,mm) mm) tagsmatcher)
14683 (push `(and ,@tagsmatcher) orlist)
14684 (setq tagsmatcher nil))
14685 (setq tagsmatcher `(progn (setq org-cached-props nil) (or ,@orlist)))))
14687 ;; Make the TODO matcher.
14688 (when (org-string-nw-p todomatch)
14689 (let ((orlist nil))
14690 (dolist (term (org-split-string todomatch "|"))
14691 (while (string-match re term)
14692 (let* ((minus (and (match-end 1)
14693 (equal (match-string 1 term) "-")))
14694 (kwd (match-string 2 term))
14695 (regexp (eq (string-to-char kwd) ?{))
14696 (mm (if regexp `(string-match ,(substring kwd 1 -1) todo)
14697 `(equal todo ,kwd))))
14698 (push (if minus `(not ,mm) mm) todomatcher))
14699 (setq term (substring term (match-end 0))))
14700 (push (if (> (length todomatcher) 1)
14701 (cons 'and todomatcher)
14704 (setq todomatcher nil))
14705 (setq todomatcher (cons 'or orlist))))
14707 ;; Return the string and function of the matcher. If no
14708 ;; tags-specific or todo-specific matcher exists, match
14710 (let ((matcher (if (and tagsmatcher todomatcher)
14711 `(and ,tagsmatcher ,todomatcher)
14712 (or tagsmatcher todomatcher t))))
14713 (when org--matcher-tags-todo-only
14714 (setq matcher `(and (member todo org-not-done-keywords) ,matcher)))
14715 (cons match0 `(lambda (todo tags-list level) ,matcher)))))
14717 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14718 "Expand group tags in MATCH.
14720 This replaces every group tag in MATCH with a regexp tag search.
14721 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14722 will be replaced like this:
14724 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14725 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14726 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14728 Replacing by a regexp preserves the structure of the match.
14729 E.g., this expansion
14731 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14733 will match anything tagged with \"Lab\" and \"Home\", or tagged
14734 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14736 A group tag in MATCH can contain regular expressions of its own.
14737 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14738 will be replaced like this:
14740 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14742 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14743 assumed to be a single group tag, and the function will return
14744 the list of tags in this group.
14746 When DOWNCASE is non-nil, expand downcased TAGS."
14748 (let* ((case-fold-search t)
14749 (stable org-mode-syntax-table)
14750 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14751 (taggroups (if downcased
14752 (mapcar (lambda (tg) (mapcar #'downcase tg))
14755 (taggroups-keys (mapcar #'car taggroups))
14756 (return-match (if downcased (downcase match) match))
14758 (work-already-expanded tags-already-expanded)
14759 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14760 ;; @ and _ are allowed as word-components in tags.
14761 (modify-syntax-entry ?@ "w" stable)
14762 (modify-syntax-entry ?_ "w" stable)
14763 ;; Temporarily replace regexp-expressions in the match-expression.
14764 (while (string-match "{.+?}" return-match)
14766 (push (match-string 0 return-match) regexps-in-match)
14767 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14768 (while (and taggroups-keys
14769 (with-syntax-table stable
14771 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14772 (regexp-opt taggroups-keys) "\\>\\)")
14774 (let* ((dir (match-string 1 return-match))
14775 (tag (match-string 2 return-match))
14776 (tag (if downcased (downcase tag) tag)))
14777 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14778 (member tag work-already-expanded))
14779 (setq tags-in-group (assoc tag taggroups))
14780 (push tag work-already-expanded)
14781 ;; Recursively expand each tag in the group, if the tag hasn't
14782 ;; already been expanded. Restore the match-data after all recursive calls.
14784 (let (tags-expanded)
14785 (dolist (x (cdr tags-in-group))
14786 (if (and (member x taggroups-keys)
14787 (not (member x work-already-expanded)))
14788 (setq tags-expanded
14791 (org-tags-expand x t downcased
14792 work-already-expanded)
14794 (setq tags-expanded
14795 (append (list x) tags-expanded)))
14796 (setq work-already-expanded
14798 (append tags-expanded
14799 work-already-expanded))))
14800 (setq tags-in-group
14801 (delete-dups (cons (car tags-in-group)
14803 ;; Filter tag-regexps from tags.
14804 (setq regexp-in-group-escaped
14805 (delq nil (mapcar (lambda (x)
14807 (and (equal "{" (substring x 0 1))
14808 (equal "}" (substring x -1))
14813 (mapcar (lambda (x)
14814 (substring x 1 -1))
14815 regexp-in-group-escaped)
14817 (delq nil (mapcar (lambda (x)
14819 (and (not (equal "{" (substring x 0 1)))
14820 (not (equal "}" (substring x -1)))
14824 ;; If single-as-list, do no more in the while-loop.
14825 (if (not single-as-list)
14827 (when regexp-in-group
14828 (setq regexp-in-group
14830 (mapconcat 'identity regexp-in-group
14832 (setq tags-in-group
14835 (regexp-opt tags-in-group)
14839 (when (stringp tags-in-group)
14840 (org-add-props tags-in-group '(grouptag t)))
14842 (replace-match tags-in-group t t return-match)))
14843 (setq tags-in-group
14844 (append regexp-in-group-escaped tags-in-group))))
14845 (setq taggroups-keys (delete tag taggroups-keys))))
14846 ;; Add the regular expressions back into the match-expression again.
14847 (while regexps-in-match
14848 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14849 (pop regexps-in-match)
14853 (if tags-in-group tags-in-group (list return-match))
14856 (list (if downcased (downcase match) match))
14859 (defun org-op-to-function (op &optional stringp)
14860 "Turn an operator into the appropriate function."
14863 ((equal op "<" ) '(< string< org-time<))
14864 ((equal op ">" ) '(> org-string> org-time>))
14865 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14866 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14867 ((member op '("=" "==")) '(= string= org-time=))
14868 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14869 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14871 (defun org<> (a b) (not (= a b)))
14872 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14873 (defun org-string>= (a b) (not (string< a b)))
14874 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14875 (defun org-string<> (a b) (not (string= a b)))
14876 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14877 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14878 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14879 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14880 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14881 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14883 "Convert S to a floating point time.
14884 If S is already a number, just return it. If it is a string, parse
14885 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14889 (condition-case nil
14890 (float-time (apply 'encode-time (org-parse-time-string s)))
14894 (defun org-time-today ()
14895 "Time in seconds today at 0:00.
14896 Returns the float number of seconds since the beginning of the
14897 epoch to the beginning of today (00:00)."
14898 (float-time (apply 'encode-time
14899 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14901 (defun org-matcher-time (s)
14902 "Interpret a time comparison value."
14905 ((string= s "<now>") (float-time))
14906 ((string= s "<today>") (org-time-today))
14907 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14908 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14909 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14910 (+ (org-time-today)
14911 (* (string-to-number (match-string 1 s))
14912 (cdr (assoc (match-string 2 s)
14913 '(("d" . 86400.0) ("w" . 604800.0)
14914 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14917 (defun org-match-any-p (re list)
14918 "Does re match any element of list?"
14919 (setq list (mapcar (lambda (x) (string-match re x)) list))
14922 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14923 (defvar org-tags-overlay (make-overlay 1 1))
14924 (delete-overlay org-tags-overlay)
14926 (defun org-get-local-tags-at (&optional pos)
14927 "Get a list of tags defined in the current headline."
14928 (org-get-tags-at pos 'local))
14930 (defun org-get-local-tags ()
14931 "Get a list of tags defined in the current headline."
14932 (org-get-tags-at nil 'local))
14934 (defun org-get-tags-at (&optional pos local)
14935 "Get a list of all headline tags applicable at POS.
14936 POS defaults to point. If tags are inherited, the list contains
14937 the targets in the same sequence as the headlines appear, i.e.
14938 the tags of the current headline come last.
14939 When LOCAL is non-nil, only return tags from the current headline,
14940 ignore inherited ones."
14942 (if (and org-trust-scanner-tags
14943 (or (not pos) (equal pos (point)))
14946 (let (tags ltags lastpos parent)
14950 (goto-char (or pos (point)))
14953 (condition-case nil
14955 (org-back-to-heading t)
14956 (while (not (equal lastpos (point)))
14957 (setq lastpos (point))
14958 (when (looking-at ".+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14959 (setq ltags (org-split-string
14960 (match-string-no-properties 1) ":"))
14962 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14965 (org-remove-uninherited-tags ltags)
14968 (or org-use-tag-inheritance (throw 'done t))
14969 (when local (throw 'done t))
14970 (or (org-up-heading-safe) (error nil))
14975 (reverse (delete-dups
14977 (org-remove-uninherited-tags
14981 (defun org-add-prop-inherited (s)
14982 (add-text-properties 0 (length s) '(inherited t) s)
14985 (defun org-toggle-tag (tag &optional onoff)
14986 "Toggle the tag TAG for the current line.
14987 If ONOFF is `on' or `off', don't toggle but set to this state."
14990 (org-back-to-heading t)
14991 (if (re-search-forward "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$"
14994 (setq current (match-string 1))
14995 (replace-match ""))
14997 (setq current (nreverse (org-split-string current ":")))
15001 (or (member tag current) (push tag current)))
15003 (or (not (member tag current)) (setq current (delete tag current))))
15004 (t (if (member tag current)
15005 (setq current (delete tag current))
15007 (push tag current))))
15011 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
15012 (org-set-tags nil t))
15013 (delete-horizontal-space))
15014 (run-hooks 'org-after-tags-change-hook))
15017 (defun org--align-tags-here (to-col)
15018 "Align tags on the current headline to TO-COL.
15019 Assume point is on a headline."
15020 (let ((pos (point)))
15021 (beginning-of-line)
15022 (if (or (not (looking-at ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15023 (>= pos (match-beginning 2)))
15024 ;; No tags or point within tags: do not align.
15026 (goto-char (match-beginning 1))
15027 (let ((shift (max (- (if (>= to-col 0) to-col
15028 (- (abs to-col) (string-width (match-string 2))))
15031 (replace-match (make-string shift ?\s) nil nil nil 1)
15032 ;; Preserve initial position, if possible. In any case, stop
15034 (when (< pos (point)) (goto-char pos))))))
15036 (defun org-set-tags-command (&optional arg just-align)
15037 "Call the set-tags command for the current entry."
15039 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
15040 (org-set-tags arg just-align)
15042 (unless (and (org-region-active-p)
15043 org-loop-over-headlines-in-active-region)
15044 (org-back-to-heading t))
15045 (org-set-tags arg just-align))))
15047 (defun org-set-tags-to (data)
15048 "Set the tags of the current entry to DATA, replacing the current tags.
15049 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
15050 If DATA is nil or the empty string, any tags will be removed."
15051 (interactive "sTags: ")
15055 ((equal data "") "")
15057 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
15060 (concat ":" (mapconcat 'identity data ":") ":"))))
15063 (org-back-to-heading t)
15064 (when (let ((case-fold-search nil))
15065 (looking-at org-complex-heading-regexp))
15068 (goto-char (match-beginning 5))
15070 (delete-region (point) (point-at-eol))
15071 (org-set-tags nil 'align))
15072 (goto-char (point-at-eol))
15074 (org-set-tags nil 'align)))
15075 (beginning-of-line 1)
15076 (when (looking-at ".*?\\([ \t]+\\)$")
15077 (delete-region (match-beginning 1) (match-end 1))))))
15079 (defun org-align-all-tags ()
15080 "Align the tags in all headings."
15083 (or (ignore-errors (org-back-to-heading t))
15084 (outline-next-heading))
15085 (if (org-at-heading-p)
15087 (message "No headings"))))
15089 (defvar org-indent-indentation-per-level)
15090 (defun org-set-tags (&optional arg just-align)
15091 "Set the tags for the current headline.
15092 With prefix ARG, realign all tags in headings in the current buffer.
15093 When JUST-ALIGN is non-nil, only align tags."
15095 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
15096 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
15097 'region-start-level
15099 org-loop-over-headlines-in-active-region)
15101 ;; We don't use ARG and JUST-ALIGN here because these args
15102 ;; are not useful when looping over headlines.
15104 org-loop-over-headlines-in-active-region
15106 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
15107 (let ((org-setting-tags t))
15110 (goto-char (point-min))
15111 (while (re-search-forward org-outline-regexp-bol nil t)
15112 (org-set-tags nil t)
15114 (message "All tags realigned to column %d" org-tags-column))
15115 (let* ((current (org-get-tags-string))
15117 (if just-align current
15118 ;; Get a new set of tags from the user.
15123 org-last-tags-completion-table
15124 ;; Uniquify tags in alists, yet preserve
15125 ;; structure (i.e., keywords).
15129 (let ((head (car pair)))
15130 (cond ((symbolp head) pair)
15131 ((member head seen) nil)
15132 (t (push head seen)
15135 (or org-current-tag-alist
15136 (org-get-buffer-tags))
15138 org-complete-tags-always-offer-all-agenda-tags
15139 (org-global-tags-completion-table
15140 (org-agenda-files))))))))
15141 (current-tags (org-split-string current ":"))
15143 (nreverse (nthcdr (length current-tags)
15144 (nreverse (org-get-tags-at))))))
15145 (replace-regexp-in-string
15148 (if (or (eq t org-use-fast-tag-selection)
15149 (and org-use-fast-tag-selection
15150 (delq nil (mapcar #'cdr table))))
15151 (org-fast-tag-selection
15152 current-tags inherited-tags table
15153 (and org-fast-tag-selection-include-todo
15154 org-todo-key-alist))
15155 (let ((org-add-colon-after-tag-completion
15156 (< 1 (length table))))
15160 #'org-tags-completion-function
15161 nil nil current 'org-tags-history))))))))))
15163 (when org-tags-sort-function
15167 (sort (org-split-string tags "[^[:alnum:]_@#%]+")
15168 org-tags-sort-function)
15171 (if (or (string= ":" tags)
15172 (string= "::" tags))
15174 (if (not (org-string-nw-p tags)) (setq tags "")
15175 (unless (string-suffix-p ":" tags) (setq tags (concat tags ":")))
15176 (unless (string-prefix-p ":" tags) (setq tags (concat ":" tags))))
15178 ;; Insert new tags at the correct column.
15179 (unless (equal current tags)
15181 (beginning-of-line)
15182 (let ((case-fold-search nil))
15183 (looking-at org-complex-heading-regexp))
15184 ;; Remove current tags, if any.
15185 (when (match-end 5) (replace-match "" nil nil nil 5))
15186 ;; Insert new tags, if any. Otherwise, remove trailing
15189 (if (not (equal tags ""))
15190 ;; When text is being inserted on an invisible
15191 ;; region boundary, it can be inadvertently sucked
15192 ;; into invisibility.
15193 (outline-flag-region (point) (progn (insert " " tags) (point)) nil)
15194 (skip-chars-backward " \t")
15195 (delete-region (point) (line-end-position)))))
15196 ;; Align tags, if any. Fix tags column if `org-indent-mode'
15198 (unless (equal tags "")
15199 (let* ((level (save-excursion
15200 (beginning-of-line)
15201 (skip-chars-forward "\\*")))
15202 (offset (if (bound-and-true-p org-indent-mode)
15203 (* (1- org-indent-indentation-per-level)
15208 (if (> org-tags-column 0) (- offset) offset))))
15209 (org--align-tags-here tags-column))))
15210 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15212 (defun org-change-tag-in-region (beg end tag off)
15213 "Add or remove TAG for each entry in the region.
15214 This works in the agenda, and also in an Org buffer."
15216 (list (region-beginning) (region-end)
15217 (let ((org-last-tags-completion-table
15218 (if (derived-mode-p 'org-mode)
15220 (delq nil (append (org-get-buffer-tags)
15221 (org-global-tags-completion-table))))
15222 (org-global-tags-completion-table))))
15224 "Tag: " 'org-tags-completion-function nil nil nil
15225 'org-tags-history))
15227 (message "[s]et or
[r]emove? ")
15228 (equal (read-char-exclusive) ?r))))
15229 (when (fboundp 'deactivate-mark) (deactivate-mark))
15230 (let ((agendap (equal major-mode 'org-agenda-mode))
15231 l1 l2 m buf pos newhead (cnt 0))
15233 (setq l2 (1- (org-current-line)))
15235 (setq l1 (org-current-line))
15236 (cl-loop for l from l1 to l2 do
15238 (setq m (get-text-property (point) 'org-hd-marker))
15239 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15241 (setq buf (if agendap (marker-buffer m) (current-buffer))
15242 pos (if agendap m (point)))
15243 (with-current-buffer buf
15247 (setq cnt (1+ cnt))
15248 (org-toggle-tag tag (if off 'off 'on))
15249 (setq newhead (org-get-heading)))))
15250 (and agendap (org-agenda-change-all-lines newhead m))))
15251 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15253 (defun org-tags-completion-function (string _predicate &optional flag)
15254 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15255 (confirm (lambda (x) (stringp (car x)))))
15256 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15257 (setq s1 (match-string 1 string)
15258 s2 (match-string 2 string))
15259 (setq s1 "" s2 string))
15263 (setq rtn (try-completion s2 ctable confirm))
15264 (when (stringp rtn)
15266 (concat s1 s2 (substring rtn (length s2))
15267 (if (and org-add-colon-after-tag-completion
15268 (assoc rtn ctable))
15273 (all-completions s2 ctable confirm))
15276 (assoc s2 ctable)))))
15278 (defun org-fast-tag-insert (kwd tags face &optional end)
15279 "Insert KDW, and the TAGS, the latter with face FACE.
15281 (insert (format "%-12s" (concat kwd ":"))
15282 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15285 (defun org-fast-tag-show-exit (flag)
15288 (when (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15289 (replace-match ""))
15292 (org-move-to-column (- (window-width) 19) t)
15293 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15295 (defun org-set-current-tags-overlay (current prefix)
15296 "Add an overlay to CURRENT tag with PREFIX."
15297 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15298 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15299 (org-overlay-display org-tags-overlay (concat prefix s))))
15301 (defvar org-last-tag-selection-key nil)
15302 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15303 "Fast tag selection with single keys.
15304 CURRENT is the current list of tags in the headline, INHERITED is the
15305 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15306 possibly with grouping information. TODO-TABLE is a similar table with
15307 TODO keywords, should these have keys assigned to them.
15308 If the keys are nil, a-z are automatically assigned.
15309 Returns the new tags string, or nil to not change the current settings."
15310 (let* ((fulltable (append table todo-table))
15311 (maxlen (apply 'max (mapcar
15313 (if (stringp (car x)) (string-width (car x)) 0))
15315 (buf (current-buffer))
15316 (expert (eq org-fast-tag-selection-single-key 'expert))
15318 (fwidth (+ maxlen 3 1 3))
15319 (ncol (/ (- (window-width) 4) fwidth))
15322 tg cnt e c char c1 c2 ntable tbl rtn
15323 ov-start ov-end ov-prefix
15324 (exit-after-next org-fast-tag-selection-single-key)
15325 (done-keywords org-done-keywords)
15326 groups ingroup intaggroup)
15328 (beginning-of-line 1)
15329 (if (looking-at ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
15330 (setq ov-start (match-beginning 1)
15331 ov-end (match-end 1)
15333 (setq ov-start (1- (point-at-eol))
15334 ov-end (1+ ov-start))
15335 (skip-chars-forward "^\n\r")
15338 (buffer-substring (1- (point)) (point))
15339 (if (> (current-column) org-tags-column)
15341 (make-string (- org-tags-column (current-column)) ?\ ))))))
15342 (move-overlay org-tags-overlay ov-start ov-end)
15343 (save-window-excursion
15345 (set-buffer (get-buffer-create " *Org tags*"))
15346 (delete-other-windows)
15347 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15348 (org-switch-to-buffer-other-window " *Org tags*"))
15350 (setq-local org-done-keywords done-keywords)
15351 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15352 (org-fast-tag-insert "Current" current c-face "\n\n")
15353 (org-fast-tag-show-exit exit-after-next)
15354 (org-set-current-tags-overlay current ov-prefix)
15355 (setq tbl fulltable char ?a cnt 0)
15356 (while (setq e (pop tbl))
15358 ((eq (car e) :startgroup)
15359 (push '() groups) (setq ingroup t)
15360 (unless (zerop cnt)
15363 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15364 ((eq (car e) :endgroup)
15365 (setq ingroup nil cnt 0)
15366 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15367 ((eq (car e) :startgrouptag)
15368 (setq intaggroup t)
15369 (unless (zerop cnt)
15373 ((eq (car e) :endgrouptag)
15374 (setq intaggroup nil cnt 0)
15376 ((equal e '(:newline))
15377 (unless (zerop cnt)
15381 (while (equal (car tbl) '(:newline))
15383 (setq tbl (cdr tbl)))))
15384 ((equal e '(:grouptags)) (insert " : "))
15386 (setq tg (copy-sequence (car e)) c2 nil)
15389 ;; automatically assign a character.
15390 (setq c1 (string-to-char
15391 (downcase (substring
15392 tg (if (= (string-to-char tg) ?@) 1 0)))))
15393 (if (or (rassoc c1 ntable) (rassoc c1 table))
15394 (while (or (rassoc char ntable) (rassoc char table))
15395 (setq char (1+ char)))
15397 (setq c (or c2 char)))
15398 (when ingroup (push tg (car groups)))
15399 (setq tg (org-add-props tg nil 'face
15401 ((not (assoc tg table))
15402 (org-get-todo-face tg))
15403 ((member tg current) c-face)
15404 ((member tg inherited) i-face))))
15405 (when (equal (caar tbl) :grouptags)
15406 (org-add-props tg nil 'face 'org-tag-group))
15407 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15408 (insert "[" c "] " tg (make-string
15409 (- fwidth 4 (length tg)) ?\ ))
15410 (push (cons tg c) ntable)
15411 (when (= (cl-incf cnt) ncol)
15413 (when (or ingroup intaggroup) (insert " "))
15415 (setq ntable (nreverse ntable))
15417 (goto-char (point-min))
15418 (unless expert (org-fit-window-to-buffer))
15422 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15423 (if (not groups) "no " "")
15424 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15425 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15426 (setq org-last-tag-selection-key c)
15428 ((= c ?\r) (throw 'exit t))
15430 (setq groups (not groups))
15431 (goto-char (point-min))
15432 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15435 (org-fast-tag-show-exit
15436 (setq exit-after-next (not exit-after-next)))
15438 (delete-other-windows)
15439 (set-window-buffer (split-window-vertically) " *Org tags*")
15440 (org-switch-to-buffer-other-window " *Org tags*")
15441 (org-fit-window-to-buffer)))
15443 (and (= c ?q) (not (rassoc c ntable))))
15444 (delete-overlay org-tags-overlay)
15445 (setq quit-flag t))
15448 (when exit-after-next (setq exit-after-next 'now)))
15450 (condition-case nil
15451 (setq tg (completing-read
15454 (with-current-buffer buf
15456 (org-get-buffer-tags))))))
15457 (quit (setq tg "")))
15458 (when (string-match "\\S-" tg)
15459 (cl-pushnew (list tg) buffer-tags :test #'equal)
15460 (if (member tg current)
15461 (setq current (delete tg current))
15462 (push tg current)))
15463 (when exit-after-next (setq exit-after-next 'now)))
15464 ((setq e (rassoc c todo-table) tg (car e))
15465 (with-current-buffer buf
15466 (save-excursion (org-todo tg)))
15467 (when exit-after-next (setq exit-after-next 'now)))
15468 ((setq e (rassoc c ntable) tg (car e))
15469 (if (member tg current)
15470 (setq current (delete tg current))
15471 (cl-loop for g in groups do
15472 (when (member tg g)
15473 (dolist (x g) (setq current (delete x current)))))
15475 (when exit-after-next (setq exit-after-next 'now))))
15477 ;; Create a sorted list
15481 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15482 (when (eq exit-after-next 'now) (throw 'exit t))
15483 (goto-char (point-min))
15484 (beginning-of-line 2)
15485 (delete-region (point) (point-at-eol))
15486 (org-fast-tag-insert "Current" current c-face)
15487 (org-set-current-tags-overlay current ov-prefix)
15488 (while (re-search-forward "\\[.\\] \\([[:alnum:]_@#%]+\\)" nil t)
15489 (setq tg (match-string 1))
15490 (add-text-properties
15491 (match-beginning 1) (match-end 1)
15494 ((member tg current) c-face)
15495 ((member tg inherited) i-face)
15496 (t (get-text-property (match-beginning 1) 'face))))))
15497 (goto-char (point-min)))))
15498 (delete-overlay org-tags-overlay)
15500 (mapconcat 'identity current ":")
15503 (defun org-get-tags-string ()
15504 "Get the TAGS string in the current headline."
15505 (unless (org-at-heading-p t)
15506 (user-error "Not on a heading"))
15508 (beginning-of-line 1)
15509 (if (looking-at ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
15510 (match-string-no-properties 1)
15513 (defun org-get-tags ()
15514 "Get the list of tags specified in the current headline."
15515 (org-split-string (org-get-tags-string) ":"))
15517 (defun org-get-buffer-tags ()
15518 "Get a table of all tags used in the buffer, for completion."
15519 (org-with-wide-buffer
15520 (goto-char (point-min))
15521 (let ((tag-re (concat org-outline-regexp-bol
15522 "\\(?:.*?[ \t]\\)?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
15524 (while (re-search-forward tag-re nil t)
15525 (dolist (tag (org-split-string (match-string-no-properties 1) ":"))
15527 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15529 ;;;; The mapping API
15531 (defvar org-agenda-skip-comment-trees)
15532 (defvar org-agenda-skip-function)
15533 (defun org-map-entries (func &optional match scope &rest skip)
15534 "Call FUNC at each headline selected by MATCH in SCOPE.
15536 FUNC is a function or a lisp form. The function will be called without
15537 arguments, with the cursor positioned at the beginning of the headline.
15538 The return values of all calls to the function will be collected and
15539 returned as a list.
15541 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15542 does not need to preserve point. After evaluation, the cursor will be
15543 moved to the end of the line (presumably of the headline of the
15544 processed entry) and search continues from there. Under some
15545 circumstances, this may not produce the wanted results. For example,
15546 if you have removed (e.g. archived) the current (sub)tree it could
15547 mean that the next entry will be skipped entirely. In such cases, you
15548 can specify the position from where search should continue by making
15549 FUNC set the variable `org-map-continue-from' to the desired buffer
15552 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15553 Only headlines that are matched by this query will be considered during
15554 the iteration. When MATCH is nil or t, all headlines will be
15555 visited by the iteration.
15557 SCOPE determines the scope of this command. It can be any of:
15559 nil The current buffer, respecting the restriction if any
15560 tree The subtree started with the entry at point
15561 region The entries within the active region, if any
15563 The entries within the active region, but only those at
15564 the same level than the first one.
15565 file The current buffer, without restriction
15567 The current buffer, and any archives associated with it
15568 agenda All agenda files
15569 agenda-with-archives
15570 All agenda files with any archive files associated with them
15572 If this is a list, all files in the list will be scanned
15574 The remaining args are treated as settings for the skipping facilities of
15575 the scanner. The following items can be given here:
15577 archive skip trees with the archive tag
15578 comment skip trees with the COMMENT keyword
15579 function or Emacs Lisp form:
15580 will be used as value for `org-agenda-skip-function', so
15581 whenever the function returns a position, FUNC will not be
15582 called for that entry and search will continue from the
15585 If your function needs to retrieve the tags including inherited tags
15586 at the *current* entry, you can use the value of the variable
15587 `org-scanner-tags' which will be much faster than getting the value
15588 with `org-get-tags-at'. If your function gets properties with
15589 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15590 to t around the call to `org-entry-properties' to get the same speedup.
15591 Note that if your function moves around to retrieve tags and properties at
15592 a *different* entry, you cannot use these techniques."
15593 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15594 (not (org-region-active-p)))
15595 (let* ((org-agenda-archives-mode nil) ; just to make sure
15596 (org-agenda-skip-archived-trees (memq 'archive skip))
15597 (org-agenda-skip-comment-trees (memq 'comment skip))
15598 (org-agenda-skip-function
15599 (car (org-delete-all '(comment archive) skip)))
15600 (org-tags-match-list-sublevels t)
15601 (start-level (eq scope 'region-start-level))
15603 org-todo-keywords-for-agenda
15604 org-done-keywords-for-agenda
15605 org-todo-keyword-alist-for-agenda
15606 org-tag-alist-for-agenda
15607 org--matcher-tags-todo-only)
15610 ((eq match t) (setq matcher t))
15611 ((eq match nil) (setq matcher t))
15612 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15616 (cond ((eq scope 'tree)
15617 (org-back-to-heading t)
15618 (org-narrow-to-subtree)
15620 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15621 (org-region-active-p))
15622 ;; If needed, set start-level to a string like "2"
15625 (goto-char (region-beginning))
15626 (unless (org-at-heading-p) (outline-next-heading))
15627 (setq start-level (org-current-level))))
15628 (narrow-to-region (region-beginning)
15630 (goto-char (region-end))
15631 (unless (and (bolp) (org-at-heading-p))
15632 (outline-next-heading))
15638 (org-agenda-prepare-buffers
15639 (and buffer-file-name (list buffer-file-name)))
15642 func matcher org--matcher-tags-todo-only start-level)))
15643 ;; Get the right scope
15645 ((and scope (listp scope) (symbolp (car scope)))
15646 (setq scope (eval scope)))
15647 ((eq scope 'agenda)
15648 (setq scope (org-agenda-files t)))
15649 ((eq scope 'agenda-with-archives)
15650 (setq scope (org-agenda-files t))
15651 (setq scope (org-add-archive-files scope)))
15653 (setq scope (and buffer-file-name (list buffer-file-name))))
15654 ((eq scope 'file-with-archives)
15655 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15656 (org-agenda-prepare-buffers scope)
15657 (dolist (file scope)
15658 (with-current-buffer (org-find-base-buffer-visiting file)
15659 (org-with-wide-buffer
15660 (goto-char (point-min))
15665 func matcher org--matcher-tags-todo-only)))))))))
15670 (defconst org-special-properties
15671 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15672 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15673 "The special properties valid in Org mode.
15674 These are properties that are not defined in the property drawer,
15675 but in some other way.")
15677 (defconst org-default-properties
15678 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15679 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15680 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15681 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15682 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15683 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15684 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15685 "Some properties that are used by Org mode for various purposes.
15686 Being in this list makes sure that they are offered for completion.")
15688 (defun org--valid-property-p (property)
15689 "Non nil when string PROPERTY is a valid property name."
15691 (or (equal property "")
15692 (string-match-p "\\s-" property))))
15694 (defun org--update-property-plist (key val props)
15695 "Associate KEY to VAL in alist PROPS.
15696 Modifications are made by side-effect. Return new alist."
15697 (let* ((appending (string= (substring key -1) "+"))
15698 (key (if appending (substring key 0 -1) key))
15699 (old (assoc-string key props t)))
15700 (if (not old) (cons (cons key val) props)
15701 (setcdr old (if appending (concat (cdr old) " " val) val))
15704 (defun org-get-property-block (&optional beg force)
15705 "Return the (beg . end) range of the body of the property drawer.
15706 BEG is the beginning of the current subtree, or of the part
15707 before the first headline. If it is not given, it will be found.
15708 If the drawer does not exist, create it if FORCE is non-nil, or
15710 (org-with-wide-buffer
15711 (when beg (goto-char beg))
15712 (unless (org-before-first-heading-p)
15713 (let ((beg (cond (beg)
15714 ((or (not (featurep 'org-inlinetask))
15715 (org-inlinetask-in-task-p))
15716 (org-back-to-heading t))
15717 (t (org-with-limited-levels (org-back-to-heading t))))))
15719 (when (looking-at-p org-planning-line-re) (forward-line))
15720 (cond ((looking-at org-property-drawer-re)
15722 (cons (point) (progn (goto-char (match-end 0))
15723 (line-beginning-position))))
15726 (org-insert-property-drawer)
15727 (let ((pos (save-excursion (search-forward ":END:")
15728 (line-beginning-position))))
15729 (cons pos pos))))))))
15731 (defun org-at-property-p ()
15732 "Non-nil when point is inside a property drawer.
15733 See `org-property-re' for match data, if applicable."
15735 (beginning-of-line)
15736 (and (looking-at org-property-re)
15737 (let ((property-drawer (save-match-data (org-get-property-block))))
15738 (and property-drawer
15739 (>= (point) (car property-drawer))
15740 (< (point) (cdr property-drawer)))))))
15742 (defun org-property-action ()
15743 "Do an action on properties."
15745 (unless (org-at-property-p) (user-error "Not at a property"))
15746 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15747 (let ((c (read-char-exclusive)))
15749 (?s (call-interactively #'org-set-property))
15750 (?d (call-interactively #'org-delete-property))
15751 (?D (call-interactively #'org-delete-property-globally))
15752 (?c (call-interactively #'org-compute-property-at-point))
15753 (otherwise (user-error "No such property action %c" c)))))
15755 (defun org-inc-effort ()
15756 "Increment the value of the effort property in the current entry."
15758 (org-set-effort nil t))
15760 (defvar org-clock-effort) ; Defined in org-clock.el.
15761 (defvar org-clock-current-task) ; Defined in org-clock.el.
15762 (defun org-set-effort (&optional value increment)
15763 "Set the effort property of the current entry.
15764 With numerical prefix arg, use the nth allowed value, 0 stands for the
15765 10th allowed value.
15767 When INCREMENT is non-nil, set the property to the next allowed value."
15769 (when (equal value 0) (setq value 10))
15770 (let* ((completion-ignore-case t)
15771 (prop org-effort-property)
15772 (cur (org-entry-get nil prop))
15773 (allowed (org-property-get-allowed-values nil prop 'table))
15774 (existing (mapcar 'list (org-property-values prop)))
15775 (heading (nth 4 (org-heading-components)))
15778 ((stringp value) value)
15779 ((and allowed (integerp value))
15780 (or (car (nth (1- value) allowed))
15781 (car (org-last allowed))))
15782 ((and allowed increment)
15783 (or (cl-caadr (member (list cur) allowed))
15784 (user-error "Allowed effort values are not set")))
15786 (message "Select 1-9,0, [RET%s]: %s"
15787 (if cur (concat "=" cur) "")
15788 (mapconcat 'car allowed " "))
15789 (setq rpl (read-char-exclusive))
15790 (if (equal rpl ?\r)
15792 (setq rpl (- rpl ?0))
15793 (when (equal rpl 0) (setq rpl 10))
15794 (if (and (> rpl 0) (<= rpl (length allowed)))
15795 (car (nth (1- rpl) allowed))
15796 (org-completing-read "Effort: " allowed nil))))
15798 (org-completing-read
15799 (concat "Effort" (and cur (string-match "\\S-" cur)
15800 (concat " [" cur "]"))
15802 existing nil nil "" nil cur)))))
15803 (unless (equal (org-entry-get nil prop) val)
15804 (org-entry-put nil prop val))
15805 (org-refresh-property
15806 '((effort . identity)
15807 (effort-minutes . org-duration-string-to-minutes))
15809 (when (equal heading (bound-and-true-p org-clock-current-task))
15810 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15811 (org-clock-update-mode-line))
15812 (message "%s is now %s" prop val)))
15814 (defun org-entry-properties (&optional pom which)
15815 "Get all properties of the current entry.
15817 When POM is a buffer position, get all properties from the entry
15820 This includes the TODO keyword, the tags, time strings for
15821 deadline, scheduled, and clocking, and any additional properties
15822 defined in the entry.
15824 If WHICH is nil or `all', get all properties. If WHICH is
15825 `special' or `standard', only get that subclass. If WHICH is
15826 a string, only get that property.
15828 Return value is an alist. Keys are properties, as upcased
15830 (org-with-point-at pom
15831 (when (and (derived-mode-p 'org-mode)
15832 (ignore-errors (org-back-to-heading t)))
15834 (let* ((beg (point))
15835 (specific (and (stringp which) (upcase which)))
15836 (which (cond ((not specific) which)
15837 ((member specific org-special-properties) 'special)
15840 ;; Get the special properties, like TODO and TAGS.
15841 (when (memq which '(nil all special))
15842 (when (or (not specific) (string= specific "CLOCKSUM"))
15843 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15845 (push (cons "CLOCKSUM"
15846 (org-minutes-to-clocksum-string clocksum))
15848 (when specific (throw 'exit props)))
15849 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15850 (let ((clocksumt (get-text-property (point)
15851 :org-clock-minutes-today)))
15853 (push (cons "CLOCKSUM_T"
15854 (org-minutes-to-clocksum-string clocksumt))
15856 (when specific (throw 'exit props)))
15857 (when (or (not specific) (string= specific "ITEM"))
15858 (let ((case-fold-search nil))
15859 (when (looking-at org-complex-heading-regexp)
15861 (let ((title (match-string-no-properties 4)))
15862 (if (org-string-nw-p title)
15863 (org-remove-tabs title)
15866 (when specific (throw 'exit props)))
15867 (when (or (not specific) (string= specific "TODO"))
15868 (let ((case-fold-search nil))
15869 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15870 (push (cons "TODO" (match-string-no-properties 2)) props)))
15871 (when specific (throw 'exit props)))
15872 (when (or (not specific) (string= specific "PRIORITY"))
15873 (push (cons "PRIORITY"
15874 (if (looking-at org-priority-regexp)
15875 (match-string-no-properties 2)
15876 (char-to-string org-default-priority)))
15878 (when specific (throw 'exit props)))
15879 (when (or (not specific) (string= specific "FILE"))
15880 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15882 (when specific (throw 'exit props)))
15883 (when (or (not specific) (string= specific "TAGS"))
15884 (let ((value (org-string-nw-p (org-get-tags-string))))
15885 (when value (push (cons "TAGS" value) props)))
15886 (when specific (throw 'exit props)))
15887 (when (or (not specific) (string= specific "ALLTAGS"))
15888 (let ((value (org-get-tags-at)))
15890 (push (cons "ALLTAGS"
15891 (format ":%s:" (mapconcat #'identity value ":")))
15893 (when specific (throw 'exit props)))
15894 (when (or (not specific) (string= specific "BLOCKED"))
15895 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15896 (when specific (throw 'exit props)))
15897 (when (or (not specific)
15898 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15900 (when (looking-at-p org-planning-line-re)
15902 (let ((bol (line-beginning-position))
15903 ;; Backward compatibility: time keywords used to
15904 ;; be configurable (before 8.3). Make sure we
15905 ;; get the correct keyword.
15906 (key-assoc `(("CLOSED" . ,org-closed-string)
15907 ("DEADLINE" . ,org-deadline-string)
15908 ("SCHEDULED" . ,org-scheduled-string))))
15909 (dolist (pair (if specific (list (assoc specific key-assoc))
15912 (when (search-backward (cdr pair) bol t)
15913 (goto-char (match-end 0))
15914 (skip-chars-forward " \t")
15915 (and (looking-at org-ts-regexp-both)
15916 (push (cons (car pair)
15917 (match-string-no-properties 0))
15919 (when specific (throw 'exit props)))
15920 (when (or (not specific)
15921 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15924 ;; Fix next time-stamp before END. TS is the
15925 ;; list of time-stamps found so far.
15928 ((string= specific "TIMESTAMP")
15930 ((string= specific "TIMESTAMP_IA")
15931 org-ts-regexp-inactive)
15932 ((assoc "TIMESTAMP_IA" ts)
15934 ((assoc "TIMESTAMP" ts)
15935 org-ts-regexp-inactive)
15936 (t org-ts-regexp-both))))
15938 (while (re-search-forward regexp end t)
15940 (let ((object (org-element-context)))
15941 ;; Accept to match timestamps in node
15942 ;; properties, too.
15943 (when (memq (org-element-type object)
15944 '(node-property timestamp))
15946 (org-element-property :type object)))
15948 ((and (memq type '(active active-range))
15949 (not (equal specific "TIMESTAMP_IA")))
15950 (unless (assoc "TIMESTAMP" ts)
15951 (push (cons "TIMESTAMP"
15952 (org-element-property
15953 :raw-value object))
15955 (when specific (throw 'exit ts))))
15956 ((and (memq type '(inactive inactive-range))
15957 (not (string= specific "TIMESTAMP")))
15958 (unless (assoc "TIMESTAMP_IA" ts)
15959 (push (cons "TIMESTAMP_IA"
15960 (org-element-property
15961 :raw-value object))
15963 (when specific (throw 'exit ts))))))
15964 ;; Both timestamp types are found,
15965 ;; move to next part.
15966 (when (= (length ts) 2) (throw 'next ts)))))
15969 ;; First look for timestamps within headline.
15970 (let ((ts (funcall find-ts (line-end-position) nil)))
15971 (if (= (length ts) 2) (setq props (nconc ts props))
15972 ;; Then find timestamps in the section, skipping
15974 (let ((end (save-excursion (outline-next-heading))))
15976 (when (looking-at-p org-planning-line-re) (forward-line))
15977 (setq props (nconc (funcall find-ts end ts) props))))))))
15978 ;; Get the standard properties, like :PROP:.
15979 (when (memq which '(nil all standard))
15980 ;; If we are looking after a specific property, delegate
15981 ;; to `org-entry-get', which is faster. However, make an
15982 ;; exception for "CATEGORY", since it can be also set
15983 ;; through keywords (i.e. #+CATEGORY).
15984 (if (and specific (not (equal specific "CATEGORY")))
15985 (let ((value (org-entry-get beg specific nil t)))
15986 (throw 'exit (and value (list (cons specific value)))))
15987 (let ((range (org-get-property-block beg)))
15989 (let ((end (cdr range)) seen-base)
15990 (goto-char (car range))
15991 ;; Unlike to `org--update-property-plist', we
15992 ;; handle the case where base values is found
15993 ;; after its extension. We also forbid standard
15994 ;; properties to be named as special properties.
15995 (while (re-search-forward org-property-re end t)
15996 (let* ((key (upcase (match-string-no-properties 2)))
15997 (extendp (string-match-p "\\+\\'" key))
15998 (key-base (if extendp (substring key 0 -1) key))
15999 (value (match-string-no-properties 3)))
16001 ((member-ignore-case key-base org-special-properties))
16004 (org--update-property-plist key value props)))
16005 ((member key seen-base))
16006 (t (push key seen-base)
16007 (let ((p (assoc-string key props t)))
16008 (if p (setcdr p (concat value " " (cdr p)))
16009 (push (cons key value) props))))))))))))
16010 (unless (assoc "CATEGORY" props)
16011 (push (cons "CATEGORY" (org-get-category beg)) props)
16012 (when (string= specific "CATEGORY") (throw 'exit props)))
16016 (defun org--property-local-values (property literal-nil)
16017 "Return value for PROPERTY in current entry.
16018 Value is a list whose car is the base value for PROPERTY and cdr
16019 a list of accumulated values. Return nil if neither is found in
16020 the entry. Also return nil when PROPERTY is set to \"nil\",
16021 unless LITERAL-NIL is non-nil."
16022 (let ((range (org-get-property-block)))
16024 (goto-char (car range))
16025 (let* ((case-fold-search t)
16030 (let ((v (and (re-search-forward
16031 (org-re-property property nil t) end t)
16032 (match-string-no-properties 3))))
16033 (list (if literal-nil v (org-not-nil v)))))))
16034 ;; Find additional values.
16035 (let* ((property+ (org-re-property (concat property "+") nil t)))
16036 (while (re-search-forward property+ end t)
16037 (push (match-string-no-properties 3) value)))
16038 ;; Return final values.
16039 (and (not (equal value '(nil))) (nreverse value))))))
16041 (defun org--property-global-value (property literal-nil)
16042 "Return value for PROPERTY in current buffer.
16043 Return value is a string. Return nil if property is not set
16044 globally. Also return nil when PROPERTY is set to \"nil\",
16045 unless LITERAL-NIL is non-nil."
16047 (cdr (or (assoc-string property org-file-properties t)
16048 (assoc-string property org-global-properties t)
16049 (assoc-string property org-global-properties-fixed t)))))
16050 (if literal-nil global (org-not-nil global))))
16052 (defun org-entry-get (pom property &optional inherit literal-nil)
16053 "Get value of PROPERTY for entry or content at point-or-marker POM.
16055 If INHERIT is non-nil and the entry does not have the property,
16056 then also check higher levels of the hierarchy. If INHERIT is
16057 the symbol `selective', use inheritance only if the setting in
16058 `org-use-property-inheritance' selects PROPERTY for inheritance.
16060 If the property is present but empty, the return value is the
16061 empty string. If the property is not present at all, nil is
16062 returned. In any other case, return the value as a string.
16063 Search is case-insensitive.
16065 If LITERAL-NIL is set, return the string value \"nil\" as
16066 a string, do not interpret it as the list atom nil. This is used
16067 for inheritance when a \"nil\" value can supersede a non-nil
16068 value higher up the hierarchy."
16069 (org-with-point-at pom
16071 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
16072 ;; We need a special property. Use `org-entry-properties' to
16073 ;; retrieve it, but specify the wanted property.
16074 (cdr (assoc-string property (org-entry-properties nil property))))
16076 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
16077 (org-entry-get-with-inheritance property literal-nil))
16079 (let* ((local (org--property-local-values property literal-nil))
16080 (value (and local (mapconcat #'identity (delq nil local) " "))))
16081 (if literal-nil value (org-not-nil value)))))))
16083 (defun org-property-or-variable-value (var &optional inherit)
16084 "Check if there is a property fixing the value of VAR.
16085 If yes, return this value. If not, return the current value of the variable."
16086 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
16087 (if (and prop (stringp prop) (string-match "\\S-" prop))
16089 (symbol-value var))))
16091 (defun org-entry-delete (pom property)
16092 "Delete PROPERTY from entry at point-or-marker POM.
16093 Accumulated properties, i.e. PROPERTY+, are also removed. Return
16094 non-nil when a property was removed."
16095 (org-with-point-at pom
16096 (pcase (org-get-property-block)
16097 (`(,begin . ,origin)
16098 (let* ((end (copy-marker origin))
16099 (re (org-re-property
16100 (concat (regexp-quote property) "\\+?") t t)))
16102 (while (re-search-forward re end t)
16103 (delete-region (match-beginning 0) (line-beginning-position 2)))
16104 ;; If drawer is empty, remove it altogether.
16105 (when (= begin end)
16106 (delete-region (line-beginning-position 0)
16107 (line-beginning-position 2)))
16108 ;; Return non-nil if some property was removed.
16109 (prog1 (/= end origin) (set-marker end nil))))
16112 ;; Multi-values properties are properties that contain multiple values
16113 ;; These values are assumed to be single words, separated by whitespace.
16114 (defun org-entry-add-to-multivalued-property (pom property value)
16115 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
16116 (let* ((old (org-entry-get pom property))
16117 (values (and old (org-split-string old "[ \t]"))))
16118 (setq value (org-entry-protect-space value))
16119 (unless (member value values)
16120 (setq values (append values (list value)))
16121 (org-entry-put pom property
16122 (mapconcat 'identity values " ")))))
16124 (defun org-entry-remove-from-multivalued-property (pom property value)
16125 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
16126 (let* ((old (org-entry-get pom property))
16127 (values (and old (org-split-string old "[ \t]"))))
16128 (setq value (org-entry-protect-space value))
16129 (when (member value values)
16130 (setq values (delete value values))
16131 (org-entry-put pom property
16132 (mapconcat 'identity values " ")))))
16134 (defun org-entry-member-in-multivalued-property (pom property value)
16135 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16136 (let* ((old (org-entry-get pom property))
16137 (values (and old (org-split-string old "[ \t]"))))
16138 (setq value (org-entry-protect-space value))
16139 (member value values)))
16141 (defun org-entry-get-multivalued-property (pom property)
16142 "Return a list of values in a multivalued property."
16143 (let* ((value (org-entry-get pom property))
16144 (values (and value (org-split-string value "[ \t]"))))
16145 (mapcar 'org-entry-restore-space values)))
16147 (defun org-entry-put-multivalued-property (pom property &rest values)
16148 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
16149 VALUES should be a list of strings. Spaces will be protected."
16150 (org-entry-put pom property
16151 (mapconcat 'org-entry-protect-space values " "))
16152 (let* ((value (org-entry-get pom property))
16153 (values (and value (org-split-string value "[ \t]"))))
16154 (mapcar 'org-entry-restore-space values)))
16156 (defun org-entry-protect-space (s)
16157 "Protect spaces and newline in string S."
16158 (while (string-match " " s)
16159 (setq s (replace-match "%20" t t s)))
16160 (while (string-match "\n" s)
16161 (setq s (replace-match "%0A" t t s)))
16164 (defun org-entry-restore-space (s)
16165 "Restore spaces and newline in string S."
16166 (while (string-match "%20" s)
16167 (setq s (replace-match " " t t s)))
16168 (while (string-match "%0A" s)
16169 (setq s (replace-match "\n" t t s)))
16172 (defvar org-entry-property-inherited-from (make-marker)
16173 "Marker pointing to the entry from where a property was inherited.
16174 Each call to `org-entry-get-with-inheritance' will set this marker to the
16175 location of the entry where the inheritance search matched. If there was
16176 no match, the marker will point nowhere.
16177 Note that also `org-entry-get' calls this function, if the INHERIT flag
16180 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16181 "Get PROPERTY of entry or content at point, search higher levels if needed.
16182 The search will stop at the first ancestor which has the property defined.
16183 If the value found is \"nil\", return nil to show that the property
16184 should be considered as undefined (this is the meaning of nil here).
16185 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16186 (move-marker org-entry-property-inherited-from nil)
16187 (org-with-wide-buffer
16191 (let ((v (org--property-local-values property literal-nil)))
16194 (concat (mapconcat #'identity (delq nil v) " ")
16199 (org-back-to-heading t)
16200 (move-marker org-entry-property-inherited-from (point))
16202 ((org-up-heading-safe))
16204 (let ((global (org--property-global-value property literal-nil)))
16205 (cond ((not global))
16206 (value (setq value (concat global " " value)))
16207 (t (setq value global))))
16208 (throw 'exit nil))))))
16209 (if literal-nil value (org-not-nil value)))))
16211 (defvar org-property-changed-functions nil
16212 "Hook called when the value of a property has changed.
16213 Each hook function should accept two arguments, the name of the property
16214 and the new value.")
16216 (defun org-entry-put (pom property value)
16217 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16219 If the value is nil, it is converted to the empty string. If it
16220 is not a string, an error is raised. Also raise an error on
16221 invalid property names.
16223 PROPERTY can be any regular property (see
16224 `org-special-properties'). It can also be \"TODO\",
16225 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16227 For the last two properties, VALUE may have any of the special
16228 values \"earlier\" and \"later\". The function then increases or
16229 decreases scheduled or deadline date by one day."
16230 (cond ((null value) (setq value ""))
16231 ((not (stringp value)) (error "Properties values should be strings"))
16232 ((not (org--valid-property-p property))
16233 (user-error "Invalid property name: \"%s\"" property)))
16234 (org-with-point-at pom
16235 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16236 (org-back-to-heading t)
16237 (org-with-limited-levels (org-back-to-heading t)))
16238 (let ((beg (point)))
16240 ((equal property "TODO")
16241 (cond ((not (org-string-nw-p value)) (setq value 'none))
16242 ((not (member value org-todo-keywords-1))
16243 (user-error "\"%s\" is not a valid TODO state" value)))
16245 (org-set-tags nil 'align))
16246 ((equal property "PRIORITY")
16247 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16248 (org-set-tags nil 'align))
16249 ((equal property "SCHEDULED")
16251 (if (and (looking-at-p org-planning-line-re)
16253 org-scheduled-time-regexp (line-end-position) t))
16254 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16255 ((string= value "later") (org-timestamp-change 1 'day))
16256 ((string= value "") (org-schedule '(4)))
16257 (t (org-schedule nil value)))
16258 (if (member value '("earlier" "later" ""))
16259 (call-interactively #'org-schedule)
16260 (org-schedule nil value))))
16261 ((equal property "DEADLINE")
16263 (if (and (looking-at-p org-planning-line-re)
16265 org-deadline-time-regexp (line-end-position) t))
16266 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16267 ((string= value "later") (org-timestamp-change 1 'day))
16268 ((string= value "") (org-deadline '(4)))
16269 (t (org-deadline nil value)))
16270 (if (member value '("earlier" "later" ""))
16271 (call-interactively #'org-deadline)
16272 (org-deadline nil value))))
16273 ((member property org-special-properties)
16274 (error "The %s property cannot be set with `org-entry-put'" property))
16276 (let* ((range (org-get-property-block beg 'force))
16278 (case-fold-search t))
16279 (goto-char (car range))
16280 (if (re-search-forward (org-re-property property nil t) end t)
16281 (progn (delete-region (match-beginning 0) (match-end 0))
16282 (goto-char (match-beginning 0)))
16286 (insert ":" property ":")
16287 (when value (insert " " value))
16288 (org-indent-line)))))
16289 (run-hook-with-args 'org-property-changed-functions property value)))
16291 (defun org-buffer-property-keys
16292 (&optional specials defaults columns ignore-malformed)
16293 "Get all property keys in the current buffer.
16295 When SPECIALS is non-nil, also list the special properties that
16296 reflect things like tags and TODO state.
16298 When DEFAULTS is non-nil, also include properties that has
16299 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16300 DESCRIPTION, LOCATION, and LOGGING and others.
16302 When COLUMNS in non-nil, also include property names given in
16303 COLUMN formats in the current buffer.
16305 When IGNORE-MALFORMED is non-nil, malformed drawer repair will not be
16306 automatically performed, such drawers will be silently ignored."
16307 (let ((case-fold-search t)
16309 (and specials org-special-properties)
16310 (and defaults (cons org-effort-property org-default-properties))
16312 (org-with-wide-buffer
16313 (goto-char (point-min))
16314 (while (re-search-forward org-property-start-re nil t)
16315 (let ((range (org-get-property-block)))
16318 (when (and (not ignore-malformed)
16319 (not (org-before-first-heading-p))
16320 (y-or-n-p (format "Malformed drawer at %d, repair?"
16321 (line-beginning-position))))
16322 (org-get-property-block nil t))
16324 (goto-char (car range))
16325 (let ((begin (car range))
16327 ;; Make sure that found property block is not located
16328 ;; before current point, as it would generate an infloop.
16329 ;; It can happen, for example, in the following
16336 ;; *************** Inlinetask
16341 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16342 (while (< (point) end)
16343 (let ((p (progn (looking-at org-property-re)
16344 (match-string-no-properties 2))))
16345 ;; Only add true property name, not extension symbol.
16346 (push (if (not (string-match-p "\\+\\'" p)) p
16347 (substring p 0 -1))
16350 (outline-next-heading)))
16352 (goto-char (point-min))
16353 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16354 (let ((element (org-element-at-point)))
16355 (when (memq (org-element-type element) '(keyword node-property))
16356 (let ((value (org-element-property :value element))
16358 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16359 (setq start (match-end 0))
16360 (let ((p (match-string-no-properties 1 value)))
16361 (unless (member-ignore-case p org-special-properties)
16362 (push p props))))))))))
16363 (sort (delete-dups props) (lambda (a b) (string< (upcase a) (upcase b))))))
16365 (defun org-property-values (key)
16366 "List all non-nil values of property KEY in current buffer."
16367 (org-with-wide-buffer
16368 (goto-char (point-min))
16369 (let ((case-fold-search t)
16370 (re (org-re-property key))
16372 (while (re-search-forward re nil t)
16373 (push (org-entry-get (point) key) values))
16374 (delete-dups values))))
16376 (defun org-insert-property-drawer ()
16377 "Insert a property drawer into the current entry."
16378 (org-with-wide-buffer
16379 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16380 (org-back-to-heading t)
16381 (org-with-limited-levels (org-back-to-heading t)))
16383 (when (looking-at-p org-planning-line-re) (forward-line))
16384 (unless (looking-at-p org-property-drawer-re)
16385 ;; Make sure we start editing a line from current entry, not from
16386 ;; next one. It prevents extending text properties or overlays
16387 ;; belonging to the latter.
16388 (when (bolp) (backward-char))
16389 (let ((begin (1+ (point)))
16390 (inhibit-read-only t))
16391 (insert "\n:PROPERTIES:\n:END:")
16392 (when (eobp) (insert "\n"))
16393 (org-indent-region begin (point))))))
16395 (defun org-insert-drawer (&optional arg drawer)
16396 "Insert a drawer at point.
16398 When optional argument ARG is non-nil, insert a property drawer.
16400 Optional argument DRAWER, when non-nil, is a string representing
16401 drawer's name. Otherwise, the user is prompted for a name.
16403 If a region is active, insert the drawer around that region
16406 Point is left between drawer's boundaries."
16408 (let* ((drawer (if arg "PROPERTIES"
16409 (or drawer (read-from-minibuffer "Drawer: ")))))
16411 ;; With C-u, fall back on `org-insert-property-drawer'
16412 (arg (org-insert-property-drawer))
16413 ;; Check validity of suggested drawer's name.
16414 ((not (string-match-p org-drawer-regexp (format ":%s:" drawer)))
16415 (user-error "Invalid drawer name"))
16416 ;; With an active region, insert a drawer at point.
16417 ((not (org-region-active-p))
16419 (unless (bolp) (insert "\n"))
16420 (insert (format ":%s:\n\n:END:\n" drawer))
16421 (forward-line -2)))
16422 ;; Otherwise, insert the drawer at point
16424 (let ((rbeg (region-beginning))
16425 (rend (copy-marker (region-end))))
16429 (beginning-of-line)
16430 (when (save-excursion
16431 (re-search-forward org-outline-regexp-bol rend t))
16432 (user-error "Drawers cannot contain headlines"))
16433 ;; Position point at the beginning of the first
16434 ;; non-blank line in region. Insert drawer's opening
16435 ;; there, then indent it.
16436 (org-skip-whitespace)
16437 (beginning-of-line)
16438 (insert ":" drawer ":\n")
16440 (indent-for-tab-command)
16441 ;; Move point to the beginning of the first blank line
16442 ;; after the last non-blank line in region. Insert
16443 ;; drawer's closing, then indent it.
16445 (skip-chars-backward " \r\t\n")
16447 (deactivate-mark t)
16448 (indent-for-tab-command)
16449 (unless (eolp) (insert "\n")))
16450 ;; Clear marker, whatever the outcome of insertion is.
16451 (set-marker rend nil)))))))
16453 (defvar org-property-set-functions-alist nil
16454 "Property set function alist.
16455 Each entry should have the following format:
16457 (PROPERTY . READ-FUNCTION)
16459 The read function will be called with the same argument as
16460 `org-completing-read'.")
16462 (defun org-set-property-function (property)
16463 "Get the function that should be used to set PROPERTY.
16464 This is computed according to `org-property-set-functions-alist'."
16465 (or (cdr (assoc property org-property-set-functions-alist))
16466 'org-completing-read))
16468 (defun org-read-property-value (property)
16469 "Read PROPERTY value from user."
16470 (let* ((completion-ignore-case t)
16471 (allowed (org-property-get-allowed-values nil property 'table))
16472 (cur (org-entry-get nil property))
16473 (prompt (concat property " value"
16474 (if (and cur (string-match "\\S-" cur))
16475 (concat " [" cur "]") "") ": "))
16476 (set-function (org-set-property-function property))
16478 (funcall set-function prompt allowed nil
16479 (not (get-text-property 0 'org-unrestricted
16481 (funcall set-function prompt
16482 (mapcar 'list (org-property-values property))
16483 nil nil "" nil cur))))
16486 (defvar org-last-set-property nil)
16487 (defvar org-last-set-property-value nil)
16488 (defun org-read-property-name ()
16489 "Read a property name."
16490 (let ((completion-ignore-case t)
16491 (default-prop (or (and (org-at-property-p)
16492 (match-string-no-properties 2))
16493 org-last-set-property)))
16494 (org-completing-read
16496 (if default-prop (concat " [" default-prop "]") "")
16498 (mapcar #'list (org-buffer-property-keys nil t t))
16499 nil nil nil nil default-prop)))
16501 (defun org-set-property-and-value (use-last)
16502 "Allow to set [PROPERTY]: [value] direction from prompt.
16503 When use-default, don't even ask, just use the last
16504 \"[PROPERTY]: [value]\" string from the history."
16506 (let* ((completion-ignore-case t)
16507 (pv (or (and use-last org-last-set-property-value)
16508 (org-completing-read
16509 "Enter a \"[Property]: [value]\" pair: "
16510 nil nil nil nil nil
16511 org-last-set-property-value)))
16513 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16514 (setq prop (match-string 1 pv)
16515 val (match-string 2 pv))
16516 (org-set-property prop val))))
16518 (defun org-set-property (property value)
16519 "In the current entry, set PROPERTY to VALUE.
16521 When called interactively, this will prompt for a property name, offering
16522 completion on existing and default properties. And then it will prompt
16523 for a value, offering completion either on allowed values (via an inherited
16524 xxx_ALL property) or on existing values in other instances of this property
16525 in the current file.
16527 Throw an error when trying to set a property with an invalid name."
16528 (interactive (list nil nil))
16529 (let ((property (or property (org-read-property-name))))
16530 ;; `org-entry-put' also makes the following check, but this one
16531 ;; avoids polluting `org-last-set-property' and
16532 ;; `org-last-set-property-value' needlessly.
16533 (unless (org--valid-property-p property)
16534 (user-error "Invalid property name: \"%s\"" property))
16535 (let ((value (or value (org-read-property-value property)))
16536 (fn (cdr (assoc-string property org-properties-postprocess-alist t))))
16537 (setq org-last-set-property property)
16538 (setq org-last-set-property-value (concat property ": " value))
16539 ;; Possibly postprocess the inserted value:
16540 (when fn (setq value (funcall fn value)))
16541 (unless (equal (org-entry-get nil property) value)
16542 (org-entry-put nil property value)))))
16544 (defun org-find-property (property &optional value)
16545 "Find first entry in buffer that sets PROPERTY.
16547 When optional argument VALUE is non-nil, only consider an entry
16548 if it contains PROPERTY set to this value. If PROPERTY should be
16549 explicitly set to nil, use string \"nil\" for VALUE.
16551 Return position where the entry begins, or nil if there is no
16552 such entry. If narrowing is in effect, only search the visible
16553 part of the buffer."
16555 (goto-char (point-min))
16556 (let ((case-fold-search t)
16557 (re (org-re-property property nil (not value) value)))
16559 (while (re-search-forward re nil t)
16560 (when (if value (org-at-property-p)
16561 (org-entry-get (point) property nil t))
16562 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16564 (defun org-delete-property (property)
16565 "In the current entry, delete PROPERTY."
16567 (let* ((completion-ignore-case t)
16568 (cat (org-entry-get (point) "CATEGORY"))
16569 (props0 (org-entry-properties nil 'standard))
16570 (props (if cat props0
16571 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16572 (prop (if (< 1 (length props))
16573 (completing-read "Property: " props nil t)
16577 (message "No property to delete in this entry")
16578 (org-entry-delete nil property)
16579 (message "Property \"%s\" deleted" property)))
16581 (defun org-delete-property-globally (property)
16582 "Remove PROPERTY globally, from all entries.
16583 This function ignores narrowing, if any."
16585 (let* ((completion-ignore-case t)
16586 (prop (completing-read
16587 "Globally remove property: "
16588 (mapcar #'list (org-buffer-property-keys)))))
16590 (org-with-wide-buffer
16591 (goto-char (point-min))
16593 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16594 (while (re-search-forward re nil t)
16595 (when (org-entry-delete (point) property) (cl-incf count)))
16596 (message "Property \"%s\" removed from %d entries" property count))))
16598 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16600 (defun org-compute-property-at-point ()
16601 "Compute the property at point.
16602 This looks for an enclosing column format, extracts the operator and
16603 then applies it to the property in the column format's scope."
16605 (unless (org-at-property-p)
16606 (user-error "Not at a property"))
16607 (let ((prop (match-string-no-properties 2)))
16608 (org-columns-get-format-and-top-level)
16609 (unless (nth 3 (assoc-string prop org-columns-current-fmt-compiled t))
16610 (user-error "No operator defined for property %s" prop))
16611 (org-columns-compute prop)))
16613 (defvar org-property-allowed-value-functions nil
16614 "Hook for functions supplying allowed values for a specific property.
16615 The functions must take a single argument, the name of the property, and
16616 return a flat list of allowed values. If \":ETC\" is one of
16617 the values, this means that these values are intended as defaults for
16618 completion, but that other values should be allowed too.
16619 The functions must return nil if they are not responsible for this
16622 (defun org-property-get-allowed-values (pom property &optional table)
16623 "Get allowed values for the property PROPERTY.
16624 When TABLE is non-nil, return an alist that can directly be used for
16628 ((equal property "TODO")
16629 (setq vals (org-with-point-at pom
16630 (append org-todo-keywords-1 '("")))))
16631 ((equal property "PRIORITY")
16632 (let ((n org-lowest-priority))
16633 (while (>= n org-highest-priority)
16634 (push (char-to-string n) vals)
16636 ((equal property "CATEGORY"))
16637 ((member property org-special-properties))
16638 ((setq vals (run-hook-with-args-until-success
16639 'org-property-allowed-value-functions property)))
16641 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16642 (when (and vals (string-match "\\S-" vals))
16643 (setq vals (car (read-from-string (concat "(" vals ")"))))
16644 (setq vals (mapcar (lambda (x)
16645 (cond ((stringp x) x)
16646 ((numberp x) (number-to-string x))
16647 ((symbolp x) (symbol-name x))
16650 (when (member ":ETC" vals)
16651 (setq vals (remove ":ETC" vals))
16652 (org-add-props (car vals) '(org-unrestricted t)))
16653 (if table (mapcar 'list vals) vals)))
16655 (defun org-property-previous-allowed-value (&optional _previous)
16656 "Switch to the next allowed value for this property."
16658 (org-property-next-allowed-value t))
16660 (defun org-property-next-allowed-value (&optional previous)
16661 "Switch to the next allowed value for this property."
16663 (unless (org-at-property-p)
16664 (user-error "Not at a property"))
16665 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16666 (key (match-string 2))
16667 (value (match-string 3))
16668 (allowed (or (org-property-get-allowed-values (point) key)
16669 (and (member value '("[ ]" "[-]" "[X]"))
16671 (heading (save-match-data (nth 4 (org-heading-components))))
16674 (user-error "Allowed values for this property have not been defined"))
16675 (when previous (setq allowed (reverse allowed)))
16676 (when (member value allowed)
16677 (setq nval (car (cdr (member value allowed)))))
16678 (setq nval (or nval (car allowed)))
16679 (when (equal nval value)
16680 (user-error "Only one allowed value for this property"))
16681 (org-at-property-p)
16682 (replace-match (concat " :" key ": " nval) t t)
16684 (beginning-of-line 1)
16685 (skip-chars-forward " \t")
16686 (when (equal prop org-effort-property)
16687 (org-refresh-property
16688 '((effort . identity)
16689 (effort-minutes . org-duration-string-to-minutes))
16691 (when (string= org-clock-current-task heading)
16692 (setq org-clock-effort nval)
16693 (org-clock-update-mode-line)))
16694 (run-hook-with-args 'org-property-changed-functions key nval)))
16696 (defun org-find-olp (path &optional this-buffer)
16697 "Return a marker pointing to the entry at outline path OLP.
16698 If anything goes wrong, throw an error.
16699 You can wrap this call to catch the error like this:
16701 (condition-case msg
16702 (org-mobile-locate-entry (match-string 4))
16703 (error (nth 1 msg)))
16705 The return value will then be either a string with the error message,
16706 or a marker if everything is OK.
16708 If THIS-BUFFER is set, the outline path does not contain a file,
16710 (let* ((file (if this-buffer buffer-file-name (pop path)))
16711 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16716 (unless buffer (error "File not found :%s" file))
16717 (with-current-buffer buffer
16718 (org-with-wide-buffer
16719 (goto-char (point-min))
16720 (dolist (heading path)
16721 (let ((re (format org-complex-heading-regexp-format
16722 (regexp-quote heading)))
16724 (while (re-search-forward re end t)
16725 (setq level (- (match-end 1) (match-beginning 1)))
16726 (when (and (>= level lmin) (<= level lmax))
16727 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16729 (error "Heading not found on level %d: %s" lmax heading))
16731 (error "Heading not unique on level %d: %s" lmax heading))
16733 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16734 (setq end (save-excursion (org-end-of-subtree t t)))))
16735 (when (org-at-heading-p)
16736 (point-marker))))))
16738 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16739 "Find node HEADING in BUFFER.
16740 Return a marker to the heading if it was found, or nil if not.
16741 If POS-ONLY is set, return just the position instead of a marker.
16743 The heading text must match exact, but it may have a TODO keyword,
16744 a priority cookie and tags in the standard locations."
16745 (with-current-buffer (or buffer (current-buffer))
16746 (org-with-wide-buffer
16747 (goto-char (point-min))
16748 (let (case-fold-search)
16749 (when (re-search-forward
16750 (format org-complex-heading-regexp-format
16751 (regexp-quote heading)) nil t)
16753 (match-beginning 0)
16754 (move-marker (make-marker) (match-beginning 0))))))))
16756 (defun org-find-exact-heading-in-directory (heading &optional dir)
16757 "Find Org node headline HEADING in all .org files in directory DIR.
16758 When the target headline is found, return a marker to this location."
16759 (let ((files (directory-files (or dir default-directory)
16760 t "\\`[^.#].*\\.org\\'"))
16763 (dolist (file files)
16764 (message "trying %s" file)
16765 (setq visiting (org-find-base-buffer-visiting file))
16766 (setq buffer (or visiting (find-file-noselect file)))
16767 (setq m (org-find-exact-headline-in-buffer
16769 (when (and (not m) (not visiting)) (kill-buffer buffer))
16770 (and m (throw 'found m))))))
16772 (defun org-find-entry-with-id (ident)
16773 "Locate the entry that contains the ID property with exact value IDENT.
16774 IDENT can be a string, a symbol or a number, this function will search for
16775 the string representation of it.
16776 Return the position where this entry starts, or nil if there is no such entry."
16777 (interactive "sID: ")
16779 ((stringp ident) ident)
16780 ((symbolp ident) (symbol-name ident))
16781 ((numberp ident) (number-to-string ident))
16782 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16783 (org-with-wide-buffer (org-find-property "ID" id))))
16787 (defvar org-last-changed-timestamp nil)
16788 (defvar org-last-inserted-timestamp nil
16789 "The last time stamp inserted with `org-insert-time-stamp'.")
16790 (defvar org-ts-what) ; dynamically scoped parameter
16792 (defun org-time-stamp (arg &optional inactive)
16793 "Prompt for a date/time and insert a time stamp.
16795 If the user specifies a time like HH:MM or if this command is
16796 called with at least one prefix argument, the time stamp contains
16797 the date and the time. Otherwise, only the date is included.
16799 All parts of a date not specified by the user are filled in from
16800 the timestamp at point, if any, or the current date/time
16803 If there is already a timestamp at the cursor, it is replaced.
16805 With two universal prefix arguments, insert an active timestamp
16806 with the current time without prompting the user.
16808 When called from lisp, the timestamp is inactive if INACTIVE is
16812 ((org-at-date-range-p t)
16813 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16814 ((org-at-timestamp-p t) (match-string 0))))
16815 ;; Default time is either the timestamp at point or today.
16816 ;; When entering a range, only the range start is considered.
16817 (default-time (if (not ts) (current-time)
16818 (apply #'encode-time (org-parse-time-string ts))))
16819 (default-input (and ts (org-get-compact-tod ts)))
16821 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16822 (match-string 0 ts)))
16824 org-end-time-was-given
16826 (and (if (equal arg '(16)) (current-time)
16827 ;; Preserve `this-command' and `last-command'.
16828 (let ((this-command this-command)
16829 (last-command last-command))
16831 arg 'totime nil nil default-time default-input
16835 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16836 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16838 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16840 ;; Make sure we're on a timestamp. When in the middle of a date
16841 ;; range, move arbitrarily to range end.
16842 (unless (org-at-timestamp-p t)
16843 (skip-chars-forward "-")
16844 (org-at-timestamp-p t))
16846 (setq org-last-changed-timestamp
16847 (org-insert-time-stamp
16848 time (or org-time-was-given arg)
16849 inactive nil nil (list org-end-time-was-given)))
16852 (insert " " repeater)
16853 (setq org-last-changed-timestamp
16854 (concat (substring org-last-inserted-timestamp 0 -1)
16855 " " repeater ">")))
16856 (message "Timestamp updated"))
16857 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16858 (t (org-insert-time-stamp
16859 time (or org-time-was-given arg) inactive nil nil
16860 (list org-end-time-was-given))))))
16862 ;; FIXME: can we use this for something else, like computing time differences?
16863 (defun org-get-compact-tod (s)
16864 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16865 (let* ((t1 (match-string 1 s))
16866 (h1 (string-to-number (match-string 2 s)))
16867 (m1 (string-to-number (match-string 3 s)))
16868 (t2 (and (match-end 4) (match-string 5 s)))
16869 (h2 (and t2 (string-to-number (match-string 6 s))))
16870 (m2 (and t2 (string-to-number (match-string 7 s))))
16874 (setq dh (- h2 h1) dm (- m2 m1))
16875 (when (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16876 (concat t1 "+" (number-to-string dh)
16877 (and (/= 0 dm) (format ":%02d" dm)))))))
16879 (defun org-time-stamp-inactive (&optional arg)
16880 "Insert an inactive time stamp.
16881 An inactive time stamp is enclosed in square brackets instead of angle
16882 brackets. It is inactive in the sense that it does not trigger agenda entries,
16883 does not link to the calendar and cannot be changed with the S-cursor keys.
16884 So these are more for recording a certain time/date."
16886 (org-time-stamp arg 'inactive))
16888 (defvar org-date-ovl (make-overlay 1 1))
16889 (overlay-put org-date-ovl 'face 'org-date-selected)
16890 (delete-overlay org-date-ovl)
16892 (defvar org-ans1) ; dynamically scoped parameter
16893 (defvar org-ans2) ; dynamically scoped parameter
16895 (defvar org-plain-time-of-day-regexp) ; defined below
16897 (defvar org-overriding-default-time nil) ; dynamically scoped
16898 (defvar org-read-date-overlay nil)
16899 (defvar org-dcst nil) ; dynamically scoped
16900 (defvar org-read-date-history nil)
16901 (defvar org-read-date-final-answer nil)
16902 (defvar org-read-date-analyze-futurep nil)
16903 (defvar org-read-date-analyze-forced-year nil)
16904 (defvar org-read-date-inactive)
16906 (defvar org-read-date-minibuffer-local-map
16907 (let* ((map (make-sparse-keymap)))
16908 (set-keymap-parent map minibuffer-local-map)
16909 (org-defkey map (kbd ".")
16910 (lambda () (interactive)
16911 ;; Are we at the beginning of the prompt?
16912 (if (looking-back "^[^:]+: "
16913 (let ((inhibit-field-text-motion t))
16914 (line-beginning-position)))
16915 (org-eval-in-calendar '(calendar-goto-today))
16917 (org-defkey map (kbd "C-.")
16918 (lambda () (interactive)
16919 (org-eval-in-calendar '(calendar-goto-today))))
16920 (org-defkey map [(meta shift left)]
16921 (lambda () (interactive)
16922 (org-eval-in-calendar '(calendar-backward-month 1))))
16923 (org-defkey map [(meta shift right)]
16924 (lambda () (interactive)
16925 (org-eval-in-calendar '(calendar-forward-month 1))))
16926 (org-defkey map [(meta shift up)]
16927 (lambda () (interactive)
16928 (org-eval-in-calendar '(calendar-backward-year 1))))
16929 (org-defkey map [(meta shift down)]
16930 (lambda () (interactive)
16931 (org-eval-in-calendar '(calendar-forward-year 1))))
16932 (org-defkey map [?\e (shift left)]
16933 (lambda () (interactive)
16934 (org-eval-in-calendar '(calendar-backward-month 1))))
16935 (org-defkey map [?\e (shift right)]
16936 (lambda () (interactive)
16937 (org-eval-in-calendar '(calendar-forward-month 1))))
16938 (org-defkey map [?\e (shift up)]
16939 (lambda () (interactive)
16940 (org-eval-in-calendar '(calendar-backward-year 1))))
16941 (org-defkey map [?\e (shift down)]
16942 (lambda () (interactive)
16943 (org-eval-in-calendar '(calendar-forward-year 1))))
16944 (org-defkey map [(shift up)]
16945 (lambda () (interactive)
16946 (org-eval-in-calendar '(calendar-backward-week 1))))
16947 (org-defkey map [(shift down)]
16948 (lambda () (interactive)
16949 (org-eval-in-calendar '(calendar-forward-week 1))))
16950 (org-defkey map [(shift left)]
16951 (lambda () (interactive)
16952 (org-eval-in-calendar '(calendar-backward-day 1))))
16953 (org-defkey map [(shift right)]
16954 (lambda () (interactive)
16955 (org-eval-in-calendar '(calendar-forward-day 1))))
16956 (org-defkey map "!"
16957 (lambda () (interactive)
16958 (org-eval-in-calendar '(diary-view-entries))
16960 (org-defkey map ">"
16961 (lambda () (interactive)
16962 (org-eval-in-calendar '(calendar-scroll-left 1))))
16963 (org-defkey map "<"
16964 (lambda () (interactive)
16965 (org-eval-in-calendar '(calendar-scroll-right 1))))
16966 (org-defkey map "\C-v"
16967 (lambda () (interactive)
16968 (org-eval-in-calendar
16969 '(calendar-scroll-left-three-months 1))))
16970 (org-defkey map "\M-v"
16971 (lambda () (interactive)
16972 (org-eval-in-calendar
16973 '(calendar-scroll-right-three-months 1))))
16975 "Keymap for minibuffer commands when using `org-read-date'.")
16978 (defvar org-defdecode)
16979 (defvar org-with-time)
16981 (defvar calendar-setup) ; Dynamically scoped.
16982 (defun org-read-date (&optional with-time to-time from-string prompt
16983 default-time default-input inactive)
16984 "Read a date, possibly a time, and make things smooth for the user.
16985 The prompt will suggest to enter an ISO date, but you can also enter anything
16986 which will at least partially be understood by `parse-time-string'.
16987 Unrecognized parts of the date will default to the current day, month, year,
16988 hour and minute. If this command is called to replace a timestamp at point,
16989 or to enter the second timestamp of a range, the default time is taken
16990 from the existing stamp. Furthermore, the command prefers the future,
16991 so if you are giving a date where the year is not given, and the day-month
16992 combination is already past in the current year, it will assume you
16993 mean next year. For details, see the manual. A few examples:
16995 3-2-5 --> 2003-02-05
16996 feb 15 --> currentyear-02-15
16997 2/15 --> currentyear-02-15
16998 sep 12 9 --> 2009-09-12
16999 12:45 --> today 12:45
17000 22 sept 0:34 --> currentyear-09-22 0:34
17001 12 --> currentyear-currentmonth-12
17002 Fri --> nearest Friday after today
17003 -Tue --> last Tuesday
17006 Furthermore you can specify a relative date by giving, as the *first* thing
17007 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
17008 change in days weeks, months, years.
17009 With a single plus or minus, the date is relative to today. With a double
17010 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
17011 +4d --> four days from today
17012 +4 --> same as above
17013 +2w --> two weeks from today
17014 ++5 --> five days from default date
17016 The function understands only English month and weekday abbreviations.
17018 While prompting, a calendar is popped up - you can also select the
17019 date with the mouse (button 1). The calendar shows a period of three
17020 months. To scroll it to other months, use the keys `>' and `<'.
17021 If you don't like the calendar, turn it off with
17022 (setq org-read-date-popup-calendar nil)
17024 With optional argument TO-TIME, the date will immediately be converted
17025 to an internal time.
17026 With an optional argument WITH-TIME, the prompt will suggest to
17027 also insert a time. Note that when WITH-TIME is not set, you can
17028 still enter a time, and this function will inform the calling routine
17029 about this change. The calling routine may then choose to change the
17030 format used to insert the time stamp into the buffer to include the time.
17031 With optional argument FROM-STRING, read from this string instead from
17032 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
17033 the time/date that is used for everything that is not specified by the
17035 (require 'parse-time)
17036 (let* ((org-with-time with-time)
17037 (org-time-stamp-rounding-minutes
17038 (if (equal org-with-time '(16))
17040 org-time-stamp-rounding-minutes))
17041 (org-dcst org-display-custom-times)
17042 (ct (org-current-time))
17043 (org-def (or org-overriding-default-time default-time ct))
17044 (org-defdecode (decode-time org-def))
17045 (cur-frame (selected-frame))
17046 (mouse-autoselect-window nil) ; Don't let the mouse jump
17048 (and (eq calendar-setup 'calendar-only) 'calendar-only))
17049 (calendar-move-hook nil)
17050 (calendar-view-diary-initially-flag nil)
17051 (calendar-view-holidays-initially-flag nil)
17052 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
17053 ;; Rationalize `org-def' and `org-defdecode', if required.
17054 (when (< (nth 2 org-defdecode) org-extend-today-until)
17055 (setf (nth 2 org-defdecode) -1)
17056 (setf (nth 1 org-defdecode) 59)
17057 (setq org-def (apply #'encode-time org-defdecode))
17058 (setq org-defdecode (decode-time org-def)))
17059 (let* ((timestr (format-time-string
17060 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d")
17062 (prompt (concat (if prompt (concat prompt " ") "")
17063 (format "Date+time [%s]: " timestr))))
17065 (from-string (setq ans from-string))
17066 (org-read-date-popup-calendar
17068 (save-window-excursion
17070 (when (eq calendar-setup 'calendar-only)
17072 (window-frame (get-buffer-window "*Calendar*" 'visible)))
17073 (select-frame cal-frame))
17074 (org-eval-in-calendar '(setq cursor-type nil) t)
17077 (calendar-forward-day (- (time-to-days org-def)
17078 (calendar-absolute-from-gregorian
17079 (calendar-current-date))))
17080 (org-eval-in-calendar nil t)
17081 (let* ((old-map (current-local-map))
17082 (map (copy-keymap calendar-mode-map))
17083 (minibuffer-local-map
17084 (copy-keymap org-read-date-minibuffer-local-map)))
17085 (org-defkey map (kbd "RET") 'org-calendar-select)
17086 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
17087 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
17090 (use-local-map map)
17091 (setq org-read-date-inactive inactive)
17092 (add-hook 'post-command-hook 'org-read-date-display)
17094 (read-string prompt
17096 'org-read-date-history
17098 ;; org-ans0: from prompt
17099 ;; org-ans1: from mouse click
17100 ;; org-ans2: from calendar motion
17102 (concat org-ans0 " " (or org-ans1 org-ans2))))
17103 (remove-hook 'post-command-hook 'org-read-date-display)
17104 (use-local-map old-map)
17105 (when org-read-date-overlay
17106 (delete-overlay org-read-date-overlay)
17107 (setq org-read-date-overlay nil)))))
17108 (bury-buffer "*Calendar*")
17110 (delete-frame cal-frame)
17111 (select-frame-set-input-focus cur-frame))))))
17113 (t ; Naked prompt only
17115 (setq ans (read-string prompt default-input
17116 'org-read-date-history timestr))
17117 (when org-read-date-overlay
17118 (delete-overlay org-read-date-overlay)
17119 (setq org-read-date-overlay nil))))))
17121 (setq final (org-read-date-analyze ans org-def org-defdecode))
17123 (when org-read-date-analyze-forced-year
17124 (message "Year was forced into %s"
17125 (if org-read-date-force-compatible-dates
17126 "compatible range (1970-2037)"
17127 "range representable on this machine"))
17130 ;; One round trip to get rid of 34th of August and stuff like that....
17131 (setq final (decode-time (apply 'encode-time final)))
17133 (setq org-read-date-final-answer ans)
17136 (apply 'encode-time final)
17137 (if (and (boundp 'org-time-was-given) org-time-was-given)
17138 (format "%04d-%02d-%02d %02d:%02d"
17139 (nth 5 final) (nth 4 final) (nth 3 final)
17140 (nth 2 final) (nth 1 final))
17141 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
17143 (defun org-read-date-display ()
17144 "Display the current date prompt interpretation in the minibuffer."
17145 (when org-read-date-display-live
17146 (when org-read-date-overlay
17147 (delete-overlay org-read-date-overlay))
17148 (when (minibufferp (current-buffer))
17151 (while (not (equal (buffer-substring
17152 (max (point-min) (- (point) 4)) (point))
17155 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
17156 " " (or org-ans1 org-ans2)))
17157 (org-end-time-was-given nil)
17158 (f (org-read-date-analyze ans org-def org-defdecode))
17160 org-time-stamp-custom-formats
17161 org-time-stamp-formats))
17162 (fmt (if (or org-with-time
17163 (and (boundp 'org-time-was-given) org-time-was-given))
17166 (txt (format-time-string fmt (apply 'encode-time f)))
17167 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
17168 (txt (concat "=> " txt)))
17169 (when (and org-end-time-was-given
17170 (string-match org-plain-time-of-day-regexp txt))
17171 (setq txt (concat (substring txt 0 (match-end 0)) "-"
17172 org-end-time-was-given
17173 (substring txt (match-end 0)))))
17174 (when org-read-date-analyze-futurep
17175 (setq txt (concat txt " (=>F)")))
17176 (setq org-read-date-overlay
17177 (make-overlay (1- (point-at-eol)) (point-at-eol)))
17178 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
17180 (defun org-read-date-analyze (ans def defdecode)
17181 "Analyze the combined answer of the date prompt."
17182 ;; FIXME: cleanup and comment
17183 ;; Pass `current-time' result to `decode-time' (instead of calling
17184 ;; without arguments) so that only `current-time' has to be
17185 ;; overriden in tests.
17186 (let ((org-def def)
17187 (org-defdecode defdecode)
17188 (nowdecode (decode-time (current-time)))
17189 delta deltan deltaw deltadef year month day
17190 hour minute second wday pm h2 m2 tl wday1
17191 iso-year iso-weekday iso-week iso-date futurep kill-year)
17192 (setq org-read-date-analyze-futurep nil
17193 org-read-date-analyze-forced-year nil)
17194 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17197 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17198 (setq ans (replace-match "" t t ans)
17200 deltaw (nth 1 delta)
17201 deltadef (nth 2 delta)))
17203 ;; Check if there is an iso week date in there. If yes, store the
17204 ;; info and postpone interpreting it until the rest of the parsing
17206 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17207 (setq iso-year (when (match-end 1)
17208 (org-small-year-to-year
17209 (string-to-number (match-string 1 ans))))
17210 iso-weekday (when (match-end 3)
17211 (string-to-number (match-string 3 ans)))
17212 iso-week (string-to-number (match-string 2 ans)))
17213 (setq ans (replace-match "" t t ans)))
17215 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17216 (when (string-match
17217 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17218 (setq year (if (match-end 2)
17219 (string-to-number (match-string 2 ans))
17220 (progn (setq kill-year t)
17221 (string-to-number (format-time-string "%Y"))))
17222 month (string-to-number (match-string 3 ans))
17223 day (string-to-number (match-string 4 ans)))
17224 (setq year (org-small-year-to-year year))
17225 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17228 ;; Help matching dotted european dates
17229 (when (string-match
17230 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17231 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17233 (string-to-number (format-time-string "%Y")))
17234 day (string-to-number (match-string 1 ans))
17235 month (string-to-number (match-string 2 ans))
17236 ans (replace-match (format "%04d-%02d-%02d" year month day)
17239 ;; Help matching american dates, like 5/30 or 5/30/7
17240 (when (string-match
17241 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17242 (setq year (if (match-end 4)
17243 (string-to-number (match-string 4 ans))
17244 (progn (setq kill-year t)
17245 (string-to-number (format-time-string "%Y"))))
17246 month (string-to-number (match-string 1 ans))
17247 day (string-to-number (match-string 2 ans)))
17248 (setq year (org-small-year-to-year year))
17249 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17251 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17252 ;; If there is a time with am/pm, and *no* time without it, we convert
17253 ;; so that matching will be successful.
17254 (cl-loop for i from 1 to 2 do ; twice, for end time as well
17255 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17256 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17257 (setq hour (string-to-number (match-string 1 ans))
17258 minute (if (match-end 3)
17259 (string-to-number (match-string 3 ans))
17262 (string-to-char (downcase (match-string 4 ans)))))
17263 (if (and (= hour 12) (not pm))
17265 (when (and pm (< hour 12)) (setq hour (+ 12 hour))))
17266 (setq ans (replace-match (format "%02d:%02d" hour minute)
17269 ;; Check if a time range is given as a duration
17270 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17271 (setq hour (string-to-number (match-string 1 ans))
17272 h2 (+ hour (string-to-number (match-string 3 ans)))
17273 minute (string-to-number (match-string 2 ans))
17274 m2 (+ minute (if (match-end 5) (string-to-number
17275 (match-string 5 ans))0)))
17276 (when (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17277 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17280 ;; Check if there is a time range
17281 (when (boundp 'org-end-time-was-given)
17282 (setq org-time-was-given nil)
17283 (when (and (string-match org-plain-time-of-day-regexp ans)
17285 (setq org-end-time-was-given (match-string 8 ans))
17286 (setq ans (concat (substring ans 0 (match-beginning 7))
17287 (substring ans (match-end 7))))))
17289 (setq tl (parse-time-string ans)
17290 day (or (nth 3 tl) (nth 3 org-defdecode))
17293 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17294 ;; Day was specified. Make sure DAY+MONTH
17295 ;; combination happens in the future.
17298 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17299 (nth 4 nowdecode)))
17300 (t (nth 4 org-defdecode)))
17302 (cond ((and (not kill-year) (nth 5 tl)))
17303 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17304 ;; Month was guessed in the future and is at least
17305 ;; equal to NOWDECODE's. Fix year accordingly.
17307 (if (or (> month (nth 4 nowdecode))
17308 (>= day (nth 3 nowdecode)))
17310 (1+ (nth 5 nowdecode))))
17311 ;; Month was specified. Make sure MONTH+YEAR
17312 ;; combination happens in the future.
17315 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17316 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17317 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17318 (t (nth 5 nowdecode))))
17319 (t (nth 5 org-defdecode)))
17320 hour (or (nth 2 tl) (nth 2 org-defdecode))
17321 minute (or (nth 1 tl) (nth 1 org-defdecode))
17322 second (or (nth 0 tl) 0)
17325 (when (and (eq org-read-date-prefer-future 'time)
17326 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17327 (equal day (nth 3 nowdecode))
17328 (equal month (nth 4 nowdecode))
17329 (equal year (nth 5 nowdecode))
17331 (or (< (nth 2 tl) (nth 2 nowdecode))
17332 (and (= (nth 2 tl) (nth 2 nowdecode))
17334 (< (nth 1 tl) (nth 1 nowdecode)))))
17338 ;; Special date definitions below
17341 ;; There was an iso week
17344 (setq year (or iso-year year)
17345 day (or iso-weekday wday 1)
17346 wday nil ; to make sure that the trigger below does not match
17347 iso-date (calendar-gregorian-from-absolute
17348 (calendar-iso-to-absolute
17349 (list iso-week day year))))
17350 ; FIXME: Should we also push ISO weeks into the future?
17351 ; (when (and org-read-date-prefer-future
17353 ; (< (calendar-absolute-from-gregorian iso-date)
17354 ; (time-to-days (current-time))))
17355 ; (setq year (1+ year)
17356 ; iso-date (calendar-gregorian-from-absolute
17357 ; (calendar-iso-to-absolute
17358 ; (list iso-week day year)))))
17359 (setq month (car iso-date)
17360 year (nth 2 iso-date)
17361 day (nth 1 iso-date)))
17365 ;; Pass `current-time' result to `decode-time' (instead of
17366 ;; calling without arguments) so that only `current-time' has
17367 ;; to be overriden in tests.
17368 (let ((now (decode-time (current-time))))
17369 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17370 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17371 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17372 ((equal deltaw "m") (setq month (+ month deltan)))
17373 ((equal deltaw "y") (setq year (+ year deltan)))))
17374 ((and wday (not (nth 3 tl)))
17375 ;; Weekday was given, but no day, so pick that day in the week
17376 ;; on or after the derived date.
17377 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17378 (unless (equal wday wday1)
17379 (setq day (+ day (% (- wday wday1 -7) 7))))))
17380 (when (and (boundp 'org-time-was-given)
17382 (setq org-time-was-given t))
17383 (when (< year 100) (setq year (+ 2000 year)))
17384 ;; Check of the date is representable
17385 (if org-read-date-force-compatible-dates
17387 (when (< year 1970)
17388 (setq year 1970 org-read-date-analyze-forced-year t))
17389 (when (> year 2037)
17390 (setq year 2037 org-read-date-analyze-forced-year t)))
17391 (condition-case nil
17392 (ignore (encode-time second minute hour day month year))
17394 (setq year (nth 5 org-defdecode))
17395 (setq org-read-date-analyze-forced-year t))))
17396 (setq org-read-date-analyze-futurep futurep)
17397 (list second minute hour day month year)))
17399 (defvar parse-time-weekdays)
17400 (defun org-read-date-get-relative (s today default)
17401 "Check string S for special relative date string.
17402 TODAY and DEFAULT are internal times, for today and for a default.
17403 Return shift list (N what def-flag)
17404 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17405 N is the number of WHATs to shift.
17406 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17407 the DEFAULT date rather than TODAY."
17408 (require 'parse-time)
17412 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17414 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17415 "\\([ \t]\\|$\\)") s)
17416 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17417 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17418 (string-to-char (substring (match-string 1 s) -1))
17420 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17421 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17422 (what (if (match-end 3) (match-string 3 s) "d"))
17423 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17424 (date (if rel default today))
17425 (wday (nth 6 (decode-time date)))
17429 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17430 (when (= delta 0) (setq delta 7))
17432 (setq delta (- delta 7))
17433 (when (= delta 0) (setq delta -7)))
17434 (when (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17435 (list delta "d" rel))
17436 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17438 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17439 "Turn a user-specified date into the internal representation.
17440 The internal representation needed by the calendar is (month day year).
17441 This is a wrapper to handle the brain-dead convention in calendar that
17442 user function argument order change dependent on argument order."
17443 (pcase calendar-date-style
17444 (`american (list arg1 arg2 arg3))
17445 (`european (list arg2 arg1 arg3))
17446 (`iso (list arg2 arg3 arg1))))
17448 (defun org-eval-in-calendar (form &optional keepdate)
17449 "Eval FORM in the calendar window and return to current window.
17450 Unless KEEPDATE is non-nil, update `org-ans2' to the cursor date."
17451 (let ((sf (selected-frame))
17452 (sw (selected-window)))
17453 (select-window (get-buffer-window "*Calendar*" t))
17455 (when (and (not keepdate) (calendar-cursor-to-date))
17456 (let* ((date (calendar-cursor-to-date))
17457 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17458 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17459 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17461 (select-frame-set-input-focus sf)))
17463 (defun org-calendar-select ()
17464 "Return to `org-read-date' with the date currently selected.
17465 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17467 (when (calendar-cursor-to-date)
17468 (let* ((date (calendar-cursor-to-date))
17469 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17470 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17471 (when (active-minibuffer-window) (exit-minibuffer))))
17473 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17474 "Insert a date stamp for the date given by the internal TIME.
17475 See `format-time-string' for the format of TIME.
17476 WITH-HM means use the stamp format that includes the time of the day.
17477 INACTIVE means use square brackets instead of angular ones, so that the
17478 stamp will not contribute to the agenda.
17479 PRE and POST are optional strings to be inserted before and after the
17481 The command returns the inserted time stamp."
17482 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17484 (when inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17485 (insert-before-markers (or pre ""))
17486 (when (listp extra)
17487 (setq extra (car extra))
17488 (if (and (stringp extra)
17489 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17490 (setq extra (format "-%02d:%02d"
17491 (string-to-number (match-string 1 extra))
17492 (string-to-number (match-string 2 extra))))
17495 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17496 (insert-before-markers (setq stamp (format-time-string fmt time)))
17497 (insert-before-markers (or post ""))
17498 (setq org-last-inserted-timestamp stamp)))
17500 (defun org-toggle-time-stamp-overlays ()
17501 "Toggle the use of custom time stamp formats."
17503 (setq org-display-custom-times (not org-display-custom-times))
17504 (unless org-display-custom-times
17505 (let ((p (point-min)) (bmp (buffer-modified-p)))
17506 (while (setq p (next-single-property-change p 'display))
17507 (when (and (get-text-property p 'display)
17508 (eq (get-text-property p 'face) 'org-date))
17509 (remove-text-properties
17510 p (setq p (next-single-property-change p 'display))
17512 (set-buffer-modified-p bmp)))
17513 (org-restart-font-lock)
17514 (setq org-table-may-need-update t)
17515 (if org-display-custom-times
17516 (message "Time stamps are overlaid with custom format")
17517 (message "Time stamp overlays removed")))
17519 (defun org-display-custom-time (beg end)
17520 "Overlay modified time stamp format over timestamp between BEG and END."
17521 (let* ((ts (buffer-substring beg end))
17522 t1 w1 with-hm tf time str w2 (off 0))
17524 (setq t1 (org-parse-time-string ts t))
17525 (when (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17526 (setq off (- (match-end 0) (match-beginning 0)))))
17527 (setq end (- end off))
17528 (setq w1 (- end beg)
17529 with-hm (and (nth 1 t1) (nth 2 t1))
17530 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17531 time (org-fix-decoded-time t1)
17533 (format-time-string
17534 (substring tf 1 -1) (apply 'encode-time time))
17535 nil 'mouse-face 'highlight)
17538 (add-text-properties (1+ beg) (+ 2 beg)
17539 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17540 (put-text-property beg end 'display str)))
17542 (defun org-fix-decoded-time (time)
17543 "Set 0 instead of nil for the first 6 elements of time.
17544 Don't touch the rest."
17546 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17548 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17549 "Difference between TIMESTAMP-STRING and now in days.
17550 If SECONDS is non-nil, return the difference in seconds."
17551 (let ((fdiff (if seconds #'float-time #'time-to-days)))
17552 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17553 (funcall fdiff (current-time)))))
17555 (defun org-deadline-close-p (timestamp-string &optional ndays)
17556 "Is the time in TIMESTAMP-STRING close to the current date?"
17557 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17558 (and (<= (org-time-stamp-to-now timestamp-string) ndays)
17559 (not (org-entry-is-done-p))))
17561 (defun org-get-wdays (ts &optional delay zero-delay)
17562 "Get the deadline lead time appropriate for timestring TS.
17563 When DELAY is non-nil, get the delay time for scheduled items
17564 instead of the deadline lead time. When ZERO-DELAY is non-nil
17565 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17566 don't try to find the delay cookie in the scheduled timestamp."
17567 (let ((tv (if delay org-scheduled-delay-days
17568 org-deadline-warning-days)))
17570 ((or (and delay (< tv 0))
17571 (and delay zero-delay (<= tv 0))
17572 (and (not delay) (<= tv 0)))
17573 ;; Enforce this value no matter what
17575 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17576 ;; lead time is specified.
17577 (floor (* (string-to-number (match-string 1 ts))
17578 (cdr (assoc (match-string 2 ts)
17579 '(("d" . 1) ("w" . 7)
17580 ("m" . 30.4) ("y" . 365.25)
17581 ("h" . 0.041667)))))))
17582 ;; go for the default.
17585 (defun org-calendar-select-mouse (ev)
17586 "Return to `org-read-date' with the date currently selected.
17587 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17589 (mouse-set-point ev)
17590 (when (calendar-cursor-to-date)
17591 (let* ((date (calendar-cursor-to-date))
17592 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17593 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17594 (when (active-minibuffer-window) (exit-minibuffer))))
17596 (defun org-check-deadlines (ndays)
17597 "Check if there are any deadlines due or past due.
17598 A deadline is considered due if it happens within `org-deadline-warning-days'
17599 days from today's date. If the deadline appears in an entry marked DONE,
17600 it is not shown. A numeric prefix argument NDAYS can be used to test that
17601 many days. If the prefix is a raw `\\[universal-argument]', all deadlines \
17604 (let* ((org-warn-days
17606 ((equal ndays '(4)) 100000)
17607 (ndays (prefix-numeric-value ndays))
17608 (t (abs org-deadline-warning-days))))
17609 (case-fold-search nil)
17610 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17612 (lambda () (org-deadline-close-p (match-string 1) org-warn-days))))
17613 (message "%d deadlines past-due or due within %d days"
17614 (org-occur regexp nil callback)
17617 (defsubst org-re-timestamp (type)
17618 "Return a regexp for timestamp TYPE.
17619 Allowed values for TYPE are:
17621 all: all timestamps
17622 active: only active timestamps (<...>)
17623 inactive: only inactive timestamps ([...])
17624 scheduled: only scheduled timestamps
17625 deadline: only deadline timestamps
17626 closed: only closed time-stamps
17628 When TYPE is nil, fall back on returning a regexp that matches
17629 both scheduled and deadline timestamps."
17631 (all org-ts-regexp-both)
17632 (active org-ts-regexp)
17633 (inactive org-ts-regexp-inactive)
17634 (scheduled org-scheduled-time-regexp)
17635 (deadline org-deadline-time-regexp)
17636 (closed org-closed-time-regexp)
17639 (regexp-opt (list org-deadline-string org-scheduled-string))
17640 " *<\\([^>]+\\)>"))))
17642 (defun org-check-before-date (d)
17643 "Check if there are deadlines or scheduled entries before date D."
17644 (interactive (list (org-read-date)))
17645 (let* ((case-fold-search nil)
17646 (regexp (org-re-timestamp org-ts-type))
17647 (ts-type org-ts-type)
17650 (let ((match (match-string 1)))
17651 (and (if (memq ts-type '(active inactive all))
17652 (eq (org-element-type (save-excursion
17654 (org-element-context)))
17656 (org-at-planning-p))
17658 (org-time-string-to-time match)
17659 (org-time-string-to-time d)))))))
17660 (message "%d entries before %s"
17661 (org-occur regexp nil callback)
17664 (defun org-check-after-date (d)
17665 "Check if there are deadlines or scheduled entries after date D."
17666 (interactive (list (org-read-date)))
17667 (let* ((case-fold-search nil)
17668 (regexp (org-re-timestamp org-ts-type))
17669 (ts-type org-ts-type)
17672 (let ((match (match-string 1)))
17673 (and (if (memq ts-type '(active inactive all))
17674 (eq (org-element-type (save-excursion
17676 (org-element-context)))
17678 (org-at-planning-p))
17680 (org-time-string-to-time match)
17681 (org-time-string-to-time d))))))))
17682 (message "%d entries after %s"
17683 (org-occur regexp nil callback)
17686 (defun org-check-dates-range (start-date end-date)
17687 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17688 (interactive (list (org-read-date nil nil nil "Range starts")
17689 (org-read-date nil nil nil "Range end")))
17690 (let ((case-fold-search nil)
17691 (regexp (org-re-timestamp org-ts-type))
17693 (let ((type org-ts-type))
17695 (let ((match (match-string 1)))
17697 (if (memq type '(active inactive all))
17698 (eq (org-element-type (save-excursion
17700 (org-element-context)))
17702 (org-at-planning-p))
17704 (org-time-string-to-time match)
17705 (org-time-string-to-time start-date)))
17707 (org-time-string-to-time match)
17708 (org-time-string-to-time end-date))))))))
17709 (message "%d entries between %s and %s"
17710 (org-occur regexp nil callback) start-date end-date)))
17712 (defun org-evaluate-time-range (&optional to-buffer)
17713 "Evaluate a time range by computing the difference between start and end.
17714 Normally the result is just printed in the echo area, but with prefix arg
17715 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17716 If the time range is actually in a table, the result is inserted into the
17718 For time difference computation, a year is assumed to be exactly 365
17719 days in order to avoid rounding problems."
17722 (org-clock-update-time-maybe)
17724 (unless (org-at-date-range-p t)
17725 (goto-char (point-at-bol))
17726 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17727 (unless (org-at-date-range-p t)
17728 (user-error "Not at a time-stamp range, and none found in current line")))
17729 (let* ((ts1 (match-string 1))
17730 (ts2 (match-string 2))
17731 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17732 (match-end (match-end 0))
17733 (time1 (org-time-string-to-time ts1))
17734 (time2 (org-time-string-to-time ts2))
17735 (t1 (float-time time1))
17736 (t2 (float-time time2))
17737 (diff (abs (- t2 t1)))
17738 (negative (< (- t2 t1) 0))
17739 ;; (ys (floor (* 365 24 60 60)))
17742 (fy "%dy %dd %02d:%02d")
17744 (fd "%dd %02d:%02d")
17749 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17751 d (floor (/ diff ds)) diff (mod diff ds)
17752 h (floor (/ diff hs)) diff (mod diff hs)
17753 m (floor (/ diff 60)))
17754 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17756 d (floor (+ (/ diff ds) 0.5))
17758 (if (not to-buffer)
17759 (message "%s" (org-make-tdiff-string y d h m))
17760 (if (org-at-table-p)
17762 (goto-char match-end)
17764 (and (looking-at " *|") (goto-char (match-end 0))))
17765 (goto-char match-end))
17767 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17768 (replace-match ""))
17769 (when negative (insert " -"))
17770 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17771 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17772 (insert " " (format fh h m))))
17773 (when align (org-table-align))
17774 (message "Time difference inserted")))))
17776 (defun org-make-tdiff-string (y d h m)
17780 (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " "))
17783 (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " "))
17786 (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " "))
17789 (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " "))
17791 (apply 'format fmt (nreverse l))))
17793 (defun org-time-string-to-time (s &optional buffer pos)
17794 "Convert a timestamp string into internal time."
17795 (condition-case errdata
17796 (apply 'encode-time (org-parse-time-string s))
17797 (error (error "Bad timestamp `%s'%s\nError was: %s"
17798 s (if (not (and buffer pos))
17800 (format-message " at %d in buffer `%s'" pos buffer))
17803 (defun org-time-string-to-seconds (s)
17804 "Convert a timestamp string to a number of seconds."
17805 (float-time (org-time-string-to-time s)))
17807 (org-define-error 'org-diary-sexp-no-match "Unable to match diary sexp")
17809 (defun org-time-string-to-absolute (s &optional daynr prefer buffer pos)
17810 "Convert time stamp S to an absolute day number.
17812 If DAYNR in non-nil, and there is a specifier for a cyclic time
17813 stamp, get the closest date to DAYNR. If PREFER is
17814 `past' (respectively `future') return a date past (respectively
17815 after) or equal to DAYNR.
17817 POS is the location of time stamp S, as a buffer position in
17820 Diary sexp timestamps are matched against DAYNR, when non-nil.
17821 If matching fails or DAYNR is nil, `org-diary-sexp-no-match' is
17824 ((string-match "\\`%%\\((.*)\\)" s)
17825 ;; Sexp timestamp: try to match DAYNR, if available, since we're
17826 ;; only able to match individual dates. If it fails, raise an
17829 (org-diary-sexp-entry
17830 (match-string 1 s) "" (calendar-gregorian-from-absolute daynr)))
17832 (signal 'org-diary-sexp-no-match (list s))))
17833 (daynr (org-closest-date s daynr prefer))
17835 (condition-case errdata
17836 (apply #'encode-time (org-parse-time-string s))
17837 (error (error "Bad timestamp `%s'%s\nError was: %s"
17839 (if (not (and buffer pos)) ""
17840 (format-message " at %d in buffer `%s'" pos buffer))
17841 (cdr errdata))))))))
17843 (defun org-days-to-iso-week (days)
17844 "Return the iso week number."
17846 (car (calendar-iso-from-absolute days)))
17848 (defun org-small-year-to-year (year)
17849 "Convert 2-digit years into 4-digit years.
17850 YEAR is expanded into one of the 30 next years, if possible, or
17851 into a past one. Any year larger than 99 is returned unchanged."
17852 (if (>= year 100) year
17853 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17854 (century (/ current 100))
17855 (offset (- year (% current 100))))
17856 (cond ((> offset 30) (+ (* (1- century) 100) year))
17857 ((> offset -70) (+ (* century 100) year))
17858 (t (+ (* (1+ century) 100) year))))))
17860 (defun org-time-from-absolute (d)
17861 "Return the time corresponding to date D.
17862 D may be an absolute day number, or a calendar-type list (month day year)."
17863 (when (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17864 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17866 (defvar org-agenda-current-date)
17867 (defun org-calendar-holiday ()
17868 "List of holidays, for Diary display in Org mode."
17869 (require 'holidays)
17870 (let ((hl (calendar-check-holidays org-agenda-current-date)))
17871 (and hl (mapconcat #'identity hl "; "))))
17873 (defun org-diary-sexp-entry (sexp entry d)
17874 "Process a SEXP diary ENTRY for date D."
17875 (require 'diary-lib)
17876 ;; `org-anniversary' and alike expect ENTRY and DATE to be bound
17878 (let* ((sexp `(let ((entry ,entry)
17880 ,(car (read-from-string sexp))))
17881 (result (if calendar-debug-sexp (eval sexp)
17882 (condition-case nil
17886 (message "Bad sexp at line %d in %s: %s"
17888 (buffer-file-name) sexp)
17890 (cond ((stringp result) (split-string result "; "))
17891 ((and (consp result)
17892 (not (consp (cdr result)))
17893 (stringp (cdr result))) (cdr result))
17894 ((and (consp result)
17895 (stringp (car result))) result)
17898 (defun org-diary-to-ical-string (frombuf)
17899 "Get iCalendar entries from diary entries in buffer FROMBUF.
17900 This uses the icalendar.el library."
17901 (let* ((tmpdir temporary-file-directory)
17902 (tmpfile (make-temp-name
17903 (expand-file-name "orgics" tmpdir)))
17905 (with-current-buffer frombuf
17906 (icalendar-export-region (point-min) (point-max) tmpfile)
17907 (setq buf (find-buffer-visiting tmpfile))
17909 (goto-char (point-min))
17910 (when (re-search-forward "^BEGIN:VEVENT" nil t)
17911 (setq b (match-beginning 0)))
17912 (goto-char (point-max))
17913 (when (re-search-backward "^END:VEVENT" nil t)
17914 (setq e (match-end 0)))
17915 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17917 (delete-file tmpfile)
17920 (defun org-closest-date (start current prefer)
17921 "Return closest date to CURRENT starting from START.
17923 CURRENT and START are both time stamps.
17925 When PREFER is `past', return a date that is either CURRENT or
17926 past. When PREFER is `future', return a date that is either
17929 Only time stamps with a repeater are modified. Any other time
17930 stamp stay unchanged. In any case, return value is an absolute
17932 (if (not (string-match "\\+\\([0-9]+\\)\\([hdwmy]\\)" start))
17933 ;; No repeater. Do not shift time stamp.
17934 (time-to-days (apply #'encode-time (org-parse-time-string start)))
17935 (let ((value (string-to-number (match-string 1 start)))
17936 (type (match-string 2 start)))
17938 ;; Repeater with a 0-value is considered as void.
17939 (time-to-days (apply #'encode-time (org-parse-time-string start)))
17940 (let* ((base (org-date-to-gregorian start))
17941 (target (org-date-to-gregorian current))
17942 (sday (calendar-absolute-from-gregorian base))
17943 (cday (calendar-absolute-from-gregorian target))
17945 ;; If START is already past CURRENT, just return START.
17946 (if (<= cday sday) sday
17947 ;; Compute closest date before (N1) and closest date past
17951 (let ((missing-hours
17952 (mod (+ (- (* 24 (- cday sday))
17953 (nth 2 (org-parse-time-string start)))
17954 org-extend-today-until)
17956 (setf n1 (if (= missing-hours 0) cday
17957 (- cday (1+ (/ missing-hours 24)))))
17958 (setf n2 (+ cday (/ (- value missing-hours) 24)))))
17960 (let ((value (if (equal type "w") (* 7 value) value)))
17961 (setf n1 (+ sday (* value (/ (- cday sday) value))))
17962 (setf n2 (+ n1 value))))
17966 ;; Add N months to gregorian date D, i.e.,
17967 ;; a list (MONTH DAY YEAR). Return a valid
17969 (let ((m (+ (nth 0 d) n)))
17972 (+ (/ m 12) (nth 2 d))))))
17973 (months ; Complete months to TARGET.
17974 (* (/ (+ (* 12 (- (nth 2 target) (nth 2 base)))
17975 (- (nth 0 target) (nth 0 base))
17976 ;; If START's day is greater than
17977 ;; TARGET's, remove incomplete month.
17978 (if (> (nth 1 target) (nth 1 base)) 0 -1))
17981 (before (funcall add-months base months)))
17982 (setf n1 (calendar-absolute-from-gregorian before))
17984 (calendar-absolute-from-gregorian
17985 (funcall add-months before value)))))
17987 (let* ((d (nth 1 base))
17990 (years ; Complete years to TARGET.
17991 (* (/ (- (nth 2 target)
17993 ;; If START's month and day are
17994 ;; greater than TARGET's, remove
17995 ;; incomplete year.
17996 (if (or (> (nth 0 target) m)
17997 (and (= (nth 0 target) m)
17998 (> (nth 1 target) d)))
18003 (before (list m d (+ y years))))
18004 (setf n1 (calendar-absolute-from-gregorian before))
18005 (setf n2 (calendar-absolute-from-gregorian
18006 (list m d (+ (nth 2 before) value)))))))
18007 ;; Handle PREFER parameter, if any.
18009 ((eq prefer 'past) (if (= cday n2) n2 n1))
18010 ((eq prefer 'future) (if (= cday n1) n1 n2))
18011 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))))))))
18013 (defun org-date-to-gregorian (d)
18014 "Turn any specification of date D into a Gregorian date for the calendar."
18015 (cond ((integerp d) (calendar-gregorian-from-absolute d))
18016 ((and (listp d) (= (length d) 3)) d)
18018 (let ((d (org-parse-time-string d)))
18019 (list (nth 4 d) (nth 3 d) (nth 5 d))))
18020 ((listp d) (list (nth 4 d) (nth 3 d) (nth 5 d)))))
18022 (defun org-parse-time-string (s &optional nodefault)
18023 "Parse the standard Org time string.
18024 This should be a lot faster than the normal `parse-time-string'.
18025 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
18026 hour and minute fields will be nil if not given."
18027 (cond ((string-match org-ts-regexp0 s)
18029 (when (or (match-beginning 8) (not nodefault))
18030 (string-to-number (or (match-string 8 s) "0")))
18031 (when (or (match-beginning 7) (not nodefault))
18032 (string-to-number (or (match-string 7 s) "0")))
18033 (string-to-number (match-string 4 s))
18034 (string-to-number (match-string 3 s))
18035 (string-to-number (match-string 2 s))
18037 ((string-match "^<[^>]+>$" s)
18038 (decode-time (seconds-to-time (org-matcher-time s))))
18039 (t (error "Not a standard Org time string: %s" s))))
18041 (defun org-timestamp-up (&optional arg)
18042 "Increase the date item at the cursor by one.
18043 If the cursor is on the year, change the year. If it is on the month,
18044 the day or the time, change that.
18045 With prefix ARG, change by that many units."
18047 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
18049 (defun org-timestamp-down (&optional arg)
18050 "Decrease the date item at the cursor by one.
18051 If the cursor is on the year, change the year. If it is on the month,
18052 the day or the time, change that.
18053 With prefix ARG, change by that many units."
18055 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
18057 (defun org-timestamp-up-day (&optional arg)
18058 "Increase the date in the time stamp by one day.
18059 With prefix ARG, change that many days."
18061 (if (and (not (org-at-timestamp-p t))
18062 (org-at-heading-p))
18064 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
18066 (defun org-timestamp-down-day (&optional arg)
18067 "Decrease the date in the time stamp by one day.
18068 With prefix ARG, change that many days."
18070 (if (and (not (org-at-timestamp-p t))
18071 (org-at-heading-p))
18073 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
18075 (defun org-at-timestamp-p (&optional inactive-ok)
18076 "Non-nil if point is inside a timestamp.
18078 When optional argument INACTIVE-OK is non-nil, also consider
18079 inactive timestamps.
18081 When this function returns a non-nil value, match data is set
18082 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
18085 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
18087 (ans (or (looking-at tsr)
18089 (skip-chars-backward "^[<\n\r\t")
18090 (when (> (point) (point-min)) (backward-char 1))
18091 (and (looking-at tsr)
18092 (> (- (match-end 0) pos) -1))))))
18094 (boundp 'org-ts-what)
18097 ((= pos (match-beginning 0)) 'bracket)
18098 ;; Point is considered to be "on the bracket" whether
18099 ;; it's really on it or right after it.
18100 ((= pos (1- (match-end 0))) 'bracket)
18101 ((= pos (match-end 0)) 'after)
18102 ((org-pos-in-match-range pos 2) 'year)
18103 ((org-pos-in-match-range pos 3) 'month)
18104 ((org-pos-in-match-range pos 7) 'hour)
18105 ((org-pos-in-match-range pos 8) 'minute)
18106 ((or (org-pos-in-match-range pos 4)
18107 (org-pos-in-match-range pos 5)) 'day)
18108 ((and (> pos (or (match-end 8) (match-end 5)))
18109 (< pos (match-end 0)))
18110 (- pos (or (match-end 8) (match-end 5))))
18114 (defun org-toggle-timestamp-type ()
18115 "Toggle the type (<active> or [inactive]) of a time stamp."
18117 (when (org-at-timestamp-p t)
18118 (let ((beg (match-beginning 0)) (end (match-end 0))
18119 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
18122 (while (re-search-forward "[][<>]" end t)
18123 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
18125 (message "Timestamp is now %sactive"
18126 (if (equal (char-after beg) ?<) "" "in")))))
18128 (defun org-at-clock-log-p nil
18129 "Is the cursor on the clock log line?"
18131 (beginning-of-line)
18132 (looking-at org-clock-line-re)))
18134 (defvar org-clock-history) ; defined in org-clock.el
18135 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
18136 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
18137 "Change the date in the time stamp at point.
18138 The date will be changed by N times WHAT. WHAT can be `day', `month',
18139 `year', `minute', `second'. If WHAT is not given, the cursor position
18140 in the timestamp determines what will be changed.
18141 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
18142 (let ((origin (point)) origin-cat
18144 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
18147 ts time time0 fixnext clrgx)
18148 (unless (org-at-timestamp-p t)
18149 (user-error "Not at a timestamp"))
18150 (if (and (not what) (eq org-ts-what 'bracket))
18151 (org-toggle-timestamp-type)
18152 ;; Point isn't on brackets. Remember the part of the time-stamp
18153 ;; the point was in. Indeed, size of time-stamps may change,
18154 ;; but point must be kept in the same category nonetheless.
18155 (setq origin-cat org-ts-what)
18156 (when (and (not what) (not (eq org-ts-what 'day))
18157 org-display-custom-times
18158 (get-text-property (point) 'display)
18159 (not (get-text-property (1- (point)) 'display)))
18160 (setq org-ts-what 'day))
18161 (setq org-ts-what (or what org-ts-what)
18162 inactive (= (char-after (match-beginning 0)) ?\[)
18163 ts (match-string 0))
18165 (when (string-match
18166 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
18168 (setq extra (match-string 1 ts))
18169 (when suppress-tmp-delay
18170 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
18171 (when (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
18173 (setq time0 (org-parse-time-string ts))
18175 (eq org-ts-what 'minute)
18176 (not current-prefix-arg))
18177 ;; This looks like s-up and s-down. Change by one rounding step.
18178 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
18179 (unless (= 0 (setq rem (% (nth 1 time0) dm)))
18180 (setcar (cdr time0) (+ (nth 1 time0)
18181 (if (> n 0) (- rem) (- dm rem))))))
18183 (apply #'encode-time
18185 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
18186 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
18187 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
18188 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
18189 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
18191 (when (and (member org-ts-what '(hour minute))
18193 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
18194 (setq extra (org-modify-ts-extra
18196 (if (eq org-ts-what 'hour) 2 5)
18198 (when (integerp org-ts-what)
18199 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
18200 (when (eq what 'calendar)
18201 (let ((cal-date (org-get-date-from-calendar)))
18202 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
18203 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
18204 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
18205 (setcar time0 (or (car time0) 0))
18206 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18207 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18208 (setq time (apply 'encode-time time0))))
18209 ;; Insert the new time-stamp, and ensure point stays in the same
18210 ;; category as before (i.e. not after the last position in that
18212 (let ((pos (point)))
18213 ;; Stay before inserted string. `save-excursion' is of no use.
18214 (setq org-last-changed-timestamp
18215 (org-insert-time-stamp time with-hm inactive nil nil extra))
18218 (looking-at org-ts-regexp3)
18221 ;; `day' category ends before `hour' if any, or at the end
18222 ;; of the day name.
18223 (`day (min (or (match-beginning 7) (1- (match-end 5))) origin))
18224 (`hour (min (match-end 7) origin))
18225 (`minute (min (1- (match-end 8)) origin))
18226 ((pred integerp) (min (1- (match-end 0)) origin))
18227 ;; Point was right after the time-stamp. However, the
18228 ;; time-stamp length might have changed, so refer to
18229 ;; (match-end 0) instead.
18230 (`after (match-end 0))
18231 ;; `year' and `month' have both fixed size: point couldn't
18232 ;; have moved into another part.
18234 ;; Update clock if on a CLOCK line.
18235 (org-clock-update-time-maybe)
18236 ;; Maybe adjust the closest clock in `org-clock-history'
18237 (when org-clock-adjust-closest
18238 (if (not (and (org-at-clock-log-p)
18239 (< 1 (length (delq nil (mapcar 'marker-position
18240 org-clock-history))))))
18241 (message "No clock to adjust")
18242 (cond ((save-excursion ; fix previous clock?
18243 (re-search-backward org-ts-regexp0 nil t)
18244 (looking-back (concat org-clock-string " \\[")
18245 (line-beginning-position)))
18246 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18247 ((save-excursion ; fix next clock?
18248 (re-search-backward org-ts-regexp0 nil t)
18249 (looking-at (concat org-ts-regexp0 "\\] =>")))
18250 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18251 (save-window-excursion
18252 ;; Find closest clock to point, adjust the previous/next one in history
18253 (let* ((p (save-excursion (org-back-to-heading t)))
18254 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18256 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18257 (clfixpos (unless (> 0 clfixnth) (nth clfixnth org-clock-history))))
18259 (message "No clock to adjust")
18261 (org-goto-marker-or-bmk clfixpos)
18263 (when (re-search-forward clrgx nil t)
18264 (goto-char (match-beginning 1))
18265 (let (org-clock-adjust-closest)
18266 (org-timestamp-change n org-ts-what updown))
18267 (message "Clock adjusted in %s for heading: %s"
18268 (file-name-nondirectory (buffer-file-name))
18269 (org-get-heading t t)))))))))
18270 ;; Try to recenter the calendar window, if any.
18271 (when (and org-calendar-follow-timestamp-change
18272 (get-buffer-window "*Calendar*" t)
18273 (memq org-ts-what '(day month year)))
18274 (org-recenter-calendar (time-to-days time))))))
18276 (defun org-modify-ts-extra (s pos n dm)
18277 "Change the different parts of the lead-time and repeat fields in timestamp."
18278 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18280 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18282 ((or (org-pos-in-match-range pos 2)
18283 (org-pos-in-match-range pos 3))
18284 (setq m (string-to-number (match-string 3 s))
18285 h (string-to-number (match-string 2 s)))
18286 (if (org-pos-in-match-range pos 2)
18288 (setq n (* dm (with-no-warnings (signum n))))
18289 (unless (= 0 (setq rem (% m dm)))
18290 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18292 (when (< m 0) (setq m (+ m 60) h (1- h)))
18293 (when (> m 59) (setq m (- m 60) h (1+ h)))
18294 (setq h (mod h 24))
18295 (setq ng 1 new (format "-%02d:%02d" h m)))
18296 ((org-pos-in-match-range pos 6)
18297 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18298 ((org-pos-in-match-range pos 5)
18299 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18301 ((org-pos-in-match-range pos 9)
18302 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18303 ((org-pos-in-match-range pos 8)
18304 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18308 (substring s 0 (match-beginning ng))
18310 (substring s (match-end ng))))))
18313 (defun org-recenter-calendar (d)
18314 "If the calendar is visible, recenter it to date D."
18315 (let ((cwin (get-buffer-window "*Calendar*" t)))
18317 (let ((calendar-move-hook nil))
18318 (with-selected-window cwin
18319 (calendar-goto-date
18320 (if (listp d) d (calendar-gregorian-from-absolute d))))))))
18322 (defun org-goto-calendar (&optional arg)
18323 "Go to the Emacs calendar at the current date.
18324 If there is a time stamp in the current line, go to that date.
18325 A prefix ARG can be used to force the current date."
18327 (let ((tsr org-ts-regexp) diff
18328 (calendar-move-hook nil)
18329 (calendar-view-holidays-initially-flag nil)
18330 (calendar-view-diary-initially-flag nil))
18331 (when (or (org-at-timestamp-p)
18333 (beginning-of-line 1)
18334 (looking-at (concat ".*" tsr))))
18335 (let ((d1 (time-to-days (current-time)))
18337 (org-time-string-to-time (match-string 1)))))
18338 (setq diff (- d2 d1))))
18340 (calendar-goto-today)
18341 (when (and diff (not arg)) (calendar-forward-day diff))))
18343 (defun org-get-date-from-calendar ()
18344 "Return a list (month day year) of date at point in calendar."
18345 (with-current-buffer "*Calendar*"
18347 (calendar-cursor-to-date))))
18349 (defun org-date-from-calendar ()
18350 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18351 If there is already a time stamp at the cursor position, update it."
18353 (if (org-at-timestamp-p t)
18354 (org-timestamp-change 0 'calendar)
18355 (let ((cal-date (org-get-date-from-calendar)))
18356 (org-insert-time-stamp
18357 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18359 (defcustom org-effort-durations
18363 ("w" . ,(* 60 8 5))
18364 ("m" . ,(* 60 8 5 4))
18365 ("y" . ,(* 60 8 5 40)))
18366 "Conversion factor to minutes for an effort modifier.
18368 Each entry has the form (MODIFIER . MINUTES).
18370 In an effort string, a number followed by MODIFIER is multiplied
18371 by the specified number of MINUTES to obtain an effort in
18374 For example, if the value of this variable is ((\"hours\" . 60)), then an
18375 effort string \"2hours\" is equivalent to 120 minutes."
18378 :package-version '(Org . "8.3")
18379 :type '(alist :key-type (string :tag "Modifier")
18380 :value-type (number :tag "Minutes")))
18382 (defun org-minutes-to-clocksum-string (m)
18383 "Format number of minutes as a clocksum string.
18384 The format is determined by `org-time-clocksum-format',
18385 `org-time-clocksum-use-fractional' and
18386 `org-time-clocksum-fractional-format' and
18387 `org-time-clocksum-use-effort-durations'."
18388 (let ((clocksum "")
18389 (m (round m)) ; Don't allow fractions of minutes
18391 (setq h (if org-time-clocksum-use-effort-durations
18392 (cdr (assoc "h" org-effort-durations)) 60)
18393 d (if org-time-clocksum-use-effort-durations
18394 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18395 w (if org-time-clocksum-use-effort-durations
18396 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18397 mo (if org-time-clocksum-use-effort-durations
18398 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18399 y (if org-time-clocksum-use-effort-durations
18400 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18401 ;; fractional format
18402 (if org-time-clocksum-use-fractional
18404 ;; single format string
18405 ((stringp org-time-clocksum-fractional-format)
18406 (format org-time-clocksum-fractional-format (/ m (float h))))
18407 ;; choice of fractional formats for different time units
18408 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18409 (> (/ (truncate m) (* y d h)) 0))
18410 (format fmt (/ m (* y d (float h)))))
18411 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18412 (> (/ (truncate m) (* mo d h)) 0))
18413 (format fmt (/ m (* mo d (float h)))))
18414 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18415 (> (/ (truncate m) (* w d h)) 0))
18416 (format fmt (/ m (* w d (float h)))))
18417 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18418 (> (/ (truncate m) (* d h)) 0))
18419 (format fmt (/ m (* d (float h)))))
18420 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18421 (> (/ (truncate m) h) 0))
18422 (format fmt (/ m (float h))))
18423 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18425 ;; fall back to smallest time unit with a format
18426 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18427 (format fmt (/ m (float h))))
18428 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18429 (format fmt (/ m (* d (float h)))))
18430 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18431 (format fmt (/ m (* w d (float h)))))
18432 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18433 (format fmt (/ m (* mo d (float h)))))
18434 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18435 (format fmt (/ m (* y d (float h))))))
18436 ;; standard (non-fractional) format, with single format string
18437 (if (stringp org-time-clocksum-format)
18438 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18439 ;; separate formats components
18440 (and (setq fmt (plist-get org-time-clocksum-format :years))
18441 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18442 (plist-get org-time-clocksum-format :require-years))
18443 (setq clocksum (concat clocksum (format fmt n))
18444 m (- m (* n y d h))))
18445 (and (setq fmt (plist-get org-time-clocksum-format :months))
18446 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18447 (plist-get org-time-clocksum-format :require-months))
18448 (setq clocksum (concat clocksum (format fmt n))
18449 m (- m (* n mo d h))))
18450 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18451 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18452 (plist-get org-time-clocksum-format :require-weeks))
18453 (setq clocksum (concat clocksum (format fmt n))
18454 m (- m (* n w d h))))
18455 (and (setq fmt (plist-get org-time-clocksum-format :days))
18456 (or (> (setq n (/ (truncate m) (* d h))) 0)
18457 (plist-get org-time-clocksum-format :require-days))
18458 (setq clocksum (concat clocksum (format fmt n))
18459 m (- m (* n d h))))
18460 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18461 (or (> (setq n (/ (truncate m) h)) 0)
18462 (plist-get org-time-clocksum-format :require-hours))
18463 (setq clocksum (concat clocksum (format fmt n))
18465 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18466 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18467 (setq clocksum (concat clocksum (format fmt m))))
18468 ;; return formatted time duration
18471 (defun org-hours-to-clocksum-string (n)
18472 (org-minutes-to-clocksum-string (* n 60)))
18474 (defun org-hh:mm-string-to-minutes (s)
18475 "Convert a string H:MM to a number of minutes.
18476 If the string is just a number, interpret it as minutes.
18477 In fact, the first hh:mm or number in the string will be taken,
18478 there can be extra stuff in the string.
18479 If no number is found, the return value is 0."
18482 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18483 (+ (* (string-to-number (match-string 1 s)) 60)
18484 (string-to-number (match-string 2 s))))
18485 ((string-match "\\([0-9]+\\)" s)
18486 (string-to-number (match-string 1 s)))
18489 (defcustom org-image-actual-width t
18490 "Should we use the actual width of images when inlining them?
18492 When set to t, always use the image width.
18494 When set to a number, use imagemagick (when available) to set
18495 the image's width to this value.
18497 When set to a number in a list, try to get the width from any
18498 #+ATTR.* keyword if it matches a width specification like
18500 #+ATTR_HTML: :width 300px
18502 and fall back on that number if none is found.
18504 When set to nil, try to get the width from an #+ATTR.* keyword
18505 and fall back on the original width if none is found.
18507 This requires Emacs >= 24.1, build with imagemagick support."
18508 :group 'org-appearance
18510 :package-version '(Org . "8.0")
18512 (const :tag "Use the image width" t)
18513 (integer :tag "Use a number of pixels")
18514 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18515 (const :tag "Use #+ATTR* or don't resize" nil)))
18517 (defcustom org-agenda-inhibit-startup nil
18518 "Inhibit startup when preparing agenda buffers.
18519 When this variable is t, the initialization of the Org agenda
18520 buffers is inhibited: e.g. the visibility state is not set, the
18521 tables are not re-aligned, etc."
18524 :group 'org-agenda)
18526 (defcustom org-agenda-ignore-properties nil
18527 "Avoid updating text properties when building the agenda.
18528 Properties are used to prepare buffers for effort estimates,
18529 appointments, statistics and subtree-local categories.
18530 If you don't use these in the agenda, you can add them to this
18531 list and agenda building will be a bit faster.
18532 The value is a list, with zero or more of the symbols `effort', `appt',
18533 `stats' or `category'."
18534 :type '(set :greedy t
18540 :package-version '(Org . "8.3")
18541 :group 'org-agenda)
18543 (defun org-duration-string-to-minutes (s &optional output-to-string)
18544 "Convert a duration string S to minutes.
18546 A bare number is interpreted as minutes, modifiers can be set by
18547 customizing `org-effort-durations' (which see).
18549 Entries containing a colon are interpreted as H:MM by
18550 `org-hh:mm-string-to-minutes'."
18552 (re (concat "\\([0-9.]+\\) *\\("
18553 (regexp-opt (mapcar 'car org-effort-durations))
18555 (while (string-match re s)
18556 (cl-incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18557 (string-to-number (match-string 1 s))))
18558 (setq s (replace-match "" nil t s)))
18559 (setq result (floor result))
18560 (cl-incf result (org-hh:mm-string-to-minutes s))
18561 (if output-to-string (number-to-string result) result)))
18565 (defun org-save-all-org-buffers ()
18566 "Save all Org buffers without user confirmation."
18568 (message "Saving all Org buffers...")
18569 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18570 (when (featurep 'org-id) (org-id-locations-save))
18571 (message "Saving all Org buffers... done"))
18573 (defun org-revert-all-org-buffers ()
18574 "Revert all Org buffers.
18575 Prompt for confirmation when there are unsaved changes.
18576 Be sure you know what you are doing before letting this function
18577 overwrite your changes.
18579 This function is useful in a setup where one tracks org files
18580 with a version control system, to revert on one machine after pulling
18581 changes from another. I believe the procedure must be like this:
18583 1. M-x org-save-all-org-buffers
18584 2. Pull changes from the other machine, resolve conflicts
18585 3. M-x org-revert-all-org-buffers"
18587 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18588 (user-error "Abort"))
18590 (save-window-excursion
18591 (dolist (b (buffer-list))
18592 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18593 (with-current-buffer b buffer-file-name))
18594 (pop-to-buffer-same-window b)
18595 (revert-buffer t 'no-confirm)))
18596 (when (and (featurep 'org-id) org-id-track-globally)
18597 (org-id-locations-load)))))
18602 (defun org-switchb (&optional arg)
18603 "Switch between Org buffers.
18605 With `\\[universal-argument]' prefix, restrict available buffers to files.
18607 With `\\[universal-argument] \\[universal-argument]' \
18608 prefix, restrict available buffers to agenda files."
18610 (let ((blist (org-buffer-list
18611 (cond ((equal arg '(4)) 'files)
18612 ((equal arg '(16)) 'agenda)))))
18613 (pop-to-buffer-same-window
18614 (completing-read "Org buffer: "
18615 (mapcar #'list (mapcar #'buffer-name blist))
18618 (defun org-buffer-list (&optional predicate exclude-tmp)
18619 "Return a list of Org buffers.
18620 PREDICATE can be `export', `files' or `agenda'.
18622 export restrict the list to Export buffers.
18623 files restrict the list to buffers visiting Org files.
18624 agenda restrict the list to buffers visiting agenda files.
18626 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18628 (agenda-files (and (eq predicate 'agenda)
18629 (mapcar 'file-truename (org-agenda-files t))))
18632 ((eq predicate 'files)
18633 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18634 ((eq predicate 'export)
18635 (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
18636 ((eq predicate 'agenda)
18638 (with-current-buffer b
18639 (and (derived-mode-p 'org-mode)
18640 (setq bfn (buffer-file-name b))
18641 (member (file-truename bfn) agenda-files)))))
18642 (t (lambda (b) (with-current-buffer b
18643 (or (derived-mode-p 'org-mode)
18644 (string-match "\\*Org .*Export"
18645 (buffer-name b)))))))))
18649 (if (and (funcall filter b)
18650 (or (not exclude-tmp)
18651 (not (string-match "tmp" (buffer-name b)))))
18656 (defun org-agenda-files (&optional unrestricted archives)
18657 "Get the list of agenda files.
18658 Optional UNRESTRICTED means return the full list even if a restriction
18659 is currently in place.
18660 When ARCHIVES is t, include all archive files that are really being
18661 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18662 `org-agenda-archives-mode' is t."
18665 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18666 ((stringp org-agenda-files) (org-read-agenda-file-list))
18667 ((listp org-agenda-files) org-agenda-files)
18668 (t (error "Invalid value of `org-agenda-files'")))))
18669 (setq files (apply 'append
18670 (mapcar (lambda (f)
18671 (if (file-directory-p f)
18673 f t org-agenda-file-regexp)
18676 (when org-agenda-skip-unavailable-files
18677 (setq files (delq nil
18680 (and (file-readable-p file) file)))
18682 (when (or (eq archives t)
18683 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18684 (setq files (org-add-archive-files files)))
18687 (defun org-agenda-file-p (&optional file)
18688 "Return non-nil, if FILE is an agenda file.
18689 If FILE is omitted, use the file associated with the current
18691 (let ((fname (or file (buffer-file-name))))
18693 (member (file-truename fname)
18694 (mapcar #'file-truename (org-agenda-files t))))))
18696 (defun org-edit-agenda-file-list ()
18697 "Edit the list of agenda files.
18698 Depending on setup, this either uses customize to edit the variable
18699 `org-agenda-files', or it visits the file that is holding the list. In the
18700 latter case, the buffer is set up in a way that saving it automatically kills
18701 the buffer and restores the previous window configuration."
18703 (if (stringp org-agenda-files)
18704 (let ((cw (current-window-configuration)))
18705 (find-file org-agenda-files)
18706 (setq-local org-window-configuration cw)
18707 (add-hook 'after-save-hook
18709 (set-window-configuration
18710 (prog1 org-window-configuration
18711 (kill-buffer (current-buffer))))
18712 (org-install-agenda-files-menu)
18713 (message "New agenda file list installed"))
18715 (message "%s" (substitute-command-keys
18716 "Edit list and finish with \\[save-buffer]")))
18717 (customize-variable 'org-agenda-files)))
18719 (defun org-store-new-agenda-file-list (list)
18720 "Set new value for the agenda file list and save it correctly."
18721 (if (stringp org-agenda-files)
18722 (let ((fe (org-read-agenda-file-list t)) b u)
18723 (while (setq b (find-buffer-visiting org-agenda-files))
18725 (with-temp-file org-agenda-files
18728 (lambda (f) ;; Keep un-expanded entries.
18729 (if (setq u (assoc f fe))
18734 (let ((org-mode-hook nil) (org-inhibit-startup t)
18735 (org-insert-mode-line-in-empty-file nil))
18736 (setq org-agenda-files list)
18737 (customize-save-variable 'org-agenda-files org-agenda-files))))
18739 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18740 "Read the list of agenda files from a file.
18741 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18742 filenames, used by `org-store-new-agenda-file-list' to write back
18743 un-expanded file names."
18744 (when (file-directory-p org-agenda-files)
18745 (error "`org-agenda-files' cannot be a single directory"))
18746 (when (stringp org-agenda-files)
18748 (insert-file-contents org-agenda-files)
18751 (let ((e (expand-file-name (substitute-in-file-name f)
18753 (if pair-with-expansion
18756 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18759 (defun org-cycle-agenda-files ()
18760 "Cycle through the files in `org-agenda-files'.
18761 If the current buffer visits an agenda file, find the next one in the list.
18762 If the current buffer does not, find the first agenda file."
18764 (let* ((fs (or (org-agenda-files t)
18765 (user-error "No agenda files")))
18766 (files (copy-sequence fs))
18767 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18770 (while (and (setq file (pop files))
18771 (not (equal (file-truename file) tcf)))))
18772 (find-file (car (or files fs)))
18773 (when (buffer-base-buffer) (pop-to-buffer-same-window (buffer-base-buffer)))))
18775 (defun org-agenda-file-to-front (&optional to-end)
18776 "Move/add the current file to the top of the agenda file list.
18777 If the file is not present in the list, it is added to the front. If it is
18778 present, it is moved there. With optional argument TO-END, add/move to the
18781 (let ((org-agenda-skip-unavailable-files nil)
18782 (file-alist (mapcar (lambda (x)
18783 (cons (file-truename x) x))
18784 (org-agenda-files t)))
18785 (ctf (file-truename
18786 (or buffer-file-name
18787 (user-error "Please save the current buffer to a file"))))
18789 (setq x (assoc ctf file-alist) had x)
18791 (unless x (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18793 (setq file-alist (append (delq x file-alist) (list x)))
18794 (setq file-alist (cons x (delq x file-alist))))
18795 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18796 (org-install-agenda-files-menu)
18797 (message "File %s to %s of agenda file list"
18798 (if had "moved" "added") (if to-end "end" "front"))))
18800 (defun org-remove-file (&optional file)
18801 "Remove current file from the list of files in variable `org-agenda-files'.
18802 These are the files which are being checked for agenda entries.
18803 Optional argument FILE means use this file instead of the current."
18805 (let* ((org-agenda-skip-unavailable-files nil)
18806 (file (or file buffer-file-name
18807 (user-error "Current buffer does not visit a file")))
18808 (true-file (file-truename file))
18809 (afile (abbreviate-file-name file))
18810 (files (delq nil (mapcar
18812 (unless (equal true-file
18815 (org-agenda-files t)))))
18816 (if (not (= (length files) (length (org-agenda-files t))))
18818 (org-store-new-agenda-file-list files)
18819 (org-install-agenda-files-menu)
18820 (message "Removed from Org Agenda list: %s" afile))
18821 (message "File was not in list: %s (not removed)" afile))))
18823 (defun org-file-menu-entry (file)
18824 (vector file (list 'find-file file) t))
18826 (defun org-check-agenda-file (file)
18827 "Make sure FILE exists. If not, ask user what to do."
18828 (unless (file-exists-p file)
18829 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18830 (abbreviate-file-name file))
18831 (let ((r (downcase (read-char-exclusive))))
18834 (org-remove-file file)
18835 (throw 'nextfile t))
18836 (t (user-error "Abort"))))))
18838 (defun org-get-agenda-file-buffer (file)
18839 "Get an agenda buffer visiting FILE.
18840 If the buffer needs to be created, add it to the list of buffers
18841 which might be released later."
18842 (let ((buf (org-find-base-buffer-visiting file)))
18844 buf ; just return it
18845 ;; Make a new buffer and remember it
18846 (setq buf (find-file-noselect file))
18847 (when buf (push buf org-agenda-new-buffers))
18850 (defun org-release-buffers (blist)
18851 "Release all buffers in list, asking the user for confirmation when needed.
18852 When a buffer is unmodified, it is just killed. When modified, it is saved
18853 \(if the user agrees) and then killed."
18855 (dolist (buf blist)
18856 (setq file (buffer-file-name buf))
18857 (when (and (buffer-modified-p buf)
18859 (y-or-n-p (format "Save file %s? " file)))
18860 (with-current-buffer buf (save-buffer)))
18861 (kill-buffer buf))))
18863 (defun org-agenda-prepare-buffers (files)
18864 "Create buffers for all agenda files, protect archived trees and comments."
18866 (let ((pa '(:org-archived t))
18867 (pc '(:org-comment t))
18868 (pall '(:org-archived t :org-comment t))
18869 (inhibit-read-only t)
18870 (org-inhibit-startup org-agenda-inhibit-startup)
18871 (rea (concat ":" org-archive-tag ":"))
18873 (setq org-tag-alist-for-agenda nil
18874 org-tag-groups-alist-for-agenda nil)
18877 (dolist (file files)
18881 (org-check-agenda-file file)
18882 (set-buffer (org-get-agenda-file-buffer file)))
18884 (org-set-regexps-and-options 'tags-only)
18886 (or (memq 'category org-agenda-ignore-properties)
18887 (org-refresh-category-properties))
18888 (or (memq 'stats org-agenda-ignore-properties)
18889 (org-refresh-stats-properties))
18890 (or (memq 'effort org-agenda-ignore-properties)
18891 (org-refresh-effort-properties))
18892 (or (memq 'appt org-agenda-ignore-properties)
18893 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18894 (setq org-todo-keywords-for-agenda
18895 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18896 (setq org-done-keywords-for-agenda
18897 (append org-done-keywords-for-agenda org-done-keywords))
18898 (setq org-todo-keyword-alist-for-agenda
18899 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18900 (setq org-tag-alist-for-agenda
18902 (append org-tag-alist-for-agenda
18903 org-current-tag-alist)))
18904 ;; Merge current file's tag groups into global
18905 ;; `org-tag-groups-alist-for-agenda'.
18906 (when org-group-tags
18907 (dolist (alist org-tag-groups-alist)
18908 (let ((old (assoc (car alist) org-tag-groups-alist-for-agenda)))
18910 (setcdr old (org-uniquify (append (cdr old) (cdr alist))))
18911 (push alist org-tag-groups-alist-for-agenda)))))
18912 (org-with-silent-modifications
18914 (remove-text-properties (point-min) (point-max) pall)
18915 (when org-agenda-skip-archived-trees
18916 (goto-char (point-min))
18917 (while (re-search-forward rea nil t)
18918 (when (org-at-heading-p t)
18919 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18920 (goto-char (point-min))
18921 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18922 (while (re-search-forward re nil t)
18923 (when (save-match-data (org-in-commented-heading-p t))
18924 (add-text-properties
18925 (match-beginning 0) (org-end-of-subtree t) pc)))))
18926 (goto-char pos)))))
18927 (setq org-todo-keywords-for-agenda
18928 (org-uniquify org-todo-keywords-for-agenda))
18929 (setq org-todo-keyword-alist-for-agenda
18930 (org-uniquify org-todo-keyword-alist-for-agenda))))
18933 ;;;; CDLaTeX minor mode
18935 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18936 "Keymap for the minor `org-cdlatex-mode'.")
18938 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18939 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18940 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18941 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18942 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18944 (defvar org-cdlatex-texmathp-advice-is-done nil
18945 "Flag remembering if we have applied the advice to texmathp already.")
18947 (define-minor-mode org-cdlatex-mode
18948 "Toggle the minor `org-cdlatex-mode'.
18949 This mode supports entering LaTeX environment and math in LaTeX fragments
18951 \\{org-cdlatex-mode-map}"
18953 (when org-cdlatex-mode
18955 (run-hooks 'cdlatex-mode-hook)
18956 (cdlatex-compute-tables))
18957 (unless org-cdlatex-texmathp-advice-is-done
18958 (setq org-cdlatex-texmathp-advice-is-done t)
18959 (defadvice texmathp (around org-math-always-on activate)
18960 "Always return t in Org buffers.
18961 This is because we want to insert math symbols without dollars even outside
18962 the LaTeX math segments. If Org mode thinks that point is actually inside
18963 an embedded LaTeX fragment, let `texmathp' do its job.
18964 `\\[org-cdlatex-mode-map]'"
18968 ((not (derived-mode-p 'org-mode)) ad-do-it)
18969 ((eq this-command 'cdlatex-math-symbol)
18970 (setq ad-return-value t
18971 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18973 (let ((p (org-inside-LaTeX-fragment-p)))
18974 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18975 (setq ad-return-value t
18976 texmathp-why '("Org mode embedded math" . 0))
18977 (when p ad-do-it)))))))))
18979 (defun turn-on-org-cdlatex ()
18980 "Unconditionally turn on `org-cdlatex-mode'."
18981 (org-cdlatex-mode 1))
18983 (defun org-try-cdlatex-tab ()
18984 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18985 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18986 - inside a LaTeX fragment, or
18987 - after the first word in a line, where an abbreviation expansion could
18988 insert a LaTeX environment."
18989 (when org-cdlatex-mode
18991 ;; Before any word on the line: No expansion possible.
18992 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18993 ;; Just after first word on the line: Expand it. Make sure it
18994 ;; cannot happen on headlines, though.
18996 (skip-chars-backward "a-zA-Z0-9*")
18997 (skip-chars-backward " \t")
18998 (and (bolp) (not (org-at-heading-p))))
19000 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
19002 (defun org-cdlatex-underscore-caret (&optional _arg)
19003 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
19004 Revert to the normal definition outside of these fragments."
19006 (if (org-inside-LaTeX-fragment-p)
19007 (call-interactively 'cdlatex-sub-superscript)
19008 (let (org-cdlatex-mode)
19009 (call-interactively (key-binding (vector last-input-event))))))
19011 (defun org-cdlatex-math-modify (&optional _arg)
19012 "Execute `cdlatex-math-modify' in LaTeX fragments.
19013 Revert to the normal definition outside of these fragments."
19015 (if (org-inside-LaTeX-fragment-p)
19016 (call-interactively 'cdlatex-math-modify)
19017 (let (org-cdlatex-mode)
19018 (call-interactively (key-binding (vector last-input-event))))))
19020 (defun org-cdlatex-environment-indent (&optional environment item)
19021 "Execute `cdlatex-environment' and indent the inserted environment.
19023 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
19025 The inserted environment is indented to current indentation
19026 unless point is at the beginning of the line, in which the
19027 environment remains unintended."
19029 ;; cdlatex-environment always return nil. Therefore, capture output
19030 ;; first and determine if an environment was selected.
19031 (let* ((beg (point-marker))
19032 (end (copy-marker (point) t))
19034 (ignore-errors (cdlatex-environment environment item))
19036 ;; Figure out how many lines to move forward after the
19037 ;; environment has been inserted.
19038 (lines (when inserted
19040 (- (cl-loop while (< beg (point))
19042 do (forward-line -1)
19045 (if (progn (goto-char beg)
19046 (and (progn (skip-chars-forward " \t") (eolp))
19047 (progn (skip-chars-backward " \t") (bolp))))
19049 (env (org-trim (delete-and-extract-region beg end))))
19051 ;; Get indentation of next line unless at column 0.
19052 (let ((ind (if (bolp) 0
19054 (org-return-indent)
19055 (prog1 (org-get-indentation)
19056 (when (progn (skip-chars-forward " \t") (eolp))
19057 (delete-region beg (point)))))))
19058 (bol (progn (skip-chars-backward " \t") (bolp))))
19059 ;; Insert a newline before environment unless at column zero
19060 ;; to "escape" the current line. Insert a newline if
19061 ;; something is one the same line as \end{ENVIRONMENT}.
19063 (concat (unless bol "\n") env
19064 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
19065 (unless (zerop ind)
19068 (while (< (point) end)
19069 (unless (eolp) (indent-line-to ind))
19072 (forward-line lines)
19073 (indent-line-to ind)))
19074 (set-marker beg nil)
19075 (set-marker end nil)))
19078 ;;;; LaTeX fragments
19080 (defun org-inside-LaTeX-fragment-p ()
19081 "Test if point is inside a LaTeX fragment.
19082 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
19083 sequence appearing also before point.
19084 Even though the matchers for math are configurable, this function assumes
19085 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
19086 delimiters are skipped when they have been removed by customization.
19087 The return value is nil, or a cons cell with the delimiter and the
19088 position of this delimiter.
19090 This function does a reasonably good job, but can locally be fooled by
19091 for example currency specifications. For example it will assume being in
19092 inline math after \"$22.34\". The LaTeX fragment formatter will only format
19093 fragments that are properly closed, but during editing, we have to live
19094 with the uncertainty caused by missing closing delimiters. This function
19095 looks only before point, not after."
19097 (let ((pos (point))
19098 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
19100 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
19102 dd-on str (start 0) m re)
19105 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
19106 re (nth 1 (assoc "$" org-latex-regexps)))
19107 (while (string-match re str start)
19109 ((= (match-end 0) (length str))
19110 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
19111 ((= (match-end 0) (- (length str) 5))
19113 (t (setq start (match-end 0))))))
19114 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
19116 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
19117 (and (match-beginning 2) (throw 'exit nil))
19119 (while (re-search-backward "\\$\\$" lim t)
19120 (setq dd-on (not dd-on)))
19122 (when dd-on (cons "$$" m))))))
19124 (defun org-inside-latex-macro-p ()
19125 "Is point inside a LaTeX macro or its arguments?"
19128 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
19130 (defun org--format-latex-make-overlay (beg end image &optional imagetype)
19131 "Build an overlay between BEG and END using IMAGE file.
19132 Argument IMAGETYPE is the extension of the displayed image,
19133 as a string. It defaults to \"png\"."
19134 (let ((ov (make-overlay beg end))
19135 (imagetype (or (intern imagetype) 'png)))
19136 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
19137 (overlay-put ov 'evaporate t)
19139 'modification-hooks
19140 (list (lambda (o _flag _beg _end &optional _l)
19141 (delete-overlay o))))
19144 (list 'image :type imagetype :file image :ascent 'center))))
19146 (defun org--list-latex-overlays (&optional beg end)
19147 "List all Org LaTeX overlays in current buffer.
19148 Limit to overlays between BEG and END when those are provided."
19150 (lambda (o) (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay))
19151 (overlays-in (or beg (point-min)) (or end (point-max)))))
19153 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
19154 "Remove all overlays with LaTeX fragment images in current buffer.
19155 When optional arguments BEG and END are non-nil, remove all
19156 overlays between them instead. Return a non-nil value when some
19157 overlays were removed, nil otherwise."
19158 (let ((overlays (org--list-latex-overlays beg end)))
19159 (mapc #'delete-overlay overlays)
19162 (defun org-toggle-latex-fragment (&optional arg)
19163 "Preview the LaTeX fragment at point, or all locally or globally.
19165 If the cursor is on a LaTeX fragment, create the image and overlay
19166 it over the source code, if there is none. Remove it otherwise.
19167 If there is no fragment at point, display all fragments in the
19170 With prefix ARG, preview or clear image for all fragments in the
19171 current subtree or in the whole buffer when used before the first
19172 headline. With a prefix ARG `\\[universal-argument] \
19173 \\[universal-argument]' preview or clear images
19174 for all fragments in the buffer."
19176 (when (display-graphic-p)
19181 ((or (equal arg '(16))
19182 (and (equal arg '(4))
19183 (org-with-limited-levels (org-before-first-heading-p))))
19184 (if (org-remove-latex-fragment-image-overlays)
19185 (progn (message "LaTeX fragments images removed from buffer")
19187 (setq msg "Creating images for buffer...")))
19189 (org-with-limited-levels (org-back-to-heading t))
19191 (setq end (progn (org-end-of-subtree t) (point)))
19192 (if (org-remove-latex-fragment-image-overlays beg end)
19194 (message "LaTeX fragment images removed from subtree")
19196 (setq msg "Creating images for subtree...")))
19197 ((let ((datum (org-element-context)))
19198 (when (memq (org-element-type datum)
19199 '(latex-environment latex-fragment))
19200 (setq beg (org-element-property :begin datum))
19201 (setq end (org-element-property :end datum))
19202 (if (org-remove-latex-fragment-image-overlays beg end)
19203 (progn (message "LaTeX fragment image removed")
19205 (setq msg "Creating image...")))))
19207 (org-with-limited-levels
19208 (setq beg (if (org-at-heading-p) (line-beginning-position)
19209 (outline-previous-heading)
19211 (setq end (progn (outline-next-heading) (point)))
19212 (if (org-remove-latex-fragment-image-overlays beg end)
19214 (message "LaTeX fragment images removed from section")
19216 (setq msg "Creating images for section...")))))
19217 (let ((file (buffer-file-name (buffer-base-buffer))))
19219 (concat org-preview-latex-image-directory "org-ltximg")
19221 ;; Emacs cannot overlay images from remote hosts. Create
19222 ;; it in `temporary-file-directory' instead.
19223 (if (or (not file) (file-remote-p file))
19224 temporary-file-directory
19226 'overlays msg 'forbuffer org-preview-latex-default-process))
19227 (message (concat msg "done")))))))
19229 (defun org-format-latex
19230 (prefix &optional beg end dir overlays msg forbuffer processing-type)
19231 "Replace LaTeX fragments with links to an image.
19233 The function takes care of creating the replacement image.
19235 Only consider fragments between BEG and END when those are
19238 When optional argument OVERLAYS is non-nil, display the image on
19239 top of the fragment instead of replacing it.
19241 PROCESSING-TYPE is the conversion method to use, as a symbol.
19243 Some of the options can be changed using the variable
19244 `org-format-latex-options', which see."
19245 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19246 (unless (eq processing-type 'verbatim)
19247 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19250 (goto-char (or beg (point-min)))
19251 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19252 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19253 (overlay-recenter (or end (point-max))))
19254 (while (re-search-forward math-regexp end t)
19255 (unless (and overlays
19256 (eq (get-char-property (point) 'org-overlay-type)
19257 'org-latex-overlay))
19258 (let* ((context (org-element-context))
19259 (type (org-element-type context)))
19260 (when (memq type '(latex-environment latex-fragment))
19261 (let ((block-type (eq type 'latex-environment))
19262 (value (org-element-property :value context))
19263 (beg (org-element-property :begin context))
19264 (end (save-excursion
19265 (goto-char (org-element-property :end context))
19266 (skip-chars-backward " \r\t\n")
19269 ((eq processing-type 'mathjax)
19270 ;; Prepare for MathJax processing.
19271 (if (not (string-match "\\`\\$\\$?" value))
19273 (delete-region beg end)
19274 (if (string= (match-string 0 value) "$$")
19275 (insert "\\[" (substring value 2 -2) "\\]")
19276 (insert "\\(" (substring value 1 -1) "\\)"))))
19277 ((assq processing-type org-preview-latex-process-alist)
19278 ;; Process to an image.
19281 (let* ((processing-info
19282 (cdr (assq processing-type org-preview-latex-process-alist)))
19283 (face (face-at-point))
19284 ;; Get the colors from the face at point.
19286 (let ((color (plist-get org-format-latex-options
19288 (if (and forbuffer (eq color 'auto))
19289 (face-attribute face :foreground nil 'default)
19292 (let ((color (plist-get org-format-latex-options
19294 (if (and forbuffer (eq color 'auto))
19295 (face-attribute face :background nil 'default)
19297 (hash (sha1 (prin1-to-string
19298 (list org-format-latex-header
19299 org-latex-default-packages-alist
19300 org-latex-packages-alist
19301 org-format-latex-options
19302 forbuffer value fg bg))))
19303 (imagetype (or (plist-get processing-info :image-output-type) "png"))
19304 (absprefix (expand-file-name prefix dir))
19305 (linkfile (format "%s_%s.%s" prefix hash imagetype))
19306 (movefile (format "%s_%s.%s" absprefix hash imagetype))
19307 (sep (and block-type "\n\n"))
19308 (link (concat sep "[[file:" linkfile "]]" sep))
19310 (org-combine-plists
19311 org-format-latex-options
19312 `(:foreground ,fg :background ,bg))))
19313 (when msg (message msg cnt))
19314 (unless checkdir-flag ; Ensure the directory exists.
19315 (setq checkdir-flag t)
19316 (let ((todir (file-name-directory absprefix)))
19317 (unless (file-directory-p todir)
19318 (make-directory todir t))))
19319 (unless (file-exists-p movefile)
19320 (org-create-formula-image
19321 value movefile options forbuffer processing-type))
19324 (dolist (o (overlays-in beg end))
19325 (when (eq (overlay-get o 'org-overlay-type)
19326 'org-latex-overlay)
19327 (delete-overlay o)))
19328 (org--format-latex-make-overlay beg end movefile imagetype)
19330 (delete-region beg end)
19332 (org-add-props link
19333 (list 'org-latex-src
19334 (replace-regexp-in-string "\"" "" value)
19335 'org-latex-src-embed-type
19336 (if block-type 'paragraph 'character)))))))
19337 ((eq processing-type 'mathml)
19338 ;; Process to MathML.
19339 (unless (org-format-latex-mathml-available-p)
19340 (user-error "LaTeX to MathML converter not configured"))
19342 (when msg (message msg cnt))
19344 (delete-region beg end)
19345 (insert (org-format-latex-as-mathml
19346 value block-type prefix dir)))
19348 (error "Unknown conversion process %s for LaTeX fragments"
19349 processing-type)))))))))))
19351 (defun org-create-math-formula (latex-frag &optional mathml-file)
19352 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19353 Use `org-latex-to-mathml-convert-command'. If the conversion is
19354 sucessful, return the portion between \"<math...> </math>\"
19355 elements otherwise return nil. When MATHML-FILE is specified,
19356 write the results in to that file. When invoked as an
19357 interactive command, prompt for LATEX-FRAG, with initial value
19358 set to the current active region and echo the results for user
19360 (interactive (list (let ((frag (when (org-region-active-p)
19361 (buffer-substring-no-properties
19362 (region-beginning) (region-end)))))
19363 (read-string "LaTeX Fragment: " frag nil frag))))
19364 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19365 (let* ((tmp-in-file
19366 (let ((file (file-relative-name
19367 (make-temp-name (expand-file-name "ltxmathml-in")))))
19368 (write-region latex-frag nil file)
19370 (tmp-out-file (file-relative-name
19371 (make-temp-name (expand-file-name "ltxmathml-out"))))
19373 org-latex-to-mathml-convert-command
19374 `((?j . ,(and org-latex-to-mathml-jar-file
19375 (shell-quote-argument
19377 org-latex-to-mathml-jar-file))))
19378 (?I . ,(shell-quote-argument tmp-in-file))
19380 (?o . ,(shell-quote-argument tmp-out-file)))))
19381 mathml shell-command-output)
19382 (when (called-interactively-p 'any)
19383 (unless (org-format-latex-mathml-available-p)
19384 (user-error "LaTeX to MathML converter not configured")))
19385 (message "Running %s" cmd)
19386 (setq shell-command-output (shell-command-to-string cmd))
19388 (when (file-readable-p tmp-out-file)
19389 (with-current-buffer (find-file-noselect tmp-out-file t)
19390 (goto-char (point-min))
19391 (when (re-search-forward
19392 (format "<math[^>]*?%s[^>]*?>\\(.\\|\n\\)*</math>"
19394 "xmlns=\"http://www.w3.org/1998/Math/MathML\""))
19396 (prog1 (match-string 0) (kill-buffer))))))
19400 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19402 (write-region mathml nil mathml-file))
19403 (when (called-interactively-p 'any)
19405 ((message "LaTeX to MathML conversion failed")
19406 (message shell-command-output)))
19407 (delete-file tmp-in-file)
19408 (when (file-exists-p tmp-out-file)
19409 (delete-file tmp-out-file))
19412 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19413 prefix &optional dir)
19414 "Use `org-create-math-formula' but check local cache first."
19415 (let* ((absprefix (expand-file-name prefix dir))
19416 (print-length nil) (print-level nil)
19417 (formula-id (concat
19422 org-latex-to-mathml-convert-command)))))
19423 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19424 (formula-cache-dir (file-name-directory formula-cache)))
19426 (unless (file-directory-p formula-cache-dir)
19427 (make-directory formula-cache-dir t))
19429 (unless (file-exists-p formula-cache)
19430 (org-create-math-formula latex-frag formula-cache))
19432 (if (file-exists-p formula-cache)
19433 ;; Successful conversion. Return the link to MathML file.
19435 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19436 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19437 'org-latex-src-embed-type (if latex-frag-type
19438 'paragraph 'character)))
19439 ;; Failed conversion. Return the LaTeX fragment verbatim
19442 (defun org--get-display-dpi ()
19443 "Get the DPI of the display.
19444 The function assumes that the display has the same pixel width in
19445 the horizontal and vertical directions."
19446 (if (display-graphic-p)
19447 (round (/ (display-pixel-height)
19448 (/ (display-mm-height) 25.4)))
19449 (error "Attempt to calculate the dpi of a non-graphic display")))
19451 (defun org-create-formula-image
19452 (string tofile options buffer &optional processing-type)
19453 "Create an image from LaTeX source using external processes.
19455 The LaTeX STRING is saved to a temporary LaTeX file, then
19456 converted to an image file by process PROCESSING-TYPE defined in
19457 `org-preview-latex-process-alist'. A nil value defaults to
19458 `org-preview-latex-default-process'.
19460 The generated image file is eventually moved to TOFILE.
19462 The OPTIONS argument controls the size, foreground color and
19463 background color of the generated image.
19465 When BUFFER non-nil, this function is used for LaTeX previewing.
19466 Otherwise, it is used to deal with LaTeX snippets showed in
19468 (let* ((processing-type (or processing-type
19469 org-preview-latex-default-process))
19471 (cdr (assq processing-type org-preview-latex-process-alist)))
19472 (programs (plist-get processing-info :programs))
19473 (error-message (or (plist-get processing-info :message) ""))
19474 (use-xcolor (plist-get processing-info :use-xcolor))
19475 (image-input-type (plist-get processing-info :image-input-type))
19476 (image-output-type (plist-get processing-info :image-output-type))
19477 (post-clean (or (plist-get processing-info :post-clean)
19478 '(".dvi" ".xdv" ".pdf" ".tex" ".aux" ".log"
19479 ".svg" ".png" ".jpg" ".jpeg" ".out")))
19481 (or (plist-get processing-info :latex-header)
19482 (org-latex-make-preamble
19483 (org-export-get-environment (org-export-get-backend 'latex))
19484 org-format-latex-header
19486 (latex-compiler (plist-get processing-info :latex-compiler))
19487 (image-converter (plist-get processing-info :image-converter))
19488 (tmpdir temporary-file-directory)
19489 (texfilebase (make-temp-name
19490 (expand-file-name "orgtex" tmpdir)))
19491 (texfile (concat texfilebase ".tex"))
19492 (image-size-adjust (or (plist-get processing-info :image-size-adjust)
19494 (scale (* (if buffer (car image-size-adjust) (cdr image-size-adjust))
19495 (or (plist-get options (if buffer :scale :html-scale)) 1.0)))
19496 (dpi (* scale (if buffer (org--get-display-dpi) 140.0)))
19497 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19499 (bg (or (plist-get options (if buffer :background :html-background))
19501 (log-buf (get-buffer-create "*Org Preview LaTeX Output*"))
19502 (resize-mini-windows nil)) ;Fix Emacs flicker when creating image.
19503 (dolist (program programs)
19504 (org-check-external-command program error-message))
19506 (progn (if (eq fg 'default)
19507 (setq fg (org-latex-color :foreground))
19508 (setq fg (org-latex-color-format fg)))
19509 (if (eq bg 'default)
19510 (setq bg (org-latex-color :background))
19511 (setq bg (org-latex-color-format
19512 (if (string= bg "Transparent") "white" bg))))
19513 (with-temp-file texfile
19514 (insert latex-header)
19515 (insert "\n\\begin{document}\n"
19516 "\\definecolor{fg}{rgb}{" fg "}\n"
19517 "\\definecolor{bg}{rgb}{" bg "}\n"
19518 "\n\\pagecolor{bg}\n"
19522 "\n\\end{document}\n")))
19523 (if (eq fg 'default)
19524 (setq fg (org-dvipng-color :foreground))
19525 (unless (string= fg "Transparent")
19526 (setq fg (org-dvipng-color-format fg))))
19527 (if (eq bg 'default)
19528 (setq bg (org-dvipng-color :background))
19529 (unless (string= bg "Transparent")
19530 (setq bg (org-dvipng-color-format bg))))
19531 (with-temp-file texfile
19532 (insert latex-header)
19533 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19535 (let* ((err-msg (format "Please adjust '%s' part of \
19536 `org-preview-latex-process-alist'."
19540 texfile latex-compiler image-input-type err-msg log-buf))
19543 image-input-file image-converter image-output-type err-msg log-buf
19544 `((?F . ,(shell-quote-argument fg))
19545 (?B . ,(shell-quote-argument bg))
19546 (?D . ,(shell-quote-argument (format "%s" dpi)))
19547 (?S . ,(shell-quote-argument (format "%s" (/ dpi 140.0))))))))
19548 (copy-file image-output-file tofile 'replace)
19549 (dolist (e post-clean)
19550 (when (file-exists-p (concat texfilebase e))
19551 (delete-file (concat texfilebase e))))
19552 image-output-file)))
19554 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19555 "Fill a LaTeX header template TPL.
19556 In the template, the following place holders will be recognized:
19558 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19559 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19560 [PACKAGES] \\usepackage statements for PKG
19561 [NO-PACKAGES] do not include PKG
19562 [EXTRA] the string EXTRA
19563 [NO-EXTRA] do not include EXTRA
19565 For backward compatibility, if both the positive and the negative place
19566 holder is missing, the positive one (without the \"NO-\") will be
19567 assumed to be present at the end of the template.
19568 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19570 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19571 (let (rpl (end ""))
19572 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19573 (setq rpl (if (or (match-end 1) (not def-pkg))
19574 "" (org-latex-packages-to-string def-pkg snippets-p t))
19575 tpl (replace-match rpl t t tpl))
19576 (when def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19578 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19579 (setq rpl (if (or (match-end 1) (not pkg))
19580 "" (org-latex-packages-to-string pkg snippets-p t))
19581 tpl (replace-match rpl t t tpl))
19582 (when pkg (setq end
19584 (org-latex-packages-to-string pkg snippets-p)))))
19586 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19587 (setq rpl (if (or (match-end 1) (not extra))
19588 "" (concat extra "\n"))
19589 tpl (replace-match rpl t t tpl))
19590 (when (and extra (string-match "\\S-" extra))
19591 (setq end (concat end "\n" extra))))
19593 (if (string-match "\\S-" end)
19594 (concat tpl "\n" end)
19597 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19598 "Turn an alist of packages into a string with the \\usepackage macros."
19599 (setq pkg (mapconcat (lambda(p)
19602 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19603 (format "%% Package %s omitted" (cadr p)))
19604 ((equal "" (car p))
19605 (format "\\usepackage{%s}" (cadr p)))
19607 (format "\\usepackage[%s]{%s}"
19608 (car p) (cadr p)))))
19611 (if newline (concat pkg "\n") pkg))
19613 (defun org-dvipng-color (attr)
19614 "Return a RGB color specification for dvipng."
19615 (org-dvipng-color-format (face-attribute 'default attr nil)))
19617 (defun org-dvipng-color-format (color-name)
19618 "Convert COLOR-NAME to a RGB color value for dvipng."
19619 (apply #'format "rgb %s %s %s"
19620 (mapcar 'org-normalize-color
19621 (color-values color-name))))
19623 (defun org-latex-color (attr)
19624 "Return a RGB color for the LaTeX color package."
19625 (org-latex-color-format (face-attribute 'default attr nil)))
19627 (defun org-latex-color-format (color-name)
19628 "Convert COLOR-NAME to a RGB color value."
19629 (apply #'format "%s,%s,%s"
19630 (mapcar 'org-normalize-color
19631 (color-values color-name))))
19633 (defun org-normalize-color (value)
19634 "Return string to be used as color value for an RGB component."
19635 (format "%g" (/ value 65535.0)))
19641 (defvar-local org-inline-image-overlays nil)
19643 (defun org-toggle-inline-images (&optional include-linked)
19644 "Toggle the display of inline images.
19645 INCLUDE-LINKED is passed to `org-display-inline-images'."
19647 (if org-inline-image-overlays
19649 (org-remove-inline-images)
19650 (when (called-interactively-p 'interactive)
19651 (message "Inline image display turned off")))
19652 (org-display-inline-images include-linked)
19653 (when (called-interactively-p 'interactive)
19654 (message (if org-inline-image-overlays
19655 (format "%d images displayed inline"
19656 (length org-inline-image-overlays))
19657 "No images to display inline")))))
19659 (defun org-redisplay-inline-images ()
19660 "Refresh the display of inline images."
19662 (if (not org-inline-image-overlays)
19663 (org-toggle-inline-images)
19664 (org-toggle-inline-images)
19665 (org-toggle-inline-images)))
19667 (defun org-display-inline-images (&optional include-linked refresh beg end)
19668 "Display inline images.
19670 An inline image is a link which follows either of these
19673 1. Its path is a file with an extension matching return value
19674 from `image-file-name-regexp' and it has no contents.
19676 2. Its description consists in a single link of the previous
19679 When optional argument INCLUDE-LINKED is non-nil, also links with
19680 a text description part will be inlined. This can be nice for
19681 a quick look at those images, but it does not reflect what
19682 exported files will look like.
19684 When optional argument REFRESH is non-nil, refresh existing
19685 images between BEG and END. This will create new image displays
19686 only if necessary. BEG and END default to the buffer
19689 (when (display-graphic-p)
19691 (org-remove-inline-images)
19692 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19693 (org-with-wide-buffer
19694 (goto-char (or beg (point-min)))
19695 (let ((case-fold-search t)
19696 (file-extension-re (image-file-name-regexp)))
19697 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19698 (let ((link (save-match-data (org-element-context))))
19699 ;; Check if we're at an inline image.
19700 (when (and (equal (org-element-property :type link) "file")
19702 (not (org-element-property :contents-begin link)))
19703 (let ((parent (org-element-property :parent link)))
19704 (or (not (eq (org-element-type parent) 'link))
19705 (not (cdr (org-element-contents parent)))))
19706 (string-match-p file-extension-re
19707 (org-element-property :path link)))
19708 (let ((file (expand-file-name
19710 (org-element-property :path link)))))
19711 (when (file-exists-p file)
19713 ;; Apply `org-image-actual-width' specifications.
19715 ((not (image-type-available-p 'imagemagick)) nil)
19716 ((eq org-image-actual-width t) nil)
19717 ((listp org-image-actual-width)
19719 ;; First try to find a width among
19720 ;; attributes associated to the paragraph
19721 ;; containing link.
19724 (while (and (setq e (org-element-property
19726 (not (eq (org-element-type e)
19731 (goto-char (org-element-property :begin paragraph))
19734 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19735 (org-element-property
19736 :post-affiliated paragraph)
19738 (string-to-number (match-string 1))))))
19739 ;; Otherwise, fall-back to provided number.
19740 (car org-image-actual-width)))
19741 ((numberp org-image-actual-width)
19742 org-image-actual-width)))
19743 (old (get-char-property-and-overlay
19744 (org-element-property :begin link)
19745 'org-image-overlay)))
19746 (if (and (car-safe old) refresh)
19747 (image-refresh (overlay-get (cdr old) 'display))
19748 (let ((image (create-image file
19749 (and width 'imagemagick)
19754 ;; If inline image is the description
19755 ;; of another link, be sure to
19756 ;; consider the latter as the one to
19757 ;; apply the overlay on.
19759 (org-element-property :parent link)))
19760 (if (eq (org-element-type parent) 'link)
19764 (org-element-property :begin link)
19767 (org-element-property :end link))
19768 (skip-chars-backward " \t")
19770 (overlay-put ov 'display image)
19771 (overlay-put ov 'face 'default)
19772 (overlay-put ov 'org-image-overlay t)
19774 ov 'modification-hooks
19775 (list 'org-display-inline-remove-overlay))
19776 (push ov org-inline-image-overlays)))))))))))))))
19778 (defun org-display-inline-remove-overlay (ov after _beg _end &optional _len)
19779 "Remove inline-display overlay if a corresponding region is modified."
19780 (let ((inhibit-modification-hooks t))
19781 (when (and ov after)
19782 (delete ov org-inline-image-overlays)
19783 (delete-overlay ov))))
19785 (defun org-remove-inline-images ()
19786 "Remove inline display of images."
19788 (mapc #'delete-overlay org-inline-image-overlays)
19789 (setq org-inline-image-overlays nil))
19793 ;; Outline functions from `outline-mode-prefix-map'
19794 ;; that can be remapped in Org:
19795 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19796 (define-key org-mode-map [remap outline-show-subtree] 'org-show-subtree)
19797 (define-key org-mode-map [remap outline-forward-same-level]
19798 'org-forward-heading-same-level)
19799 (define-key org-mode-map [remap outline-backward-same-level]
19800 'org-backward-heading-same-level)
19801 (define-key org-mode-map [remap outline-show-branches]
19802 'org-kill-note-or-show-branches)
19803 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19804 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19805 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19806 (define-key org-mode-map [remap outline-next-visible-heading]
19807 'org-next-visible-heading)
19808 (define-key org-mode-map [remap outline-previous-visible-heading]
19809 'org-previous-visible-heading)
19810 (define-key org-mode-map [remap show-children] 'org-show-children)
19812 ;; Outline functions from `outline-mode-prefix-map' that can not
19813 ;; be remapped in Org:
19815 ;; - the column "key binding" shows whether the Outline function is still
19816 ;; available in Org mode on the same key that it has been bound to in
19818 ;; - "overridden": key used for a different functionality in Org mode
19819 ;; - else: key still bound to the same Outline function in Org mode
19821 ;; | Outline function | key binding | Org replacement |
19822 ;; |------------------------------------+-------------+--------------------------|
19823 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19824 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19825 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19826 ;; | `show-entry' | overridden | no replacement |
19827 ;; | `show-branches' | `C-c C-k' | still same function |
19828 ;; | `show-subtree' | overridden | visibility cycling |
19829 ;; | `show-all' | overridden | no replacement |
19830 ;; | `hide-subtree' | overridden | visibility cycling |
19831 ;; | `hide-body' | overridden | no replacement |
19832 ;; | `hide-entry' | overridden | visibility cycling |
19833 ;; | `hide-leaves' | overridden | no replacement |
19834 ;; | `hide-sublevels' | overridden | no replacement |
19835 ;; | `hide-other' | overridden | no replacement |
19837 ;; Make `C-c C-x' a prefix key
19838 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19840 ;; TAB key with modifiers
19841 (org-defkey org-mode-map "\C-i" 'org-cycle)
19842 (org-defkey org-mode-map [(tab)] 'org-cycle)
19843 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19844 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19845 ;; The following line is necessary under Suse GNU/Linux
19846 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab)
19847 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19848 (define-key org-mode-map [backtab] 'org-shifttab)
19850 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19851 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19852 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19854 ;; Cursor keys with modifiers
19855 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19856 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19857 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19858 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19860 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19861 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19862 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19863 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19864 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19865 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19867 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19868 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19869 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19870 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19872 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19873 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19874 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19875 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19878 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19879 (dolist (pair org-babel-key-bindings)
19880 (define-key org-babel-map (car pair) (cdr pair)))
19882 ;;; Extra keys for tty access.
19883 ;; We only set them when really needed because otherwise the
19884 ;; menus don't show the simple keys
19886 (when (or org-use-extra-keys (not window-system))
19887 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19888 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19889 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19890 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19891 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19892 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19893 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19894 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19895 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19896 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19897 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19898 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19899 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19900 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19901 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19902 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19903 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19904 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19905 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19906 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19907 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19908 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19909 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19910 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19911 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19912 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19913 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19914 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19916 ;; All the other keys
19918 (org-defkey org-mode-map "\C-c\C-a" 'outline-show-all) ; in case allout messed up.
19919 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19920 (if (boundp 'narrow-map)
19921 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19922 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19923 (if (boundp 'narrow-map)
19924 (org-defkey narrow-map "b" 'org-narrow-to-block)
19925 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19926 (if (boundp 'narrow-map)
19927 (org-defkey narrow-map "e" 'org-narrow-to-element)
19928 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19929 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19930 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19931 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19932 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19933 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19934 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19935 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19936 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19937 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19938 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19939 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19940 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19941 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19942 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19943 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19944 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19945 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19946 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19947 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19948 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19949 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19950 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19951 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19952 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19953 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19954 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19955 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19956 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19957 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19958 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19959 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19960 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19961 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19962 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19963 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19964 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19965 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19966 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19967 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19968 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19969 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19970 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19971 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19972 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19973 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19974 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19975 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19976 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19977 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19978 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19979 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19980 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19981 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19982 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19983 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19984 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19985 (org-defkey org-mode-map "\C-c^" 'org-sort)
19986 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19987 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19988 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19989 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19990 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19991 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19992 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19993 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19994 (org-defkey org-mode-map "\C-m" 'org-return)
19995 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19996 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19997 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19998 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19999 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
20000 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
20001 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
20002 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
20003 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
20004 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
20005 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
20006 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
20007 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
20008 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
20009 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
20010 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
20011 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
20012 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
20013 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
20014 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
20015 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
20016 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
20017 (org-defkey org-mode-map "\M-h" 'org-mark-element)
20018 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
20019 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
20021 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
20022 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
20023 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
20025 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
20026 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
20027 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
20028 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
20029 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
20030 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
20031 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
20032 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
20033 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
20034 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
20035 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
20036 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
20037 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
20038 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
20039 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
20040 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
20041 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
20042 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
20043 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
20044 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
20045 (org-defkey org-mode-map "\C-c\C-xi" 'org-columns-insert-dblock)
20046 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
20048 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
20049 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
20050 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
20051 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
20052 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
20054 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
20056 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
20058 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
20059 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
20061 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
20064 (defconst org-speed-commands-default
20066 ("Outline Navigation")
20067 ("n" . (org-speed-move-safe 'org-next-visible-heading))
20068 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
20069 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
20070 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
20071 ("F" . org-next-block)
20072 ("B" . org-previous-block)
20073 ("u" . (org-speed-move-safe 'outline-up-heading))
20075 ("g" . (org-refile t))
20076 ("Outline Visibility")
20078 ("C" . org-shifttab)
20079 (" " . org-display-outline-path)
20080 ("s" . org-narrow-to-subtree)
20081 ("=" . org-columns)
20082 ("Outline Structure Editing")
20084 ("D" . org-metadown)
20085 ("r" . org-metaright)
20086 ("l" . org-metaleft)
20087 ("R" . org-shiftmetaright)
20088 ("L" . org-shiftmetaleft)
20089 ("i" . (progn (forward-char 1) (call-interactively
20090 'org-insert-heading-respect-content)))
20093 ("a" . org-archive-subtree-default-with-confirmation)
20094 ("@" . org-mark-subtree)
20095 ("#" . org-toggle-comment)
20097 ("I" . org-clock-in)
20098 ("O" . org-clock-out)
20099 ("Meta Data Editing")
20101 ("," . (org-priority))
20102 ("0" . (org-priority ?\ ))
20103 ("1" . (org-priority ?A))
20104 ("2" . (org-priority ?B))
20105 ("3" . (org-priority ?C))
20106 (":" . org-set-tags-command)
20107 ("e" . org-set-effort)
20108 ("E" . org-inc-effort)
20109 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20110 (org-entry-put (point) "APPT_WARNTIME" m)))
20111 ("Agenda Views etc")
20113 ("/" . org-sparse-tree)
20115 ("o" . org-open-at-point)
20116 ("?" . org-speed-command-help)
20117 ("<" . (org-agenda-set-restriction-lock 'subtree))
20118 (">" . (org-agenda-remove-restriction-lock))
20120 "The default speed commands.")
20122 (defun org-print-speed-command (e)
20123 (if (> (length (car e)) 1)
20128 (princ (make-string (length (car e)) ?-))
20132 (if (symbolp (cdr e))
20133 (princ (symbol-name (cdr e)))
20137 (defun org-speed-command-help ()
20138 "Show the available speed commands."
20140 (if (not org-use-speed-commands)
20141 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20142 (with-output-to-temp-buffer "*Help*"
20143 (princ "User-defined Speed commands\n===========================\n")
20144 (mapc #'org-print-speed-command org-speed-commands-user)
20146 (princ "Built-in Speed commands\n=======================\n")
20147 (mapc #'org-print-speed-command org-speed-commands-default))
20148 (with-current-buffer "*Help*"
20149 (setq truncate-lines t))))
20151 (defun org-speed-move-safe (cmd)
20152 "Execute CMD, but make sure that the cursor always ends up in a headline.
20153 If not, return to the original position and throw an error."
20155 (let ((pos (point)))
20156 (call-interactively cmd)
20157 (unless (and (bolp) (org-at-heading-p))
20159 (error "Boundary reached while executing %s" cmd))))
20161 (defvar org-self-insert-command-undo-counter 0)
20163 (defvar org-table-auto-blank-field) ; defined in org-table.el
20164 (defvar org-speed-command nil)
20166 (defun org-speed-command-activate (keys)
20167 "Hook for activating single-letter speed commands.
20168 `org-speed-commands-default' specifies a minimal command set.
20169 Use `org-speed-commands-user' for further customization."
20170 (when (or (and (bolp) (looking-at org-outline-regexp))
20171 (and (functionp org-use-speed-commands)
20172 (funcall org-use-speed-commands)))
20173 (cdr (assoc keys (append org-speed-commands-user
20174 org-speed-commands-default)))))
20176 (defun org-babel-speed-command-activate (keys)
20177 "Hook for activating single-letter code block commands."
20178 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20179 (cdr (assoc keys org-babel-key-bindings))))
20181 (defcustom org-speed-command-hook
20182 '(org-speed-command-default-hook org-babel-speed-command-hook)
20183 "Hook for activating speed commands at strategic locations.
20184 Hook functions are called in sequence until a valid handler is
20187 Each hook takes a single argument, a user-pressed command key
20188 which is also a `self-insert-command' from the global map.
20190 Within the hook, examine the cursor position and the command key
20191 and return nil or a valid handler as appropriate. Handler could
20192 be one of an interactive command, a function, or a form.
20194 Set `org-use-speed-commands' to non-nil value to enable this
20195 hook. The default setting is `org-speed-command-activate'."
20196 :group 'org-structure
20200 (defun org-self-insert-command (N)
20201 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20202 If the cursor is in a table looking at whitespace, the whitespace is
20203 overwritten, and the table is not marked as requiring realignment."
20205 (org-check-before-invisible-edit 'insert)
20207 ((and org-use-speed-commands
20208 (let ((kv (this-command-keys-vector)))
20209 (setq org-speed-command
20210 (run-hook-with-args-until-success
20211 'org-speed-command-hook
20212 (make-string 1 (aref kv (1- (length kv))))))))
20214 ((commandp org-speed-command)
20215 (setq this-command org-speed-command)
20216 (call-interactively org-speed-command))
20217 ((functionp org-speed-command)
20218 (funcall org-speed-command))
20219 ((and org-speed-command (listp org-speed-command))
20220 (eval org-speed-command))
20221 (t (let (org-use-speed-commands)
20222 (call-interactively 'org-self-insert-command)))))
20226 ;; Check if we blank the field, and if that triggers align.
20227 (and (featurep 'org-table) org-table-auto-blank-field
20229 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20230 (if (or (eq (char-after) ?\s) (looking-at "[^|\n]* |"))
20231 ;; Got extra space, this field does not determine
20233 (let (org-table-may-need-update) (org-table-blank-field))
20234 ;; No extra space, this field may determine column
20236 (org-table-blank-field)))
20239 (looking-at "[^|\n]* \\( \\)|"))
20240 ;; There is room for insertion without re-aligning the table.
20241 (delete-region (match-beginning 1) (match-end 1))
20242 (self-insert-command N))
20244 (setq org-table-may-need-update t)
20245 (self-insert-command N)
20246 (org-fix-tags-on-the-fly)
20247 (when org-self-insert-cluster-for-undo
20248 (if (not (eq last-command 'org-self-insert-command))
20249 (setq org-self-insert-command-undo-counter 1)
20250 (if (>= org-self-insert-command-undo-counter 20)
20251 (setq org-self-insert-command-undo-counter 1)
20252 (and (> org-self-insert-command-undo-counter 0)
20253 buffer-undo-list (listp buffer-undo-list)
20254 (not (cadr buffer-undo-list)) ; remove nil entry
20255 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20256 (setq org-self-insert-command-undo-counter
20257 (1+ org-self-insert-command-undo-counter))))))))
20259 (defun org-check-before-invisible-edit (kind)
20260 "Check is editing if kind KIND would be dangerous with invisible text around.
20261 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20262 ;; First, try to get out of here as quickly as possible, to reduce overhead
20263 (when (and org-catch-invisible-edits
20264 (or (not (boundp 'visible-mode)) (not visible-mode))
20265 (or (get-char-property (point) 'invisible)
20266 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20267 ;; OK, we need to take a closer look
20268 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20269 (invisible-before-point (unless (bobp) (get-char-property
20270 (1- (point)) 'invisible)))
20271 (border-and-ok-direction
20273 ;; Check if we are acting predictably before invisible text
20274 (and invisible-at-point (not invisible-before-point)
20275 (memq kind '(insert delete-backward)))
20276 ;; Check if we are acting predictably after invisible text
20277 ;; This works not well, and I have turned it off. It seems
20278 ;; better to always show and stop after invisible text.
20279 ;; (and (not invisible-at-point) invisible-before-point
20280 ;; (memq kind '(insert delete)))
20282 (when (or (memq invisible-at-point '(outline org-hide-block t))
20283 (memq invisible-before-point '(outline org-hide-block t)))
20284 (when (eq org-catch-invisible-edits 'error)
20285 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20286 (if (and org-custom-properties-overlays
20287 (y-or-n-p "Display invisible properties in this buffer? "))
20288 (org-toggle-custom-properties-visibility)
20289 ;; Make the area visible
20291 (when invisible-before-point
20292 (goto-char (previous-single-char-property-change
20293 (point) 'invisible)))
20294 (outline-show-subtree))
20296 ((eq org-catch-invisible-edits 'show)
20297 ;; That's it, we do the edit after showing
20299 "Unfolding invisible region around point before editing")
20301 ((and (eq org-catch-invisible-edits 'smart)
20302 border-and-ok-direction)
20303 (message "Unfolding invisible region around point before editing"))
20305 ;; Don't do the edit, make the user repeat it in full visibility
20306 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20308 (defun org-fix-tags-on-the-fly ()
20309 "Align tags in headline at point.
20310 Unlike to `org-set-tags', it ignores region and sorting."
20311 (when (and (eq (char-after (line-beginning-position)) ?*) ;short-circuit
20312 (org-at-heading-p))
20313 (let ((org-ignore-region t)
20314 (org-tags-sort-function nil))
20315 (org-set-tags nil t))))
20317 (defun org-delete-backward-char (N)
20318 "Like `delete-backward-char', insert whitespace at field end in tables.
20319 When deleting backwards, in tables this function will insert whitespace in
20320 front of the next \"|\" separator, to keep the table aligned. The table will
20321 still be marked for re-alignment if the field did fill the entire column,
20322 because, in this case the deletion might narrow the column."
20325 (org-check-before-invisible-edit 'delete-backward)
20326 (if (and (org-at-table-p)
20328 (string-match "|" (buffer-substring (point-at-bol) (point)))
20329 (looking-at ".*?|"))
20330 (let ((pos (point))
20331 (noalign (looking-at "[^|\n\r]* |"))
20332 (c org-table-may-need-update))
20333 (backward-delete-char N)
20334 (unless overwrite-mode
20335 (skip-chars-forward "^|")
20337 (goto-char (1- pos)))
20338 ;; noalign: if there were two spaces at the end, this field
20339 ;; does not determine the width of the column.
20340 (when noalign (setq org-table-may-need-update c)))
20341 (backward-delete-char N)
20342 (org-fix-tags-on-the-fly))))
20344 (defun org-delete-char (N)
20345 "Like `delete-char', but insert whitespace at field end in tables.
20346 When deleting characters, in tables this function will insert whitespace in
20347 front of the next \"|\" separator, to keep the table aligned. The table will
20348 still be marked for re-alignment if the field did fill the entire column,
20349 because, in this case the deletion might narrow the column."
20352 (org-check-before-invisible-edit 'delete)
20353 (if (and (org-at-table-p)
20355 (not (= (char-after) ?|))
20357 (if (looking-at ".*?|")
20358 (let ((pos (point))
20359 (noalign (looking-at "[^|\n\r]* |"))
20360 (c org-table-may-need-update))
20362 (concat (substring (match-string 0) 1 -1) " |") nil t)
20364 ;; noalign: if there were two spaces at the end, this field
20365 ;; does not determine the width of the column.
20366 (when noalign (setq org-table-may-need-update c)))
20369 (org-fix-tags-on-the-fly))))
20371 ;; Make `delete-selection-mode' work with Org mode and Orgtbl mode
20372 (put 'org-self-insert-command 'delete-selection
20374 (not (run-hook-with-args-until-success
20375 'self-insert-uses-region-functions))))
20376 (put 'orgtbl-self-insert-command 'delete-selection
20378 (not (run-hook-with-args-until-success
20379 'self-insert-uses-region-functions))))
20380 (put 'org-delete-char 'delete-selection 'supersede)
20381 (put 'org-delete-backward-char 'delete-selection 'supersede)
20382 (put 'org-yank 'delete-selection 'yank)
20384 ;; Make `flyspell-mode' delay after some commands
20385 (put 'org-self-insert-command 'flyspell-delayed t)
20386 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20387 (put 'org-delete-char 'flyspell-delayed t)
20388 (put 'org-delete-backward-char 'flyspell-delayed t)
20390 ;; Make pabbrev-mode expand after Org mode commands
20391 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20392 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20394 (defun org-remap (map &rest commands)
20395 "In MAP, remap the functions given in COMMANDS.
20396 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20399 (setq old (pop commands) new (pop commands))
20400 (org-defkey map (vector 'remap old) new))))
20402 (defun org-transpose-words ()
20403 "Transpose words for Org.
20404 This uses the `org-mode-transpose-word-syntax-table' syntax
20405 table, which interprets characters in `org-emphasis-alist' as
20406 word constituents."
20408 (with-syntax-table org-mode-transpose-word-syntax-table
20409 (call-interactively 'transpose-words)))
20410 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20412 (when (eq org-enable-table-editor 'optimized)
20413 ;; If the user wants maximum table support, we need to hijack
20414 ;; some standard editing functions
20415 (org-remap org-mode-map
20416 'self-insert-command 'org-self-insert-command
20417 'delete-char 'org-delete-char
20418 'delete-backward-char 'org-delete-backward-char)
20419 (org-defkey org-mode-map "|" 'org-force-self-insert))
20421 (defvar org-ctrl-c-ctrl-c-hook nil
20422 "Hook for functions attaching themselves to `C-c C-c'.
20424 This can be used to add additional functionality to the C-c C-c
20425 key which executes context-dependent commands. This hook is run
20426 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20427 run after the last test.
20429 Each function will be called with no arguments. The function
20430 must check if the context is appropriate for it to act. If yes,
20431 it should do its thing and then return a non-nil value. If the
20432 context is wrong, just do nothing and return nil.")
20434 (defvar org-ctrl-c-ctrl-c-final-hook nil
20435 "Hook for functions attaching themselves to `C-c C-c'.
20437 This can be used to add additional functionality to the C-c C-c
20438 key which executes context-dependent commands. This hook is run
20439 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20440 before the first test.
20442 Each function will be called with no arguments. The function
20443 must check if the context is appropriate for it to act. If yes,
20444 it should do its thing and then return a non-nil value. If the
20445 context is wrong, just do nothing and return nil.")
20447 (defvar org-tab-first-hook nil
20448 "Hook for functions to attach themselves to TAB.
20449 See `org-ctrl-c-ctrl-c-hook' for more information.
20450 This hook runs as the first action when TAB is pressed, even before
20451 `org-cycle' messes around with the `outline-regexp' to cater for
20452 inline tasks and plain list item folding.
20453 If any function in this hook returns t, any other actions that
20454 would have been caused by TAB (such as table field motion or visibility
20455 cycling) will not occur.")
20457 (defvar org-tab-after-check-for-table-hook nil
20458 "Hook for functions to attach themselves to TAB.
20459 See `org-ctrl-c-ctrl-c-hook' for more information.
20460 This hook runs after it has been established that the cursor is not in a
20461 table, but before checking if the cursor is in a headline or if global cycling
20463 If any function in this hook returns t, not other actions like visibility
20464 cycling will be done.")
20466 (defvar org-tab-after-check-for-cycling-hook nil
20467 "Hook for functions to attach themselves to TAB.
20468 See `org-ctrl-c-ctrl-c-hook' for more information.
20469 This hook runs after it has been established that not table field motion and
20470 not visibility should be done because of current context. This is probably
20471 the place where a package like yasnippets can hook in.")
20473 (defvar org-tab-before-tab-emulation-hook nil
20474 "Hook for functions to attach themselves to TAB.
20475 See `org-ctrl-c-ctrl-c-hook' for more information.
20476 This hook runs after every other options for TAB have been exhausted, but
20477 before indentation and \t insertion takes place.")
20479 (defvar org-metaleft-hook nil
20480 "Hook for functions attaching themselves to `M-left'.
20481 See `org-ctrl-c-ctrl-c-hook' for more information.")
20482 (defvar org-metaright-hook nil
20483 "Hook for functions attaching themselves to `M-right'.
20484 See `org-ctrl-c-ctrl-c-hook' for more information.")
20485 (defvar org-metaup-hook nil
20486 "Hook for functions attaching themselves to `M-up'.
20487 See `org-ctrl-c-ctrl-c-hook' for more information.")
20488 (defvar org-metadown-hook nil
20489 "Hook for functions attaching themselves to `M-down'.
20490 See `org-ctrl-c-ctrl-c-hook' for more information.")
20491 (defvar org-shiftmetaleft-hook nil
20492 "Hook for functions attaching themselves to `M-S-left'.
20493 See `org-ctrl-c-ctrl-c-hook' for more information.")
20494 (defvar org-shiftmetaright-hook nil
20495 "Hook for functions attaching themselves to `M-S-right'.
20496 See `org-ctrl-c-ctrl-c-hook' for more information.")
20497 (defvar org-shiftmetaup-hook nil
20498 "Hook for functions attaching themselves to `M-S-up'.
20499 See `org-ctrl-c-ctrl-c-hook' for more information.")
20500 (defvar org-shiftmetadown-hook nil
20501 "Hook for functions attaching themselves to `M-S-down'.
20502 See `org-ctrl-c-ctrl-c-hook' for more information.")
20503 (defvar org-metareturn-hook nil
20504 "Hook for functions attaching themselves to `M-RET'.
20505 See `org-ctrl-c-ctrl-c-hook' for more information.")
20506 (defvar org-shiftup-hook nil
20507 "Hook for functions attaching themselves to `S-up'.
20508 See `org-ctrl-c-ctrl-c-hook' for more information.")
20509 (defvar org-shiftup-final-hook nil
20510 "Hook for functions attaching themselves to `S-up'.
20511 This one runs after all other options except shift-select have been excluded.
20512 See `org-ctrl-c-ctrl-c-hook' for more information.")
20513 (defvar org-shiftdown-hook nil
20514 "Hook for functions attaching themselves to `S-down'.
20515 See `org-ctrl-c-ctrl-c-hook' for more information.")
20516 (defvar org-shiftdown-final-hook nil
20517 "Hook for functions attaching themselves to `S-down'.
20518 This one runs after all other options except shift-select have been excluded.
20519 See `org-ctrl-c-ctrl-c-hook' for more information.")
20520 (defvar org-shiftleft-hook nil
20521 "Hook for functions attaching themselves to `S-left'.
20522 See `org-ctrl-c-ctrl-c-hook' for more information.")
20523 (defvar org-shiftleft-final-hook nil
20524 "Hook for functions attaching themselves to `S-left'.
20525 This one runs after all other options except shift-select have been excluded.
20526 See `org-ctrl-c-ctrl-c-hook' for more information.")
20527 (defvar org-shiftright-hook nil
20528 "Hook for functions attaching themselves to `S-right'.
20529 See `org-ctrl-c-ctrl-c-hook' for more information.")
20530 (defvar org-shiftright-final-hook nil
20531 "Hook for functions attaching themselves to `S-right'.
20532 This one runs after all other options except shift-select have been excluded.
20533 See `org-ctrl-c-ctrl-c-hook' for more information.")
20535 (defun org-modifier-cursor-error ()
20536 "Throw an error, a modified cursor command was applied in wrong context."
20537 (user-error "This command is active in special context like tables, headlines or items"))
20539 (defun org-shiftselect-error ()
20540 "Throw an error because Shift-Cursor command was applied in wrong context."
20541 (if (and (boundp 'shift-select-mode) shift-select-mode)
20542 (user-error "To use shift-selection with Org mode, customize `org-support-shift-select'")
20543 (user-error "This command works only in special context like headlines or timestamps")))
20545 (defun org-call-for-shift-select (cmd)
20546 (let ((this-command-keys-shift-translated t))
20547 (call-interactively cmd)))
20549 (defun org-shifttab (&optional arg)
20550 "Global visibility cycling or move to previous table field.
20551 Call `org-table-previous-field' within a table.
20552 When ARG is nil, cycle globally through visibility states.
20553 When ARG is a numeric prefix, show contents of this level."
20556 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20558 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20559 (message "Content view to level: %d" arg)
20560 (org-content (prefix-numeric-value arg2))
20561 (org-cycle-show-empty-lines t)
20562 (setq org-cycle-global-status 'overview)))
20563 (t (call-interactively 'org-global-cycle))))
20565 (defun org-shiftmetaleft ()
20566 "Promote subtree or delete table column.
20567 Calls `org-promote-subtree', `org-outdent-item-tree', or
20568 `org-table-delete-column', depending on context. See the
20569 individual commands for more information."
20572 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20573 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20574 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20575 ((if (not (org-region-active-p)) (org-at-item-p)
20576 (save-excursion (goto-char (region-beginning))
20578 (call-interactively 'org-outdent-item-tree))
20579 (t (org-modifier-cursor-error))))
20581 (defun org-shiftmetaright ()
20582 "Demote subtree or insert table column.
20583 Calls `org-demote-subtree', `org-indent-item-tree', or
20584 `org-table-insert-column', depending on context. See the
20585 individual commands for more information."
20588 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20589 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20590 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20591 ((if (not (org-region-active-p)) (org-at-item-p)
20592 (save-excursion (goto-char (region-beginning))
20594 (call-interactively 'org-indent-item-tree))
20595 (t (org-modifier-cursor-error))))
20597 (defun org-shiftmetaup (&optional _arg)
20598 "Drag the line at point up.
20599 In a table, kill the current row.
20600 On a clock timestamp, update the value of the timestamp like `S-<up>'
20601 but also adjust the previous clocked item in the clock history.
20602 Everywhere else, drag the line at point up."
20605 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20606 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20607 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20608 (call-interactively 'org-timestamp-up)))
20609 (t (call-interactively 'org-drag-line-backward))))
20611 (defun org-shiftmetadown (&optional _arg)
20612 "Drag the line at point down.
20613 In a table, insert an empty row at the current line.
20614 On a clock timestamp, update the value of the timestamp like `S-<down>'
20615 but also adjust the previous clocked item in the clock history.
20616 Everywhere else, drag the line at point down."
20619 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20620 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20621 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20622 (call-interactively 'org-timestamp-down)))
20623 (t (call-interactively 'org-drag-line-forward))))
20625 (defsubst org-hidden-tree-error ()
20627 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20629 (defun org-metaleft (&optional _arg)
20630 "Promote heading, list item at point or move table column left.
20632 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20633 depending on context. With no specific context, calls the Emacs
20634 default `backward-word'. See the individual commands for more
20637 This function runs the hook `org-metaleft-hook' as a first step,
20638 and returns at first non-nil value."
20641 ((run-hook-with-args-until-success 'org-metaleft-hook))
20642 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20643 ((org-with-limited-levels
20644 (or (org-at-heading-p)
20645 (and (org-region-active-p)
20647 (goto-char (region-beginning))
20648 (org-at-heading-p)))))
20649 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20650 (call-interactively 'org-do-promote))
20651 ;; At an inline task.
20652 ((org-at-heading-p)
20653 (call-interactively 'org-inlinetask-promote))
20654 ((or (org-at-item-p)
20655 (and (org-region-active-p)
20657 (goto-char (region-beginning))
20659 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20660 (call-interactively 'org-outdent-item))
20661 (t (call-interactively 'backward-word))))
20663 (defun org-metaright (&optional _arg)
20664 "Demote heading, list item at point or move table column right.
20666 In front of a drawer or a block keyword, indent it correctly.
20668 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20669 `org-indent-drawer' or `org-indent-block' depending on context.
20670 With no specific context, calls the Emacs default `forward-word'.
20671 See the individual commands for more information.
20673 This function runs the hook `org-metaright-hook' as a first step,
20674 and returns at first non-nil value."
20677 ((run-hook-with-args-until-success 'org-metaright-hook))
20678 ((org-at-table-p) (call-interactively 'org-table-move-column))
20679 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20680 ((org-at-block-p) (call-interactively 'org-indent-block))
20681 ((org-with-limited-levels
20682 (or (org-at-heading-p)
20683 (and (org-region-active-p)
20685 (goto-char (region-beginning))
20686 (org-at-heading-p)))))
20687 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20688 (call-interactively 'org-do-demote))
20689 ;; At an inline task.
20690 ((org-at-heading-p)
20691 (call-interactively 'org-inlinetask-demote))
20692 ((or (org-at-item-p)
20693 (and (org-region-active-p)
20695 (goto-char (region-beginning))
20697 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20698 (call-interactively 'org-indent-item))
20699 (t (call-interactively 'forward-word))))
20701 (defun org-check-for-hidden (what)
20702 "Check if there are hidden headlines/items in the current visual line.
20703 WHAT can be either `headlines' or `items'. If the current line is
20704 an outline or item heading and it has a folded subtree below it,
20705 this function returns t, nil otherwise."
20707 ((eq what 'headlines) org-outline-regexp-bol)
20708 ((eq what 'items) (org-item-beginning-re))
20709 (t (error "This should not happen"))))
20713 (unless (org-region-active-p)
20714 (setq beg (point-at-bol))
20715 (beginning-of-line 2)
20716 (while (and (not (eobp)) ;; this is like `next-line'
20717 (get-char-property (1- (point)) 'invisible))
20718 (beginning-of-line 2))
20721 (goto-char (point-at-eol))
20722 (setq end (max end (point)))
20723 (while (re-search-forward re end t)
20724 (when (get-char-property (match-beginning 0) 'invisible)
20728 (defun org-metaup (&optional _arg)
20729 "Move subtree up or move table row up.
20730 Calls `org-move-subtree-up' or `org-table-move-row' or
20731 `org-move-item-up', depending on context. See the individual commands
20732 for more information."
20735 ((run-hook-with-args-until-success 'org-metaup-hook))
20736 ((org-region-active-p)
20737 (let* ((a (min (region-beginning) (region-end)))
20738 (b (1- (max (region-beginning) (region-end))))
20739 (c (save-excursion (goto-char a)
20740 (move-beginning-of-line 0)))
20741 (d (save-excursion (goto-char a)
20742 (move-end-of-line 0) (point))))
20743 (transpose-regions a b c d)
20745 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20746 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20747 ((org-at-item-p) (call-interactively 'org-move-item-up))
20748 (t (org-drag-element-backward))))
20750 (defun org-metadown (&optional _arg)
20751 "Move subtree down or move table row down.
20752 Calls `org-move-subtree-down' or `org-table-move-row' or
20753 `org-move-item-down', depending on context. See the individual
20754 commands for more information."
20757 ((run-hook-with-args-until-success 'org-metadown-hook))
20758 ((org-region-active-p)
20759 (let* ((a (min (region-beginning) (region-end)))
20760 (b (max (region-beginning) (region-end)))
20761 (c (save-excursion (goto-char b)
20762 (move-beginning-of-line 1)))
20763 (d (save-excursion (goto-char b)
20764 (move-end-of-line 1) (1+ (point)))))
20765 (transpose-regions a b c d)
20767 ((org-at-table-p) (call-interactively 'org-table-move-row))
20768 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20769 ((org-at-item-p) (call-interactively 'org-move-item-down))
20770 (t (org-drag-element-forward))))
20772 (defun org-shiftup (&optional arg)
20773 "Increase item in timestamp or increase priority of current headline.
20774 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20775 depending on context. See the individual commands for more information."
20778 ((run-hook-with-args-until-success 'org-shiftup-hook))
20779 ((and org-support-shift-select (org-region-active-p))
20780 (org-call-for-shift-select 'previous-line))
20781 ((org-at-timestamp-p t)
20782 (call-interactively (if org-edit-timestamp-down-means-later
20783 'org-timestamp-down 'org-timestamp-up)))
20784 ((and (not (eq org-support-shift-select 'always))
20785 org-enable-priority-commands
20786 (org-at-heading-p))
20787 (call-interactively 'org-priority-up))
20788 ((and (not org-support-shift-select) (org-at-item-p))
20789 (call-interactively 'org-previous-item))
20790 ((org-clocktable-try-shift 'up arg))
20791 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20792 (org-support-shift-select
20793 (org-call-for-shift-select 'previous-line))
20794 (t (org-shiftselect-error))))
20796 (defun org-shiftdown (&optional arg)
20797 "Decrease item in timestamp or decrease priority of current headline.
20798 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20799 depending on context. See the individual commands for more information."
20802 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20803 ((and org-support-shift-select (org-region-active-p))
20804 (org-call-for-shift-select 'next-line))
20805 ((org-at-timestamp-p t)
20806 (call-interactively (if org-edit-timestamp-down-means-later
20807 'org-timestamp-up 'org-timestamp-down)))
20808 ((and (not (eq org-support-shift-select 'always))
20809 org-enable-priority-commands
20810 (org-at-heading-p))
20811 (call-interactively 'org-priority-down))
20812 ((and (not org-support-shift-select) (org-at-item-p))
20813 (call-interactively 'org-next-item))
20814 ((org-clocktable-try-shift 'down arg))
20815 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20816 (org-support-shift-select
20817 (org-call-for-shift-select 'next-line))
20818 (t (org-shiftselect-error))))
20820 (defun org-shiftright (&optional arg)
20821 "Cycle the thing at point or in the current line, depending on context.
20822 Depending on context, this does one of the following:
20824 - switch a timestamp at point one day into the future
20825 - on a headline, switch to the next TODO keyword.
20826 - on an item, switch entire list to the next bullet type
20827 - on a property line, switch to the next allowed value
20828 - on a clocktable definition line, move time block into the future"
20831 ((run-hook-with-args-until-success 'org-shiftright-hook))
20832 ((and org-support-shift-select (org-region-active-p))
20833 (org-call-for-shift-select 'forward-char))
20834 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20835 ((and (not (eq org-support-shift-select 'always))
20836 (org-at-heading-p))
20837 (let ((org-inhibit-logging
20838 (not org-treat-S-cursor-todo-selection-as-state-change))
20839 (org-inhibit-blocking
20840 (not org-treat-S-cursor-todo-selection-as-state-change)))
20841 (org-call-with-arg 'org-todo 'right)))
20842 ((or (and org-support-shift-select
20843 (not (eq org-support-shift-select 'always))
20844 (org-at-item-bullet-p))
20845 (and (not org-support-shift-select) (org-at-item-p)))
20846 (org-call-with-arg 'org-cycle-list-bullet nil))
20847 ((and (not (eq org-support-shift-select 'always))
20848 (org-at-property-p))
20849 (call-interactively 'org-property-next-allowed-value))
20850 ((org-clocktable-try-shift 'right arg))
20851 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20852 (org-support-shift-select
20853 (org-call-for-shift-select 'forward-char))
20854 (t (org-shiftselect-error))))
20856 (defun org-shiftleft (&optional arg)
20857 "Cycle the thing at point or in the current line, depending on context.
20858 Depending on context, this does one of the following:
20860 - switch a timestamp at point one day into the past
20861 - on a headline, switch to the previous TODO keyword.
20862 - on an item, switch entire list to the previous bullet type
20863 - on a property line, switch to the previous allowed value
20864 - on a clocktable definition line, move time block into the past"
20867 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20868 ((and org-support-shift-select (org-region-active-p))
20869 (org-call-for-shift-select 'backward-char))
20870 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20871 ((and (not (eq org-support-shift-select 'always))
20872 (org-at-heading-p))
20873 (let ((org-inhibit-logging
20874 (not org-treat-S-cursor-todo-selection-as-state-change))
20875 (org-inhibit-blocking
20876 (not org-treat-S-cursor-todo-selection-as-state-change)))
20877 (org-call-with-arg 'org-todo 'left)))
20878 ((or (and org-support-shift-select
20879 (not (eq org-support-shift-select 'always))
20880 (org-at-item-bullet-p))
20881 (and (not org-support-shift-select) (org-at-item-p)))
20882 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20883 ((and (not (eq org-support-shift-select 'always))
20884 (org-at-property-p))
20885 (call-interactively 'org-property-previous-allowed-value))
20886 ((org-clocktable-try-shift 'left arg))
20887 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20888 (org-support-shift-select
20889 (org-call-for-shift-select 'backward-char))
20890 (t (org-shiftselect-error))))
20892 (defun org-shiftcontrolright ()
20893 "Switch to next TODO set."
20896 ((and org-support-shift-select (org-region-active-p))
20897 (org-call-for-shift-select 'forward-word))
20898 ((and (not (eq org-support-shift-select 'always))
20899 (org-at-heading-p))
20900 (org-call-with-arg 'org-todo 'nextset))
20901 (org-support-shift-select
20902 (org-call-for-shift-select 'forward-word))
20903 (t (org-shiftselect-error))))
20905 (defun org-shiftcontrolleft ()
20906 "Switch to previous TODO set."
20909 ((and org-support-shift-select (org-region-active-p))
20910 (org-call-for-shift-select 'backward-word))
20911 ((and (not (eq org-support-shift-select 'always))
20912 (org-at-heading-p))
20913 (org-call-with-arg 'org-todo 'previousset))
20914 (org-support-shift-select
20915 (org-call-for-shift-select 'backward-word))
20916 (t (org-shiftselect-error))))
20918 (defun org-shiftcontrolup (&optional n)
20919 "Change timestamps synchronously up in CLOCK log lines.
20920 Optional argument N tells to change by that many units."
20922 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20923 (let (org-support-shift-select)
20924 (org-clock-timestamps-up n))
20925 (user-error "Not at a clock log")))
20927 (defun org-shiftcontroldown (&optional n)
20928 "Change timestamps synchronously down in CLOCK log lines.
20929 Optional argument N tells to change by that many units."
20931 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20932 (let (org-support-shift-select)
20933 (org-clock-timestamps-down n))
20934 (user-error "Not at a clock log")))
20936 (defun org-increase-number-at-point (&optional inc)
20937 "Increment the number at point.
20938 With an optional prefix numeric argument INC, increment using
20939 this numeric value."
20941 (if (not (number-at-point))
20942 (user-error "Not on a number")
20943 (unless inc (setq inc 1))
20944 (let ((pos (point))
20945 (beg (skip-chars-backward "-+^/*0-9eE."))
20946 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20947 (setq nap (buffer-substring-no-properties
20948 (+ pos beg) (+ pos beg end)))
20949 (delete-region (+ pos beg) (+ pos beg end))
20950 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20951 (when (org-at-table-p)
20953 (org-table-end-of-field 1))))
20955 (defun org-decrease-number-at-point (&optional inc)
20956 "Decrement the number at point.
20957 With an optional prefix numeric argument INC, decrement using
20958 this numeric value."
20960 (org-increase-number-at-point (- (or inc 1))))
20962 (defun org-ctrl-c-ret ()
20963 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20966 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20967 (t (call-interactively 'org-insert-heading))))
20969 (defun org-find-visible ()
20971 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20972 (get-char-property s 'invisible)))
20974 (defun org-find-invisible ()
20976 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20977 (not (get-char-property s 'invisible))))
20980 (defun org-copy-visible (beg end)
20981 "Copy the visible parts of the region."
20986 (narrow-to-region beg end)
20987 (setq s (goto-char (point-min)))
20988 (while (not (= (point) (point-max)))
20989 (goto-char (org-find-invisible))
20990 (push (buffer-substring s (point)) snippets)
20991 (setq s (goto-char (org-find-visible))))))
20992 (kill-new (apply 'concat (nreverse snippets)))))
20994 (defun org-copy-special ()
20995 "Copy region in table or copy current subtree.
20996 Calls `org-table-copy-region' or `org-copy-subtree', depending on
20997 context. See the individual commands for more information."
20999 (call-interactively
21000 (if (org-at-table-p) #'org-table-copy-region #'org-copy-subtree)))
21002 (defun org-cut-special ()
21003 "Cut region in table or cut current subtree.
21004 Calls `org-table-cut-region' or `org-cut-subtree', depending on
21005 context. See the individual commands for more information."
21007 (call-interactively
21008 (if (org-at-table-p) #'org-table-cut-region #'org-cut-subtree)))
21010 (defun org-paste-special (arg)
21011 "Paste rectangular region into table, or past subtree relative to level.
21012 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
21013 See the individual commands for more information."
21015 (if (org-at-table-p)
21016 (org-table-paste-rectangle)
21017 (org-paste-subtree arg)))
21019 (defun org-edit-special (&optional arg)
21020 "Call a special editor for the element at point.
21021 When at a table, call the formula editor with `org-table-edit-formulas'.
21022 When in a source code block, call `org-edit-src-code'.
21023 When in a fixed-width region, call `org-edit-fixed-width-region'.
21024 When in an export block, call `org-edit-export-block'.
21025 When at an #+INCLUDE keyword, visit the included file.
21026 When at a footnote reference, call `org-edit-footnote-reference'
21027 On a link, call `ffap' to visit the link at point.
21028 Otherwise, return a user error."
21030 (let ((element (org-element-at-point)))
21031 (barf-if-buffer-read-only)
21032 (pcase (org-element-type element)
21034 (if (not arg) (org-edit-src-code)
21035 (let* ((info (org-babel-get-src-block-info))
21036 (lang (nth 0 info))
21037 (params (nth 2 info))
21038 (session (cdr (assq :session params))))
21039 (if (not session) (org-edit-src-code)
21040 ;; At a src-block with a session and function called with
21041 ;; an ARG: switch to the buffer related to the inferior
21044 (funcall (intern (concat "org-babel-prep-session:" lang))
21045 session params))))))
21047 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
21048 (org-open-link-from-string
21051 (let ((value (org-element-property :value element)))
21052 (cond ((not (org-string-nw-p value))
21053 (user-error "No file to edit"))
21054 ((string-match "\\`\"\\(.*?\\)\"" value)
21055 (match-string 1 value))
21056 ((string-match "\\`[^ \t\"]\\S-*" value)
21057 (match-string 0 value))
21058 (t (user-error "No valid file specified")))))))
21059 (user-error "No special environment to edit here")))
21061 (if (eq (org-element-property :type element) 'table.el)
21062 (org-edit-table.el)
21063 (call-interactively 'org-table-edit-formulas)))
21064 ;; Only Org tables contain `table-row' type elements.
21065 (`table-row (call-interactively 'org-table-edit-formulas))
21066 (`example-block (org-edit-src-code))
21067 (`export-block (org-edit-export-block))
21068 (`fixed-width (org-edit-fixed-width-region))
21070 ;; No notable element at point. Though, we may be at a link or
21071 ;; a footnote reference, which are objects. Thus, scan deeper.
21072 (let ((context (org-element-context element)))
21073 (pcase (org-element-type context)
21074 (`footnote-reference (org-edit-footnote-reference))
21075 (`inline-src-block (org-edit-inline-src-code))
21076 (`link (call-interactively #'ffap))
21077 (_ (user-error "No special environment to edit here"))))))))
21079 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21080 (defun org-ctrl-c-ctrl-c (&optional arg)
21081 "Set tags in headline, or update according to changed information at point.
21083 This command does many different things, depending on context:
21085 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21086 this is what we do.
21088 - If the cursor is on a statistics cookie, update it.
21090 - If the cursor is in a headline, prompt for tags and insert them
21091 into the current line, aligned to `org-tags-column'. When called
21092 with prefix arg, realign all tags in the current buffer.
21094 - If the cursor is in one of the special #+KEYWORD lines, this
21095 triggers scanning the buffer for these lines and updating the
21098 - If the cursor is inside a table, realign the table. This command
21099 works even if the automatic table editor has been turned off.
21101 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21104 - If the cursor is at a footnote reference or definition, jump to
21105 the corresponding definition or references, respectively.
21107 - If the cursor is a the beginning of a dynamic block, update it.
21109 - If the current buffer is a capture buffer, close note and file it.
21111 - If the cursor is on a <<<target>>>, update radio targets and
21112 corresponding links in this buffer.
21114 - If the cursor is on a numbered item in a plain list, renumber the
21117 - If the cursor is on a checkbox, toggle it.
21119 - If the cursor is on a code block, evaluate it. The variable
21120 `org-confirm-babel-evaluate' can be used to control prompting
21121 before code block evaluation, by default every code block
21122 evaluation requires confirmation. Code block evaluation can be
21123 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21126 ((or (bound-and-true-p org-clock-overlays) org-occur-highlights)
21127 (when (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21128 (org-remove-occur-highlights)
21129 (message "Temporary highlights/overlays removed from current buffer"))
21130 ((and (local-variable-p 'org-finish-function)
21131 (fboundp org-finish-function))
21132 (funcall org-finish-function))
21133 ((org-babel-hash-at-point))
21134 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21137 (org-element-lineage
21138 (org-element-context)
21139 ;; Limit to supported contexts.
21140 '(babel-call clock dynamic-block footnote-definition
21141 footnote-reference inline-babel-call inline-src-block
21142 inlinetask item keyword node-property paragraph
21143 plain-list property-drawer radio-target src-block
21144 statistics-cookie table table-cell table-row
21147 (type (org-element-type context)))
21148 ;; For convenience: at the first line of a paragraph on the same
21149 ;; line as an item, apply function on that item instead.
21150 (when (eq type 'paragraph)
21151 (let ((parent (org-element-property :parent context)))
21152 (when (and (eq (org-element-type parent) 'item)
21153 (= (line-beginning-position)
21154 (org-element-property :begin parent)))
21155 (setq context parent)
21156 (setq type 'item))))
21157 ;; Act according to type of element or object at point.
21159 ;; Do nothing on a blank line, except if it is contained in
21160 ;; a src block. Hence, we first check if point is in such
21161 ;; a block and then if it is at a blank line.
21163 ((or `inline-src-block `src-block)
21164 (unless org-babel-no-eval-on-ctrl-c-ctrl-c
21165 (org-babel-eval-wipe-error-buffer)
21166 (org-babel-execute-src-block
21167 current-prefix-arg (org-babel-get-src-block-info nil context))))
21168 ((guard (org-match-line "[ \t]*$"))
21169 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21171 (substitute-command-keys
21172 "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))
21173 ((or `babel-call `inline-babel-call)
21174 (let ((info (org-babel-lob-get-info context)))
21175 (when info (org-babel-execute-src-block nil info))))
21176 (`clock (org-clock-update-time-maybe))
21179 (goto-char (org-element-property :post-affiliated context))
21180 (org-update-dblock)))
21181 (`footnote-definition
21182 (goto-char (org-element-property :post-affiliated context))
21183 (call-interactively 'org-footnote-action))
21184 (`footnote-reference (call-interactively #'org-footnote-action))
21185 ((or `headline `inlinetask)
21186 (save-excursion (goto-char (org-element-property :begin context))
21187 (call-interactively #'org-set-tags)))
21189 ;; At an item: `C-u C-u' sets checkbox to "[-]"
21190 ;; unconditionally, whereas `C-u' will toggle its presence.
21191 ;; Without a universal argument, if the item has a checkbox,
21192 ;; toggle it. Otherwise repair the list.
21193 (let* ((box (org-element-property :checkbox context))
21194 (struct (org-element-property :structure context))
21195 (old-struct (copy-tree struct))
21196 (parents (org-list-parents-alist struct))
21197 (prevs (org-list-prevs-alist struct))
21198 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21199 (org-list-set-checkbox
21200 (org-element-property :begin context) struct
21201 (cond ((equal arg '(16)) "[-]")
21202 ((and (not box) (equal arg '(4))) "[ ]")
21203 ((or (not box) (equal arg '(4))) nil)
21204 ((eq box 'on) "[ ]")
21206 ;; Mimic `org-list-write-struct' but with grabbing a return
21207 ;; value from `org-list-struct-fix-box'.
21208 (org-list-struct-fix-ind struct parents 2)
21209 (org-list-struct-fix-item-end struct)
21210 (org-list-struct-fix-bul struct prevs)
21211 (org-list-struct-fix-ind struct parents)
21213 (org-list-struct-fix-box struct parents prevs orderedp)))
21214 (if (and box (equal struct old-struct))
21215 (if (equal arg '(16))
21216 (message "Checkboxes already reset")
21217 (user-error "Cannot toggle this checkbox: %s"
21219 "all subitems checked"
21220 "unchecked subitems")))
21221 (org-list-struct-apply-struct struct old-struct)
21222 (org-update-checkbox-count-maybe))
21224 (message "Checkboxes were removed due to empty box at line %d"
21225 (org-current-line block-item))))))
21227 (let ((org-inhibit-startup-visibility-stuff t)
21228 (org-startup-align-all-tables nil))
21229 (when (boundp 'org-table-coordinate-overlays)
21230 (mapc #'delete-overlay org-table-coordinate-overlays)
21231 (setq org-table-coordinate-overlays nil))
21232 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21233 (message "Local setup has been refreshed"))
21235 ;; At a plain list, with a double C-u argument, set
21236 ;; checkboxes of each item to "[-]", whereas a single one
21237 ;; will toggle their presence according to the state of the
21238 ;; first item in the list. Without an argument, repair the
21240 (let* ((begin (org-element-property :contents-begin context))
21241 (beginm (move-marker (make-marker) begin))
21242 (struct (org-element-property :structure context))
21243 (old-struct (copy-tree struct))
21244 (first-box (save-excursion
21246 (looking-at org-list-full-item-re)
21247 (match-string-no-properties 3)))
21248 (new-box (cond ((equal arg '(16)) "[-]")
21249 ((equal arg '(4)) (unless first-box "[ ]"))
21250 ((equal first-box "[X]") "[ ]")
21255 (org-list-get-all-items
21256 begin struct (org-list-prevs-alist struct)))
21257 (org-list-set-checkbox pos struct new-box)))
21258 ((and first-box (eq (point) begin))
21259 ;; For convenience, when point is at bol on the first
21260 ;; item of the list and no argument is provided, simply
21261 ;; toggle checkbox of that item, if any.
21262 (org-list-set-checkbox begin struct new-box)))
21263 (org-list-write-struct
21264 struct (org-list-parents-alist struct) old-struct)
21265 (org-update-checkbox-count-maybe)
21266 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21267 ((or `property-drawer `node-property)
21268 (call-interactively #'org-property-action))
21270 (call-interactively #'org-update-radio-target-regexp))
21271 (`statistics-cookie
21272 (call-interactively #'org-update-statistics-cookies))
21273 ((or `table `table-cell `table-row)
21274 ;; At a table, recalculate every field and align it. Also
21275 ;; send the table if necessary. If the table has
21276 ;; a `table.el' type, just give up. At a table row or cell,
21277 ;; maybe recalculate line but always align table.
21278 (if (eq (org-element-property :type context) 'table.el)
21279 (message "%s" (substitute-command-keys "\\<org-mode-map>\
21280 Use `\\[org-edit-special]' to edit table.el tables"))
21281 (let ((org-enable-table-editor t))
21282 (if (or (eq type 'table)
21283 ;; Check if point is at a TBLFM line.
21284 (and (eq type 'table-row)
21285 (= (point) (org-element-property :end context))))
21287 (if (org-at-TBLFM-p)
21288 (progn (require 'org-table)
21289 (org-table-calc-current-TBLFM))
21290 (goto-char (org-element-property :contents-begin context))
21291 (org-call-with-arg 'org-table-recalculate (or arg t))
21292 (orgtbl-send-table 'maybe)))
21293 (org-table-maybe-eval-formula)
21294 (cond (arg (call-interactively #'org-table-recalculate))
21295 ((org-table-maybe-recalculate-line))
21296 (t (org-table-align)))))))
21297 (`timestamp (org-timestamp-change 0 'day))
21298 ((and `nil (guard (org-at-heading-p)))
21299 ;; When point is on an unsupported object type, we can miss
21300 ;; the fact that it also is at a heading. Handle it here.
21301 (call-interactively #'org-set-tags))
21303 (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)))
21306 (substitute-command-keys
21307 "`\\[org-ctrl-c-ctrl-c]' can do nothing useful here"))))))))
21309 (defun org-mode-restart ()
21311 (let ((indent-status (bound-and-true-p org-indent-mode)))
21312 (funcall major-mode)
21313 (hack-local-variables)
21314 (when (and indent-status (not (bound-and-true-p org-indent-mode)))
21315 (org-indent-mode -1)))
21316 (message "%s restarted" major-mode))
21318 (defun org-kill-note-or-show-branches ()
21319 "Abort storing current note, or call `outline-show-branches'."
21321 (if (not org-finish-function)
21323 (outline-hide-subtree)
21324 (call-interactively 'outline-show-branches))
21325 (let ((org-note-abort t))
21326 (funcall org-finish-function))))
21328 (defun org-delete-indentation (&optional arg)
21329 "Join current line to previous and fix whitespace at join.
21331 If previous line is a headline add to headline title. Otherwise
21332 the function calls `delete-indentation'.
21334 With a non-nil optional argument, join it to the following one."
21336 (if (save-excursion
21337 (beginning-of-line (if arg 1 0))
21338 (let ((case-fold-search nil))
21339 (looking-at org-complex-heading-regexp)))
21341 (let ((tags-column (when (match-beginning 5)
21342 (save-excursion (goto-char (match-beginning 5))
21343 (current-column))))
21344 (string (concat " " (progn (when arg (forward-line 1))
21345 (org-trim (delete-and-extract-region
21346 (line-beginning-position)
21347 (line-end-position)))))))
21348 (unless (bobp) (delete-region (point) (1- (point))))
21349 (goto-char (or (match-end 4)
21350 (match-beginning 5)
21352 (skip-chars-backward " \t")
21353 (save-excursion (insert string))
21354 ;; Adjust alignment of tags.
21356 ((not tags-column)) ;no tags
21357 (org-auto-align-tags (org-set-tags nil t))
21358 (t (org--align-tags-here tags-column)))) ;preserve tags column
21359 (delete-indentation arg)))
21361 (defun org-open-line (n)
21362 "Insert a new row in tables, call `open-line' elsewhere.
21363 If `org-special-ctrl-o' is nil, just call `open-line' everywhere.
21364 As a special case, when a document starts with a table, allow to
21365 call `open-line' on the very first character."
21367 (if (and org-special-ctrl-o (/= (point) 1) (org-at-table-p))
21368 (org-table-insert-row)
21371 (defun org-return (&optional indent)
21372 "Goto next table row or insert a newline.
21374 Calls `org-table-next-row' or `newline', depending on context.
21376 When optional INDENT argument is non-nil, call
21377 `newline-and-indent' instead of `newline'.
21379 When `org-return-follows-link' is non-nil and point is on
21380 a timestamp or a link, call `org-open-at-point'. However, it
21381 will not happen if point is in a table or on a \"dead\"
21382 object (e.g., within a comment). In these case, you need to use
21383 `org-open-at-point' directly."
21385 (let ((context (if org-return-follows-link (org-element-context)
21386 (org-element-at-point))))
21388 ;; In a table, call `org-table-next-row'.
21389 ((or (and (eq (org-element-type context) 'table)
21390 (>= (point) (org-element-property :contents-begin context))
21391 (< (point) (org-element-property :contents-end context)))
21392 (org-element-lineage context '(table-row table-cell) t))
21393 (org-table-justify-field-maybe)
21394 (call-interactively #'org-table-next-row))
21395 ;; On a link or a timestamp, call `org-open-at-point' if
21396 ;; `org-return-follows-link' allows it. Tolerate fuzzy
21397 ;; locations, e.g., in a comment, as `org-open-at-point'.
21398 ((and org-return-follows-link
21399 (or (org-in-regexp org-ts-regexp-both nil t)
21400 (org-in-regexp org-tsr-regexp-both nil t)
21401 (org-in-regexp org-any-link-re nil t)))
21402 (call-interactively #'org-open-at-point))
21403 ;; Insert newline in heading, but preserve tags.
21405 (save-excursion (beginning-of-line)
21406 (let ((case-fold-search nil))
21407 (looking-at org-complex-heading-regexp))))
21408 ;; At headline. Split line. However, if point is on keyword,
21409 ;; priority cookie or tags, do not break any of them: add
21410 ;; a newline after the headline instead.
21411 (let ((tags-column (and (match-beginning 5)
21412 (save-excursion (goto-char (match-beginning 5))
21413 (current-column))))
21415 (when (and (match-end 4) (org-point-in-group (point) 4))
21416 (delete-and-extract-region (point) (match-end 4)))))
21417 ;; Adjust tag alignment.
21419 ((not (and tags-column string)))
21420 (org-auto-align-tags (org-set-tags nil t))
21421 (t (org--align-tags-here tags-column))) ;preserve tags column
21424 (if indent (newline-and-indent) (newline))
21425 (when string (save-excursion (insert (org-trim string))))))
21426 ;; In a list, make sure indenting keeps trailing text within.
21429 (org-element-lineage context '(item)))
21430 (let ((trailing-data
21431 (delete-and-extract-region (point) (line-end-position))))
21432 (newline-and-indent)
21433 (save-excursion (insert trailing-data))))
21434 (t (if indent (newline-and-indent) (newline))))))
21436 (defun org-return-indent ()
21437 "Goto next table row or insert a newline and indent.
21438 Calls `org-table-next-row' or `newline-and-indent', depending on
21439 context. See the individual commands for more information."
21443 (defun org-ctrl-c-star ()
21444 "Compute table, or change heading status of lines.
21445 Calls `org-table-recalculate' or `org-toggle-heading',
21446 depending on context."
21450 (call-interactively 'org-table-recalculate))
21452 ;; Convert all lines in region to list items
21453 (call-interactively 'org-toggle-heading))))
21455 (defun org-ctrl-c-minus ()
21456 "Insert separator line in table or modify bullet status of line.
21457 Also turns a plain line or a region of lines into list items.
21458 Calls `org-table-insert-hline', `org-toggle-item', or
21459 `org-cycle-list-bullet', depending on context."
21463 (call-interactively 'org-table-insert-hline))
21464 ((org-region-active-p)
21465 (call-interactively 'org-toggle-item))
21467 (call-interactively 'org-cycle-list-bullet))
21469 (call-interactively 'org-toggle-item))))
21471 (defun org-toggle-heading (&optional nstars)
21472 "Convert headings to normal text, or items or text to headings.
21473 If there is no active region, only convert the current line.
21475 With a `\\[universal-argument]' prefix, convert the whole list at
21476 point into heading.
21480 - If the first non blank line is a headline, remove the stars
21481 from all headlines in the region.
21483 - If it is a normal line, turn each and every normal line (i.e.,
21484 not an heading or an item) in the region into headings. If you
21485 want to convert only the first line of this region, use one
21486 universal prefix argument.
21488 - If it is a plain list item, turn all plain list items into headings.
21490 When converting a line into a heading, the number of stars is chosen
21491 such that the lines become children of the current entry. However,
21492 when a numeric prefix argument is given, its value determines the
21493 number of stars to add."
21497 ;; Return beginning of first non-blank line, starting from
21502 (while (org-at-comment-p) (forward-line))
21503 (skip-chars-forward " \r\t\n")
21506 ;; Determine boundaries of changes. If a universal prefix has
21507 ;; been given, put the list in a region. If region ends at a bol,
21508 ;; do not consider the last line to be in the region.
21510 (when (and current-prefix-arg (org-at-item-p))
21511 (when (listp current-prefix-arg) (setq current-prefix-arg 1))
21512 (org-mark-element))
21514 (if (org-region-active-p)
21515 (setq beg (funcall skip-blanks (region-beginning))
21516 end (copy-marker (save-excursion
21517 (goto-char (region-end))
21518 (if (bolp) (point) (point-at-eol)))))
21519 (setq beg (funcall skip-blanks (point-at-bol))
21520 end (copy-marker (point-at-eol))))
21521 ;; Ensure inline tasks don't count as headings.
21522 (org-with-limited-levels
21526 ;; Case 1. Started at an heading: de-star headings.
21527 ((org-at-heading-p)
21528 (while (< (point) end)
21529 (when (org-at-heading-p t)
21530 (looking-at org-outline-regexp) (replace-match "")
21533 ;; Case 2. Started at an item: change items into headlines.
21534 ;; One star will be added by `org-list-to-subtree'.
21536 (while (< (point) end)
21537 (when (org-at-item-p)
21538 ;; Pay attention to cases when region ends before list.
21539 (let* ((struct (org-list-struct))
21541 (min (org-list-get-bottom-point struct) (1+ end))))
21543 (narrow-to-region (point) list-end)
21544 (insert (org-list-to-subtree (org-list-to-lisp t)) "\n")))
21547 ;; Case 3. Started at normal text: make every line an heading,
21548 ;; skipping headlines and items.
21551 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21553 (cond (nstars "") ; stars from prefix only
21554 ((equal stars "") "*") ; before first heading
21555 (org-odd-levels-only "**") ; inside heading, odd
21556 (t "*"))) ; inside heading, oddeven
21557 (rpl (concat stars add-stars " "))
21558 (lend (when (listp nstars) (save-excursion (end-of-line) (point)))))
21559 (while (< (point) (if (equal nstars '(4)) lend end))
21560 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21561 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21562 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21563 (forward-line)))))))
21564 (unless toggled (message "Cannot toggle heading from here"))))
21566 (defun org-meta-return (&optional _arg)
21567 "Insert a new heading or wrap a region in a table.
21568 Calls `org-insert-heading' or `org-table-wrap-region', depending
21569 on context. See the individual commands for more information."
21571 (org-check-before-invisible-edit 'insert)
21572 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21573 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21574 #'org-insert-heading))))
21578 (defsubst org-in-subtree-not-table-p ()
21579 "Are we in a subtree and not in a table?"
21580 (and (not (org-before-first-heading-p))
21581 (not (org-at-table-p))))
21583 ;; Define the Org mode menus
21584 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21586 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21587 ["Next Field" org-cycle (org-at-table-p)]
21588 ["Previous Field" org-shifttab (org-at-table-p)]
21589 ["Next Row" org-return (org-at-table-p)]
21591 ["Blank Field" org-table-blank-field (org-at-table-p)]
21592 ["Edit Field" org-table-edit-field (org-at-table-p)]
21593 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21596 ["Move Column Left" org-metaleft (org-at-table-p)]
21597 ["Move Column Right" org-metaright (org-at-table-p)]
21598 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21599 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21601 ["Move Row Up" org-metaup (org-at-table-p)]
21602 ["Move Row Down" org-metadown (org-at-table-p)]
21603 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21604 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21605 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21607 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21609 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21610 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21611 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21612 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21615 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21616 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21617 ["Edit Formulas" org-edit-special (org-at-table-p)]
21619 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21620 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21621 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21623 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21625 ["Sum Column/Rectangle" org-table-sum
21626 (or (org-at-table-p) (org-region-active-p))]
21627 ["Which Column?" org-table-current-column (org-at-table-p)])
21629 org-table-toggle-formula-debugger
21630 :style toggle :selected (bound-and-true-p org-table-formula-debug)]
21631 ["Show Col/Row Numbers"
21632 org-table-toggle-coordinate-overlays
21634 :selected (bound-and-true-p org-table-overlay-coordinates)]
21636 ["Create" org-table-create (and (not (org-at-table-p))
21637 org-enable-table-editor)]
21638 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21639 ["Import from File" org-table-import (not (org-at-table-p))]
21640 ["Export to File" org-table-export (org-at-table-p)]
21642 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21645 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21646 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21648 (easy-menu-define org-org-menu org-mode-map "Org menu"
21651 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21652 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21653 ["Sparse Tree..." org-sparse-tree t]
21654 ["Reveal Context" org-reveal t]
21655 ["Show All" outline-show-all t]
21657 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21659 ["New Heading" org-insert-heading t]
21660 ("Navigate Headings"
21661 ["Up" outline-up-heading t]
21662 ["Next" outline-next-visible-heading t]
21663 ["Previous" outline-previous-visible-heading t]
21664 ["Next Same Level" outline-forward-same-level t]
21665 ["Previous Same Level" outline-backward-same-level t]
21667 ["Jump" org-goto t])
21669 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21671 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21672 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21674 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21675 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21676 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21678 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21680 ["Copy visible text" org-copy-visible t]
21682 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21683 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21684 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21685 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21687 ["Sort Region/Children" org-sort t]
21689 ["Convert to odd levels" org-convert-to-odd-levels t]
21690 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21692 ["Emphasis..." org-emphasize t]
21693 ["Edit Source Example" org-edit-special t]
21695 ["Footnote new/jump" org-footnote-action t]
21696 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21698 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21700 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21701 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21702 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21706 ["Store Link (Global)" org-store-link t]
21707 ["Find existing link to here" org-occur-link-in-agenda-files t]
21708 ["Insert Link" org-insert-link t]
21709 ["Follow Link" org-open-at-point t]
21711 ["Next link" org-next-link t]
21712 ["Previous link" org-previous-link t]
21714 ["Descriptive Links"
21715 org-toggle-link-display
21717 :selected org-descriptive-links
21720 org-toggle-link-display
21722 :selected (not org-descriptive-links)])
21725 ["TODO/DONE/-" org-todo t]
21727 ["Next keyword" org-shiftright (org-at-heading-p)]
21728 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21729 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21730 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21731 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21732 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21733 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21735 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21736 :selected org-enforce-todo-dependencies :style toggle :active t]
21737 "Settings for tree at point"
21738 ["Do Children sequentially" org-toggle-ordered-property :style radio
21739 :selected (org-entry-get nil "ORDERED")
21740 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21741 ["Do Children parallel" org-toggle-ordered-property :style radio
21742 :selected (not (org-entry-get nil "ORDERED"))
21743 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21745 ["Set Priority" org-priority t]
21746 ["Priority Up" org-shiftup t]
21747 ["Priority Down" org-shiftdown t]
21749 ["Get news from all feeds" org-feed-update-all t]
21750 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21751 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21752 ("TAGS and Properties"
21753 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21754 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21756 ["Set property" org-set-property (not (org-before-first-heading-p))]
21757 ["Column view of properties" org-columns t]
21758 ["Insert Column View DBlock" org-columns-insert-dblock t])
21759 ("Dates and Scheduling"
21760 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21761 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21763 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21764 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21765 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21766 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21767 ["Compute Time Range" org-evaluate-time-range t]
21768 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21769 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21771 ["Custom time format" org-toggle-time-stamp-overlays
21772 :style radio :selected org-display-custom-times]
21774 ["Goto Calendar" org-goto-calendar t]
21775 ["Date from Calendar" org-date-from-calendar t]
21777 ["Start/Restart Timer" org-timer-start t]
21778 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21779 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21780 ["Insert Timer String" org-timer t]
21781 ["Insert Timer Item" org-timer-item t])
21783 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21784 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21785 ["Clock out" org-clock-out t]
21786 ["Clock cancel" org-clock-cancel t]
21788 ["Mark as default task" org-clock-mark-default-task t]
21789 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21790 ["Goto running clock" org-clock-goto t]
21792 ["Display times" org-clock-display t]
21793 ["Create clock table" org-clock-report t]
21795 ["Record DONE time"
21796 (progn (setq org-log-done (not org-log-done))
21797 (message "Switching to %s will %s record a timestamp"
21798 (car org-done-keywords)
21799 (if org-log-done "automatically" "not")))
21800 :style toggle :selected org-log-done])
21802 ["Agenda Command..." org-agenda t]
21803 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21804 ("File List for Agenda")
21805 ("Special views current file"
21806 ["TODO Tree" org-show-todo-tree t]
21807 ["Check Deadlines" org-check-deadlines t]
21808 ["Timeline" org-timeline t]
21809 ["Tags/Property tree" org-match-sparse-tree t])
21811 ["Export/Publish..." org-export-dispatch t]
21813 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21814 :selected org-cdlatex-mode]
21815 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21816 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21817 ["Modify math symbol" org-cdlatex-math-modify
21818 (org-inside-LaTeX-fragment-p)]
21819 ["Insert citation" org-reftex-citation t])
21822 ["Push Files and Views" org-mobile-push t]
21823 ["Get Captured and Flagged" org-mobile-pull t]
21824 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21826 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21829 ["Show Version" org-version t]
21830 ["Info Documentation" org-info t])
21832 ["Browse Org Group" org-customize t]
21834 ["Expand This Menu" org-create-customize-menu
21835 (fboundp 'customize-menu-create)])
21836 ["Send bug report" org-submit-bug-report t]
21839 ["Refresh setup current buffer" org-mode-restart t]
21840 ["Reload Org (after update)" org-reload t]
21841 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21844 (defun org-info (&optional node)
21845 "Read documentation for Org in the info system.
21846 With optional NODE, go directly to that node."
21848 (info (format "(org)%s" (or node ""))))
21851 (defun org-submit-bug-report ()
21852 "Submit a bug report on Org via mail.
21854 Don't hesitate to report any problems or inaccurate documentation.
21856 If you don't have setup sending mail from (X)Emacs, please copy the
21857 output buffer into your mail program, as it gives us important
21858 information about your Org version and configuration."
21860 (require 'reporter)
21861 (defvar reporter-prompt-for-summary-p)
21862 (org-load-modules-maybe)
21863 (org-require-autoloaded-modules)
21864 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21865 (reporter-submit-bug-report
21866 "emacs-orgmode@gnu.org"
21867 (org-version nil 'full)
21869 (save-window-excursion
21870 (pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21871 (delete-other-windows)
21873 (insert "You are about to submit a bug report to the Org mailing list.
21875 We would like to add your full Org and Outline configuration to the
21876 bug report. This greatly simplifies the work of the maintainer and
21877 other experts on the mailing list.
21879 HOWEVER, some variables you have customized may contain private
21880 information. The names of customers, colleagues, or friends, might
21881 appear in the form of file names, tags, todo states, or search strings.
21882 If you answer yes to the prompt, you might want to check and remove
21883 such private information before sending the email.")
21884 (add-text-properties (point-min) (point-max) '(face org-warning))
21885 (when (yes-or-no-p "Include your Org configuration ")
21889 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21890 (or (and (symbol-value v)
21891 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21893 (get v 'custom-type) (get v 'standard-value)
21894 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21896 (kill-buffer (get-buffer "*Warn about privacy*"))
21899 "Remember to cover the basics, that is, what you expected to happen and
21900 what in fact did happen. You don't know how to make a good report? See
21902 http://orgmode.org/manual/Feedback.html#Feedback
21904 Your bug report will be posted to the Org mailing list.
21905 ------------------------------------------------------------------------")
21907 (when (re-search-backward "^\\(Subject: \\)Org mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21908 (replace-match "\\1Bug: \\3 [\\2]")))))
21911 (defun org-install-agenda-files-menu ()
21912 (let ((bl (buffer-list)))
21915 (set-buffer (pop bl))
21916 (when (derived-mode-p 'org-mode) (setq bl nil)))
21917 (when (derived-mode-p 'org-mode)
21919 '("Org") "File List for Agenda"
21922 ["Edit File List" (org-edit-agenda-file-list) t]
21923 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21924 ["Remove Current File from List" org-remove-file t]
21925 ["Cycle through agenda files" org-cycle-agenda-files t]
21926 ["Occur in all agenda files" org-occur-in-agenda-files t]
21928 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21932 (defun org-require-autoloaded-modules ()
21935 '(org-agenda org-archive org-attach org-clock org-colview org-id
21936 org-table org-timer)))
21939 (defun org-reload (&optional uncompiled)
21940 "Reload all org lisp files.
21941 With prefix arg UNCOMPILED, load the uncompiled versions."
21943 (require 'loadhist)
21944 (let* ((org-dir (org-find-library-dir "org"))
21945 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21946 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21947 (remove-re (format "\\`%s\\'"
21948 (regexp-opt '("org" "org-loaddefs" "org-version"))))
21949 (feats (delete-dups
21950 (mapcar 'file-name-sans-extension
21951 (mapcar 'file-name-nondirectory
21953 (mapcar 'feature-file
21960 (if (and (string-match feature-re f)
21961 (not (string-match remove-re f)))
21965 (list "org-version" "org")))
21966 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21967 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21968 load-uncore load-misses)
21971 (mapcar (lambda (f)
21972 (or (org-load-noerror-mustsuffix (concat org-dir f))
21973 (and (string= org-dir contrib-dir)
21974 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21975 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21976 (add-to-list 'load-uncore f 'append)
21981 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21982 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21984 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21985 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21986 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21989 (defun org-customize ()
21990 "Call the customize function with org as argument."
21992 (org-load-modules-maybe)
21993 (org-require-autoloaded-modules)
21994 (customize-browse 'org))
21996 (defun org-create-customize-menu ()
21997 "Create a full customization menu for Org mode, insert it into the menu."
21999 (org-load-modules-maybe)
22000 (org-require-autoloaded-modules)
22001 (if (fboundp 'customize-menu-create)
22004 '("Org") "Customize"
22005 `(["Browse Org group" org-customize t]
22007 ,(customize-menu-create 'org)
22008 ["Set" Custom-set t]
22009 ["Save" Custom-save t]
22010 ["Reset to Current" Custom-reset-current t]
22011 ["Reset to Saved" Custom-reset-saved t]
22012 ["Reset to Standard Settings" Custom-reset-standard t]))
22013 (message "\"Org\"-menu now contains full customization menu"))
22014 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22016 ;;;; Miscellaneous stuff
22018 ;;; Generally useful functions
22020 (defun org-get-at-eol (property n)
22021 "Get text property PROPERTY at the end of line less N characters."
22022 (get-text-property (- (point-at-eol) n) property))
22024 (defun org-find-text-property-in-string (prop s)
22025 "Return the first non-nil value of property PROP in string S."
22026 (or (get-text-property 0 prop s)
22027 (get-text-property (or (next-single-property-change 0 prop s) 0)
22030 (defun org-display-warning (message)
22031 "Display the given MESSAGE as a warning."
22032 (display-warning 'org message :warning))
22034 (defun org-eval (form)
22035 "Eval FORM and return result."
22036 (condition-case error
22038 (error (format "%%![Error: %s]" error))))
22040 (defun org-in-clocktable-p ()
22041 "Check if the cursor is in a clocktable."
22042 (let ((pos (point)) start)
22045 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22046 (setq start (match-beginning 0))
22047 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22048 (>= (match-end 0) pos)
22051 (defun org-in-verbatim-emphasis ()
22053 (and (org-in-regexp org-emph-re 2)
22054 (>= (point) (match-beginning 3))
22055 (<= (point) (match-end 4))
22056 (member (match-string 3) '("=" "~")))))
22058 (defun org-overlay-display (ovl text &optional face evap)
22059 "Make overlay OVL display TEXT with face FACE."
22060 (overlay-put ovl 'display text)
22061 (if face (overlay-put ovl 'face face))
22062 (if evap (overlay-put ovl 'evaporate t)))
22064 (defun org-overlay-before-string (ovl text &optional face evap)
22065 "Make overlay OVL display TEXT with face FACE."
22066 (if face (org-add-props text nil 'face face))
22067 (overlay-put ovl 'before-string text)
22068 (if evap (overlay-put ovl 'evaporate t)))
22070 (defun org-find-overlays (prop &optional pos delete)
22071 "Find all overlays specifying PROP at POS or point.
22072 If DELETE is non-nil, delete all those overlays."
22074 (dolist (ov (overlays-at (or pos (point))) found)
22075 (cond ((not (overlay-get ov prop)))
22076 (delete (delete-overlay ov))
22077 (t (push ov found))))))
22079 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22080 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22081 (if (and marker (marker-buffer marker)
22082 (buffer-live-p (marker-buffer marker)))
22084 (pop-to-buffer-same-window (marker-buffer marker))
22085 (when (or (> marker (point-max)) (< marker (point-min)))
22088 (org-show-context 'org-goto))
22090 (bookmark-jump bookmark)
22091 (error "Cannot find location"))))
22093 (defun org-quote-csv-field (s)
22094 "Quote field for inclusion in CSV material."
22095 (if (string-match "[\",]" s)
22096 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22099 (defun org-force-self-insert (N)
22100 "Needed to enforce self-insert under remapping."
22102 (self-insert-command N))
22104 (defun org-string-width (s)
22105 "Compute width of string, ignoring invisible characters.
22106 This ignores character with invisibility property `org-link', and also
22107 characters with property `org-cwidth', because these will become invisible
22108 upon the next fontification round."
22110 (when (or (eq t buffer-invisibility-spec)
22111 (assq 'org-link buffer-invisibility-spec))
22112 (while (setq b (text-property-any 0 (length s)
22113 'invisible 'org-link s))
22114 (setq s (concat (substring s 0 b)
22115 (substring s (or (next-single-property-change
22118 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22119 (setq s (concat (substring s 0 b)
22120 (substring s (or (next-single-property-change
22123 (setq l (string-width s) b -1)
22124 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22125 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22128 (defun org-shorten-string (s maxlength)
22129 "Shorten string S so that it is no longer than MAXLENGTH characters.
22130 If the string is shorter or has length MAXLENGTH, just return the
22131 original string. If it is longer, the functions finds a space in the
22132 string, breaks this string off at that locations and adds three dots
22133 as ellipsis. Including the ellipsis, the string will not be longer
22134 than MAXLENGTH. If finding a good breaking point in the string does
22135 not work, the string is just chopped off in the middle of a word
22137 (if (<= (length s) maxlength)
22139 (let* ((n (max (- maxlength 4) 1))
22140 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22141 (if (string-match re s)
22142 (concat (match-string 1 s) "...")
22143 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22145 (defun org-get-indentation (&optional line)
22146 "Get the indentation of the current line, interpreting tabs.
22147 When LINE is given, assume it represents a line and compute its indentation."
22149 (when (string-match "^ *" (org-remove-tabs line))
22152 (beginning-of-line 1)
22153 (skip-chars-forward " \t")
22154 (current-column))))
22156 (defun org-get-string-indentation (s)
22157 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22158 (let ((n -1) (i 0) (w tab-width) c)
22160 (while (< (setq n (1+ n)) (length s))
22161 (setq c (aref s n))
22162 (cond ((= c ?\ ) (setq i (1+ i)))
22163 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22164 (t (throw 'exit t)))))
22167 (defun org-remove-tabs (s &optional width)
22168 "Replace tabulators in S with spaces.
22169 Assumes that s is a single line, starting in column 0."
22170 (setq width (or width tab-width))
22171 (while (string-match "\t" s)
22172 (setq s (replace-match
22174 (- (* width (/ (+ (match-beginning 0) width) width))
22175 (match-beginning 0)) ?\ )
22179 (defun org-fix-indentation (line ind)
22180 "Fix indentation in LINE.
22181 IND is a cons cell with target and minimum indentation.
22182 If the current indentation in LINE is smaller than the minimum,
22183 leave it alone. If it is larger than ind, set it to the target."
22184 (let* ((l (org-remove-tabs line))
22185 (i (org-get-indentation l))
22186 (i1 (car ind)) (i2 (cdr ind)))
22187 (when (>= i i2) (setq l (substring line i2)))
22189 (concat (make-string i1 ?\ ) l)
22192 (defun org-remove-indentation (code &optional n)
22193 "Remove maximum common indentation in string CODE and return it.
22194 N may optionally be the number of columns to remove. Return CODE
22195 as-is if removal failed."
22198 (if (org-do-remove-indentation n) (buffer-string) code)))
22200 (defun org-do-remove-indentation (&optional n)
22201 "Remove the maximum common indentation from the buffer.
22202 When optional argument N is a positive integer, remove exactly
22203 that much characters from indentation, if possible. Return nil
22206 (goto-char (point-min))
22207 ;; Find maximum common indentation, if not specified.
22209 (let ((min-ind (point-max)))
22211 (while (re-search-forward "^[ \t]*\\S-" nil t)
22212 (let ((ind (1- (current-column))))
22213 (if (zerop ind) (throw :exit nil)
22214 (setq min-ind (min min-ind ind))))))
22216 (if (zerop n) (throw :exit nil)
22217 ;; Remove exactly N indentation, but give up if not possible.
22218 (while (not (eobp))
22219 (let ((ind (progn (skip-chars-forward " \t") (current-column))))
22220 (cond ((eolp) (delete-region (line-beginning-position) (point)))
22221 ((< ind n) (throw :exit nil))
22222 (t (indent-line-to (- ind n))))
22227 (defun org-fill-template (template alist)
22228 "Find each %key of ALIST in TEMPLATE and replace it."
22229 (let ((case-fold-search nil))
22230 (dolist (entry (sort (copy-sequence alist)
22231 (lambda (a b) (< (length (car a)) (length (car b))))))
22233 (replace-regexp-in-string
22234 (concat "%" (regexp-quote (car entry)))
22235 (or (cdr entry) "") template t t)))
22238 (defun org-base-buffer (buffer)
22239 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22242 (or (buffer-base-buffer buffer)
22245 (defun org-wrap (string &optional width lines)
22246 "Wrap string to either a number of lines, or a width in characters.
22247 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22248 that costs. If there is a word longer than WIDTH, the text is actually
22249 wrapped to the length of that word.
22250 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22251 many lines, whatever width that takes.
22252 The return value is a list of lines, without newlines at the end."
22253 (let* ((words (org-split-string string "[ \t\n]+"))
22254 (maxword (apply 'max (mapcar 'org-string-width words)))
22257 (org-do-wrap words (max maxword width)))
22260 (setq ll (org-do-wrap words maxword))
22261 (if (<= (length ll) lines)
22264 (while (> (length ll) lines)
22266 (setq ll (org-do-wrap words w)))
22268 (t (error "Cannot wrap this")))))
22270 (defun org-do-wrap (words width)
22271 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22274 (setq line (pop words))
22275 (while (and words (< (+ (length line) (length (car words))) width))
22276 (setq line (concat line " " (pop words))))
22277 (setq lines (push line lines)))
22280 (defun org-split-string (string &optional separators)
22281 "Splits STRING into substrings at SEPARATORS.
22282 SEPARATORS is a regular expression.
22283 No empty strings are returned if there are matches at the beginning
22284 and end of string."
22285 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22286 (let ((start 0) notfirst list)
22287 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22289 (= start (match-beginning 0))
22290 (< start (length string)))
22292 (< (match-beginning 0) (length string)))
22294 (or (eq (match-beginning 0) 0)
22295 (and (eq (match-beginning 0) (match-end 0))
22296 (eq (match-beginning 0) start))
22297 (push (substring string start (match-beginning 0)) list))
22298 (setq start (match-end 0)))
22299 (or (eq start (length string))
22300 (push (substring string start) list))
22303 (defun org-quote-vert (s)
22304 "Replace \"|\" with \"\\vert\"."
22305 (while (string-match "|" s)
22306 (setq s (replace-match "\\vert" t t s)))
22309 (defun org-uuidgen-p (s)
22310 "Is S an ID created by UUIDGEN?"
22311 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22313 (defun org-in-src-block-p (&optional inside)
22314 "Whether point is in a code source block.
22315 When INSIDE is non-nil, don't consider we are within a src block
22316 when point is at #+BEGIN_SRC or #+END_SRC."
22317 (let ((case-fold-search t))
22318 (or (and (eq (get-char-property (point) 'src-block) t))
22322 (beginning-of-line)
22323 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22325 (defun org-context ()
22326 "Return a list of contexts of the current cursor position.
22327 If several contexts apply, all are returned.
22328 Each context entry is a list with a symbol naming the context, and
22329 two positions indicating start and end of the context. Possible
22332 :headline anywhere in a headline
22333 :headline-stars on the leading stars in a headline
22334 :todo-keyword on a TODO keyword (including DONE) in a headline
22335 :tags on the TAGS in a headline
22336 :priority on the priority cookie in a headline
22337 :item on the first line of a plain list item
22338 :item-bullet on the bullet/number of a plain list item
22339 :checkbox on the checkbox in a plain list item
22340 :table in an Org table
22341 :table-special on a special filed in a table
22342 :table-table in a table.el table
22343 :clocktable in a clocktable
22344 :src-block in a source block
22345 :link on a hyperlink
22346 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22347 :target on a <<target>>
22348 :radio-target on a <<<radio-target>>>
22349 :latex-fragment on a LaTeX fragment
22350 :latex-preview on a LaTeX fragment with overlaid preview image
22352 This function expects the position to be visible because it uses font-lock
22353 faces as a help to recognize the following contexts: :table-special, :link,
22355 (let* ((f (get-text-property (point) 'face))
22356 (faces (if (listp f) f (list f)))
22357 (case-fold-search t)
22358 (p (point)) clist o)
22359 ;; First the large context
22361 ((org-at-heading-p t)
22362 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22364 (beginning-of-line 1)
22365 (looking-at org-todo-line-tags-regexp))
22366 (push (org-point-in-group p 1 :headline-stars) clist)
22367 (push (org-point-in-group p 2 :todo-keyword) clist)
22368 (push (org-point-in-group p 4 :tags) clist))
22370 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22371 (when (looking-at "\\[#[A-Z0-9]\\]")
22372 (push (org-point-in-group p 0 :priority) clist)))
22375 (push (org-point-in-group p 2 :item-bullet) clist)
22376 (push (list :item (point-at-bol)
22377 (save-excursion (org-end-of-item) (point)))
22379 (and (org-at-item-checkbox-p)
22380 (push (org-point-in-group p 0 :checkbox) clist)))
22383 (push (list :table (org-table-begin) (org-table-end)) clist)
22384 (when (memq 'org-formula faces)
22385 (push (list :table-special
22386 (previous-single-property-change p 'face)
22387 (next-single-property-change p 'face)) clist)))
22388 ((org-at-table-p 'any)
22389 (push (list :table-table) clist)))
22392 (let ((case-fold-search t))
22393 ;; New the "medium" contexts: clocktables, source blocks
22394 (cond ((org-in-clocktable-p)
22395 (push (list :clocktable
22396 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22397 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22398 (match-beginning 1))
22399 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22400 (match-end 0))) clist))
22401 ((org-in-src-block-p)
22402 (push (list :src-block
22403 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22404 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22405 (match-beginning 1))
22406 (and (search-forward "#+END_SRC" nil t)
22407 (match-beginning 0))) clist))))
22410 ;; Now the small context
22412 ((org-at-timestamp-p)
22413 (push (org-point-in-group p 0 :timestamp) clist))
22414 ((memq 'org-link faces)
22416 (previous-single-property-change p 'face)
22417 (next-single-property-change p 'face)) clist))
22418 ((memq 'org-special-keyword faces)
22419 (push (list :keyword
22420 (previous-single-property-change p 'face)
22421 (next-single-property-change p 'face)) clist))
22423 (push (org-point-in-group p 0 :target) clist)
22424 (goto-char (1- (match-beginning 0)))
22425 (when (looking-at org-radio-target-regexp)
22426 (push (org-point-in-group p 0 :radio-target) clist))
22430 (and (eq (overlay-get o 'org-overlay-type) 'org-latex-overlay)
22432 (overlays-at (point))))
22433 (push (list :latex-fragment
22434 (overlay-start o) (overlay-end o)) clist)
22435 (push (list :latex-preview
22436 (overlay-start o) (overlay-end o)) clist))
22437 ((org-inside-LaTeX-fragment-p)
22438 ;; FIXME: positions wrong.
22439 (push (list :latex-fragment (point) (point)) clist)))
22441 (setq clist (nreverse (delq nil clist)))
22444 (defun org-in-regexp (regexp &optional nlines visually)
22445 "Check if point is inside a match of REGEXP.
22447 Normally only the current line is checked, but you can include
22448 NLINES extra lines around point into the search. If VISUALLY is
22449 set, require that the cursor is not after the match but really
22450 on, so that the block visually is on the match.
22452 Return nil or a cons cell (BEG . END) where BEG and END are,
22453 respectively, the positions at the beginning and the end of the
22456 (let ((pos (point))
22457 (eol (line-end-position (if nlines (1+ nlines) 1))))
22459 (beginning-of-line (- 1 (or nlines 0)))
22460 (while (and (re-search-forward regexp eol t)
22461 (<= (match-beginning 0) pos))
22462 (let ((end (match-end 0)))
22463 (when (or (> end pos) (and (= end pos) (not visually)))
22464 (throw :exit (cons (match-beginning 0) (match-end 0))))))))))
22466 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22467 "Non-nil when point is between matches of START-RE and END-RE.
22469 Also return a non-nil value when point is on one of the matches.
22471 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22472 buffer positions. Default values are the positions of headlines
22473 surrounding the point.
22475 The functions returns a cons cell whose car (resp. cdr) is the
22476 position before START-RE (resp. after END-RE)."
22478 (let ((pos (point))
22479 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22480 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22483 ;; Point is on a block when on START-RE or if START-RE can be
22484 ;; found before it...
22485 (and (or (org-in-regexp start-re)
22486 (re-search-backward start-re limit-up t))
22487 (setq beg (match-beginning 0))
22488 ;; ... and END-RE after it...
22489 (goto-char (match-end 0))
22490 (re-search-forward end-re limit-down t)
22491 (> (setq end (match-end 0)) pos)
22492 ;; ... without another START-RE in-between.
22493 (goto-char (match-beginning 0))
22494 (not (re-search-backward start-re (1+ beg) t))
22496 (cons beg end))))))
22498 (defun org-in-block-p (names)
22499 "Non-nil when point belongs to a block whose name belongs to NAMES.
22501 NAMES is a list of strings containing names of blocks.
22503 Return first block name matched, or nil. Beware that in case of
22504 nested blocks, the returned name may not belong to the closest
22508 (let ((case-fold-search t)
22509 (lim-up (save-excursion (outline-previous-heading)))
22510 (lim-down (save-excursion (outline-next-heading))))
22511 (dolist (name names)
22512 (let ((n (regexp-quote name)))
22513 (when (org-between-regexps-p
22514 (concat "^[ \t]*#\\+begin_" n)
22515 (concat "^[ \t]*#\\+end_" n)
22517 (throw 'exit n)))))
22520 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22521 "Call `multi-occur' with buffers for all agenda files."
22522 (interactive "sOrg-files matching: ")
22523 (let* ((files (org-agenda-files))
22524 (tnames (mapcar #'file-truename files))
22525 (extra org-agenda-text-search-extra-files))
22526 (when (eq (car extra) 'agenda-archives)
22527 (setq extra (cdr extra))
22528 (setq files (org-add-archive-files files)))
22530 (unless (member (file-truename f) tnames)
22531 (unless (member f files) (setq files (append files (list f))))
22532 (setq tnames (append tnames (list (file-truename f))))))
22534 (mapcar (lambda (x)
22535 (with-current-buffer
22536 ;; FIXME: Why not just (find-file-noselect x)?
22537 ;; Is it to avoid the "revert buffer" prompt?
22538 (or (get-file-buffer x) (find-file-noselect x))
22544 (add-hook 'occur-mode-find-occurrence-hook
22545 (lambda () (when (derived-mode-p 'org-mode) (org-reveal))))
22547 (defun org-occur-link-in-agenda-files ()
22548 "Create a link and search for it in the agendas.
22549 The link is not stored in `org-stored-links', it is just created
22550 for the search purpose."
22552 (let ((link (condition-case nil
22553 (org-store-link nil)
22554 (error "Unable to create a link to here"))))
22555 (org-occur-in-agenda-files (regexp-quote link))))
22557 (defun org-reverse-string (string)
22558 "Return the reverse of STRING."
22559 (apply 'string (reverse (string-to-list string))))
22561 ;; defsubst org-uniquify must be defined before first use
22563 (defun org-uniquify-alist (alist)
22564 "Merge elements of ALIST with the same key.
22566 For example, in this alist:
22568 \(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
22569 => \\='((a 1 3) (b 2))
22571 merge (a 1) and (a 3) into (a 1 3).
22573 The function returns the new ALIST."
22575 (dolist (e alist rtn)
22577 (if (not (assoc (car e) rtn))
22579 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22580 (setq rtn (assq-delete-all (car e) rtn))
22583 (defun org-delete-all (elts list)
22584 "Remove all elements in ELTS from LIST.
22585 Comparison is done with `equal'. It is a destructive operation
22586 that may remove elements by altering the list structure."
22588 (setq list (delete (pop elts) list)))
22591 (defun org-back-over-empty-lines ()
22592 "Move backwards over whitespace, to the beginning of the first empty line.
22593 Returns the number of empty lines passed."
22594 (let ((pos (point)))
22595 (if (cdr (assq 'heading org-blank-before-new-entry))
22596 (skip-chars-backward " \t\n\r")
22598 (forward-line -1)))
22599 (beginning-of-line 2)
22600 (goto-char (min (point) pos))
22601 (count-lines (point) pos)))
22603 (defun org-skip-whitespace ()
22604 (skip-chars-forward " \t\n\r"))
22606 (defun org-point-in-group (point group &optional context)
22607 "Check if POINT is in match-group GROUP.
22608 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22609 match. If the match group does not exist or point is not inside it,
22611 (and (match-beginning group)
22612 (>= point (match-beginning group))
22613 (<= point (match-end group))
22615 (list context (match-beginning group) (match-end group))
22618 (defun org-switch-to-buffer-other-window (&rest args)
22619 "Switch to buffer in a second window on the current frame.
22620 In particular, do not allow pop-up frames.
22621 Returns the newly created buffer."
22623 (apply 'switch-to-buffer-other-window args)))
22625 (defun org-combine-plists (&rest plists)
22626 "Create a single property list from all plists in PLISTS.
22627 The process starts by copying the first list, and then setting properties
22628 from the other lists. Settings in the last list are the most significant
22629 ones and overrule settings in the other lists."
22630 (let ((rtn (copy-sequence (pop plists)))
22633 (setq ls (pop plists))
22635 (setq p (pop ls) v (pop ls))
22636 (setq rtn (plist-put rtn p v))))
22639 (defun org-replace-escapes (string table)
22640 "Replace %-escapes in STRING with values in TABLE.
22641 TABLE is an association list with keys like \"%a\" and string values.
22642 The sequences in STRING may contain normal field width and padding information,
22643 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22644 so values can contain further %-escapes if they are define later in TABLE."
22645 (let ((tbl (copy-alist table))
22646 (case-fold-search nil)
22650 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22651 (when (and (cdr e) (string-match re (cdr e)))
22652 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22654 (add-text-properties 0 3 (list 'sref sref) safe)
22655 (setcdr e (replace-match safe t t (cdr e)))))
22656 (while (string-match re string)
22657 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22659 (setq string (replace-match rpl t t string))))
22660 (while (setq pchg (next-property-change pchg string))
22661 (let ((sref (get-text-property pchg 'sref string)))
22662 (when (and sref (string-match "SREF" string pchg))
22663 (setq string (replace-match sref t t string)))))
22666 (defun org-find-base-buffer-visiting (file)
22667 "Like `find-buffer-visiting' but always return the base buffer and
22668 not an indirect buffer."
22669 (let ((buf (or (get-file-buffer file)
22670 (find-buffer-visiting file))))
22672 (or (buffer-base-buffer buf) buf)
22675 ;;; TODO: Only called once, from ox-odt which should probably use
22676 ;;; org-export-inline-image-p or something.
22677 (defun org-file-image-p (file)
22678 "Return non-nil if FILE is an image."
22680 (string-match (image-file-name-regexp) file)))
22682 (defun org-get-cursor-date (&optional with-time)
22683 "Return the date at cursor in as a time.
22684 This works in the calendar and in the agenda, anywhere else it just
22685 returns the current time.
22686 If WITH-TIME is non-nil, returns the time of the event at point (in
22687 the agenda) or the current time of the day."
22688 (let (date day defd tp hod mod)
22690 (setq tp (get-text-property (point) 'time))
22691 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22692 (setq hod (string-to-number (match-string 1 tp))
22693 mod (string-to-number (match-string 2 tp))))
22694 (or tp (let ((now (decode-time)))
22695 (setq hod (nth 2 now)
22696 mod (nth 1 now)))))
22698 ((eq major-mode 'calendar-mode)
22699 (setq date (calendar-cursor-to-date)
22700 defd (encode-time 0 (or mod 0) (or hod 0)
22701 (nth 1 date) (nth 0 date) (nth 2 date))))
22702 ((eq major-mode 'org-agenda-mode)
22703 (setq day (get-text-property (point) 'day))
22705 (setq date (calendar-gregorian-from-absolute day)
22706 defd (encode-time 0 (or mod 0) (or hod 0)
22707 (nth 1 date) (nth 0 date) (nth 2 date))))))
22708 (or defd (current-time))))
22710 (defun org-mark-subtree (&optional up)
22711 "Mark the current subtree.
22712 This puts point at the start of the current subtree, and mark at
22713 the end. If a numeric prefix UP is given, move up into the
22714 hierarchy of headlines by UP levels before marking the subtree."
22716 (org-with-limited-levels
22717 (cond ((org-at-heading-p) (beginning-of-line))
22718 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22719 (t (outline-previous-visible-heading 1))))
22720 (when up (while (and (> up 0) (org-up-heading-safe)) (cl-decf up)))
22721 (if (called-interactively-p 'any)
22722 (call-interactively 'org-mark-element)
22723 (org-mark-element)))
22725 (defun org-file-newer-than-p (file time)
22726 "Non-nil if FILE is newer than TIME.
22727 FILE is a filename, as a string, TIME is a list of integers, as
22728 returned by, e.g., `current-time'."
22729 (and (file-exists-p file)
22730 ;; Only compare times up to whole seconds as some file-systems
22731 ;; (e.g. HFS+) do not retain any finer granularity. As
22732 ;; a consequence, make sure we return non-nil when the two
22733 ;; times are equal.
22734 (not (time-less-p (cl-subseq (nth 5 (file-attributes file)) 0 2)
22735 (cl-subseq time 0 2)))))
22737 (defun org-compile-file (source process ext &optional err-msg log-buf spec)
22738 "Compile a SOURCE file using PROCESS.
22740 PROCESS is either a function or a list of shell commands, as
22741 strings. EXT is a file extension, without the leading dot, as
22742 a string. It is used to check if the process actually succeeded.
22744 PROCESS must create a file with the same base name and directory
22745 as SOURCE, but ending with EXT. The function then returns its
22746 filename. Otherwise, it raises an error. The error message can
22747 then be refined by providing string ERR-MSG, which is appended to
22748 the standard message.
22750 If PROCESS is a function, it is called with a single argument:
22753 If it is a list of commands, each of them is called using
22754 `shell-command'. By default, in each command, %b, %f, %F, %o and
22755 %O are replaced with, respectively, SOURCE base name, name, full
22756 name, directory and absolute output file name. It is possible,
22757 however, to use more place-holders by specifying them in optional
22758 argument SPEC, as an alist following the pattern
22760 (CHARACTER . REPLACEMENT-STRING).
22762 When PROCESS is a list of commands, optional argument LOG-BUF can
22763 be set to a buffer or a buffer name. `shell-command' then uses
22765 (let* ((base-name (file-name-base source))
22766 (full-name (file-truename source))
22767 (out-dir (or (file-name-directory source) "./"))
22768 (output (expand-file-name (concat base-name "." ext) out-dir))
22769 (time (current-time))
22770 (err-msg (if (stringp err-msg) (concat ". " err-msg) "")))
22771 (save-window-excursion
22773 ((pred functionp) (funcall process (shell-quote-argument source)))
22775 (let ((log-buf (and log-buf (get-buffer-create log-buf)))
22777 `((?b . ,(shell-quote-argument base-name))
22778 (?f . ,(shell-quote-argument source))
22779 (?F . ,(shell-quote-argument full-name))
22780 (?o . ,(shell-quote-argument out-dir))
22781 (?O . ,(shell-quote-argument output))))))
22782 (dolist (command process)
22783 (shell-command (format-spec command spec) log-buf))))
22784 (_ (error "No valid command to process %S%s" source err-msg))))
22785 ;; Check for process failure. Output file is expected to be
22786 ;; located in the same directory as SOURCE.
22787 (unless (org-file-newer-than-p output time)
22788 (error (format "File %S wasn't produced%s" output err-msg)))
22793 (defun org--get-expected-indentation (element contentsp)
22794 "Expected indentation column for current line, according to ELEMENT.
22795 ELEMENT is an element containing point. CONTENTSP is non-nil
22796 when indentation is to be computed according to contents of
22798 (let ((type (org-element-type element))
22799 (start (org-element-property :begin element))
22800 (post-affiliated (org-element-property :post-affiliated element)))
22801 (org-with-wide-buffer
22805 ((diary-sexp footnote-definition) 0)
22806 ((headline inlinetask nil)
22807 (if (not org-adapt-indentation) 0
22808 (let ((level (org-current-level)))
22809 (if level (1+ level) 0))))
22810 ((item plain-list) (org-list-item-body-column post-affiliated))
22813 (org-get-indentation))))
22814 ((memq type '(headline inlinetask nil))
22815 (if (org-match-line "[ \t]*$")
22816 (org--get-expected-indentation element t)
22818 ((memq type '(diary-sexp footnote-definition)) 0)
22819 ;; First paragraph of a footnote definition or an item.
22820 ;; Indent like parent.
22821 ((< (line-beginning-position) start)
22822 (org--get-expected-indentation
22823 (org-element-property :parent element) t))
22824 ;; At first line: indent according to previous sibling, if any,
22825 ;; ignoring footnote definitions and inline tasks, or parent's
22827 ((= (line-beginning-position) start)
22830 (if (= (point-min) start) (throw 'exit 0)
22831 (goto-char (1- start))
22832 (let* ((previous (org-element-at-point))
22834 (while (and parent (<= (org-element-property :end parent) start))
22835 (setq previous parent
22836 parent (org-element-property :parent parent)))
22838 ((not previous) (throw 'exit 0))
22839 ((> (org-element-property :end previous) start)
22840 (throw 'exit (org--get-expected-indentation previous t)))
22841 ((memq (org-element-type previous)
22842 '(footnote-definition inlinetask))
22843 (setq start (org-element-property :begin previous)))
22844 (t (goto-char (org-element-property :begin previous))
22846 (if (bolp) (org-get-indentation)
22847 ;; At first paragraph in an item or
22848 ;; a footnote definition.
22849 (org--get-expected-indentation
22850 (org-element-property :parent previous) t))))))))))
22851 ;; Otherwise, move to the first non-blank line above.
22853 (beginning-of-line)
22854 (let ((pos (point)))
22855 (skip-chars-backward " \r\t\n")
22857 ;; Two blank lines end a footnote definition or a plain
22858 ;; list. When we indent an empty line after them, the
22859 ;; containing list or footnote definition is over, so it
22860 ;; qualifies as a previous sibling. Therefore, we indent
22861 ;; like its first line.
22862 ((and (memq type '(footnote-definition plain-list))
22863 (> (count-lines (point) pos) 2))
22865 (org-get-indentation))
22866 ;; Line above is the first one of a paragraph at the
22867 ;; beginning of an item or a footnote definition. Indent
22869 ((< (line-beginning-position) start)
22870 (org--get-expected-indentation
22871 (org-element-property :parent element) t))
22872 ;; Line above is the beginning of an element, i.e., point
22873 ;; was originally on the blank lines between element's start
22875 ((= (line-beginning-position) post-affiliated)
22876 (org--get-expected-indentation element t))
22877 ;; POS is after contents in a greater element. Indent like
22878 ;; the beginning of the element.
22880 ;; As a special case, if point is at the end of a footnote
22881 ;; definition or an item, indent like the very last element
22882 ;; within. If that last element is an item, indent like its
22884 ((and (not (eq type 'paragraph))
22885 (let ((cend (org-element-property :contents-end element)))
22886 (and cend (<= cend pos))))
22887 (if (memq type '(footnote-definition item plain-list))
22888 (let ((last (org-element-at-point)))
22889 (org--get-expected-indentation
22890 last (eq (org-element-type last) 'item)))
22892 (org-get-indentation)))
22893 ;; In any other case, indent like the current line.
22894 (t (org-get-indentation)))))))))
22896 (defun org--align-node-property ()
22897 "Align node property at point.
22898 Alignment is done according to `org-property-format', which see."
22899 (when (save-excursion
22900 (beginning-of-line)
22901 (looking-at org-property-re))
22903 (concat (match-string 4)
22905 (format org-property-format (match-string 1) (match-string 3))))
22908 (defun org-indent-line ()
22909 "Indent line depending on context.
22911 Indentation is done according to the following rules:
22913 - Footnote definitions, diary sexps, headlines and inline tasks
22914 have to start at column 0.
22916 - On the very first line of an element, consider, in order, the
22917 next rules until one matches:
22919 1. If there's a sibling element before, ignoring footnote
22920 definitions and inline tasks, indent like its first line.
22922 2. If element has a parent, indent like its contents. More
22923 precisely, if parent is an item, indent after the
22924 description part, if any, or the bullet (see
22925 `org-list-description-max-indent'). Else, indent like
22926 parent's first line.
22928 3. Otherwise, indent relatively to current level, if
22929 `org-adapt-indentation' is non-nil, or to left margin.
22931 - On a blank line at the end of an element, indent according to
22932 the type of the element. More precisely
22934 1. If element is a plain list, an item, or a footnote
22935 definition, indent like the very last element within.
22937 2. If element is a paragraph, indent like its last non blank
22940 3. Otherwise, indent like its very first line.
22942 - In the code part of a source block, use language major mode
22943 to indent current line if `org-src-tab-acts-natively' is
22944 non-nil. If it is nil, do nothing.
22946 - Otherwise, indent like the first non-blank line above.
22948 The function doesn't indent an item as it could break the whole
22949 list structure. Instead, use \\<org-mode-map>`\\[org-shiftmetaleft]' or \
22950 `\\[org-shiftmetaright]'.
22952 Also align node properties according to `org-property-format'."
22956 (let ((indent-line-function
22957 (cl-cadadr (assq 'indent-line-function org-fb-vars))))
22958 (indent-according-to-mode)))
22959 ((org-at-heading-p) 'noindent)
22961 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22962 (type (org-element-type element)))
22963 (cond ((and (memq type '(plain-list item))
22964 (= (line-beginning-position)
22965 (org-element-property :post-affiliated element)))
22967 ((and (eq type 'latex-environment)
22968 (>= (point) (org-element-property :post-affiliated element))
22969 (< (point) (org-with-wide-buffer
22970 (goto-char (org-element-property :end element))
22971 (skip-chars-backward " \r\t\n")
22972 (line-beginning-position 2))))
22974 ((and (eq type 'src-block)
22975 org-src-tab-acts-natively
22976 (> (line-beginning-position)
22977 (org-element-property :post-affiliated element))
22978 (< (line-beginning-position)
22979 (org-with-wide-buffer
22980 (goto-char (org-element-property :end element))
22981 (skip-chars-backward " \r\t\n")
22982 (line-beginning-position))))
22983 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22985 (let ((column (org--get-expected-indentation element nil)))
22986 ;; Preserve current column.
22987 (if (<= (current-column) (current-indentation))
22988 (indent-line-to column)
22989 (save-excursion (indent-line-to column))))
22990 ;; Align node property. Also preserve current column.
22991 (when (eq type 'node-property)
22992 (let ((column (current-column)))
22993 (org--align-node-property)
22994 (org-move-to-column column)))))))))
22996 (defun org-indent-region (start end)
22997 "Indent each non-blank line in the region.
22998 Called from a program, START and END specify the region to
22999 indent. The function will not indent contents of example blocks,
23000 verse blocks and export blocks as leading white spaces are
23001 assumed to be significant there."
23005 (skip-chars-forward " \r\t\n")
23006 (unless (eobp) (beginning-of-line))
23009 ;; Set IND as indentation for all lines between point and
23010 ;; POS. Blank lines are ignored. Leave point after POS
23012 (let ((limit (copy-marker pos)))
23013 (while (< (point) limit)
23014 (unless (looking-at-p "[ \t]*$") (indent-line-to ind))
23016 (set-marker limit nil))))
23017 (end (copy-marker end)))
23018 (while (< (point) end)
23019 (if (or (looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23020 (let* ((element (org-element-at-point))
23021 (type (org-element-type element))
23022 (element-end (copy-marker (org-element-property :end element)))
23023 (ind (org--get-expected-indentation element nil)))
23025 ;; Element indented as a single block. Example blocks
23026 ;; preserving indentation are a special case since the
23027 ;; "contents" must not be indented whereas the block
23029 ((or (memq type '(export-block latex-environment))
23030 (and (eq type 'example-block)
23032 (or org-src-preserve-indentation
23033 (org-element-property :preserve-indent element)))))
23034 (let ((offset (- ind (org-get-indentation))))
23035 (unless (zerop offset)
23036 (indent-rigidly (org-element-property :begin element)
23037 (org-element-property :end element)
23039 (goto-char element-end))
23040 ;; Elements indented line wise. Be sure to exclude
23041 ;; example blocks (preserving indentation) and source
23042 ;; blocks from this category as they are treated
23043 ;; specially later.
23044 ((or (memq type '(paragraph table table-row))
23045 (not (or (org-element-property :contents-begin element)
23046 (memq type '(example-block src-block)))))
23047 (when (eq type 'node-property)
23048 (org--align-node-property)
23049 (beginning-of-line))
23050 (funcall indent-to ind (min element-end end)))
23051 ;; Elements consisting of three parts: before the
23052 ;; contents, the contents, and after the contents. The
23053 ;; contents are treated specially, according to the
23054 ;; element type, or not indented at all. Other parts are
23055 ;; indented as a single block.
23057 (let* ((post (copy-marker
23058 (org-element-property :post-affiliated element)))
23062 ((not (org-element-property :contents-begin element))
23063 ;; Fake contents for source blocks.
23064 (org-with-wide-buffer
23066 (line-beginning-position 2)))
23067 ((memq type '(footnote-definition item plain-list))
23068 ;; Contents in these elements could start on
23069 ;; the same line as the beginning of the
23070 ;; element. Make sure we start indenting
23071 ;; from the second line.
23072 (org-with-wide-buffer
23075 (skip-chars-forward " \r\t\n")
23076 (if (eobp) (point) (line-beginning-position))))
23077 (t (org-element-property :contents-begin element)))))
23079 (or (org-element-property :contents-end element)
23080 ;; Fake contents for source blocks.
23081 (org-with-wide-buffer
23082 (goto-char element-end)
23083 (skip-chars-backward " \r\t\n")
23084 (line-beginning-position)))
23086 ;; Do not change items indentation individually as it
23087 ;; might break the list as a whole. On the other
23088 ;; hand, when at a plain list, indent it as a whole.
23089 (cond ((eq type 'plain-list)
23090 (let ((offset (- ind (org-get-indentation))))
23091 (unless (zerop offset)
23092 (indent-rigidly (org-element-property :begin element)
23093 (org-element-property :end element)
23096 ((eq type 'item) (goto-char cbeg))
23097 (t (funcall indent-to ind (min cbeg end))))
23098 (when (< (point) end)
23100 ((example-block verse-block))
23102 ;; In a source block, indent source code
23103 ;; according to language major mode, but only if
23104 ;; `org-src-tab-acts-natively' is non-nil.
23105 (when (and (< (point) end) org-src-tab-acts-natively)
23107 (org-babel-do-in-edit-buffer
23108 (indent-region (point-min) (point-max))))))
23109 (t (org-indent-region (point) (min cend end))))
23110 (goto-char (min cend end))
23111 (when (< (point) end)
23112 (funcall indent-to ind (min element-end end))))
23113 (set-marker post nil)
23114 (set-marker cbeg nil)
23115 (set-marker cend nil))))
23116 (set-marker element-end nil))))
23117 (set-marker end nil))))
23119 (defun org-indent-drawer ()
23120 "Indent the drawer at point."
23122 (unless (save-excursion
23123 (beginning-of-line)
23124 (looking-at-p org-drawer-regexp))
23125 (user-error "Not at a drawer"))
23126 (let ((element (org-element-at-point)))
23127 (unless (memq (org-element-type element) '(drawer property-drawer))
23128 (user-error "Not at a drawer"))
23129 (org-with-wide-buffer
23130 (org-indent-region (org-element-property :begin element)
23131 (org-element-property :end element))))
23132 (message "Drawer at point indented"))
23134 (defun org-indent-block ()
23135 "Indent the block at point."
23137 (unless (save-excursion
23138 (beginning-of-line)
23139 (let ((case-fold-search t))
23140 (looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23141 (user-error "Not at a block"))
23142 (let ((element (org-element-at-point)))
23143 (unless (memq (org-element-type element)
23144 '(comment-block center-block dynamic-block example-block
23145 export-block quote-block special-block
23146 src-block verse-block))
23147 (user-error "Not at a block"))
23148 (org-with-wide-buffer
23149 (org-indent-region (org-element-property :begin element)
23150 (org-element-property :end element))))
23151 (message "Block at point indented"))
23156 ;; We use our own fill-paragraph and auto-fill functions.
23158 ;; `org-fill-paragraph' relies on adaptive filling and context
23159 ;; checking. Appropriate `fill-prefix' is computed with
23160 ;; `org-adaptive-fill-function'.
23162 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23163 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23164 ;; `org-adaptive-fill-function' value. Internally,
23165 ;; `org-comment-line-break-function' breaks the line.
23167 ;; `org-setup-filling' installs filling and auto-filling related
23168 ;; variables during `org-mode' initialization.
23170 (defvar org-element-paragraph-separate) ; org-element.el
23171 (defun org-setup-filling ()
23172 (require 'org-element)
23173 ;; Prevent auto-fill from inserting unwanted new items.
23174 (when (boundp 'fill-nobreak-predicate)
23176 fill-nobreak-predicate
23178 (append fill-nobreak-predicate
23179 '(org-fill-line-break-nobreak-p
23180 org-fill-paragraph-with-timestamp-nobreak-p)))))
23181 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23182 (setq-local paragraph-start paragraph-ending)
23183 (setq-local paragraph-separate paragraph-ending))
23184 (setq-local fill-paragraph-function 'org-fill-paragraph)
23185 (setq-local auto-fill-inhibit-regexp nil)
23186 (setq-local adaptive-fill-function 'org-adaptive-fill-function)
23187 (setq-local normal-auto-fill-function 'org-auto-fill-function)
23188 (setq-local comment-line-break-function 'org-comment-line-break-function))
23190 (defun org-fill-line-break-nobreak-p ()
23191 "Non-nil when a new line at point would create an Org line break."
23193 (skip-chars-backward "[ \t]")
23194 (skip-chars-backward "\\\\")
23195 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23197 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23198 "Non-nil when a new line at point would split a timestamp."
23199 (and (org-at-timestamp-p t)
23200 (not (looking-at org-ts-regexp-both))))
23202 (declare-function message-in-body-p "message" ())
23203 (defvar orgtbl-line-start-regexp) ; From org-table.el
23204 (defun org-adaptive-fill-function ()
23205 "Compute a fill prefix for the current line.
23206 Return fill prefix, as a string, or nil if current line isn't
23207 meant to be filled. For convenience, if `adaptive-fill-regexp'
23208 matches in paragraphs or comments, use it."
23210 (when (derived-mode-p 'message-mode)
23212 (beginning-of-line)
23213 (cond ((not (message-in-body-p)) (throw 'exit nil))
23214 ((looking-at-p org-table-line-regexp) (throw 'exit nil))
23215 ((looking-at message-cite-prefix-regexp)
23216 (throw 'exit (match-string-no-properties 0)))
23217 ((looking-at org-outline-regexp)
23218 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23219 (org-with-wide-buffer
23220 (unless (org-at-heading-p)
23221 (let* ((p (line-beginning-position))
23222 (element (save-excursion
23223 (beginning-of-line)
23224 (org-element-at-point)))
23225 (type (org-element-type element))
23226 (post-affiliated (org-element-property :post-affiliated element)))
23227 (unless (< p post-affiliated)
23231 (beginning-of-line)
23232 (looking-at "[ \t]*")
23233 (concat (match-string 0) "# ")))
23234 (footnote-definition "")
23236 (make-string (org-list-item-body-column post-affiliated) ?\s))
23238 ;; Fill prefix is usually the same as the current line,
23239 ;; unless the paragraph is at the beginning of an item.
23240 (let ((parent (org-element-property :parent element)))
23242 (beginning-of-line)
23243 (cond ((eq (org-element-type parent) 'item)
23244 (make-string (org-list-item-body-column
23245 (org-element-property :begin parent))
23247 ((and adaptive-fill-regexp
23249 ;; `adaptive-fill-function' to let
23250 ;; `fill-context-prefix' handle
23251 ;; `adaptive-fill-regexp' variable.
23252 (let (adaptive-fill-function)
23253 (fill-context-prefix
23255 (org-element-property :end element)))))
23256 ((looking-at "[ \t]+") (match-string 0))
23259 ;; Only fill contents if P is within block boundaries.
23260 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23263 (cend (save-excursion
23264 (goto-char (org-element-property :end element))
23265 (skip-chars-backward " \r\t\n")
23266 (line-beginning-position))))
23267 (when (and (>= p cbeg) (< p cend))
23268 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23272 (declare-function message-goto-body "message" ())
23273 (defvar message-cite-prefix-regexp) ; From message.el
23274 (defun org-fill-paragraph (&optional justify)
23275 "Fill element at point, when applicable.
23277 This function only applies to comment blocks, comments, example
23278 blocks and paragraphs. Also, as a special case, re-align table
23279 when point is at one.
23281 If JUSTIFY is non-nil (interactively, with prefix argument),
23282 justify as well. If `sentence-end-double-space' is non-nil, then
23283 period followed by one space does not end a sentence, so don't
23284 break a line there. The variable `fill-column' controls the
23287 For convenience, when point is at a plain list, an item or
23288 a footnote definition, try to fill the first paragraph within."
23290 (if (and (derived-mode-p 'message-mode)
23291 (or (not (message-in-body-p))
23292 (save-excursion (move-beginning-of-line 1)
23293 (looking-at message-cite-prefix-regexp))))
23294 ;; First ensure filling is correct in message-mode.
23295 (let ((fill-paragraph-function
23296 (cl-cadadr (assq 'fill-paragraph-function org-fb-vars)))
23297 (fill-prefix (cl-cadadr (assq 'fill-prefix org-fb-vars)))
23298 (paragraph-start (cl-cadadr (assq 'paragraph-start org-fb-vars)))
23299 (paragraph-separate
23300 (cl-cadadr (assq 'paragraph-separate org-fb-vars))))
23301 (fill-paragraph nil))
23302 (with-syntax-table org-mode-transpose-word-syntax-table
23303 ;; Move to end of line in order to get the first paragraph
23304 ;; within a plain list or a footnote definition.
23305 (let ((element (save-excursion
23307 (or (ignore-errors (org-element-at-point))
23308 (user-error "An element cannot be parsed line %d"
23309 (line-number-at-pos (point)))))))
23310 ;; First check if point is in a blank line at the beginning of
23311 ;; the buffer. In that case, ignore filling.
23312 (cl-case (org-element-type element)
23313 ;; Use major mode filling function is src blocks.
23314 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23315 ;; Align Org tables, leave table.el tables as-is.
23316 (table-row (org-table-align) t)
23318 (when (eq (org-element-property :type element) 'org)
23320 (goto-char (org-element-property :post-affiliated element))
23321 (org-table-align)))
23324 ;; Paragraphs may contain `line-break' type objects.
23325 (let ((beg (max (point-min)
23326 (org-element-property :contents-begin element)))
23327 (end (min (point-max)
23328 (org-element-property :contents-end element))))
23329 ;; Do nothing if point is at an affiliated keyword.
23330 (if (< (line-end-position) beg) t
23331 (when (derived-mode-p 'message-mode)
23332 ;; In `message-mode', do not fill following citation
23333 ;; in current paragraph nor text before message body.
23334 (let ((body-start (save-excursion (message-goto-body))))
23335 (when body-start (setq beg (max body-start beg))))
23336 (when (save-excursion
23338 (concat "^" message-cite-prefix-regexp) end t))
23339 (setq end (match-beginning 0))))
23340 ;; Fill paragraph, taking line breaks into account.
23343 (let ((cuts (list beg)))
23344 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23345 (when (eq 'line-break
23347 (save-excursion (backward-char)
23348 (org-element-context))))
23349 (push (point) cuts)))
23350 (dolist (c (delq end cuts))
23351 (fill-region-as-paragraph c end justify)
23354 ;; Contents of `comment-block' type elements should be
23355 ;; filled as plain text, but only if point is within block
23358 (let* ((case-fold-search t)
23359 (beg (save-excursion
23360 (goto-char (org-element-property :begin element))
23361 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23364 (end (save-excursion
23365 (goto-char (org-element-property :end element))
23366 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23367 (line-beginning-position))))
23368 (if (or (< (point) beg) (> (point) end)) t
23369 (fill-region-as-paragraph
23370 (save-excursion (end-of-line)
23371 (re-search-backward "^[ \t]*$" beg 'move)
23372 (line-beginning-position))
23373 (save-excursion (beginning-of-line)
23374 (re-search-forward "^[ \t]*$" end 'move)
23375 (line-beginning-position))
23379 (let ((begin (org-element-property :post-affiliated element))
23380 (end (org-element-property :end element)))
23381 (when (and (>= (point) begin) (<= (point) end))
23382 (let ((begin (save-excursion
23384 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23385 (progn (forward-line) (point))
23387 (end (save-excursion
23389 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23390 (1- (line-beginning-position))
23391 (skip-chars-backward " \r\t\n")
23392 (line-end-position)))))
23393 ;; Do not fill comments when at a blank line.
23394 (when (> end begin)
23397 (beginning-of-line)
23398 (looking-at "[ \t]*#")
23399 (let ((comment-prefix (match-string 0)))
23400 (goto-char (match-end 0))
23401 (if (looking-at adaptive-fill-regexp)
23402 (concat comment-prefix (match-string 0))
23403 (concat comment-prefix " "))))))
23405 (fill-region-as-paragraph begin end justify))))))
23407 ;; Ignore every other element.
23410 (defun org-auto-fill-function ()
23411 "Auto-fill function."
23412 ;; Check if auto-filling is meaningful.
23413 (let ((fc (current-fill-column)))
23414 (when (and fc (> (current-column) fc))
23415 (let* ((fill-prefix (org-adaptive-fill-function))
23416 ;; Enforce empty fill prefix, if required. Otherwise, it
23417 ;; will be computed again.
23418 (adaptive-fill-mode (not (equal fill-prefix ""))))
23419 (when fill-prefix (do-auto-fill))))))
23421 (defun org-comment-line-break-function (&optional soft)
23422 "Break line at point and indent, continuing comment if within one.
23423 The inserted newline is marked hard if variable
23424 `use-hard-newlines' is true, unless optional argument SOFT is
23426 (if soft (insert-and-inherit ?\n) (newline 1))
23427 (save-excursion (forward-char -1) (delete-horizontal-space))
23428 (delete-horizontal-space)
23429 (indent-to-left-margin)
23430 (insert-before-markers-and-inherit fill-prefix))
23433 ;;; Fixed Width Areas
23435 (defun org-toggle-fixed-width ()
23436 "Toggle fixed-width markup.
23438 Add or remove fixed-width markup on current line, whenever it
23439 makes sense. Return an error otherwise.
23441 If a region is active and if it contains only fixed-width areas
23442 or blank lines, remove all fixed-width markup in it. If the
23443 region contains anything else, convert all non-fixed-width lines
23444 to fixed-width ones.
23446 Blank lines at the end of the region are ignored unless the
23447 region only contains such lines."
23449 (if (not (org-region-active-p))
23452 ;; Remove fixed width marker only in a fixed-with element.
23454 ;; Add fixed width maker in paragraphs, in blank lines after
23455 ;; elements or at the beginning of a headline or an inlinetask,
23456 ;; and before any one-line elements (e.g., a clock).
23458 (beginning-of-line)
23459 (let* ((element (org-element-at-point))
23460 (type (org-element-type element)))
23462 ((and (eq type 'fixed-width)
23463 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23465 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23466 ((and (memq type '(babel-call clock comment diary-sexp headline
23467 horizontal-rule keyword paragraph
23469 (<= (org-element-property :post-affiliated element) (point)))
23470 (skip-chars-forward " \t")
23472 ((and (looking-at-p "[ \t]*$")
23473 (or (eq type 'inlinetask)
23475 (skip-chars-forward " \r\t\n")
23476 (<= (org-element-property :end element) (point)))))
23477 (delete-region (point) (line-end-position))
23480 (t (user-error "Cannot insert a fixed-width line here")))))
23482 (let* ((begin (save-excursion
23483 (goto-char (region-beginning))
23484 (line-beginning-position)))
23487 (goto-char (region-end))
23488 (unless (eolp) (beginning-of-line))
23489 (if (save-excursion (re-search-backward "\\S-" begin t))
23490 (progn (skip-chars-backward " \r\t\n") (point))
23496 (skip-chars-forward " \r\t\n")
23497 (when (eobp) (throw 'not-all-p nil))
23498 (while (< (point) end)
23499 (let ((element (org-element-at-point)))
23500 (if (eq (org-element-type element) 'fixed-width)
23501 (goto-char (org-element-property :end element))
23502 (throw 'not-all-p nil))))
23504 (if all-fixed-width-p
23507 (while (< (point) end)
23508 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23511 (if (= (line-end-position) (match-end 0)) 0 1)))
23513 (let ((min-ind (point-max)))
23514 ;; Find minimum indentation across all lines.
23517 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23520 (while (< (point) end)
23521 (unless (looking-at-p "[ \t]*$")
23522 (let ((ind (org-get-indentation)))
23523 (setq min-ind (min min-ind ind))
23524 (when (zerop ind) (throw 'zerop t))))
23526 ;; Loop over all lines and add fixed-width markup everywhere
23527 ;; but in fixed-width lines.
23530 (while (< (point) end)
23532 ((org-at-heading-p)
23535 (while (and (< (point) end) (looking-at-p "[ \t]*$"))
23538 ((looking-at-p "[ \t]*:\\( \\|$\\)")
23539 (let* ((element (org-element-at-point))
23540 (element-end (org-element-property :end element)))
23541 (if (eq (org-element-type element) 'fixed-width)
23542 (progn (goto-char element-end)
23543 (skip-chars-backward " \r\t\n")
23545 (let ((limit (min end element-end)))
23546 (while (< (point) limit)
23547 (org-move-to-column min-ind t)
23549 (forward-line))))))
23551 (org-move-to-column min-ind t)
23553 (forward-line)))))))
23554 (set-marker end nil))))
23559 ;; Org comments syntax is quite complex. It requires the entire line
23560 ;; to be just a comment. Also, even with the right syntax at the
23561 ;; beginning of line, some some elements (i.e. verse-block or
23562 ;; example-block) don't accept comments. Usual Emacs comment commands
23563 ;; cannot cope with those requirements. Therefore, Org replaces them.
23565 ;; Org still relies on `comment-dwim', but cannot trust
23566 ;; `comment-only-p'. So, `comment-region-function' and
23567 ;; `uncomment-region-function' both point
23568 ;; to`org-comment-or-uncomment-region'. Eventually,
23569 ;; `org-insert-comment' takes care of insertion of comments at the
23570 ;; beginning of line.
23572 ;; `org-setup-comments-handling' install comments related variables
23573 ;; during `org-mode' initialization.
23575 (defun org-setup-comments-handling ()
23577 (setq-local comment-use-syntax nil)
23578 (setq-local comment-start "# ")
23579 (setq-local comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23580 (setq-local comment-insert-comment-function 'org-insert-comment)
23581 (setq-local comment-region-function 'org-comment-or-uncomment-region)
23582 (setq-local uncomment-region-function 'org-comment-or-uncomment-region))
23584 (defun org-insert-comment ()
23585 "Insert an empty comment above current line.
23586 If the line is empty, insert comment at its beginning. When
23587 point is within a source block, comment according to the related
23589 (if (let ((element (org-element-at-point)))
23590 (and (eq (org-element-type element) 'src-block)
23592 (goto-char (org-element-property :post-affiliated element))
23593 (line-end-position))
23596 (goto-char (org-element-property :end element))
23597 (skip-chars-backward " \r\t\n")
23598 (line-beginning-position))
23600 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23601 (beginning-of-line)
23602 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23607 (defvar comment-empty-lines) ; From newcomment.el.
23608 (defun org-comment-or-uncomment-region (beg end &rest _)
23609 "Comment or uncomment each non-blank line in the region.
23610 Uncomment each non-blank line between BEG and END if it only
23611 contains commented lines. Otherwise, comment them. If region is
23612 strictly within a source block, use appropriate comment syntax."
23613 (if (let ((element (org-element-at-point)))
23614 (and (eq (org-element-type element) 'src-block)
23616 (goto-char (org-element-property :post-affiliated element))
23617 (line-end-position))
23619 (>= (save-excursion
23620 (goto-char (org-element-property :end element))
23621 (skip-chars-backward " \r\t\n")
23622 (line-beginning-position))
23624 ;; Translate region boundaries for the Org buffer to the source
23626 (let ((offset (- end beg)))
23629 (org-babel-do-in-edit-buffer
23630 (comment-or-uncomment-region (point) (+ offset (point))))))
23633 (narrow-to-region (save-excursion (goto-char beg)
23634 (skip-chars-forward " \r\t\n" end)
23635 (line-beginning-position))
23636 (save-excursion (goto-char end)
23637 (skip-chars-backward " \r\t\n" beg)
23638 (line-end-position)))
23640 ;; UNCOMMENTP is non-nil when every non blank line between
23641 ;; BEG and END is a comment.
23643 (goto-char (point-min))
23644 (while (and (not (eobp))
23645 (let ((element (org-element-at-point)))
23646 (and (eq (org-element-type element) 'comment)
23647 (goto-char (min (point-max)
23648 (org-element-property
23649 :end element)))))))
23652 ;; Only blank lines and comments in region: uncomment it.
23654 (goto-char (point-min))
23655 (while (not (eobp))
23656 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23657 (replace-match "" nil nil nil 1))
23659 ;; Comment each line in region.
23660 (let ((min-indent (point-max)))
23661 ;; First find the minimum indentation across all lines.
23663 (goto-char (point-min))
23664 (while (and (not (eobp)) (not (zerop min-indent)))
23665 (unless (looking-at "[ \t]*$")
23666 (setq min-indent (min min-indent (current-indentation))))
23668 ;; Then loop over all lines.
23670 (goto-char (point-min))
23671 (while (not (eobp))
23672 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23673 ;; Don't get fooled by invisible text (e.g. link path)
23674 ;; when moving to column MIN-INDENT.
23675 (let ((buffer-invisibility-spec nil))
23676 (org-move-to-column min-indent t))
23677 (insert comment-start))
23678 (forward-line)))))))))
23680 (defun org-comment-dwim (_arg)
23681 "Call `comment-dwim' within a source edit buffer if needed."
23683 (if (org-in-src-block-p)
23684 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23685 (call-interactively 'comment-dwim)))
23690 ;; This section contains tools to operate on timestamp objects, as
23691 ;; returned by, e.g. `org-element-context'.
23693 (defun org-timestamp--to-internal-time (timestamp &optional end)
23694 "Encode TIMESTAMP object into Emacs internal time.
23695 Use end of date range or time range when END is non-nil."
23696 (apply #'encode-time
23699 (lambda (prop) (or (org-element-property prop timestamp) 0))
23700 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23701 '(:minute-start :hour-start :day-start :month-start
23704 (defun org-timestamp-has-time-p (timestamp)
23705 "Non-nil when TIMESTAMP has a time specified."
23706 (org-element-property :hour-start timestamp))
23708 (defun org-timestamp-format (timestamp format &optional end utc)
23709 "Format a TIMESTAMP object into a string.
23711 FORMAT is a format specifier to be passed to
23712 `format-time-string'.
23714 When optional argument END is non-nil, use end of date-range or
23715 time-range, if possible.
23717 When optional argument UTC is non-nil, time will be expressed as
23719 (format-time-string
23720 format (org-timestamp--to-internal-time timestamp end)
23723 (defun org-timestamp-split-range (timestamp &optional end)
23724 "Extract a TIMESTAMP object from a date or time range.
23726 END, when non-nil, means extract the end of the range.
23727 Otherwise, extract its start.
23729 Return a new timestamp object."
23730 (let ((type (org-element-property :type timestamp)))
23731 (if (memq type '(active inactive diary)) timestamp
23732 (let ((split-ts (org-element-copy timestamp)))
23734 (org-element-put-property
23735 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23736 ;; Copy start properties over end properties if END is
23737 ;; non-nil. Otherwise, copy end properties over `start' ones.
23738 (let ((p-alist '((:minute-start . :minute-end)
23739 (:hour-start . :hour-end)
23740 (:day-start . :day-end)
23741 (:month-start . :month-end)
23742 (:year-start . :year-end))))
23743 (dolist (p-cell p-alist)
23744 (org-element-put-property
23746 (funcall (if end #'car #'cdr) p-cell)
23747 (org-element-property
23748 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23749 ;; Eventually refresh `:raw-value'.
23750 (org-element-put-property split-ts :raw-value nil)
23751 (org-element-put-property
23752 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23754 (defun org-timestamp-translate (timestamp &optional boundary)
23755 "Translate TIMESTAMP object to custom format.
23757 Format string is defined in `org-time-stamp-custom-formats',
23760 When optional argument BOUNDARY is non-nil, it is either the
23761 symbol `start' or `end'. In this case, only translate the
23762 starting or ending part of TIMESTAMP if it is a date or time
23763 range. Otherwise, translate both parts.
23765 Return timestamp as-is if `org-display-custom-times' is nil or if
23766 it has a `diary' type."
23767 (let ((type (org-element-property :type timestamp)))
23768 (if (or (not org-display-custom-times) (eq type 'diary))
23769 (org-element-interpret-data timestamp)
23770 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23771 org-time-stamp-custom-formats)))
23772 (if (and (not boundary) (memq type '(active-range inactive-range)))
23773 (concat (org-timestamp-format timestamp fmt)
23775 (org-timestamp-format timestamp fmt t))
23776 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23782 (defvar reftex-docstruct-symbol)
23785 (defun org-reftex-citation ()
23786 "Use reftex-citation to insert a citation into the buffer.
23787 This looks for a line like
23789 #+BIBLIOGRAPHY: foo plain option:-d
23791 and derives from it that foo.bib is the bibliography file relevant
23792 for this document. It then installs the necessary environment for RefTeX
23793 to work in this buffer and calls `reftex-citation' to insert a citation
23796 Export of such citations to both LaTeX and HTML is handled by the contributed
23797 package ox-bibtex by Taru Karttunen."
23799 (let ((reftex-docstruct-symbol 'org--rds)
23801 (org-with-wide-buffer
23802 (let ((case-fold-search t)
23803 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23804 (if (not (save-excursion
23805 (or (re-search-forward re nil t)
23806 (re-search-backward re nil t))))
23807 (user-error "No bibliography defined in file")
23808 (setq bib (concat (match-string 1) ".bib")
23809 org--rds (list (list 'bib bib))))))
23810 (call-interactively 'reftex-citation)))
23812 ;;;; Functions extending outline functionality
23814 (defun org-beginning-of-line (&optional n)
23815 "Go to the beginning of the current visible line.
23817 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23818 tags on the first attempt, and only move to after the tags when
23819 the cursor is already beyond the end of the headline.
23821 With argument N not nil or 1, move forward N - 1 lines first."
23823 (let ((origin (point))
23824 (special (pcase org-special-ctrl-a/e
23825 (`(,C-a . ,_) C-a) (_ org-special-ctrl-a/e)))
23827 ;; First move to a visible line.
23828 (if (bound-and-true-p visual-line-mode)
23829 (beginning-of-visual-line n)
23830 (move-beginning-of-line n)
23831 ;; `move-beginning-of-line' may leave point after invisible
23832 ;; characters if line starts with such of these (e.g., with
23833 ;; a link at column 0). Really move to the beginning of the
23834 ;; current visible line.
23835 (beginning-of-line))
23837 ;; No special behavior. Point is already at the beginning of
23838 ;; a line, logical or visual.
23840 ;; `beginning-of-visual-line' left point before logical beginning
23841 ;; of line: point is at the beginning of a visual line. Bail
23843 ((and (bound-and-true-p visual-line-mode) (not (bolp))))
23844 ((let ((case-fold-search nil)) (looking-at org-complex-heading-regexp))
23845 ;; At a headline, special position is before the title, but
23846 ;; after any TODO keyword or priority cookie.
23847 (let ((refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23848 (line-end-position)))
23850 (if (eq special 'reversed)
23851 (when (and (= origin bol) (eq last-command this-command))
23852 (goto-char refpos))
23853 (when (or (> origin refpos) (= origin bol))
23854 (goto-char refpos)))))
23855 ((and (looking-at org-list-full-item-re)
23856 (memq (org-element-type (save-match-data (org-element-at-point)))
23857 '(item plain-list)))
23858 ;; Set special position at first white space character after
23859 ;; bullet, and check-box, if any.
23860 (let ((after-bullet
23861 (let ((box (match-end 3)))
23862 (cond ((not box) (match-end 1))
23863 ((eq (char-after box) ?\s) (1+ box))
23865 (if (eq special 'reversed)
23866 (when (and (= (point) origin) (eq last-command this-command))
23867 (goto-char after-bullet))
23868 (when (or (> origin after-bullet) (= (point) origin))
23869 (goto-char after-bullet)))))
23870 ;; No special context. Point is already at beginning of line.
23873 (defun org-end-of-line (&optional n)
23874 "Go to the end of the line, but before ellipsis, if any.
23876 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23877 tags on the first attempt, and only move to after the tags when
23878 the cursor is already beyond the end of the headline.
23880 With argument N not nil or 1, move forward N - 1 lines first."
23882 (let ((origin (point))
23883 (special (pcase org-special-ctrl-a/e
23884 (`(,_ . ,C-e) C-e) (_ org-special-ctrl-a/e)))
23886 ;; First move to a visible line.
23887 (if (bound-and-true-p visual-line-mode)
23888 (beginning-of-visual-line n)
23889 (move-beginning-of-line n))
23891 ;; At a headline, with tags.
23894 (beginning-of-line)
23895 (let ((case-fold-search nil))
23896 (looking-at org-complex-heading-regexp)))
23898 (let ((tags (save-excursion
23899 (goto-char (match-beginning 5))
23900 (skip-chars-backward " \t")
23902 (visual-end (and (bound-and-true-p visual-line-mode)
23904 (end-of-visual-line)
23906 ;; If `end-of-visual-line' brings us before end of line or
23907 ;; even tags, i.e., the headline spans over multiple visual
23908 ;; lines, move there.
23909 (cond ((and visual-end
23910 (< visual-end tags)
23911 (<= origin visual-end))
23912 (goto-char visual-end))
23913 ((eq special 'reversed)
23914 (if (and (= origin (line-end-position))
23915 (eq this-command last-command))
23919 (if (or (< origin tags) (= origin (line-end-position)))
23922 ((bound-and-true-p visual-line-mode)
23923 (let ((bol (line-beginning-position)))
23924 (end-of-visual-line)
23925 ;; If `end-of-visual-line' gets us past the ellipsis at the
23926 ;; end of a line, backtrack and use `end-of-line' instead.
23927 (when (/= bol (line-beginning-position))
23930 (t (end-of-line)))))
23932 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23933 (define-key org-mode-map "\C-e" 'org-end-of-line)
23935 (defun org-backward-sentence (&optional _arg)
23936 "Go to beginning of sentence, or beginning of table field.
23937 This will call `backward-sentence' or `org-table-beginning-of-field',
23938 depending on context."
23940 (let* ((element (org-element-at-point))
23941 (contents-begin (org-element-property :contents-begin element))
23942 (table (org-element-lineage element '(table) t)))
23944 (> (point) contents-begin)
23945 (<= (point) (org-element-property :contents-end table)))
23946 (call-interactively #'org-table-beginning-of-field)
23948 (when (and contents-begin
23949 (< (point-min) contents-begin)
23950 (> (point) contents-begin))
23951 (narrow-to-region contents-begin
23952 (org-element-property :contents-end element)))
23953 (call-interactively #'backward-sentence)))))
23955 (defun org-forward-sentence (&optional _arg)
23956 "Go to end of sentence, or end of table field.
23957 This will call `forward-sentence' or `org-table-end-of-field',
23958 depending on context."
23960 (let* ((element (org-element-at-point))
23961 (contents-end (org-element-property :contents-end element))
23962 (table (org-element-lineage element '(table) t)))
23964 (>= (point) (org-element-property :contents-begin table))
23965 (< (point) contents-end))
23966 (call-interactively #'org-table-end-of-field)
23968 (when (and contents-end
23969 (> (point-max) contents-end)
23970 ;; Skip blank lines between elements.
23971 (< (org-element-property :end element)
23972 (save-excursion (goto-char contents-end)
23973 (skip-chars-forward " \r\t\n"))))
23974 (narrow-to-region (org-element-property :contents-begin element)
23976 (call-interactively #'forward-sentence)))))
23978 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23979 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23981 (defun org-kill-line (&optional _arg)
23982 "Kill line, to tags or end of line."
23985 ((or (not org-special-ctrl-k)
23987 (not (org-at-heading-p)))
23988 (when (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23989 org-ctrl-k-protect-subtree
23990 (or (eq org-ctrl-k-protect-subtree 'error)
23991 (not (y-or-n-p "Kill hidden subtree along with headline? "))))
23992 (user-error "C-k aborted as it would kill a hidden subtree"))
23993 (call-interactively
23994 (if (bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23995 ((looking-at ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")
23996 (kill-region (point) (match-beginning 1))
23997 (org-set-tags nil t))
23998 (t (kill-region (point) (point-at-eol)))))
24000 (define-key org-mode-map "\C-k" 'org-kill-line)
24002 (defun org-yank (&optional arg)
24003 "Yank. If the kill is a subtree, treat it specially.
24004 This command will look at the current kill and check if is a single
24005 subtree, or a series of subtrees[1]. If it passes the test, and if the
24006 cursor is at the beginning of a line or after the stars of a currently
24007 empty headline, then the yank is handled specially. How exactly depends
24008 on the value of the following variables.
24010 `org-yank-folded-subtrees'
24011 By default, this variable is non-nil, which results in
24012 subtree(s) being folded after insertion, except if doing so
24013 would swallow text after the yanked text.
24015 `org-yank-adjusted-subtrees'
24016 When non-nil (the default value is nil), the subtree will be
24017 promoted or demoted in order to fit into the local outline tree
24018 structure, which means that the level will be adjusted so that it
24019 becomes the smaller one of the two *visible* surrounding headings.
24021 Any prefix to this command will cause `yank' to be called directly with
24022 no special treatment. In particular, a simple `\\[universal-argument]' prefix \
24024 plainly yank the text as it is.
24026 \[1] The test checks if the first non-white line is a heading
24027 and if there are no other headings with fewer stars."
24029 (org-yank-generic 'yank arg))
24031 (defun org-yank-generic (command arg)
24032 "Perform some yank-like command.
24034 This function implements the behavior described in the `org-yank'
24035 documentation. However, it has been generalized to work for any
24036 interactive command with similar behavior."
24038 ;; pretend to be command COMMAND
24039 (setq this-command command)
24042 (call-interactively command)
24044 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24045 (and (org-kill-is-subtree-p)
24047 (and (looking-at "[ \t]*$")
24050 (buffer-substring (point-at-bol) (point)))))))
24053 ((and subtreep org-yank-folded-subtrees)
24054 (let ((beg (point))
24056 (if (and subtreep org-yank-adjusted-subtrees)
24057 (org-paste-subtree nil nil 'for-yank)
24058 (call-interactively command))
24062 (when (and (bolp) subtreep
24063 (not (setq swallowp
24064 (org-yank-folding-would-swallow-text beg end))))
24065 (org-with-limited-levels
24066 (or (looking-at org-outline-regexp)
24067 (re-search-forward org-outline-regexp-bol end t))
24068 (while (and (< (point) end) (looking-at org-outline-regexp))
24069 (outline-hide-subtree)
24070 (org-cycle-show-empty-lines 'folded)
24071 (condition-case nil
24072 (outline-forward-same-level 1)
24073 (error (goto-char end))))))
24076 "Inserted text not folded because that would swallow text"))
24079 (skip-chars-forward " \t\n\r")
24080 (beginning-of-line 1)
24081 (push-mark beg 'nomsg)))
24082 ((and subtreep org-yank-adjusted-subtrees)
24083 (let ((beg (point-at-bol)))
24084 (org-paste-subtree nil nil 'for-yank)
24085 (push-mark beg 'nomsg)))
24087 (call-interactively command))))))
24089 (defun org-yank-folding-would-swallow-text (beg end)
24090 "Would hide-subtree at BEG swallow any text after END?"
24092 (org-with-limited-levels
24095 (when (or (looking-at org-outline-regexp)
24096 (re-search-forward org-outline-regexp-bol end t))
24097 (setq level (org-outline-level)))
24099 (skip-chars-forward " \t\r\n\v\f")
24101 (and (bolp) (looking-at-p org-outline-regexp)
24102 (<= (org-outline-level) level))))))))
24104 (define-key org-mode-map "\C-y" 'org-yank)
24106 (defun org-truely-invisible-p ()
24107 "Check if point is at a character currently not visible.
24108 This version does not only check the character property, but also
24110 ;; Early versions of noutline don't have `outline-invisible-p'.
24111 (unless (bound-and-true-p visible-mode)
24112 (outline-invisible-p)))
24114 (defun org-invisible-p2 ()
24115 "Check if point is at a character currently not visible."
24117 (when (and (eolp) (not (bobp))) (backward-char 1))
24118 ;; Early versions of noutline don't have `outline-invisible-p'.
24119 (outline-invisible-p)))
24121 (defun org-back-to-heading (&optional invisible-ok)
24122 "Call `outline-back-to-heading', but provide a better error message."
24123 (condition-case nil
24124 (outline-back-to-heading invisible-ok)
24125 (error (error "Before first headline at position %d in buffer %s"
24126 (point) (current-buffer)))))
24128 (defun org-before-first-heading-p ()
24129 "Before first heading?"
24132 (null (re-search-backward org-outline-regexp-bol nil t))))
24134 (defun org-at-heading-p (&optional ignored)
24135 (outline-on-heading-p t))
24137 (defun org-in-commented-heading-p (&optional no-inheritance)
24138 "Non-nil if point is under a commented heading.
24139 This function also checks ancestors of the current headline,
24140 unless optional argument NO-INHERITANCE is non-nil."
24142 ((org-before-first-heading-p) nil)
24143 ((let ((headline (nth 4 (org-heading-components))))
24145 (let ((case-fold-search nil))
24146 (string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24148 (no-inheritance nil)
24150 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24152 (defun org-at-comment-p nil
24153 "Is cursor in a commented line?"
24156 (beginning-of-line)
24157 (looking-at "^[ \t]*# "))))
24159 (defun org-at-drawer-p nil
24160 "Is cursor at a drawer keyword?"
24162 (move-beginning-of-line 1)
24163 (looking-at org-drawer-regexp)))
24165 (defun org-at-block-p nil
24166 "Is cursor at a block keyword?"
24168 (move-beginning-of-line 1)
24169 (looking-at org-block-regexp)))
24171 (defun org-point-at-end-of-empty-headline ()
24172 "If point is at the end of an empty headline, return t, else nil.
24173 If the heading only contains a TODO keyword, it is still still considered
24175 (let ((case-fold-search nil))
24176 (and (looking-at "[ \t]*$")
24177 org-todo-line-regexp
24179 (beginning-of-line)
24180 (looking-at org-todo-line-regexp)
24181 (string= (match-string 3) "")))))
24183 (defun org-at-heading-or-item-p ()
24184 (or (org-at-heading-p) (org-at-item-p)))
24186 (defun org-at-target-p ()
24187 (or (org-in-regexp org-radio-target-regexp)
24188 (org-in-regexp org-target-regexp)))
24189 ;; Compatibility alias with Org versions < 7.8.03
24190 (defalias 'org-on-target-p 'org-at-target-p)
24192 (defun org-up-heading-all (arg)
24193 "Move to the heading line of which the present line is a subheading.
24194 This function considers both visible and invisible heading lines.
24195 With argument, move up ARG levels."
24196 (outline-up-heading arg t))
24198 (defun org-up-heading-safe ()
24199 "Move to the heading line of which the present line is a subheading.
24200 This version will not throw an error. It will return the level of the
24201 headline found, or nil if no higher level is found.
24203 Also, this function will be a lot faster than `outline-up-heading',
24204 because it relies on stars being the outline starters. This can really
24205 make a significant difference in outlines with very many siblings."
24206 (when (ignore-errors (org-back-to-heading t))
24207 (let ((level-up (1- (funcall outline-level))))
24208 (and (> level-up 0)
24209 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24210 (funcall outline-level)))))
24212 (defun org-first-sibling-p ()
24213 "Is this heading the first child of its parents?"
24215 (let ((re org-outline-regexp-bol)
24217 (unless (org-at-heading-p t)
24218 (user-error "Not at a heading"))
24219 (setq level (funcall outline-level))
24221 (if (not (re-search-backward re nil t))
24223 (setq l (funcall outline-level))
24226 (defun org-goto-sibling (&optional previous)
24227 "Goto the next sibling, even if it is invisible.
24228 When PREVIOUS is set, go to the previous sibling instead. Returns t
24229 when a sibling was found. When none is found, return nil and don't
24231 (let ((fun (if previous 're-search-backward 're-search-forward))
24233 (re org-outline-regexp-bol)
24235 (when (ignore-errors (org-back-to-heading t))
24236 (setq level (funcall outline-level))
24238 (or previous (forward-char 1))
24239 (while (funcall fun re nil t)
24240 (setq l (funcall outline-level))
24241 (when (< l level) (goto-char pos) (throw 'exit nil))
24242 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24246 (defun org-show-siblings ()
24247 "Show all siblings of the current headline."
24249 (while (org-goto-sibling) (org-flag-heading nil)))
24251 (while (org-goto-sibling 'previous)
24252 (org-flag-heading nil))))
24254 (defun org-goto-first-child ()
24255 "Goto the first child, even if it is invisible.
24256 Return t when a child was found. Otherwise don't move point and
24258 (let (level (pos (point)) (re org-outline-regexp-bol))
24259 (when (ignore-errors (org-back-to-heading t))
24260 (setq level (outline-level))
24262 (if (and (re-search-forward re nil t) (> (outline-level) level))
24263 (progn (goto-char (match-beginning 0)) t)
24264 (goto-char pos) nil))))
24266 (defun org-show-hidden-entry ()
24267 "Show an entry where even the heading is hidden."
24271 (defun org-flag-heading (flag &optional entry)
24272 "Flag the current heading. FLAG non-nil means make invisible.
24273 When ENTRY is non-nil, show the entire entry."
24275 (org-back-to-heading t)
24276 ;; Check if we should show the entire entry
24281 (and (outline-next-heading)
24282 (org-flag-heading nil))))
24283 (outline-flag-region (max (point-min) (1- (point)))
24284 (save-excursion (outline-end-of-heading) (point))
24287 (defun org-get-next-sibling ()
24288 "Move to next heading of the same level, and return point.
24289 If there is no such heading, return nil.
24290 This is like outline-next-sibling, but invisible headings are ok."
24291 (let ((level (funcall outline-level)))
24292 (outline-next-heading)
24293 (while (and (not (eobp)) (> (funcall outline-level) level))
24294 (outline-next-heading))
24295 (unless (or (eobp) (< (funcall outline-level) level))
24298 (defun org-get-last-sibling ()
24299 "Move to previous heading of the same level, and return point.
24300 If there is no such heading, return nil."
24301 (let ((opoint (point))
24302 (level (funcall outline-level)))
24303 (outline-previous-heading)
24304 (when (and (/= (point) opoint) (outline-on-heading-p t))
24305 (while (and (> (funcall outline-level) level)
24307 (outline-previous-heading))
24308 (unless (< (funcall outline-level) level)
24311 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24312 "Goto to the end of a subtree."
24313 ;; This contains an exact copy of the original function, but it uses
24314 ;; `org-back-to-heading', to make it work also in invisible
24315 ;; trees. And is uses an invisible-ok argument.
24316 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24317 ;; Furthermore, when used inside Org, finding the end of a large subtree
24318 ;; with many children and grandchildren etc, this can be much faster
24319 ;; than the outline version.
24320 (org-back-to-heading invisible-ok)
24322 (level (funcall outline-level)))
24323 (if (and (derived-mode-p 'org-mode) (< level 1000))
24324 ;; A true heading (not a plain list item), in Org
24325 ;; This means we can easily find the end by looking
24326 ;; only for the right number of stars. Using a regexp to do
24327 ;; this is so much faster than using a Lisp loop.
24328 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24330 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24331 ;; something else, do it the slow way
24332 (while (and (not (eobp))
24333 (or first (> (funcall outline-level) level)))
24335 (outline-next-heading)))
24337 (when (memq (preceding-char) '(?\n ?\^M))
24338 ;; Go to end of line before heading
24340 (when (memq (preceding-char) '(?\n ?\^M))
24341 ;; leave blank line before heading
24342 (forward-char -1)))))
24345 (defun org-end-of-meta-data (&optional full)
24346 "Skip planning line and properties drawer in current entry.
24347 When optional argument FULL is non-nil, also skip empty lines,
24348 clocking lines and regular drawers at the beginning of the
24350 (org-back-to-heading t)
24352 (when (looking-at-p org-planning-line-re) (forward-line))
24353 (when (looking-at org-property-drawer-re)
24354 (goto-char (match-end 0))
24356 (when (and full (not (org-at-heading-p)))
24358 (let ((end (save-excursion (outline-next-heading) (point)))
24359 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24360 (while (not (eobp))
24361 (cond ((looking-at-p org-drawer-regexp)
24362 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24365 ((looking-at-p re) (forward-line))
24366 (t (throw 'exit t))))))))
24368 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24369 "Move forward to the ARG'th subheading at same level as this one.
24370 Stop at the first and last subheadings of a superior heading.
24371 Normally this only looks at visible headings, but when INVISIBLE-OK is
24372 non-nil it will also look at invisible ones."
24374 (let ((backward? (and arg (< arg 0))))
24375 (if (org-before-first-heading-p)
24376 (if backward? (goto-char (point-min)) (outline-next-heading))
24377 (org-back-to-heading invisible-ok)
24378 (unless backward? (end-of-line)) ;do not match current headline
24379 (let ((level (- (match-end 0) (match-beginning 0) 1))
24380 (f (if backward? #'re-search-backward #'re-search-forward))
24381 (count (if arg (abs arg) 1))
24383 (while (and (> count 0)
24384 (funcall f org-outline-regexp-bol nil 'move))
24385 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24386 (cond ((< l level) (setq count 0))
24389 (not (outline-invisible-p
24390 (line-beginning-position)))))
24392 (when (= l level) (setq result (point)))))))
24393 (goto-char result))
24394 (beginning-of-line))))
24396 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24397 "Move backward to the ARG'th subheading at same level as this one.
24398 Stop at the first and last subheadings of a superior heading."
24400 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24402 (defun org-next-visible-heading (arg)
24403 "Move to the next visible heading.
24405 This function wraps `outline-next-visible-heading' with
24406 `org-with-limited-levels' in order to skip over inline tasks and
24407 respect customization of `org-odd-levels-only'."
24409 (org-with-limited-levels
24410 (outline-next-visible-heading arg)))
24412 (defun org-previous-visible-heading (arg)
24413 "Move to the previous visible heading.
24415 This function wraps `outline-previous-visible-heading' with
24416 `org-with-limited-levels' in order to skip over inline tasks and
24417 respect customization of `org-odd-levels-only'."
24419 (org-with-limited-levels
24420 (outline-previous-visible-heading arg)))
24422 (defun org-next-block (arg &optional backward block-regexp)
24423 "Jump to the next block.
24425 With a prefix argument ARG, jump forward ARG many blocks.
24427 When BACKWARD is non-nil, jump to the previous block.
24429 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24430 Match data is set according to this regexp when the function
24433 Return point at beginning of the opening line of found block.
24434 Throw an error if no block is found."
24436 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24437 (case-fold-search t)
24438 (search-fn (if backward #'re-search-backward #'re-search-forward))
24442 (if backward (beginning-of-line) (end-of-line))
24443 (while (and (> count 0) (funcall search-fn re nil t))
24444 (let ((element (save-excursion
24445 (goto-char (match-beginning 0))
24446 (save-match-data (org-element-at-point)))))
24447 (when (and (memq (org-element-type element)
24448 '(center-block comment-block dynamic-block
24449 example-block export-block quote-block
24450 special-block src-block verse-block))
24451 (<= (match-beginning 0)
24452 (org-element-property :post-affiliated element)))
24453 (setq last-element element)
24456 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24457 (save-match-data (org-show-context)))
24459 (user-error "No %s code blocks" (if backward "previous" "further")))))
24461 (defun org-previous-block (arg &optional block-regexp)
24462 "Jump to the previous block.
24463 With a prefix argument ARG, jump backward ARG many source blocks.
24464 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24466 (org-next-block arg t block-regexp))
24468 (defun org-forward-paragraph ()
24469 "Move forward to beginning of next paragraph or equivalent.
24471 The function moves point to the beginning of the next visible
24472 structural element, which can be a paragraph, a table, a list
24473 item, etc. It also provides some special moves for convenience:
24475 - On an affiliated keyword, jump to the beginning of the
24477 - On an item or a footnote definition, move to the second
24478 element inside, if any.
24479 - On a table or a property drawer, jump after it.
24480 - On a verse or source block, stop after blank lines."
24482 (when (eobp) (user-error "Cannot move further down"))
24483 (let* ((deactivate-mark nil)
24484 (element (org-element-at-point))
24485 (type (org-element-type element))
24486 (post-affiliated (org-element-property :post-affiliated element))
24487 (contents-begin (org-element-property :contents-begin element))
24488 (contents-end (org-element-property :contents-end element))
24489 (end (let ((end (org-element-property :end element)) (parent element))
24490 (while (and (setq parent (org-element-property :parent parent))
24491 (= (org-element-property :contents-end parent) end))
24492 (setq end (org-element-property :end parent)))
24494 (cond ((not element)
24495 (skip-chars-forward " \r\t\n")
24496 (or (eobp) (beginning-of-line)))
24497 ;; On affiliated keywords, move to element's beginning.
24498 ((< (point) post-affiliated)
24499 (goto-char post-affiliated))
24500 ;; At a table row, move to the end of the table. Similarly,
24501 ;; at a node property, move to the end of the property
24503 ((memq type '(node-property table-row))
24504 (goto-char (org-element-property
24505 :end (org-element-property :parent element))))
24506 ((memq type '(property-drawer table)) (goto-char end))
24507 ;; Consider blank lines as separators in verse and source
24508 ;; blocks to ease editing.
24509 ((memq type '(src-block verse-block))
24510 (when (eq type 'src-block)
24512 (save-excursion (goto-char end)
24513 (skip-chars-backward " \r\t\n")
24514 (line-beginning-position))))
24515 (beginning-of-line)
24516 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24517 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24519 (skip-chars-forward " \r\t\n")
24520 (if (= (point) contents-end) (goto-char end)
24521 (beginning-of-line))))
24522 ;; With no contents, just skip element.
24523 ((not contents-begin) (goto-char end))
24524 ;; If contents are invisible, skip the element altogether.
24525 ((outline-invisible-p (line-end-position))
24528 (org-with-limited-levels (outline-next-visible-heading 1)))
24529 ;; At a plain list, make sure we move to the next item
24530 ;; instead of skipping the whole list.
24531 (plain-list (forward-char)
24532 (org-forward-paragraph))
24533 (otherwise (goto-char end))))
24534 ((>= (point) contents-end) (goto-char end))
24535 ((>= (point) contents-begin)
24536 ;; This can only happen on paragraphs and plain lists.
24538 (paragraph (goto-char end))
24539 ;; At a plain list, try to move to second element in
24540 ;; first item, if possible.
24541 (plain-list (end-of-line)
24542 (org-forward-paragraph))))
24543 ;; When contents start on the middle of a line (e.g. in
24544 ;; items and footnote definitions), try to reach first
24545 ;; element starting after current line.
24546 ((> (line-end-position) contents-begin)
24548 (org-forward-paragraph))
24549 (t (goto-char contents-begin)))))
24551 (defun org-backward-paragraph ()
24552 "Move backward to start of previous paragraph or equivalent.
24554 The function moves point to the beginning of the current
24555 structural element, which can be a paragraph, a table, a list
24556 item, etc., or to the beginning of the previous visible one if
24557 point is already there. It also provides some special moves for
24560 - On an affiliated keyword, jump to the first one.
24561 - On a table or a property drawer, move to its beginning.
24562 - On a verse or source block, stop before blank lines."
24564 (when (bobp) (user-error "Cannot move further up"))
24565 (let* ((deactivate-mark nil)
24566 (element (org-element-at-point))
24567 (type (org-element-type element))
24568 (contents-begin (org-element-property :contents-begin element))
24569 (contents-end (org-element-property :contents-end element))
24570 (post-affiliated (org-element-property :post-affiliated element))
24571 (begin (org-element-property :begin element)))
24573 ((not element) (goto-char (point-min)))
24576 (org-backward-paragraph))
24577 ((<= (point) post-affiliated) (goto-char begin))
24578 ((memq type '(node-property table-row))
24579 (goto-char (org-element-property
24580 :post-affiliated (org-element-property :parent element))))
24581 ((memq type '(property-drawer table)) (goto-char begin))
24582 ((memq type '(src-block verse-block))
24583 (when (eq type 'src-block)
24584 (setq contents-begin
24585 (save-excursion (goto-char begin) (forward-line) (point))))
24586 (if (= (point) contents-begin) (goto-char post-affiliated)
24587 ;; Inside a verse block, see blank lines as paragraph
24589 (let ((origin (point)))
24590 (skip-chars-backward " \r\t\n" contents-begin)
24591 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24592 (skip-chars-forward " \r\t\n" origin)
24593 (if (= (point) origin) (goto-char contents-begin)
24594 (beginning-of-line))))))
24595 ((not contents-begin) (goto-char (or post-affiliated begin)))
24596 ((eq type 'paragraph)
24597 (goto-char contents-begin)
24598 ;; When at first paragraph in an item or a footnote definition,
24599 ;; move directly to beginning of line.
24600 (let ((parent-contents
24601 (org-element-property
24602 :contents-begin (org-element-property :parent element))))
24603 (when (and parent-contents (= parent-contents contents-begin))
24604 (beginning-of-line))))
24605 ;; At the end of a greater element, move to the beginning of the
24606 ;; last element within.
24607 ((>= (point) contents-end)
24608 (goto-char (1- contents-end))
24609 (org-backward-paragraph))
24610 (t (goto-char (or post-affiliated begin))))
24611 ;; Ensure we never leave point invisible.
24612 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24614 (defun org-forward-element ()
24615 "Move forward by one element.
24616 Move to the next element at the same level, when possible."
24618 (cond ((eobp) (user-error "Cannot move further down"))
24619 ((org-with-limited-levels (org-at-heading-p))
24620 (let ((origin (point)))
24621 (goto-char (org-end-of-subtree nil t))
24622 (unless (org-with-limited-levels (org-at-heading-p))
24624 (user-error "Cannot move further down"))))
24626 (let* ((elem (org-element-at-point))
24627 (end (org-element-property :end elem))
24628 (parent (org-element-property :parent elem)))
24629 (cond ((and parent (= (org-element-property :contents-end parent) end))
24630 (goto-char (org-element-property :end parent)))
24631 ((integer-or-marker-p end) (goto-char end))
24632 (t (message "No element at point")))))))
24634 (defun org-backward-element ()
24635 "Move backward by one element.
24636 Move to the previous element at the same level, when possible."
24638 (cond ((bobp) (user-error "Cannot move further up"))
24639 ((org-with-limited-levels (org-at-heading-p))
24640 ;; At a headline, move to the previous one, if any, or stay
24642 (let ((origin (point)))
24643 (org-with-limited-levels (org-backward-heading-same-level 1))
24644 ;; When current headline has no sibling above, move to its
24646 (when (= (point) origin)
24647 (or (org-with-limited-levels (org-up-heading-safe))
24648 (progn (goto-char origin)
24649 (user-error "Cannot move further up"))))))
24651 (let* ((elem (org-element-at-point))
24652 (beg (org-element-property :begin elem)))
24654 ;; Move to beginning of current element if point isn't
24656 ((null beg) (message "No element at point"))
24657 ((/= (point) beg) (goto-char beg))
24659 (skip-chars-backward " \r\t\n")
24661 (let ((prev (org-element-at-point)))
24662 (goto-char (org-element-property :begin prev))
24663 (while (and (setq prev (org-element-property :parent prev))
24664 (<= (org-element-property :end prev) beg))
24665 (goto-char (org-element-property :begin prev)))))))))))
24667 (defun org-up-element ()
24668 "Move to upper element."
24670 (if (org-with-limited-levels (org-at-heading-p))
24671 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24672 (let* ((elem (org-element-at-point))
24673 (parent (org-element-property :parent elem)))
24674 (if parent (goto-char (org-element-property :begin parent))
24675 (if (org-with-limited-levels (org-before-first-heading-p))
24676 (user-error "No surrounding element")
24677 (org-with-limited-levels (org-back-to-heading)))))))
24679 (defvar org-element-greater-elements)
24680 (defun org-down-element ()
24681 "Move to inner element."
24683 (let ((element (org-element-at-point)))
24685 ((memq (org-element-type element) '(plain-list table))
24686 (goto-char (org-element-property :contents-begin element))
24688 ((memq (org-element-type element) org-element-greater-elements)
24689 ;; If contents are hidden, first disclose them.
24690 (when (outline-invisible-p (line-end-position)) (org-cycle))
24691 (goto-char (or (org-element-property :contents-begin element)
24692 (user-error "No content for this element"))))
24693 (t (user-error "No inner element")))))
24695 (defun org-drag-element-backward ()
24696 "Move backward element at point."
24698 (let ((elem (or (org-element-at-point)
24699 (user-error "No element at point"))))
24700 (if (eq (org-element-type elem) 'headline)
24701 ;; Preserve point when moving a whole tree, even if point was
24702 ;; on blank lines below the headline.
24703 (let ((offset (skip-chars-backward " \t\n")))
24704 (unwind-protect (org-move-subtree-up)
24705 (forward-char (- offset))))
24708 (goto-char (org-element-property :begin elem))
24709 (skip-chars-backward " \r\t\n")
24711 (let* ((beg (org-element-property :begin elem))
24712 (prev (org-element-at-point))
24714 (while (and (setq up (org-element-property :parent up))
24715 (<= (org-element-property :end up) beg))
24718 ;; Error out if no previous element or previous element is
24719 ;; a parent of the current one.
24720 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24721 (user-error "Cannot drag element backward")
24722 (let ((pos (point)))
24723 (org-element-swap-A-B prev-elem elem)
24724 (goto-char (+ (org-element-property :begin prev-elem)
24725 (- pos (org-element-property :begin elem))))))))))
24727 (defun org-drag-element-forward ()
24728 "Move forward element at point."
24730 (let* ((pos (point))
24731 (elem (or (org-element-at-point)
24732 (user-error "No element at point"))))
24733 (when (= (point-max) (org-element-property :end elem))
24734 (user-error "Cannot drag element forward"))
24735 (goto-char (org-element-property :end elem))
24736 (let ((next-elem (org-element-at-point)))
24737 (when (or (org-element-nested-p elem next-elem)
24738 (and (eq (org-element-type next-elem) 'headline)
24739 (not (eq (org-element-type elem) 'headline))))
24741 (user-error "Cannot drag element forward"))
24742 ;; Compute new position of point: it's shifted by NEXT-ELEM
24743 ;; body's length (without final blanks) and by the length of
24744 ;; blanks between ELEM and NEXT-ELEM.
24745 (let ((size-next (- (save-excursion
24746 (goto-char (org-element-property :end next-elem))
24747 (skip-chars-backward " \r\t\n")
24749 ;; Small correction if buffer doesn't end
24750 ;; with a newline character.
24751 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24752 (org-element-property :begin next-elem)))
24753 (size-blank (- (org-element-property :end elem)
24755 (goto-char (org-element-property :end elem))
24756 (skip-chars-backward " \r\t\n")
24759 (org-element-swap-A-B elem next-elem)
24760 (goto-char (+ pos size-next size-blank))))))
24762 (defun org-drag-line-forward (arg)
24763 "Drag the line at point ARG lines forward."
24765 (dotimes (_ (abs arg))
24766 (let ((c (current-column)))
24769 (beginning-of-line 2)
24770 (transpose-lines 1)
24771 (beginning-of-line 0))
24772 (transpose-lines 1)
24773 (beginning-of-line -1))
24774 (org-move-to-column c))))
24776 (defun org-drag-line-backward (arg)
24777 "Drag the line at point ARG lines backward."
24779 (org-drag-line-forward (- arg)))
24781 (defun org-mark-element ()
24782 "Put point at beginning of this element, mark at end.
24784 Interactively, if this command is repeated or (in Transient Mark
24785 mode) if the mark is active, it marks the next element after the
24786 ones already marked."
24788 (let (deactivate-mark)
24789 (if (and (called-interactively-p 'any)
24790 (or (and (eq last-command this-command) (mark t))
24791 (and transient-mark-mode mark-active)))
24795 (goto-char (org-element-property :end (org-element-at-point)))))
24796 (let ((element (org-element-at-point)))
24798 (push-mark (org-element-property :end element) t t)
24799 (goto-char (org-element-property :begin element))))))
24801 (defun org-narrow-to-element ()
24802 "Narrow buffer to current element."
24804 (let ((elem (org-element-at-point)))
24806 ((eq (car elem) 'headline)
24808 (org-element-property :begin elem)
24809 (org-element-property :end elem)))
24810 ((memq (car elem) org-element-greater-elements)
24812 (org-element-property :contents-begin elem)
24813 (org-element-property :contents-end elem)))
24816 (org-element-property :begin elem)
24817 (org-element-property :end elem))))))
24819 (defun org-transpose-element ()
24820 "Transpose current and previous elements, keeping blank lines between.
24821 Point is moved after both elements."
24823 (org-skip-whitespace)
24824 (let ((end (org-element-property :end (org-element-at-point))))
24825 (org-drag-element-backward)
24828 (defun org-unindent-buffer ()
24829 "Un-indent the visible part of the buffer.
24830 Relative indentation (between items, inside blocks, etc.) isn't
24833 (unless (eq major-mode 'org-mode)
24834 (user-error "Cannot un-indent a buffer not in Org mode"))
24835 (letrec ((parse-tree (org-element-parse-buffer 'greater-element))
24838 (dolist (element (reverse contents))
24839 (if (memq (org-element-type element) '(headline section))
24840 (funcall unindent-tree (org-element-contents element))
24844 (org-element-property :begin element)
24845 (org-element-property :end element))
24846 (org-do-remove-indentation))))))))
24847 (funcall unindent-tree (org-element-contents parse-tree))))
24849 (defun org-show-children (&optional level)
24850 "Show all direct subheadings of this heading.
24851 Prefix arg LEVEL is how many levels below the current level
24852 should be shown. Default is enough to cause the following
24853 heading to appear."
24855 ;; If `orgstruct-mode' is active, use the slower version.
24856 (if orgstruct-mode (call-interactively #'outline-show-children)
24858 (org-back-to-heading t)
24859 (let* ((current-level (funcall outline-level))
24860 (max-level (org-get-valid-level
24862 (if level (prefix-numeric-value level) 1)))
24863 (end (save-excursion (org-end-of-subtree t t)))
24864 (regexp-fmt "^\\*\\{%d,%s\\}\\(?: \\|$\\)")
24865 (past-first-child nil)
24866 ;; Make sure to skip inlinetasks.
24867 (re (format regexp-fmt
24870 ((not (featurep 'org-inlinetask)) "")
24871 (org-odd-levels-only (- (* 2 org-inlinetask-min-level)
24873 (t (1- org-inlinetask-min-level))))))
24874 ;; Display parent heading.
24875 (outline-flag-region (line-end-position 0) (line-end-position) nil)
24877 ;; Display children. First child may be deeper than expected
24878 ;; MAX-LEVEL. Since we want to display it anyway, adjust
24879 ;; MAX-LEVEL accordingly.
24880 (while (re-search-forward re end t)
24881 (unless past-first-child
24882 (setq re (format regexp-fmt
24884 (max (funcall outline-level) max-level)))
24885 (setq past-first-child t))
24886 (outline-flag-region
24887 (line-end-position 0) (line-end-position) nil))))))
24889 (defun org-show-subtree ()
24890 "Show everything after this heading at deeper levels."
24892 (outline-flag-region
24895 (org-end-of-subtree t t))
24898 (defun org-show-entry ()
24899 "Show the body directly following this heading.
24900 Show the heading too, if it is currently invisible."
24904 (org-back-to-heading t)
24905 (outline-flag-region
24906 (max (point-min) (1- (point)))
24908 (if (re-search-forward
24909 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24910 (match-beginning 1)
24913 (org-cycle-hide-drawers 'children))))
24915 (defun org-make-options-regexp (kwds &optional extra)
24916 "Make a regular expression for keyword lines.
24917 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24918 when non-nil, is a regexp matching keywords names."
24919 (concat "^[ \t]*#\\+\\("
24921 (and extra (concat (and kwds "\\|") extra))
24922 "\\):[ \t]*\\(.*\\)"))
24924 ;;;; Integration with and fixes for other packages
24928 (defvar-local org-imenu-markers nil
24929 "All markers currently used by Imenu.")
24931 (defun org-imenu-new-marker (&optional pos)
24932 "Return a new marker for use by Imenu, and remember the marker."
24933 (let ((m (make-marker)))
24934 (move-marker m (or pos (point)))
24935 (push m org-imenu-markers)
24938 (defun org-imenu-get-tree ()
24939 "Produce the index for Imenu."
24940 (dolist (x org-imenu-markers) (move-marker x nil))
24941 (setq org-imenu-markers nil)
24942 (let* ((case-fold-search nil)
24943 (n org-imenu-depth)
24944 (re (concat "^" (org-get-limited-outline-regexp)))
24945 (subs (make-vector (1+ n) nil))
24947 m level head0 head)
24948 (org-with-wide-buffer
24949 (goto-char (point-max))
24950 (while (re-search-backward re nil t)
24951 (setq level (org-reduced-level (funcall outline-level)))
24952 (when (and (<= level n)
24953 (looking-at org-complex-heading-regexp)
24954 (setq head0 (match-string-no-properties 4)))
24955 (setq head (org-link-display-format head0)
24956 m (org-imenu-new-marker))
24957 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24958 (if (>= level last-level)
24959 (push (cons head m) (aref subs level))
24960 (push (cons head (aref subs (1+ level))) (aref subs level))
24961 (cl-loop for i from (1+ level) to n do (aset subs i nil)))
24962 (setq last-level level))))
24965 (eval-after-load "imenu"
24967 (add-hook 'imenu-after-jump-hook
24969 (when (derived-mode-p 'org-mode)
24970 (org-show-context 'org-goto))))))
24972 (defun org-link-display-format (s)
24973 "Replace links in string S with their description.
24974 If there is no description, use the link target."
24976 (replace-regexp-in-string
24977 org-bracket-link-analytic-regexp
24979 (if (match-end 5) (match-string 5 m)
24980 (concat (match-string 1 m) (match-string 3 m))))
24983 (defun org-toggle-link-display ()
24984 "Toggle the literal or descriptive display of links."
24986 (if org-descriptive-links
24987 (progn (org-remove-from-invisibility-spec '(org-link))
24988 (org-restart-font-lock)
24989 (setq org-descriptive-links nil))
24990 (progn (add-to-invisibility-spec '(org-link))
24991 (org-restart-font-lock)
24992 (setq org-descriptive-links t))))
24994 ;; Speedbar support
24996 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24997 "Overlay marking the agenda restriction line in speedbar.")
24998 (overlay-put org-speedbar-restriction-lock-overlay
24999 'face 'org-agenda-restriction-lock)
25000 (overlay-put org-speedbar-restriction-lock-overlay
25001 'help-echo "Agendas are currently limited to this item.")
25002 (delete-overlay org-speedbar-restriction-lock-overlay)
25004 (defun org-speedbar-set-agenda-restriction ()
25005 "Restrict future agenda commands to the location at point in speedbar.
25006 To get rid of the restriction, use `\\[org-agenda-remove-restriction-lock]'."
25008 (require 'org-agenda)
25009 (let (p m tp np dir txt)
25011 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25013 (setq m (get-text-property p 'org-imenu-marker))
25014 (with-current-buffer (marker-buffer m)
25016 (org-agenda-set-restriction-lock 'subtree)))
25017 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25018 'speedbar-function 'speedbar-find-file))
25019 (setq tp (previous-single-property-change
25020 (1+ p) 'speedbar-function)
25021 np (next-single-property-change
25022 tp 'speedbar-function)
25023 dir (speedbar-line-directory)
25024 txt (buffer-substring-no-properties (or tp (point-min))
25025 (or np (point-max))))
25026 (with-current-buffer (find-file-noselect
25027 (let ((default-directory dir))
25028 (expand-file-name txt)))
25029 (unless (derived-mode-p 'org-mode)
25030 (user-error "Cannot restrict to non-Org mode file"))
25031 (org-agenda-set-restriction-lock 'file)))
25032 (t (user-error "Don't know how to restrict Org mode agenda")))
25033 (move-overlay org-speedbar-restriction-lock-overlay
25034 (point-at-bol) (point-at-eol))
25035 (setq current-prefix-arg nil)
25036 (org-agenda-maybe-redo)))
25038 (defvar speedbar-file-key-map)
25039 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25040 (eval-after-load "speedbar"
25042 (speedbar-add-supported-extension ".org")
25043 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25044 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25045 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25046 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25047 (add-hook 'speedbar-visiting-tag-hook
25048 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25050 ;;; Fixes and Hacks for problems with other packages
25052 (defun org--flyspell-object-check-p (element)
25053 "Non-nil when Flyspell can check object at point.
25054 ELEMENT is the element at point."
25055 (let ((object (save-excursion
25056 (when (looking-at-p "\\>") (backward-char))
25057 (org-element-context element))))
25058 (cl-case (org-element-type object)
25059 ;; Prevent checks in links due to keybinding conflict with
25061 ((code entity export-snippet inline-babel-call
25062 inline-src-block line-break latex-fragment link macro
25063 statistics-cookie target timestamp verbatim)
25065 (footnote-reference
25066 ;; Only in inline footnotes, within the definition.
25067 (and (eq (org-element-property :type object) 'inline)
25069 (goto-char (org-element-property :begin object))
25070 (search-forward ":" nil t 2))
25074 (defun org-mode-flyspell-verify ()
25075 "Function used for `flyspell-generic-check-word-predicate'."
25076 (if (org-at-heading-p)
25077 ;; At a headline or an inlinetask, check title only. This is
25078 ;; faster than relying on `org-element-at-point'.
25079 (and (save-excursion (beginning-of-line)
25080 (and (let ((case-fold-search t))
25081 (not (looking-at-p "\\*+ END[ \t]*$")))
25082 (let ((case-fold-search nil))
25083 (looking-at org-complex-heading-regexp))))
25084 (match-beginning 4)
25085 (>= (point) (match-beginning 4))
25086 (or (not (match-beginning 5))
25087 (< (point) (match-beginning 5))))
25088 (let* ((element (org-element-at-point))
25089 (post-affiliated (org-element-property :post-affiliated element)))
25091 ;; Ignore checks in all affiliated keywords but captions.
25092 ((< (point) post-affiliated)
25093 (and (save-excursion
25094 (beginning-of-line)
25095 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25096 (> (point) (match-end 0))
25097 (org--flyspell-object-check-p element)))
25098 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25099 ((let ((log (org-log-into-drawer)))
25101 (let ((drawer (org-element-lineage element '(drawer))))
25103 (eq (compare-strings
25105 (org-element-property :drawer-name drawer) nil nil t)
25109 (cl-case (org-element-type element)
25110 ((comment quote-section) t)
25112 ;; Allow checks between block markers, not on them.
25113 (and (> (line-beginning-position) post-affiliated)
25116 (skip-chars-forward " \r\t\n")
25117 (< (point) (org-element-property :end element)))))
25118 ;; Arbitrary list of keywords where checks are meaningful.
25119 ;; Make sure point is on the value part of the element.
25121 (and (member (org-element-property :key element)
25122 '("DESCRIPTION" "TITLE"))
25124 (search-backward ":" (line-beginning-position) t))))
25125 ;; Check is globally allowed in paragraphs verse blocks and
25126 ;; table rows (after affiliated keywords) but some objects
25127 ;; must not be affected.
25128 ((paragraph table-row verse-block)
25129 (let ((cbeg (org-element-property :contents-begin element))
25130 (cend (org-element-property :contents-end element)))
25131 (and cbeg (>= (point) cbeg) (< (point) cend)
25132 (org--flyspell-object-check-p element))))))))))
25133 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25135 (defun org-remove-flyspell-overlays-in (beg end)
25136 "Remove flyspell overlays in region."
25137 (and (bound-and-true-p flyspell-mode)
25138 (fboundp 'flyspell-delete-region-overlays)
25139 (flyspell-delete-region-overlays beg end)))
25141 (defvar flyspell-delayed-commands)
25142 (eval-after-load "flyspell"
25143 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25145 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25146 (eval-after-load "bookmark"
25147 '(if (boundp 'bookmark-after-jump-hook)
25148 ;; We can use the hook
25149 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25150 ;; Hook not available, use advice
25151 (defadvice bookmark-jump (after org-make-visible activate)
25152 "Make the position visible."
25153 (org-bookmark-jump-unhide))))
25155 ;; Make sure saveplace shows the location if it was hidden
25156 (eval-after-load "saveplace"
25157 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25158 "Make the position visible."
25159 (org-bookmark-jump-unhide)))
25161 ;; Make sure ecb shows the location if it was hidden
25162 (eval-after-load "ecb"
25163 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25164 "Make hierarchy visible when jumping into location from ECB tree buffer."
25165 (when (derived-mode-p 'org-mode)
25166 (org-show-context))))
25168 (defun org-bookmark-jump-unhide ()
25169 "Unhide the current position, to show the bookmark location."
25170 (and (derived-mode-p 'org-mode)
25171 (or (outline-invisible-p)
25172 (save-excursion (goto-char (max (point-min) (1- (point))))
25173 (outline-invisible-p)))
25174 (org-show-context 'bookmark-jump)))
25176 (defun org-mark-jump-unhide ()
25177 "Make the point visible with `org-show-context' after jumping to the mark."
25178 (when (and (derived-mode-p 'org-mode)
25179 (outline-invisible-p))
25180 (org-show-context 'mark-goto)))
25182 (eval-after-load "simple"
25183 '(defadvice pop-to-mark-command (after org-make-visible activate)
25184 "Make the point visible with `org-show-context'."
25185 (org-mark-jump-unhide)))
25187 (eval-after-load "simple"
25188 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25189 "Make the point visible with `org-show-context'."
25190 (org-mark-jump-unhide)))
25192 (eval-after-load "simple"
25193 '(defadvice pop-global-mark (after org-make-visible activate)
25194 "Make the point visible with `org-show-context'."
25195 (org-mark-jump-unhide)))
25197 ;; Make session.el ignore our circular variable
25198 (defvar session-globals-exclude)
25199 (eval-after-load "session"
25200 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25206 (run-hooks 'org-load-hook)
25208 ;;; org.el ends here