Backport commit 284c470 from Emacs master branch
[org-mode.git] / lisp / org.el
blobe3bc12307e10f28f310a601d82dec19b1d316799
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
44 ;; linked webpages.
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
52 ;; Documentation
53 ;; -------------
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
63 ;;; Code:
65 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local)
70 ;;;; Require other packages
72 (eval-when-compile
73 (require 'cl)
74 (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (or (equal this-command 'eval-buffer)
81 (condition-case nil
82 (load (concat (file-name-directory load-file-name)
83 "org-loaddefs.el")
84 nil t t t)
85 (error
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
87 (sit-for 3)
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
89 (sit-for 3))))
91 (require 'org-macs)
92 (require 'org-compat)
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp "\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol "^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (unless (boundp 'calendar-view-holidays-initially-flag)
115 (org-defvaralias 'calendar-view-holidays-initially-flag
116 'view-calendar-holidays-initially))
117 (unless (boundp 'calendar-view-diary-initially-flag)
118 (org-defvaralias 'calendar-view-diary-initially-flag
119 'view-diary-entries-initially))
120 (unless (boundp 'diary-fancy-buffer)
121 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
123 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
124 (declare-function org-add-archive-files "org-archive" (files))
125 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
126 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
127 (declare-function org-agenda-redo "org-agenda" (&optional all))
128 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
129 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
130 (declare-function org-beamer-mode "ox-beamer" ())
131 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
132 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
133 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
134 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
135 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
136 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
137 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
138 (declare-function org-clock-update-time-maybe "org-clock" ())
139 (declare-function org-clocktable-shift "org-clock" (dir n))
140 (declare-function org-element-at-point "org-element" ())
141 (declare-function org-element-cache-refresh "org-element" (pos))
142 (declare-function org-element-cache-reset "org-element" (&optional all))
143 (declare-function org-element-contents "org-element" (element))
144 (declare-function org-element-context "org-element" (&optional element))
145 (declare-function org-element-copy "org-element" (datum))
146 (declare-function org-element-interpret-data "org-element" (data &optional parent))
147 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
148 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
149 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
150 (declare-function org-element-property "org-element" (property element))
151 (declare-function org-element-put-property "org-element" (element property value))
152 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
153 (declare-function org-element-type "org-element" (element))
154 (declare-function org-element-update-syntax "org-element" ())
155 (declare-function org-id-find-id-file "org-id" (id))
156 (declare-function org-id-get-create "org-id" (&optional force))
157 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
158 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
159 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
160 (declare-function org-plot/gnuplot "org-plot" (&optional params))
161 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
162 (declare-function org-table-align "org-table" ())
163 (declare-function org-table-begin "org-table" (&optional table-type))
164 (declare-function org-table-beginning-of-field "org-table" (&optional n))
165 (declare-function org-table-blank-field "org-table" ())
166 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
167 (declare-function org-table-edit-field "org-table" (arg))
168 (declare-function org-table-end "org-table" (&optional table-type))
169 (declare-function org-table-end-of-field "org-table" (&optional n))
170 (declare-function org-table-insert-row "org-table" (&optional arg))
171 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
172 (declare-function org-table-maybe-eval-formula "org-table" ())
173 (declare-function org-table-maybe-recalculate-line "org-table" ())
174 (declare-function org-table-next-row "org-table" ())
175 (declare-function org-table-paste-rectangle "org-table" ())
176 (declare-function org-table-wrap-region "org-table" (arg))
177 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
178 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
179 (declare-function orgtbl-mode "org-table" (&optional arg))
181 (defsubst org-uniquify (list)
182 "Non-destructively remove duplicate elements from LIST."
183 (let ((res (copy-sequence list))) (delete-dups res)))
185 (defsubst org-get-at-bol (property)
186 "Get text property PROPERTY at the beginning of line."
187 (get-text-property (point-at-bol) property))
189 (defsubst org-trim (s)
190 "Remove whitespace at the beginning and the end of string S."
191 (replace-regexp-in-string
192 "\\`[ \t\n\r]+" ""
193 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
195 ;; load languages based on value of `org-babel-load-languages'
196 (defvar org-babel-load-languages)
198 ;;;###autoload
199 (defun org-babel-do-load-languages (sym value)
200 "Load the languages defined in `org-babel-load-languages'."
201 (set-default sym value)
202 (mapc (lambda (pair)
203 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
204 (if active
205 (progn
206 (require (intern (concat "ob-" lang))))
207 (progn
208 (funcall 'fmakunbound
209 (intern (concat "org-babel-execute:" lang)))
210 (funcall 'fmakunbound
211 (intern (concat "org-babel-expand-body:" lang)))))))
212 org-babel-load-languages))
214 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
215 ;;;###autoload
216 (defun org-babel-load-file (file &optional compile)
217 "Load Emacs Lisp source code blocks in the Org-mode FILE.
218 This function exports the source code using `org-babel-tangle'
219 and then loads the resulting file using `load-file'. With prefix
220 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
221 file to byte-code before it is loaded."
222 (interactive "fFile to load: \nP")
223 (let* ((age (lambda (file)
224 (float-time
225 (time-subtract (current-time)
226 (nth 5 (or (file-attributes (file-truename file))
227 (file-attributes file)))))))
228 (base-name (file-name-sans-extension file))
229 (exported-file (concat base-name ".el")))
230 ;; tangle if the org-mode file is newer than the elisp file
231 (unless (and (file-exists-p exported-file)
232 (> (funcall age file) (funcall age exported-file)))
233 ;; Tangle-file traversal returns reversed list of tangled files
234 ;; and we want to evaluate the first target.
235 (setq exported-file
236 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
237 (message "%s %s"
238 (if compile
239 (progn (byte-compile-file exported-file 'load)
240 "Compiled and loaded")
241 (progn (load-file exported-file) "Loaded"))
242 exported-file)))
244 (defcustom org-babel-load-languages '((emacs-lisp . t))
245 "Languages which can be evaluated in Org-mode buffers.
246 This list can be used to load support for any of the languages
247 below, note that each language will depend on a different set of
248 system executables and/or Emacs modes. When a language is
249 \"loaded\", then code blocks in that language can be evaluated
250 with `org-babel-execute-src-block' bound by default to C-c
251 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
252 be set to remove code block evaluation from the C-c C-c
253 keybinding. By default only Emacs Lisp (which has no
254 requirements) is loaded."
255 :group 'org-babel
256 :set 'org-babel-do-load-languages
257 :version "24.1"
258 :type '(alist :tag "Babel Languages"
259 :key-type
260 (choice
261 (const :tag "Awk" awk)
262 (const :tag "C" C)
263 (const :tag "R" R)
264 (const :tag "Asymptote" asymptote)
265 (const :tag "Calc" calc)
266 (const :tag "Clojure" clojure)
267 (const :tag "CSS" css)
268 (const :tag "Ditaa" ditaa)
269 (const :tag "Dot" dot)
270 (const :tag "Emacs Lisp" emacs-lisp)
271 (const :tag "Forth" forth)
272 (const :tag "Fortran" fortran)
273 (const :tag "Gnuplot" gnuplot)
274 (const :tag "Haskell" haskell)
275 (const :tag "IO" io)
276 (const :tag "J" J)
277 (const :tag "Java" java)
278 (const :tag "Javascript" js)
279 (const :tag "LaTeX" latex)
280 (const :tag "Ledger" ledger)
281 (const :tag "Lilypond" lilypond)
282 (const :tag "Lisp" lisp)
283 (const :tag "Makefile" makefile)
284 (const :tag "Maxima" maxima)
285 (const :tag "Matlab" matlab)
286 (const :tag "Mscgen" mscgen)
287 (const :tag "Ocaml" ocaml)
288 (const :tag "Octave" octave)
289 (const :tag "Org" org)
290 (const :tag "Perl" perl)
291 (const :tag "Pico Lisp" picolisp)
292 (const :tag "PlantUML" plantuml)
293 (const :tag "Python" python)
294 (const :tag "Ruby" ruby)
295 (const :tag "Sass" sass)
296 (const :tag "Scala" scala)
297 (const :tag "Scheme" scheme)
298 (const :tag "Screen" screen)
299 (const :tag "Shell Script" shell)
300 (const :tag "Shen" shen)
301 (const :tag "Sql" sql)
302 (const :tag "Sqlite" sqlite)
303 (const :tag "ebnf2ps" ebnf2ps))
304 :value-type (boolean :tag "Activate" :value t)))
306 ;;;; Customization variables
307 (defcustom org-clone-delete-id nil
308 "Remove ID property of clones of a subtree.
309 When non-nil, clones of a subtree don't inherit the ID property.
310 Otherwise they inherit the ID property with a new unique
311 identifier."
312 :type 'boolean
313 :version "24.1"
314 :group 'org-id)
316 ;;; Version
317 (org-check-version)
319 ;;;###autoload
320 (defun org-version (&optional here full message)
321 "Show the org-mode version.
322 Interactively, or when MESSAGE is non-nil, show it in echo area.
323 With prefix argument, or when HERE is non-nil, insert it at point.
324 In non-interactive uses, a reduced version string is output unless
325 FULL is given."
326 (interactive (list current-prefix-arg t (not current-prefix-arg)))
327 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
328 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
329 (load-suffixes (list ".el"))
330 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
331 (org-trash (or
332 (and (fboundp 'org-release) (fboundp 'org-git-version))
333 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
334 (load-suffixes save-load-suffixes)
335 (org-version (org-release))
336 (git-version (org-git-version))
337 (version (format "Org-mode version %s (%s @ %s)"
338 org-version
339 git-version
340 (if org-install-dir
341 (if (string= org-dir org-install-dir)
342 org-install-dir
343 (concat "mixed installation! " org-install-dir " and " org-dir))
344 "org-loaddefs.el can not be found!")))
345 (version1 (if full version org-version)))
346 (when here (insert version1))
347 (when message (message "%s" version1))
348 version1))
350 (defconst org-version (org-version))
353 ;;; Syntax Constants
355 ;;;; Block
357 (defconst org-block-regexp
358 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
359 "Regular expression for hiding blocks.")
361 (defconst org-dblock-start-re
362 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
363 "Matches the start line of a dynamic block, with parameters.")
365 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
366 "Matches the end of a dynamic block.")
368 ;;;; Clock and Planning
370 (defconst org-clock-string "CLOCK:"
371 "String used as prefix for timestamps clocking work hours on an item.")
373 (defvar org-closed-string "CLOSED:"
374 "String used as the prefix for timestamps logging closing a TODO entry.")
376 (defvar org-deadline-string "DEADLINE:"
377 "String to mark deadline entries.
378 A deadline is this string, followed by a time stamp. Should be a word,
379 terminated by a colon. You can insert a schedule keyword and
380 a timestamp with \\[org-deadline].")
382 (defvar org-scheduled-string "SCHEDULED:"
383 "String to mark scheduled TODO entries.
384 A schedule is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-schedule].")
388 (defconst org-ds-keyword-length
389 (+ 2
390 (apply #'max
391 (mapcar #'length
392 (list org-deadline-string org-scheduled-string
393 org-clock-string org-closed-string))))
394 "Maximum length of the DEADLINE and SCHEDULED keywords.")
396 (defconst org-planning-line-re
397 (concat "^[ \t]*"
398 (regexp-opt
399 (list org-closed-string org-deadline-string org-scheduled-string)
401 "Matches a line with planning info.
402 Matched keyword is in group 1.")
404 (defconst org-clock-line-re
405 (concat "^[ \t]*" org-clock-string)
406 "Matches a line with clock info.")
408 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
409 "Matches the DEADLINE keyword.")
411 (defconst org-deadline-time-regexp
412 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
413 "Matches the DEADLINE keyword together with a time stamp.")
415 (defconst org-deadline-time-hour-regexp
416 (concat "\\<" org-deadline-string
417 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
418 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
420 (defconst org-deadline-line-regexp
421 (concat "\\<\\(" org-deadline-string "\\).*")
422 "Matches the DEADLINE keyword and the rest of the line.")
424 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
425 "Matches the SCHEDULED keyword.")
427 (defconst org-scheduled-time-regexp
428 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
429 "Matches the SCHEDULED keyword together with a time stamp.")
431 (defconst org-scheduled-time-hour-regexp
432 (concat "\\<" org-scheduled-string
433 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
434 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
436 (defconst org-closed-time-regexp
437 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
438 "Matches the CLOSED keyword together with a time stamp.")
440 (defconst org-keyword-time-regexp
441 (concat "\\<"
442 (regexp-opt
443 (list org-scheduled-string org-deadline-string org-closed-string
444 org-clock-string)
446 " *[[<]\\([^]>]+\\)[]>]")
447 "Matches any of the 4 keywords, together with the time stamp.")
449 (defconst org-keyword-time-not-clock-regexp
450 (concat
451 "\\<"
452 (regexp-opt
453 (list org-scheduled-string org-deadline-string org-closed-string) t)
454 " *[[<]\\([^]>]+\\)[]>]")
455 "Matches any of the 3 keywords, together with the time stamp.")
457 (defconst org-maybe-keyword-time-regexp
458 (concat "\\(\\<"
459 (regexp-opt
460 (list org-scheduled-string org-deadline-string org-closed-string
461 org-clock-string)
463 "\\)?"
464 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
465 "\\|"
466 "<%%([^\r\n>]*>\\)")
467 "Matches a timestamp, possibly preceded by a keyword.")
469 (defconst org-all-time-keywords
470 (mapcar (lambda (w) (substring w 0 -1))
471 (list org-scheduled-string org-deadline-string
472 org-clock-string org-closed-string))
473 "List of time keywords.")
475 ;;;; Drawer
477 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
478 "Matches first or last line of a hidden block.
479 Group 1 contains drawer's name or \"END\".")
481 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
482 "Regular expression matching the first line of a property drawer.")
484 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
485 "Regular expression matching the last line of a property drawer.")
487 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
488 "Regular expression matching the first line of a clock drawer.")
490 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a clock drawer.")
493 (defconst org-property-drawer-re
494 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
495 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*?"
496 "[ \t]*:END:[ \t]*$")
497 "Matches an entire property drawer.")
499 (defconst org-clock-drawer-re
500 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
501 org-clock-drawer-end-re "\\)\n?")
502 "Matches an entire clock drawer.")
504 ;;;; Headline
506 (defconst org-heading-keyword-regexp-format
507 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
508 "Printf format for a regexp matching a headline with some keyword.
509 This regexp will match the headline of any node which has the
510 exact keyword that is put into the format. The keyword isn't in
511 any group by default, but the stars and the body are.")
513 (defconst org-heading-keyword-maybe-regexp-format
514 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
515 "Printf format for a regexp matching a headline, possibly with some keyword.
516 This regexp can match any headline with the specified keyword, or
517 without a keyword. The keyword isn't in any group by default,
518 but the stars and the body are.")
520 (defconst org-archive-tag "ARCHIVE"
521 "The tag that marks a subtree as archived.
522 An archived subtree does not open during visibility cycling, and does
523 not contribute to the agenda listings.")
525 (defconst org-comment-string "COMMENT"
526 "Entries starting with this keyword will never be exported.
527 An entry can be toggled between COMMENT and normal with
528 \\[org-toggle-comment].")
531 ;;;; LaTeX Environments and Fragments
533 (defconst org-latex-regexps
534 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
535 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
536 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
537 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
538 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
539 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
540 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
541 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
542 "Regular expressions for matching embedded LaTeX.")
544 ;;;; Node Property
546 (defconst org-effort-property "Effort"
547 "The property that is being used to keep track of effort estimates.
548 Effort estimates given in this property need to have the format H:MM.")
550 ;;;; Table
552 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
553 "Detect an org-type or table-type table.")
555 (defconst org-table-line-regexp "^[ \t]*|"
556 "Detect an org-type table line.")
558 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
559 "Detect an org-type table line.")
561 (defconst org-table-hline-regexp "^[ \t]*|-"
562 "Detect an org-type table hline.")
564 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
565 "Detect a table-type table hline.")
567 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
568 "Detect the first line outside a table when searching from within it.
569 This works for both table types.")
571 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
572 "Detect a #+TBLFM line.")
574 ;;;; Timestamp
576 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
577 "Regular expression for fast time stamp matching.")
579 (defconst org-ts-regexp-inactive
580 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
581 "Regular expression for fast inactive time stamp matching.")
583 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
584 "Regular expression for fast time stamp matching.")
586 (defconst org-ts-regexp0
587 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
588 "Regular expression matching time strings for analysis.
589 This one does not require the space after the date, so it can be used
590 on a string that terminates immediately after the date.")
592 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
593 "Regular expression matching time strings for analysis.")
595 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
596 "Regular expression matching time stamps, with groups.")
598 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
599 "Regular expression matching time stamps (also [..]), with groups.")
601 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
602 "Regular expression matching a time stamp range.")
604 (defconst org-tr-regexp-both
605 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
606 "Regular expression matching a time stamp range.")
608 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
609 org-ts-regexp "\\)?")
610 "Regular expression matching a time stamp or time stamp range.")
612 (defconst org-tsr-regexp-both
613 (concat org-ts-regexp-both "\\(--?-?"
614 org-ts-regexp-both "\\)?")
615 "Regular expression matching a time stamp or time stamp range.
616 The time stamps may be either active or inactive.")
618 (defconst org-repeat-re
619 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
620 "Regular expression for specifying repeated events.
621 After a match, group 1 contains the repeat expression.")
623 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
624 "Formats for `format-time-string' which are used for time stamps.")
627 ;;; The custom variables
629 (defgroup org nil
630 "Outline-based notes management and organizer."
631 :tag "Org"
632 :group 'outlines
633 :group 'calendar)
635 (defcustom org-mode-hook nil
636 "Mode hook for Org-mode, run after the mode was turned on."
637 :group 'org
638 :type 'hook)
640 (defcustom org-load-hook nil
641 "Hook that is run after org.el has been loaded."
642 :group 'org
643 :type 'hook)
645 (defcustom org-log-buffer-setup-hook nil
646 "Hook that is run after an Org log buffer is created."
647 :group 'org
648 :version "24.1"
649 :type 'hook)
651 (defvar org-modules) ; defined below
652 (defvar org-modules-loaded nil
653 "Have the modules been loaded already?")
655 (defun org-load-modules-maybe (&optional force)
656 "Load all extensions listed in `org-modules'."
657 (when (or force (not org-modules-loaded))
658 (mapc (lambda (ext)
659 (condition-case nil (require ext)
660 (error (message "Problems while trying to load feature `%s'" ext))))
661 org-modules)
662 (setq org-modules-loaded t)))
664 (defun org-set-modules (var value)
665 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
666 (set var value)
667 (when (featurep 'org)
668 (org-load-modules-maybe 'force)
669 (org-element-cache-reset 'all)))
671 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
672 "Modules that should always be loaded together with org.el.
674 If a description starts with <C>, the file is not part of Emacs
675 and loading it will require that you have downloaded and properly
676 installed the Org mode distribution.
678 You can also use this system to load external packages (i.e. neither Org
679 core modules, nor modules from the CONTRIB directory). Just add symbols
680 to the end of the list. If the package is called org-xyz.el, then you need
681 to add the symbol `xyz', and the package must have a call to:
683 (provide \\='org-xyz)
685 For export specific modules, see also `org-export-backends'."
686 :group 'org
687 :set 'org-set-modules
688 :version "24.4"
689 :package-version '(Org . "8.0")
690 :type
691 '(set :greedy t
692 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
693 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
694 (const :tag " crypt: Encryption of subtrees" org-crypt)
695 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
696 (const :tag " docview: Links to doc-view buffers" org-docview)
697 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
698 (const :tag " habit: Track your consistency with habits" org-habit)
699 (const :tag " id: Global IDs for identifying entries" org-id)
700 (const :tag " info: Links to Info nodes" org-info)
701 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
702 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
703 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
704 (const :tag " mouse: Additional mouse support" org-mouse)
705 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
706 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
707 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
709 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
710 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
711 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
712 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
713 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
714 (const :tag "C collector: Collect properties into tables" org-collector)
715 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
716 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
717 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
718 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
719 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
720 (const :tag "C eval: Include command output as text" org-eval)
721 (const :tag "C eww: Store link to url of eww" org-eww)
722 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
723 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
724 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
725 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
726 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
727 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
728 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
729 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
730 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
731 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
732 (const :tag "C mew: Links to Mew folders/messages" org-mew)
733 (const :tag "C mtags: Support for muse-like tags" org-mtags)
734 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
735 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
736 (const :tag "C registry: A registry for Org-mode links" org-registry)
737 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
738 (const :tag "C secretary: Team management with org-mode" org-secretary)
739 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
740 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
741 (const :tag "C track: Keep up with Org-mode development" org-track)
742 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
743 (const :tag "C vm: Links to VM folders/messages" org-vm)
744 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
745 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
746 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
748 (defvar org-export-registered-backends) ; From ox.el.
749 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
750 (declare-function org-export-backend-name "ox" (backend))
751 (defcustom org-export-backends '(ascii html icalendar latex)
752 "List of export back-ends that should be always available.
754 If a description starts with <C>, the file is not part of Emacs
755 and loading it will require that you have downloaded and properly
756 installed the Org mode distribution.
758 Unlike to `org-modules', libraries in this list will not be
759 loaded along with Org, but only once the export framework is
760 needed.
762 This variable needs to be set before org.el is loaded. If you
763 need to make a change while Emacs is running, use the customize
764 interface or run the following code, where VAL stands for the new
765 value of the variable, after updating it:
767 (progn
768 (setq org-export-registered-backends
769 (org-remove-if-not
770 (lambda (backend)
771 (let ((name (org-export-backend-name backend)))
772 (or (memq name val)
773 (catch \\='parentp
774 (dolist (b val)
775 (and (org-export-derived-backend-p b name)
776 (throw \\='parentp t)))))))
777 org-export-registered-backends))
778 (let ((new-list (mapcar #\\='org-export-backend-name
779 org-export-registered-backends)))
780 (dolist (backend val)
781 (cond
782 ((not (load (format \"ox-%s\" backend) t t))
783 (message \"Problems while trying to load export back-end \\=`%s\\='\"
784 backend))
785 ((not (memq backend new-list)) (push backend new-list))))
786 (set-default \\='org-export-backends new-list)))
788 Adding a back-end to this list will also pull the back-end it
789 depends on, if any."
790 :group 'org
791 :group 'org-export
792 :version "24.4"
793 :package-version '(Org . "8.0")
794 :initialize 'custom-initialize-set
795 :set (lambda (var val)
796 (if (not (featurep 'ox)) (set-default var val)
797 ;; Any back-end not required anymore (not present in VAL and not
798 ;; a parent of any back-end in the new value) is removed from the
799 ;; list of registered back-ends.
800 (setq org-export-registered-backends
801 (org-remove-if-not
802 (lambda (backend)
803 (let ((name (org-export-backend-name backend)))
804 (or (memq name val)
805 (catch 'parentp
806 (dolist (b val)
807 (and (org-export-derived-backend-p b name)
808 (throw 'parentp t)))))))
809 org-export-registered-backends))
810 ;; Now build NEW-LIST of both new back-ends and required
811 ;; parents.
812 (let ((new-list (mapcar #'org-export-backend-name
813 org-export-registered-backends)))
814 (dolist (backend val)
815 (cond
816 ((not (load (format "ox-%s" backend) t t))
817 (message "Problems while trying to load export back-end `%s'"
818 backend))
819 ((not (memq backend new-list)) (push backend new-list))))
820 ;; Set VAR to that list with fixed dependencies.
821 (set-default var new-list))))
822 :type '(set :greedy t
823 (const :tag " ascii Export buffer to ASCII format" ascii)
824 (const :tag " beamer Export buffer to Beamer presentation" beamer)
825 (const :tag " html Export buffer to HTML format" html)
826 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
827 (const :tag " latex Export buffer to LaTeX format" latex)
828 (const :tag " man Export buffer to MAN format" man)
829 (const :tag " md Export buffer to Markdown format" md)
830 (const :tag " odt Export buffer to ODT format" odt)
831 (const :tag " org Export buffer to Org format" org)
832 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
833 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
834 (const :tag "C deck Export buffer to deck.js presentations" deck)
835 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
836 (const :tag "C groff Export buffer to Groff format" groff)
837 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
838 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
839 (const :tag "C s5 Export buffer to s5 presentations" s5)
840 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
842 (eval-after-load 'ox
843 '(mapc
844 (lambda (backend)
845 (condition-case nil (require (intern (format "ox-%s" backend)))
846 (error (message "Problems while trying to load export back-end `%s'"
847 backend))))
848 org-export-backends))
850 (defcustom org-support-shift-select nil
851 "Non-nil means make shift-cursor commands select text when possible.
852 \\<org-mode-map>\
854 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
855 start selecting a region, or enlarge regions started in this way.
856 In Org-mode, in special contexts, these same keys are used for
857 other purposes, important enough to compete with shift selection.
858 Org tries to balance these needs by supporting `shift-select-mode'
859 outside these special contexts, under control of this variable.
861 The default of this variable is nil, to avoid confusing behavior. Shifted
862 cursor keys will then execute Org commands in the following contexts:
863 - on a headline, changing TODO state (left/right) and priority (up/down)
864 - on a time stamp, changing the time
865 - in a plain list item, changing the bullet type
866 - in a property definition line, switching between allowed values
867 - in the BEGIN line of a clock table (changing the time block).
868 Outside these contexts, the commands will throw an error.
870 When this variable is t and the cursor is not in a special
871 context, Org-mode will support shift-selection for making and
872 enlarging regions. To make this more effective, the bullet
873 cycling will no longer happen anywhere in an item line, but only
874 if the cursor is exactly on the bullet.
876 If you set this variable to the symbol `always', then the keys
877 will not be special in headlines, property lines, and item lines,
878 to make shift selection work there as well. If this is what you
879 want, you can use the following alternative commands:
880 `\\[org-todo]' and `\\[org-priority]' \
881 to change TODO state and priority,
882 `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
883 can be used to switch TODO sets,
884 `\\[org-ctrl-c-minus]' to cycle item bullet types,
885 and properties can be edited by hand or in column view.
887 However, when the cursor is on a timestamp, shift-cursor commands
888 will still edit the time stamp - this is just too good to give up.
890 XEmacs user should have this variable set to nil, because
891 `shift-select-mode' is in Emacs 23 or later only."
892 :group 'org
893 :type '(choice
894 (const :tag "Never" nil)
895 (const :tag "When outside special context" t)
896 (const :tag "Everywhere except timestamps" always)))
898 (defcustom org-loop-over-headlines-in-active-region nil
899 "Shall some commands act upon headlines in the active region?
901 When set to t, some commands will be performed in all headlines
902 within the active region.
904 When set to `start-level', some commands will be performed in all
905 headlines within the active region, provided that these headlines
906 are of the same level than the first one.
908 When set to a string, those commands will be performed on the
909 matching headlines within the active region. Such string must be
910 a tags/property/todo match as it is used in the agenda tags view.
912 The list of commands is: `org-schedule', `org-deadline',
913 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
914 `org-archive-to-archive-sibling'. The archiving commands skip
915 already archived entries."
916 :type '(choice (const :tag "Don't loop" nil)
917 (const :tag "All headlines in active region" t)
918 (const :tag "In active region, headlines at the same level than the first one" start-level)
919 (string :tag "Tags/Property/Todo matcher"))
920 :version "24.1"
921 :group 'org-todo
922 :group 'org-archive)
924 (defgroup org-startup nil
925 "Options concerning startup of Org-mode."
926 :tag "Org Startup"
927 :group 'org)
929 (defcustom org-startup-folded t
930 "Non-nil means entering Org-mode will switch to OVERVIEW.
931 This can also be configured on a per-file basis by adding one of
932 the following lines anywhere in the buffer:
934 #+STARTUP: fold (or `overview', this is equivalent)
935 #+STARTUP: nofold (or `showall', this is equivalent)
936 #+STARTUP: content
937 #+STARTUP: showeverything
939 By default, this option is ignored when Org opens agenda files
940 for the first time. If you want the agenda to honor the startup
941 option, set `org-agenda-inhibit-startup' to nil."
942 :group 'org-startup
943 :type '(choice
944 (const :tag "nofold: show all" nil)
945 (const :tag "fold: overview" t)
946 (const :tag "content: all headlines" content)
947 (const :tag "show everything, even drawers" showeverything)))
949 (defcustom org-startup-truncated t
950 "Non-nil means entering Org-mode will set `truncate-lines'.
951 This is useful since some lines containing links can be very long and
952 uninteresting. Also tables look terrible when wrapped."
953 :group 'org-startup
954 :type 'boolean)
956 (defcustom org-startup-indented nil
957 "Non-nil means turn on `org-indent-mode' on startup.
958 This can also be configured on a per-file basis by adding one of
959 the following lines anywhere in the buffer:
961 #+STARTUP: indent
962 #+STARTUP: noindent"
963 :group 'org-structure
964 :type '(choice
965 (const :tag "Not" nil)
966 (const :tag "Globally (slow on startup in large files)" t)))
968 (defcustom org-use-sub-superscripts t
969 "Non-nil means interpret \"_\" and \"^\" for display.
971 If you want to control how Org exports those characters, see
972 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
973 used to be an alias for `org-export-with-sub-superscripts' in
974 Org <8.0, it is not anymore.
976 When this option is turned on, you can use TeX-like syntax for
977 sub- and superscripts within the buffer. Several characters after
978 \"_\" or \"^\" will be considered as a single item - so grouping
979 with {} is normally not needed. For example, the following things
980 will be parsed as single sub- or superscripts:
982 10^24 or 10^tau several digits will be considered 1 item.
983 10^-12 or 10^-tau a leading sign with digits or a word
984 x^2-y^3 will be read as x^2 - y^3, because items are
985 terminated by almost any nonword/nondigit char.
986 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
988 Still, ambiguity is possible. So when in doubt, use {} to enclose
989 the sub/superscript. If you set this variable to the symbol `{}',
990 the braces are *required* in order to trigger interpretations as
991 sub/superscript. This can be helpful in documents that need \"_\"
992 frequently in plain text."
993 :group 'org-startup
994 :version "24.4"
995 :package-version '(Org . "8.0")
996 :type '(choice
997 (const :tag "Always interpret" t)
998 (const :tag "Only with braces" {})
999 (const :tag "Never interpret" nil)))
1001 (defcustom org-startup-with-beamer-mode nil
1002 "Non-nil means turn on `org-beamer-mode' on startup.
1003 This can also be configured on a per-file basis by adding one of
1004 the following lines anywhere in the buffer:
1006 #+STARTUP: beamer"
1007 :group 'org-startup
1008 :version "24.1"
1009 :type 'boolean)
1011 (defcustom org-startup-align-all-tables nil
1012 "Non-nil means align all tables when visiting a file.
1013 This is useful when the column width in tables is forced with <N> cookies
1014 in table fields. Such tables will look correct only after the first re-align.
1015 This can also be configured on a per-file basis by adding one of
1016 the following lines anywhere in the buffer:
1017 #+STARTUP: align
1018 #+STARTUP: noalign"
1019 :group 'org-startup
1020 :type 'boolean)
1022 (defcustom org-startup-with-inline-images nil
1023 "Non-nil means show inline images when loading a new Org file.
1024 This can also be configured on a per-file basis by adding one of
1025 the following lines anywhere in the buffer:
1026 #+STARTUP: inlineimages
1027 #+STARTUP: noinlineimages"
1028 :group 'org-startup
1029 :version "24.1"
1030 :type 'boolean)
1032 (defcustom org-startup-with-latex-preview nil
1033 "Non-nil means preview LaTeX fragments when loading a new Org file.
1035 This can also be configured on a per-file basis by adding one of
1036 the following lines anywhere in the buffer:
1037 #+STARTUP: latexpreview
1038 #+STARTUP: nolatexpreview"
1039 :group 'org-startup
1040 :version "24.4"
1041 :package-version '(Org . "8.0")
1042 :type 'boolean)
1044 (defcustom org-insert-mode-line-in-empty-file nil
1045 "Non-nil means insert the first line setting Org-mode in empty files.
1046 When the function `org-mode' is called interactively in an empty file, this
1047 normally means that the file name does not automatically trigger Org-mode.
1048 To ensure that the file will always be in Org-mode in the future, a
1049 line enforcing Org-mode will be inserted into the buffer, if this option
1050 has been set."
1051 :group 'org-startup
1052 :type 'boolean)
1054 (defcustom org-replace-disputed-keys nil
1055 "Non-nil means use alternative key bindings for some keys.
1056 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1057 These keys are also used by other packages like shift-selection-mode'
1058 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1059 If you want to use Org-mode together with one of these other modes,
1060 or more generally if you would like to move some Org-mode commands to
1061 other keys, set this variable and configure the keys with the variable
1062 `org-disputed-keys'.
1064 This option is only relevant at load-time of Org-mode, and must be set
1065 *before* org.el is loaded. Changing it requires a restart of Emacs to
1066 become effective."
1067 :group 'org-startup
1068 :type 'boolean)
1070 (defcustom org-use-extra-keys nil
1071 "Non-nil means use extra key sequence definitions for certain commands.
1072 This happens automatically if you run XEmacs or if `window-system'
1073 is nil. This variable lets you do the same manually. You must
1074 set it before loading org.
1076 Example: on Carbon Emacs 22 running graphically, with an external
1077 keyboard on a Powerbook, the default way of setting M-left might
1078 not work for either Alt or ESC. Setting this variable will make
1079 it work for ESC."
1080 :group 'org-startup
1081 :type 'boolean)
1083 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1085 (defcustom org-disputed-keys
1086 '(([(shift up)] . [(meta p)])
1087 ([(shift down)] . [(meta n)])
1088 ([(shift left)] . [(meta -)])
1089 ([(shift right)] . [(meta +)])
1090 ([(control shift right)] . [(meta shift +)])
1091 ([(control shift left)] . [(meta shift -)]))
1092 "Keys for which Org-mode and other modes compete.
1093 This is an alist, cars are the default keys, second element specifies
1094 the alternative to use when `org-replace-disputed-keys' is t.
1096 Keys can be specified in any syntax supported by `define-key'.
1097 The value of this option takes effect only at Org-mode's startup,
1098 therefore you'll have to restart Emacs to apply it after changing."
1099 :group 'org-startup
1100 :type 'alist)
1102 (defun org-key (key)
1103 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1104 Or return the original if not disputed.
1105 Also apply the translations defined in `org-xemacs-key-equivalents'."
1106 (when org-replace-disputed-keys
1107 (let* ((nkey (key-description key))
1108 (x (org-find-if (lambda (x)
1109 (equal (key-description (car x)) nkey))
1110 org-disputed-keys)))
1111 (setq key (if x (cdr x) key))))
1112 (when (featurep 'xemacs)
1113 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1114 key)
1116 (defun org-find-if (predicate seq)
1117 (catch 'exit
1118 (while seq
1119 (if (funcall predicate (car seq))
1120 (throw 'exit (car seq))
1121 (pop seq)))))
1123 (defun org-defkey (keymap key def)
1124 "Define a key, possibly translated, as returned by `org-key'."
1125 (define-key keymap (org-key key) def))
1127 (defcustom org-ellipsis nil
1128 "The ellipsis to use in the Org-mode outline.
1129 When nil, just use the standard three dots.
1130 When a string, use that string instead.
1131 When a face, use the standard 3 dots, but with the specified face.
1132 The change affects only Org-mode (which will then use its own display table).
1133 Changing this requires executing \\[org-mode] in a buffer to become
1134 effective."
1135 :group 'org-startup
1136 :type '(choice (const :tag "Default" nil)
1137 (face :tag "Face" :value org-warning)
1138 (string :tag "String" :value "...#")))
1140 (defvar org-display-table nil
1141 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1143 (defgroup org-keywords nil
1144 "Keywords in Org-mode."
1145 :tag "Org Keywords"
1146 :group 'org)
1148 (defcustom org-closed-keep-when-no-todo nil
1149 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1150 :group 'org-todo
1151 :group 'org-keywords
1152 :version "24.4"
1153 :package-version '(Org . "8.0")
1154 :type 'boolean)
1156 (defgroup org-structure nil
1157 "Options concerning the general structure of Org-mode files."
1158 :tag "Org Structure"
1159 :group 'org)
1161 (defgroup org-reveal-location nil
1162 "Options about how to make context of a location visible."
1163 :tag "Org Reveal Location"
1164 :group 'org-structure)
1166 (defcustom org-show-context-detail '((isearch . lineage)
1167 (bookmark-jump . lineage)
1168 (default . ancestors))
1169 "Alist between context and visibility span when revealing a location.
1171 \\<org-mode-map>Some actions may move point into invisible
1172 locations. As a consequence, Org always expose a neighborhood
1173 around point. How much is shown depends on the initial action,
1174 or context. Valid contexts are
1176 agenda when exposing an entry from the agenda
1177 org-goto when using the command `org-goto' (\\[org-goto])
1178 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1179 tags-tree when constructing a sparse tree based on tags matches
1180 link-search when exposing search matches associated with a link
1181 mark-goto when exposing the jump goal of a mark
1182 bookmark-jump when exposing a bookmark location
1183 isearch when exiting from an incremental search
1184 default default for all contexts not set explicitly
1186 Allowed visibility spans are
1188 minimal show current headline; if point is not on headline,
1189 also show entry
1191 local show current headline, entry and next headline
1193 ancestors show current headline and its direct ancestors; if
1194 point is not on headline, also show entry
1196 lineage show current headline, its direct ancestors and all
1197 their children; if point is not on headline, also show
1198 entry and first child
1200 tree show current headline, its direct ancestors and all
1201 their children; if point is not on headline, also show
1202 entry and all children
1204 canonical show current headline, its direct ancestors along with
1205 their entries and children; if point is not located on
1206 the headline, also show current entry and all children
1208 As special cases, a nil or t value means show all contexts in
1209 `minimal' or `canonical' view, respectively.
1211 Some views can make displayed information very compact, but also
1212 make it harder to edit the location of the match. In such
1213 a case, use the command `org-reveal' (\\[org-reveal]) to show
1214 more context."
1215 :group 'org-reveal-location
1216 :version "25.1"
1217 :package-version '(Org . "8.3")
1218 :type '(choice
1219 (const :tag "Canonical" t)
1220 (const :tag "Minimal" nil)
1221 (repeat :greedy t :tag "Individual contexts"
1222 (cons
1223 (choice :tag "Context"
1224 (const agenda)
1225 (const org-goto)
1226 (const occur-tree)
1227 (const tags-tree)
1228 (const link-search)
1229 (const mark-goto)
1230 (const bookmark-jump)
1231 (const isearch)
1232 (const default))
1233 (choice :tag "Detail level"
1234 (const minimal)
1235 (const local)
1236 (const ancestors)
1237 (const lineage)
1238 (const tree)
1239 (const canonical))))))
1241 (defcustom org-indirect-buffer-display 'other-window
1242 "How should indirect tree buffers be displayed?
1243 This applies to indirect buffers created with the commands
1244 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1245 Valid values are:
1246 current-window Display in the current window
1247 other-window Just display in another window.
1248 dedicated-frame Create one new frame, and re-use it each time.
1249 new-frame Make a new frame each time. Note that in this case
1250 previously-made indirect buffers are kept, and you need to
1251 kill these buffers yourself."
1252 :group 'org-structure
1253 :group 'org-agenda-windows
1254 :type '(choice
1255 (const :tag "In current window" current-window)
1256 (const :tag "In current frame, other window" other-window)
1257 (const :tag "Each time a new frame" new-frame)
1258 (const :tag "One dedicated frame" dedicated-frame)))
1260 (defcustom org-use-speed-commands nil
1261 "Non-nil means activate single letter commands at beginning of a headline.
1262 This may also be a function to test for appropriate locations where speed
1263 commands should be active.
1265 For example, to activate speed commands when the point is on any
1266 star at the beginning of the headline, you can do this:
1268 (setq org-use-speed-commands
1269 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1270 :group 'org-structure
1271 :type '(choice
1272 (const :tag "Never" nil)
1273 (const :tag "At beginning of headline stars" t)
1274 (function)))
1276 (defcustom org-speed-commands-user nil
1277 "Alist of additional speed commands.
1278 This list will be checked before `org-speed-commands-default'
1279 when the variable `org-use-speed-commands' is non-nil
1280 and when the cursor is at the beginning of a headline.
1281 The car if each entry is a string with a single letter, which must
1282 be assigned to `self-insert-command' in the global map.
1283 The cdr is either a command to be called interactively, a function
1284 to be called, or a form to be evaluated.
1285 An entry that is just a list with a single string will be interpreted
1286 as a descriptive headline that will be added when listing the speed
1287 commands in the Help buffer using the `?' speed command."
1288 :group 'org-structure
1289 :type '(repeat :value ("k" . ignore)
1290 (choice :value ("k" . ignore)
1291 (list :tag "Descriptive Headline" (string :tag "Headline"))
1292 (cons :tag "Letter and Command"
1293 (string :tag "Command letter")
1294 (choice
1295 (function)
1296 (sexp))))))
1298 (defcustom org-bookmark-names-plist
1299 '(:last-capture "org-capture-last-stored"
1300 :last-refile "org-refile-last-stored"
1301 :last-capture-marker "org-capture-last-stored-marker")
1302 "Names for bookmarks automatically set by some Org commands.
1303 This can provide strings as names for a number of bookmarks Org sets
1304 automatically. The following keys are currently implemented:
1305 :last-capture
1306 :last-capture-marker
1307 :last-refile
1308 When a key does not show up in the property list, the corresponding bookmark
1309 is not set."
1310 :group 'org-structure
1311 :type 'plist)
1313 (defgroup org-cycle nil
1314 "Options concerning visibility cycling in Org-mode."
1315 :tag "Org Cycle"
1316 :group 'org-structure)
1318 (defcustom org-cycle-skip-children-state-if-no-children t
1319 "Non-nil means skip CHILDREN state in entries that don't have any."
1320 :group 'org-cycle
1321 :type 'boolean)
1323 (defcustom org-cycle-max-level nil
1324 "Maximum level which should still be subject to visibility cycling.
1325 Levels higher than this will, for cycling, be treated as text, not a headline.
1326 When `org-odd-levels-only' is set, a value of N in this variable actually
1327 means 2N-1 stars as the limiting headline.
1328 When nil, cycle all levels.
1329 Note that the limiting level of cycling is also influenced by
1330 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1331 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1332 than its value."
1333 :group 'org-cycle
1334 :type '(choice
1335 (const :tag "No limit" nil)
1336 (integer :tag "Maximum level")))
1338 (defcustom org-hide-block-startup nil
1339 "Non-nil means entering Org-mode will fold all blocks.
1340 This can also be set in on a per-file basis with
1342 #+STARTUP: hideblocks
1343 #+STARTUP: showblocks"
1344 :group 'org-startup
1345 :group 'org-cycle
1346 :type 'boolean)
1348 (defcustom org-cycle-global-at-bob nil
1349 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1350 This makes it possible to do global cycling without having to use S-TAB or
1351 \\[universal-argument] TAB. For this special case to work, the first line
1352 of the buffer must not be a headline -- it may be empty or some other text.
1353 When used in this way, `org-cycle-hook' is disabled temporarily to make
1354 sure the cursor stays at the beginning of the buffer. When this option is
1355 nil, don't do anything special at the beginning of the buffer."
1356 :group 'org-cycle
1357 :type 'boolean)
1359 (defcustom org-cycle-level-after-item/entry-creation t
1360 "Non-nil means cycle entry level or item indentation in new empty entries.
1362 When the cursor is at the end of an empty headline, i.e., with only stars
1363 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1364 and then all possible ancestor states, before returning to the original state.
1365 This makes data entry extremely fast: M-RET to create a new headline,
1366 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1368 When the cursor is at the end of an empty plain list item, one TAB will
1369 make it a subitem, two or more tabs will back up to make this an item
1370 higher up in the item hierarchy."
1371 :group 'org-cycle
1372 :type 'boolean)
1374 (defcustom org-cycle-emulate-tab t
1375 "Where should `org-cycle' emulate TAB.
1376 nil Never
1377 white Only in completely white lines
1378 whitestart Only at the beginning of lines, before the first non-white char
1379 t Everywhere except in headlines
1380 exc-hl-bol Everywhere except at the start of a headline
1381 If TAB is used in a place where it does not emulate TAB, the current subtree
1382 visibility is cycled."
1383 :group 'org-cycle
1384 :type '(choice (const :tag "Never" nil)
1385 (const :tag "Only in completely white lines" white)
1386 (const :tag "Before first char in a line" whitestart)
1387 (const :tag "Everywhere except in headlines" t)
1388 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1390 (defcustom org-cycle-separator-lines 2
1391 "Number of empty lines needed to keep an empty line between collapsed trees.
1392 If you leave an empty line between the end of a subtree and the following
1393 headline, this empty line is hidden when the subtree is folded.
1394 Org-mode will leave (exactly) one empty line visible if the number of
1395 empty lines is equal or larger to the number given in this variable.
1396 So the default 2 means at least 2 empty lines after the end of a subtree
1397 are needed to produce free space between a collapsed subtree and the
1398 following headline.
1400 If the number is negative, and the number of empty lines is at least -N,
1401 all empty lines are shown.
1403 Special case: when 0, never leave empty lines in collapsed view."
1404 :group 'org-cycle
1405 :type 'integer)
1406 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1408 (defcustom org-pre-cycle-hook nil
1409 "Hook that is run before visibility cycling is happening.
1410 The function(s) in this hook must accept a single argument which indicates
1411 the new state that will be set right after running this hook. The
1412 argument is a symbol. Before a global state change, it can have the values
1413 `overview', `content', or `all'. Before a local state change, it can have
1414 the values `folded', `children', or `subtree'."
1415 :group 'org-cycle
1416 :type 'hook)
1418 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1419 org-cycle-hide-drawers
1420 org-cycle-show-empty-lines
1421 org-optimize-window-after-visibility-change)
1422 "Hook that is run after `org-cycle' has changed the buffer visibility.
1423 The function(s) in this hook must accept a single argument which indicates
1424 the new state that was set by the most recent `org-cycle' command. The
1425 argument is a symbol. After a global state change, it can have the values
1426 `overview', `contents', or `all'. After a local state change, it can have
1427 the values `folded', `children', or `subtree'."
1428 :group 'org-cycle
1429 :type 'hook
1430 :version "25.1"
1431 :package-version '(Org . "8.3"))
1433 (defgroup org-edit-structure nil
1434 "Options concerning structure editing in Org-mode."
1435 :tag "Org Edit Structure"
1436 :group 'org-structure)
1438 (defcustom org-odd-levels-only nil
1439 "Non-nil means skip even levels and only use odd levels for the outline.
1440 This has the effect that two stars are being added/taken away in
1441 promotion/demotion commands. It also influences how levels are
1442 handled by the exporters.
1443 Changing it requires restart of `font-lock-mode' to become effective
1444 for fontification also in regions already fontified.
1445 You may also set this on a per-file basis by adding one of the following
1446 lines to the buffer:
1448 #+STARTUP: odd
1449 #+STARTUP: oddeven"
1450 :group 'org-edit-structure
1451 :group 'org-appearance
1452 :type 'boolean)
1454 (defcustom org-adapt-indentation t
1455 "Non-nil means adapt indentation to outline node level.
1457 When this variable is set, Org assumes that you write outlines by
1458 indenting text in each node to align with the headline (after the
1459 stars). The following issues are influenced by this variable:
1461 - The indentation is increased by one space in a demotion
1462 command, and decreased by one in a promotion command. However,
1463 in the latter case, if shifting some line in the entry body
1464 would alter document structure (e.g., insert a new headline),
1465 indentation is not changed at all.
1467 - Property drawers and planning information is inserted indented
1468 when this variable is set. When nil, they will not be indented.
1470 - TAB indents a line relative to current level. The lines below
1471 a headline will be indented when this variable is set.
1473 Note that this is all about true indentation, by adding and
1474 removing space characters. See also `org-indent.el' which does
1475 level-dependent indentation in a virtual way, i.e. at display
1476 time in Emacs."
1477 :group 'org-edit-structure
1478 :type 'boolean)
1480 (defcustom org-special-ctrl-a/e nil
1481 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1483 When t, `C-a' will bring back the cursor to the beginning of the
1484 headline text, i.e. after the stars and after a possible TODO
1485 keyword. In an item, this will be the position after bullet and
1486 check-box, if any. When the cursor is already at that position,
1487 another `C-a' will bring it to the beginning of the line.
1489 `C-e' will jump to the end of the headline, ignoring the presence
1490 of tags in the headline. A second `C-e' will then jump to the
1491 true end of the line, after any tags. This also means that, when
1492 this variable is non-nil, `C-e' also will never jump beyond the
1493 end of the heading of a folded section, i.e. not after the
1494 ellipses.
1496 When set to the symbol `reversed', the first `C-a' or `C-e' works
1497 normally, going to the true line boundary first. Only a directly
1498 following, identical keypress will bring the cursor to the
1499 special positions.
1501 This may also be a cons cell where the behavior for `C-a' and
1502 `C-e' is set separately."
1503 :group 'org-edit-structure
1504 :type '(choice
1505 (const :tag "off" nil)
1506 (const :tag "on: after stars/bullet and before tags first" t)
1507 (const :tag "reversed: true line boundary first" reversed)
1508 (cons :tag "Set C-a and C-e separately"
1509 (choice :tag "Special C-a"
1510 (const :tag "off" nil)
1511 (const :tag "on: after stars/bullet first" t)
1512 (const :tag "reversed: before stars/bullet first" reversed))
1513 (choice :tag "Special C-e"
1514 (const :tag "off" nil)
1515 (const :tag "on: before tags first" t)
1516 (const :tag "reversed: after tags first" reversed)))))
1517 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1519 (defcustom org-special-ctrl-k nil
1520 "Non-nil means `C-k' will behave specially in headlines.
1521 When nil, `C-k' will call the default `kill-line' command.
1522 When t, the following will happen while the cursor is in the headline:
1524 - When the cursor is at the beginning of a headline, kill the entire
1525 line and possible the folded subtree below the line.
1526 - When in the middle of the headline text, kill the headline up to the tags.
1527 - When after the headline text, kill the tags."
1528 :group 'org-edit-structure
1529 :type 'boolean)
1531 (defcustom org-ctrl-k-protect-subtree nil
1532 "Non-nil means, do not delete a hidden subtree with C-k.
1533 When set to the symbol `error', simply throw an error when C-k is
1534 used to kill (part-of) a headline that has hidden text behind it.
1535 Any other non-nil value will result in a query to the user, if it is
1536 OK to kill that hidden subtree. When nil, kill without remorse."
1537 :group 'org-edit-structure
1538 :version "24.1"
1539 :type '(choice
1540 (const :tag "Do not protect hidden subtrees" nil)
1541 (const :tag "Protect hidden subtrees with a security query" t)
1542 (const :tag "Never kill a hidden subtree with C-k" error)))
1544 (defcustom org-special-ctrl-o t
1545 "Non-nil means, make `C-o' insert a row in tables."
1546 :group 'org-edit-structure
1547 :type 'boolean)
1549 (defcustom org-catch-invisible-edits nil
1550 "Check if in invisible region before inserting or deleting a character.
1551 Valid values are:
1553 nil Do not check, so just do invisible edits.
1554 error Throw an error and do nothing.
1555 show Make point visible, and do the requested edit.
1556 show-and-error Make point visible, then throw an error and abort the edit.
1557 smart Make point visible, and do insertion/deletion if it is
1558 adjacent to visible text and the change feels predictable.
1559 Never delete a previously invisible character or add in the
1560 middle or right after an invisible region. Basically, this
1561 allows insertion and backward-delete right before ellipses.
1562 FIXME: maybe in this case we should not even show?"
1563 :group 'org-edit-structure
1564 :version "24.1"
1565 :type '(choice
1566 (const :tag "Do not check" nil)
1567 (const :tag "Throw error when trying to edit" error)
1568 (const :tag "Unhide, but do not do the edit" show-and-error)
1569 (const :tag "Show invisible part and do the edit" show)
1570 (const :tag "Be smart and do the right thing" smart)))
1572 (defcustom org-yank-folded-subtrees t
1573 "Non-nil means when yanking subtrees, fold them.
1574 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1575 it starts with a heading and all other headings in it are either children
1576 or siblings, then fold all the subtrees. However, do this only if no
1577 text after the yank would be swallowed into a folded tree by this action."
1578 :group 'org-edit-structure
1579 :type 'boolean)
1581 (defcustom org-yank-adjusted-subtrees nil
1582 "Non-nil means when yanking subtrees, adjust the level.
1583 With this setting, `org-paste-subtree' is used to insert the subtree, see
1584 this function for details."
1585 :group 'org-edit-structure
1586 :type 'boolean)
1588 (defcustom org-M-RET-may-split-line '((default . t))
1589 "Non-nil means M-RET will split the line at the cursor position.
1590 When nil, it will go to the end of the line before making a
1591 new line.
1592 You may also set this option in a different way for different
1593 contexts. Valid contexts are:
1595 headline when creating a new headline
1596 item when creating a new item
1597 table in a table field
1598 default the value to be used for all contexts not explicitly
1599 customized"
1600 :group 'org-structure
1601 :group 'org-table
1602 :type '(choice
1603 (const :tag "Always" t)
1604 (const :tag "Never" nil)
1605 (repeat :greedy t :tag "Individual contexts"
1606 (cons
1607 (choice :tag "Context"
1608 (const headline)
1609 (const item)
1610 (const table)
1611 (const default))
1612 (boolean)))))
1615 (defcustom org-insert-heading-respect-content nil
1616 "Non-nil means insert new headings after the current subtree.
1617 When nil, the new heading is created directly after the current line.
1618 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1619 this variable on for the duration of the command."
1620 :group 'org-structure
1621 :type 'boolean)
1623 (defcustom org-blank-before-new-entry '((heading . auto)
1624 (plain-list-item . auto))
1625 "Should `org-insert-heading' leave a blank line before new heading/item?
1626 The value is an alist, with `heading' and `plain-list-item' as CAR,
1627 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1628 which case Org will look at the surrounding headings/items and try to
1629 make an intelligent decision whether to insert a blank line or not.
1631 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1632 the setting here is ignored and no empty line is inserted to avoid breaking
1633 the list structure."
1634 :group 'org-edit-structure
1635 :type '(list
1636 (cons (const heading)
1637 (choice (const :tag "Never" nil)
1638 (const :tag "Always" t)
1639 (const :tag "Auto" auto)))
1640 (cons (const plain-list-item)
1641 (choice (const :tag "Never" nil)
1642 (const :tag "Always" t)
1643 (const :tag "Auto" auto)))))
1645 (defcustom org-insert-heading-hook nil
1646 "Hook being run after inserting a new heading."
1647 :group 'org-edit-structure
1648 :type 'hook)
1650 (defcustom org-enable-fixed-width-editor t
1651 "Non-nil means lines starting with \":\" are treated as fixed-width.
1652 This currently only means they are never auto-wrapped.
1653 When nil, such lines will be treated like ordinary lines."
1654 :group 'org-edit-structure
1655 :type 'boolean)
1657 (defcustom org-goto-auto-isearch t
1658 "Non-nil means typing characters in `org-goto' starts incremental search.
1659 When nil, you can use these keybindings to navigate the buffer:
1661 q Quit the org-goto interface
1662 n Go to the next visible heading
1663 p Go to the previous visible heading
1664 f Go one heading forward on same level
1665 b Go one heading backward on same level
1666 u Go one heading up"
1667 :group 'org-edit-structure
1668 :type 'boolean)
1670 (defgroup org-sparse-trees nil
1671 "Options concerning sparse trees in Org-mode."
1672 :tag "Org Sparse Trees"
1673 :group 'org-structure)
1675 (defcustom org-highlight-sparse-tree-matches t
1676 "Non-nil means highlight all matches that define a sparse tree.
1677 The highlights will automatically disappear the next time the buffer is
1678 changed by an edit command."
1679 :group 'org-sparse-trees
1680 :type 'boolean)
1682 (defcustom org-remove-highlights-with-change t
1683 "Non-nil means any change to the buffer will remove temporary highlights.
1684 \\<org-mode-map>\
1685 Such highlights are created by `org-occur' and `org-clock-display'.
1686 When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
1687 to get rid of the highlights.
1688 The highlights created by `org-toggle-latex-fragment' always need
1689 `\\[org-toggle-latex-fragment]' to be removed."
1690 :group 'org-sparse-trees
1691 :group 'org-time
1692 :type 'boolean)
1695 (defcustom org-occur-hook '(org-first-headline-recenter)
1696 "Hook that is run after `org-occur' has constructed a sparse tree.
1697 This can be used to recenter the window to show as much of the structure
1698 as possible."
1699 :group 'org-sparse-trees
1700 :type 'hook)
1702 (defgroup org-imenu-and-speedbar nil
1703 "Options concerning imenu and speedbar in Org-mode."
1704 :tag "Org Imenu and Speedbar"
1705 :group 'org-structure)
1707 (defcustom org-imenu-depth 2
1708 "The maximum level for Imenu access to Org-mode headlines.
1709 This also applied for speedbar access."
1710 :group 'org-imenu-and-speedbar
1711 :type 'integer)
1713 (defgroup org-table nil
1714 "Options concerning tables in Org-mode."
1715 :tag "Org Table"
1716 :group 'org)
1718 (defcustom org-enable-table-editor 'optimized
1719 "Non-nil means lines starting with \"|\" are handled by the table editor.
1720 When nil, such lines will be treated like ordinary lines.
1722 When equal to the symbol `optimized', the table editor will be optimized to
1723 do the following:
1724 - Automatic overwrite mode in front of whitespace in table fields.
1725 This makes the structure of the table stay in tact as long as the edited
1726 field does not exceed the column width.
1727 - Minimize the number of realigns. Normally, the table is aligned each time
1728 TAB or RET are pressed to move to another field. With optimization this
1729 happens only if changes to a field might have changed the column width.
1730 Optimization requires replacing the functions `self-insert-command',
1731 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1732 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1733 very good at guessing when a re-align will be necessary, but you can always
1734 force one with \\[org-ctrl-c-ctrl-c].
1736 If you would like to use the optimized version in Org-mode, but the
1737 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1739 This variable can be used to turn on and off the table editor during a session,
1740 but in order to toggle optimization, a restart is required.
1742 See also the variable `org-table-auto-blank-field'."
1743 :group 'org-table
1744 :type '(choice
1745 (const :tag "off" nil)
1746 (const :tag "on" t)
1747 (const :tag "on, optimized" optimized)))
1749 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1750 (version<= emacs-version "24.1"))
1751 "Non-nil means cluster self-insert commands for undo when possible.
1752 If this is set, then, like in the Emacs command loop, 20 consecutive
1753 characters will be undone together.
1754 This is configurable, because there is some impact on typing performance."
1755 :group 'org-table
1756 :type 'boolean)
1758 (defcustom org-table-tab-recognizes-table.el t
1759 "Non-nil means TAB will automatically notice a table.el table.
1760 When it sees such a table, it moves point into it and - if necessary -
1761 calls `table-recognize-table'."
1762 :group 'org-table-editing
1763 :type 'boolean)
1765 (defgroup org-link nil
1766 "Options concerning links in Org-mode."
1767 :tag "Org Link"
1768 :group 'org)
1770 (defvar org-link-abbrev-alist-local nil
1771 "Buffer-local version of `org-link-abbrev-alist', which see.
1772 The value of this is taken from the #+LINK lines.")
1773 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1775 (defcustom org-link-abbrev-alist nil
1776 "Alist of link abbreviations.
1777 The car of each element is a string, to be replaced at the start of a link.
1778 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1779 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1781 [[linkkey:tag][description]]
1783 The `linkkey' must be a word word, starting with a letter, followed
1784 by letters, numbers, `-' or `_'.
1786 If REPLACE is a string, the tag will simply be appended to create the link.
1787 If the string contains \"%s\", the tag will be inserted there. If the string
1788 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1789 at that point (see the function `url-hexify-string'). If the string contains
1790 the specifier \"%(my-function)\", then the custom function `my-function' will
1791 be invoked: this function takes the tag as its only argument and must return
1792 a string.
1794 REPLACE may also be a function that will be called with the tag as the
1795 only argument to create the link, which should be returned as a string.
1797 See the manual for examples."
1798 :group 'org-link
1799 :type '(repeat
1800 (cons
1801 (string :tag "Protocol")
1802 (choice
1803 (string :tag "Format")
1804 (function)))))
1806 (defcustom org-descriptive-links t
1807 "Non-nil means Org will display descriptive links.
1808 E.g. [[http://orgmode.org][Org website]] will be displayed as
1809 \"Org Website\", hiding the link itself and just displaying its
1810 description. When set to nil, Org will display the full links
1811 literally.
1813 You can interactively set the value of this variable by calling
1814 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1815 :group 'org-link
1816 :type 'boolean)
1818 (defcustom org-link-file-path-type 'adaptive
1819 "How the path name in file links should be stored.
1820 Valid values are:
1822 relative Relative to the current directory, i.e. the directory of the file
1823 into which the link is being inserted.
1824 absolute Absolute path, if possible with ~ for home directory.
1825 noabbrev Absolute path, no abbreviation of home directory.
1826 adaptive Use relative path for files in the current directory and sub-
1827 directories of it. For other files, use an absolute path."
1828 :group 'org-link
1829 :type '(choice
1830 (const relative)
1831 (const absolute)
1832 (const noabbrev)
1833 (const adaptive)))
1835 (defvaralias 'org-activate-links 'org-highlight-links)
1836 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1837 "Types of links that should be highlighted in Org-mode files.
1839 This is a list of symbols, each one of them leading to the
1840 highlighting of a certain link type.
1842 You can still open links that are not highlighted.
1844 In principle, it does not hurt to turn on highlighting for all
1845 link types. There may be a small gain when turning off unused
1846 link types. The types are:
1848 bracket The recommended [[link][description]] or [[link]] links with hiding.
1849 angle Links in angular brackets that may contain whitespace like
1850 <bbdb:Carsten Dominik>.
1851 plain Plain links in normal text, no whitespace, like http://google.com.
1852 radio Text that is matched by a radio target, see manual for details.
1853 tag Tag settings in a headline (link to tag search).
1854 date Time stamps (link to calendar).
1855 footnote Footnote labels.
1857 If you set this variable during an Emacs session, use `org-mode-restart'
1858 in the Org buffer so that the change takes effect."
1859 :group 'org-link
1860 :group 'org-appearance
1861 :type '(set :greedy t
1862 (const :tag "Double bracket links" bracket)
1863 (const :tag "Angular bracket links" angle)
1864 (const :tag "Plain text links" plain)
1865 (const :tag "Radio target matches" radio)
1866 (const :tag "Tags" tag)
1867 (const :tag "Timestamps" date)
1868 (const :tag "Footnotes" footnote)))
1870 (defcustom org-make-link-description-function nil
1871 "Function to use for generating link descriptions from links.
1872 When nil, the link location will be used. This function must take
1873 two parameters: the first one is the link, the second one is the
1874 description generated by `org-insert-link'. The function should
1875 return the description to use."
1876 :group 'org-link
1877 :type '(choice (const nil) (function)))
1879 (defgroup org-link-store nil
1880 "Options concerning storing links in Org-mode."
1881 :tag "Org Store Link"
1882 :group 'org-link)
1884 (defcustom org-url-hexify-p t
1885 "When non-nil, hexify URL when creating a link."
1886 :type 'boolean
1887 :version "24.3"
1888 :group 'org-link-store)
1890 (defcustom org-email-link-description-format "Email %c: %.30s"
1891 "Format of the description part of a link to an email or usenet message.
1892 The following %-escapes will be replaced by corresponding information:
1894 %F full \"From\" field
1895 %f name, taken from \"From\" field, address if no name
1896 %T full \"To\" field
1897 %t first name in \"To\" field, address if no name
1898 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1899 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1900 %s subject
1901 %d date
1902 %m message-id.
1904 You may use normal field width specification between the % and the letter.
1905 This is for example useful to limit the length of the subject.
1907 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1908 :group 'org-link-store
1909 :type 'string)
1911 (defcustom org-from-is-user-regexp
1912 (let (r1 r2)
1913 (when (and user-mail-address (not (string= user-mail-address "")))
1914 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1915 (when (and user-full-name (not (string= user-full-name "")))
1916 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1917 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1918 "Regexp matched against the \"From:\" header of an email or usenet message.
1919 It should match if the message is from the user him/herself."
1920 :group 'org-link-store
1921 :type 'regexp)
1923 (defcustom org-context-in-file-links t
1924 "Non-nil means file links from `org-store-link' contain context.
1925 A search string will be added to the file name with :: as separator and
1926 used to find the context when the link is activated by the command
1927 `org-open-at-point'. When this option is t, the entire active region
1928 will be placed in the search string of the file link. If set to a
1929 positive integer, only the first n lines of context will be stored.
1931 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1932 negates this setting for the duration of the command."
1933 :group 'org-link-store
1934 :type '(choice boolean integer))
1936 (defcustom org-keep-stored-link-after-insertion nil
1937 "Non-nil means keep link in list for entire session.
1939 The command `org-store-link' adds a link pointing to the current
1940 location to an internal list. These links accumulate during a session.
1941 The command `org-insert-link' can be used to insert links into any
1942 Org-mode file (offering completion for all stored links). When this
1943 option is nil, every link which has been inserted once using \\[org-insert-link]
1944 will be removed from the list, to make completing the unused links
1945 more efficient."
1946 :group 'org-link-store
1947 :type 'boolean)
1949 (defgroup org-link-follow nil
1950 "Options concerning following links in Org-mode."
1951 :tag "Org Follow Link"
1952 :group 'org-link)
1954 (defcustom org-link-translation-function nil
1955 "Function to translate links with different syntax to Org syntax.
1956 This can be used to translate links created for example by the Planner
1957 or emacs-wiki packages to Org syntax.
1958 The function must accept two parameters, a TYPE containing the link
1959 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1960 which is everything after the link protocol. It should return a cons
1961 with possibly modified values of type and path.
1962 Org contains a function for this, so if you set this variable to
1963 `org-translate-link-from-planner', you should be able follow many
1964 links created by planner."
1965 :group 'org-link-follow
1966 :type '(choice (const nil) (function)))
1968 (defcustom org-follow-link-hook nil
1969 "Hook that is run after a link has been followed."
1970 :group 'org-link-follow
1971 :type 'hook)
1973 (defcustom org-tab-follows-link nil
1974 "Non-nil means on links TAB will follow the link.
1975 Needs to be set before org.el is loaded.
1976 This really should not be used, it does not make sense, and the
1977 implementation is bad."
1978 :group 'org-link-follow
1979 :type 'boolean)
1981 (defcustom org-return-follows-link nil
1982 "Non-nil means on links RET will follow the link.
1983 In tables, the special behavior of RET has precedence."
1984 :group 'org-link-follow
1985 :type 'boolean)
1987 (defcustom org-mouse-1-follows-link
1988 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1989 "Non-nil means mouse-1 on a link will follow the link.
1990 A longer mouse click will still set point. Does not work on XEmacs.
1991 Needs to be set before org.el is loaded."
1992 :group 'org-link-follow
1993 :version "24.4"
1994 :package-version '(Org . "8.3")
1995 :type '(choice
1996 (const :tag "A double click follows the link" double)
1997 (const :tag "Unconditionally follow the link with mouse-1" t)
1998 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2000 (defcustom org-mark-ring-length 4
2001 "Number of different positions to be recorded in the ring.
2002 Changing this requires a restart of Emacs to work correctly."
2003 :group 'org-link-follow
2004 :type 'integer)
2006 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2007 "Non-nil means internal links in Org files must exactly match a headline.
2008 When nil, the link search tries to match a phrase with all words
2009 in the search text."
2010 :group 'org-link-follow
2011 :version "24.1"
2012 :type '(choice
2013 (const :tag "Use fuzzy text search" nil)
2014 (const :tag "Match only exact headline" t)
2015 (const :tag "Match exact headline or query to create it"
2016 query-to-create)))
2018 (defcustom org-link-frame-setup
2019 '((vm . vm-visit-folder-other-frame)
2020 (vm-imap . vm-visit-imap-folder-other-frame)
2021 (gnus . org-gnus-no-new-news)
2022 (file . find-file-other-window)
2023 (wl . wl-other-frame))
2024 "Setup the frame configuration for following links.
2025 When following a link with Emacs, it may often be useful to display
2026 this link in another window or frame. This variable can be used to
2027 set this up for the different types of links.
2028 For VM, use any of
2029 `vm-visit-folder'
2030 `vm-visit-folder-other-window'
2031 `vm-visit-folder-other-frame'
2032 For Gnus, use any of
2033 `gnus'
2034 `gnus-other-frame'
2035 `org-gnus-no-new-news'
2036 For FILE, use any of
2037 `find-file'
2038 `find-file-other-window'
2039 `find-file-other-frame'
2040 For Wanderlust use any of
2041 `wl'
2042 `wl-other-frame'
2043 For the calendar, use the variable `calendar-setup'.
2044 For BBDB, it is currently only possible to display the matches in
2045 another window."
2046 :group 'org-link-follow
2047 :type '(list
2048 (cons (const vm)
2049 (choice
2050 (const vm-visit-folder)
2051 (const vm-visit-folder-other-window)
2052 (const vm-visit-folder-other-frame)))
2053 (cons (const vm-imap)
2054 (choice
2055 (const vm-visit-imap-folder)
2056 (const vm-visit-imap-folder-other-window)
2057 (const vm-visit-imap-folder-other-frame)))
2058 (cons (const gnus)
2059 (choice
2060 (const gnus)
2061 (const gnus-other-frame)
2062 (const org-gnus-no-new-news)))
2063 (cons (const file)
2064 (choice
2065 (const find-file)
2066 (const find-file-other-window)
2067 (const find-file-other-frame)))
2068 (cons (const wl)
2069 (choice
2070 (const wl)
2071 (const wl-other-frame)))))
2073 (defcustom org-display-internal-link-with-indirect-buffer nil
2074 "Non-nil means use indirect buffer to display infile links.
2075 Activating internal links (from one location in a file to another location
2076 in the same file) normally just jumps to the location. When the link is
2077 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2078 is displayed in
2079 another window. When this option is set, the other window actually displays
2080 an indirect buffer clone of the current buffer, to avoid any visibility
2081 changes to the current buffer."
2082 :group 'org-link-follow
2083 :type 'boolean)
2085 (defcustom org-open-non-existing-files nil
2086 "Non-nil means `org-open-file' will open non-existing files.
2087 When nil, an error will be generated.
2088 This variable applies only to external applications because they
2089 might choke on non-existing files. If the link is to a file that
2090 will be opened in Emacs, the variable is ignored."
2091 :group 'org-link-follow
2092 :type 'boolean)
2094 (defcustom org-open-directory-means-index-dot-org nil
2095 "Non-nil means a link to a directory really means to index.org.
2096 When nil, following a directory link will run dired or open a finder/explorer
2097 window on that directory."
2098 :group 'org-link-follow
2099 :type 'boolean)
2101 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2102 "Non-nil means ask for confirmation before executing shell links.
2103 Shell links can be dangerous: just think about a link
2105 [[shell:rm -rf ~/*][Google Search]]
2107 This link would show up in your Org-mode document as \"Google Search\",
2108 but really it would remove your entire home directory.
2109 Therefore we advise against setting this variable to nil.
2110 Just change it to `y-or-n-p' if you want to confirm with a
2111 single keystroke rather than having to type \"yes\"."
2112 :group 'org-link-follow
2113 :type '(choice
2114 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2115 (const :tag "with y-or-n (faster)" y-or-n-p)
2116 (const :tag "no confirmation (dangerous)" nil)))
2117 (put 'org-confirm-shell-link-function
2118 'safe-local-variable
2119 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2121 (defcustom org-confirm-shell-link-not-regexp ""
2122 "A regexp to skip confirmation for shell links."
2123 :group 'org-link-follow
2124 :version "24.1"
2125 :type 'regexp)
2127 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2128 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2129 Elisp links can be dangerous: just think about a link
2131 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2133 This link would show up in your Org-mode document as \"Google Search\",
2134 but really it would remove your entire home directory.
2135 Therefore we advise against setting this variable to nil.
2136 Just change it to `y-or-n-p' if you want to confirm with a
2137 single keystroke rather than having to type \"yes\"."
2138 :group 'org-link-follow
2139 :type '(choice
2140 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2141 (const :tag "with y-or-n (faster)" y-or-n-p)
2142 (const :tag "no confirmation (dangerous)" nil)))
2143 (put 'org-confirm-shell-link-function
2144 'safe-local-variable
2145 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2147 (defcustom org-confirm-elisp-link-not-regexp ""
2148 "A regexp to skip confirmation for Elisp links."
2149 :group 'org-link-follow
2150 :version "24.1"
2151 :type 'regexp)
2153 (defconst org-file-apps-defaults-gnu
2154 '((remote . emacs)
2155 (system . mailcap)
2156 (t . mailcap))
2157 "Default file applications on a UNIX or GNU/Linux system.
2158 See `org-file-apps'.")
2160 (defconst org-file-apps-defaults-macosx
2161 '((remote . emacs)
2162 (t . "open %s")
2163 (system . "open %s")
2164 ("ps.gz" . "gv %s")
2165 ("eps.gz" . "gv %s")
2166 ("dvi" . "xdvi %s")
2167 ("fig" . "xfig %s"))
2168 "Default file applications on a MacOS X system.
2169 The system \"open\" is known as a default, but we use X11 applications
2170 for some files for which the OS does not have a good default.
2171 See `org-file-apps'.")
2173 (defconst org-file-apps-defaults-windowsnt
2174 (list
2175 '(remote . emacs)
2176 (cons t
2177 (list (if (featurep 'xemacs)
2178 'mswindows-shell-execute
2179 'w32-shell-execute)
2180 "open" 'file))
2181 (cons 'system
2182 (list (if (featurep 'xemacs)
2183 'mswindows-shell-execute
2184 'w32-shell-execute)
2185 "open" 'file)))
2186 "Default file applications on a Windows NT system.
2187 The system \"open\" is used for most files.
2188 See `org-file-apps'.")
2190 (defcustom org-file-apps
2191 '((auto-mode . emacs)
2192 ("\\.mm\\'" . default)
2193 ("\\.x?html?\\'" . default)
2194 ("\\.pdf\\'" . default))
2195 "External applications for opening `file:path' items in a document.
2196 Org-mode uses system defaults for different file types, but
2197 you can use this variable to set the application for a given file
2198 extension. The entries in this list are cons cells where the car identifies
2199 files and the cdr the corresponding command. Possible values for the
2200 file identifier are
2201 \"string\" A string as a file identifier can be interpreted in different
2202 ways, depending on its contents:
2204 - Alphanumeric characters only:
2205 Match links with this file extension.
2206 Example: (\"pdf\" . \"evince %s\")
2207 to open PDFs with evince.
2209 - Regular expression: Match links where the
2210 filename matches the regexp. If you want to
2211 use groups here, use shy groups.
2213 Example: (\"\\.x?html\\\\='\" . \"firefox %s\")
2214 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2215 to open *.html and *.xhtml with firefox.
2217 - Regular expression which contains (non-shy) groups:
2218 Match links where the whole link, including \"::\", and
2219 anything after that, matches the regexp.
2220 In a custom command string, %1, %2, etc. are replaced with
2221 the parts of the link that were matched by the groups.
2222 For backwards compatibility, if a command string is given
2223 that does not use any of the group matches, this case is
2224 handled identically to the second one (i.e. match against
2225 file name only).
2226 In a custom lisp form, you can access the group matches with
2227 (match-string n link).
2229 Example: (\"\\.pdf::\\(\\d+\\)\\\\='\" . \"evince -p %1 %s\")
2230 to open [[file:document.pdf::5]] with evince at page 5.
2232 `directory' Matches a directory
2233 `remote' Matches a remote file, accessible through tramp or efs.
2234 Remote files most likely should be visited through Emacs
2235 because external applications cannot handle such paths.
2236 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2237 so all files Emacs knows how to handle. Using this with
2238 command `emacs' will open most files in Emacs. Beware that this
2239 will also open html files inside Emacs, unless you add
2240 (\"html\" . default) to the list as well.
2241 t Default for files not matched by any of the other options.
2242 `system' The system command to open files, like `open' on Windows
2243 and Mac OS X, and mailcap under GNU/Linux. This is the command
2244 that will be selected if you call `C-c C-o' with a double
2245 \\[universal-argument] \\[universal-argument] prefix.
2247 Possible values for the command are:
2248 `emacs' The file will be visited by the current Emacs process.
2249 `default' Use the default application for this file type, which is the
2250 association for t in the list, most likely in the system-specific
2251 part.
2252 This can be used to overrule an unwanted setting in the
2253 system-specific variable.
2254 `system' Use the system command for opening files, like \"open\".
2255 This command is specified by the entry whose car is `system'.
2256 Most likely, the system-specific version of this variable
2257 does define this command, but you can overrule/replace it
2258 here.
2259 string A command to be executed by a shell; %s will be replaced
2260 by the path to the file.
2261 sexp A Lisp form which will be evaluated. The file path will
2262 be available in the Lisp variable `file'.
2263 For more examples, see the system specific constants
2264 `org-file-apps-defaults-macosx'
2265 `org-file-apps-defaults-windowsnt'
2266 `org-file-apps-defaults-gnu'."
2267 :group 'org-link-follow
2268 :type '(repeat
2269 (cons (choice :value ""
2270 (string :tag "Extension")
2271 (const :tag "System command to open files" system)
2272 (const :tag "Default for unrecognized files" t)
2273 (const :tag "Remote file" remote)
2274 (const :tag "Links to a directory" directory)
2275 (const :tag "Any files that have Emacs modes"
2276 auto-mode))
2277 (choice :value ""
2278 (const :tag "Visit with Emacs" emacs)
2279 (const :tag "Use default" default)
2280 (const :tag "Use the system command" system)
2281 (string :tag "Command")
2282 (sexp :tag "Lisp form")))))
2284 (defcustom org-doi-server-url "http://dx.doi.org/"
2285 "The URL of the DOI server."
2286 :type 'string
2287 :version "24.3"
2288 :group 'org-link-follow)
2290 (defgroup org-refile nil
2291 "Options concerning refiling entries in Org-mode."
2292 :tag "Org Refile"
2293 :group 'org)
2295 (defcustom org-directory "~/org"
2296 "Directory with org files.
2297 This is just a default location to look for Org files. There is no need
2298 at all to put your files into this directory. It is only used in the
2299 following situations:
2301 1. When a capture template specifies a target file that is not an
2302 absolute path. The path will then be interpreted relative to
2303 `org-directory'
2304 2. When a capture note is filed away in an interactive way (when exiting the
2305 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2306 with `org-directory' as the default path."
2307 :group 'org-refile
2308 :group 'org-capture
2309 :type 'directory)
2311 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2312 "Default target for storing notes.
2313 Used as a fall back file for org-capture.el, for templates that
2314 do not specify a target file."
2315 :group 'org-refile
2316 :group 'org-capture
2317 :type 'file)
2319 (defcustom org-goto-interface 'outline
2320 "The default interface to be used for `org-goto'.
2321 Allowed values are:
2322 outline The interface shows an outline of the relevant file
2323 and the correct heading is found by moving through
2324 the outline or by searching with incremental search.
2325 outline-path-completion Headlines in the current buffer are offered via
2326 completion. This is the interface also used by
2327 the refile command."
2328 :group 'org-refile
2329 :type '(choice
2330 (const :tag "Outline" outline)
2331 (const :tag "Outline-path-completion" outline-path-completion)))
2333 (defcustom org-goto-max-level 5
2334 "Maximum target level when running `org-goto' with refile interface."
2335 :group 'org-refile
2336 :type 'integer)
2338 (defcustom org-reverse-note-order nil
2339 "Non-nil means store new notes at the beginning of a file or entry.
2340 When nil, new notes will be filed to the end of a file or entry.
2341 This can also be a list with cons cells of regular expressions that
2342 are matched against file names, and values."
2343 :group 'org-capture
2344 :group 'org-refile
2345 :type '(choice
2346 (const :tag "Reverse always" t)
2347 (const :tag "Reverse never" nil)
2348 (repeat :tag "By file name regexp"
2349 (cons regexp boolean))))
2351 (defcustom org-log-refile nil
2352 "Information to record when a task is refiled.
2354 Possible values are:
2356 nil Don't add anything
2357 time Add a time stamp to the task
2358 note Prompt for a note and add it with template `org-log-note-headings'
2360 This option can also be set with on a per-file-basis with
2362 #+STARTUP: nologrefile
2363 #+STARTUP: logrefile
2364 #+STARTUP: lognoterefile
2366 You can have local logging settings for a subtree by setting the LOGGING
2367 property to one or more of these keywords.
2369 When bulk-refiling from the agenda, the value `note' is forbidden and
2370 will temporarily be changed to `time'."
2371 :group 'org-refile
2372 :group 'org-progress
2373 :version "24.1"
2374 :type '(choice
2375 (const :tag "No logging" nil)
2376 (const :tag "Record timestamp" time)
2377 (const :tag "Record timestamp with note." note)))
2379 (defcustom org-refile-targets nil
2380 "Targets for refiling entries with \\[org-refile].
2381 This is a list of cons cells. Each cell contains:
2382 - a specification of the files to be considered, either a list of files,
2383 or a symbol whose function or variable value will be used to retrieve
2384 a file name or a list of file names. If you use `org-agenda-files' for
2385 that, all agenda files will be scanned for targets. Nil means consider
2386 headings in the current buffer.
2387 - A specification of how to find candidate refile targets. This may be
2388 any of:
2389 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2390 This tag has to be present in all target headlines, inheritance will
2391 not be considered.
2392 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2393 todo keyword.
2394 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2395 headlines that are refiling targets.
2396 - a cons cell (:level . N). Any headline of level N is considered a target.
2397 Note that, when `org-odd-levels-only' is set, level corresponds to
2398 order in hierarchy, not to the number of stars.
2399 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2400 Note that, when `org-odd-levels-only' is set, level corresponds to
2401 order in hierarchy, not to the number of stars.
2403 Each element of this list generates a set of possible targets.
2404 The union of these sets is presented (with completion) to
2405 the user by `org-refile'.
2407 You can set the variable `org-refile-target-verify-function' to a function
2408 to verify each headline found by the simple criteria above.
2410 When this variable is nil, all top-level headlines in the current buffer
2411 are used, equivalent to the value `((nil . (:level . 1))'."
2412 :group 'org-refile
2413 :type '(repeat
2414 (cons
2415 (choice :value org-agenda-files
2416 (const :tag "All agenda files" org-agenda-files)
2417 (const :tag "Current buffer" nil)
2418 (function) (variable) (file))
2419 (choice :tag "Identify target headline by"
2420 (cons :tag "Specific tag" (const :value :tag) (string))
2421 (cons :tag "TODO keyword" (const :value :todo) (string))
2422 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2423 (cons :tag "Level number" (const :value :level) (integer))
2424 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2426 (defcustom org-refile-target-verify-function nil
2427 "Function to verify if the headline at point should be a refile target.
2428 The function will be called without arguments, with point at the
2429 beginning of the headline. It should return t and leave point
2430 where it is if the headline is a valid target for refiling.
2432 If the target should not be selected, the function must return nil.
2433 In addition to this, it may move point to a place from where the search
2434 should be continued. For example, the function may decide that the entire
2435 subtree of the current entry should be excluded and move point to the end
2436 of the subtree."
2437 :group 'org-refile
2438 :type '(choice
2439 (const nil)
2440 (function)))
2442 (defcustom org-refile-use-cache nil
2443 "Non-nil means cache refile targets to speed up the process.
2444 \\<org-mode-map>\
2445 The cache for a particular file will be updated automatically when
2446 the buffer has been killed, or when any of the marker used for flagging
2447 refile targets no longer points at a live buffer.
2448 If you have added new entries to a buffer that might themselves be targets,
2449 you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
2450 if you find that easier, \
2451 `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
2452 \\[org-refile]'."
2453 :group 'org-refile
2454 :version "24.1"
2455 :type 'boolean)
2457 (defcustom org-refile-use-outline-path nil
2458 "Non-nil means provide refile targets as paths.
2459 So a level 3 headline will be available as level1/level2/level3.
2461 When the value is `file', also include the file name (without directory)
2462 into the path. In this case, you can also stop the completion after
2463 the file name, to get entries inserted as top level in the file.
2465 When `full-file-path', include the full file path."
2466 :group 'org-refile
2467 :type '(choice
2468 (const :tag "Not" nil)
2469 (const :tag "Yes" t)
2470 (const :tag "Start with file name" file)
2471 (const :tag "Start with full file path" full-file-path)))
2473 (defcustom org-outline-path-complete-in-steps t
2474 "Non-nil means complete the outline path in hierarchical steps.
2475 When Org-mode uses the refile interface to select an outline path
2476 \(see variable `org-refile-use-outline-path'), the completion of
2477 the path can be done in a single go, or it can be done in steps down
2478 the headline hierarchy. Going in steps is probably the best if you
2479 do not use a special completion package like `ido' or `icicles'.
2480 However, when using these packages, going in one step can be very
2481 fast, while still showing the whole path to the entry."
2482 :group 'org-refile
2483 :type 'boolean)
2485 (defcustom org-refile-allow-creating-parent-nodes nil
2486 "Non-nil means allow to create new nodes as refile targets.
2487 New nodes are then created by adding \"/new node name\" to the completion
2488 of an existing node. When the value of this variable is `confirm',
2489 new node creation must be confirmed by the user (recommended).
2490 When nil, the completion must match an existing entry.
2492 Note that, if the new heading is not seen by the criteria
2493 listed in `org-refile-targets', multiple instances of the same
2494 heading would be created by trying again to file under the new
2495 heading."
2496 :group 'org-refile
2497 :type '(choice
2498 (const :tag "Never" nil)
2499 (const :tag "Always" t)
2500 (const :tag "Prompt for confirmation" confirm)))
2502 (defcustom org-refile-active-region-within-subtree nil
2503 "Non-nil means also refile active region within a subtree.
2505 By default `org-refile' doesn't allow refiling regions if they
2506 don't contain a set of subtrees, but it might be convenient to
2507 do so sometimes: in that case, the first line of the region is
2508 converted to a headline before refiling."
2509 :group 'org-refile
2510 :version "24.1"
2511 :type 'boolean)
2513 (defgroup org-todo nil
2514 "Options concerning TODO items in Org-mode."
2515 :tag "Org TODO"
2516 :group 'org)
2518 (defgroup org-progress nil
2519 "Options concerning Progress logging in Org-mode."
2520 :tag "Org Progress"
2521 :group 'org-time)
2523 (defvar org-todo-interpretation-widgets
2524 '((:tag "Sequence (cycling hits every state)" sequence)
2525 (:tag "Type (cycling directly to DONE)" type))
2526 "The available interpretation symbols for customizing `org-todo-keywords'.
2527 Interested libraries should add to this list.")
2529 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2530 "List of TODO entry keyword sequences and their interpretation.
2531 \\<org-mode-map>This is a list of sequences.
2533 Each sequence starts with a symbol, either `sequence' or `type',
2534 indicating if the keywords should be interpreted as a sequence of
2535 action steps, or as different types of TODO items. The first
2536 keywords are states requiring action - these states will select a headline
2537 for inclusion into the global TODO list Org-mode produces. If one of
2538 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2539 signify that no further action is necessary. If \"|\" is not found,
2540 the last keyword is treated as the only DONE state of the sequence.
2542 The command \\[org-todo] cycles an entry through these states, and one
2543 additional state where no keyword is present. For details about this
2544 cycling, see the manual.
2546 TODO keywords and interpretation can also be set on a per-file basis with
2547 the special #+SEQ_TODO and #+TYP_TODO lines.
2549 Each keyword can optionally specify a character for fast state selection
2550 \(in combination with the variable `org-use-fast-todo-selection')
2551 and specifiers for state change logging, using the same syntax that
2552 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2553 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2554 indicates to record a time stamp each time this state is selected.
2556 Each keyword may also specify if a timestamp or a note should be
2557 recorded when entering or leaving the state, by adding additional
2558 characters in the parenthesis after the keyword. This looks like this:
2559 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2560 record only the time of the state change. With X and Y being either
2561 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2562 Y when leaving the state if and only if the *target* state does not
2563 define X. You may omit any of the fast-selection key or X or /Y,
2564 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2566 For backward compatibility, this variable may also be just a list
2567 of keywords. In this case the interpretation (sequence or type) will be
2568 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2569 :group 'org-todo
2570 :group 'org-keywords
2571 :type '(choice
2572 (repeat :tag "Old syntax, just keywords"
2573 (string :tag "Keyword"))
2574 (repeat :tag "New syntax"
2575 (cons
2576 (choice
2577 :tag "Interpretation"
2578 ;;Quick and dirty way to see
2579 ;;`org-todo-interpretations'. This takes the
2580 ;;place of item arguments
2581 :convert-widget
2582 (lambda (widget)
2583 (widget-put widget
2584 :args (mapcar
2585 (lambda (x)
2586 (widget-convert
2587 (cons 'const x)))
2588 org-todo-interpretation-widgets))
2589 widget))
2590 (repeat
2591 (string :tag "Keyword"))))))
2593 (defvar org-todo-keywords-1 nil
2594 "All TODO and DONE keywords active in a buffer.")
2595 (make-variable-buffer-local 'org-todo-keywords-1)
2596 (defvar org-todo-keywords-for-agenda nil)
2597 (defvar org-done-keywords-for-agenda nil)
2598 (defvar org-todo-keyword-alist-for-agenda nil)
2599 (defvar org-tag-alist-for-agenda nil
2600 "Alist of all tags from all agenda files.")
2601 (defvar org-tag-groups-alist-for-agenda nil
2602 "Alist of all groups tags from all current agenda files.")
2603 (defvar org-tag-groups-alist nil)
2604 (make-variable-buffer-local 'org-tag-groups-alist)
2605 (defvar org-agenda-contributing-files nil)
2606 (defvar org-not-done-keywords nil)
2607 (make-variable-buffer-local 'org-not-done-keywords)
2608 (defvar org-done-keywords nil)
2609 (make-variable-buffer-local 'org-done-keywords)
2610 (defvar org-todo-heads nil)
2611 (make-variable-buffer-local 'org-todo-heads)
2612 (defvar org-todo-sets nil)
2613 (make-variable-buffer-local 'org-todo-sets)
2614 (defvar org-todo-log-states nil)
2615 (make-variable-buffer-local 'org-todo-log-states)
2616 (defvar org-todo-kwd-alist nil)
2617 (make-variable-buffer-local 'org-todo-kwd-alist)
2618 (defvar org-todo-key-alist nil)
2619 (make-variable-buffer-local 'org-todo-key-alist)
2620 (defvar org-todo-key-trigger nil)
2621 (make-variable-buffer-local 'org-todo-key-trigger)
2623 (defcustom org-todo-interpretation 'sequence
2624 "Controls how TODO keywords are interpreted.
2625 This variable is in principle obsolete and is only used for
2626 backward compatibility, if the interpretation of todo keywords is
2627 not given already in `org-todo-keywords'. See that variable for
2628 more information."
2629 :group 'org-todo
2630 :group 'org-keywords
2631 :type '(choice (const sequence)
2632 (const type)))
2634 (defcustom org-use-fast-todo-selection t
2635 "\\<org-mode-map>\
2636 Non-nil means use the fast todo selection scheme with \\[org-todo].
2637 This variable describes if and under what circumstances the cycling
2638 mechanism for TODO keywords will be replaced by a single-key, direct
2639 selection scheme.
2641 When nil, fast selection is never used.
2643 When the symbol `prefix', it will be used when `org-todo' is called
2644 with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
2645 in an Org-mode buffer, and
2646 `\\[universal-argument] t' in an agenda buffer.
2648 When t, fast selection is used by default. In this case, the prefix
2649 argument forces cycling instead.
2651 In all cases, the special interface is only used if access keys have
2652 actually been assigned by the user, i.e. if keywords in the configuration
2653 are followed by a letter in parenthesis, like TODO(t)."
2654 :group 'org-todo
2655 :type '(choice
2656 (const :tag "Never" nil)
2657 (const :tag "By default" t)
2658 (const :tag "Only with C-u C-c C-t" prefix)))
2660 (defcustom org-provide-todo-statistics t
2661 "Non-nil means update todo statistics after insert and toggle.
2662 ALL-HEADLINES means update todo statistics by including headlines
2663 with no TODO keyword as well, counting them as not done.
2664 A list of TODO keywords means the same, but skip keywords that are
2665 not in this list.
2666 When set to a list of two lists, the first list contains keywords
2667 to consider as TODO keywords, the second list contains keywords
2668 to consider as DONE keywords.
2670 When this is set, todo statistics is updated in the parent of the
2671 current entry each time a todo state is changed."
2672 :group 'org-todo
2673 :type '(choice
2674 (const :tag "Yes, only for TODO entries" t)
2675 (const :tag "Yes, including all entries" all-headlines)
2676 (repeat :tag "Yes, for TODOs in this list"
2677 (string :tag "TODO keyword"))
2678 (list :tag "Yes, for TODOs and DONEs in these lists"
2679 (repeat (string :tag "TODO keyword"))
2680 (repeat (string :tag "DONE keyword")))
2681 (other :tag "No TODO statistics" nil)))
2683 (defcustom org-hierarchical-todo-statistics t
2684 "Non-nil means TODO statistics covers just direct children.
2685 When nil, all entries in the subtree are considered.
2686 This has only an effect if `org-provide-todo-statistics' is set.
2687 To set this to nil for only a single subtree, use a COOKIE_DATA
2688 property and include the word \"recursive\" into the value."
2689 :group 'org-todo
2690 :type 'boolean)
2692 (defcustom org-after-todo-state-change-hook nil
2693 "Hook which is run after the state of a TODO item was changed.
2694 The new state (a string with a TODO keyword, or nil) is available in the
2695 Lisp variable `org-state'."
2696 :group 'org-todo
2697 :type 'hook)
2699 (defvar org-blocker-hook nil
2700 "Hook for functions that are allowed to block a state change.
2702 Functions in this hook should not modify the buffer.
2703 Each function gets as its single argument a property list,
2704 see `org-trigger-hook' for more information about this list.
2706 If any of the functions in this hook returns nil, the state change
2707 is blocked.")
2709 (defvar org-trigger-hook nil
2710 "Hook for functions that are triggered by a state change.
2712 Each function gets as its single argument a property list with at
2713 least the following elements:
2715 (:type type-of-change :position pos-at-entry-start
2716 :from old-state :to new-state)
2718 Depending on the type, more properties may be present.
2720 This mechanism is currently implemented for:
2722 TODO state changes
2723 ------------------
2724 :type todo-state-change
2725 :from previous state (keyword as a string), or nil, or a symbol
2726 `todo' or `done', to indicate the general type of state.
2727 :to new state, like in :from")
2729 (defcustom org-enforce-todo-dependencies nil
2730 "Non-nil means undone TODO entries will block switching the parent to DONE.
2731 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2732 be blocked if any prior sibling is not yet done.
2733 Finally, if the parent is blocked because of ordered siblings of its own,
2734 the child will also be blocked."
2735 :set (lambda (var val)
2736 (set var val)
2737 (if val
2738 (add-hook 'org-blocker-hook
2739 'org-block-todo-from-children-or-siblings-or-parent)
2740 (remove-hook 'org-blocker-hook
2741 'org-block-todo-from-children-or-siblings-or-parent)))
2742 :group 'org-todo
2743 :type 'boolean)
2745 (defcustom org-enforce-todo-checkbox-dependencies nil
2746 "Non-nil means unchecked boxes will block switching the parent to DONE.
2747 When this is nil, checkboxes have no influence on switching TODO states.
2748 When non-nil, you first need to check off all check boxes before the TODO
2749 entry can be switched to DONE.
2750 This variable needs to be set before org.el is loaded, and you need to
2751 restart Emacs after a change to make the change effective. The only way
2752 to change is while Emacs is running is through the customize interface."
2753 :set (lambda (var val)
2754 (set var val)
2755 (if val
2756 (add-hook 'org-blocker-hook
2757 'org-block-todo-from-checkboxes)
2758 (remove-hook 'org-blocker-hook
2759 'org-block-todo-from-checkboxes)))
2760 :group 'org-todo
2761 :type 'boolean)
2763 (defcustom org-treat-insert-todo-heading-as-state-change nil
2764 "Non-nil means inserting a TODO heading is treated as state change.
2765 So when the command \\[org-insert-todo-heading] is used, state change
2766 logging will apply if appropriate. When nil, the new TODO item will
2767 be inserted directly, and no logging will take place."
2768 :group 'org-todo
2769 :type 'boolean)
2771 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2772 "Non-nil means switching TODO states with S-cursor counts as state change.
2773 This is the default behavior. However, setting this to nil allows a
2774 convenient way to select a TODO state and bypass any logging associated
2775 with that."
2776 :group 'org-todo
2777 :type 'boolean)
2779 (defcustom org-todo-state-tags-triggers nil
2780 "Tag changes that should be triggered by TODO state changes.
2781 This is a list. Each entry is
2783 (state-change (tag . flag) .......)
2785 State-change can be a string with a state, and empty string to indicate the
2786 state that has no TODO keyword, or it can be one of the symbols `todo'
2787 or `done', meaning any not-done or done state, respectively."
2788 :group 'org-todo
2789 :group 'org-tags
2790 :type '(repeat
2791 (cons (choice :tag "When changing to"
2792 (const :tag "Not-done state" todo)
2793 (const :tag "Done state" done)
2794 (string :tag "State"))
2795 (repeat
2796 (cons :tag "Tag action"
2797 (string :tag "Tag")
2798 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2800 (defcustom org-log-done nil
2801 "Information to record when a task moves to the DONE state.
2803 Possible values are:
2805 nil Don't add anything, just change the keyword
2806 time Add a time stamp to the task
2807 note Prompt for a note and add it with template `org-log-note-headings'
2809 This option can also be set with on a per-file-basis with
2811 #+STARTUP: nologdone
2812 #+STARTUP: logdone
2813 #+STARTUP: lognotedone
2815 You can have local logging settings for a subtree by setting the LOGGING
2816 property to one or more of these keywords."
2817 :group 'org-todo
2818 :group 'org-progress
2819 :type '(choice
2820 (const :tag "No logging" nil)
2821 (const :tag "Record CLOSED timestamp" time)
2822 (const :tag "Record CLOSED timestamp with note." note)))
2824 ;; Normalize old uses of org-log-done.
2825 (cond
2826 ((eq org-log-done t) (setq org-log-done 'time))
2827 ((and (listp org-log-done) (memq 'done org-log-done))
2828 (setq org-log-done 'note)))
2830 (defcustom org-log-reschedule nil
2831 "Information to record when the scheduling date of a tasks is modified.
2833 Possible values are:
2835 nil Don't add anything, just change the date
2836 time Add a time stamp to the task
2837 note Prompt for a note and add it with template `org-log-note-headings'
2839 This option can also be set with on a per-file-basis with
2841 #+STARTUP: nologreschedule
2842 #+STARTUP: logreschedule
2843 #+STARTUP: lognotereschedule"
2844 :group 'org-todo
2845 :group 'org-progress
2846 :type '(choice
2847 (const :tag "No logging" nil)
2848 (const :tag "Record timestamp" time)
2849 (const :tag "Record timestamp with note." note)))
2851 (defcustom org-log-redeadline nil
2852 "Information to record when the deadline date of a tasks is modified.
2854 Possible values are:
2856 nil Don't add anything, just change the date
2857 time Add a time stamp to the task
2858 note Prompt for a note and add it with template `org-log-note-headings'
2860 This option can also be set with on a per-file-basis with
2862 #+STARTUP: nologredeadline
2863 #+STARTUP: logredeadline
2864 #+STARTUP: lognoteredeadline
2866 You can have local logging settings for a subtree by setting the LOGGING
2867 property to one or more of these keywords."
2868 :group 'org-todo
2869 :group 'org-progress
2870 :type '(choice
2871 (const :tag "No logging" nil)
2872 (const :tag "Record timestamp" time)
2873 (const :tag "Record timestamp with note." note)))
2875 (defcustom org-log-note-clock-out nil
2876 "Non-nil means record a note when clocking out of an item.
2877 This can also be configured on a per-file basis by adding one of
2878 the following lines anywhere in the buffer:
2880 #+STARTUP: lognoteclock-out
2881 #+STARTUP: nolognoteclock-out"
2882 :group 'org-todo
2883 :group 'org-progress
2884 :type 'boolean)
2886 (defcustom org-log-done-with-time t
2887 "Non-nil means the CLOSED time stamp will contain date and time.
2888 When nil, only the date will be recorded."
2889 :group 'org-progress
2890 :type 'boolean)
2892 (defcustom org-log-note-headings
2893 '((done . "CLOSING NOTE %t")
2894 (state . "State %-12s from %-12S %t")
2895 (note . "Note taken on %t")
2896 (reschedule . "Rescheduled from %S on %t")
2897 (delschedule . "Not scheduled, was %S on %t")
2898 (redeadline . "New deadline from %S on %t")
2899 (deldeadline . "Removed deadline, was %S on %t")
2900 (refile . "Refiled on %t")
2901 (clock-out . ""))
2902 "Headings for notes added to entries.
2904 The value is an alist, with the car being a symbol indicating the
2905 note context, and the cdr is the heading to be used. The heading
2906 may also be the empty string. The following placeholders can be
2907 used:
2909 %t a time stamp.
2910 %T an active time stamp instead the default inactive one
2911 %d a short-format time stamp.
2912 %D an active short-format time stamp.
2913 %s the new TODO state or time stamp (inactive), in double quotes.
2914 %S the old TODO state or time stamp (inactive), in double quotes.
2915 %u the user name.
2916 %U full user name.
2918 In fact, it is not a good idea to change the `state' entry,
2919 because Agenda Log mode depends on the format of these entries."
2920 :group 'org-todo
2921 :group 'org-progress
2922 :type '(list :greedy t
2923 (cons (const :tag "Heading when closing an item" done) string)
2924 (cons (const :tag
2925 "Heading when changing todo state (todo sequence only)"
2926 state) string)
2927 (cons (const :tag "Heading when just taking a note" note) string)
2928 (cons (const :tag "Heading when rescheduling" reschedule) string)
2929 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2930 (cons (const :tag "Heading when changing deadline" redeadline) string)
2931 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2932 (cons (const :tag "Heading when refiling" refile) string)
2933 (cons (const :tag "Heading when clocking out" clock-out) string)))
2935 (unless (assq 'note org-log-note-headings)
2936 (push '(note . "%t") org-log-note-headings))
2938 (defcustom org-log-into-drawer nil
2939 "Non-nil means insert state change notes and time stamps into a drawer.
2940 When nil, state changes notes will be inserted after the headline and
2941 any scheduling and clock lines, but not inside a drawer.
2943 The value of this variable should be the name of the drawer to use.
2944 LOGBOOK is proposed as the default drawer for this purpose, you can
2945 also set this to a string to define the drawer of your choice.
2947 A value of t is also allowed, representing \"LOGBOOK\".
2949 A value of t or nil can also be set with on a per-file-basis with
2951 #+STARTUP: logdrawer
2952 #+STARTUP: nologdrawer
2954 If this variable is set, `org-log-state-notes-insert-after-drawers'
2955 will be ignored.
2957 You can set the property LOG_INTO_DRAWER to overrule this setting for
2958 a subtree.
2960 Do not check directly this variable in a Lisp program. Call
2961 function `org-log-into-drawer' instead."
2962 :group 'org-todo
2963 :group 'org-progress
2964 :type '(choice
2965 (const :tag "Not into a drawer" nil)
2966 (const :tag "LOGBOOK" t)
2967 (string :tag "Other")))
2969 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2971 (defun org-log-into-drawer ()
2972 "Name of the log drawer, as a string, or nil.
2973 This is the value of `org-log-into-drawer'. However, if the
2974 current entry has or inherits a LOG_INTO_DRAWER property, it will
2975 be used instead of the default value."
2976 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2977 (cond ((equal p "nil") nil)
2978 ((equal p "t") "LOGBOOK")
2979 ((stringp p) p)
2980 (p "LOGBOOK")
2981 ((stringp org-log-into-drawer) org-log-into-drawer)
2982 (org-log-into-drawer "LOGBOOK"))))
2984 (defcustom org-log-state-notes-insert-after-drawers nil
2985 "Non-nil means insert state change notes after any drawers in entry.
2986 Only the drawers that *immediately* follow the headline and the
2987 deadline/scheduled line are skipped.
2988 When nil, insert notes right after the heading and perhaps the line
2989 with deadline/scheduling if present.
2991 This variable will have no effect if `org-log-into-drawer' is
2992 set."
2993 :group 'org-todo
2994 :group 'org-progress
2995 :type 'boolean)
2997 (defcustom org-log-states-order-reversed t
2998 "Non-nil means the latest state note will be directly after heading.
2999 When nil, the state change notes will be ordered according to time.
3001 This option can also be set with on a per-file-basis with
3003 #+STARTUP: logstatesreversed
3004 #+STARTUP: nologstatesreversed"
3005 :group 'org-todo
3006 :group 'org-progress
3007 :type 'boolean)
3009 (defcustom org-todo-repeat-to-state nil
3010 "The TODO state to which a repeater should return the repeating task.
3011 By default this is the first task in a TODO sequence, or the previous state
3012 in a TODO_TYP set. But you can specify another task here.
3013 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3014 :group 'org-todo
3015 :version "24.1"
3016 :type '(choice (const :tag "Head of sequence" nil)
3017 (string :tag "Specific state")))
3019 (defcustom org-log-repeat 'time
3020 "Non-nil means record moving through the DONE state when triggering repeat.
3021 An auto-repeating task is immediately switched back to TODO when
3022 marked DONE. If you are not logging state changes (by adding \"@\"
3023 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3024 record a closing note, there will be no record of the task moving
3025 through DONE. This variable forces taking a note anyway.
3027 nil Don't force a record
3028 time Record a time stamp
3029 note Prompt for a note and add it with template `org-log-note-headings'
3031 This option can also be set with on a per-file-basis with
3033 #+STARTUP: nologrepeat
3034 #+STARTUP: logrepeat
3035 #+STARTUP: lognoterepeat
3037 You can have local logging settings for a subtree by setting the LOGGING
3038 property to one or more of these keywords."
3039 :group 'org-todo
3040 :group 'org-progress
3041 :type '(choice
3042 (const :tag "Don't force a record" nil)
3043 (const :tag "Force recording the DONE state" time)
3044 (const :tag "Force recording a note with the DONE state" note)))
3047 (defgroup org-priorities nil
3048 "Priorities in Org-mode."
3049 :tag "Org Priorities"
3050 :group 'org-todo)
3052 (defcustom org-enable-priority-commands t
3053 "Non-nil means priority commands are active.
3054 When nil, these commands will be disabled, so that you never accidentally
3055 set a priority."
3056 :group 'org-priorities
3057 :type 'boolean)
3059 (defcustom org-highest-priority ?A
3060 "The highest priority of TODO items. A character like ?A, ?B etc.
3061 Must have a smaller ASCII number than `org-lowest-priority'."
3062 :group 'org-priorities
3063 :type 'character)
3065 (defcustom org-lowest-priority ?C
3066 "The lowest priority of TODO items. A character like ?A, ?B etc.
3067 Must have a larger ASCII number than `org-highest-priority'."
3068 :group 'org-priorities
3069 :type 'character)
3071 (defcustom org-default-priority ?B
3072 "The default priority of TODO items.
3073 This is the priority an item gets if no explicit priority is given.
3074 When starting to cycle on an empty priority the first step in the cycle
3075 depends on `org-priority-start-cycle-with-default'. The resulting first
3076 step priority must not exceed the range from `org-highest-priority' to
3077 `org-lowest-priority' which means that `org-default-priority' has to be
3078 in this range exclusive or inclusive the range boundaries. Else the
3079 first step refuses to set the default and the second will fall back
3080 to (depending on the command used) the highest or lowest priority."
3081 :group 'org-priorities
3082 :type 'character)
3084 (defcustom org-priority-start-cycle-with-default t
3085 "Non-nil means start with default priority when starting to cycle.
3086 When this is nil, the first step in the cycle will be (depending on the
3087 command used) one higher or lower than the default priority.
3088 See also `org-default-priority'."
3089 :group 'org-priorities
3090 :type 'boolean)
3092 (defcustom org-get-priority-function nil
3093 "Function to extract the priority from a string.
3094 The string is normally the headline. If this is nil Org computes the
3095 priority from the priority cookie like [#A] in the headline. It returns
3096 an integer, increasing by 1000 for each priority level.
3097 The user can set a different function here, which should take a string
3098 as an argument and return the numeric priority."
3099 :group 'org-priorities
3100 :version "24.1"
3101 :type '(choice
3102 (const nil)
3103 (function)))
3105 (defgroup org-time nil
3106 "Options concerning time stamps and deadlines in Org-mode."
3107 :tag "Org Time"
3108 :group 'org)
3110 (defcustom org-time-stamp-rounding-minutes '(0 5)
3111 "Number of minutes to round time stamps to.
3112 \\<org-mode-map>\
3113 These are two values, the first applies when first creating a time stamp.
3114 The second applies when changing it with the commands `S-up' and `S-down'.
3115 When changing the time stamp, this means that it will change in steps
3116 of N minutes, as given by the second value.
3118 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3119 numbers should be factors of 60, so for example 5, 10, 15.
3121 When this is larger than 1, you can still force an exact time stamp by using
3122 a double prefix argument to a time stamp command like \
3123 `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
3124 and by using a prefix arg to `S-up/down' to specify the exact number
3125 of minutes to shift."
3126 :group 'org-time
3127 :get (lambda (var) ; Make sure both elements are there
3128 (if (integerp (default-value var))
3129 (list (default-value var) 5)
3130 (default-value var)))
3131 :type '(list
3132 (integer :tag "when inserting times")
3133 (integer :tag "when modifying times")))
3135 ;; Normalize old customizations of this variable.
3136 (when (integerp org-time-stamp-rounding-minutes)
3137 (setq org-time-stamp-rounding-minutes
3138 (list org-time-stamp-rounding-minutes
3139 org-time-stamp-rounding-minutes)))
3141 (defcustom org-display-custom-times nil
3142 "Non-nil means overlay custom formats over all time stamps.
3143 The formats are defined through the variable `org-time-stamp-custom-formats'.
3144 To turn this on on a per-file basis, insert anywhere in the file:
3145 #+STARTUP: customtime"
3146 :group 'org-time
3147 :set 'set-default
3148 :type 'sexp)
3149 (make-variable-buffer-local 'org-display-custom-times)
3151 (defcustom org-time-stamp-custom-formats
3152 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3153 "Custom formats for time stamps. See `format-time-string' for the syntax.
3154 These are overlaid over the default ISO format if the variable
3155 `org-display-custom-times' is set. Time like %H:%M should be at the
3156 end of the second format. The custom formats are also honored by export
3157 commands, if custom time display is turned on at the time of export."
3158 :group 'org-time
3159 :type 'sexp)
3161 (defun org-time-stamp-format (&optional long inactive)
3162 "Get the right format for a time string."
3163 (let ((f (if long (cdr org-time-stamp-formats)
3164 (car org-time-stamp-formats))))
3165 (if inactive
3166 (concat "[" (substring f 1 -1) "]")
3167 f)))
3169 (defcustom org-time-clocksum-format
3170 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3171 "The format string used when creating CLOCKSUM lines.
3172 This is also used when Org mode generates a time duration.
3174 The value can be a single format string containing two
3175 %-sequences, which will be filled with the number of hours and
3176 minutes in that order.
3178 Alternatively, the value can be a plist associating any of the
3179 keys :years, :months, :weeks, :days, :hours or :minutes with
3180 format strings. The time duration is formatted using only the
3181 time components that are needed and concatenating the results.
3182 If a time unit in absent, it falls back to the next smallest
3183 unit.
3185 The keys :require-years, :require-months, :require-days,
3186 :require-weeks, :require-hours, :require-minutes are also
3187 meaningful. A non-nil value for these keys indicates that the
3188 corresponding time component should always be included, even if
3189 its value is 0.
3192 For example,
3194 (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3195 :require-minutes t)
3197 means durations longer than a day will be expressed in days,
3198 hours and minutes, and durations less than a day will always be
3199 expressed in hours and minutes (even for durations less than an
3200 hour).
3202 The value
3204 (:days \"%dd\" :minutes \"%dm\")
3206 means durations longer than a day will be expressed in days and
3207 minutes, and durations less than a day will be expressed entirely
3208 in minutes (even for durations longer than an hour)."
3209 :group 'org-time
3210 :group 'org-clock
3211 :version "24.4"
3212 :package-version '(Org . "8.0")
3213 :type '(choice (string :tag "Format string")
3214 (set :tag "Plist"
3215 (group :inline t (const :tag "Years" :years)
3216 (string :tag "Format string"))
3217 (group :inline t
3218 (const :tag "Always show years" :require-years)
3219 (const t))
3220 (group :inline t (const :tag "Months" :months)
3221 (string :tag "Format string"))
3222 (group :inline t
3223 (const :tag "Always show months" :require-months)
3224 (const t))
3225 (group :inline t (const :tag "Weeks" :weeks)
3226 (string :tag "Format string"))
3227 (group :inline t
3228 (const :tag "Always show weeks" :require-weeks)
3229 (const t))
3230 (group :inline t (const :tag "Days" :days)
3231 (string :tag "Format string"))
3232 (group :inline t
3233 (const :tag "Always show days" :require-days)
3234 (const t))
3235 (group :inline t (const :tag "Hours" :hours)
3236 (string :tag "Format string"))
3237 (group :inline t
3238 (const :tag "Always show hours" :require-hours)
3239 (const t))
3240 (group :inline t (const :tag "Minutes" :minutes)
3241 (string :tag "Format string"))
3242 (group :inline t
3243 (const :tag "Always show minutes" :require-minutes)
3244 (const t)))))
3246 (defcustom org-time-clocksum-use-fractional nil
3247 "When non-nil, \\[org-clock-display] uses fractional times.
3248 See `org-time-clocksum-format' for more on time clock formats."
3249 :group 'org-time
3250 :group 'org-clock
3251 :version "24.3"
3252 :type 'boolean)
3254 (defcustom org-time-clocksum-use-effort-durations nil
3255 "When non-nil, \\[org-clock-display] uses effort durations.
3256 E.g. by default, one day is considered to be a 8 hours effort,
3257 so a task that has been clocked for 16 hours will be displayed
3258 as during 2 days in the clock display or in the clocktable.
3260 See `org-effort-durations' on how to set effort durations
3261 and `org-time-clocksum-format' for more on time clock formats."
3262 :group 'org-time
3263 :group 'org-clock
3264 :version "24.4"
3265 :package-version '(Org . "8.0")
3266 :type 'boolean)
3268 (defcustom org-time-clocksum-fractional-format "%.2f"
3269 "The format string used when creating CLOCKSUM lines,
3270 or when Org mode generates a time duration, if
3271 `org-time-clocksum-use-fractional' is enabled.
3273 The value can be a single format string containing one
3274 %-sequence, which will be filled with the number of hours as
3275 a float.
3277 Alternatively, the value can be a plist associating any of the
3278 keys :years, :months, :weeks, :days, :hours or :minutes with
3279 a format string. The time duration is formatted using the
3280 largest time unit which gives a non-zero integer part. If all
3281 specified formats have zero integer part, the smallest time unit
3282 is used."
3283 :group 'org-time
3284 :type '(choice (string :tag "Format string")
3285 (set (group :inline t (const :tag "Years" :years)
3286 (string :tag "Format string"))
3287 (group :inline t (const :tag "Months" :months)
3288 (string :tag "Format string"))
3289 (group :inline t (const :tag "Weeks" :weeks)
3290 (string :tag "Format string"))
3291 (group :inline t (const :tag "Days" :days)
3292 (string :tag "Format string"))
3293 (group :inline t (const :tag "Hours" :hours)
3294 (string :tag "Format string"))
3295 (group :inline t (const :tag "Minutes" :minutes)
3296 (string :tag "Format string")))))
3298 (defcustom org-deadline-warning-days 14
3299 "Number of days before expiration during which a deadline becomes active.
3300 This variable governs the display in sparse trees and in the agenda.
3301 When 0 or negative, it means use this number (the absolute value of it)
3302 even if a deadline has a different individual lead time specified.
3304 Custom commands can set this variable in the options section."
3305 :group 'org-time
3306 :group 'org-agenda-daily/weekly
3307 :type 'integer)
3309 (defcustom org-scheduled-delay-days 0
3310 "Number of days before a scheduled item becomes active.
3311 This variable governs the display in sparse trees and in the agenda.
3312 The default value (i.e. 0) means: don't delay scheduled item.
3313 When negative, it means use this number (the absolute value of it)
3314 even if a scheduled item has a different individual delay time
3315 specified.
3317 Custom commands can set this variable in the options section."
3318 :group 'org-time
3319 :group 'org-agenda-daily/weekly
3320 :version "24.4"
3321 :package-version '(Org . "8.0")
3322 :type 'integer)
3324 (defcustom org-read-date-prefer-future t
3325 "Non-nil means assume future for incomplete date input from user.
3326 This affects the following situations:
3327 1. The user gives a month but not a year.
3328 For example, if it is April and you enter \"feb 2\", this will be read
3329 as Feb 2, *next* year. \"May 5\", however, will be this year.
3330 2. The user gives a day, but no month.
3331 For example, if today is the 15th, and you enter \"3\", Org-mode will
3332 read this as the third of *next* month. However, if you enter \"17\",
3333 it will be considered as *this* month.
3335 If you set this variable to the symbol `time', then also the following
3336 will work:
3338 3. If the user gives a time.
3339 If the time is before now, it will be interpreted as tomorrow.
3341 Currently none of this works for ISO week specifications.
3343 When this option is nil, the current day, month and year will always be
3344 used as defaults.
3346 See also `org-agenda-jump-prefer-future'."
3347 :group 'org-time
3348 :type '(choice
3349 (const :tag "Never" nil)
3350 (const :tag "Check month and day" t)
3351 (const :tag "Check month, day, and time" time)))
3353 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3354 "Should the agenda jump command prefer the future for incomplete dates?
3355 The default is to do the same as configured in `org-read-date-prefer-future'.
3356 But you can also set a deviating value here.
3357 This may t or nil, or the symbol `org-read-date-prefer-future'."
3358 :group 'org-agenda
3359 :group 'org-time
3360 :version "24.1"
3361 :type '(choice
3362 (const :tag "Use org-read-date-prefer-future"
3363 org-read-date-prefer-future)
3364 (const :tag "Never" nil)
3365 (const :tag "Always" t)))
3367 (defcustom org-read-date-force-compatible-dates t
3368 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3370 Depending on the system Emacs is running on, certain dates cannot
3371 be represented with the type used internally to represent time.
3372 Dates between 1970-1-1 and 2038-1-1 can always be represented
3373 correctly. Some systems allow for earlier dates, some for later,
3374 some for both. One way to find out it to insert any date into an
3375 Org buffer, putting the cursor on the year and hitting S-up and
3376 S-down to test the range.
3378 When this variable is set to t, the date/time prompt will not let
3379 you specify dates outside the 1970-2037 range, so it is certain that
3380 these dates will work in whatever version of Emacs you are
3381 running, and also that you can move a file from one Emacs implementation
3382 to another. WHenever Org is forcing the year for you, it will display
3383 a message and beep.
3385 When this variable is nil, Org will check if the date is
3386 representable in the specific Emacs implementation you are using.
3387 If not, it will force a year, usually the current year, and beep
3388 to remind you. Currently this setting is not recommended because
3389 the likelihood that you will open your Org files in an Emacs that
3390 has limited date range is not negligible.
3392 A workaround for this problem is to use diary sexp dates for time
3393 stamps outside of this range."
3394 :group 'org-time
3395 :version "24.1"
3396 :type 'boolean)
3398 (defcustom org-read-date-display-live t
3399 "Non-nil means display current interpretation of date prompt live.
3400 This display will be in an overlay, in the minibuffer."
3401 :group 'org-time
3402 :type 'boolean)
3404 (defcustom org-read-date-popup-calendar t
3405 "Non-nil means pop up a calendar when prompting for a date.
3406 In the calendar, the date can be selected with mouse-1. However, the
3407 minibuffer will also be active, and you can simply enter the date as well.
3408 When nil, only the minibuffer will be available."
3409 :group 'org-time
3410 :type 'boolean)
3411 (org-defvaralias 'org-popup-calendar-for-date-prompt
3412 'org-read-date-popup-calendar)
3414 (make-obsolete-variable
3415 'org-read-date-minibuffer-setup-hook
3416 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3417 (defcustom org-read-date-minibuffer-setup-hook nil
3418 "Hook to be used to set up keys for the date/time interface.
3419 Add key definitions to `minibuffer-local-map', which will be a
3420 temporary copy.
3422 WARNING: This option is obsolete, you should use
3423 `org-read-date-minibuffer-local-map' to set up keys."
3424 :group 'org-time
3425 :type 'hook)
3427 (defcustom org-extend-today-until 0
3428 "The hour when your day really ends. Must be an integer.
3429 This has influence for the following applications:
3430 - When switching the agenda to \"today\". It it is still earlier than
3431 the time given here, the day recognized as TODAY is actually yesterday.
3432 - When a date is read from the user and it is still before the time given
3433 here, the current date and time will be assumed to be yesterday, 23:59.
3434 Also, timestamps inserted in capture templates follow this rule.
3436 IMPORTANT: This is a feature whose implementation is and likely will
3437 remain incomplete. Really, it is only here because past midnight seems to
3438 be the favorite working time of John Wiegley :-)"
3439 :group 'org-time
3440 :type 'integer)
3442 (defcustom org-use-effective-time nil
3443 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3444 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3445 \"effective time\" of any timestamps between midnight and 8am will be
3446 23:59 of the previous day."
3447 :group 'org-time
3448 :version "24.1"
3449 :type 'boolean)
3451 (defcustom org-use-last-clock-out-time-as-effective-time nil
3452 "When non-nil, use the last clock out time for `org-todo'.
3453 Note that this option has precedence over the combined use of
3454 `org-use-effective-time' and `org-extend-today-until'."
3455 :group 'org-time
3456 :version "24.4"
3457 :package-version '(Org . "8.0")
3458 :type 'boolean)
3460 (defcustom org-edit-timestamp-down-means-later nil
3461 "Non-nil means S-down will increase the time in a time stamp.
3462 When nil, S-up will increase."
3463 :group 'org-time
3464 :type 'boolean)
3466 (defcustom org-calendar-follow-timestamp-change t
3467 "Non-nil means make the calendar window follow timestamp changes.
3468 When a timestamp is modified and the calendar window is visible, it will be
3469 moved to the new date."
3470 :group 'org-time
3471 :type 'boolean)
3473 (defgroup org-tags nil
3474 "Options concerning tags in Org-mode."
3475 :tag "Org Tags"
3476 :group 'org)
3478 (defcustom org-tag-alist nil
3479 "List of tags allowed in Org-mode files.
3480 When this list is nil, Org-mode will base TAG input on what is already in the
3481 buffer.
3482 The value of this variable is an alist, the car of each entry must be a
3483 keyword as a string, the cdr may be a character that is used to select
3484 that tag through the fast-tag-selection interface.
3485 See the manual for details."
3486 :group 'org-tags
3487 :type '(repeat
3488 (choice
3489 (cons (string :tag "Tag name")
3490 (character :tag "Access char"))
3491 (list :tag "Start radio group"
3492 (const :startgroup)
3493 (option (string :tag "Group description")))
3494 (list :tag "Start tag group, non distinct"
3495 (const :startgrouptag)
3496 (option (string :tag "Group description")))
3497 (list :tag "Group tags delimiter"
3498 (const :grouptags))
3499 (list :tag "End radio group"
3500 (const :endgroup)
3501 (option (string :tag "Group description")))
3502 (list :tag "End tag group, non distinct"
3503 (const :endgrouptag)
3504 (option (string :tag "Group description")))
3505 (const :tag "New line" (:newline)))))
3507 (defcustom org-tag-persistent-alist nil
3508 "List of tags that will always appear in all Org-mode files.
3509 This is in addition to any in buffer settings or customizations
3510 of `org-tag-alist'.
3511 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3512 The value of this variable is an alist, the car of each entry must be a
3513 keyword as a string, the cdr may be a character that is used to select
3514 that tag through the fast-tag-selection interface.
3515 See the manual for details.
3516 To disable these tags on a per-file basis, insert anywhere in the file:
3517 #+STARTUP: noptag"
3518 :group 'org-tags
3519 :type '(repeat
3520 (choice
3521 (cons (string :tag "Tag name")
3522 (character :tag "Access char"))
3523 (const :tag "Start radio group" (:startgroup))
3524 (const :tag "Group tags delimiter" (:grouptags))
3525 (const :tag "End radio group" (:endgroup))
3526 (const :tag "New line" (:newline)))))
3528 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3529 "If non-nil, always offer completion for all tags of all agenda files.
3530 Instead of customizing this variable directly, you might want to
3531 set it locally for capture buffers, because there no list of
3532 tags in that file can be created dynamically (there are none).
3534 (add-hook \\='org-capture-mode-hook
3535 (lambda ()
3536 (set (make-local-variable
3537 \\='org-complete-tags-always-offer-all-agenda-tags)
3538 t)))"
3539 :group 'org-tags
3540 :version "24.1"
3541 :type 'boolean)
3543 (defvar org-file-tags nil
3544 "List of tags that can be inherited by all entries in the file.
3545 The tags will be inherited if the variable `org-use-tag-inheritance'
3546 says they should be.
3547 This variable is populated from #+FILETAGS lines.")
3549 (defcustom org-use-fast-tag-selection 'auto
3550 "Non-nil means use fast tag selection scheme.
3551 This is a special interface to select and deselect tags with single keys.
3552 When nil, fast selection is never used.
3553 When the symbol `auto', fast selection is used if and only if selection
3554 characters for tags have been configured, either through the variable
3555 `org-tag-alist' or through a #+TAGS line in the buffer.
3556 When t, fast selection is always used and selection keys are assigned
3557 automatically if necessary."
3558 :group 'org-tags
3559 :type '(choice
3560 (const :tag "Always" t)
3561 (const :tag "Never" nil)
3562 (const :tag "When selection characters are configured" auto)))
3564 (defcustom org-fast-tag-selection-single-key nil
3565 "Non-nil means fast tag selection exits after first change.
3566 When nil, you have to press RET to exit it.
3567 During fast tag selection, you can toggle this flag with `C-c'.
3568 This variable can also have the value `expert'. In this case, the window
3569 displaying the tags menu is not even shown, until you press C-c again."
3570 :group 'org-tags
3571 :type '(choice
3572 (const :tag "No" nil)
3573 (const :tag "Yes" t)
3574 (const :tag "Expert" expert)))
3576 (defvar org-fast-tag-selection-include-todo nil
3577 "Non-nil means fast tags selection interface will also offer TODO states.
3578 This is an undocumented feature, you should not rely on it.")
3580 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3581 "The column to which tags should be indented in a headline.
3582 If this number is positive, it specifies the column. If it is negative,
3583 it means that the tags should be flushright to that column. For example,
3584 -80 works well for a normal 80 character screen.
3585 When 0, place tags directly after headline text, with only one space in
3586 between."
3587 :group 'org-tags
3588 :type 'integer)
3590 (defcustom org-auto-align-tags t
3591 "Non-nil keeps tags aligned when modifying headlines.
3592 Some operations (i.e. demoting) change the length of a headline and
3593 therefore shift the tags around. With this option turned on, after
3594 each such operation the tags are again aligned to `org-tags-column'."
3595 :group 'org-tags
3596 :type 'boolean)
3598 (defcustom org-use-tag-inheritance t
3599 "Non-nil means tags in levels apply also for sublevels.
3600 When nil, only the tags directly given in a specific line apply there.
3601 This may also be a list of tags that should be inherited, or a regexp that
3602 matches tags that should be inherited. Additional control is possible
3603 with the variable `org-tags-exclude-from-inheritance' which gives an
3604 explicit list of tags to be excluded from inheritance, even if the value of
3605 `org-use-tag-inheritance' would select it for inheritance.
3607 If this option is t, a match early-on in a tree can lead to a large
3608 number of matches in the subtree when constructing the agenda or creating
3609 a sparse tree. If you only want to see the first match in a tree during
3610 a search, check out the variable `org-tags-match-list-sublevels'."
3611 :group 'org-tags
3612 :type '(choice
3613 (const :tag "Not" nil)
3614 (const :tag "Always" t)
3615 (repeat :tag "Specific tags" (string :tag "Tag"))
3616 (regexp :tag "Tags matched by regexp")))
3618 (defcustom org-tags-exclude-from-inheritance nil
3619 "List of tags that should never be inherited.
3620 This is a way to exclude a few tags from inheritance. For way to do
3621 the opposite, to actively allow inheritance for selected tags,
3622 see the variable `org-use-tag-inheritance'."
3623 :group 'org-tags
3624 :type '(repeat (string :tag "Tag")))
3626 (defun org-tag-inherit-p (tag)
3627 "Check if TAG is one that should be inherited."
3628 (cond
3629 ((member tag org-tags-exclude-from-inheritance) nil)
3630 ((eq org-use-tag-inheritance t) t)
3631 ((not org-use-tag-inheritance) nil)
3632 ((stringp org-use-tag-inheritance)
3633 (string-match org-use-tag-inheritance tag))
3634 ((listp org-use-tag-inheritance)
3635 (member tag org-use-tag-inheritance))
3636 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3638 (defcustom org-tags-match-list-sublevels t
3639 "Non-nil means list also sublevels of headlines matching a search.
3640 This variable applies to tags/property searches, and also to stuck
3641 projects because this search is based on a tags match as well.
3643 When set to the symbol `indented', sublevels are indented with
3644 leading dots.
3646 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3647 the sublevels of a headline matching a tag search often also match
3648 the same search. Listing all of them can create very long lists.
3649 Setting this variable to nil causes subtrees of a match to be skipped.
3651 This variable is semi-obsolete and probably should always be true. It
3652 is better to limit inheritance to certain tags using the variables
3653 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3654 :group 'org-tags
3655 :type '(choice
3656 (const :tag "No, don't list them" nil)
3657 (const :tag "Yes, do list them" t)
3658 (const :tag "List them, indented with leading dots" indented)))
3660 (defcustom org-tags-sort-function nil
3661 "When set, tags are sorted using this function as a comparator."
3662 :group 'org-tags
3663 :type '(choice
3664 (const :tag "No sorting" nil)
3665 (const :tag "Alphabetical" string<)
3666 (const :tag "Reverse alphabetical" string>)
3667 (function :tag "Custom function" nil)))
3669 (defvar org-tags-history nil
3670 "History of minibuffer reads for tags.")
3671 (defvar org-last-tags-completion-table nil
3672 "The last used completion table for tags.")
3673 (defvar org-after-tags-change-hook nil
3674 "Hook that is run after the tags in a line have changed.")
3676 (defgroup org-properties nil
3677 "Options concerning properties in Org-mode."
3678 :tag "Org Properties"
3679 :group 'org)
3681 (defcustom org-property-format "%-10s %s"
3682 "How property key/value pairs should be formatted by `indent-line'.
3683 When `indent-line' hits a property definition, it will format the line
3684 according to this format, mainly to make sure that the values are
3685 lined-up with respect to each other."
3686 :group 'org-properties
3687 :type 'string)
3689 (defcustom org-properties-postprocess-alist nil
3690 "Alist of properties and functions to adjust inserted values.
3691 Elements of this alist must be of the form
3693 ([string] [function])
3695 where [string] must be a property name and [function] must be a
3696 lambda expression: this lambda expression must take one argument,
3697 the value to adjust, and return the new value as a string.
3699 For example, this element will allow the property \"Remaining\"
3700 to be updated wrt the relation between the \"Effort\" property
3701 and the clock summary:
3703 ((\"Remaining\" (lambda(value)
3704 (let ((clocksum (org-clock-sum-current-item))
3705 (effort (org-duration-string-to-minutes
3706 (org-entry-get (point) \"Effort\"))))
3707 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3708 :group 'org-properties
3709 :version "24.1"
3710 :type '(alist :key-type (string :tag "Property")
3711 :value-type (function :tag "Function")))
3713 (defcustom org-use-property-inheritance nil
3714 "Non-nil means properties apply also for sublevels.
3716 This setting is chiefly used during property searches. Turning it on can
3717 cause significant overhead when doing a search, which is why it is not
3718 on by default.
3720 When nil, only the properties directly given in the current entry count.
3721 When t, every property is inherited. The value may also be a list of
3722 properties that should have inheritance, or a regular expression matching
3723 properties that should be inherited.
3725 However, note that some special properties use inheritance under special
3726 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3727 and the properties ending in \"_ALL\" when they are used as descriptor
3728 for valid values of a property.
3730 Note for programmers:
3731 When querying an entry with `org-entry-get', you can control if inheritance
3732 should be used. By default, `org-entry-get' looks only at the local
3733 properties. You can request inheritance by setting the inherit argument
3734 to t (to force inheritance) or to `selective' (to respect the setting
3735 in this variable)."
3736 :group 'org-properties
3737 :type '(choice
3738 (const :tag "Not" nil)
3739 (const :tag "Always" t)
3740 (repeat :tag "Specific properties" (string :tag "Property"))
3741 (regexp :tag "Properties matched by regexp")))
3743 (defun org-property-inherit-p (property)
3744 "Check if PROPERTY is one that should be inherited."
3745 (cond
3746 ((eq org-use-property-inheritance t) t)
3747 ((not org-use-property-inheritance) nil)
3748 ((stringp org-use-property-inheritance)
3749 (string-match org-use-property-inheritance property))
3750 ((listp org-use-property-inheritance)
3751 (member property org-use-property-inheritance))
3752 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3754 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3755 "The default column format, if no other format has been defined.
3756 This variable can be set on the per-file basis by inserting a line
3758 #+COLUMNS: %25ITEM ....."
3759 :group 'org-properties
3760 :type 'string)
3762 (defcustom org-columns-ellipses ".."
3763 "The ellipses to be used when a field in column view is truncated.
3764 When this is the empty string, as many characters as possible are shown,
3765 but then there will be no visual indication that the field has been truncated.
3766 When this is a string of length N, the last N characters of a truncated
3767 field are replaced by this string. If the column is narrower than the
3768 ellipses string, only part of the ellipses string will be shown."
3769 :group 'org-properties
3770 :type 'string)
3772 (defcustom org-columns-modify-value-for-display-function nil
3773 "Function that modifies values for display in column view.
3774 For example, it can be used to cut out a certain part from a time stamp.
3775 The function must take 2 arguments:
3777 column-title The title of the column (*not* the property name)
3778 value The value that should be modified.
3780 The function should return the value that should be displayed,
3781 or nil if the normal value should be used."
3782 :group 'org-properties
3783 :type '(choice (const nil) (function)))
3785 (defconst org-global-properties-fixed
3786 '(("VISIBILITY_ALL" . "folded children content all")
3787 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3788 "List of property/value pairs that can be inherited by any entry.
3790 These are fixed values, for the preset properties. The user variable
3791 that can be used to add to this list is `org-global-properties'.
3793 The entries in this list are cons cells where the car is a property
3794 name and cdr is a string with the value. If the value represents
3795 multiple items like an \"_ALL\" property, separate the items by
3796 spaces.")
3798 (defcustom org-global-properties nil
3799 "List of property/value pairs that can be inherited by any entry.
3801 This list will be combined with the constant `org-global-properties-fixed'.
3803 The entries in this list are cons cells where the car is a property
3804 name and cdr is a string with the value.
3806 You can set buffer-local values for the same purpose in the variable
3807 `org-file-properties' this by adding lines like
3809 #+PROPERTY: NAME VALUE"
3810 :group 'org-properties
3811 :type '(repeat
3812 (cons (string :tag "Property")
3813 (string :tag "Value"))))
3815 (defvar org-file-properties nil
3816 "List of property/value pairs that can be inherited by any entry.
3817 Valid for the current buffer.
3818 This variable is populated from #+PROPERTY lines.")
3819 (make-variable-buffer-local 'org-file-properties)
3821 (defgroup org-agenda nil
3822 "Options concerning agenda views in Org-mode."
3823 :tag "Org Agenda"
3824 :group 'org)
3826 (defvar org-category nil
3827 "Variable used by org files to set a category for agenda display.
3828 Such files should use a file variable to set it, for example
3830 # -*- mode: org; org-category: \"ELisp\"
3832 or contain a special line
3834 #+CATEGORY: ELisp
3836 If the file does not specify a category, then file's base name
3837 is used instead.")
3838 (make-variable-buffer-local 'org-category)
3839 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3841 (defcustom org-agenda-files nil
3842 "The files to be used for agenda display.
3843 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3844 \\[org-remove-file]. You can also use customize to edit the list.
3846 If an entry is a directory, all files in that directory that are matched by
3847 `org-agenda-file-regexp' will be part of the file list.
3849 If the value of the variable is not a list but a single file name, then
3850 the list of agenda files is actually stored and maintained in that file, one
3851 agenda file per line. In this file paths can be given relative to
3852 `org-directory'. Tilde expansion and environment variable substitution
3853 are also made."
3854 :group 'org-agenda
3855 :type '(choice
3856 (repeat :tag "List of files and directories" file)
3857 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3859 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3860 "Regular expression to match files for `org-agenda-files'.
3861 If any element in the list in that variable contains a directory instead
3862 of a normal file, all files in that directory that are matched by this
3863 regular expression will be included."
3864 :group 'org-agenda
3865 :type 'regexp)
3867 (defcustom org-agenda-text-search-extra-files nil
3868 "List of extra files to be searched by text search commands.
3869 These files will be searched in addition to the agenda files by the
3870 commands `org-search-view' (`\\[org-agenda] s') \
3871 and `org-occur-in-agenda-files'.
3872 Note that these files will only be searched for text search commands,
3873 not for the other agenda views like todo lists, tag searches or the weekly
3874 agenda. This variable is intended to list notes and possibly archive files
3875 that should also be searched by these two commands.
3876 In fact, if the first element in the list is the symbol `agenda-archives',
3877 then all archive files of all agenda files will be added to the search
3878 scope."
3879 :group 'org-agenda
3880 :type '(set :greedy t
3881 (const :tag "Agenda Archives" agenda-archives)
3882 (repeat :inline t (file))))
3884 (org-defvaralias 'org-agenda-multi-occur-extra-files
3885 'org-agenda-text-search-extra-files)
3887 (defcustom org-agenda-skip-unavailable-files nil
3888 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3889 A nil value means to remove them, after a query, from the list."
3890 :group 'org-agenda
3891 :type 'boolean)
3893 (defcustom org-calendar-to-agenda-key [?c]
3894 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3895 The command `org-calendar-goto-agenda' will be bound to this key. The
3896 default is the character `c' because then `c' can be used to switch back and
3897 forth between agenda and calendar."
3898 :group 'org-agenda
3899 :type 'sexp)
3901 (defcustom org-calendar-insert-diary-entry-key [?i]
3902 "The key to be installed in `calendar-mode-map' for adding diary entries.
3903 This option is irrelevant until `org-agenda-diary-file' has been configured
3904 to point to an Org-mode file. When that is the case, the command
3905 `org-agenda-diary-entry' will be bound to the key given here, by default
3906 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3907 if you want to continue doing this, you need to change this to a different
3908 key."
3909 :group 'org-agenda
3910 :type 'sexp)
3912 (defcustom org-agenda-diary-file 'diary-file
3913 "File to which to add new entries with the `i' key in agenda and calendar.
3914 When this is the symbol `diary-file', the functionality in the Emacs
3915 calendar will be used to add entries to the `diary-file'. But when this
3916 points to a file, `org-agenda-diary-entry' will be used instead."
3917 :group 'org-agenda
3918 :type '(choice
3919 (const :tag "The standard Emacs diary file" diary-file)
3920 (file :tag "Special Org file diary entries")))
3922 (eval-after-load "calendar"
3923 '(progn
3924 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3925 'org-calendar-goto-agenda)
3926 (add-hook 'calendar-mode-hook
3927 (lambda ()
3928 (unless (eq org-agenda-diary-file 'diary-file)
3929 (define-key calendar-mode-map
3930 org-calendar-insert-diary-entry-key
3931 'org-agenda-diary-entry))))))
3933 (defgroup org-latex nil
3934 "Options for embedding LaTeX code into Org-mode."
3935 :tag "Org LaTeX"
3936 :group 'org)
3938 (defcustom org-format-latex-options
3939 '(:foreground default :background default :scale 1.0
3940 :html-foreground "Black" :html-background "Transparent"
3941 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3942 "Options for creating images from LaTeX fragments.
3943 This is a property list with the following properties:
3944 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3945 `default' means use the foreground of the default face.
3946 `auto' means use the foreground from the text face.
3947 :background the background color, or \"Transparent\".
3948 `default' means use the background of the default face.
3949 `auto' means use the background from the text face.
3950 :scale a scaling factor for the size of the images, to get more pixels
3951 :html-foreground, :html-background, :html-scale
3952 the same numbers for HTML export.
3953 :matchers a list indicating which matchers should be used to
3954 find LaTeX fragments. Valid members of this list are:
3955 \"begin\" find environments
3956 \"$1\" find single characters surrounded by $.$
3957 \"$\" find math expressions surrounded by $...$
3958 \"$$\" find math expressions surrounded by $$....$$
3959 \"\\(\" find math expressions surrounded by \\(...\\)
3960 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3961 :group 'org-latex
3962 :type 'plist)
3964 (defcustom org-format-latex-signal-error t
3965 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3966 When nil, just push out a message."
3967 :group 'org-latex
3968 :version "24.1"
3969 :type 'boolean)
3971 (defcustom org-latex-to-mathml-jar-file nil
3972 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3973 Use this to specify additional executable file say a jar file.
3975 When using MathToWeb as the converter, specify the full-path to
3976 your mathtoweb.jar file."
3977 :group 'org-latex
3978 :version "24.1"
3979 :type '(choice
3980 (const :tag "None" nil)
3981 (file :tag "JAR file" :must-match t)))
3983 (defcustom org-latex-to-mathml-convert-command nil
3984 "Command to convert LaTeX fragments to MathML.
3985 Replace format-specifiers in the command as noted below and use
3986 `shell-command' to convert LaTeX to MathML.
3987 %j: Executable file in fully expanded form as specified by
3988 `org-latex-to-mathml-jar-file'.
3989 %I: Input LaTeX file in fully expanded form.
3990 %i: The latex fragment to be converted.
3991 %o: Output MathML file.
3993 This command is used by `org-create-math-formula'.
3995 When using MathToWeb as the converter, set this option to
3996 \"java -jar %j -unicode -force -df %o %I\".
3998 When using LaTeXML set this option to
3999 \"latexmlmath \"%i\" --presentationmathml=%o\"."
4000 :group 'org-latex
4001 :version "24.1"
4002 :type '(choice
4003 (const :tag "None" nil)
4004 (string :tag "\nShell command")))
4006 (defcustom org-latex-create-formula-image-program 'dvipng
4007 "Program to convert LaTeX fragments with.
4009 dvipng Process the LaTeX fragments to dvi file, then convert
4010 dvi files to png files using dvipng.
4011 This will also include processing of non-math environments.
4012 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
4013 to convert pdf files to png files"
4014 :group 'org-latex
4015 :version "24.1"
4016 :type '(choice
4017 (const :tag "dvipng" dvipng)
4018 (const :tag "imagemagick" imagemagick)))
4020 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4021 "Path to store latex preview images.
4022 A relative path here creates many directories relative to the
4023 processed org files paths. An absolute path puts all preview
4024 images at the same place."
4025 :group 'org-latex
4026 :version "24.3"
4027 :type 'string)
4029 (defun org-format-latex-mathml-available-p ()
4030 "Return t if `org-latex-to-mathml-convert-command' is usable."
4031 (save-match-data
4032 (when (and (boundp 'org-latex-to-mathml-convert-command)
4033 org-latex-to-mathml-convert-command)
4034 (let ((executable (car (split-string
4035 org-latex-to-mathml-convert-command))))
4036 (when (executable-find executable)
4037 (if (string-match
4038 "%j" org-latex-to-mathml-convert-command)
4039 (file-readable-p org-latex-to-mathml-jar-file)
4040 t))))))
4042 (defcustom org-format-latex-header "\\documentclass{article}
4043 \\usepackage[usenames]{color}
4044 [PACKAGES]
4045 [DEFAULT-PACKAGES]
4046 \\pagestyle{empty} % do not remove
4047 % The settings below are copied from fullpage.sty
4048 \\setlength{\\textwidth}{\\paperwidth}
4049 \\addtolength{\\textwidth}{-3cm}
4050 \\setlength{\\oddsidemargin}{1.5cm}
4051 \\addtolength{\\oddsidemargin}{-2.54cm}
4052 \\setlength{\\evensidemargin}{\\oddsidemargin}
4053 \\setlength{\\textheight}{\\paperheight}
4054 \\addtolength{\\textheight}{-\\headheight}
4055 \\addtolength{\\textheight}{-\\headsep}
4056 \\addtolength{\\textheight}{-\\footskip}
4057 \\addtolength{\\textheight}{-3cm}
4058 \\setlength{\\topmargin}{1.5cm}
4059 \\addtolength{\\topmargin}{-2.54cm}"
4060 "The document header used for processing LaTeX fragments.
4061 It is imperative that this header make sure that no page number
4062 appears on the page. The package defined in the variables
4063 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4064 will either replace the placeholder \"[PACKAGES]\" in this
4065 header, or they will be appended."
4066 :group 'org-latex
4067 :type 'string)
4069 (defun org-set-packages-alist (var val)
4070 "Set the packages alist and make sure it has 3 elements per entry."
4071 (set var (mapcar (lambda (x)
4072 (if (and (consp x) (= (length x) 2))
4073 (list (car x) (nth 1 x) t)
4075 val)))
4077 (defun org-get-packages-alist (var)
4078 "Get the packages alist and make sure it has 3 elements per entry."
4079 (mapcar (lambda (x)
4080 (if (and (consp x) (= (length x) 2))
4081 (list (car x) (nth 1 x) t)
4083 (default-value var)))
4085 (defcustom org-latex-default-packages-alist
4086 '(("AUTO" "inputenc" t)
4087 ("T1" "fontenc" t)
4088 ("" "fixltx2e" nil)
4089 ("" "graphicx" t)
4090 ("" "grffile" t)
4091 ("" "longtable" nil)
4092 ("" "wrapfig" nil)
4093 ("" "rotating" nil)
4094 ("normalem" "ulem" t)
4095 ("" "amsmath" t)
4096 ("" "textcomp" t)
4097 ("" "amssymb" t)
4098 ("" "capt-of" nil)
4099 ("" "hyperref" nil))
4100 "Alist of default packages to be inserted in the header.
4102 Change this only if one of the packages here causes an
4103 incompatibility with another package you are using.
4105 The packages in this list are needed by one part or another of
4106 Org mode to function properly:
4108 - inputenc, fontenc: for basic font and character selection
4109 - fixltx2e: Important patches of LaTeX itself
4110 - graphicx: for including images
4111 - grffile: allow periods and spaces in graphics file names
4112 - longtable: For multipage tables
4113 - wrapfig: for figure placement
4114 - rotating: for sideways figures and tables
4115 - ulem: for underline and strike-through
4116 - amsmath: for subscript and superscript and math environments
4117 - textcomp, amssymb: for various symbols used
4118 for interpreting the entities in `org-entities'. You can skip
4119 some of these packages if you don't use any of their symbols.
4120 - capt-of: for captions outside of floats
4121 - hyperref: for cross references
4123 Therefore you should not modify this variable unless you know
4124 what you are doing. The one reason to change it anyway is that
4125 you might be loading some other package that conflicts with one
4126 of the default packages. Each element is either a cell or
4127 a string.
4129 A cell is of the format
4131 (\"options\" \"package\" SNIPPET-FLAG)
4133 If SNIPPET-FLAG is non-nil, the package also needs to be included
4134 when compiling LaTeX snippets into images for inclusion into
4135 non-LaTeX output.
4137 A string will be inserted as-is in the header of the document."
4138 :group 'org-latex
4139 :group 'org-export-latex
4140 :set 'org-set-packages-alist
4141 :get 'org-get-packages-alist
4142 :version "25.1"
4143 :package-version '(Org . "8.3")
4144 :type '(repeat
4145 (choice
4146 (list :tag "options/package pair"
4147 (string :tag "options")
4148 (string :tag "package")
4149 (boolean :tag "Snippet"))
4150 (string :tag "A line of LaTeX"))))
4152 (defcustom org-latex-packages-alist nil
4153 "Alist of packages to be inserted in every LaTeX header.
4155 These will be inserted after `org-latex-default-packages-alist'.
4156 Each element is either a cell or a string.
4158 A cell is of the format:
4160 (\"options\" \"package\" SNIPPET-FLAG)
4162 SNIPPET-FLAG, when non-nil, indicates that this package is also
4163 needed when turning LaTeX snippets into images for inclusion into
4164 non-LaTeX output.
4166 A string will be inserted as-is in the header of the document.
4168 Make sure that you only list packages here which:
4170 - you want in every file;
4171 - do not conflict with the setup in `org-format-latex-header';
4172 - do not conflict with the default packages in
4173 `org-latex-default-packages-alist'."
4174 :group 'org-latex
4175 :group 'org-export-latex
4176 :set 'org-set-packages-alist
4177 :get 'org-get-packages-alist
4178 :type '(repeat
4179 (choice
4180 (list :tag "options/package pair"
4181 (string :tag "options")
4182 (string :tag "package")
4183 (boolean :tag "Snippet"))
4184 (string :tag "A line of LaTeX"))))
4186 (defgroup org-appearance nil
4187 "Settings for Org-mode appearance."
4188 :tag "Org Appearance"
4189 :group 'org)
4191 (defcustom org-level-color-stars-only nil
4192 "Non-nil means fontify only the stars in each headline.
4193 When nil, the entire headline is fontified.
4194 Changing it requires restart of `font-lock-mode' to become effective
4195 also in regions already fontified."
4196 :group 'org-appearance
4197 :type 'boolean)
4199 (defcustom org-hide-leading-stars nil
4200 "Non-nil means hide the first N-1 stars in a headline.
4201 This works by using the face `org-hide' for these stars. This
4202 face is white for a light background, and black for a dark
4203 background. You may have to customize the face `org-hide' to
4204 make this work.
4205 Changing it requires restart of `font-lock-mode' to become effective
4206 also in regions already fontified.
4207 You may also set this on a per-file basis by adding one of the following
4208 lines to the buffer:
4210 #+STARTUP: hidestars
4211 #+STARTUP: showstars"
4212 :group 'org-appearance
4213 :type 'boolean)
4215 (defcustom org-hidden-keywords nil
4216 "List of symbols corresponding to keywords to be hidden the org buffer.
4217 For example, a value \\='(title) for this list will make the document's title
4218 appear in the buffer without the initial #+TITLE: keyword."
4219 :group 'org-appearance
4220 :version "24.1"
4221 :type '(set (const :tag "#+AUTHOR" author)
4222 (const :tag "#+DATE" date)
4223 (const :tag "#+EMAIL" email)
4224 (const :tag "#+TITLE" title)))
4226 (defcustom org-custom-properties nil
4227 "List of properties (as strings) with a special meaning.
4228 The default use of these custom properties is to let the user
4229 hide them with `org-toggle-custom-properties-visibility'."
4230 :group 'org-properties
4231 :group 'org-appearance
4232 :version "24.3"
4233 :type '(repeat (string :tag "Property Name")))
4235 (defcustom org-fontify-done-headline nil
4236 "Non-nil means change the face of a headline if it is marked DONE.
4237 Normally, only the TODO/DONE keyword indicates the state of a headline.
4238 When this is non-nil, the headline after the keyword is set to the
4239 `org-headline-done' as an additional indication."
4240 :group 'org-appearance
4241 :type 'boolean)
4243 (defcustom org-fontify-emphasized-text t
4244 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4245 Changing this variable requires a restart of Emacs to take effect."
4246 :group 'org-appearance
4247 :type 'boolean)
4249 (defcustom org-fontify-whole-heading-line nil
4250 "Non-nil means fontify the whole line for headings.
4251 This is useful when setting a background color for the
4252 org-level-* faces."
4253 :group 'org-appearance
4254 :type 'boolean)
4256 (defcustom org-highlight-latex-and-related nil
4257 "Non-nil means highlight LaTeX related syntax in the buffer.
4258 When non nil, the value should be a list containing any of the
4259 following symbols:
4260 `latex' Highlight LaTeX snippets and environments.
4261 `script' Highlight subscript and superscript.
4262 `entities' Highlight entities."
4263 :group 'org-appearance
4264 :version "24.4"
4265 :package-version '(Org . "8.0")
4266 :type '(choice
4267 (const :tag "No highlighting" nil)
4268 (set :greedy t :tag "Highlight"
4269 (const :tag "LaTeX snippets and environments" latex)
4270 (const :tag "Subscript and superscript" script)
4271 (const :tag "Entities" entities))))
4273 (defcustom org-hide-emphasis-markers nil
4274 "Non-nil mean font-lock should hide the emphasis marker characters."
4275 :group 'org-appearance
4276 :type 'boolean)
4278 (defcustom org-hide-macro-markers nil
4279 "Non-nil mean font-lock should hide the brackets marking macro calls."
4280 :group 'org-appearance
4281 :type 'boolean)
4283 (defcustom org-pretty-entities nil
4284 "Non-nil means show entities as UTF8 characters.
4285 When nil, the \\name form remains in the buffer."
4286 :group 'org-appearance
4287 :version "24.1"
4288 :type 'boolean)
4290 (defcustom org-pretty-entities-include-sub-superscripts t
4291 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4292 :group 'org-appearance
4293 :version "24.1"
4294 :type 'boolean)
4296 (defvar org-emph-re nil
4297 "Regular expression for matching emphasis.
4298 After a match, the match groups contain these elements:
4299 0 The match of the full regular expression, including the characters
4300 before and after the proper match
4301 1 The character before the proper match, or empty at beginning of line
4302 2 The proper match, including the leading and trailing markers
4303 3 The leading marker like * or /, indicating the type of highlighting
4304 4 The text between the emphasis markers, not including the markers
4305 5 The character after the match, empty at the end of a line")
4306 (defvar org-verbatim-re nil
4307 "Regular expression for matching verbatim text.")
4308 (defvar org-emphasis-regexp-components) ; defined just below
4309 (defvar org-emphasis-alist) ; defined just below
4310 (defun org-set-emph-re (var val)
4311 "Set variable and compute the emphasis regular expression."
4312 (set var val)
4313 (when (and (boundp 'org-emphasis-alist)
4314 (boundp 'org-emphasis-regexp-components)
4315 org-emphasis-alist org-emphasis-regexp-components)
4316 (let* ((e org-emphasis-regexp-components)
4317 (pre (car e))
4318 (post (nth 1 e))
4319 (border (nth 2 e))
4320 (body (nth 3 e))
4321 (nl (nth 4 e))
4322 (body1 (concat body "*?"))
4323 (markers (mapconcat 'car org-emphasis-alist ""))
4324 (vmarkers (mapconcat
4325 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4326 org-emphasis-alist "")))
4327 ;; make sure special characters appear at the right position in the class
4328 (if (string-match "\\^" markers)
4329 (setq markers (concat (replace-match "" t t markers) "^")))
4330 (if (string-match "-" markers)
4331 (setq markers (concat (replace-match "" t t markers) "-")))
4332 (if (string-match "\\^" vmarkers)
4333 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4334 (if (string-match "-" vmarkers)
4335 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4336 (if (> nl 0)
4337 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4338 (int-to-string nl) "\\}")))
4339 ;; Make the regexp
4340 (setq org-emph-re
4341 (concat "\\([" pre "]\\|^\\)"
4342 "\\("
4343 "\\([" markers "]\\)"
4344 "\\("
4345 "[^" border "]\\|"
4346 "[^" border "]"
4347 body1
4348 "[^" border "]"
4349 "\\)"
4350 "\\3\\)"
4351 "\\([" post "]\\|$\\)"))
4352 (setq org-verbatim-re
4353 (concat "\\([" pre "]\\|^\\)"
4354 "\\("
4355 "\\([" vmarkers "]\\)"
4356 "\\("
4357 "[^" border "]\\|"
4358 "[^" border "]"
4359 body1
4360 "[^" border "]"
4361 "\\)"
4362 "\\3\\)"
4363 "\\([" post "]\\|$\\)")))))
4365 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4366 ;; set this option proved cumbersome. See this message/thread:
4367 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4368 (defvar org-emphasis-regexp-components
4369 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4370 "Components used to build the regular expression for emphasis.
4371 This is a list with five entries. Terminology: In an emphasis string
4372 like \" *strong word* \", we call the initial space PREMATCH, the final
4373 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4374 and \"trong wor\" is the body. The different components in this variable
4375 specify what is allowed/forbidden in each part:
4377 pre Chars allowed as prematch. Beginning of line will be allowed too.
4378 post Chars allowed as postmatch. End of line will be allowed too.
4379 border The chars *forbidden* as border characters.
4380 body-regexp A regexp like \".\" to match a body character. Don't use
4381 non-shy groups here, and don't allow newline here.
4382 newline The maximum number of newlines allowed in an emphasis exp.
4384 You need to reload Org or to restart Emacs after customizing this.")
4386 (defcustom org-emphasis-alist
4387 `(("*" bold)
4388 ("/" italic)
4389 ("_" underline)
4390 ("=" org-verbatim verbatim)
4391 ("~" org-code verbatim)
4392 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4393 "Alist of characters and faces to emphasize text.
4394 Text starting and ending with a special character will be emphasized,
4395 for example *bold*, _underlined_ and /italic/. This variable sets the
4396 marker characters and the face to be used by font-lock for highlighting
4397 in Org-mode Emacs buffers.
4399 You need to reload Org or to restart Emacs after customizing this."
4400 :group 'org-appearance
4401 :set 'org-set-emph-re
4402 :version "24.4"
4403 :package-version '(Org . "8.0")
4404 :type '(repeat
4405 (list
4406 (string :tag "Marker character")
4407 (choice
4408 (face :tag "Font-lock-face")
4409 (plist :tag "Face property list"))
4410 (option (const verbatim)))))
4412 (defvar org-protecting-blocks
4413 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4414 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4415 This is needed for font-lock setup.")
4417 ;;; Miscellaneous options
4419 (defgroup org-completion nil
4420 "Completion in Org-mode."
4421 :tag "Org Completion"
4422 :group 'org)
4424 (defcustom org-completion-use-ido nil
4425 "Non-nil means use ido completion wherever possible.
4426 Note that `ido-mode' must be active for this variable to be relevant.
4427 If you decide to turn this variable on, you might well want to turn off
4428 `org-outline-path-complete-in-steps'.
4429 See also `org-completion-use-iswitchb'."
4430 :group 'org-completion
4431 :type 'boolean)
4433 (defcustom org-completion-use-iswitchb nil
4434 "Non-nil means use iswitchb completion wherever possible.
4435 Note that `iswitchb-mode' must be active for this variable to be relevant.
4436 If you decide to turn this variable on, you might well want to turn off
4437 `org-outline-path-complete-in-steps'.
4438 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4439 :group 'org-completion
4440 :type 'boolean)
4442 (defcustom org-completion-fallback-command 'hippie-expand
4443 "The expansion command called by \\[pcomplete] in normal context.
4444 Normal means, no org-mode-specific context."
4445 :group 'org-completion
4446 :type 'function)
4448 ;;; Functions and variables from their packages
4449 ;; Declared here to avoid compiler warnings
4451 ;; XEmacs only
4452 (defvar outline-mode-menu-heading)
4453 (defvar outline-mode-menu-show)
4454 (defvar outline-mode-menu-hide)
4455 (defvar zmacs-regions) ; XEmacs regions
4457 ;; Emacs only
4458 (defvar mark-active)
4460 ;; Various packages
4461 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4462 (declare-function calendar-forward-day "cal-move" (arg))
4463 (declare-function calendar-goto-date "cal-move" (date))
4464 (declare-function calendar-goto-today "cal-move" ())
4465 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4466 (defvar calc-embedded-close-formula)
4467 (defvar calc-embedded-open-formula)
4468 (declare-function cdlatex-tab "ext:cdlatex" ())
4469 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4470 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4471 (defvar font-lock-unfontify-region-function)
4472 (declare-function iswitchb-read-buffer "iswitchb"
4473 (prompt &optional default require-match start matches-set))
4474 (defvar iswitchb-temp-buflist)
4475 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4476 (defvar org-agenda-tags-todo-honor-ignore-options)
4477 (declare-function org-agenda-skip "org-agenda" ())
4478 (declare-function
4479 org-agenda-format-item "org-agenda"
4480 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4481 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4482 (declare-function org-agenda-change-all-lines "org-agenda"
4483 (newhead hdmarker &optional fixface just-this))
4484 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4485 (declare-function org-agenda-maybe-redo "org-agenda" ())
4486 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4487 (beg end))
4488 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4489 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4490 "org-agenda" (&optional end))
4491 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4492 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4493 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4494 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4495 (declare-function org-indent-mode "org-indent" (&optional arg))
4496 (declare-function parse-time-string "parse-time" (string))
4497 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4498 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4499 (defvar remember-data-file)
4500 (defvar texmathp-why)
4501 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4502 (declare-function table--at-cell-p "table" (position &optional object at-column))
4503 (declare-function calc-eval "calc" (str &optional separator &rest args))
4505 ;;;###autoload
4506 (defun turn-on-orgtbl ()
4507 "Unconditionally turn on `orgtbl-mode'."
4508 (require 'org-table)
4509 (orgtbl-mode 1))
4511 (defun org-at-table-p (&optional table-type)
4512 "Non-nil if the cursor is inside an Org table.
4513 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4514 If `org-enable-table-editor' is nil, return nil unconditionally."
4515 (and
4516 org-enable-table-editor
4517 (save-excursion
4518 (beginning-of-line)
4519 (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4520 (or (not (derived-mode-p 'org-mode))
4521 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4522 (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4523 (defsubst org-table-p () (org-at-table-p))
4525 (defun org-at-table.el-p ()
4526 "Non-nil when point is at a table.el table."
4527 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4528 (let ((element (org-element-at-point)))
4529 (and (eq (org-element-type element) 'table)
4530 (eq (org-element-property :type element) 'table.el)))))
4532 (defun org-table-recognize-table.el ()
4533 "If there is a table.el table nearby, recognize it and move into it."
4534 (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4535 (beginning-of-line)
4536 (unless (or (looking-at org-table-dataline-regexp)
4537 (not (looking-at org-table1-hline-regexp)))
4538 (forward-line)
4539 (when (looking-at org-table-any-border-regexp)
4540 (forward-line -2)))
4541 (if (re-search-forward "|" (org-table-end t) t)
4542 (progn
4543 (require 'table)
4544 (if (table--at-cell-p (point)) t
4545 (message "recognizing table.el table...")
4546 (table-recognize-table)
4547 (message "recognizing table.el table...done")))
4548 (error "This should not happen"))))
4550 (defun org-at-table-hline-p ()
4551 "Non-nil when point is inside a hline in a table.
4552 Assume point is already in a table. If `org-enable-table-editor'
4553 is nil, return nil unconditionally."
4554 (and org-enable-table-editor
4555 (save-excursion
4556 (beginning-of-line)
4557 (looking-at org-table-hline-regexp))))
4559 (defun org-table-map-tables (function &optional quietly)
4560 "Apply FUNCTION to the start of all tables in the buffer."
4561 (save-excursion
4562 (save-restriction
4563 (widen)
4564 (goto-char (point-min))
4565 (while (re-search-forward org-table-any-line-regexp nil t)
4566 (unless quietly
4567 (message "Mapping tables: %d%%"
4568 (floor (* 100.0 (point)) (buffer-size))))
4569 (beginning-of-line 1)
4570 (when (and (looking-at org-table-line-regexp)
4571 ;; Exclude tables in src/example/verbatim/clocktable blocks
4572 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4573 (save-excursion (funcall function))
4574 (or (looking-at org-table-line-regexp)
4575 (forward-char 1)))
4576 (re-search-forward org-table-any-border-regexp nil 1))))
4577 (unless quietly (message "Mapping tables: done")))
4579 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4580 (declare-function org-clock-update-mode-line "org-clock" ())
4581 (declare-function org-resolve-clocks "org-clock"
4582 (&optional also-non-dangling-p prompt last-valid))
4584 (defun org-at-TBLFM-p (&optional pos)
4585 "Non-nil when point (or POS) is in #+TBLFM line."
4586 (save-excursion
4587 (goto-char (or pos (point)))
4588 (beginning-of-line)
4589 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4590 (eq (org-element-type (org-element-at-point)) 'table))))
4592 (defvar org-clock-start-time)
4593 (defvar org-clock-marker (make-marker)
4594 "Marker recording the last clock-in.")
4595 (defvar org-clock-hd-marker (make-marker)
4596 "Marker recording the last clock-in, but the headline position.")
4597 (defvar org-clock-heading ""
4598 "The heading of the current clock entry.")
4599 (defun org-clock-is-active ()
4600 "Return the buffer where the clock is currently running.
4601 Return nil if no clock is running."
4602 (marker-buffer org-clock-marker))
4604 (defun org-check-running-clock ()
4605 "Check if the current buffer contains the running clock.
4606 If yes, offer to stop it and to save the buffer with the changes."
4607 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4608 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4609 (buffer-name))))
4610 (org-clock-out)
4611 (when (y-or-n-p "Save changed buffer?")
4612 (save-buffer))))
4614 (defun org-clocktable-try-shift (dir n)
4615 "Check if this line starts a clock table, if yes, shift the time block."
4616 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4617 (org-clocktable-shift dir n)))
4619 ;;;###autoload
4620 (defun org-clock-persistence-insinuate ()
4621 "Set up hooks for clock persistence."
4622 (require 'org-clock)
4623 (add-hook 'org-mode-hook 'org-clock-load)
4624 (add-hook 'kill-emacs-hook 'org-clock-save))
4626 (defgroup org-archive nil
4627 "Options concerning archiving in Org-mode."
4628 :tag "Org Archive"
4629 :group 'org-structure)
4631 (defcustom org-archive-location "%s_archive::"
4632 "The location where subtrees should be archived.
4634 The value of this variable is a string, consisting of two parts,
4635 separated by a double-colon. The first part is a filename and
4636 the second part is a headline.
4638 When the filename is omitted, archiving happens in the same file.
4639 %s in the filename will be replaced by the current file
4640 name (without the directory part). Archiving to a different file
4641 is useful to keep archived entries from contributing to the
4642 Org-mode Agenda.
4644 The archived entries will be filed as subtrees of the specified
4645 headline. When the headline is omitted, the subtrees are simply
4646 filed away at the end of the file, as top-level entries. Also in
4647 the heading you can use %s to represent the file name, this can be
4648 useful when using the same archive for a number of different files.
4650 Here are a few examples:
4651 \"%s_archive::\"
4652 If the current file is Projects.org, archive in file
4653 Projects.org_archive, as top-level trees. This is the default.
4655 \"::* Archived Tasks\"
4656 Archive in the current file, under the top-level headline
4657 \"* Archived Tasks\".
4659 \"~/org/archive.org::\"
4660 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4662 \"~/org/archive.org::* From %s\"
4663 Archive in file ~/org/archive.org (absolute path), under headlines
4664 \"From FILENAME\" where file name is the current file name.
4666 \"~/org/datetree.org::datetree/* Finished Tasks\"
4667 The \"datetree/\" string is special, signifying to archive
4668 items to the datetree. Items are placed in either the CLOSED
4669 date of the item, or the current date if there is no CLOSED date.
4670 The heading will be a subentry to the current date. There doesn't
4671 need to be a heading, but there always needs to be a slash after
4672 datetree. For example, to store archived items directly in the
4673 datetree, use \"~/org/datetree.org::datetree/\".
4675 \"basement::** Finished Tasks\"
4676 Archive in file ./basement (relative path), as level 3 trees
4677 below the level 2 heading \"** Finished Tasks\".
4679 You may set this option on a per-file basis by adding to the buffer a
4680 line like
4682 #+ARCHIVE: basement::** Finished Tasks
4684 You may also define it locally for a subtree by setting an ARCHIVE property
4685 in the entry. If such a property is found in an entry, or anywhere up
4686 the hierarchy, it will be used."
4687 :group 'org-archive
4688 :type 'string)
4690 (defcustom org-agenda-skip-archived-trees t
4691 "Non-nil means the agenda will skip any items located in archived trees.
4692 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4693 variable is no longer recommended, you should leave it at the value t.
4694 Instead, use the key `v' to cycle the archives-mode in the agenda."
4695 :group 'org-archive
4696 :group 'org-agenda-skip
4697 :type 'boolean)
4699 (defcustom org-columns-skip-archived-trees t
4700 "Non-nil means ignore archived trees when creating column view."
4701 :group 'org-archive
4702 :group 'org-properties
4703 :type 'boolean)
4705 (defcustom org-cycle-open-archived-trees nil
4706 "Non-nil means `org-cycle' will open archived trees.
4707 An archived tree is a tree marked with the tag ARCHIVE.
4708 When nil, archived trees will stay folded. You can still open them with
4709 normal outline commands like `show-all', but not with the cycling commands."
4710 :group 'org-archive
4711 :group 'org-cycle
4712 :type 'boolean)
4714 (defcustom org-sparse-tree-open-archived-trees nil
4715 "Non-nil means sparse tree construction shows matches in archived trees.
4716 When nil, matches in these trees are highlighted, but the trees are kept in
4717 collapsed state."
4718 :group 'org-archive
4719 :group 'org-sparse-trees
4720 :type 'boolean)
4722 (defcustom org-sparse-tree-default-date-type nil
4723 "The default date type when building a sparse tree.
4724 When this is nil, a date is a scheduled or a deadline timestamp.
4725 Otherwise, these types are allowed:
4727 all: all timestamps
4728 active: only active timestamps (<...>)
4729 inactive: only inactive timestamps ([...])
4730 scheduled: only scheduled timestamps
4731 deadline: only deadline timestamps"
4732 :type '(choice (const :tag "Scheduled or deadline" nil)
4733 (const :tag "All timestamps" all)
4734 (const :tag "Only active timestamps" active)
4735 (const :tag "Only inactive timestamps" inactive)
4736 (const :tag "Only scheduled timestamps" scheduled)
4737 (const :tag "Only deadline timestamps" deadline)
4738 (const :tag "Only closed timestamps" closed))
4739 :version "25.1"
4740 :package-version '(Org . "8.3")
4741 :group 'org-sparse-trees)
4743 (defun org-cycle-hide-archived-subtrees (state)
4744 "Re-hide all archived subtrees after a visibility state change."
4745 (when (and (not org-cycle-open-archived-trees)
4746 (not (memq state '(overview folded))))
4747 (save-excursion
4748 (let* ((globalp (memq state '(contents all)))
4749 (beg (if globalp (point-min) (point)))
4750 (end (if globalp (point-max) (org-end-of-subtree t))))
4751 (org-hide-archived-subtrees beg end)
4752 (goto-char beg)
4753 (if (looking-at (concat ".*:" org-archive-tag ":"))
4754 (message "%s" (substitute-command-keys
4755 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4757 (defun org-force-cycle-archived ()
4758 "Cycle subtree even if it is archived."
4759 (interactive)
4760 (setq this-command 'org-cycle)
4761 (let ((org-cycle-open-archived-trees t))
4762 (call-interactively 'org-cycle)))
4764 (defun org-hide-archived-subtrees (beg end)
4765 "Re-hide all archived subtrees after a visibility state change."
4766 (org-with-wide-buffer
4767 (let ((case-fold-search nil)
4768 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4769 (goto-char beg)
4770 ;; Include headline point is currently on.
4771 (beginning-of-line)
4772 (while (and (< (point) end) (re-search-forward re end t))
4773 (when (member org-archive-tag (org-get-tags))
4774 (org-flag-subtree t)
4775 (org-end-of-subtree t))))))
4777 (declare-function outline-end-of-heading "outline" ())
4778 (declare-function outline-flag-region "outline" (from to flag))
4779 (defun org-flag-subtree (flag)
4780 (save-excursion
4781 (org-back-to-heading t)
4782 (outline-end-of-heading)
4783 (outline-flag-region (point)
4784 (progn (org-end-of-subtree t) (point))
4785 flag)))
4787 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4789 ;; Declare Column View Code
4791 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4792 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4793 (declare-function org-columns-compute "org-colview" (property))
4795 ;; Declare ID code
4797 (declare-function org-id-store-link "org-id")
4798 (declare-function org-id-locations-load "org-id")
4799 (declare-function org-id-locations-save "org-id")
4800 (defvar org-id-track-globally)
4802 ;;; Variables for pre-computed regular expressions, all buffer local
4804 (defvar org-todo-regexp nil
4805 "Matches any of the TODO state keywords.")
4806 (make-variable-buffer-local 'org-todo-regexp)
4807 (defvar org-not-done-regexp nil
4808 "Matches any of the TODO state keywords except the last one.")
4809 (make-variable-buffer-local 'org-not-done-regexp)
4810 (defvar org-not-done-heading-regexp nil
4811 "Matches a TODO headline that is not done.")
4812 (make-variable-buffer-local 'org-not-done-heading-regexp)
4813 (defvar org-todo-line-regexp nil
4814 "Matches a headline and puts TODO state into group 2 if present.")
4815 (make-variable-buffer-local 'org-todo-line-regexp)
4816 (defvar org-complex-heading-regexp nil
4817 "Matches a headline and puts everything into groups:
4818 group 1: the stars
4819 group 2: The todo keyword, maybe
4820 group 3: Priority cookie
4821 group 4: True headline
4822 group 5: Tags")
4823 (make-variable-buffer-local 'org-complex-heading-regexp)
4824 (defvar org-complex-heading-regexp-format nil
4825 "Printf format to make regexp to match an exact headline.
4826 This regexp will match the headline of any node which has the
4827 exact headline text that is put into the format, but may have any
4828 TODO state, priority and tags.")
4829 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4830 (defvar org-todo-line-tags-regexp nil
4831 "Matches a headline and puts TODO state into group 2 if present.
4832 Also put tags into group 4 if tags are present.")
4833 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4835 (defconst org-plain-time-of-day-regexp
4836 (concat
4837 "\\(\\<[012]?[0-9]"
4838 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4839 "\\(--?"
4840 "\\(\\<[012]?[0-9]"
4841 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4842 "\\)?")
4843 "Regular expression to match a plain time or time range.
4844 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4845 groups carry important information:
4846 0 the full match
4847 1 the first time, range or not
4848 8 the second time, if it is a range.")
4850 (defconst org-plain-time-extension-regexp
4851 (concat
4852 "\\(\\<[012]?[0-9]"
4853 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4854 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4855 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4856 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4857 groups carry important information:
4858 0 the full match
4859 7 hours of duration
4860 9 minutes of duration")
4862 (defconst org-stamp-time-of-day-regexp
4863 (concat
4864 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4865 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4866 "\\(--?"
4867 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4868 "Regular expression to match a timestamp time or time range.
4869 After a match, the following groups carry important information:
4870 0 the full match
4871 1 date plus weekday, for back referencing to make sure both times are on the same day
4872 2 the first time, range or not
4873 4 the second time, if it is a range.")
4875 (defconst org-startup-options
4876 '(("fold" org-startup-folded t)
4877 ("overview" org-startup-folded t)
4878 ("nofold" org-startup-folded nil)
4879 ("showall" org-startup-folded nil)
4880 ("showeverything" org-startup-folded showeverything)
4881 ("content" org-startup-folded content)
4882 ("indent" org-startup-indented t)
4883 ("noindent" org-startup-indented nil)
4884 ("hidestars" org-hide-leading-stars t)
4885 ("showstars" org-hide-leading-stars nil)
4886 ("odd" org-odd-levels-only t)
4887 ("oddeven" org-odd-levels-only nil)
4888 ("align" org-startup-align-all-tables t)
4889 ("noalign" org-startup-align-all-tables nil)
4890 ("inlineimages" org-startup-with-inline-images t)
4891 ("noinlineimages" org-startup-with-inline-images nil)
4892 ("latexpreview" org-startup-with-latex-preview t)
4893 ("nolatexpreview" org-startup-with-latex-preview nil)
4894 ("customtime" org-display-custom-times t)
4895 ("logdone" org-log-done time)
4896 ("lognotedone" org-log-done note)
4897 ("nologdone" org-log-done nil)
4898 ("lognoteclock-out" org-log-note-clock-out t)
4899 ("nolognoteclock-out" org-log-note-clock-out nil)
4900 ("logrepeat" org-log-repeat state)
4901 ("lognoterepeat" org-log-repeat note)
4902 ("logdrawer" org-log-into-drawer t)
4903 ("nologdrawer" org-log-into-drawer nil)
4904 ("logstatesreversed" org-log-states-order-reversed t)
4905 ("nologstatesreversed" org-log-states-order-reversed nil)
4906 ("nologrepeat" org-log-repeat nil)
4907 ("logreschedule" org-log-reschedule time)
4908 ("lognotereschedule" org-log-reschedule note)
4909 ("nologreschedule" org-log-reschedule nil)
4910 ("logredeadline" org-log-redeadline time)
4911 ("lognoteredeadline" org-log-redeadline note)
4912 ("nologredeadline" org-log-redeadline nil)
4913 ("logrefile" org-log-refile time)
4914 ("lognoterefile" org-log-refile note)
4915 ("nologrefile" org-log-refile nil)
4916 ("fninline" org-footnote-define-inline t)
4917 ("nofninline" org-footnote-define-inline nil)
4918 ("fnlocal" org-footnote-section nil)
4919 ("fnauto" org-footnote-auto-label t)
4920 ("fnprompt" org-footnote-auto-label nil)
4921 ("fnconfirm" org-footnote-auto-label confirm)
4922 ("fnplain" org-footnote-auto-label plain)
4923 ("fnadjust" org-footnote-auto-adjust t)
4924 ("nofnadjust" org-footnote-auto-adjust nil)
4925 ("constcgs" constants-unit-system cgs)
4926 ("constSI" constants-unit-system SI)
4927 ("noptag" org-tag-persistent-alist nil)
4928 ("hideblocks" org-hide-block-startup t)
4929 ("nohideblocks" org-hide-block-startup nil)
4930 ("beamer" org-startup-with-beamer-mode t)
4931 ("entitiespretty" org-pretty-entities t)
4932 ("entitiesplain" org-pretty-entities nil))
4933 "Variable associated with STARTUP options for org-mode.
4934 Each element is a list of three items: the startup options (as written
4935 in the #+STARTUP line), the corresponding variable, and the value to set
4936 this variable to if the option is found. An optional forth element PUSH
4937 means to push this value onto the list in the variable.")
4939 (defcustom org-group-tags t
4940 "When non-nil (the default), use group tags.
4941 This can be turned on/off through `org-toggle-tags-groups'."
4942 :group 'org-tags
4943 :group 'org-startup
4944 :type 'boolean)
4946 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4948 (defun org-toggle-tags-groups ()
4949 "Toggle support for group tags.
4950 Support for group tags is controlled by the option
4951 `org-group-tags', which is non-nil by default."
4952 (interactive)
4953 (setq org-group-tags (not org-group-tags))
4954 (cond ((and (derived-mode-p 'org-agenda-mode)
4955 org-group-tags)
4956 (org-agenda-redo))
4957 ((derived-mode-p 'org-mode)
4958 (let ((org-inhibit-startup t)) (org-mode))))
4959 (message "Groups tags support has been turned %s"
4960 (if org-group-tags "on" "off")))
4962 (defun org-set-regexps-and-options (&optional tags-only)
4963 "Precompute regular expressions used in the current buffer.
4964 When optional argument TAGS-ONLY is non-nil, only compute tags
4965 related expressions."
4966 (when (derived-mode-p 'org-mode)
4967 (let ((alist (org--setup-collect-keywords
4968 (org-make-options-regexp
4969 (append '("FILETAGS" "TAGS" "SETUPFILE")
4970 (and (not tags-only)
4971 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4972 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4973 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4974 (org--setup-process-tags
4975 (cdr (assq 'tags alist)) (cdr (assq 'filetags alist)))
4976 (unless tags-only
4977 ;; File properties.
4978 (org-set-local 'org-file-properties (cdr (assq 'property alist)))
4979 ;; Archive location.
4980 (let ((archive (cdr (assq 'archive alist))))
4981 (when archive (org-set-local 'org-archive-location archive)))
4982 ;; Category.
4983 (let ((cat (org-string-nw-p (cdr (assq 'category alist)))))
4984 (when cat
4985 (org-set-local 'org-category (intern cat))
4986 (org-set-local 'org-file-properties
4987 (org--update-property-plist
4988 "CATEGORY" cat org-file-properties))))
4989 ;; Columns.
4990 (let ((column (cdr (assq 'columns alist))))
4991 (when column (org-set-local 'org-columns-default-format column)))
4992 ;; Constants.
4993 (setq org-table-formula-constants-local (cdr (assq 'constants alist)))
4994 ;; Link abbreviations.
4995 (let ((links (cdr (assq 'link alist))))
4996 (when links (setq org-link-abbrev-alist-local (nreverse links))))
4997 ;; Priorities.
4998 (let ((priorities (cdr (assq 'priorities alist))))
4999 (when priorities
5000 (org-set-local 'org-highest-priority (nth 0 priorities))
5001 (org-set-local 'org-lowest-priority (nth 1 priorities))
5002 (org-set-local 'org-default-priority (nth 2 priorities))))
5003 ;; Scripts.
5004 (let ((scripts (assq 'scripts alist)))
5005 (when scripts
5006 (org-set-local 'org-use-sub-superscripts (cdr scripts))))
5007 ;; Startup options.
5008 (let ((startup (cdr (assq 'startup alist))))
5009 (dolist (option startup)
5010 (let ((entry (assoc-string option org-startup-options t)))
5011 (when entry
5012 (let ((var (nth 1 entry))
5013 (val (nth 2 entry)))
5014 (if (not (nth 3 entry)) (org-set-local var val)
5015 (unless (listp (symbol-value var))
5016 (org-set-local var nil))
5017 (add-to-list var val)))))))
5018 ;; TODO keywords.
5019 (org-set-local 'org-todo-kwd-alist nil)
5020 (org-set-local 'org-todo-key-alist nil)
5021 (org-set-local 'org-todo-key-trigger nil)
5022 (org-set-local 'org-todo-keywords-1 nil)
5023 (org-set-local 'org-done-keywords nil)
5024 (org-set-local 'org-todo-heads nil)
5025 (org-set-local 'org-todo-sets nil)
5026 (org-set-local 'org-todo-log-states nil)
5027 (let ((todo-sequences
5028 (or (nreverse (cdr (assq 'todo alist)))
5029 (let ((d (default-value 'org-todo-keywords)))
5030 (if (not (stringp (car d))) d
5031 ;; XXX: Backward compatibility code.
5032 (list (cons org-todo-interpretation d)))))))
5033 (dolist (sequence todo-sequences)
5034 (let* ((sequence (or (run-hook-with-args-until-success
5035 'org-todo-setup-filter-hook sequence)
5036 sequence))
5037 (sequence-type (car sequence))
5038 (keywords (cdr sequence))
5039 (sep (member "|" keywords))
5040 names alist)
5041 (dolist (k (remove "|" keywords))
5042 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5044 (error "Invalid TODO keyword %s" k))
5045 (let ((name (match-string 1 k))
5046 (key (match-string 2 k))
5047 (log (org-extract-log-state-settings k)))
5048 (push name names)
5049 (push (cons name (and key (string-to-char key))) alist)
5050 (when log (push log org-todo-log-states))))
5051 (let* ((names (nreverse names))
5052 (done (if sep (org-remove-keyword-keys (cdr sep))
5053 (last names)))
5054 (head (car names))
5055 (tail (list sequence-type head (car done) (org-last done))))
5056 (add-to-list 'org-todo-heads head 'append)
5057 (push names org-todo-sets)
5058 (setq org-done-keywords (append org-done-keywords done nil))
5059 (setq org-todo-keywords-1 (append org-todo-keywords-1 names nil))
5060 (setq org-todo-key-alist
5061 (append org-todo-key-alist
5062 (and alist
5063 (append '((:startgroup))
5064 (nreverse alist)
5065 '((:endgroup))))))
5066 (dolist (k names) (push (cons k tail) org-todo-kwd-alist))))))
5067 (setq org-todo-sets (nreverse org-todo-sets)
5068 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5069 org-todo-key-trigger (delq nil (mapcar #'cdr org-todo-key-alist))
5070 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist))
5071 ;; Compute the regular expressions and other local variables.
5072 ;; Using `org-outline-regexp-bol' would complicate them much,
5073 ;; because of the fixed white space at the end of that string.
5074 (if (not org-done-keywords)
5075 (setq org-done-keywords
5076 (and org-todo-keywords-1 (last org-todo-keywords-1))))
5077 (setq org-not-done-keywords
5078 (org-delete-all org-done-keywords
5079 (copy-sequence org-todo-keywords-1))
5080 org-todo-regexp (regexp-opt org-todo-keywords-1 t)
5081 org-not-done-regexp (regexp-opt org-not-done-keywords t)
5082 org-not-done-heading-regexp
5083 (format org-heading-keyword-regexp-format org-not-done-regexp)
5084 org-todo-line-regexp
5085 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5086 org-complex-heading-regexp
5087 (concat "^\\(\\*+\\)"
5088 "\\(?: +" org-todo-regexp "\\)?"
5089 "\\(?: +\\(\\[#.\\]\\)\\)?"
5090 "\\(?: +\\(.*?\\)\\)??"
5091 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5092 "[ \t]*$")
5093 org-complex-heading-regexp-format
5094 (concat "^\\(\\*+\\)"
5095 "\\(?: +" org-todo-regexp "\\)?"
5096 "\\(?: +\\(\\[#.\\]\\)\\)?"
5097 "\\(?: +"
5098 ;; Stats cookies can be stuck to body.
5099 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5100 "\\(%s\\)"
5101 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5102 "\\)"
5103 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5104 "[ \t]*$")
5105 org-todo-line-tags-regexp
5106 (concat "^\\(\\*+\\)"
5107 "\\(?: +" org-todo-regexp "\\)?"
5108 "\\(?: +\\(.*?\\)\\)??"
5109 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5110 "[ \t]*$"))
5111 (org-compute-latex-and-related-regexp)))))
5113 (defun org--setup-collect-keywords (regexp &optional files alist)
5114 "Return setup keywords values as an alist.
5116 REGEXP matches a subset of setup keywords. FILES is a list of
5117 file names already visited. It is used to avoid circular setup
5118 files. ALIST, when non-nil, is the alist computed so far.
5120 Return value contains the following keys: `archive', `category',
5121 `columns', `constants', `filetags', `link', `priorities',
5122 `property', `scripts', `startup', `tags' and `todo'."
5123 (org-with-wide-buffer
5124 (goto-char (point-min))
5125 (let ((case-fold-search t))
5126 (while (re-search-forward regexp nil t)
5127 (let ((element (org-element-at-point)))
5128 (when (eq (org-element-type element) 'keyword)
5129 (let ((key (org-element-property :key element))
5130 (value (org-element-property :value element)))
5131 (cond
5132 ((equal key "ARCHIVE")
5133 (when (org-string-nw-p value)
5134 (push (cons 'archive value) alist)))
5135 ((equal key "CATEGORY") (push (cons 'category value) alist))
5136 ((equal key "COLUMNS") (push (cons 'columns value) alist))
5137 ((equal key "CONSTANTS")
5138 (let* ((constants (assq 'constants alist))
5139 (store (cdr constants)))
5140 (dolist (pair (org-split-string value))
5141 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5142 pair)
5143 (let* ((name (match-string 1 pair))
5144 (value (match-string 2 pair))
5145 (old (assoc name store)))
5146 (if old (setcdr old value)
5147 (push (cons name value) store)))))
5148 (if constants (setcdr constants store)
5149 (push (cons 'constants store) alist))))
5150 ((equal key "FILETAGS")
5151 (when (org-string-nw-p value)
5152 (let ((old (assq 'filetags alist))
5153 (new (apply #'nconc
5154 (mapcar (lambda (x) (org-split-string x ":"))
5155 (org-split-string value)))))
5156 (if old (setcdr old (append new (cdr old)))
5157 (push (cons 'filetags new) alist)))))
5158 ((equal key "LINK")
5159 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5160 (let ((links (assq 'link alist))
5161 (pair (cons (org-match-string-no-properties 1 value)
5162 (org-match-string-no-properties 2 value))))
5163 (if links (push pair (cdr links))
5164 (push (list 'link pair) alist)))))
5165 ((equal key "OPTIONS")
5166 (when (and (org-string-nw-p value)
5167 (string-match "\\^:\\(t\\|nil\\|{}\\)" value))
5168 (push (cons 'scripts (read (match-string 1 value))) alist)))
5169 ((equal key "PRIORITIES")
5170 (push (cons 'priorities
5171 (let ((prio (org-split-string value)))
5172 (if (< (length prio) 3) '(?A ?C ?B)
5173 (mapcar #'string-to-char prio))))
5174 alist))
5175 ((equal key "PROPERTY")
5176 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value)
5177 (let* ((property (assq 'property alist))
5178 (value (org--update-property-plist
5179 (org-match-string-no-properties 1 value)
5180 (org-match-string-no-properties 2 value)
5181 (cdr property))))
5182 (if property (setcdr property value)
5183 (push (cons 'property value) alist)))))
5184 ((equal key "STARTUP")
5185 (let ((startup (assq 'startup alist)))
5186 (if startup
5187 (setcdr startup
5188 (append (cdr startup) (org-split-string value)))
5189 (push (cons 'startup (org-split-string value)) alist))))
5190 ((equal key "TAGS")
5191 (let ((tag-cell (assq 'tags alist)))
5192 (if tag-cell
5193 (setcdr tag-cell
5194 (append (cdr tag-cell)
5195 '("\\n")
5196 (org-split-string value)))
5197 (push (cons 'tags (org-split-string value)) alist))))
5198 ((member key '("TODO" "SEQ_TODO" "TYP_TODO"))
5199 (let ((todo (assq 'todo alist))
5200 (value (cons (if (equal key "TYP_TODO") 'type 'sequence)
5201 (org-split-string value))))
5202 (if todo (push value (cdr todo))
5203 (push (list 'todo value) alist))))
5204 ((equal key "SETUPFILE")
5205 (unless buffer-read-only ; Do not check in Gnus messages.
5206 (let ((f (and (org-string-nw-p value)
5207 (expand-file-name
5208 (org-remove-double-quotes value)))))
5209 (when (and f (file-readable-p f) (not (member f files)))
5210 (with-temp-buffer
5211 (insert-file-contents f)
5212 (setq alist
5213 ;; Fake Org mode to benefit from cache
5214 ;; without recurring needlessly.
5215 (let ((major-mode 'org-mode))
5216 (org--setup-collect-keywords
5217 regexp (cons f files) alist)))))))))))))))
5218 alist)
5220 (defun org--setup-process-tags (tags filetags)
5221 "Precompute variables used for tags.
5222 TAGS is a list of tags and tag group symbols, as strings.
5223 FILETAGS is a list of tags, as strings."
5224 ;; Process the file tags.
5225 (org-set-local 'org-file-tags
5226 (mapcar #'org-add-prop-inherited filetags))
5227 ;; Provide default tags if no local tags are found.
5228 (when (and (not tags) org-tag-alist)
5229 (setq tags
5230 (mapcar (lambda (tag)
5231 (case (car tag)
5232 (:startgroup "{")
5233 (:endgroup "}")
5234 (:startgrouptag "[")
5235 (:endgrouptag "]")
5236 (:grouptags ":")
5237 (:newline "\\n")
5238 (otherwise (concat (car tag)
5239 (and (characterp (cdr tag))
5240 (format "(%c)" (cdr tag)))))))
5241 org-tag-alist)))
5242 ;; Process the tags.
5243 (org-set-local 'org-tag-groups-alist nil)
5244 (org-set-local 'org-tag-alist nil)
5245 (let (group-flag)
5246 (while tags
5247 (let ((e (car tags)))
5248 (setq tags (cdr tags))
5249 (cond
5250 ((equal e "{")
5251 (push '(:startgroup) org-tag-alist)
5252 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5253 ((equal e "}")
5254 (push '(:endgroup) org-tag-alist)
5255 (setq group-flag nil))
5256 ((equal e "[")
5257 (push '(:startgrouptag) org-tag-alist)
5258 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5259 ((equal e "]")
5260 (push '(:endgrouptag) org-tag-alist)
5261 (setq group-flag nil))
5262 ((equal e ":")
5263 (push '(:grouptags) org-tag-alist)
5264 (setq group-flag 'append))
5265 ((equal e "\\n") (push '(:newline) org-tag-alist))
5266 ((string-match
5267 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5268 "\\|{.+?}\\)" ; regular expression
5269 "\\(?:(\\(.\\))\\)?\\'")) e)
5270 (let ((tag (match-string 1 e))
5271 (key (and (match-beginning 2)
5272 (string-to-char (match-string 2 e)))))
5273 (cond ((eq group-flag 'append)
5274 (setcar org-tag-groups-alist
5275 (append (car org-tag-groups-alist) (list tag))))
5276 (group-flag (push (list tag) org-tag-groups-alist)))
5277 ;; Push all tags in groups, no matter if they already exist.
5278 (unless (and (not group-flag) (assoc tag org-tag-alist))
5279 (push (cons tag key) org-tag-alist))))))))
5280 (setq org-tag-alist (nreverse org-tag-alist)))
5282 (defun org-file-contents (file &optional noerror)
5283 "Return the contents of FILE, as a string."
5284 (if (and file (file-readable-p file))
5285 (with-temp-buffer
5286 (insert-file-contents file)
5287 (buffer-string))
5288 (funcall (if noerror 'message 'error)
5289 "Cannot read file \"%s\"%s"
5290 file
5291 (let ((from (buffer-file-name (buffer-base-buffer))))
5292 (if from (concat " (referenced in file \"" from "\")") "")))))
5294 (defun org-extract-log-state-settings (x)
5295 "Extract the log state setting from a TODO keyword string.
5296 This will extract info from a string like \"WAIT(w@/!)\"."
5297 (let (kw key log1 log2)
5298 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5299 (setq kw (match-string 1 x)
5300 key (and (match-end 2) (match-string 2 x))
5301 log1 (and (match-end 3) (match-string 3 x))
5302 log2 (and (match-end 4) (match-string 4 x)))
5303 (and (or log1 log2)
5304 (list kw
5305 (and log1 (if (equal log1 "!") 'time 'note))
5306 (and log2 (if (equal log2 "!") 'time 'note)))))))
5308 (defun org-remove-keyword-keys (list)
5309 "Remove a pair of parenthesis at the end of each string in LIST."
5310 (mapcar (lambda (x)
5311 (if (string-match "(.*)$" x)
5312 (substring x 0 (match-beginning 0))
5314 list))
5316 (defun org-assign-fast-keys (alist)
5317 "Assign fast keys to a keyword-key alist.
5318 Respect keys that are already there."
5319 (let (new e (alt ?0))
5320 (while (setq e (pop alist))
5321 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5322 (cdr e)) ;; Key already assigned.
5323 (push e new)
5324 (let ((clist (string-to-list (downcase (car e))))
5325 (used (append new alist)))
5326 (when (= (car clist) ?@)
5327 (pop clist))
5328 (while (and clist (rassoc (car clist) used))
5329 (pop clist))
5330 (unless clist
5331 (while (rassoc alt used)
5332 (incf alt)))
5333 (push (cons (car e) (or (car clist) alt)) new))))
5334 (nreverse new)))
5336 ;;; Some variables used in various places
5338 (defvar org-window-configuration nil
5339 "Used in various places to store a window configuration.")
5340 (defvar org-selected-window nil
5341 "Used in various places to store a window configuration.")
5342 (defvar org-finish-function nil
5343 "Function to be called when `C-c C-c' is used.
5344 This is for getting out of special buffers like capture.")
5347 ;; FIXME: Occasionally check by commenting these, to make sure
5348 ;; no other functions uses these, forgetting to let-bind them.
5349 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5350 (defvar org-last-state)
5351 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5353 ;; Defined somewhere in this file, but used before definition.
5354 (defvar org-entities) ;; defined in org-entities.el
5355 (defvar org-struct-menu)
5356 (defvar org-org-menu)
5357 (defvar org-tbl-menu)
5359 ;;;; Define the Org-mode
5361 ;; We use a before-change function to check if a table might need
5362 ;; an update.
5363 (defvar org-table-may-need-update t
5364 "Indicates that a table might need an update.
5365 This variable is set by `org-before-change-function'.
5366 `org-table-align' sets it back to nil.")
5367 (defun org-before-change-function (beg end)
5368 "Every change indicates that a table might need an update."
5369 (setq org-table-may-need-update t))
5370 (defvar org-mode-map)
5371 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5372 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5373 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5374 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5375 (defvar org-table-buffer-is-an nil)
5377 (defvar bidi-paragraph-direction)
5378 (defvar buffer-face-mode-face)
5380 (require 'outline)
5381 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5382 (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"))
5383 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5385 ;; Other stuff we need.
5386 (require 'time-date)
5387 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5388 (require 'easymenu)
5389 (autoload 'easy-menu-add "easymenu")
5390 (require 'overlay)
5392 ;; (require 'org-macs) moved higher up in the file before it is first used
5393 (require 'org-entities)
5394 ;; (require 'org-compat) moved higher up in the file before it is first used
5395 (require 'org-faces)
5396 (require 'org-list)
5397 (require 'org-pcomplete)
5398 (require 'org-src)
5399 (require 'org-footnote)
5400 (require 'org-macro)
5402 ;; babel
5403 (require 'ob)
5405 ;;;###autoload
5406 (define-derived-mode org-mode outline-mode "Org"
5407 "Outline-based notes management and organizer, alias
5408 \"Carsten's outline-mode for keeping track of everything.\"
5410 Org-mode develops organizational tasks around a NOTES file which
5411 contains information about projects as plain text. Org-mode is
5412 implemented on top of outline-mode, which is ideal to keep the content
5413 of large files well structured. It supports ToDo items, deadlines and
5414 time stamps, which magically appear in the diary listing of the Emacs
5415 calendar. Tables are easily created with a built-in table editor.
5416 Plain text URL-like links connect to websites, emails (VM), Usenet
5417 messages (Gnus), BBDB entries, and any files related to the project.
5418 For printing and sharing of notes, an Org-mode file (or a part of it)
5419 can be exported as a structured ASCII or HTML file.
5421 The following commands are available:
5423 \\{org-mode-map}"
5425 ;; Get rid of Outline menus, they are not needed
5426 ;; Need to do this here because define-derived-mode sets up
5427 ;; the keymap so late. Still, it is a waste to call this each time
5428 ;; we switch another buffer into org-mode.
5429 (if (featurep 'xemacs)
5430 (when (boundp 'outline-mode-menu-heading)
5431 ;; Assume this is Greg's port, it uses easymenu
5432 (easy-menu-remove outline-mode-menu-heading)
5433 (easy-menu-remove outline-mode-menu-show)
5434 (easy-menu-remove outline-mode-menu-hide))
5435 (define-key org-mode-map [menu-bar headings] 'undefined)
5436 (define-key org-mode-map [menu-bar hide] 'undefined)
5437 (define-key org-mode-map [menu-bar show] 'undefined))
5439 (org-load-modules-maybe)
5440 (when (featurep 'xemacs)
5441 (easy-menu-add org-org-menu)
5442 (easy-menu-add org-tbl-menu))
5443 (org-install-agenda-files-menu)
5444 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5445 (add-to-invisibility-spec '(org-cwidth))
5446 (add-to-invisibility-spec '(org-hide-block . t))
5447 (when (featurep 'xemacs)
5448 (org-set-local 'line-move-ignore-invisible t))
5449 (org-set-local 'outline-regexp org-outline-regexp)
5450 (org-set-local 'outline-level 'org-outline-level)
5451 (setq bidi-paragraph-direction 'left-to-right)
5452 (when (and org-ellipsis
5453 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5454 (fboundp 'make-glyph-code))
5455 (unless org-display-table
5456 (setq org-display-table (make-display-table)))
5457 (set-display-table-slot
5458 org-display-table 4
5459 (vconcat (mapcar
5460 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5461 org-ellipsis)))
5462 (if (stringp org-ellipsis) org-ellipsis "..."))))
5463 (setq buffer-display-table org-display-table))
5464 (org-set-regexps-and-options)
5465 (org-set-font-lock-defaults)
5466 (when (and org-tag-faces (not org-tags-special-faces-re))
5467 ;; tag faces set outside customize.... force initialization.
5468 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5469 ;; Calc embedded
5470 (org-set-local 'calc-embedded-open-mode "# ")
5471 ;; Modify a few syntax entries
5472 (modify-syntax-entry ?@ "w")
5473 (modify-syntax-entry ?\" "\"")
5474 (modify-syntax-entry ?\\ "_")
5475 (modify-syntax-entry ?~ "_")
5476 (if org-startup-truncated (setq truncate-lines t))
5477 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5478 (org-set-local 'font-lock-unfontify-region-function
5479 'org-unfontify-region)
5480 ;; Activate before-change-function
5481 (org-set-local 'org-table-may-need-update t)
5482 (org-add-hook 'before-change-functions 'org-before-change-function nil
5483 'local)
5484 ;; Check for running clock before killing a buffer
5485 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5486 ;; Initialize macros templates.
5487 (org-macro-initialize-templates)
5488 ;; Initialize radio targets.
5489 (org-update-radio-target-regexp)
5490 ;; Indentation.
5491 (org-set-local 'indent-line-function 'org-indent-line)
5492 (org-set-local 'indent-region-function 'org-indent-region)
5493 ;; Filling and auto-filling.
5494 (org-setup-filling)
5495 ;; Comments.
5496 (org-setup-comments-handling)
5497 ;; Initialize cache.
5498 (org-element-cache-reset)
5499 ;; Beginning/end of defun
5500 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5501 (org-set-local 'end-of-defun-function
5502 (lambda ()
5503 (if (not (org-at-heading-p))
5504 (org-forward-element)
5505 (org-forward-element)
5506 (forward-char -1))))
5507 ;; Next error for sparse trees
5508 (org-set-local 'next-error-function 'org-occur-next-match)
5509 ;; Make sure dependence stuff works reliably, even for users who set it
5510 ;; too late :-(
5511 (if org-enforce-todo-dependencies
5512 (add-hook 'org-blocker-hook
5513 'org-block-todo-from-children-or-siblings-or-parent)
5514 (remove-hook 'org-blocker-hook
5515 'org-block-todo-from-children-or-siblings-or-parent))
5516 (if org-enforce-todo-checkbox-dependencies
5517 (add-hook 'org-blocker-hook
5518 'org-block-todo-from-checkboxes)
5519 (remove-hook 'org-blocker-hook
5520 'org-block-todo-from-checkboxes))
5522 ;; Align options lines
5523 (org-set-local
5524 'align-mode-rules-list
5525 '((org-in-buffer-settings
5526 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5527 (modes . '(org-mode)))))
5529 ;; Imenu
5530 (org-set-local 'imenu-create-index-function
5531 'org-imenu-get-tree)
5533 ;; Make isearch reveal context
5534 (if (or (featurep 'xemacs)
5535 (not (boundp 'outline-isearch-open-invisible-function)))
5536 ;; Emacs 21 and XEmacs make use of the hook
5537 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5538 ;; Emacs 22 deals with this through a special variable
5539 (org-set-local 'outline-isearch-open-invisible-function
5540 (lambda (&rest ignore) (org-show-context 'isearch))))
5542 ;; Setup the pcomplete hooks
5543 (set (make-local-variable 'pcomplete-command-completion-function)
5544 'org-pcomplete-initial)
5545 (set (make-local-variable 'pcomplete-command-name-function)
5546 'org-command-at-point)
5547 (set (make-local-variable 'pcomplete-default-completion-function)
5548 'ignore)
5549 (set (make-local-variable 'pcomplete-parse-arguments-function)
5550 'org-parse-arguments)
5551 (set (make-local-variable 'pcomplete-termination-string) "")
5552 (when (>= emacs-major-version 23)
5553 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5555 ;; If empty file that did not turn on org-mode automatically, make it to.
5556 (if (and org-insert-mode-line-in-empty-file
5557 (org-called-interactively-p 'any)
5558 (= (point-min) (point-max)))
5559 (insert "# -*- mode: org -*-\n\n"))
5560 (unless org-inhibit-startup
5561 (org-unmodified
5562 (and org-startup-with-beamer-mode (org-beamer-mode))
5563 (when org-startup-align-all-tables
5564 (org-table-map-tables 'org-table-align 'quietly))
5565 (when org-startup-with-inline-images
5566 (org-display-inline-images))
5567 (when org-startup-with-latex-preview
5568 (org-toggle-latex-fragment))
5569 (unless org-inhibit-startup-visibility-stuff
5570 (org-set-startup-visibility))
5571 (org-refresh-effort-properties)))
5572 ;; Try to set org-hide correctly
5573 (let ((foreground (org-find-invisible-foreground)))
5574 (if foreground
5575 (set-face-foreground 'org-hide foreground))))
5577 ;; Update `customize-package-emacs-version-alist'
5578 (add-to-list 'customize-package-emacs-version-alist
5579 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5580 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5581 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5583 (defvar org-mode-transpose-word-syntax-table
5584 (let ((st (make-syntax-table text-mode-syntax-table)))
5585 (mapc (lambda(c) (modify-syntax-entry
5586 (string-to-char (car c)) "w p" st))
5587 org-emphasis-alist)
5588 st))
5590 (when (fboundp 'abbrev-table-put)
5591 (abbrev-table-put org-mode-abbrev-table
5592 :parents (list text-mode-abbrev-table)))
5594 (defun org-find-invisible-foreground ()
5595 (let ((candidates (remove
5596 "unspecified-bg"
5597 (nconc
5598 (list (face-background 'default)
5599 (face-background 'org-default))
5600 (mapcar
5601 (lambda (alist)
5602 (when (boundp alist)
5603 (cdr (assoc 'background-color (symbol-value alist)))))
5604 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5605 (list (face-foreground 'org-hide))))))
5606 (car (remove nil candidates))))
5608 (defun org-current-time (&optional rounding-minutes past)
5609 "Current time, possibly rounded to ROUNDING-MINUTES.
5610 When ROUNDING-MINUTES is not an integer, fall back on the car of
5611 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5612 the rounding returns a past time."
5613 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5614 (car org-time-stamp-rounding-minutes)))
5615 (time (decode-time)) res)
5616 (if (< r 1)
5617 (current-time)
5618 (setq res
5619 (apply 'encode-time
5620 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5621 (nthcdr 2 time))))
5622 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5623 (seconds-to-time (- (org-float-time res) (* r 60)))
5624 res))))
5626 (defun org-today ()
5627 "Return today date, considering `org-extend-today-until'."
5628 (time-to-days
5629 (time-subtract (current-time)
5630 (list 0 (* 3600 org-extend-today-until) 0))))
5632 ;;;; Font-Lock stuff, including the activators
5634 (defvar org-mouse-map (make-sparse-keymap))
5635 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5636 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5637 (when org-mouse-1-follows-link
5638 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5639 (when org-tab-follows-link
5640 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5641 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5643 (require 'font-lock)
5645 (defconst org-non-link-chars "]\t\n\r<>")
5646 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5647 "file+sys" "news" "shell" "elisp" "doi" "message"
5648 "help"))
5649 (defvar org-link-types-re nil
5650 "Matches a link that has a url-like prefix like \"http:\"")
5651 (defvar org-link-re-with-space nil
5652 "Matches a link with spaces, optional angular brackets around it.")
5653 (defvar org-link-re-with-space2 nil
5654 "Matches a link with spaces, optional angular brackets around it.")
5655 (defvar org-link-re-with-space3 nil
5656 "Matches a link with spaces, only for internal part in bracket links.")
5657 (defvar org-angle-link-re nil
5658 "Matches link with angular brackets, spaces are allowed.")
5659 (defvar org-plain-link-re nil
5660 "Matches plain link, without spaces.")
5661 (defvar org-bracket-link-regexp nil
5662 "Matches a link in double brackets.")
5663 (defvar org-bracket-link-analytic-regexp nil
5664 "Regular expression used to analyze links.
5665 Here is what the match groups contain after a match:
5666 1: http:
5667 2: http
5668 3: path
5669 4: [desc]
5670 5: desc")
5671 (defvar org-bracket-link-analytic-regexp++ nil
5672 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5673 (defvar org-any-link-re nil
5674 "Regular expression matching any link.")
5676 (defconst org-match-sexp-depth 3
5677 "Number of stacked braces for sub/superscript matching.")
5679 (defun org-create-multibrace-regexp (left right n)
5680 "Create a regular expression which will match a balanced sexp.
5681 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5682 as single character strings.
5683 The regexp returned will match the entire expression including the
5684 delimiters. It will also define a single group which contains the
5685 match except for the outermost delimiters. The maximum depth of
5686 stacked delimiters is N. Escaping delimiters is not possible."
5687 (let* ((nothing (concat "[^" left right "]*?"))
5688 (or "\\|")
5689 (re nothing)
5690 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5691 (while (> n 1)
5692 (setq n (1- n)
5693 re (concat re or next)
5694 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5695 (concat left "\\(" re "\\)" right)))
5697 (defconst org-match-substring-regexp
5698 (concat
5699 "\\(\\S-\\)\\([_^]\\)\\("
5700 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5701 "\\|"
5702 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5703 "\\|"
5704 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5705 "The regular expression matching a sub- or superscript.")
5707 (defconst org-match-substring-with-braces-regexp
5708 (concat
5709 "\\(\\S-\\)\\([_^]\\)"
5710 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5711 "The regular expression matching a sub- or superscript, forcing braces.")
5713 (defun org-make-link-regexps ()
5714 "Update the link regular expressions.
5715 This should be called after the variable `org-link-types' has changed."
5716 (let ((types-re (regexp-opt org-link-types t)))
5717 (setq org-link-types-re
5718 (concat "\\`" types-re ":")
5719 org-link-re-with-space
5720 (concat "<?" types-re ":"
5721 "\\([^" org-non-link-chars " ]"
5722 "[^" org-non-link-chars "]*"
5723 "[^" org-non-link-chars " ]\\)>?")
5724 org-link-re-with-space2
5725 (concat "<?" types-re ":"
5726 "\\([^" org-non-link-chars " ]"
5727 "[^\t\n\r]*"
5728 "[^" org-non-link-chars " ]\\)>?")
5729 org-link-re-with-space3
5730 (concat "<?" types-re ":"
5731 "\\([^" org-non-link-chars " ]"
5732 "[^\t\n\r]*\\)")
5733 org-angle-link-re
5734 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
5735 types-re)
5736 org-plain-link-re
5737 (concat
5738 "\\<" types-re ":"
5739 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5740 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5741 org-bracket-link-regexp
5742 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5743 org-bracket-link-analytic-regexp
5744 (concat
5745 "\\[\\["
5746 "\\(" types-re ":\\)?"
5747 "\\([^]]+\\)"
5748 "\\]"
5749 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5750 "\\]")
5751 org-bracket-link-analytic-regexp++
5752 (concat
5753 "\\[\\["
5754 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5755 "\\([^]]+\\)"
5756 "\\]"
5757 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5758 "\\]")
5759 org-any-link-re
5760 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5761 org-angle-link-re "\\)\\|\\("
5762 org-plain-link-re "\\)"))))
5764 (org-make-link-regexps)
5766 (defvar org-emph-face nil)
5768 (defun org-do-emphasis-faces (limit)
5769 "Run through the buffer and emphasize strings."
5770 (let (rtn a)
5771 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5772 (let* ((border (char-after (match-beginning 3)))
5773 (bre (regexp-quote (char-to-string border))))
5774 (if (and (not (= border (char-after (match-beginning 4))))
5775 (not (save-match-data
5776 (string-match (concat bre ".*" bre)
5777 (replace-regexp-in-string
5778 "\n" " "
5779 (substring (match-string 2) 1 -1))))))
5780 (progn
5781 (setq rtn t)
5782 (setq a (assoc (match-string 3) org-emphasis-alist))
5783 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5784 'face
5785 (nth 1 a))
5786 (and (nth 2 a)
5787 (org-remove-flyspell-overlays-in
5788 (match-beginning 0) (match-end 0)))
5789 (add-text-properties (match-beginning 2) (match-end 2)
5790 '(font-lock-multiline t org-emphasis t))
5791 (when org-hide-emphasis-markers
5792 (add-text-properties (match-end 4) (match-beginning 5)
5793 '(invisible org-link))
5794 (add-text-properties (match-beginning 3) (match-end 3)
5795 '(invisible org-link))))))
5796 (goto-char (1+ (match-beginning 0))))
5797 rtn))
5799 (defun org-emphasize (&optional char)
5800 "Insert or change an emphasis, i.e. a font like bold or italic.
5801 If there is an active region, change that region to a new emphasis.
5802 If there is no region, just insert the marker characters and position
5803 the cursor between them.
5804 CHAR should be the marker character. If it is a space, it means to
5805 remove the emphasis of the selected region.
5806 If CHAR is not given (for example in an interactive call) it will be
5807 prompted for."
5808 (interactive)
5809 (let ((erc org-emphasis-regexp-components)
5810 (prompt "")
5811 (string "") beg end move c s)
5812 (if (org-region-active-p)
5813 (setq beg (region-beginning) end (region-end)
5814 string (buffer-substring beg end))
5815 (setq move t))
5817 (unless char
5818 (message "Emphasis marker or tag: [%s]"
5819 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5820 (setq char (read-char-exclusive)))
5821 (if (equal char ?\ )
5822 (setq s "" move nil)
5823 (unless (assoc (char-to-string char) org-emphasis-alist)
5824 (user-error "No such emphasis marker: \"%c\"" char))
5825 (setq s (char-to-string char)))
5826 (while (and (> (length string) 1)
5827 (equal (substring string 0 1) (substring string -1))
5828 (assoc (substring string 0 1) org-emphasis-alist))
5829 (setq string (substring string 1 -1)))
5830 (setq string (concat s string s))
5831 (if beg (delete-region beg end))
5832 (unless (or (bolp)
5833 (string-match (concat "[" (nth 0 erc) "\n]")
5834 (char-to-string (char-before (point)))))
5835 (insert " "))
5836 (unless (or (eobp)
5837 (string-match (concat "[" (nth 1 erc) "\n]")
5838 (char-to-string (char-after (point)))))
5839 (insert " ") (backward-char 1))
5840 (insert string)
5841 (and move (backward-char 1))))
5843 (defconst org-nonsticky-props
5844 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5846 (defsubst org-rear-nonsticky-at (pos)
5847 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5849 (defun org-activate-plain-links (limit)
5850 "Add link properties for plain links."
5851 (let (f hl)
5852 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5853 (not (member 'org-tag
5854 (get-text-property (1- (match-beginning 0)) 'face)))
5855 (not (org-in-src-block-p)))
5856 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5857 (setq f (get-text-property (match-beginning 0) 'face))
5858 (setq hl (org-match-string-no-properties 0))
5859 (if (or (eq f 'org-tag)
5860 (and (listp f) (memq 'org-tag f)))
5862 (add-text-properties (match-beginning 0) (match-end 0)
5863 (list 'mouse-face 'highlight
5864 'face 'org-link
5865 'htmlize-link `(:uri ,hl)
5866 'keymap org-mouse-map))
5867 (org-rear-nonsticky-at (match-end 0)))
5868 t)))
5870 (defun org-activate-code (limit)
5871 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5872 (progn
5873 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5874 (remove-text-properties (match-beginning 0) (match-end 0)
5875 '(display t invisible t intangible t))
5876 t)))
5878 (defcustom org-src-fontify-natively t
5879 "When non-nil, fontify code in code blocks."
5880 :type 'boolean
5881 :version "24.4"
5882 :package-version '(Org . "8.3")
5883 :group 'org-appearance
5884 :group 'org-babel)
5886 (defcustom org-allow-promoting-top-level-subtree nil
5887 "When non-nil, allow promoting a top level subtree.
5888 The leading star of the top level headline will be replaced
5889 by a #."
5890 :type 'boolean
5891 :version "24.1"
5892 :group 'org-appearance)
5894 (defun org-fontify-meta-lines-and-blocks (limit)
5895 (condition-case nil
5896 (org-fontify-meta-lines-and-blocks-1 limit)
5897 (error (message "org-mode fontification error"))))
5899 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5900 "Fontify #+ lines and blocks."
5901 (let ((case-fold-search t))
5902 (if (re-search-forward
5903 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5904 limit t)
5905 (let ((beg (match-beginning 0))
5906 (block-start (match-end 0))
5907 (block-end nil)
5908 (lang (match-string 7))
5909 (beg1 (line-beginning-position 2))
5910 (dc1 (downcase (match-string 2)))
5911 (dc3 (downcase (match-string 3)))
5912 end end1 quoting block-type ovl)
5913 (cond
5914 ((and (match-end 4) (equal dc3 "+begin"))
5915 ;; Truly a block
5916 (setq block-type (downcase (match-string 5))
5917 quoting (member block-type org-protecting-blocks))
5918 (when (re-search-forward
5919 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5920 nil t) ;; on purpose, we look further than LIMIT
5921 (setq end (min (point-max) (match-end 0))
5922 end1 (min (point-max) (1- (match-beginning 0))))
5923 (setq block-end (match-beginning 0))
5924 (when quoting
5925 (org-remove-flyspell-overlays-in beg1 end1)
5926 (remove-text-properties beg end
5927 '(display t invisible t intangible t)))
5928 (add-text-properties
5929 beg end '(font-lock-fontified t font-lock-multiline t))
5930 (add-text-properties beg beg1 '(face org-meta-line))
5931 (org-remove-flyspell-overlays-in beg beg1)
5932 (add-text-properties ; For end_src
5933 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5934 (org-remove-flyspell-overlays-in end1 end)
5935 (cond
5936 ((and lang (not (string= lang "")) org-src-fontify-natively)
5937 (org-src-font-lock-fontify-block lang block-start block-end)
5938 (add-text-properties beg1 block-end '(src-block t)))
5939 (quoting
5940 (add-text-properties beg1 (min (point-max) (1+ end1))
5941 '(face org-block))) ; end of source block
5942 ((not org-fontify-quote-and-verse-blocks))
5943 ((string= block-type "quote")
5944 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5945 ((string= block-type "verse")
5946 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5947 (add-text-properties beg beg1 '(face org-block-begin-line))
5948 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5949 '(face org-block-end-line))
5951 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5952 (org-remove-flyspell-overlays-in
5953 (match-beginning 0)
5954 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5955 (add-text-properties
5956 beg (match-end 3)
5957 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5958 '(font-lock-fontified t invisible t)
5959 '(font-lock-fontified t face org-document-info-keyword)))
5960 (add-text-properties
5961 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5962 (if (string-equal dc1 "+title:")
5963 '(font-lock-fontified t face org-document-title)
5964 '(font-lock-fontified t face org-document-info))))
5965 ((equal dc1 "+caption:")
5966 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5967 (remove-text-properties (match-beginning 0) (match-end 0)
5968 '(display t invisible t intangible t))
5969 (add-text-properties (match-beginning 1) (match-end 3)
5970 '(font-lock-fontified t face org-meta-line))
5971 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5972 '(font-lock-fontified t face org-block))
5974 ((member dc3 '(" " ""))
5975 (org-remove-flyspell-overlays-in beg (match-end 0))
5976 (add-text-properties
5977 beg (match-end 0)
5978 '(font-lock-fontified t face font-lock-comment-face)))
5979 (t ;; just any other in-buffer setting, but not indented
5980 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5981 (remove-text-properties (match-beginning 0) (match-end 0)
5982 '(display t invisible t intangible t))
5983 (add-text-properties beg (match-end 0)
5984 '(font-lock-fontified t face org-meta-line))
5985 t))))))
5987 (defun org-fontify-drawers (limit)
5988 "Fontify drawers."
5989 (when (re-search-forward org-drawer-regexp limit t)
5990 (add-text-properties
5991 (match-beginning 0) (match-end 0)
5992 '(font-lock-fontified t face org-special-keyword))
5993 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5996 (defun org-fontify-macros (limit)
5997 "Fontify macros."
5998 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5999 (add-text-properties
6000 (match-beginning 0) (match-end 0)
6001 '(font-lock-fontified t face org-macro))
6002 (when org-hide-macro-markers
6003 (add-text-properties (match-end 2) (match-beginning 2)
6004 '(invisible t))
6005 (add-text-properties (match-beginning 1) (match-end 1)
6006 '(invisible t)))
6007 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6010 (defun org-activate-angle-links (limit)
6011 "Add text properties for angle links."
6012 (if (and (re-search-forward org-angle-link-re limit t)
6013 (not (org-in-src-block-p)))
6014 (progn
6015 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6016 (add-text-properties (match-beginning 0) (match-end 0)
6017 (list 'mouse-face 'highlight
6018 'keymap org-mouse-map
6019 'font-lock-multiline t))
6020 (org-rear-nonsticky-at (match-end 0))
6021 t)))
6023 (defun org-activate-footnote-links (limit)
6024 "Add text properties for footnotes."
6025 (let ((fn (org-footnote-next-reference-or-definition limit)))
6026 (when fn
6027 (let* ((beg (nth 1 fn))
6028 (end (nth 2 fn))
6029 (label (car fn))
6030 (referencep (/= (line-beginning-position) beg)))
6031 (when (and referencep (nth 3 fn))
6032 (save-excursion
6033 (goto-char beg)
6034 (search-forward (or label "fn:"))
6035 (org-remove-flyspell-overlays-in beg (match-end 0))))
6036 (add-text-properties beg end
6037 (list 'mouse-face 'highlight
6038 'keymap org-mouse-map
6039 'help-echo
6040 (if referencep "Footnote reference"
6041 "Footnote definition")
6042 'font-lock-fontified t
6043 'font-lock-multiline t
6044 'face 'org-footnote))))))
6046 (defun org-activate-bracket-links (limit)
6047 "Add text properties for bracketed links."
6048 (if (and (re-search-forward org-bracket-link-regexp limit t)
6049 (not (org-in-src-block-p)))
6050 (let* ((hl (org-match-string-no-properties 1))
6051 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6052 (ip (org-maybe-intangible
6053 (list 'invisible 'org-link
6054 'keymap org-mouse-map 'mouse-face 'highlight
6055 'font-lock-multiline t 'help-echo help
6056 'htmlize-link `(:uri ,hl))))
6057 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6058 'font-lock-multiline t 'help-echo help
6059 'htmlize-link `(:uri ,hl))))
6060 ;; We need to remove the invisible property here. Table narrowing
6061 ;; may have made some of this invisible.
6062 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6063 (remove-text-properties (match-beginning 0) (match-end 0)
6064 '(invisible nil))
6065 (if (match-end 3)
6066 (progn
6067 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6068 (org-rear-nonsticky-at (match-beginning 3))
6069 (add-text-properties (match-beginning 3) (match-end 3) vp)
6070 (org-rear-nonsticky-at (match-end 3))
6071 (add-text-properties (match-end 3) (match-end 0) ip)
6072 (org-rear-nonsticky-at (match-end 0)))
6073 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6074 (org-rear-nonsticky-at (match-beginning 1))
6075 (add-text-properties (match-beginning 1) (match-end 1) vp)
6076 (org-rear-nonsticky-at (match-end 1))
6077 (add-text-properties (match-end 1) (match-end 0) ip)
6078 (org-rear-nonsticky-at (match-end 0)))
6079 t)))
6081 (defun org-activate-dates (limit)
6082 "Add text properties for dates."
6083 (if (and (re-search-forward org-tsr-regexp-both limit t)
6084 (not (equal (char-before (match-beginning 0)) 91)))
6085 (progn
6086 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6087 (add-text-properties (match-beginning 0) (match-end 0)
6088 (list 'mouse-face 'highlight
6089 'keymap org-mouse-map))
6090 (org-rear-nonsticky-at (match-end 0))
6091 (when org-display-custom-times
6092 (if (match-end 3)
6093 (org-display-custom-time (match-beginning 3) (match-end 3)))
6094 (org-display-custom-time (match-beginning 1) (match-end 1)))
6095 t)))
6097 (defvar org-target-link-regexp nil
6098 "Regular expression matching radio targets in plain text.")
6099 (make-variable-buffer-local 'org-target-link-regexp)
6101 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6102 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6103 border border border))
6104 "Regular expression matching a link target.")
6106 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6107 "Regular expression matching a radio target.")
6109 (defconst org-any-target-regexp
6110 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6111 "Regular expression matching any target.")
6113 (defun org-activate-target-links (limit)
6114 "Add text properties for target matches."
6115 (when org-target-link-regexp
6116 (let ((case-fold-search t))
6117 (if (re-search-forward org-target-link-regexp limit t)
6118 (progn
6119 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6120 (add-text-properties (match-beginning 1) (match-end 1)
6121 (list 'mouse-face 'highlight
6122 'keymap org-mouse-map
6123 'help-echo "Radio target link"
6124 'org-linked-text t))
6125 (org-rear-nonsticky-at (match-end 1))
6126 t)))))
6128 (defun org-update-radio-target-regexp ()
6129 "Find all radio targets in this file and update the regular expression.
6130 Also refresh fontification if needed."
6131 (interactive)
6132 (let ((old-regexp org-target-link-regexp)
6133 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6134 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6135 (targets
6136 (org-with-wide-buffer
6137 (goto-char (point-min))
6138 (let (rtn)
6139 (while (re-search-forward org-radio-target-regexp nil t)
6140 ;; Make sure point is really within the object.
6141 (backward-char)
6142 (let ((obj (org-element-context)))
6143 (when (eq (org-element-type obj) 'radio-target)
6144 (add-to-list 'rtn (org-element-property :value obj)))))
6145 rtn))))
6146 (setq org-target-link-regexp
6147 (and targets
6148 (concat before-re
6149 (mapconcat
6150 (lambda (x)
6151 (replace-regexp-in-string
6152 " +" "\\s-+" (regexp-quote x) t t))
6153 targets
6154 "\\|")
6155 after-re)))
6156 (unless (equal old-regexp org-target-link-regexp)
6157 ;; Clean-up cache.
6158 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6159 ((not org-target-link-regexp) old-regexp)
6161 (concat before-re
6162 (mapconcat
6163 (lambda (re)
6164 (substring re (length before-re)
6165 (- (length after-re))))
6166 (list old-regexp org-target-link-regexp)
6167 "\\|")
6168 after-re)))))
6169 (org-with-wide-buffer
6170 (goto-char (point-min))
6171 (while (re-search-forward regexp nil t)
6172 (org-element-cache-refresh (match-beginning 1)))))
6173 ;; Re fontify buffer.
6174 (when (memq 'radio org-highlight-links)
6175 (org-restart-font-lock)))))
6177 (defun org-hide-wide-columns (limit)
6178 (let (s e)
6179 (setq s (text-property-any (point) (or limit (point-max))
6180 'org-cwidth t))
6181 (when s
6182 (setq e (next-single-property-change s 'org-cwidth))
6183 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6184 (goto-char e)
6185 t)))
6187 (defvar org-latex-and-related-regexp nil
6188 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6190 (defun org-compute-latex-and-related-regexp ()
6191 "Compute regular expression for LaTeX, entities and sub/superscript.
6192 Result depends on variable `org-highlight-latex-and-related'."
6193 (org-set-local
6194 'org-latex-and-related-regexp
6195 (let* ((re-sub
6196 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6197 ((eq org-use-sub-superscripts '{})
6198 (list org-match-substring-with-braces-regexp))
6199 (org-use-sub-superscripts (list org-match-substring-regexp))))
6200 (re-latex
6201 (when (memq 'latex org-highlight-latex-and-related)
6202 (let ((matchers (plist-get org-format-latex-options :matchers)))
6203 (delq nil
6204 (mapcar (lambda (x)
6205 (and (member (car x) matchers) (nth 1 x)))
6206 org-latex-regexps)))))
6207 (re-entities
6208 (when (memq 'entities org-highlight-latex-and-related)
6209 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6210 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6212 (defun org-do-latex-and-related (limit)
6213 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6214 LIMIT bounds the search for syntax to highlight. Stop at first
6215 highlighted object, if any. Return t if some highlighting was
6216 done, nil otherwise."
6217 (when (org-string-nw-p org-latex-and-related-regexp)
6218 (catch 'found
6219 (while (re-search-forward org-latex-and-related-regexp limit t)
6220 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6221 'face))
6222 '(org-code org-verbatim underline))
6223 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6224 '(?_ ?^))
6226 0)))
6227 (font-lock-prepend-text-property
6228 (+ offset (match-beginning 0)) (match-end 0)
6229 'face 'org-latex-and-related)
6230 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6231 '(font-lock-multiline t)))
6232 (throw 'found t)))
6233 nil)))
6235 (defun org-restart-font-lock ()
6236 "Restart `font-lock-mode', to force refontification."
6237 (when (and (boundp 'font-lock-mode) font-lock-mode)
6238 (font-lock-mode -1)
6239 (font-lock-mode 1)))
6241 (defun org-activate-tags (limit)
6242 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6243 (progn
6244 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6245 (add-text-properties (match-beginning 1) (match-end 1)
6246 (list 'mouse-face 'highlight
6247 'keymap org-mouse-map))
6248 (org-rear-nonsticky-at (match-end 1))
6249 t)))
6251 (defun org-outline-level ()
6252 "Compute the outline level of the heading at point.
6254 If this is called at a normal headline, the level is the number
6255 of stars. Use `org-reduced-level' to remove the effect of
6256 `org-odd-levels'. Unlike to `org-current-level', this function
6257 takes into consideration inlinetasks."
6258 (org-with-wide-buffer
6259 (end-of-line)
6260 (if (re-search-backward org-outline-regexp-bol nil t)
6261 (1- (- (match-end 0) (match-beginning 0)))
6262 0)))
6264 (defvar org-font-lock-keywords nil)
6266 (defsubst org-re-property (property &optional literal allow-null value)
6267 "Return a regexp matching a PROPERTY line.
6269 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6270 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6271 non-nil, match properties even without a value.
6273 Match group 3 is set to the value when it exists. If there is no
6274 value and ALLOW-NULL is non-nil, it is set to the empty string.
6276 With optional argument VALUE, match only property lines with
6277 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6278 unless LITERAL is non-nil."
6279 (concat
6280 "^\\(?4:[ \t]*\\)"
6281 (format "\\(?1::\\(?2:%s\\):\\)"
6282 (if literal property (regexp-quote property)))
6283 (cond (value
6284 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6285 (if literal value (regexp-quote value))))
6286 (allow-null
6287 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6289 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6291 (defconst org-property-re
6292 (org-re-property "\\S-+" 'literal t)
6293 "Regular expression matching a property line.
6294 There are four matching groups:
6295 1: :PROPKEY: including the leading and trailing colon,
6296 2: PROPKEY without the leading and trailing colon,
6297 3: PROPVAL without leading or trailing spaces,
6298 4: the indentation of the current line,
6299 5: trailing whitespace.")
6301 (defvar org-font-lock-hook nil
6302 "Functions to be called for special font lock stuff.")
6304 (defvar org-font-lock-set-keywords-hook nil
6305 "Functions that can manipulate `org-font-lock-extra-keywords'.
6306 This is called after `org-font-lock-extra-keywords' is defined, but before
6307 it is installed to be used by font lock. This can be useful if something
6308 needs to be inserted at a specific position in the font-lock sequence.")
6310 (defun org-font-lock-hook (limit)
6311 "Run `org-font-lock-hook' within LIMIT."
6312 (run-hook-with-args 'org-font-lock-hook limit))
6314 (defun org-set-font-lock-defaults ()
6315 "Set font lock defaults for the current buffer."
6316 (let* ((em org-fontify-emphasized-text)
6317 (lk org-highlight-links)
6318 (org-font-lock-extra-keywords
6319 (list
6320 ;; Call the hook
6321 '(org-font-lock-hook)
6322 ;; Headlines
6323 `(,(if org-fontify-whole-heading-line
6324 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6325 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6326 (1 (org-get-level-face 1))
6327 (2 (org-get-level-face 2))
6328 (3 (org-get-level-face 3)))
6329 ;; Table lines
6330 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6331 (1 'org-table t))
6332 ;; Table internals
6333 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6334 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6335 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6336 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6337 ;; Drawers
6338 '(org-fontify-drawers)
6339 ;; Properties
6340 (list org-property-re
6341 '(1 'org-special-keyword t)
6342 '(3 'org-property-value t))
6343 ;; Links
6344 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6345 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6346 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6347 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6348 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6349 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6350 (if (memq 'footnote lk) '(org-activate-footnote-links))
6351 ;; Targets.
6352 (list org-any-target-regexp '(0 'org-target t))
6353 ;; Diary sexps.
6354 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6355 ;; Macro
6356 '(org-fontify-macros)
6357 '(org-hide-wide-columns (0 nil append))
6358 ;; TODO keyword
6359 (list (format org-heading-keyword-regexp-format
6360 org-todo-regexp)
6361 '(2 (org-get-todo-face 2) t))
6362 ;; DONE
6363 (if org-fontify-done-headline
6364 (list (format org-heading-keyword-regexp-format
6365 (concat
6366 "\\(?:"
6367 (mapconcat 'regexp-quote org-done-keywords "\\|")
6368 "\\)"))
6369 '(2 'org-headline-done t))
6370 nil)
6371 ;; Priorities
6372 '(org-font-lock-add-priority-faces)
6373 ;; Tags
6374 '(org-font-lock-add-tag-faces)
6375 ;; Tags groups
6376 (if (and org-group-tags org-tag-groups-alist)
6377 (list (concat org-outline-regexp-bol ".+\\(:"
6378 (regexp-opt (mapcar 'car org-tag-groups-alist))
6379 ":\\).*$")
6380 '(1 'org-tag-group prepend)))
6381 ;; Special keywords
6382 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6383 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6384 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6385 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6386 ;; Emphasis
6387 (if em
6388 (if (featurep 'xemacs)
6389 '(org-do-emphasis-faces (0 nil append))
6390 '(org-do-emphasis-faces)))
6391 ;; Checkboxes
6392 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6393 1 'org-checkbox prepend)
6394 (if (cdr (assq 'checkbox org-list-automatic-rules))
6395 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6396 (0 (org-get-checkbox-statistics-face) t)))
6397 ;; Description list items
6398 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6399 1 'org-list-dt prepend)
6400 ;; ARCHIVEd headings
6401 (list (concat
6402 org-outline-regexp-bol
6403 "\\(.*:" org-archive-tag ":.*\\)")
6404 '(1 'org-archived prepend))
6405 ;; Specials
6406 '(org-do-latex-and-related)
6407 '(org-fontify-entities)
6408 '(org-raise-scripts)
6409 ;; Code
6410 '(org-activate-code (1 'org-code t))
6411 ;; COMMENT
6412 (list (format
6413 "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6414 org-todo-regexp
6415 org-comment-string)
6416 '(9 'org-special-keyword t))
6417 ;; Blocks and meta lines
6418 '(org-fontify-meta-lines-and-blocks))))
6419 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6420 (run-hooks 'org-font-lock-set-keywords-hook)
6421 ;; Now set the full font-lock-keywords
6422 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6423 (org-set-local 'font-lock-defaults
6424 '(org-font-lock-keywords t nil nil backward-paragraph))
6425 (kill-local-variable 'font-lock-keywords) nil))
6427 (defun org-toggle-pretty-entities ()
6428 "Toggle the composition display of entities as UTF8 characters."
6429 (interactive)
6430 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6431 (org-restart-font-lock)
6432 (if org-pretty-entities
6433 (message "Entities are now displayed as UTF8 characters")
6434 (save-restriction
6435 (widen)
6436 (org-decompose-region (point-min) (point-max))
6437 (message "Entities are now displayed as plain text"))))
6439 (defvar org-custom-properties-overlays nil
6440 "List of overlays used for custom properties.")
6441 (make-variable-buffer-local 'org-custom-properties-overlays)
6443 (defun org-toggle-custom-properties-visibility ()
6444 "Display or hide properties in `org-custom-properties'."
6445 (interactive)
6446 (if org-custom-properties-overlays
6447 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6448 (setq org-custom-properties-overlays nil))
6449 (when org-custom-properties
6450 (org-with-wide-buffer
6451 (goto-char (point-min))
6452 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6453 (while (re-search-forward regexp nil t)
6454 (let ((end (cdr (save-match-data (org-get-property-block)))))
6455 (when (and end (< (point) end))
6456 ;; Hide first custom property in current drawer.
6457 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6458 (overlay-put o 'invisible t)
6459 (overlay-put o 'org-custom-property t)
6460 (push o org-custom-properties-overlays))
6461 ;; Hide additional custom properties in the same drawer.
6462 (while (re-search-forward regexp end t)
6463 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6464 (overlay-put o 'invisible t)
6465 (overlay-put o 'org-custom-property t)
6466 (push o org-custom-properties-overlays)))))
6467 ;; Each entry is limited to a single property drawer.
6468 (outline-next-heading)))))))
6470 (defun org-fontify-entities (limit)
6471 "Find an entity to fontify."
6472 (let (ee)
6473 (when org-pretty-entities
6474 (catch 'match
6475 ;; "\_ "-family is left out on purpose. Only the first one,
6476 ;; i.e., "\_ ", could be fontified anyway, and it would be
6477 ;; confusing when adding a second white space character.
6478 (while (re-search-forward
6479 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6480 limit t)
6481 (if (and (not (org-at-comment-p))
6482 (setq ee (org-entity-get (match-string 1)))
6483 (= (length (nth 6 ee)) 1))
6484 (let*
6485 ((end (if (equal (match-string 2) "{}")
6486 (match-end 2)
6487 (match-end 1))))
6488 (add-text-properties
6489 (match-beginning 0) end
6490 (list 'font-lock-fontified t))
6491 (compose-region (match-beginning 0) end
6492 (nth 6 ee) nil)
6493 (backward-char 1)
6494 (throw 'match t))))
6495 nil))))
6497 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6498 "Fontify string S like in Org-mode."
6499 (with-temp-buffer
6500 (insert s)
6501 (let ((org-odd-levels-only odd-levels))
6502 (org-mode)
6503 (font-lock-ensure)
6504 (buffer-string))))
6506 (defvar org-m nil)
6507 (defvar org-l nil)
6508 (defvar org-f nil)
6509 (defun org-get-level-face (n)
6510 "Get the right face for match N in font-lock matching of headlines."
6511 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6512 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6513 (if org-cycle-level-faces
6514 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6515 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6516 (cond
6517 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6518 ((eq n 2) org-f)
6519 (t (if org-level-color-stars-only nil org-f))))
6521 (defun org-face-from-face-or-color (context inherit face-or-color)
6522 "Create a face list that inherits INHERIT, but sets the foreground color.
6523 When FACE-OR-COLOR is not a string, just return it."
6524 (if (stringp face-or-color)
6525 (list :inherit inherit
6526 (cdr (assoc context org-faces-easy-properties))
6527 face-or-color)
6528 face-or-color))
6530 (defun org-get-todo-face (kwd)
6531 "Get the right face for a TODO keyword KWD.
6532 If KWD is a number, get the corresponding match group."
6533 (if (numberp kwd) (setq kwd (match-string kwd)))
6534 (or (org-face-from-face-or-color
6535 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6536 (and (member kwd org-done-keywords) 'org-done)
6537 'org-todo))
6539 (defun org-get-priority-face (priority)
6540 "Get the right face for PRIORITY.
6541 PRIORITY is a character."
6542 (or (org-face-from-face-or-color
6543 'priority 'org-priority (cdr (assq priority org-priority-faces)))
6544 'org-priority))
6546 (defun org-get-tag-face (tag)
6547 "Get the right face for TAG.
6548 If TAG is a number, get the corresponding match group."
6549 (let ((tag (if (wholenump tag) (match-string tag) tag)))
6550 (or (org-face-from-face-or-color
6551 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
6552 'org-tag)))
6554 (defun org-font-lock-add-priority-faces (limit)
6555 "Add the special priority faces."
6556 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
6557 (add-text-properties
6558 (match-beginning 1) (match-end 1)
6559 (list 'face (org-get-priority-face (string-to-char (match-string 2)))
6560 'font-lock-fontified t))))
6562 (defun org-font-lock-add-tag-faces (limit)
6563 "Add the special tag faces."
6564 (when (and org-tag-faces org-tags-special-faces-re)
6565 (while (re-search-forward org-tags-special-faces-re limit t)
6566 (add-text-properties (match-beginning 1) (match-end 1)
6567 (list 'face (org-get-tag-face 1)
6568 'font-lock-fontified t))
6569 (backward-char 1))))
6571 (defun org-unfontify-region (beg end &optional maybe_loudly)
6572 "Remove fontification and activation overlays from links."
6573 (font-lock-default-unfontify-region beg end)
6574 (let* ((buffer-undo-list t)
6575 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6576 (inhibit-modification-hooks t)
6577 deactivate-mark buffer-file-name buffer-file-truename)
6578 (org-decompose-region beg end)
6579 (remove-text-properties beg end
6580 '(mouse-face t keymap t org-linked-text t
6581 invisible t intangible t
6582 org-emphasis t))
6583 (org-remove-font-lock-display-properties beg end)))
6585 (defconst org-script-display '(((raise -0.3) (height 0.7))
6586 ((raise 0.3) (height 0.7))
6587 ((raise -0.5))
6588 ((raise 0.5)))
6589 "Display properties for showing superscripts and subscripts.")
6591 (defun org-remove-font-lock-display-properties (beg end)
6592 "Remove specific display properties that have been added by font lock.
6593 The will remove the raise properties that are used to show superscripts
6594 and subscripts."
6595 (let (next prop)
6596 (while (< beg end)
6597 (setq next (next-single-property-change beg 'display nil end)
6598 prop (get-text-property beg 'display))
6599 (if (member prop org-script-display)
6600 (put-text-property beg next 'display nil))
6601 (setq beg next))))
6603 (defun org-raise-scripts (limit)
6604 "Add raise properties to sub/superscripts."
6605 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6606 (if (re-search-forward
6607 (if (eq org-use-sub-superscripts t)
6608 org-match-substring-regexp
6609 org-match-substring-with-braces-regexp)
6610 limit t)
6611 (let* ((pos (point)) table-p comment-p
6612 (mpos (match-beginning 3))
6613 (emph-p (get-text-property mpos 'org-emphasis))
6614 (link-p (get-text-property mpos 'mouse-face))
6615 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6616 (goto-char (point-at-bol))
6617 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6618 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6619 (goto-char pos)
6620 ;; Handle a_b^c
6621 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6622 (if (or comment-p emph-p link-p keyw-p)
6624 (put-text-property (match-beginning 3) (match-end 0)
6625 'display
6626 (if (equal (char-after (match-beginning 2)) ?^)
6627 (nth (if table-p 3 1) org-script-display)
6628 (nth (if table-p 2 0) org-script-display)))
6629 (add-text-properties (match-beginning 2) (match-end 2)
6630 (list 'invisible t
6631 'org-dwidth t 'org-dwidth-n 1))
6632 (if (and (eq (char-after (match-beginning 3)) ?{)
6633 (eq (char-before (match-end 3)) ?}))
6634 (progn
6635 (add-text-properties
6636 (match-beginning 3) (1+ (match-beginning 3))
6637 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6638 (add-text-properties
6639 (1- (match-end 3)) (match-end 3)
6640 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6641 t)))))
6643 ;;;; Visibility cycling, including org-goto and indirect buffer
6645 ;;; Cycling
6647 (defvar org-cycle-global-status nil)
6648 (make-variable-buffer-local 'org-cycle-global-status)
6649 (put 'org-cycle-global-status 'org-state t)
6650 (defvar org-cycle-subtree-status nil)
6651 (make-variable-buffer-local 'org-cycle-subtree-status)
6652 (put 'org-cycle-subtree-status 'org-state t)
6654 (defvar org-inlinetask-min-level)
6656 (defun org-unlogged-message (&rest args)
6657 "Display a message, but avoid logging it in the *Messages* buffer."
6658 (let ((message-log-max nil))
6659 (apply 'message args)))
6661 ;;;###autoload
6662 (defun org-cycle (&optional arg)
6663 "TAB-action and visibility cycling for Org-mode.
6665 This is the command invoked in Org-mode by the TAB key. Its main purpose
6666 is outline visibility cycling, but it also invokes other actions
6667 in special contexts.
6669 - When this function is called with a prefix argument, rotate the entire
6670 buffer through 3 states (global cycling)
6671 1. OVERVIEW: Show only top-level headlines.
6672 2. CONTENTS: Show all headlines of all levels, but no body text.
6673 3. SHOW ALL: Show everything.
6674 With a double \\[universal-argument] prefix argument, \
6675 switch to the startup visibility,
6676 determined by the variable `org-startup-folded', and by any VISIBILITY
6677 properties in the buffer.
6678 With a triple \\[universal-argument] prefix argument, \
6679 show the entire buffer, including any drawers.
6681 - When inside a table, re-align the table and move to the next field.
6683 - When point is at the beginning of a headline, rotate the subtree started
6684 by this line through 3 different states (local cycling)
6685 1. FOLDED: Only the main headline is shown.
6686 2. CHILDREN: The main headline and the direct children are shown.
6687 From this state, you can move to one of the children
6688 and zoom in further.
6689 3. SUBTREE: Show the entire subtree, including body text.
6690 If there is no subtree, switch directly from CHILDREN to FOLDED.
6692 - When point is at the beginning of an empty headline and the variable
6693 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6694 of the headline by demoting and promoting it to likely levels. This
6695 speeds up creation document structure by pressing TAB once or several
6696 times right after creating a new headline.
6698 - When there is a numeric prefix, go up to a heading with level ARG, do
6699 a `show-subtree' and return to the previous cursor position. If ARG
6700 is negative, go up that many levels.
6702 - When point is not at the beginning of a headline, execute the global
6703 binding for TAB, which is re-indenting the line. See the option
6704 `org-cycle-emulate-tab' for details.
6706 - Special case: if point is at the beginning of the buffer and there is
6707 no headline in line 1, this function will act as if called with prefix arg
6708 (\\[universal-argument] TAB, same as S-TAB) also when called without prefix arg.
6709 But only if also the variable `org-cycle-global-at-bob' is t."
6710 (interactive "P")
6711 (org-load-modules-maybe)
6712 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6713 (and org-cycle-level-after-item/entry-creation
6714 (or (org-cycle-level)
6715 (org-cycle-item-indentation))))
6716 (let* ((limit-level
6717 (or org-cycle-max-level
6718 (and (boundp 'org-inlinetask-min-level)
6719 org-inlinetask-min-level
6720 (1- org-inlinetask-min-level))))
6721 (nstars (and limit-level
6722 (if org-odd-levels-only
6723 (and limit-level (1- (* limit-level 2)))
6724 limit-level)))
6725 (org-outline-regexp
6726 (if (not (derived-mode-p 'org-mode))
6727 outline-regexp
6728 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6729 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6730 (not (looking-at org-outline-regexp))))
6731 (org-cycle-hook
6732 (if bob-special
6733 (delq 'org-optimize-window-after-visibility-change
6734 (copy-sequence org-cycle-hook))
6735 org-cycle-hook))
6736 (pos (point)))
6738 (if (or bob-special (equal arg '(4)))
6739 ;; special case: use global cycling
6740 (setq arg t))
6742 (cond
6744 ((equal arg '(16))
6745 (setq last-command 'dummy)
6746 (org-set-startup-visibility)
6747 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6749 ((equal arg '(64))
6750 (show-all)
6751 (org-unlogged-message "Entire buffer visible, including drawers"))
6753 ;; Try cdlatex TAB completion
6754 ((org-try-cdlatex-tab))
6756 ;; Table: enter it or move to the next field.
6757 ((org-at-table-p 'any)
6758 (if (org-at-table.el-p)
6759 (message "%s" (substitute-command-keys "\\<org-mode-map>\
6760 Use \\[org-edit-special] to edit table.el tables"))
6761 (if arg (org-table-edit-field t)
6762 (org-table-justify-field-maybe)
6763 (call-interactively 'org-table-next-field))))
6765 ((run-hook-with-args-until-success
6766 'org-tab-after-check-for-table-hook))
6768 ;; Global cycling: delegate to `org-cycle-internal-global'.
6769 ((eq arg t) (org-cycle-internal-global))
6771 ;; Drawers: delegate to `org-flag-drawer'.
6772 ((save-excursion
6773 (beginning-of-line 1)
6774 (looking-at org-drawer-regexp))
6775 (org-flag-drawer ; toggle block visibility
6776 (not (get-char-property (match-end 0) 'invisible))))
6778 ;; Show-subtree, ARG levels up from here.
6779 ((integerp arg)
6780 (save-excursion
6781 (org-back-to-heading)
6782 (outline-up-heading (if (< arg 0) (- arg)
6783 (- (funcall outline-level) arg)))
6784 (org-show-subtree)))
6786 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6787 ((and (featurep 'org-inlinetask)
6788 (org-inlinetask-at-task-p)
6789 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6790 (org-inlinetask-toggle-visibility))
6792 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6793 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6794 (save-excursion (move-beginning-of-line 1)
6795 (looking-at org-outline-regexp)))
6796 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6797 (org-cycle-internal-local))
6799 ;; From there: TAB emulation and template completion.
6800 (buffer-read-only (org-back-to-heading))
6802 ((run-hook-with-args-until-success
6803 'org-tab-after-check-for-cycling-hook))
6805 ((org-try-structure-completion))
6807 ((run-hook-with-args-until-success
6808 'org-tab-before-tab-emulation-hook))
6810 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6811 (or (not (bolp))
6812 (not (looking-at org-outline-regexp))))
6813 (call-interactively (global-key-binding "\t")))
6815 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6816 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6817 (or (and (eq org-cycle-emulate-tab 'white)
6818 (= (match-end 0) (point-at-eol)))
6819 (and (eq org-cycle-emulate-tab 'whitestart)
6820 (>= (match-end 0) pos))))
6822 (eq org-cycle-emulate-tab t))
6823 (call-interactively (global-key-binding "\t")))
6825 (t (save-excursion
6826 (org-back-to-heading)
6827 (org-cycle)))))))
6829 (defun org-cycle-internal-global ()
6830 "Do the global cycling action."
6831 ;; Hack to avoid display of messages for .org attachments in Gnus
6832 (let ((ga (string-match "\\*fontification" (buffer-name))))
6833 (cond
6834 ((and (eq last-command this-command)
6835 (eq org-cycle-global-status 'overview))
6836 ;; We just created the overview - now do table of contents
6837 ;; This can be slow in very large buffers, so indicate action
6838 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6839 (unless ga (org-unlogged-message "CONTENTS..."))
6840 (org-content)
6841 (unless ga (org-unlogged-message "CONTENTS...done"))
6842 (setq org-cycle-global-status 'contents)
6843 (run-hook-with-args 'org-cycle-hook 'contents))
6845 ((and (eq last-command this-command)
6846 (eq org-cycle-global-status 'contents))
6847 ;; We just showed the table of contents - now show everything
6848 (run-hook-with-args 'org-pre-cycle-hook 'all)
6849 (show-all)
6850 (unless ga (org-unlogged-message "SHOW ALL"))
6851 (setq org-cycle-global-status 'all)
6852 (run-hook-with-args 'org-cycle-hook 'all))
6855 ;; Default action: go to overview
6856 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6857 (org-overview)
6858 (unless ga (org-unlogged-message "OVERVIEW"))
6859 (setq org-cycle-global-status 'overview)
6860 (run-hook-with-args 'org-cycle-hook 'overview)))))
6862 (defvar org-called-with-limited-levels nil
6863 "Non-nil when `org-with-limited-levels' is currently active.")
6865 (defun org-cycle-internal-local ()
6866 "Do the local cycling action."
6867 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6868 ;; First, determine end of headline (EOH), end of subtree or item
6869 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6870 (save-excursion
6871 (if (org-at-item-p)
6872 (progn
6873 (beginning-of-line)
6874 (setq struct (org-list-struct))
6875 (setq eoh (point-at-eol))
6876 (setq eos (org-list-get-item-end-before-blank (point) struct))
6877 (setq has-children (org-list-has-child-p (point) struct)))
6878 (org-back-to-heading)
6879 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6880 (setq eos (save-excursion (org-end-of-subtree t t)
6881 (when (bolp) (backward-char)) (point)))
6882 (setq has-children
6883 (or (save-excursion
6884 (let ((level (funcall outline-level)))
6885 (outline-next-heading)
6886 (and (org-at-heading-p t)
6887 (> (funcall outline-level) level))))
6888 (save-excursion
6889 (org-list-search-forward (org-item-beginning-re) eos t)))))
6890 ;; Determine end invisible part of buffer (EOL)
6891 (beginning-of-line 2)
6892 ;; XEmacs doesn't have `next-single-char-property-change'
6893 (if (featurep 'xemacs)
6894 (while (and (not (eobp)) ;; this is like `next-line'
6895 (get-char-property (1- (point)) 'invisible))
6896 (beginning-of-line 2))
6897 (while (and (not (eobp)) ;; this is like `next-line'
6898 (get-char-property (1- (point)) 'invisible))
6899 (goto-char (next-single-char-property-change (point) 'invisible))
6900 (and (eolp) (beginning-of-line 2))))
6901 (setq eol (point)))
6902 ;; Find out what to do next and set `this-command'
6903 (cond
6904 ((= eos eoh)
6905 ;; Nothing is hidden behind this heading
6906 (unless (org-before-first-heading-p)
6907 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6908 (org-unlogged-message "EMPTY ENTRY")
6909 (setq org-cycle-subtree-status nil)
6910 (save-excursion
6911 (goto-char eos)
6912 (outline-next-heading)
6913 (if (outline-invisible-p) (org-flag-heading nil))))
6914 ((and (or (>= eol eos)
6915 (not (string-match "\\S-" (buffer-substring eol eos))))
6916 (or has-children
6917 (not (setq children-skipped
6918 org-cycle-skip-children-state-if-no-children))))
6919 ;; Entire subtree is hidden in one line: children view
6920 (unless (org-before-first-heading-p)
6921 (run-hook-with-args 'org-pre-cycle-hook 'children))
6922 (if (org-at-item-p)
6923 (org-list-set-item-visibility (point-at-bol) struct 'children)
6924 (org-show-entry)
6925 (org-with-limited-levels (show-children))
6926 ;; FIXME: This slows down the func way too much.
6927 ;; How keep drawers hidden in subtree anyway?
6928 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6929 ;; (org-cycle-hide-drawers 'subtree))
6931 ;; Fold every list in subtree to top-level items.
6932 (when (eq org-cycle-include-plain-lists 'integrate)
6933 (save-excursion
6934 (org-back-to-heading)
6935 (while (org-list-search-forward (org-item-beginning-re) eos t)
6936 (beginning-of-line 1)
6937 (let* ((struct (org-list-struct))
6938 (prevs (org-list-prevs-alist struct))
6939 (end (org-list-get-bottom-point struct)))
6940 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6941 (org-list-get-all-items (point) struct prevs))
6942 (goto-char (if (< end eos) end eos)))))))
6943 (org-unlogged-message "CHILDREN")
6944 (save-excursion
6945 (goto-char eos)
6946 (outline-next-heading)
6947 (if (outline-invisible-p) (org-flag-heading nil)))
6948 (setq org-cycle-subtree-status 'children)
6949 (unless (org-before-first-heading-p)
6950 (run-hook-with-args 'org-cycle-hook 'children)))
6951 ((or children-skipped
6952 (and (eq last-command this-command)
6953 (eq org-cycle-subtree-status 'children)))
6954 ;; We just showed the children, or no children are there,
6955 ;; now show everything.
6956 (unless (org-before-first-heading-p)
6957 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6958 (outline-flag-region eoh eos nil)
6959 (org-unlogged-message
6960 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6961 (setq org-cycle-subtree-status 'subtree)
6962 (unless (org-before-first-heading-p)
6963 (run-hook-with-args 'org-cycle-hook 'subtree)))
6965 ;; Default action: hide the subtree.
6966 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6967 (outline-flag-region eoh eos t)
6968 (org-unlogged-message "FOLDED")
6969 (setq org-cycle-subtree-status 'folded)
6970 (unless (org-before-first-heading-p)
6971 (run-hook-with-args 'org-cycle-hook 'folded))))))
6973 ;;;###autoload
6974 (defun org-global-cycle (&optional arg)
6975 "Cycle the global visibility. For details see `org-cycle'.
6976 With \\[universal-argument] prefix arg, switch to startup visibility.
6977 With a numeric prefix, show all headlines up to that level."
6978 (interactive "P")
6979 (let ((org-cycle-include-plain-lists
6980 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6981 (cond
6982 ((integerp arg)
6983 (show-all)
6984 (hide-sublevels arg)
6985 (setq org-cycle-global-status 'contents))
6986 ((equal arg '(4))
6987 (org-set-startup-visibility)
6988 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6990 (org-cycle '(4))))))
6992 (defun org-set-startup-visibility ()
6993 "Set the visibility required by startup options and properties."
6994 (cond
6995 ((eq org-startup-folded t)
6996 (org-overview))
6997 ((eq org-startup-folded 'content)
6998 (org-content))
6999 ((or (eq org-startup-folded 'showeverything)
7000 (eq org-startup-folded nil))
7001 (show-all)))
7002 (unless (eq org-startup-folded 'showeverything)
7003 (if org-hide-block-startup (org-hide-block-all))
7004 (org-set-visibility-according-to-property 'no-cleanup)
7005 (org-cycle-hide-archived-subtrees 'all)
7006 (org-cycle-hide-drawers 'all)
7007 (org-cycle-show-empty-lines t)))
7009 (defun org-set-visibility-according-to-property (&optional no-cleanup)
7010 "Switch subtree visibilities according to :VISIBILITY: property."
7011 (interactive)
7012 (let (org-show-entry-below)
7013 (org-with-wide-buffer
7014 (goto-char (point-min))
7015 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
7016 (if (not (org-at-property-p)) (outline-next-heading)
7017 (let ((state (match-string 3)))
7018 (save-excursion
7019 (org-back-to-heading t)
7020 (hide-subtree)
7021 (org-reveal)
7022 (cond
7023 ((equal state "folded")
7024 (hide-subtree))
7025 ((equal state "children")
7026 (org-show-hidden-entry)
7027 (show-children))
7028 ((equal state "content")
7029 (save-excursion
7030 (save-restriction
7031 (org-narrow-to-subtree)
7032 (org-content))))
7033 ((member state '("all" "showall"))
7034 (show-subtree)))))))
7035 (unless no-cleanup
7036 (org-cycle-hide-archived-subtrees 'all)
7037 (org-cycle-hide-drawers 'all)
7038 (org-cycle-show-empty-lines 'all)))))
7040 ;; This function uses outline-regexp instead of the more fundamental
7041 ;; org-outline-regexp so that org-cycle-global works outside of Org
7042 ;; buffers, where outline-regexp is needed.
7043 (defun org-overview ()
7044 "Switch to overview mode, showing only top-level headlines.
7045 This shows all headlines with a level equal or greater than the level
7046 of the first headline in the buffer. This is important, because if the
7047 first headline is not level one, then (hide-sublevels 1) gives confusing
7048 results."
7049 (interactive)
7050 (save-excursion
7051 (let ((level
7052 (save-excursion
7053 (goto-char (point-min))
7054 (if (re-search-forward (concat "^" outline-regexp) nil t)
7055 (progn
7056 (goto-char (match-beginning 0))
7057 (funcall outline-level))))))
7058 (and level (hide-sublevels level)))))
7060 (defun org-content (&optional arg)
7061 "Show all headlines in the buffer, like a table of contents.
7062 With numerical argument N, show content up to level N."
7063 (interactive "P")
7064 (org-overview)
7065 (save-excursion
7066 ;; Visit all headings and show their offspring
7067 (and (integerp arg) (org-overview))
7068 (goto-char (point-max))
7069 (catch 'exit
7070 (while (and (progn (condition-case nil
7071 (outline-previous-visible-heading 1)
7072 (error (goto-char (point-min))))
7074 (looking-at org-outline-regexp))
7075 (if (integerp arg)
7076 (show-children (1- arg))
7077 (show-branches))
7078 (if (bobp) (throw 'exit nil))))))
7080 (defun org-optimize-window-after-visibility-change (state)
7081 "Adjust the window after a change in outline visibility.
7082 This function is the default value of the hook `org-cycle-hook'."
7083 (when (get-buffer-window (current-buffer))
7084 (cond
7085 ((eq state 'content) nil)
7086 ((eq state 'all) nil)
7087 ((eq state 'folded) nil)
7088 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7089 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7091 (defun org-remove-empty-overlays-at (pos)
7092 "Remove outline overlays that do not contain non-white stuff."
7093 (mapc
7094 (lambda (o)
7095 (and (eq 'outline (overlay-get o 'invisible))
7096 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7097 (overlay-end o))))
7098 (delete-overlay o)))
7099 (overlays-at pos)))
7101 (defun org-clean-visibility-after-subtree-move ()
7102 "Fix visibility issues after moving a subtree."
7103 ;; First, find a reasonable region to look at:
7104 ;; Start two siblings above, end three below
7105 (let* ((beg (save-excursion
7106 (and (org-get-last-sibling)
7107 (org-get-last-sibling))
7108 (point)))
7109 (end (save-excursion
7110 (and (org-get-next-sibling)
7111 (org-get-next-sibling)
7112 (org-get-next-sibling))
7113 (if (org-at-heading-p)
7114 (point-at-eol)
7115 (point))))
7116 (level (looking-at "\\*+"))
7117 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7118 (save-excursion
7119 (save-restriction
7120 (narrow-to-region beg end)
7121 (when re
7122 ;; Properly fold already folded siblings
7123 (goto-char (point-min))
7124 (while (re-search-forward re nil t)
7125 (if (and (not (outline-invisible-p))
7126 (save-excursion
7127 (goto-char (point-at-eol)) (outline-invisible-p)))
7128 (hide-entry))))
7129 (org-cycle-show-empty-lines 'overview)
7130 (org-cycle-hide-drawers 'overview)))))
7132 (defun org-cycle-show-empty-lines (state)
7133 "Show empty lines above all visible headlines.
7134 The region to be covered depends on STATE when called through
7135 `org-cycle-hook'. Lisp program can use t for STATE to get the
7136 entire buffer covered. Note that an empty line is only shown if there
7137 are at least `org-cycle-separator-lines' empty lines before the headline."
7138 (when (/= org-cycle-separator-lines 0)
7139 (save-excursion
7140 (let* ((n (abs org-cycle-separator-lines))
7141 (re (cond
7142 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7143 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7144 (t (let ((ns (number-to-string (- n 2))))
7145 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7146 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7147 beg end)
7148 (cond
7149 ((memq state '(overview contents t))
7150 (setq beg (point-min) end (point-max)))
7151 ((memq state '(children folded))
7152 (setq beg (point)
7153 end (progn (org-end-of-subtree t t)
7154 (line-beginning-position 2)))))
7155 (when beg
7156 (goto-char beg)
7157 (while (re-search-forward re end t)
7158 (unless (get-char-property (match-end 1) 'invisible)
7159 (let ((e (match-end 1))
7160 (b (if (>= org-cycle-separator-lines 0)
7161 (match-beginning 1)
7162 (save-excursion
7163 (goto-char (match-beginning 0))
7164 (skip-chars-backward " \t\n")
7165 (line-end-position)))))
7166 (outline-flag-region b e nil))))))))
7167 ;; Never hide empty lines at the end of the file.
7168 (save-excursion
7169 (goto-char (point-max))
7170 (outline-previous-heading)
7171 (outline-end-of-heading)
7172 (if (and (looking-at "[ \t\n]+")
7173 (= (match-end 0) (point-max)))
7174 (outline-flag-region (point) (match-end 0) nil))))
7176 (defun org-show-empty-lines-in-parent ()
7177 "Move to the parent and re-show empty lines before visible headlines."
7178 (save-excursion
7179 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7180 (org-cycle-show-empty-lines context))))
7182 (defun org-files-list ()
7183 "Return `org-agenda-files' list, plus all open org-mode files.
7184 This is useful for operations that need to scan all of a user's
7185 open and agenda-wise Org files."
7186 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7187 (dolist (buf (buffer-list))
7188 (with-current-buffer buf
7189 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7190 (let ((file (expand-file-name (buffer-file-name))))
7191 (unless (member file files)
7192 (push file files))))))
7193 files))
7195 (defsubst org-entry-beginning-position ()
7196 "Return the beginning position of the current entry."
7197 (save-excursion (outline-back-to-heading t) (point)))
7199 (defsubst org-entry-end-position ()
7200 "Return the end position of the current entry."
7201 (save-excursion (outline-next-heading) (point)))
7203 (defun org-cycle-hide-drawers (state &optional exceptions)
7204 "Re-hide all drawers after a visibility state change.
7205 When non-nil, optional argument EXCEPTIONS is a list of strings
7206 specifying which drawers should not be hidden."
7207 (when (and (derived-mode-p 'org-mode)
7208 (not (memq state '(overview folded contents))))
7209 (save-excursion
7210 (let* ((globalp (memq state '(contents all)))
7211 (beg (if globalp (point-min) (point)))
7212 (end (if globalp (point-max)
7213 (if (eq state 'children)
7214 (save-excursion (outline-next-heading) (point))
7215 (org-end-of-subtree t)))))
7216 (goto-char beg)
7217 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7218 (unless (member-ignore-case (match-string 1) exceptions)
7219 (let ((drawer (org-element-at-point)))
7220 (when (memq (org-element-type drawer) '(drawer property-drawer))
7221 (org-flag-drawer t drawer)
7222 ;; Make sure to skip drawer entirely or we might flag
7223 ;; it another time when matching its ending line with
7224 ;; `org-drawer-regexp'.
7225 (goto-char (org-element-property :end drawer))))))))))
7227 (defun org-flag-drawer (flag &optional element)
7228 "When FLAG is non-nil, hide the drawer we are at.
7229 Otherwise make it visible. When optional argument ELEMENT is
7230 a parsed drawer, as returned by `org-element-at-point', hide or
7231 show that drawer instead."
7232 (when (save-excursion
7233 (beginning-of-line)
7234 (org-looking-at-p org-drawer-regexp))
7235 (let ((drawer (or element (org-element-at-point))))
7236 (when (memq (org-element-type drawer) '(drawer property-drawer))
7237 (let ((post (org-element-property :post-affiliated drawer)))
7238 (save-excursion
7239 (outline-flag-region
7240 (progn (goto-char post) (line-end-position))
7241 (progn (goto-char (org-element-property :end drawer))
7242 (skip-chars-backward " \r\t\n")
7243 (line-end-position))
7244 flag))
7245 ;; When the drawer is hidden away, make sure point lies in
7246 ;; a visible part of the buffer.
7247 (when (and flag (> (line-beginning-position) post))
7248 (goto-char post)))))))
7250 (defun org-subtree-end-visible-p ()
7251 "Is the end of the current subtree visible?"
7252 (pos-visible-in-window-p
7253 (save-excursion (org-end-of-subtree t) (point))))
7255 (defun org-first-headline-recenter ()
7256 "Move cursor to the first headline and recenter the headline."
7257 (goto-char (point-min))
7258 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7259 (set-window-start (selected-window) (point-at-bol))))
7261 ;;; Saving and restoring visibility
7263 (defun org-outline-overlay-data (&optional use-markers)
7264 "Return a list of the locations of all outline overlays.
7265 These are overlays with the `invisible' property value `outline'.
7266 The return value is a list of cons cells, with start and stop
7267 positions for each overlay.
7268 If USE-MARKERS is set, return the positions as markers."
7269 (let (beg end)
7270 (save-excursion
7271 (save-restriction
7272 (widen)
7273 (delq nil
7274 (mapcar (lambda (o)
7275 (when (eq (overlay-get o 'invisible) 'outline)
7276 (setq beg (overlay-start o)
7277 end (overlay-end o))
7278 (and beg end (> end beg)
7279 (if use-markers
7280 (cons (copy-marker beg)
7281 (copy-marker end t))
7282 (cons beg end)))))
7283 (overlays-in (point-min) (point-max))))))))
7285 (defun org-set-outline-overlay-data (data)
7286 "Create visibility overlays for all positions in DATA.
7287 DATA should have been made by `org-outline-overlay-data'."
7288 (let (o)
7289 (save-excursion
7290 (save-restriction
7291 (widen)
7292 (show-all)
7293 (mapc (lambda (c)
7294 (outline-flag-region (car c) (cdr c) t))
7295 data)))))
7297 ;;; Folding of blocks
7299 (defvar org-hide-block-overlays nil
7300 "Overlays hiding blocks.")
7301 (make-variable-buffer-local 'org-hide-block-overlays)
7303 (defun org-block-map (function &optional start end)
7304 "Call FUNCTION at the head of all source blocks in the current buffer.
7305 Optional arguments START and END can be used to limit the range."
7306 (let ((start (or start (point-min)))
7307 (end (or end (point-max))))
7308 (save-excursion
7309 (goto-char start)
7310 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7311 (save-excursion
7312 (save-match-data
7313 (goto-char (match-beginning 0))
7314 (funcall function)))))))
7316 (defun org-hide-block-toggle-all ()
7317 "Toggle the visibility of all blocks in the current buffer."
7318 (org-block-map 'org-hide-block-toggle))
7320 (defun org-hide-block-all ()
7321 "Fold all blocks in the current buffer."
7322 (interactive)
7323 (org-show-block-all)
7324 (org-block-map 'org-hide-block-toggle-maybe))
7326 (defun org-show-block-all ()
7327 "Unfold all blocks in the current buffer."
7328 (interactive)
7329 (mapc 'delete-overlay org-hide-block-overlays)
7330 (setq org-hide-block-overlays nil))
7332 (defun org-hide-block-toggle-maybe ()
7333 "Toggle visibility of block at point.
7334 Unlike to `org-hide-block-toggle', this function does not throw
7335 an error. Return a non-nil value when toggling is successful."
7336 (interactive)
7337 (ignore-errors (org-hide-block-toggle)))
7339 (defun org-hide-block-toggle (&optional force)
7340 "Toggle the visibility of the current block.
7341 When optional argument FORCE is `off', make block visible. If it
7342 is non-nil, hide it unconditionally. Throw an error when not at
7343 a block. Return a non-nil value when toggling is successful."
7344 (interactive)
7345 (let ((element (org-element-at-point)))
7346 (unless (memq (org-element-type element)
7347 '(center-block comment-block dynamic-block example-block
7348 export-block quote-block special-block
7349 src-block verse-block))
7350 (user-error "Not at a block"))
7351 (let* ((start (save-excursion
7352 (goto-char (org-element-property :post-affiliated element))
7353 (line-end-position)))
7354 (end (save-excursion
7355 (goto-char (org-element-property :end element))
7356 (skip-chars-backward " \r\t\n")
7357 (line-end-position)))
7358 (overlays (overlays-at start)))
7359 (cond
7360 ;; Do nothing when not before or at the block opening line or
7361 ;; at the block closing line.
7362 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7363 ((and (not (eq force 'off))
7364 (not (memq t (mapcar
7365 (lambda (o)
7366 (eq (overlay-get o 'invisible) 'org-hide-block))
7367 overlays))))
7368 (let ((ov (make-overlay start end)))
7369 (overlay-put ov 'invisible 'org-hide-block)
7370 ;; Make the block accessible to `isearch'.
7371 (overlay-put
7372 ov 'isearch-open-invisible
7373 (lambda (ov)
7374 (when (memq ov org-hide-block-overlays)
7375 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7376 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7377 (delete-overlay ov))))
7378 (push ov org-hide-block-overlays)
7379 ;; When the block is hidden away, make sure point is left in
7380 ;; a visible part of the buffer.
7381 (when (> (line-beginning-position) start)
7382 (goto-char start)
7383 (beginning-of-line))
7384 ;; Signal successful toggling.
7386 ((or (not force) (eq force 'off))
7387 (dolist (ov overlays t)
7388 (when (memq ov org-hide-block-overlays)
7389 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7390 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7391 (delete-overlay ov))))))))
7393 ;; org-tab-after-check-for-cycling-hook
7394 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7395 ;; Remove overlays when changing major mode
7396 (add-hook 'org-mode-hook
7397 (lambda () (org-add-hook 'change-major-mode-hook
7398 'org-show-block-all 'append 'local)))
7400 ;;; Org-goto
7402 (defvar org-goto-window-configuration nil)
7403 (defvar org-goto-marker nil)
7404 (defvar org-goto-map)
7405 (defun org-goto-map ()
7406 "Set the keymap `org-goto'."
7407 (setq org-goto-map
7408 (let ((map (make-sparse-keymap)))
7409 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7410 mouse-drag-region universal-argument org-occur)))
7411 (dolist (cmd cmds)
7412 (substitute-key-definition cmd cmd map global-map)))
7413 (suppress-keymap map)
7414 (org-defkey map "\C-m" 'org-goto-ret)
7415 (org-defkey map [(return)] 'org-goto-ret)
7416 (org-defkey map [(left)] 'org-goto-left)
7417 (org-defkey map [(right)] 'org-goto-right)
7418 (org-defkey map [(control ?g)] 'org-goto-quit)
7419 (org-defkey map "\C-i" 'org-cycle)
7420 (org-defkey map [(tab)] 'org-cycle)
7421 (org-defkey map [(down)] 'outline-next-visible-heading)
7422 (org-defkey map [(up)] 'outline-previous-visible-heading)
7423 (if org-goto-auto-isearch
7424 (if (fboundp 'define-key-after)
7425 (define-key-after map [t] 'org-goto-local-auto-isearch)
7426 nil)
7427 (org-defkey map "q" 'org-goto-quit)
7428 (org-defkey map "n" 'outline-next-visible-heading)
7429 (org-defkey map "p" 'outline-previous-visible-heading)
7430 (org-defkey map "f" 'outline-forward-same-level)
7431 (org-defkey map "b" 'outline-backward-same-level)
7432 (org-defkey map "u" 'outline-up-heading))
7433 (org-defkey map "/" 'org-occur)
7434 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7435 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7436 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7437 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7438 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7439 map)))
7441 (defconst org-goto-help
7442 "Browse buffer copy, to find location or copy text.%s
7443 RET=jump to location C-g=quit and return to previous location
7444 [Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7446 (defvar org-goto-start-pos) ; dynamically scoped parameter
7448 (defun org-goto (&optional alternative-interface)
7449 "Look up a different location in the current file, keeping current visibility.
7451 When you want look-up or go to a different location in a
7452 document, the fastest way is often to fold the entire buffer and
7453 then dive into the tree. This method has the disadvantage, that
7454 the previous location will be folded, which may not be what you
7455 want.
7457 This command works around this by showing a copy of the current
7458 buffer in an indirect buffer, in overview mode. You can dive
7459 into the tree in that copy, use org-occur and incremental search
7460 to find a location. When pressing RET or `Q', the command
7461 returns to the original buffer in which the visibility is still
7462 unchanged. After RET it will also jump to the location selected
7463 in the indirect buffer and expose the headline hierarchy above.
7465 With a prefix argument, use the alternative interface: e.g. if
7466 `org-goto-interface' is 'outline use 'outline-path-completion."
7467 (interactive "P")
7468 (org-goto-map)
7469 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7470 (org-refile-use-outline-path t)
7471 (org-refile-target-verify-function nil)
7472 (interface
7473 (if (not alternative-interface)
7474 org-goto-interface
7475 (if (eq org-goto-interface 'outline)
7476 'outline-path-completion
7477 'outline)))
7478 (org-goto-start-pos (point))
7479 (selected-point
7480 (if (eq interface 'outline)
7481 (car (org-get-location (current-buffer) org-goto-help))
7482 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7483 (org-refile-check-position pa)
7484 (nth 3 pa)))))
7485 (if selected-point
7486 (progn
7487 (org-mark-ring-push org-goto-start-pos)
7488 (goto-char selected-point)
7489 (if (or (outline-invisible-p) (org-invisible-p2))
7490 (org-show-context 'org-goto)))
7491 (message "Quit"))))
7493 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7494 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7495 (defvar org-goto-local-auto-isearch-map) ; defined below
7497 (defun org-get-location (buf help)
7498 "Let the user select a location in the Org-mode buffer BUF.
7499 This function uses a recursive edit. It returns the selected position
7500 or nil."
7501 (org-no-popups
7502 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7503 (isearch-hide-immediately nil)
7504 (isearch-search-fun-function
7505 (lambda () 'org-goto-local-search-headings))
7506 (org-goto-selected-point org-goto-exit-command))
7507 (save-excursion
7508 (save-window-excursion
7509 (delete-other-windows)
7510 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7511 (org-pop-to-buffer-same-window
7512 (condition-case nil
7513 (make-indirect-buffer (current-buffer) "*org-goto*")
7514 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7515 (with-output-to-temp-buffer "*Org Help*"
7516 (princ (format help (if org-goto-auto-isearch
7517 " Just type for auto-isearch."
7518 " n/p/f/b/u to navigate, q to quit."))))
7519 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7520 (setq buffer-read-only nil)
7521 (let ((org-startup-truncated t)
7522 (org-startup-folded nil)
7523 (org-startup-align-all-tables nil))
7524 (org-mode)
7525 (org-overview))
7526 (setq buffer-read-only t)
7527 (if (and (boundp 'org-goto-start-pos)
7528 (integer-or-marker-p org-goto-start-pos))
7529 (progn (goto-char org-goto-start-pos)
7530 (when (outline-invisible-p)
7531 (org-show-set-visibility 'lineage)))
7532 (goto-char (point-min)))
7533 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7534 (message "Select location and press RET")
7535 (use-local-map org-goto-map)
7536 (recursive-edit)))
7537 (kill-buffer "*org-goto*")
7538 (cons org-goto-selected-point org-goto-exit-command))))
7540 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7541 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7542 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7543 (if (fboundp 'isearch-other-control-char)
7544 (progn
7545 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7546 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7547 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7548 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7549 (define-key org-goto-local-auto-isearch-map [return] nil))
7551 (defun org-goto-local-search-headings (string bound noerror)
7552 "Search and make sure that any matches are in headlines."
7553 (catch 'return
7554 (while (if isearch-forward
7555 (search-forward string bound noerror)
7556 (search-backward string bound noerror))
7557 (when (save-match-data
7558 (and (save-excursion
7559 (beginning-of-line)
7560 (looking-at org-complex-heading-regexp))
7561 (or (not (match-beginning 5))
7562 (< (point) (match-beginning 5)))))
7563 (throw 'return (point))))))
7565 (defun org-goto-local-auto-isearch ()
7566 "Start isearch."
7567 (interactive)
7568 (goto-char (point-min))
7569 (let ((keys (this-command-keys)))
7570 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7571 (isearch-mode t)
7572 (isearch-process-search-char (string-to-char keys)))))
7574 (defun org-goto-ret (&optional arg)
7575 "Finish `org-goto' by going to the new location."
7576 (interactive "P")
7577 (setq org-goto-selected-point (point)
7578 org-goto-exit-command 'return)
7579 (throw 'exit nil))
7581 (defun org-goto-left ()
7582 "Finish `org-goto' by going to the new location."
7583 (interactive)
7584 (if (org-at-heading-p)
7585 (progn
7586 (beginning-of-line 1)
7587 (setq org-goto-selected-point (point)
7588 org-goto-exit-command 'left)
7589 (throw 'exit nil))
7590 (user-error "Not on a heading")))
7592 (defun org-goto-right ()
7593 "Finish `org-goto' by going to the new location."
7594 (interactive)
7595 (if (org-at-heading-p)
7596 (progn
7597 (setq org-goto-selected-point (point)
7598 org-goto-exit-command 'right)
7599 (throw 'exit nil))
7600 (user-error "Not on a heading")))
7602 (defun org-goto-quit ()
7603 "Finish `org-goto' without cursor motion."
7604 (interactive)
7605 (setq org-goto-selected-point nil)
7606 (setq org-goto-exit-command 'quit)
7607 (throw 'exit nil))
7609 ;;; Indirect buffer display of subtrees
7611 (defvar org-indirect-dedicated-frame nil
7612 "This is the frame being used for indirect tree display.")
7613 (defvar org-last-indirect-buffer nil)
7615 (defun org-tree-to-indirect-buffer (&optional arg)
7616 "Create indirect buffer and narrow it to current subtree.
7617 With a numerical prefix ARG, go up to this level and then take that tree.
7618 If ARG is negative, go up that many levels.
7620 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7621 indirect buffer previously made with this command, to avoid proliferation of
7622 indirect buffers. However, when you call the command with a \
7623 \\[universal-argument] prefix, or
7624 when `org-indirect-buffer-display' is `new-frame', the last buffer
7625 is kept so that you can work with several indirect buffers at the same time.
7626 If `org-indirect-buffer-display' is `dedicated-frame', the \
7627 \\[universal-argument] prefix also
7628 requests that a new frame be made for the new buffer, so that the dedicated
7629 frame is not changed."
7630 (interactive "P")
7631 (let ((cbuf (current-buffer))
7632 (cwin (selected-window))
7633 (pos (point))
7634 beg end level heading ibuf)
7635 (save-excursion
7636 (org-back-to-heading t)
7637 (when (numberp arg)
7638 (setq level (org-outline-level))
7639 (if (< arg 0) (setq arg (+ level arg)))
7640 (while (> (setq level (org-outline-level)) arg)
7641 (org-up-heading-safe)))
7642 (setq beg (point)
7643 heading (org-get-heading))
7644 (org-end-of-subtree t t)
7645 (if (org-at-heading-p) (backward-char 1))
7646 (setq end (point)))
7647 (if (and (buffer-live-p org-last-indirect-buffer)
7648 (not (eq org-indirect-buffer-display 'new-frame))
7649 (not arg))
7650 (kill-buffer org-last-indirect-buffer))
7651 (setq ibuf (org-get-indirect-buffer cbuf heading)
7652 org-last-indirect-buffer ibuf)
7653 (cond
7654 ((or (eq org-indirect-buffer-display 'new-frame)
7655 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7656 (select-frame (make-frame))
7657 (delete-other-windows)
7658 (org-pop-to-buffer-same-window ibuf)
7659 (org-set-frame-title heading))
7660 ((eq org-indirect-buffer-display 'dedicated-frame)
7661 (raise-frame
7662 (select-frame (or (and org-indirect-dedicated-frame
7663 (frame-live-p org-indirect-dedicated-frame)
7664 org-indirect-dedicated-frame)
7665 (setq org-indirect-dedicated-frame (make-frame)))))
7666 (delete-other-windows)
7667 (org-pop-to-buffer-same-window ibuf)
7668 (org-set-frame-title (concat "Indirect: " heading)))
7669 ((eq org-indirect-buffer-display 'current-window)
7670 (org-pop-to-buffer-same-window ibuf))
7671 ((eq org-indirect-buffer-display 'other-window)
7672 (pop-to-buffer ibuf))
7673 (t (error "Invalid value")))
7674 (if (featurep 'xemacs)
7675 (save-excursion (org-mode) (turn-on-font-lock)))
7676 (narrow-to-region beg end)
7677 (show-all)
7678 (goto-char pos)
7679 (run-hook-with-args 'org-cycle-hook 'all)
7680 (and (window-live-p cwin) (select-window cwin))))
7682 (defun org-get-indirect-buffer (&optional buffer heading)
7683 (setq buffer (or buffer (current-buffer)))
7684 (let ((n 1) (base (buffer-name buffer)) bname)
7685 (while (buffer-live-p
7686 (get-buffer
7687 (setq bname
7688 (concat base "-"
7689 (if heading (concat heading "-" (number-to-string n))
7690 (number-to-string n))))))
7691 (setq n (1+ n)))
7692 (condition-case nil
7693 (make-indirect-buffer buffer bname 'clone)
7694 (error (make-indirect-buffer buffer bname)))))
7696 (defun org-set-frame-title (title)
7697 "Set the title of the current frame to the string TITLE."
7698 ;; FIXME: how to name a single frame in XEmacs???
7699 (unless (featurep 'xemacs)
7700 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7702 ;;;; Structure editing
7704 ;;; Inserting headlines
7706 (defun org-previous-line-empty-p (&optional next)
7707 "Is the previous line a blank line?
7708 When NEXT is non-nil, check the next line instead."
7709 (save-excursion
7710 (and (not (bobp))
7711 (or (beginning-of-line (if next 2 0)) t)
7712 (save-match-data
7713 (looking-at "[ \t]*$")))))
7715 (defun org-insert-heading (&optional arg invisible-ok top-level)
7716 "Insert a new heading or an item with the same depth at point.
7718 If point is at the beginning of a heading or a list item, insert
7719 a new heading or a new item above the current one. If point is
7720 at the beginning of a normal line, turn the line into a heading.
7722 If point is in the middle of a headline or a list item, split the
7723 headline or the item and create a new headline/item with the text
7724 in the current line after point \(see `org-M-RET-may-split-line'
7725 on how to modify this behavior).
7727 With one universal prefix argument, set the user option
7728 `org-insert-heading-respect-content' to t for the duration of
7729 the command. This modifies the behavior described above in this
7730 ways: on list items and at the beginning of normal lines, force
7731 the insertion of a heading after the current subtree.
7733 With two universal prefix arguments, insert the heading at the
7734 end of the grandparent subtree. For example, if point is within
7735 a 2nd-level heading, then it will insert a 2nd-level heading at
7736 the end of the 1st-level parent heading.
7738 If point is at the beginning of a headline, insert a sibling
7739 before the current headline. If point is not at the beginning,
7740 split the line and create a new headline with the text in the
7741 current line after point \(see `org-M-RET-may-split-line' on how
7742 to modify this behavior).
7744 If point is at the beginning of a normal line, turn this line
7745 into a heading.
7747 When INVISIBLE-OK is set, stop at invisible headlines when going
7748 back. This is important for non-interactive uses of the
7749 command.
7751 When optional argument TOP-LEVEL is non-nil, insert a level 1
7752 heading, unconditionally."
7753 (interactive "P")
7754 (if (org-called-interactively-p 'any) (org-reveal))
7755 (let ((itemp (and (not top-level) (org-in-item-p)))
7756 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7757 (respect-content (or org-insert-heading-respect-content
7758 (equal arg '(4))))
7759 (initial-content ""))
7761 (cond
7763 ((or (= (buffer-size) 0)
7764 (and (not (save-excursion
7765 (and (ignore-errors (org-back-to-heading invisible-ok))
7766 (org-at-heading-p))))
7767 (or arg (not itemp))))
7768 ;; At beginning of buffer or so high up that only a heading
7769 ;; makes sense.
7770 (cond ((and (bolp) (not respect-content)) (insert "* "))
7771 ((not respect-content)
7772 (unless may-split (end-of-line))
7773 (insert "\n* "))
7774 ((re-search-forward org-outline-regexp-bol nil t)
7775 (beginning-of-line)
7776 (insert "* \n")
7777 (backward-char))
7778 (t (goto-char (point-max))
7779 (insert "\n* ")))
7780 (run-hooks 'org-insert-heading-hook))
7782 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7785 ;; Maybe move at the end of the subtree
7786 (when (equal arg '(16))
7787 (org-up-heading-safe)
7788 (org-end-of-subtree t))
7789 ;; Insert a heading
7790 (save-restriction
7791 (widen)
7792 (let* ((level nil)
7793 (on-heading (org-at-heading-p))
7794 (empty-line-p (if on-heading
7795 (org-previous-line-empty-p)
7796 ;; We will decide later
7797 nil))
7798 ;; Get a level string to fall back on.
7799 (fix-level
7800 (if (org-before-first-heading-p) "*"
7801 (save-excursion
7802 (org-back-to-heading t)
7803 (if (org-previous-line-empty-p) (setq empty-line-p t))
7804 (looking-at org-outline-regexp)
7805 (make-string (1- (length (match-string 0))) ?*))))
7806 (stars
7807 (save-excursion
7808 (condition-case nil
7809 (if top-level "* "
7810 (org-back-to-heading invisible-ok)
7811 (when (and (not on-heading)
7812 (featurep 'org-inlinetask)
7813 (integerp org-inlinetask-min-level)
7814 (>= (length (match-string 0))
7815 org-inlinetask-min-level))
7816 ;; Find a heading level before the inline
7817 ;; task.
7818 (while (and (setq level (org-up-heading-safe))
7819 (>= level org-inlinetask-min-level)))
7820 (if (org-at-heading-p)
7821 (org-back-to-heading invisible-ok)
7822 (error "This should not happen")))
7823 (unless (and (save-excursion
7824 (save-match-data
7825 (org-backward-heading-same-level
7826 1 invisible-ok))
7827 (= (point) (match-beginning 0)))
7828 (not (org-previous-line-empty-p t)))
7829 (setq empty-line-p (or empty-line-p
7830 (org-previous-line-empty-p))))
7831 (match-string 0))
7832 (error (or fix-level "* ")))))
7833 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7834 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7835 pos hide-previous previous-pos)
7837 ;; If we insert after content, move there and clean up
7838 ;; whitespace.
7839 (when (and respect-content
7840 (not (org-looking-at-p org-outline-regexp-bol)))
7841 (if (not (org-before-first-heading-p))
7842 (org-end-of-subtree nil t)
7843 (re-search-forward org-outline-regexp-bol)
7844 (beginning-of-line 0))
7845 (skip-chars-backward " \r\t\n")
7846 (and (not (looking-back "^\\*+" (line-beginning-position)))
7847 (looking-at "[ \t]+") (replace-match ""))
7848 (unless (eobp) (forward-char 1))
7849 (when (looking-at "^\\*")
7850 (unless (bobp) (backward-char 1))
7851 (insert "\n")))
7853 ;; If we are splitting, grab the text that should be moved
7854 ;; to the new headline.
7855 (when may-split
7856 (if (org-on-heading-p)
7857 ;; This is a heading: split intelligently (keeping
7858 ;; tags).
7859 (let ((pos (point)))
7860 (beginning-of-line)
7861 (unless (looking-at org-complex-heading-regexp)
7862 (error "This should not happen"))
7863 (when (and (match-beginning 4)
7864 (> pos (match-beginning 4))
7865 (< pos (match-end 4)))
7866 (setq initial-content (buffer-substring pos (match-end 4)))
7867 (goto-char pos)
7868 (delete-region (point) (match-end 4))
7869 (if (looking-at "[ \t]*$")
7870 (replace-match "")
7871 (insert (make-string (length initial-content) ?\s)))
7872 (setq initial-content (org-trim initial-content)))
7873 (goto-char pos))
7874 ;; A normal line.
7875 (setq initial-content
7876 (org-trim
7877 (delete-and-extract-region (point) (line-end-position))))))
7879 ;; If we are at the beginning of the line, insert before it.
7880 ;; Otherwise, after it.
7881 (cond
7882 ((and (bolp) (looking-at "[ \t]*$")))
7883 ((bolp) (save-excursion (insert "\n")))
7884 (t (end-of-line)
7885 (insert "\n")))
7887 ;; Insert the new heading
7888 (insert stars)
7889 (just-one-space)
7890 (insert initial-content)
7891 (unless (and blank (org-previous-line-empty-p))
7892 (org-N-empty-lines-before-current (if blank 1 0)))
7893 ;; Adjust visibility, which may be messed up if we removed
7894 ;; blank lines while previous entry was hidden.
7895 (let ((bol (line-beginning-position)))
7896 (dolist (o (overlays-at (1- bol)))
7897 (when (and (eq (overlay-get o 'invisible) 'outline)
7898 (eq (overlay-end o) bol))
7899 (move-overlay o (overlay-start o) (1- bol)))))
7900 (run-hooks 'org-insert-heading-hook)))))))
7902 (defun org-N-empty-lines-before-current (N)
7903 "Make the number of empty lines before current exactly N.
7904 So this will delete or add empty lines."
7905 (save-excursion
7906 (beginning-of-line)
7907 (let ((p (point)))
7908 (skip-chars-backward " \r\t\n")
7909 (unless (bolp) (forward-line))
7910 (delete-region (point) p))
7911 (when (> N 0) (insert (make-string N ?\n)))))
7913 (defun org-get-heading (&optional no-tags no-todo)
7914 "Return the heading of the current entry, without the stars.
7915 When NO-TAGS is non-nil, don't include tags.
7916 When NO-TODO is non-nil, don't include TODO keywords."
7917 (save-excursion
7918 (org-back-to-heading t)
7919 (cond
7920 ((and no-tags no-todo)
7921 (looking-at org-complex-heading-regexp)
7922 (match-string 4))
7923 (no-tags
7924 (looking-at (concat org-outline-regexp
7925 "\\(.*?\\)"
7926 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7927 (match-string 1))
7928 (no-todo
7929 (looking-at org-todo-line-regexp)
7930 (match-string 3))
7931 (t (looking-at org-heading-regexp)
7932 (match-string 2)))))
7934 (defvar orgstruct-mode) ; defined below
7936 (defun org-heading-components ()
7937 "Return the components of the current heading.
7938 This is a list with the following elements:
7939 - the level as an integer
7940 - the reduced level, different if `org-odd-levels-only' is set.
7941 - the TODO keyword, or nil
7942 - the priority character, like ?A, or nil if no priority is given
7943 - the headline text itself, or the tags string if no headline text
7944 - the tags string, or nil."
7945 (save-excursion
7946 (org-back-to-heading t)
7947 (if (let (case-fold-search)
7948 (looking-at
7949 (if orgstruct-mode
7950 org-heading-regexp
7951 org-complex-heading-regexp)))
7952 (if orgstruct-mode
7953 (list (length (match-string 1))
7954 (org-reduced-level (length (match-string 1)))
7957 (match-string 2)
7958 nil)
7959 (list (length (match-string 1))
7960 (org-reduced-level (length (match-string 1)))
7961 (org-match-string-no-properties 2)
7962 (and (match-end 3) (aref (match-string 3) 2))
7963 (org-match-string-no-properties 4)
7964 (org-match-string-no-properties 5))))))
7966 (defun org-get-entry ()
7967 "Get the entry text, after heading, entire subtree."
7968 (save-excursion
7969 (org-back-to-heading t)
7970 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7972 (defun org-insert-heading-after-current ()
7973 "Insert a new heading with same level as current, after current subtree."
7974 (interactive)
7975 (org-back-to-heading)
7976 (org-insert-heading)
7977 (org-move-subtree-down)
7978 (end-of-line 1))
7980 (defun org-insert-heading-respect-content (&optional invisible-ok)
7981 "Insert heading with `org-insert-heading-respect-content' set to t."
7982 (interactive)
7983 (org-insert-heading '(4) invisible-ok))
7985 (defun org-insert-todo-heading-respect-content (&optional force-state)
7986 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7987 (interactive)
7988 (org-insert-todo-heading force-state '(4)))
7990 (defun org-insert-todo-heading (arg &optional force-heading)
7991 "Insert a new heading with the same level and TODO state as current heading.
7992 If the heading has no TODO state, or if the state is DONE, use the first
7993 state (TODO by default). Also with one prefix arg, force first state. With
7994 two prefix args, force inserting at the end of the parent subtree."
7995 (interactive "P")
7996 (when (or force-heading (not (org-insert-item 'checkbox)))
7997 (org-insert-heading (or (and (equal arg '(16)) '(16))
7998 force-heading))
7999 (save-excursion
8000 (org-back-to-heading)
8001 (outline-previous-heading)
8002 (looking-at org-todo-line-regexp))
8003 (let*
8004 ((new-mark-x
8005 (if (or (equal arg '(4))
8006 (not (match-beginning 2))
8007 (member (match-string 2) org-done-keywords))
8008 (car org-todo-keywords-1)
8009 (match-string 2)))
8010 (new-mark
8012 (run-hook-with-args-until-success
8013 'org-todo-get-default-hook new-mark-x nil)
8014 new-mark-x)))
8015 (beginning-of-line 1)
8016 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8017 (if org-treat-insert-todo-heading-as-state-change
8018 (org-todo new-mark)
8019 (insert new-mark " "))))
8020 (when org-provide-todo-statistics
8021 (org-update-parent-todo-statistics))))
8023 (defun org-insert-subheading (arg)
8024 "Insert a new subheading and demote it.
8025 Works for outline headings and for plain lists alike."
8026 (interactive "P")
8027 (org-insert-heading arg)
8028 (cond
8029 ((org-at-heading-p) (org-do-demote))
8030 ((org-at-item-p) (org-indent-item))))
8032 (defun org-insert-todo-subheading (arg)
8033 "Insert a new subheading with TODO keyword or checkbox and demote it.
8034 Works for outline headings and for plain lists alike."
8035 (interactive "P")
8036 (org-insert-todo-heading arg)
8037 (cond
8038 ((org-at-heading-p) (org-do-demote))
8039 ((org-at-item-p) (org-indent-item))))
8041 ;;; Promotion and Demotion
8043 (defvar org-after-demote-entry-hook nil
8044 "Hook run after an entry has been demoted.
8045 The cursor will be at the beginning of the entry.
8046 When a subtree is being demoted, the hook will be called for each node.")
8048 (defvar org-after-promote-entry-hook nil
8049 "Hook run after an entry has been promoted.
8050 The cursor will be at the beginning of the entry.
8051 When a subtree is being promoted, the hook will be called for each node.")
8053 (defun org-promote-subtree ()
8054 "Promote the entire subtree.
8055 See also `org-promote'."
8056 (interactive)
8057 (save-excursion
8058 (org-with-limited-levels (org-map-tree 'org-promote)))
8059 (org-fix-position-after-promote))
8061 (defun org-demote-subtree ()
8062 "Demote the entire subtree.
8063 See `org-demote' and `org-promote'."
8064 (interactive)
8065 (save-excursion
8066 (org-with-limited-levels (org-map-tree 'org-demote)))
8067 (org-fix-position-after-promote))
8069 (defun org-do-promote ()
8070 "Promote the current heading higher up the tree.
8071 If the region is active in `transient-mark-mode', promote all
8072 headings in the region."
8073 (interactive)
8074 (save-excursion
8075 (if (org-region-active-p)
8076 (org-map-region 'org-promote (region-beginning) (region-end))
8077 (org-promote)))
8078 (org-fix-position-after-promote))
8080 (defun org-do-demote ()
8081 "Demote the current heading lower down the tree.
8082 If the region is active in `transient-mark-mode', demote all
8083 headings in the region."
8084 (interactive)
8085 (save-excursion
8086 (if (org-region-active-p)
8087 (org-map-region 'org-demote (region-beginning) (region-end))
8088 (org-demote)))
8089 (org-fix-position-after-promote))
8091 (defun org-fix-position-after-promote ()
8092 "Fix cursor position and indentation after demoting/promoting."
8093 (let ((pos (point)))
8094 (when (save-excursion
8095 (beginning-of-line 1)
8096 (looking-at org-todo-line-regexp)
8097 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8098 (cond ((eobp) (insert " "))
8099 ((eolp) (insert " "))
8100 ((equal (char-after) ?\ ) (forward-char 1))))))
8102 (defun org-current-level ()
8103 "Return the level of the current entry, or nil if before the first headline.
8104 The level is the number of stars at the beginning of the
8105 headline. Use `org-reduced-level' to remove the effect of
8106 `org-odd-levels'. Unlike to `org-outline-level', this function
8107 ignores inlinetasks."
8108 (let ((level (org-with-limited-levels (org-outline-level))))
8109 (and (> level 0) level)))
8111 (defun org-get-previous-line-level ()
8112 "Return the outline depth of the last headline before the current line.
8113 Returns 0 for the first headline in the buffer, and nil if before the
8114 first headline."
8115 (and (org-current-level)
8116 (or (and (/= (line-beginning-position) (point-min))
8117 (save-excursion (beginning-of-line 0) (org-current-level)))
8118 0)))
8120 (defun org-reduced-level (l)
8121 "Compute the effective level of a heading.
8122 This takes into account the setting of `org-odd-levels-only'."
8123 (cond
8124 ((zerop l) 0)
8125 (org-odd-levels-only (1+ (floor (/ l 2))))
8126 (t l)))
8128 (defun org-level-increment ()
8129 "Return the number of stars that will be added or removed at a
8130 time to headlines when structure editing, based on the value of
8131 `org-odd-levels-only'."
8132 (if org-odd-levels-only 2 1))
8134 (defun org-get-valid-level (level &optional change)
8135 "Rectify a level change under the influence of `org-odd-levels-only'
8136 LEVEL is a current level, CHANGE is by how much the level should be
8137 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8138 even level numbers will become the next higher odd number."
8139 (if org-odd-levels-only
8140 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8141 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8142 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8143 (max 1 (+ level (or change 0)))))
8145 (if (boundp 'define-obsolete-function-alias)
8146 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8147 (define-obsolete-function-alias 'org-get-legal-level
8148 'org-get-valid-level)
8149 (define-obsolete-function-alias 'org-get-legal-level
8150 'org-get-valid-level "23.1")))
8152 (defun org-promote ()
8153 "Promote the current heading higher up 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 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8160 (diff (abs (- level (length up-head) -1))))
8161 (cond
8162 ((and (= level 1) org-allow-promoting-top-level-subtree)
8163 (replace-match "# " nil t))
8164 ((= level 1)
8165 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8166 (t (replace-match up-head nil t)))
8167 (unless (= level 1)
8168 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8169 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8170 (run-hooks 'org-after-promote-entry-hook))))
8172 (defun org-demote ()
8173 "Demote the current heading lower down the tree."
8174 (org-with-wide-buffer
8175 (org-back-to-heading t)
8176 (let* ((after-change-functions (remq 'flyspell-after-change-function
8177 after-change-functions))
8178 (level (save-match-data (funcall outline-level)))
8179 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8180 (diff (abs (- level (length down-head) -1))))
8181 (replace-match down-head nil t)
8182 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8183 (when org-adapt-indentation (org-fixup-indentation diff))
8184 (run-hooks 'org-after-demote-entry-hook))))
8186 (defun org-cycle-level ()
8187 "Cycle the level of an empty headline through possible states.
8188 This goes first to child, then to parent, level, then up the hierarchy.
8189 After top level, it switches back to sibling level."
8190 (interactive)
8191 (let ((org-adapt-indentation nil))
8192 (when (org-point-at-end-of-empty-headline)
8193 (setq this-command 'org-cycle-level) ; Only needed for caching
8194 (let ((cur-level (org-current-level))
8195 (prev-level (org-get-previous-line-level)))
8196 (cond
8197 ;; If first headline in file, promote to top-level.
8198 ((= prev-level 0)
8199 (loop repeat (/ (- cur-level 1) (org-level-increment))
8200 do (org-do-promote)))
8201 ;; If same level as prev, demote one.
8202 ((= prev-level cur-level)
8203 (org-do-demote))
8204 ;; If parent is top-level, promote to top level if not already.
8205 ((= prev-level 1)
8206 (loop repeat (/ (- cur-level 1) (org-level-increment))
8207 do (org-do-promote)))
8208 ;; If top-level, return to prev-level.
8209 ((= cur-level 1)
8210 (loop repeat (/ (- prev-level 1) (org-level-increment))
8211 do (org-do-demote)))
8212 ;; If less than prev-level, promote one.
8213 ((< cur-level prev-level)
8214 (org-do-promote))
8215 ;; If deeper than prev-level, promote until higher than
8216 ;; prev-level.
8217 ((> cur-level prev-level)
8218 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8219 do (org-do-promote))))
8220 t))))
8222 (defun org-map-tree (fun)
8223 "Call FUN for every heading underneath the current one."
8224 (org-back-to-heading)
8225 (let ((level (funcall outline-level)))
8226 (save-excursion
8227 (funcall fun)
8228 (while (and (progn
8229 (outline-next-heading)
8230 (> (funcall outline-level) level))
8231 (not (eobp)))
8232 (funcall fun)))))
8234 (defun org-map-region (fun beg end)
8235 "Call FUN for every heading between BEG and END."
8236 (let ((org-ignore-region t))
8237 (save-excursion
8238 (setq end (copy-marker end))
8239 (goto-char beg)
8240 (if (and (re-search-forward org-outline-regexp-bol nil t)
8241 (< (point) end))
8242 (funcall fun))
8243 (while (and (progn
8244 (outline-next-heading)
8245 (< (point) end))
8246 (not (eobp)))
8247 (funcall fun)))))
8249 (defun org-fixup-indentation (diff)
8250 "Change the indentation in the current entry by DIFF.
8252 DIFF is an integer. Indentation is done according to the
8253 following rules:
8255 - Planning information and property drawers are always indented
8256 according to the new level of the headline;
8258 - Footnote definitions and their contents are ignored;
8260 - Inlinetasks' boundaries are not shifted;
8262 - Empty lines are ignored;
8264 - Other lines' indentation are shifted by DIFF columns, unless
8265 it would introduce a structural change in the document, in
8266 which case no shifting is done at all.
8268 Assume point is at a heading or an inlinetask beginning."
8269 (org-with-wide-buffer
8270 (narrow-to-region (line-beginning-position)
8271 (save-excursion
8272 (if (org-with-limited-levels (org-at-heading-p))
8273 (org-with-limited-levels (outline-next-heading))
8274 (org-inlinetask-goto-end))
8275 (point)))
8276 (forward-line)
8277 ;; Indent properly planning info and property drawer.
8278 (when (org-looking-at-p org-planning-line-re)
8279 (org-indent-line)
8280 (forward-line))
8281 (when (looking-at org-property-drawer-re)
8282 (goto-char (match-end 0))
8283 (forward-line)
8284 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8285 (catch 'no-shift
8286 (when (zerop diff) (throw 'no-shift nil))
8287 ;; If DIFF is negative, first check if a shift is possible at all
8288 ;; (e.g., it doesn't break structure). This can only happen if
8289 ;; some contents are not properly indented.
8290 (let ((case-fold-search t))
8291 (when (< diff 0)
8292 (let ((diff (- diff))
8293 (forbidden-re (concat org-outline-regexp
8294 "\\|"
8295 (substring org-footnote-definition-re 1))))
8296 (save-excursion
8297 (while (not (eobp))
8298 (cond
8299 ((org-looking-at-p "[ \t]*$") (forward-line))
8300 ((and (org-looking-at-p org-footnote-definition-re)
8301 (let ((e (org-element-at-point)))
8302 (and (eq (org-element-type e) 'footnote-definition)
8303 (goto-char (org-element-property :end e))))))
8304 ((org-looking-at-p org-outline-regexp) (forward-line))
8305 ;; Give up if shifting would move before column 0 or
8306 ;; if it would introduce a headline or a footnote
8307 ;; definition.
8309 (skip-chars-forward " \t")
8310 (let ((ind (current-column)))
8311 (when (or (< ind diff)
8312 (and (= ind diff) (org-looking-at-p forbidden-re)))
8313 (throw 'no-shift nil)))
8314 ;; Ignore contents of example blocks and source
8315 ;; blocks if their indentation is meant to be
8316 ;; preserved. Jump to block's closing line.
8317 (beginning-of-line)
8318 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8319 (let ((e (org-element-at-point)))
8320 (and (memq (org-element-type e)
8321 '(example-block src-block))
8322 (or org-src-preserve-indentation
8323 (org-element-property :preserve-indent e))
8324 (goto-char (org-element-property :end e))
8325 (progn (skip-chars-backward " \r\t\n")
8326 (beginning-of-line)
8327 t))))
8328 (forward-line))))))))
8329 ;; Shift lines but footnote definitions, inlinetasks boundaries
8330 ;; by DIFF. Also skip contents of source or example blocks
8331 ;; when indentation is meant to be preserved.
8332 (while (not (eobp))
8333 (cond
8334 ((and (org-looking-at-p org-footnote-definition-re)
8335 (let ((e (org-element-at-point)))
8336 (and (eq (org-element-type e) 'footnote-definition)
8337 (goto-char (org-element-property :end e))))))
8338 ((org-looking-at-p org-outline-regexp) (forward-line))
8339 ((org-looking-at-p "[ \t]*$") (forward-line))
8341 (org-indent-line-to (+ (org-get-indentation) diff))
8342 (beginning-of-line)
8343 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8344 (let ((e (org-element-at-point)))
8345 (and (memq (org-element-type e)
8346 '(example-block src-block))
8347 (or org-src-preserve-indentation
8348 (org-element-property :preserve-indent e))
8349 (goto-char (org-element-property :end e))
8350 (progn (skip-chars-backward " \r\t\n")
8351 (beginning-of-line)
8352 t))))
8353 (forward-line)))))))))
8355 (defun org-convert-to-odd-levels ()
8356 "Convert an org-mode file with all levels allowed to one with odd levels.
8357 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8358 level 5 etc."
8359 (interactive)
8360 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8361 (let ((outline-level 'org-outline-level)
8362 (org-odd-levels-only nil) n)
8363 (save-excursion
8364 (goto-char (point-min))
8365 (while (re-search-forward "^\\*\\*+ " nil t)
8366 (setq n (- (length (match-string 0)) 2))
8367 (while (>= (setq n (1- n)) 0)
8368 (org-demote))
8369 (end-of-line 1))))))
8371 (defun org-convert-to-oddeven-levels ()
8372 "Convert an org-mode file with only odd levels to one with odd/even levels.
8373 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8374 file contains a section with an even level, conversion would
8375 destroy the structure of the file. An error is signaled in this
8376 case."
8377 (interactive)
8378 (goto-char (point-min))
8379 ;; First check if there are no even levels
8380 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8381 (org-show-set-visibility 'canonical)
8382 (error "Not all levels are odd in this file. Conversion not possible"))
8383 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8384 (let ((outline-regexp org-outline-regexp)
8385 (outline-level 'org-outline-level)
8386 (org-odd-levels-only nil) n)
8387 (save-excursion
8388 (goto-char (point-min))
8389 (while (re-search-forward "^\\*\\*+ " nil t)
8390 (setq n (/ (1- (length (match-string 0))) 2))
8391 (while (>= (setq n (1- n)) 0)
8392 (org-promote))
8393 (end-of-line 1))))))
8395 (defun org-tr-level (n)
8396 "Make N odd if required."
8397 (if org-odd-levels-only (1+ (/ n 2)) n))
8399 ;;; Vertical tree motion, cutting and pasting of subtrees
8401 (defun org-move-subtree-up (&optional arg)
8402 "Move the current subtree up past ARG headlines of the same level."
8403 (interactive "p")
8404 (org-move-subtree-down (- (prefix-numeric-value arg))))
8406 (defun org-move-subtree-down (&optional arg)
8407 "Move the current subtree down past ARG headlines of the same level."
8408 (interactive "p")
8409 (setq arg (prefix-numeric-value arg))
8410 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8411 'org-get-last-sibling))
8412 (ins-point (make-marker))
8413 (cnt (abs arg))
8414 (col (current-column))
8415 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8416 ;; Select the tree
8417 (org-back-to-heading)
8418 (setq beg0 (point))
8419 (save-excursion
8420 (setq ne-beg (org-back-over-empty-lines))
8421 (setq beg (point)))
8422 (save-match-data
8423 (save-excursion (outline-end-of-heading)
8424 (setq folded (outline-invisible-p)))
8425 (progn (org-end-of-subtree nil t)
8426 (unless (eobp) (backward-char))))
8427 (outline-next-heading)
8428 (setq ne-end (org-back-over-empty-lines))
8429 (setq end (point))
8430 (goto-char beg0)
8431 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8432 ;; include less whitespace
8433 (save-excursion
8434 (goto-char beg)
8435 (forward-line (- ne-beg ne-end))
8436 (setq beg (point))))
8437 ;; Find insertion point, with error handling
8438 (while (> cnt 0)
8439 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8440 (progn (goto-char beg0)
8441 (user-error "Cannot move past superior level or buffer limit")))
8442 (setq cnt (1- cnt)))
8443 (if (> arg 0)
8444 ;; Moving forward - still need to move over subtree
8445 (progn (org-end-of-subtree t t)
8446 (save-excursion
8447 (org-back-over-empty-lines)
8448 (or (bolp) (newline)))))
8449 (setq ne-ins (org-back-over-empty-lines))
8450 (move-marker ins-point (point))
8451 (setq txt (buffer-substring beg end))
8452 (org-save-markers-in-region beg end)
8453 (delete-region beg end)
8454 (org-remove-empty-overlays-at beg)
8455 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8456 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8457 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8458 (let ((bbb (point)))
8459 (insert-before-markers txt)
8460 (org-reinstall-markers-in-region bbb)
8461 (move-marker ins-point bbb))
8462 (or (bolp) (insert "\n"))
8463 (setq ins-end (point))
8464 (goto-char ins-point)
8465 (org-skip-whitespace)
8466 (when (and (< arg 0)
8467 (org-first-sibling-p)
8468 (> ne-ins ne-beg))
8469 ;; Move whitespace back to beginning
8470 (save-excursion
8471 (goto-char ins-end)
8472 (let ((kill-whole-line t))
8473 (kill-line (- ne-ins ne-beg)) (point)))
8474 (insert (make-string (- ne-ins ne-beg) ?\n)))
8475 (move-marker ins-point nil)
8476 (if folded
8477 (hide-subtree)
8478 (org-show-entry)
8479 (show-children)
8480 (org-cycle-hide-drawers 'children))
8481 (org-clean-visibility-after-subtree-move)
8482 ;; move back to the initial column we were at
8483 (move-to-column col)))
8485 (defvar org-subtree-clip ""
8486 "Clipboard for cut and paste of subtrees.
8487 This is actually only a copy of the kill, because we use the normal kill
8488 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8490 (defvar org-subtree-clip-folded nil
8491 "Was the last copied subtree folded?
8492 This is used to fold the tree back after pasting.")
8494 (defun org-cut-subtree (&optional n)
8495 "Cut the current subtree into the clipboard.
8496 With prefix arg N, cut this many sequential subtrees.
8497 This is a short-hand for marking the subtree and then cutting it."
8498 (interactive "p")
8499 (org-copy-subtree n 'cut))
8501 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8502 "Copy the current subtree it in the clipboard.
8503 With prefix arg N, copy this many sequential subtrees.
8504 This is a short-hand for marking the subtree and then copying it.
8505 If CUT is non-nil, actually cut the subtree.
8506 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8507 of some markers in the region, even if CUT is non-nil. This is
8508 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8509 (interactive "p")
8510 (let (beg end folded (beg0 (point)))
8511 (if (org-called-interactively-p 'any)
8512 (org-back-to-heading nil) ; take what looks like a subtree
8513 (org-back-to-heading t)) ; take what is really there
8514 (setq beg (point))
8515 (skip-chars-forward " \t\r\n")
8516 (save-match-data
8517 (if nosubtrees
8518 (outline-next-heading)
8519 (save-excursion (outline-end-of-heading)
8520 (setq folded (outline-invisible-p)))
8521 (ignore-errors (org-forward-heading-same-level (1- n) t))
8522 (org-end-of-subtree t t)))
8523 ;; Include the end of an inlinetask
8524 (when (and (featurep 'org-inlinetask)
8525 (looking-at-p (concat (org-inlinetask-outline-regexp)
8526 "END[ \t]*$")))
8527 (end-of-line))
8528 (setq end (point))
8529 (goto-char beg0)
8530 (when (> end beg)
8531 (setq org-subtree-clip-folded folded)
8532 (when (or cut force-store-markers)
8533 (org-save-markers-in-region beg end))
8534 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8535 (setq org-subtree-clip (current-kill 0))
8536 (message "%s: Subtree(s) with %d characters"
8537 (if cut "Cut" "Copied")
8538 (length org-subtree-clip)))))
8540 (defun org-paste-subtree (&optional level tree for-yank remove)
8541 "Paste the clipboard as a subtree, with modification of headline level.
8542 The entire subtree is promoted or demoted in order to match a new headline
8543 level.
8545 If the cursor is at the beginning of a headline, the same level as
8546 that headline is used to paste the tree.
8548 If not, the new level is derived from the *visible* headings
8549 before and after the insertion point, and taken to be the inferior headline
8550 level of the two. So if the previous visible heading is level 3 and the
8551 next is level 4 (or vice versa), level 4 will be used for insertion.
8552 This makes sure that the subtree remains an independent subtree and does
8553 not swallow low level entries.
8555 You can also force a different level, either by using a numeric prefix
8556 argument, or by inserting the heading marker by hand. For example, if the
8557 cursor is after \"*****\", then the tree will be shifted to level 5.
8559 If optional TREE is given, use this text instead of the kill ring.
8561 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8562 move back over whitespace before inserting, and move point to the end of
8563 the inserted text when done.
8565 When REMOVE is non-nil, remove the subtree from the clipboard."
8566 (interactive "P")
8567 (setq tree (or tree (and kill-ring (current-kill 0))))
8568 (unless (org-kill-is-subtree-p tree)
8569 (user-error "%s"
8570 (substitute-command-keys
8571 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8572 (org-with-limited-levels
8573 (let* ((visp (not (outline-invisible-p)))
8574 (txt tree)
8575 (^re_ "\\(\\*+\\)[ \t]*")
8576 (old-level (if (string-match org-outline-regexp-bol txt)
8577 (- (match-end 0) (match-beginning 0) 1)
8578 -1))
8579 (force-level (cond (level (prefix-numeric-value level))
8580 ((and (looking-at "[ \t]*$")
8581 (string-match
8582 "^\\*+$" (buffer-substring
8583 (point-at-bol) (point))))
8584 (- (match-end 0) (match-beginning 0)))
8585 ((and (bolp)
8586 (looking-at org-outline-regexp))
8587 (- (match-end 0) (point) 1))))
8588 (previous-level (save-excursion
8589 (condition-case nil
8590 (progn
8591 (outline-previous-visible-heading 1)
8592 (if (looking-at ^re_)
8593 (- (match-end 0) (match-beginning 0) 1)
8595 (error 1))))
8596 (next-level (save-excursion
8597 (condition-case nil
8598 (progn
8599 (or (looking-at org-outline-regexp)
8600 (outline-next-visible-heading 1))
8601 (if (looking-at ^re_)
8602 (- (match-end 0) (match-beginning 0) 1)
8604 (error 1))))
8605 (new-level (or force-level (max previous-level next-level)))
8606 (shift (if (or (= old-level -1)
8607 (= new-level -1)
8608 (= old-level new-level))
8610 (- new-level old-level)))
8611 (delta (if (> shift 0) -1 1))
8612 (func (if (> shift 0) 'org-demote 'org-promote))
8613 (org-odd-levels-only nil)
8614 beg end newend)
8615 ;; Remove the forced level indicator
8616 (if force-level
8617 (delete-region (point-at-bol) (point)))
8618 ;; Paste
8619 (beginning-of-line (if (bolp) 1 2))
8620 (setq beg (point))
8621 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8622 (insert-before-markers txt)
8623 (unless (string-match "\n\\'" txt) (insert "\n"))
8624 (setq newend (point))
8625 (org-reinstall-markers-in-region beg)
8626 (setq end (point))
8627 (goto-char beg)
8628 (skip-chars-forward " \t\n\r")
8629 (setq beg (point))
8630 (if (and (outline-invisible-p) visp)
8631 (save-excursion (outline-show-heading)))
8632 ;; Shift if necessary
8633 (unless (= shift 0)
8634 (save-restriction
8635 (narrow-to-region beg end)
8636 (while (not (= shift 0))
8637 (org-map-region func (point-min) (point-max))
8638 (setq shift (+ delta shift)))
8639 (goto-char (point-min))
8640 (setq newend (point-max))))
8641 (when (or (org-called-interactively-p 'interactive) for-yank)
8642 (message "Clipboard pasted as level %d subtree" new-level))
8643 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8644 kill-ring
8645 (eq org-subtree-clip (current-kill 0))
8646 org-subtree-clip-folded)
8647 ;; The tree was folded before it was killed/copied
8648 (hide-subtree))
8649 (and for-yank (goto-char newend))
8650 (and remove (setq kill-ring (cdr kill-ring))))))
8652 (defun org-kill-is-subtree-p (&optional txt)
8653 "Check if the current kill is an outline subtree, or a set of trees.
8654 Returns nil if kill does not start with a headline, or if the first
8655 headline level is not the largest headline level in the tree.
8656 So this will actually accept several entries of equal levels as well,
8657 which is OK for `org-paste-subtree'.
8658 If optional TXT is given, check this string instead of the current kill."
8659 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8660 (re (org-get-limited-outline-regexp))
8661 (^re (concat "^" re))
8662 (start-level (and kill
8663 (string-match
8664 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8665 kill)
8666 (- (match-end 2) (match-beginning 2) 1)))
8667 (start (1+ (or (match-beginning 2) -1))))
8668 (if (not start-level)
8669 (progn
8670 nil) ;; does not even start with a heading
8671 (catch 'exit
8672 (while (setq start (string-match ^re kill (1+ start)))
8673 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8674 (throw 'exit nil)))
8675 t))))
8677 (defvar org-markers-to-move nil
8678 "Markers that should be moved with a cut-and-paste operation.
8679 Those markers are stored together with their positions relative to
8680 the start of the region.")
8682 (defun org-save-markers-in-region (beg end)
8683 "Check markers in region.
8684 If these markers are between BEG and END, record their position relative
8685 to BEG, so that after moving the block of text, we can put the markers back
8686 into place.
8687 This function gets called just before an entry or tree gets cut from the
8688 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8689 called immediately, to move the markers with the entries."
8690 (setq org-markers-to-move nil)
8691 (when (featurep 'org-clock)
8692 (org-clock-save-markers-for-cut-and-paste beg end))
8693 (when (featurep 'org-agenda)
8694 (org-agenda-save-markers-for-cut-and-paste beg end)))
8696 (defun org-check-and-save-marker (marker beg end)
8697 "Check if MARKER is between BEG and END.
8698 If yes, remember the marker and the distance to BEG."
8699 (when (and (marker-buffer marker)
8700 (equal (marker-buffer marker) (current-buffer)))
8701 (if (and (>= marker beg) (< marker end))
8702 (push (cons marker (- marker beg)) org-markers-to-move))))
8704 (defun org-reinstall-markers-in-region (beg)
8705 "Move all remembered markers to their position relative to BEG."
8706 (mapc (lambda (x)
8707 (move-marker (car x) (+ beg (cdr x))))
8708 org-markers-to-move)
8709 (setq org-markers-to-move nil))
8711 (defun org-narrow-to-subtree ()
8712 "Narrow buffer to the current subtree."
8713 (interactive)
8714 (save-excursion
8715 (save-match-data
8716 (org-with-limited-levels
8717 (narrow-to-region
8718 (progn (org-back-to-heading t) (point))
8719 (progn (org-end-of-subtree t t)
8720 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8721 (point)))))))
8723 (defun org-narrow-to-block ()
8724 "Narrow buffer to the current block."
8725 (interactive)
8726 (let* ((case-fold-search t)
8727 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8728 "^[ \t]*#\\+end_.*")))
8729 (if blockp
8730 (narrow-to-region (car blockp) (cdr blockp))
8731 (user-error "Not in a block"))))
8733 (defun org-clone-subtree-with-time-shift (n &optional shift)
8734 "Clone the task (subtree) at point N times.
8735 The clones will be inserted as siblings.
8737 In interactive use, the user will be prompted for the number of
8738 clones to be produced. If the entry has a timestamp, the user
8739 will also be prompted for a time shift, which may be a repeater
8740 as used in time stamps, for example `+3d'. To disable this,
8741 you can call the function with a universal prefix argument.
8743 When a valid repeater is given and the entry contains any time
8744 stamps, the clones will become a sequence in time, with time
8745 stamps in the subtree shifted for each clone produced. If SHIFT
8746 is nil or the empty string, time stamps will be left alone. The
8747 ID property of the original subtree is removed.
8749 If the original subtree did contain time stamps with a repeater,
8750 the following will happen:
8751 - the repeater will be removed in each clone
8752 - an additional clone will be produced, with the current, unshifted
8753 date(s) in the entry.
8754 - the original entry will be placed *after* all the clones, with
8755 repeater intact.
8756 - the start days in the repeater in the original entry will be shifted
8757 to past the last clone.
8758 In this way you can spell out a number of instances of a repeating task,
8759 and still retain the repeater to cover future instances of the task.
8761 As described above, N+1 clones are produced when the original
8762 subtree has a repeater. Setting N to 0, then, can be used to
8763 remove the repeater from a subtree and create a shifted clone
8764 with the original repeater."
8765 (interactive "nNumber of clones to produce: ")
8766 (let ((shift
8767 (or shift
8768 (if (and (not (equal current-prefix-arg '(4)))
8769 (save-excursion
8770 (re-search-forward org-ts-regexp-both
8771 (save-excursion
8772 (org-end-of-subtree t)
8773 (point)) t)))
8774 (read-from-minibuffer
8775 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8776 ""))) ;; No time shift
8777 (n-no-remove -1)
8778 (drawer-re org-drawer-regexp)
8779 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8780 beg end template task idprop
8781 shift-n shift-what doshift nmin nmax)
8782 (unless (wholenump n)
8783 (user-error "Invalid number of replications %s" n))
8784 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8785 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8786 shift)))
8787 (user-error "Invalid shift specification %s" shift))
8788 (when doshift
8789 (setq shift-n (string-to-number (match-string 1 shift))
8790 shift-what (cdr (assoc (match-string 2 shift)
8791 '(("d" . day) ("w" . week)
8792 ("m" . month) ("y" . year))))))
8793 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8794 (setq nmin 1 nmax n)
8795 (org-back-to-heading t)
8796 (setq beg (point))
8797 (setq idprop (org-entry-get nil "ID"))
8798 (org-end-of-subtree t t)
8799 (or (bolp) (insert "\n"))
8800 (setq end (point))
8801 (setq template (buffer-substring beg end))
8802 (when (and doshift
8803 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8804 (delete-region beg end)
8805 (setq end beg)
8806 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8807 (goto-char end)
8808 (loop for n from nmin to nmax do
8809 ;; prepare clone
8810 (with-temp-buffer
8811 (insert template)
8812 (org-mode)
8813 (goto-char (point-min))
8814 (org-show-subtree)
8815 (and idprop (if org-clone-delete-id
8816 (org-entry-delete nil "ID")
8817 (org-id-get-create t)))
8818 (unless (= n 0)
8819 (while (re-search-forward org-clock-re nil t)
8820 (kill-whole-line))
8821 (goto-char (point-min))
8822 (while (re-search-forward drawer-re nil t)
8823 (org-remove-empty-drawer-at (point))))
8824 (goto-char (point-min))
8825 (when doshift
8826 (while (re-search-forward org-ts-regexp-both nil t)
8827 (org-timestamp-change (* n shift-n) shift-what))
8828 (unless (= n n-no-remove)
8829 (goto-char (point-min))
8830 (while (re-search-forward org-ts-regexp nil t)
8831 (save-excursion
8832 (goto-char (match-beginning 0))
8833 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8834 (delete-region (match-beginning 1) (match-end 1)))))))
8835 (setq task (buffer-string)))
8836 (insert task))
8837 (goto-char beg)))
8839 ;;; Outline Sorting
8841 (defun org-sort (with-case)
8842 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8843 Optional argument WITH-CASE means sort case-sensitively."
8844 (interactive "P")
8845 (cond
8846 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8847 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8849 (org-call-with-arg 'org-sort-entries with-case))))
8851 (defun org-sort-remove-invisible (s)
8852 "Remove invisible links from string S."
8853 (remove-text-properties 0 (length s) org-rm-props s)
8854 (while (string-match org-bracket-link-regexp s)
8855 (setq s (replace-match (if (match-end 2)
8856 (match-string 3 s)
8857 (match-string 1 s))
8858 t t s)))
8859 (let ((st (format " %s " s)))
8860 (while (string-match org-emph-re st)
8861 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8862 (setq s (substring st 1 -1)))
8865 (defvar org-priority-regexp) ; defined later in the file
8867 (defvar org-after-sorting-entries-or-items-hook nil
8868 "Hook that is run after a bunch of entries or items have been sorted.
8869 When children are sorted, the cursor is in the parent line when this
8870 hook gets called. When a region or a plain list is sorted, the cursor
8871 will be in the first entry of the sorted region/list.")
8873 (defun org-sort-entries
8874 (&optional with-case sorting-type getkey-func compare-func property)
8875 "Sort entries on a certain level of an outline tree.
8876 If there is an active region, the entries in the region are sorted.
8877 Else, if the cursor is before the first entry, sort the top-level items.
8878 Else, the children of the entry at point are sorted.
8880 Sorting can be alphabetically, numerically, by date/time as given by
8881 a time stamp, by a property, by priority order, or by a custom function.
8883 The command prompts for the sorting type unless it has been given to the
8884 function through the SORTING-TYPE argument, which needs to be a character,
8885 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8886 the precise meaning of each character:
8888 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8889 c By creation time, which is assumed to be the first inactive time stamp
8890 at the beginning of a line.
8891 d By deadline date/time.
8892 k By clocking time.
8893 n Numerically, by converting the beginning of the entry/item to a number.
8894 o By order of TODO keywords.
8895 p By priority according to the cookie.
8896 r By the value of a property.
8897 s By scheduled date/time.
8898 t By date/time, either the first active time stamp in the entry, or, if
8899 none exist, by the first inactive one.
8901 Capital letters will reverse the sort order.
8903 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8904 called with point at the beginning of the record. It must return either
8905 a string or a number that should serve as the sorting key for that record.
8907 Comparing entries ignores case by default. However, with an optional argument
8908 WITH-CASE, the sorting considers case as well.
8910 Sorting is done against the visible part of the headlines, it ignores hidden
8911 links.
8913 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8914 (interactive "P")
8915 (let ((case-func (if with-case 'identity 'downcase))
8916 (cmstr
8917 ;; The clock marker is lost when using `sort-subr', let's
8918 ;; store the clocking string.
8919 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8920 (save-excursion
8921 (goto-char org-clock-marker)
8922 (buffer-substring-no-properties (line-beginning-position)
8923 (point)))))
8924 start beg end stars re re2
8925 txt what tmp)
8926 ;; Find beginning and end of region to sort
8927 (cond
8928 ((org-region-active-p)
8929 ;; we will sort the region
8930 (setq end (region-end)
8931 what "region")
8932 (goto-char (region-beginning))
8933 (if (not (org-at-heading-p)) (outline-next-heading))
8934 (setq start (point)))
8935 ((or (org-at-heading-p)
8936 (ignore-errors (progn (org-back-to-heading) t)))
8937 ;; we will sort the children of the current headline
8938 (org-back-to-heading)
8939 (setq start (point)
8940 end (progn (org-end-of-subtree t t)
8941 (or (bolp) (insert "\n"))
8942 (when (>= (org-back-over-empty-lines) 1)
8943 (forward-line 1))
8944 (point))
8945 what "children")
8946 (goto-char start)
8947 (show-subtree)
8948 (outline-next-heading))
8950 ;; we will sort the top-level entries in this file
8951 (goto-char (point-min))
8952 (or (org-at-heading-p) (outline-next-heading))
8953 (setq start (point))
8954 (goto-char (point-max))
8955 (beginning-of-line 1)
8956 (when (looking-at ".*?\\S-")
8957 ;; File ends in a non-white line
8958 (end-of-line 1)
8959 (insert "\n"))
8960 (setq end (point-max))
8961 (setq what "top-level")
8962 (goto-char start)
8963 (show-all)))
8965 (setq beg (point))
8966 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8968 (looking-at "\\(\\*+\\)")
8969 (setq stars (match-string 1)
8970 re (concat "^" (regexp-quote stars) " +")
8971 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8972 txt (buffer-substring beg end))
8973 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8974 (if (and (not (equal stars "*")) (string-match re2 txt))
8975 (user-error "Region to sort contains a level above the first entry"))
8977 (unless sorting-type
8978 (message
8979 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8980 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8981 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8982 what)
8983 (setq sorting-type (read-char-exclusive))
8985 (unless getkey-func
8986 (and (= (downcase sorting-type) ?f)
8987 (setq getkey-func
8988 (org-icompleting-read "Sort using function: "
8989 obarray 'fboundp t nil nil))
8990 (setq getkey-func (intern getkey-func))))
8992 (and (= (downcase sorting-type) ?r)
8993 (not property)
8994 (setq property
8995 (org-icompleting-read "Property: "
8996 (mapcar 'list (org-buffer-property-keys t))
8997 nil t))))
8999 (when (member sorting-type '(?k ?K)) (org-clock-sum))
9000 (message "Sorting entries...")
9002 (save-restriction
9003 (narrow-to-region start end)
9004 (let ((dcst (downcase sorting-type))
9005 (case-fold-search nil)
9006 (now (current-time)))
9007 (sort-subr
9008 (/= dcst sorting-type)
9009 ;; This function moves to the beginning character of the "record" to
9010 ;; be sorted.
9011 (lambda nil
9012 (if (re-search-forward re nil t)
9013 (goto-char (match-beginning 0))
9014 (goto-char (point-max))))
9015 ;; This function moves to the last character of the "record" being
9016 ;; sorted.
9017 (lambda nil
9018 (save-match-data
9019 (condition-case nil
9020 (outline-forward-same-level 1)
9021 (error
9022 (goto-char (point-max))))))
9023 ;; This function returns the value that gets sorted against.
9024 (lambda nil
9025 (cond
9026 ((= dcst ?n)
9027 (if (looking-at org-complex-heading-regexp)
9028 (string-to-number (org-sort-remove-invisible (match-string 4)))
9029 nil))
9030 ((= dcst ?a)
9031 (if (looking-at org-complex-heading-regexp)
9032 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9033 nil))
9034 ((= dcst ?k)
9035 (or (get-text-property (point) :org-clock-minutes) 0))
9036 ((= dcst ?t)
9037 (let ((end (save-excursion (outline-next-heading) (point))))
9038 (if (or (re-search-forward org-ts-regexp end t)
9039 (re-search-forward org-ts-regexp-both end t))
9040 (org-time-string-to-seconds (match-string 0))
9041 (org-float-time now))))
9042 ((= dcst ?c)
9043 (let ((end (save-excursion (outline-next-heading) (point))))
9044 (if (re-search-forward
9045 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9046 end t)
9047 (org-time-string-to-seconds (match-string 0))
9048 (org-float-time now))))
9049 ((= dcst ?s)
9050 (let ((end (save-excursion (outline-next-heading) (point))))
9051 (if (re-search-forward org-scheduled-time-regexp end t)
9052 (org-time-string-to-seconds (match-string 1))
9053 (org-float-time now))))
9054 ((= dcst ?d)
9055 (let ((end (save-excursion (outline-next-heading) (point))))
9056 (if (re-search-forward org-deadline-time-regexp end t)
9057 (org-time-string-to-seconds (match-string 1))
9058 (org-float-time now))))
9059 ((= dcst ?p)
9060 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9061 (string-to-char (match-string 2))
9062 org-default-priority))
9063 ((= dcst ?r)
9064 (or (org-entry-get nil property) ""))
9065 ((= dcst ?o)
9066 (if (looking-at org-complex-heading-regexp)
9067 (let* ((m (match-string 2))
9068 (s (if (member m org-done-keywords) '- '+)))
9069 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9070 ((= dcst ?f)
9071 (if getkey-func
9072 (progn
9073 (setq tmp (funcall getkey-func))
9074 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9075 tmp)
9076 (error "Invalid key function `%s'" getkey-func)))
9077 (t (error "Invalid sorting type `%c'" sorting-type))))
9079 (cond
9080 ((= dcst ?a) 'string<)
9081 ((= dcst ?f) compare-func)
9082 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9083 (run-hooks 'org-after-sorting-entries-or-items-hook)
9084 ;; Reset the clock marker if needed
9085 (when cmstr
9086 (save-excursion
9087 (goto-char start)
9088 (search-forward cmstr nil t)
9089 (move-marker org-clock-marker (point))))
9090 (message "Sorting entries...done")))
9092 ;;; The orgstruct minor mode
9094 ;; Define a minor mode which can be used in other modes in order to
9095 ;; integrate the org-mode structure editing commands.
9097 ;; This is really a hack, because the org-mode structure commands use
9098 ;; keys which normally belong to the major mode. Here is how it
9099 ;; works: The minor mode defines all the keys necessary to operate the
9100 ;; structure commands, but wraps the commands into a function which
9101 ;; tests if the cursor is currently at a headline or a plain list
9102 ;; item. If that is the case, the structure command is used,
9103 ;; temporarily setting many Org-mode variables like regular
9104 ;; expressions for filling etc. However, when any of those keys is
9105 ;; used at a different location, function uses `key-binding' to look
9106 ;; up if the key has an associated command in another currently active
9107 ;; keymap (minor modes, major mode, global), and executes that
9108 ;; command. There might be problems if any of the keys is otherwise
9109 ;; used as a prefix key.
9111 (defcustom orgstruct-heading-prefix-regexp ""
9112 "Regexp that matches the custom prefix of Org headlines in
9113 orgstruct(++)-mode."
9114 :group 'org
9115 :version "24.4"
9116 :package-version '(Org . "8.3")
9117 :type 'regexp)
9118 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9120 (defcustom orgstruct-setup-hook nil
9121 "Hook run after orgstruct-mode-map is filled."
9122 :group 'org
9123 :version "24.4"
9124 :package-version '(Org . "8.0")
9125 :type 'hook)
9127 (defvar orgstruct-initialized nil)
9129 (defvar org-local-vars nil
9130 "List of local variables, for use by `orgstruct-mode'.")
9132 ;;;###autoload
9133 (define-minor-mode orgstruct-mode
9134 "Toggle the minor mode `orgstruct-mode'.
9135 This mode is for using Org-mode structure commands in other
9136 modes. The following keys behave as if Org-mode were active, if
9137 the cursor is on a headline, or on a plain list item (both as
9138 defined by Org-mode)."
9139 nil " OrgStruct" (make-sparse-keymap)
9140 (funcall (if orgstruct-mode
9141 'add-to-invisibility-spec
9142 'remove-from-invisibility-spec)
9143 '(outline . t))
9144 (when orgstruct-mode
9145 (org-load-modules-maybe)
9146 (unless orgstruct-initialized
9147 (orgstruct-setup)
9148 (setq orgstruct-initialized t))))
9150 ;;;###autoload
9151 (defun turn-on-orgstruct ()
9152 "Unconditionally turn on `orgstruct-mode'."
9153 (orgstruct-mode 1))
9155 (defvar org-fb-vars nil)
9156 (make-variable-buffer-local 'org-fb-vars)
9157 (defun orgstruct++-mode (&optional arg)
9158 "Toggle `orgstruct-mode', the enhanced version of it.
9159 In addition to setting orgstruct-mode, this also exports all
9160 indentation and autofilling variables from org-mode into the
9161 buffer. It will also recognize item context in multiline items."
9162 (interactive "P")
9163 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9164 (if (< arg 1)
9165 (progn (orgstruct-mode -1)
9166 (mapc (lambda(v)
9167 (org-set-local (car v)
9168 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9169 org-fb-vars))
9170 (orgstruct-mode 1)
9171 (setq org-fb-vars nil)
9172 (unless org-local-vars
9173 (setq org-local-vars (org-get-local-variables)))
9174 (let (var val)
9175 (mapc
9176 (lambda (x)
9177 (when (string-match
9178 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9179 (symbol-name (car x)))
9180 (setq var (car x) val (nth 1 x))
9181 (push (list var `(quote ,(eval var))) org-fb-vars)
9182 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9183 org-local-vars)
9184 (org-set-local 'orgstruct-is-++ t))))
9186 (defvar orgstruct-is-++ nil
9187 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9188 (make-variable-buffer-local 'orgstruct-is-++)
9190 ;;;###autoload
9191 (defun turn-on-orgstruct++ ()
9192 "Unconditionally turn on `orgstruct++-mode'."
9193 (orgstruct++-mode 1))
9195 (defun orgstruct-error ()
9196 "Error when there is no default binding for a structure key."
9197 (interactive)
9198 (funcall (if (fboundp 'user-error)
9199 'user-error
9200 'error)
9201 "This key has no function outside structure elements"))
9203 (defun orgstruct-setup ()
9204 "Setup orgstruct keymap."
9205 (dolist (cell '((org-demote . t)
9206 (org-metaleft . t)
9207 (org-metaright . t)
9208 (org-promote . t)
9209 (org-shiftmetaleft . t)
9210 (org-shiftmetaright . t)
9211 org-backward-element
9212 org-backward-heading-same-level
9213 org-ctrl-c-ret
9214 org-ctrl-c-minus
9215 org-ctrl-c-star
9216 org-cycle
9217 org-forward-heading-same-level
9218 org-insert-heading
9219 org-insert-heading-respect-content
9220 org-kill-note-or-show-branches
9221 org-mark-subtree
9222 org-meta-return
9223 org-metadown
9224 org-metaup
9225 org-narrow-to-subtree
9226 org-promote-subtree
9227 org-reveal
9228 org-shiftdown
9229 org-shiftleft
9230 org-shiftmetadown
9231 org-shiftmetaup
9232 org-shiftright
9233 org-shifttab
9234 org-shifttab
9235 org-shiftup
9236 org-show-subtree
9237 org-sort
9238 org-up-element
9239 outline-demote
9240 outline-next-visible-heading
9241 outline-previous-visible-heading
9242 outline-promote
9243 outline-up-heading
9244 show-children))
9245 (let ((f (or (car-safe cell) cell))
9246 (disable-when-heading-prefix (cdr-safe cell)))
9247 (when (fboundp f)
9248 (let ((new-bindings))
9249 (dolist (binding (nconc (where-is-internal f org-mode-map)
9250 (where-is-internal f outline-mode-map)))
9251 (push binding new-bindings)
9252 ;; TODO use local-function-key-map
9253 (dolist (rep '(("<tab>" . "TAB")
9254 ("<return>" . "RET")
9255 ("<escape>" . "ESC")
9256 ("<delete>" . "DEL")))
9257 (setq binding (read-kbd-macro
9258 (let ((case-fold-search))
9259 (replace-regexp-in-string
9260 (regexp-quote (cdr rep))
9261 (car rep)
9262 (key-description binding)))))
9263 (pushnew binding new-bindings :test 'equal)))
9264 (dolist (binding new-bindings)
9265 (let ((key (lookup-key orgstruct-mode-map binding)))
9266 (when (or (not key) (numberp key))
9267 (ignore-errors
9268 (org-defkey orgstruct-mode-map
9269 binding
9270 (orgstruct-make-binding
9271 f binding disable-when-heading-prefix))))))))))
9272 (run-hooks 'orgstruct-setup-hook))
9274 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9275 "Create a function for binding in the structure minor mode.
9276 FUN is the command to call inside a table. KEY is the key that
9277 should be checked in for a command to execute outside of tables.
9278 Non-nil `disable-when-heading-prefix' means to disable the command
9279 if `orgstruct-heading-prefix-regexp' is not empty."
9280 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9281 (let ((nname name)
9282 (i 0))
9283 (while (fboundp (intern nname))
9284 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9285 (setq name (intern nname)))
9286 (eval
9287 (let ((bindings '((org-heading-regexp
9288 (concat "^"
9289 orgstruct-heading-prefix-regexp
9290 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9291 (org-outline-regexp
9292 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9293 (org-outline-regexp-bol
9294 (concat "^" org-outline-regexp))
9295 (outline-regexp org-outline-regexp)
9296 (outline-heading-end-regexp "\n")
9297 (outline-level 'org-outline-level)
9298 (outline-heading-alist))))
9299 `(defun ,name (arg)
9300 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9301 "Outside of structure, run the binding of `"
9302 (key-description key) "'."
9303 (when disable-when-heading-prefix
9304 (concat
9305 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9306 "back to the default binding due to limitations of Org's implementation of\n"
9307 "`" (symbol-name fun) "'.")))
9308 (interactive "p")
9309 (let* ((disable
9310 ,(and disable-when-heading-prefix
9311 '(not (string= orgstruct-heading-prefix-regexp ""))))
9312 (fallback
9313 (or disable
9314 (not
9315 (let* ,bindings
9316 (org-context-p 'headline 'item
9317 ,(when (memq fun
9318 '(org-insert-heading
9319 org-insert-heading-respect-content
9320 org-meta-return))
9321 '(when orgstruct-is-++
9322 'item-body))))))))
9323 (if fallback
9324 (let* ((orgstruct-mode)
9325 (binding
9326 (let ((key ,key))
9327 (catch 'exit
9328 (dolist
9329 (rep
9330 '(nil
9331 ("<\\([^>]*\\)tab>" . "\\1TAB")
9332 ("<\\([^>]*\\)return>" . "\\1RET")
9333 ("<\\([^>]*\\)escape>" . "\\1ESC")
9334 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9335 nil)
9336 (when rep
9337 (setq key (read-kbd-macro
9338 (let ((case-fold-search))
9339 (replace-regexp-in-string
9340 (car rep)
9341 (cdr rep)
9342 (key-description key))))))
9343 (when (key-binding key)
9344 (throw 'exit (key-binding key))))))))
9345 (if (keymapp binding)
9346 (org-set-transient-map binding)
9347 (let ((func (or binding
9348 (unless disable
9349 'orgstruct-error))))
9350 (when func
9351 (call-interactively func)))))
9352 (org-run-like-in-org-mode
9353 (lambda ()
9354 (interactive)
9355 (let* ,bindings
9356 (call-interactively ',fun)))))))))
9357 name))
9359 (defun org-contextualize-keys (alist contexts)
9360 "Return valid elements in ALIST depending on CONTEXTS.
9362 `org-agenda-custom-commands' or `org-capture-templates' are the
9363 values used for ALIST, and `org-agenda-custom-commands-contexts'
9364 or `org-capture-templates-contexts' are the associated contexts
9365 definitions."
9366 (let ((contexts
9367 ;; normalize contexts
9368 (mapcar
9369 (lambda(c) (cond ((listp (cadr c))
9370 (list (car c) (car c) (cadr c)))
9371 ((string= "" (cadr c))
9372 (list (car c) (car c) (caddr c)))
9373 (t c)))
9374 contexts))
9375 (a alist) r s)
9376 ;; loop over all commands or templates
9377 (dolist (c a)
9378 (let (vrules repl)
9379 (cond
9380 ((not (assoc (car c) contexts))
9381 (push c r))
9382 ((and (assoc (car c) contexts)
9383 (setq vrules (org-contextualize-validate-key
9384 (car c) contexts)))
9385 (mapc (lambda (vr)
9386 (when (not (equal (car vr) (cadr vr)))
9387 (setq repl vr)))
9388 vrules)
9389 (if (not repl) (push c r)
9390 (push (cadr repl) s)
9391 (push
9392 (cons (car c)
9393 (cdr (or (assoc (cadr repl) alist)
9394 (error "Undefined key `%s' as contextual replacement for `%s'"
9395 (cadr repl) (car c)))))
9396 r))))))
9397 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9398 (delq
9400 (delete-dups
9401 (mapcar (lambda (x)
9402 (let ((tpl (car x)))
9403 (when (not (delq
9405 (mapcar (lambda (y)
9406 (equal y tpl))
9407 s)))
9408 x)))
9409 (reverse r))))))
9411 (defun org-contextualize-validate-key (key contexts)
9412 "Check CONTEXTS for agenda or capture KEY."
9413 (let (rr res)
9414 (dolist (r contexts)
9415 (mapc
9416 (lambda (rr)
9417 (when
9418 (and (equal key (car r))
9419 (if (functionp rr) (funcall rr)
9420 (or (and (eq (car rr) 'in-file)
9421 (buffer-file-name)
9422 (string-match (cdr rr) (buffer-file-name)))
9423 (and (eq (car rr) 'in-mode)
9424 (string-match (cdr rr) (symbol-name major-mode)))
9425 (and (eq (car rr) 'in-buffer)
9426 (string-match (cdr rr) (buffer-name)))
9427 (when (and (eq (car rr) 'not-in-file)
9428 (buffer-file-name))
9429 (not (string-match (cdr rr) (buffer-file-name))))
9430 (when (eq (car rr) 'not-in-mode)
9431 (not (string-match (cdr rr) (symbol-name major-mode))))
9432 (when (eq (car rr) 'not-in-buffer)
9433 (not (string-match (cdr rr) (buffer-name)))))))
9434 (push r res)))
9435 (car (last r))))
9436 (delete-dups (delq nil res))))
9438 (defun org-context-p (&rest contexts)
9439 "Check if local context is any of CONTEXTS.
9440 Possible values in the list of contexts are `table', `headline', and `item'."
9441 (let ((pos (point)))
9442 (goto-char (point-at-bol))
9443 (prog1 (or (and (memq 'table contexts)
9444 (looking-at "[ \t]*|"))
9445 (and (memq 'headline contexts)
9446 (looking-at org-outline-regexp))
9447 (and (memq 'item contexts)
9448 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9449 (and (memq 'item-body contexts)
9450 (org-in-item-p)))
9451 (goto-char pos))))
9453 (defun org-get-local-variables ()
9454 "Return a list of all local variables in an Org mode buffer."
9455 (let (varlist)
9456 (with-current-buffer (get-buffer-create "*Org tmp*")
9457 (erase-buffer)
9458 (org-mode)
9459 (setq varlist (buffer-local-variables)))
9460 (kill-buffer "*Org tmp*")
9461 (delq nil
9462 (mapcar
9463 (lambda (x)
9464 (setq x
9465 (if (symbolp x)
9466 (list x)
9467 (list (car x) (cdr x))))
9468 (if (and (not (get (car x) 'org-state))
9469 (string-match
9470 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9471 (symbol-name (car x))))
9472 x nil))
9473 varlist))))
9475 (defun org-clone-local-variables (from-buffer &optional regexp)
9476 "Clone local variables from FROM-BUFFER.
9477 Optional argument REGEXP selects variables to clone."
9478 (mapc
9479 (lambda (pair)
9480 (and (symbolp (car pair))
9481 (or (null regexp)
9482 (string-match regexp (symbol-name (car pair))))
9483 (set (make-local-variable (car pair))
9484 (cdr pair))))
9485 (buffer-local-variables from-buffer)))
9487 ;;;###autoload
9488 (defun org-run-like-in-org-mode (cmd)
9489 "Run a command, pretending that the current buffer is in Org-mode.
9490 This will temporarily bind local variables that are typically bound in
9491 Org-mode to the values they have in Org-mode, and then interactively
9492 call CMD."
9493 (org-load-modules-maybe)
9494 (unless org-local-vars
9495 (setq org-local-vars (org-get-local-variables)))
9496 (let (binds)
9497 (dolist (var org-local-vars)
9498 (when (or (not (boundp (car var)))
9499 (eq (symbol-value (car var))
9500 (default-value (car var))))
9501 (push (list (car var) `(quote ,(cadr var))) binds)))
9502 (eval `(let ,binds
9503 (call-interactively (quote ,cmd))))))
9505 (defun org-get-category (&optional pos force-refresh)
9506 "Get the category applying to position POS."
9507 (save-match-data
9508 (if force-refresh (org-refresh-category-properties))
9509 (let ((pos (or pos (point))))
9510 (or (get-text-property pos 'org-category)
9511 (progn (org-refresh-category-properties)
9512 (get-text-property pos 'org-category))))))
9514 ;;; Refresh properties
9516 (defun org-refresh-properties (dprop tprop)
9517 "Refresh buffer text properties.
9518 DPROP is the drawer property and TPROP is either the
9519 corresponding text property to set, or an alist with each element
9520 being a text property (as a symbol) and a function to apply to
9521 the value of the drawer property."
9522 (let ((case-fold-search t)
9523 (inhibit-read-only t))
9524 (org-with-silent-modifications
9525 (save-excursion
9526 (save-restriction
9527 (widen)
9528 (goto-char (point-min))
9529 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9530 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9532 (defun org-refresh-property (tprop p)
9533 "Refresh the buffer text property TPROP from the drawer property P.
9534 The refresh happens only for the current tree (not subtree)."
9535 (unless (org-before-first-heading-p)
9536 (save-excursion
9537 (org-back-to-heading t)
9538 (if (symbolp tprop)
9539 ;; TPROP is a text property symbol
9540 (put-text-property
9541 (point) (or (outline-next-heading) (point-max)) tprop p)
9542 ;; TPROP is an alist with (properties . function) elements
9543 (dolist (al tprop)
9544 (save-excursion
9545 (put-text-property
9546 (line-beginning-position) (or (outline-next-heading) (point-max))
9547 (car al)
9548 (funcall (cdr al) p))))))))
9550 (defun org-refresh-category-properties ()
9551 "Refresh category text properties in the buffer."
9552 (let ((case-fold-search t)
9553 (inhibit-read-only t)
9554 (default-category
9555 (cond ((null org-category)
9556 (if buffer-file-name
9557 (file-name-sans-extension
9558 (file-name-nondirectory buffer-file-name))
9559 "???"))
9560 ((symbolp org-category) (symbol-name org-category))
9561 (t org-category))))
9562 (org-with-silent-modifications
9563 (org-with-wide-buffer
9564 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9565 ;; This is the default category for the buffer. If none is
9566 ;; found, fall-back to `org-category' or buffer file name.
9567 (put-text-property
9568 (point-min) (point-max)
9569 'org-category
9570 (catch 'buffer-category
9571 (goto-char (point-max))
9572 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9573 (let ((element (org-element-at-point)))
9574 (when (eq (org-element-type element) 'keyword)
9575 (throw 'buffer-category
9576 (org-element-property :value element)))))
9577 default-category))
9578 ;; Set sub-tree specific categories.
9579 (goto-char (point-min))
9580 (let ((regexp (org-re-property "CATEGORY")))
9581 (while (re-search-forward regexp nil t)
9582 (let ((value (org-match-string-no-properties 3)))
9583 (when (org-at-property-p)
9584 (put-text-property
9585 (save-excursion (org-back-to-heading t) (point))
9586 (save-excursion (org-end-of-subtree t t) (point))
9587 'org-category
9588 value)))))))))
9590 (defun org-refresh-stats-properties ()
9591 "Refresh stats text properties in the buffer."
9592 (let (stats)
9593 (org-with-silent-modifications
9594 (save-excursion
9595 (save-restriction
9596 (widen)
9597 (goto-char (point-min))
9598 (while (re-search-forward
9599 (concat org-outline-regexp-bol ".*"
9600 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9601 nil t)
9602 (setq stats (cond ((equal (match-string 3) "0") 0)
9603 ((match-string 2)
9604 (/ (* (string-to-number (match-string 2)) 100)
9605 (string-to-number (match-string 3))))
9606 (t (string-to-number (match-string 1)))))
9607 (org-back-to-heading t)
9608 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9609 'org-stats stats)))))))
9611 (defun org-refresh-effort-properties ()
9612 "Refresh effort properties"
9613 (org-refresh-properties
9614 org-effort-property
9615 '((effort . identity)
9616 (effort-minutes . org-duration-string-to-minutes))))
9618 ;;;; Link Stuff
9620 ;;; Link abbreviations
9622 (defun org-link-expand-abbrev (link)
9623 "Apply replacements as defined in `org-link-abbrev-alist'."
9624 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9625 (let* ((key (match-string 1 link))
9626 (as (or (assoc key org-link-abbrev-alist-local)
9627 (assoc key org-link-abbrev-alist)))
9628 (tag (and (match-end 2) (match-string 3 link)))
9629 rpl)
9630 (if (not as)
9631 link
9632 (setq rpl (cdr as))
9633 (cond
9634 ((symbolp rpl) (funcall rpl tag))
9635 ((string-match "%(\\([^)]+\\))" rpl)
9636 (replace-match
9637 (save-match-data
9638 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9639 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9640 ((string-match "%h" rpl)
9641 (replace-match (url-hexify-string (or tag "")) t t rpl))
9642 (t (concat rpl tag)))))
9643 link))
9645 ;;; Storing and inserting links
9647 (defvar org-insert-link-history nil
9648 "Minibuffer history for links inserted with `org-insert-link'.")
9650 (defvar org-stored-links nil
9651 "Contains the links stored with `org-store-link'.")
9653 (defvar org-store-link-plist nil
9654 "Plist with info about the most recently link created with `org-store-link'.")
9656 (defvar org-link-protocols nil
9657 "Link protocols added to Org-mode using `org-add-link-type'.")
9659 (defvar org-store-link-functions nil
9660 "List of functions that are called to create and store a link.
9661 Each function will be called in turn until one returns a non-nil
9662 value. Each function should check if it is responsible for creating
9663 this link (for example by looking at the major mode).
9664 If not, it must exit and return nil.
9665 If yes, it should return a non-nil value after a calling
9666 `org-store-link-props' with a list of properties and values.
9667 Special properties are:
9669 :type The link prefix, like \"http\". This must be given.
9670 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9671 This is obligatory as well.
9672 :description Optional default description for the second pair
9673 of brackets in an Org-mode link. The user can still change
9674 this when inserting this link into an Org-mode buffer.
9676 In addition to these, any additional properties can be specified
9677 and then used in capture templates.")
9679 (defun org-add-link-type (type &optional follow export)
9680 "Add TYPE to the list of `org-link-types'.
9681 Re-compute all regular expressions depending on `org-link-types'
9683 FOLLOW and EXPORT are two functions.
9685 FOLLOW should take the link path as the single argument and do whatever
9686 is necessary to follow the link, for example find a file or display
9687 a mail message.
9689 EXPORT should format the link path for export to one of the export formats.
9690 It should be a function accepting three arguments:
9692 path the path of the link, the text after the prefix (like \"http:\")
9693 desc the description of the link, if any
9694 format the export format, a symbol like `html' or `latex' or `ascii'.
9696 The function may use the FORMAT information to return different values
9697 depending on the format. The return value will be put literally into
9698 the exported file. If the return value is nil, this means Org should
9699 do what it normally does with links which do not have EXPORT defined.
9701 Org mode has a built-in default for exporting links. If you are happy with
9702 this default, there is no need to define an export function for the link
9703 type. For a simple example of an export function, see `org-bbdb.el'."
9704 (add-to-list 'org-link-types type t)
9705 (org-make-link-regexps)
9706 (org-element-update-syntax)
9707 (if (assoc type org-link-protocols)
9708 (setcdr (assoc type org-link-protocols) (list follow export))
9709 (push (list type follow export) org-link-protocols)))
9711 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9712 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9714 ;;;###autoload
9715 (defun org-store-link (arg)
9716 "\\<org-mode-map>Store an org-link to the current location.
9717 This link is added to `org-stored-links' and can later be inserted
9718 into an Org buffer with \\[org-insert-link].
9720 For some link types, a prefix ARG is interpreted.
9721 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9722 For file links, ARG negates `org-context-in-file-links'.
9724 A double prefix ARG force skipping storing functions that are not
9725 part of Org's core.
9727 A triple prefix ARG force storing a link for each line in the
9728 active region."
9729 (interactive "P")
9730 (org-load-modules-maybe)
9731 (if (and (equal arg '(64)) (org-region-active-p))
9732 (save-excursion
9733 (let ((end (region-end)))
9734 (goto-char (region-beginning))
9735 (set-mark (point))
9736 (while (< (point-at-eol) end)
9737 (move-end-of-line 1) (activate-mark)
9738 (let (current-prefix-arg)
9739 (call-interactively 'org-store-link))
9740 (move-beginning-of-line 2)
9741 (set-mark (point)))))
9742 (org-with-limited-levels
9743 (setq org-store-link-plist nil)
9744 (let (link cpltxt desc description search
9745 txt custom-id agenda-link sfuns sfunsn)
9746 (cond
9748 ;; Store a link using an external link type
9749 ((and (not (equal arg '(16)))
9750 (setq sfuns
9751 (delq
9752 nil (mapcar (lambda (f)
9753 (let (fs) (if (funcall f) (push f fs))))
9754 org-store-link-functions))
9755 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9756 (or (and (cdr sfuns)
9757 (funcall (intern
9758 (completing-read
9759 "Which function for creating the link? "
9760 sfunsn nil t (car sfunsn)))))
9761 (funcall (caar sfuns)))
9762 (setq link (plist-get org-store-link-plist :link)
9763 desc (or (plist-get org-store-link-plist
9764 :description)
9765 link))))
9767 ;; Store a link from a source code buffer.
9768 ((org-src-edit-buffer-p)
9769 (cond
9770 ((save-excursion
9771 (beginning-of-line)
9772 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9773 "[ \t]*$")))
9774 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9775 ((org-called-interactively-p 'any)
9776 (let (label)
9777 (while (or (not label)
9778 (org-with-wide-buffer
9779 (goto-char (point-min))
9780 (re-search-forward
9781 (regexp-quote (format org-coderef-label-format label))
9782 nil t)))
9783 (when label (message "Label exists already") (sit-for 2))
9784 (setq label (read-string "Code line label: " label)))
9785 (end-of-line)
9786 (setq link (format org-coderef-label-format label))
9787 (let ((gc (- 79 (length link))))
9788 (if (< (current-column) gc) (org-move-to-column gc t)
9789 (insert " ")))
9790 (insert link)
9791 (setq link (concat "(" label ")") desc nil)))
9792 (t (setq link nil))))
9794 ;; We are in the agenda, link to referenced location
9795 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9796 (let ((m (or (get-text-property (point) 'org-hd-marker)
9797 (get-text-property (point) 'org-marker))))
9798 (when m
9799 (org-with-point-at m
9800 (setq agenda-link
9801 (if (org-called-interactively-p 'any)
9802 (call-interactively 'org-store-link)
9803 (org-store-link nil)))))))
9805 ((eq major-mode 'calendar-mode)
9806 (let ((cd (calendar-cursor-to-date)))
9807 (setq link
9808 (format-time-string
9809 (car org-time-stamp-formats)
9810 (apply 'encode-time
9811 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9812 nil nil nil))))
9813 (org-store-link-props :type "calendar" :date cd)))
9815 ((eq major-mode 'help-mode)
9816 (setq link (concat "help:" (save-excursion
9817 (goto-char (point-min))
9818 (looking-at "^[^ ]+")
9819 (match-string 0))))
9820 (org-store-link-props :type "help"))
9822 ((eq major-mode 'w3-mode)
9823 (setq cpltxt (if (and (buffer-name)
9824 (not (string-match "Untitled" (buffer-name))))
9825 (buffer-name)
9826 (url-view-url t))
9827 link (url-view-url t))
9828 (org-store-link-props :type "w3" :url (url-view-url t)))
9830 ((eq major-mode 'image-mode)
9831 (setq cpltxt (concat "file:"
9832 (abbreviate-file-name buffer-file-name))
9833 link cpltxt)
9834 (org-store-link-props :type "image" :file buffer-file-name))
9836 ;; In dired, store a link to the file of the current line
9837 ((derived-mode-p 'dired-mode)
9838 (let ((file (dired-get-filename nil t)))
9839 (setq file (if file
9840 (abbreviate-file-name
9841 (expand-file-name (dired-get-filename nil t)))
9842 ;; otherwise, no file so use current directory.
9843 default-directory))
9844 (setq cpltxt (concat "file:" file)
9845 link cpltxt)))
9847 ((setq search (run-hook-with-args-until-success
9848 'org-create-file-search-functions))
9849 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9850 "::" search))
9851 (setq cpltxt (or description link)))
9853 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9854 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9855 (cond
9856 ;; Store a link using the target at point
9857 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9858 (setq cpltxt
9859 (concat "file:"
9860 (abbreviate-file-name
9861 (buffer-file-name (buffer-base-buffer)))
9862 "::" (match-string 1))
9863 link cpltxt))
9864 ((and (featurep 'org-id)
9865 (or (eq org-id-link-to-org-use-id t)
9866 (and (org-called-interactively-p 'any)
9867 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9868 (and (eq org-id-link-to-org-use-id
9869 'create-if-interactive-and-no-custom-id)
9870 (not custom-id))))
9871 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9872 ;; Store a link using the ID at point
9873 (setq link (condition-case nil
9874 (prog1 (org-id-store-link)
9875 (setq desc (or (plist-get org-store-link-plist
9876 :description)
9877 "")))
9878 (error
9879 ;; Probably before first headline, link only to file
9880 (concat "file:"
9881 (abbreviate-file-name
9882 (buffer-file-name (buffer-base-buffer))))))))
9884 ;; Just link to current headline
9885 (setq cpltxt (concat "file:"
9886 (abbreviate-file-name
9887 (buffer-file-name (buffer-base-buffer)))))
9888 ;; Add a context search string
9889 (when (org-xor org-context-in-file-links arg)
9890 (let* ((ee (org-element-at-point))
9891 (et (org-element-type ee))
9892 (ev (plist-get (cadr ee) :value))
9893 (ek (plist-get (cadr ee) :key))
9894 (eok (and (stringp ek) (string-match "name" ek))))
9895 (setq txt (cond
9896 ((org-at-heading-p) nil)
9897 ((and (eq et 'keyword) eok) ev)
9898 ((org-region-active-p)
9899 (buffer-substring (region-beginning) (region-end)))))
9900 (when (or (null txt) (string-match "\\S-" txt))
9901 (setq cpltxt
9902 (concat cpltxt "::"
9903 (condition-case nil
9904 (org-make-org-heading-search-string txt)
9905 (error "")))
9906 desc (or (and (eq et 'keyword) eok ev)
9907 (nth 4 (ignore-errors (org-heading-components)))
9908 "NONE")))))
9909 (if (string-match "::\\'" cpltxt)
9910 (setq cpltxt (substring cpltxt 0 -2)))
9911 (setq link cpltxt))))
9913 ((buffer-file-name (buffer-base-buffer))
9914 ;; Just link to this file here.
9915 (setq cpltxt (concat "file:"
9916 (abbreviate-file-name
9917 (buffer-file-name (buffer-base-buffer)))))
9918 ;; Add a context string.
9919 (when (org-xor org-context-in-file-links arg)
9920 (setq txt (if (org-region-active-p)
9921 (buffer-substring (region-beginning) (region-end))
9922 (buffer-substring (point-at-bol) (point-at-eol))))
9923 ;; Only use search option if there is some text.
9924 (when (string-match "\\S-" txt)
9925 (setq cpltxt
9926 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9927 desc "NONE")))
9928 (setq link cpltxt))
9930 ((org-called-interactively-p 'interactive)
9931 (user-error "No method for storing a link from this buffer"))
9933 (t (setq link nil)))
9935 ;; We're done setting link and desc, clean up
9936 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9937 (setq link (or link cpltxt)
9938 desc (or desc cpltxt))
9939 (cond ((equal desc "NONE") (setq desc nil))
9940 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9941 (let ((d0 (match-string 3 desc))
9942 (p0 (match-string 5 desc)))
9943 (setq desc
9944 (replace-regexp-in-string
9945 org-bracket-link-regexp
9946 (concat (or p0 d0)
9947 (if (equal (length (match-string 0 desc))
9948 (length desc)) "*" "")) desc)))))
9950 ;; Return the link
9951 (if (not (and (or (org-called-interactively-p 'any)
9952 executing-kbd-macro)
9953 link))
9954 (or agenda-link (and link (org-make-link-string link desc)))
9955 (push (list link desc) org-stored-links)
9956 (message "Stored: %s" (or desc link))
9957 (when custom-id
9958 (setq link (concat "file:" (abbreviate-file-name
9959 (buffer-file-name)) "::#" custom-id))
9960 (push (list link desc) org-stored-links))
9961 (car org-stored-links))))))
9963 (defun org-store-link-props (&rest plist)
9964 "Store link properties, extract names and addresses."
9965 (let (x adr)
9966 (when (setq x (plist-get plist :from))
9967 (setq adr (mail-extract-address-components x))
9968 (setq plist (plist-put plist :fromname (car adr)))
9969 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9970 (when (setq x (plist-get plist :to))
9971 (setq adr (mail-extract-address-components x))
9972 (setq plist (plist-put plist :toname (car adr)))
9973 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9974 (let ((from (plist-get plist :from))
9975 (to (plist-get plist :to)))
9976 (when (and from to org-from-is-user-regexp)
9977 (setq plist
9978 (plist-put plist :fromto
9979 (if (string-match org-from-is-user-regexp from)
9980 (concat "to %t")
9981 (concat "from %f"))))))
9982 (setq org-store-link-plist plist))
9984 (defun org-add-link-props (&rest plist)
9985 "Add these properties to the link property list."
9986 (let (key value)
9987 (while plist
9988 (setq key (pop plist) value (pop plist))
9989 (setq org-store-link-plist
9990 (plist-put org-store-link-plist key value)))))
9992 (defun org-email-link-description (&optional fmt)
9993 "Return the description part of an email link.
9994 This takes information from `org-store-link-plist' and formats it
9995 according to FMT (default from `org-email-link-description-format')."
9996 (setq fmt (or fmt org-email-link-description-format))
9997 (let* ((p org-store-link-plist)
9998 (to (plist-get p :toaddress))
9999 (from (plist-get p :fromaddress))
10000 (table
10001 (list
10002 (cons "%c" (plist-get p :fromto))
10003 (cons "%F" (plist-get p :from))
10004 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10005 (cons "%T" (plist-get p :to))
10006 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10007 (cons "%s" (plist-get p :subject))
10008 (cons "%d" (plist-get p :date))
10009 (cons "%m" (plist-get p :message-id)))))
10010 (when (string-match "%c" fmt)
10011 ;; Check if the user wrote this message
10012 (if (and org-from-is-user-regexp from to
10013 (save-match-data (string-match org-from-is-user-regexp from)))
10014 (setq fmt (replace-match "to %t" t t fmt))
10015 (setq fmt (replace-match "from %f" t t fmt))))
10016 (org-replace-escapes fmt table)))
10018 (defun org-make-org-heading-search-string (&optional string)
10019 "Make search string for the current headline or STRING."
10020 (let ((s (or string
10021 (and (derived-mode-p 'org-mode)
10022 (save-excursion
10023 (org-back-to-heading t)
10024 (org-element-property :raw-value (org-element-at-point))))))
10025 (lines org-context-in-file-links))
10026 (or string (setq s (concat "*" s))) ; Add * for headlines
10027 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10028 (when (and string (integerp lines) (> lines 0))
10029 (let ((slines (org-split-string s "\n")))
10030 (when (< lines (length slines))
10031 (setq s (mapconcat
10032 'identity
10033 (reverse (nthcdr (- (length slines) lines)
10034 (reverse slines))) "\n")))))
10035 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10037 (defun org-make-link-string (link &optional description)
10038 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10039 (unless (org-string-nw-p link) (error "Empty link"))
10040 (let ((uri (cond ((string-match org-link-types-re link)
10041 (concat (match-string 1 link)
10042 (org-link-escape (substring link (match-end 1)))))
10043 ;; For readability, url-encode internal links only
10044 ;; when absolutely needed (i.e, when they contain
10045 ;; square brackets). File links however, are
10046 ;; encoded since, e.g., spaces are significant.
10047 ((or (file-name-absolute-p link)
10048 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10049 (org-link-escape link))
10050 (t link)))
10051 (description
10052 (and (org-string-nw-p description)
10053 ;; Remove brackets from description, as they are fatal.
10054 (replace-regexp-in-string
10055 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10056 (org-trim description)))))
10057 (format "[[%s]%s]"
10059 (if description (format "[%s]" description) ""))))
10061 (defconst org-link-escape-chars
10062 ;;%20 %5B %5D %25
10063 '(?\s ?\[ ?\] ?%)
10064 "List of characters that should be escaped in a link when stored to Org.
10065 This is the list that is used for internal purposes.")
10067 (defconst org-link-escape-chars-browser
10068 ;;%20 %22
10069 '(?\s ?\")
10070 "List of characters to be escaped before handing over to the browser.
10071 If you consider using this constant then you probably want to use
10072 the function `org-link-escape-browser' instead. See there why
10073 this constant is a candidate to be removed once Org drops support
10074 for Emacs 24.1 and 24.2.")
10076 (defun org-link-escape (text &optional table merge)
10077 "Return percent escaped representation of TEXT.
10078 TEXT is a string with the text to escape.
10079 Optional argument TABLE is a list with characters that should be
10080 escaped. When nil, `org-link-escape-chars' is used.
10081 If optional argument MERGE is set, merge TABLE into
10082 `org-link-escape-chars'."
10083 (let ((characters-to-encode
10084 (cond ((null table) org-link-escape-chars)
10085 (merge (append org-link-escape-chars table))
10086 (t table))))
10087 (mapconcat
10088 (lambda (c)
10089 (if (or (memq c characters-to-encode)
10090 (and org-url-hexify-p (or (< c 32) (> c 126))))
10091 (mapconcat (lambda (e) (format "%%%.2X" e))
10092 (or (encode-coding-char c 'utf-8)
10093 (error "Unable to percent escape character: %c" c))
10095 (char-to-string c)))
10096 text "")))
10098 (defun org-link-escape-browser (text)
10099 "Escape some characters before handing over to the browser.
10100 This function is a candidate to be removed together with the
10101 constant `org-link-escape-chars-browser' once Org drops support
10102 for Emacs 24.1 and 24.2. All calls to this function will have to
10103 be replaced with `url-encode-url' which is available since Emacs
10104 24.3.1."
10105 ;; Example with the Org link
10106 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10107 ;; to open the browser with +subject:"Release 8.2" filled into the
10108 ;; query field: In this case the variable TEXT contains the
10109 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10110 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10111 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10112 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10113 (if (fboundp 'url-encode-url)
10114 (url-encode-url text)
10115 (if (org-string-match-p
10116 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10117 text)
10118 (org-link-escape text org-link-escape-chars-browser)
10119 text)))
10121 (defun org-link-unescape (str)
10122 "Unhex hexified Unicode parts in string STR.
10123 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10124 reciprocal of `org-link-escape', which see."
10125 (if (org-string-nw-p str)
10126 (replace-regexp-in-string
10127 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10128 str))
10130 (defun org-link-unescape-compound (hex)
10131 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10132 Note: this function also decodes single byte encodings like
10133 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10134 (save-match-data
10135 (let* ((bytes (cdr (split-string hex "%")))
10136 (ret "")
10137 (eat 0)
10138 (sum 0))
10139 (while bytes
10140 (let* ((val (string-to-number (pop bytes) 16))
10141 (shift-xor
10142 (if (= 0 eat)
10143 (cond
10144 ((>= val 252) (cons 6 252))
10145 ((>= val 248) (cons 5 248))
10146 ((>= val 240) (cons 4 240))
10147 ((>= val 224) (cons 3 224))
10148 ((>= val 192) (cons 2 192))
10149 (t (cons 0 0)))
10150 (cons 6 128))))
10151 (if (>= val 192) (setq eat (car shift-xor)))
10152 (setq val (logxor val (cdr shift-xor)))
10153 (setq sum (+ (lsh sum (car shift-xor)) val))
10154 (if (> eat 0) (setq eat (- eat 1)))
10155 (cond
10156 ((= 0 eat) ;multi byte
10157 (setq ret (concat ret (org-char-to-string sum)))
10158 (setq sum 0))
10159 ((not bytes) ; single byte(s)
10160 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10161 ret)))
10163 (defun org-link-unescape-single-byte-sequence (hex)
10164 "Unhexify hex-encoded single byte character sequences."
10165 (mapconcat (lambda (byte)
10166 (char-to-string (string-to-number byte 16)))
10167 (cdr (split-string hex "%")) ""))
10169 (defun org-xor (a b)
10170 "Exclusive or."
10171 (if a (not b) b))
10173 (defun org-fixup-message-id-for-http (s)
10174 "Replace special characters in a message id, so it can be used in an http query."
10175 (when (string-match "%" s)
10176 (setq s (mapconcat (lambda (c)
10177 (if (eq c ?%)
10178 "%25"
10179 (char-to-string c)))
10180 s "")))
10181 (while (string-match "<" s)
10182 (setq s (replace-match "%3C" t t s)))
10183 (while (string-match ">" s)
10184 (setq s (replace-match "%3E" t t s)))
10185 (while (string-match "@" s)
10186 (setq s (replace-match "%40" t t s)))
10189 (defun org-link-prettify (link)
10190 "Return a human-readable representation of LINK.
10191 The car of LINK must be a raw link.
10192 The cdr of LINK must be either a link description or nil."
10193 (let ((desc (or (cadr link) "<no description>")))
10194 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10195 "<" (car link) ">")))
10197 ;;;###autoload
10198 (defun org-insert-link-global ()
10199 "Insert a link like Org-mode does.
10200 This command can be called in any mode to insert a link in Org-mode syntax."
10201 (interactive)
10202 (org-load-modules-maybe)
10203 (org-run-like-in-org-mode 'org-insert-link))
10205 (defun org-insert-all-links (arg &optional pre post)
10206 "Insert all links in `org-stored-links'.
10207 When a universal prefix, do not delete the links from `org-stored-links'.
10208 When `ARG' is a number, insert the last N link(s).
10209 `PRE' and `POST' are optional arguments to define a string to
10210 prepend or to append."
10211 (interactive "P")
10212 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10213 (links (copy-seq org-stored-links))
10214 (pr (or pre "- "))
10215 (po (or post "\n"))
10216 (cnt 1) l)
10217 (if (null org-stored-links)
10218 (message "No link to insert")
10219 (while (and (or (listp arg) (>= arg cnt))
10220 (setq l (if (listp arg)
10221 (pop links)
10222 (pop org-stored-links))))
10223 (setq cnt (1+ cnt))
10224 (insert pr)
10225 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10226 (insert po)))))
10228 (defun org-insert-last-stored-link (arg)
10229 "Insert the last link stored in `org-stored-links'."
10230 (interactive "p")
10231 (org-insert-all-links arg "" "\n"))
10233 (defun org-link-fontify-links-to-this-file ()
10234 "Fontify links to the current file in `org-stored-links'."
10235 (let ((f (buffer-file-name)) a b)
10236 (setq a (mapcar (lambda(l)
10237 (let ((ll (car l)))
10238 (when (and (string-match "^file:\\(.+\\)::" ll)
10239 (equal f (expand-file-name (match-string 1 ll))))
10240 ll)))
10241 org-stored-links))
10242 (when (featurep 'org-id)
10243 (setq b (mapcar (lambda(l)
10244 (let ((ll (car l)))
10245 (when (and (string-match "^id:\\(.+\\)$" ll)
10246 (equal f (expand-file-name
10247 (or (org-id-find-id-file
10248 (match-string 1 ll)) ""))))
10249 ll)))
10250 org-stored-links)))
10251 (mapcar (lambda(l)
10252 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10253 (delq nil (append a b)))))
10255 (defvar org-link-links-in-this-file nil)
10256 (defun org-insert-link (&optional complete-file link-location default-description)
10257 "Insert a link. At the prompt, enter the link.
10259 Completion can be used to insert any of the link protocol prefixes like
10260 http or ftp in use.
10262 The history can be used to select a link previously stored with
10263 `org-store-link'. When the empty string is entered (i.e. if you just
10264 press RET at the prompt), the link defaults to the most recently
10265 stored link. As SPC triggers completion in the minibuffer, you need to
10266 use M-SPC or C-q SPC to force the insertion of a space character.
10268 You will also be prompted for a description, and if one is given, it will
10269 be displayed in the buffer instead of the link.
10271 If there is already a link at point, this command will allow you to edit link
10272 and description parts.
10274 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10275 be selected using completion. The path to the file will be relative to the
10276 current directory if the file is in the current directory or a subdirectory.
10277 Otherwise, the link will be the absolute path as completed in the minibuffer
10278 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10279 option `org-link-file-path-type'.
10281 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10282 the current directory or below.
10284 With three \\[universal-argument] prefixes, negate the meaning of
10285 `org-keep-stored-link-after-insertion'.
10287 If `org-make-link-description-function' is non-nil, this function will be
10288 called with the link target, and the result will be the default
10289 link description.
10291 If the LINK-LOCATION parameter is non-nil, this value will be
10292 used as the link location instead of reading one interactively.
10294 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10295 be used as the default description."
10296 (interactive "P")
10297 (let* ((wcf (current-window-configuration))
10298 (origbuf (current-buffer))
10299 (region (if (org-region-active-p)
10300 (buffer-substring (region-beginning) (region-end))))
10301 (remove (and region (list (region-beginning) (region-end))))
10302 (desc region)
10303 tmphist ; byte-compile incorrectly complains about this
10304 (link link-location)
10305 (abbrevs org-link-abbrev-alist-local)
10306 entry file all-prefixes auto-desc)
10307 (cond
10308 (link-location) ; specified by arg, just use it.
10309 ((org-in-regexp org-bracket-link-regexp 1)
10310 ;; We do have a link at point, and we are going to edit it.
10311 (setq remove (list (match-beginning 0) (match-end 0)))
10312 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10313 (setq link (read-string "Link: "
10314 (org-link-unescape
10315 (org-match-string-no-properties 1)))))
10316 ((or (org-in-regexp org-angle-link-re)
10317 (org-in-regexp org-plain-link-re))
10318 ;; Convert to bracket link
10319 (setq remove (list (match-beginning 0) (match-end 0))
10320 link (read-string "Link: "
10321 (org-remove-angle-brackets (match-string 0)))))
10322 ((member complete-file '((4) (16)))
10323 ;; Completing read for file names.
10324 (setq link (org-file-complete-link complete-file)))
10326 ;; Read link, with completion for stored links.
10327 (org-link-fontify-links-to-this-file)
10328 (org-switch-to-buffer-other-window "*Org Links*")
10329 (with-current-buffer "*Org Links*"
10330 (erase-buffer)
10331 (insert "Insert a link.
10332 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10333 (when org-stored-links
10334 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10335 (insert (mapconcat 'org-link-prettify
10336 (reverse org-stored-links) "\n")))
10337 (goto-char (point-min)))
10338 (let ((cw (selected-window)))
10339 (select-window (get-buffer-window "*Org Links*" 'visible))
10340 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10341 (unless (pos-visible-in-window-p (point-max))
10342 (org-fit-window-to-buffer))
10343 (and (window-live-p cw) (select-window cw)))
10344 ;; Fake a link history, containing the stored links.
10345 (setq tmphist (append (mapcar 'car org-stored-links)
10346 org-insert-link-history))
10347 (setq all-prefixes (append (mapcar 'car abbrevs)
10348 (mapcar 'car org-link-abbrev-alist)
10349 org-link-types))
10350 (unwind-protect
10351 (progn
10352 (setq link
10353 (org-completing-read
10354 "Link: "
10355 (append
10356 (mapcar (lambda (x) (concat x ":"))
10357 all-prefixes)
10358 (mapcar 'car org-stored-links))
10359 nil nil nil
10360 'tmphist
10361 (caar org-stored-links)))
10362 (if (not (string-match "\\S-" link))
10363 (user-error "No link selected"))
10364 (mapc (lambda(l)
10365 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10366 org-stored-links)
10367 (if (or (member link all-prefixes)
10368 (and (equal ":" (substring link -1))
10369 (member (substring link 0 -1) all-prefixes)
10370 (setq link (substring link 0 -1))))
10371 (setq link (with-current-buffer origbuf
10372 (org-link-try-special-completion link)))))
10373 (set-window-configuration wcf)
10374 (kill-buffer "*Org Links*"))
10375 (setq entry (assoc link org-stored-links))
10376 (or entry (push link org-insert-link-history))
10377 (setq desc (or desc (nth 1 entry)))))
10379 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10380 (not org-keep-stored-link-after-insertion))
10381 (setq org-stored-links (delq (assoc link org-stored-links)
10382 org-stored-links)))
10384 (if (and (string-match org-plain-link-re link)
10385 (not (string-match org-ts-regexp link)))
10386 ;; URL-like link, normalize the use of angular brackets.
10387 (setq link (org-remove-angle-brackets link)))
10389 ;; Check if we are linking to the current file with a search
10390 ;; option If yes, simplify the link by using only the search
10391 ;; option.
10392 (when (and buffer-file-name
10393 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10394 (let* ((path (match-string 1 link))
10395 (case-fold-search nil)
10396 (search (match-string 2 link)))
10397 (save-match-data
10398 (if (equal (file-truename buffer-file-name) (file-truename path))
10399 ;; We are linking to this same file, with a search option
10400 (setq link search)))))
10402 ;; Check if we can/should use a relative path. If yes, simplify the link
10403 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10404 (let* ((type (match-string 1 link))
10405 (path (match-string 2 link))
10406 (origpath path)
10407 (case-fold-search nil))
10408 (cond
10409 ((or (eq org-link-file-path-type 'absolute)
10410 (equal complete-file '(16)))
10411 (setq path (abbreviate-file-name (expand-file-name path))))
10412 ((eq org-link-file-path-type 'noabbrev)
10413 (setq path (expand-file-name path)))
10414 ((eq org-link-file-path-type 'relative)
10415 (setq path (file-relative-name path)))
10417 (save-match-data
10418 (if (string-match (concat "^" (regexp-quote
10419 (expand-file-name
10420 (file-name-as-directory
10421 default-directory))))
10422 (expand-file-name path))
10423 ;; We are linking a file with relative path name.
10424 (setq path (substring (expand-file-name path)
10425 (match-end 0)))
10426 (setq path (abbreviate-file-name (expand-file-name path)))))))
10427 (setq link (concat type path))
10428 (if (equal desc origpath)
10429 (setq desc path))))
10431 (if org-make-link-description-function
10432 (setq desc
10433 (or (condition-case nil
10434 (funcall org-make-link-description-function link desc)
10435 (error (progn (message "Can't get link description from `%s'"
10436 (symbol-name org-make-link-description-function))
10437 (sit-for 2) nil)))
10438 (read-string "Description: " default-description)))
10439 (if default-description (setq desc default-description)
10440 (setq desc (or (and auto-desc desc)
10441 (read-string "Description: " desc)))))
10443 (unless (string-match "\\S-" desc) (setq desc nil))
10444 (if remove (apply 'delete-region remove))
10445 (insert (org-make-link-string link desc))))
10447 (defun org-link-try-special-completion (type)
10448 "If there is completion support for link type TYPE, offer it."
10449 (let ((fun (intern (concat "org-" type "-complete-link"))))
10450 (if (functionp fun)
10451 (funcall fun)
10452 (read-string "Link (no completion support): " (concat type ":")))))
10454 (defun org-file-complete-link (&optional arg)
10455 "Create a file link using completion."
10456 (let ((file (org-iread-file-name "File: "))
10457 (pwd (file-name-as-directory (expand-file-name ".")))
10458 (pwd1 (file-name-as-directory (abbreviate-file-name
10459 (expand-file-name ".")))))
10460 (cond ((equal arg '(16))
10461 (concat "file:"
10462 (abbreviate-file-name (expand-file-name file))))
10463 ((string-match
10464 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10465 (concat "file:" (match-string 1 file)))
10466 ((string-match
10467 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10468 (expand-file-name file))
10469 (concat "file:"
10470 (match-string 1 (expand-file-name file))))
10471 (t (concat "file:" file)))))
10473 (defun org-iread-file-name (&rest args)
10474 "Read-file-name using `ido-mode' speedup if available.
10475 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10476 See `read-file-name' for a description of parameters."
10477 (org-without-partial-completion
10478 (if (and org-completion-use-ido
10479 (fboundp 'ido-read-file-name)
10480 (org-bound-and-true-p ido-mode)
10481 (listp (nth 1 args)))
10482 (let ((ido-enter-matching-directory nil))
10483 (apply #'ido-read-file-name args))
10484 (apply #'read-file-name args))))
10486 (defun org-completing-read (&rest args)
10487 "Completing-read with SPACE being a normal character."
10488 (let ((enable-recursive-minibuffers t)
10489 (minibuffer-local-completion-map
10490 (copy-keymap minibuffer-local-completion-map)))
10491 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10492 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10493 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10494 (apply 'org-icompleting-read args)))
10496 (defun org-completing-read-no-i (&rest args)
10497 (let (org-completion-use-ido org-completion-use-iswitchb)
10498 (apply 'org-completing-read args)))
10500 (defun org-iswitchb-completing-read (prompt choices &rest args)
10501 "Use iswitch as a completing-read replacement to choose from choices.
10502 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10503 from."
10504 (let* ((iswitchb-use-virtual-buffers nil)
10505 (iswitchb-make-buflist-hook
10506 (lambda ()
10507 (setq iswitchb-temp-buflist choices))))
10508 (iswitchb-read-buffer prompt)))
10510 (defun org-icompleting-read (&rest args)
10511 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10512 Should be called like `completing-read'."
10513 (org-without-partial-completion
10514 (if (not (listp (nth 1 args)))
10515 ;; Ido only supports lists as the COLLECTION argument. Use
10516 ;; default completion function when second argument is not
10517 ;; a list.
10518 (apply #'completing-read args)
10519 (let ((ido-enter-matching-directory nil))
10520 (apply (cond ((and org-completion-use-ido
10521 (fboundp 'ido-completing-read)
10522 (org-bound-and-true-p ido-mode))
10523 #'ido-completing-read)
10524 ((and org-completion-use-iswitchb
10525 (org-bound-and-true-p iswitchb-mode))
10526 #'org-iswitchb-completing-read)
10527 (t #'completing-read))
10528 args)))))
10530 ;;; Opening/following a link
10532 (defvar org-link-search-failed nil)
10534 (defvar org-open-link-functions nil
10535 "Hook for functions finding a plain text link.
10536 These functions must take a single argument, the link content.
10537 They will be called for links that look like [[link text][description]]
10538 when LINK TEXT does not have a protocol like \"http:\" and does not look
10539 like a filename (e.g. \"./blue.png\").
10541 These functions will be called *before* Org attempts to resolve the
10542 link by doing text searches in the current buffer - so if you want a
10543 link \"[[target]]\" to still find \"<<target>>\", your function should
10544 handle this as a special case.
10546 When the function does handle the link, it must return a non-nil value.
10547 If it decides that it is not responsible for this link, it must return
10548 nil to indicate that that Org-mode can continue with other options
10549 like exact and fuzzy text search.")
10551 (defun org-next-link (&optional search-backward)
10552 "Move forward to the next link.
10553 If the link is in hidden text, expose it."
10554 (interactive "P")
10555 (when (and org-link-search-failed (eq this-command last-command))
10556 (goto-char (point-min))
10557 (message "Link search wrapped back to beginning of buffer"))
10558 (setq org-link-search-failed nil)
10559 (let* ((pos (point))
10560 (ct (org-context))
10561 (a (assoc :link ct))
10562 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10563 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10564 ((looking-at org-any-link-re)
10565 ;; Don't stay stuck at link without an org-link face
10566 (forward-char (if search-backward -1 1))))
10567 (if (funcall srch-fun org-any-link-re nil t)
10568 (progn
10569 (goto-char (match-beginning 0))
10570 (if (outline-invisible-p) (org-show-context)))
10571 (goto-char pos)
10572 (setq org-link-search-failed t)
10573 (message "No further link found"))))
10575 (defun org-previous-link ()
10576 "Move backward to the previous link.
10577 If the link is in hidden text, expose it."
10578 (interactive)
10579 (funcall 'org-next-link t))
10581 (defun org-translate-link (s)
10582 "Translate a link string if a translation function has been defined."
10583 (with-temp-buffer
10584 (insert (org-trim s))
10585 (org-trim (org-element-interpret-data (org-element-context)))))
10587 (defun org-translate-link-from-planner (type path)
10588 "Translate a link from Emacs Planner syntax so that Org can follow it.
10589 This is still an experimental function, your mileage may vary."
10590 (cond
10591 ((member type '("http" "https" "news" "ftp"))
10592 ;; standard Internet links are the same.
10593 nil)
10594 ((and (equal type "irc") (string-match "^//" path))
10595 ;; Planner has two / at the beginning of an irc link, we have 1.
10596 ;; We should have zero, actually....
10597 (setq path (substring path 1)))
10598 ((and (equal type "lisp") (string-match "^/" path))
10599 ;; Planner has a slash, we do not.
10600 (setq type "elisp" path (substring path 1)))
10601 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10602 ;; A typical message link. Planner has the id after the final slash,
10603 ;; we separate it with a hash mark
10604 (setq path (concat (match-string 1 path) "#"
10605 (org-remove-angle-brackets (match-string 2 path))))))
10606 (cons type path))
10608 (defun org-find-file-at-mouse (ev)
10609 "Open file link or URL at mouse."
10610 (interactive "e")
10611 (mouse-set-point ev)
10612 (org-open-at-point 'in-emacs))
10614 (defun org-open-at-mouse (ev)
10615 "Open file link or URL at mouse.
10616 See the docstring of `org-open-file' for details."
10617 (interactive "e")
10618 (mouse-set-point ev)
10619 (if (eq major-mode 'org-agenda-mode)
10620 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10621 (org-open-at-point))
10623 (defvar org-window-config-before-follow-link nil
10624 "The window configuration before following a link.
10625 This is saved in case the need arises to restore it.")
10627 ;;;###autoload
10628 (defun org-open-at-point-global ()
10629 "Follow a link like Org-mode does.
10630 This command can be called in any mode to follow a link that has
10631 Org-mode syntax."
10632 (interactive)
10633 (org-run-like-in-org-mode 'org-open-at-point))
10635 ;;;###autoload
10636 (defun org-open-link-from-string (s &optional arg reference-buffer)
10637 "Open a link in the string S, as if it was in Org-mode."
10638 (interactive "sLink: \nP")
10639 (let ((reference-buffer (or reference-buffer (current-buffer))))
10640 (with-temp-buffer
10641 (let ((org-inhibit-startup (not reference-buffer)))
10642 (org-mode)
10643 (insert s)
10644 (goto-char (point-min))
10645 (when reference-buffer
10646 (setq org-link-abbrev-alist-local
10647 (with-current-buffer reference-buffer
10648 org-link-abbrev-alist-local)))
10649 (org-open-at-point arg reference-buffer)))))
10651 (defvar org-open-at-point-functions nil
10652 "Hook that is run when following a link at point.
10654 Functions in this hook must return t if they identify and follow
10655 a link at point. If they don't find anything interesting at point,
10656 they must return nil.")
10658 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10659 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10660 (defun org-open-at-point (&optional arg reference-buffer)
10661 "Open link, timestamp, footnote or tags at point.
10663 When point is on a link, follow it. Normally, files will be
10664 opened by an appropriate application. If the optional prefix
10665 argument ARG is non-nil, Emacs will visit the file. With
10666 a double prefix argument, try to open outside of Emacs, in the
10667 application the system uses for this file type.
10669 When point is on a timestamp, open the agenda at the day
10670 specified.
10672 When point is a footnote definition, move to the first reference
10673 found. If it is on a reference, move to the associated
10674 definition.
10676 When point is on a headline, display a list of every link in the
10677 entry, so it is possible to pick one, or all, of them. If point
10678 is on a tag, call `org-tags-view' instead.
10680 When optional argument REFERENCE-BUFFER is non-nil, it should
10681 specify a buffer from where the link search should happen. This
10682 is used internally by `org-open-link-from-string'.
10684 On top of syntactically correct links, this function will open
10685 the link at point in comments or comment blocks and the first
10686 link in a property drawer line."
10687 (interactive "P")
10688 ;; On a code block, open block's results.
10689 (unless (call-interactively 'org-babel-open-src-block-result)
10690 (org-load-modules-maybe)
10691 (setq org-window-config-before-follow-link (current-window-configuration))
10692 (org-remove-occur-highlights nil nil t)
10693 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10694 (let* ((context
10695 ;; Only consider supported types, even if they are not
10696 ;; the closest one.
10697 (org-element-lineage
10698 (org-element-context)
10699 '(clock comment comment-block footnote-definition
10700 footnote-reference headline inlinetask keyword link
10701 node-property timestamp)
10703 (type (org-element-type context))
10704 (value (org-element-property :value context)))
10705 (cond
10706 ((not context) (user-error "No link found"))
10707 ;; Exception: open timestamps and links in properties
10708 ;; drawers, keywords and comments.
10709 ((memq type '(comment comment-block keyword node-property))
10710 (cond ((org-in-regexp org-any-link-re)
10711 (org-open-link-from-string (match-string-no-properties 0)))
10712 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10713 (org-follow-timestamp-link))
10714 (t (user-error "No link found"))))
10715 ;; On a headline or an inlinetask, but not on a timestamp,
10716 ;; a link, a footnote reference or on tags.
10717 ((and (memq type '(headline inlinetask))
10718 ;; Not on tags.
10719 (progn (save-excursion (beginning-of-line)
10720 (looking-at org-complex-heading-regexp))
10721 (or (not (match-beginning 5))
10722 (< (point) (match-beginning 5)))))
10723 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10724 (links (car data))
10725 (links-end (cdr data)))
10726 (if links
10727 (dolist (link (if (stringp links) (list links) links))
10728 (search-forward link nil links-end)
10729 (goto-char (match-beginning 0))
10730 (org-open-at-point))
10731 (require 'org-attach)
10732 (org-attach-reveal 'if-exists))))
10733 ;; On a clock line, make sure point is on the timestamp
10734 ;; before opening it.
10735 ((and (eq type 'clock)
10736 value
10737 (>= (point) (org-element-property :begin value))
10738 (<= (point) (org-element-property :end value)))
10739 (org-follow-timestamp-link))
10740 ;; Do nothing on white spaces after an object, unless point
10741 ;; is right after it.
10742 ((> (point)
10743 (save-excursion
10744 (goto-char (org-element-property :end context))
10745 (skip-chars-backward " \t")
10746 (point)))
10747 (user-error "No link found"))
10748 ((eq type 'timestamp) (org-follow-timestamp-link))
10749 ;; On tags within a headline or an inlinetask.
10750 ((and (memq type '(headline inlinetask))
10751 (progn (save-excursion (beginning-of-line)
10752 (looking-at org-complex-heading-regexp))
10753 (and (match-beginning 5)
10754 (>= (point) (match-beginning 5)))))
10755 (org-tags-view arg (substring (match-string 5) 0 -1)))
10756 ((eq type 'link)
10757 ;; When link is located within the description of another
10758 ;; link (e.g., an inline image), always open the parent
10759 ;; link.
10760 (let*((link (let ((up (org-element-property :parent context)))
10761 (if (eq (org-element-type up) 'link) up context)))
10762 (type (org-element-property :type link))
10763 (path (org-link-unescape (org-element-property :path link))))
10764 ;; Switch back to REFERENCE-BUFFER needed when called in
10765 ;; a temporary buffer through `org-open-link-from-string'.
10766 (with-current-buffer (or reference-buffer (current-buffer))
10767 (cond
10768 ((equal type "file")
10769 (if (string-match "[*?{]" (file-name-nondirectory path))
10770 (dired path)
10771 ;; Look into `org-link-protocols' in order to find
10772 ;; a DEDICATED-FUNCTION to open file. The function
10773 ;; will be applied on raw link instead of parsed
10774 ;; link due to the limitation in `org-add-link-type'
10775 ;; ("open" function called with a single argument).
10776 ;; If no such function is found, fallback to
10777 ;; `org-open-file'.
10779 ;; Note : "file+emacs" and "file+sys" types are
10780 ;; hard-coded in order to escape the previous
10781 ;; limitation.
10782 (let* ((option (org-element-property :search-option link))
10783 (app (org-element-property :application link))
10784 (dedicated-function
10785 (nth 1 (assoc app org-link-protocols))))
10786 (if dedicated-function
10787 (funcall dedicated-function
10788 (concat path
10789 (and option (concat "::" option))))
10790 (apply #'org-open-file
10791 path
10792 (cond (arg)
10793 ((equal app "emacs") 'emacs)
10794 ((equal app "sys") 'system))
10795 (cond ((not option) nil)
10796 ((org-string-match-p "\\`[0-9]+\\'" option)
10797 (list (string-to-number option)))
10798 (t (list nil
10799 (org-link-unescape option)))))))))
10800 ((assoc type org-link-protocols)
10801 (funcall (nth 1 (assoc type org-link-protocols)) path))
10802 ((equal type "help")
10803 (let ((f-or-v (intern path)))
10804 (cond ((fboundp f-or-v) (describe-function f-or-v))
10805 ((boundp f-or-v) (describe-variable f-or-v))
10806 (t (error "Not a known function or variable")))))
10807 ((member type '("http" "https" "ftp" "mailto" "news"))
10808 (browse-url (org-link-escape-browser (concat type ":" path))))
10809 ((equal type "doi")
10810 (browse-url
10811 (org-link-escape-browser (concat org-doi-server-url path))))
10812 ((equal type "message") (browse-url (concat type ":" path)))
10813 ((equal type "shell")
10814 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10815 (cmd path))
10816 (if (or (and (org-string-nw-p
10817 org-confirm-shell-link-not-regexp)
10818 (string-match
10819 org-confirm-shell-link-not-regexp cmd))
10820 (not org-confirm-shell-link-function)
10821 (funcall org-confirm-shell-link-function
10822 (format "Execute \"%s\" in shell? "
10823 (org-add-props cmd nil
10824 'face 'org-warning))))
10825 (progn
10826 (message "Executing %s" cmd)
10827 (shell-command cmd buf)
10828 (when (featurep 'midnight)
10829 (setq clean-buffer-list-kill-buffer-names
10830 (cons (buffer-name buf)
10831 clean-buffer-list-kill-buffer-names))))
10832 (user-error "Abort"))))
10833 ((equal type "elisp")
10834 (let ((cmd path))
10835 (if (or (and (org-string-nw-p
10836 org-confirm-elisp-link-not-regexp)
10837 (org-string-match-p
10838 org-confirm-elisp-link-not-regexp cmd))
10839 (not org-confirm-elisp-link-function)
10840 (funcall org-confirm-elisp-link-function
10841 (format "Execute \"%s\" as elisp? "
10842 (org-add-props cmd nil
10843 'face 'org-warning))))
10844 (message "%s => %s" cmd
10845 (if (eq (string-to-char cmd) ?\()
10846 (eval (read cmd))
10847 (call-interactively (read cmd))))
10848 (user-error "Abort"))))
10849 ((equal type "id")
10850 (require 'org-id)
10851 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10852 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10853 (unless (run-hook-with-args-until-success
10854 'org-open-link-functions path)
10855 (if (not arg) (org-mark-ring-push)
10856 (switch-to-buffer-other-window
10857 (org-get-buffer-for-internal-link (current-buffer))))
10858 (let ((destination
10859 (org-with-wide-buffer
10860 (if (equal type "radio")
10861 (org-search-radio-target
10862 (org-element-property :path link))
10863 (org-link-search
10864 (if (member type '("custom-id" "coderef"))
10865 (org-element-property :raw-link link)
10866 path)
10867 ;; Prevent fuzzy links from matching
10868 ;; themselves.
10869 (and (equal type "fuzzy")
10870 (+ 2 (org-element-property :begin link)))))
10871 (point))))
10872 (unless (and (<= (point-min) destination)
10873 (>= (point-max) destination))
10874 (widen))
10875 (goto-char destination))))
10876 (t (browse-url-at-point))))))
10877 ;; On a footnote reference or at a footnote definition's label.
10878 ((or (eq type 'footnote-reference)
10879 (and (eq type 'footnote-definition)
10880 (save-excursion
10881 ;; Do not validate action when point is on the
10882 ;; spaces right after the footnote label, in
10883 ;; order to be on par with behaviour on links.
10884 (skip-chars-forward " \t")
10885 (let ((begin
10886 (org-element-property :contents-begin context)))
10887 (if begin (< (point) begin)
10888 (= (org-element-property :post-affiliated context)
10889 (line-beginning-position)))))))
10890 (org-footnote-action))
10891 (t (user-error "No link found")))))
10892 (run-hook-with-args 'org-follow-link-hook)))
10894 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10895 "Offer links in the current entry and return the selected link.
10896 If there is only one link, return it.
10897 If NTH is an integer, return the NTH link found.
10898 If ZERO is a string, check also this string for a link, and if
10899 there is one, return it."
10900 (with-current-buffer buffer
10901 (save-excursion
10902 (save-restriction
10903 (widen)
10904 (goto-char marker)
10905 (let ((cnt ?0)
10906 (in-emacs (if (integerp nth) nil nth))
10907 have-zero end links link c)
10908 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10909 (push (match-string 0 zero) links)
10910 (setq cnt (1- cnt) have-zero t))
10911 (save-excursion
10912 (org-back-to-heading t)
10913 (setq end (save-excursion (outline-next-heading) (point)))
10914 (while (re-search-forward org-any-link-re end t)
10915 (push (match-string 0) links))
10916 (setq links (org-uniquify (reverse links))))
10917 (cond
10918 ((null links)
10919 (message "No links"))
10920 ((equal (length links) 1)
10921 (setq link (car links)))
10922 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10923 (setq link (nth (if have-zero nth (1- nth)) links)))
10924 (t ; we have to select a link
10925 (save-excursion
10926 (save-window-excursion
10927 (delete-other-windows)
10928 (with-output-to-temp-buffer "*Select Link*"
10929 (mapc (lambda (l)
10930 (if (not (string-match org-bracket-link-regexp l))
10931 (princ (format "[%c] %s\n" (incf cnt)
10932 (org-remove-angle-brackets l)))
10933 (if (match-end 3)
10934 (princ (format "[%c] %s (%s)\n" (incf cnt)
10935 (match-string 3 l) (match-string 1 l)))
10936 (princ (format "[%c] %s\n" (incf cnt)
10937 (match-string 1 l))))))
10938 links))
10939 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10940 (message "Select link to open, RET to open all:")
10941 (setq c (read-char-exclusive))
10942 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10943 (when (equal c ?q) (user-error "Abort"))
10944 (if (equal c ?\C-m)
10945 (setq link links)
10946 (setq nth (- c ?0))
10947 (if have-zero (setq nth (1+ nth)))
10948 (unless (and (integerp nth) (>= (length links) nth))
10949 (user-error "Invalid link selection"))
10950 (setq link (nth (1- nth) links)))))
10951 (cons link end))))))
10953 ;; TODO: These functions are deprecated since `org-open-at-point'
10954 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10955 (defun org-open-file-with-system (path)
10956 "Open file at PATH using the system way of opening it."
10957 (org-open-file path 'system))
10958 (defun org-open-file-with-emacs (path)
10959 "Open file at PATH in Emacs."
10960 (org-open-file path 'emacs))
10963 ;;; File search
10965 (defvar org-create-file-search-functions nil
10966 "List of functions to construct the right search string for a file link.
10967 These functions are called in turn with point at the location to
10968 which the link should point.
10970 A function in the hook should first test if it would like to
10971 handle this file type, for example by checking the `major-mode'
10972 or the file extension. If it decides not to handle this file, it
10973 should just return nil to give other functions a chance. If it
10974 does handle the file, it must return the search string to be used
10975 when following the link. The search string will be part of the
10976 file link, given after a double colon, and `org-open-at-point'
10977 will automatically search for it. If special measures must be
10978 taken to make the search successful, another function should be
10979 added to the companion hook `org-execute-file-search-functions',
10980 which see.
10982 A function in this hook may also use `setq' to set the variable
10983 `description' to provide a suggestion for the descriptive text to
10984 be used for this link when it gets inserted into an Org-mode
10985 buffer with \\[org-insert-link].")
10987 (defvar org-execute-file-search-functions nil
10988 "List of functions to execute a file search triggered by a link.
10990 Functions added to this hook must accept a single argument, the
10991 search string that was part of the file link, the part after the
10992 double colon. The function must first check if it would like to
10993 handle this search, for example by checking the `major-mode' or
10994 the file extension. If it decides not to handle this search, it
10995 should just return nil to give other functions a chance. If it
10996 does handle the search, it must return a non-nil value to keep
10997 other functions from trying.
10999 Each function can access the current prefix argument through the
11000 variable `current-prefix-arg'. Note that a single prefix is used
11001 to force opening a link in Emacs, so it may be good to only use a
11002 numeric or double prefix to guide the search function.
11004 In case this is needed, a function in this hook can also restore
11005 the window configuration before `org-open-at-point' was called using:
11007 (set-window-configuration org-window-config-before-follow-link)")
11009 (defun org-search-radio-target (target)
11010 "Search a radio target matching TARGET in current buffer.
11011 White spaces are not significant."
11012 (let ((re (format "<<<%s>>>"
11013 (mapconcat #'regexp-quote
11014 (org-split-string target "[ \t\n]+")
11015 "[ \t]+\\(?:\n[ \t]*\\)?")))
11016 (origin (point)))
11017 (goto-char (point-min))
11018 (catch :radio-match
11019 (while (re-search-forward re nil t)
11020 (backward-char)
11021 (let ((object (org-element-context)))
11022 (when (eq (org-element-type object) 'radio-target)
11023 (goto-char (org-element-property :begin object))
11024 (org-show-context 'link-search)
11025 (throw :radio-match nil))))
11026 (goto-char origin)
11027 (user-error "No match for radio target: %s" target))))
11029 (defun org-link-search (s &optional avoid-pos stealth)
11030 "Search for a search string S.
11032 If S starts with \"#\", it triggers a custom ID search.
11034 If S is enclosed within parenthesis, it initiates a coderef
11035 search.
11037 If S is surrounded by forward slashes, it is interpreted as
11038 a regular expression. In Org mode files, this will create an
11039 `org-occur' sparse tree. In ordinary files, `occur' will be used
11040 to list matches. If the current buffer is in `dired-mode', grep
11041 will be used to search in all files.
11043 When AVOID-POS is given, ignore matches near that position.
11045 When optional argument STEALTH is non-nil, do not modify
11046 visibility around point, thus ignoring `org-show-context-detail'
11047 variable.
11049 Search is case-insensitive and ignores white spaces. Return type
11050 of matched result, with is either `dedicated' or `fuzzy'."
11051 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11052 (let* ((case-fold-search t)
11053 (origin (point))
11054 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11055 (words (org-split-string s "[ \t\n]+"))
11056 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11057 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11058 type)
11059 (cond
11060 ;; Check if there are any special search functions.
11061 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11062 ((eq (string-to-char s) ?#)
11063 ;; Look for a custom ID S if S starts with "#".
11064 (let* ((id (substring normalized 1))
11065 (match (org-find-property "CUSTOM_ID" id)))
11066 (if match (progn (goto-char match) (setf type 'dedicated))
11067 (error "No match for custom ID: %s" id))))
11068 ((string-match "\\`(\\(.*\\))\\'" normalized)
11069 ;; Look for coderef targets if S is enclosed within parenthesis.
11070 (let ((coderef (match-string-no-properties 1 normalized))
11071 (re (substring s-single-re 1 -1)))
11072 (goto-char (point-min))
11073 (catch :coderef-match
11074 (while (re-search-forward re nil t)
11075 (let ((element (org-element-at-point)))
11076 (when (and (memq (org-element-type element)
11077 '(example-block src-block))
11078 ;; Build proper regexp according to current
11079 ;; block's label format.
11080 (let ((label-fmt
11081 (regexp-quote
11082 (or (org-element-property :label-fmt element)
11083 org-coderef-label-format))))
11084 (save-excursion
11085 (beginning-of-line)
11086 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11087 (format label-fmt coderef))))))
11088 (setq type 'dedicated)
11089 (goto-char (match-beginning 1))
11090 (throw :coderef-match nil))))
11091 (goto-char origin)
11092 (error "No match for coderef: %s" coderef))))
11093 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11094 ;; Look for a regular expression.
11095 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11096 (match-string 1 s)))
11097 ;; Fuzzy links.
11099 (let* ((starred (eq (string-to-char normalized) ?*))
11100 (headline-search (and (derived-mode-p 'org-mode)
11101 (or org-link-search-must-match-exact-headline
11102 starred))))
11103 (cond
11104 ;; Look for targets, only if not in a headline search.
11105 ((and (not starred)
11106 (let ((target (format "<<%s>>" s-multi-re)))
11107 (catch :target-match
11108 (goto-char (point-min))
11109 (while (re-search-forward target nil t)
11110 (backward-char)
11111 (let ((context (org-element-context)))
11112 (when (eq (org-element-type context) 'target)
11113 (setq type 'dedicated)
11114 (goto-char (org-element-property :begin context))
11115 (throw :target-match t))))
11116 nil))))
11117 ;; Look for elements named after S, only if not in a headline
11118 ;; search.
11119 ((and (not starred)
11120 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11121 (catch :name-match
11122 (goto-char (point-min))
11123 (while (re-search-forward name nil t)
11124 (let ((element (org-element-at-point)))
11125 (when (equal (org-split-string
11126 (org-element-property :name element)
11127 "[ \t]+")
11128 words)
11129 (setq type 'dedicated)
11130 (beginning-of-line)
11131 (throw :name-match t))))
11132 nil))))
11133 ;; Regular text search. Prefer headlines in Org mode
11134 ;; buffers.
11135 ((and (derived-mode-p 'org-mode)
11136 (let* ((wspace "[ \t]")
11137 (wspaceopt (concat wspace "*"))
11138 (cookie (concat "\\(?:"
11139 wspaceopt
11140 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11141 wspaceopt
11142 "\\)"))
11143 (sep (concat "\\(?:\\(?:" wspace "\\|" cookie "\\)+\\)"))
11144 (re (concat
11145 org-outline-regexp-bol
11146 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11147 "\\(?:\\[#.\\][ \t]+\\)?"
11148 "\\(?:" org-comment-string "[ \t]+\\)?"
11149 sep "?"
11150 (let ((title (mapconcat #'regexp-quote
11151 words
11152 sep)))
11153 (if starred (substring title 1) title))
11154 sep "?"
11155 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11156 "[ \t]*$")))
11157 (goto-char (point-min))
11158 (re-search-forward re nil t)))
11159 (goto-char (match-beginning 0))
11160 (setq type 'dedicated))
11161 ;; Offer to create non-existent headline depending on
11162 ;; `org-link-search-must-match-exact-headline'.
11163 ((and (derived-mode-p 'org-mode)
11164 (not org-link-search-inhibit-query)
11165 (eq org-link-search-must-match-exact-headline 'query-to-create)
11166 (yes-or-no-p "No match - create this as a new heading? "))
11167 (goto-char (point-max))
11168 (unless (bolp) (newline))
11169 (org-insert-heading nil t t)
11170 (insert s "\n")
11171 (beginning-of-line 0))
11172 ;; Only headlines are looked after. No need to process
11173 ;; further: throw an error.
11174 ((and (derived-mode-p 'org-mode)
11175 (or starred org-link-search-must-match-exact-headline))
11176 (goto-char origin)
11177 (error "No match for fuzzy expression: %s" normalized))
11178 ;; Regular text search.
11179 ((catch :fuzzy-match
11180 (goto-char (point-min))
11181 (while (re-search-forward s-multi-re nil t)
11182 ;; Skip match if it contains AVOID-POS or it is included
11183 ;; in a link with a description but outside the
11184 ;; description.
11185 (unless (or (and avoid-pos
11186 (<= (match-beginning 0) avoid-pos)
11187 (> (match-end 0) avoid-pos))
11188 (and (save-match-data
11189 (org-in-regexp org-bracket-link-regexp))
11190 (match-beginning 3)
11191 (or (> (match-beginning 3) (point))
11192 (<= (match-end 3) (point)))
11193 (org-element-lineage
11194 (save-match-data (org-element-context))
11195 '(link) t)))
11196 (goto-char (match-beginning 0))
11197 (setq type 'fuzzy)
11198 (throw :fuzzy-match t)))
11199 nil))
11200 ;; All failed. Throw an error.
11201 (t (goto-char origin)
11202 (error "No match for fuzzy expression: %s" normalized))))))
11203 ;; Disclose surroundings of match, if appropriate.
11204 (when (and (derived-mode-p 'org-mode) (not stealth))
11205 (org-show-context 'link-search))
11206 type))
11208 (defun org-get-buffer-for-internal-link (buffer)
11209 "Return a buffer to be used for displaying the link target of internal links."
11210 (cond
11211 ((not org-display-internal-link-with-indirect-buffer)
11212 buffer)
11213 ((string-match "(Clone)$" (buffer-name buffer))
11214 (message "Buffer is already a clone, not making another one")
11215 ;; we also do not modify visibility in this case
11216 buffer)
11217 (t ; make a new indirect buffer for displaying the link
11218 (let* ((bn (buffer-name buffer))
11219 (ibn (concat bn "(Clone)"))
11220 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11221 (with-current-buffer ib (org-overview))
11222 ib))))
11224 (defun org-do-occur (regexp &optional cleanup)
11225 "Call the Emacs command `occur'.
11226 If CLEANUP is non-nil, remove the printout of the regular expression
11227 in the *Occur* buffer. This is useful if the regex is long and not useful
11228 to read."
11229 (occur regexp)
11230 (when cleanup
11231 (let ((cwin (selected-window)) win beg end)
11232 (when (setq win (get-buffer-window "*Occur*"))
11233 (select-window win))
11234 (goto-char (point-min))
11235 (when (re-search-forward "match[a-z]+" nil t)
11236 (setq beg (match-end 0))
11237 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11238 (setq end (1- (match-beginning 0)))))
11239 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11240 (goto-char (point-min))
11241 (select-window cwin))))
11243 ;;; The mark ring for links jumps
11245 (defvar org-mark-ring nil
11246 "Mark ring for positions before jumps in Org-mode.")
11247 (defvar org-mark-ring-last-goto nil
11248 "Last position in the mark ring used to go back.")
11249 ;; Fill and close the ring
11250 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11251 (loop for i from 1 to org-mark-ring-length do
11252 (push (make-marker) org-mark-ring))
11253 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11254 org-mark-ring)
11256 (defun org-mark-ring-push (&optional pos buffer)
11257 "Put the current position or POS into the mark ring and rotate it."
11258 (interactive)
11259 (setq pos (or pos (point)))
11260 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11261 (move-marker (car org-mark-ring)
11262 (or pos (point))
11263 (or buffer (current-buffer)))
11264 (message "%s"
11265 (substitute-command-keys
11266 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11268 (defun org-mark-ring-goto (&optional n)
11269 "Jump to the previous position in the mark ring.
11270 With prefix arg N, jump back that many stored positions. When
11271 called several times in succession, walk through the entire ring.
11272 Org-mode commands jumping to a different position in the current file,
11273 or to another Org-mode file, automatically push the old position
11274 onto the ring."
11275 (interactive "p")
11276 (let (p m)
11277 (if (eq last-command this-command)
11278 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11279 (setq p org-mark-ring))
11280 (setq org-mark-ring-last-goto p)
11281 (setq m (car p))
11282 (org-pop-to-buffer-same-window (marker-buffer m))
11283 (goto-char m)
11284 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11286 (defun org-remove-angle-brackets (s)
11287 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11288 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11290 (defun org-add-angle-brackets (s)
11291 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11292 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11294 (defun org-remove-double-quotes (s)
11295 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11296 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11299 ;;; Following specific links
11301 (defun org-follow-timestamp-link ()
11302 "Open an agenda view for the time-stamp date/range at point."
11303 (cond
11304 ((org-at-date-range-p t)
11305 (let ((org-agenda-start-on-weekday)
11306 (t1 (match-string 1))
11307 (t2 (match-string 2)) tt1 tt2)
11308 (setq tt1 (time-to-days (org-time-string-to-time t1))
11309 tt2 (time-to-days (org-time-string-to-time t2)))
11310 (let ((org-agenda-buffer-tmp-name
11311 (format "*Org Agenda(a:%s)"
11312 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11313 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11314 ((org-at-timestamp-p t)
11315 (let ((org-agenda-buffer-tmp-name
11316 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11317 (org-agenda-list nil (time-to-days (org-time-string-to-time
11318 (substring (match-string 1) 0 10)))
11319 1)))
11320 (t (error "This should not happen"))))
11323 ;;; Following file links
11324 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11325 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11326 (declare-function mailcap-mime-info
11327 "mailcap" (string &optional request no-decode))
11328 (defvar org-wait nil)
11329 (defun org-open-file (path &optional in-emacs line search)
11330 "Open the file at PATH.
11331 First, this expands any special file name abbreviations. Then the
11332 configuration variable `org-file-apps' is checked if it contains an
11333 entry for this file type, and if yes, the corresponding command is launched.
11335 If no application is found, Emacs simply visits the file.
11337 With optional prefix argument IN-EMACS, Emacs will visit the file.
11338 With a double \\[universal-argument] \\[universal-argument] \
11339 prefix arg, Org tries to avoid opening in Emacs
11340 and to use an external application to visit the file.
11342 Optional LINE specifies a line to go to, optional SEARCH a string
11343 to search for. If LINE or SEARCH is given, the file will be
11344 opened in Emacs, unless an entry from org-file-apps that makes
11345 use of groups in a regexp matches.
11347 If you want to change the way frames are used when following a
11348 link, please customize `org-link-frame-setup'.
11350 If the file does not exist, an error is thrown."
11351 (let* ((file (if (equal path "")
11352 buffer-file-name
11353 (substitute-in-file-name (expand-file-name path))))
11354 (file-apps (append org-file-apps (org-default-apps)))
11355 (apps (org-remove-if
11356 'org-file-apps-entry-match-against-dlink-p file-apps))
11357 (apps-dlink (org-remove-if-not
11358 'org-file-apps-entry-match-against-dlink-p file-apps))
11359 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11360 (dirp (if remp nil (file-directory-p file)))
11361 (file (if (and dirp org-open-directory-means-index-dot-org)
11362 (concat (file-name-as-directory file) "index.org")
11363 file))
11364 (a-m-a-p (assq 'auto-mode apps))
11365 (dfile (downcase file))
11366 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11367 (link (cond ((and (eq line nil)
11368 (eq search nil))
11369 file)
11370 (line
11371 (concat file "::" (number-to-string line)))
11372 (search
11373 (concat file "::" search))))
11374 (dlink (downcase link))
11375 (old-buffer (current-buffer))
11376 (old-pos (point))
11377 (old-mode major-mode)
11378 ext cmd link-match-data)
11379 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11380 (setq ext (match-string 1 dfile))
11381 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11382 (setq ext (match-string 1 dfile))))
11383 (cond
11384 ((member in-emacs '((16) system))
11385 (setq cmd (cdr (assoc 'system apps))))
11386 (in-emacs (setq cmd 'emacs))
11388 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11389 (and dirp (cdr (assoc 'directory apps)))
11390 ; first, try matching against apps-dlink
11391 ; if we get a match here, store the match data for later
11392 (let ((match (assoc-default dlink apps-dlink
11393 'string-match)))
11394 (if match
11395 (progn (setq link-match-data (match-data))
11396 match)
11397 (progn (setq in-emacs (or in-emacs line search))
11398 nil))) ; if we have no match in apps-dlink,
11399 ; always open the file in emacs if line or search
11400 ; is given (for backwards compatibility)
11401 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11402 'string-match)
11403 (cdr (assoc ext apps))
11404 (cdr (assoc t apps))))))
11405 (when (eq cmd 'system)
11406 (setq cmd (cdr (assoc 'system apps))))
11407 (when (eq cmd 'default)
11408 (setq cmd (cdr (assoc t apps))))
11409 (when (eq cmd 'mailcap)
11410 (require 'mailcap)
11411 (mailcap-parse-mailcaps)
11412 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11413 (command (mailcap-mime-info mime-type)))
11414 (if (stringp command)
11415 (setq cmd command)
11416 (setq cmd 'emacs))))
11417 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11418 (not (file-exists-p file))
11419 (not org-open-non-existing-files))
11420 (user-error "No such file: %s" file))
11421 (cond
11422 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11423 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11424 (while (string-match "['\"]%s['\"]" cmd)
11425 (setq cmd (replace-match "%s" t t cmd)))
11426 (while (string-match "%s" cmd)
11427 (setq cmd (replace-match
11428 (save-match-data
11429 (shell-quote-argument
11430 (convert-standard-filename file)))
11431 t t cmd)))
11433 ;; Replace "%1", "%2" etc. in command with group matches from regex
11434 (save-match-data
11435 (let ((match-index 1)
11436 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11437 (set-match-data link-match-data)
11438 (while (<= match-index number-of-groups)
11439 (let ((regex (concat "%" (number-to-string match-index)))
11440 (replace-with (match-string match-index dlink)))
11441 (while (string-match regex cmd)
11442 (setq cmd (replace-match replace-with t t cmd))))
11443 (setq match-index (+ match-index 1)))))
11445 (save-window-excursion
11446 (message "Running %s...done" cmd)
11447 (start-process-shell-command cmd nil cmd)
11448 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11449 ((or (stringp cmd)
11450 (eq cmd 'emacs))
11451 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11452 (widen)
11453 (if line (progn (org-goto-line line)
11454 (if (derived-mode-p 'org-mode)
11455 (org-reveal)))
11456 (if search (org-link-search search))))
11457 ((consp cmd)
11458 (let ((file (convert-standard-filename file)))
11459 (save-match-data
11460 (set-match-data link-match-data)
11461 (eval cmd))))
11462 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11463 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11464 (or (not (equal old-buffer (current-buffer)))
11465 (not (equal old-pos (point))))
11466 (org-mark-ring-push old-pos old-buffer))))
11468 (defun org-file-apps-entry-match-against-dlink-p (entry)
11469 "This function returns non-nil if `entry' uses a regular
11470 expression which should be matched against the whole link by
11471 org-open-file.
11473 It assumes that is the case when the entry uses a regular
11474 expression which has at least one grouping construct and the
11475 action is either a lisp form or a command string containing
11476 `%1', i.e. using at least one subexpression match as a
11477 parameter."
11478 (let ((selector (car entry))
11479 (action (cdr entry)))
11480 (if (stringp selector)
11481 (and (> (regexp-opt-depth selector) 0)
11482 (or (and (stringp action)
11483 (string-match "%[0-9]" action))
11484 (consp action)))
11485 nil)))
11487 (defun org-default-apps ()
11488 "Return the default applications for this operating system."
11489 (cond
11490 ((eq system-type 'darwin)
11491 org-file-apps-defaults-macosx)
11492 ((eq system-type 'windows-nt)
11493 org-file-apps-defaults-windowsnt)
11494 (t org-file-apps-defaults-gnu)))
11496 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11497 "Convert extensions to regular expressions in the cars of LIST.
11498 Also, weed out any non-string entries, because the return value is used
11499 only for regexp matching.
11500 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11501 point to the symbol `emacs', indicating that the file should
11502 be opened in Emacs."
11503 (append
11504 (delq nil
11505 (mapcar (lambda (x)
11506 (if (not (stringp (car x)))
11508 (if (string-match "\\W" (car x))
11510 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11511 list))
11512 (if add-auto-mode
11513 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11515 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11516 (defun org-file-remote-p (file)
11517 "Test whether FILE specifies a location on a remote system.
11518 Return non-nil if the location is indeed remote.
11520 For example, the filename \"/user@host:/foo\" specifies a location
11521 on the system \"/user@host:\"."
11522 (cond ((fboundp 'file-remote-p)
11523 (file-remote-p file))
11524 ((fboundp 'tramp-handle-file-remote-p)
11525 (tramp-handle-file-remote-p file))
11526 ((and (boundp 'ange-ftp-name-format)
11527 (string-match (car ange-ftp-name-format) file))
11528 t)))
11531 ;;;; Refiling
11533 (defun org-get-org-file ()
11534 "Read a filename, with default directory `org-directory'."
11535 (let ((default (or org-default-notes-file remember-data-file)))
11536 (read-file-name (format "File name [%s]: " default)
11537 (file-name-as-directory org-directory)
11538 default)))
11540 (defun org-notes-order-reversed-p ()
11541 "Check if the current file should receive notes in reversed order."
11542 (cond
11543 ((not org-reverse-note-order) nil)
11544 ((eq t org-reverse-note-order) t)
11545 ((not (listp org-reverse-note-order)) nil)
11546 (t (catch 'exit
11547 (dolist (entry org-reverse-note-order)
11548 (if (string-match (car entry) buffer-file-name)
11549 (throw 'exit (cdr entry))))))))
11551 (defvar org-refile-target-table nil
11552 "The list of refile targets, created by `org-refile'.")
11554 (defvar org-agenda-new-buffers nil
11555 "Buffers created to visit agenda files.")
11557 (defvar org-refile-cache nil
11558 "Cache for refile targets.")
11560 (defvar org-refile-markers nil
11561 "All the markers used for caching refile locations.")
11563 (defun org-refile-marker (pos)
11564 "Get a new refile marker, but only if caching is in use."
11565 (if (not org-refile-use-cache)
11567 (let ((m (make-marker)))
11568 (move-marker m pos)
11569 (push m org-refile-markers)
11570 m)))
11572 (defun org-refile-cache-clear ()
11573 "Clear the refile cache and disable all the markers."
11574 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11575 (setq org-refile-markers nil)
11576 (setq org-refile-cache nil)
11577 (message "Refile cache has been cleared"))
11579 (defun org-refile-cache-check-set (set)
11580 "Check if all the markers in the cache still have live buffers."
11581 (let (marker)
11582 (catch 'exit
11583 (while (and set (setq marker (nth 3 (pop set))))
11584 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11585 (when (and marker (null (marker-buffer marker)))
11586 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11587 (sit-for 3)
11588 (throw 'exit nil)))
11589 t)))
11591 (defun org-refile-cache-put (set &rest identifiers)
11592 "Push the refile targets SET into the cache, under IDENTIFIERS."
11593 (let* ((key (sha1 (prin1-to-string identifiers)))
11594 (entry (assoc key org-refile-cache)))
11595 (if entry
11596 (setcdr entry set)
11597 (push (cons key set) org-refile-cache))))
11599 (defun org-refile-cache-get (&rest identifiers)
11600 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11601 (cond
11602 ((not org-refile-cache) nil)
11603 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11605 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11606 org-refile-cache))))
11607 (and set (org-refile-cache-check-set set) set)))))
11609 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11610 "Produce a table with refile targets."
11611 (let ((case-fold-search nil)
11612 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11613 (entries (or org-refile-targets '((nil . (:level . 1)))))
11614 targets tgs txt re files desc descre fast-path-p level pos0)
11615 (message "Getting targets...")
11616 (with-current-buffer (or default-buffer (current-buffer))
11617 (dolist (entry entries)
11618 (setq files (car entry) desc (cdr entry))
11619 (setq fast-path-p nil)
11620 (cond
11621 ((null files) (setq files (list (current-buffer))))
11622 ((eq files 'org-agenda-files)
11623 (setq files (org-agenda-files 'unrestricted)))
11624 ((and (symbolp files) (fboundp files))
11625 (setq files (funcall files)))
11626 ((and (symbolp files) (boundp files))
11627 (setq files (symbol-value files))))
11628 (if (stringp files) (setq files (list files)))
11629 (cond
11630 ((eq (car desc) :tag)
11631 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11632 ((eq (car desc) :todo)
11633 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11634 ((eq (car desc) :regexp)
11635 (setq descre (cdr desc)))
11636 ((eq (car desc) :level)
11637 (setq descre (concat "^\\*\\{" (number-to-string
11638 (if org-odd-levels-only
11639 (1- (* 2 (cdr desc)))
11640 (cdr desc)))
11641 "\\}[ \t]")))
11642 ((eq (car desc) :maxlevel)
11643 (setq fast-path-p t)
11644 (setq descre (concat "^\\*\\{1," (number-to-string
11645 (if org-odd-levels-only
11646 (1- (* 2 (cdr desc)))
11647 (cdr desc)))
11648 "\\}[ \t]")))
11649 (t (error "Bad refiling target description %s" desc)))
11650 (dolist (f files)
11651 (with-current-buffer
11652 (if (bufferp f) f (org-get-agenda-file-buffer f))
11654 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11655 (progn
11656 (if (bufferp f) (setq f (buffer-file-name
11657 (buffer-base-buffer f))))
11658 (setq f (and f (expand-file-name f)))
11659 (if (eq org-refile-use-outline-path 'file)
11660 (push (list (file-name-nondirectory f) f nil nil) tgs))
11661 (save-excursion
11662 (save-restriction
11663 (widen)
11664 (goto-char (point-min))
11665 (while (re-search-forward descre nil t)
11666 (goto-char (setq pos0 (point-at-bol)))
11667 (catch 'next
11668 (when org-refile-target-verify-function
11669 (save-match-data
11670 (or (funcall org-refile-target-verify-function)
11671 (throw 'next t))))
11672 (when (and (looking-at org-complex-heading-regexp)
11673 (not (member (match-string 4) excluded-entries))
11674 (match-string 4))
11675 (setq level (org-reduced-level
11676 (- (match-end 1) (match-beginning 1)))
11677 txt (org-link-display-format (match-string 4))
11678 txt (replace-regexp-in-string "\\( *[[0-9]+/?[0-9]*%?]\\)+$" "" txt)
11679 re (format org-complex-heading-regexp-format
11680 (regexp-quote (match-string 4))))
11681 (when org-refile-use-outline-path
11682 (setq txt (mapconcat
11683 'org-protect-slash
11684 (append
11685 (if (eq org-refile-use-outline-path
11686 'file)
11687 (list (file-name-nondirectory
11688 (buffer-file-name
11689 (buffer-base-buffer))))
11690 (if (eq org-refile-use-outline-path
11691 'full-file-path)
11692 (list (buffer-file-name
11693 (buffer-base-buffer)))))
11694 (org-get-outline-path fast-path-p
11695 level txt)
11696 (list txt))
11697 "/")))
11698 (push (list txt f re (org-refile-marker (point)))
11699 tgs)))
11700 (when (= (point) pos0)
11701 ;; verification function has not moved point
11702 (goto-char (point-at-eol))))))))
11703 (when org-refile-use-cache
11704 (org-refile-cache-put tgs (buffer-file-name) descre))
11705 (setq targets (append tgs targets))))))
11706 (message "Getting targets...done")
11707 (nreverse targets)))
11709 (defun org-protect-slash (s)
11710 (while (string-match "/" s)
11711 (setq s (replace-match "\\" t t s)))
11714 (defvar org-olpa (make-vector 20 nil))
11716 (defun org-get-outline-path (&optional fastp level heading)
11717 "Return the outline path to the current entry, as a list.
11719 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11720 routine which makes outline path derivations for an entire file,
11721 avoiding backtracing. Refile target collection makes use of that."
11722 (if fastp
11723 (progn
11724 (if (> level 19)
11725 (error "Outline path failure, more than 19 levels"))
11726 (loop for i from level upto 19 do
11727 (aset org-olpa i nil))
11728 (prog1
11729 (delq nil (append org-olpa nil))
11730 (aset org-olpa level heading)))
11731 (let (rtn case-fold-search)
11732 (save-excursion
11733 (save-restriction
11734 (widen)
11735 (while (org-up-heading-safe)
11736 (when (looking-at org-complex-heading-regexp)
11737 (push (org-trim
11738 (replace-regexp-in-string
11739 ;; Remove statistical/checkboxes cookies
11740 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11741 (org-match-string-no-properties 4)))
11742 rtn)))
11743 rtn)))))
11745 (defun org-format-outline-path (path &optional width prefix separator)
11746 "Format the outline path PATH for display.
11747 WIDTH is the maximum number of characters that is available.
11748 PREFIX is a prefix to be included in the returned string,
11749 such as the file name.
11750 SEPARATOR is inserted between the different parts of the path,
11751 the default is \"/\"."
11752 (setq width (or width 79))
11753 (if prefix (setq width (- width (length prefix))))
11754 (if (not path)
11755 (or prefix "")
11756 (let* ((nsteps (length path))
11757 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11758 (maxwidth (if (<= total-width width)
11759 10000 ;; everything fits
11760 ;; we need to shorten the level headings
11761 (/ (- width nsteps) nsteps)))
11762 (org-odd-levels-only nil)
11763 (n 0)
11764 (total (1+ (length prefix))))
11765 (setq maxwidth (max maxwidth 10))
11766 (concat prefix
11767 (if prefix (or separator "/"))
11768 (mapconcat
11769 (lambda (h)
11770 (setq n (1+ n))
11771 (if (and (= n nsteps) (< maxwidth 10000))
11772 (setq maxwidth (- total-width total)))
11773 (if (< (length h) maxwidth)
11774 (progn (setq total (+ total (length h) 1)) h)
11775 (setq h (substring h 0 (- maxwidth 2))
11776 total (+ total maxwidth 1))
11777 (if (string-match "[ \t]+\\'" h)
11778 (setq h (substring h 0 (match-beginning 0))))
11779 (setq h (concat h "..")))
11780 (org-add-props h nil 'face
11781 (nth (% (1- n) org-n-level-faces)
11782 org-level-faces))
11784 path (or separator "/"))))))
11786 (defun org-display-outline-path (&optional file current separator just-return-string)
11787 "Display the current outline path in the echo area.
11789 If FILE is non-nil, prepend the output with the file name.
11790 If CURRENT is non-nil, append the current heading to the output.
11791 SEPARATOR is passed through to `org-format-outline-path'. It separates
11792 the different parts of the path and defaults to \"/\".
11793 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11794 (interactive "P")
11795 (let* (case-fold-search
11796 (bfn (buffer-file-name (buffer-base-buffer)))
11797 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11798 res)
11799 (if current (setq path (append path
11800 (save-excursion
11801 (org-back-to-heading t)
11802 (if (looking-at org-complex-heading-regexp)
11803 (list (match-string 4)))))))
11804 (setq res
11805 (org-format-outline-path
11806 path
11807 (1- (frame-width))
11808 (and file bfn (concat (file-name-nondirectory bfn) separator))
11809 separator))
11810 (if just-return-string
11811 (org-no-properties res)
11812 (org-unlogged-message "%s" res))))
11814 (defvar org-refile-history nil
11815 "History for refiling operations.")
11817 (defvar org-after-refile-insert-hook nil
11818 "Hook run after `org-refile' has inserted its stuff at the new location.
11819 Note that this is still *before* the stuff will be removed from
11820 the *old* location.")
11822 (defvar org-capture-last-stored-marker)
11823 (defvar org-refile-keep nil
11824 "Non-nil means `org-refile' will copy instead of refile.")
11826 (defun org-copy ()
11827 "Like `org-refile', but copy."
11828 (interactive)
11829 (let ((org-refile-keep t))
11830 (funcall 'org-refile nil nil nil "Copy")))
11832 (defun org-refile (&optional arg default-buffer rfloc msg)
11833 "Move the entry or entries at point to another heading.
11834 The list of target headings is compiled using the information in
11835 `org-refile-targets', which see.
11837 At the target location, the entry is filed as a subitem of the
11838 target heading. Depending on `org-reverse-note-order', the new
11839 subitem will either be the first or the last subitem.
11841 If there is an active region, all entries in that region will be
11842 refiled. However, the region must fulfill the requirement that
11843 the first heading sets the top-level of the moved text.
11845 With prefix arg ARG, the command will only visit the target
11846 location and not actually move anything.
11848 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11849 refiling operation has put the subtree.
11851 With a numeric prefix argument of `2', refile to the running clock.
11853 With a numeric prefix argument of `3', emulate `org-refile-keep'
11854 being set to t and copy to the target location, don't move it.
11855 Beware that keeping refiled entries may result in duplicated ID
11856 properties.
11858 RFLOC can be a refile location obtained in a different way.
11860 MSG is a string to replace \"Refile\" in the default prompt with
11861 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11863 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11865 If you are using target caching (see `org-refile-use-cache'), you
11866 have to clear the target cache in order to find new targets.
11867 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11868 prefix argument (`C-u C-u C-u C-c C-w')."
11869 (interactive "P")
11870 (if (member arg '(0 (64)))
11871 (org-refile-cache-clear)
11872 (let* ((actionmsg (cond (msg msg)
11873 ((equal arg 3) "Refile (and keep)")
11874 (t "Refile")))
11875 (cbuf (current-buffer))
11876 (regionp (org-region-active-p))
11877 (region-start (and regionp (region-beginning)))
11878 (region-end (and regionp (region-end)))
11879 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11880 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11881 pos it nbuf file re level reversed)
11882 (setq last-command nil)
11883 (when regionp
11884 (goto-char region-start)
11885 (or (bolp) (goto-char (point-at-bol)))
11886 (setq region-start (point))
11887 (unless (or (org-kill-is-subtree-p
11888 (buffer-substring region-start region-end))
11889 (prog1 org-refile-active-region-within-subtree
11890 (let ((s (point-at-eol)))
11891 (org-toggle-heading)
11892 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11893 (user-error "The region is not a (sequence of) subtree(s)")))
11894 (if (equal arg '(16))
11895 (org-refile-goto-last-stored)
11896 (when (or
11897 (and (equal arg 2)
11898 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11899 (prog1
11900 (setq it (list (or org-clock-heading "running clock")
11901 (buffer-file-name
11902 (marker-buffer org-clock-hd-marker))
11904 (marker-position org-clock-hd-marker)))
11905 (setq arg nil)))
11906 (setq it (or rfloc
11907 (let (heading-text)
11908 (save-excursion
11909 (unless (and arg (listp arg))
11910 (org-back-to-heading t)
11911 (setq heading-text
11912 (replace-regexp-in-string
11913 org-bracket-link-regexp
11914 "\\3"
11915 (nth 4 (org-heading-components)))))
11916 (org-refile-get-location
11917 (cond ((and arg (listp arg)) "Goto")
11918 (regionp (concat actionmsg " region to"))
11919 (t (concat actionmsg " subtree \""
11920 heading-text "\" to")))
11921 default-buffer
11922 (and (not (equal '(4) arg))
11923 org-refile-allow-creating-parent-nodes)
11924 arg))))))
11925 (setq file (nth 1 it)
11926 re (nth 2 it)
11927 pos (nth 3 it))
11928 (if (and (not arg)
11930 (equal (buffer-file-name) file)
11931 (if regionp
11932 (and (>= pos region-start)
11933 (<= pos region-end))
11934 (and (>= pos (point))
11935 (< pos (save-excursion
11936 (org-end-of-subtree t t))))))
11937 (error "Cannot refile to position inside the tree or region"))
11938 (setq nbuf (or (find-buffer-visiting file)
11939 (find-file-noselect file)))
11940 (if (and arg (not (equal arg 3)))
11941 (progn
11942 (org-pop-to-buffer-same-window nbuf)
11943 (goto-char pos)
11944 (org-show-context 'org-goto))
11945 (if regionp
11946 (progn
11947 (org-kill-new (buffer-substring region-start region-end))
11948 (org-save-markers-in-region region-start region-end))
11949 (org-copy-subtree 1 nil t))
11950 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11951 (find-file-noselect file)))
11952 (setq reversed (org-notes-order-reversed-p))
11953 (save-excursion
11954 (save-restriction
11955 (widen)
11956 (if pos
11957 (progn
11958 (goto-char pos)
11959 (looking-at org-outline-regexp)
11960 (setq level (org-get-valid-level (funcall outline-level) 1))
11961 (goto-char
11962 (if reversed
11963 (or (outline-next-heading) (point-max))
11964 (or (save-excursion (org-get-next-sibling))
11965 (org-end-of-subtree t t)
11966 (point-max)))))
11967 (setq level 1)
11968 (if (not reversed)
11969 (goto-char (point-max))
11970 (goto-char (point-min))
11971 (or (outline-next-heading) (goto-char (point-max)))))
11972 (if (not (bolp)) (newline))
11973 (org-paste-subtree level nil nil t)
11974 (when org-log-refile
11975 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11976 (unless (eq org-log-refile 'note)
11977 (save-excursion (org-add-log-note))))
11978 (and org-auto-align-tags
11979 (let ((org-loop-over-headlines-in-active-region nil))
11980 (org-set-tags nil t)))
11981 (let ((bookmark-name (plist-get org-bookmark-names-plist
11982 :last-refile)))
11983 (when bookmark-name
11984 (with-demoted-errors
11985 (bookmark-set bookmark-name))))
11986 ;; If we are refiling for capture, make sure that the
11987 ;; last-capture pointers point here
11988 (when (org-bound-and-true-p org-refile-for-capture)
11989 (let ((bookmark-name (plist-get org-bookmark-names-plist
11990 :last-capture-marker)))
11991 (when bookmark-name
11992 (with-demoted-errors
11993 (bookmark-set bookmark-name))))
11994 (move-marker org-capture-last-stored-marker (point)))
11995 (if (fboundp 'deactivate-mark) (deactivate-mark))
11996 (run-hooks 'org-after-refile-insert-hook))))
11997 (unless org-refile-keep
11998 (if regionp
11999 (delete-region (point) (+ (point) (- region-end region-start)))
12000 (delete-region
12001 (and (org-back-to-heading t) (point))
12002 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
12003 (when (featurep 'org-inlinetask)
12004 (org-inlinetask-remove-END-maybe))
12005 (setq org-markers-to-move nil)
12006 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
12008 (defun org-refile-goto-last-stored ()
12009 "Go to the location where the last refile was stored."
12010 (interactive)
12011 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12012 (message "This is the location of the last refile"))
12014 (defun org-refile--get-location (refloc tbl)
12015 "When user refile to REFLOC, find the associated target in TBL.
12016 Also check `org-refile-target-table'."
12017 (car (delq
12019 (mapcar
12020 (lambda (r) (or (assoc r tbl)
12021 (assoc r org-refile-target-table)))
12022 (list (replace-regexp-in-string "/$" "" refloc)
12023 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12025 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12026 no-exclude)
12027 "Prompt the user for a refile location, using PROMPT.
12028 PROMPT should not be suffixed with a colon and a space, because
12029 this function appends the default value from
12030 `org-refile-history' automatically, if that is not empty.
12031 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12032 this is used for the GOTO interface."
12033 (let ((org-refile-targets org-refile-targets)
12034 (org-refile-use-outline-path org-refile-use-outline-path)
12035 excluded-entries)
12036 (when (and (derived-mode-p 'org-mode)
12037 (not org-refile-use-cache)
12038 (not no-exclude))
12039 (org-map-tree
12040 (lambda()
12041 (setq excluded-entries
12042 (append excluded-entries (list (org-get-heading t t)))))))
12043 (setq org-refile-target-table
12044 (org-refile-get-targets default-buffer excluded-entries)))
12045 (unless org-refile-target-table
12046 (user-error "No refile targets"))
12047 (let* ((cbuf (current-buffer))
12048 (partial-completion-mode nil)
12049 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12050 (cfunc (if (and org-refile-use-outline-path
12051 org-outline-path-complete-in-steps)
12052 'org-olpath-completing-read
12053 'org-icompleting-read))
12054 (extra (if org-refile-use-outline-path "/" ""))
12055 (cbnex (concat (buffer-name) extra))
12056 (filename (and cfn (expand-file-name cfn)))
12057 (tbl (mapcar
12058 (lambda (x)
12059 (if (and (not (member org-refile-use-outline-path
12060 '(file full-file-path)))
12061 (not (equal filename (nth 1 x))))
12062 (cons (concat (car x) extra " ("
12063 (file-name-nondirectory (nth 1 x)) ")")
12064 (cdr x))
12065 (cons (concat (car x) extra) (cdr x))))
12066 org-refile-target-table))
12067 (completion-ignore-case t)
12068 cdef
12069 (prompt (concat prompt
12070 (or (and (car org-refile-history)
12071 (concat " (default " (car org-refile-history) ")"))
12072 (and (assoc cbnex tbl) (setq cdef cbnex)
12073 (concat " (default " cbnex ")"))) ": "))
12074 pa answ parent-target child parent old-hist)
12075 (setq old-hist org-refile-history)
12076 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12077 nil 'org-refile-history (or cdef (car org-refile-history))))
12078 (if (setq pa (org-refile--get-location answ tbl))
12079 (progn
12080 (org-refile-check-position pa)
12081 (when (or (not org-refile-history)
12082 (not (eq old-hist org-refile-history))
12083 (not (equal (car pa) (car org-refile-history))))
12084 (setq org-refile-history
12085 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12086 org-refile-history
12087 (cdr org-refile-history))))
12088 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12089 (pop org-refile-history)))
12091 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12092 (progn
12093 (setq parent (match-string 1 answ)
12094 child (match-string 2 answ))
12095 (setq parent-target (org-refile--get-location parent tbl))
12096 (when (and parent-target
12097 (or (eq new-nodes t)
12098 (and (eq new-nodes 'confirm)
12099 (y-or-n-p (format "Create new node \"%s\"? "
12100 child)))))
12101 (org-refile-new-child parent-target child)))
12102 (user-error "Invalid target location")))))
12104 (declare-function org-string-nw-p "org-macs" (s))
12105 (defun org-refile-check-position (refile-pointer)
12106 "Check if the refile pointer matches the headline to which it points."
12107 (let* ((file (nth 1 refile-pointer))
12108 (re (nth 2 refile-pointer))
12109 (pos (nth 3 refile-pointer))
12110 buffer)
12111 (if (and (not (markerp pos)) (not file))
12112 (user-error "Please indicate a target file in the refile path")
12113 (when (org-string-nw-p re)
12114 (setq buffer (if (markerp pos)
12115 (marker-buffer pos)
12116 (or (find-buffer-visiting file)
12117 (find-file-noselect file))))
12118 (with-current-buffer buffer
12119 (save-excursion
12120 (save-restriction
12121 (widen)
12122 (goto-char pos)
12123 (beginning-of-line 1)
12124 (unless (org-looking-at-p re)
12125 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12127 (defun org-refile-new-child (parent-target child)
12128 "Use refile target PARENT-TARGET to add new CHILD below it."
12129 (unless parent-target
12130 (error "Cannot find parent for new node"))
12131 (let ((file (nth 1 parent-target))
12132 (pos (nth 3 parent-target))
12133 level)
12134 (with-current-buffer (or (find-buffer-visiting file)
12135 (find-file-noselect file))
12136 (save-excursion
12137 (save-restriction
12138 (widen)
12139 (if pos
12140 (goto-char pos)
12141 (goto-char (point-max))
12142 (if (not (bolp)) (newline)))
12143 (when (looking-at org-outline-regexp)
12144 (setq level (funcall outline-level))
12145 (org-end-of-subtree t t))
12146 (org-back-over-empty-lines)
12147 (insert "\n" (make-string
12148 (if pos (org-get-valid-level level 1) 1) ?*)
12149 " " child "\n")
12150 (beginning-of-line 0)
12151 (list (concat (car parent-target) "/" child) file "" (point)))))))
12153 (defun org-olpath-completing-read (prompt collection &rest args)
12154 "Read an outline path like a file name."
12155 (let ((thetable collection)
12156 (org-completion-use-ido nil) ; does not work with ido.
12157 (org-completion-use-iswitchb nil)) ; or iswitchb
12158 (apply #'org-icompleting-read
12159 prompt
12160 (lambda (string predicate &optional flag)
12161 (cond
12162 ((eq flag nil) (try-completion string thetable))
12163 ((eq flag t)
12164 (let ((l (length string)))
12165 (mapcar (lambda (x)
12166 (let ((r (substring x l))
12167 (f (if (string-match " ([^)]*)$" x)
12168 (match-string 0 x)
12169 "")))
12170 (if (string-match "/" r)
12171 (concat string (substring r 0 (match-end 0)) f)
12172 x)))
12173 (all-completions string thetable predicate))))
12174 ;; Exact match?
12175 ((eq flag 'lambda) (assoc string thetable))))
12176 args)))
12178 ;;;; Dynamic blocks
12180 (defun org-find-dblock (name)
12181 "Find the first dynamic block with name NAME in the buffer.
12182 If not found, stay at current position and return nil."
12183 (let ((case-fold-search t) pos)
12184 (save-excursion
12185 (goto-char (point-min))
12186 (setq pos (and (re-search-forward
12187 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12188 (match-beginning 0))))
12189 (if pos (goto-char pos))
12190 pos))
12192 (defun org-create-dblock (plist)
12193 "Create a dynamic block section, with parameters taken from PLIST.
12194 PLIST must contain a :name entry which is used as the name of the block."
12195 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12196 (end-of-line 1)
12197 (newline))
12198 (let ((col (current-column))
12199 (name (plist-get plist :name)))
12200 (insert "#+BEGIN: " name)
12201 (while plist
12202 (if (eq (car plist) :name)
12203 (setq plist (cddr plist))
12204 (insert " " (prin1-to-string (pop plist)))))
12205 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12206 (beginning-of-line -2)))
12208 (defun org-prepare-dblock ()
12209 "Prepare dynamic block for refresh.
12210 This empties the block, puts the cursor at the insert position and returns
12211 the property list including an extra property :name with the block name."
12212 (unless (looking-at org-dblock-start-re)
12213 (user-error "Not at a dynamic block"))
12214 (let* ((begdel (1+ (match-end 0)))
12215 (name (org-no-properties (match-string 1)))
12216 (params (append (list :name name)
12217 (read (concat "(" (match-string 3) ")")))))
12218 (save-excursion
12219 (beginning-of-line 1)
12220 (skip-chars-forward " \t")
12221 (setq params (plist-put params :indentation-column (current-column))))
12222 (unless (re-search-forward org-dblock-end-re nil t)
12223 (error "Dynamic block not terminated"))
12224 (setq params
12225 (append params
12226 (list :content (buffer-substring
12227 begdel (match-beginning 0)))))
12228 (delete-region begdel (match-beginning 0))
12229 (goto-char begdel)
12230 (open-line 1)
12231 params))
12233 (defun org-map-dblocks (&optional command)
12234 "Apply COMMAND to all dynamic blocks in the current buffer.
12235 If COMMAND is not given, use `org-update-dblock'."
12236 (let ((cmd (or command 'org-update-dblock)))
12237 (save-excursion
12238 (goto-char (point-min))
12239 (while (re-search-forward org-dblock-start-re nil t)
12240 (goto-char (match-beginning 0))
12241 (save-excursion
12242 (condition-case nil
12243 (funcall cmd)
12244 (error (message "Error during update of dynamic block"))))
12245 (unless (re-search-forward org-dblock-end-re nil t)
12246 (error "Dynamic block not terminated"))))))
12248 (defun org-dblock-update (&optional arg)
12249 "User command for updating dynamic blocks.
12250 Update the dynamic block at point. With prefix ARG, update all dynamic
12251 blocks in the buffer."
12252 (interactive "P")
12253 (if arg
12254 (org-update-all-dblocks)
12255 (or (looking-at org-dblock-start-re)
12256 (org-beginning-of-dblock))
12257 (org-update-dblock)))
12259 (defun org-update-dblock ()
12260 "Update the dynamic block at point.
12261 This means to empty the block, parse for parameters and then call
12262 the correct writing function."
12263 (interactive)
12264 (save-excursion
12265 (let* ((win (selected-window))
12266 (pos (point))
12267 (line (org-current-line))
12268 (params (org-prepare-dblock))
12269 (name (plist-get params :name))
12270 (indent (plist-get params :indentation-column))
12271 (cmd (intern (concat "org-dblock-write:" name))))
12272 (message "Updating dynamic block `%s' at line %d..." name line)
12273 (funcall cmd params)
12274 (message "Updating dynamic block `%s' at line %d...done" name line)
12275 (goto-char pos)
12276 (when (and indent (> indent 0))
12277 (setq indent (make-string indent ?\ ))
12278 (save-excursion
12279 (select-window win)
12280 (org-beginning-of-dblock)
12281 (forward-line 1)
12282 (while (not (looking-at org-dblock-end-re))
12283 (insert indent)
12284 (beginning-of-line 2))
12285 (when (looking-at org-dblock-end-re)
12286 (and (looking-at "[ \t]+")
12287 (replace-match ""))
12288 (insert indent)))))))
12290 (defun org-beginning-of-dblock ()
12291 "Find the beginning of the dynamic block at point.
12292 Error if there is no such block at point."
12293 (let ((pos (point))
12294 beg)
12295 (end-of-line 1)
12296 (if (and (re-search-backward org-dblock-start-re nil t)
12297 (setq beg (match-beginning 0))
12298 (re-search-forward org-dblock-end-re nil t)
12299 (> (match-end 0) pos))
12300 (goto-char beg)
12301 (goto-char pos)
12302 (error "Not in a dynamic block"))))
12304 (defun org-update-all-dblocks ()
12305 "Update all dynamic blocks in the buffer.
12306 This function can be used in a hook."
12307 (interactive)
12308 (when (derived-mode-p 'org-mode)
12309 (org-map-dblocks 'org-update-dblock)))
12312 ;;;; Completion
12314 (declare-function org-export-backend-name "org-export" (cl-x))
12315 (declare-function org-export-backend-options "org-export" (cl-x))
12316 (defun org-get-export-keywords ()
12317 "Return a list of all currently understood export keywords.
12318 Export keywords include options, block names, attributes and
12319 keywords relative to each registered export back-end."
12320 (let (keywords)
12321 (dolist (backend
12322 (org-bound-and-true-p org-export-registered-backends)
12323 (delq nil keywords))
12324 ;; Back-end name (for keywords, like #+LATEX:)
12325 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12326 (dolist (option-entry (org-export-backend-options backend))
12327 ;; Back-end options.
12328 (push (nth 1 option-entry) keywords)))))
12330 (defconst org-options-keywords
12331 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12332 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12333 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12334 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12335 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12337 (defcustom org-structure-template-alist
12338 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12339 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12340 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12341 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12342 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12343 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12344 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12345 ("L" "#+LaTeX: ")
12346 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12347 ("H" "#+HTML: ")
12348 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12349 ("A" "#+ASCII: ")
12350 ("i" "#+INDEX: ?")
12351 ("I" "#+INCLUDE: %file ?"))
12352 "Structure completion elements.
12353 This is a list of abbreviation keys and values. The value gets inserted
12354 if you type `<' followed by the key and then press the completion key,
12355 usually `TAB'. %file will be replaced by a file name after prompting
12356 for the file using completion. The cursor will be placed at the position
12357 of the `?' in the template.
12358 There are two templates for each key, the first uses the original Org syntax,
12359 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12360 the default when the /org-mtags.el/ module has been loaded. See also the
12361 variable `org-mtags-prefer-muse-templates'."
12362 :group 'org-completion
12363 :type '(repeat
12364 (list
12365 (string :tag "Key")
12366 (string :tag "Template")))
12367 :version "25.1"
12368 :package-version '(Org . "8.3"))
12370 (defun org-try-structure-completion ()
12371 "Try to complete a structure template before point.
12372 This looks for strings like \"<e\" on an otherwise empty line and
12373 expands them."
12374 (let ((l (buffer-substring (point-at-bol) (point)))
12376 (when (and (looking-at "[ \t]*$")
12377 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12378 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12379 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12380 (match-beginning 1)) a)
12381 t)))
12383 (defun org-complete-expand-structure-template (start cell)
12384 "Expand a structure template."
12385 (let ((rpl (nth 1 cell))
12386 (ind ""))
12387 (delete-region start (point))
12388 (when (string-match "\\`[ \t]*#\\+" rpl)
12389 (cond
12390 ((bolp))
12391 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12392 (setq ind (buffer-substring (point-at-bol) (point))))
12393 (t (newline))))
12394 (setq start (point))
12395 (if (string-match "%file" rpl)
12396 (setq rpl (replace-match
12397 (concat
12398 "\""
12399 (save-match-data
12400 (abbreviate-file-name (read-file-name "Include file: ")))
12401 "\"")
12402 t t rpl)))
12403 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12404 (concat "\n" ind)))
12405 (insert rpl)
12406 (if (re-search-backward "\\?" start t) (delete-char 1))))
12408 ;;;; TODO, DEADLINE, Comments
12410 (defun org-toggle-comment ()
12411 "Change the COMMENT state of an entry."
12412 (interactive)
12413 (save-excursion
12414 (org-back-to-heading)
12415 (looking-at org-complex-heading-regexp)
12416 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12417 (skip-chars-forward " \t")
12418 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12419 (if (org-in-commented-heading-p t)
12420 (delete-region (point)
12421 (progn (search-forward " " (line-end-position) 'move)
12422 (skip-chars-forward " \t")
12423 (point)))
12424 (insert org-comment-string)
12425 (unless (eolp) (insert " ")))))
12427 (defvar org-last-todo-state-is-todo nil
12428 "This is non-nil when the last TODO state change led to a TODO state.
12429 If the last change removed the TODO tag or switched to DONE, then
12430 this is nil.")
12432 (defvar org-setting-tags nil) ; dynamically skipped
12434 (defvar org-todo-setup-filter-hook nil
12435 "Hook for functions that pre-filter todo specs.
12436 Each function takes a todo spec and returns either nil or the spec
12437 transformed into canonical form." )
12439 (defvar org-todo-get-default-hook nil
12440 "Hook for functions that get a default item for todo.
12441 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12442 nil or a string to be used for the todo mark." )
12444 (defvar org-agenda-headline-snapshot-before-repeat)
12446 (defun org-current-effective-time ()
12447 "Return current time adjusted for `org-extend-today-until' variable."
12448 (let* ((ct (org-current-time))
12449 (dct (decode-time ct))
12450 (ct1
12451 (cond
12452 (org-use-last-clock-out-time-as-effective-time
12453 (or (org-clock-get-last-clock-out-time) ct))
12454 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12455 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12456 (t ct))))
12457 ct1))
12459 (defun org-todo-yesterday (&optional arg)
12460 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12461 (interactive "P")
12462 (if (eq major-mode 'org-agenda-mode)
12463 (apply 'org-agenda-todo-yesterday arg)
12464 (let* ((org-use-effective-time t)
12465 (hour (third (decode-time
12466 (org-current-time))))
12467 (org-extend-today-until (1+ hour)))
12468 (org-todo arg))))
12470 (defvar org-block-entry-blocking ""
12471 "First entry preventing the TODO state change.")
12473 (defun org-cancel-repeater ()
12474 "Cancel a repeater by setting its numeric value to zero."
12475 (interactive)
12476 (save-excursion
12477 (org-back-to-heading t)
12478 (let ((bound1 (point))
12479 (bound0 (save-excursion (outline-next-heading) (point))))
12480 (when (re-search-forward
12481 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12482 org-deadline-time-regexp "\\)\\|\\("
12483 org-ts-regexp "\\)")
12484 bound0 t)
12485 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12486 (replace-match "0" t nil nil 1))))))
12488 (defun org-todo (&optional arg)
12489 "Change the TODO state of an item.
12490 The state of an item is given by a keyword at the start of the heading,
12491 like
12492 *** TODO Write paper
12493 *** DONE Call mom
12495 The different keywords are specified in the variable `org-todo-keywords'.
12496 By default the available states are \"TODO\" and \"DONE\".
12497 So for this example: when the item starts with TODO, it is changed to DONE.
12498 When it starts with DONE, the DONE is removed. And when neither TODO nor
12499 DONE are present, add TODO at the beginning of the heading.
12501 With \\[universal-argument] prefix arg, use completion to determine the new \
12502 state.
12503 With numeric prefix arg, switch to that state.
12504 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12505 keywords (nextset).
12506 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12507 With a numeric prefix arg of 0, inhibit note taking for the change.
12508 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12510 When called through ELisp, arg is also interpreted in the following way:
12511 `none' -> empty state
12512 \"\"(empty string) -> switch to empty state
12513 `done' -> switch to DONE
12514 `nextset' -> switch to the next set of keywords
12515 `previousset' -> switch to the previous set of keywords
12516 \"WAITING\" -> switch to the specified keyword, but only if it
12517 really is a member of `org-todo-keywords'."
12518 (interactive "P")
12519 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12520 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12521 'region-start-level 'region))
12522 org-loop-over-headlines-in-active-region)
12523 (org-map-entries
12524 `(org-todo ,arg)
12525 org-loop-over-headlines-in-active-region
12526 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12527 (if (equal arg '(16)) (setq arg 'nextset))
12528 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12529 (let ((org-blocker-hook org-blocker-hook)
12530 commentp
12531 case-fold-search)
12532 (when (equal arg '(64))
12533 (setq arg nil org-blocker-hook nil))
12534 (when (and org-blocker-hook
12535 (or org-inhibit-blocking
12536 (org-entry-get nil "NOBLOCKING")))
12537 (setq org-blocker-hook nil))
12538 (save-excursion
12539 (catch 'exit
12540 (org-back-to-heading t)
12541 (when (org-in-commented-heading-p t)
12542 (org-toggle-comment)
12543 (setq commentp t))
12544 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12545 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12546 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12547 (let* ((match-data (match-data))
12548 (startpos (point-at-bol))
12549 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12550 (org-log-done org-log-done)
12551 (org-log-repeat org-log-repeat)
12552 (org-todo-log-states org-todo-log-states)
12553 (org-inhibit-logging
12554 (if (equal arg 0)
12555 (progn (setq arg nil) 'note) org-inhibit-logging))
12556 (this (match-string 1))
12557 (hl-pos (match-beginning 0))
12558 (head (org-get-todo-sequence-head this))
12559 (ass (assoc head org-todo-kwd-alist))
12560 (interpret (nth 1 ass))
12561 (done-word (nth 3 ass))
12562 (final-done-word (nth 4 ass))
12563 (org-last-state (or this ""))
12564 (completion-ignore-case t)
12565 (member (member this org-todo-keywords-1))
12566 (tail (cdr member))
12567 (org-state (cond
12568 ((and org-todo-key-trigger
12569 (or (and (equal arg '(4))
12570 (eq org-use-fast-todo-selection 'prefix))
12571 (and (not arg) org-use-fast-todo-selection
12572 (not (eq org-use-fast-todo-selection
12573 'prefix)))))
12574 ;; Use fast selection
12575 (org-fast-todo-selection))
12576 ((and (equal arg '(4))
12577 (or (not org-use-fast-todo-selection)
12578 (not org-todo-key-trigger)))
12579 ;; Read a state with completion
12580 (org-icompleting-read
12581 "State: " (mapcar 'list org-todo-keywords-1)
12582 nil t))
12583 ((eq arg 'right)
12584 (if this
12585 (if tail (car tail) nil)
12586 (car org-todo-keywords-1)))
12587 ((eq arg 'left)
12588 (if (equal member org-todo-keywords-1)
12590 (if this
12591 (nth (- (length org-todo-keywords-1)
12592 (length tail) 2)
12593 org-todo-keywords-1)
12594 (org-last org-todo-keywords-1))))
12595 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12596 (setq arg nil))) ; hack to fall back to cycling
12597 (arg
12598 ;; user or caller requests a specific state
12599 (cond
12600 ((equal arg "") nil)
12601 ((eq arg 'none) nil)
12602 ((eq arg 'done) (or done-word (car org-done-keywords)))
12603 ((eq arg 'nextset)
12604 (or (car (cdr (member head org-todo-heads)))
12605 (car org-todo-heads)))
12606 ((eq arg 'previousset)
12607 (let ((org-todo-heads (reverse org-todo-heads)))
12608 (or (car (cdr (member head org-todo-heads)))
12609 (car org-todo-heads))))
12610 ((car (member arg org-todo-keywords-1)))
12611 ((stringp arg)
12612 (user-error "State `%s' not valid in this file" arg))
12613 ((nth (1- (prefix-numeric-value arg))
12614 org-todo-keywords-1))))
12615 ((null member) (or head (car org-todo-keywords-1)))
12616 ((equal this final-done-word) nil) ;; -> make empty
12617 ((null tail) nil) ;; -> first entry
12618 ((memq interpret '(type priority))
12619 (if (eq this-command last-command)
12620 (car tail)
12621 (if (> (length tail) 0)
12622 (or done-word (car org-done-keywords))
12623 nil)))
12625 (car tail))))
12626 (org-state (or
12627 (run-hook-with-args-until-success
12628 'org-todo-get-default-hook org-state org-last-state)
12629 org-state))
12630 (next (if org-state (concat " " org-state " ") " "))
12631 (change-plist (list :type 'todo-state-change :from this :to org-state
12632 :position startpos))
12633 dolog now-done-p)
12634 (when org-blocker-hook
12635 (setq org-last-todo-state-is-todo
12636 (not (member this org-done-keywords)))
12637 (unless (save-excursion
12638 (save-match-data
12639 (org-with-wide-buffer
12640 (run-hook-with-args-until-failure
12641 'org-blocker-hook change-plist))))
12642 (if (org-called-interactively-p 'interactive)
12643 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12644 this org-state org-block-entry-blocking)
12645 ;; fail silently
12646 (message "TODO state change from %s to %s blocked (by \"%s\")"
12647 this org-state org-block-entry-blocking)
12648 (throw 'exit nil))))
12649 (store-match-data match-data)
12650 (replace-match next t t)
12651 (cond ((equal this org-state)
12652 (message "TODO state was already %s" (org-trim next)))
12653 ((pos-visible-in-window-p hl-pos)
12654 (message "TODO state changed to %s" (org-trim next))))
12655 (unless head
12656 (setq head (org-get-todo-sequence-head org-state)
12657 ass (assoc head org-todo-kwd-alist)
12658 interpret (nth 1 ass)
12659 done-word (nth 3 ass)
12660 final-done-word (nth 4 ass)))
12661 (when (memq arg '(nextset previousset))
12662 (message "Keyword-Set %d/%d: %s"
12663 (- (length org-todo-sets) -1
12664 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12665 (length org-todo-sets)
12666 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12667 (setq org-last-todo-state-is-todo
12668 (not (member org-state org-done-keywords)))
12669 (setq now-done-p (and (member org-state org-done-keywords)
12670 (not (member this org-done-keywords))))
12671 (and logging (org-local-logging logging))
12672 (when (and (or org-todo-log-states org-log-done)
12673 (not (eq org-inhibit-logging t))
12674 (not (memq arg '(nextset previousset))))
12675 ;; we need to look at recording a time and note
12676 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12677 (nth 2 (assoc this org-todo-log-states))))
12678 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12679 (setq dolog 'time))
12680 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12681 (and org-state
12682 (member org-state org-not-done-keywords)
12683 (not (member this org-not-done-keywords))))
12684 ;; This is now a todo state and was not one before
12685 ;; If there was a CLOSED time stamp, get rid of it.
12686 (org-add-planning-info nil nil 'closed))
12687 (when (and now-done-p org-log-done)
12688 ;; It is now done, and it was not done before
12689 (org-add-planning-info 'closed (org-current-effective-time))
12690 (if (and (not dolog) (eq 'note org-log-done))
12691 (org-add-log-setup 'done org-state this 'findpos 'note)))
12692 (when (and org-state dolog)
12693 ;; This is a non-nil state, and we need to log it
12694 (org-add-log-setup 'state org-state this 'findpos dolog)))
12695 ;; Fixup tag positioning
12696 (org-todo-trigger-tag-changes org-state)
12697 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12698 (when org-provide-todo-statistics
12699 (org-update-parent-todo-statistics))
12700 (run-hooks 'org-after-todo-state-change-hook)
12701 (if (and arg (not (member org-state org-done-keywords)))
12702 (setq head (org-get-todo-sequence-head org-state)))
12703 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12704 ;; Do we need to trigger a repeat?
12705 (when now-done-p
12706 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12707 ;; This is for the agenda, take a snapshot of the headline.
12708 (save-match-data
12709 (setq org-agenda-headline-snapshot-before-repeat
12710 (org-get-heading))))
12711 (org-auto-repeat-maybe org-state))
12712 ;; Fixup cursor location if close to the keyword
12713 (if (and (outline-on-heading-p)
12714 (not (bolp))
12715 (save-excursion (beginning-of-line 1)
12716 (looking-at org-todo-line-regexp))
12717 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12718 (progn
12719 (goto-char (or (match-end 2) (match-end 1)))
12720 (and (looking-at " ") (just-one-space))))
12721 (when org-trigger-hook
12722 (save-excursion
12723 (run-hook-with-args 'org-trigger-hook change-plist)))
12724 (when commentp (org-toggle-comment))))))))
12726 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12727 "Block turning an entry into a TODO, using the hierarchy.
12728 This checks whether the current task should be blocked from state
12729 changes. Such blocking occurs when:
12731 1. The task has children which are not all in a completed state.
12733 2. A task has a parent with the property :ORDERED:, and there
12734 are siblings prior to the current task with incomplete
12735 status.
12737 3. The parent of the task is blocked because it has siblings that should
12738 be done first, or is child of a block grandparent TODO entry."
12740 (if (not org-enforce-todo-dependencies)
12741 t ; if locally turned off don't block
12742 (catch 'dont-block
12743 ;; If this is not a todo state change, or if this entry is already DONE,
12744 ;; do not block
12745 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12746 (member (plist-get change-plist :from)
12747 (cons 'done org-done-keywords))
12748 (member (plist-get change-plist :to)
12749 (cons 'todo org-not-done-keywords))
12750 (not (plist-get change-plist :to)))
12751 (throw 'dont-block t))
12752 ;; If this task has children, and any are undone, it's blocked
12753 (save-excursion
12754 (org-back-to-heading t)
12755 (let ((this-level (funcall outline-level)))
12756 (outline-next-heading)
12757 (let ((child-level (funcall outline-level)))
12758 (while (and (not (eobp))
12759 (> child-level this-level))
12760 ;; this todo has children, check whether they are all
12761 ;; completed
12762 (if (and (not (org-entry-is-done-p))
12763 (org-entry-is-todo-p))
12764 (progn (setq org-block-entry-blocking (org-get-heading))
12765 (throw 'dont-block nil)))
12766 (outline-next-heading)
12767 (setq child-level (funcall outline-level))))))
12768 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12769 ;; any previous siblings are undone, it's blocked
12770 (save-excursion
12771 (org-back-to-heading t)
12772 (let* ((pos (point))
12773 (parent-pos (and (org-up-heading-safe) (point))))
12774 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12775 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12776 (forward-line 1)
12777 (re-search-forward org-not-done-heading-regexp pos t))
12778 (setq org-block-entry-blocking (match-string 0))
12779 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12780 ;; Search further up the hierarchy, to see if an ancestor is blocked
12781 (while t
12782 (goto-char parent-pos)
12783 (if (not (looking-at org-not-done-heading-regexp))
12784 (throw 'dont-block t)) ; do not block, parent is not a TODO
12785 (setq pos (point))
12786 (setq parent-pos (and (org-up-heading-safe) (point)))
12787 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12788 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12789 (forward-line 1)
12790 (re-search-forward org-not-done-heading-regexp pos t)
12791 (setq org-block-entry-blocking (org-get-heading)))
12792 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12794 (defcustom org-track-ordered-property-with-tag nil
12795 "Should the ORDERED property also be shown as a tag?
12796 The ORDERED property decides if an entry should require subtasks to be
12797 completed in sequence. Since a property is not very visible, setting
12798 this option means that toggling the ORDERED property with the command
12799 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12800 not relevant for the behavior, but it makes things more visible.
12802 Note that toggling the tag with tags commands will not change the property
12803 and therefore not influence behavior!
12805 This can be t, meaning the tag ORDERED should be used, It can also be a
12806 string to select a different tag for this task."
12807 :group 'org-todo
12808 :type '(choice
12809 (const :tag "No tracking" nil)
12810 (const :tag "Track with ORDERED tag" t)
12811 (string :tag "Use other tag")))
12813 (defun org-toggle-ordered-property ()
12814 "Toggle the ORDERED property of the current entry.
12815 For better visibility, you can track the value of this property with a tag.
12816 See variable `org-track-ordered-property-with-tag'."
12817 (interactive)
12818 (let* ((t1 org-track-ordered-property-with-tag)
12819 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12820 (save-excursion
12821 (org-back-to-heading)
12822 (if (org-entry-get nil "ORDERED")
12823 (progn
12824 (org-delete-property "ORDERED")
12825 (and tag (org-toggle-tag tag 'off))
12826 (message "Subtasks can be completed in arbitrary order"))
12827 (org-entry-put nil "ORDERED" "t")
12828 (and tag (org-toggle-tag tag 'on))
12829 (message "Subtasks must be completed in sequence")))))
12831 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12832 (defun org-block-todo-from-checkboxes (change-plist)
12833 "Block turning an entry into a TODO, using checkboxes.
12834 This checks whether the current task should be blocked from state
12835 changes because there are unchecked boxes in this entry."
12836 (if (not org-enforce-todo-checkbox-dependencies)
12837 t ; if locally turned off don't block
12838 (catch 'dont-block
12839 ;; If this is not a todo state change, or if this entry is already DONE,
12840 ;; do not block
12841 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12842 (member (plist-get change-plist :from)
12843 (cons 'done org-done-keywords))
12844 (member (plist-get change-plist :to)
12845 (cons 'todo org-not-done-keywords))
12846 (not (plist-get change-plist :to)))
12847 (throw 'dont-block t))
12848 ;; If this task has checkboxes that are not checked, it's blocked
12849 (save-excursion
12850 (org-back-to-heading t)
12851 (let ((beg (point)) end)
12852 (outline-next-heading)
12853 (setq end (point))
12854 (goto-char beg)
12855 (if (org-list-search-forward
12856 (concat (org-item-beginning-re)
12857 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12858 "\\[[- ]\\]")
12859 end t)
12860 (progn
12861 (if (boundp 'org-blocked-by-checkboxes)
12862 (setq org-blocked-by-checkboxes t))
12863 (throw 'dont-block nil)))))
12864 t))) ; do not block
12866 (defun org-entry-blocked-p ()
12867 "Non-nil if entry at point is blocked."
12868 (and (not (org-entry-get nil "NOBLOCKING"))
12869 (member (org-entry-get nil "TODO") org-not-done-keywords)
12870 (not (run-hook-with-args-until-failure
12871 'org-blocker-hook
12872 (list :type 'todo-state-change
12873 :position (point)
12874 :from 'todo
12875 :to 'done)))))
12877 (defun org-update-statistics-cookies (all)
12878 "Update the statistics cookie, either from TODO or from checkboxes.
12879 This should be called with the cursor in a line with a statistics cookie."
12880 (interactive "P")
12881 (if all
12882 (progn
12883 (org-update-checkbox-count 'all)
12884 (org-map-entries 'org-update-parent-todo-statistics))
12885 (if (not (org-at-heading-p))
12886 (org-update-checkbox-count)
12887 (let ((pos (point-marker))
12888 end l1 l2)
12889 (ignore-errors (org-back-to-heading t))
12890 (if (not (org-at-heading-p))
12891 (org-update-checkbox-count)
12892 (setq l1 (org-outline-level))
12893 (setq end (save-excursion
12894 (outline-next-heading)
12895 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12896 (point)))
12897 (if (and (save-excursion
12898 (re-search-forward
12899 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12900 (not (save-excursion (re-search-forward
12901 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12902 (org-update-checkbox-count)
12903 (if (and l2 (> l2 l1))
12904 (progn
12905 (goto-char end)
12906 (org-update-parent-todo-statistics))
12907 (goto-char pos)
12908 (beginning-of-line 1)
12909 (while (re-search-forward
12910 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12911 (point-at-eol) t)
12912 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12913 (goto-char pos)
12914 (move-marker pos nil)))))
12916 (defvar org-entry-property-inherited-from) ;; defined below
12917 (defun org-update-parent-todo-statistics ()
12918 "Update any statistics cookie in the parent of the current headline.
12919 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12920 the entire subtree and this will travel up the hierarchy and update
12921 statistics everywhere."
12922 (let* ((prop (save-excursion (org-up-heading-safe)
12923 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12924 (recursive (or (not org-hierarchical-todo-statistics)
12925 (and prop (string-match "\\<recursive\\>" prop))))
12926 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12928 (first t)
12929 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12930 level ltoggle l1 new ndel
12931 (cnt-all 0) (cnt-done 0) is-percent kwd
12932 checkbox-beg ov ovs ove cookie-present)
12933 (catch 'exit
12934 (save-excursion
12935 (beginning-of-line 1)
12936 (setq ltoggle (funcall outline-level))
12937 ;; Three situations are to consider:
12939 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12940 ;; to the top-level ancestor on the headline;
12942 ;; 2. If parent has "recursive" property, repeat up to the
12943 ;; headline setting that property, taking inheritance into
12944 ;; account;
12946 ;; 3. Else, move up to direct parent and proceed only once.
12947 (while (and (setq level (org-up-heading-safe))
12948 (or recursive first)
12949 (>= (point) lim))
12950 (setq first nil cookie-present nil)
12951 (unless (and level
12952 (not (string-match
12953 "\\<checkbox\\>"
12954 (downcase (or (org-entry-get nil "COOKIE_DATA")
12955 "")))))
12956 (throw 'exit nil))
12957 (while (re-search-forward box-re (point-at-eol) t)
12958 (setq cnt-all 0 cnt-done 0 cookie-present t)
12959 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12960 (save-match-data
12961 (unless (outline-next-heading) (throw 'exit nil))
12962 (while (and (looking-at org-complex-heading-regexp)
12963 (> (setq l1 (length (match-string 1))) level))
12964 (setq kwd (and (or recursive (= l1 ltoggle))
12965 (match-string 2)))
12966 (if (or (eq org-provide-todo-statistics 'all-headlines)
12967 (and (eq org-provide-todo-statistics t)
12968 (or (member kwd org-done-keywords)))
12969 (and (listp org-provide-todo-statistics)
12970 (stringp (car org-provide-todo-statistics))
12971 (or (member kwd org-provide-todo-statistics)
12972 (member kwd org-done-keywords)))
12973 (and (listp org-provide-todo-statistics)
12974 (listp (car org-provide-todo-statistics))
12975 (or (member kwd (car org-provide-todo-statistics))
12976 (and (member kwd org-done-keywords)
12977 (member kwd (cadr org-provide-todo-statistics))))))
12978 (setq cnt-all (1+ cnt-all))
12979 (if (eq org-provide-todo-statistics t)
12980 (and kwd (setq cnt-all (1+ cnt-all)))))
12981 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12982 (member kwd org-done-keywords))
12983 (and (listp org-provide-todo-statistics)
12984 (listp (car org-provide-todo-statistics))
12985 (member kwd org-done-keywords)
12986 (member kwd (cadr org-provide-todo-statistics)))
12987 (and (listp org-provide-todo-statistics)
12988 (stringp (car org-provide-todo-statistics))
12989 (member kwd org-done-keywords)))
12990 (setq cnt-done (1+ cnt-done)))
12991 (outline-next-heading)))
12992 (setq new
12993 (if is-percent
12994 (format "[%d%%]" (floor (* 100.0 cnt-done)
12995 (max 1 cnt-all)))
12996 (format "[%d/%d]" cnt-done cnt-all))
12997 ndel (- (match-end 0) checkbox-beg))
12998 ;; handle overlays when updating cookie from column view
12999 (when (setq ov (car (overlays-at checkbox-beg)))
13000 (setq ovs (overlay-start ov) ove (overlay-end ov))
13001 (delete-overlay ov))
13002 (goto-char checkbox-beg)
13003 (insert new)
13004 (delete-region (point) (+ (point) ndel))
13005 (when org-auto-align-tags (org-fix-tags-on-the-fly))
13006 (when ov (move-overlay ov ovs ove)))
13007 (when cookie-present
13008 (run-hook-with-args 'org-after-todo-statistics-hook
13009 cnt-done (- cnt-all cnt-done))))))
13010 (run-hooks 'org-todo-statistics-hook)))
13012 (defvar org-after-todo-statistics-hook nil
13013 "Hook that is called after a TODO statistics cookie has been updated.
13014 Each function is called with two arguments: the number of not-done entries
13015 and the number of done entries.
13017 For example, the following function, when added to this hook, will switch
13018 an entry to DONE when all children are done, and back to TODO when new
13019 entries are set to a TODO status. Note that this hook is only called
13020 when there is a statistics cookie in the headline!
13022 (defun org-summary-todo (n-done n-not-done)
13023 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13024 (let (org-log-done org-log-states) ; turn off logging
13025 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13028 (defvar org-todo-statistics-hook nil
13029 "Hook that is run whenever Org thinks TODO statistics should be updated.
13030 This hook runs even if there is no statistics cookie present, in which case
13031 `org-after-todo-statistics-hook' would not run.")
13033 (defun org-todo-trigger-tag-changes (state)
13034 "Apply the changes defined in `org-todo-state-tags-triggers'."
13035 (let ((l org-todo-state-tags-triggers)
13036 changes)
13037 (when (or (not state) (equal state ""))
13038 (setq changes (append changes (cdr (assoc "" l)))))
13039 (when (and (stringp state) (> (length state) 0))
13040 (setq changes (append changes (cdr (assoc state l)))))
13041 (when (member state org-not-done-keywords)
13042 (setq changes (append changes (cdr (assoc 'todo l)))))
13043 (when (member state org-done-keywords)
13044 (setq changes (append changes (cdr (assoc 'done l)))))
13045 (dolist (c changes)
13046 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13048 (defun org-local-logging (value)
13049 "Get logging settings from a property VALUE."
13050 ;; Directly set the variables, they are already local.
13051 (setq org-log-done nil
13052 org-log-repeat nil
13053 org-todo-log-states nil)
13054 (dolist (w (org-split-string value))
13055 (let (a)
13056 (cond
13057 ((setq a (assoc w org-startup-options))
13058 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13059 (set (nth 1 a) (nth 2 a))))
13060 ((setq a (org-extract-log-state-settings w))
13061 (and (member (car a) org-todo-keywords-1)
13062 (push a org-todo-log-states)))))))
13064 (defun org-get-todo-sequence-head (kwd)
13065 "Return the head of the TODO sequence to which KWD belongs.
13066 If KWD is not set, check if there is a text property remembering the
13067 right sequence."
13068 (let (p)
13069 (cond
13070 ((not kwd)
13071 (or (get-text-property (point-at-bol) 'org-todo-head)
13072 (progn
13073 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13074 nil (point-at-eol)))
13075 (get-text-property p 'org-todo-head))))
13076 ((not (member kwd org-todo-keywords-1))
13077 (car org-todo-keywords-1))
13078 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13080 (defun org-fast-todo-selection ()
13081 "Fast TODO keyword selection with single keys.
13082 Returns the new TODO keyword, or nil if no state change should occur."
13083 (let* ((fulltable org-todo-key-alist)
13084 (done-keywords org-done-keywords) ;; needed for the faces.
13085 (maxlen (apply 'max (mapcar
13086 (lambda (x)
13087 (if (stringp (car x)) (string-width (car x)) 0))
13088 fulltable)))
13089 (expert nil)
13090 (fwidth (+ maxlen 3 1 3))
13091 (ncol (/ (- (window-width) 4) fwidth))
13092 tg cnt e c tbl
13093 groups ingroup)
13094 (save-excursion
13095 (save-window-excursion
13096 (if expert
13097 (set-buffer (get-buffer-create " *Org todo*"))
13098 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13099 (erase-buffer)
13100 (org-set-local 'org-done-keywords done-keywords)
13101 (setq tbl fulltable cnt 0)
13102 (while (setq e (pop tbl))
13103 (cond
13104 ((equal e '(:startgroup))
13105 (push '() groups) (setq ingroup t)
13106 (when (not (= cnt 0))
13107 (setq cnt 0)
13108 (insert "\n"))
13109 (insert "{ "))
13110 ((equal e '(:endgroup))
13111 (setq ingroup nil cnt 0)
13112 (insert "}\n"))
13113 ((equal e '(:newline))
13114 (when (not (= cnt 0))
13115 (setq cnt 0)
13116 (insert "\n")
13117 (setq e (car tbl))
13118 (while (equal (car tbl) '(:newline))
13119 (insert "\n")
13120 (setq tbl (cdr tbl)))))
13122 (setq tg (car e) c (cdr e))
13123 (if ingroup (push tg (car groups)))
13124 (setq tg (org-add-props tg nil 'face
13125 (org-get-todo-face tg)))
13126 (if (and (= cnt 0) (not ingroup)) (insert " "))
13127 (insert "[" c "] " tg (make-string
13128 (- fwidth 4 (length tg)) ?\ ))
13129 (when (= (setq cnt (1+ cnt)) ncol)
13130 (insert "\n")
13131 (if ingroup (insert " "))
13132 (setq cnt 0)))))
13133 (insert "\n")
13134 (goto-char (point-min))
13135 (if (not expert) (org-fit-window-to-buffer))
13136 (message "[a-z..]:Set [SPC]:clear")
13137 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13138 (cond
13139 ((or (= c ?\C-g)
13140 (and (= c ?q) (not (rassoc c fulltable))))
13141 (setq quit-flag t))
13142 ((= c ?\ ) nil)
13143 ((setq e (rassoc c fulltable) tg (car e))
13145 (t (setq quit-flag t)))))))
13147 (defun org-entry-is-todo-p ()
13148 (member (org-get-todo-state) org-not-done-keywords))
13150 (defun org-entry-is-done-p ()
13151 (member (org-get-todo-state) org-done-keywords))
13153 (defun org-get-todo-state ()
13154 "Return the TODO keyword of the current subtree."
13155 (save-excursion
13156 (org-back-to-heading t)
13157 (and (looking-at org-todo-line-regexp)
13158 (match-end 2)
13159 (match-string 2))))
13161 (defun org-at-date-range-p (&optional inactive-ok)
13162 "Non-nil if point is inside a date range.
13164 When optional argument INACTIVE-OK is non-nil, also consider
13165 inactive time ranges.
13167 When this function returns a non-nil value, match data is set
13168 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13169 on INACTIVE-OK."
13170 (interactive)
13171 (save-excursion
13172 (catch 'exit
13173 (let ((pos (point)))
13174 (skip-chars-backward "^[<\r\n")
13175 (skip-chars-backward "<[")
13176 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13177 (>= (match-end 0) pos)
13178 (throw 'exit t))
13179 (skip-chars-backward "^<[\r\n")
13180 (skip-chars-backward "<[")
13181 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13182 (>= (match-end 0) pos)
13183 (throw 'exit t)))
13184 nil)))
13186 (defun org-get-repeat (&optional tagline)
13187 "Check if there is a deadline/schedule with repeater in this entry."
13188 (save-match-data
13189 (save-excursion
13190 (org-back-to-heading t)
13191 (and (re-search-forward (if tagline
13192 (concat tagline "\\s-*" org-repeat-re)
13193 org-repeat-re)
13194 (org-entry-end-position) t)
13195 (match-string-no-properties 1)))))
13197 (defvar org-last-changed-timestamp)
13198 (defvar org-last-inserted-timestamp)
13199 (defvar org-log-post-message)
13200 (defvar org-log-note-purpose)
13201 (defvar org-log-note-how nil)
13202 (defvar org-log-note-extra)
13203 (defun org-auto-repeat-maybe (done-word)
13204 "Check if the current headline contains a repeated deadline/schedule.
13205 If yes, set TODO state back to what it was and change the base date
13206 of repeating deadline/scheduled time stamps to new date.
13207 This function is run automatically after each state change to a DONE state."
13208 ;; last-state is dynamically scoped into this function
13209 (let* ((repeat (org-get-repeat))
13210 (aa (assoc org-last-state org-todo-kwd-alist))
13211 (interpret (nth 1 aa))
13212 (head (nth 2 aa))
13213 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13214 (msg "Entry repeats: ")
13215 (org-log-done nil)
13216 (org-todo-log-states nil)
13217 re type n what ts time to-state)
13218 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13219 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13220 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13221 org-todo-repeat-to-state))
13222 (unless (and to-state (member to-state org-todo-keywords-1))
13223 (setq to-state (if (eq interpret 'type) org-last-state head)))
13224 (org-todo to-state)
13225 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13226 (org-entry-put nil "LAST_REPEAT" (format-time-string
13227 (org-time-stamp-format t t))))
13228 (when org-log-repeat
13229 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13230 (memq 'org-add-log-note post-command-hook))
13231 ;; OK, we are already setup for some record
13232 (if (eq org-log-repeat 'note)
13233 ;; make sure we take a note, not only a time stamp
13234 (setq org-log-note-how 'note))
13235 ;; Set up for taking a record
13236 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13237 org-last-state
13238 'findpos org-log-repeat)))
13239 (org-back-to-heading t)
13240 (org-add-planning-info nil nil 'closed)
13241 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13242 org-deadline-time-regexp "\\)\\|\\("
13243 org-ts-regexp "\\)"))
13244 (while (re-search-forward
13245 re (save-excursion (outline-next-heading) (point)) t)
13246 (setq type (if (match-end 1) org-scheduled-string
13247 (if (match-end 3) org-deadline-string "Plain:"))
13248 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13249 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13250 (setq n (string-to-number (match-string 2 ts))
13251 what (match-string 3 ts))
13252 (if (equal what "w") (setq n (* n 7) what "d"))
13253 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13254 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13255 ;; Preparation, see if we need to modify the start date for the change
13256 (when (match-end 1)
13257 (setq time (save-match-data (org-time-string-to-time ts)))
13258 (cond
13259 ((equal (match-string 1 ts) ".")
13260 ;; Shift starting date to today
13261 (org-timestamp-change
13262 (- (org-today) (time-to-days time))
13263 'day))
13264 ((equal (match-string 1 ts) "+")
13265 (let ((nshiftmax 10) (nshift 0))
13266 (while (or (= nshift 0)
13267 (<= (time-to-days time)
13268 (time-to-days (current-time))))
13269 (when (= (incf nshift) nshiftmax)
13270 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13271 (user-error "Abort")))
13272 (org-timestamp-change n (cdr (assoc what whata)))
13273 (org-at-timestamp-p t)
13274 (setq ts (match-string 1))
13275 (setq time (save-match-data (org-time-string-to-time ts)))))
13276 (org-timestamp-change (- n) (cdr (assoc what whata)))
13277 ;; rematch, so that we have everything in place for the real shift
13278 (org-at-timestamp-p t)
13279 (setq ts (match-string 1))
13280 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13281 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13282 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13283 (setq org-log-post-message msg)
13284 (message "%s" msg))))
13286 (defun org-show-todo-tree (arg)
13287 "Make a compact tree which shows all headlines marked with TODO.
13288 The tree will show the lines where the regexp matches, and all higher
13289 headlines above the match.
13290 With a \\[universal-argument] prefix, prompt for a regexp to match.
13291 With a numeric prefix N, construct a sparse tree for the Nth element
13292 of `org-todo-keywords-1'."
13293 (interactive "P")
13294 (let ((case-fold-search nil)
13295 (kwd-re
13296 (cond ((null arg) org-not-done-regexp)
13297 ((equal arg '(4))
13298 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13299 (mapcar 'list org-todo-keywords-1))))
13300 (concat "\\("
13301 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13302 "\\)\\>")))
13303 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13304 (regexp-quote (nth (1- (prefix-numeric-value arg))
13305 org-todo-keywords-1)))
13306 (t (user-error "Invalid prefix argument: %s" arg)))))
13307 (message "%d TODO entries found"
13308 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13310 (defun org-deadline (arg &optional time)
13311 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13312 With one universal prefix argument, remove any deadline from the item.
13313 With two universal prefix arguments, prompt for a warning delay.
13314 With argument TIME, set the deadline at the corresponding date. TIME
13315 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13316 (interactive "P")
13317 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13318 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13319 'region-start-level 'region))
13320 org-loop-over-headlines-in-active-region)
13321 (org-map-entries
13322 `(org-deadline ',arg ,time)
13323 org-loop-over-headlines-in-active-region
13324 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13325 (let* ((old-date (org-entry-get nil "DEADLINE"))
13326 (old-date-time (if old-date (org-time-string-to-time old-date)))
13327 (repeater (and old-date
13328 (string-match
13329 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13330 old-date)
13331 (match-string 1 old-date))))
13332 (cond
13333 ((equal arg '(4))
13334 (when (and old-date org-log-redeadline)
13335 (org-add-log-setup 'deldeadline nil old-date 'findpos
13336 org-log-redeadline))
13337 (org-remove-timestamp-with-keyword org-deadline-string)
13338 (message "Item no longer has a deadline."))
13339 ((equal arg '(16))
13340 (save-excursion
13341 (org-back-to-heading t)
13342 (if (re-search-forward
13343 org-deadline-time-regexp
13344 (save-excursion (outline-next-heading) (point)) t)
13345 (let* ((rpl0 (match-string 1))
13346 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13347 (replace-match
13348 (concat org-deadline-string
13349 " <" rpl
13350 (format " -%dd"
13351 (abs
13352 (- (time-to-days
13353 (save-match-data
13354 (org-read-date nil t nil "Warn starting from" old-date-time)))
13355 (time-to-days old-date-time))))
13356 ">") t t))
13357 (user-error "No deadline information to update"))))
13359 (org-add-planning-info 'deadline time 'closed)
13360 (when (and old-date
13361 org-log-redeadline
13362 (not (equal old-date org-last-inserted-timestamp)))
13363 (org-add-log-setup
13364 'redeadline org-last-inserted-timestamp old-date 'findpos
13365 org-log-redeadline))
13366 (when repeater
13367 (save-excursion
13368 (org-back-to-heading t)
13369 (when (re-search-forward (concat org-deadline-string " "
13370 org-last-inserted-timestamp)
13371 (save-excursion
13372 (outline-next-heading) (point)) t)
13373 (goto-char (1- (match-end 0)))
13374 (insert " " repeater)
13375 (setq org-last-inserted-timestamp
13376 (concat (substring org-last-inserted-timestamp 0 -1)
13377 " " repeater
13378 (substring org-last-inserted-timestamp -1))))))
13379 (message "Deadline on %s" org-last-inserted-timestamp))))))
13381 (defun org-schedule (arg &optional time)
13382 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13383 With one universal prefix argument, remove any scheduling date from the item.
13384 With two universal prefix arguments, prompt for a delay cookie.
13385 With argument TIME, scheduled at the corresponding date. TIME can
13386 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13387 (interactive "P")
13388 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13389 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13390 'region-start-level 'region))
13391 org-loop-over-headlines-in-active-region)
13392 (org-map-entries
13393 `(org-schedule ',arg ,time)
13394 org-loop-over-headlines-in-active-region
13395 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13396 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13397 (old-date-time (if old-date (org-time-string-to-time old-date)))
13398 (repeater (and old-date
13399 (string-match
13400 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13401 old-date)
13402 (match-string 1 old-date))))
13403 (cond
13404 ((equal arg '(4))
13405 (progn
13406 (when (and old-date org-log-reschedule)
13407 (org-add-log-setup 'delschedule nil old-date 'findpos
13408 org-log-reschedule))
13409 (org-remove-timestamp-with-keyword org-scheduled-string)
13410 (message "Item is no longer scheduled.")))
13411 ((equal arg '(16))
13412 (save-excursion
13413 (org-back-to-heading t)
13414 (if (re-search-forward
13415 org-scheduled-time-regexp
13416 (save-excursion (outline-next-heading) (point)) t)
13417 (let* ((rpl0 (match-string 1))
13418 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13419 (replace-match
13420 (concat org-scheduled-string
13421 " <" rpl
13422 (format " -%dd"
13423 (abs
13424 (- (time-to-days
13425 (save-match-data
13426 (org-read-date nil t nil "Delay until" old-date-time)))
13427 (time-to-days old-date-time))))
13428 ">") t t))
13429 (user-error "No scheduled information to update"))))
13431 (org-add-planning-info 'scheduled time 'closed)
13432 (when (and old-date
13433 org-log-reschedule
13434 (not (equal old-date org-last-inserted-timestamp)))
13435 (org-add-log-setup
13436 'reschedule org-last-inserted-timestamp old-date 'findpos
13437 org-log-reschedule))
13438 (when repeater
13439 (save-excursion
13440 (org-back-to-heading t)
13441 (when (re-search-forward (concat org-scheduled-string " "
13442 org-last-inserted-timestamp)
13443 (save-excursion
13444 (outline-next-heading) (point)) t)
13445 (goto-char (1- (match-end 0)))
13446 (insert " " repeater)
13447 (setq org-last-inserted-timestamp
13448 (concat (substring org-last-inserted-timestamp 0 -1)
13449 " " repeater
13450 (substring org-last-inserted-timestamp -1))))))
13451 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13453 (defun org-get-scheduled-time (pom &optional inherit)
13454 "Get the scheduled time as a time tuple, of a format suitable
13455 for calling org-schedule with, or if there is no scheduling,
13456 returns nil."
13457 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13458 (when time
13459 (apply 'encode-time (org-parse-time-string time)))))
13461 (defun org-get-deadline-time (pom &optional inherit)
13462 "Get the deadline as a time tuple, of a format suitable for
13463 calling org-deadline with, or if there is no scheduling, returns
13464 nil."
13465 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13466 (when time
13467 (apply 'encode-time (org-parse-time-string time)))))
13469 (defun org-remove-timestamp-with-keyword (keyword)
13470 "Remove all time stamps with KEYWORD in the current entry."
13471 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13472 beg)
13473 (save-excursion
13474 (org-back-to-heading t)
13475 (setq beg (point))
13476 (outline-next-heading)
13477 (while (re-search-backward re beg t)
13478 (replace-match "")
13479 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13480 (equal (char-before) ?\ ))
13481 (backward-delete-char 1)
13482 (if (string-match "^[ \t]*$" (buffer-substring
13483 (point-at-bol) (point-at-eol)))
13484 (delete-region (point-at-bol)
13485 (min (point-max) (1+ (point-at-eol))))))))))
13487 (defvar org-time-was-given) ; dynamically scoped parameter
13488 (defvar org-end-time-was-given) ; dynamically scoped parameter
13490 (defun org-at-planning-p ()
13491 "Non-nil when point is on a planning info line."
13492 ;; This is as accurate and faster than `org-element-at-point' since
13493 ;; planning info location is fixed in the section.
13494 (org-with-wide-buffer
13495 (beginning-of-line)
13496 (and (org-looking-at-p org-planning-line-re)
13497 (eq (point)
13498 (ignore-errors
13499 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13500 (org-back-to-heading t)
13501 (org-with-limited-levels (org-back-to-heading t)))
13502 (line-beginning-position 2))))))
13504 (defun org-add-planning-info (what &optional time &rest remove)
13505 "Insert new timestamp with keyword in the planning line.
13506 WHAT indicates what kind of time stamp to add. It is a symbol
13507 among `closed', `deadline', `scheduled' and nil. TIME indicates
13508 the time to use. If none is given, the user is prompted for
13509 a date. REMOVE indicates what kind of entries to remove. An old
13510 WHAT entry will also be removed."
13511 (let (org-time-was-given org-end-time-was-given default-time default-input)
13512 (catch 'exit
13513 (when (and (memq what '(scheduled deadline))
13514 (or (not time)
13515 (and (stringp time)
13516 (string-match "^[-+]+[0-9]" time))))
13517 ;; Try to get a default date/time from existing timestamp
13518 (save-excursion
13519 (org-back-to-heading t)
13520 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13521 (when (re-search-forward (if (eq what 'scheduled)
13522 org-scheduled-time-regexp
13523 org-deadline-time-regexp)
13524 end t)
13525 (setq ts (match-string 1)
13526 default-time (apply 'encode-time (org-parse-time-string ts))
13527 default-input (and ts (org-get-compact-tod ts)))))))
13528 (when what
13529 (setq time
13530 (if (stringp time)
13531 ;; This is a string (relative or absolute), set
13532 ;; proper date.
13533 (apply #'encode-time
13534 (org-read-date-analyze
13535 time default-time (decode-time default-time)))
13536 ;; If necessary, get the time from the user
13537 (or time (org-read-date nil 'to-time nil nil
13538 default-time default-input)))))
13540 (org-with-wide-buffer
13541 (org-back-to-heading t)
13542 (forward-line)
13543 (unless (bolp) (insert "\n"))
13544 (cond ((org-looking-at-p org-planning-line-re)
13545 ;; Move to current indentation.
13546 (skip-chars-forward " \t")
13547 ;; Check if we have to remove something.
13548 (dolist (type (if what (cons what remove) remove))
13549 (save-excursion
13550 (when (re-search-forward
13551 (case type
13552 (closed org-closed-time-regexp)
13553 (deadline org-deadline-time-regexp)
13554 (scheduled org-scheduled-time-regexp)
13555 (otherwise
13556 (error "Invalid planning type: %s" type)))
13557 (line-end-position) t)
13558 ;; Delete until next keyword or end of line.
13559 (delete-region
13560 (match-beginning 0)
13561 (if (re-search-forward org-keyword-time-not-clock-regexp
13562 (line-end-position)
13564 (match-beginning 0)
13565 (line-end-position))))))
13566 ;; If there is nothing more to add and no more keyword
13567 ;; is left, remove the line completely.
13568 (if (and (org-looking-at-p "[ \t]*$") (not what))
13569 (delete-region (line-beginning-position)
13570 (line-beginning-position 2))
13571 ;; If we removed last keyword, do not leave trailing
13572 ;; white space at the end of line.
13573 (let ((p (point)))
13574 (save-excursion
13575 (end-of-line)
13576 (unless (= (skip-chars-backward " \t" p) 0)
13577 (delete-region (point) (line-end-position)))))))
13578 ((not what) (throw 'exit nil)) ; Nothing to do.
13579 (t (insert-before-markers "\n")
13580 (backward-char 1)
13581 (when org-adapt-indentation
13582 (org-indent-to-column (1+ (org-outline-level))))))
13583 (when what
13584 ;; Insert planning keyword.
13585 (insert (case what
13586 (closed org-closed-string)
13587 (deadline org-deadline-string)
13588 (scheduled org-scheduled-string)
13589 (otherwise (error "Invalid planning type: %s" what)))
13590 " ")
13591 ;; Insert associated timestamp.
13592 (let ((ts (org-insert-time-stamp
13593 time
13594 (or org-time-was-given
13595 (and (eq what 'closed) org-log-done-with-time))
13596 (eq what 'closed)
13597 nil nil (list org-end-time-was-given))))
13598 (unless (eolp) (insert " "))
13599 ts))))))
13601 (defvar org-log-note-marker (make-marker))
13602 (defvar org-log-note-purpose nil)
13603 (defvar org-log-note-state nil)
13604 (defvar org-log-note-previous-state nil)
13605 (defvar org-log-note-extra nil)
13606 (defvar org-log-note-window-configuration nil)
13607 (defvar org-log-note-return-to (make-marker))
13608 (defvar org-log-note-effective-time nil
13609 "Remembered current time so that dynamically scoped
13610 `org-extend-today-until' affects tha timestamps in state change
13611 log")
13613 (defvar org-log-post-message nil
13614 "Message to be displayed after a log note has been stored.
13615 The auto-repeater uses this.")
13617 (defun org-add-note ()
13618 "Add a note to the current entry.
13619 This is done in the same way as adding a state change note."
13620 (interactive)
13621 (org-add-log-setup 'note nil nil 'findpos nil))
13623 (defun org-log-beginning (&optional create)
13624 "Return expected start of log notes in current entry.
13625 When optional argument CREATE is non-nil, the function creates
13626 a drawer to store notes, if necessary. Returned position ignores
13627 narrowing."
13628 (org-with-wide-buffer
13629 (org-end-of-meta-data)
13630 (let ((end (if (org-at-heading-p) (point)
13631 (save-excursion (outline-next-heading) (point))))
13632 (drawer (org-log-into-drawer)))
13633 (cond
13634 (drawer
13635 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13636 (case-fold-search t))
13637 (catch 'exit
13638 ;; Try to find existing drawer.
13639 (while (re-search-forward regexp end t)
13640 (let ((element (org-element-at-point)))
13641 (when (eq (org-element-type element) 'drawer)
13642 (let ((cend (org-element-property :contents-end element)))
13643 (when (and (not org-log-states-order-reversed) cend)
13644 (goto-char cend)))
13645 (throw 'exit nil))))
13646 ;; No drawer found. Create one, if permitted.
13647 (when create
13648 (unless (bolp) (insert "\n"))
13649 (let ((beg (point)))
13650 (insert ":" drawer ":\n:END:\n")
13651 (org-indent-region beg (point)))
13652 (end-of-line -1)))))
13653 (org-log-state-notes-insert-after-drawers
13654 (while (and (looking-at org-drawer-regexp)
13655 (progn (goto-char (match-end 0))
13656 (re-search-forward org-property-end-re end t)))
13657 (forward-line)))))
13658 (if (bolp) (point) (line-beginning-position 2))))
13660 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13661 "Set up the post command hook to take a note.
13662 If this is about to TODO state change, the new state is expected in STATE.
13663 When FINDPOS is non-nil, find the correct position for the note in
13664 the current entry. If not, assume that it can be inserted at point.
13665 HOW is an indicator what kind of note should be created.
13666 EXTRA is additional text that will be inserted into the notes buffer."
13667 (org-with-wide-buffer
13668 (when findpos
13669 (goto-char (org-log-beginning t))
13670 (unless org-log-states-order-reversed
13671 (org-skip-over-state-notes)
13672 (skip-chars-backward " \t\n\r")
13673 (forward-line)))
13674 (move-marker org-log-note-marker (point))
13675 ;; Preserve position even if a property drawer is inserted in the
13676 ;; process.
13677 (set-marker-insertion-type org-log-note-marker t)
13678 (setq org-log-note-purpose purpose
13679 org-log-note-state state
13680 org-log-note-previous-state prev-state
13681 org-log-note-how how
13682 org-log-note-extra extra
13683 org-log-note-effective-time (org-current-effective-time))
13684 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13686 (defun org-skip-over-state-notes ()
13687 "Skip past the list of State notes in an entry."
13688 (when (ignore-errors (goto-char (org-in-item-p)))
13689 (let* ((struct (org-list-struct))
13690 (prevs (org-list-prevs-alist struct))
13691 (regexp
13692 (concat "[ \t]*- +"
13693 (replace-regexp-in-string
13694 " +" " +"
13695 (org-replace-escapes
13696 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13697 `(("%d" . ,org-ts-regexp-inactive)
13698 ("%D" . ,org-ts-regexp)
13699 ("%s" . "\"\\S-+\"")
13700 ("%S" . "\"\\S-+\"")
13701 ("%t" . ,org-ts-regexp-inactive)
13702 ("%T" . ,org-ts-regexp)
13703 ("%u" . ".*?")
13704 ("%U" . ".*?")))))))
13705 (while (org-looking-at-p regexp)
13706 (goto-char (or (org-list-get-next-item (point) struct prevs)
13707 (org-list-get-item-end (point) struct)))))))
13709 (defun org-add-log-note (&optional purpose)
13710 "Pop up a window for taking a note, and add this note later at point."
13711 (remove-hook 'post-command-hook 'org-add-log-note)
13712 (setq org-log-note-window-configuration (current-window-configuration))
13713 (delete-other-windows)
13714 (move-marker org-log-note-return-to (point))
13715 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13716 (goto-char org-log-note-marker)
13717 (org-switch-to-buffer-other-window "*Org Note*")
13718 (erase-buffer)
13719 (if (memq org-log-note-how '(time state))
13720 (let (current-prefix-arg) (org-store-log-note))
13721 (let ((org-inhibit-startup t)) (org-mode))
13722 (insert (format "# Insert note for %s.
13723 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13724 (cond
13725 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13726 ((eq org-log-note-purpose 'done) "closed todo item")
13727 ((eq org-log-note-purpose 'state)
13728 (format "state change from \"%s\" to \"%s\""
13729 (or org-log-note-previous-state "")
13730 (or org-log-note-state "")))
13731 ((eq org-log-note-purpose 'reschedule)
13732 "rescheduling")
13733 ((eq org-log-note-purpose 'delschedule)
13734 "no longer scheduled")
13735 ((eq org-log-note-purpose 'redeadline)
13736 "changing deadline")
13737 ((eq org-log-note-purpose 'deldeadline)
13738 "removing deadline")
13739 ((eq org-log-note-purpose 'refile)
13740 "refiling")
13741 ((eq org-log-note-purpose 'note)
13742 "this entry")
13743 (t (error "This should not happen")))))
13744 (if org-log-note-extra (insert org-log-note-extra))
13745 (org-set-local 'org-finish-function 'org-store-log-note)
13746 (run-hooks 'org-log-buffer-setup-hook)))
13748 (defvar org-note-abort nil) ; dynamically scoped
13749 (defun org-store-log-note ()
13750 "Finish taking a log note, and insert it to where it belongs."
13751 (let ((txt (buffer-string)))
13752 (kill-buffer (current-buffer))
13753 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13754 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13755 (setq txt (replace-match "" t t txt)))
13756 (if (string-match "\\s-+\\'" txt)
13757 (setq txt (replace-match "" t t txt)))
13758 (setq lines (org-split-string txt "\n"))
13759 (when (and note (string-match "\\S-" note))
13760 (setq note
13761 (org-replace-escapes
13762 note
13763 (list (cons "%u" (user-login-name))
13764 (cons "%U" user-full-name)
13765 (cons "%t" (format-time-string
13766 (org-time-stamp-format 'long 'inactive)
13767 org-log-note-effective-time))
13768 (cons "%T" (format-time-string
13769 (org-time-stamp-format 'long nil)
13770 org-log-note-effective-time))
13771 (cons "%d" (format-time-string
13772 (org-time-stamp-format nil 'inactive)
13773 org-log-note-effective-time))
13774 (cons "%D" (format-time-string
13775 (org-time-stamp-format nil nil)
13776 org-log-note-effective-time))
13777 (cons "%s" (cond
13778 ((not org-log-note-state) "")
13779 ((org-string-match-p org-ts-regexp
13780 org-log-note-state)
13781 (format "\"[%s]\""
13782 (substring org-log-note-state 1 -1)))
13783 (t (format "\"%s\"" org-log-note-state))))
13784 (cons "%S"
13785 (cond
13786 ((not org-log-note-previous-state) "")
13787 ((org-string-match-p org-ts-regexp
13788 org-log-note-previous-state)
13789 (format "\"[%s]\""
13790 (substring
13791 org-log-note-previous-state 1 -1)))
13792 (t (format "\"%s\""
13793 org-log-note-previous-state)))))))
13794 (when lines (setq note (concat note " \\\\")))
13795 (push note lines))
13796 (when (or current-prefix-arg org-note-abort)
13797 (when (org-log-into-drawer)
13798 (org-remove-empty-drawer-at org-log-note-marker))
13799 (setq lines nil))
13800 (when lines
13801 (with-current-buffer (marker-buffer org-log-note-marker)
13802 (org-with-wide-buffer
13803 (goto-char org-log-note-marker)
13804 (move-marker org-log-note-marker nil)
13805 ;; Make sure point is at the beginning of an empty line.
13806 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13807 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13808 ;; In an existing list, add a new item at the top level.
13809 ;; Otherwise, indent line like a regular one.
13810 (let ((itemp (org-in-item-p)))
13811 (if itemp
13812 (org-indent-line-to
13813 (let ((struct (save-excursion
13814 (goto-char itemp) (org-list-struct))))
13815 (org-list-get-ind (org-list-get-top-point struct) struct)))
13816 (org-indent-line)))
13817 (insert (org-list-bullet-string "-") (pop lines))
13818 (let ((ind (org-list-item-body-column (line-beginning-position))))
13819 (dolist (line lines)
13820 (insert "\n")
13821 (org-indent-line-to ind)
13822 (insert line)))
13823 (message "Note stored")
13824 (org-back-to-heading t)
13825 (org-cycle-hide-drawers 'children))
13826 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13827 ;; from within `org-add-log-note' because `buffer-undo-list'
13828 ;; is then modified outside of `org-with-remote-undo'.
13829 (when (eq this-command 'org-agenda-todo)
13830 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13831 ;; Don't add undo information when called from `org-agenda-todo'
13832 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13833 (set-window-configuration org-log-note-window-configuration)
13834 (with-current-buffer (marker-buffer org-log-note-return-to)
13835 (goto-char org-log-note-return-to))
13836 (move-marker org-log-note-return-to nil)
13837 (and org-log-post-message (message "%s" org-log-post-message))))
13839 (defun org-remove-empty-drawer-at (pos)
13840 "Remove an empty drawer at position POS.
13841 POS may also be a marker."
13842 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13843 (org-with-wide-buffer
13844 (goto-char pos)
13845 (let ((drawer (org-element-at-point)))
13846 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13847 (not (org-element-property :contents-begin drawer)))
13848 (delete-region (org-element-property :begin drawer)
13849 (progn (goto-char (org-element-property :end drawer))
13850 (skip-chars-backward " \r\t\n")
13851 (forward-line)
13852 (point))))))))
13854 (defvar org-ts-type nil)
13855 (defun org-sparse-tree (&optional arg type)
13856 "Create a sparse tree, prompt for the details.
13857 This command can create sparse trees. You first need to select the type
13858 of match used to create the tree:
13860 t Show all TODO entries.
13861 T Show entries with a specific TODO keyword.
13862 m Show entries selected by a tags/property match.
13863 p Enter a property name and its value (both with completion on existing
13864 names/values) and show entries with that property.
13865 r Show entries matching a regular expression (`/' can be used as well).
13866 b Show deadlines and scheduled items before a date.
13867 a Show deadlines and scheduled items after a date.
13868 d Show deadlines due within `org-deadline-warning-days'.
13869 D Show deadlines and scheduled items between a date range."
13870 (interactive "P")
13871 (setq type (or type org-sparse-tree-default-date-type))
13872 (setq org-ts-type type)
13873 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13874 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13875 [c]ycle through date types: %s"
13876 (case type
13877 (all "all timestamps")
13878 (scheduled "only scheduled")
13879 (deadline "only deadline")
13880 (active "only active timestamps")
13881 (inactive "only inactive timestamps")
13882 (closed "with a closed time-stamp")
13883 (otherwise "scheduled/deadline")))
13884 (let ((answer (read-char-exclusive)))
13885 (case answer
13887 (org-sparse-tree
13889 (cadr
13890 (memq type '(nil all scheduled deadline active inactive closed)))))
13891 (?d (call-interactively 'org-check-deadlines))
13892 (?b (call-interactively 'org-check-before-date))
13893 (?a (call-interactively 'org-check-after-date))
13894 (?D (call-interactively 'org-check-dates-range))
13895 (?t (call-interactively 'org-show-todo-tree))
13896 (?T (org-show-todo-tree '(4)))
13897 (?m (call-interactively 'org-match-sparse-tree))
13898 ((?p ?P)
13899 (let* ((kwd (org-icompleting-read
13900 "Property: " (mapcar 'list (org-buffer-property-keys))))
13901 (value (org-icompleting-read
13902 "Value: " (mapcar 'list (org-property-values kwd)))))
13903 (unless (string-match "\\`{.*}\\'" value)
13904 (setq value (concat "\"" value "\"")))
13905 (org-match-sparse-tree arg (concat kwd "=" value))))
13906 ((?r ?R ?/) (call-interactively 'org-occur))
13907 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13909 (defvar org-occur-highlights nil
13910 "List of overlays used for occur matches.")
13911 (make-variable-buffer-local 'org-occur-highlights)
13912 (defvar org-occur-parameters nil
13913 "Parameters of the active org-occur calls.
13914 This is a list, each call to org-occur pushes as cons cell,
13915 containing the regular expression and the callback, onto the list.
13916 The list can contain several entries if `org-occur' has been called
13917 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13918 will only contain one set of parameters. When the highlights are
13919 removed (for example with `C-c C-c', or with the next edit (depending
13920 on `org-remove-highlights-with-change'), this variable is emptied
13921 as well.")
13922 (make-variable-buffer-local 'org-occur-parameters)
13924 (defun org-occur (regexp &optional keep-previous callback)
13925 "Make a compact tree which shows all matches of REGEXP.
13926 The tree will show the lines where the regexp matches, and all higher
13927 headlines above the match. It will also show the heading after the match,
13928 to make sure editing the matching entry is easy.
13929 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13930 call to `org-occur' will be kept, to allow stacking of calls to this
13931 command.
13932 If CALLBACK is non-nil, it is a function which is called to confirm
13933 that the match should indeed be shown."
13934 (interactive "sRegexp: \nP")
13935 (when (equal regexp "")
13936 (user-error "Regexp cannot be empty"))
13937 (unless keep-previous
13938 (org-remove-occur-highlights nil nil t))
13939 (push (cons regexp callback) org-occur-parameters)
13940 (let ((cnt 0))
13941 (save-excursion
13942 (goto-char (point-min))
13943 (if (or (not keep-previous) ; do not want to keep
13944 (not org-occur-highlights)) ; no previous matches
13945 ;; hide everything
13946 (org-overview))
13947 (while (re-search-forward regexp nil t)
13948 (backward-char) ;; FIXME: Match timestamps at the end of a headline
13949 (when (or (not callback)
13950 (save-match-data (funcall callback)))
13951 (setq cnt (1+ cnt))
13952 (when org-highlight-sparse-tree-matches
13953 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13954 (org-show-context 'occur-tree))))
13955 (when org-remove-highlights-with-change
13956 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13957 nil 'local))
13958 (unless org-sparse-tree-open-archived-trees
13959 (org-hide-archived-subtrees (point-min) (point-max)))
13960 (run-hooks 'org-occur-hook)
13961 (if (org-called-interactively-p 'interactive)
13962 (message "%d match(es) for regexp %s" cnt regexp))
13963 cnt))
13965 (defun org-occur-next-match (&optional n reset)
13966 "Function for `next-error-function' to find sparse tree matches.
13967 N is the number of matches to move, when negative move backwards.
13968 RESET is entirely ignored - this function always goes back to the
13969 starting point when no match is found."
13970 (let* ((limit (if (< n 0) (point-min) (point-max)))
13971 (search-func (if (< n 0)
13972 'previous-single-char-property-change
13973 'next-single-char-property-change))
13974 (n (abs n))
13975 (pos (point))
13977 (catch 'exit
13978 (while (setq p1 (funcall search-func (point) 'org-type))
13979 (when (equal p1 limit)
13980 (goto-char pos)
13981 (user-error "No more matches"))
13982 (when (equal (get-char-property p1 'org-type) 'org-occur)
13983 (setq n (1- n))
13984 (when (= n 0)
13985 (goto-char p1)
13986 (throw 'exit (point))))
13987 (goto-char p1))
13988 (goto-char p1)
13989 (user-error "No more matches"))))
13991 (defun org-show-context (&optional key)
13992 "Make sure point and context are visible.
13993 Optional argument KEY, when non-nil, is a symbol. See
13994 `org-show-context-detail' for allowed values and how much is to
13995 be shown."
13996 (org-show-set-visibility
13997 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13998 ((cdr (assq key org-show-context-detail)))
13999 (t (cdr (assq 'default org-show-context-detail))))))
14001 (defun org-show-set-visibility (detail)
14002 "Set visibility around point according to DETAIL.
14003 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
14004 `tree', `canonical' or t. See `org-show-context-detail' for more
14005 information."
14006 (unless (org-before-first-heading-p)
14007 ;; Show current heading and possibly its entry, following headline
14008 ;; or all children.
14009 (if (and (org-at-heading-p) (not (eq detail 'local)))
14010 (org-flag-heading nil)
14011 (org-show-entry)
14012 (org-with-limited-levels
14013 (case detail
14014 ((tree canonical t) (show-children))
14015 ((nil minimal ancestors))
14016 (t (save-excursion
14017 (outline-next-heading)
14018 (org-flag-heading nil))))))
14019 ;; Show all siblings.
14020 (when (eq detail 'lineage) (org-show-siblings))
14021 ;; Show ancestors, possibly with their children.
14022 (when (memq detail '(ancestors lineage tree canonical t))
14023 (save-excursion
14024 (while (org-up-heading-safe)
14025 (org-flag-heading nil)
14026 (when (memq detail '(canonical t)) (org-show-entry))
14027 (when (memq detail '(tree canonical t)) (show-children)))))))
14029 (defvar org-reveal-start-hook nil
14030 "Hook run before revealing a location.")
14032 (defun org-reveal (&optional siblings)
14033 "Show current entry, hierarchy above it, and the following headline.
14035 This can be used to show a consistent set of context around
14036 locations exposed with `org-show-context'.
14038 With optional argument SIBLINGS, on each level of the hierarchy all
14039 siblings are shown. This repairs the tree structure to what it would
14040 look like when opened with hierarchical calls to `org-cycle'.
14042 With double optional argument \\[universal-argument] \\[universal-argument], \
14043 go to the parent and show the
14044 entire tree."
14045 (interactive "P")
14046 (run-hooks 'org-reveal-start-hook)
14047 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14048 ((equal siblings '(16))
14049 (save-excursion
14050 (when (org-up-heading-safe)
14051 (org-show-subtree)
14052 (run-hook-with-args 'org-cycle-hook 'subtree))))
14053 (t (org-show-set-visibility 'lineage))))
14055 (defun org-highlight-new-match (beg end)
14056 "Highlight from BEG to END and mark the highlight is an occur headline."
14057 (let ((ov (make-overlay beg end)))
14058 (overlay-put ov 'face 'secondary-selection)
14059 (overlay-put ov 'org-type 'org-occur)
14060 (push ov org-occur-highlights)))
14062 (defun org-remove-occur-highlights (&optional beg end noremove)
14063 "Remove the occur highlights from the buffer.
14064 BEG and END are ignored. If NOREMOVE is nil, remove this function
14065 from the `before-change-functions' in the current buffer."
14066 (interactive)
14067 (unless org-inhibit-highlight-removal
14068 (mapc 'delete-overlay org-occur-highlights)
14069 (setq org-occur-highlights nil)
14070 (setq org-occur-parameters nil)
14071 (unless noremove
14072 (remove-hook 'before-change-functions
14073 'org-remove-occur-highlights 'local))))
14075 ;;;; Priorities
14077 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14078 "Regular expression matching the priority indicator.")
14080 (defvar org-remove-priority-next-time nil)
14082 (defun org-priority-up ()
14083 "Increase the priority of the current item."
14084 (interactive)
14085 (org-priority 'up))
14087 (defun org-priority-down ()
14088 "Decrease the priority of the current item."
14089 (interactive)
14090 (org-priority 'down))
14092 (defun org-priority (&optional action show)
14093 "Change the priority of an item.
14094 ACTION can be `set', `up', `down', or a character."
14095 (interactive "P")
14096 (if (equal action '(4))
14097 (org-show-priority)
14098 (unless org-enable-priority-commands
14099 (user-error "Priority commands are disabled"))
14100 (setq action (or action 'set))
14101 (let (current new news have remove)
14102 (save-excursion
14103 (org-back-to-heading t)
14104 (if (looking-at org-priority-regexp)
14105 (setq current (string-to-char (match-string 2))
14106 have t))
14107 (cond
14108 ((eq action 'remove)
14109 (setq remove t new ?\ ))
14110 ((or (eq action 'set)
14111 (if (featurep 'xemacs) (characterp action) (integerp action)))
14112 (if (not (eq action 'set))
14113 (setq new action)
14114 (message "Priority %c-%c, SPC to remove: "
14115 org-highest-priority org-lowest-priority)
14116 (save-match-data
14117 (setq new (read-char-exclusive))))
14118 (if (and (= (upcase org-highest-priority) org-highest-priority)
14119 (= (upcase org-lowest-priority) org-lowest-priority))
14120 (setq new (upcase new)))
14121 (cond ((equal new ?\ ) (setq remove t))
14122 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14123 (user-error "Priority must be between `%c' and `%c'"
14124 org-highest-priority org-lowest-priority))))
14125 ((eq action 'up)
14126 (setq new (if have
14127 (1- current) ; normal cycling
14128 ;; last priority was empty
14129 (if (eq last-command this-command)
14130 org-lowest-priority ; wrap around empty to lowest
14131 ;; default
14132 (if org-priority-start-cycle-with-default
14133 org-default-priority
14134 (1- org-default-priority))))))
14135 ((eq action 'down)
14136 (setq new (if have
14137 (1+ current) ; normal cycling
14138 ;; last priority was empty
14139 (if (eq last-command this-command)
14140 org-highest-priority ; wrap around empty to highest
14141 ;; default
14142 (if org-priority-start-cycle-with-default
14143 org-default-priority
14144 (1+ org-default-priority))))))
14145 (t (user-error "Invalid action")))
14146 (if (or (< (upcase new) org-highest-priority)
14147 (> (upcase new) org-lowest-priority))
14148 (if (and (memq action '(up down))
14149 (not have) (not (eq last-command this-command)))
14150 ;; `new' is from default priority
14151 (error
14152 "The default can not be set, see `org-default-priority' why")
14153 ;; normal cycling: `new' is beyond highest/lowest priority
14154 ;; and is wrapped around to the empty priority
14155 (setq remove t)))
14156 (setq news (format "%c" new))
14157 (if have
14158 (if remove
14159 (replace-match "" t t nil 1)
14160 (replace-match news t t nil 2))
14161 (if remove
14162 (user-error "No priority cookie found in line")
14163 (let ((case-fold-search nil))
14164 (looking-at org-todo-line-regexp))
14165 (if (match-end 2)
14166 (progn
14167 (goto-char (match-end 2))
14168 (insert " [#" news "]"))
14169 (goto-char (match-beginning 3))
14170 (insert "[#" news "] "))))
14171 (org-set-tags nil 'align))
14172 (if remove
14173 (message "Priority removed")
14174 (message "Priority of current item set to %s" news)))))
14176 (defun org-show-priority ()
14177 "Show the priority of the current item.
14178 This priority is composed of the main priority given with the [#A] cookies,
14179 and by additional input from the age of a schedules or deadline entry."
14180 (interactive)
14181 (let ((pri (if (eq major-mode 'org-agenda-mode)
14182 (org-get-at-bol 'priority)
14183 (save-excursion
14184 (save-match-data
14185 (beginning-of-line)
14186 (and (looking-at org-heading-regexp)
14187 (org-get-priority (match-string 0))))))))
14188 (message "Priority is %d" (if pri pri -1000))))
14190 (defun org-get-priority (s)
14191 "Find priority cookie and return priority."
14192 (save-match-data
14193 (if (functionp org-get-priority-function)
14194 (funcall org-get-priority-function)
14195 (if (not (string-match org-priority-regexp s))
14196 (* 1000 (- org-lowest-priority org-default-priority))
14197 (* 1000 (- org-lowest-priority
14198 (string-to-char (match-string 2 s))))))))
14200 ;;;; Tags
14202 (defvar org-agenda-archives-mode)
14203 (defvar org-map-continue-from nil
14204 "Position from where mapping should continue.
14205 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14207 (defvar org-scanner-tags nil
14208 "The current tag list while the tags scanner is running.")
14209 (defvar org-trust-scanner-tags nil
14210 "Should `org-get-tags-at' use the tags for the scanner.
14211 This is for internal dynamical scoping only.
14212 When this is non-nil, the function `org-get-tags-at' will return the value
14213 of `org-scanner-tags' instead of building the list by itself. This
14214 can lead to large speed-ups when the tags scanner is used in a file with
14215 many entries, and when the list of tags is retrieved, for example to
14216 obtain a list of properties. Building the tags list for each entry in such
14217 a file becomes an N^2 operation - but with this variable set, it scales
14218 as N.")
14220 (defun org-scan-tags (action matcher todo-only &optional start-level)
14221 "Scan headline tags with inheritance and produce output ACTION.
14223 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14224 or `agenda' to produce an entry list for an agenda view. It can also be
14225 a Lisp form or a function that should be called at each matched headline, in
14226 this case the return value is a list of all return values from these calls.
14228 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14229 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14230 only lines with a not-done TODO keyword are included in the output.
14231 This should be the same variable that was scoped into
14232 and set by `org-make-tags-matcher' when it constructed MATCHER.
14234 START-LEVEL can be a string with asterisks, reducing the scope to
14235 headlines matching this string."
14236 (require 'org-agenda)
14237 (let* ((re (concat "^"
14238 (if start-level
14239 ;; Get the correct level to match
14240 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14241 org-outline-regexp)
14242 " *\\(\\<\\("
14243 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14244 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14245 (props (list 'face 'default
14246 'done-face 'org-agenda-done
14247 'undone-face 'default
14248 'mouse-face 'highlight
14249 'org-not-done-regexp org-not-done-regexp
14250 'org-todo-regexp org-todo-regexp
14251 'org-complex-heading-regexp org-complex-heading-regexp
14252 'help-echo
14253 (format "mouse-2 or RET jump to org file %s"
14254 (abbreviate-file-name
14255 (or (buffer-file-name (buffer-base-buffer))
14256 (buffer-name (buffer-base-buffer)))))))
14257 (org-map-continue-from nil)
14258 lspos tags tags-list
14259 (tags-alist (list (cons 0 org-file-tags)))
14260 (llast 0) rtn rtn1 level category i txt
14261 todo marker entry priority
14262 ts-date ts-date-type ts-date-pair)
14263 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14264 (setq action (list 'lambda nil action)))
14265 (save-excursion
14266 (goto-char (point-min))
14267 (when (eq action 'sparse-tree)
14268 (org-overview)
14269 (org-remove-occur-highlights))
14270 (while (let (case-fold-search)
14271 (re-search-forward re nil t))
14272 (setq org-map-continue-from nil)
14273 (catch :skip
14274 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14275 tags (if (match-end 4) (org-match-string-no-properties 4)))
14276 (goto-char (setq lspos (match-beginning 0)))
14277 (setq level (org-reduced-level (org-outline-level))
14278 category (org-get-category))
14279 (when (eq action 'agenda)
14280 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14281 ts-date (car ts-date-pair)
14282 ts-date-type (cdr ts-date-pair)))
14283 (setq i llast llast level)
14284 ;; remove tag lists from same and sublevels
14285 (while (>= i level)
14286 (when (setq entry (assoc i tags-alist))
14287 (setq tags-alist (delete entry tags-alist)))
14288 (setq i (1- i)))
14289 ;; add the next tags
14290 (when tags
14291 (setq tags (org-split-string tags ":")
14292 tags-alist
14293 (cons (cons level tags) tags-alist)))
14294 ;; compile tags for current headline
14295 (setq tags-list
14296 (if org-use-tag-inheritance
14297 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14298 tags)
14299 org-scanner-tags tags-list)
14300 (when org-use-tag-inheritance
14301 (setcdr (car tags-alist)
14302 (mapcar (lambda (x)
14303 (setq x (copy-sequence x))
14304 (org-add-prop-inherited x))
14305 (cdar tags-alist))))
14306 (when (and tags org-use-tag-inheritance
14307 (or (not (eq t org-use-tag-inheritance))
14308 org-tags-exclude-from-inheritance))
14309 ;; selective inheritance, remove uninherited ones
14310 (setcdr (car tags-alist)
14311 (org-remove-uninherited-tags (cdar tags-alist))))
14312 (when (and
14314 ;; eval matcher only when the todo condition is OK
14315 (and (or (not todo-only) (member todo org-not-done-keywords))
14316 (let ((case-fold-search t) (org-trust-scanner-tags t))
14317 (eval matcher)))
14319 ;; Call the skipper, but return t if it does not skip,
14320 ;; so that the `and' form continues evaluating
14321 (progn
14322 (unless (eq action 'sparse-tree) (org-agenda-skip))
14325 ;; Check if timestamps are deselecting this entry
14326 (or (not todo-only)
14327 (and (member todo org-not-done-keywords)
14328 (or (not org-agenda-tags-todo-honor-ignore-options)
14329 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14331 ;; select this headline
14332 (cond
14333 ((eq action 'sparse-tree)
14334 (and org-highlight-sparse-tree-matches
14335 (org-get-heading) (match-end 0)
14336 (org-highlight-new-match
14337 (match-beginning 1) (match-end 1)))
14338 (org-show-context 'tags-tree))
14339 ((eq action 'agenda)
14340 (setq txt (org-agenda-format-item
14342 (concat
14343 (if (eq org-tags-match-list-sublevels 'indented)
14344 (make-string (1- level) ?.) "")
14345 (org-get-heading))
14346 (make-string level ?\s)
14347 category
14348 tags-list)
14349 priority (org-get-priority txt))
14350 (goto-char lspos)
14351 (setq marker (org-agenda-new-marker))
14352 (org-add-props txt props
14353 'org-marker marker 'org-hd-marker marker 'org-category category
14354 'todo-state todo
14355 'ts-date ts-date
14356 'priority priority
14357 'type (concat "tagsmatch" ts-date-type))
14358 (push txt rtn))
14359 ((functionp action)
14360 (setq org-map-continue-from nil)
14361 (save-excursion
14362 (setq rtn1 (funcall action))
14363 (push rtn1 rtn)))
14364 (t (user-error "Invalid action")))
14366 ;; if we are to skip sublevels, jump to end of subtree
14367 (unless org-tags-match-list-sublevels
14368 (org-end-of-subtree t)
14369 (backward-char 1))))
14370 ;; Get the correct position from where to continue
14371 (if org-map-continue-from
14372 (goto-char org-map-continue-from)
14373 (and (= (point) lspos) (end-of-line 1)))))
14374 (when (and (eq action 'sparse-tree)
14375 (not org-sparse-tree-open-archived-trees))
14376 (org-hide-archived-subtrees (point-min) (point-max)))
14377 (nreverse rtn)))
14379 (defun org-remove-uninherited-tags (tags)
14380 "Remove all tags that are not inherited from the list TAGS."
14381 (cond
14382 ((eq org-use-tag-inheritance t)
14383 (if org-tags-exclude-from-inheritance
14384 (org-delete-all org-tags-exclude-from-inheritance tags)
14385 tags))
14386 ((not org-use-tag-inheritance) nil)
14387 ((stringp org-use-tag-inheritance)
14388 (delq nil (mapcar
14389 (lambda (x)
14390 (if (and (string-match org-use-tag-inheritance x)
14391 (not (member x org-tags-exclude-from-inheritance)))
14392 x nil))
14393 tags)))
14394 ((listp org-use-tag-inheritance)
14395 (delq nil (mapcar
14396 (lambda (x)
14397 (if (member x org-use-tag-inheritance) x nil))
14398 tags)))))
14400 (defun org-match-sparse-tree (&optional todo-only match)
14401 "Create a sparse tree according to tags string MATCH.
14402 MATCH can contain positive and negative selection of tags, like
14403 \"+WORK+URGENT-WITHBOSS\".
14404 If optional argument TODO-ONLY is non-nil, only select lines that are
14405 also TODO lines."
14406 (interactive "P")
14407 (org-agenda-prepare-buffers (list (current-buffer)))
14408 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14410 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14412 (defvar org-cached-props nil)
14413 (defun org-cached-entry-get (pom property)
14414 (if (or (eq t org-use-property-inheritance)
14415 (and (stringp org-use-property-inheritance)
14416 (let ((case-fold-search t))
14417 (org-string-match-p org-use-property-inheritance property)))
14418 (and (listp org-use-property-inheritance)
14419 (member-ignore-case property org-use-property-inheritance)))
14420 ;; Caching is not possible, check it directly.
14421 (org-entry-get pom property 'inherit)
14422 ;; Get all properties, so we can do complicated checks easily.
14423 (cdr (assoc-string property
14424 (or org-cached-props
14425 (setq org-cached-props (org-entry-properties pom)))
14426 t))))
14428 (defun org-global-tags-completion-table (&optional files)
14429 "Return the list of all tags in all agenda buffer/files.
14430 Optional FILES argument is a list of files which can be used
14431 instead of the agenda files."
14432 (save-excursion
14433 (org-uniquify
14434 (delq nil
14435 (apply 'append
14436 (mapcar
14437 (lambda (file)
14438 (set-buffer (find-file-noselect file))
14439 (append (org-get-buffer-tags)
14440 (mapcar (lambda (x) (if (stringp (car-safe x))
14441 (list (car-safe x)) nil))
14442 org-tag-alist)))
14443 (if (and files (car files))
14444 files
14445 (org-agenda-files))))))))
14447 (defun org-make-tags-matcher (match)
14448 "Create the TAGS/TODO matcher form for the selection string MATCH.
14450 The variable `todo-only' is scoped dynamically into this function.
14451 It will be set to t if the matcher restricts matching to TODO entries,
14452 otherwise will not be touched.
14454 Returns a cons of the selection string MATCH and the constructed
14455 lisp form implementing the matcher. The matcher is to be evaluated
14456 at an Org entry, with point on the headline, and returns t if the
14457 entry matches the selection string MATCH. The returned lisp form
14458 references two variables with information about the entry, which
14459 must be bound around the form's evaluation: todo, the TODO keyword
14460 at the entry (or nil of none); and tags-list, the list of all tags
14461 at the entry including inherited ones. Additionally, the category
14462 of the entry (if any) must be specified as the text property
14463 `org-category' on the headline.
14465 See also `org-scan-tags'.
14467 (declare (special todo-only))
14468 (unless (boundp 'todo-only)
14469 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14470 (unless match
14471 ;; Get a new match request, with completion against the global
14472 ;; tags table and the local tags in current buffer
14473 (let ((org-last-tags-completion-table
14474 (org-uniquify
14475 (delq nil (append (org-get-buffer-tags)
14476 (org-global-tags-completion-table))))))
14477 (setq match (org-completing-read-no-i
14478 "Match: " 'org-tags-completion-function nil nil nil
14479 'org-tags-history))))
14481 ;; Parse the string and create a lisp form
14482 (let ((match0 match)
14483 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14484 minus tag mm
14485 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14486 orterms term orlist re-p str-p level-p level-op time-p
14487 prop-p pn pv po gv rest (start 0) (ss 0))
14488 ;; Expand group tags
14489 (setq match (org-tags-expand match))
14491 ;; Check if there is a TODO part of this match, which would be the
14492 ;; part after a "/". TO make sure that this slash is not part of
14493 ;; a property value to be matched against, we also check that there
14494 ;; is no " after that slash.
14495 ;; First, find the last slash
14496 (while (string-match "/+" match ss)
14497 (setq start (match-beginning 0) ss (match-end 0)))
14498 (if (and (string-match "/+" match start)
14499 (not (save-match-data (string-match "\"" match start))))
14500 ;; match contains also a todo-matching request
14501 (progn
14502 (setq tagsmatch (substring match 0 (match-beginning 0))
14503 todomatch (substring match (match-end 0)))
14504 (if (string-match "^!" todomatch)
14505 (setq todo-only t todomatch (substring todomatch 1)))
14506 (if (string-match "^\\s-*$" todomatch)
14507 (setq todomatch nil)))
14508 ;; only matching tags
14509 (setq tagsmatch match todomatch nil))
14511 ;; Make the tags matcher
14512 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14513 (setq tagsmatcher t)
14514 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14515 (while (setq term (pop orterms))
14516 (while (and (equal (substring term -1) "\\") orterms)
14517 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14518 (while (string-match re term)
14519 (setq rest (substring term (match-end 0))
14520 minus (and (match-end 1)
14521 (equal (match-string 1 term) "-"))
14522 tag (save-match-data (replace-regexp-in-string
14523 "\\\\-" "-"
14524 (match-string 2 term)))
14525 re-p (equal (string-to-char tag) ?{)
14526 level-p (match-end 4)
14527 prop-p (match-end 5)
14528 mm (cond
14529 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14530 (level-p
14531 (setq level-op (org-op-to-function (match-string 3 term)))
14532 `(,level-op level ,(string-to-number
14533 (match-string 4 term))))
14534 (prop-p
14535 (setq pn (match-string 5 term)
14536 po (match-string 6 term)
14537 pv (match-string 7 term)
14538 re-p (equal (string-to-char pv) ?{)
14539 str-p (equal (string-to-char pv) ?\")
14540 time-p (save-match-data
14541 (string-match "^\"[[<].*[]>]\"$" pv))
14542 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14543 (if time-p (setq pv (org-matcher-time pv)))
14544 (setq po (org-op-to-function po (if time-p 'time str-p)))
14545 (cond
14546 ((equal pn "CATEGORY")
14547 (setq gv '(get-text-property (point) 'org-category)))
14548 ((equal pn "TODO")
14549 (setq gv 'todo))
14551 (setq gv `(org-cached-entry-get nil ,pn))))
14552 (if re-p
14553 (if (eq po 'org<>)
14554 `(not (string-match ,pv (or ,gv "")))
14555 `(string-match ,pv (or ,gv "")))
14556 (if str-p
14557 `(,po (or ,gv "") ,pv)
14558 `(,po (string-to-number (or ,gv ""))
14559 ,(string-to-number pv) ))))
14560 (t `(member ,tag tags-list)))
14561 mm (if minus (list 'not mm) mm)
14562 term rest)
14563 (push mm tagsmatcher))
14564 (push (if (> (length tagsmatcher) 1)
14565 (cons 'and tagsmatcher)
14566 (car tagsmatcher))
14567 orlist)
14568 (setq tagsmatcher nil))
14569 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14570 (setq tagsmatcher
14571 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14572 ;; Make the todo matcher
14573 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14574 (setq todomatcher t)
14575 (setq orterms (org-split-string todomatch "|") orlist nil)
14576 (dolist (term orterms)
14577 (while (string-match re term)
14578 (setq minus (and (match-end 1)
14579 (equal (match-string 1 term) "-"))
14580 kwd (match-string 2 term)
14581 re-p (equal (string-to-char kwd) ?{)
14582 term (substring term (match-end 0))
14583 mm (if re-p
14584 `(string-match ,(substring kwd 1 -1) todo)
14585 (list 'equal 'todo kwd))
14586 mm (if minus (list 'not mm) mm))
14587 (push mm todomatcher))
14588 (push (if (> (length todomatcher) 1)
14589 (cons 'and todomatcher)
14590 (car todomatcher))
14591 orlist)
14592 (setq todomatcher nil))
14593 (setq todomatcher (if (> (length orlist) 1)
14594 (cons 'or orlist) (car orlist))))
14596 ;; Return the string and lisp forms of the matcher
14597 (setq matcher (if todomatcher
14598 (list 'and tagsmatcher todomatcher)
14599 tagsmatcher))
14600 (when todo-only
14601 (setq matcher (list 'and '(member todo org-not-done-keywords)
14602 matcher)))
14603 (cons match0 matcher)))
14605 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14606 "Expand group tags in MATCH.
14608 This replaces every group tag in MATCH with a regexp tag search.
14609 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14610 will be replaced like this:
14612 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14613 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14614 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14616 Replacing by a regexp preserves the structure of the match.
14617 E.g., this expansion
14619 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14621 will match anything tagged with \"Lab\" and \"Home\", or tagged
14622 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14624 A group tag in MATCH can contain regular expressions of its own.
14625 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14626 will be replaced like this:
14628 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14630 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14631 assumed to be a single group tag, and the function will return
14632 the list of tags in this group.
14634 When DOWNCASE is non-nil, expand downcased TAGS."
14635 (if org-group-tags
14636 (let* ((case-fold-search t)
14637 (stable org-mode-syntax-table)
14638 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14639 (taggroups (if downcased
14640 (mapcar (lambda (tg) (mapcar #'downcase tg))
14641 taggroups)
14642 taggroups))
14643 (taggroups-keys (mapcar #'car taggroups))
14644 (return-match (if downcased (downcase match) match))
14645 (count 0)
14646 (work-already-expanded tags-already-expanded)
14647 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14648 ;; @ and _ are allowed as word-components in tags.
14649 (modify-syntax-entry ?@ "w" stable)
14650 (modify-syntax-entry ?_ "w" stable)
14651 ;; Temporarily replace regexp-expressions in the match-expression.
14652 (while (string-match "{.+?}" return-match)
14653 (incf count)
14654 (push (match-string 0 return-match) regexps-in-match)
14655 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14656 (while (and taggroups-keys
14657 (with-syntax-table stable
14658 (string-match
14659 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14660 (regexp-opt taggroups-keys) "\\>\\)")
14661 return-match)))
14662 (let* ((dir (match-string 1 return-match))
14663 (tag (match-string 2 return-match))
14664 (tag (if downcased (downcase tag) tag)))
14665 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14666 (member tag work-already-expanded))
14667 (setq tags-in-group (assoc tag taggroups))
14668 (push tag work-already-expanded)
14669 ;; Recursively expand each tag in the group, if the tag hasn't
14670 ;; already been expanded. Restore the match-data after all recursive calls.
14671 (save-match-data
14672 (let (tags-expanded)
14673 (dolist (x (cdr tags-in-group))
14674 (if (and (member x taggroups-keys)
14675 (not (member x work-already-expanded)))
14676 (setq tags-expanded
14677 (delete-dups
14678 (append
14679 (org-tags-expand x t downcased
14680 work-already-expanded)
14681 tags-expanded)))
14682 (setq tags-expanded
14683 (append (list x) tags-expanded)))
14684 (setq work-already-expanded
14685 (delete-dups
14686 (append tags-expanded
14687 work-already-expanded))))
14688 (setq tags-in-group
14689 (delete-dups (cons (car tags-in-group)
14690 tags-expanded)))))
14691 ;; Filter tag-regexps from tags.
14692 (setq regexp-in-group-escaped
14693 (delq nil (mapcar (lambda (x)
14694 (if (stringp x)
14695 (and (equal "{" (substring x 0 1))
14696 (equal "}" (substring x -1))
14699 tags-in-group))
14700 regexp-in-group
14701 (mapcar (lambda (x)
14702 (substring x 1 -1))
14703 regexp-in-group-escaped)
14704 tags-in-group
14705 (delq nil (mapcar (lambda (x)
14706 (if (stringp x)
14707 (and (not (equal "{" (substring x 0 1)))
14708 (not (equal "}" (substring x -1)))
14711 tags-in-group)))
14712 ;; If single-as-list, do no more in the while-loop.
14713 (if (not single-as-list)
14714 (progn
14715 (when regexp-in-group
14716 (setq regexp-in-group
14717 (concat "\\|"
14718 (mapconcat 'identity regexp-in-group
14719 "\\|"))))
14720 (setq tags-in-group
14721 (concat dir
14722 "{\\<"
14723 (regexp-opt tags-in-group)
14724 "\\>"
14725 regexp-in-group
14726 "}"))
14727 (when (stringp tags-in-group)
14728 (org-add-props tags-in-group '(grouptag t)))
14729 (setq return-match
14730 (replace-match tags-in-group t t return-match)))
14731 (setq tags-in-group
14732 (append regexp-in-group-escaped tags-in-group))))
14733 (setq taggroups-keys (delete tag taggroups-keys))))
14734 ;; Add the regular expressions back into the match-expression again.
14735 (while regexps-in-match
14736 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14737 (pop regexps-in-match)
14738 return-match t t))
14739 (decf count))
14740 (if single-as-list
14741 (if tags-in-group tags-in-group (list return-match))
14742 return-match))
14743 (if single-as-list
14744 (list (if downcased (downcase match) match))
14745 match)))
14747 (defun org-op-to-function (op &optional stringp)
14748 "Turn an operator into the appropriate function."
14749 (setq op
14750 (cond
14751 ((equal op "<" ) '(< string< org-time<))
14752 ((equal op ">" ) '(> org-string> org-time>))
14753 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14754 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14755 ((member op '("=" "==")) '(= string= org-time=))
14756 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14757 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14759 (defun org<> (a b) (not (= a b)))
14760 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14761 (defun org-string>= (a b) (not (string< a b)))
14762 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14763 (defun org-string<> (a b) (not (string= a b)))
14764 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14765 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14766 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14767 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14768 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14769 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14770 (defun org-2ft (s)
14771 "Convert S to a floating point time.
14772 If S is already a number, just return it. If it is a string, parse
14773 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14774 (cond
14775 ((numberp s) s)
14776 ((stringp s)
14777 (condition-case nil
14778 (float-time (apply 'encode-time (org-parse-time-string s)))
14779 (error 0.)))
14780 (t 0.)))
14782 (defun org-time-today ()
14783 "Time in seconds today at 0:00.
14784 Returns the float number of seconds since the beginning of the
14785 epoch to the beginning of today (00:00)."
14786 (float-time (apply 'encode-time
14787 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14789 (defun org-matcher-time (s)
14790 "Interpret a time comparison value."
14791 (save-match-data
14792 (cond
14793 ((string= s "<now>") (float-time))
14794 ((string= s "<today>") (org-time-today))
14795 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14796 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14797 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14798 (+ (org-time-today)
14799 (* (string-to-number (match-string 1 s))
14800 (cdr (assoc (match-string 2 s)
14801 '(("d" . 86400.0) ("w" . 604800.0)
14802 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14803 (t (org-2ft s)))))
14805 (defun org-match-any-p (re list)
14806 "Does re match any element of list?"
14807 (setq list (mapcar (lambda (x) (string-match re x)) list))
14808 (delq nil list))
14810 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14811 (defvar org-tags-overlay (make-overlay 1 1))
14812 (org-detach-overlay org-tags-overlay)
14814 (defun org-get-local-tags-at (&optional pos)
14815 "Get a list of tags defined in the current headline."
14816 (org-get-tags-at pos 'local))
14818 (defun org-get-local-tags ()
14819 "Get a list of tags defined in the current headline."
14820 (org-get-tags-at nil 'local))
14822 (defun org-get-tags-at (&optional pos local)
14823 "Get a list of all headline tags applicable at POS.
14824 POS defaults to point. If tags are inherited, the list contains
14825 the targets in the same sequence as the headlines appear, i.e.
14826 the tags of the current headline come last.
14827 When LOCAL is non-nil, only return tags from the current headline,
14828 ignore inherited ones."
14829 (interactive)
14830 (if (and org-trust-scanner-tags
14831 (or (not pos) (equal pos (point)))
14832 (not local))
14833 org-scanner-tags
14834 (let (tags ltags lastpos parent)
14835 (save-excursion
14836 (save-restriction
14837 (widen)
14838 (goto-char (or pos (point)))
14839 (save-match-data
14840 (catch 'done
14841 (condition-case nil
14842 (progn
14843 (org-back-to-heading t)
14844 (while (not (equal lastpos (point)))
14845 (setq lastpos (point))
14846 (when (looking-at
14847 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14848 (setq ltags (org-split-string
14849 (org-match-string-no-properties 1) ":"))
14850 (when parent
14851 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14852 (setq tags (append
14853 (if parent
14854 (org-remove-uninherited-tags ltags)
14855 ltags)
14856 tags)))
14857 (or org-use-tag-inheritance (throw 'done t))
14858 (if local (throw 'done t))
14859 (or (org-up-heading-safe) (error nil))
14860 (setq parent t)))
14861 (error nil)))))
14862 (if local
14863 tags
14864 (reverse (delete-dups
14865 (reverse (append
14866 (org-remove-uninherited-tags
14867 org-file-tags)
14868 tags)))))))))
14870 (defun org-add-prop-inherited (s)
14871 (add-text-properties 0 (length s) '(inherited t) s)
14874 (defun org-toggle-tag (tag &optional onoff)
14875 "Toggle the tag TAG for the current line.
14876 If ONOFF is `on' or `off', don't toggle but set to this state."
14877 (let (res current)
14878 (save-excursion
14879 (org-back-to-heading t)
14880 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14881 (point-at-eol) t)
14882 (progn
14883 (setq current (match-string 1))
14884 (replace-match ""))
14885 (setq current ""))
14886 (setq current (nreverse (org-split-string current ":")))
14887 (cond
14888 ((eq onoff 'on)
14889 (setq res t)
14890 (or (member tag current) (push tag current)))
14891 ((eq onoff 'off)
14892 (or (not (member tag current)) (setq current (delete tag current))))
14893 (t (if (member tag current)
14894 (setq current (delete tag current))
14895 (setq res t)
14896 (push tag current))))
14897 (end-of-line 1)
14898 (if current
14899 (progn
14900 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14901 (org-set-tags nil t))
14902 (delete-horizontal-space))
14903 (run-hooks 'org-after-tags-change-hook))
14904 res))
14906 (defun org-align-tags-here (to-col)
14907 ;; Assumes that this is a headline
14908 "Align tags on the current headline to TO-COL."
14909 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14910 (beginning-of-line 1)
14911 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14912 (< pos (match-beginning 2)))
14913 (progn
14914 (setq tags-l (- (match-end 2) (match-beginning 2)))
14915 (goto-char (match-beginning 1))
14916 (insert " ")
14917 (delete-region (point) (1+ (match-beginning 2)))
14918 (setq ncol (max (current-column)
14919 (1+ col)
14920 (if (> to-col 0)
14921 to-col
14922 (- (abs to-col) tags-l))))
14923 (setq p (point))
14924 (insert (make-string (- ncol (current-column)) ?\ ))
14925 (setq ncol (current-column))
14926 (when indent-tabs-mode (tabify p (point-at-eol)))
14927 (org-move-to-column (min ncol col)))
14928 (goto-char pos))))
14930 (defun org-set-tags-command (&optional arg just-align)
14931 "Call the set-tags command for the current entry."
14932 (interactive "P")
14933 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14934 (org-set-tags arg just-align)
14935 (save-excursion
14936 (unless (and (org-region-active-p)
14937 org-loop-over-headlines-in-active-region)
14938 (org-back-to-heading t))
14939 (org-set-tags arg just-align))))
14941 (defun org-set-tags-to (data)
14942 "Set the tags of the current entry to DATA, replacing the current tags.
14943 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14944 If DATA is nil or the empty string, any tags will be removed."
14945 (interactive "sTags: ")
14946 (setq data
14947 (cond
14948 ((eq data nil) "")
14949 ((equal data "") "")
14950 ((stringp data)
14951 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14952 ":"))
14953 ((listp data)
14954 (concat ":" (mapconcat 'identity data ":") ":"))))
14955 (when data
14956 (save-excursion
14957 (org-back-to-heading t)
14958 (when (looking-at org-complex-heading-regexp)
14959 (if (match-end 5)
14960 (progn
14961 (goto-char (match-beginning 5))
14962 (insert data)
14963 (delete-region (point) (point-at-eol))
14964 (org-set-tags nil 'align))
14965 (goto-char (point-at-eol))
14966 (insert " " data)
14967 (org-set-tags nil 'align)))
14968 (beginning-of-line 1)
14969 (if (looking-at ".*?\\([ \t]+\\)$")
14970 (delete-region (match-beginning 1) (match-end 1))))))
14972 (defun org-align-all-tags ()
14973 "Align the tags i all headings."
14974 (interactive)
14975 (save-excursion
14976 (or (ignore-errors (org-back-to-heading t))
14977 (outline-next-heading))
14978 (if (org-at-heading-p)
14979 (org-set-tags t)
14980 (message "No headings"))))
14982 (defvar org-indent-indentation-per-level)
14983 (defun org-set-tags (&optional arg just-align)
14984 "Set the tags for the current headline.
14985 With prefix ARG, realign all tags in headings in the current buffer.
14986 When JUST-ALIGN is non-nil, only align tags."
14987 (interactive "P")
14988 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14989 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14990 'region-start-level
14991 'region))
14992 org-loop-over-headlines-in-active-region)
14993 (org-map-entries
14994 ;; We don't use ARG and JUST-ALIGN here because these args
14995 ;; are not useful when looping over headlines.
14996 #'org-set-tags
14997 org-loop-over-headlines-in-active-region
14999 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
15000 (let ((org-setting-tags t))
15001 (if arg
15002 (save-excursion
15003 (goto-char (point-min))
15004 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
15005 (while (re-search-forward org-outline-regexp-bol nil t)
15006 (org-set-tags nil t)
15007 (end-of-line)))
15008 (message "All tags realigned to column %d" org-tags-column))
15009 (let* ((current (org-get-tags-string))
15010 (col (current-column))
15011 (tags
15012 (if just-align current
15013 ;; Get a new set of tags from the user.
15014 (save-excursion
15015 (let* ((table
15016 (setq
15017 org-last-tags-completion-table
15018 (append
15019 org-tag-persistent-alist
15020 (or org-tag-alist (org-get-buffer-tags))
15021 (and
15022 org-complete-tags-always-offer-all-agenda-tags
15023 (org-global-tags-completion-table
15024 (org-agenda-files))))))
15025 (current-tags (org-split-string current ":"))
15026 (inherited-tags
15027 (nreverse (nthcdr (length current-tags)
15028 (nreverse (org-get-tags-at))))))
15029 (replace-regexp-in-string
15030 "\\([-+&]+\\|,\\)"
15032 (if (or (eq t org-use-fast-tag-selection)
15033 (and org-use-fast-tag-selection
15034 (delq nil (mapcar #'cdr table))))
15035 (org-fast-tag-selection
15036 current-tags inherited-tags table
15037 (and org-fast-tag-selection-include-todo
15038 org-todo-key-alist))
15039 (let ((org-add-colon-after-tag-completion
15040 (< 1 (length table))))
15041 (org-trim
15042 (completing-read
15043 "Tags: "
15044 #'org-tags-completion-function
15045 nil nil current 'org-tags-history))))))))))
15047 (when org-tags-sort-function
15048 (setq tags
15049 (mapconcat
15050 #'identity
15051 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15052 org-tags-sort-function)
15053 ":")))
15055 (if (not (org-string-nw-p tags)) (setq tags "")
15056 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15057 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15059 ;; Insert new tags at the correct column
15060 (beginning-of-line)
15061 (let ((level (if (looking-at org-outline-regexp)
15062 (- (match-end 0) (point) 1)
15063 1)))
15064 (cond
15065 ((and (equal current "") (equal tags "")))
15066 ((re-search-forward
15067 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15068 (line-end-position)
15070 (if (equal tags "") (replace-match "" t t)
15071 (goto-char (match-beginning 0))
15072 (let* ((c0 (current-column))
15073 ;; Compute offset for the case of org-indent-mode
15074 ;; active.
15075 (di (if (org-bound-and-true-p org-indent-mode)
15076 (* (1- org-indent-indentation-per-level)
15077 (1- level))
15079 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15080 (tc (+ org-tags-column
15081 (if (> org-tags-column 0) (- di) di)))
15082 (c1 (max (1+ c0)
15083 (if (> tc 0) tc
15084 (- (- tc) (string-width tags)))))
15085 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15086 (replace-match rpl t t)
15087 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15088 (tabify p0 (point))))))
15089 (t (error "Tags alignment failed"))))
15090 (org-move-to-column col))
15091 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15093 (defun org-change-tag-in-region (beg end tag off)
15094 "Add or remove TAG for each entry in the region.
15095 This works in the agenda, and also in an org-mode buffer."
15096 (interactive
15097 (list (region-beginning) (region-end)
15098 (let ((org-last-tags-completion-table
15099 (if (derived-mode-p 'org-mode)
15100 (org-uniquify
15101 (delq nil (append (org-get-buffer-tags)
15102 (org-global-tags-completion-table))))
15103 (org-global-tags-completion-table))))
15104 (org-icompleting-read
15105 "Tag: " 'org-tags-completion-function nil nil nil
15106 'org-tags-history))
15107 (progn
15108 (message "[s]et or [r]emove? ")
15109 (equal (read-char-exclusive) ?r))))
15110 (if (fboundp 'deactivate-mark) (deactivate-mark))
15111 (let ((agendap (equal major-mode 'org-agenda-mode))
15112 l1 l2 m buf pos newhead (cnt 0))
15113 (goto-char end)
15114 (setq l2 (1- (org-current-line)))
15115 (goto-char beg)
15116 (setq l1 (org-current-line))
15117 (loop for l from l1 to l2 do
15118 (org-goto-line l)
15119 (setq m (get-text-property (point) 'org-hd-marker))
15120 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15121 (and agendap m))
15122 (setq buf (if agendap (marker-buffer m) (current-buffer))
15123 pos (if agendap m (point)))
15124 (with-current-buffer buf
15125 (save-excursion
15126 (save-restriction
15127 (goto-char pos)
15128 (setq cnt (1+ cnt))
15129 (org-toggle-tag tag (if off 'off 'on))
15130 (setq newhead (org-get-heading)))))
15131 (and agendap (org-agenda-change-all-lines newhead m))))
15132 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15134 (defun org-tags-completion-function (string predicate &optional flag)
15135 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15136 (confirm (lambda (x) (stringp (car x)))))
15137 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15138 (setq s1 (match-string 1 string)
15139 s2 (match-string 2 string))
15140 (setq s1 "" s2 string))
15141 (cond
15142 ((eq flag nil)
15143 ;; try completion
15144 (setq rtn (try-completion s2 ctable confirm))
15145 (if (stringp rtn)
15146 (setq rtn
15147 (concat s1 s2 (substring rtn (length s2))
15148 (if (and org-add-colon-after-tag-completion
15149 (assoc rtn ctable))
15150 ":" ""))))
15151 rtn)
15152 ((eq flag t)
15153 ;; all-completions
15154 (all-completions s2 ctable confirm))
15155 ((eq flag 'lambda)
15156 ;; exact match?
15157 (assoc s2 ctable)))))
15159 (defun org-fast-tag-insert (kwd tags face &optional end)
15160 "Insert KDW, and the TAGS, the latter with face FACE.
15161 Also insert END."
15162 (insert (format "%-12s" (concat kwd ":"))
15163 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15164 (or end "")))
15166 (defun org-fast-tag-show-exit (flag)
15167 (save-excursion
15168 (org-goto-line 3)
15169 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15170 (replace-match ""))
15171 (when flag
15172 (end-of-line 1)
15173 (org-move-to-column (- (window-width) 19) t)
15174 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15176 (defun org-set-current-tags-overlay (current prefix)
15177 "Add an overlay to CURRENT tag with PREFIX."
15178 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15179 (if (featurep 'xemacs)
15180 (org-overlay-display org-tags-overlay (concat prefix s)
15181 'secondary-selection)
15182 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15183 (org-overlay-display org-tags-overlay (concat prefix s)))))
15185 (defvar org-last-tag-selection-key nil)
15186 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15187 "Fast tag selection with single keys.
15188 CURRENT is the current list of tags in the headline, INHERITED is the
15189 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15190 possibly with grouping information. TODO-TABLE is a similar table with
15191 TODO keywords, should these have keys assigned to them.
15192 If the keys are nil, a-z are automatically assigned.
15193 Returns the new tags string, or nil to not change the current settings."
15194 (let* ((fulltable (append table todo-table))
15195 (maxlen (apply 'max (mapcar
15196 (lambda (x)
15197 (if (stringp (car x)) (string-width (car x)) 0))
15198 fulltable)))
15199 (buf (current-buffer))
15200 (expert (eq org-fast-tag-selection-single-key 'expert))
15201 (buffer-tags nil)
15202 (fwidth (+ maxlen 3 1 3))
15203 (ncol (/ (- (window-width) 4) fwidth))
15204 (i-face 'org-done)
15205 (c-face 'org-todo)
15206 tg cnt e c char c1 c2 ntable tbl rtn
15207 ov-start ov-end ov-prefix
15208 (exit-after-next org-fast-tag-selection-single-key)
15209 (done-keywords org-done-keywords)
15210 groups ingroup intaggroup)
15211 (save-excursion
15212 (beginning-of-line 1)
15213 (if (looking-at
15214 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15215 (setq ov-start (match-beginning 1)
15216 ov-end (match-end 1)
15217 ov-prefix "")
15218 (setq ov-start (1- (point-at-eol))
15219 ov-end (1+ ov-start))
15220 (skip-chars-forward "^\n\r")
15221 (setq ov-prefix
15222 (concat
15223 (buffer-substring (1- (point)) (point))
15224 (if (> (current-column) org-tags-column)
15226 (make-string (- org-tags-column (current-column)) ?\ ))))))
15227 (move-overlay org-tags-overlay ov-start ov-end)
15228 (save-window-excursion
15229 (if expert
15230 (set-buffer (get-buffer-create " *Org tags*"))
15231 (delete-other-windows)
15232 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15233 (org-switch-to-buffer-other-window " *Org tags*"))
15234 (erase-buffer)
15235 (org-set-local 'org-done-keywords done-keywords)
15236 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15237 (org-fast-tag-insert "Current" current c-face "\n\n")
15238 (org-fast-tag-show-exit exit-after-next)
15239 (org-set-current-tags-overlay current ov-prefix)
15240 (setq tbl fulltable char ?a cnt 0)
15241 (while (setq e (pop tbl))
15242 (cond
15243 ((eq (car e) :startgroup)
15244 (push '() groups) (setq ingroup t)
15245 (unless (zerop cnt)
15246 (setq cnt 0)
15247 (insert "\n"))
15248 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15249 ((eq (car e) :endgroup)
15250 (setq ingroup nil cnt 0)
15251 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15252 ((eq (car e) :startgrouptag)
15253 (setq intaggroup t)
15254 (unless (zerop cnt)
15255 (setq cnt 0)
15256 (insert "\n"))
15257 (insert "[ "))
15258 ((eq (car e) :endgrouptag)
15259 (setq intaggroup nil cnt 0)
15260 (insert "]\n"))
15261 ((equal e '(:newline))
15262 (unless (zerop cnt)
15263 (setq cnt 0)
15264 (insert "\n")
15265 (setq e (car tbl))
15266 (while (equal (car tbl) '(:newline))
15267 (insert "\n")
15268 (setq tbl (cdr tbl)))))
15269 ((equal e '(:grouptags)) (insert " : "))
15271 (setq tg (copy-sequence (car e)) c2 nil)
15272 (if (cdr e)
15273 (setq c (cdr e))
15274 ;; automatically assign a character.
15275 (setq c1 (string-to-char
15276 (downcase (substring
15277 tg (if (= (string-to-char tg) ?@) 1 0)))))
15278 (if (or (rassoc c1 ntable) (rassoc c1 table))
15279 (while (or (rassoc char ntable) (rassoc char table))
15280 (setq char (1+ char)))
15281 (setq c2 c1))
15282 (setq c (or c2 char)))
15283 (when ingroup (push tg (car groups)))
15284 (setq tg (org-add-props tg nil 'face
15285 (cond
15286 ((not (assoc tg table))
15287 (org-get-todo-face tg))
15288 ((member tg current) c-face)
15289 ((member tg inherited) i-face))))
15290 (when (equal (caar tbl) :grouptags)
15291 (org-add-props tg nil 'face 'org-tag-group))
15292 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15293 (insert "[" c "] " tg (make-string
15294 (- fwidth 4 (length tg)) ?\ ))
15295 (push (cons tg c) ntable)
15296 (when (= (incf cnt) ncol)
15297 (insert "\n")
15298 (when (or ingroup intaggroup) (insert " "))
15299 (setq cnt 0)))))
15300 (setq ntable (nreverse ntable))
15301 (insert "\n")
15302 (goto-char (point-min))
15303 (unless expert (org-fit-window-to-buffer))
15304 (setq rtn
15305 (catch 'exit
15306 (while t
15307 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15308 (if (not groups) "no " "")
15309 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15310 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15311 (setq org-last-tag-selection-key c)
15312 (cond
15313 ((= c ?\r) (throw 'exit t))
15314 ((= c ?!)
15315 (setq groups (not groups))
15316 (goto-char (point-min))
15317 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15318 ((= c ?\C-c)
15319 (if (not expert)
15320 (org-fast-tag-show-exit
15321 (setq exit-after-next (not exit-after-next)))
15322 (setq expert nil)
15323 (delete-other-windows)
15324 (set-window-buffer (split-window-vertically) " *Org tags*")
15325 (org-switch-to-buffer-other-window " *Org tags*")
15326 (org-fit-window-to-buffer)))
15327 ((or (= c ?\C-g)
15328 (and (= c ?q) (not (rassoc c ntable))))
15329 (org-detach-overlay org-tags-overlay)
15330 (setq quit-flag t))
15331 ((= c ?\ )
15332 (setq current nil)
15333 (when exit-after-next (setq exit-after-next 'now)))
15334 ((= c ?\t)
15335 (condition-case nil
15336 (setq tg (org-icompleting-read
15337 "Tag: "
15338 (or buffer-tags
15339 (with-current-buffer buf
15340 (setq buffer-tags
15341 (org-get-buffer-tags))))))
15342 (quit (setq tg "")))
15343 (when (string-match "\\S-" tg)
15344 (add-to-list 'buffer-tags (list tg))
15345 (if (member tg current)
15346 (setq current (delete tg current))
15347 (push tg current)))
15348 (when exit-after-next (setq exit-after-next 'now)))
15349 ((setq e (rassoc c todo-table) tg (car e))
15350 (with-current-buffer buf
15351 (save-excursion (org-todo tg)))
15352 (when exit-after-next (setq exit-after-next 'now)))
15353 ((setq e (rassoc c ntable) tg (car e))
15354 (if (member tg current)
15355 (setq current (delete tg current))
15356 (loop for g in groups do
15357 (when (member tg g)
15358 (dolist (x g) (setq current (delete x current)))))
15359 (push tg current))
15360 (when exit-after-next (setq exit-after-next 'now))))
15362 ;; Create a sorted list
15363 (setq current
15364 (sort current
15365 (lambda (a b)
15366 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15367 (when (eq exit-after-next 'now) (throw 'exit t))
15368 (goto-char (point-min))
15369 (beginning-of-line 2)
15370 (delete-region (point) (point-at-eol))
15371 (org-fast-tag-insert "Current" current c-face)
15372 (org-set-current-tags-overlay current ov-prefix)
15373 (while (re-search-forward
15374 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15375 (setq tg (match-string 1))
15376 (add-text-properties
15377 (match-beginning 1) (match-end 1)
15378 (list 'face
15379 (cond
15380 ((member tg current) c-face)
15381 ((member tg inherited) i-face)
15382 (t (get-text-property (match-beginning 1) 'face))))))
15383 (goto-char (point-min)))))
15384 (org-detach-overlay org-tags-overlay)
15385 (if rtn
15386 (mapconcat 'identity current ":")
15387 nil))))
15389 (defun org-get-tags-string ()
15390 "Get the TAGS string in the current headline."
15391 (unless (org-at-heading-p t)
15392 (user-error "Not on a heading"))
15393 (save-excursion
15394 (beginning-of-line 1)
15395 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15396 (org-match-string-no-properties 1)
15397 "")))
15399 (defun org-get-tags ()
15400 "Get the list of tags specified in the current headline."
15401 (org-split-string (org-get-tags-string) ":"))
15403 (defun org-get-buffer-tags ()
15404 "Get a table of all tags used in the buffer, for completion."
15405 (org-with-wide-buffer
15406 (goto-char (point-min))
15407 (let ((tag-re (concat org-outline-regexp-bol
15408 "\\(?:.*?[ \t]\\)?"
15409 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15410 tags)
15411 (while (re-search-forward tag-re nil t)
15412 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15413 (push tag tags)))
15414 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15416 ;;;; The mapping API
15418 (defun org-map-entries (func &optional match scope &rest skip)
15419 "Call FUNC at each headline selected by MATCH in SCOPE.
15421 FUNC is a function or a lisp form. The function will be called without
15422 arguments, with the cursor positioned at the beginning of the headline.
15423 The return values of all calls to the function will be collected and
15424 returned as a list.
15426 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15427 does not need to preserve point. After evaluation, the cursor will be
15428 moved to the end of the line (presumably of the headline of the
15429 processed entry) and search continues from there. Under some
15430 circumstances, this may not produce the wanted results. For example,
15431 if you have removed (e.g. archived) the current (sub)tree it could
15432 mean that the next entry will be skipped entirely. In such cases, you
15433 can specify the position from where search should continue by making
15434 FUNC set the variable `org-map-continue-from' to the desired buffer
15435 position.
15437 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15438 Only headlines that are matched by this query will be considered during
15439 the iteration. When MATCH is nil or t, all headlines will be
15440 visited by the iteration.
15442 SCOPE determines the scope of this command. It can be any of:
15444 nil The current buffer, respecting the restriction if any
15445 tree The subtree started with the entry at point
15446 region The entries within the active region, if any
15447 region-start-level
15448 The entries within the active region, but only those at
15449 the same level than the first one.
15450 file The current buffer, without restriction
15451 file-with-archives
15452 The current buffer, and any archives associated with it
15453 agenda All agenda files
15454 agenda-with-archives
15455 All agenda files with any archive files associated with them
15456 \(file1 file2 ...)
15457 If this is a list, all files in the list will be scanned
15459 The remaining args are treated as settings for the skipping facilities of
15460 the scanner. The following items can be given here:
15462 archive skip trees with the archive tag
15463 comment skip trees with the COMMENT keyword
15464 function or Emacs Lisp form:
15465 will be used as value for `org-agenda-skip-function', so
15466 whenever the function returns a position, FUNC will not be
15467 called for that entry and search will continue from the
15468 position returned
15470 If your function needs to retrieve the tags including inherited tags
15471 at the *current* entry, you can use the value of the variable
15472 `org-scanner-tags' which will be much faster than getting the value
15473 with `org-get-tags-at'. If your function gets properties with
15474 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15475 to t around the call to `org-entry-properties' to get the same speedup.
15476 Note that if your function moves around to retrieve tags and properties at
15477 a *different* entry, you cannot use these techniques."
15478 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15479 (not (org-region-active-p)))
15480 (let* ((org-agenda-archives-mode nil) ; just to make sure
15481 (org-agenda-skip-archived-trees (memq 'archive skip))
15482 (org-agenda-skip-comment-trees (memq 'comment skip))
15483 (org-agenda-skip-function
15484 (car (org-delete-all '(comment archive) skip)))
15485 (org-tags-match-list-sublevels t)
15486 (start-level (eq scope 'region-start-level))
15487 matcher file res
15488 org-todo-keywords-for-agenda
15489 org-done-keywords-for-agenda
15490 org-todo-keyword-alist-for-agenda
15491 org-tag-alist-for-agenda
15492 todo-only)
15494 (cond
15495 ((eq match t) (setq matcher t))
15496 ((eq match nil) (setq matcher t))
15497 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15499 (save-excursion
15500 (save-restriction
15501 (cond ((eq scope 'tree)
15502 (org-back-to-heading t)
15503 (org-narrow-to-subtree)
15504 (setq scope nil))
15505 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15506 (org-region-active-p))
15507 ;; If needed, set start-level to a string like "2"
15508 (when start-level
15509 (save-excursion
15510 (goto-char (region-beginning))
15511 (unless (org-at-heading-p) (outline-next-heading))
15512 (setq start-level (org-current-level))))
15513 (narrow-to-region (region-beginning)
15514 (save-excursion
15515 (goto-char (region-end))
15516 (unless (and (bolp) (org-at-heading-p))
15517 (outline-next-heading))
15518 (point)))
15519 (setq scope nil)))
15521 (if (not scope)
15522 (progn
15523 (org-agenda-prepare-buffers
15524 (and buffer-file-name (list buffer-file-name)))
15525 (setq res (org-scan-tags func matcher todo-only start-level)))
15526 ;; Get the right scope
15527 (cond
15528 ((and scope (listp scope) (symbolp (car scope)))
15529 (setq scope (eval scope)))
15530 ((eq scope 'agenda)
15531 (setq scope (org-agenda-files t)))
15532 ((eq scope 'agenda-with-archives)
15533 (setq scope (org-agenda-files t))
15534 (setq scope (org-add-archive-files scope)))
15535 ((eq scope 'file)
15536 (setq scope (and buffer-file-name (list buffer-file-name))))
15537 ((eq scope 'file-with-archives)
15538 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15539 (org-agenda-prepare-buffers scope)
15540 (dolist (file scope)
15541 (with-current-buffer (org-find-base-buffer-visiting file)
15542 (save-excursion
15543 (save-restriction
15544 (widen)
15545 (goto-char (point-min))
15546 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15547 res)))
15549 ;;; Properties API
15551 (defconst org-special-properties
15552 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15553 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15554 "The special properties valid in Org mode.
15555 These are properties that are not defined in the property drawer,
15556 but in some other way.")
15558 (defconst org-default-properties
15559 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15560 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15561 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15562 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15563 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15564 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15565 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15566 "Some properties that are used by Org mode for various purposes.
15567 Being in this list makes sure that they are offered for completion.")
15569 (defun org--update-property-plist (key val props)
15570 "Associate KEY to VAL in alist PROPS.
15571 Modifications are made by side-effect. Return new alist."
15572 (let* ((appending (string= (substring key -1) "+"))
15573 (key (if appending (substring key 0 -1) key))
15574 (old (assoc-string key props t)))
15575 (if (not old) (cons (cons key val) props)
15576 (setcdr old (if appending (concat (cdr old) " " val) val))
15577 props)))
15579 (defun org-get-property-block (&optional beg force)
15580 "Return the (beg . end) range of the body of the property drawer.
15581 BEG is the beginning of the current subtree, or of the part
15582 before the first headline. If it is not given, it will be found.
15583 If the drawer does not exist, create it if FORCE is non-nil, or
15584 return nil."
15585 (org-with-wide-buffer
15586 (when beg (goto-char beg))
15587 (unless (org-before-first-heading-p)
15588 (let ((beg (cond (beg)
15589 ((or (not (featurep 'org-inlinetask))
15590 (org-inlinetask-in-task-p))
15591 (org-back-to-heading t))
15592 (t (org-with-limited-levels (org-back-to-heading t))))))
15593 (forward-line)
15594 (when (org-looking-at-p org-planning-line-re) (forward-line))
15595 (cond ((looking-at org-property-drawer-re)
15596 (forward-line)
15597 (cons (point) (progn (goto-char (match-end 0))
15598 (line-beginning-position))))
15599 (force
15600 (goto-char beg)
15601 (org-insert-property-drawer)
15602 (let ((pos (save-excursion (search-forward ":END:")
15603 (line-beginning-position))))
15604 (cons pos pos))))))))
15606 (defun org-at-property-p ()
15607 "Non-nil when point is inside a property drawer.
15608 See `org-property-re' for match data, if applicable."
15609 (save-excursion
15610 (beginning-of-line)
15611 (and (looking-at org-property-re)
15612 (let ((property-drawer (save-match-data (org-get-property-block))))
15613 (and property-drawer
15614 (>= (point) (car property-drawer))
15615 (< (point) (cdr property-drawer)))))))
15617 (defun org-property-action ()
15618 "Do an action on properties."
15619 (interactive)
15620 (unless (org-at-property-p) (user-error "Not at a property"))
15621 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15622 (let ((c (read-char-exclusive)))
15623 (case c
15624 (?s (call-interactively #'org-set-property))
15625 (?d (call-interactively #'org-delete-property))
15626 (?D (call-interactively #'org-delete-property-globally))
15627 (?c (call-interactively #'org-compute-property-at-point))
15628 (otherwise (user-error "No such property action %c" c)))))
15630 (defun org-inc-effort ()
15631 "Increment the value of the effort property in the current entry."
15632 (interactive)
15633 (org-set-effort nil t))
15635 (defvar org-clock-effort) ; Defined in org-clock.el.
15636 (defvar org-clock-current-task) ; Defined in org-clock.el.
15637 (defun org-set-effort (&optional value increment)
15638 "Set the effort property of the current entry.
15639 With numerical prefix arg, use the nth allowed value, 0 stands for the
15640 10th allowed value.
15642 When INCREMENT is non-nil, set the property to the next allowed value."
15643 (interactive "P")
15644 (if (equal value 0) (setq value 10))
15645 (let* ((completion-ignore-case t)
15646 (prop org-effort-property)
15647 (cur (org-entry-get nil prop))
15648 (allowed (org-property-get-allowed-values nil prop 'table))
15649 (existing (mapcar 'list (org-property-values prop)))
15650 (heading (nth 4 (org-heading-components)))
15652 (val (cond
15653 ((stringp value) value)
15654 ((and allowed (integerp value))
15655 (or (car (nth (1- value) allowed))
15656 (car (org-last allowed))))
15657 ((and allowed increment)
15658 (or (caadr (member (list cur) allowed))
15659 (user-error "Allowed effort values are not set")))
15660 (allowed
15661 (message "Select 1-9,0, [RET%s]: %s"
15662 (if cur (concat "=" cur) "")
15663 (mapconcat 'car allowed " "))
15664 (setq rpl (read-char-exclusive))
15665 (if (equal rpl ?\r)
15667 (setq rpl (- rpl ?0))
15668 (if (equal rpl 0) (setq rpl 10))
15669 (if (and (> rpl 0) (<= rpl (length allowed)))
15670 (car (nth (1- rpl) allowed))
15671 (org-completing-read "Effort: " allowed nil))))
15673 (let (org-completion-use-ido org-completion-use-iswitchb)
15674 (org-completing-read
15675 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15676 (concat "[" cur "]") "")
15677 ": ")
15678 existing nil nil "" nil cur))))))
15679 (unless (equal (org-entry-get nil prop) val)
15680 (org-entry-put nil prop val))
15681 (org-refresh-property
15682 '((effort . identity)
15683 (effort-minutes . org-duration-string-to-minutes))
15684 val)
15685 (when (string= heading org-clock-current-task)
15686 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15687 (org-clock-update-mode-line))
15688 (message "%s is now %s" prop val)))
15690 (defun org-entry-properties (&optional pom which)
15691 "Get all properties of the current entry.
15693 When POM is a buffer position, get all properties from the entry
15694 there instead.
15696 This includes the TODO keyword, the tags, time strings for
15697 deadline, scheduled, and clocking, and any additional properties
15698 defined in the entry.
15700 If WHICH is nil or `all', get all properties. If WHICH is
15701 `special' or `standard', only get that subclass. If WHICH is
15702 a string, only get that property.
15704 Return value is an alist. Keys are properties, as upcased
15705 strings."
15706 (org-with-point-at pom
15707 (when (and (derived-mode-p 'org-mode)
15708 (ignore-errors (org-back-to-heading t)))
15709 (catch 'exit
15710 (let* ((beg (point))
15711 (specific (and (stringp which) (upcase which)))
15712 (which (cond ((not specific) which)
15713 ((member specific org-special-properties) 'special)
15714 (t 'standard)))
15715 props)
15716 ;; Get the special properties, like TODO and TAGS.
15717 (when (memq which '(nil all special))
15718 (when (or (not specific) (string= specific "CLOCKSUM"))
15719 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15720 (when clocksum
15721 (push (cons "CLOCKSUM"
15722 (org-columns-number-to-string
15723 (/ (float clocksum) 60.) 'add_times))
15724 props)))
15725 (when specific (throw 'exit props)))
15726 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15727 (let ((clocksumt (get-text-property (point)
15728 :org-clock-minutes-today)))
15729 (when clocksumt
15730 (push (cons "CLOCKSUM_T"
15731 (org-columns-number-to-string
15732 (/ (float clocksumt) 60.) 'add_times))
15733 props)))
15734 (when specific (throw 'exit props)))
15735 (when (or (not specific) (string= specific "ITEM"))
15736 (when (looking-at org-complex-heading-regexp)
15737 (push (cons "ITEM"
15738 (concat
15739 (org-match-string-no-properties 1)
15740 (let ((title (org-match-string-no-properties 4)))
15741 (when (org-string-nw-p title)
15742 (concat " " (org-remove-tabs title))))))
15743 props))
15744 (when specific (throw 'exit props)))
15745 (when (or (not specific) (string= specific "TODO"))
15746 (let ((case-fold-search nil))
15747 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15748 (push (cons "TODO" (org-match-string-no-properties 2)) props)))
15749 (when specific (throw 'exit props)))
15750 (when (or (not specific) (string= specific "PRIORITY"))
15751 (push (cons "PRIORITY"
15752 (if (looking-at org-priority-regexp)
15753 (org-match-string-no-properties 2)
15754 (char-to-string org-default-priority)))
15755 props)
15756 (when specific (throw 'exit props)))
15757 (when (or (not specific) (string= specific "FILE"))
15758 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15759 props)
15760 (when specific (throw 'exit props)))
15761 (when (or (not specific) (string= specific "TAGS"))
15762 (let ((value (org-string-nw-p (org-get-tags-string))))
15763 (when value (push (cons "TAGS" value) props)))
15764 (when specific (throw 'exit props)))
15765 (when (or (not specific) (string= specific "ALLTAGS"))
15766 (let ((value (org-get-tags-at)))
15767 (when value
15768 (push (cons "ALLTAGS"
15769 (format ":%s:" (mapconcat #'identity value ":")))
15770 props)))
15771 (when specific (throw 'exit props)))
15772 (when (or (not specific) (string= specific "BLOCKED"))
15773 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15774 (when specific (throw 'exit props)))
15775 (when (or (not specific)
15776 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15777 (forward-line)
15778 (when (org-looking-at-p org-planning-line-re)
15779 (end-of-line)
15780 (let ((bol (line-beginning-position))
15781 ;; Backward compatibility: time keywords used to
15782 ;; be configurable (before 8.3). Make sure we
15783 ;; get the correct keyword.
15784 (key-assoc `(("CLOSED" . ,org-closed-string)
15785 ("DEADLINE" . ,org-deadline-string)
15786 ("SCHEDULED" . ,org-scheduled-string))))
15787 (dolist (pair (if specific (list (assoc specific key-assoc))
15788 key-assoc))
15789 (save-excursion
15790 (when (search-backward (cdr pair) bol t)
15791 (goto-char (match-end 0))
15792 (skip-chars-forward " \t")
15793 (and (looking-at org-ts-regexp-both)
15794 (push (cons (car pair)
15795 (org-match-string-no-properties 0))
15796 props)))))))
15797 (when specific (throw 'exit props)))
15798 (when (or (not specific)
15799 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15800 (let ((find-ts
15801 (lambda (end ts)
15802 (let ((regexp (cond
15803 ((string= specific "TIMESTAMP")
15804 org-ts-regexp)
15805 ((string= specific "TIMESTAMP_IA")
15806 org-ts-regexp-inactive)
15807 ((assoc "TIMESTAMP_IA" ts)
15808 org-ts-regexp)
15809 ((assoc "TIMESTAMP" ts)
15810 org-ts-regexp-inactive)
15811 (t org-ts-regexp-both))))
15812 (catch 'next
15813 (while (re-search-forward regexp end t)
15814 (backward-char)
15815 (let ((object (org-element-context)))
15816 ;; Accept to match timestamps in node
15817 ;; properties, too.
15818 (when (memq (org-element-type object)
15819 '(node-property timestamp))
15820 (let ((type
15821 (org-element-property :type object)))
15822 (cond
15823 ((and (memq type '(active active-range))
15824 (not (equal specific "TIMESTAMP_IA")))
15825 (unless (assoc "TIMESTAMP" ts)
15826 (push (cons "TIMESTAMP"
15827 (org-element-property
15828 :raw-value object))
15830 (when specific (throw 'exit ts))))
15831 ((and (memq type '(inactive inactive-range))
15832 (not (string= specific "TIMESTAMP")))
15833 (unless (assoc "TIMESTAMP_IA" ts)
15834 (push (cons "TIMESTAMP_IA"
15835 (org-element-property
15836 :raw-value object))
15838 (when specific (throw 'exit ts))))))
15839 ;; Both timestamp types are found,
15840 ;; move to next part.
15841 (when (= (length ts) 2) (throw 'next ts)))))
15842 ts)))))
15843 (goto-char beg)
15844 ;; First look for timestamps within headline.
15845 (let ((ts (funcall find-ts (line-end-position) nil)))
15846 (if (= (length ts) 2) (setq props (nconc ts props))
15847 (forward-line)
15848 ;; Then find timestamps in the section, skipping
15849 ;; planning line.
15850 (when (org-looking-at-p org-planning-line-re)
15851 (forward-line))
15852 (let ((end (save-excursion (outline-next-heading))))
15853 (setq props (nconc (funcall find-ts end ts) props))))))))
15854 ;; Get the standard properties, like :PROP:.
15855 (when (memq which '(nil all standard))
15856 ;; If we are looking after a specific property, delegate
15857 ;; to `org-entry-get', which is faster. However, make an
15858 ;; exception for "CATEGORY", since it can be also set
15859 ;; through keywords (i.e. #+CATEGORY).
15860 (if (and specific (not (equal specific "CATEGORY")))
15861 (let ((value (org-entry-get beg specific nil t)))
15862 (throw 'exit (and value (list (cons specific value)))))
15863 (let ((range (org-get-property-block beg)))
15864 (when range
15865 (let ((end (cdr range)) seen-base)
15866 (goto-char (car range))
15867 ;; Unlike to `org--update-property-plist', we
15868 ;; handle the case where base values is found
15869 ;; after its extension. We also forbid standard
15870 ;; properties to be named as special properties.
15871 (while (re-search-forward org-property-re end t)
15872 (let* ((key (upcase (org-match-string-no-properties 2)))
15873 (extendp (org-string-match-p "\\+\\'" key))
15874 (key-base (if extendp (substring key 0 -1) key))
15875 (value (org-match-string-no-properties 3)))
15876 (cond
15877 ((member-ignore-case key-base org-special-properties))
15878 (extendp
15879 (setq props
15880 (org--update-property-plist key value props)))
15881 ((member key seen-base))
15882 (t (push key seen-base)
15883 (let ((p (assoc-string key props t)))
15884 (if p (setcdr p (concat value " " (cdr p)))
15885 (push (cons key value) props))))))))))))
15886 (unless (assoc "CATEGORY" props)
15887 (push (cons "CATEGORY" (org-get-category beg)) props)
15888 (when (string= specific "CATEGORY") (throw 'exit props)))
15889 ;; Return value.
15890 props)))))
15892 (defun org-property--local-values (property literal-nil)
15893 "Return value for PROPERTY in current entry.
15894 Value is a list whose care is the base value for PROPERTY and cdr
15895 a list of accumulated values. Return nil if neither is found in
15896 the entry. Also return nil when PROPERTY is set to \"nil\",
15897 unless LITERAL-NIL is non-nil."
15898 (let ((range (org-get-property-block)))
15899 (when range
15900 (goto-char (car range))
15901 (let* ((case-fold-search t)
15902 (end (cdr range))
15903 (value
15904 ;; Base value.
15905 (save-excursion
15906 (let ((v (and (re-search-forward
15907 (org-re-property property nil t) end t)
15908 (org-match-string-no-properties 3))))
15909 (list (if literal-nil v (org-not-nil v)))))))
15910 ;; Find additional values.
15911 (let* ((property+ (org-re-property (concat property "+") nil t)))
15912 (while (re-search-forward property+ end t)
15913 (push (org-match-string-no-properties 3) value)))
15914 ;; Return final values.
15915 (and (not (equal value '(nil))) (nreverse value))))))
15917 (defun org-entry-get (pom property &optional inherit literal-nil)
15918 "Get value of PROPERTY for entry or content at point-or-marker POM.
15920 If INHERIT is non-nil and the entry does not have the property,
15921 then also check higher levels of the hierarchy. If INHERIT is
15922 the symbol `selective', use inheritance only if the setting in
15923 `org-use-property-inheritance' selects PROPERTY for inheritance.
15925 If the property is present but empty, the return value is the
15926 empty string. If the property is not present at all, nil is
15927 returned. In any other case, return the value as a string.
15928 Search is case-insensitive.
15930 If LITERAL-NIL is set, return the string value \"nil\" as
15931 a string, do not interpret it as the list atom nil. This is used
15932 for inheritance when a \"nil\" value can supersede a non-nil
15933 value higher up the hierarchy."
15934 (org-with-point-at pom
15935 (cond
15936 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15937 ;; We need a special property. Use `org-entry-properties' to
15938 ;; retrieve it, but specify the wanted property.
15939 (cdr (assoc-string property (org-entry-properties nil property))))
15940 ((and inherit
15941 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15942 (org-entry-get-with-inheritance property literal-nil))
15944 (let* ((local (org-property--local-values property literal-nil))
15945 (value (and local (mapconcat #'identity (delq nil local) " "))))
15946 (if literal-nil value (org-not-nil value)))))))
15948 (defun org-property-or-variable-value (var &optional inherit)
15949 "Check if there is a property fixing the value of VAR.
15950 If yes, return this value. If not, return the current value of the variable."
15951 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15952 (if (and prop (stringp prop) (string-match "\\S-" prop))
15953 (read prop)
15954 (symbol-value var))))
15956 (defun org-entry-delete (pom property)
15957 "Delete PROPERTY from entry at point-or-marker POM.
15958 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15959 non-nil when a property was removed."
15960 (unless (member property org-special-properties)
15961 (org-with-point-at pom
15962 (let ((range (org-get-property-block)))
15963 (when range
15964 (let* ((begin (car range))
15965 (origin (cdr range))
15966 (end (copy-marker origin))
15967 (re (org-re-property
15968 (concat (regexp-quote property) "\\+?") t t)))
15969 (goto-char begin)
15970 (while (re-search-forward re end t)
15971 (delete-region (match-beginning 0) (line-beginning-position 2)))
15972 ;; If drawer is empty, remove it altogether.
15973 (when (= begin end)
15974 (delete-region (line-beginning-position 0)
15975 (line-beginning-position 2)))
15976 ;; Return non-nil if some property was removed.
15977 (prog1 (/= end origin) (set-marker end nil))))))))
15979 ;; Multi-values properties are properties that contain multiple values
15980 ;; These values are assumed to be single words, separated by whitespace.
15981 (defun org-entry-add-to-multivalued-property (pom property value)
15982 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15983 (let* ((old (org-entry-get pom property))
15984 (values (and old (org-split-string old "[ \t]"))))
15985 (setq value (org-entry-protect-space value))
15986 (unless (member value values)
15987 (setq values (append values (list value)))
15988 (org-entry-put pom property
15989 (mapconcat 'identity values " ")))))
15991 (defun org-entry-remove-from-multivalued-property (pom property value)
15992 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15993 (let* ((old (org-entry-get pom property))
15994 (values (and old (org-split-string old "[ \t]"))))
15995 (setq value (org-entry-protect-space value))
15996 (when (member value values)
15997 (setq values (delete value values))
15998 (org-entry-put pom property
15999 (mapconcat 'identity values " ")))))
16001 (defun org-entry-member-in-multivalued-property (pom property value)
16002 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
16003 (let* ((old (org-entry-get pom property))
16004 (values (and old (org-split-string old "[ \t]"))))
16005 (setq value (org-entry-protect-space value))
16006 (member value values)))
16008 (defun org-entry-get-multivalued-property (pom property)
16009 "Return a list of values in a multivalued property."
16010 (let* ((value (org-entry-get pom property))
16011 (values (and value (org-split-string value "[ \t]"))))
16012 (mapcar 'org-entry-restore-space values)))
16014 (defun org-entry-put-multivalued-property (pom property &rest values)
16015 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
16016 VALUES should be a list of strings. Spaces will be protected."
16017 (org-entry-put pom property
16018 (mapconcat 'org-entry-protect-space values " "))
16019 (let* ((value (org-entry-get pom property))
16020 (values (and value (org-split-string value "[ \t]"))))
16021 (mapcar 'org-entry-restore-space values)))
16023 (defun org-entry-protect-space (s)
16024 "Protect spaces and newline in string S."
16025 (while (string-match " " s)
16026 (setq s (replace-match "%20" t t s)))
16027 (while (string-match "\n" s)
16028 (setq s (replace-match "%0A" t t s)))
16031 (defun org-entry-restore-space (s)
16032 "Restore spaces and newline in string S."
16033 (while (string-match "%20" s)
16034 (setq s (replace-match " " t t s)))
16035 (while (string-match "%0A" s)
16036 (setq s (replace-match "\n" t t s)))
16039 (defvar org-entry-property-inherited-from (make-marker)
16040 "Marker pointing to the entry from where a property was inherited.
16041 Each call to `org-entry-get-with-inheritance' will set this marker to the
16042 location of the entry where the inheritance search matched. If there was
16043 no match, the marker will point nowhere.
16044 Note that also `org-entry-get' calls this function, if the INHERIT flag
16045 is set.")
16047 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16048 "Get PROPERTY of entry or content at point, search higher levels if needed.
16049 The search will stop at the first ancestor which has the property defined.
16050 If the value found is \"nil\", return nil to show that the property
16051 should be considered as undefined (this is the meaning of nil here).
16052 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16053 (move-marker org-entry-property-inherited-from nil)
16054 (org-with-wide-buffer
16055 (let (value)
16056 (catch 'exit
16057 (while t
16058 (let ((v (org-property--local-values property literal-nil)))
16059 (when v
16060 (setq value
16061 (concat (mapconcat #'identity (delq nil v) " ")
16062 (and value " ")
16063 value)))
16064 (cond
16065 ((car v)
16066 (org-back-to-heading t)
16067 (move-marker org-entry-property-inherited-from (point))
16068 (throw 'exit nil))
16069 ((org-up-heading-safe))
16071 (let ((global
16072 (cdr (or (assoc-string property org-file-properties t)
16073 (assoc-string property org-global-properties t)
16074 (assoc-string property org-global-properties-fixed t)))))
16075 (cond ((not global))
16076 (value (setq value (concat global " " value)))
16077 (t (setq value global))))
16078 (throw 'exit nil))))))
16079 (if literal-nil value (org-not-nil value)))))
16081 (defvar org-property-changed-functions nil
16082 "Hook called when the value of a property has changed.
16083 Each hook function should accept two arguments, the name of the property
16084 and the new value.")
16086 (defun org-entry-put (pom property value)
16087 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16089 If the value is nil, it is converted to the empty string. If
16090 it is not a string, an error is raised.
16092 PROPERTY can be any regular property (see
16093 `org-special-properties'). It can also be \"TODO\",
16094 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16096 For the last two properties, VALUE may have any of the special
16097 values \"earlier\" and \"later\". The function then increases or
16098 decreases scheduled or deadline date by one day."
16099 (cond ((null value) (setq value ""))
16100 ((not (stringp value)) (error "Properties values should be strings")))
16101 (org-with-point-at pom
16102 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16103 (org-back-to-heading t)
16104 (org-with-limited-levels (org-back-to-heading t)))
16105 (let ((beg (point)))
16106 (cond
16107 ((equal property "TODO")
16108 (cond ((not (org-string-nw-p value)) (setq value 'none))
16109 ((not (member value org-todo-keywords-1))
16110 (user-error "\"%s\" is not a valid TODO state" value)))
16111 (org-todo value)
16112 (org-set-tags nil 'align))
16113 ((equal property "PRIORITY")
16114 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16115 (org-set-tags nil 'align))
16116 ((equal property "SCHEDULED")
16117 (forward-line)
16118 (if (and (org-looking-at-p org-planning-line-re)
16119 (re-search-forward
16120 org-scheduled-time-regexp (line-end-position) t))
16121 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16122 ((string= value "later") (org-timestamp-change 1 'day))
16123 ((string= value "") (org-schedule '(4)))
16124 (t (org-schedule nil value)))
16125 (if (member value '("earlier" "later" ""))
16126 (call-interactively #'org-schedule)
16127 (org-schedule nil value))))
16128 ((equal property "DEADLINE")
16129 (forward-line)
16130 (if (and (org-looking-at-p org-planning-line-re)
16131 (re-search-forward
16132 org-deadline-time-regexp (line-end-position) t))
16133 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16134 ((string= value "later") (org-timestamp-change 1 'day))
16135 ((string= value "") (org-deadline '(4)))
16136 (t (org-deadline nil value)))
16137 (if (member value '("earlier" "later" ""))
16138 (call-interactively #'org-deadline)
16139 (org-deadline nil value))))
16140 ((member property org-special-properties)
16141 (error "The %s property cannot be set with `org-entry-put'" property))
16143 (let* ((range (org-get-property-block beg 'force))
16144 (end (cdr range))
16145 (case-fold-search t))
16146 (goto-char (car range))
16147 (if (re-search-forward (org-re-property property nil t) end t)
16148 (progn (delete-region (match-beginning 0) (match-end 0))
16149 (goto-char (match-beginning 0)))
16150 (goto-char end)
16151 (insert "\n")
16152 (backward-char))
16153 (insert ":" property ":")
16154 (when value (insert " " value))
16155 (org-indent-line)))))
16156 (run-hook-with-args 'org-property-changed-functions property value)))
16158 (defun org-buffer-property-keys (&optional specials defaults columns)
16159 "Get all property keys in the current buffer.
16161 When SPECIALS is non-nil, also list the special properties that
16162 reflect things like tags and TODO state.
16164 When DEFAULTS is non-nil, also include properties that has
16165 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16166 DESCRIPTION, LOCATION, and LOGGING and others.
16168 When COLUMNS in non-nil, also include property names given in
16169 COLUMN formats in the current buffer."
16170 (let ((case-fold-search t)
16171 (props (append
16172 (and specials org-special-properties)
16173 (and defaults (cons org-effort-property org-default-properties))
16174 nil)))
16175 (org-with-wide-buffer
16176 (goto-char (point-min))
16177 (while (re-search-forward org-property-start-re nil t)
16178 (let ((range (org-get-property-block)))
16179 (catch 'skip
16180 (unless range
16181 (when (and (not (org-before-first-heading-p))
16182 (y-or-n-p (format "Malformed drawer at %d, repair?"
16183 (line-beginning-position))))
16184 (org-get-property-block nil t))
16185 (throw 'skip nil))
16186 (goto-char (car range))
16187 (let ((begin (car range))
16188 (end (cdr range)))
16189 ;; Make sure that found property block is not located
16190 ;; before current point, as it would generate an infloop.
16191 ;; It can happen, for example, in the following
16192 ;; situation:
16194 ;; * Headline
16195 ;; :PROPERTIES:
16196 ;; ...
16197 ;; :END:
16198 ;; *************** Inlinetask
16199 ;; #+BEGIN_EXAMPLE
16200 ;; :PROPERTIES:
16201 ;; #+END_EXAMPLE
16203 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16204 (while (< (point) end)
16205 (let ((p (progn (looking-at org-property-re)
16206 (org-match-string-no-properties 2))))
16207 ;; Only add true property name, not extension symbol.
16208 (add-to-list 'props
16209 (if (not (org-string-match-p "\\+\\'" p)) p
16210 (substring p 0 -1))))
16211 (forward-line))))
16212 (outline-next-heading)))
16213 (when columns
16214 (goto-char (point-min))
16215 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16216 (let ((element (org-element-at-point)))
16217 (when (memq (org-element-type element) '(keyword node-property))
16218 (let ((value (org-element-property :value element))
16219 (start 0))
16220 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16221 (setq start (match-end 0))
16222 (let ((p (org-match-string-no-properties 1 value)))
16223 (unless (member-ignore-case p org-special-properties)
16224 (add-to-list 'props p))))))))))
16225 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16227 (defun org-property-values (key)
16228 "List all non-nil values of property KEY in current buffer."
16229 (org-with-wide-buffer
16230 (goto-char (point-min))
16231 (let ((case-fold-search t)
16232 (re (org-re-property key))
16233 values)
16234 (while (re-search-forward re nil t)
16235 (add-to-list 'values (org-entry-get (point) key)))
16236 values)))
16238 (defun org-insert-property-drawer ()
16239 "Insert a property drawer into the current entry."
16240 (org-with-wide-buffer
16241 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16242 (org-back-to-heading t)
16243 (org-with-limited-levels (org-back-to-heading t)))
16244 (forward-line)
16245 (when (org-looking-at-p org-planning-line-re) (forward-line))
16246 (unless (org-looking-at-p org-property-drawer-re)
16247 ;; Make sure we start editing a line from current entry, not from
16248 ;; next one. It prevents extending text properties or overlays
16249 ;; belonging to the latter.
16250 (when (bolp) (backward-char))
16251 (let ((begin (1+ (point)))
16252 (inhibit-read-only t))
16253 (insert "\n:PROPERTIES:\n:END:")
16254 (when (eobp) (insert "\n"))
16255 (org-indent-region begin (point))))))
16257 (defun org-insert-drawer (&optional arg drawer)
16258 "Insert a drawer at point.
16260 When optional argument ARG is non-nil, insert a property drawer.
16262 Optional argument DRAWER, when non-nil, is a string representing
16263 drawer's name. Otherwise, the user is prompted for a name.
16265 If a region is active, insert the drawer around that region
16266 instead.
16268 Point is left between drawer's boundaries."
16269 (interactive "P")
16270 (let* ((drawer (if arg "PROPERTIES"
16271 (or drawer (read-from-minibuffer "Drawer: ")))))
16272 (cond
16273 ;; With C-u, fall back on `org-insert-property-drawer'
16274 (arg (org-insert-property-drawer))
16275 ;; Check validity of suggested drawer's name.
16276 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16277 (user-error "Invalid drawer name"))
16278 ;; With an active region, insert a drawer at point.
16279 ((not (org-region-active-p))
16280 (progn
16281 (unless (bolp) (insert "\n"))
16282 (insert (format ":%s:\n\n:END:\n" drawer))
16283 (forward-line -2)))
16284 ;; Otherwise, insert the drawer at point
16286 (let ((rbeg (region-beginning))
16287 (rend (copy-marker (region-end))))
16288 (unwind-protect
16289 (progn
16290 (goto-char rbeg)
16291 (beginning-of-line)
16292 (when (save-excursion
16293 (re-search-forward org-outline-regexp-bol rend t))
16294 (user-error "Drawers cannot contain headlines"))
16295 ;; Position point at the beginning of the first
16296 ;; non-blank line in region. Insert drawer's opening
16297 ;; there, then indent it.
16298 (org-skip-whitespace)
16299 (beginning-of-line)
16300 (insert ":" drawer ":\n")
16301 (forward-line -1)
16302 (indent-for-tab-command)
16303 ;; Move point to the beginning of the first blank line
16304 ;; after the last non-blank line in region. Insert
16305 ;; drawer's closing, then indent it.
16306 (goto-char rend)
16307 (skip-chars-backward " \r\t\n")
16308 (insert "\n:END:")
16309 (deactivate-mark t)
16310 (indent-for-tab-command)
16311 (unless (eolp) (insert "\n")))
16312 ;; Clear marker, whatever the outcome of insertion is.
16313 (set-marker rend nil)))))))
16315 (defvar org-property-set-functions-alist nil
16316 "Property set function alist.
16317 Each entry should have the following format:
16319 (PROPERTY . READ-FUNCTION)
16321 The read function will be called with the same argument as
16322 `org-completing-read'.")
16324 (defun org-set-property-function (property)
16325 "Get the function that should be used to set PROPERTY.
16326 This is computed according to `org-property-set-functions-alist'."
16327 (or (cdr (assoc property org-property-set-functions-alist))
16328 'org-completing-read))
16330 (defun org-read-property-value (property)
16331 "Read PROPERTY value from user."
16332 (let* ((completion-ignore-case t)
16333 (allowed (org-property-get-allowed-values nil property 'table))
16334 (cur (org-entry-get nil property))
16335 (prompt (concat property " value"
16336 (if (and cur (string-match "\\S-" cur))
16337 (concat " [" cur "]") "") ": "))
16338 (set-function (org-set-property-function property))
16339 (val (if allowed
16340 (funcall set-function prompt allowed nil
16341 (not (get-text-property 0 'org-unrestricted
16342 (caar allowed))))
16343 (let (org-completion-use-ido org-completion-use-iswitchb)
16344 (funcall set-function prompt
16345 (mapcar 'list (org-property-values property))
16346 nil nil "" nil cur)))))
16347 (org-trim val)))
16349 (defvar org-last-set-property nil)
16350 (defvar org-last-set-property-value nil)
16351 (defun org-read-property-name ()
16352 "Read a property name."
16353 (let ((completion-ignore-case t)
16354 (default-prop (or (and (org-at-property-p)
16355 (org-match-string-no-properties 2))
16356 org-last-set-property)))
16357 (org-completing-read
16358 (concat "Property"
16359 (if default-prop (concat " [" default-prop "]") "")
16360 ": ")
16361 (mapcar #'list (org-buffer-property-keys nil t t))
16362 nil nil nil nil default-prop)))
16364 (defun org-set-property-and-value (use-last)
16365 "Allow to set [PROPERTY]: [value] direction from prompt.
16366 When use-default, don't even ask, just use the last
16367 \"[PROPERTY]: [value]\" string from the history."
16368 (interactive "P")
16369 (let* ((completion-ignore-case t)
16370 (pv (or (and use-last org-last-set-property-value)
16371 (org-completing-read
16372 "Enter a \"[Property]: [value]\" pair: "
16373 nil nil nil nil nil
16374 org-last-set-property-value)))
16375 prop val)
16376 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16377 (setq prop (match-string 1 pv)
16378 val (match-string 2 pv))
16379 (org-set-property prop val))))
16381 (defun org-set-property (property value)
16382 "In the current entry, set PROPERTY to VALUE.
16383 When called interactively, this will prompt for a property name, offering
16384 completion on existing and default properties. And then it will prompt
16385 for a value, offering completion either on allowed values (via an inherited
16386 xxx_ALL property) or on existing values in other instances of this property
16387 in the current file."
16388 (interactive (list nil nil))
16389 (let* ((property (or property (org-read-property-name)))
16390 (value (or value (org-read-property-value property)))
16391 (fn (cdr (assoc property org-properties-postprocess-alist))))
16392 (setq org-last-set-property property)
16393 (setq org-last-set-property-value (concat property ": " value))
16394 ;; Possibly postprocess the inserted value:
16395 (when fn (setq value (funcall fn value)))
16396 (unless (equal (org-entry-get nil property) value)
16397 (org-entry-put nil property value))))
16399 (defun org-find-property (property &optional value)
16400 "Find first entry in buffer that sets PROPERTY.
16402 When optional argument VALUE is non-nil, only consider an entry
16403 if it contains PROPERTY set to this value. If PROPERTY should be
16404 explicitly set to nil, use string \"nil\" for VALUE.
16406 Return position where the entry begins, or nil if there is no
16407 such entry. If narrowing is in effect, only search the visible
16408 part of the buffer."
16409 (save-excursion
16410 (goto-char (point-min))
16411 (let ((case-fold-search t)
16412 (re (org-re-property property nil (not value) value)))
16413 (catch 'exit
16414 (while (re-search-forward re nil t)
16415 (when (if value (org-at-property-p)
16416 (org-entry-get (point) property nil t))
16417 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16419 (defun org-delete-property (property)
16420 "In the current entry, delete PROPERTY."
16421 (interactive
16422 (let* ((completion-ignore-case t)
16423 (cat (org-entry-get (point) "CATEGORY"))
16424 (props0 (org-entry-properties nil 'standard))
16425 (props (if cat props0
16426 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16427 (prop (if (< 1 (length props))
16428 (org-icompleting-read "Property: " props nil t)
16429 (caar props))))
16430 (list prop)))
16431 (if (not property)
16432 (message "No property to delete in this entry")
16433 (org-entry-delete nil property)
16434 (message "Property \"%s\" deleted" property)))
16436 (defun org-delete-property-globally (property)
16437 "Remove PROPERTY globally, from all entries.
16438 This function ignores narrowing, if any."
16439 (interactive
16440 (let* ((completion-ignore-case t)
16441 (prop (org-icompleting-read
16442 "Globally remove property: "
16443 (mapcar #'list (org-buffer-property-keys)))))
16444 (list prop)))
16445 (org-with-wide-buffer
16446 (goto-char (point-min))
16447 (let ((count 0)
16448 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16449 (while (re-search-forward re nil t)
16450 (when (org-entry-delete (point) property) (incf count)))
16451 (message "Property \"%s\" removed from %d entries" property count))))
16453 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16455 (defun org-compute-property-at-point ()
16456 "Compute the property at point.
16457 This looks for an enclosing column format, extracts the operator and
16458 then applies it to the property in the column format's scope."
16459 (interactive)
16460 (unless (org-at-property-p)
16461 (user-error "Not at a property"))
16462 (let ((prop (org-match-string-no-properties 2)))
16463 (org-columns-get-format-and-top-level)
16464 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16465 (user-error "No operator defined for property %s" prop))
16466 (org-columns-compute prop)))
16468 (defvar org-property-allowed-value-functions nil
16469 "Hook for functions supplying allowed values for a specific property.
16470 The functions must take a single argument, the name of the property, and
16471 return a flat list of allowed values. If \":ETC\" is one of
16472 the values, this means that these values are intended as defaults for
16473 completion, but that other values should be allowed too.
16474 The functions must return nil if they are not responsible for this
16475 property.")
16477 (defun org-property-get-allowed-values (pom property &optional table)
16478 "Get allowed values for the property PROPERTY.
16479 When TABLE is non-nil, return an alist that can directly be used for
16480 completion."
16481 (let (vals)
16482 (cond
16483 ((equal property "TODO")
16484 (setq vals (org-with-point-at pom
16485 (append org-todo-keywords-1 '("")))))
16486 ((equal property "PRIORITY")
16487 (let ((n org-lowest-priority))
16488 (while (>= n org-highest-priority)
16489 (push (char-to-string n) vals)
16490 (setq n (1- n)))))
16491 ((equal property "CATEGORY"))
16492 ((member property org-special-properties))
16493 ((setq vals (run-hook-with-args-until-success
16494 'org-property-allowed-value-functions property)))
16496 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16497 (when (and vals (string-match "\\S-" vals))
16498 (setq vals (car (read-from-string (concat "(" vals ")"))))
16499 (setq vals (mapcar (lambda (x)
16500 (cond ((stringp x) x)
16501 ((numberp x) (number-to-string x))
16502 ((symbolp x) (symbol-name x))
16503 (t "???")))
16504 vals)))))
16505 (when (member ":ETC" vals)
16506 (setq vals (remove ":ETC" vals))
16507 (org-add-props (car vals) '(org-unrestricted t)))
16508 (if table (mapcar 'list vals) vals)))
16510 (defun org-property-previous-allowed-value (&optional previous)
16511 "Switch to the next allowed value for this property."
16512 (interactive)
16513 (org-property-next-allowed-value t))
16515 (defun org-property-next-allowed-value (&optional previous)
16516 "Switch to the next allowed value for this property."
16517 (interactive)
16518 (unless (org-at-property-p)
16519 (user-error "Not at a property"))
16520 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16521 (key (match-string 2))
16522 (value (match-string 3))
16523 (allowed (or (org-property-get-allowed-values (point) key)
16524 (and (member value '("[ ]" "[-]" "[X]"))
16525 '("[ ]" "[X]"))))
16526 (heading (save-match-data (nth 4 (org-heading-components))))
16527 nval)
16528 (unless allowed
16529 (user-error "Allowed values for this property have not been defined"))
16530 (if previous (setq allowed (reverse allowed)))
16531 (if (member value allowed)
16532 (setq nval (car (cdr (member value allowed)))))
16533 (setq nval (or nval (car allowed)))
16534 (if (equal nval value)
16535 (user-error "Only one allowed value for this property"))
16536 (org-at-property-p)
16537 (replace-match (concat " :" key ": " nval) t t)
16538 (org-indent-line)
16539 (beginning-of-line 1)
16540 (skip-chars-forward " \t")
16541 (when (equal prop org-effort-property)
16542 (org-refresh-property
16543 '((effort . identity)
16544 (effort-minutes . org-duration-string-to-minutes))
16545 nval)
16546 (when (string= org-clock-current-task heading)
16547 (setq org-clock-effort nval)
16548 (org-clock-update-mode-line)))
16549 (run-hook-with-args 'org-property-changed-functions key nval)))
16551 (defun org-find-olp (path &optional this-buffer)
16552 "Return a marker pointing to the entry at outline path OLP.
16553 If anything goes wrong, throw an error.
16554 You can wrap this call to catch the error like this:
16556 (condition-case msg
16557 (org-mobile-locate-entry (match-string 4))
16558 (error (nth 1 msg)))
16560 The return value will then be either a string with the error message,
16561 or a marker if everything is OK.
16563 If THIS-BUFFER is set, the outline path does not contain a file,
16564 only headings."
16565 (let* ((file (if this-buffer buffer-file-name (pop path)))
16566 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16567 (level 1)
16568 (lmin 1)
16569 (lmax 1)
16570 limit re end found pos heading cnt flevel)
16571 (unless buffer (error "File not found :%s" file))
16572 (with-current-buffer buffer
16573 (save-excursion
16574 (save-restriction
16575 (widen)
16576 (setq limit (point-max))
16577 (goto-char (point-min))
16578 (dolist (heading path)
16579 (setq re (format org-complex-heading-regexp-format
16580 (regexp-quote heading)))
16581 (setq cnt 0 pos (point))
16582 (while (re-search-forward re end t)
16583 (setq level (- (match-end 1) (match-beginning 1)))
16584 (if (and (>= level lmin) (<= level lmax))
16585 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16586 (when (= cnt 0) (error "Heading not found on level %d: %s"
16587 lmax heading))
16588 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16589 lmax heading))
16590 (goto-char found)
16591 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16592 (setq end (save-excursion (org-end-of-subtree t t))))
16593 (when (org-at-heading-p)
16594 (point-marker)))))))
16596 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16597 "Find node HEADING in BUFFER.
16598 Return a marker to the heading if it was found, or nil if not.
16599 If POS-ONLY is set, return just the position instead of a marker.
16601 The heading text must match exact, but it may have a TODO keyword,
16602 a priority cookie and tags in the standard locations."
16603 (with-current-buffer (or buffer (current-buffer))
16604 (save-excursion
16605 (save-restriction
16606 (widen)
16607 (goto-char (point-min))
16608 (let (case-fold-search)
16609 (if (re-search-forward
16610 (format org-complex-heading-regexp-format
16611 (regexp-quote heading)) nil t)
16612 (if pos-only
16613 (match-beginning 0)
16614 (move-marker (make-marker) (match-beginning 0)))))))))
16616 (defun org-find-exact-heading-in-directory (heading &optional dir)
16617 "Find Org node headline HEADING in all .org files in directory DIR.
16618 When the target headline is found, return a marker to this location."
16619 (let ((files (directory-files (or dir default-directory)
16620 t "\\`[^.#].*\\.org\\'"))
16621 visiting m buffer)
16622 (catch 'found
16623 (dolist (file files)
16624 (message "trying %s" file)
16625 (setq visiting (org-find-base-buffer-visiting file))
16626 (setq buffer (or visiting (find-file-noselect file)))
16627 (setq m (org-find-exact-headline-in-buffer
16628 heading buffer))
16629 (when (and (not m) (not visiting)) (kill-buffer buffer))
16630 (and m (throw 'found m))))))
16632 (defun org-find-entry-with-id (ident)
16633 "Locate the entry that contains the ID property with exact value IDENT.
16634 IDENT can be a string, a symbol or a number, this function will search for
16635 the string representation of it.
16636 Return the position where this entry starts, or nil if there is no such entry."
16637 (interactive "sID: ")
16638 (let ((id (cond
16639 ((stringp ident) ident)
16640 ((symbolp ident) (symbol-name ident))
16641 ((numberp ident) (number-to-string ident))
16642 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16643 (org-with-wide-buffer (org-find-property "ID" id))))
16645 ;;;; Timestamps
16647 (defvar org-last-changed-timestamp nil)
16648 (defvar org-last-inserted-timestamp nil
16649 "The last time stamp inserted with `org-insert-time-stamp'.")
16650 (defvar org-ts-what) ; dynamically scoped parameter
16652 (defun org-time-stamp (arg &optional inactive)
16653 "Prompt for a date/time and insert a time stamp.
16655 If the user specifies a time like HH:MM or if this command is
16656 called with at least one prefix argument, the time stamp contains
16657 the date and the time. Otherwise, only the date is included.
16659 All parts of a date not specified by the user are filled in from
16660 the timestamp at point, if any, or the current date/time
16661 otherwise.
16663 If there is already a timestamp at the cursor, it is replaced.
16665 With two universal prefix arguments, insert an active timestamp
16666 with the current time without prompting the user.
16668 When called from lisp, the timestamp is inactive if INACTIVE is
16669 non-nil."
16670 (interactive "P")
16671 (let* ((ts (cond
16672 ((org-at-date-range-p t)
16673 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16674 ((org-at-timestamp-p t) (match-string 0))))
16675 ;; Default time is either the timestamp at point or today.
16676 ;; When entering a range, only the range start is considered.
16677 (default-time (if (not ts) (current-time)
16678 (apply #'encode-time (org-parse-time-string ts))))
16679 (default-input (and ts (org-get-compact-tod ts)))
16680 (repeater (and ts
16681 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16682 (match-string 0 ts)))
16683 org-time-was-given
16684 org-end-time-was-given
16685 (time
16686 (and (if (equal arg '(16)) (current-time)
16687 ;; Preserve `this-command' and `last-command'.
16688 (let ((this-command this-command)
16689 (last-command last-command))
16690 (org-read-date
16691 arg 'totime nil nil default-time default-input
16692 inactive))))))
16693 (cond
16694 ((and ts
16695 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16696 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16697 (insert "--")
16698 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16700 ;; Make sure we're on a timestamp. When in the middle of a date
16701 ;; range, move arbitrarily to range end.
16702 (unless (org-at-timestamp-p t)
16703 (skip-chars-forward "-")
16704 (org-at-timestamp-p t))
16705 (replace-match "")
16706 (setq org-last-changed-timestamp
16707 (org-insert-time-stamp
16708 time (or org-time-was-given arg)
16709 inactive nil nil (list org-end-time-was-given)))
16710 (when repeater
16711 (backward-char)
16712 (insert " " repeater)
16713 (setq org-last-changed-timestamp
16714 (concat (substring org-last-inserted-timestamp 0 -1)
16715 " " repeater ">")))
16716 (message "Timestamp updated"))
16717 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16718 (t (org-insert-time-stamp
16719 time (or org-time-was-given arg) inactive nil nil
16720 (list org-end-time-was-given))))))
16722 ;; FIXME: can we use this for something else, like computing time differences?
16723 (defun org-get-compact-tod (s)
16724 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16725 (let* ((t1 (match-string 1 s))
16726 (h1 (string-to-number (match-string 2 s)))
16727 (m1 (string-to-number (match-string 3 s)))
16728 (t2 (and (match-end 4) (match-string 5 s)))
16729 (h2 (and t2 (string-to-number (match-string 6 s))))
16730 (m2 (and t2 (string-to-number (match-string 7 s))))
16731 dh dm)
16732 (if (not t2)
16734 (setq dh (- h2 h1) dm (- m2 m1))
16735 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16736 (concat t1 "+" (number-to-string dh)
16737 (and (/= 0 dm) (format ":%02d" dm)))))))
16739 (defun org-time-stamp-inactive (&optional arg)
16740 "Insert an inactive time stamp.
16741 An inactive time stamp is enclosed in square brackets instead of angle
16742 brackets. It is inactive in the sense that it does not trigger agenda entries,
16743 does not link to the calendar and cannot be changed with the S-cursor keys.
16744 So these are more for recording a certain time/date."
16745 (interactive "P")
16746 (org-time-stamp arg 'inactive))
16748 (defvar org-date-ovl (make-overlay 1 1))
16749 (overlay-put org-date-ovl 'face 'org-date-selected)
16750 (org-detach-overlay org-date-ovl)
16752 (defvar org-ans1) ; dynamically scoped parameter
16753 (defvar org-ans2) ; dynamically scoped parameter
16755 (defvar org-plain-time-of-day-regexp) ; defined below
16757 (defvar org-overriding-default-time nil) ; dynamically scoped
16758 (defvar org-read-date-overlay nil)
16759 (defvar org-dcst nil) ; dynamically scoped
16760 (defvar org-read-date-history nil)
16761 (defvar org-read-date-final-answer nil)
16762 (defvar org-read-date-analyze-futurep nil)
16763 (defvar org-read-date-analyze-forced-year nil)
16764 (defvar org-read-date-inactive)
16766 (defvar org-read-date-minibuffer-local-map
16767 (let* ((map (make-sparse-keymap)))
16768 (set-keymap-parent map minibuffer-local-map)
16769 (org-defkey map (kbd ".")
16770 (lambda () (interactive)
16771 ;; Are we at the beginning of the prompt?
16772 (if (looking-back "^[^:]+: ")
16773 (org-eval-in-calendar '(calendar-goto-today))
16774 (insert "."))))
16775 (org-defkey map (kbd "C-.")
16776 (lambda () (interactive)
16777 (org-eval-in-calendar '(calendar-goto-today))))
16778 (org-defkey map [(meta shift left)]
16779 (lambda () (interactive)
16780 (org-eval-in-calendar '(calendar-backward-month 1))))
16781 (org-defkey map [(meta shift right)]
16782 (lambda () (interactive)
16783 (org-eval-in-calendar '(calendar-forward-month 1))))
16784 (org-defkey map [(meta shift up)]
16785 (lambda () (interactive)
16786 (org-eval-in-calendar '(calendar-backward-year 1))))
16787 (org-defkey map [(meta shift down)]
16788 (lambda () (interactive)
16789 (org-eval-in-calendar '(calendar-forward-year 1))))
16790 (org-defkey map [?\e (shift left)]
16791 (lambda () (interactive)
16792 (org-eval-in-calendar '(calendar-backward-month 1))))
16793 (org-defkey map [?\e (shift right)]
16794 (lambda () (interactive)
16795 (org-eval-in-calendar '(calendar-forward-month 1))))
16796 (org-defkey map [?\e (shift up)]
16797 (lambda () (interactive)
16798 (org-eval-in-calendar '(calendar-backward-year 1))))
16799 (org-defkey map [?\e (shift down)]
16800 (lambda () (interactive)
16801 (org-eval-in-calendar '(calendar-forward-year 1))))
16802 (org-defkey map [(shift up)]
16803 (lambda () (interactive)
16804 (org-eval-in-calendar '(calendar-backward-week 1))))
16805 (org-defkey map [(shift down)]
16806 (lambda () (interactive)
16807 (org-eval-in-calendar '(calendar-forward-week 1))))
16808 (org-defkey map [(shift left)]
16809 (lambda () (interactive)
16810 (org-eval-in-calendar '(calendar-backward-day 1))))
16811 (org-defkey map [(shift right)]
16812 (lambda () (interactive)
16813 (org-eval-in-calendar '(calendar-forward-day 1))))
16814 (org-defkey map "!"
16815 (lambda () (interactive)
16816 (org-eval-in-calendar '(diary-view-entries))
16817 (message "")))
16818 (org-defkey map ">"
16819 (lambda () (interactive)
16820 (org-eval-in-calendar '(calendar-scroll-left 1))))
16821 (org-defkey map "<"
16822 (lambda () (interactive)
16823 (org-eval-in-calendar '(calendar-scroll-right 1))))
16824 (org-defkey map "\C-v"
16825 (lambda () (interactive)
16826 (org-eval-in-calendar
16827 '(calendar-scroll-left-three-months 1))))
16828 (org-defkey map "\M-v"
16829 (lambda () (interactive)
16830 (org-eval-in-calendar
16831 '(calendar-scroll-right-three-months 1))))
16832 map)
16833 "Keymap for minibuffer commands when using `org-read-date'.")
16835 (defvar org-def)
16836 (defvar org-defdecode)
16837 (defvar org-with-time)
16839 (defun org-read-date (&optional org-with-time to-time from-string prompt
16840 default-time default-input inactive)
16841 "Read a date, possibly a time, and make things smooth for the user.
16842 The prompt will suggest to enter an ISO date, but you can also enter anything
16843 which will at least partially be understood by `parse-time-string'.
16844 Unrecognized parts of the date will default to the current day, month, year,
16845 hour and minute. If this command is called to replace a timestamp at point,
16846 or to enter the second timestamp of a range, the default time is taken
16847 from the existing stamp. Furthermore, the command prefers the future,
16848 so if you are giving a date where the year is not given, and the day-month
16849 combination is already past in the current year, it will assume you
16850 mean next year. For details, see the manual. A few examples:
16852 3-2-5 --> 2003-02-05
16853 feb 15 --> currentyear-02-15
16854 2/15 --> currentyear-02-15
16855 sep 12 9 --> 2009-09-12
16856 12:45 --> today 12:45
16857 22 sept 0:34 --> currentyear-09-22 0:34
16858 12 --> currentyear-currentmonth-12
16859 Fri --> nearest Friday after today
16860 -Tue --> last Tuesday
16861 etc.
16863 Furthermore you can specify a relative date by giving, as the *first* thing
16864 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16865 change in days weeks, months, years.
16866 With a single plus or minus, the date is relative to today. With a double
16867 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16868 +4d --> four days from today
16869 +4 --> same as above
16870 +2w --> two weeks from today
16871 ++5 --> five days from default date
16873 The function understands only English month and weekday abbreviations.
16875 While prompting, a calendar is popped up - you can also select the
16876 date with the mouse (button 1). The calendar shows a period of three
16877 months. To scroll it to other months, use the keys `>' and `<'.
16878 If you don't like the calendar, turn it off with
16879 (setq org-read-date-popup-calendar nil)
16881 With optional argument TO-TIME, the date will immediately be converted
16882 to an internal time.
16883 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16884 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16885 still enter a time, and this function will inform the calling routine
16886 about this change. The calling routine may then choose to change the
16887 format used to insert the time stamp into the buffer to include the time.
16888 With optional argument FROM-STRING, read from this string instead from
16889 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16890 the time/date that is used for everything that is not specified by the
16891 user."
16892 (require 'parse-time)
16893 (let* ((org-time-stamp-rounding-minutes
16894 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16895 (org-dcst org-display-custom-times)
16896 (ct (org-current-time))
16897 (org-def (or org-overriding-default-time default-time ct))
16898 (org-defdecode (decode-time org-def))
16899 (dummy (progn
16900 (when (< (nth 2 org-defdecode) org-extend-today-until)
16901 (setcar (nthcdr 2 org-defdecode) -1)
16902 (setcar (nthcdr 1 org-defdecode) 59)
16903 (setq org-def (apply 'encode-time org-defdecode)
16904 org-defdecode (decode-time org-def)))))
16905 (cur-frame (selected-frame))
16906 (mouse-autoselect-window nil) ; Don't let the mouse jump
16907 (calendar-frame-setup nil)
16908 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16909 (calendar-move-hook nil)
16910 (calendar-view-diary-initially-flag nil)
16911 (calendar-view-holidays-initially-flag nil)
16912 (timestr (format-time-string
16913 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16914 (prompt (concat (if prompt (concat prompt " ") "")
16915 (format "Date+time [%s]: " timestr)))
16916 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16918 (cond
16919 (from-string (setq ans from-string))
16920 (org-read-date-popup-calendar
16921 (save-excursion
16922 (save-window-excursion
16923 (calendar)
16924 (when (eq calendar-setup 'calendar-only)
16925 (setq cal-frame
16926 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16927 (select-frame cal-frame))
16928 (org-eval-in-calendar '(setq cursor-type nil) t)
16929 (unwind-protect
16930 (progn
16931 (calendar-forward-day (- (time-to-days org-def)
16932 (calendar-absolute-from-gregorian
16933 (calendar-current-date))))
16934 (org-eval-in-calendar nil t)
16935 (let* ((old-map (current-local-map))
16936 (map (copy-keymap calendar-mode-map))
16937 (minibuffer-local-map
16938 (copy-keymap org-read-date-minibuffer-local-map)))
16939 (org-defkey map (kbd "RET") 'org-calendar-select)
16940 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16941 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16942 (unwind-protect
16943 (progn
16944 (use-local-map map)
16945 (setq org-read-date-inactive inactive)
16946 (add-hook 'post-command-hook 'org-read-date-display)
16947 (setq org-ans0 (read-string prompt default-input
16948 'org-read-date-history nil))
16949 ;; org-ans0: from prompt
16950 ;; org-ans1: from mouse click
16951 ;; org-ans2: from calendar motion
16952 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16953 (remove-hook 'post-command-hook 'org-read-date-display)
16954 (use-local-map old-map)
16955 (when org-read-date-overlay
16956 (delete-overlay org-read-date-overlay)
16957 (setq org-read-date-overlay nil)))))
16958 (bury-buffer "*Calendar*")
16959 (when cal-frame
16960 (delete-frame cal-frame)
16961 (select-frame-set-input-focus cur-frame))))))
16963 (t ; Naked prompt only
16964 (unwind-protect
16965 (setq ans (read-string prompt default-input
16966 'org-read-date-history timestr))
16967 (when org-read-date-overlay
16968 (delete-overlay org-read-date-overlay)
16969 (setq org-read-date-overlay nil)))))
16971 (setq final (org-read-date-analyze ans org-def org-defdecode))
16973 (when org-read-date-analyze-forced-year
16974 (message "Year was forced into %s"
16975 (if org-read-date-force-compatible-dates
16976 "compatible range (1970-2037)"
16977 "range representable on this machine"))
16978 (ding))
16980 ;; One round trip to get rid of 34th of August and stuff like that....
16981 (setq final (decode-time (apply 'encode-time final)))
16983 (setq org-read-date-final-answer ans)
16985 (if to-time
16986 (apply 'encode-time final)
16987 (if (and (boundp 'org-time-was-given) org-time-was-given)
16988 (format "%04d-%02d-%02d %02d:%02d"
16989 (nth 5 final) (nth 4 final) (nth 3 final)
16990 (nth 2 final) (nth 1 final))
16991 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16993 (defun org-read-date-display ()
16994 "Display the current date prompt interpretation in the minibuffer."
16995 (when org-read-date-display-live
16996 (when org-read-date-overlay
16997 (delete-overlay org-read-date-overlay))
16998 (when (minibufferp (current-buffer))
16999 (save-excursion
17000 (end-of-line 1)
17001 (while (not (equal (buffer-substring
17002 (max (point-min) (- (point) 4)) (point))
17003 " "))
17004 (insert " ")))
17005 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
17006 " " (or org-ans1 org-ans2)))
17007 (org-end-time-was-given nil)
17008 (f (org-read-date-analyze ans org-def org-defdecode))
17009 (fmts (if org-dcst
17010 org-time-stamp-custom-formats
17011 org-time-stamp-formats))
17012 (fmt (if (or org-with-time
17013 (and (boundp 'org-time-was-given) org-time-was-given))
17014 (cdr fmts)
17015 (car fmts)))
17016 (txt (format-time-string fmt (apply 'encode-time f)))
17017 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
17018 (txt (concat "=> " txt)))
17019 (when (and org-end-time-was-given
17020 (string-match org-plain-time-of-day-regexp txt))
17021 (setq txt (concat (substring txt 0 (match-end 0)) "-"
17022 org-end-time-was-given
17023 (substring txt (match-end 0)))))
17024 (when org-read-date-analyze-futurep
17025 (setq txt (concat txt " (=>F)")))
17026 (setq org-read-date-overlay
17027 (make-overlay (1- (point-at-eol)) (point-at-eol)))
17028 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
17030 (defun org-read-date-analyze (ans org-def org-defdecode)
17031 "Analyze the combined answer of the date prompt."
17032 ;; FIXME: cleanup and comment
17033 ;; Pass `current-time' result to `decode-time' (instead of calling
17034 ;; without arguments) so that only `current-time' has to be
17035 ;; overriden in tests.
17036 (let ((nowdecode (decode-time (current-time)))
17037 delta deltan deltaw deltadef year month day
17038 hour minute second wday pm h2 m2 tl wday1
17039 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
17040 (setq org-read-date-analyze-futurep nil
17041 org-read-date-analyze-forced-year nil)
17042 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17043 (setq ans "+0"))
17045 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17046 (setq ans (replace-match "" t t ans)
17047 deltan (car delta)
17048 deltaw (nth 1 delta)
17049 deltadef (nth 2 delta)))
17051 ;; Check if there is an iso week date in there. If yes, store the
17052 ;; info and postpone interpreting it until the rest of the parsing
17053 ;; is done.
17054 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17055 (setq iso-year (if (match-end 1)
17056 (org-small-year-to-year
17057 (string-to-number (match-string 1 ans))))
17058 iso-weekday (if (match-end 3)
17059 (string-to-number (match-string 3 ans)))
17060 iso-week (string-to-number (match-string 2 ans)))
17061 (setq ans (replace-match "" t t ans)))
17063 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17064 (when (string-match
17065 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17066 (setq year (if (match-end 2)
17067 (string-to-number (match-string 2 ans))
17068 (progn (setq kill-year t)
17069 (string-to-number (format-time-string "%Y"))))
17070 month (string-to-number (match-string 3 ans))
17071 day (string-to-number (match-string 4 ans)))
17072 (if (< year 100) (setq year (+ 2000 year)))
17073 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17074 t nil ans)))
17076 ;; Help matching dotted european dates
17077 (when (string-match
17078 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17079 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17080 (setq kill-year t)
17081 (string-to-number (format-time-string "%Y")))
17082 day (string-to-number (match-string 1 ans))
17083 month (string-to-number (match-string 2 ans))
17084 ans (replace-match (format "%04d-%02d-%02d" year month day)
17085 t nil ans)))
17087 ;; Help matching american dates, like 5/30 or 5/30/7
17088 (when (string-match
17089 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17090 (setq year (if (match-end 4)
17091 (string-to-number (match-string 4 ans))
17092 (progn (setq kill-year t)
17093 (string-to-number (format-time-string "%Y"))))
17094 month (string-to-number (match-string 1 ans))
17095 day (string-to-number (match-string 2 ans)))
17096 (if (< year 100) (setq year (+ 2000 year)))
17097 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17098 t nil ans)))
17099 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17100 ;; If there is a time with am/pm, and *no* time without it, we convert
17101 ;; so that matching will be successful.
17102 (loop for i from 1 to 2 do ; twice, for end time as well
17103 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17104 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17105 (setq hour (string-to-number (match-string 1 ans))
17106 minute (if (match-end 3)
17107 (string-to-number (match-string 3 ans))
17109 pm (equal ?p
17110 (string-to-char (downcase (match-string 4 ans)))))
17111 (if (and (= hour 12) (not pm))
17112 (setq hour 0)
17113 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17114 (setq ans (replace-match (format "%02d:%02d" hour minute)
17115 t t ans))))
17117 ;; Check if a time range is given as a duration
17118 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17119 (setq hour (string-to-number (match-string 1 ans))
17120 h2 (+ hour (string-to-number (match-string 3 ans)))
17121 minute (string-to-number (match-string 2 ans))
17122 m2 (+ minute (if (match-end 5) (string-to-number
17123 (match-string 5 ans))0)))
17124 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17125 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17126 t t ans)))
17128 ;; Check if there is a time range
17129 (when (boundp 'org-end-time-was-given)
17130 (setq org-time-was-given nil)
17131 (when (and (string-match org-plain-time-of-day-regexp ans)
17132 (match-end 8))
17133 (setq org-end-time-was-given (match-string 8 ans))
17134 (setq ans (concat (substring ans 0 (match-beginning 7))
17135 (substring ans (match-end 7))))))
17137 (setq tl (parse-time-string ans)
17138 day (or (nth 3 tl) (nth 3 org-defdecode))
17139 month
17140 (cond ((nth 4 tl))
17141 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17142 ;; Day was specified. Make sure DAY+MONTH
17143 ;; combination happens in the future.
17144 ((nth 3 tl)
17145 (setq futurep t)
17146 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17147 (nth 4 nowdecode)))
17148 (t (nth 4 org-defdecode)))
17149 year
17150 (cond ((and (not kill-year) (nth 5 tl)))
17151 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17152 ;; Month was guessed in the future and is at least
17153 ;; equal to NOWDECODE's. Fix year accordingly.
17154 (futurep
17155 (if (or (> month (nth 4 nowdecode))
17156 (>= day (nth 3 nowdecode)))
17157 (nth 5 nowdecode)
17158 (1+ (nth 5 nowdecode))))
17159 ;; Month was specified. Make sure MONTH+YEAR
17160 ;; combination happens in the future.
17161 ((nth 4 tl)
17162 (setq futurep t)
17163 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17164 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17165 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17166 (t (nth 5 nowdecode))))
17167 (t (nth 5 org-defdecode)))
17168 hour (or (nth 2 tl) (nth 2 org-defdecode))
17169 minute (or (nth 1 tl) (nth 1 org-defdecode))
17170 second (or (nth 0 tl) 0)
17171 wday (nth 6 tl))
17173 (when (and (eq org-read-date-prefer-future 'time)
17174 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17175 (equal day (nth 3 nowdecode))
17176 (equal month (nth 4 nowdecode))
17177 (equal year (nth 5 nowdecode))
17178 (nth 2 tl)
17179 (or (< (nth 2 tl) (nth 2 nowdecode))
17180 (and (= (nth 2 tl) (nth 2 nowdecode))
17181 (nth 1 tl)
17182 (< (nth 1 tl) (nth 1 nowdecode)))))
17183 (setq day (1+ day)
17184 futurep t))
17186 ;; Special date definitions below
17187 (cond
17188 (iso-week
17189 ;; There was an iso week
17190 (require 'cal-iso)
17191 (setq futurep nil)
17192 (setq year (or iso-year year)
17193 day (or iso-weekday wday 1)
17194 wday nil ; to make sure that the trigger below does not match
17195 iso-date (calendar-gregorian-from-absolute
17196 (calendar-iso-to-absolute
17197 (list iso-week day year))))
17198 ; FIXME: Should we also push ISO weeks into the future?
17199 ; (when (and org-read-date-prefer-future
17200 ; (not iso-year)
17201 ; (< (calendar-absolute-from-gregorian iso-date)
17202 ; (time-to-days (current-time))))
17203 ; (setq year (1+ year)
17204 ; iso-date (calendar-gregorian-from-absolute
17205 ; (calendar-iso-to-absolute
17206 ; (list iso-week day year)))))
17207 (setq month (car iso-date)
17208 year (nth 2 iso-date)
17209 day (nth 1 iso-date)))
17210 (deltan
17211 (setq futurep nil)
17212 (unless deltadef
17213 ;; Pass `current-time' result to `decode-time' (instead of
17214 ;; calling without arguments) so that only `current-time' has
17215 ;; to be overriden in tests.
17216 (let ((now (decode-time (current-time))))
17217 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17218 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17219 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17220 ((equal deltaw "m") (setq month (+ month deltan)))
17221 ((equal deltaw "y") (setq year (+ year deltan)))))
17222 ((and wday (not (nth 3 tl)))
17223 ;; Weekday was given, but no day, so pick that day in the week
17224 ;; on or after the derived date.
17225 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17226 (unless (equal wday wday1)
17227 (setq day (+ day (% (- wday wday1 -7) 7))))))
17228 (if (and (boundp 'org-time-was-given)
17229 (nth 2 tl))
17230 (setq org-time-was-given t))
17231 (if (< year 100) (setq year (+ 2000 year)))
17232 ;; Check of the date is representable
17233 (if org-read-date-force-compatible-dates
17234 (progn
17235 (if (< year 1970)
17236 (setq year 1970 org-read-date-analyze-forced-year t))
17237 (if (> year 2037)
17238 (setq year 2037 org-read-date-analyze-forced-year t)))
17239 (condition-case nil
17240 (ignore (encode-time second minute hour day month year))
17241 (error
17242 (setq year (nth 5 org-defdecode))
17243 (setq org-read-date-analyze-forced-year t))))
17244 (setq org-read-date-analyze-futurep futurep)
17245 (list second minute hour day month year)))
17247 (defvar parse-time-weekdays)
17248 (defun org-read-date-get-relative (s today default)
17249 "Check string S for special relative date string.
17250 TODAY and DEFAULT are internal times, for today and for a default.
17251 Return shift list (N what def-flag)
17252 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17253 N is the number of WHATs to shift.
17254 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17255 the DEFAULT date rather than TODAY."
17256 (require 'parse-time)
17257 (when (and
17258 (string-match
17259 (concat
17260 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17261 "\\([0-9]+\\)?"
17262 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17263 "\\([ \t]\\|$\\)") s)
17264 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17265 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17266 (string-to-char (substring (match-string 1 s) -1))
17267 ?+))
17268 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17269 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17270 (what (if (match-end 3) (match-string 3 s) "d"))
17271 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17272 (date (if rel default today))
17273 (wday (nth 6 (decode-time date)))
17274 delta)
17275 (if wday1
17276 (progn
17277 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17278 (if (= delta 0) (setq delta 7))
17279 (if (= dir ?-)
17280 (progn
17281 (setq delta (- delta 7))
17282 (if (= delta 0) (setq delta -7))))
17283 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17284 (list delta "d" rel))
17285 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17287 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17288 "Turn a user-specified date into the internal representation.
17289 The internal representation needed by the calendar is (month day year).
17290 This is a wrapper to handle the brain-dead convention in calendar that
17291 user function argument order change dependent on argument order."
17292 (if (boundp 'calendar-date-style)
17293 (cond
17294 ((eq calendar-date-style 'american)
17295 (list arg1 arg2 arg3))
17296 ((eq calendar-date-style 'european)
17297 (list arg2 arg1 arg3))
17298 ((eq calendar-date-style 'iso)
17299 (list arg2 arg3 arg1)))
17300 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17301 (if (org-bound-and-true-p european-calendar-style)
17302 (list arg2 arg1 arg3)
17303 (list arg1 arg2 arg3)))))
17305 (defun org-eval-in-calendar (form &optional keepdate)
17306 "Eval FORM in the calendar window and return to current window.
17307 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17308 otherwise stick to the current value of `org-ans2'."
17309 (let ((sf (selected-frame))
17310 (sw (selected-window)))
17311 (select-window (get-buffer-window "*Calendar*" t))
17312 (eval form)
17313 (when (and (not keepdate) (calendar-cursor-to-date))
17314 (let* ((date (calendar-cursor-to-date))
17315 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17316 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17317 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17318 (select-window sw)
17319 (org-select-frame-set-input-focus sf)))
17321 (defun org-calendar-select ()
17322 "Return to `org-read-date' with the date currently selected.
17323 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17324 (interactive)
17325 (when (calendar-cursor-to-date)
17326 (let* ((date (calendar-cursor-to-date))
17327 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17328 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17329 (if (active-minibuffer-window) (exit-minibuffer))))
17331 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17332 "Insert a date stamp for the date given by the internal TIME.
17333 See `format-time-string' for the format of TIME.
17334 WITH-HM means use the stamp format that includes the time of the day.
17335 INACTIVE means use square brackets instead of angular ones, so that the
17336 stamp will not contribute to the agenda.
17337 PRE and POST are optional strings to be inserted before and after the
17338 stamp.
17339 The command returns the inserted time stamp."
17340 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17341 stamp)
17342 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17343 (insert-before-markers (or pre ""))
17344 (when (listp extra)
17345 (setq extra (car extra))
17346 (if (and (stringp extra)
17347 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17348 (setq extra (format "-%02d:%02d"
17349 (string-to-number (match-string 1 extra))
17350 (string-to-number (match-string 2 extra))))
17351 (setq extra nil)))
17352 (when extra
17353 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17354 (insert-before-markers (setq stamp (format-time-string fmt time)))
17355 (insert-before-markers (or post ""))
17356 (setq org-last-inserted-timestamp stamp)))
17358 (defun org-toggle-time-stamp-overlays ()
17359 "Toggle the use of custom time stamp formats."
17360 (interactive)
17361 (setq org-display-custom-times (not org-display-custom-times))
17362 (unless org-display-custom-times
17363 (let ((p (point-min)) (bmp (buffer-modified-p)))
17364 (while (setq p (next-single-property-change p 'display))
17365 (if (and (get-text-property p 'display)
17366 (eq (get-text-property p 'face) 'org-date))
17367 (remove-text-properties
17368 p (setq p (next-single-property-change p 'display))
17369 '(display t))))
17370 (set-buffer-modified-p bmp)))
17371 (if (featurep 'xemacs)
17372 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17373 (org-restart-font-lock)
17374 (setq org-table-may-need-update t)
17375 (if org-display-custom-times
17376 (message "Time stamps are overlaid with custom format")
17377 (message "Time stamp overlays removed")))
17379 (defun org-display-custom-time (beg end)
17380 "Overlay modified time stamp format over timestamp between BEG and END."
17381 (let* ((ts (buffer-substring beg end))
17382 t1 w1 with-hm tf time str w2 (off 0))
17383 (save-match-data
17384 (setq t1 (org-parse-time-string ts t))
17385 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17386 (setq off (- (match-end 0) (match-beginning 0)))))
17387 (setq end (- end off))
17388 (setq w1 (- end beg)
17389 with-hm (and (nth 1 t1) (nth 2 t1))
17390 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17391 time (org-fix-decoded-time t1)
17392 str (org-add-props
17393 (format-time-string
17394 (substring tf 1 -1) (apply 'encode-time time))
17395 nil 'mouse-face 'highlight)
17396 w2 (length str))
17397 (if (not (= w2 w1))
17398 (add-text-properties (1+ beg) (+ 2 beg)
17399 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17400 (if (featurep 'xemacs)
17401 (progn
17402 (put-text-property beg end 'invisible t)
17403 (put-text-property beg end 'end-glyph (make-glyph str)))
17404 (put-text-property beg end 'display str))))
17406 (defun org-fix-decoded-time (time)
17407 "Set 0 instead of nil for the first 6 elements of time.
17408 Don't touch the rest."
17409 (let ((n 0))
17410 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17412 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17414 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17415 "Difference between TIMESTAMP-STRING and now in days.
17416 If SECONDS is non-nil, return the difference in seconds."
17417 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17418 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17419 (funcall fdiff (current-time)))))
17421 (defun org-deadline-close (timestamp-string &optional ndays)
17422 "Is the time in TIMESTAMP-STRING close to the current date?"
17423 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17424 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17425 (not (org-entry-is-done-p))))
17427 (defun org-get-wdays (ts &optional delay zero-delay)
17428 "Get the deadline lead time appropriate for timestring TS.
17429 When DELAY is non-nil, get the delay time for scheduled items
17430 instead of the deadline lead time. When ZERO-DELAY is non-nil
17431 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17432 don't try to find the delay cookie in the scheduled timestamp."
17433 (let ((tv (if delay org-scheduled-delay-days
17434 org-deadline-warning-days)))
17435 (cond
17436 ((or (and delay (< tv 0))
17437 (and delay zero-delay (<= tv 0))
17438 (and (not delay) (<= tv 0)))
17439 ;; Enforce this value no matter what
17440 (- tv))
17441 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17442 ;; lead time is specified.
17443 (floor (* (string-to-number (match-string 1 ts))
17444 (cdr (assoc (match-string 2 ts)
17445 '(("d" . 1) ("w" . 7)
17446 ("m" . 30.4) ("y" . 365.25)
17447 ("h" . 0.041667)))))))
17448 ;; go for the default.
17449 (t tv))))
17451 (defun org-calendar-select-mouse (ev)
17452 "Return to `org-read-date' with the date currently selected.
17453 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17454 (interactive "e")
17455 (mouse-set-point ev)
17456 (when (calendar-cursor-to-date)
17457 (let* ((date (calendar-cursor-to-date))
17458 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17459 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17460 (if (active-minibuffer-window) (exit-minibuffer))))
17462 (defun org-check-deadlines (ndays)
17463 "Check if there are any deadlines due or past due.
17464 A deadline is considered due if it happens within `org-deadline-warning-days'
17465 days from today's date. If the deadline appears in an entry marked DONE,
17466 it is not shown. The prefix arg NDAYS can be used to test that many
17467 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17468 (interactive "P")
17469 (let* ((org-warn-days
17470 (cond
17471 ((equal ndays '(4)) 100000)
17472 (ndays (prefix-numeric-value ndays))
17473 (t (abs org-deadline-warning-days))))
17474 (case-fold-search nil)
17475 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17476 (callback
17477 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17478 (message "%d deadlines past-due or due within %d days"
17479 (org-occur regexp nil callback)
17480 org-warn-days)))
17482 (defsubst org-re-timestamp (type)
17483 "Return a regexp for timestamp TYPE.
17484 Allowed values for TYPE are:
17486 all: all timestamps
17487 active: only active timestamps (<...>)
17488 inactive: only inactive timestamps ([...])
17489 scheduled: only scheduled timestamps
17490 deadline: only deadline timestamps
17491 closed: only closed time-stamps
17493 When TYPE is nil, fall back on returning a regexp that matches
17494 both scheduled and deadline timestamps."
17495 (case type
17496 (all org-ts-regexp-both)
17497 (active org-ts-regexp)
17498 (inactive org-ts-regexp-inactive)
17499 (scheduled org-scheduled-time-regexp)
17500 (deadline org-deadline-time-regexp)
17501 (closed org-closed-time-regexp)
17502 (otherwise
17503 (concat "\\<"
17504 (regexp-opt (list org-deadline-string org-scheduled-string))
17505 " *<\\([^>]+\\)>"))))
17507 (defun org-check-before-date (date)
17508 "Check if there are deadlines or scheduled entries before DATE."
17509 (interactive (list (org-read-date)))
17510 (let ((case-fold-search nil)
17511 (regexp (org-re-timestamp org-ts-type))
17512 (callback
17513 `(lambda ()
17514 (let ((match (match-string 1)))
17515 (and ,(if (memq org-ts-type '(active inactive all))
17516 '(eq (org-element-type (org-element-context)) 'timestamp)
17517 '(org-at-planning-p))
17518 (time-less-p
17519 (org-time-string-to-time match)
17520 (org-time-string-to-time date)))))))
17521 (message "%d entries before %s"
17522 (org-occur regexp nil callback) date)))
17524 (defun org-check-after-date (date)
17525 "Check if there are deadlines or scheduled entries after DATE."
17526 (interactive (list (org-read-date)))
17527 (let ((case-fold-search nil)
17528 (regexp (org-re-timestamp org-ts-type))
17529 (callback
17530 `(lambda ()
17531 (let ((match (match-string 1)))
17532 (and ,(if (memq org-ts-type '(active inactive all))
17533 '(eq (org-element-type (org-element-context)) 'timestamp)
17534 '(org-at-planning-p))
17535 (not (time-less-p
17536 (org-time-string-to-time match)
17537 (org-time-string-to-time date))))))))
17538 (message "%d entries after %s"
17539 (org-occur regexp nil callback) date)))
17541 (defun org-check-dates-range (start-date end-date)
17542 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17543 (interactive (list (org-read-date nil nil nil "Range starts")
17544 (org-read-date nil nil nil "Range end")))
17545 (let ((case-fold-search nil)
17546 (regexp (org-re-timestamp org-ts-type))
17547 (callback
17548 `(lambda ()
17549 (let ((match (match-string 1)))
17550 (and
17551 ,(if (memq org-ts-type '(active inactive all))
17552 '(eq (org-element-type (org-element-context)) 'timestamp)
17553 '(org-at-planning-p))
17554 (not (time-less-p
17555 (org-time-string-to-time match)
17556 (org-time-string-to-time start-date)))
17557 (time-less-p
17558 (org-time-string-to-time match)
17559 (org-time-string-to-time end-date)))))))
17560 (message "%d entries between %s and %s"
17561 (org-occur regexp nil callback) start-date end-date)))
17563 (defun org-evaluate-time-range (&optional to-buffer)
17564 "Evaluate a time range by computing the difference between start and end.
17565 Normally the result is just printed in the echo area, but with prefix arg
17566 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17567 If the time range is actually in a table, the result is inserted into the
17568 next column.
17569 For time difference computation, a year is assumed to be exactly 365
17570 days in order to avoid rounding problems."
17571 (interactive "P")
17573 (org-clock-update-time-maybe)
17574 (save-excursion
17575 (unless (org-at-date-range-p t)
17576 (goto-char (point-at-bol))
17577 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17578 (if (not (org-at-date-range-p t))
17579 (user-error "Not at a time-stamp range, and none found in current line")))
17580 (let* ((ts1 (match-string 1))
17581 (ts2 (match-string 2))
17582 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17583 (match-end (match-end 0))
17584 (time1 (org-time-string-to-time ts1))
17585 (time2 (org-time-string-to-time ts2))
17586 (t1 (org-float-time time1))
17587 (t2 (org-float-time time2))
17588 (diff (abs (- t2 t1)))
17589 (negative (< (- t2 t1) 0))
17590 ;; (ys (floor (* 365 24 60 60)))
17591 (ds (* 24 60 60))
17592 (hs (* 60 60))
17593 (fy "%dy %dd %02d:%02d")
17594 (fy1 "%dy %dd")
17595 (fd "%dd %02d:%02d")
17596 (fd1 "%dd")
17597 (fh "%02d:%02d")
17598 y d h m align)
17599 (if havetime
17600 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17602 d (floor (/ diff ds)) diff (mod diff ds)
17603 h (floor (/ diff hs)) diff (mod diff hs)
17604 m (floor (/ diff 60)))
17605 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17607 d (floor (+ (/ diff ds) 0.5))
17608 h 0 m 0))
17609 (if (not to-buffer)
17610 (message "%s" (org-make-tdiff-string y d h m))
17611 (if (org-at-table-p)
17612 (progn
17613 (goto-char match-end)
17614 (setq align t)
17615 (and (looking-at " *|") (goto-char (match-end 0))))
17616 (goto-char match-end))
17617 (if (looking-at
17618 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17619 (replace-match ""))
17620 (if negative (insert " -"))
17621 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17622 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17623 (insert " " (format fh h m))))
17624 (if align (org-table-align))
17625 (message "Time difference inserted")))))
17627 (defun org-make-tdiff-string (y d h m)
17628 (let ((fmt "")
17629 (l nil))
17630 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17631 l (push y l)))
17632 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17633 l (push d l)))
17634 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17635 l (push h l)))
17636 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17637 l (push m l)))
17638 (apply 'format fmt (nreverse l))))
17640 (defun org-time-string-to-time (s &optional buffer pos)
17641 "Convert a timestamp string into internal time."
17642 (condition-case errdata
17643 (apply 'encode-time (org-parse-time-string s))
17644 (error (error "Bad timestamp `%s'%s\nError was: %s"
17645 s (if (not (and buffer pos))
17647 (format-message " at %d in buffer `%s'" pos buffer))
17648 (cdr errdata)))))
17650 (defun org-time-string-to-seconds (s)
17651 "Convert a timestamp string to a number of seconds."
17652 (org-float-time (org-time-string-to-time s)))
17654 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17655 "Convert a time stamp to an absolute day number.
17656 If there is a specifier for a cyclic time stamp, get the closest
17657 date to DAYNR.
17658 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17659 The variable `date' is bound by the calendar when this is called."
17660 (cond
17661 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17662 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17663 daynr
17664 (+ daynr 1000)))
17665 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17666 (> (string-to-number (match-string 1 s)) 0))
17667 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17668 (time-to-days (current-time))) (match-string 0 s)
17669 prefer show-all))
17670 (t (time-to-days
17671 (condition-case errdata
17672 (apply 'encode-time (org-parse-time-string s))
17673 (error (error "Bad timestamp `%s'%s\nError was: %s"
17674 s (if (not (and buffer pos))
17676 (format-message " at %d in buffer `%s'" pos buffer))
17677 (cdr errdata))))))))
17679 (defun org-days-to-iso-week (days)
17680 "Return the iso week number."
17681 (require 'cal-iso)
17682 (car (calendar-iso-from-absolute days)))
17684 (defun org-small-year-to-year (year)
17685 "Convert 2-digit years into 4-digit years.
17686 YEAR is expanded into one of the 30 next years, if possible, or
17687 into a past one. Any year larger than 99 is returned unchanged."
17688 (if (>= year 100) year
17689 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17690 (century (/ current 100))
17691 (offset (- year (% current 100))))
17692 (cond ((> offset 30) (+ (* (1- century) 100) year))
17693 ((> offset -70) (+ (* century 100) year))
17694 (t (+ (* (1+ century) 100) year))))))
17696 (defun org-time-from-absolute (d)
17697 "Return the time corresponding to date D.
17698 D may be an absolute day number, or a calendar-type list (month day year)."
17699 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17700 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17702 (defun org-calendar-holiday ()
17703 "List of holidays, for Diary display in Org-mode."
17704 (require 'holidays)
17705 (let ((hl (funcall
17706 (if (fboundp 'calendar-check-holidays)
17707 'calendar-check-holidays 'check-calendar-holidays) date)))
17708 (if hl (mapconcat 'identity hl "; "))))
17710 (defun org-diary-sexp-entry (sexp entry date)
17711 "Process a SEXP diary ENTRY for DATE."
17712 (require 'diary-lib)
17713 (let ((result (if calendar-debug-sexp
17714 (let ((stack-trace-on-error t))
17715 (eval (car (read-from-string sexp))))
17716 (condition-case nil
17717 (eval (car (read-from-string sexp)))
17718 (error
17719 (beep)
17720 (message "Bad sexp at line %d in %s: %s"
17721 (org-current-line)
17722 (buffer-file-name) sexp)
17723 (sleep-for 2))))))
17724 (cond ((stringp result) (split-string result "; "))
17725 ((and (consp result)
17726 (not (consp (cdr result)))
17727 (stringp (cdr result))) (cdr result))
17728 ((and (consp result)
17729 (stringp (car result))) result)
17730 (result entry))))
17732 (defun org-diary-to-ical-string (frombuf)
17733 "Get iCalendar entries from diary entries in buffer FROMBUF.
17734 This uses the icalendar.el library."
17735 (let* ((tmpdir (if (featurep 'xemacs)
17736 (temp-directory)
17737 temporary-file-directory))
17738 (tmpfile (make-temp-name
17739 (expand-file-name "orgics" tmpdir)))
17740 buf rtn b e)
17741 (with-current-buffer frombuf
17742 (icalendar-export-region (point-min) (point-max) tmpfile)
17743 (setq buf (find-buffer-visiting tmpfile))
17744 (set-buffer buf)
17745 (goto-char (point-min))
17746 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17747 (setq b (match-beginning 0)))
17748 (goto-char (point-max))
17749 (if (re-search-backward "^END:VEVENT" nil t)
17750 (setq e (match-end 0)))
17751 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17752 (kill-buffer buf)
17753 (delete-file tmpfile)
17754 rtn))
17756 (defun org-closest-date (start current change prefer show-all)
17757 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17758 When PREFER is `past', return a date that is either CURRENT or past.
17759 When PREFER is `future', return a date that is either CURRENT or future.
17760 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17761 ;; Make the proper lists from the dates
17762 (catch 'exit
17763 (let ((a1 '(("h" . hour)
17764 ("d" . day)
17765 ("w" . week)
17766 ("m" . month)
17767 ("y" . year)))
17768 (shour (nth 2 (org-parse-time-string start)))
17769 dn dw sday cday n1 n2 n0
17770 d m y y1 y2 date1 date2 nmonths nm ny m2)
17772 (setq start (org-date-to-gregorian start)
17773 current (org-date-to-gregorian
17774 (if show-all
17775 current
17776 (time-to-days (current-time))))
17777 sday (calendar-absolute-from-gregorian start)
17778 cday (calendar-absolute-from-gregorian current))
17780 (if (<= cday sday) (throw 'exit sday))
17782 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17783 (setq dn (string-to-number (match-string 1 change))
17784 dw (cdr (assoc (match-string 2 change) a1))))
17785 (unless (and dn (> dn 0))
17786 (user-error "Invalid change specifier: %s" change))
17787 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17788 (cond
17789 ((eq dw 'hour)
17790 (let ((missing-hours
17791 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17792 dn)))
17793 (setq n1 (if (zerop missing-hours) cday
17794 (- cday (1+ (floor (/ missing-hours 24)))))
17795 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17796 ((eq dw 'day)
17797 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17798 n2 (+ n1 dn)))
17799 ((eq dw 'year)
17800 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17801 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17802 (setq date1 (list m d y1)
17803 n1 (calendar-absolute-from-gregorian date1)
17804 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17805 n2 (calendar-absolute-from-gregorian date2)))
17806 ((eq dw 'month)
17807 ;; approx number of month between the two dates
17808 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17809 ;; How often does dn fit in there?
17810 (setq d (nth 1 start) m (car start) y (nth 2 start)
17811 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17812 m (+ m nm)
17813 ny (floor (/ m 12))
17814 y (+ y ny)
17815 m (- m (* ny 12)))
17816 (while (> m 12) (setq m (- m 12) y (1+ y)))
17817 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17818 (setq m2 (+ m dn) y2 y)
17819 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17820 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17821 (while (<= n2 cday)
17822 (setq n1 n2 m m2 y y2)
17823 (setq m2 (+ m dn) y2 y)
17824 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17825 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17826 ;; Make sure n1 is the earlier date
17827 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17828 (if show-all
17829 (cond
17830 ((eq prefer 'past) (if (= cday n2) n2 n1))
17831 ((eq prefer 'future) (if (= cday n1) n1 n2))
17832 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17833 (cond
17834 ((eq prefer 'past) (if (= cday n2) n2 n1))
17835 ((eq prefer 'future) (if (= cday n1) n1 n2))
17836 (t (if (= cday n1) n1 n2)))))))
17838 (defun org-date-to-gregorian (date)
17839 "Turn any specification of DATE into a Gregorian date for the calendar."
17840 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17841 ((and (listp date) (= (length date) 3)) date)
17842 ((stringp date)
17843 (setq date (org-parse-time-string date))
17844 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17845 ((listp date)
17846 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17848 (defun org-parse-time-string (s &optional nodefault)
17849 "Parse the standard Org-mode time string.
17850 This should be a lot faster than the normal `parse-time-string'.
17851 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17852 hour and minute fields will be nil if not given."
17853 (cond ((string-match org-ts-regexp0 s)
17854 (list 0
17855 (if (or (match-beginning 8) (not nodefault))
17856 (string-to-number (or (match-string 8 s) "0")))
17857 (if (or (match-beginning 7) (not nodefault))
17858 (string-to-number (or (match-string 7 s) "0")))
17859 (string-to-number (match-string 4 s))
17860 (string-to-number (match-string 3 s))
17861 (string-to-number (match-string 2 s))
17862 nil nil nil))
17863 ((string-match "^<[^>]+>$" s)
17864 (decode-time (seconds-to-time (org-matcher-time s))))
17865 (t (error "Not a standard Org-mode time string: %s" s))))
17867 (defun org-timestamp-up (&optional arg)
17868 "Increase the date item at the cursor by one.
17869 If the cursor is on the year, change the year. If it is on the month,
17870 the day or the time, change that.
17871 With prefix ARG, change by that many units."
17872 (interactive "p")
17873 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17875 (defun org-timestamp-down (&optional arg)
17876 "Decrease the date item at the cursor by one.
17877 If the cursor is on the year, change the year. If it is on the month,
17878 the day or the time, change that.
17879 With prefix ARG, change by that many units."
17880 (interactive "p")
17881 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17883 (defun org-timestamp-up-day (&optional arg)
17884 "Increase the date in the time stamp by one day.
17885 With prefix ARG, change that many days."
17886 (interactive "p")
17887 (if (and (not (org-at-timestamp-p t))
17888 (org-at-heading-p))
17889 (org-todo 'up)
17890 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17892 (defun org-timestamp-down-day (&optional arg)
17893 "Decrease the date in the time stamp by one day.
17894 With prefix ARG, change that many days."
17895 (interactive "p")
17896 (if (and (not (org-at-timestamp-p t))
17897 (org-at-heading-p))
17898 (org-todo 'down)
17899 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17901 (defun org-at-timestamp-p (&optional inactive-ok)
17902 "Non-nil if point is inside a timestamp.
17904 When optional argument INACTIVE-OK is non-nil, also consider
17905 inactive timestamps.
17907 When this function returns a non-nil value, match data is set
17908 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
17909 INACTIVE-OK."
17910 (interactive)
17911 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17912 (pos (point))
17913 (ans (or (looking-at tsr)
17914 (save-excursion
17915 (skip-chars-backward "^[<\n\r\t")
17916 (if (> (point) (point-min)) (backward-char 1))
17917 (and (looking-at tsr)
17918 (> (- (match-end 0) pos) -1))))))
17919 (and ans
17920 (boundp 'org-ts-what)
17921 (setq org-ts-what
17922 (cond
17923 ((= pos (match-beginning 0)) 'bracket)
17924 ;; Point is considered to be "on the bracket" whether
17925 ;; it's really on it or right after it.
17926 ((= pos (1- (match-end 0))) 'bracket)
17927 ((= pos (match-end 0)) 'after)
17928 ((org-pos-in-match-range pos 2) 'year)
17929 ((org-pos-in-match-range pos 3) 'month)
17930 ((org-pos-in-match-range pos 7) 'hour)
17931 ((org-pos-in-match-range pos 8) 'minute)
17932 ((or (org-pos-in-match-range pos 4)
17933 (org-pos-in-match-range pos 5)) 'day)
17934 ((and (> pos (or (match-end 8) (match-end 5)))
17935 (< pos (match-end 0)))
17936 (- pos (or (match-end 8) (match-end 5))))
17937 (t 'day))))
17938 ans))
17940 (defun org-toggle-timestamp-type ()
17941 "Toggle the type (<active> or [inactive]) of a time stamp."
17942 (interactive)
17943 (when (org-at-timestamp-p t)
17944 (let ((beg (match-beginning 0)) (end (match-end 0))
17945 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17946 (save-excursion
17947 (goto-char beg)
17948 (while (re-search-forward "[][<>]" end t)
17949 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17950 t t)))
17951 (message "Timestamp is now %sactive"
17952 (if (equal (char-after beg) ?<) "" "in")))))
17954 (defun org-at-clock-log-p nil
17955 "Is the cursor on the clock log line?"
17956 (save-excursion
17957 (move-beginning-of-line 1)
17958 (looking-at org-clock-line-re)))
17960 (defvar org-clock-history) ; defined in org-clock.el
17961 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17962 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17963 "Change the date in the time stamp at point.
17964 The date will be changed by N times WHAT. WHAT can be `day', `month',
17965 `year', `minute', `second'. If WHAT is not given, the cursor position
17966 in the timestamp determines what will be changed.
17967 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17968 (let ((origin (point)) origin-cat
17969 with-hm inactive
17970 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17971 org-ts-what
17972 extra rem
17973 ts time time0 fixnext clrgx)
17974 (if (not (org-at-timestamp-p t))
17975 (user-error "Not at a timestamp"))
17976 (if (and (not what) (eq org-ts-what 'bracket))
17977 (org-toggle-timestamp-type)
17978 ;; Point isn't on brackets. Remember the part of the time-stamp
17979 ;; the point was in. Indeed, size of time-stamps may change,
17980 ;; but point must be kept in the same category nonetheless.
17981 (setq origin-cat org-ts-what)
17982 (if (and (not what) (not (eq org-ts-what 'day))
17983 org-display-custom-times
17984 (get-text-property (point) 'display)
17985 (not (get-text-property (1- (point)) 'display)))
17986 (setq org-ts-what 'day))
17987 (setq org-ts-what (or what org-ts-what)
17988 inactive (= (char-after (match-beginning 0)) ?\[)
17989 ts (match-string 0))
17990 (replace-match "")
17991 (when (string-match
17992 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17994 (setq extra (match-string 1 ts))
17995 (if suppress-tmp-delay
17996 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17997 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17998 (setq with-hm t))
17999 (setq time0 (org-parse-time-string ts))
18000 (when (and updown
18001 (eq org-ts-what 'minute)
18002 (not current-prefix-arg))
18003 ;; This looks like s-up and s-down. Change by one rounding step.
18004 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
18005 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
18006 (setcar (cdr time0) (+ (nth 1 time0)
18007 (if (> n 0) (- rem) (- dm rem))))))
18008 (setq time
18009 (encode-time (or (car time0) 0)
18010 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
18011 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
18012 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
18013 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
18014 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
18015 (nthcdr 6 time0)))
18016 (when (and (member org-ts-what '(hour minute))
18017 extra
18018 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
18019 (setq extra (org-modify-ts-extra
18020 extra
18021 (if (eq org-ts-what 'hour) 2 5)
18022 n dm)))
18023 (when (integerp org-ts-what)
18024 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
18025 (if (eq what 'calendar)
18026 (let ((cal-date (org-get-date-from-calendar)))
18027 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
18028 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
18029 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
18030 (setcar time0 (or (car time0) 0))
18031 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18032 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18033 (setq time (apply 'encode-time time0))))
18034 ;; Insert the new time-stamp, and ensure point stays in the same
18035 ;; category as before (i.e. not after the last position in that
18036 ;; category).
18037 (let ((pos (point)))
18038 ;; Stay before inserted string. `save-excursion' is of no use.
18039 (setq org-last-changed-timestamp
18040 (org-insert-time-stamp time with-hm inactive nil nil extra))
18041 (goto-char pos))
18042 (save-match-data
18043 (looking-at org-ts-regexp3)
18044 (goto-char (cond
18045 ;; `day' category ends before `hour' if any, or at
18046 ;; the end of the day name.
18047 ((eq origin-cat 'day)
18048 (min (or (match-beginning 7) (1- (match-end 5))) origin))
18049 ((eq origin-cat 'hour) (min (match-end 7) origin))
18050 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
18051 ((integerp origin-cat) (min (1- (match-end 0)) origin))
18052 ;; `year' and `month' have both fixed size: point
18053 ;; couldn't have moved into another part.
18054 (t origin))))
18055 ;; Update clock if on a CLOCK line.
18056 (org-clock-update-time-maybe)
18057 ;; Maybe adjust the closest clock in `org-clock-history'
18058 (when org-clock-adjust-closest
18059 (if (not (and (org-at-clock-log-p)
18060 (< 1 (length (delq nil (mapcar 'marker-position
18061 org-clock-history))))))
18062 (message "No clock to adjust")
18063 (cond ((save-excursion ; fix previous clock?
18064 (re-search-backward org-ts-regexp0 nil t)
18065 (org-looking-back (concat org-clock-string " \\[")))
18066 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18067 ((save-excursion ; fix next clock?
18068 (re-search-backward org-ts-regexp0 nil t)
18069 (looking-at (concat org-ts-regexp0 "\\] =>")))
18070 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18071 (save-window-excursion
18072 ;; Find closest clock to point, adjust the previous/next one in history
18073 (let* ((p (save-excursion (org-back-to-heading t)))
18074 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18075 (clfixnth
18076 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18077 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18078 (if (not clfixpos)
18079 (message "No clock to adjust")
18080 (save-excursion
18081 (org-goto-marker-or-bmk clfixpos)
18082 (org-show-subtree)
18083 (when (re-search-forward clrgx nil t)
18084 (goto-char (match-beginning 1))
18085 (let (org-clock-adjust-closest)
18086 (org-timestamp-change n org-ts-what updown))
18087 (message "Clock adjusted in %s for heading: %s"
18088 (file-name-nondirectory (buffer-file-name))
18089 (org-get-heading t t)))))))))
18090 ;; Try to recenter the calendar window, if any.
18091 (if (and org-calendar-follow-timestamp-change
18092 (get-buffer-window "*Calendar*" t)
18093 (memq org-ts-what '(day month year)))
18094 (org-recenter-calendar (time-to-days time))))))
18096 (defun org-modify-ts-extra (s pos n dm)
18097 "Change the different parts of the lead-time and repeat fields in timestamp."
18098 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18099 ng h m new rem)
18100 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18101 (cond
18102 ((or (org-pos-in-match-range pos 2)
18103 (org-pos-in-match-range pos 3))
18104 (setq m (string-to-number (match-string 3 s))
18105 h (string-to-number (match-string 2 s)))
18106 (if (org-pos-in-match-range pos 2)
18107 (setq h (+ h n))
18108 (setq n (* dm (org-no-warnings (signum n))))
18109 (when (not (= 0 (setq rem (% m dm))))
18110 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18111 (setq m (+ m n)))
18112 (if (< m 0) (setq m (+ m 60) h (1- h)))
18113 (if (> m 59) (setq m (- m 60) h (1+ h)))
18114 (setq h (min 24 (max 0 h)))
18115 (setq ng 1 new (format "-%02d:%02d" h m)))
18116 ((org-pos-in-match-range pos 6)
18117 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18118 ((org-pos-in-match-range pos 5)
18119 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18121 ((org-pos-in-match-range pos 9)
18122 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18123 ((org-pos-in-match-range pos 8)
18124 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18126 (when ng
18127 (setq s (concat
18128 (substring s 0 (match-beginning ng))
18130 (substring s (match-end ng))))))
18133 (defun org-recenter-calendar (date)
18134 "If the calendar is visible, recenter it to DATE."
18135 (let ((cwin (get-buffer-window "*Calendar*" t)))
18136 (when cwin
18137 (let ((calendar-move-hook nil))
18138 (with-selected-window cwin
18139 (calendar-goto-date (if (listp date) date
18140 (calendar-gregorian-from-absolute date))))))))
18142 (defun org-goto-calendar (&optional arg)
18143 "Go to the Emacs calendar at the current date.
18144 If there is a time stamp in the current line, go to that date.
18145 A prefix ARG can be used to force the current date."
18146 (interactive "P")
18147 (let ((tsr org-ts-regexp) diff
18148 (calendar-move-hook nil)
18149 (calendar-view-holidays-initially-flag nil)
18150 (calendar-view-diary-initially-flag nil))
18151 (if (or (org-at-timestamp-p)
18152 (save-excursion
18153 (beginning-of-line 1)
18154 (looking-at (concat ".*" tsr))))
18155 (let ((d1 (time-to-days (current-time)))
18156 (d2 (time-to-days
18157 (org-time-string-to-time (match-string 1)))))
18158 (setq diff (- d2 d1))))
18159 (calendar)
18160 (calendar-goto-today)
18161 (if (and diff (not arg)) (calendar-forward-day diff))))
18163 (defun org-get-date-from-calendar ()
18164 "Return a list (month day year) of date at point in calendar."
18165 (with-current-buffer "*Calendar*"
18166 (save-match-data
18167 (calendar-cursor-to-date))))
18169 (defun org-date-from-calendar ()
18170 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18171 If there is already a time stamp at the cursor position, update it."
18172 (interactive)
18173 (if (org-at-timestamp-p t)
18174 (org-timestamp-change 0 'calendar)
18175 (let ((cal-date (org-get-date-from-calendar)))
18176 (org-insert-time-stamp
18177 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18179 (defcustom org-effort-durations
18180 `(("min" . 1)
18181 ("h" . 60)
18182 ("d" . ,(* 60 8))
18183 ("w" . ,(* 60 8 5))
18184 ("m" . ,(* 60 8 5 4))
18185 ("y" . ,(* 60 8 5 40)))
18186 "Conversion factor to minutes for an effort modifier.
18188 Each entry has the form (MODIFIER . MINUTES).
18190 In an effort string, a number followed by MODIFIER is multiplied
18191 by the specified number of MINUTES to obtain an effort in
18192 minutes.
18194 For example, if the value of this variable is ((\"hours\" . 60)), then an
18195 effort string \"2hours\" is equivalent to 120 minutes."
18196 :group 'org-agenda
18197 :version "25.1"
18198 :package-version '(Org . "8.3")
18199 :type '(alist :key-type (string :tag "Modifier")
18200 :value-type (number :tag "Minutes")))
18202 (defun org-minutes-to-clocksum-string (m)
18203 "Format number of minutes as a clocksum string.
18204 The format is determined by `org-time-clocksum-format',
18205 `org-time-clocksum-use-fractional' and
18206 `org-time-clocksum-fractional-format' and
18207 `org-time-clocksum-use-effort-durations'."
18208 (let ((clocksum "")
18209 (m (round m)) ; Don't allow fractions of minutes
18210 h d w mo y fmt n)
18211 (setq h (if org-time-clocksum-use-effort-durations
18212 (cdr (assoc "h" org-effort-durations)) 60)
18213 d (if org-time-clocksum-use-effort-durations
18214 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18215 w (if org-time-clocksum-use-effort-durations
18216 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18217 mo (if org-time-clocksum-use-effort-durations
18218 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18219 y (if org-time-clocksum-use-effort-durations
18220 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18221 ;; fractional format
18222 (if org-time-clocksum-use-fractional
18223 (cond
18224 ;; single format string
18225 ((stringp org-time-clocksum-fractional-format)
18226 (format org-time-clocksum-fractional-format (/ m (float h))))
18227 ;; choice of fractional formats for different time units
18228 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18229 (> (/ (truncate m) (* y d h)) 0))
18230 (format fmt (/ m (* y d (float h)))))
18231 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18232 (> (/ (truncate m) (* mo d h)) 0))
18233 (format fmt (/ m (* mo d (float h)))))
18234 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18235 (> (/ (truncate m) (* w d h)) 0))
18236 (format fmt (/ m (* w d (float h)))))
18237 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18238 (> (/ (truncate m) (* d h)) 0))
18239 (format fmt (/ m (* d (float h)))))
18240 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18241 (> (/ (truncate m) h) 0))
18242 (format fmt (/ m (float h))))
18243 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18244 (format fmt m))
18245 ;; fall back to smallest time unit with a format
18246 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18247 (format fmt (/ m (float h))))
18248 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18249 (format fmt (/ m (* d (float h)))))
18250 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18251 (format fmt (/ m (* w d (float h)))))
18252 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18253 (format fmt (/ m (* mo d (float h)))))
18254 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18255 (format fmt (/ m (* y d (float h))))))
18256 ;; standard (non-fractional) format, with single format string
18257 (if (stringp org-time-clocksum-format)
18258 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18259 ;; separate formats components
18260 (and (setq fmt (plist-get org-time-clocksum-format :years))
18261 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18262 (plist-get org-time-clocksum-format :require-years))
18263 (setq clocksum (concat clocksum (format fmt n))
18264 m (- m (* n y d h))))
18265 (and (setq fmt (plist-get org-time-clocksum-format :months))
18266 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18267 (plist-get org-time-clocksum-format :require-months))
18268 (setq clocksum (concat clocksum (format fmt n))
18269 m (- m (* n mo d h))))
18270 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18271 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18272 (plist-get org-time-clocksum-format :require-weeks))
18273 (setq clocksum (concat clocksum (format fmt n))
18274 m (- m (* n w d h))))
18275 (and (setq fmt (plist-get org-time-clocksum-format :days))
18276 (or (> (setq n (/ (truncate m) (* d h))) 0)
18277 (plist-get org-time-clocksum-format :require-days))
18278 (setq clocksum (concat clocksum (format fmt n))
18279 m (- m (* n d h))))
18280 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18281 (or (> (setq n (/ (truncate m) h)) 0)
18282 (plist-get org-time-clocksum-format :require-hours))
18283 (setq clocksum (concat clocksum (format fmt n))
18284 m (- m (* n h))))
18285 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18286 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18287 (setq clocksum (concat clocksum (format fmt m))))
18288 ;; return formatted time duration
18289 clocksum))))
18291 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18292 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18293 "Org mode version 8.0")
18295 (defun org-hours-to-clocksum-string (n)
18296 (org-minutes-to-clocksum-string (* n 60)))
18298 (defun org-hh:mm-string-to-minutes (s)
18299 "Convert a string H:MM to a number of minutes.
18300 If the string is just a number, interpret it as minutes.
18301 In fact, the first hh:mm or number in the string will be taken,
18302 there can be extra stuff in the string.
18303 If no number is found, the return value is 0."
18304 (cond
18305 ((integerp s) s)
18306 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18307 (+ (* (string-to-number (match-string 1 s)) 60)
18308 (string-to-number (match-string 2 s))))
18309 ((string-match "\\([0-9]+\\)" s)
18310 (string-to-number (match-string 1 s)))
18311 (t 0)))
18313 (defcustom org-image-actual-width t
18314 "Should we use the actual width of images when inlining them?
18316 When set to t, always use the image width.
18318 When set to a number, use imagemagick (when available) to set
18319 the image's width to this value.
18321 When set to a number in a list, try to get the width from any
18322 #+ATTR.* keyword if it matches a width specification like
18324 #+ATTR_HTML: :width 300px
18326 and fall back on that number if none is found.
18328 When set to nil, try to get the width from an #+ATTR.* keyword
18329 and fall back on the original width if none is found.
18331 This requires Emacs >= 24.1, build with imagemagick support."
18332 :group 'org-appearance
18333 :version "24.4"
18334 :package-version '(Org . "8.0")
18335 :type '(choice
18336 (const :tag "Use the image width" t)
18337 (integer :tag "Use a number of pixels")
18338 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18339 (const :tag "Use #+ATTR* or don't resize" nil)))
18341 (defcustom org-agenda-inhibit-startup nil
18342 "Inhibit startup when preparing agenda buffers.
18343 When this variable is t, the initialization of the Org agenda
18344 buffers is inhibited: e.g. the visibility state is not set, the
18345 tables are not re-aligned, etc."
18346 :type 'boolean
18347 :version "24.3"
18348 :group 'org-agenda)
18350 (define-obsolete-variable-alias
18351 'org-agenda-ignore-drawer-properties
18352 'org-agenda-ignore-properties "25.1")
18354 (defcustom org-agenda-ignore-properties nil
18355 "Avoid updating text properties when building the agenda.
18356 Properties are used to prepare buffers for effort estimates,
18357 appointments, statistics and subtree-local categories.
18358 If you don't use these in the agenda, you can add them to this
18359 list and agenda building will be a bit faster.
18360 The value is a list, with zero or more of the symbols `effort', `appt',
18361 `stats' or `category'."
18362 :type '(set :greedy t
18363 (const effort)
18364 (const appt)
18365 (const stats)
18366 (const category))
18367 :version "25.1"
18368 :package-version '(Org . "8.3")
18369 :group 'org-agenda)
18371 (defun org-duration-string-to-minutes (s &optional output-to-string)
18372 "Convert a duration string S to minutes.
18374 A bare number is interpreted as minutes, modifiers can be set by
18375 customizing `org-effort-durations' (which see).
18377 Entries containing a colon are interpreted as H:MM by
18378 `org-hh:mm-string-to-minutes'."
18379 (let ((result 0)
18380 (re (concat "\\([0-9.]+\\) *\\("
18381 (regexp-opt (mapcar 'car org-effort-durations))
18382 "\\)")))
18383 (while (string-match re s)
18384 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18385 (string-to-number (match-string 1 s))))
18386 (setq s (replace-match "" nil t s)))
18387 (setq result (floor result))
18388 (incf result (org-hh:mm-string-to-minutes s))
18389 (if output-to-string (number-to-string result) result)))
18391 ;;;; Files
18393 (defun org-save-all-org-buffers ()
18394 "Save all Org-mode buffers without user confirmation."
18395 (interactive)
18396 (message "Saving all Org-mode buffers...")
18397 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18398 (when (featurep 'org-id) (org-id-locations-save))
18399 (message "Saving all Org-mode buffers... done"))
18401 (defun org-revert-all-org-buffers ()
18402 "Revert all Org-mode buffers.
18403 Prompt for confirmation when there are unsaved changes.
18404 Be sure you know what you are doing before letting this function
18405 overwrite your changes.
18407 This function is useful in a setup where one tracks org files
18408 with a version control system, to revert on one machine after pulling
18409 changes from another. I believe the procedure must be like this:
18411 1. M-x org-save-all-org-buffers
18412 2. Pull changes from the other machine, resolve conflicts
18413 3. M-x org-revert-all-org-buffers"
18414 (interactive)
18415 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18416 (user-error "Abort"))
18417 (save-excursion
18418 (save-window-excursion
18419 (mapc
18420 (lambda (b)
18421 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18422 (with-current-buffer b buffer-file-name))
18423 (org-pop-to-buffer-same-window b)
18424 (revert-buffer t 'no-confirm)))
18425 (buffer-list))
18426 (when (and (featurep 'org-id) org-id-track-globally)
18427 (org-id-locations-load)))))
18429 ;;;; Agenda files
18431 ;;;###autoload
18432 (defun org-switchb (&optional arg)
18433 "Switch between Org buffers.
18434 With one prefix argument, restrict available buffers to files.
18435 With two prefix arguments, restrict available buffers to agenda files.
18437 Defaults to `iswitchb' for buffer name completion.
18438 Set `org-completion-use-ido' to make it use ido instead."
18439 (interactive "P")
18440 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18441 ((equal arg '(16)) (org-buffer-list 'agenda))
18442 (t (org-buffer-list))))
18443 (org-completion-use-iswitchb org-completion-use-iswitchb)
18444 (org-completion-use-ido org-completion-use-ido))
18445 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18446 (setq org-completion-use-iswitchb t))
18447 (org-pop-to-buffer-same-window
18448 (org-icompleting-read "Org buffer: "
18449 (mapcar 'list (mapcar 'buffer-name blist))
18450 nil t))))
18452 ;;; Define some older names previously used for this functionality
18453 ;;;###autoload
18454 (defalias 'org-ido-switchb 'org-switchb)
18455 ;;;###autoload
18456 (defalias 'org-iswitchb 'org-switchb)
18458 (defun org-buffer-list (&optional predicate exclude-tmp)
18459 "Return a list of Org buffers.
18460 PREDICATE can be `export', `files' or `agenda'.
18462 export restrict the list to Export buffers.
18463 files restrict the list to buffers visiting Org files.
18464 agenda restrict the list to buffers visiting agenda files.
18466 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18467 (let* ((bfn nil)
18468 (agenda-files (and (eq predicate 'agenda)
18469 (mapcar 'file-truename (org-agenda-files t))))
18470 (filter
18471 (cond
18472 ((eq predicate 'files)
18473 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18474 ((eq predicate 'export)
18475 (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
18476 ((eq predicate 'agenda)
18477 (lambda (b)
18478 (with-current-buffer b
18479 (and (derived-mode-p 'org-mode)
18480 (setq bfn (buffer-file-name b))
18481 (member (file-truename bfn) agenda-files)))))
18482 (t (lambda (b) (with-current-buffer b
18483 (or (derived-mode-p 'org-mode)
18484 (string-match "\\*Org .*Export"
18485 (buffer-name b)))))))))
18486 (delq nil
18487 (mapcar
18488 (lambda(b)
18489 (if (and (funcall filter b)
18490 (or (not exclude-tmp)
18491 (not (string-match "tmp" (buffer-name b)))))
18493 nil))
18494 (buffer-list)))))
18496 (defun org-agenda-files (&optional unrestricted archives)
18497 "Get the list of agenda files.
18498 Optional UNRESTRICTED means return the full list even if a restriction
18499 is currently in place.
18500 When ARCHIVES is t, include all archive files that are really being
18501 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18502 `org-agenda-archives-mode' is t."
18503 (let ((files
18504 (cond
18505 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18506 ((stringp org-agenda-files) (org-read-agenda-file-list))
18507 ((listp org-agenda-files) org-agenda-files)
18508 (t (error "Invalid value of `org-agenda-files'")))))
18509 (setq files (apply 'append
18510 (mapcar (lambda (f)
18511 (if (file-directory-p f)
18512 (directory-files
18513 f t org-agenda-file-regexp)
18514 (list f)))
18515 files)))
18516 (when org-agenda-skip-unavailable-files
18517 (setq files (delq nil
18518 (mapcar (function
18519 (lambda (file)
18520 (and (file-readable-p file) file)))
18521 files))))
18522 (when (or (eq archives t)
18523 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18524 (setq files (org-add-archive-files files)))
18525 files))
18527 (defun org-agenda-file-p (&optional file)
18528 "Return non-nil, if FILE is an agenda file.
18529 If FILE is omitted, use the file associated with the current
18530 buffer."
18531 (let ((fname (or file (buffer-file-name))))
18532 (and fname
18533 (member (file-truename fname)
18534 (mapcar #'file-truename (org-agenda-files t))))))
18536 (defun org-edit-agenda-file-list ()
18537 "Edit the list of agenda files.
18538 Depending on setup, this either uses customize to edit the variable
18539 `org-agenda-files', or it visits the file that is holding the list. In the
18540 latter case, the buffer is set up in a way that saving it automatically kills
18541 the buffer and restores the previous window configuration."
18542 (interactive)
18543 (if (stringp org-agenda-files)
18544 (let ((cw (current-window-configuration)))
18545 (find-file org-agenda-files)
18546 (org-set-local 'org-window-configuration cw)
18547 (org-add-hook 'after-save-hook
18548 (lambda ()
18549 (set-window-configuration
18550 (prog1 org-window-configuration
18551 (kill-buffer (current-buffer))))
18552 (org-install-agenda-files-menu)
18553 (message "New agenda file list installed"))
18554 nil 'local)
18555 (message "%s" (substitute-command-keys
18556 "Edit list and finish with \\[save-buffer]")))
18557 (customize-variable 'org-agenda-files)))
18559 (defun org-store-new-agenda-file-list (list)
18560 "Set new value for the agenda file list and save it correctly."
18561 (if (stringp org-agenda-files)
18562 (let ((fe (org-read-agenda-file-list t)) b u)
18563 (while (setq b (find-buffer-visiting org-agenda-files))
18564 (kill-buffer b))
18565 (with-temp-file org-agenda-files
18566 (insert
18567 (mapconcat
18568 (lambda (f) ;; Keep un-expanded entries.
18569 (if (setq u (assoc f fe))
18570 (cdr u)
18572 list "\n")
18573 "\n")))
18574 (let ((org-mode-hook nil) (org-inhibit-startup t)
18575 (org-insert-mode-line-in-empty-file nil))
18576 (setq org-agenda-files list)
18577 (customize-save-variable 'org-agenda-files org-agenda-files))))
18579 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18580 "Read the list of agenda files from a file.
18581 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18582 filenames, used by `org-store-new-agenda-file-list' to write back
18583 un-expanded file names."
18584 (when (file-directory-p org-agenda-files)
18585 (error "`org-agenda-files' cannot be a single directory"))
18586 (when (stringp org-agenda-files)
18587 (with-temp-buffer
18588 (insert-file-contents org-agenda-files)
18589 (mapcar
18590 (lambda (f)
18591 (let ((e (expand-file-name (substitute-in-file-name f)
18592 org-directory)))
18593 (if pair-with-expansion
18594 (cons e f)
18595 e)))
18596 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18598 ;;;###autoload
18599 (defun org-cycle-agenda-files ()
18600 "Cycle through the files in `org-agenda-files'.
18601 If the current buffer visits an agenda file, find the next one in the list.
18602 If the current buffer does not, find the first agenda file."
18603 (interactive)
18604 (let* ((fs (or (org-agenda-files t)
18605 (user-error "No agenda files")))
18606 (files (copy-sequence fs))
18607 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18608 file)
18609 (when tcf
18610 (while (and (setq file (pop files))
18611 (not (equal (file-truename file) tcf)))))
18612 (find-file (car (or files fs)))
18613 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18615 (defun org-agenda-file-to-front (&optional to-end)
18616 "Move/add the current file to the top of the agenda file list.
18617 If the file is not present in the list, it is added to the front. If it is
18618 present, it is moved there. With optional argument TO-END, add/move to the
18619 end of the list."
18620 (interactive "P")
18621 (let ((org-agenda-skip-unavailable-files nil)
18622 (file-alist (mapcar (lambda (x)
18623 (cons (file-truename x) x))
18624 (org-agenda-files t)))
18625 (ctf (file-truename
18626 (or buffer-file-name
18627 (user-error "Please save the current buffer to a file"))))
18628 x had)
18629 (setq x (assoc ctf file-alist) had x)
18631 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18632 (if to-end
18633 (setq file-alist (append (delq x file-alist) (list x)))
18634 (setq file-alist (cons x (delq x file-alist))))
18635 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18636 (org-install-agenda-files-menu)
18637 (message "File %s to %s of agenda file list"
18638 (if had "moved" "added") (if to-end "end" "front"))))
18640 (defun org-remove-file (&optional file)
18641 "Remove current file from the list of files in variable `org-agenda-files'.
18642 These are the files which are being checked for agenda entries.
18643 Optional argument FILE means use this file instead of the current."
18644 (interactive)
18645 (let* ((org-agenda-skip-unavailable-files nil)
18646 (file (or file buffer-file-name
18647 (user-error "Current buffer does not visit a file")))
18648 (true-file (file-truename file))
18649 (afile (abbreviate-file-name file))
18650 (files (delq nil (mapcar
18651 (lambda (x)
18652 (if (equal true-file
18653 (file-truename x))
18654 nil x))
18655 (org-agenda-files t)))))
18656 (if (not (= (length files) (length (org-agenda-files t))))
18657 (progn
18658 (org-store-new-agenda-file-list files)
18659 (org-install-agenda-files-menu)
18660 (message "Removed from Org Agenda list: %s" afile))
18661 (message "File was not in list: %s (not removed)" afile))))
18663 (defun org-file-menu-entry (file)
18664 (vector file (list 'find-file file) t))
18666 (defun org-check-agenda-file (file)
18667 "Make sure FILE exists. If not, ask user what to do."
18668 (when (not (file-exists-p file))
18669 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18670 (abbreviate-file-name file))
18671 (let ((r (downcase (read-char-exclusive))))
18672 (cond
18673 ((equal r ?r)
18674 (org-remove-file file)
18675 (throw 'nextfile t))
18676 (t (user-error "Abort"))))))
18678 (defun org-get-agenda-file-buffer (file)
18679 "Get an agenda buffer visiting FILE.
18680 If the buffer needs to be created, add it to the list of buffers
18681 which might be released later."
18682 (let ((buf (org-find-base-buffer-visiting file)))
18683 (if buf
18684 buf ; just return it
18685 ;; Make a new buffer and remember it
18686 (setq buf (find-file-noselect file))
18687 (if buf (push buf org-agenda-new-buffers))
18688 buf)))
18690 (defun org-release-buffers (blist)
18691 "Release all buffers in list, asking the user for confirmation when needed.
18692 When a buffer is unmodified, it is just killed. When modified, it is saved
18693 \(if the user agrees) and then killed."
18694 (let (file)
18695 (dolist (buf blist)
18696 (setq file (buffer-file-name buf))
18697 (when (and (buffer-modified-p buf)
18698 file
18699 (y-or-n-p (format "Save file %s? " file)))
18700 (with-current-buffer buf (save-buffer)))
18701 (kill-buffer buf))))
18703 (defun org-agenda-prepare-buffers (files)
18704 "Create buffers for all agenda files, protect archived trees and comments."
18705 (interactive)
18706 (let ((pa '(:org-archived t))
18707 (pc '(:org-comment t))
18708 (pall '(:org-archived t :org-comment t))
18709 (inhibit-read-only t)
18710 (org-inhibit-startup org-agenda-inhibit-startup)
18711 (rea (concat ":" org-archive-tag ":"))
18712 file re pos)
18713 (setq org-tag-alist-for-agenda nil
18714 org-tag-groups-alist-for-agenda nil)
18715 (save-excursion
18716 (save-restriction
18717 (dolist (file files)
18718 (catch 'nextfile
18719 (if (bufferp file)
18720 (set-buffer file)
18721 (org-check-agenda-file file)
18722 (set-buffer (org-get-agenda-file-buffer file)))
18723 (widen)
18724 (org-set-regexps-and-options 'tags-only)
18725 (setq pos (point))
18726 (or (memq 'category org-agenda-ignore-properties)
18727 (org-refresh-category-properties))
18728 (or (memq 'stats org-agenda-ignore-properties)
18729 (org-refresh-stats-properties))
18730 (or (memq 'effort org-agenda-ignore-properties)
18731 (org-refresh-effort-properties))
18732 (or (memq 'appt org-agenda-ignore-properties)
18733 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18734 (setq org-todo-keywords-for-agenda
18735 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18736 (setq org-done-keywords-for-agenda
18737 (append org-done-keywords-for-agenda org-done-keywords))
18738 (setq org-todo-keyword-alist-for-agenda
18739 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18740 (setq org-tag-alist-for-agenda
18741 (org-uniquify
18742 (append org-tag-alist-for-agenda
18743 org-tag-alist
18744 org-tag-persistent-alist)))
18745 (if org-group-tags
18746 (setq org-tag-groups-alist-for-agenda
18747 (org-uniquify-alist
18748 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18749 (org-with-silent-modifications
18750 (save-excursion
18751 (remove-text-properties (point-min) (point-max) pall)
18752 (when org-agenda-skip-archived-trees
18753 (goto-char (point-min))
18754 (while (re-search-forward rea nil t)
18755 (if (org-at-heading-p t)
18756 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18757 (goto-char (point-min))
18758 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18759 (while (re-search-forward re nil t)
18760 (when (save-match-data (org-in-commented-heading-p t))
18761 (add-text-properties
18762 (match-beginning 0) (org-end-of-subtree t) pc)))))
18763 (goto-char pos)))))
18764 (setq org-todo-keywords-for-agenda
18765 (org-uniquify org-todo-keywords-for-agenda))
18766 (setq org-todo-keyword-alist-for-agenda
18767 (org-uniquify org-todo-keyword-alist-for-agenda))))
18770 ;;;; CDLaTeX minor mode
18772 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18773 "Keymap for the minor `org-cdlatex-mode'.")
18775 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18776 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18777 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18778 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18779 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18781 (defvar org-cdlatex-texmathp-advice-is-done nil
18782 "Flag remembering if we have applied the advice to texmathp already.")
18784 (define-minor-mode org-cdlatex-mode
18785 "Toggle the minor `org-cdlatex-mode'.
18786 This mode supports entering LaTeX environment and math in LaTeX fragments
18787 in Org-mode.
18788 \\{org-cdlatex-mode-map}"
18789 nil " OCDL" nil
18790 (when org-cdlatex-mode
18791 (require 'cdlatex)
18792 (run-hooks 'cdlatex-mode-hook)
18793 (cdlatex-compute-tables))
18794 (unless org-cdlatex-texmathp-advice-is-done
18795 (setq org-cdlatex-texmathp-advice-is-done t)
18796 (defadvice texmathp (around org-math-always-on activate)
18797 "Always return t in org-mode buffers.
18798 This is because we want to insert math symbols without dollars even outside
18799 the LaTeX math segments. If Orgmode thinks that point is actually inside
18800 an embedded LaTeX fragment, let texmathp do its job.
18801 \\[org-cdlatex-mode-map]"
18802 (interactive)
18803 (let (p)
18804 (cond
18805 ((not (derived-mode-p 'org-mode)) ad-do-it)
18806 ((eq this-command 'cdlatex-math-symbol)
18807 (setq ad-return-value t
18808 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18810 (let ((p (org-inside-LaTeX-fragment-p)))
18811 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18812 (setq ad-return-value t
18813 texmathp-why '("Org-mode embedded math" . 0))
18814 (if p ad-do-it)))))))))
18816 (defun turn-on-org-cdlatex ()
18817 "Unconditionally turn on `org-cdlatex-mode'."
18818 (org-cdlatex-mode 1))
18820 (defun org-try-cdlatex-tab ()
18821 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18822 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18823 - inside a LaTeX fragment, or
18824 - after the first word in a line, where an abbreviation expansion could
18825 insert a LaTeX environment."
18826 (when org-cdlatex-mode
18827 (cond
18828 ;; Before any word on the line: No expansion possible.
18829 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18830 ;; Just after first word on the line: Expand it. Make sure it
18831 ;; cannot happen on headlines, though.
18832 ((save-excursion
18833 (skip-chars-backward "a-zA-Z0-9*")
18834 (skip-chars-backward " \t")
18835 (and (bolp) (not (org-at-heading-p))))
18836 (cdlatex-tab) t)
18837 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18839 (defun org-cdlatex-underscore-caret (&optional arg)
18840 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18841 Revert to the normal definition outside of these fragments."
18842 (interactive "P")
18843 (if (org-inside-LaTeX-fragment-p)
18844 (call-interactively 'cdlatex-sub-superscript)
18845 (let (org-cdlatex-mode)
18846 (call-interactively (key-binding (vector last-input-event))))))
18848 (defun org-cdlatex-math-modify (&optional arg)
18849 "Execute `cdlatex-math-modify' in LaTeX fragments.
18850 Revert to the normal definition outside of these fragments."
18851 (interactive "P")
18852 (if (org-inside-LaTeX-fragment-p)
18853 (call-interactively 'cdlatex-math-modify)
18854 (let (org-cdlatex-mode)
18855 (call-interactively (key-binding (vector last-input-event))))))
18857 (defun org-cdlatex-environment-indent (&optional environment item)
18858 "Execute `cdlatex-environment' and indent the inserted environment.
18860 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18862 The inserted environment is indented to current indentation
18863 unless point is at the beginning of the line, in which the
18864 environment remains unintended."
18865 (interactive)
18866 ;; cdlatex-environment always return nil. Therefore, capture output
18867 ;; first and determine if an environment was selected.
18868 (let* ((beg (point-marker))
18869 (end (copy-marker (point) t))
18870 (inserted (progn
18871 (ignore-errors (cdlatex-environment environment item))
18872 (< beg end)))
18873 ;; Figure out how many lines to move forward after the
18874 ;; environment has been inserted.
18875 (lines (when inserted
18876 (save-excursion
18877 (- (loop while (< beg (point))
18878 with x = 0
18879 do (forward-line -1)
18880 (incf x)
18881 finally return x)
18882 (if (progn (goto-char beg)
18883 (and (progn (skip-chars-forward " \t") (eolp))
18884 (progn (skip-chars-backward " \t") (bolp))))
18885 1 0)))))
18886 (env (org-trim (delete-and-extract-region beg end))))
18887 (when inserted
18888 ;; Get indentation of next line unless at column 0.
18889 (let ((ind (if (bolp) 0
18890 (save-excursion
18891 (org-return-indent)
18892 (prog1 (org-get-indentation)
18893 (when (progn (skip-chars-forward " \t") (eolp))
18894 (delete-region beg (point)))))))
18895 (bol (progn (skip-chars-backward " \t") (bolp))))
18896 ;; Insert a newline before environment unless at column zero
18897 ;; to "escape" the current line. Insert a newline if
18898 ;; something is one the same line as \end{ENVIRONMENT}.
18899 (insert
18900 (concat (unless bol "\n") env
18901 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18902 (unless (zerop ind)
18903 (save-excursion
18904 (goto-char beg)
18905 (while (< (point) end)
18906 (unless (eolp) (org-indent-line-to ind))
18907 (forward-line))))
18908 (goto-char beg)
18909 (forward-line lines)
18910 (org-indent-line-to ind)))
18911 (set-marker beg nil)
18912 (set-marker end nil)))
18915 ;;;; LaTeX fragments
18917 (defun org-inside-LaTeX-fragment-p ()
18918 "Test if point is inside a LaTeX fragment.
18919 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18920 sequence appearing also before point.
18921 Even though the matchers for math are configurable, this function assumes
18922 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18923 delimiters are skipped when they have been removed by customization.
18924 The return value is nil, or a cons cell with the delimiter and the
18925 position of this delimiter.
18927 This function does a reasonably good job, but can locally be fooled by
18928 for example currency specifications. For example it will assume being in
18929 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18930 fragments that are properly closed, but during editing, we have to live
18931 with the uncertainty caused by missing closing delimiters. This function
18932 looks only before point, not after."
18933 (catch 'exit
18934 (let ((pos (point))
18935 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18936 (lim (progn
18937 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18938 (point)))
18939 dd-on str (start 0) m re)
18940 (goto-char pos)
18941 (when dodollar
18942 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18943 re (nth 1 (assoc "$" org-latex-regexps)))
18944 (while (string-match re str start)
18945 (cond
18946 ((= (match-end 0) (length str))
18947 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18948 ((= (match-end 0) (- (length str) 5))
18949 (throw 'exit nil))
18950 (t (setq start (match-end 0))))))
18951 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18952 (goto-char pos)
18953 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18954 (and (match-beginning 2) (throw 'exit nil))
18955 ;; count $$
18956 (while (re-search-backward "\\$\\$" lim t)
18957 (setq dd-on (not dd-on)))
18958 (goto-char pos)
18959 (if dd-on (cons "$$" m))))))
18961 (defun org-inside-latex-macro-p ()
18962 "Is point inside a LaTeX macro or its arguments?"
18963 (save-match-data
18964 (org-in-regexp
18965 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18967 (defvar org-latex-fragment-image-overlays nil
18968 "List of overlays carrying the images of latex fragments.")
18969 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18971 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18972 "Remove all overlays with LaTeX fragment images in current buffer.
18973 When optional arguments BEG and END are non-nil, remove all
18974 overlays between them instead. Return t when some overlays were
18975 removed, nil otherwise."
18976 (let (removedp)
18977 (setq org-latex-fragment-image-overlays
18978 (let ((beg (or beg (point-min)))
18979 (end (or end (point-max))))
18980 (org-remove-if
18981 (lambda (o)
18982 (and (>= (overlay-start o) beg)
18983 (<= (overlay-end o) end)
18984 (progn (delete-overlay o)
18985 (or removedp (setq removedp t)))))
18986 org-latex-fragment-image-overlays)))
18987 removedp))
18989 (define-obsolete-function-alias
18990 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18991 (defun org-toggle-latex-fragment (&optional arg)
18992 "Preview the LaTeX fragment at point, or all locally or globally.
18994 If the cursor is on a LaTeX fragment, create the image and overlay
18995 it over the source code, if there is none. Remove it otherwise.
18996 If there is no fragment at point, display all fragments in the
18997 current section.
18999 With prefix ARG, preview or clear image for all fragments in the
19000 current subtree or in the whole buffer when used before the first
19001 headline. With a double prefix ARG \\[universal-argument] \
19002 \\[universal-argument] preview or clear images
19003 for all fragments in the buffer."
19004 (interactive "P")
19005 (unless (buffer-file-name (buffer-base-buffer))
19006 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
19007 (when (display-graphic-p)
19008 (catch 'exit
19009 (save-excursion
19010 (let ((window-start (window-start)) msg)
19011 (save-restriction
19012 (cond
19013 ((or (equal arg '(16))
19014 (and (equal arg '(4))
19015 (org-with-limited-levels (org-before-first-heading-p))))
19016 (if (org-remove-latex-fragment-image-overlays)
19017 (progn (message "LaTeX fragments images removed from buffer")
19018 (throw 'exit nil))
19019 (setq msg "Creating images for buffer...")))
19020 ((equal arg '(4))
19021 (org-with-limited-levels (org-back-to-heading t))
19022 (let ((beg (point))
19023 (end (progn (org-end-of-subtree t) (point))))
19024 (if (org-remove-latex-fragment-image-overlays beg end)
19025 (progn
19026 (message "LaTeX fragment images removed from subtree")
19027 (throw 'exit nil))
19028 (setq msg "Creating images for subtree...")
19029 (narrow-to-region beg end))))
19030 ((let ((datum (org-element-context)))
19031 (when (memq (org-element-type datum)
19032 '(latex-environment latex-fragment))
19033 (let* ((beg (org-element-property :begin datum))
19034 (end (org-element-property :end datum)))
19035 (if (org-remove-latex-fragment-image-overlays beg end)
19036 (progn (message "LaTeX fragment image removed")
19037 (throw 'exit nil))
19038 (narrow-to-region beg end)
19039 (setq msg "Creating image..."))))))
19041 (org-with-limited-levels
19042 (let ((beg (if (org-at-heading-p) (line-beginning-position)
19043 (outline-previous-heading)
19044 (point)))
19045 (end (progn (outline-next-heading) (point))))
19046 (if (org-remove-latex-fragment-image-overlays beg end)
19047 (progn
19048 (message "LaTeX fragment images removed from section")
19049 (throw 'exit nil))
19050 (setq msg "Creating images for section...")
19051 (narrow-to-region beg end))))))
19052 (let ((file (buffer-file-name (buffer-base-buffer))))
19053 (org-format-latex
19054 (concat org-latex-preview-ltxpng-directory
19055 (file-name-sans-extension (file-name-nondirectory file)))
19056 ;; Emacs cannot overlay images from remote hosts.
19057 ;; Create it in `temporary-file-directory' instead.
19058 (if (file-remote-p file) temporary-file-directory
19059 default-directory)
19060 'overlays msg 'forbuffer
19061 org-latex-create-formula-image-program)))
19062 ;; Work around a bug that doesn't restore window's start
19063 ;; when widening back the buffer.
19064 (set-window-start nil window-start)
19065 (message (concat msg "done")))))))
19067 (defun org-format-latex
19068 (prefix &optional dir overlays msg forbuffer processing-type)
19069 "Replace LaTeX fragments with links to an image, and produce images.
19071 When optional argument OVERLAYS is non-nil, display the image on
19072 top of the fragment instead of replacing it.
19074 PROCESSING-TYPE is the conversion method to use, as a symbol.
19076 Some of the options can be changed using the variable
19077 `org-format-latex-options', which see."
19078 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19079 (unless (eq processing-type 'verbatim)
19080 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19081 (cnt 0)
19082 checkdir-flag)
19083 (goto-char (point-min))
19084 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19085 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19086 (overlay-recenter (point-max)))
19087 (while (re-search-forward math-regexp nil t)
19088 (unless (and overlays
19089 (eq (get-char-property (point) 'org-overlay-type)
19090 'org-latex-overlay))
19091 (let* ((context (org-element-context))
19092 (type (org-element-type context)))
19093 (when (memq type '(latex-environment latex-fragment))
19094 (let ((block-type (eq type 'latex-environment))
19095 (value (org-element-property :value context))
19096 (beg (org-element-property :begin context))
19097 (end (save-excursion
19098 (goto-char (org-element-property :end context))
19099 (skip-chars-backward " \r\t\n")
19100 (point))))
19101 (case processing-type
19102 (mathjax
19103 ;; Prepare for MathJax processing.
19104 (if (eq (char-after beg) ?$)
19105 (save-excursion
19106 (delete-region beg end)
19107 (insert "\\(" (substring value 1 -1) "\\)"))
19108 (goto-char end)))
19109 ((dvipng imagemagick)
19110 ;; Process to an image.
19111 (incf cnt)
19112 (goto-char beg)
19113 (let* ((face (face-at-point))
19114 ;; Get the colors from the face at point.
19116 (let ((color (plist-get org-format-latex-options
19117 :foreground)))
19118 (if (and forbuffer (eq color 'auto))
19119 (face-attribute face :foreground nil 'default)
19120 color)))
19122 (let ((color (plist-get org-format-latex-options
19123 :background)))
19124 (if (and forbuffer (eq color 'auto))
19125 (face-attribute face :background nil 'default)
19126 color)))
19127 (hash (sha1 (prin1-to-string
19128 (list org-format-latex-header
19129 org-latex-default-packages-alist
19130 org-latex-packages-alist
19131 org-format-latex-options
19132 forbuffer value fg bg))))
19133 (absprefix (expand-file-name prefix dir))
19134 (linkfile (format "%s_%s.png" prefix hash))
19135 (movefile (format "%s_%s.png" absprefix hash))
19136 (sep (and block-type "\n\n"))
19137 (link (concat sep "[[file:" linkfile "]]" sep))
19138 (options
19139 (org-combine-plists
19140 org-format-latex-options
19141 `(:foreground ,fg :background ,bg))))
19142 (when msg (message msg cnt))
19143 (unless checkdir-flag ; Ensure the directory exists.
19144 (setq checkdir-flag t)
19145 (let ((todir (file-name-directory absprefix)))
19146 (unless (file-directory-p todir)
19147 (make-directory todir t))))
19148 (unless (file-exists-p movefile)
19149 (org-create-formula-image
19150 value movefile options forbuffer processing-type))
19151 (if overlays
19152 (progn
19153 (dolist (o (overlays-in beg end))
19154 (when (eq (overlay-get o 'org-overlay-type)
19155 'org-latex-overlay)
19156 (delete-overlay o)))
19157 (let ((ov (make-overlay beg end)))
19158 (overlay-put ov
19159 'org-overlay-type
19160 'org-latex-overlay)
19161 (overlay-put ov 'evaporate t)
19162 (if (featurep 'xemacs)
19163 (progn
19164 (overlay-put ov 'invisible t)
19165 (overlay-put
19166 ov 'end-glyph
19167 (make-glyph
19168 (vector 'png :file movefile))))
19169 (overlay-put
19170 ov 'display
19171 (list 'image
19172 :type 'png
19173 :file movefile
19174 :ascent 'center)))
19175 (push ov org-latex-fragment-image-overlays))
19176 (goto-char end))
19177 (delete-region beg end)
19178 (insert
19179 (org-add-props link
19180 (list 'org-latex-src
19181 (replace-regexp-in-string "\"" "" value)
19182 'org-latex-src-embed-type
19183 (if block-type 'paragraph 'character)))))))
19184 (mathml
19185 ;; Process to MathML.
19186 (unless (org-format-latex-mathml-available-p)
19187 (user-error "LaTeX to MathML converter not configured"))
19188 (incf cnt)
19189 (when msg (message msg cnt))
19190 (goto-char beg)
19191 (delete-region beg end)
19192 (insert (org-format-latex-as-mathml
19193 value block-type prefix dir)))
19194 (otherwise
19195 (error "Unknown conversion type %s for LaTeX fragments"
19196 processing-type)))))))))))
19198 (defun org-create-math-formula (latex-frag &optional mathml-file)
19199 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19200 Use `org-latex-to-mathml-convert-command'. If the conversion is
19201 sucessful, return the portion between \"<math...> </math>\"
19202 elements otherwise return nil. When MATHML-FILE is specified,
19203 write the results in to that file. When invoked as an
19204 interactive command, prompt for LATEX-FRAG, with initial value
19205 set to the current active region and echo the results for user
19206 inspection."
19207 (interactive (list (let ((frag (when (org-region-active-p)
19208 (buffer-substring-no-properties
19209 (region-beginning) (region-end)))))
19210 (read-string "LaTeX Fragment: " frag nil frag))))
19211 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19212 (let* ((tmp-in-file (file-relative-name
19213 (make-temp-name (expand-file-name "ltxmathml-in"))))
19214 (ignore (write-region latex-frag nil tmp-in-file))
19215 (tmp-out-file (file-relative-name
19216 (make-temp-name (expand-file-name "ltxmathml-out"))))
19217 (cmd (format-spec
19218 org-latex-to-mathml-convert-command
19219 `((?j . ,(and org-latex-to-mathml-jar-file
19220 (shell-quote-argument
19221 (expand-file-name
19222 org-latex-to-mathml-jar-file))))
19223 (?I . ,(shell-quote-argument tmp-in-file))
19224 (?i . ,latex-frag)
19225 (?o . ,(shell-quote-argument tmp-out-file)))))
19226 mathml shell-command-output)
19227 (when (org-called-interactively-p 'any)
19228 (unless (org-format-latex-mathml-available-p)
19229 (user-error "LaTeX to MathML converter not configured")))
19230 (message "Running %s" cmd)
19231 (setq shell-command-output (shell-command-to-string cmd))
19232 (setq mathml
19233 (when (file-readable-p tmp-out-file)
19234 (with-current-buffer (find-file-noselect tmp-out-file t)
19235 (goto-char (point-min))
19236 (when (re-search-forward
19237 (concat
19238 (regexp-quote
19239 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19240 "[^>]*?>"
19241 "\\(.\\|\n\\)*"
19242 "</math>")
19243 nil t)
19244 (prog1 (match-string 0) (kill-buffer))))))
19245 (cond
19246 (mathml
19247 (setq mathml
19248 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19249 (when mathml-file
19250 (write-region mathml nil mathml-file))
19251 (when (org-called-interactively-p 'any)
19252 (message mathml)))
19253 ((message "LaTeX to MathML conversion failed")
19254 (message shell-command-output)))
19255 (delete-file tmp-in-file)
19256 (when (file-exists-p tmp-out-file)
19257 (delete-file tmp-out-file))
19258 mathml))
19260 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19261 prefix &optional dir)
19262 "Use `org-create-math-formula' but check local cache first."
19263 (let* ((absprefix (expand-file-name prefix dir))
19264 (print-length nil) (print-level nil)
19265 (formula-id (concat
19266 "formula-"
19267 (sha1
19268 (prin1-to-string
19269 (list latex-frag
19270 org-latex-to-mathml-convert-command)))))
19271 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19272 (formula-cache-dir (file-name-directory formula-cache)))
19274 (unless (file-directory-p formula-cache-dir)
19275 (make-directory formula-cache-dir t))
19277 (unless (file-exists-p formula-cache)
19278 (org-create-math-formula latex-frag formula-cache))
19280 (if (file-exists-p formula-cache)
19281 ;; Successful conversion. Return the link to MathML file.
19282 (org-add-props
19283 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19284 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19285 'org-latex-src-embed-type (if latex-frag-type
19286 'paragraph 'character)))
19287 ;; Failed conversion. Return the LaTeX fragment verbatim
19288 latex-frag)))
19290 (defun org-create-formula-image (string tofile options buffer &optional type)
19291 "Create an image from LaTeX source using dvipng or convert.
19292 This function calls either `org-create-formula-image-with-dvipng'
19293 or `org-create-formula-image-with-imagemagick' depending on the
19294 value of `org-latex-create-formula-image-program' or on the value
19295 of the optional TYPE variable.
19297 Note: ultimately these two function should be combined as they
19298 share a good deal of logic."
19299 (org-check-external-command
19300 "latex" "needed to convert LaTeX fragments to images")
19301 (funcall
19302 (case (or type org-latex-create-formula-image-program)
19303 (dvipng
19304 (org-check-external-command
19305 "dvipng" "needed to convert LaTeX fragments to images")
19306 #'org-create-formula-image-with-dvipng)
19307 (imagemagick
19308 (org-check-external-command
19309 "convert" "you need to install imagemagick")
19310 #'org-create-formula-image-with-imagemagick)
19311 (t (error
19312 "Invalid value of `org-latex-create-formula-image-program'")))
19313 string tofile options buffer))
19315 (declare-function org-export-get-backend "ox" (name))
19316 (declare-function org-export--get-global-options "ox" (&optional backend))
19317 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19318 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19319 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19320 (defun org-create-formula--latex-header ()
19321 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19322 (let ((info (org-combine-plists (org-export--get-global-options
19323 (org-export-get-backend 'latex))
19324 (org-export--get-inbuffer-options
19325 (org-export-get-backend 'latex)))))
19326 (org-latex-guess-babel-language
19327 (org-latex-guess-inputenc
19328 (org-splice-latex-header
19329 org-format-latex-header
19330 org-latex-default-packages-alist
19331 org-latex-packages-alist t
19332 (plist-get info :latex-header)))
19333 info)))
19335 (defun org--get-display-dpi ()
19336 "Get the DPI of the display.
19338 Assumes that the display has the same pixel width in the
19339 horizontal and vertical directions."
19340 (if (display-graphic-p)
19341 (round (/ (display-pixel-height)
19342 (/ (display-mm-height) 25.4)))
19343 (error "Attempt to calculate the dpi of a non-graphic display")))
19345 ;; This function borrows from Ganesh Swami's latex2png.el
19346 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19347 "This calls dvipng."
19348 (require 'ox-latex)
19349 (let* ((tmpdir (if (featurep 'xemacs)
19350 (temp-directory)
19351 temporary-file-directory))
19352 (texfilebase (make-temp-name
19353 (expand-file-name "orgtex" tmpdir)))
19354 (texfile (concat texfilebase ".tex"))
19355 (dvifile (concat texfilebase ".dvi"))
19356 (pngfile (concat texfilebase ".png"))
19357 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19358 ;; This assumes that the display has the same pixel width in
19359 ;; the horizontal and vertical directions
19360 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19361 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19362 "Black"))
19363 (bg (or (plist-get options (if buffer :background :html-background))
19364 "Transparent")))
19365 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19366 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19367 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19368 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19369 (let ((latex-header (org-create-formula--latex-header)))
19370 (with-temp-file texfile
19371 (insert latex-header)
19372 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19373 (let ((dir default-directory))
19374 (ignore-errors
19375 (cd tmpdir)
19376 (call-process "latex" nil nil nil texfile))
19377 (cd dir))
19378 (if (not (file-exists-p dvifile))
19379 (progn (message "Failed to create dvi file from %s" texfile) nil)
19380 (ignore-errors
19381 (if (featurep 'xemacs)
19382 (call-process "dvipng" nil nil nil
19383 "-fg" fg "-bg" bg
19384 "-T" "tight"
19385 "-o" pngfile
19386 dvifile)
19387 (call-process "dvipng" nil nil nil
19388 "-fg" fg "-bg" bg
19389 "-D" dpi
19390 ;;"-x" scale "-y" scale
19391 "-T" "tight"
19392 "-o" pngfile
19393 dvifile)))
19394 (if (not (file-exists-p pngfile))
19395 (if org-format-latex-signal-error
19396 (error "Failed to create png file from %s" texfile)
19397 (message "Failed to create png file from %s" texfile)
19398 nil)
19399 ;; Use the requested file name and clean up
19400 (copy-file pngfile tofile 'replace)
19401 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19402 (if (file-exists-p (concat texfilebase e))
19403 (delete-file (concat texfilebase e))))
19404 pngfile))))
19406 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19407 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19408 "This calls convert, which is included into imagemagick."
19409 (require 'ox-latex)
19410 (let* ((tmpdir (if (featurep 'xemacs)
19411 (temp-directory)
19412 temporary-file-directory))
19413 (texfilebase (make-temp-name
19414 (expand-file-name "orgtex" tmpdir)))
19415 (texfile (concat texfilebase ".tex"))
19416 (pdffile (concat texfilebase ".pdf"))
19417 (pngfile (concat texfilebase ".png"))
19418 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19419 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19420 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19421 "black"))
19422 (bg (or (plist-get options (if buffer :background :html-background))
19423 "white")))
19424 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19425 (setq fg (org-latex-color-format fg)))
19426 (if (eq bg 'default) (setq bg (org-latex-color :background))
19427 (setq bg (org-latex-color-format
19428 (if (string= bg "Transparent") "white" bg))))
19429 (let ((latex-header (org-create-formula--latex-header)))
19430 (with-temp-file texfile
19431 (insert latex-header)
19432 (insert "\n\\begin{document}\n"
19433 "\\definecolor{fg}{rgb}{" fg "}\n"
19434 "\\definecolor{bg}{rgb}{" bg "}\n"
19435 "\n\\pagecolor{bg}\n"
19436 "\n{\\color{fg}\n"
19437 string
19438 "\n}\n"
19439 "\n\\end{document}\n")))
19440 (org-latex-compile texfile t)
19441 (if (not (file-exists-p pdffile))
19442 (progn (message "Failed to create pdf file from %s" texfile) nil)
19443 (ignore-errors
19444 (if (featurep 'xemacs)
19445 (call-process "convert" nil nil nil
19446 "-density" "96"
19447 "-trim"
19448 "-antialias"
19449 pdffile
19450 "-quality" "100"
19451 ;; "-sharpen" "0x1.0"
19452 pngfile)
19453 (call-process "convert" nil nil nil
19454 "-density" dpi
19455 "-trim"
19456 "-antialias"
19457 pdffile
19458 "-quality" "100"
19459 ;; "-sharpen" "0x1.0"
19460 pngfile)))
19461 (if (not (file-exists-p pngfile))
19462 (if org-format-latex-signal-error
19463 (error "Failed to create png file from %s" texfile)
19464 (message "Failed to create png file from %s" texfile)
19465 nil)
19466 ;; Use the requested file name and clean up
19467 (copy-file pngfile tofile 'replace)
19468 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19469 (if (file-exists-p (concat texfilebase e))
19470 (delete-file (concat texfilebase e))))
19471 pngfile))))
19473 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19474 "Fill a LaTeX header template TPL.
19475 In the template, the following place holders will be recognized:
19477 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19478 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19479 [PACKAGES] \\usepackage statements for PKG
19480 [NO-PACKAGES] do not include PKG
19481 [EXTRA] the string EXTRA
19482 [NO-EXTRA] do not include EXTRA
19484 For backward compatibility, if both the positive and the negative place
19485 holder is missing, the positive one (without the \"NO-\") will be
19486 assumed to be present at the end of the template.
19487 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19488 EXTRA is a string.
19489 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19490 (let (rpl (end ""))
19491 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19492 (setq rpl (if (or (match-end 1) (not def-pkg))
19493 "" (org-latex-packages-to-string def-pkg snippets-p t))
19494 tpl (replace-match rpl t t tpl))
19495 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19497 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19498 (setq rpl (if (or (match-end 1) (not pkg))
19499 "" (org-latex-packages-to-string pkg snippets-p t))
19500 tpl (replace-match rpl t t tpl))
19501 (if pkg (setq end
19502 (concat end "\n"
19503 (org-latex-packages-to-string pkg snippets-p)))))
19505 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19506 (setq rpl (if (or (match-end 1) (not extra))
19507 "" (concat extra "\n"))
19508 tpl (replace-match rpl t t tpl))
19509 (if (and extra (string-match "\\S-" extra))
19510 (setq end (concat end "\n" extra))))
19512 (if (string-match "\\S-" end)
19513 (concat tpl "\n" end)
19514 tpl)))
19516 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19517 "Turn an alist of packages into a string with the \\usepackage macros."
19518 (setq pkg (mapconcat (lambda(p)
19519 (cond
19520 ((stringp p) p)
19521 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19522 (format "%% Package %s omitted" (cadr p)))
19523 ((equal "" (car p))
19524 (format "\\usepackage{%s}" (cadr p)))
19526 (format "\\usepackage[%s]{%s}"
19527 (car p) (cadr p)))))
19529 "\n"))
19530 (if newline (concat pkg "\n") pkg))
19532 (defun org-dvipng-color (attr)
19533 "Return a RGB color specification for dvipng."
19534 (apply 'format "rgb %s %s %s"
19535 (mapcar 'org-normalize-color
19536 (if (featurep 'xemacs)
19537 (color-rgb-components
19538 (face-property 'default
19539 (cond ((eq attr :foreground) 'foreground)
19540 ((eq attr :background) 'background))))
19541 (color-values (face-attribute 'default attr nil))))))
19543 (defun org-dvipng-color-format (color-name)
19544 "Convert COLOR-NAME to a RGB color value for dvipng."
19545 (apply 'format "rgb %s %s %s"
19546 (mapcar 'org-normalize-color
19547 (color-values color-name))))
19549 (defun org-latex-color (attr)
19550 "Return a RGB color for the LaTeX color package."
19551 (apply 'format "%s,%s,%s"
19552 (mapcar 'org-normalize-color
19553 (if (featurep 'xemacs)
19554 (color-rgb-components
19555 (face-property 'default
19556 (cond ((eq attr :foreground) 'foreground)
19557 ((eq attr :background) 'background))))
19558 (color-values (face-attribute 'default attr nil))))))
19560 (defun org-latex-color-format (color-name)
19561 "Convert COLOR-NAME to a RGB color value."
19562 (apply 'format "%s,%s,%s"
19563 (mapcar 'org-normalize-color
19564 (color-values color-name))))
19566 (defun org-normalize-color (value)
19567 "Return string to be used as color value for an RGB component."
19568 (format "%g" (/ value 65535.0)))
19572 ;; Image display
19574 (defvar org-inline-image-overlays nil)
19575 (make-variable-buffer-local 'org-inline-image-overlays)
19577 (defun org-toggle-inline-images (&optional include-linked)
19578 "Toggle the display of inline images.
19579 INCLUDE-LINKED is passed to `org-display-inline-images'."
19580 (interactive "P")
19581 (if org-inline-image-overlays
19582 (progn
19583 (org-remove-inline-images)
19584 (when (org-called-interactively-p 'interactive)
19585 (message "Inline image display turned off")))
19586 (org-display-inline-images include-linked)
19587 (when (org-called-interactively-p 'interactive)
19588 (message (if org-inline-image-overlays
19589 (format "%d images displayed inline"
19590 (length org-inline-image-overlays))
19591 "No images to display inline")))))
19593 (defun org-redisplay-inline-images ()
19594 "Refresh the display of inline images."
19595 (interactive)
19596 (if (not org-inline-image-overlays)
19597 (org-toggle-inline-images)
19598 (org-toggle-inline-images)
19599 (org-toggle-inline-images)))
19601 (defun org-display-inline-images (&optional include-linked refresh beg end)
19602 "Display inline images.
19604 An inline image is a link which follows either of these
19605 conventions:
19607 1. Its path is a file with an extension matching return value
19608 from `image-file-name-regexp' and it has no contents.
19610 2. Its description consists in a single link of the previous
19611 type.
19613 When optional argument INCLUDE-LINKED is non-nil, also links with
19614 a text description part will be inlined. This can be nice for
19615 a quick look at those images, but it does not reflect what
19616 exported files will look like.
19618 When optional argument REFRESH is non-nil, refresh existing
19619 images between BEG and END. This will create new image displays
19620 only if necessary. BEG and END default to the buffer
19621 boundaries."
19622 (interactive "P")
19623 (when (display-graphic-p)
19624 (unless refresh
19625 (org-remove-inline-images)
19626 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19627 (org-with-wide-buffer
19628 (goto-char (or beg (point-min)))
19629 (let ((case-fold-search t)
19630 (file-extension-re (org-image-file-name-regexp)))
19631 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19632 (let ((link (save-match-data (org-element-context))))
19633 ;; Check if we're at an inline image.
19634 (when (and (equal (org-element-property :type link) "file")
19635 (or include-linked
19636 (not (org-element-property :contents-begin link)))
19637 (let ((parent (org-element-property :parent link)))
19638 (or (not (eq (org-element-type parent) 'link))
19639 (not (cdr (org-element-contents parent)))))
19640 (org-string-match-p file-extension-re
19641 (org-element-property :path link)))
19642 (let ((file (expand-file-name
19643 (org-link-unescape
19644 (org-element-property :path link)))))
19645 (when (file-exists-p file)
19646 (let ((width
19647 ;; Apply `org-image-actual-width' specifications.
19648 (cond
19649 ((not (image-type-available-p 'imagemagick)) nil)
19650 ((eq org-image-actual-width t) nil)
19651 ((listp org-image-actual-width)
19653 ;; First try to find a width among
19654 ;; attributes associated to the paragraph
19655 ;; containing link.
19656 (let ((paragraph
19657 (let ((e link))
19658 (while (and (setq e (org-element-property
19659 :parent e))
19660 (not (eq (org-element-type e)
19661 'paragraph))))
19662 e)))
19663 (when paragraph
19664 (save-excursion
19665 (goto-char (org-element-property :begin paragraph))
19666 (when
19667 (re-search-forward
19668 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19669 (org-element-property
19670 :post-affiliated paragraph)
19672 (string-to-number (match-string 1))))))
19673 ;; Otherwise, fall-back to provided number.
19674 (car org-image-actual-width)))
19675 ((numberp org-image-actual-width)
19676 org-image-actual-width)))
19677 (old (get-char-property-and-overlay
19678 (org-element-property :begin link)
19679 'org-image-overlay)))
19680 (if (and (car-safe old) refresh)
19681 (image-refresh (overlay-get (cdr old) 'display))
19682 (let ((image (create-image file
19683 (and width 'imagemagick)
19685 :width width)))
19686 (when image
19687 (let* ((link
19688 ;; If inline image is the description
19689 ;; of another link, be sure to
19690 ;; consider the latter as the one to
19691 ;; apply the overlay on.
19692 (let ((parent
19693 (org-element-property :parent link)))
19694 (if (eq (org-element-type parent) 'link)
19695 parent
19696 link)))
19697 (ov (make-overlay
19698 (org-element-property :begin link)
19699 (progn
19700 (goto-char
19701 (org-element-property :end link))
19702 (skip-chars-backward " \t")
19703 (point)))))
19704 (overlay-put ov 'display image)
19705 (overlay-put ov 'face 'default)
19706 (overlay-put ov 'org-image-overlay t)
19707 (overlay-put
19708 ov 'modification-hooks
19709 (list 'org-display-inline-remove-overlay))
19710 (push ov org-inline-image-overlays)))))))))))))))
19712 (define-obsolete-function-alias
19713 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19715 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19716 "Remove inline-display overlay if a corresponding region is modified."
19717 (let ((inhibit-modification-hooks t))
19718 (when (and ov after)
19719 (delete ov org-inline-image-overlays)
19720 (delete-overlay ov))))
19722 (defun org-remove-inline-images ()
19723 "Remove inline display of images."
19724 (interactive)
19725 (mapc 'delete-overlay org-inline-image-overlays)
19726 (setq org-inline-image-overlays nil))
19728 ;;;; Key bindings
19730 ;; Outline functions from `outline-mode-prefix-map'
19731 ;; that can be remapped in Org:
19732 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19733 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19734 (define-key org-mode-map [remap outline-forward-same-level]
19735 'org-forward-heading-same-level)
19736 (define-key org-mode-map [remap outline-backward-same-level]
19737 'org-backward-heading-same-level)
19738 (define-key org-mode-map [remap show-branches]
19739 'org-kill-note-or-show-branches)
19740 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19741 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19742 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19743 (define-key org-mode-map [remap outline-next-visible-heading]
19744 'org-next-visible-heading)
19745 (define-key org-mode-map [remap outline-previous-visible-heading]
19746 'org-previous-visible-heading)
19748 ;; Outline functions from `outline-mode-prefix-map' that can not
19749 ;; be remapped in Org:
19751 ;; - the column "key binding" shows whether the Outline function is still
19752 ;; available in Org mode on the same key that it has been bound to in
19753 ;; Outline mode:
19754 ;; - "overridden": key used for a different functionality in Org mode
19755 ;; - else: key still bound to the same Outline function in Org mode
19757 ;; | Outline function | key binding | Org replacement |
19758 ;; |------------------------------------+-------------+--------------------------|
19759 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19760 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19761 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19762 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19763 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19764 ;; | `show-entry' | overridden | no replacement |
19765 ;; | `show-children' | `C-c C-i' | visibility cycling |
19766 ;; | `show-branches' | `C-c C-k' | still same function |
19767 ;; | `show-subtree' | overridden | visibility cycling |
19768 ;; | `show-all' | overridden | no replacement |
19769 ;; | `hide-subtree' | overridden | visibility cycling |
19770 ;; | `hide-body' | overridden | no replacement |
19771 ;; | `hide-entry' | overridden | visibility cycling |
19772 ;; | `hide-leaves' | overridden | no replacement |
19773 ;; | `hide-sublevels' | overridden | no replacement |
19774 ;; | `hide-other' | overridden | no replacement |
19776 ;; Make `C-c C-x' a prefix key
19777 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19779 ;; TAB key with modifiers
19780 (org-defkey org-mode-map "\C-i" 'org-cycle)
19781 (org-defkey org-mode-map [(tab)] 'org-cycle)
19782 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19783 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19784 ;; The following line is necessary under Suse GNU/Linux
19785 (unless (featurep 'xemacs)
19786 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19787 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19788 (define-key org-mode-map [backtab] 'org-shifttab)
19790 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19791 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19792 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19794 ;; Cursor keys with modifiers
19795 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19796 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19797 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19798 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19800 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19801 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19802 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19803 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19804 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19805 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19807 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19808 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19809 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19810 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19812 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19813 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19814 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19815 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19817 ;; Babel keys
19818 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19819 (mapc (lambda (pair)
19820 (define-key org-babel-map (car pair) (cdr pair)))
19821 org-babel-key-bindings)
19823 ;;; Extra keys for tty access.
19824 ;; We only set them when really needed because otherwise the
19825 ;; menus don't show the simple keys
19827 (when (or org-use-extra-keys
19828 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19829 (not window-system))
19830 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19831 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19832 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19833 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19834 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19835 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19836 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19837 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19838 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19839 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19840 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19841 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19842 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19843 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19844 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19845 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19846 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19847 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19848 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19849 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19850 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19851 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19852 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19853 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19854 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19855 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19856 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19857 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19859 ;; All the other keys
19861 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19862 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19863 (if (boundp 'narrow-map)
19864 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19865 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19866 (if (boundp 'narrow-map)
19867 (org-defkey narrow-map "b" 'org-narrow-to-block)
19868 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19869 (if (boundp 'narrow-map)
19870 (org-defkey narrow-map "e" 'org-narrow-to-element)
19871 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19872 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19873 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19874 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19875 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19876 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19877 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19878 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19879 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19880 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19881 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19882 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19883 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19884 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19885 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19886 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19887 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19888 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19889 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19890 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19891 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19892 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19893 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19894 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19895 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19896 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19897 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19898 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19899 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19900 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19901 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19902 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19903 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19904 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19905 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19906 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19907 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19908 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19909 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19910 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19911 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19912 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19913 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19914 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19915 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19916 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19917 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19918 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19919 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19920 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19921 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19922 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19923 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19924 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19925 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19926 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19927 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19928 (org-defkey org-mode-map "\C-c^" 'org-sort)
19929 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19930 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19931 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19932 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19933 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19934 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19935 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19936 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19937 (org-defkey org-mode-map "\C-m" 'org-return)
19938 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19939 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19940 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19941 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19942 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19943 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19944 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19945 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19946 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19947 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19948 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19949 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19950 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19951 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19952 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19953 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19954 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19955 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19956 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19957 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19958 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19959 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19960 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19961 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19962 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19964 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19965 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19966 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19968 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19969 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19970 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19971 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19972 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19973 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19974 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19975 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19976 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19977 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19978 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19979 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19980 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19981 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19982 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19983 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19984 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19985 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19986 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19987 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19988 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19989 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19991 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19992 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19993 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19994 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19995 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19997 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19999 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
20001 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
20002 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
20004 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
20007 (when (featurep 'xemacs)
20008 (org-defkey org-mode-map 'button3 'popup-mode-menu))
20011 (defconst org-speed-commands-default
20013 ("Outline Navigation")
20014 ("n" . (org-speed-move-safe 'org-next-visible-heading))
20015 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
20016 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
20017 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
20018 ("F" . org-next-block)
20019 ("B" . org-previous-block)
20020 ("u" . (org-speed-move-safe 'outline-up-heading))
20021 ("j" . org-goto)
20022 ("g" . (org-refile t))
20023 ("Outline Visibility")
20024 ("c" . org-cycle)
20025 ("C" . org-shifttab)
20026 (" " . org-display-outline-path)
20027 ("s" . org-narrow-to-subtree)
20028 ("=" . org-columns)
20029 ("Outline Structure Editing")
20030 ("U" . org-metaup)
20031 ("D" . org-metadown)
20032 ("r" . org-metaright)
20033 ("l" . org-metaleft)
20034 ("R" . org-shiftmetaright)
20035 ("L" . org-shiftmetaleft)
20036 ("i" . (progn (forward-char 1) (call-interactively
20037 'org-insert-heading-respect-content)))
20038 ("^" . org-sort)
20039 ("w" . org-refile)
20040 ("a" . org-archive-subtree-default-with-confirmation)
20041 ("@" . org-mark-subtree)
20042 ("#" . org-toggle-comment)
20043 ("Clock Commands")
20044 ("I" . org-clock-in)
20045 ("O" . org-clock-out)
20046 ("Meta Data Editing")
20047 ("t" . org-todo)
20048 ("," . (org-priority))
20049 ("0" . (org-priority ?\ ))
20050 ("1" . (org-priority ?A))
20051 ("2" . (org-priority ?B))
20052 ("3" . (org-priority ?C))
20053 (":" . org-set-tags-command)
20054 ("e" . org-set-effort)
20055 ("E" . org-inc-effort)
20056 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20057 (org-entry-put (point) "APPT_WARNTIME" m)))
20058 ("Agenda Views etc")
20059 ("v" . org-agenda)
20060 ("/" . org-sparse-tree)
20061 ("Misc")
20062 ("o" . org-open-at-point)
20063 ("?" . org-speed-command-help)
20064 ("<" . (org-agenda-set-restriction-lock 'subtree))
20065 (">" . (org-agenda-remove-restriction-lock))
20067 "The default speed commands.")
20069 (defun org-print-speed-command (e)
20070 (if (> (length (car e)) 1)
20071 (progn
20072 (princ "\n")
20073 (princ (car e))
20074 (princ "\n")
20075 (princ (make-string (length (car e)) ?-))
20076 (princ "\n"))
20077 (princ (car e))
20078 (princ " ")
20079 (if (symbolp (cdr e))
20080 (princ (symbol-name (cdr e)))
20081 (prin1 (cdr e)))
20082 (princ "\n")))
20084 (defun org-speed-command-help ()
20085 "Show the available speed commands."
20086 (interactive)
20087 (if (not org-use-speed-commands)
20088 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20089 (with-output-to-temp-buffer "*Help*"
20090 (princ "User-defined Speed commands\n===========================\n")
20091 (mapc 'org-print-speed-command org-speed-commands-user)
20092 (princ "\n")
20093 (princ "Built-in Speed commands\n=======================\n")
20094 (mapc 'org-print-speed-command org-speed-commands-default))
20095 (with-current-buffer "*Help*"
20096 (setq truncate-lines t))))
20098 (defun org-speed-move-safe (cmd)
20099 "Execute CMD, but make sure that the cursor always ends up in a headline.
20100 If not, return to the original position and throw an error."
20101 (interactive)
20102 (let ((pos (point)))
20103 (call-interactively cmd)
20104 (unless (and (bolp) (org-at-heading-p))
20105 (goto-char pos)
20106 (error "Boundary reached while executing %s" cmd))))
20108 (defvar org-self-insert-command-undo-counter 0)
20110 (defvar org-table-auto-blank-field) ; defined in org-table.el
20111 (defvar org-speed-command nil)
20113 (define-obsolete-function-alias
20114 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20116 (defun org-speed-command-activate (keys)
20117 "Hook for activating single-letter speed commands.
20118 `org-speed-commands-default' specifies a minimal command set.
20119 Use `org-speed-commands-user' for further customization."
20120 (when (or (and (bolp) (looking-at org-outline-regexp))
20121 (and (functionp org-use-speed-commands)
20122 (funcall org-use-speed-commands)))
20123 (cdr (assoc keys (append org-speed-commands-user
20124 org-speed-commands-default)))))
20126 (define-obsolete-function-alias
20127 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20129 (defun org-babel-speed-command-activate (keys)
20130 "Hook for activating single-letter code block commands."
20131 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20132 (cdr (assoc keys org-babel-key-bindings))))
20134 (defcustom org-speed-command-hook
20135 '(org-speed-command-default-hook org-babel-speed-command-hook)
20136 "Hook for activating speed commands at strategic locations.
20137 Hook functions are called in sequence until a valid handler is
20138 found.
20140 Each hook takes a single argument, a user-pressed command key
20141 which is also a `self-insert-command' from the global map.
20143 Within the hook, examine the cursor position and the command key
20144 and return nil or a valid handler as appropriate. Handler could
20145 be one of an interactive command, a function, or a form.
20147 Set `org-use-speed-commands' to non-nil value to enable this
20148 hook. The default setting is `org-speed-command-activate'."
20149 :group 'org-structure
20150 :version "24.1"
20151 :type 'hook)
20153 (defun org-self-insert-command (N)
20154 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20155 If the cursor is in a table looking at whitespace, the whitespace is
20156 overwritten, and the table is not marked as requiring realignment."
20157 (interactive "p")
20158 (org-check-before-invisible-edit 'insert)
20159 (cond
20160 ((and org-use-speed-commands
20161 (let ((kv (this-command-keys-vector)))
20162 (setq org-speed-command
20163 (run-hook-with-args-until-success
20164 'org-speed-command-hook
20165 (make-string 1 (aref kv (1- (length kv))))))))
20166 (cond
20167 ((commandp org-speed-command)
20168 (setq this-command org-speed-command)
20169 (call-interactively org-speed-command))
20170 ((functionp org-speed-command)
20171 (funcall org-speed-command))
20172 ((and org-speed-command (listp org-speed-command))
20173 (eval org-speed-command))
20174 (t (let (org-use-speed-commands)
20175 (call-interactively 'org-self-insert-command)))))
20176 ((and
20177 (org-table-p)
20178 (progn
20179 ;; check if we blank the field, and if that triggers align
20180 (and (featurep 'org-table) org-table-auto-blank-field
20181 (memq last-command
20182 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20183 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20184 ;; got extra space, this field does not determine column width
20185 (let (org-table-may-need-update) (org-table-blank-field))
20186 ;; no extra space, this field may determine column width
20187 (org-table-blank-field)))
20189 (eq N 1)
20190 (looking-at "[^|\n]* |"))
20191 (let (org-table-may-need-update)
20192 (goto-char (1- (match-end 0)))
20193 (backward-delete-char 1)
20194 (goto-char (match-beginning 0))
20195 (self-insert-command N)))
20197 (setq org-table-may-need-update t)
20198 (self-insert-command N)
20199 (org-fix-tags-on-the-fly)
20200 (if org-self-insert-cluster-for-undo
20201 (if (not (eq last-command 'org-self-insert-command))
20202 (setq org-self-insert-command-undo-counter 1)
20203 (if (>= org-self-insert-command-undo-counter 20)
20204 (setq org-self-insert-command-undo-counter 1)
20205 (and (> org-self-insert-command-undo-counter 0)
20206 buffer-undo-list (listp buffer-undo-list)
20207 (not (cadr buffer-undo-list)) ; remove nil entry
20208 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20209 (setq org-self-insert-command-undo-counter
20210 (1+ org-self-insert-command-undo-counter))))))))
20212 (defun org-check-before-invisible-edit (kind)
20213 "Check is editing if kind KIND would be dangerous with invisible text around.
20214 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20215 ;; First, try to get out of here as quickly as possible, to reduce overhead
20216 (if (and org-catch-invisible-edits
20217 (or (not (boundp 'visible-mode)) (not visible-mode))
20218 (or (get-char-property (point) 'invisible)
20219 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20220 ;; OK, we need to take a closer look
20221 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20222 (invisible-before-point (if (bobp) nil (get-char-property
20223 (1- (point)) 'invisible)))
20224 (border-and-ok-direction
20226 ;; Check if we are acting predictably before invisible text
20227 (and invisible-at-point (not invisible-before-point)
20228 (memq kind '(insert delete-backward)))
20229 ;; Check if we are acting predictably after invisible text
20230 ;; This works not well, and I have turned it off. It seems
20231 ;; better to always show and stop after invisible text.
20232 ;; (and (not invisible-at-point) invisible-before-point
20233 ;; (memq kind '(insert delete)))
20235 (when (or (memq invisible-at-point '(outline org-hide-block t))
20236 (memq invisible-before-point '(outline org-hide-block t)))
20237 (if (eq org-catch-invisible-edits 'error)
20238 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20239 (if (and org-custom-properties-overlays
20240 (y-or-n-p "Display invisible properties in this buffer? "))
20241 (org-toggle-custom-properties-visibility)
20242 ;; Make the area visible
20243 (save-excursion
20244 (if invisible-before-point
20245 (goto-char (previous-single-char-property-change
20246 (point) 'invisible)))
20247 (show-subtree))
20248 (cond
20249 ((eq org-catch-invisible-edits 'show)
20250 ;; That's it, we do the edit after showing
20251 (message
20252 "Unfolding invisible region around point before editing")
20253 (sit-for 1))
20254 ((and (eq org-catch-invisible-edits 'smart)
20255 border-and-ok-direction)
20256 (message "Unfolding invisible region around point before editing"))
20258 ;; Don't do the edit, make the user repeat it in full visibility
20259 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20261 (defun org-fix-tags-on-the-fly ()
20262 (when (and (equal (char-after (point-at-bol)) ?*)
20263 (org-at-heading-p))
20264 (org-align-tags-here org-tags-column)))
20266 (defun org-delete-backward-char (N)
20267 "Like `delete-backward-char', insert whitespace at field end in tables.
20268 When deleting backwards, in tables this function will insert whitespace in
20269 front of the next \"|\" separator, to keep the table aligned. The table will
20270 still be marked for re-alignment if the field did fill the entire column,
20271 because, in this case the deletion might narrow the column."
20272 (interactive "p")
20273 (save-match-data
20274 (org-check-before-invisible-edit 'delete-backward)
20275 (if (and (org-table-p)
20276 (eq N 1)
20277 (string-match "|" (buffer-substring (point-at-bol) (point)))
20278 (looking-at ".*?|"))
20279 (let ((pos (point))
20280 (noalign (looking-at "[^|\n\r]* |"))
20281 (c org-table-may-need-update))
20282 (backward-delete-char N)
20283 (if (not overwrite-mode)
20284 (progn
20285 (skip-chars-forward "^|")
20286 (insert " ")
20287 (goto-char (1- pos))))
20288 ;; noalign: if there were two spaces at the end, this field
20289 ;; does not determine the width of the column.
20290 (if noalign (setq org-table-may-need-update c)))
20291 (backward-delete-char N)
20292 (org-fix-tags-on-the-fly))))
20294 (defun org-delete-char (N)
20295 "Like `delete-char', but insert whitespace at field end in tables.
20296 When deleting characters, in tables this function will insert whitespace in
20297 front of the next \"|\" separator, to keep the table aligned. The table will
20298 still be marked for re-alignment if the field did fill the entire column,
20299 because, in this case the deletion might narrow the column."
20300 (interactive "p")
20301 (save-match-data
20302 (org-check-before-invisible-edit 'delete)
20303 (if (and (org-table-p)
20304 (not (bolp))
20305 (not (= (char-after) ?|))
20306 (eq N 1))
20307 (if (looking-at ".*?|")
20308 (let ((pos (point))
20309 (noalign (looking-at "[^|\n\r]* |"))
20310 (c org-table-may-need-update))
20311 (replace-match
20312 (concat (substring (match-string 0) 1 -1) " |") nil t)
20313 (goto-char pos)
20314 ;; noalign: if there were two spaces at the end, this field
20315 ;; does not determine the width of the column.
20316 (if noalign (setq org-table-may-need-update c)))
20317 (delete-char N))
20318 (delete-char N)
20319 (org-fix-tags-on-the-fly))))
20321 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20322 (put 'org-self-insert-command 'delete-selection
20323 (lambda ()
20324 (not (run-hook-with-args-until-success
20325 'self-insert-uses-region-functions))))
20326 (put 'orgtbl-self-insert-command 'delete-selection
20327 (lambda ()
20328 (not (run-hook-with-args-until-success
20329 'self-insert-uses-region-functions))))
20330 (put 'org-delete-char 'delete-selection 'supersede)
20331 (put 'org-delete-backward-char 'delete-selection 'supersede)
20332 (put 'org-yank 'delete-selection 'yank)
20334 ;; Make `flyspell-mode' delay after some commands
20335 (put 'org-self-insert-command 'flyspell-delayed t)
20336 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20337 (put 'org-delete-char 'flyspell-delayed t)
20338 (put 'org-delete-backward-char 'flyspell-delayed t)
20340 ;; Make pabbrev-mode expand after org-mode commands
20341 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20342 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20344 (defun org-remap (map &rest commands)
20345 "In MAP, remap the functions given in COMMANDS.
20346 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20347 (let (new old)
20348 (while commands
20349 (setq old (pop commands) new (pop commands))
20350 (if (fboundp 'command-remapping)
20351 (org-defkey map (vector 'remap old) new)
20352 (substitute-key-definition old new map global-map)))))
20354 (defun org-transpose-words ()
20355 "Transpose words for Org.
20356 This uses the `org-mode-transpose-word-syntax-table' syntax
20357 table, which interprets characters in `org-emphasis-alist' as
20358 word constituents."
20359 (interactive)
20360 (with-syntax-table org-mode-transpose-word-syntax-table
20361 (call-interactively 'transpose-words)))
20362 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20364 (when (eq org-enable-table-editor 'optimized)
20365 ;; If the user wants maximum table support, we need to hijack
20366 ;; some standard editing functions
20367 (org-remap org-mode-map
20368 'self-insert-command 'org-self-insert-command
20369 'delete-char 'org-delete-char
20370 'delete-backward-char 'org-delete-backward-char)
20371 (org-defkey org-mode-map "|" 'org-force-self-insert))
20373 (defvar org-ctrl-c-ctrl-c-hook nil
20374 "Hook for functions attaching themselves to `C-c C-c'.
20376 This can be used to add additional functionality to the C-c C-c
20377 key which executes context-dependent commands. This hook is run
20378 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20379 run after the last test.
20381 Each function will be called with no arguments. The function
20382 must check if the context is appropriate for it to act. If yes,
20383 it should do its thing and then return a non-nil value. If the
20384 context is wrong, just do nothing and return nil.")
20386 (defvar org-ctrl-c-ctrl-c-final-hook nil
20387 "Hook for functions attaching themselves to `C-c C-c'.
20389 This can be used to add additional functionality to the C-c C-c
20390 key which executes context-dependent commands. This hook is run
20391 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20392 before the first test.
20394 Each function will be called with no arguments. The function
20395 must check if the context is appropriate for it to act. If yes,
20396 it should do its thing and then return a non-nil value. If the
20397 context is wrong, just do nothing and return nil.")
20399 (defvar org-tab-first-hook nil
20400 "Hook for functions to attach themselves to TAB.
20401 See `org-ctrl-c-ctrl-c-hook' for more information.
20402 This hook runs as the first action when TAB is pressed, even before
20403 `org-cycle' messes around with the `outline-regexp' to cater for
20404 inline tasks and plain list item folding.
20405 If any function in this hook returns t, any other actions that
20406 would have been caused by TAB (such as table field motion or visibility
20407 cycling) will not occur.")
20409 (defvar org-tab-after-check-for-table-hook nil
20410 "Hook for functions to attach themselves to TAB.
20411 See `org-ctrl-c-ctrl-c-hook' for more information.
20412 This hook runs after it has been established that the cursor is not in a
20413 table, but before checking if the cursor is in a headline or if global cycling
20414 should be done.
20415 If any function in this hook returns t, not other actions like visibility
20416 cycling will be done.")
20418 (defvar org-tab-after-check-for-cycling-hook nil
20419 "Hook for functions to attach themselves to TAB.
20420 See `org-ctrl-c-ctrl-c-hook' for more information.
20421 This hook runs after it has been established that not table field motion and
20422 not visibility should be done because of current context. This is probably
20423 the place where a package like yasnippets can hook in.")
20425 (defvar org-tab-before-tab-emulation-hook nil
20426 "Hook for functions to attach themselves to TAB.
20427 See `org-ctrl-c-ctrl-c-hook' for more information.
20428 This hook runs after every other options for TAB have been exhausted, but
20429 before indentation and \t insertion takes place.")
20431 (defvar org-metaleft-hook nil
20432 "Hook for functions attaching themselves to `M-left'.
20433 See `org-ctrl-c-ctrl-c-hook' for more information.")
20434 (defvar org-metaright-hook nil
20435 "Hook for functions attaching themselves to `M-right'.
20436 See `org-ctrl-c-ctrl-c-hook' for more information.")
20437 (defvar org-metaup-hook nil
20438 "Hook for functions attaching themselves to `M-up'.
20439 See `org-ctrl-c-ctrl-c-hook' for more information.")
20440 (defvar org-metadown-hook nil
20441 "Hook for functions attaching themselves to `M-down'.
20442 See `org-ctrl-c-ctrl-c-hook' for more information.")
20443 (defvar org-shiftmetaleft-hook nil
20444 "Hook for functions attaching themselves to `M-S-left'.
20445 See `org-ctrl-c-ctrl-c-hook' for more information.")
20446 (defvar org-shiftmetaright-hook nil
20447 "Hook for functions attaching themselves to `M-S-right'.
20448 See `org-ctrl-c-ctrl-c-hook' for more information.")
20449 (defvar org-shiftmetaup-hook nil
20450 "Hook for functions attaching themselves to `M-S-up'.
20451 See `org-ctrl-c-ctrl-c-hook' for more information.")
20452 (defvar org-shiftmetadown-hook nil
20453 "Hook for functions attaching themselves to `M-S-down'.
20454 See `org-ctrl-c-ctrl-c-hook' for more information.")
20455 (defvar org-metareturn-hook nil
20456 "Hook for functions attaching themselves to `M-RET'.
20457 See `org-ctrl-c-ctrl-c-hook' for more information.")
20458 (defvar org-shiftup-hook nil
20459 "Hook for functions attaching themselves to `S-up'.
20460 See `org-ctrl-c-ctrl-c-hook' for more information.")
20461 (defvar org-shiftup-final-hook nil
20462 "Hook for functions attaching themselves to `S-up'.
20463 This one runs after all other options except shift-select have been excluded.
20464 See `org-ctrl-c-ctrl-c-hook' for more information.")
20465 (defvar org-shiftdown-hook nil
20466 "Hook for functions attaching themselves to `S-down'.
20467 See `org-ctrl-c-ctrl-c-hook' for more information.")
20468 (defvar org-shiftdown-final-hook nil
20469 "Hook for functions attaching themselves to `S-down'.
20470 This one runs after all other options except shift-select have been excluded.
20471 See `org-ctrl-c-ctrl-c-hook' for more information.")
20472 (defvar org-shiftleft-hook nil
20473 "Hook for functions attaching themselves to `S-left'.
20474 See `org-ctrl-c-ctrl-c-hook' for more information.")
20475 (defvar org-shiftleft-final-hook nil
20476 "Hook for functions attaching themselves to `S-left'.
20477 This one runs after all other options except shift-select have been excluded.
20478 See `org-ctrl-c-ctrl-c-hook' for more information.")
20479 (defvar org-shiftright-hook nil
20480 "Hook for functions attaching themselves to `S-right'.
20481 See `org-ctrl-c-ctrl-c-hook' for more information.")
20482 (defvar org-shiftright-final-hook nil
20483 "Hook for functions attaching themselves to `S-right'.
20484 This one runs after all other options except shift-select have been excluded.
20485 See `org-ctrl-c-ctrl-c-hook' for more information.")
20487 (defun org-modifier-cursor-error ()
20488 "Throw an error, a modified cursor command was applied in wrong context."
20489 (user-error "This command is active in special context like tables, headlines or items"))
20491 (defun org-shiftselect-error ()
20492 "Throw an error because Shift-Cursor command was applied in wrong context."
20493 (if (and (boundp 'shift-select-mode) shift-select-mode)
20494 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20495 (user-error "This command works only in special context like headlines or timestamps")))
20497 (defun org-call-for-shift-select (cmd)
20498 (let ((this-command-keys-shift-translated t))
20499 (call-interactively cmd)))
20501 (defun org-shifttab (&optional arg)
20502 "Global visibility cycling or move to previous table field.
20503 Call `org-table-previous-field' within a table.
20504 When ARG is nil, cycle globally through visibility states.
20505 When ARG is a numeric prefix, show contents of this level."
20506 (interactive "P")
20507 (cond
20508 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20509 ((integerp arg)
20510 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20511 (message "Content view to level: %d" arg)
20512 (org-content (prefix-numeric-value arg2))
20513 (org-cycle-show-empty-lines t)
20514 (setq org-cycle-global-status 'overview)))
20515 (t (call-interactively 'org-global-cycle))))
20517 (defun org-shiftmetaleft ()
20518 "Promote subtree or delete table column.
20519 Calls `org-promote-subtree', `org-outdent-item-tree', or
20520 `org-table-delete-column', depending on context. See the
20521 individual commands for more information."
20522 (interactive)
20523 (cond
20524 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20525 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20526 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20527 ((if (not (org-region-active-p)) (org-at-item-p)
20528 (save-excursion (goto-char (region-beginning))
20529 (org-at-item-p)))
20530 (call-interactively 'org-outdent-item-tree))
20531 (t (org-modifier-cursor-error))))
20533 (defun org-shiftmetaright ()
20534 "Demote subtree or insert table column.
20535 Calls `org-demote-subtree', `org-indent-item-tree', or
20536 `org-table-insert-column', depending on context. See the
20537 individual commands for more information."
20538 (interactive)
20539 (cond
20540 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20541 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20542 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20543 ((if (not (org-region-active-p)) (org-at-item-p)
20544 (save-excursion (goto-char (region-beginning))
20545 (org-at-item-p)))
20546 (call-interactively 'org-indent-item-tree))
20547 (t (org-modifier-cursor-error))))
20549 (defun org-shiftmetaup (&optional arg)
20550 "Drag the line at point up.
20551 In a table, kill the current row.
20552 On a clock timestamp, update the value of the timestamp like `S-<up>'
20553 but also adjust the previous clocked item in the clock history.
20554 Everywhere else, drag the line at point up."
20555 (interactive "P")
20556 (cond
20557 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20558 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20559 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20560 (call-interactively 'org-timestamp-up)))
20561 (t (call-interactively 'org-drag-line-backward))))
20563 (defun org-shiftmetadown (&optional arg)
20564 "Drag the line at point down.
20565 In a table, insert an empty row at the current line.
20566 On a clock timestamp, update the value of the timestamp like `S-<down>'
20567 but also adjust the previous clocked item in the clock history.
20568 Everywhere else, drag the line at point down."
20569 (interactive "P")
20570 (cond
20571 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20572 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20573 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20574 (call-interactively 'org-timestamp-down)))
20575 (t (call-interactively 'org-drag-line-forward))))
20577 (defsubst org-hidden-tree-error ()
20578 (user-error
20579 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20581 (defun org-metaleft (&optional arg)
20582 "Promote heading, list item at point or move table column left.
20584 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20585 depending on context. With no specific context, calls the Emacs
20586 default `backward-word'. See the individual commands for more
20587 information.
20589 This function runs the hook `org-metaleft-hook' as a first step,
20590 and returns at first non-nil value."
20591 (interactive "P")
20592 (cond
20593 ((run-hook-with-args-until-success 'org-metaleft-hook))
20594 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20595 ((org-with-limited-levels
20596 (or (org-at-heading-p)
20597 (and (org-region-active-p)
20598 (save-excursion
20599 (goto-char (region-beginning))
20600 (org-at-heading-p)))))
20601 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20602 (call-interactively 'org-do-promote))
20603 ;; At an inline task.
20604 ((org-at-heading-p)
20605 (call-interactively 'org-inlinetask-promote))
20606 ((or (org-at-item-p)
20607 (and (org-region-active-p)
20608 (save-excursion
20609 (goto-char (region-beginning))
20610 (org-at-item-p))))
20611 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20612 (call-interactively 'org-outdent-item))
20613 (t (call-interactively 'backward-word))))
20615 (defun org-metaright (&optional arg)
20616 "Demote heading, list item at point or move table column right.
20618 In front of a drawer or a block keyword, indent it correctly.
20620 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20621 `org-indnet-drawer' or `org-indent-block' depending on context.
20622 With no specific context, calls the Emacs default `forward-word'.
20623 See the individual commands for more information.
20625 This function runs the hook `org-metaright-hook' as a first step,
20626 and returns at first non-nil value."
20627 (interactive "P")
20628 (cond
20629 ((run-hook-with-args-until-success 'org-metaright-hook))
20630 ((org-at-table-p) (call-interactively 'org-table-move-column))
20631 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20632 ((org-at-block-p) (call-interactively 'org-indent-block))
20633 ((org-with-limited-levels
20634 (or (org-at-heading-p)
20635 (and (org-region-active-p)
20636 (save-excursion
20637 (goto-char (region-beginning))
20638 (org-at-heading-p)))))
20639 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20640 (call-interactively 'org-do-demote))
20641 ;; At an inline task.
20642 ((org-at-heading-p)
20643 (call-interactively 'org-inlinetask-demote))
20644 ((or (org-at-item-p)
20645 (and (org-region-active-p)
20646 (save-excursion
20647 (goto-char (region-beginning))
20648 (org-at-item-p))))
20649 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20650 (call-interactively 'org-indent-item))
20651 (t (call-interactively 'forward-word))))
20653 (defun org-check-for-hidden (what)
20654 "Check if there are hidden headlines/items in the current visual line.
20655 WHAT can be either `headlines' or `items'. If the current line is
20656 an outline or item heading and it has a folded subtree below it,
20657 this function returns t, nil otherwise."
20658 (let ((re (cond
20659 ((eq what 'headlines) org-outline-regexp-bol)
20660 ((eq what 'items) (org-item-beginning-re))
20661 (t (error "This should not happen"))))
20662 beg end)
20663 (save-excursion
20664 (catch 'exit
20665 (unless (org-region-active-p)
20666 (setq beg (point-at-bol))
20667 (beginning-of-line 2)
20668 (while (and (not (eobp)) ;; this is like `next-line'
20669 (get-char-property (1- (point)) 'invisible))
20670 (beginning-of-line 2))
20671 (setq end (point))
20672 (goto-char beg)
20673 (goto-char (point-at-eol))
20674 (setq end (max end (point)))
20675 (while (re-search-forward re end t)
20676 (if (get-char-property (match-beginning 0) 'invisible)
20677 (throw 'exit t))))
20678 nil))))
20680 (defun org-metaup (&optional arg)
20681 "Move subtree up or move table row up.
20682 Calls `org-move-subtree-up' or `org-table-move-row' or
20683 `org-move-item-up', depending on context. See the individual commands
20684 for more information."
20685 (interactive "P")
20686 (cond
20687 ((run-hook-with-args-until-success 'org-metaup-hook))
20688 ((org-region-active-p)
20689 (let* ((a (min (region-beginning) (region-end)))
20690 (b (1- (max (region-beginning) (region-end))))
20691 (c (save-excursion (goto-char a)
20692 (move-beginning-of-line 0)))
20693 (d (save-excursion (goto-char a)
20694 (move-end-of-line 0) (point))))
20695 (transpose-regions a b c d)
20696 (goto-char c)))
20697 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20698 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20699 ((org-at-item-p) (call-interactively 'org-move-item-up))
20700 (t (org-drag-element-backward))))
20702 (defun org-metadown (&optional arg)
20703 "Move subtree down or move table row down.
20704 Calls `org-move-subtree-down' or `org-table-move-row' or
20705 `org-move-item-down', depending on context. See the individual
20706 commands for more information."
20707 (interactive "P")
20708 (cond
20709 ((run-hook-with-args-until-success 'org-metadown-hook))
20710 ((org-region-active-p)
20711 (let* ((a (min (region-beginning) (region-end)))
20712 (b (max (region-beginning) (region-end)))
20713 (c (save-excursion (goto-char b)
20714 (move-beginning-of-line 1)))
20715 (d (save-excursion (goto-char b)
20716 (move-end-of-line 1) (1+ (point)))))
20717 (transpose-regions a b c d)
20718 (goto-char d)))
20719 ((org-at-table-p) (call-interactively 'org-table-move-row))
20720 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20721 ((org-at-item-p) (call-interactively 'org-move-item-down))
20722 (t (org-drag-element-forward))))
20724 (defun org-shiftup (&optional arg)
20725 "Increase item in timestamp or increase priority of current headline.
20726 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20727 depending on context. See the individual commands for more information."
20728 (interactive "P")
20729 (cond
20730 ((run-hook-with-args-until-success 'org-shiftup-hook))
20731 ((and org-support-shift-select (org-region-active-p))
20732 (org-call-for-shift-select 'previous-line))
20733 ((org-at-timestamp-p t)
20734 (call-interactively (if org-edit-timestamp-down-means-later
20735 'org-timestamp-down 'org-timestamp-up)))
20736 ((and (not (eq org-support-shift-select 'always))
20737 org-enable-priority-commands
20738 (org-at-heading-p))
20739 (call-interactively 'org-priority-up))
20740 ((and (not org-support-shift-select) (org-at-item-p))
20741 (call-interactively 'org-previous-item))
20742 ((org-clocktable-try-shift 'up arg))
20743 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20744 (org-support-shift-select
20745 (org-call-for-shift-select 'previous-line))
20746 (t (org-shiftselect-error))))
20748 (defun org-shiftdown (&optional arg)
20749 "Decrease item in timestamp or decrease priority of current headline.
20750 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20751 depending on context. See the individual commands for more information."
20752 (interactive "P")
20753 (cond
20754 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20755 ((and org-support-shift-select (org-region-active-p))
20756 (org-call-for-shift-select 'next-line))
20757 ((org-at-timestamp-p t)
20758 (call-interactively (if org-edit-timestamp-down-means-later
20759 'org-timestamp-up 'org-timestamp-down)))
20760 ((and (not (eq org-support-shift-select 'always))
20761 org-enable-priority-commands
20762 (org-at-heading-p))
20763 (call-interactively 'org-priority-down))
20764 ((and (not org-support-shift-select) (org-at-item-p))
20765 (call-interactively 'org-next-item))
20766 ((org-clocktable-try-shift 'down arg))
20767 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20768 (org-support-shift-select
20769 (org-call-for-shift-select 'next-line))
20770 (t (org-shiftselect-error))))
20772 (defun org-shiftright (&optional arg)
20773 "Cycle the thing at point or in the current line, depending on context.
20774 Depending on context, this does one of the following:
20776 - switch a timestamp at point one day into the future
20777 - on a headline, switch to the next TODO keyword.
20778 - on an item, switch entire list to the next bullet type
20779 - on a property line, switch to the next allowed value
20780 - on a clocktable definition line, move time block into the future"
20781 (interactive "P")
20782 (cond
20783 ((run-hook-with-args-until-success 'org-shiftright-hook))
20784 ((and org-support-shift-select (org-region-active-p))
20785 (org-call-for-shift-select 'forward-char))
20786 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20787 ((and (not (eq org-support-shift-select 'always))
20788 (org-at-heading-p))
20789 (let ((org-inhibit-logging
20790 (not org-treat-S-cursor-todo-selection-as-state-change))
20791 (org-inhibit-blocking
20792 (not org-treat-S-cursor-todo-selection-as-state-change)))
20793 (org-call-with-arg 'org-todo 'right)))
20794 ((or (and org-support-shift-select
20795 (not (eq org-support-shift-select 'always))
20796 (org-at-item-bullet-p))
20797 (and (not org-support-shift-select) (org-at-item-p)))
20798 (org-call-with-arg 'org-cycle-list-bullet nil))
20799 ((and (not (eq org-support-shift-select 'always))
20800 (org-at-property-p))
20801 (call-interactively 'org-property-next-allowed-value))
20802 ((org-clocktable-try-shift 'right arg))
20803 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20804 (org-support-shift-select
20805 (org-call-for-shift-select 'forward-char))
20806 (t (org-shiftselect-error))))
20808 (defun org-shiftleft (&optional arg)
20809 "Cycle the thing at point or in the current line, depending on context.
20810 Depending on context, this does one of the following:
20812 - switch a timestamp at point one day into the past
20813 - on a headline, switch to the previous TODO keyword.
20814 - on an item, switch entire list to the previous bullet type
20815 - on a property line, switch to the previous allowed value
20816 - on a clocktable definition line, move time block into the past"
20817 (interactive "P")
20818 (cond
20819 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20820 ((and org-support-shift-select (org-region-active-p))
20821 (org-call-for-shift-select 'backward-char))
20822 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20823 ((and (not (eq org-support-shift-select 'always))
20824 (org-at-heading-p))
20825 (let ((org-inhibit-logging
20826 (not org-treat-S-cursor-todo-selection-as-state-change))
20827 (org-inhibit-blocking
20828 (not org-treat-S-cursor-todo-selection-as-state-change)))
20829 (org-call-with-arg 'org-todo 'left)))
20830 ((or (and org-support-shift-select
20831 (not (eq org-support-shift-select 'always))
20832 (org-at-item-bullet-p))
20833 (and (not org-support-shift-select) (org-at-item-p)))
20834 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20835 ((and (not (eq org-support-shift-select 'always))
20836 (org-at-property-p))
20837 (call-interactively 'org-property-previous-allowed-value))
20838 ((org-clocktable-try-shift 'left arg))
20839 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20840 (org-support-shift-select
20841 (org-call-for-shift-select 'backward-char))
20842 (t (org-shiftselect-error))))
20844 (defun org-shiftcontrolright ()
20845 "Switch to next TODO set."
20846 (interactive)
20847 (cond
20848 ((and org-support-shift-select (org-region-active-p))
20849 (org-call-for-shift-select 'forward-word))
20850 ((and (not (eq org-support-shift-select 'always))
20851 (org-at-heading-p))
20852 (org-call-with-arg 'org-todo 'nextset))
20853 (org-support-shift-select
20854 (org-call-for-shift-select 'forward-word))
20855 (t (org-shiftselect-error))))
20857 (defun org-shiftcontrolleft ()
20858 "Switch to previous TODO set."
20859 (interactive)
20860 (cond
20861 ((and org-support-shift-select (org-region-active-p))
20862 (org-call-for-shift-select 'backward-word))
20863 ((and (not (eq org-support-shift-select 'always))
20864 (org-at-heading-p))
20865 (org-call-with-arg 'org-todo 'previousset))
20866 (org-support-shift-select
20867 (org-call-for-shift-select 'backward-word))
20868 (t (org-shiftselect-error))))
20870 (defun org-shiftcontrolup (&optional n)
20871 "Change timestamps synchronously up in CLOCK log lines.
20872 Optional argument N tells to change by that many units."
20873 (interactive "P")
20874 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20875 (let (org-support-shift-select)
20876 (org-clock-timestamps-up n))
20877 (user-error "Not at a clock log")))
20879 (defun org-shiftcontroldown (&optional n)
20880 "Change timestamps synchronously down in CLOCK log lines.
20881 Optional argument N tells to change by that many units."
20882 (interactive "P")
20883 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20884 (let (org-support-shift-select)
20885 (org-clock-timestamps-down n))
20886 (user-error "Not at a clock log")))
20888 (defun org-increase-number-at-point (&optional inc)
20889 "Increment the number at point.
20890 With an optional prefix numeric argument INC, increment using
20891 this numeric value."
20892 (interactive "p")
20893 (if (not (number-at-point))
20894 (user-error "Not on a number")
20895 (unless inc (setq inc 1))
20896 (let ((pos (point))
20897 (beg (skip-chars-backward "-+^/*0-9eE."))
20898 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20899 (setq nap (buffer-substring-no-properties
20900 (+ pos beg) (+ pos beg end)))
20901 (delete-region (+ pos beg) (+ pos beg end))
20902 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20903 (when (org-at-table-p)
20904 (org-table-align)
20905 (org-table-end-of-field 1))))
20907 (defun org-decrease-number-at-point (&optional inc)
20908 "Decrement the number at point.
20909 With an optional prefix numeric argument INC, decrement using
20910 this numeric value."
20911 (interactive "p")
20912 (org-increase-number-at-point (- (or inc 1))))
20914 (defun org-ctrl-c-ret ()
20915 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20916 (interactive)
20917 (cond
20918 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20919 (t (call-interactively 'org-insert-heading))))
20921 (defun org-find-visible ()
20922 (let ((s (point)))
20923 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20924 (get-char-property s 'invisible)))
20926 (defun org-find-invisible ()
20927 (let ((s (point)))
20928 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20929 (not (get-char-property s 'invisible))))
20932 (defun org-copy-visible (beg end)
20933 "Copy the visible parts of the region."
20934 (interactive "r")
20935 (let (snippets s)
20936 (save-excursion
20937 (save-restriction
20938 (narrow-to-region beg end)
20939 (setq s (goto-char (point-min)))
20940 (while (not (= (point) (point-max)))
20941 (goto-char (org-find-invisible))
20942 (push (buffer-substring s (point)) snippets)
20943 (setq s (goto-char (org-find-visible))))))
20944 (kill-new (apply 'concat (nreverse snippets)))))
20946 (defun org-copy-special ()
20947 "Copy region in table or copy current subtree.
20948 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20949 See the individual commands for more information."
20950 (interactive)
20951 (call-interactively
20952 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20954 (defun org-cut-special ()
20955 "Cut region in table or cut current subtree.
20956 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20957 See the individual commands for more information."
20958 (interactive)
20959 (call-interactively
20960 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20962 (defun org-paste-special (arg)
20963 "Paste rectangular region into table, or past subtree relative to level.
20964 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20965 See the individual commands for more information."
20966 (interactive "P")
20967 (if (org-at-table-p)
20968 (org-table-paste-rectangle)
20969 (org-paste-subtree arg)))
20971 (defsubst org-in-fixed-width-region-p ()
20972 "Is point in a fixed-width region?"
20973 (save-match-data
20974 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20976 (defun org-edit-special (&optional arg)
20977 "Call a special editor for the element at point.
20978 When at a table, call the formula editor with `org-table-edit-formulas'.
20979 When in a source code block, call `org-edit-src-code'.
20980 When in a fixed-width region, call `org-edit-fixed-width-region'.
20981 When in an export block, call `org-edit-export-block'.
20982 When at an #+INCLUDE keyword, visit the included file.
20983 When at a footnote reference, call `org-edit-footnote-reference'
20984 On a link, call `ffap' to visit the link at point.
20985 Otherwise, return a user error."
20986 (interactive "P")
20987 (let ((element (org-element-at-point)))
20988 (assert (not buffer-read-only) nil
20989 "Buffer is read-only: %s" (buffer-name))
20990 (case (org-element-type element)
20991 (src-block
20992 (if (not arg) (org-edit-src-code)
20993 (let* ((info (org-babel-get-src-block-info))
20994 (lang (nth 0 info))
20995 (params (nth 2 info))
20996 (session (cdr (assq :session params))))
20997 (if (not session) (org-edit-src-code)
20998 ;; At a src-block with a session and function called with
20999 ;; an ARG: switch to the buffer related to the inferior
21000 ;; process.
21001 (switch-to-buffer
21002 (funcall (intern (concat "org-babel-prep-session:" lang))
21003 session params))))))
21004 (keyword
21005 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
21006 (org-open-link-from-string
21007 (format "[[%s]]"
21008 (expand-file-name
21009 (let ((value (org-element-property :value element)))
21010 (cond ((not (org-string-nw-p value))
21011 (user-error "No file to edit"))
21012 ((string-match "\\`\"\\(.*?\\)\"" value)
21013 (match-string 1 value))
21014 ((string-match "\\`[^ \t\"]\\S-*" value)
21015 (match-string 0 value))
21016 (t (user-error "No valid file specified")))))))
21017 (user-error "No special environment to edit here")))
21018 (table
21019 (if (eq (org-element-property :type element) 'table.el)
21020 (org-edit-table.el)
21021 (call-interactively 'org-table-edit-formulas)))
21022 ;; Only Org tables contain `table-row' type elements.
21023 (table-row (call-interactively 'org-table-edit-formulas))
21024 (example-block (org-edit-src-code))
21025 (export-block (org-edit-export-block))
21026 (fixed-width (org-edit-fixed-width-region))
21027 (otherwise
21028 ;; No notable element at point. Though, we may be at a link or
21029 ;; a footnote reference, which are objects. Thus, scan deeper.
21030 (let ((context (org-element-context element)))
21031 (case (org-element-type context)
21032 (link (call-interactively #'ffap))
21033 (footnote-reference (org-edit-footnote-reference))
21034 (t (user-error "No special environment to edit here"))))))))
21036 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21037 (defun org-ctrl-c-ctrl-c (&optional arg)
21038 "Set tags in headline, or update according to changed information at point.
21040 This command does many different things, depending on context:
21042 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21043 this is what we do.
21045 - If the cursor is on a statistics cookie, update it.
21047 - If the cursor is in a headline, prompt for tags and insert them
21048 into the current line, aligned to `org-tags-column'. When called
21049 with prefix arg, realign all tags in the current buffer.
21051 - If the cursor is in one of the special #+KEYWORD lines, this
21052 triggers scanning the buffer for these lines and updating the
21053 information.
21055 - If the cursor is inside a table, realign the table. This command
21056 works even if the automatic table editor has been turned off.
21058 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21059 the entire table.
21061 - If the cursor is at a footnote reference or definition, jump to
21062 the corresponding definition or references, respectively.
21064 - If the cursor is a the beginning of a dynamic block, update it.
21066 - If the current buffer is a capture buffer, close note and file it.
21068 - If the cursor is on a <<<target>>>, update radio targets and
21069 corresponding links in this buffer.
21071 - If the cursor is on a numbered item in a plain list, renumber the
21072 ordered list.
21074 - If the cursor is on a checkbox, toggle it.
21076 - If the cursor is on a code block, evaluate it. The variable
21077 `org-confirm-babel-evaluate' can be used to control prompting
21078 before code block evaluation, by default every code block
21079 evaluation requires confirmation. Code block evaluation can be
21080 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21081 (interactive "P")
21082 (cond
21083 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21084 org-occur-highlights)
21085 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21086 (org-remove-occur-highlights)
21087 (message "Temporary highlights/overlays removed from current buffer"))
21088 ((and (local-variable-p 'org-finish-function (current-buffer))
21089 (fboundp org-finish-function))
21090 (funcall org-finish-function))
21091 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21093 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21094 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21095 (user-error "C-c C-c can do nothing useful at this location"))
21096 (let* ((context (org-element-context))
21097 (type (org-element-type context)))
21098 (case type
21099 ;; When at a link, act according to the parent instead.
21100 (link (setq context (org-element-property :parent context))
21101 (setq type (org-element-type context)))
21102 ;; Unsupported object types: refer to the first supported
21103 ;; element or object containing it.
21104 ((bold code entity export-snippet inline-babel-call inline-src-block
21105 italic latex-fragment line-break macro strike-through subscript
21106 superscript underline verbatim)
21107 (setq context
21108 (org-element-lineage
21109 context '(radio-target paragraph verse-block table-cell)))))
21110 ;; For convenience: at the first line of a paragraph on the
21111 ;; same line as an item, apply function on that item instead.
21112 (when (eq type 'paragraph)
21113 (let ((parent (org-element-property :parent context)))
21114 (when (and (eq (org-element-type parent) 'item)
21115 (= (line-beginning-position)
21116 (org-element-property :begin parent)))
21117 (setq context parent type 'item))))
21118 ;; Act according to type of element or object at point.
21119 (case type
21120 (clock (org-clock-update-time-maybe))
21121 (dynamic-block
21122 (save-excursion
21123 (goto-char (org-element-property :post-affiliated context))
21124 (org-update-dblock)))
21125 (footnote-definition
21126 (goto-char (org-element-property :post-affiliated context))
21127 (call-interactively 'org-footnote-action))
21128 (footnote-reference (call-interactively 'org-footnote-action))
21129 ((headline inlinetask)
21130 (save-excursion (goto-char (org-element-property :begin context))
21131 (call-interactively 'org-set-tags)))
21132 (item
21133 ;; At an item: a double C-u set checkbox to "[-]"
21134 ;; unconditionally, whereas a single one will toggle its
21135 ;; presence. Without a universal argument, if the item
21136 ;; has a checkbox, toggle it. Otherwise repair the list.
21137 (let* ((box (org-element-property :checkbox context))
21138 (struct (org-element-property :structure context))
21139 (old-struct (copy-tree struct))
21140 (parents (org-list-parents-alist struct))
21141 (prevs (org-list-prevs-alist struct))
21142 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21143 (org-list-set-checkbox
21144 (org-element-property :begin context) struct
21145 (cond ((equal arg '(16)) "[-]")
21146 ((and (not box) (equal arg '(4))) "[ ]")
21147 ((or (not box) (equal arg '(4))) nil)
21148 ((eq box 'on) "[ ]")
21149 (t "[X]")))
21150 ;; Mimic `org-list-write-struct' but with grabbing
21151 ;; a return value from `org-list-struct-fix-box'.
21152 (org-list-struct-fix-ind struct parents 2)
21153 (org-list-struct-fix-item-end struct)
21154 (org-list-struct-fix-bul struct prevs)
21155 (org-list-struct-fix-ind struct parents)
21156 (let ((block-item
21157 (org-list-struct-fix-box struct parents prevs orderedp)))
21158 (if (and box (equal struct old-struct))
21159 (if (equal arg '(16))
21160 (message "Checkboxes already reset")
21161 (user-error "Cannot toggle this checkbox: %s"
21162 (if (eq box 'on)
21163 "all subitems checked"
21164 "unchecked subitems")))
21165 (org-list-struct-apply-struct struct old-struct)
21166 (org-update-checkbox-count-maybe))
21167 (when block-item
21168 (message "Checkboxes were removed due to empty box at line %d"
21169 (org-current-line block-item))))))
21170 (keyword
21171 (let ((org-inhibit-startup-visibility-stuff t)
21172 (org-startup-align-all-tables nil))
21173 (when (boundp 'org-table-coordinate-overlays)
21174 (mapc 'delete-overlay org-table-coordinate-overlays)
21175 (setq org-table-coordinate-overlays nil))
21176 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21177 (message "Local setup has been refreshed"))
21178 (plain-list
21179 ;; At a plain list, with a double C-u argument, set
21180 ;; checkboxes of each item to "[-]", whereas a single one
21181 ;; will toggle their presence according to the state of the
21182 ;; first item in the list. Without an argument, repair the
21183 ;; list.
21184 (let* ((begin (org-element-property :contents-begin context))
21185 (beginm (move-marker (make-marker) begin))
21186 (struct (org-element-property :structure context))
21187 (old-struct (copy-tree struct))
21188 (first-box (save-excursion
21189 (goto-char begin)
21190 (looking-at org-list-full-item-re)
21191 (match-string-no-properties 3)))
21192 (new-box (cond ((equal arg '(16)) "[-]")
21193 ((equal arg '(4)) (unless first-box "[ ]"))
21194 ((equal first-box "[X]") "[ ]")
21195 (t "[X]"))))
21196 (cond
21197 (arg
21198 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21199 (org-list-get-all-items
21200 begin struct (org-list-prevs-alist struct))))
21201 ((and first-box (eq (point) begin))
21202 ;; For convenience, when point is at bol on the first
21203 ;; item of the list and no argument is provided, simply
21204 ;; toggle checkbox of that item, if any.
21205 (org-list-set-checkbox begin struct new-box)))
21206 (org-list-write-struct
21207 struct (org-list-parents-alist struct) old-struct)
21208 (org-update-checkbox-count-maybe)
21209 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21210 ((property-drawer node-property)
21211 (call-interactively 'org-property-action))
21212 ((radio-target target)
21213 (call-interactively 'org-update-radio-target-regexp))
21214 (statistics-cookie
21215 (call-interactively 'org-update-statistics-cookies))
21216 ((table table-cell table-row)
21217 ;; At a table, recalculate every field and align it. Also
21218 ;; send the table if necessary. If the table has
21219 ;; a `table.el' type, just give up. At a table row or
21220 ;; cell, maybe recalculate line but always align table.
21221 (if (eq (org-element-property :type context) 'table.el)
21222 (message "%s" (substitute-command-keys "\\<org-mode-map>\
21223 Use \\[org-edit-special] to edit table.el tables"))
21224 (let ((org-enable-table-editor t))
21225 (if (or (eq type 'table)
21226 ;; Check if point is at a TBLFM line.
21227 (and (eq type 'table-row)
21228 (= (point) (org-element-property :end context))))
21229 (save-excursion
21230 (if (org-at-TBLFM-p)
21231 (progn (require 'org-table)
21232 (org-table-calc-current-TBLFM))
21233 (goto-char (org-element-property :contents-begin context))
21234 (org-call-with-arg 'org-table-recalculate (or arg t))
21235 (orgtbl-send-table 'maybe)))
21236 (org-table-maybe-eval-formula)
21237 (cond (arg (call-interactively 'org-table-recalculate))
21238 ((org-table-maybe-recalculate-line))
21239 (t (org-table-align)))))))
21240 (timestamp (org-timestamp-change 0 'day))
21241 (otherwise
21242 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21243 (user-error
21244 "C-c C-c can do nothing useful at this location")))))))))
21246 (defun org-mode-restart ()
21247 (interactive)
21248 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21249 (funcall major-mode)
21250 (hack-local-variables)
21251 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21252 (org-indent-mode -1)))
21253 (message "%s restarted" major-mode))
21255 (defun org-kill-note-or-show-branches ()
21256 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21257 (interactive)
21258 (if (not org-finish-function)
21259 (progn
21260 (hide-subtree)
21261 (call-interactively 'show-branches))
21262 (let ((org-note-abort t))
21263 (funcall org-finish-function))))
21265 (defun org-delete-indentation (&optional ARG)
21266 "Join current line to previous and fix whitespace at join.
21268 If previous line is a headline add to headline title. Otherwise
21269 the function calls `delete-indentation'.
21271 With argument, join this line to following line."
21272 (interactive "*P")
21273 (if (save-excursion
21274 (if ARG (beginning-of-line)
21275 (forward-line -1))
21276 (looking-at org-complex-heading-regexp))
21277 ;; At headline.
21278 (let ((tags-column (when (match-beginning 5)
21279 (save-excursion (goto-char (match-beginning 5))
21280 (current-column))))
21281 (string (concat " " (progn (when ARG (forward-line 1))
21282 (org-trim (delete-and-extract-region
21283 (line-beginning-position)
21284 (line-end-position)))))))
21285 (unless (bobp) (delete-region (point) (1- (point))))
21286 (goto-char (or (match-end 4)
21287 (match-beginning 5)
21288 (match-end 0)))
21289 (skip-chars-backward " \t")
21290 (save-excursion (insert string))
21291 ;; Adjust alignment of tags.
21292 (when tags-column
21293 (org-align-tags-here (if org-auto-align-tags
21294 org-tags-column
21295 tags-column))))
21296 (delete-indentation ARG)))
21298 (defun org-open-line (n)
21299 "Insert a new row in tables, call `open-line' elsewhere.
21300 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21301 (interactive "*p")
21302 (cond
21303 ((not org-special-ctrl-o)
21304 (open-line n))
21305 ((org-at-table-p)
21306 (org-table-insert-row))
21308 (open-line n))))
21310 (defun org-return (&optional indent)
21311 "Goto next table row or insert a newline.
21313 Calls `org-table-next-row' or `newline', depending on context.
21315 When optional INDENT argument is non-nil, call
21316 `newline-and-indent' instead of `newline'.
21318 When `org-return-follows-link' is non-nil and point is on
21319 a timestamp or a link, call `org-open-at-point'. However, it
21320 will not happen if point is in a table or on a \"dead\"
21321 object (e.g., within a comment). In these case, you need to use
21322 `org-open-at-point' directly."
21323 (interactive)
21324 (let* ((context (if org-return-follows-link (org-element-context)
21325 (org-element-at-point)))
21326 (type (org-element-type context)))
21327 (cond
21328 ;; In a table, call `org-table-next-row'.
21329 ((or (and (eq type 'table)
21330 (>= (point) (org-element-property :contents-begin context))
21331 (< (point) (org-element-property :contents-end context)))
21332 (org-element-lineage context '(table-row table-cell) t))
21333 (org-table-justify-field-maybe)
21334 (call-interactively #'org-table-next-row))
21335 ;; On a link or a timestamp but not on white spaces after it,
21336 ;; call `org-open-line' if `org-return-follows-link' allows it.
21337 ((and org-return-follows-link
21338 (memq type '(link timestamp))
21339 (< (point)
21340 (save-excursion (goto-char (org-element-property :end context))
21341 (skip-chars-backward " \t")
21342 (point))))
21343 (call-interactively #'org-open-at-point))
21344 ;; Insert newline in heading, but preserve tags.
21345 ((and (not (bolp))
21346 (save-excursion (beginning-of-line)
21347 (looking-at org-complex-heading-regexp)))
21348 ;; At headline. Split line. However, if point is on keyword,
21349 ;; priority cookie or tags, do not break any of them: add
21350 ;; a newline after the headline instead.
21351 (let ((tags-column (and (match-beginning 5)
21352 (save-excursion (goto-char (match-beginning 5))
21353 (current-column))))
21354 (string
21355 (when (and (match-end 4)
21356 (>= (point)
21357 (or (match-end 3) (match-end 2) (1+ (match-end 1))))
21358 (<= (point) (match-end 4)))
21359 (delete-and-extract-region (point) (match-end 4)))))
21360 (when (and tags-column string) ; Adjust tag alignment.
21361 (org-align-tags-here
21362 (if org-auto-align-tags org-tags-column tags-column)))
21363 (end-of-line)
21364 (org-show-entry)
21365 (if indent (newline-and-indent) (newline))
21366 (when string (save-excursion (insert (org-trim string))))))
21367 ;; In a list, make sure indenting keeps trailing text within.
21368 ((and indent
21369 (not (eolp))
21370 (org-element-lineage context '(item)))
21371 (let ((trailing-data
21372 (delete-and-extract-region (point) (line-end-position))))
21373 (newline-and-indent)
21374 (save-excursion (insert trailing-data))))
21375 (t (if indent (newline-and-indent) (newline))))))
21377 (defun org-return-indent ()
21378 "Goto next table row or insert a newline and indent.
21379 Calls `org-table-next-row' or `newline-and-indent', depending on
21380 context. See the individual commands for more information."
21381 (interactive)
21382 (org-return t))
21384 (defun org-ctrl-c-star ()
21385 "Compute table, or change heading status of lines.
21386 Calls `org-table-recalculate' or `org-toggle-heading',
21387 depending on context."
21388 (interactive)
21389 (cond
21390 ((org-at-table-p)
21391 (call-interactively 'org-table-recalculate))
21393 ;; Convert all lines in region to list items
21394 (call-interactively 'org-toggle-heading))))
21396 (defun org-ctrl-c-minus ()
21397 "Insert separator line in table or modify bullet status of line.
21398 Also turns a plain line or a region of lines into list items.
21399 Calls `org-table-insert-hline', `org-toggle-item', or
21400 `org-cycle-list-bullet', depending on context."
21401 (interactive)
21402 (cond
21403 ((org-at-table-p)
21404 (call-interactively 'org-table-insert-hline))
21405 ((org-region-active-p)
21406 (call-interactively 'org-toggle-item))
21407 ((org-in-item-p)
21408 (call-interactively 'org-cycle-list-bullet))
21410 (call-interactively 'org-toggle-item))))
21412 (defun org-toggle-item (arg)
21413 "Convert headings or normal lines to items, items to normal lines.
21414 If there is no active region, only the current line is considered.
21416 If the first non blank line in the region is a headline, convert
21417 all headlines to items, shifting text accordingly.
21419 If it is an item, convert all items to normal lines.
21421 If it is normal text, change region into a list of items.
21422 With a prefix argument ARG, change the region in a single item."
21423 (interactive "P")
21424 (let ((shift-text
21425 (function
21426 ;; Shift text in current section to IND, from point to END.
21427 ;; The function leaves point to END line.
21428 (lambda (ind end)
21429 (let ((min-i 1000) (end (copy-marker end)))
21430 ;; First determine the minimum indentation (MIN-I) of
21431 ;; the text.
21432 (save-excursion
21433 (catch 'exit
21434 (while (< (point) end)
21435 (let ((i (org-get-indentation)))
21436 (cond
21437 ;; Skip blank lines and inline tasks.
21438 ((looking-at "^[ \t]*$"))
21439 ((looking-at org-outline-regexp-bol))
21440 ;; We can't find less than 0 indentation.
21441 ((zerop i) (throw 'exit (setq min-i 0)))
21442 ((< i min-i) (setq min-i i))))
21443 (forward-line))))
21444 ;; Then indent each line so that a line indented to
21445 ;; MIN-I becomes indented to IND. Ignore blank lines
21446 ;; and inline tasks in the process.
21447 (let ((delta (- ind min-i)))
21448 (while (< (point) end)
21449 (unless (or (looking-at "^[ \t]*$")
21450 (looking-at org-outline-regexp-bol))
21451 (org-indent-line-to (+ (org-get-indentation) delta)))
21452 (forward-line)))))))
21453 (skip-blanks
21454 (function
21455 ;; Return beginning of first non-blank line, starting from
21456 ;; line at POS.
21457 (lambda (pos)
21458 (save-excursion
21459 (goto-char pos)
21460 (skip-chars-forward " \r\t\n")
21461 (point-at-bol)))))
21462 beg end)
21463 ;; Determine boundaries of changes.
21464 (if (org-region-active-p)
21465 (setq beg (funcall skip-blanks (region-beginning))
21466 end (copy-marker (region-end)))
21467 (setq beg (funcall skip-blanks (point-at-bol))
21468 end (copy-marker (point-at-eol))))
21469 ;; Depending on the starting line, choose an action on the text
21470 ;; between BEG and END.
21471 (org-with-limited-levels
21472 (save-excursion
21473 (goto-char beg)
21474 (cond
21475 ;; Case 1. Start at an item: de-itemize. Note that it only
21476 ;; happens when a region is active: `org-ctrl-c-minus'
21477 ;; would call `org-cycle-list-bullet' otherwise.
21478 ((org-at-item-p)
21479 (while (< (point) end)
21480 (when (org-at-item-p)
21481 (skip-chars-forward " \t")
21482 (delete-region (point) (match-end 0)))
21483 (forward-line)))
21484 ;; Case 2. Start at an heading: convert to items.
21485 ((org-at-heading-p)
21486 (let* ((bul (org-list-bullet-string "-"))
21487 (bul-len (length bul))
21488 (done (org-entry-is-done-p))
21489 (todo (org-entry-is-todo-p))
21490 ;; Indentation of the first heading. It should be
21491 ;; relative to the indentation of its parent, if any.
21492 (start-ind (save-excursion
21493 (cond
21494 ((not org-adapt-indentation) 0)
21495 ((not (outline-previous-heading)) 0)
21496 (t (length (match-string 0))))))
21497 ;; Level of first heading. Further headings will be
21498 ;; compared to it to determine hierarchy in the list.
21499 (ref-level (org-reduced-level (org-outline-level))))
21500 (when (or done todo) (org-todo ""))
21501 (while (< (point) end)
21502 (let* ((level (org-reduced-level (org-outline-level)))
21503 (delta (max 0 (- level ref-level))))
21504 ;; If current headline is less indented than the first
21505 ;; one, set it as reference, in order to preserve
21506 ;; subtrees.
21507 (when (< level ref-level) (setq ref-level level))
21508 (replace-match bul t t)
21509 (org-indent-line-to (+ start-ind (* delta bul-len)))
21510 (when (or done todo)
21511 (let* ((struct (org-list-struct))
21512 (old (copy-tree struct)))
21513 (org-list-set-checkbox (line-beginning-position)
21514 struct
21515 (if done "[X]" "[ ]"))
21516 (org-list-write-struct struct
21517 (org-list-parents-alist struct)
21518 old)))
21519 ;; Ensure all text down to END (or SECTION-END) belongs
21520 ;; to the newly created item.
21521 (let ((section-end (save-excursion
21522 (or (outline-next-heading) (point)))))
21523 (forward-line)
21524 (funcall shift-text
21525 (+ start-ind (* (1+ delta) bul-len))
21526 (min end section-end)))))))
21527 ;; Case 3. Normal line with ARG: make the first line of region
21528 ;; an item, and shift indentation of others lines to
21529 ;; set them as item's body.
21530 (arg (let* ((bul (org-list-bullet-string "-"))
21531 (bul-len (length bul))
21532 (ref-ind (org-get-indentation)))
21533 (skip-chars-forward " \t")
21534 (insert bul)
21535 (forward-line)
21536 (while (< (point) end)
21537 ;; Ensure that lines less indented than first one
21538 ;; still get included in item body.
21539 (funcall shift-text
21540 (+ ref-ind bul-len)
21541 (min end (save-excursion (or (outline-next-heading)
21542 (point)))))
21543 (forward-line))))
21544 ;; Case 4. Normal line without ARG: turn each non-item line
21545 ;; into an item.
21547 (while (< (point) end)
21548 (unless (or (org-at-heading-p) (org-at-item-p))
21549 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21550 (replace-match
21551 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21552 (forward-line))))))))
21554 (defun org-toggle-heading (&optional nstars)
21555 "Convert headings to normal text, or items or text to headings.
21556 If there is no active region, only convert the current line.
21558 With a \\[universal-argument] prefix, convert the whole list at
21559 point into heading.
21561 In a region:
21563 - If the first non blank line is a headline, remove the stars
21564 from all headlines in the region.
21566 - If it is a normal line, turn each and every normal line (i.e.,
21567 not an heading or an item) in the region into headings. If you
21568 want to convert only the first line of this region, use one
21569 universal prefix argument.
21571 - If it is a plain list item, turn all plain list items into headings.
21573 When converting a line into a heading, the number of stars is chosen
21574 such that the lines become children of the current entry. However,
21575 when a numeric prefix argument is given, its value determines the
21576 number of stars to add."
21577 (interactive "P")
21578 (let ((skip-blanks
21579 (function
21580 ;; Return beginning of first non-blank line, starting from
21581 ;; line at POS.
21582 (lambda (pos)
21583 (save-excursion
21584 (goto-char pos)
21585 (while (org-at-comment-p) (forward-line))
21586 (skip-chars-forward " \r\t\n")
21587 (point-at-bol)))))
21588 beg end toggled)
21589 ;; Determine boundaries of changes. If a universal prefix has
21590 ;; been given, put the list in a region. If region ends at a bol,
21591 ;; do not consider the last line to be in the region.
21593 (when (and current-prefix-arg (org-at-item-p))
21594 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21595 (org-mark-element))
21597 (if (org-region-active-p)
21598 (setq beg (funcall skip-blanks (region-beginning))
21599 end (copy-marker (save-excursion
21600 (goto-char (region-end))
21601 (if (bolp) (point) (point-at-eol)))))
21602 (setq beg (funcall skip-blanks (point-at-bol))
21603 end (copy-marker (point-at-eol))))
21604 ;; Ensure inline tasks don't count as headings.
21605 (org-with-limited-levels
21606 (save-excursion
21607 (goto-char beg)
21608 (cond
21609 ;; Case 1. Started at an heading: de-star headings.
21610 ((org-at-heading-p)
21611 (while (< (point) end)
21612 (when (org-at-heading-p t)
21613 (looking-at org-outline-regexp) (replace-match "")
21614 (setq toggled t))
21615 (forward-line)))
21616 ;; Case 2. Started at an item: change items into headlines.
21617 ;; One star will be added by `org-list-to-subtree'.
21618 ((org-at-item-p)
21619 (while (< (point) end)
21620 (when (org-at-item-p)
21621 ;; Pay attention to cases when region ends before list.
21622 (let* ((struct (org-list-struct))
21623 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21624 (save-restriction
21625 (narrow-to-region (point) list-end)
21626 (insert (org-list-to-subtree (org-list-parse-list t)))))
21627 (setq toggled t))
21628 (forward-line)))
21629 ;; Case 3. Started at normal text: make every line an heading,
21630 ;; skipping headlines and items.
21631 (t (let* ((stars
21632 (make-string
21633 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21634 (add-stars
21635 (cond (nstars "") ; stars from prefix only
21636 ((equal stars "") "*") ; before first heading
21637 (org-odd-levels-only "**") ; inside heading, odd
21638 (t "*"))) ; inside heading, oddeven
21639 (rpl (concat stars add-stars " "))
21640 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21641 (while (< (point) (if (equal nstars '(4)) lend end))
21642 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21643 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21644 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21645 (forward-line)))))))
21646 (unless toggled (message "Cannot toggle heading from here"))))
21648 (defun org-meta-return (&optional _arg)
21649 "Insert a new heading or wrap a region in a table.
21650 Calls `org-insert-heading' or `org-table-wrap-region', depending
21651 on context. See the individual commands for more information."
21652 (interactive)
21653 (org-check-before-invisible-edit 'insert)
21654 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21655 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21656 #'org-insert-heading))))
21658 ;;; Menu entries
21660 (defsubst org-in-subtree-not-table-p ()
21661 "Are we in a subtree and not in a table?"
21662 (and (not (org-before-first-heading-p))
21663 (not (org-at-table-p))))
21665 ;; Define the Org-mode menus
21666 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21667 '("Tbl"
21668 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21669 ["Next Field" org-cycle (org-at-table-p)]
21670 ["Previous Field" org-shifttab (org-at-table-p)]
21671 ["Next Row" org-return (org-at-table-p)]
21672 "--"
21673 ["Blank Field" org-table-blank-field (org-at-table-p)]
21674 ["Edit Field" org-table-edit-field (org-at-table-p)]
21675 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21676 "--"
21677 ("Column"
21678 ["Move Column Left" org-metaleft (org-at-table-p)]
21679 ["Move Column Right" org-metaright (org-at-table-p)]
21680 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21681 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21682 ("Row"
21683 ["Move Row Up" org-metaup (org-at-table-p)]
21684 ["Move Row Down" org-metadown (org-at-table-p)]
21685 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21686 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21687 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21688 "--"
21689 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21690 ("Rectangle"
21691 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21692 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21693 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21694 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21695 "--"
21696 ("Calculate"
21697 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21698 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21699 ["Edit Formulas" org-edit-special (org-at-table-p)]
21700 "--"
21701 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21702 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21703 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21704 "--"
21705 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21706 "--"
21707 ["Sum Column/Rectangle" org-table-sum
21708 (or (org-at-table-p) (org-region-active-p))]
21709 ["Which Column?" org-table-current-column (org-at-table-p)])
21710 ["Debug Formulas"
21711 org-table-toggle-formula-debugger
21712 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21713 ["Show Col/Row Numbers"
21714 org-table-toggle-coordinate-overlays
21715 :style toggle
21716 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21717 "--"
21718 ["Create" org-table-create (and (not (org-at-table-p))
21719 org-enable-table-editor)]
21720 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21721 ["Import from File" org-table-import (not (org-at-table-p))]
21722 ["Export to File" org-table-export (org-at-table-p)]
21723 "--"
21724 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21725 "--"
21726 ("Plot"
21727 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21728 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21730 (easy-menu-define org-org-menu org-mode-map "Org menu"
21731 '("Org"
21732 ("Show/Hide"
21733 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21734 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21735 ["Sparse Tree..." org-sparse-tree t]
21736 ["Reveal Context" org-reveal t]
21737 ["Show All" show-all t]
21738 "--"
21739 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21740 "--"
21741 ["New Heading" org-insert-heading t]
21742 ("Navigate Headings"
21743 ["Up" outline-up-heading t]
21744 ["Next" outline-next-visible-heading t]
21745 ["Previous" outline-previous-visible-heading t]
21746 ["Next Same Level" outline-forward-same-level t]
21747 ["Previous Same Level" outline-backward-same-level t]
21748 "--"
21749 ["Jump" org-goto t])
21750 ("Edit Structure"
21751 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21752 "--"
21753 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21754 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21755 "--"
21756 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21757 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21758 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21759 "--"
21760 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21761 "--"
21762 ["Copy visible text" org-copy-visible t]
21763 "--"
21764 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21765 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21766 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21767 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21768 "--"
21769 ["Sort Region/Children" org-sort t]
21770 "--"
21771 ["Convert to odd levels" org-convert-to-odd-levels t]
21772 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21773 ("Editing"
21774 ["Emphasis..." org-emphasize t]
21775 ["Edit Source Example" org-edit-special t]
21776 "--"
21777 ["Footnote new/jump" org-footnote-action t]
21778 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21779 ("Archive"
21780 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21781 "--"
21782 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21783 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21784 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21786 "--"
21787 ("Hyperlinks"
21788 ["Store Link (Global)" org-store-link t]
21789 ["Find existing link to here" org-occur-link-in-agenda-files t]
21790 ["Insert Link" org-insert-link t]
21791 ["Follow Link" org-open-at-point t]
21792 "--"
21793 ["Next link" org-next-link t]
21794 ["Previous link" org-previous-link t]
21795 "--"
21796 ["Descriptive Links"
21797 org-toggle-link-display
21798 :style radio
21799 :selected org-descriptive-links
21801 ["Literal Links"
21802 org-toggle-link-display
21803 :style radio
21804 :selected (not org-descriptive-links)])
21805 "--"
21806 ("TODO Lists"
21807 ["TODO/DONE/-" org-todo t]
21808 ("Select keyword"
21809 ["Next keyword" org-shiftright (org-at-heading-p)]
21810 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21811 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21812 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21813 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21814 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21815 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21816 "--"
21817 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21818 :selected org-enforce-todo-dependencies :style toggle :active t]
21819 "Settings for tree at point"
21820 ["Do Children sequentially" org-toggle-ordered-property :style radio
21821 :selected (org-entry-get nil "ORDERED")
21822 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21823 ["Do Children parallel" org-toggle-ordered-property :style radio
21824 :selected (not (org-entry-get nil "ORDERED"))
21825 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21826 "--"
21827 ["Set Priority" org-priority t]
21828 ["Priority Up" org-shiftup t]
21829 ["Priority Down" org-shiftdown t]
21830 "--"
21831 ["Get news from all feeds" org-feed-update-all t]
21832 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21833 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21834 ("TAGS and Properties"
21835 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21836 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21837 "--"
21838 ["Set property" org-set-property (not (org-before-first-heading-p))]
21839 ["Column view of properties" org-columns t]
21840 ["Insert Column View DBlock" org-insert-columns-dblock t])
21841 ("Dates and Scheduling"
21842 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21843 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21844 ("Change Date"
21845 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21846 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21847 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21848 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21849 ["Compute Time Range" org-evaluate-time-range t]
21850 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21851 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21852 "--"
21853 ["Custom time format" org-toggle-time-stamp-overlays
21854 :style radio :selected org-display-custom-times]
21855 "--"
21856 ["Goto Calendar" org-goto-calendar t]
21857 ["Date from Calendar" org-date-from-calendar t]
21858 "--"
21859 ["Start/Restart Timer" org-timer-start t]
21860 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21861 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21862 ["Insert Timer String" org-timer t]
21863 ["Insert Timer Item" org-timer-item t])
21864 ("Logging work"
21865 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21866 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21867 ["Clock out" org-clock-out t]
21868 ["Clock cancel" org-clock-cancel t]
21869 "--"
21870 ["Mark as default task" org-clock-mark-default-task t]
21871 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21872 ["Goto running clock" org-clock-goto t]
21873 "--"
21874 ["Display times" org-clock-display t]
21875 ["Create clock table" org-clock-report t]
21876 "--"
21877 ["Record DONE time"
21878 (progn (setq org-log-done (not org-log-done))
21879 (message "Switching to %s will %s record a timestamp"
21880 (car org-done-keywords)
21881 (if org-log-done "automatically" "not")))
21882 :style toggle :selected org-log-done])
21883 "--"
21884 ["Agenda Command..." org-agenda t]
21885 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21886 ("File List for Agenda")
21887 ("Special views current file"
21888 ["TODO Tree" org-show-todo-tree t]
21889 ["Check Deadlines" org-check-deadlines t]
21890 ["Timeline" org-timeline t]
21891 ["Tags/Property tree" org-match-sparse-tree t])
21892 "--"
21893 ["Export/Publish..." org-export-dispatch t]
21894 ("LaTeX"
21895 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21896 :selected org-cdlatex-mode]
21897 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21898 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21899 ["Modify math symbol" org-cdlatex-math-modify
21900 (org-inside-LaTeX-fragment-p)]
21901 ["Insert citation" org-reftex-citation t]
21902 "--"
21903 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21904 "--"
21905 ("MobileOrg"
21906 ["Push Files and Views" org-mobile-push t]
21907 ["Get Captured and Flagged" org-mobile-pull t]
21908 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21909 "--"
21910 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21911 "--"
21912 ("Documentation"
21913 ["Show Version" org-version t]
21914 ["Info Documentation" org-info t])
21915 ("Customize"
21916 ["Browse Org Group" org-customize t]
21917 "--"
21918 ["Expand This Menu" org-create-customize-menu
21919 (fboundp 'customize-menu-create)])
21920 ["Send bug report" org-submit-bug-report t]
21921 "--"
21922 ("Refresh/Reload"
21923 ["Refresh setup current buffer" org-mode-restart t]
21924 ["Reload Org (after update)" org-reload t]
21925 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21928 (defun org-info (&optional node)
21929 "Read documentation for Org-mode in the info system.
21930 With optional NODE, go directly to that node."
21931 (interactive)
21932 (info (format "(org)%s" (or node ""))))
21934 ;;;###autoload
21935 (defun org-submit-bug-report ()
21936 "Submit a bug report on Org-mode via mail.
21938 Don't hesitate to report any problems or inaccurate documentation.
21940 If you don't have setup sending mail from (X)Emacs, please copy the
21941 output buffer into your mail program, as it gives us important
21942 information about your Org-mode version and configuration."
21943 (interactive)
21944 (require 'reporter)
21945 (defvar reporter-prompt-for-summary-p)
21946 (org-load-modules-maybe)
21947 (org-require-autoloaded-modules)
21948 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21949 (reporter-submit-bug-report
21950 "emacs-orgmode@gnu.org"
21951 (org-version nil 'full)
21952 (let (list)
21953 (save-window-excursion
21954 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21955 (delete-other-windows)
21956 (erase-buffer)
21957 (insert "You are about to submit a bug report to the Org-mode mailing list.
21959 We would like to add your full Org-mode and Outline configuration to the
21960 bug report. This greatly simplifies the work of the maintainer and
21961 other experts on the mailing list.
21963 HOWEVER, some variables you have customized may contain private
21964 information. The names of customers, colleagues, or friends, might
21965 appear in the form of file names, tags, todo states, or search strings.
21966 If you answer yes to the prompt, you might want to check and remove
21967 such private information before sending the email.")
21968 (add-text-properties (point-min) (point-max) '(face org-warning))
21969 (when (yes-or-no-p "Include your Org-mode configuration ")
21970 (mapatoms
21971 (lambda (v)
21972 (and (boundp v)
21973 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21974 (or (and (symbol-value v)
21975 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21976 (and
21977 (get v 'custom-type) (get v 'standard-value)
21978 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21979 (push v list)))))
21980 (kill-buffer (get-buffer "*Warn about privacy*"))
21981 list))
21982 nil nil
21983 "Remember to cover the basics, that is, what you expected to happen and
21984 what in fact did happen. You don't know how to make a good report? See
21986 http://orgmode.org/manual/Feedback.html#Feedback
21988 Your bug report will be posted to the Org-mode mailing list.
21989 ------------------------------------------------------------------------")
21990 (save-excursion
21991 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21992 (replace-match "\\1Bug: \\3 [\\2]")))))
21995 (defun org-install-agenda-files-menu ()
21996 (let ((bl (buffer-list)))
21997 (save-excursion
21998 (while bl
21999 (set-buffer (pop bl))
22000 (if (derived-mode-p 'org-mode) (setq bl nil)))
22001 (when (derived-mode-p 'org-mode)
22002 (easy-menu-change
22003 '("Org") "File List for Agenda"
22004 (append
22005 (list
22006 ["Edit File List" (org-edit-agenda-file-list) t]
22007 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
22008 ["Remove Current File from List" org-remove-file t]
22009 ["Cycle through agenda files" org-cycle-agenda-files t]
22010 ["Occur in all agenda files" org-occur-in-agenda-files t]
22011 "--")
22012 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
22014 ;;;; Documentation
22016 (defun org-require-autoloaded-modules ()
22017 (interactive)
22018 (mapc 'require
22019 '(org-agenda org-archive org-attach org-clock org-colview org-id
22020 org-table org-timer)))
22022 ;;;###autoload
22023 (defun org-reload (&optional uncompiled)
22024 "Reload all org lisp files.
22025 With prefix arg UNCOMPILED, load the uncompiled versions."
22026 (interactive "P")
22027 (require 'loadhist)
22028 (let* ((org-dir (org-find-library-dir "org"))
22029 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
22030 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
22031 (remove-re (mapconcat 'identity
22032 (mapcar (lambda (f) (concat "^" f "$"))
22033 (list (if (featurep 'xemacs)
22034 "org-colview"
22035 "org-colview-xemacs")
22036 "org" "org-loaddefs" "org-version"))
22037 "\\|"))
22038 (feats (delete-dups
22039 (mapcar 'file-name-sans-extension
22040 (mapcar 'file-name-nondirectory
22041 (delq nil
22042 (mapcar 'feature-file
22043 features))))))
22044 (lfeat (append
22045 (sort
22046 (setq feats
22047 (delq nil (mapcar
22048 (lambda (f)
22049 (if (and (string-match feature-re f)
22050 (not (string-match remove-re f)))
22051 f nil))
22052 feats)))
22053 'string-lessp)
22054 (list "org-version" "org")))
22055 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22056 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22057 load-uncore load-misses)
22058 (setq load-misses
22059 (delq 't
22060 (mapcar (lambda (f)
22061 (or (org-load-noerror-mustsuffix (concat org-dir f))
22062 (and (string= org-dir contrib-dir)
22063 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22064 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22065 (add-to-list 'load-uncore f 'append)
22068 lfeat)))
22069 (if load-uncore
22070 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22071 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22072 (if load-misses
22073 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22074 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22075 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22077 ;;;###autoload
22078 (defun org-customize ()
22079 "Call the customize function with org as argument."
22080 (interactive)
22081 (org-load-modules-maybe)
22082 (org-require-autoloaded-modules)
22083 (customize-browse 'org))
22085 (defun org-create-customize-menu ()
22086 "Create a full customization menu for Org-mode, insert it into the menu."
22087 (interactive)
22088 (org-load-modules-maybe)
22089 (org-require-autoloaded-modules)
22090 (if (fboundp 'customize-menu-create)
22091 (progn
22092 (easy-menu-change
22093 '("Org") "Customize"
22094 `(["Browse Org group" org-customize t]
22095 "--"
22096 ,(customize-menu-create 'org)
22097 ["Set" Custom-set t]
22098 ["Save" Custom-save t]
22099 ["Reset to Current" Custom-reset-current t]
22100 ["Reset to Saved" Custom-reset-saved t]
22101 ["Reset to Standard Settings" Custom-reset-standard t]))
22102 (message "\"Org\"-menu now contains full customization menu"))
22103 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22105 ;;;; Miscellaneous stuff
22107 ;;; Generally useful functions
22109 (defsubst org-get-at-eol (property n)
22110 "Get text property PROPERTY at the end of line less N characters."
22111 (get-text-property (- (point-at-eol) n) property))
22113 (defun org-find-text-property-in-string (prop s)
22114 "Return the first non-nil value of property PROP in string S."
22115 (or (get-text-property 0 prop s)
22116 (get-text-property (or (next-single-property-change 0 prop s) 0)
22117 prop s)))
22119 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22120 "Display the given MESSAGE as a warning."
22121 (if (fboundp 'display-warning)
22122 (display-warning 'org message
22123 (if (featurep 'xemacs) 'warning :warning))
22124 (let ((buf (get-buffer-create "*Org warnings*")))
22125 (with-current-buffer buf
22126 (goto-char (point-max))
22127 (insert "Warning (Org): " message)
22128 (unless (bolp)
22129 (newline)))
22130 (display-buffer buf)
22131 (sit-for 0))))
22133 (defun org-eval (form)
22134 "Eval FORM and return result."
22135 (condition-case error
22136 (eval form)
22137 (error (format "%%![Error: %s]" error))))
22139 (defun org-in-clocktable-p ()
22140 "Check if the cursor is in a clocktable."
22141 (let ((pos (point)) start)
22142 (save-excursion
22143 (end-of-line 1)
22144 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22145 (setq start (match-beginning 0))
22146 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22147 (>= (match-end 0) pos)
22148 start))))
22150 (defun org-in-verbatim-emphasis ()
22151 (save-match-data
22152 (and (org-in-regexp org-emph-re 2)
22153 (>= (point) (match-beginning 3))
22154 (<= (point) (match-end 4))
22155 (member (match-string 3) '("=" "~")))))
22157 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22158 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22159 (if (and marker (marker-buffer marker)
22160 (buffer-live-p (marker-buffer marker)))
22161 (progn
22162 (org-pop-to-buffer-same-window (marker-buffer marker))
22163 (if (or (> marker (point-max)) (< marker (point-min)))
22164 (widen))
22165 (goto-char marker)
22166 (org-show-context 'org-goto))
22167 (if bookmark
22168 (bookmark-jump bookmark)
22169 (error "Cannot find location"))))
22171 (defun org-quote-csv-field (s)
22172 "Quote field for inclusion in CSV material."
22173 (if (string-match "[\",]" s)
22174 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22177 (defun org-force-self-insert (N)
22178 "Needed to enforce self-insert under remapping."
22179 (interactive "p")
22180 (self-insert-command N))
22182 (defun org-string-width (s)
22183 "Compute width of string, ignoring invisible characters.
22184 This ignores character with invisibility property `org-link', and also
22185 characters with property `org-cwidth', because these will become invisible
22186 upon the next fontification round."
22187 (let (b l)
22188 (when (or (eq t buffer-invisibility-spec)
22189 (assq 'org-link buffer-invisibility-spec))
22190 (while (setq b (text-property-any 0 (length s)
22191 'invisible 'org-link s))
22192 (setq s (concat (substring s 0 b)
22193 (substring s (or (next-single-property-change
22194 b 'invisible s)
22195 (length s)))))))
22196 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22197 (setq s (concat (substring s 0 b)
22198 (substring s (or (next-single-property-change
22199 b 'org-cwidth s)
22200 (length s))))))
22201 (setq l (string-width s) b -1)
22202 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22203 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22206 (defun org-shorten-string (s maxlength)
22207 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22208 If the string is shorter or has length MAXLENGTH, just return the
22209 original string. If it is longer, the functions finds a space in the
22210 string, breaks this string off at that locations and adds three dots
22211 as ellipsis. Including the ellipsis, the string will not be longer
22212 than MAXLENGTH. If finding a good breaking point in the string does
22213 not work, the string is just chopped off in the middle of a word
22214 if necessary."
22215 (if (<= (length s) maxlength)
22217 (let* ((n (max (- maxlength 4) 1))
22218 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22219 (if (string-match re s)
22220 (concat (match-string 1 s) "...")
22221 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22223 (defun org-get-indentation (&optional line)
22224 "Get the indentation of the current line, interpreting tabs.
22225 When LINE is given, assume it represents a line and compute its indentation."
22226 (if line
22227 (if (string-match "^ *" (org-remove-tabs line))
22228 (match-end 0))
22229 (save-excursion
22230 (beginning-of-line 1)
22231 (skip-chars-forward " \t")
22232 (current-column))))
22234 (defun org-get-string-indentation (s)
22235 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22236 (let ((n -1) (i 0) (w tab-width) c)
22237 (catch 'exit
22238 (while (< (setq n (1+ n)) (length s))
22239 (setq c (aref s n))
22240 (cond ((= c ?\ ) (setq i (1+ i)))
22241 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22242 (t (throw 'exit t)))))
22245 (defun org-remove-tabs (s &optional width)
22246 "Replace tabulators in S with spaces.
22247 Assumes that s is a single line, starting in column 0."
22248 (setq width (or width tab-width))
22249 (while (string-match "\t" s)
22250 (setq s (replace-match
22251 (make-string
22252 (- (* width (/ (+ (match-beginning 0) width) width))
22253 (match-beginning 0)) ?\ )
22254 t t s)))
22257 (defun org-fix-indentation (line ind)
22258 "Fix indentation in LINE.
22259 IND is a cons cell with target and minimum indentation.
22260 If the current indentation in LINE is smaller than the minimum,
22261 leave it alone. If it is larger than ind, set it to the target."
22262 (let* ((l (org-remove-tabs line))
22263 (i (org-get-indentation l))
22264 (i1 (car ind)) (i2 (cdr ind)))
22265 (if (>= i i2) (setq l (substring line i2)))
22266 (if (> i1 0)
22267 (concat (make-string i1 ?\ ) l)
22268 l)))
22270 (defun org-remove-indentation (code &optional n)
22271 "Remove the maximum common indentation from the lines in CODE.
22272 N may optionally be the number of spaces to remove."
22273 (with-temp-buffer
22274 (insert code)
22275 (org-do-remove-indentation n)
22276 (buffer-string)))
22278 (defun org-do-remove-indentation (&optional n)
22279 "Remove the maximum common indentation from the buffer."
22280 (untabify (point-min) (point-max))
22281 (let ((min 10000) re)
22282 (if n
22283 (setq min n)
22284 (goto-char (point-min))
22285 (while (re-search-forward "^ *[^ \n]" nil t)
22286 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22287 (unless (or (= min 0) (= min 10000))
22288 (setq re (format "^ \\{%d\\}" min))
22289 (goto-char (point-min))
22290 (while (re-search-forward re nil t)
22291 (replace-match "")
22292 (end-of-line 1))
22293 min)))
22295 (defun org-fill-template (template alist)
22296 "Find each %key of ALIST in TEMPLATE and replace it."
22297 (let ((case-fold-search nil))
22298 (dolist (entry (sort (copy-sequence alist)
22299 (lambda (a b) (< (length (car a)) (length (car b))))))
22300 (setq template
22301 (replace-regexp-in-string
22302 (concat "%" (regexp-quote (car entry)))
22303 (or (cdr entry) "") template t t)))
22304 template))
22306 (defun org-base-buffer (buffer)
22307 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22308 (if (not buffer)
22309 buffer
22310 (or (buffer-base-buffer buffer)
22311 buffer)))
22313 (defun org-wrap (string &optional width lines)
22314 "Wrap string to either a number of lines, or a width in characters.
22315 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22316 that costs. If there is a word longer than WIDTH, the text is actually
22317 wrapped to the length of that word.
22318 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22319 many lines, whatever width that takes.
22320 The return value is a list of lines, without newlines at the end."
22321 (let* ((words (org-split-string string "[ \t\n]+"))
22322 (maxword (apply 'max (mapcar 'org-string-width words)))
22323 w ll)
22324 (cond (width
22325 (org-do-wrap words (max maxword width)))
22326 (lines
22327 (setq w maxword)
22328 (setq ll (org-do-wrap words maxword))
22329 (if (<= (length ll) lines)
22331 (setq ll words)
22332 (while (> (length ll) lines)
22333 (setq w (1+ w))
22334 (setq ll (org-do-wrap words w)))
22335 ll))
22336 (t (error "Cannot wrap this")))))
22338 (defun org-do-wrap (words width)
22339 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22340 (let (lines line)
22341 (while words
22342 (setq line (pop words))
22343 (while (and words (< (+ (length line) (length (car words))) width))
22344 (setq line (concat line " " (pop words))))
22345 (setq lines (push line lines)))
22346 (nreverse lines)))
22348 (defun org-split-string (string &optional separators)
22349 "Splits STRING into substrings at SEPARATORS.
22350 SEPARATORS is a regular expression.
22351 No empty strings are returned if there are matches at the beginning
22352 and end of string."
22353 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22354 (let ((start 0) notfirst list)
22355 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22356 (if (and notfirst
22357 (= start (match-beginning 0))
22358 (< start (length string)))
22359 (1+ start) start))
22360 (< (match-beginning 0) (length string)))
22361 (setq notfirst t)
22362 (or (eq (match-beginning 0) 0)
22363 (and (eq (match-beginning 0) (match-end 0))
22364 (eq (match-beginning 0) start))
22365 (push (substring string start (match-beginning 0)) list))
22366 (setq start (match-end 0)))
22367 (or (eq start (length string))
22368 (push (substring string start) list))
22369 (nreverse list)))
22371 (defun org-quote-vert (s)
22372 "Replace \"|\" with \"\\vert\"."
22373 (while (string-match "|" s)
22374 (setq s (replace-match "\\vert" t t s)))
22377 (defun org-uuidgen-p (s)
22378 "Is S an ID created by UUIDGEN?"
22379 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22381 (defun org-in-src-block-p (&optional inside)
22382 "Whether point is in a code source block.
22383 When INSIDE is non-nil, don't consider we are within a src block
22384 when point is at #+BEGIN_SRC or #+END_SRC."
22385 (let ((case-fold-search t) ov)
22386 (or (and (eq (get-char-property (point) 'src-block) t))
22387 (and (not inside)
22388 (save-match-data
22389 (save-excursion
22390 (beginning-of-line)
22391 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22393 (defun org-context ()
22394 "Return a list of contexts of the current cursor position.
22395 If several contexts apply, all are returned.
22396 Each context entry is a list with a symbol naming the context, and
22397 two positions indicating start and end of the context. Possible
22398 contexts are:
22400 :headline anywhere in a headline
22401 :headline-stars on the leading stars in a headline
22402 :todo-keyword on a TODO keyword (including DONE) in a headline
22403 :tags on the TAGS in a headline
22404 :priority on the priority cookie in a headline
22405 :item on the first line of a plain list item
22406 :item-bullet on the bullet/number of a plain list item
22407 :checkbox on the checkbox in a plain list item
22408 :table in an org-mode table
22409 :table-special on a special filed in a table
22410 :table-table in a table.el table
22411 :clocktable in a clocktable
22412 :src-block in a source block
22413 :link on a hyperlink
22414 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22415 :target on a <<target>>
22416 :radio-target on a <<<radio-target>>>
22417 :latex-fragment on a LaTeX fragment
22418 :latex-preview on a LaTeX fragment with overlaid preview image
22420 This function expects the position to be visible because it uses font-lock
22421 faces as a help to recognize the following contexts: :table-special, :link,
22422 and :keyword."
22423 (let* ((f (get-text-property (point) 'face))
22424 (faces (if (listp f) f (list f)))
22425 (case-fold-search t)
22426 (p (point)) clist o)
22427 ;; First the large context
22428 (cond
22429 ((org-at-heading-p t)
22430 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22431 (when (progn
22432 (beginning-of-line 1)
22433 (looking-at org-todo-line-tags-regexp))
22434 (push (org-point-in-group p 1 :headline-stars) clist)
22435 (push (org-point-in-group p 2 :todo-keyword) clist)
22436 (push (org-point-in-group p 4 :tags) clist))
22437 (goto-char p)
22438 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22439 (if (looking-at "\\[#[A-Z0-9]\\]")
22440 (push (org-point-in-group p 0 :priority) clist)))
22442 ((org-at-item-p)
22443 (push (org-point-in-group p 2 :item-bullet) clist)
22444 (push (list :item (point-at-bol)
22445 (save-excursion (org-end-of-item) (point)))
22446 clist)
22447 (and (org-at-item-checkbox-p)
22448 (push (org-point-in-group p 0 :checkbox) clist)))
22450 ((org-at-table-p)
22451 (push (list :table (org-table-begin) (org-table-end)) clist)
22452 (if (memq 'org-formula faces)
22453 (push (list :table-special
22454 (previous-single-property-change p 'face)
22455 (next-single-property-change p 'face)) clist)))
22456 ((org-at-table-p 'any)
22457 (push (list :table-table) clist)))
22458 (goto-char p)
22460 (let ((case-fold-search t))
22461 ;; New the "medium" contexts: clocktables, source blocks
22462 (cond ((org-in-clocktable-p)
22463 (push (list :clocktable
22464 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22465 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22466 (match-beginning 1))
22467 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22468 (match-end 0))) clist))
22469 ((org-in-src-block-p)
22470 (push (list :src-block
22471 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22472 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22473 (match-beginning 1))
22474 (and (search-forward "#+END_SRC" nil t)
22475 (match-beginning 0))) clist))))
22476 (goto-char p)
22478 ;; Now the small context
22479 (cond
22480 ((org-at-timestamp-p)
22481 (push (org-point-in-group p 0 :timestamp) clist))
22482 ((memq 'org-link faces)
22483 (push (list :link
22484 (previous-single-property-change p 'face)
22485 (next-single-property-change p 'face)) clist))
22486 ((memq 'org-special-keyword faces)
22487 (push (list :keyword
22488 (previous-single-property-change p 'face)
22489 (next-single-property-change p 'face)) clist))
22490 ((org-at-target-p)
22491 (push (org-point-in-group p 0 :target) clist)
22492 (goto-char (1- (match-beginning 0)))
22493 (if (looking-at org-radio-target-regexp)
22494 (push (org-point-in-group p 0 :radio-target) clist))
22495 (goto-char p))
22496 ((setq o (car (delq nil
22497 (mapcar
22498 (lambda (x)
22499 (if (memq x org-latex-fragment-image-overlays) x))
22500 (overlays-at (point))))))
22501 (push (list :latex-fragment
22502 (overlay-start o) (overlay-end o)) clist)
22503 (push (list :latex-preview
22504 (overlay-start o) (overlay-end o)) clist))
22505 ((org-inside-LaTeX-fragment-p)
22506 ;; FIXME: positions wrong.
22507 (push (list :latex-fragment (point) (point)) clist)))
22509 (setq clist (nreverse (delq nil clist)))
22510 clist))
22512 (defun org-in-regexp (re &optional nlines visually)
22513 "Check if point is inside a match of RE.
22515 Normally only the current line is checked, but you can include
22516 NLINES extra lines after point into the search. If VISUALLY is
22517 set, require that the cursor is not after the match but really
22518 on, so that the block visually is on the match."
22519 (catch 'exit
22520 (let ((pos (point))
22521 (eol (point-at-eol (+ 1 (or nlines 0))))
22522 (inc (if visually 1 0)))
22523 (save-excursion
22524 (beginning-of-line (- 1 (or nlines 0)))
22525 (while (re-search-forward re eol t)
22526 (if (and (<= (match-beginning 0) pos)
22527 (>= (+ inc (match-end 0)) pos))
22528 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22529 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22530 "Org mode 8.3")
22532 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22533 "Non-nil when point is between matches of START-RE and END-RE.
22535 Also return a non-nil value when point is on one of the matches.
22537 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22538 buffer positions. Default values are the positions of headlines
22539 surrounding the point.
22541 The functions returns a cons cell whose car (resp. cdr) is the
22542 position before START-RE (resp. after END-RE)."
22543 (save-match-data
22544 (let ((pos (point))
22545 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22546 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22547 beg end)
22548 (save-excursion
22549 ;; Point is on a block when on START-RE or if START-RE can be
22550 ;; found before it...
22551 (and (or (org-in-regexp start-re)
22552 (re-search-backward start-re limit-up t))
22553 (setq beg (match-beginning 0))
22554 ;; ... and END-RE after it...
22555 (goto-char (match-end 0))
22556 (re-search-forward end-re limit-down t)
22557 (> (setq end (match-end 0)) pos)
22558 ;; ... without another START-RE in-between.
22559 (goto-char (match-beginning 0))
22560 (not (re-search-backward start-re (1+ beg) t))
22561 ;; Return value.
22562 (cons beg end))))))
22564 (defun org-in-block-p (names)
22565 "Non-nil when point belongs to a block whose name belongs to NAMES.
22567 NAMES is a list of strings containing names of blocks.
22569 Return first block name matched, or nil. Beware that in case of
22570 nested blocks, the returned name may not belong to the closest
22571 block from point."
22572 (save-match-data
22573 (catch 'exit
22574 (let ((case-fold-search t)
22575 (lim-up (save-excursion (outline-previous-heading)))
22576 (lim-down (save-excursion (outline-next-heading))))
22577 (mapc (lambda (name)
22578 (let ((n (regexp-quote name)))
22579 (when (org-between-regexps-p
22580 (concat "^[ \t]*#\\+begin_" n)
22581 (concat "^[ \t]*#\\+end_" n)
22582 lim-up lim-down)
22583 (throw 'exit n))))
22584 names))
22585 nil)))
22587 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22588 "Call `multi-occur' with buffers for all agenda files."
22589 (interactive "sOrg-files matching: ")
22590 (let* ((files (org-agenda-files))
22591 (tnames (mapcar #'file-truename files))
22592 (extra org-agenda-text-search-extra-files))
22593 (when (eq (car extra) 'agenda-archives)
22594 (setq extra (cdr extra))
22595 (setq files (org-add-archive-files files)))
22596 (dolist (f extra)
22597 (unless (member (file-truename f) tnames)
22598 (unless (member f files) (setq files (append files (list f))))
22599 (setq tnames (append tnames (list (file-truename f))))))
22600 (multi-occur
22601 (mapcar (lambda (x)
22602 (with-current-buffer
22603 ;; FIXME: Why not just (find-file-noselect x)?
22604 ;; Is it to avoid the "revert buffer" prompt?
22605 (or (get-file-buffer x) (find-file-noselect x))
22606 (widen)
22607 (current-buffer)))
22608 files)
22609 regexp)))
22611 (if (boundp 'occur-mode-find-occurrence-hook)
22612 ;; Emacs 23
22613 (add-hook 'occur-mode-find-occurrence-hook
22614 (lambda ()
22615 (when (derived-mode-p 'org-mode)
22616 (org-reveal))))
22617 ;; Emacs 22
22618 (defadvice occur-mode-goto-occurrence
22619 (after org-occur-reveal activate)
22620 (and (derived-mode-p 'org-mode) (org-reveal)))
22621 (defadvice occur-mode-goto-occurrence-other-window
22622 (after org-occur-reveal activate)
22623 (and (derived-mode-p 'org-mode) (org-reveal)))
22624 (defadvice occur-mode-display-occurrence
22625 (after org-occur-reveal activate)
22626 (when (derived-mode-p 'org-mode)
22627 (let ((pos (occur-mode-find-occurrence)))
22628 (with-current-buffer (marker-buffer pos)
22629 (save-excursion
22630 (goto-char pos)
22631 (org-reveal)))))))
22633 (defun org-occur-link-in-agenda-files ()
22634 "Create a link and search for it in the agendas.
22635 The link is not stored in `org-stored-links', it is just created
22636 for the search purpose."
22637 (interactive)
22638 (let ((link (condition-case nil
22639 (org-store-link nil)
22640 (error "Unable to create a link to here"))))
22641 (org-occur-in-agenda-files (regexp-quote link))))
22643 (defun org-reverse-string (string)
22644 "Return the reverse of STRING."
22645 (apply 'string (reverse (string-to-list string))))
22647 ;; defsubst org-uniquify must be defined before first use
22649 (defun org-uniquify-alist (alist)
22650 "Merge elements of ALIST with the same key.
22652 For example, in this alist:
22654 \(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
22655 => \\='((a 1 3) (b 2))
22657 merge (a 1) and (a 3) into (a 1 3).
22659 The function returns the new ALIST."
22660 (let (rtn)
22661 (mapc
22662 (lambda (e)
22663 (let (n)
22664 (if (not (assoc (car e) rtn))
22665 (push e rtn)
22666 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22667 (setq rtn (assq-delete-all (car e) rtn))
22668 (push n rtn))))
22669 alist)
22670 rtn))
22672 (defun org-delete-all (elts list)
22673 "Remove all elements in ELTS from LIST."
22674 (while elts
22675 (setq list (delete (pop elts) list)))
22676 list)
22678 (defun org-count (cl-item cl-seq)
22679 "Count the number of occurrences of ITEM in SEQ.
22680 Taken from `count' in cl-seq.el with all keyword arguments removed."
22681 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22682 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22683 (while (< cl-start cl-end)
22684 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22685 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22686 (setq cl-start (1+ cl-start)))
22687 cl-count))
22689 (defun org-remove-if (predicate seq)
22690 "Remove everything from SEQ that fulfills PREDICATE."
22691 (let (res e)
22692 (while seq
22693 (setq e (pop seq))
22694 (if (not (funcall predicate e)) (push e res)))
22695 (nreverse res)))
22697 (defun org-remove-if-not (predicate seq)
22698 "Remove everything from SEQ that does not fulfill PREDICATE."
22699 (let (res e)
22700 (while seq
22701 (setq e (pop seq))
22702 (if (funcall predicate e) (push e res)))
22703 (nreverse res)))
22705 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22706 "Reduce two-argument FUNCTION across SEQ.
22707 Taken from `reduce' in cl-seq.el with all keyword arguments but
22708 \":initial-value\" removed."
22709 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22710 (cadr (memq :initial-value cl-keys)))
22711 (cl-seq (pop cl-seq))
22712 (t (funcall cl-func)))))
22713 (while cl-seq
22714 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22715 cl-accum))
22717 (defun org-every (pred seq)
22718 "Return true if PREDICATE is true of every element of SEQ.
22719 Adapted from `every' in cl.el."
22720 (catch 'org-every
22721 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22724 (defun org-some (pred seq)
22725 "Return true if PREDICATE is true of any element of SEQ.
22726 Adapted from `some' in cl.el."
22727 (catch 'org-some
22728 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22729 nil))
22731 (defun org-back-over-empty-lines ()
22732 "Move backwards over whitespace, to the beginning of the first empty line.
22733 Returns the number of empty lines passed."
22734 (let ((pos (point)))
22735 (if (cdr (assoc 'heading org-blank-before-new-entry))
22736 (skip-chars-backward " \t\n\r")
22737 (unless (eobp)
22738 (forward-line -1)))
22739 (beginning-of-line 2)
22740 (goto-char (min (point) pos))
22741 (count-lines (point) pos)))
22743 (defun org-skip-whitespace ()
22744 (skip-chars-forward " \t\n\r"))
22746 (defun org-point-in-group (point group &optional context)
22747 "Check if POINT is in match-group GROUP.
22748 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22749 match. If the match group does not exist or point is not inside it,
22750 return nil."
22751 (and (match-beginning group)
22752 (>= point (match-beginning group))
22753 (<= point (match-end group))
22754 (if context
22755 (list context (match-beginning group) (match-end group))
22756 t)))
22758 (defun org-switch-to-buffer-other-window (&rest args)
22759 "Switch to buffer in a second window on the current frame.
22760 In particular, do not allow pop-up frames.
22761 Returns the newly created buffer."
22762 (org-no-popups
22763 (apply 'switch-to-buffer-other-window args)))
22765 (defun org-combine-plists (&rest plists)
22766 "Create a single property list from all plists in PLISTS.
22767 The process starts by copying the first list, and then setting properties
22768 from the other lists. Settings in the last list are the most significant
22769 ones and overrule settings in the other lists."
22770 (let ((rtn (copy-sequence (pop plists)))
22771 p v ls)
22772 (while plists
22773 (setq ls (pop plists))
22774 (while ls
22775 (setq p (pop ls) v (pop ls))
22776 (setq rtn (plist-put rtn p v))))
22777 rtn))
22779 (defun org-replace-escapes (string table)
22780 "Replace %-escapes in STRING with values in TABLE.
22781 TABLE is an association list with keys like \"%a\" and string values.
22782 The sequences in STRING may contain normal field width and padding information,
22783 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22784 so values can contain further %-escapes if they are define later in TABLE."
22785 (let ((tbl (copy-alist table))
22786 (case-fold-search nil)
22787 (pchg 0)
22788 e re rpl)
22789 (dolist (e tbl)
22790 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22791 (when (and (cdr e) (string-match re (cdr e)))
22792 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22793 (safe "SREF"))
22794 (add-text-properties 0 3 (list 'sref sref) safe)
22795 (setcdr e (replace-match safe t t (cdr e)))))
22796 (while (string-match re string)
22797 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22798 (cdr e)))
22799 (setq string (replace-match rpl t t string))))
22800 (while (setq pchg (next-property-change pchg string))
22801 (let ((sref (get-text-property pchg 'sref string)))
22802 (when (and sref (string-match "SREF" string pchg))
22803 (setq string (replace-match sref t t string)))))
22804 string))
22806 (defun org-sublist (list start end)
22807 "Return a section of LIST, from START to END.
22808 Counting starts at 1."
22809 (let (rtn (c start))
22810 (setq list (nthcdr (1- start) list))
22811 (while (and list (<= c end))
22812 (push (pop list) rtn)
22813 (setq c (1+ c)))
22814 (nreverse rtn)))
22816 (defun org-find-base-buffer-visiting (file)
22817 "Like `find-buffer-visiting' but always return the base buffer and
22818 not an indirect buffer."
22819 (let ((buf (or (get-file-buffer file)
22820 (find-buffer-visiting file))))
22821 (if buf
22822 (or (buffer-base-buffer buf) buf)
22823 nil)))
22825 (defun org-image-file-name-regexp (&optional extensions)
22826 "Return regexp matching the file names of images.
22827 If EXTENSIONS is given, only match these."
22828 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22829 (image-file-name-regexp)
22830 (let ((image-file-name-extensions
22831 (or extensions
22832 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22833 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22834 (concat "\\."
22835 (regexp-opt (nconc (mapcar 'upcase
22836 image-file-name-extensions)
22837 image-file-name-extensions)
22839 "\\'"))))
22841 (defun org-file-image-p (file &optional extensions)
22842 "Return non-nil if FILE is an image."
22843 (save-match-data
22844 (string-match (org-image-file-name-regexp extensions) file)))
22846 (defun org-get-cursor-date (&optional with-time)
22847 "Return the date at cursor in as a time.
22848 This works in the calendar and in the agenda, anywhere else it just
22849 returns the current time.
22850 If WITH-TIME is non-nil, returns the time of the event at point (in
22851 the agenda) or the current time of the day."
22852 (let (date day defd tp hod mod)
22853 (when with-time
22854 (setq tp (get-text-property (point) 'time))
22855 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22856 (setq hod (string-to-number (match-string 1 tp))
22857 mod (string-to-number (match-string 2 tp))))
22858 (or tp (let ((now (decode-time)))
22859 (setq hod (nth 2 now)
22860 mod (nth 1 now)))))
22861 (cond
22862 ((eq major-mode 'calendar-mode)
22863 (setq date (calendar-cursor-to-date)
22864 defd (encode-time 0 (or mod 0) (or hod 0)
22865 (nth 1 date) (nth 0 date) (nth 2 date))))
22866 ((eq major-mode 'org-agenda-mode)
22867 (setq day (get-text-property (point) 'day))
22868 (if day
22869 (setq date (calendar-gregorian-from-absolute day)
22870 defd (encode-time 0 (or mod 0) (or hod 0)
22871 (nth 1 date) (nth 0 date) (nth 2 date))))))
22872 (or defd (current-time))))
22874 (defun org-mark-subtree (&optional up)
22875 "Mark the current subtree.
22876 This puts point at the start of the current subtree, and mark at
22877 the end. If a numeric prefix UP is given, move up into the
22878 hierarchy of headlines by UP levels before marking the subtree."
22879 (interactive "P")
22880 (org-with-limited-levels
22881 (cond ((org-at-heading-p) (beginning-of-line))
22882 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22883 (t (outline-previous-visible-heading 1))))
22884 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22885 (if (org-called-interactively-p 'any)
22886 (call-interactively 'org-mark-element)
22887 (org-mark-element)))
22890 ;;; Indentation
22892 (defun org--get-expected-indentation (element contentsp)
22893 "Expected indentation column for current line, according to ELEMENT.
22894 ELEMENT is an element containing point. CONTENTSP is non-nil
22895 when indentation is to be computed according to contents of
22896 ELEMENT."
22897 (let ((type (org-element-type element))
22898 (start (org-element-property :begin element))
22899 (post-affiliated (org-element-property :post-affiliated element)))
22900 (org-with-wide-buffer
22901 (cond
22902 (contentsp
22903 (case type
22904 ((diary-sexp footnote-definition) 0)
22905 ((headline inlinetask nil)
22906 (if (not org-adapt-indentation) 0
22907 (let ((level (org-current-level)))
22908 (if level (1+ level) 0))))
22909 ((item plain-list) (org-list-item-body-column post-affiliated))
22911 (goto-char start)
22912 (org-get-indentation))))
22913 ((memq type '(headline inlinetask nil))
22914 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22915 (org--get-expected-indentation element t)
22917 ((memq type '(diary-sexp footnote-definition)) 0)
22918 ;; First paragraph of a footnote definition or an item.
22919 ;; Indent like parent.
22920 ((< (line-beginning-position) start)
22921 (org--get-expected-indentation
22922 (org-element-property :parent element) t))
22923 ;; At first line: indent according to previous sibling, if any,
22924 ;; ignoring footnote definitions and inline tasks, or parent's
22925 ;; contents.
22926 ((= (line-beginning-position) start)
22927 (catch 'exit
22928 (while t
22929 (if (= (point-min) start) (throw 'exit 0)
22930 (goto-char (1- start))
22931 (let* ((previous (org-element-at-point))
22932 (parent previous))
22933 (while (and parent (<= (org-element-property :end parent) start))
22934 (setq previous parent
22935 parent (org-element-property :parent parent)))
22936 (cond
22937 ((not previous) (throw 'exit 0))
22938 ((> (org-element-property :end previous) start)
22939 (throw 'exit (org--get-expected-indentation previous t)))
22940 ((memq (org-element-type previous)
22941 '(footnote-definition inlinetask))
22942 (setq start (org-element-property :begin previous)))
22943 (t (goto-char (org-element-property :begin previous))
22944 (throw 'exit
22945 (if (bolp) (org-get-indentation)
22946 ;; At first paragraph in an item or
22947 ;; a footnote definition.
22948 (org--get-expected-indentation
22949 (org-element-property :parent previous) t))))))))))
22950 ;; Otherwise, move to the first non-blank line above.
22952 (beginning-of-line)
22953 (let ((pos (point)))
22954 (skip-chars-backward " \r\t\n")
22955 (cond
22956 ;; Two blank lines end a footnote definition or a plain
22957 ;; list. When we indent an empty line after them, the
22958 ;; containing list or footnote definition is over, so it
22959 ;; qualifies as a previous sibling. Therefore, we indent
22960 ;; like its first line.
22961 ((and (memq type '(footnote-definition plain-list))
22962 (> (count-lines (point) pos) 2))
22963 (goto-char start)
22964 (org-get-indentation))
22965 ;; Line above is the first one of a paragraph at the
22966 ;; beginning of an item or a footnote definition. Indent
22967 ;; like parent.
22968 ((< (line-beginning-position) start)
22969 (org--get-expected-indentation
22970 (org-element-property :parent element) t))
22971 ;; Line above is the beginning of an element, i.e., point
22972 ;; was originally on the blank lines between element's start
22973 ;; and contents.
22974 ((= (line-beginning-position) post-affiliated)
22975 (org--get-expected-indentation element t))
22976 ;; POS is after contents in a greater element. Indent like
22977 ;; the beginning of the element.
22979 ;; As a special case, if point is at the end of a footnote
22980 ;; definition or an item, indent like the very last element
22981 ;; within.
22982 ((and (not (eq type 'paragraph))
22983 (let ((cend (org-element-property :contents-end element)))
22984 (and cend (<= cend pos))))
22985 (if (memq type '(footnote-definition item plain-list))
22986 (let ((last (org-element-at-point)))
22987 (org--get-expected-indentation
22988 last
22989 (memq (org-element-type last)
22990 '(footnote-definition item plain-list))))
22991 (goto-char start)
22992 (org-get-indentation)))
22993 ;; In any other case, indent like the current line.
22994 (t (org-get-indentation)))))))))
22996 (defun org--align-node-property ()
22997 "Align node property at point.
22998 Alignment is done according to `org-property-format', which see."
22999 (when (save-excursion
23000 (beginning-of-line)
23001 (looking-at org-property-re))
23002 (replace-match
23003 (concat (match-string 4)
23004 (org-trim
23005 (format org-property-format (match-string 1) (match-string 3))))
23006 t t)))
23008 (defun org-indent-line ()
23009 "Indent line depending on context.
23011 Indentation is done according to the following rules:
23013 - Footnote definitions, diary sexps, headlines and inline tasks
23014 have to start at column 0.
23016 - On the very first line of an element, consider, in order, the
23017 next rules until one matches:
23019 1. If there's a sibling element before, ignoring footnote
23020 definitions and inline tasks, indent like its first line.
23022 2. If element has a parent, indent like its contents. More
23023 precisely, if parent is an item, indent after the
23024 description part, if any, or the bullet (see
23025 `org-list-description-max-indent'). Else, indent like
23026 parent's first line.
23028 3. Otherwise, indent relatively to current level, if
23029 `org-adapt-indentation' is non-nil, or to left margin.
23031 - On a blank line at the end of an element, indent according to
23032 the type of the element. More precisely
23034 1. If element is a plain list, an item, or a footnote
23035 definition, indent like the very last element within.
23037 2. If element is a paragraph, indent like its last non blank
23038 line.
23040 3. Otherwise, indent like its very first line.
23042 - In the code part of a source block, use language major mode
23043 to indent current line if `org-src-tab-acts-natively' is
23044 non-nil. If it is nil, do nothing.
23046 - Otherwise, indent like the first non-blank line above.
23048 The function doesn't indent an item as it could break the whole
23049 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
23050 \\[org-shiftmetaright].
23052 Also align node properties according to `org-property-format'."
23053 (interactive)
23054 (cond
23055 (orgstruct-is-++
23056 (let ((indent-line-function
23057 (cadadr (assq 'indent-line-function org-fb-vars))))
23058 (indent-according-to-mode)))
23059 ((org-at-heading-p) 'noindent)
23061 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23062 (type (org-element-type element)))
23063 (cond ((and (memq type '(plain-list item))
23064 (= (line-beginning-position)
23065 (org-element-property :post-affiliated element)))
23066 'noindent)
23067 ((and (eq type 'src-block)
23068 org-src-tab-acts-natively
23069 (> (line-beginning-position)
23070 (org-element-property :post-affiliated element))
23071 (< (line-beginning-position)
23072 (org-with-wide-buffer
23073 (goto-char (org-element-property :end element))
23074 (skip-chars-backward " \r\t\n")
23075 (line-beginning-position))))
23076 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23078 (let ((column (org--get-expected-indentation element nil)))
23079 ;; Preserve current column.
23080 (if (<= (current-column) (current-indentation))
23081 (org-indent-line-to column)
23082 (save-excursion (org-indent-line-to column))))
23083 ;; Align node property. Also preserve current column.
23084 (when (eq type 'node-property)
23085 (let ((column (current-column)))
23086 (org--align-node-property)
23087 (org-move-to-column column)))))))))
23089 (defun org-indent-region (start end)
23090 "Indent each non-blank line in the region.
23091 Called from a program, START and END specify the region to
23092 indent. The function will not indent contents of example blocks,
23093 verse blocks and export blocks as leading white spaces are
23094 assumed to be significant there."
23095 (interactive "r")
23096 (save-excursion
23097 (goto-char start)
23098 (skip-chars-forward " \r\t\n")
23099 (unless (eobp) (beginning-of-line))
23100 (let ((indent-to
23101 (lambda (ind pos)
23102 ;; Set IND as indentation for all lines between point and
23103 ;; POS or END, whichever comes first. Blank lines are
23104 ;; ignored. Leave point after POS once done.
23105 (let ((limit (copy-marker (min end pos))))
23106 (while (< (point) limit)
23107 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23108 (forward-line))
23109 (set-marker limit nil))))
23110 (end (copy-marker end)))
23111 (while (< (point) end)
23112 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23113 (let* ((element (org-element-at-point))
23114 (type (org-element-type element))
23115 (element-end (copy-marker (org-element-property :end element)))
23116 (ind (org--get-expected-indentation element nil)))
23117 (cond
23118 ((or (memq type '(paragraph table table-row))
23119 (not (or (org-element-property :contents-begin element)
23120 (memq type
23121 '(example-block export-block src-block)))))
23122 ;; Elements here are indented as a single block. Also
23123 ;; align node properties.
23124 (when (eq type 'node-property)
23125 (org--align-node-property)
23126 (beginning-of-line))
23127 (funcall indent-to ind element-end))
23129 ;; Elements in this category consist of three parts:
23130 ;; before the contents, the contents, and after the
23131 ;; contents. The contents are treated specially,
23132 ;; according to the element type, or not indented at
23133 ;; all. Other parts are indented as a single block.
23134 (let* ((post (copy-marker
23135 (org-element-property :post-affiliated element)))
23136 (cbeg
23137 (copy-marker
23138 (cond
23139 ((not (org-element-property :contents-begin element))
23140 ;; Fake contents for source blocks.
23141 (org-with-wide-buffer
23142 (goto-char post)
23143 (forward-line)
23144 (point)))
23145 ((memq type '(footnote-definition item plain-list))
23146 ;; Contents in these elements could start on
23147 ;; the same line as the beginning of the
23148 ;; element. Make sure we start indenting
23149 ;; from the second line.
23150 (org-with-wide-buffer
23151 (goto-char post)
23152 (end-of-line)
23153 (skip-chars-forward " \r\t\n")
23154 (if (eobp) (point) (line-beginning-position))))
23155 (t (org-element-property :contents-begin element)))))
23156 (cend (copy-marker
23157 (or (org-element-property :contents-end element)
23158 ;; Fake contents for source blocks.
23159 (org-with-wide-buffer
23160 (goto-char element-end)
23161 (skip-chars-backward " \r\t\n")
23162 (line-beginning-position)))
23163 t)))
23164 ;; Do not change items indentation individually as it
23165 ;; might break the list as a whole. On the other
23166 ;; hand, when at a plain list, indent it as a whole.
23167 (cond ((eq type 'plain-list)
23168 (let ((offset (- ind (org-get-indentation))))
23169 (unless (zerop offset)
23170 (indent-rigidly (org-element-property :begin element)
23171 (org-element-property :end element)
23172 offset))
23173 (goto-char cbeg)))
23174 ((eq type 'item) (goto-char cbeg))
23175 (t (funcall indent-to ind cbeg)))
23176 (when (< (point) end)
23177 (case type
23178 ((example-block export-block verse-block))
23179 (src-block
23180 ;; In a source block, indent source code
23181 ;; according to language major mode, but only if
23182 ;; `org-src-tab-acts-natively' is non-nil.
23183 (when (and (< (point) end) org-src-tab-acts-natively)
23184 (ignore-errors
23185 (org-babel-do-in-edit-buffer
23186 (indent-region (point-min) (point-max))))))
23187 (t (org-indent-region (point) (min cend end))))
23188 (goto-char (min cend end))
23189 (when (< (point) end) (funcall indent-to ind element-end)))
23190 (set-marker post nil)
23191 (set-marker cbeg nil)
23192 (set-marker cend nil))))
23193 (set-marker element-end nil))))
23194 (set-marker end nil))))
23196 (defun org-indent-drawer ()
23197 "Indent the drawer at point."
23198 (interactive)
23199 (unless (save-excursion
23200 (beginning-of-line)
23201 (org-looking-at-p org-drawer-regexp))
23202 (user-error "Not at a drawer"))
23203 (let ((element (org-element-at-point)))
23204 (unless (memq (org-element-type element) '(drawer property-drawer))
23205 (user-error "Not at a drawer"))
23206 (org-with-wide-buffer
23207 (org-indent-region (org-element-property :begin element)
23208 (org-element-property :end element))))
23209 (message "Drawer at point indented"))
23211 (defun org-indent-block ()
23212 "Indent the block at point."
23213 (interactive)
23214 (unless (save-excursion
23215 (beginning-of-line)
23216 (let ((case-fold-search t))
23217 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23218 (user-error "Not at a block"))
23219 (let ((element (org-element-at-point)))
23220 (unless (memq (org-element-type element)
23221 '(comment-block center-block dynamic-block example-block
23222 export-block quote-block special-block
23223 src-block verse-block))
23224 (user-error "Not at a block"))
23225 (org-with-wide-buffer
23226 (org-indent-region (org-element-property :begin element)
23227 (org-element-property :end element))))
23228 (message "Block at point indented"))
23231 ;;; Filling
23233 ;; We use our own fill-paragraph and auto-fill functions.
23235 ;; `org-fill-paragraph' relies on adaptive filling and context
23236 ;; checking. Appropriate `fill-prefix' is computed with
23237 ;; `org-adaptive-fill-function'.
23239 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23240 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23241 ;; `org-adaptive-fill-function' value. Internally,
23242 ;; `org-comment-line-break-function' breaks the line.
23244 ;; `org-setup-filling' installs filling and auto-filling related
23245 ;; variables during `org-mode' initialization.
23247 (defvar org-element-paragraph-separate) ; org-element.el
23248 (defun org-setup-filling ()
23249 (require 'org-element)
23250 ;; Prevent auto-fill from inserting unwanted new items.
23251 (when (boundp 'fill-nobreak-predicate)
23252 (org-set-local
23253 'fill-nobreak-predicate
23254 (org-uniquify
23255 (append fill-nobreak-predicate
23256 '(org-fill-line-break-nobreak-p
23257 org-fill-paragraph-with-timestamp-nobreak-p)))))
23258 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23259 (org-set-local 'paragraph-start paragraph-ending)
23260 (org-set-local 'paragraph-separate paragraph-ending))
23261 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23262 (org-set-local 'auto-fill-inhibit-regexp nil)
23263 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23264 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23265 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23267 (defun org-fill-line-break-nobreak-p ()
23268 "Non-nil when a new line at point would create an Org line break."
23269 (save-excursion
23270 (skip-chars-backward "[ \t]")
23271 (skip-chars-backward "\\\\")
23272 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23274 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23275 "Non-nil when a new line at point would split a timestamp."
23276 (and (org-at-timestamp-p t)
23277 (not (looking-at org-ts-regexp-both))))
23279 (declare-function message-in-body-p "message" ())
23280 (defvar orgtbl-line-start-regexp) ; From org-table.el
23281 (defun org-adaptive-fill-function ()
23282 "Compute a fill prefix for the current line.
23283 Return fill prefix, as a string, or nil if current line isn't
23284 meant to be filled. For convenience, if `adaptive-fill-regexp'
23285 matches in paragraphs or comments, use it."
23286 (catch 'exit
23287 (when (derived-mode-p 'message-mode)
23288 (save-excursion
23289 (beginning-of-line)
23290 (cond ((not (message-in-body-p)) (throw 'exit nil))
23291 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23292 ((looking-at message-cite-prefix-regexp)
23293 (throw 'exit (match-string-no-properties 0)))
23294 ((looking-at org-outline-regexp)
23295 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23296 (org-with-wide-buffer
23297 (unless (org-at-heading-p)
23298 (let* ((p (line-beginning-position))
23299 (element (save-excursion
23300 (beginning-of-line)
23301 (org-element-at-point)))
23302 (type (org-element-type element))
23303 (post-affiliated (org-element-property :post-affiliated element)))
23304 (unless (< p post-affiliated)
23305 (case type
23306 (comment
23307 (save-excursion
23308 (beginning-of-line)
23309 (looking-at "[ \t]*")
23310 (concat (match-string 0) "# ")))
23311 (footnote-definition "")
23312 ((item plain-list)
23313 (make-string (org-list-item-body-column post-affiliated) ?\s))
23314 (paragraph
23315 ;; Fill prefix is usually the same as the current line,
23316 ;; unless the paragraph is at the beginning of an item.
23317 (let ((parent (org-element-property :parent element)))
23318 (save-excursion
23319 (beginning-of-line)
23320 (cond ((eq (org-element-type parent) 'item)
23321 (make-string (org-list-item-body-column
23322 (org-element-property :begin parent))
23323 ?\s))
23324 ((and adaptive-fill-regexp
23325 ;; Locally disable
23326 ;; `adaptive-fill-function' to let
23327 ;; `fill-context-prefix' handle
23328 ;; `adaptive-fill-regexp' variable.
23329 (let (adaptive-fill-function)
23330 (fill-context-prefix
23331 post-affiliated
23332 (org-element-property :end element)))))
23333 ((looking-at "[ \t]+") (match-string 0))
23334 (t "")))))
23335 (comment-block
23336 ;; Only fill contents if P is within block boundaries.
23337 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23338 (forward-line)
23339 (point)))
23340 (cend (save-excursion
23341 (goto-char (org-element-property :end element))
23342 (skip-chars-backward " \r\t\n")
23343 (line-beginning-position))))
23344 (when (and (>= p cbeg) (< p cend))
23345 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23346 (match-string 0)
23347 "")))))))))))
23349 (declare-function message-goto-body "message" ())
23350 (defvar message-cite-prefix-regexp) ; From message.el
23351 (defun org-fill-paragraph (&optional justify)
23352 "Fill element at point, when applicable.
23354 This function only applies to comment blocks, comments, example
23355 blocks and paragraphs. Also, as a special case, re-align table
23356 when point is at one.
23358 If JUSTIFY is non-nil (interactively, with prefix argument),
23359 justify as well. If `sentence-end-double-space' is non-nil, then
23360 period followed by one space does not end a sentence, so don't
23361 break a line there. The variable `fill-column' controls the
23362 width for filling.
23364 For convenience, when point is at a plain list, an item or
23365 a footnote definition, try to fill the first paragraph within."
23366 (interactive)
23367 (if (and (derived-mode-p 'message-mode)
23368 (or (not (message-in-body-p))
23369 (save-excursion (move-beginning-of-line 1)
23370 (looking-at message-cite-prefix-regexp))))
23371 ;; First ensure filling is correct in message-mode.
23372 (let ((fill-paragraph-function
23373 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23374 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23375 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23376 (paragraph-separate
23377 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23378 (fill-paragraph nil))
23379 (with-syntax-table org-mode-transpose-word-syntax-table
23380 ;; Move to end of line in order to get the first paragraph
23381 ;; within a plain list or a footnote definition.
23382 (let ((element (save-excursion
23383 (end-of-line)
23384 (or (ignore-errors (org-element-at-point))
23385 (user-error "An element cannot be parsed line %d"
23386 (line-number-at-pos (point)))))))
23387 ;; First check if point is in a blank line at the beginning of
23388 ;; the buffer. In that case, ignore filling.
23389 (case (org-element-type element)
23390 ;; Use major mode filling function is src blocks.
23391 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23392 ;; Align Org tables, leave table.el tables as-is.
23393 (table-row (org-table-align) t)
23394 (table
23395 (when (eq (org-element-property :type element) 'org)
23396 (save-excursion
23397 (goto-char (org-element-property :post-affiliated element))
23398 (org-table-align)))
23400 (paragraph
23401 ;; Paragraphs may contain `line-break' type objects.
23402 (let ((beg (max (point-min)
23403 (org-element-property :contents-begin element)))
23404 (end (min (point-max)
23405 (org-element-property :contents-end element))))
23406 ;; Do nothing if point is at an affiliated keyword.
23407 (if (< (line-end-position) beg) t
23408 (when (derived-mode-p 'message-mode)
23409 ;; In `message-mode', do not fill following citation
23410 ;; in current paragraph nor text before message body.
23411 (let ((body-start (save-excursion (message-goto-body))))
23412 (when body-start (setq beg (max body-start beg))))
23413 (when (save-excursion
23414 (re-search-forward
23415 (concat "^" message-cite-prefix-regexp) end t))
23416 (setq end (match-beginning 0))))
23417 ;; Fill paragraph, taking line breaks into account.
23418 (save-excursion
23419 (goto-char beg)
23420 (let ((cuts (list beg)))
23421 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23422 (when (eq 'line-break
23423 (org-element-type
23424 (save-excursion (backward-char)
23425 (org-element-context))))
23426 (push (point) cuts)))
23427 (dolist (c (delq end cuts))
23428 (fill-region-as-paragraph c end justify)
23429 (setq end c))))
23430 t)))
23431 ;; Contents of `comment-block' type elements should be
23432 ;; filled as plain text, but only if point is within block
23433 ;; markers.
23434 (comment-block
23435 (let* ((case-fold-search t)
23436 (beg (save-excursion
23437 (goto-char (org-element-property :begin element))
23438 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23439 (forward-line)
23440 (point)))
23441 (end (save-excursion
23442 (goto-char (org-element-property :end element))
23443 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23444 (line-beginning-position))))
23445 (if (or (< (point) beg) (> (point) end)) t
23446 (fill-region-as-paragraph
23447 (save-excursion (end-of-line)
23448 (re-search-backward "^[ \t]*$" beg 'move)
23449 (line-beginning-position))
23450 (save-excursion (beginning-of-line)
23451 (re-search-forward "^[ \t]*$" end 'move)
23452 (line-beginning-position))
23453 justify))))
23454 ;; Fill comments.
23455 (comment
23456 (let ((begin (org-element-property :post-affiliated element))
23457 (end (org-element-property :end element)))
23458 (when (and (>= (point) begin) (<= (point) end))
23459 (let ((begin (save-excursion
23460 (end-of-line)
23461 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23462 (progn (forward-line) (point))
23463 begin)))
23464 (end (save-excursion
23465 (end-of-line)
23466 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23467 (1- (line-beginning-position))
23468 (skip-chars-backward " \r\t\n")
23469 (line-end-position)))))
23470 ;; Do not fill comments when at a blank line.
23471 (when (> end begin)
23472 (let ((fill-prefix
23473 (save-excursion
23474 (beginning-of-line)
23475 (looking-at "[ \t]*#")
23476 (let ((comment-prefix (match-string 0)))
23477 (goto-char (match-end 0))
23478 (if (looking-at adaptive-fill-regexp)
23479 (concat comment-prefix (match-string 0))
23480 (concat comment-prefix " "))))))
23481 (save-excursion
23482 (fill-region-as-paragraph begin end justify))))))
23484 ;; Ignore every other element.
23485 (otherwise t))))))
23487 (defun org-auto-fill-function ()
23488 "Auto-fill function."
23489 ;; Check if auto-filling is meaningful.
23490 (let ((fc (current-fill-column)))
23491 (when (and fc (> (current-column) fc))
23492 (let* ((fill-prefix (org-adaptive-fill-function))
23493 ;; Enforce empty fill prefix, if required. Otherwise, it
23494 ;; will be computed again.
23495 (adaptive-fill-mode (not (equal fill-prefix ""))))
23496 (when fill-prefix (do-auto-fill))))))
23498 (defun org-comment-line-break-function (&optional soft)
23499 "Break line at point and indent, continuing comment if within one.
23500 The inserted newline is marked hard if variable
23501 `use-hard-newlines' is true, unless optional argument SOFT is
23502 non-nil."
23503 (if soft (insert-and-inherit ?\n) (newline 1))
23504 (save-excursion (forward-char -1) (delete-horizontal-space))
23505 (delete-horizontal-space)
23506 (indent-to-left-margin)
23507 (insert-before-markers-and-inherit fill-prefix))
23510 ;;; Fixed Width Areas
23512 (defun org-toggle-fixed-width ()
23513 "Toggle fixed-width markup.
23515 Add or remove fixed-width markup on current line, whenever it
23516 makes sense. Return an error otherwise.
23518 If a region is active and if it contains only fixed-width areas
23519 or blank lines, remove all fixed-width markup in it. If the
23520 region contains anything else, convert all non-fixed-width lines
23521 to fixed-width ones.
23523 Blank lines at the end of the region are ignored unless the
23524 region only contains such lines."
23525 (interactive)
23526 (if (not (org-region-active-p))
23527 ;; No region:
23529 ;; Remove fixed width marker only in a fixed-with element.
23531 ;; Add fixed width maker in paragraphs, in blank lines after
23532 ;; elements or at the beginning of a headline or an inlinetask,
23533 ;; and before any one-line elements (e.g., a clock).
23534 (progn
23535 (beginning-of-line)
23536 (let* ((element (org-element-at-point))
23537 (type (org-element-type element)))
23538 (cond
23539 ((and (eq type 'fixed-width)
23540 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23541 (replace-match
23542 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23543 ((and (memq type '(babel-call clock comment diary-sexp headline
23544 horizontal-rule keyword paragraph
23545 planning))
23546 (<= (org-element-property :post-affiliated element) (point)))
23547 (skip-chars-forward " \t")
23548 (insert ": "))
23549 ((and (org-looking-at-p "[ \t]*$")
23550 (or (eq type 'inlinetask)
23551 (save-excursion
23552 (skip-chars-forward " \r\t\n")
23553 (<= (org-element-property :end element) (point)))))
23554 (delete-region (point) (line-end-position))
23555 (org-indent-line)
23556 (insert ": "))
23557 (t (user-error "Cannot insert a fixed-width line here")))))
23558 ;; Region active.
23559 (let* ((begin (save-excursion
23560 (goto-char (region-beginning))
23561 (line-beginning-position)))
23562 (end (copy-marker
23563 (save-excursion
23564 (goto-char (region-end))
23565 (unless (eolp) (beginning-of-line))
23566 (if (save-excursion (re-search-backward "\\S-" begin t))
23567 (progn (skip-chars-backward " \r\t\n") (point))
23568 (point)))))
23569 (all-fixed-width-p
23570 (catch 'not-all-p
23571 (save-excursion
23572 (goto-char begin)
23573 (skip-chars-forward " \r\t\n")
23574 (when (eobp) (throw 'not-all-p nil))
23575 (while (< (point) end)
23576 (let ((element (org-element-at-point)))
23577 (if (eq (org-element-type element) 'fixed-width)
23578 (goto-char (org-element-property :end element))
23579 (throw 'not-all-p nil))))
23580 t))))
23581 (if all-fixed-width-p
23582 (save-excursion
23583 (goto-char begin)
23584 (while (< (point) end)
23585 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23586 (replace-match
23587 "" nil nil nil
23588 (if (= (line-end-position) (match-end 0)) 0 1)))
23589 (forward-line)))
23590 (let ((min-ind (point-max)))
23591 ;; Find minimum indentation across all lines.
23592 (save-excursion
23593 (goto-char begin)
23594 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23595 (setq min-ind 0)
23596 (catch 'zerop
23597 (while (< (point) end)
23598 (unless (org-looking-at-p "[ \t]*$")
23599 (let ((ind (org-get-indentation)))
23600 (setq min-ind (min min-ind ind))
23601 (when (zerop ind) (throw 'zerop t))))
23602 (forward-line)))))
23603 ;; Loop over all lines and add fixed-width markup everywhere
23604 ;; but in fixed-width lines.
23605 (save-excursion
23606 (goto-char begin)
23607 (while (< (point) end)
23608 (cond
23609 ((org-at-heading-p)
23610 (insert ": ")
23611 (forward-line)
23612 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23613 (insert ":")
23614 (forward-line)))
23615 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23616 (let* ((element (org-element-at-point))
23617 (element-end (org-element-property :end element)))
23618 (if (eq (org-element-type element) 'fixed-width)
23619 (progn (goto-char element-end)
23620 (skip-chars-backward " \r\t\n")
23621 (forward-line))
23622 (let ((limit (min end element-end)))
23623 (while (< (point) limit)
23624 (org-move-to-column min-ind t)
23625 (insert ": ")
23626 (forward-line))))))
23628 (org-move-to-column min-ind t)
23629 (insert ": ")
23630 (forward-line)))))))
23631 (set-marker end nil))))
23634 ;;; Comments
23636 ;; Org comments syntax is quite complex. It requires the entire line
23637 ;; to be just a comment. Also, even with the right syntax at the
23638 ;; beginning of line, some some elements (i.e. verse-block or
23639 ;; example-block) don't accept comments. Usual Emacs comment commands
23640 ;; cannot cope with those requirements. Therefore, Org replaces them.
23642 ;; Org still relies on `comment-dwim', but cannot trust
23643 ;; `comment-only-p'. So, `comment-region-function' and
23644 ;; `uncomment-region-function' both point
23645 ;; to`org-comment-or-uncomment-region'. Eventually,
23646 ;; `org-insert-comment' takes care of insertion of comments at the
23647 ;; beginning of line.
23649 ;; `org-setup-comments-handling' install comments related variables
23650 ;; during `org-mode' initialization.
23652 (defun org-setup-comments-handling ()
23653 (interactive)
23654 (org-set-local 'comment-use-syntax nil)
23655 (org-set-local 'comment-start "# ")
23656 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23657 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23658 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23659 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23661 (defun org-insert-comment ()
23662 "Insert an empty comment above current line.
23663 If the line is empty, insert comment at its beginning. When
23664 point is within a source block, comment according to the related
23665 major mode."
23666 (if (let ((element (org-element-at-point)))
23667 (and (eq (org-element-type element) 'src-block)
23668 (< (save-excursion
23669 (goto-char (org-element-property :post-affiliated element))
23670 (line-end-position))
23671 (point))
23672 (> (save-excursion
23673 (goto-char (org-element-property :end element))
23674 (skip-chars-backward " \r\t\n")
23675 (line-beginning-position))
23676 (point))))
23677 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23678 (beginning-of-line)
23679 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23680 (open-line 1))
23681 (org-indent-line)
23682 (insert "# ")))
23684 (defvar comment-empty-lines) ; From newcomment.el.
23685 (defun org-comment-or-uncomment-region (beg end &rest _)
23686 "Comment or uncomment each non-blank line in the region.
23687 Uncomment each non-blank line between BEG and END if it only
23688 contains commented lines. Otherwise, comment them. If region is
23689 strictly within a source block, use appropriate comment syntax."
23690 (if (let ((element (org-element-at-point)))
23691 (and (eq (org-element-type element) 'src-block)
23692 (< (save-excursion
23693 (goto-char (org-element-property :post-affiliated element))
23694 (line-end-position))
23695 beg)
23696 (>= (save-excursion
23697 (goto-char (org-element-property :end element))
23698 (skip-chars-backward " \r\t\n")
23699 (line-beginning-position))
23700 end)))
23701 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23702 (save-restriction
23703 ;; Restrict region
23704 (narrow-to-region (save-excursion (goto-char beg)
23705 (skip-chars-forward " \r\t\n" end)
23706 (line-beginning-position))
23707 (save-excursion (goto-char end)
23708 (skip-chars-backward " \r\t\n" beg)
23709 (line-end-position)))
23710 (let ((uncommentp
23711 ;; UNCOMMENTP is non-nil when every non blank line between
23712 ;; BEG and END is a comment.
23713 (save-excursion
23714 (goto-char (point-min))
23715 (while (and (not (eobp))
23716 (let ((element (org-element-at-point)))
23717 (and (eq (org-element-type element) 'comment)
23718 (goto-char (min (point-max)
23719 (org-element-property
23720 :end element)))))))
23721 (eobp))))
23722 (if uncommentp
23723 ;; Only blank lines and comments in region: uncomment it.
23724 (save-excursion
23725 (goto-char (point-min))
23726 (while (not (eobp))
23727 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23728 (replace-match "" nil nil nil 1))
23729 (forward-line)))
23730 ;; Comment each line in region.
23731 (let ((min-indent (point-max)))
23732 ;; First find the minimum indentation across all lines.
23733 (save-excursion
23734 (goto-char (point-min))
23735 (while (and (not (eobp)) (not (zerop min-indent)))
23736 (unless (looking-at "[ \t]*$")
23737 (setq min-indent (min min-indent (current-indentation))))
23738 (forward-line)))
23739 ;; Then loop over all lines.
23740 (save-excursion
23741 (goto-char (point-min))
23742 (while (not (eobp))
23743 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23744 ;; Don't get fooled by invisible text (e.g. link path)
23745 ;; when moving to column MIN-INDENT.
23746 (let ((buffer-invisibility-spec nil))
23747 (org-move-to-column min-indent t))
23748 (insert comment-start))
23749 (forward-line)))))))))
23751 (defun org-comment-dwim (arg)
23752 "Call `comment-dwim' within a source edit buffer if needed."
23753 (interactive "*P")
23754 (if (org-in-src-block-p)
23755 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23756 (call-interactively 'comment-dwim)))
23759 ;;; Timestamps API
23761 ;; This section contains tools to operate on timestamp objects, as
23762 ;; returned by, e.g. `org-element-context'.
23764 (defun org-timestamp--to-internal-time (timestamp &optional end)
23765 "Encode TIMESTAMP object into Emacs internal time.
23766 Use end of date range or time range when END is non-nil."
23767 (apply #'encode-time
23768 (cons 0
23769 (mapcar
23770 (lambda (prop) (or (org-element-property prop timestamp) 0))
23771 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23772 '(:minute-start :hour-start :day-start :month-start
23773 :year-start))))))
23775 (defun org-timestamp-has-time-p (timestamp)
23776 "Non-nil when TIMESTAMP has a time specified."
23777 (org-element-property :hour-start timestamp))
23779 (defun org-timestamp-format (timestamp format &optional end utc)
23780 "Format a TIMESTAMP object into a string.
23782 FORMAT is a format specifier to be passed to
23783 `format-time-string'.
23785 When optional argument END is non-nil, use end of date-range or
23786 time-range, if possible.
23788 When optional argument UTC is non-nil, time will be expressed as
23789 Universal Time."
23790 (format-time-string
23791 format (org-timestamp--to-internal-time timestamp end) utc))
23793 (defun org-timestamp-split-range (timestamp &optional end)
23794 "Extract a TIMESTAMP object from a date or time range.
23796 END, when non-nil, means extract the end of the range.
23797 Otherwise, extract its start.
23799 Return a new timestamp object."
23800 (let ((type (org-element-property :type timestamp)))
23801 (if (memq type '(active inactive diary)) timestamp
23802 (let ((split-ts (org-element-copy timestamp)))
23803 ;; Set new type.
23804 (org-element-put-property
23805 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23806 ;; Copy start properties over end properties if END is
23807 ;; non-nil. Otherwise, copy end properties over `start' ones.
23808 (let ((p-alist '((:minute-start . :minute-end)
23809 (:hour-start . :hour-end)
23810 (:day-start . :day-end)
23811 (:month-start . :month-end)
23812 (:year-start . :year-end))))
23813 (dolist (p-cell p-alist)
23814 (org-element-put-property
23815 split-ts
23816 (funcall (if end #'car #'cdr) p-cell)
23817 (org-element-property
23818 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23819 ;; Eventually refresh `:raw-value'.
23820 (org-element-put-property split-ts :raw-value nil)
23821 (org-element-put-property
23822 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23824 (defun org-timestamp-translate (timestamp &optional boundary)
23825 "Translate TIMESTAMP object to custom format.
23827 Format string is defined in `org-time-stamp-custom-formats',
23828 which see.
23830 When optional argument BOUNDARY is non-nil, it is either the
23831 symbol `start' or `end'. In this case, only translate the
23832 starting or ending part of TIMESTAMP if it is a date or time
23833 range. Otherwise, translate both parts.
23835 Return timestamp as-is if `org-display-custom-times' is nil or if
23836 it has a `diary' type."
23837 (let ((type (org-element-property :type timestamp)))
23838 (if (or (not org-display-custom-times) (eq type 'diary))
23839 (org-element-interpret-data timestamp)
23840 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23841 org-time-stamp-custom-formats)))
23842 (if (and (not boundary) (memq type '(active-range inactive-range)))
23843 (concat (org-timestamp-format timestamp fmt)
23844 "--"
23845 (org-timestamp-format timestamp fmt t))
23846 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23850 ;;; Other stuff.
23852 (defvar reftex-docstruct-symbol)
23853 (defvar reftex-cite-format)
23854 (defvar org--rds)
23856 (defun org-reftex-citation ()
23857 "Use reftex-citation to insert a citation into the buffer.
23858 This looks for a line like
23860 #+BIBLIOGRAPHY: foo plain option:-d
23862 and derives from it that foo.bib is the bibliography file relevant
23863 for this document. It then installs the necessary environment for RefTeX
23864 to work in this buffer and calls `reftex-citation' to insert a citation
23865 into the buffer.
23867 Export of such citations to both LaTeX and HTML is handled by the contributed
23868 package ox-bibtex by Taru Karttunen."
23869 (interactive)
23870 (let ((reftex-docstruct-symbol 'org--rds)
23871 (reftex-cite-format "\\cite{%l}")
23872 org--rds bib)
23873 (save-excursion
23874 (save-restriction
23875 (widen)
23876 (let ((case-fold-search t)
23877 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23878 (if (not (save-excursion
23879 (or (re-search-forward re nil t)
23880 (re-search-backward re nil t))))
23881 (user-error "No bibliography defined in file")
23882 (setq bib (concat (match-string 1) ".bib")
23883 org--rds (list (list 'bib bib)))))))
23884 (call-interactively 'reftex-citation)))
23886 ;;;; Functions extending outline functionality
23888 (defun org-beginning-of-line (&optional arg)
23889 "Go to the beginning of the current line. If that is invisible, continue
23890 to a visible line beginning. This makes the function of C-a more intuitive.
23891 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23892 first attempt, and only move to after the tags when the cursor is already
23893 beyond the end of the headline."
23894 (interactive "P")
23895 (let ((pos (point))
23896 (special (if (consp org-special-ctrl-a/e)
23897 (car org-special-ctrl-a/e)
23898 org-special-ctrl-a/e))
23899 deactivate-mark refpos)
23900 (if (org-bound-and-true-p visual-line-mode)
23901 (beginning-of-visual-line 1)
23902 (beginning-of-line 1))
23903 (if (and arg (fboundp 'move-beginning-of-line))
23904 (call-interactively 'move-beginning-of-line)
23905 (if (bobp)
23907 (backward-char 1)
23908 (if (org-truely-invisible-p)
23909 (while (and (not (bobp)) (org-truely-invisible-p))
23910 (backward-char 1)
23911 (beginning-of-line 1))
23912 (forward-char 1))))
23913 (when special
23914 (cond
23915 ((and (looking-at org-complex-heading-regexp)
23916 (eq (char-after (match-end 1)) ?\s))
23917 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23918 (point-at-eol)))
23919 (goto-char
23920 (if (eq special t)
23921 (cond ((> pos refpos) refpos)
23922 ((= pos (point)) refpos)
23923 (t (point)))
23924 (cond ((> pos (point)) (point))
23925 ((not (eq last-command this-command)) (point))
23926 (t refpos)))))
23927 ((org-at-item-p)
23928 ;; Being at an item and not looking at an the item means point
23929 ;; was previously moved to beginning of a visual line, which
23930 ;; doesn't contain the item. Therefore, do nothing special,
23931 ;; just stay here.
23932 (when (looking-at org-list-full-item-re)
23933 ;; Set special position at first white space character after
23934 ;; bullet, and check-box, if any.
23935 (let ((after-bullet
23936 (let ((box (match-end 3)))
23937 (if (not box) (match-end 1)
23938 (let ((after (char-after box)))
23939 (if (and after (= after ? )) (1+ box) box))))))
23940 ;; Special case: Move point to special position when
23941 ;; currently after it or at beginning of line.
23942 (if (eq special t)
23943 (when (or (> pos after-bullet) (= (point) pos))
23944 (goto-char after-bullet))
23945 ;; Reversed case: Move point to special position when
23946 ;; point was already at beginning of line and command is
23947 ;; repeated.
23948 (when (and (= (point) pos) (eq last-command this-command))
23949 (goto-char after-bullet))))))))
23950 (org-no-warnings
23951 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23952 (setq disable-point-adjustment
23953 (or (not (invisible-p (point)))
23954 (not (invisible-p (max (point-min) (1- (point))))))))
23956 (defun org-end-of-line (&optional arg)
23957 "Go to the end of the line.
23958 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23959 tags on the first attempt, and only move to after the tags when
23960 the cursor is already beyond the end of the headline."
23961 (interactive "P")
23962 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23963 org-special-ctrl-a/e))
23964 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23965 'end-of-visual-line)
23966 ((fboundp 'move-end-of-line) 'move-end-of-line)
23967 (t 'end-of-line)))
23968 deactivate-mark)
23969 (if (or (not special) arg) (call-interactively move-fun)
23970 (let* ((element (save-excursion (beginning-of-line)
23971 (org-element-at-point)))
23972 (type (org-element-type element)))
23973 (cond
23974 ((memq type '(headline inlinetask))
23975 (let ((pos (point)))
23976 (beginning-of-line 1)
23977 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23978 (if (eq special t)
23979 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23980 (goto-char (match-beginning 1))
23981 (goto-char (match-end 0)))
23982 (if (or (< pos (match-end 0))
23983 (not (eq this-command last-command)))
23984 (goto-char (match-end 0))
23985 (goto-char (match-beginning 1))))
23986 (call-interactively move-fun))))
23987 ((outline-invisible-p (line-end-position))
23988 ;; If element is hidden, `move-end-of-line' would put point
23989 ;; after it. Use `end-of-line' to stay on current line.
23990 (call-interactively 'end-of-line))
23991 (t (call-interactively move-fun)))))
23992 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23993 (setq disable-point-adjustment
23994 (or (not (invisible-p (point)))
23995 (not (invisible-p (max (point-min) (1- (point))))))))
23997 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23998 (define-key org-mode-map "\C-e" 'org-end-of-line)
24000 (defun org-backward-sentence (&optional _arg)
24001 "Go to beginning of sentence, or beginning of table field.
24002 This will call `backward-sentence' or `org-table-beginning-of-field',
24003 depending on context."
24004 (interactive)
24005 (let* ((element (org-element-at-point))
24006 (contents-begin (org-element-property :contents-begin element))
24007 (table (org-element-lineage element '(table) t)))
24008 (if (and table
24009 (> (point) contents-begin)
24010 (<= (point) (org-element-property :contents-end table)))
24011 (call-interactively #'org-table-beginning-of-field)
24012 (save-restriction
24013 (when (and contents-begin
24014 (< (point-min) contents-begin)
24015 (> (point) contents-begin))
24016 (narrow-to-region contents-begin
24017 (org-element-property :contents-end element)))
24018 (call-interactively #'backward-sentence)))))
24020 (defun org-forward-sentence (&optional _arg)
24021 "Go to end of sentence, or end of table field.
24022 This will call `forward-sentence' or `org-table-end-of-field',
24023 depending on context."
24024 (interactive)
24025 (let* ((element (org-element-at-point))
24026 (contents-end (org-element-property :contents-end element))
24027 (table (org-element-lineage element '(table) t)))
24028 (if (and table
24029 (>= (point) (org-element-property :contents-begin table))
24030 (< (point) contents-end))
24031 (call-interactively #'org-table-end-of-field)
24032 (save-restriction
24033 (when (and contents-end
24034 (> (point-max) contents-end)
24035 ;; Skip blank lines between elements.
24036 (< (org-element-property :end element)
24037 (save-excursion (goto-char contents-end)
24038 (skip-chars-forward " \r\t\n"))))
24039 (narrow-to-region (org-element-property :contents-begin element)
24040 contents-end))
24041 (call-interactively #'forward-sentence)))))
24043 (define-key org-mode-map "\M-a" 'org-backward-sentence)
24044 (define-key org-mode-map "\M-e" 'org-forward-sentence)
24046 (defun org-kill-line (&optional _arg)
24047 "Kill line, to tags or end of line."
24048 (interactive)
24049 (cond
24050 ((or (not org-special-ctrl-k)
24051 (bolp)
24052 (not (org-at-heading-p)))
24053 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
24054 org-ctrl-k-protect-subtree)
24055 (if (or (eq org-ctrl-k-protect-subtree 'error)
24056 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
24057 (user-error "C-k aborted as it would kill a hidden subtree")))
24058 (call-interactively
24059 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24060 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24061 (kill-region (point) (match-beginning 1))
24062 (org-set-tags nil t))
24063 (t (kill-region (point) (point-at-eol)))))
24065 (define-key org-mode-map "\C-k" 'org-kill-line)
24067 (defun org-yank (&optional arg)
24068 "Yank. If the kill is a subtree, treat it specially.
24069 This command will look at the current kill and check if is a single
24070 subtree, or a series of subtrees[1]. If it passes the test, and if the
24071 cursor is at the beginning of a line or after the stars of a currently
24072 empty headline, then the yank is handled specially. How exactly depends
24073 on the value of the following variables, both set by default.
24075 `org-yank-folded-subtrees'
24076 When set, the subtree(s) will be folded after insertion, but only
24077 if doing so would now swallow text after the yanked text.
24079 `org-yank-adjusted-subtrees'
24080 When set, the subtree will be promoted or demoted in order to
24081 fit into the local outline tree structure, which means that the
24082 level will be adjusted so that it becomes the smaller one of the
24083 two *visible* surrounding headings.
24085 Any prefix to this command will cause `yank' to be called directly with
24086 no special treatment. In particular, a simple \\[universal-argument] prefix \
24087 will just
24088 plainly yank the text as it is.
24090 [1] The test checks if the first non-white line is a heading
24091 and if there are no other headings with fewer stars."
24092 (interactive "P")
24093 (org-yank-generic 'yank arg))
24095 (defun org-yank-generic (command arg)
24096 "Perform some yank-like command.
24098 This function implements the behavior described in the `org-yank'
24099 documentation. However, it has been generalized to work for any
24100 interactive command with similar behavior."
24102 ;; pretend to be command COMMAND
24103 (setq this-command command)
24105 (if arg
24106 (call-interactively command)
24108 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24109 (and (org-kill-is-subtree-p)
24110 (or (bolp)
24111 (and (looking-at "[ \t]*$")
24112 (string-match
24113 "\\`\\*+\\'"
24114 (buffer-substring (point-at-bol) (point)))))))
24115 swallowp)
24116 (cond
24117 ((and subtreep org-yank-folded-subtrees)
24118 (let ((beg (point))
24119 end)
24120 (if (and subtreep org-yank-adjusted-subtrees)
24121 (org-paste-subtree nil nil 'for-yank)
24122 (call-interactively command))
24124 (setq end (point))
24125 (goto-char beg)
24126 (when (and (bolp) subtreep
24127 (not (setq swallowp
24128 (org-yank-folding-would-swallow-text beg end))))
24129 (org-with-limited-levels
24130 (or (looking-at org-outline-regexp)
24131 (re-search-forward org-outline-regexp-bol end t))
24132 (while (and (< (point) end) (looking-at org-outline-regexp))
24133 (hide-subtree)
24134 (org-cycle-show-empty-lines 'folded)
24135 (condition-case nil
24136 (outline-forward-same-level 1)
24137 (error (goto-char end))))))
24138 (when swallowp
24139 (message
24140 "Inserted text not folded because that would swallow text"))
24142 (goto-char end)
24143 (skip-chars-forward " \t\n\r")
24144 (beginning-of-line 1)
24145 (push-mark beg 'nomsg)))
24146 ((and subtreep org-yank-adjusted-subtrees)
24147 (let ((beg (point-at-bol)))
24148 (org-paste-subtree nil nil 'for-yank)
24149 (push-mark beg 'nomsg)))
24151 (call-interactively command))))))
24153 (defun org-yank-folding-would-swallow-text (beg end)
24154 "Would hide-subtree at BEG swallow any text after END?"
24155 (let (level)
24156 (org-with-limited-levels
24157 (save-excursion
24158 (goto-char beg)
24159 (when (or (looking-at org-outline-regexp)
24160 (re-search-forward org-outline-regexp-bol end t))
24161 (setq level (org-outline-level)))
24162 (goto-char end)
24163 (skip-chars-forward " \t\r\n\v\f")
24164 (if (or (eobp)
24165 (and (bolp) (looking-at org-outline-regexp)
24166 (<= (org-outline-level) level)))
24167 nil ; Nothing would be swallowed
24168 t))))) ; something would swallow
24170 (define-key org-mode-map "\C-y" 'org-yank)
24172 (defun org-truely-invisible-p ()
24173 "Check if point is at a character currently not visible.
24174 This version does not only check the character property, but also
24175 `visible-mode'."
24176 ;; Early versions of noutline don't have `outline-invisible-p'.
24177 (if (org-bound-and-true-p visible-mode)
24179 (outline-invisible-p)))
24181 (defun org-invisible-p2 ()
24182 "Check if point is at a character currently not visible."
24183 (save-excursion
24184 (if (and (eolp) (not (bobp))) (backward-char 1))
24185 ;; Early versions of noutline don't have `outline-invisible-p'.
24186 (outline-invisible-p)))
24188 (defun org-back-to-heading (&optional invisible-ok)
24189 "Call `outline-back-to-heading', but provide a better error message."
24190 (condition-case nil
24191 (outline-back-to-heading invisible-ok)
24192 (error (error "Before first headline at position %d in buffer %s"
24193 (point) (current-buffer)))))
24195 (defun org-before-first-heading-p ()
24196 "Before first heading?"
24197 (save-excursion
24198 (end-of-line)
24199 (null (re-search-backward org-outline-regexp-bol nil t))))
24201 (defun org-at-heading-p (&optional ignored)
24202 (outline-on-heading-p t))
24203 ;; Compatibility alias with Org versions < 7.8.03
24204 (defalias 'org-on-heading-p 'org-at-heading-p)
24206 (defun org-in-commented-heading-p (&optional no-inheritance)
24207 "Non-nil if point is under a commented heading.
24208 This function also checks ancestors of the current headline,
24209 unless optional argument NO-INHERITANCE is non-nil."
24210 (cond
24211 ((org-before-first-heading-p) nil)
24212 ((let ((headline (nth 4 (org-heading-components))))
24213 (and headline
24214 (let ((case-fold-search nil))
24215 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24216 headline)))))
24217 (no-inheritance nil)
24219 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24221 (defun org-at-comment-p nil
24222 "Is cursor in a commented line?"
24223 (save-excursion
24224 (save-match-data
24225 (beginning-of-line)
24226 (looking-at "^[ \t]*# "))))
24228 (defun org-at-drawer-p nil
24229 "Is cursor at a drawer keyword?"
24230 (save-excursion
24231 (move-beginning-of-line 1)
24232 (looking-at org-drawer-regexp)))
24234 (defun org-at-block-p nil
24235 "Is cursor at a block keyword?"
24236 (save-excursion
24237 (move-beginning-of-line 1)
24238 (looking-at org-block-regexp)))
24240 (defun org-point-at-end-of-empty-headline ()
24241 "If point is at the end of an empty headline, return t, else nil.
24242 If the heading only contains a TODO keyword, it is still still considered
24243 empty."
24244 (and (looking-at "[ \t]*$")
24245 (when org-todo-line-regexp
24246 (save-excursion
24247 (beginning-of-line 1)
24248 (let ((case-fold-search nil))
24249 (looking-at org-todo-line-regexp)
24250 (string= (match-string 3) ""))))))
24252 (defun org-at-heading-or-item-p ()
24253 (or (org-at-heading-p) (org-at-item-p)))
24255 (defun org-at-target-p ()
24256 (or (org-in-regexp org-radio-target-regexp)
24257 (org-in-regexp org-target-regexp)))
24258 ;; Compatibility alias with Org versions < 7.8.03
24259 (defalias 'org-on-target-p 'org-at-target-p)
24261 (defun org-up-heading-all (arg)
24262 "Move to the heading line of which the present line is a subheading.
24263 This function considers both visible and invisible heading lines.
24264 With argument, move up ARG levels."
24265 (if (fboundp 'outline-up-heading-all)
24266 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24267 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24269 (defun org-up-heading-safe ()
24270 "Move to the heading line of which the present line is a subheading.
24271 This version will not throw an error. It will return the level of the
24272 headline found, or nil if no higher level is found.
24274 Also, this function will be a lot faster than `outline-up-heading',
24275 because it relies on stars being the outline starters. This can really
24276 make a significant difference in outlines with very many siblings."
24277 (when (ignore-errors (org-back-to-heading t))
24278 (let ((level-up (1- (funcall outline-level))))
24279 (and (> level-up 0)
24280 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24281 (funcall outline-level)))))
24283 (defun org-first-sibling-p ()
24284 "Is this heading the first child of its parents?"
24285 (interactive)
24286 (let ((re org-outline-regexp-bol)
24287 level l)
24288 (unless (org-at-heading-p t)
24289 (user-error "Not at a heading"))
24290 (setq level (funcall outline-level))
24291 (save-excursion
24292 (if (not (re-search-backward re nil t))
24294 (setq l (funcall outline-level))
24295 (< l level)))))
24297 (defun org-goto-sibling (&optional previous)
24298 "Goto the next sibling, even if it is invisible.
24299 When PREVIOUS is set, go to the previous sibling instead. Returns t
24300 when a sibling was found. When none is found, return nil and don't
24301 move point."
24302 (let ((fun (if previous 're-search-backward 're-search-forward))
24303 (pos (point))
24304 (re org-outline-regexp-bol)
24305 level l)
24306 (when (ignore-errors (org-back-to-heading t))
24307 (setq level (funcall outline-level))
24308 (catch 'exit
24309 (or previous (forward-char 1))
24310 (while (funcall fun re nil t)
24311 (setq l (funcall outline-level))
24312 (when (< l level) (goto-char pos) (throw 'exit nil))
24313 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24314 (goto-char pos)
24315 nil))))
24317 (defun org-show-siblings ()
24318 "Show all siblings of the current headline."
24319 (save-excursion
24320 (while (org-goto-sibling) (org-flag-heading nil)))
24321 (save-excursion
24322 (while (org-goto-sibling 'previous)
24323 (org-flag-heading nil))))
24325 (defun org-goto-first-child ()
24326 "Goto the first child, even if it is invisible.
24327 Return t when a child was found. Otherwise don't move point and
24328 return nil."
24329 (let (level (pos (point)) (re org-outline-regexp-bol))
24330 (when (ignore-errors (org-back-to-heading t))
24331 (setq level (outline-level))
24332 (forward-char 1)
24333 (if (and (re-search-forward re nil t) (> (outline-level) level))
24334 (progn (goto-char (match-beginning 0)) t)
24335 (goto-char pos) nil))))
24337 (defun org-show-hidden-entry ()
24338 "Show an entry where even the heading is hidden."
24339 (save-excursion
24340 (org-show-entry)))
24342 (defun org-flag-heading (flag &optional entry)
24343 "Flag the current heading. FLAG non-nil means make invisible.
24344 When ENTRY is non-nil, show the entire entry."
24345 (save-excursion
24346 (org-back-to-heading t)
24347 ;; Check if we should show the entire entry
24348 (if entry
24349 (progn
24350 (org-show-entry)
24351 (save-excursion
24352 (and (outline-next-heading)
24353 (org-flag-heading nil))))
24354 (outline-flag-region (max (point-min) (1- (point)))
24355 (save-excursion (outline-end-of-heading) (point))
24356 flag))))
24358 (defun org-get-next-sibling ()
24359 "Move to next heading of the same level, and return point.
24360 If there is no such heading, return nil.
24361 This is like outline-next-sibling, but invisible headings are ok."
24362 (let ((level (funcall outline-level)))
24363 (outline-next-heading)
24364 (while (and (not (eobp)) (> (funcall outline-level) level))
24365 (outline-next-heading))
24366 (if (or (eobp) (< (funcall outline-level) level))
24368 (point))))
24370 (defun org-get-last-sibling ()
24371 "Move to previous heading of the same level, and return point.
24372 If there is no such heading, return nil."
24373 (let ((opoint (point))
24374 (level (funcall outline-level)))
24375 (outline-previous-heading)
24376 (when (and (/= (point) opoint) (outline-on-heading-p t))
24377 (while (and (> (funcall outline-level) level)
24378 (not (bobp)))
24379 (outline-previous-heading))
24380 (if (< (funcall outline-level) level)
24382 (point)))))
24384 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24385 "Goto to the end of a subtree."
24386 ;; This contains an exact copy of the original function, but it uses
24387 ;; `org-back-to-heading', to make it work also in invisible
24388 ;; trees. And is uses an invisible-ok argument.
24389 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24390 ;; Furthermore, when used inside Org, finding the end of a large subtree
24391 ;; with many children and grandchildren etc, this can be much faster
24392 ;; than the outline version.
24393 (org-back-to-heading invisible-ok)
24394 (let ((first t)
24395 (level (funcall outline-level)))
24396 (if (and (derived-mode-p 'org-mode) (< level 1000))
24397 ;; A true heading (not a plain list item), in Org-mode
24398 ;; This means we can easily find the end by looking
24399 ;; only for the right number of stars. Using a regexp to do
24400 ;; this is so much faster than using a Lisp loop.
24401 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24402 (forward-char 1)
24403 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24404 ;; something else, do it the slow way
24405 (while (and (not (eobp))
24406 (or first (> (funcall outline-level) level)))
24407 (setq first nil)
24408 (outline-next-heading)))
24409 (unless to-heading
24410 (if (memq (preceding-char) '(?\n ?\^M))
24411 (progn
24412 ;; Go to end of line before heading
24413 (forward-char -1)
24414 (if (memq (preceding-char) '(?\n ?\^M))
24415 ;; leave blank line before heading
24416 (forward-char -1))))))
24417 (point))
24419 (defun org-end-of-meta-data (&optional full)
24420 "Skip planning line and properties drawer in current entry.
24421 When optional argument FULL is non-nil, also skip empty lines,
24422 clocking lines and regular drawers at the beginning of the
24423 entry."
24424 (org-back-to-heading t)
24425 (forward-line)
24426 (when (org-looking-at-p org-planning-line-re) (forward-line))
24427 (when (looking-at org-property-drawer-re)
24428 (goto-char (match-end 0))
24429 (forward-line))
24430 (when (and full (not (org-at-heading-p)))
24431 (catch 'exit
24432 (let ((end (save-excursion (outline-next-heading) (point)))
24433 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24434 (while (not (eobp))
24435 (cond ((org-looking-at-p org-drawer-regexp)
24436 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24437 (forward-line)
24438 (throw 'exit t)))
24439 ((org-looking-at-p re) (forward-line))
24440 (t (throw 'exit t))))))))
24442 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24443 "Move forward to the ARG'th subheading at same level as this one.
24444 Stop at the first and last subheadings of a superior heading.
24445 Normally this only looks at visible headings, but when INVISIBLE-OK is
24446 non-nil it will also look at invisible ones."
24447 (interactive "p")
24448 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24449 (if (and arg (< arg 0))
24450 (goto-char (point-min))
24451 (outline-next-heading))
24452 (org-at-heading-p)
24453 (let ((level (- (match-end 0) (match-beginning 0) 1))
24454 (f (if (and arg (< arg 0))
24455 're-search-backward
24456 're-search-forward))
24457 (count (if arg (abs arg) 1))
24458 (result (point)))
24459 (while (and (prog1 (> count 0)
24460 (forward-char (if (and arg (< arg 0)) -1 1)))
24461 (funcall f org-outline-regexp-bol nil 'move))
24462 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24463 (cond ((< l level) (setq count 0))
24464 ((and (= l level)
24465 (or invisible-ok
24466 (progn
24467 (goto-char (line-beginning-position))
24468 (not (outline-invisible-p)))))
24469 (setq count (1- count))
24470 (when (eq l level)
24471 (setq result (point)))))))
24472 (goto-char result))
24473 (beginning-of-line 1)))
24475 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24476 "Move backward to the ARG'th subheading at same level as this one.
24477 Stop at the first and last subheadings of a superior heading."
24478 (interactive "p")
24479 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24481 (defun org-next-visible-heading (arg)
24482 "Move to the next visible heading.
24484 This function wraps `outline-next-visible-heading' with
24485 `org-with-limited-levels' in order to skip over inline tasks and
24486 respect customization of `org-odd-levels-only'."
24487 (interactive "p")
24488 (org-with-limited-levels
24489 (outline-next-visible-heading arg)))
24491 (defun org-previous-visible-heading (arg)
24492 "Move to the next visible heading.
24494 This function wraps `outline-previous-visible-heading' with
24495 `org-with-limited-levels' in order to skip over inline tasks and
24496 respect customization of `org-odd-levels-only'."
24497 (interactive "p")
24498 (org-with-limited-levels
24499 (outline-previous-visible-heading arg)))
24501 (defun org-next-block (arg &optional backward block-regexp)
24502 "Jump to the next block.
24504 With a prefix argument ARG, jump forward ARG many blocks.
24506 When BACKWARD is non-nil, jump to the previous block.
24508 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24509 Match data is set according to this regexp when the function
24510 returns.
24512 Return point at beginning of the opening line of found block.
24513 Throw an error if no block is found."
24514 (interactive "p")
24515 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24516 (case-fold-search t)
24517 (search-fn (if backward #'re-search-backward #'re-search-forward))
24518 (count (or arg 1))
24519 (origin (point))
24520 last-element)
24521 (if backward (beginning-of-line) (end-of-line))
24522 (while (and (> count 0) (funcall search-fn re nil t))
24523 (let ((element (save-excursion
24524 (goto-char (match-beginning 0))
24525 (save-match-data (org-element-at-point)))))
24526 (when (and (memq (org-element-type element)
24527 '(center-block comment-block dynamic-block
24528 example-block export-block quote-block
24529 special-block src-block verse-block))
24530 (<= (match-beginning 0)
24531 (org-element-property :post-affiliated element)))
24532 (setq last-element element)
24533 (decf count))))
24534 (if (= count 0)
24535 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24536 (save-match-data (org-show-context)))
24537 (goto-char origin)
24538 (user-error "No %s code blocks" (if backward "previous" "further")))))
24540 (defun org-previous-block (arg &optional block-regexp)
24541 "Jump to the previous block.
24542 With a prefix argument ARG, jump backward ARG many source blocks.
24543 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24544 (interactive "p")
24545 (org-next-block arg t block-regexp))
24547 (defun org-forward-paragraph ()
24548 "Move forward to beginning of next paragraph or equivalent.
24550 The function moves point to the beginning of the next visible
24551 structural element, which can be a paragraph, a table, a list
24552 item, etc. It also provides some special moves for convenience:
24554 - On an affiliated keyword, jump to the beginning of the
24555 relative element.
24556 - On an item or a footnote definition, move to the second
24557 element inside, if any.
24558 - On a table or a property drawer, jump after it.
24559 - On a verse or source block, stop after blank lines."
24560 (interactive)
24561 (when (eobp) (user-error "Cannot move further down"))
24562 (let* ((deactivate-mark nil)
24563 (element (org-element-at-point))
24564 (type (org-element-type element))
24565 (post-affiliated (org-element-property :post-affiliated element))
24566 (contents-begin (org-element-property :contents-begin element))
24567 (contents-end (org-element-property :contents-end element))
24568 (end (let ((end (org-element-property :end element)) (parent element))
24569 (while (and (setq parent (org-element-property :parent parent))
24570 (= (org-element-property :contents-end parent) end))
24571 (setq end (org-element-property :end parent)))
24572 end)))
24573 (cond ((not element)
24574 (skip-chars-forward " \r\t\n")
24575 (or (eobp) (beginning-of-line)))
24576 ;; On affiliated keywords, move to element's beginning.
24577 ((< (point) post-affiliated)
24578 (goto-char post-affiliated))
24579 ;; At a table row, move to the end of the table. Similarly,
24580 ;; at a node property, move to the end of the property
24581 ;; drawer.
24582 ((memq type '(node-property table-row))
24583 (goto-char (org-element-property
24584 :end (org-element-property :parent element))))
24585 ((memq type '(property-drawer table)) (goto-char end))
24586 ;; Consider blank lines as separators in verse and source
24587 ;; blocks to ease editing.
24588 ((memq type '(src-block verse-block))
24589 (when (eq type 'src-block)
24590 (setq contents-end
24591 (save-excursion (goto-char end)
24592 (skip-chars-backward " \r\t\n")
24593 (line-beginning-position))))
24594 (beginning-of-line)
24595 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24596 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24597 (goto-char end)
24598 (skip-chars-forward " \r\t\n")
24599 (if (= (point) contents-end) (goto-char end)
24600 (beginning-of-line))))
24601 ;; With no contents, just skip element.
24602 ((not contents-begin) (goto-char end))
24603 ;; If contents are invisible, skip the element altogether.
24604 ((outline-invisible-p (line-end-position))
24605 (case type
24606 (headline
24607 (org-with-limited-levels (outline-next-visible-heading 1)))
24608 ;; At a plain list, make sure we move to the next item
24609 ;; instead of skipping the whole list.
24610 (plain-list (forward-char)
24611 (org-forward-paragraph))
24612 (otherwise (goto-char end))))
24613 ((>= (point) contents-end) (goto-char end))
24614 ((>= (point) contents-begin)
24615 ;; This can only happen on paragraphs and plain lists.
24616 (case type
24617 (paragraph (goto-char end))
24618 ;; At a plain list, try to move to second element in
24619 ;; first item, if possible.
24620 (plain-list (end-of-line)
24621 (org-forward-paragraph))))
24622 ;; When contents start on the middle of a line (e.g. in
24623 ;; items and footnote definitions), try to reach first
24624 ;; element starting after current line.
24625 ((> (line-end-position) contents-begin)
24626 (end-of-line)
24627 (org-forward-paragraph))
24628 (t (goto-char contents-begin)))))
24630 (defun org-backward-paragraph ()
24631 "Move backward to start of previous paragraph or equivalent.
24633 The function moves point to the beginning of the current
24634 structural element, which can be a paragraph, a table, a list
24635 item, etc., or to the beginning of the previous visible one if
24636 point is already there. It also provides some special moves for
24637 convenience:
24639 - On an affiliated keyword, jump to the first one.
24640 - On a table or a property drawer, move to its beginning.
24641 - On a verse or source block, stop before blank lines."
24642 (interactive)
24643 (when (bobp) (user-error "Cannot move further up"))
24644 (let* ((deactivate-mark nil)
24645 (element (org-element-at-point))
24646 (type (org-element-type element))
24647 (contents-begin (org-element-property :contents-begin element))
24648 (contents-end (org-element-property :contents-end element))
24649 (post-affiliated (org-element-property :post-affiliated element))
24650 (begin (org-element-property :begin element)))
24651 (cond
24652 ((not element) (goto-char (point-min)))
24653 ((= (point) begin)
24654 (backward-char)
24655 (org-backward-paragraph))
24656 ((<= (point) post-affiliated) (goto-char begin))
24657 ((memq type '(node-property table-row))
24658 (goto-char (org-element-property
24659 :post-affiliated (org-element-property :parent element))))
24660 ((memq type '(property-drawer table)) (goto-char begin))
24661 ((memq type '(src-block verse-block))
24662 (when (eq type 'src-block)
24663 (setq contents-begin
24664 (save-excursion (goto-char begin) (forward-line) (point))))
24665 (if (= (point) contents-begin) (goto-char post-affiliated)
24666 ;; Inside a verse block, see blank lines as paragraph
24667 ;; separators.
24668 (let ((origin (point)))
24669 (skip-chars-backward " \r\t\n" contents-begin)
24670 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24671 (skip-chars-forward " \r\t\n" origin)
24672 (if (= (point) origin) (goto-char contents-begin)
24673 (beginning-of-line))))))
24674 ((not contents-begin) (goto-char (or post-affiliated begin)))
24675 ((eq type 'paragraph)
24676 (goto-char contents-begin)
24677 ;; When at first paragraph in an item or a footnote definition,
24678 ;; move directly to beginning of line.
24679 (let ((parent-contents
24680 (org-element-property
24681 :contents-begin (org-element-property :parent element))))
24682 (when (and parent-contents (= parent-contents contents-begin))
24683 (beginning-of-line))))
24684 ;; At the end of a greater element, move to the beginning of the
24685 ;; last element within.
24686 ((>= (point) contents-end)
24687 (goto-char (1- contents-end))
24688 (org-backward-paragraph))
24689 (t (goto-char (or post-affiliated begin))))
24690 ;; Ensure we never leave point invisible.
24691 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24693 (defun org-forward-element ()
24694 "Move forward by one element.
24695 Move to the next element at the same level, when possible."
24696 (interactive)
24697 (cond ((eobp) (user-error "Cannot move further down"))
24698 ((org-with-limited-levels (org-at-heading-p))
24699 (let ((origin (point)))
24700 (goto-char (org-end-of-subtree nil t))
24701 (unless (org-with-limited-levels (org-at-heading-p))
24702 (goto-char origin)
24703 (user-error "Cannot move further down"))))
24705 (let* ((elem (org-element-at-point))
24706 (end (org-element-property :end elem))
24707 (parent (org-element-property :parent elem)))
24708 (cond ((and parent (= (org-element-property :contents-end parent) end))
24709 (goto-char (org-element-property :end parent)))
24710 ((integer-or-marker-p end) (goto-char end))
24711 (t (message "No element at point")))))))
24713 (defun org-backward-element ()
24714 "Move backward by one element.
24715 Move to the previous element at the same level, when possible."
24716 (interactive)
24717 (cond ((bobp) (user-error "Cannot move further up"))
24718 ((org-with-limited-levels (org-at-heading-p))
24719 ;; At a headline, move to the previous one, if any, or stay
24720 ;; here.
24721 (let ((origin (point)))
24722 (org-with-limited-levels (org-backward-heading-same-level 1))
24723 ;; When current headline has no sibling above, move to its
24724 ;; parent.
24725 (when (= (point) origin)
24726 (or (org-with-limited-levels (org-up-heading-safe))
24727 (progn (goto-char origin)
24728 (user-error "Cannot move further up"))))))
24730 (let* ((elem (org-element-at-point))
24731 (beg (org-element-property :begin elem)))
24732 (cond
24733 ;; Move to beginning of current element if point isn't
24734 ;; there already.
24735 ((null beg) (message "No element at point"))
24736 ((/= (point) beg) (goto-char beg))
24737 (t (goto-char beg)
24738 (skip-chars-backward " \r\t\n")
24739 (unless (bobp)
24740 (let ((prev (org-element-at-point)))
24741 (goto-char (org-element-property :begin prev))
24742 (while (and (setq prev (org-element-property :parent prev))
24743 (<= (org-element-property :end prev) beg))
24744 (goto-char (org-element-property :begin prev)))))))))))
24746 (defun org-up-element ()
24747 "Move to upper element."
24748 (interactive)
24749 (if (org-with-limited-levels (org-at-heading-p))
24750 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24751 (let* ((elem (org-element-at-point))
24752 (parent (org-element-property :parent elem)))
24753 (if parent (goto-char (org-element-property :begin parent))
24754 (if (org-with-limited-levels (org-before-first-heading-p))
24755 (user-error "No surrounding element")
24756 (org-with-limited-levels (org-back-to-heading)))))))
24758 (defvar org-element-greater-elements)
24759 (defun org-down-element ()
24760 "Move to inner element."
24761 (interactive)
24762 (let ((element (org-element-at-point)))
24763 (cond
24764 ((memq (org-element-type element) '(plain-list table))
24765 (goto-char (org-element-property :contents-begin element))
24766 (forward-char))
24767 ((memq (org-element-type element) org-element-greater-elements)
24768 ;; If contents are hidden, first disclose them.
24769 (when (outline-invisible-p (line-end-position)) (org-cycle))
24770 (goto-char (or (org-element-property :contents-begin element)
24771 (user-error "No content for this element"))))
24772 (t (user-error "No inner element")))))
24774 (defun org-drag-element-backward ()
24775 "Move backward element at point."
24776 (interactive)
24777 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24778 (let* ((elem (org-element-at-point))
24779 (prev-elem
24780 (save-excursion
24781 (goto-char (org-element-property :begin elem))
24782 (skip-chars-backward " \r\t\n")
24783 (unless (bobp)
24784 (let* ((beg (org-element-property :begin elem))
24785 (prev (org-element-at-point))
24786 (up prev))
24787 (while (and (setq up (org-element-property :parent up))
24788 (<= (org-element-property :end up) beg))
24789 (setq prev up))
24790 prev)))))
24791 ;; Error out if no previous element or previous element is
24792 ;; a parent of the current one.
24793 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24794 (user-error "Cannot drag element backward")
24795 (let ((pos (point)))
24796 (org-element-swap-A-B prev-elem elem)
24797 (goto-char (+ (org-element-property :begin prev-elem)
24798 (- pos (org-element-property :begin elem)))))))))
24800 (defun org-drag-element-forward ()
24801 "Move forward element at point."
24802 (interactive)
24803 (let* ((pos (point))
24804 (elem (org-element-at-point)))
24805 (when (= (point-max) (org-element-property :end elem))
24806 (user-error "Cannot drag element forward"))
24807 (goto-char (org-element-property :end elem))
24808 (let ((next-elem (org-element-at-point)))
24809 (when (or (org-element-nested-p elem next-elem)
24810 (and (eq (org-element-type next-elem) 'headline)
24811 (not (eq (org-element-type elem) 'headline))))
24812 (goto-char pos)
24813 (user-error "Cannot drag element forward"))
24814 ;; Compute new position of point: it's shifted by NEXT-ELEM
24815 ;; body's length (without final blanks) and by the length of
24816 ;; blanks between ELEM and NEXT-ELEM.
24817 (let ((size-next (- (save-excursion
24818 (goto-char (org-element-property :end next-elem))
24819 (skip-chars-backward " \r\t\n")
24820 (forward-line)
24821 ;; Small correction if buffer doesn't end
24822 ;; with a newline character.
24823 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24824 (org-element-property :begin next-elem)))
24825 (size-blank (- (org-element-property :end elem)
24826 (save-excursion
24827 (goto-char (org-element-property :end elem))
24828 (skip-chars-backward " \r\t\n")
24829 (forward-line)
24830 (point)))))
24831 (org-element-swap-A-B elem next-elem)
24832 (goto-char (+ pos size-next size-blank))))))
24834 (defun org-drag-line-forward (arg)
24835 "Drag the line at point ARG lines forward."
24836 (interactive "p")
24837 (dotimes (n (abs arg))
24838 (let ((c (current-column)))
24839 (if (< 0 arg)
24840 (progn
24841 (beginning-of-line 2)
24842 (transpose-lines 1)
24843 (beginning-of-line 0))
24844 (transpose-lines 1)
24845 (beginning-of-line -1))
24846 (org-move-to-column c))))
24848 (defun org-drag-line-backward (arg)
24849 "Drag the line at point ARG lines backward."
24850 (interactive "p")
24851 (org-drag-line-forward (- arg)))
24853 (defun org-mark-element ()
24854 "Put point at beginning of this element, mark at end.
24856 Interactively, if this command is repeated or (in Transient Mark
24857 mode) if the mark is active, it marks the next element after the
24858 ones already marked."
24859 (interactive)
24860 (let (deactivate-mark)
24861 (if (and (org-called-interactively-p 'any)
24862 (or (and (eq last-command this-command) (mark t))
24863 (and transient-mark-mode mark-active)))
24864 (set-mark
24865 (save-excursion
24866 (goto-char (mark))
24867 (goto-char (org-element-property :end (org-element-at-point)))))
24868 (let ((element (org-element-at-point)))
24869 (end-of-line)
24870 (push-mark (org-element-property :end element) t t)
24871 (goto-char (org-element-property :begin element))))))
24873 (defun org-narrow-to-element ()
24874 "Narrow buffer to current element."
24875 (interactive)
24876 (let ((elem (org-element-at-point)))
24877 (cond
24878 ((eq (car elem) 'headline)
24879 (narrow-to-region
24880 (org-element-property :begin elem)
24881 (org-element-property :end elem)))
24882 ((memq (car elem) org-element-greater-elements)
24883 (narrow-to-region
24884 (org-element-property :contents-begin elem)
24885 (org-element-property :contents-end elem)))
24887 (narrow-to-region
24888 (org-element-property :begin elem)
24889 (org-element-property :end elem))))))
24891 (defun org-transpose-element ()
24892 "Transpose current and previous elements, keeping blank lines between.
24893 Point is moved after both elements."
24894 (interactive)
24895 (org-skip-whitespace)
24896 (let ((end (org-element-property :end (org-element-at-point))))
24897 (org-drag-element-backward)
24898 (goto-char end)))
24900 (defun org-unindent-buffer ()
24901 "Un-indent the visible part of the buffer.
24902 Relative indentation (between items, inside blocks, etc.) isn't
24903 modified."
24904 (interactive)
24905 (unless (eq major-mode 'org-mode)
24906 (user-error "Cannot un-indent a buffer not in Org mode"))
24907 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24908 unindent-tree ; For byte-compiler.
24909 (unindent-tree
24910 (function
24911 (lambda (contents)
24912 (mapc
24913 (lambda (element)
24914 (if (memq (org-element-type element) '(headline section))
24915 (funcall unindent-tree (org-element-contents element))
24916 (save-excursion
24917 (save-restriction
24918 (narrow-to-region
24919 (org-element-property :begin element)
24920 (org-element-property :end element))
24921 (org-do-remove-indentation)))))
24922 (reverse contents))))))
24923 (funcall unindent-tree (org-element-contents parse-tree))))
24925 (defun org-show-subtree ()
24926 "Show everything after this heading at deeper levels."
24927 (interactive)
24928 (outline-flag-region
24929 (point)
24930 (save-excursion
24931 (org-end-of-subtree t t))
24932 nil))
24934 (defun org-show-entry ()
24935 "Show the body directly following this heading.
24936 Show the heading too, if it is currently invisible."
24937 (interactive)
24938 (save-excursion
24939 (ignore-errors
24940 (org-back-to-heading t)
24941 (outline-flag-region
24942 (max (point-min) (1- (point)))
24943 (save-excursion
24944 (if (re-search-forward
24945 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24946 (match-beginning 1)
24947 (point-max)))
24948 nil)
24949 (org-cycle-hide-drawers 'children))))
24951 (defun org-make-options-regexp (kwds &optional extra)
24952 "Make a regular expression for keyword lines.
24953 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24954 when non-nil, is a regexp matching keywords names."
24955 (concat "^[ \t]*#\\+\\("
24956 (regexp-opt kwds)
24957 (and extra (concat (and kwds "\\|") extra))
24958 "\\):[ \t]*\\(.*\\)"))
24960 ;; Make isearch reveal the necessary context
24961 (defun org-isearch-end ()
24962 "Reveal context after isearch exits."
24963 (when isearch-success ; only if search was successful
24964 (if (featurep 'xemacs)
24965 ;; Under XEmacs, the hook is run in the correct place,
24966 ;; we directly show the context.
24967 (org-show-context 'isearch)
24968 ;; In Emacs the hook runs *before* restoring the overlays.
24969 ;; So we have to use a one-time post-command-hook to do this.
24970 ;; (Emacs 22 has a special variable, see function `org-mode')
24971 (unless (and (boundp 'isearch-mode-end-hook-quit)
24972 isearch-mode-end-hook-quit)
24973 ;; Only when the isearch was not quitted.
24974 (org-add-hook 'post-command-hook 'org-isearch-post-command
24975 'append 'local)))))
24977 (defun org-isearch-post-command ()
24978 "Remove self from hook, and show context."
24979 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24980 (org-show-context 'isearch))
24983 ;;;; Integration with and fixes for other packages
24985 ;;; Imenu support
24987 (defvar org-imenu-markers nil
24988 "All markers currently used by Imenu.")
24989 (make-variable-buffer-local 'org-imenu-markers)
24991 (defun org-imenu-new-marker (&optional pos)
24992 "Return a new marker for use by Imenu, and remember the marker."
24993 (let ((m (make-marker)))
24994 (move-marker m (or pos (point)))
24995 (push m org-imenu-markers)
24998 (defun org-imenu-get-tree ()
24999 "Produce the index for Imenu."
25000 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
25001 (setq org-imenu-markers nil)
25002 (let* ((n org-imenu-depth)
25003 (re (concat "^" (org-get-limited-outline-regexp)))
25004 (subs (make-vector (1+ n) nil))
25005 (last-level 0)
25006 m level head0 head)
25007 (save-excursion
25008 (save-restriction
25009 (widen)
25010 (goto-char (point-max))
25011 (while (re-search-backward re nil t)
25012 (setq level (org-reduced-level (funcall outline-level)))
25013 (when (and (<= level n)
25014 (looking-at org-complex-heading-regexp)
25015 (setq head0 (org-match-string-no-properties 4)))
25016 (setq head (org-link-display-format head0)
25017 m (org-imenu-new-marker))
25018 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
25019 (if (>= level last-level)
25020 (push (cons head m) (aref subs level))
25021 (push (cons head (aref subs (1+ level))) (aref subs level))
25022 (loop for i from (1+ level) to n do (aset subs i nil)))
25023 (setq last-level level)))))
25024 (aref subs 1)))
25026 (eval-after-load "imenu"
25027 '(progn
25028 (add-hook 'imenu-after-jump-hook
25029 (lambda ()
25030 (if (derived-mode-p 'org-mode)
25031 (org-show-context 'org-goto))))))
25033 (defun org-link-display-format (link)
25034 "Replace a link with its the description.
25035 If there is no description, use the link target."
25036 (save-match-data
25037 (if (string-match org-bracket-link-analytic-regexp link)
25038 (replace-match (if (match-end 5)
25039 (match-string 5 link)
25040 (concat (match-string 1 link)
25041 (match-string 3 link)))
25042 nil t link)
25043 link)))
25045 (defun org-toggle-link-display ()
25046 "Toggle the literal or descriptive display of links."
25047 (interactive)
25048 (if org-descriptive-links
25049 (progn (org-remove-from-invisibility-spec '(org-link))
25050 (org-restart-font-lock)
25051 (setq org-descriptive-links nil))
25052 (progn (add-to-invisibility-spec '(org-link))
25053 (org-restart-font-lock)
25054 (setq org-descriptive-links t))))
25056 ;; Speedbar support
25058 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25059 "Overlay marking the agenda restriction line in speedbar.")
25060 (overlay-put org-speedbar-restriction-lock-overlay
25061 'face 'org-agenda-restriction-lock)
25062 (overlay-put org-speedbar-restriction-lock-overlay
25063 'help-echo "Agendas are currently limited to this item.")
25064 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25066 (defun org-speedbar-set-agenda-restriction ()
25067 "Restrict future agenda commands to the location at point in speedbar.
25068 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25069 (interactive)
25070 (require 'org-agenda)
25071 (let (p m tp np dir txt)
25072 (cond
25073 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25074 'org-imenu t))
25075 (setq m (get-text-property p 'org-imenu-marker))
25076 (with-current-buffer (marker-buffer m)
25077 (goto-char m)
25078 (org-agenda-set-restriction-lock 'subtree)))
25079 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25080 'speedbar-function 'speedbar-find-file))
25081 (setq tp (previous-single-property-change
25082 (1+ p) 'speedbar-function)
25083 np (next-single-property-change
25084 tp 'speedbar-function)
25085 dir (speedbar-line-directory)
25086 txt (buffer-substring-no-properties (or tp (point-min))
25087 (or np (point-max))))
25088 (with-current-buffer (find-file-noselect
25089 (let ((default-directory dir))
25090 (expand-file-name txt)))
25091 (unless (derived-mode-p 'org-mode)
25092 (user-error "Cannot restrict to non-Org-mode file"))
25093 (org-agenda-set-restriction-lock 'file)))
25094 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25095 (move-overlay org-speedbar-restriction-lock-overlay
25096 (point-at-bol) (point-at-eol))
25097 (setq current-prefix-arg nil)
25098 (org-agenda-maybe-redo)))
25100 (defvar speedbar-file-key-map)
25101 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25102 (eval-after-load "speedbar"
25103 '(progn
25104 (speedbar-add-supported-extension ".org")
25105 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25106 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25107 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25108 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25109 (add-hook 'speedbar-visiting-tag-hook
25110 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25112 ;;; Fixes and Hacks for problems with other packages
25114 (defun org--flyspell-object-check-p (element)
25115 "Non-nil when Flyspell can check object at point.
25116 ELEMENT is the element at point."
25117 (let ((object (save-excursion
25118 (when (org-looking-at-p "\\>") (backward-char))
25119 (org-element-context element))))
25120 (case (org-element-type object)
25121 ;; Prevent checks in links due to keybinding conflict with
25122 ;; Flyspell.
25123 ((code entity export-snippet inline-babel-call
25124 inline-src-block line-break latex-fragment link macro
25125 statistics-cookie target timestamp verbatim)
25126 nil)
25127 (footnote-reference
25128 ;; Only in inline footnotes, within the definition.
25129 (and (eq (org-element-property :type object) 'inline)
25130 (< (save-excursion
25131 (goto-char (org-element-property :begin object))
25132 (search-forward ":" nil t 2))
25133 (point))))
25134 (otherwise t))))
25136 (defun org-mode-flyspell-verify ()
25137 "Function used for `flyspell-generic-check-word-predicate'."
25138 (if (org-at-heading-p)
25139 ;; At a headline or an inlinetask, check title only. This is
25140 ;; faster than relying on `org-element-at-point'.
25141 (and (save-excursion (beginning-of-line)
25142 (and (let ((case-fold-search t))
25143 (not (looking-at "\\*+ END[ \t]*$")))
25144 (looking-at org-complex-heading-regexp)))
25145 (match-beginning 4)
25146 (>= (point) (match-beginning 4))
25147 (or (not (match-beginning 5))
25148 (< (point) (match-beginning 5))))
25149 (let* ((element (org-element-at-point))
25150 (post-affiliated (org-element-property :post-affiliated element)))
25151 (cond
25152 ;; Ignore checks in all affiliated keywords but captions.
25153 ((< (point) post-affiliated)
25154 (and (save-excursion
25155 (beginning-of-line)
25156 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25157 (> (point) (match-end 0))
25158 (org--flyspell-object-check-p element)))
25159 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25160 ((let ((log (org-log-into-drawer)))
25161 (and log
25162 (let ((drawer (org-element-lineage element '(drawer))))
25163 (and drawer
25164 (eq (compare-strings
25165 log nil nil
25166 (org-element-property :drawer-name drawer) nil nil t)
25167 t)))))
25168 nil)
25170 (case (org-element-type element)
25171 ((comment quote-section) t)
25172 (comment-block
25173 ;; Allow checks between block markers, not on them.
25174 (and (> (line-beginning-position) post-affiliated)
25175 (save-excursion
25176 (end-of-line)
25177 (skip-chars-forward " \r\t\n")
25178 (< (point) (org-element-property :end element)))))
25179 ;; Arbitrary list of keywords where checks are meaningful.
25180 ;; Make sure point is on the value part of the element.
25181 (keyword
25182 (and (member (org-element-property :key element)
25183 '("DESCRIPTION" "TITLE"))
25184 (save-excursion
25185 (search-backward ":" (line-beginning-position) t))))
25186 ;; Check is globally allowed in paragraphs verse blocks and
25187 ;; table rows (after affiliated keywords) but some objects
25188 ;; must not be affected.
25189 ((paragraph table-row verse-block)
25190 (let ((cbeg (org-element-property :contents-begin element))
25191 (cend (org-element-property :contents-end element)))
25192 (and cbeg (>= (point) cbeg) (< (point) cend)
25193 (org--flyspell-object-check-p element))))))))))
25194 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25196 (defun org-remove-flyspell-overlays-in (beg end)
25197 "Remove flyspell overlays in region."
25198 (and (org-bound-and-true-p flyspell-mode)
25199 (fboundp 'flyspell-delete-region-overlays)
25200 (flyspell-delete-region-overlays beg end)))
25202 (defvar flyspell-delayed-commands)
25203 (eval-after-load "flyspell"
25204 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25206 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25207 (eval-after-load "bookmark"
25208 '(if (boundp 'bookmark-after-jump-hook)
25209 ;; We can use the hook
25210 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25211 ;; Hook not available, use advice
25212 (defadvice bookmark-jump (after org-make-visible activate)
25213 "Make the position visible."
25214 (org-bookmark-jump-unhide))))
25216 ;; Make sure saveplace shows the location if it was hidden
25217 (eval-after-load "saveplace"
25218 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25219 "Make the position visible."
25220 (org-bookmark-jump-unhide)))
25222 ;; Make sure ecb shows the location if it was hidden
25223 (eval-after-load "ecb"
25224 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25225 "Make hierarchy visible when jumping into location from ECB tree buffer."
25226 (if (derived-mode-p 'org-mode)
25227 (org-show-context))))
25229 (defun org-bookmark-jump-unhide ()
25230 "Unhide the current position, to show the bookmark location."
25231 (and (derived-mode-p 'org-mode)
25232 (or (outline-invisible-p)
25233 (save-excursion (goto-char (max (point-min) (1- (point))))
25234 (outline-invisible-p)))
25235 (org-show-context 'bookmark-jump)))
25237 (defun org-mark-jump-unhide ()
25238 "Make the point visible with `org-show-context' after jumping to the mark."
25239 (when (and (derived-mode-p 'org-mode)
25240 (outline-invisible-p))
25241 (org-show-context 'mark-goto)))
25243 (eval-after-load "simple"
25244 '(defadvice pop-to-mark-command (after org-make-visible activate)
25245 "Make the point visible with `org-show-context'."
25246 (org-mark-jump-unhide)))
25248 (eval-after-load "simple"
25249 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25250 "Make the point visible with `org-show-context'."
25251 (org-mark-jump-unhide)))
25253 (eval-after-load "simple"
25254 '(defadvice pop-global-mark (after org-make-visible activate)
25255 "Make the point visible with `org-show-context'."
25256 (org-mark-jump-unhide)))
25258 ;; Make session.el ignore our circular variable
25259 (defvar session-globals-exclude)
25260 (eval-after-load "session"
25261 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25263 ;;;; Finish up
25265 (provide 'org)
25267 (run-hooks 'org-load-hook)
25269 ;;; org.el ends here