org.el: mark `org-on-heading-p' obsolete.
[org-mode.git] / lisp / org.el
blob5d8880a20dc9d68677f81224a44fd25be90afd5e
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
63 ;;; Code:
65 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
66 (defvar-local org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
69 ;;;; Require other packages
71 (require 'cl-lib)
73 (eval-when-compile
74 (require 'cl)
75 (require 'gnus-sum))
77 (require 'calendar)
78 (require 'find-func)
79 (require 'format-spec)
81 (or (equal this-command 'eval-buffer)
82 (condition-case nil
83 (load (concat (file-name-directory load-file-name)
84 "org-loaddefs.el")
85 nil t t t)
86 (error
87 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
88 (sit-for 3)
89 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
90 (sit-for 3))))
92 (require 'org-macs)
93 (require 'org-compat)
95 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
96 ;; some places -- e.g. see the macro `org-with-limited-levels'.
98 ;; In Org buffers, the value of `outline-regexp' is that of
99 ;; `org-outline-regexp'. The only function still directly relying on
100 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
101 ;; job when `orgstruct-mode' is active.
102 (defvar org-outline-regexp "\\*+ "
103 "Regexp to match Org headlines.")
105 (defvar org-outline-regexp-bol "^\\*+ "
106 "Regexp to match Org headlines.
107 This is similar to `org-outline-regexp' but additionally makes
108 sure that we are at the beginning of the line.")
110 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
111 "Matches a headline, putting stars and text into groups.
112 Stars are put in group 1 and the trimmed body in group 2.")
114 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
115 (unless (boundp 'calendar-view-holidays-initially-flag)
116 (org-defvaralias 'calendar-view-holidays-initially-flag
117 'view-calendar-holidays-initially))
118 (unless (boundp 'calendar-view-diary-initially-flag)
119 (org-defvaralias 'calendar-view-diary-initially-flag
120 'view-diary-entries-initially))
121 (unless (boundp 'diary-fancy-buffer)
122 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
124 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
125 (declare-function org-add-archive-files "org-archive" (files))
126 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
127 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
128 (declare-function org-agenda-redo "org-agenda" (&optional all))
129 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
130 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
131 (declare-function org-beamer-mode "ox-beamer" ())
132 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
133 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
134 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
135 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
136 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
137 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
138 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
139 (declare-function org-clock-update-time-maybe "org-clock" ())
140 (declare-function org-clocktable-shift "org-clock" (dir n))
141 (declare-function org-element-at-point "org-element" ())
142 (declare-function org-element-cache-refresh "org-element" (pos))
143 (declare-function org-element-cache-reset "org-element" (&optional all))
144 (declare-function org-element-contents "org-element" (element))
145 (declare-function org-element-context "org-element" (&optional element))
146 (declare-function org-element-copy "org-element" (datum))
147 (declare-function org-element-interpret-data "org-element" (data &optional parent))
148 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
149 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
150 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
151 (declare-function org-element-property "org-element" (property element))
152 (declare-function org-element-put-property "org-element" (element property value))
153 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
154 (declare-function org-element-type "org-element" (element))
155 (declare-function org-element-update-syntax "org-element" ())
156 (declare-function org-id-find-id-file "org-id" (id))
157 (declare-function org-id-get-create "org-id" (&optional force))
158 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
159 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
160 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
161 (declare-function org-plot/gnuplot "org-plot" (&optional params))
162 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
163 (declare-function org-table-align "org-table" ())
164 (declare-function org-table-begin "org-table" (&optional table-type))
165 (declare-function org-table-beginning-of-field "org-table" (&optional n))
166 (declare-function org-table-blank-field "org-table" ())
167 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
168 (declare-function org-table-edit-field "org-table" (arg))
169 (declare-function org-table-end "org-table" (&optional table-type))
170 (declare-function org-table-end-of-field "org-table" (&optional n))
171 (declare-function org-table-insert-row "org-table" (&optional arg))
172 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
173 (declare-function org-table-maybe-eval-formula "org-table" ())
174 (declare-function org-table-maybe-recalculate-line "org-table" ())
175 (declare-function org-table-next-row "org-table" ())
176 (declare-function org-table-paste-rectangle "org-table" ())
177 (declare-function org-table-wrap-region "org-table" (arg))
178 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
179 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
180 (declare-function orgtbl-mode "org-table" (&optional arg))
182 (defsubst org-uniquify (list)
183 "Non-destructively remove duplicate elements from LIST."
184 (let ((res (copy-sequence list))) (delete-dups res)))
186 (defsubst org-get-at-bol (property)
187 "Get text property PROPERTY at the beginning of line."
188 (get-text-property (point-at-bol) property))
190 (defsubst org-trim (s)
191 "Remove whitespace at the beginning and the end of string S."
192 (replace-regexp-in-string
193 "\\`[ \t\n\r]+" ""
194 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
196 ;; load languages based on value of `org-babel-load-languages'
197 (defvar org-babel-load-languages)
199 ;;;###autoload
200 (defun org-babel-do-load-languages (sym value)
201 "Load the languages defined in `org-babel-load-languages'."
202 (set-default sym value)
203 (mapc (lambda (pair)
204 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
205 (if active
206 (progn
207 (require (intern (concat "ob-" lang))))
208 (progn
209 (funcall 'fmakunbound
210 (intern (concat "org-babel-execute:" lang)))
211 (funcall 'fmakunbound
212 (intern (concat "org-babel-expand-body:" lang)))))))
213 org-babel-load-languages))
215 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
216 ;;;###autoload
217 (defun org-babel-load-file (file &optional compile)
218 "Load Emacs Lisp source code blocks in the Org-mode FILE.
219 This function exports the source code using `org-babel-tangle'
220 and then loads the resulting file using `load-file'. With prefix
221 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
222 file to byte-code before it is loaded."
223 (interactive "fFile to load: \nP")
224 (let* ((age (lambda (file)
225 (float-time
226 (time-subtract (current-time)
227 (nth 5 (or (file-attributes (file-truename file))
228 (file-attributes file)))))))
229 (base-name (file-name-sans-extension file))
230 (exported-file (concat base-name ".el")))
231 ;; tangle if the org-mode file is newer than the elisp file
232 (unless (and (file-exists-p exported-file)
233 (> (funcall age file) (funcall age exported-file)))
234 ;; Tangle-file traversal returns reversed list of tangled files
235 ;; and we want to evaluate the first target.
236 (setq exported-file
237 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
238 (message "%s %s"
239 (if compile
240 (progn (byte-compile-file exported-file 'load)
241 "Compiled and loaded")
242 (progn (load-file exported-file) "Loaded"))
243 exported-file)))
245 (defcustom org-babel-load-languages '((emacs-lisp . t))
246 "Languages which can be evaluated in Org-mode buffers.
247 This list can be used to load support for any of the languages
248 below, note that each language will depend on a different set of
249 system executables and/or Emacs modes. When a language is
250 \"loaded\", then code blocks in that language can be evaluated
251 with `org-babel-execute-src-block' bound by default to C-c
252 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
253 be set to remove code block evaluation from the C-c C-c
254 keybinding. By default only Emacs Lisp (which has no
255 requirements) is loaded."
256 :group 'org-babel
257 :set 'org-babel-do-load-languages
258 :version "24.1"
259 :type '(alist :tag "Babel Languages"
260 :key-type
261 (choice
262 (const :tag "Awk" awk)
263 (const :tag "C" C)
264 (const :tag "R" R)
265 (const :tag "Asymptote" asymptote)
266 (const :tag "Calc" calc)
267 (const :tag "Clojure" clojure)
268 (const :tag "CSS" css)
269 (const :tag "Ditaa" ditaa)
270 (const :tag "Dot" dot)
271 (const :tag "Emacs Lisp" emacs-lisp)
272 (const :tag "Forth" forth)
273 (const :tag "Fortran" fortran)
274 (const :tag "Gnuplot" gnuplot)
275 (const :tag "Haskell" haskell)
276 (const :tag "IO" io)
277 (const :tag "J" J)
278 (const :tag "Java" java)
279 (const :tag "Javascript" js)
280 (const :tag "LaTeX" latex)
281 (const :tag "Ledger" ledger)
282 (const :tag "Lilypond" lilypond)
283 (const :tag "Lisp" lisp)
284 (const :tag "Makefile" makefile)
285 (const :tag "Maxima" maxima)
286 (const :tag "Matlab" matlab)
287 (const :tag "Mscgen" mscgen)
288 (const :tag "Ocaml" ocaml)
289 (const :tag "Octave" octave)
290 (const :tag "Org" org)
291 (const :tag "Perl" perl)
292 (const :tag "Pico Lisp" picolisp)
293 (const :tag "PlantUML" plantuml)
294 (const :tag "Python" python)
295 (const :tag "Ruby" ruby)
296 (const :tag "Sass" sass)
297 (const :tag "Scala" scala)
298 (const :tag "Scheme" scheme)
299 (const :tag "Screen" screen)
300 (const :tag "Shell Script" shell)
301 (const :tag "Shen" shen)
302 (const :tag "Sql" sql)
303 (const :tag "Sqlite" sqlite)
304 (const :tag "Stan" stan)
305 (const :tag "ebnf2ps" ebnf2ps))
306 :value-type (boolean :tag "Activate" :value t)))
308 ;;;; Customization variables
309 (defcustom org-clone-delete-id nil
310 "Remove ID property of clones of a subtree.
311 When non-nil, clones of a subtree don't inherit the ID property.
312 Otherwise they inherit the ID property with a new unique
313 identifier."
314 :type 'boolean
315 :version "24.1"
316 :group 'org-id)
318 ;;; Version
319 (org-check-version)
321 ;;;###autoload
322 (defun org-version (&optional here full message)
323 "Show the org-mode version.
324 Interactively, or when MESSAGE is non-nil, show it in echo area.
325 With prefix argument, or when HERE is non-nil, insert it at point.
326 In non-interactive uses, a reduced version string is output unless
327 FULL is given."
328 (interactive (list current-prefix-arg t (not current-prefix-arg)))
329 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
330 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
331 (load-suffixes (list ".el"))
332 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
333 (org-trash (or
334 (and (fboundp 'org-release) (fboundp 'org-git-version))
335 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
336 (load-suffixes save-load-suffixes)
337 (org-version (org-release))
338 (git-version (org-git-version))
339 (version (format "Org-mode version %s (%s @ %s)"
340 org-version
341 git-version
342 (if org-install-dir
343 (if (string= org-dir org-install-dir)
344 org-install-dir
345 (concat "mixed installation! " org-install-dir " and " org-dir))
346 "org-loaddefs.el can not be found!")))
347 (version1 (if full version org-version)))
348 (when here (insert version1))
349 (when message (message "%s" version1))
350 version1))
352 (defconst org-version (org-version))
355 ;;; Syntax Constants
357 ;;;; Block
359 (defconst org-block-regexp
360 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
361 "Regular expression for hiding blocks.")
363 (defconst org-dblock-start-re
364 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
365 "Matches the start line of a dynamic block, with parameters.")
367 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
368 "Matches the end of a dynamic block.")
370 ;;;; Clock and Planning
372 (defconst org-clock-string "CLOCK:"
373 "String used as prefix for timestamps clocking work hours on an item.")
375 (defvar org-closed-string "CLOSED:"
376 "String used as the prefix for timestamps logging closing a TODO entry.")
378 (defvar org-deadline-string "DEADLINE:"
379 "String to mark deadline entries.
380 A deadline is this string, followed by a time stamp. Should be a word,
381 terminated by a colon. You can insert a schedule keyword and
382 a timestamp with \\[org-deadline].")
384 (defvar org-scheduled-string "SCHEDULED:"
385 "String to mark scheduled TODO entries.
386 A schedule is this string, followed by a time stamp. Should be a word,
387 terminated by a colon. You can insert a schedule keyword and
388 a timestamp with \\[org-schedule].")
390 (defconst org-ds-keyword-length
391 (+ 2
392 (apply #'max
393 (mapcar #'length
394 (list org-deadline-string org-scheduled-string
395 org-clock-string org-closed-string))))
396 "Maximum length of the DEADLINE and SCHEDULED keywords.")
398 (defconst org-planning-line-re
399 (concat "^[ \t]*"
400 (regexp-opt
401 (list org-closed-string org-deadline-string org-scheduled-string)
403 "Matches a line with planning info.
404 Matched keyword is in group 1.")
406 (defconst org-clock-line-re
407 (concat "^[ \t]*" org-clock-string)
408 "Matches a line with clock info.")
410 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
411 "Matches the DEADLINE keyword.")
413 (defconst org-deadline-time-regexp
414 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
415 "Matches the DEADLINE keyword together with a time stamp.")
417 (defconst org-deadline-time-hour-regexp
418 (concat "\\<" org-deadline-string
419 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
420 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
422 (defconst org-deadline-line-regexp
423 (concat "\\<\\(" org-deadline-string "\\).*")
424 "Matches the DEADLINE keyword and the rest of the line.")
426 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
427 "Matches the SCHEDULED keyword.")
429 (defconst org-scheduled-time-regexp
430 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
431 "Matches the SCHEDULED keyword together with a time stamp.")
433 (defconst org-scheduled-time-hour-regexp
434 (concat "\\<" org-scheduled-string
435 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
436 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
438 (defconst org-closed-time-regexp
439 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
440 "Matches the CLOSED keyword together with a time stamp.")
442 (defconst org-keyword-time-regexp
443 (concat "\\<"
444 (regexp-opt
445 (list org-scheduled-string org-deadline-string org-closed-string
446 org-clock-string)
448 " *[[<]\\([^]>]+\\)[]>]")
449 "Matches any of the 4 keywords, together with the time stamp.")
451 (defconst org-keyword-time-not-clock-regexp
452 (concat
453 "\\<"
454 (regexp-opt
455 (list org-scheduled-string org-deadline-string org-closed-string) t)
456 " *[[<]\\([^]>]+\\)[]>]")
457 "Matches any of the 3 keywords, together with the time stamp.")
459 (defconst org-maybe-keyword-time-regexp
460 (concat "\\(\\<"
461 (regexp-opt
462 (list org-scheduled-string org-deadline-string org-closed-string
463 org-clock-string)
465 "\\)?"
466 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
467 "\\|"
468 "<%%([^\r\n>]*>\\)")
469 "Matches a timestamp, possibly preceded by a keyword.")
471 (defconst org-all-time-keywords
472 (mapcar (lambda (w) (substring w 0 -1))
473 (list org-scheduled-string org-deadline-string
474 org-clock-string org-closed-string))
475 "List of time keywords.")
477 ;;;; Drawer
479 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
480 "Matches first or last line of a hidden block.
481 Group 1 contains drawer's name or \"END\".")
483 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
484 "Regular expression matching the first line of a property drawer.")
486 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
487 "Regular expression matching the last line of a property drawer.")
489 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
490 "Regular expression matching the first line of a clock drawer.")
492 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
493 "Regular expression matching the last line of a clock drawer.")
495 (defconst org-property-drawer-re
496 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
497 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*?"
498 "[ \t]*:END:[ \t]*$")
499 "Matches an entire property drawer.")
501 (defconst org-clock-drawer-re
502 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
503 org-clock-drawer-end-re "\\)\n?")
504 "Matches an entire clock drawer.")
506 ;;;; Headline
508 (defconst org-heading-keyword-regexp-format
509 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
510 "Printf format for a regexp matching a headline with some keyword.
511 This regexp will match the headline of any node which has the
512 exact keyword that is put into the format. The keyword isn't in
513 any group by default, but the stars and the body are.")
515 (defconst org-heading-keyword-maybe-regexp-format
516 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
517 "Printf format for a regexp matching a headline, possibly with some keyword.
518 This regexp can match any headline with the specified keyword, or
519 without a keyword. The keyword isn't in any group by default,
520 but the stars and the body are.")
522 (defconst org-archive-tag "ARCHIVE"
523 "The tag that marks a subtree as archived.
524 An archived subtree does not open during visibility cycling, and does
525 not contribute to the agenda listings.")
527 (defconst org-comment-string "COMMENT"
528 "Entries starting with this keyword will never be exported.
529 An entry can be toggled between COMMENT and normal with
530 \\[org-toggle-comment].")
533 ;;;; LaTeX Environments and Fragments
535 (defconst org-latex-regexps
536 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
537 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
538 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
539 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
540 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
541 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
542 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
543 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
544 "Regular expressions for matching embedded LaTeX.")
546 ;;;; Node Property
548 (defconst org-effort-property "Effort"
549 "The property that is being used to keep track of effort estimates.
550 Effort estimates given in this property need to have the format H:MM.")
552 ;;;; Table
554 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
555 "Detect an org-type or table-type table.")
557 (defconst org-table-line-regexp "^[ \t]*|"
558 "Detect an org-type table line.")
560 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
561 "Detect an org-type table line.")
563 (defconst org-table-hline-regexp "^[ \t]*|-"
564 "Detect an org-type table hline.")
566 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
567 "Detect a table-type table hline.")
569 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
570 "Detect the first line outside a table when searching from within it.
571 This works for both table types.")
573 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
574 "Detect a #+TBLFM line.")
576 ;;;; Timestamp
578 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
579 "Regular expression for fast time stamp matching.")
581 (defconst org-ts-regexp-inactive
582 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
583 "Regular expression for fast inactive time stamp matching.")
585 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
586 "Regular expression for fast time stamp matching.")
588 (defconst org-ts-regexp0
589 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
590 "Regular expression matching time strings for analysis.
591 This one does not require the space after the date, so it can be used
592 on a string that terminates immediately after the date.")
594 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
595 "Regular expression matching time strings for analysis.")
597 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
598 "Regular expression matching time stamps, with groups.")
600 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
601 "Regular expression matching time stamps (also [..]), with groups.")
603 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
604 "Regular expression matching a time stamp range.")
606 (defconst org-tr-regexp-both
607 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
608 "Regular expression matching a time stamp range.")
610 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
611 org-ts-regexp "\\)?")
612 "Regular expression matching a time stamp or time stamp range.")
614 (defconst org-tsr-regexp-both
615 (concat org-ts-regexp-both "\\(--?-?"
616 org-ts-regexp-both "\\)?")
617 "Regular expression matching a time stamp or time stamp range.
618 The time stamps may be either active or inactive.")
620 (defconst org-repeat-re
621 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
622 "Regular expression for specifying repeated events.
623 After a match, group 1 contains the repeat expression.")
625 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
626 "Formats for `format-time-string' which are used for time stamps.")
629 ;;; The custom variables
631 (defgroup org nil
632 "Outline-based notes management and organizer."
633 :tag "Org"
634 :group 'outlines
635 :group 'calendar)
637 (defcustom org-mode-hook nil
638 "Mode hook for Org-mode, run after the mode was turned on."
639 :group 'org
640 :type 'hook)
642 (defcustom org-load-hook nil
643 "Hook that is run after org.el has been loaded."
644 :group 'org
645 :type 'hook)
647 (defcustom org-log-buffer-setup-hook nil
648 "Hook that is run after an Org log buffer is created."
649 :group 'org
650 :version "24.1"
651 :type 'hook)
653 (defvar org-modules) ; defined below
654 (defvar org-modules-loaded nil
655 "Have the modules been loaded already?")
657 (defun org-load-modules-maybe (&optional force)
658 "Load all extensions listed in `org-modules'."
659 (when (or force (not org-modules-loaded))
660 (mapc (lambda (ext)
661 (condition-case nil (require ext)
662 (error (message "Problems while trying to load feature `%s'" ext))))
663 org-modules)
664 (setq org-modules-loaded t)))
666 (defun org-set-modules (var value)
667 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
668 (set var value)
669 (when (featurep 'org)
670 (org-load-modules-maybe 'force)
671 (org-element-cache-reset 'all)))
673 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
674 "Modules that should always be loaded together with org.el.
676 If a description starts with <C>, the file is not part of Emacs
677 and loading it will require that you have downloaded and properly
678 installed the Org mode distribution.
680 You can also use this system to load external packages (i.e. neither Org
681 core modules, nor modules from the CONTRIB directory). Just add symbols
682 to the end of the list. If the package is called org-xyz.el, then you need
683 to add the symbol `xyz', and the package must have a call to:
685 (provide \\='org-xyz)
687 For export specific modules, see also `org-export-backends'."
688 :group 'org
689 :set 'org-set-modules
690 :version "24.4"
691 :package-version '(Org . "8.0")
692 :type
693 '(set :greedy t
694 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
695 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
696 (const :tag " crypt: Encryption of subtrees" org-crypt)
697 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
698 (const :tag " docview: Links to doc-view buffers" org-docview)
699 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
700 (const :tag " habit: Track your consistency with habits" org-habit)
701 (const :tag " id: Global IDs for identifying entries" org-id)
702 (const :tag " info: Links to Info nodes" org-info)
703 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
704 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
705 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
706 (const :tag " mouse: Additional mouse support" org-mouse)
707 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
708 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
709 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
711 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
712 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
713 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
714 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
715 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
716 (const :tag "C collector: Collect properties into tables" org-collector)
717 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
718 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
719 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
720 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
721 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
722 (const :tag "C eval: Include command output as text" org-eval)
723 (const :tag "C eww: Store link to url of eww" org-eww)
724 (const :tag "C expiry: Expiry mechanism for Org-mode 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-mode 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-mode links" org-registry)
739 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
740 (const :tag "C secretary: Team management with org-mode" org-secretary)
741 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
742 (const :tag "C toc: Table of contents for Org-mode 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))
753 (defcustom org-export-backends '(ascii html icalendar latex)
754 "List of export back-ends that should be always available.
756 If a description starts with <C>, the file is not part of Emacs
757 and loading it will require that you have downloaded and properly
758 installed the Org mode distribution.
760 Unlike to `org-modules', libraries in this list will not be
761 loaded along with Org, but only once the export framework is
762 needed.
764 This variable needs to be set before org.el is loaded. If you
765 need to make a change while Emacs is running, use the customize
766 interface or run the following code, where VAL stands for the new
767 value of the variable, after updating it:
769 (progn
770 (setq org-export-registered-backends
771 (cl-remove-if-not
772 (lambda (backend)
773 (let ((name (org-export-backend-name backend)))
774 (or (memq name val)
775 (catch \\='parentp
776 (dolist (b val)
777 (and (org-export-derived-backend-p b name)
778 (throw \\='parentp t)))))))
779 org-export-registered-backends))
780 (let ((new-list (mapcar #\\='org-export-backend-name
781 org-export-registered-backends)))
782 (dolist (backend val)
783 (cond
784 ((not (load (format \"ox-%s\" backend) t t))
785 (message \"Problems while trying to load export back-end \\=`%s\\='\"
786 backend))
787 ((not (memq backend new-list)) (push backend new-list))))
788 (set-default \\='org-export-backends new-list)))
790 Adding a back-end to this list will also pull the back-end it
791 depends on, if any."
792 :group 'org
793 :group 'org-export
794 :version "24.4"
795 :package-version '(Org . "8.0")
796 :initialize 'custom-initialize-set
797 :set (lambda (var val)
798 (if (not (featurep 'ox)) (set-default var val)
799 ;; Any back-end not required anymore (not present in VAL and not
800 ;; a parent of any back-end in the new value) is removed from the
801 ;; list of registered back-ends.
802 (setq org-export-registered-backends
803 (cl-remove-if-not
804 (lambda (backend)
805 (let ((name (org-export-backend-name backend)))
806 (or (memq name val)
807 (catch 'parentp
808 (dolist (b val)
809 (and (org-export-derived-backend-p b name)
810 (throw 'parentp t)))))))
811 org-export-registered-backends))
812 ;; Now build NEW-LIST of both new back-ends and required
813 ;; parents.
814 (let ((new-list (mapcar #'org-export-backend-name
815 org-export-registered-backends)))
816 (dolist (backend val)
817 (cond
818 ((not (load (format "ox-%s" backend) t t))
819 (message "Problems while trying to load export back-end `%s'"
820 backend))
821 ((not (memq backend new-list)) (push backend new-list))))
822 ;; Set VAR to that list with fixed dependencies.
823 (set-default var new-list))))
824 :type '(set :greedy t
825 (const :tag " ascii Export buffer to ASCII format" ascii)
826 (const :tag " beamer Export buffer to Beamer presentation" beamer)
827 (const :tag " html Export buffer to HTML format" html)
828 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
829 (const :tag " latex Export buffer to LaTeX format" latex)
830 (const :tag " man Export buffer to MAN format" man)
831 (const :tag " md Export buffer to Markdown format" md)
832 (const :tag " odt Export buffer to ODT format" odt)
833 (const :tag " org Export buffer to Org format" org)
834 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
835 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
836 (const :tag "C deck Export buffer to deck.js presentations" deck)
837 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
838 (const :tag "C groff Export buffer to Groff format" groff)
839 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
840 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
841 (const :tag "C s5 Export buffer to s5 presentations" s5)
842 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
844 (eval-after-load 'ox
845 '(mapc
846 (lambda (backend)
847 (condition-case nil (require (intern (format "ox-%s" backend)))
848 (error (message "Problems while trying to load export back-end `%s'"
849 backend))))
850 org-export-backends))
852 (defcustom org-support-shift-select nil
853 "Non-nil means make shift-cursor commands select text when possible.
854 \\<org-mode-map>\
856 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
857 start selecting a region, or enlarge regions started in this way.
858 In Org-mode, in special contexts, these same keys are used for
859 other purposes, important enough to compete with shift selection.
860 Org tries to balance these needs by supporting `shift-select-mode'
861 outside these special contexts, under control of this variable.
863 The default of this variable is nil, to avoid confusing behavior. Shifted
864 cursor keys will then execute Org commands in the following contexts:
865 - on a headline, changing TODO state (left/right) and priority (up/down)
866 - on a time stamp, changing the time
867 - in a plain list item, changing the bullet type
868 - in a property definition line, switching between allowed values
869 - in the BEGIN line of a clock table (changing the time block).
870 Outside these contexts, the commands will throw an error.
872 When this variable is t and the cursor is not in a special
873 context, Org-mode will support shift-selection for making and
874 enlarging regions. To make this more effective, the bullet
875 cycling will no longer happen anywhere in an item line, but only
876 if the cursor is exactly on the bullet.
878 If you set this variable to the symbol `always', then the keys
879 will not be special in headlines, property lines, and item lines,
880 to make shift selection work there as well. If this is what you
881 want, you can use the following alternative commands:
882 `\\[org-todo]' and `\\[org-priority]' \
883 to change TODO state and priority,
884 `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
885 can be used to switch TODO sets,
886 `\\[org-ctrl-c-minus]' to cycle item bullet types,
887 and properties can be edited by hand or in column view.
889 However, when the cursor is on a timestamp, shift-cursor commands
890 will still edit the time stamp - this is just too good to give up.
892 XEmacs user should have this variable set to nil, because
893 `shift-select-mode' is in Emacs 23 or later only."
894 :group 'org
895 :type '(choice
896 (const :tag "Never" nil)
897 (const :tag "When outside special context" t)
898 (const :tag "Everywhere except timestamps" always)))
900 (defcustom org-loop-over-headlines-in-active-region nil
901 "Shall some commands act upon headlines in the active region?
903 When set to t, some commands will be performed in all headlines
904 within the active region.
906 When set to `start-level', some commands will be performed in all
907 headlines within the active region, provided that these headlines
908 are of the same level than the first one.
910 When set to a string, those commands will be performed on the
911 matching headlines within the active region. Such string must be
912 a tags/property/todo match as it is used in the agenda tags view.
914 The list of commands is: `org-schedule', `org-deadline',
915 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
916 `org-archive-to-archive-sibling'. The archiving commands skip
917 already archived entries."
918 :type '(choice (const :tag "Don't loop" nil)
919 (const :tag "All headlines in active region" t)
920 (const :tag "In active region, headlines at the same level than the first one" start-level)
921 (string :tag "Tags/Property/Todo matcher"))
922 :version "24.1"
923 :group 'org-todo
924 :group 'org-archive)
926 (defgroup org-startup nil
927 "Options concerning startup of Org-mode."
928 :tag "Org Startup"
929 :group 'org)
931 (defcustom org-startup-folded t
932 "Non-nil means entering Org-mode will switch to OVERVIEW.
933 This can also be configured on a per-file basis by adding one of
934 the following lines anywhere in the buffer:
936 #+STARTUP: fold (or `overview', this is equivalent)
937 #+STARTUP: nofold (or `showall', this is equivalent)
938 #+STARTUP: content
939 #+STARTUP: showeverything
941 By default, this option is ignored when Org opens agenda files
942 for the first time. If you want the agenda to honor the startup
943 option, set `org-agenda-inhibit-startup' to nil."
944 :group 'org-startup
945 :type '(choice
946 (const :tag "nofold: show all" nil)
947 (const :tag "fold: overview" t)
948 (const :tag "content: all headlines" content)
949 (const :tag "show everything, even drawers" showeverything)))
951 (defcustom org-startup-truncated t
952 "Non-nil means entering Org-mode will set `truncate-lines'.
953 This is useful since some lines containing links can be very long and
954 uninteresting. Also tables look terrible when wrapped."
955 :group 'org-startup
956 :type 'boolean)
958 (defcustom org-startup-indented nil
959 "Non-nil means turn on `org-indent-mode' on startup.
960 This can also be configured on a per-file basis by adding one of
961 the following lines anywhere in the buffer:
963 #+STARTUP: indent
964 #+STARTUP: noindent"
965 :group 'org-structure
966 :type '(choice
967 (const :tag "Not" nil)
968 (const :tag "Globally (slow on startup in large files)" t)))
970 (defcustom org-use-sub-superscripts t
971 "Non-nil means interpret \"_\" and \"^\" for display.
973 If you want to control how Org exports those characters, see
974 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
975 used to be an alias for `org-export-with-sub-superscripts' in
976 Org <8.0, it is not anymore.
978 When this option is turned on, you can use TeX-like syntax for
979 sub- and superscripts within the buffer. Several characters after
980 \"_\" or \"^\" will be considered as a single item - so grouping
981 with {} is normally not needed. For example, the following things
982 will be parsed as single sub- or superscripts:
984 10^24 or 10^tau several digits will be considered 1 item.
985 10^-12 or 10^-tau a leading sign with digits or a word
986 x^2-y^3 will be read as x^2 - y^3, because items are
987 terminated by almost any nonword/nondigit char.
988 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
990 Still, ambiguity is possible. So when in doubt, use {} to enclose
991 the sub/superscript. If you set this variable to the symbol `{}',
992 the braces are *required* in order to trigger interpretations as
993 sub/superscript. This can be helpful in documents that need \"_\"
994 frequently in plain text."
995 :group 'org-startup
996 :version "24.4"
997 :package-version '(Org . "8.0")
998 :type '(choice
999 (const :tag "Always interpret" t)
1000 (const :tag "Only with braces" {})
1001 (const :tag "Never interpret" nil)))
1003 (defcustom org-startup-with-beamer-mode nil
1004 "Non-nil means turn on `org-beamer-mode' on startup.
1005 This can also be configured on a per-file basis by adding one of
1006 the following lines anywhere in the buffer:
1008 #+STARTUP: beamer"
1009 :group 'org-startup
1010 :version "24.1"
1011 :type 'boolean)
1013 (defcustom org-startup-align-all-tables nil
1014 "Non-nil means align all tables when visiting a file.
1015 This is useful when the column width in tables is forced with <N> cookies
1016 in table fields. Such tables will look correct only after the first re-align.
1017 This can also be configured on a per-file basis by adding one of
1018 the following lines anywhere in the buffer:
1019 #+STARTUP: align
1020 #+STARTUP: noalign"
1021 :group 'org-startup
1022 :type 'boolean)
1024 (defcustom org-startup-with-inline-images nil
1025 "Non-nil means show inline images when loading a new Org file.
1026 This can also be configured on a per-file basis by adding one of
1027 the following lines anywhere in the buffer:
1028 #+STARTUP: inlineimages
1029 #+STARTUP: noinlineimages"
1030 :group 'org-startup
1031 :version "24.1"
1032 :type 'boolean)
1034 (defcustom org-startup-with-latex-preview nil
1035 "Non-nil means preview LaTeX fragments when loading a new Org file.
1037 This can also be configured on a per-file basis by adding one of
1038 the following lines anywhere in the buffer:
1039 #+STARTUP: latexpreview
1040 #+STARTUP: nolatexpreview"
1041 :group 'org-startup
1042 :version "24.4"
1043 :package-version '(Org . "8.0")
1044 :type 'boolean)
1046 (defcustom org-insert-mode-line-in-empty-file nil
1047 "Non-nil means insert the first line setting Org-mode in empty files.
1048 When the function `org-mode' is called interactively in an empty file, this
1049 normally means that the file name does not automatically trigger Org-mode.
1050 To ensure that the file will always be in Org-mode in the future, a
1051 line enforcing Org-mode will be inserted into the buffer, if this option
1052 has been set."
1053 :group 'org-startup
1054 :type 'boolean)
1056 (defcustom org-replace-disputed-keys nil
1057 "Non-nil means use alternative key bindings for some keys.
1058 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1059 These keys are also used by other packages like shift-selection-mode'
1060 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1061 If you want to use Org-mode together with one of these other modes,
1062 or more generally if you would like to move some Org-mode commands to
1063 other keys, set this variable and configure the keys with the variable
1064 `org-disputed-keys'.
1066 This option is only relevant at load-time of Org-mode, and must be set
1067 *before* org.el is loaded. Changing it requires a restart of Emacs to
1068 become effective."
1069 :group 'org-startup
1070 :type 'boolean)
1072 (defcustom org-use-extra-keys nil
1073 "Non-nil means use extra key sequence definitions for certain commands.
1074 This happens automatically if you run XEmacs or if `window-system'
1075 is nil. This variable lets you do the same manually. You must
1076 set it before loading org.
1078 Example: on Carbon Emacs 22 running graphically, with an external
1079 keyboard on a Powerbook, the default way of setting M-left might
1080 not work for either Alt or ESC. Setting this variable will make
1081 it work for ESC."
1082 :group 'org-startup
1083 :type 'boolean)
1085 (org-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's startup,
1100 therefore you'll have to restart Emacs to apply it after changing."
1101 :group 'org-startup
1102 :type 'alist)
1104 (defun org-key (key)
1105 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1106 Or return the original if not disputed.
1107 Also apply the translations defined in `org-xemacs-key-equivalents'."
1108 (when org-replace-disputed-keys
1109 (let* ((nkey (key-description key))
1110 (x (org-find-if (lambda (x)
1111 (equal (key-description (car x)) nkey))
1112 org-disputed-keys)))
1113 (setq key (if x (cdr x) key))))
1114 (when (featurep 'xemacs)
1115 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1116 key)
1118 (defun org-find-if (predicate seq)
1119 (catch 'exit
1120 (while seq
1121 (if (funcall predicate (car seq))
1122 (throw 'exit (car seq))
1123 (pop seq)))))
1125 (defun org-defkey (keymap key def)
1126 "Define a key, possibly translated, as returned by `org-key'."
1127 (define-key keymap (org-key key) def))
1129 (defcustom org-ellipsis nil
1130 "The ellipsis to use in the Org-mode outline.
1131 When nil, just use the standard three dots.
1132 When a string, use that string instead.
1133 When a face, use the standard 3 dots, but with the specified face.
1134 The change affects only Org-mode (which will then use its own display table).
1135 Changing this requires executing \\[org-mode] in a buffer to become
1136 effective."
1137 :group 'org-startup
1138 :type '(choice (const :tag "Default" nil)
1139 (face :tag "Face" :value org-warning)
1140 (string :tag "String" :value "...#")))
1142 (defvar org-display-table nil
1143 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1145 (defgroup org-keywords nil
1146 "Keywords in Org-mode."
1147 :tag "Org Keywords"
1148 :group 'org)
1150 (defcustom org-closed-keep-when-no-todo nil
1151 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1152 :group 'org-todo
1153 :group 'org-keywords
1154 :version "24.4"
1155 :package-version '(Org . "8.0")
1156 :type 'boolean)
1158 (defgroup org-structure nil
1159 "Options concerning the general structure of Org-mode files."
1160 :tag "Org Structure"
1161 :group 'org)
1163 (defgroup org-reveal-location nil
1164 "Options about how to make context of a location visible."
1165 :tag "Org Reveal Location"
1166 :group 'org-structure)
1168 (defcustom org-show-context-detail '((isearch . lineage)
1169 (bookmark-jump . lineage)
1170 (default . ancestors))
1171 "Alist between context and visibility span when revealing a location.
1173 \\<org-mode-map>Some actions may move point into invisible
1174 locations. As a consequence, Org always expose a neighborhood
1175 around point. How much is shown depends on the initial action,
1176 or context. Valid contexts are
1178 agenda when exposing an entry from the agenda
1179 org-goto when using the command `org-goto' (\\[org-goto])
1180 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1181 tags-tree when constructing a sparse tree based on tags matches
1182 link-search when exposing search matches associated with a link
1183 mark-goto when exposing the jump goal of a mark
1184 bookmark-jump when exposing a bookmark location
1185 isearch when exiting from an incremental search
1186 default default for all contexts not set explicitly
1188 Allowed visibility spans are
1190 minimal show current headline; if point is not on headline,
1191 also show entry
1193 local show current headline, entry and next headline
1195 ancestors show current headline and its direct ancestors; if
1196 point is not on headline, also show entry
1198 lineage show current headline, its direct ancestors and all
1199 their children; if point is not on headline, also show
1200 entry and first child
1202 tree show current headline, its direct ancestors and all
1203 their children; if point is not on headline, also show
1204 entry and all children
1206 canonical show current headline, its direct ancestors along with
1207 their entries and children; if point is not located on
1208 the headline, also show current entry and all children
1210 As special cases, a nil or t value means show all contexts in
1211 `minimal' or `canonical' view, respectively.
1213 Some views can make displayed information very compact, but also
1214 make it harder to edit the location of the match. In such
1215 a case, use the command `org-reveal' (\\[org-reveal]) to show
1216 more context."
1217 :group 'org-reveal-location
1218 :version "25.1"
1219 :package-version '(Org . "8.3")
1220 :type '(choice
1221 (const :tag "Canonical" t)
1222 (const :tag "Minimal" nil)
1223 (repeat :greedy t :tag "Individual contexts"
1224 (cons
1225 (choice :tag "Context"
1226 (const agenda)
1227 (const org-goto)
1228 (const occur-tree)
1229 (const tags-tree)
1230 (const link-search)
1231 (const mark-goto)
1232 (const bookmark-jump)
1233 (const isearch)
1234 (const default))
1235 (choice :tag "Detail level"
1236 (const minimal)
1237 (const local)
1238 (const ancestors)
1239 (const lineage)
1240 (const tree)
1241 (const canonical))))))
1243 (defcustom org-indirect-buffer-display 'other-window
1244 "How should indirect tree buffers be displayed?
1245 This applies to indirect buffers created with the commands
1246 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1247 Valid values are:
1248 current-window Display in the current window
1249 other-window Just display in another window.
1250 dedicated-frame Create one new frame, and re-use it each time.
1251 new-frame Make a new frame each time. Note that in this case
1252 previously-made indirect buffers are kept, and you need to
1253 kill these buffers yourself."
1254 :group 'org-structure
1255 :group 'org-agenda-windows
1256 :type '(choice
1257 (const :tag "In current window" current-window)
1258 (const :tag "In current frame, other window" other-window)
1259 (const :tag "Each time a new frame" new-frame)
1260 (const :tag "One dedicated frame" dedicated-frame)))
1262 (defcustom org-use-speed-commands nil
1263 "Non-nil means activate single letter commands at beginning of a headline.
1264 This may also be a function to test for appropriate locations where speed
1265 commands should be active.
1267 For example, to activate speed commands when the point is on any
1268 star at the beginning of the headline, you can do this:
1270 (setq org-use-speed-commands
1271 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1272 :group 'org-structure
1273 :type '(choice
1274 (const :tag "Never" nil)
1275 (const :tag "At beginning of headline stars" t)
1276 (function)))
1278 (defcustom org-speed-commands-user nil
1279 "Alist of additional speed commands.
1280 This list will be checked before `org-speed-commands-default'
1281 when the variable `org-use-speed-commands' is non-nil
1282 and when the cursor is at the beginning of a headline.
1283 The car if each entry is a string with a single letter, which must
1284 be assigned to `self-insert-command' in the global map.
1285 The cdr is either a command to be called interactively, a function
1286 to be called, or a form to be evaluated.
1287 An entry that is just a list with a single string will be interpreted
1288 as a descriptive headline that will be added when listing the speed
1289 commands in the Help buffer using the `?' speed command."
1290 :group 'org-structure
1291 :type '(repeat :value ("k" . ignore)
1292 (choice :value ("k" . ignore)
1293 (list :tag "Descriptive Headline" (string :tag "Headline"))
1294 (cons :tag "Letter and Command"
1295 (string :tag "Command letter")
1296 (choice
1297 (function)
1298 (sexp))))))
1300 (defcustom org-bookmark-names-plist
1301 '(:last-capture "org-capture-last-stored"
1302 :last-refile "org-refile-last-stored"
1303 :last-capture-marker "org-capture-last-stored-marker")
1304 "Names for bookmarks automatically set by some Org commands.
1305 This can provide strings as names for a number of bookmarks Org sets
1306 automatically. The following keys are currently implemented:
1307 :last-capture
1308 :last-capture-marker
1309 :last-refile
1310 When a key does not show up in the property list, the corresponding bookmark
1311 is not set."
1312 :group 'org-structure
1313 :type 'plist)
1315 (defgroup org-cycle nil
1316 "Options concerning visibility cycling in Org-mode."
1317 :tag "Org Cycle"
1318 :group 'org-structure)
1320 (defcustom org-cycle-skip-children-state-if-no-children t
1321 "Non-nil means skip CHILDREN state in entries that don't have any."
1322 :group 'org-cycle
1323 :type 'boolean)
1325 (defcustom org-cycle-max-level nil
1326 "Maximum level which should still be subject to visibility cycling.
1327 Levels higher than this will, for cycling, be treated as text, not a headline.
1328 When `org-odd-levels-only' is set, a value of N in this variable actually
1329 means 2N-1 stars as the limiting headline.
1330 When nil, cycle all levels.
1331 Note that the limiting level of cycling is also influenced by
1332 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1333 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1334 than its value."
1335 :group 'org-cycle
1336 :type '(choice
1337 (const :tag "No limit" nil)
1338 (integer :tag "Maximum level")))
1340 (defcustom org-hide-block-startup nil
1341 "Non-nil means entering Org-mode will fold all blocks.
1342 This can also be set in on a per-file basis with
1344 #+STARTUP: hideblocks
1345 #+STARTUP: showblocks"
1346 :group 'org-startup
1347 :group 'org-cycle
1348 :type 'boolean)
1350 (defcustom org-cycle-global-at-bob nil
1351 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1352 This makes it possible to do global cycling without having to use S-TAB or
1353 \\[universal-argument] TAB. For this special case to work, the first line
1354 of the buffer must not be a headline -- it may be empty or some other text.
1355 When used in this way, `org-cycle-hook' is disabled temporarily to make
1356 sure the cursor stays at the beginning of the buffer. When this option is
1357 nil, don't do anything special at the beginning of the buffer."
1358 :group 'org-cycle
1359 :type 'boolean)
1361 (defcustom org-cycle-level-after-item/entry-creation t
1362 "Non-nil means cycle entry level or item indentation in new empty entries.
1364 When the cursor is at the end of an empty headline, i.e., with only stars
1365 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1366 and then all possible ancestor states, before returning to the original state.
1367 This makes data entry extremely fast: M-RET to create a new headline,
1368 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1370 When the cursor is at the end of an empty plain list item, one TAB will
1371 make it a subitem, two or more tabs will back up to make this an item
1372 higher up in the item hierarchy."
1373 :group 'org-cycle
1374 :type 'boolean)
1376 (defcustom org-cycle-emulate-tab t
1377 "Where should `org-cycle' emulate TAB.
1378 nil Never
1379 white Only in completely white lines
1380 whitestart Only at the beginning of lines, before the first non-white char
1381 t Everywhere except in headlines
1382 exc-hl-bol Everywhere except at the start of a headline
1383 If TAB is used in a place where it does not emulate TAB, the current subtree
1384 visibility is cycled."
1385 :group 'org-cycle
1386 :type '(choice (const :tag "Never" nil)
1387 (const :tag "Only in completely white lines" white)
1388 (const :tag "Before first char in a line" whitestart)
1389 (const :tag "Everywhere except in headlines" t)
1390 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1392 (defcustom org-cycle-separator-lines 2
1393 "Number of empty lines needed to keep an empty line between collapsed trees.
1394 If you leave an empty line between the end of a subtree and the following
1395 headline, this empty line is hidden when the subtree is folded.
1396 Org-mode will leave (exactly) one empty line visible if the number of
1397 empty lines is equal or larger to the number given in this variable.
1398 So the default 2 means at least 2 empty lines after the end of a subtree
1399 are needed to produce free space between a collapsed subtree and the
1400 following headline.
1402 If the number is negative, and the number of empty lines is at least -N,
1403 all empty lines are shown.
1405 Special case: when 0, never leave empty lines in collapsed view."
1406 :group 'org-cycle
1407 :type 'integer)
1408 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1410 (defcustom org-pre-cycle-hook nil
1411 "Hook that is run before visibility cycling is happening.
1412 The function(s) in this hook must accept a single argument which indicates
1413 the new state that will be set right after running this hook. The
1414 argument is a symbol. Before a global state change, it can have the values
1415 `overview', `content', or `all'. Before a local state change, it can have
1416 the values `folded', `children', or `subtree'."
1417 :group 'org-cycle
1418 :type 'hook)
1420 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1421 org-cycle-hide-drawers
1422 org-cycle-show-empty-lines
1423 org-optimize-window-after-visibility-change)
1424 "Hook that is run after `org-cycle' has changed the buffer visibility.
1425 The function(s) in this hook must accept a single argument which indicates
1426 the new state that was set by the most recent `org-cycle' command. The
1427 argument is a symbol. After a global state change, it can have the values
1428 `overview', `contents', or `all'. After a local state change, it can have
1429 the values `folded', `children', or `subtree'."
1430 :group 'org-cycle
1431 :type 'hook
1432 :version "25.1"
1433 :package-version '(Org . "8.3"))
1435 (defgroup org-edit-structure nil
1436 "Options concerning structure editing in Org-mode."
1437 :tag "Org Edit Structure"
1438 :group 'org-structure)
1440 (defcustom org-odd-levels-only nil
1441 "Non-nil means skip even levels and only use odd levels for the outline.
1442 This has the effect that two stars are being added/taken away in
1443 promotion/demotion commands. It also influences how levels are
1444 handled by the exporters.
1445 Changing it requires restart of `font-lock-mode' to become effective
1446 for fontification also in regions already fontified.
1447 You may also set this on a per-file basis by adding one of the following
1448 lines to the buffer:
1450 #+STARTUP: odd
1451 #+STARTUP: oddeven"
1452 :group 'org-edit-structure
1453 :group 'org-appearance
1454 :type 'boolean)
1456 (defcustom org-adapt-indentation t
1457 "Non-nil means adapt indentation to outline node level.
1459 When this variable is set, Org assumes that you write outlines by
1460 indenting text in each node to align with the headline (after the
1461 stars). The following issues are influenced by this variable:
1463 - The indentation is increased by one space in a demotion
1464 command, and decreased by one in a promotion command. However,
1465 in the latter case, if shifting some line in the entry body
1466 would alter document structure (e.g., insert a new headline),
1467 indentation is not changed at all.
1469 - Property drawers and planning information is inserted indented
1470 when this variable is set. When nil, they will not be indented.
1472 - TAB indents a line relative to current level. The lines below
1473 a headline will be indented when this variable is set.
1475 Note that this is all about true indentation, by adding and
1476 removing space characters. See also `org-indent.el' which does
1477 level-dependent indentation in a virtual way, i.e. at display
1478 time in Emacs."
1479 :group 'org-edit-structure
1480 :type 'boolean)
1482 (defcustom org-special-ctrl-a/e nil
1483 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1485 When t, `C-a' will bring back the cursor to the beginning of the
1486 headline text, i.e. after the stars and after a possible TODO
1487 keyword. In an item, this will be the position after bullet and
1488 check-box, if any. When the cursor is already at that position,
1489 another `C-a' will bring it to the beginning of the line.
1491 `C-e' will jump to the end of the headline, ignoring the presence
1492 of tags in the headline. A second `C-e' will then jump to the
1493 true end of the line, after any tags. This also means that, when
1494 this variable is non-nil, `C-e' also will never jump beyond the
1495 end of the heading of a folded section, i.e. not after the
1496 ellipses.
1498 When set to the symbol `reversed', the first `C-a' or `C-e' works
1499 normally, going to the true line boundary first. Only a directly
1500 following, identical keypress will bring the cursor to the
1501 special positions.
1503 This may also be a cons cell where the behavior for `C-a' and
1504 `C-e' is set separately."
1505 :group 'org-edit-structure
1506 :type '(choice
1507 (const :tag "off" nil)
1508 (const :tag "on: after stars/bullet and before tags first" t)
1509 (const :tag "reversed: true line boundary first" reversed)
1510 (cons :tag "Set C-a and C-e separately"
1511 (choice :tag "Special C-a"
1512 (const :tag "off" nil)
1513 (const :tag "on: after stars/bullet first" t)
1514 (const :tag "reversed: before stars/bullet first" reversed))
1515 (choice :tag "Special C-e"
1516 (const :tag "off" nil)
1517 (const :tag "on: before tags first" t)
1518 (const :tag "reversed: after tags first" reversed)))))
1519 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1521 (defcustom org-special-ctrl-k nil
1522 "Non-nil means `C-k' will behave specially in headlines.
1523 When nil, `C-k' will call the default `kill-line' command.
1524 When t, the following will happen while the cursor is in the headline:
1526 - When the cursor is at the beginning of a headline, kill the entire
1527 line and possible the folded subtree below the line.
1528 - When in the middle of the headline text, kill the headline up to the tags.
1529 - When after the headline text, kill the tags."
1530 :group 'org-edit-structure
1531 :type 'boolean)
1533 (defcustom org-ctrl-k-protect-subtree nil
1534 "Non-nil means, do not delete a hidden subtree with C-k.
1535 When set to the symbol `error', simply throw an error when C-k is
1536 used to kill (part-of) a headline that has hidden text behind it.
1537 Any other non-nil value will result in a query to the user, if it is
1538 OK to kill that hidden subtree. When nil, kill without remorse."
1539 :group 'org-edit-structure
1540 :version "24.1"
1541 :type '(choice
1542 (const :tag "Do not protect hidden subtrees" nil)
1543 (const :tag "Protect hidden subtrees with a security query" t)
1544 (const :tag "Never kill a hidden subtree with C-k" error)))
1546 (defcustom org-special-ctrl-o t
1547 "Non-nil means, make `C-o' insert a row in tables."
1548 :group 'org-edit-structure
1549 :type 'boolean)
1551 (defcustom org-catch-invisible-edits nil
1552 "Check if in invisible region before inserting or deleting a character.
1553 Valid values are:
1555 nil Do not check, so just do invisible edits.
1556 error Throw an error and do nothing.
1557 show Make point visible, and do the requested edit.
1558 show-and-error Make point visible, then throw an error and abort the edit.
1559 smart Make point visible, and do insertion/deletion if it is
1560 adjacent to visible text and the change feels predictable.
1561 Never delete a previously invisible character or add in the
1562 middle or right after an invisible region. Basically, this
1563 allows insertion and backward-delete right before ellipses.
1564 FIXME: maybe in this case we should not even show?"
1565 :group 'org-edit-structure
1566 :version "24.1"
1567 :type '(choice
1568 (const :tag "Do not check" nil)
1569 (const :tag "Throw error when trying to edit" error)
1570 (const :tag "Unhide, but do not do the edit" show-and-error)
1571 (const :tag "Show invisible part and do the edit" show)
1572 (const :tag "Be smart and do the right thing" smart)))
1574 (defcustom org-yank-folded-subtrees t
1575 "Non-nil means when yanking subtrees, fold them.
1576 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1577 it starts with a heading and all other headings in it are either children
1578 or siblings, then fold all the subtrees. However, do this only if no
1579 text after the yank would be swallowed into a folded tree by this action."
1580 :group 'org-edit-structure
1581 :type 'boolean)
1583 (defcustom org-yank-adjusted-subtrees nil
1584 "Non-nil means when yanking subtrees, adjust the level.
1585 With this setting, `org-paste-subtree' is used to insert the subtree, see
1586 this function for details."
1587 :group 'org-edit-structure
1588 :type 'boolean)
1590 (defcustom org-M-RET-may-split-line '((default . t))
1591 "Non-nil means M-RET will split the line at the cursor position.
1592 When nil, it will go to the end of the line before making a
1593 new line.
1594 You may also set this option in a different way for different
1595 contexts. Valid contexts are:
1597 headline when creating a new headline
1598 item when creating a new item
1599 table in a table field
1600 default the value to be used for all contexts not explicitly
1601 customized"
1602 :group 'org-structure
1603 :group 'org-table
1604 :type '(choice
1605 (const :tag "Always" t)
1606 (const :tag "Never" nil)
1607 (repeat :greedy t :tag "Individual contexts"
1608 (cons
1609 (choice :tag "Context"
1610 (const headline)
1611 (const item)
1612 (const table)
1613 (const default))
1614 (boolean)))))
1617 (defcustom org-insert-heading-respect-content nil
1618 "Non-nil means insert new headings after the current subtree.
1619 When nil, the new heading is created directly after the current line.
1620 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1621 this variable on for the duration of the command."
1622 :group 'org-structure
1623 :type 'boolean)
1625 (defcustom org-blank-before-new-entry '((heading . auto)
1626 (plain-list-item . auto))
1627 "Should `org-insert-heading' leave a blank line before new heading/item?
1628 The value is an alist, with `heading' and `plain-list-item' as CAR,
1629 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1630 which case Org will look at the surrounding headings/items and try to
1631 make an intelligent decision whether to insert a blank line or not."
1632 :group 'org-edit-structure
1633 :type '(list
1634 (cons (const heading)
1635 (choice (const :tag "Never" nil)
1636 (const :tag "Always" t)
1637 (const :tag "Auto" auto)))
1638 (cons (const plain-list-item)
1639 (choice (const :tag "Never" nil)
1640 (const :tag "Always" t)
1641 (const :tag "Auto" auto)))))
1643 (defcustom org-insert-heading-hook nil
1644 "Hook being run after inserting a new heading."
1645 :group 'org-edit-structure
1646 :type 'hook)
1648 (defcustom org-enable-fixed-width-editor t
1649 "Non-nil means lines starting with \":\" are treated as fixed-width.
1650 This currently only means they are never auto-wrapped.
1651 When nil, such lines will be treated like ordinary lines."
1652 :group 'org-edit-structure
1653 :type 'boolean)
1655 (defcustom org-goto-auto-isearch t
1656 "Non-nil means typing characters in `org-goto' starts incremental search.
1657 When nil, you can use these keybindings to navigate the buffer:
1659 q Quit the org-goto interface
1660 n Go to the next visible heading
1661 p Go to the previous visible heading
1662 f Go one heading forward on same level
1663 b Go one heading backward on same level
1664 u Go one heading up"
1665 :group 'org-edit-structure
1666 :type 'boolean)
1668 (defgroup org-sparse-trees nil
1669 "Options concerning sparse trees in Org-mode."
1670 :tag "Org Sparse Trees"
1671 :group 'org-structure)
1673 (defcustom org-highlight-sparse-tree-matches t
1674 "Non-nil means highlight all matches that define a sparse tree.
1675 The highlights will automatically disappear the next time the buffer is
1676 changed by an edit command."
1677 :group 'org-sparse-trees
1678 :type 'boolean)
1680 (defcustom org-remove-highlights-with-change t
1681 "Non-nil means any change to the buffer will remove temporary highlights.
1682 \\<org-mode-map>\
1683 Such highlights are created by `org-occur' and `org-clock-display'.
1684 When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
1685 to get rid of the highlights.
1686 The highlights created by `org-toggle-latex-fragment' always need
1687 `\\[org-toggle-latex-fragment]' to be removed."
1688 :group 'org-sparse-trees
1689 :group 'org-time
1690 :type 'boolean)
1693 (defcustom org-occur-hook '(org-first-headline-recenter)
1694 "Hook that is run after `org-occur' has constructed a sparse tree.
1695 This can be used to recenter the window to show as much of the structure
1696 as possible."
1697 :group 'org-sparse-trees
1698 :type 'hook)
1700 (defgroup org-imenu-and-speedbar nil
1701 "Options concerning imenu and speedbar in Org-mode."
1702 :tag "Org Imenu and Speedbar"
1703 :group 'org-structure)
1705 (defcustom org-imenu-depth 2
1706 "The maximum level for Imenu access to Org-mode headlines.
1707 This also applied for speedbar access."
1708 :group 'org-imenu-and-speedbar
1709 :type 'integer)
1711 (defgroup org-table nil
1712 "Options concerning tables in Org-mode."
1713 :tag "Org Table"
1714 :group 'org)
1716 (defcustom org-enable-table-editor 'optimized
1717 "Non-nil means lines starting with \"|\" are handled by the table editor.
1718 When nil, such lines will be treated like ordinary lines.
1720 When equal to the symbol `optimized', the table editor will be optimized to
1721 do the following:
1722 - Automatic overwrite mode in front of whitespace in table fields.
1723 This makes the structure of the table stay in tact as long as the edited
1724 field does not exceed the column width.
1725 - Minimize the number of realigns. Normally, the table is aligned each time
1726 TAB or RET are pressed to move to another field. With optimization this
1727 happens only if changes to a field might have changed the column width.
1728 Optimization requires replacing the functions `self-insert-command',
1729 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1730 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1731 very good at guessing when a re-align will be necessary, but you can always
1732 force one with \\[org-ctrl-c-ctrl-c].
1734 If you would like to use the optimized version in Org-mode, but the
1735 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1737 This variable can be used to turn on and off the table editor during a session,
1738 but in order to toggle optimization, a restart is required.
1740 See also the variable `org-table-auto-blank-field'."
1741 :group 'org-table
1742 :type '(choice
1743 (const :tag "off" nil)
1744 (const :tag "on" t)
1745 (const :tag "on, optimized" optimized)))
1747 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1748 (version<= emacs-version "24.1"))
1749 "Non-nil means cluster self-insert commands for undo when possible.
1750 If this is set, then, like in the Emacs command loop, 20 consecutive
1751 characters will be undone together.
1752 This is configurable, because there is some impact on typing performance."
1753 :group 'org-table
1754 :type 'boolean)
1756 (defcustom org-table-tab-recognizes-table.el t
1757 "Non-nil means TAB will automatically notice a table.el table.
1758 When it sees such a table, it moves point into it and - if necessary -
1759 calls `table-recognize-table'."
1760 :group 'org-table-editing
1761 :type 'boolean)
1763 (defgroup org-link nil
1764 "Options concerning links in Org-mode."
1765 :tag "Org Link"
1766 :group 'org)
1768 (defvar-local org-link-abbrev-alist-local nil
1769 "Buffer-local version of `org-link-abbrev-alist', which see.
1770 The value of this is taken from the #+LINK lines.")
1772 (defcustom org-link-abbrev-alist nil
1773 "Alist of link abbreviations.
1774 The car of each element is a string, to be replaced at the start of a link.
1775 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1776 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1778 [[linkkey:tag][description]]
1780 The `linkkey' must be a word word, starting with a letter, followed
1781 by letters, numbers, `-' or `_'.
1783 If REPLACE is a string, the tag will simply be appended to create the link.
1784 If the string contains \"%s\", the tag will be inserted there. If the string
1785 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1786 at that point (see the function `url-hexify-string'). If the string contains
1787 the specifier \"%(my-function)\", then the custom function `my-function' will
1788 be invoked: this function takes the tag as its only argument and must return
1789 a string.
1791 REPLACE may also be a function that will be called with the tag as the
1792 only argument to create the link, which should be returned as a string.
1794 See the manual for examples."
1795 :group 'org-link
1796 :type '(repeat
1797 (cons
1798 (string :tag "Protocol")
1799 (choice
1800 (string :tag "Format")
1801 (function)))))
1803 (defcustom org-descriptive-links t
1804 "Non-nil means Org will display descriptive links.
1805 E.g. [[http://orgmode.org][Org website]] will be displayed as
1806 \"Org Website\", hiding the link itself and just displaying its
1807 description. When set to nil, Org will display the full links
1808 literally.
1810 You can interactively set the value of this variable by calling
1811 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1812 :group 'org-link
1813 :type 'boolean)
1815 (defcustom org-link-file-path-type 'adaptive
1816 "How the path name in file links should be stored.
1817 Valid values are:
1819 relative Relative to the current directory, i.e. the directory of the file
1820 into which the link is being inserted.
1821 absolute Absolute path, if possible with ~ for home directory.
1822 noabbrev Absolute path, no abbreviation of home directory.
1823 adaptive Use relative path for files in the current directory and sub-
1824 directories of it. For other files, use an absolute path."
1825 :group 'org-link
1826 :type '(choice
1827 (const relative)
1828 (const absolute)
1829 (const noabbrev)
1830 (const adaptive)))
1832 (defvaralias 'org-activate-links 'org-highlight-links)
1833 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1834 "Types of links that should be highlighted in Org-mode files.
1836 This is a list of symbols, each one of them leading to the
1837 highlighting of a certain link type.
1839 You can still open links that are not highlighted.
1841 In principle, it does not hurt to turn on highlighting for all
1842 link types. There may be a small gain when turning off unused
1843 link types. The types are:
1845 bracket The recommended [[link][description]] or [[link]] links with hiding.
1846 angle Links in angular brackets that may contain whitespace like
1847 <bbdb:Carsten Dominik>.
1848 plain Plain links in normal text, no whitespace, like http://google.com.
1849 radio Text that is matched by a radio target, see manual for details.
1850 tag Tag settings in a headline (link to tag search).
1851 date Time stamps (link to calendar).
1852 footnote Footnote labels.
1854 If you set this variable during an Emacs session, use `org-mode-restart'
1855 in the Org buffer so that the change takes effect."
1856 :group 'org-link
1857 :group 'org-appearance
1858 :type '(set :greedy t
1859 (const :tag "Double bracket links" bracket)
1860 (const :tag "Angular bracket links" angle)
1861 (const :tag "Plain text links" plain)
1862 (const :tag "Radio target matches" radio)
1863 (const :tag "Tags" tag)
1864 (const :tag "Timestamps" date)
1865 (const :tag "Footnotes" footnote)))
1867 (defcustom org-make-link-description-function nil
1868 "Function to use for generating link descriptions from links.
1869 When nil, the link location will be used. This function must take
1870 two parameters: the first one is the link, the second one is the
1871 description generated by `org-insert-link'. The function should
1872 return the description to use."
1873 :group 'org-link
1874 :type '(choice (const nil) (function)))
1876 (defgroup org-link-store nil
1877 "Options concerning storing links in Org-mode."
1878 :tag "Org Store Link"
1879 :group 'org-link)
1881 (defcustom org-url-hexify-p t
1882 "When non-nil, hexify URL when creating a link."
1883 :type 'boolean
1884 :version "24.3"
1885 :group 'org-link-store)
1887 (defcustom org-email-link-description-format "Email %c: %.30s"
1888 "Format of the description part of a link to an email or usenet message.
1889 The following %-escapes will be replaced by corresponding information:
1891 %F full \"From\" field
1892 %f name, taken from \"From\" field, address if no name
1893 %T full \"To\" field
1894 %t first name in \"To\" field, address if no name
1895 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1896 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1897 %s subject
1898 %d date
1899 %m message-id.
1901 You may use normal field width specification between the % and the letter.
1902 This is for example useful to limit the length of the subject.
1904 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1905 :group 'org-link-store
1906 :type 'string)
1908 (defcustom org-from-is-user-regexp
1909 (let (r1 r2)
1910 (when (and user-mail-address (not (string= user-mail-address "")))
1911 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1912 (when (and user-full-name (not (string= user-full-name "")))
1913 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1914 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1915 "Regexp matched against the \"From:\" header of an email or usenet message.
1916 It should match if the message is from the user him/herself."
1917 :group 'org-link-store
1918 :type 'regexp)
1920 (defcustom org-context-in-file-links t
1921 "Non-nil means file links from `org-store-link' contain context.
1922 A search string will be added to the file name with :: as separator and
1923 used to find the context when the link is activated by the command
1924 `org-open-at-point'. When this option is t, the entire active region
1925 will be placed in the search string of the file link. If set to a
1926 positive integer, only the first n lines of context will be stored.
1928 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1929 negates this setting for the duration of the command."
1930 :group 'org-link-store
1931 :type '(choice boolean integer))
1933 (defcustom org-keep-stored-link-after-insertion nil
1934 "Non-nil means keep link in list for entire session.
1936 The command `org-store-link' adds a link pointing to the current
1937 location to an internal list. These links accumulate during a session.
1938 The command `org-insert-link' can be used to insert links into any
1939 Org-mode file (offering completion for all stored links). When this
1940 option is nil, every link which has been inserted once using \\[org-insert-link]
1941 will be removed from the list, to make completing the unused links
1942 more efficient."
1943 :group 'org-link-store
1944 :type 'boolean)
1946 (defgroup org-link-follow nil
1947 "Options concerning following links in Org-mode."
1948 :tag "Org Follow Link"
1949 :group 'org-link)
1951 (defcustom org-link-translation-function nil
1952 "Function to translate links with different syntax to Org syntax.
1953 This can be used to translate links created for example by the Planner
1954 or emacs-wiki packages to Org syntax.
1955 The function must accept two parameters, a TYPE containing the link
1956 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1957 which is everything after the link protocol. It should return a cons
1958 with possibly modified values of type and path.
1959 Org contains a function for this, so if you set this variable to
1960 `org-translate-link-from-planner', you should be able follow many
1961 links created by planner."
1962 :group 'org-link-follow
1963 :type '(choice (const nil) (function)))
1965 (defcustom org-follow-link-hook nil
1966 "Hook that is run after a link has been followed."
1967 :group 'org-link-follow
1968 :type 'hook)
1970 (defcustom org-tab-follows-link nil
1971 "Non-nil means on links TAB will follow the link.
1972 Needs to be set before org.el is loaded.
1973 This really should not be used, it does not make sense, and the
1974 implementation is bad."
1975 :group 'org-link-follow
1976 :type 'boolean)
1978 (defcustom org-return-follows-link nil
1979 "Non-nil means on links RET will follow the link.
1980 In tables, the special behavior of RET has precedence."
1981 :group 'org-link-follow
1982 :type 'boolean)
1984 (defcustom org-mouse-1-follows-link
1985 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1986 "Non-nil means mouse-1 on a link will follow the link.
1987 A longer mouse click will still set point. Does not work on XEmacs.
1988 Needs to be set before org.el is loaded."
1989 :group 'org-link-follow
1990 :version "24.4"
1991 :package-version '(Org . "8.3")
1992 :type '(choice
1993 (const :tag "A double click follows the link" double)
1994 (const :tag "Unconditionally follow the link with mouse-1" t)
1995 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1997 (defcustom org-mark-ring-length 4
1998 "Number of different positions to be recorded in the ring.
1999 Changing this requires a restart of Emacs to work correctly."
2000 :group 'org-link-follow
2001 :type 'integer)
2003 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2004 "Non-nil means internal links in Org files must exactly match a headline.
2005 When nil, the link search tries to match a phrase with all words
2006 in the search text."
2007 :group 'org-link-follow
2008 :version "24.1"
2009 :type '(choice
2010 (const :tag "Use fuzzy text search" nil)
2011 (const :tag "Match only exact headline" t)
2012 (const :tag "Match exact headline or query to create it"
2013 query-to-create)))
2015 (defcustom org-link-frame-setup
2016 '((vm . vm-visit-folder-other-frame)
2017 (vm-imap . vm-visit-imap-folder-other-frame)
2018 (gnus . org-gnus-no-new-news)
2019 (file . find-file-other-window)
2020 (wl . wl-other-frame))
2021 "Setup the frame configuration for following links.
2022 When following a link with Emacs, it may often be useful to display
2023 this link in another window or frame. This variable can be used to
2024 set this up for the different types of links.
2025 For VM, use any of
2026 `vm-visit-folder'
2027 `vm-visit-folder-other-window'
2028 `vm-visit-folder-other-frame'
2029 For Gnus, use any of
2030 `gnus'
2031 `gnus-other-frame'
2032 `org-gnus-no-new-news'
2033 For FILE, use any of
2034 `find-file'
2035 `find-file-other-window'
2036 `find-file-other-frame'
2037 For Wanderlust use any of
2038 `wl'
2039 `wl-other-frame'
2040 For the calendar, use the variable `calendar-setup'.
2041 For BBDB, it is currently only possible to display the matches in
2042 another window."
2043 :group 'org-link-follow
2044 :type '(list
2045 (cons (const vm)
2046 (choice
2047 (const vm-visit-folder)
2048 (const vm-visit-folder-other-window)
2049 (const vm-visit-folder-other-frame)))
2050 (cons (const vm-imap)
2051 (choice
2052 (const vm-visit-imap-folder)
2053 (const vm-visit-imap-folder-other-window)
2054 (const vm-visit-imap-folder-other-frame)))
2055 (cons (const gnus)
2056 (choice
2057 (const gnus)
2058 (const gnus-other-frame)
2059 (const org-gnus-no-new-news)))
2060 (cons (const file)
2061 (choice
2062 (const find-file)
2063 (const find-file-other-window)
2064 (const find-file-other-frame)))
2065 (cons (const wl)
2066 (choice
2067 (const wl)
2068 (const wl-other-frame)))))
2070 (defcustom org-display-internal-link-with-indirect-buffer nil
2071 "Non-nil means use indirect buffer to display infile links.
2072 Activating internal links (from one location in a file to another location
2073 in the same file) normally just jumps to the location. When the link is
2074 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2075 is displayed in
2076 another window. When this option is set, the other window actually displays
2077 an indirect buffer clone of the current buffer, to avoid any visibility
2078 changes to the current buffer."
2079 :group 'org-link-follow
2080 :type 'boolean)
2082 (defcustom org-open-non-existing-files nil
2083 "Non-nil means `org-open-file' will open non-existing files.
2084 When nil, an error will be generated.
2085 This variable applies only to external applications because they
2086 might choke on non-existing files. If the link is to a file that
2087 will be opened in Emacs, the variable is ignored."
2088 :group 'org-link-follow
2089 :type 'boolean)
2091 (defcustom org-open-directory-means-index-dot-org nil
2092 "Non-nil means a link to a directory really means to index.org.
2093 When nil, following a directory link will run dired or open a finder/explorer
2094 window on that directory."
2095 :group 'org-link-follow
2096 :type 'boolean)
2098 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2099 "Non-nil means ask for confirmation before executing shell links.
2100 Shell links can be dangerous: just think about a link
2102 [[shell:rm -rf ~/*][Google Search]]
2104 This link would show up in your Org-mode document as \"Google Search\",
2105 but really it would remove your entire home directory.
2106 Therefore we advise against setting this variable to nil.
2107 Just change it to `y-or-n-p' if you want to confirm with a
2108 single keystroke rather than having to type \"yes\"."
2109 :group 'org-link-follow
2110 :type '(choice
2111 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2112 (const :tag "with y-or-n (faster)" y-or-n-p)
2113 (const :tag "no confirmation (dangerous)" nil)))
2114 (put 'org-confirm-shell-link-function
2115 'safe-local-variable
2116 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2118 (defcustom org-confirm-shell-link-not-regexp ""
2119 "A regexp to skip confirmation for shell links."
2120 :group 'org-link-follow
2121 :version "24.1"
2122 :type 'regexp)
2124 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2125 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2126 Elisp links can be dangerous: just think about a link
2128 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2130 This link would show up in your Org-mode document as \"Google Search\",
2131 but really it would remove your entire home directory.
2132 Therefore we advise against setting this variable to nil.
2133 Just change it to `y-or-n-p' if you want to confirm with a
2134 single keystroke rather than having to type \"yes\"."
2135 :group 'org-link-follow
2136 :type '(choice
2137 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2138 (const :tag "with y-or-n (faster)" y-or-n-p)
2139 (const :tag "no confirmation (dangerous)" nil)))
2140 (put 'org-confirm-shell-link-function
2141 'safe-local-variable
2142 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2144 (defcustom org-confirm-elisp-link-not-regexp ""
2145 "A regexp to skip confirmation for Elisp links."
2146 :group 'org-link-follow
2147 :version "24.1"
2148 :type 'regexp)
2150 (defconst org-file-apps-defaults-gnu
2151 '((remote . emacs)
2152 (system . mailcap)
2153 (t . mailcap))
2154 "Default file applications on a UNIX or GNU/Linux system.
2155 See `org-file-apps'.")
2157 (defconst org-file-apps-defaults-macosx
2158 '((remote . emacs)
2159 (t . "open %s")
2160 (system . "open %s")
2161 ("ps.gz" . "gv %s")
2162 ("eps.gz" . "gv %s")
2163 ("dvi" . "xdvi %s")
2164 ("fig" . "xfig %s"))
2165 "Default file applications on a MacOS X system.
2166 The system \"open\" is known as a default, but we use X11 applications
2167 for some files for which the OS does not have a good default.
2168 See `org-file-apps'.")
2170 (defconst org-file-apps-defaults-windowsnt
2171 (list
2172 '(remote . emacs)
2173 (cons t
2174 (list (if (featurep 'xemacs)
2175 'mswindows-shell-execute
2176 'w32-shell-execute)
2177 "open" 'file))
2178 (cons 'system
2179 (list (if (featurep 'xemacs)
2180 'mswindows-shell-execute
2181 'w32-shell-execute)
2182 "open" 'file)))
2183 "Default file applications on a Windows NT system.
2184 The system \"open\" is used for most files.
2185 See `org-file-apps'.")
2187 (defcustom org-file-apps
2188 '((auto-mode . emacs)
2189 ("\\.mm\\'" . default)
2190 ("\\.x?html?\\'" . default)
2191 ("\\.pdf\\'" . default))
2192 "External applications for opening `file:path' items in a document.
2193 Org-mode uses system defaults for different file types, but
2194 you can use this variable to set the application for a given file
2195 extension. The entries in this list are cons cells where the car identifies
2196 files and the cdr the corresponding command. Possible values for the
2197 file identifier are
2198 \"string\" A string as a file identifier can be interpreted in different
2199 ways, depending on its contents:
2201 - Alphanumeric characters only:
2202 Match links with this file extension.
2203 Example: (\"pdf\" . \"evince %s\")
2204 to open PDFs with evince.
2206 - Regular expression: Match links where the
2207 filename matches the regexp. If you want to
2208 use groups here, use shy groups.
2210 Example: (\"\\.x?html\\\\='\" . \"firefox %s\")
2211 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2212 to open *.html and *.xhtml with firefox.
2214 - Regular expression which contains (non-shy) groups:
2215 Match links where the whole link, including \"::\", and
2216 anything after that, matches the regexp.
2217 In a custom command string, %1, %2, etc. are replaced with
2218 the parts of the link that were matched by the groups.
2219 For backwards compatibility, if a command string is given
2220 that does not use any of the group matches, this case is
2221 handled identically to the second one (i.e. match against
2222 file name only).
2223 In a custom lisp form, you can access the group matches with
2224 (match-string n link).
2226 Example: (\"\\.pdf::\\(\\d+\\)\\\\='\" . \"evince -p %1 %s\")
2227 to open [[file:document.pdf::5]] with evince at page 5.
2229 `directory' Matches a directory
2230 `remote' Matches a remote file, accessible through tramp or efs.
2231 Remote files most likely should be visited through Emacs
2232 because external applications cannot handle such paths.
2233 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2234 so all files Emacs knows how to handle. Using this with
2235 command `emacs' will open most files in Emacs. Beware that this
2236 will also open html files inside Emacs, unless you add
2237 (\"html\" . default) to the list as well.
2238 t Default for files not matched by any of the other options.
2239 `system' The system command to open files, like `open' on Windows
2240 and Mac OS X, and mailcap under GNU/Linux. This is the command
2241 that will be selected if you call `C-c C-o' with a double
2242 \\[universal-argument] \\[universal-argument] prefix.
2244 Possible values for the command are:
2245 `emacs' The file will be visited by the current Emacs process.
2246 `default' Use the default application for this file type, which is the
2247 association for t in the list, most likely in the system-specific
2248 part.
2249 This can be used to overrule an unwanted setting in the
2250 system-specific variable.
2251 `system' Use the system command for opening files, like \"open\".
2252 This command is specified by the entry whose car is `system'.
2253 Most likely, the system-specific version of this variable
2254 does define this command, but you can overrule/replace it
2255 here.
2256 string A command to be executed by a shell; %s will be replaced
2257 by the path to the file.
2258 sexp A Lisp form which will be evaluated. The file path will
2259 be available in the Lisp variable `file'.
2260 For more examples, see the system specific constants
2261 `org-file-apps-defaults-macosx'
2262 `org-file-apps-defaults-windowsnt'
2263 `org-file-apps-defaults-gnu'."
2264 :group 'org-link-follow
2265 :type '(repeat
2266 (cons (choice :value ""
2267 (string :tag "Extension")
2268 (const :tag "System command to open files" system)
2269 (const :tag "Default for unrecognized files" t)
2270 (const :tag "Remote file" remote)
2271 (const :tag "Links to a directory" directory)
2272 (const :tag "Any files that have Emacs modes"
2273 auto-mode))
2274 (choice :value ""
2275 (const :tag "Visit with Emacs" emacs)
2276 (const :tag "Use default" default)
2277 (const :tag "Use the system command" system)
2278 (string :tag "Command")
2279 (sexp :tag "Lisp form")))))
2281 (defcustom org-doi-server-url "http://dx.doi.org/"
2282 "The URL of the DOI server."
2283 :type 'string
2284 :version "24.3"
2285 :group 'org-link-follow)
2287 (defgroup org-refile nil
2288 "Options concerning refiling entries in Org-mode."
2289 :tag "Org Refile"
2290 :group 'org)
2292 (defcustom org-directory "~/org"
2293 "Directory with org files.
2294 This is just a default location to look for Org files. There is no need
2295 at all to put your files into this directory. It is only used in the
2296 following situations:
2298 1. When a capture template specifies a target file that is not an
2299 absolute path. The path will then be interpreted relative to
2300 `org-directory'
2301 2. When a capture note is filed away in an interactive way (when exiting the
2302 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2303 with `org-directory' as the default path."
2304 :group 'org-refile
2305 :group 'org-capture
2306 :type 'directory)
2308 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2309 "Default target for storing notes.
2310 Used as a fall back file for org-capture.el, for templates that
2311 do not specify a target file."
2312 :group 'org-refile
2313 :group 'org-capture
2314 :type 'file)
2316 (defcustom org-goto-interface 'outline
2317 "The default interface to be used for `org-goto'.
2318 Allowed values are:
2319 outline The interface shows an outline of the relevant file
2320 and the correct heading is found by moving through
2321 the outline or by searching with incremental search.
2322 outline-path-completion Headlines in the current buffer are offered via
2323 completion. This is the interface also used by
2324 the refile command."
2325 :group 'org-refile
2326 :type '(choice
2327 (const :tag "Outline" outline)
2328 (const :tag "Outline-path-completion" outline-path-completion)))
2330 (defcustom org-goto-max-level 5
2331 "Maximum target level when running `org-goto' with refile interface."
2332 :group 'org-refile
2333 :type 'integer)
2335 (defcustom org-reverse-note-order nil
2336 "Non-nil means store new notes at the beginning of a file or entry.
2337 When nil, new notes will be filed to the end of a file or entry.
2338 This can also be a list with cons cells of regular expressions that
2339 are matched against file names, and values."
2340 :group 'org-capture
2341 :group 'org-refile
2342 :type '(choice
2343 (const :tag "Reverse always" t)
2344 (const :tag "Reverse never" nil)
2345 (repeat :tag "By file name regexp"
2346 (cons regexp boolean))))
2348 (defcustom org-log-refile nil
2349 "Information to record when a task is refiled.
2351 Possible values are:
2353 nil Don't add anything
2354 time Add a time stamp to the task
2355 note Prompt for a note and add it with template `org-log-note-headings'
2357 This option can also be set with on a per-file-basis with
2359 #+STARTUP: nologrefile
2360 #+STARTUP: logrefile
2361 #+STARTUP: lognoterefile
2363 You can have local logging settings for a subtree by setting the LOGGING
2364 property to one or more of these keywords.
2366 When bulk-refiling from the agenda, the value `note' is forbidden and
2367 will temporarily be changed to `time'."
2368 :group 'org-refile
2369 :group 'org-progress
2370 :version "24.1"
2371 :type '(choice
2372 (const :tag "No logging" nil)
2373 (const :tag "Record timestamp" time)
2374 (const :tag "Record timestamp with note." note)))
2376 (defcustom org-refile-targets nil
2377 "Targets for refiling entries with \\[org-refile].
2378 This is a list of cons cells. Each cell contains:
2379 - a specification of the files to be considered, either a list of files,
2380 or a symbol whose function or variable value will be used to retrieve
2381 a file name or a list of file names. If you use `org-agenda-files' for
2382 that, all agenda files will be scanned for targets. Nil means consider
2383 headings in the current buffer.
2384 - A specification of how to find candidate refile targets. This may be
2385 any of:
2386 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2387 This tag has to be present in all target headlines, inheritance will
2388 not be considered.
2389 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2390 todo keyword.
2391 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2392 headlines that are refiling targets.
2393 - a cons cell (:level . N). Any headline of level N is considered a target.
2394 Note that, when `org-odd-levels-only' is set, level corresponds to
2395 order in hierarchy, not to the number of stars.
2396 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2397 Note that, when `org-odd-levels-only' is set, level corresponds to
2398 order in hierarchy, not to the number of stars.
2400 Each element of this list generates a set of possible targets.
2401 The union of these sets is presented (with completion) to
2402 the user by `org-refile'.
2404 You can set the variable `org-refile-target-verify-function' to a function
2405 to verify each headline found by the simple criteria above.
2407 When this variable is nil, all top-level headlines in the current buffer
2408 are used, equivalent to the value `((nil . (:level . 1))'."
2409 :group 'org-refile
2410 :type '(repeat
2411 (cons
2412 (choice :value org-agenda-files
2413 (const :tag "All agenda files" org-agenda-files)
2414 (const :tag "Current buffer" nil)
2415 (function) (variable) (file))
2416 (choice :tag "Identify target headline by"
2417 (cons :tag "Specific tag" (const :value :tag) (string))
2418 (cons :tag "TODO keyword" (const :value :todo) (string))
2419 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2420 (cons :tag "Level number" (const :value :level) (integer))
2421 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2423 (defcustom org-refile-target-verify-function nil
2424 "Function to verify if the headline at point should be a refile target.
2425 The function will be called without arguments, with point at the
2426 beginning of the headline. It should return t and leave point
2427 where it is if the headline is a valid target for refiling.
2429 If the target should not be selected, the function must return nil.
2430 In addition to this, it may move point to a place from where the search
2431 should be continued. For example, the function may decide that the entire
2432 subtree of the current entry should be excluded and move point to the end
2433 of the subtree."
2434 :group 'org-refile
2435 :type '(choice
2436 (const nil)
2437 (function)))
2439 (defcustom org-refile-use-cache nil
2440 "Non-nil means cache refile targets to speed up the process.
2441 \\<org-mode-map>\
2442 The cache for a particular file will be updated automatically when
2443 the buffer has been killed, or when any of the marker used for flagging
2444 refile targets no longer points at a live buffer.
2445 If you have added new entries to a buffer that might themselves be targets,
2446 you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
2447 if you find that easier, \
2448 `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
2449 \\[org-refile]'."
2450 :group 'org-refile
2451 :version "24.1"
2452 :type 'boolean)
2454 (defcustom org-refile-use-outline-path nil
2455 "Non-nil means provide refile targets as paths.
2456 So a level 3 headline will be available as level1/level2/level3.
2458 When the value is `file', also include the file name (without directory)
2459 into the path. In this case, you can also stop the completion after
2460 the file name, to get entries inserted as top level in the file.
2462 When `full-file-path', include the full file path."
2463 :group 'org-refile
2464 :type '(choice
2465 (const :tag "Not" nil)
2466 (const :tag "Yes" t)
2467 (const :tag "Start with file name" file)
2468 (const :tag "Start with full file path" full-file-path)))
2470 (defcustom org-outline-path-complete-in-steps t
2471 "Non-nil means complete the outline path in hierarchical steps.
2472 When Org-mode uses the refile interface to select an outline path
2473 \(see variable `org-refile-use-outline-path'), the completion of
2474 the path can be done in a single go, or it can be done in steps down
2475 the headline hierarchy. Going in steps is probably the best if you
2476 do not use a special completion package like `ido' or `icicles'.
2477 However, when using these packages, going in one step can be very
2478 fast, while still showing the whole path to the entry."
2479 :group 'org-refile
2480 :type 'boolean)
2482 (defcustom org-refile-allow-creating-parent-nodes nil
2483 "Non-nil means allow to create new nodes as refile targets.
2484 New nodes are then created by adding \"/new node name\" to the completion
2485 of an existing node. When the value of this variable is `confirm',
2486 new node creation must be confirmed by the user (recommended).
2487 When nil, the completion must match an existing entry.
2489 Note that, if the new heading is not seen by the criteria
2490 listed in `org-refile-targets', multiple instances of the same
2491 heading would be created by trying again to file under the new
2492 heading."
2493 :group 'org-refile
2494 :type '(choice
2495 (const :tag "Never" nil)
2496 (const :tag "Always" t)
2497 (const :tag "Prompt for confirmation" confirm)))
2499 (defcustom org-refile-active-region-within-subtree nil
2500 "Non-nil means also refile active region within a subtree.
2502 By default `org-refile' doesn't allow refiling regions if they
2503 don't contain a set of subtrees, but it might be convenient to
2504 do so sometimes: in that case, the first line of the region is
2505 converted to a headline before refiling."
2506 :group 'org-refile
2507 :version "24.1"
2508 :type 'boolean)
2510 (defgroup org-todo nil
2511 "Options concerning TODO items in Org-mode."
2512 :tag "Org TODO"
2513 :group 'org)
2515 (defgroup org-progress nil
2516 "Options concerning Progress logging in Org-mode."
2517 :tag "Org Progress"
2518 :group 'org-time)
2520 (defvar org-todo-interpretation-widgets
2521 '((:tag "Sequence (cycling hits every state)" sequence)
2522 (:tag "Type (cycling directly to DONE)" type))
2523 "The available interpretation symbols for customizing `org-todo-keywords'.
2524 Interested libraries should add to this list.")
2526 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2527 "List of TODO entry keyword sequences and their interpretation.
2528 \\<org-mode-map>This is a list of sequences.
2530 Each sequence starts with a symbol, either `sequence' or `type',
2531 indicating if the keywords should be interpreted as a sequence of
2532 action steps, or as different types of TODO items. The first
2533 keywords are states requiring action - these states will select a headline
2534 for inclusion into the global TODO list Org-mode produces. If one of
2535 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2536 signify that no further action is necessary. If \"|\" is not found,
2537 the last keyword is treated as the only DONE state of the sequence.
2539 The command \\[org-todo] cycles an entry through these states, and one
2540 additional state where no keyword is present. For details about this
2541 cycling, see the manual.
2543 TODO keywords and interpretation can also be set on a per-file basis with
2544 the special #+SEQ_TODO and #+TYP_TODO lines.
2546 Each keyword can optionally specify a character for fast state selection
2547 \(in combination with the variable `org-use-fast-todo-selection')
2548 and specifiers for state change logging, using the same syntax that
2549 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2550 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2551 indicates to record a time stamp each time this state is selected.
2553 Each keyword may also specify if a timestamp or a note should be
2554 recorded when entering or leaving the state, by adding additional
2555 characters in the parenthesis after the keyword. This looks like this:
2556 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2557 record only the time of the state change. With X and Y being either
2558 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2559 Y when leaving the state if and only if the *target* state does not
2560 define X. You may omit any of the fast-selection key or X or /Y,
2561 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2563 For backward compatibility, this variable may also be just a list
2564 of keywords. In this case the interpretation (sequence or type) will be
2565 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2566 :group 'org-todo
2567 :group 'org-keywords
2568 :type '(choice
2569 (repeat :tag "Old syntax, just keywords"
2570 (string :tag "Keyword"))
2571 (repeat :tag "New syntax"
2572 (cons
2573 (choice
2574 :tag "Interpretation"
2575 ;;Quick and dirty way to see
2576 ;;`org-todo-interpretations'. This takes the
2577 ;;place of item arguments
2578 :convert-widget
2579 (lambda (widget)
2580 (widget-put widget
2581 :args (mapcar
2582 (lambda (x)
2583 (widget-convert
2584 (cons 'const x)))
2585 org-todo-interpretation-widgets))
2586 widget))
2587 (repeat
2588 (string :tag "Keyword"))))))
2590 (defvar-local org-todo-keywords-1 nil
2591 "All TODO and DONE keywords active in a buffer.")
2592 (defvar org-todo-keywords-for-agenda nil)
2593 (defvar org-done-keywords-for-agenda nil)
2594 (defvar org-todo-keyword-alist-for-agenda nil)
2595 (defvar org-tag-alist-for-agenda nil
2596 "Alist of all tags from all agenda files.")
2597 (defvar org-tag-groups-alist-for-agenda nil
2598 "Alist of all groups tags from all current agenda files.")
2599 (defvar-local org-tag-groups-alist nil)
2600 (defvar org-agenda-contributing-files nil)
2601 (defvar-local org-not-done-keywords nil)
2602 (defvar-local org-done-keywords nil)
2603 (defvar-local org-todo-heads nil)
2604 (defvar-local org-todo-sets nil)
2605 (defvar-local org-todo-log-states nil)
2606 (defvar-local org-todo-kwd-alist nil)
2607 (defvar-local org-todo-key-alist nil)
2608 (defvar-local org-todo-key-trigger nil)
2610 (defcustom org-todo-interpretation 'sequence
2611 "Controls how TODO keywords are interpreted.
2612 This variable is in principle obsolete and is only used for
2613 backward compatibility, if the interpretation of todo keywords is
2614 not given already in `org-todo-keywords'. See that variable for
2615 more information."
2616 :group 'org-todo
2617 :group 'org-keywords
2618 :type '(choice (const sequence)
2619 (const type)))
2621 (defcustom org-use-fast-todo-selection t
2622 "\\<org-mode-map>\
2623 Non-nil means use the fast todo selection scheme with \\[org-todo].
2624 This variable describes if and under what circumstances the cycling
2625 mechanism for TODO keywords will be replaced by a single-key, direct
2626 selection scheme.
2628 When nil, fast selection is never used.
2630 When the symbol `prefix', it will be used when `org-todo' is called
2631 with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
2632 in an Org-mode buffer, and
2633 `\\[universal-argument] t' in an agenda buffer.
2635 When t, fast selection is used by default. In this case, the prefix
2636 argument forces cycling instead.
2638 In all cases, the special interface is only used if access keys have
2639 actually been assigned by the user, i.e. if keywords in the configuration
2640 are followed by a letter in parenthesis, like TODO(t)."
2641 :group 'org-todo
2642 :type '(choice
2643 (const :tag "Never" nil)
2644 (const :tag "By default" t)
2645 (const :tag "Only with C-u C-c C-t" prefix)))
2647 (defcustom org-provide-todo-statistics t
2648 "Non-nil means update todo statistics after insert and toggle.
2649 ALL-HEADLINES means update todo statistics by including headlines
2650 with no TODO keyword as well, counting them as not done.
2651 A list of TODO keywords means the same, but skip keywords that are
2652 not in this list.
2653 When set to a list of two lists, the first list contains keywords
2654 to consider as TODO keywords, the second list contains keywords
2655 to consider as DONE keywords.
2657 When this is set, todo statistics is updated in the parent of the
2658 current entry each time a todo state is changed."
2659 :group 'org-todo
2660 :type '(choice
2661 (const :tag "Yes, only for TODO entries" t)
2662 (const :tag "Yes, including all entries" all-headlines)
2663 (repeat :tag "Yes, for TODOs in this list"
2664 (string :tag "TODO keyword"))
2665 (list :tag "Yes, for TODOs and DONEs in these lists"
2666 (repeat (string :tag "TODO keyword"))
2667 (repeat (string :tag "DONE keyword")))
2668 (other :tag "No TODO statistics" nil)))
2670 (defcustom org-hierarchical-todo-statistics t
2671 "Non-nil means TODO statistics covers just direct children.
2672 When nil, all entries in the subtree are considered.
2673 This has only an effect if `org-provide-todo-statistics' is set.
2674 To set this to nil for only a single subtree, use a COOKIE_DATA
2675 property and include the word \"recursive\" into the value."
2676 :group 'org-todo
2677 :type 'boolean)
2679 (defcustom org-after-todo-state-change-hook nil
2680 "Hook which is run after the state of a TODO item was changed.
2681 The new state (a string with a TODO keyword, or nil) is available in the
2682 Lisp variable `org-state'."
2683 :group 'org-todo
2684 :type 'hook)
2686 (defvar org-blocker-hook nil
2687 "Hook for functions that are allowed to block a state change.
2689 Functions in this hook should not modify the buffer.
2690 Each function gets as its single argument a property list,
2691 see `org-trigger-hook' for more information about this list.
2693 If any of the functions in this hook returns nil, the state change
2694 is blocked.")
2696 (defvar org-trigger-hook nil
2697 "Hook for functions that are triggered by a state change.
2699 Each function gets as its single argument a property list with at
2700 least the following elements:
2702 (:type type-of-change :position pos-at-entry-start
2703 :from old-state :to new-state)
2705 Depending on the type, more properties may be present.
2707 This mechanism is currently implemented for:
2709 TODO state changes
2710 ------------------
2711 :type todo-state-change
2712 :from previous state (keyword as a string), or nil, or a symbol
2713 `todo' or `done', to indicate the general type of state.
2714 :to new state, like in :from")
2716 (defcustom org-enforce-todo-dependencies nil
2717 "Non-nil means undone TODO entries will block switching the parent to DONE.
2718 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2719 be blocked if any prior sibling is not yet done.
2720 Finally, if the parent is blocked because of ordered siblings of its own,
2721 the child will also be blocked."
2722 :set (lambda (var val)
2723 (set var val)
2724 (if val
2725 (add-hook 'org-blocker-hook
2726 'org-block-todo-from-children-or-siblings-or-parent)
2727 (remove-hook 'org-blocker-hook
2728 'org-block-todo-from-children-or-siblings-or-parent)))
2729 :group 'org-todo
2730 :type 'boolean)
2732 (defcustom org-enforce-todo-checkbox-dependencies nil
2733 "Non-nil means unchecked boxes will block switching the parent to DONE.
2734 When this is nil, checkboxes have no influence on switching TODO states.
2735 When non-nil, you first need to check off all check boxes before the TODO
2736 entry can be switched to DONE.
2737 This variable needs to be set before org.el is loaded, and you need to
2738 restart Emacs after a change to make the change effective. The only way
2739 to change is while Emacs is running is through the customize interface."
2740 :set (lambda (var val)
2741 (set var val)
2742 (if val
2743 (add-hook 'org-blocker-hook
2744 'org-block-todo-from-checkboxes)
2745 (remove-hook 'org-blocker-hook
2746 'org-block-todo-from-checkboxes)))
2747 :group 'org-todo
2748 :type 'boolean)
2750 (defcustom org-treat-insert-todo-heading-as-state-change nil
2751 "Non-nil means inserting a TODO heading is treated as state change.
2752 So when the command \\[org-insert-todo-heading] is used, state change
2753 logging will apply if appropriate. When nil, the new TODO item will
2754 be inserted directly, and no logging will take place."
2755 :group 'org-todo
2756 :type 'boolean)
2758 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2759 "Non-nil means switching TODO states with S-cursor counts as state change.
2760 This is the default behavior. However, setting this to nil allows a
2761 convenient way to select a TODO state and bypass any logging associated
2762 with that."
2763 :group 'org-todo
2764 :type 'boolean)
2766 (defcustom org-todo-state-tags-triggers nil
2767 "Tag changes that should be triggered by TODO state changes.
2768 This is a list. Each entry is
2770 (state-change (tag . flag) .......)
2772 State-change can be a string with a state, and empty string to indicate the
2773 state that has no TODO keyword, or it can be one of the symbols `todo'
2774 or `done', meaning any not-done or done state, respectively."
2775 :group 'org-todo
2776 :group 'org-tags
2777 :type '(repeat
2778 (cons (choice :tag "When changing to"
2779 (const :tag "Not-done state" todo)
2780 (const :tag "Done state" done)
2781 (string :tag "State"))
2782 (repeat
2783 (cons :tag "Tag action"
2784 (string :tag "Tag")
2785 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2787 (defcustom org-log-done nil
2788 "Information to record when a task moves to the DONE state.
2790 Possible values are:
2792 nil Don't add anything, just change the keyword
2793 time Add a time stamp to the task
2794 note Prompt for a note and add it with template `org-log-note-headings'
2796 This option can also be set with on a per-file-basis with
2798 #+STARTUP: nologdone
2799 #+STARTUP: logdone
2800 #+STARTUP: lognotedone
2802 You can have local logging settings for a subtree by setting the LOGGING
2803 property to one or more of these keywords."
2804 :group 'org-todo
2805 :group 'org-progress
2806 :type '(choice
2807 (const :tag "No logging" nil)
2808 (const :tag "Record CLOSED timestamp" time)
2809 (const :tag "Record CLOSED timestamp with note." note)))
2811 ;; Normalize old uses of org-log-done.
2812 (cond
2813 ((eq org-log-done t) (setq org-log-done 'time))
2814 ((and (listp org-log-done) (memq 'done org-log-done))
2815 (setq org-log-done 'note)))
2817 (defcustom org-log-reschedule nil
2818 "Information to record when the scheduling date of a tasks is modified.
2820 Possible values are:
2822 nil Don't add anything, just change the date
2823 time Add a time stamp to the task
2824 note Prompt for a note and add it with template `org-log-note-headings'
2826 This option can also be set with on a per-file-basis with
2828 #+STARTUP: nologreschedule
2829 #+STARTUP: logreschedule
2830 #+STARTUP: lognotereschedule"
2831 :group 'org-todo
2832 :group 'org-progress
2833 :type '(choice
2834 (const :tag "No logging" nil)
2835 (const :tag "Record timestamp" time)
2836 (const :tag "Record timestamp with note." note)))
2838 (defcustom org-log-redeadline nil
2839 "Information to record when the deadline date of a tasks is modified.
2841 Possible values are:
2843 nil Don't add anything, just change the date
2844 time Add a time stamp to the task
2845 note Prompt for a note and add it with template `org-log-note-headings'
2847 This option can also be set with on a per-file-basis with
2849 #+STARTUP: nologredeadline
2850 #+STARTUP: logredeadline
2851 #+STARTUP: lognoteredeadline
2853 You can have local logging settings for a subtree by setting the LOGGING
2854 property to one or more of these keywords."
2855 :group 'org-todo
2856 :group 'org-progress
2857 :type '(choice
2858 (const :tag "No logging" nil)
2859 (const :tag "Record timestamp" time)
2860 (const :tag "Record timestamp with note." note)))
2862 (defcustom org-log-note-clock-out nil
2863 "Non-nil means record a note when clocking out of an item.
2864 This can also be configured on a per-file basis by adding one of
2865 the following lines anywhere in the buffer:
2867 #+STARTUP: lognoteclock-out
2868 #+STARTUP: nolognoteclock-out"
2869 :group 'org-todo
2870 :group 'org-progress
2871 :type 'boolean)
2873 (defcustom org-log-done-with-time t
2874 "Non-nil means the CLOSED time stamp will contain date and time.
2875 When nil, only the date will be recorded."
2876 :group 'org-progress
2877 :type 'boolean)
2879 (defcustom org-log-note-headings
2880 '((done . "CLOSING NOTE %t")
2881 (state . "State %-12s from %-12S %t")
2882 (note . "Note taken on %t")
2883 (reschedule . "Rescheduled from %S on %t")
2884 (delschedule . "Not scheduled, was %S on %t")
2885 (redeadline . "New deadline from %S on %t")
2886 (deldeadline . "Removed deadline, was %S on %t")
2887 (refile . "Refiled on %t")
2888 (clock-out . ""))
2889 "Headings for notes added to entries.
2891 The value is an alist, with the car being a symbol indicating the
2892 note context, and the cdr is the heading to be used. The heading
2893 may also be the empty string. The following placeholders can be
2894 used:
2896 %t a time stamp.
2897 %T an active time stamp instead the default inactive one
2898 %d a short-format time stamp.
2899 %D an active short-format time stamp.
2900 %s the new TODO state or time stamp (inactive), in double quotes.
2901 %S the old TODO state or time stamp (inactive), in double quotes.
2902 %u the user name.
2903 %U full user name.
2905 In fact, it is not a good idea to change the `state' entry,
2906 because Agenda Log mode depends on the format of these entries."
2907 :group 'org-todo
2908 :group 'org-progress
2909 :type '(list :greedy t
2910 (cons (const :tag "Heading when closing an item" done) string)
2911 (cons (const :tag
2912 "Heading when changing todo state (todo sequence only)"
2913 state) string)
2914 (cons (const :tag "Heading when just taking a note" note) string)
2915 (cons (const :tag "Heading when rescheduling" reschedule) string)
2916 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2917 (cons (const :tag "Heading when changing deadline" redeadline) string)
2918 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2919 (cons (const :tag "Heading when refiling" refile) string)
2920 (cons (const :tag "Heading when clocking out" clock-out) string)))
2922 (unless (assq 'note org-log-note-headings)
2923 (push '(note . "%t") org-log-note-headings))
2925 (defcustom org-log-into-drawer nil
2926 "Non-nil means insert state change notes and time stamps into a drawer.
2927 When nil, state changes notes will be inserted after the headline and
2928 any scheduling and clock lines, but not inside a drawer.
2930 The value of this variable should be the name of the drawer to use.
2931 LOGBOOK is proposed as the default drawer for this purpose, you can
2932 also set this to a string to define the drawer of your choice.
2934 A value of t is also allowed, representing \"LOGBOOK\".
2936 A value of t or nil can also be set with on a per-file-basis with
2938 #+STARTUP: logdrawer
2939 #+STARTUP: nologdrawer
2941 If this variable is set, `org-log-state-notes-insert-after-drawers'
2942 will be ignored.
2944 You can set the property LOG_INTO_DRAWER to overrule this setting for
2945 a subtree.
2947 Do not check directly this variable in a Lisp program. Call
2948 function `org-log-into-drawer' instead."
2949 :group 'org-todo
2950 :group 'org-progress
2951 :type '(choice
2952 (const :tag "Not into a drawer" nil)
2953 (const :tag "LOGBOOK" t)
2954 (string :tag "Other")))
2956 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2958 (defun org-log-into-drawer ()
2959 "Name of the log drawer, as a string, or nil.
2960 This is the value of `org-log-into-drawer'. However, if the
2961 current entry has or inherits a LOG_INTO_DRAWER property, it will
2962 be used instead of the default value."
2963 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2964 (cond ((equal p "nil") nil)
2965 ((equal p "t") "LOGBOOK")
2966 ((stringp p) p)
2967 (p "LOGBOOK")
2968 ((stringp org-log-into-drawer) org-log-into-drawer)
2969 (org-log-into-drawer "LOGBOOK"))))
2971 (defcustom org-log-state-notes-insert-after-drawers nil
2972 "Non-nil means insert state change notes after any drawers in entry.
2973 Only the drawers that *immediately* follow the headline and the
2974 deadline/scheduled line are skipped.
2975 When nil, insert notes right after the heading and perhaps the line
2976 with deadline/scheduling if present.
2978 This variable will have no effect if `org-log-into-drawer' is
2979 set."
2980 :group 'org-todo
2981 :group 'org-progress
2982 :type 'boolean)
2984 (defcustom org-log-states-order-reversed t
2985 "Non-nil means the latest state note will be directly after heading.
2986 When nil, the state change notes will be ordered according to time.
2988 This option can also be set with on a per-file-basis with
2990 #+STARTUP: logstatesreversed
2991 #+STARTUP: nologstatesreversed"
2992 :group 'org-todo
2993 :group 'org-progress
2994 :type 'boolean)
2996 (defcustom org-todo-repeat-to-state nil
2997 "The TODO state to which a repeater should return the repeating task.
2998 By default this is the first task in a TODO sequence, or the previous state
2999 in a TODO_TYP set. But you can specify another task here.
3000 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3001 :group 'org-todo
3002 :version "24.1"
3003 :type '(choice (const :tag "Head of sequence" nil)
3004 (string :tag "Specific state")))
3006 (defcustom org-log-repeat 'time
3007 "Non-nil means record moving through the DONE state when triggering repeat.
3008 An auto-repeating task is immediately switched back to TODO when
3009 marked DONE. If you are not logging state changes (by adding \"@\"
3010 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3011 record a closing note, there will be no record of the task moving
3012 through DONE. This variable forces taking a note anyway.
3014 nil Don't force a record
3015 time Record a time stamp
3016 note Prompt for a note and add it with template `org-log-note-headings'
3018 This option can also be set with on a per-file-basis with
3020 #+STARTUP: nologrepeat
3021 #+STARTUP: logrepeat
3022 #+STARTUP: lognoterepeat
3024 You can have local logging settings for a subtree by setting the LOGGING
3025 property to one or more of these keywords."
3026 :group 'org-todo
3027 :group 'org-progress
3028 :type '(choice
3029 (const :tag "Don't force a record" nil)
3030 (const :tag "Force recording the DONE state" time)
3031 (const :tag "Force recording a note with the DONE state" note)))
3034 (defgroup org-priorities nil
3035 "Priorities in Org-mode."
3036 :tag "Org Priorities"
3037 :group 'org-todo)
3039 (defcustom org-enable-priority-commands t
3040 "Non-nil means priority commands are active.
3041 When nil, these commands will be disabled, so that you never accidentally
3042 set a priority."
3043 :group 'org-priorities
3044 :type 'boolean)
3046 (defcustom org-highest-priority ?A
3047 "The highest priority of TODO items. A character like ?A, ?B etc.
3048 Must have a smaller ASCII number than `org-lowest-priority'."
3049 :group 'org-priorities
3050 :type 'character)
3052 (defcustom org-lowest-priority ?C
3053 "The lowest priority of TODO items. A character like ?A, ?B etc.
3054 Must have a larger ASCII number than `org-highest-priority'."
3055 :group 'org-priorities
3056 :type 'character)
3058 (defcustom org-default-priority ?B
3059 "The default priority of TODO items.
3060 This is the priority an item gets if no explicit priority is given.
3061 When starting to cycle on an empty priority the first step in the cycle
3062 depends on `org-priority-start-cycle-with-default'. The resulting first
3063 step priority must not exceed the range from `org-highest-priority' to
3064 `org-lowest-priority' which means that `org-default-priority' has to be
3065 in this range exclusive or inclusive the range boundaries. Else the
3066 first step refuses to set the default and the second will fall back
3067 to (depending on the command used) the highest or lowest priority."
3068 :group 'org-priorities
3069 :type 'character)
3071 (defcustom org-priority-start-cycle-with-default t
3072 "Non-nil means start with default priority when starting to cycle.
3073 When this is nil, the first step in the cycle will be (depending on the
3074 command used) one higher or lower than the default priority.
3075 See also `org-default-priority'."
3076 :group 'org-priorities
3077 :type 'boolean)
3079 (defcustom org-get-priority-function nil
3080 "Function to extract the priority from a string.
3081 The string is normally the headline. If this is nil Org computes the
3082 priority from the priority cookie like [#A] in the headline. It returns
3083 an integer, increasing by 1000 for each priority level.
3084 The user can set a different function here, which should take a string
3085 as an argument and return the numeric priority."
3086 :group 'org-priorities
3087 :version "24.1"
3088 :type '(choice
3089 (const nil)
3090 (function)))
3092 (defgroup org-time nil
3093 "Options concerning time stamps and deadlines in Org-mode."
3094 :tag "Org Time"
3095 :group 'org)
3097 (defcustom org-time-stamp-rounding-minutes '(0 5)
3098 "Number of minutes to round time stamps to.
3099 \\<org-mode-map>\
3100 These are two values, the first applies when first creating a time stamp.
3101 The second applies when changing it with the commands `S-up' and `S-down'.
3102 When changing the time stamp, this means that it will change in steps
3103 of N minutes, as given by the second value.
3105 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3106 numbers should be factors of 60, so for example 5, 10, 15.
3108 When this is larger than 1, you can still force an exact time stamp by using
3109 a double prefix argument to a time stamp command like \
3110 `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
3111 and by using a prefix arg to `S-up/down' to specify the exact number
3112 of minutes to shift."
3113 :group 'org-time
3114 :get (lambda (var) ; Make sure both elements are there
3115 (if (integerp (default-value var))
3116 (list (default-value var) 5)
3117 (default-value var)))
3118 :type '(list
3119 (integer :tag "when inserting times")
3120 (integer :tag "when modifying times")))
3122 ;; Normalize old customizations of this variable.
3123 (when (integerp org-time-stamp-rounding-minutes)
3124 (setq org-time-stamp-rounding-minutes
3125 (list org-time-stamp-rounding-minutes
3126 org-time-stamp-rounding-minutes)))
3128 (defcustom org-display-custom-times nil
3129 "Non-nil means overlay custom formats over all time stamps.
3130 The formats are defined through the variable `org-time-stamp-custom-formats'.
3131 To turn this on on a per-file basis, insert anywhere in the file:
3132 #+STARTUP: customtime"
3133 :group 'org-time
3134 :set 'set-default
3135 :type 'sexp)
3136 (make-variable-buffer-local 'org-display-custom-times)
3138 (defcustom org-time-stamp-custom-formats
3139 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3140 "Custom formats for time stamps. See `format-time-string' for the syntax.
3141 These are overlaid over the default ISO format if the variable
3142 `org-display-custom-times' is set. Time like %H:%M should be at the
3143 end of the second format. The custom formats are also honored by export
3144 commands, if custom time display is turned on at the time of export."
3145 :group 'org-time
3146 :type 'sexp)
3148 (defun org-time-stamp-format (&optional long inactive)
3149 "Get the right format for a time string."
3150 (let ((f (if long (cdr org-time-stamp-formats)
3151 (car org-time-stamp-formats))))
3152 (if inactive
3153 (concat "[" (substring f 1 -1) "]")
3154 f)))
3156 (defcustom org-time-clocksum-format
3157 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3158 "The format string used when creating CLOCKSUM lines.
3159 This is also used when Org mode generates a time duration.
3161 The value can be a single format string containing two
3162 %-sequences, which will be filled with the number of hours and
3163 minutes in that order.
3165 Alternatively, the value can be a plist associating any of the
3166 keys :years, :months, :weeks, :days, :hours or :minutes with
3167 format strings. The time duration is formatted using only the
3168 time components that are needed and concatenating the results.
3169 If a time unit in absent, it falls back to the next smallest
3170 unit.
3172 The keys :require-years, :require-months, :require-days,
3173 :require-weeks, :require-hours, :require-minutes are also
3174 meaningful. A non-nil value for these keys indicates that the
3175 corresponding time component should always be included, even if
3176 its value is 0.
3179 For example,
3181 (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3182 :require-minutes t)
3184 means durations longer than a day will be expressed in days,
3185 hours and minutes, and durations less than a day will always be
3186 expressed in hours and minutes (even for durations less than an
3187 hour).
3189 The value
3191 (:days \"%dd\" :minutes \"%dm\")
3193 means durations longer than a day will be expressed in days and
3194 minutes, and durations less than a day will be expressed entirely
3195 in minutes (even for durations longer than an hour)."
3196 :group 'org-time
3197 :group 'org-clock
3198 :version "24.4"
3199 :package-version '(Org . "8.0")
3200 :type '(choice (string :tag "Format string")
3201 (set :tag "Plist"
3202 (group :inline t (const :tag "Years" :years)
3203 (string :tag "Format string"))
3204 (group :inline t
3205 (const :tag "Always show years" :require-years)
3206 (const t))
3207 (group :inline t (const :tag "Months" :months)
3208 (string :tag "Format string"))
3209 (group :inline t
3210 (const :tag "Always show months" :require-months)
3211 (const t))
3212 (group :inline t (const :tag "Weeks" :weeks)
3213 (string :tag "Format string"))
3214 (group :inline t
3215 (const :tag "Always show weeks" :require-weeks)
3216 (const t))
3217 (group :inline t (const :tag "Days" :days)
3218 (string :tag "Format string"))
3219 (group :inline t
3220 (const :tag "Always show days" :require-days)
3221 (const t))
3222 (group :inline t (const :tag "Hours" :hours)
3223 (string :tag "Format string"))
3224 (group :inline t
3225 (const :tag "Always show hours" :require-hours)
3226 (const t))
3227 (group :inline t (const :tag "Minutes" :minutes)
3228 (string :tag "Format string"))
3229 (group :inline t
3230 (const :tag "Always show minutes" :require-minutes)
3231 (const t)))))
3233 (defcustom org-time-clocksum-use-fractional nil
3234 "When non-nil, \\[org-clock-display] uses fractional times.
3235 See `org-time-clocksum-format' for more on time clock formats."
3236 :group 'org-time
3237 :group 'org-clock
3238 :version "24.3"
3239 :type 'boolean)
3241 (defcustom org-time-clocksum-use-effort-durations nil
3242 "When non-nil, \\[org-clock-display] uses effort durations.
3243 E.g. by default, one day is considered to be a 8 hours effort,
3244 so a task that has been clocked for 16 hours will be displayed
3245 as during 2 days in the clock display or in the clocktable.
3247 See `org-effort-durations' on how to set effort durations
3248 and `org-time-clocksum-format' for more on time clock formats."
3249 :group 'org-time
3250 :group 'org-clock
3251 :version "24.4"
3252 :package-version '(Org . "8.0")
3253 :type 'boolean)
3255 (defcustom org-time-clocksum-fractional-format "%.2f"
3256 "The format string used when creating CLOCKSUM lines,
3257 or when Org mode generates a time duration, if
3258 `org-time-clocksum-use-fractional' is enabled.
3260 The value can be a single format string containing one
3261 %-sequence, which will be filled with the number of hours as
3262 a float.
3264 Alternatively, the value can be a plist associating any of the
3265 keys :years, :months, :weeks, :days, :hours or :minutes with
3266 a format string. The time duration is formatted using the
3267 largest time unit which gives a non-zero integer part. If all
3268 specified formats have zero integer part, the smallest time unit
3269 is used."
3270 :group 'org-time
3271 :type '(choice (string :tag "Format string")
3272 (set (group :inline t (const :tag "Years" :years)
3273 (string :tag "Format string"))
3274 (group :inline t (const :tag "Months" :months)
3275 (string :tag "Format string"))
3276 (group :inline t (const :tag "Weeks" :weeks)
3277 (string :tag "Format string"))
3278 (group :inline t (const :tag "Days" :days)
3279 (string :tag "Format string"))
3280 (group :inline t (const :tag "Hours" :hours)
3281 (string :tag "Format string"))
3282 (group :inline t (const :tag "Minutes" :minutes)
3283 (string :tag "Format string")))))
3285 (defcustom org-deadline-warning-days 14
3286 "Number of days before expiration during which a deadline becomes active.
3287 This variable governs the display in sparse trees and in the agenda.
3288 When 0 or negative, it means use this number (the absolute value of it)
3289 even if a deadline has a different individual lead time specified.
3291 Custom commands can set this variable in the options section."
3292 :group 'org-time
3293 :group 'org-agenda-daily/weekly
3294 :type 'integer)
3296 (defcustom org-scheduled-delay-days 0
3297 "Number of days before a scheduled item becomes active.
3298 This variable governs the display in sparse trees and in the agenda.
3299 The default value (i.e. 0) means: don't delay scheduled item.
3300 When negative, it means use this number (the absolute value of it)
3301 even if a scheduled item has a different individual delay time
3302 specified.
3304 Custom commands can set this variable in the options section."
3305 :group 'org-time
3306 :group 'org-agenda-daily/weekly
3307 :version "24.4"
3308 :package-version '(Org . "8.0")
3309 :type 'integer)
3311 (defcustom org-read-date-prefer-future t
3312 "Non-nil means assume future for incomplete date input from user.
3313 This affects the following situations:
3314 1. The user gives a month but not a year.
3315 For example, if it is April and you enter \"feb 2\", this will be read
3316 as Feb 2, *next* year. \"May 5\", however, will be this year.
3317 2. The user gives a day, but no month.
3318 For example, if today is the 15th, and you enter \"3\", Org-mode will
3319 read this as the third of *next* month. However, if you enter \"17\",
3320 it will be considered as *this* month.
3322 If you set this variable to the symbol `time', then also the following
3323 will work:
3325 3. If the user gives a time.
3326 If the time is before now, it will be interpreted as tomorrow.
3328 Currently none of this works for ISO week specifications.
3330 When this option is nil, the current day, month and year will always be
3331 used as defaults.
3333 See also `org-agenda-jump-prefer-future'."
3334 :group 'org-time
3335 :type '(choice
3336 (const :tag "Never" nil)
3337 (const :tag "Check month and day" t)
3338 (const :tag "Check month, day, and time" time)))
3340 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3341 "Should the agenda jump command prefer the future for incomplete dates?
3342 The default is to do the same as configured in `org-read-date-prefer-future'.
3343 But you can also set a deviating value here.
3344 This may t or nil, or the symbol `org-read-date-prefer-future'."
3345 :group 'org-agenda
3346 :group 'org-time
3347 :version "24.1"
3348 :type '(choice
3349 (const :tag "Use org-read-date-prefer-future"
3350 org-read-date-prefer-future)
3351 (const :tag "Never" nil)
3352 (const :tag "Always" t)))
3354 (defcustom org-read-date-force-compatible-dates t
3355 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3357 Depending on the system Emacs is running on, certain dates cannot
3358 be represented with the type used internally to represent time.
3359 Dates between 1970-1-1 and 2038-1-1 can always be represented
3360 correctly. Some systems allow for earlier dates, some for later,
3361 some for both. One way to find out it to insert any date into an
3362 Org buffer, putting the cursor on the year and hitting S-up and
3363 S-down to test the range.
3365 When this variable is set to t, the date/time prompt will not let
3366 you specify dates outside the 1970-2037 range, so it is certain that
3367 these dates will work in whatever version of Emacs you are
3368 running, and also that you can move a file from one Emacs implementation
3369 to another. WHenever Org is forcing the year for you, it will display
3370 a message and beep.
3372 When this variable is nil, Org will check if the date is
3373 representable in the specific Emacs implementation you are using.
3374 If not, it will force a year, usually the current year, and beep
3375 to remind you. Currently this setting is not recommended because
3376 the likelihood that you will open your Org files in an Emacs that
3377 has limited date range is not negligible.
3379 A workaround for this problem is to use diary sexp dates for time
3380 stamps outside of this range."
3381 :group 'org-time
3382 :version "24.1"
3383 :type 'boolean)
3385 (defcustom org-read-date-display-live t
3386 "Non-nil means display current interpretation of date prompt live.
3387 This display will be in an overlay, in the minibuffer."
3388 :group 'org-time
3389 :type 'boolean)
3391 (defcustom org-read-date-popup-calendar t
3392 "Non-nil means pop up a calendar when prompting for a date.
3393 In the calendar, the date can be selected with mouse-1. However, the
3394 minibuffer will also be active, and you can simply enter the date as well.
3395 When nil, only the minibuffer will be available."
3396 :group 'org-time
3397 :type 'boolean)
3398 (org-defvaralias 'org-popup-calendar-for-date-prompt
3399 'org-read-date-popup-calendar)
3401 (make-obsolete-variable
3402 'org-read-date-minibuffer-setup-hook
3403 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3404 (defcustom org-read-date-minibuffer-setup-hook nil
3405 "Hook to be used to set up keys for the date/time interface.
3406 Add key definitions to `minibuffer-local-map', which will be a
3407 temporary copy.
3409 WARNING: This option is obsolete, you should use
3410 `org-read-date-minibuffer-local-map' to set up keys."
3411 :group 'org-time
3412 :type 'hook)
3414 (defcustom org-extend-today-until 0
3415 "The hour when your day really ends. Must be an integer.
3416 This has influence for the following applications:
3417 - When switching the agenda to \"today\". It it is still earlier than
3418 the time given here, the day recognized as TODAY is actually yesterday.
3419 - When a date is read from the user and it is still before the time given
3420 here, the current date and time will be assumed to be yesterday, 23:59.
3421 Also, timestamps inserted in capture templates follow this rule.
3423 IMPORTANT: This is a feature whose implementation is and likely will
3424 remain incomplete. Really, it is only here because past midnight seems to
3425 be the favorite working time of John Wiegley :-)"
3426 :group 'org-time
3427 :type 'integer)
3429 (defcustom org-use-effective-time nil
3430 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3431 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3432 \"effective time\" of any timestamps between midnight and 8am will be
3433 23:59 of the previous day."
3434 :group 'org-time
3435 :version "24.1"
3436 :type 'boolean)
3438 (defcustom org-use-last-clock-out-time-as-effective-time nil
3439 "When non-nil, use the last clock out time for `org-todo'.
3440 Note that this option has precedence over the combined use of
3441 `org-use-effective-time' and `org-extend-today-until'."
3442 :group 'org-time
3443 :version "24.4"
3444 :package-version '(Org . "8.0")
3445 :type 'boolean)
3447 (defcustom org-edit-timestamp-down-means-later nil
3448 "Non-nil means S-down will increase the time in a time stamp.
3449 When nil, S-up will increase."
3450 :group 'org-time
3451 :type 'boolean)
3453 (defcustom org-calendar-follow-timestamp-change t
3454 "Non-nil means make the calendar window follow timestamp changes.
3455 When a timestamp is modified and the calendar window is visible, it will be
3456 moved to the new date."
3457 :group 'org-time
3458 :type 'boolean)
3460 (defgroup org-tags nil
3461 "Options concerning tags in Org-mode."
3462 :tag "Org Tags"
3463 :group 'org)
3465 (defcustom org-tag-alist nil
3466 "List of tags allowed in Org-mode files.
3467 When this list is nil, Org-mode will base TAG input on what is already in the
3468 buffer.
3469 The value of this variable is an alist, the car of each entry must be a
3470 keyword as a string, the cdr may be a character that is used to select
3471 that tag through the fast-tag-selection interface.
3472 See the manual for details."
3473 :group 'org-tags
3474 :type '(repeat
3475 (choice
3476 (cons (string :tag "Tag name")
3477 (character :tag "Access char"))
3478 (list :tag "Start radio group"
3479 (const :startgroup)
3480 (option (string :tag "Group description")))
3481 (list :tag "Start tag group, non distinct"
3482 (const :startgrouptag)
3483 (option (string :tag "Group description")))
3484 (list :tag "Group tags delimiter"
3485 (const :grouptags))
3486 (list :tag "End radio group"
3487 (const :endgroup)
3488 (option (string :tag "Group description")))
3489 (list :tag "End tag group, non distinct"
3490 (const :endgrouptag)
3491 (option (string :tag "Group description")))
3492 (const :tag "New line" (:newline)))))
3494 (defcustom org-tag-persistent-alist nil
3495 "List of tags that will always appear in all Org-mode files.
3496 This is in addition to any in buffer settings or customizations
3497 of `org-tag-alist'.
3498 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3499 The value of this variable is an alist, the car of each entry must be a
3500 keyword as a string, the cdr may be a character that is used to select
3501 that tag through the fast-tag-selection interface.
3502 See the manual for details.
3503 To disable these tags on a per-file basis, insert anywhere in the file:
3504 #+STARTUP: noptag"
3505 :group 'org-tags
3506 :type '(repeat
3507 (choice
3508 (cons (string :tag "Tag name")
3509 (character :tag "Access char"))
3510 (const :tag "Start radio group" (:startgroup))
3511 (const :tag "Group tags delimiter" (:grouptags))
3512 (const :tag "End radio group" (:endgroup))
3513 (const :tag "New line" (:newline)))))
3515 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3516 "If non-nil, always offer completion for all tags of all agenda files.
3517 Instead of customizing this variable directly, you might want to
3518 set it locally for capture buffers, because there no list of
3519 tags in that file can be created dynamically (there are none).
3521 (add-hook \\='org-capture-mode-hook
3522 (lambda ()
3523 (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
3524 :group 'org-tags
3525 :version "24.1"
3526 :type 'boolean)
3528 (defvar org-file-tags nil
3529 "List of tags that can be inherited by all entries in the file.
3530 The tags will be inherited if the variable `org-use-tag-inheritance'
3531 says they should be.
3532 This variable is populated from #+FILETAGS lines.")
3534 (defcustom org-use-fast-tag-selection 'auto
3535 "Non-nil means use fast tag selection scheme.
3536 This is a special interface to select and deselect tags with single keys.
3537 When nil, fast selection is never used.
3538 When the symbol `auto', fast selection is used if and only if selection
3539 characters for tags have been configured, either through the variable
3540 `org-tag-alist' or through a #+TAGS line in the buffer.
3541 When t, fast selection is always used and selection keys are assigned
3542 automatically if necessary."
3543 :group 'org-tags
3544 :type '(choice
3545 (const :tag "Always" t)
3546 (const :tag "Never" nil)
3547 (const :tag "When selection characters are configured" auto)))
3549 (defcustom org-fast-tag-selection-single-key nil
3550 "Non-nil means fast tag selection exits after first change.
3551 When nil, you have to press RET to exit it.
3552 During fast tag selection, you can toggle this flag with `C-c'.
3553 This variable can also have the value `expert'. In this case, the window
3554 displaying the tags menu is not even shown, until you press C-c again."
3555 :group 'org-tags
3556 :type '(choice
3557 (const :tag "No" nil)
3558 (const :tag "Yes" t)
3559 (const :tag "Expert" expert)))
3561 (defvar org-fast-tag-selection-include-todo nil
3562 "Non-nil means fast tags selection interface will also offer TODO states.
3563 This is an undocumented feature, you should not rely on it.")
3565 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3566 "The column to which tags should be indented in a headline.
3567 If this number is positive, it specifies the column. If it is negative,
3568 it means that the tags should be flushright to that column. For example,
3569 -80 works well for a normal 80 character screen.
3570 When 0, place tags directly after headline text, with only one space in
3571 between."
3572 :group 'org-tags
3573 :type 'integer)
3575 (defcustom org-auto-align-tags t
3576 "Non-nil keeps tags aligned when modifying headlines.
3577 Some operations (i.e. demoting) change the length of a headline and
3578 therefore shift the tags around. With this option turned on, after
3579 each such operation the tags are again aligned to `org-tags-column'."
3580 :group 'org-tags
3581 :type 'boolean)
3583 (defcustom org-use-tag-inheritance t
3584 "Non-nil means tags in levels apply also for sublevels.
3585 When nil, only the tags directly given in a specific line apply there.
3586 This may also be a list of tags that should be inherited, or a regexp that
3587 matches tags that should be inherited. Additional control is possible
3588 with the variable `org-tags-exclude-from-inheritance' which gives an
3589 explicit list of tags to be excluded from inheritance, even if the value of
3590 `org-use-tag-inheritance' would select it for inheritance.
3592 If this option is t, a match early-on in a tree can lead to a large
3593 number of matches in the subtree when constructing the agenda or creating
3594 a sparse tree. If you only want to see the first match in a tree during
3595 a search, check out the variable `org-tags-match-list-sublevels'."
3596 :group 'org-tags
3597 :type '(choice
3598 (const :tag "Not" nil)
3599 (const :tag "Always" t)
3600 (repeat :tag "Specific tags" (string :tag "Tag"))
3601 (regexp :tag "Tags matched by regexp")))
3603 (defcustom org-tags-exclude-from-inheritance nil
3604 "List of tags that should never be inherited.
3605 This is a way to exclude a few tags from inheritance. For way to do
3606 the opposite, to actively allow inheritance for selected tags,
3607 see the variable `org-use-tag-inheritance'."
3608 :group 'org-tags
3609 :type '(repeat (string :tag "Tag")))
3611 (defun org-tag-inherit-p (tag)
3612 "Check if TAG is one that should be inherited."
3613 (cond
3614 ((member tag org-tags-exclude-from-inheritance) nil)
3615 ((eq org-use-tag-inheritance t) t)
3616 ((not org-use-tag-inheritance) nil)
3617 ((stringp org-use-tag-inheritance)
3618 (string-match org-use-tag-inheritance tag))
3619 ((listp org-use-tag-inheritance)
3620 (member tag org-use-tag-inheritance))
3621 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3623 (defcustom org-tags-match-list-sublevels t
3624 "Non-nil means list also sublevels of headlines matching a search.
3625 This variable applies to tags/property searches, and also to stuck
3626 projects because this search is based on a tags match as well.
3628 When set to the symbol `indented', sublevels are indented with
3629 leading dots.
3631 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3632 the sublevels of a headline matching a tag search often also match
3633 the same search. Listing all of them can create very long lists.
3634 Setting this variable to nil causes subtrees of a match to be skipped.
3636 This variable is semi-obsolete and probably should always be true. It
3637 is better to limit inheritance to certain tags using the variables
3638 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3639 :group 'org-tags
3640 :type '(choice
3641 (const :tag "No, don't list them" nil)
3642 (const :tag "Yes, do list them" t)
3643 (const :tag "List them, indented with leading dots" indented)))
3645 (defcustom org-tags-sort-function nil
3646 "When set, tags are sorted using this function as a comparator."
3647 :group 'org-tags
3648 :type '(choice
3649 (const :tag "No sorting" nil)
3650 (const :tag "Alphabetical" string<)
3651 (const :tag "Reverse alphabetical" string>)
3652 (function :tag "Custom function" nil)))
3654 (defvar org-tags-history nil
3655 "History of minibuffer reads for tags.")
3656 (defvar org-last-tags-completion-table nil
3657 "The last used completion table for tags.")
3658 (defvar org-after-tags-change-hook nil
3659 "Hook that is run after the tags in a line have changed.")
3661 (defgroup org-properties nil
3662 "Options concerning properties in Org-mode."
3663 :tag "Org Properties"
3664 :group 'org)
3666 (defcustom org-property-format "%-10s %s"
3667 "How property key/value pairs should be formatted by `indent-line'.
3668 When `indent-line' hits a property definition, it will format the line
3669 according to this format, mainly to make sure that the values are
3670 lined-up with respect to each other."
3671 :group 'org-properties
3672 :type 'string)
3674 (defcustom org-properties-postprocess-alist nil
3675 "Alist of properties and functions to adjust inserted values.
3676 Elements of this alist must be of the form
3678 ([string] [function])
3680 where [string] must be a property name and [function] must be a
3681 lambda expression: this lambda expression must take one argument,
3682 the value to adjust, and return the new value as a string.
3684 For example, this element will allow the property \"Remaining\"
3685 to be updated wrt the relation between the \"Effort\" property
3686 and the clock summary:
3688 ((\"Remaining\" (lambda(value)
3689 (let ((clocksum (org-clock-sum-current-item))
3690 (effort (org-duration-string-to-minutes
3691 (org-entry-get (point) \"Effort\"))))
3692 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3693 :group 'org-properties
3694 :version "24.1"
3695 :type '(alist :key-type (string :tag "Property")
3696 :value-type (function :tag "Function")))
3698 (defcustom org-use-property-inheritance nil
3699 "Non-nil means properties apply also for sublevels.
3701 This setting is chiefly used during property searches. Turning it on can
3702 cause significant overhead when doing a search, which is why it is not
3703 on by default.
3705 When nil, only the properties directly given in the current entry count.
3706 When t, every property is inherited. The value may also be a list of
3707 properties that should have inheritance, or a regular expression matching
3708 properties that should be inherited.
3710 However, note that some special properties use inheritance under special
3711 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3712 and the properties ending in \"_ALL\" when they are used as descriptor
3713 for valid values of a property.
3715 Note for programmers:
3716 When querying an entry with `org-entry-get', you can control if inheritance
3717 should be used. By default, `org-entry-get' looks only at the local
3718 properties. You can request inheritance by setting the inherit argument
3719 to t (to force inheritance) or to `selective' (to respect the setting
3720 in this variable)."
3721 :group 'org-properties
3722 :type '(choice
3723 (const :tag "Not" nil)
3724 (const :tag "Always" t)
3725 (repeat :tag "Specific properties" (string :tag "Property"))
3726 (regexp :tag "Properties matched by regexp")))
3728 (defun org-property-inherit-p (property)
3729 "Check if PROPERTY is one that should be inherited."
3730 (cond
3731 ((eq org-use-property-inheritance t) t)
3732 ((not org-use-property-inheritance) nil)
3733 ((stringp org-use-property-inheritance)
3734 (string-match org-use-property-inheritance property))
3735 ((listp org-use-property-inheritance)
3736 (member property org-use-property-inheritance))
3737 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3739 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3740 "The default column format, if no other format has been defined.
3741 This variable can be set on the per-file basis by inserting a line
3743 #+COLUMNS: %25ITEM ....."
3744 :group 'org-properties
3745 :type 'string)
3747 (defcustom org-columns-ellipses ".."
3748 "The ellipses to be used when a field in column view is truncated.
3749 When this is the empty string, as many characters as possible are shown,
3750 but then there will be no visual indication that the field has been truncated.
3751 When this is a string of length N, the last N characters of a truncated
3752 field are replaced by this string. If the column is narrower than the
3753 ellipses string, only part of the ellipses string will be shown."
3754 :group 'org-properties
3755 :type 'string)
3757 (defcustom org-columns-modify-value-for-display-function nil
3758 "Function that modifies values for display in column view.
3759 For example, it can be used to cut out a certain part from a time stamp.
3760 The function must take 2 arguments:
3762 column-title The title of the column (*not* the property name)
3763 value The value that should be modified.
3765 The function should return the value that should be displayed,
3766 or nil if the normal value should be used."
3767 :group 'org-properties
3768 :type '(choice (const nil) (function)))
3770 (defconst org-global-properties-fixed
3771 '(("VISIBILITY_ALL" . "folded children content all")
3772 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3773 "List of property/value pairs that can be inherited by any entry.
3775 These are fixed values, for the preset properties. The user variable
3776 that can be used to add to this list is `org-global-properties'.
3778 The entries in this list are cons cells where the car is a property
3779 name and cdr is a string with the value. If the value represents
3780 multiple items like an \"_ALL\" property, separate the items by
3781 spaces.")
3783 (defcustom org-global-properties nil
3784 "List of property/value pairs that can be inherited by any entry.
3786 This list will be combined with the constant `org-global-properties-fixed'.
3788 The entries in this list are cons cells where the car is a property
3789 name and cdr is a string with the value.
3791 You can set buffer-local values for the same purpose in the variable
3792 `org-file-properties' this by adding lines like
3794 #+PROPERTY: NAME VALUE"
3795 :group 'org-properties
3796 :type '(repeat
3797 (cons (string :tag "Property")
3798 (string :tag "Value"))))
3800 (defvar-local org-file-properties nil
3801 "List of property/value pairs that can be inherited by any entry.
3802 Valid for the current buffer.
3803 This variable is populated from #+PROPERTY lines.")
3805 (defgroup org-agenda nil
3806 "Options concerning agenda views in Org-mode."
3807 :tag "Org Agenda"
3808 :group 'org)
3810 (defvar-local org-category nil
3811 "Variable used by org files to set a category for agenda display.
3812 Such files should use a file variable to set it, for example
3814 # -*- mode: org; org-category: \"ELisp\"
3816 or contain a special line
3818 #+CATEGORY: ELisp
3820 If the file does not specify a category, then file's base name
3821 is used instead.")
3822 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3824 (defcustom org-agenda-files nil
3825 "The files to be used for agenda display.
3826 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3827 \\[org-remove-file]. You can also use customize to edit the list.
3829 If an entry is a directory, all files in that directory that are matched by
3830 `org-agenda-file-regexp' will be part of the file list.
3832 If the value of the variable is not a list but a single file name, then
3833 the list of agenda files is actually stored and maintained in that file, one
3834 agenda file per line. In this file paths can be given relative to
3835 `org-directory'. Tilde expansion and environment variable substitution
3836 are also made."
3837 :group 'org-agenda
3838 :type '(choice
3839 (repeat :tag "List of files and directories" file)
3840 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3842 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3843 "Regular expression to match files for `org-agenda-files'.
3844 If any element in the list in that variable contains a directory instead
3845 of a normal file, all files in that directory that are matched by this
3846 regular expression will be included."
3847 :group 'org-agenda
3848 :type 'regexp)
3850 (defcustom org-agenda-text-search-extra-files nil
3851 "List of extra files to be searched by text search commands.
3852 These files will be searched in addition to the agenda files by the
3853 commands `org-search-view' (`\\[org-agenda] s') \
3854 and `org-occur-in-agenda-files'.
3855 Note that these files will only be searched for text search commands,
3856 not for the other agenda views like todo lists, tag searches or the weekly
3857 agenda. This variable is intended to list notes and possibly archive files
3858 that should also be searched by these two commands.
3859 In fact, if the first element in the list is the symbol `agenda-archives',
3860 then all archive files of all agenda files will be added to the search
3861 scope."
3862 :group 'org-agenda
3863 :type '(set :greedy t
3864 (const :tag "Agenda Archives" agenda-archives)
3865 (repeat :inline t (file))))
3867 (org-defvaralias 'org-agenda-multi-occur-extra-files
3868 'org-agenda-text-search-extra-files)
3870 (defcustom org-agenda-skip-unavailable-files nil
3871 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3872 A nil value means to remove them, after a query, from the list."
3873 :group 'org-agenda
3874 :type 'boolean)
3876 (defcustom org-calendar-to-agenda-key [?c]
3877 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3878 The command `org-calendar-goto-agenda' will be bound to this key. The
3879 default is the character `c' because then `c' can be used to switch back and
3880 forth between agenda and calendar."
3881 :group 'org-agenda
3882 :type 'sexp)
3884 (defcustom org-calendar-insert-diary-entry-key [?i]
3885 "The key to be installed in `calendar-mode-map' for adding diary entries.
3886 This option is irrelevant until `org-agenda-diary-file' has been configured
3887 to point to an Org-mode file. When that is the case, the command
3888 `org-agenda-diary-entry' will be bound to the key given here, by default
3889 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3890 if you want to continue doing this, you need to change this to a different
3891 key."
3892 :group 'org-agenda
3893 :type 'sexp)
3895 (defcustom org-agenda-diary-file 'diary-file
3896 "File to which to add new entries with the `i' key in agenda and calendar.
3897 When this is the symbol `diary-file', the functionality in the Emacs
3898 calendar will be used to add entries to the `diary-file'. But when this
3899 points to a file, `org-agenda-diary-entry' will be used instead."
3900 :group 'org-agenda
3901 :type '(choice
3902 (const :tag "The standard Emacs diary file" diary-file)
3903 (file :tag "Special Org file diary entries")))
3905 (eval-after-load "calendar"
3906 '(progn
3907 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3908 'org-calendar-goto-agenda)
3909 (add-hook 'calendar-mode-hook
3910 (lambda ()
3911 (unless (eq org-agenda-diary-file 'diary-file)
3912 (define-key calendar-mode-map
3913 org-calendar-insert-diary-entry-key
3914 'org-agenda-diary-entry))))))
3916 (defgroup org-latex nil
3917 "Options for embedding LaTeX code into Org-mode."
3918 :tag "Org LaTeX"
3919 :group 'org)
3921 (defcustom org-format-latex-options
3922 '(:foreground default :background default :scale 1.0
3923 :html-foreground "Black" :html-background "Transparent"
3924 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3925 "Options for creating images from LaTeX fragments.
3926 This is a property list with the following properties:
3927 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3928 `default' means use the foreground of the default face.
3929 `auto' means use the foreground from the text face.
3930 :background the background color, or \"Transparent\".
3931 `default' means use the background of the default face.
3932 `auto' means use the background from the text face.
3933 :scale a scaling factor for the size of the images, to get more pixels
3934 :html-foreground, :html-background, :html-scale
3935 the same numbers for HTML export.
3936 :matchers a list indicating which matchers should be used to
3937 find LaTeX fragments. Valid members of this list are:
3938 \"begin\" find environments
3939 \"$1\" find single characters surrounded by $.$
3940 \"$\" find math expressions surrounded by $...$
3941 \"$$\" find math expressions surrounded by $$....$$
3942 \"\\(\" find math expressions surrounded by \\(...\\)
3943 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3944 :group 'org-latex
3945 :type 'plist)
3947 (defcustom org-format-latex-signal-error t
3948 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3949 When nil, just push out a message."
3950 :group 'org-latex
3951 :version "24.1"
3952 :type 'boolean)
3954 (defcustom org-latex-to-mathml-jar-file nil
3955 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3956 Use this to specify additional executable file say a jar file.
3958 When using MathToWeb as the converter, specify the full-path to
3959 your mathtoweb.jar file."
3960 :group 'org-latex
3961 :version "24.1"
3962 :type '(choice
3963 (const :tag "None" nil)
3964 (file :tag "JAR file" :must-match t)))
3966 (defcustom org-latex-to-mathml-convert-command nil
3967 "Command to convert LaTeX fragments to MathML.
3968 Replace format-specifiers in the command as noted below and use
3969 `shell-command' to convert LaTeX to MathML.
3970 %j: Executable file in fully expanded form as specified by
3971 `org-latex-to-mathml-jar-file'.
3972 %I: Input LaTeX file in fully expanded form.
3973 %i: The latex fragment to be converted.
3974 %o: Output MathML file.
3976 This command is used by `org-create-math-formula'.
3978 When using MathToWeb as the converter, set this option to
3979 \"java -jar %j -unicode -force -df %o %I\".
3981 When using LaTeXML set this option to
3982 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3983 :group 'org-latex
3984 :version "24.1"
3985 :type '(choice
3986 (const :tag "None" nil)
3987 (string :tag "\nShell command")))
3989 (defcustom org-latex-create-formula-image-program 'dvipng
3990 "Program to convert LaTeX fragments with.
3992 dvipng Process the LaTeX fragments to dvi file, then convert
3993 dvi files to png files using dvipng.
3994 This will also include processing of non-math environments.
3995 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3996 to convert pdf files to png files"
3997 :group 'org-latex
3998 :version "24.1"
3999 :type '(choice
4000 (const :tag "dvipng" dvipng)
4001 (const :tag "imagemagick" imagemagick)))
4003 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4004 "Path to store latex preview images.
4005 A relative path here creates many directories relative to the
4006 processed org files paths. An absolute path puts all preview
4007 images at the same place."
4008 :group 'org-latex
4009 :version "24.3"
4010 :type 'string)
4012 (defun org-format-latex-mathml-available-p ()
4013 "Return t if `org-latex-to-mathml-convert-command' is usable."
4014 (save-match-data
4015 (when (and (boundp 'org-latex-to-mathml-convert-command)
4016 org-latex-to-mathml-convert-command)
4017 (let ((executable (car (split-string
4018 org-latex-to-mathml-convert-command))))
4019 (when (executable-find executable)
4020 (if (string-match
4021 "%j" org-latex-to-mathml-convert-command)
4022 (file-readable-p org-latex-to-mathml-jar-file)
4023 t))))))
4025 (defcustom org-format-latex-header "\\documentclass{article}
4026 \\usepackage[usenames]{color}
4027 \[PACKAGES]
4028 \[DEFAULT-PACKAGES]
4029 \\pagestyle{empty} % do not remove
4030 % The settings below are copied from fullpage.sty
4031 \\setlength{\\textwidth}{\\paperwidth}
4032 \\addtolength{\\textwidth}{-3cm}
4033 \\setlength{\\oddsidemargin}{1.5cm}
4034 \\addtolength{\\oddsidemargin}{-2.54cm}
4035 \\setlength{\\evensidemargin}{\\oddsidemargin}
4036 \\setlength{\\textheight}{\\paperheight}
4037 \\addtolength{\\textheight}{-\\headheight}
4038 \\addtolength{\\textheight}{-\\headsep}
4039 \\addtolength{\\textheight}{-\\footskip}
4040 \\addtolength{\\textheight}{-3cm}
4041 \\setlength{\\topmargin}{1.5cm}
4042 \\addtolength{\\topmargin}{-2.54cm}"
4043 "The document header used for processing LaTeX fragments.
4044 It is imperative that this header make sure that no page number
4045 appears on the page. The package defined in the variables
4046 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4047 will either replace the placeholder \"[PACKAGES]\" in this
4048 header, or they will be appended."
4049 :group 'org-latex
4050 :type 'string)
4052 (defun org-set-packages-alist (var val)
4053 "Set the packages alist and make sure it has 3 elements per entry."
4054 (set var (mapcar (lambda (x)
4055 (if (and (consp x) (= (length x) 2))
4056 (list (car x) (nth 1 x) t)
4058 val)))
4060 (defun org-get-packages-alist (var)
4061 "Get the packages alist and make sure it has 3 elements per entry."
4062 (mapcar (lambda (x)
4063 (if (and (consp x) (= (length x) 2))
4064 (list (car x) (nth 1 x) t)
4066 (default-value var)))
4068 (defcustom org-latex-default-packages-alist
4069 '(("AUTO" "inputenc" t ("pdflatex"))
4070 ("T1" "fontenc" t ("pdflatex"))
4071 ("" "graphicx" t)
4072 ("" "grffile" t)
4073 ("" "longtable" nil)
4074 ("" "wrapfig" nil)
4075 ("" "rotating" nil)
4076 ("normalem" "ulem" t)
4077 ("" "amsmath" t)
4078 ("" "textcomp" t)
4079 ("" "amssymb" t)
4080 ("" "capt-of" nil)
4081 ("" "hyperref" nil))
4082 "Alist of default packages to be inserted in the header.
4084 Change this only if one of the packages here causes an
4085 incompatibility with another package you are using.
4087 The packages in this list are needed by one part or another of
4088 Org mode to function properly:
4090 - inputenc, fontenc: for basic font and character selection
4091 - graphicx: for including images
4092 - grffile: allow periods and spaces in graphics file names
4093 - longtable: For multipage tables
4094 - wrapfig: for figure placement
4095 - rotating: for sideways figures and tables
4096 - ulem: for underline and strike-through
4097 - amsmath: for subscript and superscript and math environments
4098 - textcomp, amssymb: for various symbols used
4099 for interpreting the entities in `org-entities'. You can skip
4100 some of these packages if you don't use any of their symbols.
4101 - capt-of: for captions outside of floats
4102 - hyperref: for cross references
4104 Therefore you should not modify this variable unless you know
4105 what you are doing. The one reason to change it anyway is that
4106 you might be loading some other package that conflicts with one
4107 of the default packages. Each element is either a cell or
4108 a string.
4110 A cell is of the format
4112 (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
4114 If SNIPPET-FLAG is non-nil, the package also needs to be included
4115 when compiling LaTeX snippets into images for inclusion into
4116 non-LaTeX output. COMPILERS is a list of compilers that should
4117 include the package, see `org-latex-compiler'. If the document
4118 compiler is not in the list, and the list is non-nil, the package
4119 will not be inserted in the final document.
4121 A string will be inserted as-is in the header of the document."
4122 :group 'org-latex
4123 :group 'org-export-latex
4124 :set 'org-set-packages-alist
4125 :get 'org-get-packages-alist
4126 :version "25.1"
4127 :package-version '(Org . "8.3")
4128 :type '(repeat
4129 (choice
4130 (list :tag "options/package pair"
4131 (string :tag "options")
4132 (string :tag "package")
4133 (boolean :tag "Snippet"))
4134 (string :tag "A line of LaTeX"))))
4136 (defcustom org-latex-packages-alist nil
4137 "Alist of packages to be inserted in every LaTeX header.
4139 These will be inserted after `org-latex-default-packages-alist'.
4140 Each element is either a cell or a string.
4142 A cell is of the format:
4144 (\"options\" \"package\" SNIPPET-FLAG)
4146 SNIPPET-FLAG, when non-nil, indicates that this package is also
4147 needed when turning LaTeX snippets into images for inclusion into
4148 non-LaTeX output.
4150 A string will be inserted as-is in the header of the document.
4152 Make sure that you only list packages here which:
4154 - you want in every file;
4155 - do not conflict with the setup in `org-format-latex-header';
4156 - do not conflict with the default packages in
4157 `org-latex-default-packages-alist'."
4158 :group 'org-latex
4159 :group 'org-export-latex
4160 :set 'org-set-packages-alist
4161 :get 'org-get-packages-alist
4162 :type '(repeat
4163 (choice
4164 (list :tag "options/package pair"
4165 (string :tag "options")
4166 (string :tag "package")
4167 (boolean :tag "Snippet"))
4168 (string :tag "A line of LaTeX"))))
4170 (defgroup org-appearance nil
4171 "Settings for Org-mode appearance."
4172 :tag "Org Appearance"
4173 :group 'org)
4175 (defcustom org-level-color-stars-only nil
4176 "Non-nil means fontify only the stars in each headline.
4177 When nil, the entire headline is fontified.
4178 Changing it requires restart of `font-lock-mode' to become effective
4179 also in regions already fontified."
4180 :group 'org-appearance
4181 :type 'boolean)
4183 (defcustom org-hide-leading-stars nil
4184 "Non-nil means hide the first N-1 stars in a headline.
4185 This works by using the face `org-hide' for these stars. This
4186 face is white for a light background, and black for a dark
4187 background. You may have to customize the face `org-hide' to
4188 make this work.
4189 Changing it requires restart of `font-lock-mode' to become effective
4190 also in regions already fontified.
4191 You may also set this on a per-file basis by adding one of the following
4192 lines to the buffer:
4194 #+STARTUP: hidestars
4195 #+STARTUP: showstars"
4196 :group 'org-appearance
4197 :type 'boolean)
4199 (defcustom org-hidden-keywords nil
4200 "List of symbols corresponding to keywords to be hidden the org buffer.
4201 For example, a value \\='(title) for this list will make the document's title
4202 appear in the buffer without the initial #+TITLE: keyword."
4203 :group 'org-appearance
4204 :version "24.1"
4205 :type '(set (const :tag "#+AUTHOR" author)
4206 (const :tag "#+DATE" date)
4207 (const :tag "#+EMAIL" email)
4208 (const :tag "#+TITLE" title)))
4210 (defcustom org-custom-properties nil
4211 "List of properties (as strings) with a special meaning.
4212 The default use of these custom properties is to let the user
4213 hide them with `org-toggle-custom-properties-visibility'."
4214 :group 'org-properties
4215 :group 'org-appearance
4216 :version "24.3"
4217 :type '(repeat (string :tag "Property Name")))
4219 (defcustom org-fontify-done-headline nil
4220 "Non-nil means change the face of a headline if it is marked DONE.
4221 Normally, only the TODO/DONE keyword indicates the state of a headline.
4222 When this is non-nil, the headline after the keyword is set to the
4223 `org-headline-done' as an additional indication."
4224 :group 'org-appearance
4225 :type 'boolean)
4227 (defcustom org-fontify-emphasized-text t
4228 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4229 Changing this variable requires a restart of Emacs to take effect."
4230 :group 'org-appearance
4231 :type 'boolean)
4233 (defcustom org-fontify-whole-heading-line nil
4234 "Non-nil means fontify the whole line for headings.
4235 This is useful when setting a background color for the
4236 org-level-* faces."
4237 :group 'org-appearance
4238 :type 'boolean)
4240 (defcustom org-highlight-latex-and-related nil
4241 "Non-nil means highlight LaTeX related syntax in the buffer.
4242 When non nil, the value should be a list containing any of the
4243 following symbols:
4244 `latex' Highlight LaTeX snippets and environments.
4245 `script' Highlight subscript and superscript.
4246 `entities' Highlight entities."
4247 :group 'org-appearance
4248 :version "24.4"
4249 :package-version '(Org . "8.0")
4250 :type '(choice
4251 (const :tag "No highlighting" nil)
4252 (set :greedy t :tag "Highlight"
4253 (const :tag "LaTeX snippets and environments" latex)
4254 (const :tag "Subscript and superscript" script)
4255 (const :tag "Entities" entities))))
4257 (defcustom org-hide-emphasis-markers nil
4258 "Non-nil mean font-lock should hide the emphasis marker characters."
4259 :group 'org-appearance
4260 :type 'boolean)
4262 (defcustom org-hide-macro-markers nil
4263 "Non-nil mean font-lock should hide the brackets marking macro calls."
4264 :group 'org-appearance
4265 :type 'boolean)
4267 (defcustom org-pretty-entities nil
4268 "Non-nil means show entities as UTF8 characters.
4269 When nil, the \\name form remains in the buffer."
4270 :group 'org-appearance
4271 :version "24.1"
4272 :type 'boolean)
4274 (defcustom org-pretty-entities-include-sub-superscripts t
4275 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4276 :group 'org-appearance
4277 :version "24.1"
4278 :type 'boolean)
4280 (defvar org-emph-re nil
4281 "Regular expression for matching emphasis.
4282 After a match, the match groups contain these elements:
4283 0 The match of the full regular expression, including the characters
4284 before and after the proper match
4285 1 The character before the proper match, or empty at beginning of line
4286 2 The proper match, including the leading and trailing markers
4287 3 The leading marker like * or /, indicating the type of highlighting
4288 4 The text between the emphasis markers, not including the markers
4289 5 The character after the match, empty at the end of a line")
4290 (defvar org-verbatim-re nil
4291 "Regular expression for matching verbatim text.")
4292 (defvar org-emphasis-regexp-components) ; defined just below
4293 (defvar org-emphasis-alist) ; defined just below
4294 (defun org-set-emph-re (var val)
4295 "Set variable and compute the emphasis regular expression."
4296 (set var val)
4297 (when (and (boundp 'org-emphasis-alist)
4298 (boundp 'org-emphasis-regexp-components)
4299 org-emphasis-alist org-emphasis-regexp-components)
4300 (let* ((e org-emphasis-regexp-components)
4301 (pre (car e))
4302 (post (nth 1 e))
4303 (border (nth 2 e))
4304 (body (nth 3 e))
4305 (nl (nth 4 e))
4306 (body1 (concat body "*?"))
4307 (markers (mapconcat 'car org-emphasis-alist ""))
4308 (vmarkers (mapconcat
4309 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4310 org-emphasis-alist "")))
4311 ;; make sure special characters appear at the right position in the class
4312 (if (string-match "\\^" markers)
4313 (setq markers (concat (replace-match "" t t markers) "^")))
4314 (if (string-match "-" markers)
4315 (setq markers (concat (replace-match "" t t markers) "-")))
4316 (if (string-match "\\^" vmarkers)
4317 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4318 (if (string-match "-" vmarkers)
4319 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4320 (if (> nl 0)
4321 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4322 (int-to-string nl) "\\}")))
4323 ;; Make the regexp
4324 (setq org-emph-re
4325 (concat "\\([" pre "]\\|^\\)"
4326 "\\("
4327 "\\([" markers "]\\)"
4328 "\\("
4329 "[^" border "]\\|"
4330 "[^" border "]"
4331 body1
4332 "[^" border "]"
4333 "\\)"
4334 "\\3\\)"
4335 "\\([" post "]\\|$\\)"))
4336 (setq org-verbatim-re
4337 (concat "\\([" pre "]\\|^\\)"
4338 "\\("
4339 "\\([" vmarkers "]\\)"
4340 "\\("
4341 "[^" border "]\\|"
4342 "[^" border "]"
4343 body1
4344 "[^" border "]"
4345 "\\)"
4346 "\\3\\)"
4347 "\\([" post "]\\|$\\)")))))
4349 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4350 ;; set this option proved cumbersome. See this message/thread:
4351 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4352 (defvar org-emphasis-regexp-components
4353 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n" "." 1)
4354 "Components used to build the regular expression for emphasis.
4355 This is a list with five entries. Terminology: In an emphasis string
4356 like \" *strong word* \", we call the initial space PREMATCH, the final
4357 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4358 and \"trong wor\" is the body. The different components in this variable
4359 specify what is allowed/forbidden in each part:
4361 pre Chars allowed as prematch. Beginning of line will be allowed too.
4362 post Chars allowed as postmatch. End of line will be allowed too.
4363 border The chars *forbidden* as border characters.
4364 body-regexp A regexp like \".\" to match a body character. Don't use
4365 non-shy groups here, and don't allow newline here.
4366 newline The maximum number of newlines allowed in an emphasis exp.
4368 You need to reload Org or to restart Emacs after customizing this.")
4370 (defcustom org-emphasis-alist
4371 `(("*" bold)
4372 ("/" italic)
4373 ("_" underline)
4374 ("=" org-verbatim verbatim)
4375 ("~" org-code verbatim)
4376 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4377 "Alist of characters and faces to emphasize text.
4378 Text starting and ending with a special character will be emphasized,
4379 for example *bold*, _underlined_ and /italic/. This variable sets the
4380 marker characters and the face to be used by font-lock for highlighting
4381 in Org-mode Emacs buffers.
4383 You need to reload Org or to restart Emacs after customizing this."
4384 :group 'org-appearance
4385 :set 'org-set-emph-re
4386 :version "24.4"
4387 :package-version '(Org . "8.0")
4388 :type '(repeat
4389 (list
4390 (string :tag "Marker character")
4391 (choice
4392 (face :tag "Font-lock-face")
4393 (plist :tag "Face property list"))
4394 (option (const verbatim)))))
4396 (defvar org-protecting-blocks
4397 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4398 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4399 This is needed for font-lock setup.")
4401 ;;; Miscellaneous options
4403 (defgroup org-completion nil
4404 "Completion in Org-mode."
4405 :tag "Org Completion"
4406 :group 'org)
4408 (defcustom org-completion-use-ido nil
4409 "Non-nil means use ido completion wherever possible.
4410 Note that `ido-mode' must be active for this variable to be relevant.
4411 If you decide to turn this variable on, you might well want to turn off
4412 `org-outline-path-complete-in-steps'.
4413 See also `org-completion-use-iswitchb'."
4414 :group 'org-completion
4415 :type 'boolean)
4417 (defcustom org-completion-use-iswitchb nil
4418 "Non-nil means use iswitchb completion wherever possible.
4419 Note that `iswitchb-mode' must be active for this variable to be relevant.
4420 If you decide to turn this variable on, you might well want to turn off
4421 `org-outline-path-complete-in-steps'.
4422 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4423 :group 'org-completion
4424 :type 'boolean)
4426 (defcustom org-completion-fallback-command 'hippie-expand
4427 "The expansion command called by \\[pcomplete] in normal context.
4428 Normal means, no org-mode-specific context."
4429 :group 'org-completion
4430 :type 'function)
4432 ;;; Functions and variables from their packages
4433 ;; Declared here to avoid compiler warnings
4435 ;; XEmacs only
4436 (defvar outline-mode-menu-heading)
4437 (defvar outline-mode-menu-show)
4438 (defvar outline-mode-menu-hide)
4439 (defvar zmacs-regions) ; XEmacs regions
4441 ;; Emacs only
4442 (defvar mark-active)
4444 ;; Various packages
4445 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4446 (declare-function calendar-forward-day "cal-move" (arg))
4447 (declare-function calendar-goto-date "cal-move" (date))
4448 (declare-function calendar-goto-today "cal-move" ())
4449 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4450 (defvar calc-embedded-close-formula)
4451 (defvar calc-embedded-open-formula)
4452 (declare-function cdlatex-tab "ext:cdlatex" ())
4453 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4454 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4455 (defvar font-lock-unfontify-region-function)
4456 (declare-function iswitchb-read-buffer "iswitchb"
4457 (prompt &optional default require-match start matches-set))
4458 (defvar iswitchb-temp-buflist)
4459 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4460 (defvar org-agenda-tags-todo-honor-ignore-options)
4461 (declare-function org-agenda-skip "org-agenda" ())
4462 (declare-function
4463 org-agenda-format-item "org-agenda"
4464 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4465 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4466 (declare-function org-agenda-change-all-lines "org-agenda"
4467 (newhead hdmarker &optional fixface just-this))
4468 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4469 (declare-function org-agenda-maybe-redo "org-agenda" ())
4470 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4471 (beg end))
4472 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4473 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4474 "org-agenda" (&optional end))
4475 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4476 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4477 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4478 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4479 (declare-function org-indent-mode "org-indent" (&optional arg))
4480 (declare-function parse-time-string "parse-time" (string))
4481 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4482 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4483 (defvar remember-data-file)
4484 (defvar texmathp-why)
4485 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4486 (declare-function table--at-cell-p "table" (position &optional object at-column))
4487 (declare-function calc-eval "calc" (str &optional separator &rest args))
4489 ;;;###autoload
4490 (defun turn-on-orgtbl ()
4491 "Unconditionally turn on `orgtbl-mode'."
4492 (require 'org-table)
4493 (orgtbl-mode 1))
4495 (defun org-at-table-p (&optional table-type)
4496 "Non-nil if the cursor is inside an Org table.
4497 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4498 If `org-enable-table-editor' is nil, return nil unconditionally."
4499 (and
4500 org-enable-table-editor
4501 (save-excursion
4502 (beginning-of-line)
4503 (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4504 (or (not (derived-mode-p 'org-mode))
4505 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4506 (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4507 (define-obsolete-function-alias 'org-table-p 'org-at-table-p "Org 9.0")
4509 (defun org-at-table.el-p ()
4510 "Non-nil when point is at a table.el table."
4511 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4512 (let ((element (org-element-at-point)))
4513 (and (eq (org-element-type element) 'table)
4514 (eq (org-element-property :type element) 'table.el)))))
4516 (defun org-table-recognize-table.el ()
4517 "If there is a table.el table nearby, recognize it and move into it."
4518 (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4519 (beginning-of-line)
4520 (unless (or (looking-at org-table-dataline-regexp)
4521 (not (looking-at org-table1-hline-regexp)))
4522 (forward-line)
4523 (when (looking-at org-table-any-border-regexp)
4524 (forward-line -2)))
4525 (if (re-search-forward "|" (org-table-end t) t)
4526 (progn
4527 (require 'table)
4528 (if (table--at-cell-p (point)) t
4529 (message "recognizing table.el table...")
4530 (table-recognize-table)
4531 (message "recognizing table.el table...done")))
4532 (error "This should not happen"))))
4533 ;;; This function is not used by org core since commit 6d1e3082, Feb 2010
4534 (make-obsolete 'org-table-recognize-table.el
4535 "please notify the org mailing list if you use this function."
4536 "Org 9.0")
4538 (defun org-at-table-hline-p ()
4539 "Non-nil when point is inside a hline in a table.
4540 Assume point is already in a table. If `org-enable-table-editor'
4541 is nil, return nil unconditionally."
4542 (and org-enable-table-editor
4543 (save-excursion
4544 (beginning-of-line)
4545 (looking-at org-table-hline-regexp))))
4547 (defun org-table-map-tables (function &optional quietly)
4548 "Apply FUNCTION to the start of all tables in the buffer."
4549 (save-excursion
4550 (save-restriction
4551 (widen)
4552 (goto-char (point-min))
4553 (while (re-search-forward org-table-any-line-regexp nil t)
4554 (unless quietly
4555 (message "Mapping tables: %d%%"
4556 (floor (* 100.0 (point)) (buffer-size))))
4557 (beginning-of-line 1)
4558 (when (and (looking-at org-table-line-regexp)
4559 ;; Exclude tables in src/example/verbatim/clocktable blocks
4560 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4561 (save-excursion (funcall function))
4562 (or (looking-at org-table-line-regexp)
4563 (forward-char 1)))
4564 (re-search-forward org-table-any-border-regexp nil 1))))
4565 (unless quietly (message "Mapping tables: done")))
4567 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4568 (declare-function org-clock-update-mode-line "org-clock" ())
4569 (declare-function org-resolve-clocks "org-clock"
4570 (&optional also-non-dangling-p prompt last-valid))
4572 (defun org-at-TBLFM-p (&optional pos)
4573 "Non-nil when point (or POS) is in #+TBLFM line."
4574 (save-excursion
4575 (goto-char (or pos (point)))
4576 (beginning-of-line)
4577 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4578 (eq (org-element-type (org-element-at-point)) 'table))))
4580 (defvar org-clock-start-time)
4581 (defvar org-clock-marker (make-marker)
4582 "Marker recording the last clock-in.")
4583 (defvar org-clock-hd-marker (make-marker)
4584 "Marker recording the last clock-in, but the headline position.")
4585 (defvar org-clock-heading ""
4586 "The heading of the current clock entry.")
4587 (defun org-clock-is-active ()
4588 "Return the buffer where the clock is currently running.
4589 Return nil if no clock is running."
4590 (marker-buffer org-clock-marker))
4592 (defun org-check-running-clock ()
4593 "Check if the current buffer contains the running clock.
4594 If yes, offer to stop it and to save the buffer with the changes."
4595 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4596 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4597 (buffer-name))))
4598 (org-clock-out)
4599 (when (y-or-n-p "Save changed buffer?")
4600 (save-buffer))))
4602 (defun org-clocktable-try-shift (dir n)
4603 "Check if this line starts a clock table, if yes, shift the time block."
4604 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4605 (org-clocktable-shift dir n)))
4607 ;;;###autoload
4608 (defun org-clock-persistence-insinuate ()
4609 "Set up hooks for clock persistence."
4610 (require 'org-clock)
4611 (add-hook 'org-mode-hook 'org-clock-load)
4612 (add-hook 'kill-emacs-hook 'org-clock-save))
4614 (defgroup org-archive nil
4615 "Options concerning archiving in Org-mode."
4616 :tag "Org Archive"
4617 :group 'org-structure)
4619 (defcustom org-archive-location "%s_archive::"
4620 "The location where subtrees should be archived.
4622 The value of this variable is a string, consisting of two parts,
4623 separated by a double-colon. The first part is a filename and
4624 the second part is a headline.
4626 When the filename is omitted, archiving happens in the same file.
4627 %s in the filename will be replaced by the current file
4628 name (without the directory part). Archiving to a different file
4629 is useful to keep archived entries from contributing to the
4630 Org-mode Agenda.
4632 The archived entries will be filed as subtrees of the specified
4633 headline. When the headline is omitted, the subtrees are simply
4634 filed away at the end of the file, as top-level entries. Also in
4635 the heading you can use %s to represent the file name, this can be
4636 useful when using the same archive for a number of different files.
4638 Here are a few examples:
4639 \"%s_archive::\"
4640 If the current file is Projects.org, archive in file
4641 Projects.org_archive, as top-level trees. This is the default.
4643 \"::* Archived Tasks\"
4644 Archive in the current file, under the top-level headline
4645 \"* Archived Tasks\".
4647 \"~/org/archive.org::\"
4648 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4650 \"~/org/archive.org::* From %s\"
4651 Archive in file ~/org/archive.org (absolute path), under headlines
4652 \"From FILENAME\" where file name is the current file name.
4654 \"~/org/datetree.org::datetree/* Finished Tasks\"
4655 The \"datetree/\" string is special, signifying to archive
4656 items to the datetree. Items are placed in either the CLOSED
4657 date of the item, or the current date if there is no CLOSED date.
4658 The heading will be a subentry to the current date. There doesn't
4659 need to be a heading, but there always needs to be a slash after
4660 datetree. For example, to store archived items directly in the
4661 datetree, use \"~/org/datetree.org::datetree/\".
4663 \"basement::** Finished Tasks\"
4664 Archive in file ./basement (relative path), as level 3 trees
4665 below the level 2 heading \"** Finished Tasks\".
4667 You may set this option on a per-file basis by adding to the buffer a
4668 line like
4670 #+ARCHIVE: basement::** Finished Tasks
4672 You may also define it locally for a subtree by setting an ARCHIVE property
4673 in the entry. If such a property is found in an entry, or anywhere up
4674 the hierarchy, it will be used."
4675 :group 'org-archive
4676 :type 'string)
4678 (defcustom org-agenda-skip-archived-trees t
4679 "Non-nil means the agenda will skip any items located in archived trees.
4680 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4681 variable is no longer recommended, you should leave it at the value t.
4682 Instead, use the key `v' to cycle the archives-mode in the agenda."
4683 :group 'org-archive
4684 :group 'org-agenda-skip
4685 :type 'boolean)
4687 (defcustom org-columns-skip-archived-trees t
4688 "Non-nil means ignore archived trees when creating column view."
4689 :group 'org-archive
4690 :group 'org-properties
4691 :type 'boolean)
4693 (defcustom org-cycle-open-archived-trees nil
4694 "Non-nil means `org-cycle' will open archived trees.
4695 An archived tree is a tree marked with the tag ARCHIVE.
4696 When nil, archived trees will stay folded. You can still open them with
4697 normal outline commands like `show-all', but not with the cycling commands."
4698 :group 'org-archive
4699 :group 'org-cycle
4700 :type 'boolean)
4702 (defcustom org-sparse-tree-open-archived-trees nil
4703 "Non-nil means sparse tree construction shows matches in archived trees.
4704 When nil, matches in these trees are highlighted, but the trees are kept in
4705 collapsed state."
4706 :group 'org-archive
4707 :group 'org-sparse-trees
4708 :type 'boolean)
4710 (defcustom org-sparse-tree-default-date-type nil
4711 "The default date type when building a sparse tree.
4712 When this is nil, a date is a scheduled or a deadline timestamp.
4713 Otherwise, these types are allowed:
4715 all: all timestamps
4716 active: only active timestamps (<...>)
4717 inactive: only inactive timestamps ([...])
4718 scheduled: only scheduled timestamps
4719 deadline: only deadline timestamps"
4720 :type '(choice (const :tag "Scheduled or deadline" nil)
4721 (const :tag "All timestamps" all)
4722 (const :tag "Only active timestamps" active)
4723 (const :tag "Only inactive timestamps" inactive)
4724 (const :tag "Only scheduled timestamps" scheduled)
4725 (const :tag "Only deadline timestamps" deadline)
4726 (const :tag "Only closed timestamps" closed))
4727 :version "25.1"
4728 :package-version '(Org . "8.3")
4729 :group 'org-sparse-trees)
4731 (defun org-cycle-hide-archived-subtrees (state)
4732 "Re-hide all archived subtrees after a visibility state change."
4733 (when (and (not org-cycle-open-archived-trees)
4734 (not (memq state '(overview folded))))
4735 (save-excursion
4736 (let* ((globalp (memq state '(contents all)))
4737 (beg (if globalp (point-min) (point)))
4738 (end (if globalp (point-max) (org-end-of-subtree t))))
4739 (org-hide-archived-subtrees beg end)
4740 (goto-char beg)
4741 (when (looking-at-p (concat ".*:" org-archive-tag ":"))
4742 (message "%s" (substitute-command-keys
4743 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4745 (defun org-force-cycle-archived ()
4746 "Cycle subtree even if it is archived."
4747 (interactive)
4748 (setq this-command 'org-cycle)
4749 (let ((org-cycle-open-archived-trees t))
4750 (call-interactively 'org-cycle)))
4752 (defun org-hide-archived-subtrees (beg end)
4753 "Re-hide all archived subtrees after a visibility state change."
4754 (org-with-wide-buffer
4755 (let ((case-fold-search nil)
4756 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4757 (goto-char beg)
4758 ;; Include headline point is currently on.
4759 (beginning-of-line)
4760 (while (and (< (point) end) (re-search-forward re end t))
4761 (when (member org-archive-tag (org-get-tags))
4762 (org-flag-subtree t)
4763 (org-end-of-subtree t))))))
4765 (declare-function outline-end-of-heading "outline" ())
4766 (declare-function outline-flag-region "outline" (from to flag))
4767 (defun org-flag-subtree (flag)
4768 (save-excursion
4769 (org-back-to-heading t)
4770 (outline-end-of-heading)
4771 (outline-flag-region (point)
4772 (progn (org-end-of-subtree t) (point))
4773 flag)))
4775 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4777 ;; Declare Column View Code
4779 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4780 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4781 (declare-function org-columns-compute "org-colview" (property))
4783 ;; Declare ID code
4785 (declare-function org-id-store-link "org-id")
4786 (declare-function org-id-locations-load "org-id")
4787 (declare-function org-id-locations-save "org-id")
4788 (defvar org-id-track-globally)
4790 ;;; Variables for pre-computed regular expressions, all buffer local
4792 (defvar-local org-todo-regexp nil
4793 "Matches any of the TODO state keywords.")
4794 (defvar-local org-not-done-regexp nil
4795 "Matches any of the TODO state keywords except the last one.")
4796 (defvar-local org-not-done-heading-regexp nil
4797 "Matches a TODO headline that is not done.")
4798 (defvar-local org-todo-line-regexp nil
4799 "Matches a headline and puts TODO state into group 2 if present.")
4800 (defvar-local org-complex-heading-regexp nil
4801 "Matches a headline and puts everything into groups:
4802 group 1: the stars
4803 group 2: The todo keyword, maybe
4804 group 3: Priority cookie
4805 group 4: True headline
4806 group 5: Tags")
4807 (defvar-local org-complex-heading-regexp-format nil
4808 "Printf format to make regexp to match an exact headline.
4809 This regexp will match the headline of any node which has the
4810 exact headline text that is put into the format, but may have any
4811 TODO state, priority and tags.")
4812 (defvar-local org-todo-line-tags-regexp nil
4813 "Matches a headline and puts TODO state into group 2 if present.
4814 Also put tags into group 4 if tags are present.")
4816 (defconst org-plain-time-of-day-regexp
4817 (concat
4818 "\\(\\<[012]?[0-9]"
4819 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4820 "\\(--?"
4821 "\\(\\<[012]?[0-9]"
4822 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4823 "\\)?")
4824 "Regular expression to match a plain time or time range.
4825 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4826 groups carry important information:
4827 0 the full match
4828 1 the first time, range or not
4829 8 the second time, if it is a range.")
4831 (defconst org-plain-time-extension-regexp
4832 (concat
4833 "\\(\\<[012]?[0-9]"
4834 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4835 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4836 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4837 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4838 groups carry important information:
4839 0 the full match
4840 7 hours of duration
4841 9 minutes of duration")
4843 (defconst org-stamp-time-of-day-regexp
4844 (concat
4845 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4846 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4847 "\\(--?"
4848 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4849 "Regular expression to match a timestamp time or time range.
4850 After a match, the following groups carry important information:
4851 0 the full match
4852 1 date plus weekday, for back referencing to make sure both times are on the same day
4853 2 the first time, range or not
4854 4 the second time, if it is a range.")
4856 (defconst org-startup-options
4857 '(("fold" org-startup-folded t)
4858 ("overview" org-startup-folded t)
4859 ("nofold" org-startup-folded nil)
4860 ("showall" org-startup-folded nil)
4861 ("showeverything" org-startup-folded showeverything)
4862 ("content" org-startup-folded content)
4863 ("indent" org-startup-indented t)
4864 ("noindent" org-startup-indented nil)
4865 ("hidestars" org-hide-leading-stars t)
4866 ("showstars" org-hide-leading-stars nil)
4867 ("odd" org-odd-levels-only t)
4868 ("oddeven" org-odd-levels-only nil)
4869 ("align" org-startup-align-all-tables t)
4870 ("noalign" org-startup-align-all-tables nil)
4871 ("inlineimages" org-startup-with-inline-images t)
4872 ("noinlineimages" org-startup-with-inline-images nil)
4873 ("latexpreview" org-startup-with-latex-preview t)
4874 ("nolatexpreview" org-startup-with-latex-preview nil)
4875 ("customtime" org-display-custom-times t)
4876 ("logdone" org-log-done time)
4877 ("lognotedone" org-log-done note)
4878 ("nologdone" org-log-done nil)
4879 ("lognoteclock-out" org-log-note-clock-out t)
4880 ("nolognoteclock-out" org-log-note-clock-out nil)
4881 ("logrepeat" org-log-repeat state)
4882 ("lognoterepeat" org-log-repeat note)
4883 ("logdrawer" org-log-into-drawer t)
4884 ("nologdrawer" org-log-into-drawer nil)
4885 ("logstatesreversed" org-log-states-order-reversed t)
4886 ("nologstatesreversed" org-log-states-order-reversed nil)
4887 ("nologrepeat" org-log-repeat nil)
4888 ("logreschedule" org-log-reschedule time)
4889 ("lognotereschedule" org-log-reschedule note)
4890 ("nologreschedule" org-log-reschedule nil)
4891 ("logredeadline" org-log-redeadline time)
4892 ("lognoteredeadline" org-log-redeadline note)
4893 ("nologredeadline" org-log-redeadline nil)
4894 ("logrefile" org-log-refile time)
4895 ("lognoterefile" org-log-refile note)
4896 ("nologrefile" org-log-refile nil)
4897 ("fninline" org-footnote-define-inline t)
4898 ("nofninline" org-footnote-define-inline nil)
4899 ("fnlocal" org-footnote-section nil)
4900 ("fnauto" org-footnote-auto-label t)
4901 ("fnprompt" org-footnote-auto-label nil)
4902 ("fnconfirm" org-footnote-auto-label confirm)
4903 ("fnplain" org-footnote-auto-label plain)
4904 ("fnadjust" org-footnote-auto-adjust t)
4905 ("nofnadjust" org-footnote-auto-adjust nil)
4906 ("constcgs" constants-unit-system cgs)
4907 ("constSI" constants-unit-system SI)
4908 ("noptag" org-tag-persistent-alist nil)
4909 ("hideblocks" org-hide-block-startup t)
4910 ("nohideblocks" org-hide-block-startup nil)
4911 ("beamer" org-startup-with-beamer-mode t)
4912 ("entitiespretty" org-pretty-entities t)
4913 ("entitiesplain" org-pretty-entities nil))
4914 "Variable associated with STARTUP options for org-mode.
4915 Each element is a list of three items: the startup options (as written
4916 in the #+STARTUP line), the corresponding variable, and the value to set
4917 this variable to if the option is found. An optional forth element PUSH
4918 means to push this value onto the list in the variable.")
4920 (defcustom org-group-tags t
4921 "When non-nil (the default), use group tags.
4922 This can be turned on/off through `org-toggle-tags-groups'."
4923 :group 'org-tags
4924 :group 'org-startup
4925 :type 'boolean)
4927 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4929 (defun org-toggle-tags-groups ()
4930 "Toggle support for group tags.
4931 Support for group tags is controlled by the option
4932 `org-group-tags', which is non-nil by default."
4933 (interactive)
4934 (setq org-group-tags (not org-group-tags))
4935 (cond ((and (derived-mode-p 'org-agenda-mode)
4936 org-group-tags)
4937 (org-agenda-redo))
4938 ((derived-mode-p 'org-mode)
4939 (let ((org-inhibit-startup t)) (org-mode))))
4940 (message "Groups tags support has been turned %s"
4941 (if org-group-tags "on" "off")))
4943 (defun org-set-regexps-and-options (&optional tags-only)
4944 "Precompute regular expressions used in the current buffer.
4945 When optional argument TAGS-ONLY is non-nil, only compute tags
4946 related expressions."
4947 (when (derived-mode-p 'org-mode)
4948 (let ((alist (org--setup-collect-keywords
4949 (org-make-options-regexp
4950 (append '("FILETAGS" "TAGS" "SETUPFILE")
4951 (and (not tags-only)
4952 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4953 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4954 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4955 (org--setup-process-tags
4956 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4957 (unless tags-only
4958 ;; File properties.
4959 (setq-local org-file-properties (cdr (assq 'property alist)))
4960 ;; Archive location.
4961 (let ((archive (cdr (assq 'archive alist))))
4962 (when archive (setq-local org-archive-location archive)))
4963 ;; Category.
4964 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4965 (when cat
4966 (setq-local org-category (intern cat))
4967 (setq-local org-file-properties
4968 (org--update-property-plist
4969 "CATEGORY" cat org-file-properties))))
4970 ;; Columns.
4971 (let ((column (cdr (assq 'columns alist))))
4972 (when column (setq-local org-columns-default-format column)))
4973 ;; Constants.
4974 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4975 ;; Link abbreviations.
4976 (let ((links (cdr (assq 'link alist))))
4977 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4978 ;; Priorities.
4979 (let ((priorities (cdr (assq 'priorities alist))))
4980 (when priorities
4981 (setq-local org-highest-priority (nth 0 priorities))
4982 (setq-local org-lowest-priority (nth 1 priorities))
4983 (setq-local org-default-priority (nth 2 priorities))))
4984 ;; Scripts.
4985 (let ((scripts (assq 'scripts alist)))
4986 (when scripts
4987 (setq-local org-use-sub-superscripts (cdr scripts))))
4988 ;; Startup options.
4989 (let ((startup (cdr (assq 'startup alist))))
4990 (dolist (option startup)
4991 (let ((entry (assoc-string option org-startup-options t)))
4992 (when entry
4993 (let ((var (nth 1 entry))
4994 (val (nth 2 entry)))
4995 (if (not (nth 3 entry)) (set (make-local-variable var) val)
4996 (unless (listp (symbol-value var))
4997 (set (make-local-variable var) nil))
4998 (add-to-list var val)))))))
4999 ;; TODO keywords.
5000 (setq-local org-todo-kwd-alist nil)
5001 (setq-local org-todo-key-alist nil)
5002 (setq-local org-todo-key-trigger nil)
5003 (setq-local org-todo-keywords-1 nil)
5004 (setq-local org-done-keywords nil)
5005 (setq-local org-todo-heads nil)
5006 (setq-local org-todo-sets nil)
5007 (setq-local org-todo-log-states nil)
5008 (let ((todo-sequences
5009 (or (nreverse (cdr (assq 'todo alist)))
5010 (let ((d (default-value 'org-todo-keywords)))
5011 (if (not (stringp (car d))) d
5012 ;; XXX: Backward compatibility code.
5013 (list (cons org-todo-interpretation d)))))))
5014 (dolist (sequence todo-sequences)
5015 (let* ((sequence (or (run-hook-with-args-until-success
5016 'org-todo-setup-filter-hook sequence)
5017 sequence))
5018 (sequence-type (car sequence))
5019 (keywords (cdr sequence))
5020 (sep (member "|" keywords))
5021 names alist)
5022 (dolist (k (remove "|" keywords))
5023 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5025 (error "Invalid TODO keyword %s" k))
5026 (let ((name (match-string 1 k))
5027 (key (match-string 2 k))
5028 (log (org-extract-log-state-settings k)))
5029 (push name names)
5030 (push (cons name (and key (string-to-char key))) alist)
5031 (when log (push log org-todo-log-states))))
5032 (let* ((names (nreverse names))
5033 (done (if sep (org-remove-keyword-keys (cdr sep))
5034 (last names)))
5035 (head (car names))
5036 (tail (list sequence-type head (car done) (org-last done))))
5037 (add-to-list 'org-todo-heads head 'append)
5038 (push names org-todo-sets)
5039 (setq org-done-keywords (append org-done-keywords done nil))
5040 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5041 (setq org-todo-key-alist
5042 (append org-todo-key-alist
5043 (and alist
5044 (append '((:startgroup))
5045 (nreverse alist)
5046 '((:endgroup))))))
5047 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5048 (setq org-todo-sets (nreverse org-todo-sets)
5049 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5050 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5051 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5052 ;; Compute the regular expressions and other local variables.
5053 ;; Using `org-outline-regexp-bol' would complicate them much,
5054 ;; because of the fixed white space at the end of that string.
5055 (unless org-done-keywords
5056 (setq org-done-keywords
5057 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5058 (setq org-not-done-keywords
5059 (org-delete-all org-done-keywords
5060 (copy-sequence org-todo-keywords-1))
5061 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5062 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5063 org-not-done-heading-regexp
5064 (format org-heading-keyword-regexp-format org-not-done-regexp)
5065 org-todo-line-regexp
5066 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5067 org-complex-heading-regexp
5068 (concat "^\\(\\*+\\)"
5069 "\\(?: +" org-todo-regexp "\\)?"
5070 "\\(?: +\\(\\[#.\\]\\)\\)?"
5071 "\\(?: +\\(.*?\\)\\)??"
5072 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5073 "[ \t]*$")
5074 org-complex-heading-regexp-format
5075 (concat "^\\(\\*+\\)"
5076 "\\(?: +" org-todo-regexp "\\)?"
5077 "\\(?: +\\(\\[#.\\]\\)\\)?"
5078 "\\(?: +"
5079 ;; Stats cookies can be stuck to body.
5080 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5081 "\\(%s\\)"
5082 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5083 "\\)"
5084 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5085 "[ \t]*$")
5086 org-todo-line-tags-regexp
5087 (concat "^\\(\\*+\\)"
5088 "\\(?: +" org-todo-regexp "\\)?"
5089 "\\(?: +\\(.*?\\)\\)??"
5090 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5091 "[ \t]*$"))
5092 (org-compute-latex-and-related-regexp)))))
5094 (defun org--setup-collect-keywords (regexp &optional files alist)
5095 "Return setup keywords values as an alist.
5097 REGEXP matches a subset of setup keywords. FILES is a list of
5098 file names already visited. It is used to avoid circular setup
5099 files. ALIST, when non-nil, is the alist computed so far.
5101 Return value contains the following keys: `archive', `category',
5102 `columns', `constants', `filetags', `link', `priorities',
5103 `property', `scripts', `startup', `tags' and `todo'."
5104 (org-with-wide-buffer
5105 (goto-char (point-min))
5106 (let ((case-fold-search t))
5107 (while (re-search-forward regexp nil t)
5108 (let ((element (org-element-at-point)))
5109 (when (eq (org-element-type element) 'keyword)
5110 (let ((key (org-element-property :key element))
5111 (value (org-element-property :value element)))
5112 (cond
5113 ((equal key "ARCHIVE")
5114 (when (org-string-nw-p value)
5115 (push (cons 'archive value) alist)))
5116 ((equal key "CATEGORY") (push (cons 'category value) alist))
5117 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5118 ((equal key "CONSTANTS")
5119 (let* ((constants (assq 'constants alist))
5120 (store (cdr constants)))
5121 (dolist (pair (org-split-string value))
5122 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5123 pair)
5124 (let* ((name (match-string 1 pair))
5125 (value (match-string 2 pair))
5126 (old (assoc name store)))
5127 (if old (setcdr old value)
5128 (push (cons name value) store)))))
5129 (if constants (setcdr constants store)
5130 (push (cons 'constants store) alist))))
5131 ((equal key "FILETAGS")
5132 (when (org-string-nw-p value)
5133 (let ((old (assq 'filetags alist))
5134 (new (apply #'nconc
5135 (mapcar (lambda (x) (org-split-string x ":"))
5136 (org-split-string value)))))
5137 (if old (setcdr old (append new (cdr old)))
5138 (push (cons 'filetags new) alist)))))
5139 ((equal key "LINK")
5140 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5141 (let ((links (assq 'link alist))
5142 (pair (cons (org-match-string-no-properties 1 value)
5143 (org-match-string-no-properties 2 value))))
5144 (if links (push pair (cdr links))
5145 (push (list 'link pair) alist)))))
5146 ((equal key "OPTIONS")
5147 (when (and (org-string-nw-p value)
5148 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5149 (push (cons 'scripts (read (match-string 1 value))) alist)))
5150 ((equal key "PRIORITIES")
5151 (push (cons 'priorities
5152 (let ((prio (org-split-string value)))
5153 (if (< (length prio) 3) '(?A ?C ?B)
5154 (mapcar #'string-to-char prio))))
5155 alist))
5156 ((equal key "PROPERTY")
5157 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5158 (let* ((property (assq 'property alist))
5159 (value (org--update-property-plist
5160 (org-match-string-no-properties 1 value)
5161 (org-match-string-no-properties 2 value)
5162 (cdr property))))
5163 (if property (setcdr property value)
5164 (push (cons 'property value) alist)))))
5165 ((equal key "STARTUP")
5166 (let ((startup (assq 'startup alist)))
5167 (if startup
5168 (setcdr startup
5169 (append (cdr startup) (org-split-string value)))
5170 (push (cons 'startup (org-split-string value)) alist))))
5171 ((equal key "TAGS")
5172 (let ((tag-cell (assq 'tags alist)))
5173 (if tag-cell
5174 (setcdr tag-cell
5175 (append (cdr tag-cell)
5176 '("\\n")
5177 (org-split-string value)))
5178 (push (cons 'tags (org-split-string value)) alist))))
5179 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5180 (let ((todo (assq 'todo alist))
5181 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5182 (org-split-string value))))
5183 (if todo (push value (cdr todo))
5184 (push (list 'todo value) alist))))
5185 ((equal key "SETUPFILE")
5186 (unless buffer-read-only ; Do not check in Gnus messages.
5187 (let ((f (and (org-string-nw-p value)
5188 (expand-file-name
5189 (org-remove-double-quotes value)))))
5190 (when (and f (file-readable-p f) (not (member f files)))
5191 (with-temp-buffer
5192 (setq default-directory (file-name-directory f))
5193 (insert-file-contents f)
5194 (setq alist
5195 ;; Fake Org mode to benefit from cache
5196 ;; without recurring needlessly.
5197 (let ((major-mode 'org-mode))
5198 (org--setup-collect-keywords
5199 regexp (cons f files) alist)))))))))))))))
5200 alist)
5202 (defun org--setup-process-tags (tags filetags)
5203 "Precompute variables used for tags.
5204 TAGS is a list of tags and tag group symbols, as strings.
5205 FILETAGS is a list of tags, as strings."
5206 ;; Process the file tags.
5207 (setq-local org-file-tags
5208 (mapcar #'org-add-prop-inherited filetags))
5209 ;; Provide default tags if no local tags are found.
5210 (when (and (not tags) org-tag-alist)
5211 (setq tags
5212 (mapcar (lambda (tag)
5213 (case (car tag)
5214 (:startgroup "{")
5215 (:endgroup "}")
5216 (:startgrouptag "[")
5217 (:endgrouptag "]")
5218 (:grouptags ":")
5219 (:newline "\\n")
5220 (otherwise (concat (car tag)
5221 (and (characterp (cdr tag))
5222 (format "(%c)" (cdr tag)))))))
5223 org-tag-alist)))
5224 ;; Process the tags.
5225 (setq-local org-tag-groups-alist nil)
5226 (setq-local org-tag-alist nil)
5227 (let (group-flag)
5228 (while tags
5229 (let ((e (car tags)))
5230 (setq tags (cdr tags))
5231 (cond
5232 ((equal e "{")
5233 (push '(:startgroup) org-tag-alist)
5234 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5235 ((equal e "}")
5236 (push '(:endgroup) org-tag-alist)
5237 (setq group-flag nil))
5238 ((equal e "[")
5239 (push '(:startgrouptag) org-tag-alist)
5240 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5241 ((equal e "]")
5242 (push '(:endgrouptag) org-tag-alist)
5243 (setq group-flag nil))
5244 ((equal e ":")
5245 (push '(:grouptags) org-tag-alist)
5246 (setq group-flag 'append))
5247 ((equal e "\\n") (push '(:newline) org-tag-alist))
5248 ((string-match
5249 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5250 "\\|{.+?}\\)" ; regular expression
5251 "\\(?:(\\(.\\))\\)?\\'")) e)
5252 (let ((tag (match-string 1 e))
5253 (key (and (match-beginning 2)
5254 (string-to-char (match-string 2 e)))))
5255 (cond ((eq group-flag 'append)
5256 (setcar org-tag-groups-alist
5257 (append (car org-tag-groups-alist) (list tag))))
5258 (group-flag (push (list tag) org-tag-groups-alist)))
5259 ;; Push all tags in groups, no matter if they already exist.
5260 (unless (and (not group-flag) (assoc tag org-tag-alist))
5261 (push (cons tag key) org-tag-alist))))))))
5262 (setq org-tag-alist (nreverse org-tag-alist)))
5264 (defun org-file-contents (file &optional noerror)
5265 "Return the contents of FILE, as a string."
5266 (if (and file (file-readable-p file))
5267 (with-temp-buffer
5268 (insert-file-contents file)
5269 (buffer-string))
5270 (funcall (if noerror 'message 'error)
5271 "Cannot read file \"%s\"%s"
5272 file
5273 (let ((from (buffer-file-name (buffer-base-buffer))))
5274 (if from (concat " (referenced in file \"" from "\")") "")))))
5276 (defun org-extract-log-state-settings (x)
5277 "Extract the log state setting from a TODO keyword string.
5278 This will extract info from a string like \"WAIT(w@/!)\"."
5279 (let (kw key log1 log2)
5280 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5281 (setq kw (match-string 1 x)
5282 key (and (match-end 2) (match-string 2 x))
5283 log1 (and (match-end 3) (match-string 3 x))
5284 log2 (and (match-end 4) (match-string 4 x)))
5285 (and (or log1 log2)
5286 (list kw
5287 (and log1 (if (equal log1 "!") 'time 'note))
5288 (and log2 (if (equal log2 "!") 'time 'note)))))))
5290 (defun org-remove-keyword-keys (list)
5291 "Remove a pair of parenthesis at the end of each string in LIST."
5292 (mapcar (lambda (x)
5293 (if (string-match "(.*)$" x)
5294 (substring x 0 (match-beginning 0))
5296 list))
5298 (defun org-assign-fast-keys (alist)
5299 "Assign fast keys to a keyword-key alist.
5300 Respect keys that are already there."
5301 (let (new e (alt ?0))
5302 (while (setq e (pop alist))
5303 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5304 (cdr e)) ;; Key already assigned.
5305 (push e new)
5306 (let ((clist (string-to-list (downcase (car e))))
5307 (used (append new alist)))
5308 (when (= (car clist) ?@)
5309 (pop clist))
5310 (while (and clist (rassoc (car clist) used))
5311 (pop clist))
5312 (unless clist
5313 (while (rassoc alt used)
5314 (incf alt)))
5315 (push (cons (car e) (or (car clist) alt)) new))))
5316 (nreverse new)))
5318 ;;; Some variables used in various places
5320 (defvar org-window-configuration nil
5321 "Used in various places to store a window configuration.")
5322 (defvar org-selected-window nil
5323 "Used in various places to store a window configuration.")
5324 (defvar org-finish-function nil
5325 "Function to be called when `C-c C-c' is used.
5326 This is for getting out of special buffers like capture.")
5329 ;; FIXME: Occasionally check by commenting these, to make sure
5330 ;; no other functions uses these, forgetting to let-bind them.
5331 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5332 (defvar org-last-state)
5333 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5335 ;; Defined somewhere in this file, but used before definition.
5336 (defvar org-entities) ;; defined in org-entities.el
5337 (defvar org-struct-menu)
5338 (defvar org-org-menu)
5339 (defvar org-tbl-menu)
5341 ;;;; Define the Org-mode
5343 ;; We use a before-change function to check if a table might need
5344 ;; an update.
5345 (defvar org-table-may-need-update t
5346 "Indicates that a table might need an update.
5347 This variable is set by `org-before-change-function'.
5348 `org-table-align' sets it back to nil.")
5349 (defun org-before-change-function (beg end)
5350 "Every change indicates that a table might need an update."
5351 (setq org-table-may-need-update t))
5352 (defvar org-mode-map)
5353 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5354 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5355 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5356 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5357 (defvar org-table-buffer-is-an nil)
5359 (defvar bidi-paragraph-direction)
5360 (defvar buffer-face-mode-face)
5362 (require 'outline)
5363 (when (and (not (keymapp outline-mode-map)) (featurep 'allout))
5364 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
5365 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5367 ;; Other stuff we need.
5368 (require 'time-date)
5369 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5370 (require 'easymenu)
5371 (autoload 'easy-menu-add "easymenu")
5372 (require 'overlay)
5374 ;; (require 'org-macs) moved higher up in the file before it is first used
5375 (require 'org-entities)
5376 ;; (require 'org-compat) moved higher up in the file before it is first used
5377 (require 'org-faces)
5378 (require 'org-list)
5379 (require 'org-pcomplete)
5380 (require 'org-src)
5381 (require 'org-footnote)
5382 (require 'org-macro)
5384 ;; babel
5385 (require 'ob)
5387 ;;;###autoload
5388 (define-derived-mode org-mode outline-mode "Org"
5389 "Outline-based notes management and organizer, alias
5390 \"Carsten's outline-mode for keeping track of everything.\"
5392 Org-mode develops organizational tasks around a NOTES file which
5393 contains information about projects as plain text. Org-mode is
5394 implemented on top of outline-mode, which is ideal to keep the content
5395 of large files well structured. It supports ToDo items, deadlines and
5396 time stamps, which magically appear in the diary listing of the Emacs
5397 calendar. Tables are easily created with a built-in table editor.
5398 Plain text URL-like links connect to websites, emails (VM), Usenet
5399 messages (Gnus), BBDB entries, and any files related to the project.
5400 For printing and sharing of notes, an Org-mode file (or a part of it)
5401 can be exported as a structured ASCII or HTML file.
5403 The following commands are available:
5405 \\{org-mode-map}"
5407 ;; Get rid of Outline menus, they are not needed
5408 ;; Need to do this here because define-derived-mode sets up
5409 ;; the keymap so late. Still, it is a waste to call this each time
5410 ;; we switch another buffer into org-mode.
5411 (if (featurep 'xemacs)
5412 (when (boundp 'outline-mode-menu-heading)
5413 ;; Assume this is Greg's port, it uses easymenu
5414 (easy-menu-remove outline-mode-menu-heading)
5415 (easy-menu-remove outline-mode-menu-show)
5416 (easy-menu-remove outline-mode-menu-hide))
5417 (define-key org-mode-map [menu-bar headings] 'undefined)
5418 (define-key org-mode-map [menu-bar hide] 'undefined)
5419 (define-key org-mode-map [menu-bar show] 'undefined))
5421 (org-load-modules-maybe)
5422 (when (featurep 'xemacs)
5423 (easy-menu-add org-org-menu)
5424 (easy-menu-add org-tbl-menu))
5425 (org-install-agenda-files-menu)
5426 (when org-descriptive-links (add-to-invisibility-spec '(org-link)))
5427 (add-to-invisibility-spec '(org-cwidth))
5428 (add-to-invisibility-spec '(org-hide-block . t))
5429 (when (featurep 'xemacs)
5430 (setq-local line-move-ignore-invisible t))
5431 (setq-local outline-regexp org-outline-regexp)
5432 (setq-local outline-level 'org-outline-level)
5433 (setq bidi-paragraph-direction 'left-to-right)
5434 (when (and org-ellipsis
5435 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5436 (fboundp 'make-glyph-code))
5437 (unless org-display-table
5438 (setq org-display-table (make-display-table)))
5439 (set-display-table-slot
5440 org-display-table 4
5441 (vconcat (mapcar
5442 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5443 org-ellipsis)))
5444 (if (stringp org-ellipsis) org-ellipsis "..."))))
5445 (setq buffer-display-table org-display-table))
5446 (org-set-regexps-and-options)
5447 (org-set-font-lock-defaults)
5448 (when (and org-tag-faces (not org-tags-special-faces-re))
5449 ;; tag faces set outside customize.... force initialization.
5450 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5451 ;; Calc embedded
5452 (setq-local calc-embedded-open-mode "# ")
5453 ;; Modify a few syntax entries
5454 (modify-syntax-entry ?@ "w")
5455 (modify-syntax-entry ?\" "\"")
5456 (modify-syntax-entry ?\\ "_")
5457 (modify-syntax-entry ?~ "_")
5458 (when org-startup-truncated (setq truncate-lines t))
5459 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5460 (setq-local font-lock-unfontify-region-function
5461 'org-unfontify-region)
5462 ;; Activate before-change-function
5463 (setq-local org-table-may-need-update t)
5464 (org-add-hook 'before-change-functions 'org-before-change-function nil
5465 'local)
5466 ;; Check for running clock before killing a buffer
5467 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5468 ;; Initialize macros templates.
5469 (org-macro-initialize-templates)
5470 ;; Initialize radio targets.
5471 (org-update-radio-target-regexp)
5472 ;; Indentation.
5473 (setq-local indent-line-function 'org-indent-line)
5474 (setq-local indent-region-function 'org-indent-region)
5475 ;; Filling and auto-filling.
5476 (org-setup-filling)
5477 ;; Comments.
5478 (org-setup-comments-handling)
5479 ;; Initialize cache.
5480 (org-element-cache-reset)
5481 ;; Beginning/end of defun
5482 (setq-local beginning-of-defun-function 'org-backward-element)
5483 (setq-local end-of-defun-function
5484 (lambda ()
5485 (if (not (org-at-heading-p))
5486 (org-forward-element)
5487 (org-forward-element)
5488 (forward-char -1))))
5489 ;; Next error for sparse trees
5490 (setq-local next-error-function 'org-occur-next-match)
5491 ;; Make sure dependence stuff works reliably, even for users who set it
5492 ;; too late :-(
5493 (if org-enforce-todo-dependencies
5494 (add-hook 'org-blocker-hook
5495 'org-block-todo-from-children-or-siblings-or-parent)
5496 (remove-hook 'org-blocker-hook
5497 'org-block-todo-from-children-or-siblings-or-parent))
5498 (if org-enforce-todo-checkbox-dependencies
5499 (add-hook 'org-blocker-hook
5500 'org-block-todo-from-checkboxes)
5501 (remove-hook 'org-blocker-hook
5502 'org-block-todo-from-checkboxes))
5504 ;; Align options lines
5505 (setq-local
5506 align-mode-rules-list
5507 '((org-in-buffer-settings
5508 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5509 (modes . '(org-mode)))))
5511 ;; Imenu
5512 (setq-local imenu-create-index-function
5513 'org-imenu-get-tree)
5515 ;; Make isearch reveal context
5516 (if (or (featurep 'xemacs)
5517 (not (boundp 'outline-isearch-open-invisible-function)))
5518 ;; Emacs 21 and XEmacs make use of the hook
5519 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5520 ;; Emacs 22 deals with this through a special variable
5521 (setq-local outline-isearch-open-invisible-function
5522 (lambda (&rest ignore) (org-show-context 'isearch))))
5524 ;; Setup the pcomplete hooks
5525 (setq-local pcomplete-command-completion-function
5526 'org-pcomplete-initial)
5527 (setq-local pcomplete-command-name-function
5528 'org-command-at-point)
5529 (setq-local pcomplete-default-completion-function
5530 'ignore)
5531 (setq-local pcomplete-parse-arguments-function
5532 'org-parse-arguments)
5533 (setq-local pcomplete-termination-string "")
5534 (setq-local buffer-face-mode-face 'org-default)
5536 ;; If empty file that did not turn on org-mode automatically, make it to.
5537 (when (and org-insert-mode-line-in-empty-file
5538 (org-called-interactively-p 'any)
5539 (= (point-min) (point-max)))
5540 (insert "# -*- mode: org -*-\n\n"))
5541 (unless org-inhibit-startup
5542 (org-unmodified
5543 (and org-startup-with-beamer-mode (org-beamer-mode))
5544 (when org-startup-align-all-tables
5545 (org-table-map-tables 'org-table-align 'quietly))
5546 (when org-startup-with-inline-images
5547 (org-display-inline-images))
5548 (when org-startup-with-latex-preview
5549 (org-toggle-latex-fragment))
5550 (unless org-inhibit-startup-visibility-stuff
5551 (org-set-startup-visibility))
5552 (org-refresh-effort-properties)))
5553 ;; Try to set org-hide correctly
5554 (let ((foreground (org-find-invisible-foreground)))
5555 (when foreground
5556 (set-face-foreground 'org-hide foreground))))
5558 ;; Update `customize-package-emacs-version-alist'
5559 (add-to-list 'customize-package-emacs-version-alist
5560 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5561 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5562 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5564 (defvar org-mode-transpose-word-syntax-table
5565 (let ((st (make-syntax-table text-mode-syntax-table)))
5566 (mapc (lambda(c) (modify-syntax-entry
5567 (string-to-char (car c)) "w p" st))
5568 org-emphasis-alist)
5569 st))
5571 (when (fboundp 'abbrev-table-put)
5572 (abbrev-table-put org-mode-abbrev-table
5573 :parents (list text-mode-abbrev-table)))
5575 (defun org-find-invisible-foreground ()
5576 (let ((candidates (remove
5577 "unspecified-bg"
5578 (nconc
5579 (list (face-background 'default)
5580 (face-background 'org-default))
5581 (mapcar
5582 (lambda (alist)
5583 (when (boundp alist)
5584 (cdr (assoc 'background-color (symbol-value alist)))))
5585 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5586 (list (face-foreground 'org-hide))))))
5587 (car (remove nil candidates))))
5589 (defun org-current-time (&optional rounding-minutes past)
5590 "Current time, possibly rounded to ROUNDING-MINUTES.
5591 When ROUNDING-MINUTES is not an integer, fall back on the car of
5592 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5593 the rounding returns a past time."
5594 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5595 (car org-time-stamp-rounding-minutes)))
5596 (time (decode-time)) res)
5597 (if (< r 1)
5598 (current-time)
5599 (setq res
5600 (apply 'encode-time
5601 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5602 (nthcdr 2 time))))
5603 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5604 (seconds-to-time (- (org-float-time res) (* r 60)))
5605 res))))
5607 (defun org-today ()
5608 "Return today date, considering `org-extend-today-until'."
5609 (time-to-days
5610 (time-subtract (current-time)
5611 (list 0 (* 3600 org-extend-today-until) 0))))
5613 ;;;; Font-Lock stuff, including the activators
5615 (defvar org-mouse-map (make-sparse-keymap))
5616 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5617 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5618 (when org-mouse-1-follows-link
5619 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5620 (when org-tab-follows-link
5621 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5622 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5624 (require 'font-lock)
5626 (defconst org-non-link-chars "]\t\n\r<>")
5627 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5628 "file+sys" "news" "shell" "elisp" "doi" "message"
5629 "help"))
5630 (defvar org-link-types-re nil
5631 "Matches a link that has a url-like prefix like \"http:\"")
5632 (defvar org-link-re-with-space nil
5633 "Matches a link with spaces, optional angular brackets around it.")
5634 (defvar org-link-re-with-space2 nil
5635 "Matches a link with spaces, optional angular brackets around it.")
5636 (defvar org-link-re-with-space3 nil
5637 "Matches a link with spaces, only for internal part in bracket links.")
5638 (defvar org-angle-link-re nil
5639 "Matches link with angular brackets, spaces are allowed.")
5640 (defvar org-plain-link-re nil
5641 "Matches plain link, without spaces.")
5642 (defvar org-bracket-link-regexp nil
5643 "Matches a link in double brackets.")
5644 (defvar org-bracket-link-analytic-regexp nil
5645 "Regular expression used to analyze links.
5646 Here is what the match groups contain after a match:
5647 1: http:
5648 2: http
5649 3: path
5650 4: [desc]
5651 5: desc")
5652 (defvar org-bracket-link-analytic-regexp++ nil
5653 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5654 (defvar org-any-link-re nil
5655 "Regular expression matching any link.")
5657 (defconst org-match-sexp-depth 3
5658 "Number of stacked braces for sub/superscript matching.")
5660 (defun org-create-multibrace-regexp (left right n)
5661 "Create a regular expression which will match a balanced sexp.
5662 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5663 as single character strings.
5664 The regexp returned will match the entire expression including the
5665 delimiters. It will also define a single group which contains the
5666 match except for the outermost delimiters. The maximum depth of
5667 stacked delimiters is N. Escaping delimiters is not possible."
5668 (let* ((nothing (concat "[^" left right "]*?"))
5669 (or "\\|")
5670 (re nothing)
5671 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5672 (while (> n 1)
5673 (setq n (1- n)
5674 re (concat re or next)
5675 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5676 (concat left "\\(" re "\\)" right)))
5678 (defconst org-match-substring-regexp
5679 (concat
5680 "\\(\\S-\\)\\([_^]\\)\\("
5681 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5682 "\\|"
5683 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5684 "\\|"
5685 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5686 "The regular expression matching a sub- or superscript.")
5688 (defconst org-match-substring-with-braces-regexp
5689 (concat
5690 "\\(\\S-\\)\\([_^]\\)"
5691 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5692 "The regular expression matching a sub- or superscript, forcing braces.")
5694 (defun org-make-link-regexps ()
5695 "Update the link regular expressions.
5696 This should be called after the variable `org-link-types' has changed."
5697 (let ((types-re (regexp-opt org-link-types t)))
5698 (setq org-link-types-re
5699 (concat "\\`" types-re ":")
5700 org-link-re-with-space
5701 (concat "<?" types-re ":"
5702 "\\([^" org-non-link-chars " ]"
5703 "[^" org-non-link-chars "]*"
5704 "[^" org-non-link-chars " ]\\)>?")
5705 org-link-re-with-space2
5706 (concat "<?" types-re ":"
5707 "\\([^" org-non-link-chars " ]"
5708 "[^\t\n\r]*"
5709 "[^" org-non-link-chars " ]\\)>?")
5710 org-link-re-with-space3
5711 (concat "<?" types-re ":"
5712 "\\([^" org-non-link-chars " ]"
5713 "[^\t\n\r]*\\)")
5714 org-angle-link-re
5715 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
5716 types-re)
5717 org-plain-link-re
5718 (concat
5719 "\\<" types-re ":"
5720 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5721 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5722 org-bracket-link-regexp
5723 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5724 org-bracket-link-analytic-regexp
5725 (concat
5726 "\\[\\["
5727 "\\(" types-re ":\\)?"
5728 "\\([^]]+\\)"
5729 "\\]"
5730 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5731 "\\]")
5732 org-bracket-link-analytic-regexp++
5733 (concat
5734 "\\[\\["
5735 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5736 "\\([^]]+\\)"
5737 "\\]"
5738 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5739 "\\]")
5740 org-any-link-re
5741 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5742 org-angle-link-re "\\)\\|\\("
5743 org-plain-link-re "\\)"))))
5745 (org-make-link-regexps)
5747 (defvar org-emph-face nil)
5749 (defun org-do-emphasis-faces (limit)
5750 "Run through the buffer and emphasize strings."
5751 (let (rtn a)
5752 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5753 (let* ((border (char-after (match-beginning 3)))
5754 (bre (regexp-quote (char-to-string border))))
5755 (when (and (not (= border (char-after (match-beginning 4))))
5756 (not (string-match-p (concat bre ".*" bre)
5757 (replace-regexp-in-string
5758 "\n" " "
5759 (substring (match-string 2) 1 -1)))))
5760 (setq rtn t)
5761 (setq a (assoc (match-string 3) org-emphasis-alist))
5762 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5763 'face
5764 (nth 1 a))
5765 (and (nth 2 a)
5766 (org-remove-flyspell-overlays-in
5767 (match-beginning 0) (match-end 0)))
5768 (add-text-properties (match-beginning 2) (match-end 2)
5769 '(font-lock-multiline t org-emphasis t))
5770 (when org-hide-emphasis-markers
5771 (add-text-properties (match-end 4) (match-beginning 5)
5772 '(invisible org-link))
5773 (add-text-properties (match-beginning 3) (match-end 3)
5774 '(invisible org-link)))))
5775 (goto-char (1+ (match-beginning 0))))
5776 rtn))
5778 (defun org-emphasize (&optional char)
5779 "Insert or change an emphasis, i.e. a font like bold or italic.
5780 If there is an active region, change that region to a new emphasis.
5781 If there is no region, just insert the marker characters and position
5782 the cursor between them.
5783 CHAR should be the marker character. If it is a space, it means to
5784 remove the emphasis of the selected region.
5785 If CHAR is not given (for example in an interactive call) it will be
5786 prompted for."
5787 (interactive)
5788 (let ((erc org-emphasis-regexp-components)
5789 (prompt "")
5790 (string "") beg end move c s)
5791 (if (org-region-active-p)
5792 (setq beg (region-beginning) end (region-end)
5793 string (buffer-substring beg end))
5794 (setq move t))
5796 (unless char
5797 (message "Emphasis marker or tag: [%s]"
5798 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5799 (setq char (read-char-exclusive)))
5800 (if (equal char ?\ )
5801 (setq s "" move nil)
5802 (unless (assoc (char-to-string char) org-emphasis-alist)
5803 (user-error "No such emphasis marker: \"%c\"" char))
5804 (setq s (char-to-string char)))
5805 (while (and (> (length string) 1)
5806 (equal (substring string 0 1) (substring string -1))
5807 (assoc (substring string 0 1) org-emphasis-alist))
5808 (setq string (substring string 1 -1)))
5809 (setq string (concat s string s))
5810 (when beg (delete-region beg end))
5811 (unless (or (bolp)
5812 (string-match (concat "[" (nth 0 erc) "\n]")
5813 (char-to-string (char-before (point)))))
5814 (insert " "))
5815 (unless (or (eobp)
5816 (string-match (concat "[" (nth 1 erc) "\n]")
5817 (char-to-string (char-after (point)))))
5818 (insert " ") (backward-char 1))
5819 (insert string)
5820 (and move (backward-char 1))))
5822 (defconst org-nonsticky-props
5823 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5825 (defsubst org-rear-nonsticky-at (pos)
5826 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5828 (defun org-activate-plain-links (limit)
5829 "Add link properties for plain links."
5830 (let (f hl)
5831 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5832 (not (member 'org-tag
5833 (get-text-property (1- (match-beginning 0)) 'face)))
5834 (not (org-in-src-block-p)))
5835 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5836 (setq f (get-text-property (match-beginning 0) 'face))
5837 (setq hl (org-match-string-no-properties 0))
5838 (unless (or (eq f 'org-tag)
5839 (and (listp f) (memq 'org-tag f)))
5840 (add-text-properties (match-beginning 0) (match-end 0)
5841 (list 'mouse-face 'highlight
5842 'face 'org-link
5843 'htmlize-link `(:uri ,hl)
5844 'keymap org-mouse-map))
5845 (org-rear-nonsticky-at (match-end 0)))
5846 t)))
5848 (defun org-activate-code (limit)
5849 (when (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5850 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5851 (remove-text-properties (match-beginning 0) (match-end 0)
5852 '(display t invisible t intangible t))
5855 (defcustom org-src-fontify-natively t
5856 "When non-nil, fontify code in code blocks."
5857 :type 'boolean
5858 :version "24.4"
5859 :package-version '(Org . "8.3")
5860 :group 'org-appearance
5861 :group 'org-babel)
5863 (defcustom org-allow-promoting-top-level-subtree nil
5864 "When non-nil, allow promoting a top level subtree.
5865 The leading star of the top level headline will be replaced
5866 by a #."
5867 :type 'boolean
5868 :version "24.1"
5869 :group 'org-appearance)
5871 (defun org-fontify-meta-lines-and-blocks (limit)
5872 (condition-case nil
5873 (org-fontify-meta-lines-and-blocks-1 limit)
5874 (error (message "org-mode fontification error"))))
5876 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5877 "Fontify #+ lines and blocks."
5878 (let ((case-fold-search t))
5879 (when (re-search-forward
5880 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5881 limit t)
5882 (let ((beg (match-beginning 0))
5883 (block-start (match-end 0))
5884 (block-end nil)
5885 (lang (match-string 7))
5886 (beg1 (line-beginning-position 2))
5887 (dc1 (downcase (match-string 2)))
5888 (dc3 (downcase (match-string 3)))
5889 end end1 quoting block-type ovl)
5890 (cond
5891 ((and (match-end 4) (equal dc3 "+begin"))
5892 ;; Truly a block
5893 (setq block-type (downcase (match-string 5))
5894 quoting (member block-type org-protecting-blocks))
5895 (when (re-search-forward
5896 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5897 nil t) ;; on purpose, we look further than LIMIT
5898 (setq end (min (point-max) (match-end 0))
5899 end1 (min (point-max) (1- (match-beginning 0))))
5900 (setq block-end (match-beginning 0))
5901 (when quoting
5902 (org-remove-flyspell-overlays-in beg1 end1)
5903 (remove-text-properties beg end
5904 '(display t invisible t intangible t)))
5905 (add-text-properties
5906 beg end '(font-lock-fontified t font-lock-multiline t))
5907 (add-text-properties beg beg1 '(face org-meta-line))
5908 (org-remove-flyspell-overlays-in beg beg1)
5909 (add-text-properties ; For end_src
5910 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5911 (org-remove-flyspell-overlays-in end1 end)
5912 (cond
5913 ((and lang (not (string= lang "")) org-src-fontify-natively)
5914 (org-src-font-lock-fontify-block lang block-start block-end)
5915 (add-text-properties beg1 block-end '(src-block t)))
5916 (quoting
5917 (add-text-properties beg1 (min (point-max) (1+ end1))
5918 '(face org-block))) ; end of source block
5919 ((not org-fontify-quote-and-verse-blocks))
5920 ((string= block-type "quote")
5921 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5922 ((string= block-type "verse")
5923 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5924 (add-text-properties beg beg1 '(face org-block-begin-line))
5925 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5926 '(face org-block-end-line))
5928 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5929 (org-remove-flyspell-overlays-in
5930 (match-beginning 0)
5931 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5932 (add-text-properties
5933 beg (match-end 3)
5934 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5935 '(font-lock-fontified t invisible t)
5936 '(font-lock-fontified t face org-document-info-keyword)))
5937 (add-text-properties
5938 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5939 (if (string-equal dc1 "+title:")
5940 '(font-lock-fontified t face org-document-title)
5941 '(font-lock-fontified t face org-document-info))))
5942 ((equal dc1 "+caption:")
5943 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5944 (remove-text-properties (match-beginning 0) (match-end 0)
5945 '(display t invisible t intangible t))
5946 (add-text-properties (match-beginning 1) (match-end 3)
5947 '(font-lock-fontified t face org-meta-line))
5948 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5949 '(font-lock-fontified t face org-block))
5951 ((member dc3 '(" " ""))
5952 (org-remove-flyspell-overlays-in beg (match-end 0))
5953 (add-text-properties
5954 beg (match-end 0)
5955 '(font-lock-fontified t face font-lock-comment-face)))
5956 (t ;; just any other in-buffer setting, but not indented
5957 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5958 (remove-text-properties (match-beginning 0) (match-end 0)
5959 '(display t invisible t intangible t))
5960 (add-text-properties beg (match-end 0)
5961 '(font-lock-fontified t face org-meta-line))
5962 t))))))
5964 (defun org-fontify-drawers (limit)
5965 "Fontify drawers."
5966 (when (re-search-forward org-drawer-regexp limit t)
5967 (add-text-properties
5968 (match-beginning 0) (match-end 0)
5969 '(font-lock-fontified t face org-special-keyword))
5970 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5973 (defun org-fontify-macros (limit)
5974 "Fontify macros."
5975 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5976 (add-text-properties
5977 (match-beginning 0) (match-end 0)
5978 '(font-lock-fontified t face org-macro))
5979 (when org-hide-macro-markers
5980 (add-text-properties (match-end 2) (match-beginning 2)
5981 '(invisible t))
5982 (add-text-properties (match-beginning 1) (match-end 1)
5983 '(invisible t)))
5984 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5987 (defun org-activate-angle-links (limit)
5988 "Add text properties for angle links."
5989 (when (and (re-search-forward org-angle-link-re limit t)
5990 (not (org-in-src-block-p)))
5991 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5992 (add-text-properties (match-beginning 0) (match-end 0)
5993 (list 'mouse-face 'highlight
5994 'keymap org-mouse-map
5995 'font-lock-multiline t))
5996 (org-rear-nonsticky-at (match-end 0))
5999 (defun org-activate-footnote-links (limit)
6000 "Add text properties for footnotes."
6001 (let ((fn (org-footnote-next-reference-or-definition limit)))
6002 (when fn
6003 (let* ((beg (nth 1 fn))
6004 (end (nth 2 fn))
6005 (label (car fn))
6006 (referencep (/= (line-beginning-position) beg)))
6007 (when (and referencep (nth 3 fn))
6008 (save-excursion
6009 (goto-char beg)
6010 (search-forward (or label "fn:"))
6011 (org-remove-flyspell-overlays-in beg (match-end 0))))
6012 (add-text-properties beg end
6013 (list 'mouse-face 'highlight
6014 'keymap org-mouse-map
6015 'help-echo
6016 (if referencep "Footnote reference"
6017 "Footnote definition")
6018 'font-lock-fontified t
6019 'font-lock-multiline t
6020 'face 'org-footnote))))))
6022 (defun org-activate-bracket-links (limit)
6023 "Add text properties for bracketed links."
6024 (when (and (re-search-forward org-bracket-link-regexp limit t)
6025 (not (org-in-src-block-p)))
6026 (let* ((hl (org-match-string-no-properties 1))
6027 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6028 (ip (org-maybe-intangible
6029 (list 'invisible 'org-link
6030 'keymap org-mouse-map 'mouse-face 'highlight
6031 'font-lock-multiline t 'help-echo help
6032 'htmlize-link `(:uri ,hl))))
6033 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6034 'font-lock-multiline t 'help-echo help
6035 'htmlize-link `(:uri ,hl))))
6036 ;; We need to remove the invisible property here. Table narrowing
6037 ;; may have made some of this invisible.
6038 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6039 (remove-text-properties (match-beginning 0) (match-end 0)
6040 '(invisible nil))
6041 (if (match-end 3)
6042 (progn
6043 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6044 (org-rear-nonsticky-at (match-beginning 3))
6045 (add-text-properties (match-beginning 3) (match-end 3) vp)
6046 (org-rear-nonsticky-at (match-end 3))
6047 (add-text-properties (match-end 3) (match-end 0) ip)
6048 (org-rear-nonsticky-at (match-end 0)))
6049 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6050 (org-rear-nonsticky-at (match-beginning 1))
6051 (add-text-properties (match-beginning 1) (match-end 1) vp)
6052 (org-rear-nonsticky-at (match-end 1))
6053 (add-text-properties (match-end 1) (match-end 0) ip)
6054 (org-rear-nonsticky-at (match-end 0)))
6055 t)))
6057 (defun org-activate-dates (limit)
6058 "Add text properties for dates."
6059 (when (and (re-search-forward org-tsr-regexp-both limit t)
6060 (not (equal (char-before (match-beginning 0)) 91)))
6061 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6062 (add-text-properties (match-beginning 0) (match-end 0)
6063 (list 'mouse-face 'highlight
6064 'keymap org-mouse-map))
6065 (org-rear-nonsticky-at (match-end 0))
6066 (when org-display-custom-times
6067 (if (match-end 3)
6068 (org-display-custom-time (match-beginning 3) (match-end 3))
6069 (org-display-custom-time (match-beginning 1) (match-end 1))))
6072 (defvar-local org-target-link-regexp nil
6073 "Regular expression matching radio targets in plain text.")
6075 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6076 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6077 border border border))
6078 "Regular expression matching a link target.")
6080 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6081 "Regular expression matching a radio target.")
6083 (defconst org-any-target-regexp
6084 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6085 "Regular expression matching any target.")
6087 (defun org-activate-target-links (limit)
6088 "Add text properties for target matches."
6089 (when org-target-link-regexp
6090 (let ((case-fold-search t))
6091 (when (re-search-forward org-target-link-regexp limit t)
6092 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6093 (add-text-properties (match-beginning 1) (match-end 1)
6094 (list 'mouse-face 'highlight
6095 'keymap org-mouse-map
6096 'help-echo "Radio target link"
6097 'org-linked-text t))
6098 (org-rear-nonsticky-at (match-end 1))
6099 t))))
6101 (defun org-update-radio-target-regexp ()
6102 "Find all radio targets in this file and update the regular expression.
6103 Also refresh fontification if needed."
6104 (interactive)
6105 (let ((old-regexp org-target-link-regexp)
6106 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6107 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6108 (targets
6109 (org-with-wide-buffer
6110 (goto-char (point-min))
6111 (let (rtn)
6112 (while (re-search-forward org-radio-target-regexp nil t)
6113 ;; Make sure point is really within the object.
6114 (backward-char)
6115 (let ((obj (org-element-context)))
6116 (when (eq (org-element-type obj) 'radio-target)
6117 (add-to-list 'rtn (org-element-property :value obj)))))
6118 rtn))))
6119 (setq org-target-link-regexp
6120 (and targets
6121 (concat before-re
6122 (mapconcat
6123 (lambda (x)
6124 (replace-regexp-in-string
6125 " +" "\\s-+" (regexp-quote x) t t))
6126 targets
6127 "\\|")
6128 after-re)))
6129 (unless (equal old-regexp org-target-link-regexp)
6130 ;; Clean-up cache.
6131 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6132 ((not org-target-link-regexp) old-regexp)
6134 (concat before-re
6135 (mapconcat
6136 (lambda (re)
6137 (substring re (length before-re)
6138 (- (length after-re))))
6139 (list old-regexp org-target-link-regexp)
6140 "\\|")
6141 after-re)))))
6142 (org-with-wide-buffer
6143 (goto-char (point-min))
6144 (while (re-search-forward regexp nil t)
6145 (org-element-cache-refresh (match-beginning 1)))))
6146 ;; Re fontify buffer.
6147 (when (memq 'radio org-highlight-links)
6148 (org-restart-font-lock)))))
6150 (defun org-hide-wide-columns (limit)
6151 (let (s e)
6152 (setq s (text-property-any (point) (or limit (point-max))
6153 'org-cwidth t))
6154 (when s
6155 (setq e (next-single-property-change s 'org-cwidth))
6156 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6157 (goto-char e)
6158 t)))
6160 (defvar org-latex-and-related-regexp nil
6161 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6163 (defun org-compute-latex-and-related-regexp ()
6164 "Compute regular expression for LaTeX, entities and sub/superscript.
6165 Result depends on variable `org-highlight-latex-and-related'."
6166 (setq-local
6167 org-latex-and-related-regexp
6168 (let* ((re-sub
6169 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6170 ((eq org-use-sub-superscripts '{})
6171 (list org-match-substring-with-braces-regexp))
6172 (org-use-sub-superscripts (list org-match-substring-regexp))))
6173 (re-latex
6174 (when (memq 'latex org-highlight-latex-and-related)
6175 (let ((matchers (plist-get org-format-latex-options :matchers)))
6176 (delq nil
6177 (mapcar (lambda (x)
6178 (and (member (car x) matchers) (nth 1 x)))
6179 org-latex-regexps)))))
6180 (re-entities
6181 (when (memq 'entities org-highlight-latex-and-related)
6182 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6183 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6185 (defun org-do-latex-and-related (limit)
6186 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6187 LIMIT bounds the search for syntax to highlight. Stop at first
6188 highlighted object, if any. Return t if some highlighting was
6189 done, nil otherwise."
6190 (when (org-string-nw-p org-latex-and-related-regexp)
6191 (catch 'found
6192 (while (re-search-forward org-latex-and-related-regexp limit t)
6193 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6194 'face))
6195 '(org-code org-verbatim underline))
6196 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6197 '(?_ ?^))
6199 0)))
6200 (font-lock-prepend-text-property
6201 (+ offset (match-beginning 0)) (match-end 0)
6202 'face 'org-latex-and-related)
6203 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6204 '(font-lock-multiline t)))
6205 (throw 'found t)))
6206 nil)))
6208 (defun org-restart-font-lock ()
6209 "Restart `font-lock-mode', to force refontification."
6210 (when (and (boundp 'font-lock-mode) font-lock-mode)
6211 (font-lock-mode -1)
6212 (font-lock-mode 1)))
6214 (defun org-activate-tags (limit)
6215 (when (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6216 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6217 (add-text-properties (match-beginning 1) (match-end 1)
6218 (list 'mouse-face 'highlight
6219 'keymap org-mouse-map))
6220 (org-rear-nonsticky-at (match-end 1))
6223 (defun org-outline-level ()
6224 "Compute the outline level of the heading at point.
6226 If this is called at a normal headline, the level is the number
6227 of stars. Use `org-reduced-level' to remove the effect of
6228 `org-odd-levels'. Unlike to `org-current-level', this function
6229 takes into consideration inlinetasks."
6230 (org-with-wide-buffer
6231 (end-of-line)
6232 (if (re-search-backward org-outline-regexp-bol nil t)
6233 (1- (- (match-end 0) (match-beginning 0)))
6234 0)))
6236 (defvar org-font-lock-keywords nil)
6238 (defsubst org-re-property (property &optional literal allow-null value)
6239 "Return a regexp matching a PROPERTY line.
6241 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6242 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6243 non-nil, match properties even without a value.
6245 Match group 3 is set to the value when it exists. If there is no
6246 value and ALLOW-NULL is non-nil, it is set to the empty string.
6248 With optional argument VALUE, match only property lines with
6249 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6250 unless LITERAL is non-nil."
6251 (concat
6252 "^\\(?4:[ \t]*\\)"
6253 (format "\\(?1::\\(?2:%s\\):\\)"
6254 (if literal property (regexp-quote property)))
6255 (cond (value
6256 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6257 (if literal value (regexp-quote value))))
6258 (allow-null
6259 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6261 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6263 (defconst org-property-re
6264 (org-re-property "\\S-+" 'literal t)
6265 "Regular expression matching a property line.
6266 There are four matching groups:
6267 1: :PROPKEY: including the leading and trailing colon,
6268 2: PROPKEY without the leading and trailing colon,
6269 3: PROPVAL without leading or trailing spaces,
6270 4: the indentation of the current line,
6271 5: trailing whitespace.")
6273 (defvar org-font-lock-hook nil
6274 "Functions to be called for special font lock stuff.")
6276 (defvar org-font-lock-set-keywords-hook nil
6277 "Functions that can manipulate `org-font-lock-extra-keywords'.
6278 This is called after `org-font-lock-extra-keywords' is defined, but before
6279 it is installed to be used by font lock. This can be useful if something
6280 needs to be inserted at a specific position in the font-lock sequence.")
6282 (defun org-font-lock-hook (limit)
6283 "Run `org-font-lock-hook' within LIMIT."
6284 (run-hook-with-args 'org-font-lock-hook limit))
6286 (defun org-set-font-lock-defaults ()
6287 "Set font lock defaults for the current buffer."
6288 (let* ((em org-fontify-emphasized-text)
6289 (lk org-highlight-links)
6290 (org-font-lock-extra-keywords
6291 (list
6292 ;; Call the hook
6293 '(org-font-lock-hook)
6294 ;; Headlines
6295 `(,(if org-fontify-whole-heading-line
6296 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6297 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6298 (1 (org-get-level-face 1))
6299 (2 (org-get-level-face 2))
6300 (3 (org-get-level-face 3)))
6301 ;; Table lines
6302 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6303 (1 'org-table t))
6304 ;; Table internals
6305 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6306 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6307 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6308 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6309 ;; Drawers
6310 '(org-fontify-drawers)
6311 ;; Properties
6312 (list org-property-re
6313 '(1 'org-special-keyword t)
6314 '(3 'org-property-value t))
6315 ;; Links
6316 (when (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6317 (when (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6318 (when (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6319 (when (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6320 (when (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6321 (when (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6322 (when (memq 'footnote lk) '(org-activate-footnote-links))
6323 ;; Targets.
6324 (list org-any-target-regexp '(0 'org-target t))
6325 ;; Diary sexps.
6326 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6327 ;; Macro
6328 '(org-fontify-macros)
6329 '(org-hide-wide-columns (0 nil append))
6330 ;; TODO keyword
6331 (list (format org-heading-keyword-regexp-format
6332 org-todo-regexp)
6333 '(2 (org-get-todo-face 2) t))
6334 ;; DONE
6335 (if org-fontify-done-headline
6336 (list (format org-heading-keyword-regexp-format
6337 (concat
6338 "\\(?:"
6339 (mapconcat 'regexp-quote org-done-keywords "\\|")
6340 "\\)"))
6341 '(2 'org-headline-done t))
6342 nil)
6343 ;; Priorities
6344 '(org-font-lock-add-priority-faces)
6345 ;; Tags
6346 '(org-font-lock-add-tag-faces)
6347 ;; Tags groups
6348 (when (and org-group-tags org-tag-groups-alist)
6349 (list (concat org-outline-regexp-bol ".+\\(:"
6350 (regexp-opt (mapcar 'car org-tag-groups-alist))
6351 ":\\).*$")
6352 '(1 'org-tag-group prepend)))
6353 ;; Special keywords
6354 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6355 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6356 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6357 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6358 ;; Emphasis
6359 (when em
6360 (if (featurep 'xemacs)
6361 '(org-do-emphasis-faces (0 nil append))
6362 '(org-do-emphasis-faces)))
6363 ;; Checkboxes
6364 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6365 1 'org-checkbox prepend)
6366 (when (cdr (assq 'checkbox org-list-automatic-rules))
6367 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6368 (0 (org-get-checkbox-statistics-face) t)))
6369 ;; Description list items
6370 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6371 1 'org-list-dt prepend)
6372 ;; ARCHIVEd headings
6373 (list (concat
6374 org-outline-regexp-bol
6375 "\\(.*:" org-archive-tag ":.*\\)")
6376 '(1 'org-archived prepend))
6377 ;; Specials
6378 '(org-do-latex-and-related)
6379 '(org-fontify-entities)
6380 '(org-raise-scripts)
6381 ;; Code
6382 '(org-activate-code (1 'org-code t))
6383 ;; COMMENT
6384 (list (format
6385 "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6386 org-todo-regexp
6387 org-comment-string)
6388 '(9 'org-special-keyword t))
6389 ;; Blocks and meta lines
6390 '(org-fontify-meta-lines-and-blocks))))
6391 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6392 (run-hooks 'org-font-lock-set-keywords-hook)
6393 ;; Now set the full font-lock-keywords
6394 (setq-local org-font-lock-keywords org-font-lock-extra-keywords)
6395 (setq-local font-lock-defaults
6396 '(org-font-lock-keywords t nil nil backward-paragraph))
6397 (kill-local-variable 'font-lock-keywords) nil))
6399 (defun org-toggle-pretty-entities ()
6400 "Toggle the composition display of entities as UTF8 characters."
6401 (interactive)
6402 (setq-local org-pretty-entities (not org-pretty-entities))
6403 (org-restart-font-lock)
6404 (if org-pretty-entities
6405 (message "Entities are now displayed as UTF8 characters")
6406 (save-restriction
6407 (widen)
6408 (org-decompose-region (point-min) (point-max))
6409 (message "Entities are now displayed as plain text"))))
6411 (defvar-local org-custom-properties-overlays nil
6412 "List of overlays used for custom properties.")
6414 (defun org-toggle-custom-properties-visibility ()
6415 "Display or hide properties in `org-custom-properties'."
6416 (interactive)
6417 (if org-custom-properties-overlays
6418 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6419 (setq org-custom-properties-overlays nil))
6420 (when org-custom-properties
6421 (org-with-wide-buffer
6422 (goto-char (point-min))
6423 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6424 (while (re-search-forward regexp nil t)
6425 (let ((end (cdr (save-match-data (org-get-property-block)))))
6426 (when (and end (< (point) end))
6427 ;; Hide first custom property in current drawer.
6428 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6429 (overlay-put o 'invisible t)
6430 (overlay-put o 'org-custom-property t)
6431 (push o org-custom-properties-overlays))
6432 ;; Hide additional custom properties in the same drawer.
6433 (while (re-search-forward regexp end t)
6434 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6435 (overlay-put o 'invisible t)
6436 (overlay-put o 'org-custom-property t)
6437 (push o org-custom-properties-overlays)))))
6438 ;; Each entry is limited to a single property drawer.
6439 (outline-next-heading)))))))
6441 (defun org-fontify-entities (limit)
6442 "Find an entity to fontify."
6443 (let (ee)
6444 (when org-pretty-entities
6445 (catch 'match
6446 ;; "\_ "-family is left out on purpose. Only the first one,
6447 ;; i.e., "\_ ", could be fontified anyway, and it would be
6448 ;; confusing when adding a second white space character.
6449 (while (re-search-forward
6450 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6451 limit t)
6452 (when (and (not (org-at-comment-p))
6453 (setq ee (org-entity-get (match-string 1)))
6454 (= (length (nth 6 ee)) 1))
6455 (let* ((end (if (equal (match-string 2) "{}")
6456 (match-end 2)
6457 (match-end 1))))
6458 (add-text-properties
6459 (match-beginning 0) end
6460 (list 'font-lock-fontified t))
6461 (compose-region (match-beginning 0) end
6462 (nth 6 ee) nil)
6463 (backward-char 1)
6464 (throw 'match t))))
6465 nil))))
6467 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6468 "Fontify string S like in Org-mode."
6469 (with-temp-buffer
6470 (insert s)
6471 (let ((org-odd-levels-only odd-levels))
6472 (org-mode)
6473 (font-lock-ensure)
6474 (buffer-string))))
6476 (defvar org-m nil)
6477 (defvar org-l nil)
6478 (defvar org-f nil)
6479 (defun org-get-level-face (n)
6480 "Get the right face for match N in font-lock matching of headlines."
6481 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6482 (when org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6483 (if org-cycle-level-faces
6484 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6485 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6486 (cond
6487 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6488 ((eq n 2) org-f)
6489 (t (unless org-level-color-stars-only org-f))))
6491 (defun org-face-from-face-or-color (context inherit face-or-color)
6492 "Create a face list that inherits INHERIT, but sets the foreground color.
6493 When FACE-OR-COLOR is not a string, just return it."
6494 (if (stringp face-or-color)
6495 (list :inherit inherit
6496 (cdr (assoc context org-faces-easy-properties))
6497 face-or-color)
6498 face-or-color))
6500 (defun org-get-todo-face (kwd)
6501 "Get the right face for a TODO keyword KWD.
6502 If KWD is a number, get the corresponding match group."
6503 (when (numberp kwd) (setq kwd (match-string kwd)))
6504 (or (org-face-from-face-or-color
6505 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6506 (and (member kwd org-done-keywords) 'org-done)
6507 'org-todo))
6509 (defun org-get-priority-face (priority)
6510 "Get the right face for PRIORITY.
6511 PRIORITY is a character."
6512 (or (org-face-from-face-or-color
6513 'priority 'org-priority (cdr (assq priority org-priority-faces)))
6514 'org-priority))
6516 (defun org-get-tag-face (tag)
6517 "Get the right face for TAG.
6518 If TAG is a number, get the corresponding match group."
6519 (let ((tag (if (wholenump tag) (match-string tag) tag)))
6520 (or (org-face-from-face-or-color
6521 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
6522 'org-tag)))
6524 (defun org-font-lock-add-priority-faces (limit)
6525 "Add the special priority faces."
6526 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
6527 (add-text-properties
6528 (match-beginning 1) (match-end 1)
6529 (list 'face (org-get-priority-face (string-to-char (match-string 2)))
6530 'font-lock-fontified t))))
6532 (defun org-font-lock-add-tag-faces (limit)
6533 "Add the special tag faces."
6534 (when (and org-tag-faces org-tags-special-faces-re)
6535 (while (re-search-forward org-tags-special-faces-re limit t)
6536 (add-text-properties (match-beginning 1) (match-end 1)
6537 (list 'face (org-get-tag-face 1)
6538 'font-lock-fontified t))
6539 (backward-char 1))))
6541 (defun org-unfontify-region (beg end &optional maybe_loudly)
6542 "Remove fontification and activation overlays from links."
6543 (font-lock-default-unfontify-region beg end)
6544 (let* ((buffer-undo-list t)
6545 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6546 (inhibit-modification-hooks t)
6547 deactivate-mark buffer-file-name buffer-file-truename)
6548 (org-decompose-region beg end)
6549 (remove-text-properties beg end
6550 '(mouse-face t keymap t org-linked-text t
6551 invisible t intangible t
6552 org-emphasis t))
6553 (org-remove-font-lock-display-properties beg end)))
6555 (defconst org-script-display '(((raise -0.3) (height 0.7))
6556 ((raise 0.3) (height 0.7))
6557 ((raise -0.5))
6558 ((raise 0.5)))
6559 "Display properties for showing superscripts and subscripts.")
6561 (defun org-remove-font-lock-display-properties (beg end)
6562 "Remove specific display properties that have been added by font lock.
6563 The will remove the raise properties that are used to show superscripts
6564 and subscripts."
6565 (let (next prop)
6566 (while (< beg end)
6567 (setq next (next-single-property-change beg 'display nil end)
6568 prop (get-text-property beg 'display))
6569 (when (member prop org-script-display)
6570 (put-text-property beg next 'display nil))
6571 (setq beg next))))
6573 (defun org-raise-scripts (limit)
6574 "Add raise properties to sub/superscripts."
6575 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
6576 (re-search-forward
6577 (if (eq org-use-sub-superscripts t)
6578 org-match-substring-regexp
6579 org-match-substring-with-braces-regexp)
6580 limit t))
6581 (let* ((pos (point)) table-p comment-p
6582 (mpos (match-beginning 3))
6583 (emph-p (get-text-property mpos 'org-emphasis))
6584 (link-p (get-text-property mpos 'mouse-face))
6585 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6586 (goto-char (point-at-bol))
6587 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6588 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6589 (goto-char pos)
6590 ;; Handle a_b^c
6591 (when (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6592 (unless (or comment-p emph-p link-p keyw-p)
6593 (put-text-property (match-beginning 3) (match-end 0)
6594 'display
6595 (if (equal (char-after (match-beginning 2)) ?^)
6596 (nth (if table-p 3 1) org-script-display)
6597 (nth (if table-p 2 0) org-script-display)))
6598 (add-text-properties (match-beginning 2) (match-end 2)
6599 (list 'invisible t
6600 'org-dwidth t 'org-dwidth-n 1))
6601 (if (and (eq (char-after (match-beginning 3)) ?{)
6602 (eq (char-before (match-end 3)) ?}))
6603 (progn
6604 (add-text-properties
6605 (match-beginning 3) (1+ (match-beginning 3))
6606 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6607 (add-text-properties
6608 (1- (match-end 3)) (match-end 3)
6609 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1)))))
6610 t)))
6612 ;;;; Visibility cycling, including org-goto and indirect buffer
6614 ;;; Cycling
6616 (defvar-local org-cycle-global-status nil)
6617 (put 'org-cycle-global-status 'org-state t)
6618 (defvar-local org-cycle-subtree-status nil)
6619 (put 'org-cycle-subtree-status 'org-state t)
6621 (defvar org-inlinetask-min-level)
6623 (defun org-unlogged-message (&rest args)
6624 "Display a message, but avoid logging it in the *Messages* buffer."
6625 (let ((message-log-max nil))
6626 (apply 'message args)))
6628 ;;;###autoload
6629 (defun org-cycle (&optional arg)
6630 "TAB-action and visibility cycling for Org-mode.
6632 This is the command invoked in Org-mode by the TAB key. Its main purpose
6633 is outline visibility cycling, but it also invokes other actions
6634 in special contexts.
6636 - When this function is called with a prefix argument, rotate the entire
6637 buffer through 3 states (global cycling)
6638 1. OVERVIEW: Show only top-level headlines.
6639 2. CONTENTS: Show all headlines of all levels, but no body text.
6640 3. SHOW ALL: Show everything.
6641 With a double \\[universal-argument] prefix argument, \
6642 switch to the startup visibility,
6643 determined by the variable `org-startup-folded', and by any VISIBILITY
6644 properties in the buffer.
6645 With a triple \\[universal-argument] prefix argument, \
6646 show the entire buffer, including any drawers.
6648 - When inside a table, re-align the table and move to the next field.
6650 - When point is at the beginning of a headline, rotate the subtree started
6651 by this line through 3 different states (local cycling)
6652 1. FOLDED: Only the main headline is shown.
6653 2. CHILDREN: The main headline and the direct children are shown.
6654 From this state, you can move to one of the children
6655 and zoom in further.
6656 3. SUBTREE: Show the entire subtree, including body text.
6657 If there is no subtree, switch directly from CHILDREN to FOLDED.
6659 - When point is at the beginning of an empty headline and the variable
6660 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6661 of the headline by demoting and promoting it to likely levels. This
6662 speeds up creation document structure by pressing TAB once or several
6663 times right after creating a new headline.
6665 - When there is a numeric prefix, go up to a heading with level ARG, do
6666 a `show-subtree' and return to the previous cursor position. If ARG
6667 is negative, go up that many levels.
6669 - When point is not at the beginning of a headline, execute the global
6670 binding for TAB, which is re-indenting the line. See the option
6671 `org-cycle-emulate-tab' for details.
6673 - Special case: if point is at the beginning of the buffer and there is
6674 no headline in line 1, this function will act as if called with prefix arg
6675 (\\[universal-argument] TAB, same as S-TAB) also when called without prefix arg.
6676 But only if also the variable `org-cycle-global-at-bob' is t."
6677 (interactive "P")
6678 (org-load-modules-maybe)
6679 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6680 (and org-cycle-level-after-item/entry-creation
6681 (or (org-cycle-level)
6682 (org-cycle-item-indentation))))
6683 (let* ((limit-level
6684 (or org-cycle-max-level
6685 (and (boundp 'org-inlinetask-min-level)
6686 org-inlinetask-min-level
6687 (1- org-inlinetask-min-level))))
6688 (nstars (and limit-level
6689 (if org-odd-levels-only
6690 (and limit-level (1- (* limit-level 2)))
6691 limit-level)))
6692 (org-outline-regexp
6693 (if (not (derived-mode-p 'org-mode))
6694 outline-regexp
6695 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6696 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6697 (not (looking-at org-outline-regexp))))
6698 (org-cycle-hook
6699 (if bob-special
6700 (delq 'org-optimize-window-after-visibility-change
6701 (copy-sequence org-cycle-hook))
6702 org-cycle-hook))
6703 (pos (point)))
6705 (when (or bob-special (equal arg '(4)))
6706 ;; special case: use global cycling
6707 (setq arg t))
6709 (cond
6711 ((equal arg '(16))
6712 (setq last-command 'dummy)
6713 (org-set-startup-visibility)
6714 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6716 ((equal arg '(64))
6717 (outline-show-all)
6718 (org-unlogged-message "Entire buffer visible, including drawers"))
6720 ;; Try cdlatex TAB completion
6721 ((org-try-cdlatex-tab))
6723 ;; Table: enter it or move to the next field.
6724 ((org-at-table-p 'any)
6725 (if (org-at-table.el-p)
6726 (message "%s" (substitute-command-keys "\\<org-mode-map>\
6727 Use \\[org-edit-special] to edit table.el tables"))
6728 (if arg (org-table-edit-field t)
6729 (org-table-justify-field-maybe)
6730 (call-interactively 'org-table-next-field))))
6732 ((run-hook-with-args-until-success
6733 'org-tab-after-check-for-table-hook))
6735 ;; Global cycling: delegate to `org-cycle-internal-global'.
6736 ((eq arg t) (org-cycle-internal-global))
6738 ;; Drawers: delegate to `org-flag-drawer'.
6739 ((save-excursion
6740 (beginning-of-line 1)
6741 (looking-at org-drawer-regexp))
6742 (org-flag-drawer ; toggle block visibility
6743 (not (get-char-property (match-end 0) 'invisible))))
6745 ;; Show-subtree, ARG levels up from here.
6746 ((integerp arg)
6747 (save-excursion
6748 (org-back-to-heading)
6749 (outline-up-heading (if (< arg 0) (- arg)
6750 (- (funcall outline-level) arg)))
6751 (org-show-subtree)))
6753 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6754 ((and (featurep 'org-inlinetask)
6755 (org-inlinetask-at-task-p)
6756 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6757 (org-inlinetask-toggle-visibility))
6759 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6760 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6761 (save-excursion (move-beginning-of-line 1)
6762 (looking-at org-outline-regexp)))
6763 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6764 (org-cycle-internal-local))
6766 ;; From there: TAB emulation and template completion.
6767 (buffer-read-only (org-back-to-heading))
6769 ((run-hook-with-args-until-success
6770 'org-tab-after-check-for-cycling-hook))
6772 ((org-try-structure-completion))
6774 ((run-hook-with-args-until-success
6775 'org-tab-before-tab-emulation-hook))
6777 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6778 (or (not (bolp))
6779 (not (looking-at org-outline-regexp))))
6780 (call-interactively (global-key-binding "\t")))
6782 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6783 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6784 (or (and (eq org-cycle-emulate-tab 'white)
6785 (= (match-end 0) (point-at-eol)))
6786 (and (eq org-cycle-emulate-tab 'whitestart)
6787 (>= (match-end 0) pos))))
6789 (eq org-cycle-emulate-tab t))
6790 (call-interactively (global-key-binding "\t")))
6792 (t (save-excursion
6793 (org-back-to-heading)
6794 (org-cycle)))))))
6796 (defun org-cycle-internal-global ()
6797 "Do the global cycling action."
6798 ;; Hack to avoid display of messages for .org attachments in Gnus
6799 (let ((ga (string-match "\\*fontification" (buffer-name))))
6800 (cond
6801 ((and (eq last-command this-command)
6802 (eq org-cycle-global-status 'overview))
6803 ;; We just created the overview - now do table of contents
6804 ;; This can be slow in very large buffers, so indicate action
6805 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6806 (unless ga (org-unlogged-message "CONTENTS..."))
6807 (org-content)
6808 (unless ga (org-unlogged-message "CONTENTS...done"))
6809 (setq org-cycle-global-status 'contents)
6810 (run-hook-with-args 'org-cycle-hook 'contents))
6812 ((and (eq last-command this-command)
6813 (eq org-cycle-global-status 'contents))
6814 ;; We just showed the table of contents - now show everything
6815 (run-hook-with-args 'org-pre-cycle-hook 'all)
6816 (outline-show-all)
6817 (unless ga (org-unlogged-message "SHOW ALL"))
6818 (setq org-cycle-global-status 'all)
6819 (run-hook-with-args 'org-cycle-hook 'all))
6822 ;; Default action: go to overview
6823 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6824 (org-overview)
6825 (unless ga (org-unlogged-message "OVERVIEW"))
6826 (setq org-cycle-global-status 'overview)
6827 (run-hook-with-args 'org-cycle-hook 'overview)))))
6829 (defvar org-called-with-limited-levels nil
6830 "Non-nil when `org-with-limited-levels' is currently active.")
6832 (defun org-cycle-internal-local ()
6833 "Do the local cycling action."
6834 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6835 ;; First, determine end of headline (EOH), end of subtree or item
6836 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6837 (save-excursion
6838 (if (org-at-item-p)
6839 (progn
6840 (beginning-of-line)
6841 (setq struct (org-list-struct))
6842 (setq eoh (point-at-eol))
6843 (setq eos (org-list-get-item-end-before-blank (point) struct))
6844 (setq has-children (org-list-has-child-p (point) struct)))
6845 (org-back-to-heading)
6846 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6847 (setq eos (save-excursion (org-end-of-subtree t t)
6848 (when (bolp) (backward-char)) (point)))
6849 (setq has-children
6850 (or (save-excursion
6851 (let ((level (funcall outline-level)))
6852 (outline-next-heading)
6853 (and (org-at-heading-p t)
6854 (> (funcall outline-level) level))))
6855 (save-excursion
6856 (org-list-search-forward (org-item-beginning-re) eos t)))))
6857 ;; Determine end invisible part of buffer (EOL)
6858 (beginning-of-line 2)
6859 ;; XEmacs doesn't have `next-single-char-property-change'
6860 (if (featurep 'xemacs)
6861 (while (and (not (eobp)) ;; this is like `next-line'
6862 (get-char-property (1- (point)) 'invisible))
6863 (beginning-of-line 2))
6864 (while (and (not (eobp)) ;; this is like `next-line'
6865 (get-char-property (1- (point)) 'invisible))
6866 (goto-char (next-single-char-property-change (point) 'invisible))
6867 (and (eolp) (beginning-of-line 2))))
6868 (setq eol (point)))
6869 ;; Find out what to do next and set `this-command'
6870 (cond
6871 ((= eos eoh)
6872 ;; Nothing is hidden behind this heading
6873 (unless (org-before-first-heading-p)
6874 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6875 (org-unlogged-message "EMPTY ENTRY")
6876 (setq org-cycle-subtree-status nil)
6877 (save-excursion
6878 (goto-char eos)
6879 (outline-next-heading)
6880 (when (outline-invisible-p) (org-flag-heading nil))))
6881 ((and (or (>= eol eos)
6882 (not (string-match "\\S-" (buffer-substring eol eos))))
6883 (or has-children
6884 (not (setq children-skipped
6885 org-cycle-skip-children-state-if-no-children))))
6886 ;; Entire subtree is hidden in one line: children view
6887 (unless (org-before-first-heading-p)
6888 (run-hook-with-args 'org-pre-cycle-hook 'children))
6889 (if (org-at-item-p)
6890 (org-list-set-item-visibility (point-at-bol) struct 'children)
6891 (org-show-entry)
6892 (org-with-limited-levels (org-show-children))
6893 ;; FIXME: This slows down the func way too much.
6894 ;; How keep drawers hidden in subtree anyway?
6895 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6896 ;; (org-cycle-hide-drawers 'subtree))
6898 ;; Fold every list in subtree to top-level items.
6899 (when (eq org-cycle-include-plain-lists 'integrate)
6900 (save-excursion
6901 (org-back-to-heading)
6902 (while (org-list-search-forward (org-item-beginning-re) eos t)
6903 (beginning-of-line 1)
6904 (let* ((struct (org-list-struct))
6905 (prevs (org-list-prevs-alist struct))
6906 (end (org-list-get-bottom-point struct)))
6907 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6908 (org-list-get-all-items (point) struct prevs))
6909 (goto-char (if (< end eos) end eos)))))))
6910 (org-unlogged-message "CHILDREN")
6911 (save-excursion
6912 (goto-char eos)
6913 (outline-next-heading)
6914 (when (outline-invisible-p) (org-flag-heading nil)))
6915 (setq org-cycle-subtree-status 'children)
6916 (unless (org-before-first-heading-p)
6917 (run-hook-with-args 'org-cycle-hook 'children)))
6918 ((or children-skipped
6919 (and (eq last-command this-command)
6920 (eq org-cycle-subtree-status 'children)))
6921 ;; We just showed the children, or no children are there,
6922 ;; now show everything.
6923 (unless (org-before-first-heading-p)
6924 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6925 (outline-flag-region eoh eos nil)
6926 (org-unlogged-message
6927 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6928 (setq org-cycle-subtree-status 'subtree)
6929 (unless (org-before-first-heading-p)
6930 (run-hook-with-args 'org-cycle-hook 'subtree)))
6932 ;; Default action: hide the subtree.
6933 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6934 (outline-flag-region eoh eos t)
6935 (org-unlogged-message "FOLDED")
6936 (setq org-cycle-subtree-status 'folded)
6937 (unless (org-before-first-heading-p)
6938 (run-hook-with-args 'org-cycle-hook 'folded))))))
6940 ;;;###autoload
6941 (defun org-global-cycle (&optional arg)
6942 "Cycle the global visibility. For details see `org-cycle'.
6943 With \\[universal-argument] prefix arg, switch to startup visibility.
6944 With a numeric prefix, show all headlines up to that level."
6945 (interactive "P")
6946 (let ((org-cycle-include-plain-lists
6947 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6948 (cond
6949 ((integerp arg)
6950 (outline-show-all)
6951 (outline-hide-sublevels arg)
6952 (setq org-cycle-global-status 'contents))
6953 ((equal arg '(4))
6954 (org-set-startup-visibility)
6955 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6957 (org-cycle '(4))))))
6959 (defun org-set-startup-visibility ()
6960 "Set the visibility required by startup options and properties."
6961 (cond
6962 ((eq org-startup-folded t)
6963 (org-overview))
6964 ((eq org-startup-folded 'content)
6965 (org-content))
6966 ((or (eq org-startup-folded 'showeverything)
6967 (eq org-startup-folded nil))
6968 (outline-show-all)))
6969 (unless (eq org-startup-folded 'showeverything)
6970 (when org-hide-block-startup (org-hide-block-all))
6971 (org-set-visibility-according-to-property 'no-cleanup)
6972 (org-cycle-hide-archived-subtrees 'all)
6973 (org-cycle-hide-drawers 'all)
6974 (org-cycle-show-empty-lines t)))
6976 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6977 "Switch subtree visibilities according to :VISIBILITY: property."
6978 (interactive)
6979 (let (org-show-entry-below)
6980 (org-with-wide-buffer
6981 (goto-char (point-min))
6982 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
6983 (if (not (org-at-property-p)) (outline-next-heading)
6984 (let ((state (match-string 3)))
6985 (save-excursion
6986 (org-back-to-heading t)
6987 (outline-hide-subtree)
6988 (org-reveal)
6989 (cond
6990 ((equal state "folded")
6991 (outline-hide-subtree))
6992 ((equal state "children")
6993 (org-show-hidden-entry)
6994 (org-show-children))
6995 ((equal state "content")
6996 (save-excursion
6997 (save-restriction
6998 (org-narrow-to-subtree)
6999 (org-content))))
7000 ((member state '("all" "showall"))
7001 (outline-show-subtree)))))))
7002 (unless no-cleanup
7003 (org-cycle-hide-archived-subtrees 'all)
7004 (org-cycle-hide-drawers 'all)
7005 (org-cycle-show-empty-lines 'all)))))
7007 ;; This function uses outline-regexp instead of the more fundamental
7008 ;; org-outline-regexp so that org-cycle-global works outside of Org
7009 ;; buffers, where outline-regexp is needed.
7010 (defun org-overview ()
7011 "Switch to overview mode, showing only top-level headlines.
7012 This shows all headlines with a level equal or greater than the level
7013 of the first headline in the buffer. This is important, because if the
7014 first headline is not level one, then (hide-sublevels 1) gives confusing
7015 results."
7016 (interactive)
7017 (save-excursion
7018 (let ((level
7019 (save-excursion
7020 (goto-char (point-min))
7021 (when (re-search-forward (concat "^" outline-regexp) nil t)
7022 (goto-char (match-beginning 0))
7023 (funcall outline-level)))))
7024 (and level (outline-hide-sublevels level)))))
7026 (defun org-content (&optional arg)
7027 "Show all headlines in the buffer, like a table of contents.
7028 With numerical argument N, show content up to level N."
7029 (interactive "P")
7030 (org-overview)
7031 (save-excursion
7032 ;; Visit all headings and show their offspring
7033 (and (integerp arg) (org-overview))
7034 (goto-char (point-max))
7035 (catch 'exit
7036 (while (and (progn (condition-case nil
7037 (outline-previous-visible-heading 1)
7038 (error (goto-char (point-min))))
7040 (looking-at org-outline-regexp))
7041 (if (integerp arg)
7042 (org-show-children (1- arg))
7043 (outline-show-branches))
7044 (when (bobp) (throw 'exit nil))))))
7046 (defun org-optimize-window-after-visibility-change (state)
7047 "Adjust the window after a change in outline visibility.
7048 This function is the default value of the hook `org-cycle-hook'."
7049 (when (get-buffer-window (current-buffer))
7050 (cond
7051 ((eq state 'content) nil)
7052 ((eq state 'all) nil)
7053 ((eq state 'folded) nil)
7054 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7055 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7057 (defun org-remove-empty-overlays-at (pos)
7058 "Remove outline overlays that do not contain non-white stuff."
7059 (mapc
7060 (lambda (o)
7061 (and (eq 'outline (overlay-get o 'invisible))
7062 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7063 (overlay-end o))))
7064 (delete-overlay o)))
7065 (overlays-at pos)))
7067 (defun org-clean-visibility-after-subtree-move ()
7068 "Fix visibility issues after moving a subtree."
7069 ;; First, find a reasonable region to look at:
7070 ;; Start two siblings above, end three below
7071 (let* ((beg (save-excursion
7072 (and (org-get-last-sibling)
7073 (org-get-last-sibling))
7074 (point)))
7075 (end (save-excursion
7076 (and (org-get-next-sibling)
7077 (org-get-next-sibling)
7078 (org-get-next-sibling))
7079 (if (org-at-heading-p)
7080 (point-at-eol)
7081 (point))))
7082 (level (looking-at "\\*+"))
7083 (re (when level (concat "^" (regexp-quote (match-string 0)) " "))))
7084 (save-excursion
7085 (save-restriction
7086 (narrow-to-region beg end)
7087 (when re
7088 ;; Properly fold already folded siblings
7089 (goto-char (point-min))
7090 (while (re-search-forward re nil t)
7091 (when (and (not (outline-invisible-p))
7092 (save-excursion
7093 (goto-char (point-at-eol)) (outline-invisible-p)))
7094 (outline-hide-entry))))
7095 (org-cycle-show-empty-lines 'overview)
7096 (org-cycle-hide-drawers 'overview)))))
7098 (defun org-cycle-show-empty-lines (state)
7099 "Show empty lines above all visible headlines.
7100 The region to be covered depends on STATE when called through
7101 `org-cycle-hook'. Lisp program can use t for STATE to get the
7102 entire buffer covered. Note that an empty line is only shown if there
7103 are at least `org-cycle-separator-lines' empty lines before the headline."
7104 (when (/= org-cycle-separator-lines 0)
7105 (save-excursion
7106 (let* ((n (abs org-cycle-separator-lines))
7107 (re (cond
7108 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7109 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7110 (t (let ((ns (number-to-string (- n 2))))
7111 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7112 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7113 beg end)
7114 (cond
7115 ((memq state '(overview contents t))
7116 (setq beg (point-min) end (point-max)))
7117 ((memq state '(children folded))
7118 (setq beg (point)
7119 end (progn (org-end-of-subtree t t)
7120 (line-beginning-position 2)))))
7121 (when beg
7122 (goto-char beg)
7123 (while (re-search-forward re end t)
7124 (unless (get-char-property (match-end 1) 'invisible)
7125 (let ((e (match-end 1))
7126 (b (if (>= org-cycle-separator-lines 0)
7127 (match-beginning 1)
7128 (save-excursion
7129 (goto-char (match-beginning 0))
7130 (skip-chars-backward " \t\n")
7131 (line-end-position)))))
7132 (outline-flag-region b e nil))))))))
7133 ;; Never hide empty lines at the end of the file.
7134 (save-excursion
7135 (goto-char (point-max))
7136 (outline-previous-heading)
7137 (outline-end-of-heading)
7138 (when (and (looking-at "[ \t\n]+")
7139 (= (match-end 0) (point-max)))
7140 (outline-flag-region (point) (match-end 0) nil))))
7142 (defun org-show-empty-lines-in-parent ()
7143 "Move to the parent and re-show empty lines before visible headlines."
7144 (save-excursion
7145 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7146 (org-cycle-show-empty-lines context))))
7148 (defun org-files-list ()
7149 "Return `org-agenda-files' list, plus all open org-mode files.
7150 This is useful for operations that need to scan all of a user's
7151 open and agenda-wise Org files."
7152 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7153 (dolist (buf (buffer-list))
7154 (with-current-buffer buf
7155 (when (and (derived-mode-p 'org-mode) (buffer-file-name))
7156 (cl-pushnew (expand-file-name (buffer-file-name)) files))))
7157 files))
7159 (defsubst org-entry-beginning-position ()
7160 "Return the beginning position of the current entry."
7161 (save-excursion (outline-back-to-heading t) (point)))
7163 (defsubst org-entry-end-position ()
7164 "Return the end position of the current entry."
7165 (save-excursion (outline-next-heading) (point)))
7167 (defun org-cycle-hide-drawers (state &optional exceptions)
7168 "Re-hide all drawers after a visibility state change.
7169 When non-nil, optional argument EXCEPTIONS is a list of strings
7170 specifying which drawers should not be hidden."
7171 (when (and (derived-mode-p 'org-mode)
7172 (not (memq state '(overview folded contents))))
7173 (save-excursion
7174 (let* ((globalp (memq state '(contents all)))
7175 (beg (if globalp (point-min) (point)))
7176 (end (if globalp (point-max)
7177 (if (eq state 'children)
7178 (save-excursion (outline-next-heading) (point))
7179 (org-end-of-subtree t)))))
7180 (goto-char beg)
7181 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7182 (unless (member-ignore-case (match-string 1) exceptions)
7183 (let ((drawer (org-element-at-point)))
7184 (when (memq (org-element-type drawer) '(drawer property-drawer))
7185 (org-flag-drawer t drawer)
7186 ;; Make sure to skip drawer entirely or we might flag
7187 ;; it another time when matching its ending line with
7188 ;; `org-drawer-regexp'.
7189 (goto-char (org-element-property :end drawer))))))))))
7191 (defun org-flag-drawer (flag &optional element)
7192 "When FLAG is non-nil, hide the drawer we are at.
7193 Otherwise make it visible. When optional argument ELEMENT is
7194 a parsed drawer, as returned by `org-element-at-point', hide or
7195 show that drawer instead."
7196 (when (save-excursion
7197 (beginning-of-line)
7198 (org-looking-at-p org-drawer-regexp))
7199 (let ((drawer (or element (org-element-at-point))))
7200 (when (memq (org-element-type drawer) '(drawer property-drawer))
7201 (let ((post (org-element-property :post-affiliated drawer)))
7202 (save-excursion
7203 (outline-flag-region
7204 (progn (goto-char post) (line-end-position))
7205 (progn (goto-char (org-element-property :end drawer))
7206 (skip-chars-backward " \r\t\n")
7207 (line-end-position))
7208 flag))
7209 ;; When the drawer is hidden away, make sure point lies in
7210 ;; a visible part of the buffer.
7211 (when (and flag (> (line-beginning-position) post))
7212 (goto-char post)))))))
7214 (defun org-subtree-end-visible-p ()
7215 "Is the end of the current subtree visible?"
7216 (pos-visible-in-window-p
7217 (save-excursion (org-end-of-subtree t) (point))))
7219 (defun org-first-headline-recenter ()
7220 "Move cursor to the first headline and recenter the headline."
7221 (goto-char (point-min))
7222 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7223 (set-window-start (selected-window) (point-at-bol))))
7225 ;;; Saving and restoring visibility
7227 (defun org-outline-overlay-data (&optional use-markers)
7228 "Return a list of the locations of all outline overlays.
7229 These are overlays with the `invisible' property value `outline'.
7230 The return value is a list of cons cells, with start and stop
7231 positions for each overlay.
7232 If USE-MARKERS is set, return the positions as markers."
7233 (let (beg end)
7234 (save-excursion
7235 (save-restriction
7236 (widen)
7237 (delq nil
7238 (mapcar (lambda (o)
7239 (when (eq (overlay-get o 'invisible) 'outline)
7240 (setq beg (overlay-start o)
7241 end (overlay-end o))
7242 (and beg end (> end beg)
7243 (if use-markers
7244 (cons (copy-marker beg)
7245 (copy-marker end t))
7246 (cons beg end)))))
7247 (overlays-in (point-min) (point-max))))))))
7249 (defun org-set-outline-overlay-data (data)
7250 "Create visibility overlays for all positions in DATA.
7251 DATA should have been made by `org-outline-overlay-data'."
7252 (let (o)
7253 (save-excursion
7254 (save-restriction
7255 (widen)
7256 (outline-show-all)
7257 (mapc (lambda (c)
7258 (outline-flag-region (car c) (cdr c) t))
7259 data)))))
7261 ;;; Folding of blocks
7263 (defvar-local org-hide-block-overlays nil
7264 "Overlays hiding blocks.")
7266 (defun org-block-map (function &optional start end)
7267 "Call FUNCTION at the head of all source blocks in the current buffer.
7268 Optional arguments START and END can be used to limit the range."
7269 (let ((start (or start (point-min)))
7270 (end (or end (point-max))))
7271 (save-excursion
7272 (goto-char start)
7273 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7274 (save-excursion
7275 (save-match-data
7276 (goto-char (match-beginning 0))
7277 (funcall function)))))))
7279 (defun org-hide-block-toggle-all ()
7280 "Toggle the visibility of all blocks in the current buffer."
7281 (org-block-map 'org-hide-block-toggle))
7283 (defun org-hide-block-all ()
7284 "Fold all blocks in the current buffer."
7285 (interactive)
7286 (org-show-block-all)
7287 (org-block-map 'org-hide-block-toggle-maybe))
7289 (defun org-show-block-all ()
7290 "Unfold all blocks in the current buffer."
7291 (interactive)
7292 (mapc 'delete-overlay org-hide-block-overlays)
7293 (setq org-hide-block-overlays nil))
7295 (defun org-hide-block-toggle-maybe ()
7296 "Toggle visibility of block at point.
7297 Unlike to `org-hide-block-toggle', this function does not throw
7298 an error. Return a non-nil value when toggling is successful."
7299 (interactive)
7300 (ignore-errors (org-hide-block-toggle)))
7302 (defun org-hide-block-toggle (&optional force)
7303 "Toggle the visibility of the current block.
7304 When optional argument FORCE is `off', make block visible. If it
7305 is non-nil, hide it unconditionally. Throw an error when not at
7306 a block. Return a non-nil value when toggling is successful."
7307 (interactive)
7308 (let ((element (org-element-at-point)))
7309 (unless (memq (org-element-type element)
7310 '(center-block comment-block dynamic-block example-block
7311 export-block quote-block special-block
7312 src-block verse-block))
7313 (user-error "Not at a block"))
7314 (let* ((start (save-excursion
7315 (goto-char (org-element-property :post-affiliated element))
7316 (line-end-position)))
7317 (end (save-excursion
7318 (goto-char (org-element-property :end element))
7319 (skip-chars-backward " \r\t\n")
7320 (line-end-position)))
7321 (overlays (overlays-at start)))
7322 (cond
7323 ;; Do nothing when not before or at the block opening line or
7324 ;; at the block closing line.
7325 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7326 ((and (not (eq force 'off))
7327 (not (memq t (mapcar
7328 (lambda (o)
7329 (eq (overlay-get o 'invisible) 'org-hide-block))
7330 overlays))))
7331 (let ((ov (make-overlay start end)))
7332 (overlay-put ov 'invisible 'org-hide-block)
7333 ;; Make the block accessible to `isearch'.
7334 (overlay-put
7335 ov 'isearch-open-invisible
7336 (lambda (ov)
7337 (when (memq ov org-hide-block-overlays)
7338 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7339 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7340 (delete-overlay ov))))
7341 (push ov org-hide-block-overlays)
7342 ;; When the block is hidden away, make sure point is left in
7343 ;; a visible part of the buffer.
7344 (when (> (line-beginning-position) start)
7345 (goto-char start)
7346 (beginning-of-line))
7347 ;; Signal successful toggling.
7349 ((or (not force) (eq force 'off))
7350 (dolist (ov overlays t)
7351 (when (memq ov org-hide-block-overlays)
7352 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7353 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7354 (delete-overlay ov))))))))
7356 ;; org-tab-after-check-for-cycling-hook
7357 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7358 ;; Remove overlays when changing major mode
7359 (add-hook 'org-mode-hook
7360 (lambda () (org-add-hook 'change-major-mode-hook
7361 'org-show-block-all 'append 'local)))
7363 ;;; Org-goto
7365 (defvar org-goto-window-configuration nil)
7366 (defvar org-goto-marker nil)
7367 (defvar org-goto-map)
7368 (defun org-goto-map ()
7369 "Set the keymap `org-goto'."
7370 (setq org-goto-map
7371 (let ((map (make-sparse-keymap)))
7372 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7373 mouse-drag-region universal-argument org-occur)))
7374 (dolist (cmd cmds)
7375 (substitute-key-definition cmd cmd map global-map)))
7376 (suppress-keymap map)
7377 (org-defkey map "\C-m" 'org-goto-ret)
7378 (org-defkey map [(return)] 'org-goto-ret)
7379 (org-defkey map [(left)] 'org-goto-left)
7380 (org-defkey map [(right)] 'org-goto-right)
7381 (org-defkey map [(control ?g)] 'org-goto-quit)
7382 (org-defkey map "\C-i" 'org-cycle)
7383 (org-defkey map [(tab)] 'org-cycle)
7384 (org-defkey map [(down)] 'outline-next-visible-heading)
7385 (org-defkey map [(up)] 'outline-previous-visible-heading)
7386 (if org-goto-auto-isearch
7387 (if (fboundp 'define-key-after)
7388 (define-key-after map [t] 'org-goto-local-auto-isearch)
7389 nil)
7390 (org-defkey map "q" 'org-goto-quit)
7391 (org-defkey map "n" 'outline-next-visible-heading)
7392 (org-defkey map "p" 'outline-previous-visible-heading)
7393 (org-defkey map "f" 'outline-forward-same-level)
7394 (org-defkey map "b" 'outline-backward-same-level)
7395 (org-defkey map "u" 'outline-up-heading))
7396 (org-defkey map "/" 'org-occur)
7397 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7398 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7399 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7400 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7401 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7402 map)))
7404 (defconst org-goto-help
7405 "Browse buffer copy, to find location or copy text.%s
7406 RET=jump to location C-g=quit and return to previous location
7407 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7409 (defvar org-goto-start-pos) ; dynamically scoped parameter
7411 (defun org-goto (&optional alternative-interface)
7412 "Look up a different location in the current file, keeping current visibility.
7414 When you want look-up or go to a different location in a
7415 document, the fastest way is often to fold the entire buffer and
7416 then dive into the tree. This method has the disadvantage, that
7417 the previous location will be folded, which may not be what you
7418 want.
7420 This command works around this by showing a copy of the current
7421 buffer in an indirect buffer, in overview mode. You can dive
7422 into the tree in that copy, use org-occur and incremental search
7423 to find a location. When pressing RET or `Q', the command
7424 returns to the original buffer in which the visibility is still
7425 unchanged. After RET it will also jump to the location selected
7426 in the indirect buffer and expose the headline hierarchy above.
7428 With a prefix argument, use the alternative interface: e.g. if
7429 `org-goto-interface' is 'outline use 'outline-path-completion."
7430 (interactive "P")
7431 (org-goto-map)
7432 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7433 (org-refile-use-outline-path t)
7434 (org-refile-target-verify-function nil)
7435 (interface
7436 (if (not alternative-interface)
7437 org-goto-interface
7438 (if (eq org-goto-interface 'outline)
7439 'outline-path-completion
7440 'outline)))
7441 (org-goto-start-pos (point))
7442 (selected-point
7443 (if (eq interface 'outline)
7444 (car (org-get-location (current-buffer) org-goto-help))
7445 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7446 (org-refile-check-position pa)
7447 (nth 3 pa)))))
7448 (if selected-point
7449 (progn
7450 (org-mark-ring-push org-goto-start-pos)
7451 (goto-char selected-point)
7452 (when (or (outline-invisible-p) (org-invisible-p2))
7453 (org-show-context 'org-goto)))
7454 (message "Quit"))))
7456 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7457 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7458 (defvar org-goto-local-auto-isearch-map) ; defined below
7460 (defun org-get-location (buf help)
7461 "Let the user select a location in the Org-mode buffer BUF.
7462 This function uses a recursive edit. It returns the selected position
7463 or nil."
7464 (org-no-popups
7465 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7466 (isearch-hide-immediately nil)
7467 (isearch-search-fun-function
7468 (lambda () 'org-goto-local-search-headings))
7469 (org-goto-selected-point org-goto-exit-command))
7470 (save-excursion
7471 (save-window-excursion
7472 (delete-other-windows)
7473 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7474 (org-pop-to-buffer-same-window
7475 (condition-case nil
7476 (make-indirect-buffer (current-buffer) "*org-goto*")
7477 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7478 (with-output-to-temp-buffer "*Org Help*"
7479 (princ (format help (if org-goto-auto-isearch
7480 " Just type for auto-isearch."
7481 " n/p/f/b/u to navigate, q to quit."))))
7482 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7483 (setq buffer-read-only nil)
7484 (let ((org-startup-truncated t)
7485 (org-startup-folded nil)
7486 (org-startup-align-all-tables nil))
7487 (org-mode)
7488 (org-overview))
7489 (setq buffer-read-only t)
7490 (if (and (boundp 'org-goto-start-pos)
7491 (integer-or-marker-p org-goto-start-pos))
7492 (progn (goto-char org-goto-start-pos)
7493 (when (outline-invisible-p)
7494 (org-show-set-visibility 'lineage)))
7495 (goto-char (point-min)))
7496 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7497 (message "Select location and press RET")
7498 (use-local-map org-goto-map)
7499 (recursive-edit)))
7500 (kill-buffer "*org-goto*")
7501 (cons org-goto-selected-point org-goto-exit-command))))
7503 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7504 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7505 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7506 (if (fboundp 'isearch-other-control-char)
7507 (progn
7508 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7509 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7510 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7511 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7512 (define-key org-goto-local-auto-isearch-map [return] nil))
7514 (defun org-goto-local-search-headings (string bound noerror)
7515 "Search and make sure that any matches are in headlines."
7516 (catch 'return
7517 (while (if isearch-forward
7518 (search-forward string bound noerror)
7519 (search-backward string bound noerror))
7520 (when (save-match-data
7521 (and (save-excursion
7522 (beginning-of-line)
7523 (looking-at org-complex-heading-regexp))
7524 (or (not (match-beginning 5))
7525 (< (point) (match-beginning 5)))))
7526 (throw 'return (point))))))
7528 (defun org-goto-local-auto-isearch ()
7529 "Start isearch."
7530 (interactive)
7531 (goto-char (point-min))
7532 (let ((keys (this-command-keys)))
7533 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7534 (isearch-mode t)
7535 (isearch-process-search-char (string-to-char keys)))))
7537 (defun org-goto-ret (&optional arg)
7538 "Finish `org-goto' by going to the new location."
7539 (interactive "P")
7540 (setq org-goto-selected-point (point)
7541 org-goto-exit-command 'return)
7542 (throw 'exit nil))
7544 (defun org-goto-left ()
7545 "Finish `org-goto' by going to the new location."
7546 (interactive)
7547 (if (org-at-heading-p)
7548 (progn
7549 (beginning-of-line 1)
7550 (setq org-goto-selected-point (point)
7551 org-goto-exit-command 'left)
7552 (throw 'exit nil))
7553 (user-error "Not on a heading")))
7555 (defun org-goto-right ()
7556 "Finish `org-goto' by going to the new location."
7557 (interactive)
7558 (if (org-at-heading-p)
7559 (progn
7560 (setq org-goto-selected-point (point)
7561 org-goto-exit-command 'right)
7562 (throw 'exit nil))
7563 (user-error "Not on a heading")))
7565 (defun org-goto-quit ()
7566 "Finish `org-goto' without cursor motion."
7567 (interactive)
7568 (setq org-goto-selected-point nil)
7569 (setq org-goto-exit-command 'quit)
7570 (throw 'exit nil))
7572 ;;; Indirect buffer display of subtrees
7574 (defvar org-indirect-dedicated-frame nil
7575 "This is the frame being used for indirect tree display.")
7576 (defvar org-last-indirect-buffer nil)
7578 (defun org-tree-to-indirect-buffer (&optional arg)
7579 "Create indirect buffer and narrow it to current subtree.
7580 With a numerical prefix ARG, go up to this level and then take that tree.
7581 If ARG is negative, go up that many levels.
7583 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7584 indirect buffer previously made with this command, to avoid proliferation of
7585 indirect buffers. However, when you call the command with a \
7586 \\[universal-argument] prefix, or
7587 when `org-indirect-buffer-display' is `new-frame', the last buffer
7588 is kept so that you can work with several indirect buffers at the same time.
7589 If `org-indirect-buffer-display' is `dedicated-frame', the \
7590 \\[universal-argument] prefix also
7591 requests that a new frame be made for the new buffer, so that the dedicated
7592 frame is not changed."
7593 (interactive "P")
7594 (let ((cbuf (current-buffer))
7595 (cwin (selected-window))
7596 (pos (point))
7597 beg end level heading ibuf)
7598 (save-excursion
7599 (org-back-to-heading t)
7600 (when (numberp arg)
7601 (setq level (org-outline-level))
7602 (when (< arg 0) (setq arg (+ level arg)))
7603 (while (> (setq level (org-outline-level)) arg)
7604 (org-up-heading-safe)))
7605 (setq beg (point)
7606 heading (org-get-heading))
7607 (org-end-of-subtree t t)
7608 (when (org-at-heading-p) (backward-char 1))
7609 (setq end (point)))
7610 (when (and (buffer-live-p org-last-indirect-buffer)
7611 (not (eq org-indirect-buffer-display 'new-frame))
7612 (not arg))
7613 (kill-buffer org-last-indirect-buffer))
7614 (setq ibuf (org-get-indirect-buffer cbuf heading)
7615 org-last-indirect-buffer ibuf)
7616 (cond
7617 ((or (eq org-indirect-buffer-display 'new-frame)
7618 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7619 (select-frame (make-frame))
7620 (delete-other-windows)
7621 (org-pop-to-buffer-same-window ibuf)
7622 (org-set-frame-title heading))
7623 ((eq org-indirect-buffer-display 'dedicated-frame)
7624 (raise-frame
7625 (select-frame (or (and org-indirect-dedicated-frame
7626 (frame-live-p org-indirect-dedicated-frame)
7627 org-indirect-dedicated-frame)
7628 (setq org-indirect-dedicated-frame (make-frame)))))
7629 (delete-other-windows)
7630 (org-pop-to-buffer-same-window ibuf)
7631 (org-set-frame-title (concat "Indirect: " heading)))
7632 ((eq org-indirect-buffer-display 'current-window)
7633 (org-pop-to-buffer-same-window ibuf))
7634 ((eq org-indirect-buffer-display 'other-window)
7635 (pop-to-buffer ibuf))
7636 (t (error "Invalid value")))
7637 (when (featurep 'xemacs)
7638 (save-excursion (org-mode) (turn-on-font-lock)))
7639 (narrow-to-region beg end)
7640 (outline-show-all)
7641 (goto-char pos)
7642 (run-hook-with-args 'org-cycle-hook 'all)
7643 (and (window-live-p cwin) (select-window cwin))))
7645 (defun org-get-indirect-buffer (&optional buffer heading)
7646 (setq buffer (or buffer (current-buffer)))
7647 (let ((n 1) (base (buffer-name buffer)) bname)
7648 (while (buffer-live-p
7649 (get-buffer
7650 (setq bname
7651 (concat base "-"
7652 (if heading (concat heading "-" (number-to-string n))
7653 (number-to-string n))))))
7654 (setq n (1+ n)))
7655 (condition-case nil
7656 (make-indirect-buffer buffer bname 'clone)
7657 (error (make-indirect-buffer buffer bname)))))
7659 (defun org-set-frame-title (title)
7660 "Set the title of the current frame to the string TITLE."
7661 ;; FIXME: how to name a single frame in XEmacs???
7662 (unless (featurep 'xemacs)
7663 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7665 ;;;; Structure editing
7667 ;;; Inserting headlines
7669 (defun org-previous-line-empty-p (&optional next)
7670 "Is the previous line a blank line?
7671 When NEXT is non-nil, check the next line instead."
7672 (save-excursion
7673 (and (not (bobp))
7674 (or (beginning-of-line (if next 2 0)) t)
7675 (save-match-data
7676 (looking-at "[ \t]*$")))))
7678 (defun org-insert-heading (&optional arg invisible-ok top-level)
7679 "Insert a new heading or an item with the same depth at point.
7681 If point is at the beginning of a heading or a list item, insert
7682 a new heading or a new item above the current one. If point is
7683 at the beginning of a normal line, turn the line into a heading.
7685 If point is in the middle of a headline or a list item, split the
7686 headline or the item and create a new headline/item with the text
7687 in the current line after point \(see `org-M-RET-may-split-line'
7688 on how to modify this behavior).
7690 With one universal prefix argument, set the user option
7691 `org-insert-heading-respect-content' to t for the duration of
7692 the command. This modifies the behavior described above in this
7693 ways: on list items and at the beginning of normal lines, force
7694 the insertion of a heading after the current subtree.
7696 With two universal prefix arguments, insert the heading at the
7697 end of the grandparent subtree. For example, if point is within
7698 a 2nd-level heading, then it will insert a 2nd-level heading at
7699 the end of the 1st-level parent heading.
7701 If point is at the beginning of a headline, insert a sibling
7702 before the current headline. If point is not at the beginning,
7703 split the line and create a new headline with the text in the
7704 current line after point \(see `org-M-RET-may-split-line' on how
7705 to modify this behavior).
7707 If point is at the beginning of a normal line, turn this line
7708 into a heading.
7710 When INVISIBLE-OK is set, stop at invisible headlines when going
7711 back. This is important for non-interactive uses of the
7712 command.
7714 When optional argument TOP-LEVEL is non-nil, insert a level 1
7715 heading, unconditionally."
7716 (interactive "P")
7717 (when (org-called-interactively-p 'any) (org-reveal))
7718 (let ((itemp (and (not top-level) (org-in-item-p)))
7719 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7720 (respect-content (or org-insert-heading-respect-content
7721 (equal arg '(4))))
7722 (initial-content ""))
7724 (cond
7726 ((or (= (buffer-size) 0)
7727 (and (not (save-excursion
7728 (and (ignore-errors (org-back-to-heading invisible-ok))
7729 (org-at-heading-p))))
7730 (or arg (not itemp))))
7731 ;; At beginning of buffer or so high up that only a heading
7732 ;; makes sense.
7733 (cond ((and (bolp) (not respect-content)) (insert "* "))
7734 ((not respect-content)
7735 (unless may-split (end-of-line))
7736 (insert "\n* "))
7737 ((re-search-forward org-outline-regexp-bol nil t)
7738 (beginning-of-line)
7739 (insert "* \n")
7740 (backward-char))
7741 (t (goto-char (point-max))
7742 (insert "\n* ")))
7743 (run-hooks 'org-insert-heading-hook))
7745 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7748 ;; Maybe move at the end of the subtree
7749 (when (equal arg '(16))
7750 (org-up-heading-safe)
7751 (org-end-of-subtree t))
7752 ;; Insert a heading
7753 (save-restriction
7754 (widen)
7755 (let* ((level nil)
7756 (on-heading (org-at-heading-p))
7757 (empty-line-p (if on-heading
7758 (org-previous-line-empty-p)
7759 ;; We will decide later
7760 nil))
7761 ;; Get a level string to fall back on.
7762 (fix-level
7763 (if (org-before-first-heading-p) "*"
7764 (save-excursion
7765 (org-back-to-heading t)
7766 (when (org-previous-line-empty-p) (setq empty-line-p t))
7767 (looking-at org-outline-regexp)
7768 (make-string (1- (length (match-string 0))) ?*))))
7769 (stars
7770 (save-excursion
7771 (condition-case nil
7772 (if top-level "* "
7773 (org-back-to-heading invisible-ok)
7774 (when (and (not on-heading)
7775 (featurep 'org-inlinetask)
7776 (integerp org-inlinetask-min-level)
7777 (>= (length (match-string 0))
7778 org-inlinetask-min-level))
7779 ;; Find a heading level before the inline
7780 ;; task.
7781 (while (and (setq level (org-up-heading-safe))
7782 (>= level org-inlinetask-min-level)))
7783 (if (org-at-heading-p)
7784 (org-back-to-heading invisible-ok)
7785 (error "This should not happen")))
7786 (unless (and (save-excursion
7787 (save-match-data
7788 (org-backward-heading-same-level
7789 1 invisible-ok))
7790 (= (point) (match-beginning 0)))
7791 (not (org-previous-line-empty-p t)))
7792 (setq empty-line-p (or empty-line-p
7793 (org-previous-line-empty-p))))
7794 (match-string 0))
7795 (error (or fix-level "* ")))))
7796 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7797 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7798 pos hide-previous previous-pos)
7800 ;; If we insert after content, move there and clean up
7801 ;; whitespace.
7802 (when (and respect-content
7803 (not (org-looking-at-p org-outline-regexp-bol)))
7804 (if (not (org-before-first-heading-p))
7805 (org-end-of-subtree nil t)
7806 (re-search-forward org-outline-regexp-bol)
7807 (beginning-of-line 0))
7808 (skip-chars-backward " \r\t\n")
7809 (and (not (org-looking-back "^\\*+" (line-beginning-position)))
7810 (looking-at "[ \t]+") (replace-match ""))
7811 (unless (eobp) (forward-char 1))
7812 (when (looking-at "^\\*")
7813 (unless (bobp) (backward-char 1))
7814 (insert "\n")))
7816 ;; If we are splitting, grab the text that should be moved
7817 ;; to the new headline.
7818 (when may-split
7819 (if (org-at-heading-p)
7820 ;; This is a heading: split intelligently (keeping
7821 ;; tags).
7822 (let ((pos (point)))
7823 (beginning-of-line)
7824 (unless (looking-at org-complex-heading-regexp)
7825 (error "This should not happen"))
7826 (when (and (match-beginning 4)
7827 (> pos (match-beginning 4))
7828 (< pos (match-end 4)))
7829 (setq initial-content (buffer-substring pos (match-end 4)))
7830 (goto-char pos)
7831 (delete-region (point) (match-end 4))
7832 (if (looking-at "[ \t]*$")
7833 (replace-match "")
7834 (insert (make-string (length initial-content) ?\s)))
7835 (setq initial-content (org-trim initial-content)))
7836 (goto-char pos))
7837 ;; A normal line.
7838 (setq initial-content
7839 (org-trim
7840 (delete-and-extract-region (point) (line-end-position))))))
7842 ;; If we are at the beginning of the line, insert before it.
7843 ;; Otherwise, after it.
7844 (cond
7845 ((and (bolp) (looking-at "[ \t]*$")))
7846 ((bolp) (save-excursion (insert "\n")))
7847 (t (end-of-line)
7848 (insert "\n")))
7850 ;; Insert the new heading
7851 (insert stars)
7852 (just-one-space)
7853 (insert initial-content)
7854 (unless (and blank (org-previous-line-empty-p))
7855 (org-N-empty-lines-before-current (if blank 1 0)))
7856 ;; Adjust visibility, which may be messed up if we removed
7857 ;; blank lines while previous entry was hidden.
7858 (let ((bol (line-beginning-position)))
7859 (dolist (o (overlays-at (1- bol)))
7860 (when (and (eq (overlay-get o 'invisible) 'outline)
7861 (eq (overlay-end o) bol))
7862 (move-overlay o (overlay-start o) (1- bol)))))
7863 (run-hooks 'org-insert-heading-hook)))))))
7865 (defun org-N-empty-lines-before-current (N)
7866 "Make the number of empty lines before current exactly N.
7867 So this will delete or add empty lines."
7868 (save-excursion
7869 (beginning-of-line)
7870 (let ((p (point)))
7871 (skip-chars-backward " \r\t\n")
7872 (unless (bolp) (forward-line))
7873 (delete-region (point) p))
7874 (when (> N 0) (insert (make-string N ?\n)))))
7876 (defun org-get-heading (&optional no-tags no-todo)
7877 "Return the heading of the current entry, without the stars.
7878 When NO-TAGS is non-nil, don't include tags.
7879 When NO-TODO is non-nil, don't include TODO keywords."
7880 (save-excursion
7881 (org-back-to-heading t)
7882 (cond
7883 ((and no-tags no-todo)
7884 (looking-at org-complex-heading-regexp)
7885 (match-string 4))
7886 (no-tags
7887 (looking-at (concat org-outline-regexp
7888 "\\(.*?\\)"
7889 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7890 (match-string 1))
7891 (no-todo
7892 (looking-at org-todo-line-regexp)
7893 (match-string 3))
7894 (t (looking-at org-heading-regexp)
7895 (match-string 2)))))
7897 (defvar orgstruct-mode) ; defined below
7899 (defun org-heading-components ()
7900 "Return the components of the current heading.
7901 This is a list with the following elements:
7902 - the level as an integer
7903 - the reduced level, different if `org-odd-levels-only' is set.
7904 - the TODO keyword, or nil
7905 - the priority character, like ?A, or nil if no priority is given
7906 - the headline text itself, or the tags string if no headline text
7907 - the tags string, or nil."
7908 (save-excursion
7909 (org-back-to-heading t)
7910 (when (let (case-fold-search)
7911 (looking-at
7912 (if orgstruct-mode
7913 org-heading-regexp
7914 org-complex-heading-regexp)))
7915 (if orgstruct-mode
7916 (list (length (match-string 1))
7917 (org-reduced-level (length (match-string 1)))
7920 (match-string 2)
7921 nil)
7922 (list (length (match-string 1))
7923 (org-reduced-level (length (match-string 1)))
7924 (org-match-string-no-properties 2)
7925 (and (match-end 3) (aref (match-string 3) 2))
7926 (org-match-string-no-properties 4)
7927 (org-match-string-no-properties 5))))))
7929 (defun org-get-entry ()
7930 "Get the entry text, after heading, entire subtree."
7931 (save-excursion
7932 (org-back-to-heading t)
7933 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7935 (defun org-insert-heading-after-current ()
7936 "Insert a new heading with same level as current, after current subtree."
7937 (interactive)
7938 (org-back-to-heading)
7939 (org-insert-heading)
7940 (org-move-subtree-down)
7941 (end-of-line 1))
7943 (defun org-insert-heading-respect-content (&optional invisible-ok)
7944 "Insert heading with `org-insert-heading-respect-content' set to t."
7945 (interactive)
7946 (org-insert-heading '(4) invisible-ok))
7948 (defun org-insert-todo-heading-respect-content (&optional force-state)
7949 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7950 (interactive)
7951 (org-insert-todo-heading force-state '(4)))
7953 (defun org-insert-todo-heading (arg &optional force-heading)
7954 "Insert a new heading with the same level and TODO state as current heading.
7955 If the heading has no TODO state, or if the state is DONE, use the first
7956 state (TODO by default). Also with one prefix arg, force first state. With
7957 two prefix args, force inserting at the end of the parent subtree."
7958 (interactive "P")
7959 (when (or force-heading (not (org-insert-item 'checkbox)))
7960 (org-insert-heading (or (and (equal arg '(16)) '(16))
7961 force-heading))
7962 (save-excursion
7963 (org-back-to-heading)
7964 (outline-previous-heading)
7965 (looking-at org-todo-line-regexp))
7966 (let*
7967 ((new-mark-x
7968 (if (or (equal arg '(4))
7969 (not (match-beginning 2))
7970 (member (match-string 2) org-done-keywords))
7971 (car org-todo-keywords-1)
7972 (match-string 2)))
7973 (new-mark
7975 (run-hook-with-args-until-success
7976 'org-todo-get-default-hook new-mark-x nil)
7977 new-mark-x)))
7978 (beginning-of-line 1)
7979 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7980 (if org-treat-insert-todo-heading-as-state-change
7981 (org-todo new-mark)
7982 (insert new-mark " "))))
7983 (when org-provide-todo-statistics
7984 (org-update-parent-todo-statistics))))
7986 (defun org-insert-subheading (arg)
7987 "Insert a new subheading and demote it.
7988 Works for outline headings and for plain lists alike."
7989 (interactive "P")
7990 (org-insert-heading arg)
7991 (cond
7992 ((org-at-heading-p) (org-do-demote))
7993 ((org-at-item-p) (org-indent-item))))
7995 (defun org-insert-todo-subheading (arg)
7996 "Insert a new subheading with TODO keyword or checkbox and demote it.
7997 Works for outline headings and for plain lists alike."
7998 (interactive "P")
7999 (org-insert-todo-heading arg)
8000 (cond
8001 ((org-at-heading-p) (org-do-demote))
8002 ((org-at-item-p) (org-indent-item))))
8004 ;;; Promotion and Demotion
8006 (defvar org-after-demote-entry-hook nil
8007 "Hook run after an entry has been demoted.
8008 The cursor will be at the beginning of the entry.
8009 When a subtree is being demoted, the hook will be called for each node.")
8011 (defvar org-after-promote-entry-hook nil
8012 "Hook run after an entry has been promoted.
8013 The cursor will be at the beginning of the entry.
8014 When a subtree is being promoted, the hook will be called for each node.")
8016 (defun org-promote-subtree ()
8017 "Promote the entire subtree.
8018 See also `org-promote'."
8019 (interactive)
8020 (save-excursion
8021 (org-with-limited-levels (org-map-tree 'org-promote)))
8022 (org-fix-position-after-promote))
8024 (defun org-demote-subtree ()
8025 "Demote the entire subtree.
8026 See `org-demote' and `org-promote'."
8027 (interactive)
8028 (save-excursion
8029 (org-with-limited-levels (org-map-tree 'org-demote)))
8030 (org-fix-position-after-promote))
8032 (defun org-do-promote ()
8033 "Promote the current heading higher up the tree.
8034 If the region is active in `transient-mark-mode', promote all
8035 headings in the region."
8036 (interactive)
8037 (save-excursion
8038 (if (org-region-active-p)
8039 (org-map-region 'org-promote (region-beginning) (region-end))
8040 (org-promote)))
8041 (org-fix-position-after-promote))
8043 (defun org-do-demote ()
8044 "Demote the current heading lower down the tree.
8045 If the region is active in `transient-mark-mode', demote all
8046 headings in the region."
8047 (interactive)
8048 (save-excursion
8049 (if (org-region-active-p)
8050 (org-map-region 'org-demote (region-beginning) (region-end))
8051 (org-demote)))
8052 (org-fix-position-after-promote))
8054 (defun org-fix-position-after-promote ()
8055 "Fix cursor position and indentation after demoting/promoting."
8056 (let ((pos (point)))
8057 (when (save-excursion
8058 (beginning-of-line 1)
8059 (looking-at org-todo-line-regexp)
8060 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8061 (cond ((eobp) (insert " "))
8062 ((eolp) (insert " "))
8063 ((equal (char-after) ?\ ) (forward-char 1))))))
8065 (defun org-current-level ()
8066 "Return the level of the current entry, or nil if before the first headline.
8067 The level is the number of stars at the beginning of the
8068 headline. Use `org-reduced-level' to remove the effect of
8069 `org-odd-levels'. Unlike to `org-outline-level', this function
8070 ignores inlinetasks."
8071 (let ((level (org-with-limited-levels (org-outline-level))))
8072 (and (> level 0) level)))
8074 (defun org-get-previous-line-level ()
8075 "Return the outline depth of the last headline before the current line.
8076 Returns 0 for the first headline in the buffer, and nil if before the
8077 first headline."
8078 (and (org-current-level)
8079 (or (and (/= (line-beginning-position) (point-min))
8080 (save-excursion (beginning-of-line 0) (org-current-level)))
8081 0)))
8083 (defun org-reduced-level (l)
8084 "Compute the effective level of a heading.
8085 This takes into account the setting of `org-odd-levels-only'."
8086 (cond
8087 ((zerop l) 0)
8088 (org-odd-levels-only (1+ (floor (/ l 2))))
8089 (t l)))
8091 (defun org-level-increment ()
8092 "Return the number of stars that will be added or removed at a
8093 time to headlines when structure editing, based on the value of
8094 `org-odd-levels-only'."
8095 (if org-odd-levels-only 2 1))
8097 (defun org-get-valid-level (level &optional change)
8098 "Rectify a level change under the influence of `org-odd-levels-only'
8099 LEVEL is a current level, CHANGE is by how much the level should be
8100 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8101 even level numbers will become the next higher odd number."
8102 (if org-odd-levels-only
8103 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8104 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8105 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8106 (max 1 (+ level (or change 0)))))
8108 (if (boundp 'define-obsolete-function-alias)
8109 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8110 (define-obsolete-function-alias 'org-get-legal-level
8111 'org-get-valid-level)
8112 (define-obsolete-function-alias 'org-get-legal-level
8113 'org-get-valid-level "23.1")))
8115 (defun org-promote ()
8116 "Promote the current heading higher up the tree."
8117 (org-with-wide-buffer
8118 (org-back-to-heading t)
8119 (let* ((after-change-functions (remq 'flyspell-after-change-function
8120 after-change-functions))
8121 (level (save-match-data (funcall outline-level)))
8122 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8123 (diff (abs (- level (length up-head) -1))))
8124 (cond
8125 ((and (= level 1) org-allow-promoting-top-level-subtree)
8126 (replace-match "# " nil t))
8127 ((= level 1)
8128 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8129 (t (replace-match up-head nil t)))
8130 (unless (= level 1)
8131 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8132 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8133 (run-hooks 'org-after-promote-entry-hook))))
8135 (defun org-demote ()
8136 "Demote the current heading lower down the tree."
8137 (org-with-wide-buffer
8138 (org-back-to-heading t)
8139 (let* ((after-change-functions (remq 'flyspell-after-change-function
8140 after-change-functions))
8141 (level (save-match-data (funcall outline-level)))
8142 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8143 (diff (abs (- level (length down-head) -1))))
8144 (replace-match down-head nil t)
8145 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8146 (when org-adapt-indentation (org-fixup-indentation diff))
8147 (run-hooks 'org-after-demote-entry-hook))))
8149 (defun org-cycle-level ()
8150 "Cycle the level of an empty headline through possible states.
8151 This goes first to child, then to parent, level, then up the hierarchy.
8152 After top level, it switches back to sibling level."
8153 (interactive)
8154 (let ((org-adapt-indentation nil))
8155 (when (org-point-at-end-of-empty-headline)
8156 (setq this-command 'org-cycle-level) ; Only needed for caching
8157 (let ((cur-level (org-current-level))
8158 (prev-level (org-get-previous-line-level)))
8159 (cond
8160 ;; If first headline in file, promote to top-level.
8161 ((= prev-level 0)
8162 (loop repeat (/ (- cur-level 1) (org-level-increment))
8163 do (org-do-promote)))
8164 ;; If same level as prev, demote one.
8165 ((= prev-level cur-level)
8166 (org-do-demote))
8167 ;; If parent is top-level, promote to top level if not already.
8168 ((= prev-level 1)
8169 (loop repeat (/ (- cur-level 1) (org-level-increment))
8170 do (org-do-promote)))
8171 ;; If top-level, return to prev-level.
8172 ((= cur-level 1)
8173 (loop repeat (/ (- prev-level 1) (org-level-increment))
8174 do (org-do-demote)))
8175 ;; If less than prev-level, promote one.
8176 ((< cur-level prev-level)
8177 (org-do-promote))
8178 ;; If deeper than prev-level, promote until higher than
8179 ;; prev-level.
8180 ((> cur-level prev-level)
8181 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8182 do (org-do-promote))))
8183 t))))
8185 (defun org-map-tree (fun)
8186 "Call FUN for every heading underneath the current one."
8187 (org-back-to-heading)
8188 (let ((level (funcall outline-level)))
8189 (save-excursion
8190 (funcall fun)
8191 (while (and (progn
8192 (outline-next-heading)
8193 (> (funcall outline-level) level))
8194 (not (eobp)))
8195 (funcall fun)))))
8197 (defun org-map-region (fun beg end)
8198 "Call FUN for every heading between BEG and END."
8199 (let ((org-ignore-region t))
8200 (save-excursion
8201 (setq end (copy-marker end))
8202 (goto-char beg)
8203 (when (and (re-search-forward org-outline-regexp-bol nil t)
8204 (< (point) end))
8205 (funcall fun))
8206 (while (and (progn
8207 (outline-next-heading)
8208 (< (point) end))
8209 (not (eobp)))
8210 (funcall fun)))))
8212 (defun org-fixup-indentation (diff)
8213 "Change the indentation in the current entry by DIFF.
8215 DIFF is an integer. Indentation is done according to the
8216 following rules:
8218 - Planning information and property drawers are always indented
8219 according to the new level of the headline;
8221 - Footnote definitions and their contents are ignored;
8223 - Inlinetasks' boundaries are not shifted;
8225 - Empty lines are ignored;
8227 - Other lines' indentation are shifted by DIFF columns, unless
8228 it would introduce a structural change in the document, in
8229 which case no shifting is done at all.
8231 Assume point is at a heading or an inlinetask beginning."
8232 (org-with-wide-buffer
8233 (narrow-to-region (line-beginning-position)
8234 (save-excursion
8235 (if (org-with-limited-levels (org-at-heading-p))
8236 (org-with-limited-levels (outline-next-heading))
8237 (org-inlinetask-goto-end))
8238 (point)))
8239 (forward-line)
8240 ;; Indent properly planning info and property drawer.
8241 (when (org-looking-at-p org-planning-line-re)
8242 (org-indent-line)
8243 (forward-line))
8244 (when (looking-at org-property-drawer-re)
8245 (goto-char (match-end 0))
8246 (forward-line)
8247 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8248 (catch 'no-shift
8249 (when (zerop diff) (throw 'no-shift nil))
8250 ;; If DIFF is negative, first check if a shift is possible at all
8251 ;; (e.g., it doesn't break structure). This can only happen if
8252 ;; some contents are not properly indented.
8253 (let ((case-fold-search t))
8254 (when (< diff 0)
8255 (let ((diff (- diff))
8256 (forbidden-re (concat org-outline-regexp
8257 "\\|"
8258 (substring org-footnote-definition-re 1))))
8259 (save-excursion
8260 (while (not (eobp))
8261 (cond
8262 ((org-looking-at-p "[ \t]*$") (forward-line))
8263 ((and (org-looking-at-p org-footnote-definition-re)
8264 (let ((e (org-element-at-point)))
8265 (and (eq (org-element-type e) 'footnote-definition)
8266 (goto-char (org-element-property :end e))))))
8267 ((org-looking-at-p org-outline-regexp) (forward-line))
8268 ;; Give up if shifting would move before column 0 or
8269 ;; if it would introduce a headline or a footnote
8270 ;; definition.
8272 (skip-chars-forward " \t")
8273 (let ((ind (current-column)))
8274 (when (or (< ind diff)
8275 (and (= ind diff) (org-looking-at-p forbidden-re)))
8276 (throw 'no-shift nil)))
8277 ;; Ignore contents of example blocks and source
8278 ;; blocks if their indentation is meant to be
8279 ;; preserved. Jump to block's closing line.
8280 (beginning-of-line)
8281 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8282 (let ((e (org-element-at-point)))
8283 (and (memq (org-element-type e)
8284 '(example-block src-block))
8285 (or org-src-preserve-indentation
8286 (org-element-property :preserve-indent e))
8287 (goto-char (org-element-property :end e))
8288 (progn (skip-chars-backward " \r\t\n")
8289 (beginning-of-line)
8290 t))))
8291 (forward-line))))))))
8292 ;; Shift lines but footnote definitions, inlinetasks boundaries
8293 ;; by DIFF. Also skip contents of source or example blocks
8294 ;; when indentation is meant to be preserved.
8295 (while (not (eobp))
8296 (cond
8297 ((and (org-looking-at-p org-footnote-definition-re)
8298 (let ((e (org-element-at-point)))
8299 (and (eq (org-element-type e) 'footnote-definition)
8300 (goto-char (org-element-property :end e))))))
8301 ((org-looking-at-p org-outline-regexp) (forward-line))
8302 ((org-looking-at-p "[ \t]*$") (forward-line))
8304 (org-indent-line-to (+ (org-get-indentation) diff))
8305 (beginning-of-line)
8306 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8307 (let ((e (org-element-at-point)))
8308 (and (memq (org-element-type e)
8309 '(example-block src-block))
8310 (or org-src-preserve-indentation
8311 (org-element-property :preserve-indent e))
8312 (goto-char (org-element-property :end e))
8313 (progn (skip-chars-backward " \r\t\n")
8314 (beginning-of-line)
8315 t))))
8316 (forward-line)))))))))
8318 (defun org-convert-to-odd-levels ()
8319 "Convert an org-mode file with all levels allowed to one with odd levels.
8320 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8321 level 5 etc."
8322 (interactive)
8323 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8324 (let ((outline-level 'org-outline-level)
8325 (org-odd-levels-only nil) n)
8326 (save-excursion
8327 (goto-char (point-min))
8328 (while (re-search-forward "^\\*\\*+ " nil t)
8329 (setq n (- (length (match-string 0)) 2))
8330 (while (>= (setq n (1- n)) 0)
8331 (org-demote))
8332 (end-of-line 1))))))
8334 (defun org-convert-to-oddeven-levels ()
8335 "Convert an org-mode file with only odd levels to one with odd/even levels.
8336 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8337 file contains a section with an even level, conversion would
8338 destroy the structure of the file. An error is signaled in this
8339 case."
8340 (interactive)
8341 (goto-char (point-min))
8342 ;; First check if there are no even levels
8343 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8344 (org-show-set-visibility 'canonical)
8345 (error "Not all levels are odd in this file. Conversion not possible"))
8346 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8347 (let ((outline-regexp org-outline-regexp)
8348 (outline-level 'org-outline-level)
8349 (org-odd-levels-only nil) n)
8350 (save-excursion
8351 (goto-char (point-min))
8352 (while (re-search-forward "^\\*\\*+ " nil t)
8353 (setq n (/ (1- (length (match-string 0))) 2))
8354 (while (>= (setq n (1- n)) 0)
8355 (org-promote))
8356 (end-of-line 1))))))
8358 (defun org-tr-level (n)
8359 "Make N odd if required."
8360 (if org-odd-levels-only (1+ (/ n 2)) n))
8362 ;;; Vertical tree motion, cutting and pasting of subtrees
8364 (defun org-move-subtree-up (&optional arg)
8365 "Move the current subtree up past ARG headlines of the same level."
8366 (interactive "p")
8367 (org-move-subtree-down (- (prefix-numeric-value arg))))
8369 (defun org-move-subtree-down (&optional arg)
8370 "Move the current subtree down past ARG headlines of the same level."
8371 (interactive "p")
8372 (setq arg (prefix-numeric-value arg))
8373 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8374 'org-get-last-sibling))
8375 (ins-point (make-marker))
8376 (cnt (abs arg))
8377 (col (current-column))
8378 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8379 ;; Select the tree
8380 (org-back-to-heading)
8381 (setq beg0 (point))
8382 (save-excursion
8383 (setq ne-beg (org-back-over-empty-lines))
8384 (setq beg (point)))
8385 (save-match-data
8386 (save-excursion (outline-end-of-heading)
8387 (setq folded (outline-invisible-p)))
8388 (progn (org-end-of-subtree nil t)
8389 (unless (eobp) (backward-char))))
8390 (outline-next-heading)
8391 (setq ne-end (org-back-over-empty-lines))
8392 (setq end (point))
8393 (goto-char beg0)
8394 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8395 ;; include less whitespace
8396 (save-excursion
8397 (goto-char beg)
8398 (forward-line (- ne-beg ne-end))
8399 (setq beg (point))))
8400 ;; Find insertion point, with error handling
8401 (while (> cnt 0)
8402 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8403 (progn (goto-char beg0)
8404 (user-error "Cannot move past superior level or buffer limit")))
8405 (setq cnt (1- cnt)))
8406 (when (> arg 0)
8407 ;; Moving forward - still need to move over subtree
8408 (org-end-of-subtree t t)
8409 (save-excursion
8410 (org-back-over-empty-lines)
8411 (or (bolp) (newline))))
8412 (setq ne-ins (org-back-over-empty-lines))
8413 (move-marker ins-point (point))
8414 (setq txt (buffer-substring beg end))
8415 (org-save-markers-in-region beg end)
8416 (delete-region beg end)
8417 (org-remove-empty-overlays-at beg)
8418 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8419 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8420 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8421 (let ((bbb (point)))
8422 (insert-before-markers txt)
8423 (org-reinstall-markers-in-region bbb)
8424 (move-marker ins-point bbb))
8425 (or (bolp) (insert "\n"))
8426 (setq ins-end (point))
8427 (goto-char ins-point)
8428 (org-skip-whitespace)
8429 (when (and (< arg 0)
8430 (org-first-sibling-p)
8431 (> ne-ins ne-beg))
8432 ;; Move whitespace back to beginning
8433 (save-excursion
8434 (goto-char ins-end)
8435 (let ((kill-whole-line t))
8436 (kill-line (- ne-ins ne-beg)) (point)))
8437 (insert (make-string (- ne-ins ne-beg) ?\n)))
8438 (move-marker ins-point nil)
8439 (if folded
8440 (outline-hide-subtree)
8441 (org-show-entry)
8442 (org-show-children)
8443 (org-cycle-hide-drawers 'children))
8444 (org-clean-visibility-after-subtree-move)
8445 ;; move back to the initial column we were at
8446 (move-to-column col)))
8448 (defvar org-subtree-clip ""
8449 "Clipboard for cut and paste of subtrees.
8450 This is actually only a copy of the kill, because we use the normal kill
8451 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8453 (defvar org-subtree-clip-folded nil
8454 "Was the last copied subtree folded?
8455 This is used to fold the tree back after pasting.")
8457 (defun org-cut-subtree (&optional n)
8458 "Cut the current subtree into the clipboard.
8459 With prefix arg N, cut this many sequential subtrees.
8460 This is a short-hand for marking the subtree and then cutting it."
8461 (interactive "p")
8462 (org-copy-subtree n 'cut))
8464 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8465 "Copy the current subtree it in the clipboard.
8466 With prefix arg N, copy this many sequential subtrees.
8467 This is a short-hand for marking the subtree and then copying it.
8468 If CUT is non-nil, actually cut the subtree.
8469 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8470 of some markers in the region, even if CUT is non-nil. This is
8471 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8472 (interactive "p")
8473 (let (beg end folded (beg0 (point)))
8474 (if (org-called-interactively-p 'any)
8475 (org-back-to-heading nil) ; take what looks like a subtree
8476 (org-back-to-heading t)) ; take what is really there
8477 (setq beg (point))
8478 (skip-chars-forward " \t\r\n")
8479 (save-match-data
8480 (if nosubtrees
8481 (outline-next-heading)
8482 (save-excursion (outline-end-of-heading)
8483 (setq folded (outline-invisible-p)))
8484 (ignore-errors (org-forward-heading-same-level (1- n) t))
8485 (org-end-of-subtree t t)))
8486 ;; Include the end of an inlinetask
8487 (when (and (featurep 'org-inlinetask)
8488 (looking-at-p (concat (org-inlinetask-outline-regexp)
8489 "END[ \t]*$")))
8490 (end-of-line))
8491 (setq end (point))
8492 (goto-char beg0)
8493 (when (> end beg)
8494 (setq org-subtree-clip-folded folded)
8495 (when (or cut force-store-markers)
8496 (org-save-markers-in-region beg end))
8497 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8498 (setq org-subtree-clip (current-kill 0))
8499 (message "%s: Subtree(s) with %d characters"
8500 (if cut "Cut" "Copied")
8501 (length org-subtree-clip)))))
8503 (defun org-paste-subtree (&optional level tree for-yank remove)
8504 "Paste the clipboard as a subtree, with modification of headline level.
8505 The entire subtree is promoted or demoted in order to match a new headline
8506 level.
8508 If the cursor is at the beginning of a headline, the same level as
8509 that headline is used to paste the tree.
8511 If not, the new level is derived from the *visible* headings
8512 before and after the insertion point, and taken to be the inferior headline
8513 level of the two. So if the previous visible heading is level 3 and the
8514 next is level 4 (or vice versa), level 4 will be used for insertion.
8515 This makes sure that the subtree remains an independent subtree and does
8516 not swallow low level entries.
8518 You can also force a different level, either by using a numeric prefix
8519 argument, or by inserting the heading marker by hand. For example, if the
8520 cursor is after \"*****\", then the tree will be shifted to level 5.
8522 If optional TREE is given, use this text instead of the kill ring.
8524 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8525 move back over whitespace before inserting, and move point to the end of
8526 the inserted text when done.
8528 When REMOVE is non-nil, remove the subtree from the clipboard."
8529 (interactive "P")
8530 (setq tree (or tree (and kill-ring (current-kill 0))))
8531 (unless (org-kill-is-subtree-p tree)
8532 (user-error "%s"
8533 (substitute-command-keys
8534 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8535 (org-with-limited-levels
8536 (let* ((visp (not (outline-invisible-p)))
8537 (txt tree)
8538 (^re_ "\\(\\*+\\)[ \t]*")
8539 (old-level (if (string-match org-outline-regexp-bol txt)
8540 (- (match-end 0) (match-beginning 0) 1)
8541 -1))
8542 (force-level (cond (level (prefix-numeric-value level))
8543 ((and (looking-at "[ \t]*$")
8544 (string-match
8545 "^\\*+$" (buffer-substring
8546 (point-at-bol) (point))))
8547 (- (match-end 0) (match-beginning 0)))
8548 ((and (bolp)
8549 (looking-at org-outline-regexp))
8550 (- (match-end 0) (point) 1))))
8551 (previous-level (save-excursion
8552 (condition-case nil
8553 (progn
8554 (outline-previous-visible-heading 1)
8555 (if (looking-at ^re_)
8556 (- (match-end 0) (match-beginning 0) 1)
8558 (error 1))))
8559 (next-level (save-excursion
8560 (condition-case nil
8561 (progn
8562 (or (looking-at org-outline-regexp)
8563 (outline-next-visible-heading 1))
8564 (if (looking-at ^re_)
8565 (- (match-end 0) (match-beginning 0) 1)
8567 (error 1))))
8568 (new-level (or force-level (max previous-level next-level)))
8569 (shift (if (or (= old-level -1)
8570 (= new-level -1)
8571 (= old-level new-level))
8573 (- new-level old-level)))
8574 (delta (if (> shift 0) -1 1))
8575 (func (if (> shift 0) 'org-demote 'org-promote))
8576 (org-odd-levels-only nil)
8577 beg end newend)
8578 ;; Remove the forced level indicator
8579 (when force-level
8580 (delete-region (point-at-bol) (point)))
8581 ;; Paste
8582 (beginning-of-line (if (bolp) 1 2))
8583 (setq beg (point))
8584 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8585 (insert-before-markers txt)
8586 (unless (string-match "\n\\'" txt) (insert "\n"))
8587 (setq newend (point))
8588 (org-reinstall-markers-in-region beg)
8589 (setq end (point))
8590 (goto-char beg)
8591 (skip-chars-forward " \t\n\r")
8592 (setq beg (point))
8593 (when (and (outline-invisible-p) visp)
8594 (save-excursion (outline-show-heading)))
8595 ;; Shift if necessary
8596 (unless (= shift 0)
8597 (save-restriction
8598 (narrow-to-region beg end)
8599 (while (not (= shift 0))
8600 (org-map-region func (point-min) (point-max))
8601 (setq shift (+ delta shift)))
8602 (goto-char (point-min))
8603 (setq newend (point-max))))
8604 (when (or (org-called-interactively-p 'interactive) for-yank)
8605 (message "Clipboard pasted as level %d subtree" new-level))
8606 (when (and (not for-yank) ; in this case, org-yank will decide about folding
8607 kill-ring
8608 (eq org-subtree-clip (current-kill 0))
8609 org-subtree-clip-folded)
8610 ;; The tree was folded before it was killed/copied
8611 (outline-hide-subtree))
8612 (and for-yank (goto-char newend))
8613 (and remove (setq kill-ring (cdr kill-ring))))))
8615 (defun org-kill-is-subtree-p (&optional txt)
8616 "Check if the current kill is an outline subtree, or a set of trees.
8617 Returns nil if kill does not start with a headline, or if the first
8618 headline level is not the largest headline level in the tree.
8619 So this will actually accept several entries of equal levels as well,
8620 which is OK for `org-paste-subtree'.
8621 If optional TXT is given, check this string instead of the current kill."
8622 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8623 (re (org-get-limited-outline-regexp))
8624 (^re (concat "^" re))
8625 (start-level (and kill
8626 (string-match
8627 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8628 kill)
8629 (- (match-end 2) (match-beginning 2) 1)))
8630 (start (1+ (or (match-beginning 2) -1))))
8631 (if (not start-level)
8632 (progn
8633 nil) ;; does not even start with a heading
8634 (catch 'exit
8635 (while (setq start (string-match ^re kill (1+ start)))
8636 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8637 (throw 'exit nil)))
8638 t))))
8640 (defvar org-markers-to-move nil
8641 "Markers that should be moved with a cut-and-paste operation.
8642 Those markers are stored together with their positions relative to
8643 the start of the region.")
8645 (defun org-save-markers-in-region (beg end)
8646 "Check markers in region.
8647 If these markers are between BEG and END, record their position relative
8648 to BEG, so that after moving the block of text, we can put the markers back
8649 into place.
8650 This function gets called just before an entry or tree gets cut from the
8651 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8652 called immediately, to move the markers with the entries."
8653 (setq org-markers-to-move nil)
8654 (when (featurep 'org-clock)
8655 (org-clock-save-markers-for-cut-and-paste beg end))
8656 (when (featurep 'org-agenda)
8657 (org-agenda-save-markers-for-cut-and-paste beg end)))
8659 (defun org-check-and-save-marker (marker beg end)
8660 "Check if MARKER is between BEG and END.
8661 If yes, remember the marker and the distance to BEG."
8662 (when (and (marker-buffer marker)
8663 (equal (marker-buffer marker) (current-buffer))
8664 (>= marker beg) (< marker end))
8665 (push (cons marker (- marker beg)) org-markers-to-move)))
8667 (defun org-reinstall-markers-in-region (beg)
8668 "Move all remembered markers to their position relative to BEG."
8669 (mapc (lambda (x)
8670 (move-marker (car x) (+ beg (cdr x))))
8671 org-markers-to-move)
8672 (setq org-markers-to-move nil))
8674 (defun org-narrow-to-subtree ()
8675 "Narrow buffer to the current subtree."
8676 (interactive)
8677 (save-excursion
8678 (save-match-data
8679 (org-with-limited-levels
8680 (narrow-to-region
8681 (progn (org-back-to-heading t) (point))
8682 (progn (org-end-of-subtree t t)
8683 (when (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8684 (point)))))))
8686 (defun org-narrow-to-block ()
8687 "Narrow buffer to the current block."
8688 (interactive)
8689 (let* ((case-fold-search t)
8690 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8691 "^[ \t]*#\\+end_.*")))
8692 (if blockp
8693 (narrow-to-region (car blockp) (cdr blockp))
8694 (user-error "Not in a block"))))
8696 (defun org-clone-subtree-with-time-shift (n &optional shift)
8697 "Clone the task (subtree) at point N times.
8698 The clones will be inserted as siblings.
8700 In interactive use, the user will be prompted for the number of
8701 clones to be produced. If the entry has a timestamp, the user
8702 will also be prompted for a time shift, which may be a repeater
8703 as used in time stamps, for example `+3d'. To disable this,
8704 you can call the function with a universal prefix argument.
8706 When a valid repeater is given and the entry contains any time
8707 stamps, the clones will become a sequence in time, with time
8708 stamps in the subtree shifted for each clone produced. If SHIFT
8709 is nil or the empty string, time stamps will be left alone. The
8710 ID property of the original subtree is removed.
8712 If the original subtree did contain time stamps with a repeater,
8713 the following will happen:
8714 - the repeater will be removed in each clone
8715 - an additional clone will be produced, with the current, unshifted
8716 date(s) in the entry.
8717 - the original entry will be placed *after* all the clones, with
8718 repeater intact.
8719 - the start days in the repeater in the original entry will be shifted
8720 to past the last clone.
8721 In this way you can spell out a number of instances of a repeating task,
8722 and still retain the repeater to cover future instances of the task.
8724 As described above, N+1 clones are produced when the original
8725 subtree has a repeater. Setting N to 0, then, can be used to
8726 remove the repeater from a subtree and create a shifted clone
8727 with the original repeater."
8728 (interactive "nNumber of clones to produce: ")
8729 (let ((shift
8730 (or shift
8731 (if (and (not (equal current-prefix-arg '(4)))
8732 (save-excursion
8733 (re-search-forward org-ts-regexp-both
8734 (save-excursion
8735 (org-end-of-subtree t)
8736 (point)) t)))
8737 (read-from-minibuffer
8738 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8739 ""))) ;; No time shift
8740 (n-no-remove -1)
8741 (drawer-re org-drawer-regexp)
8742 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8743 beg end template task idprop
8744 shift-n shift-what doshift nmin nmax)
8745 (unless (wholenump n)
8746 (user-error "Invalid number of replications %s" n))
8747 (when (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8748 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8749 shift)))
8750 (user-error "Invalid shift specification %s" shift))
8751 (when doshift
8752 (setq shift-n (string-to-number (match-string 1 shift))
8753 shift-what (cdr (assoc (match-string 2 shift)
8754 '(("d" . day) ("w" . week)
8755 ("m" . month) ("y" . year))))))
8756 (when (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8757 (setq nmin 1 nmax n)
8758 (org-back-to-heading t)
8759 (setq beg (point))
8760 (setq idprop (org-entry-get nil "ID"))
8761 (org-end-of-subtree t t)
8762 (or (bolp) (insert "\n"))
8763 (setq end (point))
8764 (setq template (buffer-substring beg end))
8765 (when (and doshift
8766 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8767 (delete-region beg end)
8768 (setq end beg)
8769 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8770 (goto-char end)
8771 (loop for n from nmin to nmax do
8772 ;; prepare clone
8773 (with-temp-buffer
8774 (insert template)
8775 (org-mode)
8776 (goto-char (point-min))
8777 (org-show-subtree)
8778 (and idprop (if org-clone-delete-id
8779 (org-entry-delete nil "ID")
8780 (org-id-get-create t)))
8781 (unless (= n 0)
8782 (while (re-search-forward org-clock-re nil t)
8783 (kill-whole-line))
8784 (goto-char (point-min))
8785 (while (re-search-forward drawer-re nil t)
8786 (org-remove-empty-drawer-at (point))))
8787 (goto-char (point-min))
8788 (when doshift
8789 (while (re-search-forward org-ts-regexp-both nil t)
8790 (org-timestamp-change (* n shift-n) shift-what))
8791 (unless (= n n-no-remove)
8792 (goto-char (point-min))
8793 (while (re-search-forward org-ts-regexp nil t)
8794 (save-excursion
8795 (goto-char (match-beginning 0))
8796 (when (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8797 (delete-region (match-beginning 1) (match-end 1)))))))
8798 (setq task (buffer-string)))
8799 (insert task))
8800 (goto-char beg)))
8802 ;;; Outline Sorting
8804 (defun org-sort (with-case)
8805 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8806 Optional argument WITH-CASE means sort case-sensitively."
8807 (interactive "P")
8808 (cond
8809 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8810 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8812 (org-call-with-arg 'org-sort-entries with-case))))
8814 (defun org-sort-remove-invisible (s)
8815 "Remove invisible links from string S."
8816 (remove-text-properties 0 (length s) org-rm-props s)
8817 (while (string-match org-bracket-link-regexp s)
8818 (setq s (replace-match (if (match-end 2)
8819 (match-string 3 s)
8820 (match-string 1 s))
8821 t t s)))
8822 (let ((st (format " %s " s)))
8823 (while (string-match org-emph-re st)
8824 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8825 (setq s (substring st 1 -1)))
8828 (defvar org-priority-regexp) ; defined later in the file
8830 (defvar org-after-sorting-entries-or-items-hook nil
8831 "Hook that is run after a bunch of entries or items have been sorted.
8832 When children are sorted, the cursor is in the parent line when this
8833 hook gets called. When a region or a plain list is sorted, the cursor
8834 will be in the first entry of the sorted region/list.")
8836 (defun org-sort-entries
8837 (&optional with-case sorting-type getkey-func compare-func property)
8838 "Sort entries on a certain level of an outline tree.
8839 If there is an active region, the entries in the region are sorted.
8840 Else, if the cursor is before the first entry, sort the top-level items.
8841 Else, the children of the entry at point are sorted.
8843 Sorting can be alphabetically, numerically, by date/time as given by
8844 a time stamp, by a property, by priority order, or by a custom function.
8846 The command prompts for the sorting type unless it has been given to the
8847 function through the SORTING-TYPE argument, which needs to be a character,
8848 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8849 the precise meaning of each character:
8851 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8852 c By creation time, which is assumed to be the first inactive time stamp
8853 at the beginning of a line.
8854 d By deadline date/time.
8855 k By clocking time.
8856 n Numerically, by converting the beginning of the entry/item to a number.
8857 o By order of TODO keywords.
8858 p By priority according to the cookie.
8859 r By the value of a property.
8860 s By scheduled date/time.
8861 t By date/time, either the first active time stamp in the entry, or, if
8862 none exist, by the first inactive one.
8864 Capital letters will reverse the sort order.
8866 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8867 called with point at the beginning of the record. It must return either
8868 a string or a number that should serve as the sorting key for that record.
8870 Comparing entries ignores case by default. However, with an optional argument
8871 WITH-CASE, the sorting considers case as well.
8873 Sorting is done against the visible part of the headlines, it ignores hidden
8874 links.
8876 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8877 (interactive "P")
8878 (let ((case-func (if with-case 'identity 'downcase))
8879 (cmstr
8880 ;; The clock marker is lost when using `sort-subr', let's
8881 ;; store the clocking string.
8882 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8883 (save-excursion
8884 (goto-char org-clock-marker)
8885 (buffer-substring-no-properties (line-beginning-position)
8886 (point)))))
8887 start beg end stars re re2
8888 txt what tmp)
8889 ;; Find beginning and end of region to sort
8890 (cond
8891 ((org-region-active-p)
8892 ;; we will sort the region
8893 (setq end (region-end)
8894 what "region")
8895 (goto-char (region-beginning))
8896 (unless (org-at-heading-p) (outline-next-heading))
8897 (setq start (point)))
8898 ((or (org-at-heading-p)
8899 (ignore-errors (progn (org-back-to-heading) t)))
8900 ;; we will sort the children of the current headline
8901 (org-back-to-heading)
8902 (setq start (point)
8903 end (progn (org-end-of-subtree t t)
8904 (or (bolp) (insert "\n"))
8905 (when (>= (org-back-over-empty-lines) 1)
8906 (forward-line 1))
8907 (point))
8908 what "children")
8909 (goto-char start)
8910 (outline-show-subtree)
8911 (outline-next-heading))
8913 ;; we will sort the top-level entries in this file
8914 (goto-char (point-min))
8915 (or (org-at-heading-p) (outline-next-heading))
8916 (setq start (point))
8917 (goto-char (point-max))
8918 (beginning-of-line 1)
8919 (when (looking-at ".*?\\S-")
8920 ;; File ends in a non-white line
8921 (end-of-line 1)
8922 (insert "\n"))
8923 (setq end (point-max))
8924 (setq what "top-level")
8925 (goto-char start)
8926 (outline-show-all)))
8928 (setq beg (point))
8929 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8931 (looking-at "\\(\\*+\\)")
8932 (setq stars (match-string 1)
8933 re (concat "^" (regexp-quote stars) " +")
8934 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8935 txt (buffer-substring beg end))
8936 (unless (equal (substring txt -1) "\n") (setq txt (concat txt "\n")))
8937 (when (and (not (equal stars "*")) (string-match re2 txt))
8938 (user-error "Region to sort contains a level above the first entry"))
8940 (unless sorting-type
8941 (message
8942 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8943 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8944 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8945 what)
8946 (setq sorting-type (read-char-exclusive))
8948 (unless getkey-func
8949 (and (= (downcase sorting-type) ?f)
8950 (setq getkey-func
8951 (org-icompleting-read "Sort using function: "
8952 obarray 'fboundp t nil nil))
8953 (setq getkey-func (intern getkey-func))))
8955 (and (= (downcase sorting-type) ?r)
8956 (not property)
8957 (setq property
8958 (org-icompleting-read "Property: "
8959 (mapcar 'list (org-buffer-property-keys t))
8960 nil t))))
8962 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8963 (message "Sorting entries...")
8965 (save-restriction
8966 (narrow-to-region start end)
8967 (let ((dcst (downcase sorting-type))
8968 (case-fold-search nil)
8969 (now (current-time)))
8970 (sort-subr
8971 (/= dcst sorting-type)
8972 ;; This function moves to the beginning character of the "record" to
8973 ;; be sorted.
8974 (lambda nil
8975 (if (re-search-forward re nil t)
8976 (goto-char (match-beginning 0))
8977 (goto-char (point-max))))
8978 ;; This function moves to the last character of the "record" being
8979 ;; sorted.
8980 (lambda nil
8981 (save-match-data
8982 (condition-case nil
8983 (outline-forward-same-level 1)
8984 (error
8985 (goto-char (point-max))))))
8986 ;; This function returns the value that gets sorted against.
8987 (lambda nil
8988 (cond
8989 ((= dcst ?n)
8990 (if (looking-at org-complex-heading-regexp)
8991 (string-to-number (org-sort-remove-invisible (match-string 4)))
8992 nil))
8993 ((= dcst ?a)
8994 (if (looking-at org-complex-heading-regexp)
8995 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8996 nil))
8997 ((= dcst ?k)
8998 (or (get-text-property (point) :org-clock-minutes) 0))
8999 ((= dcst ?t)
9000 (let ((end (save-excursion (outline-next-heading) (point))))
9001 (if (or (re-search-forward org-ts-regexp end t)
9002 (re-search-forward org-ts-regexp-both end t))
9003 (org-time-string-to-seconds (match-string 0))
9004 (org-float-time now))))
9005 ((= dcst ?c)
9006 (let ((end (save-excursion (outline-next-heading) (point))))
9007 (if (re-search-forward
9008 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9009 end t)
9010 (org-time-string-to-seconds (match-string 0))
9011 (org-float-time now))))
9012 ((= dcst ?s)
9013 (let ((end (save-excursion (outline-next-heading) (point))))
9014 (if (re-search-forward org-scheduled-time-regexp end t)
9015 (org-time-string-to-seconds (match-string 1))
9016 (org-float-time now))))
9017 ((= dcst ?d)
9018 (let ((end (save-excursion (outline-next-heading) (point))))
9019 (if (re-search-forward org-deadline-time-regexp end t)
9020 (org-time-string-to-seconds (match-string 1))
9021 (org-float-time now))))
9022 ((= dcst ?p)
9023 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9024 (string-to-char (match-string 2))
9025 org-default-priority))
9026 ((= dcst ?r)
9027 (or (org-entry-get nil property) ""))
9028 ((= dcst ?o)
9029 (when (looking-at org-complex-heading-regexp)
9030 (let* ((m (match-string 2))
9031 (s (if (member m org-done-keywords) '- '+)))
9032 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9033 ((= dcst ?f)
9034 (if getkey-func
9035 (progn
9036 (setq tmp (funcall getkey-func))
9037 (when (stringp tmp) (setq tmp (funcall case-func tmp)))
9038 tmp)
9039 (error "Invalid key function `%s'" getkey-func)))
9040 (t (error "Invalid sorting type `%c'" sorting-type))))
9042 (cond
9043 ((= dcst ?a) 'string<)
9044 ((= dcst ?f) compare-func)
9045 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9046 (run-hooks 'org-after-sorting-entries-or-items-hook)
9047 ;; Reset the clock marker if needed
9048 (when cmstr
9049 (save-excursion
9050 (goto-char start)
9051 (search-forward cmstr nil t)
9052 (move-marker org-clock-marker (point))))
9053 (message "Sorting entries...done")))
9055 ;;; The orgstruct minor mode
9057 ;; Define a minor mode which can be used in other modes in order to
9058 ;; integrate the org-mode structure editing commands.
9060 ;; This is really a hack, because the org-mode structure commands use
9061 ;; keys which normally belong to the major mode. Here is how it
9062 ;; works: The minor mode defines all the keys necessary to operate the
9063 ;; structure commands, but wraps the commands into a function which
9064 ;; tests if the cursor is currently at a headline or a plain list
9065 ;; item. If that is the case, the structure command is used,
9066 ;; temporarily setting many Org-mode variables like regular
9067 ;; expressions for filling etc. However, when any of those keys is
9068 ;; used at a different location, function uses `key-binding' to look
9069 ;; up if the key has an associated command in another currently active
9070 ;; keymap (minor modes, major mode, global), and executes that
9071 ;; command. There might be problems if any of the keys is otherwise
9072 ;; used as a prefix key.
9074 (defcustom orgstruct-heading-prefix-regexp ""
9075 "Regexp that matches the custom prefix of Org headlines in
9076 orgstruct(++)-mode."
9077 :group 'org
9078 :version "24.4"
9079 :package-version '(Org . "8.3")
9080 :type 'regexp)
9081 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9083 (defcustom orgstruct-setup-hook nil
9084 "Hook run after orgstruct-mode-map is filled."
9085 :group 'org
9086 :version "24.4"
9087 :package-version '(Org . "8.0")
9088 :type 'hook)
9090 (defvar orgstruct-initialized nil)
9092 (defvar org-local-vars nil
9093 "List of local variables, for use by `orgstruct-mode'.")
9095 ;;;###autoload
9096 (define-minor-mode orgstruct-mode
9097 "Toggle the minor mode `orgstruct-mode'.
9098 This mode is for using Org-mode structure commands in other
9099 modes. The following keys behave as if Org-mode were active, if
9100 the cursor is on a headline, or on a plain list item (both as
9101 defined by Org-mode)."
9102 nil " OrgStruct" (make-sparse-keymap)
9103 (funcall (if orgstruct-mode
9104 'add-to-invisibility-spec
9105 'remove-from-invisibility-spec)
9106 '(outline . t))
9107 (when orgstruct-mode
9108 (org-load-modules-maybe)
9109 (unless orgstruct-initialized
9110 (orgstruct-setup)
9111 (setq orgstruct-initialized t))))
9113 ;;;###autoload
9114 (defun turn-on-orgstruct ()
9115 "Unconditionally turn on `orgstruct-mode'."
9116 (orgstruct-mode 1))
9118 (defvar-local org-fb-vars nil)
9119 (defun orgstruct++-mode (&optional arg)
9120 "Toggle `orgstruct-mode', the enhanced version of it.
9121 In addition to setting orgstruct-mode, this also exports all
9122 indentation and autofilling variables from org-mode into the
9123 buffer. It will also recognize item context in multiline items."
9124 (interactive "P")
9125 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9126 (if (< arg 1)
9127 (progn (orgstruct-mode -1)
9128 (mapc (lambda(v)
9129 (set (make-local-variable (car v))
9130 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9131 org-fb-vars))
9132 (orgstruct-mode 1)
9133 (setq org-fb-vars nil)
9134 (unless org-local-vars
9135 (setq org-local-vars (org-get-local-variables)))
9136 (let (var val)
9137 (mapc
9138 (lambda (x)
9139 (when (string-match
9140 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9141 (symbol-name (car x)))
9142 (setq var (car x) val (nth 1 x))
9143 (push (list var `(quote ,(eval var))) org-fb-vars)
9144 (set (make-local-variable var)
9145 (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9146 org-local-vars)
9147 (setq-local orgstruct-is-++ t))))
9149 (defvar-local orgstruct-is-++ nil
9150 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9152 ;;;###autoload
9153 (defun turn-on-orgstruct++ ()
9154 "Unconditionally turn on `orgstruct++-mode'."
9155 (orgstruct++-mode 1))
9157 (defun orgstruct-error ()
9158 "Error when there is no default binding for a structure key."
9159 (interactive)
9160 (funcall (if (fboundp 'user-error)
9161 'user-error
9162 'error)
9163 "This key has no function outside structure elements"))
9165 (defun orgstruct-setup ()
9166 "Setup orgstruct keymap."
9167 (dolist (cell '((org-demote . t)
9168 (org-metaleft . t)
9169 (org-metaright . t)
9170 (org-promote . t)
9171 (org-shiftmetaleft . t)
9172 (org-shiftmetaright . t)
9173 org-backward-element
9174 org-backward-heading-same-level
9175 org-ctrl-c-ret
9176 org-ctrl-c-minus
9177 org-ctrl-c-star
9178 org-cycle
9179 org-forward-heading-same-level
9180 org-insert-heading
9181 org-insert-heading-respect-content
9182 org-kill-note-or-show-branches
9183 org-mark-subtree
9184 org-meta-return
9185 org-metadown
9186 org-metaup
9187 org-narrow-to-subtree
9188 org-promote-subtree
9189 org-reveal
9190 org-shiftdown
9191 org-shiftleft
9192 org-shiftmetadown
9193 org-shiftmetaup
9194 org-shiftright
9195 org-shifttab
9196 org-shifttab
9197 org-shiftup
9198 org-show-children
9199 org-show-subtree
9200 org-sort
9201 org-up-element
9202 outline-demote
9203 outline-next-visible-heading
9204 outline-previous-visible-heading
9205 outline-promote
9206 outline-up-heading))
9207 (let ((f (or (car-safe cell) cell))
9208 (disable-when-heading-prefix (cdr-safe cell)))
9209 (when (fboundp f)
9210 (let ((new-bindings))
9211 (dolist (binding (nconc (where-is-internal f org-mode-map)
9212 (where-is-internal f outline-mode-map)))
9213 (push binding new-bindings)
9214 ;; TODO use local-function-key-map
9215 (dolist (rep '(("<tab>" . "TAB")
9216 ("<return>" . "RET")
9217 ("<escape>" . "ESC")
9218 ("<delete>" . "DEL")))
9219 (setq binding (read-kbd-macro
9220 (let ((case-fold-search))
9221 (replace-regexp-in-string
9222 (regexp-quote (cdr rep))
9223 (car rep)
9224 (key-description binding)))))
9225 (pushnew binding new-bindings :test 'equal)))
9226 (dolist (binding new-bindings)
9227 (let ((key (lookup-key orgstruct-mode-map binding)))
9228 (when (or (not key) (numberp key))
9229 (ignore-errors
9230 (org-defkey orgstruct-mode-map
9231 binding
9232 (orgstruct-make-binding
9233 f binding disable-when-heading-prefix))))))))))
9234 (run-hooks 'orgstruct-setup-hook))
9236 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9237 "Create a function for binding in the structure minor mode.
9238 FUN is the command to call inside a table. KEY is the key that
9239 should be checked in for a command to execute outside of tables.
9240 Non-nil `disable-when-heading-prefix' means to disable the command
9241 if `orgstruct-heading-prefix-regexp' is not empty."
9242 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9243 (let ((nname name)
9244 (i 0))
9245 (while (fboundp (intern nname))
9246 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9247 (setq name (intern nname)))
9248 (eval
9249 (let ((bindings '((org-heading-regexp
9250 (concat "^"
9251 orgstruct-heading-prefix-regexp
9252 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9253 (org-outline-regexp
9254 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9255 (org-outline-regexp-bol
9256 (concat "^" org-outline-regexp))
9257 (outline-regexp org-outline-regexp)
9258 (outline-heading-end-regexp "\n")
9259 (outline-level 'org-outline-level)
9260 (outline-heading-alist))))
9261 `(defun ,name (arg)
9262 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9263 "Outside of structure, run the binding of `"
9264 (key-description key) "'."
9265 (when disable-when-heading-prefix
9266 (concat
9267 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9268 "back to the default binding due to limitations of Org's implementation of\n"
9269 "`" (symbol-name fun) "'.")))
9270 (interactive "p")
9271 (let* ((disable
9272 ,(and disable-when-heading-prefix
9273 '(not (string= orgstruct-heading-prefix-regexp ""))))
9274 (fallback
9275 (or disable
9276 (not
9277 (let* ,bindings
9278 (org-context-p 'headline 'item
9279 ,(when (memq fun
9280 '(org-insert-heading
9281 org-insert-heading-respect-content
9282 org-meta-return))
9283 '(when orgstruct-is-++
9284 'item-body))))))))
9285 (if fallback
9286 (let* ((orgstruct-mode)
9287 (binding
9288 (let ((key ,key))
9289 (catch 'exit
9290 (dolist
9291 (rep
9292 '(nil
9293 ("<\\([^>]*\\)tab>" . "\\1TAB")
9294 ("<\\([^>]*\\)return>" . "\\1RET")
9295 ("<\\([^>]*\\)escape>" . "\\1ESC")
9296 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9297 nil)
9298 (when rep
9299 (setq key (read-kbd-macro
9300 (let ((case-fold-search))
9301 (replace-regexp-in-string
9302 (car rep)
9303 (cdr rep)
9304 (key-description key))))))
9305 (when (key-binding key)
9306 (throw 'exit (key-binding key))))))))
9307 (if (keymapp binding)
9308 (org-set-transient-map binding)
9309 (let ((func (or binding
9310 (unless disable
9311 'orgstruct-error))))
9312 (when func
9313 (call-interactively func)))))
9314 (org-run-like-in-org-mode
9315 (lambda ()
9316 (interactive)
9317 (let* ,bindings
9318 (call-interactively ',fun)))))))))
9319 name))
9321 (defun org-contextualize-keys (alist contexts)
9322 "Return valid elements in ALIST depending on CONTEXTS.
9324 `org-agenda-custom-commands' or `org-capture-templates' are the
9325 values used for ALIST, and `org-agenda-custom-commands-contexts'
9326 or `org-capture-templates-contexts' are the associated contexts
9327 definitions."
9328 (let ((contexts
9329 ;; normalize contexts
9330 (mapcar
9331 (lambda(c) (cond ((listp (cadr c))
9332 (list (car c) (car c) (cadr c)))
9333 ((string= "" (cadr c))
9334 (list (car c) (car c) (caddr c)))
9335 (t c)))
9336 contexts))
9337 (a alist) r s)
9338 ;; loop over all commands or templates
9339 (dolist (c a)
9340 (let (vrules repl)
9341 (cond
9342 ((not (assoc (car c) contexts))
9343 (push c r))
9344 ((and (assoc (car c) contexts)
9345 (setq vrules (org-contextualize-validate-key
9346 (car c) contexts)))
9347 (mapc (lambda (vr)
9348 (unless (equal (car vr) (cadr vr))
9349 (setq repl vr)))
9350 vrules)
9351 (if (not repl) (push c r)
9352 (push (cadr repl) s)
9353 (push
9354 (cons (car c)
9355 (cdr (or (assoc (cadr repl) alist)
9356 (error "Undefined key `%s' as contextual replacement for `%s'"
9357 (cadr repl) (car c)))))
9358 r))))))
9359 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9360 (delq
9362 (delete-dups
9363 (mapcar (lambda (x)
9364 (let ((tpl (car x)))
9365 (unless (delq
9367 (mapcar (lambda (y)
9368 (equal y tpl))
9370 x)))
9371 (reverse r))))))
9373 (defun org-contextualize-validate-key (key contexts)
9374 "Check CONTEXTS for agenda or capture KEY."
9375 (let (rr res)
9376 (dolist (r contexts)
9377 (mapc
9378 (lambda (rr)
9379 (when
9380 (and (equal key (car r))
9381 (if (functionp rr) (funcall rr)
9382 (or (and (eq (car rr) 'in-file)
9383 (buffer-file-name)
9384 (string-match (cdr rr) (buffer-file-name)))
9385 (and (eq (car rr) 'in-mode)
9386 (string-match (cdr rr) (symbol-name major-mode)))
9387 (and (eq (car rr) 'in-buffer)
9388 (string-match (cdr rr) (buffer-name)))
9389 (when (and (eq (car rr) 'not-in-file)
9390 (buffer-file-name))
9391 (not (string-match (cdr rr) (buffer-file-name))))
9392 (when (eq (car rr) 'not-in-mode)
9393 (not (string-match (cdr rr) (symbol-name major-mode))))
9394 (when (eq (car rr) 'not-in-buffer)
9395 (not (string-match (cdr rr) (buffer-name)))))))
9396 (push r res)))
9397 (car (last r))))
9398 (delete-dups (delq nil res))))
9400 (defun org-context-p (&rest contexts)
9401 "Check if local context is any of CONTEXTS.
9402 Possible values in the list of contexts are `table', `headline', and `item'."
9403 (let ((pos (point)))
9404 (goto-char (point-at-bol))
9405 (prog1 (or (and (memq 'table contexts)
9406 (looking-at "[ \t]*|"))
9407 (and (memq 'headline contexts)
9408 (looking-at org-outline-regexp))
9409 (and (memq 'item contexts)
9410 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9411 (and (memq 'item-body contexts)
9412 (org-in-item-p)))
9413 (goto-char pos))))
9415 (defun org-get-local-variables ()
9416 "Return a list of all local variables in an Org mode buffer."
9417 (let (varlist)
9418 (with-current-buffer (get-buffer-create "*Org tmp*")
9419 (erase-buffer)
9420 (org-mode)
9421 (setq varlist (buffer-local-variables)))
9422 (kill-buffer "*Org tmp*")
9423 (delq nil
9424 (mapcar
9425 (lambda (x)
9426 (setq x
9427 (if (symbolp x)
9428 (list x)
9429 (list (car x) (cdr x))))
9430 (if (and (not (get (car x) 'org-state))
9431 (string-match
9432 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9433 (symbol-name (car x))))
9434 x nil))
9435 varlist))))
9437 (defun org-clone-local-variables (from-buffer &optional regexp)
9438 "Clone local variables from FROM-BUFFER.
9439 Optional argument REGEXP selects variables to clone."
9440 (mapc
9441 (lambda (pair)
9442 (and (symbolp (car pair))
9443 (or (null regexp)
9444 (string-match regexp (symbol-name (car pair))))
9445 (set (make-local-variable (car pair))
9446 (cdr pair))))
9447 (buffer-local-variables from-buffer)))
9449 ;;;###autoload
9450 (defun org-run-like-in-org-mode (cmd)
9451 "Run a command, pretending that the current buffer is in Org-mode.
9452 This will temporarily bind local variables that are typically bound in
9453 Org-mode to the values they have in Org-mode, and then interactively
9454 call CMD."
9455 (org-load-modules-maybe)
9456 (unless org-local-vars
9457 (setq org-local-vars (org-get-local-variables)))
9458 (let (binds)
9459 (dolist (var org-local-vars)
9460 (when (or (not (boundp (car var)))
9461 (eq (symbol-value (car var))
9462 (default-value (car var))))
9463 (push (list (car var) `(quote ,(cadr var))) binds)))
9464 (eval `(let ,binds
9465 (call-interactively (quote ,cmd))))))
9467 (defun org-get-category (&optional pos force-refresh)
9468 "Get the category applying to position POS."
9469 (save-match-data
9470 (when force-refresh (org-refresh-category-properties))
9471 (let ((pos (or pos (point))))
9472 (or (get-text-property pos 'org-category)
9473 (progn (org-refresh-category-properties)
9474 (get-text-property pos 'org-category))))))
9476 ;;; Refresh properties
9478 (defun org-refresh-properties (dprop tprop)
9479 "Refresh buffer text properties.
9480 DPROP is the drawer property and TPROP is either the
9481 corresponding text property to set, or an alist with each element
9482 being a text property (as a symbol) and a function to apply to
9483 the value of the drawer property."
9484 (let ((case-fold-search t)
9485 (inhibit-read-only t))
9486 (org-with-silent-modifications
9487 (save-excursion
9488 (save-restriction
9489 (widen)
9490 (goto-char (point-min))
9491 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9492 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9494 (defun org-refresh-property (tprop p)
9495 "Refresh the buffer text property TPROP from the drawer property P.
9496 The refresh happens only for the current tree (not subtree)."
9497 (unless (org-before-first-heading-p)
9498 (save-excursion
9499 (org-back-to-heading t)
9500 (if (symbolp tprop)
9501 ;; TPROP is a text property symbol
9502 (put-text-property
9503 (point) (or (outline-next-heading) (point-max)) tprop p)
9504 ;; TPROP is an alist with (properties . function) elements
9505 (dolist (al tprop)
9506 (save-excursion
9507 (put-text-property
9508 (line-beginning-position) (or (outline-next-heading) (point-max))
9509 (car al)
9510 (funcall (cdr al) p))))))))
9512 (defun org-refresh-category-properties ()
9513 "Refresh category text properties in the buffer."
9514 (let ((case-fold-search t)
9515 (inhibit-read-only t)
9516 (default-category
9517 (cond ((null org-category)
9518 (if buffer-file-name
9519 (file-name-sans-extension
9520 (file-name-nondirectory buffer-file-name))
9521 "???"))
9522 ((symbolp org-category) (symbol-name org-category))
9523 (t org-category))))
9524 (org-with-silent-modifications
9525 (org-with-wide-buffer
9526 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9527 ;; This is the default category for the buffer. If none is
9528 ;; found, fall-back to `org-category' or buffer file name.
9529 (put-text-property
9530 (point-min) (point-max)
9531 'org-category
9532 (catch 'buffer-category
9533 (goto-char (point-max))
9534 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9535 (let ((element (org-element-at-point)))
9536 (when (eq (org-element-type element) 'keyword)
9537 (throw 'buffer-category
9538 (org-element-property :value element)))))
9539 default-category))
9540 ;; Set sub-tree specific categories.
9541 (goto-char (point-min))
9542 (let ((regexp (org-re-property "CATEGORY")))
9543 (while (re-search-forward regexp nil t)
9544 (let ((value (org-match-string-no-properties 3)))
9545 (when (org-at-property-p)
9546 (put-text-property
9547 (save-excursion (org-back-to-heading t) (point))
9548 (save-excursion (org-end-of-subtree t t) (point))
9549 'org-category
9550 value)))))))))
9552 (defun org-refresh-stats-properties ()
9553 "Refresh stats text properties in the buffer."
9554 (let (stats)
9555 (org-with-silent-modifications
9556 (save-excursion
9557 (save-restriction
9558 (widen)
9559 (goto-char (point-min))
9560 (while (re-search-forward
9561 (concat org-outline-regexp-bol ".*"
9562 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9563 nil t)
9564 (setq stats (cond ((equal (match-string 3) "0") 0)
9565 ((match-string 2)
9566 (/ (* (string-to-number (match-string 2)) 100)
9567 (string-to-number (match-string 3))))
9568 (t (string-to-number (match-string 1)))))
9569 (org-back-to-heading t)
9570 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9571 'org-stats stats)))))))
9573 (defun org-refresh-effort-properties ()
9574 "Refresh effort properties"
9575 (org-refresh-properties
9576 org-effort-property
9577 '((effort . identity)
9578 (effort-minutes . org-duration-string-to-minutes))))
9580 ;;;; Link Stuff
9582 ;;; Link abbreviations
9584 (defun org-link-expand-abbrev (link)
9585 "Apply replacements as defined in `org-link-abbrev-alist'."
9586 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9587 (let* ((key (match-string 1 link))
9588 (as (or (assoc key org-link-abbrev-alist-local)
9589 (assoc key org-link-abbrev-alist)))
9590 (tag (and (match-end 2) (match-string 3 link)))
9591 rpl)
9592 (if (not as)
9593 link
9594 (setq rpl (cdr as))
9595 (cond
9596 ((symbolp rpl) (funcall rpl tag))
9597 ((string-match "%(\\([^)]+\\))" rpl)
9598 (replace-match
9599 (save-match-data
9600 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9601 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9602 ((string-match "%h" rpl)
9603 (replace-match (url-hexify-string (or tag "")) t t rpl))
9604 (t (concat rpl tag)))))
9605 link))
9607 ;;; Storing and inserting links
9609 (defvar org-insert-link-history nil
9610 "Minibuffer history for links inserted with `org-insert-link'.")
9612 (defvar org-stored-links nil
9613 "Contains the links stored with `org-store-link'.")
9615 (defvar org-store-link-plist nil
9616 "Plist with info about the most recently link created with `org-store-link'.")
9618 (defvar org-link-protocols nil
9619 "Link protocols added to Org-mode using `org-add-link-type'.")
9621 (defvar org-store-link-functions nil
9622 "List of functions that are called to create and store a link.
9623 Each function will be called in turn until one returns a non-nil
9624 value. Each function should check if it is responsible for creating
9625 this link (for example by looking at the major mode).
9626 If not, it must exit and return nil.
9627 If yes, it should return a non-nil value after a calling
9628 `org-store-link-props' with a list of properties and values.
9629 Special properties are:
9631 :type The link prefix, like \"http\". This must be given.
9632 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9633 This is obligatory as well.
9634 :description Optional default description for the second pair
9635 of brackets in an Org-mode link. The user can still change
9636 this when inserting this link into an Org-mode buffer.
9638 In addition to these, any additional properties can be specified
9639 and then used in capture templates.")
9641 (defun org-add-link-type (type &optional follow export)
9642 "Add TYPE to the list of `org-link-types'.
9643 Re-compute all regular expressions depending on `org-link-types'
9645 FOLLOW and EXPORT are two functions.
9647 FOLLOW should take the link path as the single argument and do whatever
9648 is necessary to follow the link, for example find a file or display
9649 a mail message.
9651 EXPORT should format the link path for export to one of the export formats.
9652 It should be a function accepting three arguments:
9654 path the path of the link, the text after the prefix (like \"http:\")
9655 desc the description of the link, if any
9656 format the export format, a symbol like `html' or `latex' or `ascii'.
9658 The function may use the FORMAT information to return different values
9659 depending on the format. The return value will be put literally into
9660 the exported file. If the return value is nil, this means Org should
9661 do what it normally does with links which do not have EXPORT defined.
9663 Org mode has a built-in default for exporting links. If you are happy with
9664 this default, there is no need to define an export function for the link
9665 type. For a simple example of an export function, see `org-bbdb.el'."
9666 (add-to-list 'org-link-types type t)
9667 (org-make-link-regexps)
9668 (org-element-update-syntax)
9669 (if (assoc type org-link-protocols)
9670 (setcdr (assoc type org-link-protocols) (list follow export))
9671 (push (list type follow export) org-link-protocols)))
9673 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9674 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9676 ;;;###autoload
9677 (defun org-store-link (arg)
9678 "\\<org-mode-map>Store an org-link to the current location.
9679 This link is added to `org-stored-links' and can later be inserted
9680 into an Org buffer with \\[org-insert-link].
9682 For some link types, a prefix ARG is interpreted.
9683 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9684 For file links, ARG negates `org-context-in-file-links'.
9686 A double prefix ARG force skipping storing functions that are not
9687 part of Org's core.
9689 A triple prefix ARG force storing a link for each line in the
9690 active region."
9691 (interactive "P")
9692 (org-load-modules-maybe)
9693 (if (and (equal arg '(64)) (org-region-active-p))
9694 (save-excursion
9695 (let ((end (region-end)))
9696 (goto-char (region-beginning))
9697 (set-mark (point))
9698 (while (< (point-at-eol) end)
9699 (move-end-of-line 1) (activate-mark)
9700 (let (current-prefix-arg)
9701 (call-interactively 'org-store-link))
9702 (move-beginning-of-line 2)
9703 (set-mark (point)))))
9704 (org-with-limited-levels
9705 (setq org-store-link-plist nil)
9706 (let (link cpltxt desc description search
9707 txt custom-id agenda-link sfuns sfunsn)
9708 (cond
9710 ;; Store a link using an external link type
9711 ((and (not (equal arg '(16)))
9712 (setq sfuns
9713 (delq
9714 nil (mapcar (lambda (f)
9715 (let (fs) (if (funcall f) (push f fs))))
9716 org-store-link-functions))
9717 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9718 (or (and (cdr sfuns)
9719 (funcall (intern
9720 (completing-read
9721 "Which function for creating the link? "
9722 sfunsn nil t (car sfunsn)))))
9723 (funcall (caar sfuns)))
9724 (setq link (plist-get org-store-link-plist :link)
9725 desc (or (plist-get org-store-link-plist
9726 :description)
9727 link))))
9729 ;; Store a link from a source code buffer.
9730 ((org-src-edit-buffer-p)
9731 (cond
9732 ((save-excursion
9733 (beginning-of-line)
9734 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9735 "[ \t]*$")))
9736 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9737 ((org-called-interactively-p 'any)
9738 (let (label)
9739 (while (or (not label)
9740 (org-with-wide-buffer
9741 (goto-char (point-min))
9742 (re-search-forward
9743 (regexp-quote (format org-coderef-label-format label))
9744 nil t)))
9745 (when label (message "Label exists already") (sit-for 2))
9746 (setq label (read-string "Code line label: " label)))
9747 (end-of-line)
9748 (setq link (format org-coderef-label-format label))
9749 (let ((gc (- 79 (length link))))
9750 (if (< (current-column) gc) (org-move-to-column gc t)
9751 (insert " ")))
9752 (insert link)
9753 (setq link (concat "(" label ")") desc nil)))
9754 (t (setq link nil))))
9756 ;; We are in the agenda, link to referenced location
9757 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9758 (let ((m (or (get-text-property (point) 'org-hd-marker)
9759 (get-text-property (point) 'org-marker))))
9760 (when m
9761 (org-with-point-at m
9762 (setq agenda-link
9763 (if (org-called-interactively-p 'any)
9764 (call-interactively 'org-store-link)
9765 (org-store-link nil)))))))
9767 ((eq major-mode 'calendar-mode)
9768 (let ((cd (calendar-cursor-to-date)))
9769 (setq link
9770 (format-time-string
9771 (car org-time-stamp-formats)
9772 (apply 'encode-time
9773 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9774 nil nil nil))))
9775 (org-store-link-props :type "calendar" :date cd)))
9777 ((eq major-mode 'help-mode)
9778 (setq link (concat "help:" (save-excursion
9779 (goto-char (point-min))
9780 (looking-at "^[^ ]+")
9781 (match-string 0))))
9782 (org-store-link-props :type "help"))
9784 ((eq major-mode 'w3-mode)
9785 (setq cpltxt (if (and (buffer-name)
9786 (not (string-match "Untitled" (buffer-name))))
9787 (buffer-name)
9788 (url-view-url t))
9789 link (url-view-url t))
9790 (org-store-link-props :type "w3" :url (url-view-url t)))
9792 ((eq major-mode 'image-mode)
9793 (setq cpltxt (concat "file:"
9794 (abbreviate-file-name buffer-file-name))
9795 link cpltxt)
9796 (org-store-link-props :type "image" :file buffer-file-name))
9798 ;; In dired, store a link to the file of the current line
9799 ((derived-mode-p 'dired-mode)
9800 (let ((file (dired-get-filename nil t)))
9801 (setq file (if file
9802 (abbreviate-file-name
9803 (expand-file-name (dired-get-filename nil t)))
9804 ;; otherwise, no file so use current directory.
9805 default-directory))
9806 (setq cpltxt (concat "file:" file)
9807 link cpltxt)))
9809 ((setq search (run-hook-with-args-until-success
9810 'org-create-file-search-functions))
9811 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9812 "::" search))
9813 (setq cpltxt (or description link)))
9815 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9816 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9817 (cond
9818 ;; Store a link using the target at point
9819 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9820 (setq cpltxt
9821 (concat "file:"
9822 (abbreviate-file-name
9823 (buffer-file-name (buffer-base-buffer)))
9824 "::" (match-string 1))
9825 link cpltxt))
9826 ((and (featurep 'org-id)
9827 (or (eq org-id-link-to-org-use-id t)
9828 (and (org-called-interactively-p 'any)
9829 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9830 (and (eq org-id-link-to-org-use-id
9831 'create-if-interactive-and-no-custom-id)
9832 (not custom-id))))
9833 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9834 ;; Store a link using the ID at point
9835 (setq link (condition-case nil
9836 (prog1 (org-id-store-link)
9837 (setq desc (or (plist-get org-store-link-plist
9838 :description)
9839 "")))
9840 (error
9841 ;; Probably before first headline, link only to file
9842 (concat "file:"
9843 (abbreviate-file-name
9844 (buffer-file-name (buffer-base-buffer))))))))
9846 ;; Just link to current headline
9847 (setq cpltxt (concat "file:"
9848 (abbreviate-file-name
9849 (buffer-file-name (buffer-base-buffer)))))
9850 ;; Add a context search string
9851 (when (org-xor org-context-in-file-links arg)
9852 (let* ((ee (org-element-at-point))
9853 (et (org-element-type ee))
9854 (ev (plist-get (cadr ee) :value))
9855 (ek (plist-get (cadr ee) :key))
9856 (eok (and (stringp ek) (string-match "name" ek))))
9857 (setq txt (cond
9858 ((org-at-heading-p) nil)
9859 ((and (eq et 'keyword) eok) ev)
9860 ((org-region-active-p)
9861 (buffer-substring (region-beginning) (region-end)))))
9862 (when (or (null txt) (string-match "\\S-" txt))
9863 (setq cpltxt
9864 (concat cpltxt "::"
9865 (condition-case nil
9866 (org-make-org-heading-search-string txt)
9867 (error "")))
9868 desc (or (and (eq et 'keyword) eok ev)
9869 (nth 4 (ignore-errors (org-heading-components)))
9870 "NONE")))))
9871 (when (string-match "::\\'" cpltxt)
9872 (setq cpltxt (substring cpltxt 0 -2)))
9873 (setq link cpltxt))))
9875 ((buffer-file-name (buffer-base-buffer))
9876 ;; Just link to this file here.
9877 (setq cpltxt (concat "file:"
9878 (abbreviate-file-name
9879 (buffer-file-name (buffer-base-buffer)))))
9880 ;; Add a context string.
9881 (when (org-xor org-context-in-file-links arg)
9882 (setq txt (if (org-region-active-p)
9883 (buffer-substring (region-beginning) (region-end))
9884 (buffer-substring (point-at-bol) (point-at-eol))))
9885 ;; Only use search option if there is some text.
9886 (when (string-match "\\S-" txt)
9887 (setq cpltxt
9888 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9889 desc "NONE")))
9890 (setq link cpltxt))
9892 ((org-called-interactively-p 'interactive)
9893 (user-error "No method for storing a link from this buffer"))
9895 (t (setq link nil)))
9897 ;; We're done setting link and desc, clean up
9898 (when (consp link) (setq cpltxt (car link) link (cdr link)))
9899 (setq link (or link cpltxt)
9900 desc (or desc cpltxt))
9901 (cond ((equal desc "NONE") (setq desc nil))
9902 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9903 (let ((d0 (match-string 3 desc))
9904 (p0 (match-string 5 desc)))
9905 (setq desc
9906 (replace-regexp-in-string
9907 org-bracket-link-regexp
9908 (concat (or p0 d0)
9909 (if (equal (length (match-string 0 desc))
9910 (length desc)) "*" "")) desc)))))
9912 ;; Return the link
9913 (if (not (and (or (org-called-interactively-p 'any)
9914 executing-kbd-macro)
9915 link))
9916 (or agenda-link (and link (org-make-link-string link desc)))
9917 (push (list link desc) org-stored-links)
9918 (message "Stored: %s" (or desc link))
9919 (when custom-id
9920 (setq link (concat "file:" (abbreviate-file-name
9921 (buffer-file-name)) "::#" custom-id))
9922 (push (list link desc) org-stored-links))
9923 (car org-stored-links))))))
9925 (defun org-store-link-props (&rest plist)
9926 "Store link properties, extract names and addresses."
9927 (let (x adr)
9928 (when (setq x (plist-get plist :from))
9929 (setq adr (mail-extract-address-components x))
9930 (setq plist (plist-put plist :fromname (car adr)))
9931 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9932 (when (setq x (plist-get plist :to))
9933 (setq adr (mail-extract-address-components x))
9934 (setq plist (plist-put plist :toname (car adr)))
9935 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9936 (let ((from (plist-get plist :from))
9937 (to (plist-get plist :to)))
9938 (when (and from to org-from-is-user-regexp)
9939 (setq plist
9940 (plist-put plist :fromto
9941 (if (string-match org-from-is-user-regexp from)
9942 (concat "to %t")
9943 (concat "from %f"))))))
9944 (setq org-store-link-plist plist))
9946 (defun org-add-link-props (&rest plist)
9947 "Add these properties to the link property list."
9948 (let (key value)
9949 (while plist
9950 (setq key (pop plist) value (pop plist))
9951 (setq org-store-link-plist
9952 (plist-put org-store-link-plist key value)))))
9954 (defun org-email-link-description (&optional fmt)
9955 "Return the description part of an email link.
9956 This takes information from `org-store-link-plist' and formats it
9957 according to FMT (default from `org-email-link-description-format')."
9958 (setq fmt (or fmt org-email-link-description-format))
9959 (let* ((p org-store-link-plist)
9960 (to (plist-get p :toaddress))
9961 (from (plist-get p :fromaddress))
9962 (table
9963 (list
9964 (cons "%c" (plist-get p :fromto))
9965 (cons "%F" (plist-get p :from))
9966 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9967 (cons "%T" (plist-get p :to))
9968 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9969 (cons "%s" (plist-get p :subject))
9970 (cons "%d" (plist-get p :date))
9971 (cons "%m" (plist-get p :message-id)))))
9972 (when (string-match "%c" fmt)
9973 ;; Check if the user wrote this message
9974 (if (and org-from-is-user-regexp from to
9975 (save-match-data (string-match org-from-is-user-regexp from)))
9976 (setq fmt (replace-match "to %t" t t fmt))
9977 (setq fmt (replace-match "from %f" t t fmt))))
9978 (org-replace-escapes fmt table)))
9980 (defun org-make-org-heading-search-string (&optional string)
9981 "Make search string for the current headline or STRING."
9982 (let ((s (or string
9983 (and (derived-mode-p 'org-mode)
9984 (save-excursion
9985 (org-back-to-heading t)
9986 (org-element-property :raw-value (org-element-at-point))))))
9987 (lines org-context-in-file-links))
9988 (or string (setq s (concat "*" s))) ; Add * for headlines
9989 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9990 (when (and string (integerp lines) (> lines 0))
9991 (let ((slines (org-split-string s "\n")))
9992 (when (< lines (length slines))
9993 (setq s (mapconcat
9994 'identity
9995 (reverse (nthcdr (- (length slines) lines)
9996 (reverse slines))) "\n")))))
9997 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9999 (defun org-make-link-string (link &optional description)
10000 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10001 (unless (org-string-nw-p link) (error "Empty link"))
10002 (let ((uri (cond ((string-match org-link-types-re link)
10003 (concat (match-string 1 link)
10004 (org-link-escape (substring link (match-end 1)))))
10005 ;; For readability, url-encode internal links only
10006 ;; when absolutely needed (i.e, when they contain
10007 ;; square brackets). File links however, are
10008 ;; encoded since, e.g., spaces are significant.
10009 ((or (file-name-absolute-p link)
10010 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10011 (org-link-escape link))
10012 (t link)))
10013 (description
10014 (and (org-string-nw-p description)
10015 ;; Remove brackets from description, as they are fatal.
10016 (replace-regexp-in-string
10017 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10018 (org-trim description)))))
10019 (format "[[%s]%s]"
10021 (if description (format "[%s]" description) ""))))
10023 (defconst org-link-escape-chars
10024 ;;%20 %5B %5D %25
10025 '(?\s ?\[ ?\] ?%)
10026 "List of characters that should be escaped in a link when stored to Org.
10027 This is the list that is used for internal purposes.")
10029 (defconst org-link-escape-chars-browser
10030 ;;%20 %22
10031 '(?\s ?\")
10032 "List of characters to be escaped before handing over to the browser.
10033 If you consider using this constant then you probably want to use
10034 the function `org-link-escape-browser' instead. See there why
10035 this constant is a candidate to be removed once Org drops support
10036 for Emacs 24.1 and 24.2.")
10038 (defun org-link-escape (text &optional table merge)
10039 "Return percent escaped representation of TEXT.
10040 TEXT is a string with the text to escape.
10041 Optional argument TABLE is a list with characters that should be
10042 escaped. When nil, `org-link-escape-chars' is used.
10043 If optional argument MERGE is set, merge TABLE into
10044 `org-link-escape-chars'."
10045 (let ((characters-to-encode
10046 (cond ((null table) org-link-escape-chars)
10047 (merge (append org-link-escape-chars table))
10048 (t table))))
10049 (mapconcat
10050 (lambda (c)
10051 (if (or (memq c characters-to-encode)
10052 (and org-url-hexify-p (or (< c 32) (> c 126))))
10053 (mapconcat (lambda (e) (format "%%%.2X" e))
10054 (or (encode-coding-char c 'utf-8)
10055 (error "Unable to percent escape character: %c" c))
10057 (char-to-string c)))
10058 text "")))
10060 (defun org-link-escape-browser (text)
10061 "Escape some characters before handing over to the browser.
10062 This function is a candidate to be removed together with the
10063 constant `org-link-escape-chars-browser' once Org drops support
10064 for Emacs 24.1 and 24.2. All calls to this function will have to
10065 be replaced with `url-encode-url' which is available since Emacs
10066 24.3.1."
10067 ;; Example with the Org link
10068 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10069 ;; to open the browser with +subject:"Release 8.2" filled into the
10070 ;; query field: In this case the variable TEXT contains the
10071 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10072 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10073 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10074 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10075 (if (fboundp 'url-encode-url)
10076 (url-encode-url text)
10077 (if (org-string-match-p
10078 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10079 text)
10080 (org-link-escape text org-link-escape-chars-browser)
10081 text)))
10083 (defun org-link-unescape (str)
10084 "Unhex hexified Unicode parts in string STR.
10085 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10086 reciprocal of `org-link-escape', which see."
10087 (if (org-string-nw-p str)
10088 (replace-regexp-in-string
10089 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10090 str))
10092 (defun org-link-unescape-compound (hex)
10093 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10094 Note: this function also decodes single byte encodings like
10095 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10096 (save-match-data
10097 (let* ((bytes (cdr (split-string hex "%")))
10098 (ret "")
10099 (eat 0)
10100 (sum 0))
10101 (while bytes
10102 (let* ((val (string-to-number (pop bytes) 16))
10103 (shift-xor
10104 (if (= 0 eat)
10105 (cond
10106 ((>= val 252) (cons 6 252))
10107 ((>= val 248) (cons 5 248))
10108 ((>= val 240) (cons 4 240))
10109 ((>= val 224) (cons 3 224))
10110 ((>= val 192) (cons 2 192))
10111 (t (cons 0 0)))
10112 (cons 6 128))))
10113 (when (>= val 192) (setq eat (car shift-xor)))
10114 (setq val (logxor val (cdr shift-xor)))
10115 (setq sum (+ (lsh sum (car shift-xor)) val))
10116 (when (> eat 0) (setq eat (- eat 1)))
10117 (cond
10118 ((= 0 eat) ;multi byte
10119 (setq ret (concat ret (org-char-to-string sum)))
10120 (setq sum 0))
10121 ((not bytes) ; single byte(s)
10122 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10123 ret)))
10125 (defun org-link-unescape-single-byte-sequence (hex)
10126 "Unhexify hex-encoded single byte character sequences."
10127 (mapconcat (lambda (byte)
10128 (char-to-string (string-to-number byte 16)))
10129 (cdr (split-string hex "%")) ""))
10131 (defun org-xor (a b)
10132 "Exclusive or."
10133 (if a (not b) b))
10135 (defun org-fixup-message-id-for-http (s)
10136 "Replace special characters in a message id, so it can be used in an http query."
10137 (when (string-match "%" s)
10138 (setq s (mapconcat (lambda (c)
10139 (if (eq c ?%)
10140 "%25"
10141 (char-to-string c)))
10142 s "")))
10143 (while (string-match "<" s)
10144 (setq s (replace-match "%3C" t t s)))
10145 (while (string-match ">" s)
10146 (setq s (replace-match "%3E" t t s)))
10147 (while (string-match "@" s)
10148 (setq s (replace-match "%40" t t s)))
10151 (defun org-link-prettify (link)
10152 "Return a human-readable representation of LINK.
10153 The car of LINK must be a raw link.
10154 The cdr of LINK must be either a link description or nil."
10155 (let ((desc (or (cadr link) "<no description>")))
10156 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10157 "<" (car link) ">")))
10159 ;;;###autoload
10160 (defun org-insert-link-global ()
10161 "Insert a link like Org-mode does.
10162 This command can be called in any mode to insert a link in Org-mode syntax."
10163 (interactive)
10164 (org-load-modules-maybe)
10165 (org-run-like-in-org-mode 'org-insert-link))
10167 (defun org-insert-all-links (arg &optional pre post)
10168 "Insert all links in `org-stored-links'.
10169 When a universal prefix, do not delete the links from `org-stored-links'.
10170 When `ARG' is a number, insert the last N link(s).
10171 `PRE' and `POST' are optional arguments to define a string to
10172 prepend or to append."
10173 (interactive "P")
10174 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10175 (links (copy-seq org-stored-links))
10176 (pr (or pre "- "))
10177 (po (or post "\n"))
10178 (cnt 1) l)
10179 (if (null org-stored-links)
10180 (message "No link to insert")
10181 (while (and (or (listp arg) (>= arg cnt))
10182 (setq l (if (listp arg)
10183 (pop links)
10184 (pop org-stored-links))))
10185 (setq cnt (1+ cnt))
10186 (insert pr)
10187 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10188 (insert po)))))
10190 (defun org-insert-last-stored-link (arg)
10191 "Insert the last link stored in `org-stored-links'."
10192 (interactive "p")
10193 (org-insert-all-links arg "" "\n"))
10195 (defun org-link-fontify-links-to-this-file ()
10196 "Fontify links to the current file in `org-stored-links'."
10197 (let ((f (buffer-file-name)) a b)
10198 (setq a (mapcar (lambda(l)
10199 (let ((ll (car l)))
10200 (when (and (string-match "^file:\\(.+\\)::" ll)
10201 (equal f (expand-file-name (match-string 1 ll))))
10202 ll)))
10203 org-stored-links))
10204 (when (featurep 'org-id)
10205 (setq b (mapcar (lambda(l)
10206 (let ((ll (car l)))
10207 (when (and (string-match "^id:\\(.+\\)$" ll)
10208 (equal f (expand-file-name
10209 (or (org-id-find-id-file
10210 (match-string 1 ll)) ""))))
10211 ll)))
10212 org-stored-links)))
10213 (mapcar (lambda(l)
10214 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10215 (delq nil (append a b)))))
10217 (defvar org-link-links-in-this-file nil)
10218 (defun org-insert-link (&optional complete-file link-location default-description)
10219 "Insert a link. At the prompt, enter the link.
10221 Completion can be used to insert any of the link protocol prefixes like
10222 http or ftp in use.
10224 The history can be used to select a link previously stored with
10225 `org-store-link'. When the empty string is entered (i.e. if you just
10226 press RET at the prompt), the link defaults to the most recently
10227 stored link. As SPC triggers completion in the minibuffer, you need to
10228 use M-SPC or C-q SPC to force the insertion of a space character.
10230 You will also be prompted for a description, and if one is given, it will
10231 be displayed in the buffer instead of the link.
10233 If there is already a link at point, this command will allow you to edit link
10234 and description parts.
10236 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10237 be selected using completion. The path to the file will be relative to the
10238 current directory if the file is in the current directory or a subdirectory.
10239 Otherwise, the link will be the absolute path as completed in the minibuffer
10240 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10241 option `org-link-file-path-type'.
10243 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10244 the current directory or below.
10246 With three \\[universal-argument] prefixes, negate the meaning of
10247 `org-keep-stored-link-after-insertion'.
10249 If `org-make-link-description-function' is non-nil, this function will be
10250 called with the link target, and the result will be the default
10251 link description.
10253 If the LINK-LOCATION parameter is non-nil, this value will be
10254 used as the link location instead of reading one interactively.
10256 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10257 be used as the default description."
10258 (interactive "P")
10259 (let* ((wcf (current-window-configuration))
10260 (origbuf (current-buffer))
10261 (region (when (org-region-active-p)
10262 (buffer-substring (region-beginning) (region-end))))
10263 (remove (and region (list (region-beginning) (region-end))))
10264 (desc region)
10265 tmphist ; byte-compile incorrectly complains about this
10266 (link link-location)
10267 (abbrevs org-link-abbrev-alist-local)
10268 entry file all-prefixes auto-desc)
10269 (cond
10270 (link-location) ; specified by arg, just use it.
10271 ((org-in-regexp org-bracket-link-regexp 1)
10272 ;; We do have a link at point, and we are going to edit it.
10273 (setq remove (list (match-beginning 0) (match-end 0)))
10274 (setq desc (when (match-end 3) (org-match-string-no-properties 3)))
10275 (setq link (read-string "Link: "
10276 (org-link-unescape
10277 (org-match-string-no-properties 1)))))
10278 ((or (org-in-regexp org-angle-link-re)
10279 (org-in-regexp org-plain-link-re))
10280 ;; Convert to bracket link
10281 (setq remove (list (match-beginning 0) (match-end 0))
10282 link (read-string "Link: "
10283 (org-remove-angle-brackets (match-string 0)))))
10284 ((member complete-file '((4) (16)))
10285 ;; Completing read for file names.
10286 (setq link (org-file-complete-link complete-file)))
10288 ;; Read link, with completion for stored links.
10289 (org-link-fontify-links-to-this-file)
10290 (org-switch-to-buffer-other-window "*Org Links*")
10291 (with-current-buffer "*Org Links*"
10292 (erase-buffer)
10293 (insert "Insert a link.
10294 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10295 (when org-stored-links
10296 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10297 (insert (mapconcat 'org-link-prettify
10298 (reverse org-stored-links) "\n")))
10299 (goto-char (point-min)))
10300 (let ((cw (selected-window)))
10301 (select-window (get-buffer-window "*Org Links*" 'visible))
10302 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10303 (unless (pos-visible-in-window-p (point-max))
10304 (org-fit-window-to-buffer))
10305 (and (window-live-p cw) (select-window cw)))
10306 ;; Fake a link history, containing the stored links.
10307 (setq tmphist (append (mapcar 'car org-stored-links)
10308 org-insert-link-history))
10309 (setq all-prefixes (append (mapcar 'car abbrevs)
10310 (mapcar 'car org-link-abbrev-alist)
10311 org-link-types))
10312 (unwind-protect
10313 (progn
10314 (setq link
10315 (org-completing-read
10316 "Link: "
10317 (append
10318 (mapcar (lambda (x) (concat x ":"))
10319 all-prefixes)
10320 (mapcar 'car org-stored-links))
10321 nil nil nil
10322 'tmphist
10323 (caar org-stored-links)))
10324 (unless (string-match "\\S-" link)
10325 (user-error "No link selected"))
10326 (mapc (lambda(l)
10327 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10328 org-stored-links)
10329 (when (or (member link all-prefixes)
10330 (and (equal ":" (substring link -1))
10331 (member (substring link 0 -1) all-prefixes)
10332 (setq link (substring link 0 -1))))
10333 (setq link (with-current-buffer origbuf
10334 (org-link-try-special-completion link)))))
10335 (set-window-configuration wcf)
10336 (kill-buffer "*Org Links*"))
10337 (setq entry (assoc link org-stored-links))
10338 (or entry (push link org-insert-link-history))
10339 (setq desc (or desc (nth 1 entry)))))
10341 (when (funcall (if (equal complete-file '(64)) 'not 'identity)
10342 (not org-keep-stored-link-after-insertion))
10343 (setq org-stored-links (delq (assoc link org-stored-links)
10344 org-stored-links)))
10346 (when (and (string-match org-plain-link-re link)
10347 (not (string-match org-ts-regexp link)))
10348 ;; URL-like link, normalize the use of angular brackets.
10349 (setq link (org-remove-angle-brackets link)))
10351 ;; Check if we are linking to the current file with a search
10352 ;; option If yes, simplify the link by using only the search
10353 ;; option.
10354 (when (and buffer-file-name
10355 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10356 (let* ((path (match-string 1 link))
10357 (case-fold-search nil)
10358 (search (match-string 2 link)))
10359 (save-match-data
10360 (when (equal (file-truename buffer-file-name) (file-truename path))
10361 ;; We are linking to this same file, with a search option
10362 (setq link search)))))
10364 ;; Check if we can/should use a relative path. If yes, simplify the link
10365 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10366 (let* ((type (match-string 1 link))
10367 (path (match-string 2 link))
10368 (origpath path)
10369 (case-fold-search nil))
10370 (cond
10371 ((or (eq org-link-file-path-type 'absolute)
10372 (equal complete-file '(16)))
10373 (setq path (abbreviate-file-name (expand-file-name path))))
10374 ((eq org-link-file-path-type 'noabbrev)
10375 (setq path (expand-file-name path)))
10376 ((eq org-link-file-path-type 'relative)
10377 (setq path (file-relative-name path)))
10379 (save-match-data
10380 (if (string-match (concat "^" (regexp-quote
10381 (expand-file-name
10382 (file-name-as-directory
10383 default-directory))))
10384 (expand-file-name path))
10385 ;; We are linking a file with relative path name.
10386 (setq path (substring (expand-file-name path)
10387 (match-end 0)))
10388 (setq path (abbreviate-file-name (expand-file-name path)))))))
10389 (setq link (concat type path))
10390 (when (equal desc origpath)
10391 (setq desc path))))
10393 (if org-make-link-description-function
10394 (setq desc
10395 (or (condition-case nil
10396 (funcall org-make-link-description-function link desc)
10397 (error (progn (message "Can't get link description from `%s'"
10398 (symbol-name org-make-link-description-function))
10399 (sit-for 2) nil)))
10400 (read-string "Description: " default-description)))
10401 (if default-description (setq desc default-description)
10402 (setq desc (or (and auto-desc desc)
10403 (read-string "Description: " desc)))))
10405 (unless (string-match "\\S-" desc) (setq desc nil))
10406 (when remove (apply 'delete-region remove))
10407 (insert (org-make-link-string link desc))
10408 ;; Redisplay so as the new link has proper invisible characters.
10409 (sit-for 0)))
10411 (defun org-link-try-special-completion (type)
10412 "If there is completion support for link type TYPE, offer it."
10413 (let ((fun (intern (concat "org-" type "-complete-link"))))
10414 (if (functionp fun)
10415 (funcall fun)
10416 (read-string "Link (no completion support): " (concat type ":")))))
10418 (defun org-file-complete-link (&optional arg)
10419 "Create a file link using completion."
10420 (let ((file (org-iread-file-name "File: "))
10421 (pwd (file-name-as-directory (expand-file-name ".")))
10422 (pwd1 (file-name-as-directory (abbreviate-file-name
10423 (expand-file-name ".")))))
10424 (cond ((equal arg '(16))
10425 (concat "file:"
10426 (abbreviate-file-name (expand-file-name file))))
10427 ((string-match
10428 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10429 (concat "file:" (match-string 1 file)))
10430 ((string-match
10431 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10432 (expand-file-name file))
10433 (concat "file:"
10434 (match-string 1 (expand-file-name file))))
10435 (t (concat "file:" file)))))
10437 (defun org-iread-file-name (&rest args)
10438 "Read-file-name using `ido-mode' speedup if available.
10439 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10440 See `read-file-name' for a description of parameters."
10441 (org-without-partial-completion
10442 (if (and org-completion-use-ido
10443 (fboundp 'ido-read-file-name)
10444 (org-bound-and-true-p ido-mode)
10445 (listp (nth 1 args)))
10446 (let ((ido-enter-matching-directory nil))
10447 (apply #'ido-read-file-name args))
10448 (apply #'read-file-name args))))
10450 (defun org-completing-read (&rest args)
10451 "Completing-read with SPACE being a normal character."
10452 (let ((enable-recursive-minibuffers t)
10453 (minibuffer-local-completion-map
10454 (copy-keymap minibuffer-local-completion-map)))
10455 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10456 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10457 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10458 (apply 'org-icompleting-read args)))
10460 (defun org-completing-read-no-i (&rest args)
10461 (let (org-completion-use-ido org-completion-use-iswitchb)
10462 (apply 'org-completing-read args)))
10464 (defun org-iswitchb-completing-read (prompt choices &rest args)
10465 "Use iswitch as a completing-read replacement to choose from choices.
10466 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10467 from."
10468 (let* ((iswitchb-use-virtual-buffers nil)
10469 (iswitchb-make-buflist-hook
10470 (lambda ()
10471 (setq iswitchb-temp-buflist choices))))
10472 (iswitchb-read-buffer prompt)))
10474 (defun org-icompleting-read (&rest args)
10475 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10476 Should be called like `completing-read'."
10477 (org-without-partial-completion
10478 (if (not (listp (nth 1 args)))
10479 ;; Ido only supports lists as the COLLECTION argument. Use
10480 ;; default completion function when second argument is not
10481 ;; a list.
10482 (apply #'completing-read args)
10483 (let ((ido-enter-matching-directory nil))
10484 (apply (cond ((and org-completion-use-ido
10485 (fboundp 'ido-completing-read)
10486 (org-bound-and-true-p ido-mode))
10487 #'ido-completing-read)
10488 ((and org-completion-use-iswitchb
10489 (org-bound-and-true-p iswitchb-mode))
10490 #'org-iswitchb-completing-read)
10491 (t #'completing-read))
10492 args)))))
10494 ;;; Opening/following a link
10496 (defvar org-link-search-failed nil)
10498 (defvar org-open-link-functions nil
10499 "Hook for functions finding a plain text link.
10500 These functions must take a single argument, the link content.
10501 They will be called for links that look like [[link text][description]]
10502 when LINK TEXT does not have a protocol like \"http:\" and does not look
10503 like a filename (e.g. \"./blue.png\").
10505 These functions will be called *before* Org attempts to resolve the
10506 link by doing text searches in the current buffer - so if you want a
10507 link \"[[target]]\" to still find \"<<target>>\", your function should
10508 handle this as a special case.
10510 When the function does handle the link, it must return a non-nil value.
10511 If it decides that it is not responsible for this link, it must return
10512 nil to indicate that that Org-mode can continue with other options
10513 like exact and fuzzy text search.")
10515 (defun org-next-link (&optional search-backward)
10516 "Move forward to the next link.
10517 If the link is in hidden text, expose it."
10518 (interactive "P")
10519 (when (and org-link-search-failed (eq this-command last-command))
10520 (goto-char (point-min))
10521 (message "Link search wrapped back to beginning of buffer"))
10522 (setq org-link-search-failed nil)
10523 (let* ((pos (point))
10524 (ct (org-context))
10525 (a (assoc :link ct))
10526 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10527 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10528 ((looking-at org-any-link-re)
10529 ;; Don't stay stuck at link without an org-link face
10530 (forward-char (if search-backward -1 1))))
10531 (if (funcall srch-fun org-any-link-re nil t)
10532 (progn
10533 (goto-char (match-beginning 0))
10534 (when (outline-invisible-p) (org-show-context)))
10535 (goto-char pos)
10536 (setq org-link-search-failed t)
10537 (message "No further link found"))))
10539 (defun org-previous-link ()
10540 "Move backward to the previous link.
10541 If the link is in hidden text, expose it."
10542 (interactive)
10543 (funcall 'org-next-link t))
10545 (defun org-translate-link (s)
10546 "Translate a link string if a translation function has been defined."
10547 (with-temp-buffer
10548 (insert (org-trim s))
10549 (org-trim (org-element-interpret-data (org-element-context)))))
10551 (defun org-translate-link-from-planner (type path)
10552 "Translate a link from Emacs Planner syntax so that Org can follow it.
10553 This is still an experimental function, your mileage may vary."
10554 (cond
10555 ((member type '("http" "https" "news" "ftp"))
10556 ;; standard Internet links are the same.
10557 nil)
10558 ((and (equal type "irc") (string-match "^//" path))
10559 ;; Planner has two / at the beginning of an irc link, we have 1.
10560 ;; We should have zero, actually....
10561 (setq path (substring path 1)))
10562 ((and (equal type "lisp") (string-match "^/" path))
10563 ;; Planner has a slash, we do not.
10564 (setq type "elisp" path (substring path 1)))
10565 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10566 ;; A typical message link. Planner has the id after the final slash,
10567 ;; we separate it with a hash mark
10568 (setq path (concat (match-string 1 path) "#"
10569 (org-remove-angle-brackets (match-string 2 path))))))
10570 (cons type path))
10572 (defun org-find-file-at-mouse (ev)
10573 "Open file link or URL at mouse."
10574 (interactive "e")
10575 (mouse-set-point ev)
10576 (org-open-at-point 'in-emacs))
10578 (defun org-open-at-mouse (ev)
10579 "Open file link or URL at mouse.
10580 See the docstring of `org-open-file' for details."
10581 (interactive "e")
10582 (mouse-set-point ev)
10583 (when (eq major-mode 'org-agenda-mode)
10584 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10585 (org-open-at-point))
10587 (defvar org-window-config-before-follow-link nil
10588 "The window configuration before following a link.
10589 This is saved in case the need arises to restore it.")
10591 ;;;###autoload
10592 (defun org-open-at-point-global ()
10593 "Follow a link like Org-mode does.
10594 This command can be called in any mode to follow a link that has
10595 Org-mode syntax."
10596 (interactive)
10597 (org-run-like-in-org-mode 'org-open-at-point))
10599 ;;;###autoload
10600 (defun org-open-link-from-string (s &optional arg reference-buffer)
10601 "Open a link in the string S, as if it was in Org-mode."
10602 (interactive "sLink: \nP")
10603 (let ((reference-buffer (or reference-buffer (current-buffer))))
10604 (with-temp-buffer
10605 (let ((org-inhibit-startup (not reference-buffer)))
10606 (org-mode)
10607 (insert s)
10608 (goto-char (point-min))
10609 (when reference-buffer
10610 (setq org-link-abbrev-alist-local
10611 (with-current-buffer reference-buffer
10612 org-link-abbrev-alist-local)))
10613 (org-open-at-point arg reference-buffer)))))
10615 (defvar org-open-at-point-functions nil
10616 "Hook that is run when following a link at point.
10618 Functions in this hook must return t if they identify and follow
10619 a link at point. If they don't find anything interesting at point,
10620 they must return nil.")
10622 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10623 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10624 (defun org-open-at-point (&optional arg reference-buffer)
10625 "Open link, timestamp, footnote or tags at point.
10627 When point is on a link, follow it. Normally, files will be
10628 opened by an appropriate application. If the optional prefix
10629 argument ARG is non-nil, Emacs will visit the file. With
10630 a double prefix argument, try to open outside of Emacs, in the
10631 application the system uses for this file type.
10633 When point is on a timestamp, open the agenda at the day
10634 specified.
10636 When point is a footnote definition, move to the first reference
10637 found. If it is on a reference, move to the associated
10638 definition.
10640 When point is on a headline, display a list of every link in the
10641 entry, so it is possible to pick one, or all, of them. If point
10642 is on a tag, call `org-tags-view' instead.
10644 When optional argument REFERENCE-BUFFER is non-nil, it should
10645 specify a buffer from where the link search should happen. This
10646 is used internally by `org-open-link-from-string'.
10648 On top of syntactically correct links, this function will open
10649 the link at point in comments or comment blocks and the first
10650 link in a property drawer line."
10651 (interactive "P")
10652 ;; On a code block, open block's results.
10653 (unless (call-interactively 'org-babel-open-src-block-result)
10654 (org-load-modules-maybe)
10655 (setq org-window-config-before-follow-link (current-window-configuration))
10656 (org-remove-occur-highlights nil nil t)
10657 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10658 (let* ((context
10659 ;; Only consider supported types, even if they are not
10660 ;; the closest one.
10661 (org-element-lineage
10662 (org-element-context)
10663 '(clock comment comment-block footnote-definition
10664 footnote-reference headline inlinetask keyword link
10665 node-property timestamp)
10667 (type (org-element-type context))
10668 (value (org-element-property :value context)))
10669 (cond
10670 ((not context) (user-error "No link found"))
10671 ;; Exception: open timestamps and links in properties
10672 ;; drawers, keywords and comments.
10673 ((memq type '(comment comment-block keyword node-property))
10674 (cond ((org-in-regexp org-any-link-re)
10675 (org-open-link-from-string (match-string-no-properties 0)))
10676 ((or (org-in-regexp org-ts-regexp-both nil t)
10677 (org-in-regexp org-tsr-regexp-both nil t))
10678 (org-follow-timestamp-link))
10679 (t (user-error "No link found"))))
10680 ;; On a headline or an inlinetask, but not on a timestamp,
10681 ;; a link, a footnote reference or on tags.
10682 ((and (memq type '(headline inlinetask))
10683 ;; Not on tags.
10684 (progn (save-excursion (beginning-of-line)
10685 (looking-at org-complex-heading-regexp))
10686 (or (not (match-beginning 5))
10687 (< (point) (match-beginning 5)))))
10688 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10689 (links (car data))
10690 (links-end (cdr data)))
10691 (if links
10692 (dolist (link (if (stringp links) (list links) links))
10693 (search-forward link nil links-end)
10694 (goto-char (match-beginning 0))
10695 (org-open-at-point))
10696 (require 'org-attach)
10697 (org-attach-reveal 'if-exists))))
10698 ;; On a clock line, make sure point is on the timestamp
10699 ;; before opening it.
10700 ((and (eq type 'clock)
10701 value
10702 (>= (point) (org-element-property :begin value))
10703 (<= (point) (org-element-property :end value)))
10704 (org-follow-timestamp-link))
10705 ;; Do nothing on white spaces after an object.
10706 ((>= (point)
10707 (save-excursion
10708 (goto-char (org-element-property :end context))
10709 (skip-chars-backward " \t")
10710 (point)))
10711 (user-error "No link found"))
10712 ((eq type 'timestamp) (org-follow-timestamp-link))
10713 ;; On tags within a headline or an inlinetask.
10714 ((and (memq type '(headline inlinetask))
10715 (progn (save-excursion (beginning-of-line)
10716 (looking-at org-complex-heading-regexp))
10717 (and (match-beginning 5)
10718 (>= (point) (match-beginning 5)))))
10719 (org-tags-view arg (substring (match-string 5) 0 -1)))
10720 ((eq type 'link)
10721 ;; When link is located within the description of another
10722 ;; link (e.g., an inline image), always open the parent
10723 ;; link.
10724 (let*((link (let ((up (org-element-property :parent context)))
10725 (if (eq (org-element-type up) 'link) up context)))
10726 (type (org-element-property :type link))
10727 (path (org-link-unescape (org-element-property :path link))))
10728 ;; Switch back to REFERENCE-BUFFER needed when called in
10729 ;; a temporary buffer through `org-open-link-from-string'.
10730 (with-current-buffer (or reference-buffer (current-buffer))
10731 (cond
10732 ((equal type "file")
10733 (if (string-match "[*?{]" (file-name-nondirectory path))
10734 (dired path)
10735 ;; Look into `org-link-protocols' in order to find
10736 ;; a DEDICATED-FUNCTION to open file. The function
10737 ;; will be applied on raw link instead of parsed
10738 ;; link due to the limitation in `org-add-link-type'
10739 ;; ("open" function called with a single argument).
10740 ;; If no such function is found, fallback to
10741 ;; `org-open-file'.
10743 ;; Note : "file+emacs" and "file+sys" types are
10744 ;; hard-coded in order to escape the previous
10745 ;; limitation.
10746 (let* ((option (org-element-property :search-option link))
10747 (app (org-element-property :application link))
10748 (dedicated-function
10749 (nth 1 (assoc app org-link-protocols))))
10750 (if dedicated-function
10751 (funcall dedicated-function
10752 (concat path
10753 (and option (concat "::" option))))
10754 (apply #'org-open-file
10755 path
10756 (cond (arg)
10757 ((equal app "emacs") 'emacs)
10758 ((equal app "sys") 'system))
10759 (cond ((not option) nil)
10760 ((org-string-match-p "\\`[0-9]+\\'" option)
10761 (list (string-to-number option)))
10762 (t (list nil
10763 (org-link-unescape option)))))))))
10764 ((assoc type org-link-protocols)
10765 (funcall (nth 1 (assoc type org-link-protocols)) path))
10766 ((equal type "help")
10767 (let ((f-or-v (intern path)))
10768 (cond ((fboundp f-or-v) (describe-function f-or-v))
10769 ((boundp f-or-v) (describe-variable f-or-v))
10770 (t (error "Not a known function or variable")))))
10771 ((member type '("http" "https" "ftp" "mailto" "news"))
10772 (browse-url (org-link-escape-browser (concat type ":" path))))
10773 ((equal type "doi")
10774 (browse-url
10775 (org-link-escape-browser (concat org-doi-server-url path))))
10776 ((equal type "message") (browse-url (concat type ":" path)))
10777 ((equal type "shell")
10778 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10779 (cmd path))
10780 (if (or (and (org-string-nw-p
10781 org-confirm-shell-link-not-regexp)
10782 (string-match
10783 org-confirm-shell-link-not-regexp cmd))
10784 (not org-confirm-shell-link-function)
10785 (funcall org-confirm-shell-link-function
10786 (format "Execute \"%s\" in shell? "
10787 (org-add-props cmd nil
10788 'face 'org-warning))))
10789 (progn
10790 (message "Executing %s" cmd)
10791 (shell-command cmd buf)
10792 (when (featurep 'midnight)
10793 (setq clean-buffer-list-kill-buffer-names
10794 (cons (buffer-name buf)
10795 clean-buffer-list-kill-buffer-names))))
10796 (user-error "Abort"))))
10797 ((equal type "elisp")
10798 (let ((cmd path))
10799 (if (or (and (org-string-nw-p
10800 org-confirm-elisp-link-not-regexp)
10801 (org-string-match-p
10802 org-confirm-elisp-link-not-regexp cmd))
10803 (not org-confirm-elisp-link-function)
10804 (funcall org-confirm-elisp-link-function
10805 (format "Execute \"%s\" as elisp? "
10806 (org-add-props cmd nil
10807 'face 'org-warning))))
10808 (message "%s => %s" cmd
10809 (if (eq (string-to-char cmd) ?\()
10810 (eval (read cmd))
10811 (call-interactively (read cmd))))
10812 (user-error "Abort"))))
10813 ((equal type "id")
10814 (require 'org-id)
10815 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10816 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10817 (unless (run-hook-with-args-until-success
10818 'org-open-link-functions path)
10819 (if (not arg) (org-mark-ring-push)
10820 (switch-to-buffer-other-window
10821 (org-get-buffer-for-internal-link (current-buffer))))
10822 (let ((destination
10823 (org-with-wide-buffer
10824 (if (equal type "radio")
10825 (org-search-radio-target
10826 (org-element-property :path link))
10827 (org-link-search
10828 (if (member type '("custom-id" "coderef"))
10829 (org-element-property :raw-link link)
10830 path)
10831 ;; Prevent fuzzy links from matching
10832 ;; themselves.
10833 (and (equal type "fuzzy")
10834 (+ 2 (org-element-property :begin link)))))
10835 (point))))
10836 (unless (and (<= (point-min) destination)
10837 (>= (point-max) destination))
10838 (widen))
10839 (goto-char destination))))
10840 (t (browse-url-at-point))))))
10841 ;; On a footnote reference or at a footnote definition's label.
10842 ((or (eq type 'footnote-reference)
10843 (and (eq type 'footnote-definition)
10844 (save-excursion
10845 ;; Do not validate action when point is on the
10846 ;; spaces right after the footnote label, in
10847 ;; order to be on par with behaviour on links.
10848 (skip-chars-forward " \t")
10849 (let ((begin
10850 (org-element-property :contents-begin context)))
10851 (if begin (< (point) begin)
10852 (= (org-element-property :post-affiliated context)
10853 (line-beginning-position)))))))
10854 (org-footnote-action))
10855 (t (user-error "No link found")))))
10856 (run-hook-with-args 'org-follow-link-hook)))
10858 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10859 "Offer links in the current entry and return the selected link.
10860 If there is only one link, return it.
10861 If NTH is an integer, return the NTH link found.
10862 If ZERO is a string, check also this string for a link, and if
10863 there is one, return it."
10864 (with-current-buffer buffer
10865 (save-excursion
10866 (save-restriction
10867 (widen)
10868 (goto-char marker)
10869 (let ((cnt ?0)
10870 (in-emacs (unless (integerp nth) nth))
10871 have-zero end links link c)
10872 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10873 (push (match-string 0 zero) links)
10874 (setq cnt (1- cnt) have-zero t))
10875 (save-excursion
10876 (org-back-to-heading t)
10877 (setq end (save-excursion (outline-next-heading) (point)))
10878 (while (re-search-forward org-any-link-re end t)
10879 (push (match-string 0) links))
10880 (setq links (org-uniquify (reverse links))))
10881 (cond
10882 ((null links)
10883 (message "No links"))
10884 ((equal (length links) 1)
10885 (setq link (car links)))
10886 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10887 (setq link (nth (if have-zero nth (1- nth)) links)))
10888 (t ; we have to select a link
10889 (save-excursion
10890 (save-window-excursion
10891 (delete-other-windows)
10892 (with-output-to-temp-buffer "*Select Link*"
10893 (mapc (lambda (l)
10894 (if (not (string-match org-bracket-link-regexp l))
10895 (princ (format "[%c] %s\n" (incf cnt)
10896 (org-remove-angle-brackets l)))
10897 (if (match-end 3)
10898 (princ (format "[%c] %s (%s)\n" (incf cnt)
10899 (match-string 3 l) (match-string 1 l)))
10900 (princ (format "[%c] %s\n" (incf cnt)
10901 (match-string 1 l))))))
10902 links))
10903 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10904 (message "Select link to open, RET to open all:")
10905 (setq c (read-char-exclusive))
10906 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10907 (when (equal c ?q) (user-error "Abort"))
10908 (if (equal c ?\C-m)
10909 (setq link links)
10910 (setq nth (- c ?0))
10911 (when have-zero (setq nth (1+ nth)))
10912 (unless (and (integerp nth) (>= (length links) nth))
10913 (user-error "Invalid link selection"))
10914 (setq link (nth (1- nth) links)))))
10915 (cons link end))))))
10917 ;; TODO: These functions are deprecated since `org-open-at-point'
10918 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10919 (defun org-open-file-with-system (path)
10920 "Open file at PATH using the system way of opening it."
10921 (org-open-file path 'system))
10922 (defun org-open-file-with-emacs (path)
10923 "Open file at PATH in Emacs."
10924 (org-open-file path 'emacs))
10927 ;;; File search
10929 (defvar org-create-file-search-functions nil
10930 "List of functions to construct the right search string for a file link.
10931 These functions are called in turn with point at the location to
10932 which the link should point.
10934 A function in the hook should first test if it would like to
10935 handle this file type, for example by checking the `major-mode'
10936 or the file extension. If it decides not to handle this file, it
10937 should just return nil to give other functions a chance. If it
10938 does handle the file, it must return the search string to be used
10939 when following the link. The search string will be part of the
10940 file link, given after a double colon, and `org-open-at-point'
10941 will automatically search for it. If special measures must be
10942 taken to make the search successful, another function should be
10943 added to the companion hook `org-execute-file-search-functions',
10944 which see.
10946 A function in this hook may also use `setq' to set the variable
10947 `description' to provide a suggestion for the descriptive text to
10948 be used for this link when it gets inserted into an Org-mode
10949 buffer with \\[org-insert-link].")
10951 (defvar org-execute-file-search-functions nil
10952 "List of functions to execute a file search triggered by a link.
10954 Functions added to this hook must accept a single argument, the
10955 search string that was part of the file link, the part after the
10956 double colon. The function must first check if it would like to
10957 handle this search, for example by checking the `major-mode' or
10958 the file extension. If it decides not to handle this search, it
10959 should just return nil to give other functions a chance. If it
10960 does handle the search, it must return a non-nil value to keep
10961 other functions from trying.
10963 Each function can access the current prefix argument through the
10964 variable `current-prefix-arg'. Note that a single prefix is used
10965 to force opening a link in Emacs, so it may be good to only use a
10966 numeric or double prefix to guide the search function.
10968 In case this is needed, a function in this hook can also restore
10969 the window configuration before `org-open-at-point' was called using:
10971 (set-window-configuration org-window-config-before-follow-link)")
10973 (defun org-search-radio-target (target)
10974 "Search a radio target matching TARGET in current buffer.
10975 White spaces are not significant."
10976 (let ((re (format "<<<%s>>>"
10977 (mapconcat #'regexp-quote
10978 (org-split-string target "[ \t\n]+")
10979 "[ \t]+\\(?:\n[ \t]*\\)?")))
10980 (origin (point)))
10981 (goto-char (point-min))
10982 (catch :radio-match
10983 (while (re-search-forward re nil t)
10984 (backward-char)
10985 (let ((object (org-element-context)))
10986 (when (eq (org-element-type object) 'radio-target)
10987 (goto-char (org-element-property :begin object))
10988 (org-show-context 'link-search)
10989 (throw :radio-match nil))))
10990 (goto-char origin)
10991 (user-error "No match for radio target: %s" target))))
10993 (defun org-link-search (s &optional avoid-pos stealth)
10994 "Search for a search string S.
10996 If S starts with \"#\", it triggers a custom ID search.
10998 If S is enclosed within parenthesis, it initiates a coderef
10999 search.
11001 If S is surrounded by forward slashes, it is interpreted as
11002 a regular expression. In Org mode files, this will create an
11003 `org-occur' sparse tree. In ordinary files, `occur' will be used
11004 to list matches. If the current buffer is in `dired-mode', grep
11005 will be used to search in all files.
11007 When AVOID-POS is given, ignore matches near that position.
11009 When optional argument STEALTH is non-nil, do not modify
11010 visibility around point, thus ignoring `org-show-context-detail'
11011 variable.
11013 Search is case-insensitive and ignores white spaces. Return type
11014 of matched result, with is either `dedicated' or `fuzzy'."
11015 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11016 (let* ((case-fold-search t)
11017 (origin (point))
11018 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11019 (words (org-split-string s "[ \t\n]+"))
11020 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11021 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11022 type)
11023 (cond
11024 ;; Check if there are any special search functions.
11025 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11026 ((eq (string-to-char s) ?#)
11027 ;; Look for a custom ID S if S starts with "#".
11028 (let* ((id (substring normalized 1))
11029 (match (org-find-property "CUSTOM_ID" id)))
11030 (if match (progn (goto-char match) (setf type 'dedicated))
11031 (error "No match for custom ID: %s" id))))
11032 ((string-match "\\`(\\(.*\\))\\'" normalized)
11033 ;; Look for coderef targets if S is enclosed within parenthesis.
11034 (let ((coderef (match-string-no-properties 1 normalized))
11035 (re (substring s-single-re 1 -1)))
11036 (goto-char (point-min))
11037 (catch :coderef-match
11038 (while (re-search-forward re nil t)
11039 (let ((element (org-element-at-point)))
11040 (when (and (memq (org-element-type element)
11041 '(example-block src-block))
11042 ;; Build proper regexp according to current
11043 ;; block's label format.
11044 (let ((label-fmt
11045 (regexp-quote
11046 (or (org-element-property :label-fmt element)
11047 org-coderef-label-format))))
11048 (save-excursion
11049 (beginning-of-line)
11050 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11051 (format label-fmt coderef))))))
11052 (setq type 'dedicated)
11053 (goto-char (match-beginning 1))
11054 (throw :coderef-match nil))))
11055 (goto-char origin)
11056 (error "No match for coderef: %s" coderef))))
11057 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11058 ;; Look for a regular expression.
11059 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11060 (match-string 1 s)))
11061 ;; Fuzzy links.
11063 (let* ((starred (eq (string-to-char normalized) ?*))
11064 (headline-search (and (derived-mode-p 'org-mode)
11065 (or org-link-search-must-match-exact-headline
11066 starred))))
11067 (cond
11068 ;; Look for targets, only if not in a headline search.
11069 ((and (not starred)
11070 (let ((target (format "<<%s>>" s-multi-re)))
11071 (catch :target-match
11072 (goto-char (point-min))
11073 (while (re-search-forward target nil t)
11074 (backward-char)
11075 (let ((context (org-element-context)))
11076 (when (eq (org-element-type context) 'target)
11077 (setq type 'dedicated)
11078 (goto-char (org-element-property :begin context))
11079 (throw :target-match t))))
11080 nil))))
11081 ;; Look for elements named after S, only if not in a headline
11082 ;; search.
11083 ((and (not starred)
11084 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11085 (catch :name-match
11086 (goto-char (point-min))
11087 (while (re-search-forward name nil t)
11088 (let ((element (org-element-at-point)))
11089 (when (equal (org-split-string
11090 (org-element-property :name element)
11091 "[ \t]+")
11092 words)
11093 (setq type 'dedicated)
11094 (beginning-of-line)
11095 (throw :name-match t))))
11096 nil))))
11097 ;; Regular text search. Prefer headlines in Org mode
11098 ;; buffers.
11099 ((and (derived-mode-p 'org-mode)
11100 (let* ((wspace "[ \t]")
11101 (wspaceopt (concat wspace "*"))
11102 (cookie (concat "\\(?:"
11103 wspaceopt
11104 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11105 wspaceopt
11106 "\\)"))
11107 (sep (concat "\\(?:\\(?:" wspace "\\|" cookie "\\)+\\)"))
11108 (re (concat
11109 org-outline-regexp-bol
11110 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11111 "\\(?:\\[#.\\][ \t]+\\)?"
11112 "\\(?:" org-comment-string "[ \t]+\\)?"
11113 sep "?"
11114 (let ((title (mapconcat #'regexp-quote
11115 words
11116 sep)))
11117 (if starred (substring title 1) title))
11118 sep "?"
11119 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11120 "[ \t]*$")))
11121 (goto-char (point-min))
11122 (re-search-forward re nil t)))
11123 (goto-char (match-beginning 0))
11124 (setq type 'dedicated))
11125 ;; Offer to create non-existent headline depending on
11126 ;; `org-link-search-must-match-exact-headline'.
11127 ((and (derived-mode-p 'org-mode)
11128 (not org-link-search-inhibit-query)
11129 (eq org-link-search-must-match-exact-headline 'query-to-create)
11130 (yes-or-no-p "No match - create this as a new heading? "))
11131 (goto-char (point-max))
11132 (unless (bolp) (newline))
11133 (org-insert-heading nil t t)
11134 (insert s "\n")
11135 (beginning-of-line 0))
11136 ;; Only headlines are looked after. No need to process
11137 ;; further: throw an error.
11138 ((and (derived-mode-p 'org-mode)
11139 (or starred org-link-search-must-match-exact-headline))
11140 (goto-char origin)
11141 (error "No match for fuzzy expression: %s" normalized))
11142 ;; Regular text search.
11143 ((catch :fuzzy-match
11144 (goto-char (point-min))
11145 (while (re-search-forward s-multi-re nil t)
11146 ;; Skip match if it contains AVOID-POS or it is included
11147 ;; in a link with a description but outside the
11148 ;; description.
11149 (unless (or (and avoid-pos
11150 (<= (match-beginning 0) avoid-pos)
11151 (> (match-end 0) avoid-pos))
11152 (and (save-match-data
11153 (org-in-regexp org-bracket-link-regexp))
11154 (match-beginning 3)
11155 (or (> (match-beginning 3) (point))
11156 (<= (match-end 3) (point)))
11157 (org-element-lineage
11158 (save-match-data (org-element-context))
11159 '(link) t)))
11160 (goto-char (match-beginning 0))
11161 (setq type 'fuzzy)
11162 (throw :fuzzy-match t)))
11163 nil))
11164 ;; All failed. Throw an error.
11165 (t (goto-char origin)
11166 (error "No match for fuzzy expression: %s" normalized))))))
11167 ;; Disclose surroundings of match, if appropriate.
11168 (when (and (derived-mode-p 'org-mode) (not stealth))
11169 (org-show-context 'link-search))
11170 type))
11172 (defun org-get-buffer-for-internal-link (buffer)
11173 "Return a buffer to be used for displaying the link target of internal links."
11174 (cond
11175 ((not org-display-internal-link-with-indirect-buffer)
11176 buffer)
11177 ((string-match "(Clone)$" (buffer-name buffer))
11178 (message "Buffer is already a clone, not making another one")
11179 ;; we also do not modify visibility in this case
11180 buffer)
11181 (t ; make a new indirect buffer for displaying the link
11182 (let* ((bn (buffer-name buffer))
11183 (ibn (concat bn "(Clone)"))
11184 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11185 (with-current-buffer ib (org-overview))
11186 ib))))
11188 (defun org-do-occur (regexp &optional cleanup)
11189 "Call the Emacs command `occur'.
11190 If CLEANUP is non-nil, remove the printout of the regular expression
11191 in the *Occur* buffer. This is useful if the regex is long and not useful
11192 to read."
11193 (occur regexp)
11194 (when cleanup
11195 (let ((cwin (selected-window)) win beg end)
11196 (when (setq win (get-buffer-window "*Occur*"))
11197 (select-window win))
11198 (goto-char (point-min))
11199 (when (re-search-forward "match[a-z]+" nil t)
11200 (setq beg (match-end 0))
11201 (when (re-search-forward "^[ \t]*[0-9]+" nil t)
11202 (setq end (1- (match-beginning 0)))))
11203 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11204 (goto-char (point-min))
11205 (select-window cwin))))
11207 ;;; The mark ring for links jumps
11209 (defvar org-mark-ring nil
11210 "Mark ring for positions before jumps in Org-mode.")
11211 (defvar org-mark-ring-last-goto nil
11212 "Last position in the mark ring used to go back.")
11213 ;; Fill and close the ring
11214 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11215 (loop for i from 1 to org-mark-ring-length do
11216 (push (make-marker) org-mark-ring))
11217 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11218 org-mark-ring)
11220 (defun org-mark-ring-push (&optional pos buffer)
11221 "Put the current position or POS into the mark ring and rotate it."
11222 (interactive)
11223 (setq pos (or pos (point)))
11224 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11225 (move-marker (car org-mark-ring)
11226 (or pos (point))
11227 (or buffer (current-buffer)))
11228 (message "%s"
11229 (substitute-command-keys
11230 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11232 (defun org-mark-ring-goto (&optional n)
11233 "Jump to the previous position in the mark ring.
11234 With prefix arg N, jump back that many stored positions. When
11235 called several times in succession, walk through the entire ring.
11236 Org-mode commands jumping to a different position in the current file,
11237 or to another Org-mode file, automatically push the old position
11238 onto the ring."
11239 (interactive "p")
11240 (let (p m)
11241 (if (eq last-command this-command)
11242 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11243 (setq p org-mark-ring))
11244 (setq org-mark-ring-last-goto p)
11245 (setq m (car p))
11246 (org-pop-to-buffer-same-window (marker-buffer m))
11247 (goto-char m)
11248 (when (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11250 ;;; TODO: Use string-remove-prefix and -suffix once we only support
11251 ;;; Emacs 24.4+
11252 (defun org-remove-angle-brackets (s)
11253 (when (equal (substring s 0 1) "<") (setq s (substring s 1)))
11254 (when (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11256 (defun org-add-angle-brackets (s)
11257 (unless (equal (substring s 0 1) "<") (setq s (concat "<" s)))
11258 (unless (equal (substring s -1) ">") (setq s (concat s ">")))
11260 (defun org-remove-double-quotes (s)
11261 (when (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11262 (when (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11265 ;;; Following specific links
11267 (defun org-follow-timestamp-link ()
11268 "Open an agenda view for the time-stamp date/range at point."
11269 (cond
11270 ((org-at-date-range-p t)
11271 (let ((org-agenda-start-on-weekday)
11272 (t1 (match-string 1))
11273 (t2 (match-string 2)) tt1 tt2)
11274 (setq tt1 (time-to-days (org-time-string-to-time t1))
11275 tt2 (time-to-days (org-time-string-to-time t2)))
11276 (let ((org-agenda-buffer-tmp-name
11277 (format "*Org Agenda(a:%s)"
11278 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11279 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11280 ((org-at-timestamp-p t)
11281 (let ((org-agenda-buffer-tmp-name
11282 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11283 (org-agenda-list nil (time-to-days (org-time-string-to-time
11284 (substring (match-string 1) 0 10)))
11285 1)))
11286 (t (error "This should not happen"))))
11289 ;;; Following file links
11290 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11291 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11292 (declare-function mailcap-mime-info
11293 "mailcap" (string &optional request no-decode))
11294 (defvar org-wait nil)
11295 (defun org-open-file (path &optional in-emacs line search)
11296 "Open the file at PATH.
11297 First, this expands any special file name abbreviations. Then the
11298 configuration variable `org-file-apps' is checked if it contains an
11299 entry for this file type, and if yes, the corresponding command is launched.
11301 If no application is found, Emacs simply visits the file.
11303 With optional prefix argument IN-EMACS, Emacs will visit the file.
11304 With a double \\[universal-argument] \\[universal-argument] \
11305 prefix arg, Org tries to avoid opening in Emacs
11306 and to use an external application to visit the file.
11308 Optional LINE specifies a line to go to, optional SEARCH a string
11309 to search for. If LINE or SEARCH is given, the file will be
11310 opened in Emacs, unless an entry from org-file-apps that makes
11311 use of groups in a regexp matches.
11313 If you want to change the way frames are used when following a
11314 link, please customize `org-link-frame-setup'.
11316 If the file does not exist, an error is thrown."
11317 (let* ((file (if (equal path "")
11318 buffer-file-name
11319 (substitute-in-file-name (expand-file-name path))))
11320 (file-apps (append org-file-apps (org-default-apps)))
11321 (apps (cl-remove-if
11322 'org-file-apps-entry-match-against-dlink-p file-apps))
11323 (apps-dlink (cl-remove-if-not
11324 'org-file-apps-entry-match-against-dlink-p file-apps))
11325 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11326 (dirp (unless remp (file-directory-p file)))
11327 (file (if (and dirp org-open-directory-means-index-dot-org)
11328 (concat (file-name-as-directory file) "index.org")
11329 file))
11330 (a-m-a-p (assq 'auto-mode apps))
11331 (dfile (downcase file))
11332 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11333 (link (cond ((and (eq line nil)
11334 (eq search nil))
11335 file)
11336 (line
11337 (concat file "::" (number-to-string line)))
11338 (search
11339 (concat file "::" search))))
11340 (dlink (downcase link))
11341 (old-buffer (current-buffer))
11342 (old-pos (point))
11343 (old-mode major-mode)
11344 ext cmd link-match-data)
11345 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11346 (setq ext (match-string 1 dfile))
11347 (when (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11348 (setq ext (match-string 1 dfile))))
11349 (cond
11350 ((member in-emacs '((16) system))
11351 (setq cmd (cdr (assoc 'system apps))))
11352 (in-emacs (setq cmd 'emacs))
11354 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11355 (and dirp (cdr (assoc 'directory apps)))
11356 ; first, try matching against apps-dlink
11357 ; if we get a match here, store the match data for later
11358 (let ((match (assoc-default dlink apps-dlink
11359 'string-match)))
11360 (if match
11361 (progn (setq link-match-data (match-data))
11362 match)
11363 (progn (setq in-emacs (or in-emacs line search))
11364 nil))) ; if we have no match in apps-dlink,
11365 ; always open the file in emacs if line or search
11366 ; is given (for backwards compatibility)
11367 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11368 'string-match)
11369 (cdr (assoc ext apps))
11370 (cdr (assoc t apps))))))
11371 (when (eq cmd 'system)
11372 (setq cmd (cdr (assoc 'system apps))))
11373 (when (eq cmd 'default)
11374 (setq cmd (cdr (assoc t apps))))
11375 (when (eq cmd 'mailcap)
11376 (require 'mailcap)
11377 (mailcap-parse-mailcaps)
11378 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11379 (command (mailcap-mime-info mime-type)))
11380 (if (stringp command)
11381 (setq cmd command)
11382 (setq cmd 'emacs))))
11383 (when (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11384 (not (file-exists-p file))
11385 (not org-open-non-existing-files))
11386 (user-error "No such file: %s" file))
11387 (cond
11388 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11389 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11390 (while (string-match "['\"]%s['\"]" cmd)
11391 (setq cmd (replace-match "%s" t t cmd)))
11392 (while (string-match "%s" cmd)
11393 (setq cmd (replace-match
11394 (save-match-data
11395 (shell-quote-argument
11396 (convert-standard-filename file)))
11397 t t cmd)))
11399 ;; Replace "%1", "%2" etc. in command with group matches from regex
11400 (save-match-data
11401 (let ((match-index 1)
11402 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11403 (set-match-data link-match-data)
11404 (while (<= match-index number-of-groups)
11405 (let ((regex (concat "%" (number-to-string match-index)))
11406 (replace-with (match-string match-index dlink)))
11407 (while (string-match regex cmd)
11408 (setq cmd (replace-match replace-with t t cmd))))
11409 (setq match-index (+ match-index 1)))))
11411 (save-window-excursion
11412 (message "Running %s...done" cmd)
11413 (start-process-shell-command cmd nil cmd)
11414 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11415 ((or (stringp cmd)
11416 (eq cmd 'emacs))
11417 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11418 (widen)
11419 (if line (progn (org-goto-line line)
11420 (when (derived-mode-p 'org-mode)
11421 (org-reveal)))
11422 (when search (org-link-search search))))
11423 ((consp cmd)
11424 (let ((file (convert-standard-filename file)))
11425 (save-match-data
11426 (set-match-data link-match-data)
11427 (eval cmd))))
11428 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11429 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11430 (or (not (equal old-buffer (current-buffer)))
11431 (not (equal old-pos (point))))
11432 (org-mark-ring-push old-pos old-buffer))))
11434 (defun org-file-apps-entry-match-against-dlink-p (entry)
11435 "This function returns non-nil if `entry' uses a regular
11436 expression which should be matched against the whole link by
11437 org-open-file.
11439 It assumes that is the case when the entry uses a regular
11440 expression which has at least one grouping construct and the
11441 action is either a lisp form or a command string containing
11442 `%1', i.e. using at least one subexpression match as a
11443 parameter."
11444 (let ((selector (car entry))
11445 (action (cdr entry)))
11446 (if (stringp selector)
11447 (and (> (regexp-opt-depth selector) 0)
11448 (or (and (stringp action)
11449 (string-match "%[0-9]" action))
11450 (consp action)))
11451 nil)))
11453 (defun org-default-apps ()
11454 "Return the default applications for this operating system."
11455 (cond
11456 ((eq system-type 'darwin)
11457 org-file-apps-defaults-macosx)
11458 ((eq system-type 'windows-nt)
11459 org-file-apps-defaults-windowsnt)
11460 (t org-file-apps-defaults-gnu)))
11462 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11463 "Convert extensions to regular expressions in the cars of LIST.
11464 Also, weed out any non-string entries, because the return value is used
11465 only for regexp matching.
11466 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11467 point to the symbol `emacs', indicating that the file should
11468 be opened in Emacs."
11469 (append
11470 (delq nil
11471 (mapcar (lambda (x)
11472 (unless (not (stringp (car x)))
11473 (if (string-match "\\W" (car x))
11475 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11476 list))
11477 (when add-auto-mode
11478 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11480 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11481 (defun org-file-remote-p (file)
11482 "Test whether FILE specifies a location on a remote system.
11483 Return non-nil if the location is indeed remote.
11485 For example, the filename \"/user@host:/foo\" specifies a location
11486 on the system \"/user@host:\"."
11487 (cond ((fboundp 'file-remote-p)
11488 (file-remote-p file))
11489 ((fboundp 'tramp-handle-file-remote-p)
11490 (tramp-handle-file-remote-p file))
11491 ((and (boundp 'ange-ftp-name-format)
11492 (string-match (car ange-ftp-name-format) file))
11493 t)))
11496 ;;;; Refiling
11498 (defun org-get-org-file ()
11499 "Read a filename, with default directory `org-directory'."
11500 (let ((default (or org-default-notes-file remember-data-file)))
11501 (read-file-name (format "File name [%s]: " default)
11502 (file-name-as-directory org-directory)
11503 default)))
11505 (defun org-notes-order-reversed-p ()
11506 "Check if the current file should receive notes in reversed order."
11507 (cond
11508 ((not org-reverse-note-order) nil)
11509 ((eq t org-reverse-note-order) t)
11510 ((not (listp org-reverse-note-order)) nil)
11511 (t (catch 'exit
11512 (dolist (entry org-reverse-note-order)
11513 (when (string-match (car entry) buffer-file-name)
11514 (throw 'exit (cdr entry))))))))
11516 (defvar org-refile-target-table nil
11517 "The list of refile targets, created by `org-refile'.")
11519 (defvar org-agenda-new-buffers nil
11520 "Buffers created to visit agenda files.")
11522 (defvar org-refile-cache nil
11523 "Cache for refile targets.")
11525 (defvar org-refile-markers nil
11526 "All the markers used for caching refile locations.")
11528 (defun org-refile-marker (pos)
11529 "Get a new refile marker, but only if caching is in use."
11530 (if (not org-refile-use-cache)
11532 (let ((m (make-marker)))
11533 (move-marker m pos)
11534 (push m org-refile-markers)
11535 m)))
11537 (defun org-refile-cache-clear ()
11538 "Clear the refile cache and disable all the markers."
11539 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11540 (setq org-refile-markers nil)
11541 (setq org-refile-cache nil)
11542 (message "Refile cache has been cleared"))
11544 (defun org-refile-cache-check-set (set)
11545 "Check if all the markers in the cache still have live buffers."
11546 (let (marker)
11547 (catch 'exit
11548 (while (and set (setq marker (nth 3 (pop set))))
11549 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11550 (when (and marker (null (marker-buffer marker)))
11551 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11552 (sit-for 3)
11553 (throw 'exit nil)))
11554 t)))
11556 (defun org-refile-cache-put (set &rest identifiers)
11557 "Push the refile targets SET into the cache, under IDENTIFIERS."
11558 (let* ((key (sha1 (prin1-to-string identifiers)))
11559 (entry (assoc key org-refile-cache)))
11560 (if entry
11561 (setcdr entry set)
11562 (push (cons key set) org-refile-cache))))
11564 (defun org-refile-cache-get (&rest identifiers)
11565 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11566 (cond
11567 ((not org-refile-cache) nil)
11568 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11570 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11571 org-refile-cache))))
11572 (and set (org-refile-cache-check-set set) set)))))
11574 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11575 "Produce a table with refile targets."
11576 (let ((case-fold-search nil)
11577 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11578 (entries (or org-refile-targets '((nil . (:level . 1)))))
11579 targets tgs txt re files desc descre fast-path-p level pos0)
11580 (message "Getting targets...")
11581 (with-current-buffer (or default-buffer (current-buffer))
11582 (dolist (entry entries)
11583 (setq files (car entry) desc (cdr entry))
11584 (setq fast-path-p nil)
11585 (cond
11586 ((null files) (setq files (list (current-buffer))))
11587 ((eq files 'org-agenda-files)
11588 (setq files (org-agenda-files 'unrestricted)))
11589 ((and (symbolp files) (fboundp files))
11590 (setq files (funcall files)))
11591 ((and (symbolp files) (boundp files))
11592 (setq files (symbol-value files))))
11593 (when (stringp files) (setq files (list files)))
11594 (cond
11595 ((eq (car desc) :tag)
11596 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11597 ((eq (car desc) :todo)
11598 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11599 ((eq (car desc) :regexp)
11600 (setq descre (cdr desc)))
11601 ((eq (car desc) :level)
11602 (setq descre (concat "^\\*\\{" (number-to-string
11603 (if org-odd-levels-only
11604 (1- (* 2 (cdr desc)))
11605 (cdr desc)))
11606 "\\}[ \t]")))
11607 ((eq (car desc) :maxlevel)
11608 (setq fast-path-p t)
11609 (setq descre (concat "^\\*\\{1," (number-to-string
11610 (if org-odd-levels-only
11611 (1- (* 2 (cdr desc)))
11612 (cdr desc)))
11613 "\\}[ \t]")))
11614 (t (error "Bad refiling target description %s" desc)))
11615 (dolist (f files)
11616 (with-current-buffer
11617 (if (bufferp f) f (org-get-agenda-file-buffer f))
11619 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11620 (progn
11621 (when (bufferp f) (setq f (buffer-file-name
11622 (buffer-base-buffer f))))
11623 (setq f (and f (expand-file-name f)))
11624 (when (eq org-refile-use-outline-path 'file)
11625 (push (list (file-name-nondirectory f) f nil nil) tgs))
11626 (save-excursion
11627 (save-restriction
11628 (widen)
11629 (goto-char (point-min))
11630 (while (re-search-forward descre nil t)
11631 (goto-char (setq pos0 (point-at-bol)))
11632 (catch 'next
11633 (when org-refile-target-verify-function
11634 (save-match-data
11635 (or (funcall org-refile-target-verify-function)
11636 (throw 'next t))))
11637 (when (and (looking-at org-complex-heading-regexp)
11638 (not (member (match-string 4) excluded-entries))
11639 (match-string 4))
11640 (setq level (org-reduced-level
11641 (- (match-end 1) (match-beginning 1)))
11642 txt (org-link-display-format (match-string 4))
11643 txt (replace-regexp-in-string "\\( *[[0-9]+/?[0-9]*%?]\\)+$" "" txt)
11644 re (format org-complex-heading-regexp-format
11645 (regexp-quote (match-string 4))))
11646 (when org-refile-use-outline-path
11647 (setq txt (mapconcat
11648 'org-protect-slash
11649 (append
11650 (if (eq org-refile-use-outline-path
11651 'file)
11652 (list (file-name-nondirectory
11653 (buffer-file-name
11654 (buffer-base-buffer))))
11655 (when (eq org-refile-use-outline-path
11656 'full-file-path)
11657 (list (buffer-file-name
11658 (buffer-base-buffer)))))
11659 (org-get-outline-path fast-path-p
11660 level txt)
11661 (list txt))
11662 "/")))
11663 (push (list txt f re (org-refile-marker (point)))
11664 tgs)))
11665 (when (= (point) pos0)
11666 ;; verification function has not moved point
11667 (goto-char (point-at-eol))))))))
11668 (when org-refile-use-cache
11669 (org-refile-cache-put tgs (buffer-file-name) descre))
11670 (setq targets (append tgs targets))))))
11671 (message "Getting targets...done")
11672 (nreverse targets)))
11674 (defun org-protect-slash (s)
11675 (while (string-match "/" s)
11676 (setq s (replace-match "\\" t t s)))
11679 (defvar org-olpa (make-vector 20 nil))
11681 (defun org-get-outline-path (&optional fastp level heading)
11682 "Return the outline path to the current entry, as a list.
11684 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11685 routine which makes outline path derivations for an entire file,
11686 avoiding backtracing. Refile target collection makes use of that."
11687 (if fastp
11688 (progn
11689 (when (> level 19)
11690 (error "Outline path failure, more than 19 levels"))
11691 (loop for i from level upto 19 do
11692 (aset org-olpa i nil))
11693 (prog1
11694 (delq nil (append org-olpa nil))
11695 (aset org-olpa level heading)))
11696 (let (rtn case-fold-search)
11697 (save-excursion
11698 (save-restriction
11699 (widen)
11700 (while (org-up-heading-safe)
11701 (when (looking-at org-complex-heading-regexp)
11702 (push (org-trim
11703 (replace-regexp-in-string
11704 ;; Remove statistical/checkboxes cookies
11705 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11706 (org-match-string-no-properties 4)))
11707 rtn)))
11708 rtn)))))
11710 (defun org-format-outline-path (path &optional width prefix separator)
11711 "Format the outline path PATH for display.
11712 WIDTH is the maximum number of characters that is available.
11713 PREFIX is a prefix to be included in the returned string,
11714 such as the file name.
11715 SEPARATOR is inserted between the different parts of the path,
11716 the default is \"/\"."
11717 (setq width (or width 79))
11718 (setq path (delq nil path))
11719 (unless (> width 0)
11720 (user-error "Argument `width' must be positive"))
11721 (setq separator (or separator "/"))
11722 (let* ((org-odd-levels-only nil)
11723 (fpath (concat
11724 prefix (and prefix path separator)
11725 (mapconcat
11726 (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
11727 (loop for head in path
11728 for n from 0
11729 collect (org-add-props
11730 head nil 'face
11731 (nth (% n org-n-level-faces) org-level-faces)))
11732 separator))))
11733 (when (> (length fpath) width)
11734 (if (< width 7)
11735 ;; It's unlikely that `width' will be this small, but don't
11736 ;; waste characters by adding ".." if it is.
11737 (setq fpath (substring fpath 0 width))
11738 (setf (substring fpath (- width 2)) "..")))
11739 fpath))
11741 (defun org-display-outline-path (&optional file current separator just-return-string)
11742 "Display the current outline path in the echo area.
11744 If FILE is non-nil, prepend the output with the file name.
11745 If CURRENT is non-nil, append the current heading to the output.
11746 SEPARATOR is passed through to `org-format-outline-path'. It separates
11747 the different parts of the path and defaults to \"/\".
11748 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11749 (interactive "P")
11750 (let* (case-fold-search
11751 (bfn (buffer-file-name (buffer-base-buffer)))
11752 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11753 res)
11754 (when current (setq path (append path
11755 (save-excursion
11756 (org-back-to-heading t)
11757 (when (looking-at org-complex-heading-regexp)
11758 (list (match-string 4)))))))
11759 (setq res
11760 (org-format-outline-path
11761 path
11762 (1- (frame-width))
11763 (and file bfn (concat (file-name-nondirectory bfn) separator))
11764 separator))
11765 (if just-return-string
11766 (org-no-properties res)
11767 (org-unlogged-message "%s" res))))
11769 (defvar org-refile-history nil
11770 "History for refiling operations.")
11772 (defvar org-after-refile-insert-hook nil
11773 "Hook run after `org-refile' has inserted its stuff at the new location.
11774 Note that this is still *before* the stuff will be removed from
11775 the *old* location.")
11777 (defvar org-capture-last-stored-marker)
11778 (defvar org-refile-keep nil
11779 "Non-nil means `org-refile' will copy instead of refile.")
11781 (defun org-copy ()
11782 "Like `org-refile', but copy."
11783 (interactive)
11784 (let ((org-refile-keep t))
11785 (funcall 'org-refile nil nil nil "Copy")))
11787 (defun org-refile (&optional arg default-buffer rfloc msg)
11788 "Move the entry or entries at point to another heading.
11789 The list of target headings is compiled using the information in
11790 `org-refile-targets', which see.
11792 At the target location, the entry is filed as a subitem of the
11793 target heading. Depending on `org-reverse-note-order', the new
11794 subitem will either be the first or the last subitem.
11796 If there is an active region, all entries in that region will be
11797 refiled. However, the region must fulfill the requirement that
11798 the first heading sets the top-level of the moved text.
11800 With prefix arg ARG, the command will only visit the target
11801 location and not actually move anything.
11803 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11804 refiling operation has put the subtree.
11806 With a numeric prefix argument of `2', refile to the running clock.
11808 With a numeric prefix argument of `3', emulate `org-refile-keep'
11809 being set to t and copy to the target location, don't move it.
11810 Beware that keeping refiled entries may result in duplicated ID
11811 properties.
11813 RFLOC can be a refile location obtained in a different way.
11815 MSG is a string to replace \"Refile\" in the default prompt with
11816 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11818 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11820 If you are using target caching (see `org-refile-use-cache'), you
11821 have to clear the target cache in order to find new targets.
11822 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11823 prefix argument (`C-u C-u C-u C-c C-w')."
11824 (interactive "P")
11825 (if (member arg '(0 (64)))
11826 (org-refile-cache-clear)
11827 (let* ((actionmsg (cond (msg msg)
11828 ((equal arg 3) "Refile (and keep)")
11829 (t "Refile")))
11830 (cbuf (current-buffer))
11831 (regionp (org-region-active-p))
11832 (region-start (and regionp (region-beginning)))
11833 (region-end (and regionp (region-end)))
11834 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11835 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11836 pos it nbuf file re level reversed)
11837 (setq last-command nil)
11838 (when regionp
11839 (goto-char region-start)
11840 (or (bolp) (goto-char (point-at-bol)))
11841 (setq region-start (point))
11842 (unless (or (org-kill-is-subtree-p
11843 (buffer-substring region-start region-end))
11844 (prog1 org-refile-active-region-within-subtree
11845 (let ((s (point-at-eol)))
11846 (org-toggle-heading)
11847 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11848 (user-error "The region is not a (sequence of) subtree(s)")))
11849 (if (equal arg '(16))
11850 (org-refile-goto-last-stored)
11851 (when (or
11852 (and (equal arg 2)
11853 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11854 (prog1
11855 (setq it (list (or org-clock-heading "running clock")
11856 (buffer-file-name
11857 (marker-buffer org-clock-hd-marker))
11859 (marker-position org-clock-hd-marker)))
11860 (setq arg nil)))
11861 (setq it (or rfloc
11862 (let (heading-text)
11863 (save-excursion
11864 (unless (and arg (listp arg))
11865 (org-back-to-heading t)
11866 (setq heading-text
11867 (replace-regexp-in-string
11868 org-bracket-link-regexp
11869 "\\3"
11870 (nth 4 (org-heading-components)))))
11871 (org-refile-get-location
11872 (cond ((and arg (listp arg)) "Goto")
11873 (regionp (concat actionmsg " region to"))
11874 (t (concat actionmsg " subtree \""
11875 heading-text "\" to")))
11876 default-buffer
11877 (and (not (equal '(4) arg))
11878 org-refile-allow-creating-parent-nodes)
11879 arg))))))
11880 (setq file (nth 1 it)
11881 re (nth 2 it)
11882 pos (nth 3 it))
11883 (when (and (not arg)
11885 (equal (buffer-file-name) file)
11886 (if regionp
11887 (and (>= pos region-start)
11888 (<= pos region-end))
11889 (and (>= pos (point))
11890 (< pos (save-excursion
11891 (org-end-of-subtree t t))))))
11892 (error "Cannot refile to position inside the tree or region"))
11893 (setq nbuf (or (find-buffer-visiting file)
11894 (find-file-noselect file)))
11895 (if (and arg (not (equal arg 3)))
11896 (progn
11897 (org-pop-to-buffer-same-window nbuf)
11898 (goto-char pos)
11899 (org-show-context 'org-goto))
11900 (if regionp
11901 (progn
11902 (org-kill-new (buffer-substring region-start region-end))
11903 (org-save-markers-in-region region-start region-end))
11904 (org-copy-subtree 1 nil t))
11905 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11906 (find-file-noselect file)))
11907 (setq reversed (org-notes-order-reversed-p))
11908 (save-excursion
11909 (save-restriction
11910 (widen)
11911 (if pos
11912 (progn
11913 (goto-char pos)
11914 (looking-at org-outline-regexp)
11915 (setq level (org-get-valid-level (funcall outline-level) 1))
11916 (goto-char
11917 (if reversed
11918 (or (outline-next-heading) (point-max))
11919 (or (save-excursion (org-get-next-sibling))
11920 (org-end-of-subtree t t)
11921 (point-max)))))
11922 (setq level 1)
11923 (if (not reversed)
11924 (goto-char (point-max))
11925 (goto-char (point-min))
11926 (or (outline-next-heading) (goto-char (point-max)))))
11927 (unless (bolp) (newline))
11928 (org-paste-subtree level nil nil t)
11929 (when org-log-refile
11930 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11931 (unless (eq org-log-refile 'note)
11932 (save-excursion (org-add-log-note))))
11933 (and org-auto-align-tags
11934 (let ((org-loop-over-headlines-in-active-region nil))
11935 (org-set-tags nil t)))
11936 (let ((bookmark-name (plist-get org-bookmark-names-plist
11937 :last-refile)))
11938 (when bookmark-name
11939 (with-demoted-errors
11940 (bookmark-set bookmark-name))))
11941 ;; If we are refiling for capture, make sure that the
11942 ;; last-capture pointers point here
11943 (when (org-bound-and-true-p org-refile-for-capture)
11944 (let ((bookmark-name (plist-get org-bookmark-names-plist
11945 :last-capture-marker)))
11946 (when bookmark-name
11947 (with-demoted-errors
11948 (bookmark-set bookmark-name))))
11949 (move-marker org-capture-last-stored-marker (point)))
11950 (when (fboundp 'deactivate-mark) (deactivate-mark))
11951 (run-hooks 'org-after-refile-insert-hook))))
11952 (unless org-refile-keep
11953 (if regionp
11954 (delete-region (point) (+ (point) (- region-end region-start)))
11955 (delete-region
11956 (and (org-back-to-heading t) (point))
11957 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11958 (when (featurep 'org-inlinetask)
11959 (org-inlinetask-remove-END-maybe))
11960 (setq org-markers-to-move nil)
11961 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11963 (defun org-refile-goto-last-stored ()
11964 "Go to the location where the last refile was stored."
11965 (interactive)
11966 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11967 (message "This is the location of the last refile"))
11969 (defun org-refile--get-location (refloc tbl)
11970 "When user refile to REFLOC, find the associated target in TBL.
11971 Also check `org-refile-target-table'."
11972 (car (delq
11974 (mapcar
11975 (lambda (r) (or (assoc r tbl)
11976 (assoc r org-refile-target-table)))
11977 (list (replace-regexp-in-string "/$" "" refloc)
11978 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11980 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11981 no-exclude)
11982 "Prompt the user for a refile location, using PROMPT.
11983 PROMPT should not be suffixed with a colon and a space, because
11984 this function appends the default value from
11985 `org-refile-history' automatically, if that is not empty.
11986 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11987 this is used for the GOTO interface."
11988 (let ((org-refile-targets org-refile-targets)
11989 (org-refile-use-outline-path org-refile-use-outline-path)
11990 excluded-entries)
11991 (when (and (derived-mode-p 'org-mode)
11992 (not org-refile-use-cache)
11993 (not no-exclude))
11994 (org-map-tree
11995 (lambda()
11996 (setq excluded-entries
11997 (append excluded-entries (list (org-get-heading t t)))))))
11998 (setq org-refile-target-table
11999 (org-refile-get-targets default-buffer excluded-entries)))
12000 (unless org-refile-target-table
12001 (user-error "No refile targets"))
12002 (let* ((cbuf (current-buffer))
12003 (partial-completion-mode nil)
12004 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12005 (cfunc (if (and org-refile-use-outline-path
12006 org-outline-path-complete-in-steps)
12007 'org-olpath-completing-read
12008 'org-icompleting-read))
12009 (extra (if org-refile-use-outline-path "/" ""))
12010 (cbnex (concat (buffer-name) extra))
12011 (filename (and cfn (expand-file-name cfn)))
12012 (tbl (mapcar
12013 (lambda (x)
12014 (if (and (not (member org-refile-use-outline-path
12015 '(file full-file-path)))
12016 (not (equal filename (nth 1 x))))
12017 (cons (concat (car x) extra " ("
12018 (file-name-nondirectory (nth 1 x)) ")")
12019 (cdr x))
12020 (cons (concat (car x) extra) (cdr x))))
12021 org-refile-target-table))
12022 (completion-ignore-case t)
12023 cdef
12024 (prompt (concat prompt
12025 (or (and (car org-refile-history)
12026 (concat " (default " (car org-refile-history) ")"))
12027 (and (assoc cbnex tbl) (setq cdef cbnex)
12028 (concat " (default " cbnex ")"))) ": "))
12029 pa answ parent-target child parent old-hist)
12030 (setq old-hist org-refile-history)
12031 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12032 nil 'org-refile-history (or cdef (car org-refile-history))))
12033 (if (setq pa (org-refile--get-location answ tbl))
12034 (progn
12035 (org-refile-check-position pa)
12036 (when (or (not org-refile-history)
12037 (not (eq old-hist org-refile-history))
12038 (not (equal (car pa) (car org-refile-history))))
12039 (setq org-refile-history
12040 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12041 org-refile-history
12042 (cdr org-refile-history))))
12043 (when (equal (car org-refile-history) (nth 1 org-refile-history))
12044 (pop org-refile-history)))
12046 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12047 (progn
12048 (setq parent (match-string 1 answ)
12049 child (match-string 2 answ))
12050 (setq parent-target (org-refile--get-location parent tbl))
12051 (when (and parent-target
12052 (or (eq new-nodes t)
12053 (and (eq new-nodes 'confirm)
12054 (y-or-n-p (format "Create new node \"%s\"? "
12055 child)))))
12056 (org-refile-new-child parent-target child)))
12057 (user-error "Invalid target location")))))
12059 (declare-function org-string-nw-p "org-macs" (s))
12060 (defun org-refile-check-position (refile-pointer)
12061 "Check if the refile pointer matches the headline to which it points."
12062 (let* ((file (nth 1 refile-pointer))
12063 (re (nth 2 refile-pointer))
12064 (pos (nth 3 refile-pointer))
12065 buffer)
12066 (if (and (not (markerp pos)) (not file))
12067 (user-error "Please indicate a target file in the refile path")
12068 (when (org-string-nw-p re)
12069 (setq buffer (if (markerp pos)
12070 (marker-buffer pos)
12071 (or (find-buffer-visiting file)
12072 (find-file-noselect file))))
12073 (with-current-buffer buffer
12074 (save-excursion
12075 (save-restriction
12076 (widen)
12077 (goto-char pos)
12078 (beginning-of-line 1)
12079 (unless (org-looking-at-p re)
12080 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12082 (defun org-refile-new-child (parent-target child)
12083 "Use refile target PARENT-TARGET to add new CHILD below it."
12084 (unless parent-target
12085 (error "Cannot find parent for new node"))
12086 (let ((file (nth 1 parent-target))
12087 (pos (nth 3 parent-target))
12088 level)
12089 (with-current-buffer (or (find-buffer-visiting file)
12090 (find-file-noselect file))
12091 (save-excursion
12092 (save-restriction
12093 (widen)
12094 (if pos
12095 (goto-char pos)
12096 (goto-char (point-max))
12097 (unless (bolp) (newline)))
12098 (when (looking-at org-outline-regexp)
12099 (setq level (funcall outline-level))
12100 (org-end-of-subtree t t))
12101 (org-back-over-empty-lines)
12102 (insert "\n" (make-string
12103 (if pos (org-get-valid-level level 1) 1) ?*)
12104 " " child "\n")
12105 (beginning-of-line 0)
12106 (list (concat (car parent-target) "/" child) file "" (point)))))))
12108 (defun org-olpath-completing-read (prompt collection &rest args)
12109 "Read an outline path like a file name."
12110 (let ((thetable collection)
12111 (org-completion-use-ido nil) ; does not work with ido.
12112 (org-completion-use-iswitchb nil)) ; or iswitchb
12113 (apply #'org-icompleting-read
12114 prompt
12115 (lambda (string predicate &optional flag)
12116 (cond
12117 ((eq flag nil) (try-completion string thetable))
12118 ((eq flag t)
12119 (let ((l (length string)))
12120 (mapcar (lambda (x)
12121 (let ((r (substring x l))
12122 (f (if (string-match " ([^)]*)$" x)
12123 (match-string 0 x)
12124 "")))
12125 (if (string-match "/" r)
12126 (concat string (substring r 0 (match-end 0)) f)
12127 x)))
12128 (all-completions string thetable predicate))))
12129 ;; Exact match?
12130 ((eq flag 'lambda) (assoc string thetable))))
12131 args)))
12133 ;;;; Dynamic blocks
12135 (defun org-find-dblock (name)
12136 "Find the first dynamic block with name NAME in the buffer.
12137 If not found, stay at current position and return nil."
12138 (let ((case-fold-search t) pos)
12139 (save-excursion
12140 (goto-char (point-min))
12141 (setq pos (and (re-search-forward
12142 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12143 (match-beginning 0))))
12144 (when pos (goto-char pos))
12145 pos))
12147 (defun org-create-dblock (plist)
12148 "Create a dynamic block section, with parameters taken from PLIST.
12149 PLIST must contain a :name entry which is used as the name of the block."
12150 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12151 (end-of-line 1)
12152 (newline))
12153 (let ((col (current-column))
12154 (name (plist-get plist :name)))
12155 (insert "#+BEGIN: " name)
12156 (while plist
12157 (if (eq (car plist) :name)
12158 (setq plist (cddr plist))
12159 (insert " " (prin1-to-string (pop plist)))))
12160 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12161 (beginning-of-line -2)))
12163 (defun org-prepare-dblock ()
12164 "Prepare dynamic block for refresh.
12165 This empties the block, puts the cursor at the insert position and returns
12166 the property list including an extra property :name with the block name."
12167 (unless (looking-at org-dblock-start-re)
12168 (user-error "Not at a dynamic block"))
12169 (let* ((begdel (1+ (match-end 0)))
12170 (name (org-no-properties (match-string 1)))
12171 (params (append (list :name name)
12172 (read (concat "(" (match-string 3) ")")))))
12173 (save-excursion
12174 (beginning-of-line 1)
12175 (skip-chars-forward " \t")
12176 (setq params (plist-put params :indentation-column (current-column))))
12177 (unless (re-search-forward org-dblock-end-re nil t)
12178 (error "Dynamic block not terminated"))
12179 (setq params
12180 (append params
12181 (list :content (buffer-substring
12182 begdel (match-beginning 0)))))
12183 (delete-region begdel (match-beginning 0))
12184 (goto-char begdel)
12185 (open-line 1)
12186 params))
12188 (defun org-map-dblocks (&optional command)
12189 "Apply COMMAND to all dynamic blocks in the current buffer.
12190 If COMMAND is not given, use `org-update-dblock'."
12191 (let ((cmd (or command 'org-update-dblock)))
12192 (save-excursion
12193 (goto-char (point-min))
12194 (while (re-search-forward org-dblock-start-re nil t)
12195 (goto-char (match-beginning 0))
12196 (save-excursion
12197 (condition-case nil
12198 (funcall cmd)
12199 (error (message "Error during update of dynamic block"))))
12200 (unless (re-search-forward org-dblock-end-re nil t)
12201 (error "Dynamic block not terminated"))))))
12203 (defun org-dblock-update (&optional arg)
12204 "User command for updating dynamic blocks.
12205 Update the dynamic block at point. With prefix ARG, update all dynamic
12206 blocks in the buffer."
12207 (interactive "P")
12208 (if arg
12209 (org-update-all-dblocks)
12210 (or (looking-at org-dblock-start-re)
12211 (org-beginning-of-dblock))
12212 (org-update-dblock)))
12214 (defun org-update-dblock ()
12215 "Update the dynamic block at point.
12216 This means to empty the block, parse for parameters and then call
12217 the correct writing function."
12218 (interactive)
12219 (save-excursion
12220 (let* ((win (selected-window))
12221 (pos (point))
12222 (line (org-current-line))
12223 (params (org-prepare-dblock))
12224 (name (plist-get params :name))
12225 (indent (plist-get params :indentation-column))
12226 (cmd (intern (concat "org-dblock-write:" name))))
12227 (message "Updating dynamic block `%s' at line %d..." name line)
12228 (funcall cmd params)
12229 (message "Updating dynamic block `%s' at line %d...done" name line)
12230 (goto-char pos)
12231 (when (and indent (> indent 0))
12232 (setq indent (make-string indent ?\ ))
12233 (save-excursion
12234 (select-window win)
12235 (org-beginning-of-dblock)
12236 (forward-line 1)
12237 (while (not (looking-at org-dblock-end-re))
12238 (insert indent)
12239 (beginning-of-line 2))
12240 (when (looking-at org-dblock-end-re)
12241 (and (looking-at "[ \t]+")
12242 (replace-match ""))
12243 (insert indent)))))))
12245 (defun org-beginning-of-dblock ()
12246 "Find the beginning of the dynamic block at point.
12247 Error if there is no such block at point."
12248 (let ((pos (point))
12249 beg)
12250 (end-of-line 1)
12251 (if (and (re-search-backward org-dblock-start-re nil t)
12252 (setq beg (match-beginning 0))
12253 (re-search-forward org-dblock-end-re nil t)
12254 (> (match-end 0) pos))
12255 (goto-char beg)
12256 (goto-char pos)
12257 (error "Not in a dynamic block"))))
12259 (defun org-update-all-dblocks ()
12260 "Update all dynamic blocks in the buffer.
12261 This function can be used in a hook."
12262 (interactive)
12263 (when (derived-mode-p 'org-mode)
12264 (org-map-dblocks 'org-update-dblock)))
12267 ;;;; Completion
12269 (declare-function org-export-backend-name "org-export" (cl-x))
12270 (declare-function org-export-backend-options "org-export" (cl-x))
12271 (defun org-get-export-keywords ()
12272 "Return a list of all currently understood export keywords.
12273 Export keywords include options, block names, attributes and
12274 keywords relative to each registered export back-end."
12275 (let (keywords)
12276 (dolist (backend
12277 (org-bound-and-true-p org-export-registered-backends)
12278 (delq nil keywords))
12279 ;; Back-end name (for keywords, like #+LATEX:)
12280 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12281 (dolist (option-entry (org-export-backend-options backend))
12282 ;; Back-end options.
12283 (push (nth 1 option-entry) keywords)))))
12285 (defconst org-options-keywords
12286 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12287 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12288 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12289 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12290 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12292 (defcustom org-structure-template-alist
12293 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12294 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12295 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12296 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12297 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12298 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12299 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12300 ("L" "#+LaTeX: ")
12301 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12302 ("H" "#+HTML: ")
12303 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12304 ("A" "#+ASCII: ")
12305 ("i" "#+INDEX: ?")
12306 ("I" "#+INCLUDE: %file ?"))
12307 "Structure completion elements.
12308 This is a list of abbreviation keys and values. The value gets inserted
12309 if you type `<' followed by the key and then press the completion key,
12310 usually `TAB'. %file will be replaced by a file name after prompting
12311 for the file using completion. The cursor will be placed at the position
12312 of the `?' in the template.
12313 There are two templates for each key, the first uses the original Org syntax,
12314 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12315 the default when the /org-mtags.el/ module has been loaded. See also the
12316 variable `org-mtags-prefer-muse-templates'."
12317 :group 'org-completion
12318 :type '(repeat
12319 (list
12320 (string :tag "Key")
12321 (string :tag "Template")))
12322 :version "25.1"
12323 :package-version '(Org . "8.3"))
12325 (defun org-try-structure-completion ()
12326 "Try to complete a structure template before point.
12327 This looks for strings like \"<e\" on an otherwise empty line and
12328 expands them."
12329 (let ((l (buffer-substring (point-at-bol) (point)))
12331 (when (and (looking-at "[ \t]*$")
12332 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12333 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12334 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12335 (match-beginning 1)) a)
12336 t)))
12338 (defun org-complete-expand-structure-template (start cell)
12339 "Expand a structure template."
12340 (let ((rpl (nth 1 cell))
12341 (ind ""))
12342 (delete-region start (point))
12343 (when (string-match "\\`[ \t]*#\\+" rpl)
12344 (cond
12345 ((bolp))
12346 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12347 (setq ind (buffer-substring (point-at-bol) (point))))
12348 (t (newline))))
12349 (setq start (point))
12350 (when (string-match "%file" rpl)
12351 (setq rpl (replace-match
12352 (concat
12353 "\""
12354 (save-match-data
12355 (abbreviate-file-name (read-file-name "Include file: ")))
12356 "\"")
12357 t t rpl)))
12358 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12359 (concat "\n" ind)))
12360 (insert rpl)
12361 (when (re-search-backward "\\?" start t) (delete-char 1))))
12363 ;;;; TODO, DEADLINE, Comments
12365 (defun org-toggle-comment ()
12366 "Change the COMMENT state of an entry."
12367 (interactive)
12368 (save-excursion
12369 (org-back-to-heading)
12370 (looking-at org-complex-heading-regexp)
12371 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12372 (skip-chars-forward " \t")
12373 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12374 (if (org-in-commented-heading-p t)
12375 (delete-region (point)
12376 (progn (search-forward " " (line-end-position) 'move)
12377 (skip-chars-forward " \t")
12378 (point)))
12379 (insert org-comment-string)
12380 (unless (eolp) (insert " ")))))
12382 (defvar org-last-todo-state-is-todo nil
12383 "This is non-nil when the last TODO state change led to a TODO state.
12384 If the last change removed the TODO tag or switched to DONE, then
12385 this is nil.")
12387 (defvar org-setting-tags nil) ; dynamically skipped
12389 (defvar org-todo-setup-filter-hook nil
12390 "Hook for functions that pre-filter todo specs.
12391 Each function takes a todo spec and returns either nil or the spec
12392 transformed into canonical form." )
12394 (defvar org-todo-get-default-hook nil
12395 "Hook for functions that get a default item for todo.
12396 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12397 nil or a string to be used for the todo mark." )
12399 (defvar org-agenda-headline-snapshot-before-repeat)
12401 (defun org-current-effective-time ()
12402 "Return current time adjusted for `org-extend-today-until' variable."
12403 (let* ((ct (org-current-time))
12404 (dct (decode-time ct))
12405 (ct1
12406 (cond
12407 (org-use-last-clock-out-time-as-effective-time
12408 (or (org-clock-get-last-clock-out-time) ct))
12409 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12410 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12411 (t ct))))
12412 ct1))
12414 (defun org-todo-yesterday (&optional arg)
12415 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12416 (interactive "P")
12417 (if (eq major-mode 'org-agenda-mode)
12418 (apply 'org-agenda-todo-yesterday arg)
12419 (let* ((org-use-effective-time t)
12420 (hour (third (decode-time
12421 (org-current-time))))
12422 (org-extend-today-until (1+ hour)))
12423 (org-todo arg))))
12425 (defvar org-block-entry-blocking ""
12426 "First entry preventing the TODO state change.")
12428 (defun org-cancel-repeater ()
12429 "Cancel a repeater by setting its numeric value to zero."
12430 (interactive)
12431 (save-excursion
12432 (org-back-to-heading t)
12433 (let ((bound1 (point))
12434 (bound0 (save-excursion (outline-next-heading) (point))))
12435 (when (and (re-search-forward
12436 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12437 org-deadline-time-regexp "\\)\\|\\("
12438 org-ts-regexp "\\)")
12439 bound0 t)
12440 (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]"
12441 bound1 t))
12442 (replace-match "0" t nil nil 1)))))
12444 (defun org-todo (&optional arg)
12445 "Change the TODO state of an item.
12446 The state of an item is given by a keyword at the start of the heading,
12447 like
12448 *** TODO Write paper
12449 *** DONE Call mom
12451 The different keywords are specified in the variable `org-todo-keywords'.
12452 By default the available states are \"TODO\" and \"DONE\".
12453 So for this example: when the item starts with TODO, it is changed to DONE.
12454 When it starts with DONE, the DONE is removed. And when neither TODO nor
12455 DONE are present, add TODO at the beginning of the heading.
12457 With \\[universal-argument] prefix arg, use completion to determine the new \
12458 state.
12459 With numeric prefix arg, switch to that state.
12460 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12461 keywords (nextset).
12462 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12463 With a numeric prefix arg of 0, inhibit note taking for the change.
12464 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12466 When called through ELisp, arg is also interpreted in the following way:
12467 `none' -> empty state
12468 \"\"(empty string) -> switch to empty state
12469 `done' -> switch to DONE
12470 `nextset' -> switch to the next set of keywords
12471 `previousset' -> switch to the previous set of keywords
12472 \"WAITING\" -> switch to the specified keyword, but only if it
12473 really is a member of `org-todo-keywords'."
12474 (interactive "P")
12475 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12476 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12477 'region-start-level 'region))
12478 org-loop-over-headlines-in-active-region)
12479 (org-map-entries
12480 `(org-todo ,arg)
12481 org-loop-over-headlines-in-active-region
12482 cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
12483 (when (equal arg '(16)) (setq arg 'nextset))
12484 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12485 (let ((org-blocker-hook org-blocker-hook)
12486 commentp
12487 case-fold-search)
12488 (when (equal arg '(64))
12489 (setq arg nil org-blocker-hook nil))
12490 (when (and org-blocker-hook
12491 (or org-inhibit-blocking
12492 (org-entry-get nil "NOBLOCKING")))
12493 (setq org-blocker-hook nil))
12494 (save-excursion
12495 (catch 'exit
12496 (org-back-to-heading t)
12497 (when (org-in-commented-heading-p t)
12498 (org-toggle-comment)
12499 (setq commentp t))
12500 (when (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12501 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12502 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12503 (let* ((match-data (match-data))
12504 (startpos (point-at-bol))
12505 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12506 (org-log-done org-log-done)
12507 (org-log-repeat org-log-repeat)
12508 (org-todo-log-states org-todo-log-states)
12509 (org-inhibit-logging
12510 (if (equal arg 0)
12511 (progn (setq arg nil) 'note) org-inhibit-logging))
12512 (this (match-string 1))
12513 (hl-pos (match-beginning 0))
12514 (head (org-get-todo-sequence-head this))
12515 (ass (assoc head org-todo-kwd-alist))
12516 (interpret (nth 1 ass))
12517 (done-word (nth 3 ass))
12518 (final-done-word (nth 4 ass))
12519 (org-last-state (or this ""))
12520 (completion-ignore-case t)
12521 (member (member this org-todo-keywords-1))
12522 (tail (cdr member))
12523 (org-state (cond
12524 ((and org-todo-key-trigger
12525 (or (and (equal arg '(4))
12526 (eq org-use-fast-todo-selection 'prefix))
12527 (and (not arg) org-use-fast-todo-selection
12528 (not (eq org-use-fast-todo-selection
12529 'prefix)))))
12530 ;; Use fast selection
12531 (org-fast-todo-selection))
12532 ((and (equal arg '(4))
12533 (or (not org-use-fast-todo-selection)
12534 (not org-todo-key-trigger)))
12535 ;; Read a state with completion
12536 (org-icompleting-read
12537 "State: " (mapcar 'list org-todo-keywords-1)
12538 nil t))
12539 ((eq arg 'right)
12540 (if this
12541 (if tail (car tail) nil)
12542 (car org-todo-keywords-1)))
12543 ((eq arg 'left)
12544 (unless (equal member org-todo-keywords-1)
12545 (if this
12546 (nth (- (length org-todo-keywords-1)
12547 (length tail) 2)
12548 org-todo-keywords-1)
12549 (org-last org-todo-keywords-1))))
12550 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12551 (setq arg nil))) ; hack to fall back to cycling
12552 (arg
12553 ;; user or caller requests a specific state
12554 (cond
12555 ((equal arg "") nil)
12556 ((eq arg 'none) nil)
12557 ((eq arg 'done) (or done-word (car org-done-keywords)))
12558 ((eq arg 'nextset)
12559 (or (car (cdr (member head org-todo-heads)))
12560 (car org-todo-heads)))
12561 ((eq arg 'previousset)
12562 (let ((org-todo-heads (reverse org-todo-heads)))
12563 (or (car (cdr (member head org-todo-heads)))
12564 (car org-todo-heads))))
12565 ((car (member arg org-todo-keywords-1)))
12566 ((stringp arg)
12567 (user-error "State `%s' not valid in this file" arg))
12568 ((nth (1- (prefix-numeric-value arg))
12569 org-todo-keywords-1))))
12570 ((null member) (or head (car org-todo-keywords-1)))
12571 ((equal this final-done-word) nil) ;; -> make empty
12572 ((null tail) nil) ;; -> first entry
12573 ((memq interpret '(type priority))
12574 (if (eq this-command last-command)
12575 (car tail)
12576 (if (> (length tail) 0)
12577 (or done-word (car org-done-keywords))
12578 nil)))
12580 (car tail))))
12581 (org-state (or
12582 (run-hook-with-args-until-success
12583 'org-todo-get-default-hook org-state org-last-state)
12584 org-state))
12585 (next (if org-state (concat " " org-state " ") " "))
12586 (change-plist (list :type 'todo-state-change :from this :to org-state
12587 :position startpos))
12588 dolog now-done-p)
12589 (when org-blocker-hook
12590 (setq org-last-todo-state-is-todo
12591 (not (member this org-done-keywords)))
12592 (unless (save-excursion
12593 (save-match-data
12594 (org-with-wide-buffer
12595 (run-hook-with-args-until-failure
12596 'org-blocker-hook change-plist))))
12597 (if (org-called-interactively-p 'interactive)
12598 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12599 this org-state org-block-entry-blocking)
12600 ;; fail silently
12601 (message "TODO state change from %s to %s blocked (by \"%s\")"
12602 this org-state org-block-entry-blocking)
12603 (throw 'exit nil))))
12604 (store-match-data match-data)
12605 (replace-match next t t)
12606 (cond ((equal this org-state)
12607 (message "TODO state was already %s" (org-trim next)))
12608 ((pos-visible-in-window-p hl-pos)
12609 (message "TODO state changed to %s" (org-trim next))))
12610 (unless head
12611 (setq head (org-get-todo-sequence-head org-state)
12612 ass (assoc head org-todo-kwd-alist)
12613 interpret (nth 1 ass)
12614 done-word (nth 3 ass)
12615 final-done-word (nth 4 ass)))
12616 (when (memq arg '(nextset previousset))
12617 (message "Keyword-Set %d/%d: %s"
12618 (- (length org-todo-sets) -1
12619 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12620 (length org-todo-sets)
12621 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12622 (setq org-last-todo-state-is-todo
12623 (not (member org-state org-done-keywords)))
12624 (setq now-done-p (and (member org-state org-done-keywords)
12625 (not (member this org-done-keywords))))
12626 (and logging (org-local-logging logging))
12627 (when (and (or org-todo-log-states org-log-done)
12628 (not (eq org-inhibit-logging t))
12629 (not (memq arg '(nextset previousset))))
12630 ;; we need to look at recording a time and note
12631 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12632 (nth 2 (assoc this org-todo-log-states))))
12633 (when (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12634 (setq dolog 'time))
12635 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12636 (and org-state
12637 (member org-state org-not-done-keywords)
12638 (not (member this org-not-done-keywords))))
12639 ;; This is now a todo state and was not one before
12640 ;; If there was a CLOSED time stamp, get rid of it.
12641 (org-add-planning-info nil nil 'closed))
12642 (when (and now-done-p org-log-done)
12643 ;; It is now done, and it was not done before
12644 (org-add-planning-info 'closed (org-current-effective-time))
12645 (when (and (not dolog) (eq 'note org-log-done))
12646 (org-add-log-setup 'done org-state this 'findpos 'note)))
12647 (when (and org-state dolog)
12648 ;; This is a non-nil state, and we need to log it
12649 (org-add-log-setup 'state org-state this 'findpos dolog)))
12650 ;; Fixup tag positioning
12651 (org-todo-trigger-tag-changes org-state)
12652 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12653 (when org-provide-todo-statistics
12654 (org-update-parent-todo-statistics))
12655 (run-hooks 'org-after-todo-state-change-hook)
12656 (when (and arg (not (member org-state org-done-keywords)))
12657 (setq head (org-get-todo-sequence-head org-state)))
12658 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12659 ;; Do we need to trigger a repeat?
12660 (when now-done-p
12661 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12662 ;; This is for the agenda, take a snapshot of the headline.
12663 (save-match-data
12664 (setq org-agenda-headline-snapshot-before-repeat
12665 (org-get-heading))))
12666 (org-auto-repeat-maybe org-state))
12667 ;; Fixup cursor location if close to the keyword
12668 (when (and (outline-on-heading-p)
12669 (not (bolp))
12670 (save-excursion (beginning-of-line 1)
12671 (looking-at org-todo-line-regexp))
12672 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12673 (goto-char (or (match-end 2) (match-end 1)))
12674 (and (looking-at " ") (just-one-space)))
12675 (when org-trigger-hook
12676 (save-excursion
12677 (run-hook-with-args 'org-trigger-hook change-plist)))
12678 (when commentp (org-toggle-comment))))))))
12680 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12681 "Block turning an entry into a TODO, using the hierarchy.
12682 This checks whether the current task should be blocked from state
12683 changes. Such blocking occurs when:
12685 1. The task has children which are not all in a completed state.
12687 2. A task has a parent with the property :ORDERED:, and there
12688 are siblings prior to the current task with incomplete
12689 status.
12691 3. The parent of the task is blocked because it has siblings that should
12692 be done first, or is child of a block grandparent TODO entry."
12694 (if (not org-enforce-todo-dependencies)
12695 t ; if locally turned off don't block
12696 (catch 'dont-block
12697 ;; If this is not a todo state change, or if this entry is already DONE,
12698 ;; do not block
12699 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12700 (member (plist-get change-plist :from)
12701 (cons 'done org-done-keywords))
12702 (member (plist-get change-plist :to)
12703 (cons 'todo org-not-done-keywords))
12704 (not (plist-get change-plist :to)))
12705 (throw 'dont-block t))
12706 ;; If this task has children, and any are undone, it's blocked
12707 (save-excursion
12708 (org-back-to-heading t)
12709 (let ((this-level (funcall outline-level)))
12710 (outline-next-heading)
12711 (let ((child-level (funcall outline-level)))
12712 (while (and (not (eobp))
12713 (> child-level this-level))
12714 ;; this todo has children, check whether they are all
12715 ;; completed
12716 (when (and (not (org-entry-is-done-p))
12717 (org-entry-is-todo-p))
12718 (setq org-block-entry-blocking (org-get-heading))
12719 (throw 'dont-block nil))
12720 (outline-next-heading)
12721 (setq child-level (funcall outline-level))))))
12722 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12723 ;; any previous siblings are undone, it's blocked
12724 (save-excursion
12725 (org-back-to-heading t)
12726 (let* ((pos (point))
12727 (parent-pos (and (org-up-heading-safe) (point))))
12728 (unless parent-pos (throw 'dont-block t)) ; no parent
12729 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12730 (forward-line 1)
12731 (re-search-forward org-not-done-heading-regexp pos t))
12732 (setq org-block-entry-blocking (match-string 0))
12733 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12734 ;; Search further up the hierarchy, to see if an ancestor is blocked
12735 (while t
12736 (goto-char parent-pos)
12737 (unless (looking-at org-not-done-heading-regexp)
12738 (throw 'dont-block t)) ; do not block, parent is not a TODO
12739 (setq pos (point))
12740 (setq parent-pos (and (org-up-heading-safe) (point)))
12741 (unless parent-pos (throw 'dont-block t)) ; no parent
12742 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12743 (forward-line 1)
12744 (re-search-forward org-not-done-heading-regexp pos t)
12745 (setq org-block-entry-blocking (org-get-heading)))
12746 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12748 (defcustom org-track-ordered-property-with-tag nil
12749 "Should the ORDERED property also be shown as a tag?
12750 The ORDERED property decides if an entry should require subtasks to be
12751 completed in sequence. Since a property is not very visible, setting
12752 this option means that toggling the ORDERED property with the command
12753 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12754 not relevant for the behavior, but it makes things more visible.
12756 Note that toggling the tag with tags commands will not change the property
12757 and therefore not influence behavior!
12759 This can be t, meaning the tag ORDERED should be used, It can also be a
12760 string to select a different tag for this task."
12761 :group 'org-todo
12762 :type '(choice
12763 (const :tag "No tracking" nil)
12764 (const :tag "Track with ORDERED tag" t)
12765 (string :tag "Use other tag")))
12767 (defun org-toggle-ordered-property ()
12768 "Toggle the ORDERED property of the current entry.
12769 For better visibility, you can track the value of this property with a tag.
12770 See variable `org-track-ordered-property-with-tag'."
12771 (interactive)
12772 (let* ((t1 org-track-ordered-property-with-tag)
12773 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12774 (save-excursion
12775 (org-back-to-heading)
12776 (if (org-entry-get nil "ORDERED")
12777 (progn
12778 (org-delete-property "ORDERED")
12779 (and tag (org-toggle-tag tag 'off))
12780 (message "Subtasks can be completed in arbitrary order"))
12781 (org-entry-put nil "ORDERED" "t")
12782 (and tag (org-toggle-tag tag 'on))
12783 (message "Subtasks must be completed in sequence")))))
12785 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12786 (defun org-block-todo-from-checkboxes (change-plist)
12787 "Block turning an entry into a TODO, using checkboxes.
12788 This checks whether the current task should be blocked from state
12789 changes because there are unchecked boxes in this entry."
12790 (if (not org-enforce-todo-checkbox-dependencies)
12791 t ; if locally turned off don't block
12792 (catch 'dont-block
12793 ;; If this is not a todo state change, or if this entry is already DONE,
12794 ;; do not block
12795 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12796 (member (plist-get change-plist :from)
12797 (cons 'done org-done-keywords))
12798 (member (plist-get change-plist :to)
12799 (cons 'todo org-not-done-keywords))
12800 (not (plist-get change-plist :to)))
12801 (throw 'dont-block t))
12802 ;; If this task has checkboxes that are not checked, it's blocked
12803 (save-excursion
12804 (org-back-to-heading t)
12805 (let ((beg (point)) end)
12806 (outline-next-heading)
12807 (setq end (point))
12808 (goto-char beg)
12809 (when (org-list-search-forward
12810 (concat (org-item-beginning-re)
12811 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12812 "\\[[- ]\\]")
12813 end t)
12814 (when (boundp 'org-blocked-by-checkboxes)
12815 (setq org-blocked-by-checkboxes t))
12816 (throw 'dont-block nil))))
12817 t))) ; do not block
12819 (defun org-entry-blocked-p ()
12820 "Non-nil if entry at point is blocked."
12821 (and (not (org-entry-get nil "NOBLOCKING"))
12822 (member (org-entry-get nil "TODO") org-not-done-keywords)
12823 (not (run-hook-with-args-until-failure
12824 'org-blocker-hook
12825 (list :type 'todo-state-change
12826 :position (point)
12827 :from 'todo
12828 :to 'done)))))
12830 (defun org-update-statistics-cookies (all)
12831 "Update the statistics cookie, either from TODO or from checkboxes.
12832 This should be called with the cursor in a line with a statistics cookie."
12833 (interactive "P")
12834 (if all
12835 (progn
12836 (org-update-checkbox-count 'all)
12837 (org-map-entries 'org-update-parent-todo-statistics))
12838 (if (not (org-at-heading-p))
12839 (org-update-checkbox-count)
12840 (let ((pos (point-marker))
12841 end l1 l2)
12842 (ignore-errors (org-back-to-heading t))
12843 (if (not (org-at-heading-p))
12844 (org-update-checkbox-count)
12845 (setq l1 (org-outline-level))
12846 (setq end (save-excursion
12847 (outline-next-heading)
12848 (when (org-at-heading-p) (setq l2 (org-outline-level)))
12849 (point)))
12850 (if (and (save-excursion
12851 (re-search-forward
12852 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12853 (not (save-excursion (re-search-forward
12854 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12855 (org-update-checkbox-count)
12856 (if (and l2 (> l2 l1))
12857 (progn
12858 (goto-char end)
12859 (org-update-parent-todo-statistics))
12860 (goto-char pos)
12861 (beginning-of-line 1)
12862 (while (re-search-forward
12863 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12864 (point-at-eol) t)
12865 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12866 (goto-char pos)
12867 (move-marker pos nil)))))
12869 (defvar org-entry-property-inherited-from) ;; defined below
12870 (defun org-update-parent-todo-statistics ()
12871 "Update any statistics cookie in the parent of the current headline.
12872 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12873 the entire subtree and this will travel up the hierarchy and update
12874 statistics everywhere."
12875 (let* ((prop (save-excursion (org-up-heading-safe)
12876 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12877 (recursive (or (not org-hierarchical-todo-statistics)
12878 (and prop (string-match "\\<recursive\\>" prop))))
12879 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12881 (first t)
12882 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12883 level ltoggle l1 new ndel
12884 (cnt-all 0) (cnt-done 0) is-percent kwd
12885 checkbox-beg ov ovs ove cookie-present)
12886 (catch 'exit
12887 (save-excursion
12888 (beginning-of-line 1)
12889 (setq ltoggle (funcall outline-level))
12890 ;; Three situations are to consider:
12892 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12893 ;; to the top-level ancestor on the headline;
12895 ;; 2. If parent has "recursive" property, repeat up to the
12896 ;; headline setting that property, taking inheritance into
12897 ;; account;
12899 ;; 3. Else, move up to direct parent and proceed only once.
12900 (while (and (setq level (org-up-heading-safe))
12901 (or recursive first)
12902 (>= (point) lim))
12903 (setq first nil cookie-present nil)
12904 (unless (and level
12905 (not (string-match
12906 "\\<checkbox\\>"
12907 (downcase (or (org-entry-get nil "COOKIE_DATA")
12908 "")))))
12909 (throw 'exit nil))
12910 (while (re-search-forward box-re (point-at-eol) t)
12911 (setq cnt-all 0 cnt-done 0 cookie-present t)
12912 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12913 (save-match-data
12914 (unless (outline-next-heading) (throw 'exit nil))
12915 (while (and (looking-at org-complex-heading-regexp)
12916 (> (setq l1 (length (match-string 1))) level))
12917 (setq kwd (and (or recursive (= l1 ltoggle))
12918 (match-string 2)))
12919 (if (or (eq org-provide-todo-statistics 'all-headlines)
12920 (and (eq org-provide-todo-statistics t)
12921 (or (member kwd org-done-keywords)))
12922 (and (listp org-provide-todo-statistics)
12923 (stringp (car org-provide-todo-statistics))
12924 (or (member kwd org-provide-todo-statistics)
12925 (member kwd org-done-keywords)))
12926 (and (listp org-provide-todo-statistics)
12927 (listp (car org-provide-todo-statistics))
12928 (or (member kwd (car org-provide-todo-statistics))
12929 (and (member kwd org-done-keywords)
12930 (member kwd (cadr org-provide-todo-statistics))))))
12931 (setq cnt-all (1+ cnt-all))
12932 (and (eq org-provide-todo-statistics t)
12934 (setq cnt-all (1+ cnt-all))))
12935 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12936 (member kwd org-done-keywords))
12937 (and (listp org-provide-todo-statistics)
12938 (listp (car org-provide-todo-statistics))
12939 (member kwd org-done-keywords)
12940 (member kwd (cadr org-provide-todo-statistics)))
12941 (and (listp org-provide-todo-statistics)
12942 (stringp (car org-provide-todo-statistics))
12943 (member kwd org-done-keywords)))
12944 (setq cnt-done (1+ cnt-done)))
12945 (outline-next-heading)))
12946 (setq new
12947 (if is-percent
12948 (format "[%d%%]" (floor (* 100.0 cnt-done)
12949 (max 1 cnt-all)))
12950 (format "[%d/%d]" cnt-done cnt-all))
12951 ndel (- (match-end 0) checkbox-beg))
12952 ;; handle overlays when updating cookie from column view
12953 (when (setq ov (car (overlays-at checkbox-beg)))
12954 (setq ovs (overlay-start ov) ove (overlay-end ov))
12955 (delete-overlay ov))
12956 (goto-char checkbox-beg)
12957 (insert new)
12958 (delete-region (point) (+ (point) ndel))
12959 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12960 (when ov (move-overlay ov ovs ove)))
12961 (when cookie-present
12962 (run-hook-with-args 'org-after-todo-statistics-hook
12963 cnt-done (- cnt-all cnt-done))))))
12964 (run-hooks 'org-todo-statistics-hook)))
12966 (defvar org-after-todo-statistics-hook nil
12967 "Hook that is called after a TODO statistics cookie has been updated.
12968 Each function is called with two arguments: the number of not-done entries
12969 and the number of done entries.
12971 For example, the following function, when added to this hook, will switch
12972 an entry to DONE when all children are done, and back to TODO when new
12973 entries are set to a TODO status. Note that this hook is only called
12974 when there is a statistics cookie in the headline!
12976 (defun org-summary-todo (n-done n-not-done)
12977 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12978 (let (org-log-done org-log-states) ; turn off logging
12979 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12982 (defvar org-todo-statistics-hook nil
12983 "Hook that is run whenever Org thinks TODO statistics should be updated.
12984 This hook runs even if there is no statistics cookie present, in which case
12985 `org-after-todo-statistics-hook' would not run.")
12987 (defun org-todo-trigger-tag-changes (state)
12988 "Apply the changes defined in `org-todo-state-tags-triggers'."
12989 (let ((l org-todo-state-tags-triggers)
12990 changes)
12991 (when (or (not state) (equal state ""))
12992 (setq changes (append changes (cdr (assoc "" l)))))
12993 (when (and (stringp state) (> (length state) 0))
12994 (setq changes (append changes (cdr (assoc state l)))))
12995 (when (member state org-not-done-keywords)
12996 (setq changes (append changes (cdr (assoc 'todo l)))))
12997 (when (member state org-done-keywords)
12998 (setq changes (append changes (cdr (assoc 'done l)))))
12999 (dolist (c changes)
13000 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13002 (defun org-local-logging (value)
13003 "Get logging settings from a property VALUE."
13004 ;; Directly set the variables, they are already local.
13005 (setq org-log-done nil
13006 org-log-repeat nil
13007 org-todo-log-states nil)
13008 (dolist (w (org-split-string value))
13009 (let (a)
13010 (cond
13011 ((setq a (assoc w org-startup-options))
13012 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13013 (set (nth 1 a) (nth 2 a))))
13014 ((setq a (org-extract-log-state-settings w))
13015 (and (member (car a) org-todo-keywords-1)
13016 (push a org-todo-log-states)))))))
13018 (defun org-get-todo-sequence-head (kwd)
13019 "Return the head of the TODO sequence to which KWD belongs.
13020 If KWD is not set, check if there is a text property remembering the
13021 right sequence."
13022 (let (p)
13023 (cond
13024 ((not kwd)
13025 (or (get-text-property (point-at-bol) 'org-todo-head)
13026 (progn
13027 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13028 nil (point-at-eol)))
13029 (get-text-property p 'org-todo-head))))
13030 ((not (member kwd org-todo-keywords-1))
13031 (car org-todo-keywords-1))
13032 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13034 (defun org-fast-todo-selection ()
13035 "Fast TODO keyword selection with single keys.
13036 Returns the new TODO keyword, or nil if no state change should occur."
13037 (let* ((fulltable org-todo-key-alist)
13038 (done-keywords org-done-keywords) ;; needed for the faces.
13039 (maxlen (apply 'max (mapcar
13040 (lambda (x)
13041 (if (stringp (car x)) (string-width (car x)) 0))
13042 fulltable)))
13043 (expert nil)
13044 (fwidth (+ maxlen 3 1 3))
13045 (ncol (/ (- (window-width) 4) fwidth))
13046 tg cnt e c tbl
13047 groups ingroup)
13048 (save-excursion
13049 (save-window-excursion
13050 (if expert
13051 (set-buffer (get-buffer-create " *Org todo*"))
13052 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13053 (erase-buffer)
13054 (setq-local org-done-keywords done-keywords)
13055 (setq tbl fulltable cnt 0)
13056 (while (setq e (pop tbl))
13057 (cond
13058 ((equal e '(:startgroup))
13059 (push '() groups) (setq ingroup t)
13060 (unless (= cnt 0)
13061 (setq cnt 0)
13062 (insert "\n"))
13063 (insert "{ "))
13064 ((equal e '(:endgroup))
13065 (setq ingroup nil cnt 0)
13066 (insert "}\n"))
13067 ((equal e '(:newline))
13068 (unless (= cnt 0)
13069 (setq cnt 0)
13070 (insert "\n")
13071 (setq e (car tbl))
13072 (while (equal (car tbl) '(:newline))
13073 (insert "\n")
13074 (setq tbl (cdr tbl)))))
13076 (setq tg (car e) c (cdr e))
13077 (when ingroup (push tg (car groups)))
13078 (setq tg (org-add-props tg nil 'face
13079 (org-get-todo-face tg)))
13080 (when (and (= cnt 0) (not ingroup)) (insert " "))
13081 (insert "[" c "] " tg (make-string
13082 (- fwidth 4 (length tg)) ?\ ))
13083 (when (= (setq cnt (1+ cnt)) ncol)
13084 (insert "\n")
13085 (when ingroup (insert " "))
13086 (setq cnt 0)))))
13087 (insert "\n")
13088 (goto-char (point-min))
13089 (unless expert (org-fit-window-to-buffer))
13090 (message "[a-z..]:Set [SPC]:clear")
13091 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13092 (cond
13093 ((or (= c ?\C-g)
13094 (and (= c ?q) (not (rassoc c fulltable))))
13095 (setq quit-flag t))
13096 ((= c ?\ ) nil)
13097 ((setq e (rassoc c fulltable) tg (car e))
13099 (t (setq quit-flag t)))))))
13101 (defun org-entry-is-todo-p ()
13102 (member (org-get-todo-state) org-not-done-keywords))
13104 (defun org-entry-is-done-p ()
13105 (member (org-get-todo-state) org-done-keywords))
13107 (defun org-get-todo-state ()
13108 "Return the TODO keyword of the current subtree."
13109 (save-excursion
13110 (org-back-to-heading t)
13111 (and (looking-at org-todo-line-regexp)
13112 (match-end 2)
13113 (match-string 2))))
13115 (defun org-at-date-range-p (&optional inactive-ok)
13116 "Non-nil if point is inside a date range.
13118 When optional argument INACTIVE-OK is non-nil, also consider
13119 inactive time ranges.
13121 When this function returns a non-nil value, match data is set
13122 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13123 on INACTIVE-OK."
13124 (interactive)
13125 (save-excursion
13126 (catch 'exit
13127 (let ((pos (point)))
13128 (skip-chars-backward "^[<\r\n")
13129 (skip-chars-backward "<[")
13130 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13131 (>= (match-end 0) pos)
13132 (throw 'exit t))
13133 (skip-chars-backward "^<[\r\n")
13134 (skip-chars-backward "<[")
13135 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13136 (>= (match-end 0) pos)
13137 (throw 'exit t)))
13138 nil)))
13140 (defun org-get-repeat (&optional tagline)
13141 "Check if there is a deadline/schedule with repeater in this entry."
13142 (save-match-data
13143 (save-excursion
13144 (org-back-to-heading t)
13145 (and (re-search-forward (if tagline
13146 (concat tagline "\\s-*" org-repeat-re)
13147 org-repeat-re)
13148 (org-entry-end-position) t)
13149 (match-string-no-properties 1)))))
13151 (defvar org-last-changed-timestamp)
13152 (defvar org-last-inserted-timestamp)
13153 (defvar org-log-post-message)
13154 (defvar org-log-note-purpose)
13155 (defvar org-log-note-how nil)
13156 (defvar org-log-note-extra)
13157 (defun org-auto-repeat-maybe (done-word)
13158 "Check if the current headline contains a repeated deadline/schedule.
13159 If yes, set TODO state back to what it was and change the base date
13160 of repeating deadline/scheduled time stamps to new date.
13161 This function is run automatically after each state change to a DONE state."
13162 ;; last-state is dynamically scoped into this function
13163 (let* ((repeat (org-get-repeat))
13164 (aa (assoc org-last-state org-todo-kwd-alist))
13165 (interpret (nth 1 aa))
13166 (head (nth 2 aa))
13167 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13168 (msg "Entry repeats: ")
13169 (org-log-done nil)
13170 (org-todo-log-states nil)
13171 re type n what ts time to-state)
13172 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13173 (when (eq org-log-repeat t) (setq org-log-repeat 'state))
13174 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13175 org-todo-repeat-to-state))
13176 (unless (and to-state (member to-state org-todo-keywords-1))
13177 (setq to-state (if (eq interpret 'type) org-last-state head)))
13178 (org-todo to-state)
13179 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13180 (org-entry-put nil "LAST_REPEAT" (format-time-string
13181 (org-time-stamp-format t t))))
13182 (when org-log-repeat
13183 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13184 (memq 'org-add-log-note post-command-hook))
13185 ;; OK, we are already setup for some record
13186 (when (eq org-log-repeat 'note)
13187 ;; make sure we take a note, not only a time stamp
13188 (setq org-log-note-how 'note))
13189 ;; Set up for taking a record
13190 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13191 org-last-state
13192 'findpos org-log-repeat)))
13193 (org-back-to-heading t)
13194 (org-add-planning-info nil nil 'closed)
13195 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13196 org-deadline-time-regexp "\\)\\|\\("
13197 org-ts-regexp "\\)"))
13198 (while (re-search-forward
13199 re (save-excursion (outline-next-heading) (point)) t)
13200 (setq type (if (match-end 1) org-scheduled-string
13201 (if (match-end 3) org-deadline-string "Plain:"))
13202 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13203 (if (not (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))
13204 (org-remove-timestamp-with-keyword org-scheduled-string)
13205 (setq n (string-to-number (match-string 2 ts))
13206 what (match-string 3 ts))
13207 (when (equal what "w") (setq n (* n 7) what "d"))
13208 (when (and (equal what "h")
13209 (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13210 (user-error
13211 "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13212 ;; Preparation, see if we need to modify the start date for the change
13213 (when (match-end 1)
13214 (setq time (save-match-data (org-time-string-to-time ts)))
13215 (cond
13216 ((equal (match-string 1 ts) ".")
13217 ;; Shift starting date to today
13218 (org-timestamp-change
13219 (- (org-today) (time-to-days time))
13220 'day))
13221 ((equal (match-string 1 ts) "+")
13222 (let ((nshiftmax 10) (nshift 0))
13223 (while (or (= nshift 0)
13224 (<= (time-to-days time)
13225 (time-to-days (current-time))))
13226 (when (= (incf nshift) nshiftmax)
13227 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13228 (user-error "Abort")))
13229 (org-timestamp-change n (cdr (assoc what whata)))
13230 (org-at-timestamp-p t)
13231 (setq ts (match-string 1))
13232 (setq time (save-match-data (org-time-string-to-time ts)))))
13233 (org-timestamp-change (- n) (cdr (assoc what whata)))
13234 ;; rematch, so that we have everything in place for the real shift
13235 (org-at-timestamp-p t)
13236 (setq ts (match-string 1))
13237 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13238 (save-excursion
13239 (org-timestamp-change n (cdr (assoc what whata)) nil t))
13240 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13241 (setq org-log-post-message msg)
13242 (message "%s" msg))))
13244 (defun org-show-todo-tree (arg)
13245 "Make a compact tree which shows all headlines marked with TODO.
13246 The tree will show the lines where the regexp matches, and all higher
13247 headlines above the match.
13248 With a \\[universal-argument] prefix, prompt for a regexp to match.
13249 With a numeric prefix N, construct a sparse tree for the Nth element
13250 of `org-todo-keywords-1'."
13251 (interactive "P")
13252 (let ((case-fold-search nil)
13253 (kwd-re
13254 (cond ((null arg) org-not-done-regexp)
13255 ((equal arg '(4))
13256 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13257 (mapcar 'list org-todo-keywords-1))))
13258 (concat "\\("
13259 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13260 "\\)\\>")))
13261 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13262 (regexp-quote (nth (1- (prefix-numeric-value arg))
13263 org-todo-keywords-1)))
13264 (t (user-error "Invalid prefix argument: %s" arg)))))
13265 (message "%d TODO entries found"
13266 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13268 (defun org-deadline (arg &optional time)
13269 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13270 With one universal prefix argument, remove any deadline from the item.
13271 With two universal prefix arguments, prompt for a warning delay.
13272 With argument TIME, set the deadline at the corresponding date. TIME
13273 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13274 (interactive "P")
13275 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13276 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13277 'region-start-level 'region))
13278 org-loop-over-headlines-in-active-region)
13279 (org-map-entries
13280 `(org-deadline ',arg ,time)
13281 org-loop-over-headlines-in-active-region
13282 cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
13283 (let* ((old-date (org-entry-get nil "DEADLINE"))
13284 (old-date-time (when old-date (org-time-string-to-time old-date)))
13285 (repeater (and old-date
13286 (string-match
13287 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13288 old-date)
13289 (match-string 1 old-date))))
13290 (cond
13291 ((equal arg '(4))
13292 (when (and old-date org-log-redeadline)
13293 (org-add-log-setup 'deldeadline nil old-date 'findpos
13294 org-log-redeadline))
13295 (org-remove-timestamp-with-keyword org-deadline-string)
13296 (message "Item no longer has a deadline."))
13297 ((equal arg '(16))
13298 (save-excursion
13299 (org-back-to-heading t)
13300 (if (re-search-forward
13301 org-deadline-time-regexp
13302 (save-excursion (outline-next-heading) (point)) t)
13303 (let* ((rpl0 (match-string 1))
13304 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13305 (replace-match
13306 (concat org-deadline-string
13307 " <" rpl
13308 (format " -%dd"
13309 (abs
13310 (- (time-to-days
13311 (save-match-data
13312 (org-read-date nil t nil "Warn starting from" old-date-time)))
13313 (time-to-days old-date-time))))
13314 ">") t t))
13315 (user-error "No deadline information to update"))))
13317 (org-add-planning-info 'deadline time 'closed)
13318 (when (and old-date
13319 org-log-redeadline
13320 (not (equal old-date org-last-inserted-timestamp)))
13321 (org-add-log-setup
13322 'redeadline org-last-inserted-timestamp old-date 'findpos
13323 org-log-redeadline))
13324 (when repeater
13325 (save-excursion
13326 (org-back-to-heading t)
13327 (when (re-search-forward (concat org-deadline-string " "
13328 org-last-inserted-timestamp)
13329 (save-excursion
13330 (outline-next-heading) (point)) t)
13331 (goto-char (1- (match-end 0)))
13332 (insert " " repeater)
13333 (setq org-last-inserted-timestamp
13334 (concat (substring org-last-inserted-timestamp 0 -1)
13335 " " repeater
13336 (substring org-last-inserted-timestamp -1))))))
13337 (message "Deadline on %s" org-last-inserted-timestamp))))))
13339 (defun org-schedule (arg &optional time)
13340 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13341 With one universal prefix argument, remove any scheduling date from the item.
13342 With two universal prefix arguments, prompt for a delay cookie.
13343 With argument TIME, scheduled at the corresponding date. TIME can
13344 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13345 (interactive "P")
13346 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13347 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13348 'region-start-level 'region))
13349 org-loop-over-headlines-in-active-region)
13350 (org-map-entries
13351 `(org-schedule ',arg ,time)
13352 org-loop-over-headlines-in-active-region
13353 cl (when (outline-invisible-p) (org-end-of-subtree nil t))))
13354 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13355 (old-date-time (when old-date (org-time-string-to-time old-date)))
13356 (repeater (and old-date
13357 (string-match
13358 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13359 old-date)
13360 (match-string 1 old-date))))
13361 (cond
13362 ((equal arg '(4))
13363 (progn
13364 (when (and old-date org-log-reschedule)
13365 (org-add-log-setup 'delschedule nil old-date 'findpos
13366 org-log-reschedule))
13367 (org-remove-timestamp-with-keyword org-scheduled-string)
13368 (message "Item is no longer scheduled.")))
13369 ((equal arg '(16))
13370 (save-excursion
13371 (org-back-to-heading t)
13372 (if (re-search-forward
13373 org-scheduled-time-regexp
13374 (save-excursion (outline-next-heading) (point)) t)
13375 (let* ((rpl0 (match-string 1))
13376 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13377 (replace-match
13378 (concat org-scheduled-string
13379 " <" rpl
13380 (format " -%dd"
13381 (abs
13382 (- (time-to-days
13383 (save-match-data
13384 (org-read-date nil t nil "Delay until" old-date-time)))
13385 (time-to-days old-date-time))))
13386 ">") t t))
13387 (user-error "No scheduled information to update"))))
13389 (org-add-planning-info 'scheduled time 'closed)
13390 (when (and old-date
13391 org-log-reschedule
13392 (not (equal old-date org-last-inserted-timestamp)))
13393 (org-add-log-setup
13394 'reschedule org-last-inserted-timestamp old-date 'findpos
13395 org-log-reschedule))
13396 (when repeater
13397 (save-excursion
13398 (org-back-to-heading t)
13399 (when (re-search-forward (concat org-scheduled-string " "
13400 org-last-inserted-timestamp)
13401 (save-excursion
13402 (outline-next-heading) (point)) t)
13403 (goto-char (1- (match-end 0)))
13404 (insert " " repeater)
13405 (setq org-last-inserted-timestamp
13406 (concat (substring org-last-inserted-timestamp 0 -1)
13407 " " repeater
13408 (substring org-last-inserted-timestamp -1))))))
13409 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13411 (defun org-get-scheduled-time (pom &optional inherit)
13412 "Get the scheduled time as a time tuple, of a format suitable
13413 for calling org-schedule with, or if there is no scheduling,
13414 returns nil."
13415 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13416 (when time
13417 (apply 'encode-time (org-parse-time-string time)))))
13419 (defun org-get-deadline-time (pom &optional inherit)
13420 "Get the deadline as a time tuple, of a format suitable for
13421 calling org-deadline with, or if there is no scheduling, returns
13422 nil."
13423 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13424 (when time
13425 (apply 'encode-time (org-parse-time-string time)))))
13427 (defun org-remove-timestamp-with-keyword (keyword)
13428 "Remove all time stamps with KEYWORD in the current entry."
13429 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13430 beg)
13431 (save-excursion
13432 (org-back-to-heading t)
13433 (setq beg (point))
13434 (outline-next-heading)
13435 (while (re-search-backward re beg t)
13436 (replace-match "")
13437 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13438 (equal (char-before) ?\ ))
13439 (backward-delete-char 1)
13440 (when (string-match "^[ \t]*$" (buffer-substring
13441 (point-at-bol) (point-at-eol)))
13442 (delete-region (point-at-bol)
13443 (min (point-max) (1+ (point-at-eol))))))))))
13445 (defvar org-time-was-given) ; dynamically scoped parameter
13446 (defvar org-end-time-was-given) ; dynamically scoped parameter
13448 (defun org-at-planning-p ()
13449 "Non-nil when point is on a planning info line."
13450 ;; This is as accurate and faster than `org-element-at-point' since
13451 ;; planning info location is fixed in the section.
13452 (org-with-wide-buffer
13453 (beginning-of-line)
13454 (and (org-looking-at-p org-planning-line-re)
13455 (eq (point)
13456 (ignore-errors
13457 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13458 (org-back-to-heading t)
13459 (org-with-limited-levels (org-back-to-heading t)))
13460 (line-beginning-position 2))))))
13462 (defun org-add-planning-info (what &optional time &rest remove)
13463 "Insert new timestamp with keyword in the planning line.
13464 WHAT indicates what kind of time stamp to add. It is a symbol
13465 among `closed', `deadline', `scheduled' and nil. TIME indicates
13466 the time to use. If none is given, the user is prompted for
13467 a date. REMOVE indicates what kind of entries to remove. An old
13468 WHAT entry will also be removed."
13469 (let (org-time-was-given org-end-time-was-given default-time default-input)
13470 (catch 'exit
13471 (when (and (memq what '(scheduled deadline))
13472 (or (not time)
13473 (and (stringp time)
13474 (string-match "^[-+]+[0-9]" time))))
13475 ;; Try to get a default date/time from existing timestamp
13476 (save-excursion
13477 (org-back-to-heading t)
13478 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13479 (when (re-search-forward (if (eq what 'scheduled)
13480 org-scheduled-time-regexp
13481 org-deadline-time-regexp)
13482 end t)
13483 (setq ts (match-string 1)
13484 default-time (apply 'encode-time (org-parse-time-string ts))
13485 default-input (and ts (org-get-compact-tod ts)))))))
13486 (when what
13487 (setq time
13488 (if (stringp time)
13489 ;; This is a string (relative or absolute), set
13490 ;; proper date.
13491 (apply #'encode-time
13492 (org-read-date-analyze
13493 time default-time (decode-time default-time)))
13494 ;; If necessary, get the time from the user
13495 (or time (org-read-date nil 'to-time nil nil
13496 default-time default-input)))))
13498 (org-with-wide-buffer
13499 (org-back-to-heading t)
13500 (forward-line)
13501 (unless (bolp) (insert "\n"))
13502 (cond ((org-looking-at-p org-planning-line-re)
13503 ;; Move to current indentation.
13504 (skip-chars-forward " \t")
13505 ;; Check if we have to remove something.
13506 (dolist (type (if what (cons what remove) remove))
13507 (save-excursion
13508 (when (re-search-forward
13509 (case type
13510 (closed org-closed-time-regexp)
13511 (deadline org-deadline-time-regexp)
13512 (scheduled org-scheduled-time-regexp)
13513 (otherwise
13514 (error "Invalid planning type: %s" type)))
13515 (line-end-position) t)
13516 ;; Delete until next keyword or end of line.
13517 (delete-region
13518 (match-beginning 0)
13519 (if (re-search-forward org-keyword-time-not-clock-regexp
13520 (line-end-position)
13522 (match-beginning 0)
13523 (line-end-position))))))
13524 ;; If there is nothing more to add and no more keyword
13525 ;; is left, remove the line completely.
13526 (if (and (org-looking-at-p "[ \t]*$") (not what))
13527 (delete-region (line-beginning-position)
13528 (line-beginning-position 2))
13529 ;; If we removed last keyword, do not leave trailing
13530 ;; white space at the end of line.
13531 (let ((p (point)))
13532 (save-excursion
13533 (end-of-line)
13534 (unless (= (skip-chars-backward " \t" p) 0)
13535 (delete-region (point) (line-end-position)))))))
13536 ((not what) (throw 'exit nil)) ; Nothing to do.
13537 (t (insert-before-markers "\n")
13538 (backward-char 1)
13539 (when org-adapt-indentation
13540 (org-indent-to-column (1+ (org-outline-level))))))
13541 (when what
13542 ;; Insert planning keyword.
13543 (insert (case what
13544 (closed org-closed-string)
13545 (deadline org-deadline-string)
13546 (scheduled org-scheduled-string)
13547 (otherwise (error "Invalid planning type: %s" what)))
13548 " ")
13549 ;; Insert associated timestamp.
13550 (let ((ts (org-insert-time-stamp
13551 time
13552 (or org-time-was-given
13553 (and (eq what 'closed) org-log-done-with-time))
13554 (eq what 'closed)
13555 nil nil (list org-end-time-was-given))))
13556 (unless (eolp) (insert " "))
13557 ts))))))
13559 (defvar org-log-note-marker (make-marker))
13560 (defvar org-log-note-purpose nil)
13561 (defvar org-log-note-state nil)
13562 (defvar org-log-note-previous-state nil)
13563 (defvar org-log-note-extra nil)
13564 (defvar org-log-note-window-configuration nil)
13565 (defvar org-log-note-return-to (make-marker))
13566 (defvar org-log-note-effective-time nil
13567 "Remembered current time so that dynamically scoped
13568 `org-extend-today-until' affects tha timestamps in state change
13569 log")
13571 (defvar org-log-post-message nil
13572 "Message to be displayed after a log note has been stored.
13573 The auto-repeater uses this.")
13575 (defun org-add-note ()
13576 "Add a note to the current entry.
13577 This is done in the same way as adding a state change note."
13578 (interactive)
13579 (org-add-log-setup 'note nil nil 'findpos nil))
13581 (defun org-log-beginning (&optional create)
13582 "Return expected start of log notes in current entry.
13583 When optional argument CREATE is non-nil, the function creates
13584 a drawer to store notes, if necessary. Returned position ignores
13585 narrowing."
13586 (org-with-wide-buffer
13587 (org-end-of-meta-data)
13588 (let ((end (if (org-at-heading-p) (point)
13589 (save-excursion (outline-next-heading) (point))))
13590 (drawer (org-log-into-drawer)))
13591 (cond
13592 (drawer
13593 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13594 (case-fold-search t))
13595 (catch 'exit
13596 ;; Try to find existing drawer.
13597 (while (re-search-forward regexp end t)
13598 (let ((element (org-element-at-point)))
13599 (when (eq (org-element-type element) 'drawer)
13600 (let ((cend (org-element-property :contents-end element)))
13601 (when (and (not org-log-states-order-reversed) cend)
13602 (goto-char cend)))
13603 (throw 'exit nil))))
13604 ;; No drawer found. Create one, if permitted.
13605 (when create
13606 (unless (bolp) (insert "\n"))
13607 (let ((beg (point)))
13608 (insert ":" drawer ":\n:END:\n")
13609 (org-indent-region beg (point)))
13610 (end-of-line -1)))))
13611 (org-log-state-notes-insert-after-drawers
13612 (while (and (looking-at org-drawer-regexp)
13613 (progn (goto-char (match-end 0))
13614 (re-search-forward org-property-end-re end t)))
13615 (forward-line)))))
13616 (if (bolp) (point) (line-beginning-position 2))))
13618 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13619 "Set up the post command hook to take a note.
13620 If this is about to TODO state change, the new state is expected in STATE.
13621 When FINDPOS is non-nil, find the correct position for the note in
13622 the current entry. If not, assume that it can be inserted at point.
13623 HOW is an indicator what kind of note should be created.
13624 EXTRA is additional text that will be inserted into the notes buffer."
13625 (org-with-wide-buffer
13626 (when findpos
13627 (goto-char (org-log-beginning t))
13628 (unless org-log-states-order-reversed
13629 (org-skip-over-state-notes)
13630 (skip-chars-backward " \t\n\r")
13631 (forward-line)))
13632 (move-marker org-log-note-marker (point))
13633 ;; Preserve position even if a property drawer is inserted in the
13634 ;; process.
13635 (set-marker-insertion-type org-log-note-marker t)
13636 (setq org-log-note-purpose purpose
13637 org-log-note-state state
13638 org-log-note-previous-state prev-state
13639 org-log-note-how how
13640 org-log-note-extra extra
13641 org-log-note-effective-time (org-current-effective-time))
13642 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13644 (defun org-skip-over-state-notes ()
13645 "Skip past the list of State notes in an entry."
13646 (when (ignore-errors (goto-char (org-in-item-p)))
13647 (let* ((struct (org-list-struct))
13648 (prevs (org-list-prevs-alist struct))
13649 (regexp
13650 (concat "[ \t]*- +"
13651 (replace-regexp-in-string
13652 " +" " +"
13653 (org-replace-escapes
13654 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13655 `(("%d" . ,org-ts-regexp-inactive)
13656 ("%D" . ,org-ts-regexp)
13657 ("%s" . "\"\\S-+\"")
13658 ("%S" . "\"\\S-+\"")
13659 ("%t" . ,org-ts-regexp-inactive)
13660 ("%T" . ,org-ts-regexp)
13661 ("%u" . ".*?")
13662 ("%U" . ".*?")))))))
13663 (while (org-looking-at-p regexp)
13664 (goto-char (or (org-list-get-next-item (point) struct prevs)
13665 (org-list-get-item-end (point) struct)))))))
13667 (defun org-add-log-note (&optional purpose)
13668 "Pop up a window for taking a note, and add this note later at point."
13669 (remove-hook 'post-command-hook 'org-add-log-note)
13670 (setq org-log-note-window-configuration (current-window-configuration))
13671 (delete-other-windows)
13672 (move-marker org-log-note-return-to (point))
13673 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13674 (goto-char org-log-note-marker)
13675 (org-switch-to-buffer-other-window "*Org Note*")
13676 (erase-buffer)
13677 (if (memq org-log-note-how '(time state))
13678 (let (current-prefix-arg) (org-store-log-note))
13679 (let ((org-inhibit-startup t)) (org-mode))
13680 (insert (format "# Insert note for %s.
13681 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13682 (cond
13683 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13684 ((eq org-log-note-purpose 'done) "closed todo item")
13685 ((eq org-log-note-purpose 'state)
13686 (format "state change from \"%s\" to \"%s\""
13687 (or org-log-note-previous-state "")
13688 (or org-log-note-state "")))
13689 ((eq org-log-note-purpose 'reschedule)
13690 "rescheduling")
13691 ((eq org-log-note-purpose 'delschedule)
13692 "no longer scheduled")
13693 ((eq org-log-note-purpose 'redeadline)
13694 "changing deadline")
13695 ((eq org-log-note-purpose 'deldeadline)
13696 "removing deadline")
13697 ((eq org-log-note-purpose 'refile)
13698 "refiling")
13699 ((eq org-log-note-purpose 'note)
13700 "this entry")
13701 (t (error "This should not happen")))))
13702 (when org-log-note-extra (insert org-log-note-extra))
13703 (setq-local org-finish-function 'org-store-log-note)
13704 (run-hooks 'org-log-buffer-setup-hook)))
13706 (defvar org-note-abort nil) ; dynamically scoped
13707 (defun org-store-log-note ()
13708 "Finish taking a log note, and insert it to where it belongs."
13709 (let ((txt (buffer-string)))
13710 (kill-buffer (current-buffer))
13711 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13712 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13713 (setq txt (replace-match "" t t txt)))
13714 (when (string-match "\\s-+\\'" txt)
13715 (setq txt (replace-match "" t t txt)))
13716 (setq lines (org-split-string txt "\n"))
13717 (when (and note (string-match "\\S-" note))
13718 (setq note
13719 (org-replace-escapes
13720 note
13721 (list (cons "%u" (user-login-name))
13722 (cons "%U" user-full-name)
13723 (cons "%t" (format-time-string
13724 (org-time-stamp-format 'long 'inactive)
13725 org-log-note-effective-time))
13726 (cons "%T" (format-time-string
13727 (org-time-stamp-format 'long nil)
13728 org-log-note-effective-time))
13729 (cons "%d" (format-time-string
13730 (org-time-stamp-format nil 'inactive)
13731 org-log-note-effective-time))
13732 (cons "%D" (format-time-string
13733 (org-time-stamp-format nil nil)
13734 org-log-note-effective-time))
13735 (cons "%s" (cond
13736 ((not org-log-note-state) "")
13737 ((org-string-match-p org-ts-regexp
13738 org-log-note-state)
13739 (format "\"[%s]\""
13740 (substring org-log-note-state 1 -1)))
13741 (t (format "\"%s\"" org-log-note-state))))
13742 (cons "%S"
13743 (cond
13744 ((not org-log-note-previous-state) "")
13745 ((org-string-match-p org-ts-regexp
13746 org-log-note-previous-state)
13747 (format "\"[%s]\""
13748 (substring
13749 org-log-note-previous-state 1 -1)))
13750 (t (format "\"%s\""
13751 org-log-note-previous-state)))))))
13752 (when lines (setq note (concat note " \\\\")))
13753 (push note lines))
13754 (when (or current-prefix-arg org-note-abort)
13755 (when (org-log-into-drawer)
13756 (org-remove-empty-drawer-at org-log-note-marker))
13757 (setq lines nil))
13758 (when lines
13759 (with-current-buffer (marker-buffer org-log-note-marker)
13760 (org-with-wide-buffer
13761 (goto-char org-log-note-marker)
13762 (move-marker org-log-note-marker nil)
13763 ;; Make sure point is at the beginning of an empty line.
13764 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13765 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13766 ;; In an existing list, add a new item at the top level.
13767 ;; Otherwise, indent line like a regular one.
13768 (let ((itemp (org-in-item-p)))
13769 (if itemp
13770 (org-indent-line-to
13771 (let ((struct (save-excursion
13772 (goto-char itemp) (org-list-struct))))
13773 (org-list-get-ind (org-list-get-top-point struct) struct)))
13774 (org-indent-line)))
13775 (insert (org-list-bullet-string "-") (pop lines))
13776 (let ((ind (org-list-item-body-column (line-beginning-position))))
13777 (dolist (line lines)
13778 (insert "\n")
13779 (org-indent-line-to ind)
13780 (insert line)))
13781 (message "Note stored")
13782 (org-back-to-heading t)
13783 (org-cycle-hide-drawers 'children))
13784 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13785 ;; from within `org-add-log-note' because `buffer-undo-list'
13786 ;; is then modified outside of `org-with-remote-undo'.
13787 (when (eq this-command 'org-agenda-todo)
13788 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13789 ;; Don't add undo information when called from `org-agenda-todo'
13790 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13791 (set-window-configuration org-log-note-window-configuration)
13792 (with-current-buffer (marker-buffer org-log-note-return-to)
13793 (goto-char org-log-note-return-to))
13794 (move-marker org-log-note-return-to nil)
13795 (and org-log-post-message (message "%s" org-log-post-message))))
13797 (defun org-remove-empty-drawer-at (pos)
13798 "Remove an empty drawer at position POS.
13799 POS may also be a marker."
13800 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13801 (org-with-wide-buffer
13802 (goto-char pos)
13803 (let ((drawer (org-element-at-point)))
13804 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13805 (not (org-element-property :contents-begin drawer)))
13806 (delete-region (org-element-property :begin drawer)
13807 (progn (goto-char (org-element-property :end drawer))
13808 (skip-chars-backward " \r\t\n")
13809 (forward-line)
13810 (point))))))))
13812 (defvar org-ts-type nil)
13813 (defun org-sparse-tree (&optional arg type)
13814 "Create a sparse tree, prompt for the details.
13815 This command can create sparse trees. You first need to select the type
13816 of match used to create the tree:
13818 t Show all TODO entries.
13819 T Show entries with a specific TODO keyword.
13820 m Show entries selected by a tags/property match.
13821 p Enter a property name and its value (both with completion on existing
13822 names/values) and show entries with that property.
13823 r Show entries matching a regular expression (`/' can be used as well).
13824 b Show deadlines and scheduled items before a date.
13825 a Show deadlines and scheduled items after a date.
13826 d Show deadlines due within `org-deadline-warning-days'.
13827 D Show deadlines and scheduled items between a date range."
13828 (interactive "P")
13829 (setq type (or type org-sparse-tree-default-date-type))
13830 (setq org-ts-type type)
13831 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13832 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13833 [c]ycle through date types: %s"
13834 (case type
13835 (all "all timestamps")
13836 (scheduled "only scheduled")
13837 (deadline "only deadline")
13838 (active "only active timestamps")
13839 (inactive "only inactive timestamps")
13840 (closed "with a closed time-stamp")
13841 (otherwise "scheduled/deadline")))
13842 (let ((answer (read-char-exclusive)))
13843 (case answer
13845 (org-sparse-tree
13847 (cadr
13848 (memq type '(nil all scheduled deadline active inactive closed)))))
13849 (?d (call-interactively 'org-check-deadlines))
13850 (?b (call-interactively 'org-check-before-date))
13851 (?a (call-interactively 'org-check-after-date))
13852 (?D (call-interactively 'org-check-dates-range))
13853 (?t (call-interactively 'org-show-todo-tree))
13854 (?T (org-show-todo-tree '(4)))
13855 (?m (call-interactively 'org-match-sparse-tree))
13856 ((?p ?P)
13857 (let* ((kwd (org-icompleting-read
13858 "Property: " (mapcar 'list (org-buffer-property-keys))))
13859 (value (org-icompleting-read
13860 "Value: " (mapcar 'list (org-property-values kwd)))))
13861 (unless (string-match "\\`{.*}\\'" value)
13862 (setq value (concat "\"" value "\"")))
13863 (org-match-sparse-tree arg (concat kwd "=" value))))
13864 ((?r ?R ?/) (call-interactively 'org-occur))
13865 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13867 (defvar-local org-occur-highlights nil
13868 "List of overlays used for occur matches.")
13869 (defvar-local org-occur-parameters nil
13870 "Parameters of the active org-occur calls.
13871 This is a list, each call to org-occur pushes as cons cell,
13872 containing the regular expression and the callback, onto the list.
13873 The list can contain several entries if `org-occur' has been called
13874 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13875 will only contain one set of parameters. When the highlights are
13876 removed (for example with `C-c C-c', or with the next edit (depending
13877 on `org-remove-highlights-with-change'), this variable is emptied
13878 as well.")
13880 (defun org-occur (regexp &optional keep-previous callback)
13881 "Make a compact tree which shows all matches of REGEXP.
13882 The tree will show the lines where the regexp matches, and all higher
13883 headlines above the match. It will also show the heading after the match,
13884 to make sure editing the matching entry is easy.
13885 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13886 call to `org-occur' will be kept, to allow stacking of calls to this
13887 command.
13888 If CALLBACK is non-nil, it is a function which is called to confirm
13889 that the match should indeed be shown."
13890 (interactive "sRegexp: \nP")
13891 (when (equal regexp "")
13892 (user-error "Regexp cannot be empty"))
13893 (unless keep-previous
13894 (org-remove-occur-highlights nil nil t))
13895 (push (cons regexp callback) org-occur-parameters)
13896 (let ((cnt 0))
13897 (save-excursion
13898 (goto-char (point-min))
13899 (when (or (not keep-previous) ; do not want to keep
13900 (not org-occur-highlights)) ; no previous matches
13901 ;; hide everything
13902 (org-overview))
13903 (while (re-search-forward regexp nil t)
13904 (backward-char) ;; FIXME: Match timestamps at the end of a headline
13905 (when (or (not callback)
13906 (save-match-data (funcall callback)))
13907 (setq cnt (1+ cnt))
13908 (when org-highlight-sparse-tree-matches
13909 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13910 (org-show-context 'occur-tree))))
13911 (when org-remove-highlights-with-change
13912 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13913 nil 'local))
13914 (unless org-sparse-tree-open-archived-trees
13915 (org-hide-archived-subtrees (point-min) (point-max)))
13916 (run-hooks 'org-occur-hook)
13917 (when (org-called-interactively-p 'interactive)
13918 (message "%d match(es) for regexp %s" cnt regexp))
13919 cnt))
13921 (defun org-occur-next-match (&optional n reset)
13922 "Function for `next-error-function' to find sparse tree matches.
13923 N is the number of matches to move, when negative move backwards.
13924 RESET is entirely ignored - this function always goes back to the
13925 starting point when no match is found."
13926 (let* ((limit (if (< n 0) (point-min) (point-max)))
13927 (search-func (if (< n 0)
13928 'previous-single-char-property-change
13929 'next-single-char-property-change))
13930 (n (abs n))
13931 (pos (point))
13933 (catch 'exit
13934 (while (setq p1 (funcall search-func (point) 'org-type))
13935 (when (equal p1 limit)
13936 (goto-char pos)
13937 (user-error "No more matches"))
13938 (when (equal (get-char-property p1 'org-type) 'org-occur)
13939 (setq n (1- n))
13940 (when (= n 0)
13941 (goto-char p1)
13942 (throw 'exit (point))))
13943 (goto-char p1))
13944 (goto-char p1)
13945 (user-error "No more matches"))))
13947 (defun org-show-context (&optional key)
13948 "Make sure point and context are visible.
13949 Optional argument KEY, when non-nil, is a symbol. See
13950 `org-show-context-detail' for allowed values and how much is to
13951 be shown."
13952 (org-show-set-visibility
13953 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13954 ((cdr (assq key org-show-context-detail)))
13955 (t (cdr (assq 'default org-show-context-detail))))))
13957 (defun org-show-set-visibility (detail)
13958 "Set visibility around point according to DETAIL.
13959 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13960 `tree', `canonical' or t. See `org-show-context-detail' for more
13961 information."
13962 (unless (org-before-first-heading-p)
13963 ;; Show current heading and possibly its entry, following headline
13964 ;; or all children.
13965 (if (and (org-at-heading-p) (not (eq detail 'local)))
13966 (org-flag-heading nil)
13967 (org-show-entry)
13968 (org-with-limited-levels
13969 (case detail
13970 ((tree canonical t) (org-show-children))
13971 ((nil minimal ancestors))
13972 (t (save-excursion
13973 (outline-next-heading)
13974 (org-flag-heading nil))))))
13975 ;; Show all siblings.
13976 (when (eq detail 'lineage) (org-show-siblings))
13977 ;; Show ancestors, possibly with their children.
13978 (when (memq detail '(ancestors lineage tree canonical t))
13979 (save-excursion
13980 (while (org-up-heading-safe)
13981 (org-flag-heading nil)
13982 (when (memq detail '(canonical t)) (org-show-entry))
13983 (when (memq detail '(tree canonical t)) (org-show-children)))))))
13985 (defvar org-reveal-start-hook nil
13986 "Hook run before revealing a location.")
13988 (defun org-reveal (&optional siblings)
13989 "Show current entry, hierarchy above it, and the following headline.
13991 This can be used to show a consistent set of context around
13992 locations exposed with `org-show-context'.
13994 With optional argument SIBLINGS, on each level of the hierarchy all
13995 siblings are shown. This repairs the tree structure to what it would
13996 look like when opened with hierarchical calls to `org-cycle'.
13998 With double optional argument \\[universal-argument] \\[universal-argument], \
13999 go to the parent and show the
14000 entire tree."
14001 (interactive "P")
14002 (run-hooks 'org-reveal-start-hook)
14003 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14004 ((equal siblings '(16))
14005 (save-excursion
14006 (when (org-up-heading-safe)
14007 (org-show-subtree)
14008 (run-hook-with-args 'org-cycle-hook 'subtree))))
14009 (t (org-show-set-visibility 'lineage))))
14011 (defun org-highlight-new-match (beg end)
14012 "Highlight from BEG to END and mark the highlight is an occur headline."
14013 (let ((ov (make-overlay beg end)))
14014 (overlay-put ov 'face 'secondary-selection)
14015 (overlay-put ov 'org-type 'org-occur)
14016 (push ov org-occur-highlights)))
14018 (defun org-remove-occur-highlights (&optional beg end noremove)
14019 "Remove the occur highlights from the buffer.
14020 BEG and END are ignored. If NOREMOVE is nil, remove this function
14021 from the `before-change-functions' in the current buffer."
14022 (interactive)
14023 (unless org-inhibit-highlight-removal
14024 (mapc 'delete-overlay org-occur-highlights)
14025 (setq org-occur-highlights nil)
14026 (setq org-occur-parameters nil)
14027 (unless noremove
14028 (remove-hook 'before-change-functions
14029 'org-remove-occur-highlights 'local))))
14031 ;;;; Priorities
14033 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14034 "Regular expression matching the priority indicator.")
14036 (defvar org-remove-priority-next-time nil)
14038 (defun org-priority-up ()
14039 "Increase the priority of the current item."
14040 (interactive)
14041 (org-priority 'up))
14043 (defun org-priority-down ()
14044 "Decrease the priority of the current item."
14045 (interactive)
14046 (org-priority 'down))
14048 (defun org-priority (&optional action show)
14049 "Change the priority of an item.
14050 ACTION can be `set', `up', `down', or a character."
14051 (interactive "P")
14052 (if (equal action '(4))
14053 (org-show-priority)
14054 (unless org-enable-priority-commands
14055 (user-error "Priority commands are disabled"))
14056 (setq action (or action 'set))
14057 (let (current new news have remove)
14058 (save-excursion
14059 (org-back-to-heading t)
14060 (when (looking-at org-priority-regexp)
14061 (setq current (string-to-char (match-string 2))
14062 have t))
14063 (cond
14064 ((eq action 'remove)
14065 (setq remove t new ?\ ))
14066 ((or (eq action 'set)
14067 (if (featurep 'xemacs) (characterp action) (integerp action)))
14068 (if (not (eq action 'set))
14069 (setq new action)
14070 (message "Priority %c-%c, SPC to remove: "
14071 org-highest-priority org-lowest-priority)
14072 (save-match-data
14073 (setq new (read-char-exclusive))))
14074 (when (and (= (upcase org-highest-priority) org-highest-priority)
14075 (= (upcase org-lowest-priority) org-lowest-priority))
14076 (setq new (upcase new)))
14077 (cond ((equal new ?\ ) (setq remove t))
14078 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14079 (user-error "Priority must be between `%c' and `%c'"
14080 org-highest-priority org-lowest-priority))))
14081 ((eq action 'up)
14082 (setq new (if have
14083 (1- current) ; normal cycling
14084 ;; last priority was empty
14085 (if (eq last-command this-command)
14086 org-lowest-priority ; wrap around empty to lowest
14087 ;; default
14088 (if org-priority-start-cycle-with-default
14089 org-default-priority
14090 (1- org-default-priority))))))
14091 ((eq action 'down)
14092 (setq new (if have
14093 (1+ current) ; normal cycling
14094 ;; last priority was empty
14095 (if (eq last-command this-command)
14096 org-highest-priority ; wrap around empty to highest
14097 ;; default
14098 (if org-priority-start-cycle-with-default
14099 org-default-priority
14100 (1+ org-default-priority))))))
14101 (t (user-error "Invalid action")))
14102 (when (or (< (upcase new) org-highest-priority)
14103 (> (upcase new) org-lowest-priority))
14104 (if (and (memq action '(up down))
14105 (not have) (not (eq last-command this-command)))
14106 ;; `new' is from default priority
14107 (error
14108 "The default can not be set, see `org-default-priority' why")
14109 ;; normal cycling: `new' is beyond highest/lowest priority
14110 ;; and is wrapped around to the empty priority
14111 (setq remove t)))
14112 (setq news (format "%c" new))
14113 (if have
14114 (if remove
14115 (replace-match "" t t nil 1)
14116 (replace-match news t t nil 2))
14117 (if remove
14118 (user-error "No priority cookie found in line")
14119 (let ((case-fold-search nil))
14120 (looking-at org-todo-line-regexp))
14121 (if (match-end 2)
14122 (progn
14123 (goto-char (match-end 2))
14124 (insert " [#" news "]"))
14125 (goto-char (match-beginning 3))
14126 (insert "[#" news "] "))))
14127 (org-set-tags nil 'align))
14128 (if remove
14129 (message "Priority removed")
14130 (message "Priority of current item set to %s" news)))))
14132 (defun org-show-priority ()
14133 "Show the priority of the current item.
14134 This priority is composed of the main priority given with the [#A] cookies,
14135 and by additional input from the age of a schedules or deadline entry."
14136 (interactive)
14137 (let ((pri (if (eq major-mode 'org-agenda-mode)
14138 (org-get-at-bol 'priority)
14139 (save-excursion
14140 (save-match-data
14141 (beginning-of-line)
14142 (and (looking-at org-heading-regexp)
14143 (org-get-priority (match-string 0))))))))
14144 (message "Priority is %d" (if pri pri -1000))))
14146 (defun org-get-priority (s)
14147 "Find priority cookie and return priority."
14148 (save-match-data
14149 (if (functionp org-get-priority-function)
14150 (funcall org-get-priority-function)
14151 (if (not (string-match org-priority-regexp s))
14152 (* 1000 (- org-lowest-priority org-default-priority))
14153 (* 1000 (- org-lowest-priority
14154 (string-to-char (match-string 2 s))))))))
14156 ;;;; Tags
14158 (defvar org-agenda-archives-mode)
14159 (defvar org-map-continue-from nil
14160 "Position from where mapping should continue.
14161 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14163 (defvar org-scanner-tags nil
14164 "The current tag list while the tags scanner is running.")
14165 (defvar org-trust-scanner-tags nil
14166 "Should `org-get-tags-at' use the tags for the scanner.
14167 This is for internal dynamical scoping only.
14168 When this is non-nil, the function `org-get-tags-at' will return the value
14169 of `org-scanner-tags' instead of building the list by itself. This
14170 can lead to large speed-ups when the tags scanner is used in a file with
14171 many entries, and when the list of tags is retrieved, for example to
14172 obtain a list of properties. Building the tags list for each entry in such
14173 a file becomes an N^2 operation - but with this variable set, it scales
14174 as N.")
14176 (defun org-scan-tags (action matcher todo-only &optional start-level)
14177 "Scan headline tags with inheritance and produce output ACTION.
14179 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14180 or `agenda' to produce an entry list for an agenda view. It can also be
14181 a Lisp form or a function that should be called at each matched headline, in
14182 this case the return value is a list of all return values from these calls.
14184 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14185 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14186 only lines with a not-done TODO keyword are included in the output.
14187 This should be the same variable that was scoped into
14188 and set by `org-make-tags-matcher' when it constructed MATCHER.
14190 START-LEVEL can be a string with asterisks, reducing the scope to
14191 headlines matching this string."
14192 (require 'org-agenda)
14193 (let* ((re (concat "^"
14194 (if start-level
14195 ;; Get the correct level to match
14196 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14197 org-outline-regexp)
14198 " *\\(\\<\\("
14199 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14200 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14201 (props (list 'face 'default
14202 'done-face 'org-agenda-done
14203 'undone-face 'default
14204 'mouse-face 'highlight
14205 'org-not-done-regexp org-not-done-regexp
14206 'org-todo-regexp org-todo-regexp
14207 'org-complex-heading-regexp org-complex-heading-regexp
14208 'help-echo
14209 (format "mouse-2 or RET jump to org file %s"
14210 (abbreviate-file-name
14211 (or (buffer-file-name (buffer-base-buffer))
14212 (buffer-name (buffer-base-buffer)))))))
14213 (org-map-continue-from nil)
14214 lspos tags tags-list
14215 (tags-alist (list (cons 0 org-file-tags)))
14216 (llast 0) rtn rtn1 level category i txt
14217 todo marker entry priority
14218 ts-date ts-date-type ts-date-pair)
14219 (unless (or (member action '(agenda sparse-tree)) (functionp action))
14220 (setq action (list 'lambda nil action)))
14221 (save-excursion
14222 (goto-char (point-min))
14223 (when (eq action 'sparse-tree)
14224 (org-overview)
14225 (org-remove-occur-highlights))
14226 (while (let (case-fold-search)
14227 (re-search-forward re nil t))
14228 (setq org-map-continue-from nil)
14229 (catch :skip
14230 (setq todo
14231 ;; TODO: is the 1-2 difference a bug?
14232 (when (match-end 1) (org-match-string-no-properties 2))
14233 tags (when (match-end 4) (org-match-string-no-properties 4)))
14234 (goto-char (setq lspos (match-beginning 0)))
14235 (setq level (org-reduced-level (org-outline-level))
14236 category (org-get-category))
14237 (when (eq action 'agenda)
14238 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14239 ts-date (car ts-date-pair)
14240 ts-date-type (cdr ts-date-pair)))
14241 (setq i llast llast level)
14242 ;; remove tag lists from same and sublevels
14243 (while (>= i level)
14244 (when (setq entry (assoc i tags-alist))
14245 (setq tags-alist (delete entry tags-alist)))
14246 (setq i (1- i)))
14247 ;; add the next tags
14248 (when tags
14249 (setq tags (org-split-string tags ":")
14250 tags-alist
14251 (cons (cons level tags) tags-alist)))
14252 ;; compile tags for current headline
14253 (setq tags-list
14254 (if org-use-tag-inheritance
14255 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14256 tags)
14257 org-scanner-tags tags-list)
14258 (when org-use-tag-inheritance
14259 (setcdr (car tags-alist)
14260 (mapcar (lambda (x)
14261 (setq x (copy-sequence x))
14262 (org-add-prop-inherited x))
14263 (cdar tags-alist))))
14264 (when (and tags org-use-tag-inheritance
14265 (or (not (eq t org-use-tag-inheritance))
14266 org-tags-exclude-from-inheritance))
14267 ;; selective inheritance, remove uninherited ones
14268 (setcdr (car tags-alist)
14269 (org-remove-uninherited-tags (cdar tags-alist))))
14270 (when (and
14272 ;; eval matcher only when the todo condition is OK
14273 (and (or (not todo-only) (member todo org-not-done-keywords))
14274 (let ((case-fold-search t) (org-trust-scanner-tags t))
14275 (eval matcher)))
14277 ;; Call the skipper, but return t if it does not skip,
14278 ;; so that the `and' form continues evaluating
14279 (progn
14280 (unless (eq action 'sparse-tree) (org-agenda-skip))
14283 ;; Check if timestamps are deselecting this entry
14284 (or (not todo-only)
14285 (and (member todo org-not-done-keywords)
14286 (or (not org-agenda-tags-todo-honor-ignore-options)
14287 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14289 ;; select this headline
14290 (cond
14291 ((eq action 'sparse-tree)
14292 (and org-highlight-sparse-tree-matches
14293 (org-get-heading) (match-end 0)
14294 (org-highlight-new-match
14295 (match-beginning 1) (match-end 1)))
14296 (org-show-context 'tags-tree))
14297 ((eq action 'agenda)
14298 (setq txt (org-agenda-format-item
14300 (concat
14301 (if (eq org-tags-match-list-sublevels 'indented)
14302 (make-string (1- level) ?.) "")
14303 (org-get-heading))
14304 (make-string level ?\s)
14305 category
14306 tags-list)
14307 priority (org-get-priority txt))
14308 (goto-char lspos)
14309 (setq marker (org-agenda-new-marker))
14310 (org-add-props txt props
14311 'org-marker marker 'org-hd-marker marker 'org-category category
14312 'todo-state todo
14313 'ts-date ts-date
14314 'priority priority
14315 'type (concat "tagsmatch" ts-date-type))
14316 (push txt rtn))
14317 ((functionp action)
14318 (setq org-map-continue-from nil)
14319 (save-excursion
14320 (setq rtn1 (funcall action))
14321 (push rtn1 rtn)))
14322 (t (user-error "Invalid action")))
14324 ;; if we are to skip sublevels, jump to end of subtree
14325 (unless org-tags-match-list-sublevels
14326 (org-end-of-subtree t)
14327 (backward-char 1))))
14328 ;; Get the correct position from where to continue
14329 (if org-map-continue-from
14330 (goto-char org-map-continue-from)
14331 (and (= (point) lspos) (end-of-line 1)))))
14332 (when (and (eq action 'sparse-tree)
14333 (not org-sparse-tree-open-archived-trees))
14334 (org-hide-archived-subtrees (point-min) (point-max)))
14335 (nreverse rtn)))
14337 (defun org-remove-uninherited-tags (tags)
14338 "Remove all tags that are not inherited from the list TAGS."
14339 (cond
14340 ((eq org-use-tag-inheritance t)
14341 (if org-tags-exclude-from-inheritance
14342 (org-delete-all org-tags-exclude-from-inheritance tags)
14343 tags))
14344 ((not org-use-tag-inheritance) nil)
14345 ((stringp org-use-tag-inheritance)
14346 (delq nil (mapcar
14347 (lambda (x)
14348 (if (and (string-match org-use-tag-inheritance x)
14349 (not (member x org-tags-exclude-from-inheritance)))
14350 x nil))
14351 tags)))
14352 ((listp org-use-tag-inheritance)
14353 (delq nil (mapcar
14354 (lambda (x)
14355 (if (member x org-use-tag-inheritance) x nil))
14356 tags)))))
14358 (defun org-match-sparse-tree (&optional todo-only match)
14359 "Create a sparse tree according to tags string MATCH.
14360 MATCH can contain positive and negative selection of tags, like
14361 \"+WORK+URGENT-WITHBOSS\".
14362 If optional argument TODO-ONLY is non-nil, only select lines that are
14363 also TODO lines."
14364 (interactive "P")
14365 (org-agenda-prepare-buffers (list (current-buffer)))
14366 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14368 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14370 (defvar org-cached-props nil)
14371 (defun org-cached-entry-get (pom property)
14372 (if (or (eq t org-use-property-inheritance)
14373 (and (stringp org-use-property-inheritance)
14374 (let ((case-fold-search t))
14375 (org-string-match-p org-use-property-inheritance property)))
14376 (and (listp org-use-property-inheritance)
14377 (member-ignore-case property org-use-property-inheritance)))
14378 ;; Caching is not possible, check it directly.
14379 (org-entry-get pom property 'inherit)
14380 ;; Get all properties, so we can do complicated checks easily.
14381 (cdr (assoc-string property
14382 (or org-cached-props
14383 (setq org-cached-props (org-entry-properties pom)))
14384 t))))
14386 (defun org-global-tags-completion-table (&optional files)
14387 "Return the list of all tags in all agenda buffer/files.
14388 Optional FILES argument is a list of files which can be used
14389 instead of the agenda files."
14390 (save-excursion
14391 (org-uniquify
14392 (delq nil
14393 (apply 'append
14394 (mapcar
14395 (lambda (file)
14396 (set-buffer (find-file-noselect file))
14397 (append (org-get-buffer-tags)
14398 (mapcar (lambda (x) (if (stringp (car-safe x))
14399 (list (car-safe x)) nil))
14400 org-tag-alist)))
14401 (if (and files (car files))
14402 files
14403 (org-agenda-files))))))))
14405 (defun org-make-tags-matcher (match)
14406 "Create the TAGS/TODO matcher form for the selection string MATCH.
14408 The variable `todo-only' is scoped dynamically into this function.
14409 It will be set to t if the matcher restricts matching to TODO entries,
14410 otherwise will not be touched.
14412 Returns a cons of the selection string MATCH and the constructed
14413 lisp form implementing the matcher. The matcher is to be evaluated
14414 at an Org entry, with point on the headline, and returns t if the
14415 entry matches the selection string MATCH. The returned lisp form
14416 references two variables with information about the entry, which
14417 must be bound around the form's evaluation: todo, the TODO keyword
14418 at the entry (or nil of none); and tags-list, the list of all tags
14419 at the entry including inherited ones. Additionally, the category
14420 of the entry (if any) must be specified as the text property
14421 `org-category' on the headline.
14423 See also `org-scan-tags'.
14425 (declare (special todo-only))
14426 (unless (boundp 'todo-only)
14427 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14428 (unless match
14429 ;; Get a new match request, with completion against the global
14430 ;; tags table and the local tags in current buffer
14431 (let ((org-last-tags-completion-table
14432 (org-uniquify
14433 (delq nil (append (org-get-buffer-tags)
14434 (org-global-tags-completion-table))))))
14435 (setq match (org-completing-read-no-i
14436 "Match: " 'org-tags-completion-function nil nil nil
14437 'org-tags-history))))
14439 ;; Parse the string and create a lisp form
14440 (let ((match0 match)
14441 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14442 minus tag mm
14443 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14444 orterms term orlist re-p str-p level-p level-op time-p
14445 prop-p pn pv po gv rest (start 0) (ss 0))
14446 ;; Expand group tags
14447 (setq match (org-tags-expand match))
14449 ;; Check if there is a TODO part of this match, which would be the
14450 ;; part after a "/". TO make sure that this slash is not part of
14451 ;; a property value to be matched against, we also check that there
14452 ;; is no " after that slash.
14453 ;; First, find the last slash
14454 (while (string-match "/+" match ss)
14455 (setq start (match-beginning 0) ss (match-end 0)))
14456 (if (and (string-match "/+" match start)
14457 (not (save-match-data (string-match "\"" match start))))
14458 ;; match contains also a todo-matching request
14459 (progn
14460 (setq tagsmatch (substring match 0 (match-beginning 0))
14461 todomatch (substring match (match-end 0)))
14462 (when (string-match "^!" todomatch)
14463 (setq todo-only t todomatch (substring todomatch 1)))
14464 (when (string-match "^\\s-*$" todomatch)
14465 (setq todomatch nil)))
14466 ;; only matching tags
14467 (setq tagsmatch match todomatch nil))
14469 ;; Make the tags matcher
14470 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14471 (setq tagsmatcher t)
14472 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14473 (while (setq term (pop orterms))
14474 (while (and (equal (substring term -1) "\\") orterms)
14475 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14476 (while (string-match re term)
14477 (setq rest (substring term (match-end 0))
14478 minus (and (match-end 1)
14479 (equal (match-string 1 term) "-"))
14480 tag (save-match-data (replace-regexp-in-string
14481 "\\\\-" "-"
14482 (match-string 2 term)))
14483 re-p (equal (string-to-char tag) ?{)
14484 level-p (match-end 4)
14485 prop-p (match-end 5)
14486 mm (cond
14487 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14488 (level-p
14489 (setq level-op (org-op-to-function (match-string 3 term)))
14490 `(,level-op level ,(string-to-number
14491 (match-string 4 term))))
14492 (prop-p
14493 (setq pn (match-string 5 term)
14494 po (match-string 6 term)
14495 pv (match-string 7 term)
14496 re-p (equal (string-to-char pv) ?{)
14497 str-p (equal (string-to-char pv) ?\")
14498 time-p (save-match-data
14499 (string-match "^\"[[<].*[]>]\"$" pv))
14500 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14501 (when time-p (setq pv (org-matcher-time pv)))
14502 (setq po (org-op-to-function po (if time-p 'time str-p)))
14503 (cond
14504 ((equal pn "CATEGORY")
14505 (setq gv '(get-text-property (point) 'org-category)))
14506 ((equal pn "TODO")
14507 (setq gv 'todo))
14509 (setq gv `(org-cached-entry-get nil ,pn))))
14510 (if re-p
14511 (if (eq po 'org<>)
14512 `(not (string-match ,pv (or ,gv "")))
14513 `(string-match ,pv (or ,gv "")))
14514 (if str-p
14515 `(,po (or ,gv "") ,pv)
14516 `(,po (string-to-number (or ,gv ""))
14517 ,(string-to-number pv) ))))
14518 (t `(member ,tag tags-list)))
14519 mm (if minus (list 'not mm) mm)
14520 term rest)
14521 (push mm tagsmatcher))
14522 (push (if (> (length tagsmatcher) 1)
14523 (cons 'and tagsmatcher)
14524 (car tagsmatcher))
14525 orlist)
14526 (setq tagsmatcher nil))
14527 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14528 (setq tagsmatcher
14529 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14530 ;; Make the todo matcher
14531 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14532 (setq todomatcher t)
14533 (setq orterms (org-split-string todomatch "|") orlist nil)
14534 (dolist (term orterms)
14535 (while (string-match re term)
14536 (setq minus (and (match-end 1)
14537 (equal (match-string 1 term) "-"))
14538 kwd (match-string 2 term)
14539 re-p (equal (string-to-char kwd) ?{)
14540 term (substring term (match-end 0))
14541 mm (if re-p
14542 `(string-match ,(substring kwd 1 -1) todo)
14543 (list 'equal 'todo kwd))
14544 mm (if minus (list 'not mm) mm))
14545 (push mm todomatcher))
14546 (push (if (> (length todomatcher) 1)
14547 (cons 'and todomatcher)
14548 (car todomatcher))
14549 orlist)
14550 (setq todomatcher nil))
14551 (setq todomatcher (if (> (length orlist) 1)
14552 (cons 'or orlist) (car orlist))))
14554 ;; Return the string and lisp forms of the matcher
14555 (setq matcher (if todomatcher
14556 (list 'and tagsmatcher todomatcher)
14557 tagsmatcher))
14558 (when todo-only
14559 (setq matcher (list 'and '(member todo org-not-done-keywords)
14560 matcher)))
14561 (cons match0 matcher)))
14563 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14564 "Expand group tags in MATCH.
14566 This replaces every group tag in MATCH with a regexp tag search.
14567 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14568 will be replaced like this:
14570 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14571 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14572 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14574 Replacing by a regexp preserves the structure of the match.
14575 E.g., this expansion
14577 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14579 will match anything tagged with \"Lab\" and \"Home\", or tagged
14580 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14582 A group tag in MATCH can contain regular expressions of its own.
14583 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14584 will be replaced like this:
14586 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14588 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14589 assumed to be a single group tag, and the function will return
14590 the list of tags in this group.
14592 When DOWNCASE is non-nil, expand downcased TAGS."
14593 (if org-group-tags
14594 (let* ((case-fold-search t)
14595 (stable org-mode-syntax-table)
14596 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14597 (taggroups (if downcased
14598 (mapcar (lambda (tg) (mapcar #'downcase tg))
14599 taggroups)
14600 taggroups))
14601 (taggroups-keys (mapcar #'car taggroups))
14602 (return-match (if downcased (downcase match) match))
14603 (count 0)
14604 (work-already-expanded tags-already-expanded)
14605 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14606 ;; @ and _ are allowed as word-components in tags.
14607 (modify-syntax-entry ?@ "w" stable)
14608 (modify-syntax-entry ?_ "w" stable)
14609 ;; Temporarily replace regexp-expressions in the match-expression.
14610 (while (string-match "{.+?}" return-match)
14611 (incf count)
14612 (push (match-string 0 return-match) regexps-in-match)
14613 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14614 (while (and taggroups-keys
14615 (with-syntax-table stable
14616 (string-match
14617 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14618 (regexp-opt taggroups-keys) "\\>\\)")
14619 return-match)))
14620 (let* ((dir (match-string 1 return-match))
14621 (tag (match-string 2 return-match))
14622 (tag (if downcased (downcase tag) tag)))
14623 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14624 (member tag work-already-expanded))
14625 (setq tags-in-group (assoc tag taggroups))
14626 (push tag work-already-expanded)
14627 ;; Recursively expand each tag in the group, if the tag hasn't
14628 ;; already been expanded. Restore the match-data after all recursive calls.
14629 (save-match-data
14630 (let (tags-expanded)
14631 (dolist (x (cdr tags-in-group))
14632 (if (and (member x taggroups-keys)
14633 (not (member x work-already-expanded)))
14634 (setq tags-expanded
14635 (delete-dups
14636 (append
14637 (org-tags-expand x t downcased
14638 work-already-expanded)
14639 tags-expanded)))
14640 (setq tags-expanded
14641 (append (list x) tags-expanded)))
14642 (setq work-already-expanded
14643 (delete-dups
14644 (append tags-expanded
14645 work-already-expanded))))
14646 (setq tags-in-group
14647 (delete-dups (cons (car tags-in-group)
14648 tags-expanded)))))
14649 ;; Filter tag-regexps from tags.
14650 (setq regexp-in-group-escaped
14651 (delq nil (mapcar (lambda (x)
14652 (if (stringp x)
14653 (and (equal "{" (substring x 0 1))
14654 (equal "}" (substring x -1))
14657 tags-in-group))
14658 regexp-in-group
14659 (mapcar (lambda (x)
14660 (substring x 1 -1))
14661 regexp-in-group-escaped)
14662 tags-in-group
14663 (delq nil (mapcar (lambda (x)
14664 (if (stringp x)
14665 (and (not (equal "{" (substring x 0 1)))
14666 (not (equal "}" (substring x -1)))
14669 tags-in-group)))
14670 ;; If single-as-list, do no more in the while-loop.
14671 (if (not single-as-list)
14672 (progn
14673 (when regexp-in-group
14674 (setq regexp-in-group
14675 (concat "\\|"
14676 (mapconcat 'identity regexp-in-group
14677 "\\|"))))
14678 (setq tags-in-group
14679 (concat dir
14680 "{\\<"
14681 (regexp-opt tags-in-group)
14682 "\\>"
14683 regexp-in-group
14684 "}"))
14685 (when (stringp tags-in-group)
14686 (org-add-props tags-in-group '(grouptag t)))
14687 (setq return-match
14688 (replace-match tags-in-group t t return-match)))
14689 (setq tags-in-group
14690 (append regexp-in-group-escaped tags-in-group))))
14691 (setq taggroups-keys (delete tag taggroups-keys))))
14692 ;; Add the regular expressions back into the match-expression again.
14693 (while regexps-in-match
14694 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14695 (pop regexps-in-match)
14696 return-match t t))
14697 (decf count))
14698 (if single-as-list
14699 (if tags-in-group tags-in-group (list return-match))
14700 return-match))
14701 (if single-as-list
14702 (list (if downcased (downcase match) match))
14703 match)))
14705 (defun org-op-to-function (op &optional stringp)
14706 "Turn an operator into the appropriate function."
14707 (setq op
14708 (cond
14709 ((equal op "<" ) '(< string< org-time<))
14710 ((equal op ">" ) '(> org-string> org-time>))
14711 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14712 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14713 ((member op '("=" "==")) '(= string= org-time=))
14714 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14715 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14717 (defun org<> (a b) (not (= a b)))
14718 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14719 (defun org-string>= (a b) (not (string< a b)))
14720 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14721 (defun org-string<> (a b) (not (string= a b)))
14722 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14723 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14724 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14725 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14726 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14727 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14728 (defun org-2ft (s)
14729 "Convert S to a floating point time.
14730 If S is already a number, just return it. If it is a string, parse
14731 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14732 (cond
14733 ((numberp s) s)
14734 ((stringp s)
14735 (condition-case nil
14736 (float-time (apply 'encode-time (org-parse-time-string s)))
14737 (error 0.)))
14738 (t 0.)))
14740 (defun org-time-today ()
14741 "Time in seconds today at 0:00.
14742 Returns the float number of seconds since the beginning of the
14743 epoch to the beginning of today (00:00)."
14744 (float-time (apply 'encode-time
14745 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14747 (defun org-matcher-time (s)
14748 "Interpret a time comparison value."
14749 (save-match-data
14750 (cond
14751 ((string= s "<now>") (float-time))
14752 ((string= s "<today>") (org-time-today))
14753 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14754 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14755 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14756 (+ (org-time-today)
14757 (* (string-to-number (match-string 1 s))
14758 (cdr (assoc (match-string 2 s)
14759 '(("d" . 86400.0) ("w" . 604800.0)
14760 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14761 (t (org-2ft s)))))
14763 (defun org-match-any-p (re list)
14764 "Does re match any element of list?"
14765 (setq list (mapcar (lambda (x) (string-match re x)) list))
14766 (delq nil list))
14768 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14769 (defvar org-tags-overlay (make-overlay 1 1))
14770 (org-detach-overlay org-tags-overlay)
14772 (defun org-get-local-tags-at (&optional pos)
14773 "Get a list of tags defined in the current headline."
14774 (org-get-tags-at pos 'local))
14776 (defun org-get-local-tags ()
14777 "Get a list of tags defined in the current headline."
14778 (org-get-tags-at nil 'local))
14780 (defun org-get-tags-at (&optional pos local)
14781 "Get a list of all headline tags applicable at POS.
14782 POS defaults to point. If tags are inherited, the list contains
14783 the targets in the same sequence as the headlines appear, i.e.
14784 the tags of the current headline come last.
14785 When LOCAL is non-nil, only return tags from the current headline,
14786 ignore inherited ones."
14787 (interactive)
14788 (if (and org-trust-scanner-tags
14789 (or (not pos) (equal pos (point)))
14790 (not local))
14791 org-scanner-tags
14792 (let (tags ltags lastpos parent)
14793 (save-excursion
14794 (save-restriction
14795 (widen)
14796 (goto-char (or pos (point)))
14797 (save-match-data
14798 (catch 'done
14799 (condition-case nil
14800 (progn
14801 (org-back-to-heading t)
14802 (while (not (equal lastpos (point)))
14803 (setq lastpos (point))
14804 (when (looking-at
14805 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14806 (setq ltags (org-split-string
14807 (org-match-string-no-properties 1) ":"))
14808 (when parent
14809 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14810 (setq tags (append
14811 (if parent
14812 (org-remove-uninherited-tags ltags)
14813 ltags)
14814 tags)))
14815 (or org-use-tag-inheritance (throw 'done t))
14816 (when local (throw 'done t))
14817 (or (org-up-heading-safe) (error nil))
14818 (setq parent t)))
14819 (error nil)))))
14820 (if local
14821 tags
14822 (reverse (delete-dups
14823 (reverse (append
14824 (org-remove-uninherited-tags
14825 org-file-tags)
14826 tags)))))))))
14828 (defun org-add-prop-inherited (s)
14829 (add-text-properties 0 (length s) '(inherited t) s)
14832 (defun org-toggle-tag (tag &optional onoff)
14833 "Toggle the tag TAG for the current line.
14834 If ONOFF is `on' or `off', don't toggle but set to this state."
14835 (let (res current)
14836 (save-excursion
14837 (org-back-to-heading t)
14838 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14839 (point-at-eol) t)
14840 (progn
14841 (setq current (match-string 1))
14842 (replace-match ""))
14843 (setq current ""))
14844 (setq current (nreverse (org-split-string current ":")))
14845 (cond
14846 ((eq onoff 'on)
14847 (setq res t)
14848 (or (member tag current) (push tag current)))
14849 ((eq onoff 'off)
14850 (or (not (member tag current)) (setq current (delete tag current))))
14851 (t (if (member tag current)
14852 (setq current (delete tag current))
14853 (setq res t)
14854 (push tag current))))
14855 (end-of-line 1)
14856 (if current
14857 (progn
14858 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14859 (org-set-tags nil t))
14860 (delete-horizontal-space))
14861 (run-hooks 'org-after-tags-change-hook))
14862 res))
14864 (defun org-align-tags-here (to-col)
14865 ;; Assumes that this is a headline
14866 "Align tags on the current headline to TO-COL."
14867 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14868 (beginning-of-line 1)
14869 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14870 (< pos (match-beginning 2)))
14871 (progn
14872 (setq tags-l (- (match-end 2) (match-beginning 2)))
14873 (goto-char (match-beginning 1))
14874 (insert " ")
14875 (delete-region (point) (1+ (match-beginning 2)))
14876 (setq ncol (max (current-column)
14877 (1+ col)
14878 (if (> to-col 0)
14879 to-col
14880 (- (abs to-col) tags-l))))
14881 (setq p (point))
14882 (insert (make-string (- ncol (current-column)) ?\ ))
14883 (setq ncol (current-column))
14884 (when indent-tabs-mode (tabify p (point-at-eol)))
14885 (org-move-to-column (min ncol col)))
14886 (goto-char pos))))
14888 (defun org-set-tags-command (&optional arg just-align)
14889 "Call the set-tags command for the current entry."
14890 (interactive "P")
14891 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14892 (org-set-tags arg just-align)
14893 (save-excursion
14894 (unless (and (org-region-active-p)
14895 org-loop-over-headlines-in-active-region)
14896 (org-back-to-heading t))
14897 (org-set-tags arg just-align))))
14899 (defun org-set-tags-to (data)
14900 "Set the tags of the current entry to DATA, replacing the current tags.
14901 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14902 If DATA is nil or the empty string, any tags will be removed."
14903 (interactive "sTags: ")
14904 (setq data
14905 (cond
14906 ((eq data nil) "")
14907 ((equal data "") "")
14908 ((stringp data)
14909 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14910 ":"))
14911 ((listp data)
14912 (concat ":" (mapconcat 'identity data ":") ":"))))
14913 (when data
14914 (save-excursion
14915 (org-back-to-heading t)
14916 (when (looking-at org-complex-heading-regexp)
14917 (if (match-end 5)
14918 (progn
14919 (goto-char (match-beginning 5))
14920 (insert data)
14921 (delete-region (point) (point-at-eol))
14922 (org-set-tags nil 'align))
14923 (goto-char (point-at-eol))
14924 (insert " " data)
14925 (org-set-tags nil 'align)))
14926 (beginning-of-line 1)
14927 (when (looking-at ".*?\\([ \t]+\\)$")
14928 (delete-region (match-beginning 1) (match-end 1))))))
14930 (defun org-align-all-tags ()
14931 "Align the tags i all headings."
14932 (interactive)
14933 (save-excursion
14934 (or (ignore-errors (org-back-to-heading t))
14935 (outline-next-heading))
14936 (if (org-at-heading-p)
14937 (org-set-tags t)
14938 (message "No headings"))))
14940 (defvar org-indent-indentation-per-level)
14941 (defun org-set-tags (&optional arg just-align)
14942 "Set the tags for the current headline.
14943 With prefix ARG, realign all tags in headings in the current buffer.
14944 When JUST-ALIGN is non-nil, only align tags."
14945 (interactive "P")
14946 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14947 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14948 'region-start-level
14949 'region))
14950 org-loop-over-headlines-in-active-region)
14951 (org-map-entries
14952 ;; We don't use ARG and JUST-ALIGN here because these args
14953 ;; are not useful when looping over headlines.
14954 #'org-set-tags
14955 org-loop-over-headlines-in-active-region
14957 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14958 (let ((org-setting-tags t))
14959 (if arg
14960 (save-excursion
14961 (goto-char (point-min))
14962 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14963 (while (re-search-forward org-outline-regexp-bol nil t)
14964 (org-set-tags nil t)
14965 (end-of-line)))
14966 (message "All tags realigned to column %d" org-tags-column))
14967 (let* ((current (org-get-tags-string))
14968 (col (current-column))
14969 (tags
14970 (if just-align current
14971 ;; Get a new set of tags from the user.
14972 (save-excursion
14973 (let* ((table
14974 (setq
14975 org-last-tags-completion-table
14976 (append
14977 org-tag-persistent-alist
14978 (or org-tag-alist (org-get-buffer-tags))
14979 (and
14980 org-complete-tags-always-offer-all-agenda-tags
14981 (org-global-tags-completion-table
14982 (org-agenda-files))))))
14983 (current-tags (org-split-string current ":"))
14984 (inherited-tags
14985 (nreverse (nthcdr (length current-tags)
14986 (nreverse (org-get-tags-at))))))
14987 (replace-regexp-in-string
14988 "\\([-+&]+\\|,\\)"
14990 (if (or (eq t org-use-fast-tag-selection)
14991 (and org-use-fast-tag-selection
14992 (delq nil (mapcar #'cdr table))))
14993 (org-fast-tag-selection
14994 current-tags inherited-tags table
14995 (and org-fast-tag-selection-include-todo
14996 org-todo-key-alist))
14997 (let ((org-add-colon-after-tag-completion
14998 (< 1 (length table))))
14999 (org-trim
15000 (completing-read
15001 "Tags: "
15002 #'org-tags-completion-function
15003 nil nil current 'org-tags-history))))))))))
15005 (when org-tags-sort-function
15006 (setq tags
15007 (mapconcat
15008 #'identity
15009 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15010 org-tags-sort-function)
15011 ":")))
15013 (if (not (org-string-nw-p tags)) (setq tags "")
15014 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15015 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15017 ;; Insert new tags at the correct column
15018 (beginning-of-line)
15019 (let ((level (if (looking-at org-outline-regexp)
15020 (- (match-end 0) (point) 1)
15021 1)))
15022 (cond
15023 ((and (equal current "") (equal tags "")))
15024 ((re-search-forward
15025 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15026 (line-end-position)
15028 (if (equal tags "") (replace-match "" t t)
15029 (goto-char (match-beginning 0))
15030 (let* ((c0 (current-column))
15031 ;; Compute offset for the case of org-indent-mode
15032 ;; active.
15033 (di (if (org-bound-and-true-p org-indent-mode)
15034 (* (1- org-indent-indentation-per-level)
15035 (1- level))
15037 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15038 (tc (+ org-tags-column
15039 (if (> org-tags-column 0) (- di) di)))
15040 (c1 (max (1+ c0)
15041 (if (> tc 0) tc
15042 (- (- tc) (string-width tags)))))
15043 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15044 (replace-match rpl t t)
15045 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15046 (tabify p0 (point))))))
15047 (t (error "Tags alignment failed"))))
15048 (org-move-to-column col))
15049 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15051 (defun org-change-tag-in-region (beg end tag off)
15052 "Add or remove TAG for each entry in the region.
15053 This works in the agenda, and also in an org-mode buffer."
15054 (interactive
15055 (list (region-beginning) (region-end)
15056 (let ((org-last-tags-completion-table
15057 (if (derived-mode-p 'org-mode)
15058 (org-uniquify
15059 (delq nil (append (org-get-buffer-tags)
15060 (org-global-tags-completion-table))))
15061 (org-global-tags-completion-table))))
15062 (org-icompleting-read
15063 "Tag: " 'org-tags-completion-function nil nil nil
15064 'org-tags-history))
15065 (progn
15066 (message "[s]et or [r]emove? ")
15067 (equal (read-char-exclusive) ?r))))
15068 (when (fboundp 'deactivate-mark) (deactivate-mark))
15069 (let ((agendap (equal major-mode 'org-agenda-mode))
15070 l1 l2 m buf pos newhead (cnt 0))
15071 (goto-char end)
15072 (setq l2 (1- (org-current-line)))
15073 (goto-char beg)
15074 (setq l1 (org-current-line))
15075 (loop for l from l1 to l2 do
15076 (org-goto-line l)
15077 (setq m (get-text-property (point) 'org-hd-marker))
15078 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15079 (and agendap m))
15080 (setq buf (if agendap (marker-buffer m) (current-buffer))
15081 pos (if agendap m (point)))
15082 (with-current-buffer buf
15083 (save-excursion
15084 (save-restriction
15085 (goto-char pos)
15086 (setq cnt (1+ cnt))
15087 (org-toggle-tag tag (if off 'off 'on))
15088 (setq newhead (org-get-heading)))))
15089 (and agendap (org-agenda-change-all-lines newhead m))))
15090 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15092 (defun org-tags-completion-function (string predicate &optional flag)
15093 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15094 (confirm (lambda (x) (stringp (car x)))))
15095 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15096 (setq s1 (match-string 1 string)
15097 s2 (match-string 2 string))
15098 (setq s1 "" s2 string))
15099 (cond
15100 ((eq flag nil)
15101 ;; try completion
15102 (setq rtn (try-completion s2 ctable confirm))
15103 (when (stringp rtn)
15104 (setq rtn
15105 (concat s1 s2 (substring rtn (length s2))
15106 (if (and org-add-colon-after-tag-completion
15107 (assoc rtn ctable))
15108 ":" ""))))
15109 rtn)
15110 ((eq flag t)
15111 ;; all-completions
15112 (all-completions s2 ctable confirm))
15113 ((eq flag 'lambda)
15114 ;; exact match?
15115 (assoc s2 ctable)))))
15117 (defun org-fast-tag-insert (kwd tags face &optional end)
15118 "Insert KDW, and the TAGS, the latter with face FACE.
15119 Also insert END."
15120 (insert (format "%-12s" (concat kwd ":"))
15121 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15122 (or end "")))
15124 (defun org-fast-tag-show-exit (flag)
15125 (save-excursion
15126 (org-goto-line 3)
15127 (when (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15128 (replace-match ""))
15129 (when flag
15130 (end-of-line 1)
15131 (org-move-to-column (- (window-width) 19) t)
15132 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15134 (defun org-set-current-tags-overlay (current prefix)
15135 "Add an overlay to CURRENT tag with PREFIX."
15136 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15137 (if (featurep 'xemacs)
15138 (org-overlay-display org-tags-overlay (concat prefix s)
15139 'secondary-selection)
15140 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15141 (org-overlay-display org-tags-overlay (concat prefix s)))))
15143 (defvar org-last-tag-selection-key nil)
15144 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15145 "Fast tag selection with single keys.
15146 CURRENT is the current list of tags in the headline, INHERITED is the
15147 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15148 possibly with grouping information. TODO-TABLE is a similar table with
15149 TODO keywords, should these have keys assigned to them.
15150 If the keys are nil, a-z are automatically assigned.
15151 Returns the new tags string, or nil to not change the current settings."
15152 (let* ((fulltable (append table todo-table))
15153 (maxlen (apply 'max (mapcar
15154 (lambda (x)
15155 (if (stringp (car x)) (string-width (car x)) 0))
15156 fulltable)))
15157 (buf (current-buffer))
15158 (expert (eq org-fast-tag-selection-single-key 'expert))
15159 (buffer-tags nil)
15160 (fwidth (+ maxlen 3 1 3))
15161 (ncol (/ (- (window-width) 4) fwidth))
15162 (i-face 'org-done)
15163 (c-face 'org-todo)
15164 tg cnt e c char c1 c2 ntable tbl rtn
15165 ov-start ov-end ov-prefix
15166 (exit-after-next org-fast-tag-selection-single-key)
15167 (done-keywords org-done-keywords)
15168 groups ingroup intaggroup)
15169 (save-excursion
15170 (beginning-of-line 1)
15171 (if (looking-at
15172 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15173 (setq ov-start (match-beginning 1)
15174 ov-end (match-end 1)
15175 ov-prefix "")
15176 (setq ov-start (1- (point-at-eol))
15177 ov-end (1+ ov-start))
15178 (skip-chars-forward "^\n\r")
15179 (setq ov-prefix
15180 (concat
15181 (buffer-substring (1- (point)) (point))
15182 (if (> (current-column) org-tags-column)
15184 (make-string (- org-tags-column (current-column)) ?\ ))))))
15185 (move-overlay org-tags-overlay ov-start ov-end)
15186 (save-window-excursion
15187 (if expert
15188 (set-buffer (get-buffer-create " *Org tags*"))
15189 (delete-other-windows)
15190 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15191 (org-switch-to-buffer-other-window " *Org tags*"))
15192 (erase-buffer)
15193 (setq-local org-done-keywords done-keywords)
15194 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15195 (org-fast-tag-insert "Current" current c-face "\n\n")
15196 (org-fast-tag-show-exit exit-after-next)
15197 (org-set-current-tags-overlay current ov-prefix)
15198 (setq tbl fulltable char ?a cnt 0)
15199 (while (setq e (pop tbl))
15200 (cond
15201 ((eq (car e) :startgroup)
15202 (push '() groups) (setq ingroup t)
15203 (unless (zerop cnt)
15204 (setq cnt 0)
15205 (insert "\n"))
15206 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15207 ((eq (car e) :endgroup)
15208 (setq ingroup nil cnt 0)
15209 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15210 ((eq (car e) :startgrouptag)
15211 (setq intaggroup t)
15212 (unless (zerop cnt)
15213 (setq cnt 0)
15214 (insert "\n"))
15215 (insert "[ "))
15216 ((eq (car e) :endgrouptag)
15217 (setq intaggroup nil cnt 0)
15218 (insert "]\n"))
15219 ((equal e '(:newline))
15220 (unless (zerop cnt)
15221 (setq cnt 0)
15222 (insert "\n")
15223 (setq e (car tbl))
15224 (while (equal (car tbl) '(:newline))
15225 (insert "\n")
15226 (setq tbl (cdr tbl)))))
15227 ((equal e '(:grouptags)) (insert " : "))
15229 (setq tg (copy-sequence (car e)) c2 nil)
15230 (if (cdr e)
15231 (setq c (cdr e))
15232 ;; automatically assign a character.
15233 (setq c1 (string-to-char
15234 (downcase (substring
15235 tg (if (= (string-to-char tg) ?@) 1 0)))))
15236 (if (or (rassoc c1 ntable) (rassoc c1 table))
15237 (while (or (rassoc char ntable) (rassoc char table))
15238 (setq char (1+ char)))
15239 (setq c2 c1))
15240 (setq c (or c2 char)))
15241 (when ingroup (push tg (car groups)))
15242 (setq tg (org-add-props tg nil 'face
15243 (cond
15244 ((not (assoc tg table))
15245 (org-get-todo-face tg))
15246 ((member tg current) c-face)
15247 ((member tg inherited) i-face))))
15248 (when (equal (caar tbl) :grouptags)
15249 (org-add-props tg nil 'face 'org-tag-group))
15250 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15251 (insert "[" c "] " tg (make-string
15252 (- fwidth 4 (length tg)) ?\ ))
15253 (push (cons tg c) ntable)
15254 (when (= (incf cnt) ncol)
15255 (insert "\n")
15256 (when (or ingroup intaggroup) (insert " "))
15257 (setq cnt 0)))))
15258 (setq ntable (nreverse ntable))
15259 (insert "\n")
15260 (goto-char (point-min))
15261 (unless expert (org-fit-window-to-buffer))
15262 (setq rtn
15263 (catch 'exit
15264 (while t
15265 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15266 (if (not groups) "no " "")
15267 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15268 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15269 (setq org-last-tag-selection-key c)
15270 (cond
15271 ((= c ?\r) (throw 'exit t))
15272 ((= c ?!)
15273 (setq groups (not groups))
15274 (goto-char (point-min))
15275 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15276 ((= c ?\C-c)
15277 (if (not expert)
15278 (org-fast-tag-show-exit
15279 (setq exit-after-next (not exit-after-next)))
15280 (setq expert nil)
15281 (delete-other-windows)
15282 (set-window-buffer (split-window-vertically) " *Org tags*")
15283 (org-switch-to-buffer-other-window " *Org tags*")
15284 (org-fit-window-to-buffer)))
15285 ((or (= c ?\C-g)
15286 (and (= c ?q) (not (rassoc c ntable))))
15287 (org-detach-overlay org-tags-overlay)
15288 (setq quit-flag t))
15289 ((= c ?\ )
15290 (setq current nil)
15291 (when exit-after-next (setq exit-after-next 'now)))
15292 ((= c ?\t)
15293 (condition-case nil
15294 (setq tg (org-icompleting-read
15295 "Tag: "
15296 (or buffer-tags
15297 (with-current-buffer buf
15298 (setq buffer-tags
15299 (org-get-buffer-tags))))))
15300 (quit (setq tg "")))
15301 (when (string-match "\\S-" tg)
15302 (add-to-list 'buffer-tags (list tg))
15303 (if (member tg current)
15304 (setq current (delete tg current))
15305 (push tg current)))
15306 (when exit-after-next (setq exit-after-next 'now)))
15307 ((setq e (rassoc c todo-table) tg (car e))
15308 (with-current-buffer buf
15309 (save-excursion (org-todo tg)))
15310 (when exit-after-next (setq exit-after-next 'now)))
15311 ((setq e (rassoc c ntable) tg (car e))
15312 (if (member tg current)
15313 (setq current (delete tg current))
15314 (loop for g in groups do
15315 (when (member tg g)
15316 (dolist (x g) (setq current (delete x current)))))
15317 (push tg current))
15318 (when exit-after-next (setq exit-after-next 'now))))
15320 ;; Create a sorted list
15321 (setq current
15322 (sort current
15323 (lambda (a b)
15324 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15325 (when (eq exit-after-next 'now) (throw 'exit t))
15326 (goto-char (point-min))
15327 (beginning-of-line 2)
15328 (delete-region (point) (point-at-eol))
15329 (org-fast-tag-insert "Current" current c-face)
15330 (org-set-current-tags-overlay current ov-prefix)
15331 (while (re-search-forward
15332 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15333 (setq tg (match-string 1))
15334 (add-text-properties
15335 (match-beginning 1) (match-end 1)
15336 (list 'face
15337 (cond
15338 ((member tg current) c-face)
15339 ((member tg inherited) i-face)
15340 (t (get-text-property (match-beginning 1) 'face))))))
15341 (goto-char (point-min)))))
15342 (org-detach-overlay org-tags-overlay)
15343 (if rtn
15344 (mapconcat 'identity current ":")
15345 nil))))
15347 (defun org-get-tags-string ()
15348 "Get the TAGS string in the current headline."
15349 (unless (org-at-heading-p t)
15350 (user-error "Not on a heading"))
15351 (save-excursion
15352 (beginning-of-line 1)
15353 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15354 (org-match-string-no-properties 1)
15355 "")))
15357 (defun org-get-tags ()
15358 "Get the list of tags specified in the current headline."
15359 (org-split-string (org-get-tags-string) ":"))
15361 (defun org-get-buffer-tags ()
15362 "Get a table of all tags used in the buffer, for completion."
15363 (org-with-wide-buffer
15364 (goto-char (point-min))
15365 (let ((tag-re (concat org-outline-regexp-bol
15366 "\\(?:.*?[ \t]\\)?"
15367 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15368 tags)
15369 (while (re-search-forward tag-re nil t)
15370 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15371 (push tag tags)))
15372 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15374 ;;;; The mapping API
15376 (defun org-map-entries (func &optional match scope &rest skip)
15377 "Call FUNC at each headline selected by MATCH in SCOPE.
15379 FUNC is a function or a lisp form. The function will be called without
15380 arguments, with the cursor positioned at the beginning of the headline.
15381 The return values of all calls to the function will be collected and
15382 returned as a list.
15384 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15385 does not need to preserve point. After evaluation, the cursor will be
15386 moved to the end of the line (presumably of the headline of the
15387 processed entry) and search continues from there. Under some
15388 circumstances, this may not produce the wanted results. For example,
15389 if you have removed (e.g. archived) the current (sub)tree it could
15390 mean that the next entry will be skipped entirely. In such cases, you
15391 can specify the position from where search should continue by making
15392 FUNC set the variable `org-map-continue-from' to the desired buffer
15393 position.
15395 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15396 Only headlines that are matched by this query will be considered during
15397 the iteration. When MATCH is nil or t, all headlines will be
15398 visited by the iteration.
15400 SCOPE determines the scope of this command. It can be any of:
15402 nil The current buffer, respecting the restriction if any
15403 tree The subtree started with the entry at point
15404 region The entries within the active region, if any
15405 region-start-level
15406 The entries within the active region, but only those at
15407 the same level than the first one.
15408 file The current buffer, without restriction
15409 file-with-archives
15410 The current buffer, and any archives associated with it
15411 agenda All agenda files
15412 agenda-with-archives
15413 All agenda files with any archive files associated with them
15414 \(file1 file2 ...)
15415 If this is a list, all files in the list will be scanned
15417 The remaining args are treated as settings for the skipping facilities of
15418 the scanner. The following items can be given here:
15420 archive skip trees with the archive tag
15421 comment skip trees with the COMMENT keyword
15422 function or Emacs Lisp form:
15423 will be used as value for `org-agenda-skip-function', so
15424 whenever the function returns a position, FUNC will not be
15425 called for that entry and search will continue from the
15426 position returned
15428 If your function needs to retrieve the tags including inherited tags
15429 at the *current* entry, you can use the value of the variable
15430 `org-scanner-tags' which will be much faster than getting the value
15431 with `org-get-tags-at'. If your function gets properties with
15432 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15433 to t around the call to `org-entry-properties' to get the same speedup.
15434 Note that if your function moves around to retrieve tags and properties at
15435 a *different* entry, you cannot use these techniques."
15436 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15437 (not (org-region-active-p)))
15438 (let* ((org-agenda-archives-mode nil) ; just to make sure
15439 (org-agenda-skip-archived-trees (memq 'archive skip))
15440 (org-agenda-skip-comment-trees (memq 'comment skip))
15441 (org-agenda-skip-function
15442 (car (org-delete-all '(comment archive) skip)))
15443 (org-tags-match-list-sublevels t)
15444 (start-level (eq scope 'region-start-level))
15445 matcher file res
15446 org-todo-keywords-for-agenda
15447 org-done-keywords-for-agenda
15448 org-todo-keyword-alist-for-agenda
15449 org-tag-alist-for-agenda
15450 todo-only)
15452 (cond
15453 ((eq match t) (setq matcher t))
15454 ((eq match nil) (setq matcher t))
15455 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15457 (save-excursion
15458 (save-restriction
15459 (cond ((eq scope 'tree)
15460 (org-back-to-heading t)
15461 (org-narrow-to-subtree)
15462 (setq scope nil))
15463 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15464 (org-region-active-p))
15465 ;; If needed, set start-level to a string like "2"
15466 (when start-level
15467 (save-excursion
15468 (goto-char (region-beginning))
15469 (unless (org-at-heading-p) (outline-next-heading))
15470 (setq start-level (org-current-level))))
15471 (narrow-to-region (region-beginning)
15472 (save-excursion
15473 (goto-char (region-end))
15474 (unless (and (bolp) (org-at-heading-p))
15475 (outline-next-heading))
15476 (point)))
15477 (setq scope nil)))
15479 (if (not scope)
15480 (progn
15481 (org-agenda-prepare-buffers
15482 (and buffer-file-name (list buffer-file-name)))
15483 (setq res (org-scan-tags func matcher todo-only start-level)))
15484 ;; Get the right scope
15485 (cond
15486 ((and scope (listp scope) (symbolp (car scope)))
15487 (setq scope (eval scope)))
15488 ((eq scope 'agenda)
15489 (setq scope (org-agenda-files t)))
15490 ((eq scope 'agenda-with-archives)
15491 (setq scope (org-agenda-files t))
15492 (setq scope (org-add-archive-files scope)))
15493 ((eq scope 'file)
15494 (setq scope (and buffer-file-name (list buffer-file-name))))
15495 ((eq scope 'file-with-archives)
15496 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15497 (org-agenda-prepare-buffers scope)
15498 (dolist (file scope)
15499 (with-current-buffer (org-find-base-buffer-visiting file)
15500 (save-excursion
15501 (save-restriction
15502 (widen)
15503 (goto-char (point-min))
15504 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15505 res)))
15507 ;;; Properties API
15509 (defconst org-special-properties
15510 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15511 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15512 "The special properties valid in Org mode.
15513 These are properties that are not defined in the property drawer,
15514 but in some other way.")
15516 (defconst org-default-properties
15517 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15518 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15519 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15520 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15521 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15522 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15523 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15524 "Some properties that are used by Org mode for various purposes.
15525 Being in this list makes sure that they are offered for completion.")
15527 (defun org--update-property-plist (key val props)
15528 "Associate KEY to VAL in alist PROPS.
15529 Modifications are made by side-effect. Return new alist."
15530 (let* ((appending (string= (substring key -1) "+"))
15531 (key (if appending (substring key 0 -1) key))
15532 (old (assoc-string key props t)))
15533 (if (not old) (cons (cons key val) props)
15534 (setcdr old (if appending (concat (cdr old) " " val) val))
15535 props)))
15537 (defun org-get-property-block (&optional beg force)
15538 "Return the (beg . end) range of the body of the property drawer.
15539 BEG is the beginning of the current subtree, or of the part
15540 before the first headline. If it is not given, it will be found.
15541 If the drawer does not exist, create it if FORCE is non-nil, or
15542 return nil."
15543 (org-with-wide-buffer
15544 (when beg (goto-char beg))
15545 (unless (org-before-first-heading-p)
15546 (let ((beg (cond (beg)
15547 ((or (not (featurep 'org-inlinetask))
15548 (org-inlinetask-in-task-p))
15549 (org-back-to-heading t))
15550 (t (org-with-limited-levels (org-back-to-heading t))))))
15551 (forward-line)
15552 (when (org-looking-at-p org-planning-line-re) (forward-line))
15553 (cond ((looking-at org-property-drawer-re)
15554 (forward-line)
15555 (cons (point) (progn (goto-char (match-end 0))
15556 (line-beginning-position))))
15557 (force
15558 (goto-char beg)
15559 (org-insert-property-drawer)
15560 (let ((pos (save-excursion (search-forward ":END:")
15561 (line-beginning-position))))
15562 (cons pos pos))))))))
15564 (defun org-at-property-p ()
15565 "Non-nil when point is inside a property drawer.
15566 See `org-property-re' for match data, if applicable."
15567 (save-excursion
15568 (beginning-of-line)
15569 (and (looking-at org-property-re)
15570 (let ((property-drawer (save-match-data (org-get-property-block))))
15571 (and property-drawer
15572 (>= (point) (car property-drawer))
15573 (< (point) (cdr property-drawer)))))))
15575 (defun org-property-action ()
15576 "Do an action on properties."
15577 (interactive)
15578 (unless (org-at-property-p) (user-error "Not at a property"))
15579 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15580 (let ((c (read-char-exclusive)))
15581 (case c
15582 (?s (call-interactively #'org-set-property))
15583 (?d (call-interactively #'org-delete-property))
15584 (?D (call-interactively #'org-delete-property-globally))
15585 (?c (call-interactively #'org-compute-property-at-point))
15586 (otherwise (user-error "No such property action %c" c)))))
15588 (defun org-inc-effort ()
15589 "Increment the value of the effort property in the current entry."
15590 (interactive)
15591 (org-set-effort nil t))
15593 (defvar org-clock-effort) ; Defined in org-clock.el.
15594 (defvar org-clock-current-task) ; Defined in org-clock.el.
15595 (defun org-set-effort (&optional value increment)
15596 "Set the effort property of the current entry.
15597 With numerical prefix arg, use the nth allowed value, 0 stands for the
15598 10th allowed value.
15600 When INCREMENT is non-nil, set the property to the next allowed value."
15601 (interactive "P")
15602 (when (equal value 0) (setq value 10))
15603 (let* ((completion-ignore-case t)
15604 (prop org-effort-property)
15605 (cur (org-entry-get nil prop))
15606 (allowed (org-property-get-allowed-values nil prop 'table))
15607 (existing (mapcar 'list (org-property-values prop)))
15608 (heading (nth 4 (org-heading-components)))
15610 (val (cond
15611 ((stringp value) value)
15612 ((and allowed (integerp value))
15613 (or (car (nth (1- value) allowed))
15614 (car (org-last allowed))))
15615 ((and allowed increment)
15616 (or (caadr (member (list cur) allowed))
15617 (user-error "Allowed effort values are not set")))
15618 (allowed
15619 (message "Select 1-9,0, [RET%s]: %s"
15620 (if cur (concat "=" cur) "")
15621 (mapconcat 'car allowed " "))
15622 (setq rpl (read-char-exclusive))
15623 (if (equal rpl ?\r)
15625 (setq rpl (- rpl ?0))
15626 (when (equal rpl 0) (setq rpl 10))
15627 (if (and (> rpl 0) (<= rpl (length allowed)))
15628 (car (nth (1- rpl) allowed))
15629 (org-completing-read "Effort: " allowed nil))))
15631 (let (org-completion-use-ido org-completion-use-iswitchb)
15632 (org-completing-read
15633 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15634 (concat "[" cur "]") "")
15635 ": ")
15636 existing nil nil "" nil cur))))))
15637 (unless (equal (org-entry-get nil prop) val)
15638 (org-entry-put nil prop val))
15639 (org-refresh-property
15640 '((effort . identity)
15641 (effort-minutes . org-duration-string-to-minutes))
15642 val)
15643 (when (string= heading org-clock-current-task)
15644 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15645 (org-clock-update-mode-line))
15646 (message "%s is now %s" prop val)))
15648 (defun org-entry-properties (&optional pom which)
15649 "Get all properties of the current entry.
15651 When POM is a buffer position, get all properties from the entry
15652 there instead.
15654 This includes the TODO keyword, the tags, time strings for
15655 deadline, scheduled, and clocking, and any additional properties
15656 defined in the entry.
15658 If WHICH is nil or `all', get all properties. If WHICH is
15659 `special' or `standard', only get that subclass. If WHICH is
15660 a string, only get that property.
15662 Return value is an alist. Keys are properties, as upcased
15663 strings."
15664 (org-with-point-at pom
15665 (when (and (derived-mode-p 'org-mode)
15666 (ignore-errors (org-back-to-heading t)))
15667 (catch 'exit
15668 (let* ((beg (point))
15669 (specific (and (stringp which) (upcase which)))
15670 (which (cond ((not specific) which)
15671 ((member specific org-special-properties) 'special)
15672 (t 'standard)))
15673 props)
15674 ;; Get the special properties, like TODO and TAGS.
15675 (when (memq which '(nil all special))
15676 (when (or (not specific) (string= specific "CLOCKSUM"))
15677 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15678 (when clocksum
15679 (push (cons "CLOCKSUM"
15680 (org-columns-number-to-string
15681 (/ (float clocksum) 60.) 'add_times))
15682 props)))
15683 (when specific (throw 'exit props)))
15684 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15685 (let ((clocksumt (get-text-property (point)
15686 :org-clock-minutes-today)))
15687 (when clocksumt
15688 (push (cons "CLOCKSUM_T"
15689 (org-columns-number-to-string
15690 (/ (float clocksumt) 60.) 'add_times))
15691 props)))
15692 (when specific (throw 'exit props)))
15693 (when (or (not specific) (string= specific "ITEM"))
15694 (when (looking-at org-complex-heading-regexp)
15695 (push (cons "ITEM"
15696 (concat
15697 (org-match-string-no-properties 1)
15698 (let ((title (org-match-string-no-properties 4)))
15699 (when (org-string-nw-p title)
15700 (concat " " (org-remove-tabs title))))))
15701 props))
15702 (when specific (throw 'exit props)))
15703 (when (or (not specific) (string= specific "TODO"))
15704 (let ((case-fold-search nil))
15705 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15706 (push (cons "TODO" (org-match-string-no-properties 2)) props)))
15707 (when specific (throw 'exit props)))
15708 (when (or (not specific) (string= specific "PRIORITY"))
15709 (push (cons "PRIORITY"
15710 (if (looking-at org-priority-regexp)
15711 (org-match-string-no-properties 2)
15712 (char-to-string org-default-priority)))
15713 props)
15714 (when specific (throw 'exit props)))
15715 (when (or (not specific) (string= specific "FILE"))
15716 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15717 props)
15718 (when specific (throw 'exit props)))
15719 (when (or (not specific) (string= specific "TAGS"))
15720 (let ((value (org-string-nw-p (org-get-tags-string))))
15721 (when value (push (cons "TAGS" value) props)))
15722 (when specific (throw 'exit props)))
15723 (when (or (not specific) (string= specific "ALLTAGS"))
15724 (let ((value (org-get-tags-at)))
15725 (when value
15726 (push (cons "ALLTAGS"
15727 (format ":%s:" (mapconcat #'identity value ":")))
15728 props)))
15729 (when specific (throw 'exit props)))
15730 (when (or (not specific) (string= specific "BLOCKED"))
15731 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15732 (when specific (throw 'exit props)))
15733 (when (or (not specific)
15734 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15735 (forward-line)
15736 (when (org-looking-at-p org-planning-line-re)
15737 (end-of-line)
15738 (let ((bol (line-beginning-position))
15739 ;; Backward compatibility: time keywords used to
15740 ;; be configurable (before 8.3). Make sure we
15741 ;; get the correct keyword.
15742 (key-assoc `(("CLOSED" . ,org-closed-string)
15743 ("DEADLINE" . ,org-deadline-string)
15744 ("SCHEDULED" . ,org-scheduled-string))))
15745 (dolist (pair (if specific (list (assoc specific key-assoc))
15746 key-assoc))
15747 (save-excursion
15748 (when (search-backward (cdr pair) bol t)
15749 (goto-char (match-end 0))
15750 (skip-chars-forward " \t")
15751 (and (looking-at org-ts-regexp-both)
15752 (push (cons (car pair)
15753 (org-match-string-no-properties 0))
15754 props)))))))
15755 (when specific (throw 'exit props)))
15756 (when (or (not specific)
15757 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15758 (let ((find-ts
15759 (lambda (end ts)
15760 (let ((regexp (cond
15761 ((string= specific "TIMESTAMP")
15762 org-ts-regexp)
15763 ((string= specific "TIMESTAMP_IA")
15764 org-ts-regexp-inactive)
15765 ((assoc "TIMESTAMP_IA" ts)
15766 org-ts-regexp)
15767 ((assoc "TIMESTAMP" ts)
15768 org-ts-regexp-inactive)
15769 (t org-ts-regexp-both))))
15770 (catch 'next
15771 (while (re-search-forward regexp end t)
15772 (backward-char)
15773 (let ((object (org-element-context)))
15774 ;; Accept to match timestamps in node
15775 ;; properties, too.
15776 (when (memq (org-element-type object)
15777 '(node-property timestamp))
15778 (let ((type
15779 (org-element-property :type object)))
15780 (cond
15781 ((and (memq type '(active active-range))
15782 (not (equal specific "TIMESTAMP_IA")))
15783 (unless (assoc "TIMESTAMP" ts)
15784 (push (cons "TIMESTAMP"
15785 (org-element-property
15786 :raw-value object))
15788 (when specific (throw 'exit ts))))
15789 ((and (memq type '(inactive inactive-range))
15790 (not (string= specific "TIMESTAMP")))
15791 (unless (assoc "TIMESTAMP_IA" ts)
15792 (push (cons "TIMESTAMP_IA"
15793 (org-element-property
15794 :raw-value object))
15796 (when specific (throw 'exit ts))))))
15797 ;; Both timestamp types are found,
15798 ;; move to next part.
15799 (when (= (length ts) 2) (throw 'next ts)))))
15800 ts)))))
15801 (goto-char beg)
15802 ;; First look for timestamps within headline.
15803 (let ((ts (funcall find-ts (line-end-position) nil)))
15804 (if (= (length ts) 2) (setq props (nconc ts props))
15805 (forward-line)
15806 ;; Then find timestamps in the section, skipping
15807 ;; planning line.
15808 (when (org-looking-at-p org-planning-line-re)
15809 (forward-line))
15810 (let ((end (save-excursion (outline-next-heading))))
15811 (setq props (nconc (funcall find-ts end ts) props))))))))
15812 ;; Get the standard properties, like :PROP:.
15813 (when (memq which '(nil all standard))
15814 ;; If we are looking after a specific property, delegate
15815 ;; to `org-entry-get', which is faster. However, make an
15816 ;; exception for "CATEGORY", since it can be also set
15817 ;; through keywords (i.e. #+CATEGORY).
15818 (if (and specific (not (equal specific "CATEGORY")))
15819 (let ((value (org-entry-get beg specific nil t)))
15820 (throw 'exit (and value (list (cons specific value)))))
15821 (let ((range (org-get-property-block beg)))
15822 (when range
15823 (let ((end (cdr range)) seen-base)
15824 (goto-char (car range))
15825 ;; Unlike to `org--update-property-plist', we
15826 ;; handle the case where base values is found
15827 ;; after its extension. We also forbid standard
15828 ;; properties to be named as special properties.
15829 (while (re-search-forward org-property-re end t)
15830 (let* ((key (upcase (org-match-string-no-properties 2)))
15831 (extendp (org-string-match-p "\\+\\'" key))
15832 (key-base (if extendp (substring key 0 -1) key))
15833 (value (org-match-string-no-properties 3)))
15834 (cond
15835 ((member-ignore-case key-base org-special-properties))
15836 (extendp
15837 (setq props
15838 (org--update-property-plist key value props)))
15839 ((member key seen-base))
15840 (t (push key seen-base)
15841 (let ((p (assoc-string key props t)))
15842 (if p (setcdr p (concat value " " (cdr p)))
15843 (push (cons key value) props))))))))))))
15844 (unless (assoc "CATEGORY" props)
15845 (push (cons "CATEGORY" (org-get-category beg)) props)
15846 (when (string= specific "CATEGORY") (throw 'exit props)))
15847 ;; Return value.
15848 props)))))
15850 (defun org-property--local-values (property literal-nil)
15851 "Return value for PROPERTY in current entry.
15852 Value is a list whose care is the base value for PROPERTY and cdr
15853 a list of accumulated values. Return nil if neither is found in
15854 the entry. Also return nil when PROPERTY is set to \"nil\",
15855 unless LITERAL-NIL is non-nil."
15856 (let ((range (org-get-property-block)))
15857 (when range
15858 (goto-char (car range))
15859 (let* ((case-fold-search t)
15860 (end (cdr range))
15861 (value
15862 ;; Base value.
15863 (save-excursion
15864 (let ((v (and (re-search-forward
15865 (org-re-property property nil t) end t)
15866 (org-match-string-no-properties 3))))
15867 (list (if literal-nil v (org-not-nil v)))))))
15868 ;; Find additional values.
15869 (let* ((property+ (org-re-property (concat property "+") nil t)))
15870 (while (re-search-forward property+ end t)
15871 (push (org-match-string-no-properties 3) value)))
15872 ;; Return final values.
15873 (and (not (equal value '(nil))) (nreverse value))))))
15875 (defun org-entry-get (pom property &optional inherit literal-nil)
15876 "Get value of PROPERTY for entry or content at point-or-marker POM.
15878 If INHERIT is non-nil and the entry does not have the property,
15879 then also check higher levels of the hierarchy. If INHERIT is
15880 the symbol `selective', use inheritance only if the setting in
15881 `org-use-property-inheritance' selects PROPERTY for inheritance.
15883 If the property is present but empty, the return value is the
15884 empty string. If the property is not present at all, nil is
15885 returned. In any other case, return the value as a string.
15886 Search is case-insensitive.
15888 If LITERAL-NIL is set, return the string value \"nil\" as
15889 a string, do not interpret it as the list atom nil. This is used
15890 for inheritance when a \"nil\" value can supersede a non-nil
15891 value higher up the hierarchy."
15892 (org-with-point-at pom
15893 (cond
15894 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15895 ;; We need a special property. Use `org-entry-properties' to
15896 ;; retrieve it, but specify the wanted property.
15897 (cdr (assoc-string property (org-entry-properties nil property))))
15898 ((and inherit
15899 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15900 (org-entry-get-with-inheritance property literal-nil))
15902 (let* ((local (org-property--local-values property literal-nil))
15903 (value (and local (mapconcat #'identity (delq nil local) " "))))
15904 (if literal-nil value (org-not-nil value)))))))
15906 (defun org-property-or-variable-value (var &optional inherit)
15907 "Check if there is a property fixing the value of VAR.
15908 If yes, return this value. If not, return the current value of the variable."
15909 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15910 (if (and prop (stringp prop) (string-match "\\S-" prop))
15911 (read prop)
15912 (symbol-value var))))
15914 (defun org-entry-delete (pom property)
15915 "Delete PROPERTY from entry at point-or-marker POM.
15916 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15917 non-nil when a property was removed."
15918 (unless (member property org-special-properties)
15919 (org-with-point-at pom
15920 (let ((range (org-get-property-block)))
15921 (when range
15922 (let* ((begin (car range))
15923 (origin (cdr range))
15924 (end (copy-marker origin))
15925 (re (org-re-property
15926 (concat (regexp-quote property) "\\+?") t t)))
15927 (goto-char begin)
15928 (while (re-search-forward re end t)
15929 (delete-region (match-beginning 0) (line-beginning-position 2)))
15930 ;; If drawer is empty, remove it altogether.
15931 (when (= begin end)
15932 (delete-region (line-beginning-position 0)
15933 (line-beginning-position 2)))
15934 ;; Return non-nil if some property was removed.
15935 (prog1 (/= end origin) (set-marker end nil))))))))
15937 ;; Multi-values properties are properties that contain multiple values
15938 ;; These values are assumed to be single words, separated by whitespace.
15939 (defun org-entry-add-to-multivalued-property (pom property value)
15940 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15941 (let* ((old (org-entry-get pom property))
15942 (values (and old (org-split-string old "[ \t]"))))
15943 (setq value (org-entry-protect-space value))
15944 (unless (member value values)
15945 (setq values (append values (list value)))
15946 (org-entry-put pom property
15947 (mapconcat 'identity values " ")))))
15949 (defun org-entry-remove-from-multivalued-property (pom property value)
15950 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15951 (let* ((old (org-entry-get pom property))
15952 (values (and old (org-split-string old "[ \t]"))))
15953 (setq value (org-entry-protect-space value))
15954 (when (member value values)
15955 (setq values (delete value values))
15956 (org-entry-put pom property
15957 (mapconcat 'identity values " ")))))
15959 (defun org-entry-member-in-multivalued-property (pom property value)
15960 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15961 (let* ((old (org-entry-get pom property))
15962 (values (and old (org-split-string old "[ \t]"))))
15963 (setq value (org-entry-protect-space value))
15964 (member value values)))
15966 (defun org-entry-get-multivalued-property (pom property)
15967 "Return a list of values in a multivalued property."
15968 (let* ((value (org-entry-get pom property))
15969 (values (and value (org-split-string value "[ \t]"))))
15970 (mapcar 'org-entry-restore-space values)))
15972 (defun org-entry-put-multivalued-property (pom property &rest values)
15973 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15974 VALUES should be a list of strings. Spaces will be protected."
15975 (org-entry-put pom property
15976 (mapconcat 'org-entry-protect-space values " "))
15977 (let* ((value (org-entry-get pom property))
15978 (values (and value (org-split-string value "[ \t]"))))
15979 (mapcar 'org-entry-restore-space values)))
15981 (defun org-entry-protect-space (s)
15982 "Protect spaces and newline in string S."
15983 (while (string-match " " s)
15984 (setq s (replace-match "%20" t t s)))
15985 (while (string-match "\n" s)
15986 (setq s (replace-match "%0A" t t s)))
15989 (defun org-entry-restore-space (s)
15990 "Restore spaces and newline in string S."
15991 (while (string-match "%20" s)
15992 (setq s (replace-match " " t t s)))
15993 (while (string-match "%0A" s)
15994 (setq s (replace-match "\n" t t s)))
15997 (defvar org-entry-property-inherited-from (make-marker)
15998 "Marker pointing to the entry from where a property was inherited.
15999 Each call to `org-entry-get-with-inheritance' will set this marker to the
16000 location of the entry where the inheritance search matched. If there was
16001 no match, the marker will point nowhere.
16002 Note that also `org-entry-get' calls this function, if the INHERIT flag
16003 is set.")
16005 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16006 "Get PROPERTY of entry or content at point, search higher levels if needed.
16007 The search will stop at the first ancestor which has the property defined.
16008 If the value found is \"nil\", return nil to show that the property
16009 should be considered as undefined (this is the meaning of nil here).
16010 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16011 (move-marker org-entry-property-inherited-from nil)
16012 (org-with-wide-buffer
16013 (let (value)
16014 (catch 'exit
16015 (while t
16016 (let ((v (org-property--local-values property literal-nil)))
16017 (when v
16018 (setq value
16019 (concat (mapconcat #'identity (delq nil v) " ")
16020 (and value " ")
16021 value)))
16022 (cond
16023 ((car v)
16024 (org-back-to-heading t)
16025 (move-marker org-entry-property-inherited-from (point))
16026 (throw 'exit nil))
16027 ((org-up-heading-safe))
16029 (let ((global
16030 (cdr (or (assoc-string property org-file-properties t)
16031 (assoc-string property org-global-properties t)
16032 (assoc-string property org-global-properties-fixed t)))))
16033 (cond ((not global))
16034 (value (setq value (concat global " " value)))
16035 (t (setq value global))))
16036 (throw 'exit nil))))))
16037 (if literal-nil value (org-not-nil value)))))
16039 (defvar org-property-changed-functions nil
16040 "Hook called when the value of a property has changed.
16041 Each hook function should accept two arguments, the name of the property
16042 and the new value.")
16044 (defun org-entry-put (pom property value)
16045 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16047 If the value is nil, it is converted to the empty string. If
16048 it is not a string, an error is raised.
16050 PROPERTY can be any regular property (see
16051 `org-special-properties'). It can also be \"TODO\",
16052 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16054 For the last two properties, VALUE may have any of the special
16055 values \"earlier\" and \"later\". The function then increases or
16056 decreases scheduled or deadline date by one day."
16057 (cond ((null value) (setq value ""))
16058 ((not (stringp value)) (error "Properties values should be strings")))
16059 (org-with-point-at pom
16060 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16061 (org-back-to-heading t)
16062 (org-with-limited-levels (org-back-to-heading t)))
16063 (let ((beg (point)))
16064 (cond
16065 ((equal property "TODO")
16066 (cond ((not (org-string-nw-p value)) (setq value 'none))
16067 ((not (member value org-todo-keywords-1))
16068 (user-error "\"%s\" is not a valid TODO state" value)))
16069 (org-todo value)
16070 (org-set-tags nil 'align))
16071 ((equal property "PRIORITY")
16072 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16073 (org-set-tags nil 'align))
16074 ((equal property "SCHEDULED")
16075 (forward-line)
16076 (if (and (org-looking-at-p org-planning-line-re)
16077 (re-search-forward
16078 org-scheduled-time-regexp (line-end-position) t))
16079 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16080 ((string= value "later") (org-timestamp-change 1 'day))
16081 ((string= value "") (org-schedule '(4)))
16082 (t (org-schedule nil value)))
16083 (if (member value '("earlier" "later" ""))
16084 (call-interactively #'org-schedule)
16085 (org-schedule nil value))))
16086 ((equal property "DEADLINE")
16087 (forward-line)
16088 (if (and (org-looking-at-p org-planning-line-re)
16089 (re-search-forward
16090 org-deadline-time-regexp (line-end-position) t))
16091 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16092 ((string= value "later") (org-timestamp-change 1 'day))
16093 ((string= value "") (org-deadline '(4)))
16094 (t (org-deadline nil value)))
16095 (if (member value '("earlier" "later" ""))
16096 (call-interactively #'org-deadline)
16097 (org-deadline nil value))))
16098 ((member property org-special-properties)
16099 (error "The %s property cannot be set with `org-entry-put'" property))
16101 (let* ((range (org-get-property-block beg 'force))
16102 (end (cdr range))
16103 (case-fold-search t))
16104 (goto-char (car range))
16105 (if (re-search-forward (org-re-property property nil t) end t)
16106 (progn (delete-region (match-beginning 0) (match-end 0))
16107 (goto-char (match-beginning 0)))
16108 (goto-char end)
16109 (insert "\n")
16110 (backward-char))
16111 (insert ":" property ":")
16112 (when value (insert " " value))
16113 (org-indent-line)))))
16114 (run-hook-with-args 'org-property-changed-functions property value)))
16116 (defun org-buffer-property-keys (&optional specials defaults columns)
16117 "Get all property keys in the current buffer.
16119 When SPECIALS is non-nil, also list the special properties that
16120 reflect things like tags and TODO state.
16122 When DEFAULTS is non-nil, also include properties that has
16123 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16124 DESCRIPTION, LOCATION, and LOGGING and others.
16126 When COLUMNS in non-nil, also include property names given in
16127 COLUMN formats in the current buffer."
16128 (let ((case-fold-search t)
16129 (props (append
16130 (and specials org-special-properties)
16131 (and defaults (cons org-effort-property org-default-properties))
16132 nil)))
16133 (org-with-wide-buffer
16134 (goto-char (point-min))
16135 (while (re-search-forward org-property-start-re nil t)
16136 (let ((range (org-get-property-block)))
16137 (catch 'skip
16138 (unless range
16139 (when (and (not (org-before-first-heading-p))
16140 (y-or-n-p (format "Malformed drawer at %d, repair?"
16141 (line-beginning-position))))
16142 (org-get-property-block nil t))
16143 (throw 'skip nil))
16144 (goto-char (car range))
16145 (let ((begin (car range))
16146 (end (cdr range)))
16147 ;; Make sure that found property block is not located
16148 ;; before current point, as it would generate an infloop.
16149 ;; It can happen, for example, in the following
16150 ;; situation:
16152 ;; * Headline
16153 ;; :PROPERTIES:
16154 ;; ...
16155 ;; :END:
16156 ;; *************** Inlinetask
16157 ;; #+BEGIN_EXAMPLE
16158 ;; :PROPERTIES:
16159 ;; #+END_EXAMPLE
16161 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16162 (while (< (point) end)
16163 (let ((p (progn (looking-at org-property-re)
16164 (org-match-string-no-properties 2))))
16165 ;; Only add true property name, not extension symbol.
16166 (add-to-list 'props
16167 (if (not (org-string-match-p "\\+\\'" p)) p
16168 (substring p 0 -1))))
16169 (forward-line))))
16170 (outline-next-heading)))
16171 (when columns
16172 (goto-char (point-min))
16173 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16174 (let ((element (org-element-at-point)))
16175 (when (memq (org-element-type element) '(keyword node-property))
16176 (let ((value (org-element-property :value element))
16177 (start 0))
16178 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16179 (setq start (match-end 0))
16180 (let ((p (org-match-string-no-properties 1 value)))
16181 (unless (member-ignore-case p org-special-properties)
16182 (add-to-list 'props p))))))))))
16183 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16185 (defun org-property-values (key)
16186 "List all non-nil values of property KEY in current buffer."
16187 (org-with-wide-buffer
16188 (goto-char (point-min))
16189 (let ((case-fold-search t)
16190 (re (org-re-property key))
16191 values)
16192 (while (re-search-forward re nil t)
16193 (add-to-list 'values (org-entry-get (point) key)))
16194 values)))
16196 (defun org-insert-property-drawer ()
16197 "Insert a property drawer into the current entry."
16198 (org-with-wide-buffer
16199 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16200 (org-back-to-heading t)
16201 (org-with-limited-levels (org-back-to-heading t)))
16202 (forward-line)
16203 (when (org-looking-at-p org-planning-line-re) (forward-line))
16204 (unless (org-looking-at-p org-property-drawer-re)
16205 ;; Make sure we start editing a line from current entry, not from
16206 ;; next one. It prevents extending text properties or overlays
16207 ;; belonging to the latter.
16208 (when (bolp) (backward-char))
16209 (let ((begin (1+ (point)))
16210 (inhibit-read-only t))
16211 (insert "\n:PROPERTIES:\n:END:")
16212 (when (eobp) (insert "\n"))
16213 (org-indent-region begin (point))))))
16215 (defun org-insert-drawer (&optional arg drawer)
16216 "Insert a drawer at point.
16218 When optional argument ARG is non-nil, insert a property drawer.
16220 Optional argument DRAWER, when non-nil, is a string representing
16221 drawer's name. Otherwise, the user is prompted for a name.
16223 If a region is active, insert the drawer around that region
16224 instead.
16226 Point is left between drawer's boundaries."
16227 (interactive "P")
16228 (let* ((drawer (if arg "PROPERTIES"
16229 (or drawer (read-from-minibuffer "Drawer: ")))))
16230 (cond
16231 ;; With C-u, fall back on `org-insert-property-drawer'
16232 (arg (org-insert-property-drawer))
16233 ;; Check validity of suggested drawer's name.
16234 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16235 (user-error "Invalid drawer name"))
16236 ;; With an active region, insert a drawer at point.
16237 ((not (org-region-active-p))
16238 (progn
16239 (unless (bolp) (insert "\n"))
16240 (insert (format ":%s:\n\n:END:\n" drawer))
16241 (forward-line -2)))
16242 ;; Otherwise, insert the drawer at point
16244 (let ((rbeg (region-beginning))
16245 (rend (copy-marker (region-end))))
16246 (unwind-protect
16247 (progn
16248 (goto-char rbeg)
16249 (beginning-of-line)
16250 (when (save-excursion
16251 (re-search-forward org-outline-regexp-bol rend t))
16252 (user-error "Drawers cannot contain headlines"))
16253 ;; Position point at the beginning of the first
16254 ;; non-blank line in region. Insert drawer's opening
16255 ;; there, then indent it.
16256 (org-skip-whitespace)
16257 (beginning-of-line)
16258 (insert ":" drawer ":\n")
16259 (forward-line -1)
16260 (indent-for-tab-command)
16261 ;; Move point to the beginning of the first blank line
16262 ;; after the last non-blank line in region. Insert
16263 ;; drawer's closing, then indent it.
16264 (goto-char rend)
16265 (skip-chars-backward " \r\t\n")
16266 (insert "\n:END:")
16267 (deactivate-mark t)
16268 (indent-for-tab-command)
16269 (unless (eolp) (insert "\n")))
16270 ;; Clear marker, whatever the outcome of insertion is.
16271 (set-marker rend nil)))))))
16273 (defvar org-property-set-functions-alist nil
16274 "Property set function alist.
16275 Each entry should have the following format:
16277 (PROPERTY . READ-FUNCTION)
16279 The read function will be called with the same argument as
16280 `org-completing-read'.")
16282 (defun org-set-property-function (property)
16283 "Get the function that should be used to set PROPERTY.
16284 This is computed according to `org-property-set-functions-alist'."
16285 (or (cdr (assoc property org-property-set-functions-alist))
16286 'org-completing-read))
16288 (defun org-read-property-value (property)
16289 "Read PROPERTY value from user."
16290 (let* ((completion-ignore-case t)
16291 (allowed (org-property-get-allowed-values nil property 'table))
16292 (cur (org-entry-get nil property))
16293 (prompt (concat property " value"
16294 (if (and cur (string-match "\\S-" cur))
16295 (concat " [" cur "]") "") ": "))
16296 (set-function (org-set-property-function property))
16297 (val (if allowed
16298 (funcall set-function prompt allowed nil
16299 (not (get-text-property 0 'org-unrestricted
16300 (caar allowed))))
16301 (let (org-completion-use-ido org-completion-use-iswitchb)
16302 (funcall set-function prompt
16303 (mapcar 'list (org-property-values property))
16304 nil nil "" nil cur)))))
16305 (org-trim val)))
16307 (defvar org-last-set-property nil)
16308 (defvar org-last-set-property-value nil)
16309 (defun org-read-property-name ()
16310 "Read a property name."
16311 (let ((completion-ignore-case t)
16312 (default-prop (or (and (org-at-property-p)
16313 (org-match-string-no-properties 2))
16314 org-last-set-property)))
16315 (org-completing-read
16316 (concat "Property"
16317 (if default-prop (concat " [" default-prop "]") "")
16318 ": ")
16319 (mapcar #'list (org-buffer-property-keys nil t t))
16320 nil nil nil nil default-prop)))
16322 (defun org-set-property-and-value (use-last)
16323 "Allow to set [PROPERTY]: [value] direction from prompt.
16324 When use-default, don't even ask, just use the last
16325 \"[PROPERTY]: [value]\" string from the history."
16326 (interactive "P")
16327 (let* ((completion-ignore-case t)
16328 (pv (or (and use-last org-last-set-property-value)
16329 (org-completing-read
16330 "Enter a \"[Property]: [value]\" pair: "
16331 nil nil nil nil nil
16332 org-last-set-property-value)))
16333 prop val)
16334 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16335 (setq prop (match-string 1 pv)
16336 val (match-string 2 pv))
16337 (org-set-property prop val))))
16339 (defun org-set-property (property value)
16340 "In the current entry, set PROPERTY to VALUE.
16341 When called interactively, this will prompt for a property name, offering
16342 completion on existing and default properties. And then it will prompt
16343 for a value, offering completion either on allowed values (via an inherited
16344 xxx_ALL property) or on existing values in other instances of this property
16345 in the current file."
16346 (interactive (list nil nil))
16347 (let* ((property (or property (org-read-property-name)))
16348 (value (or value (org-read-property-value property)))
16349 (fn (cdr (assoc property org-properties-postprocess-alist))))
16350 (setq org-last-set-property property)
16351 (setq org-last-set-property-value (concat property ": " value))
16352 ;; Possibly postprocess the inserted value:
16353 (when fn (setq value (funcall fn value)))
16354 (unless (equal (org-entry-get nil property) value)
16355 (org-entry-put nil property value))))
16357 (defun org-find-property (property &optional value)
16358 "Find first entry in buffer that sets PROPERTY.
16360 When optional argument VALUE is non-nil, only consider an entry
16361 if it contains PROPERTY set to this value. If PROPERTY should be
16362 explicitly set to nil, use string \"nil\" for VALUE.
16364 Return position where the entry begins, or nil if there is no
16365 such entry. If narrowing is in effect, only search the visible
16366 part of the buffer."
16367 (save-excursion
16368 (goto-char (point-min))
16369 (let ((case-fold-search t)
16370 (re (org-re-property property nil (not value) value)))
16371 (catch 'exit
16372 (while (re-search-forward re nil t)
16373 (when (if value (org-at-property-p)
16374 (org-entry-get (point) property nil t))
16375 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16377 (defun org-delete-property (property)
16378 "In the current entry, delete PROPERTY."
16379 (interactive
16380 (let* ((completion-ignore-case t)
16381 (cat (org-entry-get (point) "CATEGORY"))
16382 (props0 (org-entry-properties nil 'standard))
16383 (props (if cat props0
16384 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16385 (prop (if (< 1 (length props))
16386 (org-icompleting-read "Property: " props nil t)
16387 (caar props))))
16388 (list prop)))
16389 (if (not property)
16390 (message "No property to delete in this entry")
16391 (org-entry-delete nil property)
16392 (message "Property \"%s\" deleted" property)))
16394 (defun org-delete-property-globally (property)
16395 "Remove PROPERTY globally, from all entries.
16396 This function ignores narrowing, if any."
16397 (interactive
16398 (let* ((completion-ignore-case t)
16399 (prop (org-icompleting-read
16400 "Globally remove property: "
16401 (mapcar #'list (org-buffer-property-keys)))))
16402 (list prop)))
16403 (org-with-wide-buffer
16404 (goto-char (point-min))
16405 (let ((count 0)
16406 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16407 (while (re-search-forward re nil t)
16408 (when (org-entry-delete (point) property) (incf count)))
16409 (message "Property \"%s\" removed from %d entries" property count))))
16411 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16413 (defun org-compute-property-at-point ()
16414 "Compute the property at point.
16415 This looks for an enclosing column format, extracts the operator and
16416 then applies it to the property in the column format's scope."
16417 (interactive)
16418 (unless (org-at-property-p)
16419 (user-error "Not at a property"))
16420 (let ((prop (org-match-string-no-properties 2)))
16421 (org-columns-get-format-and-top-level)
16422 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16423 (user-error "No operator defined for property %s" prop))
16424 (org-columns-compute prop)))
16426 (defvar org-property-allowed-value-functions nil
16427 "Hook for functions supplying allowed values for a specific property.
16428 The functions must take a single argument, the name of the property, and
16429 return a flat list of allowed values. If \":ETC\" is one of
16430 the values, this means that these values are intended as defaults for
16431 completion, but that other values should be allowed too.
16432 The functions must return nil if they are not responsible for this
16433 property.")
16435 (defun org-property-get-allowed-values (pom property &optional table)
16436 "Get allowed values for the property PROPERTY.
16437 When TABLE is non-nil, return an alist that can directly be used for
16438 completion."
16439 (let (vals)
16440 (cond
16441 ((equal property "TODO")
16442 (setq vals (org-with-point-at pom
16443 (append org-todo-keywords-1 '("")))))
16444 ((equal property "PRIORITY")
16445 (let ((n org-lowest-priority))
16446 (while (>= n org-highest-priority)
16447 (push (char-to-string n) vals)
16448 (setq n (1- n)))))
16449 ((equal property "CATEGORY"))
16450 ((member property org-special-properties))
16451 ((setq vals (run-hook-with-args-until-success
16452 'org-property-allowed-value-functions property)))
16454 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16455 (when (and vals (string-match "\\S-" vals))
16456 (setq vals (car (read-from-string (concat "(" vals ")"))))
16457 (setq vals (mapcar (lambda (x)
16458 (cond ((stringp x) x)
16459 ((numberp x) (number-to-string x))
16460 ((symbolp x) (symbol-name x))
16461 (t "???")))
16462 vals)))))
16463 (when (member ":ETC" vals)
16464 (setq vals (remove ":ETC" vals))
16465 (org-add-props (car vals) '(org-unrestricted t)))
16466 (if table (mapcar 'list vals) vals)))
16468 (defun org-property-previous-allowed-value (&optional previous)
16469 "Switch to the next allowed value for this property."
16470 (interactive)
16471 (org-property-next-allowed-value t))
16473 (defun org-property-next-allowed-value (&optional previous)
16474 "Switch to the next allowed value for this property."
16475 (interactive)
16476 (unless (org-at-property-p)
16477 (user-error "Not at a property"))
16478 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16479 (key (match-string 2))
16480 (value (match-string 3))
16481 (allowed (or (org-property-get-allowed-values (point) key)
16482 (and (member value '("[ ]" "[-]" "[X]"))
16483 '("[ ]" "[X]"))))
16484 (heading (save-match-data (nth 4 (org-heading-components))))
16485 nval)
16486 (unless allowed
16487 (user-error "Allowed values for this property have not been defined"))
16488 (when previous (setq allowed (reverse allowed)))
16489 (when (member value allowed)
16490 (setq nval (car (cdr (member value allowed)))))
16491 (setq nval (or nval (car allowed)))
16492 (when (equal nval value)
16493 (user-error "Only one allowed value for this property"))
16494 (org-at-property-p)
16495 (replace-match (concat " :" key ": " nval) t t)
16496 (org-indent-line)
16497 (beginning-of-line 1)
16498 (skip-chars-forward " \t")
16499 (when (equal prop org-effort-property)
16500 (org-refresh-property
16501 '((effort . identity)
16502 (effort-minutes . org-duration-string-to-minutes))
16503 nval)
16504 (when (string= org-clock-current-task heading)
16505 (setq org-clock-effort nval)
16506 (org-clock-update-mode-line)))
16507 (run-hook-with-args 'org-property-changed-functions key nval)))
16509 (defun org-find-olp (path &optional this-buffer)
16510 "Return a marker pointing to the entry at outline path OLP.
16511 If anything goes wrong, throw an error.
16512 You can wrap this call to catch the error like this:
16514 (condition-case msg
16515 (org-mobile-locate-entry (match-string 4))
16516 (error (nth 1 msg)))
16518 The return value will then be either a string with the error message,
16519 or a marker if everything is OK.
16521 If THIS-BUFFER is set, the outline path does not contain a file,
16522 only headings."
16523 (let* ((file (if this-buffer buffer-file-name (pop path)))
16524 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16525 (level 1)
16526 (lmin 1)
16527 (lmax 1)
16528 limit re end found pos heading cnt flevel)
16529 (unless buffer (error "File not found :%s" file))
16530 (with-current-buffer buffer
16531 (save-excursion
16532 (save-restriction
16533 (widen)
16534 (setq limit (point-max))
16535 (goto-char (point-min))
16536 (dolist (heading path)
16537 (setq re (format org-complex-heading-regexp-format
16538 (regexp-quote heading)))
16539 (setq cnt 0 pos (point))
16540 (while (re-search-forward re end t)
16541 (setq level (- (match-end 1) (match-beginning 1)))
16542 (when (and (>= level lmin) (<= level lmax))
16543 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16544 (when (= cnt 0) (error "Heading not found on level %d: %s"
16545 lmax heading))
16546 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16547 lmax heading))
16548 (goto-char found)
16549 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16550 (setq end (save-excursion (org-end-of-subtree t t))))
16551 (when (org-at-heading-p)
16552 (point-marker)))))))
16554 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16555 "Find node HEADING in BUFFER.
16556 Return a marker to the heading if it was found, or nil if not.
16557 If POS-ONLY is set, return just the position instead of a marker.
16559 The heading text must match exact, but it may have a TODO keyword,
16560 a priority cookie and tags in the standard locations."
16561 (with-current-buffer (or buffer (current-buffer))
16562 (save-excursion
16563 (save-restriction
16564 (widen)
16565 (goto-char (point-min))
16566 (let (case-fold-search)
16567 (when (re-search-forward
16568 (format org-complex-heading-regexp-format
16569 (regexp-quote heading)) nil t)
16570 (if pos-only
16571 (match-beginning 0)
16572 (move-marker (make-marker) (match-beginning 0)))))))))
16574 (defun org-find-exact-heading-in-directory (heading &optional dir)
16575 "Find Org node headline HEADING in all .org files in directory DIR.
16576 When the target headline is found, return a marker to this location."
16577 (let ((files (directory-files (or dir default-directory)
16578 t "\\`[^.#].*\\.org\\'"))
16579 visiting m buffer)
16580 (catch 'found
16581 (dolist (file files)
16582 (message "trying %s" file)
16583 (setq visiting (org-find-base-buffer-visiting file))
16584 (setq buffer (or visiting (find-file-noselect file)))
16585 (setq m (org-find-exact-headline-in-buffer
16586 heading buffer))
16587 (when (and (not m) (not visiting)) (kill-buffer buffer))
16588 (and m (throw 'found m))))))
16590 (defun org-find-entry-with-id (ident)
16591 "Locate the entry that contains the ID property with exact value IDENT.
16592 IDENT can be a string, a symbol or a number, this function will search for
16593 the string representation of it.
16594 Return the position where this entry starts, or nil if there is no such entry."
16595 (interactive "sID: ")
16596 (let ((id (cond
16597 ((stringp ident) ident)
16598 ((symbolp ident) (symbol-name ident))
16599 ((numberp ident) (number-to-string ident))
16600 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16601 (org-with-wide-buffer (org-find-property "ID" id))))
16603 ;;;; Timestamps
16605 (defvar org-last-changed-timestamp nil)
16606 (defvar org-last-inserted-timestamp nil
16607 "The last time stamp inserted with `org-insert-time-stamp'.")
16608 (defvar org-ts-what) ; dynamically scoped parameter
16610 (defun org-time-stamp (arg &optional inactive)
16611 "Prompt for a date/time and insert a time stamp.
16613 If the user specifies a time like HH:MM or if this command is
16614 called with at least one prefix argument, the time stamp contains
16615 the date and the time. Otherwise, only the date is included.
16617 All parts of a date not specified by the user are filled in from
16618 the timestamp at point, if any, or the current date/time
16619 otherwise.
16621 If there is already a timestamp at the cursor, it is replaced.
16623 With two universal prefix arguments, insert an active timestamp
16624 with the current time without prompting the user.
16626 When called from lisp, the timestamp is inactive if INACTIVE is
16627 non-nil."
16628 (interactive "P")
16629 (let* ((ts (cond
16630 ((org-at-date-range-p t)
16631 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16632 ((org-at-timestamp-p t) (match-string 0))))
16633 ;; Default time is either the timestamp at point or today.
16634 ;; When entering a range, only the range start is considered.
16635 (default-time (if (not ts) (current-time)
16636 (apply #'encode-time (org-parse-time-string ts))))
16637 (default-input (and ts (org-get-compact-tod ts)))
16638 (repeater (and ts
16639 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16640 (match-string 0 ts)))
16641 org-time-was-given
16642 org-end-time-was-given
16643 (time
16644 (and (if (equal arg '(16)) (current-time)
16645 ;; Preserve `this-command' and `last-command'.
16646 (let ((this-command this-command)
16647 (last-command last-command))
16648 (org-read-date
16649 arg 'totime nil nil default-time default-input
16650 inactive))))))
16651 (cond
16652 ((and ts
16653 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16654 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16655 (insert "--")
16656 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16658 ;; Make sure we're on a timestamp. When in the middle of a date
16659 ;; range, move arbitrarily to range end.
16660 (unless (org-at-timestamp-p t)
16661 (skip-chars-forward "-")
16662 (org-at-timestamp-p t))
16663 (replace-match "")
16664 (setq org-last-changed-timestamp
16665 (org-insert-time-stamp
16666 time (or org-time-was-given arg)
16667 inactive nil nil (list org-end-time-was-given)))
16668 (when repeater
16669 (backward-char)
16670 (insert " " repeater)
16671 (setq org-last-changed-timestamp
16672 (concat (substring org-last-inserted-timestamp 0 -1)
16673 " " repeater ">")))
16674 (message "Timestamp updated"))
16675 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16676 (t (org-insert-time-stamp
16677 time (or org-time-was-given arg) inactive nil nil
16678 (list org-end-time-was-given))))))
16680 ;; FIXME: can we use this for something else, like computing time differences?
16681 (defun org-get-compact-tod (s)
16682 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16683 (let* ((t1 (match-string 1 s))
16684 (h1 (string-to-number (match-string 2 s)))
16685 (m1 (string-to-number (match-string 3 s)))
16686 (t2 (and (match-end 4) (match-string 5 s)))
16687 (h2 (and t2 (string-to-number (match-string 6 s))))
16688 (m2 (and t2 (string-to-number (match-string 7 s))))
16689 dh dm)
16690 (if (not t2)
16692 (setq dh (- h2 h1) dm (- m2 m1))
16693 (when (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16694 (concat t1 "+" (number-to-string dh)
16695 (and (/= 0 dm) (format ":%02d" dm)))))))
16697 (defun org-time-stamp-inactive (&optional arg)
16698 "Insert an inactive time stamp.
16699 An inactive time stamp is enclosed in square brackets instead of angle
16700 brackets. It is inactive in the sense that it does not trigger agenda entries,
16701 does not link to the calendar and cannot be changed with the S-cursor keys.
16702 So these are more for recording a certain time/date."
16703 (interactive "P")
16704 (org-time-stamp arg 'inactive))
16706 (defvar org-date-ovl (make-overlay 1 1))
16707 (overlay-put org-date-ovl 'face 'org-date-selected)
16708 (org-detach-overlay org-date-ovl)
16710 (defvar org-ans1) ; dynamically scoped parameter
16711 (defvar org-ans2) ; dynamically scoped parameter
16713 (defvar org-plain-time-of-day-regexp) ; defined below
16715 (defvar org-overriding-default-time nil) ; dynamically scoped
16716 (defvar org-read-date-overlay nil)
16717 (defvar org-dcst nil) ; dynamically scoped
16718 (defvar org-read-date-history nil)
16719 (defvar org-read-date-final-answer nil)
16720 (defvar org-read-date-analyze-futurep nil)
16721 (defvar org-read-date-analyze-forced-year nil)
16722 (defvar org-read-date-inactive)
16724 (defvar org-read-date-minibuffer-local-map
16725 (let* ((map (make-sparse-keymap)))
16726 (set-keymap-parent map minibuffer-local-map)
16727 (org-defkey map (kbd ".")
16728 (lambda () (interactive)
16729 ;; Are we at the beginning of the prompt?
16730 (if (org-looking-back "^[^:]+: "
16731 (let ((inhibit-field-text-motion t))
16732 (line-beginning-position)))
16733 (org-eval-in-calendar '(calendar-goto-today))
16734 (insert "."))))
16735 (org-defkey map (kbd "C-.")
16736 (lambda () (interactive)
16737 (org-eval-in-calendar '(calendar-goto-today))))
16738 (org-defkey map [(meta shift left)]
16739 (lambda () (interactive)
16740 (org-eval-in-calendar '(calendar-backward-month 1))))
16741 (org-defkey map [(meta shift right)]
16742 (lambda () (interactive)
16743 (org-eval-in-calendar '(calendar-forward-month 1))))
16744 (org-defkey map [(meta shift up)]
16745 (lambda () (interactive)
16746 (org-eval-in-calendar '(calendar-backward-year 1))))
16747 (org-defkey map [(meta shift down)]
16748 (lambda () (interactive)
16749 (org-eval-in-calendar '(calendar-forward-year 1))))
16750 (org-defkey map [?\e (shift left)]
16751 (lambda () (interactive)
16752 (org-eval-in-calendar '(calendar-backward-month 1))))
16753 (org-defkey map [?\e (shift right)]
16754 (lambda () (interactive)
16755 (org-eval-in-calendar '(calendar-forward-month 1))))
16756 (org-defkey map [?\e (shift up)]
16757 (lambda () (interactive)
16758 (org-eval-in-calendar '(calendar-backward-year 1))))
16759 (org-defkey map [?\e (shift down)]
16760 (lambda () (interactive)
16761 (org-eval-in-calendar '(calendar-forward-year 1))))
16762 (org-defkey map [(shift up)]
16763 (lambda () (interactive)
16764 (org-eval-in-calendar '(calendar-backward-week 1))))
16765 (org-defkey map [(shift down)]
16766 (lambda () (interactive)
16767 (org-eval-in-calendar '(calendar-forward-week 1))))
16768 (org-defkey map [(shift left)]
16769 (lambda () (interactive)
16770 (org-eval-in-calendar '(calendar-backward-day 1))))
16771 (org-defkey map [(shift right)]
16772 (lambda () (interactive)
16773 (org-eval-in-calendar '(calendar-forward-day 1))))
16774 (org-defkey map "!"
16775 (lambda () (interactive)
16776 (org-eval-in-calendar '(diary-view-entries))
16777 (message "")))
16778 (org-defkey map ">"
16779 (lambda () (interactive)
16780 (org-eval-in-calendar '(calendar-scroll-left 1))))
16781 (org-defkey map "<"
16782 (lambda () (interactive)
16783 (org-eval-in-calendar '(calendar-scroll-right 1))))
16784 (org-defkey map "\C-v"
16785 (lambda () (interactive)
16786 (org-eval-in-calendar
16787 '(calendar-scroll-left-three-months 1))))
16788 (org-defkey map "\M-v"
16789 (lambda () (interactive)
16790 (org-eval-in-calendar
16791 '(calendar-scroll-right-three-months 1))))
16792 map)
16793 "Keymap for minibuffer commands when using `org-read-date'.")
16795 (defvar org-def)
16796 (defvar org-defdecode)
16797 (defvar org-with-time)
16799 (defun org-read-date (&optional org-with-time to-time from-string prompt
16800 default-time default-input inactive)
16801 "Read a date, possibly a time, and make things smooth for the user.
16802 The prompt will suggest to enter an ISO date, but you can also enter anything
16803 which will at least partially be understood by `parse-time-string'.
16804 Unrecognized parts of the date will default to the current day, month, year,
16805 hour and minute. If this command is called to replace a timestamp at point,
16806 or to enter the second timestamp of a range, the default time is taken
16807 from the existing stamp. Furthermore, the command prefers the future,
16808 so if you are giving a date where the year is not given, and the day-month
16809 combination is already past in the current year, it will assume you
16810 mean next year. For details, see the manual. A few examples:
16812 3-2-5 --> 2003-02-05
16813 feb 15 --> currentyear-02-15
16814 2/15 --> currentyear-02-15
16815 sep 12 9 --> 2009-09-12
16816 12:45 --> today 12:45
16817 22 sept 0:34 --> currentyear-09-22 0:34
16818 12 --> currentyear-currentmonth-12
16819 Fri --> nearest Friday after today
16820 -Tue --> last Tuesday
16821 etc.
16823 Furthermore you can specify a relative date by giving, as the *first* thing
16824 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16825 change in days weeks, months, years.
16826 With a single plus or minus, the date is relative to today. With a double
16827 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16828 +4d --> four days from today
16829 +4 --> same as above
16830 +2w --> two weeks from today
16831 ++5 --> five days from default date
16833 The function understands only English month and weekday abbreviations.
16835 While prompting, a calendar is popped up - you can also select the
16836 date with the mouse (button 1). The calendar shows a period of three
16837 months. To scroll it to other months, use the keys `>' and `<'.
16838 If you don't like the calendar, turn it off with
16839 (setq org-read-date-popup-calendar nil)
16841 With optional argument TO-TIME, the date will immediately be converted
16842 to an internal time.
16843 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16844 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16845 still enter a time, and this function will inform the calling routine
16846 about this change. The calling routine may then choose to change the
16847 format used to insert the time stamp into the buffer to include the time.
16848 With optional argument FROM-STRING, read from this string instead from
16849 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16850 the time/date that is used for everything that is not specified by the
16851 user."
16852 (require 'parse-time)
16853 (let* ((org-time-stamp-rounding-minutes
16854 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16855 (org-dcst org-display-custom-times)
16856 (ct (org-current-time))
16857 (org-def (or org-overriding-default-time default-time ct))
16858 (org-defdecode (decode-time org-def))
16859 (dummy (progn
16860 (when (< (nth 2 org-defdecode) org-extend-today-until)
16861 (setcar (nthcdr 2 org-defdecode) -1)
16862 (setcar (nthcdr 1 org-defdecode) 59)
16863 (setq org-def (apply 'encode-time org-defdecode)
16864 org-defdecode (decode-time org-def)))))
16865 (cur-frame (selected-frame))
16866 (mouse-autoselect-window nil) ; Don't let the mouse jump
16867 (calendar-frame-setup nil)
16868 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16869 (calendar-move-hook nil)
16870 (calendar-view-diary-initially-flag nil)
16871 (calendar-view-holidays-initially-flag nil)
16872 (timestr (format-time-string
16873 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16874 (prompt (concat (if prompt (concat prompt " ") "")
16875 (format "Date+time [%s]: " timestr)))
16876 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16878 (cond
16879 (from-string (setq ans from-string))
16880 (org-read-date-popup-calendar
16881 (save-excursion
16882 (save-window-excursion
16883 (calendar)
16884 (when (eq calendar-setup 'calendar-only)
16885 (setq cal-frame
16886 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16887 (select-frame cal-frame))
16888 (org-eval-in-calendar '(setq cursor-type nil) t)
16889 (unwind-protect
16890 (progn
16891 (calendar-forward-day (- (time-to-days org-def)
16892 (calendar-absolute-from-gregorian
16893 (calendar-current-date))))
16894 (org-eval-in-calendar nil t)
16895 (let* ((old-map (current-local-map))
16896 (map (copy-keymap calendar-mode-map))
16897 (minibuffer-local-map
16898 (copy-keymap org-read-date-minibuffer-local-map)))
16899 (org-defkey map (kbd "RET") 'org-calendar-select)
16900 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16901 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16902 (unwind-protect
16903 (progn
16904 (use-local-map map)
16905 (setq org-read-date-inactive inactive)
16906 (add-hook 'post-command-hook 'org-read-date-display)
16907 (setq org-ans0 (read-string prompt default-input
16908 'org-read-date-history nil))
16909 ;; org-ans0: from prompt
16910 ;; org-ans1: from mouse click
16911 ;; org-ans2: from calendar motion
16912 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16913 (remove-hook 'post-command-hook 'org-read-date-display)
16914 (use-local-map old-map)
16915 (when org-read-date-overlay
16916 (delete-overlay org-read-date-overlay)
16917 (setq org-read-date-overlay nil)))))
16918 (bury-buffer "*Calendar*")
16919 (when cal-frame
16920 (delete-frame cal-frame)
16921 (select-frame-set-input-focus cur-frame))))))
16923 (t ; Naked prompt only
16924 (unwind-protect
16925 (setq ans (read-string prompt default-input
16926 'org-read-date-history timestr))
16927 (when org-read-date-overlay
16928 (delete-overlay org-read-date-overlay)
16929 (setq org-read-date-overlay nil)))))
16931 (setq final (org-read-date-analyze ans org-def org-defdecode))
16933 (when org-read-date-analyze-forced-year
16934 (message "Year was forced into %s"
16935 (if org-read-date-force-compatible-dates
16936 "compatible range (1970-2037)"
16937 "range representable on this machine"))
16938 (ding))
16940 ;; One round trip to get rid of 34th of August and stuff like that....
16941 (setq final (decode-time (apply 'encode-time final)))
16943 (setq org-read-date-final-answer ans)
16945 (if to-time
16946 (apply 'encode-time final)
16947 (if (and (boundp 'org-time-was-given) org-time-was-given)
16948 (format "%04d-%02d-%02d %02d:%02d"
16949 (nth 5 final) (nth 4 final) (nth 3 final)
16950 (nth 2 final) (nth 1 final))
16951 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16953 (defun org-read-date-display ()
16954 "Display the current date prompt interpretation in the minibuffer."
16955 (when org-read-date-display-live
16956 (when org-read-date-overlay
16957 (delete-overlay org-read-date-overlay))
16958 (when (minibufferp (current-buffer))
16959 (save-excursion
16960 (end-of-line 1)
16961 (while (not (equal (buffer-substring
16962 (max (point-min) (- (point) 4)) (point))
16963 " "))
16964 (insert " ")))
16965 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16966 " " (or org-ans1 org-ans2)))
16967 (org-end-time-was-given nil)
16968 (f (org-read-date-analyze ans org-def org-defdecode))
16969 (fmts (if org-dcst
16970 org-time-stamp-custom-formats
16971 org-time-stamp-formats))
16972 (fmt (if (or org-with-time
16973 (and (boundp 'org-time-was-given) org-time-was-given))
16974 (cdr fmts)
16975 (car fmts)))
16976 (txt (format-time-string fmt (apply 'encode-time f)))
16977 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16978 (txt (concat "=> " txt)))
16979 (when (and org-end-time-was-given
16980 (string-match org-plain-time-of-day-regexp txt))
16981 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16982 org-end-time-was-given
16983 (substring txt (match-end 0)))))
16984 (when org-read-date-analyze-futurep
16985 (setq txt (concat txt " (=>F)")))
16986 (setq org-read-date-overlay
16987 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16988 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16990 (defun org-read-date-analyze (ans org-def org-defdecode)
16991 "Analyze the combined answer of the date prompt."
16992 ;; FIXME: cleanup and comment
16993 ;; Pass `current-time' result to `decode-time' (instead of calling
16994 ;; without arguments) so that only `current-time' has to be
16995 ;; overriden in tests.
16996 (let ((nowdecode (decode-time (current-time)))
16997 delta deltan deltaw deltadef year month day
16998 hour minute second wday pm h2 m2 tl wday1
16999 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
17000 (setq org-read-date-analyze-futurep nil
17001 org-read-date-analyze-forced-year nil)
17002 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17003 (setq ans "+0"))
17005 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17006 (setq ans (replace-match "" t t ans)
17007 deltan (car delta)
17008 deltaw (nth 1 delta)
17009 deltadef (nth 2 delta)))
17011 ;; Check if there is an iso week date in there. If yes, store the
17012 ;; info and postpone interpreting it until the rest of the parsing
17013 ;; is done.
17014 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17015 (setq iso-year (when (match-end 1)
17016 (org-small-year-to-year
17017 (string-to-number (match-string 1 ans))))
17018 iso-weekday (when (match-end 3)
17019 (string-to-number (match-string 3 ans)))
17020 iso-week (string-to-number (match-string 2 ans)))
17021 (setq ans (replace-match "" t t ans)))
17023 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17024 (when (string-match
17025 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17026 (setq year (if (match-end 2)
17027 (string-to-number (match-string 2 ans))
17028 (progn (setq kill-year t)
17029 (string-to-number (format-time-string "%Y"))))
17030 month (string-to-number (match-string 3 ans))
17031 day (string-to-number (match-string 4 ans)))
17032 (when (< year 100) (setq year (+ 2000 year)))
17033 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17034 t nil ans)))
17036 ;; Help matching dotted european dates
17037 (when (string-match
17038 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17039 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17040 (setq kill-year t)
17041 (string-to-number (format-time-string "%Y")))
17042 day (string-to-number (match-string 1 ans))
17043 month (string-to-number (match-string 2 ans))
17044 ans (replace-match (format "%04d-%02d-%02d" year month day)
17045 t nil ans)))
17047 ;; Help matching american dates, like 5/30 or 5/30/7
17048 (when (string-match
17049 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17050 (setq year (if (match-end 4)
17051 (string-to-number (match-string 4 ans))
17052 (progn (setq kill-year t)
17053 (string-to-number (format-time-string "%Y"))))
17054 month (string-to-number (match-string 1 ans))
17055 day (string-to-number (match-string 2 ans)))
17056 (when (< year 100) (setq year (+ 2000 year)))
17057 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17058 t nil ans)))
17059 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17060 ;; If there is a time with am/pm, and *no* time without it, we convert
17061 ;; so that matching will be successful.
17062 (loop for i from 1 to 2 do ; twice, for end time as well
17063 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17064 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17065 (setq hour (string-to-number (match-string 1 ans))
17066 minute (if (match-end 3)
17067 (string-to-number (match-string 3 ans))
17069 pm (equal ?p
17070 (string-to-char (downcase (match-string 4 ans)))))
17071 (if (and (= hour 12) (not pm))
17072 (setq hour 0)
17073 (when (and pm (< hour 12)) (setq hour (+ 12 hour))))
17074 (setq ans (replace-match (format "%02d:%02d" hour minute)
17075 t t ans))))
17077 ;; Check if a time range is given as a duration
17078 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17079 (setq hour (string-to-number (match-string 1 ans))
17080 h2 (+ hour (string-to-number (match-string 3 ans)))
17081 minute (string-to-number (match-string 2 ans))
17082 m2 (+ minute (if (match-end 5) (string-to-number
17083 (match-string 5 ans))0)))
17084 (when (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17085 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17086 t t ans)))
17088 ;; Check if there is a time range
17089 (when (boundp 'org-end-time-was-given)
17090 (setq org-time-was-given nil)
17091 (when (and (string-match org-plain-time-of-day-regexp ans)
17092 (match-end 8))
17093 (setq org-end-time-was-given (match-string 8 ans))
17094 (setq ans (concat (substring ans 0 (match-beginning 7))
17095 (substring ans (match-end 7))))))
17097 (setq tl (parse-time-string ans)
17098 day (or (nth 3 tl) (nth 3 org-defdecode))
17099 month
17100 (cond ((nth 4 tl))
17101 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17102 ;; Day was specified. Make sure DAY+MONTH
17103 ;; combination happens in the future.
17104 ((nth 3 tl)
17105 (setq futurep t)
17106 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17107 (nth 4 nowdecode)))
17108 (t (nth 4 org-defdecode)))
17109 year
17110 (cond ((and (not kill-year) (nth 5 tl)))
17111 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17112 ;; Month was guessed in the future and is at least
17113 ;; equal to NOWDECODE's. Fix year accordingly.
17114 (futurep
17115 (if (or (> month (nth 4 nowdecode))
17116 (>= day (nth 3 nowdecode)))
17117 (nth 5 nowdecode)
17118 (1+ (nth 5 nowdecode))))
17119 ;; Month was specified. Make sure MONTH+YEAR
17120 ;; combination happens in the future.
17121 ((nth 4 tl)
17122 (setq futurep t)
17123 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17124 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17125 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17126 (t (nth 5 nowdecode))))
17127 (t (nth 5 org-defdecode)))
17128 hour (or (nth 2 tl) (nth 2 org-defdecode))
17129 minute (or (nth 1 tl) (nth 1 org-defdecode))
17130 second (or (nth 0 tl) 0)
17131 wday (nth 6 tl))
17133 (when (and (eq org-read-date-prefer-future 'time)
17134 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17135 (equal day (nth 3 nowdecode))
17136 (equal month (nth 4 nowdecode))
17137 (equal year (nth 5 nowdecode))
17138 (nth 2 tl)
17139 (or (< (nth 2 tl) (nth 2 nowdecode))
17140 (and (= (nth 2 tl) (nth 2 nowdecode))
17141 (nth 1 tl)
17142 (< (nth 1 tl) (nth 1 nowdecode)))))
17143 (setq day (1+ day)
17144 futurep t))
17146 ;; Special date definitions below
17147 (cond
17148 (iso-week
17149 ;; There was an iso week
17150 (require 'cal-iso)
17151 (setq futurep nil)
17152 (setq year (or iso-year year)
17153 day (or iso-weekday wday 1)
17154 wday nil ; to make sure that the trigger below does not match
17155 iso-date (calendar-gregorian-from-absolute
17156 (calendar-iso-to-absolute
17157 (list iso-week day year))))
17158 ; FIXME: Should we also push ISO weeks into the future?
17159 ; (when (and org-read-date-prefer-future
17160 ; (not iso-year)
17161 ; (< (calendar-absolute-from-gregorian iso-date)
17162 ; (time-to-days (current-time))))
17163 ; (setq year (1+ year)
17164 ; iso-date (calendar-gregorian-from-absolute
17165 ; (calendar-iso-to-absolute
17166 ; (list iso-week day year)))))
17167 (setq month (car iso-date)
17168 year (nth 2 iso-date)
17169 day (nth 1 iso-date)))
17170 (deltan
17171 (setq futurep nil)
17172 (unless deltadef
17173 ;; Pass `current-time' result to `decode-time' (instead of
17174 ;; calling without arguments) so that only `current-time' has
17175 ;; to be overriden in tests.
17176 (let ((now (decode-time (current-time))))
17177 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17178 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17179 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17180 ((equal deltaw "m") (setq month (+ month deltan)))
17181 ((equal deltaw "y") (setq year (+ year deltan)))))
17182 ((and wday (not (nth 3 tl)))
17183 ;; Weekday was given, but no day, so pick that day in the week
17184 ;; on or after the derived date.
17185 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17186 (unless (equal wday wday1)
17187 (setq day (+ day (% (- wday wday1 -7) 7))))))
17188 (when (and (boundp 'org-time-was-given)
17189 (nth 2 tl))
17190 (setq org-time-was-given t))
17191 (when (< year 100) (setq year (+ 2000 year)))
17192 ;; Check of the date is representable
17193 (if org-read-date-force-compatible-dates
17194 (progn
17195 (when (< year 1970)
17196 (setq year 1970 org-read-date-analyze-forced-year t))
17197 (when (> year 2037)
17198 (setq year 2037 org-read-date-analyze-forced-year t)))
17199 (condition-case nil
17200 (ignore (encode-time second minute hour day month year))
17201 (error
17202 (setq year (nth 5 org-defdecode))
17203 (setq org-read-date-analyze-forced-year t))))
17204 (setq org-read-date-analyze-futurep futurep)
17205 (list second minute hour day month year)))
17207 (defvar parse-time-weekdays)
17208 (defun org-read-date-get-relative (s today default)
17209 "Check string S for special relative date string.
17210 TODAY and DEFAULT are internal times, for today and for a default.
17211 Return shift list (N what def-flag)
17212 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17213 N is the number of WHATs to shift.
17214 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17215 the DEFAULT date rather than TODAY."
17216 (require 'parse-time)
17217 (when (and
17218 (string-match
17219 (concat
17220 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17221 "\\([0-9]+\\)?"
17222 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17223 "\\([ \t]\\|$\\)") s)
17224 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17225 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17226 (string-to-char (substring (match-string 1 s) -1))
17227 ?+))
17228 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17229 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17230 (what (if (match-end 3) (match-string 3 s) "d"))
17231 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17232 (date (if rel default today))
17233 (wday (nth 6 (decode-time date)))
17234 delta)
17235 (if wday1
17236 (progn
17237 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17238 (when (= delta 0) (setq delta 7))
17239 (when (= dir ?-)
17240 (setq delta (- delta 7))
17241 (when (= delta 0) (setq delta -7)))
17242 (when (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17243 (list delta "d" rel))
17244 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17246 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17247 "Turn a user-specified date into the internal representation.
17248 The internal representation needed by the calendar is (month day year).
17249 This is a wrapper to handle the brain-dead convention in calendar that
17250 user function argument order change dependent on argument order."
17251 (if (boundp 'calendar-date-style)
17252 (cond
17253 ((eq calendar-date-style 'american)
17254 (list arg1 arg2 arg3))
17255 ((eq calendar-date-style 'european)
17256 (list arg2 arg1 arg3))
17257 ((eq calendar-date-style 'iso)
17258 (list arg2 arg3 arg1)))
17259 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17260 (if (org-bound-and-true-p european-calendar-style)
17261 (list arg2 arg1 arg3)
17262 (list arg1 arg2 arg3)))))
17264 (defun org-eval-in-calendar (form &optional keepdate)
17265 "Eval FORM in the calendar window and return to current window.
17266 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17267 otherwise stick to the current value of `org-ans2'."
17268 (let ((sf (selected-frame))
17269 (sw (selected-window)))
17270 (select-window (get-buffer-window "*Calendar*" t))
17271 (eval form)
17272 (when (and (not keepdate) (calendar-cursor-to-date))
17273 (let* ((date (calendar-cursor-to-date))
17274 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17275 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17276 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17277 (select-window sw)
17278 (org-select-frame-set-input-focus sf)))
17280 (defun org-calendar-select ()
17281 "Return to `org-read-date' with the date currently selected.
17282 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17283 (interactive)
17284 (when (calendar-cursor-to-date)
17285 (let* ((date (calendar-cursor-to-date))
17286 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17287 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17288 (when (active-minibuffer-window) (exit-minibuffer))))
17290 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17291 "Insert a date stamp for the date given by the internal TIME.
17292 See `format-time-string' for the format of TIME.
17293 WITH-HM means use the stamp format that includes the time of the day.
17294 INACTIVE means use square brackets instead of angular ones, so that the
17295 stamp will not contribute to the agenda.
17296 PRE and POST are optional strings to be inserted before and after the
17297 stamp.
17298 The command returns the inserted time stamp."
17299 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17300 stamp)
17301 (when inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17302 (insert-before-markers (or pre ""))
17303 (when (listp extra)
17304 (setq extra (car extra))
17305 (if (and (stringp extra)
17306 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17307 (setq extra (format "-%02d:%02d"
17308 (string-to-number (match-string 1 extra))
17309 (string-to-number (match-string 2 extra))))
17310 (setq extra nil)))
17311 (when extra
17312 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17313 (insert-before-markers (setq stamp (format-time-string fmt time)))
17314 (insert-before-markers (or post ""))
17315 (setq org-last-inserted-timestamp stamp)))
17317 (defun org-toggle-time-stamp-overlays ()
17318 "Toggle the use of custom time stamp formats."
17319 (interactive)
17320 (setq org-display-custom-times (not org-display-custom-times))
17321 (unless org-display-custom-times
17322 (let ((p (point-min)) (bmp (buffer-modified-p)))
17323 (while (setq p (next-single-property-change p 'display))
17324 (when (and (get-text-property p 'display)
17325 (eq (get-text-property p 'face) 'org-date))
17326 (remove-text-properties
17327 p (setq p (next-single-property-change p 'display))
17328 '(display t))))
17329 (set-buffer-modified-p bmp)))
17330 (when (featurep 'xemacs)
17331 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17332 (org-restart-font-lock)
17333 (setq org-table-may-need-update t)
17334 (if org-display-custom-times
17335 (message "Time stamps are overlaid with custom format")
17336 (message "Time stamp overlays removed")))
17338 (defun org-display-custom-time (beg end)
17339 "Overlay modified time stamp format over timestamp between BEG and END."
17340 (let* ((ts (buffer-substring beg end))
17341 t1 w1 with-hm tf time str w2 (off 0))
17342 (save-match-data
17343 (setq t1 (org-parse-time-string ts t))
17344 (when (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17345 (setq off (- (match-end 0) (match-beginning 0)))))
17346 (setq end (- end off))
17347 (setq w1 (- end beg)
17348 with-hm (and (nth 1 t1) (nth 2 t1))
17349 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17350 time (org-fix-decoded-time t1)
17351 str (org-add-props
17352 (format-time-string
17353 (substring tf 1 -1) (apply 'encode-time time))
17354 nil 'mouse-face 'highlight)
17355 w2 (length str))
17356 (unless (= w2 w1)
17357 (add-text-properties (1+ beg) (+ 2 beg)
17358 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17359 (if (featurep 'xemacs)
17360 (progn
17361 (put-text-property beg end 'invisible t)
17362 (put-text-property beg end 'end-glyph (make-glyph str)))
17363 (put-text-property beg end 'display str))))
17365 (defun org-fix-decoded-time (time)
17366 "Set 0 instead of nil for the first 6 elements of time.
17367 Don't touch the rest."
17368 (let ((n 0))
17369 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17371 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17373 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17374 "Difference between TIMESTAMP-STRING and now in days.
17375 If SECONDS is non-nil, return the difference in seconds."
17376 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17377 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17378 (funcall fdiff (current-time)))))
17380 (defun org-deadline-close (timestamp-string &optional ndays)
17381 "Is the time in TIMESTAMP-STRING close to the current date?"
17382 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17383 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17384 (not (org-entry-is-done-p))))
17386 (defun org-get-wdays (ts &optional delay zero-delay)
17387 "Get the deadline lead time appropriate for timestring TS.
17388 When DELAY is non-nil, get the delay time for scheduled items
17389 instead of the deadline lead time. When ZERO-DELAY is non-nil
17390 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17391 don't try to find the delay cookie in the scheduled timestamp."
17392 (let ((tv (if delay org-scheduled-delay-days
17393 org-deadline-warning-days)))
17394 (cond
17395 ((or (and delay (< tv 0))
17396 (and delay zero-delay (<= tv 0))
17397 (and (not delay) (<= tv 0)))
17398 ;; Enforce this value no matter what
17399 (- tv))
17400 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17401 ;; lead time is specified.
17402 (floor (* (string-to-number (match-string 1 ts))
17403 (cdr (assoc (match-string 2 ts)
17404 '(("d" . 1) ("w" . 7)
17405 ("m" . 30.4) ("y" . 365.25)
17406 ("h" . 0.041667)))))))
17407 ;; go for the default.
17408 (t tv))))
17410 (defun org-calendar-select-mouse (ev)
17411 "Return to `org-read-date' with the date currently selected.
17412 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17413 (interactive "e")
17414 (mouse-set-point ev)
17415 (when (calendar-cursor-to-date)
17416 (let* ((date (calendar-cursor-to-date))
17417 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17418 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17419 (when (active-minibuffer-window) (exit-minibuffer))))
17421 (defun org-check-deadlines (ndays)
17422 "Check if there are any deadlines due or past due.
17423 A deadline is considered due if it happens within `org-deadline-warning-days'
17424 days from today's date. If the deadline appears in an entry marked DONE,
17425 it is not shown. The prefix arg NDAYS can be used to test that many
17426 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17427 (interactive "P")
17428 (let* ((org-warn-days
17429 (cond
17430 ((equal ndays '(4)) 100000)
17431 (ndays (prefix-numeric-value ndays))
17432 (t (abs org-deadline-warning-days))))
17433 (case-fold-search nil)
17434 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17435 (callback
17436 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17437 (message "%d deadlines past-due or due within %d days"
17438 (org-occur regexp nil callback)
17439 org-warn-days)))
17441 (defsubst org-re-timestamp (type)
17442 "Return a regexp for timestamp TYPE.
17443 Allowed values for TYPE are:
17445 all: all timestamps
17446 active: only active timestamps (<...>)
17447 inactive: only inactive timestamps ([...])
17448 scheduled: only scheduled timestamps
17449 deadline: only deadline timestamps
17450 closed: only closed time-stamps
17452 When TYPE is nil, fall back on returning a regexp that matches
17453 both scheduled and deadline timestamps."
17454 (case type
17455 (all org-ts-regexp-both)
17456 (active org-ts-regexp)
17457 (inactive org-ts-regexp-inactive)
17458 (scheduled org-scheduled-time-regexp)
17459 (deadline org-deadline-time-regexp)
17460 (closed org-closed-time-regexp)
17461 (otherwise
17462 (concat "\\<"
17463 (regexp-opt (list org-deadline-string org-scheduled-string))
17464 " *<\\([^>]+\\)>"))))
17466 (defun org-check-before-date (date)
17467 "Check if there are deadlines or scheduled entries before DATE."
17468 (interactive (list (org-read-date)))
17469 (let ((case-fold-search nil)
17470 (regexp (org-re-timestamp org-ts-type))
17471 (callback
17472 `(lambda ()
17473 (let ((match (match-string 1)))
17474 (and ,(if (memq org-ts-type '(active inactive all))
17475 '(eq (org-element-type (org-element-context)) 'timestamp)
17476 '(org-at-planning-p))
17477 (time-less-p
17478 (org-time-string-to-time match)
17479 (org-time-string-to-time date)))))))
17480 (message "%d entries before %s"
17481 (org-occur regexp nil callback) date)))
17483 (defun org-check-after-date (date)
17484 "Check if there are deadlines or scheduled entries after DATE."
17485 (interactive (list (org-read-date)))
17486 (let ((case-fold-search nil)
17487 (regexp (org-re-timestamp org-ts-type))
17488 (callback
17489 `(lambda ()
17490 (let ((match (match-string 1)))
17491 (and ,(if (memq org-ts-type '(active inactive all))
17492 '(eq (org-element-type (org-element-context)) 'timestamp)
17493 '(org-at-planning-p))
17494 (not (time-less-p
17495 (org-time-string-to-time match)
17496 (org-time-string-to-time date))))))))
17497 (message "%d entries after %s"
17498 (org-occur regexp nil callback) date)))
17500 (defun org-check-dates-range (start-date end-date)
17501 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17502 (interactive (list (org-read-date nil nil nil "Range starts")
17503 (org-read-date nil nil nil "Range end")))
17504 (let ((case-fold-search nil)
17505 (regexp (org-re-timestamp org-ts-type))
17506 (callback
17507 `(lambda ()
17508 (let ((match (match-string 1)))
17509 (and
17510 ,(if (memq org-ts-type '(active inactive all))
17511 '(eq (org-element-type (org-element-context)) 'timestamp)
17512 '(org-at-planning-p))
17513 (not (time-less-p
17514 (org-time-string-to-time match)
17515 (org-time-string-to-time start-date)))
17516 (time-less-p
17517 (org-time-string-to-time match)
17518 (org-time-string-to-time end-date)))))))
17519 (message "%d entries between %s and %s"
17520 (org-occur regexp nil callback) start-date end-date)))
17522 (defun org-evaluate-time-range (&optional to-buffer)
17523 "Evaluate a time range by computing the difference between start and end.
17524 Normally the result is just printed in the echo area, but with prefix arg
17525 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17526 If the time range is actually in a table, the result is inserted into the
17527 next column.
17528 For time difference computation, a year is assumed to be exactly 365
17529 days in order to avoid rounding problems."
17530 (interactive "P")
17532 (org-clock-update-time-maybe)
17533 (save-excursion
17534 (unless (org-at-date-range-p t)
17535 (goto-char (point-at-bol))
17536 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17537 (unless (org-at-date-range-p t)
17538 (user-error "Not at a time-stamp range, and none found in current line")))
17539 (let* ((ts1 (match-string 1))
17540 (ts2 (match-string 2))
17541 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17542 (match-end (match-end 0))
17543 (time1 (org-time-string-to-time ts1))
17544 (time2 (org-time-string-to-time ts2))
17545 (t1 (org-float-time time1))
17546 (t2 (org-float-time time2))
17547 (diff (abs (- t2 t1)))
17548 (negative (< (- t2 t1) 0))
17549 ;; (ys (floor (* 365 24 60 60)))
17550 (ds (* 24 60 60))
17551 (hs (* 60 60))
17552 (fy "%dy %dd %02d:%02d")
17553 (fy1 "%dy %dd")
17554 (fd "%dd %02d:%02d")
17555 (fd1 "%dd")
17556 (fh "%02d:%02d")
17557 y d h m align)
17558 (if havetime
17559 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17561 d (floor (/ diff ds)) diff (mod diff ds)
17562 h (floor (/ diff hs)) diff (mod diff hs)
17563 m (floor (/ diff 60)))
17564 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17566 d (floor (+ (/ diff ds) 0.5))
17567 h 0 m 0))
17568 (if (not to-buffer)
17569 (message "%s" (org-make-tdiff-string y d h m))
17570 (if (org-at-table-p)
17571 (progn
17572 (goto-char match-end)
17573 (setq align t)
17574 (and (looking-at " *|") (goto-char (match-end 0))))
17575 (goto-char match-end))
17576 (when (looking-at
17577 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17578 (replace-match ""))
17579 (when negative (insert " -"))
17580 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17581 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17582 (insert " " (format fh h m))))
17583 (when align (org-table-align))
17584 (message "Time difference inserted")))))
17586 (defun org-make-tdiff-string (y d h m)
17587 (let ((fmt "")
17588 (l nil))
17589 (when (> y 0)
17590 (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " "))
17591 (push y l))
17592 (when (> d 0)
17593 (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " "))
17594 (push d l))
17595 (when (> h 0)
17596 (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " "))
17597 (push h l))
17598 (when (> m 0)
17599 (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " "))
17600 (push m l))
17601 (apply 'format fmt (nreverse l))))
17603 (defun org-time-string-to-time (s &optional buffer pos)
17604 "Convert a timestamp string into internal time."
17605 (condition-case errdata
17606 (apply 'encode-time (org-parse-time-string s))
17607 (error (error "Bad timestamp `%s'%s\nError was: %s"
17608 s (if (not (and buffer pos))
17610 (format-message " at %d in buffer `%s'" pos buffer))
17611 (cdr errdata)))))
17613 (defun org-time-string-to-seconds (s)
17614 "Convert a timestamp string to a number of seconds."
17615 (org-float-time (org-time-string-to-time s)))
17617 (org-define-error 'org-diary-sexp-no-match "Unable to match diary sexp")
17619 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17620 "Convert time stamp S to an absolute day number.
17622 If DAYNR in non-nil, and there is a specifier for a cyclic time
17623 stamp, get the closest date to DAYNR. If PREFER is
17624 `past' (respectively `future') return a date past (respectively
17625 after) or equal to DAYNR.
17627 POS is the location of time stamp S, as a buffer position in
17628 BUFFER.
17630 Diary sexp timestamps are matched against DAYNR, when non-nil.
17631 If matching fails or DAYNR is nil, `org-diary-sexp-no-match' is
17632 signalled."
17633 (cond
17634 ((string-match "\\`%%\\((.*)\\)" s)
17635 ;; Sexp timestamp: try to match DAYNR, if available, since we're
17636 ;; only able to match individual dates. If it fails, raise an
17637 ;; error.
17638 (if (and daynr
17639 (org-diary-sexp-entry
17640 (match-string 1 s) "" (calendar-gregorian-from-absolute daynr)))
17641 daynr
17642 (signal 'org-diary-sexp-no-match (list s))))
17643 ((and daynr show-all) (org-closest-date s daynr prefer))
17644 (t (time-to-days
17645 (condition-case errdata
17646 (apply #'encode-time (org-parse-time-string s))
17647 (error (error "Bad timestamp `%s'%s\nError was: %s"
17649 (if (not (and buffer pos)) ""
17650 (format-message " at %d in buffer `%s'" pos buffer))
17651 (cdr errdata))))))))
17653 (defun org-days-to-iso-week (days)
17654 "Return the iso week number."
17655 (require 'cal-iso)
17656 (car (calendar-iso-from-absolute days)))
17658 (defun org-small-year-to-year (year)
17659 "Convert 2-digit years into 4-digit years.
17660 YEAR is expanded into one of the 30 next years, if possible, or
17661 into a past one. Any year larger than 99 is returned unchanged."
17662 (if (>= year 100) year
17663 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17664 (century (/ current 100))
17665 (offset (- year (% current 100))))
17666 (cond ((> offset 30) (+ (* (1- century) 100) year))
17667 ((> offset -70) (+ (* century 100) year))
17668 (t (+ (* (1+ century) 100) year))))))
17670 (defun org-time-from-absolute (d)
17671 "Return the time corresponding to date D.
17672 D may be an absolute day number, or a calendar-type list (month day year)."
17673 (when (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17674 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17676 (defun org-calendar-holiday ()
17677 "List of holidays, for Diary display in Org-mode."
17678 (require 'holidays)
17679 (let ((hl (funcall
17680 (if (fboundp 'calendar-check-holidays)
17681 'calendar-check-holidays 'check-calendar-holidays) date)))
17682 (when hl (mapconcat 'identity hl "; "))))
17684 (defun org-diary-sexp-entry (sexp entry date)
17685 "Process a SEXP diary ENTRY for DATE."
17686 (require 'diary-lib)
17687 (let ((result (if calendar-debug-sexp
17688 (let ((stack-trace-on-error t))
17689 (eval (car (read-from-string sexp))))
17690 (condition-case nil
17691 (eval (car (read-from-string sexp)))
17692 (error
17693 (beep)
17694 (message "Bad sexp at line %d in %s: %s"
17695 (org-current-line)
17696 (buffer-file-name) sexp)
17697 (sleep-for 2))))))
17698 (cond ((stringp result) (split-string result "; "))
17699 ((and (consp result)
17700 (not (consp (cdr result)))
17701 (stringp (cdr result))) (cdr result))
17702 ((and (consp result)
17703 (stringp (car result))) result)
17704 (result entry))))
17706 (defun org-diary-to-ical-string (frombuf)
17707 "Get iCalendar entries from diary entries in buffer FROMBUF.
17708 This uses the icalendar.el library."
17709 (let* ((tmpdir (if (featurep 'xemacs)
17710 (temp-directory)
17711 temporary-file-directory))
17712 (tmpfile (make-temp-name
17713 (expand-file-name "orgics" tmpdir)))
17714 buf rtn b e)
17715 (with-current-buffer frombuf
17716 (icalendar-export-region (point-min) (point-max) tmpfile)
17717 (setq buf (find-buffer-visiting tmpfile))
17718 (set-buffer buf)
17719 (goto-char (point-min))
17720 (when (re-search-forward "^BEGIN:VEVENT" nil t)
17721 (setq b (match-beginning 0)))
17722 (goto-char (point-max))
17723 (when (re-search-backward "^END:VEVENT" nil t)
17724 (setq e (match-end 0)))
17725 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17726 (kill-buffer buf)
17727 (delete-file tmpfile)
17728 rtn))
17730 (defun org-closest-date (start current prefer)
17731 "Return closest date to CURRENT starting from START.
17733 CURRENT and START are both time stamps.
17735 When PREFER is `past', return a date that is either CURRENT or
17736 past. When PREFER is `future', return a date that is either
17737 CURRENT or future.
17739 Only time stamps with a repeater are modified. Any other time
17740 stamp stay unchanged. In any case, return value is an absolute
17741 day number."
17742 (if (not (string-match "\\+\\([0-9]+\\)\\([hdwmy]\\)" start))
17743 ;; No repeater. Do not shift time stamp.
17744 (time-to-days (apply #'encode-time (org-parse-time-string start)))
17745 (let ((value (string-to-number (match-string 1 start)))
17746 (type (match-string 2 start)))
17747 (if (= 0 value)
17748 ;; Repeater with a 0-value is considered as void.
17749 (time-to-days (apply #'encode-time (org-parse-time-string start)))
17750 (let* ((base (org-date-to-gregorian start))
17751 (target (org-date-to-gregorian current))
17752 (sday (calendar-absolute-from-gregorian base))
17753 (cday (calendar-absolute-from-gregorian target))
17754 n1 n2)
17755 ;; If START is already past CURRENT, just return START.
17756 (if (<= cday sday) sday
17757 ;; Compute closest date before (N1) and closest date past
17758 ;; (N2) CURRENT.
17759 (pcase type
17760 ("h"
17761 (let ((missing-hours
17762 (mod (+ (- (* 24 (- cday sday))
17763 (nth 2 (org-parse-time-string start)))
17764 org-extend-today-until)
17765 value)))
17766 (setf n1 (if (= missing-hours 0) cday
17767 (- cday (1+ (/ missing-hours 24)))))
17768 (setf n2 (+ cday (/ (- value missing-hours) 24)))))
17769 ((or "d" "w")
17770 (let ((value (if (equal type "w") (* 7 value) value)))
17771 (setf n1 (+ sday (* value (/ (- cday sday) value))))
17772 (setf n2 (+ n1 value))))
17773 ("m"
17774 (let* ((add-months
17775 (lambda (date n)
17776 ;; Add N months to gregorian DATE, i.e.,
17777 ;; a list (MONTH DAY YEAR). Return a valid
17778 ;; gregorian date.
17779 (let ((m (+ (nth 0 date) n)))
17780 (list (mod m 12)
17781 (nth 1 date)
17782 (+ (/ m 12) (nth 2 date))))))
17783 (months ; Complete months to TARGET.
17784 (* (/ (+ (* 12 (- (nth 2 target) (nth 2 base)))
17785 (- (nth 0 target) (nth 0 base))
17786 ;; If START's day is greater than
17787 ;; TARGET's, remove incomplete month.
17788 (if (> (nth 1 target) (nth 1 base)) 0 -1))
17789 value)
17790 value))
17791 (before (funcall add-months base months)))
17792 (setf n1 (calendar-absolute-from-gregorian before))
17793 (setf n2
17794 (calendar-absolute-from-gregorian
17795 (funcall add-months before value)))))
17797 (let* ((d (nth 1 base))
17798 (m (nth 0 base))
17799 (y (nth 2 base))
17800 (years ; Complete years to TARGET.
17801 (* (/ (- (nth 2 target)
17803 ;; If START's month and day are
17804 ;; greater than TARGET's, remove
17805 ;; incomplete year.
17806 (if (or (> (nth 0 target) m)
17807 (and (= (nth 0 target) m)
17808 (> (nth 1 target) d)))
17811 value)
17812 value))
17813 (before (list m d (+ y years))))
17814 (setf n1 (calendar-absolute-from-gregorian before))
17815 (setf n2 (calendar-absolute-from-gregorian
17816 (list m d (+ (nth 2 before) value)))))))
17817 ;; Handle PREFER parameter, if any.
17818 (cond
17819 ((eq prefer 'past) (if (= cday n2) n2 n1))
17820 ((eq prefer 'future) (if (= cday n1) n1 n2))
17821 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))))))))
17823 (defun org-date-to-gregorian (date)
17824 "Turn any specification of DATE into a Gregorian date for the calendar."
17825 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17826 ((and (listp date) (= (length date) 3)) date)
17827 ((stringp date)
17828 (setq date (org-parse-time-string date))
17829 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17830 ((listp date)
17831 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17833 (defun org-parse-time-string (s &optional nodefault)
17834 "Parse the standard Org-mode time string.
17835 This should be a lot faster than the normal `parse-time-string'.
17836 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17837 hour and minute fields will be nil if not given."
17838 (cond ((string-match org-ts-regexp0 s)
17839 (list 0
17840 (when (or (match-beginning 8) (not nodefault))
17841 (string-to-number (or (match-string 8 s) "0")))
17842 (when (or (match-beginning 7) (not nodefault))
17843 (string-to-number (or (match-string 7 s) "0")))
17844 (string-to-number (match-string 4 s))
17845 (string-to-number (match-string 3 s))
17846 (string-to-number (match-string 2 s))
17847 nil nil nil))
17848 ((string-match "^<[^>]+>$" s)
17849 (decode-time (seconds-to-time (org-matcher-time s))))
17850 (t (error "Not a standard Org-mode time string: %s" s))))
17852 (defun org-timestamp-up (&optional arg)
17853 "Increase the date item at the cursor by one.
17854 If the cursor is on the year, change the year. If it is on the month,
17855 the day or the time, change that.
17856 With prefix ARG, change by that many units."
17857 (interactive "p")
17858 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17860 (defun org-timestamp-down (&optional arg)
17861 "Decrease the date item at the cursor by one.
17862 If the cursor is on the year, change the year. If it is on the month,
17863 the day or the time, change that.
17864 With prefix ARG, change by that many units."
17865 (interactive "p")
17866 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17868 (defun org-timestamp-up-day (&optional arg)
17869 "Increase the date in the time stamp by one day.
17870 With prefix ARG, change that many days."
17871 (interactive "p")
17872 (if (and (not (org-at-timestamp-p t))
17873 (org-at-heading-p))
17874 (org-todo 'up)
17875 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17877 (defun org-timestamp-down-day (&optional arg)
17878 "Decrease the date in the time stamp by one day.
17879 With prefix ARG, change that many days."
17880 (interactive "p")
17881 (if (and (not (org-at-timestamp-p t))
17882 (org-at-heading-p))
17883 (org-todo 'down)
17884 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17886 (defun org-at-timestamp-p (&optional inactive-ok)
17887 "Non-nil if point is inside a timestamp.
17889 When optional argument INACTIVE-OK is non-nil, also consider
17890 inactive timestamps.
17892 When this function returns a non-nil value, match data is set
17893 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
17894 INACTIVE-OK."
17895 (interactive)
17896 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17897 (pos (point))
17898 (ans (or (looking-at tsr)
17899 (save-excursion
17900 (skip-chars-backward "^[<\n\r\t")
17901 (when (> (point) (point-min)) (backward-char 1))
17902 (and (looking-at tsr)
17903 (> (- (match-end 0) pos) -1))))))
17904 (and ans
17905 (boundp 'org-ts-what)
17906 (setq org-ts-what
17907 (cond
17908 ((= pos (match-beginning 0)) 'bracket)
17909 ;; Point is considered to be "on the bracket" whether
17910 ;; it's really on it or right after it.
17911 ((= pos (1- (match-end 0))) 'bracket)
17912 ((= pos (match-end 0)) 'after)
17913 ((org-pos-in-match-range pos 2) 'year)
17914 ((org-pos-in-match-range pos 3) 'month)
17915 ((org-pos-in-match-range pos 7) 'hour)
17916 ((org-pos-in-match-range pos 8) 'minute)
17917 ((or (org-pos-in-match-range pos 4)
17918 (org-pos-in-match-range pos 5)) 'day)
17919 ((and (> pos (or (match-end 8) (match-end 5)))
17920 (< pos (match-end 0)))
17921 (- pos (or (match-end 8) (match-end 5))))
17922 (t 'day))))
17923 ans))
17925 (defun org-toggle-timestamp-type ()
17926 "Toggle the type (<active> or [inactive]) of a time stamp."
17927 (interactive)
17928 (when (org-at-timestamp-p t)
17929 (let ((beg (match-beginning 0)) (end (match-end 0))
17930 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17931 (save-excursion
17932 (goto-char beg)
17933 (while (re-search-forward "[][<>]" end t)
17934 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17935 t t)))
17936 (message "Timestamp is now %sactive"
17937 (if (equal (char-after beg) ?<) "" "in")))))
17939 (defun org-at-clock-log-p nil
17940 "Is the cursor on the clock log line?"
17941 (save-excursion
17942 (move-beginning-of-line 1)
17943 (looking-at org-clock-line-re)))
17945 (defvar org-clock-history) ; defined in org-clock.el
17946 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17947 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17948 "Change the date in the time stamp at point.
17949 The date will be changed by N times WHAT. WHAT can be `day', `month',
17950 `year', `minute', `second'. If WHAT is not given, the cursor position
17951 in the timestamp determines what will be changed.
17952 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17953 (let ((origin (point)) origin-cat
17954 with-hm inactive
17955 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17956 org-ts-what
17957 extra rem
17958 ts time time0 fixnext clrgx)
17959 (unless (org-at-timestamp-p t)
17960 (user-error "Not at a timestamp"))
17961 (if (and (not what) (eq org-ts-what 'bracket))
17962 (org-toggle-timestamp-type)
17963 ;; Point isn't on brackets. Remember the part of the time-stamp
17964 ;; the point was in. Indeed, size of time-stamps may change,
17965 ;; but point must be kept in the same category nonetheless.
17966 (setq origin-cat org-ts-what)
17967 (when (and (not what) (not (eq org-ts-what 'day))
17968 org-display-custom-times
17969 (get-text-property (point) 'display)
17970 (not (get-text-property (1- (point)) 'display)))
17971 (setq org-ts-what 'day))
17972 (setq org-ts-what (or what org-ts-what)
17973 inactive (= (char-after (match-beginning 0)) ?\[)
17974 ts (match-string 0))
17975 (replace-match "")
17976 (when (string-match
17977 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17979 (setq extra (match-string 1 ts))
17980 (when suppress-tmp-delay
17981 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17982 (when (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17983 (setq with-hm t))
17984 (setq time0 (org-parse-time-string ts))
17985 (when (and updown
17986 (eq org-ts-what 'minute)
17987 (not current-prefix-arg))
17988 ;; This looks like s-up and s-down. Change by one rounding step.
17989 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17990 (unless (= 0 (setq rem (% (nth 1 time0) dm)))
17991 (setcar (cdr time0) (+ (nth 1 time0)
17992 (if (> n 0) (- rem) (- dm rem))))))
17993 (setq time
17994 (encode-time (or (car time0) 0)
17995 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17996 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17997 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17998 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17999 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
18000 (nthcdr 6 time0)))
18001 (when (and (member org-ts-what '(hour minute))
18002 extra
18003 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
18004 (setq extra (org-modify-ts-extra
18005 extra
18006 (if (eq org-ts-what 'hour) 2 5)
18007 n dm)))
18008 (when (integerp org-ts-what)
18009 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
18010 (when (eq what 'calendar)
18011 (let ((cal-date (org-get-date-from-calendar)))
18012 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
18013 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
18014 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
18015 (setcar time0 (or (car time0) 0))
18016 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18017 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18018 (setq time (apply 'encode-time time0))))
18019 ;; Insert the new time-stamp, and ensure point stays in the same
18020 ;; category as before (i.e. not after the last position in that
18021 ;; category).
18022 (let ((pos (point)))
18023 ;; Stay before inserted string. `save-excursion' is of no use.
18024 (setq org-last-changed-timestamp
18025 (org-insert-time-stamp time with-hm inactive nil nil extra))
18026 (goto-char pos))
18027 (save-match-data
18028 (looking-at org-ts-regexp3)
18029 (goto-char (cond
18030 ;; `day' category ends before `hour' if any, or at
18031 ;; the end of the day name.
18032 ((eq origin-cat 'day)
18033 (min (or (match-beginning 7) (1- (match-end 5))) origin))
18034 ((eq origin-cat 'hour) (min (match-end 7) origin))
18035 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
18036 ((integerp origin-cat) (min (1- (match-end 0)) origin))
18037 ;; `year' and `month' have both fixed size: point
18038 ;; couldn't have moved into another part.
18039 (t origin))))
18040 ;; Update clock if on a CLOCK line.
18041 (org-clock-update-time-maybe)
18042 ;; Maybe adjust the closest clock in `org-clock-history'
18043 (when org-clock-adjust-closest
18044 (if (not (and (org-at-clock-log-p)
18045 (< 1 (length (delq nil (mapcar 'marker-position
18046 org-clock-history))))))
18047 (message "No clock to adjust")
18048 (cond ((save-excursion ; fix previous clock?
18049 (re-search-backward org-ts-regexp0 nil t)
18050 (org-looking-back (concat org-clock-string " \\[")
18051 (line-beginning-position)))
18052 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18053 ((save-excursion ; fix next clock?
18054 (re-search-backward org-ts-regexp0 nil t)
18055 (looking-at (concat org-ts-regexp0 "\\] =>")))
18056 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18057 (save-window-excursion
18058 ;; Find closest clock to point, adjust the previous/next one in history
18059 (let* ((p (save-excursion (org-back-to-heading t)))
18060 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18061 (clfixnth
18062 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18063 (clfixpos (unless (> 0 clfixnth) (nth clfixnth org-clock-history))))
18064 (if (not clfixpos)
18065 (message "No clock to adjust")
18066 (save-excursion
18067 (org-goto-marker-or-bmk clfixpos)
18068 (org-show-subtree)
18069 (when (re-search-forward clrgx nil t)
18070 (goto-char (match-beginning 1))
18071 (let (org-clock-adjust-closest)
18072 (org-timestamp-change n org-ts-what updown))
18073 (message "Clock adjusted in %s for heading: %s"
18074 (file-name-nondirectory (buffer-file-name))
18075 (org-get-heading t t)))))))))
18076 ;; Try to recenter the calendar window, if any.
18077 (when (and org-calendar-follow-timestamp-change
18078 (get-buffer-window "*Calendar*" t)
18079 (memq org-ts-what '(day month year)))
18080 (org-recenter-calendar (time-to-days time))))))
18082 (defun org-modify-ts-extra (s pos n dm)
18083 "Change the different parts of the lead-time and repeat fields in timestamp."
18084 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18085 ng h m new rem)
18086 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18087 (cond
18088 ((or (org-pos-in-match-range pos 2)
18089 (org-pos-in-match-range pos 3))
18090 (setq m (string-to-number (match-string 3 s))
18091 h (string-to-number (match-string 2 s)))
18092 (if (org-pos-in-match-range pos 2)
18093 (setq h (+ h n))
18094 (setq n (* dm (org-no-warnings (signum n))))
18095 (unless (= 0 (setq rem (% m dm)))
18096 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18097 (setq m (+ m n)))
18098 (when (< m 0) (setq m (+ m 60) h (1- h)))
18099 (when (> m 59) (setq m (- m 60) h (1+ h)))
18100 (setq h (mod h 24))
18101 (setq ng 1 new (format "-%02d:%02d" h m)))
18102 ((org-pos-in-match-range pos 6)
18103 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18104 ((org-pos-in-match-range pos 5)
18105 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18107 ((org-pos-in-match-range pos 9)
18108 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18109 ((org-pos-in-match-range pos 8)
18110 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18112 (when ng
18113 (setq s (concat
18114 (substring s 0 (match-beginning ng))
18116 (substring s (match-end ng))))))
18119 (defun org-recenter-calendar (date)
18120 "If the calendar is visible, recenter it to DATE."
18121 (let ((cwin (get-buffer-window "*Calendar*" t)))
18122 (when cwin
18123 (let ((calendar-move-hook nil))
18124 (with-selected-window cwin
18125 (calendar-goto-date (if (listp date) date
18126 (calendar-gregorian-from-absolute date))))))))
18128 (defun org-goto-calendar (&optional arg)
18129 "Go to the Emacs calendar at the current date.
18130 If there is a time stamp in the current line, go to that date.
18131 A prefix ARG can be used to force the current date."
18132 (interactive "P")
18133 (let ((tsr org-ts-regexp) diff
18134 (calendar-move-hook nil)
18135 (calendar-view-holidays-initially-flag nil)
18136 (calendar-view-diary-initially-flag nil))
18137 (when (or (org-at-timestamp-p)
18138 (save-excursion
18139 (beginning-of-line 1)
18140 (looking-at (concat ".*" tsr))))
18141 (let ((d1 (time-to-days (current-time)))
18142 (d2 (time-to-days
18143 (org-time-string-to-time (match-string 1)))))
18144 (setq diff (- d2 d1))))
18145 (calendar)
18146 (calendar-goto-today)
18147 (when (and diff (not arg)) (calendar-forward-day diff))))
18149 (defun org-get-date-from-calendar ()
18150 "Return a list (month day year) of date at point in calendar."
18151 (with-current-buffer "*Calendar*"
18152 (save-match-data
18153 (calendar-cursor-to-date))))
18155 (defun org-date-from-calendar ()
18156 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18157 If there is already a time stamp at the cursor position, update it."
18158 (interactive)
18159 (if (org-at-timestamp-p t)
18160 (org-timestamp-change 0 'calendar)
18161 (let ((cal-date (org-get-date-from-calendar)))
18162 (org-insert-time-stamp
18163 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18165 (defcustom org-effort-durations
18166 `(("min" . 1)
18167 ("h" . 60)
18168 ("d" . ,(* 60 8))
18169 ("w" . ,(* 60 8 5))
18170 ("m" . ,(* 60 8 5 4))
18171 ("y" . ,(* 60 8 5 40)))
18172 "Conversion factor to minutes for an effort modifier.
18174 Each entry has the form (MODIFIER . MINUTES).
18176 In an effort string, a number followed by MODIFIER is multiplied
18177 by the specified number of MINUTES to obtain an effort in
18178 minutes.
18180 For example, if the value of this variable is ((\"hours\" . 60)), then an
18181 effort string \"2hours\" is equivalent to 120 minutes."
18182 :group 'org-agenda
18183 :version "25.1"
18184 :package-version '(Org . "8.3")
18185 :type '(alist :key-type (string :tag "Modifier")
18186 :value-type (number :tag "Minutes")))
18188 (defun org-minutes-to-clocksum-string (m)
18189 "Format number of minutes as a clocksum string.
18190 The format is determined by `org-time-clocksum-format',
18191 `org-time-clocksum-use-fractional' and
18192 `org-time-clocksum-fractional-format' and
18193 `org-time-clocksum-use-effort-durations'."
18194 (let ((clocksum "")
18195 (m (round m)) ; Don't allow fractions of minutes
18196 h d w mo y fmt n)
18197 (setq h (if org-time-clocksum-use-effort-durations
18198 (cdr (assoc "h" org-effort-durations)) 60)
18199 d (if org-time-clocksum-use-effort-durations
18200 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18201 w (if org-time-clocksum-use-effort-durations
18202 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18203 mo (if org-time-clocksum-use-effort-durations
18204 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18205 y (if org-time-clocksum-use-effort-durations
18206 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18207 ;; fractional format
18208 (if org-time-clocksum-use-fractional
18209 (cond
18210 ;; single format string
18211 ((stringp org-time-clocksum-fractional-format)
18212 (format org-time-clocksum-fractional-format (/ m (float h))))
18213 ;; choice of fractional formats for different time units
18214 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18215 (> (/ (truncate m) (* y d h)) 0))
18216 (format fmt (/ m (* y d (float h)))))
18217 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18218 (> (/ (truncate m) (* mo d h)) 0))
18219 (format fmt (/ m (* mo d (float h)))))
18220 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18221 (> (/ (truncate m) (* w d h)) 0))
18222 (format fmt (/ m (* w d (float h)))))
18223 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18224 (> (/ (truncate m) (* d h)) 0))
18225 (format fmt (/ m (* d (float h)))))
18226 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18227 (> (/ (truncate m) h) 0))
18228 (format fmt (/ m (float h))))
18229 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18230 (format fmt m))
18231 ;; fall back to smallest time unit with a format
18232 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18233 (format fmt (/ m (float h))))
18234 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18235 (format fmt (/ m (* d (float h)))))
18236 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18237 (format fmt (/ m (* w d (float h)))))
18238 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18239 (format fmt (/ m (* mo d (float h)))))
18240 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18241 (format fmt (/ m (* y d (float h))))))
18242 ;; standard (non-fractional) format, with single format string
18243 (if (stringp org-time-clocksum-format)
18244 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18245 ;; separate formats components
18246 (and (setq fmt (plist-get org-time-clocksum-format :years))
18247 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18248 (plist-get org-time-clocksum-format :require-years))
18249 (setq clocksum (concat clocksum (format fmt n))
18250 m (- m (* n y d h))))
18251 (and (setq fmt (plist-get org-time-clocksum-format :months))
18252 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18253 (plist-get org-time-clocksum-format :require-months))
18254 (setq clocksum (concat clocksum (format fmt n))
18255 m (- m (* n mo d h))))
18256 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18257 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18258 (plist-get org-time-clocksum-format :require-weeks))
18259 (setq clocksum (concat clocksum (format fmt n))
18260 m (- m (* n w d h))))
18261 (and (setq fmt (plist-get org-time-clocksum-format :days))
18262 (or (> (setq n (/ (truncate m) (* d h))) 0)
18263 (plist-get org-time-clocksum-format :require-days))
18264 (setq clocksum (concat clocksum (format fmt n))
18265 m (- m (* n d h))))
18266 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18267 (or (> (setq n (/ (truncate m) h)) 0)
18268 (plist-get org-time-clocksum-format :require-hours))
18269 (setq clocksum (concat clocksum (format fmt n))
18270 m (- m (* n h))))
18271 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18272 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18273 (setq clocksum (concat clocksum (format fmt m))))
18274 ;; return formatted time duration
18275 clocksum))))
18277 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18278 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18279 "Org mode version 8.0")
18281 (defun org-hours-to-clocksum-string (n)
18282 (org-minutes-to-clocksum-string (* n 60)))
18284 (defun org-hh:mm-string-to-minutes (s)
18285 "Convert a string H:MM to a number of minutes.
18286 If the string is just a number, interpret it as minutes.
18287 In fact, the first hh:mm or number in the string will be taken,
18288 there can be extra stuff in the string.
18289 If no number is found, the return value is 0."
18290 (cond
18291 ((integerp s) s)
18292 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18293 (+ (* (string-to-number (match-string 1 s)) 60)
18294 (string-to-number (match-string 2 s))))
18295 ((string-match "\\([0-9]+\\)" s)
18296 (string-to-number (match-string 1 s)))
18297 (t 0)))
18299 (defcustom org-image-actual-width t
18300 "Should we use the actual width of images when inlining them?
18302 When set to t, always use the image width.
18304 When set to a number, use imagemagick (when available) to set
18305 the image's width to this value.
18307 When set to a number in a list, try to get the width from any
18308 #+ATTR.* keyword if it matches a width specification like
18310 #+ATTR_HTML: :width 300px
18312 and fall back on that number if none is found.
18314 When set to nil, try to get the width from an #+ATTR.* keyword
18315 and fall back on the original width if none is found.
18317 This requires Emacs >= 24.1, build with imagemagick support."
18318 :group 'org-appearance
18319 :version "24.4"
18320 :package-version '(Org . "8.0")
18321 :type '(choice
18322 (const :tag "Use the image width" t)
18323 (integer :tag "Use a number of pixels")
18324 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18325 (const :tag "Use #+ATTR* or don't resize" nil)))
18327 (defcustom org-agenda-inhibit-startup nil
18328 "Inhibit startup when preparing agenda buffers.
18329 When this variable is t, the initialization of the Org agenda
18330 buffers is inhibited: e.g. the visibility state is not set, the
18331 tables are not re-aligned, etc."
18332 :type 'boolean
18333 :version "24.3"
18334 :group 'org-agenda)
18336 (define-obsolete-variable-alias
18337 'org-agenda-ignore-drawer-properties
18338 'org-agenda-ignore-properties "25.1")
18340 (defcustom org-agenda-ignore-properties nil
18341 "Avoid updating text properties when building the agenda.
18342 Properties are used to prepare buffers for effort estimates,
18343 appointments, statistics and subtree-local categories.
18344 If you don't use these in the agenda, you can add them to this
18345 list and agenda building will be a bit faster.
18346 The value is a list, with zero or more of the symbols `effort', `appt',
18347 `stats' or `category'."
18348 :type '(set :greedy t
18349 (const effort)
18350 (const appt)
18351 (const stats)
18352 (const category))
18353 :version "25.1"
18354 :package-version '(Org . "8.3")
18355 :group 'org-agenda)
18357 (defun org-duration-string-to-minutes (s &optional output-to-string)
18358 "Convert a duration string S to minutes.
18360 A bare number is interpreted as minutes, modifiers can be set by
18361 customizing `org-effort-durations' (which see).
18363 Entries containing a colon are interpreted as H:MM by
18364 `org-hh:mm-string-to-minutes'."
18365 (let ((result 0)
18366 (re (concat "\\([0-9.]+\\) *\\("
18367 (regexp-opt (mapcar 'car org-effort-durations))
18368 "\\)")))
18369 (while (string-match re s)
18370 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18371 (string-to-number (match-string 1 s))))
18372 (setq s (replace-match "" nil t s)))
18373 (setq result (floor result))
18374 (incf result (org-hh:mm-string-to-minutes s))
18375 (if output-to-string (number-to-string result) result)))
18377 ;;;; Files
18379 (defun org-save-all-org-buffers ()
18380 "Save all Org-mode buffers without user confirmation."
18381 (interactive)
18382 (message "Saving all Org-mode buffers...")
18383 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18384 (when (featurep 'org-id) (org-id-locations-save))
18385 (message "Saving all Org-mode buffers... done"))
18387 (defun org-revert-all-org-buffers ()
18388 "Revert all Org-mode buffers.
18389 Prompt for confirmation when there are unsaved changes.
18390 Be sure you know what you are doing before letting this function
18391 overwrite your changes.
18393 This function is useful in a setup where one tracks org files
18394 with a version control system, to revert on one machine after pulling
18395 changes from another. I believe the procedure must be like this:
18397 1. M-x org-save-all-org-buffers
18398 2. Pull changes from the other machine, resolve conflicts
18399 3. M-x org-revert-all-org-buffers"
18400 (interactive)
18401 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18402 (user-error "Abort"))
18403 (save-excursion
18404 (save-window-excursion
18405 (mapc
18406 (lambda (b)
18407 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18408 (with-current-buffer b buffer-file-name))
18409 (org-pop-to-buffer-same-window b)
18410 (revert-buffer t 'no-confirm)))
18411 (buffer-list))
18412 (when (and (featurep 'org-id) org-id-track-globally)
18413 (org-id-locations-load)))))
18415 ;;;; Agenda files
18417 ;;;###autoload
18418 (defun org-switchb (&optional arg)
18419 "Switch between Org buffers.
18420 With one prefix argument, restrict available buffers to files.
18421 With two prefix arguments, restrict available buffers to agenda files.
18423 Defaults to `iswitchb' for buffer name completion.
18424 Set `org-completion-use-ido' to make it use ido instead."
18425 (interactive "P")
18426 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18427 ((equal arg '(16)) (org-buffer-list 'agenda))
18428 (t (org-buffer-list))))
18429 (org-completion-use-iswitchb org-completion-use-iswitchb)
18430 (org-completion-use-ido org-completion-use-ido))
18431 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18432 (setq org-completion-use-iswitchb t))
18433 (org-pop-to-buffer-same-window
18434 (org-icompleting-read "Org buffer: "
18435 (mapcar 'list (mapcar 'buffer-name blist))
18436 nil t))))
18438 ;;; Define some older names previously used for this functionality
18439 ;;;###autoload
18440 (defalias 'org-ido-switchb 'org-switchb)
18441 ;;;###autoload
18442 (defalias 'org-iswitchb 'org-switchb)
18444 (defun org-buffer-list (&optional predicate exclude-tmp)
18445 "Return a list of Org buffers.
18446 PREDICATE can be `export', `files' or `agenda'.
18448 export restrict the list to Export buffers.
18449 files restrict the list to buffers visiting Org files.
18450 agenda restrict the list to buffers visiting agenda files.
18452 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18453 (let* ((bfn nil)
18454 (agenda-files (and (eq predicate 'agenda)
18455 (mapcar 'file-truename (org-agenda-files t))))
18456 (filter
18457 (cond
18458 ((eq predicate 'files)
18459 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18460 ((eq predicate 'export)
18461 (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
18462 ((eq predicate 'agenda)
18463 (lambda (b)
18464 (with-current-buffer b
18465 (and (derived-mode-p 'org-mode)
18466 (setq bfn (buffer-file-name b))
18467 (member (file-truename bfn) agenda-files)))))
18468 (t (lambda (b) (with-current-buffer b
18469 (or (derived-mode-p 'org-mode)
18470 (string-match "\\*Org .*Export"
18471 (buffer-name b)))))))))
18472 (delq nil
18473 (mapcar
18474 (lambda(b)
18475 (if (and (funcall filter b)
18476 (or (not exclude-tmp)
18477 (not (string-match "tmp" (buffer-name b)))))
18479 nil))
18480 (buffer-list)))))
18482 (defun org-agenda-files (&optional unrestricted archives)
18483 "Get the list of agenda files.
18484 Optional UNRESTRICTED means return the full list even if a restriction
18485 is currently in place.
18486 When ARCHIVES is t, include all archive files that are really being
18487 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18488 `org-agenda-archives-mode' is t."
18489 (let ((files
18490 (cond
18491 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18492 ((stringp org-agenda-files) (org-read-agenda-file-list))
18493 ((listp org-agenda-files) org-agenda-files)
18494 (t (error "Invalid value of `org-agenda-files'")))))
18495 (setq files (apply 'append
18496 (mapcar (lambda (f)
18497 (if (file-directory-p f)
18498 (directory-files
18499 f t org-agenda-file-regexp)
18500 (list f)))
18501 files)))
18502 (when org-agenda-skip-unavailable-files
18503 (setq files (delq nil
18504 (mapcar (function
18505 (lambda (file)
18506 (and (file-readable-p file) file)))
18507 files))))
18508 (when (or (eq archives t)
18509 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18510 (setq files (org-add-archive-files files)))
18511 files))
18513 (defun org-agenda-file-p (&optional file)
18514 "Return non-nil, if FILE is an agenda file.
18515 If FILE is omitted, use the file associated with the current
18516 buffer."
18517 (let ((fname (or file (buffer-file-name))))
18518 (and fname
18519 (member (file-truename fname)
18520 (mapcar #'file-truename (org-agenda-files t))))))
18522 (defun org-edit-agenda-file-list ()
18523 "Edit the list of agenda files.
18524 Depending on setup, this either uses customize to edit the variable
18525 `org-agenda-files', or it visits the file that is holding the list. In the
18526 latter case, the buffer is set up in a way that saving it automatically kills
18527 the buffer and restores the previous window configuration."
18528 (interactive)
18529 (if (stringp org-agenda-files)
18530 (let ((cw (current-window-configuration)))
18531 (find-file org-agenda-files)
18532 (setq-local org-window-configuration cw)
18533 (org-add-hook 'after-save-hook
18534 (lambda ()
18535 (set-window-configuration
18536 (prog1 org-window-configuration
18537 (kill-buffer (current-buffer))))
18538 (org-install-agenda-files-menu)
18539 (message "New agenda file list installed"))
18540 nil 'local)
18541 (message "%s" (substitute-command-keys
18542 "Edit list and finish with \\[save-buffer]")))
18543 (customize-variable 'org-agenda-files)))
18545 (defun org-store-new-agenda-file-list (list)
18546 "Set new value for the agenda file list and save it correctly."
18547 (if (stringp org-agenda-files)
18548 (let ((fe (org-read-agenda-file-list t)) b u)
18549 (while (setq b (find-buffer-visiting org-agenda-files))
18550 (kill-buffer b))
18551 (with-temp-file org-agenda-files
18552 (insert
18553 (mapconcat
18554 (lambda (f) ;; Keep un-expanded entries.
18555 (if (setq u (assoc f fe))
18556 (cdr u)
18558 list "\n")
18559 "\n")))
18560 (let ((org-mode-hook nil) (org-inhibit-startup t)
18561 (org-insert-mode-line-in-empty-file nil))
18562 (setq org-agenda-files list)
18563 (customize-save-variable 'org-agenda-files org-agenda-files))))
18565 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18566 "Read the list of agenda files from a file.
18567 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18568 filenames, used by `org-store-new-agenda-file-list' to write back
18569 un-expanded file names."
18570 (when (file-directory-p org-agenda-files)
18571 (error "`org-agenda-files' cannot be a single directory"))
18572 (when (stringp org-agenda-files)
18573 (with-temp-buffer
18574 (insert-file-contents org-agenda-files)
18575 (mapcar
18576 (lambda (f)
18577 (let ((e (expand-file-name (substitute-in-file-name f)
18578 org-directory)))
18579 (if pair-with-expansion
18580 (cons e f)
18581 e)))
18582 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18584 ;;;###autoload
18585 (defun org-cycle-agenda-files ()
18586 "Cycle through the files in `org-agenda-files'.
18587 If the current buffer visits an agenda file, find the next one in the list.
18588 If the current buffer does not, find the first agenda file."
18589 (interactive)
18590 (let* ((fs (or (org-agenda-files t)
18591 (user-error "No agenda files")))
18592 (files (copy-sequence fs))
18593 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18594 file)
18595 (when tcf
18596 (while (and (setq file (pop files))
18597 (not (equal (file-truename file) tcf)))))
18598 (find-file (car (or files fs)))
18599 (when (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18601 (defun org-agenda-file-to-front (&optional to-end)
18602 "Move/add the current file to the top of the agenda file list.
18603 If the file is not present in the list, it is added to the front. If it is
18604 present, it is moved there. With optional argument TO-END, add/move to the
18605 end of the list."
18606 (interactive "P")
18607 (let ((org-agenda-skip-unavailable-files nil)
18608 (file-alist (mapcar (lambda (x)
18609 (cons (file-truename x) x))
18610 (org-agenda-files t)))
18611 (ctf (file-truename
18612 (or buffer-file-name
18613 (user-error "Please save the current buffer to a file"))))
18614 x had)
18615 (setq x (assoc ctf file-alist) had x)
18617 (unless x (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18618 (if to-end
18619 (setq file-alist (append (delq x file-alist) (list x)))
18620 (setq file-alist (cons x (delq x file-alist))))
18621 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18622 (org-install-agenda-files-menu)
18623 (message "File %s to %s of agenda file list"
18624 (if had "moved" "added") (if to-end "end" "front"))))
18626 (defun org-remove-file (&optional file)
18627 "Remove current file from the list of files in variable `org-agenda-files'.
18628 These are the files which are being checked for agenda entries.
18629 Optional argument FILE means use this file instead of the current."
18630 (interactive)
18631 (let* ((org-agenda-skip-unavailable-files nil)
18632 (file (or file buffer-file-name
18633 (user-error "Current buffer does not visit a file")))
18634 (true-file (file-truename file))
18635 (afile (abbreviate-file-name file))
18636 (files (delq nil (mapcar
18637 (lambda (x)
18638 (unless (equal true-file
18639 (file-truename x))
18641 (org-agenda-files t)))))
18642 (if (not (= (length files) (length (org-agenda-files t))))
18643 (progn
18644 (org-store-new-agenda-file-list files)
18645 (org-install-agenda-files-menu)
18646 (message "Removed from Org Agenda list: %s" afile))
18647 (message "File was not in list: %s (not removed)" afile))))
18649 (defun org-file-menu-entry (file)
18650 (vector file (list 'find-file file) t))
18652 (defun org-check-agenda-file (file)
18653 "Make sure FILE exists. If not, ask user what to do."
18654 (unless (file-exists-p file)
18655 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18656 (abbreviate-file-name file))
18657 (let ((r (downcase (read-char-exclusive))))
18658 (cond
18659 ((equal r ?r)
18660 (org-remove-file file)
18661 (throw 'nextfile t))
18662 (t (user-error "Abort"))))))
18664 (defun org-get-agenda-file-buffer (file)
18665 "Get an agenda buffer visiting FILE.
18666 If the buffer needs to be created, add it to the list of buffers
18667 which might be released later."
18668 (let ((buf (org-find-base-buffer-visiting file)))
18669 (if buf
18670 buf ; just return it
18671 ;; Make a new buffer and remember it
18672 (setq buf (find-file-noselect file))
18673 (when buf (push buf org-agenda-new-buffers))
18674 buf)))
18676 (defun org-release-buffers (blist)
18677 "Release all buffers in list, asking the user for confirmation when needed.
18678 When a buffer is unmodified, it is just killed. When modified, it is saved
18679 \(if the user agrees) and then killed."
18680 (let (file)
18681 (dolist (buf blist)
18682 (setq file (buffer-file-name buf))
18683 (when (and (buffer-modified-p buf)
18684 file
18685 (y-or-n-p (format "Save file %s? " file)))
18686 (with-current-buffer buf (save-buffer)))
18687 (kill-buffer buf))))
18689 (defun org-agenda-prepare-buffers (files)
18690 "Create buffers for all agenda files, protect archived trees and comments."
18691 (interactive)
18692 (let ((pa '(:org-archived t))
18693 (pc '(:org-comment t))
18694 (pall '(:org-archived t :org-comment t))
18695 (inhibit-read-only t)
18696 (org-inhibit-startup org-agenda-inhibit-startup)
18697 (rea (concat ":" org-archive-tag ":"))
18698 file re pos)
18699 (setq org-tag-alist-for-agenda nil
18700 org-tag-groups-alist-for-agenda nil)
18701 (save-excursion
18702 (save-restriction
18703 (dolist (file files)
18704 (catch 'nextfile
18705 (if (bufferp file)
18706 (set-buffer file)
18707 (org-check-agenda-file file)
18708 (set-buffer (org-get-agenda-file-buffer file)))
18709 (widen)
18710 (org-set-regexps-and-options 'tags-only)
18711 (setq pos (point))
18712 (or (memq 'category org-agenda-ignore-properties)
18713 (org-refresh-category-properties))
18714 (or (memq 'stats org-agenda-ignore-properties)
18715 (org-refresh-stats-properties))
18716 (or (memq 'effort org-agenda-ignore-properties)
18717 (org-refresh-effort-properties))
18718 (or (memq 'appt org-agenda-ignore-properties)
18719 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18720 (setq org-todo-keywords-for-agenda
18721 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18722 (setq org-done-keywords-for-agenda
18723 (append org-done-keywords-for-agenda org-done-keywords))
18724 (setq org-todo-keyword-alist-for-agenda
18725 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18726 (setq org-tag-alist-for-agenda
18727 (org-uniquify
18728 (append org-tag-alist-for-agenda
18729 org-tag-alist
18730 org-tag-persistent-alist)))
18731 (when org-group-tags
18732 (setq org-tag-groups-alist-for-agenda
18733 (org-uniquify-alist
18734 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18735 (org-with-silent-modifications
18736 (save-excursion
18737 (remove-text-properties (point-min) (point-max) pall)
18738 (when org-agenda-skip-archived-trees
18739 (goto-char (point-min))
18740 (while (re-search-forward rea nil t)
18741 (when (org-at-heading-p t)
18742 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18743 (goto-char (point-min))
18744 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18745 (while (re-search-forward re nil t)
18746 (when (save-match-data (org-in-commented-heading-p t))
18747 (add-text-properties
18748 (match-beginning 0) (org-end-of-subtree t) pc)))))
18749 (goto-char pos)))))
18750 (setq org-todo-keywords-for-agenda
18751 (org-uniquify org-todo-keywords-for-agenda))
18752 (setq org-todo-keyword-alist-for-agenda
18753 (org-uniquify org-todo-keyword-alist-for-agenda))))
18756 ;;;; CDLaTeX minor mode
18758 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18759 "Keymap for the minor `org-cdlatex-mode'.")
18761 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18762 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18763 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18764 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18765 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18767 (defvar org-cdlatex-texmathp-advice-is-done nil
18768 "Flag remembering if we have applied the advice to texmathp already.")
18770 (define-minor-mode org-cdlatex-mode
18771 "Toggle the minor `org-cdlatex-mode'.
18772 This mode supports entering LaTeX environment and math in LaTeX fragments
18773 in Org-mode.
18774 \\{org-cdlatex-mode-map}"
18775 nil " OCDL" nil
18776 (when org-cdlatex-mode
18777 (require 'cdlatex)
18778 (run-hooks 'cdlatex-mode-hook)
18779 (cdlatex-compute-tables))
18780 (unless org-cdlatex-texmathp-advice-is-done
18781 (setq org-cdlatex-texmathp-advice-is-done t)
18782 (defadvice texmathp (around org-math-always-on activate)
18783 "Always return t in org-mode buffers.
18784 This is because we want to insert math symbols without dollars even outside
18785 the LaTeX math segments. If Orgmode thinks that point is actually inside
18786 an embedded LaTeX fragment, let texmathp do its job.
18787 \\[org-cdlatex-mode-map]"
18788 (interactive)
18789 (let (p)
18790 (cond
18791 ((not (derived-mode-p 'org-mode)) ad-do-it)
18792 ((eq this-command 'cdlatex-math-symbol)
18793 (setq ad-return-value t
18794 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18796 (let ((p (org-inside-LaTeX-fragment-p)))
18797 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18798 (setq ad-return-value t
18799 texmathp-why '("Org-mode embedded math" . 0))
18800 (when p ad-do-it)))))))))
18802 (defun turn-on-org-cdlatex ()
18803 "Unconditionally turn on `org-cdlatex-mode'."
18804 (org-cdlatex-mode 1))
18806 (defun org-try-cdlatex-tab ()
18807 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18808 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18809 - inside a LaTeX fragment, or
18810 - after the first word in a line, where an abbreviation expansion could
18811 insert a LaTeX environment."
18812 (when org-cdlatex-mode
18813 (cond
18814 ;; Before any word on the line: No expansion possible.
18815 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18816 ;; Just after first word on the line: Expand it. Make sure it
18817 ;; cannot happen on headlines, though.
18818 ((save-excursion
18819 (skip-chars-backward "a-zA-Z0-9*")
18820 (skip-chars-backward " \t")
18821 (and (bolp) (not (org-at-heading-p))))
18822 (cdlatex-tab) t)
18823 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18825 (defun org-cdlatex-underscore-caret (&optional arg)
18826 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18827 Revert to the normal definition outside of these fragments."
18828 (interactive "P")
18829 (if (org-inside-LaTeX-fragment-p)
18830 (call-interactively 'cdlatex-sub-superscript)
18831 (let (org-cdlatex-mode)
18832 (call-interactively (key-binding (vector last-input-event))))))
18834 (defun org-cdlatex-math-modify (&optional arg)
18835 "Execute `cdlatex-math-modify' in LaTeX fragments.
18836 Revert to the normal definition outside of these fragments."
18837 (interactive "P")
18838 (if (org-inside-LaTeX-fragment-p)
18839 (call-interactively 'cdlatex-math-modify)
18840 (let (org-cdlatex-mode)
18841 (call-interactively (key-binding (vector last-input-event))))))
18843 (defun org-cdlatex-environment-indent (&optional environment item)
18844 "Execute `cdlatex-environment' and indent the inserted environment.
18846 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18848 The inserted environment is indented to current indentation
18849 unless point is at the beginning of the line, in which the
18850 environment remains unintended."
18851 (interactive)
18852 ;; cdlatex-environment always return nil. Therefore, capture output
18853 ;; first and determine if an environment was selected.
18854 (let* ((beg (point-marker))
18855 (end (copy-marker (point) t))
18856 (inserted (progn
18857 (ignore-errors (cdlatex-environment environment item))
18858 (< beg end)))
18859 ;; Figure out how many lines to move forward after the
18860 ;; environment has been inserted.
18861 (lines (when inserted
18862 (save-excursion
18863 (- (loop while (< beg (point))
18864 with x = 0
18865 do (forward-line -1)
18866 (incf x)
18867 finally return x)
18868 (if (progn (goto-char beg)
18869 (and (progn (skip-chars-forward " \t") (eolp))
18870 (progn (skip-chars-backward " \t") (bolp))))
18871 1 0)))))
18872 (env (org-trim (delete-and-extract-region beg end))))
18873 (when inserted
18874 ;; Get indentation of next line unless at column 0.
18875 (let ((ind (if (bolp) 0
18876 (save-excursion
18877 (org-return-indent)
18878 (prog1 (org-get-indentation)
18879 (when (progn (skip-chars-forward " \t") (eolp))
18880 (delete-region beg (point)))))))
18881 (bol (progn (skip-chars-backward " \t") (bolp))))
18882 ;; Insert a newline before environment unless at column zero
18883 ;; to "escape" the current line. Insert a newline if
18884 ;; something is one the same line as \end{ENVIRONMENT}.
18885 (insert
18886 (concat (unless bol "\n") env
18887 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18888 (unless (zerop ind)
18889 (save-excursion
18890 (goto-char beg)
18891 (while (< (point) end)
18892 (unless (eolp) (org-indent-line-to ind))
18893 (forward-line))))
18894 (goto-char beg)
18895 (forward-line lines)
18896 (org-indent-line-to ind)))
18897 (set-marker beg nil)
18898 (set-marker end nil)))
18901 ;;;; LaTeX fragments
18903 (defun org-inside-LaTeX-fragment-p ()
18904 "Test if point is inside a LaTeX fragment.
18905 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18906 sequence appearing also before point.
18907 Even though the matchers for math are configurable, this function assumes
18908 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18909 delimiters are skipped when they have been removed by customization.
18910 The return value is nil, or a cons cell with the delimiter and the
18911 position of this delimiter.
18913 This function does a reasonably good job, but can locally be fooled by
18914 for example currency specifications. For example it will assume being in
18915 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18916 fragments that are properly closed, but during editing, we have to live
18917 with the uncertainty caused by missing closing delimiters. This function
18918 looks only before point, not after."
18919 (catch 'exit
18920 (let ((pos (point))
18921 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18922 (lim (progn
18923 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18924 (point)))
18925 dd-on str (start 0) m re)
18926 (goto-char pos)
18927 (when dodollar
18928 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18929 re (nth 1 (assoc "$" org-latex-regexps)))
18930 (while (string-match re str start)
18931 (cond
18932 ((= (match-end 0) (length str))
18933 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18934 ((= (match-end 0) (- (length str) 5))
18935 (throw 'exit nil))
18936 (t (setq start (match-end 0))))))
18937 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18938 (goto-char pos)
18939 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18940 (and (match-beginning 2) (throw 'exit nil))
18941 ;; count $$
18942 (while (re-search-backward "\\$\\$" lim t)
18943 (setq dd-on (not dd-on)))
18944 (goto-char pos)
18945 (when dd-on (cons "$$" m))))))
18947 (defun org-inside-latex-macro-p ()
18948 "Is point inside a LaTeX macro or its arguments?"
18949 (save-match-data
18950 (org-in-regexp
18951 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18953 (defvar-local org-latex-fragment-image-overlays nil
18954 "List of overlays carrying the images of latex fragments.")
18956 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18957 "Remove all overlays with LaTeX fragment images in current buffer.
18958 When optional arguments BEG and END are non-nil, remove all
18959 overlays between them instead. Return t when some overlays were
18960 removed, nil otherwise."
18961 (let (removedp)
18962 (setq org-latex-fragment-image-overlays
18963 (let ((beg (or beg (point-min)))
18964 (end (or end (point-max))))
18965 (cl-remove-if
18966 (lambda (o)
18967 (cond ((not (overlay-buffer o)) (delete-overlay o) t)
18968 ((and (>= (overlay-start o) beg)
18969 (<= (overlay-end o) end))
18970 (delete-overlay o)
18971 (unless removedp (setq removedp t)))
18972 (t nil)))
18973 org-latex-fragment-image-overlays)))
18974 removedp))
18976 (define-obsolete-function-alias
18977 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18978 (defun org-toggle-latex-fragment (&optional arg)
18979 "Preview the LaTeX fragment at point, or all locally or globally.
18981 If the cursor is on a LaTeX fragment, create the image and overlay
18982 it over the source code, if there is none. Remove it otherwise.
18983 If there is no fragment at point, display all fragments in the
18984 current section.
18986 With prefix ARG, preview or clear image for all fragments in the
18987 current subtree or in the whole buffer when used before the first
18988 headline. With a double prefix ARG \\[universal-argument] \
18989 \\[universal-argument] preview or clear images
18990 for all fragments in the buffer."
18991 (interactive "P")
18992 (unless (buffer-file-name (buffer-base-buffer))
18993 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18994 (when (display-graphic-p)
18995 (catch 'exit
18996 (save-excursion
18997 (let ((window-start (window-start)) msg)
18998 (save-restriction
18999 (cond
19000 ((or (equal arg '(16))
19001 (and (equal arg '(4))
19002 (org-with-limited-levels (org-before-first-heading-p))))
19003 (if (org-remove-latex-fragment-image-overlays)
19004 (progn (message "LaTeX fragments images removed from buffer")
19005 (throw 'exit nil))
19006 (setq msg "Creating images for buffer...")))
19007 ((equal arg '(4))
19008 (org-with-limited-levels (org-back-to-heading t))
19009 (let ((beg (point))
19010 (end (progn (org-end-of-subtree t) (point))))
19011 (if (org-remove-latex-fragment-image-overlays beg end)
19012 (progn
19013 (message "LaTeX fragment images removed from subtree")
19014 (throw 'exit nil))
19015 (setq msg "Creating images for subtree...")
19016 (narrow-to-region beg end))))
19017 ((let ((datum (org-element-context)))
19018 (when (memq (org-element-type datum)
19019 '(latex-environment latex-fragment))
19020 (let* ((beg (org-element-property :begin datum))
19021 (end (org-element-property :end datum)))
19022 (if (org-remove-latex-fragment-image-overlays beg end)
19023 (progn (message "LaTeX fragment image removed")
19024 (throw 'exit nil))
19025 (narrow-to-region beg end)
19026 (setq msg "Creating image..."))))))
19028 (org-with-limited-levels
19029 (let ((beg (if (org-at-heading-p) (line-beginning-position)
19030 (outline-previous-heading)
19031 (point)))
19032 (end (progn (outline-next-heading) (point))))
19033 (if (org-remove-latex-fragment-image-overlays beg end)
19034 (progn
19035 (message "LaTeX fragment images removed from section")
19036 (throw 'exit nil))
19037 (setq msg "Creating images for section...")
19038 (narrow-to-region beg end))))))
19039 (let ((file (buffer-file-name (buffer-base-buffer))))
19040 (org-format-latex
19041 (concat org-latex-preview-ltxpng-directory
19042 (file-name-sans-extension (file-name-nondirectory file)))
19043 ;; Emacs cannot overlay images from remote hosts.
19044 ;; Create it in `temporary-file-directory' instead.
19045 (if (file-remote-p file) temporary-file-directory
19046 default-directory)
19047 'overlays msg 'forbuffer
19048 org-latex-create-formula-image-program)))
19049 ;; Work around a bug that doesn't restore window's start
19050 ;; when widening back the buffer.
19051 (set-window-start nil window-start)
19052 (message (concat msg "done")))))))
19054 (defun org-format-latex
19055 (prefix &optional dir overlays msg forbuffer processing-type)
19056 "Replace LaTeX fragments with links to an image, and produce images.
19058 When optional argument OVERLAYS is non-nil, display the image on
19059 top of the fragment instead of replacing it.
19061 PROCESSING-TYPE is the conversion method to use, as a symbol.
19063 Some of the options can be changed using the variable
19064 `org-format-latex-options', which see."
19065 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19066 (unless (eq processing-type 'verbatim)
19067 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19068 (cnt 0)
19069 checkdir-flag)
19070 (goto-char (point-min))
19071 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19072 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19073 (overlay-recenter (point-max)))
19074 (while (re-search-forward math-regexp nil t)
19075 (unless (and overlays
19076 (eq (get-char-property (point) 'org-overlay-type)
19077 'org-latex-overlay))
19078 (let* ((context (org-element-context))
19079 (type (org-element-type context)))
19080 (when (memq type '(latex-environment latex-fragment))
19081 (let ((block-type (eq type 'latex-environment))
19082 (value (org-element-property :value context))
19083 (beg (org-element-property :begin context))
19084 (end (save-excursion
19085 (goto-char (org-element-property :end context))
19086 (skip-chars-backward " \r\t\n")
19087 (point))))
19088 (case processing-type
19089 (mathjax
19090 ;; Prepare for MathJax processing.
19091 (if (eq (char-after beg) ?$)
19092 (save-excursion
19093 (delete-region beg end)
19094 (insert "\\(" (substring value 1 -1) "\\)"))
19095 (goto-char end)))
19096 ((dvipng imagemagick)
19097 ;; Process to an image.
19098 (incf cnt)
19099 (goto-char beg)
19100 (let* ((face (face-at-point))
19101 ;; Get the colors from the face at point.
19103 (let ((color (plist-get org-format-latex-options
19104 :foreground)))
19105 (if (and forbuffer (eq color 'auto))
19106 (face-attribute face :foreground nil 'default)
19107 color)))
19109 (let ((color (plist-get org-format-latex-options
19110 :background)))
19111 (if (and forbuffer (eq color 'auto))
19112 (face-attribute face :background nil 'default)
19113 color)))
19114 (hash (sha1 (prin1-to-string
19115 (list org-format-latex-header
19116 org-latex-default-packages-alist
19117 org-latex-packages-alist
19118 org-format-latex-options
19119 forbuffer value fg bg))))
19120 (absprefix (expand-file-name prefix dir))
19121 (linkfile (format "%s_%s.png" prefix hash))
19122 (movefile (format "%s_%s.png" absprefix hash))
19123 (sep (and block-type "\n\n"))
19124 (link (concat sep "[[file:" linkfile "]]" sep))
19125 (options
19126 (org-combine-plists
19127 org-format-latex-options
19128 `(:foreground ,fg :background ,bg))))
19129 (when msg (message msg cnt))
19130 (unless checkdir-flag ; Ensure the directory exists.
19131 (setq checkdir-flag t)
19132 (let ((todir (file-name-directory absprefix)))
19133 (unless (file-directory-p todir)
19134 (make-directory todir t))))
19135 (unless (file-exists-p movefile)
19136 (org-create-formula-image
19137 value movefile options forbuffer processing-type))
19138 (if overlays
19139 (progn
19140 (dolist (o (overlays-in beg end))
19141 (when (eq (overlay-get o 'org-overlay-type)
19142 'org-latex-overlay)
19143 (delete-overlay o)))
19144 (let ((ov (make-overlay beg end)))
19145 (overlay-put ov
19146 'org-overlay-type
19147 'org-latex-overlay)
19148 (overlay-put ov 'evaporate t)
19149 (if (featurep 'xemacs)
19150 (progn
19151 (overlay-put ov 'invisible t)
19152 (overlay-put
19153 ov 'end-glyph
19154 (make-glyph
19155 (vector 'png :file movefile))))
19156 (overlay-put
19157 ov 'display
19158 (list 'image
19159 :type 'png
19160 :file movefile
19161 :ascent 'center)))
19162 (push ov org-latex-fragment-image-overlays))
19163 (goto-char end))
19164 (delete-region beg end)
19165 (insert
19166 (org-add-props link
19167 (list 'org-latex-src
19168 (replace-regexp-in-string "\"" "" value)
19169 'org-latex-src-embed-type
19170 (if block-type 'paragraph 'character)))))))
19171 (mathml
19172 ;; Process to MathML.
19173 (unless (org-format-latex-mathml-available-p)
19174 (user-error "LaTeX to MathML converter not configured"))
19175 (incf cnt)
19176 (when msg (message msg cnt))
19177 (goto-char beg)
19178 (delete-region beg end)
19179 (insert (org-format-latex-as-mathml
19180 value block-type prefix dir)))
19181 (otherwise
19182 (error "Unknown conversion type %s for LaTeX fragments"
19183 processing-type)))))))))))
19185 (defun org-create-math-formula (latex-frag &optional mathml-file)
19186 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19187 Use `org-latex-to-mathml-convert-command'. If the conversion is
19188 sucessful, return the portion between \"<math...> </math>\"
19189 elements otherwise return nil. When MATHML-FILE is specified,
19190 write the results in to that file. When invoked as an
19191 interactive command, prompt for LATEX-FRAG, with initial value
19192 set to the current active region and echo the results for user
19193 inspection."
19194 (interactive (list (let ((frag (when (org-region-active-p)
19195 (buffer-substring-no-properties
19196 (region-beginning) (region-end)))))
19197 (read-string "LaTeX Fragment: " frag nil frag))))
19198 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19199 (let* ((tmp-in-file (file-relative-name
19200 (make-temp-name (expand-file-name "ltxmathml-in"))))
19201 (ignore (write-region latex-frag nil tmp-in-file))
19202 (tmp-out-file (file-relative-name
19203 (make-temp-name (expand-file-name "ltxmathml-out"))))
19204 (cmd (format-spec
19205 org-latex-to-mathml-convert-command
19206 `((?j . ,(and org-latex-to-mathml-jar-file
19207 (shell-quote-argument
19208 (expand-file-name
19209 org-latex-to-mathml-jar-file))))
19210 (?I . ,(shell-quote-argument tmp-in-file))
19211 (?i . ,latex-frag)
19212 (?o . ,(shell-quote-argument tmp-out-file)))))
19213 mathml shell-command-output)
19214 (when (org-called-interactively-p 'any)
19215 (unless (org-format-latex-mathml-available-p)
19216 (user-error "LaTeX to MathML converter not configured")))
19217 (message "Running %s" cmd)
19218 (setq shell-command-output (shell-command-to-string cmd))
19219 (setq mathml
19220 (when (file-readable-p tmp-out-file)
19221 (with-current-buffer (find-file-noselect tmp-out-file t)
19222 (goto-char (point-min))
19223 (when (re-search-forward
19224 (concat
19225 (regexp-quote
19226 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19227 "[^>]*?>"
19228 "\\(.\\|\n\\)*"
19229 "</math>")
19230 nil t)
19231 (prog1 (match-string 0) (kill-buffer))))))
19232 (cond
19233 (mathml
19234 (setq mathml
19235 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19236 (when mathml-file
19237 (write-region mathml nil mathml-file))
19238 (when (org-called-interactively-p 'any)
19239 (message mathml)))
19240 ((message "LaTeX to MathML conversion failed")
19241 (message shell-command-output)))
19242 (delete-file tmp-in-file)
19243 (when (file-exists-p tmp-out-file)
19244 (delete-file tmp-out-file))
19245 mathml))
19247 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19248 prefix &optional dir)
19249 "Use `org-create-math-formula' but check local cache first."
19250 (let* ((absprefix (expand-file-name prefix dir))
19251 (print-length nil) (print-level nil)
19252 (formula-id (concat
19253 "formula-"
19254 (sha1
19255 (prin1-to-string
19256 (list latex-frag
19257 org-latex-to-mathml-convert-command)))))
19258 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19259 (formula-cache-dir (file-name-directory formula-cache)))
19261 (unless (file-directory-p formula-cache-dir)
19262 (make-directory formula-cache-dir t))
19264 (unless (file-exists-p formula-cache)
19265 (org-create-math-formula latex-frag formula-cache))
19267 (if (file-exists-p formula-cache)
19268 ;; Successful conversion. Return the link to MathML file.
19269 (org-add-props
19270 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19271 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19272 'org-latex-src-embed-type (if latex-frag-type
19273 'paragraph 'character)))
19274 ;; Failed conversion. Return the LaTeX fragment verbatim
19275 latex-frag)))
19277 (defun org-create-formula-image (string tofile options buffer &optional type)
19278 "Create an image from LaTeX source using dvipng or convert.
19279 This function calls either `org-create-formula-image-with-dvipng'
19280 or `org-create-formula-image-with-imagemagick' depending on the
19281 value of `org-latex-create-formula-image-program' or on the value
19282 of the optional TYPE variable.
19284 Note: ultimately these two function should be combined as they
19285 share a good deal of logic."
19286 (org-check-external-command
19287 "latex" "needed to convert LaTeX fragments to images")
19288 (funcall
19289 (case (or type org-latex-create-formula-image-program)
19290 (dvipng
19291 (org-check-external-command
19292 "dvipng" "needed to convert LaTeX fragments to images")
19293 #'org-create-formula-image-with-dvipng)
19294 (imagemagick
19295 (org-check-external-command
19296 "convert" "you need to install imagemagick")
19297 #'org-create-formula-image-with-imagemagick)
19298 (t (error
19299 "Invalid value of `org-latex-create-formula-image-program'")))
19300 string tofile options buffer))
19302 (declare-function org-export-get-backend "ox" (name))
19303 (declare-function org-export--get-global-options "ox" (&optional backend))
19304 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19305 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19306 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19307 (defun org-create-formula--latex-header ()
19308 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19309 (let ((info (org-combine-plists (org-export--get-global-options
19310 (org-export-get-backend 'latex))
19311 (org-export--get-inbuffer-options
19312 (org-export-get-backend 'latex)))))
19313 (org-latex-guess-babel-language
19314 (org-latex-guess-inputenc
19315 (org-splice-latex-header
19316 org-format-latex-header
19317 org-latex-default-packages-alist
19318 org-latex-packages-alist t
19319 (plist-get info :latex-header)))
19320 info)))
19322 (defun org--get-display-dpi ()
19323 "Get the DPI of the display.
19325 Assumes that the display has the same pixel width in the
19326 horizontal and vertical directions."
19327 (if (display-graphic-p)
19328 (round (/ (display-pixel-height)
19329 (/ (display-mm-height) 25.4)))
19330 (error "Attempt to calculate the dpi of a non-graphic display")))
19332 ;; This function borrows from Ganesh Swami's latex2png.el
19333 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19334 "This calls dvipng."
19335 (require 'ox-latex)
19336 (let* ((tmpdir (if (featurep 'xemacs)
19337 (temp-directory)
19338 temporary-file-directory))
19339 (texfilebase (make-temp-name
19340 (expand-file-name "orgtex" tmpdir)))
19341 (texfile (concat texfilebase ".tex"))
19342 (dvifile (concat texfilebase ".dvi"))
19343 (pngfile (concat texfilebase ".png"))
19344 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19345 ;; This assumes that the display has the same pixel width in
19346 ;; the horizontal and vertical directions
19347 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19348 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19349 "Black"))
19350 (bg (or (plist-get options (if buffer :background :html-background))
19351 "Transparent")))
19352 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19353 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19354 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19355 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19356 (let ((latex-header (org-create-formula--latex-header)))
19357 (with-temp-file texfile
19358 (insert latex-header)
19359 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19360 (let ((dir default-directory))
19361 (ignore-errors
19362 (cd tmpdir)
19363 (call-process "latex" nil nil nil texfile))
19364 (cd dir))
19365 (if (not (file-exists-p dvifile))
19366 (progn (message "Failed to create dvi file from %s" texfile) nil)
19367 (ignore-errors
19368 (if (featurep 'xemacs)
19369 (call-process "dvipng" nil nil nil
19370 "-fg" fg "-bg" bg
19371 "-T" "tight"
19372 "-o" pngfile
19373 dvifile)
19374 (call-process "dvipng" nil nil nil
19375 "-fg" fg "-bg" bg
19376 "-D" dpi
19377 ;;"-x" scale "-y" scale
19378 "-T" "tight"
19379 "-o" pngfile
19380 dvifile)))
19381 (if (not (file-exists-p pngfile))
19382 (if org-format-latex-signal-error
19383 (error "Failed to create png file from %s" texfile)
19384 (message "Failed to create png file from %s" texfile)
19385 nil)
19386 ;; Use the requested file name and clean up
19387 (copy-file pngfile tofile 'replace)
19388 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19389 (when (file-exists-p (concat texfilebase e))
19390 (delete-file (concat texfilebase e))))
19391 pngfile))))
19393 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19394 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19395 "This calls convert, which is included into imagemagick."
19396 (require 'ox-latex)
19397 (let* ((tmpdir (if (featurep 'xemacs)
19398 (temp-directory)
19399 temporary-file-directory))
19400 (texfilebase (make-temp-name
19401 (expand-file-name "orgtex" tmpdir)))
19402 (texfile (concat texfilebase ".tex"))
19403 (pdffile (concat texfilebase ".pdf"))
19404 (pngfile (concat texfilebase ".png"))
19405 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19406 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19407 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19408 "black"))
19409 (bg (or (plist-get options (if buffer :background :html-background))
19410 "white")))
19411 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19412 (setq fg (org-latex-color-format fg)))
19413 (if (eq bg 'default) (setq bg (org-latex-color :background))
19414 (setq bg (org-latex-color-format
19415 (if (string= bg "Transparent") "white" bg))))
19416 (let ((latex-header (org-create-formula--latex-header)))
19417 (with-temp-file texfile
19418 (insert latex-header)
19419 (insert "\n\\begin{document}\n"
19420 "\\definecolor{fg}{rgb}{" fg "}\n"
19421 "\\definecolor{bg}{rgb}{" bg "}\n"
19422 "\n\\pagecolor{bg}\n"
19423 "\n{\\color{fg}\n"
19424 string
19425 "\n}\n"
19426 "\n\\end{document}\n")))
19427 (org-latex-compile texfile t)
19428 (if (not (file-exists-p pdffile))
19429 (progn (message "Failed to create pdf file from %s" texfile) nil)
19430 (ignore-errors
19431 (if (featurep 'xemacs)
19432 (call-process "convert" nil nil nil
19433 "-density" "96"
19434 "-trim"
19435 "-antialias"
19436 pdffile
19437 "-quality" "100"
19438 ;; "-sharpen" "0x1.0"
19439 pngfile)
19440 (call-process "convert" nil nil nil
19441 "-density" dpi
19442 "-trim"
19443 "-antialias"
19444 pdffile
19445 "-quality" "100"
19446 ;; "-sharpen" "0x1.0"
19447 pngfile)))
19448 (if (not (file-exists-p pngfile))
19449 (if org-format-latex-signal-error
19450 (error "Failed to create png file from %s" texfile)
19451 (message "Failed to create png file from %s" texfile)
19452 nil)
19453 ;; Use the requested file name and clean up
19454 (copy-file pngfile tofile 'replace)
19455 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19456 (when (file-exists-p (concat texfilebase e))
19457 (delete-file (concat texfilebase e))))
19458 pngfile))))
19460 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19461 "Fill a LaTeX header template TPL.
19462 In the template, the following place holders will be recognized:
19464 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19465 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19466 [PACKAGES] \\usepackage statements for PKG
19467 [NO-PACKAGES] do not include PKG
19468 [EXTRA] the string EXTRA
19469 [NO-EXTRA] do not include EXTRA
19471 For backward compatibility, if both the positive and the negative place
19472 holder is missing, the positive one (without the \"NO-\") will be
19473 assumed to be present at the end of the template.
19474 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19475 EXTRA is a string.
19476 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19477 (let (rpl (end ""))
19478 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19479 (setq rpl (if (or (match-end 1) (not def-pkg))
19480 "" (org-latex-packages-to-string def-pkg snippets-p t))
19481 tpl (replace-match rpl t t tpl))
19482 (when def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19484 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19485 (setq rpl (if (or (match-end 1) (not pkg))
19486 "" (org-latex-packages-to-string pkg snippets-p t))
19487 tpl (replace-match rpl t t tpl))
19488 (when pkg (setq end
19489 (concat end "\n"
19490 (org-latex-packages-to-string pkg snippets-p)))))
19492 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19493 (setq rpl (if (or (match-end 1) (not extra))
19494 "" (concat extra "\n"))
19495 tpl (replace-match rpl t t tpl))
19496 (when (and extra (string-match "\\S-" extra))
19497 (setq end (concat end "\n" extra))))
19499 (if (string-match "\\S-" end)
19500 (concat tpl "\n" end)
19501 tpl)))
19503 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19504 "Turn an alist of packages into a string with the \\usepackage macros."
19505 (setq pkg (mapconcat (lambda(p)
19506 (cond
19507 ((stringp p) p)
19508 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19509 (format "%% Package %s omitted" (cadr p)))
19510 ((equal "" (car p))
19511 (format "\\usepackage{%s}" (cadr p)))
19513 (format "\\usepackage[%s]{%s}"
19514 (car p) (cadr p)))))
19516 "\n"))
19517 (if newline (concat pkg "\n") pkg))
19519 (defun org-dvipng-color (attr)
19520 "Return a RGB color specification for dvipng."
19521 (apply 'format "rgb %s %s %s"
19522 (mapcar 'org-normalize-color
19523 (if (featurep 'xemacs)
19524 (color-rgb-components
19525 (face-property 'default
19526 (cond ((eq attr :foreground) 'foreground)
19527 ((eq attr :background) 'background))))
19528 (color-values (face-attribute 'default attr nil))))))
19530 (defun org-dvipng-color-format (color-name)
19531 "Convert COLOR-NAME to a RGB color value for dvipng."
19532 (apply 'format "rgb %s %s %s"
19533 (mapcar 'org-normalize-color
19534 (color-values color-name))))
19536 (defun org-latex-color (attr)
19537 "Return a RGB color for the LaTeX color package."
19538 (apply 'format "%s,%s,%s"
19539 (mapcar 'org-normalize-color
19540 (if (featurep 'xemacs)
19541 (color-rgb-components
19542 (face-property 'default
19543 (cond ((eq attr :foreground) 'foreground)
19544 ((eq attr :background) 'background))))
19545 (color-values (face-attribute 'default attr nil))))))
19547 (defun org-latex-color-format (color-name)
19548 "Convert COLOR-NAME to a RGB color value."
19549 (apply 'format "%s,%s,%s"
19550 (mapcar 'org-normalize-color
19551 (color-values color-name))))
19553 (defun org-normalize-color (value)
19554 "Return string to be used as color value for an RGB component."
19555 (format "%g" (/ value 65535.0)))
19559 ;; Image display
19561 (defvar-local org-inline-image-overlays nil)
19563 (defun org-toggle-inline-images (&optional include-linked)
19564 "Toggle the display of inline images.
19565 INCLUDE-LINKED is passed to `org-display-inline-images'."
19566 (interactive "P")
19567 (if org-inline-image-overlays
19568 (progn
19569 (org-remove-inline-images)
19570 (when (org-called-interactively-p 'interactive)
19571 (message "Inline image display turned off")))
19572 (org-display-inline-images include-linked)
19573 (when (org-called-interactively-p 'interactive)
19574 (message (if org-inline-image-overlays
19575 (format "%d images displayed inline"
19576 (length org-inline-image-overlays))
19577 "No images to display inline")))))
19579 (defun org-redisplay-inline-images ()
19580 "Refresh the display of inline images."
19581 (interactive)
19582 (if (not org-inline-image-overlays)
19583 (org-toggle-inline-images)
19584 (org-toggle-inline-images)
19585 (org-toggle-inline-images)))
19587 (defun org-display-inline-images (&optional include-linked refresh beg end)
19588 "Display inline images.
19590 An inline image is a link which follows either of these
19591 conventions:
19593 1. Its path is a file with an extension matching return value
19594 from `image-file-name-regexp' and it has no contents.
19596 2. Its description consists in a single link of the previous
19597 type.
19599 When optional argument INCLUDE-LINKED is non-nil, also links with
19600 a text description part will be inlined. This can be nice for
19601 a quick look at those images, but it does not reflect what
19602 exported files will look like.
19604 When optional argument REFRESH is non-nil, refresh existing
19605 images between BEG and END. This will create new image displays
19606 only if necessary. BEG and END default to the buffer
19607 boundaries."
19608 (interactive "P")
19609 (when (display-graphic-p)
19610 (unless refresh
19611 (org-remove-inline-images)
19612 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19613 (org-with-wide-buffer
19614 (goto-char (or beg (point-min)))
19615 (let ((case-fold-search t)
19616 (file-extension-re (org-image-file-name-regexp)))
19617 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19618 (let ((link (save-match-data (org-element-context))))
19619 ;; Check if we're at an inline image.
19620 (when (and (equal (org-element-property :type link) "file")
19621 (or include-linked
19622 (not (org-element-property :contents-begin link)))
19623 (let ((parent (org-element-property :parent link)))
19624 (or (not (eq (org-element-type parent) 'link))
19625 (not (cdr (org-element-contents parent)))))
19626 (org-string-match-p file-extension-re
19627 (org-element-property :path link)))
19628 (let ((file (expand-file-name
19629 (org-link-unescape
19630 (org-element-property :path link)))))
19631 (when (file-exists-p file)
19632 (let ((width
19633 ;; Apply `org-image-actual-width' specifications.
19634 (cond
19635 ((not (image-type-available-p 'imagemagick)) nil)
19636 ((eq org-image-actual-width t) nil)
19637 ((listp org-image-actual-width)
19639 ;; First try to find a width among
19640 ;; attributes associated to the paragraph
19641 ;; containing link.
19642 (let ((paragraph
19643 (let ((e link))
19644 (while (and (setq e (org-element-property
19645 :parent e))
19646 (not (eq (org-element-type e)
19647 'paragraph))))
19648 e)))
19649 (when paragraph
19650 (save-excursion
19651 (goto-char (org-element-property :begin paragraph))
19652 (when
19653 (re-search-forward
19654 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19655 (org-element-property
19656 :post-affiliated paragraph)
19658 (string-to-number (match-string 1))))))
19659 ;; Otherwise, fall-back to provided number.
19660 (car org-image-actual-width)))
19661 ((numberp org-image-actual-width)
19662 org-image-actual-width)))
19663 (old (get-char-property-and-overlay
19664 (org-element-property :begin link)
19665 'org-image-overlay)))
19666 (if (and (car-safe old) refresh)
19667 (image-refresh (overlay-get (cdr old) 'display))
19668 (let ((image (create-image file
19669 (and width 'imagemagick)
19671 :width width)))
19672 (when image
19673 (let* ((link
19674 ;; If inline image is the description
19675 ;; of another link, be sure to
19676 ;; consider the latter as the one to
19677 ;; apply the overlay on.
19678 (let ((parent
19679 (org-element-property :parent link)))
19680 (if (eq (org-element-type parent) 'link)
19681 parent
19682 link)))
19683 (ov (make-overlay
19684 (org-element-property :begin link)
19685 (progn
19686 (goto-char
19687 (org-element-property :end link))
19688 (skip-chars-backward " \t")
19689 (point)))))
19690 (overlay-put ov 'display image)
19691 (overlay-put ov 'face 'default)
19692 (overlay-put ov 'org-image-overlay t)
19693 (overlay-put
19694 ov 'modification-hooks
19695 (list 'org-display-inline-remove-overlay))
19696 (push ov org-inline-image-overlays)))))))))))))))
19698 (define-obsolete-function-alias
19699 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19701 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19702 "Remove inline-display overlay if a corresponding region is modified."
19703 (let ((inhibit-modification-hooks t))
19704 (when (and ov after)
19705 (delete ov org-inline-image-overlays)
19706 (delete-overlay ov))))
19708 (defun org-remove-inline-images ()
19709 "Remove inline display of images."
19710 (interactive)
19711 (mapc 'delete-overlay org-inline-image-overlays)
19712 (setq org-inline-image-overlays nil))
19714 ;;;; Key bindings
19716 ;; Outline functions from `outline-mode-prefix-map'
19717 ;; that can be remapped in Org:
19718 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19719 (define-key org-mode-map [remap outline-show-subtree] 'org-show-subtree)
19720 (define-key org-mode-map [remap outline-forward-same-level]
19721 'org-forward-heading-same-level)
19722 (define-key org-mode-map [remap outline-backward-same-level]
19723 'org-backward-heading-same-level)
19724 (define-key org-mode-map [remap outline-show-branches]
19725 'org-kill-note-or-show-branches)
19726 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19727 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19728 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19729 (define-key org-mode-map [remap outline-next-visible-heading]
19730 'org-next-visible-heading)
19731 (define-key org-mode-map [remap outline-previous-visible-heading]
19732 'org-previous-visible-heading)
19733 (define-key org-mode-map [remap show-children] 'org-show-children)
19735 ;; Outline functions from `outline-mode-prefix-map' that can not
19736 ;; be remapped in Org:
19738 ;; - the column "key binding" shows whether the Outline function is still
19739 ;; available in Org mode on the same key that it has been bound to in
19740 ;; Outline mode:
19741 ;; - "overridden": key used for a different functionality in Org mode
19742 ;; - else: key still bound to the same Outline function in Org mode
19744 ;; | Outline function | key binding | Org replacement |
19745 ;; |------------------------------------+-------------+--------------------------|
19746 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19747 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19748 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19749 ;; | `show-entry' | overridden | no replacement |
19750 ;; | `show-branches' | `C-c C-k' | still same function |
19751 ;; | `show-subtree' | overridden | visibility cycling |
19752 ;; | `show-all' | overridden | no replacement |
19753 ;; | `hide-subtree' | overridden | visibility cycling |
19754 ;; | `hide-body' | overridden | no replacement |
19755 ;; | `hide-entry' | overridden | visibility cycling |
19756 ;; | `hide-leaves' | overridden | no replacement |
19757 ;; | `hide-sublevels' | overridden | no replacement |
19758 ;; | `hide-other' | overridden | no replacement |
19760 ;; Make `C-c C-x' a prefix key
19761 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19763 ;; TAB key with modifiers
19764 (org-defkey org-mode-map "\C-i" 'org-cycle)
19765 (org-defkey org-mode-map [(tab)] 'org-cycle)
19766 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19767 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19768 ;; The following line is necessary under Suse GNU/Linux
19769 (unless (featurep 'xemacs)
19770 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19771 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19772 (define-key org-mode-map [backtab] 'org-shifttab)
19774 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19775 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19776 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19778 ;; Cursor keys with modifiers
19779 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19780 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19781 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19782 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19784 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19785 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19786 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19787 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19788 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19789 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19791 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19792 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19793 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19794 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19796 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19797 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19798 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19799 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19801 ;; Babel keys
19802 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19803 (mapc (lambda (pair)
19804 (define-key org-babel-map (car pair) (cdr pair)))
19805 org-babel-key-bindings)
19807 ;;; Extra keys for tty access.
19808 ;; We only set them when really needed because otherwise the
19809 ;; menus don't show the simple keys
19811 (when (or org-use-extra-keys
19812 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19813 (not window-system))
19814 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19815 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19816 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19817 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19818 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19819 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19820 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19821 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19822 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19823 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19824 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19825 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19826 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19827 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19828 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19829 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19830 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19831 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19832 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19833 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19834 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19835 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19836 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19837 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19838 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19839 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19840 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19841 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19843 ;; All the other keys
19845 (org-defkey org-mode-map "\C-c\C-a" 'outline-show-all) ; in case allout messed up.
19846 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19847 (if (boundp 'narrow-map)
19848 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19849 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19850 (if (boundp 'narrow-map)
19851 (org-defkey narrow-map "b" 'org-narrow-to-block)
19852 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19853 (if (boundp 'narrow-map)
19854 (org-defkey narrow-map "e" 'org-narrow-to-element)
19855 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19856 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19857 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19858 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19859 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19860 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19861 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19862 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19863 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19864 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19865 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19866 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19867 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19868 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19869 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19870 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19871 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19872 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19873 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19874 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19875 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19876 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19877 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19878 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19879 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19880 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19881 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19882 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19883 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19884 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19885 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19886 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19887 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19888 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19889 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19890 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19891 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19892 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19893 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19894 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19895 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19896 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19897 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19898 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19899 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19900 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19901 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19902 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19903 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19904 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19905 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19906 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19907 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19908 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19909 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19910 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19911 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19912 (org-defkey org-mode-map "\C-c^" 'org-sort)
19913 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19914 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19915 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19916 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19917 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19918 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19919 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19920 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19921 (org-defkey org-mode-map "\C-m" 'org-return)
19922 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19923 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19924 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19925 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19926 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19927 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19928 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19929 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19930 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19931 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19932 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19933 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19934 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19935 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19936 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19937 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19938 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19939 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19940 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19941 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19942 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19943 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19944 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19945 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19946 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19948 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19949 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19950 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19952 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19953 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19954 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19955 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19956 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19957 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19958 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19959 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19960 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19961 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19962 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19963 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19964 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19965 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19966 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19967 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19968 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19969 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19970 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19971 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19972 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19973 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19975 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19976 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19977 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19978 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19979 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19981 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19983 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19985 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19986 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19988 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19991 (when (featurep 'xemacs)
19992 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19995 (defconst org-speed-commands-default
19997 ("Outline Navigation")
19998 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19999 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
20000 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
20001 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
20002 ("F" . org-next-block)
20003 ("B" . org-previous-block)
20004 ("u" . (org-speed-move-safe 'outline-up-heading))
20005 ("j" . org-goto)
20006 ("g" . (org-refile t))
20007 ("Outline Visibility")
20008 ("c" . org-cycle)
20009 ("C" . org-shifttab)
20010 (" " . org-display-outline-path)
20011 ("s" . org-narrow-to-subtree)
20012 ("=" . org-columns)
20013 ("Outline Structure Editing")
20014 ("U" . org-metaup)
20015 ("D" . org-metadown)
20016 ("r" . org-metaright)
20017 ("l" . org-metaleft)
20018 ("R" . org-shiftmetaright)
20019 ("L" . org-shiftmetaleft)
20020 ("i" . (progn (forward-char 1) (call-interactively
20021 'org-insert-heading-respect-content)))
20022 ("^" . org-sort)
20023 ("w" . org-refile)
20024 ("a" . org-archive-subtree-default-with-confirmation)
20025 ("@" . org-mark-subtree)
20026 ("#" . org-toggle-comment)
20027 ("Clock Commands")
20028 ("I" . org-clock-in)
20029 ("O" . org-clock-out)
20030 ("Meta Data Editing")
20031 ("t" . org-todo)
20032 ("," . (org-priority))
20033 ("0" . (org-priority ?\ ))
20034 ("1" . (org-priority ?A))
20035 ("2" . (org-priority ?B))
20036 ("3" . (org-priority ?C))
20037 (":" . org-set-tags-command)
20038 ("e" . org-set-effort)
20039 ("E" . org-inc-effort)
20040 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20041 (org-entry-put (point) "APPT_WARNTIME" m)))
20042 ("Agenda Views etc")
20043 ("v" . org-agenda)
20044 ("/" . org-sparse-tree)
20045 ("Misc")
20046 ("o" . org-open-at-point)
20047 ("?" . org-speed-command-help)
20048 ("<" . (org-agenda-set-restriction-lock 'subtree))
20049 (">" . (org-agenda-remove-restriction-lock))
20051 "The default speed commands.")
20053 (defun org-print-speed-command (e)
20054 (if (> (length (car e)) 1)
20055 (progn
20056 (princ "\n")
20057 (princ (car e))
20058 (princ "\n")
20059 (princ (make-string (length (car e)) ?-))
20060 (princ "\n"))
20061 (princ (car e))
20062 (princ " ")
20063 (if (symbolp (cdr e))
20064 (princ (symbol-name (cdr e)))
20065 (prin1 (cdr e)))
20066 (princ "\n")))
20068 (defun org-speed-command-help ()
20069 "Show the available speed commands."
20070 (interactive)
20071 (if (not org-use-speed-commands)
20072 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20073 (with-output-to-temp-buffer "*Help*"
20074 (princ "User-defined Speed commands\n===========================\n")
20075 (mapc 'org-print-speed-command org-speed-commands-user)
20076 (princ "\n")
20077 (princ "Built-in Speed commands\n=======================\n")
20078 (mapc 'org-print-speed-command org-speed-commands-default))
20079 (with-current-buffer "*Help*"
20080 (setq truncate-lines t))))
20082 (defun org-speed-move-safe (cmd)
20083 "Execute CMD, but make sure that the cursor always ends up in a headline.
20084 If not, return to the original position and throw an error."
20085 (interactive)
20086 (let ((pos (point)))
20087 (call-interactively cmd)
20088 (unless (and (bolp) (org-at-heading-p))
20089 (goto-char pos)
20090 (error "Boundary reached while executing %s" cmd))))
20092 (defvar org-self-insert-command-undo-counter 0)
20094 (defvar org-table-auto-blank-field) ; defined in org-table.el
20095 (defvar org-speed-command nil)
20097 (define-obsolete-function-alias
20098 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20100 (defun org-speed-command-activate (keys)
20101 "Hook for activating single-letter speed commands.
20102 `org-speed-commands-default' specifies a minimal command set.
20103 Use `org-speed-commands-user' for further customization."
20104 (when (or (and (bolp) (looking-at org-outline-regexp))
20105 (and (functionp org-use-speed-commands)
20106 (funcall org-use-speed-commands)))
20107 (cdr (assoc keys (append org-speed-commands-user
20108 org-speed-commands-default)))))
20110 (define-obsolete-function-alias
20111 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20113 (defun org-babel-speed-command-activate (keys)
20114 "Hook for activating single-letter code block commands."
20115 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20116 (cdr (assoc keys org-babel-key-bindings))))
20118 (defcustom org-speed-command-hook
20119 '(org-speed-command-default-hook org-babel-speed-command-hook)
20120 "Hook for activating speed commands at strategic locations.
20121 Hook functions are called in sequence until a valid handler is
20122 found.
20124 Each hook takes a single argument, a user-pressed command key
20125 which is also a `self-insert-command' from the global map.
20127 Within the hook, examine the cursor position and the command key
20128 and return nil or a valid handler as appropriate. Handler could
20129 be one of an interactive command, a function, or a form.
20131 Set `org-use-speed-commands' to non-nil value to enable this
20132 hook. The default setting is `org-speed-command-activate'."
20133 :group 'org-structure
20134 :version "24.1"
20135 :type 'hook)
20137 (defun org-self-insert-command (N)
20138 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20139 If the cursor is in a table looking at whitespace, the whitespace is
20140 overwritten, and the table is not marked as requiring realignment."
20141 (interactive "p")
20142 (org-check-before-invisible-edit 'insert)
20143 (cond
20144 ((and org-use-speed-commands
20145 (let ((kv (this-command-keys-vector)))
20146 (setq org-speed-command
20147 (run-hook-with-args-until-success
20148 'org-speed-command-hook
20149 (make-string 1 (aref kv (1- (length kv))))))))
20150 (cond
20151 ((commandp org-speed-command)
20152 (setq this-command org-speed-command)
20153 (call-interactively org-speed-command))
20154 ((functionp org-speed-command)
20155 (funcall org-speed-command))
20156 ((and org-speed-command (listp org-speed-command))
20157 (eval org-speed-command))
20158 (t (let (org-use-speed-commands)
20159 (call-interactively 'org-self-insert-command)))))
20160 ((and
20161 (org-at-table-p)
20162 (progn
20163 ;; Check if we blank the field, and if that triggers align.
20164 (and (featurep 'org-table) org-table-auto-blank-field
20165 (memq last-command
20166 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20167 (if (or (eq (char-after) ?\s) (looking-at "[^|\n]* |"))
20168 ;; Got extra space, this field does not determine
20169 ;; column width.
20170 (let (org-table-may-need-update) (org-table-blank-field))
20171 ;; No extra space, this field may determine column
20172 ;; width.
20173 (org-table-blank-field)))
20175 (eq N 1)
20176 (looking-at "[^|\n]* \\( \\)|"))
20177 ;; There is room for insertion without re-aligning the table.
20178 (delete-region (match-beginning 1) (match-end 1))
20179 (self-insert-command N))
20181 (setq org-table-may-need-update t)
20182 (self-insert-command N)
20183 (org-fix-tags-on-the-fly)
20184 (when org-self-insert-cluster-for-undo
20185 (if (not (eq last-command 'org-self-insert-command))
20186 (setq org-self-insert-command-undo-counter 1)
20187 (if (>= org-self-insert-command-undo-counter 20)
20188 (setq org-self-insert-command-undo-counter 1)
20189 (and (> org-self-insert-command-undo-counter 0)
20190 buffer-undo-list (listp buffer-undo-list)
20191 (not (cadr buffer-undo-list)) ; remove nil entry
20192 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20193 (setq org-self-insert-command-undo-counter
20194 (1+ org-self-insert-command-undo-counter))))))))
20196 (defun org-check-before-invisible-edit (kind)
20197 "Check is editing if kind KIND would be dangerous with invisible text around.
20198 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20199 ;; First, try to get out of here as quickly as possible, to reduce overhead
20200 (when (and org-catch-invisible-edits
20201 (or (not (boundp 'visible-mode)) (not visible-mode))
20202 (or (get-char-property (point) 'invisible)
20203 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20204 ;; OK, we need to take a closer look
20205 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20206 (invisible-before-point (unless (bobp) (get-char-property
20207 (1- (point)) 'invisible)))
20208 (border-and-ok-direction
20210 ;; Check if we are acting predictably before invisible text
20211 (and invisible-at-point (not invisible-before-point)
20212 (memq kind '(insert delete-backward)))
20213 ;; Check if we are acting predictably after invisible text
20214 ;; This works not well, and I have turned it off. It seems
20215 ;; better to always show and stop after invisible text.
20216 ;; (and (not invisible-at-point) invisible-before-point
20217 ;; (memq kind '(insert delete)))
20219 (when (or (memq invisible-at-point '(outline org-hide-block t))
20220 (memq invisible-before-point '(outline org-hide-block t)))
20221 (when (eq org-catch-invisible-edits 'error)
20222 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20223 (if (and org-custom-properties-overlays
20224 (y-or-n-p "Display invisible properties in this buffer? "))
20225 (org-toggle-custom-properties-visibility)
20226 ;; Make the area visible
20227 (save-excursion
20228 (when invisible-before-point
20229 (goto-char (previous-single-char-property-change
20230 (point) 'invisible)))
20231 (outline-show-subtree))
20232 (cond
20233 ((eq org-catch-invisible-edits 'show)
20234 ;; That's it, we do the edit after showing
20235 (message
20236 "Unfolding invisible region around point before editing")
20237 (sit-for 1))
20238 ((and (eq org-catch-invisible-edits 'smart)
20239 border-and-ok-direction)
20240 (message "Unfolding invisible region around point before editing"))
20242 ;; Don't do the edit, make the user repeat it in full visibility
20243 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20245 (defun org-fix-tags-on-the-fly ()
20246 (when (and (equal (char-after (point-at-bol)) ?*)
20247 (org-at-heading-p))
20248 (org-align-tags-here org-tags-column)))
20250 (defun org-delete-backward-char (N)
20251 "Like `delete-backward-char', insert whitespace at field end in tables.
20252 When deleting backwards, in tables this function will insert whitespace in
20253 front of the next \"|\" separator, to keep the table aligned. The table will
20254 still be marked for re-alignment if the field did fill the entire column,
20255 because, in this case the deletion might narrow the column."
20256 (interactive "p")
20257 (save-match-data
20258 (org-check-before-invisible-edit 'delete-backward)
20259 (if (and (org-at-table-p)
20260 (eq N 1)
20261 (string-match "|" (buffer-substring (point-at-bol) (point)))
20262 (looking-at ".*?|"))
20263 (let ((pos (point))
20264 (noalign (looking-at "[^|\n\r]* |"))
20265 (c org-table-may-need-update))
20266 (backward-delete-char N)
20267 (unless overwrite-mode
20268 (skip-chars-forward "^|")
20269 (insert " ")
20270 (goto-char (1- pos)))
20271 ;; noalign: if there were two spaces at the end, this field
20272 ;; does not determine the width of the column.
20273 (when noalign (setq org-table-may-need-update c)))
20274 (backward-delete-char N)
20275 (org-fix-tags-on-the-fly))))
20277 (defun org-delete-char (N)
20278 "Like `delete-char', but insert whitespace at field end in tables.
20279 When deleting characters, in tables this function will insert whitespace in
20280 front of the next \"|\" separator, to keep the table aligned. The table will
20281 still be marked for re-alignment if the field did fill the entire column,
20282 because, in this case the deletion might narrow the column."
20283 (interactive "p")
20284 (save-match-data
20285 (org-check-before-invisible-edit 'delete)
20286 (if (and (org-at-table-p)
20287 (not (bolp))
20288 (not (= (char-after) ?|))
20289 (eq N 1))
20290 (if (looking-at ".*?|")
20291 (let ((pos (point))
20292 (noalign (looking-at "[^|\n\r]* |"))
20293 (c org-table-may-need-update))
20294 (replace-match
20295 (concat (substring (match-string 0) 1 -1) " |") nil t)
20296 (goto-char pos)
20297 ;; noalign: if there were two spaces at the end, this field
20298 ;; does not determine the width of the column.
20299 (when noalign (setq org-table-may-need-update c)))
20300 (delete-char N))
20301 (delete-char N)
20302 (org-fix-tags-on-the-fly))))
20304 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20305 (put 'org-self-insert-command 'delete-selection
20306 (lambda ()
20307 (not (run-hook-with-args-until-success
20308 'self-insert-uses-region-functions))))
20309 (put 'orgtbl-self-insert-command 'delete-selection
20310 (lambda ()
20311 (not (run-hook-with-args-until-success
20312 'self-insert-uses-region-functions))))
20313 (put 'org-delete-char 'delete-selection 'supersede)
20314 (put 'org-delete-backward-char 'delete-selection 'supersede)
20315 (put 'org-yank 'delete-selection 'yank)
20317 ;; Make `flyspell-mode' delay after some commands
20318 (put 'org-self-insert-command 'flyspell-delayed t)
20319 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20320 (put 'org-delete-char 'flyspell-delayed t)
20321 (put 'org-delete-backward-char 'flyspell-delayed t)
20323 ;; Make pabbrev-mode expand after org-mode commands
20324 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20325 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20327 (defun org-remap (map &rest commands)
20328 "In MAP, remap the functions given in COMMANDS.
20329 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20330 (let (new old)
20331 (while commands
20332 (setq old (pop commands) new (pop commands))
20333 (if (fboundp 'command-remapping)
20334 (org-defkey map (vector 'remap old) new)
20335 (substitute-key-definition old new map global-map)))))
20337 (defun org-transpose-words ()
20338 "Transpose words for Org.
20339 This uses the `org-mode-transpose-word-syntax-table' syntax
20340 table, which interprets characters in `org-emphasis-alist' as
20341 word constituents."
20342 (interactive)
20343 (with-syntax-table org-mode-transpose-word-syntax-table
20344 (call-interactively 'transpose-words)))
20345 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20347 (when (eq org-enable-table-editor 'optimized)
20348 ;; If the user wants maximum table support, we need to hijack
20349 ;; some standard editing functions
20350 (org-remap org-mode-map
20351 'self-insert-command 'org-self-insert-command
20352 'delete-char 'org-delete-char
20353 'delete-backward-char 'org-delete-backward-char)
20354 (org-defkey org-mode-map "|" 'org-force-self-insert))
20356 (defvar org-ctrl-c-ctrl-c-hook nil
20357 "Hook for functions attaching themselves to `C-c C-c'.
20359 This can be used to add additional functionality to the C-c C-c
20360 key which executes context-dependent commands. This hook is run
20361 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20362 run after the last test.
20364 Each function will be called with no arguments. The function
20365 must check if the context is appropriate for it to act. If yes,
20366 it should do its thing and then return a non-nil value. If the
20367 context is wrong, just do nothing and return nil.")
20369 (defvar org-ctrl-c-ctrl-c-final-hook nil
20370 "Hook for functions attaching themselves to `C-c C-c'.
20372 This can be used to add additional functionality to the C-c C-c
20373 key which executes context-dependent commands. This hook is run
20374 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20375 before the first test.
20377 Each function will be called with no arguments. The function
20378 must check if the context is appropriate for it to act. If yes,
20379 it should do its thing and then return a non-nil value. If the
20380 context is wrong, just do nothing and return nil.")
20382 (defvar org-tab-first-hook nil
20383 "Hook for functions to attach themselves to TAB.
20384 See `org-ctrl-c-ctrl-c-hook' for more information.
20385 This hook runs as the first action when TAB is pressed, even before
20386 `org-cycle' messes around with the `outline-regexp' to cater for
20387 inline tasks and plain list item folding.
20388 If any function in this hook returns t, any other actions that
20389 would have been caused by TAB (such as table field motion or visibility
20390 cycling) will not occur.")
20392 (defvar org-tab-after-check-for-table-hook nil
20393 "Hook for functions to attach themselves to TAB.
20394 See `org-ctrl-c-ctrl-c-hook' for more information.
20395 This hook runs after it has been established that the cursor is not in a
20396 table, but before checking if the cursor is in a headline or if global cycling
20397 should be done.
20398 If any function in this hook returns t, not other actions like visibility
20399 cycling will be done.")
20401 (defvar org-tab-after-check-for-cycling-hook nil
20402 "Hook for functions to attach themselves to TAB.
20403 See `org-ctrl-c-ctrl-c-hook' for more information.
20404 This hook runs after it has been established that not table field motion and
20405 not visibility should be done because of current context. This is probably
20406 the place where a package like yasnippets can hook in.")
20408 (defvar org-tab-before-tab-emulation-hook nil
20409 "Hook for functions to attach themselves to TAB.
20410 See `org-ctrl-c-ctrl-c-hook' for more information.
20411 This hook runs after every other options for TAB have been exhausted, but
20412 before indentation and \t insertion takes place.")
20414 (defvar org-metaleft-hook nil
20415 "Hook for functions attaching themselves to `M-left'.
20416 See `org-ctrl-c-ctrl-c-hook' for more information.")
20417 (defvar org-metaright-hook nil
20418 "Hook for functions attaching themselves to `M-right'.
20419 See `org-ctrl-c-ctrl-c-hook' for more information.")
20420 (defvar org-metaup-hook nil
20421 "Hook for functions attaching themselves to `M-up'.
20422 See `org-ctrl-c-ctrl-c-hook' for more information.")
20423 (defvar org-metadown-hook nil
20424 "Hook for functions attaching themselves to `M-down'.
20425 See `org-ctrl-c-ctrl-c-hook' for more information.")
20426 (defvar org-shiftmetaleft-hook nil
20427 "Hook for functions attaching themselves to `M-S-left'.
20428 See `org-ctrl-c-ctrl-c-hook' for more information.")
20429 (defvar org-shiftmetaright-hook nil
20430 "Hook for functions attaching themselves to `M-S-right'.
20431 See `org-ctrl-c-ctrl-c-hook' for more information.")
20432 (defvar org-shiftmetaup-hook nil
20433 "Hook for functions attaching themselves to `M-S-up'.
20434 See `org-ctrl-c-ctrl-c-hook' for more information.")
20435 (defvar org-shiftmetadown-hook nil
20436 "Hook for functions attaching themselves to `M-S-down'.
20437 See `org-ctrl-c-ctrl-c-hook' for more information.")
20438 (defvar org-metareturn-hook nil
20439 "Hook for functions attaching themselves to `M-RET'.
20440 See `org-ctrl-c-ctrl-c-hook' for more information.")
20441 (defvar org-shiftup-hook nil
20442 "Hook for functions attaching themselves to `S-up'.
20443 See `org-ctrl-c-ctrl-c-hook' for more information.")
20444 (defvar org-shiftup-final-hook nil
20445 "Hook for functions attaching themselves to `S-up'.
20446 This one runs after all other options except shift-select have been excluded.
20447 See `org-ctrl-c-ctrl-c-hook' for more information.")
20448 (defvar org-shiftdown-hook nil
20449 "Hook for functions attaching themselves to `S-down'.
20450 See `org-ctrl-c-ctrl-c-hook' for more information.")
20451 (defvar org-shiftdown-final-hook nil
20452 "Hook for functions attaching themselves to `S-down'.
20453 This one runs after all other options except shift-select have been excluded.
20454 See `org-ctrl-c-ctrl-c-hook' for more information.")
20455 (defvar org-shiftleft-hook nil
20456 "Hook for functions attaching themselves to `S-left'.
20457 See `org-ctrl-c-ctrl-c-hook' for more information.")
20458 (defvar org-shiftleft-final-hook nil
20459 "Hook for functions attaching themselves to `S-left'.
20460 This one runs after all other options except shift-select have been excluded.
20461 See `org-ctrl-c-ctrl-c-hook' for more information.")
20462 (defvar org-shiftright-hook nil
20463 "Hook for functions attaching themselves to `S-right'.
20464 See `org-ctrl-c-ctrl-c-hook' for more information.")
20465 (defvar org-shiftright-final-hook nil
20466 "Hook for functions attaching themselves to `S-right'.
20467 This one runs after all other options except shift-select have been excluded.
20468 See `org-ctrl-c-ctrl-c-hook' for more information.")
20470 (defun org-modifier-cursor-error ()
20471 "Throw an error, a modified cursor command was applied in wrong context."
20472 (user-error "This command is active in special context like tables, headlines or items"))
20474 (defun org-shiftselect-error ()
20475 "Throw an error because Shift-Cursor command was applied in wrong context."
20476 (if (and (boundp 'shift-select-mode) shift-select-mode)
20477 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20478 (user-error "This command works only in special context like headlines or timestamps")))
20480 (defun org-call-for-shift-select (cmd)
20481 (let ((this-command-keys-shift-translated t))
20482 (call-interactively cmd)))
20484 (defun org-shifttab (&optional arg)
20485 "Global visibility cycling or move to previous table field.
20486 Call `org-table-previous-field' within a table.
20487 When ARG is nil, cycle globally through visibility states.
20488 When ARG is a numeric prefix, show contents of this level."
20489 (interactive "P")
20490 (cond
20491 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20492 ((integerp arg)
20493 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20494 (message "Content view to level: %d" arg)
20495 (org-content (prefix-numeric-value arg2))
20496 (org-cycle-show-empty-lines t)
20497 (setq org-cycle-global-status 'overview)))
20498 (t (call-interactively 'org-global-cycle))))
20500 (defun org-shiftmetaleft ()
20501 "Promote subtree or delete table column.
20502 Calls `org-promote-subtree', `org-outdent-item-tree', or
20503 `org-table-delete-column', depending on context. See the
20504 individual commands for more information."
20505 (interactive)
20506 (cond
20507 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20508 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20509 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20510 ((if (not (org-region-active-p)) (org-at-item-p)
20511 (save-excursion (goto-char (region-beginning))
20512 (org-at-item-p)))
20513 (call-interactively 'org-outdent-item-tree))
20514 (t (org-modifier-cursor-error))))
20516 (defun org-shiftmetaright ()
20517 "Demote subtree or insert table column.
20518 Calls `org-demote-subtree', `org-indent-item-tree', or
20519 `org-table-insert-column', depending on context. See the
20520 individual commands for more information."
20521 (interactive)
20522 (cond
20523 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20524 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20525 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20526 ((if (not (org-region-active-p)) (org-at-item-p)
20527 (save-excursion (goto-char (region-beginning))
20528 (org-at-item-p)))
20529 (call-interactively 'org-indent-item-tree))
20530 (t (org-modifier-cursor-error))))
20532 (defun org-shiftmetaup (&optional arg)
20533 "Drag the line at point up.
20534 In a table, kill the current row.
20535 On a clock timestamp, update the value of the timestamp like `S-<up>'
20536 but also adjust the previous clocked item in the clock history.
20537 Everywhere else, drag the line at point up."
20538 (interactive "P")
20539 (cond
20540 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20541 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20542 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20543 (call-interactively 'org-timestamp-up)))
20544 (t (call-interactively 'org-drag-line-backward))))
20546 (defun org-shiftmetadown (&optional arg)
20547 "Drag the line at point down.
20548 In a table, insert an empty row at the current line.
20549 On a clock timestamp, update the value of the timestamp like `S-<down>'
20550 but also adjust the previous clocked item in the clock history.
20551 Everywhere else, drag the line at point down."
20552 (interactive "P")
20553 (cond
20554 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20555 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20556 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20557 (call-interactively 'org-timestamp-down)))
20558 (t (call-interactively 'org-drag-line-forward))))
20560 (defsubst org-hidden-tree-error ()
20561 (user-error
20562 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20564 (defun org-metaleft (&optional arg)
20565 "Promote heading, list item at point or move table column left.
20567 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20568 depending on context. With no specific context, calls the Emacs
20569 default `backward-word'. See the individual commands for more
20570 information.
20572 This function runs the hook `org-metaleft-hook' as a first step,
20573 and returns at first non-nil value."
20574 (interactive "P")
20575 (cond
20576 ((run-hook-with-args-until-success 'org-metaleft-hook))
20577 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20578 ((org-with-limited-levels
20579 (or (org-at-heading-p)
20580 (and (org-region-active-p)
20581 (save-excursion
20582 (goto-char (region-beginning))
20583 (org-at-heading-p)))))
20584 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20585 (call-interactively 'org-do-promote))
20586 ;; At an inline task.
20587 ((org-at-heading-p)
20588 (call-interactively 'org-inlinetask-promote))
20589 ((or (org-at-item-p)
20590 (and (org-region-active-p)
20591 (save-excursion
20592 (goto-char (region-beginning))
20593 (org-at-item-p))))
20594 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20595 (call-interactively 'org-outdent-item))
20596 (t (call-interactively 'backward-word))))
20598 (defun org-metaright (&optional arg)
20599 "Demote heading, list item at point or move table column right.
20601 In front of a drawer or a block keyword, indent it correctly.
20603 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20604 `org-indnet-drawer' or `org-indent-block' depending on context.
20605 With no specific context, calls the Emacs default `forward-word'.
20606 See the individual commands for more information.
20608 This function runs the hook `org-metaright-hook' as a first step,
20609 and returns at first non-nil value."
20610 (interactive "P")
20611 (cond
20612 ((run-hook-with-args-until-success 'org-metaright-hook))
20613 ((org-at-table-p) (call-interactively 'org-table-move-column))
20614 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20615 ((org-at-block-p) (call-interactively 'org-indent-block))
20616 ((org-with-limited-levels
20617 (or (org-at-heading-p)
20618 (and (org-region-active-p)
20619 (save-excursion
20620 (goto-char (region-beginning))
20621 (org-at-heading-p)))))
20622 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20623 (call-interactively 'org-do-demote))
20624 ;; At an inline task.
20625 ((org-at-heading-p)
20626 (call-interactively 'org-inlinetask-demote))
20627 ((or (org-at-item-p)
20628 (and (org-region-active-p)
20629 (save-excursion
20630 (goto-char (region-beginning))
20631 (org-at-item-p))))
20632 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20633 (call-interactively 'org-indent-item))
20634 (t (call-interactively 'forward-word))))
20636 (defun org-check-for-hidden (what)
20637 "Check if there are hidden headlines/items in the current visual line.
20638 WHAT can be either `headlines' or `items'. If the current line is
20639 an outline or item heading and it has a folded subtree below it,
20640 this function returns t, nil otherwise."
20641 (let ((re (cond
20642 ((eq what 'headlines) org-outline-regexp-bol)
20643 ((eq what 'items) (org-item-beginning-re))
20644 (t (error "This should not happen"))))
20645 beg end)
20646 (save-excursion
20647 (catch 'exit
20648 (unless (org-region-active-p)
20649 (setq beg (point-at-bol))
20650 (beginning-of-line 2)
20651 (while (and (not (eobp)) ;; this is like `next-line'
20652 (get-char-property (1- (point)) 'invisible))
20653 (beginning-of-line 2))
20654 (setq end (point))
20655 (goto-char beg)
20656 (goto-char (point-at-eol))
20657 (setq end (max end (point)))
20658 (while (re-search-forward re end t)
20659 (when (get-char-property (match-beginning 0) 'invisible)
20660 (throw 'exit t))))
20661 nil))))
20663 (defun org-metaup (&optional arg)
20664 "Move subtree up or move table row up.
20665 Calls `org-move-subtree-up' or `org-table-move-row' or
20666 `org-move-item-up', depending on context. See the individual commands
20667 for more information."
20668 (interactive "P")
20669 (cond
20670 ((run-hook-with-args-until-success 'org-metaup-hook))
20671 ((org-region-active-p)
20672 (let* ((a (min (region-beginning) (region-end)))
20673 (b (1- (max (region-beginning) (region-end))))
20674 (c (save-excursion (goto-char a)
20675 (move-beginning-of-line 0)))
20676 (d (save-excursion (goto-char a)
20677 (move-end-of-line 0) (point))))
20678 (transpose-regions a b c d)
20679 (goto-char c)))
20680 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20681 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20682 ((org-at-item-p) (call-interactively 'org-move-item-up))
20683 (t (org-drag-element-backward))))
20685 (defun org-metadown (&optional arg)
20686 "Move subtree down or move table row down.
20687 Calls `org-move-subtree-down' or `org-table-move-row' or
20688 `org-move-item-down', depending on context. See the individual
20689 commands for more information."
20690 (interactive "P")
20691 (cond
20692 ((run-hook-with-args-until-success 'org-metadown-hook))
20693 ((org-region-active-p)
20694 (let* ((a (min (region-beginning) (region-end)))
20695 (b (max (region-beginning) (region-end)))
20696 (c (save-excursion (goto-char b)
20697 (move-beginning-of-line 1)))
20698 (d (save-excursion (goto-char b)
20699 (move-end-of-line 1) (1+ (point)))))
20700 (transpose-regions a b c d)
20701 (goto-char d)))
20702 ((org-at-table-p) (call-interactively 'org-table-move-row))
20703 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20704 ((org-at-item-p) (call-interactively 'org-move-item-down))
20705 (t (org-drag-element-forward))))
20707 (defun org-shiftup (&optional arg)
20708 "Increase item in timestamp or increase priority of current headline.
20709 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20710 depending on context. See the individual commands for more information."
20711 (interactive "P")
20712 (cond
20713 ((run-hook-with-args-until-success 'org-shiftup-hook))
20714 ((and org-support-shift-select (org-region-active-p))
20715 (org-call-for-shift-select 'previous-line))
20716 ((org-at-timestamp-p t)
20717 (call-interactively (if org-edit-timestamp-down-means-later
20718 'org-timestamp-down 'org-timestamp-up)))
20719 ((and (not (eq org-support-shift-select 'always))
20720 org-enable-priority-commands
20721 (org-at-heading-p))
20722 (call-interactively 'org-priority-up))
20723 ((and (not org-support-shift-select) (org-at-item-p))
20724 (call-interactively 'org-previous-item))
20725 ((org-clocktable-try-shift 'up arg))
20726 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20727 (org-support-shift-select
20728 (org-call-for-shift-select 'previous-line))
20729 (t (org-shiftselect-error))))
20731 (defun org-shiftdown (&optional arg)
20732 "Decrease item in timestamp or decrease priority of current headline.
20733 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20734 depending on context. See the individual commands for more information."
20735 (interactive "P")
20736 (cond
20737 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20738 ((and org-support-shift-select (org-region-active-p))
20739 (org-call-for-shift-select 'next-line))
20740 ((org-at-timestamp-p t)
20741 (call-interactively (if org-edit-timestamp-down-means-later
20742 'org-timestamp-up 'org-timestamp-down)))
20743 ((and (not (eq org-support-shift-select 'always))
20744 org-enable-priority-commands
20745 (org-at-heading-p))
20746 (call-interactively 'org-priority-down))
20747 ((and (not org-support-shift-select) (org-at-item-p))
20748 (call-interactively 'org-next-item))
20749 ((org-clocktable-try-shift 'down arg))
20750 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20751 (org-support-shift-select
20752 (org-call-for-shift-select 'next-line))
20753 (t (org-shiftselect-error))))
20755 (defun org-shiftright (&optional arg)
20756 "Cycle the thing at point or in the current line, depending on context.
20757 Depending on context, this does one of the following:
20759 - switch a timestamp at point one day into the future
20760 - on a headline, switch to the next TODO keyword.
20761 - on an item, switch entire list to the next bullet type
20762 - on a property line, switch to the next allowed value
20763 - on a clocktable definition line, move time block into the future"
20764 (interactive "P")
20765 (cond
20766 ((run-hook-with-args-until-success 'org-shiftright-hook))
20767 ((and org-support-shift-select (org-region-active-p))
20768 (org-call-for-shift-select 'forward-char))
20769 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20770 ((and (not (eq org-support-shift-select 'always))
20771 (org-at-heading-p))
20772 (let ((org-inhibit-logging
20773 (not org-treat-S-cursor-todo-selection-as-state-change))
20774 (org-inhibit-blocking
20775 (not org-treat-S-cursor-todo-selection-as-state-change)))
20776 (org-call-with-arg 'org-todo 'right)))
20777 ((or (and org-support-shift-select
20778 (not (eq org-support-shift-select 'always))
20779 (org-at-item-bullet-p))
20780 (and (not org-support-shift-select) (org-at-item-p)))
20781 (org-call-with-arg 'org-cycle-list-bullet nil))
20782 ((and (not (eq org-support-shift-select 'always))
20783 (org-at-property-p))
20784 (call-interactively 'org-property-next-allowed-value))
20785 ((org-clocktable-try-shift 'right arg))
20786 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20787 (org-support-shift-select
20788 (org-call-for-shift-select 'forward-char))
20789 (t (org-shiftselect-error))))
20791 (defun org-shiftleft (&optional arg)
20792 "Cycle the thing at point or in the current line, depending on context.
20793 Depending on context, this does one of the following:
20795 - switch a timestamp at point one day into the past
20796 - on a headline, switch to the previous TODO keyword.
20797 - on an item, switch entire list to the previous bullet type
20798 - on a property line, switch to the previous allowed value
20799 - on a clocktable definition line, move time block into the past"
20800 (interactive "P")
20801 (cond
20802 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20803 ((and org-support-shift-select (org-region-active-p))
20804 (org-call-for-shift-select 'backward-char))
20805 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20806 ((and (not (eq org-support-shift-select 'always))
20807 (org-at-heading-p))
20808 (let ((org-inhibit-logging
20809 (not org-treat-S-cursor-todo-selection-as-state-change))
20810 (org-inhibit-blocking
20811 (not org-treat-S-cursor-todo-selection-as-state-change)))
20812 (org-call-with-arg 'org-todo 'left)))
20813 ((or (and org-support-shift-select
20814 (not (eq org-support-shift-select 'always))
20815 (org-at-item-bullet-p))
20816 (and (not org-support-shift-select) (org-at-item-p)))
20817 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20818 ((and (not (eq org-support-shift-select 'always))
20819 (org-at-property-p))
20820 (call-interactively 'org-property-previous-allowed-value))
20821 ((org-clocktable-try-shift 'left arg))
20822 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20823 (org-support-shift-select
20824 (org-call-for-shift-select 'backward-char))
20825 (t (org-shiftselect-error))))
20827 (defun org-shiftcontrolright ()
20828 "Switch to next TODO set."
20829 (interactive)
20830 (cond
20831 ((and org-support-shift-select (org-region-active-p))
20832 (org-call-for-shift-select 'forward-word))
20833 ((and (not (eq org-support-shift-select 'always))
20834 (org-at-heading-p))
20835 (org-call-with-arg 'org-todo 'nextset))
20836 (org-support-shift-select
20837 (org-call-for-shift-select 'forward-word))
20838 (t (org-shiftselect-error))))
20840 (defun org-shiftcontrolleft ()
20841 "Switch to previous TODO set."
20842 (interactive)
20843 (cond
20844 ((and org-support-shift-select (org-region-active-p))
20845 (org-call-for-shift-select 'backward-word))
20846 ((and (not (eq org-support-shift-select 'always))
20847 (org-at-heading-p))
20848 (org-call-with-arg 'org-todo 'previousset))
20849 (org-support-shift-select
20850 (org-call-for-shift-select 'backward-word))
20851 (t (org-shiftselect-error))))
20853 (defun org-shiftcontrolup (&optional n)
20854 "Change timestamps synchronously up in CLOCK log lines.
20855 Optional argument N tells to change by that many units."
20856 (interactive "P")
20857 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20858 (let (org-support-shift-select)
20859 (org-clock-timestamps-up n))
20860 (user-error "Not at a clock log")))
20862 (defun org-shiftcontroldown (&optional n)
20863 "Change timestamps synchronously down in CLOCK log lines.
20864 Optional argument N tells to change by that many units."
20865 (interactive "P")
20866 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20867 (let (org-support-shift-select)
20868 (org-clock-timestamps-down n))
20869 (user-error "Not at a clock log")))
20871 (defun org-increase-number-at-point (&optional inc)
20872 "Increment the number at point.
20873 With an optional prefix numeric argument INC, increment using
20874 this numeric value."
20875 (interactive "p")
20876 (if (not (number-at-point))
20877 (user-error "Not on a number")
20878 (unless inc (setq inc 1))
20879 (let ((pos (point))
20880 (beg (skip-chars-backward "-+^/*0-9eE."))
20881 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20882 (setq nap (buffer-substring-no-properties
20883 (+ pos beg) (+ pos beg end)))
20884 (delete-region (+ pos beg) (+ pos beg end))
20885 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20886 (when (org-at-table-p)
20887 (org-table-align)
20888 (org-table-end-of-field 1))))
20890 (defun org-decrease-number-at-point (&optional inc)
20891 "Decrement the number at point.
20892 With an optional prefix numeric argument INC, decrement using
20893 this numeric value."
20894 (interactive "p")
20895 (org-increase-number-at-point (- (or inc 1))))
20897 (defun org-ctrl-c-ret ()
20898 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20899 (interactive)
20900 (cond
20901 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20902 (t (call-interactively 'org-insert-heading))))
20904 (defun org-find-visible ()
20905 (let ((s (point)))
20906 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20907 (get-char-property s 'invisible)))
20909 (defun org-find-invisible ()
20910 (let ((s (point)))
20911 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20912 (not (get-char-property s 'invisible))))
20915 (defun org-copy-visible (beg end)
20916 "Copy the visible parts of the region."
20917 (interactive "r")
20918 (let (snippets s)
20919 (save-excursion
20920 (save-restriction
20921 (narrow-to-region beg end)
20922 (setq s (goto-char (point-min)))
20923 (while (not (= (point) (point-max)))
20924 (goto-char (org-find-invisible))
20925 (push (buffer-substring s (point)) snippets)
20926 (setq s (goto-char (org-find-visible))))))
20927 (kill-new (apply 'concat (nreverse snippets)))))
20929 (defun org-copy-special ()
20930 "Copy region in table or copy current subtree.
20931 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20932 See the individual commands for more information."
20933 (interactive)
20934 (call-interactively
20935 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20937 (defun org-cut-special ()
20938 "Cut region in table or cut current subtree.
20939 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20940 See the individual commands for more information."
20941 (interactive)
20942 (call-interactively
20943 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20945 (defun org-paste-special (arg)
20946 "Paste rectangular region into table, or past subtree relative to level.
20947 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20948 See the individual commands for more information."
20949 (interactive "P")
20950 (if (org-at-table-p)
20951 (org-table-paste-rectangle)
20952 (org-paste-subtree arg)))
20954 (defsubst org-in-fixed-width-region-p ()
20955 "Is point in a fixed-width region?"
20956 (save-match-data
20957 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20959 (defun org-edit-special (&optional arg)
20960 "Call a special editor for the element at point.
20961 When at a table, call the formula editor with `org-table-edit-formulas'.
20962 When in a source code block, call `org-edit-src-code'.
20963 When in a fixed-width region, call `org-edit-fixed-width-region'.
20964 When in an export block, call `org-edit-export-block'.
20965 When at an #+INCLUDE keyword, visit the included file.
20966 When at a footnote reference, call `org-edit-footnote-reference'
20967 On a link, call `ffap' to visit the link at point.
20968 Otherwise, return a user error."
20969 (interactive "P")
20970 (let ((element (org-element-at-point)))
20971 (assert (not buffer-read-only) nil
20972 "Buffer is read-only: %s" (buffer-name))
20973 (case (org-element-type element)
20974 (src-block
20975 (if (not arg) (org-edit-src-code)
20976 (let* ((info (org-babel-get-src-block-info))
20977 (lang (nth 0 info))
20978 (params (nth 2 info))
20979 (session (cdr (assq :session params))))
20980 (if (not session) (org-edit-src-code)
20981 ;; At a src-block with a session and function called with
20982 ;; an ARG: switch to the buffer related to the inferior
20983 ;; process.
20984 (switch-to-buffer
20985 (funcall (intern (concat "org-babel-prep-session:" lang))
20986 session params))))))
20987 (keyword
20988 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20989 (org-open-link-from-string
20990 (format "[[%s]]"
20991 (expand-file-name
20992 (let ((value (org-element-property :value element)))
20993 (cond ((not (org-string-nw-p value))
20994 (user-error "No file to edit"))
20995 ((string-match "\\`\"\\(.*?\\)\"" value)
20996 (match-string 1 value))
20997 ((string-match "\\`[^ \t\"]\\S-*" value)
20998 (match-string 0 value))
20999 (t (user-error "No valid file specified")))))))
21000 (user-error "No special environment to edit here")))
21001 (table
21002 (if (eq (org-element-property :type element) 'table.el)
21003 (org-edit-table.el)
21004 (call-interactively 'org-table-edit-formulas)))
21005 ;; Only Org tables contain `table-row' type elements.
21006 (table-row (call-interactively 'org-table-edit-formulas))
21007 (example-block (org-edit-src-code))
21008 (export-block (org-edit-export-block))
21009 (fixed-width (org-edit-fixed-width-region))
21010 (otherwise
21011 ;; No notable element at point. Though, we may be at a link or
21012 ;; a footnote reference, which are objects. Thus, scan deeper.
21013 (let ((context (org-element-context element)))
21014 (case (org-element-type context)
21015 (link (call-interactively #'ffap))
21016 (footnote-reference (org-edit-footnote-reference))
21017 (t (user-error "No special environment to edit here"))))))))
21019 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21020 (defun org-ctrl-c-ctrl-c (&optional arg)
21021 "Set tags in headline, or update according to changed information at point.
21023 This command does many different things, depending on context:
21025 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21026 this is what we do.
21028 - If the cursor is on a statistics cookie, update it.
21030 - If the cursor is in a headline, prompt for tags and insert them
21031 into the current line, aligned to `org-tags-column'. When called
21032 with prefix arg, realign all tags in the current buffer.
21034 - If the cursor is in one of the special #+KEYWORD lines, this
21035 triggers scanning the buffer for these lines and updating the
21036 information.
21038 - If the cursor is inside a table, realign the table. This command
21039 works even if the automatic table editor has been turned off.
21041 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21042 the entire table.
21044 - If the cursor is at a footnote reference or definition, jump to
21045 the corresponding definition or references, respectively.
21047 - If the cursor is a the beginning of a dynamic block, update it.
21049 - If the current buffer is a capture buffer, close note and file it.
21051 - If the cursor is on a <<<target>>>, update radio targets and
21052 corresponding links in this buffer.
21054 - If the cursor is on a numbered item in a plain list, renumber the
21055 ordered list.
21057 - If the cursor is on a checkbox, toggle it.
21059 - If the cursor is on a code block, evaluate it. The variable
21060 `org-confirm-babel-evaluate' can be used to control prompting
21061 before code block evaluation, by default every code block
21062 evaluation requires confirmation. Code block evaluation can be
21063 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21064 (interactive "P")
21065 (cond
21066 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21067 org-occur-highlights)
21068 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21069 (org-remove-occur-highlights)
21070 (message "Temporary highlights/overlays removed from current buffer"))
21071 ((and (local-variable-p 'org-finish-function (current-buffer))
21072 (fboundp org-finish-function))
21073 (funcall org-finish-function))
21074 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21076 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21077 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21078 (user-error "C-c C-c can do nothing useful at this location"))
21079 (let* ((context (org-element-context))
21080 (type (org-element-type context)))
21081 (case type
21082 ;; When at a link, act according to the parent instead.
21083 (link (setq context (org-element-property :parent context))
21084 (setq type (org-element-type context)))
21085 ;; Unsupported object types: refer to the first supported
21086 ;; element or object containing it.
21087 ((bold code entity export-snippet inline-babel-call inline-src-block
21088 italic latex-fragment line-break macro strike-through subscript
21089 superscript underline verbatim)
21090 (setq context
21091 (org-element-lineage
21092 context '(radio-target paragraph verse-block table-cell)))))
21093 ;; For convenience: at the first line of a paragraph on the
21094 ;; same line as an item, apply function on that item instead.
21095 (when (eq type 'paragraph)
21096 (let ((parent (org-element-property :parent context)))
21097 (when (and (eq (org-element-type parent) 'item)
21098 (= (line-beginning-position)
21099 (org-element-property :begin parent)))
21100 (setq context parent type 'item))))
21101 ;; Act according to type of element or object at point.
21102 (case type
21103 (clock (org-clock-update-time-maybe))
21104 (dynamic-block
21105 (save-excursion
21106 (goto-char (org-element-property :post-affiliated context))
21107 (org-update-dblock)))
21108 (footnote-definition
21109 (goto-char (org-element-property :post-affiliated context))
21110 (call-interactively 'org-footnote-action))
21111 (footnote-reference (call-interactively 'org-footnote-action))
21112 ((headline inlinetask)
21113 (save-excursion (goto-char (org-element-property :begin context))
21114 (call-interactively 'org-set-tags)))
21115 (item
21116 ;; At an item: a double C-u set checkbox to "[-]"
21117 ;; unconditionally, whereas a single one will toggle its
21118 ;; presence. Without a universal argument, if the item
21119 ;; has a checkbox, toggle it. Otherwise repair the list.
21120 (let* ((box (org-element-property :checkbox context))
21121 (struct (org-element-property :structure context))
21122 (old-struct (copy-tree struct))
21123 (parents (org-list-parents-alist struct))
21124 (prevs (org-list-prevs-alist struct))
21125 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21126 (org-list-set-checkbox
21127 (org-element-property :begin context) struct
21128 (cond ((equal arg '(16)) "[-]")
21129 ((and (not box) (equal arg '(4))) "[ ]")
21130 ((or (not box) (equal arg '(4))) nil)
21131 ((eq box 'on) "[ ]")
21132 (t "[X]")))
21133 ;; Mimic `org-list-write-struct' but with grabbing
21134 ;; a return value from `org-list-struct-fix-box'.
21135 (org-list-struct-fix-ind struct parents 2)
21136 (org-list-struct-fix-item-end struct)
21137 (org-list-struct-fix-bul struct prevs)
21138 (org-list-struct-fix-ind struct parents)
21139 (let ((block-item
21140 (org-list-struct-fix-box struct parents prevs orderedp)))
21141 (if (and box (equal struct old-struct))
21142 (if (equal arg '(16))
21143 (message "Checkboxes already reset")
21144 (user-error "Cannot toggle this checkbox: %s"
21145 (if (eq box 'on)
21146 "all subitems checked"
21147 "unchecked subitems")))
21148 (org-list-struct-apply-struct struct old-struct)
21149 (org-update-checkbox-count-maybe))
21150 (when block-item
21151 (message "Checkboxes were removed due to empty box at line %d"
21152 (org-current-line block-item))))))
21153 (keyword
21154 (let ((org-inhibit-startup-visibility-stuff t)
21155 (org-startup-align-all-tables nil))
21156 (when (boundp 'org-table-coordinate-overlays)
21157 (mapc 'delete-overlay org-table-coordinate-overlays)
21158 (setq org-table-coordinate-overlays nil))
21159 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21160 (message "Local setup has been refreshed"))
21161 (plain-list
21162 ;; At a plain list, with a double C-u argument, set
21163 ;; checkboxes of each item to "[-]", whereas a single one
21164 ;; will toggle their presence according to the state of the
21165 ;; first item in the list. Without an argument, repair the
21166 ;; list.
21167 (let* ((begin (org-element-property :contents-begin context))
21168 (beginm (move-marker (make-marker) begin))
21169 (struct (org-element-property :structure context))
21170 (old-struct (copy-tree struct))
21171 (first-box (save-excursion
21172 (goto-char begin)
21173 (looking-at org-list-full-item-re)
21174 (match-string-no-properties 3)))
21175 (new-box (cond ((equal arg '(16)) "[-]")
21176 ((equal arg '(4)) (unless first-box "[ ]"))
21177 ((equal first-box "[X]") "[ ]")
21178 (t "[X]"))))
21179 (cond
21180 (arg
21181 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21182 (org-list-get-all-items
21183 begin struct (org-list-prevs-alist struct))))
21184 ((and first-box (eq (point) begin))
21185 ;; For convenience, when point is at bol on the first
21186 ;; item of the list and no argument is provided, simply
21187 ;; toggle checkbox of that item, if any.
21188 (org-list-set-checkbox begin struct new-box)))
21189 (org-list-write-struct
21190 struct (org-list-parents-alist struct) old-struct)
21191 (org-update-checkbox-count-maybe)
21192 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21193 ((property-drawer node-property)
21194 (call-interactively 'org-property-action))
21195 ((radio-target target)
21196 (call-interactively 'org-update-radio-target-regexp))
21197 (statistics-cookie
21198 (call-interactively 'org-update-statistics-cookies))
21199 ((table table-cell table-row)
21200 ;; At a table, recalculate every field and align it. Also
21201 ;; send the table if necessary. If the table has
21202 ;; a `table.el' type, just give up. At a table row or
21203 ;; cell, maybe recalculate line but always align table.
21204 (if (eq (org-element-property :type context) 'table.el)
21205 (message "%s" (substitute-command-keys "\\<org-mode-map>\
21206 Use \\[org-edit-special] to edit table.el tables"))
21207 (let ((org-enable-table-editor t))
21208 (if (or (eq type 'table)
21209 ;; Check if point is at a TBLFM line.
21210 (and (eq type 'table-row)
21211 (= (point) (org-element-property :end context))))
21212 (save-excursion
21213 (if (org-at-TBLFM-p)
21214 (progn (require 'org-table)
21215 (org-table-calc-current-TBLFM))
21216 (goto-char (org-element-property :contents-begin context))
21217 (org-call-with-arg 'org-table-recalculate (or arg t))
21218 (orgtbl-send-table 'maybe)))
21219 (org-table-maybe-eval-formula)
21220 (cond (arg (call-interactively 'org-table-recalculate))
21221 ((org-table-maybe-recalculate-line))
21222 (t (org-table-align)))))))
21223 (timestamp (org-timestamp-change 0 'day))
21224 (otherwise
21225 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21226 (user-error
21227 "C-c C-c can do nothing useful at this location")))))))))
21229 (defun org-mode-restart ()
21230 (interactive)
21231 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21232 (funcall major-mode)
21233 (hack-local-variables)
21234 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21235 (org-indent-mode -1)))
21236 (message "%s restarted" major-mode))
21238 (defun org-kill-note-or-show-branches ()
21239 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21240 (interactive)
21241 (if (not org-finish-function)
21242 (progn
21243 (outline-hide-subtree)
21244 (call-interactively 'outline-show-branches))
21245 (let ((org-note-abort t))
21246 (funcall org-finish-function))))
21248 (defun org-delete-indentation (&optional ARG)
21249 "Join current line to previous and fix whitespace at join.
21251 If previous line is a headline add to headline title. Otherwise
21252 the function calls `delete-indentation'.
21254 With argument, join this line to following line."
21255 (interactive "*P")
21256 (if (save-excursion
21257 (if ARG (beginning-of-line)
21258 (forward-line -1))
21259 (looking-at org-complex-heading-regexp))
21260 ;; At headline.
21261 (let ((tags-column (when (match-beginning 5)
21262 (save-excursion (goto-char (match-beginning 5))
21263 (current-column))))
21264 (string (concat " " (progn (when ARG (forward-line 1))
21265 (org-trim (delete-and-extract-region
21266 (line-beginning-position)
21267 (line-end-position)))))))
21268 (unless (bobp) (delete-region (point) (1- (point))))
21269 (goto-char (or (match-end 4)
21270 (match-beginning 5)
21271 (match-end 0)))
21272 (skip-chars-backward " \t")
21273 (save-excursion (insert string))
21274 ;; Adjust alignment of tags.
21275 (when tags-column
21276 (org-align-tags-here (if org-auto-align-tags
21277 org-tags-column
21278 tags-column))))
21279 (delete-indentation ARG)))
21281 (defun org-open-line (n)
21282 "Insert a new row in tables, call `open-line' elsewhere.
21283 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21284 (interactive "*p")
21285 (cond
21286 ((not org-special-ctrl-o)
21287 (open-line n))
21288 ((org-at-table-p)
21289 (org-table-insert-row))
21291 (open-line n))))
21293 (defun org-return (&optional indent)
21294 "Goto next table row or insert a newline.
21296 Calls `org-table-next-row' or `newline', depending on context.
21298 When optional INDENT argument is non-nil, call
21299 `newline-and-indent' instead of `newline'.
21301 When `org-return-follows-link' is non-nil and point is on
21302 a timestamp or a link, call `org-open-at-point'. However, it
21303 will not happen if point is in a table or on a \"dead\"
21304 object (e.g., within a comment). In these case, you need to use
21305 `org-open-at-point' directly."
21306 (interactive)
21307 (let ((context (if org-return-follows-link (org-element-context)
21308 (org-element-at-point))))
21309 (cond
21310 ;; In a table, call `org-table-next-row'.
21311 ((or (and (eq (org-element-type context) 'table)
21312 (>= (point) (org-element-property :contents-begin context))
21313 (< (point) (org-element-property :contents-end context)))
21314 (org-element-lineage context '(table-row table-cell) t))
21315 (org-table-justify-field-maybe)
21316 (call-interactively #'org-table-next-row))
21317 ;; On a link or a timestamp, call `org-open-at-point' if
21318 ;; `org-return-follows-link' allows it. Tolerate fuzzy
21319 ;; locations, e.g., in a comment, as `org-open-at-point'.
21320 ((and org-return-follows-link
21321 (or (org-in-regexp org-ts-regexp-both nil t)
21322 (org-in-regexp org-tsr-regexp-both nil t)
21323 (org-in-regexp org-any-link-re nil t)))
21324 (call-interactively #'org-open-at-point))
21325 ;; Insert newline in heading, but preserve tags.
21326 ((and (not (bolp))
21327 (save-excursion (beginning-of-line)
21328 (looking-at org-complex-heading-regexp)))
21329 ;; At headline. Split line. However, if point is on keyword,
21330 ;; priority cookie or tags, do not break any of them: add
21331 ;; a newline after the headline instead.
21332 (let ((tags-column (and (match-beginning 5)
21333 (save-excursion (goto-char (match-beginning 5))
21334 (current-column))))
21335 (string
21336 (when (and (match-end 4)
21337 (>= (point)
21338 (or (match-end 3) (match-end 2) (1+ (match-end 1))))
21339 (<= (point) (match-end 4)))
21340 (delete-and-extract-region (point) (match-end 4)))))
21341 (when (and tags-column string) ; Adjust tag alignment.
21342 (org-align-tags-here
21343 (if org-auto-align-tags org-tags-column tags-column)))
21344 (end-of-line)
21345 (org-show-entry)
21346 (if indent (newline-and-indent) (newline))
21347 (when string (save-excursion (insert (org-trim string))))))
21348 ;; In a list, make sure indenting keeps trailing text within.
21349 ((and indent
21350 (not (eolp))
21351 (org-element-lineage context '(item)))
21352 (let ((trailing-data
21353 (delete-and-extract-region (point) (line-end-position))))
21354 (newline-and-indent)
21355 (save-excursion (insert trailing-data))))
21356 (t (if indent (newline-and-indent) (newline))))))
21358 (defun org-return-indent ()
21359 "Goto next table row or insert a newline and indent.
21360 Calls `org-table-next-row' or `newline-and-indent', depending on
21361 context. See the individual commands for more information."
21362 (interactive)
21363 (org-return t))
21365 (defun org-ctrl-c-star ()
21366 "Compute table, or change heading status of lines.
21367 Calls `org-table-recalculate' or `org-toggle-heading',
21368 depending on context."
21369 (interactive)
21370 (cond
21371 ((org-at-table-p)
21372 (call-interactively 'org-table-recalculate))
21374 ;; Convert all lines in region to list items
21375 (call-interactively 'org-toggle-heading))))
21377 (defun org-ctrl-c-minus ()
21378 "Insert separator line in table or modify bullet status of line.
21379 Also turns a plain line or a region of lines into list items.
21380 Calls `org-table-insert-hline', `org-toggle-item', or
21381 `org-cycle-list-bullet', depending on context."
21382 (interactive)
21383 (cond
21384 ((org-at-table-p)
21385 (call-interactively 'org-table-insert-hline))
21386 ((org-region-active-p)
21387 (call-interactively 'org-toggle-item))
21388 ((org-in-item-p)
21389 (call-interactively 'org-cycle-list-bullet))
21391 (call-interactively 'org-toggle-item))))
21393 (defun org-toggle-item (arg)
21394 "Convert headings or normal lines to items, items to normal lines.
21395 If there is no active region, only the current line is considered.
21397 If the first non blank line in the region is a headline, convert
21398 all headlines to items, shifting text accordingly.
21400 If it is an item, convert all items to normal lines.
21402 If it is normal text, change region into a list of items.
21403 With a prefix argument ARG, change the region in a single item."
21404 (interactive "P")
21405 (let ((shift-text
21406 (function
21407 ;; Shift text in current section to IND, from point to END.
21408 ;; The function leaves point to END line.
21409 (lambda (ind end)
21410 (let ((min-i 1000) (end (copy-marker end)))
21411 ;; First determine the minimum indentation (MIN-I) of
21412 ;; the text.
21413 (save-excursion
21414 (catch 'exit
21415 (while (< (point) end)
21416 (let ((i (org-get-indentation)))
21417 (cond
21418 ;; Skip blank lines and inline tasks.
21419 ((looking-at "^[ \t]*$"))
21420 ((looking-at org-outline-regexp-bol))
21421 ;; We can't find less than 0 indentation.
21422 ((zerop i) (throw 'exit (setq min-i 0)))
21423 ((< i min-i) (setq min-i i))))
21424 (forward-line))))
21425 ;; Then indent each line so that a line indented to
21426 ;; MIN-I becomes indented to IND. Ignore blank lines
21427 ;; and inline tasks in the process.
21428 (let ((delta (- ind min-i)))
21429 (while (< (point) end)
21430 (unless (or (looking-at "^[ \t]*$")
21431 (looking-at org-outline-regexp-bol))
21432 (org-indent-line-to (+ (org-get-indentation) delta)))
21433 (forward-line)))))))
21434 (skip-blanks
21435 (function
21436 ;; Return beginning of first non-blank line, starting from
21437 ;; line at POS.
21438 (lambda (pos)
21439 (save-excursion
21440 (goto-char pos)
21441 (skip-chars-forward " \r\t\n")
21442 (point-at-bol)))))
21443 beg end)
21444 ;; Determine boundaries of changes.
21445 (if (org-region-active-p)
21446 (setq beg (funcall skip-blanks (region-beginning))
21447 end (copy-marker (region-end)))
21448 (setq beg (funcall skip-blanks (point-at-bol))
21449 end (copy-marker (point-at-eol))))
21450 ;; Depending on the starting line, choose an action on the text
21451 ;; between BEG and END.
21452 (org-with-limited-levels
21453 (save-excursion
21454 (goto-char beg)
21455 (cond
21456 ;; Case 1. Start at an item: de-itemize. Note that it only
21457 ;; happens when a region is active: `org-ctrl-c-minus'
21458 ;; would call `org-cycle-list-bullet' otherwise.
21459 ((org-at-item-p)
21460 (while (< (point) end)
21461 (when (org-at-item-p)
21462 (skip-chars-forward " \t")
21463 (delete-region (point) (match-end 0)))
21464 (forward-line)))
21465 ;; Case 2. Start at an heading: convert to items.
21466 ((org-at-heading-p)
21467 (let* ((bul (org-list-bullet-string "-"))
21468 (bul-len (length bul))
21469 (done (org-entry-is-done-p))
21470 (todo (org-entry-is-todo-p))
21471 ;; Indentation of the first heading. It should be
21472 ;; relative to the indentation of its parent, if any.
21473 (start-ind (save-excursion
21474 (cond
21475 ((not org-adapt-indentation) 0)
21476 ((not (outline-previous-heading)) 0)
21477 (t (length (match-string 0))))))
21478 ;; Level of first heading. Further headings will be
21479 ;; compared to it to determine hierarchy in the list.
21480 (ref-level (org-reduced-level (org-outline-level))))
21481 (when (or done todo) (org-todo ""))
21482 (while (< (point) end)
21483 (let* ((level (org-reduced-level (org-outline-level)))
21484 (delta (max 0 (- level ref-level))))
21485 ;; If current headline is less indented than the first
21486 ;; one, set it as reference, in order to preserve
21487 ;; subtrees.
21488 (when (< level ref-level) (setq ref-level level))
21489 (replace-match bul t t)
21490 (org-indent-line-to (+ start-ind (* delta bul-len)))
21491 (when (or done todo)
21492 (let* ((struct (org-list-struct))
21493 (old (copy-tree struct)))
21494 (org-list-set-checkbox (line-beginning-position)
21495 struct
21496 (if done "[X]" "[ ]"))
21497 (org-list-write-struct struct
21498 (org-list-parents-alist struct)
21499 old)))
21500 ;; Ensure all text down to END (or SECTION-END) belongs
21501 ;; to the newly created item.
21502 (let ((section-end (save-excursion
21503 (or (outline-next-heading) (point)))))
21504 (forward-line)
21505 (funcall shift-text
21506 (+ start-ind (* (1+ delta) bul-len))
21507 (min end section-end)))))))
21508 ;; Case 3. Normal line with ARG: make the first line of region
21509 ;; an item, and shift indentation of others lines to
21510 ;; set them as item's body.
21511 (arg (let* ((bul (org-list-bullet-string "-"))
21512 (bul-len (length bul))
21513 (ref-ind (org-get-indentation)))
21514 (skip-chars-forward " \t")
21515 (insert bul)
21516 (forward-line)
21517 (while (< (point) end)
21518 ;; Ensure that lines less indented than first one
21519 ;; still get included in item body.
21520 (funcall shift-text
21521 (+ ref-ind bul-len)
21522 (min end (save-excursion (or (outline-next-heading)
21523 (point)))))
21524 (forward-line))))
21525 ;; Case 4. Normal line without ARG: turn each non-item line
21526 ;; into an item.
21528 (while (< (point) end)
21529 (unless (or (org-at-heading-p) (org-at-item-p))
21530 (when (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21531 (replace-match
21532 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21533 (forward-line))))))))
21535 (defun org-toggle-heading (&optional nstars)
21536 "Convert headings to normal text, or items or text to headings.
21537 If there is no active region, only convert the current line.
21539 With a \\[universal-argument] prefix, convert the whole list at
21540 point into heading.
21542 In a region:
21544 - If the first non blank line is a headline, remove the stars
21545 from all headlines in the region.
21547 - If it is a normal line, turn each and every normal line (i.e.,
21548 not an heading or an item) in the region into headings. If you
21549 want to convert only the first line of this region, use one
21550 universal prefix argument.
21552 - If it is a plain list item, turn all plain list items into headings.
21554 When converting a line into a heading, the number of stars is chosen
21555 such that the lines become children of the current entry. However,
21556 when a numeric prefix argument is given, its value determines the
21557 number of stars to add."
21558 (interactive "P")
21559 (let ((skip-blanks
21560 (function
21561 ;; Return beginning of first non-blank line, starting from
21562 ;; line at POS.
21563 (lambda (pos)
21564 (save-excursion
21565 (goto-char pos)
21566 (while (org-at-comment-p) (forward-line))
21567 (skip-chars-forward " \r\t\n")
21568 (point-at-bol)))))
21569 beg end toggled)
21570 ;; Determine boundaries of changes. If a universal prefix has
21571 ;; been given, put the list in a region. If region ends at a bol,
21572 ;; do not consider the last line to be in the region.
21574 (when (and current-prefix-arg (org-at-item-p))
21575 (when (listp current-prefix-arg) (setq current-prefix-arg 1))
21576 (org-mark-element))
21578 (if (org-region-active-p)
21579 (setq beg (funcall skip-blanks (region-beginning))
21580 end (copy-marker (save-excursion
21581 (goto-char (region-end))
21582 (if (bolp) (point) (point-at-eol)))))
21583 (setq beg (funcall skip-blanks (point-at-bol))
21584 end (copy-marker (point-at-eol))))
21585 ;; Ensure inline tasks don't count as headings.
21586 (org-with-limited-levels
21587 (save-excursion
21588 (goto-char beg)
21589 (cond
21590 ;; Case 1. Started at an heading: de-star headings.
21591 ((org-at-heading-p)
21592 (while (< (point) end)
21593 (when (org-at-heading-p t)
21594 (looking-at org-outline-regexp) (replace-match "")
21595 (setq toggled t))
21596 (forward-line)))
21597 ;; Case 2. Started at an item: change items into headlines.
21598 ;; One star will be added by `org-list-to-subtree'.
21599 ((org-at-item-p)
21600 (while (< (point) end)
21601 (when (org-at-item-p)
21602 ;; Pay attention to cases when region ends before list.
21603 (let* ((struct (org-list-struct))
21604 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21605 (save-restriction
21606 (narrow-to-region (point) list-end)
21607 (insert (org-list-to-subtree (org-list-parse-list t)))))
21608 (setq toggled t))
21609 (forward-line)))
21610 ;; Case 3. Started at normal text: make every line an heading,
21611 ;; skipping headlines and items.
21612 (t (let* ((stars
21613 (make-string
21614 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21615 (add-stars
21616 (cond (nstars "") ; stars from prefix only
21617 ((equal stars "") "*") ; before first heading
21618 (org-odd-levels-only "**") ; inside heading, odd
21619 (t "*"))) ; inside heading, oddeven
21620 (rpl (concat stars add-stars " "))
21621 (lend (when (listp nstars) (save-excursion (end-of-line) (point)))))
21622 (while (< (point) (if (equal nstars '(4)) lend end))
21623 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21624 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21625 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21626 (forward-line)))))))
21627 (unless toggled (message "Cannot toggle heading from here"))))
21629 (defun org-meta-return (&optional _arg)
21630 "Insert a new heading or wrap a region in a table.
21631 Calls `org-insert-heading' or `org-table-wrap-region', depending
21632 on context. See the individual commands for more information."
21633 (interactive)
21634 (org-check-before-invisible-edit 'insert)
21635 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21636 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21637 #'org-insert-heading))))
21639 ;;; Menu entries
21641 (defsubst org-in-subtree-not-table-p ()
21642 "Are we in a subtree and not in a table?"
21643 (and (not (org-before-first-heading-p))
21644 (not (org-at-table-p))))
21646 ;; Define the Org-mode menus
21647 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21648 '("Tbl"
21649 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21650 ["Next Field" org-cycle (org-at-table-p)]
21651 ["Previous Field" org-shifttab (org-at-table-p)]
21652 ["Next Row" org-return (org-at-table-p)]
21653 "--"
21654 ["Blank Field" org-table-blank-field (org-at-table-p)]
21655 ["Edit Field" org-table-edit-field (org-at-table-p)]
21656 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21657 "--"
21658 ("Column"
21659 ["Move Column Left" org-metaleft (org-at-table-p)]
21660 ["Move Column Right" org-metaright (org-at-table-p)]
21661 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21662 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21663 ("Row"
21664 ["Move Row Up" org-metaup (org-at-table-p)]
21665 ["Move Row Down" org-metadown (org-at-table-p)]
21666 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21667 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21668 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21669 "--"
21670 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21671 ("Rectangle"
21672 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21673 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21674 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21675 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21676 "--"
21677 ("Calculate"
21678 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21679 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21680 ["Edit Formulas" org-edit-special (org-at-table-p)]
21681 "--"
21682 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21683 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21684 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21685 "--"
21686 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21687 "--"
21688 ["Sum Column/Rectangle" org-table-sum
21689 (or (org-at-table-p) (org-region-active-p))]
21690 ["Which Column?" org-table-current-column (org-at-table-p)])
21691 ["Debug Formulas"
21692 org-table-toggle-formula-debugger
21693 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21694 ["Show Col/Row Numbers"
21695 org-table-toggle-coordinate-overlays
21696 :style toggle
21697 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21698 "--"
21699 ["Create" org-table-create (and (not (org-at-table-p))
21700 org-enable-table-editor)]
21701 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21702 ["Import from File" org-table-import (not (org-at-table-p))]
21703 ["Export to File" org-table-export (org-at-table-p)]
21704 "--"
21705 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21706 "--"
21707 ("Plot"
21708 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21709 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21711 (easy-menu-define org-org-menu org-mode-map "Org menu"
21712 '("Org"
21713 ("Show/Hide"
21714 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21715 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21716 ["Sparse Tree..." org-sparse-tree t]
21717 ["Reveal Context" org-reveal t]
21718 ["Show All" outline-show-all t]
21719 "--"
21720 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21721 "--"
21722 ["New Heading" org-insert-heading t]
21723 ("Navigate Headings"
21724 ["Up" outline-up-heading t]
21725 ["Next" outline-next-visible-heading t]
21726 ["Previous" outline-previous-visible-heading t]
21727 ["Next Same Level" outline-forward-same-level t]
21728 ["Previous Same Level" outline-backward-same-level t]
21729 "--"
21730 ["Jump" org-goto t])
21731 ("Edit Structure"
21732 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21733 "--"
21734 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21735 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21736 "--"
21737 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21738 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21739 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21740 "--"
21741 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21742 "--"
21743 ["Copy visible text" org-copy-visible t]
21744 "--"
21745 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21746 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21747 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21748 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21749 "--"
21750 ["Sort Region/Children" org-sort t]
21751 "--"
21752 ["Convert to odd levels" org-convert-to-odd-levels t]
21753 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21754 ("Editing"
21755 ["Emphasis..." org-emphasize t]
21756 ["Edit Source Example" org-edit-special t]
21757 "--"
21758 ["Footnote new/jump" org-footnote-action t]
21759 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21760 ("Archive"
21761 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21762 "--"
21763 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21764 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21765 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21767 "--"
21768 ("Hyperlinks"
21769 ["Store Link (Global)" org-store-link t]
21770 ["Find existing link to here" org-occur-link-in-agenda-files t]
21771 ["Insert Link" org-insert-link t]
21772 ["Follow Link" org-open-at-point t]
21773 "--"
21774 ["Next link" org-next-link t]
21775 ["Previous link" org-previous-link t]
21776 "--"
21777 ["Descriptive Links"
21778 org-toggle-link-display
21779 :style radio
21780 :selected org-descriptive-links
21782 ["Literal Links"
21783 org-toggle-link-display
21784 :style radio
21785 :selected (not org-descriptive-links)])
21786 "--"
21787 ("TODO Lists"
21788 ["TODO/DONE/-" org-todo t]
21789 ("Select keyword"
21790 ["Next keyword" org-shiftright (org-at-heading-p)]
21791 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21792 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21793 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21794 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21795 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21796 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21797 "--"
21798 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21799 :selected org-enforce-todo-dependencies :style toggle :active t]
21800 "Settings for tree at point"
21801 ["Do Children sequentially" org-toggle-ordered-property :style radio
21802 :selected (org-entry-get nil "ORDERED")
21803 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21804 ["Do Children parallel" org-toggle-ordered-property :style radio
21805 :selected (not (org-entry-get nil "ORDERED"))
21806 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21807 "--"
21808 ["Set Priority" org-priority t]
21809 ["Priority Up" org-shiftup t]
21810 ["Priority Down" org-shiftdown t]
21811 "--"
21812 ["Get news from all feeds" org-feed-update-all t]
21813 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21814 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21815 ("TAGS and Properties"
21816 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21817 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21818 "--"
21819 ["Set property" org-set-property (not (org-before-first-heading-p))]
21820 ["Column view of properties" org-columns t]
21821 ["Insert Column View DBlock" org-insert-columns-dblock t])
21822 ("Dates and Scheduling"
21823 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21824 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21825 ("Change Date"
21826 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21827 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21828 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21829 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21830 ["Compute Time Range" org-evaluate-time-range t]
21831 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21832 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21833 "--"
21834 ["Custom time format" org-toggle-time-stamp-overlays
21835 :style radio :selected org-display-custom-times]
21836 "--"
21837 ["Goto Calendar" org-goto-calendar t]
21838 ["Date from Calendar" org-date-from-calendar t]
21839 "--"
21840 ["Start/Restart Timer" org-timer-start t]
21841 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21842 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21843 ["Insert Timer String" org-timer t]
21844 ["Insert Timer Item" org-timer-item t])
21845 ("Logging work"
21846 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21847 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21848 ["Clock out" org-clock-out t]
21849 ["Clock cancel" org-clock-cancel t]
21850 "--"
21851 ["Mark as default task" org-clock-mark-default-task t]
21852 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21853 ["Goto running clock" org-clock-goto t]
21854 "--"
21855 ["Display times" org-clock-display t]
21856 ["Create clock table" org-clock-report t]
21857 "--"
21858 ["Record DONE time"
21859 (progn (setq org-log-done (not org-log-done))
21860 (message "Switching to %s will %s record a timestamp"
21861 (car org-done-keywords)
21862 (if org-log-done "automatically" "not")))
21863 :style toggle :selected org-log-done])
21864 "--"
21865 ["Agenda Command..." org-agenda t]
21866 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21867 ("File List for Agenda")
21868 ("Special views current file"
21869 ["TODO Tree" org-show-todo-tree t]
21870 ["Check Deadlines" org-check-deadlines t]
21871 ["Timeline" org-timeline t]
21872 ["Tags/Property tree" org-match-sparse-tree t])
21873 "--"
21874 ["Export/Publish..." org-export-dispatch t]
21875 ("LaTeX"
21876 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21877 :selected org-cdlatex-mode]
21878 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21879 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21880 ["Modify math symbol" org-cdlatex-math-modify
21881 (org-inside-LaTeX-fragment-p)]
21882 ["Insert citation" org-reftex-citation t]
21883 "--"
21884 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21885 "--"
21886 ("MobileOrg"
21887 ["Push Files and Views" org-mobile-push t]
21888 ["Get Captured and Flagged" org-mobile-pull t]
21889 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21890 "--"
21891 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21892 "--"
21893 ("Documentation"
21894 ["Show Version" org-version t]
21895 ["Info Documentation" org-info t])
21896 ("Customize"
21897 ["Browse Org Group" org-customize t]
21898 "--"
21899 ["Expand This Menu" org-create-customize-menu
21900 (fboundp 'customize-menu-create)])
21901 ["Send bug report" org-submit-bug-report t]
21902 "--"
21903 ("Refresh/Reload"
21904 ["Refresh setup current buffer" org-mode-restart t]
21905 ["Reload Org (after update)" org-reload t]
21906 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21909 (defun org-info (&optional node)
21910 "Read documentation for Org-mode in the info system.
21911 With optional NODE, go directly to that node."
21912 (interactive)
21913 (info (format "(org)%s" (or node ""))))
21915 ;;;###autoload
21916 (defun org-submit-bug-report ()
21917 "Submit a bug report on Org-mode via mail.
21919 Don't hesitate to report any problems or inaccurate documentation.
21921 If you don't have setup sending mail from (X)Emacs, please copy the
21922 output buffer into your mail program, as it gives us important
21923 information about your Org-mode version and configuration."
21924 (interactive)
21925 (require 'reporter)
21926 (defvar reporter-prompt-for-summary-p)
21927 (org-load-modules-maybe)
21928 (org-require-autoloaded-modules)
21929 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21930 (reporter-submit-bug-report
21931 "emacs-orgmode@gnu.org"
21932 (org-version nil 'full)
21933 (let (list)
21934 (save-window-excursion
21935 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21936 (delete-other-windows)
21937 (erase-buffer)
21938 (insert "You are about to submit a bug report to the Org-mode mailing list.
21940 We would like to add your full Org-mode and Outline configuration to the
21941 bug report. This greatly simplifies the work of the maintainer and
21942 other experts on the mailing list.
21944 HOWEVER, some variables you have customized may contain private
21945 information. The names of customers, colleagues, or friends, might
21946 appear in the form of file names, tags, todo states, or search strings.
21947 If you answer yes to the prompt, you might want to check and remove
21948 such private information before sending the email.")
21949 (add-text-properties (point-min) (point-max) '(face org-warning))
21950 (when (yes-or-no-p "Include your Org-mode configuration ")
21951 (mapatoms
21952 (lambda (v)
21953 (and (boundp v)
21954 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21955 (or (and (symbol-value v)
21956 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21957 (and
21958 (get v 'custom-type) (get v 'standard-value)
21959 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21960 (push v list)))))
21961 (kill-buffer (get-buffer "*Warn about privacy*"))
21962 list))
21963 nil nil
21964 "Remember to cover the basics, that is, what you expected to happen and
21965 what in fact did happen. You don't know how to make a good report? See
21967 http://orgmode.org/manual/Feedback.html#Feedback
21969 Your bug report will be posted to the Org-mode mailing list.
21970 ------------------------------------------------------------------------")
21971 (save-excursion
21972 (when (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21973 (replace-match "\\1Bug: \\3 [\\2]")))))
21976 (defun org-install-agenda-files-menu ()
21977 (let ((bl (buffer-list)))
21978 (save-excursion
21979 (while bl
21980 (set-buffer (pop bl))
21981 (when (derived-mode-p 'org-mode) (setq bl nil)))
21982 (when (derived-mode-p 'org-mode)
21983 (easy-menu-change
21984 '("Org") "File List for Agenda"
21985 (append
21986 (list
21987 ["Edit File List" (org-edit-agenda-file-list) t]
21988 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21989 ["Remove Current File from List" org-remove-file t]
21990 ["Cycle through agenda files" org-cycle-agenda-files t]
21991 ["Occur in all agenda files" org-occur-in-agenda-files t]
21992 "--")
21993 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21995 ;;;; Documentation
21997 (defun org-require-autoloaded-modules ()
21998 (interactive)
21999 (mapc 'require
22000 '(org-agenda org-archive org-attach org-clock org-colview org-id
22001 org-table org-timer)))
22003 ;;;###autoload
22004 (defun org-reload (&optional uncompiled)
22005 "Reload all org lisp files.
22006 With prefix arg UNCOMPILED, load the uncompiled versions."
22007 (interactive "P")
22008 (require 'loadhist)
22009 (let* ((org-dir (org-find-library-dir "org"))
22010 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
22011 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
22012 (remove-re (mapconcat 'identity
22013 (mapcar (lambda (f) (concat "^" f "$"))
22014 (list (if (featurep 'xemacs)
22015 "org-colview"
22016 "org-colview-xemacs")
22017 "org" "org-loaddefs" "org-version"))
22018 "\\|"))
22019 (feats (delete-dups
22020 (mapcar 'file-name-sans-extension
22021 (mapcar 'file-name-nondirectory
22022 (delq nil
22023 (mapcar 'feature-file
22024 features))))))
22025 (lfeat (append
22026 (sort
22027 (setq feats
22028 (delq nil (mapcar
22029 (lambda (f)
22030 (if (and (string-match feature-re f)
22031 (not (string-match remove-re f)))
22032 f nil))
22033 feats)))
22034 'string-lessp)
22035 (list "org-version" "org")))
22036 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22037 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22038 load-uncore load-misses)
22039 (setq load-misses
22040 (delq 't
22041 (mapcar (lambda (f)
22042 (or (org-load-noerror-mustsuffix (concat org-dir f))
22043 (and (string= org-dir contrib-dir)
22044 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22045 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22046 (add-to-list 'load-uncore f 'append)
22049 lfeat)))
22050 (when load-uncore
22051 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22052 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22053 (if load-misses
22054 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22055 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22056 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22058 ;;;###autoload
22059 (defun org-customize ()
22060 "Call the customize function with org as argument."
22061 (interactive)
22062 (org-load-modules-maybe)
22063 (org-require-autoloaded-modules)
22064 (customize-browse 'org))
22066 (defun org-create-customize-menu ()
22067 "Create a full customization menu for Org-mode, insert it into the menu."
22068 (interactive)
22069 (org-load-modules-maybe)
22070 (org-require-autoloaded-modules)
22071 (if (fboundp 'customize-menu-create)
22072 (progn
22073 (easy-menu-change
22074 '("Org") "Customize"
22075 `(["Browse Org group" org-customize t]
22076 "--"
22077 ,(customize-menu-create 'org)
22078 ["Set" Custom-set t]
22079 ["Save" Custom-save t]
22080 ["Reset to Current" Custom-reset-current t]
22081 ["Reset to Saved" Custom-reset-saved t]
22082 ["Reset to Standard Settings" Custom-reset-standard t]))
22083 (message "\"Org\"-menu now contains full customization menu"))
22084 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22086 ;;;; Miscellaneous stuff
22088 ;;; Generally useful functions
22090 (defsubst org-get-at-eol (property n)
22091 "Get text property PROPERTY at the end of line less N characters."
22092 (get-text-property (- (point-at-eol) n) property))
22094 (defun org-find-text-property-in-string (prop s)
22095 "Return the first non-nil value of property PROP in string S."
22096 (or (get-text-property 0 prop s)
22097 (get-text-property (or (next-single-property-change 0 prop s) 0)
22098 prop s)))
22100 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22101 "Display the given MESSAGE as a warning."
22102 (if (fboundp 'display-warning)
22103 (display-warning 'org message
22104 (if (featurep 'xemacs) 'warning :warning))
22105 (let ((buf (get-buffer-create "*Org warnings*")))
22106 (with-current-buffer buf
22107 (goto-char (point-max))
22108 (insert "Warning (Org): " message)
22109 (unless (bolp)
22110 (newline)))
22111 (display-buffer buf)
22112 (sit-for 0))))
22114 (defun org-eval (form)
22115 "Eval FORM and return result."
22116 (condition-case error
22117 (eval form)
22118 (error (format "%%![Error: %s]" error))))
22120 (defun org-in-clocktable-p ()
22121 "Check if the cursor is in a clocktable."
22122 (let ((pos (point)) start)
22123 (save-excursion
22124 (end-of-line 1)
22125 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22126 (setq start (match-beginning 0))
22127 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22128 (>= (match-end 0) pos)
22129 start))))
22131 (defun org-in-verbatim-emphasis ()
22132 (save-match-data
22133 (and (org-in-regexp org-emph-re 2)
22134 (>= (point) (match-beginning 3))
22135 (<= (point) (match-end 4))
22136 (member (match-string 3) '("=" "~")))))
22138 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22139 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22140 (if (and marker (marker-buffer marker)
22141 (buffer-live-p (marker-buffer marker)))
22142 (progn
22143 (org-pop-to-buffer-same-window (marker-buffer marker))
22144 (when (or (> marker (point-max)) (< marker (point-min)))
22145 (widen))
22146 (goto-char marker)
22147 (org-show-context 'org-goto))
22148 (if bookmark
22149 (bookmark-jump bookmark)
22150 (error "Cannot find location"))))
22152 (defun org-quote-csv-field (s)
22153 "Quote field for inclusion in CSV material."
22154 (if (string-match "[\",]" s)
22155 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22158 (defun org-force-self-insert (N)
22159 "Needed to enforce self-insert under remapping."
22160 (interactive "p")
22161 (self-insert-command N))
22163 (defun org-string-width (s)
22164 "Compute width of string, ignoring invisible characters.
22165 This ignores character with invisibility property `org-link', and also
22166 characters with property `org-cwidth', because these will become invisible
22167 upon the next fontification round."
22168 (let (b l)
22169 (when (or (eq t buffer-invisibility-spec)
22170 (assq 'org-link buffer-invisibility-spec))
22171 (while (setq b (text-property-any 0 (length s)
22172 'invisible 'org-link s))
22173 (setq s (concat (substring s 0 b)
22174 (substring s (or (next-single-property-change
22175 b 'invisible s)
22176 (length s)))))))
22177 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22178 (setq s (concat (substring s 0 b)
22179 (substring s (or (next-single-property-change
22180 b 'org-cwidth s)
22181 (length s))))))
22182 (setq l (string-width s) b -1)
22183 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22184 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22187 (defun org-shorten-string (s maxlength)
22188 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22189 If the string is shorter or has length MAXLENGTH, just return the
22190 original string. If it is longer, the functions finds a space in the
22191 string, breaks this string off at that locations and adds three dots
22192 as ellipsis. Including the ellipsis, the string will not be longer
22193 than MAXLENGTH. If finding a good breaking point in the string does
22194 not work, the string is just chopped off in the middle of a word
22195 if necessary."
22196 (if (<= (length s) maxlength)
22198 (let* ((n (max (- maxlength 4) 1))
22199 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22200 (if (string-match re s)
22201 (concat (match-string 1 s) "...")
22202 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22204 (defun org-get-indentation (&optional line)
22205 "Get the indentation of the current line, interpreting tabs.
22206 When LINE is given, assume it represents a line and compute its indentation."
22207 (if line
22208 (when (string-match "^ *" (org-remove-tabs line))
22209 (match-end 0))
22210 (save-excursion
22211 (beginning-of-line 1)
22212 (skip-chars-forward " \t")
22213 (current-column))))
22215 (defun org-get-string-indentation (s)
22216 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22217 (let ((n -1) (i 0) (w tab-width) c)
22218 (catch 'exit
22219 (while (< (setq n (1+ n)) (length s))
22220 (setq c (aref s n))
22221 (cond ((= c ?\ ) (setq i (1+ i)))
22222 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22223 (t (throw 'exit t)))))
22226 (defun org-remove-tabs (s &optional width)
22227 "Replace tabulators in S with spaces.
22228 Assumes that s is a single line, starting in column 0."
22229 (setq width (or width tab-width))
22230 (while (string-match "\t" s)
22231 (setq s (replace-match
22232 (make-string
22233 (- (* width (/ (+ (match-beginning 0) width) width))
22234 (match-beginning 0)) ?\ )
22235 t t s)))
22238 (defun org-fix-indentation (line ind)
22239 "Fix indentation in LINE.
22240 IND is a cons cell with target and minimum indentation.
22241 If the current indentation in LINE is smaller than the minimum,
22242 leave it alone. If it is larger than ind, set it to the target."
22243 (let* ((l (org-remove-tabs line))
22244 (i (org-get-indentation l))
22245 (i1 (car ind)) (i2 (cdr ind)))
22246 (when (>= i i2) (setq l (substring line i2)))
22247 (if (> i1 0)
22248 (concat (make-string i1 ?\ ) l)
22249 l)))
22251 (defun org-remove-indentation (code &optional n)
22252 "Remove maximum common indentation in string CODE and return it.
22253 N may optionally be the number of columns to remove. Return CODE
22254 as-is if removal failed."
22255 (with-temp-buffer
22256 (insert code)
22257 (if (org-do-remove-indentation n) (buffer-string) code)))
22259 (defun org-do-remove-indentation (&optional n)
22260 "Remove the maximum common indentation from the buffer.
22261 When optional argument N is a positive integer, remove exactly
22262 that much characters from indentation, if possible. Return nil
22263 if it fails."
22264 (catch :exit
22265 (goto-char (point-min))
22266 ;; Find maximum common indentation, if not specified.
22267 (let ((n (or n
22268 (let ((min-ind (point-max)))
22269 (save-excursion
22270 (while (re-search-forward "^[ \t]*\\S-" nil t)
22271 (let ((ind (1- (current-column))))
22272 (if (zerop ind) (throw :exit nil)
22273 (setq min-ind (min min-ind ind))))))
22274 min-ind))))
22275 (if (zerop n) (throw :exit nil)
22276 ;; Remove exactly N indentation, but give up if not possible.
22277 (while (not (eobp))
22278 (let ((ind (progn (skip-chars-forward " \t") (current-column))))
22279 (cond ((eolp) (delete-region (line-beginning-position) (point)))
22280 ((< ind n) (throw :exit nil))
22281 (t (org-indent-line-to (- ind n))))
22282 (forward-line)))
22283 ;; Signal success.
22284 t))))
22286 (defun org-fill-template (template alist)
22287 "Find each %key of ALIST in TEMPLATE and replace it."
22288 (let ((case-fold-search nil))
22289 (dolist (entry (sort (copy-sequence alist)
22290 (lambda (a b) (< (length (car a)) (length (car b))))))
22291 (setq template
22292 (replace-regexp-in-string
22293 (concat "%" (regexp-quote (car entry)))
22294 (or (cdr entry) "") template t t)))
22295 template))
22297 (defun org-base-buffer (buffer)
22298 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22299 (if (not buffer)
22300 buffer
22301 (or (buffer-base-buffer buffer)
22302 buffer)))
22304 (defun org-wrap (string &optional width lines)
22305 "Wrap string to either a number of lines, or a width in characters.
22306 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22307 that costs. If there is a word longer than WIDTH, the text is actually
22308 wrapped to the length of that word.
22309 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22310 many lines, whatever width that takes.
22311 The return value is a list of lines, without newlines at the end."
22312 (let* ((words (org-split-string string "[ \t\n]+"))
22313 (maxword (apply 'max (mapcar 'org-string-width words)))
22314 w ll)
22315 (cond (width
22316 (org-do-wrap words (max maxword width)))
22317 (lines
22318 (setq w maxword)
22319 (setq ll (org-do-wrap words maxword))
22320 (if (<= (length ll) lines)
22322 (setq ll words)
22323 (while (> (length ll) lines)
22324 (setq w (1+ w))
22325 (setq ll (org-do-wrap words w)))
22326 ll))
22327 (t (error "Cannot wrap this")))))
22329 (defun org-do-wrap (words width)
22330 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22331 (let (lines line)
22332 (while words
22333 (setq line (pop words))
22334 (while (and words (< (+ (length line) (length (car words))) width))
22335 (setq line (concat line " " (pop words))))
22336 (setq lines (push line lines)))
22337 (nreverse lines)))
22339 (defun org-split-string (string &optional separators)
22340 "Splits STRING into substrings at SEPARATORS.
22341 SEPARATORS is a regular expression.
22342 No empty strings are returned if there are matches at the beginning
22343 and end of string."
22344 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22345 (let ((start 0) notfirst list)
22346 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22347 (if (and notfirst
22348 (= start (match-beginning 0))
22349 (< start (length string)))
22350 (1+ start) start))
22351 (< (match-beginning 0) (length string)))
22352 (setq notfirst t)
22353 (or (eq (match-beginning 0) 0)
22354 (and (eq (match-beginning 0) (match-end 0))
22355 (eq (match-beginning 0) start))
22356 (push (substring string start (match-beginning 0)) list))
22357 (setq start (match-end 0)))
22358 (or (eq start (length string))
22359 (push (substring string start) list))
22360 (nreverse list)))
22362 (defun org-quote-vert (s)
22363 "Replace \"|\" with \"\\vert\"."
22364 (while (string-match "|" s)
22365 (setq s (replace-match "\\vert" t t s)))
22368 (defun org-uuidgen-p (s)
22369 "Is S an ID created by UUIDGEN?"
22370 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22372 (defun org-in-src-block-p (&optional inside)
22373 "Whether point is in a code source block.
22374 When INSIDE is non-nil, don't consider we are within a src block
22375 when point is at #+BEGIN_SRC or #+END_SRC."
22376 (let ((case-fold-search t) ov)
22377 (or (and (eq (get-char-property (point) 'src-block) t))
22378 (and (not inside)
22379 (save-match-data
22380 (save-excursion
22381 (beginning-of-line)
22382 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22384 (defun org-context ()
22385 "Return a list of contexts of the current cursor position.
22386 If several contexts apply, all are returned.
22387 Each context entry is a list with a symbol naming the context, and
22388 two positions indicating start and end of the context. Possible
22389 contexts are:
22391 :headline anywhere in a headline
22392 :headline-stars on the leading stars in a headline
22393 :todo-keyword on a TODO keyword (including DONE) in a headline
22394 :tags on the TAGS in a headline
22395 :priority on the priority cookie in a headline
22396 :item on the first line of a plain list item
22397 :item-bullet on the bullet/number of a plain list item
22398 :checkbox on the checkbox in a plain list item
22399 :table in an org-mode table
22400 :table-special on a special filed in a table
22401 :table-table in a table.el table
22402 :clocktable in a clocktable
22403 :src-block in a source block
22404 :link on a hyperlink
22405 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22406 :target on a <<target>>
22407 :radio-target on a <<<radio-target>>>
22408 :latex-fragment on a LaTeX fragment
22409 :latex-preview on a LaTeX fragment with overlaid preview image
22411 This function expects the position to be visible because it uses font-lock
22412 faces as a help to recognize the following contexts: :table-special, :link,
22413 and :keyword."
22414 (let* ((f (get-text-property (point) 'face))
22415 (faces (if (listp f) f (list f)))
22416 (case-fold-search t)
22417 (p (point)) clist o)
22418 ;; First the large context
22419 (cond
22420 ((org-at-heading-p t)
22421 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22422 (when (progn
22423 (beginning-of-line 1)
22424 (looking-at org-todo-line-tags-regexp))
22425 (push (org-point-in-group p 1 :headline-stars) clist)
22426 (push (org-point-in-group p 2 :todo-keyword) clist)
22427 (push (org-point-in-group p 4 :tags) clist))
22428 (goto-char p)
22429 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22430 (when (looking-at "\\[#[A-Z0-9]\\]")
22431 (push (org-point-in-group p 0 :priority) clist)))
22433 ((org-at-item-p)
22434 (push (org-point-in-group p 2 :item-bullet) clist)
22435 (push (list :item (point-at-bol)
22436 (save-excursion (org-end-of-item) (point)))
22437 clist)
22438 (and (org-at-item-checkbox-p)
22439 (push (org-point-in-group p 0 :checkbox) clist)))
22441 ((org-at-table-p)
22442 (push (list :table (org-table-begin) (org-table-end)) clist)
22443 (when (memq 'org-formula faces)
22444 (push (list :table-special
22445 (previous-single-property-change p 'face)
22446 (next-single-property-change p 'face)) clist)))
22447 ((org-at-table-p 'any)
22448 (push (list :table-table) clist)))
22449 (goto-char p)
22451 (let ((case-fold-search t))
22452 ;; New the "medium" contexts: clocktables, source blocks
22453 (cond ((org-in-clocktable-p)
22454 (push (list :clocktable
22455 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22456 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22457 (match-beginning 1))
22458 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22459 (match-end 0))) clist))
22460 ((org-in-src-block-p)
22461 (push (list :src-block
22462 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22463 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22464 (match-beginning 1))
22465 (and (search-forward "#+END_SRC" nil t)
22466 (match-beginning 0))) clist))))
22467 (goto-char p)
22469 ;; Now the small context
22470 (cond
22471 ((org-at-timestamp-p)
22472 (push (org-point-in-group p 0 :timestamp) clist))
22473 ((memq 'org-link faces)
22474 (push (list :link
22475 (previous-single-property-change p 'face)
22476 (next-single-property-change p 'face)) clist))
22477 ((memq 'org-special-keyword faces)
22478 (push (list :keyword
22479 (previous-single-property-change p 'face)
22480 (next-single-property-change p 'face)) clist))
22481 ((org-at-target-p)
22482 (push (org-point-in-group p 0 :target) clist)
22483 (goto-char (1- (match-beginning 0)))
22484 (when (looking-at org-radio-target-regexp)
22485 (push (org-point-in-group p 0 :radio-target) clist))
22486 (goto-char p))
22487 ((setq o (car (delq nil
22488 (mapcar
22489 (lambda (x)
22490 (when (memq x org-latex-fragment-image-overlays) x))
22491 (overlays-at (point))))))
22492 (push (list :latex-fragment
22493 (overlay-start o) (overlay-end o)) clist)
22494 (push (list :latex-preview
22495 (overlay-start o) (overlay-end o)) clist))
22496 ((org-inside-LaTeX-fragment-p)
22497 ;; FIXME: positions wrong.
22498 (push (list :latex-fragment (point) (point)) clist)))
22500 (setq clist (nreverse (delq nil clist)))
22501 clist))
22503 (defun org-in-regexp (regexp &optional nlines visually)
22504 "Check if point is inside a match of REGEXP.
22506 Normally only the current line is checked, but you can include
22507 NLINES extra lines around point into the search. If VISUALLY is
22508 set, require that the cursor is not after the match but really
22509 on, so that the block visually is on the match.
22511 Return nil or a cons cell (BEG . END) where BEG and END are,
22512 respectively, the positions at the beginning and the end of the
22513 match."
22514 (catch :exit
22515 (let ((pos (point))
22516 (eol (line-end-position (if nlines (1+ nlines) 1))))
22517 (save-excursion
22518 (beginning-of-line (- 1 (or nlines 0)))
22519 (while (and (re-search-forward regexp eol t)
22520 (<= (match-beginning 0) pos))
22521 (let ((end (match-end 0)))
22522 (when (or (> end pos) (and (= end pos) (not visually)))
22523 (throw :exit (cons (match-beginning 0) (match-end 0))))))))))
22524 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22525 "Org mode 8.3")
22527 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22528 "Non-nil when point is between matches of START-RE and END-RE.
22530 Also return a non-nil value when point is on one of the matches.
22532 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22533 buffer positions. Default values are the positions of headlines
22534 surrounding the point.
22536 The functions returns a cons cell whose car (resp. cdr) is the
22537 position before START-RE (resp. after END-RE)."
22538 (save-match-data
22539 (let ((pos (point))
22540 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22541 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22542 beg end)
22543 (save-excursion
22544 ;; Point is on a block when on START-RE or if START-RE can be
22545 ;; found before it...
22546 (and (or (org-in-regexp start-re)
22547 (re-search-backward start-re limit-up t))
22548 (setq beg (match-beginning 0))
22549 ;; ... and END-RE after it...
22550 (goto-char (match-end 0))
22551 (re-search-forward end-re limit-down t)
22552 (> (setq end (match-end 0)) pos)
22553 ;; ... without another START-RE in-between.
22554 (goto-char (match-beginning 0))
22555 (not (re-search-backward start-re (1+ beg) t))
22556 ;; Return value.
22557 (cons beg end))))))
22559 (defun org-in-block-p (names)
22560 "Non-nil when point belongs to a block whose name belongs to NAMES.
22562 NAMES is a list of strings containing names of blocks.
22564 Return first block name matched, or nil. Beware that in case of
22565 nested blocks, the returned name may not belong to the closest
22566 block from point."
22567 (save-match-data
22568 (catch 'exit
22569 (let ((case-fold-search t)
22570 (lim-up (save-excursion (outline-previous-heading)))
22571 (lim-down (save-excursion (outline-next-heading))))
22572 (mapc (lambda (name)
22573 (let ((n (regexp-quote name)))
22574 (when (org-between-regexps-p
22575 (concat "^[ \t]*#\\+begin_" n)
22576 (concat "^[ \t]*#\\+end_" n)
22577 lim-up lim-down)
22578 (throw 'exit n))))
22579 names))
22580 nil)))
22582 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22583 "Call `multi-occur' with buffers for all agenda files."
22584 (interactive "sOrg-files matching: ")
22585 (let* ((files (org-agenda-files))
22586 (tnames (mapcar #'file-truename files))
22587 (extra org-agenda-text-search-extra-files))
22588 (when (eq (car extra) 'agenda-archives)
22589 (setq extra (cdr extra))
22590 (setq files (org-add-archive-files files)))
22591 (dolist (f extra)
22592 (unless (member (file-truename f) tnames)
22593 (unless (member f files) (setq files (append files (list f))))
22594 (setq tnames (append tnames (list (file-truename f))))))
22595 (multi-occur
22596 (mapcar (lambda (x)
22597 (with-current-buffer
22598 ;; FIXME: Why not just (find-file-noselect x)?
22599 ;; Is it to avoid the "revert buffer" prompt?
22600 (or (get-file-buffer x) (find-file-noselect x))
22601 (widen)
22602 (current-buffer)))
22603 files)
22604 regexp)))
22606 (if (boundp 'occur-mode-find-occurrence-hook)
22607 ;; Emacs 23
22608 (add-hook 'occur-mode-find-occurrence-hook
22609 (lambda ()
22610 (when (derived-mode-p 'org-mode)
22611 (org-reveal))))
22612 ;; Emacs 22
22613 (defadvice occur-mode-goto-occurrence
22614 (after org-occur-reveal activate)
22615 (and (derived-mode-p 'org-mode) (org-reveal)))
22616 (defadvice occur-mode-goto-occurrence-other-window
22617 (after org-occur-reveal activate)
22618 (and (derived-mode-p 'org-mode) (org-reveal)))
22619 (defadvice occur-mode-display-occurrence
22620 (after org-occur-reveal activate)
22621 (when (derived-mode-p 'org-mode)
22622 (let ((pos (occur-mode-find-occurrence)))
22623 (with-current-buffer (marker-buffer pos)
22624 (save-excursion
22625 (goto-char pos)
22626 (org-reveal)))))))
22628 (defun org-occur-link-in-agenda-files ()
22629 "Create a link and search for it in the agendas.
22630 The link is not stored in `org-stored-links', it is just created
22631 for the search purpose."
22632 (interactive)
22633 (let ((link (condition-case nil
22634 (org-store-link nil)
22635 (error "Unable to create a link to here"))))
22636 (org-occur-in-agenda-files (regexp-quote link))))
22638 (defun org-reverse-string (string)
22639 "Return the reverse of STRING."
22640 (apply 'string (reverse (string-to-list string))))
22642 ;; defsubst org-uniquify must be defined before first use
22644 (defun org-uniquify-alist (alist)
22645 "Merge elements of ALIST with the same key.
22647 For example, in this alist:
22649 \(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
22650 => \\='((a 1 3) (b 2))
22652 merge (a 1) and (a 3) into (a 1 3).
22654 The function returns the new ALIST."
22655 (let (rtn)
22656 (mapc
22657 (lambda (e)
22658 (let (n)
22659 (if (not (assoc (car e) rtn))
22660 (push e rtn)
22661 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22662 (setq rtn (assq-delete-all (car e) rtn))
22663 (push n rtn))))
22664 alist)
22665 rtn))
22667 (defun org-delete-all (elts list)
22668 "Remove all elements in ELTS from LIST."
22669 (while elts
22670 (setq list (delete (pop elts) list)))
22671 list)
22673 (defun org-back-over-empty-lines ()
22674 "Move backwards over whitespace, to the beginning of the first empty line.
22675 Returns the number of empty lines passed."
22676 (let ((pos (point)))
22677 (if (cdr (assoc 'heading org-blank-before-new-entry))
22678 (skip-chars-backward " \t\n\r")
22679 (unless (eobp)
22680 (forward-line -1)))
22681 (beginning-of-line 2)
22682 (goto-char (min (point) pos))
22683 (count-lines (point) pos)))
22685 (defun org-skip-whitespace ()
22686 (skip-chars-forward " \t\n\r"))
22688 (defun org-point-in-group (point group &optional context)
22689 "Check if POINT is in match-group GROUP.
22690 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22691 match. If the match group does not exist or point is not inside it,
22692 return nil."
22693 (and (match-beginning group)
22694 (>= point (match-beginning group))
22695 (<= point (match-end group))
22696 (if context
22697 (list context (match-beginning group) (match-end group))
22698 t)))
22700 (defun org-switch-to-buffer-other-window (&rest args)
22701 "Switch to buffer in a second window on the current frame.
22702 In particular, do not allow pop-up frames.
22703 Returns the newly created buffer."
22704 (org-no-popups
22705 (apply 'switch-to-buffer-other-window args)))
22707 (defun org-combine-plists (&rest plists)
22708 "Create a single property list from all plists in PLISTS.
22709 The process starts by copying the first list, and then setting properties
22710 from the other lists. Settings in the last list are the most significant
22711 ones and overrule settings in the other lists."
22712 (let ((rtn (copy-sequence (pop plists)))
22713 p v ls)
22714 (while plists
22715 (setq ls (pop plists))
22716 (while ls
22717 (setq p (pop ls) v (pop ls))
22718 (setq rtn (plist-put rtn p v))))
22719 rtn))
22721 (defun org-replace-escapes (string table)
22722 "Replace %-escapes in STRING with values in TABLE.
22723 TABLE is an association list with keys like \"%a\" and string values.
22724 The sequences in STRING may contain normal field width and padding information,
22725 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22726 so values can contain further %-escapes if they are define later in TABLE."
22727 (let ((tbl (copy-alist table))
22728 (case-fold-search nil)
22729 (pchg 0)
22730 e re rpl)
22731 (dolist (e tbl)
22732 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22733 (when (and (cdr e) (string-match re (cdr e)))
22734 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22735 (safe "SREF"))
22736 (add-text-properties 0 3 (list 'sref sref) safe)
22737 (setcdr e (replace-match safe t t (cdr e)))))
22738 (while (string-match re string)
22739 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22740 (cdr e)))
22741 (setq string (replace-match rpl t t string))))
22742 (while (setq pchg (next-property-change pchg string))
22743 (let ((sref (get-text-property pchg 'sref string)))
22744 (when (and sref (string-match "SREF" string pchg))
22745 (setq string (replace-match sref t t string)))))
22746 string))
22748 (defun org-sublist (list start end)
22749 "Return a section of LIST, from START to END.
22751 Counting starts at 1."
22752 (cl-subseq list (1- start) end))
22753 (make-obsolete 'org-sublist "cl-subseq (note the 0-based counting)." "Org 9.0")
22755 (defun org-find-base-buffer-visiting (file)
22756 "Like `find-buffer-visiting' but always return the base buffer and
22757 not an indirect buffer."
22758 (let ((buf (or (get-file-buffer file)
22759 (find-buffer-visiting file))))
22760 (if buf
22761 (or (buffer-base-buffer buf) buf)
22762 nil)))
22764 (defun org-image-file-name-regexp (&optional extensions)
22765 "Return regexp matching the file names of images.
22766 If EXTENSIONS is given, only match these."
22767 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22768 (image-file-name-regexp)
22769 (let ((image-file-name-extensions
22770 (or extensions
22771 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22772 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22773 (concat "\\."
22774 (regexp-opt (nconc (mapcar 'upcase
22775 image-file-name-extensions)
22776 image-file-name-extensions)
22778 "\\'"))))
22780 (defun org-file-image-p (file &optional extensions)
22781 "Return non-nil if FILE is an image."
22782 (save-match-data
22783 (string-match (org-image-file-name-regexp extensions) file)))
22785 (defun org-get-cursor-date (&optional with-time)
22786 "Return the date at cursor in as a time.
22787 This works in the calendar and in the agenda, anywhere else it just
22788 returns the current time.
22789 If WITH-TIME is non-nil, returns the time of the event at point (in
22790 the agenda) or the current time of the day."
22791 (let (date day defd tp hod mod)
22792 (when with-time
22793 (setq tp (get-text-property (point) 'time))
22794 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22795 (setq hod (string-to-number (match-string 1 tp))
22796 mod (string-to-number (match-string 2 tp))))
22797 (or tp (let ((now (decode-time)))
22798 (setq hod (nth 2 now)
22799 mod (nth 1 now)))))
22800 (cond
22801 ((eq major-mode 'calendar-mode)
22802 (setq date (calendar-cursor-to-date)
22803 defd (encode-time 0 (or mod 0) (or hod 0)
22804 (nth 1 date) (nth 0 date) (nth 2 date))))
22805 ((eq major-mode 'org-agenda-mode)
22806 (setq day (get-text-property (point) 'day))
22807 (when day
22808 (setq date (calendar-gregorian-from-absolute day)
22809 defd (encode-time 0 (or mod 0) (or hod 0)
22810 (nth 1 date) (nth 0 date) (nth 2 date))))))
22811 (or defd (current-time))))
22813 (defun org-mark-subtree (&optional up)
22814 "Mark the current subtree.
22815 This puts point at the start of the current subtree, and mark at
22816 the end. If a numeric prefix UP is given, move up into the
22817 hierarchy of headlines by UP levels before marking the subtree."
22818 (interactive "P")
22819 (org-with-limited-levels
22820 (cond ((org-at-heading-p) (beginning-of-line))
22821 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22822 (t (outline-previous-visible-heading 1))))
22823 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22824 (if (org-called-interactively-p 'any)
22825 (call-interactively 'org-mark-element)
22826 (org-mark-element)))
22829 ;;; Indentation
22831 (defun org--get-expected-indentation (element contentsp)
22832 "Expected indentation column for current line, according to ELEMENT.
22833 ELEMENT is an element containing point. CONTENTSP is non-nil
22834 when indentation is to be computed according to contents of
22835 ELEMENT."
22836 (let ((type (org-element-type element))
22837 (start (org-element-property :begin element))
22838 (post-affiliated (org-element-property :post-affiliated element)))
22839 (org-with-wide-buffer
22840 (cond
22841 (contentsp
22842 (case type
22843 ((diary-sexp footnote-definition) 0)
22844 ((headline inlinetask nil)
22845 (if (not org-adapt-indentation) 0
22846 (let ((level (org-current-level)))
22847 (if level (1+ level) 0))))
22848 ((item plain-list) (org-list-item-body-column post-affiliated))
22850 (goto-char start)
22851 (org-get-indentation))))
22852 ((memq type '(headline inlinetask nil))
22853 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22854 (org--get-expected-indentation element t)
22856 ((memq type '(diary-sexp footnote-definition)) 0)
22857 ;; First paragraph of a footnote definition or an item.
22858 ;; Indent like parent.
22859 ((< (line-beginning-position) start)
22860 (org--get-expected-indentation
22861 (org-element-property :parent element) t))
22862 ;; At first line: indent according to previous sibling, if any,
22863 ;; ignoring footnote definitions and inline tasks, or parent's
22864 ;; contents.
22865 ((= (line-beginning-position) start)
22866 (catch 'exit
22867 (while t
22868 (if (= (point-min) start) (throw 'exit 0)
22869 (goto-char (1- start))
22870 (let* ((previous (org-element-at-point))
22871 (parent previous))
22872 (while (and parent (<= (org-element-property :end parent) start))
22873 (setq previous parent
22874 parent (org-element-property :parent parent)))
22875 (cond
22876 ((not previous) (throw 'exit 0))
22877 ((> (org-element-property :end previous) start)
22878 (throw 'exit (org--get-expected-indentation previous t)))
22879 ((memq (org-element-type previous)
22880 '(footnote-definition inlinetask))
22881 (setq start (org-element-property :begin previous)))
22882 (t (goto-char (org-element-property :begin previous))
22883 (throw 'exit
22884 (if (bolp) (org-get-indentation)
22885 ;; At first paragraph in an item or
22886 ;; a footnote definition.
22887 (org--get-expected-indentation
22888 (org-element-property :parent previous) t))))))))))
22889 ;; Otherwise, move to the first non-blank line above.
22891 (beginning-of-line)
22892 (let ((pos (point)))
22893 (skip-chars-backward " \r\t\n")
22894 (cond
22895 ;; Two blank lines end a footnote definition or a plain
22896 ;; list. When we indent an empty line after them, the
22897 ;; containing list or footnote definition is over, so it
22898 ;; qualifies as a previous sibling. Therefore, we indent
22899 ;; like its first line.
22900 ((and (memq type '(footnote-definition plain-list))
22901 (> (count-lines (point) pos) 2))
22902 (goto-char start)
22903 (org-get-indentation))
22904 ;; Line above is the first one of a paragraph at the
22905 ;; beginning of an item or a footnote definition. Indent
22906 ;; like parent.
22907 ((< (line-beginning-position) start)
22908 (org--get-expected-indentation
22909 (org-element-property :parent element) t))
22910 ;; Line above is the beginning of an element, i.e., point
22911 ;; was originally on the blank lines between element's start
22912 ;; and contents.
22913 ((= (line-beginning-position) post-affiliated)
22914 (org--get-expected-indentation element t))
22915 ;; POS is after contents in a greater element. Indent like
22916 ;; the beginning of the element.
22918 ;; As a special case, if point is at the end of a footnote
22919 ;; definition or an item, indent like the very last element
22920 ;; within.
22921 ((and (not (eq type 'paragraph))
22922 (let ((cend (org-element-property :contents-end element)))
22923 (and cend (<= cend pos))))
22924 (if (memq type '(footnote-definition item plain-list))
22925 (let ((last (org-element-at-point)))
22926 (org--get-expected-indentation
22927 last
22928 (memq (org-element-type last)
22929 '(footnote-definition item plain-list))))
22930 (goto-char start)
22931 (org-get-indentation)))
22932 ;; In any other case, indent like the current line.
22933 (t (org-get-indentation)))))))))
22935 (defun org--align-node-property ()
22936 "Align node property at point.
22937 Alignment is done according to `org-property-format', which see."
22938 (when (save-excursion
22939 (beginning-of-line)
22940 (looking-at org-property-re))
22941 (replace-match
22942 (concat (match-string 4)
22943 (org-trim
22944 (format org-property-format (match-string 1) (match-string 3))))
22945 t t)))
22947 (defun org-indent-line ()
22948 "Indent line depending on context.
22950 Indentation is done according to the following rules:
22952 - Footnote definitions, diary sexps, headlines and inline tasks
22953 have to start at column 0.
22955 - On the very first line of an element, consider, in order, the
22956 next rules until one matches:
22958 1. If there's a sibling element before, ignoring footnote
22959 definitions and inline tasks, indent like its first line.
22961 2. If element has a parent, indent like its contents. More
22962 precisely, if parent is an item, indent after the
22963 description part, if any, or the bullet (see
22964 `org-list-description-max-indent'). Else, indent like
22965 parent's first line.
22967 3. Otherwise, indent relatively to current level, if
22968 `org-adapt-indentation' is non-nil, or to left margin.
22970 - On a blank line at the end of an element, indent according to
22971 the type of the element. More precisely
22973 1. If element is a plain list, an item, or a footnote
22974 definition, indent like the very last element within.
22976 2. If element is a paragraph, indent like its last non blank
22977 line.
22979 3. Otherwise, indent like its very first line.
22981 - In the code part of a source block, use language major mode
22982 to indent current line if `org-src-tab-acts-natively' is
22983 non-nil. If it is nil, do nothing.
22985 - Otherwise, indent like the first non-blank line above.
22987 The function doesn't indent an item as it could break the whole
22988 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22989 \\[org-shiftmetaright].
22991 Also align node properties according to `org-property-format'."
22992 (interactive)
22993 (cond
22994 (orgstruct-is-++
22995 (let ((indent-line-function
22996 (cadadr (assq 'indent-line-function org-fb-vars))))
22997 (indent-according-to-mode)))
22998 ((org-at-heading-p) 'noindent)
23000 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23001 (type (org-element-type element)))
23002 (cond ((and (memq type '(plain-list item))
23003 (= (line-beginning-position)
23004 (org-element-property :post-affiliated element)))
23005 'noindent)
23006 ((and (eq type 'src-block)
23007 org-src-tab-acts-natively
23008 (> (line-beginning-position)
23009 (org-element-property :post-affiliated element))
23010 (< (line-beginning-position)
23011 (org-with-wide-buffer
23012 (goto-char (org-element-property :end element))
23013 (skip-chars-backward " \r\t\n")
23014 (line-beginning-position))))
23015 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23017 (let ((column (org--get-expected-indentation element nil)))
23018 ;; Preserve current column.
23019 (if (<= (current-column) (current-indentation))
23020 (org-indent-line-to column)
23021 (save-excursion (org-indent-line-to column))))
23022 ;; Align node property. Also preserve current column.
23023 (when (eq type 'node-property)
23024 (let ((column (current-column)))
23025 (org--align-node-property)
23026 (org-move-to-column column)))))))))
23028 (defun org-indent-region (start end)
23029 "Indent each non-blank line in the region.
23030 Called from a program, START and END specify the region to
23031 indent. The function will not indent contents of example blocks,
23032 verse blocks and export blocks as leading white spaces are
23033 assumed to be significant there."
23034 (interactive "r")
23035 (save-excursion
23036 (goto-char start)
23037 (skip-chars-forward " \r\t\n")
23038 (unless (eobp) (beginning-of-line))
23039 (let ((indent-to
23040 (lambda (ind pos)
23041 ;; Set IND as indentation for all lines between point and
23042 ;; POS or END, whichever comes first. Blank lines are
23043 ;; ignored. Leave point after POS once done.
23044 (let ((limit (copy-marker (min end pos))))
23045 (while (< (point) limit)
23046 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23047 (forward-line))
23048 (set-marker limit nil))))
23049 (end (copy-marker end)))
23050 (while (< (point) end)
23051 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23052 (let* ((element (org-element-at-point))
23053 (type (org-element-type element))
23054 (element-end (copy-marker (org-element-property :end element)))
23055 (ind (org--get-expected-indentation element nil)))
23056 (cond
23057 ((or (memq type '(paragraph table table-row))
23058 (not (or (org-element-property :contents-begin element)
23059 (memq type
23060 '(example-block export-block src-block)))))
23061 ;; Elements here are indented as a single block. Also
23062 ;; align node properties.
23063 (when (eq type 'node-property)
23064 (org--align-node-property)
23065 (beginning-of-line))
23066 (funcall indent-to ind element-end))
23068 ;; Elements in this category consist of three parts:
23069 ;; before the contents, the contents, and after the
23070 ;; contents. The contents are treated specially,
23071 ;; according to the element type, or not indented at
23072 ;; all. Other parts are indented as a single block.
23073 (let* ((post (copy-marker
23074 (org-element-property :post-affiliated element)))
23075 (cbeg
23076 (copy-marker
23077 (cond
23078 ((not (org-element-property :contents-begin element))
23079 ;; Fake contents for source blocks.
23080 (org-with-wide-buffer
23081 (goto-char post)
23082 (forward-line)
23083 (point)))
23084 ((memq type '(footnote-definition item plain-list))
23085 ;; Contents in these elements could start on
23086 ;; the same line as the beginning of the
23087 ;; element. Make sure we start indenting
23088 ;; from the second line.
23089 (org-with-wide-buffer
23090 (goto-char post)
23091 (end-of-line)
23092 (skip-chars-forward " \r\t\n")
23093 (if (eobp) (point) (line-beginning-position))))
23094 (t (org-element-property :contents-begin element)))))
23095 (cend (copy-marker
23096 (or (org-element-property :contents-end element)
23097 ;; Fake contents for source blocks.
23098 (org-with-wide-buffer
23099 (goto-char element-end)
23100 (skip-chars-backward " \r\t\n")
23101 (line-beginning-position)))
23102 t)))
23103 ;; Do not change items indentation individually as it
23104 ;; might break the list as a whole. On the other
23105 ;; hand, when at a plain list, indent it as a whole.
23106 (cond ((eq type 'plain-list)
23107 (let ((offset (- ind (org-get-indentation))))
23108 (unless (zerop offset)
23109 (indent-rigidly (org-element-property :begin element)
23110 (org-element-property :end element)
23111 offset))
23112 (goto-char cbeg)))
23113 ((eq type 'item) (goto-char cbeg))
23114 (t (funcall indent-to ind cbeg)))
23115 (when (< (point) end)
23116 (case type
23117 ((example-block export-block verse-block))
23118 (src-block
23119 ;; In a source block, indent source code
23120 ;; according to language major mode, but only if
23121 ;; `org-src-tab-acts-natively' is non-nil.
23122 (when (and (< (point) end) org-src-tab-acts-natively)
23123 (ignore-errors
23124 (org-babel-do-in-edit-buffer
23125 (indent-region (point-min) (point-max))))))
23126 (t (org-indent-region (point) (min cend end))))
23127 (goto-char (min cend end))
23128 (when (< (point) end) (funcall indent-to ind element-end)))
23129 (set-marker post nil)
23130 (set-marker cbeg nil)
23131 (set-marker cend nil))))
23132 (set-marker element-end nil))))
23133 (set-marker end nil))))
23135 (defun org-indent-drawer ()
23136 "Indent the drawer at point."
23137 (interactive)
23138 (unless (save-excursion
23139 (beginning-of-line)
23140 (org-looking-at-p org-drawer-regexp))
23141 (user-error "Not at a drawer"))
23142 (let ((element (org-element-at-point)))
23143 (unless (memq (org-element-type element) '(drawer property-drawer))
23144 (user-error "Not at a drawer"))
23145 (org-with-wide-buffer
23146 (org-indent-region (org-element-property :begin element)
23147 (org-element-property :end element))))
23148 (message "Drawer at point indented"))
23150 (defun org-indent-block ()
23151 "Indent the block at point."
23152 (interactive)
23153 (unless (save-excursion
23154 (beginning-of-line)
23155 (let ((case-fold-search t))
23156 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23157 (user-error "Not at a block"))
23158 (let ((element (org-element-at-point)))
23159 (unless (memq (org-element-type element)
23160 '(comment-block center-block dynamic-block example-block
23161 export-block quote-block special-block
23162 src-block verse-block))
23163 (user-error "Not at a block"))
23164 (org-with-wide-buffer
23165 (org-indent-region (org-element-property :begin element)
23166 (org-element-property :end element))))
23167 (message "Block at point indented"))
23170 ;;; Filling
23172 ;; We use our own fill-paragraph and auto-fill functions.
23174 ;; `org-fill-paragraph' relies on adaptive filling and context
23175 ;; checking. Appropriate `fill-prefix' is computed with
23176 ;; `org-adaptive-fill-function'.
23178 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23179 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23180 ;; `org-adaptive-fill-function' value. Internally,
23181 ;; `org-comment-line-break-function' breaks the line.
23183 ;; `org-setup-filling' installs filling and auto-filling related
23184 ;; variables during `org-mode' initialization.
23186 (defvar org-element-paragraph-separate) ; org-element.el
23187 (defun org-setup-filling ()
23188 (require 'org-element)
23189 ;; Prevent auto-fill from inserting unwanted new items.
23190 (when (boundp 'fill-nobreak-predicate)
23191 (setq-local
23192 fill-nobreak-predicate
23193 (org-uniquify
23194 (append fill-nobreak-predicate
23195 '(org-fill-line-break-nobreak-p
23196 org-fill-paragraph-with-timestamp-nobreak-p)))))
23197 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23198 (setq-local paragraph-start paragraph-ending)
23199 (setq-local paragraph-separate paragraph-ending))
23200 (setq-local fill-paragraph-function 'org-fill-paragraph)
23201 (setq-local auto-fill-inhibit-regexp nil)
23202 (setq-local adaptive-fill-function 'org-adaptive-fill-function)
23203 (setq-local normal-auto-fill-function 'org-auto-fill-function)
23204 (setq-local comment-line-break-function 'org-comment-line-break-function))
23206 (defun org-fill-line-break-nobreak-p ()
23207 "Non-nil when a new line at point would create an Org line break."
23208 (save-excursion
23209 (skip-chars-backward "[ \t]")
23210 (skip-chars-backward "\\\\")
23211 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23213 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23214 "Non-nil when a new line at point would split a timestamp."
23215 (and (org-at-timestamp-p t)
23216 (not (looking-at org-ts-regexp-both))))
23218 (declare-function message-in-body-p "message" ())
23219 (defvar orgtbl-line-start-regexp) ; From org-table.el
23220 (defun org-adaptive-fill-function ()
23221 "Compute a fill prefix for the current line.
23222 Return fill prefix, as a string, or nil if current line isn't
23223 meant to be filled. For convenience, if `adaptive-fill-regexp'
23224 matches in paragraphs or comments, use it."
23225 (catch 'exit
23226 (when (derived-mode-p 'message-mode)
23227 (save-excursion
23228 (beginning-of-line)
23229 (cond ((not (message-in-body-p)) (throw 'exit nil))
23230 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23231 ((looking-at message-cite-prefix-regexp)
23232 (throw 'exit (match-string-no-properties 0)))
23233 ((looking-at org-outline-regexp)
23234 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23235 (org-with-wide-buffer
23236 (unless (org-at-heading-p)
23237 (let* ((p (line-beginning-position))
23238 (element (save-excursion
23239 (beginning-of-line)
23240 (org-element-at-point)))
23241 (type (org-element-type element))
23242 (post-affiliated (org-element-property :post-affiliated element)))
23243 (unless (< p post-affiliated)
23244 (case type
23245 (comment
23246 (save-excursion
23247 (beginning-of-line)
23248 (looking-at "[ \t]*")
23249 (concat (match-string 0) "# ")))
23250 (footnote-definition "")
23251 ((item plain-list)
23252 (make-string (org-list-item-body-column post-affiliated) ?\s))
23253 (paragraph
23254 ;; Fill prefix is usually the same as the current line,
23255 ;; unless the paragraph is at the beginning of an item.
23256 (let ((parent (org-element-property :parent element)))
23257 (save-excursion
23258 (beginning-of-line)
23259 (cond ((eq (org-element-type parent) 'item)
23260 (make-string (org-list-item-body-column
23261 (org-element-property :begin parent))
23262 ?\s))
23263 ((and adaptive-fill-regexp
23264 ;; Locally disable
23265 ;; `adaptive-fill-function' to let
23266 ;; `fill-context-prefix' handle
23267 ;; `adaptive-fill-regexp' variable.
23268 (let (adaptive-fill-function)
23269 (fill-context-prefix
23270 post-affiliated
23271 (org-element-property :end element)))))
23272 ((looking-at "[ \t]+") (match-string 0))
23273 (t "")))))
23274 (comment-block
23275 ;; Only fill contents if P is within block boundaries.
23276 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23277 (forward-line)
23278 (point)))
23279 (cend (save-excursion
23280 (goto-char (org-element-property :end element))
23281 (skip-chars-backward " \r\t\n")
23282 (line-beginning-position))))
23283 (when (and (>= p cbeg) (< p cend))
23284 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23285 (match-string 0)
23286 "")))))))))))
23288 (declare-function message-goto-body "message" ())
23289 (defvar message-cite-prefix-regexp) ; From message.el
23290 (defun org-fill-paragraph (&optional justify)
23291 "Fill element at point, when applicable.
23293 This function only applies to comment blocks, comments, example
23294 blocks and paragraphs. Also, as a special case, re-align table
23295 when point is at one.
23297 If JUSTIFY is non-nil (interactively, with prefix argument),
23298 justify as well. If `sentence-end-double-space' is non-nil, then
23299 period followed by one space does not end a sentence, so don't
23300 break a line there. The variable `fill-column' controls the
23301 width for filling.
23303 For convenience, when point is at a plain list, an item or
23304 a footnote definition, try to fill the first paragraph within."
23305 (interactive)
23306 (if (and (derived-mode-p 'message-mode)
23307 (or (not (message-in-body-p))
23308 (save-excursion (move-beginning-of-line 1)
23309 (looking-at message-cite-prefix-regexp))))
23310 ;; First ensure filling is correct in message-mode.
23311 (let ((fill-paragraph-function
23312 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23313 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23314 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23315 (paragraph-separate
23316 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23317 (fill-paragraph nil))
23318 (with-syntax-table org-mode-transpose-word-syntax-table
23319 ;; Move to end of line in order to get the first paragraph
23320 ;; within a plain list or a footnote definition.
23321 (let ((element (save-excursion
23322 (end-of-line)
23323 (or (ignore-errors (org-element-at-point))
23324 (user-error "An element cannot be parsed line %d"
23325 (line-number-at-pos (point)))))))
23326 ;; First check if point is in a blank line at the beginning of
23327 ;; the buffer. In that case, ignore filling.
23328 (case (org-element-type element)
23329 ;; Use major mode filling function is src blocks.
23330 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23331 ;; Align Org tables, leave table.el tables as-is.
23332 (table-row (org-table-align) t)
23333 (table
23334 (when (eq (org-element-property :type element) 'org)
23335 (save-excursion
23336 (goto-char (org-element-property :post-affiliated element))
23337 (org-table-align)))
23339 (paragraph
23340 ;; Paragraphs may contain `line-break' type objects.
23341 (let ((beg (max (point-min)
23342 (org-element-property :contents-begin element)))
23343 (end (min (point-max)
23344 (org-element-property :contents-end element))))
23345 ;; Do nothing if point is at an affiliated keyword.
23346 (if (< (line-end-position) beg) t
23347 (when (derived-mode-p 'message-mode)
23348 ;; In `message-mode', do not fill following citation
23349 ;; in current paragraph nor text before message body.
23350 (let ((body-start (save-excursion (message-goto-body))))
23351 (when body-start (setq beg (max body-start beg))))
23352 (when (save-excursion
23353 (re-search-forward
23354 (concat "^" message-cite-prefix-regexp) end t))
23355 (setq end (match-beginning 0))))
23356 ;; Fill paragraph, taking line breaks into account.
23357 (save-excursion
23358 (goto-char beg)
23359 (let ((cuts (list beg)))
23360 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23361 (when (eq 'line-break
23362 (org-element-type
23363 (save-excursion (backward-char)
23364 (org-element-context))))
23365 (push (point) cuts)))
23366 (dolist (c (delq end cuts))
23367 (fill-region-as-paragraph c end justify)
23368 (setq end c))))
23369 t)))
23370 ;; Contents of `comment-block' type elements should be
23371 ;; filled as plain text, but only if point is within block
23372 ;; markers.
23373 (comment-block
23374 (let* ((case-fold-search t)
23375 (beg (save-excursion
23376 (goto-char (org-element-property :begin element))
23377 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23378 (forward-line)
23379 (point)))
23380 (end (save-excursion
23381 (goto-char (org-element-property :end element))
23382 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23383 (line-beginning-position))))
23384 (if (or (< (point) beg) (> (point) end)) t
23385 (fill-region-as-paragraph
23386 (save-excursion (end-of-line)
23387 (re-search-backward "^[ \t]*$" beg 'move)
23388 (line-beginning-position))
23389 (save-excursion (beginning-of-line)
23390 (re-search-forward "^[ \t]*$" end 'move)
23391 (line-beginning-position))
23392 justify))))
23393 ;; Fill comments.
23394 (comment
23395 (let ((begin (org-element-property :post-affiliated element))
23396 (end (org-element-property :end element)))
23397 (when (and (>= (point) begin) (<= (point) end))
23398 (let ((begin (save-excursion
23399 (end-of-line)
23400 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23401 (progn (forward-line) (point))
23402 begin)))
23403 (end (save-excursion
23404 (end-of-line)
23405 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23406 (1- (line-beginning-position))
23407 (skip-chars-backward " \r\t\n")
23408 (line-end-position)))))
23409 ;; Do not fill comments when at a blank line.
23410 (when (> end begin)
23411 (let ((fill-prefix
23412 (save-excursion
23413 (beginning-of-line)
23414 (looking-at "[ \t]*#")
23415 (let ((comment-prefix (match-string 0)))
23416 (goto-char (match-end 0))
23417 (if (looking-at adaptive-fill-regexp)
23418 (concat comment-prefix (match-string 0))
23419 (concat comment-prefix " "))))))
23420 (save-excursion
23421 (fill-region-as-paragraph begin end justify))))))
23423 ;; Ignore every other element.
23424 (otherwise t))))))
23426 (defun org-auto-fill-function ()
23427 "Auto-fill function."
23428 ;; Check if auto-filling is meaningful.
23429 (let ((fc (current-fill-column)))
23430 (when (and fc (> (current-column) fc))
23431 (let* ((fill-prefix (org-adaptive-fill-function))
23432 ;; Enforce empty fill prefix, if required. Otherwise, it
23433 ;; will be computed again.
23434 (adaptive-fill-mode (not (equal fill-prefix ""))))
23435 (when fill-prefix (do-auto-fill))))))
23437 (defun org-comment-line-break-function (&optional soft)
23438 "Break line at point and indent, continuing comment if within one.
23439 The inserted newline is marked hard if variable
23440 `use-hard-newlines' is true, unless optional argument SOFT is
23441 non-nil."
23442 (if soft (insert-and-inherit ?\n) (newline 1))
23443 (save-excursion (forward-char -1) (delete-horizontal-space))
23444 (delete-horizontal-space)
23445 (indent-to-left-margin)
23446 (insert-before-markers-and-inherit fill-prefix))
23449 ;;; Fixed Width Areas
23451 (defun org-toggle-fixed-width ()
23452 "Toggle fixed-width markup.
23454 Add or remove fixed-width markup on current line, whenever it
23455 makes sense. Return an error otherwise.
23457 If a region is active and if it contains only fixed-width areas
23458 or blank lines, remove all fixed-width markup in it. If the
23459 region contains anything else, convert all non-fixed-width lines
23460 to fixed-width ones.
23462 Blank lines at the end of the region are ignored unless the
23463 region only contains such lines."
23464 (interactive)
23465 (if (not (org-region-active-p))
23466 ;; No region:
23468 ;; Remove fixed width marker only in a fixed-with element.
23470 ;; Add fixed width maker in paragraphs, in blank lines after
23471 ;; elements or at the beginning of a headline or an inlinetask,
23472 ;; and before any one-line elements (e.g., a clock).
23473 (progn
23474 (beginning-of-line)
23475 (let* ((element (org-element-at-point))
23476 (type (org-element-type element)))
23477 (cond
23478 ((and (eq type 'fixed-width)
23479 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23480 (replace-match
23481 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23482 ((and (memq type '(babel-call clock comment diary-sexp headline
23483 horizontal-rule keyword paragraph
23484 planning))
23485 (<= (org-element-property :post-affiliated element) (point)))
23486 (skip-chars-forward " \t")
23487 (insert ": "))
23488 ((and (org-looking-at-p "[ \t]*$")
23489 (or (eq type 'inlinetask)
23490 (save-excursion
23491 (skip-chars-forward " \r\t\n")
23492 (<= (org-element-property :end element) (point)))))
23493 (delete-region (point) (line-end-position))
23494 (org-indent-line)
23495 (insert ": "))
23496 (t (user-error "Cannot insert a fixed-width line here")))))
23497 ;; Region active.
23498 (let* ((begin (save-excursion
23499 (goto-char (region-beginning))
23500 (line-beginning-position)))
23501 (end (copy-marker
23502 (save-excursion
23503 (goto-char (region-end))
23504 (unless (eolp) (beginning-of-line))
23505 (if (save-excursion (re-search-backward "\\S-" begin t))
23506 (progn (skip-chars-backward " \r\t\n") (point))
23507 (point)))))
23508 (all-fixed-width-p
23509 (catch 'not-all-p
23510 (save-excursion
23511 (goto-char begin)
23512 (skip-chars-forward " \r\t\n")
23513 (when (eobp) (throw 'not-all-p nil))
23514 (while (< (point) end)
23515 (let ((element (org-element-at-point)))
23516 (if (eq (org-element-type element) 'fixed-width)
23517 (goto-char (org-element-property :end element))
23518 (throw 'not-all-p nil))))
23519 t))))
23520 (if all-fixed-width-p
23521 (save-excursion
23522 (goto-char begin)
23523 (while (< (point) end)
23524 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23525 (replace-match
23526 "" nil nil nil
23527 (if (= (line-end-position) (match-end 0)) 0 1)))
23528 (forward-line)))
23529 (let ((min-ind (point-max)))
23530 ;; Find minimum indentation across all lines.
23531 (save-excursion
23532 (goto-char begin)
23533 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23534 (setq min-ind 0)
23535 (catch 'zerop
23536 (while (< (point) end)
23537 (unless (org-looking-at-p "[ \t]*$")
23538 (let ((ind (org-get-indentation)))
23539 (setq min-ind (min min-ind ind))
23540 (when (zerop ind) (throw 'zerop t))))
23541 (forward-line)))))
23542 ;; Loop over all lines and add fixed-width markup everywhere
23543 ;; but in fixed-width lines.
23544 (save-excursion
23545 (goto-char begin)
23546 (while (< (point) end)
23547 (cond
23548 ((org-at-heading-p)
23549 (insert ": ")
23550 (forward-line)
23551 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23552 (insert ":")
23553 (forward-line)))
23554 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23555 (let* ((element (org-element-at-point))
23556 (element-end (org-element-property :end element)))
23557 (if (eq (org-element-type element) 'fixed-width)
23558 (progn (goto-char element-end)
23559 (skip-chars-backward " \r\t\n")
23560 (forward-line))
23561 (let ((limit (min end element-end)))
23562 (while (< (point) limit)
23563 (org-move-to-column min-ind t)
23564 (insert ": ")
23565 (forward-line))))))
23567 (org-move-to-column min-ind t)
23568 (insert ": ")
23569 (forward-line)))))))
23570 (set-marker end nil))))
23573 ;;; Comments
23575 ;; Org comments syntax is quite complex. It requires the entire line
23576 ;; to be just a comment. Also, even with the right syntax at the
23577 ;; beginning of line, some some elements (i.e. verse-block or
23578 ;; example-block) don't accept comments. Usual Emacs comment commands
23579 ;; cannot cope with those requirements. Therefore, Org replaces them.
23581 ;; Org still relies on `comment-dwim', but cannot trust
23582 ;; `comment-only-p'. So, `comment-region-function' and
23583 ;; `uncomment-region-function' both point
23584 ;; to`org-comment-or-uncomment-region'. Eventually,
23585 ;; `org-insert-comment' takes care of insertion of comments at the
23586 ;; beginning of line.
23588 ;; `org-setup-comments-handling' install comments related variables
23589 ;; during `org-mode' initialization.
23591 (defun org-setup-comments-handling ()
23592 (interactive)
23593 (setq-local comment-use-syntax nil)
23594 (setq-local comment-start "# ")
23595 (setq-local comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23596 (setq-local comment-insert-comment-function 'org-insert-comment)
23597 (setq-local comment-region-function 'org-comment-or-uncomment-region)
23598 (setq-local uncomment-region-function 'org-comment-or-uncomment-region))
23600 (defun org-insert-comment ()
23601 "Insert an empty comment above current line.
23602 If the line is empty, insert comment at its beginning. When
23603 point is within a source block, comment according to the related
23604 major mode."
23605 (if (let ((element (org-element-at-point)))
23606 (and (eq (org-element-type element) 'src-block)
23607 (< (save-excursion
23608 (goto-char (org-element-property :post-affiliated element))
23609 (line-end-position))
23610 (point))
23611 (> (save-excursion
23612 (goto-char (org-element-property :end element))
23613 (skip-chars-backward " \r\t\n")
23614 (line-beginning-position))
23615 (point))))
23616 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23617 (beginning-of-line)
23618 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23619 (open-line 1))
23620 (org-indent-line)
23621 (insert "# ")))
23623 (defvar comment-empty-lines) ; From newcomment.el.
23624 (defun org-comment-or-uncomment-region (beg end &rest _)
23625 "Comment or uncomment each non-blank line in the region.
23626 Uncomment each non-blank line between BEG and END if it only
23627 contains commented lines. Otherwise, comment them. If region is
23628 strictly within a source block, use appropriate comment syntax."
23629 (if (let ((element (org-element-at-point)))
23630 (and (eq (org-element-type element) 'src-block)
23631 (< (save-excursion
23632 (goto-char (org-element-property :post-affiliated element))
23633 (line-end-position))
23634 beg)
23635 (>= (save-excursion
23636 (goto-char (org-element-property :end element))
23637 (skip-chars-backward " \r\t\n")
23638 (line-beginning-position))
23639 end)))
23640 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23641 (save-restriction
23642 ;; Restrict region
23643 (narrow-to-region (save-excursion (goto-char beg)
23644 (skip-chars-forward " \r\t\n" end)
23645 (line-beginning-position))
23646 (save-excursion (goto-char end)
23647 (skip-chars-backward " \r\t\n" beg)
23648 (line-end-position)))
23649 (let ((uncommentp
23650 ;; UNCOMMENTP is non-nil when every non blank line between
23651 ;; BEG and END is a comment.
23652 (save-excursion
23653 (goto-char (point-min))
23654 (while (and (not (eobp))
23655 (let ((element (org-element-at-point)))
23656 (and (eq (org-element-type element) 'comment)
23657 (goto-char (min (point-max)
23658 (org-element-property
23659 :end element)))))))
23660 (eobp))))
23661 (if uncommentp
23662 ;; Only blank lines and comments in region: uncomment it.
23663 (save-excursion
23664 (goto-char (point-min))
23665 (while (not (eobp))
23666 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23667 (replace-match "" nil nil nil 1))
23668 (forward-line)))
23669 ;; Comment each line in region.
23670 (let ((min-indent (point-max)))
23671 ;; First find the minimum indentation across all lines.
23672 (save-excursion
23673 (goto-char (point-min))
23674 (while (and (not (eobp)) (not (zerop min-indent)))
23675 (unless (looking-at "[ \t]*$")
23676 (setq min-indent (min min-indent (current-indentation))))
23677 (forward-line)))
23678 ;; Then loop over all lines.
23679 (save-excursion
23680 (goto-char (point-min))
23681 (while (not (eobp))
23682 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23683 ;; Don't get fooled by invisible text (e.g. link path)
23684 ;; when moving to column MIN-INDENT.
23685 (let ((buffer-invisibility-spec nil))
23686 (org-move-to-column min-indent t))
23687 (insert comment-start))
23688 (forward-line)))))))))
23690 (defun org-comment-dwim (arg)
23691 "Call `comment-dwim' within a source edit buffer if needed."
23692 (interactive "*P")
23693 (if (org-in-src-block-p)
23694 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23695 (call-interactively 'comment-dwim)))
23698 ;;; Timestamps API
23700 ;; This section contains tools to operate on timestamp objects, as
23701 ;; returned by, e.g. `org-element-context'.
23703 (defun org-timestamp--to-internal-time (timestamp &optional end)
23704 "Encode TIMESTAMP object into Emacs internal time.
23705 Use end of date range or time range when END is non-nil."
23706 (apply #'encode-time
23707 (cons 0
23708 (mapcar
23709 (lambda (prop) (or (org-element-property prop timestamp) 0))
23710 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23711 '(:minute-start :hour-start :day-start :month-start
23712 :year-start))))))
23714 (defun org-timestamp-has-time-p (timestamp)
23715 "Non-nil when TIMESTAMP has a time specified."
23716 (org-element-property :hour-start timestamp))
23718 (defun org-timestamp-format (timestamp format &optional end utc)
23719 "Format a TIMESTAMP object into a string.
23721 FORMAT is a format specifier to be passed to
23722 `format-time-string'.
23724 When optional argument END is non-nil, use end of date-range or
23725 time-range, if possible.
23727 When optional argument UTC is non-nil, time will be expressed as
23728 Universal Time."
23729 (format-time-string
23730 format (org-timestamp--to-internal-time timestamp end) utc))
23732 (defun org-timestamp-split-range (timestamp &optional end)
23733 "Extract a TIMESTAMP object from a date or time range.
23735 END, when non-nil, means extract the end of the range.
23736 Otherwise, extract its start.
23738 Return a new timestamp object."
23739 (let ((type (org-element-property :type timestamp)))
23740 (if (memq type '(active inactive diary)) timestamp
23741 (let ((split-ts (org-element-copy timestamp)))
23742 ;; Set new type.
23743 (org-element-put-property
23744 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23745 ;; Copy start properties over end properties if END is
23746 ;; non-nil. Otherwise, copy end properties over `start' ones.
23747 (let ((p-alist '((:minute-start . :minute-end)
23748 (:hour-start . :hour-end)
23749 (:day-start . :day-end)
23750 (:month-start . :month-end)
23751 (:year-start . :year-end))))
23752 (dolist (p-cell p-alist)
23753 (org-element-put-property
23754 split-ts
23755 (funcall (if end #'car #'cdr) p-cell)
23756 (org-element-property
23757 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23758 ;; Eventually refresh `:raw-value'.
23759 (org-element-put-property split-ts :raw-value nil)
23760 (org-element-put-property
23761 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23763 (defun org-timestamp-translate (timestamp &optional boundary)
23764 "Translate TIMESTAMP object to custom format.
23766 Format string is defined in `org-time-stamp-custom-formats',
23767 which see.
23769 When optional argument BOUNDARY is non-nil, it is either the
23770 symbol `start' or `end'. In this case, only translate the
23771 starting or ending part of TIMESTAMP if it is a date or time
23772 range. Otherwise, translate both parts.
23774 Return timestamp as-is if `org-display-custom-times' is nil or if
23775 it has a `diary' type."
23776 (let ((type (org-element-property :type timestamp)))
23777 (if (or (not org-display-custom-times) (eq type 'diary))
23778 (org-element-interpret-data timestamp)
23779 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23780 org-time-stamp-custom-formats)))
23781 (if (and (not boundary) (memq type '(active-range inactive-range)))
23782 (concat (org-timestamp-format timestamp fmt)
23783 "--"
23784 (org-timestamp-format timestamp fmt t))
23785 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23789 ;;; Other stuff.
23791 (defvar reftex-docstruct-symbol)
23792 (defvar reftex-cite-format)
23793 (defvar org--rds)
23795 (defun org-reftex-citation ()
23796 "Use reftex-citation to insert a citation into the buffer.
23797 This looks for a line like
23799 #+BIBLIOGRAPHY: foo plain option:-d
23801 and derives from it that foo.bib is the bibliography file relevant
23802 for this document. It then installs the necessary environment for RefTeX
23803 to work in this buffer and calls `reftex-citation' to insert a citation
23804 into the buffer.
23806 Export of such citations to both LaTeX and HTML is handled by the contributed
23807 package ox-bibtex by Taru Karttunen."
23808 (interactive)
23809 (let ((reftex-docstruct-symbol 'org--rds)
23810 (reftex-cite-format "\\cite{%l}")
23811 org--rds bib)
23812 (save-excursion
23813 (save-restriction
23814 (widen)
23815 (let ((case-fold-search t)
23816 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23817 (if (not (save-excursion
23818 (or (re-search-forward re nil t)
23819 (re-search-backward re nil t))))
23820 (user-error "No bibliography defined in file")
23821 (setq bib (concat (match-string 1) ".bib")
23822 org--rds (list (list 'bib bib)))))))
23823 (call-interactively 'reftex-citation)))
23825 ;;;; Functions extending outline functionality
23827 (defun org-beginning-of-line (&optional arg)
23828 "Go to the beginning of the current line. If that is invisible, continue
23829 to a visible line beginning. This makes the function of C-a more intuitive.
23830 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23831 first attempt, and only move to after the tags when the cursor is already
23832 beyond the end of the headline."
23833 (interactive "P")
23834 (let ((pos (point))
23835 (special (if (consp org-special-ctrl-a/e)
23836 (car org-special-ctrl-a/e)
23837 org-special-ctrl-a/e))
23838 deactivate-mark refpos)
23839 (if (org-bound-and-true-p visual-line-mode)
23840 (beginning-of-visual-line 1)
23841 (beginning-of-line 1))
23842 (if (and arg (fboundp 'move-beginning-of-line))
23843 (call-interactively 'move-beginning-of-line)
23844 (unless (bobp)
23845 (backward-char 1)
23846 (if (org-truely-invisible-p)
23847 (while (and (not (bobp)) (org-truely-invisible-p))
23848 (backward-char 1)
23849 (beginning-of-line 1))
23850 (forward-char 1))))
23851 (when special
23852 (cond
23853 ((and (looking-at org-complex-heading-regexp)
23854 (eq (char-after (match-end 1)) ?\s))
23855 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23856 (point-at-eol)))
23857 (goto-char
23858 (if (eq special t)
23859 (cond ((> pos refpos) refpos)
23860 ((= pos (point)) refpos)
23861 (t (point)))
23862 (cond ((> pos (point)) (point))
23863 ((not (eq last-command this-command)) (point))
23864 (t refpos)))))
23865 ((org-at-item-p)
23866 ;; Being at an item and not looking at an the item means point
23867 ;; was previously moved to beginning of a visual line, which
23868 ;; doesn't contain the item. Therefore, do nothing special,
23869 ;; just stay here.
23870 (when (looking-at org-list-full-item-re)
23871 ;; Set special position at first white space character after
23872 ;; bullet, and check-box, if any.
23873 (let ((after-bullet
23874 (let ((box (match-end 3)))
23875 (if (not box) (match-end 1)
23876 (let ((after (char-after box)))
23877 (if (and after (= after ? )) (1+ box) box))))))
23878 ;; Special case: Move point to special position when
23879 ;; currently after it or at beginning of line.
23880 (if (eq special t)
23881 (when (or (> pos after-bullet) (= (point) pos))
23882 (goto-char after-bullet))
23883 ;; Reversed case: Move point to special position when
23884 ;; point was already at beginning of line and command is
23885 ;; repeated.
23886 (when (and (= (point) pos) (eq last-command this-command))
23887 (goto-char after-bullet))))))))
23888 (org-no-warnings
23889 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23890 (setq disable-point-adjustment
23891 (or (not (invisible-p (point)))
23892 (not (invisible-p (max (point-min) (1- (point))))))))
23894 (defun org-end-of-line (&optional arg)
23895 "Go to the end of the line.
23896 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23897 tags on the first attempt, and only move to after the tags when
23898 the cursor is already beyond the end of the headline."
23899 (interactive "P")
23900 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23901 org-special-ctrl-a/e))
23902 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23903 'end-of-visual-line)
23904 ((fboundp 'move-end-of-line) 'move-end-of-line)
23905 (t 'end-of-line)))
23906 deactivate-mark)
23907 (if (or (not special) arg) (call-interactively move-fun)
23908 (let* ((element (save-excursion (beginning-of-line)
23909 (org-element-at-point)))
23910 (type (org-element-type element)))
23911 (cond
23912 ((memq type '(headline inlinetask))
23913 (let ((pos (point)))
23914 (beginning-of-line 1)
23915 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23916 (if (eq special t)
23917 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23918 (goto-char (match-beginning 1))
23919 (goto-char (match-end 0)))
23920 (if (or (< pos (match-end 0))
23921 (not (eq this-command last-command)))
23922 (goto-char (match-end 0))
23923 (goto-char (match-beginning 1))))
23924 (call-interactively move-fun))))
23925 ((outline-invisible-p (line-end-position))
23926 ;; If element is hidden, `move-end-of-line' would put point
23927 ;; after it. Use `end-of-line' to stay on current line.
23928 (call-interactively 'end-of-line))
23929 (t (call-interactively move-fun)))))
23930 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23931 (setq disable-point-adjustment
23932 (or (not (invisible-p (point)))
23933 (not (invisible-p (max (point-min) (1- (point))))))))
23935 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23936 (define-key org-mode-map "\C-e" 'org-end-of-line)
23938 (defun org-backward-sentence (&optional _arg)
23939 "Go to beginning of sentence, or beginning of table field.
23940 This will call `backward-sentence' or `org-table-beginning-of-field',
23941 depending on context."
23942 (interactive)
23943 (let* ((element (org-element-at-point))
23944 (contents-begin (org-element-property :contents-begin element))
23945 (table (org-element-lineage element '(table) t)))
23946 (if (and table
23947 (> (point) contents-begin)
23948 (<= (point) (org-element-property :contents-end table)))
23949 (call-interactively #'org-table-beginning-of-field)
23950 (save-restriction
23951 (when (and contents-begin
23952 (< (point-min) contents-begin)
23953 (> (point) contents-begin))
23954 (narrow-to-region contents-begin
23955 (org-element-property :contents-end element)))
23956 (call-interactively #'backward-sentence)))))
23958 (defun org-forward-sentence (&optional _arg)
23959 "Go to end of sentence, or end of table field.
23960 This will call `forward-sentence' or `org-table-end-of-field',
23961 depending on context."
23962 (interactive)
23963 (let* ((element (org-element-at-point))
23964 (contents-end (org-element-property :contents-end element))
23965 (table (org-element-lineage element '(table) t)))
23966 (if (and table
23967 (>= (point) (org-element-property :contents-begin table))
23968 (< (point) contents-end))
23969 (call-interactively #'org-table-end-of-field)
23970 (save-restriction
23971 (when (and contents-end
23972 (> (point-max) contents-end)
23973 ;; Skip blank lines between elements.
23974 (< (org-element-property :end element)
23975 (save-excursion (goto-char contents-end)
23976 (skip-chars-forward " \r\t\n"))))
23977 (narrow-to-region (org-element-property :contents-begin element)
23978 contents-end))
23979 (call-interactively #'forward-sentence)))))
23981 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23982 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23984 (defun org-kill-line (&optional _arg)
23985 "Kill line, to tags or end of line."
23986 (interactive)
23987 (cond
23988 ((or (not org-special-ctrl-k)
23989 (bolp)
23990 (not (org-at-heading-p)))
23991 (when (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23992 org-ctrl-k-protect-subtree
23993 (or (eq org-ctrl-k-protect-subtree 'error)
23994 (not (y-or-n-p "Kill hidden subtree along with headline? "))))
23995 (user-error "C-k aborted as it would kill a hidden subtree"))
23996 (call-interactively
23997 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23998 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23999 (kill-region (point) (match-beginning 1))
24000 (org-set-tags nil t))
24001 (t (kill-region (point) (point-at-eol)))))
24003 (define-key org-mode-map "\C-k" 'org-kill-line)
24005 (defun org-yank (&optional arg)
24006 "Yank. If the kill is a subtree, treat it specially.
24007 This command will look at the current kill and check if is a single
24008 subtree, or a series of subtrees[1]. If it passes the test, and if the
24009 cursor is at the beginning of a line or after the stars of a currently
24010 empty headline, then the yank is handled specially. How exactly depends
24011 on the value of the following variables, both set by default.
24013 `org-yank-folded-subtrees'
24014 When set, the subtree(s) will be folded after insertion, but only
24015 if doing so would now swallow text after the yanked text.
24017 `org-yank-adjusted-subtrees'
24018 When set, the subtree will be promoted or demoted in order to
24019 fit into the local outline tree structure, which means that the
24020 level will be adjusted so that it becomes the smaller one of the
24021 two *visible* surrounding headings.
24023 Any prefix to this command will cause `yank' to be called directly with
24024 no special treatment. In particular, a simple \\[universal-argument] prefix \
24025 will just
24026 plainly yank the text as it is.
24028 \[1] The test checks if the first non-white line is a heading
24029 and if there are no other headings with fewer stars."
24030 (interactive "P")
24031 (org-yank-generic 'yank arg))
24033 (defun org-yank-generic (command arg)
24034 "Perform some yank-like command.
24036 This function implements the behavior described in the `org-yank'
24037 documentation. However, it has been generalized to work for any
24038 interactive command with similar behavior."
24040 ;; pretend to be command COMMAND
24041 (setq this-command command)
24043 (if arg
24044 (call-interactively command)
24046 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24047 (and (org-kill-is-subtree-p)
24048 (or (bolp)
24049 (and (looking-at "[ \t]*$")
24050 (string-match
24051 "\\`\\*+\\'"
24052 (buffer-substring (point-at-bol) (point)))))))
24053 swallowp)
24054 (cond
24055 ((and subtreep org-yank-folded-subtrees)
24056 (let ((beg (point))
24057 end)
24058 (if (and subtreep org-yank-adjusted-subtrees)
24059 (org-paste-subtree nil nil 'for-yank)
24060 (call-interactively command))
24062 (setq end (point))
24063 (goto-char beg)
24064 (when (and (bolp) subtreep
24065 (not (setq swallowp
24066 (org-yank-folding-would-swallow-text beg end))))
24067 (org-with-limited-levels
24068 (or (looking-at org-outline-regexp)
24069 (re-search-forward org-outline-regexp-bol end t))
24070 (while (and (< (point) end) (looking-at org-outline-regexp))
24071 (outline-hide-subtree)
24072 (org-cycle-show-empty-lines 'folded)
24073 (condition-case nil
24074 (outline-forward-same-level 1)
24075 (error (goto-char end))))))
24076 (when swallowp
24077 (message
24078 "Inserted text not folded because that would swallow text"))
24080 (goto-char end)
24081 (skip-chars-forward " \t\n\r")
24082 (beginning-of-line 1)
24083 (push-mark beg 'nomsg)))
24084 ((and subtreep org-yank-adjusted-subtrees)
24085 (let ((beg (point-at-bol)))
24086 (org-paste-subtree nil nil 'for-yank)
24087 (push-mark beg 'nomsg)))
24089 (call-interactively command))))))
24091 (defun org-yank-folding-would-swallow-text (beg end)
24092 "Would hide-subtree at BEG swallow any text after END?"
24093 (let (level)
24094 (org-with-limited-levels
24095 (save-excursion
24096 (goto-char beg)
24097 (when (or (looking-at org-outline-regexp)
24098 (re-search-forward org-outline-regexp-bol end t))
24099 (setq level (org-outline-level)))
24100 (goto-char end)
24101 (skip-chars-forward " \t\r\n\v\f")
24102 (not (or (eobp)
24103 (and (bolp) (looking-at-p org-outline-regexp)
24104 (<= (org-outline-level) level))))))))
24106 (define-key org-mode-map "\C-y" 'org-yank)
24108 (defun org-truely-invisible-p ()
24109 "Check if point is at a character currently not visible.
24110 This version does not only check the character property, but also
24111 `visible-mode'."
24112 ;; Early versions of noutline don't have `outline-invisible-p'.
24113 (unless (org-bound-and-true-p visible-mode)
24114 (outline-invisible-p)))
24116 (defun org-invisible-p2 ()
24117 "Check if point is at a character currently not visible."
24118 (save-excursion
24119 (when (and (eolp) (not (bobp))) (backward-char 1))
24120 ;; Early versions of noutline don't have `outline-invisible-p'.
24121 (outline-invisible-p)))
24123 (defun org-back-to-heading (&optional invisible-ok)
24124 "Call `outline-back-to-heading', but provide a better error message."
24125 (condition-case nil
24126 (outline-back-to-heading invisible-ok)
24127 (error (error "Before first headline at position %d in buffer %s"
24128 (point) (current-buffer)))))
24130 (defun org-before-first-heading-p ()
24131 "Before first heading?"
24132 (save-excursion
24133 (end-of-line)
24134 (null (re-search-backward org-outline-regexp-bol nil t))))
24136 (defun org-at-heading-p (&optional ignored)
24137 (outline-on-heading-p t))
24138 ;;; Though the function was obsoleted in 7.8.03, the byte-compiler
24139 ;;; warning was only added in Org 9.0, which should be taken into
24140 ;;; account when deciding when to remove the alias.
24141 (define-obsolete-function-alias 'org-on-heading-p 'org-at-heading-p "Org 7.8.03")
24143 (defun org-in-commented-heading-p (&optional no-inheritance)
24144 "Non-nil if point is under a commented heading.
24145 This function also checks ancestors of the current headline,
24146 unless optional argument NO-INHERITANCE is non-nil."
24147 (cond
24148 ((org-before-first-heading-p) nil)
24149 ((let ((headline (nth 4 (org-heading-components))))
24150 (and headline
24151 (let ((case-fold-search nil))
24152 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24153 headline)))))
24154 (no-inheritance nil)
24156 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24158 (defun org-at-comment-p nil
24159 "Is cursor in a commented line?"
24160 (save-excursion
24161 (save-match-data
24162 (beginning-of-line)
24163 (looking-at "^[ \t]*# "))))
24165 (defun org-at-drawer-p nil
24166 "Is cursor at a drawer keyword?"
24167 (save-excursion
24168 (move-beginning-of-line 1)
24169 (looking-at org-drawer-regexp)))
24171 (defun org-at-block-p nil
24172 "Is cursor at a block keyword?"
24173 (save-excursion
24174 (move-beginning-of-line 1)
24175 (looking-at org-block-regexp)))
24177 (defun org-point-at-end-of-empty-headline ()
24178 "If point is at the end of an empty headline, return t, else nil.
24179 If the heading only contains a TODO keyword, it is still still considered
24180 empty."
24181 (and (looking-at "[ \t]*$")
24182 (when org-todo-line-regexp
24183 (save-excursion
24184 (beginning-of-line 1)
24185 (let ((case-fold-search nil))
24186 (looking-at org-todo-line-regexp)
24187 (string= (match-string 3) ""))))))
24189 (defun org-at-heading-or-item-p ()
24190 (or (org-at-heading-p) (org-at-item-p)))
24192 (defun org-at-target-p ()
24193 (or (org-in-regexp org-radio-target-regexp)
24194 (org-in-regexp org-target-regexp)))
24195 ;; Compatibility alias with Org versions < 7.8.03
24196 (defalias 'org-on-target-p 'org-at-target-p)
24198 (defun org-up-heading-all (arg)
24199 "Move to the heading line of which the present line is a subheading.
24200 This function considers both visible and invisible heading lines.
24201 With argument, move up ARG levels."
24202 (if (fboundp 'outline-up-heading-all)
24203 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24204 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24206 (defun org-up-heading-safe ()
24207 "Move to the heading line of which the present line is a subheading.
24208 This version will not throw an error. It will return the level of the
24209 headline found, or nil if no higher level is found.
24211 Also, this function will be a lot faster than `outline-up-heading',
24212 because it relies on stars being the outline starters. This can really
24213 make a significant difference in outlines with very many siblings."
24214 (when (ignore-errors (org-back-to-heading t))
24215 (let ((level-up (1- (funcall outline-level))))
24216 (and (> level-up 0)
24217 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24218 (funcall outline-level)))))
24220 (defun org-first-sibling-p ()
24221 "Is this heading the first child of its parents?"
24222 (interactive)
24223 (let ((re org-outline-regexp-bol)
24224 level l)
24225 (unless (org-at-heading-p t)
24226 (user-error "Not at a heading"))
24227 (setq level (funcall outline-level))
24228 (save-excursion
24229 (if (not (re-search-backward re nil t))
24231 (setq l (funcall outline-level))
24232 (< l level)))))
24234 (defun org-goto-sibling (&optional previous)
24235 "Goto the next sibling, even if it is invisible.
24236 When PREVIOUS is set, go to the previous sibling instead. Returns t
24237 when a sibling was found. When none is found, return nil and don't
24238 move point."
24239 (let ((fun (if previous 're-search-backward 're-search-forward))
24240 (pos (point))
24241 (re org-outline-regexp-bol)
24242 level l)
24243 (when (ignore-errors (org-back-to-heading t))
24244 (setq level (funcall outline-level))
24245 (catch 'exit
24246 (or previous (forward-char 1))
24247 (while (funcall fun re nil t)
24248 (setq l (funcall outline-level))
24249 (when (< l level) (goto-char pos) (throw 'exit nil))
24250 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24251 (goto-char pos)
24252 nil))))
24254 (defun org-show-siblings ()
24255 "Show all siblings of the current headline."
24256 (save-excursion
24257 (while (org-goto-sibling) (org-flag-heading nil)))
24258 (save-excursion
24259 (while (org-goto-sibling 'previous)
24260 (org-flag-heading nil))))
24262 (defun org-goto-first-child ()
24263 "Goto the first child, even if it is invisible.
24264 Return t when a child was found. Otherwise don't move point and
24265 return nil."
24266 (let (level (pos (point)) (re org-outline-regexp-bol))
24267 (when (ignore-errors (org-back-to-heading t))
24268 (setq level (outline-level))
24269 (forward-char 1)
24270 (if (and (re-search-forward re nil t) (> (outline-level) level))
24271 (progn (goto-char (match-beginning 0)) t)
24272 (goto-char pos) nil))))
24274 (defun org-show-hidden-entry ()
24275 "Show an entry where even the heading is hidden."
24276 (save-excursion
24277 (org-show-entry)))
24279 (defun org-flag-heading (flag &optional entry)
24280 "Flag the current heading. FLAG non-nil means make invisible.
24281 When ENTRY is non-nil, show the entire entry."
24282 (save-excursion
24283 (org-back-to-heading t)
24284 ;; Check if we should show the entire entry
24285 (if entry
24286 (progn
24287 (org-show-entry)
24288 (save-excursion
24289 (and (outline-next-heading)
24290 (org-flag-heading nil))))
24291 (outline-flag-region (max (point-min) (1- (point)))
24292 (save-excursion (outline-end-of-heading) (point))
24293 flag))))
24295 (defun org-get-next-sibling ()
24296 "Move to next heading of the same level, and return point.
24297 If there is no such heading, return nil.
24298 This is like outline-next-sibling, but invisible headings are ok."
24299 (let ((level (funcall outline-level)))
24300 (outline-next-heading)
24301 (while (and (not (eobp)) (> (funcall outline-level) level))
24302 (outline-next-heading))
24303 (unless (or (eobp) (< (funcall outline-level) level))
24304 (point))))
24306 (defun org-get-last-sibling ()
24307 "Move to previous heading of the same level, and return point.
24308 If there is no such heading, return nil."
24309 (let ((opoint (point))
24310 (level (funcall outline-level)))
24311 (outline-previous-heading)
24312 (when (and (/= (point) opoint) (outline-on-heading-p t))
24313 (while (and (> (funcall outline-level) level)
24314 (not (bobp)))
24315 (outline-previous-heading))
24316 (unless (< (funcall outline-level) level)
24317 (point)))))
24319 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24320 "Goto to the end of a subtree."
24321 ;; This contains an exact copy of the original function, but it uses
24322 ;; `org-back-to-heading', to make it work also in invisible
24323 ;; trees. And is uses an invisible-ok argument.
24324 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24325 ;; Furthermore, when used inside Org, finding the end of a large subtree
24326 ;; with many children and grandchildren etc, this can be much faster
24327 ;; than the outline version.
24328 (org-back-to-heading invisible-ok)
24329 (let ((first t)
24330 (level (funcall outline-level)))
24331 (if (and (derived-mode-p 'org-mode) (< level 1000))
24332 ;; A true heading (not a plain list item), in Org-mode
24333 ;; This means we can easily find the end by looking
24334 ;; only for the right number of stars. Using a regexp to do
24335 ;; this is so much faster than using a Lisp loop.
24336 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24337 (forward-char 1)
24338 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24339 ;; something else, do it the slow way
24340 (while (and (not (eobp))
24341 (or first (> (funcall outline-level) level)))
24342 (setq first nil)
24343 (outline-next-heading)))
24344 (unless to-heading
24345 (when (memq (preceding-char) '(?\n ?\^M))
24346 ;; Go to end of line before heading
24347 (forward-char -1)
24348 (when (memq (preceding-char) '(?\n ?\^M))
24349 ;; leave blank line before heading
24350 (forward-char -1)))))
24351 (point))
24353 (defun org-end-of-meta-data (&optional full)
24354 "Skip planning line and properties drawer in current entry.
24355 When optional argument FULL is non-nil, also skip empty lines,
24356 clocking lines and regular drawers at the beginning of the
24357 entry."
24358 (org-back-to-heading t)
24359 (forward-line)
24360 (when (org-looking-at-p org-planning-line-re) (forward-line))
24361 (when (looking-at org-property-drawer-re)
24362 (goto-char (match-end 0))
24363 (forward-line))
24364 (when (and full (not (org-at-heading-p)))
24365 (catch 'exit
24366 (let ((end (save-excursion (outline-next-heading) (point)))
24367 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24368 (while (not (eobp))
24369 (cond ((org-looking-at-p org-drawer-regexp)
24370 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24371 (forward-line)
24372 (throw 'exit t)))
24373 ((org-looking-at-p re) (forward-line))
24374 (t (throw 'exit t))))))))
24376 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24377 "Move forward to the ARG'th subheading at same level as this one.
24378 Stop at the first and last subheadings of a superior heading.
24379 Normally this only looks at visible headings, but when INVISIBLE-OK is
24380 non-nil it will also look at invisible ones."
24381 (interactive "p")
24382 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24383 (if (and arg (< arg 0))
24384 (goto-char (point-min))
24385 (outline-next-heading))
24386 (org-at-heading-p)
24387 (let ((level (- (match-end 0) (match-beginning 0) 1))
24388 (f (if (and arg (< arg 0))
24389 're-search-backward
24390 're-search-forward))
24391 (count (if arg (abs arg) 1))
24392 (result (point)))
24393 (while (and (prog1 (> count 0)
24394 (forward-char (if (and arg (< arg 0)) -1 1)))
24395 (funcall f org-outline-regexp-bol nil 'move))
24396 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24397 (cond ((< l level) (setq count 0))
24398 ((and (= l level)
24399 (or invisible-ok
24400 (progn
24401 (goto-char (line-beginning-position))
24402 (not (outline-invisible-p)))))
24403 (setq count (1- count))
24404 (when (eq l level)
24405 (setq result (point)))))))
24406 (goto-char result))
24407 (beginning-of-line 1)))
24409 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24410 "Move backward to the ARG'th subheading at same level as this one.
24411 Stop at the first and last subheadings of a superior heading."
24412 (interactive "p")
24413 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24415 (defun org-next-visible-heading (arg)
24416 "Move to the next visible heading.
24418 This function wraps `outline-next-visible-heading' with
24419 `org-with-limited-levels' in order to skip over inline tasks and
24420 respect customization of `org-odd-levels-only'."
24421 (interactive "p")
24422 (org-with-limited-levels
24423 (outline-next-visible-heading arg)))
24425 (defun org-previous-visible-heading (arg)
24426 "Move to the next visible heading.
24428 This function wraps `outline-previous-visible-heading' with
24429 `org-with-limited-levels' in order to skip over inline tasks and
24430 respect customization of `org-odd-levels-only'."
24431 (interactive "p")
24432 (org-with-limited-levels
24433 (outline-previous-visible-heading arg)))
24435 (defun org-next-block (arg &optional backward block-regexp)
24436 "Jump to the next block.
24438 With a prefix argument ARG, jump forward ARG many blocks.
24440 When BACKWARD is non-nil, jump to the previous block.
24442 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24443 Match data is set according to this regexp when the function
24444 returns.
24446 Return point at beginning of the opening line of found block.
24447 Throw an error if no block is found."
24448 (interactive "p")
24449 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24450 (case-fold-search t)
24451 (search-fn (if backward #'re-search-backward #'re-search-forward))
24452 (count (or arg 1))
24453 (origin (point))
24454 last-element)
24455 (if backward (beginning-of-line) (end-of-line))
24456 (while (and (> count 0) (funcall search-fn re nil t))
24457 (let ((element (save-excursion
24458 (goto-char (match-beginning 0))
24459 (save-match-data (org-element-at-point)))))
24460 (when (and (memq (org-element-type element)
24461 '(center-block comment-block dynamic-block
24462 example-block export-block quote-block
24463 special-block src-block verse-block))
24464 (<= (match-beginning 0)
24465 (org-element-property :post-affiliated element)))
24466 (setq last-element element)
24467 (decf count))))
24468 (if (= count 0)
24469 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24470 (save-match-data (org-show-context)))
24471 (goto-char origin)
24472 (user-error "No %s code blocks" (if backward "previous" "further")))))
24474 (defun org-previous-block (arg &optional block-regexp)
24475 "Jump to the previous block.
24476 With a prefix argument ARG, jump backward ARG many source blocks.
24477 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24478 (interactive "p")
24479 (org-next-block arg t block-regexp))
24481 (defun org-forward-paragraph ()
24482 "Move forward to beginning of next paragraph or equivalent.
24484 The function moves point to the beginning of the next visible
24485 structural element, which can be a paragraph, a table, a list
24486 item, etc. It also provides some special moves for convenience:
24488 - On an affiliated keyword, jump to the beginning of the
24489 relative element.
24490 - On an item or a footnote definition, move to the second
24491 element inside, if any.
24492 - On a table or a property drawer, jump after it.
24493 - On a verse or source block, stop after blank lines."
24494 (interactive)
24495 (when (eobp) (user-error "Cannot move further down"))
24496 (let* ((deactivate-mark nil)
24497 (element (org-element-at-point))
24498 (type (org-element-type element))
24499 (post-affiliated (org-element-property :post-affiliated element))
24500 (contents-begin (org-element-property :contents-begin element))
24501 (contents-end (org-element-property :contents-end element))
24502 (end (let ((end (org-element-property :end element)) (parent element))
24503 (while (and (setq parent (org-element-property :parent parent))
24504 (= (org-element-property :contents-end parent) end))
24505 (setq end (org-element-property :end parent)))
24506 end)))
24507 (cond ((not element)
24508 (skip-chars-forward " \r\t\n")
24509 (or (eobp) (beginning-of-line)))
24510 ;; On affiliated keywords, move to element's beginning.
24511 ((< (point) post-affiliated)
24512 (goto-char post-affiliated))
24513 ;; At a table row, move to the end of the table. Similarly,
24514 ;; at a node property, move to the end of the property
24515 ;; drawer.
24516 ((memq type '(node-property table-row))
24517 (goto-char (org-element-property
24518 :end (org-element-property :parent element))))
24519 ((memq type '(property-drawer table)) (goto-char end))
24520 ;; Consider blank lines as separators in verse and source
24521 ;; blocks to ease editing.
24522 ((memq type '(src-block verse-block))
24523 (when (eq type 'src-block)
24524 (setq contents-end
24525 (save-excursion (goto-char end)
24526 (skip-chars-backward " \r\t\n")
24527 (line-beginning-position))))
24528 (beginning-of-line)
24529 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24530 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24531 (goto-char end)
24532 (skip-chars-forward " \r\t\n")
24533 (if (= (point) contents-end) (goto-char end)
24534 (beginning-of-line))))
24535 ;; With no contents, just skip element.
24536 ((not contents-begin) (goto-char end))
24537 ;; If contents are invisible, skip the element altogether.
24538 ((outline-invisible-p (line-end-position))
24539 (case type
24540 (headline
24541 (org-with-limited-levels (outline-next-visible-heading 1)))
24542 ;; At a plain list, make sure we move to the next item
24543 ;; instead of skipping the whole list.
24544 (plain-list (forward-char)
24545 (org-forward-paragraph))
24546 (otherwise (goto-char end))))
24547 ((>= (point) contents-end) (goto-char end))
24548 ((>= (point) contents-begin)
24549 ;; This can only happen on paragraphs and plain lists.
24550 (case type
24551 (paragraph (goto-char end))
24552 ;; At a plain list, try to move to second element in
24553 ;; first item, if possible.
24554 (plain-list (end-of-line)
24555 (org-forward-paragraph))))
24556 ;; When contents start on the middle of a line (e.g. in
24557 ;; items and footnote definitions), try to reach first
24558 ;; element starting after current line.
24559 ((> (line-end-position) contents-begin)
24560 (end-of-line)
24561 (org-forward-paragraph))
24562 (t (goto-char contents-begin)))))
24564 (defun org-backward-paragraph ()
24565 "Move backward to start of previous paragraph or equivalent.
24567 The function moves point to the beginning of the current
24568 structural element, which can be a paragraph, a table, a list
24569 item, etc., or to the beginning of the previous visible one if
24570 point is already there. It also provides some special moves for
24571 convenience:
24573 - On an affiliated keyword, jump to the first one.
24574 - On a table or a property drawer, move to its beginning.
24575 - On a verse or source block, stop before blank lines."
24576 (interactive)
24577 (when (bobp) (user-error "Cannot move further up"))
24578 (let* ((deactivate-mark nil)
24579 (element (org-element-at-point))
24580 (type (org-element-type element))
24581 (contents-begin (org-element-property :contents-begin element))
24582 (contents-end (org-element-property :contents-end element))
24583 (post-affiliated (org-element-property :post-affiliated element))
24584 (begin (org-element-property :begin element)))
24585 (cond
24586 ((not element) (goto-char (point-min)))
24587 ((= (point) begin)
24588 (backward-char)
24589 (org-backward-paragraph))
24590 ((<= (point) post-affiliated) (goto-char begin))
24591 ((memq type '(node-property table-row))
24592 (goto-char (org-element-property
24593 :post-affiliated (org-element-property :parent element))))
24594 ((memq type '(property-drawer table)) (goto-char begin))
24595 ((memq type '(src-block verse-block))
24596 (when (eq type 'src-block)
24597 (setq contents-begin
24598 (save-excursion (goto-char begin) (forward-line) (point))))
24599 (if (= (point) contents-begin) (goto-char post-affiliated)
24600 ;; Inside a verse block, see blank lines as paragraph
24601 ;; separators.
24602 (let ((origin (point)))
24603 (skip-chars-backward " \r\t\n" contents-begin)
24604 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24605 (skip-chars-forward " \r\t\n" origin)
24606 (if (= (point) origin) (goto-char contents-begin)
24607 (beginning-of-line))))))
24608 ((not contents-begin) (goto-char (or post-affiliated begin)))
24609 ((eq type 'paragraph)
24610 (goto-char contents-begin)
24611 ;; When at first paragraph in an item or a footnote definition,
24612 ;; move directly to beginning of line.
24613 (let ((parent-contents
24614 (org-element-property
24615 :contents-begin (org-element-property :parent element))))
24616 (when (and parent-contents (= parent-contents contents-begin))
24617 (beginning-of-line))))
24618 ;; At the end of a greater element, move to the beginning of the
24619 ;; last element within.
24620 ((>= (point) contents-end)
24621 (goto-char (1- contents-end))
24622 (org-backward-paragraph))
24623 (t (goto-char (or post-affiliated begin))))
24624 ;; Ensure we never leave point invisible.
24625 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24627 (defun org-forward-element ()
24628 "Move forward by one element.
24629 Move to the next element at the same level, when possible."
24630 (interactive)
24631 (cond ((eobp) (user-error "Cannot move further down"))
24632 ((org-with-limited-levels (org-at-heading-p))
24633 (let ((origin (point)))
24634 (goto-char (org-end-of-subtree nil t))
24635 (unless (org-with-limited-levels (org-at-heading-p))
24636 (goto-char origin)
24637 (user-error "Cannot move further down"))))
24639 (let* ((elem (org-element-at-point))
24640 (end (org-element-property :end elem))
24641 (parent (org-element-property :parent elem)))
24642 (cond ((and parent (= (org-element-property :contents-end parent) end))
24643 (goto-char (org-element-property :end parent)))
24644 ((integer-or-marker-p end) (goto-char end))
24645 (t (message "No element at point")))))))
24647 (defun org-backward-element ()
24648 "Move backward by one element.
24649 Move to the previous element at the same level, when possible."
24650 (interactive)
24651 (cond ((bobp) (user-error "Cannot move further up"))
24652 ((org-with-limited-levels (org-at-heading-p))
24653 ;; At a headline, move to the previous one, if any, or stay
24654 ;; here.
24655 (let ((origin (point)))
24656 (org-with-limited-levels (org-backward-heading-same-level 1))
24657 ;; When current headline has no sibling above, move to its
24658 ;; parent.
24659 (when (= (point) origin)
24660 (or (org-with-limited-levels (org-up-heading-safe))
24661 (progn (goto-char origin)
24662 (user-error "Cannot move further up"))))))
24664 (let* ((elem (org-element-at-point))
24665 (beg (org-element-property :begin elem)))
24666 (cond
24667 ;; Move to beginning of current element if point isn't
24668 ;; there already.
24669 ((null beg) (message "No element at point"))
24670 ((/= (point) beg) (goto-char beg))
24671 (t (goto-char beg)
24672 (skip-chars-backward " \r\t\n")
24673 (unless (bobp)
24674 (let ((prev (org-element-at-point)))
24675 (goto-char (org-element-property :begin prev))
24676 (while (and (setq prev (org-element-property :parent prev))
24677 (<= (org-element-property :end prev) beg))
24678 (goto-char (org-element-property :begin prev)))))))))))
24680 (defun org-up-element ()
24681 "Move to upper element."
24682 (interactive)
24683 (if (org-with-limited-levels (org-at-heading-p))
24684 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24685 (let* ((elem (org-element-at-point))
24686 (parent (org-element-property :parent elem)))
24687 (if parent (goto-char (org-element-property :begin parent))
24688 (if (org-with-limited-levels (org-before-first-heading-p))
24689 (user-error "No surrounding element")
24690 (org-with-limited-levels (org-back-to-heading)))))))
24692 (defvar org-element-greater-elements)
24693 (defun org-down-element ()
24694 "Move to inner element."
24695 (interactive)
24696 (let ((element (org-element-at-point)))
24697 (cond
24698 ((memq (org-element-type element) '(plain-list table))
24699 (goto-char (org-element-property :contents-begin element))
24700 (forward-char))
24701 ((memq (org-element-type element) org-element-greater-elements)
24702 ;; If contents are hidden, first disclose them.
24703 (when (outline-invisible-p (line-end-position)) (org-cycle))
24704 (goto-char (or (org-element-property :contents-begin element)
24705 (user-error "No content for this element"))))
24706 (t (user-error "No inner element")))))
24708 (defun org-drag-element-backward ()
24709 "Move backward element at point."
24710 (interactive)
24711 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24712 (let* ((elem (org-element-at-point))
24713 (prev-elem
24714 (save-excursion
24715 (goto-char (org-element-property :begin elem))
24716 (skip-chars-backward " \r\t\n")
24717 (unless (bobp)
24718 (let* ((beg (org-element-property :begin elem))
24719 (prev (org-element-at-point))
24720 (up prev))
24721 (while (and (setq up (org-element-property :parent up))
24722 (<= (org-element-property :end up) beg))
24723 (setq prev up))
24724 prev)))))
24725 ;; Error out if no previous element or previous element is
24726 ;; a parent of the current one.
24727 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24728 (user-error "Cannot drag element backward")
24729 (let ((pos (point)))
24730 (org-element-swap-A-B prev-elem elem)
24731 (goto-char (+ (org-element-property :begin prev-elem)
24732 (- pos (org-element-property :begin elem)))))))))
24734 (defun org-drag-element-forward ()
24735 "Move forward element at point."
24736 (interactive)
24737 (let* ((pos (point))
24738 (elem (org-element-at-point)))
24739 (when (= (point-max) (org-element-property :end elem))
24740 (user-error "Cannot drag element forward"))
24741 (goto-char (org-element-property :end elem))
24742 (let ((next-elem (org-element-at-point)))
24743 (when (or (org-element-nested-p elem next-elem)
24744 (and (eq (org-element-type next-elem) 'headline)
24745 (not (eq (org-element-type elem) 'headline))))
24746 (goto-char pos)
24747 (user-error "Cannot drag element forward"))
24748 ;; Compute new position of point: it's shifted by NEXT-ELEM
24749 ;; body's length (without final blanks) and by the length of
24750 ;; blanks between ELEM and NEXT-ELEM.
24751 (let ((size-next (- (save-excursion
24752 (goto-char (org-element-property :end next-elem))
24753 (skip-chars-backward " \r\t\n")
24754 (forward-line)
24755 ;; Small correction if buffer doesn't end
24756 ;; with a newline character.
24757 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24758 (org-element-property :begin next-elem)))
24759 (size-blank (- (org-element-property :end elem)
24760 (save-excursion
24761 (goto-char (org-element-property :end elem))
24762 (skip-chars-backward " \r\t\n")
24763 (forward-line)
24764 (point)))))
24765 (org-element-swap-A-B elem next-elem)
24766 (goto-char (+ pos size-next size-blank))))))
24768 (defun org-drag-line-forward (arg)
24769 "Drag the line at point ARG lines forward."
24770 (interactive "p")
24771 (dotimes (n (abs arg))
24772 (let ((c (current-column)))
24773 (if (< 0 arg)
24774 (progn
24775 (beginning-of-line 2)
24776 (transpose-lines 1)
24777 (beginning-of-line 0))
24778 (transpose-lines 1)
24779 (beginning-of-line -1))
24780 (org-move-to-column c))))
24782 (defun org-drag-line-backward (arg)
24783 "Drag the line at point ARG lines backward."
24784 (interactive "p")
24785 (org-drag-line-forward (- arg)))
24787 (defun org-mark-element ()
24788 "Put point at beginning of this element, mark at end.
24790 Interactively, if this command is repeated or (in Transient Mark
24791 mode) if the mark is active, it marks the next element after the
24792 ones already marked."
24793 (interactive)
24794 (let (deactivate-mark)
24795 (if (and (org-called-interactively-p 'any)
24796 (or (and (eq last-command this-command) (mark t))
24797 (and transient-mark-mode mark-active)))
24798 (set-mark
24799 (save-excursion
24800 (goto-char (mark))
24801 (goto-char (org-element-property :end (org-element-at-point)))))
24802 (let ((element (org-element-at-point)))
24803 (end-of-line)
24804 (push-mark (org-element-property :end element) t t)
24805 (goto-char (org-element-property :begin element))))))
24807 (defun org-narrow-to-element ()
24808 "Narrow buffer to current element."
24809 (interactive)
24810 (let ((elem (org-element-at-point)))
24811 (cond
24812 ((eq (car elem) 'headline)
24813 (narrow-to-region
24814 (org-element-property :begin elem)
24815 (org-element-property :end elem)))
24816 ((memq (car elem) org-element-greater-elements)
24817 (narrow-to-region
24818 (org-element-property :contents-begin elem)
24819 (org-element-property :contents-end elem)))
24821 (narrow-to-region
24822 (org-element-property :begin elem)
24823 (org-element-property :end elem))))))
24825 (defun org-transpose-element ()
24826 "Transpose current and previous elements, keeping blank lines between.
24827 Point is moved after both elements."
24828 (interactive)
24829 (org-skip-whitespace)
24830 (let ((end (org-element-property :end (org-element-at-point))))
24831 (org-drag-element-backward)
24832 (goto-char end)))
24834 (defun org-unindent-buffer ()
24835 "Un-indent the visible part of the buffer.
24836 Relative indentation (between items, inside blocks, etc.) isn't
24837 modified."
24838 (interactive)
24839 (unless (eq major-mode 'org-mode)
24840 (user-error "Cannot un-indent a buffer not in Org mode"))
24841 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24842 unindent-tree ; For byte-compiler.
24843 (unindent-tree
24844 (function
24845 (lambda (contents)
24846 (mapc
24847 (lambda (element)
24848 (if (memq (org-element-type element) '(headline section))
24849 (funcall unindent-tree (org-element-contents element))
24850 (save-excursion
24851 (save-restriction
24852 (narrow-to-region
24853 (org-element-property :begin element)
24854 (org-element-property :end element))
24855 (org-do-remove-indentation)))))
24856 (reverse contents))))))
24857 (funcall unindent-tree (org-element-contents parse-tree))))
24859 (defun org-show-children (&optional level)
24860 "Show all direct subheadings of this heading.
24861 Prefix arg LEVEL is how many levels below the current level
24862 should be shown. Default is enough to cause the following
24863 heading to appear."
24864 (interactive "p")
24865 (save-excursion
24866 (org-back-to-heading t)
24867 (let* ((current-level (funcall outline-level))
24868 (max-level (org-get-valid-level
24869 current-level (if level (prefix-numeric-value level) 1)))
24870 (end (save-excursion (org-end-of-subtree t t)))
24871 (regexp-fmt "^\\*\\{%d,%s\\}\\(?: \\|$\\)")
24872 (past-first-child nil)
24873 ;; Make sure to skip inlinetasks.
24874 (re (format regexp-fmt
24875 current-level
24876 (cond
24877 ((not (featurep 'org-inlinetask)) "")
24878 (org-odd-levels-only (- (* 2 org-inlinetask-min-level)
24880 (t (1- org-inlinetask-min-level))))))
24881 ;; Display parent heading.
24882 (outline-flag-region (line-end-position 0) (line-end-position) nil)
24883 (forward-line)
24884 ;; Display children. First child may be deeper than expected
24885 ;; MAX-LEVEL. Since we want to display it anyway, adjust
24886 ;; MAX-LEVEL accordingly.
24887 (while (re-search-forward re end t)
24888 (unless past-first-child
24889 (setq re (format regexp-fmt
24890 current-level
24891 (max (funcall outline-level) max-level)))
24892 (setq past-first-child t))
24893 (outline-flag-region (line-end-position 0) (line-end-position) nil)))))
24895 (defun org-show-subtree ()
24896 "Show everything after this heading at deeper levels."
24897 (interactive)
24898 (outline-flag-region
24899 (point)
24900 (save-excursion
24901 (org-end-of-subtree t t))
24902 nil))
24904 (defun org-show-entry ()
24905 "Show the body directly following this heading.
24906 Show the heading too, if it is currently invisible."
24907 (interactive)
24908 (save-excursion
24909 (ignore-errors
24910 (org-back-to-heading t)
24911 (outline-flag-region
24912 (max (point-min) (1- (point)))
24913 (save-excursion
24914 (if (re-search-forward
24915 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24916 (match-beginning 1)
24917 (point-max)))
24918 nil)
24919 (org-cycle-hide-drawers 'children))))
24921 (defun org-make-options-regexp (kwds &optional extra)
24922 "Make a regular expression for keyword lines.
24923 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24924 when non-nil, is a regexp matching keywords names."
24925 (concat "^[ \t]*#\\+\\("
24926 (regexp-opt kwds)
24927 (and extra (concat (and kwds "\\|") extra))
24928 "\\):[ \t]*\\(.*\\)"))
24930 ;; Make isearch reveal the necessary context
24931 (defun org-isearch-end ()
24932 "Reveal context after isearch exits."
24933 (when isearch-success ; only if search was successful
24934 (if (featurep 'xemacs)
24935 ;; Under XEmacs, the hook is run in the correct place,
24936 ;; we directly show the context.
24937 (org-show-context 'isearch)
24938 ;; In Emacs the hook runs *before* restoring the overlays.
24939 ;; So we have to use a one-time post-command-hook to do this.
24940 ;; (Emacs 22 has a special variable, see function `org-mode')
24941 (unless (and (boundp 'isearch-mode-end-hook-quit)
24942 isearch-mode-end-hook-quit)
24943 ;; Only when the isearch was not quitted.
24944 (org-add-hook 'post-command-hook 'org-isearch-post-command
24945 'append 'local)))))
24947 (defun org-isearch-post-command ()
24948 "Remove self from hook, and show context."
24949 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24950 (org-show-context 'isearch))
24953 ;;;; Integration with and fixes for other packages
24955 ;;; Imenu support
24957 (defvar-local org-imenu-markers nil
24958 "All markers currently used by Imenu.")
24960 (defun org-imenu-new-marker (&optional pos)
24961 "Return a new marker for use by Imenu, and remember the marker."
24962 (let ((m (make-marker)))
24963 (move-marker m (or pos (point)))
24964 (push m org-imenu-markers)
24967 (defun org-imenu-get-tree ()
24968 "Produce the index for Imenu."
24969 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24970 (setq org-imenu-markers nil)
24971 (let* ((n org-imenu-depth)
24972 (re (concat "^" (org-get-limited-outline-regexp)))
24973 (subs (make-vector (1+ n) nil))
24974 (last-level 0)
24975 m level head0 head)
24976 (save-excursion
24977 (save-restriction
24978 (widen)
24979 (goto-char (point-max))
24980 (while (re-search-backward re nil t)
24981 (setq level (org-reduced-level (funcall outline-level)))
24982 (when (and (<= level n)
24983 (looking-at org-complex-heading-regexp)
24984 (setq head0 (org-match-string-no-properties 4)))
24985 (setq head (org-link-display-format head0)
24986 m (org-imenu-new-marker))
24987 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24988 (if (>= level last-level)
24989 (push (cons head m) (aref subs level))
24990 (push (cons head (aref subs (1+ level))) (aref subs level))
24991 (loop for i from (1+ level) to n do (aset subs i nil)))
24992 (setq last-level level)))))
24993 (aref subs 1)))
24995 (eval-after-load "imenu"
24996 '(progn
24997 (add-hook 'imenu-after-jump-hook
24998 (lambda ()
24999 (when (derived-mode-p 'org-mode)
25000 (org-show-context 'org-goto))))))
25002 (defun org-link-display-format (link)
25003 "Replace a link with its the description.
25004 If there is no description, use the link target."
25005 (save-match-data
25006 (if (string-match org-bracket-link-analytic-regexp link)
25007 (replace-match (if (match-end 5)
25008 (match-string 5 link)
25009 (concat (match-string 1 link)
25010 (match-string 3 link)))
25011 nil t link)
25012 link)))
25014 (defun org-toggle-link-display ()
25015 "Toggle the literal or descriptive display of links."
25016 (interactive)
25017 (if org-descriptive-links
25018 (progn (org-remove-from-invisibility-spec '(org-link))
25019 (org-restart-font-lock)
25020 (setq org-descriptive-links nil))
25021 (progn (add-to-invisibility-spec '(org-link))
25022 (org-restart-font-lock)
25023 (setq org-descriptive-links t))))
25025 ;; Speedbar support
25027 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25028 "Overlay marking the agenda restriction line in speedbar.")
25029 (overlay-put org-speedbar-restriction-lock-overlay
25030 'face 'org-agenda-restriction-lock)
25031 (overlay-put org-speedbar-restriction-lock-overlay
25032 'help-echo "Agendas are currently limited to this item.")
25033 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25035 (defun org-speedbar-set-agenda-restriction ()
25036 "Restrict future agenda commands to the location at point in speedbar.
25037 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25038 (interactive)
25039 (require 'org-agenda)
25040 (let (p m tp np dir txt)
25041 (cond
25042 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25043 'org-imenu t))
25044 (setq m (get-text-property p 'org-imenu-marker))
25045 (with-current-buffer (marker-buffer m)
25046 (goto-char m)
25047 (org-agenda-set-restriction-lock 'subtree)))
25048 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25049 'speedbar-function 'speedbar-find-file))
25050 (setq tp (previous-single-property-change
25051 (1+ p) 'speedbar-function)
25052 np (next-single-property-change
25053 tp 'speedbar-function)
25054 dir (speedbar-line-directory)
25055 txt (buffer-substring-no-properties (or tp (point-min))
25056 (or np (point-max))))
25057 (with-current-buffer (find-file-noselect
25058 (let ((default-directory dir))
25059 (expand-file-name txt)))
25060 (unless (derived-mode-p 'org-mode)
25061 (user-error "Cannot restrict to non-Org-mode file"))
25062 (org-agenda-set-restriction-lock 'file)))
25063 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25064 (move-overlay org-speedbar-restriction-lock-overlay
25065 (point-at-bol) (point-at-eol))
25066 (setq current-prefix-arg nil)
25067 (org-agenda-maybe-redo)))
25069 (defvar speedbar-file-key-map)
25070 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25071 (eval-after-load "speedbar"
25072 '(progn
25073 (speedbar-add-supported-extension ".org")
25074 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25075 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25076 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25077 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25078 (add-hook 'speedbar-visiting-tag-hook
25079 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25081 ;;; Fixes and Hacks for problems with other packages
25083 (defun org--flyspell-object-check-p (element)
25084 "Non-nil when Flyspell can check object at point.
25085 ELEMENT is the element at point."
25086 (let ((object (save-excursion
25087 (when (org-looking-at-p "\\>") (backward-char))
25088 (org-element-context element))))
25089 (case (org-element-type object)
25090 ;; Prevent checks in links due to keybinding conflict with
25091 ;; Flyspell.
25092 ((code entity export-snippet inline-babel-call
25093 inline-src-block line-break latex-fragment link macro
25094 statistics-cookie target timestamp verbatim)
25095 nil)
25096 (footnote-reference
25097 ;; Only in inline footnotes, within the definition.
25098 (and (eq (org-element-property :type object) 'inline)
25099 (< (save-excursion
25100 (goto-char (org-element-property :begin object))
25101 (search-forward ":" nil t 2))
25102 (point))))
25103 (otherwise t))))
25105 (defun org-mode-flyspell-verify ()
25106 "Function used for `flyspell-generic-check-word-predicate'."
25107 (if (org-at-heading-p)
25108 ;; At a headline or an inlinetask, check title only. This is
25109 ;; faster than relying on `org-element-at-point'.
25110 (and (save-excursion (beginning-of-line)
25111 (and (let ((case-fold-search t))
25112 (not (looking-at "\\*+ END[ \t]*$")))
25113 (looking-at org-complex-heading-regexp)))
25114 (match-beginning 4)
25115 (>= (point) (match-beginning 4))
25116 (or (not (match-beginning 5))
25117 (< (point) (match-beginning 5))))
25118 (let* ((element (org-element-at-point))
25119 (post-affiliated (org-element-property :post-affiliated element)))
25120 (cond
25121 ;; Ignore checks in all affiliated keywords but captions.
25122 ((< (point) post-affiliated)
25123 (and (save-excursion
25124 (beginning-of-line)
25125 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25126 (> (point) (match-end 0))
25127 (org--flyspell-object-check-p element)))
25128 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25129 ((let ((log (org-log-into-drawer)))
25130 (and log
25131 (let ((drawer (org-element-lineage element '(drawer))))
25132 (and drawer
25133 (eq (compare-strings
25134 log nil nil
25135 (org-element-property :drawer-name drawer) nil nil t)
25136 t)))))
25137 nil)
25139 (case (org-element-type element)
25140 ((comment quote-section) t)
25141 (comment-block
25142 ;; Allow checks between block markers, not on them.
25143 (and (> (line-beginning-position) post-affiliated)
25144 (save-excursion
25145 (end-of-line)
25146 (skip-chars-forward " \r\t\n")
25147 (< (point) (org-element-property :end element)))))
25148 ;; Arbitrary list of keywords where checks are meaningful.
25149 ;; Make sure point is on the value part of the element.
25150 (keyword
25151 (and (member (org-element-property :key element)
25152 '("DESCRIPTION" "TITLE"))
25153 (save-excursion
25154 (search-backward ":" (line-beginning-position) t))))
25155 ;; Check is globally allowed in paragraphs verse blocks and
25156 ;; table rows (after affiliated keywords) but some objects
25157 ;; must not be affected.
25158 ((paragraph table-row verse-block)
25159 (let ((cbeg (org-element-property :contents-begin element))
25160 (cend (org-element-property :contents-end element)))
25161 (and cbeg (>= (point) cbeg) (< (point) cend)
25162 (org--flyspell-object-check-p element))))))))))
25163 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25165 (defun org-remove-flyspell-overlays-in (beg end)
25166 "Remove flyspell overlays in region."
25167 (and (org-bound-and-true-p flyspell-mode)
25168 (fboundp 'flyspell-delete-region-overlays)
25169 (flyspell-delete-region-overlays beg end)))
25171 (defvar flyspell-delayed-commands)
25172 (eval-after-load "flyspell"
25173 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25175 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25176 (eval-after-load "bookmark"
25177 '(if (boundp 'bookmark-after-jump-hook)
25178 ;; We can use the hook
25179 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25180 ;; Hook not available, use advice
25181 (defadvice bookmark-jump (after org-make-visible activate)
25182 "Make the position visible."
25183 (org-bookmark-jump-unhide))))
25185 ;; Make sure saveplace shows the location if it was hidden
25186 (eval-after-load "saveplace"
25187 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25188 "Make the position visible."
25189 (org-bookmark-jump-unhide)))
25191 ;; Make sure ecb shows the location if it was hidden
25192 (eval-after-load "ecb"
25193 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25194 "Make hierarchy visible when jumping into location from ECB tree buffer."
25195 (when (derived-mode-p 'org-mode)
25196 (org-show-context))))
25198 (defun org-bookmark-jump-unhide ()
25199 "Unhide the current position, to show the bookmark location."
25200 (and (derived-mode-p 'org-mode)
25201 (or (outline-invisible-p)
25202 (save-excursion (goto-char (max (point-min) (1- (point))))
25203 (outline-invisible-p)))
25204 (org-show-context 'bookmark-jump)))
25206 (defun org-mark-jump-unhide ()
25207 "Make the point visible with `org-show-context' after jumping to the mark."
25208 (when (and (derived-mode-p 'org-mode)
25209 (outline-invisible-p))
25210 (org-show-context 'mark-goto)))
25212 (eval-after-load "simple"
25213 '(defadvice pop-to-mark-command (after org-make-visible activate)
25214 "Make the point visible with `org-show-context'."
25215 (org-mark-jump-unhide)))
25217 (eval-after-load "simple"
25218 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25219 "Make the point visible with `org-show-context'."
25220 (org-mark-jump-unhide)))
25222 (eval-after-load "simple"
25223 '(defadvice pop-global-mark (after org-make-visible activate)
25224 "Make the point visible with `org-show-context'."
25225 (org-mark-jump-unhide)))
25227 ;; Make session.el ignore our circular variable
25228 (defvar session-globals-exclude)
25229 (eval-after-load "session"
25230 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25232 ;;;; Finish up
25234 (provide 'org)
25236 (run-hooks 'org-load-hook)
25238 ;;; org.el ends here