Revert "org.el: Add version header"
[org-mode.git] / lisp / org.el
bloba323582972d16365fbdfcf6bca11b703dbf15871
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 org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local)
70 ;;;; Require other packages
72 (eval-when-compile
73 (require 'cl)
74 (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (or (equal this-command 'eval-buffer)
81 (condition-case nil
82 (load (concat (file-name-directory load-file-name)
83 "org-loaddefs.el")
84 nil t t t)
85 (error
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
87 (sit-for 3)
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
89 (sit-for 3))))
91 (require 'org-macs)
92 (require 'org-compat)
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp "\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol "^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (unless (boundp 'calendar-view-holidays-initially-flag)
115 (org-defvaralias 'calendar-view-holidays-initially-flag
116 'view-calendar-holidays-initially))
117 (unless (boundp 'calendar-view-diary-initially-flag)
118 (org-defvaralias 'calendar-view-diary-initially-flag
119 'view-diary-entries-initially))
120 (unless (boundp 'diary-fancy-buffer)
121 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
123 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
124 (declare-function org-add-archive-files "org-archive" (files))
125 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
126 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
127 (declare-function org-agenda-redo "org-agenda" (&optional all))
128 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
129 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
130 (declare-function org-beamer-mode "ox-beamer" ())
131 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
132 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
133 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
134 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
135 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
136 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
137 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
138 (declare-function org-clock-update-time-maybe "org-clock" ())
139 (declare-function org-clocktable-shift "org-clock" (dir n))
140 (declare-function org-element-at-point "org-element" ())
141 (declare-function org-element-cache-refresh "org-element" (pos))
142 (declare-function org-element-cache-reset "org-element" (&optional all))
143 (declare-function org-element-contents "org-element" (element))
144 (declare-function org-element-context "org-element" (&optional element))
145 (declare-function org-element-copy "org-element" (datum))
146 (declare-function org-element-interpret-data "org-element" (data &optional parent))
147 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
148 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
149 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
150 (declare-function org-element-property "org-element" (property element))
151 (declare-function org-element-put-property "org-element" (element property value))
152 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
153 (declare-function org-element-type "org-element" (element))
154 (declare-function org-element-update-syntax "org-element" ())
155 (declare-function org-id-find-id-file "org-id" (id))
156 (declare-function org-id-get-create "org-id" (&optional force))
157 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
158 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
159 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
160 (declare-function org-plot/gnuplot "org-plot" (&optional params))
161 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
162 (declare-function org-table-align "org-table" ())
163 (declare-function org-table-begin "org-table" (&optional table-type))
164 (declare-function org-table-beginning-of-field "org-table" (&optional n))
165 (declare-function org-table-blank-field "org-table" ())
166 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
167 (declare-function org-table-edit-field "org-table" (arg))
168 (declare-function org-table-end "org-table" (&optional table-type))
169 (declare-function org-table-end-of-field "org-table" (&optional n))
170 (declare-function org-table-insert-row "org-table" (&optional arg))
171 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
172 (declare-function org-table-maybe-eval-formula "org-table" ())
173 (declare-function org-table-maybe-recalculate-line "org-table" ())
174 (declare-function org-table-next-row "org-table" ())
175 (declare-function org-table-paste-rectangle "org-table" ())
176 (declare-function org-table-wrap-region "org-table" (arg))
177 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
178 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
179 (declare-function orgtbl-mode "org-table" (&optional arg))
181 (defsubst org-uniquify (list)
182 "Non-destructively remove duplicate elements from LIST."
183 (let ((res (copy-sequence list))) (delete-dups res)))
185 (defsubst org-get-at-bol (property)
186 "Get text property PROPERTY at the beginning of line."
187 (get-text-property (point-at-bol) property))
189 (defsubst org-trim (s)
190 "Remove whitespace at the beginning and the end of string S."
191 (replace-regexp-in-string
192 "\\`[ \t\n\r]+" ""
193 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
195 ;; load languages based on value of `org-babel-load-languages'
196 (defvar org-babel-load-languages)
198 ;;;###autoload
199 (defun org-babel-do-load-languages (sym value)
200 "Load the languages defined in `org-babel-load-languages'."
201 (set-default sym value)
202 (mapc (lambda (pair)
203 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
204 (if active
205 (progn
206 (require (intern (concat "ob-" lang))))
207 (progn
208 (funcall 'fmakunbound
209 (intern (concat "org-babel-execute:" lang)))
210 (funcall 'fmakunbound
211 (intern (concat "org-babel-expand-body:" lang)))))))
212 org-babel-load-languages))
214 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
215 ;;;###autoload
216 (defun org-babel-load-file (file &optional compile)
217 "Load Emacs Lisp source code blocks in the Org-mode FILE.
218 This function exports the source code using `org-babel-tangle'
219 and then loads the resulting file using `load-file'. With prefix
220 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
221 file to byte-code before it is loaded."
222 (interactive "fFile to load: \nP")
223 (let* ((age (lambda (file)
224 (float-time
225 (time-subtract (current-time)
226 (nth 5 (or (file-attributes (file-truename file))
227 (file-attributes file)))))))
228 (base-name (file-name-sans-extension file))
229 (exported-file (concat base-name ".el")))
230 ;; tangle if the org-mode file is newer than the elisp file
231 (unless (and (file-exists-p exported-file)
232 (> (funcall age file) (funcall age exported-file)))
233 ;; Tangle-file traversal returns reversed list of tangled files
234 ;; and we want to evaluate the first target.
235 (setq exported-file
236 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
237 (message "%s %s"
238 (if compile
239 (progn (byte-compile-file exported-file 'load)
240 "Compiled and loaded")
241 (progn (load-file exported-file) "Loaded"))
242 exported-file)))
244 (defcustom org-babel-load-languages '((emacs-lisp . t))
245 "Languages which can be evaluated in Org-mode buffers.
246 This list can be used to load support for any of the languages
247 below, note that each language will depend on a different set of
248 system executables and/or Emacs modes. When a language is
249 \"loaded\", then code blocks in that language can be evaluated
250 with `org-babel-execute-src-block' bound by default to C-c
251 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
252 be set to remove code block evaluation from the C-c C-c
253 keybinding. By default only Emacs Lisp (which has no
254 requirements) is loaded."
255 :group 'org-babel
256 :set 'org-babel-do-load-languages
257 :version "24.1"
258 :type '(alist :tag "Babel Languages"
259 :key-type
260 (choice
261 (const :tag "Awk" awk)
262 (const :tag "C" C)
263 (const :tag "R" R)
264 (const :tag "Asymptote" asymptote)
265 (const :tag "Calc" calc)
266 (const :tag "Clojure" clojure)
267 (const :tag "CSS" css)
268 (const :tag "Ditaa" ditaa)
269 (const :tag "Dot" dot)
270 (const :tag "Emacs Lisp" emacs-lisp)
271 (const :tag "Forth" forth)
272 (const :tag "Fortran" fortran)
273 (const :tag "Gnuplot" gnuplot)
274 (const :tag "Haskell" haskell)
275 (const :tag "IO" io)
276 (const :tag "J" J)
277 (const :tag "Java" java)
278 (const :tag "Javascript" js)
279 (const :tag "LaTeX" latex)
280 (const :tag "Ledger" ledger)
281 (const :tag "Lilypond" lilypond)
282 (const :tag "Lisp" lisp)
283 (const :tag "Makefile" makefile)
284 (const :tag "Maxima" maxima)
285 (const :tag "Matlab" matlab)
286 (const :tag "Mscgen" mscgen)
287 (const :tag "Ocaml" ocaml)
288 (const :tag "Octave" octave)
289 (const :tag "Org" org)
290 (const :tag "Perl" perl)
291 (const :tag "Pico Lisp" picolisp)
292 (const :tag "PlantUML" plantuml)
293 (const :tag "Python" python)
294 (const :tag "Ruby" ruby)
295 (const :tag "Sass" sass)
296 (const :tag "Scala" scala)
297 (const :tag "Scheme" scheme)
298 (const :tag "Screen" screen)
299 (const :tag "Shell Script" shell)
300 (const :tag "Shen" shen)
301 (const :tag "Sql" sql)
302 (const :tag "Sqlite" sqlite)
303 (const :tag "ebnf2ps" ebnf2ps))
304 :value-type (boolean :tag "Activate" :value t)))
306 ;;;; Customization variables
307 (defcustom org-clone-delete-id nil
308 "Remove ID property of clones of a subtree.
309 When non-nil, clones of a subtree don't inherit the ID property.
310 Otherwise they inherit the ID property with a new unique
311 identifier."
312 :type 'boolean
313 :version "24.1"
314 :group 'org-id)
316 ;;; Version
317 (org-check-version)
319 ;;;###autoload
320 (defun org-version (&optional here full message)
321 "Show the org-mode version.
322 Interactively, or when MESSAGE is non-nil, show it in echo area.
323 With prefix argument, or when HERE is non-nil, insert it at point.
324 In non-interactive uses, a reduced version string is output unless
325 FULL is given."
326 (interactive (list current-prefix-arg t (not current-prefix-arg)))
327 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
328 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
329 (load-suffixes (list ".el"))
330 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
331 (org-trash (or
332 (and (fboundp 'org-release) (fboundp 'org-git-version))
333 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
334 (load-suffixes save-load-suffixes)
335 (org-version (org-release))
336 (git-version (org-git-version))
337 (version (format "Org-mode version %s (%s @ %s)"
338 org-version
339 git-version
340 (if org-install-dir
341 (if (string= org-dir org-install-dir)
342 org-install-dir
343 (concat "mixed installation! " org-install-dir " and " org-dir))
344 "org-loaddefs.el can not be found!")))
345 (version1 (if full version org-version)))
346 (when here (insert version1))
347 (when message (message "%s" version1))
348 version1))
350 (defconst org-version (org-version))
353 ;;; Syntax Constants
355 ;;;; Block
357 (defconst org-block-regexp
358 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
359 "Regular expression for hiding blocks.")
361 (defconst org-dblock-start-re
362 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
363 "Matches the start line of a dynamic block, with parameters.")
365 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
366 "Matches the end of a dynamic block.")
368 ;;;; Clock and Planning
370 (defconst org-clock-string "CLOCK:"
371 "String used as prefix for timestamps clocking work hours on an item.")
373 (defvar org-closed-string "CLOSED:"
374 "String used as the prefix for timestamps logging closing a TODO entry.")
376 (defvar org-deadline-string "DEADLINE:"
377 "String to mark deadline entries.
378 A deadline is this string, followed by a time stamp. Should be a word,
379 terminated by a colon. You can insert a schedule keyword and
380 a timestamp with \\[org-deadline].")
382 (defvar org-scheduled-string "SCHEDULED:"
383 "String to mark scheduled TODO entries.
384 A schedule is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-schedule].")
388 (defconst org-ds-keyword-length
389 (+ 2
390 (apply #'max
391 (mapcar #'length
392 (list org-deadline-string org-scheduled-string
393 org-clock-string org-closed-string))))
394 "Maximum length of the DEADLINE and SCHEDULED keywords.")
396 (defconst org-planning-line-re
397 (concat "^[ \t]*"
398 (regexp-opt
399 (list org-closed-string org-deadline-string org-scheduled-string)
401 "Matches a line with planning info.
402 Matched keyword is in group 1.")
404 (defconst org-clock-line-re
405 (concat "^[ \t]*" org-clock-string)
406 "Matches a line with clock info.")
408 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
409 "Matches the DEADLINE keyword.")
411 (defconst org-deadline-time-regexp
412 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
413 "Matches the DEADLINE keyword together with a time stamp.")
415 (defconst org-deadline-time-hour-regexp
416 (concat "\\<" org-deadline-string
417 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
418 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
420 (defconst org-deadline-line-regexp
421 (concat "\\<\\(" org-deadline-string "\\).*")
422 "Matches the DEADLINE keyword and the rest of the line.")
424 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
425 "Matches the SCHEDULED keyword.")
427 (defconst org-scheduled-time-regexp
428 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
429 "Matches the SCHEDULED keyword together with a time stamp.")
431 (defconst org-scheduled-time-hour-regexp
432 (concat "\\<" org-scheduled-string
433 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
434 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
436 (defconst org-closed-time-regexp
437 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
438 "Matches the CLOSED keyword together with a time stamp.")
440 (defconst org-keyword-time-regexp
441 (concat "\\<"
442 (regexp-opt
443 (list org-scheduled-string org-deadline-string org-closed-string
444 org-clock-string)
446 " *[[<]\\([^]>]+\\)[]>]")
447 "Matches any of the 4 keywords, together with the time stamp.")
449 (defconst org-keyword-time-not-clock-regexp
450 (concat
451 "\\<"
452 (regexp-opt
453 (list org-scheduled-string org-deadline-string org-closed-string) t)
454 " *[[<]\\([^]>]+\\)[]>]")
455 "Matches any of the 3 keywords, together with the time stamp.")
457 (defconst org-maybe-keyword-time-regexp
458 (concat "\\(\\<"
459 (regexp-opt
460 (list org-scheduled-string org-deadline-string org-closed-string
461 org-clock-string)
463 "\\)?"
464 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
465 "\\|"
466 "<%%([^\r\n>]*>\\)")
467 "Matches a timestamp, possibly preceded by a keyword.")
469 (defconst org-all-time-keywords
470 (mapcar (lambda (w) (substring w 0 -1))
471 (list org-scheduled-string org-deadline-string
472 org-clock-string org-closed-string))
473 "List of time keywords.")
475 ;;;; Drawer
477 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
478 "Matches first or last line of a hidden block.
479 Group 1 contains drawer's name or \"END\".")
481 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
482 "Regular expression matching the first line of a property drawer.")
484 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
485 "Regular expression matching the last line of a property drawer.")
487 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
488 "Regular expression matching the first line of a clock drawer.")
490 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a clock drawer.")
493 (defconst org-property-drawer-re
494 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
495 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
496 "[ \t]*:END:[ \t]*$")
497 "Matches an entire property drawer.")
499 (defconst org-clock-drawer-re
500 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
501 org-clock-drawer-end-re "\\)\n?")
502 "Matches an entire clock drawer.")
504 ;;;; Headline
506 (defconst org-heading-keyword-regexp-format
507 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
508 "Printf format for a regexp matching a headline with some keyword.
509 This regexp will match the headline of any node which has the
510 exact keyword that is put into the format. The keyword isn't in
511 any group by default, but the stars and the body are.")
513 (defconst org-heading-keyword-maybe-regexp-format
514 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
515 "Printf format for a regexp matching a headline, possibly with some keyword.
516 This regexp can match any headline with the specified keyword, or
517 without a keyword. The keyword isn't in any group by default,
518 but the stars and the body are.")
520 (defconst org-archive-tag "ARCHIVE"
521 "The tag that marks a subtree as archived.
522 An archived subtree does not open during visibility cycling, and does
523 not contribute to the agenda listings.")
525 (defconst org-comment-string "COMMENT"
526 "Entries starting with this keyword will never be exported.
527 An entry can be toggled between COMMENT and normal with
528 \\[org-toggle-comment].")
531 ;;;; LaTeX Environments and Fragments
533 (defconst org-latex-regexps
534 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
535 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
536 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
537 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
538 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
539 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
540 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
541 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
542 "Regular expressions for matching embedded LaTeX.")
544 ;;;; Node Property
546 (defconst org-effort-property "Effort"
547 "The property that is being used to keep track of effort estimates.
548 Effort estimates given in this property need to have the format H:MM.")
550 ;;;; Table
552 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
553 "Detect an org-type or table-type table.")
555 (defconst org-table-line-regexp "^[ \t]*|"
556 "Detect an org-type table line.")
558 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
559 "Detect an org-type table line.")
561 (defconst org-table-hline-regexp "^[ \t]*|-"
562 "Detect an org-type table hline.")
564 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
565 "Detect a table-type table hline.")
567 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
568 "Detect the first line outside a table when searching from within it.
569 This works for both table types.")
571 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
572 "Detect a #+TBLFM line.")
574 ;;;; Timestamp
576 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
577 "Regular expression for fast time stamp matching.")
579 (defconst org-ts-regexp-inactive
580 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
581 "Regular expression for fast inactive time stamp matching.")
583 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
584 "Regular expression for fast time stamp matching.")
586 (defconst org-ts-regexp0
587 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
588 "Regular expression matching time strings for analysis.
589 This one does not require the space after the date, so it can be used
590 on a string that terminates immediately after the date.")
592 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
593 "Regular expression matching time strings for analysis.")
595 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
596 "Regular expression matching time stamps, with groups.")
598 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
599 "Regular expression matching time stamps (also [..]), with groups.")
601 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
602 "Regular expression matching a time stamp range.")
604 (defconst org-tr-regexp-both
605 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
606 "Regular expression matching a time stamp range.")
608 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
609 org-ts-regexp "\\)?")
610 "Regular expression matching a time stamp or time stamp range.")
612 (defconst org-tsr-regexp-both
613 (concat org-ts-regexp-both "\\(--?-?"
614 org-ts-regexp-both "\\)?")
615 "Regular expression matching a time stamp or time stamp range.
616 The time stamps may be either active or inactive.")
618 (defconst org-repeat-re
619 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
620 "Regular expression for specifying repeated events.
621 After a match, group 1 contains the repeat expression.")
623 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
624 "Formats for `format-time-string' which are used for time stamps.")
627 ;;; The custom variables
629 (defgroup org nil
630 "Outline-based notes management and organizer."
631 :tag "Org"
632 :group 'outlines
633 :group 'calendar)
635 (defcustom org-mode-hook nil
636 "Mode hook for Org-mode, run after the mode was turned on."
637 :group 'org
638 :type 'hook)
640 (defcustom org-load-hook nil
641 "Hook that is run after org.el has been loaded."
642 :group 'org
643 :type 'hook)
645 (defcustom org-log-buffer-setup-hook nil
646 "Hook that is run after an Org log buffer is created."
647 :group 'org
648 :version "24.1"
649 :type 'hook)
651 (defvar org-modules) ; defined below
652 (defvar org-modules-loaded nil
653 "Have the modules been loaded already?")
655 (defun org-load-modules-maybe (&optional force)
656 "Load all extensions listed in `org-modules'."
657 (when (or force (not org-modules-loaded))
658 (mapc (lambda (ext)
659 (condition-case nil (require ext)
660 (error (message "Problems while trying to load feature `%s'" ext))))
661 org-modules)
662 (setq org-modules-loaded t)))
664 (defun org-set-modules (var value)
665 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
666 (set var value)
667 (when (featurep 'org)
668 (org-load-modules-maybe 'force)
669 (org-element-cache-reset 'all)))
671 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
672 "Modules that should always be loaded together with org.el.
674 If a description starts with <C>, the file is not part of Emacs
675 and loading it will require that you have downloaded and properly
676 installed the Org mode distribution.
678 You can also use this system to load external packages (i.e. neither Org
679 core modules, nor modules from the CONTRIB directory). Just add symbols
680 to the end of the list. If the package is called org-xyz.el, then you need
681 to add the symbol `xyz', and the package must have a call to:
683 \(provide 'org-xyz)
685 For export specific modules, see also `org-export-backends'."
686 :group 'org
687 :set 'org-set-modules
688 :version "24.4"
689 :package-version '(Org . "8.0")
690 :type
691 '(set :greedy t
692 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
693 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
694 (const :tag " crypt: Encryption of subtrees" org-crypt)
695 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
696 (const :tag " docview: Links to doc-view buffers" org-docview)
697 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
698 (const :tag " habit: Track your consistency with habits" org-habit)
699 (const :tag " id: Global IDs for identifying entries" org-id)
700 (const :tag " info: Links to Info nodes" org-info)
701 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
702 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
703 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
704 (const :tag " mouse: Additional mouse support" org-mouse)
705 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
706 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
707 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
709 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
710 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
711 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
712 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
713 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
714 (const :tag "C collector: Collect properties into tables" org-collector)
715 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
716 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
717 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
718 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
719 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
720 (const :tag "C eval: Include command output as text" org-eval)
721 (const :tag "C eww: Store link to url of eww" org-eww)
722 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
723 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
724 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
725 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
726 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
727 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
728 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
729 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
730 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
731 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
732 (const :tag "C mew: Links to Mew folders/messages" org-mew)
733 (const :tag "C mtags: Support for muse-like tags" org-mtags)
734 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
735 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
736 (const :tag "C registry: A registry for Org-mode links" org-registry)
737 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
738 (const :tag "C secretary: Team management with org-mode" org-secretary)
739 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
740 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
741 (const :tag "C track: Keep up with Org-mode development" org-track)
742 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
743 (const :tag "C vm: Links to VM folders/messages" org-vm)
744 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
745 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
746 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
748 (defvar org-export-registered-backends) ; From ox.el.
749 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
750 (declare-function org-export-backend-name "ox" (backend))
751 (defcustom org-export-backends '(ascii html icalendar latex)
752 "List of export back-ends that should be always available.
754 If a description starts with <C>, the file is not part of Emacs
755 and loading it will require that you have downloaded and properly
756 installed the Org mode distribution.
758 Unlike to `org-modules', libraries in this list will not be
759 loaded along with Org, but only once the export framework is
760 needed.
762 This variable needs to be set before org.el is loaded. If you
763 need to make a change while Emacs is running, use the customize
764 interface or run the following code, where VAL stands for the new
765 value of the variable, after updating it:
767 \(progn
768 \(setq org-export-registered-backends
769 \(org-remove-if-not
770 \(lambda (backend)
771 \(let ((name (org-export-backend-name backend)))
772 \(or (memq name val)
773 \(catch 'parentp
774 \(dolist (b val)
775 \(and (org-export-derived-backend-p b name)
776 \(throw 'parentp t)))))))
777 org-export-registered-backends))
778 \(let ((new-list (mapcar #'org-export-backend-name
779 org-export-registered-backends)))
780 \(dolist (backend val)
781 \(cond
782 \((not (load (format \"ox-%s\" backend) t t))
783 \(message \"Problems while trying to load export back-end `%s'\"
784 backend))
785 \((not (memq backend new-list)) (push backend new-list))))
786 \(set-default 'org-export-backends new-list)))
788 Adding a back-end to this list will also pull the back-end it
789 depends on, if any."
790 :group 'org
791 :group 'org-export
792 :version "24.4"
793 :package-version '(Org . "8.0")
794 :initialize 'custom-initialize-set
795 :set (lambda (var val)
796 (if (not (featurep 'ox)) (set-default var val)
797 ;; Any back-end not required anymore (not present in VAL and not
798 ;; a parent of any back-end in the new value) is removed from the
799 ;; list of registered back-ends.
800 (setq org-export-registered-backends
801 (org-remove-if-not
802 (lambda (backend)
803 (let ((name (org-export-backend-name backend)))
804 (or (memq name val)
805 (catch 'parentp
806 (dolist (b val)
807 (and (org-export-derived-backend-p b name)
808 (throw 'parentp t)))))))
809 org-export-registered-backends))
810 ;; Now build NEW-LIST of both new back-ends and required
811 ;; parents.
812 (let ((new-list (mapcar #'org-export-backend-name
813 org-export-registered-backends)))
814 (dolist (backend val)
815 (cond
816 ((not (load (format "ox-%s" backend) t t))
817 (message "Problems while trying to load export back-end `%s'"
818 backend))
819 ((not (memq backend new-list)) (push backend new-list))))
820 ;; Set VAR to that list with fixed dependencies.
821 (set-default var new-list))))
822 :type '(set :greedy t
823 (const :tag " ascii Export buffer to ASCII format" ascii)
824 (const :tag " beamer Export buffer to Beamer presentation" beamer)
825 (const :tag " html Export buffer to HTML format" html)
826 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
827 (const :tag " latex Export buffer to LaTeX format" latex)
828 (const :tag " man Export buffer to MAN format" man)
829 (const :tag " md Export buffer to Markdown format" md)
830 (const :tag " odt Export buffer to ODT format" odt)
831 (const :tag " org Export buffer to Org format" org)
832 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
833 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
834 (const :tag "C deck Export buffer to deck.js presentations" deck)
835 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
836 (const :tag "C groff Export buffer to Groff format" groff)
837 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
838 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
839 (const :tag "C s5 Export buffer to s5 presentations" s5)
840 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
842 (eval-after-load 'ox
843 '(mapc
844 (lambda (backend)
845 (condition-case nil (require (intern (format "ox-%s" backend)))
846 (error (message "Problems while trying to load export back-end `%s'"
847 backend))))
848 org-export-backends))
850 (defcustom org-support-shift-select nil
851 "Non-nil means make shift-cursor commands select text when possible.
853 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
854 start selecting a region, or enlarge regions started in this way.
855 In Org-mode, in special contexts, these same keys are used for
856 other purposes, important enough to compete with shift selection.
857 Org tries to balance these needs by supporting `shift-select-mode'
858 outside these special contexts, under control of this variable.
860 The default of this variable is nil, to avoid confusing behavior. Shifted
861 cursor keys will then execute Org commands in the following contexts:
862 - on a headline, changing TODO state (left/right) and priority (up/down)
863 - on a time stamp, changing the time
864 - in a plain list item, changing the bullet type
865 - in a property definition line, switching between allowed values
866 - in the BEGIN line of a clock table (changing the time block).
867 Outside these contexts, the commands will throw an error.
869 When this variable is t and the cursor is not in a special
870 context, Org-mode will support shift-selection for making and
871 enlarging regions. To make this more effective, the bullet
872 cycling will no longer happen anywhere in an item line, but only
873 if the cursor is exactly on the bullet.
875 If you set this variable to the symbol `always', then the keys
876 will not be special in headlines, property lines, and item lines,
877 to make shift selection work there as well. If this is what you
878 want, you can use the following alternative commands: `C-c C-t'
879 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
880 can be used to switch TODO sets, `C-c -' to cycle item bullet
881 types, and properties can be edited by hand or in column view.
883 However, when the cursor is on a timestamp, shift-cursor commands
884 will still edit the time stamp - this is just too good to give up.
886 XEmacs user should have this variable set to nil, because
887 `shift-select-mode' is in Emacs 23 or later only."
888 :group 'org
889 :type '(choice
890 (const :tag "Never" nil)
891 (const :tag "When outside special context" t)
892 (const :tag "Everywhere except timestamps" always)))
894 (defcustom org-loop-over-headlines-in-active-region nil
895 "Shall some commands act upon headlines in the active region?
897 When set to t, some commands will be performed in all headlines
898 within the active region.
900 When set to `start-level', some commands will be performed in all
901 headlines within the active region, provided that these headlines
902 are of the same level than the first one.
904 When set to a string, those commands will be performed on the
905 matching headlines within the active region. Such string must be
906 a tags/property/todo match as it is used in the agenda tags view.
908 The list of commands is: `org-schedule', `org-deadline',
909 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
910 `org-archive-to-archive-sibling'. The archiving commands skip
911 already archived entries."
912 :type '(choice (const :tag "Don't loop" nil)
913 (const :tag "All headlines in active region" t)
914 (const :tag "In active region, headlines at the same level than the first one" start-level)
915 (string :tag "Tags/Property/Todo matcher"))
916 :version "24.1"
917 :group 'org-todo
918 :group 'org-archive)
920 (defgroup org-startup nil
921 "Options concerning startup of Org-mode."
922 :tag "Org Startup"
923 :group 'org)
925 (defcustom org-startup-folded t
926 "Non-nil means entering Org-mode will switch to OVERVIEW.
927 This can also be configured on a per-file basis by adding one of
928 the following lines anywhere in the buffer:
930 #+STARTUP: fold (or `overview', this is equivalent)
931 #+STARTUP: nofold (or `showall', this is equivalent)
932 #+STARTUP: content
933 #+STARTUP: showeverything
935 By default, this option is ignored when Org opens agenda files
936 for the first time. If you want the agenda to honor the startup
937 option, set `org-agenda-inhibit-startup' to nil."
938 :group 'org-startup
939 :type '(choice
940 (const :tag "nofold: show all" nil)
941 (const :tag "fold: overview" t)
942 (const :tag "content: all headlines" content)
943 (const :tag "show everything, even drawers" showeverything)))
945 (defcustom org-startup-truncated t
946 "Non-nil means entering Org-mode will set `truncate-lines'.
947 This is useful since some lines containing links can be very long and
948 uninteresting. Also tables look terrible when wrapped."
949 :group 'org-startup
950 :type 'boolean)
952 (defcustom org-startup-indented nil
953 "Non-nil means turn on `org-indent-mode' on startup.
954 This can also be configured on a per-file basis by adding one of
955 the following lines anywhere in the buffer:
957 #+STARTUP: indent
958 #+STARTUP: noindent"
959 :group 'org-structure
960 :type '(choice
961 (const :tag "Not" nil)
962 (const :tag "Globally (slow on startup in large files)" t)))
964 (defcustom org-use-sub-superscripts t
965 "Non-nil means interpret \"_\" and \"^\" for display.
967 If you want to control how Org exports those characters, see
968 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
969 used to be an alias for `org-export-with-sub-superscripts' in
970 Org <8.0, it is not anymore.
972 When this option is turned on, you can use TeX-like syntax for
973 sub- and superscripts within the buffer. Several characters after
974 \"_\" or \"^\" will be considered as a single item - so grouping
975 with {} is normally not needed. For example, the following things
976 will be parsed as single sub- or superscripts:
978 10^24 or 10^tau several digits will be considered 1 item.
979 10^-12 or 10^-tau a leading sign with digits or a word
980 x^2-y^3 will be read as x^2 - y^3, because items are
981 terminated by almost any nonword/nondigit char.
982 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
984 Still, ambiguity is possible. So when in doubt, use {} to enclose
985 the sub/superscript. If you set this variable to the symbol `{}',
986 the braces are *required* in order to trigger interpretations as
987 sub/superscript. This can be helpful in documents that need \"_\"
988 frequently in plain text."
989 :group 'org-startup
990 :version "24.4"
991 :package-version '(Org . "8.0")
992 :type '(choice
993 (const :tag "Always interpret" t)
994 (const :tag "Only with braces" {})
995 (const :tag "Never interpret" nil)))
997 (defcustom org-startup-with-beamer-mode nil
998 "Non-nil means turn on `org-beamer-mode' on startup.
999 This can also be configured on a per-file basis by adding one of
1000 the following lines anywhere in the buffer:
1002 #+STARTUP: beamer"
1003 :group 'org-startup
1004 :version "24.1"
1005 :type 'boolean)
1007 (defcustom org-startup-align-all-tables nil
1008 "Non-nil means align all tables when visiting a file.
1009 This is useful when the column width in tables is forced with <N> cookies
1010 in table fields. Such tables will look correct only after the first re-align.
1011 This can also be configured on a per-file basis by adding one of
1012 the following lines anywhere in the buffer:
1013 #+STARTUP: align
1014 #+STARTUP: noalign"
1015 :group 'org-startup
1016 :type 'boolean)
1018 (defcustom org-startup-with-inline-images nil
1019 "Non-nil means show inline images when loading a new Org file.
1020 This can also be configured on a per-file basis by adding one of
1021 the following lines anywhere in the buffer:
1022 #+STARTUP: inlineimages
1023 #+STARTUP: noinlineimages"
1024 :group 'org-startup
1025 :version "24.1"
1026 :type 'boolean)
1028 (defcustom org-startup-with-latex-preview nil
1029 "Non-nil means preview LaTeX fragments when loading a new Org file.
1031 This can also be configured on a per-file basis by adding one of
1032 the following lines anywhere in the buffer:
1033 #+STARTUP: latexpreview
1034 #+STARTUP: nolatexpreview"
1035 :group 'org-startup
1036 :version "24.4"
1037 :package-version '(Org . "8.0")
1038 :type 'boolean)
1040 (defcustom org-insert-mode-line-in-empty-file nil
1041 "Non-nil means insert the first line setting Org-mode in empty files.
1042 When the function `org-mode' is called interactively in an empty file, this
1043 normally means that the file name does not automatically trigger Org-mode.
1044 To ensure that the file will always be in Org-mode in the future, a
1045 line enforcing Org-mode will be inserted into the buffer, if this option
1046 has been set."
1047 :group 'org-startup
1048 :type 'boolean)
1050 (defcustom org-replace-disputed-keys nil
1051 "Non-nil means use alternative key bindings for some keys.
1052 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1053 These keys are also used by other packages like shift-selection-mode'
1054 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1055 If you want to use Org-mode together with one of these other modes,
1056 or more generally if you would like to move some Org-mode commands to
1057 other keys, set this variable and configure the keys with the variable
1058 `org-disputed-keys'.
1060 This option is only relevant at load-time of Org-mode, and must be set
1061 *before* org.el is loaded. Changing it requires a restart of Emacs to
1062 become effective."
1063 :group 'org-startup
1064 :type 'boolean)
1066 (defcustom org-use-extra-keys nil
1067 "Non-nil means use extra key sequence definitions for certain commands.
1068 This happens automatically if you run XEmacs or if `window-system'
1069 is nil. This variable lets you do the same manually. You must
1070 set it before loading org.
1072 Example: on Carbon Emacs 22 running graphically, with an external
1073 keyboard on a Powerbook, the default way of setting M-left might
1074 not work for either Alt or ESC. Setting this variable will make
1075 it work for ESC."
1076 :group 'org-startup
1077 :type 'boolean)
1079 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1081 (defcustom org-disputed-keys
1082 '(([(shift up)] . [(meta p)])
1083 ([(shift down)] . [(meta n)])
1084 ([(shift left)] . [(meta -)])
1085 ([(shift right)] . [(meta +)])
1086 ([(control shift right)] . [(meta shift +)])
1087 ([(control shift left)] . [(meta shift -)]))
1088 "Keys for which Org-mode and other modes compete.
1089 This is an alist, cars are the default keys, second element specifies
1090 the alternative to use when `org-replace-disputed-keys' is t.
1092 Keys can be specified in any syntax supported by `define-key'.
1093 The value of this option takes effect only at Org-mode's startup,
1094 therefore you'll have to restart Emacs to apply it after changing."
1095 :group 'org-startup
1096 :type 'alist)
1098 (defun org-key (key)
1099 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1100 Or return the original if not disputed.
1101 Also apply the translations defined in `org-xemacs-key-equivalents'."
1102 (when org-replace-disputed-keys
1103 (let* ((nkey (key-description key))
1104 (x (org-find-if (lambda (x)
1105 (equal (key-description (car x)) nkey))
1106 org-disputed-keys)))
1107 (setq key (if x (cdr x) key))))
1108 (when (featurep 'xemacs)
1109 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1110 key)
1112 (defun org-find-if (predicate seq)
1113 (catch 'exit
1114 (while seq
1115 (if (funcall predicate (car seq))
1116 (throw 'exit (car seq))
1117 (pop seq)))))
1119 (defun org-defkey (keymap key def)
1120 "Define a key, possibly translated, as returned by `org-key'."
1121 (define-key keymap (org-key key) def))
1123 (defcustom org-ellipsis nil
1124 "The ellipsis to use in the Org-mode outline.
1125 When nil, just use the standard three dots.
1126 When a string, use that string instead.
1127 When a face, use the standard 3 dots, but with the specified face.
1128 The change affects only Org-mode (which will then use its own display table).
1129 Changing this requires executing \\[org-mode] in a buffer to become
1130 effective."
1131 :group 'org-startup
1132 :type '(choice (const :tag "Default" nil)
1133 (face :tag "Face" :value org-warning)
1134 (string :tag "String" :value "...#")))
1136 (defvar org-display-table nil
1137 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1139 (defgroup org-keywords nil
1140 "Keywords in Org-mode."
1141 :tag "Org Keywords"
1142 :group 'org)
1144 (defcustom org-closed-keep-when-no-todo nil
1145 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1146 :group 'org-todo
1147 :group 'org-keywords
1148 :version "24.4"
1149 :package-version '(Org . "8.0")
1150 :type 'boolean)
1152 (defgroup org-structure nil
1153 "Options concerning the general structure of Org-mode files."
1154 :tag "Org Structure"
1155 :group 'org)
1157 (defgroup org-reveal-location nil
1158 "Options about how to make context of a location visible."
1159 :tag "Org Reveal Location"
1160 :group 'org-structure)
1162 (defcustom org-show-context-detail '((isearch . lineage)
1163 (bookmark-jump . lineage)
1164 (default . ancestors))
1165 "Alist between context and visibility span when revealing a location.
1167 \\<org-mode-map>Some actions may move point into invisible
1168 locations. As a consequence, Org always expose a neighborhood
1169 around point. How much is shown depends on the initial action,
1170 or context. Valid contexts are
1172 agenda when exposing an entry from the agenda
1173 org-goto when using the command `org-goto' (\\[org-goto])
1174 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1175 tags-tree when constructing a sparse tree based on tags matches
1176 link-search when exposing search matches associated with a link
1177 mark-goto when exposing the jump goal of a mark
1178 bookmark-jump when exposing a bookmark location
1179 isearch when exiting from an incremental search
1180 default default for all contexts not set explicitly
1182 Allowed visibility spans are
1184 minimal show current headline; if point is not on headline,
1185 also show entry
1187 local show current headline, entry and next headline
1189 ancestors show current headline and its direct ancestors; if
1190 point is not on headline, also show entry
1192 lineage show current headline, its direct ancestors and all
1193 their children; if point is not on headline, also show
1194 entry and first child
1196 tree show current headline, its direct ancestors and all
1197 their children; if point is not on headline, also show
1198 entry and all children
1200 canonical show current headline, its direct ancestors along with
1201 their entries and children; if point is not located on
1202 the headline, also show current entry and all children
1204 As special cases, a nil or t value means show all contexts in
1205 `minimal' or `canonical' view, respectively.
1207 Some views can make displayed information very compact, but also
1208 make it harder to edit the location of the match. In such
1209 a case, use the command `org-reveal' (\\[org-reveal]) to show
1210 more context."
1211 :group 'org-reveal-location
1212 :version "25.1"
1213 :package-version '(Org . "8.3")
1214 :type '(choice
1215 (const :tag "Canonical" t)
1216 (const :tag "Minimal" nil)
1217 (repeat :greedy t :tag "Individual contexts"
1218 (cons
1219 (choice :tag "Context"
1220 (const agenda)
1221 (const org-goto)
1222 (const occur-tree)
1223 (const tags-tree)
1224 (const link-search)
1225 (const mark-goto)
1226 (const bookmark-jump)
1227 (const isearch)
1228 (const default))
1229 (choice :tag "Detail level"
1230 (const minimal)
1231 (const local)
1232 (const ancestors)
1233 (const lineage)
1234 (const tree)
1235 (const canonical))))))
1237 (defcustom org-indirect-buffer-display 'other-window
1238 "How should indirect tree buffers be displayed?
1239 This applies to indirect buffers created with the commands
1240 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1241 Valid values are:
1242 current-window Display in the current window
1243 other-window Just display in another window.
1244 dedicated-frame Create one new frame, and re-use it each time.
1245 new-frame Make a new frame each time. Note that in this case
1246 previously-made indirect buffers are kept, and you need to
1247 kill these buffers yourself."
1248 :group 'org-structure
1249 :group 'org-agenda-windows
1250 :type '(choice
1251 (const :tag "In current window" current-window)
1252 (const :tag "In current frame, other window" other-window)
1253 (const :tag "Each time a new frame" new-frame)
1254 (const :tag "One dedicated frame" dedicated-frame)))
1256 (defcustom org-use-speed-commands nil
1257 "Non-nil means activate single letter commands at beginning of a headline.
1258 This may also be a function to test for appropriate locations where speed
1259 commands should be active.
1261 For example, to activate speed commands when the point is on any
1262 star at the beginning of the headline, you can do this:
1264 (setq org-use-speed-commands
1265 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1266 :group 'org-structure
1267 :type '(choice
1268 (const :tag "Never" nil)
1269 (const :tag "At beginning of headline stars" t)
1270 (function)))
1272 (defcustom org-speed-commands-user nil
1273 "Alist of additional speed commands.
1274 This list will be checked before `org-speed-commands-default'
1275 when the variable `org-use-speed-commands' is non-nil
1276 and when the cursor is at the beginning of a headline.
1277 The car if each entry is a string with a single letter, which must
1278 be assigned to `self-insert-command' in the global map.
1279 The cdr is either a command to be called interactively, a function
1280 to be called, or a form to be evaluated.
1281 An entry that is just a list with a single string will be interpreted
1282 as a descriptive headline that will be added when listing the speed
1283 commands in the Help buffer using the `?' speed command."
1284 :group 'org-structure
1285 :type '(repeat :value ("k" . ignore)
1286 (choice :value ("k" . ignore)
1287 (list :tag "Descriptive Headline" (string :tag "Headline"))
1288 (cons :tag "Letter and Command"
1289 (string :tag "Command letter")
1290 (choice
1291 (function)
1292 (sexp))))))
1294 (defcustom org-bookmark-names-plist
1295 '(:last-capture "org-capture-last-stored"
1296 :last-refile "org-refile-last-stored"
1297 :last-capture-marker "org-capture-last-stored-marker")
1298 "Names for bookmarks automatically set by some Org commands.
1299 This can provide strings as names for a number of bookmarks Org sets
1300 automatically. The following keys are currently implemented:
1301 :last-capture
1302 :last-capture-marker
1303 :last-refile
1304 When a key does not show up in the property list, the corresponding bookmark
1305 is not set."
1306 :group 'org-structure
1307 :type 'plist)
1309 (defgroup org-cycle nil
1310 "Options concerning visibility cycling in Org-mode."
1311 :tag "Org Cycle"
1312 :group 'org-structure)
1314 (defcustom org-cycle-skip-children-state-if-no-children t
1315 "Non-nil means skip CHILDREN state in entries that don't have any."
1316 :group 'org-cycle
1317 :type 'boolean)
1319 (defcustom org-cycle-max-level nil
1320 "Maximum level which should still be subject to visibility cycling.
1321 Levels higher than this will, for cycling, be treated as text, not a headline.
1322 When `org-odd-levels-only' is set, a value of N in this variable actually
1323 means 2N-1 stars as the limiting headline.
1324 When nil, cycle all levels.
1325 Note that the limiting level of cycling is also influenced by
1326 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1327 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1328 than its value."
1329 :group 'org-cycle
1330 :type '(choice
1331 (const :tag "No limit" nil)
1332 (integer :tag "Maximum level")))
1334 (defcustom org-hide-block-startup nil
1335 "Non-nil means entering Org-mode will fold all blocks.
1336 This can also be set in on a per-file basis with
1338 #+STARTUP: hideblocks
1339 #+STARTUP: showblocks"
1340 :group 'org-startup
1341 :group 'org-cycle
1342 :type 'boolean)
1344 (defcustom org-cycle-global-at-bob nil
1345 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1346 This makes it possible to do global cycling without having to use S-TAB or
1347 \\[universal-argument] TAB. For this special case to work, the first line
1348 of the buffer must not be a headline -- it may be empty or some other text.
1349 When used in this way, `org-cycle-hook' is disabled temporarily to make
1350 sure the cursor stays at the beginning of the buffer. When this option is
1351 nil, don't do anything special at the beginning of the buffer."
1352 :group 'org-cycle
1353 :type 'boolean)
1355 (defcustom org-cycle-level-after-item/entry-creation t
1356 "Non-nil means cycle entry level or item indentation in new empty entries.
1358 When the cursor is at the end of an empty headline, i.e., with only stars
1359 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1360 and then all possible ancestor states, before returning to the original state.
1361 This makes data entry extremely fast: M-RET to create a new headline,
1362 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1364 When the cursor is at the end of an empty plain list item, one TAB will
1365 make it a subitem, two or more tabs will back up to make this an item
1366 higher up in the item hierarchy."
1367 :group 'org-cycle
1368 :type 'boolean)
1370 (defcustom org-cycle-emulate-tab t
1371 "Where should `org-cycle' emulate TAB.
1372 nil Never
1373 white Only in completely white lines
1374 whitestart Only at the beginning of lines, before the first non-white char
1375 t Everywhere except in headlines
1376 exc-hl-bol Everywhere except at the start of a headline
1377 If TAB is used in a place where it does not emulate TAB, the current subtree
1378 visibility is cycled."
1379 :group 'org-cycle
1380 :type '(choice (const :tag "Never" nil)
1381 (const :tag "Only in completely white lines" white)
1382 (const :tag "Before first char in a line" whitestart)
1383 (const :tag "Everywhere except in headlines" t)
1384 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1386 (defcustom org-cycle-separator-lines 2
1387 "Number of empty lines needed to keep an empty line between collapsed trees.
1388 If you leave an empty line between the end of a subtree and the following
1389 headline, this empty line is hidden when the subtree is folded.
1390 Org-mode will leave (exactly) one empty line visible if the number of
1391 empty lines is equal or larger to the number given in this variable.
1392 So the default 2 means at least 2 empty lines after the end of a subtree
1393 are needed to produce free space between a collapsed subtree and the
1394 following headline.
1396 If the number is negative, and the number of empty lines is at least -N,
1397 all empty lines are shown.
1399 Special case: when 0, never leave empty lines in collapsed view."
1400 :group 'org-cycle
1401 :type 'integer)
1402 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1404 (defcustom org-pre-cycle-hook nil
1405 "Hook that is run before visibility cycling is happening.
1406 The function(s) in this hook must accept a single argument which indicates
1407 the new state that will be set right after running this hook. The
1408 argument is a symbol. Before a global state change, it can have the values
1409 `overview', `content', or `all'. Before a local state change, it can have
1410 the values `folded', `children', or `subtree'."
1411 :group 'org-cycle
1412 :type 'hook)
1414 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1415 org-cycle-hide-drawers
1416 org-cycle-show-empty-lines
1417 org-optimize-window-after-visibility-change)
1418 "Hook that is run after `org-cycle' has changed the buffer visibility.
1419 The function(s) in this hook must accept a single argument which indicates
1420 the new state that was set by the most recent `org-cycle' command. The
1421 argument is a symbol. After a global state change, it can have the values
1422 `overview', `contents', or `all'. After a local state change, it can have
1423 the values `folded', `children', or `subtree'."
1424 :group 'org-cycle
1425 :type 'hook
1426 :version "25.1"
1427 :package-version '(Org . "8.3"))
1429 (defgroup org-edit-structure nil
1430 "Options concerning structure editing in Org-mode."
1431 :tag "Org Edit Structure"
1432 :group 'org-structure)
1434 (defcustom org-odd-levels-only nil
1435 "Non-nil means skip even levels and only use odd levels for the outline.
1436 This has the effect that two stars are being added/taken away in
1437 promotion/demotion commands. It also influences how levels are
1438 handled by the exporters.
1439 Changing it requires restart of `font-lock-mode' to become effective
1440 for fontification also in regions already fontified.
1441 You may also set this on a per-file basis by adding one of the following
1442 lines to the buffer:
1444 #+STARTUP: odd
1445 #+STARTUP: oddeven"
1446 :group 'org-edit-structure
1447 :group 'org-appearance
1448 :type 'boolean)
1450 (defcustom org-adapt-indentation t
1451 "Non-nil means adapt indentation to outline node level.
1453 When this variable is set, Org assumes that you write outlines by
1454 indenting text in each node to align with the headline (after the
1455 stars). The following issues are influenced by this variable:
1457 - The indentation is increased by one space in a demotion
1458 command, and decreased by one in a promotion command. However,
1459 in the latter case, if shifting some line in the entry body
1460 would alter document structure (e.g., insert a new headline),
1461 indentation is not changed at all.
1463 - Property drawers and planning information is inserted indented
1464 when this variable is set. When nil, they will not be indented.
1466 - TAB indents a line relative to current level. The lines below
1467 a headline will be indented when this variable is set.
1469 Note that this is all about true indentation, by adding and
1470 removing space characters. See also `org-indent.el' which does
1471 level-dependent indentation in a virtual way, i.e. at display
1472 time in Emacs."
1473 :group 'org-edit-structure
1474 :type 'boolean)
1476 (defcustom org-special-ctrl-a/e nil
1477 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1479 When t, `C-a' will bring back the cursor to the beginning of the
1480 headline text, i.e. after the stars and after a possible TODO
1481 keyword. In an item, this will be the position after bullet and
1482 check-box, if any. When the cursor is already at that position,
1483 another `C-a' will bring it to the beginning of the line.
1485 `C-e' will jump to the end of the headline, ignoring the presence
1486 of tags in the headline. A second `C-e' will then jump to the
1487 true end of the line, after any tags. This also means that, when
1488 this variable is non-nil, `C-e' also will never jump beyond the
1489 end of the heading of a folded section, i.e. not after the
1490 ellipses.
1492 When set to the symbol `reversed', the first `C-a' or `C-e' works
1493 normally, going to the true line boundary first. Only a directly
1494 following, identical keypress will bring the cursor to the
1495 special positions.
1497 This may also be a cons cell where the behavior for `C-a' and
1498 `C-e' is set separately."
1499 :group 'org-edit-structure
1500 :type '(choice
1501 (const :tag "off" nil)
1502 (const :tag "on: after stars/bullet and before tags first" t)
1503 (const :tag "reversed: true line boundary first" reversed)
1504 (cons :tag "Set C-a and C-e separately"
1505 (choice :tag "Special C-a"
1506 (const :tag "off" nil)
1507 (const :tag "on: after stars/bullet first" t)
1508 (const :tag "reversed: before stars/bullet first" reversed))
1509 (choice :tag "Special C-e"
1510 (const :tag "off" nil)
1511 (const :tag "on: before tags first" t)
1512 (const :tag "reversed: after tags first" reversed)))))
1513 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1515 (defcustom org-special-ctrl-k nil
1516 "Non-nil means `C-k' will behave specially in headlines.
1517 When nil, `C-k' will call the default `kill-line' command.
1518 When t, the following will happen while the cursor is in the headline:
1520 - When the cursor is at the beginning of a headline, kill the entire
1521 line and possible the folded subtree below the line.
1522 - When in the middle of the headline text, kill the headline up to the tags.
1523 - When after the headline text, kill the tags."
1524 :group 'org-edit-structure
1525 :type 'boolean)
1527 (defcustom org-ctrl-k-protect-subtree nil
1528 "Non-nil means, do not delete a hidden subtree with C-k.
1529 When set to the symbol `error', simply throw an error when C-k is
1530 used to kill (part-of) a headline that has hidden text behind it.
1531 Any other non-nil value will result in a query to the user, if it is
1532 OK to kill that hidden subtree. When nil, kill without remorse."
1533 :group 'org-edit-structure
1534 :version "24.1"
1535 :type '(choice
1536 (const :tag "Do not protect hidden subtrees" nil)
1537 (const :tag "Protect hidden subtrees with a security query" t)
1538 (const :tag "Never kill a hidden subtree with C-k" error)))
1540 (defcustom org-special-ctrl-o t
1541 "Non-nil means, make `C-o' insert a row in tables."
1542 :group 'org-edit-structure
1543 :type 'boolean)
1545 (defcustom org-catch-invisible-edits nil
1546 "Check if in invisible region before inserting or deleting a character.
1547 Valid values are:
1549 nil Do not check, so just do invisible edits.
1550 error Throw an error and do nothing.
1551 show Make point visible, and do the requested edit.
1552 show-and-error Make point visible, then throw an error and abort the edit.
1553 smart Make point visible, and do insertion/deletion if it is
1554 adjacent to visible text and the change feels predictable.
1555 Never delete a previously invisible character or add in the
1556 middle or right after an invisible region. Basically, this
1557 allows insertion and backward-delete right before ellipses.
1558 FIXME: maybe in this case we should not even show?"
1559 :group 'org-edit-structure
1560 :version "24.1"
1561 :type '(choice
1562 (const :tag "Do not check" nil)
1563 (const :tag "Throw error when trying to edit" error)
1564 (const :tag "Unhide, but do not do the edit" show-and-error)
1565 (const :tag "Show invisible part and do the edit" show)
1566 (const :tag "Be smart and do the right thing" smart)))
1568 (defcustom org-yank-folded-subtrees t
1569 "Non-nil means when yanking subtrees, fold them.
1570 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1571 it starts with a heading and all other headings in it are either children
1572 or siblings, then fold all the subtrees. However, do this only if no
1573 text after the yank would be swallowed into a folded tree by this action."
1574 :group 'org-edit-structure
1575 :type 'boolean)
1577 (defcustom org-yank-adjusted-subtrees nil
1578 "Non-nil means when yanking subtrees, adjust the level.
1579 With this setting, `org-paste-subtree' is used to insert the subtree, see
1580 this function for details."
1581 :group 'org-edit-structure
1582 :type 'boolean)
1584 (defcustom org-M-RET-may-split-line '((default . t))
1585 "Non-nil means M-RET will split the line at the cursor position.
1586 When nil, it will go to the end of the line before making a
1587 new line.
1588 You may also set this option in a different way for different
1589 contexts. Valid contexts are:
1591 headline when creating a new headline
1592 item when creating a new item
1593 table in a table field
1594 default the value to be used for all contexts not explicitly
1595 customized"
1596 :group 'org-structure
1597 :group 'org-table
1598 :type '(choice
1599 (const :tag "Always" t)
1600 (const :tag "Never" nil)
1601 (repeat :greedy t :tag "Individual contexts"
1602 (cons
1603 (choice :tag "Context"
1604 (const headline)
1605 (const item)
1606 (const table)
1607 (const default))
1608 (boolean)))))
1611 (defcustom org-insert-heading-respect-content nil
1612 "Non-nil means insert new headings after the current subtree.
1613 When nil, the new heading is created directly after the current line.
1614 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1615 this variable on for the duration of the command."
1616 :group 'org-structure
1617 :type 'boolean)
1619 (defcustom org-blank-before-new-entry '((heading . auto)
1620 (plain-list-item . auto))
1621 "Should `org-insert-heading' leave a blank line before new heading/item?
1622 The value is an alist, with `heading' and `plain-list-item' as CAR,
1623 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1624 which case Org will look at the surrounding headings/items and try to
1625 make an intelligent decision whether to insert a blank line or not.
1627 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1628 the setting here is ignored and no empty line is inserted to avoid breaking
1629 the list structure."
1630 :group 'org-edit-structure
1631 :type '(list
1632 (cons (const heading)
1633 (choice (const :tag "Never" nil)
1634 (const :tag "Always" t)
1635 (const :tag "Auto" auto)))
1636 (cons (const plain-list-item)
1637 (choice (const :tag "Never" nil)
1638 (const :tag "Always" t)
1639 (const :tag "Auto" auto)))))
1641 (defcustom org-insert-heading-hook nil
1642 "Hook being run after inserting a new heading."
1643 :group 'org-edit-structure
1644 :type 'hook)
1646 (defcustom org-enable-fixed-width-editor t
1647 "Non-nil means lines starting with \":\" are treated as fixed-width.
1648 This currently only means they are never auto-wrapped.
1649 When nil, such lines will be treated like ordinary lines."
1650 :group 'org-edit-structure
1651 :type 'boolean)
1653 (defcustom org-goto-auto-isearch t
1654 "Non-nil means typing characters in `org-goto' starts incremental search.
1655 When nil, you can use these keybindings to navigate the buffer:
1657 q Quit the org-goto interface
1658 n Go to the next visible heading
1659 p Go to the previous visible heading
1660 f Go one heading forward on same level
1661 b Go one heading backward on same level
1662 u Go one heading up"
1663 :group 'org-edit-structure
1664 :type 'boolean)
1666 (defgroup org-sparse-trees nil
1667 "Options concerning sparse trees in Org-mode."
1668 :tag "Org Sparse Trees"
1669 :group 'org-structure)
1671 (defcustom org-highlight-sparse-tree-matches t
1672 "Non-nil means highlight all matches that define a sparse tree.
1673 The highlights will automatically disappear the next time the buffer is
1674 changed by an edit command."
1675 :group 'org-sparse-trees
1676 :type 'boolean)
1678 (defcustom org-remove-highlights-with-change t
1679 "Non-nil means any change to the buffer will remove temporary highlights.
1680 Such highlights are created by `org-occur' and `org-clock-display'.
1681 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1682 The highlights created by `org-toggle-latex-fragment' always need
1683 `C-c C-x C-l' to be removed."
1684 :group 'org-sparse-trees
1685 :group 'org-time
1686 :type 'boolean)
1689 (defcustom org-occur-hook '(org-first-headline-recenter)
1690 "Hook that is run after `org-occur' has constructed a sparse tree.
1691 This can be used to recenter the window to show as much of the structure
1692 as possible."
1693 :group 'org-sparse-trees
1694 :type 'hook)
1696 (defgroup org-imenu-and-speedbar nil
1697 "Options concerning imenu and speedbar in Org-mode."
1698 :tag "Org Imenu and Speedbar"
1699 :group 'org-structure)
1701 (defcustom org-imenu-depth 2
1702 "The maximum level for Imenu access to Org-mode headlines.
1703 This also applied for speedbar access."
1704 :group 'org-imenu-and-speedbar
1705 :type 'integer)
1707 (defgroup org-table nil
1708 "Options concerning tables in Org-mode."
1709 :tag "Org Table"
1710 :group 'org)
1712 (defcustom org-enable-table-editor 'optimized
1713 "Non-nil means lines starting with \"|\" are handled by the table editor.
1714 When nil, such lines will be treated like ordinary lines.
1716 When equal to the symbol `optimized', the table editor will be optimized to
1717 do the following:
1718 - Automatic overwrite mode in front of whitespace in table fields.
1719 This makes the structure of the table stay in tact as long as the edited
1720 field does not exceed the column width.
1721 - Minimize the number of realigns. Normally, the table is aligned each time
1722 TAB or RET are pressed to move to another field. With optimization this
1723 happens only if changes to a field might have changed the column width.
1724 Optimization requires replacing the functions `self-insert-command',
1725 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1726 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1727 very good at guessing when a re-align will be necessary, but you can always
1728 force one with \\[org-ctrl-c-ctrl-c].
1730 If you would like to use the optimized version in Org-mode, but the
1731 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1733 This variable can be used to turn on and off the table editor during a session,
1734 but in order to toggle optimization, a restart is required.
1736 See also the variable `org-table-auto-blank-field'."
1737 :group 'org-table
1738 :type '(choice
1739 (const :tag "off" nil)
1740 (const :tag "on" t)
1741 (const :tag "on, optimized" optimized)))
1743 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1744 (version<= emacs-version "24.1"))
1745 "Non-nil means cluster self-insert commands for undo when possible.
1746 If this is set, then, like in the Emacs command loop, 20 consecutive
1747 characters will be undone together.
1748 This is configurable, because there is some impact on typing performance."
1749 :group 'org-table
1750 :type 'boolean)
1752 (defcustom org-table-tab-recognizes-table.el t
1753 "Non-nil means TAB will automatically notice a table.el table.
1754 When it sees such a table, it moves point into it and - if necessary -
1755 calls `table-recognize-table'."
1756 :group 'org-table-editing
1757 :type 'boolean)
1759 (defgroup org-link nil
1760 "Options concerning links in Org-mode."
1761 :tag "Org Link"
1762 :group 'org)
1764 (defvar org-link-abbrev-alist-local nil
1765 "Buffer-local version of `org-link-abbrev-alist', which see.
1766 The value of this is taken from the #+LINK lines.")
1767 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1769 (defcustom org-link-abbrev-alist nil
1770 "Alist of link abbreviations.
1771 The car of each element is a string, to be replaced at the start of a link.
1772 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1773 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1775 [[linkkey:tag][description]]
1777 The 'linkkey' must be a word word, starting with a letter, followed
1778 by letters, numbers, '-' or '_'.
1780 If REPLACE is a string, the tag will simply be appended to create the link.
1781 If the string contains \"%s\", the tag will be inserted there. If the string
1782 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1783 at that point (see the function `url-hexify-string'). If the string contains
1784 the specifier \"%(my-function)\", then the custom function `my-function' will
1785 be invoked: this function takes the tag as its only argument and must return
1786 a string.
1788 REPLACE may also be a function that will be called with the tag as the
1789 only argument to create the link, which should be returned as a string.
1791 See the manual for examples."
1792 :group 'org-link
1793 :type '(repeat
1794 (cons
1795 (string :tag "Protocol")
1796 (choice
1797 (string :tag "Format")
1798 (function)))))
1800 (defcustom org-descriptive-links t
1801 "Non-nil means Org will display descriptive links.
1802 E.g. [[http://orgmode.org][Org website]] will be displayed as
1803 \"Org Website\", hiding the link itself and just displaying its
1804 description. When set to nil, Org will display the full links
1805 literally.
1807 You can interactively set the value of this variable by calling
1808 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1809 :group 'org-link
1810 :type 'boolean)
1812 (defcustom org-link-file-path-type 'adaptive
1813 "How the path name in file links should be stored.
1814 Valid values are:
1816 relative Relative to the current directory, i.e. the directory of the file
1817 into which the link is being inserted.
1818 absolute Absolute path, if possible with ~ for home directory.
1819 noabbrev Absolute path, no abbreviation of home directory.
1820 adaptive Use relative path for files in the current directory and sub-
1821 directories of it. For other files, use an absolute path."
1822 :group 'org-link
1823 :type '(choice
1824 (const relative)
1825 (const absolute)
1826 (const noabbrev)
1827 (const adaptive)))
1829 (defvaralias 'org-activate-links 'org-highlight-links)
1830 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1831 "Types of links that should be highlighted in Org-mode files.
1833 This is a list of symbols, each one of them leading to the
1834 highlighting of a certain link type.
1836 You can still open links that are not highlighted.
1838 In principle, it does not hurt to turn on highlighting for all
1839 link types. There may be a small gain when turning off unused
1840 link types. The types are:
1842 bracket The recommended [[link][description]] or [[link]] links with hiding.
1843 angle Links in angular brackets that may contain whitespace like
1844 <bbdb:Carsten Dominik>.
1845 plain Plain links in normal text, no whitespace, like http://google.com.
1846 radio Text that is matched by a radio target, see manual for details.
1847 tag Tag settings in a headline (link to tag search).
1848 date Time stamps (link to calendar).
1849 footnote Footnote labels.
1851 If you set this variable during an Emacs session, use `org-mode-restart'
1852 in the Org buffer so that the change takes effect."
1853 :group 'org-link
1854 :group 'org-appearance
1855 :type '(set :greedy t
1856 (const :tag "Double bracket links" bracket)
1857 (const :tag "Angular bracket links" angle)
1858 (const :tag "Plain text links" plain)
1859 (const :tag "Radio target matches" radio)
1860 (const :tag "Tags" tag)
1861 (const :tag "Timestamps" date)
1862 (const :tag "Footnotes" footnote)))
1864 (defcustom org-make-link-description-function nil
1865 "Function to use for generating link descriptions from links.
1866 When nil, the link location will be used. This function must take
1867 two parameters: the first one is the link, the second one is the
1868 description generated by `org-insert-link'. The function should
1869 return the description to use."
1870 :group 'org-link
1871 :type '(choice (const nil) (function)))
1873 (defgroup org-link-store nil
1874 "Options concerning storing links in Org-mode."
1875 :tag "Org Store Link"
1876 :group 'org-link)
1878 (defcustom org-url-hexify-p t
1879 "When non-nil, hexify URL when creating a link."
1880 :type 'boolean
1881 :version "24.3"
1882 :group 'org-link-store)
1884 (defcustom org-email-link-description-format "Email %c: %.30s"
1885 "Format of the description part of a link to an email or usenet message.
1886 The following %-escapes will be replaced by corresponding information:
1888 %F full \"From\" field
1889 %f name, taken from \"From\" field, address if no name
1890 %T full \"To\" field
1891 %t first name in \"To\" field, address if no name
1892 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1893 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1894 %s subject
1895 %d date
1896 %m message-id.
1898 You may use normal field width specification between the % and the letter.
1899 This is for example useful to limit the length of the subject.
1901 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1902 :group 'org-link-store
1903 :type 'string)
1905 (defcustom org-from-is-user-regexp
1906 (let (r1 r2)
1907 (when (and user-mail-address (not (string= user-mail-address "")))
1908 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1909 (when (and user-full-name (not (string= user-full-name "")))
1910 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1911 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1912 "Regexp matched against the \"From:\" header of an email or usenet message.
1913 It should match if the message is from the user him/herself."
1914 :group 'org-link-store
1915 :type 'regexp)
1917 (defcustom org-context-in-file-links t
1918 "Non-nil means file links from `org-store-link' contain context.
1919 A search string will be added to the file name with :: as separator and
1920 used to find the context when the link is activated by the command
1921 `org-open-at-point'. When this option is t, the entire active region
1922 will be placed in the search string of the file link. If set to a
1923 positive integer, only the first n lines of context will be stored.
1925 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1926 negates this setting for the duration of the command."
1927 :group 'org-link-store
1928 :type '(choice boolean integer))
1930 (defcustom org-keep-stored-link-after-insertion nil
1931 "Non-nil means keep link in list for entire session.
1933 The command `org-store-link' adds a link pointing to the current
1934 location to an internal list. These links accumulate during a session.
1935 The command `org-insert-link' can be used to insert links into any
1936 Org-mode file (offering completion for all stored links). When this
1937 option is nil, every link which has been inserted once using \\[org-insert-link]
1938 will be removed from the list, to make completing the unused links
1939 more efficient."
1940 :group 'org-link-store
1941 :type 'boolean)
1943 (defgroup org-link-follow nil
1944 "Options concerning following links in Org-mode."
1945 :tag "Org Follow Link"
1946 :group 'org-link)
1948 (defcustom org-link-translation-function nil
1949 "Function to translate links with different syntax to Org syntax.
1950 This can be used to translate links created for example by the Planner
1951 or emacs-wiki packages to Org syntax.
1952 The function must accept two parameters, a TYPE containing the link
1953 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1954 which is everything after the link protocol. It should return a cons
1955 with possibly modified values of type and path.
1956 Org contains a function for this, so if you set this variable to
1957 `org-translate-link-from-planner', you should be able follow many
1958 links created by planner."
1959 :group 'org-link-follow
1960 :type '(choice (const nil) (function)))
1962 (defcustom org-follow-link-hook nil
1963 "Hook that is run after a link has been followed."
1964 :group 'org-link-follow
1965 :type 'hook)
1967 (defcustom org-tab-follows-link nil
1968 "Non-nil means on links TAB will follow the link.
1969 Needs to be set before org.el is loaded.
1970 This really should not be used, it does not make sense, and the
1971 implementation is bad."
1972 :group 'org-link-follow
1973 :type 'boolean)
1975 (defcustom org-return-follows-link nil
1976 "Non-nil means on links RET will follow the link.
1977 In tables, the special behavior of RET has precedence."
1978 :group 'org-link-follow
1979 :type 'boolean)
1981 (defcustom org-mouse-1-follows-link
1982 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1983 "Non-nil means mouse-1 on a link will follow the link.
1984 A longer mouse click will still set point. Does not work on XEmacs.
1985 Needs to be set before org.el is loaded."
1986 :group 'org-link-follow
1987 :version "24.4"
1988 :package-version '(Org . "8.3")
1989 :type '(choice
1990 (const :tag "A double click follows the link" double)
1991 (const :tag "Unconditionally follow the link with mouse-1" t)
1992 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1994 (defcustom org-mark-ring-length 4
1995 "Number of different positions to be recorded in the ring.
1996 Changing this requires a restart of Emacs to work correctly."
1997 :group 'org-link-follow
1998 :type 'integer)
2000 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2001 "Non-nil means internal links in Org files must exactly match a headline.
2002 When nil, the link search tries to match a phrase with all words
2003 in the search text."
2004 :group 'org-link-follow
2005 :version "24.1"
2006 :type '(choice
2007 (const :tag "Use fuzzy text search" nil)
2008 (const :tag "Match only exact headline" t)
2009 (const :tag "Match exact headline or query to create it"
2010 query-to-create)))
2012 (defcustom org-link-frame-setup
2013 '((vm . vm-visit-folder-other-frame)
2014 (vm-imap . vm-visit-imap-folder-other-frame)
2015 (gnus . org-gnus-no-new-news)
2016 (file . find-file-other-window)
2017 (wl . wl-other-frame))
2018 "Setup the frame configuration for following links.
2019 When following a link with Emacs, it may often be useful to display
2020 this link in another window or frame. This variable can be used to
2021 set this up for the different types of links.
2022 For VM, use any of
2023 `vm-visit-folder'
2024 `vm-visit-folder-other-window'
2025 `vm-visit-folder-other-frame'
2026 For Gnus, use any of
2027 `gnus'
2028 `gnus-other-frame'
2029 `org-gnus-no-new-news'
2030 For FILE, use any of
2031 `find-file'
2032 `find-file-other-window'
2033 `find-file-other-frame'
2034 For Wanderlust use any of
2035 `wl'
2036 `wl-other-frame'
2037 For the calendar, use the variable `calendar-setup'.
2038 For BBDB, it is currently only possible to display the matches in
2039 another window."
2040 :group 'org-link-follow
2041 :type '(list
2042 (cons (const vm)
2043 (choice
2044 (const vm-visit-folder)
2045 (const vm-visit-folder-other-window)
2046 (const vm-visit-folder-other-frame)))
2047 (cons (const vm-imap)
2048 (choice
2049 (const vm-visit-imap-folder)
2050 (const vm-visit-imap-folder-other-window)
2051 (const vm-visit-imap-folder-other-frame)))
2052 (cons (const gnus)
2053 (choice
2054 (const gnus)
2055 (const gnus-other-frame)
2056 (const org-gnus-no-new-news)))
2057 (cons (const file)
2058 (choice
2059 (const find-file)
2060 (const find-file-other-window)
2061 (const find-file-other-frame)))
2062 (cons (const wl)
2063 (choice
2064 (const wl)
2065 (const wl-other-frame)))))
2067 (defcustom org-display-internal-link-with-indirect-buffer nil
2068 "Non-nil means use indirect buffer to display infile links.
2069 Activating internal links (from one location in a file to another location
2070 in the same file) normally just jumps to the location. When the link is
2071 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2072 is displayed in
2073 another window. When this option is set, the other window actually displays
2074 an indirect buffer clone of the current buffer, to avoid any visibility
2075 changes to the current buffer."
2076 :group 'org-link-follow
2077 :type 'boolean)
2079 (defcustom org-open-non-existing-files nil
2080 "Non-nil means `org-open-file' will open non-existing files.
2081 When nil, an error will be generated.
2082 This variable applies only to external applications because they
2083 might choke on non-existing files. If the link is to a file that
2084 will be opened in Emacs, the variable is ignored."
2085 :group 'org-link-follow
2086 :type 'boolean)
2088 (defcustom org-open-directory-means-index-dot-org nil
2089 "Non-nil means a link to a directory really means to index.org.
2090 When nil, following a directory link will run dired or open a finder/explorer
2091 window on that directory."
2092 :group 'org-link-follow
2093 :type 'boolean)
2095 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2096 "Non-nil means ask for confirmation before executing shell links.
2097 Shell links can be dangerous: just think about a link
2099 [[shell:rm -rf ~/*][Google Search]]
2101 This link would show up in your Org-mode document as \"Google Search\",
2102 but really it would remove your entire home directory.
2103 Therefore we advise against setting this variable to nil.
2104 Just change it to `y-or-n-p' if you want to confirm with a
2105 single keystroke rather than having to type \"yes\"."
2106 :group 'org-link-follow
2107 :type '(choice
2108 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2109 (const :tag "with y-or-n (faster)" y-or-n-p)
2110 (const :tag "no confirmation (dangerous)" nil)))
2111 (put 'org-confirm-shell-link-function
2112 'safe-local-variable
2113 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2115 (defcustom org-confirm-shell-link-not-regexp ""
2116 "A regexp to skip confirmation for shell links."
2117 :group 'org-link-follow
2118 :version "24.1"
2119 :type 'regexp)
2121 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2122 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2123 Elisp links can be dangerous: just think about a link
2125 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2127 This link would show up in your Org-mode document as \"Google Search\",
2128 but really it would remove your entire home directory.
2129 Therefore we advise against setting this variable to nil.
2130 Just change it to `y-or-n-p' if you want to confirm with a
2131 single keystroke rather than having to type \"yes\"."
2132 :group 'org-link-follow
2133 :type '(choice
2134 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2135 (const :tag "with y-or-n (faster)" y-or-n-p)
2136 (const :tag "no confirmation (dangerous)" nil)))
2137 (put 'org-confirm-shell-link-function
2138 'safe-local-variable
2139 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2141 (defcustom org-confirm-elisp-link-not-regexp ""
2142 "A regexp to skip confirmation for Elisp links."
2143 :group 'org-link-follow
2144 :version "24.1"
2145 :type 'regexp)
2147 (defconst org-file-apps-defaults-gnu
2148 '((remote . emacs)
2149 (system . mailcap)
2150 (t . mailcap))
2151 "Default file applications on a UNIX or GNU/Linux system.
2152 See `org-file-apps'.")
2154 (defconst org-file-apps-defaults-macosx
2155 '((remote . emacs)
2156 (t . "open %s")
2157 (system . "open %s")
2158 ("ps.gz" . "gv %s")
2159 ("eps.gz" . "gv %s")
2160 ("dvi" . "xdvi %s")
2161 ("fig" . "xfig %s"))
2162 "Default file applications on a MacOS X system.
2163 The system \"open\" is known as a default, but we use X11 applications
2164 for some files for which the OS does not have a good default.
2165 See `org-file-apps'.")
2167 (defconst org-file-apps-defaults-windowsnt
2168 (list
2169 '(remote . emacs)
2170 (cons t
2171 (list (if (featurep 'xemacs)
2172 'mswindows-shell-execute
2173 'w32-shell-execute)
2174 "open" 'file))
2175 (cons 'system
2176 (list (if (featurep 'xemacs)
2177 'mswindows-shell-execute
2178 'w32-shell-execute)
2179 "open" 'file)))
2180 "Default file applications on a Windows NT system.
2181 The system \"open\" is used for most files.
2182 See `org-file-apps'.")
2184 (defcustom org-file-apps
2185 '((auto-mode . emacs)
2186 ("\\.mm\\'" . default)
2187 ("\\.x?html?\\'" . default)
2188 ("\\.pdf\\'" . default))
2189 "External applications for opening `file:path' items in a document.
2190 Org-mode uses system defaults for different file types, but
2191 you can use this variable to set the application for a given file
2192 extension. The entries in this list are cons cells where the car identifies
2193 files and the cdr the corresponding command. Possible values for the
2194 file identifier are
2195 \"string\" A string as a file identifier can be interpreted in different
2196 ways, depending on its contents:
2198 - Alphanumeric characters only:
2199 Match links with this file extension.
2200 Example: (\"pdf\" . \"evince %s\")
2201 to open PDFs with evince.
2203 - Regular expression: Match links where the
2204 filename matches the regexp. If you want to
2205 use groups here, use shy groups.
2207 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2208 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2209 to open *.html and *.xhtml with firefox.
2211 - Regular expression which contains (non-shy) groups:
2212 Match links where the whole link, including \"::\", and
2213 anything after that, matches the regexp.
2214 In a custom command string, %1, %2, etc. are replaced with
2215 the parts of the link that were matched by the groups.
2216 For backwards compatibility, if a command string is given
2217 that does not use any of the group matches, this case is
2218 handled identically to the second one (i.e. match against
2219 file name only).
2220 In a custom lisp form, you can access the group matches with
2221 (match-string n link).
2223 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2224 to open [[file:document.pdf::5]] with evince at page 5.
2226 `directory' Matches a directory
2227 `remote' Matches a remote file, accessible through tramp or efs.
2228 Remote files most likely should be visited through Emacs
2229 because external applications cannot handle such paths.
2230 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2231 so all files Emacs knows how to handle. Using this with
2232 command `emacs' will open most files in Emacs. Beware that this
2233 will also open html files inside Emacs, unless you add
2234 (\"html\" . default) to the list as well.
2235 t Default for files not matched by any of the other options.
2236 `system' The system command to open files, like `open' on Windows
2237 and Mac OS X, and mailcap under GNU/Linux. This is the command
2238 that will be selected if you call `C-c C-o' with a double
2239 \\[universal-argument] \\[universal-argument] prefix.
2241 Possible values for the command are:
2242 `emacs' The file will be visited by the current Emacs process.
2243 `default' Use the default application for this file type, which is the
2244 association for t in the list, most likely in the system-specific
2245 part.
2246 This can be used to overrule an unwanted setting in the
2247 system-specific variable.
2248 `system' Use the system command for opening files, like \"open\".
2249 This command is specified by the entry whose car is `system'.
2250 Most likely, the system-specific version of this variable
2251 does define this command, but you can overrule/replace it
2252 here.
2253 string A command to be executed by a shell; %s will be replaced
2254 by the path to the file.
2255 sexp A Lisp form which will be evaluated. The file path will
2256 be available in the Lisp variable `file'.
2257 For more examples, see the system specific constants
2258 `org-file-apps-defaults-macosx'
2259 `org-file-apps-defaults-windowsnt'
2260 `org-file-apps-defaults-gnu'."
2261 :group 'org-link-follow
2262 :type '(repeat
2263 (cons (choice :value ""
2264 (string :tag "Extension")
2265 (const :tag "System command to open files" system)
2266 (const :tag "Default for unrecognized files" t)
2267 (const :tag "Remote file" remote)
2268 (const :tag "Links to a directory" directory)
2269 (const :tag "Any files that have Emacs modes"
2270 auto-mode))
2271 (choice :value ""
2272 (const :tag "Visit with Emacs" emacs)
2273 (const :tag "Use default" default)
2274 (const :tag "Use the system command" system)
2275 (string :tag "Command")
2276 (sexp :tag "Lisp form")))))
2278 (defcustom org-doi-server-url "http://dx.doi.org/"
2279 "The URL of the DOI server."
2280 :type 'string
2281 :version "24.3"
2282 :group 'org-link-follow)
2284 (defgroup org-refile nil
2285 "Options concerning refiling entries in Org-mode."
2286 :tag "Org Refile"
2287 :group 'org)
2289 (defcustom org-directory "~/org"
2290 "Directory with org files.
2291 This is just a default location to look for Org files. There is no need
2292 at all to put your files into this directory. It is only used in the
2293 following situations:
2295 1. When a capture template specifies a target file that is not an
2296 absolute path. The path will then be interpreted relative to
2297 `org-directory'
2298 2. When a capture note is filed away in an interactive way (when exiting the
2299 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2300 with `org-directory' as the default path."
2301 :group 'org-refile
2302 :group 'org-capture
2303 :type 'directory)
2305 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2306 "Default target for storing notes.
2307 Used as a fall back file for org-capture.el, for templates that
2308 do not specify a target file."
2309 :group 'org-refile
2310 :group 'org-capture
2311 :type 'file)
2313 (defcustom org-goto-interface 'outline
2314 "The default interface to be used for `org-goto'.
2315 Allowed values are:
2316 outline The interface shows an outline of the relevant file
2317 and the correct heading is found by moving through
2318 the outline or by searching with incremental search.
2319 outline-path-completion Headlines in the current buffer are offered via
2320 completion. This is the interface also used by
2321 the refile command."
2322 :group 'org-refile
2323 :type '(choice
2324 (const :tag "Outline" outline)
2325 (const :tag "Outline-path-completion" outline-path-completion)))
2327 (defcustom org-goto-max-level 5
2328 "Maximum target level when running `org-goto' with refile interface."
2329 :group 'org-refile
2330 :type 'integer)
2332 (defcustom org-reverse-note-order nil
2333 "Non-nil means store new notes at the beginning of a file or entry.
2334 When nil, new notes will be filed to the end of a file or entry.
2335 This can also be a list with cons cells of regular expressions that
2336 are matched against file names, and values."
2337 :group 'org-capture
2338 :group 'org-refile
2339 :type '(choice
2340 (const :tag "Reverse always" t)
2341 (const :tag "Reverse never" nil)
2342 (repeat :tag "By file name regexp"
2343 (cons regexp boolean))))
2345 (defcustom org-log-refile nil
2346 "Information to record when a task is refiled.
2348 Possible values are:
2350 nil Don't add anything
2351 time Add a time stamp to the task
2352 note Prompt for a note and add it with template `org-log-note-headings'
2354 This option can also be set with on a per-file-basis with
2356 #+STARTUP: nologrefile
2357 #+STARTUP: logrefile
2358 #+STARTUP: lognoterefile
2360 You can have local logging settings for a subtree by setting the LOGGING
2361 property to one or more of these keywords.
2363 When bulk-refiling from the agenda, the value `note' is forbidden and
2364 will temporarily be changed to `time'."
2365 :group 'org-refile
2366 :group 'org-progress
2367 :version "24.1"
2368 :type '(choice
2369 (const :tag "No logging" nil)
2370 (const :tag "Record timestamp" time)
2371 (const :tag "Record timestamp with note." note)))
2373 (defcustom org-refile-targets nil
2374 "Targets for refiling entries with \\[org-refile].
2375 This is a list of cons cells. Each cell contains:
2376 - a specification of the files to be considered, either a list of files,
2377 or a symbol whose function or variable value will be used to retrieve
2378 a file name or a list of file names. If you use `org-agenda-files' for
2379 that, all agenda files will be scanned for targets. Nil means consider
2380 headings in the current buffer.
2381 - A specification of how to find candidate refile targets. This may be
2382 any of:
2383 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2384 This tag has to be present in all target headlines, inheritance will
2385 not be considered.
2386 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2387 todo keyword.
2388 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2389 headlines that are refiling targets.
2390 - a cons cell (:level . N). Any headline of level N is considered a target.
2391 Note that, when `org-odd-levels-only' is set, level corresponds to
2392 order in hierarchy, not to the number of stars.
2393 - a cons cell (:maxlevel . N). Any headline with level <= N is 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.
2397 Each element of this list generates a set of possible targets.
2398 The union of these sets is presented (with completion) to
2399 the user by `org-refile'.
2401 You can set the variable `org-refile-target-verify-function' to a function
2402 to verify each headline found by the simple criteria above.
2404 When this variable is nil, all top-level headlines in the current buffer
2405 are used, equivalent to the value `((nil . (:level . 1))'."
2406 :group 'org-refile
2407 :type '(repeat
2408 (cons
2409 (choice :value org-agenda-files
2410 (const :tag "All agenda files" org-agenda-files)
2411 (const :tag "Current buffer" nil)
2412 (function) (variable) (file))
2413 (choice :tag "Identify target headline by"
2414 (cons :tag "Specific tag" (const :value :tag) (string))
2415 (cons :tag "TODO keyword" (const :value :todo) (string))
2416 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2417 (cons :tag "Level number" (const :value :level) (integer))
2418 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2420 (defcustom org-refile-target-verify-function nil
2421 "Function to verify if the headline at point should be a refile target.
2422 The function will be called without arguments, with point at the
2423 beginning of the headline. It should return t and leave point
2424 where it is if the headline is a valid target for refiling.
2426 If the target should not be selected, the function must return nil.
2427 In addition to this, it may move point to a place from where the search
2428 should be continued. For example, the function may decide that the entire
2429 subtree of the current entry should be excluded and move point to the end
2430 of the subtree."
2431 :group 'org-refile
2432 :type '(choice
2433 (const nil)
2434 (function)))
2436 (defcustom org-refile-use-cache nil
2437 "Non-nil means cache refile targets to speed up the process.
2438 The cache for a particular file will be updated automatically when
2439 the buffer has been killed, or when any of the marker used for flagging
2440 refile targets no longer points at a live buffer.
2441 If you have added new entries to a buffer that might themselves be targets,
2442 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2443 find that easier, `C-u C-u C-u C-c C-w'."
2444 :group 'org-refile
2445 :version "24.1"
2446 :type 'boolean)
2448 (defcustom org-refile-use-outline-path nil
2449 "Non-nil means provide refile targets as paths.
2450 So a level 3 headline will be available as level1/level2/level3.
2452 When the value is `file', also include the file name (without directory)
2453 into the path. In this case, you can also stop the completion after
2454 the file name, to get entries inserted as top level in the file.
2456 When `full-file-path', include the full file path."
2457 :group 'org-refile
2458 :type '(choice
2459 (const :tag "Not" nil)
2460 (const :tag "Yes" t)
2461 (const :tag "Start with file name" file)
2462 (const :tag "Start with full file path" full-file-path)))
2464 (defcustom org-outline-path-complete-in-steps t
2465 "Non-nil means complete the outline path in hierarchical steps.
2466 When Org-mode uses the refile interface to select an outline path
2467 \(see variable `org-refile-use-outline-path'), the completion of
2468 the path can be done in a single go, or it can be done in steps down
2469 the headline hierarchy. Going in steps is probably the best if you
2470 do not use a special completion package like `ido' or `icicles'.
2471 However, when using these packages, going in one step can be very
2472 fast, while still showing the whole path to the entry."
2473 :group 'org-refile
2474 :type 'boolean)
2476 (defcustom org-refile-allow-creating-parent-nodes nil
2477 "Non-nil means allow to create new nodes as refile targets.
2478 New nodes are then created by adding \"/new node name\" to the completion
2479 of an existing node. When the value of this variable is `confirm',
2480 new node creation must be confirmed by the user (recommended).
2481 When nil, the completion must match an existing entry.
2483 Note that, if the new heading is not seen by the criteria
2484 listed in `org-refile-targets', multiple instances of the same
2485 heading would be created by trying again to file under the new
2486 heading."
2487 :group 'org-refile
2488 :type '(choice
2489 (const :tag "Never" nil)
2490 (const :tag "Always" t)
2491 (const :tag "Prompt for confirmation" confirm)))
2493 (defcustom org-refile-active-region-within-subtree nil
2494 "Non-nil means also refile active region within a subtree.
2496 By default `org-refile' doesn't allow refiling regions if they
2497 don't contain a set of subtrees, but it might be convenient to
2498 do so sometimes: in that case, the first line of the region is
2499 converted to a headline before refiling."
2500 :group 'org-refile
2501 :version "24.1"
2502 :type 'boolean)
2504 (defgroup org-todo nil
2505 "Options concerning TODO items in Org-mode."
2506 :tag "Org TODO"
2507 :group 'org)
2509 (defgroup org-progress nil
2510 "Options concerning Progress logging in Org-mode."
2511 :tag "Org Progress"
2512 :group 'org-time)
2514 (defvar org-todo-interpretation-widgets
2515 '((:tag "Sequence (cycling hits every state)" sequence)
2516 (:tag "Type (cycling directly to DONE)" type))
2517 "The available interpretation symbols for customizing `org-todo-keywords'.
2518 Interested libraries should add to this list.")
2520 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2521 "List of TODO entry keyword sequences and their interpretation.
2522 \\<org-mode-map>This is a list of sequences.
2524 Each sequence starts with a symbol, either `sequence' or `type',
2525 indicating if the keywords should be interpreted as a sequence of
2526 action steps, or as different types of TODO items. The first
2527 keywords are states requiring action - these states will select a headline
2528 for inclusion into the global TODO list Org-mode produces. If one of
2529 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2530 signify that no further action is necessary. If \"|\" is not found,
2531 the last keyword is treated as the only DONE state of the sequence.
2533 The command \\[org-todo] cycles an entry through these states, and one
2534 additional state where no keyword is present. For details about this
2535 cycling, see the manual.
2537 TODO keywords and interpretation can also be set on a per-file basis with
2538 the special #+SEQ_TODO and #+TYP_TODO lines.
2540 Each keyword can optionally specify a character for fast state selection
2541 \(in combination with the variable `org-use-fast-todo-selection')
2542 and specifiers for state change logging, using the same syntax that
2543 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2544 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2545 indicates to record a time stamp each time this state is selected.
2547 Each keyword may also specify if a timestamp or a note should be
2548 recorded when entering or leaving the state, by adding additional
2549 characters in the parenthesis after the keyword. This looks like this:
2550 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2551 record only the time of the state change. With X and Y being either
2552 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2553 Y when leaving the state if and only if the *target* state does not
2554 define X. You may omit any of the fast-selection key or X or /Y,
2555 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2557 For backward compatibility, this variable may also be just a list
2558 of keywords. In this case the interpretation (sequence or type) will be
2559 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2560 :group 'org-todo
2561 :group 'org-keywords
2562 :type '(choice
2563 (repeat :tag "Old syntax, just keywords"
2564 (string :tag "Keyword"))
2565 (repeat :tag "New syntax"
2566 (cons
2567 (choice
2568 :tag "Interpretation"
2569 ;;Quick and dirty way to see
2570 ;;`org-todo-interpretations'. This takes the
2571 ;;place of item arguments
2572 :convert-widget
2573 (lambda (widget)
2574 (widget-put widget
2575 :args (mapcar
2576 (lambda (x)
2577 (widget-convert
2578 (cons 'const x)))
2579 org-todo-interpretation-widgets))
2580 widget))
2581 (repeat
2582 (string :tag "Keyword"))))))
2584 (defvar org-todo-keywords-1 nil
2585 "All TODO and DONE keywords active in a buffer.")
2586 (make-variable-buffer-local 'org-todo-keywords-1)
2587 (defvar org-todo-keywords-for-agenda nil)
2588 (defvar org-done-keywords-for-agenda nil)
2589 (defvar org-todo-keyword-alist-for-agenda nil)
2590 (defvar org-tag-alist-for-agenda nil
2591 "Alist of all tags from all agenda files.")
2592 (defvar org-tag-groups-alist-for-agenda nil
2593 "Alist of all groups tags from all current agenda files.")
2594 (defvar org-tag-groups-alist nil)
2595 (make-variable-buffer-local 'org-tag-groups-alist)
2596 (defvar org-agenda-contributing-files nil)
2597 (defvar org-not-done-keywords nil)
2598 (make-variable-buffer-local 'org-not-done-keywords)
2599 (defvar org-done-keywords nil)
2600 (make-variable-buffer-local 'org-done-keywords)
2601 (defvar org-todo-heads nil)
2602 (make-variable-buffer-local 'org-todo-heads)
2603 (defvar org-todo-sets nil)
2604 (make-variable-buffer-local 'org-todo-sets)
2605 (defvar org-todo-log-states nil)
2606 (make-variable-buffer-local 'org-todo-log-states)
2607 (defvar org-todo-kwd-alist nil)
2608 (make-variable-buffer-local 'org-todo-kwd-alist)
2609 (defvar org-todo-key-alist nil)
2610 (make-variable-buffer-local 'org-todo-key-alist)
2611 (defvar org-todo-key-trigger nil)
2612 (make-variable-buffer-local 'org-todo-key-trigger)
2614 (defcustom org-todo-interpretation 'sequence
2615 "Controls how TODO keywords are interpreted.
2616 This variable is in principle obsolete and is only used for
2617 backward compatibility, if the interpretation of todo keywords is
2618 not given already in `org-todo-keywords'. See that variable for
2619 more information."
2620 :group 'org-todo
2621 :group 'org-keywords
2622 :type '(choice (const sequence)
2623 (const type)))
2625 (defcustom org-use-fast-todo-selection t
2626 "Non-nil means use the fast todo selection scheme with C-c C-t.
2627 This variable describes if and under what circumstances the cycling
2628 mechanism for TODO keywords will be replaced by a single-key, direct
2629 selection scheme.
2631 When nil, fast selection is never used.
2633 When the symbol `prefix', it will be used when `org-todo' is called
2634 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2635 `C-u t' in an agenda buffer.
2637 When t, fast selection is used by default. In this case, the prefix
2638 argument forces cycling instead.
2640 In all cases, the special interface is only used if access keys have
2641 actually been assigned by the user, i.e. if keywords in the configuration
2642 are followed by a letter in parenthesis, like TODO(t)."
2643 :group 'org-todo
2644 :type '(choice
2645 (const :tag "Never" nil)
2646 (const :tag "By default" t)
2647 (const :tag "Only with C-u C-c C-t" prefix)))
2649 (defcustom org-provide-todo-statistics t
2650 "Non-nil means update todo statistics after insert and toggle.
2651 ALL-HEADLINES means update todo statistics by including headlines
2652 with no TODO keyword as well, counting them as not done.
2653 A list of TODO keywords means the same, but skip keywords that are
2654 not in this list.
2655 When set to a list of two lists, the first list contains keywords
2656 to consider as TODO keywords, the second list contains keywords
2657 to consider as DONE keywords.
2659 When this is set, todo statistics is updated in the parent of the
2660 current entry each time a todo state is changed."
2661 :group 'org-todo
2662 :type '(choice
2663 (const :tag "Yes, only for TODO entries" t)
2664 (const :tag "Yes, including all entries" all-headlines)
2665 (repeat :tag "Yes, for TODOs in this list"
2666 (string :tag "TODO keyword"))
2667 (list :tag "Yes, for TODOs and DONEs in these lists"
2668 (repeat (string :tag "TODO keyword"))
2669 (repeat (string :tag "DONE keyword")))
2670 (other :tag "No TODO statistics" nil)))
2672 (defcustom org-hierarchical-todo-statistics t
2673 "Non-nil means TODO statistics covers just direct children.
2674 When nil, all entries in the subtree are considered.
2675 This has only an effect if `org-provide-todo-statistics' is set.
2676 To set this to nil for only a single subtree, use a COOKIE_DATA
2677 property and include the word \"recursive\" into the value."
2678 :group 'org-todo
2679 :type 'boolean)
2681 (defcustom org-after-todo-state-change-hook nil
2682 "Hook which is run after the state of a TODO item was changed.
2683 The new state (a string with a TODO keyword, or nil) is available in the
2684 Lisp variable `org-state'."
2685 :group 'org-todo
2686 :type 'hook)
2688 (defvar org-blocker-hook nil
2689 "Hook for functions that are allowed to block a state change.
2691 Functions in this hook should not modify the buffer.
2692 Each function gets as its single argument a property list,
2693 see `org-trigger-hook' for more information about this list.
2695 If any of the functions in this hook returns nil, the state change
2696 is blocked.")
2698 (defvar org-trigger-hook nil
2699 "Hook for functions that are triggered by a state change.
2701 Each function gets as its single argument a property list with at
2702 least the following elements:
2704 (:type type-of-change :position pos-at-entry-start
2705 :from old-state :to new-state)
2707 Depending on the type, more properties may be present.
2709 This mechanism is currently implemented for:
2711 TODO state changes
2712 ------------------
2713 :type todo-state-change
2714 :from previous state (keyword as a string), or nil, or a symbol
2715 'todo' or 'done', to indicate the general type of state.
2716 :to new state, like in :from")
2718 (defcustom org-enforce-todo-dependencies nil
2719 "Non-nil means undone TODO entries will block switching the parent to DONE.
2720 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2721 be blocked if any prior sibling is not yet done.
2722 Finally, if the parent is blocked because of ordered siblings of its own,
2723 the child will also be blocked."
2724 :set (lambda (var val)
2725 (set var val)
2726 (if val
2727 (add-hook 'org-blocker-hook
2728 'org-block-todo-from-children-or-siblings-or-parent)
2729 (remove-hook 'org-blocker-hook
2730 'org-block-todo-from-children-or-siblings-or-parent)))
2731 :group 'org-todo
2732 :type 'boolean)
2734 (defcustom org-enforce-todo-checkbox-dependencies nil
2735 "Non-nil means unchecked boxes will block switching the parent to DONE.
2736 When this is nil, checkboxes have no influence on switching TODO states.
2737 When non-nil, you first need to check off all check boxes before the TODO
2738 entry can be switched to DONE.
2739 This variable needs to be set before org.el is loaded, and you need to
2740 restart Emacs after a change to make the change effective. The only way
2741 to change is while Emacs is running is through the customize interface."
2742 :set (lambda (var val)
2743 (set var val)
2744 (if val
2745 (add-hook 'org-blocker-hook
2746 'org-block-todo-from-checkboxes)
2747 (remove-hook 'org-blocker-hook
2748 'org-block-todo-from-checkboxes)))
2749 :group 'org-todo
2750 :type 'boolean)
2752 (defcustom org-treat-insert-todo-heading-as-state-change nil
2753 "Non-nil means inserting a TODO heading is treated as state change.
2754 So when the command \\[org-insert-todo-heading] is used, state change
2755 logging will apply if appropriate. When nil, the new TODO item will
2756 be inserted directly, and no logging will take place."
2757 :group 'org-todo
2758 :type 'boolean)
2760 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2761 "Non-nil means switching TODO states with S-cursor counts as state change.
2762 This is the default behavior. However, setting this to nil allows a
2763 convenient way to select a TODO state and bypass any logging associated
2764 with that."
2765 :group 'org-todo
2766 :type 'boolean)
2768 (defcustom org-todo-state-tags-triggers nil
2769 "Tag changes that should be triggered by TODO state changes.
2770 This is a list. Each entry is
2772 (state-change (tag . flag) .......)
2774 State-change can be a string with a state, and empty string to indicate the
2775 state that has no TODO keyword, or it can be one of the symbols `todo'
2776 or `done', meaning any not-done or done state, respectively."
2777 :group 'org-todo
2778 :group 'org-tags
2779 :type '(repeat
2780 (cons (choice :tag "When changing to"
2781 (const :tag "Not-done state" todo)
2782 (const :tag "Done state" done)
2783 (string :tag "State"))
2784 (repeat
2785 (cons :tag "Tag action"
2786 (string :tag "Tag")
2787 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2789 (defcustom org-log-done nil
2790 "Information to record when a task moves to the DONE state.
2792 Possible values are:
2794 nil Don't add anything, just change the keyword
2795 time Add a time stamp to the task
2796 note Prompt for a note and add it with template `org-log-note-headings'
2798 This option can also be set with on a per-file-basis with
2800 #+STARTUP: nologdone
2801 #+STARTUP: logdone
2802 #+STARTUP: lognotedone
2804 You can have local logging settings for a subtree by setting the LOGGING
2805 property to one or more of these keywords."
2806 :group 'org-todo
2807 :group 'org-progress
2808 :type '(choice
2809 (const :tag "No logging" nil)
2810 (const :tag "Record CLOSED timestamp" time)
2811 (const :tag "Record CLOSED timestamp with note." note)))
2813 ;; Normalize old uses of org-log-done.
2814 (cond
2815 ((eq org-log-done t) (setq org-log-done 'time))
2816 ((and (listp org-log-done) (memq 'done org-log-done))
2817 (setq org-log-done 'note)))
2819 (defcustom org-log-reschedule nil
2820 "Information to record when the scheduling date of a tasks is modified.
2822 Possible values are:
2824 nil Don't add anything, just change the date
2825 time Add a time stamp to the task
2826 note Prompt for a note and add it with template `org-log-note-headings'
2828 This option can also be set with on a per-file-basis with
2830 #+STARTUP: nologreschedule
2831 #+STARTUP: logreschedule
2832 #+STARTUP: lognotereschedule"
2833 :group 'org-todo
2834 :group 'org-progress
2835 :type '(choice
2836 (const :tag "No logging" nil)
2837 (const :tag "Record timestamp" time)
2838 (const :tag "Record timestamp with note." note)))
2840 (defcustom org-log-redeadline nil
2841 "Information to record when the deadline date of a tasks is modified.
2843 Possible values are:
2845 nil Don't add anything, just change the date
2846 time Add a time stamp to the task
2847 note Prompt for a note and add it with template `org-log-note-headings'
2849 This option can also be set with on a per-file-basis with
2851 #+STARTUP: nologredeadline
2852 #+STARTUP: logredeadline
2853 #+STARTUP: lognoteredeadline
2855 You can have local logging settings for a subtree by setting the LOGGING
2856 property to one or more of these keywords."
2857 :group 'org-todo
2858 :group 'org-progress
2859 :type '(choice
2860 (const :tag "No logging" nil)
2861 (const :tag "Record timestamp" time)
2862 (const :tag "Record timestamp with note." note)))
2864 (defcustom org-log-note-clock-out nil
2865 "Non-nil means record a note when clocking out of an item.
2866 This can also be configured on a per-file basis by adding one of
2867 the following lines anywhere in the buffer:
2869 #+STARTUP: lognoteclock-out
2870 #+STARTUP: nolognoteclock-out"
2871 :group 'org-todo
2872 :group 'org-progress
2873 :type 'boolean)
2875 (defcustom org-log-done-with-time t
2876 "Non-nil means the CLOSED time stamp will contain date and time.
2877 When nil, only the date will be recorded."
2878 :group 'org-progress
2879 :type 'boolean)
2881 (defcustom org-log-note-headings
2882 '((done . "CLOSING NOTE %t")
2883 (state . "State %-12s from %-12S %t")
2884 (note . "Note taken on %t")
2885 (reschedule . "Rescheduled from %S on %t")
2886 (delschedule . "Not scheduled, was %S on %t")
2887 (redeadline . "New deadline from %S on %t")
2888 (deldeadline . "Removed deadline, was %S on %t")
2889 (refile . "Refiled on %t")
2890 (clock-out . ""))
2891 "Headings for notes added to entries.
2893 The value is an alist, with the car being a symbol indicating the
2894 note context, and the cdr is the heading to be used. The heading
2895 may also be the empty string. The following placeholders can be
2896 used:
2898 %t a time stamp.
2899 %T an active time stamp instead the default inactive one
2900 %d a short-format time stamp.
2901 %D an active short-format time stamp.
2902 %s the new TODO state or time stamp (inactive), in double quotes.
2903 %S the old TODO state or time stamp (inactive), in double quotes.
2904 %u the user name.
2905 %U full user name.
2907 In fact, it is not a good idea to change the `state' entry,
2908 because Agenda Log mode depends on the format of these entries."
2909 :group 'org-todo
2910 :group 'org-progress
2911 :type '(list :greedy t
2912 (cons (const :tag "Heading when closing an item" done) string)
2913 (cons (const :tag
2914 "Heading when changing todo state (todo sequence only)"
2915 state) string)
2916 (cons (const :tag "Heading when just taking a note" note) string)
2917 (cons (const :tag "Heading when rescheduling" reschedule) string)
2918 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2919 (cons (const :tag "Heading when changing deadline" redeadline) string)
2920 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2921 (cons (const :tag "Heading when refiling" refile) string)
2922 (cons (const :tag "Heading when clocking out" clock-out) string)))
2924 (unless (assq 'note org-log-note-headings)
2925 (push '(note . "%t") org-log-note-headings))
2927 (defcustom org-log-into-drawer nil
2928 "Non-nil means insert state change notes and time stamps into a drawer.
2929 When nil, state changes notes will be inserted after the headline and
2930 any scheduling and clock lines, but not inside a drawer.
2932 The value of this variable should be the name of the drawer to use.
2933 LOGBOOK is proposed as the default drawer for this purpose, you can
2934 also set this to a string to define the drawer of your choice.
2936 A value of t is also allowed, representing \"LOGBOOK\".
2938 A value of t or nil can also be set with on a per-file-basis with
2940 #+STARTUP: logdrawer
2941 #+STARTUP: nologdrawer
2943 If this variable is set, `org-log-state-notes-insert-after-drawers'
2944 will be ignored.
2946 You can set the property LOG_INTO_DRAWER to overrule this setting for
2947 a subtree.
2949 Do not check directly this variable in a Lisp program. Call
2950 function `org-log-into-drawer' instead."
2951 :group 'org-todo
2952 :group 'org-progress
2953 :type '(choice
2954 (const :tag "Not into a drawer" nil)
2955 (const :tag "LOGBOOK" t)
2956 (string :tag "Other")))
2958 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2960 (defun org-log-into-drawer ()
2961 "Name of the log drawer, as a string, or nil.
2962 This is the value of `org-log-into-drawer'. However, if the
2963 current entry has or inherits a LOG_INTO_DRAWER property, it will
2964 be used instead of the default value."
2965 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2966 (cond ((equal p "nil") nil)
2967 ((equal p "t") "LOGBOOK")
2968 ((stringp p) p)
2969 (p "LOGBOOK")
2970 ((stringp org-log-into-drawer) org-log-into-drawer)
2971 (org-log-into-drawer "LOGBOOK"))))
2973 (defcustom org-log-state-notes-insert-after-drawers nil
2974 "Non-nil means insert state change notes after any drawers in entry.
2975 Only the drawers that *immediately* follow the headline and the
2976 deadline/scheduled line are skipped.
2977 When nil, insert notes right after the heading and perhaps the line
2978 with deadline/scheduling if present.
2980 This variable will have no effect if `org-log-into-drawer' is
2981 set."
2982 :group 'org-todo
2983 :group 'org-progress
2984 :type 'boolean)
2986 (defcustom org-log-states-order-reversed t
2987 "Non-nil means the latest state note will be directly after heading.
2988 When nil, the state change notes will be ordered according to time.
2990 This option can also be set with on a per-file-basis with
2992 #+STARTUP: logstatesreversed
2993 #+STARTUP: nologstatesreversed"
2994 :group 'org-todo
2995 :group 'org-progress
2996 :type 'boolean)
2998 (defcustom org-todo-repeat-to-state nil
2999 "The TODO state to which a repeater should return the repeating task.
3000 By default this is the first task in a TODO sequence, or the previous state
3001 in a TODO_TYP set. But you can specify another task here.
3002 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3003 :group 'org-todo
3004 :version "24.1"
3005 :type '(choice (const :tag "Head of sequence" nil)
3006 (string :tag "Specific state")))
3008 (defcustom org-log-repeat 'time
3009 "Non-nil means record moving through the DONE state when triggering repeat.
3010 An auto-repeating task is immediately switched back to TODO when
3011 marked DONE. If you are not logging state changes (by adding \"@\"
3012 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3013 record a closing note, there will be no record of the task moving
3014 through DONE. This variable forces taking a note anyway.
3016 nil Don't force a record
3017 time Record a time stamp
3018 note Prompt for a note and add it with template `org-log-note-headings'
3020 This option can also be set with on a per-file-basis with
3022 #+STARTUP: nologrepeat
3023 #+STARTUP: logrepeat
3024 #+STARTUP: lognoterepeat
3026 You can have local logging settings for a subtree by setting the LOGGING
3027 property to one or more of these keywords."
3028 :group 'org-todo
3029 :group 'org-progress
3030 :type '(choice
3031 (const :tag "Don't force a record" nil)
3032 (const :tag "Force recording the DONE state" time)
3033 (const :tag "Force recording a note with the DONE state" note)))
3036 (defgroup org-priorities nil
3037 "Priorities in Org-mode."
3038 :tag "Org Priorities"
3039 :group 'org-todo)
3041 (defcustom org-enable-priority-commands t
3042 "Non-nil means priority commands are active.
3043 When nil, these commands will be disabled, so that you never accidentally
3044 set a priority."
3045 :group 'org-priorities
3046 :type 'boolean)
3048 (defcustom org-highest-priority ?A
3049 "The highest priority of TODO items. A character like ?A, ?B etc.
3050 Must have a smaller ASCII number than `org-lowest-priority'."
3051 :group 'org-priorities
3052 :type 'character)
3054 (defcustom org-lowest-priority ?C
3055 "The lowest priority of TODO items. A character like ?A, ?B etc.
3056 Must have a larger ASCII number than `org-highest-priority'."
3057 :group 'org-priorities
3058 :type 'character)
3060 (defcustom org-default-priority ?B
3061 "The default priority of TODO items.
3062 This is the priority an item gets if no explicit priority is given.
3063 When starting to cycle on an empty priority the first step in the cycle
3064 depends on `org-priority-start-cycle-with-default'. The resulting first
3065 step priority must not exceed the range from `org-highest-priority' to
3066 `org-lowest-priority' which means that `org-default-priority' has to be
3067 in this range exclusive or inclusive the range boundaries. Else the
3068 first step refuses to set the default and the second will fall back
3069 to (depending on the command used) the highest or lowest priority."
3070 :group 'org-priorities
3071 :type 'character)
3073 (defcustom org-priority-start-cycle-with-default t
3074 "Non-nil means start with default priority when starting to cycle.
3075 When this is nil, the first step in the cycle will be (depending on the
3076 command used) one higher or lower than the default priority.
3077 See also `org-default-priority'."
3078 :group 'org-priorities
3079 :type 'boolean)
3081 (defcustom org-get-priority-function nil
3082 "Function to extract the priority from a string.
3083 The string is normally the headline. If this is nil Org computes the
3084 priority from the priority cookie like [#A] in the headline. It returns
3085 an integer, increasing by 1000 for each priority level.
3086 The user can set a different function here, which should take a string
3087 as an argument and return the numeric priority."
3088 :group 'org-priorities
3089 :version "24.1"
3090 :type '(choice
3091 (const nil)
3092 (function)))
3094 (defgroup org-time nil
3095 "Options concerning time stamps and deadlines in Org-mode."
3096 :tag "Org Time"
3097 :group 'org)
3099 (defcustom org-time-stamp-rounding-minutes '(0 5)
3100 "Number of minutes to round time stamps to.
3101 These are two values, the first applies when first creating a time stamp.
3102 The second applies when changing it with the commands `S-up' and `S-down'.
3103 When changing the time stamp, this means that it will change in steps
3104 of N minutes, as given by the second value.
3106 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3107 numbers should be factors of 60, so for example 5, 10, 15.
3109 When this is larger than 1, you can still force an exact time stamp by using
3110 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
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 (set (make-local-variable
3524 'org-complete-tags-always-offer-all-agenda-tags)
3525 t)))"
3526 :group 'org-tags
3527 :version "24.1"
3528 :type 'boolean)
3530 (defvar org-file-tags nil
3531 "List of tags that can be inherited by all entries in the file.
3532 The tags will be inherited if the variable `org-use-tag-inheritance'
3533 says they should be.
3534 This variable is populated from #+FILETAGS lines.")
3536 (defcustom org-use-fast-tag-selection 'auto
3537 "Non-nil means use fast tag selection scheme.
3538 This is a special interface to select and deselect tags with single keys.
3539 When nil, fast selection is never used.
3540 When the symbol `auto', fast selection is used if and only if selection
3541 characters for tags have been configured, either through the variable
3542 `org-tag-alist' or through a #+TAGS line in the buffer.
3543 When t, fast selection is always used and selection keys are assigned
3544 automatically if necessary."
3545 :group 'org-tags
3546 :type '(choice
3547 (const :tag "Always" t)
3548 (const :tag "Never" nil)
3549 (const :tag "When selection characters are configured" auto)))
3551 (defcustom org-fast-tag-selection-single-key nil
3552 "Non-nil means fast tag selection exits after first change.
3553 When nil, you have to press RET to exit it.
3554 During fast tag selection, you can toggle this flag with `C-c'.
3555 This variable can also have the value `expert'. In this case, the window
3556 displaying the tags menu is not even shown, until you press C-c again."
3557 :group 'org-tags
3558 :type '(choice
3559 (const :tag "No" nil)
3560 (const :tag "Yes" t)
3561 (const :tag "Expert" expert)))
3563 (defvar org-fast-tag-selection-include-todo nil
3564 "Non-nil means fast tags selection interface will also offer TODO states.
3565 This is an undocumented feature, you should not rely on it.")
3567 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3568 "The column to which tags should be indented in a headline.
3569 If this number is positive, it specifies the column. If it is negative,
3570 it means that the tags should be flushright to that column. For example,
3571 -80 works well for a normal 80 character screen.
3572 When 0, place tags directly after headline text, with only one space in
3573 between."
3574 :group 'org-tags
3575 :type 'integer)
3577 (defcustom org-auto-align-tags t
3578 "Non-nil keeps tags aligned when modifying headlines.
3579 Some operations (i.e. demoting) change the length of a headline and
3580 therefore shift the tags around. With this option turned on, after
3581 each such operation the tags are again aligned to `org-tags-column'."
3582 :group 'org-tags
3583 :type 'boolean)
3585 (defcustom org-use-tag-inheritance t
3586 "Non-nil means tags in levels apply also for sublevels.
3587 When nil, only the tags directly given in a specific line apply there.
3588 This may also be a list of tags that should be inherited, or a regexp that
3589 matches tags that should be inherited. Additional control is possible
3590 with the variable `org-tags-exclude-from-inheritance' which gives an
3591 explicit list of tags to be excluded from inheritance, even if the value of
3592 `org-use-tag-inheritance' would select it for inheritance.
3594 If this option is t, a match early-on in a tree can lead to a large
3595 number of matches in the subtree when constructing the agenda or creating
3596 a sparse tree. If you only want to see the first match in a tree during
3597 a search, check out the variable `org-tags-match-list-sublevels'."
3598 :group 'org-tags
3599 :type '(choice
3600 (const :tag "Not" nil)
3601 (const :tag "Always" t)
3602 (repeat :tag "Specific tags" (string :tag "Tag"))
3603 (regexp :tag "Tags matched by regexp")))
3605 (defcustom org-tags-exclude-from-inheritance nil
3606 "List of tags that should never be inherited.
3607 This is a way to exclude a few tags from inheritance. For way to do
3608 the opposite, to actively allow inheritance for selected tags,
3609 see the variable `org-use-tag-inheritance'."
3610 :group 'org-tags
3611 :type '(repeat (string :tag "Tag")))
3613 (defun org-tag-inherit-p (tag)
3614 "Check if TAG is one that should be inherited."
3615 (cond
3616 ((member tag org-tags-exclude-from-inheritance) nil)
3617 ((eq org-use-tag-inheritance t) t)
3618 ((not org-use-tag-inheritance) nil)
3619 ((stringp org-use-tag-inheritance)
3620 (string-match org-use-tag-inheritance tag))
3621 ((listp org-use-tag-inheritance)
3622 (member tag org-use-tag-inheritance))
3623 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3625 (defcustom org-tags-match-list-sublevels t
3626 "Non-nil means list also sublevels of headlines matching a search.
3627 This variable applies to tags/property searches, and also to stuck
3628 projects because this search is based on a tags match as well.
3630 When set to the symbol `indented', sublevels are indented with
3631 leading dots.
3633 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3634 the sublevels of a headline matching a tag search often also match
3635 the same search. Listing all of them can create very long lists.
3636 Setting this variable to nil causes subtrees of a match to be skipped.
3638 This variable is semi-obsolete and probably should always be true. It
3639 is better to limit inheritance to certain tags using the variables
3640 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3641 :group 'org-tags
3642 :type '(choice
3643 (const :tag "No, don't list them" nil)
3644 (const :tag "Yes, do list them" t)
3645 (const :tag "List them, indented with leading dots" indented)))
3647 (defcustom org-tags-sort-function nil
3648 "When set, tags are sorted using this function as a comparator."
3649 :group 'org-tags
3650 :type '(choice
3651 (const :tag "No sorting" nil)
3652 (const :tag "Alphabetical" string<)
3653 (const :tag "Reverse alphabetical" string>)
3654 (function :tag "Custom function" nil)))
3656 (defvar org-tags-history nil
3657 "History of minibuffer reads for tags.")
3658 (defvar org-last-tags-completion-table nil
3659 "The last used completion table for tags.")
3660 (defvar org-after-tags-change-hook nil
3661 "Hook that is run after the tags in a line have changed.")
3663 (defgroup org-properties nil
3664 "Options concerning properties in Org-mode."
3665 :tag "Org Properties"
3666 :group 'org)
3668 (defcustom org-property-format "%-10s %s"
3669 "How property key/value pairs should be formatted by `indent-line'.
3670 When `indent-line' hits a property definition, it will format the line
3671 according to this format, mainly to make sure that the values are
3672 lined-up with respect to each other."
3673 :group 'org-properties
3674 :type 'string)
3676 (defcustom org-properties-postprocess-alist nil
3677 "Alist of properties and functions to adjust inserted values.
3678 Elements of this alist must be of the form
3680 ([string] [function])
3682 where [string] must be a property name and [function] must be a
3683 lambda expression: this lambda expression must take one argument,
3684 the value to adjust, and return the new value as a string.
3686 For example, this element will allow the property \"Remaining\"
3687 to be updated wrt the relation between the \"Effort\" property
3688 and the clock summary:
3690 ((\"Remaining\" (lambda(value)
3691 (let ((clocksum (org-clock-sum-current-item))
3692 (effort (org-duration-string-to-minutes
3693 (org-entry-get (point) \"Effort\"))))
3694 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3695 :group 'org-properties
3696 :version "24.1"
3697 :type '(alist :key-type (string :tag "Property")
3698 :value-type (function :tag "Function")))
3700 (defcustom org-use-property-inheritance nil
3701 "Non-nil means properties apply also for sublevels.
3703 This setting is chiefly used during property searches. Turning it on can
3704 cause significant overhead when doing a search, which is why it is not
3705 on by default.
3707 When nil, only the properties directly given in the current entry count.
3708 When t, every property is inherited. The value may also be a list of
3709 properties that should have inheritance, or a regular expression matching
3710 properties that should be inherited.
3712 However, note that some special properties use inheritance under special
3713 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3714 and the properties ending in \"_ALL\" when they are used as descriptor
3715 for valid values of a property.
3717 Note for programmers:
3718 When querying an entry with `org-entry-get', you can control if inheritance
3719 should be used. By default, `org-entry-get' looks only at the local
3720 properties. You can request inheritance by setting the inherit argument
3721 to t (to force inheritance) or to `selective' (to respect the setting
3722 in this variable)."
3723 :group 'org-properties
3724 :type '(choice
3725 (const :tag "Not" nil)
3726 (const :tag "Always" t)
3727 (repeat :tag "Specific properties" (string :tag "Property"))
3728 (regexp :tag "Properties matched by regexp")))
3730 (defun org-property-inherit-p (property)
3731 "Check if PROPERTY is one that should be inherited."
3732 (cond
3733 ((eq org-use-property-inheritance t) t)
3734 ((not org-use-property-inheritance) nil)
3735 ((stringp org-use-property-inheritance)
3736 (string-match org-use-property-inheritance property))
3737 ((listp org-use-property-inheritance)
3738 (member property org-use-property-inheritance))
3739 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3741 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3742 "The default column format, if no other format has been defined.
3743 This variable can be set on the per-file basis by inserting a line
3745 #+COLUMNS: %25ITEM ....."
3746 :group 'org-properties
3747 :type 'string)
3749 (defcustom org-columns-ellipses ".."
3750 "The ellipses to be used when a field in column view is truncated.
3751 When this is the empty string, as many characters as possible are shown,
3752 but then there will be no visual indication that the field has been truncated.
3753 When this is a string of length N, the last N characters of a truncated
3754 field are replaced by this string. If the column is narrower than the
3755 ellipses string, only part of the ellipses string will be shown."
3756 :group 'org-properties
3757 :type 'string)
3759 (defcustom org-columns-modify-value-for-display-function nil
3760 "Function that modifies values for display in column view.
3761 For example, it can be used to cut out a certain part from a time stamp.
3762 The function must take 2 arguments:
3764 column-title The title of the column (*not* the property name)
3765 value The value that should be modified.
3767 The function should return the value that should be displayed,
3768 or nil if the normal value should be used."
3769 :group 'org-properties
3770 :type '(choice (const nil) (function)))
3772 (defconst org-global-properties-fixed
3773 '(("VISIBILITY_ALL" . "folded children content all")
3774 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3775 "List of property/value pairs that can be inherited by any entry.
3777 These are fixed values, for the preset properties. The user variable
3778 that can be used to add to this list is `org-global-properties'.
3780 The entries in this list are cons cells where the car is a property
3781 name and cdr is a string with the value. If the value represents
3782 multiple items like an \"_ALL\" property, separate the items by
3783 spaces.")
3785 (defcustom org-global-properties nil
3786 "List of property/value pairs that can be inherited by any entry.
3788 This list will be combined with the constant `org-global-properties-fixed'.
3790 The entries in this list are cons cells where the car is a property
3791 name and cdr is a string with the value.
3793 You can set buffer-local values for the same purpose in the variable
3794 `org-file-properties' this by adding lines like
3796 #+PROPERTY: NAME VALUE"
3797 :group 'org-properties
3798 :type '(repeat
3799 (cons (string :tag "Property")
3800 (string :tag "Value"))))
3802 (defvar org-file-properties nil
3803 "List of property/value pairs that can be inherited by any entry.
3804 Valid for the current buffer.
3805 This variable is populated from #+PROPERTY lines.")
3806 (make-variable-buffer-local 'org-file-properties)
3808 (defgroup org-agenda nil
3809 "Options concerning agenda views in Org-mode."
3810 :tag "Org Agenda"
3811 :group 'org)
3813 (defvar org-category nil
3814 "Variable used by org files to set a category for agenda display.
3815 Such files should use a file variable to set it, for example
3817 # -*- mode: org; org-category: \"ELisp\"
3819 or contain a special line
3821 #+CATEGORY: ELisp
3823 If the file does not specify a category, then file's base name
3824 is used instead.")
3825 (make-variable-buffer-local 'org-category)
3826 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3828 (defcustom org-agenda-files nil
3829 "The files to be used for agenda display.
3830 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3831 \\[org-remove-file]. You can also use customize to edit the list.
3833 If an entry is a directory, all files in that directory that are matched by
3834 `org-agenda-file-regexp' will be part of the file list.
3836 If the value of the variable is not a list but a single file name, then
3837 the list of agenda files is actually stored and maintained in that file, one
3838 agenda file per line. In this file paths can be given relative to
3839 `org-directory'. Tilde expansion and environment variable substitution
3840 are also made."
3841 :group 'org-agenda
3842 :type '(choice
3843 (repeat :tag "List of files and directories" file)
3844 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3846 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3847 "Regular expression to match files for `org-agenda-files'.
3848 If any element in the list in that variable contains a directory instead
3849 of a normal file, all files in that directory that are matched by this
3850 regular expression will be included."
3851 :group 'org-agenda
3852 :type 'regexp)
3854 (defcustom org-agenda-text-search-extra-files nil
3855 "List of extra files to be searched by text search commands.
3856 These files will be searched in addition to the agenda files by the
3857 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3858 Note that these files will only be searched for text search commands,
3859 not for the other agenda views like todo lists, tag searches or the weekly
3860 agenda. This variable is intended to list notes and possibly archive files
3861 that should also be searched by these two commands.
3862 In fact, if the first element in the list is the symbol `agenda-archives',
3863 then all archive files of all agenda files will be added to the search
3864 scope."
3865 :group 'org-agenda
3866 :type '(set :greedy t
3867 (const :tag "Agenda Archives" agenda-archives)
3868 (repeat :inline t (file))))
3870 (org-defvaralias 'org-agenda-multi-occur-extra-files
3871 'org-agenda-text-search-extra-files)
3873 (defcustom org-agenda-skip-unavailable-files nil
3874 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3875 A nil value means to remove them, after a query, from the list."
3876 :group 'org-agenda
3877 :type 'boolean)
3879 (defcustom org-calendar-to-agenda-key [?c]
3880 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3881 The command `org-calendar-goto-agenda' will be bound to this key. The
3882 default is the character `c' because then `c' can be used to switch back and
3883 forth between agenda and calendar."
3884 :group 'org-agenda
3885 :type 'sexp)
3887 (defcustom org-calendar-insert-diary-entry-key [?i]
3888 "The key to be installed in `calendar-mode-map' for adding diary entries.
3889 This option is irrelevant until `org-agenda-diary-file' has been configured
3890 to point to an Org-mode file. When that is the case, the command
3891 `org-agenda-diary-entry' will be bound to the key given here, by default
3892 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3893 if you want to continue doing this, you need to change this to a different
3894 key."
3895 :group 'org-agenda
3896 :type 'sexp)
3898 (defcustom org-agenda-diary-file 'diary-file
3899 "File to which to add new entries with the `i' key in agenda and calendar.
3900 When this is the symbol `diary-file', the functionality in the Emacs
3901 calendar will be used to add entries to the `diary-file'. But when this
3902 points to a file, `org-agenda-diary-entry' will be used instead."
3903 :group 'org-agenda
3904 :type '(choice
3905 (const :tag "The standard Emacs diary file" diary-file)
3906 (file :tag "Special Org file diary entries")))
3908 (eval-after-load "calendar"
3909 '(progn
3910 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3911 'org-calendar-goto-agenda)
3912 (add-hook 'calendar-mode-hook
3913 (lambda ()
3914 (unless (eq org-agenda-diary-file 'diary-file)
3915 (define-key calendar-mode-map
3916 org-calendar-insert-diary-entry-key
3917 'org-agenda-diary-entry))))))
3919 (defgroup org-latex nil
3920 "Options for embedding LaTeX code into Org-mode."
3921 :tag "Org LaTeX"
3922 :group 'org)
3924 (defcustom org-format-latex-options
3925 '(:foreground default :background default :scale 1.0
3926 :html-foreground "Black" :html-background "Transparent"
3927 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3928 "Options for creating images from LaTeX fragments.
3929 This is a property list with the following properties:
3930 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3931 `default' means use the foreground of the default face.
3932 `auto' means use the foreground from the text face.
3933 :background the background color, or \"Transparent\".
3934 `default' means use the background of the default face.
3935 `auto' means use the background from the text face.
3936 :scale a scaling factor for the size of the images, to get more pixels
3937 :html-foreground, :html-background, :html-scale
3938 the same numbers for HTML export.
3939 :matchers a list indicating which matchers should be used to
3940 find LaTeX fragments. Valid members of this list are:
3941 \"begin\" find environments
3942 \"$1\" find single characters surrounded by $.$
3943 \"$\" find math expressions surrounded by $...$
3944 \"$$\" find math expressions surrounded by $$....$$
3945 \"\\(\" find math expressions surrounded by \\(...\\)
3946 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3947 :group 'org-latex
3948 :type 'plist)
3950 (defcustom org-format-latex-signal-error t
3951 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3952 When nil, just push out a message."
3953 :group 'org-latex
3954 :version "24.1"
3955 :type 'boolean)
3957 (defcustom org-latex-to-mathml-jar-file nil
3958 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3959 Use this to specify additional executable file say a jar file.
3961 When using MathToWeb as the converter, specify the full-path to
3962 your mathtoweb.jar file."
3963 :group 'org-latex
3964 :version "24.1"
3965 :type '(choice
3966 (const :tag "None" nil)
3967 (file :tag "JAR file" :must-match t)))
3969 (defcustom org-latex-to-mathml-convert-command nil
3970 "Command to convert LaTeX fragments to MathML.
3971 Replace format-specifiers in the command as noted below and use
3972 `shell-command' to convert LaTeX to MathML.
3973 %j: Executable file in fully expanded form as specified by
3974 `org-latex-to-mathml-jar-file'.
3975 %I: Input LaTeX file in fully expanded form.
3976 %i: The latex fragment to be converted.
3977 %o: Output MathML file.
3979 This command is used by `org-create-math-formula'.
3981 When using MathToWeb as the converter, set this option to
3982 \"java -jar %j -unicode -force -df %o %I\".
3984 When using LaTeXML set this option to
3985 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3986 :group 'org-latex
3987 :version "24.1"
3988 :type '(choice
3989 (const :tag "None" nil)
3990 (string :tag "\nShell command")))
3992 (defcustom org-latex-create-formula-image-program 'dvipng
3993 "Program to convert LaTeX fragments with.
3995 dvipng Process the LaTeX fragments to dvi file, then convert
3996 dvi files to png files using dvipng.
3997 This will also include processing of non-math environments.
3998 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3999 to convert pdf files to png files"
4000 :group 'org-latex
4001 :version "24.1"
4002 :type '(choice
4003 (const :tag "dvipng" dvipng)
4004 (const :tag "imagemagick" imagemagick)))
4006 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4007 "Path to store latex preview images.
4008 A relative path here creates many directories relative to the
4009 processed org files paths. An absolute path puts all preview
4010 images at the same place."
4011 :group 'org-latex
4012 :version "24.3"
4013 :type 'string)
4015 (defun org-format-latex-mathml-available-p ()
4016 "Return t if `org-latex-to-mathml-convert-command' is usable."
4017 (save-match-data
4018 (when (and (boundp 'org-latex-to-mathml-convert-command)
4019 org-latex-to-mathml-convert-command)
4020 (let ((executable (car (split-string
4021 org-latex-to-mathml-convert-command))))
4022 (when (executable-find executable)
4023 (if (string-match
4024 "%j" org-latex-to-mathml-convert-command)
4025 (file-readable-p org-latex-to-mathml-jar-file)
4026 t))))))
4028 (defcustom org-format-latex-header "\\documentclass{article}
4029 \\usepackage[usenames]{color}
4030 \[PACKAGES]
4031 \[DEFAULT-PACKAGES]
4032 \\pagestyle{empty} % do not remove
4033 % The settings below are copied from fullpage.sty
4034 \\setlength{\\textwidth}{\\paperwidth}
4035 \\addtolength{\\textwidth}{-3cm}
4036 \\setlength{\\oddsidemargin}{1.5cm}
4037 \\addtolength{\\oddsidemargin}{-2.54cm}
4038 \\setlength{\\evensidemargin}{\\oddsidemargin}
4039 \\setlength{\\textheight}{\\paperheight}
4040 \\addtolength{\\textheight}{-\\headheight}
4041 \\addtolength{\\textheight}{-\\headsep}
4042 \\addtolength{\\textheight}{-\\footskip}
4043 \\addtolength{\\textheight}{-3cm}
4044 \\setlength{\\topmargin}{1.5cm}
4045 \\addtolength{\\topmargin}{-2.54cm}"
4046 "The document header used for processing LaTeX fragments.
4047 It is imperative that this header make sure that no page number
4048 appears on the page. The package defined in the variables
4049 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4050 will either replace the placeholder \"[PACKAGES]\" in this
4051 header, or they will be appended."
4052 :group 'org-latex
4053 :type 'string)
4055 (defun org-set-packages-alist (var val)
4056 "Set the packages alist and make sure it has 3 elements per entry."
4057 (set var (mapcar (lambda (x)
4058 (if (and (consp x) (= (length x) 2))
4059 (list (car x) (nth 1 x) t)
4061 val)))
4063 (defun org-get-packages-alist (var)
4064 "Get the packages alist and make sure it has 3 elements per entry."
4065 (mapcar (lambda (x)
4066 (if (and (consp x) (= (length x) 2))
4067 (list (car x) (nth 1 x) t)
4069 (default-value var)))
4071 (defcustom org-latex-default-packages-alist
4072 '(("AUTO" "inputenc" t)
4073 ("T1" "fontenc" t)
4074 ("" "fixltx2e" nil)
4075 ("" "graphicx" t)
4076 ("" "grffile" t)
4077 ("" "longtable" nil)
4078 ("" "wrapfig" nil)
4079 ("" "rotating" nil)
4080 ("normalem" "ulem" t)
4081 ("" "amsmath" t)
4082 ("" "textcomp" t)
4083 ("" "amssymb" t)
4084 ("" "capt-of" nil)
4085 ("" "hyperref" nil))
4086 "Alist of default packages to be inserted in the header.
4088 Change this only if one of the packages here causes an
4089 incompatibility with another package you are using.
4091 The packages in this list are needed by one part or another of
4092 Org mode to function properly:
4094 - inputenc, fontenc: for basic font and character selection
4095 - fixltx2e: Important patches of LaTeX itself
4096 - graphicx: for including images
4097 - grffile: allow periods and spaces in graphics file names
4098 - longtable: For multipage tables
4099 - wrapfig: for figure placement
4100 - rotating: for sideways figures and tables
4101 - ulem: for underline and strike-through
4102 - amsmath: for subscript and superscript and math environments
4103 - textcomp, amssymb: for various symbols used
4104 for interpreting the entities in `org-entities'. You can skip
4105 some of these packages if you don't use any of their symbols.
4106 - capt-of: for captions outside of floats
4107 - hyperref: for cross references
4109 Therefore you should not modify this variable unless you know
4110 what you are doing. The one reason to change it anyway is that
4111 you might be loading some other package that conflicts with one
4112 of the default packages. Each element is either a cell or
4113 a string.
4115 A cell is of the format
4117 \(\"options\" \"package\" SNIPPET-FLAG)
4119 If SNIPPET-FLAG is non-nil, the package also needs to be included
4120 when compiling LaTeX snippets into images for inclusion into
4121 non-LaTeX output.
4123 A string will be inserted as-is in the header of the document."
4124 :group 'org-latex
4125 :group 'org-export-latex
4126 :set 'org-set-packages-alist
4127 :get 'org-get-packages-alist
4128 :version "25.1"
4129 :package-version '(Org . "8.3")
4130 :type '(repeat
4131 (choice
4132 (list :tag "options/package pair"
4133 (string :tag "options")
4134 (string :tag "package")
4135 (boolean :tag "Snippet"))
4136 (string :tag "A line of LaTeX"))))
4138 (defcustom org-latex-packages-alist nil
4139 "Alist of packages to be inserted in every LaTeX header.
4141 These will be inserted after `org-latex-default-packages-alist'.
4142 Each element is either a cell or a string.
4144 A cell is of the format:
4146 \(\"options\" \"package\" SNIPPET-FLAG)
4148 SNIPPET-FLAG, when non-nil, indicates that this package is also
4149 needed when turning LaTeX snippets into images for inclusion into
4150 non-LaTeX output.
4152 A string will be inserted as-is in the header of the document.
4154 Make sure that you only list packages here which:
4156 - you want in every file;
4157 - do not conflict with the setup in `org-format-latex-header';
4158 - do not conflict with the default packages in
4159 `org-latex-default-packages-alist'."
4160 :group 'org-latex
4161 :group 'org-export-latex
4162 :set 'org-set-packages-alist
4163 :get 'org-get-packages-alist
4164 :type '(repeat
4165 (choice
4166 (list :tag "options/package pair"
4167 (string :tag "options")
4168 (string :tag "package")
4169 (boolean :tag "Snippet"))
4170 (string :tag "A line of LaTeX"))))
4172 (defgroup org-appearance nil
4173 "Settings for Org-mode appearance."
4174 :tag "Org Appearance"
4175 :group 'org)
4177 (defcustom org-level-color-stars-only nil
4178 "Non-nil means fontify only the stars in each headline.
4179 When nil, the entire headline is fontified.
4180 Changing it requires restart of `font-lock-mode' to become effective
4181 also in regions already fontified."
4182 :group 'org-appearance
4183 :type 'boolean)
4185 (defcustom org-hide-leading-stars nil
4186 "Non-nil means hide the first N-1 stars in a headline.
4187 This works by using the face `org-hide' for these stars. This
4188 face is white for a light background, and black for a dark
4189 background. You may have to customize the face `org-hide' to
4190 make this work.
4191 Changing it requires restart of `font-lock-mode' to become effective
4192 also in regions already fontified.
4193 You may also set this on a per-file basis by adding one of the following
4194 lines to the buffer:
4196 #+STARTUP: hidestars
4197 #+STARTUP: showstars"
4198 :group 'org-appearance
4199 :type 'boolean)
4201 (defcustom org-hidden-keywords nil
4202 "List of symbols corresponding to keywords to be hidden the org buffer.
4203 For example, a value '(title) for this list will make the document's title
4204 appear in the buffer without the initial #+TITLE: keyword."
4205 :group 'org-appearance
4206 :version "24.1"
4207 :type '(set (const :tag "#+AUTHOR" author)
4208 (const :tag "#+DATE" date)
4209 (const :tag "#+EMAIL" email)
4210 (const :tag "#+TITLE" title)))
4212 (defcustom org-custom-properties nil
4213 "List of properties (as strings) with a special meaning.
4214 The default use of these custom properties is to let the user
4215 hide them with `org-toggle-custom-properties-visibility'."
4216 :group 'org-properties
4217 :group 'org-appearance
4218 :version "24.3"
4219 :type '(repeat (string :tag "Property Name")))
4221 (defcustom org-fontify-done-headline nil
4222 "Non-nil means change the face of a headline if it is marked DONE.
4223 Normally, only the TODO/DONE keyword indicates the state of a headline.
4224 When this is non-nil, the headline after the keyword is set to the
4225 `org-headline-done' as an additional indication."
4226 :group 'org-appearance
4227 :type 'boolean)
4229 (defcustom org-fontify-emphasized-text t
4230 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4231 Changing this variable requires a restart of Emacs to take effect."
4232 :group 'org-appearance
4233 :type 'boolean)
4235 (defcustom org-fontify-whole-heading-line nil
4236 "Non-nil means fontify the whole line for headings.
4237 This is useful when setting a background color for the
4238 org-level-* faces."
4239 :group 'org-appearance
4240 :type 'boolean)
4242 (defcustom org-highlight-latex-and-related nil
4243 "Non-nil means highlight LaTeX related syntax in the buffer.
4244 When non nil, the value should be a list containing any of the
4245 following symbols:
4246 `latex' Highlight LaTeX snippets and environments.
4247 `script' Highlight subscript and superscript.
4248 `entities' Highlight entities."
4249 :group 'org-appearance
4250 :version "24.4"
4251 :package-version '(Org . "8.0")
4252 :type '(choice
4253 (const :tag "No highlighting" nil)
4254 (set :greedy t :tag "Highlight"
4255 (const :tag "LaTeX snippets and environments" latex)
4256 (const :tag "Subscript and superscript" script)
4257 (const :tag "Entities" entities))))
4259 (defcustom org-hide-emphasis-markers nil
4260 "Non-nil mean font-lock should hide the emphasis marker characters."
4261 :group 'org-appearance
4262 :type 'boolean)
4264 (defcustom org-hide-macro-markers nil
4265 "Non-nil mean font-lock should hide the brackets marking macro calls."
4266 :group 'org-appearance
4267 :type 'boolean)
4269 (defcustom org-pretty-entities nil
4270 "Non-nil means show entities as UTF8 characters.
4271 When nil, the \\name form remains in the buffer."
4272 :group 'org-appearance
4273 :version "24.1"
4274 :type 'boolean)
4276 (defcustom org-pretty-entities-include-sub-superscripts t
4277 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4278 :group 'org-appearance
4279 :version "24.1"
4280 :type 'boolean)
4282 (defvar org-emph-re nil
4283 "Regular expression for matching emphasis.
4284 After a match, the match groups contain these elements:
4285 0 The match of the full regular expression, including the characters
4286 before and after the proper match
4287 1 The character before the proper match, or empty at beginning of line
4288 2 The proper match, including the leading and trailing markers
4289 3 The leading marker like * or /, indicating the type of highlighting
4290 4 The text between the emphasis markers, not including the markers
4291 5 The character after the match, empty at the end of a line")
4292 (defvar org-verbatim-re nil
4293 "Regular expression for matching verbatim text.")
4294 (defvar org-emphasis-regexp-components) ; defined just below
4295 (defvar org-emphasis-alist) ; defined just below
4296 (defun org-set-emph-re (var val)
4297 "Set variable and compute the emphasis regular expression."
4298 (set var val)
4299 (when (and (boundp 'org-emphasis-alist)
4300 (boundp 'org-emphasis-regexp-components)
4301 org-emphasis-alist org-emphasis-regexp-components)
4302 (let* ((e org-emphasis-regexp-components)
4303 (pre (car e))
4304 (post (nth 1 e))
4305 (border (nth 2 e))
4306 (body (nth 3 e))
4307 (nl (nth 4 e))
4308 (body1 (concat body "*?"))
4309 (markers (mapconcat 'car org-emphasis-alist ""))
4310 (vmarkers (mapconcat
4311 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4312 org-emphasis-alist "")))
4313 ;; make sure special characters appear at the right position in the class
4314 (if (string-match "\\^" markers)
4315 (setq markers (concat (replace-match "" t t markers) "^")))
4316 (if (string-match "-" markers)
4317 (setq markers (concat (replace-match "" t t markers) "-")))
4318 (if (string-match "\\^" vmarkers)
4319 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4320 (if (string-match "-" vmarkers)
4321 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4322 (if (> nl 0)
4323 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4324 (int-to-string nl) "\\}")))
4325 ;; Make the regexp
4326 (setq org-emph-re
4327 (concat "\\([" pre "]\\|^\\)"
4328 "\\("
4329 "\\([" markers "]\\)"
4330 "\\("
4331 "[^" border "]\\|"
4332 "[^" border "]"
4333 body1
4334 "[^" border "]"
4335 "\\)"
4336 "\\3\\)"
4337 "\\([" post "]\\|$\\)"))
4338 (setq org-verbatim-re
4339 (concat "\\([" pre "]\\|^\\)"
4340 "\\("
4341 "\\([" vmarkers "]\\)"
4342 "\\("
4343 "[^" border "]\\|"
4344 "[^" border "]"
4345 body1
4346 "[^" border "]"
4347 "\\)"
4348 "\\3\\)"
4349 "\\([" post "]\\|$\\)")))))
4351 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4352 ;; set this option proved cumbersome. See this message/thread:
4353 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4354 (defvar org-emphasis-regexp-components
4355 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4356 "Components used to build the regular expression for emphasis.
4357 This is a list with five entries. Terminology: In an emphasis string
4358 like \" *strong word* \", we call the initial space PREMATCH, the final
4359 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4360 and \"trong wor\" is the body. The different components in this variable
4361 specify what is allowed/forbidden in each part:
4363 pre Chars allowed as prematch. Beginning of line will be allowed too.
4364 post Chars allowed as postmatch. End of line will be allowed too.
4365 border The chars *forbidden* as border characters.
4366 body-regexp A regexp like \".\" to match a body character. Don't use
4367 non-shy groups here, and don't allow newline here.
4368 newline The maximum number of newlines allowed in an emphasis exp.
4370 You need to reload Org or to restart Emacs after customizing this.")
4372 (defcustom org-emphasis-alist
4373 `(("*" bold)
4374 ("/" italic)
4375 ("_" underline)
4376 ("=" org-verbatim verbatim)
4377 ("~" org-code verbatim)
4378 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4379 "Alist of characters and faces to emphasize text.
4380 Text starting and ending with a special character will be emphasized,
4381 for example *bold*, _underlined_ and /italic/. This variable sets the
4382 marker characters and the face to be used by font-lock for highlighting
4383 in Org-mode Emacs buffers.
4385 You need to reload Org or to restart Emacs after customizing this."
4386 :group 'org-appearance
4387 :set 'org-set-emph-re
4388 :version "24.4"
4389 :package-version '(Org . "8.0")
4390 :type '(repeat
4391 (list
4392 (string :tag "Marker character")
4393 (choice
4394 (face :tag "Font-lock-face")
4395 (plist :tag "Face property list"))
4396 (option (const verbatim)))))
4398 (defvar org-protecting-blocks
4399 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4400 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4401 This is needed for font-lock setup.")
4403 ;;; Miscellaneous options
4405 (defgroup org-completion nil
4406 "Completion in Org-mode."
4407 :tag "Org Completion"
4408 :group 'org)
4410 (defcustom org-completion-use-ido nil
4411 "Non-nil means use ido completion wherever possible.
4412 Note that `ido-mode' must be active for this variable to be relevant.
4413 If you decide to turn this variable on, you might well want to turn off
4414 `org-outline-path-complete-in-steps'.
4415 See also `org-completion-use-iswitchb'."
4416 :group 'org-completion
4417 :type 'boolean)
4419 (defcustom org-completion-use-iswitchb nil
4420 "Non-nil means use iswitchb completion wherever possible.
4421 Note that `iswitchb-mode' must be active for this variable to be relevant.
4422 If you decide to turn this variable on, you might well want to turn off
4423 `org-outline-path-complete-in-steps'.
4424 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4425 :group 'org-completion
4426 :type 'boolean)
4428 (defcustom org-completion-fallback-command 'hippie-expand
4429 "The expansion command called by \\[pcomplete] in normal context.
4430 Normal means, no org-mode-specific context."
4431 :group 'org-completion
4432 :type 'function)
4434 ;;; Functions and variables from their packages
4435 ;; Declared here to avoid compiler warnings
4437 ;; XEmacs only
4438 (defvar outline-mode-menu-heading)
4439 (defvar outline-mode-menu-show)
4440 (defvar outline-mode-menu-hide)
4441 (defvar zmacs-regions) ; XEmacs regions
4443 ;; Emacs only
4444 (defvar mark-active)
4446 ;; Various packages
4447 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4448 (declare-function calendar-forward-day "cal-move" (arg))
4449 (declare-function calendar-goto-date "cal-move" (date))
4450 (declare-function calendar-goto-today "cal-move" ())
4451 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4452 (defvar calc-embedded-close-formula)
4453 (defvar calc-embedded-open-formula)
4454 (declare-function cdlatex-tab "ext:cdlatex" ())
4455 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4456 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4457 (defvar font-lock-unfontify-region-function)
4458 (declare-function iswitchb-read-buffer "iswitchb"
4459 (prompt &optional default require-match start matches-set))
4460 (defvar iswitchb-temp-buflist)
4461 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4462 (defvar org-agenda-tags-todo-honor-ignore-options)
4463 (declare-function org-agenda-skip "org-agenda" ())
4464 (declare-function
4465 org-agenda-format-item "org-agenda"
4466 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4467 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4468 (declare-function org-agenda-change-all-lines "org-agenda"
4469 (newhead hdmarker &optional fixface just-this))
4470 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4471 (declare-function org-agenda-maybe-redo "org-agenda" ())
4472 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4473 (beg end))
4474 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4475 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4476 "org-agenda" (&optional end))
4477 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4478 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4479 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4480 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4481 (declare-function org-indent-mode "org-indent" (&optional arg))
4482 (declare-function parse-time-string "parse-time" (string))
4483 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4484 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4485 (defvar remember-data-file)
4486 (defvar texmathp-why)
4487 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4488 (declare-function table--at-cell-p "table" (position &optional object at-column))
4489 (declare-function calc-eval "calc" (str &optional separator &rest args))
4491 ;;;###autoload
4492 (defun turn-on-orgtbl ()
4493 "Unconditionally turn on `orgtbl-mode'."
4494 (require 'org-table)
4495 (orgtbl-mode 1))
4497 (defun org-at-table-p (&optional table-type)
4498 "Non-nil if the cursor is inside an Org table.
4499 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4500 If `org-enable-table-editor' is nil, return nil unconditionally."
4501 (and
4502 org-enable-table-editor
4503 (save-excursion
4504 (beginning-of-line)
4505 (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4506 (or (not (derived-mode-p 'org-mode))
4507 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4508 (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4509 (defsubst org-table-p () (org-at-table-p))
4511 (defun org-at-table.el-p ()
4512 "Non-nil when point is at a table.el table."
4513 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4514 (let ((element (org-element-at-point)))
4515 (and (eq (org-element-type element) 'table)
4516 (eq (org-element-property :type element) 'table.el)))))
4518 (defun org-table-recognize-table.el ()
4519 "If there is a table.el table nearby, recognize it and move into it."
4520 (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4521 (beginning-of-line)
4522 (unless (or (looking-at org-table-dataline-regexp)
4523 (not (looking-at org-table1-hline-regexp)))
4524 (forward-line)
4525 (when (looking-at org-table-any-border-regexp)
4526 (forward-line -2)))
4527 (if (re-search-forward "|" (org-table-end t) t)
4528 (progn
4529 (require 'table)
4530 (if (table--at-cell-p (point)) t
4531 (message "recognizing table.el table...")
4532 (table-recognize-table)
4533 (message "recognizing table.el table...done")))
4534 (error "This should not happen"))))
4536 (defun org-at-table-hline-p ()
4537 "Non-nil when point is inside a hline in a table.
4538 Assume point is already in a table. If `org-enable-table-editor'
4539 is nil, return nil unconditionally."
4540 (and org-enable-table-editor
4541 (save-excursion
4542 (beginning-of-line)
4543 (looking-at org-table-hline-regexp))))
4545 (defun org-table-map-tables (function &optional quietly)
4546 "Apply FUNCTION to the start of all tables in the buffer."
4547 (save-excursion
4548 (save-restriction
4549 (widen)
4550 (goto-char (point-min))
4551 (while (re-search-forward org-table-any-line-regexp nil t)
4552 (unless quietly
4553 (message "Mapping tables: %d%%"
4554 (floor (* 100.0 (point)) (buffer-size))))
4555 (beginning-of-line 1)
4556 (when (and (looking-at org-table-line-regexp)
4557 ;; Exclude tables in src/example/verbatim/clocktable blocks
4558 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4559 (save-excursion (funcall function))
4560 (or (looking-at org-table-line-regexp)
4561 (forward-char 1)))
4562 (re-search-forward org-table-any-border-regexp nil 1))))
4563 (unless quietly (message "Mapping tables: done")))
4565 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4566 (declare-function org-clock-update-mode-line "org-clock" ())
4567 (declare-function org-resolve-clocks "org-clock"
4568 (&optional also-non-dangling-p prompt last-valid))
4570 (defun org-at-TBLFM-p (&optional pos)
4571 "Non-nil when point (or POS) is in #+TBLFM line."
4572 (save-excursion
4573 (goto-char (or pos (point)))
4574 (beginning-of-line)
4575 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4576 (eq (org-element-type (org-element-at-point)) 'table))))
4578 (defvar org-clock-start-time)
4579 (defvar org-clock-marker (make-marker)
4580 "Marker recording the last clock-in.")
4581 (defvar org-clock-hd-marker (make-marker)
4582 "Marker recording the last clock-in, but the headline position.")
4583 (defvar org-clock-heading ""
4584 "The heading of the current clock entry.")
4585 (defun org-clock-is-active ()
4586 "Return the buffer where the clock is currently running.
4587 Return nil if no clock is running."
4588 (marker-buffer org-clock-marker))
4590 (defun org-check-running-clock ()
4591 "Check if the current buffer contains the running clock.
4592 If yes, offer to stop it and to save the buffer with the changes."
4593 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4594 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4595 (buffer-name))))
4596 (org-clock-out)
4597 (when (y-or-n-p "Save changed buffer?")
4598 (save-buffer))))
4600 (defun org-clocktable-try-shift (dir n)
4601 "Check if this line starts a clock table, if yes, shift the time block."
4602 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4603 (org-clocktable-shift dir n)))
4605 ;;;###autoload
4606 (defun org-clock-persistence-insinuate ()
4607 "Set up hooks for clock persistence."
4608 (require 'org-clock)
4609 (add-hook 'org-mode-hook 'org-clock-load)
4610 (add-hook 'kill-emacs-hook 'org-clock-save))
4612 (defgroup org-archive nil
4613 "Options concerning archiving in Org-mode."
4614 :tag "Org Archive"
4615 :group 'org-structure)
4617 (defcustom org-archive-location "%s_archive::"
4618 "The location where subtrees should be archived.
4620 The value of this variable is a string, consisting of two parts,
4621 separated by a double-colon. The first part is a filename and
4622 the second part is a headline.
4624 When the filename is omitted, archiving happens in the same file.
4625 %s in the filename will be replaced by the current file
4626 name (without the directory part). Archiving to a different file
4627 is useful to keep archived entries from contributing to the
4628 Org-mode Agenda.
4630 The archived entries will be filed as subtrees of the specified
4631 headline. When the headline is omitted, the subtrees are simply
4632 filed away at the end of the file, as top-level entries. Also in
4633 the heading you can use %s to represent the file name, this can be
4634 useful when using the same archive for a number of different files.
4636 Here are a few examples:
4637 \"%s_archive::\"
4638 If the current file is Projects.org, archive in file
4639 Projects.org_archive, as top-level trees. This is the default.
4641 \"::* Archived Tasks\"
4642 Archive in the current file, under the top-level headline
4643 \"* Archived Tasks\".
4645 \"~/org/archive.org::\"
4646 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4648 \"~/org/archive.org::* From %s\"
4649 Archive in file ~/org/archive.org (absolute path), under headlines
4650 \"From FILENAME\" where file name is the current file name.
4652 \"~/org/datetree.org::datetree/* Finished Tasks\"
4653 The \"datetree/\" string is special, signifying to archive
4654 items to the datetree. Items are placed in either the CLOSED
4655 date of the item, or the current date if there is no CLOSED date.
4656 The heading will be a subentry to the current date. There doesn't
4657 need to be a heading, but there always needs to be a slash after
4658 datetree. For example, to store archived items directly in the
4659 datetree, use \"~/org/datetree.org::datetree/\".
4661 \"basement::** Finished Tasks\"
4662 Archive in file ./basement (relative path), as level 3 trees
4663 below the level 2 heading \"** Finished Tasks\".
4665 You may set this option on a per-file basis by adding to the buffer a
4666 line like
4668 #+ARCHIVE: basement::** Finished Tasks
4670 You may also define it locally for a subtree by setting an ARCHIVE property
4671 in the entry. If such a property is found in an entry, or anywhere up
4672 the hierarchy, it will be used."
4673 :group 'org-archive
4674 :type 'string)
4676 (defcustom org-agenda-skip-archived-trees t
4677 "Non-nil means the agenda will skip any items located in archived trees.
4678 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4679 variable is no longer recommended, you should leave it at the value t.
4680 Instead, use the key `v' to cycle the archives-mode in the agenda."
4681 :group 'org-archive
4682 :group 'org-agenda-skip
4683 :type 'boolean)
4685 (defcustom org-columns-skip-archived-trees t
4686 "Non-nil means ignore archived trees when creating column view."
4687 :group 'org-archive
4688 :group 'org-properties
4689 :type 'boolean)
4691 (defcustom org-cycle-open-archived-trees nil
4692 "Non-nil means `org-cycle' will open archived trees.
4693 An archived tree is a tree marked with the tag ARCHIVE.
4694 When nil, archived trees will stay folded. You can still open them with
4695 normal outline commands like `show-all', but not with the cycling commands."
4696 :group 'org-archive
4697 :group 'org-cycle
4698 :type 'boolean)
4700 (defcustom org-sparse-tree-open-archived-trees nil
4701 "Non-nil means sparse tree construction shows matches in archived trees.
4702 When nil, matches in these trees are highlighted, but the trees are kept in
4703 collapsed state."
4704 :group 'org-archive
4705 :group 'org-sparse-trees
4706 :type 'boolean)
4708 (defcustom org-sparse-tree-default-date-type nil
4709 "The default date type when building a sparse tree.
4710 When this is nil, a date is a scheduled or a deadline timestamp.
4711 Otherwise, these types are allowed:
4713 all: all timestamps
4714 active: only active timestamps (<...>)
4715 inactive: only inactive timestamps ([...])
4716 scheduled: only scheduled timestamps
4717 deadline: only deadline timestamps"
4718 :type '(choice (const :tag "Scheduled or deadline" nil)
4719 (const :tag "All timestamps" all)
4720 (const :tag "Only active timestamps" active)
4721 (const :tag "Only inactive timestamps" inactive)
4722 (const :tag "Only scheduled timestamps" scheduled)
4723 (const :tag "Only deadline timestamps" deadline)
4724 (const :tag "Only closed timestamps" closed))
4725 :version "25.1"
4726 :package-version '(Org . "8.3")
4727 :group 'org-sparse-trees)
4729 (defun org-cycle-hide-archived-subtrees (state)
4730 "Re-hide all archived subtrees after a visibility state change."
4731 (when (and (not org-cycle-open-archived-trees)
4732 (not (memq state '(overview folded))))
4733 (save-excursion
4734 (let* ((globalp (memq state '(contents all)))
4735 (beg (if globalp (point-min) (point)))
4736 (end (if globalp (point-max) (org-end-of-subtree t))))
4737 (org-hide-archived-subtrees beg end)
4738 (goto-char beg)
4739 (if (looking-at (concat ".*:" org-archive-tag ":"))
4740 (message "%s" (substitute-command-keys
4741 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4743 (defun org-force-cycle-archived ()
4744 "Cycle subtree even if it is archived."
4745 (interactive)
4746 (setq this-command 'org-cycle)
4747 (let ((org-cycle-open-archived-trees t))
4748 (call-interactively 'org-cycle)))
4750 (defun org-hide-archived-subtrees (beg end)
4751 "Re-hide all archived subtrees after a visibility state change."
4752 (org-with-wide-buffer
4753 (let ((case-fold-search nil)
4754 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4755 (goto-char beg)
4756 ;; Include headline point is currently on.
4757 (beginning-of-line)
4758 (while (and (< (point) end) (re-search-forward re end t))
4759 (when (member org-archive-tag (org-get-tags))
4760 (org-flag-subtree t)
4761 (org-end-of-subtree t))))))
4763 (declare-function outline-end-of-heading "outline" ())
4764 (declare-function outline-flag-region "outline" (from to flag))
4765 (defun org-flag-subtree (flag)
4766 (save-excursion
4767 (org-back-to-heading t)
4768 (outline-end-of-heading)
4769 (outline-flag-region (point)
4770 (progn (org-end-of-subtree t) (point))
4771 flag)))
4773 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4775 ;; Declare Column View Code
4777 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4778 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4779 (declare-function org-columns-compute "org-colview" (property))
4781 ;; Declare ID code
4783 (declare-function org-id-store-link "org-id")
4784 (declare-function org-id-locations-load "org-id")
4785 (declare-function org-id-locations-save "org-id")
4786 (defvar org-id-track-globally)
4788 ;;; Variables for pre-computed regular expressions, all buffer local
4790 (defvar org-todo-regexp nil
4791 "Matches any of the TODO state keywords.")
4792 (make-variable-buffer-local 'org-todo-regexp)
4793 (defvar org-not-done-regexp nil
4794 "Matches any of the TODO state keywords except the last one.")
4795 (make-variable-buffer-local 'org-not-done-regexp)
4796 (defvar org-not-done-heading-regexp nil
4797 "Matches a TODO headline that is not done.")
4798 (make-variable-buffer-local 'org-not-done-heading-regexp)
4799 (defvar org-todo-line-regexp nil
4800 "Matches a headline and puts TODO state into group 2 if present.")
4801 (make-variable-buffer-local 'org-todo-line-regexp)
4802 (defvar org-complex-heading-regexp nil
4803 "Matches a headline and puts everything into groups:
4804 group 1: the stars
4805 group 2: The todo keyword, maybe
4806 group 3: Priority cookie
4807 group 4: True headline
4808 group 5: Tags")
4809 (make-variable-buffer-local 'org-complex-heading-regexp)
4810 (defvar org-complex-heading-regexp-format nil
4811 "Printf format to make regexp to match an exact headline.
4812 This regexp will match the headline of any node which has the
4813 exact headline text that is put into the format, but may have any
4814 TODO state, priority and tags.")
4815 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4816 (defvar org-todo-line-tags-regexp nil
4817 "Matches a headline and puts TODO state into group 2 if present.
4818 Also put tags into group 4 if tags are present.")
4819 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4821 (defconst org-plain-time-of-day-regexp
4822 (concat
4823 "\\(\\<[012]?[0-9]"
4824 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4825 "\\(--?"
4826 "\\(\\<[012]?[0-9]"
4827 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4828 "\\)?")
4829 "Regular expression to match a plain time or time range.
4830 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4831 groups carry important information:
4832 0 the full match
4833 1 the first time, range or not
4834 8 the second time, if it is a range.")
4836 (defconst org-plain-time-extension-regexp
4837 (concat
4838 "\\(\\<[012]?[0-9]"
4839 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4840 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4841 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4842 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4843 groups carry important information:
4844 0 the full match
4845 7 hours of duration
4846 9 minutes of duration")
4848 (defconst org-stamp-time-of-day-regexp
4849 (concat
4850 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4851 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4852 "\\(--?"
4853 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4854 "Regular expression to match a timestamp time or time range.
4855 After a match, the following groups carry important information:
4856 0 the full match
4857 1 date plus weekday, for back referencing to make sure both times are on the same day
4858 2 the first time, range or not
4859 4 the second time, if it is a range.")
4861 (defconst org-startup-options
4862 '(("fold" org-startup-folded t)
4863 ("overview" org-startup-folded t)
4864 ("nofold" org-startup-folded nil)
4865 ("showall" org-startup-folded nil)
4866 ("showeverything" org-startup-folded showeverything)
4867 ("content" org-startup-folded content)
4868 ("indent" org-startup-indented t)
4869 ("noindent" org-startup-indented nil)
4870 ("hidestars" org-hide-leading-stars t)
4871 ("showstars" org-hide-leading-stars nil)
4872 ("odd" org-odd-levels-only t)
4873 ("oddeven" org-odd-levels-only nil)
4874 ("align" org-startup-align-all-tables t)
4875 ("noalign" org-startup-align-all-tables nil)
4876 ("inlineimages" org-startup-with-inline-images t)
4877 ("noinlineimages" org-startup-with-inline-images nil)
4878 ("latexpreview" org-startup-with-latex-preview t)
4879 ("nolatexpreview" org-startup-with-latex-preview nil)
4880 ("customtime" org-display-custom-times t)
4881 ("logdone" org-log-done time)
4882 ("lognotedone" org-log-done note)
4883 ("nologdone" org-log-done nil)
4884 ("lognoteclock-out" org-log-note-clock-out t)
4885 ("nolognoteclock-out" org-log-note-clock-out nil)
4886 ("logrepeat" org-log-repeat state)
4887 ("lognoterepeat" org-log-repeat note)
4888 ("logdrawer" org-log-into-drawer t)
4889 ("nologdrawer" org-log-into-drawer nil)
4890 ("logstatesreversed" org-log-states-order-reversed t)
4891 ("nologstatesreversed" org-log-states-order-reversed nil)
4892 ("nologrepeat" org-log-repeat nil)
4893 ("logreschedule" org-log-reschedule time)
4894 ("lognotereschedule" org-log-reschedule note)
4895 ("nologreschedule" org-log-reschedule nil)
4896 ("logredeadline" org-log-redeadline time)
4897 ("lognoteredeadline" org-log-redeadline note)
4898 ("nologredeadline" org-log-redeadline nil)
4899 ("logrefile" org-log-refile time)
4900 ("lognoterefile" org-log-refile note)
4901 ("nologrefile" org-log-refile nil)
4902 ("fninline" org-footnote-define-inline t)
4903 ("nofninline" org-footnote-define-inline nil)
4904 ("fnlocal" org-footnote-section nil)
4905 ("fnauto" org-footnote-auto-label t)
4906 ("fnprompt" org-footnote-auto-label nil)
4907 ("fnconfirm" org-footnote-auto-label confirm)
4908 ("fnplain" org-footnote-auto-label plain)
4909 ("fnadjust" org-footnote-auto-adjust t)
4910 ("nofnadjust" org-footnote-auto-adjust nil)
4911 ("constcgs" constants-unit-system cgs)
4912 ("constSI" constants-unit-system SI)
4913 ("noptag" org-tag-persistent-alist nil)
4914 ("hideblocks" org-hide-block-startup t)
4915 ("nohideblocks" org-hide-block-startup nil)
4916 ("beamer" org-startup-with-beamer-mode t)
4917 ("entitiespretty" org-pretty-entities t)
4918 ("entitiesplain" org-pretty-entities nil))
4919 "Variable associated with STARTUP options for org-mode.
4920 Each element is a list of three items: the startup options (as written
4921 in the #+STARTUP line), the corresponding variable, and the value to set
4922 this variable to if the option is found. An optional forth element PUSH
4923 means to push this value onto the list in the variable.")
4925 (defcustom org-group-tags t
4926 "When non-nil (the default), use group tags.
4927 This can be turned on/off through `org-toggle-tags-groups'."
4928 :group 'org-tags
4929 :group 'org-startup
4930 :type 'boolean)
4932 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4934 (defun org-toggle-tags-groups ()
4935 "Toggle support for group tags.
4936 Support for group tags is controlled by the option
4937 `org-group-tags', which is non-nil by default."
4938 (interactive)
4939 (setq org-group-tags (not org-group-tags))
4940 (cond ((and (derived-mode-p 'org-agenda-mode)
4941 org-group-tags)
4942 (org-agenda-redo))
4943 ((derived-mode-p 'org-mode)
4944 (let ((org-inhibit-startup t)) (org-mode))))
4945 (message "Groups tags support has been turned %s"
4946 (if org-group-tags "on" "off")))
4948 (defun org-set-regexps-and-options (&optional tags-only)
4949 "Precompute regular expressions used in the current buffer.
4950 When optional argument TAGS-ONLY is non-nil, only compute tags
4951 related expressions."
4952 (when (derived-mode-p 'org-mode)
4953 (let ((alist (org--setup-collect-keywords
4954 (org-make-options-regexp
4955 (append '("FILETAGS" "TAGS" "SETUPFILE")
4956 (and (not tags-only)
4957 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4958 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4959 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4960 (org--setup-process-tags
4961 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4962 (unless tags-only
4963 ;; File properties.
4964 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4965 ;; Archive location.
4966 (let ((archive (cdr (assq 'archive alist))))
4967 (when archive (org-set-local 'org-archive-location archive)))
4968 ;; Category.
4969 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4970 (when cat
4971 (org-set-local 'org-category (intern cat))
4972 (org-set-local 'org-file-properties
4973 (org--update-property-plist
4974 "CATEGORY" cat org-file-properties))))
4975 ;; Columns.
4976 (let ((column (cdr (assq 'columns alist))))
4977 (when column (org-set-local 'org-columns-default-format column)))
4978 ;; Constants.
4979 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4980 ;; Link abbreviations.
4981 (let ((links (cdr (assq 'link alist))))
4982 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4983 ;; Priorities.
4984 (let ((priorities (cdr (assq 'priorities alist))))
4985 (when priorities
4986 (org-set-local 'org-highest-priority (nth 0 priorities))
4987 (org-set-local 'org-lowest-priority (nth 1 priorities))
4988 (org-set-local 'org-default-priority (nth 2 priorities))))
4989 ;; Scripts.
4990 (let ((scripts (assq 'scripts alist)))
4991 (when scripts
4992 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4993 ;; Startup options.
4994 (let ((startup (cdr (assq 'startup alist))))
4995 (dolist (option startup)
4996 (let ((entry (assoc-string option org-startup-options t)))
4997 (when entry
4998 (let ((var (nth 1 entry))
4999 (val (nth 2 entry)))
5000 (if (not (nth 3 entry)) (org-set-local var val)
5001 (unless (listp (symbol-value var))
5002 (org-set-local var nil))
5003 (add-to-list var val)))))))
5004 ;; TODO keywords.
5005 (org-set-local 'org-todo-kwd-alist nil)
5006 (org-set-local 'org-todo-key-alist nil)
5007 (org-set-local 'org-todo-key-trigger nil)
5008 (org-set-local 'org-todo-keywords-1 nil)
5009 (org-set-local 'org-done-keywords nil)
5010 (org-set-local 'org-todo-heads nil)
5011 (org-set-local 'org-todo-sets nil)
5012 (org-set-local 'org-todo-log-states nil)
5013 (let ((todo-sequences
5014 (or (nreverse (cdr (assq 'todo alist)))
5015 (let ((d (default-value 'org-todo-keywords)))
5016 (if (not (stringp (car d))) d
5017 ;; XXX: Backward compatibility code.
5018 (list (cons org-todo-interpretation d)))))))
5019 (dolist (sequence todo-sequences)
5020 (let* ((sequence (or (run-hook-with-args-until-success
5021 'org-todo-setup-filter-hook sequence)
5022 sequence))
5023 (sequence-type (car sequence))
5024 (keywords (cdr sequence))
5025 (sep (member "|" keywords))
5026 names alist)
5027 (dolist (k (remove "|" keywords))
5028 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5030 (error "Invalid TODO keyword %s" k))
5031 (let ((name (match-string 1 k))
5032 (key (match-string 2 k))
5033 (log (org-extract-log-state-settings k)))
5034 (push name names)
5035 (push (cons name (and key (string-to-char key))) alist)
5036 (when log (push log org-todo-log-states))))
5037 (let* ((names (nreverse names))
5038 (done (if sep (org-remove-keyword-keys (cdr sep))
5039 (last names)))
5040 (head (car names))
5041 (tail (list sequence-type head (car done) (org-last done))))
5042 (add-to-list 'org-todo-heads head 'append)
5043 (push names org-todo-sets)
5044 (setq org-done-keywords (append org-done-keywords done nil))
5045 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5046 (setq org-todo-key-alist
5047 (append org-todo-key-alist
5048 (and alist
5049 (append '((:startgroup))
5050 (nreverse alist)
5051 '((:endgroup))))))
5052 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5053 (setq org-todo-sets (nreverse org-todo-sets)
5054 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5055 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5056 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5057 ;; Compute the regular expressions and other local variables.
5058 ;; Using `org-outline-regexp-bol' would complicate them much,
5059 ;; because of the fixed white space at the end of that string.
5060 (if (not org-done-keywords)
5061 (setq org-done-keywords
5062 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5063 (setq org-not-done-keywords
5064 (org-delete-all org-done-keywords
5065 (copy-sequence org-todo-keywords-1))
5066 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5067 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5068 org-not-done-heading-regexp
5069 (format org-heading-keyword-regexp-format org-not-done-regexp)
5070 org-todo-line-regexp
5071 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5072 org-complex-heading-regexp
5073 (concat "^\\(\\*+\\)"
5074 "\\(?: +" org-todo-regexp "\\)?"
5075 "\\(?: +\\(\\[#.\\]\\)\\)?"
5076 "\\(?: +\\(.*?\\)\\)??"
5077 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5078 "[ \t]*$")
5079 org-complex-heading-regexp-format
5080 (concat "^\\(\\*+\\)"
5081 "\\(?: +" org-todo-regexp "\\)?"
5082 "\\(?: +\\(\\[#.\\]\\)\\)?"
5083 "\\(?: +"
5084 ;; Stats cookies can be stuck to body.
5085 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5086 "\\(%s\\)"
5087 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5088 "\\)"
5089 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5090 "[ \t]*$")
5091 org-todo-line-tags-regexp
5092 (concat "^\\(\\*+\\)"
5093 "\\(?: +" org-todo-regexp "\\)?"
5094 "\\(?: +\\(.*?\\)\\)??"
5095 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5096 "[ \t]*$"))
5097 (org-compute-latex-and-related-regexp)))))
5099 (defun org--setup-collect-keywords (regexp &optional files alist)
5100 "Return setup keywords values as an alist.
5102 REGEXP matches a subset of setup keywords. FILES is a list of
5103 file names already visited. It is used to avoid circular setup
5104 files. ALIST, when non-nil, is the alist computed so far.
5106 Return value contains the following keys: `archive', `category',
5107 `columns', `constants', `filetags', `link', `priorities',
5108 `property', `scripts', `startup', `tags' and `todo'."
5109 (org-with-wide-buffer
5110 (goto-char (point-min))
5111 (let ((case-fold-search t))
5112 (while (re-search-forward regexp nil t)
5113 (let ((element (org-element-at-point)))
5114 (when (eq (org-element-type element) 'keyword)
5115 (let ((key (org-element-property :key element))
5116 (value (org-element-property :value element)))
5117 (cond
5118 ((equal key "ARCHIVE")
5119 (when (org-string-nw-p value)
5120 (push (cons 'archive value) alist)))
5121 ((equal key "CATEGORY") (push (cons 'category value) alist))
5122 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5123 ((equal key "CONSTANTS")
5124 (let* ((constants (assq 'constants alist))
5125 (store (cdr constants)))
5126 (dolist (pair (org-split-string value))
5127 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5128 pair)
5129 (let* ((name (match-string 1 pair))
5130 (value (match-string 2 pair))
5131 (old (assoc name store)))
5132 (if old (setcdr old value)
5133 (push (cons name value) store)))))
5134 (if constants (setcdr constants store)
5135 (push (cons 'constants store) alist))))
5136 ((equal key "FILETAGS")
5137 (when (org-string-nw-p value)
5138 (let ((old (assq 'filetags alist))
5139 (new (apply #'nconc
5140 (mapcar (lambda (x) (org-split-string x ":"))
5141 (org-split-string value)))))
5142 (if old (setcdr old (append new (cdr old)))
5143 (push (cons 'filetags new) alist)))))
5144 ((equal key "LINK")
5145 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5146 (let ((links (assq 'link alist))
5147 (pair (cons (org-match-string-no-properties 1 value)
5148 (org-match-string-no-properties 2 value))))
5149 (if links (push pair (cdr links))
5150 (push (list 'link pair) alist)))))
5151 ((equal key "OPTIONS")
5152 (when (and (org-string-nw-p value)
5153 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5154 (push (cons 'scripts (read (match-string 1 value))) alist)))
5155 ((equal key "PRIORITIES")
5156 (push (cons 'priorities
5157 (let ((prio (org-split-string value)))
5158 (if (< (length prio) 3) '(?A ?C ?B)
5159 (mapcar #'string-to-char prio))))
5160 alist))
5161 ((equal key "PROPERTY")
5162 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5163 (let* ((property (assq 'property alist))
5164 (value (org--update-property-plist
5165 (org-match-string-no-properties 1 value)
5166 (org-match-string-no-properties 2 value)
5167 (cdr property))))
5168 (if property (setcdr property value)
5169 (push (cons 'property value) alist)))))
5170 ((equal key "STARTUP")
5171 (let ((startup (assq 'startup alist)))
5172 (if startup
5173 (setcdr startup
5174 (append (cdr startup) (org-split-string value)))
5175 (push (cons 'startup (org-split-string value)) alist))))
5176 ((equal key "TAGS")
5177 (let ((tag-cell (assq 'tags alist)))
5178 (if tag-cell
5179 (setcdr tag-cell
5180 (append (cdr tag-cell)
5181 '("\\n")
5182 (org-split-string value)))
5183 (push (cons 'tags (org-split-string value)) alist))))
5184 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5185 (let ((todo (assq 'todo alist))
5186 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5187 (org-split-string value))))
5188 (if todo (push value (cdr todo))
5189 (push (list 'todo value) alist))))
5190 ((equal key "SETUPFILE")
5191 (unless buffer-read-only ; Do not check in Gnus messages.
5192 (let ((f (and (org-string-nw-p value)
5193 (expand-file-name
5194 (org-remove-double-quotes value)))))
5195 (when (and f (file-readable-p f) (not (member f files)))
5196 (with-temp-buffer
5197 (insert-file-contents f)
5198 (setq alist
5199 ;; Fake Org mode to benefit from cache
5200 ;; without recurring needlessly.
5201 (let ((major-mode 'org-mode))
5202 (org--setup-collect-keywords
5203 regexp (cons f files) alist)))))))))))))))
5204 alist)
5206 (defun org--setup-process-tags (tags filetags)
5207 "Precompute variables used for tags.
5208 TAGS is a list of tags and tag group symbols, as strings.
5209 FILETAGS is a list of tags, as strings."
5210 ;; Process the file tags.
5211 (org-set-local 'org-file-tags
5212 (mapcar #'org-add-prop-inherited filetags))
5213 ;; Provide default tags if no local tags are found.
5214 (when (and (not tags) org-tag-alist)
5215 (setq tags
5216 (mapcar (lambda (tag)
5217 (case (car tag)
5218 (:startgroup "{")
5219 (:endgroup "}")
5220 (:startgrouptag "[")
5221 (:endgrouptag "]")
5222 (:grouptags ":")
5223 (:newline "\\n")
5224 (otherwise (concat (car tag)
5225 (and (characterp (cdr tag))
5226 (format "(%c)" (cdr tag)))))))
5227 org-tag-alist)))
5228 ;; Process the tags.
5229 (org-set-local 'org-tag-groups-alist nil)
5230 (org-set-local 'org-tag-alist nil)
5231 (let (group-flag)
5232 (while tags
5233 (let ((e (car tags)))
5234 (setq tags (cdr tags))
5235 (cond
5236 ((equal e "{")
5237 (push '(:startgroup) org-tag-alist)
5238 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5239 ((equal e "}")
5240 (push '(:endgroup) org-tag-alist)
5241 (setq group-flag nil))
5242 ((equal e "[")
5243 (push '(:startgrouptag) org-tag-alist)
5244 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5245 ((equal e "]")
5246 (push '(:endgrouptag) org-tag-alist)
5247 (setq group-flag nil))
5248 ((equal e ":")
5249 (push '(:grouptags) org-tag-alist)
5250 (setq group-flag 'append))
5251 ((equal e "\\n") (push '(:newline) org-tag-alist))
5252 ((string-match
5253 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5254 "\\|{.+?}\\)" ; regular expression
5255 "\\(?:(\\(.\\))\\)?\\'")) e)
5256 (let ((tag (match-string 1 e))
5257 (key (and (match-beginning 2)
5258 (string-to-char (match-string 2 e)))))
5259 (cond ((eq group-flag 'append)
5260 (setcar org-tag-groups-alist
5261 (append (car org-tag-groups-alist) (list tag))))
5262 (group-flag (push (list tag) org-tag-groups-alist)))
5263 ;; Push all tags in groups, no matter if they already exist.
5264 (unless (and (not group-flag) (assoc tag org-tag-alist))
5265 (push (cons tag key) org-tag-alist))))))))
5266 (setq org-tag-alist (nreverse org-tag-alist)))
5268 (defun org-file-contents (file &optional noerror)
5269 "Return the contents of FILE, as a string."
5270 (if (and file (file-readable-p file))
5271 (with-temp-buffer
5272 (insert-file-contents file)
5273 (buffer-string))
5274 (funcall (if noerror 'message 'error)
5275 "Cannot read file \"%s\"%s"
5276 file
5277 (let ((from (buffer-file-name (buffer-base-buffer))))
5278 (if from (concat " (referenced in file \"" from "\")") "")))))
5280 (defun org-extract-log-state-settings (x)
5281 "Extract the log state setting from a TODO keyword string.
5282 This will extract info from a string like \"WAIT(w@/!)\"."
5283 (let (kw key log1 log2)
5284 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5285 (setq kw (match-string 1 x)
5286 key (and (match-end 2) (match-string 2 x))
5287 log1 (and (match-end 3) (match-string 3 x))
5288 log2 (and (match-end 4) (match-string 4 x)))
5289 (and (or log1 log2)
5290 (list kw
5291 (and log1 (if (equal log1 "!") 'time 'note))
5292 (and log2 (if (equal log2 "!") 'time 'note)))))))
5294 (defun org-remove-keyword-keys (list)
5295 "Remove a pair of parenthesis at the end of each string in LIST."
5296 (mapcar (lambda (x)
5297 (if (string-match "(.*)$" x)
5298 (substring x 0 (match-beginning 0))
5300 list))
5302 (defun org-assign-fast-keys (alist)
5303 "Assign fast keys to a keyword-key alist.
5304 Respect keys that are already there."
5305 (let (new e (alt ?0))
5306 (while (setq e (pop alist))
5307 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5308 (cdr e)) ;; Key already assigned.
5309 (push e new)
5310 (let ((clist (string-to-list (downcase (car e))))
5311 (used (append new alist)))
5312 (when (= (car clist) ?@)
5313 (pop clist))
5314 (while (and clist (rassoc (car clist) used))
5315 (pop clist))
5316 (unless clist
5317 (while (rassoc alt used)
5318 (incf alt)))
5319 (push (cons (car e) (or (car clist) alt)) new))))
5320 (nreverse new)))
5322 ;;; Some variables used in various places
5324 (defvar org-window-configuration nil
5325 "Used in various places to store a window configuration.")
5326 (defvar org-selected-window nil
5327 "Used in various places to store a window configuration.")
5328 (defvar org-finish-function nil
5329 "Function to be called when `C-c C-c' is used.
5330 This is for getting out of special buffers like capture.")
5333 ;; FIXME: Occasionally check by commenting these, to make sure
5334 ;; no other functions uses these, forgetting to let-bind them.
5335 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5336 (defvar org-last-state)
5337 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5339 ;; Defined somewhere in this file, but used before definition.
5340 (defvar org-entities) ;; defined in org-entities.el
5341 (defvar org-struct-menu)
5342 (defvar org-org-menu)
5343 (defvar org-tbl-menu)
5345 ;;;; Define the Org-mode
5347 ;; We use a before-change function to check if a table might need
5348 ;; an update.
5349 (defvar org-table-may-need-update t
5350 "Indicates that a table might need an update.
5351 This variable is set by `org-before-change-function'.
5352 `org-table-align' sets it back to nil.")
5353 (defun org-before-change-function (beg end)
5354 "Every change indicates that a table might need an update."
5355 (setq org-table-may-need-update t))
5356 (defvar org-mode-map)
5357 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5358 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5359 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5360 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5361 (defvar org-table-buffer-is-an nil)
5363 (defvar bidi-paragraph-direction)
5364 (defvar buffer-face-mode-face)
5366 (require 'outline)
5367 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5368 (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"))
5369 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5371 ;; Other stuff we need.
5372 (require 'time-date)
5373 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5374 (require 'easymenu)
5375 (autoload 'easy-menu-add "easymenu")
5376 (require 'overlay)
5378 ;; (require 'org-macs) moved higher up in the file before it is first used
5379 (require 'org-entities)
5380 ;; (require 'org-compat) moved higher up in the file before it is first used
5381 (require 'org-faces)
5382 (require 'org-list)
5383 (require 'org-pcomplete)
5384 (require 'org-src)
5385 (require 'org-footnote)
5386 (require 'org-macro)
5388 ;; babel
5389 (require 'ob)
5391 ;;;###autoload
5392 (define-derived-mode org-mode outline-mode "Org"
5393 "Outline-based notes management and organizer, alias
5394 \"Carsten's outline-mode for keeping track of everything.\"
5396 Org-mode develops organizational tasks around a NOTES file which
5397 contains information about projects as plain text. Org-mode is
5398 implemented on top of outline-mode, which is ideal to keep the content
5399 of large files well structured. It supports ToDo items, deadlines and
5400 time stamps, which magically appear in the diary listing of the Emacs
5401 calendar. Tables are easily created with a built-in table editor.
5402 Plain text URL-like links connect to websites, emails (VM), Usenet
5403 messages (Gnus), BBDB entries, and any files related to the project.
5404 For printing and sharing of notes, an Org-mode file (or a part of it)
5405 can be exported as a structured ASCII or HTML file.
5407 The following commands are available:
5409 \\{org-mode-map}"
5411 ;; Get rid of Outline menus, they are not needed
5412 ;; Need to do this here because define-derived-mode sets up
5413 ;; the keymap so late. Still, it is a waste to call this each time
5414 ;; we switch another buffer into org-mode.
5415 (if (featurep 'xemacs)
5416 (when (boundp 'outline-mode-menu-heading)
5417 ;; Assume this is Greg's port, it uses easymenu
5418 (easy-menu-remove outline-mode-menu-heading)
5419 (easy-menu-remove outline-mode-menu-show)
5420 (easy-menu-remove outline-mode-menu-hide))
5421 (define-key org-mode-map [menu-bar headings] 'undefined)
5422 (define-key org-mode-map [menu-bar hide] 'undefined)
5423 (define-key org-mode-map [menu-bar show] 'undefined))
5425 (org-load-modules-maybe)
5426 (when (featurep 'xemacs)
5427 (easy-menu-add org-org-menu)
5428 (easy-menu-add org-tbl-menu))
5429 (org-install-agenda-files-menu)
5430 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5431 (add-to-invisibility-spec '(org-cwidth))
5432 (add-to-invisibility-spec '(org-hide-block . t))
5433 (when (featurep 'xemacs)
5434 (org-set-local 'line-move-ignore-invisible t))
5435 (org-set-local 'outline-regexp org-outline-regexp)
5436 (org-set-local 'outline-level 'org-outline-level)
5437 (setq bidi-paragraph-direction 'left-to-right)
5438 (when (and org-ellipsis
5439 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5440 (fboundp 'make-glyph-code))
5441 (unless org-display-table
5442 (setq org-display-table (make-display-table)))
5443 (set-display-table-slot
5444 org-display-table 4
5445 (vconcat (mapcar
5446 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5447 org-ellipsis)))
5448 (if (stringp org-ellipsis) org-ellipsis "..."))))
5449 (setq buffer-display-table org-display-table))
5450 (org-set-regexps-and-options)
5451 (org-set-font-lock-defaults)
5452 (when (and org-tag-faces (not org-tags-special-faces-re))
5453 ;; tag faces set outside customize.... force initialization.
5454 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5455 ;; Calc embedded
5456 (org-set-local 'calc-embedded-open-mode "# ")
5457 ;; Modify a few syntax entries
5458 (modify-syntax-entry ?@ "w")
5459 (modify-syntax-entry ?\" "\"")
5460 (modify-syntax-entry ?\\ "_")
5461 (modify-syntax-entry ?~ "_")
5462 (if org-startup-truncated (setq truncate-lines t))
5463 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5464 (org-set-local 'font-lock-unfontify-region-function
5465 'org-unfontify-region)
5466 ;; Activate before-change-function
5467 (org-set-local 'org-table-may-need-update t)
5468 (org-add-hook 'before-change-functions 'org-before-change-function nil
5469 'local)
5470 ;; Check for running clock before killing a buffer
5471 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5472 ;; Initialize macros templates.
5473 (org-macro-initialize-templates)
5474 ;; Initialize radio targets.
5475 (org-update-radio-target-regexp)
5476 ;; Indentation.
5477 (org-set-local 'indent-line-function 'org-indent-line)
5478 (org-set-local 'indent-region-function 'org-indent-region)
5479 ;; Filling and auto-filling.
5480 (org-setup-filling)
5481 ;; Comments.
5482 (org-setup-comments-handling)
5483 ;; Initialize cache.
5484 (org-element-cache-reset)
5485 ;; Beginning/end of defun
5486 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5487 (org-set-local 'end-of-defun-function
5488 (lambda ()
5489 (if (not (org-at-heading-p))
5490 (org-forward-element)
5491 (org-forward-element)
5492 (forward-char -1))))
5493 ;; Next error for sparse trees
5494 (org-set-local 'next-error-function 'org-occur-next-match)
5495 ;; Make sure dependence stuff works reliably, even for users who set it
5496 ;; too late :-(
5497 (if org-enforce-todo-dependencies
5498 (add-hook 'org-blocker-hook
5499 'org-block-todo-from-children-or-siblings-or-parent)
5500 (remove-hook 'org-blocker-hook
5501 'org-block-todo-from-children-or-siblings-or-parent))
5502 (if org-enforce-todo-checkbox-dependencies
5503 (add-hook 'org-blocker-hook
5504 'org-block-todo-from-checkboxes)
5505 (remove-hook 'org-blocker-hook
5506 'org-block-todo-from-checkboxes))
5508 ;; Align options lines
5509 (org-set-local
5510 'align-mode-rules-list
5511 '((org-in-buffer-settings
5512 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5513 (modes . '(org-mode)))))
5515 ;; Imenu
5516 (org-set-local 'imenu-create-index-function
5517 'org-imenu-get-tree)
5519 ;; Make isearch reveal context
5520 (if (or (featurep 'xemacs)
5521 (not (boundp 'outline-isearch-open-invisible-function)))
5522 ;; Emacs 21 and XEmacs make use of the hook
5523 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5524 ;; Emacs 22 deals with this through a special variable
5525 (org-set-local 'outline-isearch-open-invisible-function
5526 (lambda (&rest ignore) (org-show-context 'isearch))))
5528 ;; Setup the pcomplete hooks
5529 (set (make-local-variable 'pcomplete-command-completion-function)
5530 'org-pcomplete-initial)
5531 (set (make-local-variable 'pcomplete-command-name-function)
5532 'org-command-at-point)
5533 (set (make-local-variable 'pcomplete-default-completion-function)
5534 'ignore)
5535 (set (make-local-variable 'pcomplete-parse-arguments-function)
5536 'org-parse-arguments)
5537 (set (make-local-variable 'pcomplete-termination-string) "")
5538 (when (>= emacs-major-version 23)
5539 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5541 ;; If empty file that did not turn on org-mode automatically, make it to.
5542 (if (and org-insert-mode-line-in-empty-file
5543 (org-called-interactively-p 'any)
5544 (= (point-min) (point-max)))
5545 (insert "# -*- mode: org -*-\n\n"))
5546 (unless org-inhibit-startup
5547 (org-unmodified
5548 (and org-startup-with-beamer-mode (org-beamer-mode))
5549 (when org-startup-align-all-tables
5550 (org-table-map-tables 'org-table-align 'quietly))
5551 (when org-startup-with-inline-images
5552 (org-display-inline-images))
5553 (when org-startup-with-latex-preview
5554 (org-toggle-latex-fragment))
5555 (unless org-inhibit-startup-visibility-stuff
5556 (org-set-startup-visibility))
5557 (org-refresh-effort-properties)))
5558 ;; Try to set org-hide correctly
5559 (let ((foreground (org-find-invisible-foreground)))
5560 (if foreground
5561 (set-face-foreground 'org-hide foreground))))
5563 ;; Update `customize-package-emacs-version-alist'
5564 (add-to-list 'customize-package-emacs-version-alist
5565 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5566 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5567 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5569 (defvar org-mode-transpose-word-syntax-table
5570 (let ((st (make-syntax-table text-mode-syntax-table)))
5571 (mapc (lambda(c) (modify-syntax-entry
5572 (string-to-char (car c)) "w p" st))
5573 org-emphasis-alist)
5574 st))
5576 (when (fboundp 'abbrev-table-put)
5577 (abbrev-table-put org-mode-abbrev-table
5578 :parents (list text-mode-abbrev-table)))
5580 (defun org-find-invisible-foreground ()
5581 (let ((candidates (remove
5582 "unspecified-bg"
5583 (nconc
5584 (list (face-background 'default)
5585 (face-background 'org-default))
5586 (mapcar
5587 (lambda (alist)
5588 (when (boundp alist)
5589 (cdr (assoc 'background-color (symbol-value alist)))))
5590 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5591 (list (face-foreground 'org-hide))))))
5592 (car (remove nil candidates))))
5594 (defun org-current-time (&optional rounding-minutes past)
5595 "Current time, possibly rounded to ROUNDING-MINUTES.
5596 When ROUNDING-MINUTES is not an integer, fall back on the car of
5597 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5598 the rounding returns a past time."
5599 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5600 (car org-time-stamp-rounding-minutes)))
5601 (time (decode-time)) res)
5602 (if (< r 1)
5603 (current-time)
5604 (setq res
5605 (apply 'encode-time
5606 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5607 (nthcdr 2 time))))
5608 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5609 (seconds-to-time (- (org-float-time res) (* r 60)))
5610 res))))
5612 (defun org-today ()
5613 "Return today date, considering `org-extend-today-until'."
5614 (time-to-days
5615 (time-subtract (current-time)
5616 (list 0 (* 3600 org-extend-today-until) 0))))
5618 ;;;; Font-Lock stuff, including the activators
5620 (defvar org-mouse-map (make-sparse-keymap))
5621 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5622 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5623 (when org-mouse-1-follows-link
5624 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5625 (when org-tab-follows-link
5626 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5627 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5629 (require 'font-lock)
5631 (defconst org-non-link-chars "]\t\n\r<>")
5632 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5633 "file+sys" "news" "shell" "elisp" "doi" "message"
5634 "help"))
5635 (defvar org-link-types-re nil
5636 "Matches a link that has a url-like prefix like \"http:\"")
5637 (defvar org-link-re-with-space nil
5638 "Matches a link with spaces, optional angular brackets around it.")
5639 (defvar org-link-re-with-space2 nil
5640 "Matches a link with spaces, optional angular brackets around it.")
5641 (defvar org-link-re-with-space3 nil
5642 "Matches a link with spaces, only for internal part in bracket links.")
5643 (defvar org-angle-link-re nil
5644 "Matches link with angular brackets, spaces are allowed.")
5645 (defvar org-plain-link-re nil
5646 "Matches plain link, without spaces.")
5647 (defvar org-bracket-link-regexp nil
5648 "Matches a link in double brackets.")
5649 (defvar org-bracket-link-analytic-regexp nil
5650 "Regular expression used to analyze links.
5651 Here is what the match groups contain after a match:
5652 1: http:
5653 2: http
5654 3: path
5655 4: [desc]
5656 5: desc")
5657 (defvar org-bracket-link-analytic-regexp++ nil
5658 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5659 (defvar org-any-link-re nil
5660 "Regular expression matching any link.")
5662 (defconst org-match-sexp-depth 3
5663 "Number of stacked braces for sub/superscript matching.")
5665 (defun org-create-multibrace-regexp (left right n)
5666 "Create a regular expression which will match a balanced sexp.
5667 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5668 as single character strings.
5669 The regexp returned will match the entire expression including the
5670 delimiters. It will also define a single group which contains the
5671 match except for the outermost delimiters. The maximum depth of
5672 stacked delimiters is N. Escaping delimiters is not possible."
5673 (let* ((nothing (concat "[^" left right "]*?"))
5674 (or "\\|")
5675 (re nothing)
5676 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5677 (while (> n 1)
5678 (setq n (1- n)
5679 re (concat re or next)
5680 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5681 (concat left "\\(" re "\\)" right)))
5683 (defconst org-match-substring-regexp
5684 (concat
5685 "\\(\\S-\\)\\([_^]\\)\\("
5686 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5687 "\\|"
5688 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5689 "\\|"
5690 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5691 "The regular expression matching a sub- or superscript.")
5693 (defconst org-match-substring-with-braces-regexp
5694 (concat
5695 "\\(\\S-\\)\\([_^]\\)"
5696 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5697 "The regular expression matching a sub- or superscript, forcing braces.")
5699 (defun org-make-link-regexps ()
5700 "Update the link regular expressions.
5701 This should be called after the variable `org-link-types' has changed."
5702 (let ((types-re (regexp-opt org-link-types t)))
5703 (setq org-link-types-re
5704 (concat "\\`" types-re ":")
5705 org-link-re-with-space
5706 (concat "<?" types-re ":"
5707 "\\([^" org-non-link-chars " ]"
5708 "[^" org-non-link-chars "]*"
5709 "[^" org-non-link-chars " ]\\)>?")
5710 org-link-re-with-space2
5711 (concat "<?" types-re ":"
5712 "\\([^" org-non-link-chars " ]"
5713 "[^\t\n\r]*"
5714 "[^" org-non-link-chars " ]\\)>?")
5715 org-link-re-with-space3
5716 (concat "<?" types-re ":"
5717 "\\([^" org-non-link-chars " ]"
5718 "[^\t\n\r]*\\)")
5719 org-angle-link-re
5720 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
5721 types-re)
5722 org-plain-link-re
5723 (concat
5724 "\\<" types-re ":"
5725 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5726 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5727 org-bracket-link-regexp
5728 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5729 org-bracket-link-analytic-regexp
5730 (concat
5731 "\\[\\["
5732 "\\(" types-re ":\\)?"
5733 "\\([^]]+\\)"
5734 "\\]"
5735 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5736 "\\]")
5737 org-bracket-link-analytic-regexp++
5738 (concat
5739 "\\[\\["
5740 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5741 "\\([^]]+\\)"
5742 "\\]"
5743 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5744 "\\]")
5745 org-any-link-re
5746 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5747 org-angle-link-re "\\)\\|\\("
5748 org-plain-link-re "\\)"))))
5750 (org-make-link-regexps)
5752 (defvar org-emph-face nil)
5754 (defun org-do-emphasis-faces (limit)
5755 "Run through the buffer and emphasize strings."
5756 (let (rtn a)
5757 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5758 (let* ((border (char-after (match-beginning 3)))
5759 (bre (regexp-quote (char-to-string border))))
5760 (if (and (not (= border (char-after (match-beginning 4))))
5761 (not (save-match-data
5762 (string-match (concat bre ".*" bre)
5763 (replace-regexp-in-string
5764 "\n" " "
5765 (substring (match-string 2) 1 -1))))))
5766 (progn
5767 (setq rtn t)
5768 (setq a (assoc (match-string 3) org-emphasis-alist))
5769 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5770 'face
5771 (nth 1 a))
5772 (and (nth 2 a)
5773 (org-remove-flyspell-overlays-in
5774 (match-beginning 0) (match-end 0)))
5775 (add-text-properties (match-beginning 2) (match-end 2)
5776 '(font-lock-multiline t org-emphasis t))
5777 (when org-hide-emphasis-markers
5778 (add-text-properties (match-end 4) (match-beginning 5)
5779 '(invisible org-link))
5780 (add-text-properties (match-beginning 3) (match-end 3)
5781 '(invisible org-link))))))
5782 (goto-char (1+ (match-beginning 0))))
5783 rtn))
5785 (defun org-emphasize (&optional char)
5786 "Insert or change an emphasis, i.e. a font like bold or italic.
5787 If there is an active region, change that region to a new emphasis.
5788 If there is no region, just insert the marker characters and position
5789 the cursor between them.
5790 CHAR should be the marker character. If it is a space, it means to
5791 remove the emphasis of the selected region.
5792 If CHAR is not given (for example in an interactive call) it will be
5793 prompted for."
5794 (interactive)
5795 (let ((erc org-emphasis-regexp-components)
5796 (prompt "")
5797 (string "") beg end move c s)
5798 (if (org-region-active-p)
5799 (setq beg (region-beginning) end (region-end)
5800 string (buffer-substring beg end))
5801 (setq move t))
5803 (unless char
5804 (message "Emphasis marker or tag: [%s]"
5805 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5806 (setq char (read-char-exclusive)))
5807 (if (equal char ?\ )
5808 (setq s "" move nil)
5809 (unless (assoc (char-to-string char) org-emphasis-alist)
5810 (user-error "No such emphasis marker: \"%c\"" char))
5811 (setq s (char-to-string char)))
5812 (while (and (> (length string) 1)
5813 (equal (substring string 0 1) (substring string -1))
5814 (assoc (substring string 0 1) org-emphasis-alist))
5815 (setq string (substring string 1 -1)))
5816 (setq string (concat s string s))
5817 (if beg (delete-region beg end))
5818 (unless (or (bolp)
5819 (string-match (concat "[" (nth 0 erc) "\n]")
5820 (char-to-string (char-before (point)))))
5821 (insert " "))
5822 (unless (or (eobp)
5823 (string-match (concat "[" (nth 1 erc) "\n]")
5824 (char-to-string (char-after (point)))))
5825 (insert " ") (backward-char 1))
5826 (insert string)
5827 (and move (backward-char 1))))
5829 (defconst org-nonsticky-props
5830 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5832 (defsubst org-rear-nonsticky-at (pos)
5833 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5835 (defun org-activate-plain-links (limit)
5836 "Add link properties for plain links."
5837 (let (f hl)
5838 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5839 (not (member 'org-tag
5840 (get-text-property (1- (match-beginning 0)) 'face)))
5841 (not (org-in-src-block-p)))
5842 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5843 (setq f (get-text-property (match-beginning 0) 'face))
5844 (setq hl (org-match-string-no-properties 0))
5845 (if (or (eq f 'org-tag)
5846 (and (listp f) (memq 'org-tag f)))
5848 (add-text-properties (match-beginning 0) (match-end 0)
5849 (list 'mouse-face 'highlight
5850 'face 'org-link
5851 'htmlize-link `(:uri ,hl)
5852 'keymap org-mouse-map))
5853 (org-rear-nonsticky-at (match-end 0)))
5854 t)))
5856 (defun org-activate-code (limit)
5857 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5858 (progn
5859 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5860 (remove-text-properties (match-beginning 0) (match-end 0)
5861 '(display t invisible t intangible t))
5862 t)))
5864 (defcustom org-src-fontify-natively t
5865 "When non-nil, fontify code in code blocks."
5866 :type 'boolean
5867 :version "24.4"
5868 :package-version '(Org . "8.3")
5869 :group 'org-appearance
5870 :group 'org-babel)
5872 (defcustom org-allow-promoting-top-level-subtree nil
5873 "When non-nil, allow promoting a top level subtree.
5874 The leading star of the top level headline will be replaced
5875 by a #."
5876 :type 'boolean
5877 :version "24.1"
5878 :group 'org-appearance)
5880 (defun org-fontify-meta-lines-and-blocks (limit)
5881 (condition-case nil
5882 (org-fontify-meta-lines-and-blocks-1 limit)
5883 (error (message "org-mode fontification error"))))
5885 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5886 "Fontify #+ lines and blocks."
5887 (let ((case-fold-search t))
5888 (if (re-search-forward
5889 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5890 limit t)
5891 (let ((beg (match-beginning 0))
5892 (block-start (match-end 0))
5893 (block-end nil)
5894 (lang (match-string 7))
5895 (beg1 (line-beginning-position 2))
5896 (dc1 (downcase (match-string 2)))
5897 (dc3 (downcase (match-string 3)))
5898 end end1 quoting block-type ovl)
5899 (cond
5900 ((and (match-end 4) (equal dc3 "+begin"))
5901 ;; Truly a block
5902 (setq block-type (downcase (match-string 5))
5903 quoting (member block-type org-protecting-blocks))
5904 (when (re-search-forward
5905 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5906 nil t) ;; on purpose, we look further than LIMIT
5907 (setq end (min (point-max) (match-end 0))
5908 end1 (min (point-max) (1- (match-beginning 0))))
5909 (setq block-end (match-beginning 0))
5910 (when quoting
5911 (org-remove-flyspell-overlays-in beg1 end1)
5912 (remove-text-properties beg end
5913 '(display t invisible t intangible t)))
5914 (add-text-properties
5915 beg end '(font-lock-fontified t font-lock-multiline t))
5916 (add-text-properties beg beg1 '(face org-meta-line))
5917 (org-remove-flyspell-overlays-in beg beg1)
5918 (add-text-properties ; For end_src
5919 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5920 (org-remove-flyspell-overlays-in end1 end)
5921 (cond
5922 ((and lang (not (string= lang "")) org-src-fontify-natively)
5923 (org-src-font-lock-fontify-block lang block-start block-end)
5924 (add-text-properties beg1 block-end '(src-block t)))
5925 (quoting
5926 (add-text-properties beg1 (min (point-max) (1+ end1))
5927 '(face org-block))) ; end of source block
5928 ((not org-fontify-quote-and-verse-blocks))
5929 ((string= block-type "quote")
5930 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5931 ((string= block-type "verse")
5932 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5933 (add-text-properties beg beg1 '(face org-block-begin-line))
5934 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5935 '(face org-block-end-line))
5937 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5938 (org-remove-flyspell-overlays-in
5939 (match-beginning 0)
5940 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5941 (add-text-properties
5942 beg (match-end 3)
5943 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5944 '(font-lock-fontified t invisible t)
5945 '(font-lock-fontified t face org-document-info-keyword)))
5946 (add-text-properties
5947 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5948 (if (string-equal dc1 "+title:")
5949 '(font-lock-fontified t face org-document-title)
5950 '(font-lock-fontified t face org-document-info))))
5951 ((equal dc1 "+caption:")
5952 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5953 (remove-text-properties (match-beginning 0) (match-end 0)
5954 '(display t invisible t intangible t))
5955 (add-text-properties (match-beginning 1) (match-end 3)
5956 '(font-lock-fontified t face org-meta-line))
5957 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5958 '(font-lock-fontified t face org-block))
5960 ((member dc3 '(" " ""))
5961 (org-remove-flyspell-overlays-in beg (match-end 0))
5962 (add-text-properties
5963 beg (match-end 0)
5964 '(font-lock-fontified t face font-lock-comment-face)))
5965 (t ;; just any other in-buffer setting, but not indented
5966 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5967 (remove-text-properties (match-beginning 0) (match-end 0)
5968 '(display t invisible t intangible t))
5969 (add-text-properties beg (match-end 0)
5970 '(font-lock-fontified t face org-meta-line))
5971 t))))))
5973 (defun org-fontify-drawers (limit)
5974 "Fontify drawers."
5975 (when (re-search-forward org-drawer-regexp limit t)
5976 (add-text-properties
5977 (match-beginning 0) (match-end 0)
5978 '(font-lock-fontified t face org-special-keyword))
5979 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5982 (defun org-fontify-macros (limit)
5983 "Fontify macros."
5984 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5985 (add-text-properties
5986 (match-beginning 0) (match-end 0)
5987 '(font-lock-fontified t face org-macro))
5988 (when org-hide-macro-markers
5989 (add-text-properties (match-end 2) (match-beginning 2)
5990 '(invisible t))
5991 (add-text-properties (match-beginning 1) (match-end 1)
5992 '(invisible t)))
5993 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5996 (defun org-activate-angle-links (limit)
5997 "Add text properties for angle links."
5998 (if (and (re-search-forward org-angle-link-re limit t)
5999 (not (org-in-src-block-p)))
6000 (progn
6001 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6002 (add-text-properties (match-beginning 0) (match-end 0)
6003 (list 'mouse-face 'highlight
6004 'keymap org-mouse-map
6005 'font-lock-multiline t))
6006 (org-rear-nonsticky-at (match-end 0))
6007 t)))
6009 (defun org-activate-footnote-links (limit)
6010 "Add text properties for footnotes."
6011 (let ((fn (org-footnote-next-reference-or-definition limit)))
6012 (when fn
6013 (let* ((beg (nth 1 fn))
6014 (end (nth 2 fn))
6015 (label (car fn))
6016 (referencep (/= (line-beginning-position) beg)))
6017 (when (and referencep (nth 3 fn))
6018 (save-excursion
6019 (goto-char beg)
6020 (search-forward (or label "fn:"))
6021 (org-remove-flyspell-overlays-in beg (match-end 0))))
6022 (add-text-properties beg end
6023 (list 'mouse-face 'highlight
6024 'keymap org-mouse-map
6025 'help-echo
6026 (if referencep "Footnote reference"
6027 "Footnote definition")
6028 'font-lock-fontified t
6029 'font-lock-multiline t
6030 'face 'org-footnote))))))
6032 (defun org-activate-bracket-links (limit)
6033 "Add text properties for bracketed links."
6034 (if (and (re-search-forward org-bracket-link-regexp limit t)
6035 (not (org-in-src-block-p)))
6036 (let* ((hl (org-match-string-no-properties 1))
6037 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6038 (ip (org-maybe-intangible
6039 (list 'invisible 'org-link
6040 'keymap org-mouse-map 'mouse-face 'highlight
6041 'font-lock-multiline t 'help-echo help
6042 'htmlize-link `(:uri ,hl))))
6043 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6044 'font-lock-multiline t 'help-echo help
6045 'htmlize-link `(:uri ,hl))))
6046 ;; We need to remove the invisible property here. Table narrowing
6047 ;; may have made some of this invisible.
6048 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6049 (remove-text-properties (match-beginning 0) (match-end 0)
6050 '(invisible nil))
6051 (if (match-end 3)
6052 (progn
6053 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6054 (org-rear-nonsticky-at (match-beginning 3))
6055 (add-text-properties (match-beginning 3) (match-end 3) vp)
6056 (org-rear-nonsticky-at (match-end 3))
6057 (add-text-properties (match-end 3) (match-end 0) ip)
6058 (org-rear-nonsticky-at (match-end 0)))
6059 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6060 (org-rear-nonsticky-at (match-beginning 1))
6061 (add-text-properties (match-beginning 1) (match-end 1) vp)
6062 (org-rear-nonsticky-at (match-end 1))
6063 (add-text-properties (match-end 1) (match-end 0) ip)
6064 (org-rear-nonsticky-at (match-end 0)))
6065 t)))
6067 (defun org-activate-dates (limit)
6068 "Add text properties for dates."
6069 (if (and (re-search-forward org-tsr-regexp-both limit t)
6070 (not (equal (char-before (match-beginning 0)) 91)))
6071 (progn
6072 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6073 (add-text-properties (match-beginning 0) (match-end 0)
6074 (list 'mouse-face 'highlight
6075 'keymap org-mouse-map))
6076 (org-rear-nonsticky-at (match-end 0))
6077 (when org-display-custom-times
6078 (if (match-end 3)
6079 (org-display-custom-time (match-beginning 3) (match-end 3)))
6080 (org-display-custom-time (match-beginning 1) (match-end 1)))
6081 t)))
6083 (defvar org-target-link-regexp nil
6084 "Regular expression matching radio targets in plain text.")
6085 (make-variable-buffer-local 'org-target-link-regexp)
6087 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6088 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6089 border border border))
6090 "Regular expression matching a link target.")
6092 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6093 "Regular expression matching a radio target.")
6095 (defconst org-any-target-regexp
6096 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6097 "Regular expression matching any target.")
6099 (defun org-activate-target-links (limit)
6100 "Add text properties for target matches."
6101 (when org-target-link-regexp
6102 (let ((case-fold-search t))
6103 (if (re-search-forward org-target-link-regexp limit t)
6104 (progn
6105 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6106 (add-text-properties (match-beginning 1) (match-end 1)
6107 (list 'mouse-face 'highlight
6108 'keymap org-mouse-map
6109 'help-echo "Radio target link"
6110 'org-linked-text t))
6111 (org-rear-nonsticky-at (match-end 1))
6112 t)))))
6114 (defun org-update-radio-target-regexp ()
6115 "Find all radio targets in this file and update the regular expression.
6116 Also refresh fontification if needed."
6117 (interactive)
6118 (let ((old-regexp org-target-link-regexp)
6119 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6120 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6121 (targets
6122 (org-with-wide-buffer
6123 (goto-char (point-min))
6124 (let (rtn)
6125 (while (re-search-forward org-radio-target-regexp nil t)
6126 ;; Make sure point is really within the object.
6127 (backward-char)
6128 (let ((obj (org-element-context)))
6129 (when (eq (org-element-type obj) 'radio-target)
6130 (add-to-list 'rtn (org-element-property :value obj)))))
6131 rtn))))
6132 (setq org-target-link-regexp
6133 (and targets
6134 (concat before-re
6135 (mapconcat
6136 (lambda (x)
6137 (replace-regexp-in-string
6138 " +" "\\s-+" (regexp-quote x) t t))
6139 targets
6140 "\\|")
6141 after-re)))
6142 (unless (equal old-regexp org-target-link-regexp)
6143 ;; Clean-up cache.
6144 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6145 ((not org-target-link-regexp) old-regexp)
6147 (concat before-re
6148 (mapconcat
6149 (lambda (re)
6150 (substring re (length before-re)
6151 (- (length after-re))))
6152 (list old-regexp org-target-link-regexp)
6153 "\\|")
6154 after-re)))))
6155 (org-with-wide-buffer
6156 (goto-char (point-min))
6157 (while (re-search-forward regexp nil t)
6158 (org-element-cache-refresh (match-beginning 1)))))
6159 ;; Re fontify buffer.
6160 (when (memq 'radio org-highlight-links)
6161 (org-restart-font-lock)))))
6163 (defun org-hide-wide-columns (limit)
6164 (let (s e)
6165 (setq s (text-property-any (point) (or limit (point-max))
6166 'org-cwidth t))
6167 (when s
6168 (setq e (next-single-property-change s 'org-cwidth))
6169 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6170 (goto-char e)
6171 t)))
6173 (defvar org-latex-and-related-regexp nil
6174 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6176 (defun org-compute-latex-and-related-regexp ()
6177 "Compute regular expression for LaTeX, entities and sub/superscript.
6178 Result depends on variable `org-highlight-latex-and-related'."
6179 (org-set-local
6180 'org-latex-and-related-regexp
6181 (let* ((re-sub
6182 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6183 ((eq org-use-sub-superscripts '{})
6184 (list org-match-substring-with-braces-regexp))
6185 (org-use-sub-superscripts (list org-match-substring-regexp))))
6186 (re-latex
6187 (when (memq 'latex org-highlight-latex-and-related)
6188 (let ((matchers (plist-get org-format-latex-options :matchers)))
6189 (delq nil
6190 (mapcar (lambda (x)
6191 (and (member (car x) matchers) (nth 1 x)))
6192 org-latex-regexps)))))
6193 (re-entities
6194 (when (memq 'entities org-highlight-latex-and-related)
6195 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6196 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6198 (defun org-do-latex-and-related (limit)
6199 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6200 LIMIT bounds the search for syntax to highlight. Stop at first
6201 highlighted object, if any. Return t if some highlighting was
6202 done, nil otherwise."
6203 (when (org-string-nw-p org-latex-and-related-regexp)
6204 (catch 'found
6205 (while (re-search-forward org-latex-and-related-regexp limit t)
6206 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6207 'face))
6208 '(org-code org-verbatim underline))
6209 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6210 '(?_ ?^))
6212 0)))
6213 (font-lock-prepend-text-property
6214 (+ offset (match-beginning 0)) (match-end 0)
6215 'face 'org-latex-and-related)
6216 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6217 '(font-lock-multiline t)))
6218 (throw 'found t)))
6219 nil)))
6221 (defun org-restart-font-lock ()
6222 "Restart `font-lock-mode', to force refontification."
6223 (when (and (boundp 'font-lock-mode) font-lock-mode)
6224 (font-lock-mode -1)
6225 (font-lock-mode 1)))
6227 (defun org-activate-tags (limit)
6228 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6229 (progn
6230 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6231 (add-text-properties (match-beginning 1) (match-end 1)
6232 (list 'mouse-face 'highlight
6233 'keymap org-mouse-map))
6234 (org-rear-nonsticky-at (match-end 1))
6235 t)))
6237 (defun org-outline-level ()
6238 "Compute the outline level of the heading at point.
6240 If this is called at a normal headline, the level is the number
6241 of stars. Use `org-reduced-level' to remove the effect of
6242 `org-odd-levels'. Unlike to `org-current-level', this function
6243 takes into consideration inlinetasks."
6244 (org-with-wide-buffer
6245 (end-of-line)
6246 (if (re-search-backward org-outline-regexp-bol nil t)
6247 (1- (- (match-end 0) (match-beginning 0)))
6248 0)))
6250 (defvar org-font-lock-keywords nil)
6252 (defsubst org-re-property (property &optional literal allow-null value)
6253 "Return a regexp matching a PROPERTY line.
6255 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6256 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6257 non-nil, match properties even without a value.
6259 Match group 3 is set to the value when it exists. If there is no
6260 value and ALLOW-NULL is non-nil, it is set to the empty string.
6262 With optional argument VALUE, match only property lines with
6263 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6264 unless LITERAL is non-nil."
6265 (concat
6266 "^\\(?4:[ \t]*\\)"
6267 (format "\\(?1::\\(?2:%s\\):\\)"
6268 (if literal property (regexp-quote property)))
6269 (cond (value
6270 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6271 (if literal value (regexp-quote value))))
6272 (allow-null
6273 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6275 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6277 (defconst org-property-re
6278 (org-re-property "\\S-+" 'literal t)
6279 "Regular expression matching a property line.
6280 There are four matching groups:
6281 1: :PROPKEY: including the leading and trailing colon,
6282 2: PROPKEY without the leading and trailing colon,
6283 3: PROPVAL without leading or trailing spaces,
6284 4: the indentation of the current line,
6285 5: trailing whitespace.")
6287 (defvar org-font-lock-hook nil
6288 "Functions to be called for special font lock stuff.")
6290 (defvar org-font-lock-set-keywords-hook nil
6291 "Functions that can manipulate `org-font-lock-extra-keywords'.
6292 This is called after `org-font-lock-extra-keywords' is defined, but before
6293 it is installed to be used by font lock. This can be useful if something
6294 needs to be inserted at a specific position in the font-lock sequence.")
6296 (defun org-font-lock-hook (limit)
6297 "Run `org-font-lock-hook' within LIMIT."
6298 (run-hook-with-args 'org-font-lock-hook limit))
6300 (defun org-set-font-lock-defaults ()
6301 "Set font lock defaults for the current buffer."
6302 (let* ((em org-fontify-emphasized-text)
6303 (lk org-highlight-links)
6304 (org-font-lock-extra-keywords
6305 (list
6306 ;; Call the hook
6307 '(org-font-lock-hook)
6308 ;; Headlines
6309 `(,(if org-fontify-whole-heading-line
6310 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6311 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6312 (1 (org-get-level-face 1))
6313 (2 (org-get-level-face 2))
6314 (3 (org-get-level-face 3)))
6315 ;; Table lines
6316 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6317 (1 'org-table t))
6318 ;; Table internals
6319 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6320 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6321 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6322 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6323 ;; Drawers
6324 '(org-fontify-drawers)
6325 ;; Properties
6326 (list org-property-re
6327 '(1 'org-special-keyword t)
6328 '(3 'org-property-value t))
6329 ;; Links
6330 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6331 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6332 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6333 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6334 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6335 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6336 (if (memq 'footnote lk) '(org-activate-footnote-links))
6337 ;; Targets.
6338 (list org-any-target-regexp '(0 'org-target t))
6339 ;; Diary sexps.
6340 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6341 ;; Macro
6342 '(org-fontify-macros)
6343 '(org-hide-wide-columns (0 nil append))
6344 ;; TODO keyword
6345 (list (format org-heading-keyword-regexp-format
6346 org-todo-regexp)
6347 '(2 (org-get-todo-face 2) t))
6348 ;; DONE
6349 (if org-fontify-done-headline
6350 (list (format org-heading-keyword-regexp-format
6351 (concat
6352 "\\(?:"
6353 (mapconcat 'regexp-quote org-done-keywords "\\|")
6354 "\\)"))
6355 '(2 'org-headline-done t))
6356 nil)
6357 ;; Priorities
6358 '(org-font-lock-add-priority-faces)
6359 ;; Tags
6360 '(org-font-lock-add-tag-faces)
6361 ;; Tags groups
6362 (if (and org-group-tags org-tag-groups-alist)
6363 (list (concat org-outline-regexp-bol ".+\\(:"
6364 (regexp-opt (mapcar 'car org-tag-groups-alist))
6365 ":\\).*$")
6366 '(1 'org-tag-group prepend)))
6367 ;; Special keywords
6368 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6369 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6370 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6371 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6372 ;; Emphasis
6373 (if em
6374 (if (featurep 'xemacs)
6375 '(org-do-emphasis-faces (0 nil append))
6376 '(org-do-emphasis-faces)))
6377 ;; Checkboxes
6378 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6379 1 'org-checkbox prepend)
6380 (if (cdr (assq 'checkbox org-list-automatic-rules))
6381 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6382 (0 (org-get-checkbox-statistics-face) t)))
6383 ;; Description list items
6384 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6385 1 'org-list-dt prepend)
6386 ;; ARCHIVEd headings
6387 (list (concat
6388 org-outline-regexp-bol
6389 "\\(.*:" org-archive-tag ":.*\\)")
6390 '(1 'org-archived prepend))
6391 ;; Specials
6392 '(org-do-latex-and-related)
6393 '(org-fontify-entities)
6394 '(org-raise-scripts)
6395 ;; Code
6396 '(org-activate-code (1 'org-code t))
6397 ;; COMMENT
6398 (list (format
6399 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6400 org-todo-regexp
6401 org-comment-string)
6402 '(9 'org-special-keyword t))
6403 ;; Blocks and meta lines
6404 '(org-fontify-meta-lines-and-blocks))))
6405 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6406 (run-hooks 'org-font-lock-set-keywords-hook)
6407 ;; Now set the full font-lock-keywords
6408 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6409 (org-set-local 'font-lock-defaults
6410 '(org-font-lock-keywords t nil nil backward-paragraph))
6411 (kill-local-variable 'font-lock-keywords) nil))
6413 (defun org-toggle-pretty-entities ()
6414 "Toggle the composition display of entities as UTF8 characters."
6415 (interactive)
6416 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6417 (org-restart-font-lock)
6418 (if org-pretty-entities
6419 (message "Entities are now displayed as UTF8 characters")
6420 (save-restriction
6421 (widen)
6422 (org-decompose-region (point-min) (point-max))
6423 (message "Entities are now displayed as plain text"))))
6425 (defvar org-custom-properties-overlays nil
6426 "List of overlays used for custom properties.")
6427 (make-variable-buffer-local 'org-custom-properties-overlays)
6429 (defun org-toggle-custom-properties-visibility ()
6430 "Display or hide properties in `org-custom-properties'."
6431 (interactive)
6432 (if org-custom-properties-overlays
6433 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6434 (setq org-custom-properties-overlays nil))
6435 (when org-custom-properties
6436 (org-with-wide-buffer
6437 (goto-char (point-min))
6438 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6439 (while (re-search-forward regexp nil t)
6440 (let ((end (cdr (save-match-data (org-get-property-block)))))
6441 (when (and end (< (point) end))
6442 ;; Hide first custom property in current drawer.
6443 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6444 (overlay-put o 'invisible t)
6445 (overlay-put o 'org-custom-property t)
6446 (push o org-custom-properties-overlays))
6447 ;; Hide additional custom properties in the same drawer.
6448 (while (re-search-forward regexp end t)
6449 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6450 (overlay-put o 'invisible t)
6451 (overlay-put o 'org-custom-property t)
6452 (push o org-custom-properties-overlays)))))
6453 ;; Each entry is limited to a single property drawer.
6454 (outline-next-heading)))))))
6456 (defun org-fontify-entities (limit)
6457 "Find an entity to fontify."
6458 (let (ee)
6459 (when org-pretty-entities
6460 (catch 'match
6461 ;; "\_ "-family is left out on purpose. Only the first one,
6462 ;; i.e., "\_ ", could be fontified anyway, and it would be
6463 ;; confusing when adding a second white space character.
6464 (while (re-search-forward
6465 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6466 limit t)
6467 (if (and (not (org-at-comment-p))
6468 (setq ee (org-entity-get (match-string 1)))
6469 (= (length (nth 6 ee)) 1))
6470 (let*
6471 ((end (if (equal (match-string 2) "{}")
6472 (match-end 2)
6473 (match-end 1))))
6474 (add-text-properties
6475 (match-beginning 0) end
6476 (list 'font-lock-fontified t))
6477 (compose-region (match-beginning 0) end
6478 (nth 6 ee) nil)
6479 (backward-char 1)
6480 (throw 'match t))))
6481 nil))))
6483 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6484 "Fontify string S like in Org-mode."
6485 (with-temp-buffer
6486 (insert s)
6487 (let ((org-odd-levels-only odd-levels))
6488 (org-mode)
6489 (font-lock-ensure)
6490 (buffer-string))))
6492 (defvar org-m nil)
6493 (defvar org-l nil)
6494 (defvar org-f nil)
6495 (defun org-get-level-face (n)
6496 "Get the right face for match N in font-lock matching of headlines."
6497 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6498 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6499 (if org-cycle-level-faces
6500 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6501 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6502 (cond
6503 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6504 ((eq n 2) org-f)
6505 (t (if org-level-color-stars-only nil org-f))))
6507 (defun org-face-from-face-or-color (context inherit face-or-color)
6508 "Create a face list that inherits INHERIT, but sets the foreground color.
6509 When FACE-OR-COLOR is not a string, just return it."
6510 (if (stringp face-or-color)
6511 (list :inherit inherit
6512 (cdr (assoc context org-faces-easy-properties))
6513 face-or-color)
6514 face-or-color))
6516 (defun org-get-todo-face (kwd)
6517 "Get the right face for a TODO keyword KWD.
6518 If KWD is a number, get the corresponding match group."
6519 (if (numberp kwd) (setq kwd (match-string kwd)))
6520 (or (org-face-from-face-or-color
6521 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6522 (and (member kwd org-done-keywords) 'org-done)
6523 'org-todo))
6525 (defun org-get-priority-face (priority)
6526 "Get the right face for PRIORITY.
6527 PRIORITY is a character."
6528 (or (org-face-from-face-or-color
6529 'priority 'org-priority (cdr (assq priority org-priority-faces)))
6530 'org-priority))
6532 (defun org-get-tag-face (tag)
6533 "Get the right face for TAG.
6534 If TAG is a number, get the corresponding match group."
6535 (let ((tag (if (wholenump tag) (match-string tag) tag)))
6536 (or (org-face-from-face-or-color
6537 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
6538 'org-tag)))
6540 (defun org-font-lock-add-priority-faces (limit)
6541 "Add the special priority faces."
6542 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
6543 (add-text-properties
6544 (match-beginning 1) (match-end 1)
6545 (list 'face (org-get-priority-face (string-to-char (match-string 2)))
6546 'font-lock-fontified t))))
6548 (defun org-font-lock-add-tag-faces (limit)
6549 "Add the special tag faces."
6550 (when (and org-tag-faces org-tags-special-faces-re)
6551 (while (re-search-forward org-tags-special-faces-re limit t)
6552 (add-text-properties (match-beginning 1) (match-end 1)
6553 (list 'face (org-get-tag-face 1)
6554 'font-lock-fontified t))
6555 (backward-char 1))))
6557 (defun org-unfontify-region (beg end &optional maybe_loudly)
6558 "Remove fontification and activation overlays from links."
6559 (font-lock-default-unfontify-region beg end)
6560 (let* ((buffer-undo-list t)
6561 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6562 (inhibit-modification-hooks t)
6563 deactivate-mark buffer-file-name buffer-file-truename)
6564 (org-decompose-region beg end)
6565 (remove-text-properties beg end
6566 '(mouse-face t keymap t org-linked-text t
6567 invisible t intangible t
6568 org-emphasis t))
6569 (org-remove-font-lock-display-properties beg end)))
6571 (defconst org-script-display '(((raise -0.3) (height 0.7))
6572 ((raise 0.3) (height 0.7))
6573 ((raise -0.5))
6574 ((raise 0.5)))
6575 "Display properties for showing superscripts and subscripts.")
6577 (defun org-remove-font-lock-display-properties (beg end)
6578 "Remove specific display properties that have been added by font lock.
6579 The will remove the raise properties that are used to show superscripts
6580 and subscripts."
6581 (let (next prop)
6582 (while (< beg end)
6583 (setq next (next-single-property-change beg 'display nil end)
6584 prop (get-text-property beg 'display))
6585 (if (member prop org-script-display)
6586 (put-text-property beg next 'display nil))
6587 (setq beg next))))
6589 (defun org-raise-scripts (limit)
6590 "Add raise properties to sub/superscripts."
6591 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6592 (if (re-search-forward
6593 (if (eq org-use-sub-superscripts t)
6594 org-match-substring-regexp
6595 org-match-substring-with-braces-regexp)
6596 limit t)
6597 (let* ((pos (point)) table-p comment-p
6598 (mpos (match-beginning 3))
6599 (emph-p (get-text-property mpos 'org-emphasis))
6600 (link-p (get-text-property mpos 'mouse-face))
6601 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6602 (goto-char (point-at-bol))
6603 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6604 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6605 (goto-char pos)
6606 ;; Handle a_b^c
6607 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6608 (if (or comment-p emph-p link-p keyw-p)
6610 (put-text-property (match-beginning 3) (match-end 0)
6611 'display
6612 (if (equal (char-after (match-beginning 2)) ?^)
6613 (nth (if table-p 3 1) org-script-display)
6614 (nth (if table-p 2 0) org-script-display)))
6615 (add-text-properties (match-beginning 2) (match-end 2)
6616 (list 'invisible t
6617 'org-dwidth t 'org-dwidth-n 1))
6618 (if (and (eq (char-after (match-beginning 3)) ?{)
6619 (eq (char-before (match-end 3)) ?}))
6620 (progn
6621 (add-text-properties
6622 (match-beginning 3) (1+ (match-beginning 3))
6623 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6624 (add-text-properties
6625 (1- (match-end 3)) (match-end 3)
6626 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6627 t)))))
6629 ;;;; Visibility cycling, including org-goto and indirect buffer
6631 ;;; Cycling
6633 (defvar org-cycle-global-status nil)
6634 (make-variable-buffer-local 'org-cycle-global-status)
6635 (put 'org-cycle-global-status 'org-state t)
6636 (defvar org-cycle-subtree-status nil)
6637 (make-variable-buffer-local 'org-cycle-subtree-status)
6638 (put 'org-cycle-subtree-status 'org-state t)
6640 (defvar org-inlinetask-min-level)
6642 (defun org-unlogged-message (&rest args)
6643 "Display a message, but avoid logging it in the *Messages* buffer."
6644 (let ((message-log-max nil))
6645 (apply 'message args)))
6647 ;;;###autoload
6648 (defun org-cycle (&optional arg)
6649 "TAB-action and visibility cycling for Org-mode.
6651 This is the command invoked in Org-mode by the TAB key. Its main purpose
6652 is outline visibility cycling, but it also invokes other actions
6653 in special contexts.
6655 - When this function is called with a prefix argument, rotate the entire
6656 buffer through 3 states (global cycling)
6657 1. OVERVIEW: Show only top-level headlines.
6658 2. CONTENTS: Show all headlines of all levels, but no body text.
6659 3. SHOW ALL: Show everything.
6660 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6661 determined by the variable `org-startup-folded', and by any VISIBILITY
6662 properties in the buffer.
6663 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6664 including any drawers.
6666 - When inside a table, re-align the table and move to the next field.
6668 - When point is at the beginning of a headline, rotate the subtree started
6669 by this line through 3 different states (local cycling)
6670 1. FOLDED: Only the main headline is shown.
6671 2. CHILDREN: The main headline and the direct children are shown.
6672 From this state, you can move to one of the children
6673 and zoom in further.
6674 3. SUBTREE: Show the entire subtree, including body text.
6675 If there is no subtree, switch directly from CHILDREN to FOLDED.
6677 - When point is at the beginning of an empty headline and the variable
6678 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6679 of the headline by demoting and promoting it to likely levels. This
6680 speeds up creation document structure by pressing TAB once or several
6681 times right after creating a new headline.
6683 - When there is a numeric prefix, go up to a heading with level ARG, do
6684 a `show-subtree' and return to the previous cursor position. If ARG
6685 is negative, go up that many levels.
6687 - When point is not at the beginning of a headline, execute the global
6688 binding for TAB, which is re-indenting the line. See the option
6689 `org-cycle-emulate-tab' for details.
6691 - Special case: if point is at the beginning of the buffer and there is
6692 no headline in line 1, this function will act as if called with prefix arg
6693 (C-u TAB, same as S-TAB) also when called without prefix arg.
6694 But only if also the variable `org-cycle-global-at-bob' is t."
6695 (interactive "P")
6696 (org-load-modules-maybe)
6697 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6698 (and org-cycle-level-after-item/entry-creation
6699 (or (org-cycle-level)
6700 (org-cycle-item-indentation))))
6701 (let* ((limit-level
6702 (or org-cycle-max-level
6703 (and (boundp 'org-inlinetask-min-level)
6704 org-inlinetask-min-level
6705 (1- org-inlinetask-min-level))))
6706 (nstars (and limit-level
6707 (if org-odd-levels-only
6708 (and limit-level (1- (* limit-level 2)))
6709 limit-level)))
6710 (org-outline-regexp
6711 (if (not (derived-mode-p 'org-mode))
6712 outline-regexp
6713 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6714 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6715 (not (looking-at org-outline-regexp))))
6716 (org-cycle-hook
6717 (if bob-special
6718 (delq 'org-optimize-window-after-visibility-change
6719 (copy-sequence org-cycle-hook))
6720 org-cycle-hook))
6721 (pos (point)))
6723 (if (or bob-special (equal arg '(4)))
6724 ;; special case: use global cycling
6725 (setq arg t))
6727 (cond
6729 ((equal arg '(16))
6730 (setq last-command 'dummy)
6731 (org-set-startup-visibility)
6732 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6734 ((equal arg '(64))
6735 (show-all)
6736 (org-unlogged-message "Entire buffer visible, including drawers"))
6738 ;; Try cdlatex TAB completion
6739 ((org-try-cdlatex-tab))
6741 ;; Table: enter it or move to the next field.
6742 ((org-at-table-p 'any)
6743 (if (org-at-table.el-p)
6744 (message "Use C-c ' to edit table.el tables")
6745 (if arg (org-table-edit-field t)
6746 (org-table-justify-field-maybe)
6747 (call-interactively 'org-table-next-field))))
6749 ((run-hook-with-args-until-success
6750 'org-tab-after-check-for-table-hook))
6752 ;; Global cycling: delegate to `org-cycle-internal-global'.
6753 ((eq arg t) (org-cycle-internal-global))
6755 ;; Drawers: delegate to `org-flag-drawer'.
6756 ((save-excursion
6757 (beginning-of-line 1)
6758 (looking-at org-drawer-regexp))
6759 (org-flag-drawer ; toggle block visibility
6760 (not (get-char-property (match-end 0) 'invisible))))
6762 ;; Show-subtree, ARG levels up from here.
6763 ((integerp arg)
6764 (save-excursion
6765 (org-back-to-heading)
6766 (outline-up-heading (if (< arg 0) (- arg)
6767 (- (funcall outline-level) arg)))
6768 (org-show-subtree)))
6770 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6771 ((and (featurep 'org-inlinetask)
6772 (org-inlinetask-at-task-p)
6773 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6774 (org-inlinetask-toggle-visibility))
6776 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6777 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6778 (save-excursion (move-beginning-of-line 1)
6779 (looking-at org-outline-regexp)))
6780 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6781 (org-cycle-internal-local))
6783 ;; From there: TAB emulation and template completion.
6784 (buffer-read-only (org-back-to-heading))
6786 ((run-hook-with-args-until-success
6787 'org-tab-after-check-for-cycling-hook))
6789 ((org-try-structure-completion))
6791 ((run-hook-with-args-until-success
6792 'org-tab-before-tab-emulation-hook))
6794 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6795 (or (not (bolp))
6796 (not (looking-at org-outline-regexp))))
6797 (call-interactively (global-key-binding "\t")))
6799 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6800 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6801 (or (and (eq org-cycle-emulate-tab 'white)
6802 (= (match-end 0) (point-at-eol)))
6803 (and (eq org-cycle-emulate-tab 'whitestart)
6804 (>= (match-end 0) pos))))
6806 (eq org-cycle-emulate-tab t))
6807 (call-interactively (global-key-binding "\t")))
6809 (t (save-excursion
6810 (org-back-to-heading)
6811 (org-cycle)))))))
6813 (defun org-cycle-internal-global ()
6814 "Do the global cycling action."
6815 ;; Hack to avoid display of messages for .org attachments in Gnus
6816 (let ((ga (string-match "\\*fontification" (buffer-name))))
6817 (cond
6818 ((and (eq last-command this-command)
6819 (eq org-cycle-global-status 'overview))
6820 ;; We just created the overview - now do table of contents
6821 ;; This can be slow in very large buffers, so indicate action
6822 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6823 (unless ga (org-unlogged-message "CONTENTS..."))
6824 (org-content)
6825 (unless ga (org-unlogged-message "CONTENTS...done"))
6826 (setq org-cycle-global-status 'contents)
6827 (run-hook-with-args 'org-cycle-hook 'contents))
6829 ((and (eq last-command this-command)
6830 (eq org-cycle-global-status 'contents))
6831 ;; We just showed the table of contents - now show everything
6832 (run-hook-with-args 'org-pre-cycle-hook 'all)
6833 (show-all)
6834 (unless ga (org-unlogged-message "SHOW ALL"))
6835 (setq org-cycle-global-status 'all)
6836 (run-hook-with-args 'org-cycle-hook 'all))
6839 ;; Default action: go to overview
6840 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6841 (org-overview)
6842 (unless ga (org-unlogged-message "OVERVIEW"))
6843 (setq org-cycle-global-status 'overview)
6844 (run-hook-with-args 'org-cycle-hook 'overview)))))
6846 (defvar org-called-with-limited-levels nil
6847 "Non-nil when `org-with-limited-levels' is currently active.")
6849 (defun org-cycle-internal-local ()
6850 "Do the local cycling action."
6851 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6852 ;; First, determine end of headline (EOH), end of subtree or item
6853 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6854 (save-excursion
6855 (if (org-at-item-p)
6856 (progn
6857 (beginning-of-line)
6858 (setq struct (org-list-struct))
6859 (setq eoh (point-at-eol))
6860 (setq eos (org-list-get-item-end-before-blank (point) struct))
6861 (setq has-children (org-list-has-child-p (point) struct)))
6862 (org-back-to-heading)
6863 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6864 (setq eos (save-excursion (org-end-of-subtree t t)
6865 (when (bolp) (backward-char)) (point)))
6866 (setq has-children
6867 (or (save-excursion
6868 (let ((level (funcall outline-level)))
6869 (outline-next-heading)
6870 (and (org-at-heading-p t)
6871 (> (funcall outline-level) level))))
6872 (save-excursion
6873 (org-list-search-forward (org-item-beginning-re) eos t)))))
6874 ;; Determine end invisible part of buffer (EOL)
6875 (beginning-of-line 2)
6876 ;; XEmacs doesn't have `next-single-char-property-change'
6877 (if (featurep 'xemacs)
6878 (while (and (not (eobp)) ;; this is like `next-line'
6879 (get-char-property (1- (point)) 'invisible))
6880 (beginning-of-line 2))
6881 (while (and (not (eobp)) ;; this is like `next-line'
6882 (get-char-property (1- (point)) 'invisible))
6883 (goto-char (next-single-char-property-change (point) 'invisible))
6884 (and (eolp) (beginning-of-line 2))))
6885 (setq eol (point)))
6886 ;; Find out what to do next and set `this-command'
6887 (cond
6888 ((= eos eoh)
6889 ;; Nothing is hidden behind this heading
6890 (unless (org-before-first-heading-p)
6891 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6892 (org-unlogged-message "EMPTY ENTRY")
6893 (setq org-cycle-subtree-status nil)
6894 (save-excursion
6895 (goto-char eos)
6896 (outline-next-heading)
6897 (if (outline-invisible-p) (org-flag-heading nil))))
6898 ((and (or (>= eol eos)
6899 (not (string-match "\\S-" (buffer-substring eol eos))))
6900 (or has-children
6901 (not (setq children-skipped
6902 org-cycle-skip-children-state-if-no-children))))
6903 ;; Entire subtree is hidden in one line: children view
6904 (unless (org-before-first-heading-p)
6905 (run-hook-with-args 'org-pre-cycle-hook 'children))
6906 (if (org-at-item-p)
6907 (org-list-set-item-visibility (point-at-bol) struct 'children)
6908 (org-show-entry)
6909 (org-with-limited-levels (show-children))
6910 ;; FIXME: This slows down the func way too much.
6911 ;; How keep drawers hidden in subtree anyway?
6912 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6913 ;; (org-cycle-hide-drawers 'subtree))
6915 ;; Fold every list in subtree to top-level items.
6916 (when (eq org-cycle-include-plain-lists 'integrate)
6917 (save-excursion
6918 (org-back-to-heading)
6919 (while (org-list-search-forward (org-item-beginning-re) eos t)
6920 (beginning-of-line 1)
6921 (let* ((struct (org-list-struct))
6922 (prevs (org-list-prevs-alist struct))
6923 (end (org-list-get-bottom-point struct)))
6924 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6925 (org-list-get-all-items (point) struct prevs))
6926 (goto-char (if (< end eos) end eos)))))))
6927 (org-unlogged-message "CHILDREN")
6928 (save-excursion
6929 (goto-char eos)
6930 (outline-next-heading)
6931 (if (outline-invisible-p) (org-flag-heading nil)))
6932 (setq org-cycle-subtree-status 'children)
6933 (unless (org-before-first-heading-p)
6934 (run-hook-with-args 'org-cycle-hook 'children)))
6935 ((or children-skipped
6936 (and (eq last-command this-command)
6937 (eq org-cycle-subtree-status 'children)))
6938 ;; We just showed the children, or no children are there,
6939 ;; now show everything.
6940 (unless (org-before-first-heading-p)
6941 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6942 (outline-flag-region eoh eos nil)
6943 (org-unlogged-message
6944 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6945 (setq org-cycle-subtree-status 'subtree)
6946 (unless (org-before-first-heading-p)
6947 (run-hook-with-args 'org-cycle-hook 'subtree)))
6949 ;; Default action: hide the subtree.
6950 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6951 (outline-flag-region eoh eos t)
6952 (org-unlogged-message "FOLDED")
6953 (setq org-cycle-subtree-status 'folded)
6954 (unless (org-before-first-heading-p)
6955 (run-hook-with-args 'org-cycle-hook 'folded))))))
6957 ;;;###autoload
6958 (defun org-global-cycle (&optional arg)
6959 "Cycle the global visibility. For details see `org-cycle'.
6960 With \\[universal-argument] prefix arg, switch to startup visibility.
6961 With a numeric prefix, show all headlines up to that level."
6962 (interactive "P")
6963 (let ((org-cycle-include-plain-lists
6964 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6965 (cond
6966 ((integerp arg)
6967 (show-all)
6968 (hide-sublevels arg)
6969 (setq org-cycle-global-status 'contents))
6970 ((equal arg '(4))
6971 (org-set-startup-visibility)
6972 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6974 (org-cycle '(4))))))
6976 (defun org-set-startup-visibility ()
6977 "Set the visibility required by startup options and properties."
6978 (cond
6979 ((eq org-startup-folded t)
6980 (org-overview))
6981 ((eq org-startup-folded 'content)
6982 (org-content))
6983 ((or (eq org-startup-folded 'showeverything)
6984 (eq org-startup-folded nil))
6985 (show-all)))
6986 (unless (eq org-startup-folded 'showeverything)
6987 (if org-hide-block-startup (org-hide-block-all))
6988 (org-set-visibility-according-to-property 'no-cleanup)
6989 (org-cycle-hide-archived-subtrees 'all)
6990 (org-cycle-hide-drawers 'all)
6991 (org-cycle-show-empty-lines t)))
6993 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6994 "Switch subtree visibilities according to :VISIBILITY: property."
6995 (interactive)
6996 (let (org-show-entry-below)
6997 (org-with-wide-buffer
6998 (goto-char (point-min))
6999 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
7000 (if (not (org-at-property-p)) (outline-next-heading)
7001 (let ((state (match-string 3)))
7002 (save-excursion
7003 (org-back-to-heading t)
7004 (hide-subtree)
7005 (org-reveal)
7006 (cond
7007 ((equal state "folded")
7008 (hide-subtree))
7009 ((equal state "children")
7010 (org-show-hidden-entry)
7011 (show-children))
7012 ((equal state "content")
7013 (save-excursion
7014 (save-restriction
7015 (org-narrow-to-subtree)
7016 (org-content))))
7017 ((member state '("all" "showall"))
7018 (show-subtree)))))))
7019 (unless no-cleanup
7020 (org-cycle-hide-archived-subtrees 'all)
7021 (org-cycle-hide-drawers 'all)
7022 (org-cycle-show-empty-lines 'all)))))
7024 ;; This function uses outline-regexp instead of the more fundamental
7025 ;; org-outline-regexp so that org-cycle-global works outside of Org
7026 ;; buffers, where outline-regexp is needed.
7027 (defun org-overview ()
7028 "Switch to overview mode, showing only top-level headlines.
7029 This shows all headlines with a level equal or greater than the level
7030 of the first headline in the buffer. This is important, because if the
7031 first headline is not level one, then (hide-sublevels 1) gives confusing
7032 results."
7033 (interactive)
7034 (save-excursion
7035 (let ((level
7036 (save-excursion
7037 (goto-char (point-min))
7038 (if (re-search-forward (concat "^" outline-regexp) nil t)
7039 (progn
7040 (goto-char (match-beginning 0))
7041 (funcall outline-level))))))
7042 (and level (hide-sublevels level)))))
7044 (defun org-content (&optional arg)
7045 "Show all headlines in the buffer, like a table of contents.
7046 With numerical argument N, show content up to level N."
7047 (interactive "P")
7048 (org-overview)
7049 (save-excursion
7050 ;; Visit all headings and show their offspring
7051 (and (integerp arg) (org-overview))
7052 (goto-char (point-max))
7053 (catch 'exit
7054 (while (and (progn (condition-case nil
7055 (outline-previous-visible-heading 1)
7056 (error (goto-char (point-min))))
7058 (looking-at org-outline-regexp))
7059 (if (integerp arg)
7060 (show-children (1- arg))
7061 (show-branches))
7062 (if (bobp) (throw 'exit nil))))))
7064 (defun org-optimize-window-after-visibility-change (state)
7065 "Adjust the window after a change in outline visibility.
7066 This function is the default value of the hook `org-cycle-hook'."
7067 (when (get-buffer-window (current-buffer))
7068 (cond
7069 ((eq state 'content) nil)
7070 ((eq state 'all) nil)
7071 ((eq state 'folded) nil)
7072 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7073 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7075 (defun org-remove-empty-overlays-at (pos)
7076 "Remove outline overlays that do not contain non-white stuff."
7077 (mapc
7078 (lambda (o)
7079 (and (eq 'outline (overlay-get o 'invisible))
7080 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7081 (overlay-end o))))
7082 (delete-overlay o)))
7083 (overlays-at pos)))
7085 (defun org-clean-visibility-after-subtree-move ()
7086 "Fix visibility issues after moving a subtree."
7087 ;; First, find a reasonable region to look at:
7088 ;; Start two siblings above, end three below
7089 (let* ((beg (save-excursion
7090 (and (org-get-last-sibling)
7091 (org-get-last-sibling))
7092 (point)))
7093 (end (save-excursion
7094 (and (org-get-next-sibling)
7095 (org-get-next-sibling)
7096 (org-get-next-sibling))
7097 (if (org-at-heading-p)
7098 (point-at-eol)
7099 (point))))
7100 (level (looking-at "\\*+"))
7101 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7102 (save-excursion
7103 (save-restriction
7104 (narrow-to-region beg end)
7105 (when re
7106 ;; Properly fold already folded siblings
7107 (goto-char (point-min))
7108 (while (re-search-forward re nil t)
7109 (if (and (not (outline-invisible-p))
7110 (save-excursion
7111 (goto-char (point-at-eol)) (outline-invisible-p)))
7112 (hide-entry))))
7113 (org-cycle-show-empty-lines 'overview)
7114 (org-cycle-hide-drawers 'overview)))))
7116 (defun org-cycle-show-empty-lines (state)
7117 "Show empty lines above all visible headlines.
7118 The region to be covered depends on STATE when called through
7119 `org-cycle-hook'. Lisp program can use t for STATE to get the
7120 entire buffer covered. Note that an empty line is only shown if there
7121 are at least `org-cycle-separator-lines' empty lines before the headline."
7122 (when (/= org-cycle-separator-lines 0)
7123 (save-excursion
7124 (let* ((n (abs org-cycle-separator-lines))
7125 (re (cond
7126 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7127 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7128 (t (let ((ns (number-to-string (- n 2))))
7129 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7130 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7131 beg end)
7132 (cond
7133 ((memq state '(overview contents t))
7134 (setq beg (point-min) end (point-max)))
7135 ((memq state '(children folded))
7136 (setq beg (point)
7137 end (progn (org-end-of-subtree t t)
7138 (line-beginning-position 2)))))
7139 (when beg
7140 (goto-char beg)
7141 (while (re-search-forward re end t)
7142 (unless (get-char-property (match-end 1) 'invisible)
7143 (let ((e (match-end 1))
7144 (b (if (>= org-cycle-separator-lines 0)
7145 (match-beginning 1)
7146 (save-excursion
7147 (goto-char (match-beginning 0))
7148 (skip-chars-backward " \t\n")
7149 (line-end-position)))))
7150 (outline-flag-region b e nil))))))))
7151 ;; Never hide empty lines at the end of the file.
7152 (save-excursion
7153 (goto-char (point-max))
7154 (outline-previous-heading)
7155 (outline-end-of-heading)
7156 (if (and (looking-at "[ \t\n]+")
7157 (= (match-end 0) (point-max)))
7158 (outline-flag-region (point) (match-end 0) nil))))
7160 (defun org-show-empty-lines-in-parent ()
7161 "Move to the parent and re-show empty lines before visible headlines."
7162 (save-excursion
7163 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7164 (org-cycle-show-empty-lines context))))
7166 (defun org-files-list ()
7167 "Return `org-agenda-files' list, plus all open org-mode files.
7168 This is useful for operations that need to scan all of a user's
7169 open and agenda-wise Org files."
7170 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7171 (dolist (buf (buffer-list))
7172 (with-current-buffer buf
7173 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7174 (let ((file (expand-file-name (buffer-file-name))))
7175 (unless (member file files)
7176 (push file files))))))
7177 files))
7179 (defsubst org-entry-beginning-position ()
7180 "Return the beginning position of the current entry."
7181 (save-excursion (outline-back-to-heading t) (point)))
7183 (defsubst org-entry-end-position ()
7184 "Return the end position of the current entry."
7185 (save-excursion (outline-next-heading) (point)))
7187 (defun org-cycle-hide-drawers (state &optional exceptions)
7188 "Re-hide all drawers after a visibility state change.
7189 When non-nil, optional argument EXCEPTIONS is a list of strings
7190 specifying which drawers should not be hidden."
7191 (when (and (derived-mode-p 'org-mode)
7192 (not (memq state '(overview folded contents))))
7193 (save-excursion
7194 (let* ((globalp (memq state '(contents all)))
7195 (beg (if globalp (point-min) (point)))
7196 (end (if globalp (point-max)
7197 (if (eq state 'children)
7198 (save-excursion (outline-next-heading) (point))
7199 (org-end-of-subtree t)))))
7200 (goto-char beg)
7201 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7202 (unless (member-ignore-case (match-string 1) exceptions)
7203 (let ((drawer (org-element-at-point)))
7204 (when (memq (org-element-type drawer) '(drawer property-drawer))
7205 (org-flag-drawer t drawer)
7206 ;; Make sure to skip drawer entirely or we might flag
7207 ;; it another time when matching its ending line with
7208 ;; `org-drawer-regexp'.
7209 (goto-char (org-element-property :end drawer))))))))))
7211 (defun org-flag-drawer (flag &optional element)
7212 "When FLAG is non-nil, hide the drawer we are at.
7213 Otherwise make it visible. When optional argument ELEMENT is
7214 a parsed drawer, as returned by `org-element-at-point', hide or
7215 show that drawer instead."
7216 (when (save-excursion
7217 (beginning-of-line)
7218 (org-looking-at-p org-drawer-regexp))
7219 (let ((drawer (or element (org-element-at-point))))
7220 (when (memq (org-element-type drawer) '(drawer property-drawer))
7221 (let ((post (org-element-property :post-affiliated drawer)))
7222 (save-excursion
7223 (outline-flag-region
7224 (progn (goto-char post) (line-end-position))
7225 (progn (goto-char (org-element-property :end drawer))
7226 (skip-chars-backward " \r\t\n")
7227 (line-end-position))
7228 flag))
7229 ;; When the drawer is hidden away, make sure point lies in
7230 ;; a visible part of the buffer.
7231 (when (and flag (> (line-beginning-position) post))
7232 (goto-char post)))))))
7234 (defun org-subtree-end-visible-p ()
7235 "Is the end of the current subtree visible?"
7236 (pos-visible-in-window-p
7237 (save-excursion (org-end-of-subtree t) (point))))
7239 (defun org-first-headline-recenter ()
7240 "Move cursor to the first headline and recenter the headline."
7241 (goto-char (point-min))
7242 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7243 (set-window-start (selected-window) (point-at-bol))))
7245 ;;; Saving and restoring visibility
7247 (defun org-outline-overlay-data (&optional use-markers)
7248 "Return a list of the locations of all outline overlays.
7249 These are overlays with the `invisible' property value `outline'.
7250 The return value is a list of cons cells, with start and stop
7251 positions for each overlay.
7252 If USE-MARKERS is set, return the positions as markers."
7253 (let (beg end)
7254 (save-excursion
7255 (save-restriction
7256 (widen)
7257 (delq nil
7258 (mapcar (lambda (o)
7259 (when (eq (overlay-get o 'invisible) 'outline)
7260 (setq beg (overlay-start o)
7261 end (overlay-end o))
7262 (and beg end (> end beg)
7263 (if use-markers
7264 (cons (copy-marker beg)
7265 (copy-marker end t))
7266 (cons beg end)))))
7267 (overlays-in (point-min) (point-max))))))))
7269 (defun org-set-outline-overlay-data (data)
7270 "Create visibility overlays for all positions in DATA.
7271 DATA should have been made by `org-outline-overlay-data'."
7272 (let (o)
7273 (save-excursion
7274 (save-restriction
7275 (widen)
7276 (show-all)
7277 (mapc (lambda (c)
7278 (outline-flag-region (car c) (cdr c) t))
7279 data)))))
7281 ;;; Folding of blocks
7283 (defvar org-hide-block-overlays nil
7284 "Overlays hiding blocks.")
7285 (make-variable-buffer-local 'org-hide-block-overlays)
7287 (defun org-block-map (function &optional start end)
7288 "Call FUNCTION at the head of all source blocks in the current buffer.
7289 Optional arguments START and END can be used to limit the range."
7290 (let ((start (or start (point-min)))
7291 (end (or end (point-max))))
7292 (save-excursion
7293 (goto-char start)
7294 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7295 (save-excursion
7296 (save-match-data
7297 (goto-char (match-beginning 0))
7298 (funcall function)))))))
7300 (defun org-hide-block-toggle-all ()
7301 "Toggle the visibility of all blocks in the current buffer."
7302 (org-block-map 'org-hide-block-toggle))
7304 (defun org-hide-block-all ()
7305 "Fold all blocks in the current buffer."
7306 (interactive)
7307 (org-show-block-all)
7308 (org-block-map 'org-hide-block-toggle-maybe))
7310 (defun org-show-block-all ()
7311 "Unfold all blocks in the current buffer."
7312 (interactive)
7313 (mapc 'delete-overlay org-hide-block-overlays)
7314 (setq org-hide-block-overlays nil))
7316 (defun org-hide-block-toggle-maybe ()
7317 "Toggle visibility of block at point.
7318 Unlike to `org-hide-block-toggle', this function does not throw
7319 an error. Return a non-nil value when toggling is successful."
7320 (interactive)
7321 (ignore-errors (org-hide-block-toggle)))
7323 (defun org-hide-block-toggle (&optional force)
7324 "Toggle the visibility of the current block.
7325 When optional argument FORCE is `off', make block visible. If it
7326 is non-nil, hide it unconditionally. Throw an error when not at
7327 a block. Return a non-nil value when toggling is successful."
7328 (interactive)
7329 (let ((element (org-element-at-point)))
7330 (unless (memq (org-element-type element)
7331 '(center-block comment-block dynamic-block example-block
7332 export-block quote-block special-block
7333 src-block verse-block))
7334 (user-error "Not at a block"))
7335 (let* ((start (save-excursion
7336 (goto-char (org-element-property :post-affiliated element))
7337 (line-end-position)))
7338 (end (save-excursion
7339 (goto-char (org-element-property :end element))
7340 (skip-chars-backward " \r\t\n")
7341 (line-end-position)))
7342 (overlays (overlays-at start)))
7343 (cond
7344 ;; Do nothing when not before or at the block opening line or
7345 ;; at the block closing line.
7346 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7347 ((and (not (eq force 'off))
7348 (not (memq t (mapcar
7349 (lambda (o)
7350 (eq (overlay-get o 'invisible) 'org-hide-block))
7351 overlays))))
7352 (let ((ov (make-overlay start end)))
7353 (overlay-put ov 'invisible 'org-hide-block)
7354 ;; Make the block accessible to `isearch'.
7355 (overlay-put
7356 ov 'isearch-open-invisible
7357 (lambda (ov)
7358 (when (memq ov org-hide-block-overlays)
7359 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7360 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7361 (delete-overlay ov))))
7362 (push ov org-hide-block-overlays)
7363 ;; When the block is hidden away, make sure point is left in
7364 ;; a visible part of the buffer.
7365 (when (> (line-beginning-position) start)
7366 (goto-char start)
7367 (beginning-of-line))
7368 ;; Signal successful toggling.
7370 ((or (not force) (eq force 'off))
7371 (dolist (ov overlays t)
7372 (when (memq ov org-hide-block-overlays)
7373 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7374 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7375 (delete-overlay ov))))))))
7377 ;; org-tab-after-check-for-cycling-hook
7378 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7379 ;; Remove overlays when changing major mode
7380 (add-hook 'org-mode-hook
7381 (lambda () (org-add-hook 'change-major-mode-hook
7382 'org-show-block-all 'append 'local)))
7384 ;;; Org-goto
7386 (defvar org-goto-window-configuration nil)
7387 (defvar org-goto-marker nil)
7388 (defvar org-goto-map)
7389 (defun org-goto-map ()
7390 "Set the keymap `org-goto'."
7391 (setq org-goto-map
7392 (let ((map (make-sparse-keymap)))
7393 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7394 mouse-drag-region universal-argument org-occur)))
7395 (dolist (cmd cmds)
7396 (substitute-key-definition cmd cmd map global-map)))
7397 (suppress-keymap map)
7398 (org-defkey map "\C-m" 'org-goto-ret)
7399 (org-defkey map [(return)] 'org-goto-ret)
7400 (org-defkey map [(left)] 'org-goto-left)
7401 (org-defkey map [(right)] 'org-goto-right)
7402 (org-defkey map [(control ?g)] 'org-goto-quit)
7403 (org-defkey map "\C-i" 'org-cycle)
7404 (org-defkey map [(tab)] 'org-cycle)
7405 (org-defkey map [(down)] 'outline-next-visible-heading)
7406 (org-defkey map [(up)] 'outline-previous-visible-heading)
7407 (if org-goto-auto-isearch
7408 (if (fboundp 'define-key-after)
7409 (define-key-after map [t] 'org-goto-local-auto-isearch)
7410 nil)
7411 (org-defkey map "q" 'org-goto-quit)
7412 (org-defkey map "n" 'outline-next-visible-heading)
7413 (org-defkey map "p" 'outline-previous-visible-heading)
7414 (org-defkey map "f" 'outline-forward-same-level)
7415 (org-defkey map "b" 'outline-backward-same-level)
7416 (org-defkey map "u" 'outline-up-heading))
7417 (org-defkey map "/" 'org-occur)
7418 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7419 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7420 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7421 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7422 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7423 map)))
7425 (defconst org-goto-help
7426 "Browse buffer copy, to find location or copy text.%s
7427 RET=jump to location C-g=quit and return to previous location
7428 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7430 (defvar org-goto-start-pos) ; dynamically scoped parameter
7432 (defun org-goto (&optional alternative-interface)
7433 "Look up a different location in the current file, keeping current visibility.
7435 When you want look-up or go to a different location in a
7436 document, the fastest way is often to fold the entire buffer and
7437 then dive into the tree. This method has the disadvantage, that
7438 the previous location will be folded, which may not be what you
7439 want.
7441 This command works around this by showing a copy of the current
7442 buffer in an indirect buffer, in overview mode. You can dive
7443 into the tree in that copy, use org-occur and incremental search
7444 to find a location. When pressing RET or `Q', the command
7445 returns to the original buffer in which the visibility is still
7446 unchanged. After RET it will also jump to the location selected
7447 in the indirect buffer and expose the headline hierarchy above.
7449 With a prefix argument, use the alternative interface: e.g. if
7450 `org-goto-interface' is 'outline use 'outline-path-completion."
7451 (interactive "P")
7452 (org-goto-map)
7453 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7454 (org-refile-use-outline-path t)
7455 (org-refile-target-verify-function nil)
7456 (interface
7457 (if (not alternative-interface)
7458 org-goto-interface
7459 (if (eq org-goto-interface 'outline)
7460 'outline-path-completion
7461 'outline)))
7462 (org-goto-start-pos (point))
7463 (selected-point
7464 (if (eq interface 'outline)
7465 (car (org-get-location (current-buffer) org-goto-help))
7466 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7467 (org-refile-check-position pa)
7468 (nth 3 pa)))))
7469 (if selected-point
7470 (progn
7471 (org-mark-ring-push org-goto-start-pos)
7472 (goto-char selected-point)
7473 (if (or (outline-invisible-p) (org-invisible-p2))
7474 (org-show-context 'org-goto)))
7475 (message "Quit"))))
7477 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7478 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7479 (defvar org-goto-local-auto-isearch-map) ; defined below
7481 (defun org-get-location (buf help)
7482 "Let the user select a location in the Org-mode buffer BUF.
7483 This function uses a recursive edit. It returns the selected position
7484 or nil."
7485 (org-no-popups
7486 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7487 (isearch-hide-immediately nil)
7488 (isearch-search-fun-function
7489 (lambda () 'org-goto-local-search-headings))
7490 (org-goto-selected-point org-goto-exit-command))
7491 (save-excursion
7492 (save-window-excursion
7493 (delete-other-windows)
7494 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7495 (org-pop-to-buffer-same-window
7496 (condition-case nil
7497 (make-indirect-buffer (current-buffer) "*org-goto*")
7498 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7499 (with-output-to-temp-buffer "*Org Help*"
7500 (princ (format help (if org-goto-auto-isearch
7501 " Just type for auto-isearch."
7502 " n/p/f/b/u to navigate, q to quit."))))
7503 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7504 (setq buffer-read-only nil)
7505 (let ((org-startup-truncated t)
7506 (org-startup-folded nil)
7507 (org-startup-align-all-tables nil))
7508 (org-mode)
7509 (org-overview))
7510 (setq buffer-read-only t)
7511 (if (and (boundp 'org-goto-start-pos)
7512 (integer-or-marker-p org-goto-start-pos))
7513 (progn (goto-char org-goto-start-pos)
7514 (when (outline-invisible-p)
7515 (org-show-set-visibility 'lineage)))
7516 (goto-char (point-min)))
7517 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7518 (message "Select location and press RET")
7519 (use-local-map org-goto-map)
7520 (recursive-edit)))
7521 (kill-buffer "*org-goto*")
7522 (cons org-goto-selected-point org-goto-exit-command))))
7524 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7525 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7526 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7527 (if (fboundp 'isearch-other-control-char)
7528 (progn
7529 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7530 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7531 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7532 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7533 (define-key org-goto-local-auto-isearch-map [return] nil))
7535 (defun org-goto-local-search-headings (string bound noerror)
7536 "Search and make sure that any matches are in headlines."
7537 (catch 'return
7538 (while (if isearch-forward
7539 (search-forward string bound noerror)
7540 (search-backward string bound noerror))
7541 (when (save-match-data
7542 (and (save-excursion
7543 (beginning-of-line)
7544 (looking-at org-complex-heading-regexp))
7545 (or (not (match-beginning 5))
7546 (< (point) (match-beginning 5)))))
7547 (throw 'return (point))))))
7549 (defun org-goto-local-auto-isearch ()
7550 "Start isearch."
7551 (interactive)
7552 (goto-char (point-min))
7553 (let ((keys (this-command-keys)))
7554 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7555 (isearch-mode t)
7556 (isearch-process-search-char (string-to-char keys)))))
7558 (defun org-goto-ret (&optional arg)
7559 "Finish `org-goto' by going to the new location."
7560 (interactive "P")
7561 (setq org-goto-selected-point (point)
7562 org-goto-exit-command 'return)
7563 (throw 'exit nil))
7565 (defun org-goto-left ()
7566 "Finish `org-goto' by going to the new location."
7567 (interactive)
7568 (if (org-at-heading-p)
7569 (progn
7570 (beginning-of-line 1)
7571 (setq org-goto-selected-point (point)
7572 org-goto-exit-command 'left)
7573 (throw 'exit nil))
7574 (user-error "Not on a heading")))
7576 (defun org-goto-right ()
7577 "Finish `org-goto' by going to the new location."
7578 (interactive)
7579 (if (org-at-heading-p)
7580 (progn
7581 (setq org-goto-selected-point (point)
7582 org-goto-exit-command 'right)
7583 (throw 'exit nil))
7584 (user-error "Not on a heading")))
7586 (defun org-goto-quit ()
7587 "Finish `org-goto' without cursor motion."
7588 (interactive)
7589 (setq org-goto-selected-point nil)
7590 (setq org-goto-exit-command 'quit)
7591 (throw 'exit nil))
7593 ;;; Indirect buffer display of subtrees
7595 (defvar org-indirect-dedicated-frame nil
7596 "This is the frame being used for indirect tree display.")
7597 (defvar org-last-indirect-buffer nil)
7599 (defun org-tree-to-indirect-buffer (&optional arg)
7600 "Create indirect buffer and narrow it to current subtree.
7601 With a numerical prefix ARG, go up to this level and then take that tree.
7602 If ARG is negative, go up that many levels.
7604 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7605 indirect buffer previously made with this command, to avoid proliferation of
7606 indirect buffers. However, when you call the command with a \
7607 \\[universal-argument] prefix, or
7608 when `org-indirect-buffer-display' is `new-frame', the last buffer
7609 is kept so that you can work with several indirect buffers at the same time.
7610 If `org-indirect-buffer-display' is `dedicated-frame', the \
7611 \\[universal-argument] prefix also
7612 requests that a new frame be made for the new buffer, so that the dedicated
7613 frame is not changed."
7614 (interactive "P")
7615 (let ((cbuf (current-buffer))
7616 (cwin (selected-window))
7617 (pos (point))
7618 beg end level heading ibuf)
7619 (save-excursion
7620 (org-back-to-heading t)
7621 (when (numberp arg)
7622 (setq level (org-outline-level))
7623 (if (< arg 0) (setq arg (+ level arg)))
7624 (while (> (setq level (org-outline-level)) arg)
7625 (org-up-heading-safe)))
7626 (setq beg (point)
7627 heading (org-get-heading))
7628 (org-end-of-subtree t t)
7629 (if (org-at-heading-p) (backward-char 1))
7630 (setq end (point)))
7631 (if (and (buffer-live-p org-last-indirect-buffer)
7632 (not (eq org-indirect-buffer-display 'new-frame))
7633 (not arg))
7634 (kill-buffer org-last-indirect-buffer))
7635 (setq ibuf (org-get-indirect-buffer cbuf heading)
7636 org-last-indirect-buffer ibuf)
7637 (cond
7638 ((or (eq org-indirect-buffer-display 'new-frame)
7639 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7640 (select-frame (make-frame))
7641 (delete-other-windows)
7642 (org-pop-to-buffer-same-window ibuf)
7643 (org-set-frame-title heading))
7644 ((eq org-indirect-buffer-display 'dedicated-frame)
7645 (raise-frame
7646 (select-frame (or (and org-indirect-dedicated-frame
7647 (frame-live-p org-indirect-dedicated-frame)
7648 org-indirect-dedicated-frame)
7649 (setq org-indirect-dedicated-frame (make-frame)))))
7650 (delete-other-windows)
7651 (org-pop-to-buffer-same-window ibuf)
7652 (org-set-frame-title (concat "Indirect: " heading)))
7653 ((eq org-indirect-buffer-display 'current-window)
7654 (org-pop-to-buffer-same-window ibuf))
7655 ((eq org-indirect-buffer-display 'other-window)
7656 (pop-to-buffer ibuf))
7657 (t (error "Invalid value")))
7658 (if (featurep 'xemacs)
7659 (save-excursion (org-mode) (turn-on-font-lock)))
7660 (narrow-to-region beg end)
7661 (show-all)
7662 (goto-char pos)
7663 (run-hook-with-args 'org-cycle-hook 'all)
7664 (and (window-live-p cwin) (select-window cwin))))
7666 (defun org-get-indirect-buffer (&optional buffer heading)
7667 (setq buffer (or buffer (current-buffer)))
7668 (let ((n 1) (base (buffer-name buffer)) bname)
7669 (while (buffer-live-p
7670 (get-buffer
7671 (setq bname
7672 (concat base "-"
7673 (if heading (concat heading "-" (number-to-string n))
7674 (number-to-string n))))))
7675 (setq n (1+ n)))
7676 (condition-case nil
7677 (make-indirect-buffer buffer bname 'clone)
7678 (error (make-indirect-buffer buffer bname)))))
7680 (defun org-set-frame-title (title)
7681 "Set the title of the current frame to the string TITLE."
7682 ;; FIXME: how to name a single frame in XEmacs???
7683 (unless (featurep 'xemacs)
7684 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7686 ;;;; Structure editing
7688 ;;; Inserting headlines
7690 (defun org-previous-line-empty-p (&optional next)
7691 "Is the previous line a blank line?
7692 When NEXT is non-nil, check the next line instead."
7693 (save-excursion
7694 (and (not (bobp))
7695 (or (beginning-of-line (if next 2 0)) t)
7696 (save-match-data
7697 (looking-at "[ \t]*$")))))
7699 (defun org-insert-heading (&optional arg invisible-ok top-level)
7700 "Insert a new heading or an item with the same depth at point.
7702 If point is at the beginning of a heading or a list item, insert
7703 a new heading or a new item above the current one. If point is
7704 at the beginning of a normal line, turn the line into a heading.
7706 If point is in the middle of a headline or a list item, split the
7707 headline or the item and create a new headline/item with the text
7708 in the current line after point \(see `org-M-RET-may-split-line'
7709 on how to modify this behavior).
7711 With one universal prefix argument, set the user option
7712 `org-insert-heading-respect-content' to t for the duration of
7713 the command. This modifies the behavior described above in this
7714 ways: on list items and at the beginning of normal lines, force
7715 the insertion of a heading after the current subtree.
7717 With two universal prefix arguments, insert the heading at the
7718 end of the grandparent subtree. For example, if point is within
7719 a 2nd-level heading, then it will insert a 2nd-level heading at
7720 the end of the 1st-level parent heading.
7722 If point is at the beginning of a headline, insert a sibling
7723 before the current headline. If point is not at the beginning,
7724 split the line and create a new headline with the text in the
7725 current line after point \(see `org-M-RET-may-split-line' on how
7726 to modify this behavior).
7728 If point is at the beginning of a normal line, turn this line
7729 into a heading.
7731 When INVISIBLE-OK is set, stop at invisible headlines when going
7732 back. This is important for non-interactive uses of the
7733 command.
7735 When optional argument TOP-LEVEL is non-nil, insert a level 1
7736 heading, unconditionally."
7737 (interactive "P")
7738 (if (org-called-interactively-p 'any) (org-reveal))
7739 (let ((itemp (and (not top-level) (org-in-item-p)))
7740 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7741 (respect-content (or org-insert-heading-respect-content
7742 (equal arg '(4))))
7743 (initial-content ""))
7745 (cond
7747 ((or (= (buffer-size) 0)
7748 (and (not (save-excursion
7749 (and (ignore-errors (org-back-to-heading invisible-ok))
7750 (org-at-heading-p))))
7751 (or arg (not itemp))))
7752 ;; At beginning of buffer or so high up that only a heading
7753 ;; makes sense.
7754 (cond ((and (bolp) (not respect-content)) (insert "* "))
7755 ((not respect-content)
7756 (unless may-split (end-of-line))
7757 (insert "\n* "))
7758 ((re-search-forward org-outline-regexp-bol nil t)
7759 (beginning-of-line)
7760 (insert "* \n")
7761 (backward-char))
7762 (t (goto-char (point-max))
7763 (insert "\n* ")))
7764 (run-hooks 'org-insert-heading-hook))
7766 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7769 ;; Maybe move at the end of the subtree
7770 (when (equal arg '(16))
7771 (org-up-heading-safe)
7772 (org-end-of-subtree t))
7773 ;; Insert a heading
7774 (save-restriction
7775 (widen)
7776 (let* ((level nil)
7777 (on-heading (org-at-heading-p))
7778 (empty-line-p (if on-heading
7779 (org-previous-line-empty-p)
7780 ;; We will decide later
7781 nil))
7782 ;; Get a level string to fall back on.
7783 (fix-level
7784 (if (org-before-first-heading-p) "*"
7785 (save-excursion
7786 (org-back-to-heading t)
7787 (if (org-previous-line-empty-p) (setq empty-line-p t))
7788 (looking-at org-outline-regexp)
7789 (make-string (1- (length (match-string 0))) ?*))))
7790 (stars
7791 (save-excursion
7792 (condition-case nil
7793 (if top-level "* "
7794 (org-back-to-heading invisible-ok)
7795 (when (and (not on-heading)
7796 (featurep 'org-inlinetask)
7797 (integerp org-inlinetask-min-level)
7798 (>= (length (match-string 0))
7799 org-inlinetask-min-level))
7800 ;; Find a heading level before the inline
7801 ;; task.
7802 (while (and (setq level (org-up-heading-safe))
7803 (>= level org-inlinetask-min-level)))
7804 (if (org-at-heading-p)
7805 (org-back-to-heading invisible-ok)
7806 (error "This should not happen")))
7807 (unless (and (save-excursion
7808 (save-match-data
7809 (org-backward-heading-same-level
7810 1 invisible-ok))
7811 (= (point) (match-beginning 0)))
7812 (not (org-previous-line-empty-p t)))
7813 (setq empty-line-p (or empty-line-p
7814 (org-previous-line-empty-p))))
7815 (match-string 0))
7816 (error (or fix-level "* ")))))
7817 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7818 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7819 pos hide-previous previous-pos)
7821 ;; If we insert after content, move there and clean up
7822 ;; whitespace.
7823 (when (and respect-content
7824 (not (org-looking-at-p org-outline-regexp-bol)))
7825 (if (not (org-before-first-heading-p))
7826 (org-end-of-subtree nil t)
7827 (re-search-forward org-outline-regexp-bol)
7828 (beginning-of-line 0))
7829 (skip-chars-backward " \r\t\n")
7830 (and (not (looking-back "^\\*+" (line-beginning-position)))
7831 (looking-at "[ \t]+") (replace-match ""))
7832 (unless (eobp) (forward-char 1))
7833 (when (looking-at "^\\*")
7834 (unless (bobp) (backward-char 1))
7835 (insert "\n")))
7837 ;; If we are splitting, grab the text that should be moved
7838 ;; to the new headline.
7839 (when may-split
7840 (if (org-on-heading-p)
7841 ;; This is a heading: split intelligently (keeping
7842 ;; tags).
7843 (let ((pos (point)))
7844 (beginning-of-line)
7845 (unless (looking-at org-complex-heading-regexp)
7846 (error "This should not happen"))
7847 (when (and (match-beginning 4)
7848 (> pos (match-beginning 4))
7849 (< pos (match-end 4)))
7850 (setq initial-content (buffer-substring pos (match-end 4)))
7851 (goto-char pos)
7852 (delete-region (point) (match-end 4))
7853 (if (looking-at "[ \t]*$")
7854 (replace-match "")
7855 (insert (make-string (length initial-content) ?\s)))
7856 (setq initial-content (org-trim initial-content)))
7857 (goto-char pos))
7858 ;; A normal line.
7859 (setq initial-content
7860 (org-trim
7861 (delete-and-extract-region (point) (line-end-position))))))
7863 ;; If we are at the beginning of the line, insert before it.
7864 ;; Otherwise, after it.
7865 (cond
7866 ((and (bolp) (looking-at "[ \t]*$")))
7867 ((bolp) (save-excursion (insert "\n")))
7868 (t (end-of-line)
7869 (insert "\n")))
7871 ;; Insert the new heading
7872 (insert stars)
7873 (just-one-space)
7874 (insert initial-content)
7875 (unless (and blank (org-previous-line-empty-p))
7876 (org-N-empty-lines-before-current (if blank 1 0)))
7877 ;; Adjust visibility, which may be messed up if we removed
7878 ;; blank lines while previous entry was hidden.
7879 (let ((bol (line-beginning-position)))
7880 (dolist (o (overlays-at (1- bol)))
7881 (when (and (eq (overlay-get o 'invisible) 'outline)
7882 (eq (overlay-end o) bol))
7883 (move-overlay o (overlay-start o) (1- bol)))))
7884 (run-hooks 'org-insert-heading-hook)))))))
7886 (defun org-N-empty-lines-before-current (N)
7887 "Make the number of empty lines before current exactly N.
7888 So this will delete or add empty lines."
7889 (save-excursion
7890 (beginning-of-line)
7891 (let ((p (point)))
7892 (skip-chars-backward " \r\t\n")
7893 (unless (bolp) (forward-line))
7894 (delete-region (point) p))
7895 (when (> N 0) (insert (make-string N ?\n)))))
7897 (defun org-get-heading (&optional no-tags no-todo)
7898 "Return the heading of the current entry, without the stars.
7899 When NO-TAGS is non-nil, don't include tags.
7900 When NO-TODO is non-nil, don't include TODO keywords."
7901 (save-excursion
7902 (org-back-to-heading t)
7903 (cond
7904 ((and no-tags no-todo)
7905 (looking-at org-complex-heading-regexp)
7906 (match-string 4))
7907 (no-tags
7908 (looking-at (concat org-outline-regexp
7909 "\\(.*?\\)"
7910 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7911 (match-string 1))
7912 (no-todo
7913 (looking-at org-todo-line-regexp)
7914 (match-string 3))
7915 (t (looking-at org-heading-regexp)
7916 (match-string 2)))))
7918 (defvar orgstruct-mode) ; defined below
7920 (defun org-heading-components ()
7921 "Return the components of the current heading.
7922 This is a list with the following elements:
7923 - the level as an integer
7924 - the reduced level, different if `org-odd-levels-only' is set.
7925 - the TODO keyword, or nil
7926 - the priority character, like ?A, or nil if no priority is given
7927 - the headline text itself, or the tags string if no headline text
7928 - the tags string, or nil."
7929 (save-excursion
7930 (org-back-to-heading t)
7931 (if (let (case-fold-search)
7932 (looking-at
7933 (if orgstruct-mode
7934 org-heading-regexp
7935 org-complex-heading-regexp)))
7936 (if orgstruct-mode
7937 (list (length (match-string 1))
7938 (org-reduced-level (length (match-string 1)))
7941 (match-string 2)
7942 nil)
7943 (list (length (match-string 1))
7944 (org-reduced-level (length (match-string 1)))
7945 (org-match-string-no-properties 2)
7946 (and (match-end 3) (aref (match-string 3) 2))
7947 (org-match-string-no-properties 4)
7948 (org-match-string-no-properties 5))))))
7950 (defun org-get-entry ()
7951 "Get the entry text, after heading, entire subtree."
7952 (save-excursion
7953 (org-back-to-heading t)
7954 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7956 (defun org-insert-heading-after-current ()
7957 "Insert a new heading with same level as current, after current subtree."
7958 (interactive)
7959 (org-back-to-heading)
7960 (org-insert-heading)
7961 (org-move-subtree-down)
7962 (end-of-line 1))
7964 (defun org-insert-heading-respect-content (&optional invisible-ok)
7965 "Insert heading with `org-insert-heading-respect-content' set to t."
7966 (interactive)
7967 (org-insert-heading '(4) invisible-ok))
7969 (defun org-insert-todo-heading-respect-content (&optional force-state)
7970 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7971 (interactive)
7972 (org-insert-todo-heading force-state '(4)))
7974 (defun org-insert-todo-heading (arg &optional force-heading)
7975 "Insert a new heading with the same level and TODO state as current heading.
7976 If the heading has no TODO state, or if the state is DONE, use the first
7977 state (TODO by default). Also with one prefix arg, force first state. With
7978 two prefix args, force inserting at the end of the parent subtree."
7979 (interactive "P")
7980 (when (or force-heading (not (org-insert-item 'checkbox)))
7981 (org-insert-heading (or (and (equal arg '(16)) '(16))
7982 force-heading))
7983 (save-excursion
7984 (org-back-to-heading)
7985 (outline-previous-heading)
7986 (looking-at org-todo-line-regexp))
7987 (let*
7988 ((new-mark-x
7989 (if (or (equal arg '(4))
7990 (not (match-beginning 2))
7991 (member (match-string 2) org-done-keywords))
7992 (car org-todo-keywords-1)
7993 (match-string 2)))
7994 (new-mark
7996 (run-hook-with-args-until-success
7997 'org-todo-get-default-hook new-mark-x nil)
7998 new-mark-x)))
7999 (beginning-of-line 1)
8000 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8001 (if org-treat-insert-todo-heading-as-state-change
8002 (org-todo new-mark)
8003 (insert new-mark " "))))
8004 (when org-provide-todo-statistics
8005 (org-update-parent-todo-statistics))))
8007 (defun org-insert-subheading (arg)
8008 "Insert a new subheading and demote it.
8009 Works for outline headings and for plain lists alike."
8010 (interactive "P")
8011 (org-insert-heading arg)
8012 (cond
8013 ((org-at-heading-p) (org-do-demote))
8014 ((org-at-item-p) (org-indent-item))))
8016 (defun org-insert-todo-subheading (arg)
8017 "Insert a new subheading with TODO keyword or checkbox and demote it.
8018 Works for outline headings and for plain lists alike."
8019 (interactive "P")
8020 (org-insert-todo-heading arg)
8021 (cond
8022 ((org-at-heading-p) (org-do-demote))
8023 ((org-at-item-p) (org-indent-item))))
8025 ;;; Promotion and Demotion
8027 (defvar org-after-demote-entry-hook nil
8028 "Hook run after an entry has been demoted.
8029 The cursor will be at the beginning of the entry.
8030 When a subtree is being demoted, the hook will be called for each node.")
8032 (defvar org-after-promote-entry-hook nil
8033 "Hook run after an entry has been promoted.
8034 The cursor will be at the beginning of the entry.
8035 When a subtree is being promoted, the hook will be called for each node.")
8037 (defun org-promote-subtree ()
8038 "Promote the entire subtree.
8039 See also `org-promote'."
8040 (interactive)
8041 (save-excursion
8042 (org-with-limited-levels (org-map-tree 'org-promote)))
8043 (org-fix-position-after-promote))
8045 (defun org-demote-subtree ()
8046 "Demote the entire subtree. See `org-demote'.
8047 See also `org-promote'."
8048 (interactive)
8049 (save-excursion
8050 (org-with-limited-levels (org-map-tree 'org-demote)))
8051 (org-fix-position-after-promote))
8054 (defun org-do-promote ()
8055 "Promote the current heading higher up the tree.
8056 If the region is active in `transient-mark-mode', promote all headings
8057 in the region."
8058 (interactive)
8059 (save-excursion
8060 (if (org-region-active-p)
8061 (org-map-region 'org-promote (region-beginning) (region-end))
8062 (org-promote)))
8063 (org-fix-position-after-promote))
8065 (defun org-do-demote ()
8066 "Demote the current heading lower down the tree.
8067 If the region is active in `transient-mark-mode', demote all headings
8068 in the region."
8069 (interactive)
8070 (save-excursion
8071 (if (org-region-active-p)
8072 (org-map-region 'org-demote (region-beginning) (region-end))
8073 (org-demote)))
8074 (org-fix-position-after-promote))
8076 (defun org-fix-position-after-promote ()
8077 "Make sure that after pro/demotion cursor position is right."
8078 (let ((pos (point)))
8079 (when (save-excursion
8080 (beginning-of-line 1)
8081 (looking-at org-todo-line-regexp)
8082 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8083 (cond ((eobp) (insert " "))
8084 ((eolp) (insert " "))
8085 ((equal (char-after) ?\ ) (forward-char 1))))))
8087 (defun org-current-level ()
8088 "Return the level of the current entry, or nil if before the first headline.
8089 The level is the number of stars at the beginning of the
8090 headline. Use `org-reduced-level' to remove the effect of
8091 `org-odd-levels'. Unlike to `org-outline-level', this function
8092 ignores inlinetasks."
8093 (let ((level (org-with-limited-levels (org-outline-level))))
8094 (and (> level 0) level)))
8096 (defun org-get-previous-line-level ()
8097 "Return the outline depth of the last headline before the current line.
8098 Returns 0 for the first headline in the buffer, and nil if before the
8099 first headline."
8100 (and (org-current-level)
8101 (or (and (/= (line-beginning-position) (point-min))
8102 (save-excursion (beginning-of-line 0) (org-current-level)))
8103 0)))
8105 (defun org-reduced-level (l)
8106 "Compute the effective level of a heading.
8107 This takes into account the setting of `org-odd-levels-only'."
8108 (cond
8109 ((zerop l) 0)
8110 (org-odd-levels-only (1+ (floor (/ l 2))))
8111 (t l)))
8113 (defun org-level-increment ()
8114 "Return the number of stars that will be added or removed at a
8115 time to headlines when structure editing, based on the value of
8116 `org-odd-levels-only'."
8117 (if org-odd-levels-only 2 1))
8119 (defun org-get-valid-level (level &optional change)
8120 "Rectify a level change under the influence of `org-odd-levels-only'
8121 LEVEL is a current level, CHANGE is by how much the level should be
8122 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8123 even level numbers will become the next higher odd number."
8124 (if org-odd-levels-only
8125 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8126 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8127 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8128 (max 1 (+ level (or change 0)))))
8130 (if (boundp 'define-obsolete-function-alias)
8131 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8132 (define-obsolete-function-alias 'org-get-legal-level
8133 'org-get-valid-level)
8134 (define-obsolete-function-alias 'org-get-legal-level
8135 'org-get-valid-level "23.1")))
8137 (defun org-promote ()
8138 "Promote the current heading higher up the tree."
8139 (org-with-wide-buffer
8140 (org-back-to-heading t)
8141 (let* ((after-change-functions (remq 'flyspell-after-change-function
8142 after-change-functions))
8143 (level (save-match-data (funcall outline-level)))
8144 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8145 (diff (abs (- level (length up-head) -1))))
8146 (cond
8147 ((and (= level 1) org-allow-promoting-top-level-subtree)
8148 (replace-match "# " nil t))
8149 ((= level 1)
8150 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8151 (t (replace-match up-head nil t)))
8152 (unless (= level 1)
8153 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8154 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8155 (run-hooks 'org-after-promote-entry-hook))))
8157 (defun org-demote ()
8158 "Demote the current heading lower down the tree."
8159 (org-with-wide-buffer
8160 (org-back-to-heading t)
8161 (let* ((after-change-functions (remq 'flyspell-after-change-function
8162 after-change-functions))
8163 (level (save-match-data (funcall outline-level)))
8164 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8165 (diff (abs (- level (length down-head) -1))))
8166 (replace-match down-head nil t)
8167 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8168 (when org-adapt-indentation (org-fixup-indentation diff))
8169 (run-hooks 'org-after-demote-entry-hook))))
8171 (defun org-cycle-level ()
8172 "Cycle the level of an empty headline through possible states.
8173 This goes first to child, then to parent, level, then up the hierarchy.
8174 After top level, it switches back to sibling level."
8175 (interactive)
8176 (let ((org-adapt-indentation nil))
8177 (when (org-point-at-end-of-empty-headline)
8178 (setq this-command 'org-cycle-level) ; Only needed for caching
8179 (let ((cur-level (org-current-level))
8180 (prev-level (org-get-previous-line-level)))
8181 (cond
8182 ;; If first headline in file, promote to top-level.
8183 ((= prev-level 0)
8184 (loop repeat (/ (- cur-level 1) (org-level-increment))
8185 do (org-do-promote)))
8186 ;; If same level as prev, demote one.
8187 ((= prev-level cur-level)
8188 (org-do-demote))
8189 ;; If parent is top-level, promote to top level if not already.
8190 ((= prev-level 1)
8191 (loop repeat (/ (- cur-level 1) (org-level-increment))
8192 do (org-do-promote)))
8193 ;; If top-level, return to prev-level.
8194 ((= cur-level 1)
8195 (loop repeat (/ (- prev-level 1) (org-level-increment))
8196 do (org-do-demote)))
8197 ;; If less than prev-level, promote one.
8198 ((< cur-level prev-level)
8199 (org-do-promote))
8200 ;; If deeper than prev-level, promote until higher than
8201 ;; prev-level.
8202 ((> cur-level prev-level)
8203 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8204 do (org-do-promote))))
8205 t))))
8207 (defun org-map-tree (fun)
8208 "Call FUN for every heading underneath the current one."
8209 (org-back-to-heading)
8210 (let ((level (funcall outline-level)))
8211 (save-excursion
8212 (funcall fun)
8213 (while (and (progn
8214 (outline-next-heading)
8215 (> (funcall outline-level) level))
8216 (not (eobp)))
8217 (funcall fun)))))
8219 (defun org-map-region (fun beg end)
8220 "Call FUN for every heading between BEG and END."
8221 (let ((org-ignore-region t))
8222 (save-excursion
8223 (setq end (copy-marker end))
8224 (goto-char beg)
8225 (if (and (re-search-forward org-outline-regexp-bol nil t)
8226 (< (point) end))
8227 (funcall fun))
8228 (while (and (progn
8229 (outline-next-heading)
8230 (< (point) end))
8231 (not (eobp)))
8232 (funcall fun)))))
8234 (defun org-fixup-indentation (diff)
8235 "Change the indentation in the current entry by DIFF.
8237 DIFF is an integer. Indentation is done according to the
8238 following rules:
8240 - Planning information and property drawers are always indented
8241 according to the new level of the headline;
8243 - Footnote definitions and their contents are ignored;
8245 - Inlinetasks' boundaries are not shifted;
8247 - Empty lines are ignored;
8249 - Other lines' indentation are shifted by DIFF columns, unless
8250 it would introduce a structural change in the document, in
8251 which case no shifting is done at all.
8253 Assume point is at a heading or an inlinetask beginning."
8254 (org-with-wide-buffer
8255 (narrow-to-region (line-beginning-position)
8256 (save-excursion
8257 (if (org-with-limited-levels (org-at-heading-p))
8258 (org-with-limited-levels (outline-next-heading))
8259 (org-inlinetask-goto-end))
8260 (point)))
8261 (forward-line)
8262 ;; Indent properly planning info and property drawer.
8263 (when (org-looking-at-p org-planning-line-re)
8264 (org-indent-line)
8265 (forward-line))
8266 (when (looking-at org-property-drawer-re)
8267 (goto-char (match-end 0))
8268 (forward-line)
8269 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8270 (catch 'no-shift
8271 (when (zerop diff) (throw 'no-shift nil))
8272 ;; If DIFF is negative, first check if a shift is possible at all
8273 ;; (e.g., it doesn't break structure). This can only happen if
8274 ;; some contents are not properly indented.
8275 (let ((case-fold-search t))
8276 (when (< diff 0)
8277 (let ((diff (- diff))
8278 (forbidden-re (concat org-outline-regexp
8279 "\\|"
8280 (substring org-footnote-definition-re 1))))
8281 (save-excursion
8282 (while (not (eobp))
8283 (cond
8284 ((org-looking-at-p "[ \t]*$") (forward-line))
8285 ((and (org-looking-at-p org-footnote-definition-re)
8286 (let ((e (org-element-at-point)))
8287 (and (eq (org-element-type e) 'footnote-definition)
8288 (goto-char (org-element-property :end e))))))
8289 ((org-looking-at-p org-outline-regexp) (forward-line))
8290 ;; Give up if shifting would move before column 0 or
8291 ;; if it would introduce a headline or a footnote
8292 ;; definition.
8294 (skip-chars-forward " \t")
8295 (let ((ind (current-column)))
8296 (when (or (< ind diff)
8297 (and (= ind diff) (org-looking-at-p forbidden-re)))
8298 (throw 'no-shift nil)))
8299 ;; Ignore contents of example blocks and source
8300 ;; blocks if their indentation is meant to be
8301 ;; preserved. Jump to block's closing line.
8302 (beginning-of-line)
8303 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8304 (let ((e (org-element-at-point)))
8305 (and (memq (org-element-type e)
8306 '(example-block src-block))
8307 (or org-src-preserve-indentation
8308 (org-element-property :preserve-indent e))
8309 (goto-char (org-element-property :end e))
8310 (progn (skip-chars-backward " \r\t\n")
8311 (beginning-of-line)
8312 t))))
8313 (forward-line))))))))
8314 ;; Shift lines but footnote definitions, inlinetasks boundaries
8315 ;; by DIFF. Also skip contents of source or example blocks
8316 ;; when indentation is meant to be preserved.
8317 (while (not (eobp))
8318 (cond
8319 ((and (org-looking-at-p org-footnote-definition-re)
8320 (let ((e (org-element-at-point)))
8321 (and (eq (org-element-type e) 'footnote-definition)
8322 (goto-char (org-element-property :end e))))))
8323 ((org-looking-at-p org-outline-regexp) (forward-line))
8324 ((org-looking-at-p "[ \t]*$") (forward-line))
8326 (org-indent-line-to (+ (org-get-indentation) diff))
8327 (beginning-of-line)
8328 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8329 (let ((e (org-element-at-point)))
8330 (and (memq (org-element-type e)
8331 '(example-block src-block))
8332 (or org-src-preserve-indentation
8333 (org-element-property :preserve-indent e))
8334 (goto-char (org-element-property :end e))
8335 (progn (skip-chars-backward " \r\t\n")
8336 (beginning-of-line)
8337 t))))
8338 (forward-line)))))))))
8340 (defun org-convert-to-odd-levels ()
8341 "Convert an org-mode file with all levels allowed to one with odd levels.
8342 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8343 level 5 etc."
8344 (interactive)
8345 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8346 (let ((outline-level 'org-outline-level)
8347 (org-odd-levels-only nil) n)
8348 (save-excursion
8349 (goto-char (point-min))
8350 (while (re-search-forward "^\\*\\*+ " nil t)
8351 (setq n (- (length (match-string 0)) 2))
8352 (while (>= (setq n (1- n)) 0)
8353 (org-demote))
8354 (end-of-line 1))))))
8356 (defun org-convert-to-oddeven-levels ()
8357 "Convert an org-mode file with only odd levels to one with odd/even levels.
8358 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8359 file contains a section with an even level, conversion would
8360 destroy the structure of the file. An error is signaled in this
8361 case."
8362 (interactive)
8363 (goto-char (point-min))
8364 ;; First check if there are no even levels
8365 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8366 (org-show-set-visibility 'canonical)
8367 (error "Not all levels are odd in this file. Conversion not possible"))
8368 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8369 (let ((outline-regexp org-outline-regexp)
8370 (outline-level 'org-outline-level)
8371 (org-odd-levels-only nil) n)
8372 (save-excursion
8373 (goto-char (point-min))
8374 (while (re-search-forward "^\\*\\*+ " nil t)
8375 (setq n (/ (1- (length (match-string 0))) 2))
8376 (while (>= (setq n (1- n)) 0)
8377 (org-promote))
8378 (end-of-line 1))))))
8380 (defun org-tr-level (n)
8381 "Make N odd if required."
8382 (if org-odd-levels-only (1+ (/ n 2)) n))
8384 ;;; Vertical tree motion, cutting and pasting of subtrees
8386 (defun org-move-subtree-up (&optional arg)
8387 "Move the current subtree up past ARG headlines of the same level."
8388 (interactive "p")
8389 (org-move-subtree-down (- (prefix-numeric-value arg))))
8391 (defun org-move-subtree-down (&optional arg)
8392 "Move the current subtree down past ARG headlines of the same level."
8393 (interactive "p")
8394 (setq arg (prefix-numeric-value arg))
8395 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8396 'org-get-last-sibling))
8397 (ins-point (make-marker))
8398 (cnt (abs arg))
8399 (col (current-column))
8400 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8401 ;; Select the tree
8402 (org-back-to-heading)
8403 (setq beg0 (point))
8404 (save-excursion
8405 (setq ne-beg (org-back-over-empty-lines))
8406 (setq beg (point)))
8407 (save-match-data
8408 (save-excursion (outline-end-of-heading)
8409 (setq folded (outline-invisible-p)))
8410 (progn (org-end-of-subtree nil t)
8411 (unless (eobp) (backward-char))))
8412 (outline-next-heading)
8413 (setq ne-end (org-back-over-empty-lines))
8414 (setq end (point))
8415 (goto-char beg0)
8416 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8417 ;; include less whitespace
8418 (save-excursion
8419 (goto-char beg)
8420 (forward-line (- ne-beg ne-end))
8421 (setq beg (point))))
8422 ;; Find insertion point, with error handling
8423 (while (> cnt 0)
8424 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8425 (progn (goto-char beg0)
8426 (user-error "Cannot move past superior level or buffer limit")))
8427 (setq cnt (1- cnt)))
8428 (if (> arg 0)
8429 ;; Moving forward - still need to move over subtree
8430 (progn (org-end-of-subtree t t)
8431 (save-excursion
8432 (org-back-over-empty-lines)
8433 (or (bolp) (newline)))))
8434 (setq ne-ins (org-back-over-empty-lines))
8435 (move-marker ins-point (point))
8436 (setq txt (buffer-substring beg end))
8437 (org-save-markers-in-region beg end)
8438 (delete-region beg end)
8439 (org-remove-empty-overlays-at beg)
8440 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8441 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8442 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8443 (let ((bbb (point)))
8444 (insert-before-markers txt)
8445 (org-reinstall-markers-in-region bbb)
8446 (move-marker ins-point bbb))
8447 (or (bolp) (insert "\n"))
8448 (setq ins-end (point))
8449 (goto-char ins-point)
8450 (org-skip-whitespace)
8451 (when (and (< arg 0)
8452 (org-first-sibling-p)
8453 (> ne-ins ne-beg))
8454 ;; Move whitespace back to beginning
8455 (save-excursion
8456 (goto-char ins-end)
8457 (let ((kill-whole-line t))
8458 (kill-line (- ne-ins ne-beg)) (point)))
8459 (insert (make-string (- ne-ins ne-beg) ?\n)))
8460 (move-marker ins-point nil)
8461 (if folded
8462 (hide-subtree)
8463 (org-show-entry)
8464 (show-children)
8465 (org-cycle-hide-drawers 'children))
8466 (org-clean-visibility-after-subtree-move)
8467 ;; move back to the initial column we were at
8468 (move-to-column col)))
8470 (defvar org-subtree-clip ""
8471 "Clipboard for cut and paste of subtrees.
8472 This is actually only a copy of the kill, because we use the normal kill
8473 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8475 (defvar org-subtree-clip-folded nil
8476 "Was the last copied subtree folded?
8477 This is used to fold the tree back after pasting.")
8479 (defun org-cut-subtree (&optional n)
8480 "Cut the current subtree into the clipboard.
8481 With prefix arg N, cut this many sequential subtrees.
8482 This is a short-hand for marking the subtree and then cutting it."
8483 (interactive "p")
8484 (org-copy-subtree n 'cut))
8486 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8487 "Copy the current subtree it in the clipboard.
8488 With prefix arg N, copy this many sequential subtrees.
8489 This is a short-hand for marking the subtree and then copying it.
8490 If CUT is non-nil, actually cut the subtree.
8491 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8492 of some markers in the region, even if CUT is non-nil. This is
8493 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8494 (interactive "p")
8495 (let (beg end folded (beg0 (point)))
8496 (if (org-called-interactively-p 'any)
8497 (org-back-to-heading nil) ; take what looks like a subtree
8498 (org-back-to-heading t)) ; take what is really there
8499 (setq beg (point))
8500 (skip-chars-forward " \t\r\n")
8501 (save-match-data
8502 (if nosubtrees
8503 (outline-next-heading)
8504 (save-excursion (outline-end-of-heading)
8505 (setq folded (outline-invisible-p)))
8506 (ignore-errors (org-forward-heading-same-level (1- n) t))
8507 (org-end-of-subtree t t)))
8508 ;; Include the end of an inlinetask
8509 (when (and (featurep 'org-inlinetask)
8510 (looking-at-p (concat (org-inlinetask-outline-regexp)
8511 "END[ \t]*$")))
8512 (end-of-line))
8513 (setq end (point))
8514 (goto-char beg0)
8515 (when (> end beg)
8516 (setq org-subtree-clip-folded folded)
8517 (when (or cut force-store-markers)
8518 (org-save-markers-in-region beg end))
8519 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8520 (setq org-subtree-clip (current-kill 0))
8521 (message "%s: Subtree(s) with %d characters"
8522 (if cut "Cut" "Copied")
8523 (length org-subtree-clip)))))
8525 (defun org-paste-subtree (&optional level tree for-yank remove)
8526 "Paste the clipboard as a subtree, with modification of headline level.
8527 The entire subtree is promoted or demoted in order to match a new headline
8528 level.
8530 If the cursor is at the beginning of a headline, the same level as
8531 that headline is used to paste the tree.
8533 If not, the new level is derived from the *visible* headings
8534 before and after the insertion point, and taken to be the inferior headline
8535 level of the two. So if the previous visible heading is level 3 and the
8536 next is level 4 (or vice versa), level 4 will be used for insertion.
8537 This makes sure that the subtree remains an independent subtree and does
8538 not swallow low level entries.
8540 You can also force a different level, either by using a numeric prefix
8541 argument, or by inserting the heading marker by hand. For example, if the
8542 cursor is after \"*****\", then the tree will be shifted to level 5.
8544 If optional TREE is given, use this text instead of the kill ring.
8546 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8547 move back over whitespace before inserting, and move point to the end of
8548 the inserted text when done.
8550 When REMOVE is non-nil, remove the subtree from the clipboard."
8551 (interactive "P")
8552 (setq tree (or tree (and kill-ring (current-kill 0))))
8553 (unless (org-kill-is-subtree-p tree)
8554 (user-error "%s"
8555 (substitute-command-keys
8556 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8557 (org-with-limited-levels
8558 (let* ((visp (not (outline-invisible-p)))
8559 (txt tree)
8560 (^re_ "\\(\\*+\\)[ \t]*")
8561 (old-level (if (string-match org-outline-regexp-bol txt)
8562 (- (match-end 0) (match-beginning 0) 1)
8563 -1))
8564 (force-level (cond (level (prefix-numeric-value level))
8565 ((and (looking-at "[ \t]*$")
8566 (string-match
8567 "^\\*+$" (buffer-substring
8568 (point-at-bol) (point))))
8569 (- (match-end 0) (match-beginning 0)))
8570 ((and (bolp)
8571 (looking-at org-outline-regexp))
8572 (- (match-end 0) (point) 1))))
8573 (previous-level (save-excursion
8574 (condition-case nil
8575 (progn
8576 (outline-previous-visible-heading 1)
8577 (if (looking-at ^re_)
8578 (- (match-end 0) (match-beginning 0) 1)
8580 (error 1))))
8581 (next-level (save-excursion
8582 (condition-case nil
8583 (progn
8584 (or (looking-at org-outline-regexp)
8585 (outline-next-visible-heading 1))
8586 (if (looking-at ^re_)
8587 (- (match-end 0) (match-beginning 0) 1)
8589 (error 1))))
8590 (new-level (or force-level (max previous-level next-level)))
8591 (shift (if (or (= old-level -1)
8592 (= new-level -1)
8593 (= old-level new-level))
8595 (- new-level old-level)))
8596 (delta (if (> shift 0) -1 1))
8597 (func (if (> shift 0) 'org-demote 'org-promote))
8598 (org-odd-levels-only nil)
8599 beg end newend)
8600 ;; Remove the forced level indicator
8601 (if force-level
8602 (delete-region (point-at-bol) (point)))
8603 ;; Paste
8604 (beginning-of-line (if (bolp) 1 2))
8605 (setq beg (point))
8606 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8607 (insert-before-markers txt)
8608 (unless (string-match "\n\\'" txt) (insert "\n"))
8609 (setq newend (point))
8610 (org-reinstall-markers-in-region beg)
8611 (setq end (point))
8612 (goto-char beg)
8613 (skip-chars-forward " \t\n\r")
8614 (setq beg (point))
8615 (if (and (outline-invisible-p) visp)
8616 (save-excursion (outline-show-heading)))
8617 ;; Shift if necessary
8618 (unless (= shift 0)
8619 (save-restriction
8620 (narrow-to-region beg end)
8621 (while (not (= shift 0))
8622 (org-map-region func (point-min) (point-max))
8623 (setq shift (+ delta shift)))
8624 (goto-char (point-min))
8625 (setq newend (point-max))))
8626 (when (or (org-called-interactively-p 'interactive) for-yank)
8627 (message "Clipboard pasted as level %d subtree" new-level))
8628 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8629 kill-ring
8630 (eq org-subtree-clip (current-kill 0))
8631 org-subtree-clip-folded)
8632 ;; The tree was folded before it was killed/copied
8633 (hide-subtree))
8634 (and for-yank (goto-char newend))
8635 (and remove (setq kill-ring (cdr kill-ring))))))
8637 (defun org-kill-is-subtree-p (&optional txt)
8638 "Check if the current kill is an outline subtree, or a set of trees.
8639 Returns nil if kill does not start with a headline, or if the first
8640 headline level is not the largest headline level in the tree.
8641 So this will actually accept several entries of equal levels as well,
8642 which is OK for `org-paste-subtree'.
8643 If optional TXT is given, check this string instead of the current kill."
8644 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8645 (re (org-get-limited-outline-regexp))
8646 (^re (concat "^" re))
8647 (start-level (and kill
8648 (string-match
8649 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8650 kill)
8651 (- (match-end 2) (match-beginning 2) 1)))
8652 (start (1+ (or (match-beginning 2) -1))))
8653 (if (not start-level)
8654 (progn
8655 nil) ;; does not even start with a heading
8656 (catch 'exit
8657 (while (setq start (string-match ^re kill (1+ start)))
8658 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8659 (throw 'exit nil)))
8660 t))))
8662 (defvar org-markers-to-move nil
8663 "Markers that should be moved with a cut-and-paste operation.
8664 Those markers are stored together with their positions relative to
8665 the start of the region.")
8667 (defun org-save-markers-in-region (beg end)
8668 "Check markers in region.
8669 If these markers are between BEG and END, record their position relative
8670 to BEG, so that after moving the block of text, we can put the markers back
8671 into place.
8672 This function gets called just before an entry or tree gets cut from the
8673 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8674 called immediately, to move the markers with the entries."
8675 (setq org-markers-to-move nil)
8676 (when (featurep 'org-clock)
8677 (org-clock-save-markers-for-cut-and-paste beg end))
8678 (when (featurep 'org-agenda)
8679 (org-agenda-save-markers-for-cut-and-paste beg end)))
8681 (defun org-check-and-save-marker (marker beg end)
8682 "Check if MARKER is between BEG and END.
8683 If yes, remember the marker and the distance to BEG."
8684 (when (and (marker-buffer marker)
8685 (equal (marker-buffer marker) (current-buffer)))
8686 (if (and (>= marker beg) (< marker end))
8687 (push (cons marker (- marker beg)) org-markers-to-move))))
8689 (defun org-reinstall-markers-in-region (beg)
8690 "Move all remembered markers to their position relative to BEG."
8691 (mapc (lambda (x)
8692 (move-marker (car x) (+ beg (cdr x))))
8693 org-markers-to-move)
8694 (setq org-markers-to-move nil))
8696 (defun org-narrow-to-subtree ()
8697 "Narrow buffer to the current subtree."
8698 (interactive)
8699 (save-excursion
8700 (save-match-data
8701 (org-with-limited-levels
8702 (narrow-to-region
8703 (progn (org-back-to-heading t) (point))
8704 (progn (org-end-of-subtree t t)
8705 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8706 (point)))))))
8708 (defun org-narrow-to-block ()
8709 "Narrow buffer to the current block."
8710 (interactive)
8711 (let* ((case-fold-search t)
8712 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8713 "^[ \t]*#\\+end_.*")))
8714 (if blockp
8715 (narrow-to-region (car blockp) (cdr blockp))
8716 (user-error "Not in a block"))))
8718 (defun org-clone-subtree-with-time-shift (n &optional shift)
8719 "Clone the task (subtree) at point N times.
8720 The clones will be inserted as siblings.
8722 In interactive use, the user will be prompted for the number of
8723 clones to be produced. If the entry has a timestamp, the user
8724 will also be prompted for a time shift, which may be a repeater
8725 as used in time stamps, for example `+3d'. To disable this,
8726 you can call the function with a universal prefix argument.
8728 When a valid repeater is given and the entry contains any time
8729 stamps, the clones will become a sequence in time, with time
8730 stamps in the subtree shifted for each clone produced. If SHIFT
8731 is nil or the empty string, time stamps will be left alone. The
8732 ID property of the original subtree is removed.
8734 If the original subtree did contain time stamps with a repeater,
8735 the following will happen:
8736 - the repeater will be removed in each clone
8737 - an additional clone will be produced, with the current, unshifted
8738 date(s) in the entry.
8739 - the original entry will be placed *after* all the clones, with
8740 repeater intact.
8741 - the start days in the repeater in the original entry will be shifted
8742 to past the last clone.
8743 In this way you can spell out a number of instances of a repeating task,
8744 and still retain the repeater to cover future instances of the task.
8746 As described above, N+1 clones are produced when the original
8747 subtree has a repeater. Setting N to 0, then, can be used to
8748 remove the repeater from a subtree and create a shifted clone
8749 with the original repeater."
8750 (interactive "nNumber of clones to produce: ")
8751 (let ((shift
8752 (or shift
8753 (if (and (not (equal current-prefix-arg '(4)))
8754 (save-excursion
8755 (re-search-forward org-ts-regexp-both
8756 (save-excursion
8757 (org-end-of-subtree t)
8758 (point)) t)))
8759 (read-from-minibuffer
8760 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8761 ""))) ;; No time shift
8762 (n-no-remove -1)
8763 (drawer-re org-drawer-regexp)
8764 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8765 beg end template task idprop
8766 shift-n shift-what doshift nmin nmax)
8767 (unless (wholenump n)
8768 (user-error "Invalid number of replications %s" n))
8769 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8770 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8771 shift)))
8772 (user-error "Invalid shift specification %s" shift))
8773 (when doshift
8774 (setq shift-n (string-to-number (match-string 1 shift))
8775 shift-what (cdr (assoc (match-string 2 shift)
8776 '(("d" . day) ("w" . week)
8777 ("m" . month) ("y" . year))))))
8778 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8779 (setq nmin 1 nmax n)
8780 (org-back-to-heading t)
8781 (setq beg (point))
8782 (setq idprop (org-entry-get nil "ID"))
8783 (org-end-of-subtree t t)
8784 (or (bolp) (insert "\n"))
8785 (setq end (point))
8786 (setq template (buffer-substring beg end))
8787 (when (and doshift
8788 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8789 (delete-region beg end)
8790 (setq end beg)
8791 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8792 (goto-char end)
8793 (loop for n from nmin to nmax do
8794 ;; prepare clone
8795 (with-temp-buffer
8796 (insert template)
8797 (org-mode)
8798 (goto-char (point-min))
8799 (org-show-subtree)
8800 (and idprop (if org-clone-delete-id
8801 (org-entry-delete nil "ID")
8802 (org-id-get-create t)))
8803 (unless (= n 0)
8804 (while (re-search-forward org-clock-re nil t)
8805 (kill-whole-line))
8806 (goto-char (point-min))
8807 (while (re-search-forward drawer-re nil t)
8808 (org-remove-empty-drawer-at (point))))
8809 (goto-char (point-min))
8810 (when doshift
8811 (while (re-search-forward org-ts-regexp-both nil t)
8812 (org-timestamp-change (* n shift-n) shift-what))
8813 (unless (= n n-no-remove)
8814 (goto-char (point-min))
8815 (while (re-search-forward org-ts-regexp nil t)
8816 (save-excursion
8817 (goto-char (match-beginning 0))
8818 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8819 (delete-region (match-beginning 1) (match-end 1)))))))
8820 (setq task (buffer-string)))
8821 (insert task))
8822 (goto-char beg)))
8824 ;;; Outline Sorting
8826 (defun org-sort (with-case)
8827 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8828 Optional argument WITH-CASE means sort case-sensitively."
8829 (interactive "P")
8830 (cond
8831 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8832 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8834 (org-call-with-arg 'org-sort-entries with-case))))
8836 (defun org-sort-remove-invisible (s)
8837 "Remove invisible links from string S."
8838 (remove-text-properties 0 (length s) org-rm-props s)
8839 (while (string-match org-bracket-link-regexp s)
8840 (setq s (replace-match (if (match-end 2)
8841 (match-string 3 s)
8842 (match-string 1 s))
8843 t t s)))
8844 (let ((st (format " %s " s)))
8845 (while (string-match org-emph-re st)
8846 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8847 (setq s (substring st 1 -1)))
8850 (defvar org-priority-regexp) ; defined later in the file
8852 (defvar org-after-sorting-entries-or-items-hook nil
8853 "Hook that is run after a bunch of entries or items have been sorted.
8854 When children are sorted, the cursor is in the parent line when this
8855 hook gets called. When a region or a plain list is sorted, the cursor
8856 will be in the first entry of the sorted region/list.")
8858 (defun org-sort-entries
8859 (&optional with-case sorting-type getkey-func compare-func property)
8860 "Sort entries on a certain level of an outline tree.
8861 If there is an active region, the entries in the region are sorted.
8862 Else, if the cursor is before the first entry, sort the top-level items.
8863 Else, the children of the entry at point are sorted.
8865 Sorting can be alphabetically, numerically, by date/time as given by
8866 a time stamp, by a property, by priority order, or by a custom function.
8868 The command prompts for the sorting type unless it has been given to the
8869 function through the SORTING-TYPE argument, which needs to be a character,
8870 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8871 the precise meaning of each character:
8873 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8874 c By creation time, which is assumed to be the first inactive time stamp
8875 at the beginning of a line.
8876 d By deadline date/time.
8877 k By clocking time.
8878 n Numerically, by converting the beginning of the entry/item to a number.
8879 o By order of TODO keywords.
8880 p By priority according to the cookie.
8881 r By the value of a property.
8882 s By scheduled date/time.
8883 t By date/time, either the first active time stamp in the entry, or, if
8884 none exist, by the first inactive one.
8886 Capital letters will reverse the sort order.
8888 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8889 called with point at the beginning of the record. It must return either
8890 a string or a number that should serve as the sorting key for that record.
8892 Comparing entries ignores case by default. However, with an optional argument
8893 WITH-CASE, the sorting considers case as well.
8895 Sorting is done against the visible part of the headlines, it ignores hidden
8896 links.
8898 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8899 (interactive "P")
8900 (let ((case-func (if with-case 'identity 'downcase))
8901 (cmstr
8902 ;; The clock marker is lost when using `sort-subr', let's
8903 ;; store the clocking string.
8904 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8905 (save-excursion
8906 (goto-char org-clock-marker)
8907 (buffer-substring-no-properties (line-beginning-position)
8908 (point)))))
8909 start beg end stars re re2
8910 txt what tmp)
8911 ;; Find beginning and end of region to sort
8912 (cond
8913 ((org-region-active-p)
8914 ;; we will sort the region
8915 (setq end (region-end)
8916 what "region")
8917 (goto-char (region-beginning))
8918 (if (not (org-at-heading-p)) (outline-next-heading))
8919 (setq start (point)))
8920 ((or (org-at-heading-p)
8921 (ignore-errors (progn (org-back-to-heading) t)))
8922 ;; we will sort the children of the current headline
8923 (org-back-to-heading)
8924 (setq start (point)
8925 end (progn (org-end-of-subtree t t)
8926 (or (bolp) (insert "\n"))
8927 (when (>= (org-back-over-empty-lines) 1)
8928 (forward-line 1))
8929 (point))
8930 what "children")
8931 (goto-char start)
8932 (show-subtree)
8933 (outline-next-heading))
8935 ;; we will sort the top-level entries in this file
8936 (goto-char (point-min))
8937 (or (org-at-heading-p) (outline-next-heading))
8938 (setq start (point))
8939 (goto-char (point-max))
8940 (beginning-of-line 1)
8941 (when (looking-at ".*?\\S-")
8942 ;; File ends in a non-white line
8943 (end-of-line 1)
8944 (insert "\n"))
8945 (setq end (point-max))
8946 (setq what "top-level")
8947 (goto-char start)
8948 (show-all)))
8950 (setq beg (point))
8951 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8953 (looking-at "\\(\\*+\\)")
8954 (setq stars (match-string 1)
8955 re (concat "^" (regexp-quote stars) " +")
8956 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8957 txt (buffer-substring beg end))
8958 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8959 (if (and (not (equal stars "*")) (string-match re2 txt))
8960 (user-error "Region to sort contains a level above the first entry"))
8962 (unless sorting-type
8963 (message
8964 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8965 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8966 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8967 what)
8968 (setq sorting-type (read-char-exclusive))
8970 (unless getkey-func
8971 (and (= (downcase sorting-type) ?f)
8972 (setq getkey-func
8973 (org-icompleting-read "Sort using function: "
8974 obarray 'fboundp t nil nil))
8975 (setq getkey-func (intern getkey-func))))
8977 (and (= (downcase sorting-type) ?r)
8978 (not property)
8979 (setq property
8980 (org-icompleting-read "Property: "
8981 (mapcar 'list (org-buffer-property-keys t))
8982 nil t))))
8984 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8985 (message "Sorting entries...")
8987 (save-restriction
8988 (narrow-to-region start end)
8989 (let ((dcst (downcase sorting-type))
8990 (case-fold-search nil)
8991 (now (current-time)))
8992 (sort-subr
8993 (/= dcst sorting-type)
8994 ;; This function moves to the beginning character of the "record" to
8995 ;; be sorted.
8996 (lambda nil
8997 (if (re-search-forward re nil t)
8998 (goto-char (match-beginning 0))
8999 (goto-char (point-max))))
9000 ;; This function moves to the last character of the "record" being
9001 ;; sorted.
9002 (lambda nil
9003 (save-match-data
9004 (condition-case nil
9005 (outline-forward-same-level 1)
9006 (error
9007 (goto-char (point-max))))))
9008 ;; This function returns the value that gets sorted against.
9009 (lambda nil
9010 (cond
9011 ((= dcst ?n)
9012 (if (looking-at org-complex-heading-regexp)
9013 (string-to-number (org-sort-remove-invisible (match-string 4)))
9014 nil))
9015 ((= dcst ?a)
9016 (if (looking-at org-complex-heading-regexp)
9017 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9018 nil))
9019 ((= dcst ?k)
9020 (or (get-text-property (point) :org-clock-minutes) 0))
9021 ((= dcst ?t)
9022 (let ((end (save-excursion (outline-next-heading) (point))))
9023 (if (or (re-search-forward org-ts-regexp end t)
9024 (re-search-forward org-ts-regexp-both end t))
9025 (org-time-string-to-seconds (match-string 0))
9026 (org-float-time now))))
9027 ((= dcst ?c)
9028 (let ((end (save-excursion (outline-next-heading) (point))))
9029 (if (re-search-forward
9030 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9031 end t)
9032 (org-time-string-to-seconds (match-string 0))
9033 (org-float-time now))))
9034 ((= dcst ?s)
9035 (let ((end (save-excursion (outline-next-heading) (point))))
9036 (if (re-search-forward org-scheduled-time-regexp end t)
9037 (org-time-string-to-seconds (match-string 1))
9038 (org-float-time now))))
9039 ((= dcst ?d)
9040 (let ((end (save-excursion (outline-next-heading) (point))))
9041 (if (re-search-forward org-deadline-time-regexp end t)
9042 (org-time-string-to-seconds (match-string 1))
9043 (org-float-time now))))
9044 ((= dcst ?p)
9045 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9046 (string-to-char (match-string 2))
9047 org-default-priority))
9048 ((= dcst ?r)
9049 (or (org-entry-get nil property) ""))
9050 ((= dcst ?o)
9051 (if (looking-at org-complex-heading-regexp)
9052 (let* ((m (match-string 2))
9053 (s (if (member m org-done-keywords) '- '+)))
9054 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9055 ((= dcst ?f)
9056 (if getkey-func
9057 (progn
9058 (setq tmp (funcall getkey-func))
9059 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9060 tmp)
9061 (error "Invalid key function `%s'" getkey-func)))
9062 (t (error "Invalid sorting type `%c'" sorting-type))))
9064 (cond
9065 ((= dcst ?a) 'string<)
9066 ((= dcst ?f) compare-func)
9067 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9068 (run-hooks 'org-after-sorting-entries-or-items-hook)
9069 ;; Reset the clock marker if needed
9070 (when cmstr
9071 (save-excursion
9072 (goto-char start)
9073 (search-forward cmstr nil t)
9074 (move-marker org-clock-marker (point))))
9075 (message "Sorting entries...done")))
9077 ;;; The orgstruct minor mode
9079 ;; Define a minor mode which can be used in other modes in order to
9080 ;; integrate the org-mode structure editing commands.
9082 ;; This is really a hack, because the org-mode structure commands use
9083 ;; keys which normally belong to the major mode. Here is how it
9084 ;; works: The minor mode defines all the keys necessary to operate the
9085 ;; structure commands, but wraps the commands into a function which
9086 ;; tests if the cursor is currently at a headline or a plain list
9087 ;; item. If that is the case, the structure command is used,
9088 ;; temporarily setting many Org-mode variables like regular
9089 ;; expressions for filling etc. However, when any of those keys is
9090 ;; used at a different location, function uses `key-binding' to look
9091 ;; up if the key has an associated command in another currently active
9092 ;; keymap (minor modes, major mode, global), and executes that
9093 ;; command. There might be problems if any of the keys is otherwise
9094 ;; used as a prefix key.
9096 (defcustom orgstruct-heading-prefix-regexp ""
9097 "Regexp that matches the custom prefix of Org headlines in
9098 orgstruct(++)-mode."
9099 :group 'org
9100 :version "24.4"
9101 :package-version '(Org . "8.3")
9102 :type 'regexp)
9103 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9105 (defcustom orgstruct-setup-hook nil
9106 "Hook run after orgstruct-mode-map is filled."
9107 :group 'org
9108 :version "24.4"
9109 :package-version '(Org . "8.0")
9110 :type 'hook)
9112 (defvar orgstruct-initialized nil)
9114 (defvar org-local-vars nil
9115 "List of local variables, for use by `orgstruct-mode'.")
9117 ;;;###autoload
9118 (define-minor-mode orgstruct-mode
9119 "Toggle the minor mode `orgstruct-mode'.
9120 This mode is for using Org-mode structure commands in other
9121 modes. The following keys behave as if Org-mode were active, if
9122 the cursor is on a headline, or on a plain list item (both as
9123 defined by Org-mode)."
9124 nil " OrgStruct" (make-sparse-keymap)
9125 (funcall (if orgstruct-mode
9126 'add-to-invisibility-spec
9127 'remove-from-invisibility-spec)
9128 '(outline . t))
9129 (when orgstruct-mode
9130 (org-load-modules-maybe)
9131 (unless orgstruct-initialized
9132 (orgstruct-setup)
9133 (setq orgstruct-initialized t))))
9135 ;;;###autoload
9136 (defun turn-on-orgstruct ()
9137 "Unconditionally turn on `orgstruct-mode'."
9138 (orgstruct-mode 1))
9140 (defvar org-fb-vars nil)
9141 (make-variable-buffer-local 'org-fb-vars)
9142 (defun orgstruct++-mode (&optional arg)
9143 "Toggle `orgstruct-mode', the enhanced version of it.
9144 In addition to setting orgstruct-mode, this also exports all
9145 indentation and autofilling variables from org-mode into the
9146 buffer. It will also recognize item context in multiline items."
9147 (interactive "P")
9148 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9149 (if (< arg 1)
9150 (progn (orgstruct-mode -1)
9151 (mapc (lambda(v)
9152 (org-set-local (car v)
9153 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9154 org-fb-vars))
9155 (orgstruct-mode 1)
9156 (setq org-fb-vars nil)
9157 (unless org-local-vars
9158 (setq org-local-vars (org-get-local-variables)))
9159 (let (var val)
9160 (mapc
9161 (lambda (x)
9162 (when (string-match
9163 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9164 (symbol-name (car x)))
9165 (setq var (car x) val (nth 1 x))
9166 (push (list var `(quote ,(eval var))) org-fb-vars)
9167 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9168 org-local-vars)
9169 (org-set-local 'orgstruct-is-++ t))))
9171 (defvar orgstruct-is-++ nil
9172 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9173 (make-variable-buffer-local 'orgstruct-is-++)
9175 ;;;###autoload
9176 (defun turn-on-orgstruct++ ()
9177 "Unconditionally turn on `orgstruct++-mode'."
9178 (orgstruct++-mode 1))
9180 (defun orgstruct-error ()
9181 "Error when there is no default binding for a structure key."
9182 (interactive)
9183 (funcall (if (fboundp 'user-error)
9184 'user-error
9185 'error)
9186 "This key has no function outside structure elements"))
9188 (defun orgstruct-setup ()
9189 "Setup orgstruct keymap."
9190 (dolist (cell '((org-demote . t)
9191 (org-metaleft . t)
9192 (org-metaright . t)
9193 (org-promote . t)
9194 (org-shiftmetaleft . t)
9195 (org-shiftmetaright . t)
9196 org-backward-element
9197 org-backward-heading-same-level
9198 org-ctrl-c-ret
9199 org-ctrl-c-minus
9200 org-ctrl-c-star
9201 org-cycle
9202 org-forward-heading-same-level
9203 org-insert-heading
9204 org-insert-heading-respect-content
9205 org-kill-note-or-show-branches
9206 org-mark-subtree
9207 org-meta-return
9208 org-metadown
9209 org-metaup
9210 org-narrow-to-subtree
9211 org-promote-subtree
9212 org-reveal
9213 org-shiftdown
9214 org-shiftleft
9215 org-shiftmetadown
9216 org-shiftmetaup
9217 org-shiftright
9218 org-shifttab
9219 org-shifttab
9220 org-shiftup
9221 org-show-subtree
9222 org-sort
9223 org-up-element
9224 outline-demote
9225 outline-next-visible-heading
9226 outline-previous-visible-heading
9227 outline-promote
9228 outline-up-heading
9229 show-children))
9230 (let ((f (or (car-safe cell) cell))
9231 (disable-when-heading-prefix (cdr-safe cell)))
9232 (when (fboundp f)
9233 (let ((new-bindings))
9234 (dolist (binding (nconc (where-is-internal f org-mode-map)
9235 (where-is-internal f outline-mode-map)))
9236 (push binding new-bindings)
9237 ;; TODO use local-function-key-map
9238 (dolist (rep '(("<tab>" . "TAB")
9239 ("<return>" . "RET")
9240 ("<escape>" . "ESC")
9241 ("<delete>" . "DEL")))
9242 (setq binding (read-kbd-macro
9243 (let ((case-fold-search))
9244 (replace-regexp-in-string
9245 (regexp-quote (cdr rep))
9246 (car rep)
9247 (key-description binding)))))
9248 (pushnew binding new-bindings :test 'equal)))
9249 (dolist (binding new-bindings)
9250 (let ((key (lookup-key orgstruct-mode-map binding)))
9251 (when (or (not key) (numberp key))
9252 (ignore-errors
9253 (org-defkey orgstruct-mode-map
9254 binding
9255 (orgstruct-make-binding
9256 f binding disable-when-heading-prefix))))))))))
9257 (run-hooks 'orgstruct-setup-hook))
9259 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9260 "Create a function for binding in the structure minor mode.
9261 FUN is the command to call inside a table. KEY is the key that
9262 should be checked in for a command to execute outside of tables.
9263 Non-nil `disable-when-heading-prefix' means to disable the command
9264 if `orgstruct-heading-prefix-regexp' is not empty."
9265 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9266 (let ((nname name)
9267 (i 0))
9268 (while (fboundp (intern nname))
9269 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9270 (setq name (intern nname)))
9271 (eval
9272 (let ((bindings '((org-heading-regexp
9273 (concat "^"
9274 orgstruct-heading-prefix-regexp
9275 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9276 (org-outline-regexp
9277 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9278 (org-outline-regexp-bol
9279 (concat "^" org-outline-regexp))
9280 (outline-regexp org-outline-regexp)
9281 (outline-heading-end-regexp "\n")
9282 (outline-level 'org-outline-level)
9283 (outline-heading-alist))))
9284 `(defun ,name (arg)
9285 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9286 "Outside of structure, run the binding of `"
9287 (key-description key) "'."
9288 (when disable-when-heading-prefix
9289 (concat
9290 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9291 "back to the default binding due to limitations of Org's implementation of\n"
9292 "`" (symbol-name fun) "'.")))
9293 (interactive "p")
9294 (let* ((disable
9295 ,(and disable-when-heading-prefix
9296 '(not (string= orgstruct-heading-prefix-regexp ""))))
9297 (fallback
9298 (or disable
9299 (not
9300 (let* ,bindings
9301 (org-context-p 'headline 'item
9302 ,(when (memq fun
9303 '(org-insert-heading
9304 org-insert-heading-respect-content
9305 org-meta-return))
9306 '(when orgstruct-is-++
9307 'item-body))))))))
9308 (if fallback
9309 (let* ((orgstruct-mode)
9310 (binding
9311 (let ((key ,key))
9312 (catch 'exit
9313 (dolist
9314 (rep
9315 '(nil
9316 ("<\\([^>]*\\)tab>" . "\\1TAB")
9317 ("<\\([^>]*\\)return>" . "\\1RET")
9318 ("<\\([^>]*\\)escape>" . "\\1ESC")
9319 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9320 nil)
9321 (when rep
9322 (setq key (read-kbd-macro
9323 (let ((case-fold-search))
9324 (replace-regexp-in-string
9325 (car rep)
9326 (cdr rep)
9327 (key-description key))))))
9328 (when (key-binding key)
9329 (throw 'exit (key-binding key))))))))
9330 (if (keymapp binding)
9331 (org-set-transient-map binding)
9332 (let ((func (or binding
9333 (unless disable
9334 'orgstruct-error))))
9335 (when func
9336 (call-interactively func)))))
9337 (org-run-like-in-org-mode
9338 (lambda ()
9339 (interactive)
9340 (let* ,bindings
9341 (call-interactively ',fun)))))))))
9342 name))
9344 (defun org-contextualize-keys (alist contexts)
9345 "Return valid elements in ALIST depending on CONTEXTS.
9347 `org-agenda-custom-commands' or `org-capture-templates' are the
9348 values used for ALIST, and `org-agenda-custom-commands-contexts'
9349 or `org-capture-templates-contexts' are the associated contexts
9350 definitions."
9351 (let ((contexts
9352 ;; normalize contexts
9353 (mapcar
9354 (lambda(c) (cond ((listp (cadr c))
9355 (list (car c) (car c) (cadr c)))
9356 ((string= "" (cadr c))
9357 (list (car c) (car c) (caddr c)))
9358 (t c)))
9359 contexts))
9360 (a alist) r s)
9361 ;; loop over all commands or templates
9362 (dolist (c a)
9363 (let (vrules repl)
9364 (cond
9365 ((not (assoc (car c) contexts))
9366 (push c r))
9367 ((and (assoc (car c) contexts)
9368 (setq vrules (org-contextualize-validate-key
9369 (car c) contexts)))
9370 (mapc (lambda (vr)
9371 (when (not (equal (car vr) (cadr vr)))
9372 (setq repl vr)))
9373 vrules)
9374 (if (not repl) (push c r)
9375 (push (cadr repl) s)
9376 (push
9377 (cons (car c)
9378 (cdr (or (assoc (cadr repl) alist)
9379 (error "Undefined key `%s' as contextual replacement for `%s'"
9380 (cadr repl) (car c)))))
9381 r))))))
9382 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9383 (delq
9385 (delete-dups
9386 (mapcar (lambda (x)
9387 (let ((tpl (car x)))
9388 (when (not (delq
9390 (mapcar (lambda (y)
9391 (equal y tpl))
9392 s)))
9393 x)))
9394 (reverse r))))))
9396 (defun org-contextualize-validate-key (key contexts)
9397 "Check CONTEXTS for agenda or capture KEY."
9398 (let (rr res)
9399 (dolist (r contexts)
9400 (mapc
9401 (lambda (rr)
9402 (when
9403 (and (equal key (car r))
9404 (if (functionp rr) (funcall rr)
9405 (or (and (eq (car rr) 'in-file)
9406 (buffer-file-name)
9407 (string-match (cdr rr) (buffer-file-name)))
9408 (and (eq (car rr) 'in-mode)
9409 (string-match (cdr rr) (symbol-name major-mode)))
9410 (and (eq (car rr) 'in-buffer)
9411 (string-match (cdr rr) (buffer-name)))
9412 (when (and (eq (car rr) 'not-in-file)
9413 (buffer-file-name))
9414 (not (string-match (cdr rr) (buffer-file-name))))
9415 (when (eq (car rr) 'not-in-mode)
9416 (not (string-match (cdr rr) (symbol-name major-mode))))
9417 (when (eq (car rr) 'not-in-buffer)
9418 (not (string-match (cdr rr) (buffer-name)))))))
9419 (push r res)))
9420 (car (last r))))
9421 (delete-dups (delq nil res))))
9423 (defun org-context-p (&rest contexts)
9424 "Check if local context is any of CONTEXTS.
9425 Possible values in the list of contexts are `table', `headline', and `item'."
9426 (let ((pos (point)))
9427 (goto-char (point-at-bol))
9428 (prog1 (or (and (memq 'table contexts)
9429 (looking-at "[ \t]*|"))
9430 (and (memq 'headline contexts)
9431 (looking-at org-outline-regexp))
9432 (and (memq 'item contexts)
9433 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9434 (and (memq 'item-body contexts)
9435 (org-in-item-p)))
9436 (goto-char pos))))
9438 (defun org-get-local-variables ()
9439 "Return a list of all local variables in an Org mode buffer."
9440 (let (varlist)
9441 (with-current-buffer (get-buffer-create "*Org tmp*")
9442 (erase-buffer)
9443 (org-mode)
9444 (setq varlist (buffer-local-variables)))
9445 (kill-buffer "*Org tmp*")
9446 (delq nil
9447 (mapcar
9448 (lambda (x)
9449 (setq x
9450 (if (symbolp x)
9451 (list x)
9452 (list (car x) (cdr x))))
9453 (if (and (not (get (car x) 'org-state))
9454 (string-match
9455 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9456 (symbol-name (car x))))
9457 x nil))
9458 varlist))))
9460 (defun org-clone-local-variables (from-buffer &optional regexp)
9461 "Clone local variables from FROM-BUFFER.
9462 Optional argument REGEXP selects variables to clone."
9463 (mapc
9464 (lambda (pair)
9465 (and (symbolp (car pair))
9466 (or (null regexp)
9467 (string-match regexp (symbol-name (car pair))))
9468 (set (make-local-variable (car pair))
9469 (cdr pair))))
9470 (buffer-local-variables from-buffer)))
9472 ;;;###autoload
9473 (defun org-run-like-in-org-mode (cmd)
9474 "Run a command, pretending that the current buffer is in Org-mode.
9475 This will temporarily bind local variables that are typically bound in
9476 Org-mode to the values they have in Org-mode, and then interactively
9477 call CMD."
9478 (org-load-modules-maybe)
9479 (unless org-local-vars
9480 (setq org-local-vars (org-get-local-variables)))
9481 (let (binds)
9482 (dolist (var org-local-vars)
9483 (when (or (not (boundp (car var)))
9484 (eq (symbol-value (car var))
9485 (default-value (car var))))
9486 (push (list (car var) `(quote ,(cadr var))) binds)))
9487 (eval `(let ,binds
9488 (call-interactively (quote ,cmd))))))
9490 (defun org-get-category (&optional pos force-refresh)
9491 "Get the category applying to position POS."
9492 (save-match-data
9493 (if force-refresh (org-refresh-category-properties))
9494 (let ((pos (or pos (point))))
9495 (or (get-text-property pos 'org-category)
9496 (progn (org-refresh-category-properties)
9497 (get-text-property pos 'org-category))))))
9499 ;;; Refresh properties
9501 (defun org-refresh-properties (dprop tprop)
9502 "Refresh buffer text properties.
9503 DPROP is the drawer property and TPROP is either the
9504 corresponding text property to set, or an alist with each element
9505 being a text property (as a symbol) and a function to apply to
9506 the value of the drawer property."
9507 (let ((case-fold-search t)
9508 (inhibit-read-only t))
9509 (org-with-silent-modifications
9510 (save-excursion
9511 (save-restriction
9512 (widen)
9513 (goto-char (point-min))
9514 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9515 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9517 (defun org-refresh-property (tprop p)
9518 "Refresh the buffer text property TPROP from the drawer property P.
9519 The refresh happens only for the current tree (not subtree)."
9520 (unless (org-before-first-heading-p)
9521 (save-excursion
9522 (org-back-to-heading t)
9523 (if (symbolp tprop)
9524 ;; TPROP is a text property symbol
9525 (put-text-property
9526 (point) (or (outline-next-heading) (point-max)) tprop p)
9527 ;; TPROP is an alist with (properties . function) elements
9528 (dolist (al tprop)
9529 (save-excursion
9530 (put-text-property
9531 (line-beginning-position) (or (outline-next-heading) (point-max))
9532 (car al)
9533 (funcall (cdr al) p))))))))
9535 (defun org-refresh-category-properties ()
9536 "Refresh category text properties in the buffer."
9537 (let ((case-fold-search t)
9538 (inhibit-read-only t)
9539 (default-category
9540 (cond ((null org-category)
9541 (if buffer-file-name
9542 (file-name-sans-extension
9543 (file-name-nondirectory buffer-file-name))
9544 "???"))
9545 ((symbolp org-category) (symbol-name org-category))
9546 (t org-category))))
9547 (org-with-silent-modifications
9548 (org-with-wide-buffer
9549 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9550 ;; This is the default category for the buffer. If none is
9551 ;; found, fall-back to `org-category' or buffer file name.
9552 (put-text-property
9553 (point-min) (point-max)
9554 'org-category
9555 (catch 'buffer-category
9556 (goto-char (point-max))
9557 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9558 (let ((element (org-element-at-point)))
9559 (when (eq (org-element-type element) 'keyword)
9560 (throw 'buffer-category
9561 (org-element-property :value element)))))
9562 default-category))
9563 ;; Set sub-tree specific categories.
9564 (goto-char (point-min))
9565 (let ((regexp (org-re-property "CATEGORY")))
9566 (while (re-search-forward regexp nil t)
9567 (let ((value (org-match-string-no-properties 3)))
9568 (when (org-at-property-p)
9569 (put-text-property
9570 (save-excursion (org-back-to-heading t) (point))
9571 (save-excursion (org-end-of-subtree t t) (point))
9572 'org-category
9573 value)))))))))
9575 (defun org-refresh-stats-properties ()
9576 "Refresh stats text properties in the buffer."
9577 (let (stats)
9578 (org-with-silent-modifications
9579 (save-excursion
9580 (save-restriction
9581 (widen)
9582 (goto-char (point-min))
9583 (while (re-search-forward
9584 (concat org-outline-regexp-bol ".*"
9585 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9586 nil t)
9587 (setq stats (cond ((equal (match-string 3) "0") 0)
9588 ((match-string 2)
9589 (/ (* (string-to-number (match-string 2)) 100)
9590 (string-to-number (match-string 3))))
9591 (t (string-to-number (match-string 1)))))
9592 (org-back-to-heading t)
9593 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9594 'org-stats stats)))))))
9596 (defun org-refresh-effort-properties ()
9597 "Refresh effort properties"
9598 (org-refresh-properties
9599 org-effort-property
9600 '((effort . identity)
9601 (effort-minutes . org-duration-string-to-minutes))))
9603 ;;;; Link Stuff
9605 ;;; Link abbreviations
9607 (defun org-link-expand-abbrev (link)
9608 "Apply replacements as defined in `org-link-abbrev-alist'."
9609 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9610 (let* ((key (match-string 1 link))
9611 (as (or (assoc key org-link-abbrev-alist-local)
9612 (assoc key org-link-abbrev-alist)))
9613 (tag (and (match-end 2) (match-string 3 link)))
9614 rpl)
9615 (if (not as)
9616 link
9617 (setq rpl (cdr as))
9618 (cond
9619 ((symbolp rpl) (funcall rpl tag))
9620 ((string-match "%(\\([^)]+\\))" rpl)
9621 (replace-match
9622 (save-match-data
9623 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9624 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9625 ((string-match "%h" rpl)
9626 (replace-match (url-hexify-string (or tag "")) t t rpl))
9627 (t (concat rpl tag)))))
9628 link))
9630 ;;; Storing and inserting links
9632 (defvar org-insert-link-history nil
9633 "Minibuffer history for links inserted with `org-insert-link'.")
9635 (defvar org-stored-links nil
9636 "Contains the links stored with `org-store-link'.")
9638 (defvar org-store-link-plist nil
9639 "Plist with info about the most recently link created with `org-store-link'.")
9641 (defvar org-link-protocols nil
9642 "Link protocols added to Org-mode using `org-add-link-type'.")
9644 (defvar org-store-link-functions nil
9645 "List of functions that are called to create and store a link.
9646 Each function will be called in turn until one returns a non-nil
9647 value. Each function should check if it is responsible for creating
9648 this link (for example by looking at the major mode).
9649 If not, it must exit and return nil.
9650 If yes, it should return a non-nil value after a calling
9651 `org-store-link-props' with a list of properties and values.
9652 Special properties are:
9654 :type The link prefix, like \"http\". This must be given.
9655 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9656 This is obligatory as well.
9657 :description Optional default description for the second pair
9658 of brackets in an Org-mode link. The user can still change
9659 this when inserting this link into an Org-mode buffer.
9661 In addition to these, any additional properties can be specified
9662 and then used in capture templates.")
9664 (defun org-add-link-type (type &optional follow export)
9665 "Add TYPE to the list of `org-link-types'.
9666 Re-compute all regular expressions depending on `org-link-types'
9668 FOLLOW and EXPORT are two functions.
9670 FOLLOW should take the link path as the single argument and do whatever
9671 is necessary to follow the link, for example find a file or display
9672 a mail message.
9674 EXPORT should format the link path for export to one of the export formats.
9675 It should be a function accepting three arguments:
9677 path the path of the link, the text after the prefix (like \"http:\")
9678 desc the description of the link, if any
9679 format the export format, a symbol like `html' or `latex' or `ascii'.
9681 The function may use the FORMAT information to return different values
9682 depending on the format. The return value will be put literally into
9683 the exported file. If the return value is nil, this means Org should
9684 do what it normally does with links which do not have EXPORT defined.
9686 Org mode has a built-in default for exporting links. If you are happy with
9687 this default, there is no need to define an export function for the link
9688 type. For a simple example of an export function, see `org-bbdb.el'."
9689 (add-to-list 'org-link-types type t)
9690 (org-make-link-regexps)
9691 (org-element-update-syntax)
9692 (if (assoc type org-link-protocols)
9693 (setcdr (assoc type org-link-protocols) (list follow export))
9694 (push (list type follow export) org-link-protocols)))
9696 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9697 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9699 ;;;###autoload
9700 (defun org-store-link (arg)
9701 "\\<org-mode-map>Store an org-link to the current location.
9702 This link is added to `org-stored-links' and can later be inserted
9703 into an Org buffer with \\[org-insert-link].
9705 For some link types, a prefix ARG is interpreted.
9706 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9707 For file links, ARG negates `org-context-in-file-links'.
9709 A double prefix ARG force skipping storing functions that are not
9710 part of Org's core.
9712 A triple prefix ARG force storing a link for each line in the
9713 active region."
9714 (interactive "P")
9715 (org-load-modules-maybe)
9716 (if (and (equal arg '(64)) (org-region-active-p))
9717 (save-excursion
9718 (let ((end (region-end)))
9719 (goto-char (region-beginning))
9720 (set-mark (point))
9721 (while (< (point-at-eol) end)
9722 (move-end-of-line 1) (activate-mark)
9723 (let (current-prefix-arg)
9724 (call-interactively 'org-store-link))
9725 (move-beginning-of-line 2)
9726 (set-mark (point)))))
9727 (org-with-limited-levels
9728 (setq org-store-link-plist nil)
9729 (let (link cpltxt desc description search
9730 txt custom-id agenda-link sfuns sfunsn)
9731 (cond
9733 ;; Store a link using an external link type
9734 ((and (not (equal arg '(16)))
9735 (setq sfuns
9736 (delq
9737 nil (mapcar (lambda (f)
9738 (let (fs) (if (funcall f) (push f fs))))
9739 org-store-link-functions))
9740 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9741 (or (and (cdr sfuns)
9742 (funcall (intern
9743 (completing-read
9744 "Which function for creating the link? "
9745 sfunsn nil t (car sfunsn)))))
9746 (funcall (caar sfuns)))
9747 (setq link (plist-get org-store-link-plist :link)
9748 desc (or (plist-get org-store-link-plist
9749 :description)
9750 link))))
9752 ;; Store a link from a source code buffer.
9753 ((org-src-edit-buffer-p)
9754 (cond
9755 ((save-excursion
9756 (beginning-of-line)
9757 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9758 "[ \t]*$")))
9759 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9760 ((org-called-interactively-p 'any)
9761 (let (label)
9762 (while (or (not label)
9763 (org-with-wide-buffer
9764 (goto-char (point-min))
9765 (re-search-forward
9766 (regexp-quote (format org-coderef-label-format label))
9767 nil t)))
9768 (when label (message "Label exists already") (sit-for 2))
9769 (setq label (read-string "Code line label: " label)))
9770 (end-of-line)
9771 (setq link (format org-coderef-label-format label))
9772 (let ((gc (- 79 (length link))))
9773 (if (< (current-column) gc) (org-move-to-column gc t)
9774 (insert " ")))
9775 (insert link)
9776 (setq link (concat "(" label ")") desc nil)))
9777 (t (setq link nil))))
9779 ;; We are in the agenda, link to referenced location
9780 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9781 (let ((m (or (get-text-property (point) 'org-hd-marker)
9782 (get-text-property (point) 'org-marker))))
9783 (when m
9784 (org-with-point-at m
9785 (setq agenda-link
9786 (if (org-called-interactively-p 'any)
9787 (call-interactively 'org-store-link)
9788 (org-store-link nil)))))))
9790 ((eq major-mode 'calendar-mode)
9791 (let ((cd (calendar-cursor-to-date)))
9792 (setq link
9793 (format-time-string
9794 (car org-time-stamp-formats)
9795 (apply 'encode-time
9796 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9797 nil nil nil))))
9798 (org-store-link-props :type "calendar" :date cd)))
9800 ((eq major-mode 'help-mode)
9801 (setq link (concat "help:" (save-excursion
9802 (goto-char (point-min))
9803 (looking-at "^[^ ]+")
9804 (match-string 0))))
9805 (org-store-link-props :type "help"))
9807 ((eq major-mode 'w3-mode)
9808 (setq cpltxt (if (and (buffer-name)
9809 (not (string-match "Untitled" (buffer-name))))
9810 (buffer-name)
9811 (url-view-url t))
9812 link (url-view-url t))
9813 (org-store-link-props :type "w3" :url (url-view-url t)))
9815 ((eq major-mode 'image-mode)
9816 (setq cpltxt (concat "file:"
9817 (abbreviate-file-name buffer-file-name))
9818 link cpltxt)
9819 (org-store-link-props :type "image" :file buffer-file-name))
9821 ;; In dired, store a link to the file of the current line
9822 ((derived-mode-p 'dired-mode)
9823 (let ((file (dired-get-filename nil t)))
9824 (setq file (if file
9825 (abbreviate-file-name
9826 (expand-file-name (dired-get-filename nil t)))
9827 ;; otherwise, no file so use current directory.
9828 default-directory))
9829 (setq cpltxt (concat "file:" file)
9830 link cpltxt)))
9832 ((setq search (run-hook-with-args-until-success
9833 'org-create-file-search-functions))
9834 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9835 "::" search))
9836 (setq cpltxt (or description link)))
9838 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9839 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9840 (cond
9841 ;; Store a link using the target at point
9842 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9843 (setq cpltxt
9844 (concat "file:"
9845 (abbreviate-file-name
9846 (buffer-file-name (buffer-base-buffer)))
9847 "::" (match-string 1))
9848 link cpltxt))
9849 ((and (featurep 'org-id)
9850 (or (eq org-id-link-to-org-use-id t)
9851 (and (org-called-interactively-p 'any)
9852 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9853 (and (eq org-id-link-to-org-use-id
9854 'create-if-interactive-and-no-custom-id)
9855 (not custom-id))))
9856 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9857 ;; Store a link using the ID at point
9858 (setq link (condition-case nil
9859 (prog1 (org-id-store-link)
9860 (setq desc (or (plist-get org-store-link-plist
9861 :description)
9862 "")))
9863 (error
9864 ;; Probably before first headline, link only to file
9865 (concat "file:"
9866 (abbreviate-file-name
9867 (buffer-file-name (buffer-base-buffer))))))))
9869 ;; Just link to current headline
9870 (setq cpltxt (concat "file:"
9871 (abbreviate-file-name
9872 (buffer-file-name (buffer-base-buffer)))))
9873 ;; Add a context search string
9874 (when (org-xor org-context-in-file-links arg)
9875 (let* ((ee (org-element-at-point))
9876 (et (org-element-type ee))
9877 (ev (plist-get (cadr ee) :value))
9878 (ek (plist-get (cadr ee) :key))
9879 (eok (and (stringp ek) (string-match "name" ek))))
9880 (setq txt (cond
9881 ((org-at-heading-p) nil)
9882 ((and (eq et 'keyword) eok) ev)
9883 ((org-region-active-p)
9884 (buffer-substring (region-beginning) (region-end)))))
9885 (when (or (null txt) (string-match "\\S-" txt))
9886 (setq cpltxt
9887 (concat cpltxt "::"
9888 (condition-case nil
9889 (org-make-org-heading-search-string txt)
9890 (error "")))
9891 desc (or (and (eq et 'keyword) eok ev)
9892 (nth 4 (ignore-errors (org-heading-components)))
9893 "NONE")))))
9894 (if (string-match "::\\'" cpltxt)
9895 (setq cpltxt (substring cpltxt 0 -2)))
9896 (setq link cpltxt))))
9898 ((buffer-file-name (buffer-base-buffer))
9899 ;; Just link to this file here.
9900 (setq cpltxt (concat "file:"
9901 (abbreviate-file-name
9902 (buffer-file-name (buffer-base-buffer)))))
9903 ;; Add a context string.
9904 (when (org-xor org-context-in-file-links arg)
9905 (setq txt (if (org-region-active-p)
9906 (buffer-substring (region-beginning) (region-end))
9907 (buffer-substring (point-at-bol) (point-at-eol))))
9908 ;; Only use search option if there is some text.
9909 (when (string-match "\\S-" txt)
9910 (setq cpltxt
9911 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9912 desc "NONE")))
9913 (setq link cpltxt))
9915 ((org-called-interactively-p 'interactive)
9916 (user-error "No method for storing a link from this buffer"))
9918 (t (setq link nil)))
9920 ;; We're done setting link and desc, clean up
9921 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9922 (setq link (or link cpltxt)
9923 desc (or desc cpltxt))
9924 (cond ((equal desc "NONE") (setq desc nil))
9925 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9926 (let ((d0 (match-string 3 desc))
9927 (p0 (match-string 5 desc)))
9928 (setq desc
9929 (replace-regexp-in-string
9930 org-bracket-link-regexp
9931 (concat (or p0 d0)
9932 (if (equal (length (match-string 0 desc))
9933 (length desc)) "*" "")) desc)))))
9935 ;; Return the link
9936 (if (not (and (or (org-called-interactively-p 'any)
9937 executing-kbd-macro)
9938 link))
9939 (or agenda-link (and link (org-make-link-string link desc)))
9940 (push (list link desc) org-stored-links)
9941 (message "Stored: %s" (or desc link))
9942 (when custom-id
9943 (setq link (concat "file:" (abbreviate-file-name
9944 (buffer-file-name)) "::#" custom-id))
9945 (push (list link desc) org-stored-links))
9946 (car org-stored-links))))))
9948 (defun org-store-link-props (&rest plist)
9949 "Store link properties, extract names and addresses."
9950 (let (x adr)
9951 (when (setq x (plist-get plist :from))
9952 (setq adr (mail-extract-address-components x))
9953 (setq plist (plist-put plist :fromname (car adr)))
9954 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9955 (when (setq x (plist-get plist :to))
9956 (setq adr (mail-extract-address-components x))
9957 (setq plist (plist-put plist :toname (car adr)))
9958 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9959 (let ((from (plist-get plist :from))
9960 (to (plist-get plist :to)))
9961 (when (and from to org-from-is-user-regexp)
9962 (setq plist
9963 (plist-put plist :fromto
9964 (if (string-match org-from-is-user-regexp from)
9965 (concat "to %t")
9966 (concat "from %f"))))))
9967 (setq org-store-link-plist plist))
9969 (defun org-add-link-props (&rest plist)
9970 "Add these properties to the link property list."
9971 (let (key value)
9972 (while plist
9973 (setq key (pop plist) value (pop plist))
9974 (setq org-store-link-plist
9975 (plist-put org-store-link-plist key value)))))
9977 (defun org-email-link-description (&optional fmt)
9978 "Return the description part of an email link.
9979 This takes information from `org-store-link-plist' and formats it
9980 according to FMT (default from `org-email-link-description-format')."
9981 (setq fmt (or fmt org-email-link-description-format))
9982 (let* ((p org-store-link-plist)
9983 (to (plist-get p :toaddress))
9984 (from (plist-get p :fromaddress))
9985 (table
9986 (list
9987 (cons "%c" (plist-get p :fromto))
9988 (cons "%F" (plist-get p :from))
9989 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9990 (cons "%T" (plist-get p :to))
9991 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9992 (cons "%s" (plist-get p :subject))
9993 (cons "%d" (plist-get p :date))
9994 (cons "%m" (plist-get p :message-id)))))
9995 (when (string-match "%c" fmt)
9996 ;; Check if the user wrote this message
9997 (if (and org-from-is-user-regexp from to
9998 (save-match-data (string-match org-from-is-user-regexp from)))
9999 (setq fmt (replace-match "to %t" t t fmt))
10000 (setq fmt (replace-match "from %f" t t fmt))))
10001 (org-replace-escapes fmt table)))
10003 (defun org-make-org-heading-search-string (&optional string)
10004 "Make search string for the current headline or STRING."
10005 (let ((s (or string
10006 (and (derived-mode-p 'org-mode)
10007 (save-excursion
10008 (org-back-to-heading t)
10009 (org-element-property :raw-value (org-element-at-point))))))
10010 (lines org-context-in-file-links))
10011 (or string (setq s (concat "*" s))) ; Add * for headlines
10012 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10013 (when (and string (integerp lines) (> lines 0))
10014 (let ((slines (org-split-string s "\n")))
10015 (when (< lines (length slines))
10016 (setq s (mapconcat
10017 'identity
10018 (reverse (nthcdr (- (length slines) lines)
10019 (reverse slines))) "\n")))))
10020 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10022 (defun org-make-link-string (link &optional description)
10023 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10024 (unless (org-string-nw-p link) (error "Empty link"))
10025 (let ((uri (cond ((string-match org-link-types-re link)
10026 (concat (match-string 1 link)
10027 (org-link-escape (substring link (match-end 1)))))
10028 ;; For readability, url-encode internal links only
10029 ;; when absolutely needed (i.e, when they contain
10030 ;; square brackets). File links however, are
10031 ;; encoded since, e.g., spaces are significant.
10032 ((or (file-name-absolute-p link)
10033 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10034 (org-link-escape link))
10035 (t link)))
10036 (description
10037 (and (org-string-nw-p description)
10038 ;; Remove brackets from description, as they are fatal.
10039 (replace-regexp-in-string
10040 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10041 (org-trim description)))))
10042 (format "[[%s]%s]"
10044 (if description (format "[%s]" description) ""))))
10046 (defconst org-link-escape-chars
10047 ;;%20 %5B %5D %25
10048 '(?\s ?\[ ?\] ?%)
10049 "List of characters that should be escaped in a link when stored to Org.
10050 This is the list that is used for internal purposes.")
10052 (defconst org-link-escape-chars-browser
10053 ;;%20 %22
10054 '(?\s ?\")
10055 "List of characters to be escaped before handing over to the browser.
10056 If you consider using this constant then you probably want to use
10057 the function `org-link-escape-browser' instead. See there why
10058 this constant is a candidate to be removed once Org drops support
10059 for Emacs 24.1 and 24.2.")
10061 (defun org-link-escape (text &optional table merge)
10062 "Return percent escaped representation of TEXT.
10063 TEXT is a string with the text to escape.
10064 Optional argument TABLE is a list with characters that should be
10065 escaped. When nil, `org-link-escape-chars' is used.
10066 If optional argument MERGE is set, merge TABLE into
10067 `org-link-escape-chars'."
10068 (let ((characters-to-encode
10069 (cond ((null table) org-link-escape-chars)
10070 (merge (append org-link-escape-chars table))
10071 (t table))))
10072 (mapconcat
10073 (lambda (c)
10074 (if (or (memq c characters-to-encode)
10075 (and org-url-hexify-p (or (< c 32) (> c 126))))
10076 (mapconcat (lambda (e) (format "%%%.2X" e))
10077 (or (encode-coding-char c 'utf-8)
10078 (error "Unable to percent escape character: %c" c))
10080 (char-to-string c)))
10081 text "")))
10083 (defun org-link-escape-browser (text)
10084 "Escape some characters before handing over to the browser.
10085 This function is a candidate to be removed together with the
10086 constant `org-link-escape-chars-browser' once Org drops support
10087 for Emacs 24.1 and 24.2. All calls to this function will have to
10088 be replaced with `url-encode-url' which is available since Emacs
10089 24.3.1."
10090 ;; Example with the Org link
10091 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10092 ;; to open the browser with +subject:"Release 8.2" filled into the
10093 ;; query field: In this case the variable TEXT contains the
10094 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10095 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10096 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10097 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10098 (if (fboundp 'url-encode-url)
10099 (url-encode-url text)
10100 (if (org-string-match-p
10101 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10102 text)
10103 (org-link-escape text org-link-escape-chars-browser)
10104 text)))
10106 (defun org-link-unescape (str)
10107 "Unhex hexified Unicode parts in string STR.
10108 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10109 reciprocal of `org-link-escape', which see."
10110 (if (org-string-nw-p str)
10111 (replace-regexp-in-string
10112 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10113 str))
10115 (defun org-link-unescape-compound (hex)
10116 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10117 Note: this function also decodes single byte encodings like
10118 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10119 (save-match-data
10120 (let* ((bytes (cdr (split-string hex "%")))
10121 (ret "")
10122 (eat 0)
10123 (sum 0))
10124 (while bytes
10125 (let* ((val (string-to-number (pop bytes) 16))
10126 (shift-xor
10127 (if (= 0 eat)
10128 (cond
10129 ((>= val 252) (cons 6 252))
10130 ((>= val 248) (cons 5 248))
10131 ((>= val 240) (cons 4 240))
10132 ((>= val 224) (cons 3 224))
10133 ((>= val 192) (cons 2 192))
10134 (t (cons 0 0)))
10135 (cons 6 128))))
10136 (if (>= val 192) (setq eat (car shift-xor)))
10137 (setq val (logxor val (cdr shift-xor)))
10138 (setq sum (+ (lsh sum (car shift-xor)) val))
10139 (if (> eat 0) (setq eat (- eat 1)))
10140 (cond
10141 ((= 0 eat) ;multi byte
10142 (setq ret (concat ret (org-char-to-string sum)))
10143 (setq sum 0))
10144 ((not bytes) ; single byte(s)
10145 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10146 ret)))
10148 (defun org-link-unescape-single-byte-sequence (hex)
10149 "Unhexify hex-encoded single byte character sequences."
10150 (mapconcat (lambda (byte)
10151 (char-to-string (string-to-number byte 16)))
10152 (cdr (split-string hex "%")) ""))
10154 (defun org-xor (a b)
10155 "Exclusive or."
10156 (if a (not b) b))
10158 (defun org-fixup-message-id-for-http (s)
10159 "Replace special characters in a message id, so it can be used in an http query."
10160 (when (string-match "%" s)
10161 (setq s (mapconcat (lambda (c)
10162 (if (eq c ?%)
10163 "%25"
10164 (char-to-string c)))
10165 s "")))
10166 (while (string-match "<" s)
10167 (setq s (replace-match "%3C" t t s)))
10168 (while (string-match ">" s)
10169 (setq s (replace-match "%3E" t t s)))
10170 (while (string-match "@" s)
10171 (setq s (replace-match "%40" t t s)))
10174 (defun org-link-prettify (link)
10175 "Return a human-readable representation of LINK.
10176 The car of LINK must be a raw link.
10177 The cdr of LINK must be either a link description or nil."
10178 (let ((desc (or (cadr link) "<no description>")))
10179 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10180 "<" (car link) ">")))
10182 ;;;###autoload
10183 (defun org-insert-link-global ()
10184 "Insert a link like Org-mode does.
10185 This command can be called in any mode to insert a link in Org-mode syntax."
10186 (interactive)
10187 (org-load-modules-maybe)
10188 (org-run-like-in-org-mode 'org-insert-link))
10190 (defun org-insert-all-links (arg &optional pre post)
10191 "Insert all links in `org-stored-links'.
10192 When a universal prefix, do not delete the links from `org-stored-links'.
10193 When `ARG' is a number, insert the last N link(s).
10194 `PRE' and `POST' are optional arguments to define a string to
10195 prepend or to append."
10196 (interactive "P")
10197 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10198 (links (copy-seq org-stored-links))
10199 (pr (or pre "- "))
10200 (po (or post "\n"))
10201 (cnt 1) l)
10202 (if (null org-stored-links)
10203 (message "No link to insert")
10204 (while (and (or (listp arg) (>= arg cnt))
10205 (setq l (if (listp arg)
10206 (pop links)
10207 (pop org-stored-links))))
10208 (setq cnt (1+ cnt))
10209 (insert pr)
10210 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10211 (insert po)))))
10213 (defun org-insert-last-stored-link (arg)
10214 "Insert the last link stored in `org-stored-links'."
10215 (interactive "p")
10216 (org-insert-all-links arg "" "\n"))
10218 (defun org-link-fontify-links-to-this-file ()
10219 "Fontify links to the current file in `org-stored-links'."
10220 (let ((f (buffer-file-name)) a b)
10221 (setq a (mapcar (lambda(l)
10222 (let ((ll (car l)))
10223 (when (and (string-match "^file:\\(.+\\)::" ll)
10224 (equal f (expand-file-name (match-string 1 ll))))
10225 ll)))
10226 org-stored-links))
10227 (when (featurep 'org-id)
10228 (setq b (mapcar (lambda(l)
10229 (let ((ll (car l)))
10230 (when (and (string-match "^id:\\(.+\\)$" ll)
10231 (equal f (expand-file-name
10232 (or (org-id-find-id-file
10233 (match-string 1 ll)) ""))))
10234 ll)))
10235 org-stored-links)))
10236 (mapcar (lambda(l)
10237 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10238 (delq nil (append a b)))))
10240 (defvar org-link-links-in-this-file nil)
10241 (defun org-insert-link (&optional complete-file link-location default-description)
10242 "Insert a link. At the prompt, enter the link.
10244 Completion can be used to insert any of the link protocol prefixes like
10245 http or ftp in use.
10247 The history can be used to select a link previously stored with
10248 `org-store-link'. When the empty string is entered (i.e. if you just
10249 press RET at the prompt), the link defaults to the most recently
10250 stored link. As SPC triggers completion in the minibuffer, you need to
10251 use M-SPC or C-q SPC to force the insertion of a space character.
10253 You will also be prompted for a description, and if one is given, it will
10254 be displayed in the buffer instead of the link.
10256 If there is already a link at point, this command will allow you to edit link
10257 and description parts.
10259 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10260 be selected using completion. The path to the file will be relative to the
10261 current directory if the file is in the current directory or a subdirectory.
10262 Otherwise, the link will be the absolute path as completed in the minibuffer
10263 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10264 option `org-link-file-path-type'.
10266 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10267 the current directory or below.
10269 With three \\[universal-argument] prefixes, negate the meaning of
10270 `org-keep-stored-link-after-insertion'.
10272 If `org-make-link-description-function' is non-nil, this function will be
10273 called with the link target, and the result will be the default
10274 link description.
10276 If the LINK-LOCATION parameter is non-nil, this value will be
10277 used as the link location instead of reading one interactively.
10279 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10280 be used as the default description."
10281 (interactive "P")
10282 (let* ((wcf (current-window-configuration))
10283 (origbuf (current-buffer))
10284 (region (if (org-region-active-p)
10285 (buffer-substring (region-beginning) (region-end))))
10286 (remove (and region (list (region-beginning) (region-end))))
10287 (desc region)
10288 tmphist ; byte-compile incorrectly complains about this
10289 (link link-location)
10290 (abbrevs org-link-abbrev-alist-local)
10291 entry file all-prefixes auto-desc)
10292 (cond
10293 (link-location) ; specified by arg, just use it.
10294 ((org-in-regexp org-bracket-link-regexp 1)
10295 ;; We do have a link at point, and we are going to edit it.
10296 (setq remove (list (match-beginning 0) (match-end 0)))
10297 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10298 (setq link (read-string "Link: "
10299 (org-link-unescape
10300 (org-match-string-no-properties 1)))))
10301 ((or (org-in-regexp org-angle-link-re)
10302 (org-in-regexp org-plain-link-re))
10303 ;; Convert to bracket link
10304 (setq remove (list (match-beginning 0) (match-end 0))
10305 link (read-string "Link: "
10306 (org-remove-angle-brackets (match-string 0)))))
10307 ((member complete-file '((4) (16)))
10308 ;; Completing read for file names.
10309 (setq link (org-file-complete-link complete-file)))
10311 ;; Read link, with completion for stored links.
10312 (org-link-fontify-links-to-this-file)
10313 (org-switch-to-buffer-other-window "*Org Links*")
10314 (with-current-buffer "*Org Links*"
10315 (erase-buffer)
10316 (insert "Insert a link.
10317 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10318 (when org-stored-links
10319 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10320 (insert (mapconcat 'org-link-prettify
10321 (reverse org-stored-links) "\n")))
10322 (goto-char (point-min)))
10323 (let ((cw (selected-window)))
10324 (select-window (get-buffer-window "*Org Links*" 'visible))
10325 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10326 (unless (pos-visible-in-window-p (point-max))
10327 (org-fit-window-to-buffer))
10328 (and (window-live-p cw) (select-window cw)))
10329 ;; Fake a link history, containing the stored links.
10330 (setq tmphist (append (mapcar 'car org-stored-links)
10331 org-insert-link-history))
10332 (setq all-prefixes (append (mapcar 'car abbrevs)
10333 (mapcar 'car org-link-abbrev-alist)
10334 org-link-types))
10335 (unwind-protect
10336 (progn
10337 (setq link
10338 (org-completing-read
10339 "Link: "
10340 (append
10341 (mapcar (lambda (x) (concat x ":"))
10342 all-prefixes)
10343 (mapcar 'car org-stored-links))
10344 nil nil nil
10345 'tmphist
10346 (caar org-stored-links)))
10347 (if (not (string-match "\\S-" link))
10348 (user-error "No link selected"))
10349 (mapc (lambda(l)
10350 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10351 org-stored-links)
10352 (if (or (member link all-prefixes)
10353 (and (equal ":" (substring link -1))
10354 (member (substring link 0 -1) all-prefixes)
10355 (setq link (substring link 0 -1))))
10356 (setq link (with-current-buffer origbuf
10357 (org-link-try-special-completion link)))))
10358 (set-window-configuration wcf)
10359 (kill-buffer "*Org Links*"))
10360 (setq entry (assoc link org-stored-links))
10361 (or entry (push link org-insert-link-history))
10362 (setq desc (or desc (nth 1 entry)))))
10364 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10365 (not org-keep-stored-link-after-insertion))
10366 (setq org-stored-links (delq (assoc link org-stored-links)
10367 org-stored-links)))
10369 (if (and (string-match org-plain-link-re link)
10370 (not (string-match org-ts-regexp link)))
10371 ;; URL-like link, normalize the use of angular brackets.
10372 (setq link (org-remove-angle-brackets link)))
10374 ;; Check if we are linking to the current file with a search
10375 ;; option If yes, simplify the link by using only the search
10376 ;; option.
10377 (when (and buffer-file-name
10378 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10379 (let* ((path (match-string 1 link))
10380 (case-fold-search nil)
10381 (search (match-string 2 link)))
10382 (save-match-data
10383 (if (equal (file-truename buffer-file-name) (file-truename path))
10384 ;; We are linking to this same file, with a search option
10385 (setq link search)))))
10387 ;; Check if we can/should use a relative path. If yes, simplify the link
10388 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10389 (let* ((type (match-string 1 link))
10390 (path (match-string 2 link))
10391 (origpath path)
10392 (case-fold-search nil))
10393 (cond
10394 ((or (eq org-link-file-path-type 'absolute)
10395 (equal complete-file '(16)))
10396 (setq path (abbreviate-file-name (expand-file-name path))))
10397 ((eq org-link-file-path-type 'noabbrev)
10398 (setq path (expand-file-name path)))
10399 ((eq org-link-file-path-type 'relative)
10400 (setq path (file-relative-name path)))
10402 (save-match-data
10403 (if (string-match (concat "^" (regexp-quote
10404 (expand-file-name
10405 (file-name-as-directory
10406 default-directory))))
10407 (expand-file-name path))
10408 ;; We are linking a file with relative path name.
10409 (setq path (substring (expand-file-name path)
10410 (match-end 0)))
10411 (setq path (abbreviate-file-name (expand-file-name path)))))))
10412 (setq link (concat type path))
10413 (if (equal desc origpath)
10414 (setq desc path))))
10416 (if org-make-link-description-function
10417 (setq desc
10418 (or (condition-case nil
10419 (funcall org-make-link-description-function link desc)
10420 (error (progn (message "Can't get link description from `%s'"
10421 (symbol-name org-make-link-description-function))
10422 (sit-for 2) nil)))
10423 (read-string "Description: " default-description)))
10424 (if default-description (setq desc default-description)
10425 (setq desc (or (and auto-desc desc)
10426 (read-string "Description: " desc)))))
10428 (unless (string-match "\\S-" desc) (setq desc nil))
10429 (if remove (apply 'delete-region remove))
10430 (insert (org-make-link-string link desc))))
10432 (defun org-link-try-special-completion (type)
10433 "If there is completion support for link type TYPE, offer it."
10434 (let ((fun (intern (concat "org-" type "-complete-link"))))
10435 (if (functionp fun)
10436 (funcall fun)
10437 (read-string "Link (no completion support): " (concat type ":")))))
10439 (defun org-file-complete-link (&optional arg)
10440 "Create a file link using completion."
10441 (let ((file (org-iread-file-name "File: "))
10442 (pwd (file-name-as-directory (expand-file-name ".")))
10443 (pwd1 (file-name-as-directory (abbreviate-file-name
10444 (expand-file-name ".")))))
10445 (cond ((equal arg '(16))
10446 (concat "file:"
10447 (abbreviate-file-name (expand-file-name file))))
10448 ((string-match
10449 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10450 (concat "file:" (match-string 1 file)))
10451 ((string-match
10452 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10453 (expand-file-name file))
10454 (concat "file:"
10455 (match-string 1 (expand-file-name file))))
10456 (t (concat "file:" file)))))
10458 (defun org-iread-file-name (&rest args)
10459 "Read-file-name using `ido-mode' speedup if available.
10460 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10461 See `read-file-name' for a description of parameters."
10462 (org-without-partial-completion
10463 (if (and org-completion-use-ido
10464 (fboundp 'ido-read-file-name)
10465 (org-bound-and-true-p ido-mode)
10466 (listp (nth 1 args)))
10467 (let ((ido-enter-matching-directory nil))
10468 (apply #'ido-read-file-name args))
10469 (apply #'read-file-name args))))
10471 (defun org-completing-read (&rest args)
10472 "Completing-read with SPACE being a normal character."
10473 (let ((enable-recursive-minibuffers t)
10474 (minibuffer-local-completion-map
10475 (copy-keymap minibuffer-local-completion-map)))
10476 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10477 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10478 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10479 (apply 'org-icompleting-read args)))
10481 (defun org-completing-read-no-i (&rest args)
10482 (let (org-completion-use-ido org-completion-use-iswitchb)
10483 (apply 'org-completing-read args)))
10485 (defun org-iswitchb-completing-read (prompt choices &rest args)
10486 "Use iswitch as a completing-read replacement to choose from choices.
10487 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10488 from."
10489 (let* ((iswitchb-use-virtual-buffers nil)
10490 (iswitchb-make-buflist-hook
10491 (lambda ()
10492 (setq iswitchb-temp-buflist choices))))
10493 (iswitchb-read-buffer prompt)))
10495 (defun org-icompleting-read (&rest args)
10496 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10497 Should be called like `completing-read'."
10498 (org-without-partial-completion
10499 (if (not (listp (nth 1 args)))
10500 ;; Ido only supports lists as the COLLECTION argument. Use
10501 ;; default completion function when second argument is not
10502 ;; a list.
10503 (apply #'completing-read args)
10504 (let ((ido-enter-matching-directory nil))
10505 (apply (cond ((and org-completion-use-ido
10506 (fboundp 'ido-completing-read)
10507 (org-bound-and-true-p ido-mode))
10508 #'ido-completing-read)
10509 ((and org-completion-use-iswitchb
10510 (org-bound-and-true-p iswitchb-mode))
10511 #'org-iswitchb-completing-read)
10512 (t #'completing-read))
10513 args)))))
10515 ;;; Opening/following a link
10517 (defvar org-link-search-failed nil)
10519 (defvar org-open-link-functions nil
10520 "Hook for functions finding a plain text link.
10521 These functions must take a single argument, the link content.
10522 They will be called for links that look like [[link text][description]]
10523 when LINK TEXT does not have a protocol like \"http:\" and does not look
10524 like a filename (e.g. \"./blue.png\").
10526 These functions will be called *before* Org attempts to resolve the
10527 link by doing text searches in the current buffer - so if you want a
10528 link \"[[target]]\" to still find \"<<target>>\", your function should
10529 handle this as a special case.
10531 When the function does handle the link, it must return a non-nil value.
10532 If it decides that it is not responsible for this link, it must return
10533 nil to indicate that that Org-mode can continue with other options
10534 like exact and fuzzy text search.")
10536 (defun org-next-link (&optional search-backward)
10537 "Move forward to the next link.
10538 If the link is in hidden text, expose it."
10539 (interactive "P")
10540 (when (and org-link-search-failed (eq this-command last-command))
10541 (goto-char (point-min))
10542 (message "Link search wrapped back to beginning of buffer"))
10543 (setq org-link-search-failed nil)
10544 (let* ((pos (point))
10545 (ct (org-context))
10546 (a (assoc :link ct))
10547 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10548 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10549 ((looking-at org-any-link-re)
10550 ;; Don't stay stuck at link without an org-link face
10551 (forward-char (if search-backward -1 1))))
10552 (if (funcall srch-fun org-any-link-re nil t)
10553 (progn
10554 (goto-char (match-beginning 0))
10555 (if (outline-invisible-p) (org-show-context)))
10556 (goto-char pos)
10557 (setq org-link-search-failed t)
10558 (message "No further link found"))))
10560 (defun org-previous-link ()
10561 "Move backward to the previous link.
10562 If the link is in hidden text, expose it."
10563 (interactive)
10564 (funcall 'org-next-link t))
10566 (defun org-translate-link (s)
10567 "Translate a link string if a translation function has been defined."
10568 (with-temp-buffer
10569 (insert (org-trim s))
10570 (org-trim (org-element-interpret-data (org-element-context)))))
10572 (defun org-translate-link-from-planner (type path)
10573 "Translate a link from Emacs Planner syntax so that Org can follow it.
10574 This is still an experimental function, your mileage may vary."
10575 (cond
10576 ((member type '("http" "https" "news" "ftp"))
10577 ;; standard Internet links are the same.
10578 nil)
10579 ((and (equal type "irc") (string-match "^//" path))
10580 ;; Planner has two / at the beginning of an irc link, we have 1.
10581 ;; We should have zero, actually....
10582 (setq path (substring path 1)))
10583 ((and (equal type "lisp") (string-match "^/" path))
10584 ;; Planner has a slash, we do not.
10585 (setq type "elisp" path (substring path 1)))
10586 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10587 ;; A typical message link. Planner has the id after the final slash,
10588 ;; we separate it with a hash mark
10589 (setq path (concat (match-string 1 path) "#"
10590 (org-remove-angle-brackets (match-string 2 path))))))
10591 (cons type path))
10593 (defun org-find-file-at-mouse (ev)
10594 "Open file link or URL at mouse."
10595 (interactive "e")
10596 (mouse-set-point ev)
10597 (org-open-at-point 'in-emacs))
10599 (defun org-open-at-mouse (ev)
10600 "Open file link or URL at mouse.
10601 See the docstring of `org-open-file' for details."
10602 (interactive "e")
10603 (mouse-set-point ev)
10604 (if (eq major-mode 'org-agenda-mode)
10605 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10606 (org-open-at-point))
10608 (defvar org-window-config-before-follow-link nil
10609 "The window configuration before following a link.
10610 This is saved in case the need arises to restore it.")
10612 ;;;###autoload
10613 (defun org-open-at-point-global ()
10614 "Follow a link like Org-mode does.
10615 This command can be called in any mode to follow a link that has
10616 Org-mode syntax."
10617 (interactive)
10618 (org-run-like-in-org-mode 'org-open-at-point))
10620 ;;;###autoload
10621 (defun org-open-link-from-string (s &optional arg reference-buffer)
10622 "Open a link in the string S, as if it was in Org-mode."
10623 (interactive "sLink: \nP")
10624 (let ((reference-buffer (or reference-buffer (current-buffer))))
10625 (with-temp-buffer
10626 (let ((org-inhibit-startup (not reference-buffer)))
10627 (org-mode)
10628 (insert s)
10629 (goto-char (point-min))
10630 (when reference-buffer
10631 (setq org-link-abbrev-alist-local
10632 (with-current-buffer reference-buffer
10633 org-link-abbrev-alist-local)))
10634 (org-open-at-point arg reference-buffer)))))
10636 (defvar org-open-at-point-functions nil
10637 "Hook that is run when following a link at point.
10639 Functions in this hook must return t if they identify and follow
10640 a link at point. If they don't find anything interesting at point,
10641 they must return nil.")
10643 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10644 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10645 (defun org-open-at-point (&optional arg reference-buffer)
10646 "Open link, timestamp, footnote or tags at point.
10648 When point is on a link, follow it. Normally, files will be
10649 opened by an appropriate application. If the optional prefix
10650 argument ARG is non-nil, Emacs will visit the file. With
10651 a double prefix argument, try to open outside of Emacs, in the
10652 application the system uses for this file type.
10654 When point is on a timestamp, open the agenda at the day
10655 specified.
10657 When point is a footnote definition, move to the first reference
10658 found. If it is on a reference, move to the associated
10659 definition.
10661 When point is on a headline, display a list of every link in the
10662 entry, so it is possible to pick one, or all, of them. If point
10663 is on a tag, call `org-tags-view' instead.
10665 When optional argument REFERENCE-BUFFER is non-nil, it should
10666 specify a buffer from where the link search should happen. This
10667 is used internally by `org-open-link-from-string'.
10669 On top of syntactically correct links, this function will open
10670 the link at point in comments or comment blocks and the first
10671 link in a property drawer line."
10672 (interactive "P")
10673 ;; On a code block, open block's results.
10674 (unless (call-interactively 'org-babel-open-src-block-result)
10675 (org-load-modules-maybe)
10676 (setq org-window-config-before-follow-link (current-window-configuration))
10677 (org-remove-occur-highlights nil nil t)
10678 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10679 (let* ((context
10680 ;; Only consider supported types, even if they are not
10681 ;; the closest one.
10682 (org-element-lineage
10683 (org-element-context)
10684 '(clock comment comment-block footnote-definition
10685 footnote-reference headline inlinetask keyword link
10686 node-property timestamp)
10688 (type (org-element-type context))
10689 (value (org-element-property :value context)))
10690 (cond
10691 ((not context) (user-error "No link found"))
10692 ;; Exception: open timestamps and links in properties
10693 ;; drawers, keywords and comments.
10694 ((memq type '(comment comment-block keyword node-property))
10695 (cond ((org-in-regexp org-any-link-re)
10696 (org-open-link-from-string (match-string-no-properties 0)))
10697 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10698 (org-follow-timestamp-link))
10699 (t (user-error "No link found"))))
10700 ;; On a headline or an inlinetask, but not on a timestamp,
10701 ;; a link, a footnote reference or on tags.
10702 ((and (memq type '(headline inlinetask))
10703 ;; Not on tags.
10704 (progn (save-excursion (beginning-of-line)
10705 (looking-at org-complex-heading-regexp))
10706 (or (not (match-beginning 5))
10707 (< (point) (match-beginning 5)))))
10708 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10709 (links (car data))
10710 (links-end (cdr data)))
10711 (if links
10712 (dolist (link (if (stringp links) (list links) links))
10713 (search-forward link nil links-end)
10714 (goto-char (match-beginning 0))
10715 (org-open-at-point))
10716 (require 'org-attach)
10717 (org-attach-reveal 'if-exists))))
10718 ;; On a clock line, make sure point is on the timestamp
10719 ;; before opening it.
10720 ((and (eq type 'clock)
10721 value
10722 (>= (point) (org-element-property :begin value))
10723 (<= (point) (org-element-property :end value)))
10724 (org-follow-timestamp-link))
10725 ;; Do nothing on white spaces after an object, unless point
10726 ;; is right after it.
10727 ((> (point)
10728 (save-excursion
10729 (goto-char (org-element-property :end context))
10730 (skip-chars-backward " \t")
10731 (point)))
10732 (user-error "No link found"))
10733 ((eq type 'timestamp) (org-follow-timestamp-link))
10734 ;; On tags within a headline or an inlinetask.
10735 ((and (memq type '(headline inlinetask))
10736 (progn (save-excursion (beginning-of-line)
10737 (looking-at org-complex-heading-regexp))
10738 (and (match-beginning 5)
10739 (>= (point) (match-beginning 5)))))
10740 (org-tags-view arg (substring (match-string 5) 0 -1)))
10741 ((eq type 'link)
10742 ;; When link is located within the description of another
10743 ;; link (e.g., an inline image), always open the parent
10744 ;; link.
10745 (let*((link (let ((up (org-element-property :parent context)))
10746 (if (eq (org-element-type up) 'link) up context)))
10747 (type (org-element-property :type link))
10748 (path (org-link-unescape (org-element-property :path link))))
10749 ;; Switch back to REFERENCE-BUFFER needed when called in
10750 ;; a temporary buffer through `org-open-link-from-string'.
10751 (with-current-buffer (or reference-buffer (current-buffer))
10752 (cond
10753 ((equal type "file")
10754 (if (string-match "[*?{]" (file-name-nondirectory path))
10755 (dired path)
10756 ;; Look into `org-link-protocols' in order to find
10757 ;; a DEDICATED-FUNCTION to open file. The function
10758 ;; will be applied on raw link instead of parsed
10759 ;; link due to the limitation in `org-add-link-type'
10760 ;; ("open" function called with a single argument).
10761 ;; If no such function is found, fallback to
10762 ;; `org-open-file'.
10764 ;; Note : "file+emacs" and "file+sys" types are
10765 ;; hard-coded in order to escape the previous
10766 ;; limitation.
10767 (let* ((option (org-element-property :search-option link))
10768 (app (org-element-property :application link))
10769 (dedicated-function
10770 (nth 1 (assoc app org-link-protocols))))
10771 (if dedicated-function
10772 (funcall dedicated-function
10773 (concat path
10774 (and option (concat "::" option))))
10775 (apply #'org-open-file
10776 path
10777 (cond (arg)
10778 ((equal app "emacs") 'emacs)
10779 ((equal app "sys") 'system))
10780 (cond ((not option) nil)
10781 ((org-string-match-p "\\`[0-9]+\\'" option)
10782 (list (string-to-number option)))
10783 (t (list nil
10784 (org-link-unescape option)))))))))
10785 ((assoc type org-link-protocols)
10786 (funcall (nth 1 (assoc type org-link-protocols)) path))
10787 ((equal type "help")
10788 (let ((f-or-v (intern path)))
10789 (cond ((fboundp f-or-v) (describe-function f-or-v))
10790 ((boundp f-or-v) (describe-variable f-or-v))
10791 (t (error "Not a known function or variable")))))
10792 ((member type '("http" "https" "ftp" "mailto" "news"))
10793 (browse-url (org-link-escape-browser (concat type ":" path))))
10794 ((equal type "doi")
10795 (browse-url
10796 (org-link-escape-browser (concat org-doi-server-url path))))
10797 ((equal type "message") (browse-url (concat type ":" path)))
10798 ((equal type "shell")
10799 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10800 (cmd path))
10801 (if (or (and (org-string-nw-p
10802 org-confirm-shell-link-not-regexp)
10803 (string-match
10804 org-confirm-shell-link-not-regexp cmd))
10805 (not org-confirm-shell-link-function)
10806 (funcall org-confirm-shell-link-function
10807 (format "Execute \"%s\" in shell? "
10808 (org-add-props cmd nil
10809 'face 'org-warning))))
10810 (progn
10811 (message "Executing %s" cmd)
10812 (shell-command cmd buf)
10813 (when (featurep 'midnight)
10814 (setq clean-buffer-list-kill-buffer-names
10815 (cons (buffer-name buf)
10816 clean-buffer-list-kill-buffer-names))))
10817 (user-error "Abort"))))
10818 ((equal type "elisp")
10819 (let ((cmd path))
10820 (if (or (and (org-string-nw-p
10821 org-confirm-elisp-link-not-regexp)
10822 (org-string-match-p
10823 org-confirm-elisp-link-not-regexp cmd))
10824 (not org-confirm-elisp-link-function)
10825 (funcall org-confirm-elisp-link-function
10826 (format "Execute \"%s\" as elisp? "
10827 (org-add-props cmd nil
10828 'face 'org-warning))))
10829 (message "%s => %s" cmd
10830 (if (eq (string-to-char cmd) ?\()
10831 (eval (read cmd))
10832 (call-interactively (read cmd))))
10833 (user-error "Abort"))))
10834 ((equal type "id")
10835 (require 'org-id)
10836 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10837 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10838 (unless (run-hook-with-args-until-success
10839 'org-open-link-functions path)
10840 (if (not arg) (org-mark-ring-push)
10841 (switch-to-buffer-other-window
10842 (org-get-buffer-for-internal-link (current-buffer))))
10843 (let ((destination
10844 (org-with-wide-buffer
10845 (if (equal type "radio")
10846 (org-search-radio-target
10847 (org-element-property :path link))
10848 (org-link-search
10849 (if (member type '("custom-id" "coderef"))
10850 (org-element-property :raw-link link)
10851 path)
10852 ;; Prevent fuzzy links from matching
10853 ;; themselves.
10854 (and (equal type "fuzzy")
10855 (+ 2 (org-element-property :begin link)))))
10856 (point))))
10857 (unless (and (<= (point-min) destination)
10858 (>= (point-max) destination))
10859 (widen))
10860 (goto-char destination))))
10861 (t (browse-url-at-point))))))
10862 ;; On a footnote reference or at a footnote definition's label.
10863 ((or (eq type 'footnote-reference)
10864 (and (eq type 'footnote-definition)
10865 (save-excursion
10866 ;; Do not validate action when point is on the
10867 ;; spaces right after the footnote label, in
10868 ;; order to be on par with behaviour on links.
10869 (skip-chars-forward " \t")
10870 (let ((begin
10871 (org-element-property :contents-begin context)))
10872 (if begin (< (point) begin)
10873 (= (org-element-property :post-affiliated context)
10874 (line-beginning-position)))))))
10875 (org-footnote-action))
10876 (t (user-error "No link found")))))
10877 (run-hook-with-args 'org-follow-link-hook)))
10879 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10880 "Offer links in the current entry and return the selected link.
10881 If there is only one link, return it.
10882 If NTH is an integer, return the NTH link found.
10883 If ZERO is a string, check also this string for a link, and if
10884 there is one, return it."
10885 (with-current-buffer buffer
10886 (save-excursion
10887 (save-restriction
10888 (widen)
10889 (goto-char marker)
10890 (let ((cnt ?0)
10891 (in-emacs (if (integerp nth) nil nth))
10892 have-zero end links link c)
10893 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10894 (push (match-string 0 zero) links)
10895 (setq cnt (1- cnt) have-zero t))
10896 (save-excursion
10897 (org-back-to-heading t)
10898 (setq end (save-excursion (outline-next-heading) (point)))
10899 (while (re-search-forward org-any-link-re end t)
10900 (push (match-string 0) links))
10901 (setq links (org-uniquify (reverse links))))
10902 (cond
10903 ((null links)
10904 (message "No links"))
10905 ((equal (length links) 1)
10906 (setq link (car links)))
10907 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10908 (setq link (nth (if have-zero nth (1- nth)) links)))
10909 (t ; we have to select a link
10910 (save-excursion
10911 (save-window-excursion
10912 (delete-other-windows)
10913 (with-output-to-temp-buffer "*Select Link*"
10914 (mapc (lambda (l)
10915 (if (not (string-match org-bracket-link-regexp l))
10916 (princ (format "[%c] %s\n" (incf cnt)
10917 (org-remove-angle-brackets l)))
10918 (if (match-end 3)
10919 (princ (format "[%c] %s (%s)\n" (incf cnt)
10920 (match-string 3 l) (match-string 1 l)))
10921 (princ (format "[%c] %s\n" (incf cnt)
10922 (match-string 1 l))))))
10923 links))
10924 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10925 (message "Select link to open, RET to open all:")
10926 (setq c (read-char-exclusive))
10927 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10928 (when (equal c ?q) (user-error "Abort"))
10929 (if (equal c ?\C-m)
10930 (setq link links)
10931 (setq nth (- c ?0))
10932 (if have-zero (setq nth (1+ nth)))
10933 (unless (and (integerp nth) (>= (length links) nth))
10934 (user-error "Invalid link selection"))
10935 (setq link (nth (1- nth) links)))))
10936 (cons link end))))))
10938 ;; TODO: These functions are deprecated since `org-open-at-point'
10939 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10940 (defun org-open-file-with-system (path)
10941 "Open file at PATH using the system way of opening it."
10942 (org-open-file path 'system))
10943 (defun org-open-file-with-emacs (path)
10944 "Open file at PATH in Emacs."
10945 (org-open-file path 'emacs))
10948 ;;; File search
10950 (defvar org-create-file-search-functions nil
10951 "List of functions to construct the right search string for a file link.
10952 These functions are called in turn with point at the location to
10953 which the link should point.
10955 A function in the hook should first test if it would like to
10956 handle this file type, for example by checking the `major-mode'
10957 or the file extension. If it decides not to handle this file, it
10958 should just return nil to give other functions a chance. If it
10959 does handle the file, it must return the search string to be used
10960 when following the link. The search string will be part of the
10961 file link, given after a double colon, and `org-open-at-point'
10962 will automatically search for it. If special measures must be
10963 taken to make the search successful, another function should be
10964 added to the companion hook `org-execute-file-search-functions',
10965 which see.
10967 A function in this hook may also use `setq' to set the variable
10968 `description' to provide a suggestion for the descriptive text to
10969 be used for this link when it gets inserted into an Org-mode
10970 buffer with \\[org-insert-link].")
10972 (defvar org-execute-file-search-functions nil
10973 "List of functions to execute a file search triggered by a link.
10975 Functions added to this hook must accept a single argument, the
10976 search string that was part of the file link, the part after the
10977 double colon. The function must first check if it would like to
10978 handle this search, for example by checking the `major-mode' or
10979 the file extension. If it decides not to handle this search, it
10980 should just return nil to give other functions a chance. If it
10981 does handle the search, it must return a non-nil value to keep
10982 other functions from trying.
10984 Each function can access the current prefix argument through the
10985 variable `current-prefix-arg'. Note that a single prefix is used
10986 to force opening a link in Emacs, so it may be good to only use a
10987 numeric or double prefix to guide the search function.
10989 In case this is needed, a function in this hook can also restore
10990 the window configuration before `org-open-at-point' was called using:
10992 (set-window-configuration org-window-config-before-follow-link)")
10994 (defun org-search-radio-target (target)
10995 "Search a radio target matching TARGET in current buffer.
10996 White spaces are not significant."
10997 (let ((re (format "<<<%s>>>"
10998 (mapconcat #'regexp-quote
10999 (org-split-string target "[ \t\n]+")
11000 "[ \t]+\\(?:\n[ \t]*\\)?")))
11001 (origin (point)))
11002 (goto-char (point-min))
11003 (catch :radio-match
11004 (while (re-search-forward re nil t)
11005 (backward-char)
11006 (let ((object (org-element-context)))
11007 (when (eq (org-element-type object) 'radio-target)
11008 (goto-char (org-element-property :begin object))
11009 (org-show-context 'link-search)
11010 (throw :radio-match nil))))
11011 (goto-char origin)
11012 (user-error "No match for radio target: %s" target))))
11014 (defun org-link-search (s &optional avoid-pos stealth)
11015 "Search for a search string S.
11017 If S starts with \"#\", it triggers a custom ID search.
11019 If S is enclosed within parenthesis, it initiates a coderef
11020 search.
11022 If S is surrounded by forward slashes, it is interpreted as
11023 a regular expression. In Org mode files, this will create an
11024 `org-occur' sparse tree. In ordinary files, `occur' will be used
11025 to list matches. If the current buffer is in `dired-mode', grep
11026 will be used to search in all files.
11028 When AVOID-POS is given, ignore matches near that position.
11030 When optional argument STEALTH is non-nil, do not modify
11031 visibility around point, thus ignoring `org-show-context-detail'
11032 variable.
11034 Search is case-insensitive and ignores white spaces. Return type
11035 of matched result, with is either `dedicated' or `fuzzy'."
11036 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11037 (let* ((case-fold-search t)
11038 (origin (point))
11039 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11040 (words (org-split-string s "[ \t\n]+"))
11041 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11042 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11043 type)
11044 (cond
11045 ;; Check if there are any special search functions.
11046 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11047 ((eq (string-to-char s) ?#)
11048 ;; Look for a custom ID S if S starts with "#".
11049 (let* ((id (substring normalized 1))
11050 (match (org-find-property "CUSTOM_ID" id)))
11051 (if match (progn (goto-char match) (setf type 'dedicated))
11052 (error "No match for custom ID: %s" id))))
11053 ((string-match "\\`(\\(.*\\))\\'" normalized)
11054 ;; Look for coderef targets if S is enclosed within parenthesis.
11055 (let ((coderef (match-string-no-properties 1 normalized))
11056 (re (substring s-single-re 1 -1)))
11057 (goto-char (point-min))
11058 (catch :coderef-match
11059 (while (re-search-forward re nil t)
11060 (let ((element (org-element-at-point)))
11061 (when (and (memq (org-element-type element)
11062 '(example-block src-block))
11063 ;; Build proper regexp according to current
11064 ;; block's label format.
11065 (let ((label-fmt
11066 (regexp-quote
11067 (or (org-element-property :label-fmt element)
11068 org-coderef-label-format))))
11069 (save-excursion
11070 (beginning-of-line)
11071 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11072 (format label-fmt coderef))))))
11073 (setq type 'dedicated)
11074 (goto-char (match-beginning 1))
11075 (throw :coderef-match nil))))
11076 (goto-char origin)
11077 (error "No match for coderef: %s" coderef))))
11078 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11079 ;; Look for a regular expression.
11080 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11081 (match-string 1 s)))
11082 ;; Fuzzy links.
11084 (let* ((starred (eq (string-to-char normalized) ?*))
11085 (headline-search (and (derived-mode-p 'org-mode)
11086 (or org-link-search-must-match-exact-headline
11087 starred))))
11088 (cond
11089 ;; Look for targets, only if not in a headline search.
11090 ((and (not starred)
11091 (let ((target (format "<<%s>>" s-multi-re)))
11092 (catch :target-match
11093 (goto-char (point-min))
11094 (while (re-search-forward target nil t)
11095 (backward-char)
11096 (let ((context (org-element-context)))
11097 (when (eq (org-element-type context) 'target)
11098 (setq type 'dedicated)
11099 (goto-char (org-element-property :begin context))
11100 (throw :target-match t))))
11101 nil))))
11102 ;; Look for elements named after S, only if not in a headline
11103 ;; search.
11104 ((and (not starred)
11105 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11106 (catch :name-match
11107 (goto-char (point-min))
11108 (while (re-search-forward name nil t)
11109 (let ((element (org-element-at-point)))
11110 (when (equal (org-split-string
11111 (org-element-property :name element)
11112 "[ \t]+")
11113 words)
11114 (setq type 'dedicated)
11115 (beginning-of-line)
11116 (throw :name-match t))))
11117 nil))))
11118 ;; Regular text search. Prefer headlines in Org mode
11119 ;; buffers.
11120 ((and (derived-mode-p 'org-mode)
11121 (let* ((wspace "[ \t]")
11122 (wspaceopt (concat wspace "*"))
11123 (cookie (concat "\\(?:"
11124 wspaceopt
11125 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11126 wspaceopt
11127 "\\)"))
11128 (sep (concat "\\(?:\\(?:" wspace "\\|" cookie "\\)+\\)"))
11129 (re (concat
11130 org-outline-regexp-bol
11131 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11132 "\\(?:\\[#.\\][ \t]+\\)?"
11133 "\\(?:" org-comment-string "[ \t]+\\)?"
11134 sep "?"
11135 (let ((title (mapconcat #'regexp-quote
11136 words
11137 sep)))
11138 (if starred (substring title 1) title))
11139 sep "?"
11140 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11141 "[ \t]*$")))
11142 (goto-char (point-min))
11143 (re-search-forward re nil t)))
11144 (goto-char (match-beginning 0))
11145 (setq type 'dedicated))
11146 ;; Offer to create non-existent headline depending on
11147 ;; `org-link-search-must-match-exact-headline'.
11148 ((and (derived-mode-p 'org-mode)
11149 (not org-link-search-inhibit-query)
11150 (eq org-link-search-must-match-exact-headline 'query-to-create)
11151 (yes-or-no-p "No match - create this as a new heading? "))
11152 (goto-char (point-max))
11153 (unless (bolp) (newline))
11154 (org-insert-heading nil t t)
11155 (insert s "\n")
11156 (beginning-of-line 0))
11157 ;; Only headlines are looked after. No need to process
11158 ;; further: throw an error.
11159 ((and (derived-mode-p 'org-mode)
11160 (or starred org-link-search-must-match-exact-headline))
11161 (goto-char origin)
11162 (error "No match for fuzzy expression: %s" normalized))
11163 ;; Regular text search.
11164 ((catch :fuzzy-match
11165 (goto-char (point-min))
11166 (while (re-search-forward s-multi-re nil t)
11167 ;; Skip match if it contains AVOID-POS or it is included
11168 ;; in a link with a description but outside the
11169 ;; description.
11170 (unless (or (and avoid-pos
11171 (<= (match-beginning 0) avoid-pos)
11172 (> (match-end 0) avoid-pos))
11173 (and (save-match-data
11174 (org-in-regexp org-bracket-link-regexp))
11175 (match-beginning 3)
11176 (or (> (match-beginning 3) (point))
11177 (<= (match-end 3) (point)))
11178 (org-element-lineage
11179 (save-match-data (org-element-context))
11180 '(link) t)))
11181 (goto-char (match-beginning 0))
11182 (setq type 'fuzzy)
11183 (throw :fuzzy-match t)))
11184 nil))
11185 ;; All failed. Throw an error.
11186 (t (goto-char origin)
11187 (error "No match for fuzzy expression: %s" normalized))))))
11188 ;; Disclose surroundings of match, if appropriate.
11189 (when (and (derived-mode-p 'org-mode) (not stealth))
11190 (org-show-context 'link-search))
11191 type))
11193 (defun org-get-buffer-for-internal-link (buffer)
11194 "Return a buffer to be used for displaying the link target of internal links."
11195 (cond
11196 ((not org-display-internal-link-with-indirect-buffer)
11197 buffer)
11198 ((string-match "(Clone)$" (buffer-name buffer))
11199 (message "Buffer is already a clone, not making another one")
11200 ;; we also do not modify visibility in this case
11201 buffer)
11202 (t ; make a new indirect buffer for displaying the link
11203 (let* ((bn (buffer-name buffer))
11204 (ibn (concat bn "(Clone)"))
11205 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11206 (with-current-buffer ib (org-overview))
11207 ib))))
11209 (defun org-do-occur (regexp &optional cleanup)
11210 "Call the Emacs command `occur'.
11211 If CLEANUP is non-nil, remove the printout of the regular expression
11212 in the *Occur* buffer. This is useful if the regex is long and not useful
11213 to read."
11214 (occur regexp)
11215 (when cleanup
11216 (let ((cwin (selected-window)) win beg end)
11217 (when (setq win (get-buffer-window "*Occur*"))
11218 (select-window win))
11219 (goto-char (point-min))
11220 (when (re-search-forward "match[a-z]+" nil t)
11221 (setq beg (match-end 0))
11222 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11223 (setq end (1- (match-beginning 0)))))
11224 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11225 (goto-char (point-min))
11226 (select-window cwin))))
11228 ;;; The mark ring for links jumps
11230 (defvar org-mark-ring nil
11231 "Mark ring for positions before jumps in Org-mode.")
11232 (defvar org-mark-ring-last-goto nil
11233 "Last position in the mark ring used to go back.")
11234 ;; Fill and close the ring
11235 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11236 (loop for i from 1 to org-mark-ring-length do
11237 (push (make-marker) org-mark-ring))
11238 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11239 org-mark-ring)
11241 (defun org-mark-ring-push (&optional pos buffer)
11242 "Put the current position or POS into the mark ring and rotate it."
11243 (interactive)
11244 (setq pos (or pos (point)))
11245 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11246 (move-marker (car org-mark-ring)
11247 (or pos (point))
11248 (or buffer (current-buffer)))
11249 (message "%s"
11250 (substitute-command-keys
11251 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11253 (defun org-mark-ring-goto (&optional n)
11254 "Jump to the previous position in the mark ring.
11255 With prefix arg N, jump back that many stored positions. When
11256 called several times in succession, walk through the entire ring.
11257 Org-mode commands jumping to a different position in the current file,
11258 or to another Org-mode file, automatically push the old position
11259 onto the ring."
11260 (interactive "p")
11261 (let (p m)
11262 (if (eq last-command this-command)
11263 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11264 (setq p org-mark-ring))
11265 (setq org-mark-ring-last-goto p)
11266 (setq m (car p))
11267 (org-pop-to-buffer-same-window (marker-buffer m))
11268 (goto-char m)
11269 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11271 (defun org-remove-angle-brackets (s)
11272 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11273 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11275 (defun org-add-angle-brackets (s)
11276 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11277 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11279 (defun org-remove-double-quotes (s)
11280 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11281 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11284 ;;; Following specific links
11286 (defun org-follow-timestamp-link ()
11287 "Open an agenda view for the time-stamp date/range at point."
11288 (cond
11289 ((org-at-date-range-p t)
11290 (let ((org-agenda-start-on-weekday)
11291 (t1 (match-string 1))
11292 (t2 (match-string 2)) tt1 tt2)
11293 (setq tt1 (time-to-days (org-time-string-to-time t1))
11294 tt2 (time-to-days (org-time-string-to-time t2)))
11295 (let ((org-agenda-buffer-tmp-name
11296 (format "*Org Agenda(a:%s)"
11297 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11298 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11299 ((org-at-timestamp-p t)
11300 (let ((org-agenda-buffer-tmp-name
11301 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11302 (org-agenda-list nil (time-to-days (org-time-string-to-time
11303 (substring (match-string 1) 0 10)))
11304 1)))
11305 (t (error "This should not happen"))))
11308 ;;; Following file links
11309 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11310 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11311 (declare-function mailcap-mime-info
11312 "mailcap" (string &optional request no-decode))
11313 (defvar org-wait nil)
11314 (defun org-open-file (path &optional in-emacs line search)
11315 "Open the file at PATH.
11316 First, this expands any special file name abbreviations. Then the
11317 configuration variable `org-file-apps' is checked if it contains an
11318 entry for this file type, and if yes, the corresponding command is launched.
11320 If no application is found, Emacs simply visits the file.
11322 With optional prefix argument IN-EMACS, Emacs will visit the file.
11323 With a double \\[universal-argument] \\[universal-argument] \
11324 prefix arg, Org tries to avoid opening in Emacs
11325 and to use an external application to visit the file.
11327 Optional LINE specifies a line to go to, optional SEARCH a string
11328 to search for. If LINE or SEARCH is given, the file will be
11329 opened in Emacs, unless an entry from org-file-apps that makes
11330 use of groups in a regexp matches.
11332 If you want to change the way frames are used when following a
11333 link, please customize `org-link-frame-setup'.
11335 If the file does not exist, an error is thrown."
11336 (let* ((file (if (equal path "")
11337 buffer-file-name
11338 (substitute-in-file-name (expand-file-name path))))
11339 (file-apps (append org-file-apps (org-default-apps)))
11340 (apps (org-remove-if
11341 'org-file-apps-entry-match-against-dlink-p file-apps))
11342 (apps-dlink (org-remove-if-not
11343 'org-file-apps-entry-match-against-dlink-p file-apps))
11344 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11345 (dirp (if remp nil (file-directory-p file)))
11346 (file (if (and dirp org-open-directory-means-index-dot-org)
11347 (concat (file-name-as-directory file) "index.org")
11348 file))
11349 (a-m-a-p (assq 'auto-mode apps))
11350 (dfile (downcase file))
11351 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11352 (link (cond ((and (eq line nil)
11353 (eq search nil))
11354 file)
11355 (line
11356 (concat file "::" (number-to-string line)))
11357 (search
11358 (concat file "::" search))))
11359 (dlink (downcase link))
11360 (old-buffer (current-buffer))
11361 (old-pos (point))
11362 (old-mode major-mode)
11363 ext cmd link-match-data)
11364 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11365 (setq ext (match-string 1 dfile))
11366 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11367 (setq ext (match-string 1 dfile))))
11368 (cond
11369 ((member in-emacs '((16) system))
11370 (setq cmd (cdr (assoc 'system apps))))
11371 (in-emacs (setq cmd 'emacs))
11373 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11374 (and dirp (cdr (assoc 'directory apps)))
11375 ; first, try matching against apps-dlink
11376 ; if we get a match here, store the match data for later
11377 (let ((match (assoc-default dlink apps-dlink
11378 'string-match)))
11379 (if match
11380 (progn (setq link-match-data (match-data))
11381 match)
11382 (progn (setq in-emacs (or in-emacs line search))
11383 nil))) ; if we have no match in apps-dlink,
11384 ; always open the file in emacs if line or search
11385 ; is given (for backwards compatibility)
11386 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11387 'string-match)
11388 (cdr (assoc ext apps))
11389 (cdr (assoc t apps))))))
11390 (when (eq cmd 'system)
11391 (setq cmd (cdr (assoc 'system apps))))
11392 (when (eq cmd 'default)
11393 (setq cmd (cdr (assoc t apps))))
11394 (when (eq cmd 'mailcap)
11395 (require 'mailcap)
11396 (mailcap-parse-mailcaps)
11397 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11398 (command (mailcap-mime-info mime-type)))
11399 (if (stringp command)
11400 (setq cmd command)
11401 (setq cmd 'emacs))))
11402 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11403 (not (file-exists-p file))
11404 (not org-open-non-existing-files))
11405 (user-error "No such file: %s" file))
11406 (cond
11407 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11408 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11409 (while (string-match "['\"]%s['\"]" cmd)
11410 (setq cmd (replace-match "%s" t t cmd)))
11411 (while (string-match "%s" cmd)
11412 (setq cmd (replace-match
11413 (save-match-data
11414 (shell-quote-argument
11415 (convert-standard-filename file)))
11416 t t cmd)))
11418 ;; Replace "%1", "%2" etc. in command with group matches from regex
11419 (save-match-data
11420 (let ((match-index 1)
11421 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11422 (set-match-data link-match-data)
11423 (while (<= match-index number-of-groups)
11424 (let ((regex (concat "%" (number-to-string match-index)))
11425 (replace-with (match-string match-index dlink)))
11426 (while (string-match regex cmd)
11427 (setq cmd (replace-match replace-with t t cmd))))
11428 (setq match-index (+ match-index 1)))))
11430 (save-window-excursion
11431 (message "Running %s...done" cmd)
11432 (start-process-shell-command cmd nil cmd)
11433 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11434 ((or (stringp cmd)
11435 (eq cmd 'emacs))
11436 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11437 (widen)
11438 (if line (progn (org-goto-line line)
11439 (if (derived-mode-p 'org-mode)
11440 (org-reveal)))
11441 (if search (org-link-search search))))
11442 ((consp cmd)
11443 (let ((file (convert-standard-filename file)))
11444 (save-match-data
11445 (set-match-data link-match-data)
11446 (eval cmd))))
11447 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11448 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11449 (or (not (equal old-buffer (current-buffer)))
11450 (not (equal old-pos (point))))
11451 (org-mark-ring-push old-pos old-buffer))))
11453 (defun org-file-apps-entry-match-against-dlink-p (entry)
11454 "This function returns non-nil if `entry' uses a regular
11455 expression which should be matched against the whole link by
11456 org-open-file.
11458 It assumes that is the case when the entry uses a regular
11459 expression which has at least one grouping construct and the
11460 action is either a lisp form or a command string containing
11461 '%1', i.e. using at least one subexpression match as a
11462 parameter."
11463 (let ((selector (car entry))
11464 (action (cdr entry)))
11465 (if (stringp selector)
11466 (and (> (regexp-opt-depth selector) 0)
11467 (or (and (stringp action)
11468 (string-match "%[0-9]" action))
11469 (consp action)))
11470 nil)))
11472 (defun org-default-apps ()
11473 "Return the default applications for this operating system."
11474 (cond
11475 ((eq system-type 'darwin)
11476 org-file-apps-defaults-macosx)
11477 ((eq system-type 'windows-nt)
11478 org-file-apps-defaults-windowsnt)
11479 (t org-file-apps-defaults-gnu)))
11481 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11482 "Convert extensions to regular expressions in the cars of LIST.
11483 Also, weed out any non-string entries, because the return value is used
11484 only for regexp matching.
11485 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11486 point to the symbol `emacs', indicating that the file should
11487 be opened in Emacs."
11488 (append
11489 (delq nil
11490 (mapcar (lambda (x)
11491 (if (not (stringp (car x)))
11493 (if (string-match "\\W" (car x))
11495 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11496 list))
11497 (if add-auto-mode
11498 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11500 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11501 (defun org-file-remote-p (file)
11502 "Test whether FILE specifies a location on a remote system.
11503 Return non-nil if the location is indeed remote.
11505 For example, the filename \"/user@host:/foo\" specifies a location
11506 on the system \"/user@host:\"."
11507 (cond ((fboundp 'file-remote-p)
11508 (file-remote-p file))
11509 ((fboundp 'tramp-handle-file-remote-p)
11510 (tramp-handle-file-remote-p file))
11511 ((and (boundp 'ange-ftp-name-format)
11512 (string-match (car ange-ftp-name-format) file))
11513 t)))
11516 ;;;; Refiling
11518 (defun org-get-org-file ()
11519 "Read a filename, with default directory `org-directory'."
11520 (let ((default (or org-default-notes-file remember-data-file)))
11521 (read-file-name (format "File name [%s]: " default)
11522 (file-name-as-directory org-directory)
11523 default)))
11525 (defun org-notes-order-reversed-p ()
11526 "Check if the current file should receive notes in reversed order."
11527 (cond
11528 ((not org-reverse-note-order) nil)
11529 ((eq t org-reverse-note-order) t)
11530 ((not (listp org-reverse-note-order)) nil)
11531 (t (catch 'exit
11532 (dolist (entry org-reverse-note-order)
11533 (if (string-match (car entry) buffer-file-name)
11534 (throw 'exit (cdr entry))))))))
11536 (defvar org-refile-target-table nil
11537 "The list of refile targets, created by `org-refile'.")
11539 (defvar org-agenda-new-buffers nil
11540 "Buffers created to visit agenda files.")
11542 (defvar org-refile-cache nil
11543 "Cache for refile targets.")
11545 (defvar org-refile-markers nil
11546 "All the markers used for caching refile locations.")
11548 (defun org-refile-marker (pos)
11549 "Get a new refile marker, but only if caching is in use."
11550 (if (not org-refile-use-cache)
11552 (let ((m (make-marker)))
11553 (move-marker m pos)
11554 (push m org-refile-markers)
11555 m)))
11557 (defun org-refile-cache-clear ()
11558 "Clear the refile cache and disable all the markers."
11559 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11560 (setq org-refile-markers nil)
11561 (setq org-refile-cache nil)
11562 (message "Refile cache has been cleared"))
11564 (defun org-refile-cache-check-set (set)
11565 "Check if all the markers in the cache still have live buffers."
11566 (let (marker)
11567 (catch 'exit
11568 (while (and set (setq marker (nth 3 (pop set))))
11569 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11570 (when (and marker (null (marker-buffer marker)))
11571 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11572 (sit-for 3)
11573 (throw 'exit nil)))
11574 t)))
11576 (defun org-refile-cache-put (set &rest identifiers)
11577 "Push the refile targets SET into the cache, under IDENTIFIERS."
11578 (let* ((key (sha1 (prin1-to-string identifiers)))
11579 (entry (assoc key org-refile-cache)))
11580 (if entry
11581 (setcdr entry set)
11582 (push (cons key set) org-refile-cache))))
11584 (defun org-refile-cache-get (&rest identifiers)
11585 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11586 (cond
11587 ((not org-refile-cache) nil)
11588 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11590 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11591 org-refile-cache))))
11592 (and set (org-refile-cache-check-set set) set)))))
11594 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11595 "Produce a table with refile targets."
11596 (let ((case-fold-search nil)
11597 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11598 (entries (or org-refile-targets '((nil . (:level . 1)))))
11599 targets tgs txt re files desc descre fast-path-p level pos0)
11600 (message "Getting targets...")
11601 (with-current-buffer (or default-buffer (current-buffer))
11602 (dolist (entry entries)
11603 (setq files (car entry) desc (cdr entry))
11604 (setq fast-path-p nil)
11605 (cond
11606 ((null files) (setq files (list (current-buffer))))
11607 ((eq files 'org-agenda-files)
11608 (setq files (org-agenda-files 'unrestricted)))
11609 ((and (symbolp files) (fboundp files))
11610 (setq files (funcall files)))
11611 ((and (symbolp files) (boundp files))
11612 (setq files (symbol-value files))))
11613 (if (stringp files) (setq files (list files)))
11614 (cond
11615 ((eq (car desc) :tag)
11616 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11617 ((eq (car desc) :todo)
11618 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11619 ((eq (car desc) :regexp)
11620 (setq descre (cdr desc)))
11621 ((eq (car desc) :level)
11622 (setq descre (concat "^\\*\\{" (number-to-string
11623 (if org-odd-levels-only
11624 (1- (* 2 (cdr desc)))
11625 (cdr desc)))
11626 "\\}[ \t]")))
11627 ((eq (car desc) :maxlevel)
11628 (setq fast-path-p t)
11629 (setq descre (concat "^\\*\\{1," (number-to-string
11630 (if org-odd-levels-only
11631 (1- (* 2 (cdr desc)))
11632 (cdr desc)))
11633 "\\}[ \t]")))
11634 (t (error "Bad refiling target description %s" desc)))
11635 (dolist (f files)
11636 (with-current-buffer
11637 (if (bufferp f) f (org-get-agenda-file-buffer f))
11639 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11640 (progn
11641 (if (bufferp f) (setq f (buffer-file-name
11642 (buffer-base-buffer f))))
11643 (setq f (and f (expand-file-name f)))
11644 (if (eq org-refile-use-outline-path 'file)
11645 (push (list (file-name-nondirectory f) f nil nil) tgs))
11646 (save-excursion
11647 (save-restriction
11648 (widen)
11649 (goto-char (point-min))
11650 (while (re-search-forward descre nil t)
11651 (goto-char (setq pos0 (point-at-bol)))
11652 (catch 'next
11653 (when org-refile-target-verify-function
11654 (save-match-data
11655 (or (funcall org-refile-target-verify-function)
11656 (throw 'next t))))
11657 (when (and (looking-at org-complex-heading-regexp)
11658 (not (member (match-string 4) excluded-entries))
11659 (match-string 4))
11660 (setq level (org-reduced-level
11661 (- (match-end 1) (match-beginning 1)))
11662 txt (org-link-display-format (match-string 4))
11663 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11664 re (format org-complex-heading-regexp-format
11665 (regexp-quote (match-string 4))))
11666 (when org-refile-use-outline-path
11667 (setq txt (mapconcat
11668 'org-protect-slash
11669 (append
11670 (if (eq org-refile-use-outline-path
11671 'file)
11672 (list (file-name-nondirectory
11673 (buffer-file-name
11674 (buffer-base-buffer))))
11675 (if (eq org-refile-use-outline-path
11676 'full-file-path)
11677 (list (buffer-file-name
11678 (buffer-base-buffer)))))
11679 (org-get-outline-path fast-path-p
11680 level txt)
11681 (list txt))
11682 "/")))
11683 (push (list txt f re (org-refile-marker (point)))
11684 tgs)))
11685 (when (= (point) pos0)
11686 ;; verification function has not moved point
11687 (goto-char (point-at-eol))))))))
11688 (when org-refile-use-cache
11689 (org-refile-cache-put tgs (buffer-file-name) descre))
11690 (setq targets (append tgs targets))))))
11691 (message "Getting targets...done")
11692 (nreverse targets)))
11694 (defun org-protect-slash (s)
11695 (while (string-match "/" s)
11696 (setq s (replace-match "\\" t t s)))
11699 (defvar org-olpa (make-vector 20 nil))
11701 (defun org-get-outline-path (&optional fastp level heading)
11702 "Return the outline path to the current entry, as a list.
11704 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11705 routine which makes outline path derivations for an entire file,
11706 avoiding backtracing. Refile target collection makes use of that."
11707 (if fastp
11708 (progn
11709 (if (> level 19)
11710 (error "Outline path failure, more than 19 levels"))
11711 (loop for i from level upto 19 do
11712 (aset org-olpa i nil))
11713 (prog1
11714 (delq nil (append org-olpa nil))
11715 (aset org-olpa level heading)))
11716 (let (rtn case-fold-search)
11717 (save-excursion
11718 (save-restriction
11719 (widen)
11720 (while (org-up-heading-safe)
11721 (when (looking-at org-complex-heading-regexp)
11722 (push (org-trim
11723 (replace-regexp-in-string
11724 ;; Remove statistical/checkboxes cookies
11725 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11726 (org-match-string-no-properties 4)))
11727 rtn)))
11728 rtn)))))
11730 (defun org-format-outline-path (path &optional width prefix separator)
11731 "Format the outline path PATH for display.
11732 WIDTH is the maximum number of characters that is available.
11733 PREFIX is a prefix to be included in the returned string,
11734 such as the file name.
11735 SEPARATOR is inserted between the different parts of the path,
11736 the default is \"/\"."
11737 (setq width (or width 79))
11738 (if prefix (setq width (- width (length prefix))))
11739 (if (not path)
11740 (or prefix "")
11741 (let* ((nsteps (length path))
11742 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11743 (maxwidth (if (<= total-width width)
11744 10000 ;; everything fits
11745 ;; we need to shorten the level headings
11746 (/ (- width nsteps) nsteps)))
11747 (org-odd-levels-only nil)
11748 (n 0)
11749 (total (1+ (length prefix))))
11750 (setq maxwidth (max maxwidth 10))
11751 (concat prefix
11752 (if prefix (or separator "/"))
11753 (mapconcat
11754 (lambda (h)
11755 (setq n (1+ n))
11756 (if (and (= n nsteps) (< maxwidth 10000))
11757 (setq maxwidth (- total-width total)))
11758 (if (< (length h) maxwidth)
11759 (progn (setq total (+ total (length h) 1)) h)
11760 (setq h (substring h 0 (- maxwidth 2))
11761 total (+ total maxwidth 1))
11762 (if (string-match "[ \t]+\\'" h)
11763 (setq h (substring h 0 (match-beginning 0))))
11764 (setq h (concat h "..")))
11765 (org-add-props h nil 'face
11766 (nth (% (1- n) org-n-level-faces)
11767 org-level-faces))
11769 path (or separator "/"))))))
11771 (defun org-display-outline-path (&optional file current separator just-return-string)
11772 "Display the current outline path in the echo area.
11774 If FILE is non-nil, prepend the output with the file name.
11775 If CURRENT is non-nil, append the current heading to the output.
11776 SEPARATOR is passed through to `org-format-outline-path'. It separates
11777 the different parts of the path and defaults to \"/\".
11778 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11779 (interactive "P")
11780 (let* (case-fold-search
11781 (bfn (buffer-file-name (buffer-base-buffer)))
11782 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11783 res)
11784 (if current (setq path (append path
11785 (save-excursion
11786 (org-back-to-heading t)
11787 (if (looking-at org-complex-heading-regexp)
11788 (list (match-string 4)))))))
11789 (setq res
11790 (org-format-outline-path
11791 path
11792 (1- (frame-width))
11793 (and file bfn (concat (file-name-nondirectory bfn) separator))
11794 separator))
11795 (if just-return-string
11796 (org-no-properties res)
11797 (org-unlogged-message "%s" res))))
11799 (defvar org-refile-history nil
11800 "History for refiling operations.")
11802 (defvar org-after-refile-insert-hook nil
11803 "Hook run after `org-refile' has inserted its stuff at the new location.
11804 Note that this is still *before* the stuff will be removed from
11805 the *old* location.")
11807 (defvar org-capture-last-stored-marker)
11808 (defvar org-refile-keep nil
11809 "Non-nil means `org-refile' will copy instead of refile.")
11811 (defun org-copy ()
11812 "Like `org-refile', but copy."
11813 (interactive)
11814 (let ((org-refile-keep t))
11815 (funcall 'org-refile nil nil nil "Copy")))
11817 (defun org-refile (&optional arg default-buffer rfloc msg)
11818 "Move the entry or entries at point to another heading.
11819 The list of target headings is compiled using the information in
11820 `org-refile-targets', which see.
11822 At the target location, the entry is filed as a subitem of the
11823 target heading. Depending on `org-reverse-note-order', the new
11824 subitem will either be the first or the last subitem.
11826 If there is an active region, all entries in that region will be
11827 refiled. However, the region must fulfill the requirement that
11828 the first heading sets the top-level of the moved text.
11830 With prefix arg ARG, the command will only visit the target
11831 location and not actually move anything.
11833 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11834 refiling operation has put the subtree.
11836 With a numeric prefix argument of `2', refile to the running clock.
11838 With a numeric prefix argument of `3', emulate `org-refile-keep'
11839 being set to t and copy to the target location, don't move it.
11840 Beware that keeping refiled entries may result in duplicated ID
11841 properties.
11843 RFLOC can be a refile location obtained in a different way.
11845 MSG is a string to replace \"Refile\" in the default prompt with
11846 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11848 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11850 If you are using target caching (see `org-refile-use-cache'), you
11851 have to clear the target cache in order to find new targets.
11852 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11853 prefix argument (`C-u C-u C-u C-c C-w')."
11854 (interactive "P")
11855 (if (member arg '(0 (64)))
11856 (org-refile-cache-clear)
11857 (let* ((actionmsg (cond (msg msg)
11858 ((equal arg 3) "Refile (and keep)")
11859 (t "Refile")))
11860 (cbuf (current-buffer))
11861 (regionp (org-region-active-p))
11862 (region-start (and regionp (region-beginning)))
11863 (region-end (and regionp (region-end)))
11864 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11865 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11866 pos it nbuf file re level reversed)
11867 (setq last-command nil)
11868 (when regionp
11869 (goto-char region-start)
11870 (or (bolp) (goto-char (point-at-bol)))
11871 (setq region-start (point))
11872 (unless (or (org-kill-is-subtree-p
11873 (buffer-substring region-start region-end))
11874 (prog1 org-refile-active-region-within-subtree
11875 (let ((s (point-at-eol)))
11876 (org-toggle-heading)
11877 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11878 (user-error "The region is not a (sequence of) subtree(s)")))
11879 (if (equal arg '(16))
11880 (org-refile-goto-last-stored)
11881 (when (or
11882 (and (equal arg 2)
11883 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11884 (prog1
11885 (setq it (list (or org-clock-heading "running clock")
11886 (buffer-file-name
11887 (marker-buffer org-clock-hd-marker))
11889 (marker-position org-clock-hd-marker)))
11890 (setq arg nil)))
11891 (setq it (or rfloc
11892 (let (heading-text)
11893 (save-excursion
11894 (unless (and arg (listp arg))
11895 (org-back-to-heading t)
11896 (setq heading-text
11897 (replace-regexp-in-string
11898 org-bracket-link-regexp
11899 "\\3"
11900 (nth 4 (org-heading-components)))))
11901 (org-refile-get-location
11902 (cond ((and arg (listp arg)) "Goto")
11903 (regionp (concat actionmsg " region to"))
11904 (t (concat actionmsg " subtree \""
11905 heading-text "\" to")))
11906 default-buffer
11907 (and (not (equal '(4) arg))
11908 org-refile-allow-creating-parent-nodes)
11909 arg))))))
11910 (setq file (nth 1 it)
11911 re (nth 2 it)
11912 pos (nth 3 it))
11913 (if (and (not arg)
11915 (equal (buffer-file-name) file)
11916 (if regionp
11917 (and (>= pos region-start)
11918 (<= pos region-end))
11919 (and (>= pos (point))
11920 (< pos (save-excursion
11921 (org-end-of-subtree t t))))))
11922 (error "Cannot refile to position inside the tree or region"))
11923 (setq nbuf (or (find-buffer-visiting file)
11924 (find-file-noselect file)))
11925 (if (and arg (not (equal arg 3)))
11926 (progn
11927 (org-pop-to-buffer-same-window nbuf)
11928 (goto-char pos)
11929 (org-show-context 'org-goto))
11930 (if regionp
11931 (progn
11932 (org-kill-new (buffer-substring region-start region-end))
11933 (org-save-markers-in-region region-start region-end))
11934 (org-copy-subtree 1 nil t))
11935 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11936 (find-file-noselect file)))
11937 (setq reversed (org-notes-order-reversed-p))
11938 (save-excursion
11939 (save-restriction
11940 (widen)
11941 (if pos
11942 (progn
11943 (goto-char pos)
11944 (looking-at org-outline-regexp)
11945 (setq level (org-get-valid-level (funcall outline-level) 1))
11946 (goto-char
11947 (if reversed
11948 (or (outline-next-heading) (point-max))
11949 (or (save-excursion (org-get-next-sibling))
11950 (org-end-of-subtree t t)
11951 (point-max)))))
11952 (setq level 1)
11953 (if (not reversed)
11954 (goto-char (point-max))
11955 (goto-char (point-min))
11956 (or (outline-next-heading) (goto-char (point-max)))))
11957 (if (not (bolp)) (newline))
11958 (org-paste-subtree level nil nil t)
11959 (when org-log-refile
11960 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11961 (unless (eq org-log-refile 'note)
11962 (save-excursion (org-add-log-note))))
11963 (and org-auto-align-tags
11964 (let ((org-loop-over-headlines-in-active-region nil))
11965 (org-set-tags nil t)))
11966 (let ((bookmark-name (plist-get org-bookmark-names-plist
11967 :last-refile)))
11968 (when bookmark-name
11969 (with-demoted-errors
11970 (bookmark-set bookmark-name))))
11971 ;; If we are refiling for capture, make sure that the
11972 ;; last-capture pointers point here
11973 (when (org-bound-and-true-p org-refile-for-capture)
11974 (let ((bookmark-name (plist-get org-bookmark-names-plist
11975 :last-capture-marker)))
11976 (when bookmark-name
11977 (with-demoted-errors
11978 (bookmark-set bookmark-name))))
11979 (move-marker org-capture-last-stored-marker (point)))
11980 (if (fboundp 'deactivate-mark) (deactivate-mark))
11981 (run-hooks 'org-after-refile-insert-hook))))
11982 (unless org-refile-keep
11983 (if regionp
11984 (delete-region (point) (+ (point) (- region-end region-start)))
11985 (delete-region
11986 (and (org-back-to-heading t) (point))
11987 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11988 (when (featurep 'org-inlinetask)
11989 (org-inlinetask-remove-END-maybe))
11990 (setq org-markers-to-move nil)
11991 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11993 (defun org-refile-goto-last-stored ()
11994 "Go to the location where the last refile was stored."
11995 (interactive)
11996 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11997 (message "This is the location of the last refile"))
11999 (defun org-refile--get-location (refloc tbl)
12000 "When user refile to REFLOC, find the associated target in TBL.
12001 Also check `org-refile-target-table'."
12002 (car (delq
12004 (mapcar
12005 (lambda (r) (or (assoc r tbl)
12006 (assoc r org-refile-target-table)))
12007 (list (replace-regexp-in-string "/$" "" refloc)
12008 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12010 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12011 no-exclude)
12012 "Prompt the user for a refile location, using PROMPT.
12013 PROMPT should not be suffixed with a colon and a space, because
12014 this function appends the default value from
12015 `org-refile-history' automatically, if that is not empty.
12016 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12017 this is used for the GOTO interface."
12018 (let ((org-refile-targets org-refile-targets)
12019 (org-refile-use-outline-path org-refile-use-outline-path)
12020 excluded-entries)
12021 (when (and (derived-mode-p 'org-mode)
12022 (not org-refile-use-cache)
12023 (not no-exclude))
12024 (org-map-tree
12025 (lambda()
12026 (setq excluded-entries
12027 (append excluded-entries (list (org-get-heading t t)))))))
12028 (setq org-refile-target-table
12029 (org-refile-get-targets default-buffer excluded-entries)))
12030 (unless org-refile-target-table
12031 (user-error "No refile targets"))
12032 (let* ((cbuf (current-buffer))
12033 (partial-completion-mode nil)
12034 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12035 (cfunc (if (and org-refile-use-outline-path
12036 org-outline-path-complete-in-steps)
12037 'org-olpath-completing-read
12038 'org-icompleting-read))
12039 (extra (if org-refile-use-outline-path "/" ""))
12040 (cbnex (concat (buffer-name) extra))
12041 (filename (and cfn (expand-file-name cfn)))
12042 (tbl (mapcar
12043 (lambda (x)
12044 (if (and (not (member org-refile-use-outline-path
12045 '(file full-file-path)))
12046 (not (equal filename (nth 1 x))))
12047 (cons (concat (car x) extra " ("
12048 (file-name-nondirectory (nth 1 x)) ")")
12049 (cdr x))
12050 (cons (concat (car x) extra) (cdr x))))
12051 org-refile-target-table))
12052 (completion-ignore-case t)
12053 cdef
12054 (prompt (concat prompt
12055 (or (and (car org-refile-history)
12056 (concat " (default " (car org-refile-history) ")"))
12057 (and (assoc cbnex tbl) (setq cdef cbnex)
12058 (concat " (default " cbnex ")"))) ": "))
12059 pa answ parent-target child parent old-hist)
12060 (setq old-hist org-refile-history)
12061 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12062 nil 'org-refile-history (or cdef (car org-refile-history))))
12063 (if (setq pa (org-refile--get-location answ tbl))
12064 (progn
12065 (org-refile-check-position pa)
12066 (when (or (not org-refile-history)
12067 (not (eq old-hist org-refile-history))
12068 (not (equal (car pa) (car org-refile-history))))
12069 (setq org-refile-history
12070 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12071 org-refile-history
12072 (cdr org-refile-history))))
12073 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12074 (pop org-refile-history)))
12076 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12077 (progn
12078 (setq parent (match-string 1 answ)
12079 child (match-string 2 answ))
12080 (setq parent-target (org-refile--get-location parent tbl))
12081 (when (and parent-target
12082 (or (eq new-nodes t)
12083 (and (eq new-nodes 'confirm)
12084 (y-or-n-p (format "Create new node \"%s\"? "
12085 child)))))
12086 (org-refile-new-child parent-target child)))
12087 (user-error "Invalid target location")))))
12089 (declare-function org-string-nw-p "org-macs" (s))
12090 (defun org-refile-check-position (refile-pointer)
12091 "Check if the refile pointer matches the headline to which it points."
12092 (let* ((file (nth 1 refile-pointer))
12093 (re (nth 2 refile-pointer))
12094 (pos (nth 3 refile-pointer))
12095 buffer)
12096 (if (and (not (markerp pos)) (not file))
12097 (user-error "Please indicate a target file in the refile path")
12098 (when (org-string-nw-p re)
12099 (setq buffer (if (markerp pos)
12100 (marker-buffer pos)
12101 (or (find-buffer-visiting file)
12102 (find-file-noselect file))))
12103 (with-current-buffer buffer
12104 (save-excursion
12105 (save-restriction
12106 (widen)
12107 (goto-char pos)
12108 (beginning-of-line 1)
12109 (unless (org-looking-at-p re)
12110 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12112 (defun org-refile-new-child (parent-target child)
12113 "Use refile target PARENT-TARGET to add new CHILD below it."
12114 (unless parent-target
12115 (error "Cannot find parent for new node"))
12116 (let ((file (nth 1 parent-target))
12117 (pos (nth 3 parent-target))
12118 level)
12119 (with-current-buffer (or (find-buffer-visiting file)
12120 (find-file-noselect file))
12121 (save-excursion
12122 (save-restriction
12123 (widen)
12124 (if pos
12125 (goto-char pos)
12126 (goto-char (point-max))
12127 (if (not (bolp)) (newline)))
12128 (when (looking-at org-outline-regexp)
12129 (setq level (funcall outline-level))
12130 (org-end-of-subtree t t))
12131 (org-back-over-empty-lines)
12132 (insert "\n" (make-string
12133 (if pos (org-get-valid-level level 1) 1) ?*)
12134 " " child "\n")
12135 (beginning-of-line 0)
12136 (list (concat (car parent-target) "/" child) file "" (point)))))))
12138 (defun org-olpath-completing-read (prompt collection &rest args)
12139 "Read an outline path like a file name."
12140 (let ((thetable collection)
12141 (org-completion-use-ido nil) ; does not work with ido.
12142 (org-completion-use-iswitchb nil)) ; or iswitchb
12143 (apply #'org-icompleting-read
12144 prompt
12145 (lambda (string predicate &optional flag)
12146 (cond
12147 ((eq flag nil) (try-completion string thetable))
12148 ((eq flag t)
12149 (let ((l (length string)))
12150 (mapcar (lambda (x)
12151 (let ((r (substring x l))
12152 (f (if (string-match " ([^)]*)$" x)
12153 (match-string 0 x)
12154 "")))
12155 (if (string-match "/" r)
12156 (concat string (substring r 0 (match-end 0)) f)
12157 x)))
12158 (all-completions string thetable predicate))))
12159 ;; Exact match?
12160 ((eq flag 'lambda) (assoc string thetable))))
12161 args)))
12163 ;;;; Dynamic blocks
12165 (defun org-find-dblock (name)
12166 "Find the first dynamic block with name NAME in the buffer.
12167 If not found, stay at current position and return nil."
12168 (let ((case-fold-search t) pos)
12169 (save-excursion
12170 (goto-char (point-min))
12171 (setq pos (and (re-search-forward
12172 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12173 (match-beginning 0))))
12174 (if pos (goto-char pos))
12175 pos))
12177 (defun org-create-dblock (plist)
12178 "Create a dynamic block section, with parameters taken from PLIST.
12179 PLIST must contain a :name entry which is used as the name of the block."
12180 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12181 (end-of-line 1)
12182 (newline))
12183 (let ((col (current-column))
12184 (name (plist-get plist :name)))
12185 (insert "#+BEGIN: " name)
12186 (while plist
12187 (if (eq (car plist) :name)
12188 (setq plist (cddr plist))
12189 (insert " " (prin1-to-string (pop plist)))))
12190 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12191 (beginning-of-line -2)))
12193 (defun org-prepare-dblock ()
12194 "Prepare dynamic block for refresh.
12195 This empties the block, puts the cursor at the insert position and returns
12196 the property list including an extra property :name with the block name."
12197 (unless (looking-at org-dblock-start-re)
12198 (user-error "Not at a dynamic block"))
12199 (let* ((begdel (1+ (match-end 0)))
12200 (name (org-no-properties (match-string 1)))
12201 (params (append (list :name name)
12202 (read (concat "(" (match-string 3) ")")))))
12203 (save-excursion
12204 (beginning-of-line 1)
12205 (skip-chars-forward " \t")
12206 (setq params (plist-put params :indentation-column (current-column))))
12207 (unless (re-search-forward org-dblock-end-re nil t)
12208 (error "Dynamic block not terminated"))
12209 (setq params
12210 (append params
12211 (list :content (buffer-substring
12212 begdel (match-beginning 0)))))
12213 (delete-region begdel (match-beginning 0))
12214 (goto-char begdel)
12215 (open-line 1)
12216 params))
12218 (defun org-map-dblocks (&optional command)
12219 "Apply COMMAND to all dynamic blocks in the current buffer.
12220 If COMMAND is not given, use `org-update-dblock'."
12221 (let ((cmd (or command 'org-update-dblock)))
12222 (save-excursion
12223 (goto-char (point-min))
12224 (while (re-search-forward org-dblock-start-re nil t)
12225 (goto-char (match-beginning 0))
12226 (save-excursion
12227 (condition-case nil
12228 (funcall cmd)
12229 (error (message "Error during update of dynamic block"))))
12230 (unless (re-search-forward org-dblock-end-re nil t)
12231 (error "Dynamic block not terminated"))))))
12233 (defun org-dblock-update (&optional arg)
12234 "User command for updating dynamic blocks.
12235 Update the dynamic block at point. With prefix ARG, update all dynamic
12236 blocks in the buffer."
12237 (interactive "P")
12238 (if arg
12239 (org-update-all-dblocks)
12240 (or (looking-at org-dblock-start-re)
12241 (org-beginning-of-dblock))
12242 (org-update-dblock)))
12244 (defun org-update-dblock ()
12245 "Update the dynamic block at point.
12246 This means to empty the block, parse for parameters and then call
12247 the correct writing function."
12248 (interactive)
12249 (save-excursion
12250 (let* ((win (selected-window))
12251 (pos (point))
12252 (line (org-current-line))
12253 (params (org-prepare-dblock))
12254 (name (plist-get params :name))
12255 (indent (plist-get params :indentation-column))
12256 (cmd (intern (concat "org-dblock-write:" name))))
12257 (message "Updating dynamic block `%s' at line %d..." name line)
12258 (funcall cmd params)
12259 (message "Updating dynamic block `%s' at line %d...done" name line)
12260 (goto-char pos)
12261 (when (and indent (> indent 0))
12262 (setq indent (make-string indent ?\ ))
12263 (save-excursion
12264 (select-window win)
12265 (org-beginning-of-dblock)
12266 (forward-line 1)
12267 (while (not (looking-at org-dblock-end-re))
12268 (insert indent)
12269 (beginning-of-line 2))
12270 (when (looking-at org-dblock-end-re)
12271 (and (looking-at "[ \t]+")
12272 (replace-match ""))
12273 (insert indent)))))))
12275 (defun org-beginning-of-dblock ()
12276 "Find the beginning of the dynamic block at point.
12277 Error if there is no such block at point."
12278 (let ((pos (point))
12279 beg)
12280 (end-of-line 1)
12281 (if (and (re-search-backward org-dblock-start-re nil t)
12282 (setq beg (match-beginning 0))
12283 (re-search-forward org-dblock-end-re nil t)
12284 (> (match-end 0) pos))
12285 (goto-char beg)
12286 (goto-char pos)
12287 (error "Not in a dynamic block"))))
12289 (defun org-update-all-dblocks ()
12290 "Update all dynamic blocks in the buffer.
12291 This function can be used in a hook."
12292 (interactive)
12293 (when (derived-mode-p 'org-mode)
12294 (org-map-dblocks 'org-update-dblock)))
12297 ;;;; Completion
12299 (declare-function org-export-backend-name "org-export" (cl-x))
12300 (declare-function org-export-backend-options "org-export" (cl-x))
12301 (defun org-get-export-keywords ()
12302 "Return a list of all currently understood export keywords.
12303 Export keywords include options, block names, attributes and
12304 keywords relative to each registered export back-end."
12305 (let (keywords)
12306 (dolist (backend
12307 (org-bound-and-true-p org-export-registered-backends)
12308 (delq nil keywords))
12309 ;; Back-end name (for keywords, like #+LATEX:)
12310 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12311 (dolist (option-entry (org-export-backend-options backend))
12312 ;; Back-end options.
12313 (push (nth 1 option-entry) keywords)))))
12315 (defconst org-options-keywords
12316 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12317 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12318 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12319 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12320 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12322 (defcustom org-structure-template-alist
12323 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12324 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12325 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12326 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12327 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12328 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12329 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12330 ("L" "#+LaTeX: ")
12331 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12332 ("H" "#+HTML: ")
12333 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12334 ("A" "#+ASCII: ")
12335 ("i" "#+INDEX: ?")
12336 ("I" "#+INCLUDE: %file ?"))
12337 "Structure completion elements.
12338 This is a list of abbreviation keys and values. The value gets inserted
12339 if you type `<' followed by the key and then press the completion key,
12340 usually `TAB'. %file will be replaced by a file name after prompting
12341 for the file using completion. The cursor will be placed at the position
12342 of the `?' in the template.
12343 There are two templates for each key, the first uses the original Org syntax,
12344 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12345 the default when the /org-mtags.el/ module has been loaded. See also the
12346 variable `org-mtags-prefer-muse-templates'."
12347 :group 'org-completion
12348 :type '(repeat
12349 (list
12350 (string :tag "Key")
12351 (string :tag "Template")))
12352 :version "25.1"
12353 :package-version '(Org . "8.3"))
12355 (defun org-try-structure-completion ()
12356 "Try to complete a structure template before point.
12357 This looks for strings like \"<e\" on an otherwise empty line and
12358 expands them."
12359 (let ((l (buffer-substring (point-at-bol) (point)))
12361 (when (and (looking-at "[ \t]*$")
12362 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12363 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12364 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12365 (match-beginning 1)) a)
12366 t)))
12368 (defun org-complete-expand-structure-template (start cell)
12369 "Expand a structure template."
12370 (let ((rpl (nth 1 cell))
12371 (ind ""))
12372 (delete-region start (point))
12373 (when (string-match "\\`[ \t]*#\\+" rpl)
12374 (cond
12375 ((bolp))
12376 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12377 (setq ind (buffer-substring (point-at-bol) (point))))
12378 (t (newline))))
12379 (setq start (point))
12380 (if (string-match "%file" rpl)
12381 (setq rpl (replace-match
12382 (concat
12383 "\""
12384 (save-match-data
12385 (abbreviate-file-name (read-file-name "Include file: ")))
12386 "\"")
12387 t t rpl)))
12388 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12389 (concat "\n" ind)))
12390 (insert rpl)
12391 (if (re-search-backward "\\?" start t) (delete-char 1))))
12393 ;;;; TODO, DEADLINE, Comments
12395 (defun org-toggle-comment ()
12396 "Change the COMMENT state of an entry."
12397 (interactive)
12398 (save-excursion
12399 (org-back-to-heading)
12400 (looking-at org-complex-heading-regexp)
12401 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12402 (skip-chars-forward " \t")
12403 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12404 (if (org-in-commented-heading-p t)
12405 (delete-region (point)
12406 (progn (search-forward " " (line-end-position) 'move)
12407 (skip-chars-forward " \t")
12408 (point)))
12409 (insert org-comment-string)
12410 (unless (eolp) (insert " ")))))
12412 (defvar org-last-todo-state-is-todo nil
12413 "This is non-nil when the last TODO state change led to a TODO state.
12414 If the last change removed the TODO tag or switched to DONE, then
12415 this is nil.")
12417 (defvar org-setting-tags nil) ; dynamically skipped
12419 (defvar org-todo-setup-filter-hook nil
12420 "Hook for functions that pre-filter todo specs.
12421 Each function takes a todo spec and returns either nil or the spec
12422 transformed into canonical form." )
12424 (defvar org-todo-get-default-hook nil
12425 "Hook for functions that get a default item for todo.
12426 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12427 nil or a string to be used for the todo mark." )
12429 (defvar org-agenda-headline-snapshot-before-repeat)
12431 (defun org-current-effective-time ()
12432 "Return current time adjusted for `org-extend-today-until' variable."
12433 (let* ((ct (org-current-time))
12434 (dct (decode-time ct))
12435 (ct1
12436 (cond
12437 (org-use-last-clock-out-time-as-effective-time
12438 (or (org-clock-get-last-clock-out-time) ct))
12439 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12440 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12441 (t ct))))
12442 ct1))
12444 (defun org-todo-yesterday (&optional arg)
12445 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12446 (interactive "P")
12447 (if (eq major-mode 'org-agenda-mode)
12448 (apply 'org-agenda-todo-yesterday arg)
12449 (let* ((org-use-effective-time t)
12450 (hour (third (decode-time
12451 (org-current-time))))
12452 (org-extend-today-until (1+ hour)))
12453 (org-todo arg))))
12455 (defvar org-block-entry-blocking ""
12456 "First entry preventing the TODO state change.")
12458 (defun org-cancel-repeater ()
12459 "Cancel a repeater by setting its numeric value to zero."
12460 (interactive)
12461 (save-excursion
12462 (org-back-to-heading t)
12463 (let ((bound1 (point))
12464 (bound0 (save-excursion (outline-next-heading) (point))))
12465 (when (re-search-forward
12466 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12467 org-deadline-time-regexp "\\)\\|\\("
12468 org-ts-regexp "\\)")
12469 bound0 t)
12470 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12471 (replace-match "0" t nil nil 1))))))
12473 (defun org-todo (&optional arg)
12474 "Change the TODO state of an item.
12475 The state of an item is given by a keyword at the start of the heading,
12476 like
12477 *** TODO Write paper
12478 *** DONE Call mom
12480 The different keywords are specified in the variable `org-todo-keywords'.
12481 By default the available states are \"TODO\" and \"DONE\".
12482 So for this example: when the item starts with TODO, it is changed to DONE.
12483 When it starts with DONE, the DONE is removed. And when neither TODO nor
12484 DONE are present, add TODO at the beginning of the heading.
12486 With \\[universal-argument] prefix arg, use completion to determine the new \
12487 state.
12488 With numeric prefix arg, switch to that state.
12489 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12490 keywords (nextset).
12491 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12492 With a numeric prefix arg of 0, inhibit note taking for the change.
12493 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12495 When called through ELisp, arg is also interpreted in the following way:
12496 'none -> empty state
12497 \"\"(empty string) -> switch to empty state
12498 'done -> switch to DONE
12499 'nextset -> switch to the next set of keywords
12500 'previousset -> switch to the previous set of keywords
12501 \"WAITING\" -> switch to the specified keyword, but only if it
12502 really is a member of `org-todo-keywords'."
12503 (interactive "P")
12504 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12505 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12506 'region-start-level 'region))
12507 org-loop-over-headlines-in-active-region)
12508 (org-map-entries
12509 `(org-todo ,arg)
12510 org-loop-over-headlines-in-active-region
12511 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12512 (if (equal arg '(16)) (setq arg 'nextset))
12513 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12514 (let ((org-blocker-hook org-blocker-hook)
12515 commentp
12516 case-fold-search)
12517 (when (equal arg '(64))
12518 (setq arg nil org-blocker-hook nil))
12519 (when (and org-blocker-hook
12520 (or org-inhibit-blocking
12521 (org-entry-get nil "NOBLOCKING")))
12522 (setq org-blocker-hook nil))
12523 (save-excursion
12524 (catch 'exit
12525 (org-back-to-heading t)
12526 (when (org-in-commented-heading-p t)
12527 (org-toggle-comment)
12528 (setq commentp t))
12529 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12530 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12531 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12532 (let* ((match-data (match-data))
12533 (startpos (point-at-bol))
12534 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12535 (org-log-done org-log-done)
12536 (org-log-repeat org-log-repeat)
12537 (org-todo-log-states org-todo-log-states)
12538 (org-inhibit-logging
12539 (if (equal arg 0)
12540 (progn (setq arg nil) 'note) org-inhibit-logging))
12541 (this (match-string 1))
12542 (hl-pos (match-beginning 0))
12543 (head (org-get-todo-sequence-head this))
12544 (ass (assoc head org-todo-kwd-alist))
12545 (interpret (nth 1 ass))
12546 (done-word (nth 3 ass))
12547 (final-done-word (nth 4 ass))
12548 (org-last-state (or this ""))
12549 (completion-ignore-case t)
12550 (member (member this org-todo-keywords-1))
12551 (tail (cdr member))
12552 (org-state (cond
12553 ((and org-todo-key-trigger
12554 (or (and (equal arg '(4))
12555 (eq org-use-fast-todo-selection 'prefix))
12556 (and (not arg) org-use-fast-todo-selection
12557 (not (eq org-use-fast-todo-selection
12558 'prefix)))))
12559 ;; Use fast selection
12560 (org-fast-todo-selection))
12561 ((and (equal arg '(4))
12562 (or (not org-use-fast-todo-selection)
12563 (not org-todo-key-trigger)))
12564 ;; Read a state with completion
12565 (org-icompleting-read
12566 "State: " (mapcar 'list org-todo-keywords-1)
12567 nil t))
12568 ((eq arg 'right)
12569 (if this
12570 (if tail (car tail) nil)
12571 (car org-todo-keywords-1)))
12572 ((eq arg 'left)
12573 (if (equal member org-todo-keywords-1)
12575 (if this
12576 (nth (- (length org-todo-keywords-1)
12577 (length tail) 2)
12578 org-todo-keywords-1)
12579 (org-last org-todo-keywords-1))))
12580 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12581 (setq arg nil))) ; hack to fall back to cycling
12582 (arg
12583 ;; user or caller requests a specific state
12584 (cond
12585 ((equal arg "") nil)
12586 ((eq arg 'none) nil)
12587 ((eq arg 'done) (or done-word (car org-done-keywords)))
12588 ((eq arg 'nextset)
12589 (or (car (cdr (member head org-todo-heads)))
12590 (car org-todo-heads)))
12591 ((eq arg 'previousset)
12592 (let ((org-todo-heads (reverse org-todo-heads)))
12593 (or (car (cdr (member head org-todo-heads)))
12594 (car org-todo-heads))))
12595 ((car (member arg org-todo-keywords-1)))
12596 ((stringp arg)
12597 (user-error "State `%s' not valid in this file" arg))
12598 ((nth (1- (prefix-numeric-value arg))
12599 org-todo-keywords-1))))
12600 ((null member) (or head (car org-todo-keywords-1)))
12601 ((equal this final-done-word) nil) ;; -> make empty
12602 ((null tail) nil) ;; -> first entry
12603 ((memq interpret '(type priority))
12604 (if (eq this-command last-command)
12605 (car tail)
12606 (if (> (length tail) 0)
12607 (or done-word (car org-done-keywords))
12608 nil)))
12610 (car tail))))
12611 (org-state (or
12612 (run-hook-with-args-until-success
12613 'org-todo-get-default-hook org-state org-last-state)
12614 org-state))
12615 (next (if org-state (concat " " org-state " ") " "))
12616 (change-plist (list :type 'todo-state-change :from this :to org-state
12617 :position startpos))
12618 dolog now-done-p)
12619 (when org-blocker-hook
12620 (setq org-last-todo-state-is-todo
12621 (not (member this org-done-keywords)))
12622 (unless (save-excursion
12623 (save-match-data
12624 (org-with-wide-buffer
12625 (run-hook-with-args-until-failure
12626 'org-blocker-hook change-plist))))
12627 (if (org-called-interactively-p 'interactive)
12628 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12629 this org-state org-block-entry-blocking)
12630 ;; fail silently
12631 (message "TODO state change from %s to %s blocked (by \"%s\")"
12632 this org-state org-block-entry-blocking)
12633 (throw 'exit nil))))
12634 (store-match-data match-data)
12635 (replace-match next t t)
12636 (cond ((equal this org-state)
12637 (message "TODO state was already %s" (org-trim next)))
12638 ((pos-visible-in-window-p hl-pos)
12639 (message "TODO state changed to %s" (org-trim next))))
12640 (unless head
12641 (setq head (org-get-todo-sequence-head org-state)
12642 ass (assoc head org-todo-kwd-alist)
12643 interpret (nth 1 ass)
12644 done-word (nth 3 ass)
12645 final-done-word (nth 4 ass)))
12646 (when (memq arg '(nextset previousset))
12647 (message "Keyword-Set %d/%d: %s"
12648 (- (length org-todo-sets) -1
12649 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12650 (length org-todo-sets)
12651 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12652 (setq org-last-todo-state-is-todo
12653 (not (member org-state org-done-keywords)))
12654 (setq now-done-p (and (member org-state org-done-keywords)
12655 (not (member this org-done-keywords))))
12656 (and logging (org-local-logging logging))
12657 (when (and (or org-todo-log-states org-log-done)
12658 (not (eq org-inhibit-logging t))
12659 (not (memq arg '(nextset previousset))))
12660 ;; we need to look at recording a time and note
12661 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12662 (nth 2 (assoc this org-todo-log-states))))
12663 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12664 (setq dolog 'time))
12665 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12666 (and org-state
12667 (member org-state org-not-done-keywords)
12668 (not (member this org-not-done-keywords))))
12669 ;; This is now a todo state and was not one before
12670 ;; If there was a CLOSED time stamp, get rid of it.
12671 (org-add-planning-info nil nil 'closed))
12672 (when (and now-done-p org-log-done)
12673 ;; It is now done, and it was not done before
12674 (org-add-planning-info 'closed (org-current-effective-time))
12675 (if (and (not dolog) (eq 'note org-log-done))
12676 (org-add-log-setup 'done org-state this 'findpos 'note)))
12677 (when (and org-state dolog)
12678 ;; This is a non-nil state, and we need to log it
12679 (org-add-log-setup 'state org-state this 'findpos dolog)))
12680 ;; Fixup tag positioning
12681 (org-todo-trigger-tag-changes org-state)
12682 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12683 (when org-provide-todo-statistics
12684 (org-update-parent-todo-statistics))
12685 (run-hooks 'org-after-todo-state-change-hook)
12686 (if (and arg (not (member org-state org-done-keywords)))
12687 (setq head (org-get-todo-sequence-head org-state)))
12688 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12689 ;; Do we need to trigger a repeat?
12690 (when now-done-p
12691 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12692 ;; This is for the agenda, take a snapshot of the headline.
12693 (save-match-data
12694 (setq org-agenda-headline-snapshot-before-repeat
12695 (org-get-heading))))
12696 (org-auto-repeat-maybe org-state))
12697 ;; Fixup cursor location if close to the keyword
12698 (if (and (outline-on-heading-p)
12699 (not (bolp))
12700 (save-excursion (beginning-of-line 1)
12701 (looking-at org-todo-line-regexp))
12702 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12703 (progn
12704 (goto-char (or (match-end 2) (match-end 1)))
12705 (and (looking-at " ") (just-one-space))))
12706 (when org-trigger-hook
12707 (save-excursion
12708 (run-hook-with-args 'org-trigger-hook change-plist)))
12709 (when commentp (org-toggle-comment))))))))
12711 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12712 "Block turning an entry into a TODO, using the hierarchy.
12713 This checks whether the current task should be blocked from state
12714 changes. Such blocking occurs when:
12716 1. The task has children which are not all in a completed state.
12718 2. A task has a parent with the property :ORDERED:, and there
12719 are siblings prior to the current task with incomplete
12720 status.
12722 3. The parent of the task is blocked because it has siblings that should
12723 be done first, or is child of a block grandparent TODO entry."
12725 (if (not org-enforce-todo-dependencies)
12726 t ; if locally turned off don't block
12727 (catch 'dont-block
12728 ;; If this is not a todo state change, or if this entry is already DONE,
12729 ;; do not block
12730 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12731 (member (plist-get change-plist :from)
12732 (cons 'done org-done-keywords))
12733 (member (plist-get change-plist :to)
12734 (cons 'todo org-not-done-keywords))
12735 (not (plist-get change-plist :to)))
12736 (throw 'dont-block t))
12737 ;; If this task has children, and any are undone, it's blocked
12738 (save-excursion
12739 (org-back-to-heading t)
12740 (let ((this-level (funcall outline-level)))
12741 (outline-next-heading)
12742 (let ((child-level (funcall outline-level)))
12743 (while (and (not (eobp))
12744 (> child-level this-level))
12745 ;; this todo has children, check whether they are all
12746 ;; completed
12747 (if (and (not (org-entry-is-done-p))
12748 (org-entry-is-todo-p))
12749 (progn (setq org-block-entry-blocking (org-get-heading))
12750 (throw 'dont-block nil)))
12751 (outline-next-heading)
12752 (setq child-level (funcall outline-level))))))
12753 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12754 ;; any previous siblings are undone, it's blocked
12755 (save-excursion
12756 (org-back-to-heading t)
12757 (let* ((pos (point))
12758 (parent-pos (and (org-up-heading-safe) (point))))
12759 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12760 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12761 (forward-line 1)
12762 (re-search-forward org-not-done-heading-regexp pos t))
12763 (setq org-block-entry-blocking (match-string 0))
12764 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12765 ;; Search further up the hierarchy, to see if an ancestor is blocked
12766 (while t
12767 (goto-char parent-pos)
12768 (if (not (looking-at org-not-done-heading-regexp))
12769 (throw 'dont-block t)) ; do not block, parent is not a TODO
12770 (setq pos (point))
12771 (setq parent-pos (and (org-up-heading-safe) (point)))
12772 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12773 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12774 (forward-line 1)
12775 (re-search-forward org-not-done-heading-regexp pos t)
12776 (setq org-block-entry-blocking (org-get-heading)))
12777 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12779 (defcustom org-track-ordered-property-with-tag nil
12780 "Should the ORDERED property also be shown as a tag?
12781 The ORDERED property decides if an entry should require subtasks to be
12782 completed in sequence. Since a property is not very visible, setting
12783 this option means that toggling the ORDERED property with the command
12784 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12785 not relevant for the behavior, but it makes things more visible.
12787 Note that toggling the tag with tags commands will not change the property
12788 and therefore not influence behavior!
12790 This can be t, meaning the tag ORDERED should be used, It can also be a
12791 string to select a different tag for this task."
12792 :group 'org-todo
12793 :type '(choice
12794 (const :tag "No tracking" nil)
12795 (const :tag "Track with ORDERED tag" t)
12796 (string :tag "Use other tag")))
12798 (defun org-toggle-ordered-property ()
12799 "Toggle the ORDERED property of the current entry.
12800 For better visibility, you can track the value of this property with a tag.
12801 See variable `org-track-ordered-property-with-tag'."
12802 (interactive)
12803 (let* ((t1 org-track-ordered-property-with-tag)
12804 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12805 (save-excursion
12806 (org-back-to-heading)
12807 (if (org-entry-get nil "ORDERED")
12808 (progn
12809 (org-delete-property "ORDERED")
12810 (and tag (org-toggle-tag tag 'off))
12811 (message "Subtasks can be completed in arbitrary order"))
12812 (org-entry-put nil "ORDERED" "t")
12813 (and tag (org-toggle-tag tag 'on))
12814 (message "Subtasks must be completed in sequence")))))
12816 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12817 (defun org-block-todo-from-checkboxes (change-plist)
12818 "Block turning an entry into a TODO, using checkboxes.
12819 This checks whether the current task should be blocked from state
12820 changes because there are unchecked boxes in this entry."
12821 (if (not org-enforce-todo-checkbox-dependencies)
12822 t ; if locally turned off don't block
12823 (catch 'dont-block
12824 ;; If this is not a todo state change, or if this entry is already DONE,
12825 ;; do not block
12826 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12827 (member (plist-get change-plist :from)
12828 (cons 'done org-done-keywords))
12829 (member (plist-get change-plist :to)
12830 (cons 'todo org-not-done-keywords))
12831 (not (plist-get change-plist :to)))
12832 (throw 'dont-block t))
12833 ;; If this task has checkboxes that are not checked, it's blocked
12834 (save-excursion
12835 (org-back-to-heading t)
12836 (let ((beg (point)) end)
12837 (outline-next-heading)
12838 (setq end (point))
12839 (goto-char beg)
12840 (if (org-list-search-forward
12841 (concat (org-item-beginning-re)
12842 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12843 "\\[[- ]\\]")
12844 end t)
12845 (progn
12846 (if (boundp 'org-blocked-by-checkboxes)
12847 (setq org-blocked-by-checkboxes t))
12848 (throw 'dont-block nil)))))
12849 t))) ; do not block
12851 (defun org-entry-blocked-p ()
12852 "Non-nil if entry at point is blocked."
12853 (and (not (org-entry-get nil "NOBLOCKING"))
12854 (member (org-entry-get nil "TODO") org-not-done-keywords)
12855 (not (run-hook-with-args-until-failure
12856 'org-blocker-hook
12857 (list :type 'todo-state-change
12858 :position (point)
12859 :from 'todo
12860 :to 'done)))))
12862 (defun org-update-statistics-cookies (all)
12863 "Update the statistics cookie, either from TODO or from checkboxes.
12864 This should be called with the cursor in a line with a statistics cookie."
12865 (interactive "P")
12866 (if all
12867 (progn
12868 (org-update-checkbox-count 'all)
12869 (org-map-entries 'org-update-parent-todo-statistics))
12870 (if (not (org-at-heading-p))
12871 (org-update-checkbox-count)
12872 (let ((pos (point-marker))
12873 end l1 l2)
12874 (ignore-errors (org-back-to-heading t))
12875 (if (not (org-at-heading-p))
12876 (org-update-checkbox-count)
12877 (setq l1 (org-outline-level))
12878 (setq end (save-excursion
12879 (outline-next-heading)
12880 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12881 (point)))
12882 (if (and (save-excursion
12883 (re-search-forward
12884 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12885 (not (save-excursion (re-search-forward
12886 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12887 (org-update-checkbox-count)
12888 (if (and l2 (> l2 l1))
12889 (progn
12890 (goto-char end)
12891 (org-update-parent-todo-statistics))
12892 (goto-char pos)
12893 (beginning-of-line 1)
12894 (while (re-search-forward
12895 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12896 (point-at-eol) t)
12897 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12898 (goto-char pos)
12899 (move-marker pos nil)))))
12901 (defvar org-entry-property-inherited-from) ;; defined below
12902 (defun org-update-parent-todo-statistics ()
12903 "Update any statistics cookie in the parent of the current headline.
12904 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12905 the entire subtree and this will travel up the hierarchy and update
12906 statistics everywhere."
12907 (let* ((prop (save-excursion (org-up-heading-safe)
12908 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12909 (recursive (or (not org-hierarchical-todo-statistics)
12910 (and prop (string-match "\\<recursive\\>" prop))))
12911 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12913 (first t)
12914 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12915 level ltoggle l1 new ndel
12916 (cnt-all 0) (cnt-done 0) is-percent kwd
12917 checkbox-beg ov ovs ove cookie-present)
12918 (catch 'exit
12919 (save-excursion
12920 (beginning-of-line 1)
12921 (setq ltoggle (funcall outline-level))
12922 ;; Three situations are to consider:
12924 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12925 ;; to the top-level ancestor on the headline;
12927 ;; 2. If parent has "recursive" property, repeat up to the
12928 ;; headline setting that property, taking inheritance into
12929 ;; account;
12931 ;; 3. Else, move up to direct parent and proceed only once.
12932 (while (and (setq level (org-up-heading-safe))
12933 (or recursive first)
12934 (>= (point) lim))
12935 (setq first nil cookie-present nil)
12936 (unless (and level
12937 (not (string-match
12938 "\\<checkbox\\>"
12939 (downcase (or (org-entry-get nil "COOKIE_DATA")
12940 "")))))
12941 (throw 'exit nil))
12942 (while (re-search-forward box-re (point-at-eol) t)
12943 (setq cnt-all 0 cnt-done 0 cookie-present t)
12944 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12945 (save-match-data
12946 (unless (outline-next-heading) (throw 'exit nil))
12947 (while (and (looking-at org-complex-heading-regexp)
12948 (> (setq l1 (length (match-string 1))) level))
12949 (setq kwd (and (or recursive (= l1 ltoggle))
12950 (match-string 2)))
12951 (if (or (eq org-provide-todo-statistics 'all-headlines)
12952 (and (eq org-provide-todo-statistics t)
12953 (or (member kwd org-done-keywords)))
12954 (and (listp org-provide-todo-statistics)
12955 (stringp (car org-provide-todo-statistics))
12956 (or (member kwd org-provide-todo-statistics)
12957 (member kwd org-done-keywords)))
12958 (and (listp org-provide-todo-statistics)
12959 (listp (car org-provide-todo-statistics))
12960 (or (member kwd (car org-provide-todo-statistics))
12961 (and (member kwd org-done-keywords)
12962 (member kwd (cadr org-provide-todo-statistics))))))
12963 (setq cnt-all (1+ cnt-all))
12964 (if (eq org-provide-todo-statistics t)
12965 (and kwd (setq cnt-all (1+ cnt-all)))))
12966 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12967 (member kwd org-done-keywords))
12968 (and (listp org-provide-todo-statistics)
12969 (listp (car org-provide-todo-statistics))
12970 (member kwd org-done-keywords)
12971 (member kwd (cadr org-provide-todo-statistics)))
12972 (and (listp org-provide-todo-statistics)
12973 (stringp (car org-provide-todo-statistics))
12974 (member kwd org-done-keywords)))
12975 (setq cnt-done (1+ cnt-done)))
12976 (outline-next-heading)))
12977 (setq new
12978 (if is-percent
12979 (format "[%d%%]" (floor (* 100.0 cnt-done)
12980 (max 1 cnt-all)))
12981 (format "[%d/%d]" cnt-done cnt-all))
12982 ndel (- (match-end 0) checkbox-beg))
12983 ;; handle overlays when updating cookie from column view
12984 (when (setq ov (car (overlays-at checkbox-beg)))
12985 (setq ovs (overlay-start ov) ove (overlay-end ov))
12986 (delete-overlay ov))
12987 (goto-char checkbox-beg)
12988 (insert new)
12989 (delete-region (point) (+ (point) ndel))
12990 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12991 (when ov (move-overlay ov ovs ove)))
12992 (when cookie-present
12993 (run-hook-with-args 'org-after-todo-statistics-hook
12994 cnt-done (- cnt-all cnt-done))))))
12995 (run-hooks 'org-todo-statistics-hook)))
12997 (defvar org-after-todo-statistics-hook nil
12998 "Hook that is called after a TODO statistics cookie has been updated.
12999 Each function is called with two arguments: the number of not-done entries
13000 and the number of done entries.
13002 For example, the following function, when added to this hook, will switch
13003 an entry to DONE when all children are done, and back to TODO when new
13004 entries are set to a TODO status. Note that this hook is only called
13005 when there is a statistics cookie in the headline!
13007 (defun org-summary-todo (n-done n-not-done)
13008 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13009 (let (org-log-done org-log-states) ; turn off logging
13010 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13013 (defvar org-todo-statistics-hook nil
13014 "Hook that is run whenever Org thinks TODO statistics should be updated.
13015 This hook runs even if there is no statistics cookie present, in which case
13016 `org-after-todo-statistics-hook' would not run.")
13018 (defun org-todo-trigger-tag-changes (state)
13019 "Apply the changes defined in `org-todo-state-tags-triggers'."
13020 (let ((l org-todo-state-tags-triggers)
13021 changes)
13022 (when (or (not state) (equal state ""))
13023 (setq changes (append changes (cdr (assoc "" l)))))
13024 (when (and (stringp state) (> (length state) 0))
13025 (setq changes (append changes (cdr (assoc state l)))))
13026 (when (member state org-not-done-keywords)
13027 (setq changes (append changes (cdr (assoc 'todo l)))))
13028 (when (member state org-done-keywords)
13029 (setq changes (append changes (cdr (assoc 'done l)))))
13030 (dolist (c changes)
13031 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13033 (defun org-local-logging (value)
13034 "Get logging settings from a property VALUE."
13035 ;; Directly set the variables, they are already local.
13036 (setq org-log-done nil
13037 org-log-repeat nil
13038 org-todo-log-states nil)
13039 (dolist (w (org-split-string value))
13040 (let (a)
13041 (cond
13042 ((setq a (assoc w org-startup-options))
13043 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13044 (set (nth 1 a) (nth 2 a))))
13045 ((setq a (org-extract-log-state-settings w))
13046 (and (member (car a) org-todo-keywords-1)
13047 (push a org-todo-log-states)))))))
13049 (defun org-get-todo-sequence-head (kwd)
13050 "Return the head of the TODO sequence to which KWD belongs.
13051 If KWD is not set, check if there is a text property remembering the
13052 right sequence."
13053 (let (p)
13054 (cond
13055 ((not kwd)
13056 (or (get-text-property (point-at-bol) 'org-todo-head)
13057 (progn
13058 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13059 nil (point-at-eol)))
13060 (get-text-property p 'org-todo-head))))
13061 ((not (member kwd org-todo-keywords-1))
13062 (car org-todo-keywords-1))
13063 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13065 (defun org-fast-todo-selection ()
13066 "Fast TODO keyword selection with single keys.
13067 Returns the new TODO keyword, or nil if no state change should occur."
13068 (let* ((fulltable org-todo-key-alist)
13069 (done-keywords org-done-keywords) ;; needed for the faces.
13070 (maxlen (apply 'max (mapcar
13071 (lambda (x)
13072 (if (stringp (car x)) (string-width (car x)) 0))
13073 fulltable)))
13074 (expert nil)
13075 (fwidth (+ maxlen 3 1 3))
13076 (ncol (/ (- (window-width) 4) fwidth))
13077 tg cnt e c tbl
13078 groups ingroup)
13079 (save-excursion
13080 (save-window-excursion
13081 (if expert
13082 (set-buffer (get-buffer-create " *Org todo*"))
13083 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13084 (erase-buffer)
13085 (org-set-local 'org-done-keywords done-keywords)
13086 (setq tbl fulltable cnt 0)
13087 (while (setq e (pop tbl))
13088 (cond
13089 ((equal e '(:startgroup))
13090 (push '() groups) (setq ingroup t)
13091 (when (not (= cnt 0))
13092 (setq cnt 0)
13093 (insert "\n"))
13094 (insert "{ "))
13095 ((equal e '(:endgroup))
13096 (setq ingroup nil cnt 0)
13097 (insert "}\n"))
13098 ((equal e '(:newline))
13099 (when (not (= cnt 0))
13100 (setq cnt 0)
13101 (insert "\n")
13102 (setq e (car tbl))
13103 (while (equal (car tbl) '(:newline))
13104 (insert "\n")
13105 (setq tbl (cdr tbl)))))
13107 (setq tg (car e) c (cdr e))
13108 (if ingroup (push tg (car groups)))
13109 (setq tg (org-add-props tg nil 'face
13110 (org-get-todo-face tg)))
13111 (if (and (= cnt 0) (not ingroup)) (insert " "))
13112 (insert "[" c "] " tg (make-string
13113 (- fwidth 4 (length tg)) ?\ ))
13114 (when (= (setq cnt (1+ cnt)) ncol)
13115 (insert "\n")
13116 (if ingroup (insert " "))
13117 (setq cnt 0)))))
13118 (insert "\n")
13119 (goto-char (point-min))
13120 (if (not expert) (org-fit-window-to-buffer))
13121 (message "[a-z..]:Set [SPC]:clear")
13122 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13123 (cond
13124 ((or (= c ?\C-g)
13125 (and (= c ?q) (not (rassoc c fulltable))))
13126 (setq quit-flag t))
13127 ((= c ?\ ) nil)
13128 ((setq e (rassoc c fulltable) tg (car e))
13130 (t (setq quit-flag t)))))))
13132 (defun org-entry-is-todo-p ()
13133 (member (org-get-todo-state) org-not-done-keywords))
13135 (defun org-entry-is-done-p ()
13136 (member (org-get-todo-state) org-done-keywords))
13138 (defun org-get-todo-state ()
13139 "Return the TODO keyword of the current subtree."
13140 (save-excursion
13141 (org-back-to-heading t)
13142 (and (looking-at org-todo-line-regexp)
13143 (match-end 2)
13144 (match-string 2))))
13146 (defun org-at-date-range-p (&optional inactive-ok)
13147 "Non-nil if point is inside a date range.
13149 When optional argument INACTIVE-OK is non-nil, also consider
13150 inactive time ranges.
13152 When this function returns a non-nil value, match data is set
13153 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13154 on INACTIVE-OK."
13155 (interactive)
13156 (save-excursion
13157 (catch 'exit
13158 (let ((pos (point)))
13159 (skip-chars-backward "^[<\r\n")
13160 (skip-chars-backward "<[")
13161 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13162 (>= (match-end 0) pos)
13163 (throw 'exit t))
13164 (skip-chars-backward "^<[\r\n")
13165 (skip-chars-backward "<[")
13166 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13167 (>= (match-end 0) pos)
13168 (throw 'exit t)))
13169 nil)))
13171 (defun org-get-repeat (&optional tagline)
13172 "Check if there is a deadline/schedule with repeater in this entry."
13173 (save-match-data
13174 (save-excursion
13175 (org-back-to-heading t)
13176 (and (re-search-forward (if tagline
13177 (concat tagline "\\s-*" org-repeat-re)
13178 org-repeat-re)
13179 (org-entry-end-position) t)
13180 (match-string-no-properties 1)))))
13182 (defvar org-last-changed-timestamp)
13183 (defvar org-last-inserted-timestamp)
13184 (defvar org-log-post-message)
13185 (defvar org-log-note-purpose)
13186 (defvar org-log-note-how nil)
13187 (defvar org-log-note-extra)
13188 (defun org-auto-repeat-maybe (done-word)
13189 "Check if the current headline contains a repeated deadline/schedule.
13190 If yes, set TODO state back to what it was and change the base date
13191 of repeating deadline/scheduled time stamps to new date.
13192 This function is run automatically after each state change to a DONE state."
13193 ;; last-state is dynamically scoped into this function
13194 (let* ((repeat (org-get-repeat))
13195 (aa (assoc org-last-state org-todo-kwd-alist))
13196 (interpret (nth 1 aa))
13197 (head (nth 2 aa))
13198 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13199 (msg "Entry repeats: ")
13200 (org-log-done nil)
13201 (org-todo-log-states nil)
13202 re type n what ts time to-state)
13203 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13204 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13205 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13206 org-todo-repeat-to-state))
13207 (unless (and to-state (member to-state org-todo-keywords-1))
13208 (setq to-state (if (eq interpret 'type) org-last-state head)))
13209 (org-todo to-state)
13210 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13211 (org-entry-put nil "LAST_REPEAT" (format-time-string
13212 (org-time-stamp-format t t))))
13213 (when org-log-repeat
13214 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13215 (memq 'org-add-log-note post-command-hook))
13216 ;; OK, we are already setup for some record
13217 (if (eq org-log-repeat 'note)
13218 ;; make sure we take a note, not only a time stamp
13219 (setq org-log-note-how 'note))
13220 ;; Set up for taking a record
13221 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13222 org-last-state
13223 'findpos org-log-repeat)))
13224 (org-back-to-heading t)
13225 (org-add-planning-info nil nil 'closed)
13226 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13227 org-deadline-time-regexp "\\)\\|\\("
13228 org-ts-regexp "\\)"))
13229 (while (re-search-forward
13230 re (save-excursion (outline-next-heading) (point)) t)
13231 (setq type (if (match-end 1) org-scheduled-string
13232 (if (match-end 3) org-deadline-string "Plain:"))
13233 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13234 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13235 (setq n (string-to-number (match-string 2 ts))
13236 what (match-string 3 ts))
13237 (if (equal what "w") (setq n (* n 7) what "d"))
13238 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13239 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13240 ;; Preparation, see if we need to modify the start date for the change
13241 (when (match-end 1)
13242 (setq time (save-match-data (org-time-string-to-time ts)))
13243 (cond
13244 ((equal (match-string 1 ts) ".")
13245 ;; Shift starting date to today
13246 (org-timestamp-change
13247 (- (org-today) (time-to-days time))
13248 'day))
13249 ((equal (match-string 1 ts) "+")
13250 (let ((nshiftmax 10) (nshift 0))
13251 (while (or (= nshift 0)
13252 (<= (time-to-days time)
13253 (time-to-days (current-time))))
13254 (when (= (incf nshift) nshiftmax)
13255 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13256 (user-error "Abort")))
13257 (org-timestamp-change n (cdr (assoc what whata)))
13258 (org-at-timestamp-p t)
13259 (setq ts (match-string 1))
13260 (setq time (save-match-data (org-time-string-to-time ts)))))
13261 (org-timestamp-change (- n) (cdr (assoc what whata)))
13262 ;; rematch, so that we have everything in place for the real shift
13263 (org-at-timestamp-p t)
13264 (setq ts (match-string 1))
13265 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13266 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13267 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13268 (setq org-log-post-message msg)
13269 (message "%s" msg))))
13271 (defun org-show-todo-tree (arg)
13272 "Make a compact tree which shows all headlines marked with TODO.
13273 The tree will show the lines where the regexp matches, and all higher
13274 headlines above the match.
13275 With a \\[universal-argument] prefix, prompt for a regexp to match.
13276 With a numeric prefix N, construct a sparse tree for the Nth element
13277 of `org-todo-keywords-1'."
13278 (interactive "P")
13279 (let ((case-fold-search nil)
13280 (kwd-re
13281 (cond ((null arg) org-not-done-regexp)
13282 ((equal arg '(4))
13283 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13284 (mapcar 'list org-todo-keywords-1))))
13285 (concat "\\("
13286 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13287 "\\)\\>")))
13288 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13289 (regexp-quote (nth (1- (prefix-numeric-value arg))
13290 org-todo-keywords-1)))
13291 (t (user-error "Invalid prefix argument: %s" arg)))))
13292 (message "%d TODO entries found"
13293 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13295 (defun org-deadline (arg &optional time)
13296 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13297 With one universal prefix argument, remove any deadline from the item.
13298 With two universal prefix arguments, prompt for a warning delay.
13299 With argument TIME, set the deadline at the corresponding date. TIME
13300 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13301 (interactive "P")
13302 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13303 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13304 'region-start-level 'region))
13305 org-loop-over-headlines-in-active-region)
13306 (org-map-entries
13307 `(org-deadline ',arg ,time)
13308 org-loop-over-headlines-in-active-region
13309 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13310 (let* ((old-date (org-entry-get nil "DEADLINE"))
13311 (old-date-time (if old-date (org-time-string-to-time old-date)))
13312 (repeater (and old-date
13313 (string-match
13314 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13315 old-date)
13316 (match-string 1 old-date))))
13317 (cond
13318 ((equal arg '(4))
13319 (when (and old-date org-log-redeadline)
13320 (org-add-log-setup 'deldeadline nil old-date 'findpos
13321 org-log-redeadline))
13322 (org-remove-timestamp-with-keyword org-deadline-string)
13323 (message "Item no longer has a deadline."))
13324 ((equal arg '(16))
13325 (save-excursion
13326 (org-back-to-heading t)
13327 (if (re-search-forward
13328 org-deadline-time-regexp
13329 (save-excursion (outline-next-heading) (point)) t)
13330 (let* ((rpl0 (match-string 1))
13331 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13332 (replace-match
13333 (concat org-deadline-string
13334 " <" rpl
13335 (format " -%dd"
13336 (abs
13337 (- (time-to-days
13338 (save-match-data
13339 (org-read-date nil t nil "Warn starting from" old-date-time)))
13340 (time-to-days old-date-time))))
13341 ">") t t))
13342 (user-error "No deadline information to update"))))
13344 (org-add-planning-info 'deadline time 'closed)
13345 (when (and old-date
13346 org-log-redeadline
13347 (not (equal old-date org-last-inserted-timestamp)))
13348 (org-add-log-setup
13349 'redeadline org-last-inserted-timestamp old-date 'findpos
13350 org-log-redeadline))
13351 (when repeater
13352 (save-excursion
13353 (org-back-to-heading t)
13354 (when (re-search-forward (concat org-deadline-string " "
13355 org-last-inserted-timestamp)
13356 (save-excursion
13357 (outline-next-heading) (point)) t)
13358 (goto-char (1- (match-end 0)))
13359 (insert " " repeater)
13360 (setq org-last-inserted-timestamp
13361 (concat (substring org-last-inserted-timestamp 0 -1)
13362 " " repeater
13363 (substring org-last-inserted-timestamp -1))))))
13364 (message "Deadline on %s" org-last-inserted-timestamp))))))
13366 (defun org-schedule (arg &optional time)
13367 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13368 With one universal prefix argument, remove any scheduling date from the item.
13369 With two universal prefix arguments, prompt for a delay cookie.
13370 With argument TIME, scheduled at the corresponding date. TIME can
13371 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13372 (interactive "P")
13373 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13374 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13375 'region-start-level 'region))
13376 org-loop-over-headlines-in-active-region)
13377 (org-map-entries
13378 `(org-schedule ',arg ,time)
13379 org-loop-over-headlines-in-active-region
13380 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13381 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13382 (old-date-time (if old-date (org-time-string-to-time old-date)))
13383 (repeater (and old-date
13384 (string-match
13385 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13386 old-date)
13387 (match-string 1 old-date))))
13388 (cond
13389 ((equal arg '(4))
13390 (progn
13391 (when (and old-date org-log-reschedule)
13392 (org-add-log-setup 'delschedule nil old-date 'findpos
13393 org-log-reschedule))
13394 (org-remove-timestamp-with-keyword org-scheduled-string)
13395 (message "Item is no longer scheduled.")))
13396 ((equal arg '(16))
13397 (save-excursion
13398 (org-back-to-heading t)
13399 (if (re-search-forward
13400 org-scheduled-time-regexp
13401 (save-excursion (outline-next-heading) (point)) t)
13402 (let* ((rpl0 (match-string 1))
13403 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13404 (replace-match
13405 (concat org-scheduled-string
13406 " <" rpl
13407 (format " -%dd"
13408 (abs
13409 (- (time-to-days
13410 (save-match-data
13411 (org-read-date nil t nil "Delay until" old-date-time)))
13412 (time-to-days old-date-time))))
13413 ">") t t))
13414 (user-error "No scheduled information to update"))))
13416 (org-add-planning-info 'scheduled time 'closed)
13417 (when (and old-date
13418 org-log-reschedule
13419 (not (equal old-date org-last-inserted-timestamp)))
13420 (org-add-log-setup
13421 'reschedule org-last-inserted-timestamp old-date 'findpos
13422 org-log-reschedule))
13423 (when repeater
13424 (save-excursion
13425 (org-back-to-heading t)
13426 (when (re-search-forward (concat org-scheduled-string " "
13427 org-last-inserted-timestamp)
13428 (save-excursion
13429 (outline-next-heading) (point)) t)
13430 (goto-char (1- (match-end 0)))
13431 (insert " " repeater)
13432 (setq org-last-inserted-timestamp
13433 (concat (substring org-last-inserted-timestamp 0 -1)
13434 " " repeater
13435 (substring org-last-inserted-timestamp -1))))))
13436 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13438 (defun org-get-scheduled-time (pom &optional inherit)
13439 "Get the scheduled time as a time tuple, of a format suitable
13440 for calling org-schedule with, or if there is no scheduling,
13441 returns nil."
13442 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13443 (when time
13444 (apply 'encode-time (org-parse-time-string time)))))
13446 (defun org-get-deadline-time (pom &optional inherit)
13447 "Get the deadline as a time tuple, of a format suitable for
13448 calling org-deadline with, or if there is no scheduling, returns
13449 nil."
13450 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13451 (when time
13452 (apply 'encode-time (org-parse-time-string time)))))
13454 (defun org-remove-timestamp-with-keyword (keyword)
13455 "Remove all time stamps with KEYWORD in the current entry."
13456 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13457 beg)
13458 (save-excursion
13459 (org-back-to-heading t)
13460 (setq beg (point))
13461 (outline-next-heading)
13462 (while (re-search-backward re beg t)
13463 (replace-match "")
13464 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13465 (equal (char-before) ?\ ))
13466 (backward-delete-char 1)
13467 (if (string-match "^[ \t]*$" (buffer-substring
13468 (point-at-bol) (point-at-eol)))
13469 (delete-region (point-at-bol)
13470 (min (point-max) (1+ (point-at-eol))))))))))
13472 (defvar org-time-was-given) ; dynamically scoped parameter
13473 (defvar org-end-time-was-given) ; dynamically scoped parameter
13475 (defun org-at-planning-p ()
13476 "Non-nil when point is on a planning info line."
13477 ;; This is as accurate and faster than `org-element-at-point' since
13478 ;; planning info location is fixed in the section.
13479 (org-with-wide-buffer
13480 (beginning-of-line)
13481 (and (org-looking-at-p org-planning-line-re)
13482 (eq (point)
13483 (ignore-errors
13484 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13485 (org-back-to-heading t)
13486 (org-with-limited-levels (org-back-to-heading t)))
13487 (line-beginning-position 2))))))
13489 (defun org-add-planning-info (what &optional time &rest remove)
13490 "Insert new timestamp with keyword in the planning line.
13491 WHAT indicates what kind of time stamp to add. It is a symbol
13492 among `closed', `deadline', `scheduled' and nil. TIME indicates
13493 the time to use. If none is given, the user is prompted for
13494 a date. REMOVE indicates what kind of entries to remove. An old
13495 WHAT entry will also be removed."
13496 (let (org-time-was-given org-end-time-was-given default-time default-input)
13497 (catch 'exit
13498 (when (and (memq what '(scheduled deadline))
13499 (or (not time)
13500 (and (stringp time)
13501 (string-match "^[-+]+[0-9]" time))))
13502 ;; Try to get a default date/time from existing timestamp
13503 (save-excursion
13504 (org-back-to-heading t)
13505 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13506 (when (re-search-forward (if (eq what 'scheduled)
13507 org-scheduled-time-regexp
13508 org-deadline-time-regexp)
13509 end t)
13510 (setq ts (match-string 1)
13511 default-time (apply 'encode-time (org-parse-time-string ts))
13512 default-input (and ts (org-get-compact-tod ts)))))))
13513 (when what
13514 (setq time
13515 (if (stringp time)
13516 ;; This is a string (relative or absolute), set
13517 ;; proper date.
13518 (apply #'encode-time
13519 (org-read-date-analyze
13520 time default-time (decode-time default-time)))
13521 ;; If necessary, get the time from the user
13522 (or time (org-read-date nil 'to-time nil nil
13523 default-time default-input)))))
13525 (org-with-wide-buffer
13526 (org-back-to-heading t)
13527 (forward-line)
13528 (unless (bolp) (insert "\n"))
13529 (cond ((org-looking-at-p org-planning-line-re)
13530 ;; Move to current indentation.
13531 (skip-chars-forward " \t")
13532 ;; Check if we have to remove something.
13533 (dolist (type (if what (cons what remove) remove))
13534 (save-excursion
13535 (when (re-search-forward
13536 (concat
13537 " *"
13538 (case type
13539 (closed org-closed-time-regexp)
13540 (deadline org-deadline-time-regexp)
13541 (scheduled org-scheduled-time-regexp)
13542 (otherwise
13543 (error "Invalid planning type: %s" type))))
13544 (line-end-position) t)
13545 (replace-match "")
13546 (when (looking-at "--+<[^>]+>") (replace-match ""))
13547 (when (and (not what) (eq type 'closed))
13548 (save-excursion
13549 (beginning-of-line)
13550 (when (looking-at "[ \t]*$")
13551 (delete-region (point)
13552 (line-beginning-position 2)))))))
13553 ;; Remove leading white spaces.
13554 (when (looking-at "[ \t]+") (replace-match ""))))
13555 ((not what) (throw 'exit nil)) ; Nothing to do.
13556 (t (insert-before-markers "\n")
13557 (backward-char 1)
13558 (when org-adapt-indentation
13559 (org-indent-to-column (1+ (org-outline-level))))))
13560 (when what
13561 ;; Insert planning keyword.
13562 (insert (case what
13563 (closed org-closed-string)
13564 (deadline org-deadline-string)
13565 (scheduled org-scheduled-string)
13566 (otherwise (error "Invalid planning type: %s" what)))
13567 " ")
13568 ;; Insert associated timestamp.
13569 (let ((ts (org-insert-time-stamp
13570 time
13571 (or org-time-was-given
13572 (and (eq what 'closed) org-log-done-with-time))
13573 (eq what 'closed)
13574 nil nil (list org-end-time-was-given))))
13575 (unless (eolp) (insert " "))
13576 ts))))))
13578 (defvar org-log-note-marker (make-marker))
13579 (defvar org-log-note-purpose nil)
13580 (defvar org-log-note-state nil)
13581 (defvar org-log-note-previous-state nil)
13582 (defvar org-log-note-extra nil)
13583 (defvar org-log-note-window-configuration nil)
13584 (defvar org-log-note-return-to (make-marker))
13585 (defvar org-log-note-effective-time nil
13586 "Remembered current time so that dynamically scoped
13587 `org-extend-today-until' affects tha timestamps in state change
13588 log")
13590 (defvar org-log-post-message nil
13591 "Message to be displayed after a log note has been stored.
13592 The auto-repeater uses this.")
13594 (defun org-add-note ()
13595 "Add a note to the current entry.
13596 This is done in the same way as adding a state change note."
13597 (interactive)
13598 (org-add-log-setup 'note nil nil 'findpos nil))
13600 (defun org-log-beginning (&optional create)
13601 "Return expected start of log notes in current entry.
13602 When optional argument CREATE is non-nil, the function creates
13603 a drawer to store notes, if necessary. Returned position ignores
13604 narrowing."
13605 (org-with-wide-buffer
13606 (org-end-of-meta-data)
13607 (let ((end (if (org-at-heading-p) (point)
13608 (save-excursion (outline-next-heading) (point))))
13609 (drawer (org-log-into-drawer)))
13610 (cond
13611 (drawer
13612 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13613 (case-fold-search t))
13614 (catch 'exit
13615 ;; Try to find existing drawer.
13616 (while (re-search-forward regexp end t)
13617 (let ((element (org-element-at-point)))
13618 (when (eq (org-element-type element) 'drawer)
13619 (let ((cend (org-element-property :contents-end element)))
13620 (when (and (not org-log-states-order-reversed) cend)
13621 (goto-char cend)))
13622 (throw 'exit nil))))
13623 ;; No drawer found. Create one, if permitted.
13624 (when create
13625 (unless (bolp) (insert "\n"))
13626 (let ((beg (point)))
13627 (insert ":" drawer ":\n:END:\n")
13628 (org-indent-region beg (point)))
13629 (end-of-line -1)))))
13630 (org-log-state-notes-insert-after-drawers
13631 (while (and (looking-at org-drawer-regexp)
13632 (progn (goto-char (match-end 0))
13633 (re-search-forward org-property-end-re end t)))
13634 (forward-line)))))
13635 (if (bolp) (point) (line-beginning-position 2))))
13637 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13638 "Set up the post command hook to take a note.
13639 If this is about to TODO state change, the new state is expected in STATE.
13640 When FINDPOS is non-nil, find the correct position for the note in
13641 the current entry. If not, assume that it can be inserted at point.
13642 HOW is an indicator what kind of note should be created.
13643 EXTRA is additional text that will be inserted into the notes buffer."
13644 (org-with-wide-buffer
13645 (when findpos
13646 (goto-char (org-log-beginning t))
13647 (unless org-log-states-order-reversed
13648 (org-skip-over-state-notes)
13649 (skip-chars-backward " \t\n\r")
13650 (forward-line)))
13651 (move-marker org-log-note-marker (point))
13652 ;; Preserve position even if a property drawer is inserted in the
13653 ;; process.
13654 (set-marker-insertion-type org-log-note-marker t)
13655 (setq org-log-note-purpose purpose
13656 org-log-note-state state
13657 org-log-note-previous-state prev-state
13658 org-log-note-how how
13659 org-log-note-extra extra
13660 org-log-note-effective-time (org-current-effective-time))
13661 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13663 (defun org-skip-over-state-notes ()
13664 "Skip past the list of State notes in an entry."
13665 (when (ignore-errors (goto-char (org-in-item-p)))
13666 (let* ((struct (org-list-struct))
13667 (prevs (org-list-prevs-alist struct))
13668 (regexp
13669 (concat "[ \t]*- +"
13670 (replace-regexp-in-string
13671 " +" " +"
13672 (org-replace-escapes
13673 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13674 `(("%d" . ,org-ts-regexp-inactive)
13675 ("%D" . ,org-ts-regexp)
13676 ("%s" . "\"\\S-+\"")
13677 ("%S" . "\"\\S-+\"")
13678 ("%t" . ,org-ts-regexp-inactive)
13679 ("%T" . ,org-ts-regexp)
13680 ("%u" . ".*?")
13681 ("%U" . ".*?")))))))
13682 (while (org-looking-at-p regexp)
13683 (goto-char (or (org-list-get-next-item (point) struct prevs)
13684 (org-list-get-item-end (point) struct)))))))
13686 (defun org-add-log-note (&optional purpose)
13687 "Pop up a window for taking a note, and add this note later at point."
13688 (remove-hook 'post-command-hook 'org-add-log-note)
13689 (setq org-log-note-window-configuration (current-window-configuration))
13690 (delete-other-windows)
13691 (move-marker org-log-note-return-to (point))
13692 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13693 (goto-char org-log-note-marker)
13694 (org-switch-to-buffer-other-window "*Org Note*")
13695 (erase-buffer)
13696 (if (memq org-log-note-how '(time state))
13697 (let (current-prefix-arg) (org-store-log-note))
13698 (let ((org-inhibit-startup t)) (org-mode))
13699 (insert (format "# Insert note for %s.
13700 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13701 (cond
13702 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13703 ((eq org-log-note-purpose 'done) "closed todo item")
13704 ((eq org-log-note-purpose 'state)
13705 (format "state change from \"%s\" to \"%s\""
13706 (or org-log-note-previous-state "")
13707 (or org-log-note-state "")))
13708 ((eq org-log-note-purpose 'reschedule)
13709 "rescheduling")
13710 ((eq org-log-note-purpose 'delschedule)
13711 "no longer scheduled")
13712 ((eq org-log-note-purpose 'redeadline)
13713 "changing deadline")
13714 ((eq org-log-note-purpose 'deldeadline)
13715 "removing deadline")
13716 ((eq org-log-note-purpose 'refile)
13717 "refiling")
13718 ((eq org-log-note-purpose 'note)
13719 "this entry")
13720 (t (error "This should not happen")))))
13721 (if org-log-note-extra (insert org-log-note-extra))
13722 (org-set-local 'org-finish-function 'org-store-log-note)
13723 (run-hooks 'org-log-buffer-setup-hook)))
13725 (defvar org-note-abort nil) ; dynamically scoped
13726 (defun org-store-log-note ()
13727 "Finish taking a log note, and insert it to where it belongs."
13728 (let ((txt (buffer-string)))
13729 (kill-buffer (current-buffer))
13730 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13731 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13732 (setq txt (replace-match "" t t txt)))
13733 (if (string-match "\\s-+\\'" txt)
13734 (setq txt (replace-match "" t t txt)))
13735 (setq lines (org-split-string txt "\n"))
13736 (when (and note (string-match "\\S-" note))
13737 (setq note
13738 (org-replace-escapes
13739 note
13740 (list (cons "%u" (user-login-name))
13741 (cons "%U" user-full-name)
13742 (cons "%t" (format-time-string
13743 (org-time-stamp-format 'long 'inactive)
13744 org-log-note-effective-time))
13745 (cons "%T" (format-time-string
13746 (org-time-stamp-format 'long nil)
13747 org-log-note-effective-time))
13748 (cons "%d" (format-time-string
13749 (org-time-stamp-format nil 'inactive)
13750 org-log-note-effective-time))
13751 (cons "%D" (format-time-string
13752 (org-time-stamp-format nil nil)
13753 org-log-note-effective-time))
13754 (cons "%s" (cond
13755 ((not org-log-note-state) "")
13756 ((org-string-match-p org-ts-regexp
13757 org-log-note-state)
13758 (format "\"[%s]\""
13759 (substring org-log-note-state 1 -1)))
13760 (t (format "\"%s\"" org-log-note-state))))
13761 (cons "%S"
13762 (cond
13763 ((not org-log-note-previous-state) "")
13764 ((org-string-match-p org-ts-regexp
13765 org-log-note-previous-state)
13766 (format "\"[%s]\""
13767 (substring
13768 org-log-note-previous-state 1 -1)))
13769 (t (format "\"%s\""
13770 org-log-note-previous-state)))))))
13771 (when lines (setq note (concat note " \\\\")))
13772 (push note lines))
13773 (when (or current-prefix-arg org-note-abort)
13774 (when (org-log-into-drawer)
13775 (org-remove-empty-drawer-at org-log-note-marker))
13776 (setq lines nil))
13777 (when lines
13778 (with-current-buffer (marker-buffer org-log-note-marker)
13779 (org-with-wide-buffer
13780 (goto-char org-log-note-marker)
13781 (move-marker org-log-note-marker nil)
13782 ;; Make sure point is at the beginning of an empty line.
13783 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13784 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13785 ;; In an existing list, add a new item at the top level.
13786 ;; Otherwise, indent line like a regular one.
13787 (let ((itemp (org-in-item-p)))
13788 (if itemp
13789 (org-indent-line-to
13790 (let ((struct (save-excursion
13791 (goto-char itemp) (org-list-struct))))
13792 (org-list-get-ind (org-list-get-top-point struct) struct)))
13793 (org-indent-line)))
13794 (insert (org-list-bullet-string "-") (pop lines))
13795 (let ((ind (org-list-item-body-column (line-beginning-position))))
13796 (dolist (line lines)
13797 (insert "\n")
13798 (org-indent-line-to ind)
13799 (insert line)))
13800 (message "Note stored")
13801 (org-back-to-heading t)
13802 (org-cycle-hide-drawers 'children))
13803 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13804 ;; from within `org-add-log-note' because `buffer-undo-list'
13805 ;; is then modified outside of `org-with-remote-undo'.
13806 (when (eq this-command 'org-agenda-todo)
13807 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13808 ;; Don't add undo information when called from `org-agenda-todo'
13809 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13810 (set-window-configuration org-log-note-window-configuration)
13811 (with-current-buffer (marker-buffer org-log-note-return-to)
13812 (goto-char org-log-note-return-to))
13813 (move-marker org-log-note-return-to nil)
13814 (and org-log-post-message (message "%s" org-log-post-message))))
13816 (defun org-remove-empty-drawer-at (pos)
13817 "Remove an empty drawer at position POS.
13818 POS may also be a marker."
13819 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13820 (org-with-wide-buffer
13821 (goto-char pos)
13822 (let ((drawer (org-element-at-point)))
13823 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13824 (not (org-element-property :contents-begin drawer)))
13825 (delete-region (org-element-property :begin drawer)
13826 (progn (goto-char (org-element-property :end drawer))
13827 (skip-chars-backward " \r\t\n")
13828 (forward-line)
13829 (point))))))))
13831 (defvar org-ts-type nil)
13832 (defun org-sparse-tree (&optional arg type)
13833 "Create a sparse tree, prompt for the details.
13834 This command can create sparse trees. You first need to select the type
13835 of match used to create the tree:
13837 t Show all TODO entries.
13838 T Show entries with a specific TODO keyword.
13839 m Show entries selected by a tags/property match.
13840 p Enter a property name and its value (both with completion on existing
13841 names/values) and show entries with that property.
13842 r Show entries matching a regular expression (`/' can be used as well).
13843 b Show deadlines and scheduled items before a date.
13844 a Show deadlines and scheduled items after a date.
13845 d Show deadlines due within `org-deadline-warning-days'.
13846 D Show deadlines and scheduled items between a date range."
13847 (interactive "P")
13848 (setq type (or type org-sparse-tree-default-date-type))
13849 (setq org-ts-type type)
13850 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13851 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13852 [c]ycle through date types: %s"
13853 (case type
13854 (all "all timestamps")
13855 (scheduled "only scheduled")
13856 (deadline "only deadline")
13857 (active "only active timestamps")
13858 (inactive "only inactive timestamps")
13859 (closed "with a closed time-stamp")
13860 (otherwise "scheduled/deadline")))
13861 (let ((answer (read-char-exclusive)))
13862 (case answer
13864 (org-sparse-tree
13866 (cadr
13867 (memq type '(nil all scheduled deadline active inactive closed)))))
13868 (?d (call-interactively 'org-check-deadlines))
13869 (?b (call-interactively 'org-check-before-date))
13870 (?a (call-interactively 'org-check-after-date))
13871 (?D (call-interactively 'org-check-dates-range))
13872 (?t (call-interactively 'org-show-todo-tree))
13873 (?T (org-show-todo-tree '(4)))
13874 (?m (call-interactively 'org-match-sparse-tree))
13875 ((?p ?P)
13876 (let* ((kwd (org-icompleting-read
13877 "Property: " (mapcar 'list (org-buffer-property-keys))))
13878 (value (org-icompleting-read
13879 "Value: " (mapcar 'list (org-property-values kwd)))))
13880 (unless (string-match "\\`{.*}\\'" value)
13881 (setq value (concat "\"" value "\"")))
13882 (org-match-sparse-tree arg (concat kwd "=" value))))
13883 ((?r ?R ?/) (call-interactively 'org-occur))
13884 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13886 (defvar org-occur-highlights nil
13887 "List of overlays used for occur matches.")
13888 (make-variable-buffer-local 'org-occur-highlights)
13889 (defvar org-occur-parameters nil
13890 "Parameters of the active org-occur calls.
13891 This is a list, each call to org-occur pushes as cons cell,
13892 containing the regular expression and the callback, onto the list.
13893 The list can contain several entries if `org-occur' has been called
13894 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13895 will only contain one set of parameters. When the highlights are
13896 removed (for example with `C-c C-c', or with the next edit (depending
13897 on `org-remove-highlights-with-change'), this variable is emptied
13898 as well.")
13899 (make-variable-buffer-local 'org-occur-parameters)
13901 (defun org-occur (regexp &optional keep-previous callback)
13902 "Make a compact tree which shows all matches of REGEXP.
13903 The tree will show the lines where the regexp matches, and all higher
13904 headlines above the match. It will also show the heading after the match,
13905 to make sure editing the matching entry is easy.
13906 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13907 call to `org-occur' will be kept, to allow stacking of calls to this
13908 command.
13909 If CALLBACK is non-nil, it is a function which is called to confirm
13910 that the match should indeed be shown."
13911 (interactive "sRegexp: \nP")
13912 (when (equal regexp "")
13913 (user-error "Regexp cannot be empty"))
13914 (unless keep-previous
13915 (org-remove-occur-highlights nil nil t))
13916 (push (cons regexp callback) org-occur-parameters)
13917 (let ((cnt 0))
13918 (save-excursion
13919 (goto-char (point-min))
13920 (if (or (not keep-previous) ; do not want to keep
13921 (not org-occur-highlights)) ; no previous matches
13922 ;; hide everything
13923 (org-overview))
13924 (while (re-search-forward regexp nil t)
13925 (backward-char) ;; FIXME: Match timestamps at the end of a headline
13926 (when (or (not callback)
13927 (save-match-data (funcall callback)))
13928 (setq cnt (1+ cnt))
13929 (when org-highlight-sparse-tree-matches
13930 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13931 (org-show-context 'occur-tree))))
13932 (when org-remove-highlights-with-change
13933 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13934 nil 'local))
13935 (unless org-sparse-tree-open-archived-trees
13936 (org-hide-archived-subtrees (point-min) (point-max)))
13937 (run-hooks 'org-occur-hook)
13938 (if (org-called-interactively-p 'interactive)
13939 (message "%d match(es) for regexp %s" cnt regexp))
13940 cnt))
13942 (defun org-occur-next-match (&optional n reset)
13943 "Function for `next-error-function' to find sparse tree matches.
13944 N is the number of matches to move, when negative move backwards.
13945 RESET is entirely ignored - this function always goes back to the
13946 starting point when no match is found."
13947 (let* ((limit (if (< n 0) (point-min) (point-max)))
13948 (search-func (if (< n 0)
13949 'previous-single-char-property-change
13950 'next-single-char-property-change))
13951 (n (abs n))
13952 (pos (point))
13954 (catch 'exit
13955 (while (setq p1 (funcall search-func (point) 'org-type))
13956 (when (equal p1 limit)
13957 (goto-char pos)
13958 (user-error "No more matches"))
13959 (when (equal (get-char-property p1 'org-type) 'org-occur)
13960 (setq n (1- n))
13961 (when (= n 0)
13962 (goto-char p1)
13963 (throw 'exit (point))))
13964 (goto-char p1))
13965 (goto-char p1)
13966 (user-error "No more matches"))))
13968 (defun org-show-context (&optional key)
13969 "Make sure point and context are visible.
13970 Optional argument KEY, when non-nil, is a symbol. See
13971 `org-show-context-detail' for allowed values and how much is to
13972 be shown."
13973 (org-show-set-visibility
13974 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13975 ((cdr (assq key org-show-context-detail)))
13976 (t (cdr (assq 'default org-show-context-detail))))))
13978 (defun org-show-set-visibility (detail)
13979 "Set visibility around point according to DETAIL.
13980 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13981 `tree', `canonical' or t. See `org-show-context-detail' for more
13982 information."
13983 (unless (org-before-first-heading-p)
13984 ;; Show current heading and possibly its entry, following headline
13985 ;; or all children.
13986 (if (and (org-at-heading-p) (not (eq detail 'local)))
13987 (org-flag-heading nil)
13988 (org-show-entry)
13989 (org-with-limited-levels
13990 (case detail
13991 ((tree canonical t) (show-children))
13992 ((nil minimal ancestors))
13993 (t (save-excursion
13994 (outline-next-heading)
13995 (org-flag-heading nil))))))
13996 ;; Show all siblings.
13997 (when (eq detail 'lineage) (org-show-siblings))
13998 ;; Show ancestors, possibly with their children.
13999 (when (memq detail '(ancestors lineage tree canonical t))
14000 (save-excursion
14001 (while (org-up-heading-safe)
14002 (org-flag-heading nil)
14003 (when (memq detail '(canonical t)) (org-show-entry))
14004 (when (memq detail '(tree canonical t)) (show-children)))))))
14006 (defvar org-reveal-start-hook nil
14007 "Hook run before revealing a location.")
14009 (defun org-reveal (&optional siblings)
14010 "Show current entry, hierarchy above it, and the following headline.
14012 This can be used to show a consistent set of context around
14013 locations exposed with `org-show-context'.
14015 With optional argument SIBLINGS, on each level of the hierarchy all
14016 siblings are shown. This repairs the tree structure to what it would
14017 look like when opened with hierarchical calls to `org-cycle'.
14019 With double optional argument \\[universal-argument] \\[universal-argument], \
14020 go to the parent and show the
14021 entire tree."
14022 (interactive "P")
14023 (run-hooks 'org-reveal-start-hook)
14024 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14025 ((equal siblings '(16))
14026 (save-excursion
14027 (when (org-up-heading-safe)
14028 (org-show-subtree)
14029 (run-hook-with-args 'org-cycle-hook 'subtree))))
14030 (t (org-show-set-visibility 'lineage))))
14032 (defun org-highlight-new-match (beg end)
14033 "Highlight from BEG to END and mark the highlight is an occur headline."
14034 (let ((ov (make-overlay beg end)))
14035 (overlay-put ov 'face 'secondary-selection)
14036 (overlay-put ov 'org-type 'org-occur)
14037 (push ov org-occur-highlights)))
14039 (defun org-remove-occur-highlights (&optional beg end noremove)
14040 "Remove the occur highlights from the buffer.
14041 BEG and END are ignored. If NOREMOVE is nil, remove this function
14042 from the `before-change-functions' in the current buffer."
14043 (interactive)
14044 (unless org-inhibit-highlight-removal
14045 (mapc 'delete-overlay org-occur-highlights)
14046 (setq org-occur-highlights nil)
14047 (setq org-occur-parameters nil)
14048 (unless noremove
14049 (remove-hook 'before-change-functions
14050 'org-remove-occur-highlights 'local))))
14052 ;;;; Priorities
14054 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14055 "Regular expression matching the priority indicator.")
14057 (defvar org-remove-priority-next-time nil)
14059 (defun org-priority-up ()
14060 "Increase the priority of the current item."
14061 (interactive)
14062 (org-priority 'up))
14064 (defun org-priority-down ()
14065 "Decrease the priority of the current item."
14066 (interactive)
14067 (org-priority 'down))
14069 (defun org-priority (&optional action show)
14070 "Change the priority of an item.
14071 ACTION can be `set', `up', `down', or a character."
14072 (interactive "P")
14073 (if (equal action '(4))
14074 (org-show-priority)
14075 (unless org-enable-priority-commands
14076 (user-error "Priority commands are disabled"))
14077 (setq action (or action 'set))
14078 (let (current new news have remove)
14079 (save-excursion
14080 (org-back-to-heading t)
14081 (if (looking-at org-priority-regexp)
14082 (setq current (string-to-char (match-string 2))
14083 have t))
14084 (cond
14085 ((eq action 'remove)
14086 (setq remove t new ?\ ))
14087 ((or (eq action 'set)
14088 (if (featurep 'xemacs) (characterp action) (integerp action)))
14089 (if (not (eq action 'set))
14090 (setq new action)
14091 (message "Priority %c-%c, SPC to remove: "
14092 org-highest-priority org-lowest-priority)
14093 (save-match-data
14094 (setq new (read-char-exclusive))))
14095 (if (and (= (upcase org-highest-priority) org-highest-priority)
14096 (= (upcase org-lowest-priority) org-lowest-priority))
14097 (setq new (upcase new)))
14098 (cond ((equal new ?\ ) (setq remove t))
14099 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14100 (user-error "Priority must be between `%c' and `%c'"
14101 org-highest-priority org-lowest-priority))))
14102 ((eq action 'up)
14103 (setq new (if have
14104 (1- current) ; normal cycling
14105 ;; last priority was empty
14106 (if (eq last-command this-command)
14107 org-lowest-priority ; wrap around empty to lowest
14108 ;; default
14109 (if org-priority-start-cycle-with-default
14110 org-default-priority
14111 (1- org-default-priority))))))
14112 ((eq action 'down)
14113 (setq new (if have
14114 (1+ current) ; normal cycling
14115 ;; last priority was empty
14116 (if (eq last-command this-command)
14117 org-highest-priority ; wrap around empty to highest
14118 ;; default
14119 (if org-priority-start-cycle-with-default
14120 org-default-priority
14121 (1+ org-default-priority))))))
14122 (t (user-error "Invalid action")))
14123 (if (or (< (upcase new) org-highest-priority)
14124 (> (upcase new) org-lowest-priority))
14125 (if (and (memq action '(up down))
14126 (not have) (not (eq last-command this-command)))
14127 ;; `new' is from default priority
14128 (error
14129 "The default can not be set, see `org-default-priority' why")
14130 ;; normal cycling: `new' is beyond highest/lowest priority
14131 ;; and is wrapped around to the empty priority
14132 (setq remove t)))
14133 (setq news (format "%c" new))
14134 (if have
14135 (if remove
14136 (replace-match "" t t nil 1)
14137 (replace-match news t t nil 2))
14138 (if remove
14139 (user-error "No priority cookie found in line")
14140 (let ((case-fold-search nil))
14141 (looking-at org-todo-line-regexp))
14142 (if (match-end 2)
14143 (progn
14144 (goto-char (match-end 2))
14145 (insert " [#" news "]"))
14146 (goto-char (match-beginning 3))
14147 (insert "[#" news "] "))))
14148 (org-set-tags nil 'align))
14149 (if remove
14150 (message "Priority removed")
14151 (message "Priority of current item set to %s" news)))))
14153 (defun org-show-priority ()
14154 "Show the priority of the current item.
14155 This priority is composed of the main priority given with the [#A] cookies,
14156 and by additional input from the age of a schedules or deadline entry."
14157 (interactive)
14158 (let ((pri (if (eq major-mode 'org-agenda-mode)
14159 (org-get-at-bol 'priority)
14160 (save-excursion
14161 (save-match-data
14162 (beginning-of-line)
14163 (and (looking-at org-heading-regexp)
14164 (org-get-priority (match-string 0))))))))
14165 (message "Priority is %d" (if pri pri -1000))))
14167 (defun org-get-priority (s)
14168 "Find priority cookie and return priority."
14169 (save-match-data
14170 (if (functionp org-get-priority-function)
14171 (funcall org-get-priority-function)
14172 (if (not (string-match org-priority-regexp s))
14173 (* 1000 (- org-lowest-priority org-default-priority))
14174 (* 1000 (- org-lowest-priority
14175 (string-to-char (match-string 2 s))))))))
14177 ;;;; Tags
14179 (defvar org-agenda-archives-mode)
14180 (defvar org-map-continue-from nil
14181 "Position from where mapping should continue.
14182 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14184 (defvar org-scanner-tags nil
14185 "The current tag list while the tags scanner is running.")
14186 (defvar org-trust-scanner-tags nil
14187 "Should `org-get-tags-at' use the tags for the scanner.
14188 This is for internal dynamical scoping only.
14189 When this is non-nil, the function `org-get-tags-at' will return the value
14190 of `org-scanner-tags' instead of building the list by itself. This
14191 can lead to large speed-ups when the tags scanner is used in a file with
14192 many entries, and when the list of tags is retrieved, for example to
14193 obtain a list of properties. Building the tags list for each entry in such
14194 a file becomes an N^2 operation - but with this variable set, it scales
14195 as N.")
14197 (defun org-scan-tags (action matcher todo-only &optional start-level)
14198 "Scan headline tags with inheritance and produce output ACTION.
14200 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14201 or `agenda' to produce an entry list for an agenda view. It can also be
14202 a Lisp form or a function that should be called at each matched headline, in
14203 this case the return value is a list of all return values from these calls.
14205 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14206 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14207 only lines with a not-done TODO keyword are included in the output.
14208 This should be the same variable that was scoped into
14209 and set by `org-make-tags-matcher' when it constructed MATCHER.
14211 START-LEVEL can be a string with asterisks, reducing the scope to
14212 headlines matching this string."
14213 (require 'org-agenda)
14214 (let* ((re (concat "^"
14215 (if start-level
14216 ;; Get the correct level to match
14217 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14218 org-outline-regexp)
14219 " *\\(\\<\\("
14220 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14221 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14222 (props (list 'face 'default
14223 'done-face 'org-agenda-done
14224 'undone-face 'default
14225 'mouse-face 'highlight
14226 'org-not-done-regexp org-not-done-regexp
14227 'org-todo-regexp org-todo-regexp
14228 'org-complex-heading-regexp org-complex-heading-regexp
14229 'help-echo
14230 (format "mouse-2 or RET jump to org file %s"
14231 (abbreviate-file-name
14232 (or (buffer-file-name (buffer-base-buffer))
14233 (buffer-name (buffer-base-buffer)))))))
14234 (org-map-continue-from nil)
14235 lspos tags tags-list
14236 (tags-alist (list (cons 0 org-file-tags)))
14237 (llast 0) rtn rtn1 level category i txt
14238 todo marker entry priority
14239 ts-date ts-date-type ts-date-pair)
14240 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14241 (setq action (list 'lambda nil action)))
14242 (save-excursion
14243 (goto-char (point-min))
14244 (when (eq action 'sparse-tree)
14245 (org-overview)
14246 (org-remove-occur-highlights))
14247 (while (let (case-fold-search)
14248 (re-search-forward re nil t))
14249 (setq org-map-continue-from nil)
14250 (catch :skip
14251 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14252 tags (if (match-end 4) (org-match-string-no-properties 4)))
14253 (goto-char (setq lspos (match-beginning 0)))
14254 (setq level (org-reduced-level (org-outline-level))
14255 category (org-get-category))
14256 (when (eq action 'agenda)
14257 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14258 ts-date (car ts-date-pair)
14259 ts-date-type (cdr ts-date-pair)))
14260 (setq i llast llast level)
14261 ;; remove tag lists from same and sublevels
14262 (while (>= i level)
14263 (when (setq entry (assoc i tags-alist))
14264 (setq tags-alist (delete entry tags-alist)))
14265 (setq i (1- i)))
14266 ;; add the next tags
14267 (when tags
14268 (setq tags (org-split-string tags ":")
14269 tags-alist
14270 (cons (cons level tags) tags-alist)))
14271 ;; compile tags for current headline
14272 (setq tags-list
14273 (if org-use-tag-inheritance
14274 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14275 tags)
14276 org-scanner-tags tags-list)
14277 (when org-use-tag-inheritance
14278 (setcdr (car tags-alist)
14279 (mapcar (lambda (x)
14280 (setq x (copy-sequence x))
14281 (org-add-prop-inherited x))
14282 (cdar tags-alist))))
14283 (when (and tags org-use-tag-inheritance
14284 (or (not (eq t org-use-tag-inheritance))
14285 org-tags-exclude-from-inheritance))
14286 ;; selective inheritance, remove uninherited ones
14287 (setcdr (car tags-alist)
14288 (org-remove-uninherited-tags (cdar tags-alist))))
14289 (when (and
14291 ;; eval matcher only when the todo condition is OK
14292 (and (or (not todo-only) (member todo org-not-done-keywords))
14293 (let ((case-fold-search t) (org-trust-scanner-tags t))
14294 (eval matcher)))
14296 ;; Call the skipper, but return t if it does not skip,
14297 ;; so that the `and' form continues evaluating
14298 (progn
14299 (unless (eq action 'sparse-tree) (org-agenda-skip))
14302 ;; Check if timestamps are deselecting this entry
14303 (or (not todo-only)
14304 (and (member todo org-not-done-keywords)
14305 (or (not org-agenda-tags-todo-honor-ignore-options)
14306 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14308 ;; select this headline
14309 (cond
14310 ((eq action 'sparse-tree)
14311 (and org-highlight-sparse-tree-matches
14312 (org-get-heading) (match-end 0)
14313 (org-highlight-new-match
14314 (match-beginning 1) (match-end 1)))
14315 (org-show-context 'tags-tree))
14316 ((eq action 'agenda)
14317 (setq txt (org-agenda-format-item
14319 (concat
14320 (if (eq org-tags-match-list-sublevels 'indented)
14321 (make-string (1- level) ?.) "")
14322 (org-get-heading))
14323 (make-string level ?\s)
14324 category
14325 tags-list)
14326 priority (org-get-priority txt))
14327 (goto-char lspos)
14328 (setq marker (org-agenda-new-marker))
14329 (org-add-props txt props
14330 'org-marker marker 'org-hd-marker marker 'org-category category
14331 'todo-state todo
14332 'ts-date ts-date
14333 'priority priority
14334 'type (concat "tagsmatch" ts-date-type))
14335 (push txt rtn))
14336 ((functionp action)
14337 (setq org-map-continue-from nil)
14338 (save-excursion
14339 (setq rtn1 (funcall action))
14340 (push rtn1 rtn)))
14341 (t (user-error "Invalid action")))
14343 ;; if we are to skip sublevels, jump to end of subtree
14344 (unless org-tags-match-list-sublevels
14345 (org-end-of-subtree t)
14346 (backward-char 1))))
14347 ;; Get the correct position from where to continue
14348 (if org-map-continue-from
14349 (goto-char org-map-continue-from)
14350 (and (= (point) lspos) (end-of-line 1)))))
14351 (when (and (eq action 'sparse-tree)
14352 (not org-sparse-tree-open-archived-trees))
14353 (org-hide-archived-subtrees (point-min) (point-max)))
14354 (nreverse rtn)))
14356 (defun org-remove-uninherited-tags (tags)
14357 "Remove all tags that are not inherited from the list TAGS."
14358 (cond
14359 ((eq org-use-tag-inheritance t)
14360 (if org-tags-exclude-from-inheritance
14361 (org-delete-all org-tags-exclude-from-inheritance tags)
14362 tags))
14363 ((not org-use-tag-inheritance) nil)
14364 ((stringp org-use-tag-inheritance)
14365 (delq nil (mapcar
14366 (lambda (x)
14367 (if (and (string-match org-use-tag-inheritance x)
14368 (not (member x org-tags-exclude-from-inheritance)))
14369 x nil))
14370 tags)))
14371 ((listp org-use-tag-inheritance)
14372 (delq nil (mapcar
14373 (lambda (x)
14374 (if (member x org-use-tag-inheritance) x nil))
14375 tags)))))
14377 (defun org-match-sparse-tree (&optional todo-only match)
14378 "Create a sparse tree according to tags string MATCH.
14379 MATCH can contain positive and negative selection of tags, like
14380 \"+WORK+URGENT-WITHBOSS\".
14381 If optional argument TODO-ONLY is non-nil, only select lines that are
14382 also TODO lines."
14383 (interactive "P")
14384 (org-agenda-prepare-buffers (list (current-buffer)))
14385 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14387 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14389 (defvar org-cached-props nil)
14390 (defun org-cached-entry-get (pom property)
14391 (if (or (eq t org-use-property-inheritance)
14392 (and (stringp org-use-property-inheritance)
14393 (let ((case-fold-search t))
14394 (org-string-match-p org-use-property-inheritance property)))
14395 (and (listp org-use-property-inheritance)
14396 (member-ignore-case property org-use-property-inheritance)))
14397 ;; Caching is not possible, check it directly.
14398 (org-entry-get pom property 'inherit)
14399 ;; Get all properties, so we can do complicated checks easily.
14400 (cdr (assoc-string property
14401 (or org-cached-props
14402 (setq org-cached-props (org-entry-properties pom)))
14403 t))))
14405 (defun org-global-tags-completion-table (&optional files)
14406 "Return the list of all tags in all agenda buffer/files.
14407 Optional FILES argument is a list of files which can be used
14408 instead of the agenda files."
14409 (save-excursion
14410 (org-uniquify
14411 (delq nil
14412 (apply 'append
14413 (mapcar
14414 (lambda (file)
14415 (set-buffer (find-file-noselect file))
14416 (append (org-get-buffer-tags)
14417 (mapcar (lambda (x) (if (stringp (car-safe x))
14418 (list (car-safe x)) nil))
14419 org-tag-alist)))
14420 (if (and files (car files))
14421 files
14422 (org-agenda-files))))))))
14424 (defun org-make-tags-matcher (match)
14425 "Create the TAGS/TODO matcher form for the selection string MATCH.
14427 The variable `todo-only' is scoped dynamically into this function.
14428 It will be set to t if the matcher restricts matching to TODO entries,
14429 otherwise will not be touched.
14431 Returns a cons of the selection string MATCH and the constructed
14432 lisp form implementing the matcher. The matcher is to be evaluated
14433 at an Org entry, with point on the headline, and returns t if the
14434 entry matches the selection string MATCH. The returned lisp form
14435 references two variables with information about the entry, which
14436 must be bound around the form's evaluation: todo, the TODO keyword
14437 at the entry (or nil of none); and tags-list, the list of all tags
14438 at the entry including inherited ones. Additionally, the category
14439 of the entry (if any) must be specified as the text property
14440 'org-category on the headline.
14442 See also `org-scan-tags'.
14444 (declare (special todo-only))
14445 (unless (boundp 'todo-only)
14446 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14447 (unless match
14448 ;; Get a new match request, with completion against the global
14449 ;; tags table and the local tags in current buffer
14450 (let ((org-last-tags-completion-table
14451 (org-uniquify
14452 (delq nil (append (org-get-buffer-tags)
14453 (org-global-tags-completion-table))))))
14454 (setq match (org-completing-read-no-i
14455 "Match: " 'org-tags-completion-function nil nil nil
14456 'org-tags-history))))
14458 ;; Parse the string and create a lisp form
14459 (let ((match0 match)
14460 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14461 minus tag mm
14462 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14463 orterms term orlist re-p str-p level-p level-op time-p
14464 prop-p pn pv po gv rest (start 0) (ss 0))
14465 ;; Expand group tags
14466 (setq match (org-tags-expand match))
14468 ;; Check if there is a TODO part of this match, which would be the
14469 ;; part after a "/". TO make sure that this slash is not part of
14470 ;; a property value to be matched against, we also check that there
14471 ;; is no " after that slash.
14472 ;; First, find the last slash
14473 (while (string-match "/+" match ss)
14474 (setq start (match-beginning 0) ss (match-end 0)))
14475 (if (and (string-match "/+" match start)
14476 (not (save-match-data (string-match "\"" match start))))
14477 ;; match contains also a todo-matching request
14478 (progn
14479 (setq tagsmatch (substring match 0 (match-beginning 0))
14480 todomatch (substring match (match-end 0)))
14481 (if (string-match "^!" todomatch)
14482 (setq todo-only t todomatch (substring todomatch 1)))
14483 (if (string-match "^\\s-*$" todomatch)
14484 (setq todomatch nil)))
14485 ;; only matching tags
14486 (setq tagsmatch match todomatch nil))
14488 ;; Make the tags matcher
14489 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14490 (setq tagsmatcher t)
14491 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14492 (while (setq term (pop orterms))
14493 (while (and (equal (substring term -1) "\\") orterms)
14494 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14495 (while (string-match re term)
14496 (setq rest (substring term (match-end 0))
14497 minus (and (match-end 1)
14498 (equal (match-string 1 term) "-"))
14499 tag (save-match-data (replace-regexp-in-string
14500 "\\\\-" "-"
14501 (match-string 2 term)))
14502 re-p (equal (string-to-char tag) ?{)
14503 level-p (match-end 4)
14504 prop-p (match-end 5)
14505 mm (cond
14506 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14507 (level-p
14508 (setq level-op (org-op-to-function (match-string 3 term)))
14509 `(,level-op level ,(string-to-number
14510 (match-string 4 term))))
14511 (prop-p
14512 (setq pn (match-string 5 term)
14513 po (match-string 6 term)
14514 pv (match-string 7 term)
14515 re-p (equal (string-to-char pv) ?{)
14516 str-p (equal (string-to-char pv) ?\")
14517 time-p (save-match-data
14518 (string-match "^\"[[<].*[]>]\"$" pv))
14519 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14520 (if time-p (setq pv (org-matcher-time pv)))
14521 (setq po (org-op-to-function po (if time-p 'time str-p)))
14522 (cond
14523 ((equal pn "CATEGORY")
14524 (setq gv '(get-text-property (point) 'org-category)))
14525 ((equal pn "TODO")
14526 (setq gv 'todo))
14528 (setq gv `(org-cached-entry-get nil ,pn))))
14529 (if re-p
14530 (if (eq po 'org<>)
14531 `(not (string-match ,pv (or ,gv "")))
14532 `(string-match ,pv (or ,gv "")))
14533 (if str-p
14534 `(,po (or ,gv "") ,pv)
14535 `(,po (string-to-number (or ,gv ""))
14536 ,(string-to-number pv) ))))
14537 (t `(member ,tag tags-list)))
14538 mm (if minus (list 'not mm) mm)
14539 term rest)
14540 (push mm tagsmatcher))
14541 (push (if (> (length tagsmatcher) 1)
14542 (cons 'and tagsmatcher)
14543 (car tagsmatcher))
14544 orlist)
14545 (setq tagsmatcher nil))
14546 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14547 (setq tagsmatcher
14548 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14549 ;; Make the todo matcher
14550 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14551 (setq todomatcher t)
14552 (setq orterms (org-split-string todomatch "|") orlist nil)
14553 (dolist (term orterms)
14554 (while (string-match re term)
14555 (setq minus (and (match-end 1)
14556 (equal (match-string 1 term) "-"))
14557 kwd (match-string 2 term)
14558 re-p (equal (string-to-char kwd) ?{)
14559 term (substring term (match-end 0))
14560 mm (if re-p
14561 `(string-match ,(substring kwd 1 -1) todo)
14562 (list 'equal 'todo kwd))
14563 mm (if minus (list 'not mm) mm))
14564 (push mm todomatcher))
14565 (push (if (> (length todomatcher) 1)
14566 (cons 'and todomatcher)
14567 (car todomatcher))
14568 orlist)
14569 (setq todomatcher nil))
14570 (setq todomatcher (if (> (length orlist) 1)
14571 (cons 'or orlist) (car orlist))))
14573 ;; Return the string and lisp forms of the matcher
14574 (setq matcher (if todomatcher
14575 (list 'and tagsmatcher todomatcher)
14576 tagsmatcher))
14577 (when todo-only
14578 (setq matcher (list 'and '(member todo org-not-done-keywords)
14579 matcher)))
14580 (cons match0 matcher)))
14582 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14583 "Expand group tags in MATCH.
14585 This replaces every group tag in MATCH with a regexp tag search.
14586 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14587 will be replaced like this:
14589 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14590 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14591 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14593 Replacing by a regexp preserves the structure of the match.
14594 E.g., this expansion
14596 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14598 will match anything tagged with \"Lab\" and \"Home\", or tagged
14599 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14601 A group tag in MATCH can contain regular expressions of its own.
14602 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14603 will be replaced like this:
14605 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14607 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14608 assumed to be a single group tag, and the function will return
14609 the list of tags in this group.
14611 When DOWNCASE is non-nil, expand downcased TAGS."
14612 (if org-group-tags
14613 (let* ((case-fold-search t)
14614 (stable org-mode-syntax-table)
14615 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14616 (taggroups (if downcased
14617 (mapcar (lambda (tg) (mapcar #'downcase tg))
14618 taggroups)
14619 taggroups))
14620 (taggroups-keys (mapcar #'car taggroups))
14621 (return-match (if downcased (downcase match) match))
14622 (count 0)
14623 (work-already-expanded tags-already-expanded)
14624 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14625 ;; @ and _ are allowed as word-components in tags.
14626 (modify-syntax-entry ?@ "w" stable)
14627 (modify-syntax-entry ?_ "w" stable)
14628 ;; Temporarily replace regexp-expressions in the match-expression.
14629 (while (string-match "{.+?}" return-match)
14630 (incf count)
14631 (push (match-string 0 return-match) regexps-in-match)
14632 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14633 (while (and taggroups-keys
14634 (with-syntax-table stable
14635 (string-match
14636 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14637 (regexp-opt taggroups-keys) "\\>\\)")
14638 return-match)))
14639 (let* ((dir (match-string 1 return-match))
14640 (tag (match-string 2 return-match))
14641 (tag (if downcased (downcase tag) tag)))
14642 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14643 (member tag work-already-expanded))
14644 (setq tags-in-group (assoc tag taggroups))
14645 (push tag work-already-expanded)
14646 ;; Recursively expand each tag in the group, if the tag hasn't
14647 ;; already been expanded. Restore the match-data after all recursive calls.
14648 (save-match-data
14649 (let (tags-expanded)
14650 (dolist (x (cdr tags-in-group))
14651 (if (and (member x taggroups-keys)
14652 (not (member x work-already-expanded)))
14653 (setq tags-expanded
14654 (delete-dups
14655 (append
14656 (org-tags-expand x t downcased
14657 work-already-expanded)
14658 tags-expanded)))
14659 (setq tags-expanded
14660 (append (list x) tags-expanded)))
14661 (setq work-already-expanded
14662 (delete-dups
14663 (append tags-expanded
14664 work-already-expanded))))
14665 (setq tags-in-group
14666 (delete-dups (cons (car tags-in-group)
14667 tags-expanded)))))
14668 ;; Filter tag-regexps from tags.
14669 (setq regexp-in-group-escaped
14670 (delq nil (mapcar (lambda (x)
14671 (if (stringp x)
14672 (and (equal "{" (substring x 0 1))
14673 (equal "}" (substring x -1))
14676 tags-in-group))
14677 regexp-in-group
14678 (mapcar (lambda (x)
14679 (substring x 1 -1))
14680 regexp-in-group-escaped)
14681 tags-in-group
14682 (delq nil (mapcar (lambda (x)
14683 (if (stringp x)
14684 (and (not (equal "{" (substring x 0 1)))
14685 (not (equal "}" (substring x -1)))
14688 tags-in-group)))
14689 ;; If single-as-list, do no more in the while-loop.
14690 (if (not single-as-list)
14691 (progn
14692 (when regexp-in-group
14693 (setq regexp-in-group
14694 (concat "\\|"
14695 (mapconcat 'identity regexp-in-group
14696 "\\|"))))
14697 (setq tags-in-group
14698 (concat dir
14699 "{\\<"
14700 (regexp-opt tags-in-group)
14701 "\\>"
14702 regexp-in-group
14703 "}"))
14704 (when (stringp tags-in-group)
14705 (org-add-props tags-in-group '(grouptag t)))
14706 (setq return-match
14707 (replace-match tags-in-group t t return-match)))
14708 (setq tags-in-group
14709 (append regexp-in-group-escaped tags-in-group))))
14710 (setq taggroups-keys (delete tag taggroups-keys))))
14711 ;; Add the regular expressions back into the match-expression again.
14712 (while regexps-in-match
14713 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14714 (pop regexps-in-match)
14715 return-match t t))
14716 (decf count))
14717 (if single-as-list
14718 (if tags-in-group tags-in-group (list return-match))
14719 return-match))
14720 (if single-as-list
14721 (list (if downcased (downcase match) match))
14722 match)))
14724 (defun org-op-to-function (op &optional stringp)
14725 "Turn an operator into the appropriate function."
14726 (setq op
14727 (cond
14728 ((equal op "<" ) '(< string< org-time<))
14729 ((equal op ">" ) '(> org-string> org-time>))
14730 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14731 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14732 ((member op '("=" "==")) '(= string= org-time=))
14733 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14734 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14736 (defun org<> (a b) (not (= a b)))
14737 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14738 (defun org-string>= (a b) (not (string< a b)))
14739 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14740 (defun org-string<> (a b) (not (string= a b)))
14741 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14742 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14743 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14744 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14745 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14746 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14747 (defun org-2ft (s)
14748 "Convert S to a floating point time.
14749 If S is already a number, just return it. If it is a string, parse
14750 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14751 (cond
14752 ((numberp s) s)
14753 ((stringp s)
14754 (condition-case nil
14755 (float-time (apply 'encode-time (org-parse-time-string s)))
14756 (error 0.)))
14757 (t 0.)))
14759 (defun org-time-today ()
14760 "Time in seconds today at 0:00.
14761 Returns the float number of seconds since the beginning of the
14762 epoch to the beginning of today (00:00)."
14763 (float-time (apply 'encode-time
14764 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14766 (defun org-matcher-time (s)
14767 "Interpret a time comparison value."
14768 (save-match-data
14769 (cond
14770 ((string= s "<now>") (float-time))
14771 ((string= s "<today>") (org-time-today))
14772 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14773 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14774 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14775 (+ (org-time-today)
14776 (* (string-to-number (match-string 1 s))
14777 (cdr (assoc (match-string 2 s)
14778 '(("d" . 86400.0) ("w" . 604800.0)
14779 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14780 (t (org-2ft s)))))
14782 (defun org-match-any-p (re list)
14783 "Does re match any element of list?"
14784 (setq list (mapcar (lambda (x) (string-match re x)) list))
14785 (delq nil list))
14787 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14788 (defvar org-tags-overlay (make-overlay 1 1))
14789 (org-detach-overlay org-tags-overlay)
14791 (defun org-get-local-tags-at (&optional pos)
14792 "Get a list of tags defined in the current headline."
14793 (org-get-tags-at pos 'local))
14795 (defun org-get-local-tags ()
14796 "Get a list of tags defined in the current headline."
14797 (org-get-tags-at nil 'local))
14799 (defun org-get-tags-at (&optional pos local)
14800 "Get a list of all headline tags applicable at POS.
14801 POS defaults to point. If tags are inherited, the list contains
14802 the targets in the same sequence as the headlines appear, i.e.
14803 the tags of the current headline come last.
14804 When LOCAL is non-nil, only return tags from the current headline,
14805 ignore inherited ones."
14806 (interactive)
14807 (if (and org-trust-scanner-tags
14808 (or (not pos) (equal pos (point)))
14809 (not local))
14810 org-scanner-tags
14811 (let (tags ltags lastpos parent)
14812 (save-excursion
14813 (save-restriction
14814 (widen)
14815 (goto-char (or pos (point)))
14816 (save-match-data
14817 (catch 'done
14818 (condition-case nil
14819 (progn
14820 (org-back-to-heading t)
14821 (while (not (equal lastpos (point)))
14822 (setq lastpos (point))
14823 (when (looking-at
14824 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14825 (setq ltags (org-split-string
14826 (org-match-string-no-properties 1) ":"))
14827 (when parent
14828 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14829 (setq tags (append
14830 (if parent
14831 (org-remove-uninherited-tags ltags)
14832 ltags)
14833 tags)))
14834 (or org-use-tag-inheritance (throw 'done t))
14835 (if local (throw 'done t))
14836 (or (org-up-heading-safe) (error nil))
14837 (setq parent t)))
14838 (error nil)))))
14839 (if local
14840 tags
14841 (reverse (delete-dups
14842 (reverse (append
14843 (org-remove-uninherited-tags
14844 org-file-tags)
14845 tags)))))))))
14847 (defun org-add-prop-inherited (s)
14848 (add-text-properties 0 (length s) '(inherited t) s)
14851 (defun org-toggle-tag (tag &optional onoff)
14852 "Toggle the tag TAG for the current line.
14853 If ONOFF is `on' or `off', don't toggle but set to this state."
14854 (let (res current)
14855 (save-excursion
14856 (org-back-to-heading t)
14857 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14858 (point-at-eol) t)
14859 (progn
14860 (setq current (match-string 1))
14861 (replace-match ""))
14862 (setq current ""))
14863 (setq current (nreverse (org-split-string current ":")))
14864 (cond
14865 ((eq onoff 'on)
14866 (setq res t)
14867 (or (member tag current) (push tag current)))
14868 ((eq onoff 'off)
14869 (or (not (member tag current)) (setq current (delete tag current))))
14870 (t (if (member tag current)
14871 (setq current (delete tag current))
14872 (setq res t)
14873 (push tag current))))
14874 (end-of-line 1)
14875 (if current
14876 (progn
14877 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14878 (org-set-tags nil t))
14879 (delete-horizontal-space))
14880 (run-hooks 'org-after-tags-change-hook))
14881 res))
14883 (defun org-align-tags-here (to-col)
14884 ;; Assumes that this is a headline
14885 "Align tags on the current headline to TO-COL."
14886 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14887 (beginning-of-line 1)
14888 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14889 (< pos (match-beginning 2)))
14890 (progn
14891 (setq tags-l (- (match-end 2) (match-beginning 2)))
14892 (goto-char (match-beginning 1))
14893 (insert " ")
14894 (delete-region (point) (1+ (match-beginning 2)))
14895 (setq ncol (max (current-column)
14896 (1+ col)
14897 (if (> to-col 0)
14898 to-col
14899 (- (abs to-col) tags-l))))
14900 (setq p (point))
14901 (insert (make-string (- ncol (current-column)) ?\ ))
14902 (setq ncol (current-column))
14903 (when indent-tabs-mode (tabify p (point-at-eol)))
14904 (org-move-to-column (min ncol col)))
14905 (goto-char pos))))
14907 (defun org-set-tags-command (&optional arg just-align)
14908 "Call the set-tags command for the current entry."
14909 (interactive "P")
14910 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14911 (org-set-tags arg just-align)
14912 (save-excursion
14913 (unless (and (org-region-active-p)
14914 org-loop-over-headlines-in-active-region)
14915 (org-back-to-heading t))
14916 (org-set-tags arg just-align))))
14918 (defun org-set-tags-to (data)
14919 "Set the tags of the current entry to DATA, replacing the current tags.
14920 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14921 If DATA is nil or the empty string, any tags will be removed."
14922 (interactive "sTags: ")
14923 (setq data
14924 (cond
14925 ((eq data nil) "")
14926 ((equal data "") "")
14927 ((stringp data)
14928 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14929 ":"))
14930 ((listp data)
14931 (concat ":" (mapconcat 'identity data ":") ":"))))
14932 (when data
14933 (save-excursion
14934 (org-back-to-heading t)
14935 (when (looking-at org-complex-heading-regexp)
14936 (if (match-end 5)
14937 (progn
14938 (goto-char (match-beginning 5))
14939 (insert data)
14940 (delete-region (point) (point-at-eol))
14941 (org-set-tags nil 'align))
14942 (goto-char (point-at-eol))
14943 (insert " " data)
14944 (org-set-tags nil 'align)))
14945 (beginning-of-line 1)
14946 (if (looking-at ".*?\\([ \t]+\\)$")
14947 (delete-region (match-beginning 1) (match-end 1))))))
14949 (defun org-align-all-tags ()
14950 "Align the tags i all headings."
14951 (interactive)
14952 (save-excursion
14953 (or (ignore-errors (org-back-to-heading t))
14954 (outline-next-heading))
14955 (if (org-at-heading-p)
14956 (org-set-tags t)
14957 (message "No headings"))))
14959 (defvar org-indent-indentation-per-level)
14960 (defun org-set-tags (&optional arg just-align)
14961 "Set the tags for the current headline.
14962 With prefix ARG, realign all tags in headings in the current buffer.
14963 When JUST-ALIGN is non-nil, only align tags."
14964 (interactive "P")
14965 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14966 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14967 'region-start-level
14968 'region))
14969 org-loop-over-headlines-in-active-region)
14970 (org-map-entries
14971 ;; We don't use ARG and JUST-ALIGN here because these args
14972 ;; are not useful when looping over headlines.
14973 #'org-set-tags
14974 org-loop-over-headlines-in-active-region
14976 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14977 (let ((org-setting-tags t))
14978 (if arg
14979 (save-excursion
14980 (goto-char (point-min))
14981 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14982 (while (re-search-forward org-outline-regexp-bol nil t)
14983 (org-set-tags nil t)
14984 (end-of-line)))
14985 (message "All tags realigned to column %d" org-tags-column))
14986 (let* ((current (org-get-tags-string))
14987 (col (current-column))
14988 (tags
14989 (if just-align current
14990 ;; Get a new set of tags from the user.
14991 (save-excursion
14992 (let* ((table
14993 (setq
14994 org-last-tags-completion-table
14995 (append
14996 org-tag-persistent-alist
14997 (or org-tag-alist (org-get-buffer-tags))
14998 (and
14999 org-complete-tags-always-offer-all-agenda-tags
15000 (org-global-tags-completion-table
15001 (org-agenda-files))))))
15002 (current-tags (org-split-string current ":"))
15003 (inherited-tags
15004 (nreverse (nthcdr (length current-tags)
15005 (nreverse (org-get-tags-at))))))
15006 (replace-regexp-in-string
15007 "\\([-+&]+\\|,\\)"
15009 (if (or (eq t org-use-fast-tag-selection)
15010 (and org-use-fast-tag-selection
15011 (delq nil (mapcar #'cdr table))))
15012 (org-fast-tag-selection
15013 current-tags inherited-tags table
15014 (and org-fast-tag-selection-include-todo
15015 org-todo-key-alist))
15016 (let ((org-add-colon-after-tag-completion
15017 (< 1 (length table))))
15018 (org-trim
15019 (completing-read
15020 "Tags: "
15021 #'org-tags-completion-function
15022 nil nil current 'org-tags-history))))))))))
15024 (when org-tags-sort-function
15025 (setq tags
15026 (mapconcat
15027 #'identity
15028 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15029 org-tags-sort-function)
15030 ":")))
15032 (if (not (org-string-nw-p tags)) (setq tags "")
15033 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15034 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15036 ;; Insert new tags at the correct column
15037 (beginning-of-line)
15038 (let ((level (if (looking-at org-outline-regexp)
15039 (- (match-end 0) (point) 1)
15040 1)))
15041 (cond
15042 ((and (equal current "") (equal tags "")))
15043 ((re-search-forward
15044 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15045 (line-end-position)
15047 (if (equal tags "") (replace-match "" t t)
15048 (goto-char (match-beginning 0))
15049 (let* ((c0 (current-column))
15050 ;; Compute offset for the case of org-indent-mode
15051 ;; active.
15052 (di (if (org-bound-and-true-p org-indent-mode)
15053 (* (1- org-indent-indentation-per-level)
15054 (1- level))
15056 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15057 (tc (+ org-tags-column
15058 (if (> org-tags-column 0) (- di) di)))
15059 (c1 (max (1+ c0)
15060 (if (> tc 0) tc
15061 (- (- tc) (string-width tags)))))
15062 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15063 (replace-match rpl t t)
15064 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15065 (tabify p0 (point))))))
15066 (t (error "Tags alignment failed"))))
15067 (org-move-to-column col))
15068 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15070 (defun org-change-tag-in-region (beg end tag off)
15071 "Add or remove TAG for each entry in the region.
15072 This works in the agenda, and also in an org-mode buffer."
15073 (interactive
15074 (list (region-beginning) (region-end)
15075 (let ((org-last-tags-completion-table
15076 (if (derived-mode-p 'org-mode)
15077 (org-uniquify
15078 (delq nil (append (org-get-buffer-tags)
15079 (org-global-tags-completion-table))))
15080 (org-global-tags-completion-table))))
15081 (org-icompleting-read
15082 "Tag: " 'org-tags-completion-function nil nil nil
15083 'org-tags-history))
15084 (progn
15085 (message "[s]et or [r]emove? ")
15086 (equal (read-char-exclusive) ?r))))
15087 (if (fboundp 'deactivate-mark) (deactivate-mark))
15088 (let ((agendap (equal major-mode 'org-agenda-mode))
15089 l1 l2 m buf pos newhead (cnt 0))
15090 (goto-char end)
15091 (setq l2 (1- (org-current-line)))
15092 (goto-char beg)
15093 (setq l1 (org-current-line))
15094 (loop for l from l1 to l2 do
15095 (org-goto-line l)
15096 (setq m (get-text-property (point) 'org-hd-marker))
15097 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15098 (and agendap m))
15099 (setq buf (if agendap (marker-buffer m) (current-buffer))
15100 pos (if agendap m (point)))
15101 (with-current-buffer buf
15102 (save-excursion
15103 (save-restriction
15104 (goto-char pos)
15105 (setq cnt (1+ cnt))
15106 (org-toggle-tag tag (if off 'off 'on))
15107 (setq newhead (org-get-heading)))))
15108 (and agendap (org-agenda-change-all-lines newhead m))))
15109 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15111 (defun org-tags-completion-function (string predicate &optional flag)
15112 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15113 (confirm (lambda (x) (stringp (car x)))))
15114 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15115 (setq s1 (match-string 1 string)
15116 s2 (match-string 2 string))
15117 (setq s1 "" s2 string))
15118 (cond
15119 ((eq flag nil)
15120 ;; try completion
15121 (setq rtn (try-completion s2 ctable confirm))
15122 (if (stringp rtn)
15123 (setq rtn
15124 (concat s1 s2 (substring rtn (length s2))
15125 (if (and org-add-colon-after-tag-completion
15126 (assoc rtn ctable))
15127 ":" ""))))
15128 rtn)
15129 ((eq flag t)
15130 ;; all-completions
15131 (all-completions s2 ctable confirm))
15132 ((eq flag 'lambda)
15133 ;; exact match?
15134 (assoc s2 ctable)))))
15136 (defun org-fast-tag-insert (kwd tags face &optional end)
15137 "Insert KDW, and the TAGS, the latter with face FACE.
15138 Also insert END."
15139 (insert (format "%-12s" (concat kwd ":"))
15140 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15141 (or end "")))
15143 (defun org-fast-tag-show-exit (flag)
15144 (save-excursion
15145 (org-goto-line 3)
15146 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15147 (replace-match ""))
15148 (when flag
15149 (end-of-line 1)
15150 (org-move-to-column (- (window-width) 19) t)
15151 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15153 (defun org-set-current-tags-overlay (current prefix)
15154 "Add an overlay to CURRENT tag with PREFIX."
15155 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15156 (if (featurep 'xemacs)
15157 (org-overlay-display org-tags-overlay (concat prefix s)
15158 'secondary-selection)
15159 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15160 (org-overlay-display org-tags-overlay (concat prefix s)))))
15162 (defvar org-last-tag-selection-key nil)
15163 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15164 "Fast tag selection with single keys.
15165 CURRENT is the current list of tags in the headline, INHERITED is the
15166 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15167 possibly with grouping information. TODO-TABLE is a similar table with
15168 TODO keywords, should these have keys assigned to them.
15169 If the keys are nil, a-z are automatically assigned.
15170 Returns the new tags string, or nil to not change the current settings."
15171 (let* ((fulltable (append table todo-table))
15172 (maxlen (apply 'max (mapcar
15173 (lambda (x)
15174 (if (stringp (car x)) (string-width (car x)) 0))
15175 fulltable)))
15176 (buf (current-buffer))
15177 (expert (eq org-fast-tag-selection-single-key 'expert))
15178 (buffer-tags nil)
15179 (fwidth (+ maxlen 3 1 3))
15180 (ncol (/ (- (window-width) 4) fwidth))
15181 (i-face 'org-done)
15182 (c-face 'org-todo)
15183 tg cnt e c char c1 c2 ntable tbl rtn
15184 ov-start ov-end ov-prefix
15185 (exit-after-next org-fast-tag-selection-single-key)
15186 (done-keywords org-done-keywords)
15187 groups ingroup intaggroup)
15188 (save-excursion
15189 (beginning-of-line 1)
15190 (if (looking-at
15191 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15192 (setq ov-start (match-beginning 1)
15193 ov-end (match-end 1)
15194 ov-prefix "")
15195 (setq ov-start (1- (point-at-eol))
15196 ov-end (1+ ov-start))
15197 (skip-chars-forward "^\n\r")
15198 (setq ov-prefix
15199 (concat
15200 (buffer-substring (1- (point)) (point))
15201 (if (> (current-column) org-tags-column)
15203 (make-string (- org-tags-column (current-column)) ?\ ))))))
15204 (move-overlay org-tags-overlay ov-start ov-end)
15205 (save-window-excursion
15206 (if expert
15207 (set-buffer (get-buffer-create " *Org tags*"))
15208 (delete-other-windows)
15209 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15210 (org-switch-to-buffer-other-window " *Org tags*"))
15211 (erase-buffer)
15212 (org-set-local 'org-done-keywords done-keywords)
15213 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15214 (org-fast-tag-insert "Current" current c-face "\n\n")
15215 (org-fast-tag-show-exit exit-after-next)
15216 (org-set-current-tags-overlay current ov-prefix)
15217 (setq tbl fulltable char ?a cnt 0)
15218 (while (setq e (pop tbl))
15219 (cond
15220 ((eq (car e) :startgroup)
15221 (push '() groups) (setq ingroup t)
15222 (unless (zerop cnt)
15223 (setq cnt 0)
15224 (insert "\n"))
15225 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15226 ((eq (car e) :endgroup)
15227 (setq ingroup nil cnt 0)
15228 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15229 ((eq (car e) :startgrouptag)
15230 (setq intaggroup t)
15231 (unless (zerop cnt)
15232 (setq cnt 0)
15233 (insert "\n"))
15234 (insert "[ "))
15235 ((eq (car e) :endgrouptag)
15236 (setq intaggroup nil cnt 0)
15237 (insert "]\n"))
15238 ((equal e '(:newline))
15239 (unless (zerop cnt)
15240 (setq cnt 0)
15241 (insert "\n")
15242 (setq e (car tbl))
15243 (while (equal (car tbl) '(:newline))
15244 (insert "\n")
15245 (setq tbl (cdr tbl)))))
15246 ((equal e '(:grouptags)) (insert " : "))
15248 (setq tg (copy-sequence (car e)) c2 nil)
15249 (if (cdr e)
15250 (setq c (cdr e))
15251 ;; automatically assign a character.
15252 (setq c1 (string-to-char
15253 (downcase (substring
15254 tg (if (= (string-to-char tg) ?@) 1 0)))))
15255 (if (or (rassoc c1 ntable) (rassoc c1 table))
15256 (while (or (rassoc char ntable) (rassoc char table))
15257 (setq char (1+ char)))
15258 (setq c2 c1))
15259 (setq c (or c2 char)))
15260 (when ingroup (push tg (car groups)))
15261 (setq tg (org-add-props tg nil 'face
15262 (cond
15263 ((not (assoc tg table))
15264 (org-get-todo-face tg))
15265 ((member tg current) c-face)
15266 ((member tg inherited) i-face))))
15267 (when (equal (caar tbl) :grouptags)
15268 (org-add-props tg nil 'face 'org-tag-group))
15269 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15270 (insert "[" c "] " tg (make-string
15271 (- fwidth 4 (length tg)) ?\ ))
15272 (push (cons tg c) ntable)
15273 (when (= (incf cnt) ncol)
15274 (insert "\n")
15275 (when (or ingroup intaggroup) (insert " "))
15276 (setq cnt 0)))))
15277 (setq ntable (nreverse ntable))
15278 (insert "\n")
15279 (goto-char (point-min))
15280 (unless expert (org-fit-window-to-buffer))
15281 (setq rtn
15282 (catch 'exit
15283 (while t
15284 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15285 (if (not groups) "no " "")
15286 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15287 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15288 (setq org-last-tag-selection-key c)
15289 (cond
15290 ((= c ?\r) (throw 'exit t))
15291 ((= c ?!)
15292 (setq groups (not groups))
15293 (goto-char (point-min))
15294 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15295 ((= c ?\C-c)
15296 (if (not expert)
15297 (org-fast-tag-show-exit
15298 (setq exit-after-next (not exit-after-next)))
15299 (setq expert nil)
15300 (delete-other-windows)
15301 (set-window-buffer (split-window-vertically) " *Org tags*")
15302 (org-switch-to-buffer-other-window " *Org tags*")
15303 (org-fit-window-to-buffer)))
15304 ((or (= c ?\C-g)
15305 (and (= c ?q) (not (rassoc c ntable))))
15306 (org-detach-overlay org-tags-overlay)
15307 (setq quit-flag t))
15308 ((= c ?\ )
15309 (setq current nil)
15310 (when exit-after-next (setq exit-after-next 'now)))
15311 ((= c ?\t)
15312 (condition-case nil
15313 (setq tg (org-icompleting-read
15314 "Tag: "
15315 (or buffer-tags
15316 (with-current-buffer buf
15317 (setq buffer-tags
15318 (org-get-buffer-tags))))))
15319 (quit (setq tg "")))
15320 (when (string-match "\\S-" tg)
15321 (add-to-list 'buffer-tags (list tg))
15322 (if (member tg current)
15323 (setq current (delete tg current))
15324 (push tg current)))
15325 (when exit-after-next (setq exit-after-next 'now)))
15326 ((setq e (rassoc c todo-table) tg (car e))
15327 (with-current-buffer buf
15328 (save-excursion (org-todo tg)))
15329 (when exit-after-next (setq exit-after-next 'now)))
15330 ((setq e (rassoc c ntable) tg (car e))
15331 (if (member tg current)
15332 (setq current (delete tg current))
15333 (loop for g in groups do
15334 (when (member tg g)
15335 (dolist (x g) (setq current (delete x current)))))
15336 (push tg current))
15337 (when exit-after-next (setq exit-after-next 'now))))
15339 ;; Create a sorted list
15340 (setq current
15341 (sort current
15342 (lambda (a b)
15343 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15344 (when (eq exit-after-next 'now) (throw 'exit t))
15345 (goto-char (point-min))
15346 (beginning-of-line 2)
15347 (delete-region (point) (point-at-eol))
15348 (org-fast-tag-insert "Current" current c-face)
15349 (org-set-current-tags-overlay current ov-prefix)
15350 (while (re-search-forward
15351 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15352 (setq tg (match-string 1))
15353 (add-text-properties
15354 (match-beginning 1) (match-end 1)
15355 (list 'face
15356 (cond
15357 ((member tg current) c-face)
15358 ((member tg inherited) i-face)
15359 (t (get-text-property (match-beginning 1) 'face))))))
15360 (goto-char (point-min)))))
15361 (org-detach-overlay org-tags-overlay)
15362 (if rtn
15363 (mapconcat 'identity current ":")
15364 nil))))
15366 (defun org-get-tags-string ()
15367 "Get the TAGS string in the current headline."
15368 (unless (org-at-heading-p t)
15369 (user-error "Not on a heading"))
15370 (save-excursion
15371 (beginning-of-line 1)
15372 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15373 (org-match-string-no-properties 1)
15374 "")))
15376 (defun org-get-tags ()
15377 "Get the list of tags specified in the current headline."
15378 (org-split-string (org-get-tags-string) ":"))
15380 (defun org-get-buffer-tags ()
15381 "Get a table of all tags used in the buffer, for completion."
15382 (org-with-wide-buffer
15383 (goto-char (point-min))
15384 (let ((tag-re (concat org-outline-regexp-bol
15385 "\\(?:.*?[ \t]\\)?"
15386 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15387 tags)
15388 (while (re-search-forward tag-re nil t)
15389 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15390 (push tag tags)))
15391 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15393 ;;;; The mapping API
15395 (defun org-map-entries (func &optional match scope &rest skip)
15396 "Call FUNC at each headline selected by MATCH in SCOPE.
15398 FUNC is a function or a lisp form. The function will be called without
15399 arguments, with the cursor positioned at the beginning of the headline.
15400 The return values of all calls to the function will be collected and
15401 returned as a list.
15403 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15404 does not need to preserve point. After evaluation, the cursor will be
15405 moved to the end of the line (presumably of the headline of the
15406 processed entry) and search continues from there. Under some
15407 circumstances, this may not produce the wanted results. For example,
15408 if you have removed (e.g. archived) the current (sub)tree it could
15409 mean that the next entry will be skipped entirely. In such cases, you
15410 can specify the position from where search should continue by making
15411 FUNC set the variable `org-map-continue-from' to the desired buffer
15412 position.
15414 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15415 Only headlines that are matched by this query will be considered during
15416 the iteration. When MATCH is nil or t, all headlines will be
15417 visited by the iteration.
15419 SCOPE determines the scope of this command. It can be any of:
15421 nil The current buffer, respecting the restriction if any
15422 tree The subtree started with the entry at point
15423 region The entries within the active region, if any
15424 region-start-level
15425 The entries within the active region, but only those at
15426 the same level than the first one.
15427 file The current buffer, without restriction
15428 file-with-archives
15429 The current buffer, and any archives associated with it
15430 agenda All agenda files
15431 agenda-with-archives
15432 All agenda files with any archive files associated with them
15433 \(file1 file2 ...)
15434 If this is a list, all files in the list will be scanned
15436 The remaining args are treated as settings for the skipping facilities of
15437 the scanner. The following items can be given here:
15439 archive skip trees with the archive tag
15440 comment skip trees with the COMMENT keyword
15441 function or Emacs Lisp form:
15442 will be used as value for `org-agenda-skip-function', so
15443 whenever the function returns a position, FUNC will not be
15444 called for that entry and search will continue from the
15445 position returned
15447 If your function needs to retrieve the tags including inherited tags
15448 at the *current* entry, you can use the value of the variable
15449 `org-scanner-tags' which will be much faster than getting the value
15450 with `org-get-tags-at'. If your function gets properties with
15451 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15452 to t around the call to `org-entry-properties' to get the same speedup.
15453 Note that if your function moves around to retrieve tags and properties at
15454 a *different* entry, you cannot use these techniques."
15455 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15456 (not (org-region-active-p)))
15457 (let* ((org-agenda-archives-mode nil) ; just to make sure
15458 (org-agenda-skip-archived-trees (memq 'archive skip))
15459 (org-agenda-skip-comment-trees (memq 'comment skip))
15460 (org-agenda-skip-function
15461 (car (org-delete-all '(comment archive) skip)))
15462 (org-tags-match-list-sublevels t)
15463 (start-level (eq scope 'region-start-level))
15464 matcher file res
15465 org-todo-keywords-for-agenda
15466 org-done-keywords-for-agenda
15467 org-todo-keyword-alist-for-agenda
15468 org-tag-alist-for-agenda
15469 todo-only)
15471 (cond
15472 ((eq match t) (setq matcher t))
15473 ((eq match nil) (setq matcher t))
15474 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15476 (save-excursion
15477 (save-restriction
15478 (cond ((eq scope 'tree)
15479 (org-back-to-heading t)
15480 (org-narrow-to-subtree)
15481 (setq scope nil))
15482 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15483 (org-region-active-p))
15484 ;; If needed, set start-level to a string like "2"
15485 (when start-level
15486 (save-excursion
15487 (goto-char (region-beginning))
15488 (unless (org-at-heading-p) (outline-next-heading))
15489 (setq start-level (org-current-level))))
15490 (narrow-to-region (region-beginning)
15491 (save-excursion
15492 (goto-char (region-end))
15493 (unless (and (bolp) (org-at-heading-p))
15494 (outline-next-heading))
15495 (point)))
15496 (setq scope nil)))
15498 (if (not scope)
15499 (progn
15500 (org-agenda-prepare-buffers
15501 (and buffer-file-name (list buffer-file-name)))
15502 (setq res (org-scan-tags func matcher todo-only start-level)))
15503 ;; Get the right scope
15504 (cond
15505 ((and scope (listp scope) (symbolp (car scope)))
15506 (setq scope (eval scope)))
15507 ((eq scope 'agenda)
15508 (setq scope (org-agenda-files t)))
15509 ((eq scope 'agenda-with-archives)
15510 (setq scope (org-agenda-files t))
15511 (setq scope (org-add-archive-files scope)))
15512 ((eq scope 'file)
15513 (setq scope (and buffer-file-name (list buffer-file-name))))
15514 ((eq scope 'file-with-archives)
15515 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15516 (org-agenda-prepare-buffers scope)
15517 (dolist (file scope)
15518 (with-current-buffer (org-find-base-buffer-visiting file)
15519 (save-excursion
15520 (save-restriction
15521 (widen)
15522 (goto-char (point-min))
15523 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15524 res)))
15526 ;;; Properties API
15528 (defconst org-special-properties
15529 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15530 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15531 "The special properties valid in Org mode.
15532 These are properties that are not defined in the property drawer,
15533 but in some other way.")
15535 (defconst org-default-properties
15536 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15537 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15538 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15539 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15540 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15541 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15542 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15543 "Some properties that are used by Org mode for various purposes.
15544 Being in this list makes sure that they are offered for completion.")
15546 (defun org--update-property-plist (key val props)
15547 "Associate KEY to VAL in alist PROPS.
15548 Modifications are made by side-effect. Return new alist."
15549 (let* ((appending (string= (substring key -1) "+"))
15550 (key (if appending (substring key 0 -1) key))
15551 (old (assoc-string key props t)))
15552 (if (not old) (cons (cons key val) props)
15553 (setcdr old (if appending (concat (cdr old) " " val) val))
15554 props)))
15556 (defun org-get-property-block (&optional beg force)
15557 "Return the (beg . end) range of the body of the property drawer.
15558 BEG is the beginning of the current subtree, or of the part
15559 before the first headline. If it is not given, it will be found.
15560 If the drawer does not exist, create it if FORCE is non-nil, or
15561 return nil."
15562 (org-with-wide-buffer
15563 (when beg (goto-char beg))
15564 (unless (org-before-first-heading-p)
15565 (let ((beg (cond (beg)
15566 ((or (not (featurep 'org-inlinetask))
15567 (org-inlinetask-in-task-p))
15568 (org-back-to-heading t))
15569 (t (org-with-limited-levels (org-back-to-heading t))))))
15570 (forward-line)
15571 (when (org-looking-at-p org-planning-line-re) (forward-line))
15572 (cond ((looking-at org-property-drawer-re)
15573 (forward-line)
15574 (cons (point) (progn (goto-char (match-end 0))
15575 (line-beginning-position))))
15576 (force
15577 (goto-char beg)
15578 (org-insert-property-drawer)
15579 (let ((pos (save-excursion (search-forward ":END:")
15580 (line-beginning-position))))
15581 (cons pos pos))))))))
15583 (defun org-at-property-p ()
15584 "Non-nil when point is inside a property drawer.
15585 See `org-property-re' for match data, if applicable."
15586 (save-excursion
15587 (beginning-of-line)
15588 (and (looking-at org-property-re)
15589 (let ((property-drawer (save-match-data (org-get-property-block))))
15590 (and property-drawer
15591 (>= (point) (car property-drawer))
15592 (< (point) (cdr property-drawer)))))))
15594 (defun org-property-action ()
15595 "Do an action on properties."
15596 (interactive)
15597 (unless (org-at-property-p) (user-error "Not at a property"))
15598 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15599 (let ((c (read-char-exclusive)))
15600 (case c
15601 (?s (call-interactively #'org-set-property))
15602 (?d (call-interactively #'org-delete-property))
15603 (?D (call-interactively #'org-delete-property-globally))
15604 (?c (call-interactively #'org-compute-property-at-point))
15605 (otherwise (user-error "No such property action %c" c)))))
15607 (defun org-inc-effort ()
15608 "Increment the value of the effort property in the current entry."
15609 (interactive)
15610 (org-set-effort nil t))
15612 (defvar org-clock-effort) ; Defined in org-clock.el.
15613 (defvar org-clock-current-task) ; Defined in org-clock.el.
15614 (defun org-set-effort (&optional value increment)
15615 "Set the effort property of the current entry.
15616 With numerical prefix arg, use the nth allowed value, 0 stands for the
15617 10th allowed value.
15619 When INCREMENT is non-nil, set the property to the next allowed value."
15620 (interactive "P")
15621 (if (equal value 0) (setq value 10))
15622 (let* ((completion-ignore-case t)
15623 (prop org-effort-property)
15624 (cur (org-entry-get nil prop))
15625 (allowed (org-property-get-allowed-values nil prop 'table))
15626 (existing (mapcar 'list (org-property-values prop)))
15627 (heading (nth 4 (org-heading-components)))
15629 (val (cond
15630 ((stringp value) value)
15631 ((and allowed (integerp value))
15632 (or (car (nth (1- value) allowed))
15633 (car (org-last allowed))))
15634 ((and allowed increment)
15635 (or (caadr (member (list cur) allowed))
15636 (user-error "Allowed effort values are not set")))
15637 (allowed
15638 (message "Select 1-9,0, [RET%s]: %s"
15639 (if cur (concat "=" cur) "")
15640 (mapconcat 'car allowed " "))
15641 (setq rpl (read-char-exclusive))
15642 (if (equal rpl ?\r)
15644 (setq rpl (- rpl ?0))
15645 (if (equal rpl 0) (setq rpl 10))
15646 (if (and (> rpl 0) (<= rpl (length allowed)))
15647 (car (nth (1- rpl) allowed))
15648 (org-completing-read "Effort: " allowed nil))))
15650 (let (org-completion-use-ido org-completion-use-iswitchb)
15651 (org-completing-read
15652 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15653 (concat "[" cur "]") "")
15654 ": ")
15655 existing nil nil "" nil cur))))))
15656 (unless (equal (org-entry-get nil prop) val)
15657 (org-entry-put nil prop val))
15658 (org-refresh-property
15659 '((effort . identity)
15660 (effort-minutes . org-duration-string-to-minutes))
15661 val)
15662 (when (string= heading org-clock-current-task)
15663 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15664 (org-clock-update-mode-line))
15665 (message "%s is now %s" prop val)))
15667 (defun org-entry-properties (&optional pom which)
15668 "Get all properties of the current entry.
15670 When POM is a buffer position, get all properties from the entry
15671 there instead.
15673 This includes the TODO keyword, the tags, time strings for
15674 deadline, scheduled, and clocking, and any additional properties
15675 defined in the entry.
15677 If WHICH is nil or `all', get all properties. If WHICH is
15678 `special' or `standard', only get that subclass. If WHICH is
15679 a string, only get that property.
15681 Return value is an alist. Keys are properties, as upcased
15682 strings."
15683 (org-with-point-at pom
15684 (when (and (derived-mode-p 'org-mode)
15685 (ignore-errors (org-back-to-heading t)))
15686 (catch 'exit
15687 (let* ((beg (point))
15688 (specific (and (stringp which) (upcase which)))
15689 (which (cond ((not specific) which)
15690 ((member specific org-special-properties) 'special)
15691 (t 'standard)))
15692 props)
15693 ;; Get the special properties, like TODO and TAGS.
15694 (when (memq which '(nil all special))
15695 (when (or (not specific) (string= specific "CLOCKSUM"))
15696 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15697 (when clocksum
15698 (push (cons "CLOCKSUM"
15699 (org-columns-number-to-string
15700 (/ (float clocksum) 60.) 'add_times))
15701 props)))
15702 (when specific (throw 'exit props)))
15703 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15704 (let ((clocksumt (get-text-property (point)
15705 :org-clock-minutes-today)))
15706 (when clocksumt
15707 (push (cons "CLOCKSUM_T"
15708 (org-columns-number-to-string
15709 (/ (float clocksumt) 60.) 'add_times))
15710 props)))
15711 (when specific (throw 'exit props)))
15712 (when (or (not specific) (string= specific "ITEM"))
15713 (when (looking-at org-complex-heading-regexp)
15714 (push (cons "ITEM"
15715 (concat
15716 (org-match-string-no-properties 1)
15717 (let ((title (org-match-string-no-properties 4)))
15718 (when (org-string-nw-p title)
15719 (concat " " (org-remove-tabs title))))))
15720 props))
15721 (when specific (throw 'exit props)))
15722 (when (or (not specific) (string= specific "TODO"))
15723 (let ((case-fold-search nil))
15724 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15725 (push (cons "TODO" (org-match-string-no-properties 2)) props)))
15726 (when specific (throw 'exit props)))
15727 (when (or (not specific) (string= specific "PRIORITY"))
15728 (push (cons "PRIORITY"
15729 (if (looking-at org-priority-regexp)
15730 (org-match-string-no-properties 2)
15731 (char-to-string org-default-priority)))
15732 props)
15733 (when specific (throw 'exit props)))
15734 (when (or (not specific) (string= specific "FILE"))
15735 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15736 props)
15737 (when specific (throw 'exit props)))
15738 (when (or (not specific) (string= specific "TAGS"))
15739 (let ((value (org-string-nw-p (org-get-tags-string))))
15740 (when value (push (cons "TAGS" value) props)))
15741 (when specific (throw 'exit props)))
15742 (when (or (not specific) (string= specific "ALLTAGS"))
15743 (let ((value (org-get-tags-at)))
15744 (when value
15745 (push (cons "ALLTAGS"
15746 (format ":%s:" (mapconcat #'identity value ":")))
15747 props)))
15748 (when specific (throw 'exit props)))
15749 (when (or (not specific) (string= specific "BLOCKED"))
15750 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15751 (when specific (throw 'exit props)))
15752 (when (or (not specific)
15753 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15754 (forward-line)
15755 (when (org-looking-at-p org-planning-line-re)
15756 (end-of-line)
15757 (let ((bol (line-beginning-position))
15758 ;; Backward compatibility: time keywords used to
15759 ;; be configurable (before 8.3). Make sure we
15760 ;; get the correct keyword.
15761 (key-assoc `(("CLOSED" . ,org-closed-string)
15762 ("DEADLINE" . ,org-deadline-string)
15763 ("SCHEDULED" . ,org-scheduled-string))))
15764 (dolist (pair (if specific (list (assoc specific key-assoc))
15765 key-assoc))
15766 (save-excursion
15767 (when (search-backward (cdr pair) bol t)
15768 (goto-char (match-end 0))
15769 (skip-chars-forward " \t")
15770 (and (looking-at org-ts-regexp-both)
15771 (push (cons (car pair)
15772 (org-match-string-no-properties 0))
15773 props)))))))
15774 (when specific (throw 'exit props)))
15775 (when (or (not specific)
15776 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15777 (let ((find-ts
15778 (lambda (end ts)
15779 (let ((regexp (cond
15780 ((string= specific "TIMESTAMP")
15781 org-ts-regexp)
15782 ((string= specific "TIMESTAMP_IA")
15783 org-ts-regexp-inactive)
15784 ((assoc "TIMESTAMP_IA" ts)
15785 org-ts-regexp)
15786 ((assoc "TIMESTAMP" ts)
15787 org-ts-regexp-inactive)
15788 (t org-ts-regexp-both))))
15789 (catch 'next
15790 (while (re-search-forward regexp end t)
15791 (backward-char)
15792 (let ((object (org-element-context)))
15793 ;; Accept to match timestamps in node
15794 ;; properties, too.
15795 (when (memq (org-element-type object)
15796 '(node-property timestamp))
15797 (let ((type
15798 (org-element-property :type object)))
15799 (cond
15800 ((and (memq type '(active active-range))
15801 (not (equal specific "TIMESTAMP_IA")))
15802 (unless (assoc "TIMESTAMP" ts)
15803 (push (cons "TIMESTAMP"
15804 (org-element-property
15805 :raw-value object))
15807 (when specific (throw 'exit ts))))
15808 ((and (memq type '(inactive inactive-range))
15809 (not (string= specific "TIMESTAMP")))
15810 (unless (assoc "TIMESTAMP_IA" ts)
15811 (push (cons "TIMESTAMP_IA"
15812 (org-element-property
15813 :raw-value object))
15815 (when specific (throw 'exit ts))))))
15816 ;; Both timestamp types are found,
15817 ;; move to next part.
15818 (when (= (length ts) 2) (throw 'next ts)))))
15819 ts)))))
15820 (goto-char beg)
15821 ;; First look for timestamps within headline.
15822 (let ((ts (funcall find-ts (line-end-position) nil)))
15823 (if (= (length ts) 2) (setq props (nconc ts props))
15824 (forward-line)
15825 ;; Then find timestamps in the section, skipping
15826 ;; planning line.
15827 (when (org-looking-at-p org-planning-line-re)
15828 (forward-line))
15829 (let ((end (save-excursion (outline-next-heading))))
15830 (setq props (nconc (funcall find-ts end ts) props))))))))
15831 ;; Get the standard properties, like :PROP:.
15832 (when (memq which '(nil all standard))
15833 ;; If we are looking after a specific property, delegate
15834 ;; to `org-entry-get', which is faster. However, make an
15835 ;; exception for "CATEGORY", since it can be also set
15836 ;; through keywords (i.e. #+CATEGORY).
15837 (if (and specific (not (equal specific "CATEGORY")))
15838 (let ((value (org-entry-get beg specific nil t)))
15839 (throw 'exit (and value (list (cons specific value)))))
15840 (let ((range (org-get-property-block beg)))
15841 (when range
15842 (let ((end (cdr range)) seen-base)
15843 (goto-char (car range))
15844 ;; Unlike to `org--update-property-plist', we
15845 ;; handle the case where base values is found
15846 ;; after its extension. We also forbid standard
15847 ;; properties to be named as special properties.
15848 (while (re-search-forward org-property-re end t)
15849 (let* ((key (upcase (org-match-string-no-properties 2)))
15850 (extendp (org-string-match-p "\\+\\'" key))
15851 (key-base (if extendp (substring key 0 -1) key))
15852 (value (org-match-string-no-properties 3)))
15853 (cond
15854 ((member-ignore-case key-base org-special-properties))
15855 (extendp
15856 (setq props
15857 (org--update-property-plist key value props)))
15858 ((member key seen-base))
15859 (t (push key seen-base)
15860 (let ((p (assoc-string key props t)))
15861 (if p (setcdr p (concat value " " (cdr p)))
15862 (push (cons key value) props))))))))))))
15863 (unless (assoc "CATEGORY" props)
15864 (push (cons "CATEGORY" (org-get-category beg)) props)
15865 (when (string= specific "CATEGORY") (throw 'exit props)))
15866 ;; Return value.
15867 props)))))
15869 (defun org-property--local-values (property literal-nil)
15870 "Return value for PROPERTY in current entry.
15871 Value is a list whose care is the base value for PROPERTY and cdr
15872 a list of accumulated values. Return nil if neither is found in
15873 the entry. Also return nil when PROPERTY is set to \"nil\",
15874 unless LITERAL-NIL is non-nil."
15875 (let ((range (org-get-property-block)))
15876 (when range
15877 (goto-char (car range))
15878 (let* ((case-fold-search t)
15879 (end (cdr range))
15880 (value
15881 ;; Base value.
15882 (save-excursion
15883 (let ((v (and (re-search-forward
15884 (org-re-property property nil t) end t)
15885 (org-match-string-no-properties 3))))
15886 (list (if literal-nil v (org-not-nil v)))))))
15887 ;; Find additional values.
15888 (let* ((property+ (org-re-property (concat property "+") nil t)))
15889 (while (re-search-forward property+ end t)
15890 (push (org-match-string-no-properties 3) value)))
15891 ;; Return final values.
15892 (and (not (equal value '(nil))) (nreverse value))))))
15894 (defun org-entry-get (pom property &optional inherit literal-nil)
15895 "Get value of PROPERTY for entry or content at point-or-marker POM.
15897 If INHERIT is non-nil and the entry does not have the property,
15898 then also check higher levels of the hierarchy. If INHERIT is
15899 the symbol `selective', use inheritance only if the setting in
15900 `org-use-property-inheritance' selects PROPERTY for inheritance.
15902 If the property is present but empty, the return value is the
15903 empty string. If the property is not present at all, nil is
15904 returned. In any other case, return the value as a string.
15905 Search is case-insensitive.
15907 If LITERAL-NIL is set, return the string value \"nil\" as
15908 a string, do not interpret it as the list atom nil. This is used
15909 for inheritance when a \"nil\" value can supersede a non-nil
15910 value higher up the hierarchy."
15911 (org-with-point-at pom
15912 (cond
15913 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15914 ;; We need a special property. Use `org-entry-properties' to
15915 ;; retrieve it, but specify the wanted property.
15916 (cdr (assoc-string property (org-entry-properties nil property))))
15917 ((and inherit
15918 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15919 (org-entry-get-with-inheritance property literal-nil))
15921 (let* ((local (org-property--local-values property literal-nil))
15922 (value (and local (mapconcat #'identity (delq nil local) " "))))
15923 (if literal-nil value (org-not-nil value)))))))
15925 (defun org-property-or-variable-value (var &optional inherit)
15926 "Check if there is a property fixing the value of VAR.
15927 If yes, return this value. If not, return the current value of the variable."
15928 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15929 (if (and prop (stringp prop) (string-match "\\S-" prop))
15930 (read prop)
15931 (symbol-value var))))
15933 (defun org-entry-delete (pom property)
15934 "Delete PROPERTY from entry at point-or-marker POM.
15935 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15936 non-nil when a property was removed."
15937 (unless (member property org-special-properties)
15938 (org-with-point-at pom
15939 (let ((range (org-get-property-block)))
15940 (when range
15941 (let* ((begin (car range))
15942 (origin (cdr range))
15943 (end (copy-marker origin))
15944 (re (org-re-property
15945 (concat (regexp-quote property) "\\+?") t t)))
15946 (goto-char begin)
15947 (while (re-search-forward re end t)
15948 (delete-region (match-beginning 0) (line-beginning-position 2)))
15949 ;; If drawer is empty, remove it altogether.
15950 (when (= begin end)
15951 (delete-region (line-beginning-position 0)
15952 (line-beginning-position 2)))
15953 ;; Return non-nil if some property was removed.
15954 (prog1 (/= end origin) (set-marker end nil))))))))
15956 ;; Multi-values properties are properties that contain multiple values
15957 ;; These values are assumed to be single words, separated by whitespace.
15958 (defun org-entry-add-to-multivalued-property (pom property value)
15959 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15960 (let* ((old (org-entry-get pom property))
15961 (values (and old (org-split-string old "[ \t]"))))
15962 (setq value (org-entry-protect-space value))
15963 (unless (member value values)
15964 (setq values (append values (list value)))
15965 (org-entry-put pom property
15966 (mapconcat 'identity values " ")))))
15968 (defun org-entry-remove-from-multivalued-property (pom property value)
15969 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15970 (let* ((old (org-entry-get pom property))
15971 (values (and old (org-split-string old "[ \t]"))))
15972 (setq value (org-entry-protect-space value))
15973 (when (member value values)
15974 (setq values (delete value values))
15975 (org-entry-put pom property
15976 (mapconcat 'identity values " ")))))
15978 (defun org-entry-member-in-multivalued-property (pom property value)
15979 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15980 (let* ((old (org-entry-get pom property))
15981 (values (and old (org-split-string old "[ \t]"))))
15982 (setq value (org-entry-protect-space value))
15983 (member value values)))
15985 (defun org-entry-get-multivalued-property (pom property)
15986 "Return a list of values in a multivalued property."
15987 (let* ((value (org-entry-get pom property))
15988 (values (and value (org-split-string value "[ \t]"))))
15989 (mapcar 'org-entry-restore-space values)))
15991 (defun org-entry-put-multivalued-property (pom property &rest values)
15992 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15993 VALUES should be a list of strings. Spaces will be protected."
15994 (org-entry-put pom property
15995 (mapconcat 'org-entry-protect-space values " "))
15996 (let* ((value (org-entry-get pom property))
15997 (values (and value (org-split-string value "[ \t]"))))
15998 (mapcar 'org-entry-restore-space values)))
16000 (defun org-entry-protect-space (s)
16001 "Protect spaces and newline in string S."
16002 (while (string-match " " s)
16003 (setq s (replace-match "%20" t t s)))
16004 (while (string-match "\n" s)
16005 (setq s (replace-match "%0A" t t s)))
16008 (defun org-entry-restore-space (s)
16009 "Restore spaces and newline in string S."
16010 (while (string-match "%20" s)
16011 (setq s (replace-match " " t t s)))
16012 (while (string-match "%0A" s)
16013 (setq s (replace-match "\n" t t s)))
16016 (defvar org-entry-property-inherited-from (make-marker)
16017 "Marker pointing to the entry from where a property was inherited.
16018 Each call to `org-entry-get-with-inheritance' will set this marker to the
16019 location of the entry where the inheritance search matched. If there was
16020 no match, the marker will point nowhere.
16021 Note that also `org-entry-get' calls this function, if the INHERIT flag
16022 is set.")
16024 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16025 "Get PROPERTY of entry or content at point, search higher levels if needed.
16026 The search will stop at the first ancestor which has the property defined.
16027 If the value found is \"nil\", return nil to show that the property
16028 should be considered as undefined (this is the meaning of nil here).
16029 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16030 (move-marker org-entry-property-inherited-from nil)
16031 (org-with-wide-buffer
16032 (let (value)
16033 (catch 'exit
16034 (while t
16035 (let ((v (org-property--local-values property literal-nil)))
16036 (when v
16037 (setq value
16038 (concat (mapconcat #'identity (delq nil v) " ")
16039 (and value " ")
16040 value)))
16041 (cond
16042 ((car v)
16043 (org-back-to-heading t)
16044 (move-marker org-entry-property-inherited-from (point))
16045 (throw 'exit nil))
16046 ((org-up-heading-safe))
16048 (let ((global
16049 (cdr (or (assoc-string property org-file-properties t)
16050 (assoc-string property org-global-properties t)
16051 (assoc-string property org-global-properties-fixed t)))))
16052 (cond ((not global))
16053 (value (setq value (concat global " " value)))
16054 (t (setq value global))))
16055 (throw 'exit nil))))))
16056 (if literal-nil value (org-not-nil value)))))
16058 (defvar org-property-changed-functions nil
16059 "Hook called when the value of a property has changed.
16060 Each hook function should accept two arguments, the name of the property
16061 and the new value.")
16063 (defun org-entry-put (pom property value)
16064 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16066 If the value is nil, it is converted to the empty string. If
16067 it is not a string, an error is raised.
16069 PROPERTY can be any regular property (see
16070 `org-special-properties'). It can also be \"TODO\",
16071 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16073 For the last two properties, VALUE may have any of the special
16074 values \"earlier\" and \"later\". The function then increases or
16075 decreases scheduled or deadline date by one day."
16076 (cond ((null value) (setq value ""))
16077 ((not (stringp value)) (error "Properties values should be strings")))
16078 (org-with-point-at pom
16079 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16080 (org-back-to-heading t)
16081 (org-with-limited-levels (org-back-to-heading t)))
16082 (let ((beg (point)))
16083 (cond
16084 ((equal property "TODO")
16085 (cond ((not (org-string-nw-p value)) (setq value 'none))
16086 ((not (member value org-todo-keywords-1))
16087 (user-error "\"%s\" is not a valid TODO state" value)))
16088 (org-todo value)
16089 (org-set-tags nil 'align))
16090 ((equal property "PRIORITY")
16091 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16092 (org-set-tags nil 'align))
16093 ((equal property "SCHEDULED")
16094 (forward-line)
16095 (if (and (org-looking-at-p org-planning-line-re)
16096 (re-search-forward
16097 org-scheduled-time-regexp (line-end-position) t))
16098 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16099 ((string= value "later") (org-timestamp-change 1 'day))
16100 ((string= value "") (org-schedule '(4)))
16101 (t (org-schedule nil value)))
16102 (if (member value '("earlier" "later" ""))
16103 (call-interactively #'org-schedule)
16104 (org-schedule nil value))))
16105 ((equal property "DEADLINE")
16106 (forward-line)
16107 (if (and (org-looking-at-p org-planning-line-re)
16108 (re-search-forward
16109 org-deadline-time-regexp (line-end-position) t))
16110 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16111 ((string= value "later") (org-timestamp-change 1 'day))
16112 ((string= value "") (org-deadline '(4)))
16113 (t (org-deadline nil value)))
16114 (if (member value '("earlier" "later" ""))
16115 (call-interactively #'org-deadline)
16116 (org-deadline nil value))))
16117 ((member property org-special-properties)
16118 (error "The %s property cannot be set with `org-entry-put'" property))
16120 (let* ((range (org-get-property-block beg 'force))
16121 (end (cdr range))
16122 (case-fold-search t))
16123 (goto-char (car range))
16124 (if (re-search-forward (org-re-property property nil t) end t)
16125 (progn (delete-region (match-beginning 0) (match-end 0))
16126 (goto-char (match-beginning 0)))
16127 (goto-char end)
16128 (insert "\n")
16129 (backward-char))
16130 (insert ":" property ":")
16131 (when value (insert " " value))
16132 (org-indent-line)))))
16133 (run-hook-with-args 'org-property-changed-functions property value)))
16135 (defun org-buffer-property-keys (&optional specials defaults columns)
16136 "Get all property keys in the current buffer.
16138 When SPECIALS is non-nil, also list the special properties that
16139 reflect things like tags and TODO state.
16141 When DEFAULTS is non-nil, also include properties that has
16142 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16143 DESCRIPTION, LOCATION, and LOGGING and others.
16145 When COLUMNS in non-nil, also include property names given in
16146 COLUMN formats in the current buffer."
16147 (let ((case-fold-search t)
16148 (props (append
16149 (and specials org-special-properties)
16150 (and defaults (cons org-effort-property org-default-properties))
16151 nil)))
16152 (org-with-wide-buffer
16153 (goto-char (point-min))
16154 (while (re-search-forward org-property-start-re nil t)
16155 (let ((range (org-get-property-block)))
16156 (catch 'skip
16157 (unless range
16158 (when (and (not (org-before-first-heading-p))
16159 (y-or-n-p (format "Malformed drawer at %d, repair?"
16160 (line-beginning-position))))
16161 (org-get-property-block nil t))
16162 (throw 'skip nil))
16163 (goto-char (car range))
16164 (let ((begin (car range))
16165 (end (cdr range)))
16166 ;; Make sure that found property block is not located
16167 ;; before current point, as it would generate an infloop.
16168 ;; It can happen, for example, in the following
16169 ;; situation:
16171 ;; * Headline
16172 ;; :PROPERTIES:
16173 ;; ...
16174 ;; :END:
16175 ;; *************** Inlinetask
16176 ;; #+BEGIN_EXAMPLE
16177 ;; :PROPERTIES:
16178 ;; #+END_EXAMPLE
16180 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16181 (while (< (point) end)
16182 (let ((p (progn (looking-at org-property-re)
16183 (org-match-string-no-properties 2))))
16184 ;; Only add true property name, not extension symbol.
16185 (add-to-list 'props
16186 (if (not (org-string-match-p "\\+\\'" p)) p
16187 (substring p 0 -1))))
16188 (forward-line))))
16189 (outline-next-heading)))
16190 (when columns
16191 (goto-char (point-min))
16192 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16193 (let ((element (org-element-at-point)))
16194 (when (memq (org-element-type element) '(keyword node-property))
16195 (let ((value (org-element-property :value element))
16196 (start 0))
16197 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16198 (setq start (match-end 0))
16199 (let ((p (org-match-string-no-properties 1 value)))
16200 (unless (member-ignore-case p org-special-properties)
16201 (add-to-list 'props p))))))))))
16202 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16204 (defun org-property-values (key)
16205 "List all non-nil values of property KEY in current buffer."
16206 (org-with-wide-buffer
16207 (goto-char (point-min))
16208 (let ((case-fold-search t)
16209 (re (org-re-property key))
16210 values)
16211 (while (re-search-forward re nil t)
16212 (add-to-list 'values (org-entry-get (point) key)))
16213 values)))
16215 (defun org-insert-property-drawer ()
16216 "Insert a property drawer into the current entry."
16217 (org-with-wide-buffer
16218 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16219 (org-back-to-heading t)
16220 (org-with-limited-levels (org-back-to-heading t)))
16221 (forward-line)
16222 (when (org-looking-at-p org-planning-line-re) (forward-line))
16223 (unless (org-looking-at-p org-property-drawer-re)
16224 (let ((inhibit-read-only t))
16225 (unless (bolp) (insert "\n"))
16226 (let ((begin (point)))
16227 (insert ":PROPERTIES:\n:END:\n")
16228 (org-indent-region begin (point)))))))
16230 (defun org-insert-drawer (&optional arg drawer)
16231 "Insert a drawer at point.
16233 When optional argument ARG is non-nil, insert a property drawer.
16235 Optional argument DRAWER, when non-nil, is a string representing
16236 drawer's name. Otherwise, the user is prompted for a name.
16238 If a region is active, insert the drawer around that region
16239 instead.
16241 Point is left between drawer's boundaries."
16242 (interactive "P")
16243 (let* ((drawer (if arg "PROPERTIES"
16244 (or drawer (read-from-minibuffer "Drawer: ")))))
16245 (cond
16246 ;; With C-u, fall back on `org-insert-property-drawer'
16247 (arg (org-insert-property-drawer))
16248 ;; Check validity of suggested drawer's name.
16249 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16250 (user-error "Invalid drawer name"))
16251 ;; With an active region, insert a drawer at point.
16252 ((not (org-region-active-p))
16253 (progn
16254 (unless (bolp) (insert "\n"))
16255 (insert (format ":%s:\n\n:END:\n" drawer))
16256 (forward-line -2)))
16257 ;; Otherwise, insert the drawer at point
16259 (let ((rbeg (region-beginning))
16260 (rend (copy-marker (region-end))))
16261 (unwind-protect
16262 (progn
16263 (goto-char rbeg)
16264 (beginning-of-line)
16265 (when (save-excursion
16266 (re-search-forward org-outline-regexp-bol rend t))
16267 (user-error "Drawers cannot contain headlines"))
16268 ;; Position point at the beginning of the first
16269 ;; non-blank line in region. Insert drawer's opening
16270 ;; there, then indent it.
16271 (org-skip-whitespace)
16272 (beginning-of-line)
16273 (insert ":" drawer ":\n")
16274 (forward-line -1)
16275 (indent-for-tab-command)
16276 ;; Move point to the beginning of the first blank line
16277 ;; after the last non-blank line in region. Insert
16278 ;; drawer's closing, then indent it.
16279 (goto-char rend)
16280 (skip-chars-backward " \r\t\n")
16281 (insert "\n:END:")
16282 (deactivate-mark t)
16283 (indent-for-tab-command)
16284 (unless (eolp) (insert "\n")))
16285 ;; Clear marker, whatever the outcome of insertion is.
16286 (set-marker rend nil)))))))
16288 (defvar org-property-set-functions-alist nil
16289 "Property set function alist.
16290 Each entry should have the following format:
16292 (PROPERTY . READ-FUNCTION)
16294 The read function will be called with the same argument as
16295 `org-completing-read'.")
16297 (defun org-set-property-function (property)
16298 "Get the function that should be used to set PROPERTY.
16299 This is computed according to `org-property-set-functions-alist'."
16300 (or (cdr (assoc property org-property-set-functions-alist))
16301 'org-completing-read))
16303 (defun org-read-property-value (property)
16304 "Read PROPERTY value from user."
16305 (let* ((completion-ignore-case t)
16306 (allowed (org-property-get-allowed-values nil property 'table))
16307 (cur (org-entry-get nil property))
16308 (prompt (concat property " value"
16309 (if (and cur (string-match "\\S-" cur))
16310 (concat " [" cur "]") "") ": "))
16311 (set-function (org-set-property-function property))
16312 (val (if allowed
16313 (funcall set-function prompt allowed nil
16314 (not (get-text-property 0 'org-unrestricted
16315 (caar allowed))))
16316 (let (org-completion-use-ido org-completion-use-iswitchb)
16317 (funcall set-function prompt
16318 (mapcar 'list (org-property-values property))
16319 nil nil "" nil cur)))))
16320 (org-trim val)))
16322 (defvar org-last-set-property nil)
16323 (defvar org-last-set-property-value nil)
16324 (defun org-read-property-name ()
16325 "Read a property name."
16326 (let ((completion-ignore-case t)
16327 (default-prop (or (and (org-at-property-p)
16328 (org-match-string-no-properties 2))
16329 org-last-set-property)))
16330 (org-completing-read
16331 (concat "Property"
16332 (if default-prop (concat " [" default-prop "]") "")
16333 ": ")
16334 (mapcar #'list (org-buffer-property-keys nil t t))
16335 nil nil nil nil default-prop)))
16337 (defun org-set-property-and-value (use-last)
16338 "Allow to set [PROPERTY]: [value] direction from prompt.
16339 When use-default, don't even ask, just use the last
16340 \"[PROPERTY]: [value]\" string from the history."
16341 (interactive "P")
16342 (let* ((completion-ignore-case t)
16343 (pv (or (and use-last org-last-set-property-value)
16344 (org-completing-read
16345 "Enter a \"[Property]: [value]\" pair: "
16346 nil nil nil nil nil
16347 org-last-set-property-value)))
16348 prop val)
16349 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16350 (setq prop (match-string 1 pv)
16351 val (match-string 2 pv))
16352 (org-set-property prop val))))
16354 (defun org-set-property (property value)
16355 "In the current entry, set PROPERTY to VALUE.
16356 When called interactively, this will prompt for a property name, offering
16357 completion on existing and default properties. And then it will prompt
16358 for a value, offering completion either on allowed values (via an inherited
16359 xxx_ALL property) or on existing values in other instances of this property
16360 in the current file."
16361 (interactive (list nil nil))
16362 (let* ((property (or property (org-read-property-name)))
16363 (value (or value (org-read-property-value property)))
16364 (fn (cdr (assoc property org-properties-postprocess-alist))))
16365 (setq org-last-set-property property)
16366 (setq org-last-set-property-value (concat property ": " value))
16367 ;; Possibly postprocess the inserted value:
16368 (when fn (setq value (funcall fn value)))
16369 (unless (equal (org-entry-get nil property) value)
16370 (org-entry-put nil property value))))
16372 (defun org-find-property (property &optional value)
16373 "Find first entry in buffer that sets PROPERTY.
16375 When optional argument VALUE is non-nil, only consider an entry
16376 if it contains PROPERTY set to this value. If PROPERTY should be
16377 explicitly set to nil, use string \"nil\" for VALUE.
16379 Return position where the entry begins, or nil if there is no
16380 such entry. If narrowing is in effect, only search the visible
16381 part of the buffer."
16382 (save-excursion
16383 (goto-char (point-min))
16384 (let ((case-fold-search t)
16385 (re (org-re-property property nil (not value) value)))
16386 (catch 'exit
16387 (while (re-search-forward re nil t)
16388 (when (if value (org-at-property-p)
16389 (org-entry-get (point) property nil t))
16390 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16392 (defun org-delete-property (property)
16393 "In the current entry, delete PROPERTY."
16394 (interactive
16395 (let* ((completion-ignore-case t)
16396 (cat (org-entry-get (point) "CATEGORY"))
16397 (props0 (org-entry-properties nil 'standard))
16398 (props (if cat props0
16399 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16400 (prop (if (< 1 (length props))
16401 (org-icompleting-read "Property: " props nil t)
16402 (caar props))))
16403 (list prop)))
16404 (if (not property)
16405 (message "No property to delete in this entry")
16406 (org-entry-delete nil property)
16407 (message "Property \"%s\" deleted" property)))
16409 (defun org-delete-property-globally (property)
16410 "Remove PROPERTY globally, from all entries.
16411 This function ignores narrowing, if any."
16412 (interactive
16413 (let* ((completion-ignore-case t)
16414 (prop (org-icompleting-read
16415 "Globally remove property: "
16416 (mapcar #'list (org-buffer-property-keys)))))
16417 (list prop)))
16418 (org-with-wide-buffer
16419 (goto-char (point-min))
16420 (let ((count 0)
16421 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16422 (while (re-search-forward re nil t)
16423 (when (org-entry-delete (point) property) (incf count)))
16424 (message "Property \"%s\" removed from %d entries" property count))))
16426 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16428 (defun org-compute-property-at-point ()
16429 "Compute the property at point.
16430 This looks for an enclosing column format, extracts the operator and
16431 then applies it to the property in the column format's scope."
16432 (interactive)
16433 (unless (org-at-property-p)
16434 (user-error "Not at a property"))
16435 (let ((prop (org-match-string-no-properties 2)))
16436 (org-columns-get-format-and-top-level)
16437 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16438 (user-error "No operator defined for property %s" prop))
16439 (org-columns-compute prop)))
16441 (defvar org-property-allowed-value-functions nil
16442 "Hook for functions supplying allowed values for a specific property.
16443 The functions must take a single argument, the name of the property, and
16444 return a flat list of allowed values. If \":ETC\" is one of
16445 the values, this means that these values are intended as defaults for
16446 completion, but that other values should be allowed too.
16447 The functions must return nil if they are not responsible for this
16448 property.")
16450 (defun org-property-get-allowed-values (pom property &optional table)
16451 "Get allowed values for the property PROPERTY.
16452 When TABLE is non-nil, return an alist that can directly be used for
16453 completion."
16454 (let (vals)
16455 (cond
16456 ((equal property "TODO")
16457 (setq vals (org-with-point-at pom
16458 (append org-todo-keywords-1 '("")))))
16459 ((equal property "PRIORITY")
16460 (let ((n org-lowest-priority))
16461 (while (>= n org-highest-priority)
16462 (push (char-to-string n) vals)
16463 (setq n (1- n)))))
16464 ((equal property "CATEGORY"))
16465 ((member property org-special-properties))
16466 ((setq vals (run-hook-with-args-until-success
16467 'org-property-allowed-value-functions property)))
16469 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16470 (when (and vals (string-match "\\S-" vals))
16471 (setq vals (car (read-from-string (concat "(" vals ")"))))
16472 (setq vals (mapcar (lambda (x)
16473 (cond ((stringp x) x)
16474 ((numberp x) (number-to-string x))
16475 ((symbolp x) (symbol-name x))
16476 (t "???")))
16477 vals)))))
16478 (when (member ":ETC" vals)
16479 (setq vals (remove ":ETC" vals))
16480 (org-add-props (car vals) '(org-unrestricted t)))
16481 (if table (mapcar 'list vals) vals)))
16483 (defun org-property-previous-allowed-value (&optional previous)
16484 "Switch to the next allowed value for this property."
16485 (interactive)
16486 (org-property-next-allowed-value t))
16488 (defun org-property-next-allowed-value (&optional previous)
16489 "Switch to the next allowed value for this property."
16490 (interactive)
16491 (unless (org-at-property-p)
16492 (user-error "Not at a property"))
16493 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16494 (key (match-string 2))
16495 (value (match-string 3))
16496 (allowed (or (org-property-get-allowed-values (point) key)
16497 (and (member value '("[ ]" "[-]" "[X]"))
16498 '("[ ]" "[X]"))))
16499 (heading (save-match-data (nth 4 (org-heading-components))))
16500 nval)
16501 (unless allowed
16502 (user-error "Allowed values for this property have not been defined"))
16503 (if previous (setq allowed (reverse allowed)))
16504 (if (member value allowed)
16505 (setq nval (car (cdr (member value allowed)))))
16506 (setq nval (or nval (car allowed)))
16507 (if (equal nval value)
16508 (user-error "Only one allowed value for this property"))
16509 (org-at-property-p)
16510 (replace-match (concat " :" key ": " nval) t t)
16511 (org-indent-line)
16512 (beginning-of-line 1)
16513 (skip-chars-forward " \t")
16514 (when (equal prop org-effort-property)
16515 (org-refresh-property
16516 '((effort . identity)
16517 (effort-minutes . org-duration-string-to-minutes))
16518 nval)
16519 (when (string= org-clock-current-task heading)
16520 (setq org-clock-effort nval)
16521 (org-clock-update-mode-line)))
16522 (run-hook-with-args 'org-property-changed-functions key nval)))
16524 (defun org-find-olp (path &optional this-buffer)
16525 "Return a marker pointing to the entry at outline path OLP.
16526 If anything goes wrong, throw an error.
16527 You can wrap this call to catch the error like this:
16529 (condition-case msg
16530 (org-mobile-locate-entry (match-string 4))
16531 (error (nth 1 msg)))
16533 The return value will then be either a string with the error message,
16534 or a marker if everything is OK.
16536 If THIS-BUFFER is set, the outline path does not contain a file,
16537 only headings."
16538 (let* ((file (if this-buffer buffer-file-name (pop path)))
16539 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16540 (level 1)
16541 (lmin 1)
16542 (lmax 1)
16543 limit re end found pos heading cnt flevel)
16544 (unless buffer (error "File not found :%s" file))
16545 (with-current-buffer buffer
16546 (save-excursion
16547 (save-restriction
16548 (widen)
16549 (setq limit (point-max))
16550 (goto-char (point-min))
16551 (dolist (heading path)
16552 (setq re (format org-complex-heading-regexp-format
16553 (regexp-quote heading)))
16554 (setq cnt 0 pos (point))
16555 (while (re-search-forward re end t)
16556 (setq level (- (match-end 1) (match-beginning 1)))
16557 (if (and (>= level lmin) (<= level lmax))
16558 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16559 (when (= cnt 0) (error "Heading not found on level %d: %s"
16560 lmax heading))
16561 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16562 lmax heading))
16563 (goto-char found)
16564 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16565 (setq end (save-excursion (org-end-of-subtree t t))))
16566 (when (org-at-heading-p)
16567 (point-marker)))))))
16569 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16570 "Find node HEADING in BUFFER.
16571 Return a marker to the heading if it was found, or nil if not.
16572 If POS-ONLY is set, return just the position instead of a marker.
16574 The heading text must match exact, but it may have a TODO keyword,
16575 a priority cookie and tags in the standard locations."
16576 (with-current-buffer (or buffer (current-buffer))
16577 (save-excursion
16578 (save-restriction
16579 (widen)
16580 (goto-char (point-min))
16581 (let (case-fold-search)
16582 (if (re-search-forward
16583 (format org-complex-heading-regexp-format
16584 (regexp-quote heading)) nil t)
16585 (if pos-only
16586 (match-beginning 0)
16587 (move-marker (make-marker) (match-beginning 0)))))))))
16589 (defun org-find-exact-heading-in-directory (heading &optional dir)
16590 "Find Org node headline HEADING in all .org files in directory DIR.
16591 When the target headline is found, return a marker to this location."
16592 (let ((files (directory-files (or dir default-directory)
16593 t "\\`[^.#].*\\.org\\'"))
16594 visiting m buffer)
16595 (catch 'found
16596 (dolist (file files)
16597 (message "trying %s" file)
16598 (setq visiting (org-find-base-buffer-visiting file))
16599 (setq buffer (or visiting (find-file-noselect file)))
16600 (setq m (org-find-exact-headline-in-buffer
16601 heading buffer))
16602 (when (and (not m) (not visiting)) (kill-buffer buffer))
16603 (and m (throw 'found m))))))
16605 (defun org-find-entry-with-id (ident)
16606 "Locate the entry that contains the ID property with exact value IDENT.
16607 IDENT can be a string, a symbol or a number, this function will search for
16608 the string representation of it.
16609 Return the position where this entry starts, or nil if there is no such entry."
16610 (interactive "sID: ")
16611 (let ((id (cond
16612 ((stringp ident) ident)
16613 ((symbolp ident) (symbol-name ident))
16614 ((numberp ident) (number-to-string ident))
16615 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16616 (org-with-wide-buffer (org-find-property "ID" id))))
16618 ;;;; Timestamps
16620 (defvar org-last-changed-timestamp nil)
16621 (defvar org-last-inserted-timestamp nil
16622 "The last time stamp inserted with `org-insert-time-stamp'.")
16623 (defvar org-ts-what) ; dynamically scoped parameter
16625 (defun org-time-stamp (arg &optional inactive)
16626 "Prompt for a date/time and insert a time stamp.
16628 If the user specifies a time like HH:MM or if this command is
16629 called with at least one prefix argument, the time stamp contains
16630 the date and the time. Otherwise, only the date is included.
16632 All parts of a date not specified by the user are filled in from
16633 the timestamp at point, if any, or the current date/time
16634 otherwise.
16636 If there is already a timestamp at the cursor, it is replaced.
16638 With two universal prefix arguments, insert an active timestamp
16639 with the current time without prompting the user.
16641 When called from lisp, the timestamp is inactive if INACTIVE is
16642 non-nil."
16643 (interactive "P")
16644 (let* ((ts (cond
16645 ((org-at-date-range-p t)
16646 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16647 ((org-at-timestamp-p t) (match-string 0))))
16648 ;; Default time is either the timestamp at point or today.
16649 ;; When entering a range, only the range start is considered.
16650 (default-time (if (not ts) (current-time)
16651 (apply #'encode-time (org-parse-time-string ts))))
16652 (default-input (and ts (org-get-compact-tod ts)))
16653 (repeater (and ts
16654 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16655 (match-string 0 ts)))
16656 org-time-was-given
16657 org-end-time-was-given
16658 (time
16659 (and (if (equal arg '(16)) (current-time)
16660 ;; Preserve `this-command' and `last-command'.
16661 (let ((this-command this-command)
16662 (last-command last-command))
16663 (org-read-date
16664 arg 'totime nil nil default-time default-input
16665 inactive))))))
16666 (cond
16667 ((and ts
16668 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16669 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16670 (insert "--")
16671 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16673 ;; Make sure we're on a timestamp. When in the middle of a date
16674 ;; range, move arbitrarily to range end.
16675 (unless (org-at-timestamp-p t)
16676 (skip-chars-forward "-")
16677 (org-at-timestamp-p t))
16678 (replace-match "")
16679 (setq org-last-changed-timestamp
16680 (org-insert-time-stamp
16681 time (or org-time-was-given arg)
16682 inactive nil nil (list org-end-time-was-given)))
16683 (when repeater
16684 (backward-char)
16685 (insert " " repeater)
16686 (setq org-last-changed-timestamp
16687 (concat (substring org-last-inserted-timestamp 0 -1)
16688 " " repeater ">")))
16689 (message "Timestamp updated"))
16690 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16691 (t (org-insert-time-stamp
16692 time (or org-time-was-given arg) inactive nil nil
16693 (list org-end-time-was-given))))))
16695 ;; FIXME: can we use this for something else, like computing time differences?
16696 (defun org-get-compact-tod (s)
16697 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16698 (let* ((t1 (match-string 1 s))
16699 (h1 (string-to-number (match-string 2 s)))
16700 (m1 (string-to-number (match-string 3 s)))
16701 (t2 (and (match-end 4) (match-string 5 s)))
16702 (h2 (and t2 (string-to-number (match-string 6 s))))
16703 (m2 (and t2 (string-to-number (match-string 7 s))))
16704 dh dm)
16705 (if (not t2)
16707 (setq dh (- h2 h1) dm (- m2 m1))
16708 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16709 (concat t1 "+" (number-to-string dh)
16710 (and (/= 0 dm) (format ":%02d" dm)))))))
16712 (defun org-time-stamp-inactive (&optional arg)
16713 "Insert an inactive time stamp.
16714 An inactive time stamp is enclosed in square brackets instead of angle
16715 brackets. It is inactive in the sense that it does not trigger agenda entries,
16716 does not link to the calendar and cannot be changed with the S-cursor keys.
16717 So these are more for recording a certain time/date."
16718 (interactive "P")
16719 (org-time-stamp arg 'inactive))
16721 (defvar org-date-ovl (make-overlay 1 1))
16722 (overlay-put org-date-ovl 'face 'org-date-selected)
16723 (org-detach-overlay org-date-ovl)
16725 (defvar org-ans1) ; dynamically scoped parameter
16726 (defvar org-ans2) ; dynamically scoped parameter
16728 (defvar org-plain-time-of-day-regexp) ; defined below
16730 (defvar org-overriding-default-time nil) ; dynamically scoped
16731 (defvar org-read-date-overlay nil)
16732 (defvar org-dcst nil) ; dynamically scoped
16733 (defvar org-read-date-history nil)
16734 (defvar org-read-date-final-answer nil)
16735 (defvar org-read-date-analyze-futurep nil)
16736 (defvar org-read-date-analyze-forced-year nil)
16737 (defvar org-read-date-inactive)
16739 (defvar org-read-date-minibuffer-local-map
16740 (let* ((map (make-sparse-keymap)))
16741 (set-keymap-parent map minibuffer-local-map)
16742 (org-defkey map (kbd ".")
16743 (lambda () (interactive)
16744 ;; Are we at the beginning of the prompt?
16745 (if (looking-back "^[^:]+: ")
16746 (org-eval-in-calendar '(calendar-goto-today))
16747 (insert "."))))
16748 (org-defkey map (kbd "C-.")
16749 (lambda () (interactive)
16750 (org-eval-in-calendar '(calendar-goto-today))))
16751 (org-defkey map [(meta shift left)]
16752 (lambda () (interactive)
16753 (org-eval-in-calendar '(calendar-backward-month 1))))
16754 (org-defkey map [(meta shift right)]
16755 (lambda () (interactive)
16756 (org-eval-in-calendar '(calendar-forward-month 1))))
16757 (org-defkey map [(meta shift up)]
16758 (lambda () (interactive)
16759 (org-eval-in-calendar '(calendar-backward-year 1))))
16760 (org-defkey map [(meta shift down)]
16761 (lambda () (interactive)
16762 (org-eval-in-calendar '(calendar-forward-year 1))))
16763 (org-defkey map [?\e (shift left)]
16764 (lambda () (interactive)
16765 (org-eval-in-calendar '(calendar-backward-month 1))))
16766 (org-defkey map [?\e (shift right)]
16767 (lambda () (interactive)
16768 (org-eval-in-calendar '(calendar-forward-month 1))))
16769 (org-defkey map [?\e (shift up)]
16770 (lambda () (interactive)
16771 (org-eval-in-calendar '(calendar-backward-year 1))))
16772 (org-defkey map [?\e (shift down)]
16773 (lambda () (interactive)
16774 (org-eval-in-calendar '(calendar-forward-year 1))))
16775 (org-defkey map [(shift up)]
16776 (lambda () (interactive)
16777 (org-eval-in-calendar '(calendar-backward-week 1))))
16778 (org-defkey map [(shift down)]
16779 (lambda () (interactive)
16780 (org-eval-in-calendar '(calendar-forward-week 1))))
16781 (org-defkey map [(shift left)]
16782 (lambda () (interactive)
16783 (org-eval-in-calendar '(calendar-backward-day 1))))
16784 (org-defkey map [(shift right)]
16785 (lambda () (interactive)
16786 (org-eval-in-calendar '(calendar-forward-day 1))))
16787 (org-defkey map "!"
16788 (lambda () (interactive)
16789 (org-eval-in-calendar '(diary-view-entries))
16790 (message "")))
16791 (org-defkey map ">"
16792 (lambda () (interactive)
16793 (org-eval-in-calendar '(calendar-scroll-left 1))))
16794 (org-defkey map "<"
16795 (lambda () (interactive)
16796 (org-eval-in-calendar '(calendar-scroll-right 1))))
16797 (org-defkey map "\C-v"
16798 (lambda () (interactive)
16799 (org-eval-in-calendar
16800 '(calendar-scroll-left-three-months 1))))
16801 (org-defkey map "\M-v"
16802 (lambda () (interactive)
16803 (org-eval-in-calendar
16804 '(calendar-scroll-right-three-months 1))))
16805 map)
16806 "Keymap for minibuffer commands when using `org-read-date'.")
16808 (defvar org-def)
16809 (defvar org-defdecode)
16810 (defvar org-with-time)
16812 (defun org-read-date (&optional org-with-time to-time from-string prompt
16813 default-time default-input inactive)
16814 "Read a date, possibly a time, and make things smooth for the user.
16815 The prompt will suggest to enter an ISO date, but you can also enter anything
16816 which will at least partially be understood by `parse-time-string'.
16817 Unrecognized parts of the date will default to the current day, month, year,
16818 hour and minute. If this command is called to replace a timestamp at point,
16819 or to enter the second timestamp of a range, the default time is taken
16820 from the existing stamp. Furthermore, the command prefers the future,
16821 so if you are giving a date where the year is not given, and the day-month
16822 combination is already past in the current year, it will assume you
16823 mean next year. For details, see the manual. A few examples:
16825 3-2-5 --> 2003-02-05
16826 feb 15 --> currentyear-02-15
16827 2/15 --> currentyear-02-15
16828 sep 12 9 --> 2009-09-12
16829 12:45 --> today 12:45
16830 22 sept 0:34 --> currentyear-09-22 0:34
16831 12 --> currentyear-currentmonth-12
16832 Fri --> nearest Friday after today
16833 -Tue --> last Tuesday
16834 etc.
16836 Furthermore you can specify a relative date by giving, as the *first* thing
16837 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16838 change in days weeks, months, years.
16839 With a single plus or minus, the date is relative to today. With a double
16840 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16841 +4d --> four days from today
16842 +4 --> same as above
16843 +2w --> two weeks from today
16844 ++5 --> five days from default date
16846 The function understands only English month and weekday abbreviations.
16848 While prompting, a calendar is popped up - you can also select the
16849 date with the mouse (button 1). The calendar shows a period of three
16850 months. To scroll it to other months, use the keys `>' and `<'.
16851 If you don't like the calendar, turn it off with
16852 \(setq org-read-date-popup-calendar nil)
16854 With optional argument TO-TIME, the date will immediately be converted
16855 to an internal time.
16856 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16857 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16858 still enter a time, and this function will inform the calling routine
16859 about this change. The calling routine may then choose to change the
16860 format used to insert the time stamp into the buffer to include the time.
16861 With optional argument FROM-STRING, read from this string instead from
16862 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16863 the time/date that is used for everything that is not specified by the
16864 user."
16865 (require 'parse-time)
16866 (let* ((org-time-stamp-rounding-minutes
16867 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16868 (org-dcst org-display-custom-times)
16869 (ct (org-current-time))
16870 (org-def (or org-overriding-default-time default-time ct))
16871 (org-defdecode (decode-time org-def))
16872 (dummy (progn
16873 (when (< (nth 2 org-defdecode) org-extend-today-until)
16874 (setcar (nthcdr 2 org-defdecode) -1)
16875 (setcar (nthcdr 1 org-defdecode) 59)
16876 (setq org-def (apply 'encode-time org-defdecode)
16877 org-defdecode (decode-time org-def)))))
16878 (cur-frame (selected-frame))
16879 (mouse-autoselect-window nil) ; Don't let the mouse jump
16880 (calendar-frame-setup nil)
16881 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16882 (calendar-move-hook nil)
16883 (calendar-view-diary-initially-flag nil)
16884 (calendar-view-holidays-initially-flag nil)
16885 (timestr (format-time-string
16886 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16887 (prompt (concat (if prompt (concat prompt " ") "")
16888 (format "Date+time [%s]: " timestr)))
16889 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16891 (cond
16892 (from-string (setq ans from-string))
16893 (org-read-date-popup-calendar
16894 (save-excursion
16895 (save-window-excursion
16896 (calendar)
16897 (when (eq calendar-setup 'calendar-only)
16898 (setq cal-frame
16899 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16900 (select-frame cal-frame))
16901 (org-eval-in-calendar '(setq cursor-type nil) t)
16902 (unwind-protect
16903 (progn
16904 (calendar-forward-day (- (time-to-days org-def)
16905 (calendar-absolute-from-gregorian
16906 (calendar-current-date))))
16907 (org-eval-in-calendar nil t)
16908 (let* ((old-map (current-local-map))
16909 (map (copy-keymap calendar-mode-map))
16910 (minibuffer-local-map
16911 (copy-keymap org-read-date-minibuffer-local-map)))
16912 (org-defkey map (kbd "RET") 'org-calendar-select)
16913 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16914 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16915 (unwind-protect
16916 (progn
16917 (use-local-map map)
16918 (setq org-read-date-inactive inactive)
16919 (add-hook 'post-command-hook 'org-read-date-display)
16920 (setq org-ans0 (read-string prompt default-input
16921 'org-read-date-history nil))
16922 ;; org-ans0: from prompt
16923 ;; org-ans1: from mouse click
16924 ;; org-ans2: from calendar motion
16925 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16926 (remove-hook 'post-command-hook 'org-read-date-display)
16927 (use-local-map old-map)
16928 (when org-read-date-overlay
16929 (delete-overlay org-read-date-overlay)
16930 (setq org-read-date-overlay nil)))))
16931 (bury-buffer "*Calendar*")
16932 (when cal-frame
16933 (delete-frame cal-frame)
16934 (select-frame-set-input-focus cur-frame))))))
16936 (t ; Naked prompt only
16937 (unwind-protect
16938 (setq ans (read-string prompt default-input
16939 'org-read-date-history timestr))
16940 (when org-read-date-overlay
16941 (delete-overlay org-read-date-overlay)
16942 (setq org-read-date-overlay nil)))))
16944 (setq final (org-read-date-analyze ans org-def org-defdecode))
16946 (when org-read-date-analyze-forced-year
16947 (message "Year was forced into %s"
16948 (if org-read-date-force-compatible-dates
16949 "compatible range (1970-2037)"
16950 "range representable on this machine"))
16951 (ding))
16953 ;; One round trip to get rid of 34th of August and stuff like that....
16954 (setq final (decode-time (apply 'encode-time final)))
16956 (setq org-read-date-final-answer ans)
16958 (if to-time
16959 (apply 'encode-time final)
16960 (if (and (boundp 'org-time-was-given) org-time-was-given)
16961 (format "%04d-%02d-%02d %02d:%02d"
16962 (nth 5 final) (nth 4 final) (nth 3 final)
16963 (nth 2 final) (nth 1 final))
16964 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16966 (defun org-read-date-display ()
16967 "Display the current date prompt interpretation in the minibuffer."
16968 (when org-read-date-display-live
16969 (when org-read-date-overlay
16970 (delete-overlay org-read-date-overlay))
16971 (when (minibufferp (current-buffer))
16972 (save-excursion
16973 (end-of-line 1)
16974 (while (not (equal (buffer-substring
16975 (max (point-min) (- (point) 4)) (point))
16976 " "))
16977 (insert " ")))
16978 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16979 " " (or org-ans1 org-ans2)))
16980 (org-end-time-was-given nil)
16981 (f (org-read-date-analyze ans org-def org-defdecode))
16982 (fmts (if org-dcst
16983 org-time-stamp-custom-formats
16984 org-time-stamp-formats))
16985 (fmt (if (or org-with-time
16986 (and (boundp 'org-time-was-given) org-time-was-given))
16987 (cdr fmts)
16988 (car fmts)))
16989 (txt (format-time-string fmt (apply 'encode-time f)))
16990 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16991 (txt (concat "=> " txt)))
16992 (when (and org-end-time-was-given
16993 (string-match org-plain-time-of-day-regexp txt))
16994 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16995 org-end-time-was-given
16996 (substring txt (match-end 0)))))
16997 (when org-read-date-analyze-futurep
16998 (setq txt (concat txt " (=>F)")))
16999 (setq org-read-date-overlay
17000 (make-overlay (1- (point-at-eol)) (point-at-eol)))
17001 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
17003 (defun org-read-date-analyze (ans org-def org-defdecode)
17004 "Analyze the combined answer of the date prompt."
17005 ;; FIXME: cleanup and comment
17006 ;; Pass `current-time' result to `decode-time' (instead of calling
17007 ;; without arguments) so that only `current-time' has to be
17008 ;; overriden in tests.
17009 (let ((nowdecode (decode-time (current-time)))
17010 delta deltan deltaw deltadef year month day
17011 hour minute second wday pm h2 m2 tl wday1
17012 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
17013 (setq org-read-date-analyze-futurep nil
17014 org-read-date-analyze-forced-year nil)
17015 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17016 (setq ans "+0"))
17018 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17019 (setq ans (replace-match "" t t ans)
17020 deltan (car delta)
17021 deltaw (nth 1 delta)
17022 deltadef (nth 2 delta)))
17024 ;; Check if there is an iso week date in there. If yes, store the
17025 ;; info and postpone interpreting it until the rest of the parsing
17026 ;; is done.
17027 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17028 (setq iso-year (if (match-end 1)
17029 (org-small-year-to-year
17030 (string-to-number (match-string 1 ans))))
17031 iso-weekday (if (match-end 3)
17032 (string-to-number (match-string 3 ans)))
17033 iso-week (string-to-number (match-string 2 ans)))
17034 (setq ans (replace-match "" t t ans)))
17036 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17037 (when (string-match
17038 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17039 (setq year (if (match-end 2)
17040 (string-to-number (match-string 2 ans))
17041 (progn (setq kill-year t)
17042 (string-to-number (format-time-string "%Y"))))
17043 month (string-to-number (match-string 3 ans))
17044 day (string-to-number (match-string 4 ans)))
17045 (if (< year 100) (setq year (+ 2000 year)))
17046 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17047 t nil ans)))
17049 ;; Help matching dotted european dates
17050 (when (string-match
17051 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17052 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17053 (setq kill-year t)
17054 (string-to-number (format-time-string "%Y")))
17055 day (string-to-number (match-string 1 ans))
17056 month (string-to-number (match-string 2 ans))
17057 ans (replace-match (format "%04d-%02d-%02d" year month day)
17058 t nil ans)))
17060 ;; Help matching american dates, like 5/30 or 5/30/7
17061 (when (string-match
17062 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17063 (setq year (if (match-end 4)
17064 (string-to-number (match-string 4 ans))
17065 (progn (setq kill-year t)
17066 (string-to-number (format-time-string "%Y"))))
17067 month (string-to-number (match-string 1 ans))
17068 day (string-to-number (match-string 2 ans)))
17069 (if (< year 100) (setq year (+ 2000 year)))
17070 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17071 t nil ans)))
17072 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17073 ;; If there is a time with am/pm, and *no* time without it, we convert
17074 ;; so that matching will be successful.
17075 (loop for i from 1 to 2 do ; twice, for end time as well
17076 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17077 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17078 (setq hour (string-to-number (match-string 1 ans))
17079 minute (if (match-end 3)
17080 (string-to-number (match-string 3 ans))
17082 pm (equal ?p
17083 (string-to-char (downcase (match-string 4 ans)))))
17084 (if (and (= hour 12) (not pm))
17085 (setq hour 0)
17086 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17087 (setq ans (replace-match (format "%02d:%02d" hour minute)
17088 t t ans))))
17090 ;; Check if a time range is given as a duration
17091 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17092 (setq hour (string-to-number (match-string 1 ans))
17093 h2 (+ hour (string-to-number (match-string 3 ans)))
17094 minute (string-to-number (match-string 2 ans))
17095 m2 (+ minute (if (match-end 5) (string-to-number
17096 (match-string 5 ans))0)))
17097 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17098 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17099 t t ans)))
17101 ;; Check if there is a time range
17102 (when (boundp 'org-end-time-was-given)
17103 (setq org-time-was-given nil)
17104 (when (and (string-match org-plain-time-of-day-regexp ans)
17105 (match-end 8))
17106 (setq org-end-time-was-given (match-string 8 ans))
17107 (setq ans (concat (substring ans 0 (match-beginning 7))
17108 (substring ans (match-end 7))))))
17110 (setq tl (parse-time-string ans)
17111 day (or (nth 3 tl) (nth 3 org-defdecode))
17112 month
17113 (cond ((nth 4 tl))
17114 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17115 ;; Day was specified. Make sure DAY+MONTH
17116 ;; combination happens in the future.
17117 ((nth 3 tl)
17118 (setq futurep t)
17119 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17120 (nth 4 nowdecode)))
17121 (t (nth 4 org-defdecode)))
17122 year
17123 (cond ((and (not kill-year) (nth 5 tl)))
17124 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17125 ;; Month was guessed in the future and is at least
17126 ;; equal to NOWDECODE's. Fix year accordingly.
17127 (futurep
17128 (if (or (> month (nth 4 nowdecode))
17129 (>= day (nth 3 nowdecode)))
17130 (nth 5 nowdecode)
17131 (1+ (nth 5 nowdecode))))
17132 ;; Month was specified. Make sure MONTH+YEAR
17133 ;; combination happens in the future.
17134 ((nth 4 tl)
17135 (setq futurep t)
17136 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17137 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17138 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17139 (t (nth 5 nowdecode))))
17140 (t (nth 5 org-defdecode)))
17141 hour (or (nth 2 tl) (nth 2 org-defdecode))
17142 minute (or (nth 1 tl) (nth 1 org-defdecode))
17143 second (or (nth 0 tl) 0)
17144 wday (nth 6 tl))
17146 (when (and (eq org-read-date-prefer-future 'time)
17147 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17148 (equal day (nth 3 nowdecode))
17149 (equal month (nth 4 nowdecode))
17150 (equal year (nth 5 nowdecode))
17151 (nth 2 tl)
17152 (or (< (nth 2 tl) (nth 2 nowdecode))
17153 (and (= (nth 2 tl) (nth 2 nowdecode))
17154 (nth 1 tl)
17155 (< (nth 1 tl) (nth 1 nowdecode)))))
17156 (setq day (1+ day)
17157 futurep t))
17159 ;; Special date definitions below
17160 (cond
17161 (iso-week
17162 ;; There was an iso week
17163 (require 'cal-iso)
17164 (setq futurep nil)
17165 (setq year (or iso-year year)
17166 day (or iso-weekday wday 1)
17167 wday nil ; to make sure that the trigger below does not match
17168 iso-date (calendar-gregorian-from-absolute
17169 (calendar-iso-to-absolute
17170 (list iso-week day year))))
17171 ; FIXME: Should we also push ISO weeks into the future?
17172 ; (when (and org-read-date-prefer-future
17173 ; (not iso-year)
17174 ; (< (calendar-absolute-from-gregorian iso-date)
17175 ; (time-to-days (current-time))))
17176 ; (setq year (1+ year)
17177 ; iso-date (calendar-gregorian-from-absolute
17178 ; (calendar-iso-to-absolute
17179 ; (list iso-week day year)))))
17180 (setq month (car iso-date)
17181 year (nth 2 iso-date)
17182 day (nth 1 iso-date)))
17183 (deltan
17184 (setq futurep nil)
17185 (unless deltadef
17186 ;; Pass `current-time' result to `decode-time' (instead of
17187 ;; calling without arguments) so that only `current-time' has
17188 ;; to be overriden in tests.
17189 (let ((now (decode-time (current-time))))
17190 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17191 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17192 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17193 ((equal deltaw "m") (setq month (+ month deltan)))
17194 ((equal deltaw "y") (setq year (+ year deltan)))))
17195 ((and wday (not (nth 3 tl)))
17196 ;; Weekday was given, but no day, so pick that day in the week
17197 ;; on or after the derived date.
17198 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17199 (unless (equal wday wday1)
17200 (setq day (+ day (% (- wday wday1 -7) 7))))))
17201 (if (and (boundp 'org-time-was-given)
17202 (nth 2 tl))
17203 (setq org-time-was-given t))
17204 (if (< year 100) (setq year (+ 2000 year)))
17205 ;; Check of the date is representable
17206 (if org-read-date-force-compatible-dates
17207 (progn
17208 (if (< year 1970)
17209 (setq year 1970 org-read-date-analyze-forced-year t))
17210 (if (> year 2037)
17211 (setq year 2037 org-read-date-analyze-forced-year t)))
17212 (condition-case nil
17213 (ignore (encode-time second minute hour day month year))
17214 (error
17215 (setq year (nth 5 org-defdecode))
17216 (setq org-read-date-analyze-forced-year t))))
17217 (setq org-read-date-analyze-futurep futurep)
17218 (list second minute hour day month year)))
17220 (defvar parse-time-weekdays)
17221 (defun org-read-date-get-relative (s today default)
17222 "Check string S for special relative date string.
17223 TODAY and DEFAULT are internal times, for today and for a default.
17224 Return shift list (N what def-flag)
17225 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17226 N is the number of WHATs to shift.
17227 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17228 the DEFAULT date rather than TODAY."
17229 (require 'parse-time)
17230 (when (and
17231 (string-match
17232 (concat
17233 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17234 "\\([0-9]+\\)?"
17235 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17236 "\\([ \t]\\|$\\)") s)
17237 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17238 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17239 (string-to-char (substring (match-string 1 s) -1))
17240 ?+))
17241 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17242 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17243 (what (if (match-end 3) (match-string 3 s) "d"))
17244 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17245 (date (if rel default today))
17246 (wday (nth 6 (decode-time date)))
17247 delta)
17248 (if wday1
17249 (progn
17250 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17251 (if (= delta 0) (setq delta 7))
17252 (if (= dir ?-)
17253 (progn
17254 (setq delta (- delta 7))
17255 (if (= delta 0) (setq delta -7))))
17256 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17257 (list delta "d" rel))
17258 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17260 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17261 "Turn a user-specified date into the internal representation.
17262 The internal representation needed by the calendar is (month day year).
17263 This is a wrapper to handle the brain-dead convention in calendar that
17264 user function argument order change dependent on argument order."
17265 (if (boundp 'calendar-date-style)
17266 (cond
17267 ((eq calendar-date-style 'american)
17268 (list arg1 arg2 arg3))
17269 ((eq calendar-date-style 'european)
17270 (list arg2 arg1 arg3))
17271 ((eq calendar-date-style 'iso)
17272 (list arg2 arg3 arg1)))
17273 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17274 (if (org-bound-and-true-p european-calendar-style)
17275 (list arg2 arg1 arg3)
17276 (list arg1 arg2 arg3)))))
17278 (defun org-eval-in-calendar (form &optional keepdate)
17279 "Eval FORM in the calendar window and return to current window.
17280 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17281 otherwise stick to the current value of `org-ans2'."
17282 (let ((sf (selected-frame))
17283 (sw (selected-window)))
17284 (select-window (get-buffer-window "*Calendar*" t))
17285 (eval form)
17286 (when (and (not keepdate) (calendar-cursor-to-date))
17287 (let* ((date (calendar-cursor-to-date))
17288 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17289 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17290 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17291 (select-window sw)
17292 (org-select-frame-set-input-focus sf)))
17294 (defun org-calendar-select ()
17295 "Return to `org-read-date' with the date currently selected.
17296 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17297 (interactive)
17298 (when (calendar-cursor-to-date)
17299 (let* ((date (calendar-cursor-to-date))
17300 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17301 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17302 (if (active-minibuffer-window) (exit-minibuffer))))
17304 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17305 "Insert a date stamp for the date given by the internal TIME.
17306 See `format-time-string' for the format of TIME.
17307 WITH-HM means use the stamp format that includes the time of the day.
17308 INACTIVE means use square brackets instead of angular ones, so that the
17309 stamp will not contribute to the agenda.
17310 PRE and POST are optional strings to be inserted before and after the
17311 stamp.
17312 The command returns the inserted time stamp."
17313 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17314 stamp)
17315 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17316 (insert-before-markers (or pre ""))
17317 (when (listp extra)
17318 (setq extra (car extra))
17319 (if (and (stringp extra)
17320 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17321 (setq extra (format "-%02d:%02d"
17322 (string-to-number (match-string 1 extra))
17323 (string-to-number (match-string 2 extra))))
17324 (setq extra nil)))
17325 (when extra
17326 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17327 (insert-before-markers (setq stamp (format-time-string fmt time)))
17328 (insert-before-markers (or post ""))
17329 (setq org-last-inserted-timestamp stamp)))
17331 (defun org-toggle-time-stamp-overlays ()
17332 "Toggle the use of custom time stamp formats."
17333 (interactive)
17334 (setq org-display-custom-times (not org-display-custom-times))
17335 (unless org-display-custom-times
17336 (let ((p (point-min)) (bmp (buffer-modified-p)))
17337 (while (setq p (next-single-property-change p 'display))
17338 (if (and (get-text-property p 'display)
17339 (eq (get-text-property p 'face) 'org-date))
17340 (remove-text-properties
17341 p (setq p (next-single-property-change p 'display))
17342 '(display t))))
17343 (set-buffer-modified-p bmp)))
17344 (if (featurep 'xemacs)
17345 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17346 (org-restart-font-lock)
17347 (setq org-table-may-need-update t)
17348 (if org-display-custom-times
17349 (message "Time stamps are overlaid with custom format")
17350 (message "Time stamp overlays removed")))
17352 (defun org-display-custom-time (beg end)
17353 "Overlay modified time stamp format over timestamp between BEG and END."
17354 (let* ((ts (buffer-substring beg end))
17355 t1 w1 with-hm tf time str w2 (off 0))
17356 (save-match-data
17357 (setq t1 (org-parse-time-string ts t))
17358 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17359 (setq off (- (match-end 0) (match-beginning 0)))))
17360 (setq end (- end off))
17361 (setq w1 (- end beg)
17362 with-hm (and (nth 1 t1) (nth 2 t1))
17363 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17364 time (org-fix-decoded-time t1)
17365 str (org-add-props
17366 (format-time-string
17367 (substring tf 1 -1) (apply 'encode-time time))
17368 nil 'mouse-face 'highlight)
17369 w2 (length str))
17370 (if (not (= w2 w1))
17371 (add-text-properties (1+ beg) (+ 2 beg)
17372 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17373 (if (featurep 'xemacs)
17374 (progn
17375 (put-text-property beg end 'invisible t)
17376 (put-text-property beg end 'end-glyph (make-glyph str)))
17377 (put-text-property beg end 'display str))))
17379 (defun org-fix-decoded-time (time)
17380 "Set 0 instead of nil for the first 6 elements of time.
17381 Don't touch the rest."
17382 (let ((n 0))
17383 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17385 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17387 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17388 "Difference between TIMESTAMP-STRING and now in days.
17389 If SECONDS is non-nil, return the difference in seconds."
17390 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17391 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17392 (funcall fdiff (current-time)))))
17394 (defun org-deadline-close (timestamp-string &optional ndays)
17395 "Is the time in TIMESTAMP-STRING close to the current date?"
17396 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17397 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17398 (not (org-entry-is-done-p))))
17400 (defun org-get-wdays (ts &optional delay zero-delay)
17401 "Get the deadline lead time appropriate for timestring TS.
17402 When DELAY is non-nil, get the delay time for scheduled items
17403 instead of the deadline lead time. When ZERO-DELAY is non-nil
17404 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17405 don't try to find the delay cookie in the scheduled timestamp."
17406 (let ((tv (if delay org-scheduled-delay-days
17407 org-deadline-warning-days)))
17408 (cond
17409 ((or (and delay (< tv 0))
17410 (and delay zero-delay (<= tv 0))
17411 (and (not delay) (<= tv 0)))
17412 ;; Enforce this value no matter what
17413 (- tv))
17414 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17415 ;; lead time is specified.
17416 (floor (* (string-to-number (match-string 1 ts))
17417 (cdr (assoc (match-string 2 ts)
17418 '(("d" . 1) ("w" . 7)
17419 ("m" . 30.4) ("y" . 365.25)
17420 ("h" . 0.041667)))))))
17421 ;; go for the default.
17422 (t tv))))
17424 (defun org-calendar-select-mouse (ev)
17425 "Return to `org-read-date' with the date currently selected.
17426 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17427 (interactive "e")
17428 (mouse-set-point ev)
17429 (when (calendar-cursor-to-date)
17430 (let* ((date (calendar-cursor-to-date))
17431 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17432 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17433 (if (active-minibuffer-window) (exit-minibuffer))))
17435 (defun org-check-deadlines (ndays)
17436 "Check if there are any deadlines due or past due.
17437 A deadline is considered due if it happens within `org-deadline-warning-days'
17438 days from today's date. If the deadline appears in an entry marked DONE,
17439 it is not shown. The prefix arg NDAYS can be used to test that many
17440 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17441 (interactive "P")
17442 (let* ((org-warn-days
17443 (cond
17444 ((equal ndays '(4)) 100000)
17445 (ndays (prefix-numeric-value ndays))
17446 (t (abs org-deadline-warning-days))))
17447 (case-fold-search nil)
17448 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17449 (callback
17450 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17451 (message "%d deadlines past-due or due within %d days"
17452 (org-occur regexp nil callback)
17453 org-warn-days)))
17455 (defsubst org-re-timestamp (type)
17456 "Return a regexp for timestamp TYPE.
17457 Allowed values for TYPE are:
17459 all: all timestamps
17460 active: only active timestamps (<...>)
17461 inactive: only inactive timestamps ([...])
17462 scheduled: only scheduled timestamps
17463 deadline: only deadline timestamps
17464 closed: only closed time-stamps
17466 When TYPE is nil, fall back on returning a regexp that matches
17467 both scheduled and deadline timestamps."
17468 (case type
17469 (all org-ts-regexp-both)
17470 (active org-ts-regexp)
17471 (inactive org-ts-regexp-inactive)
17472 (scheduled org-scheduled-time-regexp)
17473 (deadline org-deadline-time-regexp)
17474 (closed org-closed-time-regexp)
17475 (otherwise
17476 (concat "\\<"
17477 (regexp-opt (list org-deadline-string org-scheduled-string))
17478 " *<\\([^>]+\\)>"))))
17480 (defun org-check-before-date (date)
17481 "Check if there are deadlines or scheduled entries before DATE."
17482 (interactive (list (org-read-date)))
17483 (let ((case-fold-search nil)
17484 (regexp (org-re-timestamp org-ts-type))
17485 (callback
17486 `(lambda ()
17487 (let ((match (match-string 1)))
17488 (and ,(if (memq org-ts-type '(active inactive all))
17489 '(eq (org-element-type (org-element-context)) 'timestamp)
17490 '(org-at-planning-p))
17491 (time-less-p
17492 (org-time-string-to-time match)
17493 (org-time-string-to-time date)))))))
17494 (message "%d entries before %s"
17495 (org-occur regexp nil callback) date)))
17497 (defun org-check-after-date (date)
17498 "Check if there are deadlines or scheduled entries after DATE."
17499 (interactive (list (org-read-date)))
17500 (let ((case-fold-search nil)
17501 (regexp (org-re-timestamp org-ts-type))
17502 (callback
17503 `(lambda ()
17504 (let ((match (match-string 1)))
17505 (and ,(if (memq org-ts-type '(active inactive all))
17506 '(eq (org-element-type (org-element-context)) 'timestamp)
17507 '(org-at-planning-p))
17508 (not (time-less-p
17509 (org-time-string-to-time match)
17510 (org-time-string-to-time date))))))))
17511 (message "%d entries after %s"
17512 (org-occur regexp nil callback) date)))
17514 (defun org-check-dates-range (start-date end-date)
17515 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17516 (interactive (list (org-read-date nil nil nil "Range starts")
17517 (org-read-date nil nil nil "Range end")))
17518 (let ((case-fold-search nil)
17519 (regexp (org-re-timestamp org-ts-type))
17520 (callback
17521 `(lambda ()
17522 (let ((match (match-string 1)))
17523 (and
17524 ,(if (memq org-ts-type '(active inactive all))
17525 '(eq (org-element-type (org-element-context)) 'timestamp)
17526 '(org-at-planning-p))
17527 (not (time-less-p
17528 (org-time-string-to-time match)
17529 (org-time-string-to-time start-date)))
17530 (time-less-p
17531 (org-time-string-to-time match)
17532 (org-time-string-to-time end-date)))))))
17533 (message "%d entries between %s and %s"
17534 (org-occur regexp nil callback) start-date end-date)))
17536 (defun org-evaluate-time-range (&optional to-buffer)
17537 "Evaluate a time range by computing the difference between start and end.
17538 Normally the result is just printed in the echo area, but with prefix arg
17539 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17540 If the time range is actually in a table, the result is inserted into the
17541 next column.
17542 For time difference computation, a year is assumed to be exactly 365
17543 days in order to avoid rounding problems."
17544 (interactive "P")
17546 (org-clock-update-time-maybe)
17547 (save-excursion
17548 (unless (org-at-date-range-p t)
17549 (goto-char (point-at-bol))
17550 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17551 (if (not (org-at-date-range-p t))
17552 (user-error "Not at a time-stamp range, and none found in current line")))
17553 (let* ((ts1 (match-string 1))
17554 (ts2 (match-string 2))
17555 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17556 (match-end (match-end 0))
17557 (time1 (org-time-string-to-time ts1))
17558 (time2 (org-time-string-to-time ts2))
17559 (t1 (org-float-time time1))
17560 (t2 (org-float-time time2))
17561 (diff (abs (- t2 t1)))
17562 (negative (< (- t2 t1) 0))
17563 ;; (ys (floor (* 365 24 60 60)))
17564 (ds (* 24 60 60))
17565 (hs (* 60 60))
17566 (fy "%dy %dd %02d:%02d")
17567 (fy1 "%dy %dd")
17568 (fd "%dd %02d:%02d")
17569 (fd1 "%dd")
17570 (fh "%02d:%02d")
17571 y d h m align)
17572 (if havetime
17573 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17575 d (floor (/ diff ds)) diff (mod diff ds)
17576 h (floor (/ diff hs)) diff (mod diff hs)
17577 m (floor (/ diff 60)))
17578 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17580 d (floor (+ (/ diff ds) 0.5))
17581 h 0 m 0))
17582 (if (not to-buffer)
17583 (message "%s" (org-make-tdiff-string y d h m))
17584 (if (org-at-table-p)
17585 (progn
17586 (goto-char match-end)
17587 (setq align t)
17588 (and (looking-at " *|") (goto-char (match-end 0))))
17589 (goto-char match-end))
17590 (if (looking-at
17591 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17592 (replace-match ""))
17593 (if negative (insert " -"))
17594 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17595 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17596 (insert " " (format fh h m))))
17597 (if align (org-table-align))
17598 (message "Time difference inserted")))))
17600 (defun org-make-tdiff-string (y d h m)
17601 (let ((fmt "")
17602 (l nil))
17603 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17604 l (push y l)))
17605 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17606 l (push d l)))
17607 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17608 l (push h l)))
17609 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17610 l (push m l)))
17611 (apply 'format fmt (nreverse l))))
17613 (defun org-time-string-to-time (s &optional buffer pos)
17614 "Convert a timestamp string into internal time."
17615 (condition-case errdata
17616 (apply 'encode-time (org-parse-time-string s))
17617 (error (error "Bad timestamp `%s'%s\nError was: %s"
17618 s (if (not (and buffer pos))
17620 (format " at %d in buffer `%s'" pos buffer))
17621 (cdr errdata)))))
17623 (defun org-time-string-to-seconds (s)
17624 "Convert a timestamp string to a number of seconds."
17625 (org-float-time (org-time-string-to-time s)))
17627 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17628 "Convert a time stamp to an absolute day number.
17629 If there is a specifier for a cyclic time stamp, get the closest
17630 date to DAYNR.
17631 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17632 The variable `date' is bound by the calendar when this is called."
17633 (cond
17634 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17635 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17636 daynr
17637 (+ daynr 1000)))
17638 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17639 (> (string-to-number (match-string 1 s)) 0))
17640 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17641 (time-to-days (current-time))) (match-string 0 s)
17642 prefer show-all))
17643 (t (time-to-days
17644 (condition-case errdata
17645 (apply 'encode-time (org-parse-time-string s))
17646 (error (error "Bad timestamp `%s'%s\nError was: %s"
17647 s (if (not (and buffer pos))
17649 (format " at %d in buffer `%s'" pos buffer))
17650 (cdr errdata))))))))
17652 (defun org-days-to-iso-week (days)
17653 "Return the iso week number."
17654 (require 'cal-iso)
17655 (car (calendar-iso-from-absolute days)))
17657 (defun org-small-year-to-year (year)
17658 "Convert 2-digit years into 4-digit years.
17659 YEAR is expanded into one of the 30 next years, if possible, or
17660 into a past one. Any year larger than 99 is returned unchanged."
17661 (if (>= year 100) year
17662 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17663 (century (/ current 100))
17664 (offset (- year (% current 100))))
17665 (cond ((> offset 30) (+ (* (1- century) 100) year))
17666 ((> offset -70) (+ (* century 100) year))
17667 (t (+ (* (1+ century) 100) year))))))
17669 (defun org-time-from-absolute (d)
17670 "Return the time corresponding to date D.
17671 D may be an absolute day number, or a calendar-type list (month day year)."
17672 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17673 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17675 (defun org-calendar-holiday ()
17676 "List of holidays, for Diary display in Org-mode."
17677 (require 'holidays)
17678 (let ((hl (funcall
17679 (if (fboundp 'calendar-check-holidays)
17680 'calendar-check-holidays 'check-calendar-holidays) date)))
17681 (if hl (mapconcat 'identity hl "; "))))
17683 (defun org-diary-sexp-entry (sexp entry date)
17684 "Process a SEXP diary ENTRY for DATE."
17685 (require 'diary-lib)
17686 (let ((result (if calendar-debug-sexp
17687 (let ((stack-trace-on-error t))
17688 (eval (car (read-from-string sexp))))
17689 (condition-case nil
17690 (eval (car (read-from-string sexp)))
17691 (error
17692 (beep)
17693 (message "Bad sexp at line %d in %s: %s"
17694 (org-current-line)
17695 (buffer-file-name) sexp)
17696 (sleep-for 2))))))
17697 (cond ((stringp result) (split-string result "; "))
17698 ((and (consp result)
17699 (not (consp (cdr result)))
17700 (stringp (cdr result))) (cdr result))
17701 ((and (consp result)
17702 (stringp (car result))) result)
17703 (result entry))))
17705 (defun org-diary-to-ical-string (frombuf)
17706 "Get iCalendar entries from diary entries in buffer FROMBUF.
17707 This uses the icalendar.el library."
17708 (let* ((tmpdir (if (featurep 'xemacs)
17709 (temp-directory)
17710 temporary-file-directory))
17711 (tmpfile (make-temp-name
17712 (expand-file-name "orgics" tmpdir)))
17713 buf rtn b e)
17714 (with-current-buffer frombuf
17715 (icalendar-export-region (point-min) (point-max) tmpfile)
17716 (setq buf (find-buffer-visiting tmpfile))
17717 (set-buffer buf)
17718 (goto-char (point-min))
17719 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17720 (setq b (match-beginning 0)))
17721 (goto-char (point-max))
17722 (if (re-search-backward "^END:VEVENT" nil t)
17723 (setq e (match-end 0)))
17724 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17725 (kill-buffer buf)
17726 (delete-file tmpfile)
17727 rtn))
17729 (defun org-closest-date (start current change prefer show-all)
17730 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17731 When PREFER is `past', return a date that is either CURRENT or past.
17732 When PREFER is `future', return a date that is either CURRENT or future.
17733 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17734 ;; Make the proper lists from the dates
17735 (catch 'exit
17736 (let ((a1 '(("h" . hour)
17737 ("d" . day)
17738 ("w" . week)
17739 ("m" . month)
17740 ("y" . year)))
17741 (shour (nth 2 (org-parse-time-string start)))
17742 dn dw sday cday n1 n2 n0
17743 d m y y1 y2 date1 date2 nmonths nm ny m2)
17745 (setq start (org-date-to-gregorian start)
17746 current (org-date-to-gregorian
17747 (if show-all
17748 current
17749 (time-to-days (current-time))))
17750 sday (calendar-absolute-from-gregorian start)
17751 cday (calendar-absolute-from-gregorian current))
17753 (if (<= cday sday) (throw 'exit sday))
17755 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17756 (setq dn (string-to-number (match-string 1 change))
17757 dw (cdr (assoc (match-string 2 change) a1))))
17758 (unless (and dn (> dn 0))
17759 (user-error "Invalid change specifier: %s" change))
17760 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17761 (cond
17762 ((eq dw 'hour)
17763 (let ((missing-hours
17764 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17765 dn)))
17766 (setq n1 (if (zerop missing-hours) cday
17767 (- cday (1+ (floor (/ missing-hours 24)))))
17768 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17769 ((eq dw 'day)
17770 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17771 n2 (+ n1 dn)))
17772 ((eq dw 'year)
17773 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17774 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17775 (setq date1 (list m d y1)
17776 n1 (calendar-absolute-from-gregorian date1)
17777 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17778 n2 (calendar-absolute-from-gregorian date2)))
17779 ((eq dw 'month)
17780 ;; approx number of month between the two dates
17781 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17782 ;; How often does dn fit in there?
17783 (setq d (nth 1 start) m (car start) y (nth 2 start)
17784 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17785 m (+ m nm)
17786 ny (floor (/ m 12))
17787 y (+ y ny)
17788 m (- m (* ny 12)))
17789 (while (> m 12) (setq m (- m 12) y (1+ y)))
17790 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17791 (setq m2 (+ m dn) y2 y)
17792 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17793 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17794 (while (<= n2 cday)
17795 (setq n1 n2 m m2 y y2)
17796 (setq m2 (+ m dn) y2 y)
17797 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17798 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17799 ;; Make sure n1 is the earlier date
17800 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17801 (if show-all
17802 (cond
17803 ((eq prefer 'past) (if (= cday n2) n2 n1))
17804 ((eq prefer 'future) (if (= cday n1) n1 n2))
17805 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17806 (cond
17807 ((eq prefer 'past) (if (= cday n2) n2 n1))
17808 ((eq prefer 'future) (if (= cday n1) n1 n2))
17809 (t (if (= cday n1) n1 n2)))))))
17811 (defun org-date-to-gregorian (date)
17812 "Turn any specification of DATE into a Gregorian date for the calendar."
17813 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17814 ((and (listp date) (= (length date) 3)) date)
17815 ((stringp date)
17816 (setq date (org-parse-time-string date))
17817 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17818 ((listp date)
17819 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17821 (defun org-parse-time-string (s &optional nodefault)
17822 "Parse the standard Org-mode time string.
17823 This should be a lot faster than the normal `parse-time-string'.
17824 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17825 hour and minute fields will be nil if not given."
17826 (cond ((string-match org-ts-regexp0 s)
17827 (list 0
17828 (if (or (match-beginning 8) (not nodefault))
17829 (string-to-number (or (match-string 8 s) "0")))
17830 (if (or (match-beginning 7) (not nodefault))
17831 (string-to-number (or (match-string 7 s) "0")))
17832 (string-to-number (match-string 4 s))
17833 (string-to-number (match-string 3 s))
17834 (string-to-number (match-string 2 s))
17835 nil nil nil))
17836 ((string-match "^<[^>]+>$" s)
17837 (decode-time (seconds-to-time (org-matcher-time s))))
17838 (t (error "Not a standard Org-mode time string: %s" s))))
17840 (defun org-timestamp-up (&optional arg)
17841 "Increase the date item at the cursor by one.
17842 If the cursor is on the year, change the year. If it is on the month,
17843 the day or the time, change that.
17844 With prefix ARG, change by that many units."
17845 (interactive "p")
17846 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17848 (defun org-timestamp-down (&optional arg)
17849 "Decrease the date item at the cursor by one.
17850 If the cursor is on the year, change the year. If it is on the month,
17851 the day or the time, change that.
17852 With prefix ARG, change by that many units."
17853 (interactive "p")
17854 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17856 (defun org-timestamp-up-day (&optional arg)
17857 "Increase the date in the time stamp by one day.
17858 With prefix ARG, change that many days."
17859 (interactive "p")
17860 (if (and (not (org-at-timestamp-p t))
17861 (org-at-heading-p))
17862 (org-todo 'up)
17863 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17865 (defun org-timestamp-down-day (&optional arg)
17866 "Decrease the date in the time stamp by one day.
17867 With prefix ARG, change that many days."
17868 (interactive "p")
17869 (if (and (not (org-at-timestamp-p t))
17870 (org-at-heading-p))
17871 (org-todo 'down)
17872 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17874 (defun org-at-timestamp-p (&optional inactive-ok)
17875 "Non-nil if point is inside a timestamp.
17877 When optional argument INACTIVE-OK is non-nil, also consider
17878 inactive timestamps.
17880 When this function returns a non-nil value, match data is set
17881 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
17882 INACTIVE-OK."
17883 (interactive)
17884 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17885 (pos (point))
17886 (ans (or (looking-at tsr)
17887 (save-excursion
17888 (skip-chars-backward "^[<\n\r\t")
17889 (if (> (point) (point-min)) (backward-char 1))
17890 (and (looking-at tsr)
17891 (> (- (match-end 0) pos) -1))))))
17892 (and ans
17893 (boundp 'org-ts-what)
17894 (setq org-ts-what
17895 (cond
17896 ((= pos (match-beginning 0)) 'bracket)
17897 ;; Point is considered to be "on the bracket" whether
17898 ;; it's really on it or right after it.
17899 ((= pos (1- (match-end 0))) 'bracket)
17900 ((= pos (match-end 0)) 'after)
17901 ((org-pos-in-match-range pos 2) 'year)
17902 ((org-pos-in-match-range pos 3) 'month)
17903 ((org-pos-in-match-range pos 7) 'hour)
17904 ((org-pos-in-match-range pos 8) 'minute)
17905 ((or (org-pos-in-match-range pos 4)
17906 (org-pos-in-match-range pos 5)) 'day)
17907 ((and (> pos (or (match-end 8) (match-end 5)))
17908 (< pos (match-end 0)))
17909 (- pos (or (match-end 8) (match-end 5))))
17910 (t 'day))))
17911 ans))
17913 (defun org-toggle-timestamp-type ()
17914 "Toggle the type (<active> or [inactive]) of a time stamp."
17915 (interactive)
17916 (when (org-at-timestamp-p t)
17917 (let ((beg (match-beginning 0)) (end (match-end 0))
17918 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17919 (save-excursion
17920 (goto-char beg)
17921 (while (re-search-forward "[][<>]" end t)
17922 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17923 t t)))
17924 (message "Timestamp is now %sactive"
17925 (if (equal (char-after beg) ?<) "" "in")))))
17927 (defun org-at-clock-log-p nil
17928 "Is the cursor on the clock log line?"
17929 (save-excursion
17930 (move-beginning-of-line 1)
17931 (looking-at org-clock-line-re)))
17933 (defvar org-clock-history) ; defined in org-clock.el
17934 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17935 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17936 "Change the date in the time stamp at point.
17937 The date will be changed by N times WHAT. WHAT can be `day', `month',
17938 `year', `minute', `second'. If WHAT is not given, the cursor position
17939 in the timestamp determines what will be changed.
17940 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17941 (let ((origin (point)) origin-cat
17942 with-hm inactive
17943 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17944 org-ts-what
17945 extra rem
17946 ts time time0 fixnext clrgx)
17947 (if (not (org-at-timestamp-p t))
17948 (user-error "Not at a timestamp"))
17949 (if (and (not what) (eq org-ts-what 'bracket))
17950 (org-toggle-timestamp-type)
17951 ;; Point isn't on brackets. Remember the part of the time-stamp
17952 ;; the point was in. Indeed, size of time-stamps may change,
17953 ;; but point must be kept in the same category nonetheless.
17954 (setq origin-cat org-ts-what)
17955 (if (and (not what) (not (eq org-ts-what 'day))
17956 org-display-custom-times
17957 (get-text-property (point) 'display)
17958 (not (get-text-property (1- (point)) 'display)))
17959 (setq org-ts-what 'day))
17960 (setq org-ts-what (or what org-ts-what)
17961 inactive (= (char-after (match-beginning 0)) ?\[)
17962 ts (match-string 0))
17963 (replace-match "")
17964 (when (string-match
17965 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17967 (setq extra (match-string 1 ts))
17968 (if suppress-tmp-delay
17969 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17970 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17971 (setq with-hm t))
17972 (setq time0 (org-parse-time-string ts))
17973 (when (and updown
17974 (eq org-ts-what 'minute)
17975 (not current-prefix-arg))
17976 ;; This looks like s-up and s-down. Change by one rounding step.
17977 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17978 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17979 (setcar (cdr time0) (+ (nth 1 time0)
17980 (if (> n 0) (- rem) (- dm rem))))))
17981 (setq time
17982 (encode-time (or (car time0) 0)
17983 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17984 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17985 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17986 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17987 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17988 (nthcdr 6 time0)))
17989 (when (and (member org-ts-what '(hour minute))
17990 extra
17991 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17992 (setq extra (org-modify-ts-extra
17993 extra
17994 (if (eq org-ts-what 'hour) 2 5)
17995 n dm)))
17996 (when (integerp org-ts-what)
17997 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17998 (if (eq what 'calendar)
17999 (let ((cal-date (org-get-date-from-calendar)))
18000 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
18001 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
18002 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
18003 (setcar time0 (or (car time0) 0))
18004 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18005 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18006 (setq time (apply 'encode-time time0))))
18007 ;; Insert the new time-stamp, and ensure point stays in the same
18008 ;; category as before (i.e. not after the last position in that
18009 ;; category).
18010 (let ((pos (point)))
18011 ;; Stay before inserted string. `save-excursion' is of no use.
18012 (setq org-last-changed-timestamp
18013 (org-insert-time-stamp time with-hm inactive nil nil extra))
18014 (goto-char pos))
18015 (save-match-data
18016 (looking-at org-ts-regexp3)
18017 (goto-char (cond
18018 ;; `day' category ends before `hour' if any, or at
18019 ;; the end of the day name.
18020 ((eq origin-cat 'day)
18021 (min (or (match-beginning 7) (1- (match-end 5))) origin))
18022 ((eq origin-cat 'hour) (min (match-end 7) origin))
18023 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
18024 ((integerp origin-cat) (min (1- (match-end 0)) origin))
18025 ;; `year' and `month' have both fixed size: point
18026 ;; couldn't have moved into another part.
18027 (t origin))))
18028 ;; Update clock if on a CLOCK line.
18029 (org-clock-update-time-maybe)
18030 ;; Maybe adjust the closest clock in `org-clock-history'
18031 (when org-clock-adjust-closest
18032 (if (not (and (org-at-clock-log-p)
18033 (< 1 (length (delq nil (mapcar 'marker-position
18034 org-clock-history))))))
18035 (message "No clock to adjust")
18036 (cond ((save-excursion ; fix previous clock?
18037 (re-search-backward org-ts-regexp0 nil t)
18038 (org-looking-back (concat org-clock-string " \\[")))
18039 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18040 ((save-excursion ; fix next clock?
18041 (re-search-backward org-ts-regexp0 nil t)
18042 (looking-at (concat org-ts-regexp0 "\\] =>")))
18043 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18044 (save-window-excursion
18045 ;; Find closest clock to point, adjust the previous/next one in history
18046 (let* ((p (save-excursion (org-back-to-heading t)))
18047 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18048 (clfixnth
18049 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18050 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18051 (if (not clfixpos)
18052 (message "No clock to adjust")
18053 (save-excursion
18054 (org-goto-marker-or-bmk clfixpos)
18055 (org-show-subtree)
18056 (when (re-search-forward clrgx nil t)
18057 (goto-char (match-beginning 1))
18058 (let (org-clock-adjust-closest)
18059 (org-timestamp-change n org-ts-what updown))
18060 (message "Clock adjusted in %s for heading: %s"
18061 (file-name-nondirectory (buffer-file-name))
18062 (org-get-heading t t)))))))))
18063 ;; Try to recenter the calendar window, if any.
18064 (if (and org-calendar-follow-timestamp-change
18065 (get-buffer-window "*Calendar*" t)
18066 (memq org-ts-what '(day month year)))
18067 (org-recenter-calendar (time-to-days time))))))
18069 (defun org-modify-ts-extra (s pos n dm)
18070 "Change the different parts of the lead-time and repeat fields in timestamp."
18071 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18072 ng h m new rem)
18073 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18074 (cond
18075 ((or (org-pos-in-match-range pos 2)
18076 (org-pos-in-match-range pos 3))
18077 (setq m (string-to-number (match-string 3 s))
18078 h (string-to-number (match-string 2 s)))
18079 (if (org-pos-in-match-range pos 2)
18080 (setq h (+ h n))
18081 (setq n (* dm (org-no-warnings (signum n))))
18082 (when (not (= 0 (setq rem (% m dm))))
18083 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18084 (setq m (+ m n)))
18085 (if (< m 0) (setq m (+ m 60) h (1- h)))
18086 (if (> m 59) (setq m (- m 60) h (1+ h)))
18087 (setq h (min 24 (max 0 h)))
18088 (setq ng 1 new (format "-%02d:%02d" h m)))
18089 ((org-pos-in-match-range pos 6)
18090 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18091 ((org-pos-in-match-range pos 5)
18092 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18094 ((org-pos-in-match-range pos 9)
18095 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18096 ((org-pos-in-match-range pos 8)
18097 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18099 (when ng
18100 (setq s (concat
18101 (substring s 0 (match-beginning ng))
18103 (substring s (match-end ng))))))
18106 (defun org-recenter-calendar (date)
18107 "If the calendar is visible, recenter it to DATE."
18108 (let ((cwin (get-buffer-window "*Calendar*" t)))
18109 (when cwin
18110 (let ((calendar-move-hook nil))
18111 (with-selected-window cwin
18112 (calendar-goto-date (if (listp date) date
18113 (calendar-gregorian-from-absolute date))))))))
18115 (defun org-goto-calendar (&optional arg)
18116 "Go to the Emacs calendar at the current date.
18117 If there is a time stamp in the current line, go to that date.
18118 A prefix ARG can be used to force the current date."
18119 (interactive "P")
18120 (let ((tsr org-ts-regexp) diff
18121 (calendar-move-hook nil)
18122 (calendar-view-holidays-initially-flag nil)
18123 (calendar-view-diary-initially-flag nil))
18124 (if (or (org-at-timestamp-p)
18125 (save-excursion
18126 (beginning-of-line 1)
18127 (looking-at (concat ".*" tsr))))
18128 (let ((d1 (time-to-days (current-time)))
18129 (d2 (time-to-days
18130 (org-time-string-to-time (match-string 1)))))
18131 (setq diff (- d2 d1))))
18132 (calendar)
18133 (calendar-goto-today)
18134 (if (and diff (not arg)) (calendar-forward-day diff))))
18136 (defun org-get-date-from-calendar ()
18137 "Return a list (month day year) of date at point in calendar."
18138 (with-current-buffer "*Calendar*"
18139 (save-match-data
18140 (calendar-cursor-to-date))))
18142 (defun org-date-from-calendar ()
18143 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18144 If there is already a time stamp at the cursor position, update it."
18145 (interactive)
18146 (if (org-at-timestamp-p t)
18147 (org-timestamp-change 0 'calendar)
18148 (let ((cal-date (org-get-date-from-calendar)))
18149 (org-insert-time-stamp
18150 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18152 (defcustom org-effort-durations
18153 `(("min" . 1)
18154 ("h" . 60)
18155 ("d" . ,(* 60 8))
18156 ("w" . ,(* 60 8 5))
18157 ("m" . ,(* 60 8 5 4))
18158 ("y" . ,(* 60 8 5 40)))
18159 "Conversion factor to minutes for an effort modifier.
18161 Each entry has the form (MODIFIER . MINUTES).
18163 In an effort string, a number followed by MODIFIER is multiplied
18164 by the specified number of MINUTES to obtain an effort in
18165 minutes.
18167 For example, if the value of this variable is ((\"hours\" . 60)), then an
18168 effort string \"2hours\" is equivalent to 120 minutes."
18169 :group 'org-agenda
18170 :version "25.1"
18171 :package-version '(Org . "8.3")
18172 :type '(alist :key-type (string :tag "Modifier")
18173 :value-type (number :tag "Minutes")))
18175 (defun org-minutes-to-clocksum-string (m)
18176 "Format number of minutes as a clocksum string.
18177 The format is determined by `org-time-clocksum-format',
18178 `org-time-clocksum-use-fractional' and
18179 `org-time-clocksum-fractional-format' and
18180 `org-time-clocksum-use-effort-durations'."
18181 (let ((clocksum "")
18182 (m (round m)) ; Don't allow fractions of minutes
18183 h d w mo y fmt n)
18184 (setq h (if org-time-clocksum-use-effort-durations
18185 (cdr (assoc "h" org-effort-durations)) 60)
18186 d (if org-time-clocksum-use-effort-durations
18187 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18188 w (if org-time-clocksum-use-effort-durations
18189 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18190 mo (if org-time-clocksum-use-effort-durations
18191 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18192 y (if org-time-clocksum-use-effort-durations
18193 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18194 ;; fractional format
18195 (if org-time-clocksum-use-fractional
18196 (cond
18197 ;; single format string
18198 ((stringp org-time-clocksum-fractional-format)
18199 (format org-time-clocksum-fractional-format (/ m (float h))))
18200 ;; choice of fractional formats for different time units
18201 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18202 (> (/ (truncate m) (* y d h)) 0))
18203 (format fmt (/ m (* y d (float h)))))
18204 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18205 (> (/ (truncate m) (* mo d h)) 0))
18206 (format fmt (/ m (* mo d (float h)))))
18207 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18208 (> (/ (truncate m) (* w d h)) 0))
18209 (format fmt (/ m (* w d (float h)))))
18210 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18211 (> (/ (truncate m) (* d h)) 0))
18212 (format fmt (/ m (* d (float h)))))
18213 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18214 (> (/ (truncate m) h) 0))
18215 (format fmt (/ m (float h))))
18216 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18217 (format fmt m))
18218 ;; fall back to smallest time unit with a format
18219 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18220 (format fmt (/ m (float h))))
18221 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18222 (format fmt (/ m (* d (float h)))))
18223 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18224 (format fmt (/ m (* w d (float h)))))
18225 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18226 (format fmt (/ m (* mo d (float h)))))
18227 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18228 (format fmt (/ m (* y d (float h))))))
18229 ;; standard (non-fractional) format, with single format string
18230 (if (stringp org-time-clocksum-format)
18231 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18232 ;; separate formats components
18233 (and (setq fmt (plist-get org-time-clocksum-format :years))
18234 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18235 (plist-get org-time-clocksum-format :require-years))
18236 (setq clocksum (concat clocksum (format fmt n))
18237 m (- m (* n y d h))))
18238 (and (setq fmt (plist-get org-time-clocksum-format :months))
18239 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18240 (plist-get org-time-clocksum-format :require-months))
18241 (setq clocksum (concat clocksum (format fmt n))
18242 m (- m (* n mo d h))))
18243 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18244 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18245 (plist-get org-time-clocksum-format :require-weeks))
18246 (setq clocksum (concat clocksum (format fmt n))
18247 m (- m (* n w d h))))
18248 (and (setq fmt (plist-get org-time-clocksum-format :days))
18249 (or (> (setq n (/ (truncate m) (* d h))) 0)
18250 (plist-get org-time-clocksum-format :require-days))
18251 (setq clocksum (concat clocksum (format fmt n))
18252 m (- m (* n d h))))
18253 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18254 (or (> (setq n (/ (truncate m) h)) 0)
18255 (plist-get org-time-clocksum-format :require-hours))
18256 (setq clocksum (concat clocksum (format fmt n))
18257 m (- m (* n h))))
18258 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18259 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18260 (setq clocksum (concat clocksum (format fmt m))))
18261 ;; return formatted time duration
18262 clocksum))))
18264 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18265 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18266 "Org mode version 8.0")
18268 (defun org-hours-to-clocksum-string (n)
18269 (org-minutes-to-clocksum-string (* n 60)))
18271 (defun org-hh:mm-string-to-minutes (s)
18272 "Convert a string H:MM to a number of minutes.
18273 If the string is just a number, interpret it as minutes.
18274 In fact, the first hh:mm or number in the string will be taken,
18275 there can be extra stuff in the string.
18276 If no number is found, the return value is 0."
18277 (cond
18278 ((integerp s) s)
18279 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18280 (+ (* (string-to-number (match-string 1 s)) 60)
18281 (string-to-number (match-string 2 s))))
18282 ((string-match "\\([0-9]+\\)" s)
18283 (string-to-number (match-string 1 s)))
18284 (t 0)))
18286 (defcustom org-image-actual-width t
18287 "Should we use the actual width of images when inlining them?
18289 When set to t, always use the image width.
18291 When set to a number, use imagemagick (when available) to set
18292 the image's width to this value.
18294 When set to a number in a list, try to get the width from any
18295 #+ATTR.* keyword if it matches a width specification like
18297 #+ATTR_HTML: :width 300px
18299 and fall back on that number if none is found.
18301 When set to nil, try to get the width from an #+ATTR.* keyword
18302 and fall back on the original width if none is found.
18304 This requires Emacs >= 24.1, build with imagemagick support."
18305 :group 'org-appearance
18306 :version "24.4"
18307 :package-version '(Org . "8.0")
18308 :type '(choice
18309 (const :tag "Use the image width" t)
18310 (integer :tag "Use a number of pixels")
18311 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18312 (const :tag "Use #+ATTR* or don't resize" nil)))
18314 (defcustom org-agenda-inhibit-startup nil
18315 "Inhibit startup when preparing agenda buffers.
18316 When this variable is t, the initialization of the Org agenda
18317 buffers is inhibited: e.g. the visibility state is not set, the
18318 tables are not re-aligned, etc."
18319 :type 'boolean
18320 :version "24.3"
18321 :group 'org-agenda)
18323 (define-obsolete-variable-alias
18324 'org-agenda-ignore-drawer-properties
18325 'org-agenda-ignore-properties "25.1")
18327 (defcustom org-agenda-ignore-properties nil
18328 "Avoid updating text properties when building the agenda.
18329 Properties are used to prepare buffers for effort estimates,
18330 appointments, statistics and subtree-local categories.
18331 If you don't use these in the agenda, you can add them to this
18332 list and agenda building will be a bit faster.
18333 The value is a list, with zero or more of the symbols `effort', `appt',
18334 `stats' or `category'."
18335 :type '(set :greedy t
18336 (const effort)
18337 (const appt)
18338 (const stats)
18339 (const category))
18340 :version "25.1"
18341 :package-version '(Org . "8.3")
18342 :group 'org-agenda)
18344 (defun org-duration-string-to-minutes (s &optional output-to-string)
18345 "Convert a duration string S to minutes.
18347 A bare number is interpreted as minutes, modifiers can be set by
18348 customizing `org-effort-durations' (which see).
18350 Entries containing a colon are interpreted as H:MM by
18351 `org-hh:mm-string-to-minutes'."
18352 (let ((result 0)
18353 (re (concat "\\([0-9.]+\\) *\\("
18354 (regexp-opt (mapcar 'car org-effort-durations))
18355 "\\)")))
18356 (while (string-match re s)
18357 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18358 (string-to-number (match-string 1 s))))
18359 (setq s (replace-match "" nil t s)))
18360 (setq result (floor result))
18361 (incf result (org-hh:mm-string-to-minutes s))
18362 (if output-to-string (number-to-string result) result)))
18364 ;;;; Files
18366 (defun org-save-all-org-buffers ()
18367 "Save all Org-mode buffers without user confirmation."
18368 (interactive)
18369 (message "Saving all Org-mode buffers...")
18370 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18371 (when (featurep 'org-id) (org-id-locations-save))
18372 (message "Saving all Org-mode buffers... done"))
18374 (defun org-revert-all-org-buffers ()
18375 "Revert all Org-mode buffers.
18376 Prompt for confirmation when there are unsaved changes.
18377 Be sure you know what you are doing before letting this function
18378 overwrite your changes.
18380 This function is useful in a setup where one tracks org files
18381 with a version control system, to revert on one machine after pulling
18382 changes from another. I believe the procedure must be like this:
18384 1. M-x org-save-all-org-buffers
18385 2. Pull changes from the other machine, resolve conflicts
18386 3. M-x org-revert-all-org-buffers"
18387 (interactive)
18388 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18389 (user-error "Abort"))
18390 (save-excursion
18391 (save-window-excursion
18392 (mapc
18393 (lambda (b)
18394 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18395 (with-current-buffer b buffer-file-name))
18396 (org-pop-to-buffer-same-window b)
18397 (revert-buffer t 'no-confirm)))
18398 (buffer-list))
18399 (when (and (featurep 'org-id) org-id-track-globally)
18400 (org-id-locations-load)))))
18402 ;;;; Agenda files
18404 ;;;###autoload
18405 (defun org-switchb (&optional arg)
18406 "Switch between Org buffers.
18407 With one prefix argument, restrict available buffers to files.
18408 With two prefix arguments, restrict available buffers to agenda files.
18410 Defaults to `iswitchb' for buffer name completion.
18411 Set `org-completion-use-ido' to make it use ido instead."
18412 (interactive "P")
18413 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18414 ((equal arg '(16)) (org-buffer-list 'agenda))
18415 (t (org-buffer-list))))
18416 (org-completion-use-iswitchb org-completion-use-iswitchb)
18417 (org-completion-use-ido org-completion-use-ido))
18418 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18419 (setq org-completion-use-iswitchb t))
18420 (org-pop-to-buffer-same-window
18421 (org-icompleting-read "Org buffer: "
18422 (mapcar 'list (mapcar 'buffer-name blist))
18423 nil t))))
18425 ;;; Define some older names previously used for this functionality
18426 ;;;###autoload
18427 (defalias 'org-ido-switchb 'org-switchb)
18428 ;;;###autoload
18429 (defalias 'org-iswitchb 'org-switchb)
18431 (defun org-buffer-list (&optional predicate exclude-tmp)
18432 "Return a list of Org buffers.
18433 PREDICATE can be `export', `files' or `agenda'.
18435 export restrict the list to Export buffers.
18436 files restrict the list to buffers visiting Org files.
18437 agenda restrict the list to buffers visiting agenda files.
18439 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18440 (let* ((bfn nil)
18441 (agenda-files (and (eq predicate 'agenda)
18442 (mapcar 'file-truename (org-agenda-files t))))
18443 (filter
18444 (cond
18445 ((eq predicate 'files)
18446 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18447 ((eq predicate 'export)
18448 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18449 ((eq predicate 'agenda)
18450 (lambda (b)
18451 (with-current-buffer b
18452 (and (derived-mode-p 'org-mode)
18453 (setq bfn (buffer-file-name b))
18454 (member (file-truename bfn) agenda-files)))))
18455 (t (lambda (b) (with-current-buffer b
18456 (or (derived-mode-p 'org-mode)
18457 (string-match "\*Org .*Export"
18458 (buffer-name b)))))))))
18459 (delq nil
18460 (mapcar
18461 (lambda(b)
18462 (if (and (funcall filter b)
18463 (or (not exclude-tmp)
18464 (not (string-match "tmp" (buffer-name b)))))
18466 nil))
18467 (buffer-list)))))
18469 (defun org-agenda-files (&optional unrestricted archives)
18470 "Get the list of agenda files.
18471 Optional UNRESTRICTED means return the full list even if a restriction
18472 is currently in place.
18473 When ARCHIVES is t, include all archive files that are really being
18474 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18475 `org-agenda-archives-mode' is t."
18476 (let ((files
18477 (cond
18478 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18479 ((stringp org-agenda-files) (org-read-agenda-file-list))
18480 ((listp org-agenda-files) org-agenda-files)
18481 (t (error "Invalid value of `org-agenda-files'")))))
18482 (setq files (apply 'append
18483 (mapcar (lambda (f)
18484 (if (file-directory-p f)
18485 (directory-files
18486 f t org-agenda-file-regexp)
18487 (list f)))
18488 files)))
18489 (when org-agenda-skip-unavailable-files
18490 (setq files (delq nil
18491 (mapcar (function
18492 (lambda (file)
18493 (and (file-readable-p file) file)))
18494 files))))
18495 (when (or (eq archives t)
18496 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18497 (setq files (org-add-archive-files files)))
18498 files))
18500 (defun org-agenda-file-p (&optional file)
18501 "Return non-nil, if FILE is an agenda file.
18502 If FILE is omitted, use the file associated with the current
18503 buffer."
18504 (let ((fname (or file (buffer-file-name))))
18505 (and fname
18506 (member (file-truename fname)
18507 (mapcar #'file-truename (org-agenda-files t))))))
18509 (defun org-edit-agenda-file-list ()
18510 "Edit the list of agenda files.
18511 Depending on setup, this either uses customize to edit the variable
18512 `org-agenda-files', or it visits the file that is holding the list. In the
18513 latter case, the buffer is set up in a way that saving it automatically kills
18514 the buffer and restores the previous window configuration."
18515 (interactive)
18516 (if (stringp org-agenda-files)
18517 (let ((cw (current-window-configuration)))
18518 (find-file org-agenda-files)
18519 (org-set-local 'org-window-configuration cw)
18520 (org-add-hook 'after-save-hook
18521 (lambda ()
18522 (set-window-configuration
18523 (prog1 org-window-configuration
18524 (kill-buffer (current-buffer))))
18525 (org-install-agenda-files-menu)
18526 (message "New agenda file list installed"))
18527 nil 'local)
18528 (message "%s" (substitute-command-keys
18529 "Edit list and finish with \\[save-buffer]")))
18530 (customize-variable 'org-agenda-files)))
18532 (defun org-store-new-agenda-file-list (list)
18533 "Set new value for the agenda file list and save it correctly."
18534 (if (stringp org-agenda-files)
18535 (let ((fe (org-read-agenda-file-list t)) b u)
18536 (while (setq b (find-buffer-visiting org-agenda-files))
18537 (kill-buffer b))
18538 (with-temp-file org-agenda-files
18539 (insert
18540 (mapconcat
18541 (lambda (f) ;; Keep un-expanded entries.
18542 (if (setq u (assoc f fe))
18543 (cdr u)
18545 list "\n")
18546 "\n")))
18547 (let ((org-mode-hook nil) (org-inhibit-startup t)
18548 (org-insert-mode-line-in-empty-file nil))
18549 (setq org-agenda-files list)
18550 (customize-save-variable 'org-agenda-files org-agenda-files))))
18552 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18553 "Read the list of agenda files from a file.
18554 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18555 filenames, used by `org-store-new-agenda-file-list' to write back
18556 un-expanded file names."
18557 (when (file-directory-p org-agenda-files)
18558 (error "`org-agenda-files' cannot be a single directory"))
18559 (when (stringp org-agenda-files)
18560 (with-temp-buffer
18561 (insert-file-contents org-agenda-files)
18562 (mapcar
18563 (lambda (f)
18564 (let ((e (expand-file-name (substitute-in-file-name f)
18565 org-directory)))
18566 (if pair-with-expansion
18567 (cons e f)
18568 e)))
18569 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18571 ;;;###autoload
18572 (defun org-cycle-agenda-files ()
18573 "Cycle through the files in `org-agenda-files'.
18574 If the current buffer visits an agenda file, find the next one in the list.
18575 If the current buffer does not, find the first agenda file."
18576 (interactive)
18577 (let* ((fs (or (org-agenda-files t)
18578 (user-error "No agenda files")))
18579 (files (copy-sequence fs))
18580 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18581 file)
18582 (when tcf
18583 (while (and (setq file (pop files))
18584 (not (equal (file-truename file) tcf)))))
18585 (find-file (car (or files fs)))
18586 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18588 (defun org-agenda-file-to-front (&optional to-end)
18589 "Move/add the current file to the top of the agenda file list.
18590 If the file is not present in the list, it is added to the front. If it is
18591 present, it is moved there. With optional argument TO-END, add/move to the
18592 end of the list."
18593 (interactive "P")
18594 (let ((org-agenda-skip-unavailable-files nil)
18595 (file-alist (mapcar (lambda (x)
18596 (cons (file-truename x) x))
18597 (org-agenda-files t)))
18598 (ctf (file-truename
18599 (or buffer-file-name
18600 (user-error "Please save the current buffer to a file"))))
18601 x had)
18602 (setq x (assoc ctf file-alist) had x)
18604 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18605 (if to-end
18606 (setq file-alist (append (delq x file-alist) (list x)))
18607 (setq file-alist (cons x (delq x file-alist))))
18608 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18609 (org-install-agenda-files-menu)
18610 (message "File %s to %s of agenda file list"
18611 (if had "moved" "added") (if to-end "end" "front"))))
18613 (defun org-remove-file (&optional file)
18614 "Remove current file from the list of files in variable `org-agenda-files'.
18615 These are the files which are being checked for agenda entries.
18616 Optional argument FILE means use this file instead of the current."
18617 (interactive)
18618 (let* ((org-agenda-skip-unavailable-files nil)
18619 (file (or file buffer-file-name
18620 (user-error "Current buffer does not visit a file")))
18621 (true-file (file-truename file))
18622 (afile (abbreviate-file-name file))
18623 (files (delq nil (mapcar
18624 (lambda (x)
18625 (if (equal true-file
18626 (file-truename x))
18627 nil x))
18628 (org-agenda-files t)))))
18629 (if (not (= (length files) (length (org-agenda-files t))))
18630 (progn
18631 (org-store-new-agenda-file-list files)
18632 (org-install-agenda-files-menu)
18633 (message "Removed from Org Agenda list: %s" afile))
18634 (message "File was not in list: %s (not removed)" afile))))
18636 (defun org-file-menu-entry (file)
18637 (vector file (list 'find-file file) t))
18639 (defun org-check-agenda-file (file)
18640 "Make sure FILE exists. If not, ask user what to do."
18641 (when (not (file-exists-p file))
18642 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18643 (abbreviate-file-name file))
18644 (let ((r (downcase (read-char-exclusive))))
18645 (cond
18646 ((equal r ?r)
18647 (org-remove-file file)
18648 (throw 'nextfile t))
18649 (t (user-error "Abort"))))))
18651 (defun org-get-agenda-file-buffer (file)
18652 "Get an agenda buffer visiting FILE.
18653 If the buffer needs to be created, add it to the list of buffers
18654 which might be released later."
18655 (let ((buf (org-find-base-buffer-visiting file)))
18656 (if buf
18657 buf ; just return it
18658 ;; Make a new buffer and remember it
18659 (setq buf (find-file-noselect file))
18660 (if buf (push buf org-agenda-new-buffers))
18661 buf)))
18663 (defun org-release-buffers (blist)
18664 "Release all buffers in list, asking the user for confirmation when needed.
18665 When a buffer is unmodified, it is just killed. When modified, it is saved
18666 \(if the user agrees) and then killed."
18667 (let (file)
18668 (dolist (buf blist)
18669 (setq file (buffer-file-name buf))
18670 (when (and (buffer-modified-p buf)
18671 file
18672 (y-or-n-p (format "Save file %s? " file)))
18673 (with-current-buffer buf (save-buffer)))
18674 (kill-buffer buf))))
18676 (defun org-agenda-prepare-buffers (files)
18677 "Create buffers for all agenda files, protect archived trees and comments."
18678 (interactive)
18679 (let ((pa '(:org-archived t))
18680 (pc '(:org-comment t))
18681 (pall '(:org-archived t :org-comment t))
18682 (inhibit-read-only t)
18683 (org-inhibit-startup org-agenda-inhibit-startup)
18684 (rea (concat ":" org-archive-tag ":"))
18685 file re pos)
18686 (setq org-tag-alist-for-agenda nil
18687 org-tag-groups-alist-for-agenda nil)
18688 (save-excursion
18689 (save-restriction
18690 (dolist (file files)
18691 (catch 'nextfile
18692 (if (bufferp file)
18693 (set-buffer file)
18694 (org-check-agenda-file file)
18695 (set-buffer (org-get-agenda-file-buffer file)))
18696 (widen)
18697 (org-set-regexps-and-options 'tags-only)
18698 (setq pos (point))
18699 (or (memq 'category org-agenda-ignore-properties)
18700 (org-refresh-category-properties))
18701 (or (memq 'stats org-agenda-ignore-properties)
18702 (org-refresh-stats-properties))
18703 (or (memq 'effort org-agenda-ignore-properties)
18704 (org-refresh-effort-properties))
18705 (or (memq 'appt org-agenda-ignore-properties)
18706 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18707 (setq org-todo-keywords-for-agenda
18708 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18709 (setq org-done-keywords-for-agenda
18710 (append org-done-keywords-for-agenda org-done-keywords))
18711 (setq org-todo-keyword-alist-for-agenda
18712 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18713 (setq org-tag-alist-for-agenda
18714 (org-uniquify
18715 (append org-tag-alist-for-agenda
18716 org-tag-alist
18717 org-tag-persistent-alist)))
18718 (if org-group-tags
18719 (setq org-tag-groups-alist-for-agenda
18720 (org-uniquify-alist
18721 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18722 (org-with-silent-modifications
18723 (save-excursion
18724 (remove-text-properties (point-min) (point-max) pall)
18725 (when org-agenda-skip-archived-trees
18726 (goto-char (point-min))
18727 (while (re-search-forward rea nil t)
18728 (if (org-at-heading-p t)
18729 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18730 (goto-char (point-min))
18731 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18732 (while (re-search-forward re nil t)
18733 (when (save-match-data (org-in-commented-heading-p t))
18734 (add-text-properties
18735 (match-beginning 0) (org-end-of-subtree t) pc)))))
18736 (goto-char pos)))))
18737 (setq org-todo-keywords-for-agenda
18738 (org-uniquify org-todo-keywords-for-agenda))
18739 (setq org-todo-keyword-alist-for-agenda
18740 (org-uniquify org-todo-keyword-alist-for-agenda))))
18743 ;;;; CDLaTeX minor mode
18745 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18746 "Keymap for the minor `org-cdlatex-mode'.")
18748 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18749 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18750 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18751 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18752 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18754 (defvar org-cdlatex-texmathp-advice-is-done nil
18755 "Flag remembering if we have applied the advice to texmathp already.")
18757 (define-minor-mode org-cdlatex-mode
18758 "Toggle the minor `org-cdlatex-mode'.
18759 This mode supports entering LaTeX environment and math in LaTeX fragments
18760 in Org-mode.
18761 \\{org-cdlatex-mode-map}"
18762 nil " OCDL" nil
18763 (when org-cdlatex-mode
18764 (require 'cdlatex)
18765 (run-hooks 'cdlatex-mode-hook)
18766 (cdlatex-compute-tables))
18767 (unless org-cdlatex-texmathp-advice-is-done
18768 (setq org-cdlatex-texmathp-advice-is-done t)
18769 (defadvice texmathp (around org-math-always-on activate)
18770 "Always return t in org-mode buffers.
18771 This is because we want to insert math symbols without dollars even outside
18772 the LaTeX math segments. If Orgmode thinks that point is actually inside
18773 an embedded LaTeX fragment, let texmathp do its job.
18774 \\[org-cdlatex-mode-map]"
18775 (interactive)
18776 (let (p)
18777 (cond
18778 ((not (derived-mode-p 'org-mode)) ad-do-it)
18779 ((eq this-command 'cdlatex-math-symbol)
18780 (setq ad-return-value t
18781 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18783 (let ((p (org-inside-LaTeX-fragment-p)))
18784 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18785 (setq ad-return-value t
18786 texmathp-why '("Org-mode embedded math" . 0))
18787 (if p ad-do-it)))))))))
18789 (defun turn-on-org-cdlatex ()
18790 "Unconditionally turn on `org-cdlatex-mode'."
18791 (org-cdlatex-mode 1))
18793 (defun org-try-cdlatex-tab ()
18794 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18795 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18796 - inside a LaTeX fragment, or
18797 - after the first word in a line, where an abbreviation expansion could
18798 insert a LaTeX environment."
18799 (when org-cdlatex-mode
18800 (cond
18801 ;; Before any word on the line: No expansion possible.
18802 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18803 ;; Just after first word on the line: Expand it. Make sure it
18804 ;; cannot happen on headlines, though.
18805 ((save-excursion
18806 (skip-chars-backward "a-zA-Z0-9*")
18807 (skip-chars-backward " \t")
18808 (and (bolp) (not (org-at-heading-p))))
18809 (cdlatex-tab) t)
18810 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18812 (defun org-cdlatex-underscore-caret (&optional arg)
18813 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18814 Revert to the normal definition outside of these fragments."
18815 (interactive "P")
18816 (if (org-inside-LaTeX-fragment-p)
18817 (call-interactively 'cdlatex-sub-superscript)
18818 (let (org-cdlatex-mode)
18819 (call-interactively (key-binding (vector last-input-event))))))
18821 (defun org-cdlatex-math-modify (&optional arg)
18822 "Execute `cdlatex-math-modify' in LaTeX fragments.
18823 Revert to the normal definition outside of these fragments."
18824 (interactive "P")
18825 (if (org-inside-LaTeX-fragment-p)
18826 (call-interactively 'cdlatex-math-modify)
18827 (let (org-cdlatex-mode)
18828 (call-interactively (key-binding (vector last-input-event))))))
18830 (defun org-cdlatex-environment-indent (&optional environment item)
18831 "Execute `cdlatex-environment' and indent the inserted environment.
18833 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18835 The inserted environment is indented to current indentation
18836 unless point is at the beginning of the line, in which the
18837 environment remains unintended."
18838 (interactive)
18839 ;; cdlatex-environment always return nil. Therefore, capture output
18840 ;; first and determine if an environment was selected.
18841 (let* ((beg (point-marker))
18842 (end (copy-marker (point) t))
18843 (inserted (progn
18844 (ignore-errors (cdlatex-environment environment item))
18845 (< beg end)))
18846 ;; Figure out how many lines to move forward after the
18847 ;; environment has been inserted.
18848 (lines (when inserted
18849 (save-excursion
18850 (- (loop while (< beg (point))
18851 with x = 0
18852 do (forward-line -1)
18853 (incf x)
18854 finally return x)
18855 (if (progn (goto-char beg)
18856 (and (progn (skip-chars-forward " \t") (eolp))
18857 (progn (skip-chars-backward " \t") (bolp))))
18858 1 0)))))
18859 (env (org-trim (delete-and-extract-region beg end))))
18860 (when inserted
18861 ;; Get indentation of next line unless at column 0.
18862 (let ((ind (if (bolp) 0
18863 (save-excursion
18864 (org-return-indent)
18865 (prog1 (org-get-indentation)
18866 (when (progn (skip-chars-forward " \t") (eolp))
18867 (delete-region beg (point)))))))
18868 (bol (progn (skip-chars-backward " \t") (bolp))))
18869 ;; Insert a newline before environment unless at column zero
18870 ;; to "escape" the current line. Insert a newline if
18871 ;; something is one the same line as \end{ENVIRONMENT}.
18872 (insert
18873 (concat (unless bol "\n") env
18874 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18875 (unless (zerop ind)
18876 (save-excursion
18877 (goto-char beg)
18878 (while (< (point) end)
18879 (unless (eolp) (org-indent-line-to ind))
18880 (forward-line))))
18881 (goto-char beg)
18882 (forward-line lines)
18883 (org-indent-line-to ind)))
18884 (set-marker beg nil)
18885 (set-marker end nil)))
18888 ;;;; LaTeX fragments
18890 (defun org-inside-LaTeX-fragment-p ()
18891 "Test if point is inside a LaTeX fragment.
18892 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18893 sequence appearing also before point.
18894 Even though the matchers for math are configurable, this function assumes
18895 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18896 delimiters are skipped when they have been removed by customization.
18897 The return value is nil, or a cons cell with the delimiter and the
18898 position of this delimiter.
18900 This function does a reasonably good job, but can locally be fooled by
18901 for example currency specifications. For example it will assume being in
18902 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18903 fragments that are properly closed, but during editing, we have to live
18904 with the uncertainty caused by missing closing delimiters. This function
18905 looks only before point, not after."
18906 (catch 'exit
18907 (let ((pos (point))
18908 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18909 (lim (progn
18910 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18911 (point)))
18912 dd-on str (start 0) m re)
18913 (goto-char pos)
18914 (when dodollar
18915 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18916 re (nth 1 (assoc "$" org-latex-regexps)))
18917 (while (string-match re str start)
18918 (cond
18919 ((= (match-end 0) (length str))
18920 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18921 ((= (match-end 0) (- (length str) 5))
18922 (throw 'exit nil))
18923 (t (setq start (match-end 0))))))
18924 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18925 (goto-char pos)
18926 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18927 (and (match-beginning 2) (throw 'exit nil))
18928 ;; count $$
18929 (while (re-search-backward "\\$\\$" lim t)
18930 (setq dd-on (not dd-on)))
18931 (goto-char pos)
18932 (if dd-on (cons "$$" m))))))
18934 (defun org-inside-latex-macro-p ()
18935 "Is point inside a LaTeX macro or its arguments?"
18936 (save-match-data
18937 (org-in-regexp
18938 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18940 (defvar org-latex-fragment-image-overlays nil
18941 "List of overlays carrying the images of latex fragments.")
18942 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18944 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18945 "Remove all overlays with LaTeX fragment images in current buffer.
18946 When optional arguments BEG and END are non-nil, remove all
18947 overlays between them instead. Return t when some overlays were
18948 removed, nil otherwise."
18949 (let (removedp)
18950 (setq org-latex-fragment-image-overlays
18951 (let ((beg (or beg (point-min)))
18952 (end (or end (point-max))))
18953 (org-remove-if
18954 (lambda (o)
18955 (and (>= (overlay-start o) beg)
18956 (<= (overlay-end o) end)
18957 (progn (delete-overlay o)
18958 (or removedp (setq removedp t)))))
18959 org-latex-fragment-image-overlays)))
18960 removedp))
18962 (define-obsolete-function-alias
18963 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18964 (defun org-toggle-latex-fragment (&optional arg)
18965 "Preview the LaTeX fragment at point, or all locally or globally.
18967 If the cursor is on a LaTeX fragment, create the image and overlay
18968 it over the source code, if there is none. Remove it otherwise.
18969 If there is no fragment at point, display all fragments in the
18970 current section.
18972 With prefix ARG, preview or clear image for all fragments in the
18973 current subtree or in the whole buffer when used before the first
18974 headline. With a double prefix ARG \\[universal-argument] \
18975 \\[universal-argument] preview or clear images
18976 for all fragments in the buffer."
18977 (interactive "P")
18978 (unless (buffer-file-name (buffer-base-buffer))
18979 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18980 (when (display-graphic-p)
18981 (catch 'exit
18982 (save-excursion
18983 (let ((window-start (window-start)) msg)
18984 (save-restriction
18985 (cond
18986 ((or (equal arg '(16))
18987 (and (equal arg '(4))
18988 (org-with-limited-levels (org-before-first-heading-p))))
18989 (if (org-remove-latex-fragment-image-overlays)
18990 (progn (message "LaTeX fragments images removed from buffer")
18991 (throw 'exit nil))
18992 (setq msg "Creating images for buffer...")))
18993 ((equal arg '(4))
18994 (org-with-limited-levels (org-back-to-heading t))
18995 (let ((beg (point))
18996 (end (progn (org-end-of-subtree t) (point))))
18997 (if (org-remove-latex-fragment-image-overlays beg end)
18998 (progn
18999 (message "LaTeX fragment images removed from subtree")
19000 (throw 'exit nil))
19001 (setq msg "Creating images for subtree...")
19002 (narrow-to-region beg end))))
19003 ((let ((datum (org-element-context)))
19004 (when (memq (org-element-type datum)
19005 '(latex-environment latex-fragment))
19006 (let* ((beg (org-element-property :begin datum))
19007 (end (org-element-property :end datum)))
19008 (if (org-remove-latex-fragment-image-overlays beg end)
19009 (progn (message "LaTeX fragment image removed")
19010 (throw 'exit nil))
19011 (narrow-to-region beg end)
19012 (setq msg "Creating image..."))))))
19014 (org-with-limited-levels
19015 (let ((beg (if (org-at-heading-p) (line-beginning-position)
19016 (outline-previous-heading)
19017 (point)))
19018 (end (progn (outline-next-heading) (point))))
19019 (if (org-remove-latex-fragment-image-overlays beg end)
19020 (progn
19021 (message "LaTeX fragment images removed from section")
19022 (throw 'exit nil))
19023 (setq msg "Creating images for section...")
19024 (narrow-to-region beg end))))))
19025 (let ((file (buffer-file-name (buffer-base-buffer))))
19026 (org-format-latex
19027 (concat org-latex-preview-ltxpng-directory
19028 (file-name-sans-extension (file-name-nondirectory file)))
19029 ;; Emacs cannot overlay images from remote hosts.
19030 ;; Create it in `temporary-file-directory' instead.
19031 (if (file-remote-p file) temporary-file-directory
19032 default-directory)
19033 'overlays msg 'forbuffer
19034 org-latex-create-formula-image-program)))
19035 ;; Work around a bug that doesn't restore window's start
19036 ;; when widening back the buffer.
19037 (set-window-start nil window-start)
19038 (message (concat msg "done")))))))
19040 (defun org-format-latex
19041 (prefix &optional dir overlays msg forbuffer processing-type)
19042 "Replace LaTeX fragments with links to an image, and produce images.
19044 When optional argument OVERLAYS is non-nil, display the image on
19045 top of the fragment instead of replacing it.
19047 PROCESSING-TYPE is the conversion method to use, as a symbol.
19049 Some of the options can be changed using the variable
19050 `org-format-latex-options', which see."
19051 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19052 (unless (eq processing-type 'verbatim)
19053 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19054 (cnt 0)
19055 checkdir-flag)
19056 (goto-char (point-min))
19057 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19058 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19059 (overlay-recenter (point-max)))
19060 (while (re-search-forward math-regexp nil t)
19061 (unless (and overlays
19062 (eq (get-char-property (point) 'org-overlay-type)
19063 'org-latex-overlay))
19064 (let* ((context (org-element-context))
19065 (type (org-element-type context)))
19066 (when (memq type '(latex-environment latex-fragment))
19067 (let ((block-type (eq type 'latex-environment))
19068 (value (org-element-property :value context))
19069 (beg (org-element-property :begin context))
19070 (end (save-excursion
19071 (goto-char (org-element-property :end context))
19072 (skip-chars-backward " \r\t\n")
19073 (point))))
19074 (case processing-type
19075 (mathjax
19076 ;; Prepare for MathJax processing.
19077 (if (eq (char-after beg) ?$)
19078 (save-excursion
19079 (delete-region beg end)
19080 (insert "\\(" (substring value 1 -1) "\\)"))
19081 (goto-char end)))
19082 ((dvipng imagemagick)
19083 ;; Process to an image.
19084 (incf cnt)
19085 (goto-char beg)
19086 (let* ((face (face-at-point))
19087 ;; Get the colors from the face at point.
19089 (let ((color (plist-get org-format-latex-options
19090 :foreground)))
19091 (if (and forbuffer (eq color 'auto))
19092 (face-attribute face :foreground nil 'default)
19093 color)))
19095 (let ((color (plist-get org-format-latex-options
19096 :background)))
19097 (if (and forbuffer (eq color 'auto))
19098 (face-attribute face :background nil 'default)
19099 color)))
19100 (hash (sha1 (prin1-to-string
19101 (list org-format-latex-header
19102 org-latex-default-packages-alist
19103 org-latex-packages-alist
19104 org-format-latex-options
19105 forbuffer value fg bg))))
19106 (absprefix (expand-file-name prefix dir))
19107 (linkfile (format "%s_%s.png" prefix hash))
19108 (movefile (format "%s_%s.png" absprefix hash))
19109 (sep (and block-type "\n\n"))
19110 (link (concat sep "[[file:" linkfile "]]" sep))
19111 (options
19112 (org-combine-plists
19113 org-format-latex-options
19114 `(:foreground ,fg :background ,bg))))
19115 (when msg (message msg cnt))
19116 (unless checkdir-flag ; Ensure the directory exists.
19117 (setq checkdir-flag t)
19118 (let ((todir (file-name-directory absprefix)))
19119 (unless (file-directory-p todir)
19120 (make-directory todir t))))
19121 (unless (file-exists-p movefile)
19122 (org-create-formula-image
19123 value movefile options forbuffer processing-type))
19124 (if overlays
19125 (progn
19126 (dolist (o (overlays-in beg end))
19127 (when (eq (overlay-get o 'org-overlay-type)
19128 'org-latex-overlay)
19129 (delete-overlay o)))
19130 (let ((ov (make-overlay beg end)))
19131 (overlay-put ov
19132 'org-overlay-type
19133 'org-latex-overlay)
19134 (overlay-put ov 'evaporate t)
19135 (if (featurep 'xemacs)
19136 (progn
19137 (overlay-put ov 'invisible t)
19138 (overlay-put
19139 ov 'end-glyph
19140 (make-glyph
19141 (vector 'png :file movefile))))
19142 (overlay-put
19143 ov 'display
19144 (list 'image
19145 :type 'png
19146 :file movefile
19147 :ascent 'center)))
19148 (push ov org-latex-fragment-image-overlays))
19149 (goto-char end))
19150 (delete-region beg end)
19151 (insert
19152 (org-add-props link
19153 (list 'org-latex-src
19154 (replace-regexp-in-string "\"" "" value)
19155 'org-latex-src-embed-type
19156 (if block-type 'paragraph 'character)))))))
19157 (mathml
19158 ;; Process to MathML.
19159 (unless (org-format-latex-mathml-available-p)
19160 (user-error "LaTeX to MathML converter not configured"))
19161 (incf cnt)
19162 (when msg (message msg cnt))
19163 (goto-char beg)
19164 (delete-region beg end)
19165 (insert (org-format-latex-as-mathml
19166 value block-type prefix dir)))
19167 (otherwise
19168 (error "Unknown conversion type %s for LaTeX fragments"
19169 processing-type)))))))))))
19171 (defun org-create-math-formula (latex-frag &optional mathml-file)
19172 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19173 Use `org-latex-to-mathml-convert-command'. If the conversion is
19174 sucessful, return the portion between \"<math...> </math>\"
19175 elements otherwise return nil. When MATHML-FILE is specified,
19176 write the results in to that file. When invoked as an
19177 interactive command, prompt for LATEX-FRAG, with initial value
19178 set to the current active region and echo the results for user
19179 inspection."
19180 (interactive (list (let ((frag (when (org-region-active-p)
19181 (buffer-substring-no-properties
19182 (region-beginning) (region-end)))))
19183 (read-string "LaTeX Fragment: " frag nil frag))))
19184 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19185 (let* ((tmp-in-file (file-relative-name
19186 (make-temp-name (expand-file-name "ltxmathml-in"))))
19187 (ignore (write-region latex-frag nil tmp-in-file))
19188 (tmp-out-file (file-relative-name
19189 (make-temp-name (expand-file-name "ltxmathml-out"))))
19190 (cmd (format-spec
19191 org-latex-to-mathml-convert-command
19192 `((?j . ,(and org-latex-to-mathml-jar-file
19193 (shell-quote-argument
19194 (expand-file-name
19195 org-latex-to-mathml-jar-file))))
19196 (?I . ,(shell-quote-argument tmp-in-file))
19197 (?i . ,latex-frag)
19198 (?o . ,(shell-quote-argument tmp-out-file)))))
19199 mathml shell-command-output)
19200 (when (org-called-interactively-p 'any)
19201 (unless (org-format-latex-mathml-available-p)
19202 (user-error "LaTeX to MathML converter not configured")))
19203 (message "Running %s" cmd)
19204 (setq shell-command-output (shell-command-to-string cmd))
19205 (setq mathml
19206 (when (file-readable-p tmp-out-file)
19207 (with-current-buffer (find-file-noselect tmp-out-file t)
19208 (goto-char (point-min))
19209 (when (re-search-forward
19210 (concat
19211 (regexp-quote
19212 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19213 "[^>]*?>"
19214 "\\(.\\|\n\\)*"
19215 "</math>")
19216 nil t)
19217 (prog1 (match-string 0) (kill-buffer))))))
19218 (cond
19219 (mathml
19220 (setq mathml
19221 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19222 (when mathml-file
19223 (write-region mathml nil mathml-file))
19224 (when (org-called-interactively-p 'any)
19225 (message mathml)))
19226 ((message "LaTeX to MathML conversion failed")
19227 (message shell-command-output)))
19228 (delete-file tmp-in-file)
19229 (when (file-exists-p tmp-out-file)
19230 (delete-file tmp-out-file))
19231 mathml))
19233 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19234 prefix &optional dir)
19235 "Use `org-create-math-formula' but check local cache first."
19236 (let* ((absprefix (expand-file-name prefix dir))
19237 (print-length nil) (print-level nil)
19238 (formula-id (concat
19239 "formula-"
19240 (sha1
19241 (prin1-to-string
19242 (list latex-frag
19243 org-latex-to-mathml-convert-command)))))
19244 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19245 (formula-cache-dir (file-name-directory formula-cache)))
19247 (unless (file-directory-p formula-cache-dir)
19248 (make-directory formula-cache-dir t))
19250 (unless (file-exists-p formula-cache)
19251 (org-create-math-formula latex-frag formula-cache))
19253 (if (file-exists-p formula-cache)
19254 ;; Successful conversion. Return the link to MathML file.
19255 (org-add-props
19256 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19257 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19258 'org-latex-src-embed-type (if latex-frag-type
19259 'paragraph 'character)))
19260 ;; Failed conversion. Return the LaTeX fragment verbatim
19261 latex-frag)))
19263 (defun org-create-formula-image (string tofile options buffer &optional type)
19264 "Create an image from LaTeX source using dvipng or convert.
19265 This function calls either `org-create-formula-image-with-dvipng'
19266 or `org-create-formula-image-with-imagemagick' depending on the
19267 value of `org-latex-create-formula-image-program' or on the value
19268 of the optional TYPE variable.
19270 Note: ultimately these two function should be combined as they
19271 share a good deal of logic."
19272 (org-check-external-command
19273 "latex" "needed to convert LaTeX fragments to images")
19274 (funcall
19275 (case (or type org-latex-create-formula-image-program)
19276 (dvipng
19277 (org-check-external-command
19278 "dvipng" "needed to convert LaTeX fragments to images")
19279 #'org-create-formula-image-with-dvipng)
19280 (imagemagick
19281 (org-check-external-command
19282 "convert" "you need to install imagemagick")
19283 #'org-create-formula-image-with-imagemagick)
19284 (t (error
19285 "Invalid value of `org-latex-create-formula-image-program'")))
19286 string tofile options buffer))
19288 (declare-function org-export-get-backend "ox" (name))
19289 (declare-function org-export--get-global-options "ox" (&optional backend))
19290 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19291 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19292 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19293 (defun org-create-formula--latex-header ()
19294 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19295 (let ((info (org-combine-plists (org-export--get-global-options
19296 (org-export-get-backend 'latex))
19297 (org-export--get-inbuffer-options
19298 (org-export-get-backend 'latex)))))
19299 (org-latex-guess-babel-language
19300 (org-latex-guess-inputenc
19301 (org-splice-latex-header
19302 org-format-latex-header
19303 org-latex-default-packages-alist
19304 org-latex-packages-alist t
19305 (plist-get info :latex-header)))
19306 info)))
19308 (defun org--get-display-dpi ()
19309 "Get the DPI of the display.
19311 Assumes that the display has the same pixel width in the
19312 horizontal and vertical directions."
19313 (if (display-graphic-p)
19314 (round (/ (display-pixel-height)
19315 (/ (display-mm-height) 25.4)))
19316 (error "Attempt to calculate the dpi of a non-graphic display")))
19318 ;; This function borrows from Ganesh Swami's latex2png.el
19319 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19320 "This calls dvipng."
19321 (require 'ox-latex)
19322 (let* ((tmpdir (if (featurep 'xemacs)
19323 (temp-directory)
19324 temporary-file-directory))
19325 (texfilebase (make-temp-name
19326 (expand-file-name "orgtex" tmpdir)))
19327 (texfile (concat texfilebase ".tex"))
19328 (dvifile (concat texfilebase ".dvi"))
19329 (pngfile (concat texfilebase ".png"))
19330 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19331 ;; This assumes that the display has the same pixel width in
19332 ;; the horizontal and vertical directions
19333 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19334 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19335 "Black"))
19336 (bg (or (plist-get options (if buffer :background :html-background))
19337 "Transparent")))
19338 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19339 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19340 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19341 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19342 (let ((latex-header (org-create-formula--latex-header)))
19343 (with-temp-file texfile
19344 (insert latex-header)
19345 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19346 (let ((dir default-directory))
19347 (ignore-errors
19348 (cd tmpdir)
19349 (call-process "latex" nil nil nil texfile))
19350 (cd dir))
19351 (if (not (file-exists-p dvifile))
19352 (progn (message "Failed to create dvi file from %s" texfile) nil)
19353 (ignore-errors
19354 (if (featurep 'xemacs)
19355 (call-process "dvipng" nil nil nil
19356 "-fg" fg "-bg" bg
19357 "-T" "tight"
19358 "-o" pngfile
19359 dvifile)
19360 (call-process "dvipng" nil nil nil
19361 "-fg" fg "-bg" bg
19362 "-D" dpi
19363 ;;"-x" scale "-y" scale
19364 "-T" "tight"
19365 "-o" pngfile
19366 dvifile)))
19367 (if (not (file-exists-p pngfile))
19368 (if org-format-latex-signal-error
19369 (error "Failed to create png file from %s" texfile)
19370 (message "Failed to create png file from %s" texfile)
19371 nil)
19372 ;; Use the requested file name and clean up
19373 (copy-file pngfile tofile 'replace)
19374 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19375 (if (file-exists-p (concat texfilebase e))
19376 (delete-file (concat texfilebase e))))
19377 pngfile))))
19379 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19380 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19381 "This calls convert, which is included into imagemagick."
19382 (require 'ox-latex)
19383 (let* ((tmpdir (if (featurep 'xemacs)
19384 (temp-directory)
19385 temporary-file-directory))
19386 (texfilebase (make-temp-name
19387 (expand-file-name "orgtex" tmpdir)))
19388 (texfile (concat texfilebase ".tex"))
19389 (pdffile (concat texfilebase ".pdf"))
19390 (pngfile (concat texfilebase ".png"))
19391 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19392 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19393 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19394 "black"))
19395 (bg (or (plist-get options (if buffer :background :html-background))
19396 "white")))
19397 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19398 (setq fg (org-latex-color-format fg)))
19399 (if (eq bg 'default) (setq bg (org-latex-color :background))
19400 (setq bg (org-latex-color-format
19401 (if (string= bg "Transparent") "white" bg))))
19402 (let ((latex-header (org-create-formula--latex-header)))
19403 (with-temp-file texfile
19404 (insert latex-header)
19405 (insert "\n\\begin{document}\n"
19406 "\\definecolor{fg}{rgb}{" fg "}\n"
19407 "\\definecolor{bg}{rgb}{" bg "}\n"
19408 "\n\\pagecolor{bg}\n"
19409 "\n{\\color{fg}\n"
19410 string
19411 "\n}\n"
19412 "\n\\end{document}\n")))
19413 (org-latex-compile texfile t)
19414 (if (not (file-exists-p pdffile))
19415 (progn (message "Failed to create pdf file from %s" texfile) nil)
19416 (ignore-errors
19417 (if (featurep 'xemacs)
19418 (call-process "convert" nil nil nil
19419 "-density" "96"
19420 "-trim"
19421 "-antialias"
19422 pdffile
19423 "-quality" "100"
19424 ;; "-sharpen" "0x1.0"
19425 pngfile)
19426 (call-process "convert" nil nil nil
19427 "-density" dpi
19428 "-trim"
19429 "-antialias"
19430 pdffile
19431 "-quality" "100"
19432 ;; "-sharpen" "0x1.0"
19433 pngfile)))
19434 (if (not (file-exists-p pngfile))
19435 (if org-format-latex-signal-error
19436 (error "Failed to create png file from %s" texfile)
19437 (message "Failed to create png file from %s" texfile)
19438 nil)
19439 ;; Use the requested file name and clean up
19440 (copy-file pngfile tofile 'replace)
19441 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19442 (if (file-exists-p (concat texfilebase e))
19443 (delete-file (concat texfilebase e))))
19444 pngfile))))
19446 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19447 "Fill a LaTeX header template TPL.
19448 In the template, the following place holders will be recognized:
19450 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19451 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19452 [PACKAGES] \\usepackage statements for PKG
19453 [NO-PACKAGES] do not include PKG
19454 [EXTRA] the string EXTRA
19455 [NO-EXTRA] do not include EXTRA
19457 For backward compatibility, if both the positive and the negative place
19458 holder is missing, the positive one (without the \"NO-\") will be
19459 assumed to be present at the end of the template.
19460 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19461 EXTRA is a string.
19462 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19463 (let (rpl (end ""))
19464 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19465 (setq rpl (if (or (match-end 1) (not def-pkg))
19466 "" (org-latex-packages-to-string def-pkg snippets-p t))
19467 tpl (replace-match rpl t t tpl))
19468 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19470 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19471 (setq rpl (if (or (match-end 1) (not pkg))
19472 "" (org-latex-packages-to-string pkg snippets-p t))
19473 tpl (replace-match rpl t t tpl))
19474 (if pkg (setq end
19475 (concat end "\n"
19476 (org-latex-packages-to-string pkg snippets-p)))))
19478 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19479 (setq rpl (if (or (match-end 1) (not extra))
19480 "" (concat extra "\n"))
19481 tpl (replace-match rpl t t tpl))
19482 (if (and extra (string-match "\\S-" extra))
19483 (setq end (concat end "\n" extra))))
19485 (if (string-match "\\S-" end)
19486 (concat tpl "\n" end)
19487 tpl)))
19489 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19490 "Turn an alist of packages into a string with the \\usepackage macros."
19491 (setq pkg (mapconcat (lambda(p)
19492 (cond
19493 ((stringp p) p)
19494 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19495 (format "%% Package %s omitted" (cadr p)))
19496 ((equal "" (car p))
19497 (format "\\usepackage{%s}" (cadr p)))
19499 (format "\\usepackage[%s]{%s}"
19500 (car p) (cadr p)))))
19502 "\n"))
19503 (if newline (concat pkg "\n") pkg))
19505 (defun org-dvipng-color (attr)
19506 "Return a RGB color specification for dvipng."
19507 (apply 'format "rgb %s %s %s"
19508 (mapcar 'org-normalize-color
19509 (if (featurep 'xemacs)
19510 (color-rgb-components
19511 (face-property 'default
19512 (cond ((eq attr :foreground) 'foreground)
19513 ((eq attr :background) 'background))))
19514 (color-values (face-attribute 'default attr nil))))))
19516 (defun org-dvipng-color-format (color-name)
19517 "Convert COLOR-NAME to a RGB color value for dvipng."
19518 (apply 'format "rgb %s %s %s"
19519 (mapcar 'org-normalize-color
19520 (color-values color-name))))
19522 (defun org-latex-color (attr)
19523 "Return a RGB color for the LaTeX color package."
19524 (apply 'format "%s,%s,%s"
19525 (mapcar 'org-normalize-color
19526 (if (featurep 'xemacs)
19527 (color-rgb-components
19528 (face-property 'default
19529 (cond ((eq attr :foreground) 'foreground)
19530 ((eq attr :background) 'background))))
19531 (color-values (face-attribute 'default attr nil))))))
19533 (defun org-latex-color-format (color-name)
19534 "Convert COLOR-NAME to a RGB color value."
19535 (apply 'format "%s,%s,%s"
19536 (mapcar 'org-normalize-color
19537 (color-values color-name))))
19539 (defun org-normalize-color (value)
19540 "Return string to be used as color value for an RGB component."
19541 (format "%g" (/ value 65535.0)))
19545 ;; Image display
19547 (defvar org-inline-image-overlays nil)
19548 (make-variable-buffer-local 'org-inline-image-overlays)
19550 (defun org-toggle-inline-images (&optional include-linked)
19551 "Toggle the display of inline images.
19552 INCLUDE-LINKED is passed to `org-display-inline-images'."
19553 (interactive "P")
19554 (if org-inline-image-overlays
19555 (progn
19556 (org-remove-inline-images)
19557 (when (org-called-interactively-p 'interactive)
19558 (message "Inline image display turned off")))
19559 (org-display-inline-images include-linked)
19560 (when (org-called-interactively-p 'interactive)
19561 (message (if org-inline-image-overlays
19562 (format "%d images displayed inline"
19563 (length org-inline-image-overlays))
19564 "No images to display inline")))))
19566 (defun org-redisplay-inline-images ()
19567 "Refresh the display of inline images."
19568 (interactive)
19569 (if (not org-inline-image-overlays)
19570 (org-toggle-inline-images)
19571 (org-toggle-inline-images)
19572 (org-toggle-inline-images)))
19574 (defun org-display-inline-images (&optional include-linked refresh beg end)
19575 "Display inline images.
19577 An inline image is a link which follows either of these
19578 conventions:
19580 1. Its path is a file with an extension matching return value
19581 from `image-file-name-regexp' and it has no contents.
19583 2. Its description consists in a single link of the previous
19584 type.
19586 When optional argument INCLUDE-LINKED is non-nil, also links with
19587 a text description part will be inlined. This can be nice for
19588 a quick look at those images, but it does not reflect what
19589 exported files will look like.
19591 When optional argument REFRESH is non-nil, refresh existing
19592 images between BEG and END. This will create new image displays
19593 only if necessary. BEG and END default to the buffer
19594 boundaries."
19595 (interactive "P")
19596 (when (display-graphic-p)
19597 (unless refresh
19598 (org-remove-inline-images)
19599 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19600 (org-with-wide-buffer
19601 (goto-char (or beg (point-min)))
19602 (let ((case-fold-search t)
19603 (file-extension-re (org-image-file-name-regexp)))
19604 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19605 (let ((link (save-match-data (org-element-context))))
19606 ;; Check if we're at an inline image.
19607 (when (and (equal (org-element-property :type link) "file")
19608 (or include-linked
19609 (not (org-element-property :contents-begin link)))
19610 (let ((parent (org-element-property :parent link)))
19611 (or (not (eq (org-element-type parent) 'link))
19612 (not (cdr (org-element-contents parent)))))
19613 (org-string-match-p file-extension-re
19614 (org-element-property :path link)))
19615 (let ((file (expand-file-name
19616 (org-link-unescape
19617 (org-element-property :path link)))))
19618 (when (file-exists-p file)
19619 (let ((width
19620 ;; Apply `org-image-actual-width' specifications.
19621 (cond
19622 ((not (image-type-available-p 'imagemagick)) nil)
19623 ((eq org-image-actual-width t) nil)
19624 ((listp org-image-actual-width)
19626 ;; First try to find a width among
19627 ;; attributes associated to the paragraph
19628 ;; containing link.
19629 (let ((paragraph
19630 (let ((e link))
19631 (while (and (setq e (org-element-property
19632 :parent e))
19633 (not (eq (org-element-type e)
19634 'paragraph))))
19635 e)))
19636 (when paragraph
19637 (save-excursion
19638 (goto-char (org-element-property :begin paragraph))
19639 (when
19640 (re-search-forward
19641 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19642 (org-element-property
19643 :post-affiliated paragraph)
19645 (string-to-number (match-string 1))))))
19646 ;; Otherwise, fall-back to provided number.
19647 (car org-image-actual-width)))
19648 ((numberp org-image-actual-width)
19649 org-image-actual-width)))
19650 (old (get-char-property-and-overlay
19651 (org-element-property :begin link)
19652 'org-image-overlay)))
19653 (if (and (car-safe old) refresh)
19654 (image-refresh (overlay-get (cdr old) 'display))
19655 (let ((image (create-image file
19656 (and width 'imagemagick)
19658 :width width)))
19659 (when image
19660 (let* ((link
19661 ;; If inline image is the description
19662 ;; of another link, be sure to
19663 ;; consider the latter as the one to
19664 ;; apply the overlay on.
19665 (let ((parent
19666 (org-element-property :parent link)))
19667 (if (eq (org-element-type parent) 'link)
19668 parent
19669 link)))
19670 (ov (make-overlay
19671 (org-element-property :begin link)
19672 (progn
19673 (goto-char
19674 (org-element-property :end link))
19675 (skip-chars-backward " \t")
19676 (point)))))
19677 (overlay-put ov 'display image)
19678 (overlay-put ov 'face 'default)
19679 (overlay-put ov 'org-image-overlay t)
19680 (overlay-put
19681 ov 'modification-hooks
19682 (list 'org-display-inline-remove-overlay))
19683 (push ov org-inline-image-overlays)))))))))))))))
19685 (define-obsolete-function-alias
19686 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19688 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19689 "Remove inline-display overlay if a corresponding region is modified."
19690 (let ((inhibit-modification-hooks t))
19691 (when (and ov after)
19692 (delete ov org-inline-image-overlays)
19693 (delete-overlay ov))))
19695 (defun org-remove-inline-images ()
19696 "Remove inline display of images."
19697 (interactive)
19698 (mapc 'delete-overlay org-inline-image-overlays)
19699 (setq org-inline-image-overlays nil))
19701 ;;;; Key bindings
19703 ;; Outline functions from `outline-mode-prefix-map'
19704 ;; that can be remapped in Org:
19705 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19706 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19707 (define-key org-mode-map [remap outline-forward-same-level]
19708 'org-forward-heading-same-level)
19709 (define-key org-mode-map [remap outline-backward-same-level]
19710 'org-backward-heading-same-level)
19711 (define-key org-mode-map [remap show-branches]
19712 'org-kill-note-or-show-branches)
19713 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19714 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19715 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19716 (define-key org-mode-map [remap outline-next-visible-heading]
19717 'org-next-visible-heading)
19718 (define-key org-mode-map [remap outline-previous-visible-heading]
19719 'org-previous-visible-heading)
19721 ;; Outline functions from `outline-mode-prefix-map' that can not
19722 ;; be remapped in Org:
19724 ;; - the column "key binding" shows whether the Outline function is still
19725 ;; available in Org mode on the same key that it has been bound to in
19726 ;; Outline mode:
19727 ;; - "overridden": key used for a different functionality in Org mode
19728 ;; - else: key still bound to the same Outline function in Org mode
19730 ;; | Outline function | key binding | Org replacement |
19731 ;; |------------------------------------+-------------+--------------------------|
19732 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19733 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19734 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19735 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19736 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19737 ;; | `show-entry' | overridden | no replacement |
19738 ;; | `show-children' | `C-c C-i' | visibility cycling |
19739 ;; | `show-branches' | `C-c C-k' | still same function |
19740 ;; | `show-subtree' | overridden | visibility cycling |
19741 ;; | `show-all' | overridden | no replacement |
19742 ;; | `hide-subtree' | overridden | visibility cycling |
19743 ;; | `hide-body' | overridden | no replacement |
19744 ;; | `hide-entry' | overridden | visibility cycling |
19745 ;; | `hide-leaves' | overridden | no replacement |
19746 ;; | `hide-sublevels' | overridden | no replacement |
19747 ;; | `hide-other' | overridden | no replacement |
19749 ;; Make `C-c C-x' a prefix key
19750 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19752 ;; TAB key with modifiers
19753 (org-defkey org-mode-map "\C-i" 'org-cycle)
19754 (org-defkey org-mode-map [(tab)] 'org-cycle)
19755 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19756 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19757 ;; The following line is necessary under Suse GNU/Linux
19758 (unless (featurep 'xemacs)
19759 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19760 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19761 (define-key org-mode-map [backtab] 'org-shifttab)
19763 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19764 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19765 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19767 ;; Cursor keys with modifiers
19768 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19769 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19770 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19771 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19773 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19774 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19775 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19776 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19777 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19778 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19780 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19781 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19782 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19783 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19785 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19786 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19787 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19788 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19790 ;; Babel keys
19791 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19792 (mapc (lambda (pair)
19793 (define-key org-babel-map (car pair) (cdr pair)))
19794 org-babel-key-bindings)
19796 ;;; Extra keys for tty access.
19797 ;; We only set them when really needed because otherwise the
19798 ;; menus don't show the simple keys
19800 (when (or org-use-extra-keys
19801 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19802 (not window-system))
19803 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19804 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19805 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19806 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19807 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19808 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19809 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19810 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19811 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19812 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19813 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19814 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19815 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19816 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19817 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19818 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19819 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19820 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19821 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19822 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19823 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19824 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19825 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19826 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19827 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19828 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19829 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19830 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19832 ;; All the other keys
19834 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19835 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19836 (if (boundp 'narrow-map)
19837 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19838 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19839 (if (boundp 'narrow-map)
19840 (org-defkey narrow-map "b" 'org-narrow-to-block)
19841 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19842 (if (boundp 'narrow-map)
19843 (org-defkey narrow-map "e" 'org-narrow-to-element)
19844 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19845 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19846 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19847 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19848 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19849 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19850 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19851 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19852 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19853 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19854 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19855 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19856 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19857 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19858 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19859 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19860 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19861 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19862 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19863 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19864 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19865 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19866 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19867 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19868 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19869 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19870 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19871 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19872 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19873 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19874 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19875 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19876 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19877 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19878 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19879 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19880 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19881 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19882 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19883 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19884 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19885 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19886 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19887 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19888 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19889 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19890 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19891 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19892 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19893 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19894 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19895 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19896 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19897 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19898 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19899 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19900 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19901 (org-defkey org-mode-map "\C-c^" 'org-sort)
19902 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19903 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19904 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19905 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19906 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19907 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19908 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19909 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19910 (org-defkey org-mode-map "\C-m" 'org-return)
19911 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19912 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19913 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19914 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19915 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19916 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19917 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19918 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19919 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19920 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19921 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19922 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19923 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19924 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19925 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19926 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19927 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19928 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19929 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19930 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19931 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19932 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19933 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19934 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19935 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19937 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19938 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19939 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19941 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19942 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19943 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19944 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19945 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19946 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19947 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19948 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19949 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19950 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19951 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19952 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19953 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19954 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19955 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19956 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19957 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19958 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19959 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19960 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19961 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19962 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19964 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19965 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19966 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19967 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19968 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19970 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19972 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19974 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19975 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19977 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19980 (when (featurep 'xemacs)
19981 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19984 (defconst org-speed-commands-default
19986 ("Outline Navigation")
19987 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19988 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19989 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19990 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19991 ("F" . org-next-block)
19992 ("B" . org-previous-block)
19993 ("u" . (org-speed-move-safe 'outline-up-heading))
19994 ("j" . org-goto)
19995 ("g" . (org-refile t))
19996 ("Outline Visibility")
19997 ("c" . org-cycle)
19998 ("C" . org-shifttab)
19999 (" " . org-display-outline-path)
20000 ("s" . org-narrow-to-subtree)
20001 ("=" . org-columns)
20002 ("Outline Structure Editing")
20003 ("U" . org-metaup)
20004 ("D" . org-metadown)
20005 ("r" . org-metaright)
20006 ("l" . org-metaleft)
20007 ("R" . org-shiftmetaright)
20008 ("L" . org-shiftmetaleft)
20009 ("i" . (progn (forward-char 1) (call-interactively
20010 'org-insert-heading-respect-content)))
20011 ("^" . org-sort)
20012 ("w" . org-refile)
20013 ("a" . org-archive-subtree-default-with-confirmation)
20014 ("@" . org-mark-subtree)
20015 ("#" . org-toggle-comment)
20016 ("Clock Commands")
20017 ("I" . org-clock-in)
20018 ("O" . org-clock-out)
20019 ("Meta Data Editing")
20020 ("t" . org-todo)
20021 ("," . (org-priority))
20022 ("0" . (org-priority ?\ ))
20023 ("1" . (org-priority ?A))
20024 ("2" . (org-priority ?B))
20025 ("3" . (org-priority ?C))
20026 (":" . org-set-tags-command)
20027 ("e" . org-set-effort)
20028 ("E" . org-inc-effort)
20029 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20030 (org-entry-put (point) "APPT_WARNTIME" m)))
20031 ("Agenda Views etc")
20032 ("v" . org-agenda)
20033 ("/" . org-sparse-tree)
20034 ("Misc")
20035 ("o" . org-open-at-point)
20036 ("?" . org-speed-command-help)
20037 ("<" . (org-agenda-set-restriction-lock 'subtree))
20038 (">" . (org-agenda-remove-restriction-lock))
20040 "The default speed commands.")
20042 (defun org-print-speed-command (e)
20043 (if (> (length (car e)) 1)
20044 (progn
20045 (princ "\n")
20046 (princ (car e))
20047 (princ "\n")
20048 (princ (make-string (length (car e)) ?-))
20049 (princ "\n"))
20050 (princ (car e))
20051 (princ " ")
20052 (if (symbolp (cdr e))
20053 (princ (symbol-name (cdr e)))
20054 (prin1 (cdr e)))
20055 (princ "\n")))
20057 (defun org-speed-command-help ()
20058 "Show the available speed commands."
20059 (interactive)
20060 (if (not org-use-speed-commands)
20061 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20062 (with-output-to-temp-buffer "*Help*"
20063 (princ "User-defined Speed commands\n===========================\n")
20064 (mapc 'org-print-speed-command org-speed-commands-user)
20065 (princ "\n")
20066 (princ "Built-in Speed commands\n=======================\n")
20067 (mapc 'org-print-speed-command org-speed-commands-default))
20068 (with-current-buffer "*Help*"
20069 (setq truncate-lines t))))
20071 (defun org-speed-move-safe (cmd)
20072 "Execute CMD, but make sure that the cursor always ends up in a headline.
20073 If not, return to the original position and throw an error."
20074 (interactive)
20075 (let ((pos (point)))
20076 (call-interactively cmd)
20077 (unless (and (bolp) (org-at-heading-p))
20078 (goto-char pos)
20079 (error "Boundary reached while executing %s" cmd))))
20081 (defvar org-self-insert-command-undo-counter 0)
20083 (defvar org-table-auto-blank-field) ; defined in org-table.el
20084 (defvar org-speed-command nil)
20086 (define-obsolete-function-alias
20087 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20089 (defun org-speed-command-activate (keys)
20090 "Hook for activating single-letter speed commands.
20091 `org-speed-commands-default' specifies a minimal command set.
20092 Use `org-speed-commands-user' for further customization."
20093 (when (or (and (bolp) (looking-at org-outline-regexp))
20094 (and (functionp org-use-speed-commands)
20095 (funcall org-use-speed-commands)))
20096 (cdr (assoc keys (append org-speed-commands-user
20097 org-speed-commands-default)))))
20099 (define-obsolete-function-alias
20100 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20102 (defun org-babel-speed-command-activate (keys)
20103 "Hook for activating single-letter code block commands."
20104 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20105 (cdr (assoc keys org-babel-key-bindings))))
20107 (defcustom org-speed-command-hook
20108 '(org-speed-command-default-hook org-babel-speed-command-hook)
20109 "Hook for activating speed commands at strategic locations.
20110 Hook functions are called in sequence until a valid handler is
20111 found.
20113 Each hook takes a single argument, a user-pressed command key
20114 which is also a `self-insert-command' from the global map.
20116 Within the hook, examine the cursor position and the command key
20117 and return nil or a valid handler as appropriate. Handler could
20118 be one of an interactive command, a function, or a form.
20120 Set `org-use-speed-commands' to non-nil value to enable this
20121 hook. The default setting is `org-speed-command-activate'."
20122 :group 'org-structure
20123 :version "24.1"
20124 :type 'hook)
20126 (defun org-self-insert-command (N)
20127 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20128 If the cursor is in a table looking at whitespace, the whitespace is
20129 overwritten, and the table is not marked as requiring realignment."
20130 (interactive "p")
20131 (org-check-before-invisible-edit 'insert)
20132 (cond
20133 ((and org-use-speed-commands
20134 (let ((kv (this-command-keys-vector)))
20135 (setq org-speed-command
20136 (run-hook-with-args-until-success
20137 'org-speed-command-hook
20138 (make-string 1 (aref kv (1- (length kv))))))))
20139 (cond
20140 ((commandp org-speed-command)
20141 (setq this-command org-speed-command)
20142 (call-interactively org-speed-command))
20143 ((functionp org-speed-command)
20144 (funcall org-speed-command))
20145 ((and org-speed-command (listp org-speed-command))
20146 (eval org-speed-command))
20147 (t (let (org-use-speed-commands)
20148 (call-interactively 'org-self-insert-command)))))
20149 ((and
20150 (org-table-p)
20151 (progn
20152 ;; check if we blank the field, and if that triggers align
20153 (and (featurep 'org-table) org-table-auto-blank-field
20154 (memq last-command
20155 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20156 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20157 ;; got extra space, this field does not determine column width
20158 (let (org-table-may-need-update) (org-table-blank-field))
20159 ;; no extra space, this field may determine column width
20160 (org-table-blank-field)))
20162 (eq N 1)
20163 (looking-at "[^|\n]* |"))
20164 (let (org-table-may-need-update)
20165 (goto-char (1- (match-end 0)))
20166 (backward-delete-char 1)
20167 (goto-char (match-beginning 0))
20168 (self-insert-command N)))
20170 (setq org-table-may-need-update t)
20171 (self-insert-command N)
20172 (org-fix-tags-on-the-fly)
20173 (if org-self-insert-cluster-for-undo
20174 (if (not (eq last-command 'org-self-insert-command))
20175 (setq org-self-insert-command-undo-counter 1)
20176 (if (>= org-self-insert-command-undo-counter 20)
20177 (setq org-self-insert-command-undo-counter 1)
20178 (and (> org-self-insert-command-undo-counter 0)
20179 buffer-undo-list (listp buffer-undo-list)
20180 (not (cadr buffer-undo-list)) ; remove nil entry
20181 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20182 (setq org-self-insert-command-undo-counter
20183 (1+ org-self-insert-command-undo-counter))))))))
20185 (defun org-check-before-invisible-edit (kind)
20186 "Check is editing if kind KIND would be dangerous with invisible text around.
20187 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20188 ;; First, try to get out of here as quickly as possible, to reduce overhead
20189 (if (and org-catch-invisible-edits
20190 (or (not (boundp 'visible-mode)) (not visible-mode))
20191 (or (get-char-property (point) 'invisible)
20192 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20193 ;; OK, we need to take a closer look
20194 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20195 (invisible-before-point (if (bobp) nil (get-char-property
20196 (1- (point)) 'invisible)))
20197 (border-and-ok-direction
20199 ;; Check if we are acting predictably before invisible text
20200 (and invisible-at-point (not invisible-before-point)
20201 (memq kind '(insert delete-backward)))
20202 ;; Check if we are acting predictably after invisible text
20203 ;; This works not well, and I have turned it off. It seems
20204 ;; better to always show and stop after invisible text.
20205 ;; (and (not invisible-at-point) invisible-before-point
20206 ;; (memq kind '(insert delete)))
20208 (when (or (memq invisible-at-point '(outline org-hide-block t))
20209 (memq invisible-before-point '(outline org-hide-block t)))
20210 (if (eq org-catch-invisible-edits 'error)
20211 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20212 (if (and org-custom-properties-overlays
20213 (y-or-n-p "Display invisible properties in this buffer? "))
20214 (org-toggle-custom-properties-visibility)
20215 ;; Make the area visible
20216 (save-excursion
20217 (if invisible-before-point
20218 (goto-char (previous-single-char-property-change
20219 (point) 'invisible)))
20220 (show-subtree))
20221 (cond
20222 ((eq org-catch-invisible-edits 'show)
20223 ;; That's it, we do the edit after showing
20224 (message
20225 "Unfolding invisible region around point before editing")
20226 (sit-for 1))
20227 ((and (eq org-catch-invisible-edits 'smart)
20228 border-and-ok-direction)
20229 (message "Unfolding invisible region around point before editing"))
20231 ;; Don't do the edit, make the user repeat it in full visibility
20232 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20234 (defun org-fix-tags-on-the-fly ()
20235 (when (and (equal (char-after (point-at-bol)) ?*)
20236 (org-at-heading-p))
20237 (org-align-tags-here org-tags-column)))
20239 (defun org-delete-backward-char (N)
20240 "Like `delete-backward-char', insert whitespace at field end in tables.
20241 When deleting backwards, in tables this function will insert whitespace in
20242 front of the next \"|\" separator, to keep the table aligned. The table will
20243 still be marked for re-alignment if the field did fill the entire column,
20244 because, in this case the deletion might narrow the column."
20245 (interactive "p")
20246 (save-match-data
20247 (org-check-before-invisible-edit 'delete-backward)
20248 (if (and (org-table-p)
20249 (eq N 1)
20250 (string-match "|" (buffer-substring (point-at-bol) (point)))
20251 (looking-at ".*?|"))
20252 (let ((pos (point))
20253 (noalign (looking-at "[^|\n\r]* |"))
20254 (c org-table-may-need-update))
20255 (backward-delete-char N)
20256 (if (not overwrite-mode)
20257 (progn
20258 (skip-chars-forward "^|")
20259 (insert " ")
20260 (goto-char (1- pos))))
20261 ;; noalign: if there were two spaces at the end, this field
20262 ;; does not determine the width of the column.
20263 (if noalign (setq org-table-may-need-update c)))
20264 (backward-delete-char N)
20265 (org-fix-tags-on-the-fly))))
20267 (defun org-delete-char (N)
20268 "Like `delete-char', but insert whitespace at field end in tables.
20269 When deleting characters, in tables this function will insert whitespace in
20270 front of the next \"|\" separator, to keep the table aligned. The table will
20271 still be marked for re-alignment if the field did fill the entire column,
20272 because, in this case the deletion might narrow the column."
20273 (interactive "p")
20274 (save-match-data
20275 (org-check-before-invisible-edit 'delete)
20276 (if (and (org-table-p)
20277 (not (bolp))
20278 (not (= (char-after) ?|))
20279 (eq N 1))
20280 (if (looking-at ".*?|")
20281 (let ((pos (point))
20282 (noalign (looking-at "[^|\n\r]* |"))
20283 (c org-table-may-need-update))
20284 (replace-match
20285 (concat (substring (match-string 0) 1 -1) " |") nil t)
20286 (goto-char pos)
20287 ;; noalign: if there were two spaces at the end, this field
20288 ;; does not determine the width of the column.
20289 (if noalign (setq org-table-may-need-update c)))
20290 (delete-char N))
20291 (delete-char N)
20292 (org-fix-tags-on-the-fly))))
20294 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20295 (put 'org-self-insert-command 'delete-selection
20296 (lambda ()
20297 (not (run-hook-with-args-until-success
20298 'self-insert-uses-region-functions))))
20299 (put 'orgtbl-self-insert-command 'delete-selection
20300 (lambda ()
20301 (not (run-hook-with-args-until-success
20302 'self-insert-uses-region-functions))))
20303 (put 'org-delete-char 'delete-selection 'supersede)
20304 (put 'org-delete-backward-char 'delete-selection 'supersede)
20305 (put 'org-yank 'delete-selection 'yank)
20307 ;; Make `flyspell-mode' delay after some commands
20308 (put 'org-self-insert-command 'flyspell-delayed t)
20309 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20310 (put 'org-delete-char 'flyspell-delayed t)
20311 (put 'org-delete-backward-char 'flyspell-delayed t)
20313 ;; Make pabbrev-mode expand after org-mode commands
20314 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20315 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20317 (defun org-remap (map &rest commands)
20318 "In MAP, remap the functions given in COMMANDS.
20319 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20320 (let (new old)
20321 (while commands
20322 (setq old (pop commands) new (pop commands))
20323 (if (fboundp 'command-remapping)
20324 (org-defkey map (vector 'remap old) new)
20325 (substitute-key-definition old new map global-map)))))
20327 (defun org-transpose-words ()
20328 "Transpose words for Org.
20329 This uses the `org-mode-transpose-word-syntax-table' syntax
20330 table, which interprets characters in `org-emphasis-alist' as
20331 word constituents."
20332 (interactive)
20333 (with-syntax-table org-mode-transpose-word-syntax-table
20334 (call-interactively 'transpose-words)))
20335 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20337 (when (eq org-enable-table-editor 'optimized)
20338 ;; If the user wants maximum table support, we need to hijack
20339 ;; some standard editing functions
20340 (org-remap org-mode-map
20341 'self-insert-command 'org-self-insert-command
20342 'delete-char 'org-delete-char
20343 'delete-backward-char 'org-delete-backward-char)
20344 (org-defkey org-mode-map "|" 'org-force-self-insert))
20346 (defvar org-ctrl-c-ctrl-c-hook nil
20347 "Hook for functions attaching themselves to `C-c C-c'.
20349 This can be used to add additional functionality to the C-c C-c
20350 key which executes context-dependent commands. This hook is run
20351 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20352 run after the last test.
20354 Each function will be called with no arguments. The function
20355 must check if the context is appropriate for it to act. If yes,
20356 it should do its thing and then return a non-nil value. If the
20357 context is wrong, just do nothing and return nil.")
20359 (defvar org-ctrl-c-ctrl-c-final-hook nil
20360 "Hook for functions attaching themselves to `C-c C-c'.
20362 This can be used to add additional functionality to the C-c C-c
20363 key which executes context-dependent commands. This hook is run
20364 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20365 before the first test.
20367 Each function will be called with no arguments. The function
20368 must check if the context is appropriate for it to act. If yes,
20369 it should do its thing and then return a non-nil value. If the
20370 context is wrong, just do nothing and return nil.")
20372 (defvar org-tab-first-hook nil
20373 "Hook for functions to attach themselves to TAB.
20374 See `org-ctrl-c-ctrl-c-hook' for more information.
20375 This hook runs as the first action when TAB is pressed, even before
20376 `org-cycle' messes around with the `outline-regexp' to cater for
20377 inline tasks and plain list item folding.
20378 If any function in this hook returns t, any other actions that
20379 would have been caused by TAB (such as table field motion or visibility
20380 cycling) will not occur.")
20382 (defvar org-tab-after-check-for-table-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 after it has been established that the cursor is not in a
20386 table, but before checking if the cursor is in a headline or if global cycling
20387 should be done.
20388 If any function in this hook returns t, not other actions like visibility
20389 cycling will be done.")
20391 (defvar org-tab-after-check-for-cycling-hook nil
20392 "Hook for functions to attach themselves to TAB.
20393 See `org-ctrl-c-ctrl-c-hook' for more information.
20394 This hook runs after it has been established that not table field motion and
20395 not visibility should be done because of current context. This is probably
20396 the place where a package like yasnippets can hook in.")
20398 (defvar org-tab-before-tab-emulation-hook nil
20399 "Hook for functions to attach themselves to TAB.
20400 See `org-ctrl-c-ctrl-c-hook' for more information.
20401 This hook runs after every other options for TAB have been exhausted, but
20402 before indentation and \t insertion takes place.")
20404 (defvar org-metaleft-hook nil
20405 "Hook for functions attaching themselves to `M-left'.
20406 See `org-ctrl-c-ctrl-c-hook' for more information.")
20407 (defvar org-metaright-hook nil
20408 "Hook for functions attaching themselves to `M-right'.
20409 See `org-ctrl-c-ctrl-c-hook' for more information.")
20410 (defvar org-metaup-hook nil
20411 "Hook for functions attaching themselves to `M-up'.
20412 See `org-ctrl-c-ctrl-c-hook' for more information.")
20413 (defvar org-metadown-hook nil
20414 "Hook for functions attaching themselves to `M-down'.
20415 See `org-ctrl-c-ctrl-c-hook' for more information.")
20416 (defvar org-shiftmetaleft-hook nil
20417 "Hook for functions attaching themselves to `M-S-left'.
20418 See `org-ctrl-c-ctrl-c-hook' for more information.")
20419 (defvar org-shiftmetaright-hook nil
20420 "Hook for functions attaching themselves to `M-S-right'.
20421 See `org-ctrl-c-ctrl-c-hook' for more information.")
20422 (defvar org-shiftmetaup-hook nil
20423 "Hook for functions attaching themselves to `M-S-up'.
20424 See `org-ctrl-c-ctrl-c-hook' for more information.")
20425 (defvar org-shiftmetadown-hook nil
20426 "Hook for functions attaching themselves to `M-S-down'.
20427 See `org-ctrl-c-ctrl-c-hook' for more information.")
20428 (defvar org-metareturn-hook nil
20429 "Hook for functions attaching themselves to `M-RET'.
20430 See `org-ctrl-c-ctrl-c-hook' for more information.")
20431 (defvar org-shiftup-hook nil
20432 "Hook for functions attaching themselves to `S-up'.
20433 See `org-ctrl-c-ctrl-c-hook' for more information.")
20434 (defvar org-shiftup-final-hook nil
20435 "Hook for functions attaching themselves to `S-up'.
20436 This one runs after all other options except shift-select have been excluded.
20437 See `org-ctrl-c-ctrl-c-hook' for more information.")
20438 (defvar org-shiftdown-hook nil
20439 "Hook for functions attaching themselves to `S-down'.
20440 See `org-ctrl-c-ctrl-c-hook' for more information.")
20441 (defvar org-shiftdown-final-hook nil
20442 "Hook for functions attaching themselves to `S-down'.
20443 This one runs after all other options except shift-select have been excluded.
20444 See `org-ctrl-c-ctrl-c-hook' for more information.")
20445 (defvar org-shiftleft-hook nil
20446 "Hook for functions attaching themselves to `S-left'.
20447 See `org-ctrl-c-ctrl-c-hook' for more information.")
20448 (defvar org-shiftleft-final-hook nil
20449 "Hook for functions attaching themselves to `S-left'.
20450 This one runs after all other options except shift-select have been excluded.
20451 See `org-ctrl-c-ctrl-c-hook' for more information.")
20452 (defvar org-shiftright-hook nil
20453 "Hook for functions attaching themselves to `S-right'.
20454 See `org-ctrl-c-ctrl-c-hook' for more information.")
20455 (defvar org-shiftright-final-hook nil
20456 "Hook for functions attaching themselves to `S-right'.
20457 This one runs after all other options except shift-select have been excluded.
20458 See `org-ctrl-c-ctrl-c-hook' for more information.")
20460 (defun org-modifier-cursor-error ()
20461 "Throw an error, a modified cursor command was applied in wrong context."
20462 (user-error "This command is active in special context like tables, headlines or items"))
20464 (defun org-shiftselect-error ()
20465 "Throw an error because Shift-Cursor command was applied in wrong context."
20466 (if (and (boundp 'shift-select-mode) shift-select-mode)
20467 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20468 (user-error "This command works only in special context like headlines or timestamps")))
20470 (defun org-call-for-shift-select (cmd)
20471 (let ((this-command-keys-shift-translated t))
20472 (call-interactively cmd)))
20474 (defun org-shifttab (&optional arg)
20475 "Global visibility cycling or move to previous table field.
20476 Call `org-table-previous-field' within a table.
20477 When ARG is nil, cycle globally through visibility states.
20478 When ARG is a numeric prefix, show contents of this level."
20479 (interactive "P")
20480 (cond
20481 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20482 ((integerp arg)
20483 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20484 (message "Content view to level: %d" arg)
20485 (org-content (prefix-numeric-value arg2))
20486 (org-cycle-show-empty-lines t)
20487 (setq org-cycle-global-status 'overview)))
20488 (t (call-interactively 'org-global-cycle))))
20490 (defun org-shiftmetaleft ()
20491 "Promote subtree or delete table column.
20492 Calls `org-promote-subtree', `org-outdent-item-tree', or
20493 `org-table-delete-column', depending on context. See the
20494 individual commands for more information."
20495 (interactive)
20496 (cond
20497 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20498 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20499 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20500 ((if (not (org-region-active-p)) (org-at-item-p)
20501 (save-excursion (goto-char (region-beginning))
20502 (org-at-item-p)))
20503 (call-interactively 'org-outdent-item-tree))
20504 (t (org-modifier-cursor-error))))
20506 (defun org-shiftmetaright ()
20507 "Demote subtree or insert table column.
20508 Calls `org-demote-subtree', `org-indent-item-tree', or
20509 `org-table-insert-column', depending on context. See the
20510 individual commands for more information."
20511 (interactive)
20512 (cond
20513 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20514 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20515 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20516 ((if (not (org-region-active-p)) (org-at-item-p)
20517 (save-excursion (goto-char (region-beginning))
20518 (org-at-item-p)))
20519 (call-interactively 'org-indent-item-tree))
20520 (t (org-modifier-cursor-error))))
20522 (defun org-shiftmetaup (&optional arg)
20523 "Drag the line at point up.
20524 In a table, kill the current row.
20525 On a clock timestamp, update the value of the timestamp like `S-<up>'
20526 but also adjust the previous clocked item in the clock history.
20527 Everywhere else, drag the line at point up."
20528 (interactive "P")
20529 (cond
20530 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20531 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20532 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20533 (call-interactively 'org-timestamp-up)))
20534 (t (call-interactively 'org-drag-line-backward))))
20536 (defun org-shiftmetadown (&optional arg)
20537 "Drag the line at point down.
20538 In a table, insert an empty row at the current line.
20539 On a clock timestamp, update the value of the timestamp like `S-<down>'
20540 but also adjust the previous clocked item in the clock history.
20541 Everywhere else, drag the line at point down."
20542 (interactive "P")
20543 (cond
20544 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20545 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20546 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20547 (call-interactively 'org-timestamp-down)))
20548 (t (call-interactively 'org-drag-line-forward))))
20550 (defsubst org-hidden-tree-error ()
20551 (user-error
20552 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20554 (defun org-metaleft (&optional arg)
20555 "Promote heading, list item at point or move table column left.
20557 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20558 depending on context. With no specific context, calls the Emacs
20559 default `backward-word'. See the individual commands for more
20560 information.
20562 This function runs the hook `org-metaleft-hook' as a first step,
20563 and returns at first non-nil value."
20564 (interactive "P")
20565 (cond
20566 ((run-hook-with-args-until-success 'org-metaleft-hook))
20567 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20568 ((org-with-limited-levels
20569 (or (org-at-heading-p)
20570 (and (org-region-active-p)
20571 (save-excursion
20572 (goto-char (region-beginning))
20573 (org-at-heading-p)))))
20574 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20575 (call-interactively 'org-do-promote))
20576 ;; At an inline task.
20577 ((org-at-heading-p)
20578 (call-interactively 'org-inlinetask-promote))
20579 ((or (org-at-item-p)
20580 (and (org-region-active-p)
20581 (save-excursion
20582 (goto-char (region-beginning))
20583 (org-at-item-p))))
20584 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20585 (call-interactively 'org-outdent-item))
20586 (t (call-interactively 'backward-word))))
20588 (defun org-metaright (&optional arg)
20589 "Demote heading, list item at point or move table column right.
20591 In front of a drawer or a block keyword, indent it correctly.
20593 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20594 `org-indnet-drawer' or `org-indent-block' depending on context.
20595 With no specific context, calls the Emacs default `forward-word'.
20596 See the individual commands for more information.
20598 This function runs the hook `org-metaright-hook' as a first step,
20599 and returns at first non-nil value."
20600 (interactive "P")
20601 (cond
20602 ((run-hook-with-args-until-success 'org-metaright-hook))
20603 ((org-at-table-p) (call-interactively 'org-table-move-column))
20604 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20605 ((org-at-block-p) (call-interactively 'org-indent-block))
20606 ((org-with-limited-levels
20607 (or (org-at-heading-p)
20608 (and (org-region-active-p)
20609 (save-excursion
20610 (goto-char (region-beginning))
20611 (org-at-heading-p)))))
20612 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20613 (call-interactively 'org-do-demote))
20614 ;; At an inline task.
20615 ((org-at-heading-p)
20616 (call-interactively 'org-inlinetask-demote))
20617 ((or (org-at-item-p)
20618 (and (org-region-active-p)
20619 (save-excursion
20620 (goto-char (region-beginning))
20621 (org-at-item-p))))
20622 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20623 (call-interactively 'org-indent-item))
20624 (t (call-interactively 'forward-word))))
20626 (defun org-check-for-hidden (what)
20627 "Check if there are hidden headlines/items in the current visual line.
20628 WHAT can be either `headlines' or `items'. If the current line is
20629 an outline or item heading and it has a folded subtree below it,
20630 this function returns t, nil otherwise."
20631 (let ((re (cond
20632 ((eq what 'headlines) org-outline-regexp-bol)
20633 ((eq what 'items) (org-item-beginning-re))
20634 (t (error "This should not happen"))))
20635 beg end)
20636 (save-excursion
20637 (catch 'exit
20638 (unless (org-region-active-p)
20639 (setq beg (point-at-bol))
20640 (beginning-of-line 2)
20641 (while (and (not (eobp)) ;; this is like `next-line'
20642 (get-char-property (1- (point)) 'invisible))
20643 (beginning-of-line 2))
20644 (setq end (point))
20645 (goto-char beg)
20646 (goto-char (point-at-eol))
20647 (setq end (max end (point)))
20648 (while (re-search-forward re end t)
20649 (if (get-char-property (match-beginning 0) 'invisible)
20650 (throw 'exit t))))
20651 nil))))
20653 (defun org-metaup (&optional arg)
20654 "Move subtree up or move table row up.
20655 Calls `org-move-subtree-up' or `org-table-move-row' or
20656 `org-move-item-up', depending on context. See the individual commands
20657 for more information."
20658 (interactive "P")
20659 (cond
20660 ((run-hook-with-args-until-success 'org-metaup-hook))
20661 ((org-region-active-p)
20662 (let* ((a (min (region-beginning) (region-end)))
20663 (b (1- (max (region-beginning) (region-end))))
20664 (c (save-excursion (goto-char a)
20665 (move-beginning-of-line 0)))
20666 (d (save-excursion (goto-char a)
20667 (move-end-of-line 0) (point))))
20668 (transpose-regions a b c d)
20669 (goto-char c)))
20670 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20671 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20672 ((org-at-item-p) (call-interactively 'org-move-item-up))
20673 (t (org-drag-element-backward))))
20675 (defun org-metadown (&optional arg)
20676 "Move subtree down or move table row down.
20677 Calls `org-move-subtree-down' or `org-table-move-row' or
20678 `org-move-item-down', depending on context. See the individual
20679 commands for more information."
20680 (interactive "P")
20681 (cond
20682 ((run-hook-with-args-until-success 'org-metadown-hook))
20683 ((org-region-active-p)
20684 (let* ((a (min (region-beginning) (region-end)))
20685 (b (max (region-beginning) (region-end)))
20686 (c (save-excursion (goto-char b)
20687 (move-beginning-of-line 1)))
20688 (d (save-excursion (goto-char b)
20689 (move-end-of-line 1) (1+ (point)))))
20690 (transpose-regions a b c d)
20691 (goto-char d)))
20692 ((org-at-table-p) (call-interactively 'org-table-move-row))
20693 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20694 ((org-at-item-p) (call-interactively 'org-move-item-down))
20695 (t (org-drag-element-forward))))
20697 (defun org-shiftup (&optional arg)
20698 "Increase item in timestamp or increase priority of current headline.
20699 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20700 depending on context. See the individual commands for more information."
20701 (interactive "P")
20702 (cond
20703 ((run-hook-with-args-until-success 'org-shiftup-hook))
20704 ((and org-support-shift-select (org-region-active-p))
20705 (org-call-for-shift-select 'previous-line))
20706 ((org-at-timestamp-p t)
20707 (call-interactively (if org-edit-timestamp-down-means-later
20708 'org-timestamp-down 'org-timestamp-up)))
20709 ((and (not (eq org-support-shift-select 'always))
20710 org-enable-priority-commands
20711 (org-at-heading-p))
20712 (call-interactively 'org-priority-up))
20713 ((and (not org-support-shift-select) (org-at-item-p))
20714 (call-interactively 'org-previous-item))
20715 ((org-clocktable-try-shift 'up arg))
20716 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20717 (org-support-shift-select
20718 (org-call-for-shift-select 'previous-line))
20719 (t (org-shiftselect-error))))
20721 (defun org-shiftdown (&optional arg)
20722 "Decrease item in timestamp or decrease priority of current headline.
20723 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20724 depending on context. See the individual commands for more information."
20725 (interactive "P")
20726 (cond
20727 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20728 ((and org-support-shift-select (org-region-active-p))
20729 (org-call-for-shift-select 'next-line))
20730 ((org-at-timestamp-p t)
20731 (call-interactively (if org-edit-timestamp-down-means-later
20732 'org-timestamp-up 'org-timestamp-down)))
20733 ((and (not (eq org-support-shift-select 'always))
20734 org-enable-priority-commands
20735 (org-at-heading-p))
20736 (call-interactively 'org-priority-down))
20737 ((and (not org-support-shift-select) (org-at-item-p))
20738 (call-interactively 'org-next-item))
20739 ((org-clocktable-try-shift 'down arg))
20740 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20741 (org-support-shift-select
20742 (org-call-for-shift-select 'next-line))
20743 (t (org-shiftselect-error))))
20745 (defun org-shiftright (&optional arg)
20746 "Cycle the thing at point or in the current line, depending on context.
20747 Depending on context, this does one of the following:
20749 - switch a timestamp at point one day into the future
20750 - on a headline, switch to the next TODO keyword.
20751 - on an item, switch entire list to the next bullet type
20752 - on a property line, switch to the next allowed value
20753 - on a clocktable definition line, move time block into the future"
20754 (interactive "P")
20755 (cond
20756 ((run-hook-with-args-until-success 'org-shiftright-hook))
20757 ((and org-support-shift-select (org-region-active-p))
20758 (org-call-for-shift-select 'forward-char))
20759 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20760 ((and (not (eq org-support-shift-select 'always))
20761 (org-at-heading-p))
20762 (let ((org-inhibit-logging
20763 (not org-treat-S-cursor-todo-selection-as-state-change))
20764 (org-inhibit-blocking
20765 (not org-treat-S-cursor-todo-selection-as-state-change)))
20766 (org-call-with-arg 'org-todo 'right)))
20767 ((or (and org-support-shift-select
20768 (not (eq org-support-shift-select 'always))
20769 (org-at-item-bullet-p))
20770 (and (not org-support-shift-select) (org-at-item-p)))
20771 (org-call-with-arg 'org-cycle-list-bullet nil))
20772 ((and (not (eq org-support-shift-select 'always))
20773 (org-at-property-p))
20774 (call-interactively 'org-property-next-allowed-value))
20775 ((org-clocktable-try-shift 'right arg))
20776 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20777 (org-support-shift-select
20778 (org-call-for-shift-select 'forward-char))
20779 (t (org-shiftselect-error))))
20781 (defun org-shiftleft (&optional arg)
20782 "Cycle the thing at point or in the current line, depending on context.
20783 Depending on context, this does one of the following:
20785 - switch a timestamp at point one day into the past
20786 - on a headline, switch to the previous TODO keyword.
20787 - on an item, switch entire list to the previous bullet type
20788 - on a property line, switch to the previous allowed value
20789 - on a clocktable definition line, move time block into the past"
20790 (interactive "P")
20791 (cond
20792 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20793 ((and org-support-shift-select (org-region-active-p))
20794 (org-call-for-shift-select 'backward-char))
20795 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20796 ((and (not (eq org-support-shift-select 'always))
20797 (org-at-heading-p))
20798 (let ((org-inhibit-logging
20799 (not org-treat-S-cursor-todo-selection-as-state-change))
20800 (org-inhibit-blocking
20801 (not org-treat-S-cursor-todo-selection-as-state-change)))
20802 (org-call-with-arg 'org-todo 'left)))
20803 ((or (and org-support-shift-select
20804 (not (eq org-support-shift-select 'always))
20805 (org-at-item-bullet-p))
20806 (and (not org-support-shift-select) (org-at-item-p)))
20807 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20808 ((and (not (eq org-support-shift-select 'always))
20809 (org-at-property-p))
20810 (call-interactively 'org-property-previous-allowed-value))
20811 ((org-clocktable-try-shift 'left arg))
20812 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20813 (org-support-shift-select
20814 (org-call-for-shift-select 'backward-char))
20815 (t (org-shiftselect-error))))
20817 (defun org-shiftcontrolright ()
20818 "Switch to next TODO set."
20819 (interactive)
20820 (cond
20821 ((and org-support-shift-select (org-region-active-p))
20822 (org-call-for-shift-select 'forward-word))
20823 ((and (not (eq org-support-shift-select 'always))
20824 (org-at-heading-p))
20825 (org-call-with-arg 'org-todo 'nextset))
20826 (org-support-shift-select
20827 (org-call-for-shift-select 'forward-word))
20828 (t (org-shiftselect-error))))
20830 (defun org-shiftcontrolleft ()
20831 "Switch to previous TODO set."
20832 (interactive)
20833 (cond
20834 ((and org-support-shift-select (org-region-active-p))
20835 (org-call-for-shift-select 'backward-word))
20836 ((and (not (eq org-support-shift-select 'always))
20837 (org-at-heading-p))
20838 (org-call-with-arg 'org-todo 'previousset))
20839 (org-support-shift-select
20840 (org-call-for-shift-select 'backward-word))
20841 (t (org-shiftselect-error))))
20843 (defun org-shiftcontrolup (&optional n)
20844 "Change timestamps synchronously up in CLOCK log lines.
20845 Optional argument N tells to change by that many units."
20846 (interactive "P")
20847 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20848 (let (org-support-shift-select)
20849 (org-clock-timestamps-up n))
20850 (user-error "Not at a clock log")))
20852 (defun org-shiftcontroldown (&optional n)
20853 "Change timestamps synchronously down in CLOCK log lines.
20854 Optional argument N tells to change by that many units."
20855 (interactive "P")
20856 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20857 (let (org-support-shift-select)
20858 (org-clock-timestamps-down n))
20859 (user-error "Not at a clock log")))
20861 (defun org-increase-number-at-point (&optional inc)
20862 "Increment the number at point.
20863 With an optional prefix numeric argument INC, increment using
20864 this numeric value."
20865 (interactive "p")
20866 (if (not (number-at-point))
20867 (user-error "Not on a number")
20868 (unless inc (setq inc 1))
20869 (let ((pos (point))
20870 (beg (skip-chars-backward "-+^/*0-9eE."))
20871 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20872 (setq nap (buffer-substring-no-properties
20873 (+ pos beg) (+ pos beg end)))
20874 (delete-region (+ pos beg) (+ pos beg end))
20875 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20876 (when (org-at-table-p)
20877 (org-table-align)
20878 (org-table-end-of-field 1))))
20880 (defun org-decrease-number-at-point (&optional inc)
20881 "Decrement the number at point.
20882 With an optional prefix numeric argument INC, decrement using
20883 this numeric value."
20884 (interactive "p")
20885 (org-increase-number-at-point (- (or inc 1))))
20887 (defun org-ctrl-c-ret ()
20888 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20889 (interactive)
20890 (cond
20891 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20892 (t (call-interactively 'org-insert-heading))))
20894 (defun org-find-visible ()
20895 (let ((s (point)))
20896 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20897 (get-char-property s 'invisible)))
20899 (defun org-find-invisible ()
20900 (let ((s (point)))
20901 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20902 (not (get-char-property s 'invisible))))
20905 (defun org-copy-visible (beg end)
20906 "Copy the visible parts of the region."
20907 (interactive "r")
20908 (let (snippets s)
20909 (save-excursion
20910 (save-restriction
20911 (narrow-to-region beg end)
20912 (setq s (goto-char (point-min)))
20913 (while (not (= (point) (point-max)))
20914 (goto-char (org-find-invisible))
20915 (push (buffer-substring s (point)) snippets)
20916 (setq s (goto-char (org-find-visible))))))
20917 (kill-new (apply 'concat (nreverse snippets)))))
20919 (defun org-copy-special ()
20920 "Copy region in table or copy current subtree.
20921 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20922 See the individual commands for more information."
20923 (interactive)
20924 (call-interactively
20925 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20927 (defun org-cut-special ()
20928 "Cut region in table or cut current subtree.
20929 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20930 See the individual commands for more information."
20931 (interactive)
20932 (call-interactively
20933 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20935 (defun org-paste-special (arg)
20936 "Paste rectangular region into table, or past subtree relative to level.
20937 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20938 See the individual commands for more information."
20939 (interactive "P")
20940 (if (org-at-table-p)
20941 (org-table-paste-rectangle)
20942 (org-paste-subtree arg)))
20944 (defsubst org-in-fixed-width-region-p ()
20945 "Is point in a fixed-width region?"
20946 (save-match-data
20947 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20949 (defun org-edit-special (&optional arg)
20950 "Call a special editor for the element at point.
20951 When at a table, call the formula editor with `org-table-edit-formulas'.
20952 When in a source code block, call `org-edit-src-code'.
20953 When in a fixed-width region, call `org-edit-fixed-width-region'.
20954 When in an export block, call `org-edit-export-block'.
20955 When at an #+INCLUDE keyword, visit the included file.
20956 When at a footnote reference, call `org-edit-footnote-reference'
20957 On a link, call `ffap' to visit the link at point.
20958 Otherwise, return a user error."
20959 (interactive "P")
20960 (let ((element (org-element-at-point)))
20961 (assert (not buffer-read-only) nil
20962 "Buffer is read-only: %s" (buffer-name))
20963 (case (org-element-type element)
20964 (src-block
20965 (if (not arg) (org-edit-src-code)
20966 (let* ((info (org-babel-get-src-block-info))
20967 (lang (nth 0 info))
20968 (params (nth 2 info))
20969 (session (cdr (assq :session params))))
20970 (if (not session) (org-edit-src-code)
20971 ;; At a src-block with a session and function called with
20972 ;; an ARG: switch to the buffer related to the inferior
20973 ;; process.
20974 (switch-to-buffer
20975 (funcall (intern (concat "org-babel-prep-session:" lang))
20976 session params))))))
20977 (keyword
20978 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20979 (org-open-link-from-string
20980 (format "[[%s]]"
20981 (expand-file-name
20982 (let ((value (org-element-property :value element)))
20983 (cond ((not (org-string-nw-p value))
20984 (user-error "No file to edit"))
20985 ((string-match "\\`\"\\(.*?\\)\"" value)
20986 (match-string 1 value))
20987 ((string-match "\\`[^ \t\"]\\S-*" value)
20988 (match-string 0 value))
20989 (t (user-error "No valid file specified")))))))
20990 (user-error "No special environment to edit here")))
20991 (table
20992 (if (eq (org-element-property :type element) 'table.el)
20993 (org-edit-table.el)
20994 (call-interactively 'org-table-edit-formulas)))
20995 ;; Only Org tables contain `table-row' type elements.
20996 (table-row (call-interactively 'org-table-edit-formulas))
20997 (example-block (org-edit-src-code))
20998 (export-block (org-edit-export-block))
20999 (fixed-width (org-edit-fixed-width-region))
21000 (otherwise
21001 ;; No notable element at point. Though, we may be at a link or
21002 ;; a footnote reference, which are objects. Thus, scan deeper.
21003 (let ((context (org-element-context element)))
21004 (case (org-element-type context)
21005 (link (call-interactively #'ffap))
21006 (footnote-reference (org-edit-footnote-reference))
21007 (t (user-error "No special environment to edit here"))))))))
21009 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21010 (defun org-ctrl-c-ctrl-c (&optional arg)
21011 "Set tags in headline, or update according to changed information at point.
21013 This command does many different things, depending on context:
21015 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21016 this is what we do.
21018 - If the cursor is on a statistics cookie, update it.
21020 - If the cursor is in a headline, prompt for tags and insert them
21021 into the current line, aligned to `org-tags-column'. When called
21022 with prefix arg, realign all tags in the current buffer.
21024 - If the cursor is in one of the special #+KEYWORD lines, this
21025 triggers scanning the buffer for these lines and updating the
21026 information.
21028 - If the cursor is inside a table, realign the table. This command
21029 works even if the automatic table editor has been turned off.
21031 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21032 the entire table.
21034 - If the cursor is at a footnote reference or definition, jump to
21035 the corresponding definition or references, respectively.
21037 - If the cursor is a the beginning of a dynamic block, update it.
21039 - If the current buffer is a capture buffer, close note and file it.
21041 - If the cursor is on a <<<target>>>, update radio targets and
21042 corresponding links in this buffer.
21044 - If the cursor is on a numbered item in a plain list, renumber the
21045 ordered list.
21047 - If the cursor is on a checkbox, toggle it.
21049 - If the cursor is on a code block, evaluate it. The variable
21050 `org-confirm-babel-evaluate' can be used to control prompting
21051 before code block evaluation, by default every code block
21052 evaluation requires confirmation. Code block evaluation can be
21053 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21054 (interactive "P")
21055 (cond
21056 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21057 org-occur-highlights)
21058 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21059 (org-remove-occur-highlights)
21060 (message "Temporary highlights/overlays removed from current buffer"))
21061 ((and (local-variable-p 'org-finish-function (current-buffer))
21062 (fboundp org-finish-function))
21063 (funcall org-finish-function))
21064 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21066 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21067 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21068 (user-error "C-c C-c can do nothing useful at this location"))
21069 (let* ((context (org-element-context))
21070 (type (org-element-type context)))
21071 (case type
21072 ;; When at a link, act according to the parent instead.
21073 (link (setq context (org-element-property :parent context))
21074 (setq type (org-element-type context)))
21075 ;; Unsupported object types: refer to the first supported
21076 ;; element or object containing it.
21077 ((bold code entity export-snippet inline-babel-call inline-src-block
21078 italic latex-fragment line-break macro strike-through subscript
21079 superscript underline verbatim)
21080 (setq context
21081 (org-element-lineage
21082 context '(radio-target paragraph verse-block table-cell)))))
21083 ;; For convenience: at the first line of a paragraph on the
21084 ;; same line as an item, apply function on that item instead.
21085 (when (eq type 'paragraph)
21086 (let ((parent (org-element-property :parent context)))
21087 (when (and (eq (org-element-type parent) 'item)
21088 (= (line-beginning-position)
21089 (org-element-property :begin parent)))
21090 (setq context parent type 'item))))
21091 ;; Act according to type of element or object at point.
21092 (case type
21093 (clock (org-clock-update-time-maybe))
21094 (dynamic-block
21095 (save-excursion
21096 (goto-char (org-element-property :post-affiliated context))
21097 (org-update-dblock)))
21098 (footnote-definition
21099 (goto-char (org-element-property :post-affiliated context))
21100 (call-interactively 'org-footnote-action))
21101 (footnote-reference (call-interactively 'org-footnote-action))
21102 ((headline inlinetask)
21103 (save-excursion (goto-char (org-element-property :begin context))
21104 (call-interactively 'org-set-tags)))
21105 (item
21106 ;; At an item: a double C-u set checkbox to "[-]"
21107 ;; unconditionally, whereas a single one will toggle its
21108 ;; presence. Without a universal argument, if the item
21109 ;; has a checkbox, toggle it. Otherwise repair the list.
21110 (let* ((box (org-element-property :checkbox context))
21111 (struct (org-element-property :structure context))
21112 (old-struct (copy-tree struct))
21113 (parents (org-list-parents-alist struct))
21114 (prevs (org-list-prevs-alist struct))
21115 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21116 (org-list-set-checkbox
21117 (org-element-property :begin context) struct
21118 (cond ((equal arg '(16)) "[-]")
21119 ((and (not box) (equal arg '(4))) "[ ]")
21120 ((or (not box) (equal arg '(4))) nil)
21121 ((eq box 'on) "[ ]")
21122 (t "[X]")))
21123 ;; Mimic `org-list-write-struct' but with grabbing
21124 ;; a return value from `org-list-struct-fix-box'.
21125 (org-list-struct-fix-ind struct parents 2)
21126 (org-list-struct-fix-item-end struct)
21127 (org-list-struct-fix-bul struct prevs)
21128 (org-list-struct-fix-ind struct parents)
21129 (let ((block-item
21130 (org-list-struct-fix-box struct parents prevs orderedp)))
21131 (if (and box (equal struct old-struct))
21132 (if (equal arg '(16))
21133 (message "Checkboxes already reset")
21134 (user-error "Cannot toggle this checkbox: %s"
21135 (if (eq box 'on)
21136 "all subitems checked"
21137 "unchecked subitems")))
21138 (org-list-struct-apply-struct struct old-struct)
21139 (org-update-checkbox-count-maybe))
21140 (when block-item
21141 (message "Checkboxes were removed due to empty box at line %d"
21142 (org-current-line block-item))))))
21143 (keyword
21144 (let ((org-inhibit-startup-visibility-stuff t)
21145 (org-startup-align-all-tables nil))
21146 (when (boundp 'org-table-coordinate-overlays)
21147 (mapc 'delete-overlay org-table-coordinate-overlays)
21148 (setq org-table-coordinate-overlays nil))
21149 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21150 (message "Local setup has been refreshed"))
21151 (plain-list
21152 ;; At a plain list, with a double C-u argument, set
21153 ;; checkboxes of each item to "[-]", whereas a single one
21154 ;; will toggle their presence according to the state of the
21155 ;; first item in the list. Without an argument, repair the
21156 ;; list.
21157 (let* ((begin (org-element-property :contents-begin context))
21158 (beginm (move-marker (make-marker) begin))
21159 (struct (org-element-property :structure context))
21160 (old-struct (copy-tree struct))
21161 (first-box (save-excursion
21162 (goto-char begin)
21163 (looking-at org-list-full-item-re)
21164 (match-string-no-properties 3)))
21165 (new-box (cond ((equal arg '(16)) "[-]")
21166 ((equal arg '(4)) (unless first-box "[ ]"))
21167 ((equal first-box "[X]") "[ ]")
21168 (t "[X]"))))
21169 (cond
21170 (arg
21171 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21172 (org-list-get-all-items
21173 begin struct (org-list-prevs-alist struct))))
21174 ((and first-box (eq (point) begin))
21175 ;; For convenience, when point is at bol on the first
21176 ;; item of the list and no argument is provided, simply
21177 ;; toggle checkbox of that item, if any.
21178 (org-list-set-checkbox begin struct new-box)))
21179 (org-list-write-struct
21180 struct (org-list-parents-alist struct) old-struct)
21181 (org-update-checkbox-count-maybe)
21182 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21183 ((property-drawer node-property)
21184 (call-interactively 'org-property-action))
21185 ((radio-target target)
21186 (call-interactively 'org-update-radio-target-regexp))
21187 (statistics-cookie
21188 (call-interactively 'org-update-statistics-cookies))
21189 ((table table-cell table-row)
21190 ;; At a table, recalculate every field and align it. Also
21191 ;; send the table if necessary. If the table has
21192 ;; a `table.el' type, just give up. At a table row or
21193 ;; cell, maybe recalculate line but always align table.
21194 (if (eq (org-element-property :type context) 'table.el)
21195 (message "Use C-c ' to edit table.el tables")
21196 (let ((org-enable-table-editor t))
21197 (if (or (eq type 'table)
21198 ;; Check if point is at a TBLFM line.
21199 (and (eq type 'table-row)
21200 (= (point) (org-element-property :end context))))
21201 (save-excursion
21202 (if (org-at-TBLFM-p)
21203 (progn (require 'org-table)
21204 (org-table-calc-current-TBLFM))
21205 (goto-char (org-element-property :contents-begin context))
21206 (org-call-with-arg 'org-table-recalculate (or arg t))
21207 (orgtbl-send-table 'maybe)))
21208 (org-table-maybe-eval-formula)
21209 (cond (arg (call-interactively 'org-table-recalculate))
21210 ((org-table-maybe-recalculate-line))
21211 (t (org-table-align)))))))
21212 (timestamp (org-timestamp-change 0 'day))
21213 (otherwise
21214 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21215 (user-error
21216 "C-c C-c can do nothing useful at this location")))))))))
21218 (defun org-mode-restart ()
21219 (interactive)
21220 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21221 (funcall major-mode)
21222 (hack-local-variables)
21223 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21224 (org-indent-mode -1)))
21225 (message "%s restarted" major-mode))
21227 (defun org-kill-note-or-show-branches ()
21228 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21229 (interactive)
21230 (if (not org-finish-function)
21231 (progn
21232 (hide-subtree)
21233 (call-interactively 'show-branches))
21234 (let ((org-note-abort t))
21235 (funcall org-finish-function))))
21237 (defun org-delete-indentation (&optional ARG)
21238 "Join current line to previous and fix whitespace at join.
21240 If previous line is a headline add to headline title. Otherwise
21241 the function calls `delete-indentation'.
21243 With argument, join this line to following line."
21244 (interactive "*P")
21245 (if (save-excursion
21246 (if ARG (beginning-of-line)
21247 (forward-line -1))
21248 (looking-at org-complex-heading-regexp))
21249 ;; At headline.
21250 (let ((tags-column (when (match-beginning 5)
21251 (save-excursion (goto-char (match-beginning 5))
21252 (current-column))))
21253 (string (concat " " (progn (when ARG (forward-line 1))
21254 (org-trim (delete-and-extract-region
21255 (line-beginning-position)
21256 (line-end-position)))))))
21257 (unless (bobp) (delete-region (point) (1- (point))))
21258 (goto-char (or (match-end 4)
21259 (match-beginning 5)
21260 (match-end 0)))
21261 (skip-chars-backward " \t")
21262 (save-excursion (insert string))
21263 ;; Adjust alignment of tags.
21264 (when tags-column
21265 (org-align-tags-here (if org-auto-align-tags
21266 org-tags-column
21267 tags-column))))
21268 (delete-indentation ARG)))
21270 (defun org-open-line (n)
21271 "Insert a new row in tables, call `open-line' elsewhere.
21272 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21273 (interactive "*p")
21274 (cond
21275 ((not org-special-ctrl-o)
21276 (open-line n))
21277 ((org-at-table-p)
21278 (org-table-insert-row))
21280 (open-line n))))
21282 (defun org-return (&optional indent)
21283 "Goto next table row or insert a newline.
21285 Calls `org-table-next-row' or `newline', depending on context.
21287 When optional INDENT argument is non-nil, call
21288 `newline-and-indent' instead of `newline'.
21290 When `org-return-follows-link' is non-nil and point is on
21291 a timestamp or a link, call `org-open-at-point'. However, it
21292 will not happen if point is in a table or on a \"dead\"
21293 object (e.g., within a comment). In these case, you need to use
21294 `org-open-at-point' directly."
21295 (interactive)
21296 (let* ((context (if org-return-follows-link (org-element-context)
21297 (org-element-at-point)))
21298 (type (org-element-type context)))
21299 (cond
21300 ;; In a table, call `org-table-next-row'.
21301 ((or (and (eq type 'table)
21302 (>= (point) (org-element-property :contents-begin context))
21303 (< (point) (org-element-property :contents-end context)))
21304 (org-element-lineage context '(table-row table-cell) t))
21305 (org-table-justify-field-maybe)
21306 (call-interactively #'org-table-next-row))
21307 ;; On a link or a timestamp but not on white spaces after it,
21308 ;; call `org-open-line' if `org-return-follows-link' allows it.
21309 ((and org-return-follows-link
21310 (memq type '(link timestamp))
21311 (< (point)
21312 (save-excursion (goto-char (org-element-property :end context))
21313 (skip-chars-backward " \t")
21314 (point))))
21315 (call-interactively #'org-open-at-point))
21316 ;; Insert newline in heading, but preserve tags.
21317 ((and (not (bolp))
21318 (save-excursion (beginning-of-line)
21319 (looking-at org-complex-heading-regexp)))
21320 ;; At headline. Split line. However, if point is on keyword,
21321 ;; priority cookie or tags, do not break any of them: add
21322 ;; a newline after the headline instead.
21323 (let ((tags-column (and (match-beginning 5)
21324 (save-excursion (goto-char (match-beginning 5))
21325 (current-column))))
21326 (string
21327 (when (and (match-end 4)
21328 (>= (point)
21329 (or (match-end 3) (match-end 2) (1+ (match-end 1))))
21330 (<= (point) (match-end 4)))
21331 (delete-and-extract-region (point) (match-end 4)))))
21332 (when (and tags-column string) ; Adjust tag alignment.
21333 (org-align-tags-here
21334 (if org-auto-align-tags org-tags-column tags-column)))
21335 (end-of-line)
21336 (org-show-entry)
21337 (if indent (newline-and-indent) (newline))
21338 (when string (save-excursion (insert (org-trim string))))))
21339 ;; In a list, make sure indenting keeps trailing text within.
21340 ((and indent
21341 (not (eolp))
21342 (org-element-lineage context '(item)))
21343 (let ((trailing-data
21344 (delete-and-extract-region (point) (line-end-position))))
21345 (newline-and-indent)
21346 (save-excursion (insert trailing-data))))
21347 (t (if indent (newline-and-indent) (newline))))))
21349 (defun org-return-indent ()
21350 "Goto next table row or insert a newline and indent.
21351 Calls `org-table-next-row' or `newline-and-indent', depending on
21352 context. See the individual commands for more information."
21353 (interactive)
21354 (org-return t))
21356 (defun org-ctrl-c-star ()
21357 "Compute table, or change heading status of lines.
21358 Calls `org-table-recalculate' or `org-toggle-heading',
21359 depending on context."
21360 (interactive)
21361 (cond
21362 ((org-at-table-p)
21363 (call-interactively 'org-table-recalculate))
21365 ;; Convert all lines in region to list items
21366 (call-interactively 'org-toggle-heading))))
21368 (defun org-ctrl-c-minus ()
21369 "Insert separator line in table or modify bullet status of line.
21370 Also turns a plain line or a region of lines into list items.
21371 Calls `org-table-insert-hline', `org-toggle-item', or
21372 `org-cycle-list-bullet', depending on context."
21373 (interactive)
21374 (cond
21375 ((org-at-table-p)
21376 (call-interactively 'org-table-insert-hline))
21377 ((org-region-active-p)
21378 (call-interactively 'org-toggle-item))
21379 ((org-in-item-p)
21380 (call-interactively 'org-cycle-list-bullet))
21382 (call-interactively 'org-toggle-item))))
21384 (defun org-toggle-item (arg)
21385 "Convert headings or normal lines to items, items to normal lines.
21386 If there is no active region, only the current line is considered.
21388 If the first non blank line in the region is a headline, convert
21389 all headlines to items, shifting text accordingly.
21391 If it is an item, convert all items to normal lines.
21393 If it is normal text, change region into a list of items.
21394 With a prefix argument ARG, change the region in a single item."
21395 (interactive "P")
21396 (let ((shift-text
21397 (function
21398 ;; Shift text in current section to IND, from point to END.
21399 ;; The function leaves point to END line.
21400 (lambda (ind end)
21401 (let ((min-i 1000) (end (copy-marker end)))
21402 ;; First determine the minimum indentation (MIN-I) of
21403 ;; the text.
21404 (save-excursion
21405 (catch 'exit
21406 (while (< (point) end)
21407 (let ((i (org-get-indentation)))
21408 (cond
21409 ;; Skip blank lines and inline tasks.
21410 ((looking-at "^[ \t]*$"))
21411 ((looking-at org-outline-regexp-bol))
21412 ;; We can't find less than 0 indentation.
21413 ((zerop i) (throw 'exit (setq min-i 0)))
21414 ((< i min-i) (setq min-i i))))
21415 (forward-line))))
21416 ;; Then indent each line so that a line indented to
21417 ;; MIN-I becomes indented to IND. Ignore blank lines
21418 ;; and inline tasks in the process.
21419 (let ((delta (- ind min-i)))
21420 (while (< (point) end)
21421 (unless (or (looking-at "^[ \t]*$")
21422 (looking-at org-outline-regexp-bol))
21423 (org-indent-line-to (+ (org-get-indentation) delta)))
21424 (forward-line)))))))
21425 (skip-blanks
21426 (function
21427 ;; Return beginning of first non-blank line, starting from
21428 ;; line at POS.
21429 (lambda (pos)
21430 (save-excursion
21431 (goto-char pos)
21432 (skip-chars-forward " \r\t\n")
21433 (point-at-bol)))))
21434 beg end)
21435 ;; Determine boundaries of changes.
21436 (if (org-region-active-p)
21437 (setq beg (funcall skip-blanks (region-beginning))
21438 end (copy-marker (region-end)))
21439 (setq beg (funcall skip-blanks (point-at-bol))
21440 end (copy-marker (point-at-eol))))
21441 ;; Depending on the starting line, choose an action on the text
21442 ;; between BEG and END.
21443 (org-with-limited-levels
21444 (save-excursion
21445 (goto-char beg)
21446 (cond
21447 ;; Case 1. Start at an item: de-itemize. Note that it only
21448 ;; happens when a region is active: `org-ctrl-c-minus'
21449 ;; would call `org-cycle-list-bullet' otherwise.
21450 ((org-at-item-p)
21451 (while (< (point) end)
21452 (when (org-at-item-p)
21453 (skip-chars-forward " \t")
21454 (delete-region (point) (match-end 0)))
21455 (forward-line)))
21456 ;; Case 2. Start at an heading: convert to items.
21457 ((org-at-heading-p)
21458 (let* ((bul (org-list-bullet-string "-"))
21459 (bul-len (length bul))
21460 (done (org-entry-is-done-p))
21461 (todo (org-entry-is-todo-p))
21462 ;; Indentation of the first heading. It should be
21463 ;; relative to the indentation of its parent, if any.
21464 (start-ind (save-excursion
21465 (cond
21466 ((not org-adapt-indentation) 0)
21467 ((not (outline-previous-heading)) 0)
21468 (t (length (match-string 0))))))
21469 ;; Level of first heading. Further headings will be
21470 ;; compared to it to determine hierarchy in the list.
21471 (ref-level (org-reduced-level (org-outline-level))))
21472 (when (or done todo) (org-todo ""))
21473 (while (< (point) end)
21474 (let* ((level (org-reduced-level (org-outline-level)))
21475 (delta (max 0 (- level ref-level))))
21476 ;; If current headline is less indented than the first
21477 ;; one, set it as reference, in order to preserve
21478 ;; subtrees.
21479 (when (< level ref-level) (setq ref-level level))
21480 (replace-match bul t t)
21481 (org-indent-line-to (+ start-ind (* delta bul-len)))
21482 (when (or done todo)
21483 (let* ((struct (org-list-struct))
21484 (old (copy-tree struct)))
21485 (org-list-set-checkbox (line-beginning-position)
21486 struct
21487 (if done "[X]" "[ ]"))
21488 (org-list-write-struct struct
21489 (org-list-parents-alist struct)
21490 old)))
21491 ;; Ensure all text down to END (or SECTION-END) belongs
21492 ;; to the newly created item.
21493 (let ((section-end (save-excursion
21494 (or (outline-next-heading) (point)))))
21495 (forward-line)
21496 (funcall shift-text
21497 (+ start-ind (* (1+ delta) bul-len))
21498 (min end section-end)))))))
21499 ;; Case 3. Normal line with ARG: make the first line of region
21500 ;; an item, and shift indentation of others lines to
21501 ;; set them as item's body.
21502 (arg (let* ((bul (org-list-bullet-string "-"))
21503 (bul-len (length bul))
21504 (ref-ind (org-get-indentation)))
21505 (skip-chars-forward " \t")
21506 (insert bul)
21507 (forward-line)
21508 (while (< (point) end)
21509 ;; Ensure that lines less indented than first one
21510 ;; still get included in item body.
21511 (funcall shift-text
21512 (+ ref-ind bul-len)
21513 (min end (save-excursion (or (outline-next-heading)
21514 (point)))))
21515 (forward-line))))
21516 ;; Case 4. Normal line without ARG: turn each non-item line
21517 ;; into an item.
21519 (while (< (point) end)
21520 (unless (or (org-at-heading-p) (org-at-item-p))
21521 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21522 (replace-match
21523 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21524 (forward-line))))))))
21526 (defun org-toggle-heading (&optional nstars)
21527 "Convert headings to normal text, or items or text to headings.
21528 If there is no active region, only convert the current line.
21530 With a \\[universal-argument] prefix, convert the whole list at
21531 point into heading.
21533 In a region:
21535 - If the first non blank line is a headline, remove the stars
21536 from all headlines in the region.
21538 - If it is a normal line, turn each and every normal line (i.e.,
21539 not an heading or an item) in the region into headings. If you
21540 want to convert only the first line of this region, use one
21541 universal prefix argument.
21543 - If it is a plain list item, turn all plain list items into headings.
21545 When converting a line into a heading, the number of stars is chosen
21546 such that the lines become children of the current entry. However,
21547 when a numeric prefix argument is given, its value determines the
21548 number of stars to add."
21549 (interactive "P")
21550 (let ((skip-blanks
21551 (function
21552 ;; Return beginning of first non-blank line, starting from
21553 ;; line at POS.
21554 (lambda (pos)
21555 (save-excursion
21556 (goto-char pos)
21557 (while (org-at-comment-p) (forward-line))
21558 (skip-chars-forward " \r\t\n")
21559 (point-at-bol)))))
21560 beg end toggled)
21561 ;; Determine boundaries of changes. If a universal prefix has
21562 ;; been given, put the list in a region. If region ends at a bol,
21563 ;; do not consider the last line to be in the region.
21565 (when (and current-prefix-arg (org-at-item-p))
21566 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21567 (org-mark-element))
21569 (if (org-region-active-p)
21570 (setq beg (funcall skip-blanks (region-beginning))
21571 end (copy-marker (save-excursion
21572 (goto-char (region-end))
21573 (if (bolp) (point) (point-at-eol)))))
21574 (setq beg (funcall skip-blanks (point-at-bol))
21575 end (copy-marker (point-at-eol))))
21576 ;; Ensure inline tasks don't count as headings.
21577 (org-with-limited-levels
21578 (save-excursion
21579 (goto-char beg)
21580 (cond
21581 ;; Case 1. Started at an heading: de-star headings.
21582 ((org-at-heading-p)
21583 (while (< (point) end)
21584 (when (org-at-heading-p t)
21585 (looking-at org-outline-regexp) (replace-match "")
21586 (setq toggled t))
21587 (forward-line)))
21588 ;; Case 2. Started at an item: change items into headlines.
21589 ;; One star will be added by `org-list-to-subtree'.
21590 ((org-at-item-p)
21591 (while (< (point) end)
21592 (when (org-at-item-p)
21593 ;; Pay attention to cases when region ends before list.
21594 (let* ((struct (org-list-struct))
21595 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21596 (save-restriction
21597 (narrow-to-region (point) list-end)
21598 (insert (org-list-to-subtree (org-list-parse-list t)))))
21599 (setq toggled t))
21600 (forward-line)))
21601 ;; Case 3. Started at normal text: make every line an heading,
21602 ;; skipping headlines and items.
21603 (t (let* ((stars
21604 (make-string
21605 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21606 (add-stars
21607 (cond (nstars "") ; stars from prefix only
21608 ((equal stars "") "*") ; before first heading
21609 (org-odd-levels-only "**") ; inside heading, odd
21610 (t "*"))) ; inside heading, oddeven
21611 (rpl (concat stars add-stars " "))
21612 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21613 (while (< (point) (if (equal nstars '(4)) lend end))
21614 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21615 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21616 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21617 (forward-line)))))))
21618 (unless toggled (message "Cannot toggle heading from here"))))
21620 (defun org-meta-return (&optional _arg)
21621 "Insert a new heading or wrap a region in a table.
21622 Calls `org-insert-heading' or `org-table-wrap-region', depending
21623 on context. See the individual commands for more information."
21624 (interactive)
21625 (org-check-before-invisible-edit 'insert)
21626 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21627 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21628 #'org-insert-heading))))
21630 ;;; Menu entries
21632 (defsubst org-in-subtree-not-table-p ()
21633 "Are we in a subtree and not in a table?"
21634 (and (not (org-before-first-heading-p))
21635 (not (org-at-table-p))))
21637 ;; Define the Org-mode menus
21638 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21639 '("Tbl"
21640 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21641 ["Next Field" org-cycle (org-at-table-p)]
21642 ["Previous Field" org-shifttab (org-at-table-p)]
21643 ["Next Row" org-return (org-at-table-p)]
21644 "--"
21645 ["Blank Field" org-table-blank-field (org-at-table-p)]
21646 ["Edit Field" org-table-edit-field (org-at-table-p)]
21647 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21648 "--"
21649 ("Column"
21650 ["Move Column Left" org-metaleft (org-at-table-p)]
21651 ["Move Column Right" org-metaright (org-at-table-p)]
21652 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21653 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21654 ("Row"
21655 ["Move Row Up" org-metaup (org-at-table-p)]
21656 ["Move Row Down" org-metadown (org-at-table-p)]
21657 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21658 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21659 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21660 "--"
21661 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21662 ("Rectangle"
21663 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21664 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21665 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21666 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21667 "--"
21668 ("Calculate"
21669 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21670 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21671 ["Edit Formulas" org-edit-special (org-at-table-p)]
21672 "--"
21673 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21674 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21675 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21676 "--"
21677 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21678 "--"
21679 ["Sum Column/Rectangle" org-table-sum
21680 (or (org-at-table-p) (org-region-active-p))]
21681 ["Which Column?" org-table-current-column (org-at-table-p)])
21682 ["Debug Formulas"
21683 org-table-toggle-formula-debugger
21684 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21685 ["Show Col/Row Numbers"
21686 org-table-toggle-coordinate-overlays
21687 :style toggle
21688 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21689 "--"
21690 ["Create" org-table-create (and (not (org-at-table-p))
21691 org-enable-table-editor)]
21692 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21693 ["Import from File" org-table-import (not (org-at-table-p))]
21694 ["Export to File" org-table-export (org-at-table-p)]
21695 "--"
21696 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21697 "--"
21698 ("Plot"
21699 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21700 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21702 (easy-menu-define org-org-menu org-mode-map "Org menu"
21703 '("Org"
21704 ("Show/Hide"
21705 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21706 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21707 ["Sparse Tree..." org-sparse-tree t]
21708 ["Reveal Context" org-reveal t]
21709 ["Show All" show-all t]
21710 "--"
21711 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21712 "--"
21713 ["New Heading" org-insert-heading t]
21714 ("Navigate Headings"
21715 ["Up" outline-up-heading t]
21716 ["Next" outline-next-visible-heading t]
21717 ["Previous" outline-previous-visible-heading t]
21718 ["Next Same Level" outline-forward-same-level t]
21719 ["Previous Same Level" outline-backward-same-level t]
21720 "--"
21721 ["Jump" org-goto t])
21722 ("Edit Structure"
21723 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21724 "--"
21725 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21726 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21727 "--"
21728 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21729 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21730 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21731 "--"
21732 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21733 "--"
21734 ["Copy visible text" org-copy-visible t]
21735 "--"
21736 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21737 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21738 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21739 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21740 "--"
21741 ["Sort Region/Children" org-sort t]
21742 "--"
21743 ["Convert to odd levels" org-convert-to-odd-levels t]
21744 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21745 ("Editing"
21746 ["Emphasis..." org-emphasize t]
21747 ["Edit Source Example" org-edit-special t]
21748 "--"
21749 ["Footnote new/jump" org-footnote-action t]
21750 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21751 ("Archive"
21752 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21753 "--"
21754 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21755 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21756 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21758 "--"
21759 ("Hyperlinks"
21760 ["Store Link (Global)" org-store-link t]
21761 ["Find existing link to here" org-occur-link-in-agenda-files t]
21762 ["Insert Link" org-insert-link t]
21763 ["Follow Link" org-open-at-point t]
21764 "--"
21765 ["Next link" org-next-link t]
21766 ["Previous link" org-previous-link t]
21767 "--"
21768 ["Descriptive Links"
21769 org-toggle-link-display
21770 :style radio
21771 :selected org-descriptive-links
21773 ["Literal Links"
21774 org-toggle-link-display
21775 :style radio
21776 :selected (not org-descriptive-links)])
21777 "--"
21778 ("TODO Lists"
21779 ["TODO/DONE/-" org-todo t]
21780 ("Select keyword"
21781 ["Next keyword" org-shiftright (org-at-heading-p)]
21782 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21783 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21784 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21785 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21786 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21787 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21788 "--"
21789 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21790 :selected org-enforce-todo-dependencies :style toggle :active t]
21791 "Settings for tree at point"
21792 ["Do Children sequentially" org-toggle-ordered-property :style radio
21793 :selected (org-entry-get nil "ORDERED")
21794 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21795 ["Do Children parallel" org-toggle-ordered-property :style radio
21796 :selected (not (org-entry-get nil "ORDERED"))
21797 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21798 "--"
21799 ["Set Priority" org-priority t]
21800 ["Priority Up" org-shiftup t]
21801 ["Priority Down" org-shiftdown t]
21802 "--"
21803 ["Get news from all feeds" org-feed-update-all t]
21804 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21805 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21806 ("TAGS and Properties"
21807 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21808 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21809 "--"
21810 ["Set property" org-set-property (not (org-before-first-heading-p))]
21811 ["Column view of properties" org-columns t]
21812 ["Insert Column View DBlock" org-insert-columns-dblock t])
21813 ("Dates and Scheduling"
21814 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21815 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21816 ("Change Date"
21817 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21818 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21819 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21820 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21821 ["Compute Time Range" org-evaluate-time-range t]
21822 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21823 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21824 "--"
21825 ["Custom time format" org-toggle-time-stamp-overlays
21826 :style radio :selected org-display-custom-times]
21827 "--"
21828 ["Goto Calendar" org-goto-calendar t]
21829 ["Date from Calendar" org-date-from-calendar t]
21830 "--"
21831 ["Start/Restart Timer" org-timer-start t]
21832 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21833 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21834 ["Insert Timer String" org-timer t]
21835 ["Insert Timer Item" org-timer-item t])
21836 ("Logging work"
21837 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21838 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21839 ["Clock out" org-clock-out t]
21840 ["Clock cancel" org-clock-cancel t]
21841 "--"
21842 ["Mark as default task" org-clock-mark-default-task t]
21843 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21844 ["Goto running clock" org-clock-goto t]
21845 "--"
21846 ["Display times" org-clock-display t]
21847 ["Create clock table" org-clock-report t]
21848 "--"
21849 ["Record DONE time"
21850 (progn (setq org-log-done (not org-log-done))
21851 (message "Switching to %s will %s record a timestamp"
21852 (car org-done-keywords)
21853 (if org-log-done "automatically" "not")))
21854 :style toggle :selected org-log-done])
21855 "--"
21856 ["Agenda Command..." org-agenda t]
21857 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21858 ("File List for Agenda")
21859 ("Special views current file"
21860 ["TODO Tree" org-show-todo-tree t]
21861 ["Check Deadlines" org-check-deadlines t]
21862 ["Timeline" org-timeline t]
21863 ["Tags/Property tree" org-match-sparse-tree t])
21864 "--"
21865 ["Export/Publish..." org-export-dispatch t]
21866 ("LaTeX"
21867 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21868 :selected org-cdlatex-mode]
21869 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21870 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21871 ["Modify math symbol" org-cdlatex-math-modify
21872 (org-inside-LaTeX-fragment-p)]
21873 ["Insert citation" org-reftex-citation t]
21874 "--"
21875 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21876 "--"
21877 ("MobileOrg"
21878 ["Push Files and Views" org-mobile-push t]
21879 ["Get Captured and Flagged" org-mobile-pull t]
21880 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21881 "--"
21882 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21883 "--"
21884 ("Documentation"
21885 ["Show Version" org-version t]
21886 ["Info Documentation" org-info t])
21887 ("Customize"
21888 ["Browse Org Group" org-customize t]
21889 "--"
21890 ["Expand This Menu" org-create-customize-menu
21891 (fboundp 'customize-menu-create)])
21892 ["Send bug report" org-submit-bug-report t]
21893 "--"
21894 ("Refresh/Reload"
21895 ["Refresh setup current buffer" org-mode-restart t]
21896 ["Reload Org (after update)" org-reload t]
21897 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21900 (defun org-info (&optional node)
21901 "Read documentation for Org-mode in the info system.
21902 With optional NODE, go directly to that node."
21903 (interactive)
21904 (info (format "(org)%s" (or node ""))))
21906 ;;;###autoload
21907 (defun org-submit-bug-report ()
21908 "Submit a bug report on Org-mode via mail.
21910 Don't hesitate to report any problems or inaccurate documentation.
21912 If you don't have setup sending mail from (X)Emacs, please copy the
21913 output buffer into your mail program, as it gives us important
21914 information about your Org-mode version and configuration."
21915 (interactive)
21916 (require 'reporter)
21917 (defvar reporter-prompt-for-summary-p)
21918 (org-load-modules-maybe)
21919 (org-require-autoloaded-modules)
21920 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21921 (reporter-submit-bug-report
21922 "emacs-orgmode@gnu.org"
21923 (org-version nil 'full)
21924 (let (list)
21925 (save-window-excursion
21926 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21927 (delete-other-windows)
21928 (erase-buffer)
21929 (insert "You are about to submit a bug report to the Org-mode mailing list.
21931 We would like to add your full Org-mode and Outline configuration to the
21932 bug report. This greatly simplifies the work of the maintainer and
21933 other experts on the mailing list.
21935 HOWEVER, some variables you have customized may contain private
21936 information. The names of customers, colleagues, or friends, might
21937 appear in the form of file names, tags, todo states, or search strings.
21938 If you answer yes to the prompt, you might want to check and remove
21939 such private information before sending the email.")
21940 (add-text-properties (point-min) (point-max) '(face org-warning))
21941 (when (yes-or-no-p "Include your Org-mode configuration ")
21942 (mapatoms
21943 (lambda (v)
21944 (and (boundp v)
21945 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21946 (or (and (symbol-value v)
21947 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21948 (and
21949 (get v 'custom-type) (get v 'standard-value)
21950 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21951 (push v list)))))
21952 (kill-buffer (get-buffer "*Warn about privacy*"))
21953 list))
21954 nil nil
21955 "Remember to cover the basics, that is, what you expected to happen and
21956 what in fact did happen. You don't know how to make a good report? See
21958 http://orgmode.org/manual/Feedback.html#Feedback
21960 Your bug report will be posted to the Org-mode mailing list.
21961 ------------------------------------------------------------------------")
21962 (save-excursion
21963 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21964 (replace-match "\\1Bug: \\3 [\\2]")))))
21967 (defun org-install-agenda-files-menu ()
21968 (let ((bl (buffer-list)))
21969 (save-excursion
21970 (while bl
21971 (set-buffer (pop bl))
21972 (if (derived-mode-p 'org-mode) (setq bl nil)))
21973 (when (derived-mode-p 'org-mode)
21974 (easy-menu-change
21975 '("Org") "File List for Agenda"
21976 (append
21977 (list
21978 ["Edit File List" (org-edit-agenda-file-list) t]
21979 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21980 ["Remove Current File from List" org-remove-file t]
21981 ["Cycle through agenda files" org-cycle-agenda-files t]
21982 ["Occur in all agenda files" org-occur-in-agenda-files t]
21983 "--")
21984 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21986 ;;;; Documentation
21988 (defun org-require-autoloaded-modules ()
21989 (interactive)
21990 (mapc 'require
21991 '(org-agenda org-archive org-attach org-clock org-colview org-id
21992 org-table org-timer)))
21994 ;;;###autoload
21995 (defun org-reload (&optional uncompiled)
21996 "Reload all org lisp files.
21997 With prefix arg UNCOMPILED, load the uncompiled versions."
21998 (interactive "P")
21999 (require 'loadhist)
22000 (let* ((org-dir (org-find-library-dir "org"))
22001 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
22002 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
22003 (remove-re (mapconcat 'identity
22004 (mapcar (lambda (f) (concat "^" f "$"))
22005 (list (if (featurep 'xemacs)
22006 "org-colview"
22007 "org-colview-xemacs")
22008 "org" "org-loaddefs" "org-version"))
22009 "\\|"))
22010 (feats (delete-dups
22011 (mapcar 'file-name-sans-extension
22012 (mapcar 'file-name-nondirectory
22013 (delq nil
22014 (mapcar 'feature-file
22015 features))))))
22016 (lfeat (append
22017 (sort
22018 (setq feats
22019 (delq nil (mapcar
22020 (lambda (f)
22021 (if (and (string-match feature-re f)
22022 (not (string-match remove-re f)))
22023 f nil))
22024 feats)))
22025 'string-lessp)
22026 (list "org-version" "org")))
22027 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22028 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22029 load-uncore load-misses)
22030 (setq load-misses
22031 (delq 't
22032 (mapcar (lambda (f)
22033 (or (org-load-noerror-mustsuffix (concat org-dir f))
22034 (and (string= org-dir contrib-dir)
22035 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22036 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22037 (add-to-list 'load-uncore f 'append)
22040 lfeat)))
22041 (if load-uncore
22042 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22043 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22044 (if load-misses
22045 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22046 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22047 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22049 ;;;###autoload
22050 (defun org-customize ()
22051 "Call the customize function with org as argument."
22052 (interactive)
22053 (org-load-modules-maybe)
22054 (org-require-autoloaded-modules)
22055 (customize-browse 'org))
22057 (defun org-create-customize-menu ()
22058 "Create a full customization menu for Org-mode, insert it into the menu."
22059 (interactive)
22060 (org-load-modules-maybe)
22061 (org-require-autoloaded-modules)
22062 (if (fboundp 'customize-menu-create)
22063 (progn
22064 (easy-menu-change
22065 '("Org") "Customize"
22066 `(["Browse Org group" org-customize t]
22067 "--"
22068 ,(customize-menu-create 'org)
22069 ["Set" Custom-set t]
22070 ["Save" Custom-save t]
22071 ["Reset to Current" Custom-reset-current t]
22072 ["Reset to Saved" Custom-reset-saved t]
22073 ["Reset to Standard Settings" Custom-reset-standard t]))
22074 (message "\"Org\"-menu now contains full customization menu"))
22075 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22077 ;;;; Miscellaneous stuff
22079 ;;; Generally useful functions
22081 (defsubst org-get-at-eol (property n)
22082 "Get text property PROPERTY at the end of line less N characters."
22083 (get-text-property (- (point-at-eol) n) property))
22085 (defun org-find-text-property-in-string (prop s)
22086 "Return the first non-nil value of property PROP in string S."
22087 (or (get-text-property 0 prop s)
22088 (get-text-property (or (next-single-property-change 0 prop s) 0)
22089 prop s)))
22091 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22092 "Display the given MESSAGE as a warning."
22093 (if (fboundp 'display-warning)
22094 (display-warning 'org message
22095 (if (featurep 'xemacs) 'warning :warning))
22096 (let ((buf (get-buffer-create "*Org warnings*")))
22097 (with-current-buffer buf
22098 (goto-char (point-max))
22099 (insert "Warning (Org): " message)
22100 (unless (bolp)
22101 (newline)))
22102 (display-buffer buf)
22103 (sit-for 0))))
22105 (defun org-eval (form)
22106 "Eval FORM and return result."
22107 (condition-case error
22108 (eval form)
22109 (error (format "%%![Error: %s]" error))))
22111 (defun org-in-clocktable-p ()
22112 "Check if the cursor is in a clocktable."
22113 (let ((pos (point)) start)
22114 (save-excursion
22115 (end-of-line 1)
22116 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22117 (setq start (match-beginning 0))
22118 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22119 (>= (match-end 0) pos)
22120 start))))
22122 (defun org-in-verbatim-emphasis ()
22123 (save-match-data
22124 (and (org-in-regexp org-emph-re 2)
22125 (>= (point) (match-beginning 3))
22126 (<= (point) (match-end 4))
22127 (member (match-string 3) '("=" "~")))))
22129 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22130 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22131 (if (and marker (marker-buffer marker)
22132 (buffer-live-p (marker-buffer marker)))
22133 (progn
22134 (org-pop-to-buffer-same-window (marker-buffer marker))
22135 (if (or (> marker (point-max)) (< marker (point-min)))
22136 (widen))
22137 (goto-char marker)
22138 (org-show-context 'org-goto))
22139 (if bookmark
22140 (bookmark-jump bookmark)
22141 (error "Cannot find location"))))
22143 (defun org-quote-csv-field (s)
22144 "Quote field for inclusion in CSV material."
22145 (if (string-match "[\",]" s)
22146 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22149 (defun org-force-self-insert (N)
22150 "Needed to enforce self-insert under remapping."
22151 (interactive "p")
22152 (self-insert-command N))
22154 (defun org-string-width (s)
22155 "Compute width of string, ignoring invisible characters.
22156 This ignores character with invisibility property `org-link', and also
22157 characters with property `org-cwidth', because these will become invisible
22158 upon the next fontification round."
22159 (let (b l)
22160 (when (or (eq t buffer-invisibility-spec)
22161 (assq 'org-link buffer-invisibility-spec))
22162 (while (setq b (text-property-any 0 (length s)
22163 'invisible 'org-link s))
22164 (setq s (concat (substring s 0 b)
22165 (substring s (or (next-single-property-change
22166 b 'invisible s)
22167 (length s)))))))
22168 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22169 (setq s (concat (substring s 0 b)
22170 (substring s (or (next-single-property-change
22171 b 'org-cwidth s)
22172 (length s))))))
22173 (setq l (string-width s) b -1)
22174 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22175 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22178 (defun org-shorten-string (s maxlength)
22179 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22180 If the string is shorter or has length MAXLENGTH, just return the
22181 original string. If it is longer, the functions finds a space in the
22182 string, breaks this string off at that locations and adds three dots
22183 as ellipsis. Including the ellipsis, the string will not be longer
22184 than MAXLENGTH. If finding a good breaking point in the string does
22185 not work, the string is just chopped off in the middle of a word
22186 if necessary."
22187 (if (<= (length s) maxlength)
22189 (let* ((n (max (- maxlength 4) 1))
22190 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22191 (if (string-match re s)
22192 (concat (match-string 1 s) "...")
22193 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22195 (defun org-get-indentation (&optional line)
22196 "Get the indentation of the current line, interpreting tabs.
22197 When LINE is given, assume it represents a line and compute its indentation."
22198 (if line
22199 (if (string-match "^ *" (org-remove-tabs line))
22200 (match-end 0))
22201 (save-excursion
22202 (beginning-of-line 1)
22203 (skip-chars-forward " \t")
22204 (current-column))))
22206 (defun org-get-string-indentation (s)
22207 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22208 (let ((n -1) (i 0) (w tab-width) c)
22209 (catch 'exit
22210 (while (< (setq n (1+ n)) (length s))
22211 (setq c (aref s n))
22212 (cond ((= c ?\ ) (setq i (1+ i)))
22213 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22214 (t (throw 'exit t)))))
22217 (defun org-remove-tabs (s &optional width)
22218 "Replace tabulators in S with spaces.
22219 Assumes that s is a single line, starting in column 0."
22220 (setq width (or width tab-width))
22221 (while (string-match "\t" s)
22222 (setq s (replace-match
22223 (make-string
22224 (- (* width (/ (+ (match-beginning 0) width) width))
22225 (match-beginning 0)) ?\ )
22226 t t s)))
22229 (defun org-fix-indentation (line ind)
22230 "Fix indentation in LINE.
22231 IND is a cons cell with target and minimum indentation.
22232 If the current indentation in LINE is smaller than the minimum,
22233 leave it alone. If it is larger than ind, set it to the target."
22234 (let* ((l (org-remove-tabs line))
22235 (i (org-get-indentation l))
22236 (i1 (car ind)) (i2 (cdr ind)))
22237 (if (>= i i2) (setq l (substring line i2)))
22238 (if (> i1 0)
22239 (concat (make-string i1 ?\ ) l)
22240 l)))
22242 (defun org-remove-indentation (code &optional n)
22243 "Remove the maximum common indentation from the lines in CODE.
22244 N may optionally be the number of spaces to remove."
22245 (with-temp-buffer
22246 (insert code)
22247 (org-do-remove-indentation n)
22248 (buffer-string)))
22250 (defun org-do-remove-indentation (&optional n)
22251 "Remove the maximum common indentation from the buffer."
22252 (untabify (point-min) (point-max))
22253 (let ((min 10000) re)
22254 (if n
22255 (setq min n)
22256 (goto-char (point-min))
22257 (while (re-search-forward "^ *[^ \n]" nil t)
22258 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22259 (unless (or (= min 0) (= min 10000))
22260 (setq re (format "^ \\{%d\\}" min))
22261 (goto-char (point-min))
22262 (while (re-search-forward re nil t)
22263 (replace-match "")
22264 (end-of-line 1))
22265 min)))
22267 (defun org-fill-template (template alist)
22268 "Find each %key of ALIST in TEMPLATE and replace it."
22269 (let ((case-fold-search nil))
22270 (dolist (entry (sort (copy-sequence alist)
22271 (lambda (a b) (< (length (car a)) (length (car b))))))
22272 (setq template
22273 (replace-regexp-in-string
22274 (concat "%" (regexp-quote (car entry)))
22275 (or (cdr entry) "") template t t)))
22276 template))
22278 (defun org-base-buffer (buffer)
22279 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22280 (if (not buffer)
22281 buffer
22282 (or (buffer-base-buffer buffer)
22283 buffer)))
22285 (defun org-wrap (string &optional width lines)
22286 "Wrap string to either a number of lines, or a width in characters.
22287 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22288 that costs. If there is a word longer than WIDTH, the text is actually
22289 wrapped to the length of that word.
22290 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22291 many lines, whatever width that takes.
22292 The return value is a list of lines, without newlines at the end."
22293 (let* ((words (org-split-string string "[ \t\n]+"))
22294 (maxword (apply 'max (mapcar 'org-string-width words)))
22295 w ll)
22296 (cond (width
22297 (org-do-wrap words (max maxword width)))
22298 (lines
22299 (setq w maxword)
22300 (setq ll (org-do-wrap words maxword))
22301 (if (<= (length ll) lines)
22303 (setq ll words)
22304 (while (> (length ll) lines)
22305 (setq w (1+ w))
22306 (setq ll (org-do-wrap words w)))
22307 ll))
22308 (t (error "Cannot wrap this")))))
22310 (defun org-do-wrap (words width)
22311 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22312 (let (lines line)
22313 (while words
22314 (setq line (pop words))
22315 (while (and words (< (+ (length line) (length (car words))) width))
22316 (setq line (concat line " " (pop words))))
22317 (setq lines (push line lines)))
22318 (nreverse lines)))
22320 (defun org-split-string (string &optional separators)
22321 "Splits STRING into substrings at SEPARATORS.
22322 SEPARATORS is a regular expression.
22323 No empty strings are returned if there are matches at the beginning
22324 and end of string."
22325 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22326 (let ((start 0) notfirst list)
22327 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22328 (if (and notfirst
22329 (= start (match-beginning 0))
22330 (< start (length string)))
22331 (1+ start) start))
22332 (< (match-beginning 0) (length string)))
22333 (setq notfirst t)
22334 (or (eq (match-beginning 0) 0)
22335 (and (eq (match-beginning 0) (match-end 0))
22336 (eq (match-beginning 0) start))
22337 (push (substring string start (match-beginning 0)) list))
22338 (setq start (match-end 0)))
22339 (or (eq start (length string))
22340 (push (substring string start) list))
22341 (nreverse list)))
22343 (defun org-quote-vert (s)
22344 "Replace \"|\" with \"\\vert\"."
22345 (while (string-match "|" s)
22346 (setq s (replace-match "\\vert" t t s)))
22349 (defun org-uuidgen-p (s)
22350 "Is S an ID created by UUIDGEN?"
22351 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22353 (defun org-in-src-block-p (&optional inside)
22354 "Whether point is in a code source block.
22355 When INSIDE is non-nil, don't consider we are within a src block
22356 when point is at #+BEGIN_SRC or #+END_SRC."
22357 (let ((case-fold-search t) ov)
22358 (or (and (eq (get-char-property (point) 'src-block) t))
22359 (and (not inside)
22360 (save-match-data
22361 (save-excursion
22362 (beginning-of-line)
22363 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22365 (defun org-context ()
22366 "Return a list of contexts of the current cursor position.
22367 If several contexts apply, all are returned.
22368 Each context entry is a list with a symbol naming the context, and
22369 two positions indicating start and end of the context. Possible
22370 contexts are:
22372 :headline anywhere in a headline
22373 :headline-stars on the leading stars in a headline
22374 :todo-keyword on a TODO keyword (including DONE) in a headline
22375 :tags on the TAGS in a headline
22376 :priority on the priority cookie in a headline
22377 :item on the first line of a plain list item
22378 :item-bullet on the bullet/number of a plain list item
22379 :checkbox on the checkbox in a plain list item
22380 :table in an org-mode table
22381 :table-special on a special filed in a table
22382 :table-table in a table.el table
22383 :clocktable in a clocktable
22384 :src-block in a source block
22385 :link on a hyperlink
22386 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22387 :target on a <<target>>
22388 :radio-target on a <<<radio-target>>>
22389 :latex-fragment on a LaTeX fragment
22390 :latex-preview on a LaTeX fragment with overlaid preview image
22392 This function expects the position to be visible because it uses font-lock
22393 faces as a help to recognize the following contexts: :table-special, :link,
22394 and :keyword."
22395 (let* ((f (get-text-property (point) 'face))
22396 (faces (if (listp f) f (list f)))
22397 (case-fold-search t)
22398 (p (point)) clist o)
22399 ;; First the large context
22400 (cond
22401 ((org-at-heading-p t)
22402 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22403 (when (progn
22404 (beginning-of-line 1)
22405 (looking-at org-todo-line-tags-regexp))
22406 (push (org-point-in-group p 1 :headline-stars) clist)
22407 (push (org-point-in-group p 2 :todo-keyword) clist)
22408 (push (org-point-in-group p 4 :tags) clist))
22409 (goto-char p)
22410 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22411 (if (looking-at "\\[#[A-Z0-9]\\]")
22412 (push (org-point-in-group p 0 :priority) clist)))
22414 ((org-at-item-p)
22415 (push (org-point-in-group p 2 :item-bullet) clist)
22416 (push (list :item (point-at-bol)
22417 (save-excursion (org-end-of-item) (point)))
22418 clist)
22419 (and (org-at-item-checkbox-p)
22420 (push (org-point-in-group p 0 :checkbox) clist)))
22422 ((org-at-table-p)
22423 (push (list :table (org-table-begin) (org-table-end)) clist)
22424 (if (memq 'org-formula faces)
22425 (push (list :table-special
22426 (previous-single-property-change p 'face)
22427 (next-single-property-change p 'face)) clist)))
22428 ((org-at-table-p 'any)
22429 (push (list :table-table) clist)))
22430 (goto-char p)
22432 (let ((case-fold-search t))
22433 ;; New the "medium" contexts: clocktables, source blocks
22434 (cond ((org-in-clocktable-p)
22435 (push (list :clocktable
22436 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22437 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22438 (match-beginning 1))
22439 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22440 (match-end 0))) clist))
22441 ((org-in-src-block-p)
22442 (push (list :src-block
22443 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22444 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22445 (match-beginning 1))
22446 (and (search-forward "#+END_SRC" nil t)
22447 (match-beginning 0))) clist))))
22448 (goto-char p)
22450 ;; Now the small context
22451 (cond
22452 ((org-at-timestamp-p)
22453 (push (org-point-in-group p 0 :timestamp) clist))
22454 ((memq 'org-link faces)
22455 (push (list :link
22456 (previous-single-property-change p 'face)
22457 (next-single-property-change p 'face)) clist))
22458 ((memq 'org-special-keyword faces)
22459 (push (list :keyword
22460 (previous-single-property-change p 'face)
22461 (next-single-property-change p 'face)) clist))
22462 ((org-at-target-p)
22463 (push (org-point-in-group p 0 :target) clist)
22464 (goto-char (1- (match-beginning 0)))
22465 (if (looking-at org-radio-target-regexp)
22466 (push (org-point-in-group p 0 :radio-target) clist))
22467 (goto-char p))
22468 ((setq o (car (delq nil
22469 (mapcar
22470 (lambda (x)
22471 (if (memq x org-latex-fragment-image-overlays) x))
22472 (overlays-at (point))))))
22473 (push (list :latex-fragment
22474 (overlay-start o) (overlay-end o)) clist)
22475 (push (list :latex-preview
22476 (overlay-start o) (overlay-end o)) clist))
22477 ((org-inside-LaTeX-fragment-p)
22478 ;; FIXME: positions wrong.
22479 (push (list :latex-fragment (point) (point)) clist)))
22481 (setq clist (nreverse (delq nil clist)))
22482 clist))
22484 (defun org-in-regexp (re &optional nlines visually)
22485 "Check if point is inside a match of RE.
22487 Normally only the current line is checked, but you can include
22488 NLINES extra lines after point into the search. If VISUALLY is
22489 set, require that the cursor is not after the match but really
22490 on, so that the block visually is on the match."
22491 (catch 'exit
22492 (let ((pos (point))
22493 (eol (point-at-eol (+ 1 (or nlines 0))))
22494 (inc (if visually 1 0)))
22495 (save-excursion
22496 (beginning-of-line (- 1 (or nlines 0)))
22497 (while (re-search-forward re eol t)
22498 (if (and (<= (match-beginning 0) pos)
22499 (>= (+ inc (match-end 0)) pos))
22500 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22501 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22502 "Org mode 8.3")
22504 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22505 "Non-nil when point is between matches of START-RE and END-RE.
22507 Also return a non-nil value when point is on one of the matches.
22509 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22510 buffer positions. Default values are the positions of headlines
22511 surrounding the point.
22513 The functions returns a cons cell whose car (resp. cdr) is the
22514 position before START-RE (resp. after END-RE)."
22515 (save-match-data
22516 (let ((pos (point))
22517 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22518 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22519 beg end)
22520 (save-excursion
22521 ;; Point is on a block when on START-RE or if START-RE can be
22522 ;; found before it...
22523 (and (or (org-in-regexp start-re)
22524 (re-search-backward start-re limit-up t))
22525 (setq beg (match-beginning 0))
22526 ;; ... and END-RE after it...
22527 (goto-char (match-end 0))
22528 (re-search-forward end-re limit-down t)
22529 (> (setq end (match-end 0)) pos)
22530 ;; ... without another START-RE in-between.
22531 (goto-char (match-beginning 0))
22532 (not (re-search-backward start-re (1+ beg) t))
22533 ;; Return value.
22534 (cons beg end))))))
22536 (defun org-in-block-p (names)
22537 "Non-nil when point belongs to a block whose name belongs to NAMES.
22539 NAMES is a list of strings containing names of blocks.
22541 Return first block name matched, or nil. Beware that in case of
22542 nested blocks, the returned name may not belong to the closest
22543 block from point."
22544 (save-match-data
22545 (catch 'exit
22546 (let ((case-fold-search t)
22547 (lim-up (save-excursion (outline-previous-heading)))
22548 (lim-down (save-excursion (outline-next-heading))))
22549 (mapc (lambda (name)
22550 (let ((n (regexp-quote name)))
22551 (when (org-between-regexps-p
22552 (concat "^[ \t]*#\\+begin_" n)
22553 (concat "^[ \t]*#\\+end_" n)
22554 lim-up lim-down)
22555 (throw 'exit n))))
22556 names))
22557 nil)))
22559 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22560 "Call `multi-occur' with buffers for all agenda files."
22561 (interactive "sOrg-files matching: ")
22562 (let* ((files (org-agenda-files))
22563 (tnames (mapcar #'file-truename files))
22564 (extra org-agenda-text-search-extra-files))
22565 (when (eq (car extra) 'agenda-archives)
22566 (setq extra (cdr extra))
22567 (setq files (org-add-archive-files files)))
22568 (dolist (f extra)
22569 (unless (member (file-truename f) tnames)
22570 (unless (member f files) (setq files (append files (list f))))
22571 (setq tnames (append tnames (list (file-truename f))))))
22572 (multi-occur
22573 (mapcar (lambda (x)
22574 (with-current-buffer
22575 ;; FIXME: Why not just (find-file-noselect x)?
22576 ;; Is it to avoid the "revert buffer" prompt?
22577 (or (get-file-buffer x) (find-file-noselect x))
22578 (widen)
22579 (current-buffer)))
22580 files)
22581 regexp)))
22583 (if (boundp 'occur-mode-find-occurrence-hook)
22584 ;; Emacs 23
22585 (add-hook 'occur-mode-find-occurrence-hook
22586 (lambda ()
22587 (when (derived-mode-p 'org-mode)
22588 (org-reveal))))
22589 ;; Emacs 22
22590 (defadvice occur-mode-goto-occurrence
22591 (after org-occur-reveal activate)
22592 (and (derived-mode-p 'org-mode) (org-reveal)))
22593 (defadvice occur-mode-goto-occurrence-other-window
22594 (after org-occur-reveal activate)
22595 (and (derived-mode-p 'org-mode) (org-reveal)))
22596 (defadvice occur-mode-display-occurrence
22597 (after org-occur-reveal activate)
22598 (when (derived-mode-p 'org-mode)
22599 (let ((pos (occur-mode-find-occurrence)))
22600 (with-current-buffer (marker-buffer pos)
22601 (save-excursion
22602 (goto-char pos)
22603 (org-reveal)))))))
22605 (defun org-occur-link-in-agenda-files ()
22606 "Create a link and search for it in the agendas.
22607 The link is not stored in `org-stored-links', it is just created
22608 for the search purpose."
22609 (interactive)
22610 (let ((link (condition-case nil
22611 (org-store-link nil)
22612 (error "Unable to create a link to here"))))
22613 (org-occur-in-agenda-files (regexp-quote link))))
22615 (defun org-reverse-string (string)
22616 "Return the reverse of STRING."
22617 (apply 'string (reverse (string-to-list string))))
22619 ;; defsubst org-uniquify must be defined before first use
22621 (defun org-uniquify-alist (alist)
22622 "Merge elements of ALIST with the same key.
22624 For example, in this alist:
22626 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22627 => '((a 1 3) (b 2))
22629 merge (a 1) and (a 3) into (a 1 3).
22631 The function returns the new ALIST."
22632 (let (rtn)
22633 (mapc
22634 (lambda (e)
22635 (let (n)
22636 (if (not (assoc (car e) rtn))
22637 (push e rtn)
22638 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22639 (setq rtn (assq-delete-all (car e) rtn))
22640 (push n rtn))))
22641 alist)
22642 rtn))
22644 (defun org-delete-all (elts list)
22645 "Remove all elements in ELTS from LIST."
22646 (while elts
22647 (setq list (delete (pop elts) list)))
22648 list)
22650 (defun org-count (cl-item cl-seq)
22651 "Count the number of occurrences of ITEM in SEQ.
22652 Taken from `count' in cl-seq.el with all keyword arguments removed."
22653 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22654 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22655 (while (< cl-start cl-end)
22656 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22657 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22658 (setq cl-start (1+ cl-start)))
22659 cl-count))
22661 (defun org-remove-if (predicate seq)
22662 "Remove everything from SEQ that fulfills PREDICATE."
22663 (let (res e)
22664 (while seq
22665 (setq e (pop seq))
22666 (if (not (funcall predicate e)) (push e res)))
22667 (nreverse res)))
22669 (defun org-remove-if-not (predicate seq)
22670 "Remove everything from SEQ that does not fulfill PREDICATE."
22671 (let (res e)
22672 (while seq
22673 (setq e (pop seq))
22674 (if (funcall predicate e) (push e res)))
22675 (nreverse res)))
22677 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22678 "Reduce two-argument FUNCTION across SEQ.
22679 Taken from `reduce' in cl-seq.el with all keyword arguments but
22680 \":initial-value\" removed."
22681 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22682 (cadr (memq :initial-value cl-keys)))
22683 (cl-seq (pop cl-seq))
22684 (t (funcall cl-func)))))
22685 (while cl-seq
22686 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22687 cl-accum))
22689 (defun org-every (pred seq)
22690 "Return true if PREDICATE is true of every element of SEQ.
22691 Adapted from `every' in cl.el."
22692 (catch 'org-every
22693 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22696 (defun org-some (pred seq)
22697 "Return true if PREDICATE is true of any element of SEQ.
22698 Adapted from `some' in cl.el."
22699 (catch 'org-some
22700 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22701 nil))
22703 (defun org-back-over-empty-lines ()
22704 "Move backwards over whitespace, to the beginning of the first empty line.
22705 Returns the number of empty lines passed."
22706 (let ((pos (point)))
22707 (if (cdr (assoc 'heading org-blank-before-new-entry))
22708 (skip-chars-backward " \t\n\r")
22709 (unless (eobp)
22710 (forward-line -1)))
22711 (beginning-of-line 2)
22712 (goto-char (min (point) pos))
22713 (count-lines (point) pos)))
22715 (defun org-skip-whitespace ()
22716 (skip-chars-forward " \t\n\r"))
22718 (defun org-point-in-group (point group &optional context)
22719 "Check if POINT is in match-group GROUP.
22720 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22721 match. If the match group does not exist or point is not inside it,
22722 return nil."
22723 (and (match-beginning group)
22724 (>= point (match-beginning group))
22725 (<= point (match-end group))
22726 (if context
22727 (list context (match-beginning group) (match-end group))
22728 t)))
22730 (defun org-switch-to-buffer-other-window (&rest args)
22731 "Switch to buffer in a second window on the current frame.
22732 In particular, do not allow pop-up frames.
22733 Returns the newly created buffer."
22734 (org-no-popups
22735 (apply 'switch-to-buffer-other-window args)))
22737 (defun org-combine-plists (&rest plists)
22738 "Create a single property list from all plists in PLISTS.
22739 The process starts by copying the first list, and then setting properties
22740 from the other lists. Settings in the last list are the most significant
22741 ones and overrule settings in the other lists."
22742 (let ((rtn (copy-sequence (pop plists)))
22743 p v ls)
22744 (while plists
22745 (setq ls (pop plists))
22746 (while ls
22747 (setq p (pop ls) v (pop ls))
22748 (setq rtn (plist-put rtn p v))))
22749 rtn))
22751 (defun org-replace-escapes (string table)
22752 "Replace %-escapes in STRING with values in TABLE.
22753 TABLE is an association list with keys like \"%a\" and string values.
22754 The sequences in STRING may contain normal field width and padding information,
22755 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22756 so values can contain further %-escapes if they are define later in TABLE."
22757 (let ((tbl (copy-alist table))
22758 (case-fold-search nil)
22759 (pchg 0)
22760 e re rpl)
22761 (dolist (e tbl)
22762 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22763 (when (and (cdr e) (string-match re (cdr e)))
22764 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22765 (safe "SREF"))
22766 (add-text-properties 0 3 (list 'sref sref) safe)
22767 (setcdr e (replace-match safe t t (cdr e)))))
22768 (while (string-match re string)
22769 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22770 (cdr e)))
22771 (setq string (replace-match rpl t t string))))
22772 (while (setq pchg (next-property-change pchg string))
22773 (let ((sref (get-text-property pchg 'sref string)))
22774 (when (and sref (string-match "SREF" string pchg))
22775 (setq string (replace-match sref t t string)))))
22776 string))
22778 (defun org-sublist (list start end)
22779 "Return a section of LIST, from START to END.
22780 Counting starts at 1."
22781 (let (rtn (c start))
22782 (setq list (nthcdr (1- start) list))
22783 (while (and list (<= c end))
22784 (push (pop list) rtn)
22785 (setq c (1+ c)))
22786 (nreverse rtn)))
22788 (defun org-find-base-buffer-visiting (file)
22789 "Like `find-buffer-visiting' but always return the base buffer and
22790 not an indirect buffer."
22791 (let ((buf (or (get-file-buffer file)
22792 (find-buffer-visiting file))))
22793 (if buf
22794 (or (buffer-base-buffer buf) buf)
22795 nil)))
22797 (defun org-image-file-name-regexp (&optional extensions)
22798 "Return regexp matching the file names of images.
22799 If EXTENSIONS is given, only match these."
22800 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22801 (image-file-name-regexp)
22802 (let ((image-file-name-extensions
22803 (or extensions
22804 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22805 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22806 (concat "\\."
22807 (regexp-opt (nconc (mapcar 'upcase
22808 image-file-name-extensions)
22809 image-file-name-extensions)
22811 "\\'"))))
22813 (defun org-file-image-p (file &optional extensions)
22814 "Return non-nil if FILE is an image."
22815 (save-match-data
22816 (string-match (org-image-file-name-regexp extensions) file)))
22818 (defun org-get-cursor-date (&optional with-time)
22819 "Return the date at cursor in as a time.
22820 This works in the calendar and in the agenda, anywhere else it just
22821 returns the current time.
22822 If WITH-TIME is non-nil, returns the time of the event at point (in
22823 the agenda) or the current time of the day."
22824 (let (date day defd tp hod mod)
22825 (when with-time
22826 (setq tp (get-text-property (point) 'time))
22827 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22828 (setq hod (string-to-number (match-string 1 tp))
22829 mod (string-to-number (match-string 2 tp))))
22830 (or tp (let ((now (decode-time)))
22831 (setq hod (nth 2 now)
22832 mod (nth 1 now)))))
22833 (cond
22834 ((eq major-mode 'calendar-mode)
22835 (setq date (calendar-cursor-to-date)
22836 defd (encode-time 0 (or mod 0) (or hod 0)
22837 (nth 1 date) (nth 0 date) (nth 2 date))))
22838 ((eq major-mode 'org-agenda-mode)
22839 (setq day (get-text-property (point) 'day))
22840 (if day
22841 (setq date (calendar-gregorian-from-absolute day)
22842 defd (encode-time 0 (or mod 0) (or hod 0)
22843 (nth 1 date) (nth 0 date) (nth 2 date))))))
22844 (or defd (current-time))))
22846 (defun org-mark-subtree (&optional up)
22847 "Mark the current subtree.
22848 This puts point at the start of the current subtree, and mark at
22849 the end. If a numeric prefix UP is given, move up into the
22850 hierarchy of headlines by UP levels before marking the subtree."
22851 (interactive "P")
22852 (org-with-limited-levels
22853 (cond ((org-at-heading-p) (beginning-of-line))
22854 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22855 (t (outline-previous-visible-heading 1))))
22856 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22857 (if (org-called-interactively-p 'any)
22858 (call-interactively 'org-mark-element)
22859 (org-mark-element)))
22862 ;;; Indentation
22864 (defun org--get-expected-indentation (element contentsp)
22865 "Expected indentation column for current line, according to ELEMENT.
22866 ELEMENT is an element containing point. CONTENTSP is non-nil
22867 when indentation is to be computed according to contents of
22868 ELEMENT."
22869 (let ((type (org-element-type element))
22870 (start (org-element-property :begin element))
22871 (post-affiliated (org-element-property :post-affiliated element)))
22872 (org-with-wide-buffer
22873 (cond
22874 (contentsp
22875 (case type
22876 ((diary-sexp footnote-definition) 0)
22877 ((headline inlinetask nil)
22878 (if (not org-adapt-indentation) 0
22879 (let ((level (org-current-level)))
22880 (if level (1+ level) 0))))
22881 ((item plain-list) (org-list-item-body-column post-affiliated))
22883 (goto-char start)
22884 (org-get-indentation))))
22885 ((memq type '(headline inlinetask nil))
22886 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22887 (org--get-expected-indentation element t)
22889 ((memq type '(diary-sexp footnote-definition)) 0)
22890 ;; First paragraph of a footnote definition or an item.
22891 ;; Indent like parent.
22892 ((< (line-beginning-position) start)
22893 (org--get-expected-indentation
22894 (org-element-property :parent element) t))
22895 ;; At first line: indent according to previous sibling, if any,
22896 ;; ignoring footnote definitions and inline tasks, or parent's
22897 ;; contents.
22898 ((= (line-beginning-position) start)
22899 (catch 'exit
22900 (while t
22901 (if (= (point-min) start) (throw 'exit 0)
22902 (goto-char (1- start))
22903 (let* ((previous (org-element-at-point))
22904 (parent previous))
22905 (while (and parent (<= (org-element-property :end parent) start))
22906 (setq previous parent
22907 parent (org-element-property :parent parent)))
22908 (cond
22909 ((not previous) (throw 'exit 0))
22910 ((> (org-element-property :end previous) start)
22911 (throw 'exit (org--get-expected-indentation previous t)))
22912 ((memq (org-element-type previous)
22913 '(footnote-definition inlinetask))
22914 (setq start (org-element-property :begin previous)))
22915 (t (goto-char (org-element-property :begin previous))
22916 (throw 'exit
22917 (if (bolp) (org-get-indentation)
22918 ;; At first paragraph in an item or
22919 ;; a footnote definition.
22920 (org--get-expected-indentation
22921 (org-element-property :parent previous) t))))))))))
22922 ;; Otherwise, move to the first non-blank line above.
22924 (beginning-of-line)
22925 (let ((pos (point)))
22926 (skip-chars-backward " \r\t\n")
22927 (cond
22928 ;; Two blank lines end a footnote definition or a plain
22929 ;; list. When we indent an empty line after them, the
22930 ;; containing list or footnote definition is over, so it
22931 ;; qualifies as a previous sibling. Therefore, we indent
22932 ;; like its first line.
22933 ((and (memq type '(footnote-definition plain-list))
22934 (> (count-lines (point) pos) 2))
22935 (goto-char start)
22936 (org-get-indentation))
22937 ;; Line above is the first one of a paragraph at the
22938 ;; beginning of an item or a footnote definition. Indent
22939 ;; like parent.
22940 ((< (line-beginning-position) start)
22941 (org--get-expected-indentation
22942 (org-element-property :parent element) t))
22943 ;; Line above is the beginning of an element, i.e., point
22944 ;; was originally on the blank lines between element's start
22945 ;; and contents.
22946 ((= (line-beginning-position) post-affiliated)
22947 (org--get-expected-indentation element t))
22948 ;; POS is after contents in a greater element. Indent like
22949 ;; the beginning of the element.
22951 ;; As a special case, if point is at the end of a footnote
22952 ;; definition or an item, indent like the very last element
22953 ;; within.
22954 ((and (not (eq type 'paragraph))
22955 (let ((cend (org-element-property :contents-end element)))
22956 (and cend (<= cend pos))))
22957 (if (memq type '(footnote-definition item plain-list))
22958 (let ((last (org-element-at-point)))
22959 (org--get-expected-indentation
22960 last
22961 (memq (org-element-type last)
22962 '(footnote-definition item plain-list))))
22963 (goto-char start)
22964 (org-get-indentation)))
22965 ;; In any other case, indent like the current line.
22966 (t (org-get-indentation)))))))))
22968 (defun org--align-node-property ()
22969 "Align node property at point.
22970 Alignment is done according to `org-property-format', which see."
22971 (when (save-excursion
22972 (beginning-of-line)
22973 (looking-at org-property-re))
22974 (replace-match
22975 (concat (match-string 4)
22976 (org-trim
22977 (format org-property-format (match-string 1) (match-string 3))))
22978 t t)))
22980 (defun org-indent-line ()
22981 "Indent line depending on context.
22983 Indentation is done according to the following rules:
22985 - Footnote definitions, diary sexps, headlines and inline tasks
22986 have to start at column 0.
22988 - On the very first line of an element, consider, in order, the
22989 next rules until one matches:
22991 1. If there's a sibling element before, ignoring footnote
22992 definitions and inline tasks, indent like its first line.
22994 2. If element has a parent, indent like its contents. More
22995 precisely, if parent is an item, indent after the
22996 description part, if any, or the bullet (see
22997 `org-list-description-max-indent'). Else, indent like
22998 parent's first line.
23000 3. Otherwise, indent relatively to current level, if
23001 `org-adapt-indentation' is non-nil, or to left margin.
23003 - On a blank line at the end of an element, indent according to
23004 the type of the element. More precisely
23006 1. If element is a plain list, an item, or a footnote
23007 definition, indent like the very last element within.
23009 2. If element is a paragraph, indent like its last non blank
23010 line.
23012 3. Otherwise, indent like its very first line.
23014 - In the code part of a source block, use language major mode
23015 to indent current line if `org-src-tab-acts-natively' is
23016 non-nil. If it is nil, do nothing.
23018 - Otherwise, indent like the first non-blank line above.
23020 The function doesn't indent an item as it could break the whole
23021 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
23022 \\[org-shiftmetaright].
23024 Also align node properties according to `org-property-format'."
23025 (interactive)
23026 (cond
23027 (orgstruct-is-++
23028 (let ((indent-line-function
23029 (cadadr (assq 'indent-line-function org-fb-vars))))
23030 (indent-according-to-mode)))
23031 ((org-at-heading-p) 'noindent)
23033 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23034 (type (org-element-type element)))
23035 (cond ((and (memq type '(plain-list item))
23036 (= (line-beginning-position)
23037 (org-element-property :post-affiliated element)))
23038 'noindent)
23039 ((and (eq type 'src-block)
23040 org-src-tab-acts-natively
23041 (> (line-beginning-position)
23042 (org-element-property :post-affiliated element))
23043 (< (line-beginning-position)
23044 (org-with-wide-buffer
23045 (goto-char (org-element-property :end element))
23046 (skip-chars-backward " \r\t\n")
23047 (line-beginning-position))))
23048 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23050 (let ((column (org--get-expected-indentation element nil)))
23051 ;; Preserve current column.
23052 (if (<= (current-column) (current-indentation))
23053 (org-indent-line-to column)
23054 (save-excursion (org-indent-line-to column))))
23055 ;; Align node property. Also preserve current column.
23056 (when (eq type 'node-property)
23057 (let ((column (current-column)))
23058 (org--align-node-property)
23059 (org-move-to-column column)))))))))
23061 (defun org-indent-region (start end)
23062 "Indent each non-blank line in the region.
23063 Called from a program, START and END specify the region to
23064 indent. The function will not indent contents of example blocks,
23065 verse blocks and export blocks as leading white spaces are
23066 assumed to be significant there."
23067 (interactive "r")
23068 (save-excursion
23069 (goto-char start)
23070 (skip-chars-forward " \r\t\n")
23071 (unless (eobp) (beginning-of-line))
23072 (let ((indent-to
23073 (lambda (ind pos)
23074 ;; Set IND as indentation for all lines between point and
23075 ;; POS or END, whichever comes first. Blank lines are
23076 ;; ignored. Leave point after POS once done.
23077 (let ((limit (copy-marker (min end pos))))
23078 (while (< (point) limit)
23079 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23080 (forward-line))
23081 (set-marker limit nil))))
23082 (end (copy-marker end)))
23083 (while (< (point) end)
23084 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23085 (let* ((element (org-element-at-point))
23086 (type (org-element-type element))
23087 (element-end (copy-marker (org-element-property :end element)))
23088 (ind (org--get-expected-indentation element nil)))
23089 (cond
23090 ((or (memq type '(paragraph table table-row))
23091 (not (or (org-element-property :contents-begin element)
23092 (memq type
23093 '(example-block export-block src-block)))))
23094 ;; Elements here are indented as a single block. Also
23095 ;; align node properties.
23096 (when (eq type 'node-property)
23097 (org--align-node-property)
23098 (beginning-of-line))
23099 (funcall indent-to ind element-end))
23101 ;; Elements in this category consist of three parts:
23102 ;; before the contents, the contents, and after the
23103 ;; contents. The contents are treated specially,
23104 ;; according to the element type, or not indented at
23105 ;; all. Other parts are indented as a single block.
23106 (let* ((post (copy-marker
23107 (org-element-property :post-affiliated element)))
23108 (cbeg
23109 (copy-marker
23110 (cond
23111 ((not (org-element-property :contents-begin element))
23112 ;; Fake contents for source blocks.
23113 (org-with-wide-buffer
23114 (goto-char post)
23115 (forward-line)
23116 (point)))
23117 ((memq type '(footnote-definition item plain-list))
23118 ;; Contents in these elements could start on
23119 ;; the same line as the beginning of the
23120 ;; element. Make sure we start indenting
23121 ;; from the second line.
23122 (org-with-wide-buffer
23123 (goto-char post)
23124 (end-of-line)
23125 (skip-chars-forward " \r\t\n")
23126 (if (eobp) (point) (line-beginning-position))))
23127 (t (org-element-property :contents-begin element)))))
23128 (cend (copy-marker
23129 (or (org-element-property :contents-end element)
23130 ;; Fake contents for source blocks.
23131 (org-with-wide-buffer
23132 (goto-char element-end)
23133 (skip-chars-backward " \r\t\n")
23134 (line-beginning-position)))
23135 t)))
23136 ;; Do not change items indentation individually as it
23137 ;; might break the list as a whole. On the other
23138 ;; hand, when at a plain list, indent it as a whole.
23139 (cond ((eq type 'plain-list)
23140 (let ((offset (- ind (org-get-indentation))))
23141 (unless (zerop offset)
23142 (indent-rigidly (org-element-property :begin element)
23143 (org-element-property :end element)
23144 offset))
23145 (goto-char cbeg)))
23146 ((eq type 'item) (goto-char cbeg))
23147 (t (funcall indent-to ind cbeg)))
23148 (when (< (point) end)
23149 (case type
23150 ((example-block export-block verse-block))
23151 (src-block
23152 ;; In a source block, indent source code
23153 ;; according to language major mode, but only if
23154 ;; `org-src-tab-acts-natively' is non-nil.
23155 (when (and (< (point) end) org-src-tab-acts-natively)
23156 (ignore-errors
23157 (org-babel-do-in-edit-buffer
23158 (indent-region (point-min) (point-max))))))
23159 (t (org-indent-region (point) (min cend end))))
23160 (goto-char (min cend end))
23161 (when (< (point) end) (funcall indent-to ind element-end)))
23162 (set-marker post nil)
23163 (set-marker cbeg nil)
23164 (set-marker cend nil))))
23165 (set-marker element-end nil))))
23166 (set-marker end nil))))
23168 (defun org-indent-drawer ()
23169 "Indent the drawer at point."
23170 (interactive)
23171 (unless (save-excursion
23172 (beginning-of-line)
23173 (org-looking-at-p org-drawer-regexp))
23174 (user-error "Not at a drawer"))
23175 (let ((element (org-element-at-point)))
23176 (unless (memq (org-element-type element) '(drawer property-drawer))
23177 (user-error "Not at a drawer"))
23178 (org-with-wide-buffer
23179 (org-indent-region (org-element-property :begin element)
23180 (org-element-property :end element))))
23181 (message "Drawer at point indented"))
23183 (defun org-indent-block ()
23184 "Indent the block at point."
23185 (interactive)
23186 (unless (save-excursion
23187 (beginning-of-line)
23188 (let ((case-fold-search t))
23189 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23190 (user-error "Not at a block"))
23191 (let ((element (org-element-at-point)))
23192 (unless (memq (org-element-type element)
23193 '(comment-block center-block dynamic-block example-block
23194 export-block quote-block special-block
23195 src-block verse-block))
23196 (user-error "Not at a block"))
23197 (org-with-wide-buffer
23198 (org-indent-region (org-element-property :begin element)
23199 (org-element-property :end element))))
23200 (message "Block at point indented"))
23203 ;;; Filling
23205 ;; We use our own fill-paragraph and auto-fill functions.
23207 ;; `org-fill-paragraph' relies on adaptive filling and context
23208 ;; checking. Appropriate `fill-prefix' is computed with
23209 ;; `org-adaptive-fill-function'.
23211 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23212 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23213 ;; `org-adaptive-fill-function' value. Internally,
23214 ;; `org-comment-line-break-function' breaks the line.
23216 ;; `org-setup-filling' installs filling and auto-filling related
23217 ;; variables during `org-mode' initialization.
23219 (defvar org-element-paragraph-separate) ; org-element.el
23220 (defun org-setup-filling ()
23221 (require 'org-element)
23222 ;; Prevent auto-fill from inserting unwanted new items.
23223 (when (boundp 'fill-nobreak-predicate)
23224 (org-set-local
23225 'fill-nobreak-predicate
23226 (org-uniquify
23227 (append fill-nobreak-predicate
23228 '(org-fill-line-break-nobreak-p
23229 org-fill-paragraph-with-timestamp-nobreak-p)))))
23230 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23231 (org-set-local 'paragraph-start paragraph-ending)
23232 (org-set-local 'paragraph-separate paragraph-ending))
23233 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23234 (org-set-local 'auto-fill-inhibit-regexp nil)
23235 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23236 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23237 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23239 (defun org-fill-line-break-nobreak-p ()
23240 "Non-nil when a new line at point would create an Org line break."
23241 (save-excursion
23242 (skip-chars-backward "[ \t]")
23243 (skip-chars-backward "\\\\")
23244 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23246 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23247 "Non-nil when a new line at point would split a timestamp."
23248 (and (org-at-timestamp-p t)
23249 (not (looking-at org-ts-regexp-both))))
23251 (declare-function message-in-body-p "message" ())
23252 (defvar orgtbl-line-start-regexp) ; From org-table.el
23253 (defun org-adaptive-fill-function ()
23254 "Compute a fill prefix for the current line.
23255 Return fill prefix, as a string, or nil if current line isn't
23256 meant to be filled. For convenience, if `adaptive-fill-regexp'
23257 matches in paragraphs or comments, use it."
23258 (catch 'exit
23259 (when (derived-mode-p 'message-mode)
23260 (save-excursion
23261 (beginning-of-line)
23262 (cond ((not (message-in-body-p)) (throw 'exit nil))
23263 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23264 ((looking-at message-cite-prefix-regexp)
23265 (throw 'exit (match-string-no-properties 0)))
23266 ((looking-at org-outline-regexp)
23267 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23268 (org-with-wide-buffer
23269 (unless (org-at-heading-p)
23270 (let* ((p (line-beginning-position))
23271 (element (save-excursion
23272 (beginning-of-line)
23273 (org-element-at-point)))
23274 (type (org-element-type element))
23275 (post-affiliated (org-element-property :post-affiliated element)))
23276 (unless (< p post-affiliated)
23277 (case type
23278 (comment
23279 (save-excursion
23280 (beginning-of-line)
23281 (looking-at "[ \t]*")
23282 (concat (match-string 0) "# ")))
23283 (footnote-definition "")
23284 ((item plain-list)
23285 (make-string (org-list-item-body-column post-affiliated) ?\s))
23286 (paragraph
23287 ;; Fill prefix is usually the same as the current line,
23288 ;; unless the paragraph is at the beginning of an item.
23289 (let ((parent (org-element-property :parent element)))
23290 (save-excursion
23291 (beginning-of-line)
23292 (cond ((eq (org-element-type parent) 'item)
23293 (make-string (org-list-item-body-column
23294 (org-element-property :begin parent))
23295 ?\s))
23296 ((and adaptive-fill-regexp
23297 ;; Locally disable
23298 ;; `adaptive-fill-function' to let
23299 ;; `fill-context-prefix' handle
23300 ;; `adaptive-fill-regexp' variable.
23301 (let (adaptive-fill-function)
23302 (fill-context-prefix
23303 post-affiliated
23304 (org-element-property :end element)))))
23305 ((looking-at "[ \t]+") (match-string 0))
23306 (t "")))))
23307 (comment-block
23308 ;; Only fill contents if P is within block boundaries.
23309 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23310 (forward-line)
23311 (point)))
23312 (cend (save-excursion
23313 (goto-char (org-element-property :end element))
23314 (skip-chars-backward " \r\t\n")
23315 (line-beginning-position))))
23316 (when (and (>= p cbeg) (< p cend))
23317 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23318 (match-string 0)
23319 "")))))))))))
23321 (declare-function message-goto-body "message" ())
23322 (defvar message-cite-prefix-regexp) ; From message.el
23323 (defun org-fill-paragraph (&optional justify)
23324 "Fill element at point, when applicable.
23326 This function only applies to comment blocks, comments, example
23327 blocks and paragraphs. Also, as a special case, re-align table
23328 when point is at one.
23330 If JUSTIFY is non-nil (interactively, with prefix argument),
23331 justify as well. If `sentence-end-double-space' is non-nil, then
23332 period followed by one space does not end a sentence, so don't
23333 break a line there. The variable `fill-column' controls the
23334 width for filling.
23336 For convenience, when point is at a plain list, an item or
23337 a footnote definition, try to fill the first paragraph within."
23338 (interactive)
23339 (if (and (derived-mode-p 'message-mode)
23340 (or (not (message-in-body-p))
23341 (save-excursion (move-beginning-of-line 1)
23342 (looking-at message-cite-prefix-regexp))))
23343 ;; First ensure filling is correct in message-mode.
23344 (let ((fill-paragraph-function
23345 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23346 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23347 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23348 (paragraph-separate
23349 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23350 (fill-paragraph nil))
23351 (with-syntax-table org-mode-transpose-word-syntax-table
23352 ;; Move to end of line in order to get the first paragraph
23353 ;; within a plain list or a footnote definition.
23354 (let ((element (save-excursion
23355 (end-of-line)
23356 (or (ignore-errors (org-element-at-point))
23357 (user-error "An element cannot be parsed line %d"
23358 (line-number-at-pos (point)))))))
23359 ;; First check if point is in a blank line at the beginning of
23360 ;; the buffer. In that case, ignore filling.
23361 (case (org-element-type element)
23362 ;; Use major mode filling function is src blocks.
23363 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23364 ;; Align Org tables, leave table.el tables as-is.
23365 (table-row (org-table-align) t)
23366 (table
23367 (when (eq (org-element-property :type element) 'org)
23368 (save-excursion
23369 (goto-char (org-element-property :post-affiliated element))
23370 (org-table-align)))
23372 (paragraph
23373 ;; Paragraphs may contain `line-break' type objects.
23374 (let ((beg (max (point-min)
23375 (org-element-property :contents-begin element)))
23376 (end (min (point-max)
23377 (org-element-property :contents-end element))))
23378 ;; Do nothing if point is at an affiliated keyword.
23379 (if (< (line-end-position) beg) t
23380 (when (derived-mode-p 'message-mode)
23381 ;; In `message-mode', do not fill following citation
23382 ;; in current paragraph nor text before message body.
23383 (let ((body-start (save-excursion (message-goto-body))))
23384 (when body-start (setq beg (max body-start beg))))
23385 (when (save-excursion
23386 (re-search-forward
23387 (concat "^" message-cite-prefix-regexp) end t))
23388 (setq end (match-beginning 0))))
23389 ;; Fill paragraph, taking line breaks into account.
23390 (save-excursion
23391 (goto-char beg)
23392 (let ((cuts (list beg)))
23393 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23394 (when (eq 'line-break
23395 (org-element-type
23396 (save-excursion (backward-char)
23397 (org-element-context))))
23398 (push (point) cuts)))
23399 (dolist (c (delq end cuts))
23400 (fill-region-as-paragraph c end justify)
23401 (setq end c))))
23402 t)))
23403 ;; Contents of `comment-block' type elements should be
23404 ;; filled as plain text, but only if point is within block
23405 ;; markers.
23406 (comment-block
23407 (let* ((case-fold-search t)
23408 (beg (save-excursion
23409 (goto-char (org-element-property :begin element))
23410 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23411 (forward-line)
23412 (point)))
23413 (end (save-excursion
23414 (goto-char (org-element-property :end element))
23415 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23416 (line-beginning-position))))
23417 (if (or (< (point) beg) (> (point) end)) t
23418 (fill-region-as-paragraph
23419 (save-excursion (end-of-line)
23420 (re-search-backward "^[ \t]*$" beg 'move)
23421 (line-beginning-position))
23422 (save-excursion (beginning-of-line)
23423 (re-search-forward "^[ \t]*$" end 'move)
23424 (line-beginning-position))
23425 justify))))
23426 ;; Fill comments.
23427 (comment
23428 (let ((begin (org-element-property :post-affiliated element))
23429 (end (org-element-property :end element)))
23430 (when (and (>= (point) begin) (<= (point) end))
23431 (let ((begin (save-excursion
23432 (end-of-line)
23433 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23434 (progn (forward-line) (point))
23435 begin)))
23436 (end (save-excursion
23437 (end-of-line)
23438 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23439 (1- (line-beginning-position))
23440 (skip-chars-backward " \r\t\n")
23441 (line-end-position)))))
23442 ;; Do not fill comments when at a blank line.
23443 (when (> end begin)
23444 (let ((fill-prefix
23445 (save-excursion
23446 (beginning-of-line)
23447 (looking-at "[ \t]*#")
23448 (let ((comment-prefix (match-string 0)))
23449 (goto-char (match-end 0))
23450 (if (looking-at adaptive-fill-regexp)
23451 (concat comment-prefix (match-string 0))
23452 (concat comment-prefix " "))))))
23453 (save-excursion
23454 (fill-region-as-paragraph begin end justify))))))
23456 ;; Ignore every other element.
23457 (otherwise t))))))
23459 (defun org-auto-fill-function ()
23460 "Auto-fill function."
23461 ;; Check if auto-filling is meaningful.
23462 (let ((fc (current-fill-column)))
23463 (when (and fc (> (current-column) fc))
23464 (let* ((fill-prefix (org-adaptive-fill-function))
23465 ;; Enforce empty fill prefix, if required. Otherwise, it
23466 ;; will be computed again.
23467 (adaptive-fill-mode (not (equal fill-prefix ""))))
23468 (when fill-prefix (do-auto-fill))))))
23470 (defun org-comment-line-break-function (&optional soft)
23471 "Break line at point and indent, continuing comment if within one.
23472 The inserted newline is marked hard if variable
23473 `use-hard-newlines' is true, unless optional argument SOFT is
23474 non-nil."
23475 (if soft (insert-and-inherit ?\n) (newline 1))
23476 (save-excursion (forward-char -1) (delete-horizontal-space))
23477 (delete-horizontal-space)
23478 (indent-to-left-margin)
23479 (insert-before-markers-and-inherit fill-prefix))
23482 ;;; Fixed Width Areas
23484 (defun org-toggle-fixed-width ()
23485 "Toggle fixed-width markup.
23487 Add or remove fixed-width markup on current line, whenever it
23488 makes sense. Return an error otherwise.
23490 If a region is active and if it contains only fixed-width areas
23491 or blank lines, remove all fixed-width markup in it. If the
23492 region contains anything else, convert all non-fixed-width lines
23493 to fixed-width ones.
23495 Blank lines at the end of the region are ignored unless the
23496 region only contains such lines."
23497 (interactive)
23498 (if (not (org-region-active-p))
23499 ;; No region:
23501 ;; Remove fixed width marker only in a fixed-with element.
23503 ;; Add fixed width maker in paragraphs, in blank lines after
23504 ;; elements or at the beginning of a headline or an inlinetask,
23505 ;; and before any one-line elements (e.g., a clock).
23506 (progn
23507 (beginning-of-line)
23508 (let* ((element (org-element-at-point))
23509 (type (org-element-type element)))
23510 (cond
23511 ((and (eq type 'fixed-width)
23512 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23513 (replace-match
23514 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23515 ((and (memq type '(babel-call clock comment diary-sexp headline
23516 horizontal-rule keyword paragraph
23517 planning))
23518 (<= (org-element-property :post-affiliated element) (point)))
23519 (skip-chars-forward " \t")
23520 (insert ": "))
23521 ((and (org-looking-at-p "[ \t]*$")
23522 (or (eq type 'inlinetask)
23523 (save-excursion
23524 (skip-chars-forward " \r\t\n")
23525 (<= (org-element-property :end element) (point)))))
23526 (delete-region (point) (line-end-position))
23527 (org-indent-line)
23528 (insert ": "))
23529 (t (user-error "Cannot insert a fixed-width line here")))))
23530 ;; Region active.
23531 (let* ((begin (save-excursion
23532 (goto-char (region-beginning))
23533 (line-beginning-position)))
23534 (end (copy-marker
23535 (save-excursion
23536 (goto-char (region-end))
23537 (unless (eolp) (beginning-of-line))
23538 (if (save-excursion (re-search-backward "\\S-" begin t))
23539 (progn (skip-chars-backward " \r\t\n") (point))
23540 (point)))))
23541 (all-fixed-width-p
23542 (catch 'not-all-p
23543 (save-excursion
23544 (goto-char begin)
23545 (skip-chars-forward " \r\t\n")
23546 (when (eobp) (throw 'not-all-p nil))
23547 (while (< (point) end)
23548 (let ((element (org-element-at-point)))
23549 (if (eq (org-element-type element) 'fixed-width)
23550 (goto-char (org-element-property :end element))
23551 (throw 'not-all-p nil))))
23552 t))))
23553 (if all-fixed-width-p
23554 (save-excursion
23555 (goto-char begin)
23556 (while (< (point) end)
23557 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23558 (replace-match
23559 "" nil nil nil
23560 (if (= (line-end-position) (match-end 0)) 0 1)))
23561 (forward-line)))
23562 (let ((min-ind (point-max)))
23563 ;; Find minimum indentation across all lines.
23564 (save-excursion
23565 (goto-char begin)
23566 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23567 (setq min-ind 0)
23568 (catch 'zerop
23569 (while (< (point) end)
23570 (unless (org-looking-at-p "[ \t]*$")
23571 (let ((ind (org-get-indentation)))
23572 (setq min-ind (min min-ind ind))
23573 (when (zerop ind) (throw 'zerop t))))
23574 (forward-line)))))
23575 ;; Loop over all lines and add fixed-width markup everywhere
23576 ;; but in fixed-width lines.
23577 (save-excursion
23578 (goto-char begin)
23579 (while (< (point) end)
23580 (cond
23581 ((org-at-heading-p)
23582 (insert ": ")
23583 (forward-line)
23584 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23585 (insert ":")
23586 (forward-line)))
23587 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23588 (let* ((element (org-element-at-point))
23589 (element-end (org-element-property :end element)))
23590 (if (eq (org-element-type element) 'fixed-width)
23591 (progn (goto-char element-end)
23592 (skip-chars-backward " \r\t\n")
23593 (forward-line))
23594 (let ((limit (min end element-end)))
23595 (while (< (point) limit)
23596 (org-move-to-column min-ind t)
23597 (insert ": ")
23598 (forward-line))))))
23600 (org-move-to-column min-ind t)
23601 (insert ": ")
23602 (forward-line)))))))
23603 (set-marker end nil))))
23606 ;;; Comments
23608 ;; Org comments syntax is quite complex. It requires the entire line
23609 ;; to be just a comment. Also, even with the right syntax at the
23610 ;; beginning of line, some some elements (i.e. verse-block or
23611 ;; example-block) don't accept comments. Usual Emacs comment commands
23612 ;; cannot cope with those requirements. Therefore, Org replaces them.
23614 ;; Org still relies on `comment-dwim', but cannot trust
23615 ;; `comment-only-p'. So, `comment-region-function' and
23616 ;; `uncomment-region-function' both point
23617 ;; to`org-comment-or-uncomment-region'. Eventually,
23618 ;; `org-insert-comment' takes care of insertion of comments at the
23619 ;; beginning of line.
23621 ;; `org-setup-comments-handling' install comments related variables
23622 ;; during `org-mode' initialization.
23624 (defun org-setup-comments-handling ()
23625 (interactive)
23626 (org-set-local 'comment-use-syntax nil)
23627 (org-set-local 'comment-start "# ")
23628 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23629 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23630 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23631 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23633 (defun org-insert-comment ()
23634 "Insert an empty comment above current line.
23635 If the line is empty, insert comment at its beginning. When
23636 point is within a source block, comment according to the related
23637 major mode."
23638 (if (let ((element (org-element-at-point)))
23639 (and (eq (org-element-type element) 'src-block)
23640 (< (save-excursion
23641 (goto-char (org-element-property :post-affiliated element))
23642 (line-end-position))
23643 (point))
23644 (> (save-excursion
23645 (goto-char (org-element-property :end element))
23646 (skip-chars-backward " \r\t\n")
23647 (line-beginning-position))
23648 (point))))
23649 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23650 (beginning-of-line)
23651 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23652 (open-line 1))
23653 (org-indent-line)
23654 (insert "# ")))
23656 (defvar comment-empty-lines) ; From newcomment.el.
23657 (defun org-comment-or-uncomment-region (beg end &rest _)
23658 "Comment or uncomment each non-blank line in the region.
23659 Uncomment each non-blank line between BEG and END if it only
23660 contains commented lines. Otherwise, comment them. If region is
23661 strictly within a source block, use appropriate comment syntax."
23662 (if (let ((element (org-element-at-point)))
23663 (and (eq (org-element-type element) 'src-block)
23664 (< (save-excursion
23665 (goto-char (org-element-property :post-affiliated element))
23666 (line-end-position))
23667 beg)
23668 (>= (save-excursion
23669 (goto-char (org-element-property :end element))
23670 (skip-chars-backward " \r\t\n")
23671 (line-beginning-position))
23672 end)))
23673 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23674 (save-restriction
23675 ;; Restrict region
23676 (narrow-to-region (save-excursion (goto-char beg)
23677 (skip-chars-forward " \r\t\n" end)
23678 (line-beginning-position))
23679 (save-excursion (goto-char end)
23680 (skip-chars-backward " \r\t\n" beg)
23681 (line-end-position)))
23682 (let ((uncommentp
23683 ;; UNCOMMENTP is non-nil when every non blank line between
23684 ;; BEG and END is a comment.
23685 (save-excursion
23686 (goto-char (point-min))
23687 (while (and (not (eobp))
23688 (let ((element (org-element-at-point)))
23689 (and (eq (org-element-type element) 'comment)
23690 (goto-char (min (point-max)
23691 (org-element-property
23692 :end element)))))))
23693 (eobp))))
23694 (if uncommentp
23695 ;; Only blank lines and comments in region: uncomment it.
23696 (save-excursion
23697 (goto-char (point-min))
23698 (while (not (eobp))
23699 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23700 (replace-match "" nil nil nil 1))
23701 (forward-line)))
23702 ;; Comment each line in region.
23703 (let ((min-indent (point-max)))
23704 ;; First find the minimum indentation across all lines.
23705 (save-excursion
23706 (goto-char (point-min))
23707 (while (and (not (eobp)) (not (zerop min-indent)))
23708 (unless (looking-at "[ \t]*$")
23709 (setq min-indent (min min-indent (current-indentation))))
23710 (forward-line)))
23711 ;; Then loop over all lines.
23712 (save-excursion
23713 (goto-char (point-min))
23714 (while (not (eobp))
23715 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23716 ;; Don't get fooled by invisible text (e.g. link path)
23717 ;; when moving to column MIN-INDENT.
23718 (let ((buffer-invisibility-spec nil))
23719 (org-move-to-column min-indent t))
23720 (insert comment-start))
23721 (forward-line)))))))))
23723 (defun org-comment-dwim (arg)
23724 "Call `comment-dwim' within a source edit buffer if needed."
23725 (interactive "*P")
23726 (if (org-in-src-block-p)
23727 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23728 (call-interactively 'comment-dwim)))
23731 ;;; Timestamps API
23733 ;; This section contains tools to operate on timestamp objects, as
23734 ;; returned by, e.g. `org-element-context'.
23736 (defun org-timestamp--to-internal-time (timestamp &optional end)
23737 "Encode TIMESTAMP object into Emacs internal time.
23738 Use end of date range or time range when END is non-nil."
23739 (apply #'encode-time
23740 (cons 0
23741 (mapcar
23742 (lambda (prop) (or (org-element-property prop timestamp) 0))
23743 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23744 '(:minute-start :hour-start :day-start :month-start
23745 :year-start))))))
23747 (defun org-timestamp-has-time-p (timestamp)
23748 "Non-nil when TIMESTAMP has a time specified."
23749 (org-element-property :hour-start timestamp))
23751 (defun org-timestamp-format (timestamp format &optional end utc)
23752 "Format a TIMESTAMP object into a string.
23754 FORMAT is a format specifier to be passed to
23755 `format-time-string'.
23757 When optional argument END is non-nil, use end of date-range or
23758 time-range, if possible.
23760 When optional argument UTC is non-nil, time will be expressed as
23761 Universal Time."
23762 (format-time-string
23763 format (org-timestamp--to-internal-time timestamp end) utc))
23765 (defun org-timestamp-split-range (timestamp &optional end)
23766 "Extract a TIMESTAMP object from a date or time range.
23768 END, when non-nil, means extract the end of the range.
23769 Otherwise, extract its start.
23771 Return a new timestamp object."
23772 (let ((type (org-element-property :type timestamp)))
23773 (if (memq type '(active inactive diary)) timestamp
23774 (let ((split-ts (org-element-copy timestamp)))
23775 ;; Set new type.
23776 (org-element-put-property
23777 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23778 ;; Copy start properties over end properties if END is
23779 ;; non-nil. Otherwise, copy end properties over `start' ones.
23780 (let ((p-alist '((:minute-start . :minute-end)
23781 (:hour-start . :hour-end)
23782 (:day-start . :day-end)
23783 (:month-start . :month-end)
23784 (:year-start . :year-end))))
23785 (dolist (p-cell p-alist)
23786 (org-element-put-property
23787 split-ts
23788 (funcall (if end #'car #'cdr) p-cell)
23789 (org-element-property
23790 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23791 ;; Eventually refresh `:raw-value'.
23792 (org-element-put-property split-ts :raw-value nil)
23793 (org-element-put-property
23794 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23796 (defun org-timestamp-translate (timestamp &optional boundary)
23797 "Translate TIMESTAMP object to custom format.
23799 Format string is defined in `org-time-stamp-custom-formats',
23800 which see.
23802 When optional argument BOUNDARY is non-nil, it is either the
23803 symbol `start' or `end'. In this case, only translate the
23804 starting or ending part of TIMESTAMP if it is a date or time
23805 range. Otherwise, translate both parts.
23807 Return timestamp as-is if `org-display-custom-times' is nil or if
23808 it has a `diary' type."
23809 (let ((type (org-element-property :type timestamp)))
23810 (if (or (not org-display-custom-times) (eq type 'diary))
23811 (org-element-interpret-data timestamp)
23812 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23813 org-time-stamp-custom-formats)))
23814 (if (and (not boundary) (memq type '(active-range inactive-range)))
23815 (concat (org-timestamp-format timestamp fmt)
23816 "--"
23817 (org-timestamp-format timestamp fmt t))
23818 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23822 ;;; Other stuff.
23824 (defvar reftex-docstruct-symbol)
23825 (defvar reftex-cite-format)
23826 (defvar org--rds)
23828 (defun org-reftex-citation ()
23829 "Use reftex-citation to insert a citation into the buffer.
23830 This looks for a line like
23832 #+BIBLIOGRAPHY: foo plain option:-d
23834 and derives from it that foo.bib is the bibliography file relevant
23835 for this document. It then installs the necessary environment for RefTeX
23836 to work in this buffer and calls `reftex-citation' to insert a citation
23837 into the buffer.
23839 Export of such citations to both LaTeX and HTML is handled by the contributed
23840 package ox-bibtex by Taru Karttunen."
23841 (interactive)
23842 (let ((reftex-docstruct-symbol 'org--rds)
23843 (reftex-cite-format "\\cite{%l}")
23844 org--rds bib)
23845 (save-excursion
23846 (save-restriction
23847 (widen)
23848 (let ((case-fold-search t)
23849 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23850 (if (not (save-excursion
23851 (or (re-search-forward re nil t)
23852 (re-search-backward re nil t))))
23853 (user-error "No bibliography defined in file")
23854 (setq bib (concat (match-string 1) ".bib")
23855 org--rds (list (list 'bib bib)))))))
23856 (call-interactively 'reftex-citation)))
23858 ;;;; Functions extending outline functionality
23860 (defun org-beginning-of-line (&optional arg)
23861 "Go to the beginning of the current line. If that is invisible, continue
23862 to a visible line beginning. This makes the function of C-a more intuitive.
23863 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23864 first attempt, and only move to after the tags when the cursor is already
23865 beyond the end of the headline."
23866 (interactive "P")
23867 (let ((pos (point))
23868 (special (if (consp org-special-ctrl-a/e)
23869 (car org-special-ctrl-a/e)
23870 org-special-ctrl-a/e))
23871 deactivate-mark refpos)
23872 (if (org-bound-and-true-p visual-line-mode)
23873 (beginning-of-visual-line 1)
23874 (beginning-of-line 1))
23875 (if (and arg (fboundp 'move-beginning-of-line))
23876 (call-interactively 'move-beginning-of-line)
23877 (if (bobp)
23879 (backward-char 1)
23880 (if (org-truely-invisible-p)
23881 (while (and (not (bobp)) (org-truely-invisible-p))
23882 (backward-char 1)
23883 (beginning-of-line 1))
23884 (forward-char 1))))
23885 (when special
23886 (cond
23887 ((and (looking-at org-complex-heading-regexp)
23888 (eq (char-after (match-end 1)) ?\s))
23889 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23890 (point-at-eol)))
23891 (goto-char
23892 (if (eq special t)
23893 (cond ((> pos refpos) refpos)
23894 ((= pos (point)) refpos)
23895 (t (point)))
23896 (cond ((> pos (point)) (point))
23897 ((not (eq last-command this-command)) (point))
23898 (t refpos)))))
23899 ((org-at-item-p)
23900 ;; Being at an item and not looking at an the item means point
23901 ;; was previously moved to beginning of a visual line, which
23902 ;; doesn't contain the item. Therefore, do nothing special,
23903 ;; just stay here.
23904 (when (looking-at org-list-full-item-re)
23905 ;; Set special position at first white space character after
23906 ;; bullet, and check-box, if any.
23907 (let ((after-bullet
23908 (let ((box (match-end 3)))
23909 (if (not box) (match-end 1)
23910 (let ((after (char-after box)))
23911 (if (and after (= after ? )) (1+ box) box))))))
23912 ;; Special case: Move point to special position when
23913 ;; currently after it or at beginning of line.
23914 (if (eq special t)
23915 (when (or (> pos after-bullet) (= (point) pos))
23916 (goto-char after-bullet))
23917 ;; Reversed case: Move point to special position when
23918 ;; point was already at beginning of line and command is
23919 ;; repeated.
23920 (when (and (= (point) pos) (eq last-command this-command))
23921 (goto-char after-bullet))))))))
23922 (org-no-warnings
23923 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23924 (setq disable-point-adjustment
23925 (or (not (invisible-p (point)))
23926 (not (invisible-p (max (point-min) (1- (point))))))))
23928 (defun org-end-of-line (&optional arg)
23929 "Go to the end of the line.
23930 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23931 tags on the first attempt, and only move to after the tags when
23932 the cursor is already beyond the end of the headline."
23933 (interactive "P")
23934 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23935 org-special-ctrl-a/e))
23936 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23937 'end-of-visual-line)
23938 ((fboundp 'move-end-of-line) 'move-end-of-line)
23939 (t 'end-of-line)))
23940 deactivate-mark)
23941 (if (or (not special) arg) (call-interactively move-fun)
23942 (let* ((element (save-excursion (beginning-of-line)
23943 (org-element-at-point)))
23944 (type (org-element-type element)))
23945 (cond
23946 ((memq type '(headline inlinetask))
23947 (let ((pos (point)))
23948 (beginning-of-line 1)
23949 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23950 (if (eq special t)
23951 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23952 (goto-char (match-beginning 1))
23953 (goto-char (match-end 0)))
23954 (if (or (< pos (match-end 0))
23955 (not (eq this-command last-command)))
23956 (goto-char (match-end 0))
23957 (goto-char (match-beginning 1))))
23958 (call-interactively move-fun))))
23959 ((outline-invisible-p (line-end-position))
23960 ;; If element is hidden, `move-end-of-line' would put point
23961 ;; after it. Use `end-of-line' to stay on current line.
23962 (call-interactively 'end-of-line))
23963 (t (call-interactively move-fun)))))
23964 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23965 (setq disable-point-adjustment
23966 (or (not (invisible-p (point)))
23967 (not (invisible-p (max (point-min) (1- (point))))))))
23969 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23970 (define-key org-mode-map "\C-e" 'org-end-of-line)
23972 (defun org-backward-sentence (&optional _arg)
23973 "Go to beginning of sentence, or beginning of table field.
23974 This will call `backward-sentence' or `org-table-beginning-of-field',
23975 depending on context."
23976 (interactive)
23977 (let* ((element (org-element-at-point))
23978 (contents-begin (org-element-property :contents-begin element))
23979 (table (org-element-lineage element '(table) t)))
23980 (if (and table
23981 (> (point) contents-begin)
23982 (<= (point) (org-element-property :contents-end table)))
23983 (call-interactively #'org-table-beginning-of-field)
23984 (save-restriction
23985 (when (and contents-begin
23986 (< (point-min) contents-begin)
23987 (> (point) contents-begin))
23988 (narrow-to-region contents-begin
23989 (org-element-property :contents-end element)))
23990 (call-interactively #'backward-sentence)))))
23992 (defun org-forward-sentence (&optional _arg)
23993 "Go to end of sentence, or end of table field.
23994 This will call `forward-sentence' or `org-table-end-of-field',
23995 depending on context."
23996 (interactive)
23997 (let* ((element (org-element-at-point))
23998 (contents-end (org-element-property :contents-end element))
23999 (table (org-element-lineage element '(table) t)))
24000 (if (and table
24001 (>= (point) (org-element-property :contents-begin table))
24002 (< (point) contents-end))
24003 (call-interactively #'org-table-end-of-field)
24004 (save-restriction
24005 (when (and contents-end
24006 (> (point-max) contents-end)
24007 ;; Skip blank lines between elements.
24008 (< (org-element-property :end element)
24009 (save-excursion (goto-char contents-end)
24010 (skip-chars-forward " \r\t\n"))))
24011 (narrow-to-region (org-element-property :contents-begin element)
24012 contents-end))
24013 (call-interactively #'forward-sentence)))))
24015 (define-key org-mode-map "\M-a" 'org-backward-sentence)
24016 (define-key org-mode-map "\M-e" 'org-forward-sentence)
24018 (defun org-kill-line (&optional _arg)
24019 "Kill line, to tags or end of line."
24020 (interactive)
24021 (cond
24022 ((or (not org-special-ctrl-k)
24023 (bolp)
24024 (not (org-at-heading-p)))
24025 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
24026 org-ctrl-k-protect-subtree)
24027 (if (or (eq org-ctrl-k-protect-subtree 'error)
24028 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
24029 (user-error "C-k aborted as it would kill a hidden subtree")))
24030 (call-interactively
24031 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24032 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24033 (kill-region (point) (match-beginning 1))
24034 (org-set-tags nil t))
24035 (t (kill-region (point) (point-at-eol)))))
24037 (define-key org-mode-map "\C-k" 'org-kill-line)
24039 (defun org-yank (&optional arg)
24040 "Yank. If the kill is a subtree, treat it specially.
24041 This command will look at the current kill and check if is a single
24042 subtree, or a series of subtrees[1]. If it passes the test, and if the
24043 cursor is at the beginning of a line or after the stars of a currently
24044 empty headline, then the yank is handled specially. How exactly depends
24045 on the value of the following variables, both set by default.
24047 `org-yank-folded-subtrees'
24048 When set, the subtree(s) will be folded after insertion, but only
24049 if doing so would now swallow text after the yanked text.
24051 `org-yank-adjusted-subtrees'
24052 When set, the subtree will be promoted or demoted in order to
24053 fit into the local outline tree structure, which means that the
24054 level will be adjusted so that it becomes the smaller one of the
24055 two *visible* surrounding headings.
24057 Any prefix to this command will cause `yank' to be called directly with
24058 no special treatment. In particular, a simple \\[universal-argument] prefix \
24059 will just
24060 plainly yank the text as it is.
24062 \[1] The test checks if the first non-white line is a heading
24063 and if there are no other headings with fewer stars."
24064 (interactive "P")
24065 (org-yank-generic 'yank arg))
24067 (defun org-yank-generic (command arg)
24068 "Perform some yank-like command.
24070 This function implements the behavior described in the `org-yank'
24071 documentation. However, it has been generalized to work for any
24072 interactive command with similar behavior."
24074 ;; pretend to be command COMMAND
24075 (setq this-command command)
24077 (if arg
24078 (call-interactively command)
24080 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24081 (and (org-kill-is-subtree-p)
24082 (or (bolp)
24083 (and (looking-at "[ \t]*$")
24084 (string-match
24085 "\\`\\*+\\'"
24086 (buffer-substring (point-at-bol) (point)))))))
24087 swallowp)
24088 (cond
24089 ((and subtreep org-yank-folded-subtrees)
24090 (let ((beg (point))
24091 end)
24092 (if (and subtreep org-yank-adjusted-subtrees)
24093 (org-paste-subtree nil nil 'for-yank)
24094 (call-interactively command))
24096 (setq end (point))
24097 (goto-char beg)
24098 (when (and (bolp) subtreep
24099 (not (setq swallowp
24100 (org-yank-folding-would-swallow-text beg end))))
24101 (org-with-limited-levels
24102 (or (looking-at org-outline-regexp)
24103 (re-search-forward org-outline-regexp-bol end t))
24104 (while (and (< (point) end) (looking-at org-outline-regexp))
24105 (hide-subtree)
24106 (org-cycle-show-empty-lines 'folded)
24107 (condition-case nil
24108 (outline-forward-same-level 1)
24109 (error (goto-char end))))))
24110 (when swallowp
24111 (message
24112 "Inserted text not folded because that would swallow text"))
24114 (goto-char end)
24115 (skip-chars-forward " \t\n\r")
24116 (beginning-of-line 1)
24117 (push-mark beg 'nomsg)))
24118 ((and subtreep org-yank-adjusted-subtrees)
24119 (let ((beg (point-at-bol)))
24120 (org-paste-subtree nil nil 'for-yank)
24121 (push-mark beg 'nomsg)))
24123 (call-interactively command))))))
24125 (defun org-yank-folding-would-swallow-text (beg end)
24126 "Would hide-subtree at BEG swallow any text after END?"
24127 (let (level)
24128 (org-with-limited-levels
24129 (save-excursion
24130 (goto-char beg)
24131 (when (or (looking-at org-outline-regexp)
24132 (re-search-forward org-outline-regexp-bol end t))
24133 (setq level (org-outline-level)))
24134 (goto-char end)
24135 (skip-chars-forward " \t\r\n\v\f")
24136 (if (or (eobp)
24137 (and (bolp) (looking-at org-outline-regexp)
24138 (<= (org-outline-level) level)))
24139 nil ; Nothing would be swallowed
24140 t))))) ; something would swallow
24142 (define-key org-mode-map "\C-y" 'org-yank)
24144 (defun org-truely-invisible-p ()
24145 "Check if point is at a character currently not visible.
24146 This version does not only check the character property, but also
24147 `visible-mode'."
24148 ;; Early versions of noutline don't have `outline-invisible-p'.
24149 (if (org-bound-and-true-p visible-mode)
24151 (outline-invisible-p)))
24153 (defun org-invisible-p2 ()
24154 "Check if point is at a character currently not visible."
24155 (save-excursion
24156 (if (and (eolp) (not (bobp))) (backward-char 1))
24157 ;; Early versions of noutline don't have `outline-invisible-p'.
24158 (outline-invisible-p)))
24160 (defun org-back-to-heading (&optional invisible-ok)
24161 "Call `outline-back-to-heading', but provide a better error message."
24162 (condition-case nil
24163 (outline-back-to-heading invisible-ok)
24164 (error (error "Before first headline at position %d in buffer %s"
24165 (point) (current-buffer)))))
24167 (defun org-before-first-heading-p ()
24168 "Before first heading?"
24169 (save-excursion
24170 (end-of-line)
24171 (null (re-search-backward org-outline-regexp-bol nil t))))
24173 (defun org-at-heading-p (&optional ignored)
24174 (outline-on-heading-p t))
24175 ;; Compatibility alias with Org versions < 7.8.03
24176 (defalias 'org-on-heading-p 'org-at-heading-p)
24178 (defun org-in-commented-heading-p (&optional no-inheritance)
24179 "Non-nil if point is under a commented heading.
24180 This function also checks ancestors of the current headline,
24181 unless optional argument NO-INHERITANCE is non-nil."
24182 (cond
24183 ((org-before-first-heading-p) nil)
24184 ((let ((headline (nth 4 (org-heading-components))))
24185 (and headline
24186 (let ((case-fold-search nil))
24187 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24188 headline)))))
24189 (no-inheritance nil)
24191 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24193 (defun org-at-comment-p nil
24194 "Is cursor in a commented line?"
24195 (save-excursion
24196 (save-match-data
24197 (beginning-of-line)
24198 (looking-at "^[ \t]*# "))))
24200 (defun org-at-drawer-p nil
24201 "Is cursor at a drawer keyword?"
24202 (save-excursion
24203 (move-beginning-of-line 1)
24204 (looking-at org-drawer-regexp)))
24206 (defun org-at-block-p nil
24207 "Is cursor at a block keyword?"
24208 (save-excursion
24209 (move-beginning-of-line 1)
24210 (looking-at org-block-regexp)))
24212 (defun org-point-at-end-of-empty-headline ()
24213 "If point is at the end of an empty headline, return t, else nil.
24214 If the heading only contains a TODO keyword, it is still still considered
24215 empty."
24216 (and (looking-at "[ \t]*$")
24217 (when org-todo-line-regexp
24218 (save-excursion
24219 (beginning-of-line 1)
24220 (let ((case-fold-search nil))
24221 (looking-at org-todo-line-regexp)
24222 (string= (match-string 3) ""))))))
24224 (defun org-at-heading-or-item-p ()
24225 (or (org-at-heading-p) (org-at-item-p)))
24227 (defun org-at-target-p ()
24228 (or (org-in-regexp org-radio-target-regexp)
24229 (org-in-regexp org-target-regexp)))
24230 ;; Compatibility alias with Org versions < 7.8.03
24231 (defalias 'org-on-target-p 'org-at-target-p)
24233 (defun org-up-heading-all (arg)
24234 "Move to the heading line of which the present line is a subheading.
24235 This function considers both visible and invisible heading lines.
24236 With argument, move up ARG levels."
24237 (if (fboundp 'outline-up-heading-all)
24238 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24239 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24241 (defun org-up-heading-safe ()
24242 "Move to the heading line of which the present line is a subheading.
24243 This version will not throw an error. It will return the level of the
24244 headline found, or nil if no higher level is found.
24246 Also, this function will be a lot faster than `outline-up-heading',
24247 because it relies on stars being the outline starters. This can really
24248 make a significant difference in outlines with very many siblings."
24249 (when (ignore-errors (org-back-to-heading t))
24250 (let ((level-up (1- (funcall outline-level))))
24251 (and (> level-up 0)
24252 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24253 (funcall outline-level)))))
24255 (defun org-first-sibling-p ()
24256 "Is this heading the first child of its parents?"
24257 (interactive)
24258 (let ((re org-outline-regexp-bol)
24259 level l)
24260 (unless (org-at-heading-p t)
24261 (user-error "Not at a heading"))
24262 (setq level (funcall outline-level))
24263 (save-excursion
24264 (if (not (re-search-backward re nil t))
24266 (setq l (funcall outline-level))
24267 (< l level)))))
24269 (defun org-goto-sibling (&optional previous)
24270 "Goto the next sibling, even if it is invisible.
24271 When PREVIOUS is set, go to the previous sibling instead. Returns t
24272 when a sibling was found. When none is found, return nil and don't
24273 move point."
24274 (let ((fun (if previous 're-search-backward 're-search-forward))
24275 (pos (point))
24276 (re org-outline-regexp-bol)
24277 level l)
24278 (when (ignore-errors (org-back-to-heading t))
24279 (setq level (funcall outline-level))
24280 (catch 'exit
24281 (or previous (forward-char 1))
24282 (while (funcall fun re nil t)
24283 (setq l (funcall outline-level))
24284 (when (< l level) (goto-char pos) (throw 'exit nil))
24285 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24286 (goto-char pos)
24287 nil))))
24289 (defun org-show-siblings ()
24290 "Show all siblings of the current headline."
24291 (save-excursion
24292 (while (org-goto-sibling) (org-flag-heading nil)))
24293 (save-excursion
24294 (while (org-goto-sibling 'previous)
24295 (org-flag-heading nil))))
24297 (defun org-goto-first-child ()
24298 "Goto the first child, even if it is invisible.
24299 Return t when a child was found. Otherwise don't move point and
24300 return nil."
24301 (let (level (pos (point)) (re org-outline-regexp-bol))
24302 (when (ignore-errors (org-back-to-heading t))
24303 (setq level (outline-level))
24304 (forward-char 1)
24305 (if (and (re-search-forward re nil t) (> (outline-level) level))
24306 (progn (goto-char (match-beginning 0)) t)
24307 (goto-char pos) nil))))
24309 (defun org-show-hidden-entry ()
24310 "Show an entry where even the heading is hidden."
24311 (save-excursion
24312 (org-show-entry)))
24314 (defun org-flag-heading (flag &optional entry)
24315 "Flag the current heading. FLAG non-nil means make invisible.
24316 When ENTRY is non-nil, show the entire entry."
24317 (save-excursion
24318 (org-back-to-heading t)
24319 ;; Check if we should show the entire entry
24320 (if entry
24321 (progn
24322 (org-show-entry)
24323 (save-excursion
24324 (and (outline-next-heading)
24325 (org-flag-heading nil))))
24326 (outline-flag-region (max (point-min) (1- (point)))
24327 (save-excursion (outline-end-of-heading) (point))
24328 flag))))
24330 (defun org-get-next-sibling ()
24331 "Move to next heading of the same level, and return point.
24332 If there is no such heading, return nil.
24333 This is like outline-next-sibling, but invisible headings are ok."
24334 (let ((level (funcall outline-level)))
24335 (outline-next-heading)
24336 (while (and (not (eobp)) (> (funcall outline-level) level))
24337 (outline-next-heading))
24338 (if (or (eobp) (< (funcall outline-level) level))
24340 (point))))
24342 (defun org-get-last-sibling ()
24343 "Move to previous heading of the same level, and return point.
24344 If there is no such heading, return nil."
24345 (let ((opoint (point))
24346 (level (funcall outline-level)))
24347 (outline-previous-heading)
24348 (when (and (/= (point) opoint) (outline-on-heading-p t))
24349 (while (and (> (funcall outline-level) level)
24350 (not (bobp)))
24351 (outline-previous-heading))
24352 (if (< (funcall outline-level) level)
24354 (point)))))
24356 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24357 "Goto to the end of a subtree."
24358 ;; This contains an exact copy of the original function, but it uses
24359 ;; `org-back-to-heading', to make it work also in invisible
24360 ;; trees. And is uses an invisible-ok argument.
24361 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24362 ;; Furthermore, when used inside Org, finding the end of a large subtree
24363 ;; with many children and grandchildren etc, this can be much faster
24364 ;; than the outline version.
24365 (org-back-to-heading invisible-ok)
24366 (let ((first t)
24367 (level (funcall outline-level)))
24368 (if (and (derived-mode-p 'org-mode) (< level 1000))
24369 ;; A true heading (not a plain list item), in Org-mode
24370 ;; This means we can easily find the end by looking
24371 ;; only for the right number of stars. Using a regexp to do
24372 ;; this is so much faster than using a Lisp loop.
24373 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24374 (forward-char 1)
24375 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24376 ;; something else, do it the slow way
24377 (while (and (not (eobp))
24378 (or first (> (funcall outline-level) level)))
24379 (setq first nil)
24380 (outline-next-heading)))
24381 (unless to-heading
24382 (if (memq (preceding-char) '(?\n ?\^M))
24383 (progn
24384 ;; Go to end of line before heading
24385 (forward-char -1)
24386 (if (memq (preceding-char) '(?\n ?\^M))
24387 ;; leave blank line before heading
24388 (forward-char -1))))))
24389 (point))
24391 (defun org-end-of-meta-data (&optional full)
24392 "Skip planning line and properties drawer in current entry.
24393 When optional argument FULL is non-nil, also skip empty lines,
24394 clocking lines and regular drawers at the beginning of the
24395 entry."
24396 (org-back-to-heading t)
24397 (forward-line)
24398 (when (org-looking-at-p org-planning-line-re) (forward-line))
24399 (when (looking-at org-property-drawer-re)
24400 (goto-char (match-end 0))
24401 (forward-line))
24402 (when (and full (not (org-at-heading-p)))
24403 (catch 'exit
24404 (let ((end (save-excursion (outline-next-heading) (point)))
24405 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24406 (while (not (eobp))
24407 (cond ((org-looking-at-p org-drawer-regexp)
24408 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24409 (forward-line)
24410 (throw 'exit t)))
24411 ((org-looking-at-p re) (forward-line))
24412 (t (throw 'exit t))))))))
24414 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24415 "Move forward to the ARG'th subheading at same level as this one.
24416 Stop at the first and last subheadings of a superior heading.
24417 Normally this only looks at visible headings, but when INVISIBLE-OK is
24418 non-nil it will also look at invisible ones."
24419 (interactive "p")
24420 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24421 (if (and arg (< arg 0))
24422 (goto-char (point-min))
24423 (outline-next-heading))
24424 (org-at-heading-p)
24425 (let ((level (- (match-end 0) (match-beginning 0) 1))
24426 (f (if (and arg (< arg 0))
24427 're-search-backward
24428 're-search-forward))
24429 (count (if arg (abs arg) 1))
24430 (result (point)))
24431 (while (and (prog1 (> count 0)
24432 (forward-char (if (and arg (< arg 0)) -1 1)))
24433 (funcall f org-outline-regexp-bol nil 'move))
24434 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24435 (cond ((< l level) (setq count 0))
24436 ((and (= l level)
24437 (or invisible-ok
24438 (progn
24439 (goto-char (line-beginning-position))
24440 (not (outline-invisible-p)))))
24441 (setq count (1- count))
24442 (when (eq l level)
24443 (setq result (point)))))))
24444 (goto-char result))
24445 (beginning-of-line 1)))
24447 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24448 "Move backward to the ARG'th subheading at same level as this one.
24449 Stop at the first and last subheadings of a superior heading."
24450 (interactive "p")
24451 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24453 (defun org-next-visible-heading (arg)
24454 "Move to the next visible heading.
24456 This function wraps `outline-next-visible-heading' with
24457 `org-with-limited-levels' in order to skip over inline tasks and
24458 respect customization of `org-odd-levels-only'."
24459 (interactive "p")
24460 (org-with-limited-levels
24461 (outline-next-visible-heading arg)))
24463 (defun org-previous-visible-heading (arg)
24464 "Move to the next visible heading.
24466 This function wraps `outline-previous-visible-heading' with
24467 `org-with-limited-levels' in order to skip over inline tasks and
24468 respect customization of `org-odd-levels-only'."
24469 (interactive "p")
24470 (org-with-limited-levels
24471 (outline-previous-visible-heading arg)))
24473 (defun org-next-block (arg &optional backward block-regexp)
24474 "Jump to the next block.
24476 With a prefix argument ARG, jump forward ARG many blocks.
24478 When BACKWARD is non-nil, jump to the previous block.
24480 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24481 Match data is set according to this regexp when the function
24482 returns.
24484 Return point at beginning of the opening line of found block.
24485 Throw an error if no block is found."
24486 (interactive "p")
24487 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24488 (case-fold-search t)
24489 (search-fn (if backward #'re-search-backward #'re-search-forward))
24490 (count (or arg 1))
24491 (origin (point))
24492 last-element)
24493 (if backward (beginning-of-line) (end-of-line))
24494 (while (and (> count 0) (funcall search-fn re nil t))
24495 (let ((element (save-excursion
24496 (goto-char (match-beginning 0))
24497 (save-match-data (org-element-at-point)))))
24498 (when (and (memq (org-element-type element)
24499 '(center-block comment-block dynamic-block
24500 example-block export-block quote-block
24501 special-block src-block verse-block))
24502 (<= (match-beginning 0)
24503 (org-element-property :post-affiliated element)))
24504 (setq last-element element)
24505 (decf count))))
24506 (if (= count 0)
24507 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24508 (save-match-data (org-show-context)))
24509 (goto-char origin)
24510 (user-error "No %s code blocks" (if backward "previous" "further")))))
24512 (defun org-previous-block (arg &optional block-regexp)
24513 "Jump to the previous block.
24514 With a prefix argument ARG, jump backward ARG many source blocks.
24515 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24516 (interactive "p")
24517 (org-next-block arg t block-regexp))
24519 (defun org-forward-paragraph ()
24520 "Move forward to beginning of next paragraph or equivalent.
24522 The function moves point to the beginning of the next visible
24523 structural element, which can be a paragraph, a table, a list
24524 item, etc. It also provides some special moves for convenience:
24526 - On an affiliated keyword, jump to the beginning of the
24527 relative element.
24528 - On an item or a footnote definition, move to the second
24529 element inside, if any.
24530 - On a table or a property drawer, jump after it.
24531 - On a verse or source block, stop after blank lines."
24532 (interactive)
24533 (when (eobp) (user-error "Cannot move further down"))
24534 (let* ((deactivate-mark nil)
24535 (element (org-element-at-point))
24536 (type (org-element-type element))
24537 (post-affiliated (org-element-property :post-affiliated element))
24538 (contents-begin (org-element-property :contents-begin element))
24539 (contents-end (org-element-property :contents-end element))
24540 (end (let ((end (org-element-property :end element)) (parent element))
24541 (while (and (setq parent (org-element-property :parent parent))
24542 (= (org-element-property :contents-end parent) end))
24543 (setq end (org-element-property :end parent)))
24544 end)))
24545 (cond ((not element)
24546 (skip-chars-forward " \r\t\n")
24547 (or (eobp) (beginning-of-line)))
24548 ;; On affiliated keywords, move to element's beginning.
24549 ((< (point) post-affiliated)
24550 (goto-char post-affiliated))
24551 ;; At a table row, move to the end of the table. Similarly,
24552 ;; at a node property, move to the end of the property
24553 ;; drawer.
24554 ((memq type '(node-property table-row))
24555 (goto-char (org-element-property
24556 :end (org-element-property :parent element))))
24557 ((memq type '(property-drawer table)) (goto-char end))
24558 ;; Consider blank lines as separators in verse and source
24559 ;; blocks to ease editing.
24560 ((memq type '(src-block verse-block))
24561 (when (eq type 'src-block)
24562 (setq contents-end
24563 (save-excursion (goto-char end)
24564 (skip-chars-backward " \r\t\n")
24565 (line-beginning-position))))
24566 (beginning-of-line)
24567 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24568 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24569 (goto-char end)
24570 (skip-chars-forward " \r\t\n")
24571 (if (= (point) contents-end) (goto-char end)
24572 (beginning-of-line))))
24573 ;; With no contents, just skip element.
24574 ((not contents-begin) (goto-char end))
24575 ;; If contents are invisible, skip the element altogether.
24576 ((outline-invisible-p (line-end-position))
24577 (case type
24578 (headline
24579 (org-with-limited-levels (outline-next-visible-heading 1)))
24580 ;; At a plain list, make sure we move to the next item
24581 ;; instead of skipping the whole list.
24582 (plain-list (forward-char)
24583 (org-forward-paragraph))
24584 (otherwise (goto-char end))))
24585 ((>= (point) contents-end) (goto-char end))
24586 ((>= (point) contents-begin)
24587 ;; This can only happen on paragraphs and plain lists.
24588 (case type
24589 (paragraph (goto-char end))
24590 ;; At a plain list, try to move to second element in
24591 ;; first item, if possible.
24592 (plain-list (end-of-line)
24593 (org-forward-paragraph))))
24594 ;; When contents start on the middle of a line (e.g. in
24595 ;; items and footnote definitions), try to reach first
24596 ;; element starting after current line.
24597 ((> (line-end-position) contents-begin)
24598 (end-of-line)
24599 (org-forward-paragraph))
24600 (t (goto-char contents-begin)))))
24602 (defun org-backward-paragraph ()
24603 "Move backward to start of previous paragraph or equivalent.
24605 The function moves point to the beginning of the current
24606 structural element, which can be a paragraph, a table, a list
24607 item, etc., or to the beginning of the previous visible one if
24608 point is already there. It also provides some special moves for
24609 convenience:
24611 - On an affiliated keyword, jump to the first one.
24612 - On a table or a property drawer, move to its beginning.
24613 - On a verse or source block, stop before blank lines."
24614 (interactive)
24615 (when (bobp) (user-error "Cannot move further up"))
24616 (let* ((deactivate-mark nil)
24617 (element (org-element-at-point))
24618 (type (org-element-type element))
24619 (contents-begin (org-element-property :contents-begin element))
24620 (contents-end (org-element-property :contents-end element))
24621 (post-affiliated (org-element-property :post-affiliated element))
24622 (begin (org-element-property :begin element)))
24623 (cond
24624 ((not element) (goto-char (point-min)))
24625 ((= (point) begin)
24626 (backward-char)
24627 (org-backward-paragraph))
24628 ((<= (point) post-affiliated) (goto-char begin))
24629 ((memq type '(node-property table-row))
24630 (goto-char (org-element-property
24631 :post-affiliated (org-element-property :parent element))))
24632 ((memq type '(property-drawer table)) (goto-char begin))
24633 ((memq type '(src-block verse-block))
24634 (when (eq type 'src-block)
24635 (setq contents-begin
24636 (save-excursion (goto-char begin) (forward-line) (point))))
24637 (if (= (point) contents-begin) (goto-char post-affiliated)
24638 ;; Inside a verse block, see blank lines as paragraph
24639 ;; separators.
24640 (let ((origin (point)))
24641 (skip-chars-backward " \r\t\n" contents-begin)
24642 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24643 (skip-chars-forward " \r\t\n" origin)
24644 (if (= (point) origin) (goto-char contents-begin)
24645 (beginning-of-line))))))
24646 ((not contents-begin) (goto-char (or post-affiliated begin)))
24647 ((eq type 'paragraph)
24648 (goto-char contents-begin)
24649 ;; When at first paragraph in an item or a footnote definition,
24650 ;; move directly to beginning of line.
24651 (let ((parent-contents
24652 (org-element-property
24653 :contents-begin (org-element-property :parent element))))
24654 (when (and parent-contents (= parent-contents contents-begin))
24655 (beginning-of-line))))
24656 ;; At the end of a greater element, move to the beginning of the
24657 ;; last element within.
24658 ((>= (point) contents-end)
24659 (goto-char (1- contents-end))
24660 (org-backward-paragraph))
24661 (t (goto-char (or post-affiliated begin))))
24662 ;; Ensure we never leave point invisible.
24663 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24665 (defun org-forward-element ()
24666 "Move forward by one element.
24667 Move to the next element at the same level, when possible."
24668 (interactive)
24669 (cond ((eobp) (user-error "Cannot move further down"))
24670 ((org-with-limited-levels (org-at-heading-p))
24671 (let ((origin (point)))
24672 (goto-char (org-end-of-subtree nil t))
24673 (unless (org-with-limited-levels (org-at-heading-p))
24674 (goto-char origin)
24675 (user-error "Cannot move further down"))))
24677 (let* ((elem (org-element-at-point))
24678 (end (org-element-property :end elem))
24679 (parent (org-element-property :parent elem)))
24680 (cond ((and parent (= (org-element-property :contents-end parent) end))
24681 (goto-char (org-element-property :end parent)))
24682 ((integer-or-marker-p end) (goto-char end))
24683 (t (message "No element at point")))))))
24685 (defun org-backward-element ()
24686 "Move backward by one element.
24687 Move to the previous element at the same level, when possible."
24688 (interactive)
24689 (cond ((bobp) (user-error "Cannot move further up"))
24690 ((org-with-limited-levels (org-at-heading-p))
24691 ;; At a headline, move to the previous one, if any, or stay
24692 ;; here.
24693 (let ((origin (point)))
24694 (org-with-limited-levels (org-backward-heading-same-level 1))
24695 ;; When current headline has no sibling above, move to its
24696 ;; parent.
24697 (when (= (point) origin)
24698 (or (org-with-limited-levels (org-up-heading-safe))
24699 (progn (goto-char origin)
24700 (user-error "Cannot move further up"))))))
24702 (let* ((elem (org-element-at-point))
24703 (beg (org-element-property :begin elem)))
24704 (cond
24705 ;; Move to beginning of current element if point isn't
24706 ;; there already.
24707 ((null beg) (message "No element at point"))
24708 ((/= (point) beg) (goto-char beg))
24709 (t (goto-char beg)
24710 (skip-chars-backward " \r\t\n")
24711 (unless (bobp)
24712 (let ((prev (org-element-at-point)))
24713 (goto-char (org-element-property :begin prev))
24714 (while (and (setq prev (org-element-property :parent prev))
24715 (<= (org-element-property :end prev) beg))
24716 (goto-char (org-element-property :begin prev)))))))))))
24718 (defun org-up-element ()
24719 "Move to upper element."
24720 (interactive)
24721 (if (org-with-limited-levels (org-at-heading-p))
24722 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24723 (let* ((elem (org-element-at-point))
24724 (parent (org-element-property :parent elem)))
24725 (if parent (goto-char (org-element-property :begin parent))
24726 (if (org-with-limited-levels (org-before-first-heading-p))
24727 (user-error "No surrounding element")
24728 (org-with-limited-levels (org-back-to-heading)))))))
24730 (defvar org-element-greater-elements)
24731 (defun org-down-element ()
24732 "Move to inner element."
24733 (interactive)
24734 (let ((element (org-element-at-point)))
24735 (cond
24736 ((memq (org-element-type element) '(plain-list table))
24737 (goto-char (org-element-property :contents-begin element))
24738 (forward-char))
24739 ((memq (org-element-type element) org-element-greater-elements)
24740 ;; If contents are hidden, first disclose them.
24741 (when (outline-invisible-p (line-end-position)) (org-cycle))
24742 (goto-char (or (org-element-property :contents-begin element)
24743 (user-error "No content for this element"))))
24744 (t (user-error "No inner element")))))
24746 (defun org-drag-element-backward ()
24747 "Move backward element at point."
24748 (interactive)
24749 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24750 (let* ((elem (org-element-at-point))
24751 (prev-elem
24752 (save-excursion
24753 (goto-char (org-element-property :begin elem))
24754 (skip-chars-backward " \r\t\n")
24755 (unless (bobp)
24756 (let* ((beg (org-element-property :begin elem))
24757 (prev (org-element-at-point))
24758 (up prev))
24759 (while (and (setq up (org-element-property :parent up))
24760 (<= (org-element-property :end up) beg))
24761 (setq prev up))
24762 prev)))))
24763 ;; Error out if no previous element or previous element is
24764 ;; a parent of the current one.
24765 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24766 (user-error "Cannot drag element backward")
24767 (let ((pos (point)))
24768 (org-element-swap-A-B prev-elem elem)
24769 (goto-char (+ (org-element-property :begin prev-elem)
24770 (- pos (org-element-property :begin elem)))))))))
24772 (defun org-drag-element-forward ()
24773 "Move forward element at point."
24774 (interactive)
24775 (let* ((pos (point))
24776 (elem (org-element-at-point)))
24777 (when (= (point-max) (org-element-property :end elem))
24778 (user-error "Cannot drag element forward"))
24779 (goto-char (org-element-property :end elem))
24780 (let ((next-elem (org-element-at-point)))
24781 (when (or (org-element-nested-p elem next-elem)
24782 (and (eq (org-element-type next-elem) 'headline)
24783 (not (eq (org-element-type elem) 'headline))))
24784 (goto-char pos)
24785 (user-error "Cannot drag element forward"))
24786 ;; Compute new position of point: it's shifted by NEXT-ELEM
24787 ;; body's length (without final blanks) and by the length of
24788 ;; blanks between ELEM and NEXT-ELEM.
24789 (let ((size-next (- (save-excursion
24790 (goto-char (org-element-property :end next-elem))
24791 (skip-chars-backward " \r\t\n")
24792 (forward-line)
24793 ;; Small correction if buffer doesn't end
24794 ;; with a newline character.
24795 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24796 (org-element-property :begin next-elem)))
24797 (size-blank (- (org-element-property :end elem)
24798 (save-excursion
24799 (goto-char (org-element-property :end elem))
24800 (skip-chars-backward " \r\t\n")
24801 (forward-line)
24802 (point)))))
24803 (org-element-swap-A-B elem next-elem)
24804 (goto-char (+ pos size-next size-blank))))))
24806 (defun org-drag-line-forward (arg)
24807 "Drag the line at point ARG lines forward."
24808 (interactive "p")
24809 (dotimes (n (abs arg))
24810 (let ((c (current-column)))
24811 (if (< 0 arg)
24812 (progn
24813 (beginning-of-line 2)
24814 (transpose-lines 1)
24815 (beginning-of-line 0))
24816 (transpose-lines 1)
24817 (beginning-of-line -1))
24818 (org-move-to-column c))))
24820 (defun org-drag-line-backward (arg)
24821 "Drag the line at point ARG lines backward."
24822 (interactive "p")
24823 (org-drag-line-forward (- arg)))
24825 (defun org-mark-element ()
24826 "Put point at beginning of this element, mark at end.
24828 Interactively, if this command is repeated or (in Transient Mark
24829 mode) if the mark is active, it marks the next element after the
24830 ones already marked."
24831 (interactive)
24832 (let (deactivate-mark)
24833 (if (and (org-called-interactively-p 'any)
24834 (or (and (eq last-command this-command) (mark t))
24835 (and transient-mark-mode mark-active)))
24836 (set-mark
24837 (save-excursion
24838 (goto-char (mark))
24839 (goto-char (org-element-property :end (org-element-at-point)))))
24840 (let ((element (org-element-at-point)))
24841 (end-of-line)
24842 (push-mark (org-element-property :end element) t t)
24843 (goto-char (org-element-property :begin element))))))
24845 (defun org-narrow-to-element ()
24846 "Narrow buffer to current element."
24847 (interactive)
24848 (let ((elem (org-element-at-point)))
24849 (cond
24850 ((eq (car elem) 'headline)
24851 (narrow-to-region
24852 (org-element-property :begin elem)
24853 (org-element-property :end elem)))
24854 ((memq (car elem) org-element-greater-elements)
24855 (narrow-to-region
24856 (org-element-property :contents-begin elem)
24857 (org-element-property :contents-end elem)))
24859 (narrow-to-region
24860 (org-element-property :begin elem)
24861 (org-element-property :end elem))))))
24863 (defun org-transpose-element ()
24864 "Transpose current and previous elements, keeping blank lines between.
24865 Point is moved after both elements."
24866 (interactive)
24867 (org-skip-whitespace)
24868 (let ((end (org-element-property :end (org-element-at-point))))
24869 (org-drag-element-backward)
24870 (goto-char end)))
24872 (defun org-unindent-buffer ()
24873 "Un-indent the visible part of the buffer.
24874 Relative indentation (between items, inside blocks, etc.) isn't
24875 modified."
24876 (interactive)
24877 (unless (eq major-mode 'org-mode)
24878 (user-error "Cannot un-indent a buffer not in Org mode"))
24879 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24880 unindent-tree ; For byte-compiler.
24881 (unindent-tree
24882 (function
24883 (lambda (contents)
24884 (mapc
24885 (lambda (element)
24886 (if (memq (org-element-type element) '(headline section))
24887 (funcall unindent-tree (org-element-contents element))
24888 (save-excursion
24889 (save-restriction
24890 (narrow-to-region
24891 (org-element-property :begin element)
24892 (org-element-property :end element))
24893 (org-do-remove-indentation)))))
24894 (reverse contents))))))
24895 (funcall unindent-tree (org-element-contents parse-tree))))
24897 (defun org-show-subtree ()
24898 "Show everything after this heading at deeper levels."
24899 (interactive)
24900 (outline-flag-region
24901 (point)
24902 (save-excursion
24903 (org-end-of-subtree t t))
24904 nil))
24906 (defun org-show-entry ()
24907 "Show the body directly following this heading.
24908 Show the heading too, if it is currently invisible."
24909 (interactive)
24910 (save-excursion
24911 (ignore-errors
24912 (org-back-to-heading t)
24913 (outline-flag-region
24914 (max (point-min) (1- (point)))
24915 (save-excursion
24916 (if (re-search-forward
24917 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24918 (match-beginning 1)
24919 (point-max)))
24920 nil)
24921 (org-cycle-hide-drawers 'children))))
24923 (defun org-make-options-regexp (kwds &optional extra)
24924 "Make a regular expression for keyword lines.
24925 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24926 when non-nil, is a regexp matching keywords names."
24927 (concat "^[ \t]*#\\+\\("
24928 (regexp-opt kwds)
24929 (and extra (concat (and kwds "\\|") extra))
24930 "\\):[ \t]*\\(.*\\)"))
24932 ;; Make isearch reveal the necessary context
24933 (defun org-isearch-end ()
24934 "Reveal context after isearch exits."
24935 (when isearch-success ; only if search was successful
24936 (if (featurep 'xemacs)
24937 ;; Under XEmacs, the hook is run in the correct place,
24938 ;; we directly show the context.
24939 (org-show-context 'isearch)
24940 ;; In Emacs the hook runs *before* restoring the overlays.
24941 ;; So we have to use a one-time post-command-hook to do this.
24942 ;; (Emacs 22 has a special variable, see function `org-mode')
24943 (unless (and (boundp 'isearch-mode-end-hook-quit)
24944 isearch-mode-end-hook-quit)
24945 ;; Only when the isearch was not quitted.
24946 (org-add-hook 'post-command-hook 'org-isearch-post-command
24947 'append 'local)))))
24949 (defun org-isearch-post-command ()
24950 "Remove self from hook, and show context."
24951 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24952 (org-show-context 'isearch))
24955 ;;;; Integration with and fixes for other packages
24957 ;;; Imenu support
24959 (defvar org-imenu-markers nil
24960 "All markers currently used by Imenu.")
24961 (make-variable-buffer-local 'org-imenu-markers)
24963 (defun org-imenu-new-marker (&optional pos)
24964 "Return a new marker for use by Imenu, and remember the marker."
24965 (let ((m (make-marker)))
24966 (move-marker m (or pos (point)))
24967 (push m org-imenu-markers)
24970 (defun org-imenu-get-tree ()
24971 "Produce the index for Imenu."
24972 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24973 (setq org-imenu-markers nil)
24974 (let* ((n org-imenu-depth)
24975 (re (concat "^" (org-get-limited-outline-regexp)))
24976 (subs (make-vector (1+ n) nil))
24977 (last-level 0)
24978 m level head0 head)
24979 (save-excursion
24980 (save-restriction
24981 (widen)
24982 (goto-char (point-max))
24983 (while (re-search-backward re nil t)
24984 (setq level (org-reduced-level (funcall outline-level)))
24985 (when (and (<= level n)
24986 (looking-at org-complex-heading-regexp)
24987 (setq head0 (org-match-string-no-properties 4)))
24988 (setq head (org-link-display-format head0)
24989 m (org-imenu-new-marker))
24990 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24991 (if (>= level last-level)
24992 (push (cons head m) (aref subs level))
24993 (push (cons head (aref subs (1+ level))) (aref subs level))
24994 (loop for i from (1+ level) to n do (aset subs i nil)))
24995 (setq last-level level)))))
24996 (aref subs 1)))
24998 (eval-after-load "imenu"
24999 '(progn
25000 (add-hook 'imenu-after-jump-hook
25001 (lambda ()
25002 (if (derived-mode-p 'org-mode)
25003 (org-show-context 'org-goto))))))
25005 (defun org-link-display-format (link)
25006 "Replace a link with its the description.
25007 If there is no description, use the link target."
25008 (save-match-data
25009 (if (string-match org-bracket-link-analytic-regexp link)
25010 (replace-match (if (match-end 5)
25011 (match-string 5 link)
25012 (concat (match-string 1 link)
25013 (match-string 3 link)))
25014 nil t link)
25015 link)))
25017 (defun org-toggle-link-display ()
25018 "Toggle the literal or descriptive display of links."
25019 (interactive)
25020 (if org-descriptive-links
25021 (progn (org-remove-from-invisibility-spec '(org-link))
25022 (org-restart-font-lock)
25023 (setq org-descriptive-links nil))
25024 (progn (add-to-invisibility-spec '(org-link))
25025 (org-restart-font-lock)
25026 (setq org-descriptive-links t))))
25028 ;; Speedbar support
25030 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25031 "Overlay marking the agenda restriction line in speedbar.")
25032 (overlay-put org-speedbar-restriction-lock-overlay
25033 'face 'org-agenda-restriction-lock)
25034 (overlay-put org-speedbar-restriction-lock-overlay
25035 'help-echo "Agendas are currently limited to this item.")
25036 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25038 (defun org-speedbar-set-agenda-restriction ()
25039 "Restrict future agenda commands to the location at point in speedbar.
25040 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25041 (interactive)
25042 (require 'org-agenda)
25043 (let (p m tp np dir txt)
25044 (cond
25045 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25046 'org-imenu t))
25047 (setq m (get-text-property p 'org-imenu-marker))
25048 (with-current-buffer (marker-buffer m)
25049 (goto-char m)
25050 (org-agenda-set-restriction-lock 'subtree)))
25051 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25052 'speedbar-function 'speedbar-find-file))
25053 (setq tp (previous-single-property-change
25054 (1+ p) 'speedbar-function)
25055 np (next-single-property-change
25056 tp 'speedbar-function)
25057 dir (speedbar-line-directory)
25058 txt (buffer-substring-no-properties (or tp (point-min))
25059 (or np (point-max))))
25060 (with-current-buffer (find-file-noselect
25061 (let ((default-directory dir))
25062 (expand-file-name txt)))
25063 (unless (derived-mode-p 'org-mode)
25064 (user-error "Cannot restrict to non-Org-mode file"))
25065 (org-agenda-set-restriction-lock 'file)))
25066 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25067 (move-overlay org-speedbar-restriction-lock-overlay
25068 (point-at-bol) (point-at-eol))
25069 (setq current-prefix-arg nil)
25070 (org-agenda-maybe-redo)))
25072 (defvar speedbar-file-key-map)
25073 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25074 (eval-after-load "speedbar"
25075 '(progn
25076 (speedbar-add-supported-extension ".org")
25077 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25078 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25079 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25080 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25081 (add-hook 'speedbar-visiting-tag-hook
25082 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25084 ;;; Fixes and Hacks for problems with other packages
25086 (defun org--flyspell-object-check-p (element)
25087 "Non-nil when Flyspell can check object at point.
25088 ELEMENT is the element at point."
25089 (let ((object (save-excursion
25090 (when (org-looking-at-p "\\>") (backward-char))
25091 (org-element-context element))))
25092 (case (org-element-type object)
25093 ;; Prevent checks in links due to keybinding conflict with
25094 ;; Flyspell.
25095 ((code entity export-snippet inline-babel-call
25096 inline-src-block line-break latex-fragment link macro
25097 statistics-cookie target timestamp verbatim)
25098 nil)
25099 (footnote-reference
25100 ;; Only in inline footnotes, within the definition.
25101 (and (eq (org-element-property :type object) 'inline)
25102 (< (save-excursion
25103 (goto-char (org-element-property :begin object))
25104 (search-forward ":" nil t 2))
25105 (point))))
25106 (otherwise t))))
25108 (defun org-mode-flyspell-verify ()
25109 "Function used for `flyspell-generic-check-word-predicate'."
25110 (if (org-at-heading-p)
25111 ;; At a headline or an inlinetask, check title only. This is
25112 ;; faster than relying on `org-element-at-point'.
25113 (and (save-excursion (beginning-of-line)
25114 (and (let ((case-fold-search t))
25115 (not (looking-at "\\*+ END[ \t]*$")))
25116 (looking-at org-complex-heading-regexp)))
25117 (match-beginning 4)
25118 (>= (point) (match-beginning 4))
25119 (or (not (match-beginning 5))
25120 (< (point) (match-beginning 5))))
25121 (let* ((element (org-element-at-point))
25122 (post-affiliated (org-element-property :post-affiliated element)))
25123 (cond
25124 ;; Ignore checks in all affiliated keywords but captions.
25125 ((< (point) post-affiliated)
25126 (and (save-excursion
25127 (beginning-of-line)
25128 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25129 (> (point) (match-end 0))
25130 (org--flyspell-object-check-p element)))
25131 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25132 ((let ((log (org-log-into-drawer)))
25133 (and log
25134 (let ((drawer (org-element-lineage element '(drawer))))
25135 (and drawer
25136 (eq (compare-strings
25137 log nil nil
25138 (org-element-property :drawer-name drawer) nil nil t)
25139 t)))))
25140 nil)
25142 (case (org-element-type element)
25143 ((comment quote-section) t)
25144 (comment-block
25145 ;; Allow checks between block markers, not on them.
25146 (and (> (line-beginning-position) post-affiliated)
25147 (save-excursion
25148 (end-of-line)
25149 (skip-chars-forward " \r\t\n")
25150 (< (point) (org-element-property :end element)))))
25151 ;; Arbitrary list of keywords where checks are meaningful.
25152 ;; Make sure point is on the value part of the element.
25153 (keyword
25154 (and (member (org-element-property :key element)
25155 '("DESCRIPTION" "TITLE"))
25156 (save-excursion
25157 (search-backward ":" (line-beginning-position) t))))
25158 ;; Check is globally allowed in paragraphs verse blocks and
25159 ;; table rows (after affiliated keywords) but some objects
25160 ;; must not be affected.
25161 ((paragraph table-row verse-block)
25162 (let ((cbeg (org-element-property :contents-begin element))
25163 (cend (org-element-property :contents-end element)))
25164 (and cbeg (>= (point) cbeg) (< (point) cend)
25165 (org--flyspell-object-check-p element))))))))))
25166 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25168 (defun org-remove-flyspell-overlays-in (beg end)
25169 "Remove flyspell overlays in region."
25170 (and (org-bound-and-true-p flyspell-mode)
25171 (fboundp 'flyspell-delete-region-overlays)
25172 (flyspell-delete-region-overlays beg end)))
25174 (defvar flyspell-delayed-commands)
25175 (eval-after-load "flyspell"
25176 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25178 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25179 (eval-after-load "bookmark"
25180 '(if (boundp 'bookmark-after-jump-hook)
25181 ;; We can use the hook
25182 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25183 ;; Hook not available, use advice
25184 (defadvice bookmark-jump (after org-make-visible activate)
25185 "Make the position visible."
25186 (org-bookmark-jump-unhide))))
25188 ;; Make sure saveplace shows the location if it was hidden
25189 (eval-after-load "saveplace"
25190 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25191 "Make the position visible."
25192 (org-bookmark-jump-unhide)))
25194 ;; Make sure ecb shows the location if it was hidden
25195 (eval-after-load "ecb"
25196 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25197 "Make hierarchy visible when jumping into location from ECB tree buffer."
25198 (if (derived-mode-p 'org-mode)
25199 (org-show-context))))
25201 (defun org-bookmark-jump-unhide ()
25202 "Unhide the current position, to show the bookmark location."
25203 (and (derived-mode-p 'org-mode)
25204 (or (outline-invisible-p)
25205 (save-excursion (goto-char (max (point-min) (1- (point))))
25206 (outline-invisible-p)))
25207 (org-show-context 'bookmark-jump)))
25209 (defun org-mark-jump-unhide ()
25210 "Make the point visible with `org-show-context' after jumping to the mark."
25211 (when (and (derived-mode-p 'org-mode)
25212 (outline-invisible-p))
25213 (org-show-context 'mark-goto)))
25215 (eval-after-load "simple"
25216 '(defadvice pop-to-mark-command (after org-make-visible activate)
25217 "Make the point visible with `org-show-context'."
25218 (org-mark-jump-unhide)))
25220 (eval-after-load "simple"
25221 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25222 "Make the point visible with `org-show-context'."
25223 (org-mark-jump-unhide)))
25225 (eval-after-load "simple"
25226 '(defadvice pop-global-mark (after org-make-visible activate)
25227 "Make the point visible with `org-show-context'."
25228 (org-mark-jump-unhide)))
25230 ;; Make session.el ignore our circular variable
25231 (defvar session-globals-exclude)
25232 (eval-after-load "session"
25233 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25235 ;;;; Finish up
25237 (provide 'org)
25239 (run-hooks 'org-load-hook)
25241 ;;; org.el ends here