Merge branch 'master' of orgmode.org:org-mode
[org-mode.git] / lisp / org.el
blob484f3ffa264a776b76349d81942c648e0c83a808
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 jira: Add a jira:ticket protocol to Org-mode" org-jira)
728 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
729 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
730 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
731 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
732 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
733 (const :tag "C mew: Links to Mew folders/messages" org-mew)
734 (const :tag "C mtags: Support for muse-like tags" org-mtags)
735 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
736 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
737 (const :tag "C registry: A registry for Org-mode links" org-registry)
738 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
739 (const :tag "C secretary: Team management with org-mode" org-secretary)
740 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
741 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
742 (const :tag "C track: Keep up with Org-mode development" org-track)
743 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
744 (const :tag "C vm: Links to VM folders/messages" org-vm)
745 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
746 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
747 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
749 (defvar org-export-registered-backends) ; From ox.el.
750 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
751 (declare-function org-export-backend-name "ox" (backend))
752 (defcustom org-export-backends '(ascii html icalendar latex)
753 "List of export back-ends that should be always available.
755 If a description starts with <C>, the file is not part of Emacs
756 and loading it will require that you have downloaded and properly
757 installed the Org mode distribution.
759 Unlike to `org-modules', libraries in this list will not be
760 loaded along with Org, but only once the export framework is
761 needed.
763 This variable needs to be set before org.el is loaded. If you
764 need to make a change while Emacs is running, use the customize
765 interface or run the following code, where VAL stands for the new
766 value of the variable, after updating it:
768 \(progn
769 \(setq org-export-registered-backends
770 \(org-remove-if-not
771 \(lambda (backend)
772 \(let ((name (org-export-backend-name backend)))
773 \(or (memq name val)
774 \(catch 'parentp
775 \(dolist (b val)
776 \(and (org-export-derived-backend-p b name)
777 \(throw 'parentp t)))))))
778 org-export-registered-backends))
779 \(let ((new-list (mapcar #'org-export-backend-name
780 org-export-registered-backends)))
781 \(dolist (backend val)
782 \(cond
783 \((not (load (format \"ox-%s\" backend) t t))
784 \(message \"Problems while trying to load export back-end `%s'\"
785 backend))
786 \((not (memq backend new-list)) (push backend new-list))))
787 \(set-default 'org-export-backends new-list)))
789 Adding a back-end to this list will also pull the back-end it
790 depends on, if any."
791 :group 'org
792 :group 'org-export
793 :version "24.4"
794 :package-version '(Org . "8.0")
795 :initialize 'custom-initialize-set
796 :set (lambda (var val)
797 (if (not (featurep 'ox)) (set-default var val)
798 ;; Any back-end not required anymore (not present in VAL and not
799 ;; a parent of any back-end in the new value) is removed from the
800 ;; list of registered back-ends.
801 (setq org-export-registered-backends
802 (org-remove-if-not
803 (lambda (backend)
804 (let ((name (org-export-backend-name backend)))
805 (or (memq name val)
806 (catch 'parentp
807 (dolist (b val)
808 (and (org-export-derived-backend-p b name)
809 (throw 'parentp t)))))))
810 org-export-registered-backends))
811 ;; Now build NEW-LIST of both new back-ends and required
812 ;; parents.
813 (let ((new-list (mapcar #'org-export-backend-name
814 org-export-registered-backends)))
815 (dolist (backend val)
816 (cond
817 ((not (load (format "ox-%s" backend) t t))
818 (message "Problems while trying to load export back-end `%s'"
819 backend))
820 ((not (memq backend new-list)) (push backend new-list))))
821 ;; Set VAR to that list with fixed dependencies.
822 (set-default var new-list))))
823 :type '(set :greedy t
824 (const :tag " ascii Export buffer to ASCII format" ascii)
825 (const :tag " beamer Export buffer to Beamer presentation" beamer)
826 (const :tag " html Export buffer to HTML format" html)
827 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
828 (const :tag " latex Export buffer to LaTeX format" latex)
829 (const :tag " man Export buffer to MAN format" man)
830 (const :tag " md Export buffer to Markdown format" md)
831 (const :tag " odt Export buffer to ODT format" odt)
832 (const :tag " org Export buffer to Org format" org)
833 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
834 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
835 (const :tag "C deck Export buffer to deck.js presentations" deck)
836 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
837 (const :tag "C groff Export buffer to Groff format" groff)
838 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
839 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
840 (const :tag "C s5 Export buffer to s5 presentations" s5)
841 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
843 (eval-after-load 'ox
844 '(mapc
845 (lambda (backend)
846 (condition-case nil (require (intern (format "ox-%s" backend)))
847 (error (message "Problems while trying to load export back-end `%s'"
848 backend))))
849 org-export-backends))
851 (defcustom org-support-shift-select nil
852 "Non-nil means make shift-cursor commands select text when possible.
854 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
855 start selecting a region, or enlarge regions started in this way.
856 In Org-mode, in special contexts, these same keys are used for
857 other purposes, important enough to compete with shift selection.
858 Org tries to balance these needs by supporting `shift-select-mode'
859 outside these special contexts, under control of this variable.
861 The default of this variable is nil, to avoid confusing behavior. Shifted
862 cursor keys will then execute Org commands in the following contexts:
863 - on a headline, changing TODO state (left/right) and priority (up/down)
864 - on a time stamp, changing the time
865 - in a plain list item, changing the bullet type
866 - in a property definition line, switching between allowed values
867 - in the BEGIN line of a clock table (changing the time block).
868 Outside these contexts, the commands will throw an error.
870 When this variable is t and the cursor is not in a special
871 context, Org-mode will support shift-selection for making and
872 enlarging regions. To make this more effective, the bullet
873 cycling will no longer happen anywhere in an item line, but only
874 if the cursor is exactly on the bullet.
876 If you set this variable to the symbol `always', then the keys
877 will not be special in headlines, property lines, and item lines,
878 to make shift selection work there as well. If this is what you
879 want, you can use the following alternative commands: `C-c C-t'
880 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
881 can be used to switch TODO sets, `C-c -' to cycle item bullet
882 types, and properties can be edited by hand or in column view.
884 However, when the cursor is on a timestamp, shift-cursor commands
885 will still edit the time stamp - this is just too good to give up.
887 XEmacs user should have this variable set to nil, because
888 `shift-select-mode' is in Emacs 23 or later only."
889 :group 'org
890 :type '(choice
891 (const :tag "Never" nil)
892 (const :tag "When outside special context" t)
893 (const :tag "Everywhere except timestamps" always)))
895 (defcustom org-loop-over-headlines-in-active-region nil
896 "Shall some commands act upon headlines in the active region?
898 When set to `t', some commands will be performed in all headlines
899 within the active region.
901 When set to `start-level', some commands will be performed in all
902 headlines within the active region, provided that these headlines
903 are of the same level than the first one.
905 When set to a string, those commands will be performed on the
906 matching headlines within the active region. Such string must be
907 a tags/property/todo match as it is used in the agenda tags view.
909 The list of commands is: `org-schedule', `org-deadline',
910 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
911 `org-archive-to-archive-sibling'. The archiving commands skip
912 already archived entries."
913 :type '(choice (const :tag "Don't loop" nil)
914 (const :tag "All headlines in active region" t)
915 (const :tag "In active region, headlines at the same level than the first one" start-level)
916 (string :tag "Tags/Property/Todo matcher"))
917 :version "24.1"
918 :group 'org-todo
919 :group 'org-archive)
921 (defgroup org-startup nil
922 "Options concerning startup of Org-mode."
923 :tag "Org Startup"
924 :group 'org)
926 (defcustom org-startup-folded t
927 "Non-nil means entering Org-mode will switch to OVERVIEW.
928 This can also be configured on a per-file basis by adding one of
929 the following lines anywhere in the buffer:
931 #+STARTUP: fold (or `overview', this is equivalent)
932 #+STARTUP: nofold (or `showall', this is equivalent)
933 #+STARTUP: content
934 #+STARTUP: showeverything
936 By default, this option is ignored when Org opens agenda files
937 for the first time. If you want the agenda to honor the startup
938 option, set `org-agenda-inhibit-startup' to nil."
939 :group 'org-startup
940 :type '(choice
941 (const :tag "nofold: show all" nil)
942 (const :tag "fold: overview" t)
943 (const :tag "content: all headlines" content)
944 (const :tag "show everything, even drawers" showeverything)))
946 (defcustom org-startup-truncated t
947 "Non-nil means entering Org-mode will set `truncate-lines'.
948 This is useful since some lines containing links can be very long and
949 uninteresting. Also tables look terrible when wrapped."
950 :group 'org-startup
951 :type 'boolean)
953 (defcustom org-startup-indented nil
954 "Non-nil means turn on `org-indent-mode' on startup.
955 This can also be configured on a per-file basis by adding one of
956 the following lines anywhere in the buffer:
958 #+STARTUP: indent
959 #+STARTUP: noindent"
960 :group 'org-structure
961 :type '(choice
962 (const :tag "Not" nil)
963 (const :tag "Globally (slow on startup in large files)" t)))
965 (defcustom org-use-sub-superscripts t
966 "Non-nil means interpret \"_\" and \"^\" for display.
968 If you want to control how Org exports those characters, see
969 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
970 used to be an alias for `org-export-with-sub-superscripts' in
971 Org <8.0, it is not anymore.
973 When this option is turned on, you can use TeX-like syntax for
974 sub- and superscripts within the buffer. Several characters after
975 \"_\" or \"^\" will be considered as a single item - so grouping
976 with {} is normally not needed. For example, the following things
977 will be parsed as single sub- or superscripts:
979 10^24 or 10^tau several digits will be considered 1 item.
980 10^-12 or 10^-tau a leading sign with digits or a word
981 x^2-y^3 will be read as x^2 - y^3, because items are
982 terminated by almost any nonword/nondigit char.
983 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
985 Still, ambiguity is possible. So when in doubt, use {} to enclose
986 the sub/superscript. If you set this variable to the symbol `{}',
987 the braces are *required* in order to trigger interpretations as
988 sub/superscript. This can be helpful in documents that need \"_\"
989 frequently in plain text."
990 :group 'org-startup
991 :version "24.4"
992 :package-version '(Org . "8.0")
993 :type '(choice
994 (const :tag "Always interpret" t)
995 (const :tag "Only with braces" {})
996 (const :tag "Never interpret" nil)))
998 (defcustom org-startup-with-beamer-mode nil
999 "Non-nil means turn on `org-beamer-mode' on startup.
1000 This can also be configured on a per-file basis by adding one of
1001 the following lines anywhere in the buffer:
1003 #+STARTUP: beamer"
1004 :group 'org-startup
1005 :version "24.1"
1006 :type 'boolean)
1008 (defcustom org-startup-align-all-tables nil
1009 "Non-nil means align all tables when visiting a file.
1010 This is useful when the column width in tables is forced with <N> cookies
1011 in table fields. Such tables will look correct only after the first re-align.
1012 This can also be configured on a per-file basis by adding one of
1013 the following lines anywhere in the buffer:
1014 #+STARTUP: align
1015 #+STARTUP: noalign"
1016 :group 'org-startup
1017 :type 'boolean)
1019 (defcustom org-startup-with-inline-images nil
1020 "Non-nil means show inline images when loading a new Org file.
1021 This can also be configured on a per-file basis by adding one of
1022 the following lines anywhere in the buffer:
1023 #+STARTUP: inlineimages
1024 #+STARTUP: noinlineimages"
1025 :group 'org-startup
1026 :version "24.1"
1027 :type 'boolean)
1029 (defcustom org-startup-with-latex-preview nil
1030 "Non-nil means preview LaTeX fragments when loading a new Org file.
1032 This can also be configured on a per-file basis by adding one of
1033 the following lines anywhere in the buffer:
1034 #+STARTUP: latexpreview
1035 #+STARTUP: nolatexpreview"
1036 :group 'org-startup
1037 :version "24.4"
1038 :package-version '(Org . "8.0")
1039 :type 'boolean)
1041 (defcustom org-insert-mode-line-in-empty-file nil
1042 "Non-nil means insert the first line setting Org-mode in empty files.
1043 When the function `org-mode' is called interactively in an empty file, this
1044 normally means that the file name does not automatically trigger Org-mode.
1045 To ensure that the file will always be in Org-mode in the future, a
1046 line enforcing Org-mode will be inserted into the buffer, if this option
1047 has been set."
1048 :group 'org-startup
1049 :type 'boolean)
1051 (defcustom org-replace-disputed-keys nil
1052 "Non-nil means use alternative key bindings for some keys.
1053 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1054 These keys are also used by other packages like shift-selection-mode'
1055 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1056 If you want to use Org-mode together with one of these other modes,
1057 or more generally if you would like to move some Org-mode commands to
1058 other keys, set this variable and configure the keys with the variable
1059 `org-disputed-keys'.
1061 This option is only relevant at load-time of Org-mode, and must be set
1062 *before* org.el is loaded. Changing it requires a restart of Emacs to
1063 become effective."
1064 :group 'org-startup
1065 :type 'boolean)
1067 (defcustom org-use-extra-keys nil
1068 "Non-nil means use extra key sequence definitions for certain commands.
1069 This happens automatically if you run XEmacs or if `window-system'
1070 is nil. This variable lets you do the same manually. You must
1071 set it before loading org.
1073 Example: on Carbon Emacs 22 running graphically, with an external
1074 keyboard on a Powerbook, the default way of setting M-left might
1075 not work for either Alt or ESC. Setting this variable will make
1076 it work for ESC."
1077 :group 'org-startup
1078 :type 'boolean)
1080 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1082 (defcustom org-disputed-keys
1083 '(([(shift up)] . [(meta p)])
1084 ([(shift down)] . [(meta n)])
1085 ([(shift left)] . [(meta -)])
1086 ([(shift right)] . [(meta +)])
1087 ([(control shift right)] . [(meta shift +)])
1088 ([(control shift left)] . [(meta shift -)]))
1089 "Keys for which Org-mode and other modes compete.
1090 This is an alist, cars are the default keys, second element specifies
1091 the alternative to use when `org-replace-disputed-keys' is t.
1093 Keys can be specified in any syntax supported by `define-key'.
1094 The value of this option takes effect only at Org-mode's startup,
1095 therefore you'll have to restart Emacs to apply it after changing."
1096 :group 'org-startup
1097 :type 'alist)
1099 (defun org-key (key)
1100 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1101 Or return the original if not disputed.
1102 Also apply the translations defined in `org-xemacs-key-equivalents'."
1103 (when org-replace-disputed-keys
1104 (let* ((nkey (key-description key))
1105 (x (org-find-if (lambda (x)
1106 (equal (key-description (car x)) nkey))
1107 org-disputed-keys)))
1108 (setq key (if x (cdr x) key))))
1109 (when (featurep 'xemacs)
1110 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1111 key)
1113 (defun org-find-if (predicate seq)
1114 (catch 'exit
1115 (while seq
1116 (if (funcall predicate (car seq))
1117 (throw 'exit (car seq))
1118 (pop seq)))))
1120 (defun org-defkey (keymap key def)
1121 "Define a key, possibly translated, as returned by `org-key'."
1122 (define-key keymap (org-key key) def))
1124 (defcustom org-ellipsis nil
1125 "The ellipsis to use in the Org-mode outline.
1126 When nil, just use the standard three dots.
1127 When a string, use that string instead.
1128 When a face, use the standard 3 dots, but with the specified face.
1129 The change affects only Org-mode (which will then use its own display table).
1130 Changing this requires executing \\[org-mode] in a buffer to become
1131 effective."
1132 :group 'org-startup
1133 :type '(choice (const :tag "Default" nil)
1134 (face :tag "Face" :value org-warning)
1135 (string :tag "String" :value "...#")))
1137 (defvar org-display-table nil
1138 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1140 (defgroup org-keywords nil
1141 "Keywords in Org-mode."
1142 :tag "Org Keywords"
1143 :group 'org)
1145 (defcustom org-closed-keep-when-no-todo nil
1146 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1147 :group 'org-todo
1148 :group 'org-keywords
1149 :version "24.4"
1150 :package-version '(Org . "8.0")
1151 :type 'boolean)
1153 (defgroup org-structure nil
1154 "Options concerning the general structure of Org-mode files."
1155 :tag "Org Structure"
1156 :group 'org)
1158 (defgroup org-reveal-location nil
1159 "Options about how to make context of a location visible."
1160 :tag "Org Reveal Location"
1161 :group 'org-structure)
1163 (defcustom org-show-context-detail '((isearch . lineage)
1164 (bookmark-jump . lineage)
1165 (default . ancestors))
1166 "Alist between context and visibility span when revealing a location.
1168 \\<org-mode-map>Some actions may move point into invisible
1169 locations. As a consequence, Org always expose a neighborhood
1170 around point. How much is shown depends on the initial action,
1171 or context. Valid contexts are
1173 agenda when exposing an entry from the agenda
1174 org-goto when using the command `org-goto' (\\[org-goto])
1175 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1176 tags-tree when constructing a sparse tree based on tags matches
1177 link-search when exposing search matches associated with a link
1178 mark-goto when exposing the jump goal of a mark
1179 bookmark-jump when exposing a bookmark location
1180 isearch when exiting from an incremental search
1181 default default for all contexts not set explicitly
1183 Allowed visibility spans are
1185 minimal show current headline; if point is not on headline,
1186 also show entry
1188 local show current headline, entry and next headline
1190 ancestors show current headline and its direct ancestors; if
1191 point is not on headline, also show entry
1193 lineage show current headline, its direct ancestors and all
1194 their children; if point is not on headline, also show
1195 entry and first child
1197 tree show current headline, its direct ancestors and all
1198 their children; if point is not on headline, also show
1199 entry and all children
1201 canonical show current headline, its direct ancestors along with
1202 their entries and children; if point is not located on
1203 the headline, also show current entry and all children
1205 As special cases, a nil or t value means show all contexts in
1206 `minimal' or `canonical' view, respectively.
1208 Some views can make displayed information very compact, but also
1209 make it harder to edit the location of the match. In such
1210 a case, use the command `org-reveal' (\\[org-reveal]) to show
1211 more context."
1212 :group 'org-reveal-location
1213 :version "25.1"
1214 :package-version '(Org . "8.3")
1215 :type '(choice
1216 (const :tag "Canonical" t)
1217 (const :tag "Minimal" nil)
1218 (repeat :greedy t :tag "Individual contexts"
1219 (cons
1220 (choice :tag "Context"
1221 (const agenda)
1222 (const org-goto)
1223 (const occur-tree)
1224 (const tags-tree)
1225 (const link-search)
1226 (const mark-goto)
1227 (const bookmark-jump)
1228 (const isearch)
1229 (const default))
1230 (choice :tag "Detail level"
1231 (const minimal)
1232 (const local)
1233 (const ancestors)
1234 (const lineage)
1235 (const tree)
1236 (const canonical))))))
1238 (defcustom org-indirect-buffer-display 'other-window
1239 "How should indirect tree buffers be displayed?
1240 This applies to indirect buffers created with the commands
1241 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1242 Valid values are:
1243 current-window Display in the current window
1244 other-window Just display in another window.
1245 dedicated-frame Create one new frame, and re-use it each time.
1246 new-frame Make a new frame each time. Note that in this case
1247 previously-made indirect buffers are kept, and you need to
1248 kill these buffers yourself."
1249 :group 'org-structure
1250 :group 'org-agenda-windows
1251 :type '(choice
1252 (const :tag "In current window" current-window)
1253 (const :tag "In current frame, other window" other-window)
1254 (const :tag "Each time a new frame" new-frame)
1255 (const :tag "One dedicated frame" dedicated-frame)))
1257 (defcustom org-use-speed-commands nil
1258 "Non-nil means activate single letter commands at beginning of a headline.
1259 This may also be a function to test for appropriate locations where speed
1260 commands should be active.
1262 For example, to activate speed commands when the point is on any
1263 star at the beginning of the headline, you can do this:
1265 (setq org-use-speed-commands
1266 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1267 :group 'org-structure
1268 :type '(choice
1269 (const :tag "Never" nil)
1270 (const :tag "At beginning of headline stars" t)
1271 (function)))
1273 (defcustom org-speed-commands-user nil
1274 "Alist of additional speed commands.
1275 This list will be checked before `org-speed-commands-default'
1276 when the variable `org-use-speed-commands' is non-nil
1277 and when the cursor is at the beginning of a headline.
1278 The car if each entry is a string with a single letter, which must
1279 be assigned to `self-insert-command' in the global map.
1280 The cdr is either a command to be called interactively, a function
1281 to be called, or a form to be evaluated.
1282 An entry that is just a list with a single string will be interpreted
1283 as a descriptive headline that will be added when listing the speed
1284 commands in the Help buffer using the `?' speed command."
1285 :group 'org-structure
1286 :type '(repeat :value ("k" . ignore)
1287 (choice :value ("k" . ignore)
1288 (list :tag "Descriptive Headline" (string :tag "Headline"))
1289 (cons :tag "Letter and Command"
1290 (string :tag "Command letter")
1291 (choice
1292 (function)
1293 (sexp))))))
1295 (defcustom org-bookmark-names-plist
1296 '(:last-capture "org-capture-last-stored"
1297 :last-refile "org-refile-last-stored"
1298 :last-capture-marker "org-capture-last-stored-marker")
1299 "Names for bookmarks automatically set by some Org commands.
1300 This can provide strings as names for a number of bookmarks Org sets
1301 automatically. The following keys are currently implemented:
1302 :last-capture
1303 :last-capture-marker
1304 :last-refile
1305 When a key does not show up in the property list, the corresponding bookmark
1306 is not set."
1307 :group 'org-structure
1308 :type 'plist)
1310 (defgroup org-cycle nil
1311 "Options concerning visibility cycling in Org-mode."
1312 :tag "Org Cycle"
1313 :group 'org-structure)
1315 (defcustom org-cycle-skip-children-state-if-no-children t
1316 "Non-nil means skip CHILDREN state in entries that don't have any."
1317 :group 'org-cycle
1318 :type 'boolean)
1320 (defcustom org-cycle-max-level nil
1321 "Maximum level which should still be subject to visibility cycling.
1322 Levels higher than this will, for cycling, be treated as text, not a headline.
1323 When `org-odd-levels-only' is set, a value of N in this variable actually
1324 means 2N-1 stars as the limiting headline.
1325 When nil, cycle all levels.
1326 Note that the limiting level of cycling is also influenced by
1327 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1328 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1329 than its value."
1330 :group 'org-cycle
1331 :type '(choice
1332 (const :tag "No limit" nil)
1333 (integer :tag "Maximum level")))
1335 (defcustom org-hide-block-startup nil
1336 "Non-nil means entering Org-mode will fold all blocks.
1337 This can also be set in on a per-file basis with
1339 #+STARTUP: hideblocks
1340 #+STARTUP: showblocks"
1341 :group 'org-startup
1342 :group 'org-cycle
1343 :type 'boolean)
1345 (defcustom org-cycle-global-at-bob nil
1346 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1347 This makes it possible to do global cycling without having to use S-TAB or
1348 \\[universal-argument] TAB. For this special case to work, the first line
1349 of the buffer must not be a headline -- it may be empty or some other text.
1350 When used in this way, `org-cycle-hook' is disabled temporarily to make
1351 sure the cursor stays at the beginning of the buffer. When this option is
1352 nil, don't do anything special at the beginning of the buffer."
1353 :group 'org-cycle
1354 :type 'boolean)
1356 (defcustom org-cycle-level-after-item/entry-creation t
1357 "Non-nil means cycle entry level or item indentation in new empty entries.
1359 When the cursor is at the end of an empty headline, i.e., with only stars
1360 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1361 and then all possible ancestor states, before returning to the original state.
1362 This makes data entry extremely fast: M-RET to create a new headline,
1363 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1365 When the cursor is at the end of an empty plain list item, one TAB will
1366 make it a subitem, two or more tabs will back up to make this an item
1367 higher up in the item hierarchy."
1368 :group 'org-cycle
1369 :type 'boolean)
1371 (defcustom org-cycle-emulate-tab t
1372 "Where should `org-cycle' emulate TAB.
1373 nil Never
1374 white Only in completely white lines
1375 whitestart Only at the beginning of lines, before the first non-white char
1376 t Everywhere except in headlines
1377 exc-hl-bol Everywhere except at the start of a headline
1378 If TAB is used in a place where it does not emulate TAB, the current subtree
1379 visibility is cycled."
1380 :group 'org-cycle
1381 :type '(choice (const :tag "Never" nil)
1382 (const :tag "Only in completely white lines" white)
1383 (const :tag "Before first char in a line" whitestart)
1384 (const :tag "Everywhere except in headlines" t)
1385 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1387 (defcustom org-cycle-separator-lines 2
1388 "Number of empty lines needed to keep an empty line between collapsed trees.
1389 If you leave an empty line between the end of a subtree and the following
1390 headline, this empty line is hidden when the subtree is folded.
1391 Org-mode will leave (exactly) one empty line visible if the number of
1392 empty lines is equal or larger to the number given in this variable.
1393 So the default 2 means at least 2 empty lines after the end of a subtree
1394 are needed to produce free space between a collapsed subtree and the
1395 following headline.
1397 If the number is negative, and the number of empty lines is at least -N,
1398 all empty lines are shown.
1400 Special case: when 0, never leave empty lines in collapsed view."
1401 :group 'org-cycle
1402 :type 'integer)
1403 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1405 (defcustom org-pre-cycle-hook nil
1406 "Hook that is run before visibility cycling is happening.
1407 The function(s) in this hook must accept a single argument which indicates
1408 the new state that will be set right after running this hook. The
1409 argument is a symbol. Before a global state change, it can have the values
1410 `overview', `content', or `all'. Before a local state change, it can have
1411 the values `folded', `children', or `subtree'."
1412 :group 'org-cycle
1413 :type 'hook)
1415 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1416 org-cycle-hide-drawers
1417 org-cycle-show-empty-lines
1418 org-optimize-window-after-visibility-change)
1419 "Hook that is run after `org-cycle' has changed the buffer visibility.
1420 The function(s) in this hook must accept a single argument which indicates
1421 the new state that was set by the most recent `org-cycle' command. The
1422 argument is a symbol. After a global state change, it can have the values
1423 `overview', `contents', or `all'. After a local state change, it can have
1424 the values `folded', `children', or `subtree'."
1425 :group 'org-cycle
1426 :type 'hook
1427 :version "25.1"
1428 :package-version '(Org . "8.3"))
1430 (defgroup org-edit-structure nil
1431 "Options concerning structure editing in Org-mode."
1432 :tag "Org Edit Structure"
1433 :group 'org-structure)
1435 (defcustom org-odd-levels-only nil
1436 "Non-nil means skip even levels and only use odd levels for the outline.
1437 This has the effect that two stars are being added/taken away in
1438 promotion/demotion commands. It also influences how levels are
1439 handled by the exporters.
1440 Changing it requires restart of `font-lock-mode' to become effective
1441 for fontification also in regions already fontified.
1442 You may also set this on a per-file basis by adding one of the following
1443 lines to the buffer:
1445 #+STARTUP: odd
1446 #+STARTUP: oddeven"
1447 :group 'org-edit-structure
1448 :group 'org-appearance
1449 :type 'boolean)
1451 (defcustom org-adapt-indentation t
1452 "Non-nil means adapt indentation to outline node level.
1454 When this variable is set, Org assumes that you write outlines by
1455 indenting text in each node to align with the headline (after the
1456 stars). The following issues are influenced by this variable:
1458 - The indentation is increased by one space in a demotion
1459 command, and decreased by one in a promotion command. However,
1460 in the latter case, if shifting some line in the entry body
1461 would alter document structure (e.g., insert a new headline),
1462 indentation is not changed at all.
1464 - Property drawers and planning information is inserted indented
1465 when this variable is set. When nil, they will not be indented.
1467 - TAB indents a line relative to current level. The lines below
1468 a headline will be indented when this variable is set.
1470 Note that this is all about true indentation, by adding and
1471 removing space characters. See also `org-indent.el' which does
1472 level-dependent indentation in a virtual way, i.e. at display
1473 time in Emacs."
1474 :group 'org-edit-structure
1475 :type 'boolean)
1477 (defcustom org-special-ctrl-a/e nil
1478 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1480 When t, `C-a' will bring back the cursor to the beginning of the
1481 headline text, i.e. after the stars and after a possible TODO
1482 keyword. In an item, this will be the position after bullet and
1483 check-box, if any. When the cursor is already at that position,
1484 another `C-a' will bring it to the beginning of the line.
1486 `C-e' will jump to the end of the headline, ignoring the presence
1487 of tags in the headline. A second `C-e' will then jump to the
1488 true end of the line, after any tags. This also means that, when
1489 this variable is non-nil, `C-e' also will never jump beyond the
1490 end of the heading of a folded section, i.e. not after the
1491 ellipses.
1493 When set to the symbol `reversed', the first `C-a' or `C-e' works
1494 normally, going to the true line boundary first. Only a directly
1495 following, identical keypress will bring the cursor to the
1496 special positions.
1498 This may also be a cons cell where the behavior for `C-a' and
1499 `C-e' is set separately."
1500 :group 'org-edit-structure
1501 :type '(choice
1502 (const :tag "off" nil)
1503 (const :tag "on: after stars/bullet and before tags first" t)
1504 (const :tag "reversed: true line boundary first" reversed)
1505 (cons :tag "Set C-a and C-e separately"
1506 (choice :tag "Special C-a"
1507 (const :tag "off" nil)
1508 (const :tag "on: after stars/bullet first" t)
1509 (const :tag "reversed: before stars/bullet first" reversed))
1510 (choice :tag "Special C-e"
1511 (const :tag "off" nil)
1512 (const :tag "on: before tags first" t)
1513 (const :tag "reversed: after tags first" reversed)))))
1514 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1516 (defcustom org-special-ctrl-k nil
1517 "Non-nil means `C-k' will behave specially in headlines.
1518 When nil, `C-k' will call the default `kill-line' command.
1519 When t, the following will happen while the cursor is in the headline:
1521 - When the cursor is at the beginning of a headline, kill the entire
1522 line and possible the folded subtree below the line.
1523 - When in the middle of the headline text, kill the headline up to the tags.
1524 - When after the headline text, kill the tags."
1525 :group 'org-edit-structure
1526 :type 'boolean)
1528 (defcustom org-ctrl-k-protect-subtree nil
1529 "Non-nil means, do not delete a hidden subtree with C-k.
1530 When set to the symbol `error', simply throw an error when C-k is
1531 used to kill (part-of) a headline that has hidden text behind it.
1532 Any other non-nil value will result in a query to the user, if it is
1533 OK to kill that hidden subtree. When nil, kill without remorse."
1534 :group 'org-edit-structure
1535 :version "24.1"
1536 :type '(choice
1537 (const :tag "Do not protect hidden subtrees" nil)
1538 (const :tag "Protect hidden subtrees with a security query" t)
1539 (const :tag "Never kill a hidden subtree with C-k" error)))
1541 (defcustom org-special-ctrl-o t
1542 "Non-nil means, make `C-o' insert a row in tables."
1543 :group 'org-edit-structure
1544 :type 'boolean)
1546 (defcustom org-catch-invisible-edits nil
1547 "Check if in invisible region before inserting or deleting a character.
1548 Valid values are:
1550 nil Do not check, so just do invisible edits.
1551 error Throw an error and do nothing.
1552 show Make point visible, and do the requested edit.
1553 show-and-error Make point visible, then throw an error and abort the edit.
1554 smart Make point visible, and do insertion/deletion if it is
1555 adjacent to visible text and the change feels predictable.
1556 Never delete a previously invisible character or add in the
1557 middle or right after an invisible region. Basically, this
1558 allows insertion and backward-delete right before ellipses.
1559 FIXME: maybe in this case we should not even show?"
1560 :group 'org-edit-structure
1561 :version "24.1"
1562 :type '(choice
1563 (const :tag "Do not check" nil)
1564 (const :tag "Throw error when trying to edit" error)
1565 (const :tag "Unhide, but do not do the edit" show-and-error)
1566 (const :tag "Show invisible part and do the edit" show)
1567 (const :tag "Be smart and do the right thing" smart)))
1569 (defcustom org-yank-folded-subtrees t
1570 "Non-nil means when yanking subtrees, fold them.
1571 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1572 it starts with a heading and all other headings in it are either children
1573 or siblings, then fold all the subtrees. However, do this only if no
1574 text after the yank would be swallowed into a folded tree by this action."
1575 :group 'org-edit-structure
1576 :type 'boolean)
1578 (defcustom org-yank-adjusted-subtrees nil
1579 "Non-nil means when yanking subtrees, adjust the level.
1580 With this setting, `org-paste-subtree' is used to insert the subtree, see
1581 this function for details."
1582 :group 'org-edit-structure
1583 :type 'boolean)
1585 (defcustom org-M-RET-may-split-line '((default . t))
1586 "Non-nil means M-RET will split the line at the cursor position.
1587 When nil, it will go to the end of the line before making a
1588 new line.
1589 You may also set this option in a different way for different
1590 contexts. Valid contexts are:
1592 headline when creating a new headline
1593 item when creating a new item
1594 table in a table field
1595 default the value to be used for all contexts not explicitly
1596 customized"
1597 :group 'org-structure
1598 :group 'org-table
1599 :type '(choice
1600 (const :tag "Always" t)
1601 (const :tag "Never" nil)
1602 (repeat :greedy t :tag "Individual contexts"
1603 (cons
1604 (choice :tag "Context"
1605 (const headline)
1606 (const item)
1607 (const table)
1608 (const default))
1609 (boolean)))))
1612 (defcustom org-insert-heading-respect-content nil
1613 "Non-nil means insert new headings after the current subtree.
1614 When nil, the new heading is created directly after the current line.
1615 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1616 this variable on for the duration of the command."
1617 :group 'org-structure
1618 :type 'boolean)
1620 (defcustom org-blank-before-new-entry '((heading . auto)
1621 (plain-list-item . auto))
1622 "Should `org-insert-heading' leave a blank line before new heading/item?
1623 The value is an alist, with `heading' and `plain-list-item' as CAR,
1624 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1625 which case Org will look at the surrounding headings/items and try to
1626 make an intelligent decision whether to insert a blank line or not.
1628 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1629 the setting here is ignored and no empty line is inserted to avoid breaking
1630 the list structure."
1631 :group 'org-edit-structure
1632 :type '(list
1633 (cons (const heading)
1634 (choice (const :tag "Never" nil)
1635 (const :tag "Always" t)
1636 (const :tag "Auto" auto)))
1637 (cons (const plain-list-item)
1638 (choice (const :tag "Never" nil)
1639 (const :tag "Always" t)
1640 (const :tag "Auto" auto)))))
1642 (defcustom org-insert-heading-hook nil
1643 "Hook being run after inserting a new heading."
1644 :group 'org-edit-structure
1645 :type 'hook)
1647 (defcustom org-enable-fixed-width-editor t
1648 "Non-nil means lines starting with \":\" are treated as fixed-width.
1649 This currently only means they are never auto-wrapped.
1650 When nil, such lines will be treated like ordinary lines."
1651 :group 'org-edit-structure
1652 :type 'boolean)
1654 (defcustom org-goto-auto-isearch t
1655 "Non-nil means typing characters in `org-goto' starts incremental search.
1656 When nil, you can use these keybindings to navigate the buffer:
1658 q Quit the org-goto interface
1659 n Go to the next visible heading
1660 p Go to the previous visible heading
1661 f Go one heading forward on same level
1662 b Go one heading backward on same level
1663 u Go one heading up"
1664 :group 'org-edit-structure
1665 :type 'boolean)
1667 (defgroup org-sparse-trees nil
1668 "Options concerning sparse trees in Org-mode."
1669 :tag "Org Sparse Trees"
1670 :group 'org-structure)
1672 (defcustom org-highlight-sparse-tree-matches t
1673 "Non-nil means highlight all matches that define a sparse tree.
1674 The highlights will automatically disappear the next time the buffer is
1675 changed by an edit command."
1676 :group 'org-sparse-trees
1677 :type 'boolean)
1679 (defcustom org-remove-highlights-with-change t
1680 "Non-nil means any change to the buffer will remove temporary highlights.
1681 Such highlights are created by `org-occur' and `org-clock-display'.
1682 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1683 The highlights created by `org-toggle-latex-fragment' always need
1684 `C-c C-x C-l' to be removed."
1685 :group 'org-sparse-trees
1686 :group 'org-time
1687 :type 'boolean)
1690 (defcustom org-occur-hook '(org-first-headline-recenter)
1691 "Hook that is run after `org-occur' has constructed a sparse tree.
1692 This can be used to recenter the window to show as much of the structure
1693 as possible."
1694 :group 'org-sparse-trees
1695 :type 'hook)
1697 (defgroup org-imenu-and-speedbar nil
1698 "Options concerning imenu and speedbar in Org-mode."
1699 :tag "Org Imenu and Speedbar"
1700 :group 'org-structure)
1702 (defcustom org-imenu-depth 2
1703 "The maximum level for Imenu access to Org-mode headlines.
1704 This also applied for speedbar access."
1705 :group 'org-imenu-and-speedbar
1706 :type 'integer)
1708 (defgroup org-table nil
1709 "Options concerning tables in Org-mode."
1710 :tag "Org Table"
1711 :group 'org)
1713 (defcustom org-enable-table-editor 'optimized
1714 "Non-nil means lines starting with \"|\" are handled by the table editor.
1715 When nil, such lines will be treated like ordinary lines.
1717 When equal to the symbol `optimized', the table editor will be optimized to
1718 do the following:
1719 - Automatic overwrite mode in front of whitespace in table fields.
1720 This makes the structure of the table stay in tact as long as the edited
1721 field does not exceed the column width.
1722 - Minimize the number of realigns. Normally, the table is aligned each time
1723 TAB or RET are pressed to move to another field. With optimization this
1724 happens only if changes to a field might have changed the column width.
1725 Optimization requires replacing the functions `self-insert-command',
1726 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1727 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1728 very good at guessing when a re-align will be necessary, but you can always
1729 force one with \\[org-ctrl-c-ctrl-c].
1731 If you would like to use the optimized version in Org-mode, but the
1732 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1734 This variable can be used to turn on and off the table editor during a session,
1735 but in order to toggle optimization, a restart is required.
1737 See also the variable `org-table-auto-blank-field'."
1738 :group 'org-table
1739 :type '(choice
1740 (const :tag "off" nil)
1741 (const :tag "on" t)
1742 (const :tag "on, optimized" optimized)))
1744 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1745 (version<= emacs-version "24.1"))
1746 "Non-nil means cluster self-insert commands for undo when possible.
1747 If this is set, then, like in the Emacs command loop, 20 consecutive
1748 characters will be undone together.
1749 This is configurable, because there is some impact on typing performance."
1750 :group 'org-table
1751 :type 'boolean)
1753 (defcustom org-table-tab-recognizes-table.el t
1754 "Non-nil means TAB will automatically notice a table.el table.
1755 When it sees such a table, it moves point into it and - if necessary -
1756 calls `table-recognize-table'."
1757 :group 'org-table-editing
1758 :type 'boolean)
1760 (defgroup org-link nil
1761 "Options concerning links in Org-mode."
1762 :tag "Org Link"
1763 :group 'org)
1765 (defvar org-link-abbrev-alist-local nil
1766 "Buffer-local version of `org-link-abbrev-alist', which see.
1767 The value of this is taken from the #+LINK lines.")
1768 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1770 (defcustom org-link-abbrev-alist nil
1771 "Alist of link abbreviations.
1772 The car of each element is a string, to be replaced at the start of a link.
1773 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1774 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1776 [[linkkey:tag][description]]
1778 The 'linkkey' must be a word word, starting with a letter, followed
1779 by letters, numbers, '-' or '_'.
1781 If REPLACE is a string, the tag will simply be appended to create the link.
1782 If the string contains \"%s\", the tag will be inserted there. If the string
1783 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1784 at that point (see the function `url-hexify-string'). If the string contains
1785 the specifier \"%(my-function)\", then the custom function `my-function' will
1786 be invoked: this function takes the tag as its only argument and must return
1787 a string.
1789 REPLACE may also be a function that will be called with the tag as the
1790 only argument to create the link, which should be returned as a string.
1792 See the manual for examples."
1793 :group 'org-link
1794 :type '(repeat
1795 (cons
1796 (string :tag "Protocol")
1797 (choice
1798 (string :tag "Format")
1799 (function)))))
1801 (defcustom org-descriptive-links t
1802 "Non-nil means Org will display descriptive links.
1803 E.g. [[http://orgmode.org][Org website]] will be displayed as
1804 \"Org Website\", hiding the link itself and just displaying its
1805 description. When set to `nil', Org will display the full links
1806 literally.
1808 You can interactively set the value of this variable by calling
1809 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1810 :group 'org-link
1811 :type 'boolean)
1813 (defcustom org-link-file-path-type 'adaptive
1814 "How the path name in file links should be stored.
1815 Valid values are:
1817 relative Relative to the current directory, i.e. the directory of the file
1818 into which the link is being inserted.
1819 absolute Absolute path, if possible with ~ for home directory.
1820 noabbrev Absolute path, no abbreviation of home directory.
1821 adaptive Use relative path for files in the current directory and sub-
1822 directories of it. For other files, use an absolute path."
1823 :group 'org-link
1824 :type '(choice
1825 (const relative)
1826 (const absolute)
1827 (const noabbrev)
1828 (const adaptive)))
1830 (defvaralias 'org-activate-links 'org-highlight-links)
1831 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1832 "Types of links that should be highlighted in Org-mode files.
1834 This is a list of symbols, each one of them leading to the
1835 highlighting of a certain link type.
1837 You can still open links that are not highlighted.
1839 In principle, it does not hurt to turn on highlighting for all
1840 link types. There may be a small gain when turning off unused
1841 link types. The types are:
1843 bracket The recommended [[link][description]] or [[link]] links with hiding.
1844 angle Links in angular brackets that may contain whitespace like
1845 <bbdb:Carsten Dominik>.
1846 plain Plain links in normal text, no whitespace, like http://google.com.
1847 radio Text that is matched by a radio target, see manual for details.
1848 tag Tag settings in a headline (link to tag search).
1849 date Time stamps (link to calendar).
1850 footnote Footnote labels.
1852 If you set this variable during an Emacs session, use `org-mode-restart'
1853 in the Org buffer so that the change takes effect."
1854 :group 'org-link
1855 :group 'org-appearance
1856 :type '(set :greedy t
1857 (const :tag "Double bracket links" bracket)
1858 (const :tag "Angular bracket links" angle)
1859 (const :tag "Plain text links" plain)
1860 (const :tag "Radio target matches" radio)
1861 (const :tag "Tags" tag)
1862 (const :tag "Timestamps" date)
1863 (const :tag "Footnotes" footnote)))
1865 (defcustom org-make-link-description-function nil
1866 "Function to use for generating link descriptions from links.
1867 When nil, the link location will be used. This function must take
1868 two parameters: the first one is the link, the second one is the
1869 description generated by `org-insert-link'. The function should
1870 return the description to use."
1871 :group 'org-link
1872 :type '(choice (const nil) (function)))
1874 (defgroup org-link-store nil
1875 "Options concerning storing links in Org-mode."
1876 :tag "Org Store Link"
1877 :group 'org-link)
1879 (defcustom org-url-hexify-p t
1880 "When non-nil, hexify URL when creating a link."
1881 :type 'boolean
1882 :version "24.3"
1883 :group 'org-link-store)
1885 (defcustom org-email-link-description-format "Email %c: %.30s"
1886 "Format of the description part of a link to an email or usenet message.
1887 The following %-escapes will be replaced by corresponding information:
1889 %F full \"From\" field
1890 %f name, taken from \"From\" field, address if no name
1891 %T full \"To\" field
1892 %t first name in \"To\" field, address if no name
1893 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1894 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1895 %s subject
1896 %d date
1897 %m message-id.
1899 You may use normal field width specification between the % and the letter.
1900 This is for example useful to limit the length of the subject.
1902 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1903 :group 'org-link-store
1904 :type 'string)
1906 (defcustom org-from-is-user-regexp
1907 (let (r1 r2)
1908 (when (and user-mail-address (not (string= user-mail-address "")))
1909 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1910 (when (and user-full-name (not (string= user-full-name "")))
1911 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1912 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1913 "Regexp matched against the \"From:\" header of an email or usenet message.
1914 It should match if the message is from the user him/herself."
1915 :group 'org-link-store
1916 :type 'regexp)
1918 (defcustom org-context-in-file-links t
1919 "Non-nil means file links from `org-store-link' contain context.
1920 A search string will be added to the file name with :: as separator and
1921 used to find the context when the link is activated by the command
1922 `org-open-at-point'. When this option is t, the entire active region
1923 will be placed in the search string of the file link. If set to a
1924 positive integer, only the first n lines of context will be stored.
1926 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1927 negates this setting for the duration of the command."
1928 :group 'org-link-store
1929 :type '(choice boolean integer))
1931 (defcustom org-keep-stored-link-after-insertion nil
1932 "Non-nil means keep link in list for entire session.
1934 The command `org-store-link' adds a link pointing to the current
1935 location to an internal list. These links accumulate during a session.
1936 The command `org-insert-link' can be used to insert links into any
1937 Org-mode file (offering completion for all stored links). When this
1938 option is nil, every link which has been inserted once using \\[org-insert-link]
1939 will be removed from the list, to make completing the unused links
1940 more efficient."
1941 :group 'org-link-store
1942 :type 'boolean)
1944 (defgroup org-link-follow nil
1945 "Options concerning following links in Org-mode."
1946 :tag "Org Follow Link"
1947 :group 'org-link)
1949 (defcustom org-link-translation-function nil
1950 "Function to translate links with different syntax to Org syntax.
1951 This can be used to translate links created for example by the Planner
1952 or emacs-wiki packages to Org syntax.
1953 The function must accept two parameters, a TYPE containing the link
1954 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1955 which is everything after the link protocol. It should return a cons
1956 with possibly modified values of type and path.
1957 Org contains a function for this, so if you set this variable to
1958 `org-translate-link-from-planner', you should be able follow many
1959 links created by planner."
1960 :group 'org-link-follow
1961 :type '(choice (const nil) (function)))
1963 (defcustom org-follow-link-hook nil
1964 "Hook that is run after a link has been followed."
1965 :group 'org-link-follow
1966 :type 'hook)
1968 (defcustom org-tab-follows-link nil
1969 "Non-nil means on links TAB will follow the link.
1970 Needs to be set before org.el is loaded.
1971 This really should not be used, it does not make sense, and the
1972 implementation is bad."
1973 :group 'org-link-follow
1974 :type 'boolean)
1976 (defcustom org-return-follows-link nil
1977 "Non-nil means on links RET will follow the link.
1978 In tables, the special behavior of RET has precedence."
1979 :group 'org-link-follow
1980 :type 'boolean)
1982 (defcustom org-mouse-1-follows-link
1983 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1984 "Non-nil means mouse-1 on a link will follow the link.
1985 A longer mouse click will still set point. Does not work on XEmacs.
1986 Needs to be set before org.el is loaded."
1987 :group 'org-link-follow
1988 :version "24.4"
1989 :package-version '(Org . "8.3")
1990 :type '(choice
1991 (const :tag "A double click follows the link" double)
1992 (const :tag "Unconditionally follow the link with mouse-1" t)
1993 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1995 (defcustom org-mark-ring-length 4
1996 "Number of different positions to be recorded in the ring.
1997 Changing this requires a restart of Emacs to work correctly."
1998 :group 'org-link-follow
1999 :type 'integer)
2001 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2002 "Non-nil means internal links in Org files must exactly match a headline.
2003 When nil, the link search tries to match a phrase with all words
2004 in the search text."
2005 :group 'org-link-follow
2006 :version "24.1"
2007 :type '(choice
2008 (const :tag "Use fuzzy text search" nil)
2009 (const :tag "Match only exact headline" t)
2010 (const :tag "Match exact headline or query to create it"
2011 query-to-create)))
2013 (defcustom org-link-frame-setup
2014 '((vm . vm-visit-folder-other-frame)
2015 (vm-imap . vm-visit-imap-folder-other-frame)
2016 (gnus . org-gnus-no-new-news)
2017 (file . find-file-other-window)
2018 (wl . wl-other-frame))
2019 "Setup the frame configuration for following links.
2020 When following a link with Emacs, it may often be useful to display
2021 this link in another window or frame. This variable can be used to
2022 set this up for the different types of links.
2023 For VM, use any of
2024 `vm-visit-folder'
2025 `vm-visit-folder-other-window'
2026 `vm-visit-folder-other-frame'
2027 For Gnus, use any of
2028 `gnus'
2029 `gnus-other-frame'
2030 `org-gnus-no-new-news'
2031 For FILE, use any of
2032 `find-file'
2033 `find-file-other-window'
2034 `find-file-other-frame'
2035 For Wanderlust use any of
2036 `wl'
2037 `wl-other-frame'
2038 For the calendar, use the variable `calendar-setup'.
2039 For BBDB, it is currently only possible to display the matches in
2040 another window."
2041 :group 'org-link-follow
2042 :type '(list
2043 (cons (const vm)
2044 (choice
2045 (const vm-visit-folder)
2046 (const vm-visit-folder-other-window)
2047 (const vm-visit-folder-other-frame)))
2048 (cons (const vm-imap)
2049 (choice
2050 (const vm-visit-imap-folder)
2051 (const vm-visit-imap-folder-other-window)
2052 (const vm-visit-imap-folder-other-frame)))
2053 (cons (const gnus)
2054 (choice
2055 (const gnus)
2056 (const gnus-other-frame)
2057 (const org-gnus-no-new-news)))
2058 (cons (const file)
2059 (choice
2060 (const find-file)
2061 (const find-file-other-window)
2062 (const find-file-other-frame)))
2063 (cons (const wl)
2064 (choice
2065 (const wl)
2066 (const wl-other-frame)))))
2068 (defcustom org-display-internal-link-with-indirect-buffer nil
2069 "Non-nil means use indirect buffer to display infile links.
2070 Activating internal links (from one location in a file to another location
2071 in the same file) normally just jumps to the location. When the link is
2072 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2073 is displayed in
2074 another window. When this option is set, the other window actually displays
2075 an indirect buffer clone of the current buffer, to avoid any visibility
2076 changes to the current buffer."
2077 :group 'org-link-follow
2078 :type 'boolean)
2080 (defcustom org-open-non-existing-files nil
2081 "Non-nil means `org-open-file' will open non-existing files.
2082 When nil, an error will be generated.
2083 This variable applies only to external applications because they
2084 might choke on non-existing files. If the link is to a file that
2085 will be opened in Emacs, the variable is ignored."
2086 :group 'org-link-follow
2087 :type 'boolean)
2089 (defcustom org-open-directory-means-index-dot-org nil
2090 "Non-nil means a link to a directory really means to index.org.
2091 When nil, following a directory link will run dired or open a finder/explorer
2092 window on that directory."
2093 :group 'org-link-follow
2094 :type 'boolean)
2096 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2097 "Non-nil means ask for confirmation before executing shell links.
2098 Shell links can be dangerous: just think about a link
2100 [[shell:rm -rf ~/*][Google Search]]
2102 This link would show up in your Org-mode document as \"Google Search\",
2103 but really it would remove your entire home directory.
2104 Therefore we advise against setting this variable to nil.
2105 Just change it to `y-or-n-p' if you want to confirm with a
2106 single keystroke rather than having to type \"yes\"."
2107 :group 'org-link-follow
2108 :type '(choice
2109 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2110 (const :tag "with y-or-n (faster)" y-or-n-p)
2111 (const :tag "no confirmation (dangerous)" nil)))
2112 (put 'org-confirm-shell-link-function
2113 'safe-local-variable
2114 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2116 (defcustom org-confirm-shell-link-not-regexp ""
2117 "A regexp to skip confirmation for shell links."
2118 :group 'org-link-follow
2119 :version "24.1"
2120 :type 'regexp)
2122 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2123 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2124 Elisp links can be dangerous: just think about a link
2126 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2128 This link would show up in your Org-mode document as \"Google Search\",
2129 but really it would remove your entire home directory.
2130 Therefore we advise against setting this variable to nil.
2131 Just change it to `y-or-n-p' if you want to confirm with a
2132 single keystroke rather than having to type \"yes\"."
2133 :group 'org-link-follow
2134 :type '(choice
2135 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2136 (const :tag "with y-or-n (faster)" y-or-n-p)
2137 (const :tag "no confirmation (dangerous)" nil)))
2138 (put 'org-confirm-shell-link-function
2139 'safe-local-variable
2140 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2142 (defcustom org-confirm-elisp-link-not-regexp ""
2143 "A regexp to skip confirmation for Elisp links."
2144 :group 'org-link-follow
2145 :version "24.1"
2146 :type 'regexp)
2148 (defconst org-file-apps-defaults-gnu
2149 '((remote . emacs)
2150 (system . mailcap)
2151 (t . mailcap))
2152 "Default file applications on a UNIX or GNU/Linux system.
2153 See `org-file-apps'.")
2155 (defconst org-file-apps-defaults-macosx
2156 '((remote . emacs)
2157 (t . "open %s")
2158 (system . "open %s")
2159 ("ps.gz" . "gv %s")
2160 ("eps.gz" . "gv %s")
2161 ("dvi" . "xdvi %s")
2162 ("fig" . "xfig %s"))
2163 "Default file applications on a MacOS X system.
2164 The system \"open\" is known as a default, but we use X11 applications
2165 for some files for which the OS does not have a good default.
2166 See `org-file-apps'.")
2168 (defconst org-file-apps-defaults-windowsnt
2169 (list
2170 '(remote . emacs)
2171 (cons t
2172 (list (if (featurep 'xemacs)
2173 'mswindows-shell-execute
2174 'w32-shell-execute)
2175 "open" 'file))
2176 (cons 'system
2177 (list (if (featurep 'xemacs)
2178 'mswindows-shell-execute
2179 'w32-shell-execute)
2180 "open" 'file)))
2181 "Default file applications on a Windows NT system.
2182 The system \"open\" is used for most files.
2183 See `org-file-apps'.")
2185 (defcustom org-file-apps
2186 '((auto-mode . emacs)
2187 ("\\.mm\\'" . default)
2188 ("\\.x?html?\\'" . default)
2189 ("\\.pdf\\'" . default))
2190 "External applications for opening `file:path' items in a document.
2191 Org-mode uses system defaults for different file types, but
2192 you can use this variable to set the application for a given file
2193 extension. The entries in this list are cons cells where the car identifies
2194 files and the cdr the corresponding command. Possible values for the
2195 file identifier are
2196 \"string\" A string as a file identifier can be interpreted in different
2197 ways, depending on its contents:
2199 - Alphanumeric characters only:
2200 Match links with this file extension.
2201 Example: (\"pdf\" . \"evince %s\")
2202 to open PDFs with evince.
2204 - Regular expression: Match links where the
2205 filename matches the regexp. If you want to
2206 use groups here, use shy groups.
2208 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2209 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2210 to open *.html and *.xhtml with firefox.
2212 - Regular expression which contains (non-shy) groups:
2213 Match links where the whole link, including \"::\", and
2214 anything after that, matches the regexp.
2215 In a custom command string, %1, %2, etc. are replaced with
2216 the parts of the link that were matched by the groups.
2217 For backwards compatibility, if a command string is given
2218 that does not use any of the group matches, this case is
2219 handled identically to the second one (i.e. match against
2220 file name only).
2221 In a custom lisp form, you can access the group matches with
2222 (match-string n link).
2224 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2225 to open [[file:document.pdf::5]] with evince at page 5.
2227 `directory' Matches a directory
2228 `remote' Matches a remote file, accessible through tramp or efs.
2229 Remote files most likely should be visited through Emacs
2230 because external applications cannot handle such paths.
2231 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2232 so all files Emacs knows how to handle. Using this with
2233 command `emacs' will open most files in Emacs. Beware that this
2234 will also open html files inside Emacs, unless you add
2235 (\"html\" . default) to the list as well.
2236 t Default for files not matched by any of the other options.
2237 `system' The system command to open files, like `open' on Windows
2238 and Mac OS X, and mailcap under GNU/Linux. This is the command
2239 that will be selected if you call `C-c C-o' with a double
2240 \\[universal-argument] \\[universal-argument] prefix.
2242 Possible values for the command are:
2243 `emacs' The file will be visited by the current Emacs process.
2244 `default' Use the default application for this file type, which is the
2245 association for t in the list, most likely in the system-specific
2246 part.
2247 This can be used to overrule an unwanted setting in the
2248 system-specific variable.
2249 `system' Use the system command for opening files, like \"open\".
2250 This command is specified by the entry whose car is `system'.
2251 Most likely, the system-specific version of this variable
2252 does define this command, but you can overrule/replace it
2253 here.
2254 string A command to be executed by a shell; %s will be replaced
2255 by the path to the file.
2256 sexp A Lisp form which will be evaluated. The file path will
2257 be available in the Lisp variable `file'.
2258 For more examples, see the system specific constants
2259 `org-file-apps-defaults-macosx'
2260 `org-file-apps-defaults-windowsnt'
2261 `org-file-apps-defaults-gnu'."
2262 :group 'org-link-follow
2263 :type '(repeat
2264 (cons (choice :value ""
2265 (string :tag "Extension")
2266 (const :tag "System command to open files" system)
2267 (const :tag "Default for unrecognized files" t)
2268 (const :tag "Remote file" remote)
2269 (const :tag "Links to a directory" directory)
2270 (const :tag "Any files that have Emacs modes"
2271 auto-mode))
2272 (choice :value ""
2273 (const :tag "Visit with Emacs" emacs)
2274 (const :tag "Use default" default)
2275 (const :tag "Use the system command" system)
2276 (string :tag "Command")
2277 (sexp :tag "Lisp form")))))
2279 (defcustom org-doi-server-url "http://dx.doi.org/"
2280 "The URL of the DOI server."
2281 :type 'string
2282 :version "24.3"
2283 :group 'org-link-follow)
2285 (defgroup org-refile nil
2286 "Options concerning refiling entries in Org-mode."
2287 :tag "Org Refile"
2288 :group 'org)
2290 (defcustom org-directory "~/org"
2291 "Directory with org files.
2292 This is just a default location to look for Org files. There is no need
2293 at all to put your files into this directory. It is only used in the
2294 following situations:
2296 1. When a capture template specifies a target file that is not an
2297 absolute path. The path will then be interpreted relative to
2298 `org-directory'
2299 2. When a capture note is filed away in an interactive way (when exiting the
2300 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2301 with `org-directory' as the default path."
2302 :group 'org-refile
2303 :group 'org-capture
2304 :type 'directory)
2306 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2307 "Default target for storing notes.
2308 Used as a fall back file for org-capture.el, for templates that
2309 do not specify a target file."
2310 :group 'org-refile
2311 :group 'org-capture
2312 :type 'file)
2314 (defcustom org-goto-interface 'outline
2315 "The default interface to be used for `org-goto'.
2316 Allowed values are:
2317 outline The interface shows an outline of the relevant file
2318 and the correct heading is found by moving through
2319 the outline or by searching with incremental search.
2320 outline-path-completion Headlines in the current buffer are offered via
2321 completion. This is the interface also used by
2322 the refile command."
2323 :group 'org-refile
2324 :type '(choice
2325 (const :tag "Outline" outline)
2326 (const :tag "Outline-path-completion" outline-path-completion)))
2328 (defcustom org-goto-max-level 5
2329 "Maximum target level when running `org-goto' with refile interface."
2330 :group 'org-refile
2331 :type 'integer)
2333 (defcustom org-reverse-note-order nil
2334 "Non-nil means store new notes at the beginning of a file or entry.
2335 When nil, new notes will be filed to the end of a file or entry.
2336 This can also be a list with cons cells of regular expressions that
2337 are matched against file names, and values."
2338 :group 'org-capture
2339 :group 'org-refile
2340 :type '(choice
2341 (const :tag "Reverse always" t)
2342 (const :tag "Reverse never" nil)
2343 (repeat :tag "By file name regexp"
2344 (cons regexp boolean))))
2346 (defcustom org-log-refile nil
2347 "Information to record when a task is refiled.
2349 Possible values are:
2351 nil Don't add anything
2352 time Add a time stamp to the task
2353 note Prompt for a note and add it with template `org-log-note-headings'
2355 This option can also be set with on a per-file-basis with
2357 #+STARTUP: nologrefile
2358 #+STARTUP: logrefile
2359 #+STARTUP: lognoterefile
2361 You can have local logging settings for a subtree by setting the LOGGING
2362 property to one or more of these keywords.
2364 When bulk-refiling from the agenda, the value `note' is forbidden and
2365 will temporarily be changed to `time'."
2366 :group 'org-refile
2367 :group 'org-progress
2368 :version "24.1"
2369 :type '(choice
2370 (const :tag "No logging" nil)
2371 (const :tag "Record timestamp" time)
2372 (const :tag "Record timestamp with note." note)))
2374 (defcustom org-refile-targets nil
2375 "Targets for refiling entries with \\[org-refile].
2376 This is a list of cons cells. Each cell contains:
2377 - a specification of the files to be considered, either a list of files,
2378 or a symbol whose function or variable value will be used to retrieve
2379 a file name or a list of file names. If you use `org-agenda-files' for
2380 that, all agenda files will be scanned for targets. Nil means consider
2381 headings in the current buffer.
2382 - A specification of how to find candidate refile targets. This may be
2383 any of:
2384 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2385 This tag has to be present in all target headlines, inheritance will
2386 not be considered.
2387 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2388 todo keyword.
2389 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2390 headlines that are refiling targets.
2391 - a cons cell (:level . N). Any headline of level N is considered a target.
2392 Note that, when `org-odd-levels-only' is set, level corresponds to
2393 order in hierarchy, not to the number of stars.
2394 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2395 Note that, when `org-odd-levels-only' is set, level corresponds to
2396 order in hierarchy, not to the number of stars.
2398 Each element of this list generates a set of possible targets.
2399 The union of these sets is presented (with completion) to
2400 the user by `org-refile'.
2402 You can set the variable `org-refile-target-verify-function' to a function
2403 to verify each headline found by the simple criteria above.
2405 When this variable is nil, all top-level headlines in the current buffer
2406 are used, equivalent to the value `((nil . (:level . 1))'."
2407 :group 'org-refile
2408 :type '(repeat
2409 (cons
2410 (choice :value org-agenda-files
2411 (const :tag "All agenda files" org-agenda-files)
2412 (const :tag "Current buffer" nil)
2413 (function) (variable) (file))
2414 (choice :tag "Identify target headline by"
2415 (cons :tag "Specific tag" (const :value :tag) (string))
2416 (cons :tag "TODO keyword" (const :value :todo) (string))
2417 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2418 (cons :tag "Level number" (const :value :level) (integer))
2419 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2421 (defcustom org-refile-target-verify-function nil
2422 "Function to verify if the headline at point should be a refile target.
2423 The function will be called without arguments, with point at the
2424 beginning of the headline. It should return t and leave point
2425 where it is if the headline is a valid target for refiling.
2427 If the target should not be selected, the function must return nil.
2428 In addition to this, it may move point to a place from where the search
2429 should be continued. For example, the function may decide that the entire
2430 subtree of the current entry should be excluded and move point to the end
2431 of the subtree."
2432 :group 'org-refile
2433 :type '(choice
2434 (const nil)
2435 (function)))
2437 (defcustom org-refile-use-cache nil
2438 "Non-nil means cache refile targets to speed up the process.
2439 The cache for a particular file will be updated automatically when
2440 the buffer has been killed, or when any of the marker used for flagging
2441 refile targets no longer points at a live buffer.
2442 If you have added new entries to a buffer that might themselves be targets,
2443 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2444 find that easier, `C-u C-u C-u C-c C-w'."
2445 :group 'org-refile
2446 :version "24.1"
2447 :type 'boolean)
2449 (defcustom org-refile-use-outline-path nil
2450 "Non-nil means provide refile targets as paths.
2451 So a level 3 headline will be available as level1/level2/level3.
2453 When the value is `file', also include the file name (without directory)
2454 into the path. In this case, you can also stop the completion after
2455 the file name, to get entries inserted as top level in the file.
2457 When `full-file-path', include the full file path."
2458 :group 'org-refile
2459 :type '(choice
2460 (const :tag "Not" nil)
2461 (const :tag "Yes" t)
2462 (const :tag "Start with file name" file)
2463 (const :tag "Start with full file path" full-file-path)))
2465 (defcustom org-outline-path-complete-in-steps t
2466 "Non-nil means complete the outline path in hierarchical steps.
2467 When Org-mode uses the refile interface to select an outline path
2468 \(see variable `org-refile-use-outline-path'), the completion of
2469 the path can be done in a single go, or it can be done in steps down
2470 the headline hierarchy. Going in steps is probably the best if you
2471 do not use a special completion package like `ido' or `icicles'.
2472 However, when using these packages, going in one step can be very
2473 fast, while still showing the whole path to the entry."
2474 :group 'org-refile
2475 :type 'boolean)
2477 (defcustom org-refile-allow-creating-parent-nodes nil
2478 "Non-nil means allow to create new nodes as refile targets.
2479 New nodes are then created by adding \"/new node name\" to the completion
2480 of an existing node. When the value of this variable is `confirm',
2481 new node creation must be confirmed by the user (recommended).
2482 When nil, the completion must match an existing entry.
2484 Note that, if the new heading is not seen by the criteria
2485 listed in `org-refile-targets', multiple instances of the same
2486 heading would be created by trying again to file under the new
2487 heading."
2488 :group 'org-refile
2489 :type '(choice
2490 (const :tag "Never" nil)
2491 (const :tag "Always" t)
2492 (const :tag "Prompt for confirmation" confirm)))
2494 (defcustom org-refile-active-region-within-subtree nil
2495 "Non-nil means also refile active region within a subtree.
2497 By default `org-refile' doesn't allow refiling regions if they
2498 don't contain a set of subtrees, but it might be convenient to
2499 do so sometimes: in that case, the first line of the region is
2500 converted to a headline before refiling."
2501 :group 'org-refile
2502 :version "24.1"
2503 :type 'boolean)
2505 (defgroup org-todo nil
2506 "Options concerning TODO items in Org-mode."
2507 :tag "Org TODO"
2508 :group 'org)
2510 (defgroup org-progress nil
2511 "Options concerning Progress logging in Org-mode."
2512 :tag "Org Progress"
2513 :group 'org-time)
2515 (defvar org-todo-interpretation-widgets
2516 '((:tag "Sequence (cycling hits every state)" sequence)
2517 (:tag "Type (cycling directly to DONE)" type))
2518 "The available interpretation symbols for customizing `org-todo-keywords'.
2519 Interested libraries should add to this list.")
2521 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2522 "List of TODO entry keyword sequences and their interpretation.
2523 \\<org-mode-map>This is a list of sequences.
2525 Each sequence starts with a symbol, either `sequence' or `type',
2526 indicating if the keywords should be interpreted as a sequence of
2527 action steps, or as different types of TODO items. The first
2528 keywords are states requiring action - these states will select a headline
2529 for inclusion into the global TODO list Org-mode produces. If one of
2530 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2531 signify that no further action is necessary. If \"|\" is not found,
2532 the last keyword is treated as the only DONE state of the sequence.
2534 The command \\[org-todo] cycles an entry through these states, and one
2535 additional state where no keyword is present. For details about this
2536 cycling, see the manual.
2538 TODO keywords and interpretation can also be set on a per-file basis with
2539 the special #+SEQ_TODO and #+TYP_TODO lines.
2541 Each keyword can optionally specify a character for fast state selection
2542 \(in combination with the variable `org-use-fast-todo-selection')
2543 and specifiers for state change logging, using the same syntax that
2544 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2545 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2546 indicates to record a time stamp each time this state is selected.
2548 Each keyword may also specify if a timestamp or a note should be
2549 recorded when entering or leaving the state, by adding additional
2550 characters in the parenthesis after the keyword. This looks like this:
2551 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2552 record only the time of the state change. With X and Y being either
2553 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2554 Y when leaving the state if and only if the *target* state does not
2555 define X. You may omit any of the fast-selection key or X or /Y,
2556 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2558 For backward compatibility, this variable may also be just a list
2559 of keywords. In this case the interpretation (sequence or type) will be
2560 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2561 :group 'org-todo
2562 :group 'org-keywords
2563 :type '(choice
2564 (repeat :tag "Old syntax, just keywords"
2565 (string :tag "Keyword"))
2566 (repeat :tag "New syntax"
2567 (cons
2568 (choice
2569 :tag "Interpretation"
2570 ;;Quick and dirty way to see
2571 ;;`org-todo-interpretations'. This takes the
2572 ;;place of item arguments
2573 :convert-widget
2574 (lambda (widget)
2575 (widget-put widget
2576 :args (mapcar
2577 (lambda (x)
2578 (widget-convert
2579 (cons 'const x)))
2580 org-todo-interpretation-widgets))
2581 widget))
2582 (repeat
2583 (string :tag "Keyword"))))))
2585 (defvar org-todo-keywords-1 nil
2586 "All TODO and DONE keywords active in a buffer.")
2587 (make-variable-buffer-local 'org-todo-keywords-1)
2588 (defvar org-todo-keywords-for-agenda nil)
2589 (defvar org-done-keywords-for-agenda nil)
2590 (defvar org-todo-keyword-alist-for-agenda nil)
2591 (defvar org-tag-alist-for-agenda nil
2592 "Alist of all tags from all agenda files.")
2593 (defvar org-tag-groups-alist-for-agenda nil
2594 "Alist of all groups tags from all current agenda files.")
2595 (defvar org-tag-groups-alist nil)
2596 (make-variable-buffer-local 'org-tag-groups-alist)
2597 (defvar org-agenda-contributing-files nil)
2598 (defvar org-not-done-keywords nil)
2599 (make-variable-buffer-local 'org-not-done-keywords)
2600 (defvar org-done-keywords nil)
2601 (make-variable-buffer-local 'org-done-keywords)
2602 (defvar org-todo-heads nil)
2603 (make-variable-buffer-local 'org-todo-heads)
2604 (defvar org-todo-sets nil)
2605 (make-variable-buffer-local 'org-todo-sets)
2606 (defvar org-todo-log-states nil)
2607 (make-variable-buffer-local 'org-todo-log-states)
2608 (defvar org-todo-kwd-alist nil)
2609 (make-variable-buffer-local 'org-todo-kwd-alist)
2610 (defvar org-todo-key-alist nil)
2611 (make-variable-buffer-local 'org-todo-key-alist)
2612 (defvar org-todo-key-trigger nil)
2613 (make-variable-buffer-local 'org-todo-key-trigger)
2615 (defcustom org-todo-interpretation 'sequence
2616 "Controls how TODO keywords are interpreted.
2617 This variable is in principle obsolete and is only used for
2618 backward compatibility, if the interpretation of todo keywords is
2619 not given already in `org-todo-keywords'. See that variable for
2620 more information."
2621 :group 'org-todo
2622 :group 'org-keywords
2623 :type '(choice (const sequence)
2624 (const type)))
2626 (defcustom org-use-fast-todo-selection t
2627 "Non-nil means use the fast todo selection scheme with C-c C-t.
2628 This variable describes if and under what circumstances the cycling
2629 mechanism for TODO keywords will be replaced by a single-key, direct
2630 selection scheme.
2632 When nil, fast selection is never used.
2634 When the symbol `prefix', it will be used when `org-todo' is called
2635 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2636 `C-u t' in an agenda buffer.
2638 When t, fast selection is used by default. In this case, the prefix
2639 argument forces cycling instead.
2641 In all cases, the special interface is only used if access keys have
2642 actually been assigned by the user, i.e. if keywords in the configuration
2643 are followed by a letter in parenthesis, like TODO(t)."
2644 :group 'org-todo
2645 :type '(choice
2646 (const :tag "Never" nil)
2647 (const :tag "By default" t)
2648 (const :tag "Only with C-u C-c C-t" prefix)))
2650 (defcustom org-provide-todo-statistics t
2651 "Non-nil means update todo statistics after insert and toggle.
2652 ALL-HEADLINES means update todo statistics by including headlines
2653 with no TODO keyword as well, counting them as not done.
2654 A list of TODO keywords means the same, but skip keywords that are
2655 not in this list.
2656 When set to a list of two lists, the first list contains keywords
2657 to consider as TODO keywords, the second list contains keywords
2658 to consider as DONE keywords.
2660 When this is set, todo statistics is updated in the parent of the
2661 current entry each time a todo state is changed."
2662 :group 'org-todo
2663 :type '(choice
2664 (const :tag "Yes, only for TODO entries" t)
2665 (const :tag "Yes, including all entries" all-headlines)
2666 (repeat :tag "Yes, for TODOs in this list"
2667 (string :tag "TODO keyword"))
2668 (list :tag "Yes, for TODOs and DONEs in these lists"
2669 (repeat (string :tag "TODO keyword"))
2670 (repeat (string :tag "DONE keyword")))
2671 (other :tag "No TODO statistics" nil)))
2673 (defcustom org-hierarchical-todo-statistics t
2674 "Non-nil means TODO statistics covers just direct children.
2675 When nil, all entries in the subtree are considered.
2676 This has only an effect if `org-provide-todo-statistics' is set.
2677 To set this to nil for only a single subtree, use a COOKIE_DATA
2678 property and include the word \"recursive\" into the value."
2679 :group 'org-todo
2680 :type 'boolean)
2682 (defcustom org-after-todo-state-change-hook nil
2683 "Hook which is run after the state of a TODO item was changed.
2684 The new state (a string with a TODO keyword, or nil) is available in the
2685 Lisp variable `org-state'."
2686 :group 'org-todo
2687 :type 'hook)
2689 (defvar org-blocker-hook nil
2690 "Hook for functions that are allowed to block a state change.
2692 Functions in this hook should not modify the buffer.
2693 Each function gets as its single argument a property list,
2694 see `org-trigger-hook' for more information about this list.
2696 If any of the functions in this hook returns nil, the state change
2697 is blocked.")
2699 (defvar org-trigger-hook nil
2700 "Hook for functions that are triggered by a state change.
2702 Each function gets as its single argument a property list with at
2703 least the following elements:
2705 (:type type-of-change :position pos-at-entry-start
2706 :from old-state :to new-state)
2708 Depending on the type, more properties may be present.
2710 This mechanism is currently implemented for:
2712 TODO state changes
2713 ------------------
2714 :type todo-state-change
2715 :from previous state (keyword as a string), or nil, or a symbol
2716 'todo' or 'done', to indicate the general type of state.
2717 :to new state, like in :from")
2719 (defcustom org-enforce-todo-dependencies nil
2720 "Non-nil means undone TODO entries will block switching the parent to DONE.
2721 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2722 be blocked if any prior sibling is not yet done.
2723 Finally, if the parent is blocked because of ordered siblings of its own,
2724 the child will also be blocked."
2725 :set (lambda (var val)
2726 (set var val)
2727 (if val
2728 (add-hook 'org-blocker-hook
2729 'org-block-todo-from-children-or-siblings-or-parent)
2730 (remove-hook 'org-blocker-hook
2731 'org-block-todo-from-children-or-siblings-or-parent)))
2732 :group 'org-todo
2733 :type 'boolean)
2735 (defcustom org-enforce-todo-checkbox-dependencies nil
2736 "Non-nil means unchecked boxes will block switching the parent to DONE.
2737 When this is nil, checkboxes have no influence on switching TODO states.
2738 When non-nil, you first need to check off all check boxes before the TODO
2739 entry can be switched to DONE.
2740 This variable needs to be set before org.el is loaded, and you need to
2741 restart Emacs after a change to make the change effective. The only way
2742 to change is while Emacs is running is through the customize interface."
2743 :set (lambda (var val)
2744 (set var val)
2745 (if val
2746 (add-hook 'org-blocker-hook
2747 'org-block-todo-from-checkboxes)
2748 (remove-hook 'org-blocker-hook
2749 'org-block-todo-from-checkboxes)))
2750 :group 'org-todo
2751 :type 'boolean)
2753 (defcustom org-treat-insert-todo-heading-as-state-change nil
2754 "Non-nil means inserting a TODO heading is treated as state change.
2755 So when the command \\[org-insert-todo-heading] is used, state change
2756 logging will apply if appropriate. When nil, the new TODO item will
2757 be inserted directly, and no logging will take place."
2758 :group 'org-todo
2759 :type 'boolean)
2761 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2762 "Non-nil means switching TODO states with S-cursor counts as state change.
2763 This is the default behavior. However, setting this to nil allows a
2764 convenient way to select a TODO state and bypass any logging associated
2765 with that."
2766 :group 'org-todo
2767 :type 'boolean)
2769 (defcustom org-todo-state-tags-triggers nil
2770 "Tag changes that should be triggered by TODO state changes.
2771 This is a list. Each entry is
2773 (state-change (tag . flag) .......)
2775 State-change can be a string with a state, and empty string to indicate the
2776 state that has no TODO keyword, or it can be one of the symbols `todo'
2777 or `done', meaning any not-done or done state, respectively."
2778 :group 'org-todo
2779 :group 'org-tags
2780 :type '(repeat
2781 (cons (choice :tag "When changing to"
2782 (const :tag "Not-done state" todo)
2783 (const :tag "Done state" done)
2784 (string :tag "State"))
2785 (repeat
2786 (cons :tag "Tag action"
2787 (string :tag "Tag")
2788 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2790 (defcustom org-log-done nil
2791 "Information to record when a task moves to the DONE state.
2793 Possible values are:
2795 nil Don't add anything, just change the keyword
2796 time Add a time stamp to the task
2797 note Prompt for a note and add it with template `org-log-note-headings'
2799 This option can also be set with on a per-file-basis with
2801 #+STARTUP: nologdone
2802 #+STARTUP: logdone
2803 #+STARTUP: lognotedone
2805 You can have local logging settings for a subtree by setting the LOGGING
2806 property to one or more of these keywords."
2807 :group 'org-todo
2808 :group 'org-progress
2809 :type '(choice
2810 (const :tag "No logging" nil)
2811 (const :tag "Record CLOSED timestamp" time)
2812 (const :tag "Record CLOSED timestamp with note." note)))
2814 ;; Normalize old uses of org-log-done.
2815 (cond
2816 ((eq org-log-done t) (setq org-log-done 'time))
2817 ((and (listp org-log-done) (memq 'done org-log-done))
2818 (setq org-log-done 'note)))
2820 (defcustom org-log-reschedule nil
2821 "Information to record when the scheduling date of a tasks is modified.
2823 Possible values are:
2825 nil Don't add anything, just change the date
2826 time Add a time stamp to the task
2827 note Prompt for a note and add it with template `org-log-note-headings'
2829 This option can also be set with on a per-file-basis with
2831 #+STARTUP: nologreschedule
2832 #+STARTUP: logreschedule
2833 #+STARTUP: lognotereschedule"
2834 :group 'org-todo
2835 :group 'org-progress
2836 :type '(choice
2837 (const :tag "No logging" nil)
2838 (const :tag "Record timestamp" time)
2839 (const :tag "Record timestamp with note." note)))
2841 (defcustom org-log-redeadline nil
2842 "Information to record when the deadline date of a tasks is modified.
2844 Possible values are:
2846 nil Don't add anything, just change the date
2847 time Add a time stamp to the task
2848 note Prompt for a note and add it with template `org-log-note-headings'
2850 This option can also be set with on a per-file-basis with
2852 #+STARTUP: nologredeadline
2853 #+STARTUP: logredeadline
2854 #+STARTUP: lognoteredeadline
2856 You can have local logging settings for a subtree by setting the LOGGING
2857 property to one or more of these keywords."
2858 :group 'org-todo
2859 :group 'org-progress
2860 :type '(choice
2861 (const :tag "No logging" nil)
2862 (const :tag "Record timestamp" time)
2863 (const :tag "Record timestamp with note." note)))
2865 (defcustom org-log-note-clock-out nil
2866 "Non-nil means record a note when clocking out of an item.
2867 This can also be configured on a per-file basis by adding one of
2868 the following lines anywhere in the buffer:
2870 #+STARTUP: lognoteclock-out
2871 #+STARTUP: nolognoteclock-out"
2872 :group 'org-todo
2873 :group 'org-progress
2874 :type 'boolean)
2876 (defcustom org-log-done-with-time t
2877 "Non-nil means the CLOSED time stamp will contain date and time.
2878 When nil, only the date will be recorded."
2879 :group 'org-progress
2880 :type 'boolean)
2882 (defcustom org-log-note-headings
2883 '((done . "CLOSING NOTE %t")
2884 (state . "State %-12s from %-12S %t")
2885 (note . "Note taken on %t")
2886 (reschedule . "Rescheduled from %S on %t")
2887 (delschedule . "Not scheduled, was %S on %t")
2888 (redeadline . "New deadline from %S on %t")
2889 (deldeadline . "Removed deadline, was %S on %t")
2890 (refile . "Refiled on %t")
2891 (clock-out . ""))
2892 "Headings for notes added to entries.
2894 The value is an alist, with the car being a symbol indicating the
2895 note context, and the cdr is the heading to be used. The heading
2896 may also be the empty string. The following placeholders can be
2897 used:
2899 %t a time stamp.
2900 %T an active time stamp instead the default inactive one
2901 %d a short-format time stamp.
2902 %D an active short-format time stamp.
2903 %s the new TODO state or time stamp (inactive), in double quotes.
2904 %S the old TODO state or time stamp (inactive), in double quotes.
2905 %u the user name.
2906 %U full user name.
2908 In fact, it is not a good idea to change the `state' entry,
2909 because Agenda Log mode depends on the format of these entries."
2910 :group 'org-todo
2911 :group 'org-progress
2912 :type '(list :greedy t
2913 (cons (const :tag "Heading when closing an item" done) string)
2914 (cons (const :tag
2915 "Heading when changing todo state (todo sequence only)"
2916 state) string)
2917 (cons (const :tag "Heading when just taking a note" note) string)
2918 (cons (const :tag "Heading when rescheduling" reschedule) string)
2919 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2920 (cons (const :tag "Heading when changing deadline" redeadline) string)
2921 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2922 (cons (const :tag "Heading when refiling" refile) string)
2923 (cons (const :tag "Heading when clocking out" clock-out) string)))
2925 (unless (assq 'note org-log-note-headings)
2926 (push '(note . "%t") org-log-note-headings))
2928 (defcustom org-log-into-drawer nil
2929 "Non-nil means insert state change notes and time stamps into a drawer.
2930 When nil, state changes notes will be inserted after the headline and
2931 any scheduling and clock lines, but not inside a drawer.
2933 The value of this variable should be the name of the drawer to use.
2934 LOGBOOK is proposed as the default drawer for this purpose, you can
2935 also set this to a string to define the drawer of your choice.
2937 A value of t is also allowed, representing \"LOGBOOK\".
2939 A value of t or nil can also be set with on a per-file-basis with
2941 #+STARTUP: logdrawer
2942 #+STARTUP: nologdrawer
2944 If this variable is set, `org-log-state-notes-insert-after-drawers'
2945 will be ignored.
2947 You can set the property LOG_INTO_DRAWER to overrule this setting for
2948 a subtree.
2950 Do not check directly this variable in a Lisp program. Call
2951 function `org-log-into-drawer' instead."
2952 :group 'org-todo
2953 :group 'org-progress
2954 :type '(choice
2955 (const :tag "Not into a drawer" nil)
2956 (const :tag "LOGBOOK" t)
2957 (string :tag "Other")))
2959 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2961 (defun org-log-into-drawer ()
2962 "Name of the log drawer, as a string, or nil.
2963 This is the value of `org-log-into-drawer'. However, if the
2964 current entry has or inherits a LOG_INTO_DRAWER property, it will
2965 be used instead of the default value."
2966 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2967 (cond ((equal p "nil") nil)
2968 ((equal p "t") "LOGBOOK")
2969 ((stringp p) p)
2970 (p "LOGBOOK")
2971 ((stringp org-log-into-drawer) org-log-into-drawer)
2972 (org-log-into-drawer "LOGBOOK"))))
2974 (defcustom org-log-state-notes-insert-after-drawers nil
2975 "Non-nil means insert state change notes after any drawers in entry.
2976 Only the drawers that *immediately* follow the headline and the
2977 deadline/scheduled line are skipped.
2978 When nil, insert notes right after the heading and perhaps the line
2979 with deadline/scheduling if present.
2981 This variable will have no effect if `org-log-into-drawer' is
2982 set."
2983 :group 'org-todo
2984 :group 'org-progress
2985 :type 'boolean)
2987 (defcustom org-log-states-order-reversed t
2988 "Non-nil means the latest state note will be directly after heading.
2989 When nil, the state change notes will be ordered according to time.
2991 This option can also be set with on a per-file-basis with
2993 #+STARTUP: logstatesreversed
2994 #+STARTUP: nologstatesreversed"
2995 :group 'org-todo
2996 :group 'org-progress
2997 :type 'boolean)
2999 (defcustom org-todo-repeat-to-state nil
3000 "The TODO state to which a repeater should return the repeating task.
3001 By default this is the first task in a TODO sequence, or the previous state
3002 in a TODO_TYP set. But you can specify another task here.
3003 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3004 :group 'org-todo
3005 :version "24.1"
3006 :type '(choice (const :tag "Head of sequence" nil)
3007 (string :tag "Specific state")))
3009 (defcustom org-log-repeat 'time
3010 "Non-nil means record moving through the DONE state when triggering repeat.
3011 An auto-repeating task is immediately switched back to TODO when
3012 marked DONE. If you are not logging state changes (by adding \"@\"
3013 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3014 record a closing note, there will be no record of the task moving
3015 through DONE. This variable forces taking a note anyway.
3017 nil Don't force a record
3018 time Record a time stamp
3019 note Prompt for a note and add it with template `org-log-note-headings'
3021 This option can also be set with on a per-file-basis with
3023 #+STARTUP: nologrepeat
3024 #+STARTUP: logrepeat
3025 #+STARTUP: lognoterepeat
3027 You can have local logging settings for a subtree by setting the LOGGING
3028 property to one or more of these keywords."
3029 :group 'org-todo
3030 :group 'org-progress
3031 :type '(choice
3032 (const :tag "Don't force a record" nil)
3033 (const :tag "Force recording the DONE state" time)
3034 (const :tag "Force recording a note with the DONE state" note)))
3037 (defgroup org-priorities nil
3038 "Priorities in Org-mode."
3039 :tag "Org Priorities"
3040 :group 'org-todo)
3042 (defcustom org-enable-priority-commands t
3043 "Non-nil means priority commands are active.
3044 When nil, these commands will be disabled, so that you never accidentally
3045 set a priority."
3046 :group 'org-priorities
3047 :type 'boolean)
3049 (defcustom org-highest-priority ?A
3050 "The highest priority of TODO items. A character like ?A, ?B etc.
3051 Must have a smaller ASCII number than `org-lowest-priority'."
3052 :group 'org-priorities
3053 :type 'character)
3055 (defcustom org-lowest-priority ?C
3056 "The lowest priority of TODO items. A character like ?A, ?B etc.
3057 Must have a larger ASCII number than `org-highest-priority'."
3058 :group 'org-priorities
3059 :type 'character)
3061 (defcustom org-default-priority ?B
3062 "The default priority of TODO items.
3063 This is the priority an item gets if no explicit priority is given.
3064 When starting to cycle on an empty priority the first step in the cycle
3065 depends on `org-priority-start-cycle-with-default'. The resulting first
3066 step priority must not exceed the range from `org-highest-priority' to
3067 `org-lowest-priority' which means that `org-default-priority' has to be
3068 in this range exclusive or inclusive the range boundaries. Else the
3069 first step refuses to set the default and the second will fall back
3070 to (depending on the command used) the highest or lowest priority."
3071 :group 'org-priorities
3072 :type 'character)
3074 (defcustom org-priority-start-cycle-with-default t
3075 "Non-nil means start with default priority when starting to cycle.
3076 When this is nil, the first step in the cycle will be (depending on the
3077 command used) one higher or lower than the default priority.
3078 See also `org-default-priority'."
3079 :group 'org-priorities
3080 :type 'boolean)
3082 (defcustom org-get-priority-function nil
3083 "Function to extract the priority from a string.
3084 The string is normally the headline. If this is nil Org computes the
3085 priority from the priority cookie like [#A] in the headline. It returns
3086 an integer, increasing by 1000 for each priority level.
3087 The user can set a different function here, which should take a string
3088 as an argument and return the numeric priority."
3089 :group 'org-priorities
3090 :version "24.1"
3091 :type '(choice
3092 (const nil)
3093 (function)))
3095 (defgroup org-time nil
3096 "Options concerning time stamps and deadlines in Org-mode."
3097 :tag "Org Time"
3098 :group 'org)
3100 (defcustom org-time-stamp-rounding-minutes '(0 5)
3101 "Number of minutes to round time stamps to.
3102 These are two values, the first applies when first creating a time stamp.
3103 The second applies when changing it with the commands `S-up' and `S-down'.
3104 When changing the time stamp, this means that it will change in steps
3105 of N minutes, as given by the second value.
3107 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3108 numbers should be factors of 60, so for example 5, 10, 15.
3110 When this is larger than 1, you can still force an exact time stamp by using
3111 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3112 and by using a prefix arg to `S-up/down' to specify the exact number
3113 of minutes to shift."
3114 :group 'org-time
3115 :get (lambda (var) ; Make sure both elements are there
3116 (if (integerp (default-value var))
3117 (list (default-value var) 5)
3118 (default-value var)))
3119 :type '(list
3120 (integer :tag "when inserting times")
3121 (integer :tag "when modifying times")))
3123 ;; Normalize old customizations of this variable.
3124 (when (integerp org-time-stamp-rounding-minutes)
3125 (setq org-time-stamp-rounding-minutes
3126 (list org-time-stamp-rounding-minutes
3127 org-time-stamp-rounding-minutes)))
3129 (defcustom org-display-custom-times nil
3130 "Non-nil means overlay custom formats over all time stamps.
3131 The formats are defined through the variable `org-time-stamp-custom-formats'.
3132 To turn this on on a per-file basis, insert anywhere in the file:
3133 #+STARTUP: customtime"
3134 :group 'org-time
3135 :set 'set-default
3136 :type 'sexp)
3137 (make-variable-buffer-local 'org-display-custom-times)
3139 (defcustom org-time-stamp-custom-formats
3140 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3141 "Custom formats for time stamps. See `format-time-string' for the syntax.
3142 These are overlaid over the default ISO format if the variable
3143 `org-display-custom-times' is set. Time like %H:%M should be at the
3144 end of the second format. The custom formats are also honored by export
3145 commands, if custom time display is turned on at the time of export."
3146 :group 'org-time
3147 :type 'sexp)
3149 (defun org-time-stamp-format (&optional long inactive)
3150 "Get the right format for a time string."
3151 (let ((f (if long (cdr org-time-stamp-formats)
3152 (car org-time-stamp-formats))))
3153 (if inactive
3154 (concat "[" (substring f 1 -1) "]")
3155 f)))
3157 (defcustom org-time-clocksum-format
3158 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3159 "The format string used when creating CLOCKSUM lines.
3160 This is also used when Org mode generates a time duration.
3162 The value can be a single format string containing two
3163 %-sequences, which will be filled with the number of hours and
3164 minutes in that order.
3166 Alternatively, the value can be a plist associating any of the
3167 keys :years, :months, :weeks, :days, :hours or :minutes with
3168 format strings. The time duration is formatted using only the
3169 time components that are needed and concatenating the results.
3170 If a time unit in absent, it falls back to the next smallest
3171 unit.
3173 The keys :require-years, :require-months, :require-days,
3174 :require-weeks, :require-hours, :require-minutes are also
3175 meaningful. A non-nil value for these keys indicates that the
3176 corresponding time component should always be included, even if
3177 its value is 0.
3180 For example,
3182 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3183 :require-minutes t)
3185 means durations longer than a day will be expressed in days,
3186 hours and minutes, and durations less than a day will always be
3187 expressed in hours and minutes (even for durations less than an
3188 hour).
3190 The value
3192 \(:days \"%dd\" :minutes \"%dm\")
3194 means durations longer than a day will be expressed in days and
3195 minutes, and durations less than a day will be expressed entirely
3196 in minutes (even for durations longer than an hour)."
3197 :group 'org-time
3198 :group 'org-clock
3199 :version "24.4"
3200 :package-version '(Org . "8.0")
3201 :type '(choice (string :tag "Format string")
3202 (set :tag "Plist"
3203 (group :inline t (const :tag "Years" :years)
3204 (string :tag "Format string"))
3205 (group :inline t
3206 (const :tag "Always show years" :require-years)
3207 (const t))
3208 (group :inline t (const :tag "Months" :months)
3209 (string :tag "Format string"))
3210 (group :inline t
3211 (const :tag "Always show months" :require-months)
3212 (const t))
3213 (group :inline t (const :tag "Weeks" :weeks)
3214 (string :tag "Format string"))
3215 (group :inline t
3216 (const :tag "Always show weeks" :require-weeks)
3217 (const t))
3218 (group :inline t (const :tag "Days" :days)
3219 (string :tag "Format string"))
3220 (group :inline t
3221 (const :tag "Always show days" :require-days)
3222 (const t))
3223 (group :inline t (const :tag "Hours" :hours)
3224 (string :tag "Format string"))
3225 (group :inline t
3226 (const :tag "Always show hours" :require-hours)
3227 (const t))
3228 (group :inline t (const :tag "Minutes" :minutes)
3229 (string :tag "Format string"))
3230 (group :inline t
3231 (const :tag "Always show minutes" :require-minutes)
3232 (const t)))))
3234 (defcustom org-time-clocksum-use-fractional nil
3235 "When non-nil, \\[org-clock-display] uses fractional times.
3236 See `org-time-clocksum-format' for more on time clock formats."
3237 :group 'org-time
3238 :group 'org-clock
3239 :version "24.3"
3240 :type 'boolean)
3242 (defcustom org-time-clocksum-use-effort-durations nil
3243 "When non-nil, \\[org-clock-display] uses effort durations.
3244 E.g. by default, one day is considered to be a 8 hours effort,
3245 so a task that has been clocked for 16 hours will be displayed
3246 as during 2 days in the clock display or in the clocktable.
3248 See `org-effort-durations' on how to set effort durations
3249 and `org-time-clocksum-format' for more on time clock formats."
3250 :group 'org-time
3251 :group 'org-clock
3252 :version "24.4"
3253 :package-version '(Org . "8.0")
3254 :type 'boolean)
3256 (defcustom org-time-clocksum-fractional-format "%.2f"
3257 "The format string used when creating CLOCKSUM lines,
3258 or when Org mode generates a time duration, if
3259 `org-time-clocksum-use-fractional' is enabled.
3261 The value can be a single format string containing one
3262 %-sequence, which will be filled with the number of hours as
3263 a float.
3265 Alternatively, the value can be a plist associating any of the
3266 keys :years, :months, :weeks, :days, :hours or :minutes with
3267 a format string. The time duration is formatted using the
3268 largest time unit which gives a non-zero integer part. If all
3269 specified formats have zero integer part, the smallest time unit
3270 is used."
3271 :group 'org-time
3272 :type '(choice (string :tag "Format string")
3273 (set (group :inline t (const :tag "Years" :years)
3274 (string :tag "Format string"))
3275 (group :inline t (const :tag "Months" :months)
3276 (string :tag "Format string"))
3277 (group :inline t (const :tag "Weeks" :weeks)
3278 (string :tag "Format string"))
3279 (group :inline t (const :tag "Days" :days)
3280 (string :tag "Format string"))
3281 (group :inline t (const :tag "Hours" :hours)
3282 (string :tag "Format string"))
3283 (group :inline t (const :tag "Minutes" :minutes)
3284 (string :tag "Format string")))))
3286 (defcustom org-deadline-warning-days 14
3287 "Number of days before expiration during which a deadline becomes active.
3288 This variable governs the display in sparse trees and in the agenda.
3289 When 0 or negative, it means use this number (the absolute value of it)
3290 even if a deadline has a different individual lead time specified.
3292 Custom commands can set this variable in the options section."
3293 :group 'org-time
3294 :group 'org-agenda-daily/weekly
3295 :type 'integer)
3297 (defcustom org-scheduled-delay-days 0
3298 "Number of days before a scheduled item becomes active.
3299 This variable governs the display in sparse trees and in the agenda.
3300 The default value (i.e. 0) means: don't delay scheduled item.
3301 When negative, it means use this number (the absolute value of it)
3302 even if a scheduled item has a different individual delay time
3303 specified.
3305 Custom commands can set this variable in the options section."
3306 :group 'org-time
3307 :group 'org-agenda-daily/weekly
3308 :version "24.4"
3309 :package-version '(Org . "8.0")
3310 :type 'integer)
3312 (defcustom org-read-date-prefer-future t
3313 "Non-nil means assume future for incomplete date input from user.
3314 This affects the following situations:
3315 1. The user gives a month but not a year.
3316 For example, if it is April and you enter \"feb 2\", this will be read
3317 as Feb 2, *next* year. \"May 5\", however, will be this year.
3318 2. The user gives a day, but no month.
3319 For example, if today is the 15th, and you enter \"3\", Org-mode will
3320 read this as the third of *next* month. However, if you enter \"17\",
3321 it will be considered as *this* month.
3323 If you set this variable to the symbol `time', then also the following
3324 will work:
3326 3. If the user gives a time.
3327 If the time is before now, it will be interpreted as tomorrow.
3329 Currently none of this works for ISO week specifications.
3331 When this option is nil, the current day, month and year will always be
3332 used as defaults.
3334 See also `org-agenda-jump-prefer-future'."
3335 :group 'org-time
3336 :type '(choice
3337 (const :tag "Never" nil)
3338 (const :tag "Check month and day" t)
3339 (const :tag "Check month, day, and time" time)))
3341 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3342 "Should the agenda jump command prefer the future for incomplete dates?
3343 The default is to do the same as configured in `org-read-date-prefer-future'.
3344 But you can also set a deviating value here.
3345 This may t or nil, or the symbol `org-read-date-prefer-future'."
3346 :group 'org-agenda
3347 :group 'org-time
3348 :version "24.1"
3349 :type '(choice
3350 (const :tag "Use org-read-date-prefer-future"
3351 org-read-date-prefer-future)
3352 (const :tag "Never" nil)
3353 (const :tag "Always" t)))
3355 (defcustom org-read-date-force-compatible-dates t
3356 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3358 Depending on the system Emacs is running on, certain dates cannot
3359 be represented with the type used internally to represent time.
3360 Dates between 1970-1-1 and 2038-1-1 can always be represented
3361 correctly. Some systems allow for earlier dates, some for later,
3362 some for both. One way to find out it to insert any date into an
3363 Org buffer, putting the cursor on the year and hitting S-up and
3364 S-down to test the range.
3366 When this variable is set to t, the date/time prompt will not let
3367 you specify dates outside the 1970-2037 range, so it is certain that
3368 these dates will work in whatever version of Emacs you are
3369 running, and also that you can move a file from one Emacs implementation
3370 to another. WHenever Org is forcing the year for you, it will display
3371 a message and beep.
3373 When this variable is nil, Org will check if the date is
3374 representable in the specific Emacs implementation you are using.
3375 If not, it will force a year, usually the current year, and beep
3376 to remind you. Currently this setting is not recommended because
3377 the likelihood that you will open your Org files in an Emacs that
3378 has limited date range is not negligible.
3380 A workaround for this problem is to use diary sexp dates for time
3381 stamps outside of this range."
3382 :group 'org-time
3383 :version "24.1"
3384 :type 'boolean)
3386 (defcustom org-read-date-display-live t
3387 "Non-nil means display current interpretation of date prompt live.
3388 This display will be in an overlay, in the minibuffer."
3389 :group 'org-time
3390 :type 'boolean)
3392 (defcustom org-read-date-popup-calendar t
3393 "Non-nil means pop up a calendar when prompting for a date.
3394 In the calendar, the date can be selected with mouse-1. However, the
3395 minibuffer will also be active, and you can simply enter the date as well.
3396 When nil, only the minibuffer will be available."
3397 :group 'org-time
3398 :type 'boolean)
3399 (org-defvaralias 'org-popup-calendar-for-date-prompt
3400 'org-read-date-popup-calendar)
3402 (make-obsolete-variable
3403 'org-read-date-minibuffer-setup-hook
3404 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3405 (defcustom org-read-date-minibuffer-setup-hook nil
3406 "Hook to be used to set up keys for the date/time interface.
3407 Add key definitions to `minibuffer-local-map', which will be a
3408 temporary copy.
3410 WARNING: This option is obsolete, you should use
3411 `org-read-date-minibuffer-local-map' to set up keys."
3412 :group 'org-time
3413 :type 'hook)
3415 (defcustom org-extend-today-until 0
3416 "The hour when your day really ends. Must be an integer.
3417 This has influence for the following applications:
3418 - When switching the agenda to \"today\". It it is still earlier than
3419 the time given here, the day recognized as TODAY is actually yesterday.
3420 - When a date is read from the user and it is still before the time given
3421 here, the current date and time will be assumed to be yesterday, 23:59.
3422 Also, timestamps inserted in capture templates follow this rule.
3424 IMPORTANT: This is a feature whose implementation is and likely will
3425 remain incomplete. Really, it is only here because past midnight seems to
3426 be the favorite working time of John Wiegley :-)"
3427 :group 'org-time
3428 :type 'integer)
3430 (defcustom org-use-effective-time nil
3431 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3432 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3433 \"effective time\" of any timestamps between midnight and 8am will be
3434 23:59 of the previous day."
3435 :group 'org-time
3436 :version "24.1"
3437 :type 'boolean)
3439 (defcustom org-use-last-clock-out-time-as-effective-time nil
3440 "When non-nil, use the last clock out time for `org-todo'.
3441 Note that this option has precedence over the combined use of
3442 `org-use-effective-time' and `org-extend-today-until'."
3443 :group 'org-time
3444 :version "24.4"
3445 :package-version '(Org . "8.0")
3446 :type 'boolean)
3448 (defcustom org-edit-timestamp-down-means-later nil
3449 "Non-nil means S-down will increase the time in a time stamp.
3450 When nil, S-up will increase."
3451 :group 'org-time
3452 :type 'boolean)
3454 (defcustom org-calendar-follow-timestamp-change t
3455 "Non-nil means make the calendar window follow timestamp changes.
3456 When a timestamp is modified and the calendar window is visible, it will be
3457 moved to the new date."
3458 :group 'org-time
3459 :type 'boolean)
3461 (defgroup org-tags nil
3462 "Options concerning tags in Org-mode."
3463 :tag "Org Tags"
3464 :group 'org)
3466 (defcustom org-tag-alist nil
3467 "List of tags allowed in Org-mode files.
3468 When this list is nil, Org-mode will base TAG input on what is already in the
3469 buffer.
3470 The value of this variable is an alist, the car of each entry must be a
3471 keyword as a string, the cdr may be a character that is used to select
3472 that tag through the fast-tag-selection interface.
3473 See the manual for details."
3474 :group 'org-tags
3475 :type '(repeat
3476 (choice
3477 (cons (string :tag "Tag name")
3478 (character :tag "Access char"))
3479 (list :tag "Start radio group"
3480 (const :startgroup)
3481 (option (string :tag "Group description")))
3482 (list :tag "Start tag group, non distinct"
3483 (const :startgrouptag)
3484 (option (string :tag "Group description")))
3485 (list :tag "Group tags delimiter"
3486 (const :grouptags))
3487 (list :tag "End radio group"
3488 (const :endgroup)
3489 (option (string :tag "Group description")))
3490 (list :tag "End tag group, non distinct"
3491 (const :endgrouptag)
3492 (option (string :tag "Group description")))
3493 (const :tag "New line" (:newline)))))
3495 (defcustom org-tag-persistent-alist nil
3496 "List of tags that will always appear in all Org-mode files.
3497 This is in addition to any in buffer settings or customizations
3498 of `org-tag-alist'.
3499 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3500 The value of this variable is an alist, the car of each entry must be a
3501 keyword as a string, the cdr may be a character that is used to select
3502 that tag through the fast-tag-selection interface.
3503 See the manual for details.
3504 To disable these tags on a per-file basis, insert anywhere in the file:
3505 #+STARTUP: noptag"
3506 :group 'org-tags
3507 :type '(repeat
3508 (choice
3509 (cons (string :tag "Tag name")
3510 (character :tag "Access char"))
3511 (const :tag "Start radio group" (:startgroup))
3512 (const :tag "Group tags delimiter" (:grouptags))
3513 (const :tag "End radio group" (:endgroup))
3514 (const :tag "New line" (:newline)))))
3516 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3517 "If non-nil, always offer completion for all tags of all agenda files.
3518 Instead of customizing this variable directly, you might want to
3519 set it locally for capture buffers, because there no list of
3520 tags in that file can be created dynamically (there are none).
3522 (add-hook 'org-capture-mode-hook
3523 (lambda ()
3524 (set (make-local-variable
3525 'org-complete-tags-always-offer-all-agenda-tags)
3526 t)))"
3527 :group 'org-tags
3528 :version "24.1"
3529 :type 'boolean)
3531 (defvar org-file-tags nil
3532 "List of tags that can be inherited by all entries in the file.
3533 The tags will be inherited if the variable `org-use-tag-inheritance'
3534 says they should be.
3535 This variable is populated from #+FILETAGS lines.")
3537 (defcustom org-use-fast-tag-selection 'auto
3538 "Non-nil means use fast tag selection scheme.
3539 This is a special interface to select and deselect tags with single keys.
3540 When nil, fast selection is never used.
3541 When the symbol `auto', fast selection is used if and only if selection
3542 characters for tags have been configured, either through the variable
3543 `org-tag-alist' or through a #+TAGS line in the buffer.
3544 When t, fast selection is always used and selection keys are assigned
3545 automatically if necessary."
3546 :group 'org-tags
3547 :type '(choice
3548 (const :tag "Always" t)
3549 (const :tag "Never" nil)
3550 (const :tag "When selection characters are configured" auto)))
3552 (defcustom org-fast-tag-selection-single-key nil
3553 "Non-nil means fast tag selection exits after first change.
3554 When nil, you have to press RET to exit it.
3555 During fast tag selection, you can toggle this flag with `C-c'.
3556 This variable can also have the value `expert'. In this case, the window
3557 displaying the tags menu is not even shown, until you press C-c again."
3558 :group 'org-tags
3559 :type '(choice
3560 (const :tag "No" nil)
3561 (const :tag "Yes" t)
3562 (const :tag "Expert" expert)))
3564 (defvar org-fast-tag-selection-include-todo nil
3565 "Non-nil means fast tags selection interface will also offer TODO states.
3566 This is an undocumented feature, you should not rely on it.")
3568 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3569 "The column to which tags should be indented in a headline.
3570 If this number is positive, it specifies the column. If it is negative,
3571 it means that the tags should be flushright to that column. For example,
3572 -80 works well for a normal 80 character screen.
3573 When 0, place tags directly after headline text, with only one space in
3574 between."
3575 :group 'org-tags
3576 :type 'integer)
3578 (defcustom org-auto-align-tags t
3579 "Non-nil keeps tags aligned when modifying headlines.
3580 Some operations (i.e. demoting) change the length of a headline and
3581 therefore shift the tags around. With this option turned on, after
3582 each such operation the tags are again aligned to `org-tags-column'."
3583 :group 'org-tags
3584 :type 'boolean)
3586 (defcustom org-use-tag-inheritance t
3587 "Non-nil means tags in levels apply also for sublevels.
3588 When nil, only the tags directly given in a specific line apply there.
3589 This may also be a list of tags that should be inherited, or a regexp that
3590 matches tags that should be inherited. Additional control is possible
3591 with the variable `org-tags-exclude-from-inheritance' which gives an
3592 explicit list of tags to be excluded from inheritance, even if the value of
3593 `org-use-tag-inheritance' would select it for inheritance.
3595 If this option is t, a match early-on in a tree can lead to a large
3596 number of matches in the subtree when constructing the agenda or creating
3597 a sparse tree. If you only want to see the first match in a tree during
3598 a search, check out the variable `org-tags-match-list-sublevels'."
3599 :group 'org-tags
3600 :type '(choice
3601 (const :tag "Not" nil)
3602 (const :tag "Always" t)
3603 (repeat :tag "Specific tags" (string :tag "Tag"))
3604 (regexp :tag "Tags matched by regexp")))
3606 (defcustom org-tags-exclude-from-inheritance nil
3607 "List of tags that should never be inherited.
3608 This is a way to exclude a few tags from inheritance. For way to do
3609 the opposite, to actively allow inheritance for selected tags,
3610 see the variable `org-use-tag-inheritance'."
3611 :group 'org-tags
3612 :type '(repeat (string :tag "Tag")))
3614 (defun org-tag-inherit-p (tag)
3615 "Check if TAG is one that should be inherited."
3616 (cond
3617 ((member tag org-tags-exclude-from-inheritance) nil)
3618 ((eq org-use-tag-inheritance t) t)
3619 ((not org-use-tag-inheritance) nil)
3620 ((stringp org-use-tag-inheritance)
3621 (string-match org-use-tag-inheritance tag))
3622 ((listp org-use-tag-inheritance)
3623 (member tag org-use-tag-inheritance))
3624 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3626 (defcustom org-tags-match-list-sublevels t
3627 "Non-nil means list also sublevels of headlines matching a search.
3628 This variable applies to tags/property searches, and also to stuck
3629 projects because this search is based on a tags match as well.
3631 When set to the symbol `indented', sublevels are indented with
3632 leading dots.
3634 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3635 the sublevels of a headline matching a tag search often also match
3636 the same search. Listing all of them can create very long lists.
3637 Setting this variable to nil causes subtrees of a match to be skipped.
3639 This variable is semi-obsolete and probably should always be true. It
3640 is better to limit inheritance to certain tags using the variables
3641 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3642 :group 'org-tags
3643 :type '(choice
3644 (const :tag "No, don't list them" nil)
3645 (const :tag "Yes, do list them" t)
3646 (const :tag "List them, indented with leading dots" indented)))
3648 (defcustom org-tags-sort-function nil
3649 "When set, tags are sorted using this function as a comparator."
3650 :group 'org-tags
3651 :type '(choice
3652 (const :tag "No sorting" nil)
3653 (const :tag "Alphabetical" string<)
3654 (const :tag "Reverse alphabetical" string>)
3655 (function :tag "Custom function" nil)))
3657 (defvar org-tags-history nil
3658 "History of minibuffer reads for tags.")
3659 (defvar org-last-tags-completion-table nil
3660 "The last used completion table for tags.")
3661 (defvar org-after-tags-change-hook nil
3662 "Hook that is run after the tags in a line have changed.")
3664 (defgroup org-properties nil
3665 "Options concerning properties in Org-mode."
3666 :tag "Org Properties"
3667 :group 'org)
3669 (defcustom org-property-format "%-10s %s"
3670 "How property key/value pairs should be formatted by `indent-line'.
3671 When `indent-line' hits a property definition, it will format the line
3672 according to this format, mainly to make sure that the values are
3673 lined-up with respect to each other."
3674 :group 'org-properties
3675 :type 'string)
3677 (defcustom org-properties-postprocess-alist nil
3678 "Alist of properties and functions to adjust inserted values.
3679 Elements of this alist must be of the form
3681 ([string] [function])
3683 where [string] must be a property name and [function] must be a
3684 lambda expression: this lambda expression must take one argument,
3685 the value to adjust, and return the new value as a string.
3687 For example, this element will allow the property \"Remaining\"
3688 to be updated wrt the relation between the \"Effort\" property
3689 and the clock summary:
3691 ((\"Remaining\" (lambda(value)
3692 (let ((clocksum (org-clock-sum-current-item))
3693 (effort (org-duration-string-to-minutes
3694 (org-entry-get (point) \"Effort\"))))
3695 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3696 :group 'org-properties
3697 :version "24.1"
3698 :type '(alist :key-type (string :tag "Property")
3699 :value-type (function :tag "Function")))
3701 (defcustom org-use-property-inheritance nil
3702 "Non-nil means properties apply also for sublevels.
3704 This setting is chiefly used during property searches. Turning it on can
3705 cause significant overhead when doing a search, which is why it is not
3706 on by default.
3708 When nil, only the properties directly given in the current entry count.
3709 When t, every property is inherited. The value may also be a list of
3710 properties that should have inheritance, or a regular expression matching
3711 properties that should be inherited.
3713 However, note that some special properties use inheritance under special
3714 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3715 and the properties ending in \"_ALL\" when they are used as descriptor
3716 for valid values of a property.
3718 Note for programmers:
3719 When querying an entry with `org-entry-get', you can control if inheritance
3720 should be used. By default, `org-entry-get' looks only at the local
3721 properties. You can request inheritance by setting the inherit argument
3722 to t (to force inheritance) or to `selective' (to respect the setting
3723 in this variable)."
3724 :group 'org-properties
3725 :type '(choice
3726 (const :tag "Not" nil)
3727 (const :tag "Always" t)
3728 (repeat :tag "Specific properties" (string :tag "Property"))
3729 (regexp :tag "Properties matched by regexp")))
3731 (defun org-property-inherit-p (property)
3732 "Check if PROPERTY is one that should be inherited."
3733 (cond
3734 ((eq org-use-property-inheritance t) t)
3735 ((not org-use-property-inheritance) nil)
3736 ((stringp org-use-property-inheritance)
3737 (string-match org-use-property-inheritance property))
3738 ((listp org-use-property-inheritance)
3739 (member property org-use-property-inheritance))
3740 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3742 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3743 "The default column format, if no other format has been defined.
3744 This variable can be set on the per-file basis by inserting a line
3746 #+COLUMNS: %25ITEM ....."
3747 :group 'org-properties
3748 :type 'string)
3750 (defcustom org-columns-ellipses ".."
3751 "The ellipses to be used when a field in column view is truncated.
3752 When this is the empty string, as many characters as possible are shown,
3753 but then there will be no visual indication that the field has been truncated.
3754 When this is a string of length N, the last N characters of a truncated
3755 field are replaced by this string. If the column is narrower than the
3756 ellipses string, only part of the ellipses string will be shown."
3757 :group 'org-properties
3758 :type 'string)
3760 (defcustom org-columns-modify-value-for-display-function nil
3761 "Function that modifies values for display in column view.
3762 For example, it can be used to cut out a certain part from a time stamp.
3763 The function must take 2 arguments:
3765 column-title The title of the column (*not* the property name)
3766 value The value that should be modified.
3768 The function should return the value that should be displayed,
3769 or nil if the normal value should be used."
3770 :group 'org-properties
3771 :type '(choice (const nil) (function)))
3773 (defconst org-global-properties-fixed
3774 '(("VISIBILITY_ALL" . "folded children content all")
3775 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3776 "List of property/value pairs that can be inherited by any entry.
3778 These are fixed values, for the preset properties. The user variable
3779 that can be used to add to this list is `org-global-properties'.
3781 The entries in this list are cons cells where the car is a property
3782 name and cdr is a string with the value. If the value represents
3783 multiple items like an \"_ALL\" property, separate the items by
3784 spaces.")
3786 (defcustom org-global-properties nil
3787 "List of property/value pairs that can be inherited by any entry.
3789 This list will be combined with the constant `org-global-properties-fixed'.
3791 The entries in this list are cons cells where the car is a property
3792 name and cdr is a string with the value.
3794 You can set buffer-local values for the same purpose in the variable
3795 `org-file-properties' this by adding lines like
3797 #+PROPERTY: NAME VALUE"
3798 :group 'org-properties
3799 :type '(repeat
3800 (cons (string :tag "Property")
3801 (string :tag "Value"))))
3803 (defvar org-file-properties nil
3804 "List of property/value pairs that can be inherited by any entry.
3805 Valid for the current buffer.
3806 This variable is populated from #+PROPERTY lines.")
3807 (make-variable-buffer-local 'org-file-properties)
3809 (defgroup org-agenda nil
3810 "Options concerning agenda views in Org-mode."
3811 :tag "Org Agenda"
3812 :group 'org)
3814 (defvar org-category nil
3815 "Variable used by org files to set a category for agenda display.
3816 Such files should use a file variable to set it, for example
3818 # -*- mode: org; org-category: \"ELisp\"
3820 or contain a special line
3822 #+CATEGORY: ELisp
3824 If the file does not specify a category, then file's base name
3825 is used instead.")
3826 (make-variable-buffer-local 'org-category)
3827 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3829 (defcustom org-agenda-files nil
3830 "The files to be used for agenda display.
3831 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3832 \\[org-remove-file]. You can also use customize to edit the list.
3834 If an entry is a directory, all files in that directory that are matched by
3835 `org-agenda-file-regexp' will be part of the file list.
3837 If the value of the variable is not a list but a single file name, then
3838 the list of agenda files is actually stored and maintained in that file, one
3839 agenda file per line. In this file paths can be given relative to
3840 `org-directory'. Tilde expansion and environment variable substitution
3841 are also made."
3842 :group 'org-agenda
3843 :type '(choice
3844 (repeat :tag "List of files and directories" file)
3845 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3847 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3848 "Regular expression to match files for `org-agenda-files'.
3849 If any element in the list in that variable contains a directory instead
3850 of a normal file, all files in that directory that are matched by this
3851 regular expression will be included."
3852 :group 'org-agenda
3853 :type 'regexp)
3855 (defcustom org-agenda-text-search-extra-files nil
3856 "List of extra files to be searched by text search commands.
3857 These files will be searched in addition to the agenda files by the
3858 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3859 Note that these files will only be searched for text search commands,
3860 not for the other agenda views like todo lists, tag searches or the weekly
3861 agenda. This variable is intended to list notes and possibly archive files
3862 that should also be searched by these two commands.
3863 In fact, if the first element in the list is the symbol `agenda-archives',
3864 then all archive files of all agenda files will be added to the search
3865 scope."
3866 :group 'org-agenda
3867 :type '(set :greedy t
3868 (const :tag "Agenda Archives" agenda-archives)
3869 (repeat :inline t (file))))
3871 (org-defvaralias 'org-agenda-multi-occur-extra-files
3872 'org-agenda-text-search-extra-files)
3874 (defcustom org-agenda-skip-unavailable-files nil
3875 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3876 A nil value means to remove them, after a query, from the list."
3877 :group 'org-agenda
3878 :type 'boolean)
3880 (defcustom org-calendar-to-agenda-key [?c]
3881 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3882 The command `org-calendar-goto-agenda' will be bound to this key. The
3883 default is the character `c' because then `c' can be used to switch back and
3884 forth between agenda and calendar."
3885 :group 'org-agenda
3886 :type 'sexp)
3888 (defcustom org-calendar-insert-diary-entry-key [?i]
3889 "The key to be installed in `calendar-mode-map' for adding diary entries.
3890 This option is irrelevant until `org-agenda-diary-file' has been configured
3891 to point to an Org-mode file. When that is the case, the command
3892 `org-agenda-diary-entry' will be bound to the key given here, by default
3893 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3894 if you want to continue doing this, you need to change this to a different
3895 key."
3896 :group 'org-agenda
3897 :type 'sexp)
3899 (defcustom org-agenda-diary-file 'diary-file
3900 "File to which to add new entries with the `i' key in agenda and calendar.
3901 When this is the symbol `diary-file', the functionality in the Emacs
3902 calendar will be used to add entries to the `diary-file'. But when this
3903 points to a file, `org-agenda-diary-entry' will be used instead."
3904 :group 'org-agenda
3905 :type '(choice
3906 (const :tag "The standard Emacs diary file" diary-file)
3907 (file :tag "Special Org file diary entries")))
3909 (eval-after-load "calendar"
3910 '(progn
3911 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3912 'org-calendar-goto-agenda)
3913 (add-hook 'calendar-mode-hook
3914 (lambda ()
3915 (unless (eq org-agenda-diary-file 'diary-file)
3916 (define-key calendar-mode-map
3917 org-calendar-insert-diary-entry-key
3918 'org-agenda-diary-entry))))))
3920 (defgroup org-latex nil
3921 "Options for embedding LaTeX code into Org-mode."
3922 :tag "Org LaTeX"
3923 :group 'org)
3925 (defcustom org-format-latex-options
3926 '(:foreground default :background default :scale 1.0
3927 :html-foreground "Black" :html-background "Transparent"
3928 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3929 "Options for creating images from LaTeX fragments.
3930 This is a property list with the following properties:
3931 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3932 `default' means use the foreground of the default face.
3933 `auto' means use the foreground from the text face.
3934 :background the background color, or \"Transparent\".
3935 `default' means use the background of the default face.
3936 `auto' means use the background from the text face.
3937 :scale a scaling factor for the size of the images, to get more pixels
3938 :html-foreground, :html-background, :html-scale
3939 the same numbers for HTML export.
3940 :matchers a list indicating which matchers should be used to
3941 find LaTeX fragments. Valid members of this list are:
3942 \"begin\" find environments
3943 \"$1\" find single characters surrounded by $.$
3944 \"$\" find math expressions surrounded by $...$
3945 \"$$\" find math expressions surrounded by $$....$$
3946 \"\\(\" find math expressions surrounded by \\(...\\)
3947 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3948 :group 'org-latex
3949 :type 'plist)
3951 (defcustom org-format-latex-signal-error t
3952 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3953 When nil, just push out a message."
3954 :group 'org-latex
3955 :version "24.1"
3956 :type 'boolean)
3958 (defcustom org-latex-to-mathml-jar-file nil
3959 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3960 Use this to specify additional executable file say a jar file.
3962 When using MathToWeb as the converter, specify the full-path to
3963 your mathtoweb.jar file."
3964 :group 'org-latex
3965 :version "24.1"
3966 :type '(choice
3967 (const :tag "None" nil)
3968 (file :tag "JAR file" :must-match t)))
3970 (defcustom org-latex-to-mathml-convert-command nil
3971 "Command to convert LaTeX fragments to MathML.
3972 Replace format-specifiers in the command as noted below and use
3973 `shell-command' to convert LaTeX to MathML.
3974 %j: Executable file in fully expanded form as specified by
3975 `org-latex-to-mathml-jar-file'.
3976 %I: Input LaTeX file in fully expanded form.
3977 %i: The latex fragment to be converted.
3978 %o: Output MathML file.
3979 This command is used by `org-create-math-formula'.
3981 When using MathToWeb as the converter, set this to
3982 \"java -jar %j -unicode -force -df %o %I\".
3984 When using LaTeXML set this 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 org-enable-table-editor
4502 (save-excursion
4503 (beginning-of-line)
4504 (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4505 (let ((element (org-element-lineage (org-element-at-point) '(table) t)))
4506 (and element
4507 (or table-type (eq (org-element-property :type element) 'org))))))
4508 (defsubst org-table-p () (org-at-table-p))
4510 (defun org-at-table.el-p ()
4511 "Non-nil when point is at a table.el table."
4512 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4513 (let ((element (org-element-at-point)))
4514 (and (eq (org-element-type element) 'table)
4515 (eq (org-element-property :type element) 'table.el)))))
4517 (defun org-table-recognize-table.el ()
4518 "If there is a table.el table nearby, recognize it and move into it."
4519 (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4520 (beginning-of-line)
4521 (unless (or (looking-at org-table-dataline-regexp)
4522 (not (looking-at org-table1-hline-regexp)))
4523 (forward-line)
4524 (when (looking-at org-table-any-border-regexp)
4525 (forward-line -2)))
4526 (if (re-search-forward "|" (org-table-end t) t)
4527 (progn
4528 (require 'table)
4529 (if (table--at-cell-p (point)) t
4530 (message "recognizing table.el table...")
4531 (table-recognize-table)
4532 (message "recognizing table.el table...done")))
4533 (error "This should not happen"))))
4535 (defun org-at-table-hline-p ()
4536 "Non-nil when point is inside a hline in a table.
4537 Assume point is already in a table. If `org-enable-table-editor'
4538 is nil, return nil unconditionally."
4539 (and org-enable-table-editor
4540 (save-excursion
4541 (beginning-of-line)
4542 (looking-at org-table-hline-regexp))))
4544 (defun org-table-map-tables (function &optional quietly)
4545 "Apply FUNCTION to the start of all tables in the buffer."
4546 (save-excursion
4547 (save-restriction
4548 (widen)
4549 (goto-char (point-min))
4550 (while (re-search-forward org-table-any-line-regexp nil t)
4551 (unless quietly
4552 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4553 (beginning-of-line 1)
4554 (when (and (looking-at org-table-line-regexp)
4555 ;; Exclude tables in src/example/verbatim/clocktable blocks
4556 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4557 (save-excursion (funcall function))
4558 (or (looking-at org-table-line-regexp)
4559 (forward-char 1)))
4560 (re-search-forward org-table-any-border-regexp nil 1))))
4561 (unless quietly (message "Mapping tables: done")))
4563 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4564 (declare-function org-clock-update-mode-line "org-clock" ())
4565 (declare-function org-resolve-clocks "org-clock"
4566 (&optional also-non-dangling-p prompt last-valid))
4568 (defun org-at-TBLFM-p (&optional pos)
4569 "Non-nil when point (or POS) is in #+TBLFM line."
4570 (save-excursion
4571 (goto-char (or pos (point)))
4572 (beginning-of-line)
4573 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4574 (eq (org-element-type (org-element-at-point)) 'table))))
4576 (defvar org-clock-start-time)
4577 (defvar org-clock-marker (make-marker)
4578 "Marker recording the last clock-in.")
4579 (defvar org-clock-hd-marker (make-marker)
4580 "Marker recording the last clock-in, but the headline position.")
4581 (defvar org-clock-heading ""
4582 "The heading of the current clock entry.")
4583 (defun org-clock-is-active ()
4584 "Return the buffer where the clock is currently running.
4585 Return nil if no clock is running."
4586 (marker-buffer org-clock-marker))
4588 (defun org-check-running-clock ()
4589 "Check if the current buffer contains the running clock.
4590 If yes, offer to stop it and to save the buffer with the changes."
4591 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4592 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4593 (buffer-name))))
4594 (org-clock-out)
4595 (when (y-or-n-p "Save changed buffer?")
4596 (save-buffer))))
4598 (defun org-clocktable-try-shift (dir n)
4599 "Check if this line starts a clock table, if yes, shift the time block."
4600 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4601 (org-clocktable-shift dir n)))
4603 ;;;###autoload
4604 (defun org-clock-persistence-insinuate ()
4605 "Set up hooks for clock persistence."
4606 (require 'org-clock)
4607 (add-hook 'org-mode-hook 'org-clock-load)
4608 (add-hook 'kill-emacs-hook 'org-clock-save))
4610 (defgroup org-archive nil
4611 "Options concerning archiving in Org-mode."
4612 :tag "Org Archive"
4613 :group 'org-structure)
4615 (defcustom org-archive-location "%s_archive::"
4616 "The location where subtrees should be archived.
4618 The value of this variable is a string, consisting of two parts,
4619 separated by a double-colon. The first part is a filename and
4620 the second part is a headline.
4622 When the filename is omitted, archiving happens in the same file.
4623 %s in the filename will be replaced by the current file
4624 name (without the directory part). Archiving to a different file
4625 is useful to keep archived entries from contributing to the
4626 Org-mode Agenda.
4628 The archived entries will be filed as subtrees of the specified
4629 headline. When the headline is omitted, the subtrees are simply
4630 filed away at the end of the file, as top-level entries. Also in
4631 the heading you can use %s to represent the file name, this can be
4632 useful when using the same archive for a number of different files.
4634 Here are a few examples:
4635 \"%s_archive::\"
4636 If the current file is Projects.org, archive in file
4637 Projects.org_archive, as top-level trees. This is the default.
4639 \"::* Archived Tasks\"
4640 Archive in the current file, under the top-level headline
4641 \"* Archived Tasks\".
4643 \"~/org/archive.org::\"
4644 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4646 \"~/org/archive.org::* From %s\"
4647 Archive in file ~/org/archive.org (absolute path), under headlines
4648 \"From FILENAME\" where file name is the current file name.
4650 \"~/org/datetree.org::datetree/* Finished Tasks\"
4651 The \"datetree/\" string is special, signifying to archive
4652 items to the datetree. Items are placed in either the CLOSED
4653 date of the item, or the current date if there is no CLOSED date.
4654 The heading will be a subentry to the current date. There doesn't
4655 need to be a heading, but there always needs to be a slash after
4656 datetree. For example, to store archived items directly in the
4657 datetree, use \"~/org/datetree.org::datetree/\".
4659 \"basement::** Finished Tasks\"
4660 Archive in file ./basement (relative path), as level 3 trees
4661 below the level 2 heading \"** Finished Tasks\".
4663 You may set this option on a per-file basis by adding to the buffer a
4664 line like
4666 #+ARCHIVE: basement::** Finished Tasks
4668 You may also define it locally for a subtree by setting an ARCHIVE property
4669 in the entry. If such a property is found in an entry, or anywhere up
4670 the hierarchy, it will be used."
4671 :group 'org-archive
4672 :type 'string)
4674 (defcustom org-agenda-skip-archived-trees t
4675 "Non-nil means the agenda will skip any items located in archived trees.
4676 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4677 variable is no longer recommended, you should leave it at the value t.
4678 Instead, use the key `v' to cycle the archives-mode in the agenda."
4679 :group 'org-archive
4680 :group 'org-agenda-skip
4681 :type 'boolean)
4683 (defcustom org-columns-skip-archived-trees t
4684 "Non-nil means ignore archived trees when creating column view."
4685 :group 'org-archive
4686 :group 'org-properties
4687 :type 'boolean)
4689 (defcustom org-cycle-open-archived-trees nil
4690 "Non-nil means `org-cycle' will open archived trees.
4691 An archived tree is a tree marked with the tag ARCHIVE.
4692 When nil, archived trees will stay folded. You can still open them with
4693 normal outline commands like `show-all', but not with the cycling commands."
4694 :group 'org-archive
4695 :group 'org-cycle
4696 :type 'boolean)
4698 (defcustom org-sparse-tree-open-archived-trees nil
4699 "Non-nil means sparse tree construction shows matches in archived trees.
4700 When nil, matches in these trees are highlighted, but the trees are kept in
4701 collapsed state."
4702 :group 'org-archive
4703 :group 'org-sparse-trees
4704 :type 'boolean)
4706 (defcustom org-sparse-tree-default-date-type nil
4707 "The default date type when building a sparse tree.
4708 When this is nil, a date is a scheduled or a deadline timestamp.
4709 Otherwise, these types are allowed:
4711 all: all timestamps
4712 active: only active timestamps (<...>)
4713 inactive: only inactive timestamps ([...])
4714 scheduled: only scheduled timestamps
4715 deadline: only deadline timestamps"
4716 :type '(choice (const :tag "Scheduled or deadline" nil)
4717 (const :tag "All timestamps" all)
4718 (const :tag "Only active timestamps" active)
4719 (const :tag "Only inactive timestamps" inactive)
4720 (const :tag "Only scheduled timestamps" scheduled)
4721 (const :tag "Only deadline timestamps" deadline)
4722 (const :tag "Only closed timestamps" closed))
4723 :version "25.1"
4724 :package-version '(Org . "8.3")
4725 :group 'org-sparse-trees)
4727 (defun org-cycle-hide-archived-subtrees (state)
4728 "Re-hide all archived subtrees after a visibility state change."
4729 (when (and (not org-cycle-open-archived-trees)
4730 (not (memq state '(overview folded))))
4731 (save-excursion
4732 (let* ((globalp (memq state '(contents all)))
4733 (beg (if globalp (point-min) (point)))
4734 (end (if globalp (point-max) (org-end-of-subtree t))))
4735 (org-hide-archived-subtrees beg end)
4736 (goto-char beg)
4737 (if (looking-at (concat ".*:" org-archive-tag ":"))
4738 (message "%s" (substitute-command-keys
4739 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4741 (defun org-force-cycle-archived ()
4742 "Cycle subtree even if it is archived."
4743 (interactive)
4744 (setq this-command 'org-cycle)
4745 (let ((org-cycle-open-archived-trees t))
4746 (call-interactively 'org-cycle)))
4748 (defun org-hide-archived-subtrees (beg end)
4749 "Re-hide all archived subtrees after a visibility state change."
4750 (org-with-wide-buffer
4751 (let ((case-fold-search nil)
4752 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4753 (goto-char beg)
4754 (while (and (< (point) end) (re-search-forward re end t))
4755 (when (member org-archive-tag (org-get-tags))
4756 (org-flag-subtree t)
4757 (org-end-of-subtree t))))))
4759 (declare-function outline-end-of-heading "outline" ())
4760 (declare-function outline-flag-region "outline" (from to flag))
4761 (defun org-flag-subtree (flag)
4762 (save-excursion
4763 (org-back-to-heading t)
4764 (outline-end-of-heading)
4765 (outline-flag-region (point)
4766 (progn (org-end-of-subtree t) (point))
4767 flag)))
4769 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4771 ;; Declare Column View Code
4773 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4774 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4775 (declare-function org-columns-compute "org-colview" (property))
4777 ;; Declare ID code
4779 (declare-function org-id-store-link "org-id")
4780 (declare-function org-id-locations-load "org-id")
4781 (declare-function org-id-locations-save "org-id")
4782 (defvar org-id-track-globally)
4784 ;;; Variables for pre-computed regular expressions, all buffer local
4786 (defvar org-todo-regexp nil
4787 "Matches any of the TODO state keywords.")
4788 (make-variable-buffer-local 'org-todo-regexp)
4789 (defvar org-not-done-regexp nil
4790 "Matches any of the TODO state keywords except the last one.")
4791 (make-variable-buffer-local 'org-not-done-regexp)
4792 (defvar org-not-done-heading-regexp nil
4793 "Matches a TODO headline that is not done.")
4794 (make-variable-buffer-local 'org-not-done-heading-regexp)
4795 (defvar org-todo-line-regexp nil
4796 "Matches a headline and puts TODO state into group 2 if present.")
4797 (make-variable-buffer-local 'org-todo-line-regexp)
4798 (defvar org-complex-heading-regexp nil
4799 "Matches a headline and puts everything into groups:
4800 group 1: the stars
4801 group 2: The todo keyword, maybe
4802 group 3: Priority cookie
4803 group 4: True headline
4804 group 5: Tags")
4805 (make-variable-buffer-local 'org-complex-heading-regexp)
4806 (defvar org-complex-heading-regexp-format nil
4807 "Printf format to make regexp to match an exact headline.
4808 This regexp will match the headline of any node which has the
4809 exact headline text that is put into the format, but may have any
4810 TODO state, priority and tags.")
4811 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4812 (defvar org-todo-line-tags-regexp nil
4813 "Matches a headline and puts TODO state into group 2 if present.
4814 Also put tags into group 4 if tags are present.")
4815 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4817 (defconst org-plain-time-of-day-regexp
4818 (concat
4819 "\\(\\<[012]?[0-9]"
4820 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4821 "\\(--?"
4822 "\\(\\<[012]?[0-9]"
4823 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4824 "\\)?")
4825 "Regular expression to match a plain time or time range.
4826 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4827 groups carry important information:
4828 0 the full match
4829 1 the first time, range or not
4830 8 the second time, if it is a range.")
4832 (defconst org-plain-time-extension-regexp
4833 (concat
4834 "\\(\\<[012]?[0-9]"
4835 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4836 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4837 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4838 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4839 groups carry important information:
4840 0 the full match
4841 7 hours of duration
4842 9 minutes of duration")
4844 (defconst org-stamp-time-of-day-regexp
4845 (concat
4846 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4847 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4848 "\\(--?"
4849 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4850 "Regular expression to match a timestamp time or time range.
4851 After a match, the following groups carry important information:
4852 0 the full match
4853 1 date plus weekday, for back referencing to make sure both times are on the same day
4854 2 the first time, range or not
4855 4 the second time, if it is a range.")
4857 (defconst org-startup-options
4858 '(("fold" org-startup-folded t)
4859 ("overview" org-startup-folded t)
4860 ("nofold" org-startup-folded nil)
4861 ("showall" org-startup-folded nil)
4862 ("showeverything" org-startup-folded showeverything)
4863 ("content" org-startup-folded content)
4864 ("indent" org-startup-indented t)
4865 ("noindent" org-startup-indented nil)
4866 ("hidestars" org-hide-leading-stars t)
4867 ("showstars" org-hide-leading-stars nil)
4868 ("odd" org-odd-levels-only t)
4869 ("oddeven" org-odd-levels-only nil)
4870 ("align" org-startup-align-all-tables t)
4871 ("noalign" org-startup-align-all-tables nil)
4872 ("inlineimages" org-startup-with-inline-images t)
4873 ("noinlineimages" org-startup-with-inline-images nil)
4874 ("latexpreview" org-startup-with-latex-preview t)
4875 ("nolatexpreview" org-startup-with-latex-preview nil)
4876 ("customtime" org-display-custom-times t)
4877 ("logdone" org-log-done time)
4878 ("lognotedone" org-log-done note)
4879 ("nologdone" org-log-done nil)
4880 ("lognoteclock-out" org-log-note-clock-out t)
4881 ("nolognoteclock-out" org-log-note-clock-out nil)
4882 ("logrepeat" org-log-repeat state)
4883 ("lognoterepeat" org-log-repeat note)
4884 ("logdrawer" org-log-into-drawer t)
4885 ("nologdrawer" org-log-into-drawer nil)
4886 ("logstatesreversed" org-log-states-order-reversed t)
4887 ("nologstatesreversed" org-log-states-order-reversed nil)
4888 ("nologrepeat" org-log-repeat nil)
4889 ("logreschedule" org-log-reschedule time)
4890 ("lognotereschedule" org-log-reschedule note)
4891 ("nologreschedule" org-log-reschedule nil)
4892 ("logredeadline" org-log-redeadline time)
4893 ("lognoteredeadline" org-log-redeadline note)
4894 ("nologredeadline" org-log-redeadline nil)
4895 ("logrefile" org-log-refile time)
4896 ("lognoterefile" org-log-refile note)
4897 ("nologrefile" org-log-refile nil)
4898 ("fninline" org-footnote-define-inline t)
4899 ("nofninline" org-footnote-define-inline nil)
4900 ("fnlocal" org-footnote-section nil)
4901 ("fnauto" org-footnote-auto-label t)
4902 ("fnprompt" org-footnote-auto-label nil)
4903 ("fnconfirm" org-footnote-auto-label confirm)
4904 ("fnplain" org-footnote-auto-label plain)
4905 ("fnadjust" org-footnote-auto-adjust t)
4906 ("nofnadjust" org-footnote-auto-adjust nil)
4907 ("constcgs" constants-unit-system cgs)
4908 ("constSI" constants-unit-system SI)
4909 ("noptag" org-tag-persistent-alist nil)
4910 ("hideblocks" org-hide-block-startup t)
4911 ("nohideblocks" org-hide-block-startup nil)
4912 ("beamer" org-startup-with-beamer-mode t)
4913 ("entitiespretty" org-pretty-entities t)
4914 ("entitiesplain" org-pretty-entities nil))
4915 "Variable associated with STARTUP options for org-mode.
4916 Each element is a list of three items: the startup options (as written
4917 in the #+STARTUP line), the corresponding variable, and the value to set
4918 this variable to if the option is found. An optional forth element PUSH
4919 means to push this value onto the list in the variable.")
4921 (defcustom org-group-tags t
4922 "When non-nil (the default), use group tags.
4923 This can be turned on/off through `org-toggle-tags-groups'."
4924 :group 'org-tags
4925 :group 'org-startup
4926 :type 'boolean)
4928 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4930 (defun org-toggle-tags-groups ()
4931 "Toggle support for group tags.
4932 Support for group tags is controlled by the option
4933 `org-group-tags', which is non-nil by default."
4934 (interactive)
4935 (setq org-group-tags (not org-group-tags))
4936 (cond ((and (derived-mode-p 'org-agenda-mode)
4937 org-group-tags)
4938 (org-agenda-redo))
4939 ((derived-mode-p 'org-mode)
4940 (let ((org-inhibit-startup t)) (org-mode))))
4941 (message "Groups tags support has been turned %s"
4942 (if org-group-tags "on" "off")))
4944 (defun org-set-regexps-and-options (&optional tags-only)
4945 "Precompute regular expressions used in the current buffer.
4946 When optional argument TAGS-ONLY is non-nil, only compute tags
4947 related expressions."
4948 (when (derived-mode-p 'org-mode)
4949 (let ((alist (org--setup-collect-keywords
4950 (org-make-options-regexp
4951 (append '("FILETAGS" "TAGS" "SETUPFILE")
4952 (and (not tags-only)
4953 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4954 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4955 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4956 (org--setup-process-tags
4957 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4958 (unless tags-only
4959 ;; File properties.
4960 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4961 ;; Archive location.
4962 (let ((archive (cdr (assq 'archive alist))))
4963 (when archive (org-set-local 'org-archive-location archive)))
4964 ;; Category.
4965 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4966 (when cat
4967 (org-set-local 'org-category (intern cat))
4968 (org-set-local 'org-file-properties
4969 (org--update-property-plist
4970 "CATEGORY" cat org-file-properties))))
4971 ;; Columns.
4972 (let ((column (cdr (assq 'columns alist))))
4973 (when column (org-set-local 'org-columns-default-format column)))
4974 ;; Constants.
4975 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4976 ;; Link abbreviations.
4977 (let ((links (cdr (assq 'link alist))))
4978 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4979 ;; Priorities.
4980 (let ((priorities (cdr (assq 'priorities alist))))
4981 (when priorities
4982 (org-set-local 'org-highest-priority (nth 0 priorities))
4983 (org-set-local 'org-lowest-priority (nth 1 priorities))
4984 (org-set-local 'org-default-priority (nth 2 priorities))))
4985 ;; Scripts.
4986 (let ((scripts (assq 'scripts alist)))
4987 (when scripts
4988 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
4989 ;; Startup options.
4990 (let ((startup (cdr (assq 'startup alist))))
4991 (dolist (option startup)
4992 (let ((entry (assoc-string option org-startup-options t)))
4993 (when entry
4994 (let ((var (nth 1 entry))
4995 (val (nth 2 entry)))
4996 (if (not (nth 3 entry)) (org-set-local var val)
4997 (unless (listp (symbol-value var))
4998 (org-set-local var nil))
4999 (add-to-list var val)))))))
5000 ;; TODO keywords.
5001 (org-set-local 'org-todo-kwd-alist nil)
5002 (org-set-local 'org-todo-key-alist nil)
5003 (org-set-local 'org-todo-key-trigger nil)
5004 (org-set-local 'org-todo-keywords-1 nil)
5005 (org-set-local 'org-done-keywords nil)
5006 (org-set-local 'org-todo-heads nil)
5007 (org-set-local 'org-todo-sets nil)
5008 (org-set-local 'org-todo-log-states nil)
5009 (let ((todo-sequences
5010 (or (nreverse (cdr (assq 'todo alist)))
5011 (let ((d (default-value 'org-todo-keywords)))
5012 (if (not (stringp (car d))) d
5013 ;; XXX: Backward compatibility code.
5014 (list (cons org-todo-interpretation d)))))))
5015 (dolist (sequence todo-sequences)
5016 (let* ((sequence (or (run-hook-with-args-until-success
5017 'org-todo-setup-filter-hook sequence)
5018 sequence))
5019 (sequence-type (car sequence))
5020 (keywords (cdr sequence))
5021 (sep (member "|" keywords))
5022 names alist)
5023 (dolist (k (remove "|" keywords))
5024 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5026 (error "Invalid TODO keyword %s" k))
5027 (let ((name (match-string 1 k))
5028 (key (match-string 2 k))
5029 (log (org-extract-log-state-settings k)))
5030 (push name names)
5031 (push (cons name (and key (string-to-char key))) alist)
5032 (when log (push log org-todo-log-states))))
5033 (let* ((names (nreverse names))
5034 (done (if sep (org-remove-keyword-keys (cdr sep))
5035 (last names)))
5036 (head (car names))
5037 (tail (list sequence-type head (car done) (org-last done))))
5038 (add-to-list 'org-todo-heads head 'append)
5039 (push names org-todo-sets)
5040 (setq org-done-keywords (append org-done-keywords done nil))
5041 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5042 (setq org-todo-key-alist
5043 (append org-todo-key-alist
5044 (and alist
5045 (append '((:startgroup))
5046 (nreverse alist)
5047 '((:endgroup))))))
5048 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5049 (setq org-todo-sets (nreverse org-todo-sets)
5050 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5051 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5052 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5053 ;; Compute the regular expressions and other local variables.
5054 ;; Using `org-outline-regexp-bol' would complicate them much,
5055 ;; because of the fixed white space at the end of that string.
5056 (if (not org-done-keywords)
5057 (setq org-done-keywords
5058 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5059 (setq org-not-done-keywords
5060 (org-delete-all org-done-keywords
5061 (copy-sequence org-todo-keywords-1))
5062 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5063 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5064 org-not-done-heading-regexp
5065 (format org-heading-keyword-regexp-format org-not-done-regexp)
5066 org-todo-line-regexp
5067 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5068 org-complex-heading-regexp
5069 (concat "^\\(\\*+\\)"
5070 "\\(?: +" org-todo-regexp "\\)?"
5071 "\\(?: +\\(\\[#.\\]\\)\\)?"
5072 "\\(?: +\\(.*?\\)\\)??"
5073 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5074 "[ \t]*$")
5075 org-complex-heading-regexp-format
5076 (concat "^\\(\\*+\\)"
5077 "\\(?: +" org-todo-regexp "\\)?"
5078 "\\(?: +\\(\\[#.\\]\\)\\)?"
5079 "\\(?: +"
5080 ;; Stats cookies can be stuck to body.
5081 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5082 "\\(%s\\)"
5083 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5084 "\\)"
5085 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5086 "[ \t]*$")
5087 org-todo-line-tags-regexp
5088 (concat "^\\(\\*+\\)"
5089 "\\(?: +" org-todo-regexp "\\)?"
5090 "\\(?: +\\(.*?\\)\\)??"
5091 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5092 "[ \t]*$"))
5093 (org-compute-latex-and-related-regexp)))))
5095 (defun org--setup-collect-keywords (regexp &optional files alist)
5096 "Return setup keywords values as an alist.
5098 REGEXP matches a subset of setup keywords. FILES is a list of
5099 file names already visited. It is used to avoid circular setup
5100 files. ALIST, when non-nil, is the alist computed so far.
5102 Return value contains the following keys: `archive', `category',
5103 `columns', `constants', `filetags', `link', `priorities',
5104 `property', `scripts', `startup', `tags' and `todo'."
5105 (org-with-wide-buffer
5106 (goto-char (point-min))
5107 (let ((case-fold-search t))
5108 (while (re-search-forward regexp nil t)
5109 (let ((element (org-element-at-point)))
5110 (when (eq (org-element-type element) 'keyword)
5111 (let ((key (org-element-property :key element))
5112 (value (org-element-property :value element)))
5113 (cond
5114 ((equal key "ARCHIVE")
5115 (when (org-string-nw-p value)
5116 (push (cons 'archive value) alist)))
5117 ((equal key "CATEGORY") (push (cons 'category value) alist))
5118 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5119 ((equal key "CONSTANTS")
5120 (let* ((constants (assq 'constants alist))
5121 (store (cdr constants)))
5122 (dolist (pair (org-split-string value))
5123 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5124 pair)
5125 (let* ((name (match-string 1 pair))
5126 (value (match-string 2 pair))
5127 (old (assoc name store)))
5128 (if old (setcdr old value)
5129 (push (cons name value) store)))))
5130 (if constants (setcdr constants store)
5131 (push (cons 'constants store) alist))))
5132 ((equal key "FILETAGS")
5133 (when (org-string-nw-p value)
5134 (let ((old (assq 'filetags alist))
5135 (new (apply #'nconc
5136 (mapcar (lambda (x) (org-split-string x ":"))
5137 (org-split-string value)))))
5138 (if old (setcdr old (append new (cdr old)))
5139 (push (cons 'filetags new) alist)))))
5140 ((equal key "LINK")
5141 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5142 (let ((links (assq 'link alist))
5143 (pair (cons (org-match-string-no-properties 1 value)
5144 (org-match-string-no-properties 2 value))))
5145 (if links (push pair (cdr links))
5146 (push (list 'link pair) alist)))))
5147 ((equal key "OPTIONS")
5148 (when (and (org-string-nw-p value)
5149 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5150 (push (cons 'scripts (read (match-string 1 value))) alist)))
5151 ((equal key "PRIORITIES")
5152 (push (cons 'priorities
5153 (let ((prio (org-split-string value)))
5154 (if (< (length prio) 3) '(?A ?C ?B)
5155 (mapcar #'string-to-char prio))))
5156 alist))
5157 ((equal key "PROPERTY")
5158 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5159 (let* ((property (assq 'property alist))
5160 (value (org--update-property-plist
5161 (org-match-string-no-properties 1 value)
5162 (org-match-string-no-properties 2 value)
5163 (cdr property))))
5164 (if property (setcdr property value)
5165 (push (cons 'property value) alist)))))
5166 ((equal key "STARTUP")
5167 (let ((startup (assq 'startup alist)))
5168 (if startup
5169 (setcdr startup
5170 (append (cdr startup) (org-split-string value)))
5171 (push (cons 'startup (org-split-string value)) alist))))
5172 ((equal key "TAGS")
5173 (let ((tag-cell (assq 'tags alist)))
5174 (if tag-cell
5175 (setcdr tag-cell
5176 (append (cdr tag-cell)
5177 '("\\n")
5178 (org-split-string value)))
5179 (push (cons 'tags (org-split-string value)) alist))))
5180 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5181 (let ((todo (assq 'todo alist))
5182 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5183 (org-split-string value))))
5184 (if todo (push value (cdr todo))
5185 (push (list 'todo value) alist))))
5186 ((equal key "SETUPFILE")
5187 (unless buffer-read-only ; Do not check in Gnus messages.
5188 (let ((f (and (org-string-nw-p value)
5189 (expand-file-name
5190 (org-remove-double-quotes value)))))
5191 (when (and f (file-readable-p f) (not (member f files)))
5192 (with-temp-buffer
5193 (insert-file-contents f)
5194 (setq alist
5195 ;; Fake Org mode to benefit from cache
5196 ;; without recurring needlessly.
5197 (let ((major-mode 'org-mode))
5198 (org--setup-collect-keywords
5199 regexp (cons f files) alist)))))))))))))))
5200 alist)
5202 (defun org--setup-process-tags (tags filetags)
5203 "Precompute variables used for tags.
5204 TAGS is a list of tags and tag group symbols, as strings.
5205 FILETAGS is a list of tags, as strings."
5206 ;; Process the file tags.
5207 (org-set-local 'org-file-tags
5208 (mapcar #'org-add-prop-inherited filetags))
5209 ;; Provide default tags if no local tags are found.
5210 (when (and (not tags) org-tag-alist)
5211 (setq tags
5212 (mapcar (lambda (tag)
5213 (case (car tag)
5214 (:startgroup "{")
5215 (:endgroup "}")
5216 (:startgrouptag "[")
5217 (:endgrouptag "]")
5218 (:grouptags ":")
5219 (:newline "\\n")
5220 (otherwise (concat (car tag)
5221 (and (characterp (cdr tag))
5222 (format "(%c)" (cdr tag)))))))
5223 org-tag-alist)))
5224 ;; Process the tags.
5225 (org-set-local 'org-tag-groups-alist nil)
5226 (org-set-local 'org-tag-alist nil)
5227 (let (group-flag)
5228 (while tags
5229 (let ((e (car tags)))
5230 (setq tags (cdr tags))
5231 (cond
5232 ((equal e "{")
5233 (push '(:startgroup) org-tag-alist)
5234 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5235 ((equal e "}")
5236 (push '(:endgroup) org-tag-alist)
5237 (setq group-flag nil))
5238 ((equal e "[")
5239 (push '(:startgrouptag) org-tag-alist)
5240 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5241 ((equal e "]")
5242 (push '(:endgrouptag) org-tag-alist)
5243 (setq group-flag nil))
5244 ((equal e ":")
5245 (push '(:grouptags) org-tag-alist)
5246 (setq group-flag 'append))
5247 ((equal e "\\n") (push '(:newline) org-tag-alist))
5248 ((string-match
5249 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5250 "\\|{.+?}\\)" ; regular expression
5251 "\\(?:(\\(.\\))\\)?\\'")) e)
5252 (let ((tag (match-string 1 e))
5253 (key (and (match-beginning 2)
5254 (string-to-char (match-string 2 e)))))
5255 (cond ((eq group-flag 'append)
5256 (setcar org-tag-groups-alist
5257 (append (car org-tag-groups-alist) (list tag))))
5258 (group-flag (push (list tag) org-tag-groups-alist)))
5259 ;; Push all tags in groups, no matter if they already exist.
5260 (unless (and (not group-flag) (assoc tag org-tag-alist))
5261 (push (cons tag key) org-tag-alist))))))))
5262 (setq org-tag-alist (nreverse org-tag-alist)))
5264 (defun org-file-contents (file &optional noerror)
5265 "Return the contents of FILE, as a string."
5266 (if (and file (file-readable-p file))
5267 (with-temp-buffer
5268 (insert-file-contents file)
5269 (buffer-string))
5270 (funcall (if noerror 'message 'error)
5271 "Cannot read file \"%s\"%s"
5272 file
5273 (let ((from (buffer-file-name (buffer-base-buffer))))
5274 (if from (concat " (referenced in file \"" from "\")") "")))))
5276 (defun org-extract-log-state-settings (x)
5277 "Extract the log state setting from a TODO keyword string.
5278 This will extract info from a string like \"WAIT(w@/!)\"."
5279 (let (kw key log1 log2)
5280 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5281 (setq kw (match-string 1 x)
5282 key (and (match-end 2) (match-string 2 x))
5283 log1 (and (match-end 3) (match-string 3 x))
5284 log2 (and (match-end 4) (match-string 4 x)))
5285 (and (or log1 log2)
5286 (list kw
5287 (and log1 (if (equal log1 "!") 'time 'note))
5288 (and log2 (if (equal log2 "!") 'time 'note)))))))
5290 (defun org-remove-keyword-keys (list)
5291 "Remove a pair of parenthesis at the end of each string in LIST."
5292 (mapcar (lambda (x)
5293 (if (string-match "(.*)$" x)
5294 (substring x 0 (match-beginning 0))
5296 list))
5298 (defun org-assign-fast-keys (alist)
5299 "Assign fast keys to a keyword-key alist.
5300 Respect keys that are already there."
5301 (let (new e (alt ?0))
5302 (while (setq e (pop alist))
5303 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5304 (cdr e)) ;; Key already assigned.
5305 (push e new)
5306 (let ((clist (string-to-list (downcase (car e))))
5307 (used (append new alist)))
5308 (when (= (car clist) ?@)
5309 (pop clist))
5310 (while (and clist (rassoc (car clist) used))
5311 (pop clist))
5312 (unless clist
5313 (while (rassoc alt used)
5314 (incf alt)))
5315 (push (cons (car e) (or (car clist) alt)) new))))
5316 (nreverse new)))
5318 ;;; Some variables used in various places
5320 (defvar org-window-configuration nil
5321 "Used in various places to store a window configuration.")
5322 (defvar org-selected-window nil
5323 "Used in various places to store a window configuration.")
5324 (defvar org-finish-function nil
5325 "Function to be called when `C-c C-c' is used.
5326 This is for getting out of special buffers like capture.")
5329 ;; FIXME: Occasionally check by commenting these, to make sure
5330 ;; no other functions uses these, forgetting to let-bind them.
5331 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5332 (defvar org-last-state)
5333 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5335 ;; Defined somewhere in this file, but used before definition.
5336 (defvar org-entities) ;; defined in org-entities.el
5337 (defvar org-struct-menu)
5338 (defvar org-org-menu)
5339 (defvar org-tbl-menu)
5341 ;;;; Define the Org-mode
5343 ;; We use a before-change function to check if a table might need
5344 ;; an update.
5345 (defvar org-table-may-need-update t
5346 "Indicates that a table might need an update.
5347 This variable is set by `org-before-change-function'.
5348 `org-table-align' sets it back to nil.")
5349 (defun org-before-change-function (beg end)
5350 "Every change indicates that a table might need an update."
5351 (setq org-table-may-need-update t))
5352 (defvar org-mode-map)
5353 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5354 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5355 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5356 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5357 (defvar org-table-buffer-is-an nil)
5359 (defvar bidi-paragraph-direction)
5360 (defvar buffer-face-mode-face)
5362 (require 'outline)
5363 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5364 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
5365 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5367 ;; Other stuff we need.
5368 (require 'time-date)
5369 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5370 (require 'easymenu)
5371 (autoload 'easy-menu-add "easymenu")
5372 (require 'overlay)
5374 ;; (require 'org-macs) moved higher up in the file before it is first used
5375 (require 'org-entities)
5376 ;; (require 'org-compat) moved higher up in the file before it is first used
5377 (require 'org-faces)
5378 (require 'org-list)
5379 (require 'org-pcomplete)
5380 (require 'org-src)
5381 (require 'org-footnote)
5382 (require 'org-macro)
5384 ;; babel
5385 (require 'ob)
5387 ;;;###autoload
5388 (define-derived-mode org-mode outline-mode "Org"
5389 "Outline-based notes management and organizer, alias
5390 \"Carsten's outline-mode for keeping track of everything.\"
5392 Org-mode develops organizational tasks around a NOTES file which
5393 contains information about projects as plain text. Org-mode is
5394 implemented on top of outline-mode, which is ideal to keep the content
5395 of large files well structured. It supports ToDo items, deadlines and
5396 time stamps, which magically appear in the diary listing of the Emacs
5397 calendar. Tables are easily created with a built-in table editor.
5398 Plain text URL-like links connect to websites, emails (VM), Usenet
5399 messages (Gnus), BBDB entries, and any files related to the project.
5400 For printing and sharing of notes, an Org-mode file (or a part of it)
5401 can be exported as a structured ASCII or HTML file.
5403 The following commands are available:
5405 \\{org-mode-map}"
5407 ;; Get rid of Outline menus, they are not needed
5408 ;; Need to do this here because define-derived-mode sets up
5409 ;; the keymap so late. Still, it is a waste to call this each time
5410 ;; we switch another buffer into org-mode.
5411 (if (featurep 'xemacs)
5412 (when (boundp 'outline-mode-menu-heading)
5413 ;; Assume this is Greg's port, it uses easymenu
5414 (easy-menu-remove outline-mode-menu-heading)
5415 (easy-menu-remove outline-mode-menu-show)
5416 (easy-menu-remove outline-mode-menu-hide))
5417 (define-key org-mode-map [menu-bar headings] 'undefined)
5418 (define-key org-mode-map [menu-bar hide] 'undefined)
5419 (define-key org-mode-map [menu-bar show] 'undefined))
5421 (org-load-modules-maybe)
5422 (easy-menu-add org-org-menu)
5423 (easy-menu-add org-tbl-menu)
5424 (org-install-agenda-files-menu)
5425 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5426 (add-to-invisibility-spec '(org-cwidth))
5427 (add-to-invisibility-spec '(org-hide-block . t))
5428 (when (featurep 'xemacs)
5429 (org-set-local 'line-move-ignore-invisible t))
5430 (org-set-local 'outline-regexp org-outline-regexp)
5431 (org-set-local 'outline-level 'org-outline-level)
5432 (setq bidi-paragraph-direction 'left-to-right)
5433 (when (and org-ellipsis
5434 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5435 (fboundp 'make-glyph-code))
5436 (unless org-display-table
5437 (setq org-display-table (make-display-table)))
5438 (set-display-table-slot
5439 org-display-table 4
5440 (vconcat (mapcar
5441 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5442 org-ellipsis)))
5443 (if (stringp org-ellipsis) org-ellipsis "..."))))
5444 (setq buffer-display-table org-display-table))
5445 (org-set-regexps-and-options)
5446 (org-set-font-lock-defaults)
5447 (when (and org-tag-faces (not org-tags-special-faces-re))
5448 ;; tag faces set outside customize.... force initialization.
5449 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5450 ;; Calc embedded
5451 (org-set-local 'calc-embedded-open-mode "# ")
5452 ;; Modify a few syntax entries
5453 (modify-syntax-entry ?@ "w")
5454 (modify-syntax-entry ?\" "\"")
5455 (modify-syntax-entry ?\\ "_")
5456 (modify-syntax-entry ?~ "_")
5457 (if org-startup-truncated (setq truncate-lines t))
5458 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5459 (org-set-local 'font-lock-unfontify-region-function
5460 'org-unfontify-region)
5461 ;; Activate before-change-function
5462 (org-set-local 'org-table-may-need-update t)
5463 (org-add-hook 'before-change-functions 'org-before-change-function nil
5464 'local)
5465 ;; Check for running clock before killing a buffer
5466 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5467 ;; Initialize macros templates.
5468 (org-macro-initialize-templates)
5469 ;; Initialize radio targets.
5470 (org-update-radio-target-regexp)
5471 ;; Indentation.
5472 (org-set-local 'indent-line-function 'org-indent-line)
5473 (org-set-local 'indent-region-function 'org-indent-region)
5474 ;; Filling and auto-filling.
5475 (org-setup-filling)
5476 ;; Comments.
5477 (org-setup-comments-handling)
5478 ;; Initialize cache.
5479 (org-element-cache-reset)
5480 ;; Beginning/end of defun
5481 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5482 (org-set-local 'end-of-defun-function
5483 (lambda ()
5484 (if (not (org-at-heading-p))
5485 (org-forward-element)
5486 (org-forward-element)
5487 (forward-char -1))))
5488 ;; Next error for sparse trees
5489 (org-set-local 'next-error-function 'org-occur-next-match)
5490 ;; Make sure dependence stuff works reliably, even for users who set it
5491 ;; too late :-(
5492 (if org-enforce-todo-dependencies
5493 (add-hook 'org-blocker-hook
5494 'org-block-todo-from-children-or-siblings-or-parent)
5495 (remove-hook 'org-blocker-hook
5496 'org-block-todo-from-children-or-siblings-or-parent))
5497 (if org-enforce-todo-checkbox-dependencies
5498 (add-hook 'org-blocker-hook
5499 'org-block-todo-from-checkboxes)
5500 (remove-hook 'org-blocker-hook
5501 'org-block-todo-from-checkboxes))
5503 ;; Align options lines
5504 (org-set-local
5505 'align-mode-rules-list
5506 '((org-in-buffer-settings
5507 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5508 (modes . '(org-mode)))))
5510 ;; Imenu
5511 (org-set-local 'imenu-create-index-function
5512 'org-imenu-get-tree)
5514 ;; Make isearch reveal context
5515 (if (or (featurep 'xemacs)
5516 (not (boundp 'outline-isearch-open-invisible-function)))
5517 ;; Emacs 21 and XEmacs make use of the hook
5518 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5519 ;; Emacs 22 deals with this through a special variable
5520 (org-set-local 'outline-isearch-open-invisible-function
5521 (lambda (&rest ignore) (org-show-context 'isearch))))
5523 ;; Setup the pcomplete hooks
5524 (set (make-local-variable 'pcomplete-command-completion-function)
5525 'org-pcomplete-initial)
5526 (set (make-local-variable 'pcomplete-command-name-function)
5527 'org-command-at-point)
5528 (set (make-local-variable 'pcomplete-default-completion-function)
5529 'ignore)
5530 (set (make-local-variable 'pcomplete-parse-arguments-function)
5531 'org-parse-arguments)
5532 (set (make-local-variable 'pcomplete-termination-string) "")
5533 (when (>= emacs-major-version 23)
5534 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5536 ;; If empty file that did not turn on org-mode automatically, make it to.
5537 (if (and org-insert-mode-line-in-empty-file
5538 (org-called-interactively-p 'any)
5539 (= (point-min) (point-max)))
5540 (insert "# -*- mode: org -*-\n\n"))
5541 (unless org-inhibit-startup
5542 (org-unmodified
5543 (and org-startup-with-beamer-mode (org-beamer-mode))
5544 (when org-startup-align-all-tables
5545 (org-table-map-tables 'org-table-align 'quietly))
5546 (when org-startup-with-inline-images
5547 (org-display-inline-images))
5548 (when org-startup-with-latex-preview
5549 (org-toggle-latex-fragment))
5550 (unless org-inhibit-startup-visibility-stuff
5551 (org-set-startup-visibility))
5552 (org-refresh-effort-properties)))
5553 ;; Try to set org-hide correctly
5554 (let ((foreground (org-find-invisible-foreground)))
5555 (if foreground
5556 (set-face-foreground 'org-hide foreground))))
5558 ;; Update `customize-package-emacs-version-alist'
5559 (add-to-list 'customize-package-emacs-version-alist
5560 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5561 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5562 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5564 (defvar org-mode-transpose-word-syntax-table
5565 (let ((st (make-syntax-table text-mode-syntax-table)))
5566 (mapc (lambda(c) (modify-syntax-entry
5567 (string-to-char (car c)) "w p" st))
5568 org-emphasis-alist)
5569 st))
5571 (when (fboundp 'abbrev-table-put)
5572 (abbrev-table-put org-mode-abbrev-table
5573 :parents (list text-mode-abbrev-table)))
5575 (defun org-find-invisible-foreground ()
5576 (let ((candidates (remove
5577 "unspecified-bg"
5578 (nconc
5579 (list (face-background 'default)
5580 (face-background 'org-default))
5581 (mapcar
5582 (lambda (alist)
5583 (when (boundp alist)
5584 (cdr (assoc 'background-color (symbol-value alist)))))
5585 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5586 (list (face-foreground 'org-hide))))))
5587 (car (remove nil candidates))))
5589 (defun org-current-time (&optional rounding-minutes past)
5590 "Current time, possibly rounded to ROUNDING-MINUTES.
5591 When ROUNDING-MINUTES is not an integer, fall back on the car of
5592 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5593 the rounding returns a past time."
5594 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5595 (car org-time-stamp-rounding-minutes)))
5596 (time (decode-time)) res)
5597 (if (< r 1)
5598 (current-time)
5599 (setq res
5600 (apply 'encode-time
5601 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5602 (nthcdr 2 time))))
5603 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5604 (seconds-to-time (- (org-float-time res) (* r 60)))
5605 res))))
5607 (defun org-today ()
5608 "Return today date, considering `org-extend-today-until'."
5609 (time-to-days
5610 (time-subtract (current-time)
5611 (list 0 (* 3600 org-extend-today-until) 0))))
5613 ;;;; Font-Lock stuff, including the activators
5615 (defvar org-mouse-map (make-sparse-keymap))
5616 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5617 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5618 (when org-mouse-1-follows-link
5619 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5620 (when org-tab-follows-link
5621 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5622 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5624 (require 'font-lock)
5626 (defconst org-non-link-chars "]\t\n\r<>")
5627 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5628 "file+sys" "news" "shell" "elisp" "doi" "message"
5629 "help"))
5630 (defvar org-link-types-re nil
5631 "Matches a link that has a url-like prefix like \"http:\"")
5632 (defvar org-link-re-with-space nil
5633 "Matches a link with spaces, optional angular brackets around it.")
5634 (defvar org-link-re-with-space2 nil
5635 "Matches a link with spaces, optional angular brackets around it.")
5636 (defvar org-link-re-with-space3 nil
5637 "Matches a link with spaces, only for internal part in bracket links.")
5638 (defvar org-angle-link-re nil
5639 "Matches link with angular brackets, spaces are allowed.")
5640 (defvar org-plain-link-re nil
5641 "Matches plain link, without spaces.")
5642 (defvar org-bracket-link-regexp nil
5643 "Matches a link in double brackets.")
5644 (defvar org-bracket-link-analytic-regexp nil
5645 "Regular expression used to analyze links.
5646 Here is what the match groups contain after a match:
5647 1: http:
5648 2: http
5649 3: path
5650 4: [desc]
5651 5: desc")
5652 (defvar org-bracket-link-analytic-regexp++ nil
5653 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5654 (defvar org-any-link-re nil
5655 "Regular expression matching any link.")
5657 (defconst org-match-sexp-depth 3
5658 "Number of stacked braces for sub/superscript matching.")
5660 (defun org-create-multibrace-regexp (left right n)
5661 "Create a regular expression which will match a balanced sexp.
5662 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5663 as single character strings.
5664 The regexp returned will match the entire expression including the
5665 delimiters. It will also define a single group which contains the
5666 match except for the outermost delimiters. The maximum depth of
5667 stacked delimiters is N. Escaping delimiters is not possible."
5668 (let* ((nothing (concat "[^" left right "]*?"))
5669 (or "\\|")
5670 (re nothing)
5671 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5672 (while (> n 1)
5673 (setq n (1- n)
5674 re (concat re or next)
5675 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5676 (concat left "\\(" re "\\)" right)))
5678 (defconst org-match-substring-regexp
5679 (concat
5680 "\\(\\S-\\)\\([_^]\\)\\("
5681 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5682 "\\|"
5683 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5684 "\\|"
5685 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5686 "The regular expression matching a sub- or superscript.")
5688 (defconst org-match-substring-with-braces-regexp
5689 (concat
5690 "\\(\\S-\\)\\([_^]\\)"
5691 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5692 "The regular expression matching a sub- or superscript, forcing braces.")
5694 (defun org-make-link-regexps ()
5695 "Update the link regular expressions.
5696 This should be called after the variable `org-link-types' has changed."
5697 (let ((types-re (regexp-opt org-link-types t)))
5698 (setq org-link-types-re
5699 (concat "\\`" types-re ":")
5700 org-link-re-with-space
5701 (concat "<?" types-re ":"
5702 "\\([^" org-non-link-chars " ]"
5703 "[^" org-non-link-chars "]*"
5704 "[^" org-non-link-chars " ]\\)>?")
5705 org-link-re-with-space2
5706 (concat "<?" types-re ":"
5707 "\\([^" org-non-link-chars " ]"
5708 "[^\t\n\r]*"
5709 "[^" org-non-link-chars " ]\\)>?")
5710 org-link-re-with-space3
5711 (concat "<?" types-re ":"
5712 "\\([^" org-non-link-chars " ]"
5713 "[^\t\n\r]*\\)")
5714 org-angle-link-re
5715 (format "<%s:\\(\n?\\(?:[^>\n]+\n?\\)*\\)>" types-re)
5716 org-plain-link-re
5717 (concat
5718 "\\<" types-re ":"
5719 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5720 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5721 org-bracket-link-regexp
5722 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5723 org-bracket-link-analytic-regexp
5724 (concat
5725 "\\[\\["
5726 "\\(" types-re ":\\)?"
5727 "\\([^]]+\\)"
5728 "\\]"
5729 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5730 "\\]")
5731 org-bracket-link-analytic-regexp++
5732 (concat
5733 "\\[\\["
5734 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5735 "\\([^]]+\\)"
5736 "\\]"
5737 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5738 "\\]")
5739 org-any-link-re
5740 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5741 org-angle-link-re "\\)\\|\\("
5742 org-plain-link-re "\\)"))))
5744 (org-make-link-regexps)
5746 (defvar org-emph-face nil)
5748 (defun org-do-emphasis-faces (limit)
5749 "Run through the buffer and emphasize strings."
5750 (let (rtn a)
5751 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5752 (let* ((border (char-after (match-beginning 3)))
5753 (bre (regexp-quote (char-to-string border))))
5754 (if (and (not (= border (char-after (match-beginning 4))))
5755 (not (save-match-data
5756 (string-match (concat bre ".*" bre)
5757 (replace-regexp-in-string
5758 "\n" " "
5759 (substring (match-string 2) 1 -1))))))
5760 (progn
5761 (setq rtn t)
5762 (setq a (assoc (match-string 3) org-emphasis-alist))
5763 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5764 'face
5765 (nth 1 a))
5766 (and (nth 2 a)
5767 (org-remove-flyspell-overlays-in
5768 (match-beginning 0) (match-end 0)))
5769 (add-text-properties (match-beginning 2) (match-end 2)
5770 '(font-lock-multiline t org-emphasis t))
5771 (when org-hide-emphasis-markers
5772 (add-text-properties (match-end 4) (match-beginning 5)
5773 '(invisible org-link))
5774 (add-text-properties (match-beginning 3) (match-end 3)
5775 '(invisible org-link))))))
5776 (goto-char (1+ (match-beginning 0))))
5777 rtn))
5779 (defun org-emphasize (&optional char)
5780 "Insert or change an emphasis, i.e. a font like bold or italic.
5781 If there is an active region, change that region to a new emphasis.
5782 If there is no region, just insert the marker characters and position
5783 the cursor between them.
5784 CHAR should be the marker character. If it is a space, it means to
5785 remove the emphasis of the selected region.
5786 If CHAR is not given (for example in an interactive call) it will be
5787 prompted for."
5788 (interactive)
5789 (let ((erc org-emphasis-regexp-components)
5790 (prompt "")
5791 (string "") beg end move c s)
5792 (if (org-region-active-p)
5793 (setq beg (region-beginning) end (region-end)
5794 string (buffer-substring beg end))
5795 (setq move t))
5797 (unless char
5798 (message "Emphasis marker or tag: [%s]"
5799 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5800 (setq char (read-char-exclusive)))
5801 (if (equal char ?\ )
5802 (setq s "" move nil)
5803 (unless (assoc (char-to-string char) org-emphasis-alist)
5804 (user-error "No such emphasis marker: \"%c\"" char))
5805 (setq s (char-to-string char)))
5806 (while (and (> (length string) 1)
5807 (equal (substring string 0 1) (substring string -1))
5808 (assoc (substring string 0 1) org-emphasis-alist))
5809 (setq string (substring string 1 -1)))
5810 (setq string (concat s string s))
5811 (if beg (delete-region beg end))
5812 (unless (or (bolp)
5813 (string-match (concat "[" (nth 0 erc) "\n]")
5814 (char-to-string (char-before (point)))))
5815 (insert " "))
5816 (unless (or (eobp)
5817 (string-match (concat "[" (nth 1 erc) "\n]")
5818 (char-to-string (char-after (point)))))
5819 (insert " ") (backward-char 1))
5820 (insert string)
5821 (and move (backward-char 1))))
5823 (defconst org-nonsticky-props
5824 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5826 (defsubst org-rear-nonsticky-at (pos)
5827 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5829 (defun org-activate-plain-links (limit)
5830 "Add link properties for plain links."
5831 (let (f hl)
5832 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5833 (not (member 'org-tag
5834 (get-text-property (1- (match-beginning 0)) 'face)))
5835 (not (org-in-src-block-p)))
5836 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5837 (setq f (get-text-property (match-beginning 0) 'face))
5838 (setq hl (org-match-string-no-properties 0))
5839 (if (or (eq f 'org-tag)
5840 (and (listp f) (memq 'org-tag f)))
5842 (add-text-properties (match-beginning 0) (match-end 0)
5843 (list 'mouse-face 'highlight
5844 'face 'org-link
5845 'htmlize-link `(:uri ,hl)
5846 'keymap org-mouse-map))
5847 (org-rear-nonsticky-at (match-end 0)))
5848 t)))
5850 (defun org-activate-code (limit)
5851 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5852 (progn
5853 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5854 (remove-text-properties (match-beginning 0) (match-end 0)
5855 '(display t invisible t intangible t))
5856 t)))
5858 (defcustom org-src-fontify-natively t
5859 "When non-nil, fontify code in code blocks."
5860 :type 'boolean
5861 :version "24.4"
5862 :package-version '(Org . "8.3")
5863 :group 'org-appearance
5864 :group 'org-babel)
5866 (defcustom org-allow-promoting-top-level-subtree nil
5867 "When non-nil, allow promoting a top level subtree.
5868 The leading star of the top level headline will be replaced
5869 by a #."
5870 :type 'boolean
5871 :version "24.1"
5872 :group 'org-appearance)
5874 (defun org-fontify-meta-lines-and-blocks (limit)
5875 (condition-case nil
5876 (org-fontify-meta-lines-and-blocks-1 limit)
5877 (error (message "org-mode fontification error"))))
5879 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5880 "Fontify #+ lines and blocks."
5881 (let ((case-fold-search t))
5882 (if (re-search-forward
5883 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5884 limit t)
5885 (let ((beg (match-beginning 0))
5886 (block-start (match-end 0))
5887 (block-end nil)
5888 (lang (match-string 7))
5889 (beg1 (line-beginning-position 2))
5890 (dc1 (downcase (match-string 2)))
5891 (dc3 (downcase (match-string 3)))
5892 end end1 quoting block-type ovl)
5893 (cond
5894 ((and (match-end 4) (equal dc3 "+begin"))
5895 ;; Truly a block
5896 (setq block-type (downcase (match-string 5))
5897 quoting (member block-type org-protecting-blocks))
5898 (when (re-search-forward
5899 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5900 nil t) ;; on purpose, we look further than LIMIT
5901 (setq end (min (point-max) (match-end 0))
5902 end1 (min (point-max) (1- (match-beginning 0))))
5903 (setq block-end (match-beginning 0))
5904 (when quoting
5905 (org-remove-flyspell-overlays-in beg1 end1)
5906 (remove-text-properties beg end
5907 '(display t invisible t intangible t)))
5908 (add-text-properties
5909 beg end '(font-lock-fontified t font-lock-multiline t))
5910 (add-text-properties beg beg1 '(face org-meta-line))
5911 (org-remove-flyspell-overlays-in beg beg1)
5912 (add-text-properties ; For end_src
5913 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5914 (org-remove-flyspell-overlays-in end1 end)
5915 (cond
5916 ((and lang (not (string= lang "")) org-src-fontify-natively)
5917 (org-src-font-lock-fontify-block lang block-start block-end)
5918 (add-text-properties beg1 block-end '(src-block t)))
5919 (quoting
5920 (add-text-properties beg1 (min (point-max) (1+ end1))
5921 '(face org-block))) ; end of source block
5922 ((not org-fontify-quote-and-verse-blocks))
5923 ((string= block-type "quote")
5924 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5925 ((string= block-type "verse")
5926 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5927 (add-text-properties beg beg1 '(face org-block-begin-line))
5928 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5929 '(face org-block-end-line))
5931 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5932 (org-remove-flyspell-overlays-in
5933 (match-beginning 0)
5934 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5935 (add-text-properties
5936 beg (match-end 3)
5937 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5938 '(font-lock-fontified t invisible t)
5939 '(font-lock-fontified t face org-document-info-keyword)))
5940 (add-text-properties
5941 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5942 (if (string-equal dc1 "+title:")
5943 '(font-lock-fontified t face org-document-title)
5944 '(font-lock-fontified t face org-document-info))))
5945 ((equal dc1 "+caption:")
5946 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5947 (remove-text-properties (match-beginning 0) (match-end 0)
5948 '(display t invisible t intangible t))
5949 (add-text-properties (match-beginning 1) (match-end 3)
5950 '(font-lock-fontified t face org-meta-line))
5951 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5952 '(font-lock-fontified t face org-block))
5954 ((member dc3 '(" " ""))
5955 (org-remove-flyspell-overlays-in beg (match-end 0))
5956 (add-text-properties
5957 beg (match-end 0)
5958 '(font-lock-fontified t face font-lock-comment-face)))
5959 (t ;; just any other in-buffer setting, but not indented
5960 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5961 (remove-text-properties (match-beginning 0) (match-end 0)
5962 '(display t invisible t intangible t))
5963 (add-text-properties beg (match-end 0)
5964 '(font-lock-fontified t face org-meta-line))
5965 t))))))
5967 (defun org-fontify-drawers (limit)
5968 "Fontify drawers."
5969 (when (re-search-forward org-drawer-regexp limit t)
5970 (add-text-properties
5971 (match-beginning 0) (match-end 0)
5972 '(font-lock-fontified t face org-special-keyword))
5973 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5976 (defun org-fontify-macros (limit)
5977 "Fontify macros."
5978 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5979 (add-text-properties
5980 (match-beginning 0) (match-end 0)
5981 '(font-lock-fontified t face org-macro))
5982 (when org-hide-macro-markers
5983 (add-text-properties (match-end 2) (match-beginning 2)
5984 '(invisible t))
5985 (add-text-properties (match-beginning 1) (match-end 1)
5986 '(invisible t)))
5987 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5990 (defun org-activate-angle-links (limit)
5991 "Add text properties for angle links."
5992 (if (and (re-search-forward org-angle-link-re limit t)
5993 (not (org-in-src-block-p)))
5994 (progn
5995 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5996 (add-text-properties (match-beginning 0) (match-end 0)
5997 (list 'mouse-face 'highlight
5998 'keymap org-mouse-map
5999 'font-lock-multiline t))
6000 (org-rear-nonsticky-at (match-end 0))
6001 t)))
6003 (defun org-activate-footnote-links (limit)
6004 "Add text properties for footnotes."
6005 (let ((fn (org-footnote-next-reference-or-definition limit)))
6006 (when fn
6007 (let* ((beg (nth 1 fn))
6008 (end (nth 2 fn))
6009 (label (car fn))
6010 (referencep (/= (line-beginning-position) beg)))
6011 (when (and referencep (nth 3 fn))
6012 (save-excursion
6013 (goto-char beg)
6014 (search-forward (or label "fn:"))
6015 (org-remove-flyspell-overlays-in beg (match-end 0))))
6016 (add-text-properties beg end
6017 (list 'mouse-face 'highlight
6018 'keymap org-mouse-map
6019 'help-echo
6020 (if referencep "Footnote reference"
6021 "Footnote definition")
6022 'font-lock-fontified t
6023 'font-lock-multiline t
6024 'face 'org-footnote))))))
6026 (defun org-activate-bracket-links (limit)
6027 "Add text properties for bracketed links."
6028 (if (and (re-search-forward org-bracket-link-regexp limit t)
6029 (not (org-in-src-block-p)))
6030 (let* ((hl (org-match-string-no-properties 1))
6031 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6032 (ip (org-maybe-intangible
6033 (list 'invisible 'org-link
6034 'keymap org-mouse-map 'mouse-face 'highlight
6035 'font-lock-multiline t 'help-echo help
6036 'htmlize-link `(:uri ,hl))))
6037 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6038 'font-lock-multiline t 'help-echo help
6039 'htmlize-link `(:uri ,hl))))
6040 ;; We need to remove the invisible property here. Table narrowing
6041 ;; may have made some of this invisible.
6042 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6043 (remove-text-properties (match-beginning 0) (match-end 0)
6044 '(invisible nil))
6045 (if (match-end 3)
6046 (progn
6047 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6048 (org-rear-nonsticky-at (match-beginning 3))
6049 (add-text-properties (match-beginning 3) (match-end 3) vp)
6050 (org-rear-nonsticky-at (match-end 3))
6051 (add-text-properties (match-end 3) (match-end 0) ip)
6052 (org-rear-nonsticky-at (match-end 0)))
6053 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6054 (org-rear-nonsticky-at (match-beginning 1))
6055 (add-text-properties (match-beginning 1) (match-end 1) vp)
6056 (org-rear-nonsticky-at (match-end 1))
6057 (add-text-properties (match-end 1) (match-end 0) ip)
6058 (org-rear-nonsticky-at (match-end 0)))
6059 t)))
6061 (defun org-activate-dates (limit)
6062 "Add text properties for dates."
6063 (if (and (re-search-forward org-tsr-regexp-both limit t)
6064 (not (equal (char-before (match-beginning 0)) 91)))
6065 (progn
6066 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6067 (add-text-properties (match-beginning 0) (match-end 0)
6068 (list 'mouse-face 'highlight
6069 'keymap org-mouse-map))
6070 (org-rear-nonsticky-at (match-end 0))
6071 (when org-display-custom-times
6072 (if (match-end 3)
6073 (org-display-custom-time (match-beginning 3) (match-end 3)))
6074 (org-display-custom-time (match-beginning 1) (match-end 1)))
6075 t)))
6077 (defvar org-target-link-regexp nil
6078 "Regular expression matching radio targets in plain text.")
6079 (make-variable-buffer-local 'org-target-link-regexp)
6081 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6082 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6083 border border border))
6084 "Regular expression matching a link target.")
6086 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6087 "Regular expression matching a radio target.")
6089 (defconst org-any-target-regexp
6090 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6091 "Regular expression matching any target.")
6093 (defun org-activate-target-links (limit)
6094 "Add text properties for target matches."
6095 (when org-target-link-regexp
6096 (let ((case-fold-search t))
6097 (if (re-search-forward org-target-link-regexp limit t)
6098 (progn
6099 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6100 (add-text-properties (match-beginning 1) (match-end 1)
6101 (list 'mouse-face 'highlight
6102 'keymap org-mouse-map
6103 'help-echo "Radio target link"
6104 'org-linked-text t))
6105 (org-rear-nonsticky-at (match-end 1))
6106 t)))))
6108 (defun org-update-radio-target-regexp ()
6109 "Find all radio targets in this file and update the regular expression.
6110 Also refresh fontification if needed."
6111 (interactive)
6112 (let ((old-regexp org-target-link-regexp)
6113 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6114 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6115 (targets
6116 (org-with-wide-buffer
6117 (goto-char (point-min))
6118 (let (rtn)
6119 (while (re-search-forward org-radio-target-regexp nil t)
6120 ;; Make sure point is really within the object.
6121 (backward-char)
6122 (let ((obj (org-element-context)))
6123 (when (eq (org-element-type obj) 'radio-target)
6124 (add-to-list 'rtn (org-element-property :value obj)))))
6125 rtn))))
6126 (setq org-target-link-regexp
6127 (and targets
6128 (concat before-re
6129 (mapconcat
6130 (lambda (x)
6131 (replace-regexp-in-string
6132 " +" "\\s-+" (regexp-quote x) t t))
6133 targets
6134 "\\|")
6135 after-re)))
6136 (unless (equal old-regexp org-target-link-regexp)
6137 ;; Clean-up cache.
6138 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6139 ((not org-target-link-regexp) old-regexp)
6141 (concat before-re
6142 (mapconcat
6143 (lambda (re)
6144 (substring re (length before-re)
6145 (- (length after-re))))
6146 (list old-regexp org-target-link-regexp)
6147 "\\|")
6148 after-re)))))
6149 (org-with-wide-buffer
6150 (goto-char (point-min))
6151 (while (re-search-forward regexp nil t)
6152 (org-element-cache-refresh (match-beginning 1)))))
6153 ;; Re fontify buffer.
6154 (when (memq 'radio org-highlight-links)
6155 (org-restart-font-lock)))))
6157 (defun org-hide-wide-columns (limit)
6158 (let (s e)
6159 (setq s (text-property-any (point) (or limit (point-max))
6160 'org-cwidth t))
6161 (when s
6162 (setq e (next-single-property-change s 'org-cwidth))
6163 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6164 (goto-char e)
6165 t)))
6167 (defvar org-latex-and-related-regexp nil
6168 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6170 (defun org-compute-latex-and-related-regexp ()
6171 "Compute regular expression for LaTeX, entities and sub/superscript.
6172 Result depends on variable `org-highlight-latex-and-related'."
6173 (org-set-local
6174 'org-latex-and-related-regexp
6175 (let* ((re-sub
6176 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6177 ((eq org-use-sub-superscripts '{})
6178 (list org-match-substring-with-braces-regexp))
6179 (org-use-sub-superscripts (list org-match-substring-regexp))))
6180 (re-latex
6181 (when (memq 'latex org-highlight-latex-and-related)
6182 (let ((matchers (plist-get org-format-latex-options :matchers)))
6183 (delq nil
6184 (mapcar (lambda (x)
6185 (and (member (car x) matchers) (nth 1 x)))
6186 org-latex-regexps)))))
6187 (re-entities
6188 (when (memq 'entities org-highlight-latex-and-related)
6189 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6190 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6192 (defun org-do-latex-and-related (limit)
6193 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6194 LIMIT bounds the search for syntax to highlight. Stop at first
6195 highlighted object, if any. Return t if some highlighting was
6196 done, nil otherwise."
6197 (when (org-string-nw-p org-latex-and-related-regexp)
6198 (catch 'found
6199 (while (re-search-forward org-latex-and-related-regexp limit t)
6200 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6201 'face))
6202 '(org-code org-verbatim underline))
6203 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6204 '(?_ ?^))
6206 0)))
6207 (font-lock-prepend-text-property
6208 (+ offset (match-beginning 0)) (match-end 0)
6209 'face 'org-latex-and-related)
6210 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6211 '(font-lock-multiline t)))
6212 (throw 'found t)))
6213 nil)))
6215 (defun org-restart-font-lock ()
6216 "Restart `font-lock-mode', to force refontification."
6217 (when (and (boundp 'font-lock-mode) font-lock-mode)
6218 (font-lock-mode -1)
6219 (font-lock-mode 1)))
6221 (defun org-activate-tags (limit)
6222 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6223 (progn
6224 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6225 (add-text-properties (match-beginning 1) (match-end 1)
6226 (list 'mouse-face 'highlight
6227 'keymap org-mouse-map))
6228 (org-rear-nonsticky-at (match-end 1))
6229 t)))
6231 (defun org-outline-level ()
6232 "Compute the outline level of the heading at point.
6234 If this is called at a normal headline, the level is the number
6235 of stars. Use `org-reduced-level' to remove the effect of
6236 `org-odd-levels'. Unlike to `org-current-level', this function
6237 takes into consideration inlinetasks."
6238 (org-with-wide-buffer
6239 (end-of-line)
6240 (if (re-search-backward org-outline-regexp-bol nil t)
6241 (1- (- (match-end 0) (match-beginning 0)))
6242 0)))
6244 (defvar org-font-lock-keywords nil)
6246 (defsubst org-re-property (property &optional literal allow-null value)
6247 "Return a regexp matching a PROPERTY line.
6249 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6250 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6251 non-nil, match properties even without a value.
6253 Match group 3 is set to the value when it exists. If there is no
6254 value and ALLOW-NULL is non-nil, it is set to the empty string.
6256 With optional argument VALUE, match only property lines with
6257 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6258 unless LITERAL is non-nil."
6259 (concat
6260 "^\\(?4:[ \t]*\\)"
6261 (format "\\(?1::\\(?2:%s\\):\\)"
6262 (if literal property (regexp-quote property)))
6263 (cond (value
6264 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6265 (if literal value (regexp-quote value))))
6266 (allow-null
6267 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6269 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6271 (defconst org-property-re
6272 (org-re-property "\\S-+" 'literal t)
6273 "Regular expression matching a property line.
6274 There are four matching groups:
6275 1: :PROPKEY: including the leading and trailing colon,
6276 2: PROPKEY without the leading and trailing colon,
6277 3: PROPVAL without leading or trailing spaces,
6278 4: the indentation of the current line,
6279 5: trailing whitespace.")
6281 (defvar org-font-lock-hook nil
6282 "Functions to be called for special font lock stuff.")
6284 (defvar org-font-lock-set-keywords-hook nil
6285 "Functions that can manipulate `org-font-lock-extra-keywords'.
6286 This is called after `org-font-lock-extra-keywords' is defined, but before
6287 it is installed to be used by font lock. This can be useful if something
6288 needs to be inserted at a specific position in the font-lock sequence.")
6290 (defun org-font-lock-hook (limit)
6291 "Run `org-font-lock-hook' within LIMIT."
6292 (run-hook-with-args 'org-font-lock-hook limit))
6294 (defun org-set-font-lock-defaults ()
6295 "Set font lock defaults for the current buffer."
6296 (let* ((em org-fontify-emphasized-text)
6297 (lk org-highlight-links)
6298 (org-font-lock-extra-keywords
6299 (list
6300 ;; Call the hook
6301 '(org-font-lock-hook)
6302 ;; Headlines
6303 `(,(if org-fontify-whole-heading-line
6304 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6305 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6306 (1 (org-get-level-face 1))
6307 (2 (org-get-level-face 2))
6308 (3 (org-get-level-face 3)))
6309 ;; Table lines
6310 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6311 (1 'org-table t))
6312 ;; Table internals
6313 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6314 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6315 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6316 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6317 ;; Drawers
6318 '(org-fontify-drawers)
6319 ;; Properties
6320 (list org-property-re
6321 '(1 'org-special-keyword t)
6322 '(3 'org-property-value t))
6323 ;; Links
6324 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6325 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6326 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6327 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6328 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6329 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6330 (if (memq 'footnote lk) '(org-activate-footnote-links))
6331 ;; Targets.
6332 (list org-any-target-regexp '(0 'org-target t))
6333 ;; Diary sexps.
6334 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6335 ;; Macro
6336 '(org-fontify-macros)
6337 '(org-hide-wide-columns (0 nil append))
6338 ;; TODO keyword
6339 (list (format org-heading-keyword-regexp-format
6340 org-todo-regexp)
6341 '(2 (org-get-todo-face 2) t))
6342 ;; DONE
6343 (if org-fontify-done-headline
6344 (list (format org-heading-keyword-regexp-format
6345 (concat
6346 "\\(?:"
6347 (mapconcat 'regexp-quote org-done-keywords "\\|")
6348 "\\)"))
6349 '(2 'org-headline-done t))
6350 nil)
6351 ;; Priorities
6352 '(org-font-lock-add-priority-faces)
6353 ;; Tags
6354 '(org-font-lock-add-tag-faces)
6355 ;; Tags groups
6356 (if (and org-group-tags org-tag-groups-alist)
6357 (list (concat org-outline-regexp-bol ".+\\(:"
6358 (regexp-opt (mapcar 'car org-tag-groups-alist))
6359 ":\\).*$")
6360 '(1 'org-tag-group prepend)))
6361 ;; Special keywords
6362 (list (concat "\\<" org-comment-string) '(0 'org-special-keyword t))
6363 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6364 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6365 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6366 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6367 ;; Emphasis
6368 (if em
6369 (if (featurep 'xemacs)
6370 '(org-do-emphasis-faces (0 nil append))
6371 '(org-do-emphasis-faces)))
6372 ;; Checkboxes
6373 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6374 1 'org-checkbox prepend)
6375 (if (cdr (assq 'checkbox org-list-automatic-rules))
6376 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6377 (0 (org-get-checkbox-statistics-face) t)))
6378 ;; Description list items
6379 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6380 1 'org-list-dt prepend)
6381 ;; ARCHIVEd headings
6382 (list (concat
6383 org-outline-regexp-bol
6384 "\\(.*:" org-archive-tag ":.*\\)")
6385 '(1 'org-archived prepend))
6386 ;; Specials
6387 '(org-do-latex-and-related)
6388 '(org-fontify-entities)
6389 '(org-raise-scripts)
6390 ;; Code
6391 '(org-activate-code (1 'org-code t))
6392 ;; COMMENT
6393 (list (format
6394 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6395 org-todo-regexp
6396 org-comment-string)
6397 '(9 'org-special-keyword t))
6398 ;; Blocks and meta lines
6399 '(org-fontify-meta-lines-and-blocks))))
6400 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6401 (run-hooks 'org-font-lock-set-keywords-hook)
6402 ;; Now set the full font-lock-keywords
6403 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6404 (org-set-local 'font-lock-defaults
6405 '(org-font-lock-keywords t nil nil backward-paragraph))
6406 (kill-local-variable 'font-lock-keywords) nil))
6408 (defun org-toggle-pretty-entities ()
6409 "Toggle the composition display of entities as UTF8 characters."
6410 (interactive)
6411 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6412 (org-restart-font-lock)
6413 (if org-pretty-entities
6414 (message "Entities are now displayed as UTF8 characters")
6415 (save-restriction
6416 (widen)
6417 (org-decompose-region (point-min) (point-max))
6418 (message "Entities are now displayed as plain text"))))
6420 (defvar org-custom-properties-overlays nil
6421 "List of overlays used for custom properties.")
6422 (make-variable-buffer-local 'org-custom-properties-overlays)
6424 (defun org-toggle-custom-properties-visibility ()
6425 "Display or hide properties in `org-custom-properties'."
6426 (interactive)
6427 (if org-custom-properties-overlays
6428 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6429 (setq org-custom-properties-overlays nil))
6430 (when org-custom-properties
6431 (org-with-wide-buffer
6432 (goto-char (point-min))
6433 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6434 (while (re-search-forward regexp nil t)
6435 (let ((end (cdr (save-match-data (org-get-property-block)))))
6436 (when (and end (< (point) end))
6437 ;; Hide first custom property in current drawer.
6438 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6439 (overlay-put o 'invisible t)
6440 (overlay-put o 'org-custom-property t)
6441 (push o org-custom-properties-overlays))
6442 ;; Hide additional custom properties in the same drawer.
6443 (while (re-search-forward regexp end t)
6444 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6445 (overlay-put o 'invisible t)
6446 (overlay-put o 'org-custom-property t)
6447 (push o org-custom-properties-overlays)))))
6448 ;; Each entry is limited to a single property drawer.
6449 (outline-next-heading)))))))
6451 (defun org-fontify-entities (limit)
6452 "Find an entity to fontify."
6453 (let (ee)
6454 (when org-pretty-entities
6455 (catch 'match
6456 ;; "\_ "-family is left out on purpose. Only the first one,
6457 ;; i.e., "\_ ", could be fontified anyway, and it would be
6458 ;; confusing when adding a second white space character.
6459 (while (re-search-forward
6460 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6461 limit t)
6462 (if (and (not (org-at-comment-p))
6463 (setq ee (org-entity-get (match-string 1)))
6464 (= (length (nth 6 ee)) 1))
6465 (let*
6466 ((end (if (equal (match-string 2) "{}")
6467 (match-end 2)
6468 (match-end 1))))
6469 (add-text-properties
6470 (match-beginning 0) end
6471 (list 'font-lock-fontified t))
6472 (compose-region (match-beginning 0) end
6473 (nth 6 ee) nil)
6474 (backward-char 1)
6475 (throw 'match t))))
6476 nil))))
6478 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6479 "Fontify string S like in Org-mode."
6480 (with-temp-buffer
6481 (insert s)
6482 (let ((org-odd-levels-only odd-levels))
6483 (org-mode)
6484 (font-lock-ensure)
6485 (buffer-string))))
6487 (defvar org-m nil)
6488 (defvar org-l nil)
6489 (defvar org-f nil)
6490 (defun org-get-level-face (n)
6491 "Get the right face for match N in font-lock matching of headlines."
6492 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6493 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6494 (if org-cycle-level-faces
6495 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6496 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6497 (cond
6498 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6499 ((eq n 2) org-f)
6500 (t (if org-level-color-stars-only nil org-f))))
6503 (defun org-get-todo-face (kwd)
6504 "Get the right face for a TODO keyword KWD.
6505 If KWD is a number, get the corresponding match group."
6506 (if (numberp kwd) (setq kwd (match-string kwd)))
6507 (or (org-face-from-face-or-color
6508 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6509 (and (member kwd org-done-keywords) 'org-done)
6510 'org-todo))
6512 (defun org-face-from-face-or-color (context inherit face-or-color)
6513 "Create a face list that inherits INHERIT, but sets the foreground color.
6514 When FACE-OR-COLOR is not a string, just return it."
6515 (if (stringp face-or-color)
6516 (list :inherit inherit
6517 (cdr (assoc context org-faces-easy-properties))
6518 face-or-color)
6519 face-or-color))
6521 (defun org-font-lock-add-tag-faces (limit)
6522 "Add the special tag faces."
6523 (when (and org-tag-faces org-tags-special-faces-re)
6524 (while (re-search-forward org-tags-special-faces-re limit t)
6525 (add-text-properties (match-beginning 1) (match-end 1)
6526 (list 'face (org-get-tag-face 1)
6527 'font-lock-fontified t))
6528 (backward-char 1))))
6530 (defun org-font-lock-add-priority-faces (limit)
6531 "Add the special priority faces."
6532 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6533 (when (save-match-data (org-at-heading-p))
6534 (add-text-properties
6535 (match-beginning 0) (match-end 0)
6536 (list 'face (or (org-face-from-face-or-color
6537 'priority 'org-priority
6538 (cdr (assoc (char-after (match-beginning 1))
6539 org-priority-faces)))
6540 'org-priority)
6541 'font-lock-fontified t)))))
6543 (defun org-get-tag-face (kwd)
6544 "Get the right face for a TODO keyword KWD.
6545 If KWD is a number, get the corresponding match group."
6546 (if (numberp kwd) (setq kwd (match-string kwd)))
6547 (or (org-face-from-face-or-color
6548 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6549 'org-tag))
6551 (defun org-unfontify-region (beg end &optional maybe_loudly)
6552 "Remove fontification and activation overlays from links."
6553 (font-lock-default-unfontify-region beg end)
6554 (let* ((buffer-undo-list t)
6555 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6556 (inhibit-modification-hooks t)
6557 deactivate-mark buffer-file-name buffer-file-truename)
6558 (org-decompose-region beg end)
6559 (remove-text-properties beg end
6560 '(mouse-face t keymap t org-linked-text t
6561 invisible t intangible t
6562 org-emphasis t))
6563 (org-remove-font-lock-display-properties beg end)))
6565 (defconst org-script-display '(((raise -0.3) (height 0.7))
6566 ((raise 0.3) (height 0.7))
6567 ((raise -0.5))
6568 ((raise 0.5)))
6569 "Display properties for showing superscripts and subscripts.")
6571 (defun org-remove-font-lock-display-properties (beg end)
6572 "Remove specific display properties that have been added by font lock.
6573 The will remove the raise properties that are used to show superscripts
6574 and subscripts."
6575 (let (next prop)
6576 (while (< beg end)
6577 (setq next (next-single-property-change beg 'display nil end)
6578 prop (get-text-property beg 'display))
6579 (if (member prop org-script-display)
6580 (put-text-property beg next 'display nil))
6581 (setq beg next))))
6583 (defun org-raise-scripts (limit)
6584 "Add raise properties to sub/superscripts."
6585 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6586 (if (re-search-forward
6587 (if (eq org-use-sub-superscripts t)
6588 org-match-substring-regexp
6589 org-match-substring-with-braces-regexp)
6590 limit t)
6591 (let* ((pos (point)) table-p comment-p
6592 (mpos (match-beginning 3))
6593 (emph-p (get-text-property mpos 'org-emphasis))
6594 (link-p (get-text-property mpos 'mouse-face))
6595 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6596 (goto-char (point-at-bol))
6597 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6598 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6599 (goto-char pos)
6600 ;; Handle a_b^c
6601 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6602 (if (or comment-p emph-p link-p keyw-p)
6604 (put-text-property (match-beginning 3) (match-end 0)
6605 'display
6606 (if (equal (char-after (match-beginning 2)) ?^)
6607 (nth (if table-p 3 1) org-script-display)
6608 (nth (if table-p 2 0) org-script-display)))
6609 (add-text-properties (match-beginning 2) (match-end 2)
6610 (list 'invisible t
6611 'org-dwidth t 'org-dwidth-n 1))
6612 (if (and (eq (char-after (match-beginning 3)) ?{)
6613 (eq (char-before (match-end 3)) ?}))
6614 (progn
6615 (add-text-properties
6616 (match-beginning 3) (1+ (match-beginning 3))
6617 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6618 (add-text-properties
6619 (1- (match-end 3)) (match-end 3)
6620 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6621 t)))))
6623 ;;;; Visibility cycling, including org-goto and indirect buffer
6625 ;;; Cycling
6627 (defvar org-cycle-global-status nil)
6628 (make-variable-buffer-local 'org-cycle-global-status)
6629 (put 'org-cycle-global-status 'org-state t)
6630 (defvar org-cycle-subtree-status nil)
6631 (make-variable-buffer-local 'org-cycle-subtree-status)
6632 (put 'org-cycle-subtree-status 'org-state t)
6634 (defvar org-inlinetask-min-level)
6636 (defun org-unlogged-message (&rest args)
6637 "Display a message, but avoid logging it in the *Messages* buffer."
6638 (let ((message-log-max nil))
6639 (apply 'message args)))
6641 ;;;###autoload
6642 (defun org-cycle (&optional arg)
6643 "TAB-action and visibility cycling for Org-mode.
6645 This is the command invoked in Org-mode by the TAB key. Its main purpose
6646 is outline visibility cycling, but it also invokes other actions
6647 in special contexts.
6649 - When this function is called with a prefix argument, rotate the entire
6650 buffer through 3 states (global cycling)
6651 1. OVERVIEW: Show only top-level headlines.
6652 2. CONTENTS: Show all headlines of all levels, but no body text.
6653 3. SHOW ALL: Show everything.
6654 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6655 determined by the variable `org-startup-folded', and by any VISIBILITY
6656 properties in the buffer.
6657 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6658 including any drawers.
6660 - When inside a table, re-align the table and move to the next field.
6662 - When point is at the beginning of a headline, rotate the subtree started
6663 by this line through 3 different states (local cycling)
6664 1. FOLDED: Only the main headline is shown.
6665 2. CHILDREN: The main headline and the direct children are shown.
6666 From this state, you can move to one of the children
6667 and zoom in further.
6668 3. SUBTREE: Show the entire subtree, including body text.
6669 If there is no subtree, switch directly from CHILDREN to FOLDED.
6671 - When point is at the beginning of an empty headline and the variable
6672 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6673 of the headline by demoting and promoting it to likely levels. This
6674 speeds up creation document structure by pressing TAB once or several
6675 times right after creating a new headline.
6677 - When there is a numeric prefix, go up to a heading with level ARG, do
6678 a `show-subtree' and return to the previous cursor position. If ARG
6679 is negative, go up that many levels.
6681 - When point is not at the beginning of a headline, execute the global
6682 binding for TAB, which is re-indenting the line. See the option
6683 `org-cycle-emulate-tab' for details.
6685 - Special case: if point is at the beginning of the buffer and there is
6686 no headline in line 1, this function will act as if called with prefix arg
6687 (C-u TAB, same as S-TAB) also when called without prefix arg.
6688 But only if also the variable `org-cycle-global-at-bob' is t."
6689 (interactive "P")
6690 (org-load-modules-maybe)
6691 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6692 (and org-cycle-level-after-item/entry-creation
6693 (or (org-cycle-level)
6694 (org-cycle-item-indentation))))
6695 (let* ((limit-level
6696 (or org-cycle-max-level
6697 (and (boundp 'org-inlinetask-min-level)
6698 org-inlinetask-min-level
6699 (1- org-inlinetask-min-level))))
6700 (nstars (and limit-level
6701 (if org-odd-levels-only
6702 (and limit-level (1- (* limit-level 2)))
6703 limit-level)))
6704 (org-outline-regexp
6705 (if (not (derived-mode-p 'org-mode))
6706 outline-regexp
6707 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6708 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6709 (not (looking-at org-outline-regexp))))
6710 (org-cycle-hook
6711 (if bob-special
6712 (delq 'org-optimize-window-after-visibility-change
6713 (copy-sequence org-cycle-hook))
6714 org-cycle-hook))
6715 (pos (point)))
6717 (if (or bob-special (equal arg '(4)))
6718 ;; special case: use global cycling
6719 (setq arg t))
6721 (cond
6723 ((equal arg '(16))
6724 (setq last-command 'dummy)
6725 (org-set-startup-visibility)
6726 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6728 ((equal arg '(64))
6729 (show-all)
6730 (org-unlogged-message "Entire buffer visible, including drawers"))
6732 ;; Try cdlatex TAB completion
6733 ((org-try-cdlatex-tab))
6735 ;; Table: enter it or move to the next field.
6736 ((org-at-table-p 'any)
6737 (if (org-at-table.el-p)
6738 (message "Use C-c ' to edit table.el tables")
6739 (if arg (org-table-edit-field t)
6740 (org-table-justify-field-maybe)
6741 (call-interactively 'org-table-next-field))))
6743 ((run-hook-with-args-until-success
6744 'org-tab-after-check-for-table-hook))
6746 ;; Global cycling: delegate to `org-cycle-internal-global'.
6747 ((eq arg t) (org-cycle-internal-global))
6749 ;; Drawers: delegate to `org-flag-drawer'.
6750 ((save-excursion
6751 (beginning-of-line 1)
6752 (looking-at org-drawer-regexp))
6753 (org-flag-drawer ; toggle block visibility
6754 (not (get-char-property (match-end 0) 'invisible))))
6756 ;; Show-subtree, ARG levels up from here.
6757 ((integerp arg)
6758 (save-excursion
6759 (org-back-to-heading)
6760 (outline-up-heading (if (< arg 0) (- arg)
6761 (- (funcall outline-level) arg)))
6762 (org-show-subtree)))
6764 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6765 ((and (featurep 'org-inlinetask)
6766 (org-inlinetask-at-task-p)
6767 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6768 (org-inlinetask-toggle-visibility))
6770 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6771 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6772 (save-excursion (move-beginning-of-line 1)
6773 (looking-at org-outline-regexp)))
6774 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6775 (org-cycle-internal-local))
6777 ;; From there: TAB emulation and template completion.
6778 (buffer-read-only (org-back-to-heading))
6780 ((run-hook-with-args-until-success
6781 'org-tab-after-check-for-cycling-hook))
6783 ((org-try-structure-completion))
6785 ((run-hook-with-args-until-success
6786 'org-tab-before-tab-emulation-hook))
6788 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6789 (or (not (bolp))
6790 (not (looking-at org-outline-regexp))))
6791 (call-interactively (global-key-binding "\t")))
6793 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6794 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6795 (or (and (eq org-cycle-emulate-tab 'white)
6796 (= (match-end 0) (point-at-eol)))
6797 (and (eq org-cycle-emulate-tab 'whitestart)
6798 (>= (match-end 0) pos))))
6800 (eq org-cycle-emulate-tab t))
6801 (call-interactively (global-key-binding "\t")))
6803 (t (save-excursion
6804 (org-back-to-heading)
6805 (org-cycle)))))))
6807 (defun org-cycle-internal-global ()
6808 "Do the global cycling action."
6809 ;; Hack to avoid display of messages for .org attachments in Gnus
6810 (let ((ga (string-match "\\*fontification" (buffer-name))))
6811 (cond
6812 ((and (eq last-command this-command)
6813 (eq org-cycle-global-status 'overview))
6814 ;; We just created the overview - now do table of contents
6815 ;; This can be slow in very large buffers, so indicate action
6816 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6817 (unless ga (org-unlogged-message "CONTENTS..."))
6818 (org-content)
6819 (unless ga (org-unlogged-message "CONTENTS...done"))
6820 (setq org-cycle-global-status 'contents)
6821 (run-hook-with-args 'org-cycle-hook 'contents))
6823 ((and (eq last-command this-command)
6824 (eq org-cycle-global-status 'contents))
6825 ;; We just showed the table of contents - now show everything
6826 (run-hook-with-args 'org-pre-cycle-hook 'all)
6827 (show-all)
6828 (unless ga (org-unlogged-message "SHOW ALL"))
6829 (setq org-cycle-global-status 'all)
6830 (run-hook-with-args 'org-cycle-hook 'all))
6833 ;; Default action: go to overview
6834 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6835 (org-overview)
6836 (unless ga (org-unlogged-message "OVERVIEW"))
6837 (setq org-cycle-global-status 'overview)
6838 (run-hook-with-args 'org-cycle-hook 'overview)))))
6840 (defvar org-called-with-limited-levels nil
6841 "Non-nil when `org-with-limited-levels' is currently active.")
6843 (defun org-cycle-internal-local ()
6844 "Do the local cycling action."
6845 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6846 ;; First, determine end of headline (EOH), end of subtree or item
6847 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6848 (save-excursion
6849 (if (org-at-item-p)
6850 (progn
6851 (beginning-of-line)
6852 (setq struct (org-list-struct))
6853 (setq eoh (point-at-eol))
6854 (setq eos (org-list-get-item-end-before-blank (point) struct))
6855 (setq has-children (org-list-has-child-p (point) struct)))
6856 (org-back-to-heading)
6857 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6858 (setq eos (save-excursion (org-end-of-subtree t t)
6859 (when (bolp) (backward-char)) (point)))
6860 (setq has-children
6861 (or (save-excursion
6862 (let ((level (funcall outline-level)))
6863 (outline-next-heading)
6864 (and (org-at-heading-p t)
6865 (> (funcall outline-level) level))))
6866 (save-excursion
6867 (org-list-search-forward (org-item-beginning-re) eos t)))))
6868 ;; Determine end invisible part of buffer (EOL)
6869 (beginning-of-line 2)
6870 ;; XEmacs doesn't have `next-single-char-property-change'
6871 (if (featurep 'xemacs)
6872 (while (and (not (eobp)) ;; this is like `next-line'
6873 (get-char-property (1- (point)) 'invisible))
6874 (beginning-of-line 2))
6875 (while (and (not (eobp)) ;; this is like `next-line'
6876 (get-char-property (1- (point)) 'invisible))
6877 (goto-char (next-single-char-property-change (point) 'invisible))
6878 (and (eolp) (beginning-of-line 2))))
6879 (setq eol (point)))
6880 ;; Find out what to do next and set `this-command'
6881 (cond
6882 ((= eos eoh)
6883 ;; Nothing is hidden behind this heading
6884 (unless (org-before-first-heading-p)
6885 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6886 (org-unlogged-message "EMPTY ENTRY")
6887 (setq org-cycle-subtree-status nil)
6888 (save-excursion
6889 (goto-char eos)
6890 (outline-next-heading)
6891 (if (outline-invisible-p) (org-flag-heading nil))))
6892 ((and (or (>= eol eos)
6893 (not (string-match "\\S-" (buffer-substring eol eos))))
6894 (or has-children
6895 (not (setq children-skipped
6896 org-cycle-skip-children-state-if-no-children))))
6897 ;; Entire subtree is hidden in one line: children view
6898 (unless (org-before-first-heading-p)
6899 (run-hook-with-args 'org-pre-cycle-hook 'children))
6900 (if (org-at-item-p)
6901 (org-list-set-item-visibility (point-at-bol) struct 'children)
6902 (org-show-entry)
6903 (org-with-limited-levels (show-children))
6904 ;; FIXME: This slows down the func way too much.
6905 ;; How keep drawers hidden in subtree anyway?
6906 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6907 ;; (org-cycle-hide-drawers 'subtree))
6909 ;; Fold every list in subtree to top-level items.
6910 (when (eq org-cycle-include-plain-lists 'integrate)
6911 (save-excursion
6912 (org-back-to-heading)
6913 (while (org-list-search-forward (org-item-beginning-re) eos t)
6914 (beginning-of-line 1)
6915 (let* ((struct (org-list-struct))
6916 (prevs (org-list-prevs-alist struct))
6917 (end (org-list-get-bottom-point struct)))
6918 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6919 (org-list-get-all-items (point) struct prevs))
6920 (goto-char (if (< end eos) end eos)))))))
6921 (org-unlogged-message "CHILDREN")
6922 (save-excursion
6923 (goto-char eos)
6924 (outline-next-heading)
6925 (if (outline-invisible-p) (org-flag-heading nil)))
6926 (setq org-cycle-subtree-status 'children)
6927 (unless (org-before-first-heading-p)
6928 (run-hook-with-args 'org-cycle-hook 'children)))
6929 ((or children-skipped
6930 (and (eq last-command this-command)
6931 (eq org-cycle-subtree-status 'children)))
6932 ;; We just showed the children, or no children are there,
6933 ;; now show everything.
6934 (unless (org-before-first-heading-p)
6935 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6936 (outline-flag-region eoh eos nil)
6937 (org-unlogged-message
6938 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6939 (setq org-cycle-subtree-status 'subtree)
6940 (unless (org-before-first-heading-p)
6941 (run-hook-with-args 'org-cycle-hook 'subtree)))
6943 ;; Default action: hide the subtree.
6944 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6945 (outline-flag-region eoh eos t)
6946 (org-unlogged-message "FOLDED")
6947 (setq org-cycle-subtree-status 'folded)
6948 (unless (org-before-first-heading-p)
6949 (run-hook-with-args 'org-cycle-hook 'folded))))))
6951 ;;;###autoload
6952 (defun org-global-cycle (&optional arg)
6953 "Cycle the global visibility. For details see `org-cycle'.
6954 With \\[universal-argument] prefix arg, switch to startup visibility.
6955 With a numeric prefix, show all headlines up to that level."
6956 (interactive "P")
6957 (let ((org-cycle-include-plain-lists
6958 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6959 (cond
6960 ((integerp arg)
6961 (show-all)
6962 (hide-sublevels arg)
6963 (setq org-cycle-global-status 'contents))
6964 ((equal arg '(4))
6965 (org-set-startup-visibility)
6966 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6968 (org-cycle '(4))))))
6970 (defun org-set-startup-visibility ()
6971 "Set the visibility required by startup options and properties."
6972 (cond
6973 ((eq org-startup-folded t)
6974 (org-overview))
6975 ((eq org-startup-folded 'content)
6976 (org-content))
6977 ((or (eq org-startup-folded 'showeverything)
6978 (eq org-startup-folded nil))
6979 (show-all)))
6980 (unless (eq org-startup-folded 'showeverything)
6981 (if org-hide-block-startup (org-hide-block-all))
6982 (org-set-visibility-according-to-property 'no-cleanup)
6983 (org-cycle-hide-archived-subtrees 'all)
6984 (org-cycle-hide-drawers 'all)
6985 (org-cycle-show-empty-lines t)))
6987 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6988 "Switch subtree visibilities according to :VISIBILITY: property."
6989 (interactive)
6990 (let (org-show-entry-below)
6991 (org-with-wide-buffer
6992 (goto-char (point-min))
6993 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
6994 (if (not (org-at-property-p)) (outline-next-heading)
6995 (let ((state (match-string 3)))
6996 (save-excursion
6997 (org-back-to-heading t)
6998 (hide-subtree)
6999 (org-reveal)
7000 (cond
7001 ((equal state "folded")
7002 (hide-subtree))
7003 ((equal state "children")
7004 (org-show-hidden-entry)
7005 (show-children))
7006 ((equal state "content")
7007 (save-excursion
7008 (save-restriction
7009 (org-narrow-to-subtree)
7010 (org-content))))
7011 ((member state '("all" "showall"))
7012 (show-subtree)))))))
7013 (unless no-cleanup
7014 (org-cycle-hide-archived-subtrees 'all)
7015 (org-cycle-hide-drawers 'all)
7016 (org-cycle-show-empty-lines 'all)))))
7018 ;; This function uses outline-regexp instead of the more fundamental
7019 ;; org-outline-regexp so that org-cycle-global works outside of Org
7020 ;; buffers, where outline-regexp is needed.
7021 (defun org-overview ()
7022 "Switch to overview mode, showing only top-level headlines.
7023 This shows all headlines with a level equal or greater than the level
7024 of the first headline in the buffer. This is important, because if the
7025 first headline is not level one, then (hide-sublevels 1) gives confusing
7026 results."
7027 (interactive)
7028 (save-excursion
7029 (let ((level
7030 (save-excursion
7031 (goto-char (point-min))
7032 (if (re-search-forward (concat "^" outline-regexp) nil t)
7033 (progn
7034 (goto-char (match-beginning 0))
7035 (funcall outline-level))))))
7036 (and level (hide-sublevels level)))))
7038 (defun org-content (&optional arg)
7039 "Show all headlines in the buffer, like a table of contents.
7040 With numerical argument N, show content up to level N."
7041 (interactive "P")
7042 (org-overview)
7043 (save-excursion
7044 ;; Visit all headings and show their offspring
7045 (and (integerp arg) (org-overview))
7046 (goto-char (point-max))
7047 (catch 'exit
7048 (while (and (progn (condition-case nil
7049 (outline-previous-visible-heading 1)
7050 (error (goto-char (point-min))))
7052 (looking-at org-outline-regexp))
7053 (if (integerp arg)
7054 (show-children (1- arg))
7055 (show-branches))
7056 (if (bobp) (throw 'exit nil))))))
7058 (defun org-optimize-window-after-visibility-change (state)
7059 "Adjust the window after a change in outline visibility.
7060 This function is the default value of the hook `org-cycle-hook'."
7061 (when (get-buffer-window (current-buffer))
7062 (cond
7063 ((eq state 'content) nil)
7064 ((eq state 'all) nil)
7065 ((eq state 'folded) nil)
7066 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7067 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7069 (defun org-remove-empty-overlays-at (pos)
7070 "Remove outline overlays that do not contain non-white stuff."
7071 (mapc
7072 (lambda (o)
7073 (and (eq 'outline (overlay-get o 'invisible))
7074 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7075 (overlay-end o))))
7076 (delete-overlay o)))
7077 (overlays-at pos)))
7079 (defun org-clean-visibility-after-subtree-move ()
7080 "Fix visibility issues after moving a subtree."
7081 ;; First, find a reasonable region to look at:
7082 ;; Start two siblings above, end three below
7083 (let* ((beg (save-excursion
7084 (and (org-get-last-sibling)
7085 (org-get-last-sibling))
7086 (point)))
7087 (end (save-excursion
7088 (and (org-get-next-sibling)
7089 (org-get-next-sibling)
7090 (org-get-next-sibling))
7091 (if (org-at-heading-p)
7092 (point-at-eol)
7093 (point))))
7094 (level (looking-at "\\*+"))
7095 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7096 (save-excursion
7097 (save-restriction
7098 (narrow-to-region beg end)
7099 (when re
7100 ;; Properly fold already folded siblings
7101 (goto-char (point-min))
7102 (while (re-search-forward re nil t)
7103 (if (and (not (outline-invisible-p))
7104 (save-excursion
7105 (goto-char (point-at-eol)) (outline-invisible-p)))
7106 (hide-entry))))
7107 (org-cycle-show-empty-lines 'overview)
7108 (org-cycle-hide-drawers 'overview)))))
7110 (defun org-cycle-show-empty-lines (state)
7111 "Show empty lines above all visible headlines.
7112 The region to be covered depends on STATE when called through
7113 `org-cycle-hook'. Lisp program can use t for STATE to get the
7114 entire buffer covered. Note that an empty line is only shown if there
7115 are at least `org-cycle-separator-lines' empty lines before the headline."
7116 (when (/= org-cycle-separator-lines 0)
7117 (save-excursion
7118 (let* ((n (abs org-cycle-separator-lines))
7119 (re (cond
7120 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7121 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7122 (t (let ((ns (number-to-string (- n 2))))
7123 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7124 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7125 beg end)
7126 (cond
7127 ((memq state '(overview contents t))
7128 (setq beg (point-min) end (point-max)))
7129 ((memq state '(children folded))
7130 (setq beg (point)
7131 end (progn (org-end-of-subtree t t)
7132 (line-beginning-position 2)))))
7133 (when beg
7134 (goto-char beg)
7135 (while (re-search-forward re end t)
7136 (unless (get-char-property (match-end 1) 'invisible)
7137 (let ((e (match-end 1))
7138 (b (if (>= org-cycle-separator-lines 0)
7139 (match-beginning 1)
7140 (save-excursion
7141 (goto-char (match-beginning 0))
7142 (skip-chars-backward " \t\n")
7143 (line-end-position)))))
7144 (outline-flag-region b e nil))))))))
7145 ;; Never hide empty lines at the end of the file.
7146 (save-excursion
7147 (goto-char (point-max))
7148 (outline-previous-heading)
7149 (outline-end-of-heading)
7150 (if (and (looking-at "[ \t\n]+")
7151 (= (match-end 0) (point-max)))
7152 (outline-flag-region (point) (match-end 0) nil))))
7154 (defun org-show-empty-lines-in-parent ()
7155 "Move to the parent and re-show empty lines before visible headlines."
7156 (save-excursion
7157 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7158 (org-cycle-show-empty-lines context))))
7160 (defun org-files-list ()
7161 "Return `org-agenda-files' list, plus all open org-mode files.
7162 This is useful for operations that need to scan all of a user's
7163 open and agenda-wise Org files."
7164 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7165 (dolist (buf (buffer-list))
7166 (with-current-buffer buf
7167 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7168 (let ((file (expand-file-name (buffer-file-name))))
7169 (unless (member file files)
7170 (push file files))))))
7171 files))
7173 (defsubst org-entry-beginning-position ()
7174 "Return the beginning position of the current entry."
7175 (save-excursion (outline-back-to-heading t) (point)))
7177 (defsubst org-entry-end-position ()
7178 "Return the end position of the current entry."
7179 (save-excursion (outline-next-heading) (point)))
7181 (defun org-cycle-hide-drawers (state &optional exceptions)
7182 "Re-hide all drawers after a visibility state change.
7183 When non-nil, optional argument EXCEPTIONS is a list of strings
7184 specifying which drawers should not be hidden."
7185 (when (and (derived-mode-p 'org-mode)
7186 (not (memq state '(overview folded contents))))
7187 (save-excursion
7188 (let* ((globalp (memq state '(contents all)))
7189 (beg (if globalp (point-min) (point)))
7190 (end (if globalp (point-max)
7191 (if (eq state 'children)
7192 (save-excursion (outline-next-heading) (point))
7193 (org-end-of-subtree t)))))
7194 (goto-char beg)
7195 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7196 (unless (member-ignore-case (match-string 1) exceptions)
7197 (let ((drawer (org-element-at-point)))
7198 (when (memq (org-element-type drawer) '(drawer property-drawer))
7199 (org-flag-drawer t drawer)
7200 ;; Make sure to skip drawer entirely or we might flag
7201 ;; it another time when matching its ending line with
7202 ;; `org-drawer-regexp'.
7203 (goto-char (org-element-property :end drawer))))))))))
7205 (defun org-flag-drawer (flag &optional element)
7206 "When FLAG is non-nil, hide the drawer we are at.
7207 Otherwise make it visible. When optional argument ELEMENT is
7208 a parsed drawer, as returned by `org-element-at-point', hide or
7209 show that drawer instead."
7210 (when (save-excursion
7211 (beginning-of-line)
7212 (org-looking-at-p org-drawer-regexp))
7213 (let ((drawer (or element (org-element-at-point))))
7214 (when (memq (org-element-type drawer) '(drawer property-drawer))
7215 (let ((post (org-element-property :post-affiliated drawer)))
7216 (save-excursion
7217 (outline-flag-region
7218 (progn (goto-char post) (line-end-position))
7219 (progn (goto-char (org-element-property :end drawer))
7220 (skip-chars-backward " \r\t\n")
7221 (line-end-position))
7222 flag))
7223 ;; When the drawer is hidden away, make sure point lies in
7224 ;; a visible part of the buffer.
7225 (when (and flag (> (line-beginning-position) post))
7226 (goto-char post)))))))
7228 (defun org-subtree-end-visible-p ()
7229 "Is the end of the current subtree visible?"
7230 (pos-visible-in-window-p
7231 (save-excursion (org-end-of-subtree t) (point))))
7233 (defun org-first-headline-recenter ()
7234 "Move cursor to the first headline and recenter the headline."
7235 (goto-char (point-min))
7236 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7237 (set-window-start (selected-window) (point-at-bol))))
7239 ;;; Saving and restoring visibility
7241 (defun org-outline-overlay-data (&optional use-markers)
7242 "Return a list of the locations of all outline overlays.
7243 These are overlays with the `invisible' property value `outline'.
7244 The return value is a list of cons cells, with start and stop
7245 positions for each overlay.
7246 If USE-MARKERS is set, return the positions as markers."
7247 (let (beg end)
7248 (save-excursion
7249 (save-restriction
7250 (widen)
7251 (delq nil
7252 (mapcar (lambda (o)
7253 (when (eq (overlay-get o 'invisible) 'outline)
7254 (setq beg (overlay-start o)
7255 end (overlay-end o))
7256 (and beg end (> end beg)
7257 (if use-markers
7258 (cons (copy-marker beg)
7259 (copy-marker end t))
7260 (cons beg end)))))
7261 (overlays-in (point-min) (point-max))))))))
7263 (defun org-set-outline-overlay-data (data)
7264 "Create visibility overlays for all positions in DATA.
7265 DATA should have been made by `org-outline-overlay-data'."
7266 (let (o)
7267 (save-excursion
7268 (save-restriction
7269 (widen)
7270 (show-all)
7271 (mapc (lambda (c)
7272 (outline-flag-region (car c) (cdr c) t))
7273 data)))))
7275 ;;; Folding of blocks
7277 (defvar org-hide-block-overlays nil
7278 "Overlays hiding blocks.")
7279 (make-variable-buffer-local 'org-hide-block-overlays)
7281 (defun org-block-map (function &optional start end)
7282 "Call FUNCTION at the head of all source blocks in the current buffer.
7283 Optional arguments START and END can be used to limit the range."
7284 (let ((start (or start (point-min)))
7285 (end (or end (point-max))))
7286 (save-excursion
7287 (goto-char start)
7288 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7289 (save-excursion
7290 (save-match-data
7291 (goto-char (match-beginning 0))
7292 (funcall function)))))))
7294 (defun org-hide-block-toggle-all ()
7295 "Toggle the visibility of all blocks in the current buffer."
7296 (org-block-map 'org-hide-block-toggle))
7298 (defun org-hide-block-all ()
7299 "Fold all blocks in the current buffer."
7300 (interactive)
7301 (org-show-block-all)
7302 (org-block-map 'org-hide-block-toggle-maybe))
7304 (defun org-show-block-all ()
7305 "Unfold all blocks in the current buffer."
7306 (interactive)
7307 (mapc 'delete-overlay org-hide-block-overlays)
7308 (setq org-hide-block-overlays nil))
7310 (defun org-hide-block-toggle-maybe ()
7311 "Toggle visibility of block at point.
7312 Unlike to `org-hide-block-toggle', this function does not throw
7313 an error. Return a non-nil value when toggling is successful."
7314 (interactive)
7315 (ignore-errors (org-hide-block-toggle)))
7317 (defun org-hide-block-toggle (&optional force)
7318 "Toggle the visibility of the current block.
7319 When optional argument FORCE is `off', make block visible. If it
7320 is non-nil, hide it unconditionally. Throw an error when not at
7321 a block. Return a non-nil value when toggling is successful."
7322 (interactive)
7323 (let ((element (org-element-at-point)))
7324 (unless (memq (org-element-type element)
7325 '(center-block comment-block dynamic-block example-block
7326 export-block quote-block special-block
7327 src-block verse-block))
7328 (user-error "Not at a block"))
7329 (let* ((start (save-excursion
7330 (goto-char (org-element-property :post-affiliated element))
7331 (line-end-position)))
7332 (end (save-excursion
7333 (goto-char (org-element-property :end element))
7334 (skip-chars-backward " \r\t\n")
7335 (line-end-position)))
7336 (overlays (overlays-at start)))
7337 (cond
7338 ;; Do nothing when not before or at the block opening line or
7339 ;; at the block closing line.
7340 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7341 ((and (not (eq force 'off))
7342 (not (memq t (mapcar
7343 (lambda (o)
7344 (eq (overlay-get o 'invisible) 'org-hide-block))
7345 overlays))))
7346 (let ((ov (make-overlay start end)))
7347 (overlay-put ov 'invisible 'org-hide-block)
7348 ;; Make the block accessible to `isearch'.
7349 (overlay-put
7350 ov 'isearch-open-invisible
7351 (lambda (ov)
7352 (when (memq ov org-hide-block-overlays)
7353 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7354 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7355 (delete-overlay ov))))
7356 (push ov org-hide-block-overlays)
7357 ;; When the block is hidden away, make sure point is left in
7358 ;; a visible part of the buffer.
7359 (when (> (line-beginning-position) start)
7360 (goto-char start)
7361 (beginning-of-line))
7362 ;; Signal successful toggling.
7364 ((or (not force) (eq force 'off))
7365 (dolist (ov overlays t)
7366 (when (memq ov org-hide-block-overlays)
7367 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7368 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7369 (delete-overlay ov))))))))
7371 ;; org-tab-after-check-for-cycling-hook
7372 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7373 ;; Remove overlays when changing major mode
7374 (add-hook 'org-mode-hook
7375 (lambda () (org-add-hook 'change-major-mode-hook
7376 'org-show-block-all 'append 'local)))
7378 ;;; Org-goto
7380 (defvar org-goto-window-configuration nil)
7381 (defvar org-goto-marker nil)
7382 (defvar org-goto-map)
7383 (defun org-goto-map ()
7384 "Set the keymap `org-goto'."
7385 (setq org-goto-map
7386 (let ((map (make-sparse-keymap)))
7387 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7388 mouse-drag-region universal-argument org-occur))
7389 cmd)
7390 (while (setq cmd (pop cmds))
7391 (substitute-key-definition cmd cmd map global-map)))
7392 (suppress-keymap map)
7393 (org-defkey map "\C-m" 'org-goto-ret)
7394 (org-defkey map [(return)] 'org-goto-ret)
7395 (org-defkey map [(left)] 'org-goto-left)
7396 (org-defkey map [(right)] 'org-goto-right)
7397 (org-defkey map [(control ?g)] 'org-goto-quit)
7398 (org-defkey map "\C-i" 'org-cycle)
7399 (org-defkey map [(tab)] 'org-cycle)
7400 (org-defkey map [(down)] 'outline-next-visible-heading)
7401 (org-defkey map [(up)] 'outline-previous-visible-heading)
7402 (if org-goto-auto-isearch
7403 (if (fboundp 'define-key-after)
7404 (define-key-after map [t] 'org-goto-local-auto-isearch)
7405 nil)
7406 (org-defkey map "q" 'org-goto-quit)
7407 (org-defkey map "n" 'outline-next-visible-heading)
7408 (org-defkey map "p" 'outline-previous-visible-heading)
7409 (org-defkey map "f" 'outline-forward-same-level)
7410 (org-defkey map "b" 'outline-backward-same-level)
7411 (org-defkey map "u" 'outline-up-heading))
7412 (org-defkey map "/" 'org-occur)
7413 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7414 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7415 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7416 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7417 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7418 map)))
7420 (defconst org-goto-help
7421 "Browse buffer copy, to find location or copy text.%s
7422 RET=jump to location C-g=quit and return to previous location
7423 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7425 (defvar org-goto-start-pos) ; dynamically scoped parameter
7427 (defun org-goto (&optional alternative-interface)
7428 "Look up a different location in the current file, keeping current visibility.
7430 When you want look-up or go to a different location in a
7431 document, the fastest way is often to fold the entire buffer and
7432 then dive into the tree. This method has the disadvantage, that
7433 the previous location will be folded, which may not be what you
7434 want.
7436 This command works around this by showing a copy of the current
7437 buffer in an indirect buffer, in overview mode. You can dive
7438 into the tree in that copy, use org-occur and incremental search
7439 to find a location. When pressing RET or `Q', the command
7440 returns to the original buffer in which the visibility is still
7441 unchanged. After RET it will also jump to the location selected
7442 in the indirect buffer and expose the headline hierarchy above.
7444 With a prefix argument, use the alternative interface: e.g. if
7445 `org-goto-interface' is 'outline use 'outline-path-completion."
7446 (interactive "P")
7447 (org-goto-map)
7448 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7449 (org-refile-use-outline-path t)
7450 (org-refile-target-verify-function nil)
7451 (interface
7452 (if (not alternative-interface)
7453 org-goto-interface
7454 (if (eq org-goto-interface 'outline)
7455 'outline-path-completion
7456 'outline)))
7457 (org-goto-start-pos (point))
7458 (selected-point
7459 (if (eq interface 'outline)
7460 (car (org-get-location (current-buffer) org-goto-help))
7461 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7462 (org-refile-check-position pa)
7463 (nth 3 pa)))))
7464 (if selected-point
7465 (progn
7466 (org-mark-ring-push org-goto-start-pos)
7467 (goto-char selected-point)
7468 (if (or (outline-invisible-p) (org-invisible-p2))
7469 (org-show-context 'org-goto)))
7470 (message "Quit"))))
7472 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7473 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7474 (defvar org-goto-local-auto-isearch-map) ; defined below
7476 (defun org-get-location (buf help)
7477 "Let the user select a location in the Org-mode buffer BUF.
7478 This function uses a recursive edit. It returns the selected position
7479 or nil."
7480 (org-no-popups
7481 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7482 (isearch-hide-immediately nil)
7483 (isearch-search-fun-function
7484 (lambda () 'org-goto-local-search-headings))
7485 (org-goto-selected-point org-goto-exit-command))
7486 (save-excursion
7487 (save-window-excursion
7488 (delete-other-windows)
7489 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7490 (org-pop-to-buffer-same-window
7491 (condition-case nil
7492 (make-indirect-buffer (current-buffer) "*org-goto*")
7493 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7494 (with-output-to-temp-buffer "*Org Help*"
7495 (princ (format help (if org-goto-auto-isearch
7496 " Just type for auto-isearch."
7497 " n/p/f/b/u to navigate, q to quit."))))
7498 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7499 (setq buffer-read-only nil)
7500 (let ((org-startup-truncated t)
7501 (org-startup-folded nil)
7502 (org-startup-align-all-tables nil))
7503 (org-mode)
7504 (org-overview))
7505 (setq buffer-read-only t)
7506 (if (and (boundp 'org-goto-start-pos)
7507 (integer-or-marker-p org-goto-start-pos))
7508 (progn (goto-char org-goto-start-pos)
7509 (when (outline-invisible-p)
7510 (org-show-set-visibility 'lineage)))
7511 (goto-char (point-min)))
7512 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7513 (message "Select location and press RET")
7514 (use-local-map org-goto-map)
7515 (recursive-edit)))
7516 (kill-buffer "*org-goto*")
7517 (cons org-goto-selected-point org-goto-exit-command))))
7519 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7520 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7521 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7522 (if (fboundp 'isearch-other-control-char)
7523 (progn
7524 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7525 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7526 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7527 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7528 (define-key org-goto-local-auto-isearch-map [return] nil))
7530 (defun org-goto-local-search-headings (string bound noerror)
7531 "Search and make sure that any matches are in headlines."
7532 (catch 'return
7533 (while (if isearch-forward
7534 (search-forward string bound noerror)
7535 (search-backward string bound noerror))
7536 (when (save-match-data
7537 (and (save-excursion
7538 (beginning-of-line)
7539 (looking-at org-complex-heading-regexp))
7540 (or (not (match-beginning 5))
7541 (< (point) (match-beginning 5)))))
7542 (throw 'return (point))))))
7544 (defun org-goto-local-auto-isearch ()
7545 "Start isearch."
7546 (interactive)
7547 (goto-char (point-min))
7548 (let ((keys (this-command-keys)))
7549 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7550 (isearch-mode t)
7551 (isearch-process-search-char (string-to-char keys)))))
7553 (defun org-goto-ret (&optional arg)
7554 "Finish `org-goto' by going to the new location."
7555 (interactive "P")
7556 (setq org-goto-selected-point (point)
7557 org-goto-exit-command 'return)
7558 (throw 'exit nil))
7560 (defun org-goto-left ()
7561 "Finish `org-goto' by going to the new location."
7562 (interactive)
7563 (if (org-at-heading-p)
7564 (progn
7565 (beginning-of-line 1)
7566 (setq org-goto-selected-point (point)
7567 org-goto-exit-command 'left)
7568 (throw 'exit nil))
7569 (user-error "Not on a heading")))
7571 (defun org-goto-right ()
7572 "Finish `org-goto' by going to the new location."
7573 (interactive)
7574 (if (org-at-heading-p)
7575 (progn
7576 (setq org-goto-selected-point (point)
7577 org-goto-exit-command 'right)
7578 (throw 'exit nil))
7579 (user-error "Not on a heading")))
7581 (defun org-goto-quit ()
7582 "Finish `org-goto' without cursor motion."
7583 (interactive)
7584 (setq org-goto-selected-point nil)
7585 (setq org-goto-exit-command 'quit)
7586 (throw 'exit nil))
7588 ;;; Indirect buffer display of subtrees
7590 (defvar org-indirect-dedicated-frame nil
7591 "This is the frame being used for indirect tree display.")
7592 (defvar org-last-indirect-buffer nil)
7594 (defun org-tree-to-indirect-buffer (&optional arg)
7595 "Create indirect buffer and narrow it to current subtree.
7596 With a numerical prefix ARG, go up to this level and then take that tree.
7597 If ARG is negative, go up that many levels.
7599 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7600 indirect buffer previously made with this command, to avoid proliferation of
7601 indirect buffers. However, when you call the command with a \
7602 \\[universal-argument] prefix, or
7603 when `org-indirect-buffer-display' is `new-frame', the last buffer
7604 is kept so that you can work with several indirect buffers at the same time.
7605 If `org-indirect-buffer-display' is `dedicated-frame', the \
7606 \\[universal-argument] prefix also
7607 requests that a new frame be made for the new buffer, so that the dedicated
7608 frame is not changed."
7609 (interactive "P")
7610 (let ((cbuf (current-buffer))
7611 (cwin (selected-window))
7612 (pos (point))
7613 beg end level heading ibuf)
7614 (save-excursion
7615 (org-back-to-heading t)
7616 (when (numberp arg)
7617 (setq level (org-outline-level))
7618 (if (< arg 0) (setq arg (+ level arg)))
7619 (while (> (setq level (org-outline-level)) arg)
7620 (org-up-heading-safe)))
7621 (setq beg (point)
7622 heading (org-get-heading))
7623 (org-end-of-subtree t t)
7624 (if (org-at-heading-p) (backward-char 1))
7625 (setq end (point)))
7626 (if (and (buffer-live-p org-last-indirect-buffer)
7627 (not (eq org-indirect-buffer-display 'new-frame))
7628 (not arg))
7629 (kill-buffer org-last-indirect-buffer))
7630 (setq ibuf (org-get-indirect-buffer cbuf heading)
7631 org-last-indirect-buffer ibuf)
7632 (cond
7633 ((or (eq org-indirect-buffer-display 'new-frame)
7634 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7635 (select-frame (make-frame))
7636 (delete-other-windows)
7637 (org-pop-to-buffer-same-window ibuf)
7638 (org-set-frame-title heading))
7639 ((eq org-indirect-buffer-display 'dedicated-frame)
7640 (raise-frame
7641 (select-frame (or (and org-indirect-dedicated-frame
7642 (frame-live-p org-indirect-dedicated-frame)
7643 org-indirect-dedicated-frame)
7644 (setq org-indirect-dedicated-frame (make-frame)))))
7645 (delete-other-windows)
7646 (org-pop-to-buffer-same-window ibuf)
7647 (org-set-frame-title (concat "Indirect: " heading)))
7648 ((eq org-indirect-buffer-display 'current-window)
7649 (org-pop-to-buffer-same-window ibuf))
7650 ((eq org-indirect-buffer-display 'other-window)
7651 (pop-to-buffer ibuf))
7652 (t (error "Invalid value")))
7653 (if (featurep 'xemacs)
7654 (save-excursion (org-mode) (turn-on-font-lock)))
7655 (narrow-to-region beg end)
7656 (show-all)
7657 (goto-char pos)
7658 (run-hook-with-args 'org-cycle-hook 'all)
7659 (and (window-live-p cwin) (select-window cwin))))
7661 (defun org-get-indirect-buffer (&optional buffer heading)
7662 (setq buffer (or buffer (current-buffer)))
7663 (let ((n 1) (base (buffer-name buffer)) bname)
7664 (while (buffer-live-p
7665 (get-buffer
7666 (setq bname
7667 (concat base "-"
7668 (if heading (concat heading "-" (number-to-string n))
7669 (number-to-string n))))))
7670 (setq n (1+ n)))
7671 (condition-case nil
7672 (make-indirect-buffer buffer bname 'clone)
7673 (error (make-indirect-buffer buffer bname)))))
7675 (defun org-set-frame-title (title)
7676 "Set the title of the current frame to the string TITLE."
7677 ;; FIXME: how to name a single frame in XEmacs???
7678 (unless (featurep 'xemacs)
7679 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7681 ;;;; Structure editing
7683 ;;; Inserting headlines
7685 (defun org-previous-line-empty-p (&optional next)
7686 "Is the previous line a blank line?
7687 When NEXT is non-nil, check the next line instead."
7688 (save-excursion
7689 (and (not (bobp))
7690 (or (beginning-of-line (if next 2 0)) t)
7691 (save-match-data
7692 (looking-at "[ \t]*$")))))
7694 (defun org-insert-heading (&optional arg invisible-ok top-level)
7695 "Insert a new heading or an item with the same depth at point.
7697 If point is at the beginning of a heading or a list item, insert
7698 a new heading or a new item above the current one. If point is
7699 at the beginning of a normal line, turn the line into a heading.
7701 If point is in the middle of a headline or a list item, split the
7702 headline or the item and create a new headline/item with the text
7703 in the current line after point \(see `org-M-RET-may-split-line'
7704 on how to modify this behavior).
7706 With one universal prefix argument, set the user option
7707 `org-insert-heading-respect-content' to t for the duration of
7708 the command. This modifies the behavior described above in this
7709 ways: on list items and at the beginning of normal lines, force
7710 the insertion of a heading after the current subtree.
7712 With two universal prefix arguments, insert the heading at the
7713 end of the grandparent subtree. For example, if point is within
7714 a 2nd-level heading, then it will insert a 2nd-level heading at
7715 the end of the 1st-level parent heading.
7717 If point is at the beginning of a headline, insert a sibling
7718 before the current headline. If point is not at the beginning,
7719 split the line and create a new headline with the text in the
7720 current line after point \(see `org-M-RET-may-split-line' on how
7721 to modify this behavior).
7723 If point is at the beginning of a normal line, turn this line
7724 into a heading.
7726 When INVISIBLE-OK is set, stop at invisible headlines when going
7727 back. This is important for non-interactive uses of the
7728 command.
7730 When optional argument TOP-LEVEL is non-nil, insert a level 1
7731 heading, unconditionally."
7732 (interactive "P")
7733 (if (org-called-interactively-p 'any) (org-reveal))
7734 (let ((itemp (and (not top-level) (org-in-item-p)))
7735 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7736 (respect-content (or org-insert-heading-respect-content
7737 (equal arg '(4))))
7738 (initial-content ""))
7740 (cond
7742 ((or (= (buffer-size) 0)
7743 (and (not (save-excursion
7744 (and (ignore-errors (org-back-to-heading invisible-ok))
7745 (org-at-heading-p))))
7746 (or arg (not itemp))))
7747 ;; At beginning of buffer or so high up that only a heading
7748 ;; makes sense.
7749 (cond ((and (bolp) (not respect-content)) (insert "* "))
7750 ((not respect-content)
7751 (unless may-split (end-of-line))
7752 (insert "\n* "))
7753 ((re-search-forward org-outline-regexp-bol nil t)
7754 (beginning-of-line)
7755 (insert "* \n")
7756 (backward-char))
7757 (t (goto-char (point-max))
7758 (insert "\n* ")))
7759 (run-hooks 'org-insert-heading-hook))
7761 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7764 ;; Maybe move at the end of the subtree
7765 (when (equal arg '(16))
7766 (org-up-heading-safe)
7767 (org-end-of-subtree t))
7768 ;; Insert a heading
7769 (save-restriction
7770 (widen)
7771 (let* ((level nil)
7772 (on-heading (org-at-heading-p))
7773 (empty-line-p (if on-heading
7774 (org-previous-line-empty-p)
7775 ;; We will decide later
7776 nil))
7777 ;; Get a level string to fall back on.
7778 (fix-level
7779 (if (org-before-first-heading-p) "*"
7780 (save-excursion
7781 (org-back-to-heading t)
7782 (if (org-previous-line-empty-p) (setq empty-line-p t))
7783 (looking-at org-outline-regexp)
7784 (make-string (1- (length (match-string 0))) ?*))))
7785 (stars
7786 (save-excursion
7787 (condition-case nil
7788 (if top-level "* "
7789 (org-back-to-heading invisible-ok)
7790 (when (and (not on-heading)
7791 (featurep 'org-inlinetask)
7792 (integerp org-inlinetask-min-level)
7793 (>= (length (match-string 0))
7794 org-inlinetask-min-level))
7795 ;; Find a heading level before the inline
7796 ;; task.
7797 (while (and (setq level (org-up-heading-safe))
7798 (>= level org-inlinetask-min-level)))
7799 (if (org-at-heading-p)
7800 (org-back-to-heading invisible-ok)
7801 (error "This should not happen")))
7802 (unless (and (save-excursion
7803 (save-match-data
7804 (org-backward-heading-same-level
7805 1 invisible-ok))
7806 (= (point) (match-beginning 0)))
7807 (not (org-previous-line-empty-p t)))
7808 (setq empty-line-p (or empty-line-p
7809 (org-previous-line-empty-p))))
7810 (match-string 0))
7811 (error (or fix-level "* ")))))
7812 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7813 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7814 pos hide-previous previous-pos)
7816 ;; If we insert after content, move there and clean up
7817 ;; whitespace.
7818 (when (and respect-content
7819 (not (org-looking-at-p org-outline-regexp-bol)))
7820 (if (not (org-before-first-heading-p))
7821 (org-end-of-subtree nil t)
7822 (re-search-forward org-outline-regexp-bol)
7823 (beginning-of-line 0))
7824 (skip-chars-backward " \r\t\n")
7825 (and (not (looking-back "^\\*+"))
7826 (looking-at "[ \t]+") (replace-match ""))
7827 (unless (eobp) (forward-char 1))
7828 (when (looking-at "^\\*")
7829 (unless (bobp) (backward-char 1))
7830 (insert "\n")))
7832 ;; If we are splitting, grab the text that should be moved
7833 ;; to the new headline.
7834 (when may-split
7835 (if (org-on-heading-p)
7836 ;; This is a heading: split intelligently (keeping
7837 ;; tags).
7838 (let ((pos (point)))
7839 (beginning-of-line)
7840 (unless (looking-at org-complex-heading-regexp)
7841 (error "This should not happen"))
7842 (when (and (match-beginning 4)
7843 (> pos (match-beginning 4))
7844 (< pos (match-end 4)))
7845 (setq initial-content (buffer-substring pos (match-end 4)))
7846 (goto-char pos)
7847 (delete-region (point) (match-end 4))
7848 (if (looking-at "[ \t]*$")
7849 (replace-match "")
7850 (insert (make-string (length initial-content) ?\s)))
7851 (setq initial-content (org-trim initial-content)))
7852 (goto-char pos))
7853 ;; A normal line.
7854 (setq initial-content
7855 (org-trim
7856 (delete-and-extract-region (point) (line-end-position))))))
7858 ;; If we are at the beginning of the line, insert before it.
7859 ;; Otherwise, after it.
7860 (cond
7861 ((and (bolp) (looking-at "[ \t]*$")))
7862 ((bolp) (save-excursion (insert "\n")))
7863 (t (end-of-line)
7864 (insert "\n")))
7866 ;; Insert the new heading
7867 (insert stars)
7868 (just-one-space)
7869 (insert initial-content)
7870 (unless (and blank (org-previous-line-empty-p))
7871 (org-N-empty-lines-before-current (if blank 1 0)))
7872 ;; Adjust visibility, which may be messed up if we removed
7873 ;; blank lines while previous entry was hidden.
7874 (let ((bol (line-beginning-position)))
7875 (dolist (o (overlays-at (1- bol)))
7876 (when (and (eq (overlay-get o 'invisible) 'outline)
7877 (eq (overlay-end o) bol))
7878 (move-overlay o (overlay-start o) (1- bol)))))
7879 (run-hooks 'org-insert-heading-hook)))))))
7881 (defun org-N-empty-lines-before-current (N)
7882 "Make the number of empty lines before current exactly N.
7883 So this will delete or add empty lines."
7884 (save-excursion
7885 (beginning-of-line)
7886 (let ((p (point)))
7887 (skip-chars-backward " \r\t\n")
7888 (unless (bolp) (forward-line))
7889 (delete-region (point) p))
7890 (when (> N 0) (insert (make-string N ?\n)))))
7892 (defun org-get-heading (&optional no-tags no-todo)
7893 "Return the heading of the current entry, without the stars.
7894 When NO-TAGS is non-nil, don't include tags.
7895 When NO-TODO is non-nil, don't include TODO keywords."
7896 (save-excursion
7897 (org-back-to-heading t)
7898 (cond
7899 ((and no-tags no-todo)
7900 (looking-at org-complex-heading-regexp)
7901 (match-string 4))
7902 (no-tags
7903 (looking-at (concat org-outline-regexp
7904 "\\(.*?\\)"
7905 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7906 (match-string 1))
7907 (no-todo
7908 (looking-at org-todo-line-regexp)
7909 (match-string 3))
7910 (t (looking-at org-heading-regexp)
7911 (match-string 2)))))
7913 (defvar orgstruct-mode) ; defined below
7915 (defun org-heading-components ()
7916 "Return the components of the current heading.
7917 This is a list with the following elements:
7918 - the level as an integer
7919 - the reduced level, different if `org-odd-levels-only' is set.
7920 - the TODO keyword, or nil
7921 - the priority character, like ?A, or nil if no priority is given
7922 - the headline text itself, or the tags string if no headline text
7923 - the tags string, or nil."
7924 (save-excursion
7925 (org-back-to-heading t)
7926 (if (let (case-fold-search)
7927 (looking-at
7928 (if orgstruct-mode
7929 org-heading-regexp
7930 org-complex-heading-regexp)))
7931 (if orgstruct-mode
7932 (list (length (match-string 1))
7933 (org-reduced-level (length (match-string 1)))
7936 (match-string 2)
7937 nil)
7938 (list (length (match-string 1))
7939 (org-reduced-level (length (match-string 1)))
7940 (org-match-string-no-properties 2)
7941 (and (match-end 3) (aref (match-string 3) 2))
7942 (org-match-string-no-properties 4)
7943 (org-match-string-no-properties 5))))))
7945 (defun org-get-entry ()
7946 "Get the entry text, after heading, entire subtree."
7947 (save-excursion
7948 (org-back-to-heading t)
7949 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7951 (defun org-insert-heading-after-current ()
7952 "Insert a new heading with same level as current, after current subtree."
7953 (interactive)
7954 (org-back-to-heading)
7955 (org-insert-heading)
7956 (org-move-subtree-down)
7957 (end-of-line 1))
7959 (defun org-insert-heading-respect-content (&optional invisible-ok)
7960 "Insert heading with `org-insert-heading-respect-content' set to t."
7961 (interactive)
7962 (org-insert-heading '(4) invisible-ok))
7964 (defun org-insert-todo-heading-respect-content (&optional force-state)
7965 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7966 (interactive)
7967 (org-insert-todo-heading force-state '(4)))
7969 (defun org-insert-todo-heading (arg &optional force-heading)
7970 "Insert a new heading with the same level and TODO state as current heading.
7971 If the heading has no TODO state, or if the state is DONE, use the first
7972 state (TODO by default). Also with one prefix arg, force first state. With
7973 two prefix args, force inserting at the end of the parent subtree."
7974 (interactive "P")
7975 (when (or force-heading (not (org-insert-item 'checkbox)))
7976 (org-insert-heading (or (and (equal arg '(16)) '(16))
7977 force-heading))
7978 (save-excursion
7979 (org-back-to-heading)
7980 (outline-previous-heading)
7981 (looking-at org-todo-line-regexp))
7982 (let*
7983 ((new-mark-x
7984 (if (or (equal arg '(4))
7985 (not (match-beginning 2))
7986 (member (match-string 2) org-done-keywords))
7987 (car org-todo-keywords-1)
7988 (match-string 2)))
7989 (new-mark
7991 (run-hook-with-args-until-success
7992 'org-todo-get-default-hook new-mark-x nil)
7993 new-mark-x)))
7994 (beginning-of-line 1)
7995 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7996 (if org-treat-insert-todo-heading-as-state-change
7997 (org-todo new-mark)
7998 (insert new-mark " "))))
7999 (when org-provide-todo-statistics
8000 (org-update-parent-todo-statistics))))
8002 (defun org-insert-subheading (arg)
8003 "Insert a new subheading and demote it.
8004 Works for outline headings and for plain lists alike."
8005 (interactive "P")
8006 (org-insert-heading arg)
8007 (cond
8008 ((org-at-heading-p) (org-do-demote))
8009 ((org-at-item-p) (org-indent-item))))
8011 (defun org-insert-todo-subheading (arg)
8012 "Insert a new subheading with TODO keyword or checkbox and demote it.
8013 Works for outline headings and for plain lists alike."
8014 (interactive "P")
8015 (org-insert-todo-heading arg)
8016 (cond
8017 ((org-at-heading-p) (org-do-demote))
8018 ((org-at-item-p) (org-indent-item))))
8020 ;;; Promotion and Demotion
8022 (defvar org-after-demote-entry-hook nil
8023 "Hook run after an entry has been demoted.
8024 The cursor will be at the beginning of the entry.
8025 When a subtree is being demoted, the hook will be called for each node.")
8027 (defvar org-after-promote-entry-hook nil
8028 "Hook run after an entry has been promoted.
8029 The cursor will be at the beginning of the entry.
8030 When a subtree is being promoted, the hook will be called for each node.")
8032 (defun org-promote-subtree ()
8033 "Promote the entire subtree.
8034 See also `org-promote'."
8035 (interactive)
8036 (save-excursion
8037 (org-with-limited-levels (org-map-tree 'org-promote)))
8038 (org-fix-position-after-promote))
8040 (defun org-demote-subtree ()
8041 "Demote the entire subtree. See `org-demote'.
8042 See also `org-promote'."
8043 (interactive)
8044 (save-excursion
8045 (org-with-limited-levels (org-map-tree 'org-demote)))
8046 (org-fix-position-after-promote))
8049 (defun org-do-promote ()
8050 "Promote the current heading higher up the tree.
8051 If the region is active in `transient-mark-mode', promote all headings
8052 in the region."
8053 (interactive)
8054 (save-excursion
8055 (if (org-region-active-p)
8056 (org-map-region 'org-promote (region-beginning) (region-end))
8057 (org-promote)))
8058 (org-fix-position-after-promote))
8060 (defun org-do-demote ()
8061 "Demote the current heading lower down the tree.
8062 If the region is active in `transient-mark-mode', demote all headings
8063 in the region."
8064 (interactive)
8065 (save-excursion
8066 (if (org-region-active-p)
8067 (org-map-region 'org-demote (region-beginning) (region-end))
8068 (org-demote)))
8069 (org-fix-position-after-promote))
8071 (defun org-fix-position-after-promote ()
8072 "Make sure that after pro/demotion cursor position is right."
8073 (let ((pos (point)))
8074 (when (save-excursion
8075 (beginning-of-line 1)
8076 (looking-at org-todo-line-regexp)
8077 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8078 (cond ((eobp) (insert " "))
8079 ((eolp) (insert " "))
8080 ((equal (char-after) ?\ ) (forward-char 1))))))
8082 (defun org-current-level ()
8083 "Return the level of the current entry, or nil if before the first headline.
8084 The level is the number of stars at the beginning of the
8085 headline. Use `org-reduced-level' to remove the effect of
8086 `org-odd-levels'. Unlike to `org-outline-level', this function
8087 ignores inlinetasks."
8088 (let ((level (org-with-limited-levels (org-outline-level))))
8089 (and (> level 0) level)))
8091 (defun org-get-previous-line-level ()
8092 "Return the outline depth of the last headline before the current line.
8093 Returns 0 for the first headline in the buffer, and nil if before the
8094 first headline."
8095 (and (org-current-level)
8096 (or (and (/= (line-beginning-position) (point-min))
8097 (save-excursion (beginning-of-line 0) (org-current-level)))
8098 0)))
8100 (defun org-reduced-level (l)
8101 "Compute the effective level of a heading.
8102 This takes into account the setting of `org-odd-levels-only'."
8103 (cond
8104 ((zerop l) 0)
8105 (org-odd-levels-only (1+ (floor (/ l 2))))
8106 (t l)))
8108 (defun org-level-increment ()
8109 "Return the number of stars that will be added or removed at a
8110 time to headlines when structure editing, based on the value of
8111 `org-odd-levels-only'."
8112 (if org-odd-levels-only 2 1))
8114 (defun org-get-valid-level (level &optional change)
8115 "Rectify a level change under the influence of `org-odd-levels-only'
8116 LEVEL is a current level, CHANGE is by how much the level should be
8117 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8118 even level numbers will become the next higher odd number."
8119 (if org-odd-levels-only
8120 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8121 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8122 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8123 (max 1 (+ level (or change 0)))))
8125 (if (boundp 'define-obsolete-function-alias)
8126 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8127 (define-obsolete-function-alias 'org-get-legal-level
8128 'org-get-valid-level)
8129 (define-obsolete-function-alias 'org-get-legal-level
8130 'org-get-valid-level "23.1")))
8132 (defun org-promote ()
8133 "Promote the current heading higher up the tree."
8134 (org-with-wide-buffer
8135 (org-back-to-heading t)
8136 (let* ((after-change-functions (remq 'flyspell-after-change-function
8137 after-change-functions))
8138 (level (save-match-data (funcall outline-level)))
8139 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8140 (diff (abs (- level (length up-head) -1))))
8141 (cond
8142 ((and (= level 1) org-allow-promoting-top-level-subtree)
8143 (replace-match "# " nil t))
8144 ((= level 1)
8145 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8146 (t (replace-match up-head nil t)))
8147 (unless (= level 1)
8148 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8149 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8150 (run-hooks 'org-after-promote-entry-hook))))
8152 (defun org-demote ()
8153 "Demote the current heading lower down the tree."
8154 (org-with-wide-buffer
8155 (org-back-to-heading t)
8156 (let* ((after-change-functions (remq 'flyspell-after-change-function
8157 after-change-functions))
8158 (level (save-match-data (funcall outline-level)))
8159 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8160 (diff (abs (- level (length down-head) -1))))
8161 (replace-match down-head nil t)
8162 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8163 (when org-adapt-indentation (org-fixup-indentation diff))
8164 (run-hooks 'org-after-demote-entry-hook))))
8166 (defun org-cycle-level ()
8167 "Cycle the level of an empty headline through possible states.
8168 This goes first to child, then to parent, level, then up the hierarchy.
8169 After top level, it switches back to sibling level."
8170 (interactive)
8171 (let ((org-adapt-indentation nil))
8172 (when (org-point-at-end-of-empty-headline)
8173 (setq this-command 'org-cycle-level) ; Only needed for caching
8174 (let ((cur-level (org-current-level))
8175 (prev-level (org-get-previous-line-level)))
8176 (cond
8177 ;; If first headline in file, promote to top-level.
8178 ((= prev-level 0)
8179 (loop repeat (/ (- cur-level 1) (org-level-increment))
8180 do (org-do-promote)))
8181 ;; If same level as prev, demote one.
8182 ((= prev-level cur-level)
8183 (org-do-demote))
8184 ;; If parent is top-level, promote to top level if not already.
8185 ((= prev-level 1)
8186 (loop repeat (/ (- cur-level 1) (org-level-increment))
8187 do (org-do-promote)))
8188 ;; If top-level, return to prev-level.
8189 ((= cur-level 1)
8190 (loop repeat (/ (- prev-level 1) (org-level-increment))
8191 do (org-do-demote)))
8192 ;; If less than prev-level, promote one.
8193 ((< cur-level prev-level)
8194 (org-do-promote))
8195 ;; If deeper than prev-level, promote until higher than
8196 ;; prev-level.
8197 ((> cur-level prev-level)
8198 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8199 do (org-do-promote))))
8200 t))))
8202 (defun org-map-tree (fun)
8203 "Call FUN for every heading underneath the current one."
8204 (org-back-to-heading)
8205 (let ((level (funcall outline-level)))
8206 (save-excursion
8207 (funcall fun)
8208 (while (and (progn
8209 (outline-next-heading)
8210 (> (funcall outline-level) level))
8211 (not (eobp)))
8212 (funcall fun)))))
8214 (defun org-map-region (fun beg end)
8215 "Call FUN for every heading between BEG and END."
8216 (let ((org-ignore-region t))
8217 (save-excursion
8218 (setq end (copy-marker end))
8219 (goto-char beg)
8220 (if (and (re-search-forward org-outline-regexp-bol nil t)
8221 (< (point) end))
8222 (funcall fun))
8223 (while (and (progn
8224 (outline-next-heading)
8225 (< (point) end))
8226 (not (eobp)))
8227 (funcall fun)))))
8229 (defun org-fixup-indentation (diff)
8230 "Change the indentation in the current entry by DIFF.
8232 DIFF is an integer. Indentation is done according to the
8233 following rules:
8235 - Planning information and property drawers are always indented
8236 according to the new level of the headline;
8238 - Footnote definitions and their contents are ignored;
8240 - Inlinetasks' boundaries are not shifted;
8242 - Empty lines are ignored;
8244 - Other lines' indentation are shifted by DIFF columns, unless
8245 it would introduce a structural change in the document, in
8246 which case no shifting is done at all.
8248 Assume point is at a heading or an inlinetask beginning."
8249 (org-with-wide-buffer
8250 (narrow-to-region (line-beginning-position)
8251 (save-excursion
8252 (if (org-with-limited-levels (org-at-heading-p))
8253 (org-with-limited-levels (outline-next-heading))
8254 (org-inlinetask-goto-end))
8255 (point)))
8256 (forward-line)
8257 ;; Indent properly planning info and property drawer.
8258 (when (org-looking-at-p org-planning-line-re)
8259 (org-indent-line)
8260 (forward-line))
8261 (when (looking-at org-property-drawer-re)
8262 (goto-char (match-end 0))
8263 (forward-line)
8264 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8265 (catch 'no-shift
8266 (when (zerop diff) (throw 'no-shift nil))
8267 ;; If DIFF is negative, first check if a shift is possible at all
8268 ;; (e.g., it doesn't break structure). This can only happen if
8269 ;; some contents are not properly indented.
8270 (let ((case-fold-search t))
8271 (when (< diff 0)
8272 (let ((diff (- diff))
8273 (forbidden-re (concat org-outline-regexp
8274 "\\|"
8275 (substring org-footnote-definition-re 1))))
8276 (save-excursion
8277 (while (not (eobp))
8278 (cond
8279 ((org-looking-at-p "[ \t]*$") (forward-line))
8280 ((and (org-looking-at-p org-footnote-definition-re)
8281 (let ((e (org-element-at-point)))
8282 (and (eq (org-element-type e) 'footnote-definition)
8283 (goto-char (org-element-property :end e))))))
8284 ((org-looking-at-p org-outline-regexp) (forward-line))
8285 ;; Give up if shifting would move before column 0 or
8286 ;; if it would introduce a headline or a footnote
8287 ;; definition.
8289 (skip-chars-forward " \t")
8290 (let ((ind (current-column)))
8291 (when (or (< ind diff)
8292 (and (= ind diff) (org-looking-at-p forbidden-re)))
8293 (throw 'no-shift nil)))
8294 ;; Ignore contents of example blocks and source
8295 ;; blocks if their indentation is meant to be
8296 ;; preserved. Jump to block's closing line.
8297 (beginning-of-line)
8298 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8299 (let ((e (org-element-at-point)))
8300 (and (memq (org-element-type e)
8301 '(example-block src-block))
8302 (or org-src-preserve-indentation
8303 (org-element-property :preserve-indent e))
8304 (goto-char (org-element-property :end e))
8305 (progn (skip-chars-backward " \r\t\n")
8306 (beginning-of-line)
8307 t))))
8308 (forward-line))))))))
8309 ;; Shift lines but footnote definitions, inlinetasks boundaries
8310 ;; by DIFF. Also skip contents of source or example blocks
8311 ;; when indentation is meant to be preserved.
8312 (while (not (eobp))
8313 (cond
8314 ((and (org-looking-at-p org-footnote-definition-re)
8315 (let ((e (org-element-at-point)))
8316 (and (eq (org-element-type e) 'footnote-definition)
8317 (goto-char (org-element-property :end e))))))
8318 ((org-looking-at-p org-outline-regexp) (forward-line))
8319 ((org-looking-at-p "[ \t]*$") (forward-line))
8321 (org-indent-line-to (+ (org-get-indentation) diff))
8322 (beginning-of-line)
8323 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8324 (let ((e (org-element-at-point)))
8325 (and (memq (org-element-type e)
8326 '(example-block src-block))
8327 (or org-src-preserve-indentation
8328 (org-element-property :preserve-indent e))
8329 (goto-char (org-element-property :end e))
8330 (progn (skip-chars-backward " \r\t\n")
8331 (beginning-of-line)
8332 t))))
8333 (forward-line)))))))))
8335 (defun org-convert-to-odd-levels ()
8336 "Convert an org-mode file with all levels allowed to one with odd levels.
8337 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8338 level 5 etc."
8339 (interactive)
8340 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8341 (let ((outline-level 'org-outline-level)
8342 (org-odd-levels-only nil) n)
8343 (save-excursion
8344 (goto-char (point-min))
8345 (while (re-search-forward "^\\*\\*+ " nil t)
8346 (setq n (- (length (match-string 0)) 2))
8347 (while (>= (setq n (1- n)) 0)
8348 (org-demote))
8349 (end-of-line 1))))))
8351 (defun org-convert-to-oddeven-levels ()
8352 "Convert an org-mode file with only odd levels to one with odd/even levels.
8353 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8354 file contains a section with an even level, conversion would
8355 destroy the structure of the file. An error is signaled in this
8356 case."
8357 (interactive)
8358 (goto-char (point-min))
8359 ;; First check if there are no even levels
8360 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8361 (org-show-set-visibility 'canonical)
8362 (error "Not all levels are odd in this file. Conversion not possible"))
8363 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8364 (let ((outline-regexp org-outline-regexp)
8365 (outline-level 'org-outline-level)
8366 (org-odd-levels-only nil) n)
8367 (save-excursion
8368 (goto-char (point-min))
8369 (while (re-search-forward "^\\*\\*+ " nil t)
8370 (setq n (/ (1- (length (match-string 0))) 2))
8371 (while (>= (setq n (1- n)) 0)
8372 (org-promote))
8373 (end-of-line 1))))))
8375 (defun org-tr-level (n)
8376 "Make N odd if required."
8377 (if org-odd-levels-only (1+ (/ n 2)) n))
8379 ;;; Vertical tree motion, cutting and pasting of subtrees
8381 (defun org-move-subtree-up (&optional arg)
8382 "Move the current subtree up past ARG headlines of the same level."
8383 (interactive "p")
8384 (org-move-subtree-down (- (prefix-numeric-value arg))))
8386 (defun org-move-subtree-down (&optional arg)
8387 "Move the current subtree down past ARG headlines of the same level."
8388 (interactive "p")
8389 (setq arg (prefix-numeric-value arg))
8390 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8391 'org-get-last-sibling))
8392 (ins-point (make-marker))
8393 (cnt (abs arg))
8394 (col (current-column))
8395 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8396 ;; Select the tree
8397 (org-back-to-heading)
8398 (setq beg0 (point))
8399 (save-excursion
8400 (setq ne-beg (org-back-over-empty-lines))
8401 (setq beg (point)))
8402 (save-match-data
8403 (save-excursion (outline-end-of-heading)
8404 (setq folded (outline-invisible-p)))
8405 (progn (org-end-of-subtree nil t)
8406 (unless (eobp) (backward-char))))
8407 (outline-next-heading)
8408 (setq ne-end (org-back-over-empty-lines))
8409 (setq end (point))
8410 (goto-char beg0)
8411 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8412 ;; include less whitespace
8413 (save-excursion
8414 (goto-char beg)
8415 (forward-line (- ne-beg ne-end))
8416 (setq beg (point))))
8417 ;; Find insertion point, with error handling
8418 (while (> cnt 0)
8419 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8420 (progn (goto-char beg0)
8421 (user-error "Cannot move past superior level or buffer limit")))
8422 (setq cnt (1- cnt)))
8423 (if (> arg 0)
8424 ;; Moving forward - still need to move over subtree
8425 (progn (org-end-of-subtree t t)
8426 (save-excursion
8427 (org-back-over-empty-lines)
8428 (or (bolp) (newline)))))
8429 (setq ne-ins (org-back-over-empty-lines))
8430 (move-marker ins-point (point))
8431 (setq txt (buffer-substring beg end))
8432 (org-save-markers-in-region beg end)
8433 (delete-region beg end)
8434 (org-remove-empty-overlays-at beg)
8435 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8436 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8437 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8438 (let ((bbb (point)))
8439 (insert-before-markers txt)
8440 (org-reinstall-markers-in-region bbb)
8441 (move-marker ins-point bbb))
8442 (or (bolp) (insert "\n"))
8443 (setq ins-end (point))
8444 (goto-char ins-point)
8445 (org-skip-whitespace)
8446 (when (and (< arg 0)
8447 (org-first-sibling-p)
8448 (> ne-ins ne-beg))
8449 ;; Move whitespace back to beginning
8450 (save-excursion
8451 (goto-char ins-end)
8452 (let ((kill-whole-line t))
8453 (kill-line (- ne-ins ne-beg)) (point)))
8454 (insert (make-string (- ne-ins ne-beg) ?\n)))
8455 (move-marker ins-point nil)
8456 (if folded
8457 (hide-subtree)
8458 (org-show-entry)
8459 (show-children)
8460 (org-cycle-hide-drawers 'children))
8461 (org-clean-visibility-after-subtree-move)
8462 ;; move back to the initial column we were at
8463 (move-to-column col)))
8465 (defvar org-subtree-clip ""
8466 "Clipboard for cut and paste of subtrees.
8467 This is actually only a copy of the kill, because we use the normal kill
8468 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8470 (defvar org-subtree-clip-folded nil
8471 "Was the last copied subtree folded?
8472 This is used to fold the tree back after pasting.")
8474 (defun org-cut-subtree (&optional n)
8475 "Cut the current subtree into the clipboard.
8476 With prefix arg N, cut this many sequential subtrees.
8477 This is a short-hand for marking the subtree and then cutting it."
8478 (interactive "p")
8479 (org-copy-subtree n 'cut))
8481 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8482 "Copy the current subtree it in the clipboard.
8483 With prefix arg N, copy this many sequential subtrees.
8484 This is a short-hand for marking the subtree and then copying it.
8485 If CUT is non-nil, actually cut the subtree.
8486 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8487 of some markers in the region, even if CUT is non-nil. This is
8488 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8489 (interactive "p")
8490 (let (beg end folded (beg0 (point)))
8491 (if (org-called-interactively-p 'any)
8492 (org-back-to-heading nil) ; take what looks like a subtree
8493 (org-back-to-heading t)) ; take what is really there
8494 (setq beg (point))
8495 (skip-chars-forward " \t\r\n")
8496 (save-match-data
8497 (if nosubtrees
8498 (outline-next-heading)
8499 (save-excursion (outline-end-of-heading)
8500 (setq folded (outline-invisible-p)))
8501 (ignore-errors (org-forward-heading-same-level (1- n) t))
8502 (org-end-of-subtree t t)))
8503 ;; Include the end of an inlinetask
8504 (when (and (featurep 'org-inlinetask)
8505 (looking-at-p (concat (org-inlinetask-outline-regexp)
8506 "END[ \t]*$")))
8507 (end-of-line))
8508 (setq end (point))
8509 (goto-char beg0)
8510 (when (> end beg)
8511 (setq org-subtree-clip-folded folded)
8512 (when (or cut force-store-markers)
8513 (org-save-markers-in-region beg end))
8514 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8515 (setq org-subtree-clip (current-kill 0))
8516 (message "%s: Subtree(s) with %d characters"
8517 (if cut "Cut" "Copied")
8518 (length org-subtree-clip)))))
8520 (defun org-paste-subtree (&optional level tree for-yank remove)
8521 "Paste the clipboard as a subtree, with modification of headline level.
8522 The entire subtree is promoted or demoted in order to match a new headline
8523 level.
8525 If the cursor is at the beginning of a headline, the same level as
8526 that headline is used to paste the tree.
8528 If not, the new level is derived from the *visible* headings
8529 before and after the insertion point, and taken to be the inferior headline
8530 level of the two. So if the previous visible heading is level 3 and the
8531 next is level 4 (or vice versa), level 4 will be used for insertion.
8532 This makes sure that the subtree remains an independent subtree and does
8533 not swallow low level entries.
8535 You can also force a different level, either by using a numeric prefix
8536 argument, or by inserting the heading marker by hand. For example, if the
8537 cursor is after \"*****\", then the tree will be shifted to level 5.
8539 If optional TREE is given, use this text instead of the kill ring.
8541 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8542 move back over whitespace before inserting, and move point to the end of
8543 the inserted text when done.
8545 When REMOVE is non-nil, remove the subtree from the clipboard."
8546 (interactive "P")
8547 (setq tree (or tree (and kill-ring (current-kill 0))))
8548 (unless (org-kill-is-subtree-p tree)
8549 (user-error "%s"
8550 (substitute-command-keys
8551 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8552 (org-with-limited-levels
8553 (let* ((visp (not (outline-invisible-p)))
8554 (txt tree)
8555 (^re_ "\\(\\*+\\)[ \t]*")
8556 (old-level (if (string-match org-outline-regexp-bol txt)
8557 (- (match-end 0) (match-beginning 0) 1)
8558 -1))
8559 (force-level (cond (level (prefix-numeric-value level))
8560 ((and (looking-at "[ \t]*$")
8561 (string-match
8562 "^\\*+$" (buffer-substring
8563 (point-at-bol) (point))))
8564 (- (match-end 0) (match-beginning 0)))
8565 ((and (bolp)
8566 (looking-at org-outline-regexp))
8567 (- (match-end 0) (point) 1))))
8568 (previous-level (save-excursion
8569 (condition-case nil
8570 (progn
8571 (outline-previous-visible-heading 1)
8572 (if (looking-at ^re_)
8573 (- (match-end 0) (match-beginning 0) 1)
8575 (error 1))))
8576 (next-level (save-excursion
8577 (condition-case nil
8578 (progn
8579 (or (looking-at org-outline-regexp)
8580 (outline-next-visible-heading 1))
8581 (if (looking-at ^re_)
8582 (- (match-end 0) (match-beginning 0) 1)
8584 (error 1))))
8585 (new-level (or force-level (max previous-level next-level)))
8586 (shift (if (or (= old-level -1)
8587 (= new-level -1)
8588 (= old-level new-level))
8590 (- new-level old-level)))
8591 (delta (if (> shift 0) -1 1))
8592 (func (if (> shift 0) 'org-demote 'org-promote))
8593 (org-odd-levels-only nil)
8594 beg end newend)
8595 ;; Remove the forced level indicator
8596 (if force-level
8597 (delete-region (point-at-bol) (point)))
8598 ;; Paste
8599 (beginning-of-line (if (bolp) 1 2))
8600 (setq beg (point))
8601 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8602 (insert-before-markers txt)
8603 (unless (string-match "\n\\'" txt) (insert "\n"))
8604 (setq newend (point))
8605 (org-reinstall-markers-in-region beg)
8606 (setq end (point))
8607 (goto-char beg)
8608 (skip-chars-forward " \t\n\r")
8609 (setq beg (point))
8610 (if (and (outline-invisible-p) visp)
8611 (save-excursion (outline-show-heading)))
8612 ;; Shift if necessary
8613 (unless (= shift 0)
8614 (save-restriction
8615 (narrow-to-region beg end)
8616 (while (not (= shift 0))
8617 (org-map-region func (point-min) (point-max))
8618 (setq shift (+ delta shift)))
8619 (goto-char (point-min))
8620 (setq newend (point-max))))
8621 (when (or (org-called-interactively-p 'interactive) for-yank)
8622 (message "Clipboard pasted as level %d subtree" new-level))
8623 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8624 kill-ring
8625 (eq org-subtree-clip (current-kill 0))
8626 org-subtree-clip-folded)
8627 ;; The tree was folded before it was killed/copied
8628 (hide-subtree))
8629 (and for-yank (goto-char newend))
8630 (and remove (setq kill-ring (cdr kill-ring))))))
8632 (defun org-kill-is-subtree-p (&optional txt)
8633 "Check if the current kill is an outline subtree, or a set of trees.
8634 Returns nil if kill does not start with a headline, or if the first
8635 headline level is not the largest headline level in the tree.
8636 So this will actually accept several entries of equal levels as well,
8637 which is OK for `org-paste-subtree'.
8638 If optional TXT is given, check this string instead of the current kill."
8639 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8640 (re (org-get-limited-outline-regexp))
8641 (^re (concat "^" re))
8642 (start-level (and kill
8643 (string-match
8644 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8645 kill)
8646 (- (match-end 2) (match-beginning 2) 1)))
8647 (start (1+ (or (match-beginning 2) -1))))
8648 (if (not start-level)
8649 (progn
8650 nil) ;; does not even start with a heading
8651 (catch 'exit
8652 (while (setq start (string-match ^re kill (1+ start)))
8653 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8654 (throw 'exit nil)))
8655 t))))
8657 (defvar org-markers-to-move nil
8658 "Markers that should be moved with a cut-and-paste operation.
8659 Those markers are stored together with their positions relative to
8660 the start of the region.")
8662 (defun org-save-markers-in-region (beg end)
8663 "Check markers in region.
8664 If these markers are between BEG and END, record their position relative
8665 to BEG, so that after moving the block of text, we can put the markers back
8666 into place.
8667 This function gets called just before an entry or tree gets cut from the
8668 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8669 called immediately, to move the markers with the entries."
8670 (setq org-markers-to-move nil)
8671 (when (featurep 'org-clock)
8672 (org-clock-save-markers-for-cut-and-paste beg end))
8673 (when (featurep 'org-agenda)
8674 (org-agenda-save-markers-for-cut-and-paste beg end)))
8676 (defun org-check-and-save-marker (marker beg end)
8677 "Check if MARKER is between BEG and END.
8678 If yes, remember the marker and the distance to BEG."
8679 (when (and (marker-buffer marker)
8680 (equal (marker-buffer marker) (current-buffer)))
8681 (if (and (>= marker beg) (< marker end))
8682 (push (cons marker (- marker beg)) org-markers-to-move))))
8684 (defun org-reinstall-markers-in-region (beg)
8685 "Move all remembered markers to their position relative to BEG."
8686 (mapc (lambda (x)
8687 (move-marker (car x) (+ beg (cdr x))))
8688 org-markers-to-move)
8689 (setq org-markers-to-move nil))
8691 (defun org-narrow-to-subtree ()
8692 "Narrow buffer to the current subtree."
8693 (interactive)
8694 (save-excursion
8695 (save-match-data
8696 (org-with-limited-levels
8697 (narrow-to-region
8698 (progn (org-back-to-heading t) (point))
8699 (progn (org-end-of-subtree t t)
8700 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8701 (point)))))))
8703 (defun org-narrow-to-block ()
8704 "Narrow buffer to the current block."
8705 (interactive)
8706 (let* ((case-fold-search t)
8707 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8708 "^[ \t]*#\\+end_.*")))
8709 (if blockp
8710 (narrow-to-region (car blockp) (cdr blockp))
8711 (user-error "Not in a block"))))
8713 (defun org-clone-subtree-with-time-shift (n &optional shift)
8714 "Clone the task (subtree) at point N times.
8715 The clones will be inserted as siblings.
8717 In interactive use, the user will be prompted for the number of
8718 clones to be produced. If the entry has a timestamp, the user
8719 will also be prompted for a time shift, which may be a repeater
8720 as used in time stamps, for example `+3d'. To disable this,
8721 you can call the function with a universal prefix argument.
8723 When a valid repeater is given and the entry contains any time
8724 stamps, the clones will become a sequence in time, with time
8725 stamps in the subtree shifted for each clone produced. If SHIFT
8726 is nil or the empty string, time stamps will be left alone. The
8727 ID property of the original subtree is removed.
8729 If the original subtree did contain time stamps with a repeater,
8730 the following will happen:
8731 - the repeater will be removed in each clone
8732 - an additional clone will be produced, with the current, unshifted
8733 date(s) in the entry.
8734 - the original entry will be placed *after* all the clones, with
8735 repeater intact.
8736 - the start days in the repeater in the original entry will be shifted
8737 to past the last clone.
8738 In this way you can spell out a number of instances of a repeating task,
8739 and still retain the repeater to cover future instances of the task.
8741 As described above, N+1 clones are produced when the original
8742 subtree has a repeater. Setting N to 0, then, can be used to
8743 remove the repeater from a subtree and create a shifted clone
8744 with the original repeater."
8745 (interactive "nNumber of clones to produce: ")
8746 (let ((shift
8747 (or shift
8748 (if (and (not (equal current-prefix-arg '(4)))
8749 (save-excursion
8750 (re-search-forward org-ts-regexp-both
8751 (save-excursion
8752 (org-end-of-subtree t)
8753 (point)) t)))
8754 (read-from-minibuffer
8755 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8756 ""))) ;; No time shift
8757 (n-no-remove -1)
8758 (drawer-re org-drawer-regexp)
8759 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8760 beg end template task idprop
8761 shift-n shift-what doshift nmin nmax)
8762 (unless (wholenump n)
8763 (user-error "Invalid number of replications %s" n))
8764 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8765 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8766 shift)))
8767 (user-error "Invalid shift specification %s" shift))
8768 (when doshift
8769 (setq shift-n (string-to-number (match-string 1 shift))
8770 shift-what (cdr (assoc (match-string 2 shift)
8771 '(("d" . day) ("w" . week)
8772 ("m" . month) ("y" . year))))))
8773 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8774 (setq nmin 1 nmax n)
8775 (org-back-to-heading t)
8776 (setq beg (point))
8777 (setq idprop (org-entry-get nil "ID"))
8778 (org-end-of-subtree t t)
8779 (or (bolp) (insert "\n"))
8780 (setq end (point))
8781 (setq template (buffer-substring beg end))
8782 (when (and doshift
8783 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8784 (delete-region beg end)
8785 (setq end beg)
8786 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8787 (goto-char end)
8788 (loop for n from nmin to nmax do
8789 ;; prepare clone
8790 (with-temp-buffer
8791 (insert template)
8792 (org-mode)
8793 (goto-char (point-min))
8794 (org-show-subtree)
8795 (and idprop (if org-clone-delete-id
8796 (org-entry-delete nil "ID")
8797 (org-id-get-create t)))
8798 (unless (= n 0)
8799 (while (re-search-forward org-clock-re nil t)
8800 (kill-whole-line))
8801 (goto-char (point-min))
8802 (while (re-search-forward drawer-re nil t)
8803 (org-remove-empty-drawer-at (point))))
8804 (goto-char (point-min))
8805 (when doshift
8806 (while (re-search-forward org-ts-regexp-both nil t)
8807 (org-timestamp-change (* n shift-n) shift-what))
8808 (unless (= n n-no-remove)
8809 (goto-char (point-min))
8810 (while (re-search-forward org-ts-regexp nil t)
8811 (save-excursion
8812 (goto-char (match-beginning 0))
8813 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8814 (delete-region (match-beginning 1) (match-end 1)))))))
8815 (setq task (buffer-string)))
8816 (insert task))
8817 (goto-char beg)))
8819 ;;; Outline Sorting
8821 (defun org-sort (with-case)
8822 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8823 Optional argument WITH-CASE means sort case-sensitively."
8824 (interactive "P")
8825 (cond
8826 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8827 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8829 (org-call-with-arg 'org-sort-entries with-case))))
8831 (defun org-sort-remove-invisible (s)
8832 "Remove invisible links from string S."
8833 (remove-text-properties 0 (length s) org-rm-props s)
8834 (while (string-match org-bracket-link-regexp s)
8835 (setq s (replace-match (if (match-end 2)
8836 (match-string 3 s)
8837 (match-string 1 s)) t t s)))
8838 (let ((st (format " %s " s)))
8839 (while (string-match org-emph-re st)
8840 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8841 (setq s (substring st 1 -1)))
8844 (defvar org-priority-regexp) ; defined later in the file
8846 (defvar org-after-sorting-entries-or-items-hook nil
8847 "Hook that is run after a bunch of entries or items have been sorted.
8848 When children are sorted, the cursor is in the parent line when this
8849 hook gets called. When a region or a plain list is sorted, the cursor
8850 will be in the first entry of the sorted region/list.")
8852 (defun org-sort-entries
8853 (&optional with-case sorting-type getkey-func compare-func property)
8854 "Sort entries on a certain level of an outline tree.
8855 If there is an active region, the entries in the region are sorted.
8856 Else, if the cursor is before the first entry, sort the top-level items.
8857 Else, the children of the entry at point are sorted.
8859 Sorting can be alphabetically, numerically, by date/time as given by
8860 a time stamp, by a property, by priority order, or by a custom function.
8862 The command prompts for the sorting type unless it has been given to the
8863 function through the SORTING-TYPE argument, which needs to be a character,
8864 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8865 the precise meaning of each character:
8867 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8868 c By creation time, which is assumed to be the first inactive time stamp
8869 at the beginning of a line.
8870 d By deadline date/time.
8871 k By clocking time.
8872 n Numerically, by converting the beginning of the entry/item to a number.
8873 o By order of TODO keywords.
8874 p By priority according to the cookie.
8875 r By the value of a property.
8876 s By scheduled date/time.
8877 t By date/time, either the first active time stamp in the entry, or, if
8878 none exist, by the first inactive one.
8880 Capital letters will reverse the sort order.
8882 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8883 called with point at the beginning of the record. It must return either
8884 a string or a number that should serve as the sorting key for that record.
8886 Comparing entries ignores case by default. However, with an optional argument
8887 WITH-CASE, the sorting considers case as well.
8889 Sorting is done against the visible part of the headlines, it ignores hidden
8890 links.
8892 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8893 (interactive "P")
8894 (let ((case-func (if with-case 'identity 'downcase))
8895 (cmstr
8896 ;; The clock marker is lost when using `sort-subr', let's
8897 ;; store the clocking string.
8898 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8899 (save-excursion
8900 (goto-char org-clock-marker)
8901 (looking-back "^.*") (match-string-no-properties 0))))
8902 start beg end stars re re2
8903 txt what tmp)
8904 ;; Find beginning and end of region to sort
8905 (cond
8906 ((org-region-active-p)
8907 ;; we will sort the region
8908 (setq end (region-end)
8909 what "region")
8910 (goto-char (region-beginning))
8911 (if (not (org-at-heading-p)) (outline-next-heading))
8912 (setq start (point)))
8913 ((or (org-at-heading-p)
8914 (ignore-errors (progn (org-back-to-heading) t)))
8915 ;; we will sort the children of the current headline
8916 (org-back-to-heading)
8917 (setq start (point)
8918 end (progn (org-end-of-subtree t t)
8919 (or (bolp) (insert "\n"))
8920 (when (>= (org-back-over-empty-lines) 1)
8921 (forward-line 1))
8922 (point))
8923 what "children")
8924 (goto-char start)
8925 (show-subtree)
8926 (outline-next-heading))
8928 ;; we will sort the top-level entries in this file
8929 (goto-char (point-min))
8930 (or (org-at-heading-p) (outline-next-heading))
8931 (setq start (point))
8932 (goto-char (point-max))
8933 (beginning-of-line 1)
8934 (when (looking-at ".*?\\S-")
8935 ;; File ends in a non-white line
8936 (end-of-line 1)
8937 (insert "\n"))
8938 (setq end (point-max))
8939 (setq what "top-level")
8940 (goto-char start)
8941 (show-all)))
8943 (setq beg (point))
8944 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8946 (looking-at "\\(\\*+\\)")
8947 (setq stars (match-string 1)
8948 re (concat "^" (regexp-quote stars) " +")
8949 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8950 txt (buffer-substring beg end))
8951 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8952 (if (and (not (equal stars "*")) (string-match re2 txt))
8953 (user-error "Region to sort contains a level above the first entry"))
8955 (unless sorting-type
8956 (message
8957 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8958 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8959 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8960 what)
8961 (setq sorting-type (read-char-exclusive))
8963 (unless getkey-func
8964 (and (= (downcase sorting-type) ?f)
8965 (setq getkey-func
8966 (org-icompleting-read "Sort using function: "
8967 obarray 'fboundp t nil nil))
8968 (setq getkey-func (intern getkey-func))))
8970 (and (= (downcase sorting-type) ?r)
8971 (not property)
8972 (setq property
8973 (org-icompleting-read "Property: "
8974 (mapcar 'list (org-buffer-property-keys t))
8975 nil t))))
8977 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8978 (message "Sorting entries...")
8980 (save-restriction
8981 (narrow-to-region start end)
8982 (let ((dcst (downcase sorting-type))
8983 (case-fold-search nil)
8984 (now (current-time)))
8985 (sort-subr
8986 (/= dcst sorting-type)
8987 ;; This function moves to the beginning character of the "record" to
8988 ;; be sorted.
8989 (lambda nil
8990 (if (re-search-forward re nil t)
8991 (goto-char (match-beginning 0))
8992 (goto-char (point-max))))
8993 ;; This function moves to the last character of the "record" being
8994 ;; sorted.
8995 (lambda nil
8996 (save-match-data
8997 (condition-case nil
8998 (outline-forward-same-level 1)
8999 (error
9000 (goto-char (point-max))))))
9001 ;; This function returns the value that gets sorted against.
9002 (lambda nil
9003 (cond
9004 ((= dcst ?n)
9005 (if (looking-at org-complex-heading-regexp)
9006 (string-to-number (org-sort-remove-invisible (match-string 4)))
9007 nil))
9008 ((= dcst ?a)
9009 (if (looking-at org-complex-heading-regexp)
9010 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9011 nil))
9012 ((= dcst ?k)
9013 (or (get-text-property (point) :org-clock-minutes) 0))
9014 ((= dcst ?t)
9015 (let ((end (save-excursion (outline-next-heading) (point))))
9016 (if (or (re-search-forward org-ts-regexp end t)
9017 (re-search-forward org-ts-regexp-both end t))
9018 (org-time-string-to-seconds (match-string 0))
9019 (org-float-time now))))
9020 ((= dcst ?c)
9021 (let ((end (save-excursion (outline-next-heading) (point))))
9022 (if (re-search-forward
9023 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9024 end t)
9025 (org-time-string-to-seconds (match-string 0))
9026 (org-float-time now))))
9027 ((= dcst ?s)
9028 (let ((end (save-excursion (outline-next-heading) (point))))
9029 (if (re-search-forward org-scheduled-time-regexp end t)
9030 (org-time-string-to-seconds (match-string 1))
9031 (org-float-time now))))
9032 ((= dcst ?d)
9033 (let ((end (save-excursion (outline-next-heading) (point))))
9034 (if (re-search-forward org-deadline-time-regexp end t)
9035 (org-time-string-to-seconds (match-string 1))
9036 (org-float-time now))))
9037 ((= dcst ?p)
9038 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9039 (string-to-char (match-string 2))
9040 org-default-priority))
9041 ((= dcst ?r)
9042 (or (org-entry-get nil property) ""))
9043 ((= dcst ?o)
9044 (if (looking-at org-complex-heading-regexp)
9045 (let* ((m (match-string 2))
9046 (s (if (member m org-done-keywords) '- '+)))
9047 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9048 ((= dcst ?f)
9049 (if getkey-func
9050 (progn
9051 (setq tmp (funcall getkey-func))
9052 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9053 tmp)
9054 (error "Invalid key function `%s'" getkey-func)))
9055 (t (error "Invalid sorting type `%c'" sorting-type))))
9057 (cond
9058 ((= dcst ?a) 'string<)
9059 ((= dcst ?f) compare-func)
9060 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9061 (run-hooks 'org-after-sorting-entries-or-items-hook)
9062 ;; Reset the clock marker if needed
9063 (when cmstr
9064 (save-excursion
9065 (goto-char start)
9066 (search-forward cmstr nil t)
9067 (move-marker org-clock-marker (point))))
9068 (message "Sorting entries...done")))
9070 ;;; The orgstruct minor mode
9072 ;; Define a minor mode which can be used in other modes in order to
9073 ;; integrate the org-mode structure editing commands.
9075 ;; This is really a hack, because the org-mode structure commands use
9076 ;; keys which normally belong to the major mode. Here is how it
9077 ;; works: The minor mode defines all the keys necessary to operate the
9078 ;; structure commands, but wraps the commands into a function which
9079 ;; tests if the cursor is currently at a headline or a plain list
9080 ;; item. If that is the case, the structure command is used,
9081 ;; temporarily setting many Org-mode variables like regular
9082 ;; expressions for filling etc. However, when any of those keys is
9083 ;; used at a different location, function uses `key-binding' to look
9084 ;; up if the key has an associated command in another currently active
9085 ;; keymap (minor modes, major mode, global), and executes that
9086 ;; command. There might be problems if any of the keys is otherwise
9087 ;; used as a prefix key.
9089 (defcustom orgstruct-heading-prefix-regexp ""
9090 "Regexp that matches the custom prefix of Org headlines in
9091 orgstruct(++)-mode."
9092 :group 'org
9093 :version "24.4"
9094 :package-version '(Org . "8.3")
9095 :type 'regexp)
9096 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9098 (defcustom orgstruct-setup-hook nil
9099 "Hook run after orgstruct-mode-map is filled."
9100 :group 'org
9101 :version "24.4"
9102 :package-version '(Org . "8.0")
9103 :type 'hook)
9105 (defvar orgstruct-initialized nil)
9107 (defvar org-local-vars nil
9108 "List of local variables, for use by `orgstruct-mode'.")
9110 ;;;###autoload
9111 (define-minor-mode orgstruct-mode
9112 "Toggle the minor mode `orgstruct-mode'.
9113 This mode is for using Org-mode structure commands in other
9114 modes. The following keys behave as if Org-mode were active, if
9115 the cursor is on a headline, or on a plain list item (both as
9116 defined by Org-mode)."
9117 nil " OrgStruct" (make-sparse-keymap)
9118 (funcall (if orgstruct-mode
9119 'add-to-invisibility-spec
9120 'remove-from-invisibility-spec)
9121 '(outline . t))
9122 (when orgstruct-mode
9123 (org-load-modules-maybe)
9124 (unless orgstruct-initialized
9125 (orgstruct-setup)
9126 (setq orgstruct-initialized t))))
9128 ;;;###autoload
9129 (defun turn-on-orgstruct ()
9130 "Unconditionally turn on `orgstruct-mode'."
9131 (orgstruct-mode 1))
9133 (defvar org-fb-vars nil)
9134 (make-variable-buffer-local 'org-fb-vars)
9135 (defun orgstruct++-mode (&optional arg)
9136 "Toggle `orgstruct-mode', the enhanced version of it.
9137 In addition to setting orgstruct-mode, this also exports all
9138 indentation and autofilling variables from org-mode into the
9139 buffer. It will also recognize item context in multiline items."
9140 (interactive "P")
9141 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9142 (if (< arg 1)
9143 (progn (orgstruct-mode -1)
9144 (mapc (lambda(v)
9145 (org-set-local (car v)
9146 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9147 org-fb-vars))
9148 (orgstruct-mode 1)
9149 (setq org-fb-vars nil)
9150 (unless org-local-vars
9151 (setq org-local-vars (org-get-local-variables)))
9152 (let (var val)
9153 (mapc
9154 (lambda (x)
9155 (when (string-match
9156 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9157 (symbol-name (car x)))
9158 (setq var (car x) val (nth 1 x))
9159 (push (list var `(quote ,(eval var))) org-fb-vars)
9160 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9161 org-local-vars)
9162 (org-set-local 'orgstruct-is-++ t))))
9164 (defvar orgstruct-is-++ nil
9165 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9166 (make-variable-buffer-local 'orgstruct-is-++)
9168 ;;;###autoload
9169 (defun turn-on-orgstruct++ ()
9170 "Unconditionally turn on `orgstruct++-mode'."
9171 (orgstruct++-mode 1))
9173 (defun orgstruct-error ()
9174 "Error when there is no default binding for a structure key."
9175 (interactive)
9176 (funcall (if (fboundp 'user-error)
9177 'user-error
9178 'error)
9179 "This key has no function outside structure elements"))
9181 (defun orgstruct-setup ()
9182 "Setup orgstruct keymap."
9183 (dolist (cell '((org-demote . t)
9184 (org-metaleft . t)
9185 (org-metaright . t)
9186 (org-promote . t)
9187 (org-shiftmetaleft . t)
9188 (org-shiftmetaright . t)
9189 org-backward-element
9190 org-backward-heading-same-level
9191 org-ctrl-c-ret
9192 org-ctrl-c-minus
9193 org-ctrl-c-star
9194 org-cycle
9195 org-forward-heading-same-level
9196 org-insert-heading
9197 org-insert-heading-respect-content
9198 org-kill-note-or-show-branches
9199 org-mark-subtree
9200 org-meta-return
9201 org-metadown
9202 org-metaup
9203 org-narrow-to-subtree
9204 org-promote-subtree
9205 org-reveal
9206 org-shiftdown
9207 org-shiftleft
9208 org-shiftmetadown
9209 org-shiftmetaup
9210 org-shiftright
9211 org-shifttab
9212 org-shifttab
9213 org-shiftup
9214 org-show-subtree
9215 org-sort
9216 org-up-element
9217 outline-demote
9218 outline-next-visible-heading
9219 outline-previous-visible-heading
9220 outline-promote
9221 outline-up-heading
9222 show-children))
9223 (let ((f (or (car-safe cell) cell))
9224 (disable-when-heading-prefix (cdr-safe cell)))
9225 (when (fboundp f)
9226 (let ((new-bindings))
9227 (dolist (binding (nconc (where-is-internal f org-mode-map)
9228 (where-is-internal f outline-mode-map)))
9229 (push binding new-bindings)
9230 ;; TODO use local-function-key-map
9231 (dolist (rep '(("<tab>" . "TAB")
9232 ("<return>" . "RET")
9233 ("<escape>" . "ESC")
9234 ("<delete>" . "DEL")))
9235 (setq binding (read-kbd-macro
9236 (let ((case-fold-search))
9237 (replace-regexp-in-string
9238 (regexp-quote (cdr rep))
9239 (car rep)
9240 (key-description binding)))))
9241 (pushnew binding new-bindings :test 'equal)))
9242 (dolist (binding new-bindings)
9243 (let ((key (lookup-key orgstruct-mode-map binding)))
9244 (when (or (not key) (numberp key))
9245 (ignore-errors
9246 (org-defkey orgstruct-mode-map
9247 binding
9248 (orgstruct-make-binding
9249 f binding disable-when-heading-prefix))))))))))
9250 (run-hooks 'orgstruct-setup-hook))
9252 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9253 "Create a function for binding in the structure minor mode.
9254 FUN is the command to call inside a table. KEY is the key that
9255 should be checked in for a command to execute outside of tables.
9256 Non-nil `disable-when-heading-prefix' means to disable the command
9257 if `orgstruct-heading-prefix-regexp' is not empty."
9258 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9259 (let ((nname name)
9260 (i 0))
9261 (while (fboundp (intern nname))
9262 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9263 (setq name (intern nname)))
9264 (eval
9265 (let ((bindings '((org-heading-regexp
9266 (concat "^"
9267 orgstruct-heading-prefix-regexp
9268 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9269 (org-outline-regexp
9270 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9271 (org-outline-regexp-bol
9272 (concat "^" org-outline-regexp))
9273 (outline-regexp org-outline-regexp)
9274 (outline-heading-end-regexp "\n")
9275 (outline-level 'org-outline-level)
9276 (outline-heading-alist))))
9277 `(defun ,name (arg)
9278 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9279 "Outside of structure, run the binding of `"
9280 (key-description key) "'."
9281 (when disable-when-heading-prefix
9282 (concat
9283 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9284 "back to the default binding due to limitations of Org's implementation of\n"
9285 "`" (symbol-name fun) "'.")))
9286 (interactive "p")
9287 (let* ((disable
9288 ,(and disable-when-heading-prefix
9289 '(not (string= orgstruct-heading-prefix-regexp ""))))
9290 (fallback
9291 (or disable
9292 (not
9293 (let* ,bindings
9294 (org-context-p 'headline 'item
9295 ,(when (memq fun
9296 '(org-insert-heading
9297 org-insert-heading-respect-content
9298 org-meta-return))
9299 '(when orgstruct-is-++
9300 'item-body))))))))
9301 (if fallback
9302 (let* ((orgstruct-mode)
9303 (binding
9304 (let ((key ,key))
9305 (catch 'exit
9306 (dolist
9307 (rep
9308 '(nil
9309 ("<\\([^>]*\\)tab>" . "\\1TAB")
9310 ("<\\([^>]*\\)return>" . "\\1RET")
9311 ("<\\([^>]*\\)escape>" . "\\1ESC")
9312 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9313 nil)
9314 (when rep
9315 (setq key (read-kbd-macro
9316 (let ((case-fold-search))
9317 (replace-regexp-in-string
9318 (car rep)
9319 (cdr rep)
9320 (key-description key))))))
9321 (when (key-binding key)
9322 (throw 'exit (key-binding key))))))))
9323 (if (keymapp binding)
9324 (org-set-transient-map binding)
9325 (let ((func (or binding
9326 (unless disable
9327 'orgstruct-error))))
9328 (when func
9329 (call-interactively func)))))
9330 (org-run-like-in-org-mode
9331 (lambda ()
9332 (interactive)
9333 (let* ,bindings
9334 (call-interactively ',fun)))))))))
9335 name))
9337 (defun org-contextualize-keys (alist contexts)
9338 "Return valid elements in ALIST depending on CONTEXTS.
9340 `org-agenda-custom-commands' or `org-capture-templates' are the
9341 values used for ALIST, and `org-agenda-custom-commands-contexts'
9342 or `org-capture-templates-contexts' are the associated contexts
9343 definitions."
9344 (let ((contexts
9345 ;; normalize contexts
9346 (mapcar
9347 (lambda(c) (cond ((listp (cadr c))
9348 (list (car c) (car c) (cadr c)))
9349 ((string= "" (cadr c))
9350 (list (car c) (car c) (caddr c)))
9351 (t c))) contexts))
9352 (a alist) c r s)
9353 ;; loop over all commands or templates
9354 (while (setq c (pop a))
9355 (let (vrules repl)
9356 (cond
9357 ((not (assoc (car c) contexts))
9358 (push c r))
9359 ((and (assoc (car c) contexts)
9360 (setq vrules (org-contextualize-validate-key
9361 (car c) contexts)))
9362 (mapc (lambda (vr)
9363 (when (not (equal (car vr) (cadr vr)))
9364 (setq repl vr))) vrules)
9365 (if (not repl) (push c r)
9366 (push (cadr repl) s)
9367 (push
9368 (cons (car c)
9369 (cdr (or (assoc (cadr repl) alist)
9370 (error "Undefined key `%s' as contextual replacement for `%s'"
9371 (cadr repl) (car c)))))
9372 r))))))
9373 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9374 (delq
9376 (delete-dups
9377 (mapcar (lambda (x)
9378 (let ((tpl (car x)))
9379 (when (not (delq
9381 (mapcar (lambda(y)
9382 (equal y tpl)) s))) x)))
9383 (reverse r))))))
9385 (defun org-contextualize-validate-key (key contexts)
9386 "Check CONTEXTS for agenda or capture KEY."
9387 (let (r rr res)
9388 (while (setq r (pop contexts))
9389 (mapc
9390 (lambda (rr)
9391 (when
9392 (and (equal key (car r))
9393 (if (functionp rr) (funcall rr)
9394 (or (and (eq (car rr) 'in-file)
9395 (buffer-file-name)
9396 (string-match (cdr rr) (buffer-file-name)))
9397 (and (eq (car rr) 'in-mode)
9398 (string-match (cdr rr) (symbol-name major-mode)))
9399 (and (eq (car rr) 'in-buffer)
9400 (string-match (cdr rr) (buffer-name)))
9401 (when (and (eq (car rr) 'not-in-file)
9402 (buffer-file-name))
9403 (not (string-match (cdr rr) (buffer-file-name))))
9404 (when (eq (car rr) 'not-in-mode)
9405 (not (string-match (cdr rr) (symbol-name major-mode))))
9406 (when (eq (car rr) 'not-in-buffer)
9407 (not (string-match (cdr rr) (buffer-name)))))))
9408 (push r res)))
9409 (car (last r))))
9410 (delete-dups (delq nil res))))
9412 (defun org-context-p (&rest contexts)
9413 "Check if local context is any of CONTEXTS.
9414 Possible values in the list of contexts are `table', `headline', and `item'."
9415 (let ((pos (point)))
9416 (goto-char (point-at-bol))
9417 (prog1 (or (and (memq 'table contexts)
9418 (looking-at "[ \t]*|"))
9419 (and (memq 'headline contexts)
9420 (looking-at org-outline-regexp))
9421 (and (memq 'item contexts)
9422 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9423 (and (memq 'item-body contexts)
9424 (org-in-item-p)))
9425 (goto-char pos))))
9427 (defun org-get-local-variables ()
9428 "Return a list of all local variables in an Org mode buffer."
9429 (let (varlist)
9430 (with-current-buffer (get-buffer-create "*Org tmp*")
9431 (erase-buffer)
9432 (org-mode)
9433 (setq varlist (buffer-local-variables)))
9434 (kill-buffer "*Org tmp*")
9435 (delq nil
9436 (mapcar
9437 (lambda (x)
9438 (setq x
9439 (if (symbolp x)
9440 (list x)
9441 (list (car x) (cdr x))))
9442 (if (and (not (get (car x) 'org-state))
9443 (string-match
9444 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9445 (symbol-name (car x))))
9446 x nil))
9447 varlist))))
9449 (defun org-clone-local-variables (from-buffer &optional regexp)
9450 "Clone local variables from FROM-BUFFER.
9451 Optional argument REGEXP selects variables to clone."
9452 (mapc
9453 (lambda (pair)
9454 (and (symbolp (car pair))
9455 (or (null regexp)
9456 (string-match regexp (symbol-name (car pair))))
9457 (set (make-local-variable (car pair))
9458 (cdr pair))))
9459 (buffer-local-variables from-buffer)))
9461 ;;;###autoload
9462 (defun org-run-like-in-org-mode (cmd)
9463 "Run a command, pretending that the current buffer is in Org-mode.
9464 This will temporarily bind local variables that are typically bound in
9465 Org-mode to the values they have in Org-mode, and then interactively
9466 call CMD."
9467 (org-load-modules-maybe)
9468 (unless org-local-vars
9469 (setq org-local-vars (org-get-local-variables)))
9470 (let (binds)
9471 (dolist (var org-local-vars)
9472 (when (or (not (boundp (car var)))
9473 (eq (symbol-value (car var))
9474 (default-value (car var))))
9475 (push (list (car var) `(quote ,(cadr var))) binds)))
9476 (eval `(let ,binds
9477 (call-interactively (quote ,cmd))))))
9479 (defun org-get-category (&optional pos force-refresh)
9480 "Get the category applying to position POS."
9481 (save-match-data
9482 (if force-refresh (org-refresh-category-properties))
9483 (let ((pos (or pos (point))))
9484 (or (get-text-property pos 'org-category)
9485 (progn (org-refresh-category-properties)
9486 (get-text-property pos 'org-category))))))
9488 ;;; Refresh properties
9490 (defun org-refresh-properties (dprop tprop)
9491 "Refresh buffer text properties.
9492 DPROP is the drawer property and TPROP is either the
9493 corresponding text property to set, or an alist with each element
9494 being a text property (as a symbol) and a function to apply to
9495 the value of the drawer property."
9496 (let ((case-fold-search t)
9497 (inhibit-read-only t))
9498 (org-with-silent-modifications
9499 (save-excursion
9500 (save-restriction
9501 (widen)
9502 (goto-char (point-min))
9503 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9504 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9506 (defun org-refresh-property (tprop p)
9507 "Refresh the buffer text property TPROP from the drawer property P.
9508 The refresh happens only for the current tree (not subtree)."
9509 (unless (org-before-first-heading-p)
9510 (save-excursion
9511 (org-back-to-heading t)
9512 (if (symbolp tprop)
9513 ;; TPROP is a text property symbol
9514 (put-text-property
9515 (point) (or (outline-next-heading) (point-max)) tprop p)
9516 ;; TPROP is an alist with (properties . function) elements
9517 (dolist (al tprop)
9518 (save-excursion
9519 (put-text-property
9520 (line-beginning-position) (or (outline-next-heading) (point-max))
9521 (car al)
9522 (funcall (cdr al) p))))))))
9524 (defun org-refresh-category-properties ()
9525 "Refresh category text properties in the buffer."
9526 (let ((case-fold-search t)
9527 (inhibit-read-only t)
9528 (default-category
9529 (cond ((null org-category)
9530 (if buffer-file-name
9531 (file-name-sans-extension
9532 (file-name-nondirectory buffer-file-name))
9533 "???"))
9534 ((symbolp org-category) (symbol-name org-category))
9535 (t org-category))))
9536 (org-with-silent-modifications
9537 (org-with-wide-buffer
9538 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9539 ;; This is the default category for the buffer. If none is
9540 ;; found, fall-back to `org-category' or buffer file name.
9541 (put-text-property
9542 (point-min) (point-max)
9543 'org-category
9544 (catch 'buffer-category
9545 (goto-char (point-max))
9546 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9547 (let ((element (org-element-at-point)))
9548 (when (eq (org-element-type element) 'keyword)
9549 (throw 'buffer-category
9550 (org-element-property :value element)))))
9551 default-category))
9552 ;; Set sub-tree specific categories.
9553 (goto-char (point-min))
9554 (let ((regexp (org-re-property "CATEGORY")))
9555 (while (re-search-forward regexp nil t)
9556 (let ((value (org-match-string-no-properties 3)))
9557 (when (org-at-property-p)
9558 (put-text-property
9559 (save-excursion (org-back-to-heading t) (point))
9560 (save-excursion (org-end-of-subtree t t) (point))
9561 'org-category
9562 value)))))))))
9564 (defun org-refresh-stats-properties ()
9565 "Refresh stats text properties in the buffer."
9566 (let (stats)
9567 (org-with-silent-modifications
9568 (save-excursion
9569 (save-restriction
9570 (widen)
9571 (goto-char (point-min))
9572 (while (re-search-forward
9573 (concat org-outline-regexp-bol ".*"
9574 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9575 nil t)
9576 (setq stats (cond ((equal (match-string 3) "0") 0)
9577 ((match-string 2)
9578 (/ (* (string-to-number (match-string 2)) 100)
9579 (string-to-number (match-string 3))))
9580 (t (string-to-number (match-string 1)))))
9581 (org-back-to-heading t)
9582 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9583 'org-stats stats)))))))
9585 (defun org-refresh-effort-properties ()
9586 "Refresh effort properties"
9587 (org-refresh-properties
9588 org-effort-property
9589 '((effort . identity)
9590 (effort-minutes . org-duration-string-to-minutes))))
9592 ;;;; Link Stuff
9594 ;;; Link abbreviations
9596 (defun org-link-expand-abbrev (link)
9597 "Apply replacements as defined in `org-link-abbrev-alist'."
9598 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9599 (let* ((key (match-string 1 link))
9600 (as (or (assoc key org-link-abbrev-alist-local)
9601 (assoc key org-link-abbrev-alist)))
9602 (tag (and (match-end 2) (match-string 3 link)))
9603 rpl)
9604 (if (not as)
9605 link
9606 (setq rpl (cdr as))
9607 (cond
9608 ((symbolp rpl) (funcall rpl tag))
9609 ((string-match "%(\\([^)]+\\))" rpl)
9610 (replace-match
9611 (save-match-data
9612 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9613 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9614 ((string-match "%h" rpl)
9615 (replace-match (url-hexify-string (or tag "")) t t rpl))
9616 (t (concat rpl tag)))))
9617 link))
9619 ;;; Storing and inserting links
9621 (defvar org-insert-link-history nil
9622 "Minibuffer history for links inserted with `org-insert-link'.")
9624 (defvar org-stored-links nil
9625 "Contains the links stored with `org-store-link'.")
9627 (defvar org-store-link-plist nil
9628 "Plist with info about the most recently link created with `org-store-link'.")
9630 (defvar org-link-protocols nil
9631 "Link protocols added to Org-mode using `org-add-link-type'.")
9633 (defvar org-store-link-functions nil
9634 "List of functions that are called to create and store a link.
9635 Each function will be called in turn until one returns a non-nil
9636 value. Each function should check if it is responsible for creating
9637 this link (for example by looking at the major mode).
9638 If not, it must exit and return nil.
9639 If yes, it should return a non-nil value after a calling
9640 `org-store-link-props' with a list of properties and values.
9641 Special properties are:
9643 :type The link prefix, like \"http\". This must be given.
9644 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9645 This is obligatory as well.
9646 :description Optional default description for the second pair
9647 of brackets in an Org-mode link. The user can still change
9648 this when inserting this link into an Org-mode buffer.
9650 In addition to these, any additional properties can be specified
9651 and then used in capture templates.")
9653 (defun org-add-link-type (type &optional follow export)
9654 "Add TYPE to the list of `org-link-types'.
9655 Re-compute all regular expressions depending on `org-link-types'
9657 FOLLOW and EXPORT are two functions.
9659 FOLLOW should take the link path as the single argument and do whatever
9660 is necessary to follow the link, for example find a file or display
9661 a mail message.
9663 EXPORT should format the link path for export to one of the export formats.
9664 It should be a function accepting three arguments:
9666 path the path of the link, the text after the prefix (like \"http:\")
9667 desc the description of the link, if any
9668 format the export format, a symbol like `html' or `latex' or `ascii'.
9670 The function may use the FORMAT information to return different values
9671 depending on the format. The return value will be put literally into
9672 the exported file. If the return value is nil, this means Org should
9673 do what it normally does with links which do not have EXPORT defined.
9675 Org mode has a built-in default for exporting links. If you are happy with
9676 this default, there is no need to define an export function for the link
9677 type. For a simple example of an export function, see `org-bbdb.el'."
9678 (add-to-list 'org-link-types type t)
9679 (org-make-link-regexps)
9680 (org-element-update-syntax)
9681 (if (assoc type org-link-protocols)
9682 (setcdr (assoc type org-link-protocols) (list follow export))
9683 (push (list type follow export) org-link-protocols)))
9685 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9686 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9688 ;;;###autoload
9689 (defun org-store-link (arg)
9690 "\\<org-mode-map>Store an org-link to the current location.
9691 This link is added to `org-stored-links' and can later be inserted
9692 into an Org buffer with \\[org-insert-link].
9694 For some link types, a prefix ARG is interpreted.
9695 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9696 For file links, ARG negates `org-context-in-file-links'.
9698 A double prefix ARG force skipping storing functions that are not
9699 part of Org's core.
9701 A triple prefix ARG force storing a link for each line in the
9702 active region."
9703 (interactive "P")
9704 (org-load-modules-maybe)
9705 (if (and (equal arg '(64)) (org-region-active-p))
9706 (save-excursion
9707 (let ((end (region-end)))
9708 (goto-char (region-beginning))
9709 (set-mark (point))
9710 (while (< (point-at-eol) end)
9711 (move-end-of-line 1) (activate-mark)
9712 (let (current-prefix-arg)
9713 (call-interactively 'org-store-link))
9714 (move-beginning-of-line 2)
9715 (set-mark (point)))))
9716 (org-with-limited-levels
9717 (setq org-store-link-plist nil)
9718 (let (link cpltxt desc description search
9719 txt custom-id agenda-link sfuns sfunsn)
9720 (cond
9722 ;; Store a link using an external link type
9723 ((and (not (equal arg '(16)))
9724 (setq sfuns
9725 (delq
9726 nil (mapcar (lambda (f)
9727 (let (fs) (if (funcall f) (push f fs))))
9728 org-store-link-functions))
9729 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9730 (or (and (cdr sfuns)
9731 (funcall (intern
9732 (completing-read
9733 "Which function for creating the link? "
9734 sfunsn nil t (car sfunsn)))))
9735 (funcall (caar sfuns)))
9736 (setq link (plist-get org-store-link-plist :link)
9737 desc (or (plist-get org-store-link-plist
9738 :description) link))))
9740 ;; Store a link from a source code buffer.
9741 ((org-src-edit-buffer-p)
9742 (cond
9743 ((save-excursion
9744 (beginning-of-line)
9745 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9746 "[ \t]*$")))
9747 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9748 ((org-called-interactively-p 'any)
9749 (let (label)
9750 (while (or (not label)
9751 (org-with-wide-buffer
9752 (goto-char (point-min))
9753 (re-search-forward
9754 (regexp-quote (format org-coderef-label-format label))
9755 nil t)))
9756 (when label (message "Label exists already") (sit-for 2))
9757 (setq label (read-string "Code line label: " label)))
9758 (end-of-line)
9759 (setq link (format org-coderef-label-format label))
9760 (let ((gc (- 79 (length link))))
9761 (if (< (current-column) gc) (org-move-to-column gc t)
9762 (insert " ")))
9763 (insert link)
9764 (setq link (concat "(" label ")") desc nil)))
9765 (t (setq link nil))))
9767 ;; We are in the agenda, link to referenced location
9768 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9769 (let ((m (or (get-text-property (point) 'org-hd-marker)
9770 (get-text-property (point) 'org-marker))))
9771 (when m
9772 (org-with-point-at m
9773 (setq agenda-link
9774 (if (org-called-interactively-p 'any)
9775 (call-interactively 'org-store-link)
9776 (org-store-link nil)))))))
9778 ((eq major-mode 'calendar-mode)
9779 (let ((cd (calendar-cursor-to-date)))
9780 (setq link
9781 (format-time-string
9782 (car org-time-stamp-formats)
9783 (apply 'encode-time
9784 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9785 nil nil nil))))
9786 (org-store-link-props :type "calendar" :date cd)))
9788 ((eq major-mode 'help-mode)
9789 (setq link (concat "help:" (save-excursion
9790 (goto-char (point-min))
9791 (looking-at "^[^ ]+")
9792 (match-string 0))))
9793 (org-store-link-props :type "help"))
9795 ((eq major-mode 'w3-mode)
9796 (setq cpltxt (if (and (buffer-name)
9797 (not (string-match "Untitled" (buffer-name))))
9798 (buffer-name)
9799 (url-view-url t))
9800 link (url-view-url t))
9801 (org-store-link-props :type "w3" :url (url-view-url t)))
9803 ((eq major-mode 'image-mode)
9804 (setq cpltxt (concat "file:"
9805 (abbreviate-file-name buffer-file-name))
9806 link cpltxt)
9807 (org-store-link-props :type "image" :file buffer-file-name))
9809 ;; In dired, store a link to the file of the current line
9810 ((derived-mode-p 'dired-mode)
9811 (let ((file (dired-get-filename nil t)))
9812 (setq file (if file
9813 (abbreviate-file-name
9814 (expand-file-name (dired-get-filename nil t)))
9815 ;; otherwise, no file so use current directory.
9816 default-directory))
9817 (setq cpltxt (concat "file:" file)
9818 link cpltxt)))
9820 ((setq search (run-hook-with-args-until-success
9821 'org-create-file-search-functions))
9822 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9823 "::" search))
9824 (setq cpltxt (or description link)))
9826 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9827 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9828 (cond
9829 ;; Store a link using the target at point
9830 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9831 (setq cpltxt
9832 (concat "file:"
9833 (abbreviate-file-name
9834 (buffer-file-name (buffer-base-buffer)))
9835 "::" (match-string 1))
9836 link cpltxt))
9837 ((and (featurep 'org-id)
9838 (or (eq org-id-link-to-org-use-id t)
9839 (and (org-called-interactively-p 'any)
9840 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9841 (and (eq org-id-link-to-org-use-id
9842 'create-if-interactive-and-no-custom-id)
9843 (not custom-id))))
9844 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9845 ;; Store a link using the ID at point
9846 (setq link (condition-case nil
9847 (prog1 (org-id-store-link)
9848 (setq desc (or (plist-get org-store-link-plist
9849 :description)
9850 "")))
9851 (error
9852 ;; Probably before first headline, link only to file
9853 (concat "file:"
9854 (abbreviate-file-name
9855 (buffer-file-name (buffer-base-buffer))))))))
9857 ;; Just link to current headline
9858 (setq cpltxt (concat "file:"
9859 (abbreviate-file-name
9860 (buffer-file-name (buffer-base-buffer)))))
9861 ;; Add a context search string
9862 (when (org-xor org-context-in-file-links arg)
9863 (let* ((ee (org-element-at-point))
9864 (et (org-element-type ee))
9865 (ev (plist-get (cadr ee) :value))
9866 (ek (plist-get (cadr ee) :key))
9867 (eok (and (stringp ek) (string-match "name" ek))))
9868 (setq txt (cond
9869 ((org-at-heading-p) nil)
9870 ((and (eq et 'keyword) eok) ev)
9871 ((org-region-active-p)
9872 (buffer-substring (region-beginning) (region-end)))))
9873 (when (or (null txt) (string-match "\\S-" txt))
9874 (setq cpltxt
9875 (concat cpltxt "::"
9876 (condition-case nil
9877 (org-make-org-heading-search-string txt)
9878 (error "")))
9879 desc (or (and (eq et 'keyword) eok ev)
9880 (nth 4 (ignore-errors (org-heading-components)))
9881 "NONE")))))
9882 (if (string-match "::\\'" cpltxt)
9883 (setq cpltxt (substring cpltxt 0 -2)))
9884 (setq link cpltxt))))
9886 ((buffer-file-name (buffer-base-buffer))
9887 ;; Just link to this file here.
9888 (setq cpltxt (concat "file:"
9889 (abbreviate-file-name
9890 (buffer-file-name (buffer-base-buffer)))))
9891 ;; Add a context string.
9892 (when (org-xor org-context-in-file-links arg)
9893 (setq txt (if (org-region-active-p)
9894 (buffer-substring (region-beginning) (region-end))
9895 (buffer-substring (point-at-bol) (point-at-eol))))
9896 ;; Only use search option if there is some text.
9897 (when (string-match "\\S-" txt)
9898 (setq cpltxt
9899 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9900 desc "NONE")))
9901 (setq link cpltxt))
9903 ((org-called-interactively-p 'interactive)
9904 (user-error "No method for storing a link from this buffer"))
9906 (t (setq link nil)))
9908 ;; We're done setting link and desc, clean up
9909 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9910 (setq link (or link cpltxt)
9911 desc (or desc cpltxt))
9912 (cond ((equal desc "NONE") (setq desc nil))
9913 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9914 (let ((d0 (match-string 3 desc))
9915 (p0 (match-string 5 desc)))
9916 (setq desc
9917 (replace-regexp-in-string
9918 org-bracket-link-regexp
9919 (concat (or p0 d0)
9920 (if (equal (length (match-string 0 desc))
9921 (length desc)) "*" "")) desc)))))
9923 ;; Return the link
9924 (if (not (and (or (org-called-interactively-p 'any)
9925 executing-kbd-macro) link))
9926 (or agenda-link (and link (org-make-link-string link desc)))
9927 (push (list link desc) org-stored-links)
9928 (message "Stored: %s" (or desc link))
9929 (when custom-id
9930 (setq link (concat "file:" (abbreviate-file-name
9931 (buffer-file-name)) "::#" custom-id))
9932 (push (list link desc) org-stored-links))
9933 (car org-stored-links))))))
9935 (defun org-store-link-props (&rest plist)
9936 "Store link properties, extract names and addresses."
9937 (let (x adr)
9938 (when (setq x (plist-get plist :from))
9939 (setq adr (mail-extract-address-components x))
9940 (setq plist (plist-put plist :fromname (car adr)))
9941 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9942 (when (setq x (plist-get plist :to))
9943 (setq adr (mail-extract-address-components x))
9944 (setq plist (plist-put plist :toname (car adr)))
9945 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9946 (let ((from (plist-get plist :from))
9947 (to (plist-get plist :to)))
9948 (when (and from to org-from-is-user-regexp)
9949 (setq plist
9950 (plist-put plist :fromto
9951 (if (string-match org-from-is-user-regexp from)
9952 (concat "to %t")
9953 (concat "from %f"))))))
9954 (setq org-store-link-plist plist))
9956 (defun org-add-link-props (&rest plist)
9957 "Add these properties to the link property list."
9958 (let (key value)
9959 (while plist
9960 (setq key (pop plist) value (pop plist))
9961 (setq org-store-link-plist
9962 (plist-put org-store-link-plist key value)))))
9964 (defun org-email-link-description (&optional fmt)
9965 "Return the description part of an email link.
9966 This takes information from `org-store-link-plist' and formats it
9967 according to FMT (default from `org-email-link-description-format')."
9968 (setq fmt (or fmt org-email-link-description-format))
9969 (let* ((p org-store-link-plist)
9970 (to (plist-get p :toaddress))
9971 (from (plist-get p :fromaddress))
9972 (table
9973 (list
9974 (cons "%c" (plist-get p :fromto))
9975 (cons "%F" (plist-get p :from))
9976 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9977 (cons "%T" (plist-get p :to))
9978 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9979 (cons "%s" (plist-get p :subject))
9980 (cons "%d" (plist-get p :date))
9981 (cons "%m" (plist-get p :message-id)))))
9982 (when (string-match "%c" fmt)
9983 ;; Check if the user wrote this message
9984 (if (and org-from-is-user-regexp from to
9985 (save-match-data (string-match org-from-is-user-regexp from)))
9986 (setq fmt (replace-match "to %t" t t fmt))
9987 (setq fmt (replace-match "from %f" t t fmt))))
9988 (org-replace-escapes fmt table)))
9990 (defun org-make-org-heading-search-string (&optional string)
9991 "Make search string for the current headline or STRING."
9992 (let ((s (or string
9993 (and (derived-mode-p 'org-mode)
9994 (save-excursion
9995 (org-back-to-heading t)
9996 (org-element-property :raw-value (org-element-at-point))))))
9997 (lines org-context-in-file-links))
9998 (or string (setq s (concat "*" s))) ; Add * for headlines
9999 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10000 (when (and string (integerp lines) (> lines 0))
10001 (let ((slines (org-split-string s "\n")))
10002 (when (< lines (length slines))
10003 (setq s (mapconcat
10004 'identity
10005 (reverse (nthcdr (- (length slines) lines)
10006 (reverse slines))) "\n")))))
10007 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10009 (defun org-make-link-string (link &optional description)
10010 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10011 (unless (org-string-nw-p link) (error "Empty link"))
10012 (let ((uri (cond ((string-match org-link-types-re link)
10013 (concat (match-string 1 link)
10014 (org-link-escape (substring link (match-end 1)))))
10015 ;; For readability, url-encode internal links only
10016 ;; when absolutely needed (i.e, when they contain
10017 ;; square brackets). File links however, are
10018 ;; encoded since, e.g., spaces are significant.
10019 ((or (file-name-absolute-p link)
10020 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10021 (org-link-escape link))
10022 (t link)))
10023 (description
10024 (and (org-string-nw-p description)
10025 ;; Remove brackets from description, as they are fatal.
10026 (replace-regexp-in-string
10027 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10028 (org-trim description)))))
10029 (format "[[%s]%s]"
10031 (if description (format "[%s]" description) ""))))
10033 (defconst org-link-escape-chars
10034 ;;%20 %5B %5D %25
10035 '(?\s ?\[ ?\] ?%)
10036 "List of characters that should be escaped in a link when stored to Org.
10037 This is the list that is used for internal purposes.")
10039 (defconst org-link-escape-chars-browser
10040 ;;%20 %22
10041 '(?\s ?\")
10042 "List of characters to be escaped before handing over to the browser.
10043 If you consider using this constant then you probably want to use
10044 the function `org-link-escape-browser' instead. See there why
10045 this constant is a candidate to be removed once Org drops support
10046 for Emacs 24.1 and 24.2.")
10048 (defun org-link-escape (text &optional table merge)
10049 "Return percent escaped representation of TEXT.
10050 TEXT is a string with the text to escape.
10051 Optional argument TABLE is a list with characters that should be
10052 escaped. When nil, `org-link-escape-chars' is used.
10053 If optional argument MERGE is set, merge TABLE into
10054 `org-link-escape-chars'."
10055 (let ((characters-to-encode
10056 (cond ((null table) org-link-escape-chars)
10057 (merge (append org-link-escape-chars table))
10058 (t table))))
10059 (mapconcat
10060 (lambda (c)
10061 (if (or (memq c characters-to-encode)
10062 (and org-url-hexify-p (or (< c 32) (> c 126))))
10063 (mapconcat (lambda (e) (format "%%%.2X" e))
10064 (or (encode-coding-char c 'utf-8)
10065 (error "Unable to percent escape character: %c" c))
10067 (char-to-string c)))
10068 text "")))
10070 (defun org-link-escape-browser (text)
10071 "Escape some characters before handing over to the browser.
10072 This function is a candidate to be removed together with the
10073 constant `org-link-escape-chars-browser' once Org drops support
10074 for Emacs 24.1 and 24.2. All calls to this function will have to
10075 be replaced with `url-encode-url' which is available since Emacs
10076 24.3.1."
10077 ;; Example with the Org link
10078 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10079 ;; to open the browser with +subject:"Release 8.2" filled into the
10080 ;; query field: In this case the variable TEXT contains the
10081 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10082 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10083 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10084 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10085 (if (fboundp 'url-encode-url)
10086 (url-encode-url text)
10087 (if (org-string-match-p
10088 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10089 text)
10090 (org-link-escape text org-link-escape-chars-browser)
10091 text)))
10093 (defun org-link-unescape (str)
10094 "Unhex hexified Unicode parts in string STR.
10095 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10096 reciprocal of `org-link-escape', which see."
10097 (if (org-string-nw-p str)
10098 (replace-regexp-in-string
10099 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10100 str))
10102 (defun org-link-unescape-compound (hex)
10103 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10104 Note: this function also decodes single byte encodings like
10105 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10106 (save-match-data
10107 (let* ((bytes (cdr (split-string hex "%")))
10108 (ret "")
10109 (eat 0)
10110 (sum 0))
10111 (while bytes
10112 (let* ((val (string-to-number (pop bytes) 16))
10113 (shift-xor
10114 (if (= 0 eat)
10115 (cond
10116 ((>= val 252) (cons 6 252))
10117 ((>= val 248) (cons 5 248))
10118 ((>= val 240) (cons 4 240))
10119 ((>= val 224) (cons 3 224))
10120 ((>= val 192) (cons 2 192))
10121 (t (cons 0 0)))
10122 (cons 6 128))))
10123 (if (>= val 192) (setq eat (car shift-xor)))
10124 (setq val (logxor val (cdr shift-xor)))
10125 (setq sum (+ (lsh sum (car shift-xor)) val))
10126 (if (> eat 0) (setq eat (- eat 1)))
10127 (cond
10128 ((= 0 eat) ;multi byte
10129 (setq ret (concat ret (org-char-to-string sum)))
10130 (setq sum 0))
10131 ((not bytes) ; single byte(s)
10132 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10133 ret)))
10135 (defun org-link-unescape-single-byte-sequence (hex)
10136 "Unhexify hex-encoded single byte character sequences."
10137 (mapconcat (lambda (byte)
10138 (char-to-string (string-to-number byte 16)))
10139 (cdr (split-string hex "%")) ""))
10141 (defun org-xor (a b)
10142 "Exclusive or."
10143 (if a (not b) b))
10145 (defun org-fixup-message-id-for-http (s)
10146 "Replace special characters in a message id, so it can be used in an http query."
10147 (when (string-match "%" s)
10148 (setq s (mapconcat (lambda (c)
10149 (if (eq c ?%)
10150 "%25"
10151 (char-to-string c)))
10152 s "")))
10153 (while (string-match "<" s)
10154 (setq s (replace-match "%3C" t t s)))
10155 (while (string-match ">" s)
10156 (setq s (replace-match "%3E" t t s)))
10157 (while (string-match "@" s)
10158 (setq s (replace-match "%40" t t s)))
10161 (defun org-link-prettify (link)
10162 "Return a human-readable representation of LINK.
10163 The car of LINK must be a raw link.
10164 The cdr of LINK must be either a link description or nil."
10165 (let ((desc (or (cadr link) "<no description>")))
10166 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10167 "<" (car link) ">")))
10169 ;;;###autoload
10170 (defun org-insert-link-global ()
10171 "Insert a link like Org-mode does.
10172 This command can be called in any mode to insert a link in Org-mode syntax."
10173 (interactive)
10174 (org-load-modules-maybe)
10175 (org-run-like-in-org-mode 'org-insert-link))
10177 (defun org-insert-all-links (arg &optional pre post)
10178 "Insert all links in `org-stored-links'.
10179 When a universal prefix, do not delete the links from `org-stored-links'.
10180 When `ARG' is a number, insert the last N link(s).
10181 `PRE' and `POST' are optional arguments to define a string to
10182 prepend or to append."
10183 (interactive "P")
10184 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10185 (links (copy-seq org-stored-links))
10186 (pr (or pre "- "))
10187 (po (or post "\n"))
10188 (cnt 1) l)
10189 (if (null org-stored-links)
10190 (message "No link to insert")
10191 (while (and (or (listp arg) (>= arg cnt))
10192 (setq l (if (listp arg)
10193 (pop links)
10194 (pop org-stored-links))))
10195 (setq cnt (1+ cnt))
10196 (insert pr)
10197 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10198 (insert po)))))
10200 (defun org-insert-last-stored-link (arg)
10201 "Insert the last link stored in `org-stored-links'."
10202 (interactive "p")
10203 (org-insert-all-links arg "" "\n"))
10205 (defun org-link-fontify-links-to-this-file ()
10206 "Fontify links to the current file in `org-stored-links'."
10207 (let ((f (buffer-file-name)) a b)
10208 (setq a (mapcar (lambda(l)
10209 (let ((ll (car l)))
10210 (when (and (string-match "^file:\\(.+\\)::" ll)
10211 (equal f (expand-file-name (match-string 1 ll))))
10212 ll)))
10213 org-stored-links))
10214 (when (featurep 'org-id)
10215 (setq b (mapcar (lambda(l)
10216 (let ((ll (car l)))
10217 (when (and (string-match "^id:\\(.+\\)$" ll)
10218 (equal f (expand-file-name
10219 (or (org-id-find-id-file
10220 (match-string 1 ll)) ""))))
10221 ll)))
10222 org-stored-links)))
10223 (mapcar (lambda(l)
10224 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10225 (delq nil (append a b)))))
10227 (defvar org-link-links-in-this-file nil)
10228 (defun org-insert-link (&optional complete-file link-location default-description)
10229 "Insert a link. At the prompt, enter the link.
10231 Completion can be used to insert any of the link protocol prefixes like
10232 http or ftp in use.
10234 The history can be used to select a link previously stored with
10235 `org-store-link'. When the empty string is entered (i.e. if you just
10236 press RET at the prompt), the link defaults to the most recently
10237 stored link. As SPC triggers completion in the minibuffer, you need to
10238 use M-SPC or C-q SPC to force the insertion of a space character.
10240 You will also be prompted for a description, and if one is given, it will
10241 be displayed in the buffer instead of the link.
10243 If there is already a link at point, this command will allow you to edit link
10244 and description parts.
10246 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10247 be selected using completion. The path to the file will be relative to the
10248 current directory if the file is in the current directory or a subdirectory.
10249 Otherwise, the link will be the absolute path as completed in the minibuffer
10250 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10251 option `org-link-file-path-type'.
10253 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10254 the current directory or below.
10256 With three \\[universal-argument] prefixes, negate the meaning of
10257 `org-keep-stored-link-after-insertion'.
10259 If `org-make-link-description-function' is non-nil, this function will be
10260 called with the link target, and the result will be the default
10261 link description.
10263 If the LINK-LOCATION parameter is non-nil, this value will be
10264 used as the link location instead of reading one interactively.
10266 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10267 be used as the default description."
10268 (interactive "P")
10269 (let* ((wcf (current-window-configuration))
10270 (origbuf (current-buffer))
10271 (region (if (org-region-active-p)
10272 (buffer-substring (region-beginning) (region-end))))
10273 (remove (and region (list (region-beginning) (region-end))))
10274 (desc region)
10275 tmphist ; byte-compile incorrectly complains about this
10276 (link link-location)
10277 (abbrevs org-link-abbrev-alist-local)
10278 entry file all-prefixes auto-desc)
10279 (cond
10280 (link-location) ; specified by arg, just use it.
10281 ((org-in-regexp org-bracket-link-regexp 1)
10282 ;; We do have a link at point, and we are going to edit it.
10283 (setq remove (list (match-beginning 0) (match-end 0)))
10284 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10285 (setq link (read-string "Link: "
10286 (org-link-unescape
10287 (org-match-string-no-properties 1)))))
10288 ((or (org-in-regexp org-angle-link-re)
10289 (org-in-regexp org-plain-link-re))
10290 ;; Convert to bracket link
10291 (setq remove (list (match-beginning 0) (match-end 0))
10292 link (read-string "Link: "
10293 (org-remove-angle-brackets (match-string 0)))))
10294 ((member complete-file '((4) (16)))
10295 ;; Completing read for file names.
10296 (setq link (org-file-complete-link complete-file)))
10298 ;; Read link, with completion for stored links.
10299 (org-link-fontify-links-to-this-file)
10300 (org-switch-to-buffer-other-window "*Org Links*")
10301 (with-current-buffer "*Org Links*"
10302 (erase-buffer)
10303 (insert "Insert a link.
10304 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10305 (when org-stored-links
10306 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10307 (insert (mapconcat 'org-link-prettify
10308 (reverse org-stored-links) "\n")))
10309 (goto-char (point-min)))
10310 (let ((cw (selected-window)))
10311 (select-window (get-buffer-window "*Org Links*" 'visible))
10312 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10313 (unless (pos-visible-in-window-p (point-max))
10314 (org-fit-window-to-buffer))
10315 (and (window-live-p cw) (select-window cw)))
10316 ;; Fake a link history, containing the stored links.
10317 (setq tmphist (append (mapcar 'car org-stored-links)
10318 org-insert-link-history))
10319 (setq all-prefixes (append (mapcar 'car abbrevs)
10320 (mapcar 'car org-link-abbrev-alist)
10321 org-link-types))
10322 (unwind-protect
10323 (progn
10324 (setq link
10325 (org-completing-read
10326 "Link: "
10327 (append
10328 (mapcar (lambda (x) (concat x ":"))
10329 all-prefixes)
10330 (mapcar 'car org-stored-links))
10331 nil nil nil
10332 'tmphist
10333 (caar org-stored-links)))
10334 (if (not (string-match "\\S-" link))
10335 (user-error "No link selected"))
10336 (mapc (lambda(l)
10337 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10338 org-stored-links)
10339 (if (or (member link all-prefixes)
10340 (and (equal ":" (substring link -1))
10341 (member (substring link 0 -1) all-prefixes)
10342 (setq link (substring link 0 -1))))
10343 (setq link (with-current-buffer origbuf
10344 (org-link-try-special-completion link)))))
10345 (set-window-configuration wcf)
10346 (kill-buffer "*Org Links*"))
10347 (setq entry (assoc link org-stored-links))
10348 (or entry (push link org-insert-link-history))
10349 (setq desc (or desc (nth 1 entry)))))
10351 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10352 (not org-keep-stored-link-after-insertion))
10353 (setq org-stored-links (delq (assoc link org-stored-links)
10354 org-stored-links)))
10356 (if (and (string-match org-plain-link-re link)
10357 (not (string-match org-ts-regexp link)))
10358 ;; URL-like link, normalize the use of angular brackets.
10359 (setq link (org-remove-angle-brackets link)))
10361 ;; Check if we are linking to the current file with a search
10362 ;; option If yes, simplify the link by using only the search
10363 ;; option.
10364 (when (and buffer-file-name
10365 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10366 (let* ((path (match-string 1 link))
10367 (case-fold-search nil)
10368 (search (match-string 2 link)))
10369 (save-match-data
10370 (if (equal (file-truename buffer-file-name) (file-truename path))
10371 ;; We are linking to this same file, with a search option
10372 (setq link search)))))
10374 ;; Check if we can/should use a relative path. If yes, simplify the link
10375 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10376 (let* ((type (match-string 1 link))
10377 (path (match-string 2 link))
10378 (origpath path)
10379 (case-fold-search nil))
10380 (cond
10381 ((or (eq org-link-file-path-type 'absolute)
10382 (equal complete-file '(16)))
10383 (setq path (abbreviate-file-name (expand-file-name path))))
10384 ((eq org-link-file-path-type 'noabbrev)
10385 (setq path (expand-file-name path)))
10386 ((eq org-link-file-path-type 'relative)
10387 (setq path (file-relative-name path)))
10389 (save-match-data
10390 (if (string-match (concat "^" (regexp-quote
10391 (expand-file-name
10392 (file-name-as-directory
10393 default-directory))))
10394 (expand-file-name path))
10395 ;; We are linking a file with relative path name.
10396 (setq path (substring (expand-file-name path)
10397 (match-end 0)))
10398 (setq path (abbreviate-file-name (expand-file-name path)))))))
10399 (setq link (concat type path))
10400 (if (equal desc origpath)
10401 (setq desc path))))
10403 (if org-make-link-description-function
10404 (setq desc
10405 (or (condition-case nil
10406 (funcall org-make-link-description-function link desc)
10407 (error (progn (message "Can't get link description from `%s'"
10408 (symbol-name org-make-link-description-function))
10409 (sit-for 2) nil)))
10410 (read-string "Description: " default-description)))
10411 (if default-description (setq desc default-description)
10412 (setq desc (or (and auto-desc desc)
10413 (read-string "Description: " desc)))))
10415 (unless (string-match "\\S-" desc) (setq desc nil))
10416 (if remove (apply 'delete-region remove))
10417 (insert (org-make-link-string link desc))))
10419 (defun org-link-try-special-completion (type)
10420 "If there is completion support for link type TYPE, offer it."
10421 (let ((fun (intern (concat "org-" type "-complete-link"))))
10422 (if (functionp fun)
10423 (funcall fun)
10424 (read-string "Link (no completion support): " (concat type ":")))))
10426 (defun org-file-complete-link (&optional arg)
10427 "Create a file link using completion."
10428 (let ((file (org-iread-file-name "File: "))
10429 (pwd (file-name-as-directory (expand-file-name ".")))
10430 (pwd1 (file-name-as-directory (abbreviate-file-name
10431 (expand-file-name ".")))))
10432 (cond ((equal arg '(16))
10433 (concat "file:"
10434 (abbreviate-file-name (expand-file-name file))))
10435 ((string-match
10436 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10437 (concat "file:" (match-string 1 file)))
10438 ((string-match
10439 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10440 (expand-file-name file))
10441 (concat "file:"
10442 (match-string 1 (expand-file-name file))))
10443 (t (concat "file:" file)))))
10445 (defun org-iread-file-name (&rest args)
10446 "Read-file-name using `ido-mode' speedup if available.
10447 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10448 See `read-file-name' for a description of parameters."
10449 (org-without-partial-completion
10450 (if (and org-completion-use-ido
10451 (fboundp 'ido-read-file-name)
10452 (org-bound-and-true-p ido-mode)
10453 (listp (nth 1 args)))
10454 (let ((ido-enter-matching-directory nil))
10455 (apply #'ido-read-file-name args))
10456 (apply #'read-file-name args))))
10458 (defun org-completing-read (&rest args)
10459 "Completing-read with SPACE being a normal character."
10460 (let ((enable-recursive-minibuffers t)
10461 (minibuffer-local-completion-map
10462 (copy-keymap minibuffer-local-completion-map)))
10463 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10464 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10465 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10466 (apply 'org-icompleting-read args)))
10468 (defun org-completing-read-no-i (&rest args)
10469 (let (org-completion-use-ido org-completion-use-iswitchb)
10470 (apply 'org-completing-read args)))
10472 (defun org-iswitchb-completing-read (prompt choices &rest args)
10473 "Use iswitch as a completing-read replacement to choose from choices.
10474 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10475 from."
10476 (let* ((iswitchb-use-virtual-buffers nil)
10477 (iswitchb-make-buflist-hook
10478 (lambda ()
10479 (setq iswitchb-temp-buflist choices))))
10480 (iswitchb-read-buffer prompt)))
10482 (defun org-icompleting-read (&rest args)
10483 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10484 Should be called like `completing-read'."
10485 (org-without-partial-completion
10486 (if (not (listp (nth 1 args)))
10487 ;; Ido only supports lists as the COLLECTION argument. Use
10488 ;; default completion function when second argument is not
10489 ;; a list.
10490 (apply #'completing-read args)
10491 (let ((ido-enter-matching-directory nil))
10492 (apply (cond ((and org-completion-use-ido
10493 (fboundp 'ido-completing-read)
10494 (org-bound-and-true-p ido-mode))
10495 #'ido-completing-read)
10496 ((and org-completion-use-iswitchb
10497 (org-bound-and-true-p iswitchb-mode))
10498 #'org-iswitchb-completing-read)
10499 (t #'completing-read))
10500 args)))))
10502 ;;; Opening/following a link
10504 (defvar org-link-search-failed nil)
10506 (defvar org-open-link-functions nil
10507 "Hook for functions finding a plain text link.
10508 These functions must take a single argument, the link content.
10509 They will be called for links that look like [[link text][description]]
10510 when LINK TEXT does not have a protocol like \"http:\" and does not look
10511 like a filename (e.g. \"./blue.png\").
10513 These functions will be called *before* Org attempts to resolve the
10514 link by doing text searches in the current buffer - so if you want a
10515 link \"[[target]]\" to still find \"<<target>>\", your function should
10516 handle this as a special case.
10518 When the function does handle the link, it must return a non-nil value.
10519 If it decides that it is not responsible for this link, it must return
10520 nil to indicate that that Org-mode can continue with other options
10521 like exact and fuzzy text search.")
10523 (defun org-next-link (&optional search-backward)
10524 "Move forward to the next link.
10525 If the link is in hidden text, expose it."
10526 (interactive "P")
10527 (when (and org-link-search-failed (eq this-command last-command))
10528 (goto-char (point-min))
10529 (message "Link search wrapped back to beginning of buffer"))
10530 (setq org-link-search-failed nil)
10531 (let* ((pos (point))
10532 (ct (org-context))
10533 (a (assoc :link ct))
10534 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10535 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10536 ((looking-at org-any-link-re)
10537 ;; Don't stay stuck at link without an org-link face
10538 (forward-char (if search-backward -1 1))))
10539 (if (funcall srch-fun org-any-link-re nil t)
10540 (progn
10541 (goto-char (match-beginning 0))
10542 (if (outline-invisible-p) (org-show-context)))
10543 (goto-char pos)
10544 (setq org-link-search-failed t)
10545 (message "No further link found"))))
10547 (defun org-previous-link ()
10548 "Move backward to the previous link.
10549 If the link is in hidden text, expose it."
10550 (interactive)
10551 (funcall 'org-next-link t))
10553 (defun org-translate-link (s)
10554 "Translate a link string if a translation function has been defined."
10555 (if (and org-link-translation-function
10556 (fboundp org-link-translation-function)
10557 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10558 (progn
10559 (setq s (funcall org-link-translation-function
10560 (match-string 1 s) (match-string 2 s)))
10561 (concat (car s) ":" (cdr s)))
10564 (defun org-translate-link-from-planner (type path)
10565 "Translate a link from Emacs Planner syntax so that Org can follow it.
10566 This is still an experimental function, your mileage may vary."
10567 (cond
10568 ((member type '("http" "https" "news" "ftp"))
10569 ;; standard Internet links are the same.
10570 nil)
10571 ((and (equal type "irc") (string-match "^//" path))
10572 ;; Planner has two / at the beginning of an irc link, we have 1.
10573 ;; We should have zero, actually....
10574 (setq path (substring path 1)))
10575 ((and (equal type "lisp") (string-match "^/" path))
10576 ;; Planner has a slash, we do not.
10577 (setq type "elisp" path (substring path 1)))
10578 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10579 ;; A typical message link. Planner has the id after the final slash,
10580 ;; we separate it with a hash mark
10581 (setq path (concat (match-string 1 path) "#"
10582 (org-remove-angle-brackets (match-string 2 path))))))
10583 (cons type path))
10585 (defun org-find-file-at-mouse (ev)
10586 "Open file link or URL at mouse."
10587 (interactive "e")
10588 (mouse-set-point ev)
10589 (org-open-at-point 'in-emacs))
10591 (defun org-open-at-mouse (ev)
10592 "Open file link or URL at mouse.
10593 See the docstring of `org-open-file' for details."
10594 (interactive "e")
10595 (mouse-set-point ev)
10596 (if (eq major-mode 'org-agenda-mode)
10597 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10598 (org-open-at-point))
10600 (defvar org-window-config-before-follow-link nil
10601 "The window configuration before following a link.
10602 This is saved in case the need arises to restore it.")
10604 ;;;###autoload
10605 (defun org-open-at-point-global ()
10606 "Follow a link like Org-mode does.
10607 This command can be called in any mode to follow a link that has
10608 Org-mode syntax."
10609 (interactive)
10610 (org-run-like-in-org-mode 'org-open-at-point))
10612 ;;;###autoload
10613 (defun org-open-link-from-string (s &optional arg reference-buffer)
10614 "Open a link in the string S, as if it was in Org-mode."
10615 (interactive "sLink: \nP")
10616 (let ((reference-buffer (or reference-buffer (current-buffer))))
10617 (with-temp-buffer
10618 (let ((org-inhibit-startup (not reference-buffer)))
10619 (org-mode)
10620 (insert s)
10621 (goto-char (point-min))
10622 (when reference-buffer
10623 (setq org-link-abbrev-alist-local
10624 (with-current-buffer reference-buffer
10625 org-link-abbrev-alist-local)))
10626 (org-open-at-point arg reference-buffer)))))
10628 (defvar org-open-at-point-functions nil
10629 "Hook that is run when following a link at point.
10631 Functions in this hook must return t if they identify and follow
10632 a link at point. If they don't find anything interesting at point,
10633 they must return nil.")
10635 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10636 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10637 (defun org-open-at-point (&optional arg reference-buffer)
10638 "Open link, timestamp, footnote or tags at point.
10640 When point is on a link, follow it. Normally, files will be
10641 opened by an appropriate application. If the optional prefix
10642 argument ARG is non-nil, Emacs will visit the file. With
10643 a double prefix argument, try to open outside of Emacs, in the
10644 application the system uses for this file type.
10646 When point is on a timestamp, open the agenda at the day
10647 specified.
10649 When point is a footnote definition, move to the first reference
10650 found. If it is on a reference, move to the associated
10651 definition.
10653 When point is on a headline, display a list of every link in the
10654 entry, so it is possible to pick one, or all, of them. If point
10655 is on a tag, call `org-tags-view' instead.
10657 When optional argument REFERENCE-BUFFER is non-nil, it should
10658 specify a buffer from where the link search should happen. This
10659 is used internally by `org-open-link-from-string'.
10661 On top of syntactically correct links, this function will open
10662 the link at point in comments or comment blocks and the first
10663 link in a property drawer line."
10664 (interactive "P")
10665 ;; On a code block, open block's results.
10666 (unless (call-interactively 'org-babel-open-src-block-result)
10667 (org-load-modules-maybe)
10668 (setq org-window-config-before-follow-link (current-window-configuration))
10669 (org-remove-occur-highlights nil nil t)
10670 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10671 (let* ((context
10672 ;; Only consider supported types, even if they are not
10673 ;; the closest one.
10674 (org-element-lineage
10675 (org-element-context)
10676 '(comment comment-block footnote-definition footnote-reference
10677 headline inlinetask keyword link node-property
10678 timestamp)
10680 (type (org-element-type context))
10681 (value (org-element-property :value context)))
10682 (cond
10683 ((not context) (user-error "No link found"))
10684 ;; Exception: open timestamps and links in properties
10685 ;; drawers, keywords and comments.
10686 ((memq type '(comment comment-block keyword node-property))
10687 (cond ((org-in-regexp org-any-link-re)
10688 (org-open-link-from-string (match-string-no-properties 0)))
10689 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10690 (org-follow-timestamp-link))
10691 (t (user-error "No link found"))))
10692 ;; On a headline or an inlinetask, but not on a timestamp,
10693 ;; a link, a footnote reference or on tags.
10694 ((and (memq type '(headline inlinetask))
10695 ;; Not on tags.
10696 (progn (save-excursion (beginning-of-line)
10697 (looking-at org-complex-heading-regexp))
10698 (or (not (match-beginning 5))
10699 (< (point) (match-beginning 5)))))
10700 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10701 (links (car data))
10702 (links-end (cdr data)))
10703 (if links
10704 (dolist (link (if (stringp links) (list links) links))
10705 (search-forward link nil links-end)
10706 (goto-char (match-beginning 0))
10707 (org-open-at-point))
10708 (require 'org-attach)
10709 (org-attach-reveal 'if-exists))))
10710 ;; Do nothing on white spaces after an object, unless point
10711 ;; is right after it.
10712 ((> (point)
10713 (save-excursion
10714 (goto-char (org-element-property :end context))
10715 (skip-chars-backward " \t")
10716 (point)))
10717 (user-error "No link found"))
10718 ((eq type 'timestamp) (org-follow-timestamp-link))
10719 ;; On tags within a headline or an inlinetask.
10720 ((and (memq type '(headline inlinetask))
10721 (progn (save-excursion (beginning-of-line)
10722 (looking-at org-complex-heading-regexp))
10723 (and (match-beginning 5)
10724 (>= (point) (match-beginning 5)))))
10725 (org-tags-view arg (substring (match-string 5) 0 -1)))
10726 ((eq type 'link)
10727 ;; When link is located within the description of another
10728 ;; link (e.g., an inline image), always open the parent
10729 ;; link.
10730 (let*((link (let ((up (org-element-property :parent context)))
10731 (if (eq (org-element-type up) 'link) up context)))
10732 (type (org-element-property :type link))
10733 (path (org-link-unescape (org-element-property :path link))))
10734 ;; Switch back to REFERENCE-BUFFER needed when called in
10735 ;; a temporary buffer through `org-open-link-from-string'.
10736 (with-current-buffer (or reference-buffer (current-buffer))
10737 (cond
10738 ((equal type "file")
10739 (if (string-match "[*?{]" (file-name-nondirectory path))
10740 (dired path)
10741 ;; Look into `org-link-protocols' in order to find
10742 ;; a DEDICATED-FUNCTION to open file. The function
10743 ;; will be applied on raw link instead of parsed
10744 ;; link due to the limitation in `org-add-link-type'
10745 ;; ("open" function called with a single argument).
10746 ;; If no such function is found, fallback to
10747 ;; `org-open-file'.
10749 ;; Note : "file+emacs" and "file+sys" types are
10750 ;; hard-coded in order to escape the previous
10751 ;; limitation.
10752 (let* ((option (org-element-property :search-option link))
10753 (app (org-element-property :application link))
10754 (dedicated-function
10755 (nth 1 (assoc app org-link-protocols))))
10756 (if dedicated-function
10757 (funcall dedicated-function
10758 (concat path
10759 (and option (concat "::" option))))
10760 (apply #'org-open-file
10761 path
10762 (cond (arg)
10763 ((equal app "emacs") 'emacs)
10764 ((equal app "sys") 'system))
10765 (cond ((not option) nil)
10766 ((org-string-match-p "\\`[0-9]+\\'" option)
10767 (list (string-to-number option)))
10768 (t (list nil
10769 (org-link-unescape option)))))))))
10770 ((assoc type org-link-protocols)
10771 (funcall (nth 1 (assoc type org-link-protocols)) path))
10772 ((equal type "help")
10773 (let ((f-or-v (intern path)))
10774 (cond ((fboundp f-or-v) (describe-function f-or-v))
10775 ((boundp f-or-v) (describe-variable f-or-v))
10776 (t (error "Not a known function or variable")))))
10777 ((member type '("http" "https" "ftp" "mailto" "news"))
10778 (browse-url (org-link-escape-browser (concat type ":" path))))
10779 ((equal type "doi")
10780 (browse-url
10781 (org-link-escape-browser (concat org-doi-server-url path))))
10782 ((equal type "message") (browse-url (concat type ":" path)))
10783 ((equal type "shell")
10784 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10785 (cmd path))
10786 (if (or (and (org-string-nw-p
10787 org-confirm-shell-link-not-regexp)
10788 (string-match
10789 org-confirm-shell-link-not-regexp cmd))
10790 (not org-confirm-shell-link-function)
10791 (funcall org-confirm-shell-link-function
10792 (format "Execute \"%s\" in shell? "
10793 (org-add-props cmd nil
10794 'face 'org-warning))))
10795 (progn
10796 (message "Executing %s" cmd)
10797 (shell-command cmd buf)
10798 (when (featurep 'midnight)
10799 (setq clean-buffer-list-kill-buffer-names
10800 (cons (buffer-name buf)
10801 clean-buffer-list-kill-buffer-names))))
10802 (user-error "Abort"))))
10803 ((equal type "elisp")
10804 (let ((cmd path))
10805 (if (or (and (org-string-nw-p
10806 org-confirm-elisp-link-not-regexp)
10807 (org-string-match-p
10808 org-confirm-elisp-link-not-regexp cmd))
10809 (not org-confirm-elisp-link-function)
10810 (funcall org-confirm-elisp-link-function
10811 (format "Execute \"%s\" as elisp? "
10812 (org-add-props cmd nil
10813 'face 'org-warning))))
10814 (message "%s => %s" cmd
10815 (if (eq (string-to-char cmd) ?\()
10816 (eval (read cmd))
10817 (call-interactively (read cmd))))
10818 (user-error "Abort"))))
10819 ((equal type "id")
10820 (require 'ord-id)
10821 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10822 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10823 (unless (run-hook-with-args-until-success
10824 'org-open-link-functions path)
10825 (if (not arg) (org-mark-ring-push)
10826 (switch-to-buffer-other-window
10827 (org-get-buffer-for-internal-link (current-buffer))))
10828 (let ((destination
10829 (org-with-wide-buffer
10830 (if (equal type "radio")
10831 (org-search-radio-target
10832 (org-element-property :path link))
10833 (org-link-search
10834 (if (member type '("custom-id" "coderef"))
10835 (org-element-property :raw-link link)
10836 path)
10837 ;; Prevent fuzzy links from matching
10838 ;; themselves.
10839 (and (equal type "fuzzy")
10840 (+ 2 (org-element-property :begin link)))))
10841 (point))))
10842 (unless (and (<= (point-min) destination)
10843 (>= (point-max) destination))
10844 (widen))
10845 (goto-char destination))))
10846 (t (browse-url-at-point))))))
10847 ;; On a footnote reference or at a footnote definition's label.
10848 ((or (eq type 'footnote-reference)
10849 (and (eq type 'footnote-definition)
10850 (save-excursion
10851 ;; Do not validate action when point is on the
10852 ;; spaces right after the footnote label, in
10853 ;; order to be on par with behaviour on links.
10854 (skip-chars-forward " \t")
10855 (let ((begin
10856 (org-element-property :contents-begin context)))
10857 (if begin (< (point) begin)
10858 (= (org-element-property :post-affiliated context)
10859 (line-beginning-position)))))))
10860 (org-footnote-action))
10861 (t (user-error "No link found")))))
10862 (run-hook-with-args 'org-follow-link-hook)))
10864 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10865 "Offer links in the current entry and return the selected link.
10866 If there is only one link, return it.
10867 If NTH is an integer, return the NTH link found.
10868 If ZERO is a string, check also this string for a link, and if
10869 there is one, return it."
10870 (with-current-buffer buffer
10871 (save-excursion
10872 (save-restriction
10873 (widen)
10874 (goto-char marker)
10875 (let ((cnt ?0)
10876 (in-emacs (if (integerp nth) nil nth))
10877 have-zero end links link c)
10878 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10879 (push (match-string 0 zero) links)
10880 (setq cnt (1- cnt) have-zero t))
10881 (save-excursion
10882 (org-back-to-heading t)
10883 (setq end (save-excursion (outline-next-heading) (point)))
10884 (while (re-search-forward org-any-link-re end t)
10885 (push (match-string 0) links))
10886 (setq links (org-uniquify (reverse links))))
10887 (cond
10888 ((null links)
10889 (message "No links"))
10890 ((equal (length links) 1)
10891 (setq link (car links)))
10892 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10893 (setq link (nth (if have-zero nth (1- nth)) links)))
10894 (t ; we have to select a link
10895 (save-excursion
10896 (save-window-excursion
10897 (delete-other-windows)
10898 (with-output-to-temp-buffer "*Select Link*"
10899 (mapc (lambda (l)
10900 (if (not (string-match org-bracket-link-regexp l))
10901 (princ (format "[%c] %s\n" (incf cnt)
10902 (org-remove-angle-brackets l)))
10903 (if (match-end 3)
10904 (princ (format "[%c] %s (%s)\n" (incf cnt)
10905 (match-string 3 l) (match-string 1 l)))
10906 (princ (format "[%c] %s\n" (incf cnt)
10907 (match-string 1 l))))))
10908 links))
10909 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10910 (message "Select link to open, RET to open all:")
10911 (setq c (read-char-exclusive))
10912 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10913 (when (equal c ?q) (user-error "Abort"))
10914 (if (equal c ?\C-m)
10915 (setq link links)
10916 (setq nth (- c ?0))
10917 (if have-zero (setq nth (1+ nth)))
10918 (unless (and (integerp nth) (>= (length links) nth))
10919 (user-error "Invalid link selection"))
10920 (setq link (nth (1- nth) links)))))
10921 (cons link end))))))
10923 ;; TODO: These functions are deprecated since `org-open-at-point'
10924 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10925 (defun org-open-file-with-system (path)
10926 "Open file at PATH using the system way of opening it."
10927 (org-open-file path 'system))
10928 (defun org-open-file-with-emacs (path)
10929 "Open file at PATH in Emacs."
10930 (org-open-file path 'emacs))
10933 ;;; File search
10935 (defvar org-create-file-search-functions nil
10936 "List of functions to construct the right search string for a file link.
10937 These functions are called in turn with point at the location to
10938 which the link should point.
10940 A function in the hook should first test if it would like to
10941 handle this file type, for example by checking the `major-mode'
10942 or the file extension. If it decides not to handle this file, it
10943 should just return nil to give other functions a chance. If it
10944 does handle the file, it must return the search string to be used
10945 when following the link. The search string will be part of the
10946 file link, given after a double colon, and `org-open-at-point'
10947 will automatically search for it. If special measures must be
10948 taken to make the search successful, another function should be
10949 added to the companion hook `org-execute-file-search-functions',
10950 which see.
10952 A function in this hook may also use `setq' to set the variable
10953 `description' to provide a suggestion for the descriptive text to
10954 be used for this link when it gets inserted into an Org-mode
10955 buffer with \\[org-insert-link].")
10957 (defvar org-execute-file-search-functions nil
10958 "List of functions to execute a file search triggered by a link.
10960 Functions added to this hook must accept a single argument, the
10961 search string that was part of the file link, the part after the
10962 double colon. The function must first check if it would like to
10963 handle this search, for example by checking the `major-mode' or
10964 the file extension. If it decides not to handle this search, it
10965 should just return nil to give other functions a chance. If it
10966 does handle the search, it must return a non-nil value to keep
10967 other functions from trying.
10969 Each function can access the current prefix argument through the
10970 variable `current-prefix-arg'. Note that a single prefix is used
10971 to force opening a link in Emacs, so it may be good to only use a
10972 numeric or double prefix to guide the search function.
10974 In case this is needed, a function in this hook can also restore
10975 the window configuration before `org-open-at-point' was called using:
10977 (set-window-configuration org-window-config-before-follow-link)")
10979 (defun org-search-radio-target (target)
10980 "Search a radio target matching TARGET in current buffer.
10981 White spaces are not significant."
10982 (let ((re (format "<<<%s>>>"
10983 (mapconcat #'regexp-quote
10984 (org-split-string target "[ \t\n]+")
10985 "[ \t]+\\(?:\n[ \t]*\\)?")))
10986 (origin (point)))
10987 (goto-char (point-min))
10988 (catch :radio-match
10989 (while (re-search-forward re nil t)
10990 (backward-char)
10991 (let ((object (org-element-context)))
10992 (when (eq (org-element-type object) 'radio-target)
10993 (goto-char (org-element-property :begin object))
10994 (org-show-context 'link-search)
10995 (throw :radio-match nil))))
10996 (goto-char origin)
10997 (user-error "No match for radio target: %s" target))))
10999 (defun org-link-search (s &optional avoid-pos stealth)
11000 "Search for a search string S.
11002 If S starts with \"#\", it triggers a custom ID search.
11004 If S is enclosed within parenthesis, it initiates a coderef
11005 search.
11007 If S is surrounded by forward slashes, it is interpreted as
11008 a regular expression. In Org mode files, this will create an
11009 `org-occur' sparse tree. In ordinary files, `occur' will be used
11010 to list matches. If the current buffer is in `dired-mode', grep
11011 will be used to search in all files.
11013 When AVOID-POS is given, ignore matches near that position.
11015 When optional argument STEALTH is non-nil, do not modify
11016 visibility around point, thus ignoring `org-show-context-detail'
11017 variable.
11019 Search is case-insensitive and ignores white spaces. Return type
11020 of matched result, with is either `dedicated' or `fuzzy'."
11021 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11022 (let* ((case-fold-search t)
11023 (origin (point))
11024 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11025 (words (org-split-string s "[ \t\n]+"))
11026 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11027 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11028 type)
11029 (cond
11030 ;; Check if there are any special search functions.
11031 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11032 ((eq (string-to-char s) ?#)
11033 ;; Look for a custom ID S if S starts with "#".
11034 (let* ((id (substring normalized 1))
11035 (match (org-find-property "CUSTOM_ID" id)))
11036 (if match (progn (goto-char match) (setf type 'dedicated))
11037 (error "No match for custom ID: %s" id))))
11038 ((string-match "\\`(\\(.*\\))\\'" normalized)
11039 ;; Look for coderef targets if S is enclosed within parenthesis.
11040 (let ((coderef (match-string-no-properties 1 normalized))
11041 (re (substring s-single-re 1 -1)))
11042 (goto-char (point-min))
11043 (catch :coderef-match
11044 (while (re-search-forward re nil t)
11045 (let ((element (org-element-at-point)))
11046 (when (and (memq (org-element-type element)
11047 '(example-block src-block))
11048 ;; Build proper regexp according to current
11049 ;; block's label format.
11050 (let ((label-fmt
11051 (regexp-quote
11052 (or (org-element-property :label-fmt element)
11053 org-coderef-label-format))))
11054 (save-excursion
11055 (beginning-of-line)
11056 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11057 (format label-fmt coderef))))))
11058 (setq type 'dedicated)
11059 (goto-char (match-beginning 1))
11060 (throw :coderef-match nil))))
11061 (goto-char origin)
11062 (error "No match for coderef: %s" coderef))))
11063 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11064 ;; Look for a regular expression.
11065 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11066 (match-string 1 s)))
11067 ;; Fuzzy links.
11069 (let* ((starred (eq (string-to-char normalized) ?*))
11070 (headline-search (and (derived-mode-p 'org-mode)
11071 (or org-link-search-must-match-exact-headline
11072 starred))))
11073 (cond
11074 ;; Look for targets, only if not in a headline search.
11075 ((and (not starred)
11076 (let ((target (format "<<%s>>" s-multi-re)))
11077 (catch :target-match
11078 (goto-char (point-min))
11079 (while (re-search-forward target nil t)
11080 (backward-char)
11081 (let ((context (org-element-context)))
11082 (when (eq (org-element-type context) 'target)
11083 (setq type 'dedicated)
11084 (goto-char (org-element-property :begin context))
11085 (throw :target-match t))))
11086 nil))))
11087 ;; Look for elements named after S, only if not in a headline
11088 ;; search.
11089 ((and (not starred)
11090 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11091 (catch :name-match
11092 (goto-char (point-min))
11093 (while (re-search-forward name nil t)
11094 (let ((element (org-element-at-point)))
11095 (when (equal (org-split-string
11096 (org-element-property :name element)
11097 "[ \t]+")
11098 words)
11099 (setq type 'dedicated)
11100 (beginning-of-line)
11101 (throw :name-match t))))
11102 nil))))
11103 ;; Regular text search. Prefer headlines in Org mode
11104 ;; buffers.
11105 ((and (derived-mode-p 'org-mode)
11106 (let* ((wspace "[ \t]")
11107 (wspaceopt (concat wspace "*"))
11108 (cookie (concat "\\(?:"
11109 wspaceopt
11110 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11111 wspaceopt
11112 "\\)"))
11113 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)"))
11114 (re (concat
11115 org-outline-regexp-bol
11116 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11117 "\\(?:\\[#.\\][ \t]+\\)?"
11118 "\\(?:" org-comment-string "[ \t]+\\)?"
11119 sep "*"
11120 (let ((title (mapconcat #'regexp-quote
11121 words
11122 (concat sep "+"))))
11123 (if starred (substring title 1) title))
11124 sep "*"
11125 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11126 "[ \t]*$")))
11127 (goto-char (point-min))
11128 (re-search-forward re nil t)))
11129 (goto-char (match-beginning 0))
11130 (setq type 'dedicated))
11131 ;; Offer to create non-existent headline depending on
11132 ;; `org-link-search-must-match-exact-headline'.
11133 ((and (derived-mode-p 'org-mode)
11134 (not org-link-search-inhibit-query)
11135 (eq org-link-search-must-match-exact-headline 'query-to-create)
11136 (yes-or-no-p "No match - create this as a new heading? "))
11137 (goto-char (point-max))
11138 (unless (bolp) (newline))
11139 (org-insert-heading nil t t)
11140 (insert s "\n")
11141 (beginning-of-line 0))
11142 ;; Only headlines are looked after. No need to process
11143 ;; further: throw an error.
11144 ((and (derived-mode-p 'org-mode)
11145 (or starred org-link-search-must-match-exact-headline))
11146 (goto-char origin)
11147 (error "No match for fuzzy expression: %s" normalized))
11148 ;; Regular text search.
11149 ((catch :fuzzy-match
11150 (goto-char (point-min))
11151 (while (re-search-forward s-multi-re nil t)
11152 ;; Skip match if it contains AVOID-POS or it is included
11153 ;; in a link with a description but outside the
11154 ;; description.
11155 (unless (or (and avoid-pos
11156 (<= (match-beginning 0) avoid-pos)
11157 (> (match-end 0) avoid-pos))
11158 (and (save-match-data
11159 (org-in-regexp org-bracket-link-regexp))
11160 (match-beginning 3)
11161 (or (> (match-beginning 3) (point))
11162 (<= (match-end 3) (point)))
11163 (org-element-lineage
11164 (save-match-data (org-element-context))
11165 '(link) t)))
11166 (goto-char (match-beginning 0))
11167 (setq type 'fuzzy)
11168 (throw :fuzzy-match t)))
11169 nil))
11170 ;; All failed. Throw an error.
11171 (t (goto-char origin)
11172 (error "No match for fuzzy expression: %s" normalized))))))
11173 ;; Disclose surroundings of match, if appropriate.
11174 (when (and (derived-mode-p 'org-mode) (not stealth))
11175 (org-show-context 'link-search))
11176 type))
11178 (defun org-get-buffer-for-internal-link (buffer)
11179 "Return a buffer to be used for displaying the link target of internal links."
11180 (cond
11181 ((not org-display-internal-link-with-indirect-buffer)
11182 buffer)
11183 ((string-match "(Clone)$" (buffer-name buffer))
11184 (message "Buffer is already a clone, not making another one")
11185 ;; we also do not modify visibility in this case
11186 buffer)
11187 (t ; make a new indirect buffer for displaying the link
11188 (let* ((bn (buffer-name buffer))
11189 (ibn (concat bn "(Clone)"))
11190 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11191 (with-current-buffer ib (org-overview))
11192 ib))))
11194 (defun org-do-occur (regexp &optional cleanup)
11195 "Call the Emacs command `occur'.
11196 If CLEANUP is non-nil, remove the printout of the regular expression
11197 in the *Occur* buffer. This is useful if the regex is long and not useful
11198 to read."
11199 (occur regexp)
11200 (when cleanup
11201 (let ((cwin (selected-window)) win beg end)
11202 (when (setq win (get-buffer-window "*Occur*"))
11203 (select-window win))
11204 (goto-char (point-min))
11205 (when (re-search-forward "match[a-z]+" nil t)
11206 (setq beg (match-end 0))
11207 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11208 (setq end (1- (match-beginning 0)))))
11209 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11210 (goto-char (point-min))
11211 (select-window cwin))))
11213 ;;; The mark ring for links jumps
11215 (defvar org-mark-ring nil
11216 "Mark ring for positions before jumps in Org-mode.")
11217 (defvar org-mark-ring-last-goto nil
11218 "Last position in the mark ring used to go back.")
11219 ;; Fill and close the ring
11220 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11221 (loop for i from 1 to org-mark-ring-length do
11222 (push (make-marker) org-mark-ring))
11223 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11224 org-mark-ring)
11226 (defun org-mark-ring-push (&optional pos buffer)
11227 "Put the current position or POS into the mark ring and rotate it."
11228 (interactive)
11229 (setq pos (or pos (point)))
11230 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11231 (move-marker (car org-mark-ring)
11232 (or pos (point))
11233 (or buffer (current-buffer)))
11234 (message "%s"
11235 (substitute-command-keys
11236 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11238 (defun org-mark-ring-goto (&optional n)
11239 "Jump to the previous position in the mark ring.
11240 With prefix arg N, jump back that many stored positions. When
11241 called several times in succession, walk through the entire ring.
11242 Org-mode commands jumping to a different position in the current file,
11243 or to another Org-mode file, automatically push the old position
11244 onto the ring."
11245 (interactive "p")
11246 (let (p m)
11247 (if (eq last-command this-command)
11248 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11249 (setq p org-mark-ring))
11250 (setq org-mark-ring-last-goto p)
11251 (setq m (car p))
11252 (org-pop-to-buffer-same-window (marker-buffer m))
11253 (goto-char m)
11254 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11256 (defun org-remove-angle-brackets (s)
11257 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11258 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11260 (defun org-add-angle-brackets (s)
11261 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11262 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11264 (defun org-remove-double-quotes (s)
11265 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11266 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11269 ;;; Following specific links
11271 (defun org-follow-timestamp-link ()
11272 "Open an agenda view for the time-stamp date/range at point."
11273 (cond
11274 ((org-at-date-range-p t)
11275 (let ((org-agenda-start-on-weekday)
11276 (t1 (match-string 1))
11277 (t2 (match-string 2)) tt1 tt2)
11278 (setq tt1 (time-to-days (org-time-string-to-time t1))
11279 tt2 (time-to-days (org-time-string-to-time t2)))
11280 (let ((org-agenda-buffer-tmp-name
11281 (format "*Org Agenda(a:%s)"
11282 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11283 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11284 ((org-at-timestamp-p t)
11285 (let ((org-agenda-buffer-tmp-name
11286 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11287 (org-agenda-list nil (time-to-days (org-time-string-to-time
11288 (substring (match-string 1) 0 10)))
11289 1)))
11290 (t (error "This should not happen"))))
11293 ;;; Following file links
11294 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11295 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11296 (declare-function mailcap-mime-info
11297 "mailcap" (string &optional request no-decode))
11298 (defvar org-wait nil)
11299 (defun org-open-file (path &optional in-emacs line search)
11300 "Open the file at PATH.
11301 First, this expands any special file name abbreviations. Then the
11302 configuration variable `org-file-apps' is checked if it contains an
11303 entry for this file type, and if yes, the corresponding command is launched.
11305 If no application is found, Emacs simply visits the file.
11307 With optional prefix argument IN-EMACS, Emacs will visit the file.
11308 With a double \\[universal-argument] \\[universal-argument] \
11309 prefix arg, Org tries to avoid opening in Emacs
11310 and to use an external application to visit the file.
11312 Optional LINE specifies a line to go to, optional SEARCH a string
11313 to search for. If LINE or SEARCH is given, the file will be
11314 opened in Emacs, unless an entry from org-file-apps that makes
11315 use of groups in a regexp matches.
11317 If you want to change the way frames are used when following a
11318 link, please customize `org-link-frame-setup'.
11320 If the file does not exist, an error is thrown."
11321 (let* ((file (if (equal path "")
11322 buffer-file-name
11323 (substitute-in-file-name (expand-file-name path))))
11324 (file-apps (append org-file-apps (org-default-apps)))
11325 (apps (org-remove-if
11326 'org-file-apps-entry-match-against-dlink-p file-apps))
11327 (apps-dlink (org-remove-if-not
11328 'org-file-apps-entry-match-against-dlink-p file-apps))
11329 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11330 (dirp (if remp nil (file-directory-p file)))
11331 (file (if (and dirp org-open-directory-means-index-dot-org)
11332 (concat (file-name-as-directory file) "index.org")
11333 file))
11334 (a-m-a-p (assq 'auto-mode apps))
11335 (dfile (downcase file))
11336 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11337 (link (cond ((and (eq line nil)
11338 (eq search nil))
11339 file)
11340 (line
11341 (concat file "::" (number-to-string line)))
11342 (search
11343 (concat file "::" search))))
11344 (dlink (downcase link))
11345 (old-buffer (current-buffer))
11346 (old-pos (point))
11347 (old-mode major-mode)
11348 ext cmd link-match-data)
11349 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11350 (setq ext (match-string 1 dfile))
11351 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11352 (setq ext (match-string 1 dfile))))
11353 (cond
11354 ((member in-emacs '((16) system))
11355 (setq cmd (cdr (assoc 'system apps))))
11356 (in-emacs (setq cmd 'emacs))
11358 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11359 (and dirp (cdr (assoc 'directory apps)))
11360 ; first, try matching against apps-dlink
11361 ; if we get a match here, store the match data for later
11362 (let ((match (assoc-default dlink apps-dlink
11363 'string-match)))
11364 (if match
11365 (progn (setq link-match-data (match-data))
11366 match)
11367 (progn (setq in-emacs (or in-emacs line search))
11368 nil))) ; if we have no match in apps-dlink,
11369 ; always open the file in emacs if line or search
11370 ; is given (for backwards compatibility)
11371 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11372 'string-match)
11373 (cdr (assoc ext apps))
11374 (cdr (assoc t apps))))))
11375 (when (eq cmd 'system)
11376 (setq cmd (cdr (assoc 'system apps))))
11377 (when (eq cmd 'default)
11378 (setq cmd (cdr (assoc t apps))))
11379 (when (eq cmd 'mailcap)
11380 (require 'mailcap)
11381 (mailcap-parse-mailcaps)
11382 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11383 (command (mailcap-mime-info mime-type)))
11384 (if (stringp command)
11385 (setq cmd command)
11386 (setq cmd 'emacs))))
11387 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11388 (not (file-exists-p file))
11389 (not org-open-non-existing-files))
11390 (user-error "No such file: %s" file))
11391 (cond
11392 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11393 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11394 (while (string-match "['\"]%s['\"]" cmd)
11395 (setq cmd (replace-match "%s" t t cmd)))
11396 (while (string-match "%s" cmd)
11397 (setq cmd (replace-match
11398 (save-match-data
11399 (shell-quote-argument
11400 (convert-standard-filename file)))
11401 t t cmd)))
11403 ;; Replace "%1", "%2" etc. in command with group matches from regex
11404 (save-match-data
11405 (let ((match-index 1)
11406 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11407 (set-match-data link-match-data)
11408 (while (<= match-index number-of-groups)
11409 (let ((regex (concat "%" (number-to-string match-index)))
11410 (replace-with (match-string match-index dlink)))
11411 (while (string-match regex cmd)
11412 (setq cmd (replace-match replace-with t t cmd))))
11413 (setq match-index (+ match-index 1)))))
11415 (save-window-excursion
11416 (message "Running %s...done" cmd)
11417 (start-process-shell-command cmd nil cmd)
11418 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11419 ((or (stringp cmd)
11420 (eq cmd 'emacs))
11421 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11422 (widen)
11423 (if line (progn (org-goto-line line)
11424 (if (derived-mode-p 'org-mode)
11425 (org-reveal)))
11426 (if search (org-link-search search))))
11427 ((consp cmd)
11428 (let ((file (convert-standard-filename file)))
11429 (save-match-data
11430 (set-match-data link-match-data)
11431 (eval cmd))))
11432 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11433 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11434 (or (not (equal old-buffer (current-buffer)))
11435 (not (equal old-pos (point))))
11436 (org-mark-ring-push old-pos old-buffer))))
11438 (defun org-file-apps-entry-match-against-dlink-p (entry)
11439 "This function returns non-nil if `entry' uses a regular
11440 expression which should be matched against the whole link by
11441 org-open-file.
11443 It assumes that is the case when the entry uses a regular
11444 expression which has at least one grouping construct and the
11445 action is either a lisp form or a command string containing
11446 '%1', i.e. using at least one subexpression match as a
11447 parameter."
11448 (let ((selector (car entry))
11449 (action (cdr entry)))
11450 (if (stringp selector)
11451 (and (> (regexp-opt-depth selector) 0)
11452 (or (and (stringp action)
11453 (string-match "%[0-9]" action))
11454 (consp action)))
11455 nil)))
11457 (defun org-default-apps ()
11458 "Return the default applications for this operating system."
11459 (cond
11460 ((eq system-type 'darwin)
11461 org-file-apps-defaults-macosx)
11462 ((eq system-type 'windows-nt)
11463 org-file-apps-defaults-windowsnt)
11464 (t org-file-apps-defaults-gnu)))
11466 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11467 "Convert extensions to regular expressions in the cars of LIST.
11468 Also, weed out any non-string entries, because the return value is used
11469 only for regexp matching.
11470 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11471 point to the symbol `emacs', indicating that the file should
11472 be opened in Emacs."
11473 (append
11474 (delq nil
11475 (mapcar (lambda (x)
11476 (if (not (stringp (car x)))
11478 (if (string-match "\\W" (car x))
11480 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11481 list))
11482 (if add-auto-mode
11483 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11485 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11486 (defun org-file-remote-p (file)
11487 "Test whether FILE specifies a location on a remote system.
11488 Return non-nil if the location is indeed remote.
11490 For example, the filename \"/user@host:/foo\" specifies a location
11491 on the system \"/user@host:\"."
11492 (cond ((fboundp 'file-remote-p)
11493 (file-remote-p file))
11494 ((fboundp 'tramp-handle-file-remote-p)
11495 (tramp-handle-file-remote-p file))
11496 ((and (boundp 'ange-ftp-name-format)
11497 (string-match (car ange-ftp-name-format) file))
11498 t)))
11501 ;;;; Refiling
11503 (defun org-get-org-file ()
11504 "Read a filename, with default directory `org-directory'."
11505 (let ((default (or org-default-notes-file remember-data-file)))
11506 (read-file-name (format "File name [%s]: " default)
11507 (file-name-as-directory org-directory)
11508 default)))
11510 (defun org-notes-order-reversed-p ()
11511 "Check if the current file should receive notes in reversed order."
11512 (cond
11513 ((not org-reverse-note-order) nil)
11514 ((eq t org-reverse-note-order) t)
11515 ((not (listp org-reverse-note-order)) nil)
11516 (t (catch 'exit
11517 (let ((all org-reverse-note-order)
11518 entry)
11519 (while (setq entry (pop all))
11520 (if (string-match (car entry) buffer-file-name)
11521 (throw 'exit (cdr entry))))
11522 nil)))))
11524 (defvar org-refile-target-table nil
11525 "The list of refile targets, created by `org-refile'.")
11527 (defvar org-agenda-new-buffers nil
11528 "Buffers created to visit agenda files.")
11530 (defvar org-refile-cache nil
11531 "Cache for refile targets.")
11533 (defvar org-refile-markers nil
11534 "All the markers used for caching refile locations.")
11536 (defun org-refile-marker (pos)
11537 "Get a new refile marker, but only if caching is in use."
11538 (if (not org-refile-use-cache)
11540 (let ((m (make-marker)))
11541 (move-marker m pos)
11542 (push m org-refile-markers)
11543 m)))
11545 (defun org-refile-cache-clear ()
11546 "Clear the refile cache and disable all the markers."
11547 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11548 (setq org-refile-markers nil)
11549 (setq org-refile-cache nil)
11550 (message "Refile cache has been cleared"))
11552 (defun org-refile-cache-check-set (set)
11553 "Check if all the markers in the cache still have live buffers."
11554 (let (marker)
11555 (catch 'exit
11556 (while (and set (setq marker (nth 3 (pop set))))
11557 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11558 (when (and marker (null (marker-buffer marker)))
11559 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11560 (sit-for 3)
11561 (throw 'exit nil)))
11562 t)))
11564 (defun org-refile-cache-put (set &rest identifiers)
11565 "Push the refile targets SET into the cache, under IDENTIFIERS."
11566 (let* ((key (sha1 (prin1-to-string identifiers)))
11567 (entry (assoc key org-refile-cache)))
11568 (if entry
11569 (setcdr entry set)
11570 (push (cons key set) org-refile-cache))))
11572 (defun org-refile-cache-get (&rest identifiers)
11573 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11574 (cond
11575 ((not org-refile-cache) nil)
11576 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11578 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11579 org-refile-cache))))
11580 (and set (org-refile-cache-check-set set) set)))))
11582 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11583 "Produce a table with refile targets."
11584 (let ((case-fold-search nil)
11585 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11586 (entries (or org-refile-targets '((nil . (:level . 1)))))
11587 targets tgs txt re files f desc descre fast-path-p level pos0)
11588 (message "Getting targets...")
11589 (with-current-buffer (or default-buffer (current-buffer))
11590 (while (setq entry (pop entries))
11591 (setq files (car entry) desc (cdr entry))
11592 (setq fast-path-p nil)
11593 (cond
11594 ((null files) (setq files (list (current-buffer))))
11595 ((eq files 'org-agenda-files)
11596 (setq files (org-agenda-files 'unrestricted)))
11597 ((and (symbolp files) (fboundp files))
11598 (setq files (funcall files)))
11599 ((and (symbolp files) (boundp files))
11600 (setq files (symbol-value files))))
11601 (if (stringp files) (setq files (list files)))
11602 (cond
11603 ((eq (car desc) :tag)
11604 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11605 ((eq (car desc) :todo)
11606 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11607 ((eq (car desc) :regexp)
11608 (setq descre (cdr desc)))
11609 ((eq (car desc) :level)
11610 (setq descre (concat "^\\*\\{" (number-to-string
11611 (if org-odd-levels-only
11612 (1- (* 2 (cdr desc)))
11613 (cdr desc)))
11614 "\\}[ \t]")))
11615 ((eq (car desc) :maxlevel)
11616 (setq fast-path-p t)
11617 (setq descre (concat "^\\*\\{1," (number-to-string
11618 (if org-odd-levels-only
11619 (1- (* 2 (cdr desc)))
11620 (cdr desc)))
11621 "\\}[ \t]")))
11622 (t (error "Bad refiling target description %s" desc)))
11623 (while (setq f (pop files))
11624 (with-current-buffer
11625 (if (bufferp f) f (org-get-agenda-file-buffer f))
11627 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11628 (progn
11629 (if (bufferp f) (setq f (buffer-file-name
11630 (buffer-base-buffer f))))
11631 (setq f (and f (expand-file-name f)))
11632 (if (eq org-refile-use-outline-path 'file)
11633 (push (list (file-name-nondirectory f) f nil nil) tgs))
11634 (save-excursion
11635 (save-restriction
11636 (widen)
11637 (goto-char (point-min))
11638 (while (re-search-forward descre nil t)
11639 (goto-char (setq pos0 (point-at-bol)))
11640 (catch 'next
11641 (when org-refile-target-verify-function
11642 (save-match-data
11643 (or (funcall org-refile-target-verify-function)
11644 (throw 'next t))))
11645 (when (and (looking-at org-complex-heading-regexp)
11646 (not (member (match-string 4) excluded-entries))
11647 (match-string 4))
11648 (setq level (org-reduced-level
11649 (- (match-end 1) (match-beginning 1)))
11650 txt (org-link-display-format (match-string 4))
11651 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11652 re (format org-complex-heading-regexp-format
11653 (regexp-quote (match-string 4))))
11654 (when org-refile-use-outline-path
11655 (setq txt (mapconcat
11656 'org-protect-slash
11657 (append
11658 (if (eq org-refile-use-outline-path
11659 'file)
11660 (list (file-name-nondirectory
11661 (buffer-file-name
11662 (buffer-base-buffer))))
11663 (if (eq org-refile-use-outline-path
11664 'full-file-path)
11665 (list (buffer-file-name
11666 (buffer-base-buffer)))))
11667 (org-get-outline-path fast-path-p
11668 level txt)
11669 (list txt))
11670 "/")))
11671 (push (list txt f re (org-refile-marker (point)))
11672 tgs)))
11673 (when (= (point) pos0)
11674 ;; verification function has not moved point
11675 (goto-char (point-at-eol))))))))
11676 (when org-refile-use-cache
11677 (org-refile-cache-put tgs (buffer-file-name) descre))
11678 (setq targets (append tgs targets))))))
11679 (message "Getting targets...done")
11680 (nreverse targets)))
11682 (defun org-protect-slash (s)
11683 (while (string-match "/" s)
11684 (setq s (replace-match "\\" t t s)))
11687 (defvar org-olpa (make-vector 20 nil))
11689 (defun org-get-outline-path (&optional fastp level heading)
11690 "Return the outline path to the current entry, as a list.
11692 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11693 routine which makes outline path derivations for an entire file,
11694 avoiding backtracing. Refile target collection makes use of that."
11695 (if fastp
11696 (progn
11697 (if (> level 19)
11698 (error "Outline path failure, more than 19 levels"))
11699 (loop for i from level upto 19 do
11700 (aset org-olpa i nil))
11701 (prog1
11702 (delq nil (append org-olpa nil))
11703 (aset org-olpa level heading)))
11704 (let (rtn case-fold-search)
11705 (save-excursion
11706 (save-restriction
11707 (widen)
11708 (while (org-up-heading-safe)
11709 (when (looking-at org-complex-heading-regexp)
11710 (push (org-trim
11711 (replace-regexp-in-string
11712 ;; Remove statistical/checkboxes cookies
11713 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11714 (org-match-string-no-properties 4)))
11715 rtn)))
11716 rtn)))))
11718 (defun org-format-outline-path (path &optional width prefix separator)
11719 "Format the outline path PATH for display.
11720 WIDTH is the maximum number of characters that is available.
11721 PREFIX is a prefix to be included in the returned string,
11722 such as the file name.
11723 SEPARATOR is inserted between the different parts of the path,
11724 the default is \"/\"."
11725 (setq width (or width 79))
11726 (if prefix (setq width (- width (length prefix))))
11727 (if (not path)
11728 (or prefix "")
11729 (let* ((nsteps (length path))
11730 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11731 (maxwidth (if (<= total-width width)
11732 10000 ;; everything fits
11733 ;; we need to shorten the level headings
11734 (/ (- width nsteps) nsteps)))
11735 (org-odd-levels-only nil)
11736 (n 0)
11737 (total (1+ (length prefix))))
11738 (setq maxwidth (max maxwidth 10))
11739 (concat prefix
11740 (if prefix (or separator "/"))
11741 (mapconcat
11742 (lambda (h)
11743 (setq n (1+ n))
11744 (if (and (= n nsteps) (< maxwidth 10000))
11745 (setq maxwidth (- total-width total)))
11746 (if (< (length h) maxwidth)
11747 (progn (setq total (+ total (length h) 1)) h)
11748 (setq h (substring h 0 (- maxwidth 2))
11749 total (+ total maxwidth 1))
11750 (if (string-match "[ \t]+\\'" h)
11751 (setq h (substring h 0 (match-beginning 0))))
11752 (setq h (concat h "..")))
11753 (org-add-props h nil 'face
11754 (nth (% (1- n) org-n-level-faces)
11755 org-level-faces))
11757 path (or separator "/"))))))
11759 (defun org-display-outline-path (&optional file current separator just-return-string)
11760 "Display the current outline path in the echo area.
11762 If FILE is non-nil, prepend the output with the file name.
11763 If CURRENT is non-nil, append the current heading to the output.
11764 SEPARATOR is passed through to `org-format-outline-path'. It separates
11765 the different parts of the path and defaults to \"/\".
11766 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11767 (interactive "P")
11768 (let* (case-fold-search
11769 (bfn (buffer-file-name (buffer-base-buffer)))
11770 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11771 res)
11772 (if current (setq path (append path
11773 (save-excursion
11774 (org-back-to-heading t)
11775 (if (looking-at org-complex-heading-regexp)
11776 (list (match-string 4)))))))
11777 (setq res
11778 (org-format-outline-path
11779 path
11780 (1- (frame-width))
11781 (and file bfn (concat (file-name-nondirectory bfn) separator))
11782 separator))
11783 (if just-return-string
11784 (org-no-properties res)
11785 (org-unlogged-message "%s" res))))
11787 (defvar org-refile-history nil
11788 "History for refiling operations.")
11790 (defvar org-after-refile-insert-hook nil
11791 "Hook run after `org-refile' has inserted its stuff at the new location.
11792 Note that this is still *before* the stuff will be removed from
11793 the *old* location.")
11795 (defvar org-capture-last-stored-marker)
11796 (defvar org-refile-keep nil
11797 "Non-nil means `org-refile' will copy instead of refile.")
11799 (defun org-copy ()
11800 "Like `org-refile', but copy."
11801 (interactive)
11802 (let ((org-refile-keep t))
11803 (funcall 'org-refile nil nil nil "Copy")))
11805 (defun org-refile (&optional arg default-buffer rfloc msg)
11806 "Move the entry or entries at point to another heading.
11807 The list of target headings is compiled using the information in
11808 `org-refile-targets', which see.
11810 At the target location, the entry is filed as a subitem of the
11811 target heading. Depending on `org-reverse-note-order', the new
11812 subitem will either be the first or the last subitem.
11814 If there is an active region, all entries in that region will be
11815 refiled. However, the region must fulfill the requirement that
11816 the first heading sets the top-level of the moved text.
11818 With prefix arg ARG, the command will only visit the target
11819 location and not actually move anything.
11821 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11822 refiling operation has put the subtree.
11824 With a numeric prefix argument of `2', refile to the running clock.
11826 With a numeric prefix argument of `3', emulate `org-refile-keep'
11827 being set to `t' and copy to the target location, don't move it.
11828 Beware that keeping refiled entries may result in duplicated ID
11829 properties.
11831 RFLOC can be a refile location obtained in a different way.
11833 MSG is a string to replace \"Refile\" in the default prompt with
11834 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11836 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11838 If you are using target caching (see `org-refile-use-cache'), you
11839 have to clear the target cache in order to find new targets.
11840 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11841 prefix argument (`C-u C-u C-u C-c C-w')."
11842 (interactive "P")
11843 (if (member arg '(0 (64)))
11844 (org-refile-cache-clear)
11845 (let* ((actionmsg (cond (msg msg)
11846 ((equal arg 3) "Refile (and keep)")
11847 (t "Refile")))
11848 (cbuf (current-buffer))
11849 (regionp (org-region-active-p))
11850 (region-start (and regionp (region-beginning)))
11851 (region-end (and regionp (region-end)))
11852 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11853 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11854 pos it nbuf file re level reversed)
11855 (setq last-command nil)
11856 (when regionp
11857 (goto-char region-start)
11858 (or (bolp) (goto-char (point-at-bol)))
11859 (setq region-start (point))
11860 (unless (or (org-kill-is-subtree-p
11861 (buffer-substring region-start region-end))
11862 (prog1 org-refile-active-region-within-subtree
11863 (let ((s (point-at-eol)))
11864 (org-toggle-heading)
11865 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11866 (user-error "The region is not a (sequence of) subtree(s)")))
11867 (if (equal arg '(16))
11868 (org-refile-goto-last-stored)
11869 (when (or
11870 (and (equal arg 2)
11871 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11872 (prog1
11873 (setq it (list (or org-clock-heading "running clock")
11874 (buffer-file-name
11875 (marker-buffer org-clock-hd-marker))
11877 (marker-position org-clock-hd-marker)))
11878 (setq arg nil)))
11879 (setq it (or rfloc
11880 (let (heading-text)
11881 (save-excursion
11882 (unless (and arg (listp arg))
11883 (org-back-to-heading t)
11884 (setq heading-text
11885 (replace-regexp-in-string
11886 org-bracket-link-regexp
11887 "\\3"
11888 (nth 4 (org-heading-components)))))
11889 (org-refile-get-location
11890 (cond ((and arg (listp arg)) "Goto")
11891 (regionp (concat actionmsg " region to"))
11892 (t (concat actionmsg " subtree \""
11893 heading-text "\" to")))
11894 default-buffer
11895 (and (not (equal '(4) arg))
11896 org-refile-allow-creating-parent-nodes)
11897 arg))))))
11898 (setq file (nth 1 it)
11899 re (nth 2 it)
11900 pos (nth 3 it))
11901 (if (and (not arg)
11903 (equal (buffer-file-name) file)
11904 (if regionp
11905 (and (>= pos region-start)
11906 (<= pos region-end))
11907 (and (>= pos (point))
11908 (< pos (save-excursion
11909 (org-end-of-subtree t t))))))
11910 (error "Cannot refile to position inside the tree or region"))
11911 (setq nbuf (or (find-buffer-visiting file)
11912 (find-file-noselect file)))
11913 (if (and arg (not (equal arg 3)))
11914 (progn
11915 (org-pop-to-buffer-same-window nbuf)
11916 (goto-char pos)
11917 (org-show-context 'org-goto))
11918 (if regionp
11919 (progn
11920 (org-kill-new (buffer-substring region-start region-end))
11921 (org-save-markers-in-region region-start region-end))
11922 (org-copy-subtree 1 nil t))
11923 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11924 (find-file-noselect file)))
11925 (setq reversed (org-notes-order-reversed-p))
11926 (save-excursion
11927 (save-restriction
11928 (widen)
11929 (if pos
11930 (progn
11931 (goto-char pos)
11932 (looking-at org-outline-regexp)
11933 (setq level (org-get-valid-level (funcall outline-level) 1))
11934 (goto-char
11935 (if reversed
11936 (or (outline-next-heading) (point-max))
11937 (or (save-excursion (org-get-next-sibling))
11938 (org-end-of-subtree t t)
11939 (point-max)))))
11940 (setq level 1)
11941 (if (not reversed)
11942 (goto-char (point-max))
11943 (goto-char (point-min))
11944 (or (outline-next-heading) (goto-char (point-max)))))
11945 (if (not (bolp)) (newline))
11946 (org-paste-subtree level nil nil t)
11947 (when org-log-refile
11948 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11949 (unless (eq org-log-refile 'note)
11950 (save-excursion (org-add-log-note))))
11951 (and org-auto-align-tags
11952 (let ((org-loop-over-headlines-in-active-region nil))
11953 (org-set-tags nil t)))
11954 (let ((bookmark-name (plist-get org-bookmark-names-plist
11955 :last-refile)))
11956 (when bookmark-name
11957 (with-demoted-errors
11958 (bookmark-set bookmark-name))))
11959 ;; If we are refiling for capture, make sure that the
11960 ;; last-capture pointers point here
11961 (when (org-bound-and-true-p org-refile-for-capture)
11962 (let ((bookmark-name (plist-get org-bookmark-names-plist
11963 :last-capture-marker)))
11964 (when bookmark-name
11965 (with-demoted-errors
11966 (bookmark-set bookmark-name))))
11967 (move-marker org-capture-last-stored-marker (point)))
11968 (if (fboundp 'deactivate-mark) (deactivate-mark))
11969 (run-hooks 'org-after-refile-insert-hook))))
11970 (unless org-refile-keep
11971 (if regionp
11972 (delete-region (point) (+ (point) (- region-end region-start)))
11973 (delete-region
11974 (and (org-back-to-heading t) (point))
11975 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11976 (when (featurep 'org-inlinetask)
11977 (org-inlinetask-remove-END-maybe))
11978 (setq org-markers-to-move nil)
11979 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11981 (defun org-refile-goto-last-stored ()
11982 "Go to the location where the last refile was stored."
11983 (interactive)
11984 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11985 (message "This is the location of the last refile"))
11987 (defun org-refile--get-location (refloc tbl)
11988 "When user refile to REFLOC, find the associated target in TBL.
11989 Also check `org-refile-target-table'."
11990 (car (delq
11992 (mapcar
11993 (lambda (r) (or (assoc r tbl)
11994 (assoc r org-refile-target-table)))
11995 (list (replace-regexp-in-string "/$" "" refloc)
11996 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11998 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11999 no-exclude)
12000 "Prompt the user for a refile location, using PROMPT.
12001 PROMPT should not be suffixed with a colon and a space, because
12002 this function appends the default value from
12003 `org-refile-history' automatically, if that is not empty.
12004 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12005 this is used for the GOTO interface."
12006 (let ((org-refile-targets org-refile-targets)
12007 (org-refile-use-outline-path org-refile-use-outline-path)
12008 excluded-entries)
12009 (when (and (derived-mode-p 'org-mode)
12010 (not org-refile-use-cache)
12011 (not no-exclude))
12012 (org-map-tree
12013 (lambda()
12014 (setq excluded-entries
12015 (append excluded-entries (list (org-get-heading t t)))))))
12016 (setq org-refile-target-table
12017 (org-refile-get-targets default-buffer excluded-entries)))
12018 (unless org-refile-target-table
12019 (user-error "No refile targets"))
12020 (let* ((cbuf (current-buffer))
12021 (partial-completion-mode nil)
12022 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12023 (cfunc (if (and org-refile-use-outline-path
12024 org-outline-path-complete-in-steps)
12025 'org-olpath-completing-read
12026 'org-icompleting-read))
12027 (extra (if org-refile-use-outline-path "/" ""))
12028 (cbnex (concat (buffer-name) extra))
12029 (filename (and cfn (expand-file-name cfn)))
12030 (tbl (mapcar
12031 (lambda (x)
12032 (if (and (not (member org-refile-use-outline-path
12033 '(file full-file-path)))
12034 (not (equal filename (nth 1 x))))
12035 (cons (concat (car x) extra " ("
12036 (file-name-nondirectory (nth 1 x)) ")")
12037 (cdr x))
12038 (cons (concat (car x) extra) (cdr x))))
12039 org-refile-target-table))
12040 (completion-ignore-case t)
12041 cdef
12042 (prompt (concat prompt
12043 (or (and (car org-refile-history)
12044 (concat " (default " (car org-refile-history) ")"))
12045 (and (assoc cbnex tbl) (setq cdef cbnex)
12046 (concat " (default " cbnex ")"))) ": "))
12047 pa answ parent-target child parent old-hist)
12048 (setq old-hist org-refile-history)
12049 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12050 nil 'org-refile-history (or cdef (car org-refile-history))))
12051 (if (setq pa (org-refile--get-location answ tbl))
12052 (progn
12053 (org-refile-check-position pa)
12054 (when (or (not org-refile-history)
12055 (not (eq old-hist org-refile-history))
12056 (not (equal (car pa) (car org-refile-history))))
12057 (setq org-refile-history
12058 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12059 org-refile-history
12060 (cdr org-refile-history))))
12061 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12062 (pop org-refile-history)))
12064 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12065 (progn
12066 (setq parent (match-string 1 answ)
12067 child (match-string 2 answ))
12068 (setq parent-target (org-refile--get-location parent tbl))
12069 (when (and parent-target
12070 (or (eq new-nodes t)
12071 (and (eq new-nodes 'confirm)
12072 (y-or-n-p (format "Create new node \"%s\"? "
12073 child)))))
12074 (org-refile-new-child parent-target child)))
12075 (user-error "Invalid target location")))))
12077 (declare-function org-string-nw-p "org-macs" (s))
12078 (defun org-refile-check-position (refile-pointer)
12079 "Check if the refile pointer matches the headline to which it points."
12080 (let* ((file (nth 1 refile-pointer))
12081 (re (nth 2 refile-pointer))
12082 (pos (nth 3 refile-pointer))
12083 buffer)
12084 (if (and (not (markerp pos)) (not file))
12085 (user-error "Please indicate a target file in the refile path")
12086 (when (org-string-nw-p re)
12087 (setq buffer (if (markerp pos)
12088 (marker-buffer pos)
12089 (or (find-buffer-visiting file)
12090 (find-file-noselect file))))
12091 (with-current-buffer buffer
12092 (save-excursion
12093 (save-restriction
12094 (widen)
12095 (goto-char pos)
12096 (beginning-of-line 1)
12097 (unless (org-looking-at-p re)
12098 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12100 (defun org-refile-new-child (parent-target child)
12101 "Use refile target PARENT-TARGET to add new CHILD below it."
12102 (unless parent-target
12103 (error "Cannot find parent for new node"))
12104 (let ((file (nth 1 parent-target))
12105 (pos (nth 3 parent-target))
12106 level)
12107 (with-current-buffer (or (find-buffer-visiting file)
12108 (find-file-noselect file))
12109 (save-excursion
12110 (save-restriction
12111 (widen)
12112 (if pos
12113 (goto-char pos)
12114 (goto-char (point-max))
12115 (if (not (bolp)) (newline)))
12116 (when (looking-at org-outline-regexp)
12117 (setq level (funcall outline-level))
12118 (org-end-of-subtree t t))
12119 (org-back-over-empty-lines)
12120 (insert "\n" (make-string
12121 (if pos (org-get-valid-level level 1) 1) ?*)
12122 " " child "\n")
12123 (beginning-of-line 0)
12124 (list (concat (car parent-target) "/" child) file "" (point)))))))
12126 (defun org-olpath-completing-read (prompt collection &rest args)
12127 "Read an outline path like a file name."
12128 (let ((thetable collection)
12129 (org-completion-use-ido nil) ; does not work with ido.
12130 (org-completion-use-iswitchb nil)) ; or iswitchb
12131 (apply #'org-icompleting-read
12132 prompt
12133 (lambda (string predicate &optional flag)
12134 (cond
12135 ((eq flag nil) (try-completion string thetable))
12136 ((eq flag t)
12137 (let ((l (length string)))
12138 (mapcar (lambda (x)
12139 (let ((r (substring x l))
12140 (f (if (string-match " ([^)]*)$" x)
12141 (match-string 0 x)
12142 "")))
12143 (if (string-match "/" r)
12144 (concat string (substring r 0 (match-end 0)) f)
12145 x)))
12146 (all-completions string thetable predicate))))
12147 ;; Exact match?
12148 ((eq flag 'lambda) (assoc string thetable))))
12149 args)))
12151 ;;;; Dynamic blocks
12153 (defun org-find-dblock (name)
12154 "Find the first dynamic block with name NAME in the buffer.
12155 If not found, stay at current position and return nil."
12156 (let ((case-fold-search t) pos)
12157 (save-excursion
12158 (goto-char (point-min))
12159 (setq pos (and (re-search-forward
12160 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12161 (match-beginning 0))))
12162 (if pos (goto-char pos))
12163 pos))
12165 (defun org-create-dblock (plist)
12166 "Create a dynamic block section, with parameters taken from PLIST.
12167 PLIST must contain a :name entry which is used as the name of the block."
12168 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12169 (end-of-line 1)
12170 (newline))
12171 (let ((col (current-column))
12172 (name (plist-get plist :name)))
12173 (insert "#+BEGIN: " name)
12174 (while plist
12175 (if (eq (car plist) :name)
12176 (setq plist (cddr plist))
12177 (insert " " (prin1-to-string (pop plist)))))
12178 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12179 (beginning-of-line -2)))
12181 (defun org-prepare-dblock ()
12182 "Prepare dynamic block for refresh.
12183 This empties the block, puts the cursor at the insert position and returns
12184 the property list including an extra property :name with the block name."
12185 (unless (looking-at org-dblock-start-re)
12186 (user-error "Not at a dynamic block"))
12187 (let* ((begdel (1+ (match-end 0)))
12188 (name (org-no-properties (match-string 1)))
12189 (params (append (list :name name)
12190 (read (concat "(" (match-string 3) ")")))))
12191 (save-excursion
12192 (beginning-of-line 1)
12193 (skip-chars-forward " \t")
12194 (setq params (plist-put params :indentation-column (current-column))))
12195 (unless (re-search-forward org-dblock-end-re nil t)
12196 (error "Dynamic block not terminated"))
12197 (setq params
12198 (append params
12199 (list :content (buffer-substring
12200 begdel (match-beginning 0)))))
12201 (delete-region begdel (match-beginning 0))
12202 (goto-char begdel)
12203 (open-line 1)
12204 params))
12206 (defun org-map-dblocks (&optional command)
12207 "Apply COMMAND to all dynamic blocks in the current buffer.
12208 If COMMAND is not given, use `org-update-dblock'."
12209 (let ((cmd (or command 'org-update-dblock)))
12210 (save-excursion
12211 (goto-char (point-min))
12212 (while (re-search-forward org-dblock-start-re nil t)
12213 (goto-char (match-beginning 0))
12214 (save-excursion
12215 (condition-case nil
12216 (funcall cmd)
12217 (error (message "Error during update of dynamic block"))))
12218 (unless (re-search-forward org-dblock-end-re nil t)
12219 (error "Dynamic block not terminated"))))))
12221 (defun org-dblock-update (&optional arg)
12222 "User command for updating dynamic blocks.
12223 Update the dynamic block at point. With prefix ARG, update all dynamic
12224 blocks in the buffer."
12225 (interactive "P")
12226 (if arg
12227 (org-update-all-dblocks)
12228 (or (looking-at org-dblock-start-re)
12229 (org-beginning-of-dblock))
12230 (org-update-dblock)))
12232 (defun org-update-dblock ()
12233 "Update the dynamic block at point.
12234 This means to empty the block, parse for parameters and then call
12235 the correct writing function."
12236 (interactive)
12237 (save-excursion
12238 (let* ((win (selected-window))
12239 (pos (point))
12240 (line (org-current-line))
12241 (params (org-prepare-dblock))
12242 (name (plist-get params :name))
12243 (indent (plist-get params :indentation-column))
12244 (cmd (intern (concat "org-dblock-write:" name))))
12245 (message "Updating dynamic block `%s' at line %d..." name line)
12246 (funcall cmd params)
12247 (message "Updating dynamic block `%s' at line %d...done" name line)
12248 (goto-char pos)
12249 (when (and indent (> indent 0))
12250 (setq indent (make-string indent ?\ ))
12251 (save-excursion
12252 (select-window win)
12253 (org-beginning-of-dblock)
12254 (forward-line 1)
12255 (while (not (looking-at org-dblock-end-re))
12256 (insert indent)
12257 (beginning-of-line 2))
12258 (when (looking-at org-dblock-end-re)
12259 (and (looking-at "[ \t]+")
12260 (replace-match ""))
12261 (insert indent)))))))
12263 (defun org-beginning-of-dblock ()
12264 "Find the beginning of the dynamic block at point.
12265 Error if there is no such block at point."
12266 (let ((pos (point))
12267 beg)
12268 (end-of-line 1)
12269 (if (and (re-search-backward org-dblock-start-re nil t)
12270 (setq beg (match-beginning 0))
12271 (re-search-forward org-dblock-end-re nil t)
12272 (> (match-end 0) pos))
12273 (goto-char beg)
12274 (goto-char pos)
12275 (error "Not in a dynamic block"))))
12277 (defun org-update-all-dblocks ()
12278 "Update all dynamic blocks in the buffer.
12279 This function can be used in a hook."
12280 (interactive)
12281 (when (derived-mode-p 'org-mode)
12282 (org-map-dblocks 'org-update-dblock)))
12285 ;;;; Completion
12287 (declare-function org-export-backend-name "org-export" (cl-x))
12288 (declare-function org-export-backend-options "org-export" (cl-x))
12289 (defun org-get-export-keywords ()
12290 "Return a list of all currently understood export keywords.
12291 Export keywords include options, block names, attributes and
12292 keywords relative to each registered export back-end."
12293 (let (keywords)
12294 (dolist (backend
12295 (org-bound-and-true-p org-export-registered-backends)
12296 (delq nil keywords))
12297 ;; Back-end name (for keywords, like #+LATEX:)
12298 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12299 (dolist (option-entry (org-export-backend-options backend))
12300 ;; Back-end options.
12301 (push (nth 1 option-entry) keywords)))))
12303 (defconst org-options-keywords
12304 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12305 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12306 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12307 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12308 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12310 (defcustom org-structure-template-alist
12311 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12312 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12313 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12314 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12315 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12316 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12317 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12318 ("L" "#+LaTeX: ")
12319 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12320 ("H" "#+HTML: ")
12321 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12322 ("A" "#+ASCII: ")
12323 ("i" "#+INDEX: ?")
12324 ("I" "#+INCLUDE: %file ?"))
12325 "Structure completion elements.
12326 This is a list of abbreviation keys and values. The value gets inserted
12327 if you type `<' followed by the key and then press the completion key,
12328 usually `TAB'. %file will be replaced by a file name after prompting
12329 for the file using completion. The cursor will be placed at the position
12330 of the `?` in the template.
12331 There are two templates for each key, the first uses the original Org syntax,
12332 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12333 the default when the /org-mtags.el/ module has been loaded. See also the
12334 variable `org-mtags-prefer-muse-templates'."
12335 :group 'org-completion
12336 :type '(repeat
12337 (list
12338 (string :tag "Key")
12339 (string :tag "Template")))
12340 :version "25.1"
12341 :package-version '(Org . "8.3"))
12343 (defun org-try-structure-completion ()
12344 "Try to complete a structure template before point.
12345 This looks for strings like \"<e\" on an otherwise empty line and
12346 expands them."
12347 (let ((l (buffer-substring (point-at-bol) (point)))
12349 (when (and (looking-at "[ \t]*$")
12350 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12351 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12352 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12353 (match-beginning 1)) a)
12354 t)))
12356 (defun org-complete-expand-structure-template (start cell)
12357 "Expand a structure template."
12358 (let ((rpl (nth 1 cell))
12359 (ind ""))
12360 (delete-region start (point))
12361 (when (string-match "\\`[ \t]*#\\+" rpl)
12362 (cond
12363 ((bolp))
12364 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12365 (setq ind (buffer-substring (point-at-bol) (point))))
12366 (t (newline))))
12367 (setq start (point))
12368 (if (string-match "%file" rpl)
12369 (setq rpl (replace-match
12370 (concat
12371 "\""
12372 (save-match-data
12373 (abbreviate-file-name (read-file-name "Include file: ")))
12374 "\"")
12375 t t rpl)))
12376 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12377 (concat "\n" ind)))
12378 (insert rpl)
12379 (if (re-search-backward "\\?" start t) (delete-char 1))))
12381 ;;;; TODO, DEADLINE, Comments
12383 (defun org-toggle-comment ()
12384 "Change the COMMENT state of an entry."
12385 (interactive)
12386 (save-excursion
12387 (org-back-to-heading)
12388 (looking-at org-complex-heading-regexp)
12389 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12390 (skip-chars-forward " \t")
12391 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12392 (if (org-in-commented-heading-p t)
12393 (delete-region (point)
12394 (progn (search-forward " " (line-end-position) 'move)
12395 (skip-chars-forward " \t")
12396 (point)))
12397 (insert org-comment-string)
12398 (unless (eolp) (insert " ")))))
12400 (defvar org-last-todo-state-is-todo nil
12401 "This is non-nil when the last TODO state change led to a TODO state.
12402 If the last change removed the TODO tag or switched to DONE, then
12403 this is nil.")
12405 (defvar org-setting-tags nil) ; dynamically skipped
12407 (defvar org-todo-setup-filter-hook nil
12408 "Hook for functions that pre-filter todo specs.
12409 Each function takes a todo spec and returns either nil or the spec
12410 transformed into canonical form." )
12412 (defvar org-todo-get-default-hook nil
12413 "Hook for functions that get a default item for todo.
12414 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12415 nil or a string to be used for the todo mark." )
12417 (defvar org-agenda-headline-snapshot-before-repeat)
12419 (defun org-current-effective-time ()
12420 "Return current time adjusted for `org-extend-today-until' variable."
12421 (let* ((ct (org-current-time))
12422 (dct (decode-time ct))
12423 (ct1
12424 (cond
12425 (org-use-last-clock-out-time-as-effective-time
12426 (or (org-clock-get-last-clock-out-time) ct))
12427 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12428 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12429 (t ct))))
12430 ct1))
12432 (defun org-todo-yesterday (&optional arg)
12433 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12434 (interactive "P")
12435 (if (eq major-mode 'org-agenda-mode)
12436 (apply 'org-agenda-todo-yesterday arg)
12437 (let* ((org-use-effective-time t)
12438 (hour (third (decode-time
12439 (org-current-time))))
12440 (org-extend-today-until (1+ hour)))
12441 (org-todo arg))))
12443 (defvar org-block-entry-blocking ""
12444 "First entry preventing the TODO state change.")
12446 (defun org-cancel-repeater ()
12447 "Cancel a repeater by setting its numeric value to zero."
12448 (interactive)
12449 (save-excursion
12450 (org-back-to-heading t)
12451 (let ((bound1 (point))
12452 (bound0 (save-excursion (outline-next-heading) (point))))
12453 (when (re-search-forward
12454 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12455 org-deadline-time-regexp "\\)\\|\\("
12456 org-ts-regexp "\\)")
12457 bound0 t)
12458 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12459 (replace-match "0" t nil nil 1))))))
12461 (defun org-todo (&optional arg)
12462 "Change the TODO state of an item.
12463 The state of an item is given by a keyword at the start of the heading,
12464 like
12465 *** TODO Write paper
12466 *** DONE Call mom
12468 The different keywords are specified in the variable `org-todo-keywords'.
12469 By default the available states are \"TODO\" and \"DONE\".
12470 So for this example: when the item starts with TODO, it is changed to DONE.
12471 When it starts with DONE, the DONE is removed. And when neither TODO nor
12472 DONE are present, add TODO at the beginning of the heading.
12474 With \\[universal-argument] prefix arg, use completion to determine the new \
12475 state.
12476 With numeric prefix arg, switch to that state.
12477 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12478 keywords (nextset).
12479 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12480 With a numeric prefix arg of 0, inhibit note taking for the change.
12481 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12483 When called through ELisp, arg is also interpreted in the following way:
12484 'none -> empty state
12485 \"\"(empty string) -> switch to empty state
12486 'done -> switch to DONE
12487 'nextset -> switch to the next set of keywords
12488 'previousset -> switch to the previous set of keywords
12489 \"WAITING\" -> switch to the specified keyword, but only if it
12490 really is a member of `org-todo-keywords'."
12491 (interactive "P")
12492 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12493 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12494 'region-start-level 'region))
12495 org-loop-over-headlines-in-active-region)
12496 (org-map-entries
12497 `(org-todo ,arg)
12498 org-loop-over-headlines-in-active-region
12499 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12500 (if (equal arg '(16)) (setq arg 'nextset))
12501 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12502 (let ((org-blocker-hook org-blocker-hook)
12503 commentp
12504 case-fold-search)
12505 (when (equal arg '(64))
12506 (setq arg nil org-blocker-hook nil))
12507 (when (and org-blocker-hook
12508 (or org-inhibit-blocking
12509 (org-entry-get nil "NOBLOCKING")))
12510 (setq org-blocker-hook nil))
12511 (save-excursion
12512 (catch 'exit
12513 (org-back-to-heading t)
12514 (when (org-in-commented-heading-p t)
12515 (org-toggle-comment)
12516 (setq commentp t))
12517 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12518 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12519 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12520 (let* ((match-data (match-data))
12521 (startpos (point-at-bol))
12522 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12523 (org-log-done org-log-done)
12524 (org-log-repeat org-log-repeat)
12525 (org-todo-log-states org-todo-log-states)
12526 (org-inhibit-logging
12527 (if (equal arg 0)
12528 (progn (setq arg nil) 'note) org-inhibit-logging))
12529 (this (match-string 1))
12530 (hl-pos (match-beginning 0))
12531 (head (org-get-todo-sequence-head this))
12532 (ass (assoc head org-todo-kwd-alist))
12533 (interpret (nth 1 ass))
12534 (done-word (nth 3 ass))
12535 (final-done-word (nth 4 ass))
12536 (org-last-state (or this ""))
12537 (completion-ignore-case t)
12538 (member (member this org-todo-keywords-1))
12539 (tail (cdr member))
12540 (org-state (cond
12541 ((and org-todo-key-trigger
12542 (or (and (equal arg '(4))
12543 (eq org-use-fast-todo-selection 'prefix))
12544 (and (not arg) org-use-fast-todo-selection
12545 (not (eq org-use-fast-todo-selection
12546 'prefix)))))
12547 ;; Use fast selection
12548 (org-fast-todo-selection))
12549 ((and (equal arg '(4))
12550 (or (not org-use-fast-todo-selection)
12551 (not org-todo-key-trigger)))
12552 ;; Read a state with completion
12553 (org-icompleting-read
12554 "State: " (mapcar 'list org-todo-keywords-1)
12555 nil t))
12556 ((eq arg 'right)
12557 (if this
12558 (if tail (car tail) nil)
12559 (car org-todo-keywords-1)))
12560 ((eq arg 'left)
12561 (if (equal member org-todo-keywords-1)
12563 (if this
12564 (nth (- (length org-todo-keywords-1)
12565 (length tail) 2)
12566 org-todo-keywords-1)
12567 (org-last org-todo-keywords-1))))
12568 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12569 (setq arg nil))) ; hack to fall back to cycling
12570 (arg
12571 ;; user or caller requests a specific state
12572 (cond
12573 ((equal arg "") nil)
12574 ((eq arg 'none) nil)
12575 ((eq arg 'done) (or done-word (car org-done-keywords)))
12576 ((eq arg 'nextset)
12577 (or (car (cdr (member head org-todo-heads)))
12578 (car org-todo-heads)))
12579 ((eq arg 'previousset)
12580 (let ((org-todo-heads (reverse org-todo-heads)))
12581 (or (car (cdr (member head org-todo-heads)))
12582 (car org-todo-heads))))
12583 ((car (member arg org-todo-keywords-1)))
12584 ((stringp arg)
12585 (user-error "State `%s' not valid in this file" arg))
12586 ((nth (1- (prefix-numeric-value arg))
12587 org-todo-keywords-1))))
12588 ((null member) (or head (car org-todo-keywords-1)))
12589 ((equal this final-done-word) nil) ;; -> make empty
12590 ((null tail) nil) ;; -> first entry
12591 ((memq interpret '(type priority))
12592 (if (eq this-command last-command)
12593 (car tail)
12594 (if (> (length tail) 0)
12595 (or done-word (car org-done-keywords))
12596 nil)))
12598 (car tail))))
12599 (org-state (or
12600 (run-hook-with-args-until-success
12601 'org-todo-get-default-hook org-state org-last-state)
12602 org-state))
12603 (next (if org-state (concat " " org-state " ") " "))
12604 (change-plist (list :type 'todo-state-change :from this :to org-state
12605 :position startpos))
12606 dolog now-done-p)
12607 (when org-blocker-hook
12608 (setq org-last-todo-state-is-todo
12609 (not (member this org-done-keywords)))
12610 (unless (save-excursion
12611 (save-match-data
12612 (org-with-wide-buffer
12613 (run-hook-with-args-until-failure
12614 'org-blocker-hook change-plist))))
12615 (if (org-called-interactively-p 'interactive)
12616 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12617 this org-state org-block-entry-blocking)
12618 ;; fail silently
12619 (message "TODO state change from %s to %s blocked (by \"%s\")"
12620 this org-state org-block-entry-blocking)
12621 (throw 'exit nil))))
12622 (store-match-data match-data)
12623 (replace-match next t t)
12624 (cond ((equal this org-state)
12625 (message "TODO state was already %s" (org-trim next)))
12626 ((pos-visible-in-window-p hl-pos)
12627 (message "TODO state changed to %s" (org-trim next))))
12628 (unless head
12629 (setq head (org-get-todo-sequence-head org-state)
12630 ass (assoc head org-todo-kwd-alist)
12631 interpret (nth 1 ass)
12632 done-word (nth 3 ass)
12633 final-done-word (nth 4 ass)))
12634 (when (memq arg '(nextset previousset))
12635 (message "Keyword-Set %d/%d: %s"
12636 (- (length org-todo-sets) -1
12637 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12638 (length org-todo-sets)
12639 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12640 (setq org-last-todo-state-is-todo
12641 (not (member org-state org-done-keywords)))
12642 (setq now-done-p (and (member org-state org-done-keywords)
12643 (not (member this org-done-keywords))))
12644 (and logging (org-local-logging logging))
12645 (when (and (or org-todo-log-states org-log-done)
12646 (not (eq org-inhibit-logging t))
12647 (not (memq arg '(nextset previousset))))
12648 ;; we need to look at recording a time and note
12649 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12650 (nth 2 (assoc this org-todo-log-states))))
12651 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12652 (setq dolog 'time))
12653 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12654 (and org-state
12655 (member org-state org-not-done-keywords)
12656 (not (member this org-not-done-keywords))))
12657 ;; This is now a todo state and was not one before
12658 ;; If there was a CLOSED time stamp, get rid of it.
12659 (org-add-planning-info nil nil 'closed))
12660 (when (and now-done-p org-log-done)
12661 ;; It is now done, and it was not done before
12662 (org-add-planning-info 'closed (org-current-effective-time))
12663 (if (and (not dolog) (eq 'note org-log-done))
12664 (org-add-log-setup 'done org-state this 'findpos 'note)))
12665 (when (and org-state dolog)
12666 ;; This is a non-nil state, and we need to log it
12667 (org-add-log-setup 'state org-state this 'findpos dolog)))
12668 ;; Fixup tag positioning
12669 (org-todo-trigger-tag-changes org-state)
12670 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12671 (when org-provide-todo-statistics
12672 (org-update-parent-todo-statistics))
12673 (run-hooks 'org-after-todo-state-change-hook)
12674 (if (and arg (not (member org-state org-done-keywords)))
12675 (setq head (org-get-todo-sequence-head org-state)))
12676 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12677 ;; Do we need to trigger a repeat?
12678 (when now-done-p
12679 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12680 ;; This is for the agenda, take a snapshot of the headline.
12681 (save-match-data
12682 (setq org-agenda-headline-snapshot-before-repeat
12683 (org-get-heading))))
12684 (org-auto-repeat-maybe org-state))
12685 ;; Fixup cursor location if close to the keyword
12686 (if (and (outline-on-heading-p)
12687 (not (bolp))
12688 (save-excursion (beginning-of-line 1)
12689 (looking-at org-todo-line-regexp))
12690 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12691 (progn
12692 (goto-char (or (match-end 2) (match-end 1)))
12693 (and (looking-at " ") (just-one-space))))
12694 (when org-trigger-hook
12695 (save-excursion
12696 (run-hook-with-args 'org-trigger-hook change-plist)))
12697 (when commentp (org-toggle-comment))))))))
12699 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12700 "Block turning an entry into a TODO, using the hierarchy.
12701 This checks whether the current task should be blocked from state
12702 changes. Such blocking occurs when:
12704 1. The task has children which are not all in a completed state.
12706 2. A task has a parent with the property :ORDERED:, and there
12707 are siblings prior to the current task with incomplete
12708 status.
12710 3. The parent of the task is blocked because it has siblings that should
12711 be done first, or is child of a block grandparent TODO entry."
12713 (if (not org-enforce-todo-dependencies)
12714 t ; if locally turned off don't block
12715 (catch 'dont-block
12716 ;; If this is not a todo state change, or if this entry is already DONE,
12717 ;; do not block
12718 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12719 (member (plist-get change-plist :from)
12720 (cons 'done org-done-keywords))
12721 (member (plist-get change-plist :to)
12722 (cons 'todo org-not-done-keywords))
12723 (not (plist-get change-plist :to)))
12724 (throw 'dont-block t))
12725 ;; If this task has children, and any are undone, it's blocked
12726 (save-excursion
12727 (org-back-to-heading t)
12728 (let ((this-level (funcall outline-level)))
12729 (outline-next-heading)
12730 (let ((child-level (funcall outline-level)))
12731 (while (and (not (eobp))
12732 (> child-level this-level))
12733 ;; this todo has children, check whether they are all
12734 ;; completed
12735 (if (and (not (org-entry-is-done-p))
12736 (org-entry-is-todo-p))
12737 (progn (setq org-block-entry-blocking (org-get-heading))
12738 (throw 'dont-block nil)))
12739 (outline-next-heading)
12740 (setq child-level (funcall outline-level))))))
12741 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12742 ;; any previous siblings are undone, it's blocked
12743 (save-excursion
12744 (org-back-to-heading t)
12745 (let* ((pos (point))
12746 (parent-pos (and (org-up-heading-safe) (point))))
12747 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12748 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12749 (forward-line 1)
12750 (re-search-forward org-not-done-heading-regexp pos t))
12751 (setq org-block-entry-blocking (match-string 0))
12752 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12753 ;; Search further up the hierarchy, to see if an ancestor is blocked
12754 (while t
12755 (goto-char parent-pos)
12756 (if (not (looking-at org-not-done-heading-regexp))
12757 (throw 'dont-block t)) ; do not block, parent is not a TODO
12758 (setq pos (point))
12759 (setq parent-pos (and (org-up-heading-safe) (point)))
12760 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12761 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12762 (forward-line 1)
12763 (re-search-forward org-not-done-heading-regexp pos t)
12764 (setq org-block-entry-blocking (org-get-heading)))
12765 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12767 (defcustom org-track-ordered-property-with-tag nil
12768 "Should the ORDERED property also be shown as a tag?
12769 The ORDERED property decides if an entry should require subtasks to be
12770 completed in sequence. Since a property is not very visible, setting
12771 this option means that toggling the ORDERED property with the command
12772 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12773 not relevant for the behavior, but it makes things more visible.
12775 Note that toggling the tag with tags commands will not change the property
12776 and therefore not influence behavior!
12778 This can be t, meaning the tag ORDERED should be used, It can also be a
12779 string to select a different tag for this task."
12780 :group 'org-todo
12781 :type '(choice
12782 (const :tag "No tracking" nil)
12783 (const :tag "Track with ORDERED tag" t)
12784 (string :tag "Use other tag")))
12786 (defun org-toggle-ordered-property ()
12787 "Toggle the ORDERED property of the current entry.
12788 For better visibility, you can track the value of this property with a tag.
12789 See variable `org-track-ordered-property-with-tag'."
12790 (interactive)
12791 (let* ((t1 org-track-ordered-property-with-tag)
12792 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12793 (save-excursion
12794 (org-back-to-heading)
12795 (if (org-entry-get nil "ORDERED")
12796 (progn
12797 (org-delete-property "ORDERED")
12798 (and tag (org-toggle-tag tag 'off))
12799 (message "Subtasks can be completed in arbitrary order"))
12800 (org-entry-put nil "ORDERED" "t")
12801 (and tag (org-toggle-tag tag 'on))
12802 (message "Subtasks must be completed in sequence")))))
12804 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12805 (defun org-block-todo-from-checkboxes (change-plist)
12806 "Block turning an entry into a TODO, using checkboxes.
12807 This checks whether the current task should be blocked from state
12808 changes because there are unchecked boxes in this entry."
12809 (if (not org-enforce-todo-checkbox-dependencies)
12810 t ; if locally turned off don't block
12811 (catch 'dont-block
12812 ;; If this is not a todo state change, or if this entry is already DONE,
12813 ;; do not block
12814 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12815 (member (plist-get change-plist :from)
12816 (cons 'done org-done-keywords))
12817 (member (plist-get change-plist :to)
12818 (cons 'todo org-not-done-keywords))
12819 (not (plist-get change-plist :to)))
12820 (throw 'dont-block t))
12821 ;; If this task has checkboxes that are not checked, it's blocked
12822 (save-excursion
12823 (org-back-to-heading t)
12824 (let ((beg (point)) end)
12825 (outline-next-heading)
12826 (setq end (point))
12827 (goto-char beg)
12828 (if (org-list-search-forward
12829 (concat (org-item-beginning-re)
12830 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12831 "\\[[- ]\\]")
12832 end t)
12833 (progn
12834 (if (boundp 'org-blocked-by-checkboxes)
12835 (setq org-blocked-by-checkboxes t))
12836 (throw 'dont-block nil)))))
12837 t))) ; do not block
12839 (defun org-entry-blocked-p ()
12840 "Is the current entry blocked?"
12841 (org-with-silent-modifications
12842 (if (org-entry-get nil "NOBLOCKING")
12843 nil ;; Never block this entry
12844 (not (run-hook-with-args-until-failure
12845 'org-blocker-hook
12846 (list :type 'todo-state-change
12847 :position (point)
12848 :from 'todo
12849 :to 'done))))))
12851 (defun org-update-statistics-cookies (all)
12852 "Update the statistics cookie, either from TODO or from checkboxes.
12853 This should be called with the cursor in a line with a statistics cookie."
12854 (interactive "P")
12855 (if all
12856 (progn
12857 (org-update-checkbox-count 'all)
12858 (org-map-entries 'org-update-parent-todo-statistics))
12859 (if (not (org-at-heading-p))
12860 (org-update-checkbox-count)
12861 (let ((pos (point-marker))
12862 end l1 l2)
12863 (ignore-errors (org-back-to-heading t))
12864 (if (not (org-at-heading-p))
12865 (org-update-checkbox-count)
12866 (setq l1 (org-outline-level))
12867 (setq end (save-excursion
12868 (outline-next-heading)
12869 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12870 (point)))
12871 (if (and (save-excursion
12872 (re-search-forward
12873 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12874 (not (save-excursion (re-search-forward
12875 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12876 (org-update-checkbox-count)
12877 (if (and l2 (> l2 l1))
12878 (progn
12879 (goto-char end)
12880 (org-update-parent-todo-statistics))
12881 (goto-char pos)
12882 (beginning-of-line 1)
12883 (while (re-search-forward
12884 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12885 (point-at-eol) t)
12886 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12887 (goto-char pos)
12888 (move-marker pos nil)))))
12890 (defvar org-entry-property-inherited-from) ;; defined below
12891 (defun org-update-parent-todo-statistics ()
12892 "Update any statistics cookie in the parent of the current headline.
12893 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12894 the entire subtree and this will travel up the hierarchy and update
12895 statistics everywhere."
12896 (let* ((prop (save-excursion (org-up-heading-safe)
12897 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12898 (recursive (or (not org-hierarchical-todo-statistics)
12899 (and prop (string-match "\\<recursive\\>" prop))))
12900 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12902 (first t)
12903 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12904 level ltoggle l1 new ndel
12905 (cnt-all 0) (cnt-done 0) is-percent kwd
12906 checkbox-beg ov ovs ove cookie-present)
12907 (catch 'exit
12908 (save-excursion
12909 (beginning-of-line 1)
12910 (setq ltoggle (funcall outline-level))
12911 ;; Three situations are to consider:
12913 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12914 ;; to the top-level ancestor on the headline;
12916 ;; 2. If parent has "recursive" property, repeat up to the
12917 ;; headline setting that property, taking inheritance into
12918 ;; account;
12920 ;; 3. Else, move up to direct parent and proceed only once.
12921 (while (and (setq level (org-up-heading-safe))
12922 (or recursive first)
12923 (>= (point) lim))
12924 (setq first nil cookie-present nil)
12925 (unless (and level
12926 (not (string-match
12927 "\\<checkbox\\>"
12928 (downcase (or (org-entry-get nil "COOKIE_DATA")
12929 "")))))
12930 (throw 'exit nil))
12931 (while (re-search-forward box-re (point-at-eol) t)
12932 (setq cnt-all 0 cnt-done 0 cookie-present t)
12933 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12934 (save-match-data
12935 (unless (outline-next-heading) (throw 'exit nil))
12936 (while (and (looking-at org-complex-heading-regexp)
12937 (> (setq l1 (length (match-string 1))) level))
12938 (setq kwd (and (or recursive (= l1 ltoggle))
12939 (match-string 2)))
12940 (if (or (eq org-provide-todo-statistics 'all-headlines)
12941 (and (eq org-provide-todo-statistics t)
12942 (or (member kwd org-done-keywords)))
12943 (and (listp org-provide-todo-statistics)
12944 (stringp (car org-provide-todo-statistics))
12945 (or (member kwd org-provide-todo-statistics)
12946 (member kwd org-done-keywords)))
12947 (and (listp org-provide-todo-statistics)
12948 (listp (car org-provide-todo-statistics))
12949 (or (member kwd (car org-provide-todo-statistics))
12950 (and (member kwd org-done-keywords)
12951 (member kwd (cadr org-provide-todo-statistics))))))
12952 (setq cnt-all (1+ cnt-all))
12953 (if (eq org-provide-todo-statistics t)
12954 (and kwd (setq cnt-all (1+ cnt-all)))))
12955 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12956 (member kwd org-done-keywords))
12957 (and (listp org-provide-todo-statistics)
12958 (listp (car org-provide-todo-statistics))
12959 (member kwd org-done-keywords)
12960 (member kwd (cadr org-provide-todo-statistics)))
12961 (and (listp org-provide-todo-statistics)
12962 (stringp (car org-provide-todo-statistics))
12963 (member kwd org-done-keywords)))
12964 (setq cnt-done (1+ cnt-done)))
12965 (outline-next-heading)))
12966 (setq new
12967 (if is-percent
12968 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12969 (format "[%d/%d]" cnt-done cnt-all))
12970 ndel (- (match-end 0) checkbox-beg))
12971 ;; handle overlays when updating cookie from column view
12972 (when (setq ov (car (overlays-at checkbox-beg)))
12973 (setq ovs (overlay-start ov) ove (overlay-end ov))
12974 (delete-overlay ov))
12975 (goto-char checkbox-beg)
12976 (insert new)
12977 (delete-region (point) (+ (point) ndel))
12978 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12979 (when ov (move-overlay ov ovs ove)))
12980 (when cookie-present
12981 (run-hook-with-args 'org-after-todo-statistics-hook
12982 cnt-done (- cnt-all cnt-done))))))
12983 (run-hooks 'org-todo-statistics-hook)))
12985 (defvar org-after-todo-statistics-hook nil
12986 "Hook that is called after a TODO statistics cookie has been updated.
12987 Each function is called with two arguments: the number of not-done entries
12988 and the number of done entries.
12990 For example, the following function, when added to this hook, will switch
12991 an entry to DONE when all children are done, and back to TODO when new
12992 entries are set to a TODO status. Note that this hook is only called
12993 when there is a statistics cookie in the headline!
12995 (defun org-summary-todo (n-done n-not-done)
12996 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12997 (let (org-log-done org-log-states) ; turn off logging
12998 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13001 (defvar org-todo-statistics-hook nil
13002 "Hook that is run whenever Org thinks TODO statistics should be updated.
13003 This hook runs even if there is no statistics cookie present, in which case
13004 `org-after-todo-statistics-hook' would not run.")
13006 (defun org-todo-trigger-tag-changes (state)
13007 "Apply the changes defined in `org-todo-state-tags-triggers'."
13008 (let ((l org-todo-state-tags-triggers)
13009 changes)
13010 (when (or (not state) (equal state ""))
13011 (setq changes (append changes (cdr (assoc "" l)))))
13012 (when (and (stringp state) (> (length state) 0))
13013 (setq changes (append changes (cdr (assoc state l)))))
13014 (when (member state org-not-done-keywords)
13015 (setq changes (append changes (cdr (assoc 'todo l)))))
13016 (when (member state org-done-keywords)
13017 (setq changes (append changes (cdr (assoc 'done l)))))
13018 (dolist (c changes)
13019 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13021 (defun org-local-logging (value)
13022 "Get logging settings from a property VALUE."
13023 (let* (words w a)
13024 ;; directly set the variables, they are already local.
13025 (setq org-log-done nil
13026 org-log-repeat nil
13027 org-todo-log-states nil)
13028 (setq words (org-split-string value))
13029 (while (setq w (pop words))
13030 (cond
13031 ((setq a (assoc w org-startup-options))
13032 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13033 (set (nth 1 a) (nth 2 a))))
13034 ((setq a (org-extract-log-state-settings w))
13035 (and (member (car a) org-todo-keywords-1)
13036 (push a org-todo-log-states)))))))
13038 (defun org-get-todo-sequence-head (kwd)
13039 "Return the head of the TODO sequence to which KWD belongs.
13040 If KWD is not set, check if there is a text property remembering the
13041 right sequence."
13042 (let (p)
13043 (cond
13044 ((not kwd)
13045 (or (get-text-property (point-at-bol) 'org-todo-head)
13046 (progn
13047 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13048 nil (point-at-eol)))
13049 (get-text-property p 'org-todo-head))))
13050 ((not (member kwd org-todo-keywords-1))
13051 (car org-todo-keywords-1))
13052 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13054 (defun org-fast-todo-selection ()
13055 "Fast TODO keyword selection with single keys.
13056 Returns the new TODO keyword, or nil if no state change should occur."
13057 (let* ((fulltable org-todo-key-alist)
13058 (done-keywords org-done-keywords) ;; needed for the faces.
13059 (maxlen (apply 'max (mapcar
13060 (lambda (x)
13061 (if (stringp (car x)) (string-width (car x)) 0))
13062 fulltable)))
13063 (expert nil)
13064 (fwidth (+ maxlen 3 1 3))
13065 (ncol (/ (- (window-width) 4) fwidth))
13066 tg cnt e c tbl
13067 groups ingroup)
13068 (save-excursion
13069 (save-window-excursion
13070 (if expert
13071 (set-buffer (get-buffer-create " *Org todo*"))
13072 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13073 (erase-buffer)
13074 (org-set-local 'org-done-keywords done-keywords)
13075 (setq tbl fulltable cnt 0)
13076 (while (setq e (pop tbl))
13077 (cond
13078 ((equal e '(:startgroup))
13079 (push '() groups) (setq ingroup t)
13080 (when (not (= cnt 0))
13081 (setq cnt 0)
13082 (insert "\n"))
13083 (insert "{ "))
13084 ((equal e '(:endgroup))
13085 (setq ingroup nil cnt 0)
13086 (insert "}\n"))
13087 ((equal e '(:newline))
13088 (when (not (= cnt 0))
13089 (setq cnt 0)
13090 (insert "\n")
13091 (setq e (car tbl))
13092 (while (equal (car tbl) '(:newline))
13093 (insert "\n")
13094 (setq tbl (cdr tbl)))))
13096 (setq tg (car e) c (cdr e))
13097 (if ingroup (push tg (car groups)))
13098 (setq tg (org-add-props tg nil 'face
13099 (org-get-todo-face tg)))
13100 (if (and (= cnt 0) (not ingroup)) (insert " "))
13101 (insert "[" c "] " tg (make-string
13102 (- fwidth 4 (length tg)) ?\ ))
13103 (when (= (setq cnt (1+ cnt)) ncol)
13104 (insert "\n")
13105 (if ingroup (insert " "))
13106 (setq cnt 0)))))
13107 (insert "\n")
13108 (goto-char (point-min))
13109 (if (not expert) (org-fit-window-to-buffer))
13110 (message "[a-z..]:Set [SPC]:clear")
13111 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13112 (cond
13113 ((or (= c ?\C-g)
13114 (and (= c ?q) (not (rassoc c fulltable))))
13115 (setq quit-flag t))
13116 ((= c ?\ ) nil)
13117 ((setq e (rassoc c fulltable) tg (car e))
13119 (t (setq quit-flag t)))))))
13121 (defun org-entry-is-todo-p ()
13122 (member (org-get-todo-state) org-not-done-keywords))
13124 (defun org-entry-is-done-p ()
13125 (member (org-get-todo-state) org-done-keywords))
13127 (defun org-get-todo-state ()
13128 "Return the TODO keyword of the current subtree."
13129 (save-excursion
13130 (org-back-to-heading t)
13131 (and (looking-at org-todo-line-regexp)
13132 (match-end 2)
13133 (match-string 2))))
13135 (defun org-at-date-range-p (&optional inactive-ok)
13136 "Is the cursor inside a date range?"
13137 (interactive)
13138 (save-excursion
13139 (catch 'exit
13140 (let ((pos (point)))
13141 (skip-chars-backward "^[<\r\n")
13142 (skip-chars-backward "<[")
13143 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13144 (>= (match-end 0) pos)
13145 (throw 'exit t))
13146 (skip-chars-backward "^<[\r\n")
13147 (skip-chars-backward "<[")
13148 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13149 (>= (match-end 0) pos)
13150 (throw 'exit t)))
13151 nil)))
13153 (defun org-get-repeat (&optional tagline)
13154 "Check if there is a deadline/schedule with repeater in this entry."
13155 (save-match-data
13156 (save-excursion
13157 (org-back-to-heading t)
13158 (and (re-search-forward (if tagline
13159 (concat tagline "\\s-*" org-repeat-re)
13160 org-repeat-re)
13161 (org-entry-end-position) t)
13162 (match-string-no-properties 1)))))
13164 (defvar org-last-changed-timestamp)
13165 (defvar org-last-inserted-timestamp)
13166 (defvar org-log-post-message)
13167 (defvar org-log-note-purpose)
13168 (defvar org-log-note-how nil)
13169 (defvar org-log-note-extra)
13170 (defun org-auto-repeat-maybe (done-word)
13171 "Check if the current headline contains a repeated deadline/schedule.
13172 If yes, set TODO state back to what it was and change the base date
13173 of repeating deadline/scheduled time stamps to new date.
13174 This function is run automatically after each state change to a DONE state."
13175 ;; last-state is dynamically scoped into this function
13176 (let* ((repeat (org-get-repeat))
13177 (aa (assoc org-last-state org-todo-kwd-alist))
13178 (interpret (nth 1 aa))
13179 (head (nth 2 aa))
13180 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13181 (msg "Entry repeats: ")
13182 (org-log-done nil)
13183 (org-todo-log-states nil)
13184 re type n what ts time to-state)
13185 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13186 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13187 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13188 org-todo-repeat-to-state))
13189 (unless (and to-state (member to-state org-todo-keywords-1))
13190 (setq to-state (if (eq interpret 'type) org-last-state head)))
13191 (org-todo to-state)
13192 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13193 (org-entry-put nil "LAST_REPEAT" (format-time-string
13194 (org-time-stamp-format t t))))
13195 (when org-log-repeat
13196 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13197 (memq 'org-add-log-note post-command-hook))
13198 ;; OK, we are already setup for some record
13199 (if (eq org-log-repeat 'note)
13200 ;; make sure we take a note, not only a time stamp
13201 (setq org-log-note-how 'note))
13202 ;; Set up for taking a record
13203 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13204 org-last-state
13205 'findpos org-log-repeat)))
13206 (org-back-to-heading t)
13207 (org-add-planning-info nil nil 'closed)
13208 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13209 org-deadline-time-regexp "\\)\\|\\("
13210 org-ts-regexp "\\)"))
13211 (while (re-search-forward
13212 re (save-excursion (outline-next-heading) (point)) t)
13213 (setq type (if (match-end 1) org-scheduled-string
13214 (if (match-end 3) org-deadline-string "Plain:"))
13215 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13216 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13217 (setq n (string-to-number (match-string 2 ts))
13218 what (match-string 3 ts))
13219 (if (equal what "w") (setq n (* n 7) what "d"))
13220 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13221 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13222 ;; Preparation, see if we need to modify the start date for the change
13223 (when (match-end 1)
13224 (setq time (save-match-data (org-time-string-to-time ts)))
13225 (cond
13226 ((equal (match-string 1 ts) ".")
13227 ;; Shift starting date to today
13228 (org-timestamp-change
13229 (- (org-today) (time-to-days time))
13230 'day))
13231 ((equal (match-string 1 ts) "+")
13232 (let ((nshiftmax 10) (nshift 0))
13233 (while (or (= nshift 0)
13234 (<= (time-to-days time)
13235 (time-to-days (current-time))))
13236 (when (= (incf nshift) nshiftmax)
13237 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13238 (user-error "Abort")))
13239 (org-timestamp-change n (cdr (assoc what whata)))
13240 (org-at-timestamp-p t)
13241 (setq ts (match-string 1))
13242 (setq time (save-match-data (org-time-string-to-time ts)))))
13243 (org-timestamp-change (- n) (cdr (assoc what whata)))
13244 ;; rematch, so that we have everything in place for the real shift
13245 (org-at-timestamp-p t)
13246 (setq ts (match-string 1))
13247 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13248 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13249 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13250 (setq org-log-post-message msg)
13251 (message "%s" msg))))
13253 (defun org-show-todo-tree (arg)
13254 "Make a compact tree which shows all headlines marked with TODO.
13255 The tree will show the lines where the regexp matches, and all higher
13256 headlines above the match.
13257 With a \\[universal-argument] prefix, prompt for a regexp to match.
13258 With a numeric prefix N, construct a sparse tree for the Nth element
13259 of `org-todo-keywords-1'."
13260 (interactive "P")
13261 (let ((case-fold-search nil)
13262 (kwd-re
13263 (cond ((null arg) org-not-done-regexp)
13264 ((equal arg '(4))
13265 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13266 (mapcar 'list org-todo-keywords-1))))
13267 (concat "\\("
13268 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13269 "\\)\\>")))
13270 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13271 (regexp-quote (nth (1- (prefix-numeric-value arg))
13272 org-todo-keywords-1)))
13273 (t (user-error "Invalid prefix argument: %s" arg)))))
13274 (message "%d TODO entries found"
13275 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13277 (defun org-deadline (arg &optional time)
13278 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13279 With one universal prefix argument, remove any deadline from the item.
13280 With two universal prefix arguments, prompt for a warning delay.
13281 With argument TIME, set the deadline at the corresponding date. TIME
13282 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13283 (interactive "P")
13284 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13285 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13286 'region-start-level 'region))
13287 org-loop-over-headlines-in-active-region)
13288 (org-map-entries
13289 `(org-deadline ',arg ,time)
13290 org-loop-over-headlines-in-active-region
13291 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13292 (let* ((old-date (org-entry-get nil "DEADLINE"))
13293 (old-date-time (if old-date (org-time-string-to-time old-date)))
13294 (repeater (and old-date
13295 (string-match
13296 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13297 old-date)
13298 (match-string 1 old-date))))
13299 (cond
13300 ((equal arg '(4))
13301 (when (and old-date org-log-redeadline)
13302 (org-add-log-setup 'deldeadline nil old-date 'findpos
13303 org-log-redeadline))
13304 (org-remove-timestamp-with-keyword org-deadline-string)
13305 (message "Item no longer has a deadline."))
13306 ((equal arg '(16))
13307 (save-excursion
13308 (org-back-to-heading t)
13309 (if (re-search-forward
13310 org-deadline-time-regexp
13311 (save-excursion (outline-next-heading) (point)) t)
13312 (let* ((rpl0 (match-string 1))
13313 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13314 (replace-match
13315 (concat org-deadline-string
13316 " <" rpl
13317 (format " -%dd"
13318 (abs
13319 (- (time-to-days
13320 (save-match-data
13321 (org-read-date nil t nil "Warn starting from" old-date-time)))
13322 (time-to-days old-date-time))))
13323 ">") t t))
13324 (user-error "No deadline information to update"))))
13326 (org-add-planning-info 'deadline time 'closed)
13327 (when (and old-date org-log-redeadline
13328 (not (equal old-date
13329 (substring org-last-inserted-timestamp 1 -1))))
13330 (org-add-log-setup 'redeadline nil old-date 'findpos
13331 org-log-redeadline))
13332 (when repeater
13333 (save-excursion
13334 (org-back-to-heading t)
13335 (when (re-search-forward (concat org-deadline-string " "
13336 org-last-inserted-timestamp)
13337 (save-excursion
13338 (outline-next-heading) (point)) t)
13339 (goto-char (1- (match-end 0)))
13340 (insert " " repeater)
13341 (setq org-last-inserted-timestamp
13342 (concat (substring org-last-inserted-timestamp 0 -1)
13343 " " repeater
13344 (substring org-last-inserted-timestamp -1))))))
13345 (message "Deadline on %s" org-last-inserted-timestamp))))))
13347 (defun org-schedule (arg &optional time)
13348 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13349 With one universal prefix argument, remove any scheduling date from the item.
13350 With two universal prefix arguments, prompt for a delay cookie.
13351 With argument TIME, scheduled at the corresponding date. TIME can
13352 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13353 (interactive "P")
13354 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13355 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13356 'region-start-level 'region))
13357 org-loop-over-headlines-in-active-region)
13358 (org-map-entries
13359 `(org-schedule ',arg ,time)
13360 org-loop-over-headlines-in-active-region
13361 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13362 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13363 (old-date-time (if old-date (org-time-string-to-time old-date)))
13364 (repeater (and old-date
13365 (string-match
13366 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13367 old-date)
13368 (match-string 1 old-date))))
13369 (cond
13370 ((equal arg '(4))
13371 (progn
13372 (when (and old-date org-log-reschedule)
13373 (org-add-log-setup 'delschedule nil old-date 'findpos
13374 org-log-reschedule))
13375 (org-remove-timestamp-with-keyword org-scheduled-string)
13376 (message "Item is no longer scheduled.")))
13377 ((equal arg '(16))
13378 (save-excursion
13379 (org-back-to-heading t)
13380 (if (re-search-forward
13381 org-scheduled-time-regexp
13382 (save-excursion (outline-next-heading) (point)) t)
13383 (let* ((rpl0 (match-string 1))
13384 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13385 (replace-match
13386 (concat org-scheduled-string
13387 " <" rpl
13388 (format " -%dd"
13389 (abs
13390 (- (time-to-days
13391 (save-match-data
13392 (org-read-date nil t nil "Delay until" old-date-time)))
13393 (time-to-days old-date-time))))
13394 ">") t t))
13395 (user-error "No scheduled information to update"))))
13397 (org-add-planning-info 'scheduled time 'closed)
13398 (when (and old-date org-log-reschedule
13399 (not (equal old-date
13400 (substring org-last-inserted-timestamp 1 -1))))
13401 (org-add-log-setup 'reschedule nil old-date 'findpos
13402 org-log-reschedule))
13403 (when repeater
13404 (save-excursion
13405 (org-back-to-heading t)
13406 (when (re-search-forward (concat org-scheduled-string " "
13407 org-last-inserted-timestamp)
13408 (save-excursion
13409 (outline-next-heading) (point)) t)
13410 (goto-char (1- (match-end 0)))
13411 (insert " " repeater)
13412 (setq org-last-inserted-timestamp
13413 (concat (substring org-last-inserted-timestamp 0 -1)
13414 " " repeater
13415 (substring org-last-inserted-timestamp -1))))))
13416 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13418 (defun org-get-scheduled-time (pom &optional inherit)
13419 "Get the scheduled time as a time tuple, of a format suitable
13420 for calling org-schedule with, or if there is no scheduling,
13421 returns nil."
13422 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13423 (when time
13424 (apply 'encode-time (org-parse-time-string time)))))
13426 (defun org-get-deadline-time (pom &optional inherit)
13427 "Get the deadline as a time tuple, of a format suitable for
13428 calling org-deadline with, or if there is no scheduling, returns
13429 nil."
13430 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13431 (when time
13432 (apply 'encode-time (org-parse-time-string time)))))
13434 (defun org-remove-timestamp-with-keyword (keyword)
13435 "Remove all time stamps with KEYWORD in the current entry."
13436 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13437 beg)
13438 (save-excursion
13439 (org-back-to-heading t)
13440 (setq beg (point))
13441 (outline-next-heading)
13442 (while (re-search-backward re beg t)
13443 (replace-match "")
13444 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13445 (equal (char-before) ?\ ))
13446 (backward-delete-char 1)
13447 (if (string-match "^[ \t]*$" (buffer-substring
13448 (point-at-bol) (point-at-eol)))
13449 (delete-region (point-at-bol)
13450 (min (point-max) (1+ (point-at-eol))))))))))
13452 (defvar org-time-was-given) ; dynamically scoped parameter
13453 (defvar org-end-time-was-given) ; dynamically scoped parameter
13455 (defun org-at-planning-p ()
13456 "Non-nil when point is on a planning info line."
13457 ;; This is as accurate and faster than `org-element-at-point' since
13458 ;; planning info location is fixed in the section.
13459 (org-with-wide-buffer
13460 (beginning-of-line)
13461 (and (org-looking-at-p org-planning-line-re)
13462 (eq (point)
13463 (ignore-errors
13464 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13465 (org-back-to-heading t)
13466 (org-with-limited-levels (org-back-to-heading t)))
13467 (line-beginning-position 2))))))
13469 (defun org-add-planning-info (what &optional time &rest remove)
13470 "Insert new timestamp with keyword in the planning line.
13471 WHAT indicates what kind of time stamp to add. It is a symbol
13472 among `closed', `deadline', `scheduled' and nil. TIME indicates
13473 the time to use. If none is given, the user is prompted for
13474 a date. REMOVE indicates what kind of entries to remove. An old
13475 WHAT entry will also be removed."
13476 (let (org-time-was-given org-end-time-was-given default-time default-input)
13477 (catch 'exit
13478 (when (and (memq what '(scheduled deadline))
13479 (or (not time)
13480 (and (stringp time)
13481 (string-match "^[-+]+[0-9]" time))))
13482 ;; Try to get a default date/time from existing timestamp
13483 (save-excursion
13484 (org-back-to-heading t)
13485 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13486 (when (re-search-forward (if (eq what 'scheduled)
13487 org-scheduled-time-regexp
13488 org-deadline-time-regexp)
13489 end t)
13490 (setq ts (match-string 1)
13491 default-time (apply 'encode-time (org-parse-time-string ts))
13492 default-input (and ts (org-get-compact-tod ts)))))))
13493 (when what
13494 (setq time
13495 (if (stringp time)
13496 ;; This is a string (relative or absolute), set
13497 ;; proper date.
13498 (apply #'encode-time
13499 (org-read-date-analyze
13500 time default-time (decode-time default-time)))
13501 ;; If necessary, get the time from the user
13502 (or time (org-read-date nil 'to-time nil nil
13503 default-time default-input)))))
13505 (org-with-wide-buffer
13506 (org-back-to-heading t)
13507 (forward-line)
13508 (unless (bolp) (insert "\n"))
13509 (cond ((org-looking-at-p org-planning-line-re)
13510 ;; Move to current indentation.
13511 (skip-chars-forward " \t")
13512 ;; Check if we have to remove something.
13513 (dolist (type (if what (cons what remove) remove))
13514 (save-excursion
13515 (when (re-search-forward
13516 (concat
13517 " *"
13518 (case type
13519 (closed org-closed-time-regexp)
13520 (deadline org-deadline-time-regexp)
13521 (scheduled org-scheduled-time-regexp)
13522 (otherwise
13523 (error "Invalid planning type: %s" type))))
13524 (line-end-position) t)
13525 (replace-match "")
13526 (when (looking-at "--+<[^>]+>") (replace-match ""))
13527 (when (and (not what) (eq type 'closed))
13528 (save-excursion
13529 (beginning-of-line)
13530 (when (looking-at "[ \t]*$")
13531 (delete-region (point)
13532 (line-beginning-position 2)))))))
13533 ;; Remove leading white spaces.
13534 (when (looking-at "[ \t]+") (replace-match ""))))
13535 ((not what) (throw 'exit nil)) ; Nothing to do.
13536 (t (insert-before-markers "\n")
13537 (backward-char 1)
13538 (when org-adapt-indentation
13539 (org-indent-to-column (1+ (org-outline-level))))))
13540 (when what
13541 ;; Insert planning keyword.
13542 (insert (case what
13543 (closed org-closed-string)
13544 (deadline org-deadline-string)
13545 (scheduled org-scheduled-string)
13546 (otherwise (error "Invalid planning type: %s" what)))
13547 " ")
13548 ;; Insert associated timestamp.
13549 (let ((ts (org-insert-time-stamp
13550 time
13551 (or org-time-was-given
13552 (and (eq what 'closed) org-log-done-with-time))
13553 (eq what 'closed)
13554 nil nil (list org-end-time-was-given))))
13555 (unless (eolp) (insert " "))
13556 ts))))))
13558 (defvar org-log-note-marker (make-marker))
13559 (defvar org-log-note-purpose nil)
13560 (defvar org-log-note-state nil)
13561 (defvar org-log-note-previous-state nil)
13562 (defvar org-log-note-extra nil)
13563 (defvar org-log-note-window-configuration nil)
13564 (defvar org-log-note-return-to (make-marker))
13565 (defvar org-log-note-effective-time nil
13566 "Remembered current time so that dynamically scoped
13567 `org-extend-today-until' affects tha timestamps in state change
13568 log")
13570 (defvar org-log-post-message nil
13571 "Message to be displayed after a log note has been stored.
13572 The auto-repeater uses this.")
13574 (defun org-add-note ()
13575 "Add a note to the current entry.
13576 This is done in the same way as adding a state change note."
13577 (interactive)
13578 (org-add-log-setup 'note nil nil 'findpos nil))
13580 (defun org-log-beginning (&optional create)
13581 "Return expected start of log notes in current entry.
13582 When optional argument CREATE is non-nil, the function creates
13583 a drawer to store notes, if necessary. Returned position ignores
13584 narrowing."
13585 (org-with-wide-buffer
13586 (org-end-of-meta-data)
13587 (let ((end (if (org-at-heading-p) (point)
13588 (save-excursion (outline-next-heading) (point))))
13589 (drawer (org-log-into-drawer)))
13590 (cond
13591 (drawer
13592 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13593 (case-fold-search t))
13594 (catch 'exit
13595 ;; Try to find existing drawer.
13596 (while (re-search-forward regexp end t)
13597 (let ((element (org-element-at-point)))
13598 (when (eq (org-element-type element) 'drawer)
13599 (let ((cend (org-element-property :contents-end element)))
13600 (when (and (not org-log-states-order-reversed) cend)
13601 (goto-char cend)))
13602 (throw 'exit nil))))
13603 ;; No drawer found. Create one, if permitted.
13604 (when create
13605 (unless (bolp) (insert "\n"))
13606 (let ((beg (point)))
13607 (insert ":" drawer ":\n:END:\n")
13608 (org-indent-region beg (point)))
13609 (end-of-line -1)))))
13610 (org-log-state-notes-insert-after-drawers
13611 (while (and (looking-at org-drawer-regexp)
13612 (progn (goto-char (match-end 0))
13613 (re-search-forward org-property-end-re end t)))
13614 (forward-line)))))
13615 (if (bolp) (point) (line-beginning-position 2))))
13617 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13618 "Set up the post command hook to take a note.
13619 If this is about to TODO state change, the new state is expected in STATE.
13620 When FINDPOS is non-nil, find the correct position for the note in
13621 the current entry. If not, assume that it can be inserted at point.
13622 HOW is an indicator what kind of note should be created.
13623 EXTRA is additional text that will be inserted into the notes buffer."
13624 (org-with-wide-buffer
13625 (when findpos
13626 (goto-char (org-log-beginning t))
13627 (unless org-log-states-order-reversed
13628 (org-skip-over-state-notes)
13629 (skip-chars-backward " \t\n\r")
13630 (forward-line)))
13631 (move-marker org-log-note-marker (point))
13632 ;; Preserve position even if a property drawer is inserted in the
13633 ;; process.
13634 (set-marker-insertion-type org-log-note-marker t)
13635 (setq org-log-note-purpose purpose
13636 org-log-note-state state
13637 org-log-note-previous-state prev-state
13638 org-log-note-how how
13639 org-log-note-extra extra
13640 org-log-note-effective-time (org-current-effective-time))
13641 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13643 (defun org-skip-over-state-notes ()
13644 "Skip past the list of State notes in an entry."
13645 (when (ignore-errors (goto-char (org-in-item-p)))
13646 (let* ((struct (org-list-struct))
13647 (prevs (org-list-prevs-alist struct))
13648 (regexp
13649 (concat "[ \t]*- +"
13650 (replace-regexp-in-string
13651 " +" " +"
13652 (org-replace-escapes
13653 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13654 `(("%d" . ,org-ts-regexp-inactive)
13655 ("%D" . ,org-ts-regexp)
13656 ("%s" . "\"\\S-+\"")
13657 ("%S" . "\"\\S-+\"")
13658 ("%t" . ,org-ts-regexp-inactive)
13659 ("%T" . ,org-ts-regexp)
13660 ("%u" . ".*?")
13661 ("%U" . ".*?")))))))
13662 (while (org-looking-at-p regexp)
13663 (goto-char (or (org-list-get-next-item (point) struct prevs)
13664 (org-list-get-item-end (point) struct)))))))
13666 (defun org-add-log-note (&optional purpose)
13667 "Pop up a window for taking a note, and add this note later at point."
13668 (remove-hook 'post-command-hook 'org-add-log-note)
13669 (setq org-log-note-window-configuration (current-window-configuration))
13670 (delete-other-windows)
13671 (move-marker org-log-note-return-to (point))
13672 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13673 (goto-char org-log-note-marker)
13674 (org-switch-to-buffer-other-window "*Org Note*")
13675 (erase-buffer)
13676 (if (memq org-log-note-how '(time state))
13677 (let (current-prefix-arg) (org-store-log-note))
13678 (let ((org-inhibit-startup t)) (org-mode))
13679 (insert (format "# Insert note for %s.
13680 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13681 (cond
13682 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13683 ((eq org-log-note-purpose 'done) "closed todo item")
13684 ((eq org-log-note-purpose 'state)
13685 (format "state change from \"%s\" to \"%s\""
13686 (or org-log-note-previous-state "")
13687 (or org-log-note-state "")))
13688 ((eq org-log-note-purpose 'reschedule)
13689 "rescheduling")
13690 ((eq org-log-note-purpose 'delschedule)
13691 "no longer scheduled")
13692 ((eq org-log-note-purpose 'redeadline)
13693 "changing deadline")
13694 ((eq org-log-note-purpose 'deldeadline)
13695 "removing deadline")
13696 ((eq org-log-note-purpose 'refile)
13697 "refiling")
13698 ((eq org-log-note-purpose 'note)
13699 "this entry")
13700 (t (error "This should not happen")))))
13701 (if org-log-note-extra (insert org-log-note-extra))
13702 (org-set-local 'org-finish-function 'org-store-log-note)
13703 (run-hooks 'org-log-buffer-setup-hook)))
13705 (defvar org-note-abort nil) ; dynamically scoped
13706 (defun org-store-log-note ()
13707 "Finish taking a log note, and insert it to where it belongs."
13708 (let ((txt (buffer-string)))
13709 (kill-buffer (current-buffer))
13710 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13711 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13712 (setq txt (replace-match "" t t txt)))
13713 (if (string-match "\\s-+\\'" txt)
13714 (setq txt (replace-match "" t t txt)))
13715 (setq lines (org-split-string txt "\n"))
13716 (when (and note (string-match "\\S-" note))
13717 (setq note
13718 (org-replace-escapes
13719 note
13720 (list (cons "%u" (user-login-name))
13721 (cons "%U" user-full-name)
13722 (cons "%t" (format-time-string
13723 (org-time-stamp-format 'long 'inactive)
13724 org-log-note-effective-time))
13725 (cons "%T" (format-time-string
13726 (org-time-stamp-format 'long nil)
13727 org-log-note-effective-time))
13728 (cons "%d" (format-time-string
13729 (org-time-stamp-format nil 'inactive)
13730 org-log-note-effective-time))
13731 (cons "%D" (format-time-string
13732 (org-time-stamp-format nil nil)
13733 org-log-note-effective-time))
13734 (cons "%s" (cond
13735 ((not org-log-note-state) "")
13736 ((org-string-match-p org-ts-regexp
13737 org-log-note-state)
13738 (format "\"[%s]\""
13739 (substring org-log-note-state 1 -1)))
13740 (t (format "\"%s\"" org-log-note-state))))
13741 (cons "%S"
13742 (cond
13743 ((not org-log-note-previous-state) "")
13744 ((org-string-match-p org-ts-regexp
13745 org-log-note-previous-state)
13746 (format "\"[%s]\""
13747 (substring
13748 org-log-note-previous-state 1 -1)))
13749 (t (format "\"%s\""
13750 org-log-note-previous-state)))))))
13751 (when lines (setq note (concat note " \\\\")))
13752 (push note lines))
13753 (when (or current-prefix-arg org-note-abort)
13754 (when (org-log-into-drawer)
13755 (org-remove-empty-drawer-at org-log-note-marker))
13756 (setq lines nil))
13757 (when lines
13758 (with-current-buffer (marker-buffer org-log-note-marker)
13759 (org-with-wide-buffer
13760 (goto-char org-log-note-marker)
13761 (move-marker org-log-note-marker nil)
13762 ;; Make sure point is at the beginning of an empty line.
13763 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13764 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13765 ;; In an existing list, add a new item at the top level.
13766 ;; Otherwise, indent line like a regular one.
13767 (let ((itemp (org-in-item-p)))
13768 (if itemp
13769 (org-indent-line-to
13770 (let ((struct (save-excursion
13771 (goto-char itemp) (org-list-struct))))
13772 (org-list-get-ind (org-list-get-top-point struct) struct)))
13773 (org-indent-line)))
13774 (insert (org-list-bullet-string "-") (pop lines))
13775 (let ((ind (org-list-item-body-column (line-beginning-position))))
13776 (dolist (line lines)
13777 (insert "\n")
13778 (org-indent-line-to ind)
13779 (insert line)))
13780 (message "Note stored")
13781 (org-back-to-heading t)
13782 (org-cycle-hide-drawers 'children))
13783 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13784 ;; from within `org-add-log-note' because `buffer-undo-list'
13785 ;; is then modified outside of `org-with-remote-undo'.
13786 (when (eq this-command 'org-agenda-todo)
13787 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13788 ;; Don't add undo information when called from `org-agenda-todo'
13789 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13790 (set-window-configuration org-log-note-window-configuration)
13791 (with-current-buffer (marker-buffer org-log-note-return-to)
13792 (goto-char org-log-note-return-to))
13793 (move-marker org-log-note-return-to nil)
13794 (and org-log-post-message (message "%s" org-log-post-message))))
13796 (defun org-remove-empty-drawer-at (pos)
13797 "Remove an empty drawer at position POS.
13798 POS may also be a marker."
13799 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13800 (org-with-wide-buffer
13801 (goto-char pos)
13802 (let ((drawer (org-element-at-point)))
13803 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13804 (not (org-element-property :contents-begin drawer)))
13805 (delete-region (org-element-property :begin drawer)
13806 (progn (goto-char (org-element-property :end drawer))
13807 (skip-chars-backward " \r\t\n")
13808 (forward-line)
13809 (point))))))))
13811 (defvar org-ts-type nil)
13812 (defun org-sparse-tree (&optional arg type)
13813 "Create a sparse tree, prompt for the details.
13814 This command can create sparse trees. You first need to select the type
13815 of match used to create the tree:
13817 t Show all TODO entries.
13818 T Show entries with a specific TODO keyword.
13819 m Show entries selected by a tags/property match.
13820 p Enter a property name and its value (both with completion on existing
13821 names/values) and show entries with that property.
13822 r Show entries matching a regular expression (`/' can be used as well).
13823 b Show deadlines and scheduled items before a date.
13824 a Show deadlines and scheduled items after a date.
13825 d Show deadlines due within `org-deadline-warning-days'.
13826 D Show deadlines and scheduled items between a date range."
13827 (interactive "P")
13828 (setq type (or type org-sparse-tree-default-date-type))
13829 (setq org-ts-type type)
13830 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13831 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13832 [c]ycle through date types: %s"
13833 (case type
13834 (all "all timestamps")
13835 (scheduled "only scheduled")
13836 (deadline "only deadline")
13837 (active "only active timestamps")
13838 (inactive "only inactive timestamps")
13839 (closed "with a closed time-stamp")
13840 (otherwise "scheduled/deadline")))
13841 (let ((answer (read-char-exclusive)))
13842 (case answer
13844 (org-sparse-tree
13846 (cadr
13847 (memq type '(nil all scheduled deadline active inactive closed)))))
13848 (?d (call-interactively 'org-check-deadlines))
13849 (?b (call-interactively 'org-check-before-date))
13850 (?a (call-interactively 'org-check-after-date))
13851 (?D (call-interactively 'org-check-dates-range))
13852 (?t (call-interactively 'org-show-todo-tree))
13853 (?T (org-show-todo-tree '(4)))
13854 (?m (call-interactively 'org-match-sparse-tree))
13855 ((?p ?P)
13856 (let* ((kwd (org-icompleting-read
13857 "Property: " (mapcar 'list (org-buffer-property-keys))))
13858 (value (org-icompleting-read
13859 "Value: " (mapcar 'list (org-property-values kwd)))))
13860 (unless (string-match "\\`{.*}\\'" value)
13861 (setq value (concat "\"" value "\"")))
13862 (org-match-sparse-tree arg (concat kwd "=" value))))
13863 ((?r ?R ?/) (call-interactively 'org-occur))
13864 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13866 (defvar org-occur-highlights nil
13867 "List of overlays used for occur matches.")
13868 (make-variable-buffer-local 'org-occur-highlights)
13869 (defvar org-occur-parameters nil
13870 "Parameters of the active org-occur calls.
13871 This is a list, each call to org-occur pushes as cons cell,
13872 containing the regular expression and the callback, onto the list.
13873 The list can contain several entries if `org-occur' has been called
13874 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13875 will only contain one set of parameters. When the highlights are
13876 removed (for example with `C-c C-c', or with the next edit (depending
13877 on `org-remove-highlights-with-change'), this variable is emptied
13878 as well.")
13879 (make-variable-buffer-local 'org-occur-parameters)
13881 (defun org-occur (regexp &optional keep-previous callback)
13882 "Make a compact tree which shows all matches of REGEXP.
13883 The tree will show the lines where the regexp matches, and all higher
13884 headlines above the match. It will also show the heading after the match,
13885 to make sure editing the matching entry is easy.
13886 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13887 call to `org-occur' will be kept, to allow stacking of calls to this
13888 command.
13889 If CALLBACK is non-nil, it is a function which is called to confirm
13890 that the match should indeed be shown."
13891 (interactive "sRegexp: \nP")
13892 (when (equal regexp "")
13893 (user-error "Regexp cannot be empty"))
13894 (unless keep-previous
13895 (org-remove-occur-highlights nil nil t))
13896 (push (cons regexp callback) org-occur-parameters)
13897 (let ((cnt 0))
13898 (save-excursion
13899 (goto-char (point-min))
13900 (if (or (not keep-previous) ; do not want to keep
13901 (not org-occur-highlights)) ; no previous matches
13902 ;; hide everything
13903 (org-overview))
13904 (while (re-search-forward regexp nil t)
13905 (when (or (not callback)
13906 (save-match-data (funcall callback)))
13907 (setq cnt (1+ cnt))
13908 (when org-highlight-sparse-tree-matches
13909 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13910 (org-show-context 'occur-tree))))
13911 (when org-remove-highlights-with-change
13912 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13913 nil 'local))
13914 (unless org-sparse-tree-open-archived-trees
13915 (org-hide-archived-subtrees (point-min) (point-max)))
13916 (run-hooks 'org-occur-hook)
13917 (if (org-called-interactively-p 'interactive)
13918 (message "%d match(es) for regexp %s" cnt regexp))
13919 cnt))
13921 (defun org-occur-next-match (&optional n reset)
13922 "Function for `next-error-function' to find sparse tree matches.
13923 N is the number of matches to move, when negative move backwards.
13924 RESET is entirely ignored - this function always goes back to the
13925 starting point when no match is found."
13926 (let* ((limit (if (< n 0) (point-min) (point-max)))
13927 (search-func (if (< n 0)
13928 'previous-single-char-property-change
13929 'next-single-char-property-change))
13930 (n (abs n))
13931 (pos (point))
13933 (catch 'exit
13934 (while (setq p1 (funcall search-func (point) 'org-type))
13935 (when (equal p1 limit)
13936 (goto-char pos)
13937 (user-error "No more matches"))
13938 (when (equal (get-char-property p1 'org-type) 'org-occur)
13939 (setq n (1- n))
13940 (when (= n 0)
13941 (goto-char p1)
13942 (throw 'exit (point))))
13943 (goto-char p1))
13944 (goto-char p1)
13945 (user-error "No more matches"))))
13947 (defun org-show-context (&optional key)
13948 "Make sure point and context are visible.
13949 Optional argument KEY, when non-nil, is a symbol. See
13950 `org-show-context-detail' for allowed values and how much is to
13951 be shown."
13952 (org-show-set-visibility
13953 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13954 ((cdr (assq key org-show-context-detail)))
13955 (t (cdr (assq 'default org-show-context-detail))))))
13957 (defun org-show-set-visibility (detail)
13958 "Set visibility around point according to DETAIL.
13959 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13960 `tree', `canonical' or t. See `org-show-context-detail' for more
13961 information."
13962 (unless (org-before-first-heading-p)
13963 ;; Show current heading and possibly its entry, following headline
13964 ;; or all children.
13965 (if (and (org-at-heading-p) (not (eq detail 'local)))
13966 (org-flag-heading nil)
13967 (org-show-entry)
13968 (org-with-limited-levels
13969 (case detail
13970 ((tree canonical t) (show-children))
13971 ((nil minimal ancestors))
13972 (t (save-excursion
13973 (outline-next-heading)
13974 (org-flag-heading nil))))))
13975 ;; Show all siblings.
13976 (when (eq detail 'lineage) (org-show-siblings))
13977 ;; Show ancestors, possibly with their children.
13978 (when (memq detail '(ancestors lineage tree canonical t))
13979 (save-excursion
13980 (while (org-up-heading-safe)
13981 (org-flag-heading nil)
13982 (when (memq detail '(canonical t)) (org-show-entry))
13983 (when (memq detail '(tree canonical t)) (show-children)))))))
13985 (defvar org-reveal-start-hook nil
13986 "Hook run before revealing a location.")
13988 (defun org-reveal (&optional siblings)
13989 "Show current entry, hierarchy above it, and the following headline.
13991 This can be used to show a consistent set of context around
13992 locations exposed with `org-show-context'.
13994 With optional argument SIBLINGS, on each level of the hierarchy all
13995 siblings are shown. This repairs the tree structure to what it would
13996 look like when opened with hierarchical calls to `org-cycle'.
13998 With double optional argument \\[universal-argument] \\[universal-argument], \
13999 go to the parent and show the
14000 entire tree."
14001 (interactive "P")
14002 (run-hooks 'org-reveal-start-hook)
14003 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14004 ((equal siblings '(16))
14005 (save-excursion
14006 (when (org-up-heading-safe)
14007 (org-show-subtree)
14008 (run-hook-with-args 'org-cycle-hook 'subtree))))
14009 (t (org-show-set-visibility 'lineage))))
14011 (defun org-highlight-new-match (beg end)
14012 "Highlight from BEG to END and mark the highlight is an occur headline."
14013 (let ((ov (make-overlay beg end)))
14014 (overlay-put ov 'face 'secondary-selection)
14015 (overlay-put ov 'org-type 'org-occur)
14016 (push ov org-occur-highlights)))
14018 (defun org-remove-occur-highlights (&optional beg end noremove)
14019 "Remove the occur highlights from the buffer.
14020 BEG and END are ignored. If NOREMOVE is nil, remove this function
14021 from the `before-change-functions' in the current buffer."
14022 (interactive)
14023 (unless org-inhibit-highlight-removal
14024 (mapc 'delete-overlay org-occur-highlights)
14025 (setq org-occur-highlights nil)
14026 (setq org-occur-parameters nil)
14027 (unless noremove
14028 (remove-hook 'before-change-functions
14029 'org-remove-occur-highlights 'local))))
14031 ;;;; Priorities
14033 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14034 "Regular expression matching the priority indicator.")
14036 (defvar org-remove-priority-next-time nil)
14038 (defun org-priority-up ()
14039 "Increase the priority of the current item."
14040 (interactive)
14041 (org-priority 'up))
14043 (defun org-priority-down ()
14044 "Decrease the priority of the current item."
14045 (interactive)
14046 (org-priority 'down))
14048 (defun org-priority (&optional action show)
14049 "Change the priority of an item.
14050 ACTION can be `set', `up', `down', or a character."
14051 (interactive "P")
14052 (if (equal action '(4))
14053 (org-show-priority)
14054 (unless org-enable-priority-commands
14055 (user-error "Priority commands are disabled"))
14056 (setq action (or action 'set))
14057 (let (current new news have remove)
14058 (save-excursion
14059 (org-back-to-heading t)
14060 (if (looking-at org-priority-regexp)
14061 (setq current (string-to-char (match-string 2))
14062 have t))
14063 (cond
14064 ((eq action 'remove)
14065 (setq remove t new ?\ ))
14066 ((or (eq action 'set)
14067 (if (featurep 'xemacs) (characterp action) (integerp action)))
14068 (if (not (eq action 'set))
14069 (setq new action)
14070 (message "Priority %c-%c, SPC to remove: "
14071 org-highest-priority org-lowest-priority)
14072 (save-match-data
14073 (setq new (read-char-exclusive))))
14074 (if (and (= (upcase org-highest-priority) org-highest-priority)
14075 (= (upcase org-lowest-priority) org-lowest-priority))
14076 (setq new (upcase new)))
14077 (cond ((equal new ?\ ) (setq remove t))
14078 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14079 (user-error "Priority must be between `%c' and `%c'"
14080 org-highest-priority org-lowest-priority))))
14081 ((eq action 'up)
14082 (setq new (if have
14083 (1- current) ; normal cycling
14084 ;; last priority was empty
14085 (if (eq last-command this-command)
14086 org-lowest-priority ; wrap around empty to lowest
14087 ;; default
14088 (if org-priority-start-cycle-with-default
14089 org-default-priority
14090 (1- org-default-priority))))))
14091 ((eq action 'down)
14092 (setq new (if have
14093 (1+ current) ; normal cycling
14094 ;; last priority was empty
14095 (if (eq last-command this-command)
14096 org-highest-priority ; wrap around empty to highest
14097 ;; default
14098 (if org-priority-start-cycle-with-default
14099 org-default-priority
14100 (1+ org-default-priority))))))
14101 (t (user-error "Invalid action")))
14102 (if (or (< (upcase new) org-highest-priority)
14103 (> (upcase new) org-lowest-priority))
14104 (if (and (memq action '(up down))
14105 (not have) (not (eq last-command this-command)))
14106 ;; `new' is from default priority
14107 (error
14108 "The default can not be set, see `org-default-priority' why")
14109 ;; normal cycling: `new' is beyond highest/lowest priority
14110 ;; and is wrapped around to the empty priority
14111 (setq remove t)))
14112 (setq news (format "%c" new))
14113 (if have
14114 (if remove
14115 (replace-match "" t t nil 1)
14116 (replace-match news t t nil 2))
14117 (if remove
14118 (user-error "No priority cookie found in line")
14119 (let ((case-fold-search nil))
14120 (looking-at org-todo-line-regexp))
14121 (if (match-end 2)
14122 (progn
14123 (goto-char (match-end 2))
14124 (insert " [#" news "]"))
14125 (goto-char (match-beginning 3))
14126 (insert "[#" news "] "))))
14127 (org-set-tags nil 'align))
14128 (if remove
14129 (message "Priority removed")
14130 (message "Priority of current item set to %s" news)))))
14132 (defun org-show-priority ()
14133 "Show the priority of the current item.
14134 This priority is composed of the main priority given with the [#A] cookies,
14135 and by additional input from the age of a schedules or deadline entry."
14136 (interactive)
14137 (let ((pri (if (eq major-mode 'org-agenda-mode)
14138 (org-get-at-bol 'priority)
14139 (save-excursion
14140 (save-match-data
14141 (beginning-of-line)
14142 (and (looking-at org-heading-regexp)
14143 (org-get-priority (match-string 0))))))))
14144 (message "Priority is %d" (if pri pri -1000))))
14146 (defun org-get-priority (s)
14147 "Find priority cookie and return priority."
14148 (save-match-data
14149 (if (functionp org-get-priority-function)
14150 (funcall org-get-priority-function)
14151 (if (not (string-match org-priority-regexp s))
14152 (* 1000 (- org-lowest-priority org-default-priority))
14153 (* 1000 (- org-lowest-priority
14154 (string-to-char (match-string 2 s))))))))
14156 ;;;; Tags
14158 (defvar org-agenda-archives-mode)
14159 (defvar org-map-continue-from nil
14160 "Position from where mapping should continue.
14161 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14163 (defvar org-scanner-tags nil
14164 "The current tag list while the tags scanner is running.")
14165 (defvar org-trust-scanner-tags nil
14166 "Should `org-get-tags-at' use the tags for the scanner.
14167 This is for internal dynamical scoping only.
14168 When this is non-nil, the function `org-get-tags-at' will return the value
14169 of `org-scanner-tags' instead of building the list by itself. This
14170 can lead to large speed-ups when the tags scanner is used in a file with
14171 many entries, and when the list of tags is retrieved, for example to
14172 obtain a list of properties. Building the tags list for each entry in such
14173 a file becomes an N^2 operation - but with this variable set, it scales
14174 as N.")
14176 (defun org-scan-tags (action matcher todo-only &optional start-level)
14177 "Scan headline tags with inheritance and produce output ACTION.
14179 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14180 or `agenda' to produce an entry list for an agenda view. It can also be
14181 a Lisp form or a function that should be called at each matched headline, in
14182 this case the return value is a list of all return values from these calls.
14184 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14185 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14186 only lines with a not-done TODO keyword are included in the output.
14187 This should be the same variable that was scoped into
14188 and set by `org-make-tags-matcher' when it constructed MATCHER.
14190 START-LEVEL can be a string with asterisks, reducing the scope to
14191 headlines matching this string."
14192 (require 'org-agenda)
14193 (let* ((re (concat "^"
14194 (if start-level
14195 ;; Get the correct level to match
14196 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14197 org-outline-regexp)
14198 " *\\(\\<\\("
14199 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14200 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14201 (props (list 'face 'default
14202 'done-face 'org-agenda-done
14203 'undone-face 'default
14204 'mouse-face 'highlight
14205 'org-not-done-regexp org-not-done-regexp
14206 'org-todo-regexp org-todo-regexp
14207 'org-complex-heading-regexp org-complex-heading-regexp
14208 'help-echo
14209 (format "mouse-2 or RET jump to org file %s"
14210 (abbreviate-file-name
14211 (or (buffer-file-name (buffer-base-buffer))
14212 (buffer-name (buffer-base-buffer)))))))
14213 (org-map-continue-from nil)
14214 lspos tags tags-list
14215 (tags-alist (list (cons 0 org-file-tags)))
14216 (llast 0) rtn rtn1 level category i txt
14217 todo marker entry priority
14218 ts-date ts-date-type ts-date-pair)
14219 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14220 (setq action (list 'lambda nil action)))
14221 (save-excursion
14222 (goto-char (point-min))
14223 (when (eq action 'sparse-tree)
14224 (org-overview)
14225 (org-remove-occur-highlights))
14226 (while (let (case-fold-search)
14227 (re-search-forward re nil t))
14228 (setq org-map-continue-from nil)
14229 (catch :skip
14230 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14231 tags (if (match-end 4) (org-match-string-no-properties 4)))
14232 (goto-char (setq lspos (match-beginning 0)))
14233 (setq level (org-reduced-level (org-outline-level))
14234 category (org-get-category))
14235 (when (eq action 'agenda)
14236 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14237 ts-date (car ts-date-pair)
14238 ts-date-type (cdr ts-date-pair)))
14239 (setq i llast llast level)
14240 ;; remove tag lists from same and sublevels
14241 (while (>= i level)
14242 (when (setq entry (assoc i tags-alist))
14243 (setq tags-alist (delete entry tags-alist)))
14244 (setq i (1- i)))
14245 ;; add the next tags
14246 (when tags
14247 (setq tags (org-split-string tags ":")
14248 tags-alist
14249 (cons (cons level tags) tags-alist)))
14250 ;; compile tags for current headline
14251 (setq tags-list
14252 (if org-use-tag-inheritance
14253 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14254 tags)
14255 org-scanner-tags tags-list)
14256 (when org-use-tag-inheritance
14257 (setcdr (car tags-alist)
14258 (mapcar (lambda (x)
14259 (setq x (copy-sequence x))
14260 (org-add-prop-inherited x))
14261 (cdar tags-alist))))
14262 (when (and tags org-use-tag-inheritance
14263 (or (not (eq t org-use-tag-inheritance))
14264 org-tags-exclude-from-inheritance))
14265 ;; selective inheritance, remove uninherited ones
14266 (setcdr (car tags-alist)
14267 (org-remove-uninherited-tags (cdar tags-alist))))
14268 (when (and
14270 ;; eval matcher only when the todo condition is OK
14271 (and (or (not todo-only) (member todo org-not-done-keywords))
14272 (let ((case-fold-search t) (org-trust-scanner-tags t))
14273 (eval matcher)))
14275 ;; Call the skipper, but return t if it does not skip,
14276 ;; so that the `and' form continues evaluating
14277 (progn
14278 (unless (eq action 'sparse-tree) (org-agenda-skip))
14281 ;; Check if timestamps are deselecting this entry
14282 (or (not todo-only)
14283 (and (member todo org-not-done-keywords)
14284 (or (not org-agenda-tags-todo-honor-ignore-options)
14285 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14287 ;; select this headline
14288 (cond
14289 ((eq action 'sparse-tree)
14290 (and org-highlight-sparse-tree-matches
14291 (org-get-heading) (match-end 0)
14292 (org-highlight-new-match
14293 (match-beginning 1) (match-end 1)))
14294 (org-show-context 'tags-tree))
14295 ((eq action 'agenda)
14296 (setq txt (org-agenda-format-item
14298 (concat
14299 (if (eq org-tags-match-list-sublevels 'indented)
14300 (make-string (1- level) ?.) "")
14301 (org-get-heading))
14302 (make-string level ?\s)
14303 category
14304 tags-list)
14305 priority (org-get-priority txt))
14306 (goto-char lspos)
14307 (setq marker (org-agenda-new-marker))
14308 (org-add-props txt props
14309 'org-marker marker 'org-hd-marker marker 'org-category category
14310 'todo-state todo
14311 'ts-date ts-date
14312 'priority priority
14313 'type (concat "tagsmatch" ts-date-type))
14314 (push txt rtn))
14315 ((functionp action)
14316 (setq org-map-continue-from nil)
14317 (save-excursion
14318 (setq rtn1 (funcall action))
14319 (push rtn1 rtn)))
14320 (t (user-error "Invalid action")))
14322 ;; if we are to skip sublevels, jump to end of subtree
14323 (unless org-tags-match-list-sublevels
14324 (org-end-of-subtree t)
14325 (backward-char 1))))
14326 ;; Get the correct position from where to continue
14327 (if org-map-continue-from
14328 (goto-char org-map-continue-from)
14329 (and (= (point) lspos) (end-of-line 1)))))
14330 (when (and (eq action 'sparse-tree)
14331 (not org-sparse-tree-open-archived-trees))
14332 (org-hide-archived-subtrees (point-min) (point-max)))
14333 (nreverse rtn)))
14335 (defun org-remove-uninherited-tags (tags)
14336 "Remove all tags that are not inherited from the list TAGS."
14337 (cond
14338 ((eq org-use-tag-inheritance t)
14339 (if org-tags-exclude-from-inheritance
14340 (org-delete-all org-tags-exclude-from-inheritance tags)
14341 tags))
14342 ((not org-use-tag-inheritance) nil)
14343 ((stringp org-use-tag-inheritance)
14344 (delq nil (mapcar
14345 (lambda (x)
14346 (if (and (string-match org-use-tag-inheritance x)
14347 (not (member x org-tags-exclude-from-inheritance)))
14348 x nil))
14349 tags)))
14350 ((listp org-use-tag-inheritance)
14351 (delq nil (mapcar
14352 (lambda (x)
14353 (if (member x org-use-tag-inheritance) x nil))
14354 tags)))))
14356 (defun org-match-sparse-tree (&optional todo-only match)
14357 "Create a sparse tree according to tags string MATCH.
14358 MATCH can contain positive and negative selection of tags, like
14359 \"+WORK+URGENT-WITHBOSS\".
14360 If optional argument TODO-ONLY is non-nil, only select lines that are
14361 also TODO lines."
14362 (interactive "P")
14363 (org-agenda-prepare-buffers (list (current-buffer)))
14364 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14366 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14368 (defvar org-cached-props nil)
14369 (defun org-cached-entry-get (pom property)
14370 (if (or (eq t org-use-property-inheritance)
14371 (and (stringp org-use-property-inheritance)
14372 (let ((case-fold-search t))
14373 (org-string-match-p org-use-property-inheritance property)))
14374 (and (listp org-use-property-inheritance)
14375 (member-ignore-case property org-use-property-inheritance)))
14376 ;; Caching is not possible, check it directly.
14377 (org-entry-get pom property 'inherit)
14378 ;; Get all properties, so we can do complicated checks easily.
14379 (cdr (assoc-string property
14380 (or org-cached-props
14381 (setq org-cached-props (org-entry-properties pom)))
14382 t))))
14384 (defun org-global-tags-completion-table (&optional files)
14385 "Return the list of all tags in all agenda buffer/files.
14386 Optional FILES argument is a list of files which can be used
14387 instead of the agenda files."
14388 (save-excursion
14389 (org-uniquify
14390 (delq nil
14391 (apply 'append
14392 (mapcar
14393 (lambda (file)
14394 (set-buffer (find-file-noselect file))
14395 (append (org-get-buffer-tags)
14396 (mapcar (lambda (x) (if (stringp (car-safe x))
14397 (list (car-safe x)) nil))
14398 org-tag-alist)))
14399 (if (and files (car files))
14400 files
14401 (org-agenda-files))))))))
14403 (defun org-make-tags-matcher (match)
14404 "Create the TAGS/TODO matcher form for the selection string MATCH.
14406 The variable `todo-only' is scoped dynamically into this function.
14407 It will be set to t if the matcher restricts matching to TODO entries,
14408 otherwise will not be touched.
14410 Returns a cons of the selection string MATCH and the constructed
14411 lisp form implementing the matcher. The matcher is to be evaluated
14412 at an Org entry, with point on the headline, and returns t if the
14413 entry matches the selection string MATCH. The returned lisp form
14414 references two variables with information about the entry, which
14415 must be bound around the form's evaluation: todo, the TODO keyword
14416 at the entry (or nil of none); and tags-list, the list of all tags
14417 at the entry including inherited ones. Additionally, the category
14418 of the entry (if any) must be specified as the text property
14419 'org-category on the headline.
14421 See also `org-scan-tags'.
14423 (declare (special todo-only))
14424 (unless (boundp 'todo-only)
14425 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14426 (unless match
14427 ;; Get a new match request, with completion against the global
14428 ;; tags table and the local tags in current buffer
14429 (let ((org-last-tags-completion-table
14430 (org-uniquify
14431 (delq nil (append (org-get-buffer-tags)
14432 (org-global-tags-completion-table))))))
14433 (setq match (org-completing-read-no-i
14434 "Match: " 'org-tags-completion-function nil nil nil
14435 'org-tags-history))))
14437 ;; Parse the string and create a lisp form
14438 (let ((match0 match)
14439 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14440 minus tag mm
14441 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14442 orterms term orlist re-p str-p level-p level-op time-p
14443 prop-p pn pv po gv rest (start 0) (ss 0))
14444 ;; Expand group tags
14445 (setq match (org-tags-expand match))
14447 ;; Check if there is a TODO part of this match, which would be the
14448 ;; part after a "/". TO make sure that this slash is not part of
14449 ;; a property value to be matched against, we also check that there
14450 ;; is no " after that slash.
14451 ;; First, find the last slash
14452 (while (string-match "/+" match ss)
14453 (setq start (match-beginning 0) ss (match-end 0)))
14454 (if (and (string-match "/+" match start)
14455 (not (save-match-data (string-match "\"" match start))))
14456 ;; match contains also a todo-matching request
14457 (progn
14458 (setq tagsmatch (substring match 0 (match-beginning 0))
14459 todomatch (substring match (match-end 0)))
14460 (if (string-match "^!" todomatch)
14461 (setq todo-only t todomatch (substring todomatch 1)))
14462 (if (string-match "^\\s-*$" todomatch)
14463 (setq todomatch nil)))
14464 ;; only matching tags
14465 (setq tagsmatch match todomatch nil))
14467 ;; Make the tags matcher
14468 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14469 (setq tagsmatcher t)
14470 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14471 (while (setq term (pop orterms))
14472 (while (and (equal (substring term -1) "\\") orterms)
14473 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14474 (while (string-match re term)
14475 (setq rest (substring term (match-end 0))
14476 minus (and (match-end 1)
14477 (equal (match-string 1 term) "-"))
14478 tag (save-match-data (replace-regexp-in-string
14479 "\\\\-" "-"
14480 (match-string 2 term)))
14481 re-p (equal (string-to-char tag) ?{)
14482 level-p (match-end 4)
14483 prop-p (match-end 5)
14484 mm (cond
14485 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14486 (level-p
14487 (setq level-op (org-op-to-function (match-string 3 term)))
14488 `(,level-op level ,(string-to-number
14489 (match-string 4 term))))
14490 (prop-p
14491 (setq pn (match-string 5 term)
14492 po (match-string 6 term)
14493 pv (match-string 7 term)
14494 re-p (equal (string-to-char pv) ?{)
14495 str-p (equal (string-to-char pv) ?\")
14496 time-p (save-match-data
14497 (string-match "^\"[[<].*[]>]\"$" pv))
14498 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14499 (if time-p (setq pv (org-matcher-time pv)))
14500 (setq po (org-op-to-function po (if time-p 'time str-p)))
14501 (cond
14502 ((equal pn "CATEGORY")
14503 (setq gv '(get-text-property (point) 'org-category)))
14504 ((equal pn "TODO")
14505 (setq gv 'todo))
14507 (setq gv `(org-cached-entry-get nil ,pn))))
14508 (if re-p
14509 (if (eq po 'org<>)
14510 `(not (string-match ,pv (or ,gv "")))
14511 `(string-match ,pv (or ,gv "")))
14512 (if str-p
14513 `(,po (or ,gv "") ,pv)
14514 `(,po (string-to-number (or ,gv ""))
14515 ,(string-to-number pv) ))))
14516 (t `(member ,tag tags-list)))
14517 mm (if minus (list 'not mm) mm)
14518 term rest)
14519 (push mm tagsmatcher))
14520 (push (if (> (length tagsmatcher) 1)
14521 (cons 'and tagsmatcher)
14522 (car tagsmatcher))
14523 orlist)
14524 (setq tagsmatcher nil))
14525 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14526 (setq tagsmatcher
14527 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14528 ;; Make the todo matcher
14529 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14530 (setq todomatcher t)
14531 (setq orterms (org-split-string todomatch "|") orlist nil)
14532 (while (setq term (pop orterms))
14533 (while (string-match re term)
14534 (setq minus (and (match-end 1)
14535 (equal (match-string 1 term) "-"))
14536 kwd (match-string 2 term)
14537 re-p (equal (string-to-char kwd) ?{)
14538 term (substring term (match-end 0))
14539 mm (if re-p
14540 `(string-match ,(substring kwd 1 -1) todo)
14541 (list 'equal 'todo kwd))
14542 mm (if minus (list 'not mm) mm))
14543 (push mm todomatcher))
14544 (push (if (> (length todomatcher) 1)
14545 (cons 'and todomatcher)
14546 (car todomatcher))
14547 orlist)
14548 (setq todomatcher nil))
14549 (setq todomatcher (if (> (length orlist) 1)
14550 (cons 'or orlist) (car orlist))))
14552 ;; Return the string and lisp forms of the matcher
14553 (setq matcher (if todomatcher
14554 (list 'and tagsmatcher todomatcher)
14555 tagsmatcher))
14556 (when todo-only
14557 (setq matcher (list 'and '(member todo org-not-done-keywords)
14558 matcher)))
14559 (cons match0 matcher)))
14561 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14562 "Expand group tags in MATCH.
14564 This replaces every group tag in MATCH with a regexp tag search.
14565 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14566 will be replaced like this:
14568 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14569 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14570 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14572 Replacing by a regexp preserves the structure of the match.
14573 E.g., this expansion
14575 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14577 will match anything tagged with \"Lab\" and \"Home\", or tagged
14578 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14580 A group tag in MATCH can contain regular expressions of its own.
14581 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14582 will be replaced like this:
14584 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14586 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14587 assumed to be a single group tag, and the function will return
14588 the list of tags in this group.
14590 When DOWNCASE is non-nil, expand downcased TAGS."
14591 (if org-group-tags
14592 (let* ((case-fold-search t)
14593 (stable org-mode-syntax-table)
14594 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14595 (taggroups (if downcased
14596 (mapcar (lambda (tg) (mapcar #'downcase tg))
14597 taggroups)
14598 taggroups))
14599 (taggroups-keys (mapcar #'car taggroups))
14600 (return-match (if downcased (downcase match) match))
14601 (count 0)
14602 (work-already-expanded tags-already-expanded)
14603 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14604 ;; @ and _ are allowed as word-components in tags.
14605 (modify-syntax-entry ?@ "w" stable)
14606 (modify-syntax-entry ?_ "w" stable)
14607 ;; Temporarily replace regexp-expressions in the match-expression.
14608 (while (string-match "{.+?}" return-match)
14609 (incf count)
14610 (push (match-string 0 return-match) regexps-in-match)
14611 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14612 (while (and taggroups-keys
14613 (with-syntax-table stable
14614 (string-match
14615 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14616 (regexp-opt taggroups-keys) "\\>\\)") return-match)))
14617 (let* ((dir (match-string 1 return-match))
14618 (tag (match-string 2 return-match))
14619 (tag (if downcased (downcase tag) tag)))
14620 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14621 (member tag work-already-expanded))
14622 (setq tags-in-group (assoc tag taggroups))
14623 (push tag work-already-expanded)
14624 ;; Recursively expand each tag in the group, if the tag hasn't
14625 ;; already been expanded. Restore the match-data after all recursive calls.
14626 (save-match-data
14627 (let (tags-expanded)
14628 (dolist (x (cdr tags-in-group))
14629 (if (and (member x taggroups-keys)
14630 (not (member x work-already-expanded)))
14631 (setq tags-expanded
14632 (delete-dups
14633 (append
14634 (org-tags-expand x t downcased
14635 work-already-expanded)
14636 tags-expanded)))
14637 (setq tags-expanded
14638 (append (list x) tags-expanded)))
14639 (setq work-already-expanded
14640 (delete-dups
14641 (append tags-expanded
14642 work-already-expanded))))
14643 (setq tags-in-group
14644 (delete-dups (cons (car tags-in-group)
14645 tags-expanded)))))
14646 ;; Filter tag-regexps from tags.
14647 (setq regexp-in-group-escaped
14648 (delq nil (mapcar (lambda (x)
14649 (if (stringp x)
14650 (and (equal "{" (substring x 0 1))
14651 (equal "}" (substring x -1))
14654 tags-in-group))
14655 regexp-in-group
14656 (mapcar (lambda (x)
14657 (substring x 1 -1))
14658 regexp-in-group-escaped)
14659 tags-in-group
14660 (delq nil (mapcar (lambda (x)
14661 (if (stringp x)
14662 (and (not (equal "{" (substring x 0 1)))
14663 (not (equal "}" (substring x -1)))
14666 tags-in-group)))
14667 ;; If single-as-list, do no more in the while-loop.
14668 (if (not single-as-list)
14669 (progn
14670 (when regexp-in-group
14671 (setq regexp-in-group
14672 (concat "\\|"
14673 (mapconcat 'identity regexp-in-group
14674 "\\|"))))
14675 (setq tags-in-group
14676 (concat dir
14677 "{\\<"
14678 (regexp-opt tags-in-group)
14679 "\\>"
14680 regexp-in-group
14681 "}"))
14682 (when (stringp tags-in-group)
14683 (org-add-props tags-in-group '(grouptag t)))
14684 (setq return-match
14685 (replace-match tags-in-group t t return-match)))
14686 (setq tags-in-group
14687 (append regexp-in-group-escaped tags-in-group))))
14688 (setq taggroups-keys (delete tag taggroups-keys))))
14689 ;; Add the regular expressions back into the match-expression again.
14690 (while regexps-in-match
14691 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14692 (pop regexps-in-match)
14693 return-match t t))
14694 (decf count))
14695 (if single-as-list
14696 (if tags-in-group tags-in-group (list return-match))
14697 return-match))
14698 (if single-as-list
14699 (list (if downcased (downcase match) match))
14700 match)))
14702 (defun org-op-to-function (op &optional stringp)
14703 "Turn an operator into the appropriate function."
14704 (setq op
14705 (cond
14706 ((equal op "<" ) '(< string< org-time<))
14707 ((equal op ">" ) '(> org-string> org-time>))
14708 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14709 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14710 ((member op '("=" "==")) '(= string= org-time=))
14711 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14712 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14714 (defun org<> (a b) (not (= a b)))
14715 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14716 (defun org-string>= (a b) (not (string< a b)))
14717 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14718 (defun org-string<> (a b) (not (string= a b)))
14719 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14720 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14721 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14722 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14723 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14724 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14725 (defun org-2ft (s)
14726 "Convert S to a floating point time.
14727 If S is already a number, just return it. If it is a string, parse
14728 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14729 (cond
14730 ((numberp s) s)
14731 ((stringp s)
14732 (condition-case nil
14733 (float-time (apply 'encode-time (org-parse-time-string s)))
14734 (error 0.)))
14735 (t 0.)))
14737 (defun org-time-today ()
14738 "Time in seconds today at 0:00.
14739 Returns the float number of seconds since the beginning of the
14740 epoch to the beginning of today (00:00)."
14741 (float-time (apply 'encode-time
14742 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14744 (defun org-matcher-time (s)
14745 "Interpret a time comparison value."
14746 (save-match-data
14747 (cond
14748 ((string= s "<now>") (float-time))
14749 ((string= s "<today>") (org-time-today))
14750 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14751 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14752 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14753 (+ (org-time-today)
14754 (* (string-to-number (match-string 1 s))
14755 (cdr (assoc (match-string 2 s)
14756 '(("d" . 86400.0) ("w" . 604800.0)
14757 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14758 (t (org-2ft s)))))
14760 (defun org-match-any-p (re list)
14761 "Does re match any element of list?"
14762 (setq list (mapcar (lambda (x) (string-match re x)) list))
14763 (delq nil list))
14765 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14766 (defvar org-tags-overlay (make-overlay 1 1))
14767 (org-detach-overlay org-tags-overlay)
14769 (defun org-get-local-tags-at (&optional pos)
14770 "Get a list of tags defined in the current headline."
14771 (org-get-tags-at pos 'local))
14773 (defun org-get-local-tags ()
14774 "Get a list of tags defined in the current headline."
14775 (org-get-tags-at nil 'local))
14777 (defun org-get-tags-at (&optional pos local)
14778 "Get a list of all headline tags applicable at POS.
14779 POS defaults to point. If tags are inherited, the list contains
14780 the targets in the same sequence as the headlines appear, i.e.
14781 the tags of the current headline come last.
14782 When LOCAL is non-nil, only return tags from the current headline,
14783 ignore inherited ones."
14784 (interactive)
14785 (if (and org-trust-scanner-tags
14786 (or (not pos) (equal pos (point)))
14787 (not local))
14788 org-scanner-tags
14789 (let (tags ltags lastpos parent)
14790 (save-excursion
14791 (save-restriction
14792 (widen)
14793 (goto-char (or pos (point)))
14794 (save-match-data
14795 (catch 'done
14796 (condition-case nil
14797 (progn
14798 (org-back-to-heading t)
14799 (while (not (equal lastpos (point)))
14800 (setq lastpos (point))
14801 (when (looking-at
14802 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14803 (setq ltags (org-split-string
14804 (org-match-string-no-properties 1) ":"))
14805 (when parent
14806 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14807 (setq tags (append
14808 (if parent
14809 (org-remove-uninherited-tags ltags)
14810 ltags)
14811 tags)))
14812 (or org-use-tag-inheritance (throw 'done t))
14813 (if local (throw 'done t))
14814 (or (org-up-heading-safe) (error nil))
14815 (setq parent t)))
14816 (error nil)))))
14817 (if local
14818 tags
14819 (reverse (delete-dups
14820 (reverse (append
14821 (org-remove-uninherited-tags
14822 org-file-tags) tags)))))))))
14824 (defun org-add-prop-inherited (s)
14825 (add-text-properties 0 (length s) '(inherited t) s)
14828 (defun org-toggle-tag (tag &optional onoff)
14829 "Toggle the tag TAG for the current line.
14830 If ONOFF is `on' or `off', don't toggle but set to this state."
14831 (let (res current)
14832 (save-excursion
14833 (org-back-to-heading t)
14834 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14835 (point-at-eol) t)
14836 (progn
14837 (setq current (match-string 1))
14838 (replace-match ""))
14839 (setq current ""))
14840 (setq current (nreverse (org-split-string current ":")))
14841 (cond
14842 ((eq onoff 'on)
14843 (setq res t)
14844 (or (member tag current) (push tag current)))
14845 ((eq onoff 'off)
14846 (or (not (member tag current)) (setq current (delete tag current))))
14847 (t (if (member tag current)
14848 (setq current (delete tag current))
14849 (setq res t)
14850 (push tag current))))
14851 (end-of-line 1)
14852 (if current
14853 (progn
14854 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14855 (org-set-tags nil t))
14856 (delete-horizontal-space))
14857 (run-hooks 'org-after-tags-change-hook))
14858 res))
14860 (defun org-align-tags-here (to-col)
14861 ;; Assumes that this is a headline
14862 "Align tags on the current headline to TO-COL."
14863 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14864 (beginning-of-line 1)
14865 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14866 (< pos (match-beginning 2)))
14867 (progn
14868 (setq tags-l (- (match-end 2) (match-beginning 2)))
14869 (goto-char (match-beginning 1))
14870 (insert " ")
14871 (delete-region (point) (1+ (match-beginning 2)))
14872 (setq ncol (max (current-column)
14873 (1+ col)
14874 (if (> to-col 0)
14875 to-col
14876 (- (abs to-col) tags-l))))
14877 (setq p (point))
14878 (insert (make-string (- ncol (current-column)) ?\ ))
14879 (setq ncol (current-column))
14880 (when indent-tabs-mode (tabify p (point-at-eol)))
14881 (org-move-to-column (min ncol col)))
14882 (goto-char pos))))
14884 (defun org-set-tags-command (&optional arg just-align)
14885 "Call the set-tags command for the current entry."
14886 (interactive "P")
14887 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14888 (org-set-tags arg just-align)
14889 (save-excursion
14890 (unless (and (org-region-active-p)
14891 org-loop-over-headlines-in-active-region)
14892 (org-back-to-heading t))
14893 (org-set-tags arg just-align))))
14895 (defun org-set-tags-to (data)
14896 "Set the tags of the current entry to DATA, replacing the current tags.
14897 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14898 If DATA is nil or the empty string, any tags will be removed."
14899 (interactive "sTags: ")
14900 (setq data
14901 (cond
14902 ((eq data nil) "")
14903 ((equal data "") "")
14904 ((stringp data)
14905 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14906 ":"))
14907 ((listp data)
14908 (concat ":" (mapconcat 'identity data ":") ":"))))
14909 (when data
14910 (save-excursion
14911 (org-back-to-heading t)
14912 (when (looking-at org-complex-heading-regexp)
14913 (if (match-end 5)
14914 (progn
14915 (goto-char (match-beginning 5))
14916 (insert data)
14917 (delete-region (point) (point-at-eol))
14918 (org-set-tags nil 'align))
14919 (goto-char (point-at-eol))
14920 (insert " " data)
14921 (org-set-tags nil 'align)))
14922 (beginning-of-line 1)
14923 (if (looking-at ".*?\\([ \t]+\\)$")
14924 (delete-region (match-beginning 1) (match-end 1))))))
14926 (defun org-align-all-tags ()
14927 "Align the tags i all headings."
14928 (interactive)
14929 (save-excursion
14930 (or (ignore-errors (org-back-to-heading t))
14931 (outline-next-heading))
14932 (if (org-at-heading-p)
14933 (org-set-tags t)
14934 (message "No headings"))))
14936 (defvar org-indent-indentation-per-level)
14937 (defun org-set-tags (&optional arg just-align)
14938 "Set the tags for the current headline.
14939 With prefix ARG, realign all tags in headings in the current buffer.
14940 When JUST-ALIGN is non-nil, only align tags."
14941 (interactive "P")
14942 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14943 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14944 'region-start-level
14945 'region))
14946 org-loop-over-headlines-in-active-region)
14947 (org-map-entries
14948 ;; We don't use ARG and JUST-ALIGN here because these args
14949 ;; are not useful when looping over headlines.
14950 #'org-set-tags
14951 org-loop-over-headlines-in-active-region
14953 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14954 (let ((org-setting-tags t))
14955 (if arg
14956 (save-excursion
14957 (goto-char (point-min))
14958 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14959 (while (re-search-forward org-outline-regexp-bol nil t)
14960 (org-set-tags nil t)
14961 (end-of-line)))
14962 (message "All tags realigned to column %d" org-tags-column))
14963 (let* ((current (org-get-tags-string))
14964 (col (current-column))
14965 (tags
14966 (if just-align current
14967 ;; Get a new set of tags from the user.
14968 (save-excursion
14969 (let* ((table
14970 (setq
14971 org-last-tags-completion-table
14972 (append
14973 org-tag-persistent-alist
14974 (or org-tag-alist (org-get-buffer-tags))
14975 (and
14976 org-complete-tags-always-offer-all-agenda-tags
14977 (org-global-tags-completion-table
14978 (org-agenda-files))))))
14979 (current-tags (org-split-string current ":"))
14980 (inherited-tags
14981 (nreverse (nthcdr (length current-tags)
14982 (nreverse (org-get-tags-at))))))
14983 (replace-regexp-in-string
14984 "\\([-+&]+\\|,\\)"
14986 (if (or (eq t org-use-fast-tag-selection)
14987 (and org-use-fast-tag-selection
14988 (delq nil (mapcar #'cdr table))))
14989 (org-fast-tag-selection
14990 current-tags inherited-tags table
14991 (and org-fast-tag-selection-include-todo
14992 org-todo-key-alist))
14993 (let ((org-add-colon-after-tag-completion
14994 (< 1 (length table))))
14995 (org-trim
14996 (completing-read
14997 "Tags: "
14998 #'org-tags-completion-function
14999 nil nil current 'org-tags-history))))))))))
15001 (when org-tags-sort-function
15002 (setq tags
15003 (mapconcat
15004 #'identity
15005 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15006 org-tags-sort-function)
15007 ":")))
15009 (if (not (org-string-nw-p tags)) (setq tags "")
15010 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15011 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15013 ;; Insert new tags at the correct column
15014 (beginning-of-line)
15015 (let ((level (if (looking-at org-outline-regexp)
15016 (- (match-end 0) (point) 1)
15017 1)))
15018 (cond
15019 ((and (equal current "") (equal tags "")))
15020 ((re-search-forward
15021 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15022 (line-end-position)
15024 (if (equal tags "") (replace-match "" t t)
15025 (goto-char (match-beginning 0))
15026 (let* ((c0 (current-column))
15027 ;; Compute offset for the case of org-indent-mode
15028 ;; active.
15029 (di (if (org-bound-and-true-p org-indent-mode)
15030 (* (1- org-indent-indentation-per-level)
15031 (1- level))
15033 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15034 (tc (+ org-tags-column
15035 (if (> org-tags-column 0) (- di) di)))
15036 (c1 (max (1+ c0)
15037 (if (> tc 0) tc
15038 (- (- tc) (string-width tags)))))
15039 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15040 (replace-match rpl t t)
15041 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15042 (tabify p0 (point))))))
15043 (t (error "Tags alignment failed"))))
15044 (org-move-to-column col))
15045 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15047 (defun org-change-tag-in-region (beg end tag off)
15048 "Add or remove TAG for each entry in the region.
15049 This works in the agenda, and also in an org-mode buffer."
15050 (interactive
15051 (list (region-beginning) (region-end)
15052 (let ((org-last-tags-completion-table
15053 (if (derived-mode-p 'org-mode)
15054 (org-uniquify
15055 (delq nil (append (org-get-buffer-tags)
15056 (org-global-tags-completion-table))))
15057 (org-global-tags-completion-table))))
15058 (org-icompleting-read
15059 "Tag: " 'org-tags-completion-function nil nil nil
15060 'org-tags-history))
15061 (progn
15062 (message "[s]et or [r]emove? ")
15063 (equal (read-char-exclusive) ?r))))
15064 (if (fboundp 'deactivate-mark) (deactivate-mark))
15065 (let ((agendap (equal major-mode 'org-agenda-mode))
15066 l1 l2 m buf pos newhead (cnt 0))
15067 (goto-char end)
15068 (setq l2 (1- (org-current-line)))
15069 (goto-char beg)
15070 (setq l1 (org-current-line))
15071 (loop for l from l1 to l2 do
15072 (org-goto-line l)
15073 (setq m (get-text-property (point) 'org-hd-marker))
15074 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15075 (and agendap m))
15076 (setq buf (if agendap (marker-buffer m) (current-buffer))
15077 pos (if agendap m (point)))
15078 (with-current-buffer buf
15079 (save-excursion
15080 (save-restriction
15081 (goto-char pos)
15082 (setq cnt (1+ cnt))
15083 (org-toggle-tag tag (if off 'off 'on))
15084 (setq newhead (org-get-heading)))))
15085 (and agendap (org-agenda-change-all-lines newhead m))))
15086 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15088 (defun org-tags-completion-function (string predicate &optional flag)
15089 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15090 (confirm (lambda (x) (stringp (car x)))))
15091 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15092 (setq s1 (match-string 1 string)
15093 s2 (match-string 2 string))
15094 (setq s1 "" s2 string))
15095 (cond
15096 ((eq flag nil)
15097 ;; try completion
15098 (setq rtn (try-completion s2 ctable confirm))
15099 (if (stringp rtn)
15100 (setq rtn
15101 (concat s1 s2 (substring rtn (length s2))
15102 (if (and org-add-colon-after-tag-completion
15103 (assoc rtn ctable))
15104 ":" ""))))
15105 rtn)
15106 ((eq flag t)
15107 ;; all-completions
15108 (all-completions s2 ctable confirm))
15109 ((eq flag 'lambda)
15110 ;; exact match?
15111 (assoc s2 ctable)))))
15113 (defun org-fast-tag-insert (kwd tags face &optional end)
15114 "Insert KDW, and the TAGS, the latter with face FACE.
15115 Also insert END."
15116 (insert (format "%-12s" (concat kwd ":"))
15117 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15118 (or end "")))
15120 (defun org-fast-tag-show-exit (flag)
15121 (save-excursion
15122 (org-goto-line 3)
15123 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15124 (replace-match ""))
15125 (when flag
15126 (end-of-line 1)
15127 (org-move-to-column (- (window-width) 19) t)
15128 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15130 (defun org-set-current-tags-overlay (current prefix)
15131 "Add an overlay to CURRENT tag with PREFIX."
15132 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15133 (if (featurep 'xemacs)
15134 (org-overlay-display org-tags-overlay (concat prefix s)
15135 'secondary-selection)
15136 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15137 (org-overlay-display org-tags-overlay (concat prefix s)))))
15139 (defvar org-last-tag-selection-key nil)
15140 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15141 "Fast tag selection with single keys.
15142 CURRENT is the current list of tags in the headline, INHERITED is the
15143 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15144 possibly with grouping information. TODO-TABLE is a similar table with
15145 TODO keywords, should these have keys assigned to them.
15146 If the keys are nil, a-z are automatically assigned.
15147 Returns the new tags string, or nil to not change the current settings."
15148 (let* ((fulltable (append table todo-table))
15149 (maxlen (apply 'max (mapcar
15150 (lambda (x)
15151 (if (stringp (car x)) (string-width (car x)) 0))
15152 fulltable)))
15153 (buf (current-buffer))
15154 (expert (eq org-fast-tag-selection-single-key 'expert))
15155 (buffer-tags nil)
15156 (fwidth (+ maxlen 3 1 3))
15157 (ncol (/ (- (window-width) 4) fwidth))
15158 (i-face 'org-done)
15159 (c-face 'org-todo)
15160 tg cnt e c char c1 c2 ntable tbl rtn
15161 ov-start ov-end ov-prefix
15162 (exit-after-next org-fast-tag-selection-single-key)
15163 (done-keywords org-done-keywords)
15164 groups ingroup intaggroup)
15165 (save-excursion
15166 (beginning-of-line 1)
15167 (if (looking-at
15168 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15169 (setq ov-start (match-beginning 1)
15170 ov-end (match-end 1)
15171 ov-prefix "")
15172 (setq ov-start (1- (point-at-eol))
15173 ov-end (1+ ov-start))
15174 (skip-chars-forward "^\n\r")
15175 (setq ov-prefix
15176 (concat
15177 (buffer-substring (1- (point)) (point))
15178 (if (> (current-column) org-tags-column)
15180 (make-string (- org-tags-column (current-column)) ?\ ))))))
15181 (move-overlay org-tags-overlay ov-start ov-end)
15182 (save-window-excursion
15183 (if expert
15184 (set-buffer (get-buffer-create " *Org tags*"))
15185 (delete-other-windows)
15186 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15187 (org-switch-to-buffer-other-window " *Org tags*"))
15188 (erase-buffer)
15189 (org-set-local 'org-done-keywords done-keywords)
15190 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15191 (org-fast-tag-insert "Current" current c-face "\n\n")
15192 (org-fast-tag-show-exit exit-after-next)
15193 (org-set-current-tags-overlay current ov-prefix)
15194 (setq tbl fulltable char ?a cnt 0)
15195 (while (setq e (pop tbl))
15196 (cond
15197 ((eq (car e) :startgroup)
15198 (push '() groups) (setq ingroup t)
15199 (unless (zerop cnt)
15200 (setq cnt 0)
15201 (insert "\n"))
15202 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15203 ((eq (car e) :endgroup)
15204 (setq ingroup nil cnt 0)
15205 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15206 ((eq (car e) :startgrouptag)
15207 (setq intaggroup t)
15208 (unless (zerop cnt)
15209 (setq cnt 0)
15210 (insert "\n"))
15211 (insert "[ "))
15212 ((eq (car e) :endgrouptag)
15213 (setq intaggroup nil cnt 0)
15214 (insert "]\n"))
15215 ((equal e '(:newline))
15216 (unless (zerop cnt)
15217 (setq cnt 0)
15218 (insert "\n")
15219 (setq e (car tbl))
15220 (while (equal (car tbl) '(:newline))
15221 (insert "\n")
15222 (setq tbl (cdr tbl)))))
15223 ((equal e '(:grouptags)) (insert " : "))
15225 (setq tg (copy-sequence (car e)) c2 nil)
15226 (if (cdr e)
15227 (setq c (cdr e))
15228 ;; automatically assign a character.
15229 (setq c1 (string-to-char
15230 (downcase (substring
15231 tg (if (= (string-to-char tg) ?@) 1 0)))))
15232 (if (or (rassoc c1 ntable) (rassoc c1 table))
15233 (while (or (rassoc char ntable) (rassoc char table))
15234 (setq char (1+ char)))
15235 (setq c2 c1))
15236 (setq c (or c2 char)))
15237 (when ingroup (push tg (car groups)))
15238 (setq tg (org-add-props tg nil 'face
15239 (cond
15240 ((not (assoc tg table))
15241 (org-get-todo-face tg))
15242 ((member tg current) c-face)
15243 ((member tg inherited) i-face))))
15244 (when (equal (caar tbl) :grouptags)
15245 (org-add-props tg nil 'face 'org-tag-group))
15246 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15247 (insert "[" c "] " tg (make-string
15248 (- fwidth 4 (length tg)) ?\ ))
15249 (push (cons tg c) ntable)
15250 (when (= (incf cnt) ncol)
15251 (insert "\n")
15252 (when (or ingroup intaggroup) (insert " "))
15253 (setq cnt 0)))))
15254 (setq ntable (nreverse ntable))
15255 (insert "\n")
15256 (goto-char (point-min))
15257 (unless expert (org-fit-window-to-buffer))
15258 (setq rtn
15259 (catch 'exit
15260 (while t
15261 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15262 (if (not groups) "no " "")
15263 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15264 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15265 (setq org-last-tag-selection-key c)
15266 (cond
15267 ((= c ?\r) (throw 'exit t))
15268 ((= c ?!)
15269 (setq groups (not groups))
15270 (goto-char (point-min))
15271 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15272 ((= c ?\C-c)
15273 (if (not expert)
15274 (org-fast-tag-show-exit
15275 (setq exit-after-next (not exit-after-next)))
15276 (setq expert nil)
15277 (delete-other-windows)
15278 (set-window-buffer (split-window-vertically) " *Org tags*")
15279 (org-switch-to-buffer-other-window " *Org tags*")
15280 (org-fit-window-to-buffer)))
15281 ((or (= c ?\C-g)
15282 (and (= c ?q) (not (rassoc c ntable))))
15283 (org-detach-overlay org-tags-overlay)
15284 (setq quit-flag t))
15285 ((= c ?\ )
15286 (setq current nil)
15287 (when exit-after-next (setq exit-after-next 'now)))
15288 ((= c ?\t)
15289 (condition-case nil
15290 (setq tg (org-icompleting-read
15291 "Tag: "
15292 (or buffer-tags
15293 (with-current-buffer buf
15294 (org-get-buffer-tags)))))
15295 (quit (setq tg "")))
15296 (when (string-match "\\S-" tg)
15297 (add-to-list 'buffer-tags (list tg))
15298 (if (member tg current)
15299 (setq current (delete tg current))
15300 (push tg current)))
15301 (when exit-after-next (setq exit-after-next 'now)))
15302 ((setq e (rassoc c todo-table) tg (car e))
15303 (with-current-buffer buf
15304 (save-excursion (org-todo tg)))
15305 (when exit-after-next (setq exit-after-next 'now)))
15306 ((setq e (rassoc c ntable) tg (car e))
15307 (if (member tg current)
15308 (setq current (delete tg current))
15309 (loop for g in groups do
15310 (when (member tg g)
15311 (dolist (x g) (setq current (delete x current)))))
15312 (push tg current))
15313 (when exit-after-next (setq exit-after-next 'now))))
15315 ;; Create a sorted list
15316 (setq current
15317 (sort current
15318 (lambda (a b)
15319 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15320 (when (eq exit-after-next 'now) (throw 'exit t))
15321 (goto-char (point-min))
15322 (beginning-of-line 2)
15323 (delete-region (point) (point-at-eol))
15324 (org-fast-tag-insert "Current" current c-face)
15325 (org-set-current-tags-overlay current ov-prefix)
15326 (while (re-search-forward
15327 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15328 (setq tg (match-string 1))
15329 (add-text-properties
15330 (match-beginning 1) (match-end 1)
15331 (list 'face
15332 (cond
15333 ((member tg current) c-face)
15334 ((member tg inherited) i-face)
15335 (t (get-text-property (match-beginning 1) 'face))))))
15336 (goto-char (point-min)))))
15337 (org-detach-overlay org-tags-overlay)
15338 (if rtn
15339 (mapconcat 'identity current ":")
15340 nil))))
15342 (defun org-get-tags-string ()
15343 "Get the TAGS string in the current headline."
15344 (unless (org-at-heading-p t)
15345 (user-error "Not on a heading"))
15346 (save-excursion
15347 (beginning-of-line 1)
15348 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15349 (org-match-string-no-properties 1)
15350 "")))
15352 (defun org-get-tags ()
15353 "Get the list of tags specified in the current headline."
15354 (org-split-string (org-get-tags-string) ":"))
15356 (defun org-get-buffer-tags ()
15357 "Get a table of all tags used in the buffer, for completion."
15358 (org-with-wide-buffer
15359 (goto-char (point-min))
15360 (let ((tag-re (concat org-outline-regexp-bol
15361 "\\(?:.*?[ \t]\\)?"
15362 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15363 tags)
15364 (while (re-search-forward tag-re nil t)
15365 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15366 (push tag tags)))
15367 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15369 ;;;; The mapping API
15371 (defun org-map-entries (func &optional match scope &rest skip)
15372 "Call FUNC at each headline selected by MATCH in SCOPE.
15374 FUNC is a function or a lisp form. The function will be called without
15375 arguments, with the cursor positioned at the beginning of the headline.
15376 The return values of all calls to the function will be collected and
15377 returned as a list.
15379 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15380 does not need to preserve point. After evaluation, the cursor will be
15381 moved to the end of the line (presumably of the headline of the
15382 processed entry) and search continues from there. Under some
15383 circumstances, this may not produce the wanted results. For example,
15384 if you have removed (e.g. archived) the current (sub)tree it could
15385 mean that the next entry will be skipped entirely. In such cases, you
15386 can specify the position from where search should continue by making
15387 FUNC set the variable `org-map-continue-from' to the desired buffer
15388 position.
15390 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15391 Only headlines that are matched by this query will be considered during
15392 the iteration. When MATCH is nil or t, all headlines will be
15393 visited by the iteration.
15395 SCOPE determines the scope of this command. It can be any of:
15397 nil The current buffer, respecting the restriction if any
15398 tree The subtree started with the entry at point
15399 region The entries within the active region, if any
15400 region-start-level
15401 The entries within the active region, but only those at
15402 the same level than the first one.
15403 file The current buffer, without restriction
15404 file-with-archives
15405 The current buffer, and any archives associated with it
15406 agenda All agenda files
15407 agenda-with-archives
15408 All agenda files with any archive files associated with them
15409 \(file1 file2 ...)
15410 If this is a list, all files in the list will be scanned
15412 The remaining args are treated as settings for the skipping facilities of
15413 the scanner. The following items can be given here:
15415 archive skip trees with the archive tag
15416 comment skip trees with the COMMENT keyword
15417 function or Emacs Lisp form:
15418 will be used as value for `org-agenda-skip-function', so
15419 whenever the function returns a position, FUNC will not be
15420 called for that entry and search will continue from the
15421 position returned
15423 If your function needs to retrieve the tags including inherited tags
15424 at the *current* entry, you can use the value of the variable
15425 `org-scanner-tags' which will be much faster than getting the value
15426 with `org-get-tags-at'. If your function gets properties with
15427 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15428 to t around the call to `org-entry-properties' to get the same speedup.
15429 Note that if your function moves around to retrieve tags and properties at
15430 a *different* entry, you cannot use these techniques."
15431 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15432 (not (org-region-active-p)))
15433 (let* ((org-agenda-archives-mode nil) ; just to make sure
15434 (org-agenda-skip-archived-trees (memq 'archive skip))
15435 (org-agenda-skip-comment-trees (memq 'comment skip))
15436 (org-agenda-skip-function
15437 (car (org-delete-all '(comment archive) skip)))
15438 (org-tags-match-list-sublevels t)
15439 (start-level (eq scope 'region-start-level))
15440 matcher file res
15441 org-todo-keywords-for-agenda
15442 org-done-keywords-for-agenda
15443 org-todo-keyword-alist-for-agenda
15444 org-tag-alist-for-agenda
15445 todo-only)
15447 (cond
15448 ((eq match t) (setq matcher t))
15449 ((eq match nil) (setq matcher t))
15450 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15452 (save-excursion
15453 (save-restriction
15454 (cond ((eq scope 'tree)
15455 (org-back-to-heading t)
15456 (org-narrow-to-subtree)
15457 (setq scope nil))
15458 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15459 (org-region-active-p))
15460 ;; If needed, set start-level to a string like "2"
15461 (when start-level
15462 (save-excursion
15463 (goto-char (region-beginning))
15464 (unless (org-at-heading-p) (outline-next-heading))
15465 (setq start-level (org-current-level))))
15466 (narrow-to-region (region-beginning)
15467 (save-excursion
15468 (goto-char (region-end))
15469 (unless (and (bolp) (org-at-heading-p))
15470 (outline-next-heading))
15471 (point)))
15472 (setq scope nil)))
15474 (if (not scope)
15475 (progn
15476 (org-agenda-prepare-buffers
15477 (list (buffer-file-name (current-buffer))))
15478 (setq res (org-scan-tags func matcher todo-only start-level)))
15479 ;; Get the right scope
15480 (cond
15481 ((and scope (listp scope) (symbolp (car scope)))
15482 (setq scope (eval scope)))
15483 ((eq scope 'agenda)
15484 (setq scope (org-agenda-files t)))
15485 ((eq scope 'agenda-with-archives)
15486 (setq scope (org-agenda-files t))
15487 (setq scope (org-add-archive-files scope)))
15488 ((eq scope 'file)
15489 (setq scope (list (buffer-file-name))))
15490 ((eq scope 'file-with-archives)
15491 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15492 (org-agenda-prepare-buffers scope)
15493 (while (setq file (pop scope))
15494 (with-current-buffer (org-find-base-buffer-visiting file)
15495 (save-excursion
15496 (save-restriction
15497 (widen)
15498 (goto-char (point-min))
15499 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15500 res)))
15502 ;;; Properties API
15504 (defconst org-special-properties
15505 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15506 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15507 "The special properties valid in Org mode.
15508 These are properties that are not defined in the property drawer,
15509 but in some other way.")
15511 (defconst org-default-properties
15512 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15513 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15514 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15515 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15516 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15517 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15518 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15519 "Some properties that are used by Org mode for various purposes.
15520 Being in this list makes sure that they are offered for completion.")
15522 (defun org--update-property-plist (key val props)
15523 "Associate KEY to VAL in alist PROPS.
15524 Modifications are made by side-effect. Return new alist."
15525 (let* ((appending (string= (substring key -1) "+"))
15526 (key (if appending (substring key 0 -1) key))
15527 (old (assoc-string key props t)))
15528 (if (not old) (cons (cons key val) props)
15529 (setcdr old (if appending (concat (cdr old) " " val) val))
15530 props)))
15532 (defun org-get-property-block (&optional beg force)
15533 "Return the (beg . end) range of the body of the property drawer.
15534 BEG is the beginning of the current subtree, or of the part
15535 before the first headline. If it is not given, it will be found.
15536 If the drawer does not exist, create it if FORCE is non-nil, or
15537 return nil."
15538 (org-with-wide-buffer
15539 (when beg (goto-char beg))
15540 (unless (org-before-first-heading-p)
15541 (let ((beg (cond (beg)
15542 ((or (not (featurep 'org-inlinetask))
15543 (org-inlinetask-in-task-p))
15544 (org-back-to-heading t))
15545 (t (org-with-limited-levels (org-back-to-heading t))))))
15546 (forward-line)
15547 (when (org-looking-at-p org-planning-line-re) (forward-line))
15548 (cond ((looking-at org-property-drawer-re)
15549 (forward-line)
15550 (cons (point) (progn (goto-char (match-end 0))
15551 (line-beginning-position))))
15552 (force
15553 (goto-char beg)
15554 (org-insert-property-drawer)
15555 (let ((pos (save-excursion (search-forward ":END:")
15556 (line-beginning-position))))
15557 (cons pos pos))))))))
15559 (defun org-at-property-p ()
15560 "Non-nil when point is inside a property drawer.
15561 See `org-property-re' for match data, if applicable."
15562 (save-excursion
15563 (beginning-of-line)
15564 (and (looking-at org-property-re)
15565 (let ((property-drawer (save-match-data (org-get-property-block))))
15566 (and property-drawer
15567 (>= (point) (car property-drawer))
15568 (< (point) (cdr property-drawer)))))))
15570 (defun org-property-action ()
15571 "Do an action on properties."
15572 (interactive)
15573 (unless (org-at-property-p) (user-error "Not at a property"))
15574 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15575 (let ((c (read-char-exclusive)))
15576 (case c
15577 (?s (call-interactively #'org-set-property))
15578 (?d (call-interactively #'org-delete-property))
15579 (?D (call-interactively #'org-delete-property-globally))
15580 (?c (call-interactively #'org-compute-property-at-point))
15581 (otherwise (user-error "No such property action %c" c)))))
15583 (defun org-inc-effort ()
15584 "Increment the value of the effort property in the current entry."
15585 (interactive)
15586 (org-set-effort nil t))
15588 (defvar org-clock-effort) ; Defined in org-clock.el.
15589 (defvar org-clock-current-task) ; Defined in org-clock.el.
15590 (defun org-set-effort (&optional value increment)
15591 "Set the effort property of the current entry.
15592 With numerical prefix arg, use the nth allowed value, 0 stands for the
15593 10th allowed value.
15595 When INCREMENT is non-nil, set the property to the next allowed value."
15596 (interactive "P")
15597 (if (equal value 0) (setq value 10))
15598 (let* ((completion-ignore-case t)
15599 (prop org-effort-property)
15600 (cur (org-entry-get nil prop))
15601 (allowed (org-property-get-allowed-values nil prop 'table))
15602 (existing (mapcar 'list (org-property-values prop)))
15603 (heading (nth 4 (org-heading-components)))
15605 (val (cond
15606 ((stringp value) value)
15607 ((and allowed (integerp value))
15608 (or (car (nth (1- value) allowed))
15609 (car (org-last allowed))))
15610 ((and allowed increment)
15611 (or (caadr (member (list cur) allowed))
15612 (user-error "Allowed effort values are not set")))
15613 (allowed
15614 (message "Select 1-9,0, [RET%s]: %s"
15615 (if cur (concat "=" cur) "")
15616 (mapconcat 'car allowed " "))
15617 (setq rpl (read-char-exclusive))
15618 (if (equal rpl ?\r)
15620 (setq rpl (- rpl ?0))
15621 (if (equal rpl 0) (setq rpl 10))
15622 (if (and (> rpl 0) (<= rpl (length allowed)))
15623 (car (nth (1- rpl) allowed))
15624 (org-completing-read "Effort: " allowed nil))))
15626 (let (org-completion-use-ido org-completion-use-iswitchb)
15627 (org-completing-read
15628 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15629 (concat "[" cur "]") "")
15630 ": ")
15631 existing nil nil "" nil cur))))))
15632 (unless (equal (org-entry-get nil prop) val)
15633 (org-entry-put nil prop val))
15634 (org-refresh-property
15635 '((effort . identity)
15636 (effort-minutes . org-duration-string-to-minutes))
15637 val)
15638 (when (string= heading org-clock-current-task)
15639 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15640 (org-clock-update-mode-line))
15641 (message "%s is now %s" prop val)))
15643 (defun org-entry-properties (&optional pom which)
15644 "Get all properties of the current entry.
15646 When POM is a buffer position, get all properties from the entry
15647 there instead.
15649 This includes the TODO keyword, the tags, time strings for
15650 deadline, scheduled, and clocking, and any additional properties
15651 defined in the entry.
15653 If WHICH is nil or `all', get all properties. If WHICH is
15654 `special' or `standard', only get that subclass. If WHICH is
15655 a string, only get that property.
15657 Return value is an alist. Keys are properties, as upcased
15658 strings."
15659 (org-with-point-at pom
15660 (when (and (derived-mode-p 'org-mode)
15661 (ignore-errors (org-back-to-heading t)))
15662 (catch 'exit
15663 (let* ((beg (point))
15664 (specific (and (stringp which) (upcase which)))
15665 (which (cond ((not specific) which)
15666 ((member specific org-special-properties) 'special)
15667 (t 'standard)))
15668 props)
15669 ;; Get the special properties, like TODO and TAGS.
15670 (when (memq which '(nil all special))
15671 (when (or (not specific) (string= specific "CLOCKSUM"))
15672 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15673 (when clocksum
15674 (push (cons "CLOCKSUM"
15675 (org-columns-number-to-string
15676 (/ (float clocksum) 60.) 'add_times))
15677 props)))
15678 (when specific (throw 'exit props)))
15679 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15680 (let ((clocksumt (get-text-property (point)
15681 :org-clock-minutes-today)))
15682 (when clocksumt
15683 (push (cons "CLOCKSUM_T"
15684 (org-columns-number-to-string
15685 (/ (float clocksumt) 60.) 'add_times))
15686 props)))
15687 (when specific (throw 'exit props)))
15688 (when (or (not specific) (string= specific "ITEM"))
15689 (when (looking-at org-complex-heading-regexp)
15690 (push (cons "ITEM"
15691 (concat
15692 (org-match-string-no-properties 1)
15693 (let ((title (org-match-string-no-properties 4)))
15694 (when (org-string-nw-p title)
15695 (concat " " (org-remove-tabs title))))))
15696 props))
15697 (when specific (throw 'exit props)))
15698 (when (or (not specific) (string= specific "TODO"))
15699 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15700 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15701 (when specific (throw 'exit props)))
15702 (when (or (not specific) (string= specific "PRIORITY"))
15703 (when (looking-at org-priority-regexp)
15704 (push (cons "PRIORITY" (org-match-string-no-properties 2))
15705 props))
15706 (when specific (throw 'exit props)))
15707 (when (or (not specific) (string= specific "FILE"))
15708 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15709 props)
15710 (when specific (throw 'exit props)))
15711 (when (or (not specific) (string= specific "TAGS"))
15712 (let ((value (org-string-nw-p (org-get-tags-string))))
15713 (when value (push (cons "TAGS" value) props)))
15714 (when specific (throw 'exit props)))
15715 (when (or (not specific) (string= specific "ALLTAGS"))
15716 (let ((value (org-get-tags-at)))
15717 (when value
15718 (push (cons "ALLTAGS"
15719 (format ":%s:" (mapconcat #'identity value ":")))
15720 props)))
15721 (when specific (throw 'exit props)))
15722 (when (or (not specific) (string= specific "BLOCKED"))
15723 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15724 (when specific (throw 'exit props)))
15725 (when (or (not specific)
15726 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15727 (forward-line)
15728 (when (org-looking-at-p org-planning-line-re)
15729 (end-of-line)
15730 (let ((bol (line-beginning-position))
15731 ;; Backward compatibility: time keywords used to
15732 ;; be configurable (before 8.3). Make sure we
15733 ;; get the correct keyword.
15734 (key-assoc `(("CLOSED" . ,org-closed-string)
15735 ("DEADLINE" . ,org-deadline-string)
15736 ("SCHEDULED" . ,org-scheduled-string))))
15737 (dolist (pair (if specific (list (assoc specific key-assoc))
15738 key-assoc))
15739 (save-excursion
15740 (when (search-backward (cdr pair) bol t)
15741 (goto-char (match-end 0))
15742 (skip-chars-forward " \t")
15743 (and (looking-at org-ts-regexp-both)
15744 (push (cons (car pair)
15745 (org-match-string-no-properties 0))
15746 props)))))))
15747 (when specific (throw 'exit props)))
15748 (when (or (not specific)
15749 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15750 (let ((find-ts
15751 (lambda (end ts)
15752 (let ((regexp (cond
15753 ((string= specific "TIMESTAMP")
15754 org-ts-regexp)
15755 ((string= specific "TIMESTAMP_IA")
15756 org-ts-regexp-inactive)
15757 ((assoc "TIMESTAMP_IA" ts)
15758 org-ts-regexp)
15759 ((assoc "TIMESTAMP" ts)
15760 org-ts-regexp-inactive)
15761 (t org-ts-regexp-both))))
15762 (catch 'next
15763 (while (re-search-forward regexp end t)
15764 (backward-char)
15765 (let ((object (org-element-context)))
15766 ;; Accept to match timestamps in node
15767 ;; properties, too.
15768 (when (memq (org-element-type object)
15769 '(node-property timestamp))
15770 (let ((type
15771 (org-element-property :type object)))
15772 (cond
15773 ((and (memq type '(active active-range))
15774 (not (equal specific "TIMESTAMP_IA")))
15775 (unless (assoc "TIMESTAMP" ts)
15776 (push (cons "TIMESTAMP"
15777 (org-element-property
15778 :raw-value object))
15780 (when specific (throw 'exit ts))))
15781 ((and (memq type '(inactive inactive-range))
15782 (not (string= specific "TIMESTAMP")))
15783 (unless (assoc "TIMESTAMP_IA" ts)
15784 (push (cons "TIMESTAMP_IA"
15785 (org-element-property
15786 :raw-value object))
15788 (when specific (throw 'exit ts))))))
15789 ;; Both timestamp types are found,
15790 ;; move to next part.
15791 (when (= (length ts) 2) (throw 'next ts)))))
15792 ts)))))
15793 (goto-char beg)
15794 ;; First look for timestamps within headline.
15795 (let ((ts (funcall find-ts (line-end-position) nil)))
15796 (if (= (length ts) 2) (setq props (nconc ts props))
15797 (forward-line)
15798 ;; Then find timestamps in the section, skipping
15799 ;; planning line.
15800 (when (org-looking-at-p org-planning-line-re)
15801 (forward-line))
15802 (let ((end (save-excursion (outline-next-heading))))
15803 (setq props (nconc (funcall find-ts end ts) props))))))))
15804 ;; Get the standard properties, like :PROP:.
15805 (when (memq which '(nil all standard))
15806 ;; If we are looking after a specific property, delegate
15807 ;; to `org-entry-get', which is faster. However, make an
15808 ;; exception for "CATEGORY", since it can be also set
15809 ;; through keywords (i.e. #+CATEGORY).
15810 (if (and specific (not (equal specific "CATEGORY")))
15811 (let ((value (org-entry-get beg specific nil t)))
15812 (throw 'exit (and value (list (cons specific value)))))
15813 (let ((range (org-get-property-block beg)))
15814 (when range
15815 (let ((end (cdr range)) seen-base)
15816 (goto-char (car range))
15817 ;; Unlike to `org--update-property-plist', we
15818 ;; handle the case where base values is found
15819 ;; after its extension. We also forbid standard
15820 ;; properties to be named as special properties.
15821 (while (re-search-forward org-property-re end t)
15822 (let* ((key (upcase (org-match-string-no-properties 2)))
15823 (extendp (org-string-match-p "\\+\\'" key))
15824 (key-base (if extendp (substring key 0 -1) key))
15825 (value (org-match-string-no-properties 3)))
15826 (cond
15827 ((member-ignore-case key-base org-special-properties))
15828 (extendp
15829 (setq props
15830 (org--update-property-plist key value props)))
15831 ((member key seen-base))
15832 (t (push key seen-base)
15833 (let ((p (assoc-string key props t)))
15834 (if p (setcdr p (concat value " " (cdr p)))
15835 (push (cons key value) props))))))))))))
15836 (unless (assoc "CATEGORY" props)
15837 (push (cons "CATEGORY" (org-get-category beg)) props)
15838 (when (string= specific "CATEGORY") (throw 'exit props)))
15839 ;; Return value.
15840 (append (get-text-property beg 'org-summaries) props))))))
15842 (defun org-property--local-values (property literal-nil)
15843 "Return value for PROPERTY in current entry.
15844 Value is a list whose care is the base value for PROPERTY and cdr
15845 a list of accumulated values. Return nil if neither is found in
15846 the entry. Also return nil when PROPERTY is set to \"nil\",
15847 unless LITERAL-NIL is non-nil."
15848 (let ((range (org-get-property-block)))
15849 (when range
15850 (goto-char (car range))
15851 (let* ((case-fold-search t)
15852 (end (cdr range))
15853 (value
15854 ;; Base value.
15855 (save-excursion
15856 (let ((v (and (re-search-forward
15857 (org-re-property property nil t) end t)
15858 (org-match-string-no-properties 3))))
15859 (list (if literal-nil v (org-not-nil v)))))))
15860 ;; Find additional values.
15861 (let* ((property+ (org-re-property (concat property "+") nil t)))
15862 (while (re-search-forward property+ end t)
15863 (push (org-match-string-no-properties 3) value)))
15864 ;; Return final values.
15865 (and (not (equal value '(nil))) (nreverse value))))))
15867 (defun org-entry-get (pom property &optional inherit literal-nil)
15868 "Get value of PROPERTY for entry or content at point-or-marker POM.
15870 If INHERIT is non-nil and the entry does not have the property,
15871 then also check higher levels of the hierarchy. If INHERIT is
15872 the symbol `selective', use inheritance only if the setting in
15873 `org-use-property-inheritance' selects PROPERTY for inheritance.
15875 If the property is present but empty, the return value is the
15876 empty string. If the property is not present at all, nil is
15877 returned. In any other case, return the value as a string.
15878 Search is case-insensitive.
15880 If LITERAL-NIL is set, return the string value \"nil\" as
15881 a string, do not interpret it as the list atom nil. This is used
15882 for inheritance when a \"nil\" value can supersede a non-nil
15883 value higher up the hierarchy."
15884 (org-with-point-at pom
15885 (cond
15886 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15887 ;; We need a special property. Use `org-entry-properties' to
15888 ;; retrieve it, but specify the wanted property.
15889 (cdr (assoc-string property (org-entry-properties nil property))))
15890 ((and inherit
15891 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15892 (org-entry-get-with-inheritance property literal-nil))
15894 (let* ((local (org-property--local-values property literal-nil))
15895 (value (and local (mapconcat #'identity (delq nil local) " "))))
15896 (if literal-nil value (org-not-nil value)))))))
15898 (defun org-property-or-variable-value (var &optional inherit)
15899 "Check if there is a property fixing the value of VAR.
15900 If yes, return this value. If not, return the current value of the variable."
15901 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15902 (if (and prop (stringp prop) (string-match "\\S-" prop))
15903 (read prop)
15904 (symbol-value var))))
15906 (defun org-entry-delete (pom property)
15907 "Delete PROPERTY from entry at point-or-marker POM.
15908 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15909 non-nil when a property was removed."
15910 (unless (member property org-special-properties)
15911 (org-with-point-at pom
15912 (let ((range (org-get-property-block)))
15913 (when range
15914 (let* ((begin (car range))
15915 (origin (cdr range))
15916 (end (copy-marker origin))
15917 (re (org-re-property
15918 (concat (regexp-quote property) "\\+?") t t)))
15919 (goto-char begin)
15920 (while (re-search-forward re end t)
15921 (delete-region (match-beginning 0) (line-beginning-position 2)))
15922 ;; If drawer is empty, remove it altogether.
15923 (when (= begin end)
15924 (delete-region (line-beginning-position 0)
15925 (line-beginning-position 2)))
15926 ;; Return non-nil if some property was removed.
15927 (prog1 (/= end origin) (set-marker end nil))))))))
15929 ;; Multi-values properties are properties that contain multiple values
15930 ;; These values are assumed to be single words, separated by whitespace.
15931 (defun org-entry-add-to-multivalued-property (pom property value)
15932 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15933 (let* ((old (org-entry-get pom property))
15934 (values (and old (org-split-string old "[ \t]"))))
15935 (setq value (org-entry-protect-space value))
15936 (unless (member value values)
15937 (setq values (append values (list value)))
15938 (org-entry-put pom property
15939 (mapconcat 'identity values " ")))))
15941 (defun org-entry-remove-from-multivalued-property (pom property value)
15942 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15943 (let* ((old (org-entry-get pom property))
15944 (values (and old (org-split-string old "[ \t]"))))
15945 (setq value (org-entry-protect-space value))
15946 (when (member value values)
15947 (setq values (delete value values))
15948 (org-entry-put pom property
15949 (mapconcat 'identity values " ")))))
15951 (defun org-entry-member-in-multivalued-property (pom property value)
15952 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15953 (let* ((old (org-entry-get pom property))
15954 (values (and old (org-split-string old "[ \t]"))))
15955 (setq value (org-entry-protect-space value))
15956 (member value values)))
15958 (defun org-entry-get-multivalued-property (pom property)
15959 "Return a list of values in a multivalued property."
15960 (let* ((value (org-entry-get pom property))
15961 (values (and value (org-split-string value "[ \t]"))))
15962 (mapcar 'org-entry-restore-space values)))
15964 (defun org-entry-put-multivalued-property (pom property &rest values)
15965 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15966 VALUES should be a list of strings. Spaces will be protected."
15967 (org-entry-put pom property
15968 (mapconcat 'org-entry-protect-space values " "))
15969 (let* ((value (org-entry-get pom property))
15970 (values (and value (org-split-string value "[ \t]"))))
15971 (mapcar 'org-entry-restore-space values)))
15973 (defun org-entry-protect-space (s)
15974 "Protect spaces and newline in string S."
15975 (while (string-match " " s)
15976 (setq s (replace-match "%20" t t s)))
15977 (while (string-match "\n" s)
15978 (setq s (replace-match "%0A" t t s)))
15981 (defun org-entry-restore-space (s)
15982 "Restore spaces and newline in string S."
15983 (while (string-match "%20" s)
15984 (setq s (replace-match " " t t s)))
15985 (while (string-match "%0A" s)
15986 (setq s (replace-match "\n" t t s)))
15989 (defvar org-entry-property-inherited-from (make-marker)
15990 "Marker pointing to the entry from where a property was inherited.
15991 Each call to `org-entry-get-with-inheritance' will set this marker to the
15992 location of the entry where the inheritance search matched. If there was
15993 no match, the marker will point nowhere.
15994 Note that also `org-entry-get' calls this function, if the INHERIT flag
15995 is set.")
15997 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15998 "Get PROPERTY of entry or content at point, search higher levels if needed.
15999 The search will stop at the first ancestor which has the property defined.
16000 If the value found is \"nil\", return nil to show that the property
16001 should be considered as undefined (this is the meaning of nil here).
16002 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16003 (move-marker org-entry-property-inherited-from nil)
16004 (org-with-wide-buffer
16005 (let (value)
16006 (catch 'exit
16007 (while t
16008 (let ((v (org-property--local-values property literal-nil)))
16009 (when v
16010 (setq value
16011 (concat (mapconcat #'identity (delq nil v) " ")
16012 (and value " ")
16013 value)))
16014 (cond
16015 ((car v)
16016 (org-back-to-heading t)
16017 (move-marker org-entry-property-inherited-from (point))
16018 (throw 'exit nil))
16019 ((org-up-heading-safe))
16021 (let ((global
16022 (cdr (or (assoc-string property org-file-properties t)
16023 (assoc-string property org-global-properties t)
16024 (assoc-string property org-global-properties-fixed t)))))
16025 (cond ((not global))
16026 (value (setq value (concat global " " value)))
16027 (t (setq value global))))
16028 (throw 'exit nil))))))
16029 (if literal-nil value (org-not-nil value)))))
16031 (defvar org-property-changed-functions nil
16032 "Hook called when the value of a property has changed.
16033 Each hook function should accept two arguments, the name of the property
16034 and the new value.")
16036 (defun org-entry-put (pom property value)
16037 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16039 If the value is `nil', it is converted to the empty string. If
16040 it is not a string, an error is raised.
16042 PROPERTY can be any regular property (see
16043 `org-special-properties'). It can also be \"TODO\",
16044 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16046 For the last two properties, VALUE may have any of the special
16047 values \"earlier\" and \"later\". The function then increases or
16048 decreases scheduled or deadline date by one day."
16049 (cond ((null value) (setq value ""))
16050 ((not (stringp value)) (error "Properties values should be strings")))
16051 (org-with-point-at pom
16052 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16053 (org-back-to-heading t)
16054 (org-with-limited-levels (org-back-to-heading t)))
16055 (let ((beg (point)))
16056 (cond
16057 ((equal property "TODO")
16058 (cond ((not (org-string-nw-p value)) (setq value 'none))
16059 ((not (member value org-todo-keywords-1))
16060 (user-error "\"%s\" is not a valid TODO state" value)))
16061 (org-todo value)
16062 (org-set-tags nil 'align))
16063 ((equal property "PRIORITY")
16064 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16065 (org-set-tags nil 'align))
16066 ((equal property "SCHEDULED")
16067 (forward-line)
16068 (if (and (org-looking-at-p org-planning-line-re)
16069 (re-search-forward
16070 org-scheduled-time-regexp (line-end-position) t))
16071 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16072 ((string= value "later") (org-timestamp-change 1 'day))
16073 ((string= value "") (org-schedule '(4)))
16074 (t (org-schedule nil value)))
16075 (if (member value '("earlier" "later" ""))
16076 (call-interactively #'org-schedule)
16077 (org-schedule nil value))))
16078 ((equal property "DEADLINE")
16079 (forward-line)
16080 (if (and (org-looking-at-p org-planning-line-re)
16081 (re-search-forward
16082 org-deadline-time-regexp (line-end-position) t))
16083 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16084 ((string= value "later") (org-timestamp-change 1 'day))
16085 ((string= value "") (org-deadline '(4)))
16086 (t (org-deadline nil value)))
16087 (if (member value '("earlier" "later" ""))
16088 (call-interactively #'org-deadline)
16089 (org-deadline nil value))))
16090 ((member property org-special-properties)
16091 (error "The %s property cannot be set with `org-entry-put'" property))
16093 (let* ((range (org-get-property-block beg 'force))
16094 (end (cdr range))
16095 (case-fold-search t))
16096 (goto-char (car range))
16097 (if (re-search-forward (org-re-property property nil t) end t)
16098 (progn (delete-region (match-beginning 0) (match-end 0))
16099 (goto-char (match-beginning 0)))
16100 (goto-char end)
16101 (insert "\n")
16102 (backward-char))
16103 (insert ":" property ":")
16104 (when value (insert " " value))
16105 (org-indent-line)))))
16106 (run-hook-with-args 'org-property-changed-functions property value)))
16108 (defun org-buffer-property-keys (&optional specials defaults columns)
16109 "Get all property keys in the current buffer.
16111 When SPECIALS is non-nil, also list the special properties that
16112 reflect things like tags and TODO state.
16114 When DEFAULTS is non-nil, also include properties that has
16115 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16116 DESCRIPTION, LOCATION, and LOGGING and others.
16118 When COLUMNS in non-nil, also include property names given in
16119 COLUMN formats in the current buffer."
16120 (let ((case-fold-search t)
16121 (props (append
16122 (and specials org-special-properties)
16123 (and defaults (cons org-effort-property org-default-properties))
16124 nil)))
16125 (org-with-wide-buffer
16126 (goto-char (point-min))
16127 (while (re-search-forward org-property-start-re nil t)
16128 (let ((range (org-get-property-block)))
16129 (catch 'skip
16130 (unless range
16131 (when (and (not (org-before-first-heading-p))
16132 (y-or-n-p (format "Malformed drawer at %d, repair?"
16133 (line-beginning-position))))
16134 (org-get-property-block nil t))
16135 (throw 'skip nil))
16136 (goto-char (car range))
16137 (let ((begin (car range))
16138 (end (cdr range)))
16139 ;; Make sure that found property block is not located
16140 ;; before current point, as it would generate an infloop.
16141 ;; It can happen, for example, in the following
16142 ;; situation:
16144 ;; * Headline
16145 ;; :PROPERTIES:
16146 ;; ...
16147 ;; :END:
16148 ;; *************** Inlinetask
16149 ;; #+BEGIN_EXAMPLE
16150 ;; :PROPERTIES:
16151 ;; #+END_EXAMPLE
16153 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16154 (while (< (point) end)
16155 (let ((p (progn (looking-at org-property-re)
16156 (org-match-string-no-properties 2))))
16157 ;; Only add true property name, not extension symbol.
16158 (add-to-list 'props
16159 (if (not (org-string-match-p "\\+\\'" p)) p
16160 (substring p 0 -1))))
16161 (forward-line))))
16162 (outline-next-heading)))
16163 (when columns
16164 (goto-char (point-min))
16165 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16166 (let ((element (org-element-at-point)))
16167 (when (memq (org-element-type element) '(keyword node-property))
16168 (let ((value (org-element-property :value element))
16169 (start 0))
16170 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16171 (setq start (match-end 0))
16172 (let ((p (org-match-string-no-properties 1 value)))
16173 (unless (member-ignore-case p org-special-properties)
16174 (add-to-list 'props p))))))))))
16175 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16177 (defun org-property-values (key)
16178 "List all non-nil values of property KEY in current buffer."
16179 (org-with-wide-buffer
16180 (goto-char (point-min))
16181 (let ((case-fold-search t)
16182 (re (org-re-property key))
16183 values)
16184 (while (re-search-forward re nil t)
16185 (add-to-list 'values (org-entry-get (point) key)))
16186 values)))
16188 (defun org-insert-property-drawer ()
16189 "Insert a property drawer into the current entry."
16190 (org-with-wide-buffer
16191 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16192 (org-back-to-heading t)
16193 (org-with-limited-levels (org-back-to-heading t)))
16194 (forward-line)
16195 (when (org-looking-at-p org-planning-line-re) (forward-line))
16196 (unless (org-looking-at-p org-property-drawer-re)
16197 (let ((inhibit-read-only t))
16198 (unless (bolp) (insert "\n"))
16199 (let ((begin (point)))
16200 (insert ":PROPERTIES:\n:END:\n")
16201 (org-indent-region begin (point)))))))
16203 (defun org-insert-drawer (&optional arg drawer)
16204 "Insert a drawer at point.
16206 When optional argument ARG is non-nil, insert a property drawer.
16208 Optional argument DRAWER, when non-nil, is a string representing
16209 drawer's name. Otherwise, the user is prompted for a name.
16211 If a region is active, insert the drawer around that region
16212 instead.
16214 Point is left between drawer's boundaries."
16215 (interactive "P")
16216 (let* ((drawer (if arg "PROPERTIES"
16217 (or drawer (read-from-minibuffer "Drawer: ")))))
16218 (cond
16219 ;; With C-u, fall back on `org-insert-property-drawer'
16220 (arg (org-insert-property-drawer))
16221 ;; Check validity of suggested drawer's name.
16222 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16223 (user-error "Invalid drawer name"))
16224 ;; With an active region, insert a drawer at point.
16225 ((not (org-region-active-p))
16226 (progn
16227 (unless (bolp) (insert "\n"))
16228 (insert (format ":%s:\n\n:END:\n" drawer))
16229 (forward-line -2)))
16230 ;; Otherwise, insert the drawer at point
16232 (let ((rbeg (region-beginning))
16233 (rend (copy-marker (region-end))))
16234 (unwind-protect
16235 (progn
16236 (goto-char rbeg)
16237 (beginning-of-line)
16238 (when (save-excursion
16239 (re-search-forward org-outline-regexp-bol rend t))
16240 (user-error "Drawers cannot contain headlines"))
16241 ;; Position point at the beginning of the first
16242 ;; non-blank line in region. Insert drawer's opening
16243 ;; there, then indent it.
16244 (org-skip-whitespace)
16245 (beginning-of-line)
16246 (insert ":" drawer ":\n")
16247 (forward-line -1)
16248 (indent-for-tab-command)
16249 ;; Move point to the beginning of the first blank line
16250 ;; after the last non-blank line in region. Insert
16251 ;; drawer's closing, then indent it.
16252 (goto-char rend)
16253 (skip-chars-backward " \r\t\n")
16254 (insert "\n:END:")
16255 (deactivate-mark t)
16256 (indent-for-tab-command)
16257 (unless (eolp) (insert "\n")))
16258 ;; Clear marker, whatever the outcome of insertion is.
16259 (set-marker rend nil)))))))
16261 (defvar org-property-set-functions-alist nil
16262 "Property set function alist.
16263 Each entry should have the following format:
16265 (PROPERTY . READ-FUNCTION)
16267 The read function will be called with the same argument as
16268 `org-completing-read'.")
16270 (defun org-set-property-function (property)
16271 "Get the function that should be used to set PROPERTY.
16272 This is computed according to `org-property-set-functions-alist'."
16273 (or (cdr (assoc property org-property-set-functions-alist))
16274 'org-completing-read))
16276 (defun org-read-property-value (property)
16277 "Read PROPERTY value from user."
16278 (let* ((completion-ignore-case t)
16279 (allowed (org-property-get-allowed-values nil property 'table))
16280 (cur (org-entry-get nil property))
16281 (prompt (concat property " value"
16282 (if (and cur (string-match "\\S-" cur))
16283 (concat " [" cur "]") "") ": "))
16284 (set-function (org-set-property-function property))
16285 (val (if allowed
16286 (funcall set-function prompt allowed nil
16287 (not (get-text-property 0 'org-unrestricted
16288 (caar allowed))))
16289 (let (org-completion-use-ido org-completion-use-iswitchb)
16290 (funcall set-function prompt
16291 (mapcar 'list (org-property-values property))
16292 nil nil "" nil cur)))))
16293 (org-trim val)))
16295 (defvar org-last-set-property nil)
16296 (defvar org-last-set-property-value nil)
16297 (defun org-read-property-name ()
16298 "Read a property name."
16299 (let ((completion-ignore-case t)
16300 (default-prop (or (and (org-at-property-p)
16301 (org-match-string-no-properties 2))
16302 org-last-set-property)))
16303 (org-completing-read
16304 (concat "Property"
16305 (if default-prop (concat " [" default-prop "]") "")
16306 ": ")
16307 (mapcar #'list (org-buffer-property-keys nil t t))
16308 nil nil nil nil default-prop)))
16310 (defun org-set-property-and-value (use-last)
16311 "Allow to set [PROPERTY]: [value] direction from prompt.
16312 When use-default, don't even ask, just use the last
16313 \"[PROPERTY]: [value]\" string from the history."
16314 (interactive "P")
16315 (let* ((completion-ignore-case t)
16316 (pv (or (and use-last org-last-set-property-value)
16317 (org-completing-read
16318 "Enter a \"[Property]: [value]\" pair: "
16319 nil nil nil nil nil
16320 org-last-set-property-value)))
16321 prop val)
16322 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16323 (setq prop (match-string 1 pv)
16324 val (match-string 2 pv))
16325 (org-set-property prop val))))
16327 (defun org-set-property (property value)
16328 "In the current entry, set PROPERTY to VALUE.
16329 When called interactively, this will prompt for a property name, offering
16330 completion on existing and default properties. And then it will prompt
16331 for a value, offering completion either on allowed values (via an inherited
16332 xxx_ALL property) or on existing values in other instances of this property
16333 in the current file."
16334 (interactive (list nil nil))
16335 (let* ((property (or property (org-read-property-name)))
16336 (value (or value (org-read-property-value property)))
16337 (fn (cdr (assoc property org-properties-postprocess-alist))))
16338 (setq org-last-set-property property)
16339 (setq org-last-set-property-value (concat property ": " value))
16340 ;; Possibly postprocess the inserted value:
16341 (when fn (setq value (funcall fn value)))
16342 (unless (equal (org-entry-get nil property) value)
16343 (org-entry-put nil property value))))
16345 (defun org-find-property (property &optional value)
16346 "Find first entry in buffer that sets PROPERTY.
16348 When optional argument VALUE is non-nil, only consider an entry
16349 if it contains PROPERTY set to this value. If PROPERTY should be
16350 explicitly set to nil, use string \"nil\" for VALUE.
16352 Return position where the entry begins, or nil if there is no
16353 such entry. If narrowing is in effect, only search the visible
16354 part of the buffer."
16355 (save-excursion
16356 (goto-char (point-min))
16357 (let ((case-fold-search t)
16358 (re (org-re-property property nil (not value) value)))
16359 (catch 'exit
16360 (while (re-search-forward re nil t)
16361 (when (if value (org-at-property-p)
16362 (org-entry-get (point) property nil t))
16363 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16365 (defun org-delete-property (property)
16366 "In the current entry, delete PROPERTY."
16367 (interactive
16368 (let* ((completion-ignore-case t)
16369 (cat (org-entry-get (point) "CATEGORY"))
16370 (props0 (org-entry-properties nil 'standard))
16371 (props (if cat props0
16372 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16373 (prop (if (< 1 (length props))
16374 (org-icompleting-read "Property: " props nil t)
16375 (caar props))))
16376 (list prop)))
16377 (if (not property)
16378 (message "No property to delete in this entry")
16379 (org-entry-delete nil property)
16380 (message "Property \"%s\" deleted" property)))
16382 (defun org-delete-property-globally (property)
16383 "Remove PROPERTY globally, from all entries.
16384 This function ignores narrowing, if any."
16385 (interactive
16386 (let* ((completion-ignore-case t)
16387 (prop (org-icompleting-read
16388 "Globally remove property: "
16389 (mapcar #'list (org-buffer-property-keys)))))
16390 (list prop)))
16391 (org-with-wide-buffer
16392 (goto-char (point-min))
16393 (let ((count 0)
16394 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16395 (while (re-search-forward re nil t)
16396 (when (org-entry-delete (point) property) (incf count)))
16397 (message "Property \"%s\" removed from %d entries" property count))))
16399 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16401 (defun org-compute-property-at-point ()
16402 "Compute the property at point.
16403 This looks for an enclosing column format, extracts the operator and
16404 then applies it to the property in the column format's scope."
16405 (interactive)
16406 (unless (org-at-property-p)
16407 (user-error "Not at a property"))
16408 (let ((prop (org-match-string-no-properties 2)))
16409 (org-columns-get-format-and-top-level)
16410 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16411 (user-error "No operator defined for property %s" prop))
16412 (org-columns-compute prop)))
16414 (defvar org-property-allowed-value-functions nil
16415 "Hook for functions supplying allowed values for a specific property.
16416 The functions must take a single argument, the name of the property, and
16417 return a flat list of allowed values. If \":ETC\" is one of
16418 the values, this means that these values are intended as defaults for
16419 completion, but that other values should be allowed too.
16420 The functions must return nil if they are not responsible for this
16421 property.")
16423 (defun org-property-get-allowed-values (pom property &optional table)
16424 "Get allowed values for the property PROPERTY.
16425 When TABLE is non-nil, return an alist that can directly be used for
16426 completion."
16427 (let (vals)
16428 (cond
16429 ((equal property "TODO")
16430 (setq vals (org-with-point-at pom
16431 (append org-todo-keywords-1 '("")))))
16432 ((equal property "PRIORITY")
16433 (let ((n org-lowest-priority))
16434 (while (>= n org-highest-priority)
16435 (push (char-to-string n) vals)
16436 (setq n (1- n)))))
16437 ((equal property "CATEGORY"))
16438 ((member property org-special-properties))
16439 ((setq vals (run-hook-with-args-until-success
16440 'org-property-allowed-value-functions property)))
16442 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16443 (when (and vals (string-match "\\S-" vals))
16444 (setq vals (car (read-from-string (concat "(" vals ")"))))
16445 (setq vals (mapcar (lambda (x)
16446 (cond ((stringp x) x)
16447 ((numberp x) (number-to-string x))
16448 ((symbolp x) (symbol-name x))
16449 (t "???")))
16450 vals)))))
16451 (when (member ":ETC" vals)
16452 (setq vals (remove ":ETC" vals))
16453 (org-add-props (car vals) '(org-unrestricted t)))
16454 (if table (mapcar 'list vals) vals)))
16456 (defun org-property-previous-allowed-value (&optional previous)
16457 "Switch to the next allowed value for this property."
16458 (interactive)
16459 (org-property-next-allowed-value t))
16461 (defun org-property-next-allowed-value (&optional previous)
16462 "Switch to the next allowed value for this property."
16463 (interactive)
16464 (unless (org-at-property-p)
16465 (user-error "Not at a property"))
16466 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16467 (key (match-string 2))
16468 (value (match-string 3))
16469 (allowed (or (org-property-get-allowed-values (point) key)
16470 (and (member value '("[ ]" "[-]" "[X]"))
16471 '("[ ]" "[X]"))))
16472 (heading (save-match-data (nth 4 (org-heading-components))))
16473 nval)
16474 (unless allowed
16475 (user-error "Allowed values for this property have not been defined"))
16476 (if previous (setq allowed (reverse allowed)))
16477 (if (member value allowed)
16478 (setq nval (car (cdr (member value allowed)))))
16479 (setq nval (or nval (car allowed)))
16480 (if (equal nval value)
16481 (user-error "Only one allowed value for this property"))
16482 (org-at-property-p)
16483 (replace-match (concat " :" key ": " nval) t t)
16484 (org-indent-line)
16485 (beginning-of-line 1)
16486 (skip-chars-forward " \t")
16487 (when (equal prop org-effort-property)
16488 (org-refresh-property
16489 '((effort . identity)
16490 (effort-minutes . org-duration-string-to-minutes))
16491 nval)
16492 (when (string= org-clock-current-task heading)
16493 (setq org-clock-effort nval)
16494 (org-clock-update-mode-line)))
16495 (run-hook-with-args 'org-property-changed-functions key nval)))
16497 (defun org-find-olp (path &optional this-buffer)
16498 "Return a marker pointing to the entry at outline path OLP.
16499 If anything goes wrong, throw an error.
16500 You can wrap this call to catch the error like this:
16502 (condition-case msg
16503 (org-mobile-locate-entry (match-string 4))
16504 (error (nth 1 msg)))
16506 The return value will then be either a string with the error message,
16507 or a marker if everything is OK.
16509 If THIS-BUFFER is set, the outline path does not contain a file,
16510 only headings."
16511 (let* ((file (if this-buffer buffer-file-name (pop path)))
16512 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16513 (level 1)
16514 (lmin 1)
16515 (lmax 1)
16516 limit re end found pos heading cnt flevel)
16517 (unless buffer (error "File not found :%s" file))
16518 (with-current-buffer buffer
16519 (save-excursion
16520 (save-restriction
16521 (widen)
16522 (setq limit (point-max))
16523 (goto-char (point-min))
16524 (while (setq heading (pop path))
16525 (setq re (format org-complex-heading-regexp-format
16526 (regexp-quote heading)))
16527 (setq cnt 0 pos (point))
16528 (while (re-search-forward re end t)
16529 (setq level (- (match-end 1) (match-beginning 1)))
16530 (if (and (>= level lmin) (<= level lmax))
16531 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16532 (when (= cnt 0) (error "Heading not found on level %d: %s"
16533 lmax heading))
16534 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16535 lmax heading))
16536 (goto-char found)
16537 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16538 (setq end (save-excursion (org-end-of-subtree t t))))
16539 (when (org-at-heading-p)
16540 (point-marker)))))))
16542 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16543 "Find node HEADING in BUFFER.
16544 Return a marker to the heading if it was found, or nil if not.
16545 If POS-ONLY is set, return just the position instead of a marker.
16547 The heading text must match exact, but it may have a TODO keyword,
16548 a priority cookie and tags in the standard locations."
16549 (with-current-buffer (or buffer (current-buffer))
16550 (save-excursion
16551 (save-restriction
16552 (widen)
16553 (goto-char (point-min))
16554 (let (case-fold-search)
16555 (if (re-search-forward
16556 (format org-complex-heading-regexp-format
16557 (regexp-quote heading)) nil t)
16558 (if pos-only
16559 (match-beginning 0)
16560 (move-marker (make-marker) (match-beginning 0)))))))))
16562 (defun org-find-exact-heading-in-directory (heading &optional dir)
16563 "Find Org node headline HEADING in all .org files in directory DIR.
16564 When the target headline is found, return a marker to this location."
16565 (let ((files (directory-files (or dir default-directory)
16566 t "\\`[^.#].*\\.org\\'"))
16567 file visiting m buffer)
16568 (catch 'found
16569 (while (setq file (pop files))
16570 (message "trying %s" file)
16571 (setq visiting (org-find-base-buffer-visiting file))
16572 (setq buffer (or visiting (find-file-noselect file)))
16573 (setq m (org-find-exact-headline-in-buffer
16574 heading buffer))
16575 (when (and (not m) (not visiting)) (kill-buffer buffer))
16576 (and m (throw 'found m))))))
16578 (defun org-find-entry-with-id (ident)
16579 "Locate the entry that contains the ID property with exact value IDENT.
16580 IDENT can be a string, a symbol or a number, this function will search for
16581 the string representation of it.
16582 Return the position where this entry starts, or nil if there is no such entry."
16583 (interactive "sID: ")
16584 (let ((id (cond
16585 ((stringp ident) ident)
16586 ((symbolp ident) (symbol-name ident))
16587 ((numberp ident) (number-to-string ident))
16588 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16589 (org-with-wide-buffer (org-find-property "ID" id))))
16591 ;;;; Timestamps
16593 (defvar org-last-changed-timestamp nil)
16594 (defvar org-last-inserted-timestamp nil
16595 "The last time stamp inserted with `org-insert-time-stamp'.")
16596 (defvar org-ts-what) ; dynamically scoped parameter
16598 (defun org-time-stamp (arg &optional inactive)
16599 "Prompt for a date/time and insert a time stamp.
16601 If the user specifies a time like HH:MM or if this command is
16602 called with at least one prefix argument, the time stamp contains
16603 the date and the time. Otherwise, only the date is included.
16605 All parts of a date not specified by the user are filled in from
16606 the timestamp at point, if any, or the current date/time
16607 otherwise.
16609 If there is already a timestamp at the cursor, it is replaced.
16611 With two universal prefix arguments, insert an active timestamp
16612 with the current time without prompting the user.
16614 When called from lisp, the timestamp is inactive if INACTIVE is
16615 non-nil."
16616 (interactive "P")
16617 (let* ((ts
16618 (cond ((org-at-date-range-p t)
16619 (save-excursion
16620 (goto-char (match-beginning 0))
16621 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16622 (match-string 0))
16623 ((org-at-timestamp-p t) (match-string 0))))
16624 ;; Default time is either the timestamp at point or today.
16625 ;; When entering a range, only the range start is considered.
16626 (default-time (if (not ts) (current-time)
16627 (apply #'encode-time (org-parse-time-string ts))))
16628 (default-input (and ts (org-get-compact-tod ts)))
16629 (repeater (and ts
16630 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16631 (match-string 0 ts)))
16632 org-time-was-given
16633 org-end-time-was-given
16634 (time
16635 (and (if (equal arg '(16)) (current-time)
16636 ;; Preserve `this-command' and `last-command'.
16637 (let ((this-command this-command)
16638 (last-command last-command))
16639 (org-read-date
16640 arg 'totime nil nil default-time default-input
16641 inactive))))))
16642 (cond
16643 ((and ts
16644 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16645 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16646 (insert "--")
16647 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16649 ;; Make sure we're on a timestamp. When in the middle of a date
16650 ;; range, move arbitrarily to range end.
16651 (unless (org-at-timestamp-p t)
16652 (skip-chars-forward "-")
16653 (org-at-timestamp-p t))
16654 (replace-match "")
16655 (setq org-last-changed-timestamp
16656 (org-insert-time-stamp
16657 time (or org-time-was-given arg)
16658 inactive nil nil (list org-end-time-was-given)))
16659 (when repeater
16660 (backward-char)
16661 (insert " " repeater)
16662 (setq org-last-changed-timestamp
16663 (concat (substring org-last-inserted-timestamp 0 -1)
16664 " " repeater ">")))
16665 (message "Timestamp updated"))
16666 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16667 (t (org-insert-time-stamp
16668 time (or org-time-was-given arg) inactive nil nil
16669 (list org-end-time-was-given))))))
16671 ;; FIXME: can we use this for something else, like computing time differences?
16672 (defun org-get-compact-tod (s)
16673 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16674 (let* ((t1 (match-string 1 s))
16675 (h1 (string-to-number (match-string 2 s)))
16676 (m1 (string-to-number (match-string 3 s)))
16677 (t2 (and (match-end 4) (match-string 5 s)))
16678 (h2 (and t2 (string-to-number (match-string 6 s))))
16679 (m2 (and t2 (string-to-number (match-string 7 s))))
16680 dh dm)
16681 (if (not t2)
16683 (setq dh (- h2 h1) dm (- m2 m1))
16684 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16685 (concat t1 "+" (number-to-string dh)
16686 (and (/= 0 dm) (format ":%02d" dm)))))))
16688 (defun org-time-stamp-inactive (&optional arg)
16689 "Insert an inactive time stamp.
16690 An inactive time stamp is enclosed in square brackets instead of angle
16691 brackets. It is inactive in the sense that it does not trigger agenda entries,
16692 does not link to the calendar and cannot be changed with the S-cursor keys.
16693 So these are more for recording a certain time/date."
16694 (interactive "P")
16695 (org-time-stamp arg 'inactive))
16697 (defvar org-date-ovl (make-overlay 1 1))
16698 (overlay-put org-date-ovl 'face 'org-date-selected)
16699 (org-detach-overlay org-date-ovl)
16701 (defvar org-ans1) ; dynamically scoped parameter
16702 (defvar org-ans2) ; dynamically scoped parameter
16704 (defvar org-plain-time-of-day-regexp) ; defined below
16706 (defvar org-overriding-default-time nil) ; dynamically scoped
16707 (defvar org-read-date-overlay nil)
16708 (defvar org-dcst nil) ; dynamically scoped
16709 (defvar org-read-date-history nil)
16710 (defvar org-read-date-final-answer nil)
16711 (defvar org-read-date-analyze-futurep nil)
16712 (defvar org-read-date-analyze-forced-year nil)
16713 (defvar org-read-date-inactive)
16715 (defvar org-read-date-minibuffer-local-map
16716 (let* ((map (make-sparse-keymap)))
16717 (set-keymap-parent map minibuffer-local-map)
16718 (org-defkey map (kbd ".")
16719 (lambda () (interactive)
16720 ;; Are we at the beginning of the prompt?
16721 (if (looking-back "^[^:]+: ")
16722 (org-eval-in-calendar '(calendar-goto-today))
16723 (insert "."))))
16724 (org-defkey map (kbd "C-.")
16725 (lambda () (interactive)
16726 (org-eval-in-calendar '(calendar-goto-today))))
16727 (org-defkey map [(meta shift left)]
16728 (lambda () (interactive)
16729 (org-eval-in-calendar '(calendar-backward-month 1))))
16730 (org-defkey map [(meta shift right)]
16731 (lambda () (interactive)
16732 (org-eval-in-calendar '(calendar-forward-month 1))))
16733 (org-defkey map [(meta shift up)]
16734 (lambda () (interactive)
16735 (org-eval-in-calendar '(calendar-backward-year 1))))
16736 (org-defkey map [(meta shift down)]
16737 (lambda () (interactive)
16738 (org-eval-in-calendar '(calendar-forward-year 1))))
16739 (org-defkey map [?\e (shift left)]
16740 (lambda () (interactive)
16741 (org-eval-in-calendar '(calendar-backward-month 1))))
16742 (org-defkey map [?\e (shift right)]
16743 (lambda () (interactive)
16744 (org-eval-in-calendar '(calendar-forward-month 1))))
16745 (org-defkey map [?\e (shift up)]
16746 (lambda () (interactive)
16747 (org-eval-in-calendar '(calendar-backward-year 1))))
16748 (org-defkey map [?\e (shift down)]
16749 (lambda () (interactive)
16750 (org-eval-in-calendar '(calendar-forward-year 1))))
16751 (org-defkey map [(shift up)]
16752 (lambda () (interactive)
16753 (org-eval-in-calendar '(calendar-backward-week 1))))
16754 (org-defkey map [(shift down)]
16755 (lambda () (interactive)
16756 (org-eval-in-calendar '(calendar-forward-week 1))))
16757 (org-defkey map [(shift left)]
16758 (lambda () (interactive)
16759 (org-eval-in-calendar '(calendar-backward-day 1))))
16760 (org-defkey map [(shift right)]
16761 (lambda () (interactive)
16762 (org-eval-in-calendar '(calendar-forward-day 1))))
16763 (org-defkey map "!"
16764 (lambda () (interactive)
16765 (org-eval-in-calendar '(diary-view-entries))
16766 (message "")))
16767 (org-defkey map ">"
16768 (lambda () (interactive)
16769 (org-eval-in-calendar '(calendar-scroll-left 1))))
16770 (org-defkey map "<"
16771 (lambda () (interactive)
16772 (org-eval-in-calendar '(calendar-scroll-right 1))))
16773 (org-defkey map "\C-v"
16774 (lambda () (interactive)
16775 (org-eval-in-calendar
16776 '(calendar-scroll-left-three-months 1))))
16777 (org-defkey map "\M-v"
16778 (lambda () (interactive)
16779 (org-eval-in-calendar
16780 '(calendar-scroll-right-three-months 1))))
16781 map)
16782 "Keymap for minibuffer commands when using `org-read-date'.")
16784 (defvar org-def)
16785 (defvar org-defdecode)
16786 (defvar org-with-time)
16788 (defun org-read-date (&optional org-with-time to-time from-string prompt
16789 default-time default-input inactive)
16790 "Read a date, possibly a time, and make things smooth for the user.
16791 The prompt will suggest to enter an ISO date, but you can also enter anything
16792 which will at least partially be understood by `parse-time-string'.
16793 Unrecognized parts of the date will default to the current day, month, year,
16794 hour and minute. If this command is called to replace a timestamp at point,
16795 or to enter the second timestamp of a range, the default time is taken
16796 from the existing stamp. Furthermore, the command prefers the future,
16797 so if you are giving a date where the year is not given, and the day-month
16798 combination is already past in the current year, it will assume you
16799 mean next year. For details, see the manual. A few examples:
16801 3-2-5 --> 2003-02-05
16802 feb 15 --> currentyear-02-15
16803 2/15 --> currentyear-02-15
16804 sep 12 9 --> 2009-09-12
16805 12:45 --> today 12:45
16806 22 sept 0:34 --> currentyear-09-22 0:34
16807 12 --> currentyear-currentmonth-12
16808 Fri --> nearest Friday after today
16809 -Tue --> last Tuesday
16810 etc.
16812 Furthermore you can specify a relative date by giving, as the *first* thing
16813 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16814 change in days weeks, months, years.
16815 With a single plus or minus, the date is relative to today. With a double
16816 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16817 +4d --> four days from today
16818 +4 --> same as above
16819 +2w --> two weeks from today
16820 ++5 --> five days from default date
16822 The function understands only English month and weekday abbreviations.
16824 While prompting, a calendar is popped up - you can also select the
16825 date with the mouse (button 1). The calendar shows a period of three
16826 months. To scroll it to other months, use the keys `>' and `<'.
16827 If you don't like the calendar, turn it off with
16828 \(setq org-read-date-popup-calendar nil)
16830 With optional argument TO-TIME, the date will immediately be converted
16831 to an internal time.
16832 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16833 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16834 still enter a time, and this function will inform the calling routine
16835 about this change. The calling routine may then choose to change the
16836 format used to insert the time stamp into the buffer to include the time.
16837 With optional argument FROM-STRING, read from this string instead from
16838 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16839 the time/date that is used for everything that is not specified by the
16840 user."
16841 (require 'parse-time)
16842 (let* ((org-time-stamp-rounding-minutes
16843 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16844 (org-dcst org-display-custom-times)
16845 (ct (org-current-time))
16846 (org-def (or org-overriding-default-time default-time ct))
16847 (org-defdecode (decode-time org-def))
16848 (dummy (progn
16849 (when (< (nth 2 org-defdecode) org-extend-today-until)
16850 (setcar (nthcdr 2 org-defdecode) -1)
16851 (setcar (nthcdr 1 org-defdecode) 59)
16852 (setq org-def (apply 'encode-time org-defdecode)
16853 org-defdecode (decode-time org-def)))))
16854 (cur-frame (selected-frame))
16855 (mouse-autoselect-window nil) ; Don't let the mouse jump
16856 (calendar-frame-setup nil)
16857 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16858 (calendar-move-hook nil)
16859 (calendar-view-diary-initially-flag nil)
16860 (calendar-view-holidays-initially-flag nil)
16861 (timestr (format-time-string
16862 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16863 (prompt (concat (if prompt (concat prompt " ") "")
16864 (format "Date+time [%s]: " timestr)))
16865 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16867 (cond
16868 (from-string (setq ans from-string))
16869 (org-read-date-popup-calendar
16870 (save-excursion
16871 (save-window-excursion
16872 (calendar)
16873 (when (eq calendar-setup 'calendar-only)
16874 (setq cal-frame
16875 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16876 (select-frame cal-frame))
16877 (org-eval-in-calendar '(setq cursor-type nil) t)
16878 (unwind-protect
16879 (progn
16880 (calendar-forward-day (- (time-to-days org-def)
16881 (calendar-absolute-from-gregorian
16882 (calendar-current-date))))
16883 (org-eval-in-calendar nil t)
16884 (let* ((old-map (current-local-map))
16885 (map (copy-keymap calendar-mode-map))
16886 (minibuffer-local-map
16887 (copy-keymap org-read-date-minibuffer-local-map)))
16888 (org-defkey map (kbd "RET") 'org-calendar-select)
16889 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16890 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16891 (unwind-protect
16892 (progn
16893 (use-local-map map)
16894 (setq org-read-date-inactive inactive)
16895 (add-hook 'post-command-hook 'org-read-date-display)
16896 (setq org-ans0 (read-string prompt default-input
16897 'org-read-date-history nil))
16898 ;; org-ans0: from prompt
16899 ;; org-ans1: from mouse click
16900 ;; org-ans2: from calendar motion
16901 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16902 (remove-hook 'post-command-hook 'org-read-date-display)
16903 (use-local-map old-map)
16904 (when org-read-date-overlay
16905 (delete-overlay org-read-date-overlay)
16906 (setq org-read-date-overlay nil)))))
16907 (bury-buffer "*Calendar*")
16908 (when cal-frame
16909 (delete-frame cal-frame)
16910 (select-frame-set-input-focus cur-frame))))))
16912 (t ; Naked prompt only
16913 (unwind-protect
16914 (setq ans (read-string prompt default-input
16915 'org-read-date-history timestr))
16916 (when org-read-date-overlay
16917 (delete-overlay org-read-date-overlay)
16918 (setq org-read-date-overlay nil)))))
16920 (setq final (org-read-date-analyze ans org-def org-defdecode))
16922 (when org-read-date-analyze-forced-year
16923 (message "Year was forced into %s"
16924 (if org-read-date-force-compatible-dates
16925 "compatible range (1970-2037)"
16926 "range representable on this machine"))
16927 (ding))
16929 ;; One round trip to get rid of 34th of August and stuff like that....
16930 (setq final (decode-time (apply 'encode-time final)))
16932 (setq org-read-date-final-answer ans)
16934 (if to-time
16935 (apply 'encode-time final)
16936 (if (and (boundp 'org-time-was-given) org-time-was-given)
16937 (format "%04d-%02d-%02d %02d:%02d"
16938 (nth 5 final) (nth 4 final) (nth 3 final)
16939 (nth 2 final) (nth 1 final))
16940 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16942 (defun org-read-date-display ()
16943 "Display the current date prompt interpretation in the minibuffer."
16944 (when org-read-date-display-live
16945 (when org-read-date-overlay
16946 (delete-overlay org-read-date-overlay))
16947 (when (minibufferp (current-buffer))
16948 (save-excursion
16949 (end-of-line 1)
16950 (while (not (equal (buffer-substring
16951 (max (point-min) (- (point) 4)) (point))
16952 " "))
16953 (insert " ")))
16954 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16955 " " (or org-ans1 org-ans2)))
16956 (org-end-time-was-given nil)
16957 (f (org-read-date-analyze ans org-def org-defdecode))
16958 (fmts (if org-dcst
16959 org-time-stamp-custom-formats
16960 org-time-stamp-formats))
16961 (fmt (if (or org-with-time
16962 (and (boundp 'org-time-was-given) org-time-was-given))
16963 (cdr fmts)
16964 (car fmts)))
16965 (txt (format-time-string fmt (apply 'encode-time f)))
16966 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16967 (txt (concat "=> " txt)))
16968 (when (and org-end-time-was-given
16969 (string-match org-plain-time-of-day-regexp txt))
16970 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16971 org-end-time-was-given
16972 (substring txt (match-end 0)))))
16973 (when org-read-date-analyze-futurep
16974 (setq txt (concat txt " (=>F)")))
16975 (setq org-read-date-overlay
16976 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16977 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16979 (defun org-read-date-analyze (ans org-def org-defdecode)
16980 "Analyze the combined answer of the date prompt."
16981 ;; FIXME: cleanup and comment
16982 (let ((nowdecode (decode-time (current-time)))
16983 delta deltan deltaw deltadef year month day
16984 hour minute second wday pm h2 m2 tl wday1
16985 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16986 (setq org-read-date-analyze-futurep nil
16987 org-read-date-analyze-forced-year nil)
16988 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16989 (setq ans "+0"))
16991 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16992 (setq ans (replace-match "" t t ans)
16993 deltan (car delta)
16994 deltaw (nth 1 delta)
16995 deltadef (nth 2 delta)))
16997 ;; Check if there is an iso week date in there. If yes, store the
16998 ;; info and postpone interpreting it until the rest of the parsing
16999 ;; is done.
17000 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17001 (setq iso-year (if (match-end 1)
17002 (org-small-year-to-year
17003 (string-to-number (match-string 1 ans))))
17004 iso-weekday (if (match-end 3)
17005 (string-to-number (match-string 3 ans)))
17006 iso-week (string-to-number (match-string 2 ans)))
17007 (setq ans (replace-match "" t t ans)))
17009 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17010 (when (string-match
17011 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17012 (setq year (if (match-end 2)
17013 (string-to-number (match-string 2 ans))
17014 (progn (setq kill-year t)
17015 (string-to-number (format-time-string "%Y"))))
17016 month (string-to-number (match-string 3 ans))
17017 day (string-to-number (match-string 4 ans)))
17018 (if (< year 100) (setq year (+ 2000 year)))
17019 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17020 t nil ans)))
17022 ;; Help matching dotted european dates
17023 (when (string-match
17024 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17025 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17026 (setq kill-year t)
17027 (string-to-number (format-time-string "%Y")))
17028 day (string-to-number (match-string 1 ans))
17029 month (string-to-number (match-string 2 ans))
17030 ans (replace-match (format "%04d-%02d-%02d" year month day)
17031 t nil ans)))
17033 ;; Help matching american dates, like 5/30 or 5/30/7
17034 (when (string-match
17035 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17036 (setq year (if (match-end 4)
17037 (string-to-number (match-string 4 ans))
17038 (progn (setq kill-year t)
17039 (string-to-number (format-time-string "%Y"))))
17040 month (string-to-number (match-string 1 ans))
17041 day (string-to-number (match-string 2 ans)))
17042 (if (< year 100) (setq year (+ 2000 year)))
17043 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17044 t nil ans)))
17045 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17046 ;; If there is a time with am/pm, and *no* time without it, we convert
17047 ;; so that matching will be successful.
17048 (loop for i from 1 to 2 do ; twice, for end time as well
17049 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17050 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17051 (setq hour (string-to-number (match-string 1 ans))
17052 minute (if (match-end 3)
17053 (string-to-number (match-string 3 ans))
17055 pm (equal ?p
17056 (string-to-char (downcase (match-string 4 ans)))))
17057 (if (and (= hour 12) (not pm))
17058 (setq hour 0)
17059 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17060 (setq ans (replace-match (format "%02d:%02d" hour minute)
17061 t t ans))))
17063 ;; Check if a time range is given as a duration
17064 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17065 (setq hour (string-to-number (match-string 1 ans))
17066 h2 (+ hour (string-to-number (match-string 3 ans)))
17067 minute (string-to-number (match-string 2 ans))
17068 m2 (+ minute (if (match-end 5) (string-to-number
17069 (match-string 5 ans))0)))
17070 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17071 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17072 t t ans)))
17074 ;; Check if there is a time range
17075 (when (boundp 'org-end-time-was-given)
17076 (setq org-time-was-given nil)
17077 (when (and (string-match org-plain-time-of-day-regexp ans)
17078 (match-end 8))
17079 (setq org-end-time-was-given (match-string 8 ans))
17080 (setq ans (concat (substring ans 0 (match-beginning 7))
17081 (substring ans (match-end 7))))))
17083 (setq tl (parse-time-string ans)
17084 day (or (nth 3 tl) (nth 3 org-defdecode))
17085 month
17086 (cond ((nth 4 tl))
17087 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17088 ;; Day was specified. Make sure DAY+MONTH
17089 ;; combination happens in the future.
17090 ((nth 3 tl)
17091 (setq futurep t)
17092 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17093 (nth 4 nowdecode)))
17094 (t (nth 4 org-defdecode)))
17095 year
17096 (cond ((and (not kill-year) (nth 5 tl)))
17097 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17098 ;; Month was guessed in the future and is at least
17099 ;; equal to NOWDECODE's. Fix year accordingly.
17100 (futurep
17101 (if (or (> month (nth 4 nowdecode))
17102 (>= day (nth 3 nowdecode)))
17103 (nth 5 nowdecode)
17104 (1+ (nth 5 nowdecode))))
17105 ;; Month was specified. Make sure MONTH+YEAR
17106 ;; combination happens in the future.
17107 ((nth 4 tl)
17108 (setq futurep t)
17109 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17110 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17111 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17112 (t (nth 5 nowdecode))))
17113 (t (nth 5 org-defdecode)))
17114 hour (or (nth 2 tl) (nth 2 org-defdecode))
17115 minute (or (nth 1 tl) (nth 1 org-defdecode))
17116 second (or (nth 0 tl) 0)
17117 wday (nth 6 tl))
17119 (when (and (eq org-read-date-prefer-future 'time)
17120 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17121 (equal day (nth 3 nowdecode))
17122 (equal month (nth 4 nowdecode))
17123 (equal year (nth 5 nowdecode))
17124 (nth 2 tl)
17125 (or (< (nth 2 tl) (nth 2 nowdecode))
17126 (and (= (nth 2 tl) (nth 2 nowdecode))
17127 (nth 1 tl)
17128 (< (nth 1 tl) (nth 1 nowdecode)))))
17129 (setq day (1+ day)
17130 futurep t))
17132 ;; Special date definitions below
17133 (cond
17134 (iso-week
17135 ;; There was an iso week
17136 (require 'cal-iso)
17137 (setq futurep nil)
17138 (setq year (or iso-year year)
17139 day (or iso-weekday wday 1)
17140 wday nil ; to make sure that the trigger below does not match
17141 iso-date (calendar-gregorian-from-absolute
17142 (calendar-iso-to-absolute
17143 (list iso-week day year))))
17144 ; FIXME: Should we also push ISO weeks into the future?
17145 ; (when (and org-read-date-prefer-future
17146 ; (not iso-year)
17147 ; (< (calendar-absolute-from-gregorian iso-date)
17148 ; (time-to-days (current-time))))
17149 ; (setq year (1+ year)
17150 ; iso-date (calendar-gregorian-from-absolute
17151 ; (calendar-iso-to-absolute
17152 ; (list iso-week day year)))))
17153 (setq month (car iso-date)
17154 year (nth 2 iso-date)
17155 day (nth 1 iso-date)))
17156 (deltan
17157 (setq futurep nil)
17158 (unless deltadef
17159 (let ((now (decode-time (current-time))))
17160 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17161 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17162 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17163 ((equal deltaw "m") (setq month (+ month deltan)))
17164 ((equal deltaw "y") (setq year (+ year deltan)))))
17165 ((and wday (not (nth 3 tl)))
17166 ;; Weekday was given, but no day, so pick that day in the week
17167 ;; on or after the derived date.
17168 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17169 (unless (equal wday wday1)
17170 (setq day (+ day (% (- wday wday1 -7) 7))))))
17171 (if (and (boundp 'org-time-was-given)
17172 (nth 2 tl))
17173 (setq org-time-was-given t))
17174 (if (< year 100) (setq year (+ 2000 year)))
17175 ;; Check of the date is representable
17176 (if org-read-date-force-compatible-dates
17177 (progn
17178 (if (< year 1970)
17179 (setq year 1970 org-read-date-analyze-forced-year t))
17180 (if (> year 2037)
17181 (setq year 2037 org-read-date-analyze-forced-year t)))
17182 (condition-case nil
17183 (ignore (encode-time second minute hour day month year))
17184 (error
17185 (setq year (nth 5 org-defdecode))
17186 (setq org-read-date-analyze-forced-year t))))
17187 (setq org-read-date-analyze-futurep futurep)
17188 (list second minute hour day month year)))
17190 (defvar parse-time-weekdays)
17191 (defun org-read-date-get-relative (s today default)
17192 "Check string S for special relative date string.
17193 TODAY and DEFAULT are internal times, for today and for a default.
17194 Return shift list (N what def-flag)
17195 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17196 N is the number of WHATs to shift.
17197 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17198 the DEFAULT date rather than TODAY."
17199 (require 'parse-time)
17200 (when (and
17201 (string-match
17202 (concat
17203 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17204 "\\([0-9]+\\)?"
17205 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17206 "\\([ \t]\\|$\\)") s)
17207 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17208 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17209 (string-to-char (substring (match-string 1 s) -1))
17210 ?+))
17211 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17212 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17213 (what (if (match-end 3) (match-string 3 s) "d"))
17214 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17215 (date (if rel default today))
17216 (wday (nth 6 (decode-time date)))
17217 delta)
17218 (if wday1
17219 (progn
17220 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17221 (if (= delta 0) (setq delta 7))
17222 (if (= dir ?-)
17223 (progn
17224 (setq delta (- delta 7))
17225 (if (= delta 0) (setq delta -7))))
17226 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17227 (list delta "d" rel))
17228 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17230 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17231 "Turn a user-specified date into the internal representation.
17232 The internal representation needed by the calendar is (month day year).
17233 This is a wrapper to handle the brain-dead convention in calendar that
17234 user function argument order change dependent on argument order."
17235 (if (boundp 'calendar-date-style)
17236 (cond
17237 ((eq calendar-date-style 'american)
17238 (list arg1 arg2 arg3))
17239 ((eq calendar-date-style 'european)
17240 (list arg2 arg1 arg3))
17241 ((eq calendar-date-style 'iso)
17242 (list arg2 arg3 arg1)))
17243 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17244 (if (org-bound-and-true-p european-calendar-style)
17245 (list arg2 arg1 arg3)
17246 (list arg1 arg2 arg3)))))
17248 (defun org-eval-in-calendar (form &optional keepdate)
17249 "Eval FORM in the calendar window and return to current window.
17250 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17251 otherwise stick to the current value of `org-ans2'."
17252 (let ((sf (selected-frame))
17253 (sw (selected-window)))
17254 (select-window (get-buffer-window "*Calendar*" t))
17255 (eval form)
17256 (when (and (not keepdate) (calendar-cursor-to-date))
17257 (let* ((date (calendar-cursor-to-date))
17258 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17259 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17260 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17261 (select-window sw)
17262 (org-select-frame-set-input-focus sf)))
17264 (defun org-calendar-select ()
17265 "Return to `org-read-date' with the date currently selected.
17266 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17267 (interactive)
17268 (when (calendar-cursor-to-date)
17269 (let* ((date (calendar-cursor-to-date))
17270 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17271 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17272 (if (active-minibuffer-window) (exit-minibuffer))))
17274 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17275 "Insert a date stamp for the date given by the internal TIME.
17276 See `format-time-string' for the format of TIME.
17277 WITH-HM means use the stamp format that includes the time of the day.
17278 INACTIVE means use square brackets instead of angular ones, so that the
17279 stamp will not contribute to the agenda.
17280 PRE and POST are optional strings to be inserted before and after the
17281 stamp.
17282 The command returns the inserted time stamp."
17283 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17284 stamp)
17285 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17286 (insert-before-markers (or pre ""))
17287 (when (listp extra)
17288 (setq extra (car extra))
17289 (if (and (stringp extra)
17290 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17291 (setq extra (format "-%02d:%02d"
17292 (string-to-number (match-string 1 extra))
17293 (string-to-number (match-string 2 extra))))
17294 (setq extra nil)))
17295 (when extra
17296 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17297 (insert-before-markers (setq stamp (format-time-string fmt time)))
17298 (insert-before-markers (or post ""))
17299 (setq org-last-inserted-timestamp stamp)))
17301 (defun org-toggle-time-stamp-overlays ()
17302 "Toggle the use of custom time stamp formats."
17303 (interactive)
17304 (setq org-display-custom-times (not org-display-custom-times))
17305 (unless org-display-custom-times
17306 (let ((p (point-min)) (bmp (buffer-modified-p)))
17307 (while (setq p (next-single-property-change p 'display))
17308 (if (and (get-text-property p 'display)
17309 (eq (get-text-property p 'face) 'org-date))
17310 (remove-text-properties
17311 p (setq p (next-single-property-change p 'display))
17312 '(display t))))
17313 (set-buffer-modified-p bmp)))
17314 (if (featurep 'xemacs)
17315 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17316 (org-restart-font-lock)
17317 (setq org-table-may-need-update t)
17318 (if org-display-custom-times
17319 (message "Time stamps are overlaid with custom format")
17320 (message "Time stamp overlays removed")))
17322 (defun org-display-custom-time (beg end)
17323 "Overlay modified time stamp format over timestamp between BEG and END."
17324 (let* ((ts (buffer-substring beg end))
17325 t1 w1 with-hm tf time str w2 (off 0))
17326 (save-match-data
17327 (setq t1 (org-parse-time-string ts t))
17328 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17329 (setq off (- (match-end 0) (match-beginning 0)))))
17330 (setq end (- end off))
17331 (setq w1 (- end beg)
17332 with-hm (and (nth 1 t1) (nth 2 t1))
17333 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17334 time (org-fix-decoded-time t1)
17335 str (org-add-props
17336 (format-time-string
17337 (substring tf 1 -1) (apply 'encode-time time))
17338 nil 'mouse-face 'highlight)
17339 w2 (length str))
17340 (if (not (= w2 w1))
17341 (add-text-properties (1+ beg) (+ 2 beg)
17342 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17343 (if (featurep 'xemacs)
17344 (progn
17345 (put-text-property beg end 'invisible t)
17346 (put-text-property beg end 'end-glyph (make-glyph str)))
17347 (put-text-property beg end 'display str))))
17349 (defun org-fix-decoded-time (time)
17350 "Set 0 instead of nil for the first 6 elements of time.
17351 Don't touch the rest."
17352 (let ((n 0))
17353 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17355 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17357 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17358 "Difference between TIMESTAMP-STRING and now in days.
17359 If SECONDS is non-nil, return the difference in seconds."
17360 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17361 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17362 (funcall fdiff (current-time)))))
17364 (defun org-deadline-close (timestamp-string &optional ndays)
17365 "Is the time in TIMESTAMP-STRING close to the current date?"
17366 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17367 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17368 (not (org-entry-is-done-p))))
17370 (defun org-get-wdays (ts &optional delay zero-delay)
17371 "Get the deadline lead time appropriate for timestring TS.
17372 When DELAY is non-nil, get the delay time for scheduled items
17373 instead of the deadline lead time. When ZERO-DELAY is non-nil
17374 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17375 don't try to find the delay cookie in the scheduled timestamp."
17376 (let ((tv (if delay org-scheduled-delay-days
17377 org-deadline-warning-days)))
17378 (cond
17379 ((or (and delay (< tv 0))
17380 (and delay zero-delay (<= tv 0))
17381 (and (not delay) (<= tv 0)))
17382 ;; Enforce this value no matter what
17383 (- tv))
17384 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17385 ;; lead time is specified.
17386 (floor (* (string-to-number (match-string 1 ts))
17387 (cdr (assoc (match-string 2 ts)
17388 '(("d" . 1) ("w" . 7)
17389 ("m" . 30.4) ("y" . 365.25)
17390 ("h" . 0.041667)))))))
17391 ;; go for the default.
17392 (t tv))))
17394 (defun org-calendar-select-mouse (ev)
17395 "Return to `org-read-date' with the date currently selected.
17396 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17397 (interactive "e")
17398 (mouse-set-point ev)
17399 (when (calendar-cursor-to-date)
17400 (let* ((date (calendar-cursor-to-date))
17401 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17402 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17403 (if (active-minibuffer-window) (exit-minibuffer))))
17405 (defun org-check-deadlines (ndays)
17406 "Check if there are any deadlines due or past due.
17407 A deadline is considered due if it happens within `org-deadline-warning-days'
17408 days from today's date. If the deadline appears in an entry marked DONE,
17409 it is not shown. The prefix arg NDAYS can be used to test that many
17410 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17411 (interactive "P")
17412 (let* ((org-warn-days
17413 (cond
17414 ((equal ndays '(4)) 100000)
17415 (ndays (prefix-numeric-value ndays))
17416 (t (abs org-deadline-warning-days))))
17417 (case-fold-search nil)
17418 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17419 (callback
17420 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17422 (message "%d deadlines past-due or due within %d days"
17423 (org-occur regexp nil callback)
17424 org-warn-days)))
17426 (defsubst org-re-timestamp (type)
17427 "Return a regexp for timestamp TYPE.
17428 Allowed values for TYPE are:
17430 all: all timestamps
17431 active: only active timestamps (<...>)
17432 inactive: only inactive timestamps ([...])
17433 scheduled: only scheduled timestamps
17434 deadline: only deadline timestamps
17435 closed: only closed time-stamps
17437 When TYPE is nil, fall back on returning a regexp that matches
17438 both scheduled and deadline timestamps."
17439 (case type
17440 (all org-ts-regexp-both)
17441 (active org-ts-regexp)
17442 (inactive org-ts-regexp-inactive)
17443 (scheduled org-scheduled-time-regexp)
17444 (deadline org-deadline-time-regexp)
17445 (closed org-closed-time-regexp)
17446 (otherwise
17447 (concat "\\<"
17448 (regexp-opt (list org-deadline-string org-scheduled-string))
17449 " *<\\([^>]+\\)>"))))
17451 (defun org-check-before-date (date)
17452 "Check if there are deadlines or scheduled entries before DATE."
17453 (interactive (list (org-read-date)))
17454 (let ((case-fold-search nil)
17455 (regexp (org-re-timestamp org-ts-type))
17456 (callback
17457 `(lambda ()
17458 (and ,(if (memq org-ts-type '(active inactive all))
17459 '(eq (org-element-type (org-element-context)) 'timestamp)
17460 '(org-at-planning-p))
17461 (time-less-p
17462 (org-time-string-to-time (match-string 1))
17463 (org-time-string-to-time date))))))
17464 (message "%d entries before %s"
17465 (org-occur regexp nil callback) date)))
17467 (defun org-check-after-date (date)
17468 "Check if there are deadlines or scheduled entries after DATE."
17469 (interactive (list (org-read-date)))
17470 (let ((case-fold-search nil)
17471 (regexp (org-re-timestamp org-ts-type))
17472 (callback
17473 `(lambda ()
17474 (and ,(if (memq org-ts-type '(active inactive all))
17475 '(eq (org-element-type (org-element-context)) 'timestamp)
17476 '(org-at-planning-p))
17477 (not (time-less-p
17478 (org-time-string-to-time (match-string 1))
17479 (org-time-string-to-time date)))))))
17480 (message "%d entries after %s"
17481 (org-occur regexp nil callback) date)))
17483 (defun org-check-dates-range (start-date end-date)
17484 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17485 (interactive (list (org-read-date nil nil nil "Range starts")
17486 (org-read-date nil nil nil "Range end")))
17487 (let ((case-fold-search nil)
17488 (regexp (org-re-timestamp org-ts-type))
17489 (callback
17490 `(lambda ()
17491 (let ((match (match-string 1)))
17492 (and
17493 ,(if (memq org-ts-type '(active inactive all))
17494 '(eq (org-element-type (org-element-context)) 'timestamp)
17495 '(org-at-planning-p))
17496 (not (time-less-p
17497 (org-time-string-to-time match)
17498 (org-time-string-to-time start-date)))
17499 (time-less-p
17500 (org-time-string-to-time match)
17501 (org-time-string-to-time end-date)))))))
17502 (message "%d entries between %s and %s"
17503 (org-occur regexp nil callback) start-date end-date)))
17505 (defun org-evaluate-time-range (&optional to-buffer)
17506 "Evaluate a time range by computing the difference between start and end.
17507 Normally the result is just printed in the echo area, but with prefix arg
17508 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17509 If the time range is actually in a table, the result is inserted into the
17510 next column.
17511 For time difference computation, a year is assumed to be exactly 365
17512 days in order to avoid rounding problems."
17513 (interactive "P")
17515 (org-clock-update-time-maybe)
17516 (save-excursion
17517 (unless (org-at-date-range-p t)
17518 (goto-char (point-at-bol))
17519 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17520 (if (not (org-at-date-range-p t))
17521 (user-error "Not at a time-stamp range, and none found in current line")))
17522 (let* ((ts1 (match-string 1))
17523 (ts2 (match-string 2))
17524 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17525 (match-end (match-end 0))
17526 (time1 (org-time-string-to-time ts1))
17527 (time2 (org-time-string-to-time ts2))
17528 (t1 (org-float-time time1))
17529 (t2 (org-float-time time2))
17530 (diff (abs (- t2 t1)))
17531 (negative (< (- t2 t1) 0))
17532 ;; (ys (floor (* 365 24 60 60)))
17533 (ds (* 24 60 60))
17534 (hs (* 60 60))
17535 (fy "%dy %dd %02d:%02d")
17536 (fy1 "%dy %dd")
17537 (fd "%dd %02d:%02d")
17538 (fd1 "%dd")
17539 (fh "%02d:%02d")
17540 y d h m align)
17541 (if havetime
17542 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17544 d (floor (/ diff ds)) diff (mod diff ds)
17545 h (floor (/ diff hs)) diff (mod diff hs)
17546 m (floor (/ diff 60)))
17547 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17549 d (floor (+ (/ diff ds) 0.5))
17550 h 0 m 0))
17551 (if (not to-buffer)
17552 (message "%s" (org-make-tdiff-string y d h m))
17553 (if (org-at-table-p)
17554 (progn
17555 (goto-char match-end)
17556 (setq align t)
17557 (and (looking-at " *|") (goto-char (match-end 0))))
17558 (goto-char match-end))
17559 (if (looking-at
17560 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17561 (replace-match ""))
17562 (if negative (insert " -"))
17563 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17564 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17565 (insert " " (format fh h m))))
17566 (if align (org-table-align))
17567 (message "Time difference inserted")))))
17569 (defun org-make-tdiff-string (y d h m)
17570 (let ((fmt "")
17571 (l nil))
17572 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17573 l (push y l)))
17574 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17575 l (push d l)))
17576 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17577 l (push h l)))
17578 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17579 l (push m l)))
17580 (apply 'format fmt (nreverse l))))
17582 (defun org-time-string-to-time (s &optional buffer pos)
17583 "Convert a timestamp string into internal time."
17584 (condition-case errdata
17585 (apply 'encode-time (org-parse-time-string s))
17586 (error (error "Bad timestamp `%s'%s\nError was: %s"
17587 s (if (not (and buffer pos))
17589 (format " at %d in buffer `%s'" pos buffer))
17590 (cdr errdata)))))
17592 (defun org-time-string-to-seconds (s)
17593 "Convert a timestamp string to a number of seconds."
17594 (org-float-time (org-time-string-to-time s)))
17596 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17597 "Convert a time stamp to an absolute day number.
17598 If there is a specifier for a cyclic time stamp, get the closest
17599 date to DAYNR.
17600 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17601 The variable `date' is bound by the calendar when this is called."
17602 (cond
17603 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17604 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17605 daynr
17606 (+ daynr 1000)))
17607 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17608 (> (string-to-number (match-string 1 s)) 0))
17609 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17610 (time-to-days (current-time))) (match-string 0 s)
17611 prefer show-all))
17612 (t (time-to-days
17613 (condition-case errdata
17614 (apply 'encode-time (org-parse-time-string s))
17615 (error (error "Bad timestamp `%s'%s\nError was: %s"
17616 s (if (not (and buffer pos))
17618 (format " at %d in buffer `%s'" pos buffer))
17619 (cdr errdata))))))))
17621 (defun org-days-to-iso-week (days)
17622 "Return the iso week number."
17623 (require 'cal-iso)
17624 (car (calendar-iso-from-absolute days)))
17626 (defun org-small-year-to-year (year)
17627 "Convert 2-digit years into 4-digit years.
17628 YEAR is expanded into one of the 30 next years, if possible, or
17629 into a past one. Any year larger than 99 is returned unchanged."
17630 (if (>= year 100) year
17631 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17632 (century (/ current 100))
17633 (offset (- year (% current 100))))
17634 (cond ((> offset 30) (+ (* (1- century) 100) year))
17635 ((> offset -70) (+ (* century 100) year))
17636 (t (+ (* (1+ century) 100) year))))))
17638 (defun org-time-from-absolute (d)
17639 "Return the time corresponding to date D.
17640 D may be an absolute day number, or a calendar-type list (month day year)."
17641 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17642 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17644 (defun org-calendar-holiday ()
17645 "List of holidays, for Diary display in Org-mode."
17646 (require 'holidays)
17647 (let ((hl (funcall
17648 (if (fboundp 'calendar-check-holidays)
17649 'calendar-check-holidays 'check-calendar-holidays) date)))
17650 (if hl (mapconcat 'identity hl "; "))))
17652 (defun org-diary-sexp-entry (sexp entry date)
17653 "Process a SEXP diary ENTRY for DATE."
17654 (require 'diary-lib)
17655 (let ((result (if calendar-debug-sexp
17656 (let ((stack-trace-on-error t))
17657 (eval (car (read-from-string sexp))))
17658 (condition-case nil
17659 (eval (car (read-from-string sexp)))
17660 (error
17661 (beep)
17662 (message "Bad sexp at line %d in %s: %s"
17663 (org-current-line)
17664 (buffer-file-name) sexp)
17665 (sleep-for 2))))))
17666 (cond ((stringp result) (split-string result "; "))
17667 ((and (consp result)
17668 (not (consp (cdr result)))
17669 (stringp (cdr result))) (cdr result))
17670 ((and (consp result)
17671 (stringp (car result))) result)
17672 (result entry))))
17674 (defun org-diary-to-ical-string (frombuf)
17675 "Get iCalendar entries from diary entries in buffer FROMBUF.
17676 This uses the icalendar.el library."
17677 (let* ((tmpdir (if (featurep 'xemacs)
17678 (temp-directory)
17679 temporary-file-directory))
17680 (tmpfile (make-temp-name
17681 (expand-file-name "orgics" tmpdir)))
17682 buf rtn b e)
17683 (with-current-buffer frombuf
17684 (icalendar-export-region (point-min) (point-max) tmpfile)
17685 (setq buf (find-buffer-visiting tmpfile))
17686 (set-buffer buf)
17687 (goto-char (point-min))
17688 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17689 (setq b (match-beginning 0)))
17690 (goto-char (point-max))
17691 (if (re-search-backward "^END:VEVENT" nil t)
17692 (setq e (match-end 0)))
17693 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17694 (kill-buffer buf)
17695 (delete-file tmpfile)
17696 rtn))
17698 (defun org-closest-date (start current change prefer show-all)
17699 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17700 When PREFER is `past', return a date that is either CURRENT or past.
17701 When PREFER is `future', return a date that is either CURRENT or future.
17702 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17703 ;; Make the proper lists from the dates
17704 (catch 'exit
17705 (let ((a1 '(("h" . hour)
17706 ("d" . day)
17707 ("w" . week)
17708 ("m" . month)
17709 ("y" . year)))
17710 (shour (nth 2 (org-parse-time-string start)))
17711 dn dw sday cday n1 n2 n0
17712 d m y y1 y2 date1 date2 nmonths nm ny m2)
17714 (setq start (org-date-to-gregorian start)
17715 current (org-date-to-gregorian
17716 (if show-all
17717 current
17718 (time-to-days (current-time))))
17719 sday (calendar-absolute-from-gregorian start)
17720 cday (calendar-absolute-from-gregorian current))
17722 (if (<= cday sday) (throw 'exit sday))
17724 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17725 (setq dn (string-to-number (match-string 1 change))
17726 dw (cdr (assoc (match-string 2 change) a1))))
17727 (unless (and dn (> dn 0))
17728 (user-error "Invalid change specifier: %s" change))
17729 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17730 (cond
17731 ((eq dw 'hour)
17732 (let ((missing-hours
17733 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17734 dn)))
17735 (setq n1 (if (zerop missing-hours) cday
17736 (- cday (1+ (floor (/ missing-hours 24)))))
17737 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17738 ((eq dw 'day)
17739 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17740 n2 (+ n1 dn)))
17741 ((eq dw 'year)
17742 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17743 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17744 (setq date1 (list m d y1)
17745 n1 (calendar-absolute-from-gregorian date1)
17746 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17747 n2 (calendar-absolute-from-gregorian date2)))
17748 ((eq dw 'month)
17749 ;; approx number of month between the two dates
17750 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17751 ;; How often does dn fit in there?
17752 (setq d (nth 1 start) m (car start) y (nth 2 start)
17753 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17754 m (+ m nm)
17755 ny (floor (/ m 12))
17756 y (+ y ny)
17757 m (- m (* ny 12)))
17758 (while (> m 12) (setq m (- m 12) y (1+ y)))
17759 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17760 (setq m2 (+ m dn) y2 y)
17761 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17762 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17763 (while (<= n2 cday)
17764 (setq n1 n2 m m2 y y2)
17765 (setq m2 (+ m dn) y2 y)
17766 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17767 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17768 ;; Make sure n1 is the earlier date
17769 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17770 (if show-all
17771 (cond
17772 ((eq prefer 'past) (if (= cday n2) n2 n1))
17773 ((eq prefer 'future) (if (= cday n1) n1 n2))
17774 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17775 (cond
17776 ((eq prefer 'past) (if (= cday n2) n2 n1))
17777 ((eq prefer 'future) (if (= cday n1) n1 n2))
17778 (t (if (= cday n1) n1 n2)))))))
17780 (defun org-date-to-gregorian (date)
17781 "Turn any specification of DATE into a Gregorian date for the calendar."
17782 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17783 ((and (listp date) (= (length date) 3)) date)
17784 ((stringp date)
17785 (setq date (org-parse-time-string date))
17786 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17787 ((listp date)
17788 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17790 (defun org-parse-time-string (s &optional nodefault)
17791 "Parse the standard Org-mode time string.
17792 This should be a lot faster than the normal `parse-time-string'.
17793 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17794 hour and minute fields will be nil if not given."
17795 (cond ((string-match org-ts-regexp0 s)
17796 (list 0
17797 (if (or (match-beginning 8) (not nodefault))
17798 (string-to-number (or (match-string 8 s) "0")))
17799 (if (or (match-beginning 7) (not nodefault))
17800 (string-to-number (or (match-string 7 s) "0")))
17801 (string-to-number (match-string 4 s))
17802 (string-to-number (match-string 3 s))
17803 (string-to-number (match-string 2 s))
17804 nil nil nil))
17805 ((string-match "^<[^>]+>$" s)
17806 (decode-time (seconds-to-time (org-matcher-time s))))
17807 (t (error "Not a standard Org-mode time string: %s" s))))
17809 (defun org-timestamp-up (&optional arg)
17810 "Increase the date item at the cursor by one.
17811 If the cursor is on the year, change the year. If it is on the month,
17812 the day or the time, change that.
17813 With prefix ARG, change by that many units."
17814 (interactive "p")
17815 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17817 (defun org-timestamp-down (&optional arg)
17818 "Decrease the date item at the cursor by one.
17819 If the cursor is on the year, change the year. If it is on the month,
17820 the day or the time, change that.
17821 With prefix ARG, change by that many units."
17822 (interactive "p")
17823 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17825 (defun org-timestamp-up-day (&optional arg)
17826 "Increase the date in the time stamp by one day.
17827 With prefix ARG, change that many days."
17828 (interactive "p")
17829 (if (and (not (org-at-timestamp-p t))
17830 (org-at-heading-p))
17831 (org-todo 'up)
17832 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17834 (defun org-timestamp-down-day (&optional arg)
17835 "Decrease the date in the time stamp by one day.
17836 With prefix ARG, change that many days."
17837 (interactive "p")
17838 (if (and (not (org-at-timestamp-p t))
17839 (org-at-heading-p))
17840 (org-todo 'down)
17841 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17843 (defun org-at-timestamp-p (&optional inactive-ok)
17844 "Determine if the cursor is in or at a timestamp."
17845 (interactive)
17846 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17847 (pos (point))
17848 (ans (or (looking-at tsr)
17849 (save-excursion
17850 (skip-chars-backward "^[<\n\r\t")
17851 (if (> (point) (point-min)) (backward-char 1))
17852 (and (looking-at tsr)
17853 (> (- (match-end 0) pos) -1))))))
17854 (and ans
17855 (boundp 'org-ts-what)
17856 (setq org-ts-what
17857 (cond
17858 ((= pos (match-beginning 0)) 'bracket)
17859 ;; Point is considered to be "on the bracket" whether
17860 ;; it's really on it or right after it.
17861 ((= pos (1- (match-end 0))) 'bracket)
17862 ((= pos (match-end 0)) 'after)
17863 ((org-pos-in-match-range pos 2) 'year)
17864 ((org-pos-in-match-range pos 3) 'month)
17865 ((org-pos-in-match-range pos 7) 'hour)
17866 ((org-pos-in-match-range pos 8) 'minute)
17867 ((or (org-pos-in-match-range pos 4)
17868 (org-pos-in-match-range pos 5)) 'day)
17869 ((and (> pos (or (match-end 8) (match-end 5)))
17870 (< pos (match-end 0)))
17871 (- pos (or (match-end 8) (match-end 5))))
17872 (t 'day))))
17873 ans))
17875 (defun org-toggle-timestamp-type ()
17876 "Toggle the type (<active> or [inactive]) of a time stamp."
17877 (interactive)
17878 (when (org-at-timestamp-p t)
17879 (let ((beg (match-beginning 0)) (end (match-end 0))
17880 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17881 (save-excursion
17882 (goto-char beg)
17883 (while (re-search-forward "[][<>]" end t)
17884 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17885 t t)))
17886 (message "Timestamp is now %sactive"
17887 (if (equal (char-after beg) ?<) "" "in")))))
17889 (defun org-at-clock-log-p nil
17890 "Is the cursor on the clock log line?"
17891 (save-excursion
17892 (move-beginning-of-line 1)
17893 (looking-at org-clock-line-re)))
17895 (defvar org-clock-history) ; defined in org-clock.el
17896 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17897 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17898 "Change the date in the time stamp at point.
17899 The date will be changed by N times WHAT. WHAT can be `day', `month',
17900 `year', `minute', `second'. If WHAT is not given, the cursor position
17901 in the timestamp determines what will be changed.
17902 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17903 (let ((origin (point)) origin-cat
17904 with-hm inactive
17905 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17906 org-ts-what
17907 extra rem
17908 ts time time0 fixnext clrgx)
17909 (if (not (org-at-timestamp-p t))
17910 (user-error "Not at a timestamp"))
17911 (if (and (not what) (eq org-ts-what 'bracket))
17912 (org-toggle-timestamp-type)
17913 ;; Point isn't on brackets. Remember the part of the time-stamp
17914 ;; the point was in. Indeed, size of time-stamps may change,
17915 ;; but point must be kept in the same category nonetheless.
17916 (setq origin-cat org-ts-what)
17917 (if (and (not what) (not (eq org-ts-what 'day))
17918 org-display-custom-times
17919 (get-text-property (point) 'display)
17920 (not (get-text-property (1- (point)) 'display)))
17921 (setq org-ts-what 'day))
17922 (setq org-ts-what (or what org-ts-what)
17923 inactive (= (char-after (match-beginning 0)) ?\[)
17924 ts (match-string 0))
17925 (replace-match "")
17926 (when (string-match
17927 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17929 (setq extra (match-string 1 ts))
17930 (if suppress-tmp-delay
17931 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17932 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17933 (setq with-hm t))
17934 (setq time0 (org-parse-time-string ts))
17935 (when (and updown
17936 (eq org-ts-what 'minute)
17937 (not current-prefix-arg))
17938 ;; This looks like s-up and s-down. Change by one rounding step.
17939 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17940 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17941 (setcar (cdr time0) (+ (nth 1 time0)
17942 (if (> n 0) (- rem) (- dm rem))))))
17943 (setq time
17944 (encode-time (or (car time0) 0)
17945 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17946 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17947 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17948 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17949 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17950 (nthcdr 6 time0)))
17951 (when (and (member org-ts-what '(hour minute))
17952 extra
17953 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17954 (setq extra (org-modify-ts-extra
17955 extra
17956 (if (eq org-ts-what 'hour) 2 5)
17957 n dm)))
17958 (when (integerp org-ts-what)
17959 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17960 (if (eq what 'calendar)
17961 (let ((cal-date (org-get-date-from-calendar)))
17962 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17963 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17964 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17965 (setcar time0 (or (car time0) 0))
17966 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17967 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17968 (setq time (apply 'encode-time time0))))
17969 ;; Insert the new time-stamp, and ensure point stays in the same
17970 ;; category as before (i.e. not after the last position in that
17971 ;; category).
17972 (let ((pos (point)))
17973 ;; Stay before inserted string. `save-excursion' is of no use.
17974 (setq org-last-changed-timestamp
17975 (org-insert-time-stamp time with-hm inactive nil nil extra))
17976 (goto-char pos))
17977 (save-match-data
17978 (looking-at org-ts-regexp3)
17979 (goto-char (cond
17980 ;; `day' category ends before `hour' if any, or at
17981 ;; the end of the day name.
17982 ((eq origin-cat 'day)
17983 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17984 ((eq origin-cat 'hour) (min (match-end 7) origin))
17985 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17986 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17987 ;; `year' and `month' have both fixed size: point
17988 ;; couldn't have moved into another part.
17989 (t origin))))
17990 ;; Update clock if on a CLOCK line.
17991 (org-clock-update-time-maybe)
17992 ;; Maybe adjust the closest clock in `org-clock-history'
17993 (when org-clock-adjust-closest
17994 (if (not (and (org-at-clock-log-p)
17995 (< 1 (length (delq nil (mapcar 'marker-position
17996 org-clock-history))))))
17997 (message "No clock to adjust")
17998 (cond ((save-excursion ; fix previous clock?
17999 (re-search-backward org-ts-regexp0 nil t)
18000 (org-looking-back (concat org-clock-string " \\[")))
18001 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18002 ((save-excursion ; fix next clock?
18003 (re-search-backward org-ts-regexp0 nil t)
18004 (looking-at (concat org-ts-regexp0 "\\] =>")))
18005 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18006 (save-window-excursion
18007 ;; Find closest clock to point, adjust the previous/next one in history
18008 (let* ((p (save-excursion (org-back-to-heading t)))
18009 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18010 (clfixnth
18011 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18012 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18013 (if (not clfixpos)
18014 (message "No clock to adjust")
18015 (save-excursion
18016 (org-goto-marker-or-bmk clfixpos)
18017 (org-show-subtree)
18018 (when (re-search-forward clrgx nil t)
18019 (goto-char (match-beginning 1))
18020 (let (org-clock-adjust-closest)
18021 (org-timestamp-change n org-ts-what updown))
18022 (message "Clock adjusted in %s for heading: %s"
18023 (file-name-nondirectory (buffer-file-name))
18024 (org-get-heading t t)))))))))
18025 ;; Try to recenter the calendar window, if any.
18026 (if (and org-calendar-follow-timestamp-change
18027 (get-buffer-window "*Calendar*" t)
18028 (memq org-ts-what '(day month year)))
18029 (org-recenter-calendar (time-to-days time))))))
18031 (defun org-modify-ts-extra (s pos n dm)
18032 "Change the different parts of the lead-time and repeat fields in timestamp."
18033 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18034 ng h m new rem)
18035 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18036 (cond
18037 ((or (org-pos-in-match-range pos 2)
18038 (org-pos-in-match-range pos 3))
18039 (setq m (string-to-number (match-string 3 s))
18040 h (string-to-number (match-string 2 s)))
18041 (if (org-pos-in-match-range pos 2)
18042 (setq h (+ h n))
18043 (setq n (* dm (org-no-warnings (signum n))))
18044 (when (not (= 0 (setq rem (% m dm))))
18045 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18046 (setq m (+ m n)))
18047 (if (< m 0) (setq m (+ m 60) h (1- h)))
18048 (if (> m 59) (setq m (- m 60) h (1+ h)))
18049 (setq h (min 24 (max 0 h)))
18050 (setq ng 1 new (format "-%02d:%02d" h m)))
18051 ((org-pos-in-match-range pos 6)
18052 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18053 ((org-pos-in-match-range pos 5)
18054 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18056 ((org-pos-in-match-range pos 9)
18057 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18058 ((org-pos-in-match-range pos 8)
18059 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18061 (when ng
18062 (setq s (concat
18063 (substring s 0 (match-beginning ng))
18065 (substring s (match-end ng))))))
18068 (defun org-recenter-calendar (date)
18069 "If the calendar is visible, recenter it to DATE."
18070 (let ((cwin (get-buffer-window "*Calendar*" t)))
18071 (when cwin
18072 (let ((calendar-move-hook nil))
18073 (with-selected-window cwin
18074 (calendar-goto-date (if (listp date) date
18075 (calendar-gregorian-from-absolute date))))))))
18077 (defun org-goto-calendar (&optional arg)
18078 "Go to the Emacs calendar at the current date.
18079 If there is a time stamp in the current line, go to that date.
18080 A prefix ARG can be used to force the current date."
18081 (interactive "P")
18082 (let ((tsr org-ts-regexp) diff
18083 (calendar-move-hook nil)
18084 (calendar-view-holidays-initially-flag nil)
18085 (calendar-view-diary-initially-flag nil))
18086 (if (or (org-at-timestamp-p)
18087 (save-excursion
18088 (beginning-of-line 1)
18089 (looking-at (concat ".*" tsr))))
18090 (let ((d1 (time-to-days (current-time)))
18091 (d2 (time-to-days
18092 (org-time-string-to-time (match-string 1)))))
18093 (setq diff (- d2 d1))))
18094 (calendar)
18095 (calendar-goto-today)
18096 (if (and diff (not arg)) (calendar-forward-day diff))))
18098 (defun org-get-date-from-calendar ()
18099 "Return a list (month day year) of date at point in calendar."
18100 (with-current-buffer "*Calendar*"
18101 (save-match-data
18102 (calendar-cursor-to-date))))
18104 (defun org-date-from-calendar ()
18105 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18106 If there is already a time stamp at the cursor position, update it."
18107 (interactive)
18108 (if (org-at-timestamp-p t)
18109 (org-timestamp-change 0 'calendar)
18110 (let ((cal-date (org-get-date-from-calendar)))
18111 (org-insert-time-stamp
18112 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18114 (defcustom org-effort-durations
18115 `(("min" . 1)
18116 ("h" . 60)
18117 ("d" . ,(* 60 8))
18118 ("w" . ,(* 60 8 5))
18119 ("m" . ,(* 60 8 5 4))
18120 ("y" . ,(* 60 8 5 40)))
18121 "Conversion factor to minutes for an effort modifier.
18123 Each entry has the form (MODIFIER . MINUTES).
18125 In an effort string, a number followed by MODIFIER is multiplied
18126 by the specified number of MINUTES to obtain an effort in
18127 minutes.
18129 For example, if the value of this variable is ((\"hours\" . 60)), then an
18130 effort string \"2hours\" is equivalent to 120 minutes."
18131 :group 'org-agenda
18132 :version "25.1"
18133 :package-version '(Org . "8.3")
18134 :type '(alist :key-type (string :tag "Modifier")
18135 :value-type (number :tag "Minutes")))
18137 (defun org-minutes-to-clocksum-string (m)
18138 "Format number of minutes as a clocksum string.
18139 The format is determined by `org-time-clocksum-format',
18140 `org-time-clocksum-use-fractional' and
18141 `org-time-clocksum-fractional-format' and
18142 `org-time-clocksum-use-effort-durations'."
18143 (let ((clocksum "")
18144 (m (round m)) ; Don't allow fractions of minutes
18145 h d w mo y fmt n)
18146 (setq h (if org-time-clocksum-use-effort-durations
18147 (cdr (assoc "h" org-effort-durations)) 60)
18148 d (if org-time-clocksum-use-effort-durations
18149 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18150 w (if org-time-clocksum-use-effort-durations
18151 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18152 mo (if org-time-clocksum-use-effort-durations
18153 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18154 y (if org-time-clocksum-use-effort-durations
18155 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18156 ;; fractional format
18157 (if org-time-clocksum-use-fractional
18158 (cond
18159 ;; single format string
18160 ((stringp org-time-clocksum-fractional-format)
18161 (format org-time-clocksum-fractional-format (/ m (float h))))
18162 ;; choice of fractional formats for different time units
18163 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18164 (> (/ (truncate m) (* y d h)) 0))
18165 (format fmt (/ m (* y d (float h)))))
18166 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18167 (> (/ (truncate m) (* mo d h)) 0))
18168 (format fmt (/ m (* mo d (float h)))))
18169 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18170 (> (/ (truncate m) (* w d h)) 0))
18171 (format fmt (/ m (* w d (float h)))))
18172 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18173 (> (/ (truncate m) (* d h)) 0))
18174 (format fmt (/ m (* d (float h)))))
18175 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18176 (> (/ (truncate m) h) 0))
18177 (format fmt (/ m (float h))))
18178 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18179 (format fmt m))
18180 ;; fall back to smallest time unit with a format
18181 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18182 (format fmt (/ m (float h))))
18183 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18184 (format fmt (/ m (* d (float h)))))
18185 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18186 (format fmt (/ m (* w d (float h)))))
18187 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18188 (format fmt (/ m (* mo d (float h)))))
18189 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18190 (format fmt (/ m (* y d (float h))))))
18191 ;; standard (non-fractional) format, with single format string
18192 (if (stringp org-time-clocksum-format)
18193 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18194 ;; separate formats components
18195 (and (setq fmt (plist-get org-time-clocksum-format :years))
18196 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18197 (plist-get org-time-clocksum-format :require-years))
18198 (setq clocksum (concat clocksum (format fmt n))
18199 m (- m (* n y d h))))
18200 (and (setq fmt (plist-get org-time-clocksum-format :months))
18201 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18202 (plist-get org-time-clocksum-format :require-months))
18203 (setq clocksum (concat clocksum (format fmt n))
18204 m (- m (* n mo d h))))
18205 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18206 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18207 (plist-get org-time-clocksum-format :require-weeks))
18208 (setq clocksum (concat clocksum (format fmt n))
18209 m (- m (* n w d h))))
18210 (and (setq fmt (plist-get org-time-clocksum-format :days))
18211 (or (> (setq n (/ (truncate m) (* d h))) 0)
18212 (plist-get org-time-clocksum-format :require-days))
18213 (setq clocksum (concat clocksum (format fmt n))
18214 m (- m (* n d h))))
18215 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18216 (or (> (setq n (/ (truncate m) h)) 0)
18217 (plist-get org-time-clocksum-format :require-hours))
18218 (setq clocksum (concat clocksum (format fmt n))
18219 m (- m (* n h))))
18220 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18221 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18222 (setq clocksum (concat clocksum (format fmt m))))
18223 ;; return formatted time duration
18224 clocksum))))
18226 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18227 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18228 "Org mode version 8.0")
18230 (defun org-hours-to-clocksum-string (n)
18231 (org-minutes-to-clocksum-string (* n 60)))
18233 (defun org-hh:mm-string-to-minutes (s)
18234 "Convert a string H:MM to a number of minutes.
18235 If the string is just a number, interpret it as minutes.
18236 In fact, the first hh:mm or number in the string will be taken,
18237 there can be extra stuff in the string.
18238 If no number is found, the return value is 0."
18239 (cond
18240 ((integerp s) s)
18241 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18242 (+ (* (string-to-number (match-string 1 s)) 60)
18243 (string-to-number (match-string 2 s))))
18244 ((string-match "\\([0-9]+\\)" s)
18245 (string-to-number (match-string 1 s)))
18246 (t 0)))
18248 (defcustom org-image-actual-width t
18249 "Should we use the actual width of images when inlining them?
18251 When set to `t', always use the image width.
18253 When set to a number, use imagemagick (when available) to set
18254 the image's width to this value.
18256 When set to a number in a list, try to get the width from any
18257 #+ATTR.* keyword if it matches a width specification like
18259 #+ATTR_HTML: :width 300px
18261 and fall back on that number if none is found.
18263 When set to nil, try to get the width from an #+ATTR.* keyword
18264 and fall back on the original width if none is found.
18266 This requires Emacs >= 24.1, build with imagemagick support."
18267 :group 'org-appearance
18268 :version "24.4"
18269 :package-version '(Org . "8.0")
18270 :type '(choice
18271 (const :tag "Use the image width" t)
18272 (integer :tag "Use a number of pixels")
18273 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18274 (const :tag "Use #+ATTR* or don't resize" nil)))
18276 (defcustom org-agenda-inhibit-startup nil
18277 "Inhibit startup when preparing agenda buffers.
18278 When this variable is `t', the initialization of the Org agenda
18279 buffers is inhibited: e.g. the visibility state is not set, the
18280 tables are not re-aligned, etc."
18281 :type 'boolean
18282 :version "24.3"
18283 :group 'org-agenda)
18285 (define-obsolete-variable-alias
18286 'org-agenda-ignore-drawer-properties
18287 'org-agenda-ignore-properties "25.1")
18289 (defcustom org-agenda-ignore-properties nil
18290 "Avoid updating text properties when building the agenda.
18291 Properties are used to prepare buffers for effort estimates,
18292 appointments, statistics and subtree-local categories.
18293 If you don't use these in the agenda, you can add them to this
18294 list and agenda building will be a bit faster.
18295 The value is a list, with zero or more of the symbols `effort', `appt',
18296 `stats' or `category'."
18297 :type '(set :greedy t
18298 (const effort)
18299 (const appt)
18300 (const stats)
18301 (const category))
18302 :version "25.1"
18303 :package-version '(Org . "8.3")
18304 :group 'org-agenda)
18306 (defun org-duration-string-to-minutes (s &optional output-to-string)
18307 "Convert a duration string S to minutes.
18309 A bare number is interpreted as minutes, modifiers can be set by
18310 customizing `org-effort-durations' (which see).
18312 Entries containing a colon are interpreted as H:MM by
18313 `org-hh:mm-string-to-minutes'."
18314 (let ((result 0)
18315 (re (concat "\\([0-9.]+\\) *\\("
18316 (regexp-opt (mapcar 'car org-effort-durations))
18317 "\\)")))
18318 (while (string-match re s)
18319 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18320 (string-to-number (match-string 1 s))))
18321 (setq s (replace-match "" nil t s)))
18322 (setq result (floor result))
18323 (incf result (org-hh:mm-string-to-minutes s))
18324 (if output-to-string (number-to-string result) result)))
18326 ;;;; Files
18328 (defun org-save-all-org-buffers ()
18329 "Save all Org-mode buffers without user confirmation."
18330 (interactive)
18331 (message "Saving all Org-mode buffers...")
18332 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18333 (when (featurep 'org-id) (org-id-locations-save))
18334 (message "Saving all Org-mode buffers... done"))
18336 (defun org-revert-all-org-buffers ()
18337 "Revert all Org-mode buffers.
18338 Prompt for confirmation when there are unsaved changes.
18339 Be sure you know what you are doing before letting this function
18340 overwrite your changes.
18342 This function is useful in a setup where one tracks org files
18343 with a version control system, to revert on one machine after pulling
18344 changes from another. I believe the procedure must be like this:
18346 1. M-x org-save-all-org-buffers
18347 2. Pull changes from the other machine, resolve conflicts
18348 3. M-x org-revert-all-org-buffers"
18349 (interactive)
18350 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18351 (user-error "Abort"))
18352 (save-excursion
18353 (save-window-excursion
18354 (mapc
18355 (lambda (b)
18356 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18357 (with-current-buffer b buffer-file-name))
18358 (org-pop-to-buffer-same-window b)
18359 (revert-buffer t 'no-confirm)))
18360 (buffer-list))
18361 (when (and (featurep 'org-id) org-id-track-globally)
18362 (org-id-locations-load)))))
18364 ;;;; Agenda files
18366 ;;;###autoload
18367 (defun org-switchb (&optional arg)
18368 "Switch between Org buffers.
18369 With one prefix argument, restrict available buffers to files.
18370 With two prefix arguments, restrict available buffers to agenda files.
18372 Defaults to `iswitchb' for buffer name completion.
18373 Set `org-completion-use-ido' to make it use ido instead."
18374 (interactive "P")
18375 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18376 ((equal arg '(16)) (org-buffer-list 'agenda))
18377 (t (org-buffer-list))))
18378 (org-completion-use-iswitchb org-completion-use-iswitchb)
18379 (org-completion-use-ido org-completion-use-ido))
18380 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18381 (setq org-completion-use-iswitchb t))
18382 (org-pop-to-buffer-same-window
18383 (org-icompleting-read "Org buffer: "
18384 (mapcar 'list (mapcar 'buffer-name blist))
18385 nil t))))
18387 ;;; Define some older names previously used for this functionality
18388 ;;;###autoload
18389 (defalias 'org-ido-switchb 'org-switchb)
18390 ;;;###autoload
18391 (defalias 'org-iswitchb 'org-switchb)
18393 (defun org-buffer-list (&optional predicate exclude-tmp)
18394 "Return a list of Org buffers.
18395 PREDICATE can be `export', `files' or `agenda'.
18397 export restrict the list to Export buffers.
18398 files restrict the list to buffers visiting Org files.
18399 agenda restrict the list to buffers visiting agenda files.
18401 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18402 (let* ((bfn nil)
18403 (agenda-files (and (eq predicate 'agenda)
18404 (mapcar 'file-truename (org-agenda-files t))))
18405 (filter
18406 (cond
18407 ((eq predicate 'files)
18408 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18409 ((eq predicate 'export)
18410 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18411 ((eq predicate 'agenda)
18412 (lambda (b)
18413 (with-current-buffer b
18414 (and (derived-mode-p 'org-mode)
18415 (setq bfn (buffer-file-name b))
18416 (member (file-truename bfn) agenda-files)))))
18417 (t (lambda (b) (with-current-buffer b
18418 (or (derived-mode-p 'org-mode)
18419 (string-match "\*Org .*Export"
18420 (buffer-name b)))))))))
18421 (delq nil
18422 (mapcar
18423 (lambda(b)
18424 (if (and (funcall filter b)
18425 (or (not exclude-tmp)
18426 (not (string-match "tmp" (buffer-name b)))))
18428 nil))
18429 (buffer-list)))))
18431 (defun org-agenda-files (&optional unrestricted archives)
18432 "Get the list of agenda files.
18433 Optional UNRESTRICTED means return the full list even if a restriction
18434 is currently in place.
18435 When ARCHIVES is t, include all archive files that are really being
18436 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18437 `org-agenda-archives-mode' is t."
18438 (let ((files
18439 (cond
18440 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18441 ((stringp org-agenda-files) (org-read-agenda-file-list))
18442 ((listp org-agenda-files) org-agenda-files)
18443 (t (error "Invalid value of `org-agenda-files'")))))
18444 (setq files (apply 'append
18445 (mapcar (lambda (f)
18446 (if (file-directory-p f)
18447 (directory-files
18448 f t org-agenda-file-regexp)
18449 (list f)))
18450 files)))
18451 (when org-agenda-skip-unavailable-files
18452 (setq files (delq nil
18453 (mapcar (function
18454 (lambda (file)
18455 (and (file-readable-p file) file)))
18456 files))))
18457 (when (or (eq archives t)
18458 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18459 (setq files (org-add-archive-files files)))
18460 files))
18462 (defun org-agenda-file-p (&optional file)
18463 "Return non-nil, if FILE is an agenda file.
18464 If FILE is omitted, use the file associated with the current
18465 buffer."
18466 (let ((fname (or file (buffer-file-name))))
18467 (and fname
18468 (member (file-truename fname)
18469 (mapcar #'file-truename (org-agenda-files t))))))
18471 (defun org-edit-agenda-file-list ()
18472 "Edit the list of agenda files.
18473 Depending on setup, this either uses customize to edit the variable
18474 `org-agenda-files', or it visits the file that is holding the list. In the
18475 latter case, the buffer is set up in a way that saving it automatically kills
18476 the buffer and restores the previous window configuration."
18477 (interactive)
18478 (if (stringp org-agenda-files)
18479 (let ((cw (current-window-configuration)))
18480 (find-file org-agenda-files)
18481 (org-set-local 'org-window-configuration cw)
18482 (org-add-hook 'after-save-hook
18483 (lambda ()
18484 (set-window-configuration
18485 (prog1 org-window-configuration
18486 (kill-buffer (current-buffer))))
18487 (org-install-agenda-files-menu)
18488 (message "New agenda file list installed"))
18489 nil 'local)
18490 (message "%s" (substitute-command-keys
18491 "Edit list and finish with \\[save-buffer]")))
18492 (customize-variable 'org-agenda-files)))
18494 (defun org-store-new-agenda-file-list (list)
18495 "Set new value for the agenda file list and save it correctly."
18496 (if (stringp org-agenda-files)
18497 (let ((fe (org-read-agenda-file-list t)) b u)
18498 (while (setq b (find-buffer-visiting org-agenda-files))
18499 (kill-buffer b))
18500 (with-temp-file org-agenda-files
18501 (insert
18502 (mapconcat
18503 (lambda (f) ;; Keep un-expanded entries.
18504 (if (setq u (assoc f fe))
18505 (cdr u)
18507 list "\n")
18508 "\n")))
18509 (let ((org-mode-hook nil) (org-inhibit-startup t)
18510 (org-insert-mode-line-in-empty-file nil))
18511 (setq org-agenda-files list)
18512 (customize-save-variable 'org-agenda-files org-agenda-files))))
18514 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18515 "Read the list of agenda files from a file.
18516 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18517 filenames, used by `org-store-new-agenda-file-list' to write back
18518 un-expanded file names."
18519 (when (file-directory-p org-agenda-files)
18520 (error "`org-agenda-files' cannot be a single directory"))
18521 (when (stringp org-agenda-files)
18522 (with-temp-buffer
18523 (insert-file-contents org-agenda-files)
18524 (mapcar
18525 (lambda (f)
18526 (let ((e (expand-file-name (substitute-in-file-name f)
18527 org-directory)))
18528 (if pair-with-expansion
18529 (cons e f)
18530 e)))
18531 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18533 ;;;###autoload
18534 (defun org-cycle-agenda-files ()
18535 "Cycle through the files in `org-agenda-files'.
18536 If the current buffer visits an agenda file, find the next one in the list.
18537 If the current buffer does not, find the first agenda file."
18538 (interactive)
18539 (let* ((fs (org-agenda-files t))
18540 (files (append fs (list (car fs))))
18541 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18542 file)
18543 (unless files (user-error "No agenda files"))
18544 (catch 'exit
18545 (while (setq file (pop files))
18546 (if (equal (file-truename file) tcf)
18547 (when (car files)
18548 (find-file (car files))
18549 (throw 'exit t))))
18550 (find-file (car fs)))
18551 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18553 (defun org-agenda-file-to-front (&optional to-end)
18554 "Move/add the current file to the top of the agenda file list.
18555 If the file is not present in the list, it is added to the front. If it is
18556 present, it is moved there. With optional argument TO-END, add/move to the
18557 end of the list."
18558 (interactive "P")
18559 (let ((org-agenda-skip-unavailable-files nil)
18560 (file-alist (mapcar (lambda (x)
18561 (cons (file-truename x) x))
18562 (org-agenda-files t)))
18563 (ctf (file-truename
18564 (or buffer-file-name
18565 (user-error "Please save the current buffer to a file"))))
18566 x had)
18567 (setq x (assoc ctf file-alist) had x)
18569 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18570 (if to-end
18571 (setq file-alist (append (delq x file-alist) (list x)))
18572 (setq file-alist (cons x (delq x file-alist))))
18573 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18574 (org-install-agenda-files-menu)
18575 (message "File %s to %s of agenda file list"
18576 (if had "moved" "added") (if to-end "end" "front"))))
18578 (defun org-remove-file (&optional file)
18579 "Remove current file from the list of files in variable `org-agenda-files'.
18580 These are the files which are being checked for agenda entries.
18581 Optional argument FILE means use this file instead of the current."
18582 (interactive)
18583 (let* ((org-agenda-skip-unavailable-files nil)
18584 (file (or file buffer-file-name
18585 (user-error "Current buffer does not visit a file")))
18586 (true-file (file-truename file))
18587 (afile (abbreviate-file-name file))
18588 (files (delq nil (mapcar
18589 (lambda (x)
18590 (if (equal true-file
18591 (file-truename x))
18592 nil x))
18593 (org-agenda-files t)))))
18594 (if (not (= (length files) (length (org-agenda-files t))))
18595 (progn
18596 (org-store-new-agenda-file-list files)
18597 (org-install-agenda-files-menu)
18598 (message "Removed from Org Agenda list: %s" afile))
18599 (message "File was not in list: %s (not removed)" afile))))
18601 (defun org-file-menu-entry (file)
18602 (vector file (list 'find-file file) t))
18604 (defun org-check-agenda-file (file)
18605 "Make sure FILE exists. If not, ask user what to do."
18606 (when (not (file-exists-p file))
18607 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18608 (abbreviate-file-name file))
18609 (let ((r (downcase (read-char-exclusive))))
18610 (cond
18611 ((equal r ?r)
18612 (org-remove-file file)
18613 (throw 'nextfile t))
18614 (t (user-error "Abort"))))))
18616 (defun org-get-agenda-file-buffer (file)
18617 "Get an agenda buffer visiting FILE.
18618 If the buffer needs to be created, add it to the list of buffers
18619 which might be released later."
18620 (let ((buf (org-find-base-buffer-visiting file)))
18621 (if buf
18622 buf ; just return it
18623 ;; Make a new buffer and remember it
18624 (setq buf (find-file-noselect file))
18625 (if buf (push buf org-agenda-new-buffers))
18626 buf)))
18628 (defun org-release-buffers (blist)
18629 "Release all buffers in list, asking the user for confirmation when needed.
18630 When a buffer is unmodified, it is just killed. When modified, it is saved
18631 \(if the user agrees) and then killed."
18632 (let (buf file)
18633 (while (setq buf (pop blist))
18634 (setq file (buffer-file-name buf))
18635 (when (and (buffer-modified-p buf)
18636 file
18637 (y-or-n-p (format "Save file %s? " file)))
18638 (with-current-buffer buf (save-buffer)))
18639 (kill-buffer buf))))
18641 (defun org-agenda-prepare-buffers (files)
18642 "Create buffers for all agenda files, protect archived trees and comments."
18643 (interactive)
18644 (let ((pa '(:org-archived t))
18645 (pc '(:org-comment t))
18646 (pall '(:org-archived t :org-comment t))
18647 (inhibit-read-only t)
18648 (org-inhibit-startup org-agenda-inhibit-startup)
18649 (rea (concat ":" org-archive-tag ":"))
18650 file re pos)
18651 (setq org-tag-alist-for-agenda nil
18652 org-tag-groups-alist-for-agenda nil)
18653 (save-excursion
18654 (save-restriction
18655 (while (setq file (pop files))
18656 (catch 'nextfile
18657 (if (bufferp file)
18658 (set-buffer file)
18659 (org-check-agenda-file file)
18660 (set-buffer (org-get-agenda-file-buffer file)))
18661 (widen)
18662 (org-set-regexps-and-options 'tags-only)
18663 (setq pos (point))
18664 (or (memq 'category org-agenda-ignore-properties)
18665 (org-refresh-category-properties))
18666 (or (memq 'stats org-agenda-ignore-properties)
18667 (org-refresh-stats-properties))
18668 (or (memq 'effort org-agenda-ignore-properties)
18669 (org-refresh-effort-properties))
18670 (or (memq 'appt org-agenda-ignore-properties)
18671 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18672 (setq org-todo-keywords-for-agenda
18673 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18674 (setq org-done-keywords-for-agenda
18675 (append org-done-keywords-for-agenda org-done-keywords))
18676 (setq org-todo-keyword-alist-for-agenda
18677 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18678 (setq org-tag-alist-for-agenda
18679 (org-uniquify
18680 (append org-tag-alist-for-agenda
18681 org-tag-alist
18682 org-tag-persistent-alist)))
18683 (if org-group-tags
18684 (setq org-tag-groups-alist-for-agenda
18685 (org-uniquify-alist
18686 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18687 (org-with-silent-modifications
18688 (save-excursion
18689 (remove-text-properties (point-min) (point-max) pall)
18690 (when org-agenda-skip-archived-trees
18691 (goto-char (point-min))
18692 (while (re-search-forward rea nil t)
18693 (if (org-at-heading-p t)
18694 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18695 (goto-char (point-min))
18696 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18697 (while (re-search-forward re nil t)
18698 (when (save-match-data (org-in-commented-heading-p t))
18699 (add-text-properties
18700 (match-beginning 0) (org-end-of-subtree t) pc)))))
18701 (goto-char pos)))))
18702 (setq org-todo-keywords-for-agenda
18703 (org-uniquify org-todo-keywords-for-agenda))
18704 (setq org-todo-keyword-alist-for-agenda
18705 (org-uniquify org-todo-keyword-alist-for-agenda))))
18708 ;;;; CDLaTeX minor mode
18710 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18711 "Keymap for the minor `org-cdlatex-mode'.")
18713 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18714 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18715 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18716 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18717 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18719 (defvar org-cdlatex-texmathp-advice-is-done nil
18720 "Flag remembering if we have applied the advice to texmathp already.")
18722 (define-minor-mode org-cdlatex-mode
18723 "Toggle the minor `org-cdlatex-mode'.
18724 This mode supports entering LaTeX environment and math in LaTeX fragments
18725 in Org-mode.
18726 \\{org-cdlatex-mode-map}"
18727 nil " OCDL" nil
18728 (when org-cdlatex-mode
18729 (require 'cdlatex)
18730 (run-hooks 'cdlatex-mode-hook)
18731 (cdlatex-compute-tables))
18732 (unless org-cdlatex-texmathp-advice-is-done
18733 (setq org-cdlatex-texmathp-advice-is-done t)
18734 (defadvice texmathp (around org-math-always-on activate)
18735 "Always return t in org-mode buffers.
18736 This is because we want to insert math symbols without dollars even outside
18737 the LaTeX math segments. If Orgmode thinks that point is actually inside
18738 an embedded LaTeX fragment, let texmathp do its job.
18739 \\[org-cdlatex-mode-map]"
18740 (interactive)
18741 (let (p)
18742 (cond
18743 ((not (derived-mode-p 'org-mode)) ad-do-it)
18744 ((eq this-command 'cdlatex-math-symbol)
18745 (setq ad-return-value t
18746 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18748 (let ((p (org-inside-LaTeX-fragment-p)))
18749 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18750 (setq ad-return-value t
18751 texmathp-why '("Org-mode embedded math" . 0))
18752 (if p ad-do-it)))))))))
18754 (defun turn-on-org-cdlatex ()
18755 "Unconditionally turn on `org-cdlatex-mode'."
18756 (org-cdlatex-mode 1))
18758 (defun org-try-cdlatex-tab ()
18759 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18760 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18761 - inside a LaTeX fragment, or
18762 - after the first word in a line, where an abbreviation expansion could
18763 insert a LaTeX environment."
18764 (when org-cdlatex-mode
18765 (cond
18766 ;; Before any word on the line: No expansion possible.
18767 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18768 ;; Just after first word on the line: Expand it. Make sure it
18769 ;; cannot happen on headlines, though.
18770 ((save-excursion
18771 (skip-chars-backward "a-zA-Z0-9*")
18772 (skip-chars-backward " \t")
18773 (and (bolp) (not (org-at-heading-p))))
18774 (cdlatex-tab) t)
18775 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18777 (defun org-cdlatex-underscore-caret (&optional arg)
18778 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18779 Revert to the normal definition outside of these fragments."
18780 (interactive "P")
18781 (if (org-inside-LaTeX-fragment-p)
18782 (call-interactively 'cdlatex-sub-superscript)
18783 (let (org-cdlatex-mode)
18784 (call-interactively (key-binding (vector last-input-event))))))
18786 (defun org-cdlatex-math-modify (&optional arg)
18787 "Execute `cdlatex-math-modify' in LaTeX fragments.
18788 Revert to the normal definition outside of these fragments."
18789 (interactive "P")
18790 (if (org-inside-LaTeX-fragment-p)
18791 (call-interactively 'cdlatex-math-modify)
18792 (let (org-cdlatex-mode)
18793 (call-interactively (key-binding (vector last-input-event))))))
18795 (defun org-cdlatex-environment-indent (&optional environment item)
18796 "Execute `cdlatex-environment' and indent the inserted environment.
18798 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18800 The inserted environment is indented to current indentation
18801 unless point is at the beginning of the line, in which the
18802 environment remains unintended."
18803 (interactive)
18804 ;; cdlatex-environment always return nil. Therefore, capture output
18805 ;; first and determine if an environment was selected.
18806 (let* ((beg (point-marker))
18807 (end (copy-marker (point) t))
18808 (inserted (progn
18809 (ignore-errors (cdlatex-environment environment item))
18810 (< beg end)))
18811 ;; Figure out how many lines to move forward after the
18812 ;; environment has been inserted.
18813 (lines (when inserted
18814 (save-excursion
18815 (- (loop while (< beg (point))
18816 with x = 0
18817 do (forward-line -1)
18818 (incf x)
18819 finally return x)
18820 (if (progn (goto-char beg)
18821 (and (progn (skip-chars-forward " \t") (eolp))
18822 (progn (skip-chars-backward " \t") (bolp))))
18823 1 0)))))
18824 (env (org-trim (delete-and-extract-region beg end))))
18825 (when inserted
18826 ;; Get indentation of next line unless at column 0.
18827 (let ((ind (if (bolp) 0
18828 (save-excursion
18829 (org-return-indent)
18830 (prog1 (org-get-indentation)
18831 (when (progn (skip-chars-forward " \t") (eolp))
18832 (delete-region beg (point)))))))
18833 (bol (progn (skip-chars-backward " \t") (bolp))))
18834 ;; Insert a newline before environment unless at column zero
18835 ;; to "escape" the current line. Insert a newline if
18836 ;; something is one the same line as \end{ENVIRONMENT}.
18837 (insert
18838 (concat (unless bol "\n") env
18839 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18840 (unless (zerop ind)
18841 (save-excursion
18842 (goto-char beg)
18843 (while (< (point) end)
18844 (unless (eolp) (org-indent-line-to ind))
18845 (forward-line))))
18846 (goto-char beg)
18847 (forward-line lines)
18848 (org-indent-line-to ind)))
18849 (set-marker beg nil)
18850 (set-marker end nil)))
18853 ;;;; LaTeX fragments
18855 (defun org-inside-LaTeX-fragment-p ()
18856 "Test if point is inside a LaTeX fragment.
18857 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18858 sequence appearing also before point.
18859 Even though the matchers for math are configurable, this function assumes
18860 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18861 delimiters are skipped when they have been removed by customization.
18862 The return value is nil, or a cons cell with the delimiter and the
18863 position of this delimiter.
18865 This function does a reasonably good job, but can locally be fooled by
18866 for example currency specifications. For example it will assume being in
18867 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18868 fragments that are properly closed, but during editing, we have to live
18869 with the uncertainty caused by missing closing delimiters. This function
18870 looks only before point, not after."
18871 (catch 'exit
18872 (let ((pos (point))
18873 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18874 (lim (progn
18875 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18876 (point)))
18877 dd-on str (start 0) m re)
18878 (goto-char pos)
18879 (when dodollar
18880 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18881 re (nth 1 (assoc "$" org-latex-regexps)))
18882 (while (string-match re str start)
18883 (cond
18884 ((= (match-end 0) (length str))
18885 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18886 ((= (match-end 0) (- (length str) 5))
18887 (throw 'exit nil))
18888 (t (setq start (match-end 0))))))
18889 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18890 (goto-char pos)
18891 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18892 (and (match-beginning 2) (throw 'exit nil))
18893 ;; count $$
18894 (while (re-search-backward "\\$\\$" lim t)
18895 (setq dd-on (not dd-on)))
18896 (goto-char pos)
18897 (if dd-on (cons "$$" m))))))
18899 (defun org-inside-latex-macro-p ()
18900 "Is point inside a LaTeX macro or its arguments?"
18901 (save-match-data
18902 (org-in-regexp
18903 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18905 (defvar org-latex-fragment-image-overlays nil
18906 "List of overlays carrying the images of latex fragments.")
18907 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18909 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18910 "Remove all overlays with LaTeX fragment images in current buffer.
18911 When optional arguments BEG and END are non-nil, remove all
18912 overlays between them instead. Return t when some overlays were
18913 removed, nil otherwise."
18914 (let (removedp)
18915 (setq org-latex-fragment-image-overlays
18916 (let ((beg (or beg (point-min)))
18917 (end (or end (point-max))))
18918 (org-remove-if
18919 (lambda (o)
18920 (and (>= (overlay-start o) beg)
18921 (<= (overlay-end o) end)
18922 (progn (delete-overlay o)
18923 (or removedp (setq removedp t)))))
18924 org-latex-fragment-image-overlays)))
18925 removedp))
18927 (define-obsolete-function-alias
18928 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18929 (defun org-toggle-latex-fragment (&optional arg)
18930 "Preview the LaTeX fragment at point, or all locally or globally.
18932 If the cursor is on a LaTeX fragment, create the image and overlay
18933 it over the source code, if there is none. Remove it otherwise.
18934 If there is no fragment at point, display all fragments in the
18935 current section.
18937 With prefix ARG, preview or clear image for all fragments in the
18938 current subtree or in the whole buffer when used before the first
18939 headline. With a double prefix ARG \\[universal-argument] \
18940 \\[universal-argument] preview or clear images
18941 for all fragments in the buffer."
18942 (interactive "P")
18943 (unless (buffer-file-name (buffer-base-buffer))
18944 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18945 (when (display-graphic-p)
18946 (catch 'exit
18947 (save-excursion
18948 (let ((window-start (window-start)) msg)
18949 (save-restriction
18950 (cond
18951 ((or (equal arg '(16))
18952 (and (equal arg '(4))
18953 (org-with-limited-levels (org-before-first-heading-p))))
18954 (if (org-remove-latex-fragment-image-overlays)
18955 (progn (message "LaTeX fragments images removed from buffer")
18956 (throw 'exit nil))
18957 (setq msg "Creating images for buffer...")))
18958 ((equal arg '(4))
18959 (org-with-limited-levels (org-back-to-heading t))
18960 (let ((beg (point))
18961 (end (progn (org-end-of-subtree t) (point))))
18962 (if (org-remove-latex-fragment-image-overlays beg end)
18963 (progn
18964 (message "LaTeX fragment images removed from subtree")
18965 (throw 'exit nil))
18966 (setq msg "Creating images for subtree...")
18967 (narrow-to-region beg end))))
18968 ((let ((datum (org-element-context)))
18969 (when (memq (org-element-type datum)
18970 '(latex-environment latex-fragment))
18971 (let* ((beg (org-element-property :begin datum))
18972 (end (org-element-property :end datum)))
18973 (if (org-remove-latex-fragment-image-overlays beg end)
18974 (progn (message "LaTeX fragment image removed")
18975 (throw 'exit nil))
18976 (narrow-to-region beg end)
18977 (setq msg "Creating image..."))))))
18979 (org-with-limited-levels
18980 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18981 (outline-previous-heading)
18982 (point)))
18983 (end (progn (outline-next-heading) (point))))
18984 (if (org-remove-latex-fragment-image-overlays beg end)
18985 (progn
18986 (message "LaTeX fragment images removed from section")
18987 (throw 'exit nil))
18988 (setq msg "Creating images for section...")
18989 (narrow-to-region beg end))))))
18990 (let ((file (buffer-file-name (buffer-base-buffer))))
18991 (org-format-latex
18992 (concat org-latex-preview-ltxpng-directory
18993 (file-name-sans-extension (file-name-nondirectory file)))
18994 ;; Emacs cannot overlay images from remote hosts.
18995 ;; Create it in `temporary-file-directory' instead.
18996 (if (file-remote-p file) temporary-file-directory
18997 default-directory)
18998 'overlays msg 'forbuffer
18999 org-latex-create-formula-image-program)))
19000 ;; Work around a bug that doesn't restore window's start
19001 ;; when widening back the buffer.
19002 (set-window-start nil window-start)
19003 (message (concat msg "done")))))))
19005 (defun org-format-latex
19006 (prefix &optional dir overlays msg forbuffer processing-type)
19007 "Replace LaTeX fragments with links to an image, and produce images.
19009 When optional argument OVERLAYS is non-nil, display the image on
19010 top of the fragment instead of replacing it.
19012 PROCESSING-TYPE is the conversion method to use, as a symbol.
19014 Some of the options can be changed using the variable
19015 `org-format-latex-options', which see."
19016 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19017 (unless (eq processing-type 'verbatim)
19018 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19019 (cnt 0)
19020 checkdir-flag)
19021 (goto-char (point-min))
19022 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19023 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19024 (overlay-recenter (point-max)))
19025 (while (re-search-forward math-regexp nil t)
19026 (unless (and overlays
19027 (eq (get-char-property (point) 'org-overlay-type)
19028 'org-latex-overlay))
19029 (let* ((context (org-element-context))
19030 (type (org-element-type context)))
19031 (when (memq type '(latex-environment latex-fragment))
19032 (let ((block-type (eq type 'latex-environment))
19033 (value (org-element-property :value context))
19034 (beg (org-element-property :begin context))
19035 (end (save-excursion
19036 (goto-char (org-element-property :end context))
19037 (skip-chars-backward " \r\t\n")
19038 (point))))
19039 (case processing-type
19040 (mathjax
19041 ;; Prepare for MathJax processing.
19042 (if (eq (char-after beg) ?$)
19043 (save-excursion
19044 (delete-region beg end)
19045 (insert "\\(" (substring value 1 -1) "\\)"))
19046 (goto-char end)))
19047 ((dvipng imagemagick)
19048 ;; Process to an image.
19049 (incf cnt)
19050 (goto-char beg)
19051 (let* ((face (face-at-point))
19052 ;; Get the colors from the face at point.
19054 (let ((color (plist-get org-format-latex-options
19055 :foreground)))
19056 (if (and forbuffer (eq color 'auto))
19057 (face-attribute face :foreground nil 'default)
19058 color)))
19060 (let ((color (plist-get org-format-latex-options
19061 :background)))
19062 (if (and forbuffer (eq color 'auto))
19063 (face-attribute face :background nil 'default)
19064 color)))
19065 (hash (sha1 (prin1-to-string
19066 (list org-format-latex-header
19067 org-latex-default-packages-alist
19068 org-latex-packages-alist
19069 org-format-latex-options
19070 forbuffer value fg bg))))
19071 (absprefix (expand-file-name prefix dir))
19072 (linkfile (format "%s_%s.png" prefix hash))
19073 (movefile (format "%s_%s.png" absprefix hash))
19074 (sep (and block-type "\n\n"))
19075 (link (concat sep "[[file:" linkfile "]]" sep))
19076 (options
19077 (org-combine-plists
19078 org-format-latex-options
19079 `(:foreground ,fg :background ,bg))))
19080 (when msg (message msg cnt))
19081 (unless checkdir-flag ; Ensure the directory exists.
19082 (setq checkdir-flag t)
19083 (let ((todir (file-name-directory absprefix)))
19084 (unless (file-directory-p todir)
19085 (make-directory todir t))))
19086 (unless (file-exists-p movefile)
19087 (org-create-formula-image
19088 value movefile options forbuffer processing-type))
19089 (if overlays
19090 (progn
19091 (dolist (o (overlays-in beg end))
19092 (when (eq (overlay-get o 'org-overlay-type)
19093 'org-latex-overlay)
19094 (delete-overlay o)))
19095 (let ((ov (make-overlay beg end)))
19096 (overlay-put ov
19097 'org-overlay-type
19098 'org-latex-overlay)
19099 (overlay-put ov 'evaporate t)
19100 (if (featurep 'xemacs)
19101 (progn
19102 (overlay-put ov 'invisible t)
19103 (overlay-put
19104 ov 'end-glyph
19105 (make-glyph
19106 (vector 'png :file movefile))))
19107 (overlay-put
19108 ov 'display
19109 (list 'image
19110 :type 'png
19111 :file movefile
19112 :ascent 'center)))
19113 (push ov org-latex-fragment-image-overlays))
19114 (goto-char end))
19115 (delete-region beg end)
19116 (insert
19117 (org-add-props link
19118 (list 'org-latex-src
19119 (replace-regexp-in-string "\"" "" value)
19120 'org-latex-src-embed-type
19121 (if block-type 'paragraph 'character)))))))
19122 (mathml
19123 ;; Process to MathML.
19124 (unless (org-format-latex-mathml-available-p)
19125 (user-error "LaTeX to MathML converter not configured"))
19126 (incf cnt)
19127 (when msg (message msg cnt))
19128 (goto-char beg)
19129 (delete-region beg end)
19130 (insert (org-format-latex-as-mathml
19131 value block-type prefix dir)))
19132 (otherwise
19133 (error "Unknown conversion type %s for LaTeX fragments"
19134 processing-type)))))))))))
19136 (defun org-create-math-formula (latex-frag &optional mathml-file)
19137 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19138 Use `org-latex-to-mathml-convert-command'. If the conversion is
19139 sucessful, return the portion between \"<math...> </math>\"
19140 elements otherwise return nil. When MATHML-FILE is specified,
19141 write the results in to that file. When invoked as an
19142 interactive command, prompt for LATEX-FRAG, with initial value
19143 set to the current active region and echo the results for user
19144 inspection."
19145 (interactive (list (let ((frag (when (org-region-active-p)
19146 (buffer-substring-no-properties
19147 (region-beginning) (region-end)))))
19148 (read-string "LaTeX Fragment: " frag nil frag))))
19149 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19150 (let* ((tmp-in-file (file-relative-name
19151 (make-temp-name (expand-file-name "ltxmathml-in"))))
19152 (ignore (write-region latex-frag nil tmp-in-file))
19153 (tmp-out-file (file-relative-name
19154 (make-temp-name (expand-file-name "ltxmathml-out"))))
19155 (cmd (format-spec
19156 org-latex-to-mathml-convert-command
19157 `((?j . ,(and org-latex-to-mathml-jar-file
19158 (shell-quote-argument
19159 (expand-file-name
19160 org-latex-to-mathml-jar-file))))
19161 (?I . ,(shell-quote-argument tmp-in-file))
19162 (?i . ,latex-frag)
19163 (?o . ,(shell-quote-argument tmp-out-file)))))
19164 mathml shell-command-output)
19165 (when (org-called-interactively-p 'any)
19166 (unless (org-format-latex-mathml-available-p)
19167 (user-error "LaTeX to MathML converter not configured")))
19168 (message "Running %s" cmd)
19169 (setq shell-command-output (shell-command-to-string cmd))
19170 (setq mathml
19171 (when (file-readable-p tmp-out-file)
19172 (with-current-buffer (find-file-noselect tmp-out-file t)
19173 (goto-char (point-min))
19174 (when (re-search-forward
19175 (concat
19176 (regexp-quote
19177 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19178 "[^>]*?>"
19179 "\\(.\\|\n\\)*"
19180 "</math>")
19181 nil t)
19182 (prog1 (match-string 0) (kill-buffer))))))
19183 (cond
19184 (mathml
19185 (setq mathml
19186 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19187 (when mathml-file
19188 (write-region mathml nil mathml-file))
19189 (when (org-called-interactively-p 'any)
19190 (message mathml)))
19191 ((message "LaTeX to MathML conversion failed")
19192 (message shell-command-output)))
19193 (delete-file tmp-in-file)
19194 (when (file-exists-p tmp-out-file)
19195 (delete-file tmp-out-file))
19196 mathml))
19198 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19199 prefix &optional dir)
19200 "Use `org-create-math-formula' but check local cache first."
19201 (let* ((absprefix (expand-file-name prefix dir))
19202 (print-length nil) (print-level nil)
19203 (formula-id (concat
19204 "formula-"
19205 (sha1
19206 (prin1-to-string
19207 (list latex-frag
19208 org-latex-to-mathml-convert-command)))))
19209 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19210 (formula-cache-dir (file-name-directory formula-cache)))
19212 (unless (file-directory-p formula-cache-dir)
19213 (make-directory formula-cache-dir t))
19215 (unless (file-exists-p formula-cache)
19216 (org-create-math-formula latex-frag formula-cache))
19218 (if (file-exists-p formula-cache)
19219 ;; Successful conversion. Return the link to MathML file.
19220 (org-add-props
19221 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19222 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19223 'org-latex-src-embed-type (if latex-frag-type
19224 'paragraph 'character)))
19225 ;; Failed conversion. Return the LaTeX fragment verbatim
19226 latex-frag)))
19228 (defun org-create-formula-image (string tofile options buffer &optional type)
19229 "Create an image from LaTeX source using dvipng or convert.
19230 This function calls either `org-create-formula-image-with-dvipng'
19231 or `org-create-formula-image-with-imagemagick' depending on the
19232 value of `org-latex-create-formula-image-program' or on the value
19233 of the optional TYPE variable.
19235 Note: ultimately these two function should be combined as they
19236 share a good deal of logic."
19237 (org-check-external-command
19238 "latex" "needed to convert LaTeX fragments to images")
19239 (funcall
19240 (case (or type org-latex-create-formula-image-program)
19241 (dvipng
19242 (org-check-external-command
19243 "dvipng" "needed to convert LaTeX fragments to images")
19244 #'org-create-formula-image-with-dvipng)
19245 (imagemagick
19246 (org-check-external-command
19247 "convert" "you need to install imagemagick")
19248 #'org-create-formula-image-with-imagemagick)
19249 (t (error
19250 "Invalid value of `org-latex-create-formula-image-program'")))
19251 string tofile options buffer))
19253 (declare-function org-export-get-backend "ox" (name))
19254 (declare-function org-export--get-global-options "ox" (&optional backend))
19255 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19256 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19257 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19258 (defun org-create-formula--latex-header ()
19259 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19260 (let ((info (org-combine-plists (org-export--get-global-options
19261 (org-export-get-backend 'latex))
19262 (org-export--get-inbuffer-options
19263 (org-export-get-backend 'latex)))))
19264 (org-latex-guess-babel-language
19265 (org-latex-guess-inputenc
19266 (org-splice-latex-header
19267 org-format-latex-header
19268 org-latex-default-packages-alist
19269 org-latex-packages-alist t
19270 (plist-get info :latex-header)))
19271 info)))
19273 (defun org--get-display-dpi ()
19274 "Get the DPI of the display.
19276 Assumes that the display has the same pixel width in the
19277 horizontal and vertical directions."
19278 (if (display-graphic-p)
19279 (round (/ (display-pixel-height)
19280 (/ (display-mm-height) 25.4)))
19281 (error "Attempt to calculate the dpi of a non-graphic display")))
19283 ;; This function borrows from Ganesh Swami's latex2png.el
19284 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19285 "This calls dvipng."
19286 (require 'ox-latex)
19287 (let* ((tmpdir (if (featurep 'xemacs)
19288 (temp-directory)
19289 temporary-file-directory))
19290 (texfilebase (make-temp-name
19291 (expand-file-name "orgtex" tmpdir)))
19292 (texfile (concat texfilebase ".tex"))
19293 (dvifile (concat texfilebase ".dvi"))
19294 (pngfile (concat texfilebase ".png"))
19295 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19296 ;; This assumes that the display has the same pixel width in
19297 ;; the horizontal and vertical directions
19298 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19299 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19300 "Black"))
19301 (bg (or (plist-get options (if buffer :background :html-background))
19302 "Transparent")))
19303 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19304 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19305 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19306 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19307 (let ((latex-header (org-create-formula--latex-header)))
19308 (with-temp-file texfile
19309 (insert latex-header)
19310 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19311 (let ((dir default-directory))
19312 (ignore-errors
19313 (cd tmpdir)
19314 (call-process "latex" nil nil nil texfile))
19315 (cd dir))
19316 (if (not (file-exists-p dvifile))
19317 (progn (message "Failed to create dvi file from %s" texfile) nil)
19318 (ignore-errors
19319 (if (featurep 'xemacs)
19320 (call-process "dvipng" nil nil nil
19321 "-fg" fg "-bg" bg
19322 "-T" "tight"
19323 "-o" pngfile
19324 dvifile)
19325 (call-process "dvipng" nil nil nil
19326 "-fg" fg "-bg" bg
19327 "-D" dpi
19328 ;;"-x" scale "-y" scale
19329 "-T" "tight"
19330 "-o" pngfile
19331 dvifile)))
19332 (if (not (file-exists-p pngfile))
19333 (if org-format-latex-signal-error
19334 (error "Failed to create png file from %s" texfile)
19335 (message "Failed to create png file from %s" texfile)
19336 nil)
19337 ;; Use the requested file name and clean up
19338 (copy-file pngfile tofile 'replace)
19339 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19340 (if (file-exists-p (concat texfilebase e))
19341 (delete-file (concat texfilebase e))))
19342 pngfile))))
19344 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19345 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19346 "This calls convert, which is included into imagemagick."
19347 (require 'ox-latex)
19348 (let* ((tmpdir (if (featurep 'xemacs)
19349 (temp-directory)
19350 temporary-file-directory))
19351 (texfilebase (make-temp-name
19352 (expand-file-name "orgtex" tmpdir)))
19353 (texfile (concat texfilebase ".tex"))
19354 (pdffile (concat texfilebase ".pdf"))
19355 (pngfile (concat texfilebase ".png"))
19356 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19357 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19358 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19359 "black"))
19360 (bg (or (plist-get options (if buffer :background :html-background))
19361 "white")))
19362 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19363 (setq fg (org-latex-color-format fg)))
19364 (if (eq bg 'default) (setq bg (org-latex-color :background))
19365 (setq bg (org-latex-color-format
19366 (if (string= bg "Transparent") "white" bg))))
19367 (let ((latex-header (org-create-formula--latex-header)))
19368 (with-temp-file texfile
19369 (insert latex-header)
19370 (insert "\n\\begin{document}\n"
19371 "\\definecolor{fg}{rgb}{" fg "}\n"
19372 "\\definecolor{bg}{rgb}{" bg "}\n"
19373 "\n\\pagecolor{bg}\n"
19374 "\n{\\color{fg}\n"
19375 string
19376 "\n}\n"
19377 "\n\\end{document}\n")))
19378 (org-latex-compile texfile t)
19379 (if (not (file-exists-p pdffile))
19380 (progn (message "Failed to create pdf file from %s" texfile) nil)
19381 (ignore-errors
19382 (if (featurep 'xemacs)
19383 (call-process "convert" nil nil nil
19384 "-density" "96"
19385 "-trim"
19386 "-antialias"
19387 pdffile
19388 "-quality" "100"
19389 ;; "-sharpen" "0x1.0"
19390 pngfile)
19391 (call-process "convert" nil nil nil
19392 "-density" dpi
19393 "-trim"
19394 "-antialias"
19395 pdffile
19396 "-quality" "100"
19397 ;; "-sharpen" "0x1.0"
19398 pngfile)))
19399 (if (not (file-exists-p pngfile))
19400 (if org-format-latex-signal-error
19401 (error "Failed to create png file from %s" texfile)
19402 (message "Failed to create png file from %s" texfile)
19403 nil)
19404 ;; Use the requested file name and clean up
19405 (copy-file pngfile tofile 'replace)
19406 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19407 (if (file-exists-p (concat texfilebase e))
19408 (delete-file (concat texfilebase e))))
19409 pngfile))))
19411 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19412 "Fill a LaTeX header template TPL.
19413 In the template, the following place holders will be recognized:
19415 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19416 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19417 [PACKAGES] \\usepackage statements for PKG
19418 [NO-PACKAGES] do not include PKG
19419 [EXTRA] the string EXTRA
19420 [NO-EXTRA] do not include EXTRA
19422 For backward compatibility, if both the positive and the negative place
19423 holder is missing, the positive one (without the \"NO-\") will be
19424 assumed to be present at the end of the template.
19425 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19426 EXTRA is a string.
19427 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19428 (let (rpl (end ""))
19429 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19430 (setq rpl (if (or (match-end 1) (not def-pkg))
19431 "" (org-latex-packages-to-string def-pkg snippets-p t))
19432 tpl (replace-match rpl t t tpl))
19433 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19435 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19436 (setq rpl (if (or (match-end 1) (not pkg))
19437 "" (org-latex-packages-to-string pkg snippets-p t))
19438 tpl (replace-match rpl t t tpl))
19439 (if pkg (setq end
19440 (concat end "\n"
19441 (org-latex-packages-to-string pkg snippets-p)))))
19443 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19444 (setq rpl (if (or (match-end 1) (not extra))
19445 "" (concat extra "\n"))
19446 tpl (replace-match rpl t t tpl))
19447 (if (and extra (string-match "\\S-" extra))
19448 (setq end (concat end "\n" extra))))
19450 (if (string-match "\\S-" end)
19451 (concat tpl "\n" end)
19452 tpl)))
19454 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19455 "Turn an alist of packages into a string with the \\usepackage macros."
19456 (setq pkg (mapconcat (lambda(p)
19457 (cond
19458 ((stringp p) p)
19459 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19460 (format "%% Package %s omitted" (cadr p)))
19461 ((equal "" (car p))
19462 (format "\\usepackage{%s}" (cadr p)))
19464 (format "\\usepackage[%s]{%s}"
19465 (car p) (cadr p)))))
19467 "\n"))
19468 (if newline (concat pkg "\n") pkg))
19470 (defun org-dvipng-color (attr)
19471 "Return a RGB color specification for dvipng."
19472 (apply 'format "rgb %s %s %s"
19473 (mapcar 'org-normalize-color
19474 (if (featurep 'xemacs)
19475 (color-rgb-components
19476 (face-property 'default
19477 (cond ((eq attr :foreground) 'foreground)
19478 ((eq attr :background) 'background))))
19479 (color-values (face-attribute 'default attr nil))))))
19481 (defun org-dvipng-color-format (color-name)
19482 "Convert COLOR-NAME to a RGB color value for dvipng."
19483 (apply 'format "rgb %s %s %s"
19484 (mapcar 'org-normalize-color
19485 (color-values color-name))))
19487 (defun org-latex-color (attr)
19488 "Return a RGB color for the LaTeX color package."
19489 (apply 'format "%s,%s,%s"
19490 (mapcar 'org-normalize-color
19491 (if (featurep 'xemacs)
19492 (color-rgb-components
19493 (face-property 'default
19494 (cond ((eq attr :foreground) 'foreground)
19495 ((eq attr :background) 'background))))
19496 (color-values (face-attribute 'default attr nil))))))
19498 (defun org-latex-color-format (color-name)
19499 "Convert COLOR-NAME to a RGB color value."
19500 (apply 'format "%s,%s,%s"
19501 (mapcar 'org-normalize-color
19502 (color-values color-name))))
19504 (defun org-normalize-color (value)
19505 "Return string to be used as color value for an RGB component."
19506 (format "%g" (/ value 65535.0)))
19510 ;; Image display
19512 (defvar org-inline-image-overlays nil)
19513 (make-variable-buffer-local 'org-inline-image-overlays)
19515 (defun org-toggle-inline-images (&optional include-linked)
19516 "Toggle the display of inline images.
19517 INCLUDE-LINKED is passed to `org-display-inline-images'."
19518 (interactive "P")
19519 (if org-inline-image-overlays
19520 (progn
19521 (org-remove-inline-images)
19522 (when (org-called-interactively-p 'interactive)
19523 (message "Inline image display turned off")))
19524 (org-display-inline-images include-linked)
19525 (when (org-called-interactively-p 'interactive)
19526 (message (if org-inline-image-overlays
19527 (format "%d images displayed inline"
19528 (length org-inline-image-overlays))
19529 "No images to display inline")))))
19531 (defun org-redisplay-inline-images ()
19532 "Refresh the display of inline images."
19533 (interactive)
19534 (if (not org-inline-image-overlays)
19535 (org-toggle-inline-images)
19536 (org-toggle-inline-images)
19537 (org-toggle-inline-images)))
19539 (defun org-display-inline-images (&optional include-linked refresh beg end)
19540 "Display inline images.
19542 An inline image is a link which follows either of these
19543 conventions:
19545 1. Its path is a file with an extension matching return value
19546 from `image-file-name-regexp' and it has no contents.
19548 2. Its description consists in a single link of the previous
19549 type.
19551 When optional argument INCLUDE-LINKED is non-nil, also links with
19552 a text description part will be inlined. This can be nice for
19553 a quick look at those images, but it does not reflect what
19554 exported files will look like.
19556 When optional argument REFRESH is non-nil, refresh existing
19557 images between BEG and END. This will create new image displays
19558 only if necessary. BEG and END default to the buffer
19559 boundaries."
19560 (interactive "P")
19561 (when (display-graphic-p)
19562 (unless refresh
19563 (org-remove-inline-images)
19564 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19565 (org-with-wide-buffer
19566 (goto-char (or beg (point-min)))
19567 (let ((case-fold-search t)
19568 (file-extension-re (org-image-file-name-regexp)))
19569 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19570 (let ((link (save-match-data (org-element-context))))
19571 ;; Check if we're at an inline image.
19572 (when (and (equal (org-element-property :type link) "file")
19573 (or include-linked
19574 (not (org-element-property :contents-begin link)))
19575 (let ((parent (org-element-property :parent link)))
19576 (or (not (eq (org-element-type parent) 'link))
19577 (not (cdr (org-element-contents parent)))))
19578 (org-string-match-p file-extension-re
19579 (org-element-property :path link)))
19580 (let ((file (expand-file-name
19581 (org-link-unescape
19582 (org-element-property :path link)))))
19583 (when (file-exists-p file)
19584 (let ((width
19585 ;; Apply `org-image-actual-width' specifications.
19586 (cond
19587 ((not (image-type-available-p 'imagemagick)) nil)
19588 ((eq org-image-actual-width t) nil)
19589 ((listp org-image-actual-width)
19591 ;; First try to find a width among
19592 ;; attributes associated to the paragraph
19593 ;; containing link.
19594 (let ((paragraph
19595 (let ((e link))
19596 (while (and (setq e (org-element-property
19597 :parent e))
19598 (not (eq (org-element-type e)
19599 'paragraph))))
19600 e)))
19601 (when paragraph
19602 (save-excursion
19603 (goto-char (org-element-property :begin paragraph))
19604 (when
19605 (re-search-forward
19606 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19607 (org-element-property
19608 :post-affiliated paragraph)
19610 (string-to-number (match-string 1))))))
19611 ;; Otherwise, fall-back to provided number.
19612 (car org-image-actual-width)))
19613 ((numberp org-image-actual-width)
19614 org-image-actual-width)))
19615 (old (get-char-property-and-overlay
19616 (org-element-property :begin link)
19617 'org-image-overlay)))
19618 (if (and (car-safe old) refresh)
19619 (image-refresh (overlay-get (cdr old) 'display))
19620 (let ((image (create-image file
19621 (and width 'imagemagick)
19623 :width width)))
19624 (when image
19625 (let* ((link
19626 ;; If inline image is the description
19627 ;; of another link, be sure to
19628 ;; consider the latter as the one to
19629 ;; apply the overlay on.
19630 (let ((parent
19631 (org-element-property :parent link)))
19632 (if (eq (org-element-type parent) 'link)
19633 parent
19634 link)))
19635 (ov (make-overlay
19636 (org-element-property :begin link)
19637 (progn
19638 (goto-char
19639 (org-element-property :end link))
19640 (skip-chars-backward " \t")
19641 (point)))))
19642 (overlay-put ov 'display image)
19643 (overlay-put ov 'face 'default)
19644 (overlay-put ov 'org-image-overlay t)
19645 (overlay-put
19646 ov 'modification-hooks
19647 (list 'org-display-inline-remove-overlay))
19648 (push ov org-inline-image-overlays)))))))))))))))
19650 (define-obsolete-function-alias
19651 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19653 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19654 "Remove inline-display overlay if a corresponding region is modified."
19655 (let ((inhibit-modification-hooks t))
19656 (when (and ov after)
19657 (delete ov org-inline-image-overlays)
19658 (delete-overlay ov))))
19660 (defun org-remove-inline-images ()
19661 "Remove inline display of images."
19662 (interactive)
19663 (mapc 'delete-overlay org-inline-image-overlays)
19664 (setq org-inline-image-overlays nil))
19666 ;;;; Key bindings
19668 ;; Outline functions from `outline-mode-prefix-map'
19669 ;; that can be remapped in Org:
19670 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19671 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19672 (define-key org-mode-map [remap outline-forward-same-level]
19673 'org-forward-heading-same-level)
19674 (define-key org-mode-map [remap outline-backward-same-level]
19675 'org-backward-heading-same-level)
19676 (define-key org-mode-map [remap show-branches]
19677 'org-kill-note-or-show-branches)
19678 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19679 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19680 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19681 (define-key org-mode-map [remap outline-next-visible-heading]
19682 'org-next-visible-heading)
19683 (define-key org-mode-map [remap outline-previous-visible-heading]
19684 'org-previous-visible-heading)
19686 ;; Outline functions from `outline-mode-prefix-map' that can not
19687 ;; be remapped in Org:
19689 ;; - the column "key binding" shows whether the Outline function is still
19690 ;; available in Org mode on the same key that it has been bound to in
19691 ;; Outline mode:
19692 ;; - "overridden": key used for a different functionality in Org mode
19693 ;; - else: key still bound to the same Outline function in Org mode
19695 ;; | Outline function | key binding | Org replacement |
19696 ;; |------------------------------------+-------------+--------------------------|
19697 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19698 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19699 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19700 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19701 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19702 ;; | `show-entry' | overridden | no replacement |
19703 ;; | `show-children' | `C-c C-i' | visibility cycling |
19704 ;; | `show-branches' | `C-c C-k' | still same function |
19705 ;; | `show-subtree' | overridden | visibility cycling |
19706 ;; | `show-all' | overridden | no replacement |
19707 ;; | `hide-subtree' | overridden | visibility cycling |
19708 ;; | `hide-body' | overridden | no replacement |
19709 ;; | `hide-entry' | overridden | visibility cycling |
19710 ;; | `hide-leaves' | overridden | no replacement |
19711 ;; | `hide-sublevels' | overridden | no replacement |
19712 ;; | `hide-other' | overridden | no replacement |
19714 ;; Make `C-c C-x' a prefix key
19715 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19717 ;; TAB key with modifiers
19718 (org-defkey org-mode-map "\C-i" 'org-cycle)
19719 (org-defkey org-mode-map [(tab)] 'org-cycle)
19720 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19721 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19722 ;; The following line is necessary under Suse GNU/Linux
19723 (unless (featurep 'xemacs)
19724 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19725 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19726 (define-key org-mode-map [backtab] 'org-shifttab)
19728 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19729 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19730 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19732 ;; Cursor keys with modifiers
19733 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19734 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19735 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19736 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19738 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19739 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19740 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19741 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19742 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19743 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19745 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19746 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19747 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19748 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19750 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19751 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19752 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19753 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19755 ;; Babel keys
19756 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19757 (mapc (lambda (pair)
19758 (define-key org-babel-map (car pair) (cdr pair)))
19759 org-babel-key-bindings)
19761 ;;; Extra keys for tty access.
19762 ;; We only set them when really needed because otherwise the
19763 ;; menus don't show the simple keys
19765 (when (or org-use-extra-keys
19766 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19767 (not window-system))
19768 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19769 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19770 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19771 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19772 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19773 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19774 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19775 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19776 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19777 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19778 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19779 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19780 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19781 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19782 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19783 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19784 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19785 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19786 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19787 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19788 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19789 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19790 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19791 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19792 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19793 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19794 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19795 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19797 ;; All the other keys
19799 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19800 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19801 (if (boundp 'narrow-map)
19802 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19803 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19804 (if (boundp 'narrow-map)
19805 (org-defkey narrow-map "b" 'org-narrow-to-block)
19806 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19807 (if (boundp 'narrow-map)
19808 (org-defkey narrow-map "e" 'org-narrow-to-element)
19809 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19810 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19811 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19812 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19813 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19814 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19815 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19816 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19817 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19818 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19819 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19820 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19821 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19822 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19823 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19824 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19825 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19826 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19827 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19828 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19829 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19830 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19831 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19832 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19833 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19834 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19835 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19836 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19837 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19838 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19839 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19840 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19841 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19842 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19843 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19844 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19845 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19846 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19847 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19848 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19849 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19850 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19851 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19852 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19853 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19854 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19855 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19856 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19857 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19858 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19859 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19860 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19861 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19862 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19863 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19864 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19865 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19866 (org-defkey org-mode-map "\C-c^" 'org-sort)
19867 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19868 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19869 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19870 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19871 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19872 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19873 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19874 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19875 (org-defkey org-mode-map "\C-m" 'org-return)
19876 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19877 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19878 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19879 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19880 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19881 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19882 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19883 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19884 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19885 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19886 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19887 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19888 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19889 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19890 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19891 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19892 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19893 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19894 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19895 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19896 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19897 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19898 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19899 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19900 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19902 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19903 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19904 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19906 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19907 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19908 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19909 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19910 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19911 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19912 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19913 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19914 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19915 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19916 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19917 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19918 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19919 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19920 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19921 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19922 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19923 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19924 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19925 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19926 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19927 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19929 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19930 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19931 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19932 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19933 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19935 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19937 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19939 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19940 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19942 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19945 (when (featurep 'xemacs)
19946 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19949 (defconst org-speed-commands-default
19951 ("Outline Navigation")
19952 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19953 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19954 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19955 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19956 ("F" . org-next-block)
19957 ("B" . org-previous-block)
19958 ("u" . (org-speed-move-safe 'outline-up-heading))
19959 ("j" . org-goto)
19960 ("g" . (org-refile t))
19961 ("Outline Visibility")
19962 ("c" . org-cycle)
19963 ("C" . org-shifttab)
19964 (" " . org-display-outline-path)
19965 ("s" . org-narrow-to-subtree)
19966 ("=" . org-columns)
19967 ("Outline Structure Editing")
19968 ("U" . org-metaup)
19969 ("D" . org-metadown)
19970 ("r" . org-metaright)
19971 ("l" . org-metaleft)
19972 ("R" . org-shiftmetaright)
19973 ("L" . org-shiftmetaleft)
19974 ("i" . (progn (forward-char 1) (call-interactively
19975 'org-insert-heading-respect-content)))
19976 ("^" . org-sort)
19977 ("w" . org-refile)
19978 ("a" . org-archive-subtree-default-with-confirmation)
19979 ("@" . org-mark-subtree)
19980 ("#" . org-toggle-comment)
19981 ("Clock Commands")
19982 ("I" . org-clock-in)
19983 ("O" . org-clock-out)
19984 ("Meta Data Editing")
19985 ("t" . org-todo)
19986 ("," . (org-priority))
19987 ("0" . (org-priority ?\ ))
19988 ("1" . (org-priority ?A))
19989 ("2" . (org-priority ?B))
19990 ("3" . (org-priority ?C))
19991 (":" . org-set-tags-command)
19992 ("e" . org-set-effort)
19993 ("E" . org-inc-effort)
19994 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19995 (org-entry-put (point) "APPT_WARNTIME" m)))
19996 ("Agenda Views etc")
19997 ("v" . org-agenda)
19998 ("/" . org-sparse-tree)
19999 ("Misc")
20000 ("o" . org-open-at-point)
20001 ("?" . org-speed-command-help)
20002 ("<" . (org-agenda-set-restriction-lock 'subtree))
20003 (">" . (org-agenda-remove-restriction-lock))
20005 "The default speed commands.")
20007 (defun org-print-speed-command (e)
20008 (if (> (length (car e)) 1)
20009 (progn
20010 (princ "\n")
20011 (princ (car e))
20012 (princ "\n")
20013 (princ (make-string (length (car e)) ?-))
20014 (princ "\n"))
20015 (princ (car e))
20016 (princ " ")
20017 (if (symbolp (cdr e))
20018 (princ (symbol-name (cdr e)))
20019 (prin1 (cdr e)))
20020 (princ "\n")))
20022 (defun org-speed-command-help ()
20023 "Show the available speed commands."
20024 (interactive)
20025 (if (not org-use-speed-commands)
20026 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20027 (with-output-to-temp-buffer "*Help*"
20028 (princ "User-defined Speed commands\n===========================\n")
20029 (mapc 'org-print-speed-command org-speed-commands-user)
20030 (princ "\n")
20031 (princ "Built-in Speed commands\n=======================\n")
20032 (mapc 'org-print-speed-command org-speed-commands-default))
20033 (with-current-buffer "*Help*"
20034 (setq truncate-lines t))))
20036 (defun org-speed-move-safe (cmd)
20037 "Execute CMD, but make sure that the cursor always ends up in a headline.
20038 If not, return to the original position and throw an error."
20039 (interactive)
20040 (let ((pos (point)))
20041 (call-interactively cmd)
20042 (unless (and (bolp) (org-at-heading-p))
20043 (goto-char pos)
20044 (error "Boundary reached while executing %s" cmd))))
20046 (defvar org-self-insert-command-undo-counter 0)
20048 (defvar org-table-auto-blank-field) ; defined in org-table.el
20049 (defvar org-speed-command nil)
20051 (define-obsolete-function-alias
20052 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20054 (defun org-speed-command-activate (keys)
20055 "Hook for activating single-letter speed commands.
20056 `org-speed-commands-default' specifies a minimal command set.
20057 Use `org-speed-commands-user' for further customization."
20058 (when (or (and (bolp) (looking-at org-outline-regexp))
20059 (and (functionp org-use-speed-commands)
20060 (funcall org-use-speed-commands)))
20061 (cdr (assoc keys (append org-speed-commands-user
20062 org-speed-commands-default)))))
20064 (define-obsolete-function-alias
20065 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20067 (defun org-babel-speed-command-activate (keys)
20068 "Hook for activating single-letter code block commands."
20069 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20070 (cdr (assoc keys org-babel-key-bindings))))
20072 (defcustom org-speed-command-hook
20073 '(org-speed-command-default-hook org-babel-speed-command-hook)
20074 "Hook for activating speed commands at strategic locations.
20075 Hook functions are called in sequence until a valid handler is
20076 found.
20078 Each hook takes a single argument, a user-pressed command key
20079 which is also a `self-insert-command' from the global map.
20081 Within the hook, examine the cursor position and the command key
20082 and return nil or a valid handler as appropriate. Handler could
20083 be one of an interactive command, a function, or a form.
20085 Set `org-use-speed-commands' to non-nil value to enable this
20086 hook. The default setting is `org-speed-command-activate'."
20087 :group 'org-structure
20088 :version "24.1"
20089 :type 'hook)
20091 (defun org-self-insert-command (N)
20092 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20093 If the cursor is in a table looking at whitespace, the whitespace is
20094 overwritten, and the table is not marked as requiring realignment."
20095 (interactive "p")
20096 (org-check-before-invisible-edit 'insert)
20097 (cond
20098 ((and org-use-speed-commands
20099 (let ((kv (this-command-keys-vector)))
20100 (setq org-speed-command
20101 (run-hook-with-args-until-success
20102 'org-speed-command-hook
20103 (make-string 1 (aref kv (1- (length kv))))))))
20104 (cond
20105 ((commandp org-speed-command)
20106 (setq this-command org-speed-command)
20107 (call-interactively org-speed-command))
20108 ((functionp org-speed-command)
20109 (funcall org-speed-command))
20110 ((and org-speed-command (listp org-speed-command))
20111 (eval org-speed-command))
20112 (t (let (org-use-speed-commands)
20113 (call-interactively 'org-self-insert-command)))))
20114 ((and
20115 (org-table-p)
20116 (progn
20117 ;; check if we blank the field, and if that triggers align
20118 (and (featurep 'org-table) org-table-auto-blank-field
20119 (memq last-command
20120 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20121 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20122 ;; got extra space, this field does not determine column width
20123 (let (org-table-may-need-update) (org-table-blank-field))
20124 ;; no extra space, this field may determine column width
20125 (org-table-blank-field)))
20127 (eq N 1)
20128 (looking-at "[^|\n]* |"))
20129 (let (org-table-may-need-update)
20130 (goto-char (1- (match-end 0)))
20131 (backward-delete-char 1)
20132 (goto-char (match-beginning 0))
20133 (self-insert-command N)))
20135 (setq org-table-may-need-update t)
20136 (self-insert-command N)
20137 (org-fix-tags-on-the-fly)
20138 (if org-self-insert-cluster-for-undo
20139 (if (not (eq last-command 'org-self-insert-command))
20140 (setq org-self-insert-command-undo-counter 1)
20141 (if (>= org-self-insert-command-undo-counter 20)
20142 (setq org-self-insert-command-undo-counter 1)
20143 (and (> org-self-insert-command-undo-counter 0)
20144 buffer-undo-list (listp buffer-undo-list)
20145 (not (cadr buffer-undo-list)) ; remove nil entry
20146 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20147 (setq org-self-insert-command-undo-counter
20148 (1+ org-self-insert-command-undo-counter))))))))
20150 (defun org-check-before-invisible-edit (kind)
20151 "Check is editing if kind KIND would be dangerous with invisible text around.
20152 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20153 ;; First, try to get out of here as quickly as possible, to reduce overhead
20154 (if (and org-catch-invisible-edits
20155 (or (not (boundp 'visible-mode)) (not visible-mode))
20156 (or (get-char-property (point) 'invisible)
20157 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20158 ;; OK, we need to take a closer look
20159 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20160 (invisible-before-point (if (bobp) nil (get-char-property
20161 (1- (point)) 'invisible)))
20162 (border-and-ok-direction
20164 ;; Check if we are acting predictably before invisible text
20165 (and invisible-at-point (not invisible-before-point)
20166 (memq kind '(insert delete-backward)))
20167 ;; Check if we are acting predictably after invisible text
20168 ;; This works not well, and I have turned it off. It seems
20169 ;; better to always show and stop after invisible text.
20170 ;; (and (not invisible-at-point) invisible-before-point
20171 ;; (memq kind '(insert delete)))
20173 (when (or (memq invisible-at-point '(outline org-hide-block t))
20174 (memq invisible-before-point '(outline org-hide-block t)))
20175 (if (eq org-catch-invisible-edits 'error)
20176 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20177 (if (and org-custom-properties-overlays
20178 (y-or-n-p "Display invisible properties in this buffer? "))
20179 (org-toggle-custom-properties-visibility)
20180 ;; Make the area visible
20181 (save-excursion
20182 (if invisible-before-point
20183 (goto-char (previous-single-char-property-change
20184 (point) 'invisible)))
20185 (show-subtree))
20186 (cond
20187 ((eq org-catch-invisible-edits 'show)
20188 ;; That's it, we do the edit after showing
20189 (message
20190 "Unfolding invisible region around point before editing")
20191 (sit-for 1))
20192 ((and (eq org-catch-invisible-edits 'smart)
20193 border-and-ok-direction)
20194 (message "Unfolding invisible region around point before editing"))
20196 ;; Don't do the edit, make the user repeat it in full visibility
20197 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20199 (defun org-fix-tags-on-the-fly ()
20200 (when (and (equal (char-after (point-at-bol)) ?*)
20201 (org-at-heading-p))
20202 (org-align-tags-here org-tags-column)))
20204 (defun org-delete-backward-char (N)
20205 "Like `delete-backward-char', insert whitespace at field end in tables.
20206 When deleting backwards, in tables this function will insert whitespace in
20207 front of the next \"|\" separator, to keep the table aligned. The table will
20208 still be marked for re-alignment if the field did fill the entire column,
20209 because, in this case the deletion might narrow the column."
20210 (interactive "p")
20211 (save-match-data
20212 (org-check-before-invisible-edit 'delete-backward)
20213 (if (and (org-table-p)
20214 (eq N 1)
20215 (string-match "|" (buffer-substring (point-at-bol) (point)))
20216 (looking-at ".*?|"))
20217 (let ((pos (point))
20218 (noalign (looking-at "[^|\n\r]* |"))
20219 (c org-table-may-need-update))
20220 (backward-delete-char N)
20221 (if (not overwrite-mode)
20222 (progn
20223 (skip-chars-forward "^|")
20224 (insert " ")
20225 (goto-char (1- pos))))
20226 ;; noalign: if there were two spaces at the end, this field
20227 ;; does not determine the width of the column.
20228 (if noalign (setq org-table-may-need-update c)))
20229 (backward-delete-char N)
20230 (org-fix-tags-on-the-fly))))
20232 (defun org-delete-char (N)
20233 "Like `delete-char', but insert whitespace at field end in tables.
20234 When deleting characters, in tables this function will insert whitespace in
20235 front of the next \"|\" separator, to keep the table aligned. The table will
20236 still be marked for re-alignment if the field did fill the entire column,
20237 because, in this case the deletion might narrow the column."
20238 (interactive "p")
20239 (save-match-data
20240 (org-check-before-invisible-edit 'delete)
20241 (if (and (org-table-p)
20242 (not (bolp))
20243 (not (= (char-after) ?|))
20244 (eq N 1))
20245 (if (looking-at ".*?|")
20246 (let ((pos (point))
20247 (noalign (looking-at "[^|\n\r]* |"))
20248 (c org-table-may-need-update))
20249 (replace-match
20250 (concat (substring (match-string 0) 1 -1) " |") nil t)
20251 (goto-char pos)
20252 ;; noalign: if there were two spaces at the end, this field
20253 ;; does not determine the width of the column.
20254 (if noalign (setq org-table-may-need-update c)))
20255 (delete-char N))
20256 (delete-char N)
20257 (org-fix-tags-on-the-fly))))
20259 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20260 (put 'org-self-insert-command 'delete-selection
20261 (lambda ()
20262 (not (run-hook-with-args-until-success
20263 'self-insert-uses-region-functions))))
20264 (put 'orgtbl-self-insert-command 'delete-selection
20265 (lambda ()
20266 (not (run-hook-with-args-until-success
20267 'self-insert-uses-region-functions))))
20268 (put 'org-delete-char 'delete-selection 'supersede)
20269 (put 'org-delete-backward-char 'delete-selection 'supersede)
20270 (put 'org-yank 'delete-selection 'yank)
20272 ;; Make `flyspell-mode' delay after some commands
20273 (put 'org-self-insert-command 'flyspell-delayed t)
20274 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20275 (put 'org-delete-char 'flyspell-delayed t)
20276 (put 'org-delete-backward-char 'flyspell-delayed t)
20278 ;; Make pabbrev-mode expand after org-mode commands
20279 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20280 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20282 (defun org-remap (map &rest commands)
20283 "In MAP, remap the functions given in COMMANDS.
20284 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20285 (let (new old)
20286 (while commands
20287 (setq old (pop commands) new (pop commands))
20288 (if (fboundp 'command-remapping)
20289 (org-defkey map (vector 'remap old) new)
20290 (substitute-key-definition old new map global-map)))))
20292 (defun org-transpose-words ()
20293 "Transpose words for Org.
20294 This uses the `org-mode-transpose-word-syntax-table' syntax
20295 table, which interprets characters in `org-emphasis-alist' as
20296 word constituents."
20297 (interactive)
20298 (with-syntax-table org-mode-transpose-word-syntax-table
20299 (call-interactively 'transpose-words)))
20300 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20302 (when (eq org-enable-table-editor 'optimized)
20303 ;; If the user wants maximum table support, we need to hijack
20304 ;; some standard editing functions
20305 (org-remap org-mode-map
20306 'self-insert-command 'org-self-insert-command
20307 'delete-char 'org-delete-char
20308 'delete-backward-char 'org-delete-backward-char)
20309 (org-defkey org-mode-map "|" 'org-force-self-insert))
20311 (defvar org-ctrl-c-ctrl-c-hook nil
20312 "Hook for functions attaching themselves to `C-c C-c'.
20314 This can be used to add additional functionality to the C-c C-c
20315 key which executes context-dependent commands. This hook is run
20316 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20317 run after the last test.
20319 Each function will be called with no arguments. The function
20320 must check if the context is appropriate for it to act. If yes,
20321 it should do its thing and then return a non-nil value. If the
20322 context is wrong, just do nothing and return nil.")
20324 (defvar org-ctrl-c-ctrl-c-final-hook nil
20325 "Hook for functions attaching themselves to `C-c C-c'.
20327 This can be used to add additional functionality to the C-c C-c
20328 key which executes context-dependent commands. This hook is run
20329 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20330 before the first test.
20332 Each function will be called with no arguments. The function
20333 must check if the context is appropriate for it to act. If yes,
20334 it should do its thing and then return a non-nil value. If the
20335 context is wrong, just do nothing and return nil.")
20337 (defvar org-tab-first-hook nil
20338 "Hook for functions to attach themselves to TAB.
20339 See `org-ctrl-c-ctrl-c-hook' for more information.
20340 This hook runs as the first action when TAB is pressed, even before
20341 `org-cycle' messes around with the `outline-regexp' to cater for
20342 inline tasks and plain list item folding.
20343 If any function in this hook returns t, any other actions that
20344 would have been caused by TAB (such as table field motion or visibility
20345 cycling) will not occur.")
20347 (defvar org-tab-after-check-for-table-hook nil
20348 "Hook for functions to attach themselves to TAB.
20349 See `org-ctrl-c-ctrl-c-hook' for more information.
20350 This hook runs after it has been established that the cursor is not in a
20351 table, but before checking if the cursor is in a headline or if global cycling
20352 should be done.
20353 If any function in this hook returns t, not other actions like visibility
20354 cycling will be done.")
20356 (defvar org-tab-after-check-for-cycling-hook nil
20357 "Hook for functions to attach themselves to TAB.
20358 See `org-ctrl-c-ctrl-c-hook' for more information.
20359 This hook runs after it has been established that not table field motion and
20360 not visibility should be done because of current context. This is probably
20361 the place where a package like yasnippets can hook in.")
20363 (defvar org-tab-before-tab-emulation-hook nil
20364 "Hook for functions to attach themselves to TAB.
20365 See `org-ctrl-c-ctrl-c-hook' for more information.
20366 This hook runs after every other options for TAB have been exhausted, but
20367 before indentation and \t insertion takes place.")
20369 (defvar org-metaleft-hook nil
20370 "Hook for functions attaching themselves to `M-left'.
20371 See `org-ctrl-c-ctrl-c-hook' for more information.")
20372 (defvar org-metaright-hook nil
20373 "Hook for functions attaching themselves to `M-right'.
20374 See `org-ctrl-c-ctrl-c-hook' for more information.")
20375 (defvar org-metaup-hook nil
20376 "Hook for functions attaching themselves to `M-up'.
20377 See `org-ctrl-c-ctrl-c-hook' for more information.")
20378 (defvar org-metadown-hook nil
20379 "Hook for functions attaching themselves to `M-down'.
20380 See `org-ctrl-c-ctrl-c-hook' for more information.")
20381 (defvar org-shiftmetaleft-hook nil
20382 "Hook for functions attaching themselves to `M-S-left'.
20383 See `org-ctrl-c-ctrl-c-hook' for more information.")
20384 (defvar org-shiftmetaright-hook nil
20385 "Hook for functions attaching themselves to `M-S-right'.
20386 See `org-ctrl-c-ctrl-c-hook' for more information.")
20387 (defvar org-shiftmetaup-hook nil
20388 "Hook for functions attaching themselves to `M-S-up'.
20389 See `org-ctrl-c-ctrl-c-hook' for more information.")
20390 (defvar org-shiftmetadown-hook nil
20391 "Hook for functions attaching themselves to `M-S-down'.
20392 See `org-ctrl-c-ctrl-c-hook' for more information.")
20393 (defvar org-metareturn-hook nil
20394 "Hook for functions attaching themselves to `M-RET'.
20395 See `org-ctrl-c-ctrl-c-hook' for more information.")
20396 (defvar org-shiftup-hook nil
20397 "Hook for functions attaching themselves to `S-up'.
20398 See `org-ctrl-c-ctrl-c-hook' for more information.")
20399 (defvar org-shiftup-final-hook nil
20400 "Hook for functions attaching themselves to `S-up'.
20401 This one runs after all other options except shift-select have been excluded.
20402 See `org-ctrl-c-ctrl-c-hook' for more information.")
20403 (defvar org-shiftdown-hook nil
20404 "Hook for functions attaching themselves to `S-down'.
20405 See `org-ctrl-c-ctrl-c-hook' for more information.")
20406 (defvar org-shiftdown-final-hook nil
20407 "Hook for functions attaching themselves to `S-down'.
20408 This one runs after all other options except shift-select have been excluded.
20409 See `org-ctrl-c-ctrl-c-hook' for more information.")
20410 (defvar org-shiftleft-hook nil
20411 "Hook for functions attaching themselves to `S-left'.
20412 See `org-ctrl-c-ctrl-c-hook' for more information.")
20413 (defvar org-shiftleft-final-hook nil
20414 "Hook for functions attaching themselves to `S-left'.
20415 This one runs after all other options except shift-select have been excluded.
20416 See `org-ctrl-c-ctrl-c-hook' for more information.")
20417 (defvar org-shiftright-hook nil
20418 "Hook for functions attaching themselves to `S-right'.
20419 See `org-ctrl-c-ctrl-c-hook' for more information.")
20420 (defvar org-shiftright-final-hook nil
20421 "Hook for functions attaching themselves to `S-right'.
20422 This one runs after all other options except shift-select have been excluded.
20423 See `org-ctrl-c-ctrl-c-hook' for more information.")
20425 (defun org-modifier-cursor-error ()
20426 "Throw an error, a modified cursor command was applied in wrong context."
20427 (user-error "This command is active in special context like tables, headlines or items"))
20429 (defun org-shiftselect-error ()
20430 "Throw an error because Shift-Cursor command was applied in wrong context."
20431 (if (and (boundp 'shift-select-mode) shift-select-mode)
20432 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20433 (user-error "This command works only in special context like headlines or timestamps")))
20435 (defun org-call-for-shift-select (cmd)
20436 (let ((this-command-keys-shift-translated t))
20437 (call-interactively cmd)))
20439 (defun org-shifttab (&optional arg)
20440 "Global visibility cycling or move to previous table field.
20441 Call `org-table-previous-field' within a table.
20442 When ARG is nil, cycle globally through visibility states.
20443 When ARG is a numeric prefix, show contents of this level."
20444 (interactive "P")
20445 (cond
20446 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20447 ((integerp arg)
20448 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20449 (message "Content view to level: %d" arg)
20450 (org-content (prefix-numeric-value arg2))
20451 (org-cycle-show-empty-lines t)
20452 (setq org-cycle-global-status 'overview)))
20453 (t (call-interactively 'org-global-cycle))))
20455 (defun org-shiftmetaleft ()
20456 "Promote subtree or delete table column.
20457 Calls `org-promote-subtree', `org-outdent-item-tree', or
20458 `org-table-delete-column', depending on context. See the
20459 individual commands for more information."
20460 (interactive)
20461 (cond
20462 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20463 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20464 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20465 ((if (not (org-region-active-p)) (org-at-item-p)
20466 (save-excursion (goto-char (region-beginning))
20467 (org-at-item-p)))
20468 (call-interactively 'org-outdent-item-tree))
20469 (t (org-modifier-cursor-error))))
20471 (defun org-shiftmetaright ()
20472 "Demote subtree or insert table column.
20473 Calls `org-demote-subtree', `org-indent-item-tree', or
20474 `org-table-insert-column', depending on context. See the
20475 individual commands for more information."
20476 (interactive)
20477 (cond
20478 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20479 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20480 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20481 ((if (not (org-region-active-p)) (org-at-item-p)
20482 (save-excursion (goto-char (region-beginning))
20483 (org-at-item-p)))
20484 (call-interactively 'org-indent-item-tree))
20485 (t (org-modifier-cursor-error))))
20487 (defun org-shiftmetaup (&optional arg)
20488 "Drag the line at point up.
20489 In a table, kill the current row.
20490 On a clock timestamp, update the value of the timestamp like `S-<up>'
20491 but also adjust the previous clocked item in the clock history.
20492 Everywhere else, drag the line at point up."
20493 (interactive "P")
20494 (cond
20495 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20496 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20497 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20498 (call-interactively 'org-timestamp-up)))
20499 (t (call-interactively 'org-drag-line-backward))))
20501 (defun org-shiftmetadown (&optional arg)
20502 "Drag the line at point down.
20503 In a table, insert an empty row at the current line.
20504 On a clock timestamp, update the value of the timestamp like `S-<down>'
20505 but also adjust the previous clocked item in the clock history.
20506 Everywhere else, drag the line at point down."
20507 (interactive "P")
20508 (cond
20509 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20510 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20511 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20512 (call-interactively 'org-timestamp-down)))
20513 (t (call-interactively 'org-drag-line-forward))))
20515 (defsubst org-hidden-tree-error ()
20516 (user-error
20517 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20519 (defun org-metaleft (&optional arg)
20520 "Promote heading, list item at point or move table column left.
20522 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20523 depending on context. With no specific context, calls the Emacs
20524 default `backward-word'. See the individual commands for more
20525 information.
20527 This function runs the hook `org-metaleft-hook' as a first step,
20528 and returns at first non-nil value."
20529 (interactive "P")
20530 (cond
20531 ((run-hook-with-args-until-success 'org-metaleft-hook))
20532 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20533 ((org-with-limited-levels
20534 (or (org-at-heading-p)
20535 (and (org-region-active-p)
20536 (save-excursion
20537 (goto-char (region-beginning))
20538 (org-at-heading-p)))))
20539 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20540 (call-interactively 'org-do-promote))
20541 ;; At an inline task.
20542 ((org-at-heading-p)
20543 (call-interactively 'org-inlinetask-promote))
20544 ((or (org-at-item-p)
20545 (and (org-region-active-p)
20546 (save-excursion
20547 (goto-char (region-beginning))
20548 (org-at-item-p))))
20549 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20550 (call-interactively 'org-outdent-item))
20551 (t (call-interactively 'backward-word))))
20553 (defun org-metaright (&optional arg)
20554 "Demote heading, list item at point or move table column right.
20556 In front of a drawer or a block keyword, indent it correctly.
20558 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20559 `org-indnet-drawer' or `org-indent-block' depending on context.
20560 With no specific context, calls the Emacs default `forward-word'.
20561 See the individual commands for more information.
20563 This function runs the hook `org-metaright-hook' as a first step,
20564 and returns at first non-nil value."
20565 (interactive "P")
20566 (cond
20567 ((run-hook-with-args-until-success 'org-metaright-hook))
20568 ((org-at-table-p) (call-interactively 'org-table-move-column))
20569 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20570 ((org-at-block-p) (call-interactively 'org-indent-block))
20571 ((org-with-limited-levels
20572 (or (org-at-heading-p)
20573 (and (org-region-active-p)
20574 (save-excursion
20575 (goto-char (region-beginning))
20576 (org-at-heading-p)))))
20577 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20578 (call-interactively 'org-do-demote))
20579 ;; At an inline task.
20580 ((org-at-heading-p)
20581 (call-interactively 'org-inlinetask-demote))
20582 ((or (org-at-item-p)
20583 (and (org-region-active-p)
20584 (save-excursion
20585 (goto-char (region-beginning))
20586 (org-at-item-p))))
20587 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20588 (call-interactively 'org-indent-item))
20589 (t (call-interactively 'forward-word))))
20591 (defun org-check-for-hidden (what)
20592 "Check if there are hidden headlines/items in the current visual line.
20593 WHAT can be either `headlines' or `items'. If the current line is
20594 an outline or item heading and it has a folded subtree below it,
20595 this function returns t, nil otherwise."
20596 (let ((re (cond
20597 ((eq what 'headlines) org-outline-regexp-bol)
20598 ((eq what 'items) (org-item-beginning-re))
20599 (t (error "This should not happen"))))
20600 beg end)
20601 (save-excursion
20602 (catch 'exit
20603 (unless (org-region-active-p)
20604 (setq beg (point-at-bol))
20605 (beginning-of-line 2)
20606 (while (and (not (eobp)) ;; this is like `next-line'
20607 (get-char-property (1- (point)) 'invisible))
20608 (beginning-of-line 2))
20609 (setq end (point))
20610 (goto-char beg)
20611 (goto-char (point-at-eol))
20612 (setq end (max end (point)))
20613 (while (re-search-forward re end t)
20614 (if (get-char-property (match-beginning 0) 'invisible)
20615 (throw 'exit t))))
20616 nil))))
20618 (defun org-metaup (&optional arg)
20619 "Move subtree up or move table row up.
20620 Calls `org-move-subtree-up' or `org-table-move-row' or
20621 `org-move-item-up', depending on context. See the individual commands
20622 for more information."
20623 (interactive "P")
20624 (cond
20625 ((run-hook-with-args-until-success 'org-metaup-hook))
20626 ((org-region-active-p)
20627 (let* ((a (min (region-beginning) (region-end)))
20628 (b (1- (max (region-beginning) (region-end))))
20629 (c (save-excursion (goto-char a)
20630 (move-beginning-of-line 0)))
20631 (d (save-excursion (goto-char a)
20632 (move-end-of-line 0) (point))))
20633 (transpose-regions a b c d)
20634 (goto-char c)))
20635 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20636 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20637 ((org-at-item-p) (call-interactively 'org-move-item-up))
20638 (t (org-drag-element-backward))))
20640 (defun org-metadown (&optional arg)
20641 "Move subtree down or move table row down.
20642 Calls `org-move-subtree-down' or `org-table-move-row' or
20643 `org-move-item-down', depending on context. See the individual
20644 commands for more information."
20645 (interactive "P")
20646 (cond
20647 ((run-hook-with-args-until-success 'org-metadown-hook))
20648 ((org-region-active-p)
20649 (let* ((a (min (region-beginning) (region-end)))
20650 (b (max (region-beginning) (region-end)))
20651 (c (save-excursion (goto-char b)
20652 (move-beginning-of-line 1)))
20653 (d (save-excursion (goto-char b)
20654 (move-end-of-line 1) (1+ (point)))))
20655 (transpose-regions a b c d)
20656 (goto-char d)))
20657 ((org-at-table-p) (call-interactively 'org-table-move-row))
20658 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20659 ((org-at-item-p) (call-interactively 'org-move-item-down))
20660 (t (org-drag-element-forward))))
20662 (defun org-shiftup (&optional arg)
20663 "Increase item in timestamp or increase priority of current headline.
20664 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20665 depending on context. See the individual commands for more information."
20666 (interactive "P")
20667 (cond
20668 ((run-hook-with-args-until-success 'org-shiftup-hook))
20669 ((and org-support-shift-select (org-region-active-p))
20670 (org-call-for-shift-select 'previous-line))
20671 ((org-at-timestamp-p t)
20672 (call-interactively (if org-edit-timestamp-down-means-later
20673 'org-timestamp-down 'org-timestamp-up)))
20674 ((and (not (eq org-support-shift-select 'always))
20675 org-enable-priority-commands
20676 (org-at-heading-p))
20677 (call-interactively 'org-priority-up))
20678 ((and (not org-support-shift-select) (org-at-item-p))
20679 (call-interactively 'org-previous-item))
20680 ((org-clocktable-try-shift 'up arg))
20681 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20682 (org-support-shift-select
20683 (org-call-for-shift-select 'previous-line))
20684 (t (org-shiftselect-error))))
20686 (defun org-shiftdown (&optional arg)
20687 "Decrease item in timestamp or decrease priority of current headline.
20688 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20689 depending on context. See the individual commands for more information."
20690 (interactive "P")
20691 (cond
20692 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20693 ((and org-support-shift-select (org-region-active-p))
20694 (org-call-for-shift-select 'next-line))
20695 ((org-at-timestamp-p t)
20696 (call-interactively (if org-edit-timestamp-down-means-later
20697 'org-timestamp-up 'org-timestamp-down)))
20698 ((and (not (eq org-support-shift-select 'always))
20699 org-enable-priority-commands
20700 (org-at-heading-p))
20701 (call-interactively 'org-priority-down))
20702 ((and (not org-support-shift-select) (org-at-item-p))
20703 (call-interactively 'org-next-item))
20704 ((org-clocktable-try-shift 'down arg))
20705 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20706 (org-support-shift-select
20707 (org-call-for-shift-select 'next-line))
20708 (t (org-shiftselect-error))))
20710 (defun org-shiftright (&optional arg)
20711 "Cycle the thing at point or in the current line, depending on context.
20712 Depending on context, this does one of the following:
20714 - switch a timestamp at point one day into the future
20715 - on a headline, switch to the next TODO keyword.
20716 - on an item, switch entire list to the next bullet type
20717 - on a property line, switch to the next allowed value
20718 - on a clocktable definition line, move time block into the future"
20719 (interactive "P")
20720 (cond
20721 ((run-hook-with-args-until-success 'org-shiftright-hook))
20722 ((and org-support-shift-select (org-region-active-p))
20723 (org-call-for-shift-select 'forward-char))
20724 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20725 ((and (not (eq org-support-shift-select 'always))
20726 (org-at-heading-p))
20727 (let ((org-inhibit-logging
20728 (not org-treat-S-cursor-todo-selection-as-state-change))
20729 (org-inhibit-blocking
20730 (not org-treat-S-cursor-todo-selection-as-state-change)))
20731 (org-call-with-arg 'org-todo 'right)))
20732 ((or (and org-support-shift-select
20733 (not (eq org-support-shift-select 'always))
20734 (org-at-item-bullet-p))
20735 (and (not org-support-shift-select) (org-at-item-p)))
20736 (org-call-with-arg 'org-cycle-list-bullet nil))
20737 ((and (not (eq org-support-shift-select 'always))
20738 (org-at-property-p))
20739 (call-interactively 'org-property-next-allowed-value))
20740 ((org-clocktable-try-shift 'right arg))
20741 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20742 (org-support-shift-select
20743 (org-call-for-shift-select 'forward-char))
20744 (t (org-shiftselect-error))))
20746 (defun org-shiftleft (&optional arg)
20747 "Cycle the thing at point or in the current line, depending on context.
20748 Depending on context, this does one of the following:
20750 - switch a timestamp at point one day into the past
20751 - on a headline, switch to the previous TODO keyword.
20752 - on an item, switch entire list to the previous bullet type
20753 - on a property line, switch to the previous allowed value
20754 - on a clocktable definition line, move time block into the past"
20755 (interactive "P")
20756 (cond
20757 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20758 ((and org-support-shift-select (org-region-active-p))
20759 (org-call-for-shift-select 'backward-char))
20760 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20761 ((and (not (eq org-support-shift-select 'always))
20762 (org-at-heading-p))
20763 (let ((org-inhibit-logging
20764 (not org-treat-S-cursor-todo-selection-as-state-change))
20765 (org-inhibit-blocking
20766 (not org-treat-S-cursor-todo-selection-as-state-change)))
20767 (org-call-with-arg 'org-todo 'left)))
20768 ((or (and org-support-shift-select
20769 (not (eq org-support-shift-select 'always))
20770 (org-at-item-bullet-p))
20771 (and (not org-support-shift-select) (org-at-item-p)))
20772 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20773 ((and (not (eq org-support-shift-select 'always))
20774 (org-at-property-p))
20775 (call-interactively 'org-property-previous-allowed-value))
20776 ((org-clocktable-try-shift 'left arg))
20777 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20778 (org-support-shift-select
20779 (org-call-for-shift-select 'backward-char))
20780 (t (org-shiftselect-error))))
20782 (defun org-shiftcontrolright ()
20783 "Switch to next TODO set."
20784 (interactive)
20785 (cond
20786 ((and org-support-shift-select (org-region-active-p))
20787 (org-call-for-shift-select 'forward-word))
20788 ((and (not (eq org-support-shift-select 'always))
20789 (org-at-heading-p))
20790 (org-call-with-arg 'org-todo 'nextset))
20791 (org-support-shift-select
20792 (org-call-for-shift-select 'forward-word))
20793 (t (org-shiftselect-error))))
20795 (defun org-shiftcontrolleft ()
20796 "Switch to previous TODO set."
20797 (interactive)
20798 (cond
20799 ((and org-support-shift-select (org-region-active-p))
20800 (org-call-for-shift-select 'backward-word))
20801 ((and (not (eq org-support-shift-select 'always))
20802 (org-at-heading-p))
20803 (org-call-with-arg 'org-todo 'previousset))
20804 (org-support-shift-select
20805 (org-call-for-shift-select 'backward-word))
20806 (t (org-shiftselect-error))))
20808 (defun org-shiftcontrolup (&optional n)
20809 "Change timestamps synchronously up in CLOCK log lines.
20810 Optional argument N tells to change by that many units."
20811 (interactive "P")
20812 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20813 (let (org-support-shift-select)
20814 (org-clock-timestamps-up n))
20815 (user-error "Not at a clock log")))
20817 (defun org-shiftcontroldown (&optional n)
20818 "Change timestamps synchronously down in CLOCK log lines.
20819 Optional argument N tells to change by that many units."
20820 (interactive "P")
20821 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20822 (let (org-support-shift-select)
20823 (org-clock-timestamps-down n))
20824 (user-error "Not at a clock log")))
20826 (defun org-increase-number-at-point (&optional inc)
20827 "Increment the number at point.
20828 With an optional prefix numeric argument INC, increment using
20829 this numeric value."
20830 (interactive "p")
20831 (if (not (number-at-point))
20832 (user-error "Not on a number")
20833 (unless inc (setq inc 1))
20834 (let ((pos (point))
20835 (beg (skip-chars-backward "-+^/*0-9eE."))
20836 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20837 (setq nap (buffer-substring-no-properties
20838 (+ pos beg) (+ pos beg end)))
20839 (delete-region (+ pos beg) (+ pos beg end))
20840 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20841 (when (org-at-table-p)
20842 (org-table-align)
20843 (org-table-end-of-field 1))))
20845 (defun org-decrease-number-at-point (&optional inc)
20846 "Decrement the number at point.
20847 With an optional prefix numeric argument INC, decrement using
20848 this numeric value."
20849 (interactive "p")
20850 (org-increase-number-at-point (- (or inc 1))))
20852 (defun org-ctrl-c-ret ()
20853 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20854 (interactive)
20855 (cond
20856 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20857 (t (call-interactively 'org-insert-heading))))
20859 (defun org-find-visible ()
20860 (let ((s (point)))
20861 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20862 (get-char-property s 'invisible)))
20864 (defun org-find-invisible ()
20865 (let ((s (point)))
20866 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20867 (not (get-char-property s 'invisible))))
20870 (defun org-copy-visible (beg end)
20871 "Copy the visible parts of the region."
20872 (interactive "r")
20873 (let (snippets s)
20874 (save-excursion
20875 (save-restriction
20876 (narrow-to-region beg end)
20877 (setq s (goto-char (point-min)))
20878 (while (not (= (point) (point-max)))
20879 (goto-char (org-find-invisible))
20880 (push (buffer-substring s (point)) snippets)
20881 (setq s (goto-char (org-find-visible))))))
20882 (kill-new (apply 'concat (nreverse snippets)))))
20884 (defun org-copy-special ()
20885 "Copy region in table or copy current subtree.
20886 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20887 See the individual commands for more information."
20888 (interactive)
20889 (call-interactively
20890 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20892 (defun org-cut-special ()
20893 "Cut region in table or cut current subtree.
20894 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20895 See the individual commands for more information."
20896 (interactive)
20897 (call-interactively
20898 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20900 (defun org-paste-special (arg)
20901 "Paste rectangular region into table, or past subtree relative to level.
20902 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20903 See the individual commands for more information."
20904 (interactive "P")
20905 (if (org-at-table-p)
20906 (org-table-paste-rectangle)
20907 (org-paste-subtree arg)))
20909 (defsubst org-in-fixed-width-region-p ()
20910 "Is point in a fixed-width region?"
20911 (save-match-data
20912 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20914 (defun org-edit-special (&optional arg)
20915 "Call a special editor for the element at point.
20916 When at a table, call the formula editor with `org-table-edit-formulas'.
20917 When in a source code block, call `org-edit-src-code'.
20918 When in a fixed-width region, call `org-edit-fixed-width-region'.
20919 When in an export block, call `org-edit-export-block'.
20920 When at an #+INCLUDE keyword, visit the included file.
20921 When at a footnote reference, call `org-edit-footnote-reference'
20922 On a link, call `ffap' to visit the link at point.
20923 Otherwise, return a user error."
20924 (interactive "P")
20925 (let ((element (org-element-at-point)))
20926 (assert (not buffer-read-only) nil
20927 "Buffer is read-only: %s" (buffer-name))
20928 (case (org-element-type element)
20929 (src-block
20930 (if (not arg) (org-edit-src-code)
20931 (let* ((info (org-babel-get-src-block-info))
20932 (lang (nth 0 info))
20933 (params (nth 2 info))
20934 (session (cdr (assq :session params))))
20935 (if (not session) (org-edit-src-code)
20936 ;; At a src-block with a session and function called with
20937 ;; an ARG: switch to the buffer related to the inferior
20938 ;; process.
20939 (switch-to-buffer
20940 (funcall (intern (concat "org-babel-prep-session:" lang))
20941 session params))))))
20942 (keyword
20943 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20944 (org-open-link-from-string
20945 (format "[[%s]]"
20946 (expand-file-name
20947 (let ((value (org-element-property :value element)))
20948 (cond ((not (org-string-nw-p value))
20949 (user-error "No file to edit"))
20950 ((string-match "\\`\"\\(.*?\\)\"" value)
20951 (match-string 1 value))
20952 ((string-match "\\`[^ \t\"]\\S-*" value)
20953 (match-string 0 value))
20954 (t (user-error "No valid file specified")))))))
20955 (user-error "No special environment to edit here")))
20956 (table
20957 (if (eq (org-element-property :type element) 'table.el)
20958 (org-edit-table.el)
20959 (call-interactively 'org-table-edit-formulas)))
20960 ;; Only Org tables contain `table-row' type elements.
20961 (table-row (call-interactively 'org-table-edit-formulas))
20962 (example-block (org-edit-src-code))
20963 (export-block (org-edit-export-block))
20964 (fixed-width (org-edit-fixed-width-region))
20965 (otherwise
20966 ;; No notable element at point. Though, we may be at a link or
20967 ;; a footnote reference, which are objects. Thus, scan deeper.
20968 (let ((context (org-element-context element)))
20969 (case (org-element-type context)
20970 (link (call-interactively #'ffap))
20971 (footnote-reference (org-edit-footnote-reference))
20972 (t (user-error "No special environment to edit here"))))))))
20974 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20975 (defun org-ctrl-c-ctrl-c (&optional arg)
20976 "Set tags in headline, or update according to changed information at point.
20978 This command does many different things, depending on context:
20980 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20981 this is what we do.
20983 - If the cursor is on a statistics cookie, update it.
20985 - If the cursor is in a headline, prompt for tags and insert them
20986 into the current line, aligned to `org-tags-column'. When called
20987 with prefix arg, realign all tags in the current buffer.
20989 - If the cursor is in one of the special #+KEYWORD lines, this
20990 triggers scanning the buffer for these lines and updating the
20991 information.
20993 - If the cursor is inside a table, realign the table. This command
20994 works even if the automatic table editor has been turned off.
20996 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20997 the entire table.
20999 - If the cursor is at a footnote reference or definition, jump to
21000 the corresponding definition or references, respectively.
21002 - If the cursor is a the beginning of a dynamic block, update it.
21004 - If the current buffer is a capture buffer, close note and file it.
21006 - If the cursor is on a <<<target>>>, update radio targets and
21007 corresponding links in this buffer.
21009 - If the cursor is on a numbered item in a plain list, renumber the
21010 ordered list.
21012 - If the cursor is on a checkbox, toggle it.
21014 - If the cursor is on a code block, evaluate it. The variable
21015 `org-confirm-babel-evaluate' can be used to control prompting
21016 before code block evaluation, by default every code block
21017 evaluation requires confirmation. Code block evaluation can be
21018 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21019 (interactive "P")
21020 (cond
21021 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21022 org-occur-highlights)
21023 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21024 (org-remove-occur-highlights)
21025 (message "Temporary highlights/overlays removed from current buffer"))
21026 ((and (local-variable-p 'org-finish-function (current-buffer))
21027 (fboundp org-finish-function))
21028 (funcall org-finish-function))
21029 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21031 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21032 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21033 (user-error "C-c C-c can do nothing useful at this location"))
21034 (let* ((context (org-element-context))
21035 (type (org-element-type context)))
21036 (case type
21037 ;; When at a link, act according to the parent instead.
21038 (link (setq context (org-element-property :parent context))
21039 (setq type (org-element-type context)))
21040 ;; Unsupported object types: refer to the first supported
21041 ;; element or object containing it.
21042 ((bold code entity export-snippet inline-babel-call inline-src-block
21043 italic latex-fragment line-break macro strike-through subscript
21044 superscript underline verbatim)
21045 (setq context
21046 (org-element-lineage
21047 context '(radio-target paragraph verse-block table-cell)))))
21048 ;; For convenience: at the first line of a paragraph on the
21049 ;; same line as an item, apply function on that item instead.
21050 (when (eq type 'paragraph)
21051 (let ((parent (org-element-property :parent context)))
21052 (when (and (eq (org-element-type parent) 'item)
21053 (= (line-beginning-position)
21054 (org-element-property :begin parent)))
21055 (setq context parent type 'item))))
21056 ;; Act according to type of element or object at point.
21057 (case type
21058 (clock (org-clock-update-time-maybe))
21059 (dynamic-block
21060 (save-excursion
21061 (goto-char (org-element-property :post-affiliated context))
21062 (org-update-dblock)))
21063 (footnote-definition
21064 (goto-char (org-element-property :post-affiliated context))
21065 (call-interactively 'org-footnote-action))
21066 (footnote-reference (call-interactively 'org-footnote-action))
21067 ((headline inlinetask)
21068 (save-excursion (goto-char (org-element-property :begin context))
21069 (call-interactively 'org-set-tags)))
21070 (item
21071 ;; At an item: a double C-u set checkbox to "[-]"
21072 ;; unconditionally, whereas a single one will toggle its
21073 ;; presence. Without an universal argument, if the item
21074 ;; has a checkbox, toggle it. Otherwise repair the list.
21075 (let* ((box (org-element-property :checkbox context))
21076 (struct (org-element-property :structure context))
21077 (old-struct (copy-tree struct))
21078 (parents (org-list-parents-alist struct))
21079 (prevs (org-list-prevs-alist struct))
21080 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21081 (org-list-set-checkbox
21082 (org-element-property :begin context) struct
21083 (cond ((equal arg '(16)) "[-]")
21084 ((and (not box) (equal arg '(4))) "[ ]")
21085 ((or (not box) (equal arg '(4))) nil)
21086 ((eq box 'on) "[ ]")
21087 (t "[X]")))
21088 ;; Mimic `org-list-write-struct' but with grabbing
21089 ;; a return value from `org-list-struct-fix-box'.
21090 (org-list-struct-fix-ind struct parents 2)
21091 (org-list-struct-fix-item-end struct)
21092 (org-list-struct-fix-bul struct prevs)
21093 (org-list-struct-fix-ind struct parents)
21094 (let ((block-item
21095 (org-list-struct-fix-box struct parents prevs orderedp)))
21096 (if (and box (equal struct old-struct))
21097 (if (equal arg '(16))
21098 (message "Checkboxes already reset")
21099 (user-error "Cannot toggle this checkbox: %s"
21100 (if (eq box 'on)
21101 "all subitems checked"
21102 "unchecked subitems")))
21103 (org-list-struct-apply-struct struct old-struct)
21104 (org-update-checkbox-count-maybe))
21105 (when block-item
21106 (message "Checkboxes were removed due to empty box at line %d"
21107 (org-current-line block-item))))))
21108 (keyword
21109 (let ((org-inhibit-startup-visibility-stuff t)
21110 (org-startup-align-all-tables nil))
21111 (when (boundp 'org-table-coordinate-overlays)
21112 (mapc 'delete-overlay org-table-coordinate-overlays)
21113 (setq org-table-coordinate-overlays nil))
21114 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21115 (message "Local setup has been refreshed"))
21116 (plain-list
21117 ;; At a plain list, with a double C-u argument, set
21118 ;; checkboxes of each item to "[-]", whereas a single one
21119 ;; will toggle their presence according to the state of the
21120 ;; first item in the list. Without an argument, repair the
21121 ;; list.
21122 (let* ((begin (org-element-property :contents-begin context))
21123 (beginm (move-marker (make-marker) begin))
21124 (struct (org-element-property :structure context))
21125 (old-struct (copy-tree struct))
21126 (first-box (save-excursion
21127 (goto-char begin)
21128 (looking-at org-list-full-item-re)
21129 (match-string-no-properties 3)))
21130 (new-box (cond ((equal arg '(16)) "[-]")
21131 ((equal arg '(4)) (unless first-box "[ ]"))
21132 ((equal first-box "[X]") "[ ]")
21133 (t "[X]"))))
21134 (cond
21135 (arg
21136 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21137 (org-list-get-all-items
21138 begin struct (org-list-prevs-alist struct))))
21139 ((and first-box (eq (point) begin))
21140 ;; For convenience, when point is at bol on the first
21141 ;; item of the list and no argument is provided, simply
21142 ;; toggle checkbox of that item, if any.
21143 (org-list-set-checkbox begin struct new-box)))
21144 (org-list-write-struct
21145 struct (org-list-parents-alist struct) old-struct)
21146 (org-update-checkbox-count-maybe)
21147 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21148 ((property-drawer node-property)
21149 (call-interactively 'org-property-action))
21150 ((radio-target target)
21151 (call-interactively 'org-update-radio-target-regexp))
21152 (statistics-cookie
21153 (call-interactively 'org-update-statistics-cookies))
21154 ((table table-cell table-row)
21155 ;; At a table, recalculate every field and align it. Also
21156 ;; send the table if necessary. If the table has
21157 ;; a `table.el' type, just give up. At a table row or
21158 ;; cell, maybe recalculate line but always align table.
21159 (if (eq (org-element-property :type context) 'table.el)
21160 (message "Use C-c ' to edit table.el tables")
21161 (let ((org-enable-table-editor t))
21162 (if (or (eq type 'table)
21163 ;; Check if point is at a TBLFM line.
21164 (and (eq type 'table-row)
21165 (= (point) (org-element-property :end context))))
21166 (save-excursion
21167 (if (org-at-TBLFM-p)
21168 (progn (require 'org-table)
21169 (org-table-calc-current-TBLFM))
21170 (goto-char (org-element-property :contents-begin context))
21171 (org-call-with-arg 'org-table-recalculate (or arg t))
21172 (orgtbl-send-table 'maybe)))
21173 (org-table-maybe-eval-formula)
21174 (cond (arg (call-interactively 'org-table-recalculate))
21175 ((org-table-maybe-recalculate-line))
21176 (t (org-table-align)))))))
21177 (timestamp (org-timestamp-change 0 'day))
21178 (otherwise
21179 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21180 (user-error
21181 "C-c C-c can do nothing useful at this location")))))))))
21183 (defun org-mode-restart ()
21184 (interactive)
21185 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21186 (funcall major-mode)
21187 (hack-local-variables)
21188 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21189 (org-indent-mode -1)))
21190 (message "%s restarted" major-mode))
21192 (defun org-kill-note-or-show-branches ()
21193 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21194 (interactive)
21195 (if (not org-finish-function)
21196 (progn
21197 (hide-subtree)
21198 (call-interactively 'show-branches))
21199 (let ((org-note-abort t))
21200 (funcall org-finish-function))))
21202 (defun org-delete-indentation (&optional ARG)
21203 "Join current line to previous and fix whitespace at join.
21205 If previous line is a headline add to headline title. Otherwise
21206 the function calls `delete-indentation'.
21208 With argument, join this line to following line."
21209 (interactive "*P")
21210 (if (save-excursion
21211 (if ARG (beginning-of-line)
21212 (forward-line -1))
21213 (looking-at org-complex-heading-regexp))
21214 ;; At headline.
21215 (let ((tags-column (when (match-beginning 5)
21216 (save-excursion (goto-char (match-beginning 5))
21217 (current-column))))
21218 (string (concat " " (progn (when ARG (forward-line 1))
21219 (org-trim (delete-and-extract-region
21220 (line-beginning-position)
21221 (line-end-position)))))))
21222 (unless (bobp) (delete-region (point) (1- (point))))
21223 (goto-char (or (match-end 4)
21224 (match-beginning 5)
21225 (match-end 0)))
21226 (skip-chars-backward " \t")
21227 (save-excursion (insert string))
21228 ;; Adjust alignment of tags.
21229 (when tags-column
21230 (org-align-tags-here (if org-auto-align-tags
21231 org-tags-column
21232 tags-column))))
21233 (delete-indentation ARG)))
21235 (defun org-open-line (n)
21236 "Insert a new row in tables, call `open-line' elsewhere.
21237 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21238 (interactive "*p")
21239 (cond
21240 ((not org-special-ctrl-o)
21241 (open-line n))
21242 ((org-at-table-p)
21243 (org-table-insert-row))
21245 (open-line n))))
21247 (defun org-return (&optional indent)
21248 "Goto next table row or insert a newline.
21250 Calls `org-table-next-row' or `newline', depending on context.
21252 When optional INDENT argument is non-nil, call
21253 `newline-and-indent' instead of `newline'.
21255 When `org-return-follows-link' is non-nil and point is on
21256 a timestamp or a link, call `org-open-at-point'. However, it
21257 will not happen if point is in a table or on a \"dead\"
21258 object (e.g., within a comment). In these case, you need to use
21259 `org-open-at-point' directly."
21260 (interactive)
21261 (if (and (not (bolp))
21262 (save-excursion (beginning-of-line)
21263 (looking-at org-complex-heading-regexp)))
21264 ;; At headline.
21265 (let ((tags-column (when (match-beginning 5)
21266 (save-excursion (goto-char (match-beginning 5))
21267 (current-column))))
21268 ;; Test if before or after headline title.
21269 (string (when (and (match-end 4)
21270 (not (or (< (point)
21271 (or (match-end 3)
21272 (match-end 2)
21273 (save-excursion
21274 (goto-char (match-beginning 4))
21275 (skip-chars-backward " \t")
21276 (point))))
21277 (and (match-beginning 5)
21278 (>= (point) (match-beginning 5))))))
21279 ;; Point is on headline keywords, tags or cookies. Do not break
21280 ;; them: add a newline after the headline instead.
21281 (org-string-nw-p
21282 (delete-and-extract-region (point) (match-end 4))))))
21283 ;; Adjust alignment of tags.
21284 (when (and tags-column string)
21285 (org-align-tags-here (if org-auto-align-tags
21286 org-tags-column
21287 tags-column)))
21288 (end-of-line)
21289 (org-show-entry)
21290 (if indent (newline-and-indent) (newline))
21291 (and string (save-excursion (insert (org-trim string)))))
21292 (let* ((context (if org-return-follows-link (org-element-context)
21293 (org-element-at-point)))
21294 (type (org-element-type context)))
21295 (cond
21296 ;; In a table, call `org-table-next-row'.
21297 ((or (and (eq type 'table)
21298 (>= (point) (org-element-property :contents-begin context))
21299 (< (point) (org-element-property :contents-end context)))
21300 (org-element-lineage context '(table-row table-cell) t))
21301 (org-table-justify-field-maybe)
21302 (call-interactively #'org-table-next-row))
21303 ;; On a link or a timestamp but not on white spaces after it,
21304 ;; call `org-open-line' if `org-return-follows-link' allows it.
21305 ((and org-return-follows-link
21306 (memq type '(link timestamp))
21307 (< (point)
21308 (save-excursion (goto-char (org-element-property :end context))
21309 (skip-chars-backward " \t")
21310 (point))))
21311 (call-interactively #'org-open-at-point))
21312 ;; In a list, make sure indenting keeps trailing text within.
21313 ((and indent
21314 (not (eolp))
21315 (org-element-lineage context '(item)))
21316 (let ((trailing-data
21317 (delete-and-extract-region (point) (line-end-position))))
21318 (newline-and-indent)
21319 (save-excursion (insert trailing-data))))
21320 (t (if indent (newline-and-indent) (newline)))))))
21322 (defun org-return-indent ()
21323 "Goto next table row or insert a newline and indent.
21324 Calls `org-table-next-row' or `newline-and-indent', depending on
21325 context. See the individual commands for more information."
21326 (interactive)
21327 (org-return t))
21329 (defun org-ctrl-c-star ()
21330 "Compute table, or change heading status of lines.
21331 Calls `org-table-recalculate' or `org-toggle-heading',
21332 depending on context."
21333 (interactive)
21334 (cond
21335 ((org-at-table-p)
21336 (call-interactively 'org-table-recalculate))
21338 ;; Convert all lines in region to list items
21339 (call-interactively 'org-toggle-heading))))
21341 (defun org-ctrl-c-minus ()
21342 "Insert separator line in table or modify bullet status of line.
21343 Also turns a plain line or a region of lines into list items.
21344 Calls `org-table-insert-hline', `org-toggle-item', or
21345 `org-cycle-list-bullet', depending on context."
21346 (interactive)
21347 (cond
21348 ((org-at-table-p)
21349 (call-interactively 'org-table-insert-hline))
21350 ((org-region-active-p)
21351 (call-interactively 'org-toggle-item))
21352 ((org-in-item-p)
21353 (call-interactively 'org-cycle-list-bullet))
21355 (call-interactively 'org-toggle-item))))
21357 (defun org-toggle-item (arg)
21358 "Convert headings or normal lines to items, items to normal lines.
21359 If there is no active region, only the current line is considered.
21361 If the first non blank line in the region is a headline, convert
21362 all headlines to items, shifting text accordingly.
21364 If it is an item, convert all items to normal lines.
21366 If it is normal text, change region into a list of items.
21367 With a prefix argument ARG, change the region in a single item."
21368 (interactive "P")
21369 (let ((shift-text
21370 (function
21371 ;; Shift text in current section to IND, from point to END.
21372 ;; The function leaves point to END line.
21373 (lambda (ind end)
21374 (let ((min-i 1000) (end (copy-marker end)))
21375 ;; First determine the minimum indentation (MIN-I) of
21376 ;; the text.
21377 (save-excursion
21378 (catch 'exit
21379 (while (< (point) end)
21380 (let ((i (org-get-indentation)))
21381 (cond
21382 ;; Skip blank lines and inline tasks.
21383 ((looking-at "^[ \t]*$"))
21384 ((looking-at org-outline-regexp-bol))
21385 ;; We can't find less than 0 indentation.
21386 ((zerop i) (throw 'exit (setq min-i 0)))
21387 ((< i min-i) (setq min-i i))))
21388 (forward-line))))
21389 ;; Then indent each line so that a line indented to
21390 ;; MIN-I becomes indented to IND. Ignore blank lines
21391 ;; and inline tasks in the process.
21392 (let ((delta (- ind min-i)))
21393 (while (< (point) end)
21394 (unless (or (looking-at "^[ \t]*$")
21395 (looking-at org-outline-regexp-bol))
21396 (org-indent-line-to (+ (org-get-indentation) delta)))
21397 (forward-line)))))))
21398 (skip-blanks
21399 (function
21400 ;; Return beginning of first non-blank line, starting from
21401 ;; line at POS.
21402 (lambda (pos)
21403 (save-excursion
21404 (goto-char pos)
21405 (skip-chars-forward " \r\t\n")
21406 (point-at-bol)))))
21407 beg end)
21408 ;; Determine boundaries of changes.
21409 (if (org-region-active-p)
21410 (setq beg (funcall skip-blanks (region-beginning))
21411 end (copy-marker (region-end)))
21412 (setq beg (funcall skip-blanks (point-at-bol))
21413 end (copy-marker (point-at-eol))))
21414 ;; Depending on the starting line, choose an action on the text
21415 ;; between BEG and END.
21416 (org-with-limited-levels
21417 (save-excursion
21418 (goto-char beg)
21419 (cond
21420 ;; Case 1. Start at an item: de-itemize. Note that it only
21421 ;; happens when a region is active: `org-ctrl-c-minus'
21422 ;; would call `org-cycle-list-bullet' otherwise.
21423 ((org-at-item-p)
21424 (while (< (point) end)
21425 (when (org-at-item-p)
21426 (skip-chars-forward " \t")
21427 (delete-region (point) (match-end 0)))
21428 (forward-line)))
21429 ;; Case 2. Start at an heading: convert to items.
21430 ((org-at-heading-p)
21431 (let* ((bul (org-list-bullet-string "-"))
21432 (bul-len (length bul))
21433 (done (org-entry-is-done-p))
21434 (todo (org-entry-is-todo-p))
21435 ;; Indentation of the first heading. It should be
21436 ;; relative to the indentation of its parent, if any.
21437 (start-ind (save-excursion
21438 (cond
21439 ((not org-adapt-indentation) 0)
21440 ((not (outline-previous-heading)) 0)
21441 (t (length (match-string 0))))))
21442 ;; Level of first heading. Further headings will be
21443 ;; compared to it to determine hierarchy in the list.
21444 (ref-level (org-reduced-level (org-outline-level))))
21445 (when (or done todo) (org-todo ""))
21446 (while (< (point) end)
21447 (let* ((level (org-reduced-level (org-outline-level)))
21448 (delta (max 0 (- level ref-level))))
21449 ;; If current headline is less indented than the first
21450 ;; one, set it as reference, in order to preserve
21451 ;; subtrees.
21452 (when (< level ref-level) (setq ref-level level))
21453 (replace-match bul t t)
21454 (org-indent-line-to (+ start-ind (* delta bul-len)))
21455 (when (or done todo)
21456 (let* ((struct (org-list-struct))
21457 (old (copy-tree struct)))
21458 (org-list-set-checkbox (line-beginning-position)
21459 struct
21460 (if done "[X]" "[ ]"))
21461 (org-list-write-struct struct
21462 (org-list-parents-alist struct)
21463 old)))
21464 ;; Ensure all text down to END (or SECTION-END) belongs
21465 ;; to the newly created item.
21466 (let ((section-end (save-excursion
21467 (or (outline-next-heading) (point)))))
21468 (forward-line)
21469 (funcall shift-text
21470 (+ start-ind (* (1+ delta) bul-len))
21471 (min end section-end)))))))
21472 ;; Case 3. Normal line with ARG: make the first line of region
21473 ;; an item, and shift indentation of others lines to
21474 ;; set them as item's body.
21475 (arg (let* ((bul (org-list-bullet-string "-"))
21476 (bul-len (length bul))
21477 (ref-ind (org-get-indentation)))
21478 (skip-chars-forward " \t")
21479 (insert bul)
21480 (forward-line)
21481 (while (< (point) end)
21482 ;; Ensure that lines less indented than first one
21483 ;; still get included in item body.
21484 (funcall shift-text
21485 (+ ref-ind bul-len)
21486 (min end (save-excursion (or (outline-next-heading)
21487 (point)))))
21488 (forward-line))))
21489 ;; Case 4. Normal line without ARG: turn each non-item line
21490 ;; into an item.
21492 (while (< (point) end)
21493 (unless (or (org-at-heading-p) (org-at-item-p))
21494 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21495 (replace-match
21496 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21497 (forward-line))))))))
21499 (defun org-toggle-heading (&optional nstars)
21500 "Convert headings to normal text, or items or text to headings.
21501 If there is no active region, only convert the current line.
21503 With a \\[universal-argument] prefix, convert the whole list at
21504 point into heading.
21506 In a region:
21508 - If the first non blank line is a headline, remove the stars
21509 from all headlines in the region.
21511 - If it is a normal line, turn each and every normal line (i.e.,
21512 not an heading or an item) in the region into headings. If you
21513 want to convert only the first line of this region, use one
21514 universal prefix argument.
21516 - If it is a plain list item, turn all plain list items into headings.
21518 When converting a line into a heading, the number of stars is chosen
21519 such that the lines become children of the current entry. However,
21520 when a numeric prefix argument is given, its value determines the
21521 number of stars to add."
21522 (interactive "P")
21523 (let ((skip-blanks
21524 (function
21525 ;; Return beginning of first non-blank line, starting from
21526 ;; line at POS.
21527 (lambda (pos)
21528 (save-excursion
21529 (goto-char pos)
21530 (while (org-at-comment-p) (forward-line))
21531 (skip-chars-forward " \r\t\n")
21532 (point-at-bol)))))
21533 beg end toggled)
21534 ;; Determine boundaries of changes. If a universal prefix has
21535 ;; been given, put the list in a region. If region ends at a bol,
21536 ;; do not consider the last line to be in the region.
21538 (when (and current-prefix-arg (org-at-item-p))
21539 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21540 (org-mark-element))
21542 (if (org-region-active-p)
21543 (setq beg (funcall skip-blanks (region-beginning))
21544 end (copy-marker (save-excursion
21545 (goto-char (region-end))
21546 (if (bolp) (point) (point-at-eol)))))
21547 (setq beg (funcall skip-blanks (point-at-bol))
21548 end (copy-marker (point-at-eol))))
21549 ;; Ensure inline tasks don't count as headings.
21550 (org-with-limited-levels
21551 (save-excursion
21552 (goto-char beg)
21553 (cond
21554 ;; Case 1. Started at an heading: de-star headings.
21555 ((org-at-heading-p)
21556 (while (< (point) end)
21557 (when (org-at-heading-p t)
21558 (looking-at org-outline-regexp) (replace-match "")
21559 (setq toggled t))
21560 (forward-line)))
21561 ;; Case 2. Started at an item: change items into headlines.
21562 ;; One star will be added by `org-list-to-subtree'.
21563 ((org-at-item-p)
21564 (while (< (point) end)
21565 (when (org-at-item-p)
21566 ;; Pay attention to cases when region ends before list.
21567 (let* ((struct (org-list-struct))
21568 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21569 (save-restriction
21570 (narrow-to-region (point) list-end)
21571 (insert (org-list-to-subtree (org-list-parse-list t)))))
21572 (setq toggled t))
21573 (forward-line)))
21574 ;; Case 3. Started at normal text: make every line an heading,
21575 ;; skipping headlines and items.
21576 (t (let* ((stars
21577 (make-string
21578 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21579 (add-stars
21580 (cond (nstars "") ; stars from prefix only
21581 ((equal stars "") "*") ; before first heading
21582 (org-odd-levels-only "**") ; inside heading, odd
21583 (t "*"))) ; inside heading, oddeven
21584 (rpl (concat stars add-stars " "))
21585 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21586 (while (< (point) (if (equal nstars '(4)) lend end))
21587 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21588 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21589 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21590 (forward-line)))))))
21591 (unless toggled (message "Cannot toggle heading from here"))))
21593 (defun org-meta-return (&optional arg)
21594 "Insert a new heading or wrap a region in a table.
21595 Calls `org-insert-heading' or `org-table-wrap-region', depending
21596 on context. See the individual commands for more information."
21597 (interactive "P")
21598 (org-check-before-invisible-edit 'insert)
21599 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21600 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21601 #'org-insert-heading))))
21603 ;;; Menu entries
21605 (defsubst org-in-subtree-not-table-p ()
21606 "Are we in a subtree and not in a table?"
21607 (and (not (org-before-first-heading-p))
21608 (not (org-at-table-p))))
21610 ;; Define the Org-mode menus
21611 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21612 '("Tbl"
21613 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21614 ["Next Field" org-cycle (org-at-table-p)]
21615 ["Previous Field" org-shifttab (org-at-table-p)]
21616 ["Next Row" org-return (org-at-table-p)]
21617 "--"
21618 ["Blank Field" org-table-blank-field (org-at-table-p)]
21619 ["Edit Field" org-table-edit-field (org-at-table-p)]
21620 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21621 "--"
21622 ("Column"
21623 ["Move Column Left" org-metaleft (org-at-table-p)]
21624 ["Move Column Right" org-metaright (org-at-table-p)]
21625 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21626 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21627 ("Row"
21628 ["Move Row Up" org-metaup (org-at-table-p)]
21629 ["Move Row Down" org-metadown (org-at-table-p)]
21630 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21631 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21632 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21633 "--"
21634 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21635 ("Rectangle"
21636 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21637 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21638 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21639 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21640 "--"
21641 ("Calculate"
21642 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21643 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21644 ["Edit Formulas" org-edit-special (org-at-table-p)]
21645 "--"
21646 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21647 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21648 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21649 "--"
21650 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21651 "--"
21652 ["Sum Column/Rectangle" org-table-sum
21653 (or (org-at-table-p) (org-region-active-p))]
21654 ["Which Column?" org-table-current-column (org-at-table-p)])
21655 ["Debug Formulas"
21656 org-table-toggle-formula-debugger
21657 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21658 ["Show Col/Row Numbers"
21659 org-table-toggle-coordinate-overlays
21660 :style toggle
21661 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21662 "--"
21663 ["Create" org-table-create (and (not (org-at-table-p))
21664 org-enable-table-editor)]
21665 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21666 ["Import from File" org-table-import (not (org-at-table-p))]
21667 ["Export to File" org-table-export (org-at-table-p)]
21668 "--"
21669 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21670 "--"
21671 ("Plot"
21672 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21673 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21675 (easy-menu-define org-org-menu org-mode-map "Org menu"
21676 '("Org"
21677 ("Show/Hide"
21678 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21679 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21680 ["Sparse Tree..." org-sparse-tree t]
21681 ["Reveal Context" org-reveal t]
21682 ["Show All" show-all t]
21683 "--"
21684 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21685 "--"
21686 ["New Heading" org-insert-heading t]
21687 ("Navigate Headings"
21688 ["Up" outline-up-heading t]
21689 ["Next" outline-next-visible-heading t]
21690 ["Previous" outline-previous-visible-heading t]
21691 ["Next Same Level" outline-forward-same-level t]
21692 ["Previous Same Level" outline-backward-same-level t]
21693 "--"
21694 ["Jump" org-goto t])
21695 ("Edit Structure"
21696 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21697 "--"
21698 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21699 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21700 "--"
21701 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21702 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21703 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21704 "--"
21705 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21706 "--"
21707 ["Copy visible text" org-copy-visible t]
21708 "--"
21709 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21710 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21711 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21712 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21713 "--"
21714 ["Sort Region/Children" org-sort t]
21715 "--"
21716 ["Convert to odd levels" org-convert-to-odd-levels t]
21717 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21718 ("Editing"
21719 ["Emphasis..." org-emphasize t]
21720 ["Edit Source Example" org-edit-special t]
21721 "--"
21722 ["Footnote new/jump" org-footnote-action t]
21723 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21724 ("Archive"
21725 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21726 "--"
21727 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21728 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21729 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21731 "--"
21732 ("Hyperlinks"
21733 ["Store Link (Global)" org-store-link t]
21734 ["Find existing link to here" org-occur-link-in-agenda-files t]
21735 ["Insert Link" org-insert-link t]
21736 ["Follow Link" org-open-at-point t]
21737 "--"
21738 ["Next link" org-next-link t]
21739 ["Previous link" org-previous-link t]
21740 "--"
21741 ["Descriptive Links"
21742 org-toggle-link-display
21743 :style radio
21744 :selected org-descriptive-links
21746 ["Literal Links"
21747 org-toggle-link-display
21748 :style radio
21749 :selected (not org-descriptive-links)])
21750 "--"
21751 ("TODO Lists"
21752 ["TODO/DONE/-" org-todo t]
21753 ("Select keyword"
21754 ["Next keyword" org-shiftright (org-at-heading-p)]
21755 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21756 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21757 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21758 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21759 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21760 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21761 "--"
21762 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21763 :selected org-enforce-todo-dependencies :style toggle :active t]
21764 "Settings for tree at point"
21765 ["Do Children sequentially" org-toggle-ordered-property :style radio
21766 :selected (org-entry-get nil "ORDERED")
21767 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21768 ["Do Children parallel" org-toggle-ordered-property :style radio
21769 :selected (not (org-entry-get nil "ORDERED"))
21770 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21771 "--"
21772 ["Set Priority" org-priority t]
21773 ["Priority Up" org-shiftup t]
21774 ["Priority Down" org-shiftdown t]
21775 "--"
21776 ["Get news from all feeds" org-feed-update-all t]
21777 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21778 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21779 ("TAGS and Properties"
21780 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21781 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21782 "--"
21783 ["Set property" org-set-property (not (org-before-first-heading-p))]
21784 ["Column view of properties" org-columns t]
21785 ["Insert Column View DBlock" org-insert-columns-dblock t])
21786 ("Dates and Scheduling"
21787 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21788 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21789 ("Change Date"
21790 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21791 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21792 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21793 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21794 ["Compute Time Range" org-evaluate-time-range t]
21795 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21796 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21797 "--"
21798 ["Custom time format" org-toggle-time-stamp-overlays
21799 :style radio :selected org-display-custom-times]
21800 "--"
21801 ["Goto Calendar" org-goto-calendar t]
21802 ["Date from Calendar" org-date-from-calendar t]
21803 "--"
21804 ["Start/Restart Timer" org-timer-start t]
21805 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21806 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21807 ["Insert Timer String" org-timer t]
21808 ["Insert Timer Item" org-timer-item t])
21809 ("Logging work"
21810 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21811 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21812 ["Clock out" org-clock-out t]
21813 ["Clock cancel" org-clock-cancel t]
21814 "--"
21815 ["Mark as default task" org-clock-mark-default-task t]
21816 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21817 ["Goto running clock" org-clock-goto t]
21818 "--"
21819 ["Display times" org-clock-display t]
21820 ["Create clock table" org-clock-report t]
21821 "--"
21822 ["Record DONE time"
21823 (progn (setq org-log-done (not org-log-done))
21824 (message "Switching to %s will %s record a timestamp"
21825 (car org-done-keywords)
21826 (if org-log-done "automatically" "not")))
21827 :style toggle :selected org-log-done])
21828 "--"
21829 ["Agenda Command..." org-agenda t]
21830 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21831 ("File List for Agenda")
21832 ("Special views current file"
21833 ["TODO Tree" org-show-todo-tree t]
21834 ["Check Deadlines" org-check-deadlines t]
21835 ["Timeline" org-timeline t]
21836 ["Tags/Property tree" org-match-sparse-tree t])
21837 "--"
21838 ["Export/Publish..." org-export-dispatch t]
21839 ("LaTeX"
21840 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21841 :selected org-cdlatex-mode]
21842 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21843 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21844 ["Modify math symbol" org-cdlatex-math-modify
21845 (org-inside-LaTeX-fragment-p)]
21846 ["Insert citation" org-reftex-citation t]
21847 "--"
21848 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21849 "--"
21850 ("MobileOrg"
21851 ["Push Files and Views" org-mobile-push t]
21852 ["Get Captured and Flagged" org-mobile-pull t]
21853 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21854 "--"
21855 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21856 "--"
21857 ("Documentation"
21858 ["Show Version" org-version t]
21859 ["Info Documentation" org-info t])
21860 ("Customize"
21861 ["Browse Org Group" org-customize t]
21862 "--"
21863 ["Expand This Menu" org-create-customize-menu
21864 (fboundp 'customize-menu-create)])
21865 ["Send bug report" org-submit-bug-report t]
21866 "--"
21867 ("Refresh/Reload"
21868 ["Refresh setup current buffer" org-mode-restart t]
21869 ["Reload Org (after update)" org-reload t]
21870 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21873 (defun org-info (&optional node)
21874 "Read documentation for Org-mode in the info system.
21875 With optional NODE, go directly to that node."
21876 (interactive)
21877 (info (format "(org)%s" (or node ""))))
21879 ;;;###autoload
21880 (defun org-submit-bug-report ()
21881 "Submit a bug report on Org-mode via mail.
21883 Don't hesitate to report any problems or inaccurate documentation.
21885 If you don't have setup sending mail from (X)Emacs, please copy the
21886 output buffer into your mail program, as it gives us important
21887 information about your Org-mode version and configuration."
21888 (interactive)
21889 (require 'reporter)
21890 (org-load-modules-maybe)
21891 (org-require-autoloaded-modules)
21892 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21893 (reporter-submit-bug-report
21894 "emacs-orgmode@gnu.org"
21895 (org-version nil 'full)
21896 (let (list)
21897 (save-window-excursion
21898 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21899 (delete-other-windows)
21900 (erase-buffer)
21901 (insert "You are about to submit a bug report to the Org-mode mailing list.
21903 We would like to add your full Org-mode and Outline configuration to the
21904 bug report. This greatly simplifies the work of the maintainer and
21905 other experts on the mailing list.
21907 HOWEVER, some variables you have customized may contain private
21908 information. The names of customers, colleagues, or friends, might
21909 appear in the form of file names, tags, todo states, or search strings.
21910 If you answer yes to the prompt, you might want to check and remove
21911 such private information before sending the email.")
21912 (add-text-properties (point-min) (point-max) '(face org-warning))
21913 (when (yes-or-no-p "Include your Org-mode configuration ")
21914 (mapatoms
21915 (lambda (v)
21916 (and (boundp v)
21917 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21918 (or (and (symbol-value v)
21919 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21920 (and
21921 (get v 'custom-type) (get v 'standard-value)
21922 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21923 (push v list)))))
21924 (kill-buffer (get-buffer "*Warn about privacy*"))
21925 list))
21926 nil nil
21927 "Remember to cover the basics, that is, what you expected to happen and
21928 what in fact did happen. You don't know how to make a good report? See
21930 http://orgmode.org/manual/Feedback.html#Feedback
21932 Your bug report will be posted to the Org-mode mailing list.
21933 ------------------------------------------------------------------------")
21934 (save-excursion
21935 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21936 (replace-match "\\1Bug: \\3 [\\2]")))))
21939 (defun org-install-agenda-files-menu ()
21940 (let ((bl (buffer-list)))
21941 (save-excursion
21942 (while bl
21943 (set-buffer (pop bl))
21944 (if (derived-mode-p 'org-mode) (setq bl nil)))
21945 (when (derived-mode-p 'org-mode)
21946 (easy-menu-change
21947 '("Org") "File List for Agenda"
21948 (append
21949 (list
21950 ["Edit File List" (org-edit-agenda-file-list) t]
21951 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21952 ["Remove Current File from List" org-remove-file t]
21953 ["Cycle through agenda files" org-cycle-agenda-files t]
21954 ["Occur in all agenda files" org-occur-in-agenda-files t]
21955 "--")
21956 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21958 ;;;; Documentation
21960 (defun org-require-autoloaded-modules ()
21961 (interactive)
21962 (mapc 'require
21963 '(org-agenda org-archive org-attach org-clock org-colview org-id
21964 org-table org-timer)))
21966 ;;;###autoload
21967 (defun org-reload (&optional uncompiled)
21968 "Reload all org lisp files.
21969 With prefix arg UNCOMPILED, load the uncompiled versions."
21970 (interactive "P")
21971 (require 'loadhist)
21972 (let* ((org-dir (org-find-library-dir "org"))
21973 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21974 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21975 (remove-re (mapconcat 'identity
21976 (mapcar (lambda (f) (concat "^" f "$"))
21977 (list (if (featurep 'xemacs)
21978 "org-colview"
21979 "org-colview-xemacs")
21980 "org" "org-loaddefs" "org-version"))
21981 "\\|"))
21982 (feats (delete-dups
21983 (mapcar 'file-name-sans-extension
21984 (mapcar 'file-name-nondirectory
21985 (delq nil
21986 (mapcar 'feature-file
21987 features))))))
21988 (lfeat (append
21989 (sort
21990 (setq feats
21991 (delq nil (mapcar
21992 (lambda (f)
21993 (if (and (string-match feature-re f)
21994 (not (string-match remove-re f)))
21995 f nil))
21996 feats)))
21997 'string-lessp)
21998 (list "org-version" "org")))
21999 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22000 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22001 load-uncore load-misses)
22002 (setq load-misses
22003 (delq 't
22004 (mapcar (lambda (f)
22005 (or (org-load-noerror-mustsuffix (concat org-dir f))
22006 (and (string= org-dir contrib-dir)
22007 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22008 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22009 (add-to-list 'load-uncore f 'append)
22012 lfeat)))
22013 (if load-uncore
22014 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22015 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22016 (if load-misses
22017 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22018 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22019 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22021 ;;;###autoload
22022 (defun org-customize ()
22023 "Call the customize function with org as argument."
22024 (interactive)
22025 (org-load-modules-maybe)
22026 (org-require-autoloaded-modules)
22027 (customize-browse 'org))
22029 (defun org-create-customize-menu ()
22030 "Create a full customization menu for Org-mode, insert it into the menu."
22031 (interactive)
22032 (org-load-modules-maybe)
22033 (org-require-autoloaded-modules)
22034 (if (fboundp 'customize-menu-create)
22035 (progn
22036 (easy-menu-change
22037 '("Org") "Customize"
22038 `(["Browse Org group" org-customize t]
22039 "--"
22040 ,(customize-menu-create 'org)
22041 ["Set" Custom-set t]
22042 ["Save" Custom-save t]
22043 ["Reset to Current" Custom-reset-current t]
22044 ["Reset to Saved" Custom-reset-saved t]
22045 ["Reset to Standard Settings" Custom-reset-standard t]))
22046 (message "\"Org\"-menu now contains full customization menu"))
22047 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22049 ;;;; Miscellaneous stuff
22051 ;;; Generally useful functions
22053 (defsubst org-get-at-eol (property n)
22054 "Get text property PROPERTY at the end of line less N characters."
22055 (get-text-property (- (point-at-eol) n) property))
22057 (defun org-find-text-property-in-string (prop s)
22058 "Return the first non-nil value of property PROP in string S."
22059 (or (get-text-property 0 prop s)
22060 (get-text-property (or (next-single-property-change 0 prop s) 0)
22061 prop s)))
22063 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22064 "Display the given MESSAGE as a warning."
22065 (if (fboundp 'display-warning)
22066 (display-warning 'org message
22067 (if (featurep 'xemacs) 'warning :warning))
22068 (let ((buf (get-buffer-create "*Org warnings*")))
22069 (with-current-buffer buf
22070 (goto-char (point-max))
22071 (insert "Warning (Org): " message)
22072 (unless (bolp)
22073 (newline)))
22074 (display-buffer buf)
22075 (sit-for 0))))
22077 (defun org-eval (form)
22078 "Eval FORM and return result."
22079 (condition-case error
22080 (eval form)
22081 (error (format "%%![Error: %s]" error))))
22083 (defun org-in-clocktable-p ()
22084 "Check if the cursor is in a clocktable."
22085 (let ((pos (point)) start)
22086 (save-excursion
22087 (end-of-line 1)
22088 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22089 (setq start (match-beginning 0))
22090 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22091 (>= (match-end 0) pos)
22092 start))))
22094 (defun org-in-verbatim-emphasis ()
22095 (save-match-data
22096 (and (org-in-regexp org-emph-re 2)
22097 (>= (point) (match-beginning 3))
22098 (<= (point) (match-end 4))
22099 (member (match-string 3) '("=" "~")))))
22101 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22102 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22103 (if (and marker (marker-buffer marker)
22104 (buffer-live-p (marker-buffer marker)))
22105 (progn
22106 (org-pop-to-buffer-same-window (marker-buffer marker))
22107 (if (or (> marker (point-max)) (< marker (point-min)))
22108 (widen))
22109 (goto-char marker)
22110 (org-show-context 'org-goto))
22111 (if bookmark
22112 (bookmark-jump bookmark)
22113 (error "Cannot find location"))))
22115 (defun org-quote-csv-field (s)
22116 "Quote field for inclusion in CSV material."
22117 (if (string-match "[\",]" s)
22118 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22121 (defun org-force-self-insert (N)
22122 "Needed to enforce self-insert under remapping."
22123 (interactive "p")
22124 (self-insert-command N))
22126 (defun org-string-width (s)
22127 "Compute width of string, ignoring invisible characters.
22128 This ignores character with invisibility property `org-link', and also
22129 characters with property `org-cwidth', because these will become invisible
22130 upon the next fontification round."
22131 (let (b l)
22132 (when (or (eq t buffer-invisibility-spec)
22133 (assq 'org-link buffer-invisibility-spec))
22134 (while (setq b (text-property-any 0 (length s)
22135 'invisible 'org-link s))
22136 (setq s (concat (substring s 0 b)
22137 (substring s (or (next-single-property-change
22138 b 'invisible s) (length s)))))))
22139 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22140 (setq s (concat (substring s 0 b)
22141 (substring s (or (next-single-property-change
22142 b 'org-cwidth s) (length s))))))
22143 (setq l (string-width s) b -1)
22144 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22145 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22148 (defun org-shorten-string (s maxlength)
22149 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22150 If the string is shorter or has length MAXLENGTH, just return the
22151 original string. If it is longer, the functions finds a space in the
22152 string, breaks this string off at that locations and adds three dots
22153 as ellipsis. Including the ellipsis, the string will not be longer
22154 than MAXLENGTH. If finding a good breaking point in the string does
22155 not work, the string is just chopped off in the middle of a word
22156 if necessary."
22157 (if (<= (length s) maxlength)
22159 (let* ((n (max (- maxlength 4) 1))
22160 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22161 (if (string-match re s)
22162 (concat (match-string 1 s) "...")
22163 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22165 (defun org-get-indentation (&optional line)
22166 "Get the indentation of the current line, interpreting tabs.
22167 When LINE is given, assume it represents a line and compute its indentation."
22168 (if line
22169 (if (string-match "^ *" (org-remove-tabs line))
22170 (match-end 0))
22171 (save-excursion
22172 (beginning-of-line 1)
22173 (skip-chars-forward " \t")
22174 (current-column))))
22176 (defun org-get-string-indentation (s)
22177 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22178 (let ((n -1) (i 0) (w tab-width) c)
22179 (catch 'exit
22180 (while (< (setq n (1+ n)) (length s))
22181 (setq c (aref s n))
22182 (cond ((= c ?\ ) (setq i (1+ i)))
22183 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22184 (t (throw 'exit t)))))
22187 (defun org-remove-tabs (s &optional width)
22188 "Replace tabulators in S with spaces.
22189 Assumes that s is a single line, starting in column 0."
22190 (setq width (or width tab-width))
22191 (while (string-match "\t" s)
22192 (setq s (replace-match
22193 (make-string
22194 (- (* width (/ (+ (match-beginning 0) width) width))
22195 (match-beginning 0)) ?\ )
22196 t t s)))
22199 (defun org-fix-indentation (line ind)
22200 "Fix indentation in LINE.
22201 IND is a cons cell with target and minimum indentation.
22202 If the current indentation in LINE is smaller than the minimum,
22203 leave it alone. If it is larger than ind, set it to the target."
22204 (let* ((l (org-remove-tabs line))
22205 (i (org-get-indentation l))
22206 (i1 (car ind)) (i2 (cdr ind)))
22207 (if (>= i i2) (setq l (substring line i2)))
22208 (if (> i1 0)
22209 (concat (make-string i1 ?\ ) l)
22210 l)))
22212 (defun org-remove-indentation (code &optional n)
22213 "Remove the maximum common indentation from the lines in CODE.
22214 N may optionally be the number of spaces to remove."
22215 (with-temp-buffer
22216 (insert code)
22217 (org-do-remove-indentation n)
22218 (buffer-string)))
22220 (defun org-do-remove-indentation (&optional n)
22221 "Remove the maximum common indentation from the buffer."
22222 (untabify (point-min) (point-max))
22223 (let ((min 10000) re)
22224 (if n
22225 (setq min n)
22226 (goto-char (point-min))
22227 (while (re-search-forward "^ *[^ \n]" nil t)
22228 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22229 (unless (or (= min 0) (= min 10000))
22230 (setq re (format "^ \\{%d\\}" min))
22231 (goto-char (point-min))
22232 (while (re-search-forward re nil t)
22233 (replace-match "")
22234 (end-of-line 1))
22235 min)))
22237 (defun org-fill-template (template alist)
22238 "Find each %key of ALIST in TEMPLATE and replace it."
22239 (let ((case-fold-search nil)
22240 entry key value)
22241 (setq alist (sort (copy-sequence alist)
22242 (lambda (a b) (< (length (car a)) (length (car b))))))
22243 (while (setq entry (pop alist))
22244 (setq template
22245 (replace-regexp-in-string
22246 (concat "%" (regexp-quote (car entry)))
22247 (or (cdr entry) "") template t t)))
22248 template))
22250 (defun org-base-buffer (buffer)
22251 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22252 (if (not buffer)
22253 buffer
22254 (or (buffer-base-buffer buffer)
22255 buffer)))
22257 (defun org-wrap (string &optional width lines)
22258 "Wrap string to either a number of lines, or a width in characters.
22259 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22260 that costs. If there is a word longer than WIDTH, the text is actually
22261 wrapped to the length of that word.
22262 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22263 many lines, whatever width that takes.
22264 The return value is a list of lines, without newlines at the end."
22265 (let* ((words (org-split-string string "[ \t\n]+"))
22266 (maxword (apply 'max (mapcar 'org-string-width words)))
22267 w ll)
22268 (cond (width
22269 (org-do-wrap words (max maxword width)))
22270 (lines
22271 (setq w maxword)
22272 (setq ll (org-do-wrap words maxword))
22273 (if (<= (length ll) lines)
22275 (setq ll words)
22276 (while (> (length ll) lines)
22277 (setq w (1+ w))
22278 (setq ll (org-do-wrap words w)))
22279 ll))
22280 (t (error "Cannot wrap this")))))
22282 (defun org-do-wrap (words width)
22283 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22284 (let (lines line)
22285 (while words
22286 (setq line (pop words))
22287 (while (and words (< (+ (length line) (length (car words))) width))
22288 (setq line (concat line " " (pop words))))
22289 (setq lines (push line lines)))
22290 (nreverse lines)))
22292 (defun org-split-string (string &optional separators)
22293 "Splits STRING into substrings at SEPARATORS.
22294 No empty strings are returned if there are matches at the beginning
22295 and end of string."
22296 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22297 (start 0)
22298 notfirst
22299 (list nil))
22300 (while (and (string-match rexp string
22301 (if (and notfirst
22302 (= start (match-beginning 0))
22303 (< start (length string)))
22304 (1+ start) start))
22305 (< (match-beginning 0) (length string)))
22306 (setq notfirst t)
22307 (or (eq (match-beginning 0) 0)
22308 (and (eq (match-beginning 0) (match-end 0))
22309 (eq (match-beginning 0) start))
22310 (setq list
22311 (cons (substring string start (match-beginning 0))
22312 list)))
22313 (setq start (match-end 0)))
22314 (or (eq start (length string))
22315 (setq list
22316 (cons (substring string start)
22317 list)))
22318 (nreverse list)))
22320 (defun org-quote-vert (s)
22321 "Replace \"|\" with \"\\vert\"."
22322 (while (string-match "|" s)
22323 (setq s (replace-match "\\vert" t t s)))
22326 (defun org-uuidgen-p (s)
22327 "Is S an ID created by UUIDGEN?"
22328 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22330 (defun org-in-src-block-p (&optional inside)
22331 "Whether point is in a code source block.
22332 When INSIDE is non-nil, don't consider we are within a src block
22333 when point is at #+BEGIN_SRC or #+END_SRC."
22334 (let ((case-fold-search t) ov)
22335 (or (and (eq (get-char-property (point) 'src-block) t))
22336 (and (not inside)
22337 (save-match-data
22338 (save-excursion
22339 (beginning-of-line)
22340 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22342 (defun org-context ()
22343 "Return a list of contexts of the current cursor position.
22344 If several contexts apply, all are returned.
22345 Each context entry is a list with a symbol naming the context, and
22346 two positions indicating start and end of the context. Possible
22347 contexts are:
22349 :headline anywhere in a headline
22350 :headline-stars on the leading stars in a headline
22351 :todo-keyword on a TODO keyword (including DONE) in a headline
22352 :tags on the TAGS in a headline
22353 :priority on the priority cookie in a headline
22354 :item on the first line of a plain list item
22355 :item-bullet on the bullet/number of a plain list item
22356 :checkbox on the checkbox in a plain list item
22357 :table in an org-mode table
22358 :table-special on a special filed in a table
22359 :table-table in a table.el table
22360 :clocktable in a clocktable
22361 :src-block in a source block
22362 :link on a hyperlink
22363 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22364 :target on a <<target>>
22365 :radio-target on a <<<radio-target>>>
22366 :latex-fragment on a LaTeX fragment
22367 :latex-preview on a LaTeX fragment with overlaid preview image
22369 This function expects the position to be visible because it uses font-lock
22370 faces as a help to recognize the following contexts: :table-special, :link,
22371 and :keyword."
22372 (let* ((f (get-text-property (point) 'face))
22373 (faces (if (listp f) f (list f)))
22374 (case-fold-search t)
22375 (p (point)) clist o)
22376 ;; First the large context
22377 (cond
22378 ((org-at-heading-p t)
22379 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22380 (when (progn
22381 (beginning-of-line 1)
22382 (looking-at org-todo-line-tags-regexp))
22383 (push (org-point-in-group p 1 :headline-stars) clist)
22384 (push (org-point-in-group p 2 :todo-keyword) clist)
22385 (push (org-point-in-group p 4 :tags) clist))
22386 (goto-char p)
22387 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22388 (if (looking-at "\\[#[A-Z0-9]\\]")
22389 (push (org-point-in-group p 0 :priority) clist)))
22391 ((org-at-item-p)
22392 (push (org-point-in-group p 2 :item-bullet) clist)
22393 (push (list :item (point-at-bol)
22394 (save-excursion (org-end-of-item) (point)))
22395 clist)
22396 (and (org-at-item-checkbox-p)
22397 (push (org-point-in-group p 0 :checkbox) clist)))
22399 ((org-at-table-p)
22400 (push (list :table (org-table-begin) (org-table-end)) clist)
22401 (if (memq 'org-formula faces)
22402 (push (list :table-special
22403 (previous-single-property-change p 'face)
22404 (next-single-property-change p 'face)) clist)))
22405 ((org-at-table-p 'any)
22406 (push (list :table-table) clist)))
22407 (goto-char p)
22409 (let ((case-fold-search t))
22410 ;; New the "medium" contexts: clocktables, source blocks
22411 (cond ((org-in-clocktable-p)
22412 (push (list :clocktable
22413 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22414 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22415 (match-beginning 1))
22416 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22417 (match-end 0))) clist))
22418 ((org-in-src-block-p)
22419 (push (list :src-block
22420 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22421 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22422 (match-beginning 1))
22423 (and (search-forward "#+END_SRC" nil t)
22424 (match-beginning 0))) clist))))
22425 (goto-char p)
22427 ;; Now the small context
22428 (cond
22429 ((org-at-timestamp-p)
22430 (push (org-point-in-group p 0 :timestamp) clist))
22431 ((memq 'org-link faces)
22432 (push (list :link
22433 (previous-single-property-change p 'face)
22434 (next-single-property-change p 'face)) clist))
22435 ((memq 'org-special-keyword faces)
22436 (push (list :keyword
22437 (previous-single-property-change p 'face)
22438 (next-single-property-change p 'face)) clist))
22439 ((org-at-target-p)
22440 (push (org-point-in-group p 0 :target) clist)
22441 (goto-char (1- (match-beginning 0)))
22442 (if (looking-at org-radio-target-regexp)
22443 (push (org-point-in-group p 0 :radio-target) clist))
22444 (goto-char p))
22445 ((setq o (car (delq nil
22446 (mapcar
22447 (lambda (x)
22448 (if (memq x org-latex-fragment-image-overlays) x))
22449 (overlays-at (point))))))
22450 (push (list :latex-fragment
22451 (overlay-start o) (overlay-end o)) clist)
22452 (push (list :latex-preview
22453 (overlay-start o) (overlay-end o)) clist))
22454 ((org-inside-LaTeX-fragment-p)
22455 ;; FIXME: positions wrong.
22456 (push (list :latex-fragment (point) (point)) clist)))
22458 (setq clist (nreverse (delq nil clist)))
22459 clist))
22461 (defun org-in-regexp (re &optional nlines visually)
22462 "Check if point is inside a match of RE.
22464 Normally only the current line is checked, but you can include
22465 NLINES extra lines after point into the search. If VISUALLY is
22466 set, require that the cursor is not after the match but really
22467 on, so that the block visually is on the match."
22468 (catch 'exit
22469 (let ((pos (point))
22470 (eol (point-at-eol (+ 1 (or nlines 0))))
22471 (inc (if visually 1 0)))
22472 (save-excursion
22473 (beginning-of-line (- 1 (or nlines 0)))
22474 (while (re-search-forward re eol t)
22475 (if (and (<= (match-beginning 0) pos)
22476 (>= (+ inc (match-end 0)) pos))
22477 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22478 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22479 "Org mode 8.3")
22481 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22482 "Non-nil when point is between matches of START-RE and END-RE.
22484 Also return a non-nil value when point is on one of the matches.
22486 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22487 buffer positions. Default values are the positions of headlines
22488 surrounding the point.
22490 The functions returns a cons cell whose car (resp. cdr) is the
22491 position before START-RE (resp. after END-RE)."
22492 (save-match-data
22493 (let ((pos (point))
22494 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22495 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22496 beg end)
22497 (save-excursion
22498 ;; Point is on a block when on START-RE or if START-RE can be
22499 ;; found before it...
22500 (and (or (org-in-regexp start-re)
22501 (re-search-backward start-re limit-up t))
22502 (setq beg (match-beginning 0))
22503 ;; ... and END-RE after it...
22504 (goto-char (match-end 0))
22505 (re-search-forward end-re limit-down t)
22506 (> (setq end (match-end 0)) pos)
22507 ;; ... without another START-RE in-between.
22508 (goto-char (match-beginning 0))
22509 (not (re-search-backward start-re (1+ beg) t))
22510 ;; Return value.
22511 (cons beg end))))))
22513 (defun org-in-block-p (names)
22514 "Non-nil when point belongs to a block whose name belongs to NAMES.
22516 NAMES is a list of strings containing names of blocks.
22518 Return first block name matched, or nil. Beware that in case of
22519 nested blocks, the returned name may not belong to the closest
22520 block from point."
22521 (save-match-data
22522 (catch 'exit
22523 (let ((case-fold-search t)
22524 (lim-up (save-excursion (outline-previous-heading)))
22525 (lim-down (save-excursion (outline-next-heading))))
22526 (mapc (lambda (name)
22527 (let ((n (regexp-quote name)))
22528 (when (org-between-regexps-p
22529 (concat "^[ \t]*#\\+begin_" n)
22530 (concat "^[ \t]*#\\+end_" n)
22531 lim-up lim-down)
22532 (throw 'exit n))))
22533 names))
22534 nil)))
22536 (defun org-occur-in-agenda-files (regexp &optional nlines)
22537 "Call `multi-occur' with buffers for all agenda files."
22538 (interactive "sOrg-files matching: \np")
22539 (let* ((files (org-agenda-files))
22540 (tnames (mapcar 'file-truename files))
22541 (extra org-agenda-text-search-extra-files)
22543 (when (eq (car extra) 'agenda-archives)
22544 (setq extra (cdr extra))
22545 (setq files (org-add-archive-files files)))
22546 (while (setq f (pop extra))
22547 (unless (member (file-truename f) tnames)
22548 (add-to-list 'files f 'append)
22549 (add-to-list 'tnames (file-truename f) 'append)))
22550 (multi-occur
22551 (mapcar (lambda (x)
22552 (with-current-buffer
22553 (or (get-file-buffer x) (find-file-noselect x))
22554 (widen)
22555 (current-buffer)))
22556 files)
22557 regexp)))
22559 (if (boundp 'occur-mode-find-occurrence-hook)
22560 ;; Emacs 23
22561 (add-hook 'occur-mode-find-occurrence-hook
22562 (lambda ()
22563 (when (derived-mode-p 'org-mode)
22564 (org-reveal))))
22565 ;; Emacs 22
22566 (defadvice occur-mode-goto-occurrence
22567 (after org-occur-reveal activate)
22568 (and (derived-mode-p 'org-mode) (org-reveal)))
22569 (defadvice occur-mode-goto-occurrence-other-window
22570 (after org-occur-reveal activate)
22571 (and (derived-mode-p 'org-mode) (org-reveal)))
22572 (defadvice occur-mode-display-occurrence
22573 (after org-occur-reveal activate)
22574 (when (derived-mode-p 'org-mode)
22575 (let ((pos (occur-mode-find-occurrence)))
22576 (with-current-buffer (marker-buffer pos)
22577 (save-excursion
22578 (goto-char pos)
22579 (org-reveal)))))))
22581 (defun org-occur-link-in-agenda-files ()
22582 "Create a link and search for it in the agendas.
22583 The link is not stored in `org-stored-links', it is just created
22584 for the search purpose."
22585 (interactive)
22586 (let ((link (condition-case nil
22587 (org-store-link nil)
22588 (error "Unable to create a link to here"))))
22589 (org-occur-in-agenda-files (regexp-quote link))))
22591 (defun org-reverse-string (string)
22592 "Return the reverse of STRING."
22593 (apply 'string (reverse (string-to-list string))))
22595 ;; defsubst org-uniquify must be defined before first use
22597 (defun org-uniquify-alist (alist)
22598 "Merge elements of ALIST with the same key.
22600 For example, in this alist:
22602 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22603 => '((a 1 3) (b 2))
22605 merge (a 1) and (a 3) into (a 1 3).
22607 The function returns the new ALIST."
22608 (let (rtn)
22609 (mapc
22610 (lambda (e)
22611 (let (n)
22612 (if (not (assoc (car e) rtn))
22613 (push e rtn)
22614 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22615 (setq rtn (assq-delete-all (car e) rtn))
22616 (push n rtn))))
22617 alist)
22618 rtn))
22620 (defun org-delete-all (elts list)
22621 "Remove all elements in ELTS from LIST."
22622 (while elts
22623 (setq list (delete (pop elts) list)))
22624 list)
22626 (defun org-count (cl-item cl-seq)
22627 "Count the number of occurrences of ITEM in SEQ.
22628 Taken from `count' in cl-seq.el with all keyword arguments removed."
22629 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22630 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22631 (while (< cl-start cl-end)
22632 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22633 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22634 (setq cl-start (1+ cl-start)))
22635 cl-count))
22637 (defun org-remove-if (predicate seq)
22638 "Remove everything from SEQ that fulfills PREDICATE."
22639 (let (res e)
22640 (while seq
22641 (setq e (pop seq))
22642 (if (not (funcall predicate e)) (push e res)))
22643 (nreverse res)))
22645 (defun org-remove-if-not (predicate seq)
22646 "Remove everything from SEQ that does not fulfill PREDICATE."
22647 (let (res e)
22648 (while seq
22649 (setq e (pop seq))
22650 (if (funcall predicate e) (push e res)))
22651 (nreverse res)))
22653 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22654 "Reduce two-argument FUNCTION across SEQ.
22655 Taken from `reduce' in cl-seq.el with all keyword arguments but
22656 \":initial-value\" removed."
22657 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22658 (cadr (memq :initial-value cl-keys)))
22659 (cl-seq (pop cl-seq))
22660 (t (funcall cl-func)))))
22661 (while cl-seq
22662 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22663 cl-accum))
22665 (defun org-every (pred seq)
22666 "Return true if PREDICATE is true of every element of SEQ.
22667 Adapted from `every' in cl.el."
22668 (catch 'org-every
22669 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22672 (defun org-some (pred seq)
22673 "Return true if PREDICATE is true of any element of SEQ.
22674 Adapted from `some' in cl.el."
22675 (catch 'org-some
22676 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22677 nil))
22679 (defun org-back-over-empty-lines ()
22680 "Move backwards over whitespace, to the beginning of the first empty line.
22681 Returns the number of empty lines passed."
22682 (let ((pos (point)))
22683 (if (cdr (assoc 'heading org-blank-before-new-entry))
22684 (skip-chars-backward " \t\n\r")
22685 (unless (eobp)
22686 (forward-line -1)))
22687 (beginning-of-line 2)
22688 (goto-char (min (point) pos))
22689 (count-lines (point) pos)))
22691 (defun org-skip-whitespace ()
22692 (skip-chars-forward " \t\n\r"))
22694 (defun org-point-in-group (point group &optional context)
22695 "Check if POINT is in match-group GROUP.
22696 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22697 match. If the match group does not exist or point is not inside it,
22698 return nil."
22699 (and (match-beginning group)
22700 (>= point (match-beginning group))
22701 (<= point (match-end group))
22702 (if context
22703 (list context (match-beginning group) (match-end group))
22704 t)))
22706 (defun org-switch-to-buffer-other-window (&rest args)
22707 "Switch to buffer in a second window on the current frame.
22708 In particular, do not allow pop-up frames.
22709 Returns the newly created buffer."
22710 (org-no-popups
22711 (apply 'switch-to-buffer-other-window args)))
22713 (defun org-combine-plists (&rest plists)
22714 "Create a single property list from all plists in PLISTS.
22715 The process starts by copying the first list, and then setting properties
22716 from the other lists. Settings in the last list are the most significant
22717 ones and overrule settings in the other lists."
22718 (let ((rtn (copy-sequence (pop plists)))
22719 p v ls)
22720 (while plists
22721 (setq ls (pop plists))
22722 (while ls
22723 (setq p (pop ls) v (pop ls))
22724 (setq rtn (plist-put rtn p v))))
22725 rtn))
22727 (defun org-replace-escapes (string table)
22728 "Replace %-escapes in STRING with values in TABLE.
22729 TABLE is an association list with keys like \"%a\" and string values.
22730 The sequences in STRING may contain normal field width and padding information,
22731 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22732 so values can contain further %-escapes if they are define later in TABLE."
22733 (let ((tbl (copy-alist table))
22734 (case-fold-search nil)
22735 (pchg 0)
22736 e re rpl)
22737 (while (setq e (pop tbl))
22738 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22739 (when (and (cdr e) (string-match re (cdr e)))
22740 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22741 (safe "SREF"))
22742 (add-text-properties 0 3 (list 'sref sref) safe)
22743 (setcdr e (replace-match safe t t (cdr e)))))
22744 (while (string-match re string)
22745 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22746 (cdr e)))
22747 (setq string (replace-match rpl t t string))))
22748 (while (setq pchg (next-property-change pchg string))
22749 (let ((sref (get-text-property pchg 'sref string)))
22750 (when (and sref (string-match "SREF" string pchg))
22751 (setq string (replace-match sref t t string)))))
22752 string))
22754 (defun org-sublist (list start end)
22755 "Return a section of LIST, from START to END.
22756 Counting starts at 1."
22757 (let (rtn (c start))
22758 (setq list (nthcdr (1- start) list))
22759 (while (and list (<= c end))
22760 (push (pop list) rtn)
22761 (setq c (1+ c)))
22762 (nreverse rtn)))
22764 (defun org-find-base-buffer-visiting (file)
22765 "Like `find-buffer-visiting' but always return the base buffer and
22766 not an indirect buffer."
22767 (let ((buf (or (get-file-buffer file)
22768 (find-buffer-visiting file))))
22769 (if buf
22770 (or (buffer-base-buffer buf) buf)
22771 nil)))
22773 (defun org-image-file-name-regexp (&optional extensions)
22774 "Return regexp matching the file names of images.
22775 If EXTENSIONS is given, only match these."
22776 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22777 (image-file-name-regexp)
22778 (let ((image-file-name-extensions
22779 (or extensions
22780 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22781 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22782 (concat "\\."
22783 (regexp-opt (nconc (mapcar 'upcase
22784 image-file-name-extensions)
22785 image-file-name-extensions)
22787 "\\'"))))
22789 (defun org-file-image-p (file &optional extensions)
22790 "Return non-nil if FILE is an image."
22791 (save-match-data
22792 (string-match (org-image-file-name-regexp extensions) file)))
22794 (defun org-get-cursor-date (&optional with-time)
22795 "Return the date at cursor in as a time.
22796 This works in the calendar and in the agenda, anywhere else it just
22797 returns the current time.
22798 If WITH-TIME is non-nil, returns the time of the event at point (in
22799 the agenda) or the current time of the day."
22800 (let (date day defd tp tm hod mod)
22801 (when with-time
22802 (setq tp (get-text-property (point) 'time))
22803 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22804 (setq hod (string-to-number (match-string 1 tp))
22805 mod (string-to-number (match-string 2 tp))))
22806 (or tp (setq hod (nth 2 (decode-time (current-time)))
22807 mod (nth 1 (decode-time (current-time))))))
22808 (cond
22809 ((eq major-mode 'calendar-mode)
22810 (setq date (calendar-cursor-to-date)
22811 defd (encode-time 0 (or mod 0) (or hod 0)
22812 (nth 1 date) (nth 0 date) (nth 2 date))))
22813 ((eq major-mode 'org-agenda-mode)
22814 (setq day (get-text-property (point) 'day))
22815 (if day
22816 (setq date (calendar-gregorian-from-absolute day)
22817 defd (encode-time 0 (or mod 0) (or hod 0)
22818 (nth 1 date) (nth 0 date) (nth 2 date))))))
22819 (or defd (current-time))))
22821 (defun org-mark-subtree (&optional up)
22822 "Mark the current subtree.
22823 This puts point at the start of the current subtree, and mark at
22824 the end. If a numeric prefix UP is given, move up into the
22825 hierarchy of headlines by UP levels before marking the subtree."
22826 (interactive "P")
22827 (org-with-limited-levels
22828 (cond ((org-at-heading-p) (beginning-of-line))
22829 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22830 (t (outline-previous-visible-heading 1))))
22831 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22832 (if (org-called-interactively-p 'any)
22833 (call-interactively 'org-mark-element)
22834 (org-mark-element)))
22837 ;;; Indentation
22839 (defun org--get-expected-indentation (element contentsp)
22840 "Expected indentation column for current line, according to ELEMENT.
22841 ELEMENT is an element containing point. CONTENTSP is non-nil
22842 when indentation is to be computed according to contents of
22843 ELEMENT."
22844 (let ((type (org-element-type element))
22845 (start (org-element-property :begin element))
22846 (post-affiliated (org-element-property :post-affiliated element)))
22847 (org-with-wide-buffer
22848 (cond
22849 (contentsp
22850 (case type
22851 ((diary-sexp footnote-definition) 0)
22852 ((headline inlinetask nil)
22853 (if (not org-adapt-indentation) 0
22854 (let ((level (org-current-level)))
22855 (if level (1+ level) 0))))
22856 ((item plain-list) (org-list-item-body-column post-affiliated))
22858 (goto-char start)
22859 (org-get-indentation))))
22860 ((memq type '(headline inlinetask nil))
22861 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22862 (org--get-expected-indentation element t)
22864 ((memq type '(diary-sexp footnote-definition)) 0)
22865 ;; First paragraph of a footnote definition or an item.
22866 ;; Indent like parent.
22867 ((< (line-beginning-position) start)
22868 (org--get-expected-indentation
22869 (org-element-property :parent element) t))
22870 ;; At first line: indent according to previous sibling, if any,
22871 ;; ignoring footnote definitions and inline tasks, or parent's
22872 ;; contents.
22873 ((= (line-beginning-position) start)
22874 (catch 'exit
22875 (while t
22876 (if (= (point-min) start) (throw 'exit 0)
22877 (goto-char (1- start))
22878 (let* ((previous (org-element-at-point))
22879 (parent previous))
22880 (while (and parent (<= (org-element-property :end parent) start))
22881 (setq previous parent
22882 parent (org-element-property :parent parent)))
22883 (cond
22884 ((not previous) (throw 'exit 0))
22885 ((> (org-element-property :end previous) start)
22886 (throw 'exit (org--get-expected-indentation previous t)))
22887 ((memq (org-element-type previous)
22888 '(footnote-definition inlinetask))
22889 (setq start (org-element-property :begin previous)))
22890 (t (goto-char (org-element-property :begin previous))
22891 (throw 'exit
22892 (if (bolp) (org-get-indentation)
22893 ;; At first paragraph in an item or
22894 ;; a footnote definition.
22895 (org--get-expected-indentation
22896 (org-element-property :parent previous) t))))))))))
22897 ;; Otherwise, move to the first non-blank line above.
22899 (beginning-of-line)
22900 (let ((pos (point)))
22901 (skip-chars-backward " \r\t\n")
22902 (cond
22903 ;; Two blank lines end a footnote definition or a plain
22904 ;; list. When we indent an empty line after them, the
22905 ;; containing list or footnote definition is over, so it
22906 ;; qualifies as a previous sibling. Therefore, we indent
22907 ;; like its first line.
22908 ((and (memq type '(footnote-definition plain-list))
22909 (> (count-lines (point) pos) 2))
22910 (goto-char start)
22911 (org-get-indentation))
22912 ;; Line above is the first one of a paragraph at the
22913 ;; beginning of an item or a footnote definition. Indent
22914 ;; like parent.
22915 ((< (line-beginning-position) start)
22916 (org--get-expected-indentation
22917 (org-element-property :parent element) t))
22918 ;; Line above is the beginning of an element, i.e., point
22919 ;; was originally on the blank lines between element's start
22920 ;; and contents.
22921 ((= (line-beginning-position) post-affiliated)
22922 (org--get-expected-indentation element t))
22923 ;; POS is after contents in a greater element. Indent like
22924 ;; the beginning of the element.
22926 ;; As a special case, if point is at the end of a footnote
22927 ;; definition or an item, indent like the very last element
22928 ;; within.
22929 ((and (not (eq type 'paragraph))
22930 (let ((cend (org-element-property :contents-end element)))
22931 (and cend (<= cend pos))))
22932 (if (memq type '(footnote-definition item plain-list))
22933 (let ((last (org-element-at-point)))
22934 (org--get-expected-indentation
22935 last
22936 (memq (org-element-type last)
22937 '(footnote-definition item plain-list))))
22938 (goto-char start)
22939 (org-get-indentation)))
22940 ;; In any other case, indent like the current line.
22941 (t (org-get-indentation)))))))))
22943 (defun org--align-node-property ()
22944 "Align node property at point.
22945 Alignment is done according to `org-property-format', which see."
22946 (when (save-excursion
22947 (beginning-of-line)
22948 (looking-at org-property-re))
22949 (replace-match
22950 (concat (match-string 4)
22951 (org-trim
22952 (format org-property-format (match-string 1) (match-string 3))))
22953 t t)))
22955 (defun org-indent-line ()
22956 "Indent line depending on context.
22958 Indentation is done according to the following rules:
22960 - Footnote definitions, diary sexps, headlines and inline tasks
22961 have to start at column 0.
22963 - On the very first line of an element, consider, in order, the
22964 next rules until one matches:
22966 1. If there's a sibling element before, ignoring footnote
22967 definitions and inline tasks, indent like its first line.
22969 2. If element has a parent, indent like its contents. More
22970 precisely, if parent is an item, indent after the
22971 description part, if any, or the bullet (see
22972 `org-list-description-max-indent'). Else, indent like
22973 parent's first line.
22975 3. Otherwise, indent relatively to current level, if
22976 `org-adapt-indentation' is non-nil, or to left margin.
22978 - On a blank line at the end of an element, indent according to
22979 the type of the element. More precisely
22981 1. If element is a plain list, an item, or a footnote
22982 definition, indent like the very last element within.
22984 2. If element is a paragraph, indent like its last non blank
22985 line.
22987 3. Otherwise, indent like its very first line.
22989 - In the code part of a source block, use language major mode
22990 to indent current line if `org-src-tab-acts-natively' is
22991 non-nil. If it is nil, do nothing.
22993 - Otherwise, indent like the first non-blank line above.
22995 The function doesn't indent an item as it could break the whole
22996 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22997 \\[org-shiftmetaright].
22999 Also align node properties according to `org-property-format'."
23000 (interactive)
23001 (cond
23002 (orgstruct-is-++
23003 (let ((indent-line-function
23004 (cadadr (assq 'indent-line-function org-fb-vars))))
23005 (indent-according-to-mode)))
23006 ((org-at-heading-p) 'noindent)
23008 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23009 (type (org-element-type element)))
23010 (cond ((and (memq type '(plain-list item))
23011 (= (line-beginning-position)
23012 (org-element-property :post-affiliated element)))
23013 'noindent)
23014 ((and (eq type 'src-block)
23015 org-src-tab-acts-natively
23016 (> (line-beginning-position)
23017 (org-element-property :post-affiliated element))
23018 (< (line-beginning-position)
23019 (org-with-wide-buffer
23020 (goto-char (org-element-property :end element))
23021 (skip-chars-backward " \r\t\n")
23022 (line-beginning-position))))
23023 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23025 (let ((column (org--get-expected-indentation element nil)))
23026 ;; Preserve current column.
23027 (if (<= (current-column) (current-indentation))
23028 (org-indent-line-to column)
23029 (save-excursion (org-indent-line-to column))))
23030 ;; Align node property. Also preserve current column.
23031 (when (eq type 'node-property)
23032 (let ((column (current-column)))
23033 (org--align-node-property)
23034 (org-move-to-column column)))))))))
23036 (defun org-indent-region (start end)
23037 "Indent each non-blank line in the region.
23038 Called from a program, START and END specify the region to
23039 indent. The function will not indent contents of example blocks,
23040 verse blocks and export blocks as leading white spaces are
23041 assumed to be significant there."
23042 (interactive "r")
23043 (save-excursion
23044 (goto-char start)
23045 (skip-chars-forward " \r\t\n")
23046 (unless (eobp) (beginning-of-line))
23047 (let ((indent-to
23048 (lambda (ind pos)
23049 ;; Set IND as indentation for all lines between point and
23050 ;; POS or END, whichever comes first. Blank lines are
23051 ;; ignored. Leave point after POS once done.
23052 (let ((limit (copy-marker (min end pos))))
23053 (while (< (point) limit)
23054 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23055 (forward-line))
23056 (set-marker limit nil))))
23057 (end (copy-marker end)))
23058 (while (< (point) end)
23059 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23060 (let* ((element (org-element-at-point))
23061 (type (org-element-type element))
23062 (element-end (copy-marker (org-element-property :end element)))
23063 (ind (org--get-expected-indentation element nil)))
23064 (cond
23065 ((or (memq type '(paragraph table table-row))
23066 (not (or (org-element-property :contents-begin element)
23067 (memq type
23068 '(example-block export-block src-block)))))
23069 ;; Elements here are indented as a single block. Also
23070 ;; align node properties.
23071 (when (eq type 'node-property)
23072 (org--align-node-property)
23073 (beginning-of-line))
23074 (funcall indent-to ind element-end))
23076 ;; Elements in this category consist of three parts:
23077 ;; before the contents, the contents, and after the
23078 ;; contents. The contents are treated specially,
23079 ;; according to the element type, or not indented at
23080 ;; all. Other parts are indented as a single block.
23081 (let* ((post (copy-marker
23082 (org-element-property :post-affiliated element)))
23083 (cbeg
23084 (copy-marker
23085 (cond
23086 ((not (org-element-property :contents-begin element))
23087 ;; Fake contents for source blocks.
23088 (org-with-wide-buffer
23089 (goto-char post)
23090 (forward-line)
23091 (point)))
23092 ((memq type '(footnote-definition item plain-list))
23093 ;; Contents in these elements could start on
23094 ;; the same line as the beginning of the
23095 ;; element. Make sure we start indenting
23096 ;; from the second line.
23097 (org-with-wide-buffer
23098 (goto-char post)
23099 (end-of-line)
23100 (skip-chars-forward " \r\t\n")
23101 (if (eobp) (point) (line-beginning-position))))
23102 (t (org-element-property :contents-begin element)))))
23103 (cend (copy-marker
23104 (or (org-element-property :contents-end element)
23105 ;; Fake contents for source blocks.
23106 (org-with-wide-buffer
23107 (goto-char element-end)
23108 (skip-chars-backward " \r\t\n")
23109 (line-beginning-position)))
23110 t)))
23111 ;; Do not change items indentation individually as it
23112 ;; might break the list as a whole. On the other
23113 ;; hand, when at a plain list, indent it as a whole.
23114 (cond ((eq type 'plain-list)
23115 (let ((offset (- ind (org-get-indentation))))
23116 (unless (zerop offset)
23117 (indent-rigidly (org-element-property :begin element)
23118 (org-element-property :end element)
23119 offset))
23120 (goto-char cbeg)))
23121 ((eq type 'item) (goto-char cbeg))
23122 (t (funcall indent-to ind cbeg)))
23123 (when (< (point) end)
23124 (case type
23125 ((example-block export-block verse-block))
23126 (src-block
23127 ;; In a source block, indent source code
23128 ;; according to language major mode, but only if
23129 ;; `org-src-tab-acts-natively' is non-nil.
23130 (when (and (< (point) end) org-src-tab-acts-natively)
23131 (ignore-errors
23132 (org-babel-do-in-edit-buffer
23133 (indent-region (point-min) (point-max))))))
23134 (t (org-indent-region (point) (min cend end))))
23135 (goto-char (min cend end))
23136 (when (< (point) end) (funcall indent-to ind element-end)))
23137 (set-marker post nil)
23138 (set-marker cbeg nil)
23139 (set-marker cend nil))))
23140 (set-marker element-end nil))))
23141 (set-marker end nil))))
23143 (defun org-indent-drawer ()
23144 "Indent the drawer at point."
23145 (interactive)
23146 (unless (save-excursion
23147 (beginning-of-line)
23148 (org-looking-at-p org-drawer-regexp))
23149 (user-error "Not at a drawer"))
23150 (let ((element (org-element-at-point)))
23151 (unless (memq (org-element-type element) '(drawer property-drawer))
23152 (user-error "Not at a drawer"))
23153 (org-with-wide-buffer
23154 (org-indent-region (org-element-property :begin element)
23155 (org-element-property :end element))))
23156 (message "Drawer at point indented"))
23158 (defun org-indent-block ()
23159 "Indent the block at point."
23160 (interactive)
23161 (unless (save-excursion
23162 (beginning-of-line)
23163 (let ((case-fold-search t))
23164 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23165 (user-error "Not at a block"))
23166 (let ((element (org-element-at-point)))
23167 (unless (memq (org-element-type element)
23168 '(comment-block center-block dynamic-block example-block
23169 export-block quote-block special-block
23170 src-block verse-block))
23171 (user-error "Not at a block"))
23172 (org-with-wide-buffer
23173 (org-indent-region (org-element-property :begin element)
23174 (org-element-property :end element))))
23175 (message "Block at point indented"))
23178 ;;; Filling
23180 ;; We use our own fill-paragraph and auto-fill functions.
23182 ;; `org-fill-paragraph' relies on adaptive filling and context
23183 ;; checking. Appropriate `fill-prefix' is computed with
23184 ;; `org-adaptive-fill-function'.
23186 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23187 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23188 ;; `org-adaptive-fill-function' value. Internally,
23189 ;; `org-comment-line-break-function' breaks the line.
23191 ;; `org-setup-filling' installs filling and auto-filling related
23192 ;; variables during `org-mode' initialization.
23194 (defvar org-element-paragraph-separate) ; org-element.el
23195 (defun org-setup-filling ()
23196 (require 'org-element)
23197 ;; Prevent auto-fill from inserting unwanted new items.
23198 (when (boundp 'fill-nobreak-predicate)
23199 (org-set-local
23200 'fill-nobreak-predicate
23201 (org-uniquify
23202 (append fill-nobreak-predicate
23203 '(org-fill-line-break-nobreak-p
23204 org-fill-paragraph-with-timestamp-nobreak-p)))))
23205 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23206 (org-set-local 'paragraph-start paragraph-ending)
23207 (org-set-local 'paragraph-separate paragraph-ending))
23208 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23209 (org-set-local 'auto-fill-inhibit-regexp nil)
23210 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23211 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23212 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23214 (defun org-fill-line-break-nobreak-p ()
23215 "Non-nil when a new line at point would create an Org line break."
23216 (save-excursion
23217 (skip-chars-backward "[ \t]")
23218 (skip-chars-backward "\\\\")
23219 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23221 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23222 "Non-nil when a new line at point would split a timestamp."
23223 (and (org-at-timestamp-p t)
23224 (not (looking-at org-ts-regexp-both))))
23226 (declare-function message-in-body-p "message" ())
23227 (defvar orgtbl-line-start-regexp) ; From org-table.el
23228 (defun org-adaptive-fill-function ()
23229 "Compute a fill prefix for the current line.
23230 Return fill prefix, as a string, or nil if current line isn't
23231 meant to be filled. For convenience, if `adaptive-fill-regexp'
23232 matches in paragraphs or comments, use it."
23233 (catch 'exit
23234 (when (derived-mode-p 'message-mode)
23235 (save-excursion
23236 (beginning-of-line)
23237 (cond ((not (message-in-body-p)) (throw 'exit nil))
23238 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23239 ((looking-at message-cite-prefix-regexp)
23240 (throw 'exit (match-string-no-properties 0)))
23241 ((looking-at org-outline-regexp)
23242 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23243 (org-with-wide-buffer
23244 (unless (org-at-heading-p)
23245 (let* ((p (line-beginning-position))
23246 (element (save-excursion
23247 (beginning-of-line)
23248 (org-element-at-point)))
23249 (type (org-element-type element))
23250 (post-affiliated (org-element-property :post-affiliated element)))
23251 (unless (< p post-affiliated)
23252 (case type
23253 (comment
23254 (save-excursion
23255 (beginning-of-line)
23256 (looking-at "[ \t]*")
23257 (concat (match-string 0) "# ")))
23258 (footnote-definition "")
23259 ((item plain-list)
23260 (make-string (org-list-item-body-column post-affiliated) ?\s))
23261 (paragraph
23262 ;; Fill prefix is usually the same as the current line,
23263 ;; unless the paragraph is at the beginning of an item.
23264 (let ((parent (org-element-property :parent element)))
23265 (save-excursion
23266 (beginning-of-line)
23267 (cond ((eq (org-element-type parent) 'item)
23268 (make-string (org-list-item-body-column
23269 (org-element-property :begin parent))
23270 ?\s))
23271 ((and adaptive-fill-regexp
23272 ;; Locally disable
23273 ;; `adaptive-fill-function' to let
23274 ;; `fill-context-prefix' handle
23275 ;; `adaptive-fill-regexp' variable.
23276 (let (adaptive-fill-function)
23277 (fill-context-prefix
23278 post-affiliated
23279 (org-element-property :end element)))))
23280 ((looking-at "[ \t]+") (match-string 0))
23281 (t "")))))
23282 (comment-block
23283 ;; Only fill contents if P is within block boundaries.
23284 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23285 (forward-line)
23286 (point)))
23287 (cend (save-excursion
23288 (goto-char (org-element-property :end element))
23289 (skip-chars-backward " \r\t\n")
23290 (line-beginning-position))))
23291 (when (and (>= p cbeg) (< p cend))
23292 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23293 (match-string 0)
23294 "")))))))))))
23296 (declare-function message-goto-body "message" ())
23297 (defvar message-cite-prefix-regexp) ; From message.el
23298 (defun org-fill-paragraph (&optional justify)
23299 "Fill element at point, when applicable.
23301 This function only applies to comment blocks, comments, example
23302 blocks and paragraphs. Also, as a special case, re-align table
23303 when point is at one.
23305 If JUSTIFY is non-nil (interactively, with prefix argument),
23306 justify as well. If `sentence-end-double-space' is non-nil, then
23307 period followed by one space does not end a sentence, so don't
23308 break a line there. The variable `fill-column' controls the
23309 width for filling.
23311 For convenience, when point is at a plain list, an item or
23312 a footnote definition, try to fill the first paragraph within."
23313 (interactive)
23314 (if (and (derived-mode-p 'message-mode)
23315 (or (not (message-in-body-p))
23316 (save-excursion (move-beginning-of-line 1)
23317 (looking-at message-cite-prefix-regexp))))
23318 ;; First ensure filling is correct in message-mode.
23319 (let ((fill-paragraph-function
23320 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23321 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23322 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23323 (paragraph-separate
23324 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23325 (fill-paragraph nil))
23326 (with-syntax-table org-mode-transpose-word-syntax-table
23327 ;; Move to end of line in order to get the first paragraph
23328 ;; within a plain list or a footnote definition.
23329 (let ((element (save-excursion
23330 (end-of-line)
23331 (or (ignore-errors (org-element-at-point))
23332 (user-error "An element cannot be parsed line %d"
23333 (line-number-at-pos (point)))))))
23334 ;; First check if point is in a blank line at the beginning of
23335 ;; the buffer. In that case, ignore filling.
23336 (case (org-element-type element)
23337 ;; Use major mode filling function is src blocks.
23338 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23339 ;; Align Org tables, leave table.el tables as-is.
23340 (table-row (org-table-align) t)
23341 (table
23342 (when (eq (org-element-property :type element) 'org)
23343 (save-excursion
23344 (goto-char (org-element-property :post-affiliated element))
23345 (org-table-align)))
23347 (paragraph
23348 ;; Paragraphs may contain `line-break' type objects.
23349 (let ((beg (max (point-min)
23350 (org-element-property :contents-begin element)))
23351 (end (min (point-max)
23352 (org-element-property :contents-end element))))
23353 ;; Do nothing if point is at an affiliated keyword.
23354 (if (< (line-end-position) beg) t
23355 (when (derived-mode-p 'message-mode)
23356 ;; In `message-mode', do not fill following citation
23357 ;; in current paragraph nor text before message body.
23358 (let ((body-start (save-excursion (message-goto-body))))
23359 (when body-start (setq beg (max body-start beg))))
23360 (when (save-excursion
23361 (re-search-forward
23362 (concat "^" message-cite-prefix-regexp) end t))
23363 (setq end (match-beginning 0))))
23364 ;; Fill paragraph, taking line breaks into account.
23365 (save-excursion
23366 (goto-char beg)
23367 (let ((cuts (list beg)))
23368 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23369 (when (eq 'line-break
23370 (org-element-type
23371 (save-excursion (backward-char)
23372 (org-element-context))))
23373 (push (point) cuts)))
23374 (dolist (c (delq end cuts))
23375 (fill-region-as-paragraph c end justify)
23376 (setq end c))))
23377 t)))
23378 ;; Contents of `comment-block' type elements should be
23379 ;; filled as plain text, but only if point is within block
23380 ;; markers.
23381 (comment-block
23382 (let* ((case-fold-search t)
23383 (beg (save-excursion
23384 (goto-char (org-element-property :begin element))
23385 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23386 (forward-line)
23387 (point)))
23388 (end (save-excursion
23389 (goto-char (org-element-property :end element))
23390 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23391 (line-beginning-position))))
23392 (if (or (< (point) beg) (> (point) end)) t
23393 (fill-region-as-paragraph
23394 (save-excursion (end-of-line)
23395 (re-search-backward "^[ \t]*$" beg 'move)
23396 (line-beginning-position))
23397 (save-excursion (beginning-of-line)
23398 (re-search-forward "^[ \t]*$" end 'move)
23399 (line-beginning-position))
23400 justify))))
23401 ;; Fill comments.
23402 (comment
23403 (let ((begin (org-element-property :post-affiliated element))
23404 (end (org-element-property :end element)))
23405 (when (and (>= (point) begin) (<= (point) end))
23406 (let ((begin (save-excursion
23407 (end-of-line)
23408 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23409 (progn (forward-line) (point))
23410 begin)))
23411 (end (save-excursion
23412 (end-of-line)
23413 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23414 (1- (line-beginning-position))
23415 (skip-chars-backward " \r\t\n")
23416 (line-end-position)))))
23417 ;; Do not fill comments when at a blank line.
23418 (when (> end begin)
23419 (let ((fill-prefix
23420 (save-excursion
23421 (beginning-of-line)
23422 (looking-at "[ \t]*#")
23423 (let ((comment-prefix (match-string 0)))
23424 (goto-char (match-end 0))
23425 (if (looking-at adaptive-fill-regexp)
23426 (concat comment-prefix (match-string 0))
23427 (concat comment-prefix " "))))))
23428 (save-excursion
23429 (fill-region-as-paragraph begin end justify))))))
23431 ;; Ignore every other element.
23432 (otherwise t))))))
23434 (defun org-auto-fill-function ()
23435 "Auto-fill function."
23436 ;; Check if auto-filling is meaningful.
23437 (let ((fc (current-fill-column)))
23438 (when (and fc (> (current-column) fc))
23439 (let* ((fill-prefix (org-adaptive-fill-function))
23440 ;; Enforce empty fill prefix, if required. Otherwise, it
23441 ;; will be computed again.
23442 (adaptive-fill-mode (not (equal fill-prefix ""))))
23443 (when fill-prefix (do-auto-fill))))))
23445 (defun org-comment-line-break-function (&optional soft)
23446 "Break line at point and indent, continuing comment if within one.
23447 The inserted newline is marked hard if variable
23448 `use-hard-newlines' is true, unless optional argument SOFT is
23449 non-nil."
23450 (if soft (insert-and-inherit ?\n) (newline 1))
23451 (save-excursion (forward-char -1) (delete-horizontal-space))
23452 (delete-horizontal-space)
23453 (indent-to-left-margin)
23454 (insert-before-markers-and-inherit fill-prefix))
23457 ;;; Fixed Width Areas
23459 (defun org-toggle-fixed-width ()
23460 "Toggle fixed-width markup.
23462 Add or remove fixed-width markup on current line, whenever it
23463 makes sense. Return an error otherwise.
23465 If a region is active and if it contains only fixed-width areas
23466 or blank lines, remove all fixed-width markup in it. If the
23467 region contains anything else, convert all non-fixed-width lines
23468 to fixed-width ones.
23470 Blank lines at the end of the region are ignored unless the
23471 region only contains such lines."
23472 (interactive)
23473 (if (not (org-region-active-p))
23474 ;; No region:
23476 ;; Remove fixed width marker only in a fixed-with element.
23478 ;; Add fixed width maker in paragraphs, in blank lines after
23479 ;; elements or at the beginning of a headline or an inlinetask,
23480 ;; and before any one-line elements (e.g., a clock).
23481 (progn
23482 (beginning-of-line)
23483 (let* ((element (org-element-at-point))
23484 (type (org-element-type element)))
23485 (cond
23486 ((and (eq type 'fixed-width)
23487 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23488 (replace-match
23489 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23490 ((and (memq type '(babel-call clock comment diary-sexp headline
23491 horizontal-rule keyword paragraph
23492 planning))
23493 (<= (org-element-property :post-affiliated element) (point)))
23494 (skip-chars-forward " \t")
23495 (insert ": "))
23496 ((and (org-looking-at-p "[ \t]*$")
23497 (or (eq type 'inlinetask)
23498 (save-excursion
23499 (skip-chars-forward " \r\t\n")
23500 (<= (org-element-property :end element) (point)))))
23501 (delete-region (point) (line-end-position))
23502 (org-indent-line)
23503 (insert ": "))
23504 (t (user-error "Cannot insert a fixed-width line here")))))
23505 ;; Region active.
23506 (let* ((begin (save-excursion
23507 (goto-char (region-beginning))
23508 (line-beginning-position)))
23509 (end (copy-marker
23510 (save-excursion
23511 (goto-char (region-end))
23512 (unless (eolp) (beginning-of-line))
23513 (if (save-excursion (re-search-backward "\\S-" begin t))
23514 (progn (skip-chars-backward " \r\t\n") (point))
23515 (point)))))
23516 (all-fixed-width-p
23517 (catch 'not-all-p
23518 (save-excursion
23519 (goto-char begin)
23520 (skip-chars-forward " \r\t\n")
23521 (when (eobp) (throw 'not-all-p nil))
23522 (while (< (point) end)
23523 (let ((element (org-element-at-point)))
23524 (if (eq (org-element-type element) 'fixed-width)
23525 (goto-char (org-element-property :end element))
23526 (throw 'not-all-p nil))))
23527 t))))
23528 (if all-fixed-width-p
23529 (save-excursion
23530 (goto-char begin)
23531 (while (< (point) end)
23532 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23533 (replace-match
23534 "" nil nil nil
23535 (if (= (line-end-position) (match-end 0)) 0 1)))
23536 (forward-line)))
23537 (let ((min-ind (point-max)))
23538 ;; Find minimum indentation across all lines.
23539 (save-excursion
23540 (goto-char begin)
23541 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23542 (setq min-ind 0)
23543 (catch 'zerop
23544 (while (< (point) end)
23545 (unless (org-looking-at-p "[ \t]*$")
23546 (let ((ind (org-get-indentation)))
23547 (setq min-ind (min min-ind ind))
23548 (when (zerop ind) (throw 'zerop t))))
23549 (forward-line)))))
23550 ;; Loop over all lines and add fixed-width markup everywhere
23551 ;; but in fixed-width lines.
23552 (save-excursion
23553 (goto-char begin)
23554 (while (< (point) end)
23555 (cond
23556 ((org-at-heading-p)
23557 (insert ": ")
23558 (forward-line)
23559 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23560 (insert ":")
23561 (forward-line)))
23562 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23563 (let* ((element (org-element-at-point))
23564 (element-end (org-element-property :end element)))
23565 (if (eq (org-element-type element) 'fixed-width)
23566 (progn (goto-char element-end)
23567 (skip-chars-backward " \r\t\n")
23568 (forward-line))
23569 (let ((limit (min end element-end)))
23570 (while (< (point) limit)
23571 (org-move-to-column min-ind t)
23572 (insert ": ")
23573 (forward-line))))))
23575 (org-move-to-column min-ind t)
23576 (insert ": ")
23577 (forward-line)))))))
23578 (set-marker end nil))))
23581 ;;; Comments
23583 ;; Org comments syntax is quite complex. It requires the entire line
23584 ;; to be just a comment. Also, even with the right syntax at the
23585 ;; beginning of line, some some elements (i.e. verse-block or
23586 ;; example-block) don't accept comments. Usual Emacs comment commands
23587 ;; cannot cope with those requirements. Therefore, Org replaces them.
23589 ;; Org still relies on `comment-dwim', but cannot trust
23590 ;; `comment-only-p'. So, `comment-region-function' and
23591 ;; `uncomment-region-function' both point
23592 ;; to`org-comment-or-uncomment-region'. Eventually,
23593 ;; `org-insert-comment' takes care of insertion of comments at the
23594 ;; beginning of line.
23596 ;; `org-setup-comments-handling' install comments related variables
23597 ;; during `org-mode' initialization.
23599 (defun org-setup-comments-handling ()
23600 (interactive)
23601 (org-set-local 'comment-use-syntax nil)
23602 (org-set-local 'comment-start "# ")
23603 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23604 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23605 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23606 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23608 (defun org-insert-comment ()
23609 "Insert an empty comment above current line.
23610 If the line is empty, insert comment at its beginning. When
23611 point is within a source block, comment according to the related
23612 major mode."
23613 (if (let ((element (org-element-at-point)))
23614 (and (eq (org-element-type element) 'src-block)
23615 (< (save-excursion
23616 (goto-char (org-element-property :post-affiliated element))
23617 (line-end-position))
23618 (point))
23619 (> (save-excursion
23620 (goto-char (org-element-property :end element))
23621 (skip-chars-backward " \r\t\n")
23622 (line-beginning-position))
23623 (point))))
23624 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23625 (beginning-of-line)
23626 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23627 (open-line 1))
23628 (org-indent-line)
23629 (insert "# ")))
23631 (defvar comment-empty-lines) ; From newcomment.el.
23632 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23633 "Comment or uncomment each non-blank line in the region.
23634 Uncomment each non-blank line between BEG and END if it only
23635 contains commented lines. Otherwise, comment them. If region is
23636 strictly within a source block, use appropriate comment syntax."
23637 (if (let ((element (org-element-at-point)))
23638 (and (eq (org-element-type element) 'src-block)
23639 (< (save-excursion
23640 (goto-char (org-element-property :post-affiliated element))
23641 (line-end-position))
23642 beg)
23643 (>= (save-excursion
23644 (goto-char (org-element-property :end element))
23645 (skip-chars-backward " \r\t\n")
23646 (line-beginning-position))
23647 end)))
23648 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23649 (save-restriction
23650 ;; Restrict region
23651 (narrow-to-region (save-excursion (goto-char beg)
23652 (skip-chars-forward " \r\t\n" end)
23653 (line-beginning-position))
23654 (save-excursion (goto-char end)
23655 (skip-chars-backward " \r\t\n" beg)
23656 (line-end-position)))
23657 (let ((uncommentp
23658 ;; UNCOMMENTP is non-nil when every non blank line between
23659 ;; BEG and END is a comment.
23660 (save-excursion
23661 (goto-char (point-min))
23662 (while (and (not (eobp))
23663 (let ((element (org-element-at-point)))
23664 (and (eq (org-element-type element) 'comment)
23665 (goto-char (min (point-max)
23666 (org-element-property
23667 :end element)))))))
23668 (eobp))))
23669 (if uncommentp
23670 ;; Only blank lines and comments in region: uncomment it.
23671 (save-excursion
23672 (goto-char (point-min))
23673 (while (not (eobp))
23674 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23675 (replace-match "" nil nil nil 1))
23676 (forward-line)))
23677 ;; Comment each line in region.
23678 (let ((min-indent (point-max)))
23679 ;; First find the minimum indentation across all lines.
23680 (save-excursion
23681 (goto-char (point-min))
23682 (while (and (not (eobp)) (not (zerop min-indent)))
23683 (unless (looking-at "[ \t]*$")
23684 (setq min-indent (min min-indent (current-indentation))))
23685 (forward-line)))
23686 ;; Then loop over all lines.
23687 (save-excursion
23688 (goto-char (point-min))
23689 (while (not (eobp))
23690 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23691 ;; Don't get fooled by invisible text (e.g. link path)
23692 ;; when moving to column MIN-INDENT.
23693 (let ((buffer-invisibility-spec nil))
23694 (org-move-to-column min-indent t))
23695 (insert comment-start))
23696 (forward-line)))))))))
23698 (defun org-comment-dwim (arg)
23699 "Call `comment-dwim' within a source edit buffer if needed."
23700 (interactive "*P")
23701 (if (org-in-src-block-p)
23702 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23703 (call-interactively 'comment-dwim)))
23706 ;;; Timestamps API
23708 ;; This section contains tools to operate on timestamp objects, as
23709 ;; returned by, e.g. `org-element-context'.
23711 (defun org-timestamp--to-internal-time (timestamp &optional end)
23712 "Encode TIMESTAMP object into Emacs internal time.
23713 Use end of date range or time range when END is non-nil."
23714 (apply #'encode-time
23715 (cons 0
23716 (mapcar
23717 (lambda (prop) (or (org-element-property prop timestamp) 0))
23718 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23719 '(:minute-start :hour-start :day-start :month-start
23720 :year-start))))))
23722 (defun org-timestamp-has-time-p (timestamp)
23723 "Non-nil when TIMESTAMP has a time specified."
23724 (org-element-property :hour-start timestamp))
23726 (defun org-timestamp-format (timestamp format &optional end utc)
23727 "Format a TIMESTAMP object into a string.
23729 FORMAT is a format specifier to be passed to
23730 `format-time-string'.
23732 When optional argument END is non-nil, use end of date-range or
23733 time-range, if possible.
23735 When optional argument UTC is non-nil, time will be expressed as
23736 Universal Time."
23737 (format-time-string
23738 format (org-timestamp--to-internal-time timestamp end) utc))
23740 (defun org-timestamp-split-range (timestamp &optional end)
23741 "Extract a TIMESTAMP object from a date or time range.
23743 END, when non-nil, means extract the end of the range.
23744 Otherwise, extract its start.
23746 Return a new timestamp object."
23747 (let ((type (org-element-property :type timestamp)))
23748 (if (memq type '(active inactive diary)) timestamp
23749 (let ((split-ts (org-element-copy timestamp)))
23750 ;; Set new type.
23751 (org-element-put-property
23752 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23753 ;; Copy start properties over end properties if END is
23754 ;; non-nil. Otherwise, copy end properties over `start' ones.
23755 (let ((p-alist '((:minute-start . :minute-end)
23756 (:hour-start . :hour-end)
23757 (:day-start . :day-end)
23758 (:month-start . :month-end)
23759 (:year-start . :year-end))))
23760 (dolist (p-cell p-alist)
23761 (org-element-put-property
23762 split-ts
23763 (funcall (if end #'car #'cdr) p-cell)
23764 (org-element-property
23765 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23766 ;; Eventually refresh `:raw-value'.
23767 (org-element-put-property split-ts :raw-value nil)
23768 (org-element-put-property
23769 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23771 (defun org-timestamp-translate (timestamp &optional boundary)
23772 "Translate TIMESTAMP object to custom format.
23774 Format string is defined in `org-time-stamp-custom-formats',
23775 which see.
23777 When optional argument BOUNDARY is non-nil, it is either the
23778 symbol `start' or `end'. In this case, only translate the
23779 starting or ending part of TIMESTAMP if it is a date or time
23780 range. Otherwise, translate both parts.
23782 Return timestamp as-is if `org-display-custom-times' is nil or if
23783 it has a `diary' type."
23784 (let ((type (org-element-property :type timestamp)))
23785 (if (or (not org-display-custom-times) (eq type 'diary))
23786 (org-element-interpret-data timestamp)
23787 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23788 org-time-stamp-custom-formats)))
23789 (if (and (not boundary) (memq type '(active-range inactive-range)))
23790 (concat (org-timestamp-format timestamp fmt)
23791 "--"
23792 (org-timestamp-format timestamp fmt t))
23793 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23797 ;;; Other stuff.
23799 (defun org-reftex-citation ()
23800 "Use reftex-citation to insert a citation into the buffer.
23801 This looks for a line like
23803 #+BIBLIOGRAPHY: foo plain option:-d
23805 and derives from it that foo.bib is the bibliography file relevant
23806 for this document. It then installs the necessary environment for RefTeX
23807 to work in this buffer and calls `reftex-citation' to insert a citation
23808 into the buffer.
23810 Export of such citations to both LaTeX and HTML is handled by the contributed
23811 package ox-bibtex by Taru Karttunen."
23812 (interactive)
23813 (let ((reftex-docstruct-symbol 'rds)
23814 (reftex-cite-format "\\cite{%l}")
23815 rds bib)
23816 (save-excursion
23817 (save-restriction
23818 (widen)
23819 (let ((case-fold-search t)
23820 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23821 (if (not (save-excursion
23822 (or (re-search-forward re nil t)
23823 (re-search-backward re nil t))))
23824 (user-error "No bibliography defined in file")
23825 (setq bib (concat (match-string 1) ".bib")
23826 rds (list (list 'bib bib)))))))
23827 (call-interactively 'reftex-citation)))
23829 ;;;; Functions extending outline functionality
23831 (defun org-beginning-of-line (&optional arg)
23832 "Go to the beginning of the current line. If that is invisible, continue
23833 to a visible line beginning. This makes the function of C-a more intuitive.
23834 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23835 first attempt, and only move to after the tags when the cursor is already
23836 beyond the end of the headline."
23837 (interactive "P")
23838 (let ((pos (point))
23839 (special (if (consp org-special-ctrl-a/e)
23840 (car org-special-ctrl-a/e)
23841 org-special-ctrl-a/e))
23842 deactivate-mark refpos)
23843 (if (org-bound-and-true-p visual-line-mode)
23844 (beginning-of-visual-line 1)
23845 (beginning-of-line 1))
23846 (if (and arg (fboundp 'move-beginning-of-line))
23847 (call-interactively 'move-beginning-of-line)
23848 (if (bobp)
23850 (backward-char 1)
23851 (if (org-truely-invisible-p)
23852 (while (and (not (bobp)) (org-truely-invisible-p))
23853 (backward-char 1)
23854 (beginning-of-line 1))
23855 (forward-char 1))))
23856 (when special
23857 (cond
23858 ((and (looking-at org-complex-heading-regexp)
23859 (eq (char-after (match-end 1)) ?\s))
23860 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23861 (point-at-eol)))
23862 (goto-char
23863 (if (eq special t)
23864 (cond ((> pos refpos) refpos)
23865 ((= pos (point)) refpos)
23866 (t (point)))
23867 (cond ((> pos (point)) (point))
23868 ((not (eq last-command this-command)) (point))
23869 (t refpos)))))
23870 ((org-at-item-p)
23871 ;; Being at an item and not looking at an the item means point
23872 ;; was previously moved to beginning of a visual line, which
23873 ;; doesn't contain the item. Therefore, do nothing special,
23874 ;; just stay here.
23875 (when (looking-at org-list-full-item-re)
23876 ;; Set special position at first white space character after
23877 ;; bullet, and check-box, if any.
23878 (let ((after-bullet
23879 (let ((box (match-end 3)))
23880 (if (not box) (match-end 1)
23881 (let ((after (char-after box)))
23882 (if (and after (= after ? )) (1+ box) box))))))
23883 ;; Special case: Move point to special position when
23884 ;; currently after it or at beginning of line.
23885 (if (eq special t)
23886 (when (or (> pos after-bullet) (= (point) pos))
23887 (goto-char after-bullet))
23888 ;; Reversed case: Move point to special position when
23889 ;; point was already at beginning of line and command is
23890 ;; repeated.
23891 (when (and (= (point) pos) (eq last-command this-command))
23892 (goto-char after-bullet))))))))
23893 (org-no-warnings
23894 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23895 (setq disable-point-adjustment
23896 (or (not (invisible-p (point)))
23897 (not (invisible-p (max (point-min) (1- (point))))))))
23899 (defun org-end-of-line (&optional arg)
23900 "Go to the end of the line.
23901 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23902 tags on the first attempt, and only move to after the tags when
23903 the cursor is already beyond the end of the headline."
23904 (interactive "P")
23905 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23906 org-special-ctrl-a/e))
23907 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23908 'end-of-visual-line)
23909 ((fboundp 'move-end-of-line) 'move-end-of-line)
23910 (t 'end-of-line)))
23911 deactivate-mark)
23912 (if (or (not special) arg) (call-interactively move-fun)
23913 (let* ((element (save-excursion (beginning-of-line)
23914 (org-element-at-point)))
23915 (type (org-element-type element)))
23916 (cond
23917 ((memq type '(headline inlinetask))
23918 (let ((pos (point)))
23919 (beginning-of-line 1)
23920 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23921 (if (eq special t)
23922 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23923 (goto-char (match-beginning 1))
23924 (goto-char (match-end 0)))
23925 (if (or (< pos (match-end 0))
23926 (not (eq this-command last-command)))
23927 (goto-char (match-end 0))
23928 (goto-char (match-beginning 1))))
23929 (call-interactively move-fun))))
23930 ((outline-invisible-p (line-end-position))
23931 ;; If element is hidden, `move-end-of-line' would put point
23932 ;; after it. Use `end-of-line' to stay on current line.
23933 (call-interactively 'end-of-line))
23934 (t (call-interactively move-fun)))))
23935 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23936 (setq disable-point-adjustment
23937 (or (not (invisible-p (point)))
23938 (not (invisible-p (max (point-min) (1- (point))))))))
23940 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23941 (define-key org-mode-map "\C-e" 'org-end-of-line)
23943 (defun org-backward-sentence (&optional arg)
23944 "Go to beginning of sentence, or beginning of table field.
23945 This will call `backward-sentence' or `org-table-beginning-of-field',
23946 depending on context."
23947 (interactive "P")
23948 (let* ((element (org-element-at-point))
23949 (contents-begin (org-element-property :contents-begin element))
23950 (table (org-element-lineage element '(table) t)))
23951 (if (and table
23952 (> (point) contents-begin)
23953 (<= (point) (org-element-property :contents-end table)))
23954 (call-interactively #'org-table-beginning-of-field)
23955 (save-restriction
23956 (when (and contents-begin
23957 (< (point-min) contents-begin)
23958 (> (point) contents-begin))
23959 (narrow-to-region contents-begin
23960 (org-element-property :contents-end element)))
23961 (call-interactively #'backward-sentence)))))
23963 (defun org-forward-sentence (&optional arg)
23964 "Go to end of sentence, or end of table field.
23965 This will call `forward-sentence' or `org-table-end-of-field',
23966 depending on context."
23967 (interactive "P")
23968 (let* ((element (org-element-at-point))
23969 (contents-end (org-element-property :contents-end element))
23970 (table (org-element-lineage element '(table) t)))
23971 (if (and table
23972 (>= (point) (org-element-property :contents-begin table))
23973 (< (point) contents-end))
23974 (call-interactively #'org-table-end-of-field)
23975 (save-restriction
23976 (when (and contents-end
23977 (> (point-max) contents-end)
23978 ;; Skip blank lines between elements.
23979 (< (org-element-property :end element)
23980 (save-excursion (goto-char contents-end)
23981 (skip-chars-forward " \r\t\n"))))
23982 (narrow-to-region (org-element-property :contents-begin element)
23983 contents-end))
23984 (call-interactively #'forward-sentence)))))
23986 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23987 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23989 (defun org-kill-line (&optional arg)
23990 "Kill line, to tags or end of line."
23991 (interactive "P")
23992 (cond
23993 ((or (not org-special-ctrl-k)
23994 (bolp)
23995 (not (org-at-heading-p)))
23996 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23997 org-ctrl-k-protect-subtree)
23998 (if (or (eq org-ctrl-k-protect-subtree 'error)
23999 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
24000 (user-error "C-k aborted as it would kill a hidden subtree")))
24001 (call-interactively
24002 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24003 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24004 (kill-region (point) (match-beginning 1))
24005 (org-set-tags nil t))
24006 (t (kill-region (point) (point-at-eol)))))
24008 (define-key org-mode-map "\C-k" 'org-kill-line)
24010 (defun org-yank (&optional arg)
24011 "Yank. If the kill is a subtree, treat it specially.
24012 This command will look at the current kill and check if is a single
24013 subtree, or a series of subtrees[1]. If it passes the test, and if the
24014 cursor is at the beginning of a line or after the stars of a currently
24015 empty headline, then the yank is handled specially. How exactly depends
24016 on the value of the following variables, both set by default.
24018 `org-yank-folded-subtrees'
24019 When set, the subtree(s) will be folded after insertion, but only
24020 if doing so would now swallow text after the yanked text.
24022 `org-yank-adjusted-subtrees'
24023 When set, the subtree will be promoted or demoted in order to
24024 fit into the local outline tree structure, which means that the
24025 level will be adjusted so that it becomes the smaller one of the
24026 two *visible* surrounding headings.
24028 Any prefix to this command will cause `yank' to be called directly with
24029 no special treatment. In particular, a simple \\[universal-argument] prefix \
24030 will just
24031 plainly yank the text as it is.
24033 \[1] The test checks if the first non-white line is a heading
24034 and if there are no other headings with fewer stars."
24035 (interactive "P")
24036 (org-yank-generic 'yank arg))
24038 (defun org-yank-generic (command arg)
24039 "Perform some yank-like command.
24041 This function implements the behavior described in the `org-yank'
24042 documentation. However, it has been generalized to work for any
24043 interactive command with similar behavior."
24045 ;; pretend to be command COMMAND
24046 (setq this-command command)
24048 (if arg
24049 (call-interactively command)
24051 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24052 (and (org-kill-is-subtree-p)
24053 (or (bolp)
24054 (and (looking-at "[ \t]*$")
24055 (string-match
24056 "\\`\\*+\\'"
24057 (buffer-substring (point-at-bol) (point)))))))
24058 swallowp)
24059 (cond
24060 ((and subtreep org-yank-folded-subtrees)
24061 (let ((beg (point))
24062 end)
24063 (if (and subtreep org-yank-adjusted-subtrees)
24064 (org-paste-subtree nil nil 'for-yank)
24065 (call-interactively command))
24067 (setq end (point))
24068 (goto-char beg)
24069 (when (and (bolp) subtreep
24070 (not (setq swallowp
24071 (org-yank-folding-would-swallow-text beg end))))
24072 (org-with-limited-levels
24073 (or (looking-at org-outline-regexp)
24074 (re-search-forward org-outline-regexp-bol end t))
24075 (while (and (< (point) end) (looking-at org-outline-regexp))
24076 (hide-subtree)
24077 (org-cycle-show-empty-lines 'folded)
24078 (condition-case nil
24079 (outline-forward-same-level 1)
24080 (error (goto-char end))))))
24081 (when swallowp
24082 (message
24083 "Inserted text not folded because that would swallow text"))
24085 (goto-char end)
24086 (skip-chars-forward " \t\n\r")
24087 (beginning-of-line 1)
24088 (push-mark beg 'nomsg)))
24089 ((and subtreep org-yank-adjusted-subtrees)
24090 (let ((beg (point-at-bol)))
24091 (org-paste-subtree nil nil 'for-yank)
24092 (push-mark beg 'nomsg)))
24094 (call-interactively command))))))
24096 (defun org-yank-folding-would-swallow-text (beg end)
24097 "Would hide-subtree at BEG swallow any text after END?"
24098 (let (level)
24099 (org-with-limited-levels
24100 (save-excursion
24101 (goto-char beg)
24102 (when (or (looking-at org-outline-regexp)
24103 (re-search-forward org-outline-regexp-bol end t))
24104 (setq level (org-outline-level)))
24105 (goto-char end)
24106 (skip-chars-forward " \t\r\n\v\f")
24107 (if (or (eobp)
24108 (and (bolp) (looking-at org-outline-regexp)
24109 (<= (org-outline-level) level)))
24110 nil ; Nothing would be swallowed
24111 t))))) ; something would swallow
24113 (define-key org-mode-map "\C-y" 'org-yank)
24115 (defun org-truely-invisible-p ()
24116 "Check if point is at a character currently not visible.
24117 This version does not only check the character property, but also
24118 `visible-mode'."
24119 ;; Early versions of noutline don't have `outline-invisible-p'.
24120 (if (org-bound-and-true-p visible-mode)
24122 (outline-invisible-p)))
24124 (defun org-invisible-p2 ()
24125 "Check if point is at a character currently not visible."
24126 (save-excursion
24127 (if (and (eolp) (not (bobp))) (backward-char 1))
24128 ;; Early versions of noutline don't have `outline-invisible-p'.
24129 (outline-invisible-p)))
24131 (defun org-back-to-heading (&optional invisible-ok)
24132 "Call `outline-back-to-heading', but provide a better error message."
24133 (condition-case nil
24134 (outline-back-to-heading invisible-ok)
24135 (error (error "Before first headline at position %d in buffer %s"
24136 (point) (current-buffer)))))
24138 (defun org-before-first-heading-p ()
24139 "Before first heading?"
24140 (save-excursion
24141 (end-of-line)
24142 (null (re-search-backward org-outline-regexp-bol nil t))))
24144 (defun org-at-heading-p (&optional ignored)
24145 (outline-on-heading-p t))
24146 ;; Compatibility alias with Org versions < 7.8.03
24147 (defalias 'org-on-heading-p 'org-at-heading-p)
24149 (defun org-in-commented-heading-p (&optional no-inheritance)
24150 "Non-nil if point is under a commented heading.
24151 This function also checks ancestors of the current headline,
24152 unless optional argument NO-INHERITANCE is non-nil."
24153 (cond
24154 ((org-before-first-heading-p) nil)
24155 ((let ((headline (nth 4 (org-heading-components))))
24156 (and headline
24157 (let ((case-fold-search nil))
24158 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24159 headline)))))
24160 (no-inheritance nil)
24162 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24164 (defun org-at-comment-p nil
24165 "Is cursor in a commented line?"
24166 (save-excursion
24167 (save-match-data
24168 (beginning-of-line)
24169 (looking-at "^[ \t]*# "))))
24171 (defun org-at-drawer-p nil
24172 "Is cursor at a drawer keyword?"
24173 (save-excursion
24174 (move-beginning-of-line 1)
24175 (looking-at org-drawer-regexp)))
24177 (defun org-at-block-p nil
24178 "Is cursor at a block keyword?"
24179 (save-excursion
24180 (move-beginning-of-line 1)
24181 (looking-at org-block-regexp)))
24183 (defun org-point-at-end-of-empty-headline ()
24184 "If point is at the end of an empty headline, return t, else nil.
24185 If the heading only contains a TODO keyword, it is still still considered
24186 empty."
24187 (and (looking-at "[ \t]*$")
24188 (when org-todo-line-regexp
24189 (save-excursion
24190 (beginning-of-line 1)
24191 (let ((case-fold-search nil))
24192 (looking-at org-todo-line-regexp)
24193 (string= (match-string 3) ""))))))
24195 (defun org-at-heading-or-item-p ()
24196 (or (org-at-heading-p) (org-at-item-p)))
24198 (defun org-at-target-p ()
24199 (or (org-in-regexp org-radio-target-regexp)
24200 (org-in-regexp org-target-regexp)))
24201 ;; Compatibility alias with Org versions < 7.8.03
24202 (defalias 'org-on-target-p 'org-at-target-p)
24204 (defun org-up-heading-all (arg)
24205 "Move to the heading line of which the present line is a subheading.
24206 This function considers both visible and invisible heading lines.
24207 With argument, move up ARG levels."
24208 (if (fboundp 'outline-up-heading-all)
24209 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24210 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24212 (defun org-up-heading-safe ()
24213 "Move to the heading line of which the present line is a subheading.
24214 This version will not throw an error. It will return the level of the
24215 headline found, or nil if no higher level is found.
24217 Also, this function will be a lot faster than `outline-up-heading',
24218 because it relies on stars being the outline starters. This can really
24219 make a significant difference in outlines with very many siblings."
24220 (when (ignore-errors (org-back-to-heading t))
24221 (let ((level-up (1- (funcall outline-level))))
24222 (and (> level-up 0)
24223 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24224 (funcall outline-level)))))
24226 (defun org-first-sibling-p ()
24227 "Is this heading the first child of its parents?"
24228 (interactive)
24229 (let ((re org-outline-regexp-bol)
24230 level l)
24231 (unless (org-at-heading-p t)
24232 (user-error "Not at a heading"))
24233 (setq level (funcall outline-level))
24234 (save-excursion
24235 (if (not (re-search-backward re nil t))
24237 (setq l (funcall outline-level))
24238 (< l level)))))
24240 (defun org-goto-sibling (&optional previous)
24241 "Goto the next sibling, even if it is invisible.
24242 When PREVIOUS is set, go to the previous sibling instead. Returns t
24243 when a sibling was found. When none is found, return nil and don't
24244 move point."
24245 (let ((fun (if previous 're-search-backward 're-search-forward))
24246 (pos (point))
24247 (re org-outline-regexp-bol)
24248 level l)
24249 (when (ignore-errors (org-back-to-heading t))
24250 (setq level (funcall outline-level))
24251 (catch 'exit
24252 (or previous (forward-char 1))
24253 (while (funcall fun re nil t)
24254 (setq l (funcall outline-level))
24255 (when (< l level) (goto-char pos) (throw 'exit nil))
24256 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24257 (goto-char pos)
24258 nil))))
24260 (defun org-show-siblings ()
24261 "Show all siblings of the current headline."
24262 (save-excursion
24263 (while (org-goto-sibling) (org-flag-heading nil)))
24264 (save-excursion
24265 (while (org-goto-sibling 'previous)
24266 (org-flag-heading nil))))
24268 (defun org-goto-first-child ()
24269 "Goto the first child, even if it is invisible.
24270 Return t when a child was found. Otherwise don't move point and
24271 return nil."
24272 (let (level (pos (point)) (re org-outline-regexp-bol))
24273 (when (ignore-errors (org-back-to-heading t))
24274 (setq level (outline-level))
24275 (forward-char 1)
24276 (if (and (re-search-forward re nil t) (> (outline-level) level))
24277 (progn (goto-char (match-beginning 0)) t)
24278 (goto-char pos) nil))))
24280 (defun org-show-hidden-entry ()
24281 "Show an entry where even the heading is hidden."
24282 (save-excursion
24283 (org-show-entry)))
24285 (defun org-flag-heading (flag &optional entry)
24286 "Flag the current heading. FLAG non-nil means make invisible.
24287 When ENTRY is non-nil, show the entire entry."
24288 (save-excursion
24289 (org-back-to-heading t)
24290 ;; Check if we should show the entire entry
24291 (if entry
24292 (progn
24293 (org-show-entry)
24294 (save-excursion
24295 (and (outline-next-heading)
24296 (org-flag-heading nil))))
24297 (outline-flag-region (max (point-min) (1- (point)))
24298 (save-excursion (outline-end-of-heading) (point))
24299 flag))))
24301 (defun org-get-next-sibling ()
24302 "Move to next heading of the same level, and return point.
24303 If there is no such heading, return nil.
24304 This is like outline-next-sibling, but invisible headings are ok."
24305 (let ((level (funcall outline-level)))
24306 (outline-next-heading)
24307 (while (and (not (eobp)) (> (funcall outline-level) level))
24308 (outline-next-heading))
24309 (if (or (eobp) (< (funcall outline-level) level))
24311 (point))))
24313 (defun org-get-last-sibling ()
24314 "Move to previous heading of the same level, and return point.
24315 If there is no such heading, return nil."
24316 (let ((opoint (point))
24317 (level (funcall outline-level)))
24318 (outline-previous-heading)
24319 (when (and (/= (point) opoint) (outline-on-heading-p t))
24320 (while (and (> (funcall outline-level) level)
24321 (not (bobp)))
24322 (outline-previous-heading))
24323 (if (< (funcall outline-level) level)
24325 (point)))))
24327 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24328 "Goto to the end of a subtree."
24329 ;; This contains an exact copy of the original function, but it uses
24330 ;; `org-back-to-heading', to make it work also in invisible
24331 ;; trees. And is uses an invisible-ok argument.
24332 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24333 ;; Furthermore, when used inside Org, finding the end of a large subtree
24334 ;; with many children and grandchildren etc, this can be much faster
24335 ;; than the outline version.
24336 (org-back-to-heading invisible-ok)
24337 (let ((first t)
24338 (level (funcall outline-level)))
24339 (if (and (derived-mode-p 'org-mode) (< level 1000))
24340 ;; A true heading (not a plain list item), in Org-mode
24341 ;; This means we can easily find the end by looking
24342 ;; only for the right number of stars. Using a regexp to do
24343 ;; this is so much faster than using a Lisp loop.
24344 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24345 (forward-char 1)
24346 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24347 ;; something else, do it the slow way
24348 (while (and (not (eobp))
24349 (or first (> (funcall outline-level) level)))
24350 (setq first nil)
24351 (outline-next-heading)))
24352 (unless to-heading
24353 (if (memq (preceding-char) '(?\n ?\^M))
24354 (progn
24355 ;; Go to end of line before heading
24356 (forward-char -1)
24357 (if (memq (preceding-char) '(?\n ?\^M))
24358 ;; leave blank line before heading
24359 (forward-char -1))))))
24360 (point))
24362 (defun org-end-of-meta-data (&optional full)
24363 "Skip planning line and properties drawer in current entry.
24364 When optional argument FULL is non-nil, also skip empty lines,
24365 clocking lines and regular drawers at the beginning of the
24366 entry."
24367 (org-back-to-heading t)
24368 (forward-line)
24369 (when (org-looking-at-p org-planning-line-re) (forward-line))
24370 (when (looking-at org-property-drawer-re)
24371 (goto-char (match-end 0))
24372 (forward-line))
24373 (when (and full (not (org-at-heading-p)))
24374 (catch 'exit
24375 (let ((end (save-excursion (outline-next-heading) (point)))
24376 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24377 (while (not (eobp))
24378 (cond ((org-looking-at-p org-drawer-regexp)
24379 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24380 (forward-line)
24381 (throw 'exit t)))
24382 ((org-looking-at-p re) (forward-line))
24383 (t (throw 'exit t))))))))
24385 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24386 "Move forward to the ARG'th subheading at same level as this one.
24387 Stop at the first and last subheadings of a superior heading.
24388 Normally this only looks at visible headings, but when INVISIBLE-OK is
24389 non-nil it will also look at invisible ones."
24390 (interactive "p")
24391 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24392 (if (and arg (< arg 0))
24393 (goto-char (point-min))
24394 (outline-next-heading))
24395 (org-at-heading-p)
24396 (let ((level (- (match-end 0) (match-beginning 0) 1))
24397 (f (if (and arg (< arg 0))
24398 're-search-backward
24399 're-search-forward))
24400 (count (if arg (abs arg) 1))
24401 (result (point)))
24402 (while (and (prog1 (> count 0)
24403 (forward-char (if (and arg (< arg 0)) -1 1)))
24404 (funcall f org-outline-regexp-bol nil 'move))
24405 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24406 (cond ((< l level) (setq count 0))
24407 ((and (= l level)
24408 (or invisible-ok
24409 (progn
24410 (goto-char (line-beginning-position))
24411 (not (outline-invisible-p)))))
24412 (setq count (1- count))
24413 (when (eq l level)
24414 (setq result (point)))))))
24415 (goto-char result))
24416 (beginning-of-line 1)))
24418 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24419 "Move backward to the ARG'th subheading at same level as this one.
24420 Stop at the first and last subheadings of a superior heading."
24421 (interactive "p")
24422 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24424 (defun org-next-visible-heading (arg)
24425 "Move to the next visible heading.
24427 This function wraps `outline-next-visible-heading' with
24428 `org-with-limited-levels' in order to skip over inline tasks and
24429 respect customization of `org-odd-levels-only'."
24430 (interactive "p")
24431 (org-with-limited-levels
24432 (outline-next-visible-heading arg)))
24434 (defun org-previous-visible-heading (arg)
24435 "Move to the next visible heading.
24437 This function wraps `outline-previous-visible-heading' with
24438 `org-with-limited-levels' in order to skip over inline tasks and
24439 respect customization of `org-odd-levels-only'."
24440 (interactive "p")
24441 (org-with-limited-levels
24442 (outline-previous-visible-heading arg)))
24444 (defun org-next-block (arg &optional backward block-regexp)
24445 "Jump to the next block.
24447 With a prefix argument ARG, jump forward ARG many blocks.
24449 When BACKWARD is non-nil, jump to the previous block.
24451 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24452 Match data is set according to this regexp when the function
24453 returns.
24455 Return point at beginning of the opening line of found block.
24456 Throw an error if no block is found."
24457 (interactive "p")
24458 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24459 (case-fold-search t)
24460 (search-fn (if backward #'re-search-backward #'re-search-forward))
24461 (count (or arg 1))
24462 (origin (point))
24463 last-element)
24464 (if backward (beginning-of-line) (end-of-line))
24465 (while (and (> count 0) (funcall search-fn re nil t))
24466 (let ((element (save-excursion
24467 (goto-char (match-beginning 0))
24468 (save-match-data (org-element-at-point)))))
24469 (when (and (memq (org-element-type element)
24470 '(center-block comment-block dynamic-block
24471 example-block export-block quote-block
24472 special-block src-block verse-block))
24473 (<= (match-beginning 0)
24474 (org-element-property :post-affiliated element)))
24475 (setq last-element element)
24476 (decf count))))
24477 (if (= count 0)
24478 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24479 (save-match-data (org-show-context)))
24480 (goto-char origin)
24481 (user-error "No %s code blocks" (if backward "previous" "further")))))
24483 (defun org-previous-block (arg &optional block-regexp)
24484 "Jump to the previous block.
24485 With a prefix argument ARG, jump backward ARG many source blocks.
24486 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24487 (interactive "p")
24488 (org-next-block arg t block-regexp))
24490 (defun org-forward-paragraph ()
24491 "Move forward to beginning of next paragraph or equivalent.
24493 The function moves point to the beginning of the next visible
24494 structural element, which can be a paragraph, a table, a list
24495 item, etc. It also provides some special moves for convenience:
24497 - On an affiliated keyword, jump to the beginning of the
24498 relative element.
24499 - On an item or a footnote definition, move to the second
24500 element inside, if any.
24501 - On a table or a property drawer, jump after it.
24502 - On a verse or source block, stop after blank lines."
24503 (interactive)
24504 (when (eobp) (user-error "Cannot move further down"))
24505 (let* ((deactivate-mark nil)
24506 (element (org-element-at-point))
24507 (type (org-element-type element))
24508 (post-affiliated (org-element-property :post-affiliated element))
24509 (contents-begin (org-element-property :contents-begin element))
24510 (contents-end (org-element-property :contents-end element))
24511 (end (let ((end (org-element-property :end element)) (parent element))
24512 (while (and (setq parent (org-element-property :parent parent))
24513 (= (org-element-property :contents-end parent) end))
24514 (setq end (org-element-property :end parent)))
24515 end)))
24516 (cond ((not element)
24517 (skip-chars-forward " \r\t\n")
24518 (or (eobp) (beginning-of-line)))
24519 ;; On affiliated keywords, move to element's beginning.
24520 ((< (point) post-affiliated)
24521 (goto-char post-affiliated))
24522 ;; At a table row, move to the end of the table. Similarly,
24523 ;; at a node property, move to the end of the property
24524 ;; drawer.
24525 ((memq type '(node-property table-row))
24526 (goto-char (org-element-property
24527 :end (org-element-property :parent element))))
24528 ((memq type '(property-drawer table)) (goto-char end))
24529 ;; Consider blank lines as separators in verse and source
24530 ;; blocks to ease editing.
24531 ((memq type '(src-block verse-block))
24532 (when (eq type 'src-block)
24533 (setq contents-end
24534 (save-excursion (goto-char end)
24535 (skip-chars-backward " \r\t\n")
24536 (line-beginning-position))))
24537 (beginning-of-line)
24538 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24539 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24540 (goto-char end)
24541 (skip-chars-forward " \r\t\n")
24542 (if (= (point) contents-end) (goto-char end)
24543 (beginning-of-line))))
24544 ;; With no contents, just skip element.
24545 ((not contents-begin) (goto-char end))
24546 ;; If contents are invisible, skip the element altogether.
24547 ((outline-invisible-p (line-end-position))
24548 (case type
24549 (headline
24550 (org-with-limited-levels (outline-next-visible-heading 1)))
24551 ;; At a plain list, make sure we move to the next item
24552 ;; instead of skipping the whole list.
24553 (plain-list (forward-char)
24554 (org-forward-paragraph))
24555 (otherwise (goto-char end))))
24556 ((>= (point) contents-end) (goto-char end))
24557 ((>= (point) contents-begin)
24558 ;; This can only happen on paragraphs and plain lists.
24559 (case type
24560 (paragraph (goto-char end))
24561 ;; At a plain list, try to move to second element in
24562 ;; first item, if possible.
24563 (plain-list (end-of-line)
24564 (org-forward-paragraph))))
24565 ;; When contents start on the middle of a line (e.g. in
24566 ;; items and footnote definitions), try to reach first
24567 ;; element starting after current line.
24568 ((> (line-end-position) contents-begin)
24569 (end-of-line)
24570 (org-forward-paragraph))
24571 (t (goto-char contents-begin)))))
24573 (defun org-backward-paragraph ()
24574 "Move backward to start of previous paragraph or equivalent.
24576 The function moves point to the beginning of the current
24577 structural element, which can be a paragraph, a table, a list
24578 item, etc., or to the beginning of the previous visible one if
24579 point is already there. It also provides some special moves for
24580 convenience:
24582 - On an affiliated keyword, jump to the first one.
24583 - On a table or a property drawer, move to its beginning.
24584 - On a verse or source block, stop before blank lines."
24585 (interactive)
24586 (when (bobp) (user-error "Cannot move further up"))
24587 (let* ((deactivate-mark nil)
24588 (element (org-element-at-point))
24589 (type (org-element-type element))
24590 (contents-begin (org-element-property :contents-begin element))
24591 (contents-end (org-element-property :contents-end element))
24592 (post-affiliated (org-element-property :post-affiliated element))
24593 (begin (org-element-property :begin element)))
24594 (cond
24595 ((not element) (goto-char (point-min)))
24596 ((= (point) begin)
24597 (backward-char)
24598 (org-backward-paragraph))
24599 ((<= (point) post-affiliated) (goto-char begin))
24600 ((memq type '(node-property table-row))
24601 (goto-char (org-element-property
24602 :post-affiliated (org-element-property :parent element))))
24603 ((memq type '(property-drawer table)) (goto-char begin))
24604 ((memq type '(src-block verse-block))
24605 (when (eq type 'src-block)
24606 (setq contents-begin
24607 (save-excursion (goto-char begin) (forward-line) (point))))
24608 (if (= (point) contents-begin) (goto-char post-affiliated)
24609 ;; Inside a verse block, see blank lines as paragraph
24610 ;; separators.
24611 (let ((origin (point)))
24612 (skip-chars-backward " \r\t\n" contents-begin)
24613 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24614 (skip-chars-forward " \r\t\n" origin)
24615 (if (= (point) origin) (goto-char contents-begin)
24616 (beginning-of-line))))))
24617 ((not contents-begin) (goto-char (or post-affiliated begin)))
24618 ((eq type 'paragraph)
24619 (goto-char contents-begin)
24620 ;; When at first paragraph in an item or a footnote definition,
24621 ;; move directly to beginning of line.
24622 (let ((parent-contents
24623 (org-element-property
24624 :contents-begin (org-element-property :parent element))))
24625 (when (and parent-contents (= parent-contents contents-begin))
24626 (beginning-of-line))))
24627 ;; At the end of a greater element, move to the beginning of the
24628 ;; last element within.
24629 ((>= (point) contents-end)
24630 (goto-char (1- contents-end))
24631 (org-backward-paragraph))
24632 (t (goto-char (or post-affiliated begin))))
24633 ;; Ensure we never leave point invisible.
24634 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24636 (defun org-forward-element ()
24637 "Move forward by one element.
24638 Move to the next element at the same level, when possible."
24639 (interactive)
24640 (cond ((eobp) (user-error "Cannot move further down"))
24641 ((org-with-limited-levels (org-at-heading-p))
24642 (let ((origin (point)))
24643 (goto-char (org-end-of-subtree nil t))
24644 (unless (org-with-limited-levels (org-at-heading-p))
24645 (goto-char origin)
24646 (user-error "Cannot move further down"))))
24648 (let* ((elem (org-element-at-point))
24649 (end (org-element-property :end elem))
24650 (parent (org-element-property :parent elem)))
24651 (cond ((and parent (= (org-element-property :contents-end parent) end))
24652 (goto-char (org-element-property :end parent)))
24653 ((integer-or-marker-p end) (goto-char end))
24654 (t (message "No element at point")))))))
24656 (defun org-backward-element ()
24657 "Move backward by one element.
24658 Move to the previous element at the same level, when possible."
24659 (interactive)
24660 (cond ((bobp) (user-error "Cannot move further up"))
24661 ((org-with-limited-levels (org-at-heading-p))
24662 ;; At a headline, move to the previous one, if any, or stay
24663 ;; here.
24664 (let ((origin (point)))
24665 (org-with-limited-levels (org-backward-heading-same-level 1))
24666 ;; When current headline has no sibling above, move to its
24667 ;; parent.
24668 (when (= (point) origin)
24669 (or (org-with-limited-levels (org-up-heading-safe))
24670 (progn (goto-char origin)
24671 (user-error "Cannot move further up"))))))
24673 (let* ((elem (org-element-at-point))
24674 (beg (org-element-property :begin elem)))
24675 (cond
24676 ;; Move to beginning of current element if point isn't
24677 ;; there already.
24678 ((null beg) (message "No element at point"))
24679 ((/= (point) beg) (goto-char beg))
24680 (t (goto-char beg)
24681 (skip-chars-backward " \r\t\n")
24682 (unless (bobp)
24683 (let ((prev (org-element-at-point)))
24684 (goto-char (org-element-property :begin prev))
24685 (while (and (setq prev (org-element-property :parent prev))
24686 (<= (org-element-property :end prev) beg))
24687 (goto-char (org-element-property :begin prev)))))))))))
24689 (defun org-up-element ()
24690 "Move to upper element."
24691 (interactive)
24692 (if (org-with-limited-levels (org-at-heading-p))
24693 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24694 (let* ((elem (org-element-at-point))
24695 (parent (org-element-property :parent elem)))
24696 (if parent (goto-char (org-element-property :begin parent))
24697 (if (org-with-limited-levels (org-before-first-heading-p))
24698 (user-error "No surrounding element")
24699 (org-with-limited-levels (org-back-to-heading)))))))
24701 (defvar org-element-greater-elements)
24702 (defun org-down-element ()
24703 "Move to inner element."
24704 (interactive)
24705 (let ((element (org-element-at-point)))
24706 (cond
24707 ((memq (org-element-type element) '(plain-list table))
24708 (goto-char (org-element-property :contents-begin element))
24709 (forward-char))
24710 ((memq (org-element-type element) org-element-greater-elements)
24711 ;; If contents are hidden, first disclose them.
24712 (when (outline-invisible-p (line-end-position)) (org-cycle))
24713 (goto-char (or (org-element-property :contents-begin element)
24714 (user-error "No content for this element"))))
24715 (t (user-error "No inner element")))))
24717 (defun org-drag-element-backward ()
24718 "Move backward element at point."
24719 (interactive)
24720 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24721 (let* ((elem (org-element-at-point))
24722 (prev-elem
24723 (save-excursion
24724 (goto-char (org-element-property :begin elem))
24725 (skip-chars-backward " \r\t\n")
24726 (unless (bobp)
24727 (let* ((beg (org-element-property :begin elem))
24728 (prev (org-element-at-point))
24729 (up prev))
24730 (while (and (setq up (org-element-property :parent up))
24731 (<= (org-element-property :end up) beg))
24732 (setq prev up))
24733 prev)))))
24734 ;; Error out if no previous element or previous element is
24735 ;; a parent of the current one.
24736 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24737 (user-error "Cannot drag element backward")
24738 (let ((pos (point)))
24739 (org-element-swap-A-B prev-elem elem)
24740 (goto-char (+ (org-element-property :begin prev-elem)
24741 (- pos (org-element-property :begin elem)))))))))
24743 (defun org-drag-element-forward ()
24744 "Move forward element at point."
24745 (interactive)
24746 (let* ((pos (point))
24747 (elem (org-element-at-point)))
24748 (when (= (point-max) (org-element-property :end elem))
24749 (user-error "Cannot drag element forward"))
24750 (goto-char (org-element-property :end elem))
24751 (let ((next-elem (org-element-at-point)))
24752 (when (or (org-element-nested-p elem next-elem)
24753 (and (eq (org-element-type next-elem) 'headline)
24754 (not (eq (org-element-type elem) 'headline))))
24755 (goto-char pos)
24756 (user-error "Cannot drag element forward"))
24757 ;; Compute new position of point: it's shifted by NEXT-ELEM
24758 ;; body's length (without final blanks) and by the length of
24759 ;; blanks between ELEM and NEXT-ELEM.
24760 (let ((size-next (- (save-excursion
24761 (goto-char (org-element-property :end next-elem))
24762 (skip-chars-backward " \r\t\n")
24763 (forward-line)
24764 ;; Small correction if buffer doesn't end
24765 ;; with a newline character.
24766 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24767 (org-element-property :begin next-elem)))
24768 (size-blank (- (org-element-property :end elem)
24769 (save-excursion
24770 (goto-char (org-element-property :end elem))
24771 (skip-chars-backward " \r\t\n")
24772 (forward-line)
24773 (point)))))
24774 (org-element-swap-A-B elem next-elem)
24775 (goto-char (+ pos size-next size-blank))))))
24777 (defun org-drag-line-forward (arg)
24778 "Drag the line at point ARG lines forward."
24779 (interactive "p")
24780 (dotimes (n (abs arg))
24781 (let ((c (current-column)))
24782 (if (< 0 arg)
24783 (progn
24784 (beginning-of-line 2)
24785 (transpose-lines 1)
24786 (beginning-of-line 0))
24787 (transpose-lines 1)
24788 (beginning-of-line -1))
24789 (org-move-to-column c))))
24791 (defun org-drag-line-backward (arg)
24792 "Drag the line at point ARG lines backward."
24793 (interactive "p")
24794 (org-drag-line-forward (- arg)))
24796 (defun org-mark-element ()
24797 "Put point at beginning of this element, mark at end.
24799 Interactively, if this command is repeated or (in Transient Mark
24800 mode) if the mark is active, it marks the next element after the
24801 ones already marked."
24802 (interactive)
24803 (let (deactivate-mark)
24804 (if (and (org-called-interactively-p 'any)
24805 (or (and (eq last-command this-command) (mark t))
24806 (and transient-mark-mode mark-active)))
24807 (set-mark
24808 (save-excursion
24809 (goto-char (mark))
24810 (goto-char (org-element-property :end (org-element-at-point)))))
24811 (let ((element (org-element-at-point)))
24812 (end-of-line)
24813 (push-mark (org-element-property :end element) t t)
24814 (goto-char (org-element-property :begin element))))))
24816 (defun org-narrow-to-element ()
24817 "Narrow buffer to current element."
24818 (interactive)
24819 (let ((elem (org-element-at-point)))
24820 (cond
24821 ((eq (car elem) 'headline)
24822 (narrow-to-region
24823 (org-element-property :begin elem)
24824 (org-element-property :end elem)))
24825 ((memq (car elem) org-element-greater-elements)
24826 (narrow-to-region
24827 (org-element-property :contents-begin elem)
24828 (org-element-property :contents-end elem)))
24830 (narrow-to-region
24831 (org-element-property :begin elem)
24832 (org-element-property :end elem))))))
24834 (defun org-transpose-element ()
24835 "Transpose current and previous elements, keeping blank lines between.
24836 Point is moved after both elements."
24837 (interactive)
24838 (org-skip-whitespace)
24839 (let ((end (org-element-property :end (org-element-at-point))))
24840 (org-drag-element-backward)
24841 (goto-char end)))
24843 (defun org-unindent-buffer ()
24844 "Un-indent the visible part of the buffer.
24845 Relative indentation (between items, inside blocks, etc.) isn't
24846 modified."
24847 (interactive)
24848 (unless (eq major-mode 'org-mode)
24849 (user-error "Cannot un-indent a buffer not in Org mode"))
24850 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24851 unindent-tree ; For byte-compiler.
24852 (unindent-tree
24853 (function
24854 (lambda (contents)
24855 (mapc
24856 (lambda (element)
24857 (if (memq (org-element-type element) '(headline section))
24858 (funcall unindent-tree (org-element-contents element))
24859 (save-excursion
24860 (save-restriction
24861 (narrow-to-region
24862 (org-element-property :begin element)
24863 (org-element-property :end element))
24864 (org-do-remove-indentation)))))
24865 (reverse contents))))))
24866 (funcall unindent-tree (org-element-contents parse-tree))))
24868 (defun org-show-subtree ()
24869 "Show everything after this heading at deeper levels."
24870 (interactive)
24871 (outline-flag-region
24872 (point)
24873 (save-excursion
24874 (org-end-of-subtree t t))
24875 nil))
24877 (defun org-show-entry ()
24878 "Show the body directly following this heading.
24879 Show the heading too, if it is currently invisible."
24880 (interactive)
24881 (save-excursion
24882 (ignore-errors
24883 (org-back-to-heading t)
24884 (outline-flag-region
24885 (max (point-min) (1- (point)))
24886 (save-excursion
24887 (if (re-search-forward
24888 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24889 (match-beginning 1)
24890 (point-max)))
24891 nil)
24892 (org-cycle-hide-drawers 'children))))
24894 (defun org-make-options-regexp (kwds &optional extra)
24895 "Make a regular expression for keyword lines.
24896 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24897 when non-nil, is a regexp matching keywords names."
24898 (concat "^[ \t]*#\\+\\("
24899 (regexp-opt kwds)
24900 (and extra (concat (and kwds "\\|") extra))
24901 "\\):[ \t]*\\(.*\\)"))
24903 ;; Make isearch reveal the necessary context
24904 (defun org-isearch-end ()
24905 "Reveal context after isearch exits."
24906 (when isearch-success ; only if search was successful
24907 (if (featurep 'xemacs)
24908 ;; Under XEmacs, the hook is run in the correct place,
24909 ;; we directly show the context.
24910 (org-show-context 'isearch)
24911 ;; In Emacs the hook runs *before* restoring the overlays.
24912 ;; So we have to use a one-time post-command-hook to do this.
24913 ;; (Emacs 22 has a special variable, see function `org-mode')
24914 (unless (and (boundp 'isearch-mode-end-hook-quit)
24915 isearch-mode-end-hook-quit)
24916 ;; Only when the isearch was not quitted.
24917 (org-add-hook 'post-command-hook 'org-isearch-post-command
24918 'append 'local)))))
24920 (defun org-isearch-post-command ()
24921 "Remove self from hook, and show context."
24922 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24923 (org-show-context 'isearch))
24926 ;;;; Integration with and fixes for other packages
24928 ;;; Imenu support
24930 (defvar org-imenu-markers nil
24931 "All markers currently used by Imenu.")
24932 (make-variable-buffer-local 'org-imenu-markers)
24934 (defun org-imenu-new-marker (&optional pos)
24935 "Return a new marker for use by Imenu, and remember the marker."
24936 (let ((m (make-marker)))
24937 (move-marker m (or pos (point)))
24938 (push m org-imenu-markers)
24941 (defun org-imenu-get-tree ()
24942 "Produce the index for Imenu."
24943 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24944 (setq org-imenu-markers nil)
24945 (let* ((n org-imenu-depth)
24946 (re (concat "^" (org-get-limited-outline-regexp)))
24947 (subs (make-vector (1+ n) nil))
24948 (last-level 0)
24949 m level head0 head)
24950 (save-excursion
24951 (save-restriction
24952 (widen)
24953 (goto-char (point-max))
24954 (while (re-search-backward re nil t)
24955 (setq level (org-reduced-level (funcall outline-level)))
24956 (when (and (<= level n)
24957 (looking-at org-complex-heading-regexp)
24958 (setq head0 (org-match-string-no-properties 4)))
24959 (setq head (org-link-display-format head0)
24960 m (org-imenu-new-marker))
24961 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24962 (if (>= level last-level)
24963 (push (cons head m) (aref subs level))
24964 (push (cons head (aref subs (1+ level))) (aref subs level))
24965 (loop for i from (1+ level) to n do (aset subs i nil)))
24966 (setq last-level level)))))
24967 (aref subs 1)))
24969 (eval-after-load "imenu"
24970 '(progn
24971 (add-hook 'imenu-after-jump-hook
24972 (lambda ()
24973 (if (derived-mode-p 'org-mode)
24974 (org-show-context 'org-goto))))))
24976 (defun org-link-display-format (link)
24977 "Replace a link with its the description.
24978 If there is no description, use the link target."
24979 (save-match-data
24980 (if (string-match org-bracket-link-analytic-regexp link)
24981 (replace-match (if (match-end 5)
24982 (match-string 5 link)
24983 (concat (match-string 1 link)
24984 (match-string 3 link)))
24985 nil t link)
24986 link)))
24988 (defun org-toggle-link-display ()
24989 "Toggle the literal or descriptive display of links."
24990 (interactive)
24991 (if org-descriptive-links
24992 (progn (org-remove-from-invisibility-spec '(org-link))
24993 (org-restart-font-lock)
24994 (setq org-descriptive-links nil))
24995 (progn (add-to-invisibility-spec '(org-link))
24996 (org-restart-font-lock)
24997 (setq org-descriptive-links t))))
24999 ;; Speedbar support
25001 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25002 "Overlay marking the agenda restriction line in speedbar.")
25003 (overlay-put org-speedbar-restriction-lock-overlay
25004 'face 'org-agenda-restriction-lock)
25005 (overlay-put org-speedbar-restriction-lock-overlay
25006 'help-echo "Agendas are currently limited to this item.")
25007 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25009 (defun org-speedbar-set-agenda-restriction ()
25010 "Restrict future agenda commands to the location at point in speedbar.
25011 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25012 (interactive)
25013 (require 'org-agenda)
25014 (let (p m tp np dir txt)
25015 (cond
25016 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25017 'org-imenu t))
25018 (setq m (get-text-property p 'org-imenu-marker))
25019 (with-current-buffer (marker-buffer m)
25020 (goto-char m)
25021 (org-agenda-set-restriction-lock 'subtree)))
25022 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25023 'speedbar-function 'speedbar-find-file))
25024 (setq tp (previous-single-property-change
25025 (1+ p) 'speedbar-function)
25026 np (next-single-property-change
25027 tp 'speedbar-function)
25028 dir (speedbar-line-directory)
25029 txt (buffer-substring-no-properties (or tp (point-min))
25030 (or np (point-max))))
25031 (with-current-buffer (find-file-noselect
25032 (let ((default-directory dir))
25033 (expand-file-name txt)))
25034 (unless (derived-mode-p 'org-mode)
25035 (user-error "Cannot restrict to non-Org-mode file"))
25036 (org-agenda-set-restriction-lock 'file)))
25037 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25038 (move-overlay org-speedbar-restriction-lock-overlay
25039 (point-at-bol) (point-at-eol))
25040 (setq current-prefix-arg nil)
25041 (org-agenda-maybe-redo)))
25043 (defvar speedbar-file-key-map)
25044 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25045 (eval-after-load "speedbar"
25046 '(progn
25047 (speedbar-add-supported-extension ".org")
25048 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25049 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25050 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25051 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25052 (add-hook 'speedbar-visiting-tag-hook
25053 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25055 ;;; Fixes and Hacks for problems with other packages
25057 (defun org--flyspell-object-check-p (element)
25058 "Non-nil when Flyspell can check object at point.
25059 ELEMENT is the element at point."
25060 (let ((object (save-excursion
25061 (when (org-looking-at-p "\\>") (backward-char))
25062 (org-element-context element))))
25063 (case (org-element-type object)
25064 ;; Prevent checks in links due to keybinding conflict with
25065 ;; Flyspell.
25066 ((code entity export-snippet inline-babel-call
25067 inline-src-block line-break latex-fragment link macro
25068 statistics-cookie target timestamp verbatim)
25069 nil)
25070 (footnote-reference
25071 ;; Only in inline footnotes, within the definition.
25072 (and (eq (org-element-property :type object) 'inline)
25073 (< (save-excursion
25074 (goto-char (org-element-property :begin object))
25075 (search-forward ":" nil t 2))
25076 (point))))
25077 (otherwise t))))
25079 (defun org-mode-flyspell-verify ()
25080 "Function used for `flyspell-generic-check-word-predicate'."
25081 (if (org-at-heading-p)
25082 ;; At a headline or an inlinetask, check title only. This is
25083 ;; faster than relying on `org-element-at-point'.
25084 (and (save-excursion (beginning-of-line)
25085 (and (let ((case-fold-search t))
25086 (not (looking-at "\\*+ END[ \t]*$")))
25087 (looking-at org-complex-heading-regexp)))
25088 (match-beginning 4)
25089 (>= (point) (match-beginning 4))
25090 (or (not (match-beginning 5))
25091 (< (point) (match-beginning 5))))
25092 (let* ((element (org-element-at-point))
25093 (post-affiliated (org-element-property :post-affiliated element)))
25094 (cond
25095 ;; Ignore checks in all affiliated keywords but captions.
25096 ((< (point) post-affiliated)
25097 (and (save-excursion
25098 (beginning-of-line)
25099 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25100 (> (point) (match-end 0))
25101 (org--flyspell-object-check-p element)))
25102 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25103 ((let ((log (org-log-into-drawer)))
25104 (and log
25105 (let ((drawer (org-element-lineage element '(drawer))))
25106 (and drawer
25107 (eq (compare-strings
25108 log nil nil
25109 (org-element-property :drawer-name drawer) nil nil t)
25110 t)))))
25111 nil)
25113 (case (org-element-type element)
25114 ((comment quote-section) t)
25115 (comment-block
25116 ;; Allow checks between block markers, not on them.
25117 (and (> (line-beginning-position) post-affiliated)
25118 (save-excursion
25119 (end-of-line)
25120 (skip-chars-forward " \r\t\n")
25121 (< (point) (org-element-property :end element)))))
25122 ;; Arbitrary list of keywords where checks are meaningful.
25123 ;; Make sure point is on the value part of the element.
25124 (keyword
25125 (and (member (org-element-property :key element)
25126 '("DESCRIPTION" "TITLE"))
25127 (save-excursion
25128 (search-backward ":" (line-beginning-position) t))))
25129 ;; Check is globally allowed in paragraphs verse blocks and
25130 ;; table rows (after affiliated keywords) but some objects
25131 ;; must not be affected.
25132 ((paragraph table-row verse-block)
25133 (let ((cbeg (org-element-property :contents-begin element))
25134 (cend (org-element-property :contents-end element)))
25135 (and cbeg (>= (point) cbeg) (< (point) cend)
25136 (org--flyspell-object-check-p element))))))))))
25137 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25139 (defun org-remove-flyspell-overlays-in (beg end)
25140 "Remove flyspell overlays in region."
25141 (and (org-bound-and-true-p flyspell-mode)
25142 (fboundp 'flyspell-delete-region-overlays)
25143 (flyspell-delete-region-overlays beg end)))
25145 (defvar flyspell-delayed-commands)
25146 (eval-after-load "flyspell"
25147 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25149 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25150 (eval-after-load "bookmark"
25151 '(if (boundp 'bookmark-after-jump-hook)
25152 ;; We can use the hook
25153 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25154 ;; Hook not available, use advice
25155 (defadvice bookmark-jump (after org-make-visible activate)
25156 "Make the position visible."
25157 (org-bookmark-jump-unhide))))
25159 ;; Make sure saveplace shows the location if it was hidden
25160 (eval-after-load "saveplace"
25161 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25162 "Make the position visible."
25163 (org-bookmark-jump-unhide)))
25165 ;; Make sure ecb shows the location if it was hidden
25166 (eval-after-load "ecb"
25167 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25168 "Make hierarchy visible when jumping into location from ECB tree buffer."
25169 (if (derived-mode-p 'org-mode)
25170 (org-show-context))))
25172 (defun org-bookmark-jump-unhide ()
25173 "Unhide the current position, to show the bookmark location."
25174 (and (derived-mode-p 'org-mode)
25175 (or (outline-invisible-p)
25176 (save-excursion (goto-char (max (point-min) (1- (point))))
25177 (outline-invisible-p)))
25178 (org-show-context 'bookmark-jump)))
25180 (defun org-mark-jump-unhide ()
25181 "Make the point visible with `org-show-context' after jumping to the mark."
25182 (when (and (derived-mode-p 'org-mode)
25183 (outline-invisible-p))
25184 (org-show-context 'mark-goto)))
25186 (eval-after-load "simple"
25187 '(defadvice pop-to-mark-command (after org-make-visible activate)
25188 "Make the point visible with `org-show-context'."
25189 (org-mark-jump-unhide)))
25191 (eval-after-load "simple"
25192 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25193 "Make the point visible with `org-show-context'."
25194 (org-mark-jump-unhide)))
25196 (eval-after-load "simple"
25197 '(defadvice pop-global-mark (after org-make-visible activate)
25198 "Make the point visible with `org-show-context'."
25199 (org-mark-jump-unhide)))
25201 ;; Make session.el ignore our circular variable
25202 (defvar session-globals-exclude)
25203 (eval-after-load "session"
25204 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25206 ;;;; Finish up
25208 (provide 'org)
25210 (run-hooks 'org-load-hook)
25212 ;;; org.el ends here