org-format-outline-path: Cosmetic fix
[org-mode/org-tableheadings.git] / lisp / org.el
blob3ac7780ff30980f8519f4455aec830bdf9a4cb06
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 (setq default-directory (file-name-directory f))
5212 (insert-file-contents f)
5213 (setq alist
5214 ;; Fake Org mode to benefit from cache
5215 ;; without recurring needlessly.
5216 (let ((major-mode 'org-mode))
5217 (org--setup-collect-keywords
5218 regexp (cons f files) alist)))))))))))))))
5219 alist)
5221 (defun org--setup-process-tags (tags filetags)
5222 "Precompute variables used for tags.
5223 TAGS is a list of tags and tag group symbols, as strings.
5224 FILETAGS is a list of tags, as strings."
5225 ;; Process the file tags.
5226 (org-set-local 'org-file-tags
5227 (mapcar #'org-add-prop-inherited filetags))
5228 ;; Provide default tags if no local tags are found.
5229 (when (and (not tags) org-tag-alist)
5230 (setq tags
5231 (mapcar (lambda (tag)
5232 (case (car tag)
5233 (:startgroup "{")
5234 (:endgroup "}")
5235 (:startgrouptag "[")
5236 (:endgrouptag "]")
5237 (:grouptags ":")
5238 (:newline "\\n")
5239 (otherwise (concat (car tag)
5240 (and (characterp (cdr tag))
5241 (format "(%c)" (cdr tag)))))))
5242 org-tag-alist)))
5243 ;; Process the tags.
5244 (org-set-local 'org-tag-groups-alist nil)
5245 (org-set-local 'org-tag-alist nil)
5246 (let (group-flag)
5247 (while tags
5248 (let ((e (car tags)))
5249 (setq tags (cdr tags))
5250 (cond
5251 ((equal e "{")
5252 (push '(:startgroup) org-tag-alist)
5253 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5254 ((equal e "}")
5255 (push '(:endgroup) org-tag-alist)
5256 (setq group-flag nil))
5257 ((equal e "[")
5258 (push '(:startgrouptag) org-tag-alist)
5259 (when (equal (nth 1 tags) ":") (setq group-flag t)))
5260 ((equal e "]")
5261 (push '(:endgrouptag) org-tag-alist)
5262 (setq group-flag nil))
5263 ((equal e ":")
5264 (push '(:grouptags) org-tag-alist)
5265 (setq group-flag 'append))
5266 ((equal e "\\n") (push '(:newline) org-tag-alist))
5267 ((string-match
5268 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5269 "\\|{.+?}\\)" ; regular expression
5270 "\\(?:(\\(.\\))\\)?\\'")) e)
5271 (let ((tag (match-string 1 e))
5272 (key (and (match-beginning 2)
5273 (string-to-char (match-string 2 e)))))
5274 (cond ((eq group-flag 'append)
5275 (setcar org-tag-groups-alist
5276 (append (car org-tag-groups-alist) (list tag))))
5277 (group-flag (push (list tag) org-tag-groups-alist)))
5278 ;; Push all tags in groups, no matter if they already exist.
5279 (unless (and (not group-flag) (assoc tag org-tag-alist))
5280 (push (cons tag key) org-tag-alist))))))))
5281 (setq org-tag-alist (nreverse org-tag-alist)))
5283 (defun org-file-contents (file &optional noerror)
5284 "Return the contents of FILE, as a string."
5285 (if (and file (file-readable-p file))
5286 (with-temp-buffer
5287 (insert-file-contents file)
5288 (buffer-string))
5289 (funcall (if noerror 'message 'error)
5290 "Cannot read file \"%s\"%s"
5291 file
5292 (let ((from (buffer-file-name (buffer-base-buffer))))
5293 (if from (concat " (referenced in file \"" from "\")") "")))))
5295 (defun org-extract-log-state-settings (x)
5296 "Extract the log state setting from a TODO keyword string.
5297 This will extract info from a string like \"WAIT(w@/!)\"."
5298 (let (kw key log1 log2)
5299 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5300 (setq kw (match-string 1 x)
5301 key (and (match-end 2) (match-string 2 x))
5302 log1 (and (match-end 3) (match-string 3 x))
5303 log2 (and (match-end 4) (match-string 4 x)))
5304 (and (or log1 log2)
5305 (list kw
5306 (and log1 (if (equal log1 "!") 'time 'note))
5307 (and log2 (if (equal log2 "!") 'time 'note)))))))
5309 (defun org-remove-keyword-keys (list)
5310 "Remove a pair of parenthesis at the end of each string in LIST."
5311 (mapcar (lambda (x)
5312 (if (string-match "(.*)$" x)
5313 (substring x 0 (match-beginning 0))
5315 list))
5317 (defun org-assign-fast-keys (alist)
5318 "Assign fast keys to a keyword-key alist.
5319 Respect keys that are already there."
5320 (let (new e (alt ?0))
5321 (while (setq e (pop alist))
5322 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5323 (cdr e)) ;; Key already assigned.
5324 (push e new)
5325 (let ((clist (string-to-list (downcase (car e))))
5326 (used (append new alist)))
5327 (when (= (car clist) ?@)
5328 (pop clist))
5329 (while (and clist (rassoc (car clist) used))
5330 (pop clist))
5331 (unless clist
5332 (while (rassoc alt used)
5333 (incf alt)))
5334 (push (cons (car e) (or (car clist) alt)) new))))
5335 (nreverse new)))
5337 ;;; Some variables used in various places
5339 (defvar org-window-configuration nil
5340 "Used in various places to store a window configuration.")
5341 (defvar org-selected-window nil
5342 "Used in various places to store a window configuration.")
5343 (defvar org-finish-function nil
5344 "Function to be called when `C-c C-c' is used.
5345 This is for getting out of special buffers like capture.")
5348 ;; FIXME: Occasionally check by commenting these, to make sure
5349 ;; no other functions uses these, forgetting to let-bind them.
5350 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5351 (defvar org-last-state)
5352 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5354 ;; Defined somewhere in this file, but used before definition.
5355 (defvar org-entities) ;; defined in org-entities.el
5356 (defvar org-struct-menu)
5357 (defvar org-org-menu)
5358 (defvar org-tbl-menu)
5360 ;;;; Define the Org-mode
5362 ;; We use a before-change function to check if a table might need
5363 ;; an update.
5364 (defvar org-table-may-need-update t
5365 "Indicates that a table might need an update.
5366 This variable is set by `org-before-change-function'.
5367 `org-table-align' sets it back to nil.")
5368 (defun org-before-change-function (beg end)
5369 "Every change indicates that a table might need an update."
5370 (setq org-table-may-need-update t))
5371 (defvar org-mode-map)
5372 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5373 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5374 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5375 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5376 (defvar org-table-buffer-is-an nil)
5378 (defvar bidi-paragraph-direction)
5379 (defvar buffer-face-mode-face)
5381 (require 'outline)
5382 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5383 (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"))
5384 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5386 ;; Other stuff we need.
5387 (require 'time-date)
5388 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5389 (require 'easymenu)
5390 (autoload 'easy-menu-add "easymenu")
5391 (require 'overlay)
5393 ;; (require 'org-macs) moved higher up in the file before it is first used
5394 (require 'org-entities)
5395 ;; (require 'org-compat) moved higher up in the file before it is first used
5396 (require 'org-faces)
5397 (require 'org-list)
5398 (require 'org-pcomplete)
5399 (require 'org-src)
5400 (require 'org-footnote)
5401 (require 'org-macro)
5403 ;; babel
5404 (require 'ob)
5406 ;;;###autoload
5407 (define-derived-mode org-mode outline-mode "Org"
5408 "Outline-based notes management and organizer, alias
5409 \"Carsten's outline-mode for keeping track of everything.\"
5411 Org-mode develops organizational tasks around a NOTES file which
5412 contains information about projects as plain text. Org-mode is
5413 implemented on top of outline-mode, which is ideal to keep the content
5414 of large files well structured. It supports ToDo items, deadlines and
5415 time stamps, which magically appear in the diary listing of the Emacs
5416 calendar. Tables are easily created with a built-in table editor.
5417 Plain text URL-like links connect to websites, emails (VM), Usenet
5418 messages (Gnus), BBDB entries, and any files related to the project.
5419 For printing and sharing of notes, an Org-mode file (or a part of it)
5420 can be exported as a structured ASCII or HTML file.
5422 The following commands are available:
5424 \\{org-mode-map}"
5426 ;; Get rid of Outline menus, they are not needed
5427 ;; Need to do this here because define-derived-mode sets up
5428 ;; the keymap so late. Still, it is a waste to call this each time
5429 ;; we switch another buffer into org-mode.
5430 (if (featurep 'xemacs)
5431 (when (boundp 'outline-mode-menu-heading)
5432 ;; Assume this is Greg's port, it uses easymenu
5433 (easy-menu-remove outline-mode-menu-heading)
5434 (easy-menu-remove outline-mode-menu-show)
5435 (easy-menu-remove outline-mode-menu-hide))
5436 (define-key org-mode-map [menu-bar headings] 'undefined)
5437 (define-key org-mode-map [menu-bar hide] 'undefined)
5438 (define-key org-mode-map [menu-bar show] 'undefined))
5440 (org-load-modules-maybe)
5441 (when (featurep 'xemacs)
5442 (easy-menu-add org-org-menu)
5443 (easy-menu-add org-tbl-menu))
5444 (org-install-agenda-files-menu)
5445 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5446 (add-to-invisibility-spec '(org-cwidth))
5447 (add-to-invisibility-spec '(org-hide-block . t))
5448 (when (featurep 'xemacs)
5449 (org-set-local 'line-move-ignore-invisible t))
5450 (org-set-local 'outline-regexp org-outline-regexp)
5451 (org-set-local 'outline-level 'org-outline-level)
5452 (setq bidi-paragraph-direction 'left-to-right)
5453 (when (and org-ellipsis
5454 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5455 (fboundp 'make-glyph-code))
5456 (unless org-display-table
5457 (setq org-display-table (make-display-table)))
5458 (set-display-table-slot
5459 org-display-table 4
5460 (vconcat (mapcar
5461 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5462 org-ellipsis)))
5463 (if (stringp org-ellipsis) org-ellipsis "..."))))
5464 (setq buffer-display-table org-display-table))
5465 (org-set-regexps-and-options)
5466 (org-set-font-lock-defaults)
5467 (when (and org-tag-faces (not org-tags-special-faces-re))
5468 ;; tag faces set outside customize.... force initialization.
5469 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5470 ;; Calc embedded
5471 (org-set-local 'calc-embedded-open-mode "# ")
5472 ;; Modify a few syntax entries
5473 (modify-syntax-entry ?@ "w")
5474 (modify-syntax-entry ?\" "\"")
5475 (modify-syntax-entry ?\\ "_")
5476 (modify-syntax-entry ?~ "_")
5477 (if org-startup-truncated (setq truncate-lines t))
5478 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5479 (org-set-local 'font-lock-unfontify-region-function
5480 'org-unfontify-region)
5481 ;; Activate before-change-function
5482 (org-set-local 'org-table-may-need-update t)
5483 (org-add-hook 'before-change-functions 'org-before-change-function nil
5484 'local)
5485 ;; Check for running clock before killing a buffer
5486 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5487 ;; Initialize macros templates.
5488 (org-macro-initialize-templates)
5489 ;; Initialize radio targets.
5490 (org-update-radio-target-regexp)
5491 ;; Indentation.
5492 (org-set-local 'indent-line-function 'org-indent-line)
5493 (org-set-local 'indent-region-function 'org-indent-region)
5494 ;; Filling and auto-filling.
5495 (org-setup-filling)
5496 ;; Comments.
5497 (org-setup-comments-handling)
5498 ;; Initialize cache.
5499 (org-element-cache-reset)
5500 ;; Beginning/end of defun
5501 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5502 (org-set-local 'end-of-defun-function
5503 (lambda ()
5504 (if (not (org-at-heading-p))
5505 (org-forward-element)
5506 (org-forward-element)
5507 (forward-char -1))))
5508 ;; Next error for sparse trees
5509 (org-set-local 'next-error-function 'org-occur-next-match)
5510 ;; Make sure dependence stuff works reliably, even for users who set it
5511 ;; too late :-(
5512 (if org-enforce-todo-dependencies
5513 (add-hook 'org-blocker-hook
5514 'org-block-todo-from-children-or-siblings-or-parent)
5515 (remove-hook 'org-blocker-hook
5516 'org-block-todo-from-children-or-siblings-or-parent))
5517 (if org-enforce-todo-checkbox-dependencies
5518 (add-hook 'org-blocker-hook
5519 'org-block-todo-from-checkboxes)
5520 (remove-hook 'org-blocker-hook
5521 'org-block-todo-from-checkboxes))
5523 ;; Align options lines
5524 (org-set-local
5525 'align-mode-rules-list
5526 '((org-in-buffer-settings
5527 (regexp . "^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5528 (modes . '(org-mode)))))
5530 ;; Imenu
5531 (org-set-local 'imenu-create-index-function
5532 'org-imenu-get-tree)
5534 ;; Make isearch reveal context
5535 (if (or (featurep 'xemacs)
5536 (not (boundp 'outline-isearch-open-invisible-function)))
5537 ;; Emacs 21 and XEmacs make use of the hook
5538 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5539 ;; Emacs 22 deals with this through a special variable
5540 (org-set-local 'outline-isearch-open-invisible-function
5541 (lambda (&rest ignore) (org-show-context 'isearch))))
5543 ;; Setup the pcomplete hooks
5544 (set (make-local-variable 'pcomplete-command-completion-function)
5545 'org-pcomplete-initial)
5546 (set (make-local-variable 'pcomplete-command-name-function)
5547 'org-command-at-point)
5548 (set (make-local-variable 'pcomplete-default-completion-function)
5549 'ignore)
5550 (set (make-local-variable 'pcomplete-parse-arguments-function)
5551 'org-parse-arguments)
5552 (set (make-local-variable 'pcomplete-termination-string) "")
5553 (when (>= emacs-major-version 23)
5554 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5556 ;; If empty file that did not turn on org-mode automatically, make it to.
5557 (if (and org-insert-mode-line-in-empty-file
5558 (org-called-interactively-p 'any)
5559 (= (point-min) (point-max)))
5560 (insert "# -*- mode: org -*-\n\n"))
5561 (unless org-inhibit-startup
5562 (org-unmodified
5563 (and org-startup-with-beamer-mode (org-beamer-mode))
5564 (when org-startup-align-all-tables
5565 (org-table-map-tables 'org-table-align 'quietly))
5566 (when org-startup-with-inline-images
5567 (org-display-inline-images))
5568 (when org-startup-with-latex-preview
5569 (org-toggle-latex-fragment))
5570 (unless org-inhibit-startup-visibility-stuff
5571 (org-set-startup-visibility))
5572 (org-refresh-effort-properties)))
5573 ;; Try to set org-hide correctly
5574 (let ((foreground (org-find-invisible-foreground)))
5575 (if foreground
5576 (set-face-foreground 'org-hide foreground))))
5578 ;; Update `customize-package-emacs-version-alist'
5579 (add-to-list 'customize-package-emacs-version-alist
5580 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5581 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5582 ("8.2.6" . "24.4") ("8.3" . "25.1")))
5584 (defvar org-mode-transpose-word-syntax-table
5585 (let ((st (make-syntax-table text-mode-syntax-table)))
5586 (mapc (lambda(c) (modify-syntax-entry
5587 (string-to-char (car c)) "w p" st))
5588 org-emphasis-alist)
5589 st))
5591 (when (fboundp 'abbrev-table-put)
5592 (abbrev-table-put org-mode-abbrev-table
5593 :parents (list text-mode-abbrev-table)))
5595 (defun org-find-invisible-foreground ()
5596 (let ((candidates (remove
5597 "unspecified-bg"
5598 (nconc
5599 (list (face-background 'default)
5600 (face-background 'org-default))
5601 (mapcar
5602 (lambda (alist)
5603 (when (boundp alist)
5604 (cdr (assoc 'background-color (symbol-value alist)))))
5605 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5606 (list (face-foreground 'org-hide))))))
5607 (car (remove nil candidates))))
5609 (defun org-current-time (&optional rounding-minutes past)
5610 "Current time, possibly rounded to ROUNDING-MINUTES.
5611 When ROUNDING-MINUTES is not an integer, fall back on the car of
5612 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5613 the rounding returns a past time."
5614 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5615 (car org-time-stamp-rounding-minutes)))
5616 (time (decode-time)) res)
5617 (if (< r 1)
5618 (current-time)
5619 (setq res
5620 (apply 'encode-time
5621 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5622 (nthcdr 2 time))))
5623 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5624 (seconds-to-time (- (org-float-time res) (* r 60)))
5625 res))))
5627 (defun org-today ()
5628 "Return today date, considering `org-extend-today-until'."
5629 (time-to-days
5630 (time-subtract (current-time)
5631 (list 0 (* 3600 org-extend-today-until) 0))))
5633 ;;;; Font-Lock stuff, including the activators
5635 (defvar org-mouse-map (make-sparse-keymap))
5636 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5637 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5638 (when org-mouse-1-follows-link
5639 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5640 (when org-tab-follows-link
5641 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5642 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5644 (require 'font-lock)
5646 (defconst org-non-link-chars "]\t\n\r<>")
5647 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "file+emacs"
5648 "file+sys" "news" "shell" "elisp" "doi" "message"
5649 "help"))
5650 (defvar org-link-types-re nil
5651 "Matches a link that has a url-like prefix like \"http:\"")
5652 (defvar org-link-re-with-space nil
5653 "Matches a link with spaces, optional angular brackets around it.")
5654 (defvar org-link-re-with-space2 nil
5655 "Matches a link with spaces, optional angular brackets around it.")
5656 (defvar org-link-re-with-space3 nil
5657 "Matches a link with spaces, only for internal part in bracket links.")
5658 (defvar org-angle-link-re nil
5659 "Matches link with angular brackets, spaces are allowed.")
5660 (defvar org-plain-link-re nil
5661 "Matches plain link, without spaces.")
5662 (defvar org-bracket-link-regexp nil
5663 "Matches a link in double brackets.")
5664 (defvar org-bracket-link-analytic-regexp nil
5665 "Regular expression used to analyze links.
5666 Here is what the match groups contain after a match:
5667 1: http:
5668 2: http
5669 3: path
5670 4: [desc]
5671 5: desc")
5672 (defvar org-bracket-link-analytic-regexp++ nil
5673 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5674 (defvar org-any-link-re nil
5675 "Regular expression matching any link.")
5677 (defconst org-match-sexp-depth 3
5678 "Number of stacked braces for sub/superscript matching.")
5680 (defun org-create-multibrace-regexp (left right n)
5681 "Create a regular expression which will match a balanced sexp.
5682 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5683 as single character strings.
5684 The regexp returned will match the entire expression including the
5685 delimiters. It will also define a single group which contains the
5686 match except for the outermost delimiters. The maximum depth of
5687 stacked delimiters is N. Escaping delimiters is not possible."
5688 (let* ((nothing (concat "[^" left right "]*?"))
5689 (or "\\|")
5690 (re nothing)
5691 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5692 (while (> n 1)
5693 (setq n (1- n)
5694 re (concat re or next)
5695 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5696 (concat left "\\(" re "\\)" right)))
5698 (defconst org-match-substring-regexp
5699 (concat
5700 "\\(\\S-\\)\\([_^]\\)\\("
5701 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5702 "\\|"
5703 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5704 "\\|"
5705 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5706 "The regular expression matching a sub- or superscript.")
5708 (defconst org-match-substring-with-braces-regexp
5709 (concat
5710 "\\(\\S-\\)\\([_^]\\)"
5711 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5712 "The regular expression matching a sub- or superscript, forcing braces.")
5714 (defun org-make-link-regexps ()
5715 "Update the link regular expressions.
5716 This should be called after the variable `org-link-types' has changed."
5717 (let ((types-re (regexp-opt org-link-types t)))
5718 (setq org-link-types-re
5719 (concat "\\`" types-re ":")
5720 org-link-re-with-space
5721 (concat "<?" types-re ":"
5722 "\\([^" org-non-link-chars " ]"
5723 "[^" org-non-link-chars "]*"
5724 "[^" org-non-link-chars " ]\\)>?")
5725 org-link-re-with-space2
5726 (concat "<?" types-re ":"
5727 "\\([^" org-non-link-chars " ]"
5728 "[^\t\n\r]*"
5729 "[^" org-non-link-chars " ]\\)>?")
5730 org-link-re-with-space3
5731 (concat "<?" types-re ":"
5732 "\\([^" org-non-link-chars " ]"
5733 "[^\t\n\r]*\\)")
5734 org-angle-link-re
5735 (format "<%s:\\([^>\n]*\\(?:\n[ \t]*[^> \t\n][^>\n]*\\)*\\)>"
5736 types-re)
5737 org-plain-link-re
5738 (concat
5739 "\\<" types-re ":"
5740 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5741 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5742 org-bracket-link-regexp
5743 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5744 org-bracket-link-analytic-regexp
5745 (concat
5746 "\\[\\["
5747 "\\(" types-re ":\\)?"
5748 "\\([^]]+\\)"
5749 "\\]"
5750 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5751 "\\]")
5752 org-bracket-link-analytic-regexp++
5753 (concat
5754 "\\[\\["
5755 "\\(" (regexp-opt (cons "coderef" org-link-types) t) ":\\)?"
5756 "\\([^]]+\\)"
5757 "\\]"
5758 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5759 "\\]")
5760 org-any-link-re
5761 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5762 org-angle-link-re "\\)\\|\\("
5763 org-plain-link-re "\\)"))))
5765 (org-make-link-regexps)
5767 (defvar org-emph-face nil)
5769 (defun org-do-emphasis-faces (limit)
5770 "Run through the buffer and emphasize strings."
5771 (let (rtn a)
5772 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5773 (let* ((border (char-after (match-beginning 3)))
5774 (bre (regexp-quote (char-to-string border))))
5775 (if (and (not (= border (char-after (match-beginning 4))))
5776 (not (save-match-data
5777 (string-match (concat bre ".*" bre)
5778 (replace-regexp-in-string
5779 "\n" " "
5780 (substring (match-string 2) 1 -1))))))
5781 (progn
5782 (setq rtn t)
5783 (setq a (assoc (match-string 3) org-emphasis-alist))
5784 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5785 'face
5786 (nth 1 a))
5787 (and (nth 2 a)
5788 (org-remove-flyspell-overlays-in
5789 (match-beginning 0) (match-end 0)))
5790 (add-text-properties (match-beginning 2) (match-end 2)
5791 '(font-lock-multiline t org-emphasis t))
5792 (when org-hide-emphasis-markers
5793 (add-text-properties (match-end 4) (match-beginning 5)
5794 '(invisible org-link))
5795 (add-text-properties (match-beginning 3) (match-end 3)
5796 '(invisible org-link))))))
5797 (goto-char (1+ (match-beginning 0))))
5798 rtn))
5800 (defun org-emphasize (&optional char)
5801 "Insert or change an emphasis, i.e. a font like bold or italic.
5802 If there is an active region, change that region to a new emphasis.
5803 If there is no region, just insert the marker characters and position
5804 the cursor between them.
5805 CHAR should be the marker character. If it is a space, it means to
5806 remove the emphasis of the selected region.
5807 If CHAR is not given (for example in an interactive call) it will be
5808 prompted for."
5809 (interactive)
5810 (let ((erc org-emphasis-regexp-components)
5811 (prompt "")
5812 (string "") beg end move c s)
5813 (if (org-region-active-p)
5814 (setq beg (region-beginning) end (region-end)
5815 string (buffer-substring beg end))
5816 (setq move t))
5818 (unless char
5819 (message "Emphasis marker or tag: [%s]"
5820 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5821 (setq char (read-char-exclusive)))
5822 (if (equal char ?\ )
5823 (setq s "" move nil)
5824 (unless (assoc (char-to-string char) org-emphasis-alist)
5825 (user-error "No such emphasis marker: \"%c\"" char))
5826 (setq s (char-to-string char)))
5827 (while (and (> (length string) 1)
5828 (equal (substring string 0 1) (substring string -1))
5829 (assoc (substring string 0 1) org-emphasis-alist))
5830 (setq string (substring string 1 -1)))
5831 (setq string (concat s string s))
5832 (if beg (delete-region beg end))
5833 (unless (or (bolp)
5834 (string-match (concat "[" (nth 0 erc) "\n]")
5835 (char-to-string (char-before (point)))))
5836 (insert " "))
5837 (unless (or (eobp)
5838 (string-match (concat "[" (nth 1 erc) "\n]")
5839 (char-to-string (char-after (point)))))
5840 (insert " ") (backward-char 1))
5841 (insert string)
5842 (and move (backward-char 1))))
5844 (defconst org-nonsticky-props
5845 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5847 (defsubst org-rear-nonsticky-at (pos)
5848 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5850 (defun org-activate-plain-links (limit)
5851 "Add link properties for plain links."
5852 (let (f hl)
5853 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5854 (not (member 'org-tag
5855 (get-text-property (1- (match-beginning 0)) 'face)))
5856 (not (org-in-src-block-p)))
5857 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5858 (setq f (get-text-property (match-beginning 0) 'face))
5859 (setq hl (org-match-string-no-properties 0))
5860 (if (or (eq f 'org-tag)
5861 (and (listp f) (memq 'org-tag f)))
5863 (add-text-properties (match-beginning 0) (match-end 0)
5864 (list 'mouse-face 'highlight
5865 'face 'org-link
5866 'htmlize-link `(:uri ,hl)
5867 'keymap org-mouse-map))
5868 (org-rear-nonsticky-at (match-end 0)))
5869 t)))
5871 (defun org-activate-code (limit)
5872 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5873 (progn
5874 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5875 (remove-text-properties (match-beginning 0) (match-end 0)
5876 '(display t invisible t intangible t))
5877 t)))
5879 (defcustom org-src-fontify-natively t
5880 "When non-nil, fontify code in code blocks."
5881 :type 'boolean
5882 :version "24.4"
5883 :package-version '(Org . "8.3")
5884 :group 'org-appearance
5885 :group 'org-babel)
5887 (defcustom org-allow-promoting-top-level-subtree nil
5888 "When non-nil, allow promoting a top level subtree.
5889 The leading star of the top level headline will be replaced
5890 by a #."
5891 :type 'boolean
5892 :version "24.1"
5893 :group 'org-appearance)
5895 (defun org-fontify-meta-lines-and-blocks (limit)
5896 (condition-case nil
5897 (org-fontify-meta-lines-and-blocks-1 limit)
5898 (error (message "org-mode fontification error"))))
5900 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5901 "Fontify #+ lines and blocks."
5902 (let ((case-fold-search t))
5903 (if (re-search-forward
5904 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5905 limit t)
5906 (let ((beg (match-beginning 0))
5907 (block-start (match-end 0))
5908 (block-end nil)
5909 (lang (match-string 7))
5910 (beg1 (line-beginning-position 2))
5911 (dc1 (downcase (match-string 2)))
5912 (dc3 (downcase (match-string 3)))
5913 end end1 quoting block-type ovl)
5914 (cond
5915 ((and (match-end 4) (equal dc3 "+begin"))
5916 ;; Truly a block
5917 (setq block-type (downcase (match-string 5))
5918 quoting (member block-type org-protecting-blocks))
5919 (when (re-search-forward
5920 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5921 nil t) ;; on purpose, we look further than LIMIT
5922 (setq end (min (point-max) (match-end 0))
5923 end1 (min (point-max) (1- (match-beginning 0))))
5924 (setq block-end (match-beginning 0))
5925 (when quoting
5926 (org-remove-flyspell-overlays-in beg1 end1)
5927 (remove-text-properties beg end
5928 '(display t invisible t intangible t)))
5929 (add-text-properties
5930 beg end '(font-lock-fontified t font-lock-multiline t))
5931 (add-text-properties beg beg1 '(face org-meta-line))
5932 (org-remove-flyspell-overlays-in beg beg1)
5933 (add-text-properties ; For end_src
5934 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5935 (org-remove-flyspell-overlays-in end1 end)
5936 (cond
5937 ((and lang (not (string= lang "")) org-src-fontify-natively)
5938 (org-src-font-lock-fontify-block lang block-start block-end)
5939 (add-text-properties beg1 block-end '(src-block t)))
5940 (quoting
5941 (add-text-properties beg1 (min (point-max) (1+ end1))
5942 '(face org-block))) ; end of source block
5943 ((not org-fontify-quote-and-verse-blocks))
5944 ((string= block-type "quote")
5945 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5946 ((string= block-type "verse")
5947 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5948 (add-text-properties beg beg1 '(face org-block-begin-line))
5949 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5950 '(face org-block-end-line))
5952 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5953 (org-remove-flyspell-overlays-in
5954 (match-beginning 0)
5955 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5956 (add-text-properties
5957 beg (match-end 3)
5958 (if (member (intern (substring dc1 1 -1)) org-hidden-keywords)
5959 '(font-lock-fontified t invisible t)
5960 '(font-lock-fontified t face org-document-info-keyword)))
5961 (add-text-properties
5962 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5963 (if (string-equal dc1 "+title:")
5964 '(font-lock-fontified t face org-document-title)
5965 '(font-lock-fontified t face org-document-info))))
5966 ((equal dc1 "+caption:")
5967 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5968 (remove-text-properties (match-beginning 0) (match-end 0)
5969 '(display t invisible t intangible t))
5970 (add-text-properties (match-beginning 1) (match-end 3)
5971 '(font-lock-fontified t face org-meta-line))
5972 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5973 '(font-lock-fontified t face org-block))
5975 ((member dc3 '(" " ""))
5976 (org-remove-flyspell-overlays-in beg (match-end 0))
5977 (add-text-properties
5978 beg (match-end 0)
5979 '(font-lock-fontified t face font-lock-comment-face)))
5980 (t ;; just any other in-buffer setting, but not indented
5981 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5982 (remove-text-properties (match-beginning 0) (match-end 0)
5983 '(display t invisible t intangible t))
5984 (add-text-properties beg (match-end 0)
5985 '(font-lock-fontified t face org-meta-line))
5986 t))))))
5988 (defun org-fontify-drawers (limit)
5989 "Fontify drawers."
5990 (when (re-search-forward org-drawer-regexp limit t)
5991 (add-text-properties
5992 (match-beginning 0) (match-end 0)
5993 '(font-lock-fontified t face org-special-keyword))
5994 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5997 (defun org-fontify-macros (limit)
5998 "Fontify macros."
5999 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
6000 (add-text-properties
6001 (match-beginning 0) (match-end 0)
6002 '(font-lock-fontified t face org-macro))
6003 (when org-hide-macro-markers
6004 (add-text-properties (match-end 2) (match-beginning 2)
6005 '(invisible t))
6006 (add-text-properties (match-beginning 1) (match-end 1)
6007 '(invisible t)))
6008 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6011 (defun org-activate-angle-links (limit)
6012 "Add text properties for angle links."
6013 (if (and (re-search-forward org-angle-link-re limit t)
6014 (not (org-in-src-block-p)))
6015 (progn
6016 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6017 (add-text-properties (match-beginning 0) (match-end 0)
6018 (list 'mouse-face 'highlight
6019 'keymap org-mouse-map
6020 'font-lock-multiline t))
6021 (org-rear-nonsticky-at (match-end 0))
6022 t)))
6024 (defun org-activate-footnote-links (limit)
6025 "Add text properties for footnotes."
6026 (let ((fn (org-footnote-next-reference-or-definition limit)))
6027 (when fn
6028 (let* ((beg (nth 1 fn))
6029 (end (nth 2 fn))
6030 (label (car fn))
6031 (referencep (/= (line-beginning-position) beg)))
6032 (when (and referencep (nth 3 fn))
6033 (save-excursion
6034 (goto-char beg)
6035 (search-forward (or label "fn:"))
6036 (org-remove-flyspell-overlays-in beg (match-end 0))))
6037 (add-text-properties beg end
6038 (list 'mouse-face 'highlight
6039 'keymap org-mouse-map
6040 'help-echo
6041 (if referencep "Footnote reference"
6042 "Footnote definition")
6043 'font-lock-fontified t
6044 'font-lock-multiline t
6045 'face 'org-footnote))))))
6047 (defun org-activate-bracket-links (limit)
6048 "Add text properties for bracketed links."
6049 (if (and (re-search-forward org-bracket-link-regexp limit t)
6050 (not (org-in-src-block-p)))
6051 (let* ((hl (org-match-string-no-properties 1))
6052 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6053 (ip (org-maybe-intangible
6054 (list 'invisible 'org-link
6055 'keymap org-mouse-map 'mouse-face 'highlight
6056 'font-lock-multiline t 'help-echo help
6057 'htmlize-link `(:uri ,hl))))
6058 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6059 'font-lock-multiline t 'help-echo help
6060 'htmlize-link `(:uri ,hl))))
6061 ;; We need to remove the invisible property here. Table narrowing
6062 ;; may have made some of this invisible.
6063 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6064 (remove-text-properties (match-beginning 0) (match-end 0)
6065 '(invisible nil))
6066 (if (match-end 3)
6067 (progn
6068 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6069 (org-rear-nonsticky-at (match-beginning 3))
6070 (add-text-properties (match-beginning 3) (match-end 3) vp)
6071 (org-rear-nonsticky-at (match-end 3))
6072 (add-text-properties (match-end 3) (match-end 0) ip)
6073 (org-rear-nonsticky-at (match-end 0)))
6074 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6075 (org-rear-nonsticky-at (match-beginning 1))
6076 (add-text-properties (match-beginning 1) (match-end 1) vp)
6077 (org-rear-nonsticky-at (match-end 1))
6078 (add-text-properties (match-end 1) (match-end 0) ip)
6079 (org-rear-nonsticky-at (match-end 0)))
6080 t)))
6082 (defun org-activate-dates (limit)
6083 "Add text properties for dates."
6084 (if (and (re-search-forward org-tsr-regexp-both limit t)
6085 (not (equal (char-before (match-beginning 0)) 91)))
6086 (progn
6087 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6088 (add-text-properties (match-beginning 0) (match-end 0)
6089 (list 'mouse-face 'highlight
6090 'keymap org-mouse-map))
6091 (org-rear-nonsticky-at (match-end 0))
6092 (when org-display-custom-times
6093 (if (match-end 3)
6094 (org-display-custom-time (match-beginning 3) (match-end 3)))
6095 (org-display-custom-time (match-beginning 1) (match-end 1)))
6096 t)))
6098 (defvar org-target-link-regexp nil
6099 "Regular expression matching radio targets in plain text.")
6100 (make-variable-buffer-local 'org-target-link-regexp)
6102 (defconst org-target-regexp (let ((border "[^<>\n\r \t]"))
6103 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6104 border border border))
6105 "Regular expression matching a link target.")
6107 (defconst org-radio-target-regexp (format "<%s>" org-target-regexp)
6108 "Regular expression matching a radio target.")
6110 (defconst org-any-target-regexp
6111 (format "%s\\|%s" org-radio-target-regexp org-target-regexp)
6112 "Regular expression matching any target.")
6114 (defun org-activate-target-links (limit)
6115 "Add text properties for target matches."
6116 (when org-target-link-regexp
6117 (let ((case-fold-search t))
6118 (if (re-search-forward org-target-link-regexp limit t)
6119 (progn
6120 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6121 (add-text-properties (match-beginning 1) (match-end 1)
6122 (list 'mouse-face 'highlight
6123 'keymap org-mouse-map
6124 'help-echo "Radio target link"
6125 'org-linked-text t))
6126 (org-rear-nonsticky-at (match-end 1))
6127 t)))))
6129 (defun org-update-radio-target-regexp ()
6130 "Find all radio targets in this file and update the regular expression.
6131 Also refresh fontification if needed."
6132 (interactive)
6133 (let ((old-regexp org-target-link-regexp)
6134 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6135 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6136 (targets
6137 (org-with-wide-buffer
6138 (goto-char (point-min))
6139 (let (rtn)
6140 (while (re-search-forward org-radio-target-regexp nil t)
6141 ;; Make sure point is really within the object.
6142 (backward-char)
6143 (let ((obj (org-element-context)))
6144 (when (eq (org-element-type obj) 'radio-target)
6145 (add-to-list 'rtn (org-element-property :value obj)))))
6146 rtn))))
6147 (setq org-target-link-regexp
6148 (and targets
6149 (concat before-re
6150 (mapconcat
6151 (lambda (x)
6152 (replace-regexp-in-string
6153 " +" "\\s-+" (regexp-quote x) t t))
6154 targets
6155 "\\|")
6156 after-re)))
6157 (unless (equal old-regexp org-target-link-regexp)
6158 ;; Clean-up cache.
6159 (let ((regexp (cond ((not old-regexp) org-target-link-regexp)
6160 ((not org-target-link-regexp) old-regexp)
6162 (concat before-re
6163 (mapconcat
6164 (lambda (re)
6165 (substring re (length before-re)
6166 (- (length after-re))))
6167 (list old-regexp org-target-link-regexp)
6168 "\\|")
6169 after-re)))))
6170 (org-with-wide-buffer
6171 (goto-char (point-min))
6172 (while (re-search-forward regexp nil t)
6173 (org-element-cache-refresh (match-beginning 1)))))
6174 ;; Re fontify buffer.
6175 (when (memq 'radio org-highlight-links)
6176 (org-restart-font-lock)))))
6178 (defun org-hide-wide-columns (limit)
6179 (let (s e)
6180 (setq s (text-property-any (point) (or limit (point-max))
6181 'org-cwidth t))
6182 (when s
6183 (setq e (next-single-property-change s 'org-cwidth))
6184 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6185 (goto-char e)
6186 t)))
6188 (defvar org-latex-and-related-regexp nil
6189 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6191 (defun org-compute-latex-and-related-regexp ()
6192 "Compute regular expression for LaTeX, entities and sub/superscript.
6193 Result depends on variable `org-highlight-latex-and-related'."
6194 (org-set-local
6195 'org-latex-and-related-regexp
6196 (let* ((re-sub
6197 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6198 ((eq org-use-sub-superscripts '{})
6199 (list org-match-substring-with-braces-regexp))
6200 (org-use-sub-superscripts (list org-match-substring-regexp))))
6201 (re-latex
6202 (when (memq 'latex org-highlight-latex-and-related)
6203 (let ((matchers (plist-get org-format-latex-options :matchers)))
6204 (delq nil
6205 (mapcar (lambda (x)
6206 (and (member (car x) matchers) (nth 1 x)))
6207 org-latex-regexps)))))
6208 (re-entities
6209 (when (memq 'entities org-highlight-latex-and-related)
6210 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6211 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6213 (defun org-do-latex-and-related (limit)
6214 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6215 LIMIT bounds the search for syntax to highlight. Stop at first
6216 highlighted object, if any. Return t if some highlighting was
6217 done, nil otherwise."
6218 (when (org-string-nw-p org-latex-and-related-regexp)
6219 (catch 'found
6220 (while (re-search-forward org-latex-and-related-regexp limit t)
6221 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6222 'face))
6223 '(org-code org-verbatim underline))
6224 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6225 '(?_ ?^))
6227 0)))
6228 (font-lock-prepend-text-property
6229 (+ offset (match-beginning 0)) (match-end 0)
6230 'face 'org-latex-and-related)
6231 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6232 '(font-lock-multiline t)))
6233 (throw 'found t)))
6234 nil)))
6236 (defun org-restart-font-lock ()
6237 "Restart `font-lock-mode', to force refontification."
6238 (when (and (boundp 'font-lock-mode) font-lock-mode)
6239 (font-lock-mode -1)
6240 (font-lock-mode 1)))
6242 (defun org-activate-tags (limit)
6243 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6244 (progn
6245 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6246 (add-text-properties (match-beginning 1) (match-end 1)
6247 (list 'mouse-face 'highlight
6248 'keymap org-mouse-map))
6249 (org-rear-nonsticky-at (match-end 1))
6250 t)))
6252 (defun org-outline-level ()
6253 "Compute the outline level of the heading at point.
6255 If this is called at a normal headline, the level is the number
6256 of stars. Use `org-reduced-level' to remove the effect of
6257 `org-odd-levels'. Unlike to `org-current-level', this function
6258 takes into consideration inlinetasks."
6259 (org-with-wide-buffer
6260 (end-of-line)
6261 (if (re-search-backward org-outline-regexp-bol nil t)
6262 (1- (- (match-end 0) (match-beginning 0)))
6263 0)))
6265 (defvar org-font-lock-keywords nil)
6267 (defsubst org-re-property (property &optional literal allow-null value)
6268 "Return a regexp matching a PROPERTY line.
6270 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6271 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6272 non-nil, match properties even without a value.
6274 Match group 3 is set to the value when it exists. If there is no
6275 value and ALLOW-NULL is non-nil, it is set to the empty string.
6277 With optional argument VALUE, match only property lines with
6278 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6279 unless LITERAL is non-nil."
6280 (concat
6281 "^\\(?4:[ \t]*\\)"
6282 (format "\\(?1::\\(?2:%s\\):\\)"
6283 (if literal property (regexp-quote property)))
6284 (cond (value
6285 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6286 (if literal value (regexp-quote value))))
6287 (allow-null
6288 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6290 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6292 (defconst org-property-re
6293 (org-re-property "\\S-+" 'literal t)
6294 "Regular expression matching a property line.
6295 There are four matching groups:
6296 1: :PROPKEY: including the leading and trailing colon,
6297 2: PROPKEY without the leading and trailing colon,
6298 3: PROPVAL without leading or trailing spaces,
6299 4: the indentation of the current line,
6300 5: trailing whitespace.")
6302 (defvar org-font-lock-hook nil
6303 "Functions to be called for special font lock stuff.")
6305 (defvar org-font-lock-set-keywords-hook nil
6306 "Functions that can manipulate `org-font-lock-extra-keywords'.
6307 This is called after `org-font-lock-extra-keywords' is defined, but before
6308 it is installed to be used by font lock. This can be useful if something
6309 needs to be inserted at a specific position in the font-lock sequence.")
6311 (defun org-font-lock-hook (limit)
6312 "Run `org-font-lock-hook' within LIMIT."
6313 (run-hook-with-args 'org-font-lock-hook limit))
6315 (defun org-set-font-lock-defaults ()
6316 "Set font lock defaults for the current buffer."
6317 (let* ((em org-fontify-emphasized-text)
6318 (lk org-highlight-links)
6319 (org-font-lock-extra-keywords
6320 (list
6321 ;; Call the hook
6322 '(org-font-lock-hook)
6323 ;; Headlines
6324 `(,(if org-fontify-whole-heading-line
6325 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6326 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6327 (1 (org-get-level-face 1))
6328 (2 (org-get-level-face 2))
6329 (3 (org-get-level-face 3)))
6330 ;; Table lines
6331 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6332 (1 'org-table t))
6333 ;; Table internals
6334 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6335 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6336 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6337 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6338 ;; Drawers
6339 '(org-fontify-drawers)
6340 ;; Properties
6341 (list org-property-re
6342 '(1 'org-special-keyword t)
6343 '(3 'org-property-value t))
6344 ;; Links
6345 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6346 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6347 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6348 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6349 (if (memq 'radio lk) '(org-activate-target-links (1 'org-link t)))
6350 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6351 (if (memq 'footnote lk) '(org-activate-footnote-links))
6352 ;; Targets.
6353 (list org-any-target-regexp '(0 'org-target t))
6354 ;; Diary sexps.
6355 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6356 ;; Macro
6357 '(org-fontify-macros)
6358 '(org-hide-wide-columns (0 nil append))
6359 ;; TODO keyword
6360 (list (format org-heading-keyword-regexp-format
6361 org-todo-regexp)
6362 '(2 (org-get-todo-face 2) t))
6363 ;; DONE
6364 (if org-fontify-done-headline
6365 (list (format org-heading-keyword-regexp-format
6366 (concat
6367 "\\(?:"
6368 (mapconcat 'regexp-quote org-done-keywords "\\|")
6369 "\\)"))
6370 '(2 'org-headline-done t))
6371 nil)
6372 ;; Priorities
6373 '(org-font-lock-add-priority-faces)
6374 ;; Tags
6375 '(org-font-lock-add-tag-faces)
6376 ;; Tags groups
6377 (if (and org-group-tags org-tag-groups-alist)
6378 (list (concat org-outline-regexp-bol ".+\\(:"
6379 (regexp-opt (mapcar 'car org-tag-groups-alist))
6380 ":\\).*$")
6381 '(1 'org-tag-group prepend)))
6382 ;; Special keywords
6383 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6384 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6385 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6386 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6387 ;; Emphasis
6388 (if em
6389 (if (featurep 'xemacs)
6390 '(org-do-emphasis-faces (0 nil append))
6391 '(org-do-emphasis-faces)))
6392 ;; Checkboxes
6393 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6394 1 'org-checkbox prepend)
6395 (if (cdr (assq 'checkbox org-list-automatic-rules))
6396 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6397 (0 (org-get-checkbox-statistics-face) t)))
6398 ;; Description list items
6399 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6400 1 'org-list-dt prepend)
6401 ;; ARCHIVEd headings
6402 (list (concat
6403 org-outline-regexp-bol
6404 "\\(.*:" org-archive-tag ":.*\\)")
6405 '(1 'org-archived prepend))
6406 ;; Specials
6407 '(org-do-latex-and-related)
6408 '(org-fontify-entities)
6409 '(org-raise-scripts)
6410 ;; Code
6411 '(org-activate-code (1 'org-code t))
6412 ;; COMMENT
6413 (list (format
6414 "^\\*+\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6415 org-todo-regexp
6416 org-comment-string)
6417 '(9 'org-special-keyword t))
6418 ;; Blocks and meta lines
6419 '(org-fontify-meta-lines-and-blocks))))
6420 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6421 (run-hooks 'org-font-lock-set-keywords-hook)
6422 ;; Now set the full font-lock-keywords
6423 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6424 (org-set-local 'font-lock-defaults
6425 '(org-font-lock-keywords t nil nil backward-paragraph))
6426 (kill-local-variable 'font-lock-keywords) nil))
6428 (defun org-toggle-pretty-entities ()
6429 "Toggle the composition display of entities as UTF8 characters."
6430 (interactive)
6431 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6432 (org-restart-font-lock)
6433 (if org-pretty-entities
6434 (message "Entities are now displayed as UTF8 characters")
6435 (save-restriction
6436 (widen)
6437 (org-decompose-region (point-min) (point-max))
6438 (message "Entities are now displayed as plain text"))))
6440 (defvar org-custom-properties-overlays nil
6441 "List of overlays used for custom properties.")
6442 (make-variable-buffer-local 'org-custom-properties-overlays)
6444 (defun org-toggle-custom-properties-visibility ()
6445 "Display or hide properties in `org-custom-properties'."
6446 (interactive)
6447 (if org-custom-properties-overlays
6448 (progn (mapc #'delete-overlay org-custom-properties-overlays)
6449 (setq org-custom-properties-overlays nil))
6450 (when org-custom-properties
6451 (org-with-wide-buffer
6452 (goto-char (point-min))
6453 (let ((regexp (org-re-property (regexp-opt org-custom-properties) t t)))
6454 (while (re-search-forward regexp nil t)
6455 (let ((end (cdr (save-match-data (org-get-property-block)))))
6456 (when (and end (< (point) end))
6457 ;; Hide first custom property in current drawer.
6458 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6459 (overlay-put o 'invisible t)
6460 (overlay-put o 'org-custom-property t)
6461 (push o org-custom-properties-overlays))
6462 ;; Hide additional custom properties in the same drawer.
6463 (while (re-search-forward regexp end t)
6464 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6465 (overlay-put o 'invisible t)
6466 (overlay-put o 'org-custom-property t)
6467 (push o org-custom-properties-overlays)))))
6468 ;; Each entry is limited to a single property drawer.
6469 (outline-next-heading)))))))
6471 (defun org-fontify-entities (limit)
6472 "Find an entity to fontify."
6473 (let (ee)
6474 (when org-pretty-entities
6475 (catch 'match
6476 ;; "\_ "-family is left out on purpose. Only the first one,
6477 ;; i.e., "\_ ", could be fontified anyway, and it would be
6478 ;; confusing when adding a second white space character.
6479 (while (re-search-forward
6480 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6481 limit t)
6482 (if (and (not (org-at-comment-p))
6483 (setq ee (org-entity-get (match-string 1)))
6484 (= (length (nth 6 ee)) 1))
6485 (let*
6486 ((end (if (equal (match-string 2) "{}")
6487 (match-end 2)
6488 (match-end 1))))
6489 (add-text-properties
6490 (match-beginning 0) end
6491 (list 'font-lock-fontified t))
6492 (compose-region (match-beginning 0) end
6493 (nth 6 ee) nil)
6494 (backward-char 1)
6495 (throw 'match t))))
6496 nil))))
6498 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6499 "Fontify string S like in Org-mode."
6500 (with-temp-buffer
6501 (insert s)
6502 (let ((org-odd-levels-only odd-levels))
6503 (org-mode)
6504 (font-lock-ensure)
6505 (buffer-string))))
6507 (defvar org-m nil)
6508 (defvar org-l nil)
6509 (defvar org-f nil)
6510 (defun org-get-level-face (n)
6511 "Get the right face for match N in font-lock matching of headlines."
6512 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6513 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6514 (if org-cycle-level-faces
6515 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6516 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6517 (cond
6518 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6519 ((eq n 2) org-f)
6520 (t (if org-level-color-stars-only nil org-f))))
6522 (defun org-face-from-face-or-color (context inherit face-or-color)
6523 "Create a face list that inherits INHERIT, but sets the foreground color.
6524 When FACE-OR-COLOR is not a string, just return it."
6525 (if (stringp face-or-color)
6526 (list :inherit inherit
6527 (cdr (assoc context org-faces-easy-properties))
6528 face-or-color)
6529 face-or-color))
6531 (defun org-get-todo-face (kwd)
6532 "Get the right face for a TODO keyword KWD.
6533 If KWD is a number, get the corresponding match group."
6534 (if (numberp kwd) (setq kwd (match-string kwd)))
6535 (or (org-face-from-face-or-color
6536 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6537 (and (member kwd org-done-keywords) 'org-done)
6538 'org-todo))
6540 (defun org-get-priority-face (priority)
6541 "Get the right face for PRIORITY.
6542 PRIORITY is a character."
6543 (or (org-face-from-face-or-color
6544 'priority 'org-priority (cdr (assq priority org-priority-faces)))
6545 'org-priority))
6547 (defun org-get-tag-face (tag)
6548 "Get the right face for TAG.
6549 If TAG is a number, get the corresponding match group."
6550 (let ((tag (if (wholenump tag) (match-string tag) tag)))
6551 (or (org-face-from-face-or-color
6552 'tag 'org-tag (cdr (assoc tag org-tag-faces)))
6553 'org-tag)))
6555 (defun org-font-lock-add-priority-faces (limit)
6556 "Add the special priority faces."
6557 (while (re-search-forward "^\\*+ .*?\\(\\[#\\(.\\)\\]\\)" limit t)
6558 (add-text-properties
6559 (match-beginning 1) (match-end 1)
6560 (list 'face (org-get-priority-face (string-to-char (match-string 2)))
6561 'font-lock-fontified t))))
6563 (defun org-font-lock-add-tag-faces (limit)
6564 "Add the special tag faces."
6565 (when (and org-tag-faces org-tags-special-faces-re)
6566 (while (re-search-forward org-tags-special-faces-re limit t)
6567 (add-text-properties (match-beginning 1) (match-end 1)
6568 (list 'face (org-get-tag-face 1)
6569 'font-lock-fontified t))
6570 (backward-char 1))))
6572 (defun org-unfontify-region (beg end &optional maybe_loudly)
6573 "Remove fontification and activation overlays from links."
6574 (font-lock-default-unfontify-region beg end)
6575 (let* ((buffer-undo-list t)
6576 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6577 (inhibit-modification-hooks t)
6578 deactivate-mark buffer-file-name buffer-file-truename)
6579 (org-decompose-region beg end)
6580 (remove-text-properties beg end
6581 '(mouse-face t keymap t org-linked-text t
6582 invisible t intangible t
6583 org-emphasis t))
6584 (org-remove-font-lock-display-properties beg end)))
6586 (defconst org-script-display '(((raise -0.3) (height 0.7))
6587 ((raise 0.3) (height 0.7))
6588 ((raise -0.5))
6589 ((raise 0.5)))
6590 "Display properties for showing superscripts and subscripts.")
6592 (defun org-remove-font-lock-display-properties (beg end)
6593 "Remove specific display properties that have been added by font lock.
6594 The will remove the raise properties that are used to show superscripts
6595 and subscripts."
6596 (let (next prop)
6597 (while (< beg end)
6598 (setq next (next-single-property-change beg 'display nil end)
6599 prop (get-text-property beg 'display))
6600 (if (member prop org-script-display)
6601 (put-text-property beg next 'display nil))
6602 (setq beg next))))
6604 (defun org-raise-scripts (limit)
6605 "Add raise properties to sub/superscripts."
6606 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6607 (if (re-search-forward
6608 (if (eq org-use-sub-superscripts t)
6609 org-match-substring-regexp
6610 org-match-substring-with-braces-regexp)
6611 limit t)
6612 (let* ((pos (point)) table-p comment-p
6613 (mpos (match-beginning 3))
6614 (emph-p (get-text-property mpos 'org-emphasis))
6615 (link-p (get-text-property mpos 'mouse-face))
6616 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6617 (goto-char (point-at-bol))
6618 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6619 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6620 (goto-char pos)
6621 ;; Handle a_b^c
6622 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6623 (if (or comment-p emph-p link-p keyw-p)
6625 (put-text-property (match-beginning 3) (match-end 0)
6626 'display
6627 (if (equal (char-after (match-beginning 2)) ?^)
6628 (nth (if table-p 3 1) org-script-display)
6629 (nth (if table-p 2 0) org-script-display)))
6630 (add-text-properties (match-beginning 2) (match-end 2)
6631 (list 'invisible t
6632 'org-dwidth t 'org-dwidth-n 1))
6633 (if (and (eq (char-after (match-beginning 3)) ?{)
6634 (eq (char-before (match-end 3)) ?}))
6635 (progn
6636 (add-text-properties
6637 (match-beginning 3) (1+ (match-beginning 3))
6638 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6639 (add-text-properties
6640 (1- (match-end 3)) (match-end 3)
6641 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6642 t)))))
6644 ;;;; Visibility cycling, including org-goto and indirect buffer
6646 ;;; Cycling
6648 (defvar org-cycle-global-status nil)
6649 (make-variable-buffer-local 'org-cycle-global-status)
6650 (put 'org-cycle-global-status 'org-state t)
6651 (defvar org-cycle-subtree-status nil)
6652 (make-variable-buffer-local 'org-cycle-subtree-status)
6653 (put 'org-cycle-subtree-status 'org-state t)
6655 (defvar org-inlinetask-min-level)
6657 (defun org-unlogged-message (&rest args)
6658 "Display a message, but avoid logging it in the *Messages* buffer."
6659 (let ((message-log-max nil))
6660 (apply 'message args)))
6662 ;;;###autoload
6663 (defun org-cycle (&optional arg)
6664 "TAB-action and visibility cycling for Org-mode.
6666 This is the command invoked in Org-mode by the TAB key. Its main purpose
6667 is outline visibility cycling, but it also invokes other actions
6668 in special contexts.
6670 - When this function is called with a prefix argument, rotate the entire
6671 buffer through 3 states (global cycling)
6672 1. OVERVIEW: Show only top-level headlines.
6673 2. CONTENTS: Show all headlines of all levels, but no body text.
6674 3. SHOW ALL: Show everything.
6675 With a double \\[universal-argument] prefix argument, \
6676 switch to the startup visibility,
6677 determined by the variable `org-startup-folded', and by any VISIBILITY
6678 properties in the buffer.
6679 With a triple \\[universal-argument] prefix argument, \
6680 show the entire buffer, including any drawers.
6682 - When inside a table, re-align the table and move to the next field.
6684 - When point is at the beginning of a headline, rotate the subtree started
6685 by this line through 3 different states (local cycling)
6686 1. FOLDED: Only the main headline is shown.
6687 2. CHILDREN: The main headline and the direct children are shown.
6688 From this state, you can move to one of the children
6689 and zoom in further.
6690 3. SUBTREE: Show the entire subtree, including body text.
6691 If there is no subtree, switch directly from CHILDREN to FOLDED.
6693 - When point is at the beginning of an empty headline and the variable
6694 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6695 of the headline by demoting and promoting it to likely levels. This
6696 speeds up creation document structure by pressing TAB once or several
6697 times right after creating a new headline.
6699 - When there is a numeric prefix, go up to a heading with level ARG, do
6700 a `show-subtree' and return to the previous cursor position. If ARG
6701 is negative, go up that many levels.
6703 - When point is not at the beginning of a headline, execute the global
6704 binding for TAB, which is re-indenting the line. See the option
6705 `org-cycle-emulate-tab' for details.
6707 - Special case: if point is at the beginning of the buffer and there is
6708 no headline in line 1, this function will act as if called with prefix arg
6709 (\\[universal-argument] TAB, same as S-TAB) also when called without prefix arg.
6710 But only if also the variable `org-cycle-global-at-bob' is t."
6711 (interactive "P")
6712 (org-load-modules-maybe)
6713 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6714 (and org-cycle-level-after-item/entry-creation
6715 (or (org-cycle-level)
6716 (org-cycle-item-indentation))))
6717 (let* ((limit-level
6718 (or org-cycle-max-level
6719 (and (boundp 'org-inlinetask-min-level)
6720 org-inlinetask-min-level
6721 (1- org-inlinetask-min-level))))
6722 (nstars (and limit-level
6723 (if org-odd-levels-only
6724 (and limit-level (1- (* limit-level 2)))
6725 limit-level)))
6726 (org-outline-regexp
6727 (if (not (derived-mode-p 'org-mode))
6728 outline-regexp
6729 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6730 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6731 (not (looking-at org-outline-regexp))))
6732 (org-cycle-hook
6733 (if bob-special
6734 (delq 'org-optimize-window-after-visibility-change
6735 (copy-sequence org-cycle-hook))
6736 org-cycle-hook))
6737 (pos (point)))
6739 (if (or bob-special (equal arg '(4)))
6740 ;; special case: use global cycling
6741 (setq arg t))
6743 (cond
6745 ((equal arg '(16))
6746 (setq last-command 'dummy)
6747 (org-set-startup-visibility)
6748 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6750 ((equal arg '(64))
6751 (outline-show-all)
6752 (org-unlogged-message "Entire buffer visible, including drawers"))
6754 ;; Try cdlatex TAB completion
6755 ((org-try-cdlatex-tab))
6757 ;; Table: enter it or move to the next field.
6758 ((org-at-table-p 'any)
6759 (if (org-at-table.el-p)
6760 (message "%s" (substitute-command-keys "\\<org-mode-map>\
6761 Use \\[org-edit-special] to edit table.el tables"))
6762 (if arg (org-table-edit-field t)
6763 (org-table-justify-field-maybe)
6764 (call-interactively 'org-table-next-field))))
6766 ((run-hook-with-args-until-success
6767 'org-tab-after-check-for-table-hook))
6769 ;; Global cycling: delegate to `org-cycle-internal-global'.
6770 ((eq arg t) (org-cycle-internal-global))
6772 ;; Drawers: delegate to `org-flag-drawer'.
6773 ((save-excursion
6774 (beginning-of-line 1)
6775 (looking-at org-drawer-regexp))
6776 (org-flag-drawer ; toggle block visibility
6777 (not (get-char-property (match-end 0) 'invisible))))
6779 ;; Show-subtree, ARG levels up from here.
6780 ((integerp arg)
6781 (save-excursion
6782 (org-back-to-heading)
6783 (outline-up-heading (if (< arg 0) (- arg)
6784 (- (funcall outline-level) arg)))
6785 (org-show-subtree)))
6787 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6788 ((and (featurep 'org-inlinetask)
6789 (org-inlinetask-at-task-p)
6790 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6791 (org-inlinetask-toggle-visibility))
6793 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6794 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6795 (save-excursion (move-beginning-of-line 1)
6796 (looking-at org-outline-regexp)))
6797 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6798 (org-cycle-internal-local))
6800 ;; From there: TAB emulation and template completion.
6801 (buffer-read-only (org-back-to-heading))
6803 ((run-hook-with-args-until-success
6804 'org-tab-after-check-for-cycling-hook))
6806 ((org-try-structure-completion))
6808 ((run-hook-with-args-until-success
6809 'org-tab-before-tab-emulation-hook))
6811 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6812 (or (not (bolp))
6813 (not (looking-at org-outline-regexp))))
6814 (call-interactively (global-key-binding "\t")))
6816 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6817 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6818 (or (and (eq org-cycle-emulate-tab 'white)
6819 (= (match-end 0) (point-at-eol)))
6820 (and (eq org-cycle-emulate-tab 'whitestart)
6821 (>= (match-end 0) pos))))
6823 (eq org-cycle-emulate-tab t))
6824 (call-interactively (global-key-binding "\t")))
6826 (t (save-excursion
6827 (org-back-to-heading)
6828 (org-cycle)))))))
6830 (defun org-cycle-internal-global ()
6831 "Do the global cycling action."
6832 ;; Hack to avoid display of messages for .org attachments in Gnus
6833 (let ((ga (string-match "\\*fontification" (buffer-name))))
6834 (cond
6835 ((and (eq last-command this-command)
6836 (eq org-cycle-global-status 'overview))
6837 ;; We just created the overview - now do table of contents
6838 ;; This can be slow in very large buffers, so indicate action
6839 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6840 (unless ga (org-unlogged-message "CONTENTS..."))
6841 (org-content)
6842 (unless ga (org-unlogged-message "CONTENTS...done"))
6843 (setq org-cycle-global-status 'contents)
6844 (run-hook-with-args 'org-cycle-hook 'contents))
6846 ((and (eq last-command this-command)
6847 (eq org-cycle-global-status 'contents))
6848 ;; We just showed the table of contents - now show everything
6849 (run-hook-with-args 'org-pre-cycle-hook 'all)
6850 (outline-show-all)
6851 (unless ga (org-unlogged-message "SHOW ALL"))
6852 (setq org-cycle-global-status 'all)
6853 (run-hook-with-args 'org-cycle-hook 'all))
6856 ;; Default action: go to overview
6857 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6858 (org-overview)
6859 (unless ga (org-unlogged-message "OVERVIEW"))
6860 (setq org-cycle-global-status 'overview)
6861 (run-hook-with-args 'org-cycle-hook 'overview)))))
6863 (defvar org-called-with-limited-levels nil
6864 "Non-nil when `org-with-limited-levels' is currently active.")
6866 (defun org-cycle-internal-local ()
6867 "Do the local cycling action."
6868 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6869 ;; First, determine end of headline (EOH), end of subtree or item
6870 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6871 (save-excursion
6872 (if (org-at-item-p)
6873 (progn
6874 (beginning-of-line)
6875 (setq struct (org-list-struct))
6876 (setq eoh (point-at-eol))
6877 (setq eos (org-list-get-item-end-before-blank (point) struct))
6878 (setq has-children (org-list-has-child-p (point) struct)))
6879 (org-back-to-heading)
6880 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6881 (setq eos (save-excursion (org-end-of-subtree t t)
6882 (when (bolp) (backward-char)) (point)))
6883 (setq has-children
6884 (or (save-excursion
6885 (let ((level (funcall outline-level)))
6886 (outline-next-heading)
6887 (and (org-at-heading-p t)
6888 (> (funcall outline-level) level))))
6889 (save-excursion
6890 (org-list-search-forward (org-item-beginning-re) eos t)))))
6891 ;; Determine end invisible part of buffer (EOL)
6892 (beginning-of-line 2)
6893 ;; XEmacs doesn't have `next-single-char-property-change'
6894 (if (featurep 'xemacs)
6895 (while (and (not (eobp)) ;; this is like `next-line'
6896 (get-char-property (1- (point)) 'invisible))
6897 (beginning-of-line 2))
6898 (while (and (not (eobp)) ;; this is like `next-line'
6899 (get-char-property (1- (point)) 'invisible))
6900 (goto-char (next-single-char-property-change (point) 'invisible))
6901 (and (eolp) (beginning-of-line 2))))
6902 (setq eol (point)))
6903 ;; Find out what to do next and set `this-command'
6904 (cond
6905 ((= eos eoh)
6906 ;; Nothing is hidden behind this heading
6907 (unless (org-before-first-heading-p)
6908 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6909 (org-unlogged-message "EMPTY ENTRY")
6910 (setq org-cycle-subtree-status nil)
6911 (save-excursion
6912 (goto-char eos)
6913 (outline-next-heading)
6914 (if (outline-invisible-p) (org-flag-heading nil))))
6915 ((and (or (>= eol eos)
6916 (not (string-match "\\S-" (buffer-substring eol eos))))
6917 (or has-children
6918 (not (setq children-skipped
6919 org-cycle-skip-children-state-if-no-children))))
6920 ;; Entire subtree is hidden in one line: children view
6921 (unless (org-before-first-heading-p)
6922 (run-hook-with-args 'org-pre-cycle-hook 'children))
6923 (if (org-at-item-p)
6924 (org-list-set-item-visibility (point-at-bol) struct 'children)
6925 (org-show-entry)
6926 (org-with-limited-levels (outline-show-children))
6927 ;; FIXME: This slows down the func way too much.
6928 ;; How keep drawers hidden in subtree anyway?
6929 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6930 ;; (org-cycle-hide-drawers 'subtree))
6932 ;; Fold every list in subtree to top-level items.
6933 (when (eq org-cycle-include-plain-lists 'integrate)
6934 (save-excursion
6935 (org-back-to-heading)
6936 (while (org-list-search-forward (org-item-beginning-re) eos t)
6937 (beginning-of-line 1)
6938 (let* ((struct (org-list-struct))
6939 (prevs (org-list-prevs-alist struct))
6940 (end (org-list-get-bottom-point struct)))
6941 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6942 (org-list-get-all-items (point) struct prevs))
6943 (goto-char (if (< end eos) end eos)))))))
6944 (org-unlogged-message "CHILDREN")
6945 (save-excursion
6946 (goto-char eos)
6947 (outline-next-heading)
6948 (if (outline-invisible-p) (org-flag-heading nil)))
6949 (setq org-cycle-subtree-status 'children)
6950 (unless (org-before-first-heading-p)
6951 (run-hook-with-args 'org-cycle-hook 'children)))
6952 ((or children-skipped
6953 (and (eq last-command this-command)
6954 (eq org-cycle-subtree-status 'children)))
6955 ;; We just showed the children, or no children are there,
6956 ;; now show everything.
6957 (unless (org-before-first-heading-p)
6958 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6959 (outline-flag-region eoh eos nil)
6960 (org-unlogged-message
6961 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6962 (setq org-cycle-subtree-status 'subtree)
6963 (unless (org-before-first-heading-p)
6964 (run-hook-with-args 'org-cycle-hook 'subtree)))
6966 ;; Default action: hide the subtree.
6967 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6968 (outline-flag-region eoh eos t)
6969 (org-unlogged-message "FOLDED")
6970 (setq org-cycle-subtree-status 'folded)
6971 (unless (org-before-first-heading-p)
6972 (run-hook-with-args 'org-cycle-hook 'folded))))))
6974 ;;;###autoload
6975 (defun org-global-cycle (&optional arg)
6976 "Cycle the global visibility. For details see `org-cycle'.
6977 With \\[universal-argument] prefix arg, switch to startup visibility.
6978 With a numeric prefix, show all headlines up to that level."
6979 (interactive "P")
6980 (let ((org-cycle-include-plain-lists
6981 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6982 (cond
6983 ((integerp arg)
6984 (outline-show-all)
6985 (outline-hide-sublevels arg)
6986 (setq org-cycle-global-status 'contents))
6987 ((equal arg '(4))
6988 (org-set-startup-visibility)
6989 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6991 (org-cycle '(4))))))
6993 (defun org-set-startup-visibility ()
6994 "Set the visibility required by startup options and properties."
6995 (cond
6996 ((eq org-startup-folded t)
6997 (org-overview))
6998 ((eq org-startup-folded 'content)
6999 (org-content))
7000 ((or (eq org-startup-folded 'showeverything)
7001 (eq org-startup-folded nil))
7002 (outline-show-all)))
7003 (unless (eq org-startup-folded 'showeverything)
7004 (if org-hide-block-startup (org-hide-block-all))
7005 (org-set-visibility-according-to-property 'no-cleanup)
7006 (org-cycle-hide-archived-subtrees 'all)
7007 (org-cycle-hide-drawers 'all)
7008 (org-cycle-show-empty-lines t)))
7010 (defun org-set-visibility-according-to-property (&optional no-cleanup)
7011 "Switch subtree visibilities according to :VISIBILITY: property."
7012 (interactive)
7013 (let (org-show-entry-below)
7014 (org-with-wide-buffer
7015 (goto-char (point-min))
7016 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t)
7017 (if (not (org-at-property-p)) (outline-next-heading)
7018 (let ((state (match-string 3)))
7019 (save-excursion
7020 (org-back-to-heading t)
7021 (outline-hide-subtree)
7022 (org-reveal)
7023 (cond
7024 ((equal state "folded")
7025 (outline-hide-subtree))
7026 ((equal state "children")
7027 (org-show-hidden-entry)
7028 (outline-show-children))
7029 ((equal state "content")
7030 (save-excursion
7031 (save-restriction
7032 (org-narrow-to-subtree)
7033 (org-content))))
7034 ((member state '("all" "showall"))
7035 (outline-show-subtree)))))))
7036 (unless no-cleanup
7037 (org-cycle-hide-archived-subtrees 'all)
7038 (org-cycle-hide-drawers 'all)
7039 (org-cycle-show-empty-lines 'all)))))
7041 ;; This function uses outline-regexp instead of the more fundamental
7042 ;; org-outline-regexp so that org-cycle-global works outside of Org
7043 ;; buffers, where outline-regexp is needed.
7044 (defun org-overview ()
7045 "Switch to overview mode, showing only top-level headlines.
7046 This shows all headlines with a level equal or greater than the level
7047 of the first headline in the buffer. This is important, because if the
7048 first headline is not level one, then (hide-sublevels 1) gives confusing
7049 results."
7050 (interactive)
7051 (save-excursion
7052 (let ((level
7053 (save-excursion
7054 (goto-char (point-min))
7055 (if (re-search-forward (concat "^" outline-regexp) nil t)
7056 (progn
7057 (goto-char (match-beginning 0))
7058 (funcall outline-level))))))
7059 (and level (outline-hide-sublevels level)))))
7061 (defun org-content (&optional arg)
7062 "Show all headlines in the buffer, like a table of contents.
7063 With numerical argument N, show content up to level N."
7064 (interactive "P")
7065 (org-overview)
7066 (save-excursion
7067 ;; Visit all headings and show their offspring
7068 (and (integerp arg) (org-overview))
7069 (goto-char (point-max))
7070 (catch 'exit
7071 (while (and (progn (condition-case nil
7072 (outline-previous-visible-heading 1)
7073 (error (goto-char (point-min))))
7075 (looking-at org-outline-regexp))
7076 (if (integerp arg)
7077 (outline-show-children (1- arg))
7078 (outline-show-branches))
7079 (if (bobp) (throw 'exit nil))))))
7081 (defun org-optimize-window-after-visibility-change (state)
7082 "Adjust the window after a change in outline visibility.
7083 This function is the default value of the hook `org-cycle-hook'."
7084 (when (get-buffer-window (current-buffer))
7085 (cond
7086 ((eq state 'content) nil)
7087 ((eq state 'all) nil)
7088 ((eq state 'folded) nil)
7089 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7090 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7092 (defun org-remove-empty-overlays-at (pos)
7093 "Remove outline overlays that do not contain non-white stuff."
7094 (mapc
7095 (lambda (o)
7096 (and (eq 'outline (overlay-get o 'invisible))
7097 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7098 (overlay-end o))))
7099 (delete-overlay o)))
7100 (overlays-at pos)))
7102 (defun org-clean-visibility-after-subtree-move ()
7103 "Fix visibility issues after moving a subtree."
7104 ;; First, find a reasonable region to look at:
7105 ;; Start two siblings above, end three below
7106 (let* ((beg (save-excursion
7107 (and (org-get-last-sibling)
7108 (org-get-last-sibling))
7109 (point)))
7110 (end (save-excursion
7111 (and (org-get-next-sibling)
7112 (org-get-next-sibling)
7113 (org-get-next-sibling))
7114 (if (org-at-heading-p)
7115 (point-at-eol)
7116 (point))))
7117 (level (looking-at "\\*+"))
7118 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7119 (save-excursion
7120 (save-restriction
7121 (narrow-to-region beg end)
7122 (when re
7123 ;; Properly fold already folded siblings
7124 (goto-char (point-min))
7125 (while (re-search-forward re nil t)
7126 (if (and (not (outline-invisible-p))
7127 (save-excursion
7128 (goto-char (point-at-eol)) (outline-invisible-p)))
7129 (outline-hide-entry))))
7130 (org-cycle-show-empty-lines 'overview)
7131 (org-cycle-hide-drawers 'overview)))))
7133 (defun org-cycle-show-empty-lines (state)
7134 "Show empty lines above all visible headlines.
7135 The region to be covered depends on STATE when called through
7136 `org-cycle-hook'. Lisp program can use t for STATE to get the
7137 entire buffer covered. Note that an empty line is only shown if there
7138 are at least `org-cycle-separator-lines' empty lines before the headline."
7139 (when (/= org-cycle-separator-lines 0)
7140 (save-excursion
7141 (let* ((n (abs org-cycle-separator-lines))
7142 (re (cond
7143 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7144 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7145 (t (let ((ns (number-to-string (- n 2))))
7146 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7147 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7148 beg end)
7149 (cond
7150 ((memq state '(overview contents t))
7151 (setq beg (point-min) end (point-max)))
7152 ((memq state '(children folded))
7153 (setq beg (point)
7154 end (progn (org-end-of-subtree t t)
7155 (line-beginning-position 2)))))
7156 (when beg
7157 (goto-char beg)
7158 (while (re-search-forward re end t)
7159 (unless (get-char-property (match-end 1) 'invisible)
7160 (let ((e (match-end 1))
7161 (b (if (>= org-cycle-separator-lines 0)
7162 (match-beginning 1)
7163 (save-excursion
7164 (goto-char (match-beginning 0))
7165 (skip-chars-backward " \t\n")
7166 (line-end-position)))))
7167 (outline-flag-region b e nil))))))))
7168 ;; Never hide empty lines at the end of the file.
7169 (save-excursion
7170 (goto-char (point-max))
7171 (outline-previous-heading)
7172 (outline-end-of-heading)
7173 (if (and (looking-at "[ \t\n]+")
7174 (= (match-end 0) (point-max)))
7175 (outline-flag-region (point) (match-end 0) nil))))
7177 (defun org-show-empty-lines-in-parent ()
7178 "Move to the parent and re-show empty lines before visible headlines."
7179 (save-excursion
7180 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7181 (org-cycle-show-empty-lines context))))
7183 (defun org-files-list ()
7184 "Return `org-agenda-files' list, plus all open org-mode files.
7185 This is useful for operations that need to scan all of a user's
7186 open and agenda-wise Org files."
7187 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7188 (dolist (buf (buffer-list))
7189 (with-current-buffer buf
7190 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7191 (let ((file (expand-file-name (buffer-file-name))))
7192 (unless (member file files)
7193 (push file files))))))
7194 files))
7196 (defsubst org-entry-beginning-position ()
7197 "Return the beginning position of the current entry."
7198 (save-excursion (outline-back-to-heading t) (point)))
7200 (defsubst org-entry-end-position ()
7201 "Return the end position of the current entry."
7202 (save-excursion (outline-next-heading) (point)))
7204 (defun org-cycle-hide-drawers (state &optional exceptions)
7205 "Re-hide all drawers after a visibility state change.
7206 When non-nil, optional argument EXCEPTIONS is a list of strings
7207 specifying which drawers should not be hidden."
7208 (when (and (derived-mode-p 'org-mode)
7209 (not (memq state '(overview folded contents))))
7210 (save-excursion
7211 (let* ((globalp (memq state '(contents all)))
7212 (beg (if globalp (point-min) (point)))
7213 (end (if globalp (point-max)
7214 (if (eq state 'children)
7215 (save-excursion (outline-next-heading) (point))
7216 (org-end-of-subtree t)))))
7217 (goto-char beg)
7218 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7219 (unless (member-ignore-case (match-string 1) exceptions)
7220 (let ((drawer (org-element-at-point)))
7221 (when (memq (org-element-type drawer) '(drawer property-drawer))
7222 (org-flag-drawer t drawer)
7223 ;; Make sure to skip drawer entirely or we might flag
7224 ;; it another time when matching its ending line with
7225 ;; `org-drawer-regexp'.
7226 (goto-char (org-element-property :end drawer))))))))))
7228 (defun org-flag-drawer (flag &optional element)
7229 "When FLAG is non-nil, hide the drawer we are at.
7230 Otherwise make it visible. When optional argument ELEMENT is
7231 a parsed drawer, as returned by `org-element-at-point', hide or
7232 show that drawer instead."
7233 (when (save-excursion
7234 (beginning-of-line)
7235 (org-looking-at-p org-drawer-regexp))
7236 (let ((drawer (or element (org-element-at-point))))
7237 (when (memq (org-element-type drawer) '(drawer property-drawer))
7238 (let ((post (org-element-property :post-affiliated drawer)))
7239 (save-excursion
7240 (outline-flag-region
7241 (progn (goto-char post) (line-end-position))
7242 (progn (goto-char (org-element-property :end drawer))
7243 (skip-chars-backward " \r\t\n")
7244 (line-end-position))
7245 flag))
7246 ;; When the drawer is hidden away, make sure point lies in
7247 ;; a visible part of the buffer.
7248 (when (and flag (> (line-beginning-position) post))
7249 (goto-char post)))))))
7251 (defun org-subtree-end-visible-p ()
7252 "Is the end of the current subtree visible?"
7253 (pos-visible-in-window-p
7254 (save-excursion (org-end-of-subtree t) (point))))
7256 (defun org-first-headline-recenter ()
7257 "Move cursor to the first headline and recenter the headline."
7258 (goto-char (point-min))
7259 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7260 (set-window-start (selected-window) (point-at-bol))))
7262 ;;; Saving and restoring visibility
7264 (defun org-outline-overlay-data (&optional use-markers)
7265 "Return a list of the locations of all outline overlays.
7266 These are overlays with the `invisible' property value `outline'.
7267 The return value is a list of cons cells, with start and stop
7268 positions for each overlay.
7269 If USE-MARKERS is set, return the positions as markers."
7270 (let (beg end)
7271 (save-excursion
7272 (save-restriction
7273 (widen)
7274 (delq nil
7275 (mapcar (lambda (o)
7276 (when (eq (overlay-get o 'invisible) 'outline)
7277 (setq beg (overlay-start o)
7278 end (overlay-end o))
7279 (and beg end (> end beg)
7280 (if use-markers
7281 (cons (copy-marker beg)
7282 (copy-marker end t))
7283 (cons beg end)))))
7284 (overlays-in (point-min) (point-max))))))))
7286 (defun org-set-outline-overlay-data (data)
7287 "Create visibility overlays for all positions in DATA.
7288 DATA should have been made by `org-outline-overlay-data'."
7289 (let (o)
7290 (save-excursion
7291 (save-restriction
7292 (widen)
7293 (outline-show-all)
7294 (mapc (lambda (c)
7295 (outline-flag-region (car c) (cdr c) t))
7296 data)))))
7298 ;;; Folding of blocks
7300 (defvar org-hide-block-overlays nil
7301 "Overlays hiding blocks.")
7302 (make-variable-buffer-local 'org-hide-block-overlays)
7304 (defun org-block-map (function &optional start end)
7305 "Call FUNCTION at the head of all source blocks in the current buffer.
7306 Optional arguments START and END can be used to limit the range."
7307 (let ((start (or start (point-min)))
7308 (end (or end (point-max))))
7309 (save-excursion
7310 (goto-char start)
7311 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7312 (save-excursion
7313 (save-match-data
7314 (goto-char (match-beginning 0))
7315 (funcall function)))))))
7317 (defun org-hide-block-toggle-all ()
7318 "Toggle the visibility of all blocks in the current buffer."
7319 (org-block-map 'org-hide-block-toggle))
7321 (defun org-hide-block-all ()
7322 "Fold all blocks in the current buffer."
7323 (interactive)
7324 (org-show-block-all)
7325 (org-block-map 'org-hide-block-toggle-maybe))
7327 (defun org-show-block-all ()
7328 "Unfold all blocks in the current buffer."
7329 (interactive)
7330 (mapc 'delete-overlay org-hide-block-overlays)
7331 (setq org-hide-block-overlays nil))
7333 (defun org-hide-block-toggle-maybe ()
7334 "Toggle visibility of block at point.
7335 Unlike to `org-hide-block-toggle', this function does not throw
7336 an error. Return a non-nil value when toggling is successful."
7337 (interactive)
7338 (ignore-errors (org-hide-block-toggle)))
7340 (defun org-hide-block-toggle (&optional force)
7341 "Toggle the visibility of the current block.
7342 When optional argument FORCE is `off', make block visible. If it
7343 is non-nil, hide it unconditionally. Throw an error when not at
7344 a block. Return a non-nil value when toggling is successful."
7345 (interactive)
7346 (let ((element (org-element-at-point)))
7347 (unless (memq (org-element-type element)
7348 '(center-block comment-block dynamic-block example-block
7349 export-block quote-block special-block
7350 src-block verse-block))
7351 (user-error "Not at a block"))
7352 (let* ((start (save-excursion
7353 (goto-char (org-element-property :post-affiliated element))
7354 (line-end-position)))
7355 (end (save-excursion
7356 (goto-char (org-element-property :end element))
7357 (skip-chars-backward " \r\t\n")
7358 (line-end-position)))
7359 (overlays (overlays-at start)))
7360 (cond
7361 ;; Do nothing when not before or at the block opening line or
7362 ;; at the block closing line.
7363 ((let ((eol (line-end-position))) (and (> eol start) (/= eol end))) nil)
7364 ((and (not (eq force 'off))
7365 (not (memq t (mapcar
7366 (lambda (o)
7367 (eq (overlay-get o 'invisible) 'org-hide-block))
7368 overlays))))
7369 (let ((ov (make-overlay start end)))
7370 (overlay-put ov 'invisible 'org-hide-block)
7371 ;; Make the block accessible to `isearch'.
7372 (overlay-put
7373 ov 'isearch-open-invisible
7374 (lambda (ov)
7375 (when (memq ov org-hide-block-overlays)
7376 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7377 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7378 (delete-overlay ov))))
7379 (push ov org-hide-block-overlays)
7380 ;; When the block is hidden away, make sure point is left in
7381 ;; a visible part of the buffer.
7382 (when (> (line-beginning-position) start)
7383 (goto-char start)
7384 (beginning-of-line))
7385 ;; Signal successful toggling.
7387 ((or (not force) (eq force 'off))
7388 (dolist (ov overlays t)
7389 (when (memq ov org-hide-block-overlays)
7390 (setq org-hide-block-overlays (delq ov org-hide-block-overlays)))
7391 (when (eq (overlay-get ov 'invisible) 'org-hide-block)
7392 (delete-overlay ov))))))))
7394 ;; org-tab-after-check-for-cycling-hook
7395 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7396 ;; Remove overlays when changing major mode
7397 (add-hook 'org-mode-hook
7398 (lambda () (org-add-hook 'change-major-mode-hook
7399 'org-show-block-all 'append 'local)))
7401 ;;; Org-goto
7403 (defvar org-goto-window-configuration nil)
7404 (defvar org-goto-marker nil)
7405 (defvar org-goto-map)
7406 (defun org-goto-map ()
7407 "Set the keymap `org-goto'."
7408 (setq org-goto-map
7409 (let ((map (make-sparse-keymap)))
7410 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7411 mouse-drag-region universal-argument org-occur)))
7412 (dolist (cmd cmds)
7413 (substitute-key-definition cmd cmd map global-map)))
7414 (suppress-keymap map)
7415 (org-defkey map "\C-m" 'org-goto-ret)
7416 (org-defkey map [(return)] 'org-goto-ret)
7417 (org-defkey map [(left)] 'org-goto-left)
7418 (org-defkey map [(right)] 'org-goto-right)
7419 (org-defkey map [(control ?g)] 'org-goto-quit)
7420 (org-defkey map "\C-i" 'org-cycle)
7421 (org-defkey map [(tab)] 'org-cycle)
7422 (org-defkey map [(down)] 'outline-next-visible-heading)
7423 (org-defkey map [(up)] 'outline-previous-visible-heading)
7424 (if org-goto-auto-isearch
7425 (if (fboundp 'define-key-after)
7426 (define-key-after map [t] 'org-goto-local-auto-isearch)
7427 nil)
7428 (org-defkey map "q" 'org-goto-quit)
7429 (org-defkey map "n" 'outline-next-visible-heading)
7430 (org-defkey map "p" 'outline-previous-visible-heading)
7431 (org-defkey map "f" 'outline-forward-same-level)
7432 (org-defkey map "b" 'outline-backward-same-level)
7433 (org-defkey map "u" 'outline-up-heading))
7434 (org-defkey map "/" 'org-occur)
7435 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7436 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7437 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7438 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7439 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7440 map)))
7442 (defconst org-goto-help
7443 "Browse buffer copy, to find location or copy text.%s
7444 RET=jump to location C-g=quit and return to previous location
7445 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7447 (defvar org-goto-start-pos) ; dynamically scoped parameter
7449 (defun org-goto (&optional alternative-interface)
7450 "Look up a different location in the current file, keeping current visibility.
7452 When you want look-up or go to a different location in a
7453 document, the fastest way is often to fold the entire buffer and
7454 then dive into the tree. This method has the disadvantage, that
7455 the previous location will be folded, which may not be what you
7456 want.
7458 This command works around this by showing a copy of the current
7459 buffer in an indirect buffer, in overview mode. You can dive
7460 into the tree in that copy, use org-occur and incremental search
7461 to find a location. When pressing RET or `Q', the command
7462 returns to the original buffer in which the visibility is still
7463 unchanged. After RET it will also jump to the location selected
7464 in the indirect buffer and expose the headline hierarchy above.
7466 With a prefix argument, use the alternative interface: e.g. if
7467 `org-goto-interface' is 'outline use 'outline-path-completion."
7468 (interactive "P")
7469 (org-goto-map)
7470 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7471 (org-refile-use-outline-path t)
7472 (org-refile-target-verify-function nil)
7473 (interface
7474 (if (not alternative-interface)
7475 org-goto-interface
7476 (if (eq org-goto-interface 'outline)
7477 'outline-path-completion
7478 'outline)))
7479 (org-goto-start-pos (point))
7480 (selected-point
7481 (if (eq interface 'outline)
7482 (car (org-get-location (current-buffer) org-goto-help))
7483 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7484 (org-refile-check-position pa)
7485 (nth 3 pa)))))
7486 (if selected-point
7487 (progn
7488 (org-mark-ring-push org-goto-start-pos)
7489 (goto-char selected-point)
7490 (if (or (outline-invisible-p) (org-invisible-p2))
7491 (org-show-context 'org-goto)))
7492 (message "Quit"))))
7494 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7495 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7496 (defvar org-goto-local-auto-isearch-map) ; defined below
7498 (defun org-get-location (buf help)
7499 "Let the user select a location in the Org-mode buffer BUF.
7500 This function uses a recursive edit. It returns the selected position
7501 or nil."
7502 (org-no-popups
7503 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7504 (isearch-hide-immediately nil)
7505 (isearch-search-fun-function
7506 (lambda () 'org-goto-local-search-headings))
7507 (org-goto-selected-point org-goto-exit-command))
7508 (save-excursion
7509 (save-window-excursion
7510 (delete-other-windows)
7511 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7512 (org-pop-to-buffer-same-window
7513 (condition-case nil
7514 (make-indirect-buffer (current-buffer) "*org-goto*")
7515 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7516 (with-output-to-temp-buffer "*Org Help*"
7517 (princ (format help (if org-goto-auto-isearch
7518 " Just type for auto-isearch."
7519 " n/p/f/b/u to navigate, q to quit."))))
7520 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7521 (setq buffer-read-only nil)
7522 (let ((org-startup-truncated t)
7523 (org-startup-folded nil)
7524 (org-startup-align-all-tables nil))
7525 (org-mode)
7526 (org-overview))
7527 (setq buffer-read-only t)
7528 (if (and (boundp 'org-goto-start-pos)
7529 (integer-or-marker-p org-goto-start-pos))
7530 (progn (goto-char org-goto-start-pos)
7531 (when (outline-invisible-p)
7532 (org-show-set-visibility 'lineage)))
7533 (goto-char (point-min)))
7534 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7535 (message "Select location and press RET")
7536 (use-local-map org-goto-map)
7537 (recursive-edit)))
7538 (kill-buffer "*org-goto*")
7539 (cons org-goto-selected-point org-goto-exit-command))))
7541 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7542 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7543 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7544 (if (fboundp 'isearch-other-control-char)
7545 (progn
7546 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7547 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7548 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7549 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7550 (define-key org-goto-local-auto-isearch-map [return] nil))
7552 (defun org-goto-local-search-headings (string bound noerror)
7553 "Search and make sure that any matches are in headlines."
7554 (catch 'return
7555 (while (if isearch-forward
7556 (search-forward string bound noerror)
7557 (search-backward string bound noerror))
7558 (when (save-match-data
7559 (and (save-excursion
7560 (beginning-of-line)
7561 (looking-at org-complex-heading-regexp))
7562 (or (not (match-beginning 5))
7563 (< (point) (match-beginning 5)))))
7564 (throw 'return (point))))))
7566 (defun org-goto-local-auto-isearch ()
7567 "Start isearch."
7568 (interactive)
7569 (goto-char (point-min))
7570 (let ((keys (this-command-keys)))
7571 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7572 (isearch-mode t)
7573 (isearch-process-search-char (string-to-char keys)))))
7575 (defun org-goto-ret (&optional arg)
7576 "Finish `org-goto' by going to the new location."
7577 (interactive "P")
7578 (setq org-goto-selected-point (point)
7579 org-goto-exit-command 'return)
7580 (throw 'exit nil))
7582 (defun org-goto-left ()
7583 "Finish `org-goto' by going to the new location."
7584 (interactive)
7585 (if (org-at-heading-p)
7586 (progn
7587 (beginning-of-line 1)
7588 (setq org-goto-selected-point (point)
7589 org-goto-exit-command 'left)
7590 (throw 'exit nil))
7591 (user-error "Not on a heading")))
7593 (defun org-goto-right ()
7594 "Finish `org-goto' by going to the new location."
7595 (interactive)
7596 (if (org-at-heading-p)
7597 (progn
7598 (setq org-goto-selected-point (point)
7599 org-goto-exit-command 'right)
7600 (throw 'exit nil))
7601 (user-error "Not on a heading")))
7603 (defun org-goto-quit ()
7604 "Finish `org-goto' without cursor motion."
7605 (interactive)
7606 (setq org-goto-selected-point nil)
7607 (setq org-goto-exit-command 'quit)
7608 (throw 'exit nil))
7610 ;;; Indirect buffer display of subtrees
7612 (defvar org-indirect-dedicated-frame nil
7613 "This is the frame being used for indirect tree display.")
7614 (defvar org-last-indirect-buffer nil)
7616 (defun org-tree-to-indirect-buffer (&optional arg)
7617 "Create indirect buffer and narrow it to current subtree.
7618 With a numerical prefix ARG, go up to this level and then take that tree.
7619 If ARG is negative, go up that many levels.
7621 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7622 indirect buffer previously made with this command, to avoid proliferation of
7623 indirect buffers. However, when you call the command with a \
7624 \\[universal-argument] prefix, or
7625 when `org-indirect-buffer-display' is `new-frame', the last buffer
7626 is kept so that you can work with several indirect buffers at the same time.
7627 If `org-indirect-buffer-display' is `dedicated-frame', the \
7628 \\[universal-argument] prefix also
7629 requests that a new frame be made for the new buffer, so that the dedicated
7630 frame is not changed."
7631 (interactive "P")
7632 (let ((cbuf (current-buffer))
7633 (cwin (selected-window))
7634 (pos (point))
7635 beg end level heading ibuf)
7636 (save-excursion
7637 (org-back-to-heading t)
7638 (when (numberp arg)
7639 (setq level (org-outline-level))
7640 (if (< arg 0) (setq arg (+ level arg)))
7641 (while (> (setq level (org-outline-level)) arg)
7642 (org-up-heading-safe)))
7643 (setq beg (point)
7644 heading (org-get-heading))
7645 (org-end-of-subtree t t)
7646 (if (org-at-heading-p) (backward-char 1))
7647 (setq end (point)))
7648 (if (and (buffer-live-p org-last-indirect-buffer)
7649 (not (eq org-indirect-buffer-display 'new-frame))
7650 (not arg))
7651 (kill-buffer org-last-indirect-buffer))
7652 (setq ibuf (org-get-indirect-buffer cbuf heading)
7653 org-last-indirect-buffer ibuf)
7654 (cond
7655 ((or (eq org-indirect-buffer-display 'new-frame)
7656 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7657 (select-frame (make-frame))
7658 (delete-other-windows)
7659 (org-pop-to-buffer-same-window ibuf)
7660 (org-set-frame-title heading))
7661 ((eq org-indirect-buffer-display 'dedicated-frame)
7662 (raise-frame
7663 (select-frame (or (and org-indirect-dedicated-frame
7664 (frame-live-p org-indirect-dedicated-frame)
7665 org-indirect-dedicated-frame)
7666 (setq org-indirect-dedicated-frame (make-frame)))))
7667 (delete-other-windows)
7668 (org-pop-to-buffer-same-window ibuf)
7669 (org-set-frame-title (concat "Indirect: " heading)))
7670 ((eq org-indirect-buffer-display 'current-window)
7671 (org-pop-to-buffer-same-window ibuf))
7672 ((eq org-indirect-buffer-display 'other-window)
7673 (pop-to-buffer ibuf))
7674 (t (error "Invalid value")))
7675 (if (featurep 'xemacs)
7676 (save-excursion (org-mode) (turn-on-font-lock)))
7677 (narrow-to-region beg end)
7678 (outline-show-all)
7679 (goto-char pos)
7680 (run-hook-with-args 'org-cycle-hook 'all)
7681 (and (window-live-p cwin) (select-window cwin))))
7683 (defun org-get-indirect-buffer (&optional buffer heading)
7684 (setq buffer (or buffer (current-buffer)))
7685 (let ((n 1) (base (buffer-name buffer)) bname)
7686 (while (buffer-live-p
7687 (get-buffer
7688 (setq bname
7689 (concat base "-"
7690 (if heading (concat heading "-" (number-to-string n))
7691 (number-to-string n))))))
7692 (setq n (1+ n)))
7693 (condition-case nil
7694 (make-indirect-buffer buffer bname 'clone)
7695 (error (make-indirect-buffer buffer bname)))))
7697 (defun org-set-frame-title (title)
7698 "Set the title of the current frame to the string TITLE."
7699 ;; FIXME: how to name a single frame in XEmacs???
7700 (unless (featurep 'xemacs)
7701 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7703 ;;;; Structure editing
7705 ;;; Inserting headlines
7707 (defun org-previous-line-empty-p (&optional next)
7708 "Is the previous line a blank line?
7709 When NEXT is non-nil, check the next line instead."
7710 (save-excursion
7711 (and (not (bobp))
7712 (or (beginning-of-line (if next 2 0)) t)
7713 (save-match-data
7714 (looking-at "[ \t]*$")))))
7716 (defun org-insert-heading (&optional arg invisible-ok top-level)
7717 "Insert a new heading or an item with the same depth at point.
7719 If point is at the beginning of a heading or a list item, insert
7720 a new heading or a new item above the current one. If point is
7721 at the beginning of a normal line, turn the line into a heading.
7723 If point is in the middle of a headline or a list item, split the
7724 headline or the item and create a new headline/item with the text
7725 in the current line after point \(see `org-M-RET-may-split-line'
7726 on how to modify this behavior).
7728 With one universal prefix argument, set the user option
7729 `org-insert-heading-respect-content' to t for the duration of
7730 the command. This modifies the behavior described above in this
7731 ways: on list items and at the beginning of normal lines, force
7732 the insertion of a heading after the current subtree.
7734 With two universal prefix arguments, insert the heading at the
7735 end of the grandparent subtree. For example, if point is within
7736 a 2nd-level heading, then it will insert a 2nd-level heading at
7737 the end of the 1st-level parent heading.
7739 If point is at the beginning of a headline, insert a sibling
7740 before the current headline. If point is not at the beginning,
7741 split the line and create a new headline with the text in the
7742 current line after point \(see `org-M-RET-may-split-line' on how
7743 to modify this behavior).
7745 If point is at the beginning of a normal line, turn this line
7746 into a heading.
7748 When INVISIBLE-OK is set, stop at invisible headlines when going
7749 back. This is important for non-interactive uses of the
7750 command.
7752 When optional argument TOP-LEVEL is non-nil, insert a level 1
7753 heading, unconditionally."
7754 (interactive "P")
7755 (if (org-called-interactively-p 'any) (org-reveal))
7756 (let ((itemp (and (not top-level) (org-in-item-p)))
7757 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7758 (respect-content (or org-insert-heading-respect-content
7759 (equal arg '(4))))
7760 (initial-content ""))
7762 (cond
7764 ((or (= (buffer-size) 0)
7765 (and (not (save-excursion
7766 (and (ignore-errors (org-back-to-heading invisible-ok))
7767 (org-at-heading-p))))
7768 (or arg (not itemp))))
7769 ;; At beginning of buffer or so high up that only a heading
7770 ;; makes sense.
7771 (cond ((and (bolp) (not respect-content)) (insert "* "))
7772 ((not respect-content)
7773 (unless may-split (end-of-line))
7774 (insert "\n* "))
7775 ((re-search-forward org-outline-regexp-bol nil t)
7776 (beginning-of-line)
7777 (insert "* \n")
7778 (backward-char))
7779 (t (goto-char (point-max))
7780 (insert "\n* ")))
7781 (run-hooks 'org-insert-heading-hook))
7783 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7786 ;; Maybe move at the end of the subtree
7787 (when (equal arg '(16))
7788 (org-up-heading-safe)
7789 (org-end-of-subtree t))
7790 ;; Insert a heading
7791 (save-restriction
7792 (widen)
7793 (let* ((level nil)
7794 (on-heading (org-at-heading-p))
7795 (empty-line-p (if on-heading
7796 (org-previous-line-empty-p)
7797 ;; We will decide later
7798 nil))
7799 ;; Get a level string to fall back on.
7800 (fix-level
7801 (if (org-before-first-heading-p) "*"
7802 (save-excursion
7803 (org-back-to-heading t)
7804 (if (org-previous-line-empty-p) (setq empty-line-p t))
7805 (looking-at org-outline-regexp)
7806 (make-string (1- (length (match-string 0))) ?*))))
7807 (stars
7808 (save-excursion
7809 (condition-case nil
7810 (if top-level "* "
7811 (org-back-to-heading invisible-ok)
7812 (when (and (not on-heading)
7813 (featurep 'org-inlinetask)
7814 (integerp org-inlinetask-min-level)
7815 (>= (length (match-string 0))
7816 org-inlinetask-min-level))
7817 ;; Find a heading level before the inline
7818 ;; task.
7819 (while (and (setq level (org-up-heading-safe))
7820 (>= level org-inlinetask-min-level)))
7821 (if (org-at-heading-p)
7822 (org-back-to-heading invisible-ok)
7823 (error "This should not happen")))
7824 (unless (and (save-excursion
7825 (save-match-data
7826 (org-backward-heading-same-level
7827 1 invisible-ok))
7828 (= (point) (match-beginning 0)))
7829 (not (org-previous-line-empty-p t)))
7830 (setq empty-line-p (or empty-line-p
7831 (org-previous-line-empty-p))))
7832 (match-string 0))
7833 (error (or fix-level "* ")))))
7834 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7835 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7836 pos hide-previous previous-pos)
7838 ;; If we insert after content, move there and clean up
7839 ;; whitespace.
7840 (when (and respect-content
7841 (not (org-looking-at-p org-outline-regexp-bol)))
7842 (if (not (org-before-first-heading-p))
7843 (org-end-of-subtree nil t)
7844 (re-search-forward org-outline-regexp-bol)
7845 (beginning-of-line 0))
7846 (skip-chars-backward " \r\t\n")
7847 (and (not (org-looking-back "^\\*+" (line-beginning-position)))
7848 (looking-at "[ \t]+") (replace-match ""))
7849 (unless (eobp) (forward-char 1))
7850 (when (looking-at "^\\*")
7851 (unless (bobp) (backward-char 1))
7852 (insert "\n")))
7854 ;; If we are splitting, grab the text that should be moved
7855 ;; to the new headline.
7856 (when may-split
7857 (if (org-on-heading-p)
7858 ;; This is a heading: split intelligently (keeping
7859 ;; tags).
7860 (let ((pos (point)))
7861 (beginning-of-line)
7862 (unless (looking-at org-complex-heading-regexp)
7863 (error "This should not happen"))
7864 (when (and (match-beginning 4)
7865 (> pos (match-beginning 4))
7866 (< pos (match-end 4)))
7867 (setq initial-content (buffer-substring pos (match-end 4)))
7868 (goto-char pos)
7869 (delete-region (point) (match-end 4))
7870 (if (looking-at "[ \t]*$")
7871 (replace-match "")
7872 (insert (make-string (length initial-content) ?\s)))
7873 (setq initial-content (org-trim initial-content)))
7874 (goto-char pos))
7875 ;; A normal line.
7876 (setq initial-content
7877 (org-trim
7878 (delete-and-extract-region (point) (line-end-position))))))
7880 ;; If we are at the beginning of the line, insert before it.
7881 ;; Otherwise, after it.
7882 (cond
7883 ((and (bolp) (looking-at "[ \t]*$")))
7884 ((bolp) (save-excursion (insert "\n")))
7885 (t (end-of-line)
7886 (insert "\n")))
7888 ;; Insert the new heading
7889 (insert stars)
7890 (just-one-space)
7891 (insert initial-content)
7892 (unless (and blank (org-previous-line-empty-p))
7893 (org-N-empty-lines-before-current (if blank 1 0)))
7894 ;; Adjust visibility, which may be messed up if we removed
7895 ;; blank lines while previous entry was hidden.
7896 (let ((bol (line-beginning-position)))
7897 (dolist (o (overlays-at (1- bol)))
7898 (when (and (eq (overlay-get o 'invisible) 'outline)
7899 (eq (overlay-end o) bol))
7900 (move-overlay o (overlay-start o) (1- bol)))))
7901 (run-hooks 'org-insert-heading-hook)))))))
7903 (defun org-N-empty-lines-before-current (N)
7904 "Make the number of empty lines before current exactly N.
7905 So this will delete or add empty lines."
7906 (save-excursion
7907 (beginning-of-line)
7908 (let ((p (point)))
7909 (skip-chars-backward " \r\t\n")
7910 (unless (bolp) (forward-line))
7911 (delete-region (point) p))
7912 (when (> N 0) (insert (make-string N ?\n)))))
7914 (defun org-get-heading (&optional no-tags no-todo)
7915 "Return the heading of the current entry, without the stars.
7916 When NO-TAGS is non-nil, don't include tags.
7917 When NO-TODO is non-nil, don't include TODO keywords."
7918 (save-excursion
7919 (org-back-to-heading t)
7920 (cond
7921 ((and no-tags no-todo)
7922 (looking-at org-complex-heading-regexp)
7923 (match-string 4))
7924 (no-tags
7925 (looking-at (concat org-outline-regexp
7926 "\\(.*?\\)"
7927 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7928 (match-string 1))
7929 (no-todo
7930 (looking-at org-todo-line-regexp)
7931 (match-string 3))
7932 (t (looking-at org-heading-regexp)
7933 (match-string 2)))))
7935 (defvar orgstruct-mode) ; defined below
7937 (defun org-heading-components ()
7938 "Return the components of the current heading.
7939 This is a list with the following elements:
7940 - the level as an integer
7941 - the reduced level, different if `org-odd-levels-only' is set.
7942 - the TODO keyword, or nil
7943 - the priority character, like ?A, or nil if no priority is given
7944 - the headline text itself, or the tags string if no headline text
7945 - the tags string, or nil."
7946 (save-excursion
7947 (org-back-to-heading t)
7948 (if (let (case-fold-search)
7949 (looking-at
7950 (if orgstruct-mode
7951 org-heading-regexp
7952 org-complex-heading-regexp)))
7953 (if orgstruct-mode
7954 (list (length (match-string 1))
7955 (org-reduced-level (length (match-string 1)))
7958 (match-string 2)
7959 nil)
7960 (list (length (match-string 1))
7961 (org-reduced-level (length (match-string 1)))
7962 (org-match-string-no-properties 2)
7963 (and (match-end 3) (aref (match-string 3) 2))
7964 (org-match-string-no-properties 4)
7965 (org-match-string-no-properties 5))))))
7967 (defun org-get-entry ()
7968 "Get the entry text, after heading, entire subtree."
7969 (save-excursion
7970 (org-back-to-heading t)
7971 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7973 (defun org-insert-heading-after-current ()
7974 "Insert a new heading with same level as current, after current subtree."
7975 (interactive)
7976 (org-back-to-heading)
7977 (org-insert-heading)
7978 (org-move-subtree-down)
7979 (end-of-line 1))
7981 (defun org-insert-heading-respect-content (&optional invisible-ok)
7982 "Insert heading with `org-insert-heading-respect-content' set to t."
7983 (interactive)
7984 (org-insert-heading '(4) invisible-ok))
7986 (defun org-insert-todo-heading-respect-content (&optional force-state)
7987 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7988 (interactive)
7989 (org-insert-todo-heading force-state '(4)))
7991 (defun org-insert-todo-heading (arg &optional force-heading)
7992 "Insert a new heading with the same level and TODO state as current heading.
7993 If the heading has no TODO state, or if the state is DONE, use the first
7994 state (TODO by default). Also with one prefix arg, force first state. With
7995 two prefix args, force inserting at the end of the parent subtree."
7996 (interactive "P")
7997 (when (or force-heading (not (org-insert-item 'checkbox)))
7998 (org-insert-heading (or (and (equal arg '(16)) '(16))
7999 force-heading))
8000 (save-excursion
8001 (org-back-to-heading)
8002 (outline-previous-heading)
8003 (looking-at org-todo-line-regexp))
8004 (let*
8005 ((new-mark-x
8006 (if (or (equal arg '(4))
8007 (not (match-beginning 2))
8008 (member (match-string 2) org-done-keywords))
8009 (car org-todo-keywords-1)
8010 (match-string 2)))
8011 (new-mark
8013 (run-hook-with-args-until-success
8014 'org-todo-get-default-hook new-mark-x nil)
8015 new-mark-x)))
8016 (beginning-of-line 1)
8017 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8018 (if org-treat-insert-todo-heading-as-state-change
8019 (org-todo new-mark)
8020 (insert new-mark " "))))
8021 (when org-provide-todo-statistics
8022 (org-update-parent-todo-statistics))))
8024 (defun org-insert-subheading (arg)
8025 "Insert a new subheading and demote it.
8026 Works for outline headings and for plain lists alike."
8027 (interactive "P")
8028 (org-insert-heading arg)
8029 (cond
8030 ((org-at-heading-p) (org-do-demote))
8031 ((org-at-item-p) (org-indent-item))))
8033 (defun org-insert-todo-subheading (arg)
8034 "Insert a new subheading with TODO keyword or checkbox and demote it.
8035 Works for outline headings and for plain lists alike."
8036 (interactive "P")
8037 (org-insert-todo-heading arg)
8038 (cond
8039 ((org-at-heading-p) (org-do-demote))
8040 ((org-at-item-p) (org-indent-item))))
8042 ;;; Promotion and Demotion
8044 (defvar org-after-demote-entry-hook nil
8045 "Hook run after an entry has been demoted.
8046 The cursor will be at the beginning of the entry.
8047 When a subtree is being demoted, the hook will be called for each node.")
8049 (defvar org-after-promote-entry-hook nil
8050 "Hook run after an entry has been promoted.
8051 The cursor will be at the beginning of the entry.
8052 When a subtree is being promoted, the hook will be called for each node.")
8054 (defun org-promote-subtree ()
8055 "Promote the entire subtree.
8056 See also `org-promote'."
8057 (interactive)
8058 (save-excursion
8059 (org-with-limited-levels (org-map-tree 'org-promote)))
8060 (org-fix-position-after-promote))
8062 (defun org-demote-subtree ()
8063 "Demote the entire subtree.
8064 See `org-demote' and `org-promote'."
8065 (interactive)
8066 (save-excursion
8067 (org-with-limited-levels (org-map-tree 'org-demote)))
8068 (org-fix-position-after-promote))
8070 (defun org-do-promote ()
8071 "Promote the current heading higher up the tree.
8072 If the region is active in `transient-mark-mode', promote all
8073 headings in the region."
8074 (interactive)
8075 (save-excursion
8076 (if (org-region-active-p)
8077 (org-map-region 'org-promote (region-beginning) (region-end))
8078 (org-promote)))
8079 (org-fix-position-after-promote))
8081 (defun org-do-demote ()
8082 "Demote the current heading lower down the tree.
8083 If the region is active in `transient-mark-mode', demote all
8084 headings in the region."
8085 (interactive)
8086 (save-excursion
8087 (if (org-region-active-p)
8088 (org-map-region 'org-demote (region-beginning) (region-end))
8089 (org-demote)))
8090 (org-fix-position-after-promote))
8092 (defun org-fix-position-after-promote ()
8093 "Fix cursor position and indentation after demoting/promoting."
8094 (let ((pos (point)))
8095 (when (save-excursion
8096 (beginning-of-line 1)
8097 (looking-at org-todo-line-regexp)
8098 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8099 (cond ((eobp) (insert " "))
8100 ((eolp) (insert " "))
8101 ((equal (char-after) ?\ ) (forward-char 1))))))
8103 (defun org-current-level ()
8104 "Return the level of the current entry, or nil if before the first headline.
8105 The level is the number of stars at the beginning of the
8106 headline. Use `org-reduced-level' to remove the effect of
8107 `org-odd-levels'. Unlike to `org-outline-level', this function
8108 ignores inlinetasks."
8109 (let ((level (org-with-limited-levels (org-outline-level))))
8110 (and (> level 0) level)))
8112 (defun org-get-previous-line-level ()
8113 "Return the outline depth of the last headline before the current line.
8114 Returns 0 for the first headline in the buffer, and nil if before the
8115 first headline."
8116 (and (org-current-level)
8117 (or (and (/= (line-beginning-position) (point-min))
8118 (save-excursion (beginning-of-line 0) (org-current-level)))
8119 0)))
8121 (defun org-reduced-level (l)
8122 "Compute the effective level of a heading.
8123 This takes into account the setting of `org-odd-levels-only'."
8124 (cond
8125 ((zerop l) 0)
8126 (org-odd-levels-only (1+ (floor (/ l 2))))
8127 (t l)))
8129 (defun org-level-increment ()
8130 "Return the number of stars that will be added or removed at a
8131 time to headlines when structure editing, based on the value of
8132 `org-odd-levels-only'."
8133 (if org-odd-levels-only 2 1))
8135 (defun org-get-valid-level (level &optional change)
8136 "Rectify a level change under the influence of `org-odd-levels-only'
8137 LEVEL is a current level, CHANGE is by how much the level should be
8138 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8139 even level numbers will become the next higher odd number."
8140 (if org-odd-levels-only
8141 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8142 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8143 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8144 (max 1 (+ level (or change 0)))))
8146 (if (boundp 'define-obsolete-function-alias)
8147 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8148 (define-obsolete-function-alias 'org-get-legal-level
8149 'org-get-valid-level)
8150 (define-obsolete-function-alias 'org-get-legal-level
8151 'org-get-valid-level "23.1")))
8153 (defun org-promote ()
8154 "Promote the current heading higher up the tree."
8155 (org-with-wide-buffer
8156 (org-back-to-heading t)
8157 (let* ((after-change-functions (remq 'flyspell-after-change-function
8158 after-change-functions))
8159 (level (save-match-data (funcall outline-level)))
8160 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8161 (diff (abs (- level (length up-head) -1))))
8162 (cond
8163 ((and (= level 1) org-allow-promoting-top-level-subtree)
8164 (replace-match "# " nil t))
8165 ((= level 1)
8166 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8167 (t (replace-match up-head nil t)))
8168 (unless (= level 1)
8169 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8170 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8171 (run-hooks 'org-after-promote-entry-hook))))
8173 (defun org-demote ()
8174 "Demote the current heading lower down the tree."
8175 (org-with-wide-buffer
8176 (org-back-to-heading t)
8177 (let* ((after-change-functions (remq 'flyspell-after-change-function
8178 after-change-functions))
8179 (level (save-match-data (funcall outline-level)))
8180 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8181 (diff (abs (- level (length down-head) -1))))
8182 (replace-match down-head nil t)
8183 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8184 (when org-adapt-indentation (org-fixup-indentation diff))
8185 (run-hooks 'org-after-demote-entry-hook))))
8187 (defun org-cycle-level ()
8188 "Cycle the level of an empty headline through possible states.
8189 This goes first to child, then to parent, level, then up the hierarchy.
8190 After top level, it switches back to sibling level."
8191 (interactive)
8192 (let ((org-adapt-indentation nil))
8193 (when (org-point-at-end-of-empty-headline)
8194 (setq this-command 'org-cycle-level) ; Only needed for caching
8195 (let ((cur-level (org-current-level))
8196 (prev-level (org-get-previous-line-level)))
8197 (cond
8198 ;; If first headline in file, promote to top-level.
8199 ((= prev-level 0)
8200 (loop repeat (/ (- cur-level 1) (org-level-increment))
8201 do (org-do-promote)))
8202 ;; If same level as prev, demote one.
8203 ((= prev-level cur-level)
8204 (org-do-demote))
8205 ;; If parent is top-level, promote to top level if not already.
8206 ((= prev-level 1)
8207 (loop repeat (/ (- cur-level 1) (org-level-increment))
8208 do (org-do-promote)))
8209 ;; If top-level, return to prev-level.
8210 ((= cur-level 1)
8211 (loop repeat (/ (- prev-level 1) (org-level-increment))
8212 do (org-do-demote)))
8213 ;; If less than prev-level, promote one.
8214 ((< cur-level prev-level)
8215 (org-do-promote))
8216 ;; If deeper than prev-level, promote until higher than
8217 ;; prev-level.
8218 ((> cur-level prev-level)
8219 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8220 do (org-do-promote))))
8221 t))))
8223 (defun org-map-tree (fun)
8224 "Call FUN for every heading underneath the current one."
8225 (org-back-to-heading)
8226 (let ((level (funcall outline-level)))
8227 (save-excursion
8228 (funcall fun)
8229 (while (and (progn
8230 (outline-next-heading)
8231 (> (funcall outline-level) level))
8232 (not (eobp)))
8233 (funcall fun)))))
8235 (defun org-map-region (fun beg end)
8236 "Call FUN for every heading between BEG and END."
8237 (let ((org-ignore-region t))
8238 (save-excursion
8239 (setq end (copy-marker end))
8240 (goto-char beg)
8241 (if (and (re-search-forward org-outline-regexp-bol nil t)
8242 (< (point) end))
8243 (funcall fun))
8244 (while (and (progn
8245 (outline-next-heading)
8246 (< (point) end))
8247 (not (eobp)))
8248 (funcall fun)))))
8250 (defun org-fixup-indentation (diff)
8251 "Change the indentation in the current entry by DIFF.
8253 DIFF is an integer. Indentation is done according to the
8254 following rules:
8256 - Planning information and property drawers are always indented
8257 according to the new level of the headline;
8259 - Footnote definitions and their contents are ignored;
8261 - Inlinetasks' boundaries are not shifted;
8263 - Empty lines are ignored;
8265 - Other lines' indentation are shifted by DIFF columns, unless
8266 it would introduce a structural change in the document, in
8267 which case no shifting is done at all.
8269 Assume point is at a heading or an inlinetask beginning."
8270 (org-with-wide-buffer
8271 (narrow-to-region (line-beginning-position)
8272 (save-excursion
8273 (if (org-with-limited-levels (org-at-heading-p))
8274 (org-with-limited-levels (outline-next-heading))
8275 (org-inlinetask-goto-end))
8276 (point)))
8277 (forward-line)
8278 ;; Indent properly planning info and property drawer.
8279 (when (org-looking-at-p org-planning-line-re)
8280 (org-indent-line)
8281 (forward-line))
8282 (when (looking-at org-property-drawer-re)
8283 (goto-char (match-end 0))
8284 (forward-line)
8285 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8286 (catch 'no-shift
8287 (when (zerop diff) (throw 'no-shift nil))
8288 ;; If DIFF is negative, first check if a shift is possible at all
8289 ;; (e.g., it doesn't break structure). This can only happen if
8290 ;; some contents are not properly indented.
8291 (let ((case-fold-search t))
8292 (when (< diff 0)
8293 (let ((diff (- diff))
8294 (forbidden-re (concat org-outline-regexp
8295 "\\|"
8296 (substring org-footnote-definition-re 1))))
8297 (save-excursion
8298 (while (not (eobp))
8299 (cond
8300 ((org-looking-at-p "[ \t]*$") (forward-line))
8301 ((and (org-looking-at-p org-footnote-definition-re)
8302 (let ((e (org-element-at-point)))
8303 (and (eq (org-element-type e) 'footnote-definition)
8304 (goto-char (org-element-property :end e))))))
8305 ((org-looking-at-p org-outline-regexp) (forward-line))
8306 ;; Give up if shifting would move before column 0 or
8307 ;; if it would introduce a headline or a footnote
8308 ;; definition.
8310 (skip-chars-forward " \t")
8311 (let ((ind (current-column)))
8312 (when (or (< ind diff)
8313 (and (= ind diff) (org-looking-at-p forbidden-re)))
8314 (throw 'no-shift nil)))
8315 ;; Ignore contents of example blocks and source
8316 ;; blocks if their indentation is meant to be
8317 ;; preserved. Jump to block's closing line.
8318 (beginning-of-line)
8319 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8320 (let ((e (org-element-at-point)))
8321 (and (memq (org-element-type e)
8322 '(example-block src-block))
8323 (or org-src-preserve-indentation
8324 (org-element-property :preserve-indent e))
8325 (goto-char (org-element-property :end e))
8326 (progn (skip-chars-backward " \r\t\n")
8327 (beginning-of-line)
8328 t))))
8329 (forward-line))))))))
8330 ;; Shift lines but footnote definitions, inlinetasks boundaries
8331 ;; by DIFF. Also skip contents of source or example blocks
8332 ;; when indentation is meant to be preserved.
8333 (while (not (eobp))
8334 (cond
8335 ((and (org-looking-at-p org-footnote-definition-re)
8336 (let ((e (org-element-at-point)))
8337 (and (eq (org-element-type e) 'footnote-definition)
8338 (goto-char (org-element-property :end e))))))
8339 ((org-looking-at-p org-outline-regexp) (forward-line))
8340 ((org-looking-at-p "[ \t]*$") (forward-line))
8342 (org-indent-line-to (+ (org-get-indentation) diff))
8343 (beginning-of-line)
8344 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8345 (let ((e (org-element-at-point)))
8346 (and (memq (org-element-type e)
8347 '(example-block src-block))
8348 (or org-src-preserve-indentation
8349 (org-element-property :preserve-indent e))
8350 (goto-char (org-element-property :end e))
8351 (progn (skip-chars-backward " \r\t\n")
8352 (beginning-of-line)
8353 t))))
8354 (forward-line)))))))))
8356 (defun org-convert-to-odd-levels ()
8357 "Convert an org-mode file with all levels allowed to one with odd levels.
8358 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8359 level 5 etc."
8360 (interactive)
8361 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8362 (let ((outline-level 'org-outline-level)
8363 (org-odd-levels-only nil) n)
8364 (save-excursion
8365 (goto-char (point-min))
8366 (while (re-search-forward "^\\*\\*+ " nil t)
8367 (setq n (- (length (match-string 0)) 2))
8368 (while (>= (setq n (1- n)) 0)
8369 (org-demote))
8370 (end-of-line 1))))))
8372 (defun org-convert-to-oddeven-levels ()
8373 "Convert an org-mode file with only odd levels to one with odd/even levels.
8374 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8375 file contains a section with an even level, conversion would
8376 destroy the structure of the file. An error is signaled in this
8377 case."
8378 (interactive)
8379 (goto-char (point-min))
8380 ;; First check if there are no even levels
8381 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8382 (org-show-set-visibility 'canonical)
8383 (error "Not all levels are odd in this file. Conversion not possible"))
8384 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8385 (let ((outline-regexp org-outline-regexp)
8386 (outline-level 'org-outline-level)
8387 (org-odd-levels-only nil) n)
8388 (save-excursion
8389 (goto-char (point-min))
8390 (while (re-search-forward "^\\*\\*+ " nil t)
8391 (setq n (/ (1- (length (match-string 0))) 2))
8392 (while (>= (setq n (1- n)) 0)
8393 (org-promote))
8394 (end-of-line 1))))))
8396 (defun org-tr-level (n)
8397 "Make N odd if required."
8398 (if org-odd-levels-only (1+ (/ n 2)) n))
8400 ;;; Vertical tree motion, cutting and pasting of subtrees
8402 (defun org-move-subtree-up (&optional arg)
8403 "Move the current subtree up past ARG headlines of the same level."
8404 (interactive "p")
8405 (org-move-subtree-down (- (prefix-numeric-value arg))))
8407 (defun org-move-subtree-down (&optional arg)
8408 "Move the current subtree down past ARG headlines of the same level."
8409 (interactive "p")
8410 (setq arg (prefix-numeric-value arg))
8411 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8412 'org-get-last-sibling))
8413 (ins-point (make-marker))
8414 (cnt (abs arg))
8415 (col (current-column))
8416 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8417 ;; Select the tree
8418 (org-back-to-heading)
8419 (setq beg0 (point))
8420 (save-excursion
8421 (setq ne-beg (org-back-over-empty-lines))
8422 (setq beg (point)))
8423 (save-match-data
8424 (save-excursion (outline-end-of-heading)
8425 (setq folded (outline-invisible-p)))
8426 (progn (org-end-of-subtree nil t)
8427 (unless (eobp) (backward-char))))
8428 (outline-next-heading)
8429 (setq ne-end (org-back-over-empty-lines))
8430 (setq end (point))
8431 (goto-char beg0)
8432 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8433 ;; include less whitespace
8434 (save-excursion
8435 (goto-char beg)
8436 (forward-line (- ne-beg ne-end))
8437 (setq beg (point))))
8438 ;; Find insertion point, with error handling
8439 (while (> cnt 0)
8440 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8441 (progn (goto-char beg0)
8442 (user-error "Cannot move past superior level or buffer limit")))
8443 (setq cnt (1- cnt)))
8444 (if (> arg 0)
8445 ;; Moving forward - still need to move over subtree
8446 (progn (org-end-of-subtree t t)
8447 (save-excursion
8448 (org-back-over-empty-lines)
8449 (or (bolp) (newline)))))
8450 (setq ne-ins (org-back-over-empty-lines))
8451 (move-marker ins-point (point))
8452 (setq txt (buffer-substring beg end))
8453 (org-save-markers-in-region beg end)
8454 (delete-region beg end)
8455 (org-remove-empty-overlays-at beg)
8456 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8457 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8458 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8459 (let ((bbb (point)))
8460 (insert-before-markers txt)
8461 (org-reinstall-markers-in-region bbb)
8462 (move-marker ins-point bbb))
8463 (or (bolp) (insert "\n"))
8464 (setq ins-end (point))
8465 (goto-char ins-point)
8466 (org-skip-whitespace)
8467 (when (and (< arg 0)
8468 (org-first-sibling-p)
8469 (> ne-ins ne-beg))
8470 ;; Move whitespace back to beginning
8471 (save-excursion
8472 (goto-char ins-end)
8473 (let ((kill-whole-line t))
8474 (kill-line (- ne-ins ne-beg)) (point)))
8475 (insert (make-string (- ne-ins ne-beg) ?\n)))
8476 (move-marker ins-point nil)
8477 (if folded
8478 (outline-hide-subtree)
8479 (org-show-entry)
8480 (outline-show-children)
8481 (org-cycle-hide-drawers 'children))
8482 (org-clean-visibility-after-subtree-move)
8483 ;; move back to the initial column we were at
8484 (move-to-column col)))
8486 (defvar org-subtree-clip ""
8487 "Clipboard for cut and paste of subtrees.
8488 This is actually only a copy of the kill, because we use the normal kill
8489 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8491 (defvar org-subtree-clip-folded nil
8492 "Was the last copied subtree folded?
8493 This is used to fold the tree back after pasting.")
8495 (defun org-cut-subtree (&optional n)
8496 "Cut the current subtree into the clipboard.
8497 With prefix arg N, cut this many sequential subtrees.
8498 This is a short-hand for marking the subtree and then cutting it."
8499 (interactive "p")
8500 (org-copy-subtree n 'cut))
8502 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8503 "Copy the current subtree it in the clipboard.
8504 With prefix arg N, copy this many sequential subtrees.
8505 This is a short-hand for marking the subtree and then copying it.
8506 If CUT is non-nil, actually cut the subtree.
8507 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8508 of some markers in the region, even if CUT is non-nil. This is
8509 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8510 (interactive "p")
8511 (let (beg end folded (beg0 (point)))
8512 (if (org-called-interactively-p 'any)
8513 (org-back-to-heading nil) ; take what looks like a subtree
8514 (org-back-to-heading t)) ; take what is really there
8515 (setq beg (point))
8516 (skip-chars-forward " \t\r\n")
8517 (save-match-data
8518 (if nosubtrees
8519 (outline-next-heading)
8520 (save-excursion (outline-end-of-heading)
8521 (setq folded (outline-invisible-p)))
8522 (ignore-errors (org-forward-heading-same-level (1- n) t))
8523 (org-end-of-subtree t t)))
8524 ;; Include the end of an inlinetask
8525 (when (and (featurep 'org-inlinetask)
8526 (looking-at-p (concat (org-inlinetask-outline-regexp)
8527 "END[ \t]*$")))
8528 (end-of-line))
8529 (setq end (point))
8530 (goto-char beg0)
8531 (when (> end beg)
8532 (setq org-subtree-clip-folded folded)
8533 (when (or cut force-store-markers)
8534 (org-save-markers-in-region beg end))
8535 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8536 (setq org-subtree-clip (current-kill 0))
8537 (message "%s: Subtree(s) with %d characters"
8538 (if cut "Cut" "Copied")
8539 (length org-subtree-clip)))))
8541 (defun org-paste-subtree (&optional level tree for-yank remove)
8542 "Paste the clipboard as a subtree, with modification of headline level.
8543 The entire subtree is promoted or demoted in order to match a new headline
8544 level.
8546 If the cursor is at the beginning of a headline, the same level as
8547 that headline is used to paste the tree.
8549 If not, the new level is derived from the *visible* headings
8550 before and after the insertion point, and taken to be the inferior headline
8551 level of the two. So if the previous visible heading is level 3 and the
8552 next is level 4 (or vice versa), level 4 will be used for insertion.
8553 This makes sure that the subtree remains an independent subtree and does
8554 not swallow low level entries.
8556 You can also force a different level, either by using a numeric prefix
8557 argument, or by inserting the heading marker by hand. For example, if the
8558 cursor is after \"*****\", then the tree will be shifted to level 5.
8560 If optional TREE is given, use this text instead of the kill ring.
8562 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8563 move back over whitespace before inserting, and move point to the end of
8564 the inserted text when done.
8566 When REMOVE is non-nil, remove the subtree from the clipboard."
8567 (interactive "P")
8568 (setq tree (or tree (and kill-ring (current-kill 0))))
8569 (unless (org-kill-is-subtree-p tree)
8570 (user-error "%s"
8571 (substitute-command-keys
8572 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8573 (org-with-limited-levels
8574 (let* ((visp (not (outline-invisible-p)))
8575 (txt tree)
8576 (^re_ "\\(\\*+\\)[ \t]*")
8577 (old-level (if (string-match org-outline-regexp-bol txt)
8578 (- (match-end 0) (match-beginning 0) 1)
8579 -1))
8580 (force-level (cond (level (prefix-numeric-value level))
8581 ((and (looking-at "[ \t]*$")
8582 (string-match
8583 "^\\*+$" (buffer-substring
8584 (point-at-bol) (point))))
8585 (- (match-end 0) (match-beginning 0)))
8586 ((and (bolp)
8587 (looking-at org-outline-regexp))
8588 (- (match-end 0) (point) 1))))
8589 (previous-level (save-excursion
8590 (condition-case nil
8591 (progn
8592 (outline-previous-visible-heading 1)
8593 (if (looking-at ^re_)
8594 (- (match-end 0) (match-beginning 0) 1)
8596 (error 1))))
8597 (next-level (save-excursion
8598 (condition-case nil
8599 (progn
8600 (or (looking-at org-outline-regexp)
8601 (outline-next-visible-heading 1))
8602 (if (looking-at ^re_)
8603 (- (match-end 0) (match-beginning 0) 1)
8605 (error 1))))
8606 (new-level (or force-level (max previous-level next-level)))
8607 (shift (if (or (= old-level -1)
8608 (= new-level -1)
8609 (= old-level new-level))
8611 (- new-level old-level)))
8612 (delta (if (> shift 0) -1 1))
8613 (func (if (> shift 0) 'org-demote 'org-promote))
8614 (org-odd-levels-only nil)
8615 beg end newend)
8616 ;; Remove the forced level indicator
8617 (if force-level
8618 (delete-region (point-at-bol) (point)))
8619 ;; Paste
8620 (beginning-of-line (if (bolp) 1 2))
8621 (setq beg (point))
8622 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8623 (insert-before-markers txt)
8624 (unless (string-match "\n\\'" txt) (insert "\n"))
8625 (setq newend (point))
8626 (org-reinstall-markers-in-region beg)
8627 (setq end (point))
8628 (goto-char beg)
8629 (skip-chars-forward " \t\n\r")
8630 (setq beg (point))
8631 (if (and (outline-invisible-p) visp)
8632 (save-excursion (outline-show-heading)))
8633 ;; Shift if necessary
8634 (unless (= shift 0)
8635 (save-restriction
8636 (narrow-to-region beg end)
8637 (while (not (= shift 0))
8638 (org-map-region func (point-min) (point-max))
8639 (setq shift (+ delta shift)))
8640 (goto-char (point-min))
8641 (setq newend (point-max))))
8642 (when (or (org-called-interactively-p 'interactive) for-yank)
8643 (message "Clipboard pasted as level %d subtree" new-level))
8644 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8645 kill-ring
8646 (eq org-subtree-clip (current-kill 0))
8647 org-subtree-clip-folded)
8648 ;; The tree was folded before it was killed/copied
8649 (outline-hide-subtree))
8650 (and for-yank (goto-char newend))
8651 (and remove (setq kill-ring (cdr kill-ring))))))
8653 (defun org-kill-is-subtree-p (&optional txt)
8654 "Check if the current kill is an outline subtree, or a set of trees.
8655 Returns nil if kill does not start with a headline, or if the first
8656 headline level is not the largest headline level in the tree.
8657 So this will actually accept several entries of equal levels as well,
8658 which is OK for `org-paste-subtree'.
8659 If optional TXT is given, check this string instead of the current kill."
8660 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8661 (re (org-get-limited-outline-regexp))
8662 (^re (concat "^" re))
8663 (start-level (and kill
8664 (string-match
8665 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8666 kill)
8667 (- (match-end 2) (match-beginning 2) 1)))
8668 (start (1+ (or (match-beginning 2) -1))))
8669 (if (not start-level)
8670 (progn
8671 nil) ;; does not even start with a heading
8672 (catch 'exit
8673 (while (setq start (string-match ^re kill (1+ start)))
8674 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8675 (throw 'exit nil)))
8676 t))))
8678 (defvar org-markers-to-move nil
8679 "Markers that should be moved with a cut-and-paste operation.
8680 Those markers are stored together with their positions relative to
8681 the start of the region.")
8683 (defun org-save-markers-in-region (beg end)
8684 "Check markers in region.
8685 If these markers are between BEG and END, record their position relative
8686 to BEG, so that after moving the block of text, we can put the markers back
8687 into place.
8688 This function gets called just before an entry or tree gets cut from the
8689 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8690 called immediately, to move the markers with the entries."
8691 (setq org-markers-to-move nil)
8692 (when (featurep 'org-clock)
8693 (org-clock-save-markers-for-cut-and-paste beg end))
8694 (when (featurep 'org-agenda)
8695 (org-agenda-save-markers-for-cut-and-paste beg end)))
8697 (defun org-check-and-save-marker (marker beg end)
8698 "Check if MARKER is between BEG and END.
8699 If yes, remember the marker and the distance to BEG."
8700 (when (and (marker-buffer marker)
8701 (equal (marker-buffer marker) (current-buffer)))
8702 (if (and (>= marker beg) (< marker end))
8703 (push (cons marker (- marker beg)) org-markers-to-move))))
8705 (defun org-reinstall-markers-in-region (beg)
8706 "Move all remembered markers to their position relative to BEG."
8707 (mapc (lambda (x)
8708 (move-marker (car x) (+ beg (cdr x))))
8709 org-markers-to-move)
8710 (setq org-markers-to-move nil))
8712 (defun org-narrow-to-subtree ()
8713 "Narrow buffer to the current subtree."
8714 (interactive)
8715 (save-excursion
8716 (save-match-data
8717 (org-with-limited-levels
8718 (narrow-to-region
8719 (progn (org-back-to-heading t) (point))
8720 (progn (org-end-of-subtree t t)
8721 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8722 (point)))))))
8724 (defun org-narrow-to-block ()
8725 "Narrow buffer to the current block."
8726 (interactive)
8727 (let* ((case-fold-search t)
8728 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8729 "^[ \t]*#\\+end_.*")))
8730 (if blockp
8731 (narrow-to-region (car blockp) (cdr blockp))
8732 (user-error "Not in a block"))))
8734 (defun org-clone-subtree-with-time-shift (n &optional shift)
8735 "Clone the task (subtree) at point N times.
8736 The clones will be inserted as siblings.
8738 In interactive use, the user will be prompted for the number of
8739 clones to be produced. If the entry has a timestamp, the user
8740 will also be prompted for a time shift, which may be a repeater
8741 as used in time stamps, for example `+3d'. To disable this,
8742 you can call the function with a universal prefix argument.
8744 When a valid repeater is given and the entry contains any time
8745 stamps, the clones will become a sequence in time, with time
8746 stamps in the subtree shifted for each clone produced. If SHIFT
8747 is nil or the empty string, time stamps will be left alone. The
8748 ID property of the original subtree is removed.
8750 If the original subtree did contain time stamps with a repeater,
8751 the following will happen:
8752 - the repeater will be removed in each clone
8753 - an additional clone will be produced, with the current, unshifted
8754 date(s) in the entry.
8755 - the original entry will be placed *after* all the clones, with
8756 repeater intact.
8757 - the start days in the repeater in the original entry will be shifted
8758 to past the last clone.
8759 In this way you can spell out a number of instances of a repeating task,
8760 and still retain the repeater to cover future instances of the task.
8762 As described above, N+1 clones are produced when the original
8763 subtree has a repeater. Setting N to 0, then, can be used to
8764 remove the repeater from a subtree and create a shifted clone
8765 with the original repeater."
8766 (interactive "nNumber of clones to produce: ")
8767 (let ((shift
8768 (or shift
8769 (if (and (not (equal current-prefix-arg '(4)))
8770 (save-excursion
8771 (re-search-forward org-ts-regexp-both
8772 (save-excursion
8773 (org-end-of-subtree t)
8774 (point)) t)))
8775 (read-from-minibuffer
8776 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8777 ""))) ;; No time shift
8778 (n-no-remove -1)
8779 (drawer-re org-drawer-regexp)
8780 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8781 beg end template task idprop
8782 shift-n shift-what doshift nmin nmax)
8783 (unless (wholenump n)
8784 (user-error "Invalid number of replications %s" n))
8785 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8786 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8787 shift)))
8788 (user-error "Invalid shift specification %s" shift))
8789 (when doshift
8790 (setq shift-n (string-to-number (match-string 1 shift))
8791 shift-what (cdr (assoc (match-string 2 shift)
8792 '(("d" . day) ("w" . week)
8793 ("m" . month) ("y" . year))))))
8794 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8795 (setq nmin 1 nmax n)
8796 (org-back-to-heading t)
8797 (setq beg (point))
8798 (setq idprop (org-entry-get nil "ID"))
8799 (org-end-of-subtree t t)
8800 (or (bolp) (insert "\n"))
8801 (setq end (point))
8802 (setq template (buffer-substring beg end))
8803 (when (and doshift
8804 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8805 (delete-region beg end)
8806 (setq end beg)
8807 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8808 (goto-char end)
8809 (loop for n from nmin to nmax do
8810 ;; prepare clone
8811 (with-temp-buffer
8812 (insert template)
8813 (org-mode)
8814 (goto-char (point-min))
8815 (org-show-subtree)
8816 (and idprop (if org-clone-delete-id
8817 (org-entry-delete nil "ID")
8818 (org-id-get-create t)))
8819 (unless (= n 0)
8820 (while (re-search-forward org-clock-re nil t)
8821 (kill-whole-line))
8822 (goto-char (point-min))
8823 (while (re-search-forward drawer-re nil t)
8824 (org-remove-empty-drawer-at (point))))
8825 (goto-char (point-min))
8826 (when doshift
8827 (while (re-search-forward org-ts-regexp-both nil t)
8828 (org-timestamp-change (* n shift-n) shift-what))
8829 (unless (= n n-no-remove)
8830 (goto-char (point-min))
8831 (while (re-search-forward org-ts-regexp nil t)
8832 (save-excursion
8833 (goto-char (match-beginning 0))
8834 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8835 (delete-region (match-beginning 1) (match-end 1)))))))
8836 (setq task (buffer-string)))
8837 (insert task))
8838 (goto-char beg)))
8840 ;;; Outline Sorting
8842 (defun org-sort (with-case)
8843 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8844 Optional argument WITH-CASE means sort case-sensitively."
8845 (interactive "P")
8846 (cond
8847 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8848 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8850 (org-call-with-arg 'org-sort-entries with-case))))
8852 (defun org-sort-remove-invisible (s)
8853 "Remove invisible links from string S."
8854 (remove-text-properties 0 (length s) org-rm-props s)
8855 (while (string-match org-bracket-link-regexp s)
8856 (setq s (replace-match (if (match-end 2)
8857 (match-string 3 s)
8858 (match-string 1 s))
8859 t t s)))
8860 (let ((st (format " %s " s)))
8861 (while (string-match org-emph-re st)
8862 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8863 (setq s (substring st 1 -1)))
8866 (defvar org-priority-regexp) ; defined later in the file
8868 (defvar org-after-sorting-entries-or-items-hook nil
8869 "Hook that is run after a bunch of entries or items have been sorted.
8870 When children are sorted, the cursor is in the parent line when this
8871 hook gets called. When a region or a plain list is sorted, the cursor
8872 will be in the first entry of the sorted region/list.")
8874 (defun org-sort-entries
8875 (&optional with-case sorting-type getkey-func compare-func property)
8876 "Sort entries on a certain level of an outline tree.
8877 If there is an active region, the entries in the region are sorted.
8878 Else, if the cursor is before the first entry, sort the top-level items.
8879 Else, the children of the entry at point are sorted.
8881 Sorting can be alphabetically, numerically, by date/time as given by
8882 a time stamp, by a property, by priority order, or by a custom function.
8884 The command prompts for the sorting type unless it has been given to the
8885 function through the SORTING-TYPE argument, which needs to be a character,
8886 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8887 the precise meaning of each character:
8889 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8890 c By creation time, which is assumed to be the first inactive time stamp
8891 at the beginning of a line.
8892 d By deadline date/time.
8893 k By clocking time.
8894 n Numerically, by converting the beginning of the entry/item to a number.
8895 o By order of TODO keywords.
8896 p By priority according to the cookie.
8897 r By the value of a property.
8898 s By scheduled date/time.
8899 t By date/time, either the first active time stamp in the entry, or, if
8900 none exist, by the first inactive one.
8902 Capital letters will reverse the sort order.
8904 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8905 called with point at the beginning of the record. It must return either
8906 a string or a number that should serve as the sorting key for that record.
8908 Comparing entries ignores case by default. However, with an optional argument
8909 WITH-CASE, the sorting considers case as well.
8911 Sorting is done against the visible part of the headlines, it ignores hidden
8912 links.
8914 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8915 (interactive "P")
8916 (let ((case-func (if with-case 'identity 'downcase))
8917 (cmstr
8918 ;; The clock marker is lost when using `sort-subr', let's
8919 ;; store the clocking string.
8920 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8921 (save-excursion
8922 (goto-char org-clock-marker)
8923 (buffer-substring-no-properties (line-beginning-position)
8924 (point)))))
8925 start beg end stars re re2
8926 txt what tmp)
8927 ;; Find beginning and end of region to sort
8928 (cond
8929 ((org-region-active-p)
8930 ;; we will sort the region
8931 (setq end (region-end)
8932 what "region")
8933 (goto-char (region-beginning))
8934 (if (not (org-at-heading-p)) (outline-next-heading))
8935 (setq start (point)))
8936 ((or (org-at-heading-p)
8937 (ignore-errors (progn (org-back-to-heading) t)))
8938 ;; we will sort the children of the current headline
8939 (org-back-to-heading)
8940 (setq start (point)
8941 end (progn (org-end-of-subtree t t)
8942 (or (bolp) (insert "\n"))
8943 (when (>= (org-back-over-empty-lines) 1)
8944 (forward-line 1))
8945 (point))
8946 what "children")
8947 (goto-char start)
8948 (outline-show-subtree)
8949 (outline-next-heading))
8951 ;; we will sort the top-level entries in this file
8952 (goto-char (point-min))
8953 (or (org-at-heading-p) (outline-next-heading))
8954 (setq start (point))
8955 (goto-char (point-max))
8956 (beginning-of-line 1)
8957 (when (looking-at ".*?\\S-")
8958 ;; File ends in a non-white line
8959 (end-of-line 1)
8960 (insert "\n"))
8961 (setq end (point-max))
8962 (setq what "top-level")
8963 (goto-char start)
8964 (outline-show-all)))
8966 (setq beg (point))
8967 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8969 (looking-at "\\(\\*+\\)")
8970 (setq stars (match-string 1)
8971 re (concat "^" (regexp-quote stars) " +")
8972 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8973 txt (buffer-substring beg end))
8974 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8975 (if (and (not (equal stars "*")) (string-match re2 txt))
8976 (user-error "Region to sort contains a level above the first entry"))
8978 (unless sorting-type
8979 (message
8980 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8981 [t]ime [s]cheduled [d]eadline [c]reated cloc[k]ing
8982 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8983 what)
8984 (setq sorting-type (read-char-exclusive))
8986 (unless getkey-func
8987 (and (= (downcase sorting-type) ?f)
8988 (setq getkey-func
8989 (org-icompleting-read "Sort using function: "
8990 obarray 'fboundp t nil nil))
8991 (setq getkey-func (intern getkey-func))))
8993 (and (= (downcase sorting-type) ?r)
8994 (not property)
8995 (setq property
8996 (org-icompleting-read "Property: "
8997 (mapcar 'list (org-buffer-property-keys t))
8998 nil t))))
9000 (when (member sorting-type '(?k ?K)) (org-clock-sum))
9001 (message "Sorting entries...")
9003 (save-restriction
9004 (narrow-to-region start end)
9005 (let ((dcst (downcase sorting-type))
9006 (case-fold-search nil)
9007 (now (current-time)))
9008 (sort-subr
9009 (/= dcst sorting-type)
9010 ;; This function moves to the beginning character of the "record" to
9011 ;; be sorted.
9012 (lambda nil
9013 (if (re-search-forward re nil t)
9014 (goto-char (match-beginning 0))
9015 (goto-char (point-max))))
9016 ;; This function moves to the last character of the "record" being
9017 ;; sorted.
9018 (lambda nil
9019 (save-match-data
9020 (condition-case nil
9021 (outline-forward-same-level 1)
9022 (error
9023 (goto-char (point-max))))))
9024 ;; This function returns the value that gets sorted against.
9025 (lambda nil
9026 (cond
9027 ((= dcst ?n)
9028 (if (looking-at org-complex-heading-regexp)
9029 (string-to-number (org-sort-remove-invisible (match-string 4)))
9030 nil))
9031 ((= dcst ?a)
9032 (if (looking-at org-complex-heading-regexp)
9033 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9034 nil))
9035 ((= dcst ?k)
9036 (or (get-text-property (point) :org-clock-minutes) 0))
9037 ((= dcst ?t)
9038 (let ((end (save-excursion (outline-next-heading) (point))))
9039 (if (or (re-search-forward org-ts-regexp end t)
9040 (re-search-forward org-ts-regexp-both end t))
9041 (org-time-string-to-seconds (match-string 0))
9042 (org-float-time now))))
9043 ((= dcst ?c)
9044 (let ((end (save-excursion (outline-next-heading) (point))))
9045 (if (re-search-forward
9046 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9047 end t)
9048 (org-time-string-to-seconds (match-string 0))
9049 (org-float-time now))))
9050 ((= dcst ?s)
9051 (let ((end (save-excursion (outline-next-heading) (point))))
9052 (if (re-search-forward org-scheduled-time-regexp end t)
9053 (org-time-string-to-seconds (match-string 1))
9054 (org-float-time now))))
9055 ((= dcst ?d)
9056 (let ((end (save-excursion (outline-next-heading) (point))))
9057 (if (re-search-forward org-deadline-time-regexp end t)
9058 (org-time-string-to-seconds (match-string 1))
9059 (org-float-time now))))
9060 ((= dcst ?p)
9061 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9062 (string-to-char (match-string 2))
9063 org-default-priority))
9064 ((= dcst ?r)
9065 (or (org-entry-get nil property) ""))
9066 ((= dcst ?o)
9067 (if (looking-at org-complex-heading-regexp)
9068 (let* ((m (match-string 2))
9069 (s (if (member m org-done-keywords) '- '+)))
9070 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9071 ((= dcst ?f)
9072 (if getkey-func
9073 (progn
9074 (setq tmp (funcall getkey-func))
9075 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9076 tmp)
9077 (error "Invalid key function `%s'" getkey-func)))
9078 (t (error "Invalid sorting type `%c'" sorting-type))))
9080 (cond
9081 ((= dcst ?a) 'string<)
9082 ((= dcst ?f) compare-func)
9083 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9084 (run-hooks 'org-after-sorting-entries-or-items-hook)
9085 ;; Reset the clock marker if needed
9086 (when cmstr
9087 (save-excursion
9088 (goto-char start)
9089 (search-forward cmstr nil t)
9090 (move-marker org-clock-marker (point))))
9091 (message "Sorting entries...done")))
9093 ;;; The orgstruct minor mode
9095 ;; Define a minor mode which can be used in other modes in order to
9096 ;; integrate the org-mode structure editing commands.
9098 ;; This is really a hack, because the org-mode structure commands use
9099 ;; keys which normally belong to the major mode. Here is how it
9100 ;; works: The minor mode defines all the keys necessary to operate the
9101 ;; structure commands, but wraps the commands into a function which
9102 ;; tests if the cursor is currently at a headline or a plain list
9103 ;; item. If that is the case, the structure command is used,
9104 ;; temporarily setting many Org-mode variables like regular
9105 ;; expressions for filling etc. However, when any of those keys is
9106 ;; used at a different location, function uses `key-binding' to look
9107 ;; up if the key has an associated command in another currently active
9108 ;; keymap (minor modes, major mode, global), and executes that
9109 ;; command. There might be problems if any of the keys is otherwise
9110 ;; used as a prefix key.
9112 (defcustom orgstruct-heading-prefix-regexp ""
9113 "Regexp that matches the custom prefix of Org headlines in
9114 orgstruct(++)-mode."
9115 :group 'org
9116 :version "24.4"
9117 :package-version '(Org . "8.3")
9118 :type 'regexp)
9119 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9121 (defcustom orgstruct-setup-hook nil
9122 "Hook run after orgstruct-mode-map is filled."
9123 :group 'org
9124 :version "24.4"
9125 :package-version '(Org . "8.0")
9126 :type 'hook)
9128 (defvar orgstruct-initialized nil)
9130 (defvar org-local-vars nil
9131 "List of local variables, for use by `orgstruct-mode'.")
9133 ;;;###autoload
9134 (define-minor-mode orgstruct-mode
9135 "Toggle the minor mode `orgstruct-mode'.
9136 This mode is for using Org-mode structure commands in other
9137 modes. The following keys behave as if Org-mode were active, if
9138 the cursor is on a headline, or on a plain list item (both as
9139 defined by Org-mode)."
9140 nil " OrgStruct" (make-sparse-keymap)
9141 (funcall (if orgstruct-mode
9142 'add-to-invisibility-spec
9143 'remove-from-invisibility-spec)
9144 '(outline . t))
9145 (when orgstruct-mode
9146 (org-load-modules-maybe)
9147 (unless orgstruct-initialized
9148 (orgstruct-setup)
9149 (setq orgstruct-initialized t))))
9151 ;;;###autoload
9152 (defun turn-on-orgstruct ()
9153 "Unconditionally turn on `orgstruct-mode'."
9154 (orgstruct-mode 1))
9156 (defvar org-fb-vars nil)
9157 (make-variable-buffer-local 'org-fb-vars)
9158 (defun orgstruct++-mode (&optional arg)
9159 "Toggle `orgstruct-mode', the enhanced version of it.
9160 In addition to setting orgstruct-mode, this also exports all
9161 indentation and autofilling variables from org-mode into the
9162 buffer. It will also recognize item context in multiline items."
9163 (interactive "P")
9164 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9165 (if (< arg 1)
9166 (progn (orgstruct-mode -1)
9167 (mapc (lambda(v)
9168 (org-set-local (car v)
9169 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9170 org-fb-vars))
9171 (orgstruct-mode 1)
9172 (setq org-fb-vars nil)
9173 (unless org-local-vars
9174 (setq org-local-vars (org-get-local-variables)))
9175 (let (var val)
9176 (mapc
9177 (lambda (x)
9178 (when (string-match
9179 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9180 (symbol-name (car x)))
9181 (setq var (car x) val (nth 1 x))
9182 (push (list var `(quote ,(eval var))) org-fb-vars)
9183 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9184 org-local-vars)
9185 (org-set-local 'orgstruct-is-++ t))))
9187 (defvar orgstruct-is-++ nil
9188 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9189 (make-variable-buffer-local 'orgstruct-is-++)
9191 ;;;###autoload
9192 (defun turn-on-orgstruct++ ()
9193 "Unconditionally turn on `orgstruct++-mode'."
9194 (orgstruct++-mode 1))
9196 (defun orgstruct-error ()
9197 "Error when there is no default binding for a structure key."
9198 (interactive)
9199 (funcall (if (fboundp 'user-error)
9200 'user-error
9201 'error)
9202 "This key has no function outside structure elements"))
9204 (defun orgstruct-setup ()
9205 "Setup orgstruct keymap."
9206 (dolist (cell '((org-demote . t)
9207 (org-metaleft . t)
9208 (org-metaright . t)
9209 (org-promote . t)
9210 (org-shiftmetaleft . t)
9211 (org-shiftmetaright . t)
9212 org-backward-element
9213 org-backward-heading-same-level
9214 org-ctrl-c-ret
9215 org-ctrl-c-minus
9216 org-ctrl-c-star
9217 org-cycle
9218 org-forward-heading-same-level
9219 org-insert-heading
9220 org-insert-heading-respect-content
9221 org-kill-note-or-show-branches
9222 org-mark-subtree
9223 org-meta-return
9224 org-metadown
9225 org-metaup
9226 org-narrow-to-subtree
9227 org-promote-subtree
9228 org-reveal
9229 org-shiftdown
9230 org-shiftleft
9231 org-shiftmetadown
9232 org-shiftmetaup
9233 org-shiftright
9234 org-shifttab
9235 org-shifttab
9236 org-shiftup
9237 org-show-subtree
9238 org-sort
9239 org-up-element
9240 outline-demote
9241 outline-next-visible-heading
9242 outline-previous-visible-heading
9243 outline-promote
9244 outline-up-heading
9245 outline-show-children))
9246 (let ((f (or (car-safe cell) cell))
9247 (disable-when-heading-prefix (cdr-safe cell)))
9248 (when (fboundp f)
9249 (let ((new-bindings))
9250 (dolist (binding (nconc (where-is-internal f org-mode-map)
9251 (where-is-internal f outline-mode-map)))
9252 (push binding new-bindings)
9253 ;; TODO use local-function-key-map
9254 (dolist (rep '(("<tab>" . "TAB")
9255 ("<return>" . "RET")
9256 ("<escape>" . "ESC")
9257 ("<delete>" . "DEL")))
9258 (setq binding (read-kbd-macro
9259 (let ((case-fold-search))
9260 (replace-regexp-in-string
9261 (regexp-quote (cdr rep))
9262 (car rep)
9263 (key-description binding)))))
9264 (pushnew binding new-bindings :test 'equal)))
9265 (dolist (binding new-bindings)
9266 (let ((key (lookup-key orgstruct-mode-map binding)))
9267 (when (or (not key) (numberp key))
9268 (ignore-errors
9269 (org-defkey orgstruct-mode-map
9270 binding
9271 (orgstruct-make-binding
9272 f binding disable-when-heading-prefix))))))))))
9273 (run-hooks 'orgstruct-setup-hook))
9275 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9276 "Create a function for binding in the structure minor mode.
9277 FUN is the command to call inside a table. KEY is the key that
9278 should be checked in for a command to execute outside of tables.
9279 Non-nil `disable-when-heading-prefix' means to disable the command
9280 if `orgstruct-heading-prefix-regexp' is not empty."
9281 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9282 (let ((nname name)
9283 (i 0))
9284 (while (fboundp (intern nname))
9285 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9286 (setq name (intern nname)))
9287 (eval
9288 (let ((bindings '((org-heading-regexp
9289 (concat "^"
9290 orgstruct-heading-prefix-regexp
9291 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9292 (org-outline-regexp
9293 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9294 (org-outline-regexp-bol
9295 (concat "^" org-outline-regexp))
9296 (outline-regexp org-outline-regexp)
9297 (outline-heading-end-regexp "\n")
9298 (outline-level 'org-outline-level)
9299 (outline-heading-alist))))
9300 `(defun ,name (arg)
9301 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9302 "Outside of structure, run the binding of `"
9303 (key-description key) "'."
9304 (when disable-when-heading-prefix
9305 (concat
9306 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9307 "back to the default binding due to limitations of Org's implementation of\n"
9308 "`" (symbol-name fun) "'.")))
9309 (interactive "p")
9310 (let* ((disable
9311 ,(and disable-when-heading-prefix
9312 '(not (string= orgstruct-heading-prefix-regexp ""))))
9313 (fallback
9314 (or disable
9315 (not
9316 (let* ,bindings
9317 (org-context-p 'headline 'item
9318 ,(when (memq fun
9319 '(org-insert-heading
9320 org-insert-heading-respect-content
9321 org-meta-return))
9322 '(when orgstruct-is-++
9323 'item-body))))))))
9324 (if fallback
9325 (let* ((orgstruct-mode)
9326 (binding
9327 (let ((key ,key))
9328 (catch 'exit
9329 (dolist
9330 (rep
9331 '(nil
9332 ("<\\([^>]*\\)tab>" . "\\1TAB")
9333 ("<\\([^>]*\\)return>" . "\\1RET")
9334 ("<\\([^>]*\\)escape>" . "\\1ESC")
9335 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9336 nil)
9337 (when rep
9338 (setq key (read-kbd-macro
9339 (let ((case-fold-search))
9340 (replace-regexp-in-string
9341 (car rep)
9342 (cdr rep)
9343 (key-description key))))))
9344 (when (key-binding key)
9345 (throw 'exit (key-binding key))))))))
9346 (if (keymapp binding)
9347 (org-set-transient-map binding)
9348 (let ((func (or binding
9349 (unless disable
9350 'orgstruct-error))))
9351 (when func
9352 (call-interactively func)))))
9353 (org-run-like-in-org-mode
9354 (lambda ()
9355 (interactive)
9356 (let* ,bindings
9357 (call-interactively ',fun)))))))))
9358 name))
9360 (defun org-contextualize-keys (alist contexts)
9361 "Return valid elements in ALIST depending on CONTEXTS.
9363 `org-agenda-custom-commands' or `org-capture-templates' are the
9364 values used for ALIST, and `org-agenda-custom-commands-contexts'
9365 or `org-capture-templates-contexts' are the associated contexts
9366 definitions."
9367 (let ((contexts
9368 ;; normalize contexts
9369 (mapcar
9370 (lambda(c) (cond ((listp (cadr c))
9371 (list (car c) (car c) (cadr c)))
9372 ((string= "" (cadr c))
9373 (list (car c) (car c) (caddr c)))
9374 (t c)))
9375 contexts))
9376 (a alist) r s)
9377 ;; loop over all commands or templates
9378 (dolist (c a)
9379 (let (vrules repl)
9380 (cond
9381 ((not (assoc (car c) contexts))
9382 (push c r))
9383 ((and (assoc (car c) contexts)
9384 (setq vrules (org-contextualize-validate-key
9385 (car c) contexts)))
9386 (mapc (lambda (vr)
9387 (when (not (equal (car vr) (cadr vr)))
9388 (setq repl vr)))
9389 vrules)
9390 (if (not repl) (push c r)
9391 (push (cadr repl) s)
9392 (push
9393 (cons (car c)
9394 (cdr (or (assoc (cadr repl) alist)
9395 (error "Undefined key `%s' as contextual replacement for `%s'"
9396 (cadr repl) (car c)))))
9397 r))))))
9398 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9399 (delq
9401 (delete-dups
9402 (mapcar (lambda (x)
9403 (let ((tpl (car x)))
9404 (when (not (delq
9406 (mapcar (lambda (y)
9407 (equal y tpl))
9408 s)))
9409 x)))
9410 (reverse r))))))
9412 (defun org-contextualize-validate-key (key contexts)
9413 "Check CONTEXTS for agenda or capture KEY."
9414 (let (rr res)
9415 (dolist (r contexts)
9416 (mapc
9417 (lambda (rr)
9418 (when
9419 (and (equal key (car r))
9420 (if (functionp rr) (funcall rr)
9421 (or (and (eq (car rr) 'in-file)
9422 (buffer-file-name)
9423 (string-match (cdr rr) (buffer-file-name)))
9424 (and (eq (car rr) 'in-mode)
9425 (string-match (cdr rr) (symbol-name major-mode)))
9426 (and (eq (car rr) 'in-buffer)
9427 (string-match (cdr rr) (buffer-name)))
9428 (when (and (eq (car rr) 'not-in-file)
9429 (buffer-file-name))
9430 (not (string-match (cdr rr) (buffer-file-name))))
9431 (when (eq (car rr) 'not-in-mode)
9432 (not (string-match (cdr rr) (symbol-name major-mode))))
9433 (when (eq (car rr) 'not-in-buffer)
9434 (not (string-match (cdr rr) (buffer-name)))))))
9435 (push r res)))
9436 (car (last r))))
9437 (delete-dups (delq nil res))))
9439 (defun org-context-p (&rest contexts)
9440 "Check if local context is any of CONTEXTS.
9441 Possible values in the list of contexts are `table', `headline', and `item'."
9442 (let ((pos (point)))
9443 (goto-char (point-at-bol))
9444 (prog1 (or (and (memq 'table contexts)
9445 (looking-at "[ \t]*|"))
9446 (and (memq 'headline contexts)
9447 (looking-at org-outline-regexp))
9448 (and (memq 'item contexts)
9449 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9450 (and (memq 'item-body contexts)
9451 (org-in-item-p)))
9452 (goto-char pos))))
9454 (defun org-get-local-variables ()
9455 "Return a list of all local variables in an Org mode buffer."
9456 (let (varlist)
9457 (with-current-buffer (get-buffer-create "*Org tmp*")
9458 (erase-buffer)
9459 (org-mode)
9460 (setq varlist (buffer-local-variables)))
9461 (kill-buffer "*Org tmp*")
9462 (delq nil
9463 (mapcar
9464 (lambda (x)
9465 (setq x
9466 (if (symbolp x)
9467 (list x)
9468 (list (car x) (cdr x))))
9469 (if (and (not (get (car x) 'org-state))
9470 (string-match
9471 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9472 (symbol-name (car x))))
9473 x nil))
9474 varlist))))
9476 (defun org-clone-local-variables (from-buffer &optional regexp)
9477 "Clone local variables from FROM-BUFFER.
9478 Optional argument REGEXP selects variables to clone."
9479 (mapc
9480 (lambda (pair)
9481 (and (symbolp (car pair))
9482 (or (null regexp)
9483 (string-match regexp (symbol-name (car pair))))
9484 (set (make-local-variable (car pair))
9485 (cdr pair))))
9486 (buffer-local-variables from-buffer)))
9488 ;;;###autoload
9489 (defun org-run-like-in-org-mode (cmd)
9490 "Run a command, pretending that the current buffer is in Org-mode.
9491 This will temporarily bind local variables that are typically bound in
9492 Org-mode to the values they have in Org-mode, and then interactively
9493 call CMD."
9494 (org-load-modules-maybe)
9495 (unless org-local-vars
9496 (setq org-local-vars (org-get-local-variables)))
9497 (let (binds)
9498 (dolist (var org-local-vars)
9499 (when (or (not (boundp (car var)))
9500 (eq (symbol-value (car var))
9501 (default-value (car var))))
9502 (push (list (car var) `(quote ,(cadr var))) binds)))
9503 (eval `(let ,binds
9504 (call-interactively (quote ,cmd))))))
9506 (defun org-get-category (&optional pos force-refresh)
9507 "Get the category applying to position POS."
9508 (save-match-data
9509 (if force-refresh (org-refresh-category-properties))
9510 (let ((pos (or pos (point))))
9511 (or (get-text-property pos 'org-category)
9512 (progn (org-refresh-category-properties)
9513 (get-text-property pos 'org-category))))))
9515 ;;; Refresh properties
9517 (defun org-refresh-properties (dprop tprop)
9518 "Refresh buffer text properties.
9519 DPROP is the drawer property and TPROP is either the
9520 corresponding text property to set, or an alist with each element
9521 being a text property (as a symbol) and a function to apply to
9522 the value of the drawer property."
9523 (let ((case-fold-search t)
9524 (inhibit-read-only t))
9525 (org-with-silent-modifications
9526 (save-excursion
9527 (save-restriction
9528 (widen)
9529 (goto-char (point-min))
9530 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9531 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9533 (defun org-refresh-property (tprop p)
9534 "Refresh the buffer text property TPROP from the drawer property P.
9535 The refresh happens only for the current tree (not subtree)."
9536 (unless (org-before-first-heading-p)
9537 (save-excursion
9538 (org-back-to-heading t)
9539 (if (symbolp tprop)
9540 ;; TPROP is a text property symbol
9541 (put-text-property
9542 (point) (or (outline-next-heading) (point-max)) tprop p)
9543 ;; TPROP is an alist with (properties . function) elements
9544 (dolist (al tprop)
9545 (save-excursion
9546 (put-text-property
9547 (line-beginning-position) (or (outline-next-heading) (point-max))
9548 (car al)
9549 (funcall (cdr al) p))))))))
9551 (defun org-refresh-category-properties ()
9552 "Refresh category text properties in the buffer."
9553 (let ((case-fold-search t)
9554 (inhibit-read-only t)
9555 (default-category
9556 (cond ((null org-category)
9557 (if buffer-file-name
9558 (file-name-sans-extension
9559 (file-name-nondirectory buffer-file-name))
9560 "???"))
9561 ((symbolp org-category) (symbol-name org-category))
9562 (t org-category))))
9563 (org-with-silent-modifications
9564 (org-with-wide-buffer
9565 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9566 ;; This is the default category for the buffer. If none is
9567 ;; found, fall-back to `org-category' or buffer file name.
9568 (put-text-property
9569 (point-min) (point-max)
9570 'org-category
9571 (catch 'buffer-category
9572 (goto-char (point-max))
9573 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9574 (let ((element (org-element-at-point)))
9575 (when (eq (org-element-type element) 'keyword)
9576 (throw 'buffer-category
9577 (org-element-property :value element)))))
9578 default-category))
9579 ;; Set sub-tree specific categories.
9580 (goto-char (point-min))
9581 (let ((regexp (org-re-property "CATEGORY")))
9582 (while (re-search-forward regexp nil t)
9583 (let ((value (org-match-string-no-properties 3)))
9584 (when (org-at-property-p)
9585 (put-text-property
9586 (save-excursion (org-back-to-heading t) (point))
9587 (save-excursion (org-end-of-subtree t t) (point))
9588 'org-category
9589 value)))))))))
9591 (defun org-refresh-stats-properties ()
9592 "Refresh stats text properties in the buffer."
9593 (let (stats)
9594 (org-with-silent-modifications
9595 (save-excursion
9596 (save-restriction
9597 (widen)
9598 (goto-char (point-min))
9599 (while (re-search-forward
9600 (concat org-outline-regexp-bol ".*"
9601 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9602 nil t)
9603 (setq stats (cond ((equal (match-string 3) "0") 0)
9604 ((match-string 2)
9605 (/ (* (string-to-number (match-string 2)) 100)
9606 (string-to-number (match-string 3))))
9607 (t (string-to-number (match-string 1)))))
9608 (org-back-to-heading t)
9609 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9610 'org-stats stats)))))))
9612 (defun org-refresh-effort-properties ()
9613 "Refresh effort properties"
9614 (org-refresh-properties
9615 org-effort-property
9616 '((effort . identity)
9617 (effort-minutes . org-duration-string-to-minutes))))
9619 ;;;; Link Stuff
9621 ;;; Link abbreviations
9623 (defun org-link-expand-abbrev (link)
9624 "Apply replacements as defined in `org-link-abbrev-alist'."
9625 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9626 (let* ((key (match-string 1 link))
9627 (as (or (assoc key org-link-abbrev-alist-local)
9628 (assoc key org-link-abbrev-alist)))
9629 (tag (and (match-end 2) (match-string 3 link)))
9630 rpl)
9631 (if (not as)
9632 link
9633 (setq rpl (cdr as))
9634 (cond
9635 ((symbolp rpl) (funcall rpl tag))
9636 ((string-match "%(\\([^)]+\\))" rpl)
9637 (replace-match
9638 (save-match-data
9639 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9640 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9641 ((string-match "%h" rpl)
9642 (replace-match (url-hexify-string (or tag "")) t t rpl))
9643 (t (concat rpl tag)))))
9644 link))
9646 ;;; Storing and inserting links
9648 (defvar org-insert-link-history nil
9649 "Minibuffer history for links inserted with `org-insert-link'.")
9651 (defvar org-stored-links nil
9652 "Contains the links stored with `org-store-link'.")
9654 (defvar org-store-link-plist nil
9655 "Plist with info about the most recently link created with `org-store-link'.")
9657 (defvar org-link-protocols nil
9658 "Link protocols added to Org-mode using `org-add-link-type'.")
9660 (defvar org-store-link-functions nil
9661 "List of functions that are called to create and store a link.
9662 Each function will be called in turn until one returns a non-nil
9663 value. Each function should check if it is responsible for creating
9664 this link (for example by looking at the major mode).
9665 If not, it must exit and return nil.
9666 If yes, it should return a non-nil value after a calling
9667 `org-store-link-props' with a list of properties and values.
9668 Special properties are:
9670 :type The link prefix, like \"http\". This must be given.
9671 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9672 This is obligatory as well.
9673 :description Optional default description for the second pair
9674 of brackets in an Org-mode link. The user can still change
9675 this when inserting this link into an Org-mode buffer.
9677 In addition to these, any additional properties can be specified
9678 and then used in capture templates.")
9680 (defun org-add-link-type (type &optional follow export)
9681 "Add TYPE to the list of `org-link-types'.
9682 Re-compute all regular expressions depending on `org-link-types'
9684 FOLLOW and EXPORT are two functions.
9686 FOLLOW should take the link path as the single argument and do whatever
9687 is necessary to follow the link, for example find a file or display
9688 a mail message.
9690 EXPORT should format the link path for export to one of the export formats.
9691 It should be a function accepting three arguments:
9693 path the path of the link, the text after the prefix (like \"http:\")
9694 desc the description of the link, if any
9695 format the export format, a symbol like `html' or `latex' or `ascii'.
9697 The function may use the FORMAT information to return different values
9698 depending on the format. The return value will be put literally into
9699 the exported file. If the return value is nil, this means Org should
9700 do what it normally does with links which do not have EXPORT defined.
9702 Org mode has a built-in default for exporting links. If you are happy with
9703 this default, there is no need to define an export function for the link
9704 type. For a simple example of an export function, see `org-bbdb.el'."
9705 (add-to-list 'org-link-types type t)
9706 (org-make-link-regexps)
9707 (org-element-update-syntax)
9708 (if (assoc type org-link-protocols)
9709 (setcdr (assoc type org-link-protocols) (list follow export))
9710 (push (list type follow export) org-link-protocols)))
9712 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9713 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9715 ;;;###autoload
9716 (defun org-store-link (arg)
9717 "\\<org-mode-map>Store an org-link to the current location.
9718 This link is added to `org-stored-links' and can later be inserted
9719 into an Org buffer with \\[org-insert-link].
9721 For some link types, a prefix ARG is interpreted.
9722 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9723 For file links, ARG negates `org-context-in-file-links'.
9725 A double prefix ARG force skipping storing functions that are not
9726 part of Org's core.
9728 A triple prefix ARG force storing a link for each line in the
9729 active region."
9730 (interactive "P")
9731 (org-load-modules-maybe)
9732 (if (and (equal arg '(64)) (org-region-active-p))
9733 (save-excursion
9734 (let ((end (region-end)))
9735 (goto-char (region-beginning))
9736 (set-mark (point))
9737 (while (< (point-at-eol) end)
9738 (move-end-of-line 1) (activate-mark)
9739 (let (current-prefix-arg)
9740 (call-interactively 'org-store-link))
9741 (move-beginning-of-line 2)
9742 (set-mark (point)))))
9743 (org-with-limited-levels
9744 (setq org-store-link-plist nil)
9745 (let (link cpltxt desc description search
9746 txt custom-id agenda-link sfuns sfunsn)
9747 (cond
9749 ;; Store a link using an external link type
9750 ((and (not (equal arg '(16)))
9751 (setq sfuns
9752 (delq
9753 nil (mapcar (lambda (f)
9754 (let (fs) (if (funcall f) (push f fs))))
9755 org-store-link-functions))
9756 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9757 (or (and (cdr sfuns)
9758 (funcall (intern
9759 (completing-read
9760 "Which function for creating the link? "
9761 sfunsn nil t (car sfunsn)))))
9762 (funcall (caar sfuns)))
9763 (setq link (plist-get org-store-link-plist :link)
9764 desc (or (plist-get org-store-link-plist
9765 :description)
9766 link))))
9768 ;; Store a link from a source code buffer.
9769 ((org-src-edit-buffer-p)
9770 (cond
9771 ((save-excursion
9772 (beginning-of-line)
9773 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9774 "[ \t]*$")))
9775 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9776 ((org-called-interactively-p 'any)
9777 (let (label)
9778 (while (or (not label)
9779 (org-with-wide-buffer
9780 (goto-char (point-min))
9781 (re-search-forward
9782 (regexp-quote (format org-coderef-label-format label))
9783 nil t)))
9784 (when label (message "Label exists already") (sit-for 2))
9785 (setq label (read-string "Code line label: " label)))
9786 (end-of-line)
9787 (setq link (format org-coderef-label-format label))
9788 (let ((gc (- 79 (length link))))
9789 (if (< (current-column) gc) (org-move-to-column gc t)
9790 (insert " ")))
9791 (insert link)
9792 (setq link (concat "(" label ")") desc nil)))
9793 (t (setq link nil))))
9795 ;; We are in the agenda, link to referenced location
9796 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9797 (let ((m (or (get-text-property (point) 'org-hd-marker)
9798 (get-text-property (point) 'org-marker))))
9799 (when m
9800 (org-with-point-at m
9801 (setq agenda-link
9802 (if (org-called-interactively-p 'any)
9803 (call-interactively 'org-store-link)
9804 (org-store-link nil)))))))
9806 ((eq major-mode 'calendar-mode)
9807 (let ((cd (calendar-cursor-to-date)))
9808 (setq link
9809 (format-time-string
9810 (car org-time-stamp-formats)
9811 (apply 'encode-time
9812 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9813 nil nil nil))))
9814 (org-store-link-props :type "calendar" :date cd)))
9816 ((eq major-mode 'help-mode)
9817 (setq link (concat "help:" (save-excursion
9818 (goto-char (point-min))
9819 (looking-at "^[^ ]+")
9820 (match-string 0))))
9821 (org-store-link-props :type "help"))
9823 ((eq major-mode 'w3-mode)
9824 (setq cpltxt (if (and (buffer-name)
9825 (not (string-match "Untitled" (buffer-name))))
9826 (buffer-name)
9827 (url-view-url t))
9828 link (url-view-url t))
9829 (org-store-link-props :type "w3" :url (url-view-url t)))
9831 ((eq major-mode 'image-mode)
9832 (setq cpltxt (concat "file:"
9833 (abbreviate-file-name buffer-file-name))
9834 link cpltxt)
9835 (org-store-link-props :type "image" :file buffer-file-name))
9837 ;; In dired, store a link to the file of the current line
9838 ((derived-mode-p 'dired-mode)
9839 (let ((file (dired-get-filename nil t)))
9840 (setq file (if file
9841 (abbreviate-file-name
9842 (expand-file-name (dired-get-filename nil t)))
9843 ;; otherwise, no file so use current directory.
9844 default-directory))
9845 (setq cpltxt (concat "file:" file)
9846 link cpltxt)))
9848 ((setq search (run-hook-with-args-until-success
9849 'org-create-file-search-functions))
9850 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9851 "::" search))
9852 (setq cpltxt (or description link)))
9854 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9855 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9856 (cond
9857 ;; Store a link using the target at point
9858 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9859 (setq cpltxt
9860 (concat "file:"
9861 (abbreviate-file-name
9862 (buffer-file-name (buffer-base-buffer)))
9863 "::" (match-string 1))
9864 link cpltxt))
9865 ((and (featurep 'org-id)
9866 (or (eq org-id-link-to-org-use-id t)
9867 (and (org-called-interactively-p 'any)
9868 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9869 (and (eq org-id-link-to-org-use-id
9870 'create-if-interactive-and-no-custom-id)
9871 (not custom-id))))
9872 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9873 ;; Store a link using the ID at point
9874 (setq link (condition-case nil
9875 (prog1 (org-id-store-link)
9876 (setq desc (or (plist-get org-store-link-plist
9877 :description)
9878 "")))
9879 (error
9880 ;; Probably before first headline, link only to file
9881 (concat "file:"
9882 (abbreviate-file-name
9883 (buffer-file-name (buffer-base-buffer))))))))
9885 ;; Just link to current headline
9886 (setq cpltxt (concat "file:"
9887 (abbreviate-file-name
9888 (buffer-file-name (buffer-base-buffer)))))
9889 ;; Add a context search string
9890 (when (org-xor org-context-in-file-links arg)
9891 (let* ((ee (org-element-at-point))
9892 (et (org-element-type ee))
9893 (ev (plist-get (cadr ee) :value))
9894 (ek (plist-get (cadr ee) :key))
9895 (eok (and (stringp ek) (string-match "name" ek))))
9896 (setq txt (cond
9897 ((org-at-heading-p) nil)
9898 ((and (eq et 'keyword) eok) ev)
9899 ((org-region-active-p)
9900 (buffer-substring (region-beginning) (region-end)))))
9901 (when (or (null txt) (string-match "\\S-" txt))
9902 (setq cpltxt
9903 (concat cpltxt "::"
9904 (condition-case nil
9905 (org-make-org-heading-search-string txt)
9906 (error "")))
9907 desc (or (and (eq et 'keyword) eok ev)
9908 (nth 4 (ignore-errors (org-heading-components)))
9909 "NONE")))))
9910 (if (string-match "::\\'" cpltxt)
9911 (setq cpltxt (substring cpltxt 0 -2)))
9912 (setq link cpltxt))))
9914 ((buffer-file-name (buffer-base-buffer))
9915 ;; Just link to this file here.
9916 (setq cpltxt (concat "file:"
9917 (abbreviate-file-name
9918 (buffer-file-name (buffer-base-buffer)))))
9919 ;; Add a context string.
9920 (when (org-xor org-context-in-file-links arg)
9921 (setq txt (if (org-region-active-p)
9922 (buffer-substring (region-beginning) (region-end))
9923 (buffer-substring (point-at-bol) (point-at-eol))))
9924 ;; Only use search option if there is some text.
9925 (when (string-match "\\S-" txt)
9926 (setq cpltxt
9927 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9928 desc "NONE")))
9929 (setq link cpltxt))
9931 ((org-called-interactively-p 'interactive)
9932 (user-error "No method for storing a link from this buffer"))
9934 (t (setq link nil)))
9936 ;; We're done setting link and desc, clean up
9937 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9938 (setq link (or link cpltxt)
9939 desc (or desc cpltxt))
9940 (cond ((equal desc "NONE") (setq desc nil))
9941 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9942 (let ((d0 (match-string 3 desc))
9943 (p0 (match-string 5 desc)))
9944 (setq desc
9945 (replace-regexp-in-string
9946 org-bracket-link-regexp
9947 (concat (or p0 d0)
9948 (if (equal (length (match-string 0 desc))
9949 (length desc)) "*" "")) desc)))))
9951 ;; Return the link
9952 (if (not (and (or (org-called-interactively-p 'any)
9953 executing-kbd-macro)
9954 link))
9955 (or agenda-link (and link (org-make-link-string link desc)))
9956 (push (list link desc) org-stored-links)
9957 (message "Stored: %s" (or desc link))
9958 (when custom-id
9959 (setq link (concat "file:" (abbreviate-file-name
9960 (buffer-file-name)) "::#" custom-id))
9961 (push (list link desc) org-stored-links))
9962 (car org-stored-links))))))
9964 (defun org-store-link-props (&rest plist)
9965 "Store link properties, extract names and addresses."
9966 (let (x adr)
9967 (when (setq x (plist-get plist :from))
9968 (setq adr (mail-extract-address-components x))
9969 (setq plist (plist-put plist :fromname (car adr)))
9970 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9971 (when (setq x (plist-get plist :to))
9972 (setq adr (mail-extract-address-components x))
9973 (setq plist (plist-put plist :toname (car adr)))
9974 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9975 (let ((from (plist-get plist :from))
9976 (to (plist-get plist :to)))
9977 (when (and from to org-from-is-user-regexp)
9978 (setq plist
9979 (plist-put plist :fromto
9980 (if (string-match org-from-is-user-regexp from)
9981 (concat "to %t")
9982 (concat "from %f"))))))
9983 (setq org-store-link-plist plist))
9985 (defun org-add-link-props (&rest plist)
9986 "Add these properties to the link property list."
9987 (let (key value)
9988 (while plist
9989 (setq key (pop plist) value (pop plist))
9990 (setq org-store-link-plist
9991 (plist-put org-store-link-plist key value)))))
9993 (defun org-email-link-description (&optional fmt)
9994 "Return the description part of an email link.
9995 This takes information from `org-store-link-plist' and formats it
9996 according to FMT (default from `org-email-link-description-format')."
9997 (setq fmt (or fmt org-email-link-description-format))
9998 (let* ((p org-store-link-plist)
9999 (to (plist-get p :toaddress))
10000 (from (plist-get p :fromaddress))
10001 (table
10002 (list
10003 (cons "%c" (plist-get p :fromto))
10004 (cons "%F" (plist-get p :from))
10005 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
10006 (cons "%T" (plist-get p :to))
10007 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
10008 (cons "%s" (plist-get p :subject))
10009 (cons "%d" (plist-get p :date))
10010 (cons "%m" (plist-get p :message-id)))))
10011 (when (string-match "%c" fmt)
10012 ;; Check if the user wrote this message
10013 (if (and org-from-is-user-regexp from to
10014 (save-match-data (string-match org-from-is-user-regexp from)))
10015 (setq fmt (replace-match "to %t" t t fmt))
10016 (setq fmt (replace-match "from %f" t t fmt))))
10017 (org-replace-escapes fmt table)))
10019 (defun org-make-org-heading-search-string (&optional string)
10020 "Make search string for the current headline or STRING."
10021 (let ((s (or string
10022 (and (derived-mode-p 'org-mode)
10023 (save-excursion
10024 (org-back-to-heading t)
10025 (org-element-property :raw-value (org-element-at-point))))))
10026 (lines org-context-in-file-links))
10027 (or string (setq s (concat "*" s))) ; Add * for headlines
10028 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10029 (when (and string (integerp lines) (> lines 0))
10030 (let ((slines (org-split-string s "\n")))
10031 (when (< lines (length slines))
10032 (setq s (mapconcat
10033 'identity
10034 (reverse (nthcdr (- (length slines) lines)
10035 (reverse slines))) "\n")))))
10036 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10038 (defun org-make-link-string (link &optional description)
10039 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10040 (unless (org-string-nw-p link) (error "Empty link"))
10041 (let ((uri (cond ((string-match org-link-types-re link)
10042 (concat (match-string 1 link)
10043 (org-link-escape (substring link (match-end 1)))))
10044 ;; For readability, url-encode internal links only
10045 ;; when absolutely needed (i.e, when they contain
10046 ;; square brackets). File links however, are
10047 ;; encoded since, e.g., spaces are significant.
10048 ((or (file-name-absolute-p link)
10049 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10050 (org-link-escape link))
10051 (t link)))
10052 (description
10053 (and (org-string-nw-p description)
10054 ;; Remove brackets from description, as they are fatal.
10055 (replace-regexp-in-string
10056 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10057 (org-trim description)))))
10058 (format "[[%s]%s]"
10060 (if description (format "[%s]" description) ""))))
10062 (defconst org-link-escape-chars
10063 ;;%20 %5B %5D %25
10064 '(?\s ?\[ ?\] ?%)
10065 "List of characters that should be escaped in a link when stored to Org.
10066 This is the list that is used for internal purposes.")
10068 (defconst org-link-escape-chars-browser
10069 ;;%20 %22
10070 '(?\s ?\")
10071 "List of characters to be escaped before handing over to the browser.
10072 If you consider using this constant then you probably want to use
10073 the function `org-link-escape-browser' instead. See there why
10074 this constant is a candidate to be removed once Org drops support
10075 for Emacs 24.1 and 24.2.")
10077 (defun org-link-escape (text &optional table merge)
10078 "Return percent escaped representation of TEXT.
10079 TEXT is a string with the text to escape.
10080 Optional argument TABLE is a list with characters that should be
10081 escaped. When nil, `org-link-escape-chars' is used.
10082 If optional argument MERGE is set, merge TABLE into
10083 `org-link-escape-chars'."
10084 (let ((characters-to-encode
10085 (cond ((null table) org-link-escape-chars)
10086 (merge (append org-link-escape-chars table))
10087 (t table))))
10088 (mapconcat
10089 (lambda (c)
10090 (if (or (memq c characters-to-encode)
10091 (and org-url-hexify-p (or (< c 32) (> c 126))))
10092 (mapconcat (lambda (e) (format "%%%.2X" e))
10093 (or (encode-coding-char c 'utf-8)
10094 (error "Unable to percent escape character: %c" c))
10096 (char-to-string c)))
10097 text "")))
10099 (defun org-link-escape-browser (text)
10100 "Escape some characters before handing over to the browser.
10101 This function is a candidate to be removed together with the
10102 constant `org-link-escape-chars-browser' once Org drops support
10103 for Emacs 24.1 and 24.2. All calls to this function will have to
10104 be replaced with `url-encode-url' which is available since Emacs
10105 24.3.1."
10106 ;; Example with the Org link
10107 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10108 ;; to open the browser with +subject:"Release 8.2" filled into the
10109 ;; query field: In this case the variable TEXT contains the
10110 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10111 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10112 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10113 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10114 (if (fboundp 'url-encode-url)
10115 (url-encode-url text)
10116 (if (org-string-match-p
10117 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10118 text)
10119 (org-link-escape text org-link-escape-chars-browser)
10120 text)))
10122 (defun org-link-unescape (str)
10123 "Unhex hexified Unicode parts in string STR.
10124 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10125 reciprocal of `org-link-escape', which see."
10126 (if (org-string-nw-p str)
10127 (replace-regexp-in-string
10128 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10129 str))
10131 (defun org-link-unescape-compound (hex)
10132 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10133 Note: this function also decodes single byte encodings like
10134 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10135 (save-match-data
10136 (let* ((bytes (cdr (split-string hex "%")))
10137 (ret "")
10138 (eat 0)
10139 (sum 0))
10140 (while bytes
10141 (let* ((val (string-to-number (pop bytes) 16))
10142 (shift-xor
10143 (if (= 0 eat)
10144 (cond
10145 ((>= val 252) (cons 6 252))
10146 ((>= val 248) (cons 5 248))
10147 ((>= val 240) (cons 4 240))
10148 ((>= val 224) (cons 3 224))
10149 ((>= val 192) (cons 2 192))
10150 (t (cons 0 0)))
10151 (cons 6 128))))
10152 (if (>= val 192) (setq eat (car shift-xor)))
10153 (setq val (logxor val (cdr shift-xor)))
10154 (setq sum (+ (lsh sum (car shift-xor)) val))
10155 (if (> eat 0) (setq eat (- eat 1)))
10156 (cond
10157 ((= 0 eat) ;multi byte
10158 (setq ret (concat ret (org-char-to-string sum)))
10159 (setq sum 0))
10160 ((not bytes) ; single byte(s)
10161 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10162 ret)))
10164 (defun org-link-unescape-single-byte-sequence (hex)
10165 "Unhexify hex-encoded single byte character sequences."
10166 (mapconcat (lambda (byte)
10167 (char-to-string (string-to-number byte 16)))
10168 (cdr (split-string hex "%")) ""))
10170 (defun org-xor (a b)
10171 "Exclusive or."
10172 (if a (not b) b))
10174 (defun org-fixup-message-id-for-http (s)
10175 "Replace special characters in a message id, so it can be used in an http query."
10176 (when (string-match "%" s)
10177 (setq s (mapconcat (lambda (c)
10178 (if (eq c ?%)
10179 "%25"
10180 (char-to-string c)))
10181 s "")))
10182 (while (string-match "<" s)
10183 (setq s (replace-match "%3C" t t s)))
10184 (while (string-match ">" s)
10185 (setq s (replace-match "%3E" t t s)))
10186 (while (string-match "@" s)
10187 (setq s (replace-match "%40" t t s)))
10190 (defun org-link-prettify (link)
10191 "Return a human-readable representation of LINK.
10192 The car of LINK must be a raw link.
10193 The cdr of LINK must be either a link description or nil."
10194 (let ((desc (or (cadr link) "<no description>")))
10195 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10196 "<" (car link) ">")))
10198 ;;;###autoload
10199 (defun org-insert-link-global ()
10200 "Insert a link like Org-mode does.
10201 This command can be called in any mode to insert a link in Org-mode syntax."
10202 (interactive)
10203 (org-load-modules-maybe)
10204 (org-run-like-in-org-mode 'org-insert-link))
10206 (defun org-insert-all-links (arg &optional pre post)
10207 "Insert all links in `org-stored-links'.
10208 When a universal prefix, do not delete the links from `org-stored-links'.
10209 When `ARG' is a number, insert the last N link(s).
10210 `PRE' and `POST' are optional arguments to define a string to
10211 prepend or to append."
10212 (interactive "P")
10213 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10214 (links (copy-seq org-stored-links))
10215 (pr (or pre "- "))
10216 (po (or post "\n"))
10217 (cnt 1) l)
10218 (if (null org-stored-links)
10219 (message "No link to insert")
10220 (while (and (or (listp arg) (>= arg cnt))
10221 (setq l (if (listp arg)
10222 (pop links)
10223 (pop org-stored-links))))
10224 (setq cnt (1+ cnt))
10225 (insert pr)
10226 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10227 (insert po)))))
10229 (defun org-insert-last-stored-link (arg)
10230 "Insert the last link stored in `org-stored-links'."
10231 (interactive "p")
10232 (org-insert-all-links arg "" "\n"))
10234 (defun org-link-fontify-links-to-this-file ()
10235 "Fontify links to the current file in `org-stored-links'."
10236 (let ((f (buffer-file-name)) a b)
10237 (setq a (mapcar (lambda(l)
10238 (let ((ll (car l)))
10239 (when (and (string-match "^file:\\(.+\\)::" ll)
10240 (equal f (expand-file-name (match-string 1 ll))))
10241 ll)))
10242 org-stored-links))
10243 (when (featurep 'org-id)
10244 (setq b (mapcar (lambda(l)
10245 (let ((ll (car l)))
10246 (when (and (string-match "^id:\\(.+\\)$" ll)
10247 (equal f (expand-file-name
10248 (or (org-id-find-id-file
10249 (match-string 1 ll)) ""))))
10250 ll)))
10251 org-stored-links)))
10252 (mapcar (lambda(l)
10253 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10254 (delq nil (append a b)))))
10256 (defvar org-link-links-in-this-file nil)
10257 (defun org-insert-link (&optional complete-file link-location default-description)
10258 "Insert a link. At the prompt, enter the link.
10260 Completion can be used to insert any of the link protocol prefixes like
10261 http or ftp in use.
10263 The history can be used to select a link previously stored with
10264 `org-store-link'. When the empty string is entered (i.e. if you just
10265 press RET at the prompt), the link defaults to the most recently
10266 stored link. As SPC triggers completion in the minibuffer, you need to
10267 use M-SPC or C-q SPC to force the insertion of a space character.
10269 You will also be prompted for a description, and if one is given, it will
10270 be displayed in the buffer instead of the link.
10272 If there is already a link at point, this command will allow you to edit link
10273 and description parts.
10275 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10276 be selected using completion. The path to the file will be relative to the
10277 current directory if the file is in the current directory or a subdirectory.
10278 Otherwise, the link will be the absolute path as completed in the minibuffer
10279 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10280 option `org-link-file-path-type'.
10282 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10283 the current directory or below.
10285 With three \\[universal-argument] prefixes, negate the meaning of
10286 `org-keep-stored-link-after-insertion'.
10288 If `org-make-link-description-function' is non-nil, this function will be
10289 called with the link target, and the result will be the default
10290 link description.
10292 If the LINK-LOCATION parameter is non-nil, this value will be
10293 used as the link location instead of reading one interactively.
10295 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10296 be used as the default description."
10297 (interactive "P")
10298 (let* ((wcf (current-window-configuration))
10299 (origbuf (current-buffer))
10300 (region (if (org-region-active-p)
10301 (buffer-substring (region-beginning) (region-end))))
10302 (remove (and region (list (region-beginning) (region-end))))
10303 (desc region)
10304 tmphist ; byte-compile incorrectly complains about this
10305 (link link-location)
10306 (abbrevs org-link-abbrev-alist-local)
10307 entry file all-prefixes auto-desc)
10308 (cond
10309 (link-location) ; specified by arg, just use it.
10310 ((org-in-regexp org-bracket-link-regexp 1)
10311 ;; We do have a link at point, and we are going to edit it.
10312 (setq remove (list (match-beginning 0) (match-end 0)))
10313 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10314 (setq link (read-string "Link: "
10315 (org-link-unescape
10316 (org-match-string-no-properties 1)))))
10317 ((or (org-in-regexp org-angle-link-re)
10318 (org-in-regexp org-plain-link-re))
10319 ;; Convert to bracket link
10320 (setq remove (list (match-beginning 0) (match-end 0))
10321 link (read-string "Link: "
10322 (org-remove-angle-brackets (match-string 0)))))
10323 ((member complete-file '((4) (16)))
10324 ;; Completing read for file names.
10325 (setq link (org-file-complete-link complete-file)))
10327 ;; Read link, with completion for stored links.
10328 (org-link-fontify-links-to-this-file)
10329 (org-switch-to-buffer-other-window "*Org Links*")
10330 (with-current-buffer "*Org Links*"
10331 (erase-buffer)
10332 (insert "Insert a link.
10333 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10334 (when org-stored-links
10335 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10336 (insert (mapconcat 'org-link-prettify
10337 (reverse org-stored-links) "\n")))
10338 (goto-char (point-min)))
10339 (let ((cw (selected-window)))
10340 (select-window (get-buffer-window "*Org Links*" 'visible))
10341 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10342 (unless (pos-visible-in-window-p (point-max))
10343 (org-fit-window-to-buffer))
10344 (and (window-live-p cw) (select-window cw)))
10345 ;; Fake a link history, containing the stored links.
10346 (setq tmphist (append (mapcar 'car org-stored-links)
10347 org-insert-link-history))
10348 (setq all-prefixes (append (mapcar 'car abbrevs)
10349 (mapcar 'car org-link-abbrev-alist)
10350 org-link-types))
10351 (unwind-protect
10352 (progn
10353 (setq link
10354 (org-completing-read
10355 "Link: "
10356 (append
10357 (mapcar (lambda (x) (concat x ":"))
10358 all-prefixes)
10359 (mapcar 'car org-stored-links))
10360 nil nil nil
10361 'tmphist
10362 (caar org-stored-links)))
10363 (if (not (string-match "\\S-" link))
10364 (user-error "No link selected"))
10365 (mapc (lambda(l)
10366 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10367 org-stored-links)
10368 (if (or (member link all-prefixes)
10369 (and (equal ":" (substring link -1))
10370 (member (substring link 0 -1) all-prefixes)
10371 (setq link (substring link 0 -1))))
10372 (setq link (with-current-buffer origbuf
10373 (org-link-try-special-completion link)))))
10374 (set-window-configuration wcf)
10375 (kill-buffer "*Org Links*"))
10376 (setq entry (assoc link org-stored-links))
10377 (or entry (push link org-insert-link-history))
10378 (setq desc (or desc (nth 1 entry)))))
10380 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10381 (not org-keep-stored-link-after-insertion))
10382 (setq org-stored-links (delq (assoc link org-stored-links)
10383 org-stored-links)))
10385 (if (and (string-match org-plain-link-re link)
10386 (not (string-match org-ts-regexp link)))
10387 ;; URL-like link, normalize the use of angular brackets.
10388 (setq link (org-remove-angle-brackets link)))
10390 ;; Check if we are linking to the current file with a search
10391 ;; option If yes, simplify the link by using only the search
10392 ;; option.
10393 (when (and buffer-file-name
10394 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10395 (let* ((path (match-string 1 link))
10396 (case-fold-search nil)
10397 (search (match-string 2 link)))
10398 (save-match-data
10399 (if (equal (file-truename buffer-file-name) (file-truename path))
10400 ;; We are linking to this same file, with a search option
10401 (setq link search)))))
10403 ;; Check if we can/should use a relative path. If yes, simplify the link
10404 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10405 (let* ((type (match-string 1 link))
10406 (path (match-string 2 link))
10407 (origpath path)
10408 (case-fold-search nil))
10409 (cond
10410 ((or (eq org-link-file-path-type 'absolute)
10411 (equal complete-file '(16)))
10412 (setq path (abbreviate-file-name (expand-file-name path))))
10413 ((eq org-link-file-path-type 'noabbrev)
10414 (setq path (expand-file-name path)))
10415 ((eq org-link-file-path-type 'relative)
10416 (setq path (file-relative-name path)))
10418 (save-match-data
10419 (if (string-match (concat "^" (regexp-quote
10420 (expand-file-name
10421 (file-name-as-directory
10422 default-directory))))
10423 (expand-file-name path))
10424 ;; We are linking a file with relative path name.
10425 (setq path (substring (expand-file-name path)
10426 (match-end 0)))
10427 (setq path (abbreviate-file-name (expand-file-name path)))))))
10428 (setq link (concat type path))
10429 (if (equal desc origpath)
10430 (setq desc path))))
10432 (if org-make-link-description-function
10433 (setq desc
10434 (or (condition-case nil
10435 (funcall org-make-link-description-function link desc)
10436 (error (progn (message "Can't get link description from `%s'"
10437 (symbol-name org-make-link-description-function))
10438 (sit-for 2) nil)))
10439 (read-string "Description: " default-description)))
10440 (if default-description (setq desc default-description)
10441 (setq desc (or (and auto-desc desc)
10442 (read-string "Description: " desc)))))
10444 (unless (string-match "\\S-" desc) (setq desc nil))
10445 (if remove (apply 'delete-region remove))
10446 (insert (org-make-link-string link desc))))
10448 (defun org-link-try-special-completion (type)
10449 "If there is completion support for link type TYPE, offer it."
10450 (let ((fun (intern (concat "org-" type "-complete-link"))))
10451 (if (functionp fun)
10452 (funcall fun)
10453 (read-string "Link (no completion support): " (concat type ":")))))
10455 (defun org-file-complete-link (&optional arg)
10456 "Create a file link using completion."
10457 (let ((file (org-iread-file-name "File: "))
10458 (pwd (file-name-as-directory (expand-file-name ".")))
10459 (pwd1 (file-name-as-directory (abbreviate-file-name
10460 (expand-file-name ".")))))
10461 (cond ((equal arg '(16))
10462 (concat "file:"
10463 (abbreviate-file-name (expand-file-name file))))
10464 ((string-match
10465 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10466 (concat "file:" (match-string 1 file)))
10467 ((string-match
10468 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10469 (expand-file-name file))
10470 (concat "file:"
10471 (match-string 1 (expand-file-name file))))
10472 (t (concat "file:" file)))))
10474 (defun org-iread-file-name (&rest args)
10475 "Read-file-name using `ido-mode' speedup if available.
10476 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10477 See `read-file-name' for a description of parameters."
10478 (org-without-partial-completion
10479 (if (and org-completion-use-ido
10480 (fboundp 'ido-read-file-name)
10481 (org-bound-and-true-p ido-mode)
10482 (listp (nth 1 args)))
10483 (let ((ido-enter-matching-directory nil))
10484 (apply #'ido-read-file-name args))
10485 (apply #'read-file-name args))))
10487 (defun org-completing-read (&rest args)
10488 "Completing-read with SPACE being a normal character."
10489 (let ((enable-recursive-minibuffers t)
10490 (minibuffer-local-completion-map
10491 (copy-keymap minibuffer-local-completion-map)))
10492 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10493 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10494 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10495 (apply 'org-icompleting-read args)))
10497 (defun org-completing-read-no-i (&rest args)
10498 (let (org-completion-use-ido org-completion-use-iswitchb)
10499 (apply 'org-completing-read args)))
10501 (defun org-iswitchb-completing-read (prompt choices &rest args)
10502 "Use iswitch as a completing-read replacement to choose from choices.
10503 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10504 from."
10505 (let* ((iswitchb-use-virtual-buffers nil)
10506 (iswitchb-make-buflist-hook
10507 (lambda ()
10508 (setq iswitchb-temp-buflist choices))))
10509 (iswitchb-read-buffer prompt)))
10511 (defun org-icompleting-read (&rest args)
10512 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10513 Should be called like `completing-read'."
10514 (org-without-partial-completion
10515 (if (not (listp (nth 1 args)))
10516 ;; Ido only supports lists as the COLLECTION argument. Use
10517 ;; default completion function when second argument is not
10518 ;; a list.
10519 (apply #'completing-read args)
10520 (let ((ido-enter-matching-directory nil))
10521 (apply (cond ((and org-completion-use-ido
10522 (fboundp 'ido-completing-read)
10523 (org-bound-and-true-p ido-mode))
10524 #'ido-completing-read)
10525 ((and org-completion-use-iswitchb
10526 (org-bound-and-true-p iswitchb-mode))
10527 #'org-iswitchb-completing-read)
10528 (t #'completing-read))
10529 args)))))
10531 ;;; Opening/following a link
10533 (defvar org-link-search-failed nil)
10535 (defvar org-open-link-functions nil
10536 "Hook for functions finding a plain text link.
10537 These functions must take a single argument, the link content.
10538 They will be called for links that look like [[link text][description]]
10539 when LINK TEXT does not have a protocol like \"http:\" and does not look
10540 like a filename (e.g. \"./blue.png\").
10542 These functions will be called *before* Org attempts to resolve the
10543 link by doing text searches in the current buffer - so if you want a
10544 link \"[[target]]\" to still find \"<<target>>\", your function should
10545 handle this as a special case.
10547 When the function does handle the link, it must return a non-nil value.
10548 If it decides that it is not responsible for this link, it must return
10549 nil to indicate that that Org-mode can continue with other options
10550 like exact and fuzzy text search.")
10552 (defun org-next-link (&optional search-backward)
10553 "Move forward to the next link.
10554 If the link is in hidden text, expose it."
10555 (interactive "P")
10556 (when (and org-link-search-failed (eq this-command last-command))
10557 (goto-char (point-min))
10558 (message "Link search wrapped back to beginning of buffer"))
10559 (setq org-link-search-failed nil)
10560 (let* ((pos (point))
10561 (ct (org-context))
10562 (a (assoc :link ct))
10563 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10564 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10565 ((looking-at org-any-link-re)
10566 ;; Don't stay stuck at link without an org-link face
10567 (forward-char (if search-backward -1 1))))
10568 (if (funcall srch-fun org-any-link-re nil t)
10569 (progn
10570 (goto-char (match-beginning 0))
10571 (if (outline-invisible-p) (org-show-context)))
10572 (goto-char pos)
10573 (setq org-link-search-failed t)
10574 (message "No further link found"))))
10576 (defun org-previous-link ()
10577 "Move backward to the previous link.
10578 If the link is in hidden text, expose it."
10579 (interactive)
10580 (funcall 'org-next-link t))
10582 (defun org-translate-link (s)
10583 "Translate a link string if a translation function has been defined."
10584 (with-temp-buffer
10585 (insert (org-trim s))
10586 (org-trim (org-element-interpret-data (org-element-context)))))
10588 (defun org-translate-link-from-planner (type path)
10589 "Translate a link from Emacs Planner syntax so that Org can follow it.
10590 This is still an experimental function, your mileage may vary."
10591 (cond
10592 ((member type '("http" "https" "news" "ftp"))
10593 ;; standard Internet links are the same.
10594 nil)
10595 ((and (equal type "irc") (string-match "^//" path))
10596 ;; Planner has two / at the beginning of an irc link, we have 1.
10597 ;; We should have zero, actually....
10598 (setq path (substring path 1)))
10599 ((and (equal type "lisp") (string-match "^/" path))
10600 ;; Planner has a slash, we do not.
10601 (setq type "elisp" path (substring path 1)))
10602 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10603 ;; A typical message link. Planner has the id after the final slash,
10604 ;; we separate it with a hash mark
10605 (setq path (concat (match-string 1 path) "#"
10606 (org-remove-angle-brackets (match-string 2 path))))))
10607 (cons type path))
10609 (defun org-find-file-at-mouse (ev)
10610 "Open file link or URL at mouse."
10611 (interactive "e")
10612 (mouse-set-point ev)
10613 (org-open-at-point 'in-emacs))
10615 (defun org-open-at-mouse (ev)
10616 "Open file link or URL at mouse.
10617 See the docstring of `org-open-file' for details."
10618 (interactive "e")
10619 (mouse-set-point ev)
10620 (if (eq major-mode 'org-agenda-mode)
10621 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10622 (org-open-at-point))
10624 (defvar org-window-config-before-follow-link nil
10625 "The window configuration before following a link.
10626 This is saved in case the need arises to restore it.")
10628 ;;;###autoload
10629 (defun org-open-at-point-global ()
10630 "Follow a link like Org-mode does.
10631 This command can be called in any mode to follow a link that has
10632 Org-mode syntax."
10633 (interactive)
10634 (org-run-like-in-org-mode 'org-open-at-point))
10636 ;;;###autoload
10637 (defun org-open-link-from-string (s &optional arg reference-buffer)
10638 "Open a link in the string S, as if it was in Org-mode."
10639 (interactive "sLink: \nP")
10640 (let ((reference-buffer (or reference-buffer (current-buffer))))
10641 (with-temp-buffer
10642 (let ((org-inhibit-startup (not reference-buffer)))
10643 (org-mode)
10644 (insert s)
10645 (goto-char (point-min))
10646 (when reference-buffer
10647 (setq org-link-abbrev-alist-local
10648 (with-current-buffer reference-buffer
10649 org-link-abbrev-alist-local)))
10650 (org-open-at-point arg reference-buffer)))))
10652 (defvar org-open-at-point-functions nil
10653 "Hook that is run when following a link at point.
10655 Functions in this hook must return t if they identify and follow
10656 a link at point. If they don't find anything interesting at point,
10657 they must return nil.")
10659 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10660 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10661 (defun org-open-at-point (&optional arg reference-buffer)
10662 "Open link, timestamp, footnote or tags at point.
10664 When point is on a link, follow it. Normally, files will be
10665 opened by an appropriate application. If the optional prefix
10666 argument ARG is non-nil, Emacs will visit the file. With
10667 a double prefix argument, try to open outside of Emacs, in the
10668 application the system uses for this file type.
10670 When point is on a timestamp, open the agenda at the day
10671 specified.
10673 When point is a footnote definition, move to the first reference
10674 found. If it is on a reference, move to the associated
10675 definition.
10677 When point is on a headline, display a list of every link in the
10678 entry, so it is possible to pick one, or all, of them. If point
10679 is on a tag, call `org-tags-view' instead.
10681 When optional argument REFERENCE-BUFFER is non-nil, it should
10682 specify a buffer from where the link search should happen. This
10683 is used internally by `org-open-link-from-string'.
10685 On top of syntactically correct links, this function will open
10686 the link at point in comments or comment blocks and the first
10687 link in a property drawer line."
10688 (interactive "P")
10689 ;; On a code block, open block's results.
10690 (unless (call-interactively 'org-babel-open-src-block-result)
10691 (org-load-modules-maybe)
10692 (setq org-window-config-before-follow-link (current-window-configuration))
10693 (org-remove-occur-highlights nil nil t)
10694 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10695 (let* ((context
10696 ;; Only consider supported types, even if they are not
10697 ;; the closest one.
10698 (org-element-lineage
10699 (org-element-context)
10700 '(clock comment comment-block footnote-definition
10701 footnote-reference headline inlinetask keyword link
10702 node-property timestamp)
10704 (type (org-element-type context))
10705 (value (org-element-property :value context)))
10706 (cond
10707 ((not context) (user-error "No link found"))
10708 ;; Exception: open timestamps and links in properties
10709 ;; drawers, keywords and comments.
10710 ((memq type '(comment comment-block keyword node-property))
10711 (cond ((org-in-regexp org-any-link-re)
10712 (org-open-link-from-string (match-string-no-properties 0)))
10713 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10714 (org-follow-timestamp-link))
10715 (t (user-error "No link found"))))
10716 ;; On a headline or an inlinetask, but not on a timestamp,
10717 ;; a link, a footnote reference or on tags.
10718 ((and (memq type '(headline inlinetask))
10719 ;; Not on tags.
10720 (progn (save-excursion (beginning-of-line)
10721 (looking-at org-complex-heading-regexp))
10722 (or (not (match-beginning 5))
10723 (< (point) (match-beginning 5)))))
10724 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10725 (links (car data))
10726 (links-end (cdr data)))
10727 (if links
10728 (dolist (link (if (stringp links) (list links) links))
10729 (search-forward link nil links-end)
10730 (goto-char (match-beginning 0))
10731 (org-open-at-point))
10732 (require 'org-attach)
10733 (org-attach-reveal 'if-exists))))
10734 ;; On a clock line, make sure point is on the timestamp
10735 ;; before opening it.
10736 ((and (eq type 'clock)
10737 value
10738 (>= (point) (org-element-property :begin value))
10739 (<= (point) (org-element-property :end value)))
10740 (org-follow-timestamp-link))
10741 ;; Do nothing on white spaces after an object, unless point
10742 ;; is right after it.
10743 ((> (point)
10744 (save-excursion
10745 (goto-char (org-element-property :end context))
10746 (skip-chars-backward " \t")
10747 (point)))
10748 (user-error "No link found"))
10749 ((eq type 'timestamp) (org-follow-timestamp-link))
10750 ;; On tags within a headline or an inlinetask.
10751 ((and (memq type '(headline inlinetask))
10752 (progn (save-excursion (beginning-of-line)
10753 (looking-at org-complex-heading-regexp))
10754 (and (match-beginning 5)
10755 (>= (point) (match-beginning 5)))))
10756 (org-tags-view arg (substring (match-string 5) 0 -1)))
10757 ((eq type 'link)
10758 ;; When link is located within the description of another
10759 ;; link (e.g., an inline image), always open the parent
10760 ;; link.
10761 (let*((link (let ((up (org-element-property :parent context)))
10762 (if (eq (org-element-type up) 'link) up context)))
10763 (type (org-element-property :type link))
10764 (path (org-link-unescape (org-element-property :path link))))
10765 ;; Switch back to REFERENCE-BUFFER needed when called in
10766 ;; a temporary buffer through `org-open-link-from-string'.
10767 (with-current-buffer (or reference-buffer (current-buffer))
10768 (cond
10769 ((equal type "file")
10770 (if (string-match "[*?{]" (file-name-nondirectory path))
10771 (dired path)
10772 ;; Look into `org-link-protocols' in order to find
10773 ;; a DEDICATED-FUNCTION to open file. The function
10774 ;; will be applied on raw link instead of parsed
10775 ;; link due to the limitation in `org-add-link-type'
10776 ;; ("open" function called with a single argument).
10777 ;; If no such function is found, fallback to
10778 ;; `org-open-file'.
10780 ;; Note : "file+emacs" and "file+sys" types are
10781 ;; hard-coded in order to escape the previous
10782 ;; limitation.
10783 (let* ((option (org-element-property :search-option link))
10784 (app (org-element-property :application link))
10785 (dedicated-function
10786 (nth 1 (assoc app org-link-protocols))))
10787 (if dedicated-function
10788 (funcall dedicated-function
10789 (concat path
10790 (and option (concat "::" option))))
10791 (apply #'org-open-file
10792 path
10793 (cond (arg)
10794 ((equal app "emacs") 'emacs)
10795 ((equal app "sys") 'system))
10796 (cond ((not option) nil)
10797 ((org-string-match-p "\\`[0-9]+\\'" option)
10798 (list (string-to-number option)))
10799 (t (list nil
10800 (org-link-unescape option)))))))))
10801 ((assoc type org-link-protocols)
10802 (funcall (nth 1 (assoc type org-link-protocols)) path))
10803 ((equal type "help")
10804 (let ((f-or-v (intern path)))
10805 (cond ((fboundp f-or-v) (describe-function f-or-v))
10806 ((boundp f-or-v) (describe-variable f-or-v))
10807 (t (error "Not a known function or variable")))))
10808 ((member type '("http" "https" "ftp" "mailto" "news"))
10809 (browse-url (org-link-escape-browser (concat type ":" path))))
10810 ((equal type "doi")
10811 (browse-url
10812 (org-link-escape-browser (concat org-doi-server-url path))))
10813 ((equal type "message") (browse-url (concat type ":" path)))
10814 ((equal type "shell")
10815 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10816 (cmd path))
10817 (if (or (and (org-string-nw-p
10818 org-confirm-shell-link-not-regexp)
10819 (string-match
10820 org-confirm-shell-link-not-regexp cmd))
10821 (not org-confirm-shell-link-function)
10822 (funcall org-confirm-shell-link-function
10823 (format "Execute \"%s\" in shell? "
10824 (org-add-props cmd nil
10825 'face 'org-warning))))
10826 (progn
10827 (message "Executing %s" cmd)
10828 (shell-command cmd buf)
10829 (when (featurep 'midnight)
10830 (setq clean-buffer-list-kill-buffer-names
10831 (cons (buffer-name buf)
10832 clean-buffer-list-kill-buffer-names))))
10833 (user-error "Abort"))))
10834 ((equal type "elisp")
10835 (let ((cmd path))
10836 (if (or (and (org-string-nw-p
10837 org-confirm-elisp-link-not-regexp)
10838 (org-string-match-p
10839 org-confirm-elisp-link-not-regexp cmd))
10840 (not org-confirm-elisp-link-function)
10841 (funcall org-confirm-elisp-link-function
10842 (format "Execute \"%s\" as elisp? "
10843 (org-add-props cmd nil
10844 'face 'org-warning))))
10845 (message "%s => %s" cmd
10846 (if (eq (string-to-char cmd) ?\()
10847 (eval (read cmd))
10848 (call-interactively (read cmd))))
10849 (user-error "Abort"))))
10850 ((equal type "id")
10851 (require 'org-id)
10852 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10853 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10854 (unless (run-hook-with-args-until-success
10855 'org-open-link-functions path)
10856 (if (not arg) (org-mark-ring-push)
10857 (switch-to-buffer-other-window
10858 (org-get-buffer-for-internal-link (current-buffer))))
10859 (let ((destination
10860 (org-with-wide-buffer
10861 (if (equal type "radio")
10862 (org-search-radio-target
10863 (org-element-property :path link))
10864 (org-link-search
10865 (if (member type '("custom-id" "coderef"))
10866 (org-element-property :raw-link link)
10867 path)
10868 ;; Prevent fuzzy links from matching
10869 ;; themselves.
10870 (and (equal type "fuzzy")
10871 (+ 2 (org-element-property :begin link)))))
10872 (point))))
10873 (unless (and (<= (point-min) destination)
10874 (>= (point-max) destination))
10875 (widen))
10876 (goto-char destination))))
10877 (t (browse-url-at-point))))))
10878 ;; On a footnote reference or at a footnote definition's label.
10879 ((or (eq type 'footnote-reference)
10880 (and (eq type 'footnote-definition)
10881 (save-excursion
10882 ;; Do not validate action when point is on the
10883 ;; spaces right after the footnote label, in
10884 ;; order to be on par with behaviour on links.
10885 (skip-chars-forward " \t")
10886 (let ((begin
10887 (org-element-property :contents-begin context)))
10888 (if begin (< (point) begin)
10889 (= (org-element-property :post-affiliated context)
10890 (line-beginning-position)))))))
10891 (org-footnote-action))
10892 (t (user-error "No link found")))))
10893 (run-hook-with-args 'org-follow-link-hook)))
10895 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10896 "Offer links in the current entry and return the selected link.
10897 If there is only one link, return it.
10898 If NTH is an integer, return the NTH link found.
10899 If ZERO is a string, check also this string for a link, and if
10900 there is one, return it."
10901 (with-current-buffer buffer
10902 (save-excursion
10903 (save-restriction
10904 (widen)
10905 (goto-char marker)
10906 (let ((cnt ?0)
10907 (in-emacs (if (integerp nth) nil nth))
10908 have-zero end links link c)
10909 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10910 (push (match-string 0 zero) links)
10911 (setq cnt (1- cnt) have-zero t))
10912 (save-excursion
10913 (org-back-to-heading t)
10914 (setq end (save-excursion (outline-next-heading) (point)))
10915 (while (re-search-forward org-any-link-re end t)
10916 (push (match-string 0) links))
10917 (setq links (org-uniquify (reverse links))))
10918 (cond
10919 ((null links)
10920 (message "No links"))
10921 ((equal (length links) 1)
10922 (setq link (car links)))
10923 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10924 (setq link (nth (if have-zero nth (1- nth)) links)))
10925 (t ; we have to select a link
10926 (save-excursion
10927 (save-window-excursion
10928 (delete-other-windows)
10929 (with-output-to-temp-buffer "*Select Link*"
10930 (mapc (lambda (l)
10931 (if (not (string-match org-bracket-link-regexp l))
10932 (princ (format "[%c] %s\n" (incf cnt)
10933 (org-remove-angle-brackets l)))
10934 (if (match-end 3)
10935 (princ (format "[%c] %s (%s)\n" (incf cnt)
10936 (match-string 3 l) (match-string 1 l)))
10937 (princ (format "[%c] %s\n" (incf cnt)
10938 (match-string 1 l))))))
10939 links))
10940 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10941 (message "Select link to open, RET to open all:")
10942 (setq c (read-char-exclusive))
10943 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10944 (when (equal c ?q) (user-error "Abort"))
10945 (if (equal c ?\C-m)
10946 (setq link links)
10947 (setq nth (- c ?0))
10948 (if have-zero (setq nth (1+ nth)))
10949 (unless (and (integerp nth) (>= (length links) nth))
10950 (user-error "Invalid link selection"))
10951 (setq link (nth (1- nth) links)))))
10952 (cons link end))))))
10954 ;; TODO: These functions are deprecated since `org-open-at-point'
10955 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10956 (defun org-open-file-with-system (path)
10957 "Open file at PATH using the system way of opening it."
10958 (org-open-file path 'system))
10959 (defun org-open-file-with-emacs (path)
10960 "Open file at PATH in Emacs."
10961 (org-open-file path 'emacs))
10964 ;;; File search
10966 (defvar org-create-file-search-functions nil
10967 "List of functions to construct the right search string for a file link.
10968 These functions are called in turn with point at the location to
10969 which the link should point.
10971 A function in the hook should first test if it would like to
10972 handle this file type, for example by checking the `major-mode'
10973 or the file extension. If it decides not to handle this file, it
10974 should just return nil to give other functions a chance. If it
10975 does handle the file, it must return the search string to be used
10976 when following the link. The search string will be part of the
10977 file link, given after a double colon, and `org-open-at-point'
10978 will automatically search for it. If special measures must be
10979 taken to make the search successful, another function should be
10980 added to the companion hook `org-execute-file-search-functions',
10981 which see.
10983 A function in this hook may also use `setq' to set the variable
10984 `description' to provide a suggestion for the descriptive text to
10985 be used for this link when it gets inserted into an Org-mode
10986 buffer with \\[org-insert-link].")
10988 (defvar org-execute-file-search-functions nil
10989 "List of functions to execute a file search triggered by a link.
10991 Functions added to this hook must accept a single argument, the
10992 search string that was part of the file link, the part after the
10993 double colon. The function must first check if it would like to
10994 handle this search, for example by checking the `major-mode' or
10995 the file extension. If it decides not to handle this search, it
10996 should just return nil to give other functions a chance. If it
10997 does handle the search, it must return a non-nil value to keep
10998 other functions from trying.
11000 Each function can access the current prefix argument through the
11001 variable `current-prefix-arg'. Note that a single prefix is used
11002 to force opening a link in Emacs, so it may be good to only use a
11003 numeric or double prefix to guide the search function.
11005 In case this is needed, a function in this hook can also restore
11006 the window configuration before `org-open-at-point' was called using:
11008 (set-window-configuration org-window-config-before-follow-link)")
11010 (defun org-search-radio-target (target)
11011 "Search a radio target matching TARGET in current buffer.
11012 White spaces are not significant."
11013 (let ((re (format "<<<%s>>>"
11014 (mapconcat #'regexp-quote
11015 (org-split-string target "[ \t\n]+")
11016 "[ \t]+\\(?:\n[ \t]*\\)?")))
11017 (origin (point)))
11018 (goto-char (point-min))
11019 (catch :radio-match
11020 (while (re-search-forward re nil t)
11021 (backward-char)
11022 (let ((object (org-element-context)))
11023 (when (eq (org-element-type object) 'radio-target)
11024 (goto-char (org-element-property :begin object))
11025 (org-show-context 'link-search)
11026 (throw :radio-match nil))))
11027 (goto-char origin)
11028 (user-error "No match for radio target: %s" target))))
11030 (defun org-link-search (s &optional avoid-pos stealth)
11031 "Search for a search string S.
11033 If S starts with \"#\", it triggers a custom ID search.
11035 If S is enclosed within parenthesis, it initiates a coderef
11036 search.
11038 If S is surrounded by forward slashes, it is interpreted as
11039 a regular expression. In Org mode files, this will create an
11040 `org-occur' sparse tree. In ordinary files, `occur' will be used
11041 to list matches. If the current buffer is in `dired-mode', grep
11042 will be used to search in all files.
11044 When AVOID-POS is given, ignore matches near that position.
11046 When optional argument STEALTH is non-nil, do not modify
11047 visibility around point, thus ignoring `org-show-context-detail'
11048 variable.
11050 Search is case-insensitive and ignores white spaces. Return type
11051 of matched result, with is either `dedicated' or `fuzzy'."
11052 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11053 (let* ((case-fold-search t)
11054 (origin (point))
11055 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11056 (words (org-split-string s "[ \t\n]+"))
11057 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11058 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11059 type)
11060 (cond
11061 ;; Check if there are any special search functions.
11062 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11063 ((eq (string-to-char s) ?#)
11064 ;; Look for a custom ID S if S starts with "#".
11065 (let* ((id (substring normalized 1))
11066 (match (org-find-property "CUSTOM_ID" id)))
11067 (if match (progn (goto-char match) (setf type 'dedicated))
11068 (error "No match for custom ID: %s" id))))
11069 ((string-match "\\`(\\(.*\\))\\'" normalized)
11070 ;; Look for coderef targets if S is enclosed within parenthesis.
11071 (let ((coderef (match-string-no-properties 1 normalized))
11072 (re (substring s-single-re 1 -1)))
11073 (goto-char (point-min))
11074 (catch :coderef-match
11075 (while (re-search-forward re nil t)
11076 (let ((element (org-element-at-point)))
11077 (when (and (memq (org-element-type element)
11078 '(example-block src-block))
11079 ;; Build proper regexp according to current
11080 ;; block's label format.
11081 (let ((label-fmt
11082 (regexp-quote
11083 (or (org-element-property :label-fmt element)
11084 org-coderef-label-format))))
11085 (save-excursion
11086 (beginning-of-line)
11087 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11088 (format label-fmt coderef))))))
11089 (setq type 'dedicated)
11090 (goto-char (match-beginning 1))
11091 (throw :coderef-match nil))))
11092 (goto-char origin)
11093 (error "No match for coderef: %s" coderef))))
11094 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11095 ;; Look for a regular expression.
11096 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11097 (match-string 1 s)))
11098 ;; Fuzzy links.
11100 (let* ((starred (eq (string-to-char normalized) ?*))
11101 (headline-search (and (derived-mode-p 'org-mode)
11102 (or org-link-search-must-match-exact-headline
11103 starred))))
11104 (cond
11105 ;; Look for targets, only if not in a headline search.
11106 ((and (not starred)
11107 (let ((target (format "<<%s>>" s-multi-re)))
11108 (catch :target-match
11109 (goto-char (point-min))
11110 (while (re-search-forward target nil t)
11111 (backward-char)
11112 (let ((context (org-element-context)))
11113 (when (eq (org-element-type context) 'target)
11114 (setq type 'dedicated)
11115 (goto-char (org-element-property :begin context))
11116 (throw :target-match t))))
11117 nil))))
11118 ;; Look for elements named after S, only if not in a headline
11119 ;; search.
11120 ((and (not starred)
11121 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11122 (catch :name-match
11123 (goto-char (point-min))
11124 (while (re-search-forward name nil t)
11125 (let ((element (org-element-at-point)))
11126 (when (equal (org-split-string
11127 (org-element-property :name element)
11128 "[ \t]+")
11129 words)
11130 (setq type 'dedicated)
11131 (beginning-of-line)
11132 (throw :name-match t))))
11133 nil))))
11134 ;; Regular text search. Prefer headlines in Org mode
11135 ;; buffers.
11136 ((and (derived-mode-p 'org-mode)
11137 (let* ((wspace "[ \t]")
11138 (wspaceopt (concat wspace "*"))
11139 (cookie (concat "\\(?:"
11140 wspaceopt
11141 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11142 wspaceopt
11143 "\\)"))
11144 (sep (concat "\\(?:\\(?:" wspace "\\|" cookie "\\)+\\)"))
11145 (re (concat
11146 org-outline-regexp-bol
11147 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11148 "\\(?:\\[#.\\][ \t]+\\)?"
11149 "\\(?:" org-comment-string "[ \t]+\\)?"
11150 sep "?"
11151 (let ((title (mapconcat #'regexp-quote
11152 words
11153 sep)))
11154 (if starred (substring title 1) title))
11155 sep "?"
11156 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11157 "[ \t]*$")))
11158 (goto-char (point-min))
11159 (re-search-forward re nil t)))
11160 (goto-char (match-beginning 0))
11161 (setq type 'dedicated))
11162 ;; Offer to create non-existent headline depending on
11163 ;; `org-link-search-must-match-exact-headline'.
11164 ((and (derived-mode-p 'org-mode)
11165 (not org-link-search-inhibit-query)
11166 (eq org-link-search-must-match-exact-headline 'query-to-create)
11167 (yes-or-no-p "No match - create this as a new heading? "))
11168 (goto-char (point-max))
11169 (unless (bolp) (newline))
11170 (org-insert-heading nil t t)
11171 (insert s "\n")
11172 (beginning-of-line 0))
11173 ;; Only headlines are looked after. No need to process
11174 ;; further: throw an error.
11175 ((and (derived-mode-p 'org-mode)
11176 (or starred org-link-search-must-match-exact-headline))
11177 (goto-char origin)
11178 (error "No match for fuzzy expression: %s" normalized))
11179 ;; Regular text search.
11180 ((catch :fuzzy-match
11181 (goto-char (point-min))
11182 (while (re-search-forward s-multi-re nil t)
11183 ;; Skip match if it contains AVOID-POS or it is included
11184 ;; in a link with a description but outside the
11185 ;; description.
11186 (unless (or (and avoid-pos
11187 (<= (match-beginning 0) avoid-pos)
11188 (> (match-end 0) avoid-pos))
11189 (and (save-match-data
11190 (org-in-regexp org-bracket-link-regexp))
11191 (match-beginning 3)
11192 (or (> (match-beginning 3) (point))
11193 (<= (match-end 3) (point)))
11194 (org-element-lineage
11195 (save-match-data (org-element-context))
11196 '(link) t)))
11197 (goto-char (match-beginning 0))
11198 (setq type 'fuzzy)
11199 (throw :fuzzy-match t)))
11200 nil))
11201 ;; All failed. Throw an error.
11202 (t (goto-char origin)
11203 (error "No match for fuzzy expression: %s" normalized))))))
11204 ;; Disclose surroundings of match, if appropriate.
11205 (when (and (derived-mode-p 'org-mode) (not stealth))
11206 (org-show-context 'link-search))
11207 type))
11209 (defun org-get-buffer-for-internal-link (buffer)
11210 "Return a buffer to be used for displaying the link target of internal links."
11211 (cond
11212 ((not org-display-internal-link-with-indirect-buffer)
11213 buffer)
11214 ((string-match "(Clone)$" (buffer-name buffer))
11215 (message "Buffer is already a clone, not making another one")
11216 ;; we also do not modify visibility in this case
11217 buffer)
11218 (t ; make a new indirect buffer for displaying the link
11219 (let* ((bn (buffer-name buffer))
11220 (ibn (concat bn "(Clone)"))
11221 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11222 (with-current-buffer ib (org-overview))
11223 ib))))
11225 (defun org-do-occur (regexp &optional cleanup)
11226 "Call the Emacs command `occur'.
11227 If CLEANUP is non-nil, remove the printout of the regular expression
11228 in the *Occur* buffer. This is useful if the regex is long and not useful
11229 to read."
11230 (occur regexp)
11231 (when cleanup
11232 (let ((cwin (selected-window)) win beg end)
11233 (when (setq win (get-buffer-window "*Occur*"))
11234 (select-window win))
11235 (goto-char (point-min))
11236 (when (re-search-forward "match[a-z]+" nil t)
11237 (setq beg (match-end 0))
11238 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11239 (setq end (1- (match-beginning 0)))))
11240 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11241 (goto-char (point-min))
11242 (select-window cwin))))
11244 ;;; The mark ring for links jumps
11246 (defvar org-mark-ring nil
11247 "Mark ring for positions before jumps in Org-mode.")
11248 (defvar org-mark-ring-last-goto nil
11249 "Last position in the mark ring used to go back.")
11250 ;; Fill and close the ring
11251 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11252 (loop for i from 1 to org-mark-ring-length do
11253 (push (make-marker) org-mark-ring))
11254 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11255 org-mark-ring)
11257 (defun org-mark-ring-push (&optional pos buffer)
11258 "Put the current position or POS into the mark ring and rotate it."
11259 (interactive)
11260 (setq pos (or pos (point)))
11261 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11262 (move-marker (car org-mark-ring)
11263 (or pos (point))
11264 (or buffer (current-buffer)))
11265 (message "%s"
11266 (substitute-command-keys
11267 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11269 (defun org-mark-ring-goto (&optional n)
11270 "Jump to the previous position in the mark ring.
11271 With prefix arg N, jump back that many stored positions. When
11272 called several times in succession, walk through the entire ring.
11273 Org-mode commands jumping to a different position in the current file,
11274 or to another Org-mode file, automatically push the old position
11275 onto the ring."
11276 (interactive "p")
11277 (let (p m)
11278 (if (eq last-command this-command)
11279 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11280 (setq p org-mark-ring))
11281 (setq org-mark-ring-last-goto p)
11282 (setq m (car p))
11283 (org-pop-to-buffer-same-window (marker-buffer m))
11284 (goto-char m)
11285 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11287 (defun org-remove-angle-brackets (s)
11288 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11289 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11291 (defun org-add-angle-brackets (s)
11292 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11293 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11295 (defun org-remove-double-quotes (s)
11296 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11297 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11300 ;;; Following specific links
11302 (defun org-follow-timestamp-link ()
11303 "Open an agenda view for the time-stamp date/range at point."
11304 (cond
11305 ((org-at-date-range-p t)
11306 (let ((org-agenda-start-on-weekday)
11307 (t1 (match-string 1))
11308 (t2 (match-string 2)) tt1 tt2)
11309 (setq tt1 (time-to-days (org-time-string-to-time t1))
11310 tt2 (time-to-days (org-time-string-to-time t2)))
11311 (let ((org-agenda-buffer-tmp-name
11312 (format "*Org Agenda(a:%s)"
11313 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11314 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11315 ((org-at-timestamp-p t)
11316 (let ((org-agenda-buffer-tmp-name
11317 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11318 (org-agenda-list nil (time-to-days (org-time-string-to-time
11319 (substring (match-string 1) 0 10)))
11320 1)))
11321 (t (error "This should not happen"))))
11324 ;;; Following file links
11325 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11326 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11327 (declare-function mailcap-mime-info
11328 "mailcap" (string &optional request no-decode))
11329 (defvar org-wait nil)
11330 (defun org-open-file (path &optional in-emacs line search)
11331 "Open the file at PATH.
11332 First, this expands any special file name abbreviations. Then the
11333 configuration variable `org-file-apps' is checked if it contains an
11334 entry for this file type, and if yes, the corresponding command is launched.
11336 If no application is found, Emacs simply visits the file.
11338 With optional prefix argument IN-EMACS, Emacs will visit the file.
11339 With a double \\[universal-argument] \\[universal-argument] \
11340 prefix arg, Org tries to avoid opening in Emacs
11341 and to use an external application to visit the file.
11343 Optional LINE specifies a line to go to, optional SEARCH a string
11344 to search for. If LINE or SEARCH is given, the file will be
11345 opened in Emacs, unless an entry from org-file-apps that makes
11346 use of groups in a regexp matches.
11348 If you want to change the way frames are used when following a
11349 link, please customize `org-link-frame-setup'.
11351 If the file does not exist, an error is thrown."
11352 (let* ((file (if (equal path "")
11353 buffer-file-name
11354 (substitute-in-file-name (expand-file-name path))))
11355 (file-apps (append org-file-apps (org-default-apps)))
11356 (apps (org-remove-if
11357 'org-file-apps-entry-match-against-dlink-p file-apps))
11358 (apps-dlink (org-remove-if-not
11359 'org-file-apps-entry-match-against-dlink-p file-apps))
11360 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11361 (dirp (if remp nil (file-directory-p file)))
11362 (file (if (and dirp org-open-directory-means-index-dot-org)
11363 (concat (file-name-as-directory file) "index.org")
11364 file))
11365 (a-m-a-p (assq 'auto-mode apps))
11366 (dfile (downcase file))
11367 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11368 (link (cond ((and (eq line nil)
11369 (eq search nil))
11370 file)
11371 (line
11372 (concat file "::" (number-to-string line)))
11373 (search
11374 (concat file "::" search))))
11375 (dlink (downcase link))
11376 (old-buffer (current-buffer))
11377 (old-pos (point))
11378 (old-mode major-mode)
11379 ext cmd link-match-data)
11380 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11381 (setq ext (match-string 1 dfile))
11382 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11383 (setq ext (match-string 1 dfile))))
11384 (cond
11385 ((member in-emacs '((16) system))
11386 (setq cmd (cdr (assoc 'system apps))))
11387 (in-emacs (setq cmd 'emacs))
11389 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11390 (and dirp (cdr (assoc 'directory apps)))
11391 ; first, try matching against apps-dlink
11392 ; if we get a match here, store the match data for later
11393 (let ((match (assoc-default dlink apps-dlink
11394 'string-match)))
11395 (if match
11396 (progn (setq link-match-data (match-data))
11397 match)
11398 (progn (setq in-emacs (or in-emacs line search))
11399 nil))) ; if we have no match in apps-dlink,
11400 ; always open the file in emacs if line or search
11401 ; is given (for backwards compatibility)
11402 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11403 'string-match)
11404 (cdr (assoc ext apps))
11405 (cdr (assoc t apps))))))
11406 (when (eq cmd 'system)
11407 (setq cmd (cdr (assoc 'system apps))))
11408 (when (eq cmd 'default)
11409 (setq cmd (cdr (assoc t apps))))
11410 (when (eq cmd 'mailcap)
11411 (require 'mailcap)
11412 (mailcap-parse-mailcaps)
11413 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11414 (command (mailcap-mime-info mime-type)))
11415 (if (stringp command)
11416 (setq cmd command)
11417 (setq cmd 'emacs))))
11418 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11419 (not (file-exists-p file))
11420 (not org-open-non-existing-files))
11421 (user-error "No such file: %s" file))
11422 (cond
11423 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11424 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11425 (while (string-match "['\"]%s['\"]" cmd)
11426 (setq cmd (replace-match "%s" t t cmd)))
11427 (while (string-match "%s" cmd)
11428 (setq cmd (replace-match
11429 (save-match-data
11430 (shell-quote-argument
11431 (convert-standard-filename file)))
11432 t t cmd)))
11434 ;; Replace "%1", "%2" etc. in command with group matches from regex
11435 (save-match-data
11436 (let ((match-index 1)
11437 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11438 (set-match-data link-match-data)
11439 (while (<= match-index number-of-groups)
11440 (let ((regex (concat "%" (number-to-string match-index)))
11441 (replace-with (match-string match-index dlink)))
11442 (while (string-match regex cmd)
11443 (setq cmd (replace-match replace-with t t cmd))))
11444 (setq match-index (+ match-index 1)))))
11446 (save-window-excursion
11447 (message "Running %s...done" cmd)
11448 (start-process-shell-command cmd nil cmd)
11449 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11450 ((or (stringp cmd)
11451 (eq cmd 'emacs))
11452 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11453 (widen)
11454 (if line (progn (org-goto-line line)
11455 (if (derived-mode-p 'org-mode)
11456 (org-reveal)))
11457 (if search (org-link-search search))))
11458 ((consp cmd)
11459 (let ((file (convert-standard-filename file)))
11460 (save-match-data
11461 (set-match-data link-match-data)
11462 (eval cmd))))
11463 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11464 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11465 (or (not (equal old-buffer (current-buffer)))
11466 (not (equal old-pos (point))))
11467 (org-mark-ring-push old-pos old-buffer))))
11469 (defun org-file-apps-entry-match-against-dlink-p (entry)
11470 "This function returns non-nil if `entry' uses a regular
11471 expression which should be matched against the whole link by
11472 org-open-file.
11474 It assumes that is the case when the entry uses a regular
11475 expression which has at least one grouping construct and the
11476 action is either a lisp form or a command string containing
11477 `%1', i.e. using at least one subexpression match as a
11478 parameter."
11479 (let ((selector (car entry))
11480 (action (cdr entry)))
11481 (if (stringp selector)
11482 (and (> (regexp-opt-depth selector) 0)
11483 (or (and (stringp action)
11484 (string-match "%[0-9]" action))
11485 (consp action)))
11486 nil)))
11488 (defun org-default-apps ()
11489 "Return the default applications for this operating system."
11490 (cond
11491 ((eq system-type 'darwin)
11492 org-file-apps-defaults-macosx)
11493 ((eq system-type 'windows-nt)
11494 org-file-apps-defaults-windowsnt)
11495 (t org-file-apps-defaults-gnu)))
11497 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11498 "Convert extensions to regular expressions in the cars of LIST.
11499 Also, weed out any non-string entries, because the return value is used
11500 only for regexp matching.
11501 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11502 point to the symbol `emacs', indicating that the file should
11503 be opened in Emacs."
11504 (append
11505 (delq nil
11506 (mapcar (lambda (x)
11507 (if (not (stringp (car x)))
11509 (if (string-match "\\W" (car x))
11511 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11512 list))
11513 (if add-auto-mode
11514 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11516 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11517 (defun org-file-remote-p (file)
11518 "Test whether FILE specifies a location on a remote system.
11519 Return non-nil if the location is indeed remote.
11521 For example, the filename \"/user@host:/foo\" specifies a location
11522 on the system \"/user@host:\"."
11523 (cond ((fboundp 'file-remote-p)
11524 (file-remote-p file))
11525 ((fboundp 'tramp-handle-file-remote-p)
11526 (tramp-handle-file-remote-p file))
11527 ((and (boundp 'ange-ftp-name-format)
11528 (string-match (car ange-ftp-name-format) file))
11529 t)))
11532 ;;;; Refiling
11534 (defun org-get-org-file ()
11535 "Read a filename, with default directory `org-directory'."
11536 (let ((default (or org-default-notes-file remember-data-file)))
11537 (read-file-name (format "File name [%s]: " default)
11538 (file-name-as-directory org-directory)
11539 default)))
11541 (defun org-notes-order-reversed-p ()
11542 "Check if the current file should receive notes in reversed order."
11543 (cond
11544 ((not org-reverse-note-order) nil)
11545 ((eq t org-reverse-note-order) t)
11546 ((not (listp org-reverse-note-order)) nil)
11547 (t (catch 'exit
11548 (dolist (entry org-reverse-note-order)
11549 (if (string-match (car entry) buffer-file-name)
11550 (throw 'exit (cdr entry))))))))
11552 (defvar org-refile-target-table nil
11553 "The list of refile targets, created by `org-refile'.")
11555 (defvar org-agenda-new-buffers nil
11556 "Buffers created to visit agenda files.")
11558 (defvar org-refile-cache nil
11559 "Cache for refile targets.")
11561 (defvar org-refile-markers nil
11562 "All the markers used for caching refile locations.")
11564 (defun org-refile-marker (pos)
11565 "Get a new refile marker, but only if caching is in use."
11566 (if (not org-refile-use-cache)
11568 (let ((m (make-marker)))
11569 (move-marker m pos)
11570 (push m org-refile-markers)
11571 m)))
11573 (defun org-refile-cache-clear ()
11574 "Clear the refile cache and disable all the markers."
11575 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11576 (setq org-refile-markers nil)
11577 (setq org-refile-cache nil)
11578 (message "Refile cache has been cleared"))
11580 (defun org-refile-cache-check-set (set)
11581 "Check if all the markers in the cache still have live buffers."
11582 (let (marker)
11583 (catch 'exit
11584 (while (and set (setq marker (nth 3 (pop set))))
11585 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11586 (when (and marker (null (marker-buffer marker)))
11587 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11588 (sit-for 3)
11589 (throw 'exit nil)))
11590 t)))
11592 (defun org-refile-cache-put (set &rest identifiers)
11593 "Push the refile targets SET into the cache, under IDENTIFIERS."
11594 (let* ((key (sha1 (prin1-to-string identifiers)))
11595 (entry (assoc key org-refile-cache)))
11596 (if entry
11597 (setcdr entry set)
11598 (push (cons key set) org-refile-cache))))
11600 (defun org-refile-cache-get (&rest identifiers)
11601 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11602 (cond
11603 ((not org-refile-cache) nil)
11604 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11606 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11607 org-refile-cache))))
11608 (and set (org-refile-cache-check-set set) set)))))
11610 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11611 "Produce a table with refile targets."
11612 (let ((case-fold-search nil)
11613 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11614 (entries (or org-refile-targets '((nil . (:level . 1)))))
11615 targets tgs txt re files desc descre fast-path-p level pos0)
11616 (message "Getting targets...")
11617 (with-current-buffer (or default-buffer (current-buffer))
11618 (dolist (entry entries)
11619 (setq files (car entry) desc (cdr entry))
11620 (setq fast-path-p nil)
11621 (cond
11622 ((null files) (setq files (list (current-buffer))))
11623 ((eq files 'org-agenda-files)
11624 (setq files (org-agenda-files 'unrestricted)))
11625 ((and (symbolp files) (fboundp files))
11626 (setq files (funcall files)))
11627 ((and (symbolp files) (boundp files))
11628 (setq files (symbol-value files))))
11629 (if (stringp files) (setq files (list files)))
11630 (cond
11631 ((eq (car desc) :tag)
11632 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11633 ((eq (car desc) :todo)
11634 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11635 ((eq (car desc) :regexp)
11636 (setq descre (cdr desc)))
11637 ((eq (car desc) :level)
11638 (setq descre (concat "^\\*\\{" (number-to-string
11639 (if org-odd-levels-only
11640 (1- (* 2 (cdr desc)))
11641 (cdr desc)))
11642 "\\}[ \t]")))
11643 ((eq (car desc) :maxlevel)
11644 (setq fast-path-p t)
11645 (setq descre (concat "^\\*\\{1," (number-to-string
11646 (if org-odd-levels-only
11647 (1- (* 2 (cdr desc)))
11648 (cdr desc)))
11649 "\\}[ \t]")))
11650 (t (error "Bad refiling target description %s" desc)))
11651 (dolist (f files)
11652 (with-current-buffer
11653 (if (bufferp f) f (org-get-agenda-file-buffer f))
11655 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11656 (progn
11657 (if (bufferp f) (setq f (buffer-file-name
11658 (buffer-base-buffer f))))
11659 (setq f (and f (expand-file-name f)))
11660 (if (eq org-refile-use-outline-path 'file)
11661 (push (list (file-name-nondirectory f) f nil nil) tgs))
11662 (save-excursion
11663 (save-restriction
11664 (widen)
11665 (goto-char (point-min))
11666 (while (re-search-forward descre nil t)
11667 (goto-char (setq pos0 (point-at-bol)))
11668 (catch 'next
11669 (when org-refile-target-verify-function
11670 (save-match-data
11671 (or (funcall org-refile-target-verify-function)
11672 (throw 'next t))))
11673 (when (and (looking-at org-complex-heading-regexp)
11674 (not (member (match-string 4) excluded-entries))
11675 (match-string 4))
11676 (setq level (org-reduced-level
11677 (- (match-end 1) (match-beginning 1)))
11678 txt (org-link-display-format (match-string 4))
11679 txt (replace-regexp-in-string "\\( *[[0-9]+/?[0-9]*%?]\\)+$" "" txt)
11680 re (format org-complex-heading-regexp-format
11681 (regexp-quote (match-string 4))))
11682 (when org-refile-use-outline-path
11683 (setq txt (mapconcat
11684 'org-protect-slash
11685 (append
11686 (if (eq org-refile-use-outline-path
11687 'file)
11688 (list (file-name-nondirectory
11689 (buffer-file-name
11690 (buffer-base-buffer))))
11691 (if (eq org-refile-use-outline-path
11692 'full-file-path)
11693 (list (buffer-file-name
11694 (buffer-base-buffer)))))
11695 (org-get-outline-path fast-path-p
11696 level txt)
11697 (list txt))
11698 "/")))
11699 (push (list txt f re (org-refile-marker (point)))
11700 tgs)))
11701 (when (= (point) pos0)
11702 ;; verification function has not moved point
11703 (goto-char (point-at-eol))))))))
11704 (when org-refile-use-cache
11705 (org-refile-cache-put tgs (buffer-file-name) descre))
11706 (setq targets (append tgs targets))))))
11707 (message "Getting targets...done")
11708 (nreverse targets)))
11710 (defun org-protect-slash (s)
11711 (while (string-match "/" s)
11712 (setq s (replace-match "\\" t t s)))
11715 (defvar org-olpa (make-vector 20 nil))
11717 (defun org-get-outline-path (&optional fastp level heading)
11718 "Return the outline path to the current entry, as a list.
11720 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11721 routine which makes outline path derivations for an entire file,
11722 avoiding backtracing. Refile target collection makes use of that."
11723 (if fastp
11724 (progn
11725 (if (> level 19)
11726 (error "Outline path failure, more than 19 levels"))
11727 (loop for i from level upto 19 do
11728 (aset org-olpa i nil))
11729 (prog1
11730 (delq nil (append org-olpa nil))
11731 (aset org-olpa level heading)))
11732 (let (rtn case-fold-search)
11733 (save-excursion
11734 (save-restriction
11735 (widen)
11736 (while (org-up-heading-safe)
11737 (when (looking-at org-complex-heading-regexp)
11738 (push (org-trim
11739 (replace-regexp-in-string
11740 ;; Remove statistical/checkboxes cookies
11741 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11742 (org-match-string-no-properties 4)))
11743 rtn)))
11744 rtn)))))
11746 (defun org-format-outline-path (path &optional width prefix separator)
11747 "Format the outline path PATH for display.
11748 WIDTH is the maximum number of characters that is available.
11749 PREFIX is a prefix to be included in the returned string,
11750 such as the file name.
11751 SEPARATOR is inserted between the different parts of the path,
11752 the default is \"/\"."
11753 (setq width (or width 79))
11754 (unless (> width 0)
11755 (user-error "Argument `width' must be positive"))
11756 (setq separator (or separator "/"))
11757 (let* ((org-odd-levels-only nil)
11758 (fpath (concat
11759 prefix (and prefix path separator)
11760 (mapconcat
11761 (lambda (s) (replace-regexp-in-string "[ \t]+\\'" "" s))
11762 (loop for head in path
11763 for n from 0
11764 collect (org-add-props
11765 head nil 'face
11766 (nth (% n org-n-level-faces) org-level-faces)))
11767 separator))))
11768 (when (> (length fpath) width)
11769 (if (< width 7)
11770 ;; It's unlikely that `width' will be this small, but don't
11771 ;; waste characters by adding ".." if it is.
11772 (setq fpath (substring fpath 0 width))
11773 (setf (substring fpath (- width 2)) "..")))
11774 fpath))
11776 (defun org-display-outline-path (&optional file current separator just-return-string)
11777 "Display the current outline path in the echo area.
11779 If FILE is non-nil, prepend the output with the file name.
11780 If CURRENT is non-nil, append the current heading to the output.
11781 SEPARATOR is passed through to `org-format-outline-path'. It separates
11782 the different parts of the path and defaults to \"/\".
11783 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11784 (interactive "P")
11785 (let* (case-fold-search
11786 (bfn (buffer-file-name (buffer-base-buffer)))
11787 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11788 res)
11789 (if current (setq path (append path
11790 (save-excursion
11791 (org-back-to-heading t)
11792 (if (looking-at org-complex-heading-regexp)
11793 (list (match-string 4)))))))
11794 (setq res
11795 (org-format-outline-path
11796 path
11797 (1- (frame-width))
11798 (and file bfn (concat (file-name-nondirectory bfn) separator))
11799 separator))
11800 (if just-return-string
11801 (org-no-properties res)
11802 (org-unlogged-message "%s" res))))
11804 (defvar org-refile-history nil
11805 "History for refiling operations.")
11807 (defvar org-after-refile-insert-hook nil
11808 "Hook run after `org-refile' has inserted its stuff at the new location.
11809 Note that this is still *before* the stuff will be removed from
11810 the *old* location.")
11812 (defvar org-capture-last-stored-marker)
11813 (defvar org-refile-keep nil
11814 "Non-nil means `org-refile' will copy instead of refile.")
11816 (defun org-copy ()
11817 "Like `org-refile', but copy."
11818 (interactive)
11819 (let ((org-refile-keep t))
11820 (funcall 'org-refile nil nil nil "Copy")))
11822 (defun org-refile (&optional arg default-buffer rfloc msg)
11823 "Move the entry or entries at point to another heading.
11824 The list of target headings is compiled using the information in
11825 `org-refile-targets', which see.
11827 At the target location, the entry is filed as a subitem of the
11828 target heading. Depending on `org-reverse-note-order', the new
11829 subitem will either be the first or the last subitem.
11831 If there is an active region, all entries in that region will be
11832 refiled. However, the region must fulfill the requirement that
11833 the first heading sets the top-level of the moved text.
11835 With prefix arg ARG, the command will only visit the target
11836 location and not actually move anything.
11838 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11839 refiling operation has put the subtree.
11841 With a numeric prefix argument of `2', refile to the running clock.
11843 With a numeric prefix argument of `3', emulate `org-refile-keep'
11844 being set to t and copy to the target location, don't move it.
11845 Beware that keeping refiled entries may result in duplicated ID
11846 properties.
11848 RFLOC can be a refile location obtained in a different way.
11850 MSG is a string to replace \"Refile\" in the default prompt with
11851 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11853 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11855 If you are using target caching (see `org-refile-use-cache'), you
11856 have to clear the target cache in order to find new targets.
11857 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11858 prefix argument (`C-u C-u C-u C-c C-w')."
11859 (interactive "P")
11860 (if (member arg '(0 (64)))
11861 (org-refile-cache-clear)
11862 (let* ((actionmsg (cond (msg msg)
11863 ((equal arg 3) "Refile (and keep)")
11864 (t "Refile")))
11865 (cbuf (current-buffer))
11866 (regionp (org-region-active-p))
11867 (region-start (and regionp (region-beginning)))
11868 (region-end (and regionp (region-end)))
11869 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11870 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11871 pos it nbuf file re level reversed)
11872 (setq last-command nil)
11873 (when regionp
11874 (goto-char region-start)
11875 (or (bolp) (goto-char (point-at-bol)))
11876 (setq region-start (point))
11877 (unless (or (org-kill-is-subtree-p
11878 (buffer-substring region-start region-end))
11879 (prog1 org-refile-active-region-within-subtree
11880 (let ((s (point-at-eol)))
11881 (org-toggle-heading)
11882 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11883 (user-error "The region is not a (sequence of) subtree(s)")))
11884 (if (equal arg '(16))
11885 (org-refile-goto-last-stored)
11886 (when (or
11887 (and (equal arg 2)
11888 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11889 (prog1
11890 (setq it (list (or org-clock-heading "running clock")
11891 (buffer-file-name
11892 (marker-buffer org-clock-hd-marker))
11894 (marker-position org-clock-hd-marker)))
11895 (setq arg nil)))
11896 (setq it (or rfloc
11897 (let (heading-text)
11898 (save-excursion
11899 (unless (and arg (listp arg))
11900 (org-back-to-heading t)
11901 (setq heading-text
11902 (replace-regexp-in-string
11903 org-bracket-link-regexp
11904 "\\3"
11905 (nth 4 (org-heading-components)))))
11906 (org-refile-get-location
11907 (cond ((and arg (listp arg)) "Goto")
11908 (regionp (concat actionmsg " region to"))
11909 (t (concat actionmsg " subtree \""
11910 heading-text "\" to")))
11911 default-buffer
11912 (and (not (equal '(4) arg))
11913 org-refile-allow-creating-parent-nodes)
11914 arg))))))
11915 (setq file (nth 1 it)
11916 re (nth 2 it)
11917 pos (nth 3 it))
11918 (if (and (not arg)
11920 (equal (buffer-file-name) file)
11921 (if regionp
11922 (and (>= pos region-start)
11923 (<= pos region-end))
11924 (and (>= pos (point))
11925 (< pos (save-excursion
11926 (org-end-of-subtree t t))))))
11927 (error "Cannot refile to position inside the tree or region"))
11928 (setq nbuf (or (find-buffer-visiting file)
11929 (find-file-noselect file)))
11930 (if (and arg (not (equal arg 3)))
11931 (progn
11932 (org-pop-to-buffer-same-window nbuf)
11933 (goto-char pos)
11934 (org-show-context 'org-goto))
11935 (if regionp
11936 (progn
11937 (org-kill-new (buffer-substring region-start region-end))
11938 (org-save-markers-in-region region-start region-end))
11939 (org-copy-subtree 1 nil t))
11940 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11941 (find-file-noselect file)))
11942 (setq reversed (org-notes-order-reversed-p))
11943 (save-excursion
11944 (save-restriction
11945 (widen)
11946 (if pos
11947 (progn
11948 (goto-char pos)
11949 (looking-at org-outline-regexp)
11950 (setq level (org-get-valid-level (funcall outline-level) 1))
11951 (goto-char
11952 (if reversed
11953 (or (outline-next-heading) (point-max))
11954 (or (save-excursion (org-get-next-sibling))
11955 (org-end-of-subtree t t)
11956 (point-max)))))
11957 (setq level 1)
11958 (if (not reversed)
11959 (goto-char (point-max))
11960 (goto-char (point-min))
11961 (or (outline-next-heading) (goto-char (point-max)))))
11962 (if (not (bolp)) (newline))
11963 (org-paste-subtree level nil nil t)
11964 (when org-log-refile
11965 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11966 (unless (eq org-log-refile 'note)
11967 (save-excursion (org-add-log-note))))
11968 (and org-auto-align-tags
11969 (let ((org-loop-over-headlines-in-active-region nil))
11970 (org-set-tags nil t)))
11971 (let ((bookmark-name (plist-get org-bookmark-names-plist
11972 :last-refile)))
11973 (when bookmark-name
11974 (with-demoted-errors
11975 (bookmark-set bookmark-name))))
11976 ;; If we are refiling for capture, make sure that the
11977 ;; last-capture pointers point here
11978 (when (org-bound-and-true-p org-refile-for-capture)
11979 (let ((bookmark-name (plist-get org-bookmark-names-plist
11980 :last-capture-marker)))
11981 (when bookmark-name
11982 (with-demoted-errors
11983 (bookmark-set bookmark-name))))
11984 (move-marker org-capture-last-stored-marker (point)))
11985 (if (fboundp 'deactivate-mark) (deactivate-mark))
11986 (run-hooks 'org-after-refile-insert-hook))))
11987 (unless org-refile-keep
11988 (if regionp
11989 (delete-region (point) (+ (point) (- region-end region-start)))
11990 (delete-region
11991 (and (org-back-to-heading t) (point))
11992 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11993 (when (featurep 'org-inlinetask)
11994 (org-inlinetask-remove-END-maybe))
11995 (setq org-markers-to-move nil)
11996 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11998 (defun org-refile-goto-last-stored ()
11999 "Go to the location where the last refile was stored."
12000 (interactive)
12001 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
12002 (message "This is the location of the last refile"))
12004 (defun org-refile--get-location (refloc tbl)
12005 "When user refile to REFLOC, find the associated target in TBL.
12006 Also check `org-refile-target-table'."
12007 (car (delq
12009 (mapcar
12010 (lambda (r) (or (assoc r tbl)
12011 (assoc r org-refile-target-table)))
12012 (list (replace-regexp-in-string "/$" "" refloc)
12013 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
12015 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
12016 no-exclude)
12017 "Prompt the user for a refile location, using PROMPT.
12018 PROMPT should not be suffixed with a colon and a space, because
12019 this function appends the default value from
12020 `org-refile-history' automatically, if that is not empty.
12021 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12022 this is used for the GOTO interface."
12023 (let ((org-refile-targets org-refile-targets)
12024 (org-refile-use-outline-path org-refile-use-outline-path)
12025 excluded-entries)
12026 (when (and (derived-mode-p 'org-mode)
12027 (not org-refile-use-cache)
12028 (not no-exclude))
12029 (org-map-tree
12030 (lambda()
12031 (setq excluded-entries
12032 (append excluded-entries (list (org-get-heading t t)))))))
12033 (setq org-refile-target-table
12034 (org-refile-get-targets default-buffer excluded-entries)))
12035 (unless org-refile-target-table
12036 (user-error "No refile targets"))
12037 (let* ((cbuf (current-buffer))
12038 (partial-completion-mode nil)
12039 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12040 (cfunc (if (and org-refile-use-outline-path
12041 org-outline-path-complete-in-steps)
12042 'org-olpath-completing-read
12043 'org-icompleting-read))
12044 (extra (if org-refile-use-outline-path "/" ""))
12045 (cbnex (concat (buffer-name) extra))
12046 (filename (and cfn (expand-file-name cfn)))
12047 (tbl (mapcar
12048 (lambda (x)
12049 (if (and (not (member org-refile-use-outline-path
12050 '(file full-file-path)))
12051 (not (equal filename (nth 1 x))))
12052 (cons (concat (car x) extra " ("
12053 (file-name-nondirectory (nth 1 x)) ")")
12054 (cdr x))
12055 (cons (concat (car x) extra) (cdr x))))
12056 org-refile-target-table))
12057 (completion-ignore-case t)
12058 cdef
12059 (prompt (concat prompt
12060 (or (and (car org-refile-history)
12061 (concat " (default " (car org-refile-history) ")"))
12062 (and (assoc cbnex tbl) (setq cdef cbnex)
12063 (concat " (default " cbnex ")"))) ": "))
12064 pa answ parent-target child parent old-hist)
12065 (setq old-hist org-refile-history)
12066 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12067 nil 'org-refile-history (or cdef (car org-refile-history))))
12068 (if (setq pa (org-refile--get-location answ tbl))
12069 (progn
12070 (org-refile-check-position pa)
12071 (when (or (not org-refile-history)
12072 (not (eq old-hist org-refile-history))
12073 (not (equal (car pa) (car org-refile-history))))
12074 (setq org-refile-history
12075 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12076 org-refile-history
12077 (cdr org-refile-history))))
12078 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12079 (pop org-refile-history)))
12081 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12082 (progn
12083 (setq parent (match-string 1 answ)
12084 child (match-string 2 answ))
12085 (setq parent-target (org-refile--get-location parent tbl))
12086 (when (and parent-target
12087 (or (eq new-nodes t)
12088 (and (eq new-nodes 'confirm)
12089 (y-or-n-p (format "Create new node \"%s\"? "
12090 child)))))
12091 (org-refile-new-child parent-target child)))
12092 (user-error "Invalid target location")))))
12094 (declare-function org-string-nw-p "org-macs" (s))
12095 (defun org-refile-check-position (refile-pointer)
12096 "Check if the refile pointer matches the headline to which it points."
12097 (let* ((file (nth 1 refile-pointer))
12098 (re (nth 2 refile-pointer))
12099 (pos (nth 3 refile-pointer))
12100 buffer)
12101 (if (and (not (markerp pos)) (not file))
12102 (user-error "Please indicate a target file in the refile path")
12103 (when (org-string-nw-p re)
12104 (setq buffer (if (markerp pos)
12105 (marker-buffer pos)
12106 (or (find-buffer-visiting file)
12107 (find-file-noselect file))))
12108 (with-current-buffer buffer
12109 (save-excursion
12110 (save-restriction
12111 (widen)
12112 (goto-char pos)
12113 (beginning-of-line 1)
12114 (unless (org-looking-at-p re)
12115 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12117 (defun org-refile-new-child (parent-target child)
12118 "Use refile target PARENT-TARGET to add new CHILD below it."
12119 (unless parent-target
12120 (error "Cannot find parent for new node"))
12121 (let ((file (nth 1 parent-target))
12122 (pos (nth 3 parent-target))
12123 level)
12124 (with-current-buffer (or (find-buffer-visiting file)
12125 (find-file-noselect file))
12126 (save-excursion
12127 (save-restriction
12128 (widen)
12129 (if pos
12130 (goto-char pos)
12131 (goto-char (point-max))
12132 (if (not (bolp)) (newline)))
12133 (when (looking-at org-outline-regexp)
12134 (setq level (funcall outline-level))
12135 (org-end-of-subtree t t))
12136 (org-back-over-empty-lines)
12137 (insert "\n" (make-string
12138 (if pos (org-get-valid-level level 1) 1) ?*)
12139 " " child "\n")
12140 (beginning-of-line 0)
12141 (list (concat (car parent-target) "/" child) file "" (point)))))))
12143 (defun org-olpath-completing-read (prompt collection &rest args)
12144 "Read an outline path like a file name."
12145 (let ((thetable collection)
12146 (org-completion-use-ido nil) ; does not work with ido.
12147 (org-completion-use-iswitchb nil)) ; or iswitchb
12148 (apply #'org-icompleting-read
12149 prompt
12150 (lambda (string predicate &optional flag)
12151 (cond
12152 ((eq flag nil) (try-completion string thetable))
12153 ((eq flag t)
12154 (let ((l (length string)))
12155 (mapcar (lambda (x)
12156 (let ((r (substring x l))
12157 (f (if (string-match " ([^)]*)$" x)
12158 (match-string 0 x)
12159 "")))
12160 (if (string-match "/" r)
12161 (concat string (substring r 0 (match-end 0)) f)
12162 x)))
12163 (all-completions string thetable predicate))))
12164 ;; Exact match?
12165 ((eq flag 'lambda) (assoc string thetable))))
12166 args)))
12168 ;;;; Dynamic blocks
12170 (defun org-find-dblock (name)
12171 "Find the first dynamic block with name NAME in the buffer.
12172 If not found, stay at current position and return nil."
12173 (let ((case-fold-search t) pos)
12174 (save-excursion
12175 (goto-char (point-min))
12176 (setq pos (and (re-search-forward
12177 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12178 (match-beginning 0))))
12179 (if pos (goto-char pos))
12180 pos))
12182 (defun org-create-dblock (plist)
12183 "Create a dynamic block section, with parameters taken from PLIST.
12184 PLIST must contain a :name entry which is used as the name of the block."
12185 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12186 (end-of-line 1)
12187 (newline))
12188 (let ((col (current-column))
12189 (name (plist-get plist :name)))
12190 (insert "#+BEGIN: " name)
12191 (while plist
12192 (if (eq (car plist) :name)
12193 (setq plist (cddr plist))
12194 (insert " " (prin1-to-string (pop plist)))))
12195 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12196 (beginning-of-line -2)))
12198 (defun org-prepare-dblock ()
12199 "Prepare dynamic block for refresh.
12200 This empties the block, puts the cursor at the insert position and returns
12201 the property list including an extra property :name with the block name."
12202 (unless (looking-at org-dblock-start-re)
12203 (user-error "Not at a dynamic block"))
12204 (let* ((begdel (1+ (match-end 0)))
12205 (name (org-no-properties (match-string 1)))
12206 (params (append (list :name name)
12207 (read (concat "(" (match-string 3) ")")))))
12208 (save-excursion
12209 (beginning-of-line 1)
12210 (skip-chars-forward " \t")
12211 (setq params (plist-put params :indentation-column (current-column))))
12212 (unless (re-search-forward org-dblock-end-re nil t)
12213 (error "Dynamic block not terminated"))
12214 (setq params
12215 (append params
12216 (list :content (buffer-substring
12217 begdel (match-beginning 0)))))
12218 (delete-region begdel (match-beginning 0))
12219 (goto-char begdel)
12220 (open-line 1)
12221 params))
12223 (defun org-map-dblocks (&optional command)
12224 "Apply COMMAND to all dynamic blocks in the current buffer.
12225 If COMMAND is not given, use `org-update-dblock'."
12226 (let ((cmd (or command 'org-update-dblock)))
12227 (save-excursion
12228 (goto-char (point-min))
12229 (while (re-search-forward org-dblock-start-re nil t)
12230 (goto-char (match-beginning 0))
12231 (save-excursion
12232 (condition-case nil
12233 (funcall cmd)
12234 (error (message "Error during update of dynamic block"))))
12235 (unless (re-search-forward org-dblock-end-re nil t)
12236 (error "Dynamic block not terminated"))))))
12238 (defun org-dblock-update (&optional arg)
12239 "User command for updating dynamic blocks.
12240 Update the dynamic block at point. With prefix ARG, update all dynamic
12241 blocks in the buffer."
12242 (interactive "P")
12243 (if arg
12244 (org-update-all-dblocks)
12245 (or (looking-at org-dblock-start-re)
12246 (org-beginning-of-dblock))
12247 (org-update-dblock)))
12249 (defun org-update-dblock ()
12250 "Update the dynamic block at point.
12251 This means to empty the block, parse for parameters and then call
12252 the correct writing function."
12253 (interactive)
12254 (save-excursion
12255 (let* ((win (selected-window))
12256 (pos (point))
12257 (line (org-current-line))
12258 (params (org-prepare-dblock))
12259 (name (plist-get params :name))
12260 (indent (plist-get params :indentation-column))
12261 (cmd (intern (concat "org-dblock-write:" name))))
12262 (message "Updating dynamic block `%s' at line %d..." name line)
12263 (funcall cmd params)
12264 (message "Updating dynamic block `%s' at line %d...done" name line)
12265 (goto-char pos)
12266 (when (and indent (> indent 0))
12267 (setq indent (make-string indent ?\ ))
12268 (save-excursion
12269 (select-window win)
12270 (org-beginning-of-dblock)
12271 (forward-line 1)
12272 (while (not (looking-at org-dblock-end-re))
12273 (insert indent)
12274 (beginning-of-line 2))
12275 (when (looking-at org-dblock-end-re)
12276 (and (looking-at "[ \t]+")
12277 (replace-match ""))
12278 (insert indent)))))))
12280 (defun org-beginning-of-dblock ()
12281 "Find the beginning of the dynamic block at point.
12282 Error if there is no such block at point."
12283 (let ((pos (point))
12284 beg)
12285 (end-of-line 1)
12286 (if (and (re-search-backward org-dblock-start-re nil t)
12287 (setq beg (match-beginning 0))
12288 (re-search-forward org-dblock-end-re nil t)
12289 (> (match-end 0) pos))
12290 (goto-char beg)
12291 (goto-char pos)
12292 (error "Not in a dynamic block"))))
12294 (defun org-update-all-dblocks ()
12295 "Update all dynamic blocks in the buffer.
12296 This function can be used in a hook."
12297 (interactive)
12298 (when (derived-mode-p 'org-mode)
12299 (org-map-dblocks 'org-update-dblock)))
12302 ;;;; Completion
12304 (declare-function org-export-backend-name "org-export" (cl-x))
12305 (declare-function org-export-backend-options "org-export" (cl-x))
12306 (defun org-get-export-keywords ()
12307 "Return a list of all currently understood export keywords.
12308 Export keywords include options, block names, attributes and
12309 keywords relative to each registered export back-end."
12310 (let (keywords)
12311 (dolist (backend
12312 (org-bound-and-true-p org-export-registered-backends)
12313 (delq nil keywords))
12314 ;; Back-end name (for keywords, like #+LATEX:)
12315 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12316 (dolist (option-entry (org-export-backend-options backend))
12317 ;; Back-end options.
12318 (push (nth 1 option-entry) keywords)))))
12320 (defconst org-options-keywords
12321 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12322 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12323 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12324 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12325 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12327 (defcustom org-structure-template-alist
12328 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12329 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12330 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12331 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12332 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12333 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12334 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12335 ("L" "#+LaTeX: ")
12336 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12337 ("H" "#+HTML: ")
12338 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12339 ("A" "#+ASCII: ")
12340 ("i" "#+INDEX: ?")
12341 ("I" "#+INCLUDE: %file ?"))
12342 "Structure completion elements.
12343 This is a list of abbreviation keys and values. The value gets inserted
12344 if you type `<' followed by the key and then press the completion key,
12345 usually `TAB'. %file will be replaced by a file name after prompting
12346 for the file using completion. The cursor will be placed at the position
12347 of the `?' in the template.
12348 There are two templates for each key, the first uses the original Org syntax,
12349 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12350 the default when the /org-mtags.el/ module has been loaded. See also the
12351 variable `org-mtags-prefer-muse-templates'."
12352 :group 'org-completion
12353 :type '(repeat
12354 (list
12355 (string :tag "Key")
12356 (string :tag "Template")))
12357 :version "25.1"
12358 :package-version '(Org . "8.3"))
12360 (defun org-try-structure-completion ()
12361 "Try to complete a structure template before point.
12362 This looks for strings like \"<e\" on an otherwise empty line and
12363 expands them."
12364 (let ((l (buffer-substring (point-at-bol) (point)))
12366 (when (and (looking-at "[ \t]*$")
12367 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12368 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12369 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12370 (match-beginning 1)) a)
12371 t)))
12373 (defun org-complete-expand-structure-template (start cell)
12374 "Expand a structure template."
12375 (let ((rpl (nth 1 cell))
12376 (ind ""))
12377 (delete-region start (point))
12378 (when (string-match "\\`[ \t]*#\\+" rpl)
12379 (cond
12380 ((bolp))
12381 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12382 (setq ind (buffer-substring (point-at-bol) (point))))
12383 (t (newline))))
12384 (setq start (point))
12385 (if (string-match "%file" rpl)
12386 (setq rpl (replace-match
12387 (concat
12388 "\""
12389 (save-match-data
12390 (abbreviate-file-name (read-file-name "Include file: ")))
12391 "\"")
12392 t t rpl)))
12393 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12394 (concat "\n" ind)))
12395 (insert rpl)
12396 (if (re-search-backward "\\?" start t) (delete-char 1))))
12398 ;;;; TODO, DEADLINE, Comments
12400 (defun org-toggle-comment ()
12401 "Change the COMMENT state of an entry."
12402 (interactive)
12403 (save-excursion
12404 (org-back-to-heading)
12405 (looking-at org-complex-heading-regexp)
12406 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12407 (skip-chars-forward " \t")
12408 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12409 (if (org-in-commented-heading-p t)
12410 (delete-region (point)
12411 (progn (search-forward " " (line-end-position) 'move)
12412 (skip-chars-forward " \t")
12413 (point)))
12414 (insert org-comment-string)
12415 (unless (eolp) (insert " ")))))
12417 (defvar org-last-todo-state-is-todo nil
12418 "This is non-nil when the last TODO state change led to a TODO state.
12419 If the last change removed the TODO tag or switched to DONE, then
12420 this is nil.")
12422 (defvar org-setting-tags nil) ; dynamically skipped
12424 (defvar org-todo-setup-filter-hook nil
12425 "Hook for functions that pre-filter todo specs.
12426 Each function takes a todo spec and returns either nil or the spec
12427 transformed into canonical form." )
12429 (defvar org-todo-get-default-hook nil
12430 "Hook for functions that get a default item for todo.
12431 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12432 nil or a string to be used for the todo mark." )
12434 (defvar org-agenda-headline-snapshot-before-repeat)
12436 (defun org-current-effective-time ()
12437 "Return current time adjusted for `org-extend-today-until' variable."
12438 (let* ((ct (org-current-time))
12439 (dct (decode-time ct))
12440 (ct1
12441 (cond
12442 (org-use-last-clock-out-time-as-effective-time
12443 (or (org-clock-get-last-clock-out-time) ct))
12444 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12445 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12446 (t ct))))
12447 ct1))
12449 (defun org-todo-yesterday (&optional arg)
12450 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12451 (interactive "P")
12452 (if (eq major-mode 'org-agenda-mode)
12453 (apply 'org-agenda-todo-yesterday arg)
12454 (let* ((org-use-effective-time t)
12455 (hour (third (decode-time
12456 (org-current-time))))
12457 (org-extend-today-until (1+ hour)))
12458 (org-todo arg))))
12460 (defvar org-block-entry-blocking ""
12461 "First entry preventing the TODO state change.")
12463 (defun org-cancel-repeater ()
12464 "Cancel a repeater by setting its numeric value to zero."
12465 (interactive)
12466 (save-excursion
12467 (org-back-to-heading t)
12468 (let ((bound1 (point))
12469 (bound0 (save-excursion (outline-next-heading) (point))))
12470 (when (re-search-forward
12471 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12472 org-deadline-time-regexp "\\)\\|\\("
12473 org-ts-regexp "\\)")
12474 bound0 t)
12475 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12476 (replace-match "0" t nil nil 1))))))
12478 (defun org-todo (&optional arg)
12479 "Change the TODO state of an item.
12480 The state of an item is given by a keyword at the start of the heading,
12481 like
12482 *** TODO Write paper
12483 *** DONE Call mom
12485 The different keywords are specified in the variable `org-todo-keywords'.
12486 By default the available states are \"TODO\" and \"DONE\".
12487 So for this example: when the item starts with TODO, it is changed to DONE.
12488 When it starts with DONE, the DONE is removed. And when neither TODO nor
12489 DONE are present, add TODO at the beginning of the heading.
12491 With \\[universal-argument] prefix arg, use completion to determine the new \
12492 state.
12493 With numeric prefix arg, switch to that state.
12494 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12495 keywords (nextset).
12496 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12497 With a numeric prefix arg of 0, inhibit note taking for the change.
12498 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12500 When called through ELisp, arg is also interpreted in the following way:
12501 `none' -> empty state
12502 \"\"(empty string) -> switch to empty state
12503 `done' -> switch to DONE
12504 `nextset' -> switch to the next set of keywords
12505 `previousset' -> switch to the previous set of keywords
12506 \"WAITING\" -> switch to the specified keyword, but only if it
12507 really is a member of `org-todo-keywords'."
12508 (interactive "P")
12509 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12510 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12511 'region-start-level 'region))
12512 org-loop-over-headlines-in-active-region)
12513 (org-map-entries
12514 `(org-todo ,arg)
12515 org-loop-over-headlines-in-active-region
12516 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12517 (if (equal arg '(16)) (setq arg 'nextset))
12518 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12519 (let ((org-blocker-hook org-blocker-hook)
12520 commentp
12521 case-fold-search)
12522 (when (equal arg '(64))
12523 (setq arg nil org-blocker-hook nil))
12524 (when (and org-blocker-hook
12525 (or org-inhibit-blocking
12526 (org-entry-get nil "NOBLOCKING")))
12527 (setq org-blocker-hook nil))
12528 (save-excursion
12529 (catch 'exit
12530 (org-back-to-heading t)
12531 (when (org-in-commented-heading-p t)
12532 (org-toggle-comment)
12533 (setq commentp t))
12534 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12535 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12536 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12537 (let* ((match-data (match-data))
12538 (startpos (point-at-bol))
12539 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12540 (org-log-done org-log-done)
12541 (org-log-repeat org-log-repeat)
12542 (org-todo-log-states org-todo-log-states)
12543 (org-inhibit-logging
12544 (if (equal arg 0)
12545 (progn (setq arg nil) 'note) org-inhibit-logging))
12546 (this (match-string 1))
12547 (hl-pos (match-beginning 0))
12548 (head (org-get-todo-sequence-head this))
12549 (ass (assoc head org-todo-kwd-alist))
12550 (interpret (nth 1 ass))
12551 (done-word (nth 3 ass))
12552 (final-done-word (nth 4 ass))
12553 (org-last-state (or this ""))
12554 (completion-ignore-case t)
12555 (member (member this org-todo-keywords-1))
12556 (tail (cdr member))
12557 (org-state (cond
12558 ((and org-todo-key-trigger
12559 (or (and (equal arg '(4))
12560 (eq org-use-fast-todo-selection 'prefix))
12561 (and (not arg) org-use-fast-todo-selection
12562 (not (eq org-use-fast-todo-selection
12563 'prefix)))))
12564 ;; Use fast selection
12565 (org-fast-todo-selection))
12566 ((and (equal arg '(4))
12567 (or (not org-use-fast-todo-selection)
12568 (not org-todo-key-trigger)))
12569 ;; Read a state with completion
12570 (org-icompleting-read
12571 "State: " (mapcar 'list org-todo-keywords-1)
12572 nil t))
12573 ((eq arg 'right)
12574 (if this
12575 (if tail (car tail) nil)
12576 (car org-todo-keywords-1)))
12577 ((eq arg 'left)
12578 (if (equal member org-todo-keywords-1)
12580 (if this
12581 (nth (- (length org-todo-keywords-1)
12582 (length tail) 2)
12583 org-todo-keywords-1)
12584 (org-last org-todo-keywords-1))))
12585 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12586 (setq arg nil))) ; hack to fall back to cycling
12587 (arg
12588 ;; user or caller requests a specific state
12589 (cond
12590 ((equal arg "") nil)
12591 ((eq arg 'none) nil)
12592 ((eq arg 'done) (or done-word (car org-done-keywords)))
12593 ((eq arg 'nextset)
12594 (or (car (cdr (member head org-todo-heads)))
12595 (car org-todo-heads)))
12596 ((eq arg 'previousset)
12597 (let ((org-todo-heads (reverse org-todo-heads)))
12598 (or (car (cdr (member head org-todo-heads)))
12599 (car org-todo-heads))))
12600 ((car (member arg org-todo-keywords-1)))
12601 ((stringp arg)
12602 (user-error "State `%s' not valid in this file" arg))
12603 ((nth (1- (prefix-numeric-value arg))
12604 org-todo-keywords-1))))
12605 ((null member) (or head (car org-todo-keywords-1)))
12606 ((equal this final-done-word) nil) ;; -> make empty
12607 ((null tail) nil) ;; -> first entry
12608 ((memq interpret '(type priority))
12609 (if (eq this-command last-command)
12610 (car tail)
12611 (if (> (length tail) 0)
12612 (or done-word (car org-done-keywords))
12613 nil)))
12615 (car tail))))
12616 (org-state (or
12617 (run-hook-with-args-until-success
12618 'org-todo-get-default-hook org-state org-last-state)
12619 org-state))
12620 (next (if org-state (concat " " org-state " ") " "))
12621 (change-plist (list :type 'todo-state-change :from this :to org-state
12622 :position startpos))
12623 dolog now-done-p)
12624 (when org-blocker-hook
12625 (setq org-last-todo-state-is-todo
12626 (not (member this org-done-keywords)))
12627 (unless (save-excursion
12628 (save-match-data
12629 (org-with-wide-buffer
12630 (run-hook-with-args-until-failure
12631 'org-blocker-hook change-plist))))
12632 (if (org-called-interactively-p 'interactive)
12633 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12634 this org-state org-block-entry-blocking)
12635 ;; fail silently
12636 (message "TODO state change from %s to %s blocked (by \"%s\")"
12637 this org-state org-block-entry-blocking)
12638 (throw 'exit nil))))
12639 (store-match-data match-data)
12640 (replace-match next t t)
12641 (cond ((equal this org-state)
12642 (message "TODO state was already %s" (org-trim next)))
12643 ((pos-visible-in-window-p hl-pos)
12644 (message "TODO state changed to %s" (org-trim next))))
12645 (unless head
12646 (setq head (org-get-todo-sequence-head org-state)
12647 ass (assoc head org-todo-kwd-alist)
12648 interpret (nth 1 ass)
12649 done-word (nth 3 ass)
12650 final-done-word (nth 4 ass)))
12651 (when (memq arg '(nextset previousset))
12652 (message "Keyword-Set %d/%d: %s"
12653 (- (length org-todo-sets) -1
12654 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12655 (length org-todo-sets)
12656 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12657 (setq org-last-todo-state-is-todo
12658 (not (member org-state org-done-keywords)))
12659 (setq now-done-p (and (member org-state org-done-keywords)
12660 (not (member this org-done-keywords))))
12661 (and logging (org-local-logging logging))
12662 (when (and (or org-todo-log-states org-log-done)
12663 (not (eq org-inhibit-logging t))
12664 (not (memq arg '(nextset previousset))))
12665 ;; we need to look at recording a time and note
12666 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12667 (nth 2 (assoc this org-todo-log-states))))
12668 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12669 (setq dolog 'time))
12670 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12671 (and org-state
12672 (member org-state org-not-done-keywords)
12673 (not (member this org-not-done-keywords))))
12674 ;; This is now a todo state and was not one before
12675 ;; If there was a CLOSED time stamp, get rid of it.
12676 (org-add-planning-info nil nil 'closed))
12677 (when (and now-done-p org-log-done)
12678 ;; It is now done, and it was not done before
12679 (org-add-planning-info 'closed (org-current-effective-time))
12680 (if (and (not dolog) (eq 'note org-log-done))
12681 (org-add-log-setup 'done org-state this 'findpos 'note)))
12682 (when (and org-state dolog)
12683 ;; This is a non-nil state, and we need to log it
12684 (org-add-log-setup 'state org-state this 'findpos dolog)))
12685 ;; Fixup tag positioning
12686 (org-todo-trigger-tag-changes org-state)
12687 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12688 (when org-provide-todo-statistics
12689 (org-update-parent-todo-statistics))
12690 (run-hooks 'org-after-todo-state-change-hook)
12691 (if (and arg (not (member org-state org-done-keywords)))
12692 (setq head (org-get-todo-sequence-head org-state)))
12693 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12694 ;; Do we need to trigger a repeat?
12695 (when now-done-p
12696 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12697 ;; This is for the agenda, take a snapshot of the headline.
12698 (save-match-data
12699 (setq org-agenda-headline-snapshot-before-repeat
12700 (org-get-heading))))
12701 (org-auto-repeat-maybe org-state))
12702 ;; Fixup cursor location if close to the keyword
12703 (if (and (outline-on-heading-p)
12704 (not (bolp))
12705 (save-excursion (beginning-of-line 1)
12706 (looking-at org-todo-line-regexp))
12707 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12708 (progn
12709 (goto-char (or (match-end 2) (match-end 1)))
12710 (and (looking-at " ") (just-one-space))))
12711 (when org-trigger-hook
12712 (save-excursion
12713 (run-hook-with-args 'org-trigger-hook change-plist)))
12714 (when commentp (org-toggle-comment))))))))
12716 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12717 "Block turning an entry into a TODO, using the hierarchy.
12718 This checks whether the current task should be blocked from state
12719 changes. Such blocking occurs when:
12721 1. The task has children which are not all in a completed state.
12723 2. A task has a parent with the property :ORDERED:, and there
12724 are siblings prior to the current task with incomplete
12725 status.
12727 3. The parent of the task is blocked because it has siblings that should
12728 be done first, or is child of a block grandparent TODO entry."
12730 (if (not org-enforce-todo-dependencies)
12731 t ; if locally turned off don't block
12732 (catch 'dont-block
12733 ;; If this is not a todo state change, or if this entry is already DONE,
12734 ;; do not block
12735 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12736 (member (plist-get change-plist :from)
12737 (cons 'done org-done-keywords))
12738 (member (plist-get change-plist :to)
12739 (cons 'todo org-not-done-keywords))
12740 (not (plist-get change-plist :to)))
12741 (throw 'dont-block t))
12742 ;; If this task has children, and any are undone, it's blocked
12743 (save-excursion
12744 (org-back-to-heading t)
12745 (let ((this-level (funcall outline-level)))
12746 (outline-next-heading)
12747 (let ((child-level (funcall outline-level)))
12748 (while (and (not (eobp))
12749 (> child-level this-level))
12750 ;; this todo has children, check whether they are all
12751 ;; completed
12752 (if (and (not (org-entry-is-done-p))
12753 (org-entry-is-todo-p))
12754 (progn (setq org-block-entry-blocking (org-get-heading))
12755 (throw 'dont-block nil)))
12756 (outline-next-heading)
12757 (setq child-level (funcall outline-level))))))
12758 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12759 ;; any previous siblings are undone, it's blocked
12760 (save-excursion
12761 (org-back-to-heading t)
12762 (let* ((pos (point))
12763 (parent-pos (and (org-up-heading-safe) (point))))
12764 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12765 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12766 (forward-line 1)
12767 (re-search-forward org-not-done-heading-regexp pos t))
12768 (setq org-block-entry-blocking (match-string 0))
12769 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12770 ;; Search further up the hierarchy, to see if an ancestor is blocked
12771 (while t
12772 (goto-char parent-pos)
12773 (if (not (looking-at org-not-done-heading-regexp))
12774 (throw 'dont-block t)) ; do not block, parent is not a TODO
12775 (setq pos (point))
12776 (setq parent-pos (and (org-up-heading-safe) (point)))
12777 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12778 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12779 (forward-line 1)
12780 (re-search-forward org-not-done-heading-regexp pos t)
12781 (setq org-block-entry-blocking (org-get-heading)))
12782 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12784 (defcustom org-track-ordered-property-with-tag nil
12785 "Should the ORDERED property also be shown as a tag?
12786 The ORDERED property decides if an entry should require subtasks to be
12787 completed in sequence. Since a property is not very visible, setting
12788 this option means that toggling the ORDERED property with the command
12789 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12790 not relevant for the behavior, but it makes things more visible.
12792 Note that toggling the tag with tags commands will not change the property
12793 and therefore not influence behavior!
12795 This can be t, meaning the tag ORDERED should be used, It can also be a
12796 string to select a different tag for this task."
12797 :group 'org-todo
12798 :type '(choice
12799 (const :tag "No tracking" nil)
12800 (const :tag "Track with ORDERED tag" t)
12801 (string :tag "Use other tag")))
12803 (defun org-toggle-ordered-property ()
12804 "Toggle the ORDERED property of the current entry.
12805 For better visibility, you can track the value of this property with a tag.
12806 See variable `org-track-ordered-property-with-tag'."
12807 (interactive)
12808 (let* ((t1 org-track-ordered-property-with-tag)
12809 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12810 (save-excursion
12811 (org-back-to-heading)
12812 (if (org-entry-get nil "ORDERED")
12813 (progn
12814 (org-delete-property "ORDERED")
12815 (and tag (org-toggle-tag tag 'off))
12816 (message "Subtasks can be completed in arbitrary order"))
12817 (org-entry-put nil "ORDERED" "t")
12818 (and tag (org-toggle-tag tag 'on))
12819 (message "Subtasks must be completed in sequence")))))
12821 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12822 (defun org-block-todo-from-checkboxes (change-plist)
12823 "Block turning an entry into a TODO, using checkboxes.
12824 This checks whether the current task should be blocked from state
12825 changes because there are unchecked boxes in this entry."
12826 (if (not org-enforce-todo-checkbox-dependencies)
12827 t ; if locally turned off don't block
12828 (catch 'dont-block
12829 ;; If this is not a todo state change, or if this entry is already DONE,
12830 ;; do not block
12831 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12832 (member (plist-get change-plist :from)
12833 (cons 'done org-done-keywords))
12834 (member (plist-get change-plist :to)
12835 (cons 'todo org-not-done-keywords))
12836 (not (plist-get change-plist :to)))
12837 (throw 'dont-block t))
12838 ;; If this task has checkboxes that are not checked, it's blocked
12839 (save-excursion
12840 (org-back-to-heading t)
12841 (let ((beg (point)) end)
12842 (outline-next-heading)
12843 (setq end (point))
12844 (goto-char beg)
12845 (if (org-list-search-forward
12846 (concat (org-item-beginning-re)
12847 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12848 "\\[[- ]\\]")
12849 end t)
12850 (progn
12851 (if (boundp 'org-blocked-by-checkboxes)
12852 (setq org-blocked-by-checkboxes t))
12853 (throw 'dont-block nil)))))
12854 t))) ; do not block
12856 (defun org-entry-blocked-p ()
12857 "Non-nil if entry at point is blocked."
12858 (and (not (org-entry-get nil "NOBLOCKING"))
12859 (member (org-entry-get nil "TODO") org-not-done-keywords)
12860 (not (run-hook-with-args-until-failure
12861 'org-blocker-hook
12862 (list :type 'todo-state-change
12863 :position (point)
12864 :from 'todo
12865 :to 'done)))))
12867 (defun org-update-statistics-cookies (all)
12868 "Update the statistics cookie, either from TODO or from checkboxes.
12869 This should be called with the cursor in a line with a statistics cookie."
12870 (interactive "P")
12871 (if all
12872 (progn
12873 (org-update-checkbox-count 'all)
12874 (org-map-entries 'org-update-parent-todo-statistics))
12875 (if (not (org-at-heading-p))
12876 (org-update-checkbox-count)
12877 (let ((pos (point-marker))
12878 end l1 l2)
12879 (ignore-errors (org-back-to-heading t))
12880 (if (not (org-at-heading-p))
12881 (org-update-checkbox-count)
12882 (setq l1 (org-outline-level))
12883 (setq end (save-excursion
12884 (outline-next-heading)
12885 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12886 (point)))
12887 (if (and (save-excursion
12888 (re-search-forward
12889 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12890 (not (save-excursion (re-search-forward
12891 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12892 (org-update-checkbox-count)
12893 (if (and l2 (> l2 l1))
12894 (progn
12895 (goto-char end)
12896 (org-update-parent-todo-statistics))
12897 (goto-char pos)
12898 (beginning-of-line 1)
12899 (while (re-search-forward
12900 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12901 (point-at-eol) t)
12902 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12903 (goto-char pos)
12904 (move-marker pos nil)))))
12906 (defvar org-entry-property-inherited-from) ;; defined below
12907 (defun org-update-parent-todo-statistics ()
12908 "Update any statistics cookie in the parent of the current headline.
12909 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12910 the entire subtree and this will travel up the hierarchy and update
12911 statistics everywhere."
12912 (let* ((prop (save-excursion (org-up-heading-safe)
12913 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12914 (recursive (or (not org-hierarchical-todo-statistics)
12915 (and prop (string-match "\\<recursive\\>" prop))))
12916 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12918 (first t)
12919 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12920 level ltoggle l1 new ndel
12921 (cnt-all 0) (cnt-done 0) is-percent kwd
12922 checkbox-beg ov ovs ove cookie-present)
12923 (catch 'exit
12924 (save-excursion
12925 (beginning-of-line 1)
12926 (setq ltoggle (funcall outline-level))
12927 ;; Three situations are to consider:
12929 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12930 ;; to the top-level ancestor on the headline;
12932 ;; 2. If parent has "recursive" property, repeat up to the
12933 ;; headline setting that property, taking inheritance into
12934 ;; account;
12936 ;; 3. Else, move up to direct parent and proceed only once.
12937 (while (and (setq level (org-up-heading-safe))
12938 (or recursive first)
12939 (>= (point) lim))
12940 (setq first nil cookie-present nil)
12941 (unless (and level
12942 (not (string-match
12943 "\\<checkbox\\>"
12944 (downcase (or (org-entry-get nil "COOKIE_DATA")
12945 "")))))
12946 (throw 'exit nil))
12947 (while (re-search-forward box-re (point-at-eol) t)
12948 (setq cnt-all 0 cnt-done 0 cookie-present t)
12949 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12950 (save-match-data
12951 (unless (outline-next-heading) (throw 'exit nil))
12952 (while (and (looking-at org-complex-heading-regexp)
12953 (> (setq l1 (length (match-string 1))) level))
12954 (setq kwd (and (or recursive (= l1 ltoggle))
12955 (match-string 2)))
12956 (if (or (eq org-provide-todo-statistics 'all-headlines)
12957 (and (eq org-provide-todo-statistics t)
12958 (or (member kwd org-done-keywords)))
12959 (and (listp org-provide-todo-statistics)
12960 (stringp (car org-provide-todo-statistics))
12961 (or (member kwd org-provide-todo-statistics)
12962 (member kwd org-done-keywords)))
12963 (and (listp org-provide-todo-statistics)
12964 (listp (car org-provide-todo-statistics))
12965 (or (member kwd (car org-provide-todo-statistics))
12966 (and (member kwd org-done-keywords)
12967 (member kwd (cadr org-provide-todo-statistics))))))
12968 (setq cnt-all (1+ cnt-all))
12969 (if (eq org-provide-todo-statistics t)
12970 (and kwd (setq cnt-all (1+ cnt-all)))))
12971 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12972 (member kwd org-done-keywords))
12973 (and (listp org-provide-todo-statistics)
12974 (listp (car org-provide-todo-statistics))
12975 (member kwd org-done-keywords)
12976 (member kwd (cadr org-provide-todo-statistics)))
12977 (and (listp org-provide-todo-statistics)
12978 (stringp (car org-provide-todo-statistics))
12979 (member kwd org-done-keywords)))
12980 (setq cnt-done (1+ cnt-done)))
12981 (outline-next-heading)))
12982 (setq new
12983 (if is-percent
12984 (format "[%d%%]" (floor (* 100.0 cnt-done)
12985 (max 1 cnt-all)))
12986 (format "[%d/%d]" cnt-done cnt-all))
12987 ndel (- (match-end 0) checkbox-beg))
12988 ;; handle overlays when updating cookie from column view
12989 (when (setq ov (car (overlays-at checkbox-beg)))
12990 (setq ovs (overlay-start ov) ove (overlay-end ov))
12991 (delete-overlay ov))
12992 (goto-char checkbox-beg)
12993 (insert new)
12994 (delete-region (point) (+ (point) ndel))
12995 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12996 (when ov (move-overlay ov ovs ove)))
12997 (when cookie-present
12998 (run-hook-with-args 'org-after-todo-statistics-hook
12999 cnt-done (- cnt-all cnt-done))))))
13000 (run-hooks 'org-todo-statistics-hook)))
13002 (defvar org-after-todo-statistics-hook nil
13003 "Hook that is called after a TODO statistics cookie has been updated.
13004 Each function is called with two arguments: the number of not-done entries
13005 and the number of done entries.
13007 For example, the following function, when added to this hook, will switch
13008 an entry to DONE when all children are done, and back to TODO when new
13009 entries are set to a TODO status. Note that this hook is only called
13010 when there is a statistics cookie in the headline!
13012 (defun org-summary-todo (n-done n-not-done)
13013 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13014 (let (org-log-done org-log-states) ; turn off logging
13015 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13018 (defvar org-todo-statistics-hook nil
13019 "Hook that is run whenever Org thinks TODO statistics should be updated.
13020 This hook runs even if there is no statistics cookie present, in which case
13021 `org-after-todo-statistics-hook' would not run.")
13023 (defun org-todo-trigger-tag-changes (state)
13024 "Apply the changes defined in `org-todo-state-tags-triggers'."
13025 (let ((l org-todo-state-tags-triggers)
13026 changes)
13027 (when (or (not state) (equal state ""))
13028 (setq changes (append changes (cdr (assoc "" l)))))
13029 (when (and (stringp state) (> (length state) 0))
13030 (setq changes (append changes (cdr (assoc state l)))))
13031 (when (member state org-not-done-keywords)
13032 (setq changes (append changes (cdr (assoc 'todo l)))))
13033 (when (member state org-done-keywords)
13034 (setq changes (append changes (cdr (assoc 'done l)))))
13035 (dolist (c changes)
13036 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13038 (defun org-local-logging (value)
13039 "Get logging settings from a property VALUE."
13040 ;; Directly set the variables, they are already local.
13041 (setq org-log-done nil
13042 org-log-repeat nil
13043 org-todo-log-states nil)
13044 (dolist (w (org-split-string value))
13045 (let (a)
13046 (cond
13047 ((setq a (assoc w org-startup-options))
13048 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13049 (set (nth 1 a) (nth 2 a))))
13050 ((setq a (org-extract-log-state-settings w))
13051 (and (member (car a) org-todo-keywords-1)
13052 (push a org-todo-log-states)))))))
13054 (defun org-get-todo-sequence-head (kwd)
13055 "Return the head of the TODO sequence to which KWD belongs.
13056 If KWD is not set, check if there is a text property remembering the
13057 right sequence."
13058 (let (p)
13059 (cond
13060 ((not kwd)
13061 (or (get-text-property (point-at-bol) 'org-todo-head)
13062 (progn
13063 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13064 nil (point-at-eol)))
13065 (get-text-property p 'org-todo-head))))
13066 ((not (member kwd org-todo-keywords-1))
13067 (car org-todo-keywords-1))
13068 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13070 (defun org-fast-todo-selection ()
13071 "Fast TODO keyword selection with single keys.
13072 Returns the new TODO keyword, or nil if no state change should occur."
13073 (let* ((fulltable org-todo-key-alist)
13074 (done-keywords org-done-keywords) ;; needed for the faces.
13075 (maxlen (apply 'max (mapcar
13076 (lambda (x)
13077 (if (stringp (car x)) (string-width (car x)) 0))
13078 fulltable)))
13079 (expert nil)
13080 (fwidth (+ maxlen 3 1 3))
13081 (ncol (/ (- (window-width) 4) fwidth))
13082 tg cnt e c tbl
13083 groups ingroup)
13084 (save-excursion
13085 (save-window-excursion
13086 (if expert
13087 (set-buffer (get-buffer-create " *Org todo*"))
13088 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13089 (erase-buffer)
13090 (org-set-local 'org-done-keywords done-keywords)
13091 (setq tbl fulltable cnt 0)
13092 (while (setq e (pop tbl))
13093 (cond
13094 ((equal e '(:startgroup))
13095 (push '() groups) (setq ingroup t)
13096 (when (not (= cnt 0))
13097 (setq cnt 0)
13098 (insert "\n"))
13099 (insert "{ "))
13100 ((equal e '(:endgroup))
13101 (setq ingroup nil cnt 0)
13102 (insert "}\n"))
13103 ((equal e '(:newline))
13104 (when (not (= cnt 0))
13105 (setq cnt 0)
13106 (insert "\n")
13107 (setq e (car tbl))
13108 (while (equal (car tbl) '(:newline))
13109 (insert "\n")
13110 (setq tbl (cdr tbl)))))
13112 (setq tg (car e) c (cdr e))
13113 (if ingroup (push tg (car groups)))
13114 (setq tg (org-add-props tg nil 'face
13115 (org-get-todo-face tg)))
13116 (if (and (= cnt 0) (not ingroup)) (insert " "))
13117 (insert "[" c "] " tg (make-string
13118 (- fwidth 4 (length tg)) ?\ ))
13119 (when (= (setq cnt (1+ cnt)) ncol)
13120 (insert "\n")
13121 (if ingroup (insert " "))
13122 (setq cnt 0)))))
13123 (insert "\n")
13124 (goto-char (point-min))
13125 (if (not expert) (org-fit-window-to-buffer))
13126 (message "[a-z..]:Set [SPC]:clear")
13127 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13128 (cond
13129 ((or (= c ?\C-g)
13130 (and (= c ?q) (not (rassoc c fulltable))))
13131 (setq quit-flag t))
13132 ((= c ?\ ) nil)
13133 ((setq e (rassoc c fulltable) tg (car e))
13135 (t (setq quit-flag t)))))))
13137 (defun org-entry-is-todo-p ()
13138 (member (org-get-todo-state) org-not-done-keywords))
13140 (defun org-entry-is-done-p ()
13141 (member (org-get-todo-state) org-done-keywords))
13143 (defun org-get-todo-state ()
13144 "Return the TODO keyword of the current subtree."
13145 (save-excursion
13146 (org-back-to-heading t)
13147 (and (looking-at org-todo-line-regexp)
13148 (match-end 2)
13149 (match-string 2))))
13151 (defun org-at-date-range-p (&optional inactive-ok)
13152 "Non-nil if point is inside a date range.
13154 When optional argument INACTIVE-OK is non-nil, also consider
13155 inactive time ranges.
13157 When this function returns a non-nil value, match data is set
13158 according to `org-tr-regexp-both' or `org-tr-regexp', depending
13159 on INACTIVE-OK."
13160 (interactive)
13161 (save-excursion
13162 (catch 'exit
13163 (let ((pos (point)))
13164 (skip-chars-backward "^[<\r\n")
13165 (skip-chars-backward "<[")
13166 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13167 (>= (match-end 0) pos)
13168 (throw 'exit t))
13169 (skip-chars-backward "^<[\r\n")
13170 (skip-chars-backward "<[")
13171 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13172 (>= (match-end 0) pos)
13173 (throw 'exit t)))
13174 nil)))
13176 (defun org-get-repeat (&optional tagline)
13177 "Check if there is a deadline/schedule with repeater in this entry."
13178 (save-match-data
13179 (save-excursion
13180 (org-back-to-heading t)
13181 (and (re-search-forward (if tagline
13182 (concat tagline "\\s-*" org-repeat-re)
13183 org-repeat-re)
13184 (org-entry-end-position) t)
13185 (match-string-no-properties 1)))))
13187 (defvar org-last-changed-timestamp)
13188 (defvar org-last-inserted-timestamp)
13189 (defvar org-log-post-message)
13190 (defvar org-log-note-purpose)
13191 (defvar org-log-note-how nil)
13192 (defvar org-log-note-extra)
13193 (defun org-auto-repeat-maybe (done-word)
13194 "Check if the current headline contains a repeated deadline/schedule.
13195 If yes, set TODO state back to what it was and change the base date
13196 of repeating deadline/scheduled time stamps to new date.
13197 This function is run automatically after each state change to a DONE state."
13198 ;; last-state is dynamically scoped into this function
13199 (let* ((repeat (org-get-repeat))
13200 (aa (assoc org-last-state org-todo-kwd-alist))
13201 (interpret (nth 1 aa))
13202 (head (nth 2 aa))
13203 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13204 (msg "Entry repeats: ")
13205 (org-log-done nil)
13206 (org-todo-log-states nil)
13207 re type n what ts time to-state)
13208 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13209 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13210 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13211 org-todo-repeat-to-state))
13212 (unless (and to-state (member to-state org-todo-keywords-1))
13213 (setq to-state (if (eq interpret 'type) org-last-state head)))
13214 (org-todo to-state)
13215 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13216 (org-entry-put nil "LAST_REPEAT" (format-time-string
13217 (org-time-stamp-format t t))))
13218 (when org-log-repeat
13219 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13220 (memq 'org-add-log-note post-command-hook))
13221 ;; OK, we are already setup for some record
13222 (if (eq org-log-repeat 'note)
13223 ;; make sure we take a note, not only a time stamp
13224 (setq org-log-note-how 'note))
13225 ;; Set up for taking a record
13226 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13227 org-last-state
13228 'findpos org-log-repeat)))
13229 (org-back-to-heading t)
13230 (org-add-planning-info nil nil 'closed)
13231 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13232 org-deadline-time-regexp "\\)\\|\\("
13233 org-ts-regexp "\\)"))
13234 (while (re-search-forward
13235 re (save-excursion (outline-next-heading) (point)) t)
13236 (setq type (if (match-end 1) org-scheduled-string
13237 (if (match-end 3) org-deadline-string "Plain:"))
13238 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13239 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13240 (setq n (string-to-number (match-string 2 ts))
13241 what (match-string 3 ts))
13242 (if (equal what "w") (setq n (* n 7) what "d"))
13243 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13244 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13245 ;; Preparation, see if we need to modify the start date for the change
13246 (when (match-end 1)
13247 (setq time (save-match-data (org-time-string-to-time ts)))
13248 (cond
13249 ((equal (match-string 1 ts) ".")
13250 ;; Shift starting date to today
13251 (org-timestamp-change
13252 (- (org-today) (time-to-days time))
13253 'day))
13254 ((equal (match-string 1 ts) "+")
13255 (let ((nshiftmax 10) (nshift 0))
13256 (while (or (= nshift 0)
13257 (<= (time-to-days time)
13258 (time-to-days (current-time))))
13259 (when (= (incf nshift) nshiftmax)
13260 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13261 (user-error "Abort")))
13262 (org-timestamp-change n (cdr (assoc what whata)))
13263 (org-at-timestamp-p t)
13264 (setq ts (match-string 1))
13265 (setq time (save-match-data (org-time-string-to-time ts)))))
13266 (org-timestamp-change (- n) (cdr (assoc what whata)))
13267 ;; rematch, so that we have everything in place for the real shift
13268 (org-at-timestamp-p t)
13269 (setq ts (match-string 1))
13270 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13271 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13272 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13273 (setq org-log-post-message msg)
13274 (message "%s" msg))))
13276 (defun org-show-todo-tree (arg)
13277 "Make a compact tree which shows all headlines marked with TODO.
13278 The tree will show the lines where the regexp matches, and all higher
13279 headlines above the match.
13280 With a \\[universal-argument] prefix, prompt for a regexp to match.
13281 With a numeric prefix N, construct a sparse tree for the Nth element
13282 of `org-todo-keywords-1'."
13283 (interactive "P")
13284 (let ((case-fold-search nil)
13285 (kwd-re
13286 (cond ((null arg) org-not-done-regexp)
13287 ((equal arg '(4))
13288 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13289 (mapcar 'list org-todo-keywords-1))))
13290 (concat "\\("
13291 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13292 "\\)\\>")))
13293 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13294 (regexp-quote (nth (1- (prefix-numeric-value arg))
13295 org-todo-keywords-1)))
13296 (t (user-error "Invalid prefix argument: %s" arg)))))
13297 (message "%d TODO entries found"
13298 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13300 (defun org-deadline (arg &optional time)
13301 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13302 With one universal prefix argument, remove any deadline from the item.
13303 With two universal prefix arguments, prompt for a warning delay.
13304 With argument TIME, set the deadline at the corresponding date. TIME
13305 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13306 (interactive "P")
13307 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13308 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13309 'region-start-level 'region))
13310 org-loop-over-headlines-in-active-region)
13311 (org-map-entries
13312 `(org-deadline ',arg ,time)
13313 org-loop-over-headlines-in-active-region
13314 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13315 (let* ((old-date (org-entry-get nil "DEADLINE"))
13316 (old-date-time (if old-date (org-time-string-to-time old-date)))
13317 (repeater (and old-date
13318 (string-match
13319 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13320 old-date)
13321 (match-string 1 old-date))))
13322 (cond
13323 ((equal arg '(4))
13324 (when (and old-date org-log-redeadline)
13325 (org-add-log-setup 'deldeadline nil old-date 'findpos
13326 org-log-redeadline))
13327 (org-remove-timestamp-with-keyword org-deadline-string)
13328 (message "Item no longer has a deadline."))
13329 ((equal arg '(16))
13330 (save-excursion
13331 (org-back-to-heading t)
13332 (if (re-search-forward
13333 org-deadline-time-regexp
13334 (save-excursion (outline-next-heading) (point)) t)
13335 (let* ((rpl0 (match-string 1))
13336 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13337 (replace-match
13338 (concat org-deadline-string
13339 " <" rpl
13340 (format " -%dd"
13341 (abs
13342 (- (time-to-days
13343 (save-match-data
13344 (org-read-date nil t nil "Warn starting from" old-date-time)))
13345 (time-to-days old-date-time))))
13346 ">") t t))
13347 (user-error "No deadline information to update"))))
13349 (org-add-planning-info 'deadline time 'closed)
13350 (when (and old-date
13351 org-log-redeadline
13352 (not (equal old-date org-last-inserted-timestamp)))
13353 (org-add-log-setup
13354 'redeadline org-last-inserted-timestamp old-date 'findpos
13355 org-log-redeadline))
13356 (when repeater
13357 (save-excursion
13358 (org-back-to-heading t)
13359 (when (re-search-forward (concat org-deadline-string " "
13360 org-last-inserted-timestamp)
13361 (save-excursion
13362 (outline-next-heading) (point)) t)
13363 (goto-char (1- (match-end 0)))
13364 (insert " " repeater)
13365 (setq org-last-inserted-timestamp
13366 (concat (substring org-last-inserted-timestamp 0 -1)
13367 " " repeater
13368 (substring org-last-inserted-timestamp -1))))))
13369 (message "Deadline on %s" org-last-inserted-timestamp))))))
13371 (defun org-schedule (arg &optional time)
13372 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13373 With one universal prefix argument, remove any scheduling date from the item.
13374 With two universal prefix arguments, prompt for a delay cookie.
13375 With argument TIME, scheduled at the corresponding date. TIME can
13376 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13377 (interactive "P")
13378 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13379 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13380 'region-start-level 'region))
13381 org-loop-over-headlines-in-active-region)
13382 (org-map-entries
13383 `(org-schedule ',arg ,time)
13384 org-loop-over-headlines-in-active-region
13385 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13386 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13387 (old-date-time (if old-date (org-time-string-to-time old-date)))
13388 (repeater (and old-date
13389 (string-match
13390 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13391 old-date)
13392 (match-string 1 old-date))))
13393 (cond
13394 ((equal arg '(4))
13395 (progn
13396 (when (and old-date org-log-reschedule)
13397 (org-add-log-setup 'delschedule nil old-date 'findpos
13398 org-log-reschedule))
13399 (org-remove-timestamp-with-keyword org-scheduled-string)
13400 (message "Item is no longer scheduled.")))
13401 ((equal arg '(16))
13402 (save-excursion
13403 (org-back-to-heading t)
13404 (if (re-search-forward
13405 org-scheduled-time-regexp
13406 (save-excursion (outline-next-heading) (point)) t)
13407 (let* ((rpl0 (match-string 1))
13408 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13409 (replace-match
13410 (concat org-scheduled-string
13411 " <" rpl
13412 (format " -%dd"
13413 (abs
13414 (- (time-to-days
13415 (save-match-data
13416 (org-read-date nil t nil "Delay until" old-date-time)))
13417 (time-to-days old-date-time))))
13418 ">") t t))
13419 (user-error "No scheduled information to update"))))
13421 (org-add-planning-info 'scheduled time 'closed)
13422 (when (and old-date
13423 org-log-reschedule
13424 (not (equal old-date org-last-inserted-timestamp)))
13425 (org-add-log-setup
13426 'reschedule org-last-inserted-timestamp old-date 'findpos
13427 org-log-reschedule))
13428 (when repeater
13429 (save-excursion
13430 (org-back-to-heading t)
13431 (when (re-search-forward (concat org-scheduled-string " "
13432 org-last-inserted-timestamp)
13433 (save-excursion
13434 (outline-next-heading) (point)) t)
13435 (goto-char (1- (match-end 0)))
13436 (insert " " repeater)
13437 (setq org-last-inserted-timestamp
13438 (concat (substring org-last-inserted-timestamp 0 -1)
13439 " " repeater
13440 (substring org-last-inserted-timestamp -1))))))
13441 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13443 (defun org-get-scheduled-time (pom &optional inherit)
13444 "Get the scheduled time as a time tuple, of a format suitable
13445 for calling org-schedule with, or if there is no scheduling,
13446 returns nil."
13447 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13448 (when time
13449 (apply 'encode-time (org-parse-time-string time)))))
13451 (defun org-get-deadline-time (pom &optional inherit)
13452 "Get the deadline as a time tuple, of a format suitable for
13453 calling org-deadline with, or if there is no scheduling, returns
13454 nil."
13455 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13456 (when time
13457 (apply 'encode-time (org-parse-time-string time)))))
13459 (defun org-remove-timestamp-with-keyword (keyword)
13460 "Remove all time stamps with KEYWORD in the current entry."
13461 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13462 beg)
13463 (save-excursion
13464 (org-back-to-heading t)
13465 (setq beg (point))
13466 (outline-next-heading)
13467 (while (re-search-backward re beg t)
13468 (replace-match "")
13469 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13470 (equal (char-before) ?\ ))
13471 (backward-delete-char 1)
13472 (if (string-match "^[ \t]*$" (buffer-substring
13473 (point-at-bol) (point-at-eol)))
13474 (delete-region (point-at-bol)
13475 (min (point-max) (1+ (point-at-eol))))))))))
13477 (defvar org-time-was-given) ; dynamically scoped parameter
13478 (defvar org-end-time-was-given) ; dynamically scoped parameter
13480 (defun org-at-planning-p ()
13481 "Non-nil when point is on a planning info line."
13482 ;; This is as accurate and faster than `org-element-at-point' since
13483 ;; planning info location is fixed in the section.
13484 (org-with-wide-buffer
13485 (beginning-of-line)
13486 (and (org-looking-at-p org-planning-line-re)
13487 (eq (point)
13488 (ignore-errors
13489 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13490 (org-back-to-heading t)
13491 (org-with-limited-levels (org-back-to-heading t)))
13492 (line-beginning-position 2))))))
13494 (defun org-add-planning-info (what &optional time &rest remove)
13495 "Insert new timestamp with keyword in the planning line.
13496 WHAT indicates what kind of time stamp to add. It is a symbol
13497 among `closed', `deadline', `scheduled' and nil. TIME indicates
13498 the time to use. If none is given, the user is prompted for
13499 a date. REMOVE indicates what kind of entries to remove. An old
13500 WHAT entry will also be removed."
13501 (let (org-time-was-given org-end-time-was-given default-time default-input)
13502 (catch 'exit
13503 (when (and (memq what '(scheduled deadline))
13504 (or (not time)
13505 (and (stringp time)
13506 (string-match "^[-+]+[0-9]" time))))
13507 ;; Try to get a default date/time from existing timestamp
13508 (save-excursion
13509 (org-back-to-heading t)
13510 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13511 (when (re-search-forward (if (eq what 'scheduled)
13512 org-scheduled-time-regexp
13513 org-deadline-time-regexp)
13514 end t)
13515 (setq ts (match-string 1)
13516 default-time (apply 'encode-time (org-parse-time-string ts))
13517 default-input (and ts (org-get-compact-tod ts)))))))
13518 (when what
13519 (setq time
13520 (if (stringp time)
13521 ;; This is a string (relative or absolute), set
13522 ;; proper date.
13523 (apply #'encode-time
13524 (org-read-date-analyze
13525 time default-time (decode-time default-time)))
13526 ;; If necessary, get the time from the user
13527 (or time (org-read-date nil 'to-time nil nil
13528 default-time default-input)))))
13530 (org-with-wide-buffer
13531 (org-back-to-heading t)
13532 (forward-line)
13533 (unless (bolp) (insert "\n"))
13534 (cond ((org-looking-at-p org-planning-line-re)
13535 ;; Move to current indentation.
13536 (skip-chars-forward " \t")
13537 ;; Check if we have to remove something.
13538 (dolist (type (if what (cons what remove) remove))
13539 (save-excursion
13540 (when (re-search-forward
13541 (case type
13542 (closed org-closed-time-regexp)
13543 (deadline org-deadline-time-regexp)
13544 (scheduled org-scheduled-time-regexp)
13545 (otherwise
13546 (error "Invalid planning type: %s" type)))
13547 (line-end-position) t)
13548 ;; Delete until next keyword or end of line.
13549 (delete-region
13550 (match-beginning 0)
13551 (if (re-search-forward org-keyword-time-not-clock-regexp
13552 (line-end-position)
13554 (match-beginning 0)
13555 (line-end-position))))))
13556 ;; If there is nothing more to add and no more keyword
13557 ;; is left, remove the line completely.
13558 (if (and (org-looking-at-p "[ \t]*$") (not what))
13559 (delete-region (line-beginning-position)
13560 (line-beginning-position 2))
13561 ;; If we removed last keyword, do not leave trailing
13562 ;; white space at the end of line.
13563 (let ((p (point)))
13564 (save-excursion
13565 (end-of-line)
13566 (unless (= (skip-chars-backward " \t" p) 0)
13567 (delete-region (point) (line-end-position)))))))
13568 ((not what) (throw 'exit nil)) ; Nothing to do.
13569 (t (insert-before-markers "\n")
13570 (backward-char 1)
13571 (when org-adapt-indentation
13572 (org-indent-to-column (1+ (org-outline-level))))))
13573 (when what
13574 ;; Insert planning keyword.
13575 (insert (case what
13576 (closed org-closed-string)
13577 (deadline org-deadline-string)
13578 (scheduled org-scheduled-string)
13579 (otherwise (error "Invalid planning type: %s" what)))
13580 " ")
13581 ;; Insert associated timestamp.
13582 (let ((ts (org-insert-time-stamp
13583 time
13584 (or org-time-was-given
13585 (and (eq what 'closed) org-log-done-with-time))
13586 (eq what 'closed)
13587 nil nil (list org-end-time-was-given))))
13588 (unless (eolp) (insert " "))
13589 ts))))))
13591 (defvar org-log-note-marker (make-marker))
13592 (defvar org-log-note-purpose nil)
13593 (defvar org-log-note-state nil)
13594 (defvar org-log-note-previous-state nil)
13595 (defvar org-log-note-extra nil)
13596 (defvar org-log-note-window-configuration nil)
13597 (defvar org-log-note-return-to (make-marker))
13598 (defvar org-log-note-effective-time nil
13599 "Remembered current time so that dynamically scoped
13600 `org-extend-today-until' affects tha timestamps in state change
13601 log")
13603 (defvar org-log-post-message nil
13604 "Message to be displayed after a log note has been stored.
13605 The auto-repeater uses this.")
13607 (defun org-add-note ()
13608 "Add a note to the current entry.
13609 This is done in the same way as adding a state change note."
13610 (interactive)
13611 (org-add-log-setup 'note nil nil 'findpos nil))
13613 (defun org-log-beginning (&optional create)
13614 "Return expected start of log notes in current entry.
13615 When optional argument CREATE is non-nil, the function creates
13616 a drawer to store notes, if necessary. Returned position ignores
13617 narrowing."
13618 (org-with-wide-buffer
13619 (org-end-of-meta-data)
13620 (let ((end (if (org-at-heading-p) (point)
13621 (save-excursion (outline-next-heading) (point))))
13622 (drawer (org-log-into-drawer)))
13623 (cond
13624 (drawer
13625 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13626 (case-fold-search t))
13627 (catch 'exit
13628 ;; Try to find existing drawer.
13629 (while (re-search-forward regexp end t)
13630 (let ((element (org-element-at-point)))
13631 (when (eq (org-element-type element) 'drawer)
13632 (let ((cend (org-element-property :contents-end element)))
13633 (when (and (not org-log-states-order-reversed) cend)
13634 (goto-char cend)))
13635 (throw 'exit nil))))
13636 ;; No drawer found. Create one, if permitted.
13637 (when create
13638 (unless (bolp) (insert "\n"))
13639 (let ((beg (point)))
13640 (insert ":" drawer ":\n:END:\n")
13641 (org-indent-region beg (point)))
13642 (end-of-line -1)))))
13643 (org-log-state-notes-insert-after-drawers
13644 (while (and (looking-at org-drawer-regexp)
13645 (progn (goto-char (match-end 0))
13646 (re-search-forward org-property-end-re end t)))
13647 (forward-line)))))
13648 (if (bolp) (point) (line-beginning-position 2))))
13650 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13651 "Set up the post command hook to take a note.
13652 If this is about to TODO state change, the new state is expected in STATE.
13653 When FINDPOS is non-nil, find the correct position for the note in
13654 the current entry. If not, assume that it can be inserted at point.
13655 HOW is an indicator what kind of note should be created.
13656 EXTRA is additional text that will be inserted into the notes buffer."
13657 (org-with-wide-buffer
13658 (when findpos
13659 (goto-char (org-log-beginning t))
13660 (unless org-log-states-order-reversed
13661 (org-skip-over-state-notes)
13662 (skip-chars-backward " \t\n\r")
13663 (forward-line)))
13664 (move-marker org-log-note-marker (point))
13665 ;; Preserve position even if a property drawer is inserted in the
13666 ;; process.
13667 (set-marker-insertion-type org-log-note-marker t)
13668 (setq org-log-note-purpose purpose
13669 org-log-note-state state
13670 org-log-note-previous-state prev-state
13671 org-log-note-how how
13672 org-log-note-extra extra
13673 org-log-note-effective-time (org-current-effective-time))
13674 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13676 (defun org-skip-over-state-notes ()
13677 "Skip past the list of State notes in an entry."
13678 (when (ignore-errors (goto-char (org-in-item-p)))
13679 (let* ((struct (org-list-struct))
13680 (prevs (org-list-prevs-alist struct))
13681 (regexp
13682 (concat "[ \t]*- +"
13683 (replace-regexp-in-string
13684 " +" " +"
13685 (org-replace-escapes
13686 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13687 `(("%d" . ,org-ts-regexp-inactive)
13688 ("%D" . ,org-ts-regexp)
13689 ("%s" . "\"\\S-+\"")
13690 ("%S" . "\"\\S-+\"")
13691 ("%t" . ,org-ts-regexp-inactive)
13692 ("%T" . ,org-ts-regexp)
13693 ("%u" . ".*?")
13694 ("%U" . ".*?")))))))
13695 (while (org-looking-at-p regexp)
13696 (goto-char (or (org-list-get-next-item (point) struct prevs)
13697 (org-list-get-item-end (point) struct)))))))
13699 (defun org-add-log-note (&optional purpose)
13700 "Pop up a window for taking a note, and add this note later at point."
13701 (remove-hook 'post-command-hook 'org-add-log-note)
13702 (setq org-log-note-window-configuration (current-window-configuration))
13703 (delete-other-windows)
13704 (move-marker org-log-note-return-to (point))
13705 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13706 (goto-char org-log-note-marker)
13707 (org-switch-to-buffer-other-window "*Org Note*")
13708 (erase-buffer)
13709 (if (memq org-log-note-how '(time state))
13710 (let (current-prefix-arg) (org-store-log-note))
13711 (let ((org-inhibit-startup t)) (org-mode))
13712 (insert (format "# Insert note for %s.
13713 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13714 (cond
13715 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13716 ((eq org-log-note-purpose 'done) "closed todo item")
13717 ((eq org-log-note-purpose 'state)
13718 (format "state change from \"%s\" to \"%s\""
13719 (or org-log-note-previous-state "")
13720 (or org-log-note-state "")))
13721 ((eq org-log-note-purpose 'reschedule)
13722 "rescheduling")
13723 ((eq org-log-note-purpose 'delschedule)
13724 "no longer scheduled")
13725 ((eq org-log-note-purpose 'redeadline)
13726 "changing deadline")
13727 ((eq org-log-note-purpose 'deldeadline)
13728 "removing deadline")
13729 ((eq org-log-note-purpose 'refile)
13730 "refiling")
13731 ((eq org-log-note-purpose 'note)
13732 "this entry")
13733 (t (error "This should not happen")))))
13734 (if org-log-note-extra (insert org-log-note-extra))
13735 (org-set-local 'org-finish-function 'org-store-log-note)
13736 (run-hooks 'org-log-buffer-setup-hook)))
13738 (defvar org-note-abort nil) ; dynamically scoped
13739 (defun org-store-log-note ()
13740 "Finish taking a log note, and insert it to where it belongs."
13741 (let ((txt (buffer-string)))
13742 (kill-buffer (current-buffer))
13743 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13744 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13745 (setq txt (replace-match "" t t txt)))
13746 (if (string-match "\\s-+\\'" txt)
13747 (setq txt (replace-match "" t t txt)))
13748 (setq lines (org-split-string txt "\n"))
13749 (when (and note (string-match "\\S-" note))
13750 (setq note
13751 (org-replace-escapes
13752 note
13753 (list (cons "%u" (user-login-name))
13754 (cons "%U" user-full-name)
13755 (cons "%t" (format-time-string
13756 (org-time-stamp-format 'long 'inactive)
13757 org-log-note-effective-time))
13758 (cons "%T" (format-time-string
13759 (org-time-stamp-format 'long nil)
13760 org-log-note-effective-time))
13761 (cons "%d" (format-time-string
13762 (org-time-stamp-format nil 'inactive)
13763 org-log-note-effective-time))
13764 (cons "%D" (format-time-string
13765 (org-time-stamp-format nil nil)
13766 org-log-note-effective-time))
13767 (cons "%s" (cond
13768 ((not org-log-note-state) "")
13769 ((org-string-match-p org-ts-regexp
13770 org-log-note-state)
13771 (format "\"[%s]\""
13772 (substring org-log-note-state 1 -1)))
13773 (t (format "\"%s\"" org-log-note-state))))
13774 (cons "%S"
13775 (cond
13776 ((not org-log-note-previous-state) "")
13777 ((org-string-match-p org-ts-regexp
13778 org-log-note-previous-state)
13779 (format "\"[%s]\""
13780 (substring
13781 org-log-note-previous-state 1 -1)))
13782 (t (format "\"%s\""
13783 org-log-note-previous-state)))))))
13784 (when lines (setq note (concat note " \\\\")))
13785 (push note lines))
13786 (when (or current-prefix-arg org-note-abort)
13787 (when (org-log-into-drawer)
13788 (org-remove-empty-drawer-at org-log-note-marker))
13789 (setq lines nil))
13790 (when lines
13791 (with-current-buffer (marker-buffer org-log-note-marker)
13792 (org-with-wide-buffer
13793 (goto-char org-log-note-marker)
13794 (move-marker org-log-note-marker nil)
13795 ;; Make sure point is at the beginning of an empty line.
13796 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13797 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13798 ;; In an existing list, add a new item at the top level.
13799 ;; Otherwise, indent line like a regular one.
13800 (let ((itemp (org-in-item-p)))
13801 (if itemp
13802 (org-indent-line-to
13803 (let ((struct (save-excursion
13804 (goto-char itemp) (org-list-struct))))
13805 (org-list-get-ind (org-list-get-top-point struct) struct)))
13806 (org-indent-line)))
13807 (insert (org-list-bullet-string "-") (pop lines))
13808 (let ((ind (org-list-item-body-column (line-beginning-position))))
13809 (dolist (line lines)
13810 (insert "\n")
13811 (org-indent-line-to ind)
13812 (insert line)))
13813 (message "Note stored")
13814 (org-back-to-heading t)
13815 (org-cycle-hide-drawers 'children))
13816 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13817 ;; from within `org-add-log-note' because `buffer-undo-list'
13818 ;; is then modified outside of `org-with-remote-undo'.
13819 (when (eq this-command 'org-agenda-todo)
13820 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13821 ;; Don't add undo information when called from `org-agenda-todo'
13822 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13823 (set-window-configuration org-log-note-window-configuration)
13824 (with-current-buffer (marker-buffer org-log-note-return-to)
13825 (goto-char org-log-note-return-to))
13826 (move-marker org-log-note-return-to nil)
13827 (and org-log-post-message (message "%s" org-log-post-message))))
13829 (defun org-remove-empty-drawer-at (pos)
13830 "Remove an empty drawer at position POS.
13831 POS may also be a marker."
13832 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13833 (org-with-wide-buffer
13834 (goto-char pos)
13835 (let ((drawer (org-element-at-point)))
13836 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13837 (not (org-element-property :contents-begin drawer)))
13838 (delete-region (org-element-property :begin drawer)
13839 (progn (goto-char (org-element-property :end drawer))
13840 (skip-chars-backward " \r\t\n")
13841 (forward-line)
13842 (point))))))))
13844 (defvar org-ts-type nil)
13845 (defun org-sparse-tree (&optional arg type)
13846 "Create a sparse tree, prompt for the details.
13847 This command can create sparse trees. You first need to select the type
13848 of match used to create the tree:
13850 t Show all TODO entries.
13851 T Show entries with a specific TODO keyword.
13852 m Show entries selected by a tags/property match.
13853 p Enter a property name and its value (both with completion on existing
13854 names/values) and show entries with that property.
13855 r Show entries matching a regular expression (`/' can be used as well).
13856 b Show deadlines and scheduled items before a date.
13857 a Show deadlines and scheduled items after a date.
13858 d Show deadlines due within `org-deadline-warning-days'.
13859 D Show deadlines and scheduled items between a date range."
13860 (interactive "P")
13861 (setq type (or type org-sparse-tree-default-date-type))
13862 (setq org-ts-type type)
13863 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13864 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13865 [c]ycle through date types: %s"
13866 (case type
13867 (all "all timestamps")
13868 (scheduled "only scheduled")
13869 (deadline "only deadline")
13870 (active "only active timestamps")
13871 (inactive "only inactive timestamps")
13872 (closed "with a closed time-stamp")
13873 (otherwise "scheduled/deadline")))
13874 (let ((answer (read-char-exclusive)))
13875 (case answer
13877 (org-sparse-tree
13879 (cadr
13880 (memq type '(nil all scheduled deadline active inactive closed)))))
13881 (?d (call-interactively 'org-check-deadlines))
13882 (?b (call-interactively 'org-check-before-date))
13883 (?a (call-interactively 'org-check-after-date))
13884 (?D (call-interactively 'org-check-dates-range))
13885 (?t (call-interactively 'org-show-todo-tree))
13886 (?T (org-show-todo-tree '(4)))
13887 (?m (call-interactively 'org-match-sparse-tree))
13888 ((?p ?P)
13889 (let* ((kwd (org-icompleting-read
13890 "Property: " (mapcar 'list (org-buffer-property-keys))))
13891 (value (org-icompleting-read
13892 "Value: " (mapcar 'list (org-property-values kwd)))))
13893 (unless (string-match "\\`{.*}\\'" value)
13894 (setq value (concat "\"" value "\"")))
13895 (org-match-sparse-tree arg (concat kwd "=" value))))
13896 ((?r ?R ?/) (call-interactively 'org-occur))
13897 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13899 (defvar org-occur-highlights nil
13900 "List of overlays used for occur matches.")
13901 (make-variable-buffer-local 'org-occur-highlights)
13902 (defvar org-occur-parameters nil
13903 "Parameters of the active org-occur calls.
13904 This is a list, each call to org-occur pushes as cons cell,
13905 containing the regular expression and the callback, onto the list.
13906 The list can contain several entries if `org-occur' has been called
13907 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13908 will only contain one set of parameters. When the highlights are
13909 removed (for example with `C-c C-c', or with the next edit (depending
13910 on `org-remove-highlights-with-change'), this variable is emptied
13911 as well.")
13912 (make-variable-buffer-local 'org-occur-parameters)
13914 (defun org-occur (regexp &optional keep-previous callback)
13915 "Make a compact tree which shows all matches of REGEXP.
13916 The tree will show the lines where the regexp matches, and all higher
13917 headlines above the match. It will also show the heading after the match,
13918 to make sure editing the matching entry is easy.
13919 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13920 call to `org-occur' will be kept, to allow stacking of calls to this
13921 command.
13922 If CALLBACK is non-nil, it is a function which is called to confirm
13923 that the match should indeed be shown."
13924 (interactive "sRegexp: \nP")
13925 (when (equal regexp "")
13926 (user-error "Regexp cannot be empty"))
13927 (unless keep-previous
13928 (org-remove-occur-highlights nil nil t))
13929 (push (cons regexp callback) org-occur-parameters)
13930 (let ((cnt 0))
13931 (save-excursion
13932 (goto-char (point-min))
13933 (if (or (not keep-previous) ; do not want to keep
13934 (not org-occur-highlights)) ; no previous matches
13935 ;; hide everything
13936 (org-overview))
13937 (while (re-search-forward regexp nil t)
13938 (backward-char) ;; FIXME: Match timestamps at the end of a headline
13939 (when (or (not callback)
13940 (save-match-data (funcall callback)))
13941 (setq cnt (1+ cnt))
13942 (when org-highlight-sparse-tree-matches
13943 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13944 (org-show-context 'occur-tree))))
13945 (when org-remove-highlights-with-change
13946 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13947 nil 'local))
13948 (unless org-sparse-tree-open-archived-trees
13949 (org-hide-archived-subtrees (point-min) (point-max)))
13950 (run-hooks 'org-occur-hook)
13951 (if (org-called-interactively-p 'interactive)
13952 (message "%d match(es) for regexp %s" cnt regexp))
13953 cnt))
13955 (defun org-occur-next-match (&optional n reset)
13956 "Function for `next-error-function' to find sparse tree matches.
13957 N is the number of matches to move, when negative move backwards.
13958 RESET is entirely ignored - this function always goes back to the
13959 starting point when no match is found."
13960 (let* ((limit (if (< n 0) (point-min) (point-max)))
13961 (search-func (if (< n 0)
13962 'previous-single-char-property-change
13963 'next-single-char-property-change))
13964 (n (abs n))
13965 (pos (point))
13967 (catch 'exit
13968 (while (setq p1 (funcall search-func (point) 'org-type))
13969 (when (equal p1 limit)
13970 (goto-char pos)
13971 (user-error "No more matches"))
13972 (when (equal (get-char-property p1 'org-type) 'org-occur)
13973 (setq n (1- n))
13974 (when (= n 0)
13975 (goto-char p1)
13976 (throw 'exit (point))))
13977 (goto-char p1))
13978 (goto-char p1)
13979 (user-error "No more matches"))))
13981 (defun org-show-context (&optional key)
13982 "Make sure point and context are visible.
13983 Optional argument KEY, when non-nil, is a symbol. See
13984 `org-show-context-detail' for allowed values and how much is to
13985 be shown."
13986 (org-show-set-visibility
13987 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13988 ((cdr (assq key org-show-context-detail)))
13989 (t (cdr (assq 'default org-show-context-detail))))))
13991 (defun org-show-set-visibility (detail)
13992 "Set visibility around point according to DETAIL.
13993 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13994 `tree', `canonical' or t. See `org-show-context-detail' for more
13995 information."
13996 (unless (org-before-first-heading-p)
13997 ;; Show current heading and possibly its entry, following headline
13998 ;; or all children.
13999 (if (and (org-at-heading-p) (not (eq detail 'local)))
14000 (org-flag-heading nil)
14001 (org-show-entry)
14002 (org-with-limited-levels
14003 (case detail
14004 ((tree canonical t) (outline-show-children))
14005 ((nil minimal ancestors))
14006 (t (save-excursion
14007 (outline-next-heading)
14008 (org-flag-heading nil))))))
14009 ;; Show all siblings.
14010 (when (eq detail 'lineage) (org-show-siblings))
14011 ;; Show ancestors, possibly with their children.
14012 (when (memq detail '(ancestors lineage tree canonical t))
14013 (save-excursion
14014 (while (org-up-heading-safe)
14015 (org-flag-heading nil)
14016 (when (memq detail '(canonical t)) (org-show-entry))
14017 (when (memq detail '(tree canonical t)) (outline-show-children)))))))
14019 (defvar org-reveal-start-hook nil
14020 "Hook run before revealing a location.")
14022 (defun org-reveal (&optional siblings)
14023 "Show current entry, hierarchy above it, and the following headline.
14025 This can be used to show a consistent set of context around
14026 locations exposed with `org-show-context'.
14028 With optional argument SIBLINGS, on each level of the hierarchy all
14029 siblings are shown. This repairs the tree structure to what it would
14030 look like when opened with hierarchical calls to `org-cycle'.
14032 With double optional argument \\[universal-argument] \\[universal-argument], \
14033 go to the parent and show the
14034 entire tree."
14035 (interactive "P")
14036 (run-hooks 'org-reveal-start-hook)
14037 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14038 ((equal siblings '(16))
14039 (save-excursion
14040 (when (org-up-heading-safe)
14041 (org-show-subtree)
14042 (run-hook-with-args 'org-cycle-hook 'subtree))))
14043 (t (org-show-set-visibility 'lineage))))
14045 (defun org-highlight-new-match (beg end)
14046 "Highlight from BEG to END and mark the highlight is an occur headline."
14047 (let ((ov (make-overlay beg end)))
14048 (overlay-put ov 'face 'secondary-selection)
14049 (overlay-put ov 'org-type 'org-occur)
14050 (push ov org-occur-highlights)))
14052 (defun org-remove-occur-highlights (&optional beg end noremove)
14053 "Remove the occur highlights from the buffer.
14054 BEG and END are ignored. If NOREMOVE is nil, remove this function
14055 from the `before-change-functions' in the current buffer."
14056 (interactive)
14057 (unless org-inhibit-highlight-removal
14058 (mapc 'delete-overlay org-occur-highlights)
14059 (setq org-occur-highlights nil)
14060 (setq org-occur-parameters nil)
14061 (unless noremove
14062 (remove-hook 'before-change-functions
14063 'org-remove-occur-highlights 'local))))
14065 ;;;; Priorities
14067 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14068 "Regular expression matching the priority indicator.")
14070 (defvar org-remove-priority-next-time nil)
14072 (defun org-priority-up ()
14073 "Increase the priority of the current item."
14074 (interactive)
14075 (org-priority 'up))
14077 (defun org-priority-down ()
14078 "Decrease the priority of the current item."
14079 (interactive)
14080 (org-priority 'down))
14082 (defun org-priority (&optional action show)
14083 "Change the priority of an item.
14084 ACTION can be `set', `up', `down', or a character."
14085 (interactive "P")
14086 (if (equal action '(4))
14087 (org-show-priority)
14088 (unless org-enable-priority-commands
14089 (user-error "Priority commands are disabled"))
14090 (setq action (or action 'set))
14091 (let (current new news have remove)
14092 (save-excursion
14093 (org-back-to-heading t)
14094 (if (looking-at org-priority-regexp)
14095 (setq current (string-to-char (match-string 2))
14096 have t))
14097 (cond
14098 ((eq action 'remove)
14099 (setq remove t new ?\ ))
14100 ((or (eq action 'set)
14101 (if (featurep 'xemacs) (characterp action) (integerp action)))
14102 (if (not (eq action 'set))
14103 (setq new action)
14104 (message "Priority %c-%c, SPC to remove: "
14105 org-highest-priority org-lowest-priority)
14106 (save-match-data
14107 (setq new (read-char-exclusive))))
14108 (if (and (= (upcase org-highest-priority) org-highest-priority)
14109 (= (upcase org-lowest-priority) org-lowest-priority))
14110 (setq new (upcase new)))
14111 (cond ((equal new ?\ ) (setq remove t))
14112 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14113 (user-error "Priority must be between `%c' and `%c'"
14114 org-highest-priority org-lowest-priority))))
14115 ((eq action 'up)
14116 (setq new (if have
14117 (1- current) ; normal cycling
14118 ;; last priority was empty
14119 (if (eq last-command this-command)
14120 org-lowest-priority ; wrap around empty to lowest
14121 ;; default
14122 (if org-priority-start-cycle-with-default
14123 org-default-priority
14124 (1- org-default-priority))))))
14125 ((eq action 'down)
14126 (setq new (if have
14127 (1+ current) ; normal cycling
14128 ;; last priority was empty
14129 (if (eq last-command this-command)
14130 org-highest-priority ; wrap around empty to highest
14131 ;; default
14132 (if org-priority-start-cycle-with-default
14133 org-default-priority
14134 (1+ org-default-priority))))))
14135 (t (user-error "Invalid action")))
14136 (if (or (< (upcase new) org-highest-priority)
14137 (> (upcase new) org-lowest-priority))
14138 (if (and (memq action '(up down))
14139 (not have) (not (eq last-command this-command)))
14140 ;; `new' is from default priority
14141 (error
14142 "The default can not be set, see `org-default-priority' why")
14143 ;; normal cycling: `new' is beyond highest/lowest priority
14144 ;; and is wrapped around to the empty priority
14145 (setq remove t)))
14146 (setq news (format "%c" new))
14147 (if have
14148 (if remove
14149 (replace-match "" t t nil 1)
14150 (replace-match news t t nil 2))
14151 (if remove
14152 (user-error "No priority cookie found in line")
14153 (let ((case-fold-search nil))
14154 (looking-at org-todo-line-regexp))
14155 (if (match-end 2)
14156 (progn
14157 (goto-char (match-end 2))
14158 (insert " [#" news "]"))
14159 (goto-char (match-beginning 3))
14160 (insert "[#" news "] "))))
14161 (org-set-tags nil 'align))
14162 (if remove
14163 (message "Priority removed")
14164 (message "Priority of current item set to %s" news)))))
14166 (defun org-show-priority ()
14167 "Show the priority of the current item.
14168 This priority is composed of the main priority given with the [#A] cookies,
14169 and by additional input from the age of a schedules or deadline entry."
14170 (interactive)
14171 (let ((pri (if (eq major-mode 'org-agenda-mode)
14172 (org-get-at-bol 'priority)
14173 (save-excursion
14174 (save-match-data
14175 (beginning-of-line)
14176 (and (looking-at org-heading-regexp)
14177 (org-get-priority (match-string 0))))))))
14178 (message "Priority is %d" (if pri pri -1000))))
14180 (defun org-get-priority (s)
14181 "Find priority cookie and return priority."
14182 (save-match-data
14183 (if (functionp org-get-priority-function)
14184 (funcall org-get-priority-function)
14185 (if (not (string-match org-priority-regexp s))
14186 (* 1000 (- org-lowest-priority org-default-priority))
14187 (* 1000 (- org-lowest-priority
14188 (string-to-char (match-string 2 s))))))))
14190 ;;;; Tags
14192 (defvar org-agenda-archives-mode)
14193 (defvar org-map-continue-from nil
14194 "Position from where mapping should continue.
14195 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14197 (defvar org-scanner-tags nil
14198 "The current tag list while the tags scanner is running.")
14199 (defvar org-trust-scanner-tags nil
14200 "Should `org-get-tags-at' use the tags for the scanner.
14201 This is for internal dynamical scoping only.
14202 When this is non-nil, the function `org-get-tags-at' will return the value
14203 of `org-scanner-tags' instead of building the list by itself. This
14204 can lead to large speed-ups when the tags scanner is used in a file with
14205 many entries, and when the list of tags is retrieved, for example to
14206 obtain a list of properties. Building the tags list for each entry in such
14207 a file becomes an N^2 operation - but with this variable set, it scales
14208 as N.")
14210 (defun org-scan-tags (action matcher todo-only &optional start-level)
14211 "Scan headline tags with inheritance and produce output ACTION.
14213 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14214 or `agenda' to produce an entry list for an agenda view. It can also be
14215 a Lisp form or a function that should be called at each matched headline, in
14216 this case the return value is a list of all return values from these calls.
14218 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14219 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14220 only lines with a not-done TODO keyword are included in the output.
14221 This should be the same variable that was scoped into
14222 and set by `org-make-tags-matcher' when it constructed MATCHER.
14224 START-LEVEL can be a string with asterisks, reducing the scope to
14225 headlines matching this string."
14226 (require 'org-agenda)
14227 (let* ((re (concat "^"
14228 (if start-level
14229 ;; Get the correct level to match
14230 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14231 org-outline-regexp)
14232 " *\\(\\<\\("
14233 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14234 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14235 (props (list 'face 'default
14236 'done-face 'org-agenda-done
14237 'undone-face 'default
14238 'mouse-face 'highlight
14239 'org-not-done-regexp org-not-done-regexp
14240 'org-todo-regexp org-todo-regexp
14241 'org-complex-heading-regexp org-complex-heading-regexp
14242 'help-echo
14243 (format "mouse-2 or RET jump to org file %s"
14244 (abbreviate-file-name
14245 (or (buffer-file-name (buffer-base-buffer))
14246 (buffer-name (buffer-base-buffer)))))))
14247 (org-map-continue-from nil)
14248 lspos tags tags-list
14249 (tags-alist (list (cons 0 org-file-tags)))
14250 (llast 0) rtn rtn1 level category i txt
14251 todo marker entry priority
14252 ts-date ts-date-type ts-date-pair)
14253 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14254 (setq action (list 'lambda nil action)))
14255 (save-excursion
14256 (goto-char (point-min))
14257 (when (eq action 'sparse-tree)
14258 (org-overview)
14259 (org-remove-occur-highlights))
14260 (while (let (case-fold-search)
14261 (re-search-forward re nil t))
14262 (setq org-map-continue-from nil)
14263 (catch :skip
14264 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14265 tags (if (match-end 4) (org-match-string-no-properties 4)))
14266 (goto-char (setq lspos (match-beginning 0)))
14267 (setq level (org-reduced-level (org-outline-level))
14268 category (org-get-category))
14269 (when (eq action 'agenda)
14270 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14271 ts-date (car ts-date-pair)
14272 ts-date-type (cdr ts-date-pair)))
14273 (setq i llast llast level)
14274 ;; remove tag lists from same and sublevels
14275 (while (>= i level)
14276 (when (setq entry (assoc i tags-alist))
14277 (setq tags-alist (delete entry tags-alist)))
14278 (setq i (1- i)))
14279 ;; add the next tags
14280 (when tags
14281 (setq tags (org-split-string tags ":")
14282 tags-alist
14283 (cons (cons level tags) tags-alist)))
14284 ;; compile tags for current headline
14285 (setq tags-list
14286 (if org-use-tag-inheritance
14287 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14288 tags)
14289 org-scanner-tags tags-list)
14290 (when org-use-tag-inheritance
14291 (setcdr (car tags-alist)
14292 (mapcar (lambda (x)
14293 (setq x (copy-sequence x))
14294 (org-add-prop-inherited x))
14295 (cdar tags-alist))))
14296 (when (and tags org-use-tag-inheritance
14297 (or (not (eq t org-use-tag-inheritance))
14298 org-tags-exclude-from-inheritance))
14299 ;; selective inheritance, remove uninherited ones
14300 (setcdr (car tags-alist)
14301 (org-remove-uninherited-tags (cdar tags-alist))))
14302 (when (and
14304 ;; eval matcher only when the todo condition is OK
14305 (and (or (not todo-only) (member todo org-not-done-keywords))
14306 (let ((case-fold-search t) (org-trust-scanner-tags t))
14307 (eval matcher)))
14309 ;; Call the skipper, but return t if it does not skip,
14310 ;; so that the `and' form continues evaluating
14311 (progn
14312 (unless (eq action 'sparse-tree) (org-agenda-skip))
14315 ;; Check if timestamps are deselecting this entry
14316 (or (not todo-only)
14317 (and (member todo org-not-done-keywords)
14318 (or (not org-agenda-tags-todo-honor-ignore-options)
14319 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14321 ;; select this headline
14322 (cond
14323 ((eq action 'sparse-tree)
14324 (and org-highlight-sparse-tree-matches
14325 (org-get-heading) (match-end 0)
14326 (org-highlight-new-match
14327 (match-beginning 1) (match-end 1)))
14328 (org-show-context 'tags-tree))
14329 ((eq action 'agenda)
14330 (setq txt (org-agenda-format-item
14332 (concat
14333 (if (eq org-tags-match-list-sublevels 'indented)
14334 (make-string (1- level) ?.) "")
14335 (org-get-heading))
14336 (make-string level ?\s)
14337 category
14338 tags-list)
14339 priority (org-get-priority txt))
14340 (goto-char lspos)
14341 (setq marker (org-agenda-new-marker))
14342 (org-add-props txt props
14343 'org-marker marker 'org-hd-marker marker 'org-category category
14344 'todo-state todo
14345 'ts-date ts-date
14346 'priority priority
14347 'type (concat "tagsmatch" ts-date-type))
14348 (push txt rtn))
14349 ((functionp action)
14350 (setq org-map-continue-from nil)
14351 (save-excursion
14352 (setq rtn1 (funcall action))
14353 (push rtn1 rtn)))
14354 (t (user-error "Invalid action")))
14356 ;; if we are to skip sublevels, jump to end of subtree
14357 (unless org-tags-match-list-sublevels
14358 (org-end-of-subtree t)
14359 (backward-char 1))))
14360 ;; Get the correct position from where to continue
14361 (if org-map-continue-from
14362 (goto-char org-map-continue-from)
14363 (and (= (point) lspos) (end-of-line 1)))))
14364 (when (and (eq action 'sparse-tree)
14365 (not org-sparse-tree-open-archived-trees))
14366 (org-hide-archived-subtrees (point-min) (point-max)))
14367 (nreverse rtn)))
14369 (defun org-remove-uninherited-tags (tags)
14370 "Remove all tags that are not inherited from the list TAGS."
14371 (cond
14372 ((eq org-use-tag-inheritance t)
14373 (if org-tags-exclude-from-inheritance
14374 (org-delete-all org-tags-exclude-from-inheritance tags)
14375 tags))
14376 ((not org-use-tag-inheritance) nil)
14377 ((stringp org-use-tag-inheritance)
14378 (delq nil (mapcar
14379 (lambda (x)
14380 (if (and (string-match org-use-tag-inheritance x)
14381 (not (member x org-tags-exclude-from-inheritance)))
14382 x nil))
14383 tags)))
14384 ((listp org-use-tag-inheritance)
14385 (delq nil (mapcar
14386 (lambda (x)
14387 (if (member x org-use-tag-inheritance) x nil))
14388 tags)))))
14390 (defun org-match-sparse-tree (&optional todo-only match)
14391 "Create a sparse tree according to tags string MATCH.
14392 MATCH can contain positive and negative selection of tags, like
14393 \"+WORK+URGENT-WITHBOSS\".
14394 If optional argument TODO-ONLY is non-nil, only select lines that are
14395 also TODO lines."
14396 (interactive "P")
14397 (org-agenda-prepare-buffers (list (current-buffer)))
14398 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14400 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14402 (defvar org-cached-props nil)
14403 (defun org-cached-entry-get (pom property)
14404 (if (or (eq t org-use-property-inheritance)
14405 (and (stringp org-use-property-inheritance)
14406 (let ((case-fold-search t))
14407 (org-string-match-p org-use-property-inheritance property)))
14408 (and (listp org-use-property-inheritance)
14409 (member-ignore-case property org-use-property-inheritance)))
14410 ;; Caching is not possible, check it directly.
14411 (org-entry-get pom property 'inherit)
14412 ;; Get all properties, so we can do complicated checks easily.
14413 (cdr (assoc-string property
14414 (or org-cached-props
14415 (setq org-cached-props (org-entry-properties pom)))
14416 t))))
14418 (defun org-global-tags-completion-table (&optional files)
14419 "Return the list of all tags in all agenda buffer/files.
14420 Optional FILES argument is a list of files which can be used
14421 instead of the agenda files."
14422 (save-excursion
14423 (org-uniquify
14424 (delq nil
14425 (apply 'append
14426 (mapcar
14427 (lambda (file)
14428 (set-buffer (find-file-noselect file))
14429 (append (org-get-buffer-tags)
14430 (mapcar (lambda (x) (if (stringp (car-safe x))
14431 (list (car-safe x)) nil))
14432 org-tag-alist)))
14433 (if (and files (car files))
14434 files
14435 (org-agenda-files))))))))
14437 (defun org-make-tags-matcher (match)
14438 "Create the TAGS/TODO matcher form for the selection string MATCH.
14440 The variable `todo-only' is scoped dynamically into this function.
14441 It will be set to t if the matcher restricts matching to TODO entries,
14442 otherwise will not be touched.
14444 Returns a cons of the selection string MATCH and the constructed
14445 lisp form implementing the matcher. The matcher is to be evaluated
14446 at an Org entry, with point on the headline, and returns t if the
14447 entry matches the selection string MATCH. The returned lisp form
14448 references two variables with information about the entry, which
14449 must be bound around the form's evaluation: todo, the TODO keyword
14450 at the entry (or nil of none); and tags-list, the list of all tags
14451 at the entry including inherited ones. Additionally, the category
14452 of the entry (if any) must be specified as the text property
14453 `org-category' on the headline.
14455 See also `org-scan-tags'.
14457 (declare (special todo-only))
14458 (unless (boundp 'todo-only)
14459 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14460 (unless match
14461 ;; Get a new match request, with completion against the global
14462 ;; tags table and the local tags in current buffer
14463 (let ((org-last-tags-completion-table
14464 (org-uniquify
14465 (delq nil (append (org-get-buffer-tags)
14466 (org-global-tags-completion-table))))))
14467 (setq match (org-completing-read-no-i
14468 "Match: " 'org-tags-completion-function nil nil nil
14469 'org-tags-history))))
14471 ;; Parse the string and create a lisp form
14472 (let ((match0 match)
14473 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14474 minus tag mm
14475 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14476 orterms term orlist re-p str-p level-p level-op time-p
14477 prop-p pn pv po gv rest (start 0) (ss 0))
14478 ;; Expand group tags
14479 (setq match (org-tags-expand match))
14481 ;; Check if there is a TODO part of this match, which would be the
14482 ;; part after a "/". TO make sure that this slash is not part of
14483 ;; a property value to be matched against, we also check that there
14484 ;; is no " after that slash.
14485 ;; First, find the last slash
14486 (while (string-match "/+" match ss)
14487 (setq start (match-beginning 0) ss (match-end 0)))
14488 (if (and (string-match "/+" match start)
14489 (not (save-match-data (string-match "\"" match start))))
14490 ;; match contains also a todo-matching request
14491 (progn
14492 (setq tagsmatch (substring match 0 (match-beginning 0))
14493 todomatch (substring match (match-end 0)))
14494 (if (string-match "^!" todomatch)
14495 (setq todo-only t todomatch (substring todomatch 1)))
14496 (if (string-match "^\\s-*$" todomatch)
14497 (setq todomatch nil)))
14498 ;; only matching tags
14499 (setq tagsmatch match todomatch nil))
14501 ;; Make the tags matcher
14502 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14503 (setq tagsmatcher t)
14504 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14505 (while (setq term (pop orterms))
14506 (while (and (equal (substring term -1) "\\") orterms)
14507 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14508 (while (string-match re term)
14509 (setq rest (substring term (match-end 0))
14510 minus (and (match-end 1)
14511 (equal (match-string 1 term) "-"))
14512 tag (save-match-data (replace-regexp-in-string
14513 "\\\\-" "-"
14514 (match-string 2 term)))
14515 re-p (equal (string-to-char tag) ?{)
14516 level-p (match-end 4)
14517 prop-p (match-end 5)
14518 mm (cond
14519 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14520 (level-p
14521 (setq level-op (org-op-to-function (match-string 3 term)))
14522 `(,level-op level ,(string-to-number
14523 (match-string 4 term))))
14524 (prop-p
14525 (setq pn (match-string 5 term)
14526 po (match-string 6 term)
14527 pv (match-string 7 term)
14528 re-p (equal (string-to-char pv) ?{)
14529 str-p (equal (string-to-char pv) ?\")
14530 time-p (save-match-data
14531 (string-match "^\"[[<].*[]>]\"$" pv))
14532 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14533 (if time-p (setq pv (org-matcher-time pv)))
14534 (setq po (org-op-to-function po (if time-p 'time str-p)))
14535 (cond
14536 ((equal pn "CATEGORY")
14537 (setq gv '(get-text-property (point) 'org-category)))
14538 ((equal pn "TODO")
14539 (setq gv 'todo))
14541 (setq gv `(org-cached-entry-get nil ,pn))))
14542 (if re-p
14543 (if (eq po 'org<>)
14544 `(not (string-match ,pv (or ,gv "")))
14545 `(string-match ,pv (or ,gv "")))
14546 (if str-p
14547 `(,po (or ,gv "") ,pv)
14548 `(,po (string-to-number (or ,gv ""))
14549 ,(string-to-number pv) ))))
14550 (t `(member ,tag tags-list)))
14551 mm (if minus (list 'not mm) mm)
14552 term rest)
14553 (push mm tagsmatcher))
14554 (push (if (> (length tagsmatcher) 1)
14555 (cons 'and tagsmatcher)
14556 (car tagsmatcher))
14557 orlist)
14558 (setq tagsmatcher nil))
14559 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14560 (setq tagsmatcher
14561 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14562 ;; Make the todo matcher
14563 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14564 (setq todomatcher t)
14565 (setq orterms (org-split-string todomatch "|") orlist nil)
14566 (dolist (term orterms)
14567 (while (string-match re term)
14568 (setq minus (and (match-end 1)
14569 (equal (match-string 1 term) "-"))
14570 kwd (match-string 2 term)
14571 re-p (equal (string-to-char kwd) ?{)
14572 term (substring term (match-end 0))
14573 mm (if re-p
14574 `(string-match ,(substring kwd 1 -1) todo)
14575 (list 'equal 'todo kwd))
14576 mm (if minus (list 'not mm) mm))
14577 (push mm todomatcher))
14578 (push (if (> (length todomatcher) 1)
14579 (cons 'and todomatcher)
14580 (car todomatcher))
14581 orlist)
14582 (setq todomatcher nil))
14583 (setq todomatcher (if (> (length orlist) 1)
14584 (cons 'or orlist) (car orlist))))
14586 ;; Return the string and lisp forms of the matcher
14587 (setq matcher (if todomatcher
14588 (list 'and tagsmatcher todomatcher)
14589 tagsmatcher))
14590 (when todo-only
14591 (setq matcher (list 'and '(member todo org-not-done-keywords)
14592 matcher)))
14593 (cons match0 matcher)))
14595 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14596 "Expand group tags in MATCH.
14598 This replaces every group tag in MATCH with a regexp tag search.
14599 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14600 will be replaced like this:
14602 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14603 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14604 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14606 Replacing by a regexp preserves the structure of the match.
14607 E.g., this expansion
14609 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14611 will match anything tagged with \"Lab\" and \"Home\", or tagged
14612 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14614 A group tag in MATCH can contain regular expressions of its own.
14615 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14616 will be replaced like this:
14618 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14620 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14621 assumed to be a single group tag, and the function will return
14622 the list of tags in this group.
14624 When DOWNCASE is non-nil, expand downcased TAGS."
14625 (if org-group-tags
14626 (let* ((case-fold-search t)
14627 (stable org-mode-syntax-table)
14628 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14629 (taggroups (if downcased
14630 (mapcar (lambda (tg) (mapcar #'downcase tg))
14631 taggroups)
14632 taggroups))
14633 (taggroups-keys (mapcar #'car taggroups))
14634 (return-match (if downcased (downcase match) match))
14635 (count 0)
14636 (work-already-expanded tags-already-expanded)
14637 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14638 ;; @ and _ are allowed as word-components in tags.
14639 (modify-syntax-entry ?@ "w" stable)
14640 (modify-syntax-entry ?_ "w" stable)
14641 ;; Temporarily replace regexp-expressions in the match-expression.
14642 (while (string-match "{.+?}" return-match)
14643 (incf count)
14644 (push (match-string 0 return-match) regexps-in-match)
14645 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14646 (while (and taggroups-keys
14647 (with-syntax-table stable
14648 (string-match
14649 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14650 (regexp-opt taggroups-keys) "\\>\\)")
14651 return-match)))
14652 (let* ((dir (match-string 1 return-match))
14653 (tag (match-string 2 return-match))
14654 (tag (if downcased (downcase tag) tag)))
14655 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14656 (member tag work-already-expanded))
14657 (setq tags-in-group (assoc tag taggroups))
14658 (push tag work-already-expanded)
14659 ;; Recursively expand each tag in the group, if the tag hasn't
14660 ;; already been expanded. Restore the match-data after all recursive calls.
14661 (save-match-data
14662 (let (tags-expanded)
14663 (dolist (x (cdr tags-in-group))
14664 (if (and (member x taggroups-keys)
14665 (not (member x work-already-expanded)))
14666 (setq tags-expanded
14667 (delete-dups
14668 (append
14669 (org-tags-expand x t downcased
14670 work-already-expanded)
14671 tags-expanded)))
14672 (setq tags-expanded
14673 (append (list x) tags-expanded)))
14674 (setq work-already-expanded
14675 (delete-dups
14676 (append tags-expanded
14677 work-already-expanded))))
14678 (setq tags-in-group
14679 (delete-dups (cons (car tags-in-group)
14680 tags-expanded)))))
14681 ;; Filter tag-regexps from tags.
14682 (setq regexp-in-group-escaped
14683 (delq nil (mapcar (lambda (x)
14684 (if (stringp x)
14685 (and (equal "{" (substring x 0 1))
14686 (equal "}" (substring x -1))
14689 tags-in-group))
14690 regexp-in-group
14691 (mapcar (lambda (x)
14692 (substring x 1 -1))
14693 regexp-in-group-escaped)
14694 tags-in-group
14695 (delq nil (mapcar (lambda (x)
14696 (if (stringp x)
14697 (and (not (equal "{" (substring x 0 1)))
14698 (not (equal "}" (substring x -1)))
14701 tags-in-group)))
14702 ;; If single-as-list, do no more in the while-loop.
14703 (if (not single-as-list)
14704 (progn
14705 (when regexp-in-group
14706 (setq regexp-in-group
14707 (concat "\\|"
14708 (mapconcat 'identity regexp-in-group
14709 "\\|"))))
14710 (setq tags-in-group
14711 (concat dir
14712 "{\\<"
14713 (regexp-opt tags-in-group)
14714 "\\>"
14715 regexp-in-group
14716 "}"))
14717 (when (stringp tags-in-group)
14718 (org-add-props tags-in-group '(grouptag t)))
14719 (setq return-match
14720 (replace-match tags-in-group t t return-match)))
14721 (setq tags-in-group
14722 (append regexp-in-group-escaped tags-in-group))))
14723 (setq taggroups-keys (delete tag taggroups-keys))))
14724 ;; Add the regular expressions back into the match-expression again.
14725 (while regexps-in-match
14726 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14727 (pop regexps-in-match)
14728 return-match t t))
14729 (decf count))
14730 (if single-as-list
14731 (if tags-in-group tags-in-group (list return-match))
14732 return-match))
14733 (if single-as-list
14734 (list (if downcased (downcase match) match))
14735 match)))
14737 (defun org-op-to-function (op &optional stringp)
14738 "Turn an operator into the appropriate function."
14739 (setq op
14740 (cond
14741 ((equal op "<" ) '(< string< org-time<))
14742 ((equal op ">" ) '(> org-string> org-time>))
14743 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14744 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14745 ((member op '("=" "==")) '(= string= org-time=))
14746 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14747 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14749 (defun org<> (a b) (not (= a b)))
14750 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14751 (defun org-string>= (a b) (not (string< a b)))
14752 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14753 (defun org-string<> (a b) (not (string= a b)))
14754 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14755 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14756 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14757 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14758 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14759 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14760 (defun org-2ft (s)
14761 "Convert S to a floating point time.
14762 If S is already a number, just return it. If it is a string, parse
14763 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14764 (cond
14765 ((numberp s) s)
14766 ((stringp s)
14767 (condition-case nil
14768 (float-time (apply 'encode-time (org-parse-time-string s)))
14769 (error 0.)))
14770 (t 0.)))
14772 (defun org-time-today ()
14773 "Time in seconds today at 0:00.
14774 Returns the float number of seconds since the beginning of the
14775 epoch to the beginning of today (00:00)."
14776 (float-time (apply 'encode-time
14777 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14779 (defun org-matcher-time (s)
14780 "Interpret a time comparison value."
14781 (save-match-data
14782 (cond
14783 ((string= s "<now>") (float-time))
14784 ((string= s "<today>") (org-time-today))
14785 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14786 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14787 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14788 (+ (org-time-today)
14789 (* (string-to-number (match-string 1 s))
14790 (cdr (assoc (match-string 2 s)
14791 '(("d" . 86400.0) ("w" . 604800.0)
14792 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14793 (t (org-2ft s)))))
14795 (defun org-match-any-p (re list)
14796 "Does re match any element of list?"
14797 (setq list (mapcar (lambda (x) (string-match re x)) list))
14798 (delq nil list))
14800 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14801 (defvar org-tags-overlay (make-overlay 1 1))
14802 (org-detach-overlay org-tags-overlay)
14804 (defun org-get-local-tags-at (&optional pos)
14805 "Get a list of tags defined in the current headline."
14806 (org-get-tags-at pos 'local))
14808 (defun org-get-local-tags ()
14809 "Get a list of tags defined in the current headline."
14810 (org-get-tags-at nil 'local))
14812 (defun org-get-tags-at (&optional pos local)
14813 "Get a list of all headline tags applicable at POS.
14814 POS defaults to point. If tags are inherited, the list contains
14815 the targets in the same sequence as the headlines appear, i.e.
14816 the tags of the current headline come last.
14817 When LOCAL is non-nil, only return tags from the current headline,
14818 ignore inherited ones."
14819 (interactive)
14820 (if (and org-trust-scanner-tags
14821 (or (not pos) (equal pos (point)))
14822 (not local))
14823 org-scanner-tags
14824 (let (tags ltags lastpos parent)
14825 (save-excursion
14826 (save-restriction
14827 (widen)
14828 (goto-char (or pos (point)))
14829 (save-match-data
14830 (catch 'done
14831 (condition-case nil
14832 (progn
14833 (org-back-to-heading t)
14834 (while (not (equal lastpos (point)))
14835 (setq lastpos (point))
14836 (when (looking-at
14837 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14838 (setq ltags (org-split-string
14839 (org-match-string-no-properties 1) ":"))
14840 (when parent
14841 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14842 (setq tags (append
14843 (if parent
14844 (org-remove-uninherited-tags ltags)
14845 ltags)
14846 tags)))
14847 (or org-use-tag-inheritance (throw 'done t))
14848 (if local (throw 'done t))
14849 (or (org-up-heading-safe) (error nil))
14850 (setq parent t)))
14851 (error nil)))))
14852 (if local
14853 tags
14854 (reverse (delete-dups
14855 (reverse (append
14856 (org-remove-uninherited-tags
14857 org-file-tags)
14858 tags)))))))))
14860 (defun org-add-prop-inherited (s)
14861 (add-text-properties 0 (length s) '(inherited t) s)
14864 (defun org-toggle-tag (tag &optional onoff)
14865 "Toggle the tag TAG for the current line.
14866 If ONOFF is `on' or `off', don't toggle but set to this state."
14867 (let (res current)
14868 (save-excursion
14869 (org-back-to-heading t)
14870 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14871 (point-at-eol) t)
14872 (progn
14873 (setq current (match-string 1))
14874 (replace-match ""))
14875 (setq current ""))
14876 (setq current (nreverse (org-split-string current ":")))
14877 (cond
14878 ((eq onoff 'on)
14879 (setq res t)
14880 (or (member tag current) (push tag current)))
14881 ((eq onoff 'off)
14882 (or (not (member tag current)) (setq current (delete tag current))))
14883 (t (if (member tag current)
14884 (setq current (delete tag current))
14885 (setq res t)
14886 (push tag current))))
14887 (end-of-line 1)
14888 (if current
14889 (progn
14890 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14891 (org-set-tags nil t))
14892 (delete-horizontal-space))
14893 (run-hooks 'org-after-tags-change-hook))
14894 res))
14896 (defun org-align-tags-here (to-col)
14897 ;; Assumes that this is a headline
14898 "Align tags on the current headline to TO-COL."
14899 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14900 (beginning-of-line 1)
14901 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14902 (< pos (match-beginning 2)))
14903 (progn
14904 (setq tags-l (- (match-end 2) (match-beginning 2)))
14905 (goto-char (match-beginning 1))
14906 (insert " ")
14907 (delete-region (point) (1+ (match-beginning 2)))
14908 (setq ncol (max (current-column)
14909 (1+ col)
14910 (if (> to-col 0)
14911 to-col
14912 (- (abs to-col) tags-l))))
14913 (setq p (point))
14914 (insert (make-string (- ncol (current-column)) ?\ ))
14915 (setq ncol (current-column))
14916 (when indent-tabs-mode (tabify p (point-at-eol)))
14917 (org-move-to-column (min ncol col)))
14918 (goto-char pos))))
14920 (defun org-set-tags-command (&optional arg just-align)
14921 "Call the set-tags command for the current entry."
14922 (interactive "P")
14923 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14924 (org-set-tags arg just-align)
14925 (save-excursion
14926 (unless (and (org-region-active-p)
14927 org-loop-over-headlines-in-active-region)
14928 (org-back-to-heading t))
14929 (org-set-tags arg just-align))))
14931 (defun org-set-tags-to (data)
14932 "Set the tags of the current entry to DATA, replacing the current tags.
14933 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14934 If DATA is nil or the empty string, any tags will be removed."
14935 (interactive "sTags: ")
14936 (setq data
14937 (cond
14938 ((eq data nil) "")
14939 ((equal data "") "")
14940 ((stringp data)
14941 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14942 ":"))
14943 ((listp data)
14944 (concat ":" (mapconcat 'identity data ":") ":"))))
14945 (when data
14946 (save-excursion
14947 (org-back-to-heading t)
14948 (when (looking-at org-complex-heading-regexp)
14949 (if (match-end 5)
14950 (progn
14951 (goto-char (match-beginning 5))
14952 (insert data)
14953 (delete-region (point) (point-at-eol))
14954 (org-set-tags nil 'align))
14955 (goto-char (point-at-eol))
14956 (insert " " data)
14957 (org-set-tags nil 'align)))
14958 (beginning-of-line 1)
14959 (if (looking-at ".*?\\([ \t]+\\)$")
14960 (delete-region (match-beginning 1) (match-end 1))))))
14962 (defun org-align-all-tags ()
14963 "Align the tags i all headings."
14964 (interactive)
14965 (save-excursion
14966 (or (ignore-errors (org-back-to-heading t))
14967 (outline-next-heading))
14968 (if (org-at-heading-p)
14969 (org-set-tags t)
14970 (message "No headings"))))
14972 (defvar org-indent-indentation-per-level)
14973 (defun org-set-tags (&optional arg just-align)
14974 "Set the tags for the current headline.
14975 With prefix ARG, realign all tags in headings in the current buffer.
14976 When JUST-ALIGN is non-nil, only align tags."
14977 (interactive "P")
14978 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14979 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14980 'region-start-level
14981 'region))
14982 org-loop-over-headlines-in-active-region)
14983 (org-map-entries
14984 ;; We don't use ARG and JUST-ALIGN here because these args
14985 ;; are not useful when looping over headlines.
14986 #'org-set-tags
14987 org-loop-over-headlines-in-active-region
14989 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14990 (let ((org-setting-tags t))
14991 (if arg
14992 (save-excursion
14993 (goto-char (point-min))
14994 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14995 (while (re-search-forward org-outline-regexp-bol nil t)
14996 (org-set-tags nil t)
14997 (end-of-line)))
14998 (message "All tags realigned to column %d" org-tags-column))
14999 (let* ((current (org-get-tags-string))
15000 (col (current-column))
15001 (tags
15002 (if just-align current
15003 ;; Get a new set of tags from the user.
15004 (save-excursion
15005 (let* ((table
15006 (setq
15007 org-last-tags-completion-table
15008 (append
15009 org-tag-persistent-alist
15010 (or org-tag-alist (org-get-buffer-tags))
15011 (and
15012 org-complete-tags-always-offer-all-agenda-tags
15013 (org-global-tags-completion-table
15014 (org-agenda-files))))))
15015 (current-tags (org-split-string current ":"))
15016 (inherited-tags
15017 (nreverse (nthcdr (length current-tags)
15018 (nreverse (org-get-tags-at))))))
15019 (replace-regexp-in-string
15020 "\\([-+&]+\\|,\\)"
15022 (if (or (eq t org-use-fast-tag-selection)
15023 (and org-use-fast-tag-selection
15024 (delq nil (mapcar #'cdr table))))
15025 (org-fast-tag-selection
15026 current-tags inherited-tags table
15027 (and org-fast-tag-selection-include-todo
15028 org-todo-key-alist))
15029 (let ((org-add-colon-after-tag-completion
15030 (< 1 (length table))))
15031 (org-trim
15032 (completing-read
15033 "Tags: "
15034 #'org-tags-completion-function
15035 nil nil current 'org-tags-history))))))))))
15037 (when org-tags-sort-function
15038 (setq tags
15039 (mapconcat
15040 #'identity
15041 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15042 org-tags-sort-function)
15043 ":")))
15045 (if (not (org-string-nw-p tags)) (setq tags "")
15046 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15047 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15049 ;; Insert new tags at the correct column
15050 (beginning-of-line)
15051 (let ((level (if (looking-at org-outline-regexp)
15052 (- (match-end 0) (point) 1)
15053 1)))
15054 (cond
15055 ((and (equal current "") (equal tags "")))
15056 ((re-search-forward
15057 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15058 (line-end-position)
15060 (if (equal tags "") (replace-match "" t t)
15061 (goto-char (match-beginning 0))
15062 (let* ((c0 (current-column))
15063 ;; Compute offset for the case of org-indent-mode
15064 ;; active.
15065 (di (if (org-bound-and-true-p org-indent-mode)
15066 (* (1- org-indent-indentation-per-level)
15067 (1- level))
15069 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15070 (tc (+ org-tags-column
15071 (if (> org-tags-column 0) (- di) di)))
15072 (c1 (max (1+ c0)
15073 (if (> tc 0) tc
15074 (- (- tc) (string-width tags)))))
15075 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15076 (replace-match rpl t t)
15077 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15078 (tabify p0 (point))))))
15079 (t (error "Tags alignment failed"))))
15080 (org-move-to-column col))
15081 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15083 (defun org-change-tag-in-region (beg end tag off)
15084 "Add or remove TAG for each entry in the region.
15085 This works in the agenda, and also in an org-mode buffer."
15086 (interactive
15087 (list (region-beginning) (region-end)
15088 (let ((org-last-tags-completion-table
15089 (if (derived-mode-p 'org-mode)
15090 (org-uniquify
15091 (delq nil (append (org-get-buffer-tags)
15092 (org-global-tags-completion-table))))
15093 (org-global-tags-completion-table))))
15094 (org-icompleting-read
15095 "Tag: " 'org-tags-completion-function nil nil nil
15096 'org-tags-history))
15097 (progn
15098 (message "[s]et or [r]emove? ")
15099 (equal (read-char-exclusive) ?r))))
15100 (if (fboundp 'deactivate-mark) (deactivate-mark))
15101 (let ((agendap (equal major-mode 'org-agenda-mode))
15102 l1 l2 m buf pos newhead (cnt 0))
15103 (goto-char end)
15104 (setq l2 (1- (org-current-line)))
15105 (goto-char beg)
15106 (setq l1 (org-current-line))
15107 (loop for l from l1 to l2 do
15108 (org-goto-line l)
15109 (setq m (get-text-property (point) 'org-hd-marker))
15110 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15111 (and agendap m))
15112 (setq buf (if agendap (marker-buffer m) (current-buffer))
15113 pos (if agendap m (point)))
15114 (with-current-buffer buf
15115 (save-excursion
15116 (save-restriction
15117 (goto-char pos)
15118 (setq cnt (1+ cnt))
15119 (org-toggle-tag tag (if off 'off 'on))
15120 (setq newhead (org-get-heading)))))
15121 (and agendap (org-agenda-change-all-lines newhead m))))
15122 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15124 (defun org-tags-completion-function (string predicate &optional flag)
15125 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15126 (confirm (lambda (x) (stringp (car x)))))
15127 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15128 (setq s1 (match-string 1 string)
15129 s2 (match-string 2 string))
15130 (setq s1 "" s2 string))
15131 (cond
15132 ((eq flag nil)
15133 ;; try completion
15134 (setq rtn (try-completion s2 ctable confirm))
15135 (if (stringp rtn)
15136 (setq rtn
15137 (concat s1 s2 (substring rtn (length s2))
15138 (if (and org-add-colon-after-tag-completion
15139 (assoc rtn ctable))
15140 ":" ""))))
15141 rtn)
15142 ((eq flag t)
15143 ;; all-completions
15144 (all-completions s2 ctable confirm))
15145 ((eq flag 'lambda)
15146 ;; exact match?
15147 (assoc s2 ctable)))))
15149 (defun org-fast-tag-insert (kwd tags face &optional end)
15150 "Insert KDW, and the TAGS, the latter with face FACE.
15151 Also insert END."
15152 (insert (format "%-12s" (concat kwd ":"))
15153 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15154 (or end "")))
15156 (defun org-fast-tag-show-exit (flag)
15157 (save-excursion
15158 (org-goto-line 3)
15159 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15160 (replace-match ""))
15161 (when flag
15162 (end-of-line 1)
15163 (org-move-to-column (- (window-width) 19) t)
15164 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15166 (defun org-set-current-tags-overlay (current prefix)
15167 "Add an overlay to CURRENT tag with PREFIX."
15168 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15169 (if (featurep 'xemacs)
15170 (org-overlay-display org-tags-overlay (concat prefix s)
15171 'secondary-selection)
15172 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15173 (org-overlay-display org-tags-overlay (concat prefix s)))))
15175 (defvar org-last-tag-selection-key nil)
15176 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15177 "Fast tag selection with single keys.
15178 CURRENT is the current list of tags in the headline, INHERITED is the
15179 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15180 possibly with grouping information. TODO-TABLE is a similar table with
15181 TODO keywords, should these have keys assigned to them.
15182 If the keys are nil, a-z are automatically assigned.
15183 Returns the new tags string, or nil to not change the current settings."
15184 (let* ((fulltable (append table todo-table))
15185 (maxlen (apply 'max (mapcar
15186 (lambda (x)
15187 (if (stringp (car x)) (string-width (car x)) 0))
15188 fulltable)))
15189 (buf (current-buffer))
15190 (expert (eq org-fast-tag-selection-single-key 'expert))
15191 (buffer-tags nil)
15192 (fwidth (+ maxlen 3 1 3))
15193 (ncol (/ (- (window-width) 4) fwidth))
15194 (i-face 'org-done)
15195 (c-face 'org-todo)
15196 tg cnt e c char c1 c2 ntable tbl rtn
15197 ov-start ov-end ov-prefix
15198 (exit-after-next org-fast-tag-selection-single-key)
15199 (done-keywords org-done-keywords)
15200 groups ingroup intaggroup)
15201 (save-excursion
15202 (beginning-of-line 1)
15203 (if (looking-at
15204 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15205 (setq ov-start (match-beginning 1)
15206 ov-end (match-end 1)
15207 ov-prefix "")
15208 (setq ov-start (1- (point-at-eol))
15209 ov-end (1+ ov-start))
15210 (skip-chars-forward "^\n\r")
15211 (setq ov-prefix
15212 (concat
15213 (buffer-substring (1- (point)) (point))
15214 (if (> (current-column) org-tags-column)
15216 (make-string (- org-tags-column (current-column)) ?\ ))))))
15217 (move-overlay org-tags-overlay ov-start ov-end)
15218 (save-window-excursion
15219 (if expert
15220 (set-buffer (get-buffer-create " *Org tags*"))
15221 (delete-other-windows)
15222 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15223 (org-switch-to-buffer-other-window " *Org tags*"))
15224 (erase-buffer)
15225 (org-set-local 'org-done-keywords done-keywords)
15226 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15227 (org-fast-tag-insert "Current" current c-face "\n\n")
15228 (org-fast-tag-show-exit exit-after-next)
15229 (org-set-current-tags-overlay current ov-prefix)
15230 (setq tbl fulltable char ?a cnt 0)
15231 (while (setq e (pop tbl))
15232 (cond
15233 ((eq (car e) :startgroup)
15234 (push '() groups) (setq ingroup t)
15235 (unless (zerop cnt)
15236 (setq cnt 0)
15237 (insert "\n"))
15238 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15239 ((eq (car e) :endgroup)
15240 (setq ingroup nil cnt 0)
15241 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15242 ((eq (car e) :startgrouptag)
15243 (setq intaggroup t)
15244 (unless (zerop cnt)
15245 (setq cnt 0)
15246 (insert "\n"))
15247 (insert "[ "))
15248 ((eq (car e) :endgrouptag)
15249 (setq intaggroup nil cnt 0)
15250 (insert "]\n"))
15251 ((equal e '(:newline))
15252 (unless (zerop cnt)
15253 (setq cnt 0)
15254 (insert "\n")
15255 (setq e (car tbl))
15256 (while (equal (car tbl) '(:newline))
15257 (insert "\n")
15258 (setq tbl (cdr tbl)))))
15259 ((equal e '(:grouptags)) (insert " : "))
15261 (setq tg (copy-sequence (car e)) c2 nil)
15262 (if (cdr e)
15263 (setq c (cdr e))
15264 ;; automatically assign a character.
15265 (setq c1 (string-to-char
15266 (downcase (substring
15267 tg (if (= (string-to-char tg) ?@) 1 0)))))
15268 (if (or (rassoc c1 ntable) (rassoc c1 table))
15269 (while (or (rassoc char ntable) (rassoc char table))
15270 (setq char (1+ char)))
15271 (setq c2 c1))
15272 (setq c (or c2 char)))
15273 (when ingroup (push tg (car groups)))
15274 (setq tg (org-add-props tg nil 'face
15275 (cond
15276 ((not (assoc tg table))
15277 (org-get-todo-face tg))
15278 ((member tg current) c-face)
15279 ((member tg inherited) i-face))))
15280 (when (equal (caar tbl) :grouptags)
15281 (org-add-props tg nil 'face 'org-tag-group))
15282 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15283 (insert "[" c "] " tg (make-string
15284 (- fwidth 4 (length tg)) ?\ ))
15285 (push (cons tg c) ntable)
15286 (when (= (incf cnt) ncol)
15287 (insert "\n")
15288 (when (or ingroup intaggroup) (insert " "))
15289 (setq cnt 0)))))
15290 (setq ntable (nreverse ntable))
15291 (insert "\n")
15292 (goto-char (point-min))
15293 (unless expert (org-fit-window-to-buffer))
15294 (setq rtn
15295 (catch 'exit
15296 (while t
15297 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15298 (if (not groups) "no " "")
15299 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15300 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15301 (setq org-last-tag-selection-key c)
15302 (cond
15303 ((= c ?\r) (throw 'exit t))
15304 ((= c ?!)
15305 (setq groups (not groups))
15306 (goto-char (point-min))
15307 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15308 ((= c ?\C-c)
15309 (if (not expert)
15310 (org-fast-tag-show-exit
15311 (setq exit-after-next (not exit-after-next)))
15312 (setq expert nil)
15313 (delete-other-windows)
15314 (set-window-buffer (split-window-vertically) " *Org tags*")
15315 (org-switch-to-buffer-other-window " *Org tags*")
15316 (org-fit-window-to-buffer)))
15317 ((or (= c ?\C-g)
15318 (and (= c ?q) (not (rassoc c ntable))))
15319 (org-detach-overlay org-tags-overlay)
15320 (setq quit-flag t))
15321 ((= c ?\ )
15322 (setq current nil)
15323 (when exit-after-next (setq exit-after-next 'now)))
15324 ((= c ?\t)
15325 (condition-case nil
15326 (setq tg (org-icompleting-read
15327 "Tag: "
15328 (or buffer-tags
15329 (with-current-buffer buf
15330 (setq buffer-tags
15331 (org-get-buffer-tags))))))
15332 (quit (setq tg "")))
15333 (when (string-match "\\S-" tg)
15334 (add-to-list 'buffer-tags (list tg))
15335 (if (member tg current)
15336 (setq current (delete tg current))
15337 (push tg current)))
15338 (when exit-after-next (setq exit-after-next 'now)))
15339 ((setq e (rassoc c todo-table) tg (car e))
15340 (with-current-buffer buf
15341 (save-excursion (org-todo tg)))
15342 (when exit-after-next (setq exit-after-next 'now)))
15343 ((setq e (rassoc c ntable) tg (car e))
15344 (if (member tg current)
15345 (setq current (delete tg current))
15346 (loop for g in groups do
15347 (when (member tg g)
15348 (dolist (x g) (setq current (delete x current)))))
15349 (push tg current))
15350 (when exit-after-next (setq exit-after-next 'now))))
15352 ;; Create a sorted list
15353 (setq current
15354 (sort current
15355 (lambda (a b)
15356 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15357 (when (eq exit-after-next 'now) (throw 'exit t))
15358 (goto-char (point-min))
15359 (beginning-of-line 2)
15360 (delete-region (point) (point-at-eol))
15361 (org-fast-tag-insert "Current" current c-face)
15362 (org-set-current-tags-overlay current ov-prefix)
15363 (while (re-search-forward
15364 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15365 (setq tg (match-string 1))
15366 (add-text-properties
15367 (match-beginning 1) (match-end 1)
15368 (list 'face
15369 (cond
15370 ((member tg current) c-face)
15371 ((member tg inherited) i-face)
15372 (t (get-text-property (match-beginning 1) 'face))))))
15373 (goto-char (point-min)))))
15374 (org-detach-overlay org-tags-overlay)
15375 (if rtn
15376 (mapconcat 'identity current ":")
15377 nil))))
15379 (defun org-get-tags-string ()
15380 "Get the TAGS string in the current headline."
15381 (unless (org-at-heading-p t)
15382 (user-error "Not on a heading"))
15383 (save-excursion
15384 (beginning-of-line 1)
15385 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15386 (org-match-string-no-properties 1)
15387 "")))
15389 (defun org-get-tags ()
15390 "Get the list of tags specified in the current headline."
15391 (org-split-string (org-get-tags-string) ":"))
15393 (defun org-get-buffer-tags ()
15394 "Get a table of all tags used in the buffer, for completion."
15395 (org-with-wide-buffer
15396 (goto-char (point-min))
15397 (let ((tag-re (concat org-outline-regexp-bol
15398 "\\(?:.*?[ \t]\\)?"
15399 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15400 tags)
15401 (while (re-search-forward tag-re nil t)
15402 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15403 (push tag tags)))
15404 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15406 ;;;; The mapping API
15408 (defun org-map-entries (func &optional match scope &rest skip)
15409 "Call FUNC at each headline selected by MATCH in SCOPE.
15411 FUNC is a function or a lisp form. The function will be called without
15412 arguments, with the cursor positioned at the beginning of the headline.
15413 The return values of all calls to the function will be collected and
15414 returned as a list.
15416 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15417 does not need to preserve point. After evaluation, the cursor will be
15418 moved to the end of the line (presumably of the headline of the
15419 processed entry) and search continues from there. Under some
15420 circumstances, this may not produce the wanted results. For example,
15421 if you have removed (e.g. archived) the current (sub)tree it could
15422 mean that the next entry will be skipped entirely. In such cases, you
15423 can specify the position from where search should continue by making
15424 FUNC set the variable `org-map-continue-from' to the desired buffer
15425 position.
15427 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15428 Only headlines that are matched by this query will be considered during
15429 the iteration. When MATCH is nil or t, all headlines will be
15430 visited by the iteration.
15432 SCOPE determines the scope of this command. It can be any of:
15434 nil The current buffer, respecting the restriction if any
15435 tree The subtree started with the entry at point
15436 region The entries within the active region, if any
15437 region-start-level
15438 The entries within the active region, but only those at
15439 the same level than the first one.
15440 file The current buffer, without restriction
15441 file-with-archives
15442 The current buffer, and any archives associated with it
15443 agenda All agenda files
15444 agenda-with-archives
15445 All agenda files with any archive files associated with them
15446 \(file1 file2 ...)
15447 If this is a list, all files in the list will be scanned
15449 The remaining args are treated as settings for the skipping facilities of
15450 the scanner. The following items can be given here:
15452 archive skip trees with the archive tag
15453 comment skip trees with the COMMENT keyword
15454 function or Emacs Lisp form:
15455 will be used as value for `org-agenda-skip-function', so
15456 whenever the function returns a position, FUNC will not be
15457 called for that entry and search will continue from the
15458 position returned
15460 If your function needs to retrieve the tags including inherited tags
15461 at the *current* entry, you can use the value of the variable
15462 `org-scanner-tags' which will be much faster than getting the value
15463 with `org-get-tags-at'. If your function gets properties with
15464 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15465 to t around the call to `org-entry-properties' to get the same speedup.
15466 Note that if your function moves around to retrieve tags and properties at
15467 a *different* entry, you cannot use these techniques."
15468 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15469 (not (org-region-active-p)))
15470 (let* ((org-agenda-archives-mode nil) ; just to make sure
15471 (org-agenda-skip-archived-trees (memq 'archive skip))
15472 (org-agenda-skip-comment-trees (memq 'comment skip))
15473 (org-agenda-skip-function
15474 (car (org-delete-all '(comment archive) skip)))
15475 (org-tags-match-list-sublevels t)
15476 (start-level (eq scope 'region-start-level))
15477 matcher file res
15478 org-todo-keywords-for-agenda
15479 org-done-keywords-for-agenda
15480 org-todo-keyword-alist-for-agenda
15481 org-tag-alist-for-agenda
15482 todo-only)
15484 (cond
15485 ((eq match t) (setq matcher t))
15486 ((eq match nil) (setq matcher t))
15487 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15489 (save-excursion
15490 (save-restriction
15491 (cond ((eq scope 'tree)
15492 (org-back-to-heading t)
15493 (org-narrow-to-subtree)
15494 (setq scope nil))
15495 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15496 (org-region-active-p))
15497 ;; If needed, set start-level to a string like "2"
15498 (when start-level
15499 (save-excursion
15500 (goto-char (region-beginning))
15501 (unless (org-at-heading-p) (outline-next-heading))
15502 (setq start-level (org-current-level))))
15503 (narrow-to-region (region-beginning)
15504 (save-excursion
15505 (goto-char (region-end))
15506 (unless (and (bolp) (org-at-heading-p))
15507 (outline-next-heading))
15508 (point)))
15509 (setq scope nil)))
15511 (if (not scope)
15512 (progn
15513 (org-agenda-prepare-buffers
15514 (and buffer-file-name (list buffer-file-name)))
15515 (setq res (org-scan-tags func matcher todo-only start-level)))
15516 ;; Get the right scope
15517 (cond
15518 ((and scope (listp scope) (symbolp (car scope)))
15519 (setq scope (eval scope)))
15520 ((eq scope 'agenda)
15521 (setq scope (org-agenda-files t)))
15522 ((eq scope 'agenda-with-archives)
15523 (setq scope (org-agenda-files t))
15524 (setq scope (org-add-archive-files scope)))
15525 ((eq scope 'file)
15526 (setq scope (and buffer-file-name (list buffer-file-name))))
15527 ((eq scope 'file-with-archives)
15528 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15529 (org-agenda-prepare-buffers scope)
15530 (dolist (file scope)
15531 (with-current-buffer (org-find-base-buffer-visiting file)
15532 (save-excursion
15533 (save-restriction
15534 (widen)
15535 (goto-char (point-min))
15536 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15537 res)))
15539 ;;; Properties API
15541 (defconst org-special-properties
15542 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15543 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15544 "The special properties valid in Org mode.
15545 These are properties that are not defined in the property drawer,
15546 but in some other way.")
15548 (defconst org-default-properties
15549 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15550 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15551 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15552 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15553 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15554 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15555 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15556 "Some properties that are used by Org mode for various purposes.
15557 Being in this list makes sure that they are offered for completion.")
15559 (defun org--update-property-plist (key val props)
15560 "Associate KEY to VAL in alist PROPS.
15561 Modifications are made by side-effect. Return new alist."
15562 (let* ((appending (string= (substring key -1) "+"))
15563 (key (if appending (substring key 0 -1) key))
15564 (old (assoc-string key props t)))
15565 (if (not old) (cons (cons key val) props)
15566 (setcdr old (if appending (concat (cdr old) " " val) val))
15567 props)))
15569 (defun org-get-property-block (&optional beg force)
15570 "Return the (beg . end) range of the body of the property drawer.
15571 BEG is the beginning of the current subtree, or of the part
15572 before the first headline. If it is not given, it will be found.
15573 If the drawer does not exist, create it if FORCE is non-nil, or
15574 return nil."
15575 (org-with-wide-buffer
15576 (when beg (goto-char beg))
15577 (unless (org-before-first-heading-p)
15578 (let ((beg (cond (beg)
15579 ((or (not (featurep 'org-inlinetask))
15580 (org-inlinetask-in-task-p))
15581 (org-back-to-heading t))
15582 (t (org-with-limited-levels (org-back-to-heading t))))))
15583 (forward-line)
15584 (when (org-looking-at-p org-planning-line-re) (forward-line))
15585 (cond ((looking-at org-property-drawer-re)
15586 (forward-line)
15587 (cons (point) (progn (goto-char (match-end 0))
15588 (line-beginning-position))))
15589 (force
15590 (goto-char beg)
15591 (org-insert-property-drawer)
15592 (let ((pos (save-excursion (search-forward ":END:")
15593 (line-beginning-position))))
15594 (cons pos pos))))))))
15596 (defun org-at-property-p ()
15597 "Non-nil when point is inside a property drawer.
15598 See `org-property-re' for match data, if applicable."
15599 (save-excursion
15600 (beginning-of-line)
15601 (and (looking-at org-property-re)
15602 (let ((property-drawer (save-match-data (org-get-property-block))))
15603 (and property-drawer
15604 (>= (point) (car property-drawer))
15605 (< (point) (cdr property-drawer)))))))
15607 (defun org-property-action ()
15608 "Do an action on properties."
15609 (interactive)
15610 (unless (org-at-property-p) (user-error "Not at a property"))
15611 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15612 (let ((c (read-char-exclusive)))
15613 (case c
15614 (?s (call-interactively #'org-set-property))
15615 (?d (call-interactively #'org-delete-property))
15616 (?D (call-interactively #'org-delete-property-globally))
15617 (?c (call-interactively #'org-compute-property-at-point))
15618 (otherwise (user-error "No such property action %c" c)))))
15620 (defun org-inc-effort ()
15621 "Increment the value of the effort property in the current entry."
15622 (interactive)
15623 (org-set-effort nil t))
15625 (defvar org-clock-effort) ; Defined in org-clock.el.
15626 (defvar org-clock-current-task) ; Defined in org-clock.el.
15627 (defun org-set-effort (&optional value increment)
15628 "Set the effort property of the current entry.
15629 With numerical prefix arg, use the nth allowed value, 0 stands for the
15630 10th allowed value.
15632 When INCREMENT is non-nil, set the property to the next allowed value."
15633 (interactive "P")
15634 (if (equal value 0) (setq value 10))
15635 (let* ((completion-ignore-case t)
15636 (prop org-effort-property)
15637 (cur (org-entry-get nil prop))
15638 (allowed (org-property-get-allowed-values nil prop 'table))
15639 (existing (mapcar 'list (org-property-values prop)))
15640 (heading (nth 4 (org-heading-components)))
15642 (val (cond
15643 ((stringp value) value)
15644 ((and allowed (integerp value))
15645 (or (car (nth (1- value) allowed))
15646 (car (org-last allowed))))
15647 ((and allowed increment)
15648 (or (caadr (member (list cur) allowed))
15649 (user-error "Allowed effort values are not set")))
15650 (allowed
15651 (message "Select 1-9,0, [RET%s]: %s"
15652 (if cur (concat "=" cur) "")
15653 (mapconcat 'car allowed " "))
15654 (setq rpl (read-char-exclusive))
15655 (if (equal rpl ?\r)
15657 (setq rpl (- rpl ?0))
15658 (if (equal rpl 0) (setq rpl 10))
15659 (if (and (> rpl 0) (<= rpl (length allowed)))
15660 (car (nth (1- rpl) allowed))
15661 (org-completing-read "Effort: " allowed nil))))
15663 (let (org-completion-use-ido org-completion-use-iswitchb)
15664 (org-completing-read
15665 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15666 (concat "[" cur "]") "")
15667 ": ")
15668 existing nil nil "" nil cur))))))
15669 (unless (equal (org-entry-get nil prop) val)
15670 (org-entry-put nil prop val))
15671 (org-refresh-property
15672 '((effort . identity)
15673 (effort-minutes . org-duration-string-to-minutes))
15674 val)
15675 (when (string= heading org-clock-current-task)
15676 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15677 (org-clock-update-mode-line))
15678 (message "%s is now %s" prop val)))
15680 (defun org-entry-properties (&optional pom which)
15681 "Get all properties of the current entry.
15683 When POM is a buffer position, get all properties from the entry
15684 there instead.
15686 This includes the TODO keyword, the tags, time strings for
15687 deadline, scheduled, and clocking, and any additional properties
15688 defined in the entry.
15690 If WHICH is nil or `all', get all properties. If WHICH is
15691 `special' or `standard', only get that subclass. If WHICH is
15692 a string, only get that property.
15694 Return value is an alist. Keys are properties, as upcased
15695 strings."
15696 (org-with-point-at pom
15697 (when (and (derived-mode-p 'org-mode)
15698 (ignore-errors (org-back-to-heading t)))
15699 (catch 'exit
15700 (let* ((beg (point))
15701 (specific (and (stringp which) (upcase which)))
15702 (which (cond ((not specific) which)
15703 ((member specific org-special-properties) 'special)
15704 (t 'standard)))
15705 props)
15706 ;; Get the special properties, like TODO and TAGS.
15707 (when (memq which '(nil all special))
15708 (when (or (not specific) (string= specific "CLOCKSUM"))
15709 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15710 (when clocksum
15711 (push (cons "CLOCKSUM"
15712 (org-columns-number-to-string
15713 (/ (float clocksum) 60.) 'add_times))
15714 props)))
15715 (when specific (throw 'exit props)))
15716 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15717 (let ((clocksumt (get-text-property (point)
15718 :org-clock-minutes-today)))
15719 (when clocksumt
15720 (push (cons "CLOCKSUM_T"
15721 (org-columns-number-to-string
15722 (/ (float clocksumt) 60.) 'add_times))
15723 props)))
15724 (when specific (throw 'exit props)))
15725 (when (or (not specific) (string= specific "ITEM"))
15726 (when (looking-at org-complex-heading-regexp)
15727 (push (cons "ITEM"
15728 (concat
15729 (org-match-string-no-properties 1)
15730 (let ((title (org-match-string-no-properties 4)))
15731 (when (org-string-nw-p title)
15732 (concat " " (org-remove-tabs title))))))
15733 props))
15734 (when specific (throw 'exit props)))
15735 (when (or (not specific) (string= specific "TODO"))
15736 (let ((case-fold-search nil))
15737 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15738 (push (cons "TODO" (org-match-string-no-properties 2)) props)))
15739 (when specific (throw 'exit props)))
15740 (when (or (not specific) (string= specific "PRIORITY"))
15741 (push (cons "PRIORITY"
15742 (if (looking-at org-priority-regexp)
15743 (org-match-string-no-properties 2)
15744 (char-to-string org-default-priority)))
15745 props)
15746 (when specific (throw 'exit props)))
15747 (when (or (not specific) (string= specific "FILE"))
15748 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15749 props)
15750 (when specific (throw 'exit props)))
15751 (when (or (not specific) (string= specific "TAGS"))
15752 (let ((value (org-string-nw-p (org-get-tags-string))))
15753 (when value (push (cons "TAGS" value) props)))
15754 (when specific (throw 'exit props)))
15755 (when (or (not specific) (string= specific "ALLTAGS"))
15756 (let ((value (org-get-tags-at)))
15757 (when value
15758 (push (cons "ALLTAGS"
15759 (format ":%s:" (mapconcat #'identity value ":")))
15760 props)))
15761 (when specific (throw 'exit props)))
15762 (when (or (not specific) (string= specific "BLOCKED"))
15763 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15764 (when specific (throw 'exit props)))
15765 (when (or (not specific)
15766 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15767 (forward-line)
15768 (when (org-looking-at-p org-planning-line-re)
15769 (end-of-line)
15770 (let ((bol (line-beginning-position))
15771 ;; Backward compatibility: time keywords used to
15772 ;; be configurable (before 8.3). Make sure we
15773 ;; get the correct keyword.
15774 (key-assoc `(("CLOSED" . ,org-closed-string)
15775 ("DEADLINE" . ,org-deadline-string)
15776 ("SCHEDULED" . ,org-scheduled-string))))
15777 (dolist (pair (if specific (list (assoc specific key-assoc))
15778 key-assoc))
15779 (save-excursion
15780 (when (search-backward (cdr pair) bol t)
15781 (goto-char (match-end 0))
15782 (skip-chars-forward " \t")
15783 (and (looking-at org-ts-regexp-both)
15784 (push (cons (car pair)
15785 (org-match-string-no-properties 0))
15786 props)))))))
15787 (when specific (throw 'exit props)))
15788 (when (or (not specific)
15789 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15790 (let ((find-ts
15791 (lambda (end ts)
15792 (let ((regexp (cond
15793 ((string= specific "TIMESTAMP")
15794 org-ts-regexp)
15795 ((string= specific "TIMESTAMP_IA")
15796 org-ts-regexp-inactive)
15797 ((assoc "TIMESTAMP_IA" ts)
15798 org-ts-regexp)
15799 ((assoc "TIMESTAMP" ts)
15800 org-ts-regexp-inactive)
15801 (t org-ts-regexp-both))))
15802 (catch 'next
15803 (while (re-search-forward regexp end t)
15804 (backward-char)
15805 (let ((object (org-element-context)))
15806 ;; Accept to match timestamps in node
15807 ;; properties, too.
15808 (when (memq (org-element-type object)
15809 '(node-property timestamp))
15810 (let ((type
15811 (org-element-property :type object)))
15812 (cond
15813 ((and (memq type '(active active-range))
15814 (not (equal specific "TIMESTAMP_IA")))
15815 (unless (assoc "TIMESTAMP" ts)
15816 (push (cons "TIMESTAMP"
15817 (org-element-property
15818 :raw-value object))
15820 (when specific (throw 'exit ts))))
15821 ((and (memq type '(inactive inactive-range))
15822 (not (string= specific "TIMESTAMP")))
15823 (unless (assoc "TIMESTAMP_IA" ts)
15824 (push (cons "TIMESTAMP_IA"
15825 (org-element-property
15826 :raw-value object))
15828 (when specific (throw 'exit ts))))))
15829 ;; Both timestamp types are found,
15830 ;; move to next part.
15831 (when (= (length ts) 2) (throw 'next ts)))))
15832 ts)))))
15833 (goto-char beg)
15834 ;; First look for timestamps within headline.
15835 (let ((ts (funcall find-ts (line-end-position) nil)))
15836 (if (= (length ts) 2) (setq props (nconc ts props))
15837 (forward-line)
15838 ;; Then find timestamps in the section, skipping
15839 ;; planning line.
15840 (when (org-looking-at-p org-planning-line-re)
15841 (forward-line))
15842 (let ((end (save-excursion (outline-next-heading))))
15843 (setq props (nconc (funcall find-ts end ts) props))))))))
15844 ;; Get the standard properties, like :PROP:.
15845 (when (memq which '(nil all standard))
15846 ;; If we are looking after a specific property, delegate
15847 ;; to `org-entry-get', which is faster. However, make an
15848 ;; exception for "CATEGORY", since it can be also set
15849 ;; through keywords (i.e. #+CATEGORY).
15850 (if (and specific (not (equal specific "CATEGORY")))
15851 (let ((value (org-entry-get beg specific nil t)))
15852 (throw 'exit (and value (list (cons specific value)))))
15853 (let ((range (org-get-property-block beg)))
15854 (when range
15855 (let ((end (cdr range)) seen-base)
15856 (goto-char (car range))
15857 ;; Unlike to `org--update-property-plist', we
15858 ;; handle the case where base values is found
15859 ;; after its extension. We also forbid standard
15860 ;; properties to be named as special properties.
15861 (while (re-search-forward org-property-re end t)
15862 (let* ((key (upcase (org-match-string-no-properties 2)))
15863 (extendp (org-string-match-p "\\+\\'" key))
15864 (key-base (if extendp (substring key 0 -1) key))
15865 (value (org-match-string-no-properties 3)))
15866 (cond
15867 ((member-ignore-case key-base org-special-properties))
15868 (extendp
15869 (setq props
15870 (org--update-property-plist key value props)))
15871 ((member key seen-base))
15872 (t (push key seen-base)
15873 (let ((p (assoc-string key props t)))
15874 (if p (setcdr p (concat value " " (cdr p)))
15875 (push (cons key value) props))))))))))))
15876 (unless (assoc "CATEGORY" props)
15877 (push (cons "CATEGORY" (org-get-category beg)) props)
15878 (when (string= specific "CATEGORY") (throw 'exit props)))
15879 ;; Return value.
15880 props)))))
15882 (defun org-property--local-values (property literal-nil)
15883 "Return value for PROPERTY in current entry.
15884 Value is a list whose care is the base value for PROPERTY and cdr
15885 a list of accumulated values. Return nil if neither is found in
15886 the entry. Also return nil when PROPERTY is set to \"nil\",
15887 unless LITERAL-NIL is non-nil."
15888 (let ((range (org-get-property-block)))
15889 (when range
15890 (goto-char (car range))
15891 (let* ((case-fold-search t)
15892 (end (cdr range))
15893 (value
15894 ;; Base value.
15895 (save-excursion
15896 (let ((v (and (re-search-forward
15897 (org-re-property property nil t) end t)
15898 (org-match-string-no-properties 3))))
15899 (list (if literal-nil v (org-not-nil v)))))))
15900 ;; Find additional values.
15901 (let* ((property+ (org-re-property (concat property "+") nil t)))
15902 (while (re-search-forward property+ end t)
15903 (push (org-match-string-no-properties 3) value)))
15904 ;; Return final values.
15905 (and (not (equal value '(nil))) (nreverse value))))))
15907 (defun org-entry-get (pom property &optional inherit literal-nil)
15908 "Get value of PROPERTY for entry or content at point-or-marker POM.
15910 If INHERIT is non-nil and the entry does not have the property,
15911 then also check higher levels of the hierarchy. If INHERIT is
15912 the symbol `selective', use inheritance only if the setting in
15913 `org-use-property-inheritance' selects PROPERTY for inheritance.
15915 If the property is present but empty, the return value is the
15916 empty string. If the property is not present at all, nil is
15917 returned. In any other case, return the value as a string.
15918 Search is case-insensitive.
15920 If LITERAL-NIL is set, return the string value \"nil\" as
15921 a string, do not interpret it as the list atom nil. This is used
15922 for inheritance when a \"nil\" value can supersede a non-nil
15923 value higher up the hierarchy."
15924 (org-with-point-at pom
15925 (cond
15926 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15927 ;; We need a special property. Use `org-entry-properties' to
15928 ;; retrieve it, but specify the wanted property.
15929 (cdr (assoc-string property (org-entry-properties nil property))))
15930 ((and inherit
15931 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15932 (org-entry-get-with-inheritance property literal-nil))
15934 (let* ((local (org-property--local-values property literal-nil))
15935 (value (and local (mapconcat #'identity (delq nil local) " "))))
15936 (if literal-nil value (org-not-nil value)))))))
15938 (defun org-property-or-variable-value (var &optional inherit)
15939 "Check if there is a property fixing the value of VAR.
15940 If yes, return this value. If not, return the current value of the variable."
15941 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15942 (if (and prop (stringp prop) (string-match "\\S-" prop))
15943 (read prop)
15944 (symbol-value var))))
15946 (defun org-entry-delete (pom property)
15947 "Delete PROPERTY from entry at point-or-marker POM.
15948 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15949 non-nil when a property was removed."
15950 (unless (member property org-special-properties)
15951 (org-with-point-at pom
15952 (let ((range (org-get-property-block)))
15953 (when range
15954 (let* ((begin (car range))
15955 (origin (cdr range))
15956 (end (copy-marker origin))
15957 (re (org-re-property
15958 (concat (regexp-quote property) "\\+?") t t)))
15959 (goto-char begin)
15960 (while (re-search-forward re end t)
15961 (delete-region (match-beginning 0) (line-beginning-position 2)))
15962 ;; If drawer is empty, remove it altogether.
15963 (when (= begin end)
15964 (delete-region (line-beginning-position 0)
15965 (line-beginning-position 2)))
15966 ;; Return non-nil if some property was removed.
15967 (prog1 (/= end origin) (set-marker end nil))))))))
15969 ;; Multi-values properties are properties that contain multiple values
15970 ;; These values are assumed to be single words, separated by whitespace.
15971 (defun org-entry-add-to-multivalued-property (pom property value)
15972 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15973 (let* ((old (org-entry-get pom property))
15974 (values (and old (org-split-string old "[ \t]"))))
15975 (setq value (org-entry-protect-space value))
15976 (unless (member value values)
15977 (setq values (append values (list value)))
15978 (org-entry-put pom property
15979 (mapconcat 'identity values " ")))))
15981 (defun org-entry-remove-from-multivalued-property (pom property value)
15982 "Remove VALUE from 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 (when (member value values)
15987 (setq values (delete value values))
15988 (org-entry-put pom property
15989 (mapconcat 'identity values " ")))))
15991 (defun org-entry-member-in-multivalued-property (pom property value)
15992 "Is VALUE one of the 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 (member value values)))
15998 (defun org-entry-get-multivalued-property (pom property)
15999 "Return a list of values in a multivalued property."
16000 (let* ((value (org-entry-get pom property))
16001 (values (and value (org-split-string value "[ \t]"))))
16002 (mapcar 'org-entry-restore-space values)))
16004 (defun org-entry-put-multivalued-property (pom property &rest values)
16005 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
16006 VALUES should be a list of strings. Spaces will be protected."
16007 (org-entry-put pom property
16008 (mapconcat 'org-entry-protect-space values " "))
16009 (let* ((value (org-entry-get pom property))
16010 (values (and value (org-split-string value "[ \t]"))))
16011 (mapcar 'org-entry-restore-space values)))
16013 (defun org-entry-protect-space (s)
16014 "Protect spaces and newline in string S."
16015 (while (string-match " " s)
16016 (setq s (replace-match "%20" t t s)))
16017 (while (string-match "\n" s)
16018 (setq s (replace-match "%0A" t t s)))
16021 (defun org-entry-restore-space (s)
16022 "Restore spaces and newline in string S."
16023 (while (string-match "%20" s)
16024 (setq s (replace-match " " t t s)))
16025 (while (string-match "%0A" s)
16026 (setq s (replace-match "\n" t t s)))
16029 (defvar org-entry-property-inherited-from (make-marker)
16030 "Marker pointing to the entry from where a property was inherited.
16031 Each call to `org-entry-get-with-inheritance' will set this marker to the
16032 location of the entry where the inheritance search matched. If there was
16033 no match, the marker will point nowhere.
16034 Note that also `org-entry-get' calls this function, if the INHERIT flag
16035 is set.")
16037 (defun org-entry-get-with-inheritance (property &optional literal-nil)
16038 "Get PROPERTY of entry or content at point, search higher levels if needed.
16039 The search will stop at the first ancestor which has the property defined.
16040 If the value found is \"nil\", return nil to show that the property
16041 should be considered as undefined (this is the meaning of nil here).
16042 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16043 (move-marker org-entry-property-inherited-from nil)
16044 (org-with-wide-buffer
16045 (let (value)
16046 (catch 'exit
16047 (while t
16048 (let ((v (org-property--local-values property literal-nil)))
16049 (when v
16050 (setq value
16051 (concat (mapconcat #'identity (delq nil v) " ")
16052 (and value " ")
16053 value)))
16054 (cond
16055 ((car v)
16056 (org-back-to-heading t)
16057 (move-marker org-entry-property-inherited-from (point))
16058 (throw 'exit nil))
16059 ((org-up-heading-safe))
16061 (let ((global
16062 (cdr (or (assoc-string property org-file-properties t)
16063 (assoc-string property org-global-properties t)
16064 (assoc-string property org-global-properties-fixed t)))))
16065 (cond ((not global))
16066 (value (setq value (concat global " " value)))
16067 (t (setq value global))))
16068 (throw 'exit nil))))))
16069 (if literal-nil value (org-not-nil value)))))
16071 (defvar org-property-changed-functions nil
16072 "Hook called when the value of a property has changed.
16073 Each hook function should accept two arguments, the name of the property
16074 and the new value.")
16076 (defun org-entry-put (pom property value)
16077 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16079 If the value is nil, it is converted to the empty string. If
16080 it is not a string, an error is raised.
16082 PROPERTY can be any regular property (see
16083 `org-special-properties'). It can also be \"TODO\",
16084 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16086 For the last two properties, VALUE may have any of the special
16087 values \"earlier\" and \"later\". The function then increases or
16088 decreases scheduled or deadline date by one day."
16089 (cond ((null value) (setq value ""))
16090 ((not (stringp value)) (error "Properties values should be strings")))
16091 (org-with-point-at pom
16092 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16093 (org-back-to-heading t)
16094 (org-with-limited-levels (org-back-to-heading t)))
16095 (let ((beg (point)))
16096 (cond
16097 ((equal property "TODO")
16098 (cond ((not (org-string-nw-p value)) (setq value 'none))
16099 ((not (member value org-todo-keywords-1))
16100 (user-error "\"%s\" is not a valid TODO state" value)))
16101 (org-todo value)
16102 (org-set-tags nil 'align))
16103 ((equal property "PRIORITY")
16104 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16105 (org-set-tags nil 'align))
16106 ((equal property "SCHEDULED")
16107 (forward-line)
16108 (if (and (org-looking-at-p org-planning-line-re)
16109 (re-search-forward
16110 org-scheduled-time-regexp (line-end-position) t))
16111 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16112 ((string= value "later") (org-timestamp-change 1 'day))
16113 ((string= value "") (org-schedule '(4)))
16114 (t (org-schedule nil value)))
16115 (if (member value '("earlier" "later" ""))
16116 (call-interactively #'org-schedule)
16117 (org-schedule nil value))))
16118 ((equal property "DEADLINE")
16119 (forward-line)
16120 (if (and (org-looking-at-p org-planning-line-re)
16121 (re-search-forward
16122 org-deadline-time-regexp (line-end-position) t))
16123 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16124 ((string= value "later") (org-timestamp-change 1 'day))
16125 ((string= value "") (org-deadline '(4)))
16126 (t (org-deadline nil value)))
16127 (if (member value '("earlier" "later" ""))
16128 (call-interactively #'org-deadline)
16129 (org-deadline nil value))))
16130 ((member property org-special-properties)
16131 (error "The %s property cannot be set with `org-entry-put'" property))
16133 (let* ((range (org-get-property-block beg 'force))
16134 (end (cdr range))
16135 (case-fold-search t))
16136 (goto-char (car range))
16137 (if (re-search-forward (org-re-property property nil t) end t)
16138 (progn (delete-region (match-beginning 0) (match-end 0))
16139 (goto-char (match-beginning 0)))
16140 (goto-char end)
16141 (insert "\n")
16142 (backward-char))
16143 (insert ":" property ":")
16144 (when value (insert " " value))
16145 (org-indent-line)))))
16146 (run-hook-with-args 'org-property-changed-functions property value)))
16148 (defun org-buffer-property-keys (&optional specials defaults columns)
16149 "Get all property keys in the current buffer.
16151 When SPECIALS is non-nil, also list the special properties that
16152 reflect things like tags and TODO state.
16154 When DEFAULTS is non-nil, also include properties that has
16155 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16156 DESCRIPTION, LOCATION, and LOGGING and others.
16158 When COLUMNS in non-nil, also include property names given in
16159 COLUMN formats in the current buffer."
16160 (let ((case-fold-search t)
16161 (props (append
16162 (and specials org-special-properties)
16163 (and defaults (cons org-effort-property org-default-properties))
16164 nil)))
16165 (org-with-wide-buffer
16166 (goto-char (point-min))
16167 (while (re-search-forward org-property-start-re nil t)
16168 (let ((range (org-get-property-block)))
16169 (catch 'skip
16170 (unless range
16171 (when (and (not (org-before-first-heading-p))
16172 (y-or-n-p (format "Malformed drawer at %d, repair?"
16173 (line-beginning-position))))
16174 (org-get-property-block nil t))
16175 (throw 'skip nil))
16176 (goto-char (car range))
16177 (let ((begin (car range))
16178 (end (cdr range)))
16179 ;; Make sure that found property block is not located
16180 ;; before current point, as it would generate an infloop.
16181 ;; It can happen, for example, in the following
16182 ;; situation:
16184 ;; * Headline
16185 ;; :PROPERTIES:
16186 ;; ...
16187 ;; :END:
16188 ;; *************** Inlinetask
16189 ;; #+BEGIN_EXAMPLE
16190 ;; :PROPERTIES:
16191 ;; #+END_EXAMPLE
16193 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16194 (while (< (point) end)
16195 (let ((p (progn (looking-at org-property-re)
16196 (org-match-string-no-properties 2))))
16197 ;; Only add true property name, not extension symbol.
16198 (add-to-list 'props
16199 (if (not (org-string-match-p "\\+\\'" p)) p
16200 (substring p 0 -1))))
16201 (forward-line))))
16202 (outline-next-heading)))
16203 (when columns
16204 (goto-char (point-min))
16205 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16206 (let ((element (org-element-at-point)))
16207 (when (memq (org-element-type element) '(keyword node-property))
16208 (let ((value (org-element-property :value element))
16209 (start 0))
16210 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16211 (setq start (match-end 0))
16212 (let ((p (org-match-string-no-properties 1 value)))
16213 (unless (member-ignore-case p org-special-properties)
16214 (add-to-list 'props p))))))))))
16215 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16217 (defun org-property-values (key)
16218 "List all non-nil values of property KEY in current buffer."
16219 (org-with-wide-buffer
16220 (goto-char (point-min))
16221 (let ((case-fold-search t)
16222 (re (org-re-property key))
16223 values)
16224 (while (re-search-forward re nil t)
16225 (add-to-list 'values (org-entry-get (point) key)))
16226 values)))
16228 (defun org-insert-property-drawer ()
16229 "Insert a property drawer into the current entry."
16230 (org-with-wide-buffer
16231 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16232 (org-back-to-heading t)
16233 (org-with-limited-levels (org-back-to-heading t)))
16234 (forward-line)
16235 (when (org-looking-at-p org-planning-line-re) (forward-line))
16236 (unless (org-looking-at-p org-property-drawer-re)
16237 ;; Make sure we start editing a line from current entry, not from
16238 ;; next one. It prevents extending text properties or overlays
16239 ;; belonging to the latter.
16240 (when (bolp) (backward-char))
16241 (let ((begin (1+ (point)))
16242 (inhibit-read-only t))
16243 (insert "\n:PROPERTIES:\n:END:")
16244 (when (eobp) (insert "\n"))
16245 (org-indent-region begin (point))))))
16247 (defun org-insert-drawer (&optional arg drawer)
16248 "Insert a drawer at point.
16250 When optional argument ARG is non-nil, insert a property drawer.
16252 Optional argument DRAWER, when non-nil, is a string representing
16253 drawer's name. Otherwise, the user is prompted for a name.
16255 If a region is active, insert the drawer around that region
16256 instead.
16258 Point is left between drawer's boundaries."
16259 (interactive "P")
16260 (let* ((drawer (if arg "PROPERTIES"
16261 (or drawer (read-from-minibuffer "Drawer: ")))))
16262 (cond
16263 ;; With C-u, fall back on `org-insert-property-drawer'
16264 (arg (org-insert-property-drawer))
16265 ;; Check validity of suggested drawer's name.
16266 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16267 (user-error "Invalid drawer name"))
16268 ;; With an active region, insert a drawer at point.
16269 ((not (org-region-active-p))
16270 (progn
16271 (unless (bolp) (insert "\n"))
16272 (insert (format ":%s:\n\n:END:\n" drawer))
16273 (forward-line -2)))
16274 ;; Otherwise, insert the drawer at point
16276 (let ((rbeg (region-beginning))
16277 (rend (copy-marker (region-end))))
16278 (unwind-protect
16279 (progn
16280 (goto-char rbeg)
16281 (beginning-of-line)
16282 (when (save-excursion
16283 (re-search-forward org-outline-regexp-bol rend t))
16284 (user-error "Drawers cannot contain headlines"))
16285 ;; Position point at the beginning of the first
16286 ;; non-blank line in region. Insert drawer's opening
16287 ;; there, then indent it.
16288 (org-skip-whitespace)
16289 (beginning-of-line)
16290 (insert ":" drawer ":\n")
16291 (forward-line -1)
16292 (indent-for-tab-command)
16293 ;; Move point to the beginning of the first blank line
16294 ;; after the last non-blank line in region. Insert
16295 ;; drawer's closing, then indent it.
16296 (goto-char rend)
16297 (skip-chars-backward " \r\t\n")
16298 (insert "\n:END:")
16299 (deactivate-mark t)
16300 (indent-for-tab-command)
16301 (unless (eolp) (insert "\n")))
16302 ;; Clear marker, whatever the outcome of insertion is.
16303 (set-marker rend nil)))))))
16305 (defvar org-property-set-functions-alist nil
16306 "Property set function alist.
16307 Each entry should have the following format:
16309 (PROPERTY . READ-FUNCTION)
16311 The read function will be called with the same argument as
16312 `org-completing-read'.")
16314 (defun org-set-property-function (property)
16315 "Get the function that should be used to set PROPERTY.
16316 This is computed according to `org-property-set-functions-alist'."
16317 (or (cdr (assoc property org-property-set-functions-alist))
16318 'org-completing-read))
16320 (defun org-read-property-value (property)
16321 "Read PROPERTY value from user."
16322 (let* ((completion-ignore-case t)
16323 (allowed (org-property-get-allowed-values nil property 'table))
16324 (cur (org-entry-get nil property))
16325 (prompt (concat property " value"
16326 (if (and cur (string-match "\\S-" cur))
16327 (concat " [" cur "]") "") ": "))
16328 (set-function (org-set-property-function property))
16329 (val (if allowed
16330 (funcall set-function prompt allowed nil
16331 (not (get-text-property 0 'org-unrestricted
16332 (caar allowed))))
16333 (let (org-completion-use-ido org-completion-use-iswitchb)
16334 (funcall set-function prompt
16335 (mapcar 'list (org-property-values property))
16336 nil nil "" nil cur)))))
16337 (org-trim val)))
16339 (defvar org-last-set-property nil)
16340 (defvar org-last-set-property-value nil)
16341 (defun org-read-property-name ()
16342 "Read a property name."
16343 (let ((completion-ignore-case t)
16344 (default-prop (or (and (org-at-property-p)
16345 (org-match-string-no-properties 2))
16346 org-last-set-property)))
16347 (org-completing-read
16348 (concat "Property"
16349 (if default-prop (concat " [" default-prop "]") "")
16350 ": ")
16351 (mapcar #'list (org-buffer-property-keys nil t t))
16352 nil nil nil nil default-prop)))
16354 (defun org-set-property-and-value (use-last)
16355 "Allow to set [PROPERTY]: [value] direction from prompt.
16356 When use-default, don't even ask, just use the last
16357 \"[PROPERTY]: [value]\" string from the history."
16358 (interactive "P")
16359 (let* ((completion-ignore-case t)
16360 (pv (or (and use-last org-last-set-property-value)
16361 (org-completing-read
16362 "Enter a \"[Property]: [value]\" pair: "
16363 nil nil nil nil nil
16364 org-last-set-property-value)))
16365 prop val)
16366 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16367 (setq prop (match-string 1 pv)
16368 val (match-string 2 pv))
16369 (org-set-property prop val))))
16371 (defun org-set-property (property value)
16372 "In the current entry, set PROPERTY to VALUE.
16373 When called interactively, this will prompt for a property name, offering
16374 completion on existing and default properties. And then it will prompt
16375 for a value, offering completion either on allowed values (via an inherited
16376 xxx_ALL property) or on existing values in other instances of this property
16377 in the current file."
16378 (interactive (list nil nil))
16379 (let* ((property (or property (org-read-property-name)))
16380 (value (or value (org-read-property-value property)))
16381 (fn (cdr (assoc property org-properties-postprocess-alist))))
16382 (setq org-last-set-property property)
16383 (setq org-last-set-property-value (concat property ": " value))
16384 ;; Possibly postprocess the inserted value:
16385 (when fn (setq value (funcall fn value)))
16386 (unless (equal (org-entry-get nil property) value)
16387 (org-entry-put nil property value))))
16389 (defun org-find-property (property &optional value)
16390 "Find first entry in buffer that sets PROPERTY.
16392 When optional argument VALUE is non-nil, only consider an entry
16393 if it contains PROPERTY set to this value. If PROPERTY should be
16394 explicitly set to nil, use string \"nil\" for VALUE.
16396 Return position where the entry begins, or nil if there is no
16397 such entry. If narrowing is in effect, only search the visible
16398 part of the buffer."
16399 (save-excursion
16400 (goto-char (point-min))
16401 (let ((case-fold-search t)
16402 (re (org-re-property property nil (not value) value)))
16403 (catch 'exit
16404 (while (re-search-forward re nil t)
16405 (when (if value (org-at-property-p)
16406 (org-entry-get (point) property nil t))
16407 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16409 (defun org-delete-property (property)
16410 "In the current entry, delete PROPERTY."
16411 (interactive
16412 (let* ((completion-ignore-case t)
16413 (cat (org-entry-get (point) "CATEGORY"))
16414 (props0 (org-entry-properties nil 'standard))
16415 (props (if cat props0
16416 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16417 (prop (if (< 1 (length props))
16418 (org-icompleting-read "Property: " props nil t)
16419 (caar props))))
16420 (list prop)))
16421 (if (not property)
16422 (message "No property to delete in this entry")
16423 (org-entry-delete nil property)
16424 (message "Property \"%s\" deleted" property)))
16426 (defun org-delete-property-globally (property)
16427 "Remove PROPERTY globally, from all entries.
16428 This function ignores narrowing, if any."
16429 (interactive
16430 (let* ((completion-ignore-case t)
16431 (prop (org-icompleting-read
16432 "Globally remove property: "
16433 (mapcar #'list (org-buffer-property-keys)))))
16434 (list prop)))
16435 (org-with-wide-buffer
16436 (goto-char (point-min))
16437 (let ((count 0)
16438 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16439 (while (re-search-forward re nil t)
16440 (when (org-entry-delete (point) property) (incf count)))
16441 (message "Property \"%s\" removed from %d entries" property count))))
16443 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16445 (defun org-compute-property-at-point ()
16446 "Compute the property at point.
16447 This looks for an enclosing column format, extracts the operator and
16448 then applies it to the property in the column format's scope."
16449 (interactive)
16450 (unless (org-at-property-p)
16451 (user-error "Not at a property"))
16452 (let ((prop (org-match-string-no-properties 2)))
16453 (org-columns-get-format-and-top-level)
16454 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16455 (user-error "No operator defined for property %s" prop))
16456 (org-columns-compute prop)))
16458 (defvar org-property-allowed-value-functions nil
16459 "Hook for functions supplying allowed values for a specific property.
16460 The functions must take a single argument, the name of the property, and
16461 return a flat list of allowed values. If \":ETC\" is one of
16462 the values, this means that these values are intended as defaults for
16463 completion, but that other values should be allowed too.
16464 The functions must return nil if they are not responsible for this
16465 property.")
16467 (defun org-property-get-allowed-values (pom property &optional table)
16468 "Get allowed values for the property PROPERTY.
16469 When TABLE is non-nil, return an alist that can directly be used for
16470 completion."
16471 (let (vals)
16472 (cond
16473 ((equal property "TODO")
16474 (setq vals (org-with-point-at pom
16475 (append org-todo-keywords-1 '("")))))
16476 ((equal property "PRIORITY")
16477 (let ((n org-lowest-priority))
16478 (while (>= n org-highest-priority)
16479 (push (char-to-string n) vals)
16480 (setq n (1- n)))))
16481 ((equal property "CATEGORY"))
16482 ((member property org-special-properties))
16483 ((setq vals (run-hook-with-args-until-success
16484 'org-property-allowed-value-functions property)))
16486 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16487 (when (and vals (string-match "\\S-" vals))
16488 (setq vals (car (read-from-string (concat "(" vals ")"))))
16489 (setq vals (mapcar (lambda (x)
16490 (cond ((stringp x) x)
16491 ((numberp x) (number-to-string x))
16492 ((symbolp x) (symbol-name x))
16493 (t "???")))
16494 vals)))))
16495 (when (member ":ETC" vals)
16496 (setq vals (remove ":ETC" vals))
16497 (org-add-props (car vals) '(org-unrestricted t)))
16498 (if table (mapcar 'list vals) vals)))
16500 (defun org-property-previous-allowed-value (&optional previous)
16501 "Switch to the next allowed value for this property."
16502 (interactive)
16503 (org-property-next-allowed-value t))
16505 (defun org-property-next-allowed-value (&optional previous)
16506 "Switch to the next allowed value for this property."
16507 (interactive)
16508 (unless (org-at-property-p)
16509 (user-error "Not at a property"))
16510 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16511 (key (match-string 2))
16512 (value (match-string 3))
16513 (allowed (or (org-property-get-allowed-values (point) key)
16514 (and (member value '("[ ]" "[-]" "[X]"))
16515 '("[ ]" "[X]"))))
16516 (heading (save-match-data (nth 4 (org-heading-components))))
16517 nval)
16518 (unless allowed
16519 (user-error "Allowed values for this property have not been defined"))
16520 (if previous (setq allowed (reverse allowed)))
16521 (if (member value allowed)
16522 (setq nval (car (cdr (member value allowed)))))
16523 (setq nval (or nval (car allowed)))
16524 (if (equal nval value)
16525 (user-error "Only one allowed value for this property"))
16526 (org-at-property-p)
16527 (replace-match (concat " :" key ": " nval) t t)
16528 (org-indent-line)
16529 (beginning-of-line 1)
16530 (skip-chars-forward " \t")
16531 (when (equal prop org-effort-property)
16532 (org-refresh-property
16533 '((effort . identity)
16534 (effort-minutes . org-duration-string-to-minutes))
16535 nval)
16536 (when (string= org-clock-current-task heading)
16537 (setq org-clock-effort nval)
16538 (org-clock-update-mode-line)))
16539 (run-hook-with-args 'org-property-changed-functions key nval)))
16541 (defun org-find-olp (path &optional this-buffer)
16542 "Return a marker pointing to the entry at outline path OLP.
16543 If anything goes wrong, throw an error.
16544 You can wrap this call to catch the error like this:
16546 (condition-case msg
16547 (org-mobile-locate-entry (match-string 4))
16548 (error (nth 1 msg)))
16550 The return value will then be either a string with the error message,
16551 or a marker if everything is OK.
16553 If THIS-BUFFER is set, the outline path does not contain a file,
16554 only headings."
16555 (let* ((file (if this-buffer buffer-file-name (pop path)))
16556 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16557 (level 1)
16558 (lmin 1)
16559 (lmax 1)
16560 limit re end found pos heading cnt flevel)
16561 (unless buffer (error "File not found :%s" file))
16562 (with-current-buffer buffer
16563 (save-excursion
16564 (save-restriction
16565 (widen)
16566 (setq limit (point-max))
16567 (goto-char (point-min))
16568 (dolist (heading path)
16569 (setq re (format org-complex-heading-regexp-format
16570 (regexp-quote heading)))
16571 (setq cnt 0 pos (point))
16572 (while (re-search-forward re end t)
16573 (setq level (- (match-end 1) (match-beginning 1)))
16574 (if (and (>= level lmin) (<= level lmax))
16575 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16576 (when (= cnt 0) (error "Heading not found on level %d: %s"
16577 lmax heading))
16578 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16579 lmax heading))
16580 (goto-char found)
16581 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16582 (setq end (save-excursion (org-end-of-subtree t t))))
16583 (when (org-at-heading-p)
16584 (point-marker)))))))
16586 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16587 "Find node HEADING in BUFFER.
16588 Return a marker to the heading if it was found, or nil if not.
16589 If POS-ONLY is set, return just the position instead of a marker.
16591 The heading text must match exact, but it may have a TODO keyword,
16592 a priority cookie and tags in the standard locations."
16593 (with-current-buffer (or buffer (current-buffer))
16594 (save-excursion
16595 (save-restriction
16596 (widen)
16597 (goto-char (point-min))
16598 (let (case-fold-search)
16599 (if (re-search-forward
16600 (format org-complex-heading-regexp-format
16601 (regexp-quote heading)) nil t)
16602 (if pos-only
16603 (match-beginning 0)
16604 (move-marker (make-marker) (match-beginning 0)))))))))
16606 (defun org-find-exact-heading-in-directory (heading &optional dir)
16607 "Find Org node headline HEADING in all .org files in directory DIR.
16608 When the target headline is found, return a marker to this location."
16609 (let ((files (directory-files (or dir default-directory)
16610 t "\\`[^.#].*\\.org\\'"))
16611 visiting m buffer)
16612 (catch 'found
16613 (dolist (file files)
16614 (message "trying %s" file)
16615 (setq visiting (org-find-base-buffer-visiting file))
16616 (setq buffer (or visiting (find-file-noselect file)))
16617 (setq m (org-find-exact-headline-in-buffer
16618 heading buffer))
16619 (when (and (not m) (not visiting)) (kill-buffer buffer))
16620 (and m (throw 'found m))))))
16622 (defun org-find-entry-with-id (ident)
16623 "Locate the entry that contains the ID property with exact value IDENT.
16624 IDENT can be a string, a symbol or a number, this function will search for
16625 the string representation of it.
16626 Return the position where this entry starts, or nil if there is no such entry."
16627 (interactive "sID: ")
16628 (let ((id (cond
16629 ((stringp ident) ident)
16630 ((symbolp ident) (symbol-name ident))
16631 ((numberp ident) (number-to-string ident))
16632 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16633 (org-with-wide-buffer (org-find-property "ID" id))))
16635 ;;;; Timestamps
16637 (defvar org-last-changed-timestamp nil)
16638 (defvar org-last-inserted-timestamp nil
16639 "The last time stamp inserted with `org-insert-time-stamp'.")
16640 (defvar org-ts-what) ; dynamically scoped parameter
16642 (defun org-time-stamp (arg &optional inactive)
16643 "Prompt for a date/time and insert a time stamp.
16645 If the user specifies a time like HH:MM or if this command is
16646 called with at least one prefix argument, the time stamp contains
16647 the date and the time. Otherwise, only the date is included.
16649 All parts of a date not specified by the user are filled in from
16650 the timestamp at point, if any, or the current date/time
16651 otherwise.
16653 If there is already a timestamp at the cursor, it is replaced.
16655 With two universal prefix arguments, insert an active timestamp
16656 with the current time without prompting the user.
16658 When called from lisp, the timestamp is inactive if INACTIVE is
16659 non-nil."
16660 (interactive "P")
16661 (let* ((ts (cond
16662 ((org-at-date-range-p t)
16663 (match-string (if (< (point) (- (match-beginning 2) 2)) 1 2)))
16664 ((org-at-timestamp-p t) (match-string 0))))
16665 ;; Default time is either the timestamp at point or today.
16666 ;; When entering a range, only the range start is considered.
16667 (default-time (if (not ts) (current-time)
16668 (apply #'encode-time (org-parse-time-string ts))))
16669 (default-input (and ts (org-get-compact-tod ts)))
16670 (repeater (and ts
16671 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16672 (match-string 0 ts)))
16673 org-time-was-given
16674 org-end-time-was-given
16675 (time
16676 (and (if (equal arg '(16)) (current-time)
16677 ;; Preserve `this-command' and `last-command'.
16678 (let ((this-command this-command)
16679 (last-command last-command))
16680 (org-read-date
16681 arg 'totime nil nil default-time default-input
16682 inactive))))))
16683 (cond
16684 ((and ts
16685 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16686 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16687 (insert "--")
16688 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16690 ;; Make sure we're on a timestamp. When in the middle of a date
16691 ;; range, move arbitrarily to range end.
16692 (unless (org-at-timestamp-p t)
16693 (skip-chars-forward "-")
16694 (org-at-timestamp-p t))
16695 (replace-match "")
16696 (setq org-last-changed-timestamp
16697 (org-insert-time-stamp
16698 time (or org-time-was-given arg)
16699 inactive nil nil (list org-end-time-was-given)))
16700 (when repeater
16701 (backward-char)
16702 (insert " " repeater)
16703 (setq org-last-changed-timestamp
16704 (concat (substring org-last-inserted-timestamp 0 -1)
16705 " " repeater ">")))
16706 (message "Timestamp updated"))
16707 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16708 (t (org-insert-time-stamp
16709 time (or org-time-was-given arg) inactive nil nil
16710 (list org-end-time-was-given))))))
16712 ;; FIXME: can we use this for something else, like computing time differences?
16713 (defun org-get-compact-tod (s)
16714 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16715 (let* ((t1 (match-string 1 s))
16716 (h1 (string-to-number (match-string 2 s)))
16717 (m1 (string-to-number (match-string 3 s)))
16718 (t2 (and (match-end 4) (match-string 5 s)))
16719 (h2 (and t2 (string-to-number (match-string 6 s))))
16720 (m2 (and t2 (string-to-number (match-string 7 s))))
16721 dh dm)
16722 (if (not t2)
16724 (setq dh (- h2 h1) dm (- m2 m1))
16725 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16726 (concat t1 "+" (number-to-string dh)
16727 (and (/= 0 dm) (format ":%02d" dm)))))))
16729 (defun org-time-stamp-inactive (&optional arg)
16730 "Insert an inactive time stamp.
16731 An inactive time stamp is enclosed in square brackets instead of angle
16732 brackets. It is inactive in the sense that it does not trigger agenda entries,
16733 does not link to the calendar and cannot be changed with the S-cursor keys.
16734 So these are more for recording a certain time/date."
16735 (interactive "P")
16736 (org-time-stamp arg 'inactive))
16738 (defvar org-date-ovl (make-overlay 1 1))
16739 (overlay-put org-date-ovl 'face 'org-date-selected)
16740 (org-detach-overlay org-date-ovl)
16742 (defvar org-ans1) ; dynamically scoped parameter
16743 (defvar org-ans2) ; dynamically scoped parameter
16745 (defvar org-plain-time-of-day-regexp) ; defined below
16747 (defvar org-overriding-default-time nil) ; dynamically scoped
16748 (defvar org-read-date-overlay nil)
16749 (defvar org-dcst nil) ; dynamically scoped
16750 (defvar org-read-date-history nil)
16751 (defvar org-read-date-final-answer nil)
16752 (defvar org-read-date-analyze-futurep nil)
16753 (defvar org-read-date-analyze-forced-year nil)
16754 (defvar org-read-date-inactive)
16756 (defvar org-read-date-minibuffer-local-map
16757 (let* ((map (make-sparse-keymap)))
16758 (set-keymap-parent map minibuffer-local-map)
16759 (org-defkey map (kbd ".")
16760 (lambda () (interactive)
16761 ;; Are we at the beginning of the prompt?
16762 (if (org-looking-back "^[^:]+: "
16763 (let ((inhibit-field-text-motion t))
16764 (line-beginning-position)))
16765 (org-eval-in-calendar '(calendar-goto-today))
16766 (insert "."))))
16767 (org-defkey map (kbd "C-.")
16768 (lambda () (interactive)
16769 (org-eval-in-calendar '(calendar-goto-today))))
16770 (org-defkey map [(meta shift left)]
16771 (lambda () (interactive)
16772 (org-eval-in-calendar '(calendar-backward-month 1))))
16773 (org-defkey map [(meta shift right)]
16774 (lambda () (interactive)
16775 (org-eval-in-calendar '(calendar-forward-month 1))))
16776 (org-defkey map [(meta shift up)]
16777 (lambda () (interactive)
16778 (org-eval-in-calendar '(calendar-backward-year 1))))
16779 (org-defkey map [(meta shift down)]
16780 (lambda () (interactive)
16781 (org-eval-in-calendar '(calendar-forward-year 1))))
16782 (org-defkey map [?\e (shift left)]
16783 (lambda () (interactive)
16784 (org-eval-in-calendar '(calendar-backward-month 1))))
16785 (org-defkey map [?\e (shift right)]
16786 (lambda () (interactive)
16787 (org-eval-in-calendar '(calendar-forward-month 1))))
16788 (org-defkey map [?\e (shift up)]
16789 (lambda () (interactive)
16790 (org-eval-in-calendar '(calendar-backward-year 1))))
16791 (org-defkey map [?\e (shift down)]
16792 (lambda () (interactive)
16793 (org-eval-in-calendar '(calendar-forward-year 1))))
16794 (org-defkey map [(shift up)]
16795 (lambda () (interactive)
16796 (org-eval-in-calendar '(calendar-backward-week 1))))
16797 (org-defkey map [(shift down)]
16798 (lambda () (interactive)
16799 (org-eval-in-calendar '(calendar-forward-week 1))))
16800 (org-defkey map [(shift left)]
16801 (lambda () (interactive)
16802 (org-eval-in-calendar '(calendar-backward-day 1))))
16803 (org-defkey map [(shift right)]
16804 (lambda () (interactive)
16805 (org-eval-in-calendar '(calendar-forward-day 1))))
16806 (org-defkey map "!"
16807 (lambda () (interactive)
16808 (org-eval-in-calendar '(diary-view-entries))
16809 (message "")))
16810 (org-defkey map ">"
16811 (lambda () (interactive)
16812 (org-eval-in-calendar '(calendar-scroll-left 1))))
16813 (org-defkey map "<"
16814 (lambda () (interactive)
16815 (org-eval-in-calendar '(calendar-scroll-right 1))))
16816 (org-defkey map "\C-v"
16817 (lambda () (interactive)
16818 (org-eval-in-calendar
16819 '(calendar-scroll-left-three-months 1))))
16820 (org-defkey map "\M-v"
16821 (lambda () (interactive)
16822 (org-eval-in-calendar
16823 '(calendar-scroll-right-three-months 1))))
16824 map)
16825 "Keymap for minibuffer commands when using `org-read-date'.")
16827 (defvar org-def)
16828 (defvar org-defdecode)
16829 (defvar org-with-time)
16831 (defun org-read-date (&optional org-with-time to-time from-string prompt
16832 default-time default-input inactive)
16833 "Read a date, possibly a time, and make things smooth for the user.
16834 The prompt will suggest to enter an ISO date, but you can also enter anything
16835 which will at least partially be understood by `parse-time-string'.
16836 Unrecognized parts of the date will default to the current day, month, year,
16837 hour and minute. If this command is called to replace a timestamp at point,
16838 or to enter the second timestamp of a range, the default time is taken
16839 from the existing stamp. Furthermore, the command prefers the future,
16840 so if you are giving a date where the year is not given, and the day-month
16841 combination is already past in the current year, it will assume you
16842 mean next year. For details, see the manual. A few examples:
16844 3-2-5 --> 2003-02-05
16845 feb 15 --> currentyear-02-15
16846 2/15 --> currentyear-02-15
16847 sep 12 9 --> 2009-09-12
16848 12:45 --> today 12:45
16849 22 sept 0:34 --> currentyear-09-22 0:34
16850 12 --> currentyear-currentmonth-12
16851 Fri --> nearest Friday after today
16852 -Tue --> last Tuesday
16853 etc.
16855 Furthermore you can specify a relative date by giving, as the *first* thing
16856 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16857 change in days weeks, months, years.
16858 With a single plus or minus, the date is relative to today. With a double
16859 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16860 +4d --> four days from today
16861 +4 --> same as above
16862 +2w --> two weeks from today
16863 ++5 --> five days from default date
16865 The function understands only English month and weekday abbreviations.
16867 While prompting, a calendar is popped up - you can also select the
16868 date with the mouse (button 1). The calendar shows a period of three
16869 months. To scroll it to other months, use the keys `>' and `<'.
16870 If you don't like the calendar, turn it off with
16871 (setq org-read-date-popup-calendar nil)
16873 With optional argument TO-TIME, the date will immediately be converted
16874 to an internal time.
16875 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16876 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16877 still enter a time, and this function will inform the calling routine
16878 about this change. The calling routine may then choose to change the
16879 format used to insert the time stamp into the buffer to include the time.
16880 With optional argument FROM-STRING, read from this string instead from
16881 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16882 the time/date that is used for everything that is not specified by the
16883 user."
16884 (require 'parse-time)
16885 (let* ((org-time-stamp-rounding-minutes
16886 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16887 (org-dcst org-display-custom-times)
16888 (ct (org-current-time))
16889 (org-def (or org-overriding-default-time default-time ct))
16890 (org-defdecode (decode-time org-def))
16891 (dummy (progn
16892 (when (< (nth 2 org-defdecode) org-extend-today-until)
16893 (setcar (nthcdr 2 org-defdecode) -1)
16894 (setcar (nthcdr 1 org-defdecode) 59)
16895 (setq org-def (apply 'encode-time org-defdecode)
16896 org-defdecode (decode-time org-def)))))
16897 (cur-frame (selected-frame))
16898 (mouse-autoselect-window nil) ; Don't let the mouse jump
16899 (calendar-frame-setup nil)
16900 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16901 (calendar-move-hook nil)
16902 (calendar-view-diary-initially-flag nil)
16903 (calendar-view-holidays-initially-flag nil)
16904 (timestr (format-time-string
16905 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16906 (prompt (concat (if prompt (concat prompt " ") "")
16907 (format "Date+time [%s]: " timestr)))
16908 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16910 (cond
16911 (from-string (setq ans from-string))
16912 (org-read-date-popup-calendar
16913 (save-excursion
16914 (save-window-excursion
16915 (calendar)
16916 (when (eq calendar-setup 'calendar-only)
16917 (setq cal-frame
16918 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16919 (select-frame cal-frame))
16920 (org-eval-in-calendar '(setq cursor-type nil) t)
16921 (unwind-protect
16922 (progn
16923 (calendar-forward-day (- (time-to-days org-def)
16924 (calendar-absolute-from-gregorian
16925 (calendar-current-date))))
16926 (org-eval-in-calendar nil t)
16927 (let* ((old-map (current-local-map))
16928 (map (copy-keymap calendar-mode-map))
16929 (minibuffer-local-map
16930 (copy-keymap org-read-date-minibuffer-local-map)))
16931 (org-defkey map (kbd "RET") 'org-calendar-select)
16932 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16933 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16934 (unwind-protect
16935 (progn
16936 (use-local-map map)
16937 (setq org-read-date-inactive inactive)
16938 (add-hook 'post-command-hook 'org-read-date-display)
16939 (setq org-ans0 (read-string prompt default-input
16940 'org-read-date-history nil))
16941 ;; org-ans0: from prompt
16942 ;; org-ans1: from mouse click
16943 ;; org-ans2: from calendar motion
16944 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16945 (remove-hook 'post-command-hook 'org-read-date-display)
16946 (use-local-map old-map)
16947 (when org-read-date-overlay
16948 (delete-overlay org-read-date-overlay)
16949 (setq org-read-date-overlay nil)))))
16950 (bury-buffer "*Calendar*")
16951 (when cal-frame
16952 (delete-frame cal-frame)
16953 (select-frame-set-input-focus cur-frame))))))
16955 (t ; Naked prompt only
16956 (unwind-protect
16957 (setq ans (read-string prompt default-input
16958 'org-read-date-history timestr))
16959 (when org-read-date-overlay
16960 (delete-overlay org-read-date-overlay)
16961 (setq org-read-date-overlay nil)))))
16963 (setq final (org-read-date-analyze ans org-def org-defdecode))
16965 (when org-read-date-analyze-forced-year
16966 (message "Year was forced into %s"
16967 (if org-read-date-force-compatible-dates
16968 "compatible range (1970-2037)"
16969 "range representable on this machine"))
16970 (ding))
16972 ;; One round trip to get rid of 34th of August and stuff like that....
16973 (setq final (decode-time (apply 'encode-time final)))
16975 (setq org-read-date-final-answer ans)
16977 (if to-time
16978 (apply 'encode-time final)
16979 (if (and (boundp 'org-time-was-given) org-time-was-given)
16980 (format "%04d-%02d-%02d %02d:%02d"
16981 (nth 5 final) (nth 4 final) (nth 3 final)
16982 (nth 2 final) (nth 1 final))
16983 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16985 (defun org-read-date-display ()
16986 "Display the current date prompt interpretation in the minibuffer."
16987 (when org-read-date-display-live
16988 (when org-read-date-overlay
16989 (delete-overlay org-read-date-overlay))
16990 (when (minibufferp (current-buffer))
16991 (save-excursion
16992 (end-of-line 1)
16993 (while (not (equal (buffer-substring
16994 (max (point-min) (- (point) 4)) (point))
16995 " "))
16996 (insert " ")))
16997 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16998 " " (or org-ans1 org-ans2)))
16999 (org-end-time-was-given nil)
17000 (f (org-read-date-analyze ans org-def org-defdecode))
17001 (fmts (if org-dcst
17002 org-time-stamp-custom-formats
17003 org-time-stamp-formats))
17004 (fmt (if (or org-with-time
17005 (and (boundp 'org-time-was-given) org-time-was-given))
17006 (cdr fmts)
17007 (car fmts)))
17008 (txt (format-time-string fmt (apply 'encode-time f)))
17009 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
17010 (txt (concat "=> " txt)))
17011 (when (and org-end-time-was-given
17012 (string-match org-plain-time-of-day-regexp txt))
17013 (setq txt (concat (substring txt 0 (match-end 0)) "-"
17014 org-end-time-was-given
17015 (substring txt (match-end 0)))))
17016 (when org-read-date-analyze-futurep
17017 (setq txt (concat txt " (=>F)")))
17018 (setq org-read-date-overlay
17019 (make-overlay (1- (point-at-eol)) (point-at-eol)))
17020 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
17022 (defun org-read-date-analyze (ans org-def org-defdecode)
17023 "Analyze the combined answer of the date prompt."
17024 ;; FIXME: cleanup and comment
17025 ;; Pass `current-time' result to `decode-time' (instead of calling
17026 ;; without arguments) so that only `current-time' has to be
17027 ;; overriden in tests.
17028 (let ((nowdecode (decode-time (current-time)))
17029 delta deltan deltaw deltadef year month day
17030 hour minute second wday pm h2 m2 tl wday1
17031 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
17032 (setq org-read-date-analyze-futurep nil
17033 org-read-date-analyze-forced-year nil)
17034 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
17035 (setq ans "+0"))
17037 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
17038 (setq ans (replace-match "" t t ans)
17039 deltan (car delta)
17040 deltaw (nth 1 delta)
17041 deltadef (nth 2 delta)))
17043 ;; Check if there is an iso week date in there. If yes, store the
17044 ;; info and postpone interpreting it until the rest of the parsing
17045 ;; is done.
17046 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17047 (setq iso-year (if (match-end 1)
17048 (org-small-year-to-year
17049 (string-to-number (match-string 1 ans))))
17050 iso-weekday (if (match-end 3)
17051 (string-to-number (match-string 3 ans)))
17052 iso-week (string-to-number (match-string 2 ans)))
17053 (setq ans (replace-match "" t t ans)))
17055 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17056 (when (string-match
17057 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17058 (setq year (if (match-end 2)
17059 (string-to-number (match-string 2 ans))
17060 (progn (setq kill-year t)
17061 (string-to-number (format-time-string "%Y"))))
17062 month (string-to-number (match-string 3 ans))
17063 day (string-to-number (match-string 4 ans)))
17064 (if (< year 100) (setq year (+ 2000 year)))
17065 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17066 t nil ans)))
17068 ;; Help matching dotted european dates
17069 (when (string-match
17070 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17071 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17072 (setq kill-year t)
17073 (string-to-number (format-time-string "%Y")))
17074 day (string-to-number (match-string 1 ans))
17075 month (string-to-number (match-string 2 ans))
17076 ans (replace-match (format "%04d-%02d-%02d" year month day)
17077 t nil ans)))
17079 ;; Help matching american dates, like 5/30 or 5/30/7
17080 (when (string-match
17081 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17082 (setq year (if (match-end 4)
17083 (string-to-number (match-string 4 ans))
17084 (progn (setq kill-year t)
17085 (string-to-number (format-time-string "%Y"))))
17086 month (string-to-number (match-string 1 ans))
17087 day (string-to-number (match-string 2 ans)))
17088 (if (< year 100) (setq year (+ 2000 year)))
17089 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17090 t nil ans)))
17091 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17092 ;; If there is a time with am/pm, and *no* time without it, we convert
17093 ;; so that matching will be successful.
17094 (loop for i from 1 to 2 do ; twice, for end time as well
17095 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17096 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17097 (setq hour (string-to-number (match-string 1 ans))
17098 minute (if (match-end 3)
17099 (string-to-number (match-string 3 ans))
17101 pm (equal ?p
17102 (string-to-char (downcase (match-string 4 ans)))))
17103 (if (and (= hour 12) (not pm))
17104 (setq hour 0)
17105 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17106 (setq ans (replace-match (format "%02d:%02d" hour minute)
17107 t t ans))))
17109 ;; Check if a time range is given as a duration
17110 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17111 (setq hour (string-to-number (match-string 1 ans))
17112 h2 (+ hour (string-to-number (match-string 3 ans)))
17113 minute (string-to-number (match-string 2 ans))
17114 m2 (+ minute (if (match-end 5) (string-to-number
17115 (match-string 5 ans))0)))
17116 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17117 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17118 t t ans)))
17120 ;; Check if there is a time range
17121 (when (boundp 'org-end-time-was-given)
17122 (setq org-time-was-given nil)
17123 (when (and (string-match org-plain-time-of-day-regexp ans)
17124 (match-end 8))
17125 (setq org-end-time-was-given (match-string 8 ans))
17126 (setq ans (concat (substring ans 0 (match-beginning 7))
17127 (substring ans (match-end 7))))))
17129 (setq tl (parse-time-string ans)
17130 day (or (nth 3 tl) (nth 3 org-defdecode))
17131 month
17132 (cond ((nth 4 tl))
17133 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17134 ;; Day was specified. Make sure DAY+MONTH
17135 ;; combination happens in the future.
17136 ((nth 3 tl)
17137 (setq futurep t)
17138 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17139 (nth 4 nowdecode)))
17140 (t (nth 4 org-defdecode)))
17141 year
17142 (cond ((and (not kill-year) (nth 5 tl)))
17143 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17144 ;; Month was guessed in the future and is at least
17145 ;; equal to NOWDECODE's. Fix year accordingly.
17146 (futurep
17147 (if (or (> month (nth 4 nowdecode))
17148 (>= day (nth 3 nowdecode)))
17149 (nth 5 nowdecode)
17150 (1+ (nth 5 nowdecode))))
17151 ;; Month was specified. Make sure MONTH+YEAR
17152 ;; combination happens in the future.
17153 ((nth 4 tl)
17154 (setq futurep t)
17155 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17156 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17157 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17158 (t (nth 5 nowdecode))))
17159 (t (nth 5 org-defdecode)))
17160 hour (or (nth 2 tl) (nth 2 org-defdecode))
17161 minute (or (nth 1 tl) (nth 1 org-defdecode))
17162 second (or (nth 0 tl) 0)
17163 wday (nth 6 tl))
17165 (when (and (eq org-read-date-prefer-future 'time)
17166 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17167 (equal day (nth 3 nowdecode))
17168 (equal month (nth 4 nowdecode))
17169 (equal year (nth 5 nowdecode))
17170 (nth 2 tl)
17171 (or (< (nth 2 tl) (nth 2 nowdecode))
17172 (and (= (nth 2 tl) (nth 2 nowdecode))
17173 (nth 1 tl)
17174 (< (nth 1 tl) (nth 1 nowdecode)))))
17175 (setq day (1+ day)
17176 futurep t))
17178 ;; Special date definitions below
17179 (cond
17180 (iso-week
17181 ;; There was an iso week
17182 (require 'cal-iso)
17183 (setq futurep nil)
17184 (setq year (or iso-year year)
17185 day (or iso-weekday wday 1)
17186 wday nil ; to make sure that the trigger below does not match
17187 iso-date (calendar-gregorian-from-absolute
17188 (calendar-iso-to-absolute
17189 (list iso-week day year))))
17190 ; FIXME: Should we also push ISO weeks into the future?
17191 ; (when (and org-read-date-prefer-future
17192 ; (not iso-year)
17193 ; (< (calendar-absolute-from-gregorian iso-date)
17194 ; (time-to-days (current-time))))
17195 ; (setq year (1+ year)
17196 ; iso-date (calendar-gregorian-from-absolute
17197 ; (calendar-iso-to-absolute
17198 ; (list iso-week day year)))))
17199 (setq month (car iso-date)
17200 year (nth 2 iso-date)
17201 day (nth 1 iso-date)))
17202 (deltan
17203 (setq futurep nil)
17204 (unless deltadef
17205 ;; Pass `current-time' result to `decode-time' (instead of
17206 ;; calling without arguments) so that only `current-time' has
17207 ;; to be overriden in tests.
17208 (let ((now (decode-time (current-time))))
17209 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17210 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17211 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17212 ((equal deltaw "m") (setq month (+ month deltan)))
17213 ((equal deltaw "y") (setq year (+ year deltan)))))
17214 ((and wday (not (nth 3 tl)))
17215 ;; Weekday was given, but no day, so pick that day in the week
17216 ;; on or after the derived date.
17217 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17218 (unless (equal wday wday1)
17219 (setq day (+ day (% (- wday wday1 -7) 7))))))
17220 (if (and (boundp 'org-time-was-given)
17221 (nth 2 tl))
17222 (setq org-time-was-given t))
17223 (if (< year 100) (setq year (+ 2000 year)))
17224 ;; Check of the date is representable
17225 (if org-read-date-force-compatible-dates
17226 (progn
17227 (if (< year 1970)
17228 (setq year 1970 org-read-date-analyze-forced-year t))
17229 (if (> year 2037)
17230 (setq year 2037 org-read-date-analyze-forced-year t)))
17231 (condition-case nil
17232 (ignore (encode-time second minute hour day month year))
17233 (error
17234 (setq year (nth 5 org-defdecode))
17235 (setq org-read-date-analyze-forced-year t))))
17236 (setq org-read-date-analyze-futurep futurep)
17237 (list second minute hour day month year)))
17239 (defvar parse-time-weekdays)
17240 (defun org-read-date-get-relative (s today default)
17241 "Check string S for special relative date string.
17242 TODAY and DEFAULT are internal times, for today and for a default.
17243 Return shift list (N what def-flag)
17244 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17245 N is the number of WHATs to shift.
17246 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17247 the DEFAULT date rather than TODAY."
17248 (require 'parse-time)
17249 (when (and
17250 (string-match
17251 (concat
17252 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17253 "\\([0-9]+\\)?"
17254 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17255 "\\([ \t]\\|$\\)") s)
17256 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17257 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17258 (string-to-char (substring (match-string 1 s) -1))
17259 ?+))
17260 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17261 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17262 (what (if (match-end 3) (match-string 3 s) "d"))
17263 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17264 (date (if rel default today))
17265 (wday (nth 6 (decode-time date)))
17266 delta)
17267 (if wday1
17268 (progn
17269 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17270 (if (= delta 0) (setq delta 7))
17271 (if (= dir ?-)
17272 (progn
17273 (setq delta (- delta 7))
17274 (if (= delta 0) (setq delta -7))))
17275 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17276 (list delta "d" rel))
17277 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17279 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17280 "Turn a user-specified date into the internal representation.
17281 The internal representation needed by the calendar is (month day year).
17282 This is a wrapper to handle the brain-dead convention in calendar that
17283 user function argument order change dependent on argument order."
17284 (if (boundp 'calendar-date-style)
17285 (cond
17286 ((eq calendar-date-style 'american)
17287 (list arg1 arg2 arg3))
17288 ((eq calendar-date-style 'european)
17289 (list arg2 arg1 arg3))
17290 ((eq calendar-date-style 'iso)
17291 (list arg2 arg3 arg1)))
17292 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17293 (if (org-bound-and-true-p european-calendar-style)
17294 (list arg2 arg1 arg3)
17295 (list arg1 arg2 arg3)))))
17297 (defun org-eval-in-calendar (form &optional keepdate)
17298 "Eval FORM in the calendar window and return to current window.
17299 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17300 otherwise stick to the current value of `org-ans2'."
17301 (let ((sf (selected-frame))
17302 (sw (selected-window)))
17303 (select-window (get-buffer-window "*Calendar*" t))
17304 (eval form)
17305 (when (and (not keepdate) (calendar-cursor-to-date))
17306 (let* ((date (calendar-cursor-to-date))
17307 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17308 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17309 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17310 (select-window sw)
17311 (org-select-frame-set-input-focus sf)))
17313 (defun org-calendar-select ()
17314 "Return to `org-read-date' with the date currently selected.
17315 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17316 (interactive)
17317 (when (calendar-cursor-to-date)
17318 (let* ((date (calendar-cursor-to-date))
17319 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17320 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17321 (if (active-minibuffer-window) (exit-minibuffer))))
17323 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17324 "Insert a date stamp for the date given by the internal TIME.
17325 See `format-time-string' for the format of TIME.
17326 WITH-HM means use the stamp format that includes the time of the day.
17327 INACTIVE means use square brackets instead of angular ones, so that the
17328 stamp will not contribute to the agenda.
17329 PRE and POST are optional strings to be inserted before and after the
17330 stamp.
17331 The command returns the inserted time stamp."
17332 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17333 stamp)
17334 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17335 (insert-before-markers (or pre ""))
17336 (when (listp extra)
17337 (setq extra (car extra))
17338 (if (and (stringp extra)
17339 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17340 (setq extra (format "-%02d:%02d"
17341 (string-to-number (match-string 1 extra))
17342 (string-to-number (match-string 2 extra))))
17343 (setq extra nil)))
17344 (when extra
17345 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17346 (insert-before-markers (setq stamp (format-time-string fmt time)))
17347 (insert-before-markers (or post ""))
17348 (setq org-last-inserted-timestamp stamp)))
17350 (defun org-toggle-time-stamp-overlays ()
17351 "Toggle the use of custom time stamp formats."
17352 (interactive)
17353 (setq org-display-custom-times (not org-display-custom-times))
17354 (unless org-display-custom-times
17355 (let ((p (point-min)) (bmp (buffer-modified-p)))
17356 (while (setq p (next-single-property-change p 'display))
17357 (if (and (get-text-property p 'display)
17358 (eq (get-text-property p 'face) 'org-date))
17359 (remove-text-properties
17360 p (setq p (next-single-property-change p 'display))
17361 '(display t))))
17362 (set-buffer-modified-p bmp)))
17363 (if (featurep 'xemacs)
17364 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17365 (org-restart-font-lock)
17366 (setq org-table-may-need-update t)
17367 (if org-display-custom-times
17368 (message "Time stamps are overlaid with custom format")
17369 (message "Time stamp overlays removed")))
17371 (defun org-display-custom-time (beg end)
17372 "Overlay modified time stamp format over timestamp between BEG and END."
17373 (let* ((ts (buffer-substring beg end))
17374 t1 w1 with-hm tf time str w2 (off 0))
17375 (save-match-data
17376 (setq t1 (org-parse-time-string ts t))
17377 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17378 (setq off (- (match-end 0) (match-beginning 0)))))
17379 (setq end (- end off))
17380 (setq w1 (- end beg)
17381 with-hm (and (nth 1 t1) (nth 2 t1))
17382 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17383 time (org-fix-decoded-time t1)
17384 str (org-add-props
17385 (format-time-string
17386 (substring tf 1 -1) (apply 'encode-time time))
17387 nil 'mouse-face 'highlight)
17388 w2 (length str))
17389 (if (not (= w2 w1))
17390 (add-text-properties (1+ beg) (+ 2 beg)
17391 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17392 (if (featurep 'xemacs)
17393 (progn
17394 (put-text-property beg end 'invisible t)
17395 (put-text-property beg end 'end-glyph (make-glyph str)))
17396 (put-text-property beg end 'display str))))
17398 (defun org-fix-decoded-time (time)
17399 "Set 0 instead of nil for the first 6 elements of time.
17400 Don't touch the rest."
17401 (let ((n 0))
17402 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17404 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17406 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17407 "Difference between TIMESTAMP-STRING and now in days.
17408 If SECONDS is non-nil, return the difference in seconds."
17409 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17410 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17411 (funcall fdiff (current-time)))))
17413 (defun org-deadline-close (timestamp-string &optional ndays)
17414 "Is the time in TIMESTAMP-STRING close to the current date?"
17415 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17416 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17417 (not (org-entry-is-done-p))))
17419 (defun org-get-wdays (ts &optional delay zero-delay)
17420 "Get the deadline lead time appropriate for timestring TS.
17421 When DELAY is non-nil, get the delay time for scheduled items
17422 instead of the deadline lead time. When ZERO-DELAY is non-nil
17423 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17424 don't try to find the delay cookie in the scheduled timestamp."
17425 (let ((tv (if delay org-scheduled-delay-days
17426 org-deadline-warning-days)))
17427 (cond
17428 ((or (and delay (< tv 0))
17429 (and delay zero-delay (<= tv 0))
17430 (and (not delay) (<= tv 0)))
17431 ;; Enforce this value no matter what
17432 (- tv))
17433 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17434 ;; lead time is specified.
17435 (floor (* (string-to-number (match-string 1 ts))
17436 (cdr (assoc (match-string 2 ts)
17437 '(("d" . 1) ("w" . 7)
17438 ("m" . 30.4) ("y" . 365.25)
17439 ("h" . 0.041667)))))))
17440 ;; go for the default.
17441 (t tv))))
17443 (defun org-calendar-select-mouse (ev)
17444 "Return to `org-read-date' with the date currently selected.
17445 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17446 (interactive "e")
17447 (mouse-set-point ev)
17448 (when (calendar-cursor-to-date)
17449 (let* ((date (calendar-cursor-to-date))
17450 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17451 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17452 (if (active-minibuffer-window) (exit-minibuffer))))
17454 (defun org-check-deadlines (ndays)
17455 "Check if there are any deadlines due or past due.
17456 A deadline is considered due if it happens within `org-deadline-warning-days'
17457 days from today's date. If the deadline appears in an entry marked DONE,
17458 it is not shown. The prefix arg NDAYS can be used to test that many
17459 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17460 (interactive "P")
17461 (let* ((org-warn-days
17462 (cond
17463 ((equal ndays '(4)) 100000)
17464 (ndays (prefix-numeric-value ndays))
17465 (t (abs org-deadline-warning-days))))
17466 (case-fold-search nil)
17467 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17468 (callback
17469 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17470 (message "%d deadlines past-due or due within %d days"
17471 (org-occur regexp nil callback)
17472 org-warn-days)))
17474 (defsubst org-re-timestamp (type)
17475 "Return a regexp for timestamp TYPE.
17476 Allowed values for TYPE are:
17478 all: all timestamps
17479 active: only active timestamps (<...>)
17480 inactive: only inactive timestamps ([...])
17481 scheduled: only scheduled timestamps
17482 deadline: only deadline timestamps
17483 closed: only closed time-stamps
17485 When TYPE is nil, fall back on returning a regexp that matches
17486 both scheduled and deadline timestamps."
17487 (case type
17488 (all org-ts-regexp-both)
17489 (active org-ts-regexp)
17490 (inactive org-ts-regexp-inactive)
17491 (scheduled org-scheduled-time-regexp)
17492 (deadline org-deadline-time-regexp)
17493 (closed org-closed-time-regexp)
17494 (otherwise
17495 (concat "\\<"
17496 (regexp-opt (list org-deadline-string org-scheduled-string))
17497 " *<\\([^>]+\\)>"))))
17499 (defun org-check-before-date (date)
17500 "Check if there are deadlines or scheduled entries before DATE."
17501 (interactive (list (org-read-date)))
17502 (let ((case-fold-search nil)
17503 (regexp (org-re-timestamp org-ts-type))
17504 (callback
17505 `(lambda ()
17506 (let ((match (match-string 1)))
17507 (and ,(if (memq org-ts-type '(active inactive all))
17508 '(eq (org-element-type (org-element-context)) 'timestamp)
17509 '(org-at-planning-p))
17510 (time-less-p
17511 (org-time-string-to-time match)
17512 (org-time-string-to-time date)))))))
17513 (message "%d entries before %s"
17514 (org-occur regexp nil callback) date)))
17516 (defun org-check-after-date (date)
17517 "Check if there are deadlines or scheduled entries after DATE."
17518 (interactive (list (org-read-date)))
17519 (let ((case-fold-search nil)
17520 (regexp (org-re-timestamp org-ts-type))
17521 (callback
17522 `(lambda ()
17523 (let ((match (match-string 1)))
17524 (and ,(if (memq org-ts-type '(active inactive all))
17525 '(eq (org-element-type (org-element-context)) 'timestamp)
17526 '(org-at-planning-p))
17527 (not (time-less-p
17528 (org-time-string-to-time match)
17529 (org-time-string-to-time date))))))))
17530 (message "%d entries after %s"
17531 (org-occur regexp nil callback) date)))
17533 (defun org-check-dates-range (start-date end-date)
17534 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17535 (interactive (list (org-read-date nil nil nil "Range starts")
17536 (org-read-date nil nil nil "Range end")))
17537 (let ((case-fold-search nil)
17538 (regexp (org-re-timestamp org-ts-type))
17539 (callback
17540 `(lambda ()
17541 (let ((match (match-string 1)))
17542 (and
17543 ,(if (memq org-ts-type '(active inactive all))
17544 '(eq (org-element-type (org-element-context)) 'timestamp)
17545 '(org-at-planning-p))
17546 (not (time-less-p
17547 (org-time-string-to-time match)
17548 (org-time-string-to-time start-date)))
17549 (time-less-p
17550 (org-time-string-to-time match)
17551 (org-time-string-to-time end-date)))))))
17552 (message "%d entries between %s and %s"
17553 (org-occur regexp nil callback) start-date end-date)))
17555 (defun org-evaluate-time-range (&optional to-buffer)
17556 "Evaluate a time range by computing the difference between start and end.
17557 Normally the result is just printed in the echo area, but with prefix arg
17558 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17559 If the time range is actually in a table, the result is inserted into the
17560 next column.
17561 For time difference computation, a year is assumed to be exactly 365
17562 days in order to avoid rounding problems."
17563 (interactive "P")
17565 (org-clock-update-time-maybe)
17566 (save-excursion
17567 (unless (org-at-date-range-p t)
17568 (goto-char (point-at-bol))
17569 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17570 (if (not (org-at-date-range-p t))
17571 (user-error "Not at a time-stamp range, and none found in current line")))
17572 (let* ((ts1 (match-string 1))
17573 (ts2 (match-string 2))
17574 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17575 (match-end (match-end 0))
17576 (time1 (org-time-string-to-time ts1))
17577 (time2 (org-time-string-to-time ts2))
17578 (t1 (org-float-time time1))
17579 (t2 (org-float-time time2))
17580 (diff (abs (- t2 t1)))
17581 (negative (< (- t2 t1) 0))
17582 ;; (ys (floor (* 365 24 60 60)))
17583 (ds (* 24 60 60))
17584 (hs (* 60 60))
17585 (fy "%dy %dd %02d:%02d")
17586 (fy1 "%dy %dd")
17587 (fd "%dd %02d:%02d")
17588 (fd1 "%dd")
17589 (fh "%02d:%02d")
17590 y d h m align)
17591 (if havetime
17592 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17594 d (floor (/ diff ds)) diff (mod diff ds)
17595 h (floor (/ diff hs)) diff (mod diff hs)
17596 m (floor (/ diff 60)))
17597 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17599 d (floor (+ (/ diff ds) 0.5))
17600 h 0 m 0))
17601 (if (not to-buffer)
17602 (message "%s" (org-make-tdiff-string y d h m))
17603 (if (org-at-table-p)
17604 (progn
17605 (goto-char match-end)
17606 (setq align t)
17607 (and (looking-at " *|") (goto-char (match-end 0))))
17608 (goto-char match-end))
17609 (if (looking-at
17610 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17611 (replace-match ""))
17612 (if negative (insert " -"))
17613 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17614 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17615 (insert " " (format fh h m))))
17616 (if align (org-table-align))
17617 (message "Time difference inserted")))))
17619 (defun org-make-tdiff-string (y d h m)
17620 (let ((fmt "")
17621 (l nil))
17622 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17623 l (push y l)))
17624 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17625 l (push d l)))
17626 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17627 l (push h l)))
17628 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17629 l (push m l)))
17630 (apply 'format fmt (nreverse l))))
17632 (defun org-time-string-to-time (s &optional buffer pos)
17633 "Convert a timestamp string into internal time."
17634 (condition-case errdata
17635 (apply 'encode-time (org-parse-time-string s))
17636 (error (error "Bad timestamp `%s'%s\nError was: %s"
17637 s (if (not (and buffer pos))
17639 (format-message " at %d in buffer `%s'" pos buffer))
17640 (cdr errdata)))))
17642 (defun org-time-string-to-seconds (s)
17643 "Convert a timestamp string to a number of seconds."
17644 (org-float-time (org-time-string-to-time s)))
17646 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17647 "Convert a time stamp to an absolute day number.
17648 If there is a specifier for a cyclic time stamp, get the closest
17649 date to DAYNR.
17650 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17651 The variable `date' is bound by the calendar when this is called."
17652 (cond
17653 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17654 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17655 daynr
17656 (+ daynr 1000)))
17657 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17658 (> (string-to-number (match-string 1 s)) 0))
17659 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17660 (time-to-days (current-time))) (match-string 0 s)
17661 prefer show-all))
17662 (t (time-to-days
17663 (condition-case errdata
17664 (apply 'encode-time (org-parse-time-string s))
17665 (error (error "Bad timestamp `%s'%s\nError was: %s"
17666 s (if (not (and buffer pos))
17668 (format-message " at %d in buffer `%s'" pos buffer))
17669 (cdr errdata))))))))
17671 (defun org-days-to-iso-week (days)
17672 "Return the iso week number."
17673 (require 'cal-iso)
17674 (car (calendar-iso-from-absolute days)))
17676 (defun org-small-year-to-year (year)
17677 "Convert 2-digit years into 4-digit years.
17678 YEAR is expanded into one of the 30 next years, if possible, or
17679 into a past one. Any year larger than 99 is returned unchanged."
17680 (if (>= year 100) year
17681 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17682 (century (/ current 100))
17683 (offset (- year (% current 100))))
17684 (cond ((> offset 30) (+ (* (1- century) 100) year))
17685 ((> offset -70) (+ (* century 100) year))
17686 (t (+ (* (1+ century) 100) year))))))
17688 (defun org-time-from-absolute (d)
17689 "Return the time corresponding to date D.
17690 D may be an absolute day number, or a calendar-type list (month day year)."
17691 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17692 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17694 (defun org-calendar-holiday ()
17695 "List of holidays, for Diary display in Org-mode."
17696 (require 'holidays)
17697 (let ((hl (funcall
17698 (if (fboundp 'calendar-check-holidays)
17699 'calendar-check-holidays 'check-calendar-holidays) date)))
17700 (if hl (mapconcat 'identity hl "; "))))
17702 (defun org-diary-sexp-entry (sexp entry date)
17703 "Process a SEXP diary ENTRY for DATE."
17704 (require 'diary-lib)
17705 (let ((result (if calendar-debug-sexp
17706 (let ((stack-trace-on-error t))
17707 (eval (car (read-from-string sexp))))
17708 (condition-case nil
17709 (eval (car (read-from-string sexp)))
17710 (error
17711 (beep)
17712 (message "Bad sexp at line %d in %s: %s"
17713 (org-current-line)
17714 (buffer-file-name) sexp)
17715 (sleep-for 2))))))
17716 (cond ((stringp result) (split-string result "; "))
17717 ((and (consp result)
17718 (not (consp (cdr result)))
17719 (stringp (cdr result))) (cdr result))
17720 ((and (consp result)
17721 (stringp (car result))) result)
17722 (result entry))))
17724 (defun org-diary-to-ical-string (frombuf)
17725 "Get iCalendar entries from diary entries in buffer FROMBUF.
17726 This uses the icalendar.el library."
17727 (let* ((tmpdir (if (featurep 'xemacs)
17728 (temp-directory)
17729 temporary-file-directory))
17730 (tmpfile (make-temp-name
17731 (expand-file-name "orgics" tmpdir)))
17732 buf rtn b e)
17733 (with-current-buffer frombuf
17734 (icalendar-export-region (point-min) (point-max) tmpfile)
17735 (setq buf (find-buffer-visiting tmpfile))
17736 (set-buffer buf)
17737 (goto-char (point-min))
17738 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17739 (setq b (match-beginning 0)))
17740 (goto-char (point-max))
17741 (if (re-search-backward "^END:VEVENT" nil t)
17742 (setq e (match-end 0)))
17743 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17744 (kill-buffer buf)
17745 (delete-file tmpfile)
17746 rtn))
17748 (defun org-closest-date (start current change prefer show-all)
17749 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17750 When PREFER is `past', return a date that is either CURRENT or past.
17751 When PREFER is `future', return a date that is either CURRENT or future.
17752 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17753 ;; Make the proper lists from the dates
17754 (catch 'exit
17755 (let ((a1 '(("h" . hour)
17756 ("d" . day)
17757 ("w" . week)
17758 ("m" . month)
17759 ("y" . year)))
17760 (shour (nth 2 (org-parse-time-string start)))
17761 dn dw sday cday n1 n2 n0
17762 d m y y1 y2 date1 date2 nmonths nm ny m2)
17764 (setq start (org-date-to-gregorian start)
17765 current (org-date-to-gregorian
17766 (if show-all
17767 current
17768 (time-to-days (current-time))))
17769 sday (calendar-absolute-from-gregorian start)
17770 cday (calendar-absolute-from-gregorian current))
17772 (if (<= cday sday) (throw 'exit sday))
17774 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17775 (setq dn (string-to-number (match-string 1 change))
17776 dw (cdr (assoc (match-string 2 change) a1))))
17777 (unless (and dn (> dn 0))
17778 (user-error "Invalid change specifier: %s" change))
17779 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17780 (cond
17781 ((eq dw 'hour)
17782 (let ((missing-hours
17783 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17784 dn)))
17785 (setq n1 (if (zerop missing-hours) cday
17786 (- cday (1+ (floor (/ missing-hours 24)))))
17787 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17788 ((eq dw 'day)
17789 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17790 n2 (+ n1 dn)))
17791 ((eq dw 'year)
17792 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17793 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17794 (setq date1 (list m d y1)
17795 n1 (calendar-absolute-from-gregorian date1)
17796 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17797 n2 (calendar-absolute-from-gregorian date2)))
17798 ((eq dw 'month)
17799 ;; approx number of month between the two dates
17800 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17801 ;; How often does dn fit in there?
17802 (setq d (nth 1 start) m (car start) y (nth 2 start)
17803 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17804 m (+ m nm)
17805 ny (floor (/ m 12))
17806 y (+ y ny)
17807 m (- m (* ny 12)))
17808 (while (> m 12) (setq m (- m 12) y (1+ y)))
17809 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17810 (setq m2 (+ m dn) y2 y)
17811 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17812 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17813 (while (<= n2 cday)
17814 (setq n1 n2 m m2 y y2)
17815 (setq m2 (+ m dn) y2 y)
17816 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17817 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17818 ;; Make sure n1 is the earlier date
17819 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17820 (if show-all
17821 (cond
17822 ((eq prefer 'past) (if (= cday n2) n2 n1))
17823 ((eq prefer 'future) (if (= cday n1) n1 n2))
17824 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17825 (cond
17826 ((eq prefer 'past) (if (= cday n2) n2 n1))
17827 ((eq prefer 'future) (if (= cday n1) n1 n2))
17828 (t (if (= cday n1) n1 n2)))))))
17830 (defun org-date-to-gregorian (date)
17831 "Turn any specification of DATE into a Gregorian date for the calendar."
17832 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17833 ((and (listp date) (= (length date) 3)) date)
17834 ((stringp date)
17835 (setq date (org-parse-time-string date))
17836 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17837 ((listp date)
17838 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17840 (defun org-parse-time-string (s &optional nodefault)
17841 "Parse the standard Org-mode time string.
17842 This should be a lot faster than the normal `parse-time-string'.
17843 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17844 hour and minute fields will be nil if not given."
17845 (cond ((string-match org-ts-regexp0 s)
17846 (list 0
17847 (if (or (match-beginning 8) (not nodefault))
17848 (string-to-number (or (match-string 8 s) "0")))
17849 (if (or (match-beginning 7) (not nodefault))
17850 (string-to-number (or (match-string 7 s) "0")))
17851 (string-to-number (match-string 4 s))
17852 (string-to-number (match-string 3 s))
17853 (string-to-number (match-string 2 s))
17854 nil nil nil))
17855 ((string-match "^<[^>]+>$" s)
17856 (decode-time (seconds-to-time (org-matcher-time s))))
17857 (t (error "Not a standard Org-mode time string: %s" s))))
17859 (defun org-timestamp-up (&optional arg)
17860 "Increase the date item at the cursor by one.
17861 If the cursor is on the year, change the year. If it is on the month,
17862 the day or the time, change that.
17863 With prefix ARG, change by that many units."
17864 (interactive "p")
17865 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17867 (defun org-timestamp-down (&optional arg)
17868 "Decrease 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-up-day (&optional arg)
17876 "Increase the date in the time stamp by one day.
17877 With prefix ARG, change that many days."
17878 (interactive "p")
17879 (if (and (not (org-at-timestamp-p t))
17880 (org-at-heading-p))
17881 (org-todo 'up)
17882 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17884 (defun org-timestamp-down-day (&optional arg)
17885 "Decrease the date in the time stamp by one day.
17886 With prefix ARG, change that many days."
17887 (interactive "p")
17888 (if (and (not (org-at-timestamp-p t))
17889 (org-at-heading-p))
17890 (org-todo 'down)
17891 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17893 (defun org-at-timestamp-p (&optional inactive-ok)
17894 "Non-nil if point is inside a timestamp.
17896 When optional argument INACTIVE-OK is non-nil, also consider
17897 inactive timestamps.
17899 When this function returns a non-nil value, match data is set
17900 according to `org-ts-regexp3' or `org-ts-regexp2', depending on
17901 INACTIVE-OK."
17902 (interactive)
17903 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17904 (pos (point))
17905 (ans (or (looking-at tsr)
17906 (save-excursion
17907 (skip-chars-backward "^[<\n\r\t")
17908 (if (> (point) (point-min)) (backward-char 1))
17909 (and (looking-at tsr)
17910 (> (- (match-end 0) pos) -1))))))
17911 (and ans
17912 (boundp 'org-ts-what)
17913 (setq org-ts-what
17914 (cond
17915 ((= pos (match-beginning 0)) 'bracket)
17916 ;; Point is considered to be "on the bracket" whether
17917 ;; it's really on it or right after it.
17918 ((= pos (1- (match-end 0))) 'bracket)
17919 ((= pos (match-end 0)) 'after)
17920 ((org-pos-in-match-range pos 2) 'year)
17921 ((org-pos-in-match-range pos 3) 'month)
17922 ((org-pos-in-match-range pos 7) 'hour)
17923 ((org-pos-in-match-range pos 8) 'minute)
17924 ((or (org-pos-in-match-range pos 4)
17925 (org-pos-in-match-range pos 5)) 'day)
17926 ((and (> pos (or (match-end 8) (match-end 5)))
17927 (< pos (match-end 0)))
17928 (- pos (or (match-end 8) (match-end 5))))
17929 (t 'day))))
17930 ans))
17932 (defun org-toggle-timestamp-type ()
17933 "Toggle the type (<active> or [inactive]) of a time stamp."
17934 (interactive)
17935 (when (org-at-timestamp-p t)
17936 (let ((beg (match-beginning 0)) (end (match-end 0))
17937 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17938 (save-excursion
17939 (goto-char beg)
17940 (while (re-search-forward "[][<>]" end t)
17941 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17942 t t)))
17943 (message "Timestamp is now %sactive"
17944 (if (equal (char-after beg) ?<) "" "in")))))
17946 (defun org-at-clock-log-p nil
17947 "Is the cursor on the clock log line?"
17948 (save-excursion
17949 (move-beginning-of-line 1)
17950 (looking-at org-clock-line-re)))
17952 (defvar org-clock-history) ; defined in org-clock.el
17953 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17954 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17955 "Change the date in the time stamp at point.
17956 The date will be changed by N times WHAT. WHAT can be `day', `month',
17957 `year', `minute', `second'. If WHAT is not given, the cursor position
17958 in the timestamp determines what will be changed.
17959 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17960 (let ((origin (point)) origin-cat
17961 with-hm inactive
17962 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17963 org-ts-what
17964 extra rem
17965 ts time time0 fixnext clrgx)
17966 (if (not (org-at-timestamp-p t))
17967 (user-error "Not at a timestamp"))
17968 (if (and (not what) (eq org-ts-what 'bracket))
17969 (org-toggle-timestamp-type)
17970 ;; Point isn't on brackets. Remember the part of the time-stamp
17971 ;; the point was in. Indeed, size of time-stamps may change,
17972 ;; but point must be kept in the same category nonetheless.
17973 (setq origin-cat org-ts-what)
17974 (if (and (not what) (not (eq org-ts-what 'day))
17975 org-display-custom-times
17976 (get-text-property (point) 'display)
17977 (not (get-text-property (1- (point)) 'display)))
17978 (setq org-ts-what 'day))
17979 (setq org-ts-what (or what org-ts-what)
17980 inactive (= (char-after (match-beginning 0)) ?\[)
17981 ts (match-string 0))
17982 (replace-match "")
17983 (when (string-match
17984 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17986 (setq extra (match-string 1 ts))
17987 (if suppress-tmp-delay
17988 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17989 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17990 (setq with-hm t))
17991 (setq time0 (org-parse-time-string ts))
17992 (when (and updown
17993 (eq org-ts-what 'minute)
17994 (not current-prefix-arg))
17995 ;; This looks like s-up and s-down. Change by one rounding step.
17996 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17997 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17998 (setcar (cdr time0) (+ (nth 1 time0)
17999 (if (> n 0) (- rem) (- dm rem))))))
18000 (setq time
18001 (encode-time (or (car time0) 0)
18002 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
18003 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
18004 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
18005 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
18006 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
18007 (nthcdr 6 time0)))
18008 (when (and (member org-ts-what '(hour minute))
18009 extra
18010 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
18011 (setq extra (org-modify-ts-extra
18012 extra
18013 (if (eq org-ts-what 'hour) 2 5)
18014 n dm)))
18015 (when (integerp org-ts-what)
18016 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
18017 (if (eq what 'calendar)
18018 (let ((cal-date (org-get-date-from-calendar)))
18019 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
18020 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
18021 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
18022 (setcar time0 (or (car time0) 0))
18023 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
18024 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
18025 (setq time (apply 'encode-time time0))))
18026 ;; Insert the new time-stamp, and ensure point stays in the same
18027 ;; category as before (i.e. not after the last position in that
18028 ;; category).
18029 (let ((pos (point)))
18030 ;; Stay before inserted string. `save-excursion' is of no use.
18031 (setq org-last-changed-timestamp
18032 (org-insert-time-stamp time with-hm inactive nil nil extra))
18033 (goto-char pos))
18034 (save-match-data
18035 (looking-at org-ts-regexp3)
18036 (goto-char (cond
18037 ;; `day' category ends before `hour' if any, or at
18038 ;; the end of the day name.
18039 ((eq origin-cat 'day)
18040 (min (or (match-beginning 7) (1- (match-end 5))) origin))
18041 ((eq origin-cat 'hour) (min (match-end 7) origin))
18042 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
18043 ((integerp origin-cat) (min (1- (match-end 0)) origin))
18044 ;; `year' and `month' have both fixed size: point
18045 ;; couldn't have moved into another part.
18046 (t origin))))
18047 ;; Update clock if on a CLOCK line.
18048 (org-clock-update-time-maybe)
18049 ;; Maybe adjust the closest clock in `org-clock-history'
18050 (when org-clock-adjust-closest
18051 (if (not (and (org-at-clock-log-p)
18052 (< 1 (length (delq nil (mapcar 'marker-position
18053 org-clock-history))))))
18054 (message "No clock to adjust")
18055 (cond ((save-excursion ; fix previous clock?
18056 (re-search-backward org-ts-regexp0 nil t)
18057 (org-looking-back (concat org-clock-string " \\[")
18058 (line-beginning-position)))
18059 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18060 ((save-excursion ; fix next clock?
18061 (re-search-backward org-ts-regexp0 nil t)
18062 (looking-at (concat org-ts-regexp0 "\\] =>")))
18063 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18064 (save-window-excursion
18065 ;; Find closest clock to point, adjust the previous/next one in history
18066 (let* ((p (save-excursion (org-back-to-heading t)))
18067 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18068 (clfixnth
18069 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18070 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18071 (if (not clfixpos)
18072 (message "No clock to adjust")
18073 (save-excursion
18074 (org-goto-marker-or-bmk clfixpos)
18075 (org-show-subtree)
18076 (when (re-search-forward clrgx nil t)
18077 (goto-char (match-beginning 1))
18078 (let (org-clock-adjust-closest)
18079 (org-timestamp-change n org-ts-what updown))
18080 (message "Clock adjusted in %s for heading: %s"
18081 (file-name-nondirectory (buffer-file-name))
18082 (org-get-heading t t)))))))))
18083 ;; Try to recenter the calendar window, if any.
18084 (if (and org-calendar-follow-timestamp-change
18085 (get-buffer-window "*Calendar*" t)
18086 (memq org-ts-what '(day month year)))
18087 (org-recenter-calendar (time-to-days time))))))
18089 (defun org-modify-ts-extra (s pos n dm)
18090 "Change the different parts of the lead-time and repeat fields in timestamp."
18091 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18092 ng h m new rem)
18093 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18094 (cond
18095 ((or (org-pos-in-match-range pos 2)
18096 (org-pos-in-match-range pos 3))
18097 (setq m (string-to-number (match-string 3 s))
18098 h (string-to-number (match-string 2 s)))
18099 (if (org-pos-in-match-range pos 2)
18100 (setq h (+ h n))
18101 (setq n (* dm (org-no-warnings (signum n))))
18102 (when (not (= 0 (setq rem (% m dm))))
18103 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18104 (setq m (+ m n)))
18105 (if (< m 0) (setq m (+ m 60) h (1- h)))
18106 (if (> m 59) (setq m (- m 60) h (1+ h)))
18107 (setq h (mod h 24))
18108 (setq ng 1 new (format "-%02d:%02d" h m)))
18109 ((org-pos-in-match-range pos 6)
18110 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18111 ((org-pos-in-match-range pos 5)
18112 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18114 ((org-pos-in-match-range pos 9)
18115 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18116 ((org-pos-in-match-range pos 8)
18117 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18119 (when ng
18120 (setq s (concat
18121 (substring s 0 (match-beginning ng))
18123 (substring s (match-end ng))))))
18126 (defun org-recenter-calendar (date)
18127 "If the calendar is visible, recenter it to DATE."
18128 (let ((cwin (get-buffer-window "*Calendar*" t)))
18129 (when cwin
18130 (let ((calendar-move-hook nil))
18131 (with-selected-window cwin
18132 (calendar-goto-date (if (listp date) date
18133 (calendar-gregorian-from-absolute date))))))))
18135 (defun org-goto-calendar (&optional arg)
18136 "Go to the Emacs calendar at the current date.
18137 If there is a time stamp in the current line, go to that date.
18138 A prefix ARG can be used to force the current date."
18139 (interactive "P")
18140 (let ((tsr org-ts-regexp) diff
18141 (calendar-move-hook nil)
18142 (calendar-view-holidays-initially-flag nil)
18143 (calendar-view-diary-initially-flag nil))
18144 (if (or (org-at-timestamp-p)
18145 (save-excursion
18146 (beginning-of-line 1)
18147 (looking-at (concat ".*" tsr))))
18148 (let ((d1 (time-to-days (current-time)))
18149 (d2 (time-to-days
18150 (org-time-string-to-time (match-string 1)))))
18151 (setq diff (- d2 d1))))
18152 (calendar)
18153 (calendar-goto-today)
18154 (if (and diff (not arg)) (calendar-forward-day diff))))
18156 (defun org-get-date-from-calendar ()
18157 "Return a list (month day year) of date at point in calendar."
18158 (with-current-buffer "*Calendar*"
18159 (save-match-data
18160 (calendar-cursor-to-date))))
18162 (defun org-date-from-calendar ()
18163 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18164 If there is already a time stamp at the cursor position, update it."
18165 (interactive)
18166 (if (org-at-timestamp-p t)
18167 (org-timestamp-change 0 'calendar)
18168 (let ((cal-date (org-get-date-from-calendar)))
18169 (org-insert-time-stamp
18170 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18172 (defcustom org-effort-durations
18173 `(("min" . 1)
18174 ("h" . 60)
18175 ("d" . ,(* 60 8))
18176 ("w" . ,(* 60 8 5))
18177 ("m" . ,(* 60 8 5 4))
18178 ("y" . ,(* 60 8 5 40)))
18179 "Conversion factor to minutes for an effort modifier.
18181 Each entry has the form (MODIFIER . MINUTES).
18183 In an effort string, a number followed by MODIFIER is multiplied
18184 by the specified number of MINUTES to obtain an effort in
18185 minutes.
18187 For example, if the value of this variable is ((\"hours\" . 60)), then an
18188 effort string \"2hours\" is equivalent to 120 minutes."
18189 :group 'org-agenda
18190 :version "25.1"
18191 :package-version '(Org . "8.3")
18192 :type '(alist :key-type (string :tag "Modifier")
18193 :value-type (number :tag "Minutes")))
18195 (defun org-minutes-to-clocksum-string (m)
18196 "Format number of minutes as a clocksum string.
18197 The format is determined by `org-time-clocksum-format',
18198 `org-time-clocksum-use-fractional' and
18199 `org-time-clocksum-fractional-format' and
18200 `org-time-clocksum-use-effort-durations'."
18201 (let ((clocksum "")
18202 (m (round m)) ; Don't allow fractions of minutes
18203 h d w mo y fmt n)
18204 (setq h (if org-time-clocksum-use-effort-durations
18205 (cdr (assoc "h" org-effort-durations)) 60)
18206 d (if org-time-clocksum-use-effort-durations
18207 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18208 w (if org-time-clocksum-use-effort-durations
18209 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18210 mo (if org-time-clocksum-use-effort-durations
18211 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18212 y (if org-time-clocksum-use-effort-durations
18213 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18214 ;; fractional format
18215 (if org-time-clocksum-use-fractional
18216 (cond
18217 ;; single format string
18218 ((stringp org-time-clocksum-fractional-format)
18219 (format org-time-clocksum-fractional-format (/ m (float h))))
18220 ;; choice of fractional formats for different time units
18221 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18222 (> (/ (truncate m) (* y d h)) 0))
18223 (format fmt (/ m (* y d (float h)))))
18224 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18225 (> (/ (truncate m) (* mo d h)) 0))
18226 (format fmt (/ m (* mo d (float h)))))
18227 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18228 (> (/ (truncate m) (* w d h)) 0))
18229 (format fmt (/ m (* w d (float h)))))
18230 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18231 (> (/ (truncate m) (* d h)) 0))
18232 (format fmt (/ m (* d (float h)))))
18233 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18234 (> (/ (truncate m) h) 0))
18235 (format fmt (/ m (float h))))
18236 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18237 (format fmt m))
18238 ;; fall back to smallest time unit with a format
18239 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18240 (format fmt (/ m (float h))))
18241 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18242 (format fmt (/ m (* d (float h)))))
18243 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18244 (format fmt (/ m (* w d (float h)))))
18245 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18246 (format fmt (/ m (* mo d (float h)))))
18247 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18248 (format fmt (/ m (* y d (float h))))))
18249 ;; standard (non-fractional) format, with single format string
18250 (if (stringp org-time-clocksum-format)
18251 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18252 ;; separate formats components
18253 (and (setq fmt (plist-get org-time-clocksum-format :years))
18254 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18255 (plist-get org-time-clocksum-format :require-years))
18256 (setq clocksum (concat clocksum (format fmt n))
18257 m (- m (* n y d h))))
18258 (and (setq fmt (plist-get org-time-clocksum-format :months))
18259 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18260 (plist-get org-time-clocksum-format :require-months))
18261 (setq clocksum (concat clocksum (format fmt n))
18262 m (- m (* n mo d h))))
18263 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18264 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18265 (plist-get org-time-clocksum-format :require-weeks))
18266 (setq clocksum (concat clocksum (format fmt n))
18267 m (- m (* n w d h))))
18268 (and (setq fmt (plist-get org-time-clocksum-format :days))
18269 (or (> (setq n (/ (truncate m) (* d h))) 0)
18270 (plist-get org-time-clocksum-format :require-days))
18271 (setq clocksum (concat clocksum (format fmt n))
18272 m (- m (* n d h))))
18273 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18274 (or (> (setq n (/ (truncate m) h)) 0)
18275 (plist-get org-time-clocksum-format :require-hours))
18276 (setq clocksum (concat clocksum (format fmt n))
18277 m (- m (* n h))))
18278 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18279 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18280 (setq clocksum (concat clocksum (format fmt m))))
18281 ;; return formatted time duration
18282 clocksum))))
18284 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18285 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18286 "Org mode version 8.0")
18288 (defun org-hours-to-clocksum-string (n)
18289 (org-minutes-to-clocksum-string (* n 60)))
18291 (defun org-hh:mm-string-to-minutes (s)
18292 "Convert a string H:MM to a number of minutes.
18293 If the string is just a number, interpret it as minutes.
18294 In fact, the first hh:mm or number in the string will be taken,
18295 there can be extra stuff in the string.
18296 If no number is found, the return value is 0."
18297 (cond
18298 ((integerp s) s)
18299 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18300 (+ (* (string-to-number (match-string 1 s)) 60)
18301 (string-to-number (match-string 2 s))))
18302 ((string-match "\\([0-9]+\\)" s)
18303 (string-to-number (match-string 1 s)))
18304 (t 0)))
18306 (defcustom org-image-actual-width t
18307 "Should we use the actual width of images when inlining them?
18309 When set to t, always use the image width.
18311 When set to a number, use imagemagick (when available) to set
18312 the image's width to this value.
18314 When set to a number in a list, try to get the width from any
18315 #+ATTR.* keyword if it matches a width specification like
18317 #+ATTR_HTML: :width 300px
18319 and fall back on that number if none is found.
18321 When set to nil, try to get the width from an #+ATTR.* keyword
18322 and fall back on the original width if none is found.
18324 This requires Emacs >= 24.1, build with imagemagick support."
18325 :group 'org-appearance
18326 :version "24.4"
18327 :package-version '(Org . "8.0")
18328 :type '(choice
18329 (const :tag "Use the image width" t)
18330 (integer :tag "Use a number of pixels")
18331 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18332 (const :tag "Use #+ATTR* or don't resize" nil)))
18334 (defcustom org-agenda-inhibit-startup nil
18335 "Inhibit startup when preparing agenda buffers.
18336 When this variable is t, the initialization of the Org agenda
18337 buffers is inhibited: e.g. the visibility state is not set, the
18338 tables are not re-aligned, etc."
18339 :type 'boolean
18340 :version "24.3"
18341 :group 'org-agenda)
18343 (define-obsolete-variable-alias
18344 'org-agenda-ignore-drawer-properties
18345 'org-agenda-ignore-properties "25.1")
18347 (defcustom org-agenda-ignore-properties nil
18348 "Avoid updating text properties when building the agenda.
18349 Properties are used to prepare buffers for effort estimates,
18350 appointments, statistics and subtree-local categories.
18351 If you don't use these in the agenda, you can add them to this
18352 list and agenda building will be a bit faster.
18353 The value is a list, with zero or more of the symbols `effort', `appt',
18354 `stats' or `category'."
18355 :type '(set :greedy t
18356 (const effort)
18357 (const appt)
18358 (const stats)
18359 (const category))
18360 :version "25.1"
18361 :package-version '(Org . "8.3")
18362 :group 'org-agenda)
18364 (defun org-duration-string-to-minutes (s &optional output-to-string)
18365 "Convert a duration string S to minutes.
18367 A bare number is interpreted as minutes, modifiers can be set by
18368 customizing `org-effort-durations' (which see).
18370 Entries containing a colon are interpreted as H:MM by
18371 `org-hh:mm-string-to-minutes'."
18372 (let ((result 0)
18373 (re (concat "\\([0-9.]+\\) *\\("
18374 (regexp-opt (mapcar 'car org-effort-durations))
18375 "\\)")))
18376 (while (string-match re s)
18377 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18378 (string-to-number (match-string 1 s))))
18379 (setq s (replace-match "" nil t s)))
18380 (setq result (floor result))
18381 (incf result (org-hh:mm-string-to-minutes s))
18382 (if output-to-string (number-to-string result) result)))
18384 ;;;; Files
18386 (defun org-save-all-org-buffers ()
18387 "Save all Org-mode buffers without user confirmation."
18388 (interactive)
18389 (message "Saving all Org-mode buffers...")
18390 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18391 (when (featurep 'org-id) (org-id-locations-save))
18392 (message "Saving all Org-mode buffers... done"))
18394 (defun org-revert-all-org-buffers ()
18395 "Revert all Org-mode buffers.
18396 Prompt for confirmation when there are unsaved changes.
18397 Be sure you know what you are doing before letting this function
18398 overwrite your changes.
18400 This function is useful in a setup where one tracks org files
18401 with a version control system, to revert on one machine after pulling
18402 changes from another. I believe the procedure must be like this:
18404 1. M-x org-save-all-org-buffers
18405 2. Pull changes from the other machine, resolve conflicts
18406 3. M-x org-revert-all-org-buffers"
18407 (interactive)
18408 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18409 (user-error "Abort"))
18410 (save-excursion
18411 (save-window-excursion
18412 (mapc
18413 (lambda (b)
18414 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18415 (with-current-buffer b buffer-file-name))
18416 (org-pop-to-buffer-same-window b)
18417 (revert-buffer t 'no-confirm)))
18418 (buffer-list))
18419 (when (and (featurep 'org-id) org-id-track-globally)
18420 (org-id-locations-load)))))
18422 ;;;; Agenda files
18424 ;;;###autoload
18425 (defun org-switchb (&optional arg)
18426 "Switch between Org buffers.
18427 With one prefix argument, restrict available buffers to files.
18428 With two prefix arguments, restrict available buffers to agenda files.
18430 Defaults to `iswitchb' for buffer name completion.
18431 Set `org-completion-use-ido' to make it use ido instead."
18432 (interactive "P")
18433 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18434 ((equal arg '(16)) (org-buffer-list 'agenda))
18435 (t (org-buffer-list))))
18436 (org-completion-use-iswitchb org-completion-use-iswitchb)
18437 (org-completion-use-ido org-completion-use-ido))
18438 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18439 (setq org-completion-use-iswitchb t))
18440 (org-pop-to-buffer-same-window
18441 (org-icompleting-read "Org buffer: "
18442 (mapcar 'list (mapcar 'buffer-name blist))
18443 nil t))))
18445 ;;; Define some older names previously used for this functionality
18446 ;;;###autoload
18447 (defalias 'org-ido-switchb 'org-switchb)
18448 ;;;###autoload
18449 (defalias 'org-iswitchb 'org-switchb)
18451 (defun org-buffer-list (&optional predicate exclude-tmp)
18452 "Return a list of Org buffers.
18453 PREDICATE can be `export', `files' or `agenda'.
18455 export restrict the list to Export buffers.
18456 files restrict the list to buffers visiting Org files.
18457 agenda restrict the list to buffers visiting agenda files.
18459 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18460 (let* ((bfn nil)
18461 (agenda-files (and (eq predicate 'agenda)
18462 (mapcar 'file-truename (org-agenda-files t))))
18463 (filter
18464 (cond
18465 ((eq predicate 'files)
18466 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18467 ((eq predicate 'export)
18468 (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
18469 ((eq predicate 'agenda)
18470 (lambda (b)
18471 (with-current-buffer b
18472 (and (derived-mode-p 'org-mode)
18473 (setq bfn (buffer-file-name b))
18474 (member (file-truename bfn) agenda-files)))))
18475 (t (lambda (b) (with-current-buffer b
18476 (or (derived-mode-p 'org-mode)
18477 (string-match "\\*Org .*Export"
18478 (buffer-name b)))))))))
18479 (delq nil
18480 (mapcar
18481 (lambda(b)
18482 (if (and (funcall filter b)
18483 (or (not exclude-tmp)
18484 (not (string-match "tmp" (buffer-name b)))))
18486 nil))
18487 (buffer-list)))))
18489 (defun org-agenda-files (&optional unrestricted archives)
18490 "Get the list of agenda files.
18491 Optional UNRESTRICTED means return the full list even if a restriction
18492 is currently in place.
18493 When ARCHIVES is t, include all archive files that are really being
18494 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18495 `org-agenda-archives-mode' is t."
18496 (let ((files
18497 (cond
18498 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18499 ((stringp org-agenda-files) (org-read-agenda-file-list))
18500 ((listp org-agenda-files) org-agenda-files)
18501 (t (error "Invalid value of `org-agenda-files'")))))
18502 (setq files (apply 'append
18503 (mapcar (lambda (f)
18504 (if (file-directory-p f)
18505 (directory-files
18506 f t org-agenda-file-regexp)
18507 (list f)))
18508 files)))
18509 (when org-agenda-skip-unavailable-files
18510 (setq files (delq nil
18511 (mapcar (function
18512 (lambda (file)
18513 (and (file-readable-p file) file)))
18514 files))))
18515 (when (or (eq archives t)
18516 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18517 (setq files (org-add-archive-files files)))
18518 files))
18520 (defun org-agenda-file-p (&optional file)
18521 "Return non-nil, if FILE is an agenda file.
18522 If FILE is omitted, use the file associated with the current
18523 buffer."
18524 (let ((fname (or file (buffer-file-name))))
18525 (and fname
18526 (member (file-truename fname)
18527 (mapcar #'file-truename (org-agenda-files t))))))
18529 (defun org-edit-agenda-file-list ()
18530 "Edit the list of agenda files.
18531 Depending on setup, this either uses customize to edit the variable
18532 `org-agenda-files', or it visits the file that is holding the list. In the
18533 latter case, the buffer is set up in a way that saving it automatically kills
18534 the buffer and restores the previous window configuration."
18535 (interactive)
18536 (if (stringp org-agenda-files)
18537 (let ((cw (current-window-configuration)))
18538 (find-file org-agenda-files)
18539 (org-set-local 'org-window-configuration cw)
18540 (org-add-hook 'after-save-hook
18541 (lambda ()
18542 (set-window-configuration
18543 (prog1 org-window-configuration
18544 (kill-buffer (current-buffer))))
18545 (org-install-agenda-files-menu)
18546 (message "New agenda file list installed"))
18547 nil 'local)
18548 (message "%s" (substitute-command-keys
18549 "Edit list and finish with \\[save-buffer]")))
18550 (customize-variable 'org-agenda-files)))
18552 (defun org-store-new-agenda-file-list (list)
18553 "Set new value for the agenda file list and save it correctly."
18554 (if (stringp org-agenda-files)
18555 (let ((fe (org-read-agenda-file-list t)) b u)
18556 (while (setq b (find-buffer-visiting org-agenda-files))
18557 (kill-buffer b))
18558 (with-temp-file org-agenda-files
18559 (insert
18560 (mapconcat
18561 (lambda (f) ;; Keep un-expanded entries.
18562 (if (setq u (assoc f fe))
18563 (cdr u)
18565 list "\n")
18566 "\n")))
18567 (let ((org-mode-hook nil) (org-inhibit-startup t)
18568 (org-insert-mode-line-in-empty-file nil))
18569 (setq org-agenda-files list)
18570 (customize-save-variable 'org-agenda-files org-agenda-files))))
18572 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18573 "Read the list of agenda files from a file.
18574 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18575 filenames, used by `org-store-new-agenda-file-list' to write back
18576 un-expanded file names."
18577 (when (file-directory-p org-agenda-files)
18578 (error "`org-agenda-files' cannot be a single directory"))
18579 (when (stringp org-agenda-files)
18580 (with-temp-buffer
18581 (insert-file-contents org-agenda-files)
18582 (mapcar
18583 (lambda (f)
18584 (let ((e (expand-file-name (substitute-in-file-name f)
18585 org-directory)))
18586 (if pair-with-expansion
18587 (cons e f)
18588 e)))
18589 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18591 ;;;###autoload
18592 (defun org-cycle-agenda-files ()
18593 "Cycle through the files in `org-agenda-files'.
18594 If the current buffer visits an agenda file, find the next one in the list.
18595 If the current buffer does not, find the first agenda file."
18596 (interactive)
18597 (let* ((fs (or (org-agenda-files t)
18598 (user-error "No agenda files")))
18599 (files (copy-sequence fs))
18600 (tcf (and buffer-file-name (file-truename buffer-file-name)))
18601 file)
18602 (when tcf
18603 (while (and (setq file (pop files))
18604 (not (equal (file-truename file) tcf)))))
18605 (find-file (car (or files fs)))
18606 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18608 (defun org-agenda-file-to-front (&optional to-end)
18609 "Move/add the current file to the top of the agenda file list.
18610 If the file is not present in the list, it is added to the front. If it is
18611 present, it is moved there. With optional argument TO-END, add/move to the
18612 end of the list."
18613 (interactive "P")
18614 (let ((org-agenda-skip-unavailable-files nil)
18615 (file-alist (mapcar (lambda (x)
18616 (cons (file-truename x) x))
18617 (org-agenda-files t)))
18618 (ctf (file-truename
18619 (or buffer-file-name
18620 (user-error "Please save the current buffer to a file"))))
18621 x had)
18622 (setq x (assoc ctf file-alist) had x)
18624 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18625 (if to-end
18626 (setq file-alist (append (delq x file-alist) (list x)))
18627 (setq file-alist (cons x (delq x file-alist))))
18628 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18629 (org-install-agenda-files-menu)
18630 (message "File %s to %s of agenda file list"
18631 (if had "moved" "added") (if to-end "end" "front"))))
18633 (defun org-remove-file (&optional file)
18634 "Remove current file from the list of files in variable `org-agenda-files'.
18635 These are the files which are being checked for agenda entries.
18636 Optional argument FILE means use this file instead of the current."
18637 (interactive)
18638 (let* ((org-agenda-skip-unavailable-files nil)
18639 (file (or file buffer-file-name
18640 (user-error "Current buffer does not visit a file")))
18641 (true-file (file-truename file))
18642 (afile (abbreviate-file-name file))
18643 (files (delq nil (mapcar
18644 (lambda (x)
18645 (if (equal true-file
18646 (file-truename x))
18647 nil x))
18648 (org-agenda-files t)))))
18649 (if (not (= (length files) (length (org-agenda-files t))))
18650 (progn
18651 (org-store-new-agenda-file-list files)
18652 (org-install-agenda-files-menu)
18653 (message "Removed from Org Agenda list: %s" afile))
18654 (message "File was not in list: %s (not removed)" afile))))
18656 (defun org-file-menu-entry (file)
18657 (vector file (list 'find-file file) t))
18659 (defun org-check-agenda-file (file)
18660 "Make sure FILE exists. If not, ask user what to do."
18661 (when (not (file-exists-p file))
18662 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18663 (abbreviate-file-name file))
18664 (let ((r (downcase (read-char-exclusive))))
18665 (cond
18666 ((equal r ?r)
18667 (org-remove-file file)
18668 (throw 'nextfile t))
18669 (t (user-error "Abort"))))))
18671 (defun org-get-agenda-file-buffer (file)
18672 "Get an agenda buffer visiting FILE.
18673 If the buffer needs to be created, add it to the list of buffers
18674 which might be released later."
18675 (let ((buf (org-find-base-buffer-visiting file)))
18676 (if buf
18677 buf ; just return it
18678 ;; Make a new buffer and remember it
18679 (setq buf (find-file-noselect file))
18680 (if buf (push buf org-agenda-new-buffers))
18681 buf)))
18683 (defun org-release-buffers (blist)
18684 "Release all buffers in list, asking the user for confirmation when needed.
18685 When a buffer is unmodified, it is just killed. When modified, it is saved
18686 \(if the user agrees) and then killed."
18687 (let (file)
18688 (dolist (buf blist)
18689 (setq file (buffer-file-name buf))
18690 (when (and (buffer-modified-p buf)
18691 file
18692 (y-or-n-p (format "Save file %s? " file)))
18693 (with-current-buffer buf (save-buffer)))
18694 (kill-buffer buf))))
18696 (defun org-agenda-prepare-buffers (files)
18697 "Create buffers for all agenda files, protect archived trees and comments."
18698 (interactive)
18699 (let ((pa '(:org-archived t))
18700 (pc '(:org-comment t))
18701 (pall '(:org-archived t :org-comment t))
18702 (inhibit-read-only t)
18703 (org-inhibit-startup org-agenda-inhibit-startup)
18704 (rea (concat ":" org-archive-tag ":"))
18705 file re pos)
18706 (setq org-tag-alist-for-agenda nil
18707 org-tag-groups-alist-for-agenda nil)
18708 (save-excursion
18709 (save-restriction
18710 (dolist (file files)
18711 (catch 'nextfile
18712 (if (bufferp file)
18713 (set-buffer file)
18714 (org-check-agenda-file file)
18715 (set-buffer (org-get-agenda-file-buffer file)))
18716 (widen)
18717 (org-set-regexps-and-options 'tags-only)
18718 (setq pos (point))
18719 (or (memq 'category org-agenda-ignore-properties)
18720 (org-refresh-category-properties))
18721 (or (memq 'stats org-agenda-ignore-properties)
18722 (org-refresh-stats-properties))
18723 (or (memq 'effort org-agenda-ignore-properties)
18724 (org-refresh-effort-properties))
18725 (or (memq 'appt org-agenda-ignore-properties)
18726 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18727 (setq org-todo-keywords-for-agenda
18728 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18729 (setq org-done-keywords-for-agenda
18730 (append org-done-keywords-for-agenda org-done-keywords))
18731 (setq org-todo-keyword-alist-for-agenda
18732 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18733 (setq org-tag-alist-for-agenda
18734 (org-uniquify
18735 (append org-tag-alist-for-agenda
18736 org-tag-alist
18737 org-tag-persistent-alist)))
18738 (if org-group-tags
18739 (setq org-tag-groups-alist-for-agenda
18740 (org-uniquify-alist
18741 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18742 (org-with-silent-modifications
18743 (save-excursion
18744 (remove-text-properties (point-min) (point-max) pall)
18745 (when org-agenda-skip-archived-trees
18746 (goto-char (point-min))
18747 (while (re-search-forward rea nil t)
18748 (if (org-at-heading-p t)
18749 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18750 (goto-char (point-min))
18751 (setq re (format "^\\*+ .*\\<%s\\>" org-comment-string))
18752 (while (re-search-forward re nil t)
18753 (when (save-match-data (org-in-commented-heading-p t))
18754 (add-text-properties
18755 (match-beginning 0) (org-end-of-subtree t) pc)))))
18756 (goto-char pos)))))
18757 (setq org-todo-keywords-for-agenda
18758 (org-uniquify org-todo-keywords-for-agenda))
18759 (setq org-todo-keyword-alist-for-agenda
18760 (org-uniquify org-todo-keyword-alist-for-agenda))))
18763 ;;;; CDLaTeX minor mode
18765 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18766 "Keymap for the minor `org-cdlatex-mode'.")
18768 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18769 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18770 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18771 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18772 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18774 (defvar org-cdlatex-texmathp-advice-is-done nil
18775 "Flag remembering if we have applied the advice to texmathp already.")
18777 (define-minor-mode org-cdlatex-mode
18778 "Toggle the minor `org-cdlatex-mode'.
18779 This mode supports entering LaTeX environment and math in LaTeX fragments
18780 in Org-mode.
18781 \\{org-cdlatex-mode-map}"
18782 nil " OCDL" nil
18783 (when org-cdlatex-mode
18784 (require 'cdlatex)
18785 (run-hooks 'cdlatex-mode-hook)
18786 (cdlatex-compute-tables))
18787 (unless org-cdlatex-texmathp-advice-is-done
18788 (setq org-cdlatex-texmathp-advice-is-done t)
18789 (defadvice texmathp (around org-math-always-on activate)
18790 "Always return t in org-mode buffers.
18791 This is because we want to insert math symbols without dollars even outside
18792 the LaTeX math segments. If Orgmode thinks that point is actually inside
18793 an embedded LaTeX fragment, let texmathp do its job.
18794 \\[org-cdlatex-mode-map]"
18795 (interactive)
18796 (let (p)
18797 (cond
18798 ((not (derived-mode-p 'org-mode)) ad-do-it)
18799 ((eq this-command 'cdlatex-math-symbol)
18800 (setq ad-return-value t
18801 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18803 (let ((p (org-inside-LaTeX-fragment-p)))
18804 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18805 (setq ad-return-value t
18806 texmathp-why '("Org-mode embedded math" . 0))
18807 (if p ad-do-it)))))))))
18809 (defun turn-on-org-cdlatex ()
18810 "Unconditionally turn on `org-cdlatex-mode'."
18811 (org-cdlatex-mode 1))
18813 (defun org-try-cdlatex-tab ()
18814 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18815 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18816 - inside a LaTeX fragment, or
18817 - after the first word in a line, where an abbreviation expansion could
18818 insert a LaTeX environment."
18819 (when org-cdlatex-mode
18820 (cond
18821 ;; Before any word on the line: No expansion possible.
18822 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18823 ;; Just after first word on the line: Expand it. Make sure it
18824 ;; cannot happen on headlines, though.
18825 ((save-excursion
18826 (skip-chars-backward "a-zA-Z0-9*")
18827 (skip-chars-backward " \t")
18828 (and (bolp) (not (org-at-heading-p))))
18829 (cdlatex-tab) t)
18830 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18832 (defun org-cdlatex-underscore-caret (&optional arg)
18833 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18834 Revert to the normal definition outside of these fragments."
18835 (interactive "P")
18836 (if (org-inside-LaTeX-fragment-p)
18837 (call-interactively 'cdlatex-sub-superscript)
18838 (let (org-cdlatex-mode)
18839 (call-interactively (key-binding (vector last-input-event))))))
18841 (defun org-cdlatex-math-modify (&optional arg)
18842 "Execute `cdlatex-math-modify' in LaTeX fragments.
18843 Revert to the normal definition outside of these fragments."
18844 (interactive "P")
18845 (if (org-inside-LaTeX-fragment-p)
18846 (call-interactively 'cdlatex-math-modify)
18847 (let (org-cdlatex-mode)
18848 (call-interactively (key-binding (vector last-input-event))))))
18850 (defun org-cdlatex-environment-indent (&optional environment item)
18851 "Execute `cdlatex-environment' and indent the inserted environment.
18853 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18855 The inserted environment is indented to current indentation
18856 unless point is at the beginning of the line, in which the
18857 environment remains unintended."
18858 (interactive)
18859 ;; cdlatex-environment always return nil. Therefore, capture output
18860 ;; first and determine if an environment was selected.
18861 (let* ((beg (point-marker))
18862 (end (copy-marker (point) t))
18863 (inserted (progn
18864 (ignore-errors (cdlatex-environment environment item))
18865 (< beg end)))
18866 ;; Figure out how many lines to move forward after the
18867 ;; environment has been inserted.
18868 (lines (when inserted
18869 (save-excursion
18870 (- (loop while (< beg (point))
18871 with x = 0
18872 do (forward-line -1)
18873 (incf x)
18874 finally return x)
18875 (if (progn (goto-char beg)
18876 (and (progn (skip-chars-forward " \t") (eolp))
18877 (progn (skip-chars-backward " \t") (bolp))))
18878 1 0)))))
18879 (env (org-trim (delete-and-extract-region beg end))))
18880 (when inserted
18881 ;; Get indentation of next line unless at column 0.
18882 (let ((ind (if (bolp) 0
18883 (save-excursion
18884 (org-return-indent)
18885 (prog1 (org-get-indentation)
18886 (when (progn (skip-chars-forward " \t") (eolp))
18887 (delete-region beg (point)))))))
18888 (bol (progn (skip-chars-backward " \t") (bolp))))
18889 ;; Insert a newline before environment unless at column zero
18890 ;; to "escape" the current line. Insert a newline if
18891 ;; something is one the same line as \end{ENVIRONMENT}.
18892 (insert
18893 (concat (unless bol "\n") env
18894 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18895 (unless (zerop ind)
18896 (save-excursion
18897 (goto-char beg)
18898 (while (< (point) end)
18899 (unless (eolp) (org-indent-line-to ind))
18900 (forward-line))))
18901 (goto-char beg)
18902 (forward-line lines)
18903 (org-indent-line-to ind)))
18904 (set-marker beg nil)
18905 (set-marker end nil)))
18908 ;;;; LaTeX fragments
18910 (defun org-inside-LaTeX-fragment-p ()
18911 "Test if point is inside a LaTeX fragment.
18912 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18913 sequence appearing also before point.
18914 Even though the matchers for math are configurable, this function assumes
18915 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18916 delimiters are skipped when they have been removed by customization.
18917 The return value is nil, or a cons cell with the delimiter and the
18918 position of this delimiter.
18920 This function does a reasonably good job, but can locally be fooled by
18921 for example currency specifications. For example it will assume being in
18922 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18923 fragments that are properly closed, but during editing, we have to live
18924 with the uncertainty caused by missing closing delimiters. This function
18925 looks only before point, not after."
18926 (catch 'exit
18927 (let ((pos (point))
18928 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18929 (lim (progn
18930 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18931 (point)))
18932 dd-on str (start 0) m re)
18933 (goto-char pos)
18934 (when dodollar
18935 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18936 re (nth 1 (assoc "$" org-latex-regexps)))
18937 (while (string-match re str start)
18938 (cond
18939 ((= (match-end 0) (length str))
18940 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18941 ((= (match-end 0) (- (length str) 5))
18942 (throw 'exit nil))
18943 (t (setq start (match-end 0))))))
18944 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18945 (goto-char pos)
18946 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18947 (and (match-beginning 2) (throw 'exit nil))
18948 ;; count $$
18949 (while (re-search-backward "\\$\\$" lim t)
18950 (setq dd-on (not dd-on)))
18951 (goto-char pos)
18952 (if dd-on (cons "$$" m))))))
18954 (defun org-inside-latex-macro-p ()
18955 "Is point inside a LaTeX macro or its arguments?"
18956 (save-match-data
18957 (org-in-regexp
18958 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18960 (defvar org-latex-fragment-image-overlays nil
18961 "List of overlays carrying the images of latex fragments.")
18962 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18964 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18965 "Remove all overlays with LaTeX fragment images in current buffer.
18966 When optional arguments BEG and END are non-nil, remove all
18967 overlays between them instead. Return t when some overlays were
18968 removed, nil otherwise."
18969 (let (removedp)
18970 (setq org-latex-fragment-image-overlays
18971 (let ((beg (or beg (point-min)))
18972 (end (or end (point-max))))
18973 (org-remove-if
18974 (lambda (o)
18975 (cond ((not (overlay-buffer o)) (delete-overlay o) t)
18976 ((and (>= (overlay-start o) beg)
18977 (<= (overlay-end o) end))
18978 (delete-overlay o)
18979 (unless removedp (setq removedp t)))
18980 (t nil)))
18981 org-latex-fragment-image-overlays)))
18982 removedp))
18984 (define-obsolete-function-alias
18985 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18986 (defun org-toggle-latex-fragment (&optional arg)
18987 "Preview the LaTeX fragment at point, or all locally or globally.
18989 If the cursor is on a LaTeX fragment, create the image and overlay
18990 it over the source code, if there is none. Remove it otherwise.
18991 If there is no fragment at point, display all fragments in the
18992 current section.
18994 With prefix ARG, preview or clear image for all fragments in the
18995 current subtree or in the whole buffer when used before the first
18996 headline. With a double prefix ARG \\[universal-argument] \
18997 \\[universal-argument] preview or clear images
18998 for all fragments in the buffer."
18999 (interactive "P")
19000 (unless (buffer-file-name (buffer-base-buffer))
19001 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
19002 (when (display-graphic-p)
19003 (catch 'exit
19004 (save-excursion
19005 (let ((window-start (window-start)) msg)
19006 (save-restriction
19007 (cond
19008 ((or (equal arg '(16))
19009 (and (equal arg '(4))
19010 (org-with-limited-levels (org-before-first-heading-p))))
19011 (if (org-remove-latex-fragment-image-overlays)
19012 (progn (message "LaTeX fragments images removed from buffer")
19013 (throw 'exit nil))
19014 (setq msg "Creating images for buffer...")))
19015 ((equal arg '(4))
19016 (org-with-limited-levels (org-back-to-heading t))
19017 (let ((beg (point))
19018 (end (progn (org-end-of-subtree t) (point))))
19019 (if (org-remove-latex-fragment-image-overlays beg end)
19020 (progn
19021 (message "LaTeX fragment images removed from subtree")
19022 (throw 'exit nil))
19023 (setq msg "Creating images for subtree...")
19024 (narrow-to-region beg end))))
19025 ((let ((datum (org-element-context)))
19026 (when (memq (org-element-type datum)
19027 '(latex-environment latex-fragment))
19028 (let* ((beg (org-element-property :begin datum))
19029 (end (org-element-property :end datum)))
19030 (if (org-remove-latex-fragment-image-overlays beg end)
19031 (progn (message "LaTeX fragment image removed")
19032 (throw 'exit nil))
19033 (narrow-to-region beg end)
19034 (setq msg "Creating image..."))))))
19036 (org-with-limited-levels
19037 (let ((beg (if (org-at-heading-p) (line-beginning-position)
19038 (outline-previous-heading)
19039 (point)))
19040 (end (progn (outline-next-heading) (point))))
19041 (if (org-remove-latex-fragment-image-overlays beg end)
19042 (progn
19043 (message "LaTeX fragment images removed from section")
19044 (throw 'exit nil))
19045 (setq msg "Creating images for section...")
19046 (narrow-to-region beg end))))))
19047 (let ((file (buffer-file-name (buffer-base-buffer))))
19048 (org-format-latex
19049 (concat org-latex-preview-ltxpng-directory
19050 (file-name-sans-extension (file-name-nondirectory file)))
19051 ;; Emacs cannot overlay images from remote hosts.
19052 ;; Create it in `temporary-file-directory' instead.
19053 (if (file-remote-p file) temporary-file-directory
19054 default-directory)
19055 'overlays msg 'forbuffer
19056 org-latex-create-formula-image-program)))
19057 ;; Work around a bug that doesn't restore window's start
19058 ;; when widening back the buffer.
19059 (set-window-start nil window-start)
19060 (message (concat msg "done")))))))
19062 (defun org-format-latex
19063 (prefix &optional dir overlays msg forbuffer processing-type)
19064 "Replace LaTeX fragments with links to an image, and produce images.
19066 When optional argument OVERLAYS is non-nil, display the image on
19067 top of the fragment instead of replacing it.
19069 PROCESSING-TYPE is the conversion method to use, as a symbol.
19071 Some of the options can be changed using the variable
19072 `org-format-latex-options', which see."
19073 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19074 (unless (eq processing-type 'verbatim)
19075 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19076 (cnt 0)
19077 checkdir-flag)
19078 (goto-char (point-min))
19079 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19080 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19081 (overlay-recenter (point-max)))
19082 (while (re-search-forward math-regexp nil t)
19083 (unless (and overlays
19084 (eq (get-char-property (point) 'org-overlay-type)
19085 'org-latex-overlay))
19086 (let* ((context (org-element-context))
19087 (type (org-element-type context)))
19088 (when (memq type '(latex-environment latex-fragment))
19089 (let ((block-type (eq type 'latex-environment))
19090 (value (org-element-property :value context))
19091 (beg (org-element-property :begin context))
19092 (end (save-excursion
19093 (goto-char (org-element-property :end context))
19094 (skip-chars-backward " \r\t\n")
19095 (point))))
19096 (case processing-type
19097 (mathjax
19098 ;; Prepare for MathJax processing.
19099 (if (eq (char-after beg) ?$)
19100 (save-excursion
19101 (delete-region beg end)
19102 (insert "\\(" (substring value 1 -1) "\\)"))
19103 (goto-char end)))
19104 ((dvipng imagemagick)
19105 ;; Process to an image.
19106 (incf cnt)
19107 (goto-char beg)
19108 (let* ((face (face-at-point))
19109 ;; Get the colors from the face at point.
19111 (let ((color (plist-get org-format-latex-options
19112 :foreground)))
19113 (if (and forbuffer (eq color 'auto))
19114 (face-attribute face :foreground nil 'default)
19115 color)))
19117 (let ((color (plist-get org-format-latex-options
19118 :background)))
19119 (if (and forbuffer (eq color 'auto))
19120 (face-attribute face :background nil 'default)
19121 color)))
19122 (hash (sha1 (prin1-to-string
19123 (list org-format-latex-header
19124 org-latex-default-packages-alist
19125 org-latex-packages-alist
19126 org-format-latex-options
19127 forbuffer value fg bg))))
19128 (absprefix (expand-file-name prefix dir))
19129 (linkfile (format "%s_%s.png" prefix hash))
19130 (movefile (format "%s_%s.png" absprefix hash))
19131 (sep (and block-type "\n\n"))
19132 (link (concat sep "[[file:" linkfile "]]" sep))
19133 (options
19134 (org-combine-plists
19135 org-format-latex-options
19136 `(:foreground ,fg :background ,bg))))
19137 (when msg (message msg cnt))
19138 (unless checkdir-flag ; Ensure the directory exists.
19139 (setq checkdir-flag t)
19140 (let ((todir (file-name-directory absprefix)))
19141 (unless (file-directory-p todir)
19142 (make-directory todir t))))
19143 (unless (file-exists-p movefile)
19144 (org-create-formula-image
19145 value movefile options forbuffer processing-type))
19146 (if overlays
19147 (progn
19148 (dolist (o (overlays-in beg end))
19149 (when (eq (overlay-get o 'org-overlay-type)
19150 'org-latex-overlay)
19151 (delete-overlay o)))
19152 (let ((ov (make-overlay beg end)))
19153 (overlay-put ov
19154 'org-overlay-type
19155 'org-latex-overlay)
19156 (overlay-put ov 'evaporate t)
19157 (if (featurep 'xemacs)
19158 (progn
19159 (overlay-put ov 'invisible t)
19160 (overlay-put
19161 ov 'end-glyph
19162 (make-glyph
19163 (vector 'png :file movefile))))
19164 (overlay-put
19165 ov 'display
19166 (list 'image
19167 :type 'png
19168 :file movefile
19169 :ascent 'center)))
19170 (push ov org-latex-fragment-image-overlays))
19171 (goto-char end))
19172 (delete-region beg end)
19173 (insert
19174 (org-add-props link
19175 (list 'org-latex-src
19176 (replace-regexp-in-string "\"" "" value)
19177 'org-latex-src-embed-type
19178 (if block-type 'paragraph 'character)))))))
19179 (mathml
19180 ;; Process to MathML.
19181 (unless (org-format-latex-mathml-available-p)
19182 (user-error "LaTeX to MathML converter not configured"))
19183 (incf cnt)
19184 (when msg (message msg cnt))
19185 (goto-char beg)
19186 (delete-region beg end)
19187 (insert (org-format-latex-as-mathml
19188 value block-type prefix dir)))
19189 (otherwise
19190 (error "Unknown conversion type %s for LaTeX fragments"
19191 processing-type)))))))))))
19193 (defun org-create-math-formula (latex-frag &optional mathml-file)
19194 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19195 Use `org-latex-to-mathml-convert-command'. If the conversion is
19196 sucessful, return the portion between \"<math...> </math>\"
19197 elements otherwise return nil. When MATHML-FILE is specified,
19198 write the results in to that file. When invoked as an
19199 interactive command, prompt for LATEX-FRAG, with initial value
19200 set to the current active region and echo the results for user
19201 inspection."
19202 (interactive (list (let ((frag (when (org-region-active-p)
19203 (buffer-substring-no-properties
19204 (region-beginning) (region-end)))))
19205 (read-string "LaTeX Fragment: " frag nil frag))))
19206 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19207 (let* ((tmp-in-file (file-relative-name
19208 (make-temp-name (expand-file-name "ltxmathml-in"))))
19209 (ignore (write-region latex-frag nil tmp-in-file))
19210 (tmp-out-file (file-relative-name
19211 (make-temp-name (expand-file-name "ltxmathml-out"))))
19212 (cmd (format-spec
19213 org-latex-to-mathml-convert-command
19214 `((?j . ,(and org-latex-to-mathml-jar-file
19215 (shell-quote-argument
19216 (expand-file-name
19217 org-latex-to-mathml-jar-file))))
19218 (?I . ,(shell-quote-argument tmp-in-file))
19219 (?i . ,latex-frag)
19220 (?o . ,(shell-quote-argument tmp-out-file)))))
19221 mathml shell-command-output)
19222 (when (org-called-interactively-p 'any)
19223 (unless (org-format-latex-mathml-available-p)
19224 (user-error "LaTeX to MathML converter not configured")))
19225 (message "Running %s" cmd)
19226 (setq shell-command-output (shell-command-to-string cmd))
19227 (setq mathml
19228 (when (file-readable-p tmp-out-file)
19229 (with-current-buffer (find-file-noselect tmp-out-file t)
19230 (goto-char (point-min))
19231 (when (re-search-forward
19232 (concat
19233 (regexp-quote
19234 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19235 "[^>]*?>"
19236 "\\(.\\|\n\\)*"
19237 "</math>")
19238 nil t)
19239 (prog1 (match-string 0) (kill-buffer))))))
19240 (cond
19241 (mathml
19242 (setq mathml
19243 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19244 (when mathml-file
19245 (write-region mathml nil mathml-file))
19246 (when (org-called-interactively-p 'any)
19247 (message mathml)))
19248 ((message "LaTeX to MathML conversion failed")
19249 (message shell-command-output)))
19250 (delete-file tmp-in-file)
19251 (when (file-exists-p tmp-out-file)
19252 (delete-file tmp-out-file))
19253 mathml))
19255 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19256 prefix &optional dir)
19257 "Use `org-create-math-formula' but check local cache first."
19258 (let* ((absprefix (expand-file-name prefix dir))
19259 (print-length nil) (print-level nil)
19260 (formula-id (concat
19261 "formula-"
19262 (sha1
19263 (prin1-to-string
19264 (list latex-frag
19265 org-latex-to-mathml-convert-command)))))
19266 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19267 (formula-cache-dir (file-name-directory formula-cache)))
19269 (unless (file-directory-p formula-cache-dir)
19270 (make-directory formula-cache-dir t))
19272 (unless (file-exists-p formula-cache)
19273 (org-create-math-formula latex-frag formula-cache))
19275 (if (file-exists-p formula-cache)
19276 ;; Successful conversion. Return the link to MathML file.
19277 (org-add-props
19278 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19279 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19280 'org-latex-src-embed-type (if latex-frag-type
19281 'paragraph 'character)))
19282 ;; Failed conversion. Return the LaTeX fragment verbatim
19283 latex-frag)))
19285 (defun org-create-formula-image (string tofile options buffer &optional type)
19286 "Create an image from LaTeX source using dvipng or convert.
19287 This function calls either `org-create-formula-image-with-dvipng'
19288 or `org-create-formula-image-with-imagemagick' depending on the
19289 value of `org-latex-create-formula-image-program' or on the value
19290 of the optional TYPE variable.
19292 Note: ultimately these two function should be combined as they
19293 share a good deal of logic."
19294 (org-check-external-command
19295 "latex" "needed to convert LaTeX fragments to images")
19296 (funcall
19297 (case (or type org-latex-create-formula-image-program)
19298 (dvipng
19299 (org-check-external-command
19300 "dvipng" "needed to convert LaTeX fragments to images")
19301 #'org-create-formula-image-with-dvipng)
19302 (imagemagick
19303 (org-check-external-command
19304 "convert" "you need to install imagemagick")
19305 #'org-create-formula-image-with-imagemagick)
19306 (t (error
19307 "Invalid value of `org-latex-create-formula-image-program'")))
19308 string tofile options buffer))
19310 (declare-function org-export-get-backend "ox" (name))
19311 (declare-function org-export--get-global-options "ox" (&optional backend))
19312 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19313 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19314 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19315 (defun org-create-formula--latex-header ()
19316 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19317 (let ((info (org-combine-plists (org-export--get-global-options
19318 (org-export-get-backend 'latex))
19319 (org-export--get-inbuffer-options
19320 (org-export-get-backend 'latex)))))
19321 (org-latex-guess-babel-language
19322 (org-latex-guess-inputenc
19323 (org-splice-latex-header
19324 org-format-latex-header
19325 org-latex-default-packages-alist
19326 org-latex-packages-alist t
19327 (plist-get info :latex-header)))
19328 info)))
19330 (defun org--get-display-dpi ()
19331 "Get the DPI of the display.
19333 Assumes that the display has the same pixel width in the
19334 horizontal and vertical directions."
19335 (if (display-graphic-p)
19336 (round (/ (display-pixel-height)
19337 (/ (display-mm-height) 25.4)))
19338 (error "Attempt to calculate the dpi of a non-graphic display")))
19340 ;; This function borrows from Ganesh Swami's latex2png.el
19341 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19342 "This calls dvipng."
19343 (require 'ox-latex)
19344 (let* ((tmpdir (if (featurep 'xemacs)
19345 (temp-directory)
19346 temporary-file-directory))
19347 (texfilebase (make-temp-name
19348 (expand-file-name "orgtex" tmpdir)))
19349 (texfile (concat texfilebase ".tex"))
19350 (dvifile (concat texfilebase ".dvi"))
19351 (pngfile (concat texfilebase ".png"))
19352 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19353 ;; This assumes that the display has the same pixel width in
19354 ;; the horizontal and vertical directions
19355 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19356 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19357 "Black"))
19358 (bg (or (plist-get options (if buffer :background :html-background))
19359 "Transparent")))
19360 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19361 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19362 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19363 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19364 (let ((latex-header (org-create-formula--latex-header)))
19365 (with-temp-file texfile
19366 (insert latex-header)
19367 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19368 (let ((dir default-directory))
19369 (ignore-errors
19370 (cd tmpdir)
19371 (call-process "latex" nil nil nil texfile))
19372 (cd dir))
19373 (if (not (file-exists-p dvifile))
19374 (progn (message "Failed to create dvi file from %s" texfile) nil)
19375 (ignore-errors
19376 (if (featurep 'xemacs)
19377 (call-process "dvipng" nil nil nil
19378 "-fg" fg "-bg" bg
19379 "-T" "tight"
19380 "-o" pngfile
19381 dvifile)
19382 (call-process "dvipng" nil nil nil
19383 "-fg" fg "-bg" bg
19384 "-D" dpi
19385 ;;"-x" scale "-y" scale
19386 "-T" "tight"
19387 "-o" pngfile
19388 dvifile)))
19389 (if (not (file-exists-p pngfile))
19390 (if org-format-latex-signal-error
19391 (error "Failed to create png file from %s" texfile)
19392 (message "Failed to create png file from %s" texfile)
19393 nil)
19394 ;; Use the requested file name and clean up
19395 (copy-file pngfile tofile 'replace)
19396 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19397 (if (file-exists-p (concat texfilebase e))
19398 (delete-file (concat texfilebase e))))
19399 pngfile))))
19401 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19402 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19403 "This calls convert, which is included into imagemagick."
19404 (require 'ox-latex)
19405 (let* ((tmpdir (if (featurep 'xemacs)
19406 (temp-directory)
19407 temporary-file-directory))
19408 (texfilebase (make-temp-name
19409 (expand-file-name "orgtex" tmpdir)))
19410 (texfile (concat texfilebase ".tex"))
19411 (pdffile (concat texfilebase ".pdf"))
19412 (pngfile (concat texfilebase ".png"))
19413 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19414 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19415 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19416 "black"))
19417 (bg (or (plist-get options (if buffer :background :html-background))
19418 "white")))
19419 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19420 (setq fg (org-latex-color-format fg)))
19421 (if (eq bg 'default) (setq bg (org-latex-color :background))
19422 (setq bg (org-latex-color-format
19423 (if (string= bg "Transparent") "white" bg))))
19424 (let ((latex-header (org-create-formula--latex-header)))
19425 (with-temp-file texfile
19426 (insert latex-header)
19427 (insert "\n\\begin{document}\n"
19428 "\\definecolor{fg}{rgb}{" fg "}\n"
19429 "\\definecolor{bg}{rgb}{" bg "}\n"
19430 "\n\\pagecolor{bg}\n"
19431 "\n{\\color{fg}\n"
19432 string
19433 "\n}\n"
19434 "\n\\end{document}\n")))
19435 (org-latex-compile texfile t)
19436 (if (not (file-exists-p pdffile))
19437 (progn (message "Failed to create pdf file from %s" texfile) nil)
19438 (ignore-errors
19439 (if (featurep 'xemacs)
19440 (call-process "convert" nil nil nil
19441 "-density" "96"
19442 "-trim"
19443 "-antialias"
19444 pdffile
19445 "-quality" "100"
19446 ;; "-sharpen" "0x1.0"
19447 pngfile)
19448 (call-process "convert" nil nil nil
19449 "-density" dpi
19450 "-trim"
19451 "-antialias"
19452 pdffile
19453 "-quality" "100"
19454 ;; "-sharpen" "0x1.0"
19455 pngfile)))
19456 (if (not (file-exists-p pngfile))
19457 (if org-format-latex-signal-error
19458 (error "Failed to create png file from %s" texfile)
19459 (message "Failed to create png file from %s" texfile)
19460 nil)
19461 ;; Use the requested file name and clean up
19462 (copy-file pngfile tofile 'replace)
19463 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19464 (if (file-exists-p (concat texfilebase e))
19465 (delete-file (concat texfilebase e))))
19466 pngfile))))
19468 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19469 "Fill a LaTeX header template TPL.
19470 In the template, the following place holders will be recognized:
19472 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19473 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19474 [PACKAGES] \\usepackage statements for PKG
19475 [NO-PACKAGES] do not include PKG
19476 [EXTRA] the string EXTRA
19477 [NO-EXTRA] do not include EXTRA
19479 For backward compatibility, if both the positive and the negative place
19480 holder is missing, the positive one (without the \"NO-\") will be
19481 assumed to be present at the end of the template.
19482 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19483 EXTRA is a string.
19484 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19485 (let (rpl (end ""))
19486 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19487 (setq rpl (if (or (match-end 1) (not def-pkg))
19488 "" (org-latex-packages-to-string def-pkg snippets-p t))
19489 tpl (replace-match rpl t t tpl))
19490 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19492 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19493 (setq rpl (if (or (match-end 1) (not pkg))
19494 "" (org-latex-packages-to-string pkg snippets-p t))
19495 tpl (replace-match rpl t t tpl))
19496 (if pkg (setq end
19497 (concat end "\n"
19498 (org-latex-packages-to-string pkg snippets-p)))))
19500 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19501 (setq rpl (if (or (match-end 1) (not extra))
19502 "" (concat extra "\n"))
19503 tpl (replace-match rpl t t tpl))
19504 (if (and extra (string-match "\\S-" extra))
19505 (setq end (concat end "\n" extra))))
19507 (if (string-match "\\S-" end)
19508 (concat tpl "\n" end)
19509 tpl)))
19511 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19512 "Turn an alist of packages into a string with the \\usepackage macros."
19513 (setq pkg (mapconcat (lambda(p)
19514 (cond
19515 ((stringp p) p)
19516 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19517 (format "%% Package %s omitted" (cadr p)))
19518 ((equal "" (car p))
19519 (format "\\usepackage{%s}" (cadr p)))
19521 (format "\\usepackage[%s]{%s}"
19522 (car p) (cadr p)))))
19524 "\n"))
19525 (if newline (concat pkg "\n") pkg))
19527 (defun org-dvipng-color (attr)
19528 "Return a RGB color specification for dvipng."
19529 (apply 'format "rgb %s %s %s"
19530 (mapcar 'org-normalize-color
19531 (if (featurep 'xemacs)
19532 (color-rgb-components
19533 (face-property 'default
19534 (cond ((eq attr :foreground) 'foreground)
19535 ((eq attr :background) 'background))))
19536 (color-values (face-attribute 'default attr nil))))))
19538 (defun org-dvipng-color-format (color-name)
19539 "Convert COLOR-NAME to a RGB color value for dvipng."
19540 (apply 'format "rgb %s %s %s"
19541 (mapcar 'org-normalize-color
19542 (color-values color-name))))
19544 (defun org-latex-color (attr)
19545 "Return a RGB color for the LaTeX color package."
19546 (apply 'format "%s,%s,%s"
19547 (mapcar 'org-normalize-color
19548 (if (featurep 'xemacs)
19549 (color-rgb-components
19550 (face-property 'default
19551 (cond ((eq attr :foreground) 'foreground)
19552 ((eq attr :background) 'background))))
19553 (color-values (face-attribute 'default attr nil))))))
19555 (defun org-latex-color-format (color-name)
19556 "Convert COLOR-NAME to a RGB color value."
19557 (apply 'format "%s,%s,%s"
19558 (mapcar 'org-normalize-color
19559 (color-values color-name))))
19561 (defun org-normalize-color (value)
19562 "Return string to be used as color value for an RGB component."
19563 (format "%g" (/ value 65535.0)))
19567 ;; Image display
19569 (defvar org-inline-image-overlays nil)
19570 (make-variable-buffer-local 'org-inline-image-overlays)
19572 (defun org-toggle-inline-images (&optional include-linked)
19573 "Toggle the display of inline images.
19574 INCLUDE-LINKED is passed to `org-display-inline-images'."
19575 (interactive "P")
19576 (if org-inline-image-overlays
19577 (progn
19578 (org-remove-inline-images)
19579 (when (org-called-interactively-p 'interactive)
19580 (message "Inline image display turned off")))
19581 (org-display-inline-images include-linked)
19582 (when (org-called-interactively-p 'interactive)
19583 (message (if org-inline-image-overlays
19584 (format "%d images displayed inline"
19585 (length org-inline-image-overlays))
19586 "No images to display inline")))))
19588 (defun org-redisplay-inline-images ()
19589 "Refresh the display of inline images."
19590 (interactive)
19591 (if (not org-inline-image-overlays)
19592 (org-toggle-inline-images)
19593 (org-toggle-inline-images)
19594 (org-toggle-inline-images)))
19596 (defun org-display-inline-images (&optional include-linked refresh beg end)
19597 "Display inline images.
19599 An inline image is a link which follows either of these
19600 conventions:
19602 1. Its path is a file with an extension matching return value
19603 from `image-file-name-regexp' and it has no contents.
19605 2. Its description consists in a single link of the previous
19606 type.
19608 When optional argument INCLUDE-LINKED is non-nil, also links with
19609 a text description part will be inlined. This can be nice for
19610 a quick look at those images, but it does not reflect what
19611 exported files will look like.
19613 When optional argument REFRESH is non-nil, refresh existing
19614 images between BEG and END. This will create new image displays
19615 only if necessary. BEG and END default to the buffer
19616 boundaries."
19617 (interactive "P")
19618 (when (display-graphic-p)
19619 (unless refresh
19620 (org-remove-inline-images)
19621 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19622 (org-with-wide-buffer
19623 (goto-char (or beg (point-min)))
19624 (let ((case-fold-search t)
19625 (file-extension-re (org-image-file-name-regexp)))
19626 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19627 (let ((link (save-match-data (org-element-context))))
19628 ;; Check if we're at an inline image.
19629 (when (and (equal (org-element-property :type link) "file")
19630 (or include-linked
19631 (not (org-element-property :contents-begin link)))
19632 (let ((parent (org-element-property :parent link)))
19633 (or (not (eq (org-element-type parent) 'link))
19634 (not (cdr (org-element-contents parent)))))
19635 (org-string-match-p file-extension-re
19636 (org-element-property :path link)))
19637 (let ((file (expand-file-name
19638 (org-link-unescape
19639 (org-element-property :path link)))))
19640 (when (file-exists-p file)
19641 (let ((width
19642 ;; Apply `org-image-actual-width' specifications.
19643 (cond
19644 ((not (image-type-available-p 'imagemagick)) nil)
19645 ((eq org-image-actual-width t) nil)
19646 ((listp org-image-actual-width)
19648 ;; First try to find a width among
19649 ;; attributes associated to the paragraph
19650 ;; containing link.
19651 (let ((paragraph
19652 (let ((e link))
19653 (while (and (setq e (org-element-property
19654 :parent e))
19655 (not (eq (org-element-type e)
19656 'paragraph))))
19657 e)))
19658 (when paragraph
19659 (save-excursion
19660 (goto-char (org-element-property :begin paragraph))
19661 (when
19662 (re-search-forward
19663 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19664 (org-element-property
19665 :post-affiliated paragraph)
19667 (string-to-number (match-string 1))))))
19668 ;; Otherwise, fall-back to provided number.
19669 (car org-image-actual-width)))
19670 ((numberp org-image-actual-width)
19671 org-image-actual-width)))
19672 (old (get-char-property-and-overlay
19673 (org-element-property :begin link)
19674 'org-image-overlay)))
19675 (if (and (car-safe old) refresh)
19676 (image-refresh (overlay-get (cdr old) 'display))
19677 (let ((image (create-image file
19678 (and width 'imagemagick)
19680 :width width)))
19681 (when image
19682 (let* ((link
19683 ;; If inline image is the description
19684 ;; of another link, be sure to
19685 ;; consider the latter as the one to
19686 ;; apply the overlay on.
19687 (let ((parent
19688 (org-element-property :parent link)))
19689 (if (eq (org-element-type parent) 'link)
19690 parent
19691 link)))
19692 (ov (make-overlay
19693 (org-element-property :begin link)
19694 (progn
19695 (goto-char
19696 (org-element-property :end link))
19697 (skip-chars-backward " \t")
19698 (point)))))
19699 (overlay-put ov 'display image)
19700 (overlay-put ov 'face 'default)
19701 (overlay-put ov 'org-image-overlay t)
19702 (overlay-put
19703 ov 'modification-hooks
19704 (list 'org-display-inline-remove-overlay))
19705 (push ov org-inline-image-overlays)))))))))))))))
19707 (define-obsolete-function-alias
19708 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19710 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19711 "Remove inline-display overlay if a corresponding region is modified."
19712 (let ((inhibit-modification-hooks t))
19713 (when (and ov after)
19714 (delete ov org-inline-image-overlays)
19715 (delete-overlay ov))))
19717 (defun org-remove-inline-images ()
19718 "Remove inline display of images."
19719 (interactive)
19720 (mapc 'delete-overlay org-inline-image-overlays)
19721 (setq org-inline-image-overlays nil))
19723 ;;;; Key bindings
19725 ;; Outline functions from `outline-mode-prefix-map'
19726 ;; that can be remapped in Org:
19727 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19728 (define-key org-mode-map [remap outline-show-subtree] 'org-show-subtree)
19729 (define-key org-mode-map [remap outline-forward-same-level]
19730 'org-forward-heading-same-level)
19731 (define-key org-mode-map [remap outline-backward-same-level]
19732 'org-backward-heading-same-level)
19733 (define-key org-mode-map [remap outline-show-branches]
19734 'org-kill-note-or-show-branches)
19735 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19736 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19737 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19738 (define-key org-mode-map [remap outline-next-visible-heading]
19739 'org-next-visible-heading)
19740 (define-key org-mode-map [remap outline-previous-visible-heading]
19741 'org-previous-visible-heading)
19743 ;; Outline functions from `outline-mode-prefix-map' that can not
19744 ;; be remapped in Org:
19746 ;; - the column "key binding" shows whether the Outline function is still
19747 ;; available in Org mode on the same key that it has been bound to in
19748 ;; Outline mode:
19749 ;; - "overridden": key used for a different functionality in Org mode
19750 ;; - else: key still bound to the same Outline function in Org mode
19752 ;; | Outline function | key binding | Org replacement |
19753 ;; |------------------------------------+-------------+--------------------------|
19754 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19755 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19756 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19757 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19758 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19759 ;; | `show-entry' | overridden | no replacement |
19760 ;; | `show-children' | `C-c C-i' | visibility cycling |
19761 ;; | `show-branches' | `C-c C-k' | still same function |
19762 ;; | `show-subtree' | overridden | visibility cycling |
19763 ;; | `show-all' | overridden | no replacement |
19764 ;; | `hide-subtree' | overridden | visibility cycling |
19765 ;; | `hide-body' | overridden | no replacement |
19766 ;; | `hide-entry' | overridden | visibility cycling |
19767 ;; | `hide-leaves' | overridden | no replacement |
19768 ;; | `hide-sublevels' | overridden | no replacement |
19769 ;; | `hide-other' | overridden | no replacement |
19771 ;; Make `C-c C-x' a prefix key
19772 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19774 ;; TAB key with modifiers
19775 (org-defkey org-mode-map "\C-i" 'org-cycle)
19776 (org-defkey org-mode-map [(tab)] 'org-cycle)
19777 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19778 (org-defkey org-mode-map "\M-\t" #'pcomplete)
19779 ;; The following line is necessary under Suse GNU/Linux
19780 (unless (featurep 'xemacs)
19781 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19782 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19783 (define-key org-mode-map [backtab] 'org-shifttab)
19785 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19786 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19787 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19789 ;; Cursor keys with modifiers
19790 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19791 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19792 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19793 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19795 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19796 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19797 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19798 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19799 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19800 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19802 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19803 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19804 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19805 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19807 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19808 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19809 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19810 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19812 ;; Babel keys
19813 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19814 (mapc (lambda (pair)
19815 (define-key org-babel-map (car pair) (cdr pair)))
19816 org-babel-key-bindings)
19818 ;;; Extra keys for tty access.
19819 ;; We only set them when really needed because otherwise the
19820 ;; menus don't show the simple keys
19822 (when (or org-use-extra-keys
19823 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19824 (not window-system))
19825 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19826 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19827 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19828 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19829 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19830 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19831 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19832 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19833 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19834 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19835 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19836 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19837 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19838 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19839 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19840 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19841 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19842 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19843 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19844 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19845 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19846 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19847 (org-defkey org-mode-map [?\e (tab)] #'pcomplete)
19848 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19849 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19850 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19851 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19852 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19854 ;; All the other keys
19856 (org-defkey org-mode-map "\C-c\C-a" 'outline-show-all) ; in case allout messed up.
19857 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19858 (if (boundp 'narrow-map)
19859 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19860 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19861 (if (boundp 'narrow-map)
19862 (org-defkey narrow-map "b" 'org-narrow-to-block)
19863 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19864 (if (boundp 'narrow-map)
19865 (org-defkey narrow-map "e" 'org-narrow-to-element)
19866 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19867 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19868 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19869 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19870 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19871 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19872 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19873 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19874 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19875 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19876 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19877 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree)
19878 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19879 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19880 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19881 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19882 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19883 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19884 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19885 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19886 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19887 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19888 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19889 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19890 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19891 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19892 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19893 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19894 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19895 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19896 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19897 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19898 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19899 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19900 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19901 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19902 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19903 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19904 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19905 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19906 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19907 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19908 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19909 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19910 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19911 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19912 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19913 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19914 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19915 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19916 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19917 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19918 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19919 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19920 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19921 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19922 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19923 (org-defkey org-mode-map "\C-c^" 'org-sort)
19924 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19925 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19926 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19927 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19928 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19929 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19930 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19931 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19932 (org-defkey org-mode-map "\C-m" 'org-return)
19933 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19934 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19935 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19936 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19937 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19938 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19939 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19940 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19941 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19942 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19943 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19944 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19945 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19946 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19947 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19948 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19949 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19950 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19951 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19952 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19953 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19954 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19955 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19956 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19957 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19959 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19960 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19961 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19963 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19964 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19965 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19966 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19967 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19968 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19969 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19970 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19971 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19972 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19973 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19974 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19975 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19976 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19977 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19978 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19979 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19980 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19981 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19982 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19983 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19984 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19986 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19987 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19988 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19989 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19990 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19992 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19994 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19996 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19997 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19999 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
20002 (when (featurep 'xemacs)
20003 (org-defkey org-mode-map 'button3 'popup-mode-menu))
20006 (defconst org-speed-commands-default
20008 ("Outline Navigation")
20009 ("n" . (org-speed-move-safe 'org-next-visible-heading))
20010 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
20011 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
20012 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
20013 ("F" . org-next-block)
20014 ("B" . org-previous-block)
20015 ("u" . (org-speed-move-safe 'outline-up-heading))
20016 ("j" . org-goto)
20017 ("g" . (org-refile t))
20018 ("Outline Visibility")
20019 ("c" . org-cycle)
20020 ("C" . org-shifttab)
20021 (" " . org-display-outline-path)
20022 ("s" . org-narrow-to-subtree)
20023 ("=" . org-columns)
20024 ("Outline Structure Editing")
20025 ("U" . org-metaup)
20026 ("D" . org-metadown)
20027 ("r" . org-metaright)
20028 ("l" . org-metaleft)
20029 ("R" . org-shiftmetaright)
20030 ("L" . org-shiftmetaleft)
20031 ("i" . (progn (forward-char 1) (call-interactively
20032 'org-insert-heading-respect-content)))
20033 ("^" . org-sort)
20034 ("w" . org-refile)
20035 ("a" . org-archive-subtree-default-with-confirmation)
20036 ("@" . org-mark-subtree)
20037 ("#" . org-toggle-comment)
20038 ("Clock Commands")
20039 ("I" . org-clock-in)
20040 ("O" . org-clock-out)
20041 ("Meta Data Editing")
20042 ("t" . org-todo)
20043 ("," . (org-priority))
20044 ("0" . (org-priority ?\ ))
20045 ("1" . (org-priority ?A))
20046 ("2" . (org-priority ?B))
20047 ("3" . (org-priority ?C))
20048 (":" . org-set-tags-command)
20049 ("e" . org-set-effort)
20050 ("E" . org-inc-effort)
20051 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
20052 (org-entry-put (point) "APPT_WARNTIME" m)))
20053 ("Agenda Views etc")
20054 ("v" . org-agenda)
20055 ("/" . org-sparse-tree)
20056 ("Misc")
20057 ("o" . org-open-at-point)
20058 ("?" . org-speed-command-help)
20059 ("<" . (org-agenda-set-restriction-lock 'subtree))
20060 (">" . (org-agenda-remove-restriction-lock))
20062 "The default speed commands.")
20064 (defun org-print-speed-command (e)
20065 (if (> (length (car e)) 1)
20066 (progn
20067 (princ "\n")
20068 (princ (car e))
20069 (princ "\n")
20070 (princ (make-string (length (car e)) ?-))
20071 (princ "\n"))
20072 (princ (car e))
20073 (princ " ")
20074 (if (symbolp (cdr e))
20075 (princ (symbol-name (cdr e)))
20076 (prin1 (cdr e)))
20077 (princ "\n")))
20079 (defun org-speed-command-help ()
20080 "Show the available speed commands."
20081 (interactive)
20082 (if (not org-use-speed-commands)
20083 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20084 (with-output-to-temp-buffer "*Help*"
20085 (princ "User-defined Speed commands\n===========================\n")
20086 (mapc 'org-print-speed-command org-speed-commands-user)
20087 (princ "\n")
20088 (princ "Built-in Speed commands\n=======================\n")
20089 (mapc 'org-print-speed-command org-speed-commands-default))
20090 (with-current-buffer "*Help*"
20091 (setq truncate-lines t))))
20093 (defun org-speed-move-safe (cmd)
20094 "Execute CMD, but make sure that the cursor always ends up in a headline.
20095 If not, return to the original position and throw an error."
20096 (interactive)
20097 (let ((pos (point)))
20098 (call-interactively cmd)
20099 (unless (and (bolp) (org-at-heading-p))
20100 (goto-char pos)
20101 (error "Boundary reached while executing %s" cmd))))
20103 (defvar org-self-insert-command-undo-counter 0)
20105 (defvar org-table-auto-blank-field) ; defined in org-table.el
20106 (defvar org-speed-command nil)
20108 (define-obsolete-function-alias
20109 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20111 (defun org-speed-command-activate (keys)
20112 "Hook for activating single-letter speed commands.
20113 `org-speed-commands-default' specifies a minimal command set.
20114 Use `org-speed-commands-user' for further customization."
20115 (when (or (and (bolp) (looking-at org-outline-regexp))
20116 (and (functionp org-use-speed-commands)
20117 (funcall org-use-speed-commands)))
20118 (cdr (assoc keys (append org-speed-commands-user
20119 org-speed-commands-default)))))
20121 (define-obsolete-function-alias
20122 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20124 (defun org-babel-speed-command-activate (keys)
20125 "Hook for activating single-letter code block commands."
20126 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20127 (cdr (assoc keys org-babel-key-bindings))))
20129 (defcustom org-speed-command-hook
20130 '(org-speed-command-default-hook org-babel-speed-command-hook)
20131 "Hook for activating speed commands at strategic locations.
20132 Hook functions are called in sequence until a valid handler is
20133 found.
20135 Each hook takes a single argument, a user-pressed command key
20136 which is also a `self-insert-command' from the global map.
20138 Within the hook, examine the cursor position and the command key
20139 and return nil or a valid handler as appropriate. Handler could
20140 be one of an interactive command, a function, or a form.
20142 Set `org-use-speed-commands' to non-nil value to enable this
20143 hook. The default setting is `org-speed-command-activate'."
20144 :group 'org-structure
20145 :version "24.1"
20146 :type 'hook)
20148 (defun org-self-insert-command (N)
20149 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20150 If the cursor is in a table looking at whitespace, the whitespace is
20151 overwritten, and the table is not marked as requiring realignment."
20152 (interactive "p")
20153 (org-check-before-invisible-edit 'insert)
20154 (cond
20155 ((and org-use-speed-commands
20156 (let ((kv (this-command-keys-vector)))
20157 (setq org-speed-command
20158 (run-hook-with-args-until-success
20159 'org-speed-command-hook
20160 (make-string 1 (aref kv (1- (length kv))))))))
20161 (cond
20162 ((commandp org-speed-command)
20163 (setq this-command org-speed-command)
20164 (call-interactively org-speed-command))
20165 ((functionp org-speed-command)
20166 (funcall org-speed-command))
20167 ((and org-speed-command (listp org-speed-command))
20168 (eval org-speed-command))
20169 (t (let (org-use-speed-commands)
20170 (call-interactively 'org-self-insert-command)))))
20171 ((and
20172 (org-table-p)
20173 (progn
20174 ;; check if we blank the field, and if that triggers align
20175 (and (featurep 'org-table) org-table-auto-blank-field
20176 (memq last-command
20177 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20178 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20179 ;; got extra space, this field does not determine column width
20180 (let (org-table-may-need-update) (org-table-blank-field))
20181 ;; no extra space, this field may determine column width
20182 (org-table-blank-field)))
20184 (eq N 1)
20185 (looking-at "[^|\n]* |"))
20186 (let (org-table-may-need-update)
20187 (goto-char (1- (match-end 0)))
20188 (backward-delete-char 1)
20189 (goto-char (match-beginning 0))
20190 (self-insert-command N)))
20192 (setq org-table-may-need-update t)
20193 (self-insert-command N)
20194 (org-fix-tags-on-the-fly)
20195 (if org-self-insert-cluster-for-undo
20196 (if (not (eq last-command 'org-self-insert-command))
20197 (setq org-self-insert-command-undo-counter 1)
20198 (if (>= org-self-insert-command-undo-counter 20)
20199 (setq org-self-insert-command-undo-counter 1)
20200 (and (> org-self-insert-command-undo-counter 0)
20201 buffer-undo-list (listp buffer-undo-list)
20202 (not (cadr buffer-undo-list)) ; remove nil entry
20203 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20204 (setq org-self-insert-command-undo-counter
20205 (1+ org-self-insert-command-undo-counter))))))))
20207 (defun org-check-before-invisible-edit (kind)
20208 "Check is editing if kind KIND would be dangerous with invisible text around.
20209 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20210 ;; First, try to get out of here as quickly as possible, to reduce overhead
20211 (if (and org-catch-invisible-edits
20212 (or (not (boundp 'visible-mode)) (not visible-mode))
20213 (or (get-char-property (point) 'invisible)
20214 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20215 ;; OK, we need to take a closer look
20216 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20217 (invisible-before-point (if (bobp) nil (get-char-property
20218 (1- (point)) 'invisible)))
20219 (border-and-ok-direction
20221 ;; Check if we are acting predictably before invisible text
20222 (and invisible-at-point (not invisible-before-point)
20223 (memq kind '(insert delete-backward)))
20224 ;; Check if we are acting predictably after invisible text
20225 ;; This works not well, and I have turned it off. It seems
20226 ;; better to always show and stop after invisible text.
20227 ;; (and (not invisible-at-point) invisible-before-point
20228 ;; (memq kind '(insert delete)))
20230 (when (or (memq invisible-at-point '(outline org-hide-block t))
20231 (memq invisible-before-point '(outline org-hide-block t)))
20232 (if (eq org-catch-invisible-edits 'error)
20233 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20234 (if (and org-custom-properties-overlays
20235 (y-or-n-p "Display invisible properties in this buffer? "))
20236 (org-toggle-custom-properties-visibility)
20237 ;; Make the area visible
20238 (save-excursion
20239 (if invisible-before-point
20240 (goto-char (previous-single-char-property-change
20241 (point) 'invisible)))
20242 (outline-show-subtree))
20243 (cond
20244 ((eq org-catch-invisible-edits 'show)
20245 ;; That's it, we do the edit after showing
20246 (message
20247 "Unfolding invisible region around point before editing")
20248 (sit-for 1))
20249 ((and (eq org-catch-invisible-edits 'smart)
20250 border-and-ok-direction)
20251 (message "Unfolding invisible region around point before editing"))
20253 ;; Don't do the edit, make the user repeat it in full visibility
20254 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20256 (defun org-fix-tags-on-the-fly ()
20257 (when (and (equal (char-after (point-at-bol)) ?*)
20258 (org-at-heading-p))
20259 (org-align-tags-here org-tags-column)))
20261 (defun org-delete-backward-char (N)
20262 "Like `delete-backward-char', insert whitespace at field end in tables.
20263 When deleting backwards, in tables this function will insert whitespace in
20264 front of the next \"|\" separator, to keep the table aligned. The table will
20265 still be marked for re-alignment if the field did fill the entire column,
20266 because, in this case the deletion might narrow the column."
20267 (interactive "p")
20268 (save-match-data
20269 (org-check-before-invisible-edit 'delete-backward)
20270 (if (and (org-table-p)
20271 (eq N 1)
20272 (string-match "|" (buffer-substring (point-at-bol) (point)))
20273 (looking-at ".*?|"))
20274 (let ((pos (point))
20275 (noalign (looking-at "[^|\n\r]* |"))
20276 (c org-table-may-need-update))
20277 (backward-delete-char N)
20278 (if (not overwrite-mode)
20279 (progn
20280 (skip-chars-forward "^|")
20281 (insert " ")
20282 (goto-char (1- pos))))
20283 ;; noalign: if there were two spaces at the end, this field
20284 ;; does not determine the width of the column.
20285 (if noalign (setq org-table-may-need-update c)))
20286 (backward-delete-char N)
20287 (org-fix-tags-on-the-fly))))
20289 (defun org-delete-char (N)
20290 "Like `delete-char', but insert whitespace at field end in tables.
20291 When deleting characters, in tables this function will insert whitespace in
20292 front of the next \"|\" separator, to keep the table aligned. The table will
20293 still be marked for re-alignment if the field did fill the entire column,
20294 because, in this case the deletion might narrow the column."
20295 (interactive "p")
20296 (save-match-data
20297 (org-check-before-invisible-edit 'delete)
20298 (if (and (org-table-p)
20299 (not (bolp))
20300 (not (= (char-after) ?|))
20301 (eq N 1))
20302 (if (looking-at ".*?|")
20303 (let ((pos (point))
20304 (noalign (looking-at "[^|\n\r]* |"))
20305 (c org-table-may-need-update))
20306 (replace-match
20307 (concat (substring (match-string 0) 1 -1) " |") nil t)
20308 (goto-char pos)
20309 ;; noalign: if there were two spaces at the end, this field
20310 ;; does not determine the width of the column.
20311 (if noalign (setq org-table-may-need-update c)))
20312 (delete-char N))
20313 (delete-char N)
20314 (org-fix-tags-on-the-fly))))
20316 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20317 (put 'org-self-insert-command 'delete-selection
20318 (lambda ()
20319 (not (run-hook-with-args-until-success
20320 'self-insert-uses-region-functions))))
20321 (put 'orgtbl-self-insert-command 'delete-selection
20322 (lambda ()
20323 (not (run-hook-with-args-until-success
20324 'self-insert-uses-region-functions))))
20325 (put 'org-delete-char 'delete-selection 'supersede)
20326 (put 'org-delete-backward-char 'delete-selection 'supersede)
20327 (put 'org-yank 'delete-selection 'yank)
20329 ;; Make `flyspell-mode' delay after some commands
20330 (put 'org-self-insert-command 'flyspell-delayed t)
20331 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20332 (put 'org-delete-char 'flyspell-delayed t)
20333 (put 'org-delete-backward-char 'flyspell-delayed t)
20335 ;; Make pabbrev-mode expand after org-mode commands
20336 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20337 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20339 (defun org-remap (map &rest commands)
20340 "In MAP, remap the functions given in COMMANDS.
20341 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20342 (let (new old)
20343 (while commands
20344 (setq old (pop commands) new (pop commands))
20345 (if (fboundp 'command-remapping)
20346 (org-defkey map (vector 'remap old) new)
20347 (substitute-key-definition old new map global-map)))))
20349 (defun org-transpose-words ()
20350 "Transpose words for Org.
20351 This uses the `org-mode-transpose-word-syntax-table' syntax
20352 table, which interprets characters in `org-emphasis-alist' as
20353 word constituents."
20354 (interactive)
20355 (with-syntax-table org-mode-transpose-word-syntax-table
20356 (call-interactively 'transpose-words)))
20357 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20359 (when (eq org-enable-table-editor 'optimized)
20360 ;; If the user wants maximum table support, we need to hijack
20361 ;; some standard editing functions
20362 (org-remap org-mode-map
20363 'self-insert-command 'org-self-insert-command
20364 'delete-char 'org-delete-char
20365 'delete-backward-char 'org-delete-backward-char)
20366 (org-defkey org-mode-map "|" 'org-force-self-insert))
20368 (defvar org-ctrl-c-ctrl-c-hook nil
20369 "Hook for functions attaching themselves to `C-c C-c'.
20371 This can be used to add additional functionality to the C-c C-c
20372 key which executes context-dependent commands. This hook is run
20373 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20374 run after the last test.
20376 Each function will be called with no arguments. The function
20377 must check if the context is appropriate for it to act. If yes,
20378 it should do its thing and then return a non-nil value. If the
20379 context is wrong, just do nothing and return nil.")
20381 (defvar org-ctrl-c-ctrl-c-final-hook nil
20382 "Hook for functions attaching themselves to `C-c C-c'.
20384 This can be used to add additional functionality to the C-c C-c
20385 key which executes context-dependent commands. This hook is run
20386 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20387 before the first test.
20389 Each function will be called with no arguments. The function
20390 must check if the context is appropriate for it to act. If yes,
20391 it should do its thing and then return a non-nil value. If the
20392 context is wrong, just do nothing and return nil.")
20394 (defvar org-tab-first-hook nil
20395 "Hook for functions to attach themselves to TAB.
20396 See `org-ctrl-c-ctrl-c-hook' for more information.
20397 This hook runs as the first action when TAB is pressed, even before
20398 `org-cycle' messes around with the `outline-regexp' to cater for
20399 inline tasks and plain list item folding.
20400 If any function in this hook returns t, any other actions that
20401 would have been caused by TAB (such as table field motion or visibility
20402 cycling) will not occur.")
20404 (defvar org-tab-after-check-for-table-hook nil
20405 "Hook for functions to attach themselves to TAB.
20406 See `org-ctrl-c-ctrl-c-hook' for more information.
20407 This hook runs after it has been established that the cursor is not in a
20408 table, but before checking if the cursor is in a headline or if global cycling
20409 should be done.
20410 If any function in this hook returns t, not other actions like visibility
20411 cycling will be done.")
20413 (defvar org-tab-after-check-for-cycling-hook nil
20414 "Hook for functions to attach themselves to TAB.
20415 See `org-ctrl-c-ctrl-c-hook' for more information.
20416 This hook runs after it has been established that not table field motion and
20417 not visibility should be done because of current context. This is probably
20418 the place where a package like yasnippets can hook in.")
20420 (defvar org-tab-before-tab-emulation-hook nil
20421 "Hook for functions to attach themselves to TAB.
20422 See `org-ctrl-c-ctrl-c-hook' for more information.
20423 This hook runs after every other options for TAB have been exhausted, but
20424 before indentation and \t insertion takes place.")
20426 (defvar org-metaleft-hook nil
20427 "Hook for functions attaching themselves to `M-left'.
20428 See `org-ctrl-c-ctrl-c-hook' for more information.")
20429 (defvar org-metaright-hook nil
20430 "Hook for functions attaching themselves to `M-right'.
20431 See `org-ctrl-c-ctrl-c-hook' for more information.")
20432 (defvar org-metaup-hook nil
20433 "Hook for functions attaching themselves to `M-up'.
20434 See `org-ctrl-c-ctrl-c-hook' for more information.")
20435 (defvar org-metadown-hook nil
20436 "Hook for functions attaching themselves to `M-down'.
20437 See `org-ctrl-c-ctrl-c-hook' for more information.")
20438 (defvar org-shiftmetaleft-hook nil
20439 "Hook for functions attaching themselves to `M-S-left'.
20440 See `org-ctrl-c-ctrl-c-hook' for more information.")
20441 (defvar org-shiftmetaright-hook nil
20442 "Hook for functions attaching themselves to `M-S-right'.
20443 See `org-ctrl-c-ctrl-c-hook' for more information.")
20444 (defvar org-shiftmetaup-hook nil
20445 "Hook for functions attaching themselves to `M-S-up'.
20446 See `org-ctrl-c-ctrl-c-hook' for more information.")
20447 (defvar org-shiftmetadown-hook nil
20448 "Hook for functions attaching themselves to `M-S-down'.
20449 See `org-ctrl-c-ctrl-c-hook' for more information.")
20450 (defvar org-metareturn-hook nil
20451 "Hook for functions attaching themselves to `M-RET'.
20452 See `org-ctrl-c-ctrl-c-hook' for more information.")
20453 (defvar org-shiftup-hook nil
20454 "Hook for functions attaching themselves to `S-up'.
20455 See `org-ctrl-c-ctrl-c-hook' for more information.")
20456 (defvar org-shiftup-final-hook nil
20457 "Hook for functions attaching themselves to `S-up'.
20458 This one runs after all other options except shift-select have been excluded.
20459 See `org-ctrl-c-ctrl-c-hook' for more information.")
20460 (defvar org-shiftdown-hook nil
20461 "Hook for functions attaching themselves to `S-down'.
20462 See `org-ctrl-c-ctrl-c-hook' for more information.")
20463 (defvar org-shiftdown-final-hook nil
20464 "Hook for functions attaching themselves to `S-down'.
20465 This one runs after all other options except shift-select have been excluded.
20466 See `org-ctrl-c-ctrl-c-hook' for more information.")
20467 (defvar org-shiftleft-hook nil
20468 "Hook for functions attaching themselves to `S-left'.
20469 See `org-ctrl-c-ctrl-c-hook' for more information.")
20470 (defvar org-shiftleft-final-hook nil
20471 "Hook for functions attaching themselves to `S-left'.
20472 This one runs after all other options except shift-select have been excluded.
20473 See `org-ctrl-c-ctrl-c-hook' for more information.")
20474 (defvar org-shiftright-hook nil
20475 "Hook for functions attaching themselves to `S-right'.
20476 See `org-ctrl-c-ctrl-c-hook' for more information.")
20477 (defvar org-shiftright-final-hook nil
20478 "Hook for functions attaching themselves to `S-right'.
20479 This one runs after all other options except shift-select have been excluded.
20480 See `org-ctrl-c-ctrl-c-hook' for more information.")
20482 (defun org-modifier-cursor-error ()
20483 "Throw an error, a modified cursor command was applied in wrong context."
20484 (user-error "This command is active in special context like tables, headlines or items"))
20486 (defun org-shiftselect-error ()
20487 "Throw an error because Shift-Cursor command was applied in wrong context."
20488 (if (and (boundp 'shift-select-mode) shift-select-mode)
20489 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20490 (user-error "This command works only in special context like headlines or timestamps")))
20492 (defun org-call-for-shift-select (cmd)
20493 (let ((this-command-keys-shift-translated t))
20494 (call-interactively cmd)))
20496 (defun org-shifttab (&optional arg)
20497 "Global visibility cycling or move to previous table field.
20498 Call `org-table-previous-field' within a table.
20499 When ARG is nil, cycle globally through visibility states.
20500 When ARG is a numeric prefix, show contents of this level."
20501 (interactive "P")
20502 (cond
20503 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20504 ((integerp arg)
20505 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20506 (message "Content view to level: %d" arg)
20507 (org-content (prefix-numeric-value arg2))
20508 (org-cycle-show-empty-lines t)
20509 (setq org-cycle-global-status 'overview)))
20510 (t (call-interactively 'org-global-cycle))))
20512 (defun org-shiftmetaleft ()
20513 "Promote subtree or delete table column.
20514 Calls `org-promote-subtree', `org-outdent-item-tree', or
20515 `org-table-delete-column', depending on context. See the
20516 individual commands for more information."
20517 (interactive)
20518 (cond
20519 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20520 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20521 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20522 ((if (not (org-region-active-p)) (org-at-item-p)
20523 (save-excursion (goto-char (region-beginning))
20524 (org-at-item-p)))
20525 (call-interactively 'org-outdent-item-tree))
20526 (t (org-modifier-cursor-error))))
20528 (defun org-shiftmetaright ()
20529 "Demote subtree or insert table column.
20530 Calls `org-demote-subtree', `org-indent-item-tree', or
20531 `org-table-insert-column', depending on context. See the
20532 individual commands for more information."
20533 (interactive)
20534 (cond
20535 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20536 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20537 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20538 ((if (not (org-region-active-p)) (org-at-item-p)
20539 (save-excursion (goto-char (region-beginning))
20540 (org-at-item-p)))
20541 (call-interactively 'org-indent-item-tree))
20542 (t (org-modifier-cursor-error))))
20544 (defun org-shiftmetaup (&optional arg)
20545 "Drag the line at point up.
20546 In a table, kill the current row.
20547 On a clock timestamp, update the value of the timestamp like `S-<up>'
20548 but also adjust the previous clocked item in the clock history.
20549 Everywhere else, drag the line at point up."
20550 (interactive "P")
20551 (cond
20552 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20553 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20554 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20555 (call-interactively 'org-timestamp-up)))
20556 (t (call-interactively 'org-drag-line-backward))))
20558 (defun org-shiftmetadown (&optional arg)
20559 "Drag the line at point down.
20560 In a table, insert an empty row at the current line.
20561 On a clock timestamp, update the value of the timestamp like `S-<down>'
20562 but also adjust the previous clocked item in the clock history.
20563 Everywhere else, drag the line at point down."
20564 (interactive "P")
20565 (cond
20566 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20567 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20568 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20569 (call-interactively 'org-timestamp-down)))
20570 (t (call-interactively 'org-drag-line-forward))))
20572 (defsubst org-hidden-tree-error ()
20573 (user-error
20574 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20576 (defun org-metaleft (&optional arg)
20577 "Promote heading, list item at point or move table column left.
20579 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20580 depending on context. With no specific context, calls the Emacs
20581 default `backward-word'. See the individual commands for more
20582 information.
20584 This function runs the hook `org-metaleft-hook' as a first step,
20585 and returns at first non-nil value."
20586 (interactive "P")
20587 (cond
20588 ((run-hook-with-args-until-success 'org-metaleft-hook))
20589 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20590 ((org-with-limited-levels
20591 (or (org-at-heading-p)
20592 (and (org-region-active-p)
20593 (save-excursion
20594 (goto-char (region-beginning))
20595 (org-at-heading-p)))))
20596 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20597 (call-interactively 'org-do-promote))
20598 ;; At an inline task.
20599 ((org-at-heading-p)
20600 (call-interactively 'org-inlinetask-promote))
20601 ((or (org-at-item-p)
20602 (and (org-region-active-p)
20603 (save-excursion
20604 (goto-char (region-beginning))
20605 (org-at-item-p))))
20606 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20607 (call-interactively 'org-outdent-item))
20608 (t (call-interactively 'backward-word))))
20610 (defun org-metaright (&optional arg)
20611 "Demote heading, list item at point or move table column right.
20613 In front of a drawer or a block keyword, indent it correctly.
20615 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20616 `org-indnet-drawer' or `org-indent-block' depending on context.
20617 With no specific context, calls the Emacs default `forward-word'.
20618 See the individual commands for more information.
20620 This function runs the hook `org-metaright-hook' as a first step,
20621 and returns at first non-nil value."
20622 (interactive "P")
20623 (cond
20624 ((run-hook-with-args-until-success 'org-metaright-hook))
20625 ((org-at-table-p) (call-interactively 'org-table-move-column))
20626 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20627 ((org-at-block-p) (call-interactively 'org-indent-block))
20628 ((org-with-limited-levels
20629 (or (org-at-heading-p)
20630 (and (org-region-active-p)
20631 (save-excursion
20632 (goto-char (region-beginning))
20633 (org-at-heading-p)))))
20634 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20635 (call-interactively 'org-do-demote))
20636 ;; At an inline task.
20637 ((org-at-heading-p)
20638 (call-interactively 'org-inlinetask-demote))
20639 ((or (org-at-item-p)
20640 (and (org-region-active-p)
20641 (save-excursion
20642 (goto-char (region-beginning))
20643 (org-at-item-p))))
20644 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20645 (call-interactively 'org-indent-item))
20646 (t (call-interactively 'forward-word))))
20648 (defun org-check-for-hidden (what)
20649 "Check if there are hidden headlines/items in the current visual line.
20650 WHAT can be either `headlines' or `items'. If the current line is
20651 an outline or item heading and it has a folded subtree below it,
20652 this function returns t, nil otherwise."
20653 (let ((re (cond
20654 ((eq what 'headlines) org-outline-regexp-bol)
20655 ((eq what 'items) (org-item-beginning-re))
20656 (t (error "This should not happen"))))
20657 beg end)
20658 (save-excursion
20659 (catch 'exit
20660 (unless (org-region-active-p)
20661 (setq beg (point-at-bol))
20662 (beginning-of-line 2)
20663 (while (and (not (eobp)) ;; this is like `next-line'
20664 (get-char-property (1- (point)) 'invisible))
20665 (beginning-of-line 2))
20666 (setq end (point))
20667 (goto-char beg)
20668 (goto-char (point-at-eol))
20669 (setq end (max end (point)))
20670 (while (re-search-forward re end t)
20671 (if (get-char-property (match-beginning 0) 'invisible)
20672 (throw 'exit t))))
20673 nil))))
20675 (defun org-metaup (&optional arg)
20676 "Move subtree up or move table row up.
20677 Calls `org-move-subtree-up' or `org-table-move-row' or
20678 `org-move-item-up', depending on context. See the individual commands
20679 for more information."
20680 (interactive "P")
20681 (cond
20682 ((run-hook-with-args-until-success 'org-metaup-hook))
20683 ((org-region-active-p)
20684 (let* ((a (min (region-beginning) (region-end)))
20685 (b (1- (max (region-beginning) (region-end))))
20686 (c (save-excursion (goto-char a)
20687 (move-beginning-of-line 0)))
20688 (d (save-excursion (goto-char a)
20689 (move-end-of-line 0) (point))))
20690 (transpose-regions a b c d)
20691 (goto-char c)))
20692 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20693 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20694 ((org-at-item-p) (call-interactively 'org-move-item-up))
20695 (t (org-drag-element-backward))))
20697 (defun org-metadown (&optional arg)
20698 "Move subtree down or move table row down.
20699 Calls `org-move-subtree-down' or `org-table-move-row' or
20700 `org-move-item-down', depending on context. See the individual
20701 commands for more information."
20702 (interactive "P")
20703 (cond
20704 ((run-hook-with-args-until-success 'org-metadown-hook))
20705 ((org-region-active-p)
20706 (let* ((a (min (region-beginning) (region-end)))
20707 (b (max (region-beginning) (region-end)))
20708 (c (save-excursion (goto-char b)
20709 (move-beginning-of-line 1)))
20710 (d (save-excursion (goto-char b)
20711 (move-end-of-line 1) (1+ (point)))))
20712 (transpose-regions a b c d)
20713 (goto-char d)))
20714 ((org-at-table-p) (call-interactively 'org-table-move-row))
20715 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20716 ((org-at-item-p) (call-interactively 'org-move-item-down))
20717 (t (org-drag-element-forward))))
20719 (defun org-shiftup (&optional arg)
20720 "Increase item in timestamp or increase priority of current headline.
20721 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20722 depending on context. See the individual commands for more information."
20723 (interactive "P")
20724 (cond
20725 ((run-hook-with-args-until-success 'org-shiftup-hook))
20726 ((and org-support-shift-select (org-region-active-p))
20727 (org-call-for-shift-select 'previous-line))
20728 ((org-at-timestamp-p t)
20729 (call-interactively (if org-edit-timestamp-down-means-later
20730 'org-timestamp-down 'org-timestamp-up)))
20731 ((and (not (eq org-support-shift-select 'always))
20732 org-enable-priority-commands
20733 (org-at-heading-p))
20734 (call-interactively 'org-priority-up))
20735 ((and (not org-support-shift-select) (org-at-item-p))
20736 (call-interactively 'org-previous-item))
20737 ((org-clocktable-try-shift 'up arg))
20738 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20739 (org-support-shift-select
20740 (org-call-for-shift-select 'previous-line))
20741 (t (org-shiftselect-error))))
20743 (defun org-shiftdown (&optional arg)
20744 "Decrease item in timestamp or decrease priority of current headline.
20745 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20746 depending on context. See the individual commands for more information."
20747 (interactive "P")
20748 (cond
20749 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20750 ((and org-support-shift-select (org-region-active-p))
20751 (org-call-for-shift-select 'next-line))
20752 ((org-at-timestamp-p t)
20753 (call-interactively (if org-edit-timestamp-down-means-later
20754 'org-timestamp-up 'org-timestamp-down)))
20755 ((and (not (eq org-support-shift-select 'always))
20756 org-enable-priority-commands
20757 (org-at-heading-p))
20758 (call-interactively 'org-priority-down))
20759 ((and (not org-support-shift-select) (org-at-item-p))
20760 (call-interactively 'org-next-item))
20761 ((org-clocktable-try-shift 'down arg))
20762 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20763 (org-support-shift-select
20764 (org-call-for-shift-select 'next-line))
20765 (t (org-shiftselect-error))))
20767 (defun org-shiftright (&optional arg)
20768 "Cycle the thing at point or in the current line, depending on context.
20769 Depending on context, this does one of the following:
20771 - switch a timestamp at point one day into the future
20772 - on a headline, switch to the next TODO keyword.
20773 - on an item, switch entire list to the next bullet type
20774 - on a property line, switch to the next allowed value
20775 - on a clocktable definition line, move time block into the future"
20776 (interactive "P")
20777 (cond
20778 ((run-hook-with-args-until-success 'org-shiftright-hook))
20779 ((and org-support-shift-select (org-region-active-p))
20780 (org-call-for-shift-select 'forward-char))
20781 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20782 ((and (not (eq org-support-shift-select 'always))
20783 (org-at-heading-p))
20784 (let ((org-inhibit-logging
20785 (not org-treat-S-cursor-todo-selection-as-state-change))
20786 (org-inhibit-blocking
20787 (not org-treat-S-cursor-todo-selection-as-state-change)))
20788 (org-call-with-arg 'org-todo 'right)))
20789 ((or (and org-support-shift-select
20790 (not (eq org-support-shift-select 'always))
20791 (org-at-item-bullet-p))
20792 (and (not org-support-shift-select) (org-at-item-p)))
20793 (org-call-with-arg 'org-cycle-list-bullet nil))
20794 ((and (not (eq org-support-shift-select 'always))
20795 (org-at-property-p))
20796 (call-interactively 'org-property-next-allowed-value))
20797 ((org-clocktable-try-shift 'right arg))
20798 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20799 (org-support-shift-select
20800 (org-call-for-shift-select 'forward-char))
20801 (t (org-shiftselect-error))))
20803 (defun org-shiftleft (&optional arg)
20804 "Cycle the thing at point or in the current line, depending on context.
20805 Depending on context, this does one of the following:
20807 - switch a timestamp at point one day into the past
20808 - on a headline, switch to the previous TODO keyword.
20809 - on an item, switch entire list to the previous bullet type
20810 - on a property line, switch to the previous allowed value
20811 - on a clocktable definition line, move time block into the past"
20812 (interactive "P")
20813 (cond
20814 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20815 ((and org-support-shift-select (org-region-active-p))
20816 (org-call-for-shift-select 'backward-char))
20817 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20818 ((and (not (eq org-support-shift-select 'always))
20819 (org-at-heading-p))
20820 (let ((org-inhibit-logging
20821 (not org-treat-S-cursor-todo-selection-as-state-change))
20822 (org-inhibit-blocking
20823 (not org-treat-S-cursor-todo-selection-as-state-change)))
20824 (org-call-with-arg 'org-todo 'left)))
20825 ((or (and org-support-shift-select
20826 (not (eq org-support-shift-select 'always))
20827 (org-at-item-bullet-p))
20828 (and (not org-support-shift-select) (org-at-item-p)))
20829 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20830 ((and (not (eq org-support-shift-select 'always))
20831 (org-at-property-p))
20832 (call-interactively 'org-property-previous-allowed-value))
20833 ((org-clocktable-try-shift 'left arg))
20834 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20835 (org-support-shift-select
20836 (org-call-for-shift-select 'backward-char))
20837 (t (org-shiftselect-error))))
20839 (defun org-shiftcontrolright ()
20840 "Switch to next TODO set."
20841 (interactive)
20842 (cond
20843 ((and org-support-shift-select (org-region-active-p))
20844 (org-call-for-shift-select 'forward-word))
20845 ((and (not (eq org-support-shift-select 'always))
20846 (org-at-heading-p))
20847 (org-call-with-arg 'org-todo 'nextset))
20848 (org-support-shift-select
20849 (org-call-for-shift-select 'forward-word))
20850 (t (org-shiftselect-error))))
20852 (defun org-shiftcontrolleft ()
20853 "Switch to previous TODO set."
20854 (interactive)
20855 (cond
20856 ((and org-support-shift-select (org-region-active-p))
20857 (org-call-for-shift-select 'backward-word))
20858 ((and (not (eq org-support-shift-select 'always))
20859 (org-at-heading-p))
20860 (org-call-with-arg 'org-todo 'previousset))
20861 (org-support-shift-select
20862 (org-call-for-shift-select 'backward-word))
20863 (t (org-shiftselect-error))))
20865 (defun org-shiftcontrolup (&optional n)
20866 "Change timestamps synchronously up in CLOCK log lines.
20867 Optional argument N tells to change by that many units."
20868 (interactive "P")
20869 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20870 (let (org-support-shift-select)
20871 (org-clock-timestamps-up n))
20872 (user-error "Not at a clock log")))
20874 (defun org-shiftcontroldown (&optional n)
20875 "Change timestamps synchronously down in CLOCK log lines.
20876 Optional argument N tells to change by that many units."
20877 (interactive "P")
20878 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20879 (let (org-support-shift-select)
20880 (org-clock-timestamps-down n))
20881 (user-error "Not at a clock log")))
20883 (defun org-increase-number-at-point (&optional inc)
20884 "Increment the number at point.
20885 With an optional prefix numeric argument INC, increment using
20886 this numeric value."
20887 (interactive "p")
20888 (if (not (number-at-point))
20889 (user-error "Not on a number")
20890 (unless inc (setq inc 1))
20891 (let ((pos (point))
20892 (beg (skip-chars-backward "-+^/*0-9eE."))
20893 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20894 (setq nap (buffer-substring-no-properties
20895 (+ pos beg) (+ pos beg end)))
20896 (delete-region (+ pos beg) (+ pos beg end))
20897 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20898 (when (org-at-table-p)
20899 (org-table-align)
20900 (org-table-end-of-field 1))))
20902 (defun org-decrease-number-at-point (&optional inc)
20903 "Decrement the number at point.
20904 With an optional prefix numeric argument INC, decrement using
20905 this numeric value."
20906 (interactive "p")
20907 (org-increase-number-at-point (- (or inc 1))))
20909 (defun org-ctrl-c-ret ()
20910 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20911 (interactive)
20912 (cond
20913 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20914 (t (call-interactively 'org-insert-heading))))
20916 (defun org-find-visible ()
20917 (let ((s (point)))
20918 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20919 (get-char-property s 'invisible)))
20921 (defun org-find-invisible ()
20922 (let ((s (point)))
20923 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20924 (not (get-char-property s 'invisible))))
20927 (defun org-copy-visible (beg end)
20928 "Copy the visible parts of the region."
20929 (interactive "r")
20930 (let (snippets s)
20931 (save-excursion
20932 (save-restriction
20933 (narrow-to-region beg end)
20934 (setq s (goto-char (point-min)))
20935 (while (not (= (point) (point-max)))
20936 (goto-char (org-find-invisible))
20937 (push (buffer-substring s (point)) snippets)
20938 (setq s (goto-char (org-find-visible))))))
20939 (kill-new (apply 'concat (nreverse snippets)))))
20941 (defun org-copy-special ()
20942 "Copy region in table or copy current subtree.
20943 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20944 See the individual commands for more information."
20945 (interactive)
20946 (call-interactively
20947 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20949 (defun org-cut-special ()
20950 "Cut region in table or cut current subtree.
20951 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20952 See the individual commands for more information."
20953 (interactive)
20954 (call-interactively
20955 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20957 (defun org-paste-special (arg)
20958 "Paste rectangular region into table, or past subtree relative to level.
20959 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20960 See the individual commands for more information."
20961 (interactive "P")
20962 (if (org-at-table-p)
20963 (org-table-paste-rectangle)
20964 (org-paste-subtree arg)))
20966 (defsubst org-in-fixed-width-region-p ()
20967 "Is point in a fixed-width region?"
20968 (save-match-data
20969 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20971 (defun org-edit-special (&optional arg)
20972 "Call a special editor for the element at point.
20973 When at a table, call the formula editor with `org-table-edit-formulas'.
20974 When in a source code block, call `org-edit-src-code'.
20975 When in a fixed-width region, call `org-edit-fixed-width-region'.
20976 When in an export block, call `org-edit-export-block'.
20977 When at an #+INCLUDE keyword, visit the included file.
20978 When at a footnote reference, call `org-edit-footnote-reference'
20979 On a link, call `ffap' to visit the link at point.
20980 Otherwise, return a user error."
20981 (interactive "P")
20982 (let ((element (org-element-at-point)))
20983 (assert (not buffer-read-only) nil
20984 "Buffer is read-only: %s" (buffer-name))
20985 (case (org-element-type element)
20986 (src-block
20987 (if (not arg) (org-edit-src-code)
20988 (let* ((info (org-babel-get-src-block-info))
20989 (lang (nth 0 info))
20990 (params (nth 2 info))
20991 (session (cdr (assq :session params))))
20992 (if (not session) (org-edit-src-code)
20993 ;; At a src-block with a session and function called with
20994 ;; an ARG: switch to the buffer related to the inferior
20995 ;; process.
20996 (switch-to-buffer
20997 (funcall (intern (concat "org-babel-prep-session:" lang))
20998 session params))))))
20999 (keyword
21000 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
21001 (org-open-link-from-string
21002 (format "[[%s]]"
21003 (expand-file-name
21004 (let ((value (org-element-property :value element)))
21005 (cond ((not (org-string-nw-p value))
21006 (user-error "No file to edit"))
21007 ((string-match "\\`\"\\(.*?\\)\"" value)
21008 (match-string 1 value))
21009 ((string-match "\\`[^ \t\"]\\S-*" value)
21010 (match-string 0 value))
21011 (t (user-error "No valid file specified")))))))
21012 (user-error "No special environment to edit here")))
21013 (table
21014 (if (eq (org-element-property :type element) 'table.el)
21015 (org-edit-table.el)
21016 (call-interactively 'org-table-edit-formulas)))
21017 ;; Only Org tables contain `table-row' type elements.
21018 (table-row (call-interactively 'org-table-edit-formulas))
21019 (example-block (org-edit-src-code))
21020 (export-block (org-edit-export-block))
21021 (fixed-width (org-edit-fixed-width-region))
21022 (otherwise
21023 ;; No notable element at point. Though, we may be at a link or
21024 ;; a footnote reference, which are objects. Thus, scan deeper.
21025 (let ((context (org-element-context element)))
21026 (case (org-element-type context)
21027 (link (call-interactively #'ffap))
21028 (footnote-reference (org-edit-footnote-reference))
21029 (t (user-error "No special environment to edit here"))))))))
21031 (defvar org-table-coordinate-overlays) ; defined in org-table.el
21032 (defun org-ctrl-c-ctrl-c (&optional arg)
21033 "Set tags in headline, or update according to changed information at point.
21035 This command does many different things, depending on context:
21037 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
21038 this is what we do.
21040 - If the cursor is on a statistics cookie, update it.
21042 - If the cursor is in a headline, prompt for tags and insert them
21043 into the current line, aligned to `org-tags-column'. When called
21044 with prefix arg, realign all tags in the current buffer.
21046 - If the cursor is in one of the special #+KEYWORD lines, this
21047 triggers scanning the buffer for these lines and updating the
21048 information.
21050 - If the cursor is inside a table, realign the table. This command
21051 works even if the automatic table editor has been turned off.
21053 - If the cursor is on a #+TBLFM line, re-apply the formulas to
21054 the entire table.
21056 - If the cursor is at a footnote reference or definition, jump to
21057 the corresponding definition or references, respectively.
21059 - If the cursor is a the beginning of a dynamic block, update it.
21061 - If the current buffer is a capture buffer, close note and file it.
21063 - If the cursor is on a <<<target>>>, update radio targets and
21064 corresponding links in this buffer.
21066 - If the cursor is on a numbered item in a plain list, renumber the
21067 ordered list.
21069 - If the cursor is on a checkbox, toggle it.
21071 - If the cursor is on a code block, evaluate it. The variable
21072 `org-confirm-babel-evaluate' can be used to control prompting
21073 before code block evaluation, by default every code block
21074 evaluation requires confirmation. Code block evaluation can be
21075 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21076 (interactive "P")
21077 (cond
21078 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21079 org-occur-highlights)
21080 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21081 (org-remove-occur-highlights)
21082 (message "Temporary highlights/overlays removed from current buffer"))
21083 ((and (local-variable-p 'org-finish-function (current-buffer))
21084 (fboundp org-finish-function))
21085 (funcall org-finish-function))
21086 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21088 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21089 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21090 (user-error "C-c C-c can do nothing useful at this location"))
21091 (let* ((context (org-element-context))
21092 (type (org-element-type context)))
21093 (case type
21094 ;; When at a link, act according to the parent instead.
21095 (link (setq context (org-element-property :parent context))
21096 (setq type (org-element-type context)))
21097 ;; Unsupported object types: refer to the first supported
21098 ;; element or object containing it.
21099 ((bold code entity export-snippet inline-babel-call inline-src-block
21100 italic latex-fragment line-break macro strike-through subscript
21101 superscript underline verbatim)
21102 (setq context
21103 (org-element-lineage
21104 context '(radio-target paragraph verse-block table-cell)))))
21105 ;; For convenience: at the first line of a paragraph on the
21106 ;; same line as an item, apply function on that item instead.
21107 (when (eq type 'paragraph)
21108 (let ((parent (org-element-property :parent context)))
21109 (when (and (eq (org-element-type parent) 'item)
21110 (= (line-beginning-position)
21111 (org-element-property :begin parent)))
21112 (setq context parent type 'item))))
21113 ;; Act according to type of element or object at point.
21114 (case type
21115 (clock (org-clock-update-time-maybe))
21116 (dynamic-block
21117 (save-excursion
21118 (goto-char (org-element-property :post-affiliated context))
21119 (org-update-dblock)))
21120 (footnote-definition
21121 (goto-char (org-element-property :post-affiliated context))
21122 (call-interactively 'org-footnote-action))
21123 (footnote-reference (call-interactively 'org-footnote-action))
21124 ((headline inlinetask)
21125 (save-excursion (goto-char (org-element-property :begin context))
21126 (call-interactively 'org-set-tags)))
21127 (item
21128 ;; At an item: a double C-u set checkbox to "[-]"
21129 ;; unconditionally, whereas a single one will toggle its
21130 ;; presence. Without a universal argument, if the item
21131 ;; has a checkbox, toggle it. Otherwise repair the list.
21132 (let* ((box (org-element-property :checkbox context))
21133 (struct (org-element-property :structure context))
21134 (old-struct (copy-tree struct))
21135 (parents (org-list-parents-alist struct))
21136 (prevs (org-list-prevs-alist struct))
21137 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21138 (org-list-set-checkbox
21139 (org-element-property :begin context) struct
21140 (cond ((equal arg '(16)) "[-]")
21141 ((and (not box) (equal arg '(4))) "[ ]")
21142 ((or (not box) (equal arg '(4))) nil)
21143 ((eq box 'on) "[ ]")
21144 (t "[X]")))
21145 ;; Mimic `org-list-write-struct' but with grabbing
21146 ;; a return value from `org-list-struct-fix-box'.
21147 (org-list-struct-fix-ind struct parents 2)
21148 (org-list-struct-fix-item-end struct)
21149 (org-list-struct-fix-bul struct prevs)
21150 (org-list-struct-fix-ind struct parents)
21151 (let ((block-item
21152 (org-list-struct-fix-box struct parents prevs orderedp)))
21153 (if (and box (equal struct old-struct))
21154 (if (equal arg '(16))
21155 (message "Checkboxes already reset")
21156 (user-error "Cannot toggle this checkbox: %s"
21157 (if (eq box 'on)
21158 "all subitems checked"
21159 "unchecked subitems")))
21160 (org-list-struct-apply-struct struct old-struct)
21161 (org-update-checkbox-count-maybe))
21162 (when block-item
21163 (message "Checkboxes were removed due to empty box at line %d"
21164 (org-current-line block-item))))))
21165 (keyword
21166 (let ((org-inhibit-startup-visibility-stuff t)
21167 (org-startup-align-all-tables nil))
21168 (when (boundp 'org-table-coordinate-overlays)
21169 (mapc 'delete-overlay org-table-coordinate-overlays)
21170 (setq org-table-coordinate-overlays nil))
21171 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21172 (message "Local setup has been refreshed"))
21173 (plain-list
21174 ;; At a plain list, with a double C-u argument, set
21175 ;; checkboxes of each item to "[-]", whereas a single one
21176 ;; will toggle their presence according to the state of the
21177 ;; first item in the list. Without an argument, repair the
21178 ;; list.
21179 (let* ((begin (org-element-property :contents-begin context))
21180 (beginm (move-marker (make-marker) begin))
21181 (struct (org-element-property :structure context))
21182 (old-struct (copy-tree struct))
21183 (first-box (save-excursion
21184 (goto-char begin)
21185 (looking-at org-list-full-item-re)
21186 (match-string-no-properties 3)))
21187 (new-box (cond ((equal arg '(16)) "[-]")
21188 ((equal arg '(4)) (unless first-box "[ ]"))
21189 ((equal first-box "[X]") "[ ]")
21190 (t "[X]"))))
21191 (cond
21192 (arg
21193 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21194 (org-list-get-all-items
21195 begin struct (org-list-prevs-alist struct))))
21196 ((and first-box (eq (point) begin))
21197 ;; For convenience, when point is at bol on the first
21198 ;; item of the list and no argument is provided, simply
21199 ;; toggle checkbox of that item, if any.
21200 (org-list-set-checkbox begin struct new-box)))
21201 (org-list-write-struct
21202 struct (org-list-parents-alist struct) old-struct)
21203 (org-update-checkbox-count-maybe)
21204 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21205 ((property-drawer node-property)
21206 (call-interactively 'org-property-action))
21207 ((radio-target target)
21208 (call-interactively 'org-update-radio-target-regexp))
21209 (statistics-cookie
21210 (call-interactively 'org-update-statistics-cookies))
21211 ((table table-cell table-row)
21212 ;; At a table, recalculate every field and align it. Also
21213 ;; send the table if necessary. If the table has
21214 ;; a `table.el' type, just give up. At a table row or
21215 ;; cell, maybe recalculate line but always align table.
21216 (if (eq (org-element-property :type context) 'table.el)
21217 (message "%s" (substitute-command-keys "\\<org-mode-map>\
21218 Use \\[org-edit-special] to edit table.el tables"))
21219 (let ((org-enable-table-editor t))
21220 (if (or (eq type 'table)
21221 ;; Check if point is at a TBLFM line.
21222 (and (eq type 'table-row)
21223 (= (point) (org-element-property :end context))))
21224 (save-excursion
21225 (if (org-at-TBLFM-p)
21226 (progn (require 'org-table)
21227 (org-table-calc-current-TBLFM))
21228 (goto-char (org-element-property :contents-begin context))
21229 (org-call-with-arg 'org-table-recalculate (or arg t))
21230 (orgtbl-send-table 'maybe)))
21231 (org-table-maybe-eval-formula)
21232 (cond (arg (call-interactively 'org-table-recalculate))
21233 ((org-table-maybe-recalculate-line))
21234 (t (org-table-align)))))))
21235 (timestamp (org-timestamp-change 0 'day))
21236 (otherwise
21237 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21238 (user-error
21239 "C-c C-c can do nothing useful at this location")))))))))
21241 (defun org-mode-restart ()
21242 (interactive)
21243 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21244 (funcall major-mode)
21245 (hack-local-variables)
21246 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21247 (org-indent-mode -1)))
21248 (message "%s restarted" major-mode))
21250 (defun org-kill-note-or-show-branches ()
21251 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21252 (interactive)
21253 (if (not org-finish-function)
21254 (progn
21255 (outline-hide-subtree)
21256 (call-interactively 'outline-show-branches))
21257 (let ((org-note-abort t))
21258 (funcall org-finish-function))))
21260 (defun org-delete-indentation (&optional ARG)
21261 "Join current line to previous and fix whitespace at join.
21263 If previous line is a headline add to headline title. Otherwise
21264 the function calls `delete-indentation'.
21266 With argument, join this line to following line."
21267 (interactive "*P")
21268 (if (save-excursion
21269 (if ARG (beginning-of-line)
21270 (forward-line -1))
21271 (looking-at org-complex-heading-regexp))
21272 ;; At headline.
21273 (let ((tags-column (when (match-beginning 5)
21274 (save-excursion (goto-char (match-beginning 5))
21275 (current-column))))
21276 (string (concat " " (progn (when ARG (forward-line 1))
21277 (org-trim (delete-and-extract-region
21278 (line-beginning-position)
21279 (line-end-position)))))))
21280 (unless (bobp) (delete-region (point) (1- (point))))
21281 (goto-char (or (match-end 4)
21282 (match-beginning 5)
21283 (match-end 0)))
21284 (skip-chars-backward " \t")
21285 (save-excursion (insert string))
21286 ;; Adjust alignment of tags.
21287 (when tags-column
21288 (org-align-tags-here (if org-auto-align-tags
21289 org-tags-column
21290 tags-column))))
21291 (delete-indentation ARG)))
21293 (defun org-open-line (n)
21294 "Insert a new row in tables, call `open-line' elsewhere.
21295 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21296 (interactive "*p")
21297 (cond
21298 ((not org-special-ctrl-o)
21299 (open-line n))
21300 ((org-at-table-p)
21301 (org-table-insert-row))
21303 (open-line n))))
21305 (defun org-return (&optional indent)
21306 "Goto next table row or insert a newline.
21308 Calls `org-table-next-row' or `newline', depending on context.
21310 When optional INDENT argument is non-nil, call
21311 `newline-and-indent' instead of `newline'.
21313 When `org-return-follows-link' is non-nil and point is on
21314 a timestamp or a link, call `org-open-at-point'. However, it
21315 will not happen if point is in a table or on a \"dead\"
21316 object (e.g., within a comment). In these case, you need to use
21317 `org-open-at-point' directly."
21318 (interactive)
21319 (let ((context (if org-return-follows-link (org-element-context)
21320 (org-element-at-point))))
21321 (cond
21322 ;; In a table, call `org-table-next-row'.
21323 ((or (and (eq (org-element-type context) 'table)
21324 (>= (point) (org-element-property :contents-begin context))
21325 (< (point) (org-element-property :contents-end context)))
21326 (org-element-lineage context '(table-row table-cell) t))
21327 (org-table-justify-field-maybe)
21328 (call-interactively #'org-table-next-row))
21329 ;; On a link or a timestamp, call `org-open-line' if
21330 ;; `org-return-follows-link' allows it. Tolerate fuzzy
21331 ;; locations, e.g., in a comment, as `org-open-line'.
21332 ((and org-return-follows-link
21333 (or (org-at-timestamp-p t)
21334 (org-at-date-range-p t)
21335 (org-in-regexp org-any-link-re)))
21336 (call-interactively #'org-open-at-point))
21337 ;; Insert newline in heading, but preserve tags.
21338 ((and (not (bolp))
21339 (save-excursion (beginning-of-line)
21340 (looking-at org-complex-heading-regexp)))
21341 ;; At headline. Split line. However, if point is on keyword,
21342 ;; priority cookie or tags, do not break any of them: add
21343 ;; a newline after the headline instead.
21344 (let ((tags-column (and (match-beginning 5)
21345 (save-excursion (goto-char (match-beginning 5))
21346 (current-column))))
21347 (string
21348 (when (and (match-end 4)
21349 (>= (point)
21350 (or (match-end 3) (match-end 2) (1+ (match-end 1))))
21351 (<= (point) (match-end 4)))
21352 (delete-and-extract-region (point) (match-end 4)))))
21353 (when (and tags-column string) ; Adjust tag alignment.
21354 (org-align-tags-here
21355 (if org-auto-align-tags org-tags-column tags-column)))
21356 (end-of-line)
21357 (org-show-entry)
21358 (if indent (newline-and-indent) (newline))
21359 (when string (save-excursion (insert (org-trim string))))))
21360 ;; In a list, make sure indenting keeps trailing text within.
21361 ((and indent
21362 (not (eolp))
21363 (org-element-lineage context '(item)))
21364 (let ((trailing-data
21365 (delete-and-extract-region (point) (line-end-position))))
21366 (newline-and-indent)
21367 (save-excursion (insert trailing-data))))
21368 (t (if indent (newline-and-indent) (newline))))))
21370 (defun org-return-indent ()
21371 "Goto next table row or insert a newline and indent.
21372 Calls `org-table-next-row' or `newline-and-indent', depending on
21373 context. See the individual commands for more information."
21374 (interactive)
21375 (org-return t))
21377 (defun org-ctrl-c-star ()
21378 "Compute table, or change heading status of lines.
21379 Calls `org-table-recalculate' or `org-toggle-heading',
21380 depending on context."
21381 (interactive)
21382 (cond
21383 ((org-at-table-p)
21384 (call-interactively 'org-table-recalculate))
21386 ;; Convert all lines in region to list items
21387 (call-interactively 'org-toggle-heading))))
21389 (defun org-ctrl-c-minus ()
21390 "Insert separator line in table or modify bullet status of line.
21391 Also turns a plain line or a region of lines into list items.
21392 Calls `org-table-insert-hline', `org-toggle-item', or
21393 `org-cycle-list-bullet', depending on context."
21394 (interactive)
21395 (cond
21396 ((org-at-table-p)
21397 (call-interactively 'org-table-insert-hline))
21398 ((org-region-active-p)
21399 (call-interactively 'org-toggle-item))
21400 ((org-in-item-p)
21401 (call-interactively 'org-cycle-list-bullet))
21403 (call-interactively 'org-toggle-item))))
21405 (defun org-toggle-item (arg)
21406 "Convert headings or normal lines to items, items to normal lines.
21407 If there is no active region, only the current line is considered.
21409 If the first non blank line in the region is a headline, convert
21410 all headlines to items, shifting text accordingly.
21412 If it is an item, convert all items to normal lines.
21414 If it is normal text, change region into a list of items.
21415 With a prefix argument ARG, change the region in a single item."
21416 (interactive "P")
21417 (let ((shift-text
21418 (function
21419 ;; Shift text in current section to IND, from point to END.
21420 ;; The function leaves point to END line.
21421 (lambda (ind end)
21422 (let ((min-i 1000) (end (copy-marker end)))
21423 ;; First determine the minimum indentation (MIN-I) of
21424 ;; the text.
21425 (save-excursion
21426 (catch 'exit
21427 (while (< (point) end)
21428 (let ((i (org-get-indentation)))
21429 (cond
21430 ;; Skip blank lines and inline tasks.
21431 ((looking-at "^[ \t]*$"))
21432 ((looking-at org-outline-regexp-bol))
21433 ;; We can't find less than 0 indentation.
21434 ((zerop i) (throw 'exit (setq min-i 0)))
21435 ((< i min-i) (setq min-i i))))
21436 (forward-line))))
21437 ;; Then indent each line so that a line indented to
21438 ;; MIN-I becomes indented to IND. Ignore blank lines
21439 ;; and inline tasks in the process.
21440 (let ((delta (- ind min-i)))
21441 (while (< (point) end)
21442 (unless (or (looking-at "^[ \t]*$")
21443 (looking-at org-outline-regexp-bol))
21444 (org-indent-line-to (+ (org-get-indentation) delta)))
21445 (forward-line)))))))
21446 (skip-blanks
21447 (function
21448 ;; Return beginning of first non-blank line, starting from
21449 ;; line at POS.
21450 (lambda (pos)
21451 (save-excursion
21452 (goto-char pos)
21453 (skip-chars-forward " \r\t\n")
21454 (point-at-bol)))))
21455 beg end)
21456 ;; Determine boundaries of changes.
21457 (if (org-region-active-p)
21458 (setq beg (funcall skip-blanks (region-beginning))
21459 end (copy-marker (region-end)))
21460 (setq beg (funcall skip-blanks (point-at-bol))
21461 end (copy-marker (point-at-eol))))
21462 ;; Depending on the starting line, choose an action on the text
21463 ;; between BEG and END.
21464 (org-with-limited-levels
21465 (save-excursion
21466 (goto-char beg)
21467 (cond
21468 ;; Case 1. Start at an item: de-itemize. Note that it only
21469 ;; happens when a region is active: `org-ctrl-c-minus'
21470 ;; would call `org-cycle-list-bullet' otherwise.
21471 ((org-at-item-p)
21472 (while (< (point) end)
21473 (when (org-at-item-p)
21474 (skip-chars-forward " \t")
21475 (delete-region (point) (match-end 0)))
21476 (forward-line)))
21477 ;; Case 2. Start at an heading: convert to items.
21478 ((org-at-heading-p)
21479 (let* ((bul (org-list-bullet-string "-"))
21480 (bul-len (length bul))
21481 (done (org-entry-is-done-p))
21482 (todo (org-entry-is-todo-p))
21483 ;; Indentation of the first heading. It should be
21484 ;; relative to the indentation of its parent, if any.
21485 (start-ind (save-excursion
21486 (cond
21487 ((not org-adapt-indentation) 0)
21488 ((not (outline-previous-heading)) 0)
21489 (t (length (match-string 0))))))
21490 ;; Level of first heading. Further headings will be
21491 ;; compared to it to determine hierarchy in the list.
21492 (ref-level (org-reduced-level (org-outline-level))))
21493 (when (or done todo) (org-todo ""))
21494 (while (< (point) end)
21495 (let* ((level (org-reduced-level (org-outline-level)))
21496 (delta (max 0 (- level ref-level))))
21497 ;; If current headline is less indented than the first
21498 ;; one, set it as reference, in order to preserve
21499 ;; subtrees.
21500 (when (< level ref-level) (setq ref-level level))
21501 (replace-match bul t t)
21502 (org-indent-line-to (+ start-ind (* delta bul-len)))
21503 (when (or done todo)
21504 (let* ((struct (org-list-struct))
21505 (old (copy-tree struct)))
21506 (org-list-set-checkbox (line-beginning-position)
21507 struct
21508 (if done "[X]" "[ ]"))
21509 (org-list-write-struct struct
21510 (org-list-parents-alist struct)
21511 old)))
21512 ;; Ensure all text down to END (or SECTION-END) belongs
21513 ;; to the newly created item.
21514 (let ((section-end (save-excursion
21515 (or (outline-next-heading) (point)))))
21516 (forward-line)
21517 (funcall shift-text
21518 (+ start-ind (* (1+ delta) bul-len))
21519 (min end section-end)))))))
21520 ;; Case 3. Normal line with ARG: make the first line of region
21521 ;; an item, and shift indentation of others lines to
21522 ;; set them as item's body.
21523 (arg (let* ((bul (org-list-bullet-string "-"))
21524 (bul-len (length bul))
21525 (ref-ind (org-get-indentation)))
21526 (skip-chars-forward " \t")
21527 (insert bul)
21528 (forward-line)
21529 (while (< (point) end)
21530 ;; Ensure that lines less indented than first one
21531 ;; still get included in item body.
21532 (funcall shift-text
21533 (+ ref-ind bul-len)
21534 (min end (save-excursion (or (outline-next-heading)
21535 (point)))))
21536 (forward-line))))
21537 ;; Case 4. Normal line without ARG: turn each non-item line
21538 ;; into an item.
21540 (while (< (point) end)
21541 (unless (or (org-at-heading-p) (org-at-item-p))
21542 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21543 (replace-match
21544 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21545 (forward-line))))))))
21547 (defun org-toggle-heading (&optional nstars)
21548 "Convert headings to normal text, or items or text to headings.
21549 If there is no active region, only convert the current line.
21551 With a \\[universal-argument] prefix, convert the whole list at
21552 point into heading.
21554 In a region:
21556 - If the first non blank line is a headline, remove the stars
21557 from all headlines in the region.
21559 - If it is a normal line, turn each and every normal line (i.e.,
21560 not an heading or an item) in the region into headings. If you
21561 want to convert only the first line of this region, use one
21562 universal prefix argument.
21564 - If it is a plain list item, turn all plain list items into headings.
21566 When converting a line into a heading, the number of stars is chosen
21567 such that the lines become children of the current entry. However,
21568 when a numeric prefix argument is given, its value determines the
21569 number of stars to add."
21570 (interactive "P")
21571 (let ((skip-blanks
21572 (function
21573 ;; Return beginning of first non-blank line, starting from
21574 ;; line at POS.
21575 (lambda (pos)
21576 (save-excursion
21577 (goto-char pos)
21578 (while (org-at-comment-p) (forward-line))
21579 (skip-chars-forward " \r\t\n")
21580 (point-at-bol)))))
21581 beg end toggled)
21582 ;; Determine boundaries of changes. If a universal prefix has
21583 ;; been given, put the list in a region. If region ends at a bol,
21584 ;; do not consider the last line to be in the region.
21586 (when (and current-prefix-arg (org-at-item-p))
21587 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21588 (org-mark-element))
21590 (if (org-region-active-p)
21591 (setq beg (funcall skip-blanks (region-beginning))
21592 end (copy-marker (save-excursion
21593 (goto-char (region-end))
21594 (if (bolp) (point) (point-at-eol)))))
21595 (setq beg (funcall skip-blanks (point-at-bol))
21596 end (copy-marker (point-at-eol))))
21597 ;; Ensure inline tasks don't count as headings.
21598 (org-with-limited-levels
21599 (save-excursion
21600 (goto-char beg)
21601 (cond
21602 ;; Case 1. Started at an heading: de-star headings.
21603 ((org-at-heading-p)
21604 (while (< (point) end)
21605 (when (org-at-heading-p t)
21606 (looking-at org-outline-regexp) (replace-match "")
21607 (setq toggled t))
21608 (forward-line)))
21609 ;; Case 2. Started at an item: change items into headlines.
21610 ;; One star will be added by `org-list-to-subtree'.
21611 ((org-at-item-p)
21612 (while (< (point) end)
21613 (when (org-at-item-p)
21614 ;; Pay attention to cases when region ends before list.
21615 (let* ((struct (org-list-struct))
21616 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21617 (save-restriction
21618 (narrow-to-region (point) list-end)
21619 (insert (org-list-to-subtree (org-list-parse-list t)))))
21620 (setq toggled t))
21621 (forward-line)))
21622 ;; Case 3. Started at normal text: make every line an heading,
21623 ;; skipping headlines and items.
21624 (t (let* ((stars
21625 (make-string
21626 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21627 (add-stars
21628 (cond (nstars "") ; stars from prefix only
21629 ((equal stars "") "*") ; before first heading
21630 (org-odd-levels-only "**") ; inside heading, odd
21631 (t "*"))) ; inside heading, oddeven
21632 (rpl (concat stars add-stars " "))
21633 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21634 (while (< (point) (if (equal nstars '(4)) lend end))
21635 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21636 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21637 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21638 (forward-line)))))))
21639 (unless toggled (message "Cannot toggle heading from here"))))
21641 (defun org-meta-return (&optional _arg)
21642 "Insert a new heading or wrap a region in a table.
21643 Calls `org-insert-heading' or `org-table-wrap-region', depending
21644 on context. See the individual commands for more information."
21645 (interactive)
21646 (org-check-before-invisible-edit 'insert)
21647 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21648 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21649 #'org-insert-heading))))
21651 ;;; Menu entries
21653 (defsubst org-in-subtree-not-table-p ()
21654 "Are we in a subtree and not in a table?"
21655 (and (not (org-before-first-heading-p))
21656 (not (org-at-table-p))))
21658 ;; Define the Org-mode menus
21659 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21660 '("Tbl"
21661 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21662 ["Next Field" org-cycle (org-at-table-p)]
21663 ["Previous Field" org-shifttab (org-at-table-p)]
21664 ["Next Row" org-return (org-at-table-p)]
21665 "--"
21666 ["Blank Field" org-table-blank-field (org-at-table-p)]
21667 ["Edit Field" org-table-edit-field (org-at-table-p)]
21668 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21669 "--"
21670 ("Column"
21671 ["Move Column Left" org-metaleft (org-at-table-p)]
21672 ["Move Column Right" org-metaright (org-at-table-p)]
21673 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21674 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21675 ("Row"
21676 ["Move Row Up" org-metaup (org-at-table-p)]
21677 ["Move Row Down" org-metadown (org-at-table-p)]
21678 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21679 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21680 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21681 "--"
21682 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21683 ("Rectangle"
21684 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21685 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21686 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21687 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21688 "--"
21689 ("Calculate"
21690 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21691 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21692 ["Edit Formulas" org-edit-special (org-at-table-p)]
21693 "--"
21694 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21695 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21696 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21697 "--"
21698 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21699 "--"
21700 ["Sum Column/Rectangle" org-table-sum
21701 (or (org-at-table-p) (org-region-active-p))]
21702 ["Which Column?" org-table-current-column (org-at-table-p)])
21703 ["Debug Formulas"
21704 org-table-toggle-formula-debugger
21705 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21706 ["Show Col/Row Numbers"
21707 org-table-toggle-coordinate-overlays
21708 :style toggle
21709 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21710 "--"
21711 ["Create" org-table-create (and (not (org-at-table-p))
21712 org-enable-table-editor)]
21713 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21714 ["Import from File" org-table-import (not (org-at-table-p))]
21715 ["Export to File" org-table-export (org-at-table-p)]
21716 "--"
21717 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21718 "--"
21719 ("Plot"
21720 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21721 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21723 (easy-menu-define org-org-menu org-mode-map "Org menu"
21724 '("Org"
21725 ("Show/Hide"
21726 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21727 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21728 ["Sparse Tree..." org-sparse-tree t]
21729 ["Reveal Context" org-reveal t]
21730 ["Show All" outline-show-all t]
21731 "--"
21732 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21733 "--"
21734 ["New Heading" org-insert-heading t]
21735 ("Navigate Headings"
21736 ["Up" outline-up-heading t]
21737 ["Next" outline-next-visible-heading t]
21738 ["Previous" outline-previous-visible-heading t]
21739 ["Next Same Level" outline-forward-same-level t]
21740 ["Previous Same Level" outline-backward-same-level t]
21741 "--"
21742 ["Jump" org-goto t])
21743 ("Edit Structure"
21744 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21745 "--"
21746 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21747 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21748 "--"
21749 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21750 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21751 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21752 "--"
21753 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21754 "--"
21755 ["Copy visible text" org-copy-visible t]
21756 "--"
21757 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21758 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21759 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21760 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21761 "--"
21762 ["Sort Region/Children" org-sort t]
21763 "--"
21764 ["Convert to odd levels" org-convert-to-odd-levels t]
21765 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21766 ("Editing"
21767 ["Emphasis..." org-emphasize t]
21768 ["Edit Source Example" org-edit-special t]
21769 "--"
21770 ["Footnote new/jump" org-footnote-action t]
21771 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21772 ("Archive"
21773 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21774 "--"
21775 ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)]
21776 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21777 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21779 "--"
21780 ("Hyperlinks"
21781 ["Store Link (Global)" org-store-link t]
21782 ["Find existing link to here" org-occur-link-in-agenda-files t]
21783 ["Insert Link" org-insert-link t]
21784 ["Follow Link" org-open-at-point t]
21785 "--"
21786 ["Next link" org-next-link t]
21787 ["Previous link" org-previous-link t]
21788 "--"
21789 ["Descriptive Links"
21790 org-toggle-link-display
21791 :style radio
21792 :selected org-descriptive-links
21794 ["Literal Links"
21795 org-toggle-link-display
21796 :style radio
21797 :selected (not org-descriptive-links)])
21798 "--"
21799 ("TODO Lists"
21800 ["TODO/DONE/-" org-todo t]
21801 ("Select keyword"
21802 ["Next keyword" org-shiftright (org-at-heading-p)]
21803 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21804 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21805 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21806 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21807 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21808 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21809 "--"
21810 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21811 :selected org-enforce-todo-dependencies :style toggle :active t]
21812 "Settings for tree at point"
21813 ["Do Children sequentially" org-toggle-ordered-property :style radio
21814 :selected (org-entry-get nil "ORDERED")
21815 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21816 ["Do Children parallel" org-toggle-ordered-property :style radio
21817 :selected (not (org-entry-get nil "ORDERED"))
21818 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21819 "--"
21820 ["Set Priority" org-priority t]
21821 ["Priority Up" org-shiftup t]
21822 ["Priority Down" org-shiftdown t]
21823 "--"
21824 ["Get news from all feeds" org-feed-update-all t]
21825 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21826 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21827 ("TAGS and Properties"
21828 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21829 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21830 "--"
21831 ["Set property" org-set-property (not (org-before-first-heading-p))]
21832 ["Column view of properties" org-columns t]
21833 ["Insert Column View DBlock" org-insert-columns-dblock t])
21834 ("Dates and Scheduling"
21835 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21836 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21837 ("Change Date"
21838 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21839 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21840 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21841 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21842 ["Compute Time Range" org-evaluate-time-range t]
21843 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21844 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21845 "--"
21846 ["Custom time format" org-toggle-time-stamp-overlays
21847 :style radio :selected org-display-custom-times]
21848 "--"
21849 ["Goto Calendar" org-goto-calendar t]
21850 ["Date from Calendar" org-date-from-calendar t]
21851 "--"
21852 ["Start/Restart Timer" org-timer-start t]
21853 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21854 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21855 ["Insert Timer String" org-timer t]
21856 ["Insert Timer Item" org-timer-item t])
21857 ("Logging work"
21858 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21859 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21860 ["Clock out" org-clock-out t]
21861 ["Clock cancel" org-clock-cancel t]
21862 "--"
21863 ["Mark as default task" org-clock-mark-default-task t]
21864 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21865 ["Goto running clock" org-clock-goto t]
21866 "--"
21867 ["Display times" org-clock-display t]
21868 ["Create clock table" org-clock-report t]
21869 "--"
21870 ["Record DONE time"
21871 (progn (setq org-log-done (not org-log-done))
21872 (message "Switching to %s will %s record a timestamp"
21873 (car org-done-keywords)
21874 (if org-log-done "automatically" "not")))
21875 :style toggle :selected org-log-done])
21876 "--"
21877 ["Agenda Command..." org-agenda t]
21878 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21879 ("File List for Agenda")
21880 ("Special views current file"
21881 ["TODO Tree" org-show-todo-tree t]
21882 ["Check Deadlines" org-check-deadlines t]
21883 ["Timeline" org-timeline t]
21884 ["Tags/Property tree" org-match-sparse-tree t])
21885 "--"
21886 ["Export/Publish..." org-export-dispatch t]
21887 ("LaTeX"
21888 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21889 :selected org-cdlatex-mode]
21890 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21891 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21892 ["Modify math symbol" org-cdlatex-math-modify
21893 (org-inside-LaTeX-fragment-p)]
21894 ["Insert citation" org-reftex-citation t]
21895 "--"
21896 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21897 "--"
21898 ("MobileOrg"
21899 ["Push Files and Views" org-mobile-push t]
21900 ["Get Captured and Flagged" org-mobile-pull t]
21901 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21902 "--"
21903 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21904 "--"
21905 ("Documentation"
21906 ["Show Version" org-version t]
21907 ["Info Documentation" org-info t])
21908 ("Customize"
21909 ["Browse Org Group" org-customize t]
21910 "--"
21911 ["Expand This Menu" org-create-customize-menu
21912 (fboundp 'customize-menu-create)])
21913 ["Send bug report" org-submit-bug-report t]
21914 "--"
21915 ("Refresh/Reload"
21916 ["Refresh setup current buffer" org-mode-restart t]
21917 ["Reload Org (after update)" org-reload t]
21918 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21921 (defun org-info (&optional node)
21922 "Read documentation for Org-mode in the info system.
21923 With optional NODE, go directly to that node."
21924 (interactive)
21925 (info (format "(org)%s" (or node ""))))
21927 ;;;###autoload
21928 (defun org-submit-bug-report ()
21929 "Submit a bug report on Org-mode via mail.
21931 Don't hesitate to report any problems or inaccurate documentation.
21933 If you don't have setup sending mail from (X)Emacs, please copy the
21934 output buffer into your mail program, as it gives us important
21935 information about your Org-mode version and configuration."
21936 (interactive)
21937 (require 'reporter)
21938 (defvar reporter-prompt-for-summary-p)
21939 (org-load-modules-maybe)
21940 (org-require-autoloaded-modules)
21941 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21942 (reporter-submit-bug-report
21943 "emacs-orgmode@gnu.org"
21944 (org-version nil 'full)
21945 (let (list)
21946 (save-window-excursion
21947 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21948 (delete-other-windows)
21949 (erase-buffer)
21950 (insert "You are about to submit a bug report to the Org-mode mailing list.
21952 We would like to add your full Org-mode and Outline configuration to the
21953 bug report. This greatly simplifies the work of the maintainer and
21954 other experts on the mailing list.
21956 HOWEVER, some variables you have customized may contain private
21957 information. The names of customers, colleagues, or friends, might
21958 appear in the form of file names, tags, todo states, or search strings.
21959 If you answer yes to the prompt, you might want to check and remove
21960 such private information before sending the email.")
21961 (add-text-properties (point-min) (point-max) '(face org-warning))
21962 (when (yes-or-no-p "Include your Org-mode configuration ")
21963 (mapatoms
21964 (lambda (v)
21965 (and (boundp v)
21966 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21967 (or (and (symbol-value v)
21968 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21969 (and
21970 (get v 'custom-type) (get v 'standard-value)
21971 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21972 (push v list)))))
21973 (kill-buffer (get-buffer "*Warn about privacy*"))
21974 list))
21975 nil nil
21976 "Remember to cover the basics, that is, what you expected to happen and
21977 what in fact did happen. You don't know how to make a good report? See
21979 http://orgmode.org/manual/Feedback.html#Feedback
21981 Your bug report will be posted to the Org-mode mailing list.
21982 ------------------------------------------------------------------------")
21983 (save-excursion
21984 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21985 (replace-match "\\1Bug: \\3 [\\2]")))))
21988 (defun org-install-agenda-files-menu ()
21989 (let ((bl (buffer-list)))
21990 (save-excursion
21991 (while bl
21992 (set-buffer (pop bl))
21993 (if (derived-mode-p 'org-mode) (setq bl nil)))
21994 (when (derived-mode-p 'org-mode)
21995 (easy-menu-change
21996 '("Org") "File List for Agenda"
21997 (append
21998 (list
21999 ["Edit File List" (org-edit-agenda-file-list) t]
22000 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
22001 ["Remove Current File from List" org-remove-file t]
22002 ["Cycle through agenda files" org-cycle-agenda-files t]
22003 ["Occur in all agenda files" org-occur-in-agenda-files t]
22004 "--")
22005 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
22007 ;;;; Documentation
22009 (defun org-require-autoloaded-modules ()
22010 (interactive)
22011 (mapc 'require
22012 '(org-agenda org-archive org-attach org-clock org-colview org-id
22013 org-table org-timer)))
22015 ;;;###autoload
22016 (defun org-reload (&optional uncompiled)
22017 "Reload all org lisp files.
22018 With prefix arg UNCOMPILED, load the uncompiled versions."
22019 (interactive "P")
22020 (require 'loadhist)
22021 (let* ((org-dir (org-find-library-dir "org"))
22022 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
22023 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
22024 (remove-re (mapconcat 'identity
22025 (mapcar (lambda (f) (concat "^" f "$"))
22026 (list (if (featurep 'xemacs)
22027 "org-colview"
22028 "org-colview-xemacs")
22029 "org" "org-loaddefs" "org-version"))
22030 "\\|"))
22031 (feats (delete-dups
22032 (mapcar 'file-name-sans-extension
22033 (mapcar 'file-name-nondirectory
22034 (delq nil
22035 (mapcar 'feature-file
22036 features))))))
22037 (lfeat (append
22038 (sort
22039 (setq feats
22040 (delq nil (mapcar
22041 (lambda (f)
22042 (if (and (string-match feature-re f)
22043 (not (string-match remove-re f)))
22044 f nil))
22045 feats)))
22046 'string-lessp)
22047 (list "org-version" "org")))
22048 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
22049 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22050 load-uncore load-misses)
22051 (setq load-misses
22052 (delq 't
22053 (mapcar (lambda (f)
22054 (or (org-load-noerror-mustsuffix (concat org-dir f))
22055 (and (string= org-dir contrib-dir)
22056 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22057 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22058 (add-to-list 'load-uncore f 'append)
22061 lfeat)))
22062 (if load-uncore
22063 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22064 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22065 (if load-misses
22066 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22067 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22068 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22070 ;;;###autoload
22071 (defun org-customize ()
22072 "Call the customize function with org as argument."
22073 (interactive)
22074 (org-load-modules-maybe)
22075 (org-require-autoloaded-modules)
22076 (customize-browse 'org))
22078 (defun org-create-customize-menu ()
22079 "Create a full customization menu for Org-mode, insert it into the menu."
22080 (interactive)
22081 (org-load-modules-maybe)
22082 (org-require-autoloaded-modules)
22083 (if (fboundp 'customize-menu-create)
22084 (progn
22085 (easy-menu-change
22086 '("Org") "Customize"
22087 `(["Browse Org group" org-customize t]
22088 "--"
22089 ,(customize-menu-create 'org)
22090 ["Set" Custom-set t]
22091 ["Save" Custom-save t]
22092 ["Reset to Current" Custom-reset-current t]
22093 ["Reset to Saved" Custom-reset-saved t]
22094 ["Reset to Standard Settings" Custom-reset-standard t]))
22095 (message "\"Org\"-menu now contains full customization menu"))
22096 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22098 ;;;; Miscellaneous stuff
22100 ;;; Generally useful functions
22102 (defsubst org-get-at-eol (property n)
22103 "Get text property PROPERTY at the end of line less N characters."
22104 (get-text-property (- (point-at-eol) n) property))
22106 (defun org-find-text-property-in-string (prop s)
22107 "Return the first non-nil value of property PROP in string S."
22108 (or (get-text-property 0 prop s)
22109 (get-text-property (or (next-single-property-change 0 prop s) 0)
22110 prop s)))
22112 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22113 "Display the given MESSAGE as a warning."
22114 (if (fboundp 'display-warning)
22115 (display-warning 'org message
22116 (if (featurep 'xemacs) 'warning :warning))
22117 (let ((buf (get-buffer-create "*Org warnings*")))
22118 (with-current-buffer buf
22119 (goto-char (point-max))
22120 (insert "Warning (Org): " message)
22121 (unless (bolp)
22122 (newline)))
22123 (display-buffer buf)
22124 (sit-for 0))))
22126 (defun org-eval (form)
22127 "Eval FORM and return result."
22128 (condition-case error
22129 (eval form)
22130 (error (format "%%![Error: %s]" error))))
22132 (defun org-in-clocktable-p ()
22133 "Check if the cursor is in a clocktable."
22134 (let ((pos (point)) start)
22135 (save-excursion
22136 (end-of-line 1)
22137 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22138 (setq start (match-beginning 0))
22139 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22140 (>= (match-end 0) pos)
22141 start))))
22143 (defun org-in-verbatim-emphasis ()
22144 (save-match-data
22145 (and (org-in-regexp org-emph-re 2)
22146 (>= (point) (match-beginning 3))
22147 (<= (point) (match-end 4))
22148 (member (match-string 3) '("=" "~")))))
22150 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22151 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22152 (if (and marker (marker-buffer marker)
22153 (buffer-live-p (marker-buffer marker)))
22154 (progn
22155 (org-pop-to-buffer-same-window (marker-buffer marker))
22156 (if (or (> marker (point-max)) (< marker (point-min)))
22157 (widen))
22158 (goto-char marker)
22159 (org-show-context 'org-goto))
22160 (if bookmark
22161 (bookmark-jump bookmark)
22162 (error "Cannot find location"))))
22164 (defun org-quote-csv-field (s)
22165 "Quote field for inclusion in CSV material."
22166 (if (string-match "[\",]" s)
22167 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22170 (defun org-force-self-insert (N)
22171 "Needed to enforce self-insert under remapping."
22172 (interactive "p")
22173 (self-insert-command N))
22175 (defun org-string-width (s)
22176 "Compute width of string, ignoring invisible characters.
22177 This ignores character with invisibility property `org-link', and also
22178 characters with property `org-cwidth', because these will become invisible
22179 upon the next fontification round."
22180 (let (b l)
22181 (when (or (eq t buffer-invisibility-spec)
22182 (assq 'org-link buffer-invisibility-spec))
22183 (while (setq b (text-property-any 0 (length s)
22184 'invisible 'org-link s))
22185 (setq s (concat (substring s 0 b)
22186 (substring s (or (next-single-property-change
22187 b 'invisible s)
22188 (length s)))))))
22189 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22190 (setq s (concat (substring s 0 b)
22191 (substring s (or (next-single-property-change
22192 b 'org-cwidth s)
22193 (length s))))))
22194 (setq l (string-width s) b -1)
22195 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22196 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22199 (defun org-shorten-string (s maxlength)
22200 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22201 If the string is shorter or has length MAXLENGTH, just return the
22202 original string. If it is longer, the functions finds a space in the
22203 string, breaks this string off at that locations and adds three dots
22204 as ellipsis. Including the ellipsis, the string will not be longer
22205 than MAXLENGTH. If finding a good breaking point in the string does
22206 not work, the string is just chopped off in the middle of a word
22207 if necessary."
22208 (if (<= (length s) maxlength)
22210 (let* ((n (max (- maxlength 4) 1))
22211 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22212 (if (string-match re s)
22213 (concat (match-string 1 s) "...")
22214 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22216 (defun org-get-indentation (&optional line)
22217 "Get the indentation of the current line, interpreting tabs.
22218 When LINE is given, assume it represents a line and compute its indentation."
22219 (if line
22220 (if (string-match "^ *" (org-remove-tabs line))
22221 (match-end 0))
22222 (save-excursion
22223 (beginning-of-line 1)
22224 (skip-chars-forward " \t")
22225 (current-column))))
22227 (defun org-get-string-indentation (s)
22228 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22229 (let ((n -1) (i 0) (w tab-width) c)
22230 (catch 'exit
22231 (while (< (setq n (1+ n)) (length s))
22232 (setq c (aref s n))
22233 (cond ((= c ?\ ) (setq i (1+ i)))
22234 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22235 (t (throw 'exit t)))))
22238 (defun org-remove-tabs (s &optional width)
22239 "Replace tabulators in S with spaces.
22240 Assumes that s is a single line, starting in column 0."
22241 (setq width (or width tab-width))
22242 (while (string-match "\t" s)
22243 (setq s (replace-match
22244 (make-string
22245 (- (* width (/ (+ (match-beginning 0) width) width))
22246 (match-beginning 0)) ?\ )
22247 t t s)))
22250 (defun org-fix-indentation (line ind)
22251 "Fix indentation in LINE.
22252 IND is a cons cell with target and minimum indentation.
22253 If the current indentation in LINE is smaller than the minimum,
22254 leave it alone. If it is larger than ind, set it to the target."
22255 (let* ((l (org-remove-tabs line))
22256 (i (org-get-indentation l))
22257 (i1 (car ind)) (i2 (cdr ind)))
22258 (if (>= i i2) (setq l (substring line i2)))
22259 (if (> i1 0)
22260 (concat (make-string i1 ?\ ) l)
22261 l)))
22263 (defun org-remove-indentation (code &optional n)
22264 "Remove the maximum common indentation from the lines in CODE.
22265 N may optionally be the number of spaces to remove."
22266 (with-temp-buffer
22267 (insert code)
22268 (org-do-remove-indentation n)
22269 (buffer-string)))
22271 (defun org-do-remove-indentation (&optional n)
22272 "Remove the maximum common indentation from the buffer."
22273 (untabify (point-min) (point-max))
22274 (let ((min 10000) re)
22275 (if n
22276 (setq min n)
22277 (goto-char (point-min))
22278 (while (re-search-forward "^ *[^ \n]" nil t)
22279 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22280 (unless (or (= min 0) (= min 10000))
22281 (setq re (format "^ \\{%d\\}" min))
22282 (goto-char (point-min))
22283 (while (re-search-forward re nil t)
22284 (replace-match "")
22285 (end-of-line 1))
22286 min)))
22288 (defun org-fill-template (template alist)
22289 "Find each %key of ALIST in TEMPLATE and replace it."
22290 (let ((case-fold-search nil))
22291 (dolist (entry (sort (copy-sequence alist)
22292 (lambda (a b) (< (length (car a)) (length (car b))))))
22293 (setq template
22294 (replace-regexp-in-string
22295 (concat "%" (regexp-quote (car entry)))
22296 (or (cdr entry) "") template t t)))
22297 template))
22299 (defun org-base-buffer (buffer)
22300 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22301 (if (not buffer)
22302 buffer
22303 (or (buffer-base-buffer buffer)
22304 buffer)))
22306 (defun org-wrap (string &optional width lines)
22307 "Wrap string to either a number of lines, or a width in characters.
22308 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22309 that costs. If there is a word longer than WIDTH, the text is actually
22310 wrapped to the length of that word.
22311 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22312 many lines, whatever width that takes.
22313 The return value is a list of lines, without newlines at the end."
22314 (let* ((words (org-split-string string "[ \t\n]+"))
22315 (maxword (apply 'max (mapcar 'org-string-width words)))
22316 w ll)
22317 (cond (width
22318 (org-do-wrap words (max maxword width)))
22319 (lines
22320 (setq w maxword)
22321 (setq ll (org-do-wrap words maxword))
22322 (if (<= (length ll) lines)
22324 (setq ll words)
22325 (while (> (length ll) lines)
22326 (setq w (1+ w))
22327 (setq ll (org-do-wrap words w)))
22328 ll))
22329 (t (error "Cannot wrap this")))))
22331 (defun org-do-wrap (words width)
22332 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22333 (let (lines line)
22334 (while words
22335 (setq line (pop words))
22336 (while (and words (< (+ (length line) (length (car words))) width))
22337 (setq line (concat line " " (pop words))))
22338 (setq lines (push line lines)))
22339 (nreverse lines)))
22341 (defun org-split-string (string &optional separators)
22342 "Splits STRING into substrings at SEPARATORS.
22343 SEPARATORS is a regular expression.
22344 No empty strings are returned if there are matches at the beginning
22345 and end of string."
22346 ;; FIXME: why not use (split-string STRING SEPARATORS t)?
22347 (let ((start 0) notfirst list)
22348 (while (and (string-match (or separators "[ \f\t\n\r\v]+") string
22349 (if (and notfirst
22350 (= start (match-beginning 0))
22351 (< start (length string)))
22352 (1+ start) start))
22353 (< (match-beginning 0) (length string)))
22354 (setq notfirst t)
22355 (or (eq (match-beginning 0) 0)
22356 (and (eq (match-beginning 0) (match-end 0))
22357 (eq (match-beginning 0) start))
22358 (push (substring string start (match-beginning 0)) list))
22359 (setq start (match-end 0)))
22360 (or (eq start (length string))
22361 (push (substring string start) list))
22362 (nreverse list)))
22364 (defun org-quote-vert (s)
22365 "Replace \"|\" with \"\\vert\"."
22366 (while (string-match "|" s)
22367 (setq s (replace-match "\\vert" t t s)))
22370 (defun org-uuidgen-p (s)
22371 "Is S an ID created by UUIDGEN?"
22372 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22374 (defun org-in-src-block-p (&optional inside)
22375 "Whether point is in a code source block.
22376 When INSIDE is non-nil, don't consider we are within a src block
22377 when point is at #+BEGIN_SRC or #+END_SRC."
22378 (let ((case-fold-search t) ov)
22379 (or (and (eq (get-char-property (point) 'src-block) t))
22380 (and (not inside)
22381 (save-match-data
22382 (save-excursion
22383 (beginning-of-line)
22384 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22386 (defun org-context ()
22387 "Return a list of contexts of the current cursor position.
22388 If several contexts apply, all are returned.
22389 Each context entry is a list with a symbol naming the context, and
22390 two positions indicating start and end of the context. Possible
22391 contexts are:
22393 :headline anywhere in a headline
22394 :headline-stars on the leading stars in a headline
22395 :todo-keyword on a TODO keyword (including DONE) in a headline
22396 :tags on the TAGS in a headline
22397 :priority on the priority cookie in a headline
22398 :item on the first line of a plain list item
22399 :item-bullet on the bullet/number of a plain list item
22400 :checkbox on the checkbox in a plain list item
22401 :table in an org-mode table
22402 :table-special on a special filed in a table
22403 :table-table in a table.el table
22404 :clocktable in a clocktable
22405 :src-block in a source block
22406 :link on a hyperlink
22407 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22408 :target on a <<target>>
22409 :radio-target on a <<<radio-target>>>
22410 :latex-fragment on a LaTeX fragment
22411 :latex-preview on a LaTeX fragment with overlaid preview image
22413 This function expects the position to be visible because it uses font-lock
22414 faces as a help to recognize the following contexts: :table-special, :link,
22415 and :keyword."
22416 (let* ((f (get-text-property (point) 'face))
22417 (faces (if (listp f) f (list f)))
22418 (case-fold-search t)
22419 (p (point)) clist o)
22420 ;; First the large context
22421 (cond
22422 ((org-at-heading-p t)
22423 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22424 (when (progn
22425 (beginning-of-line 1)
22426 (looking-at org-todo-line-tags-regexp))
22427 (push (org-point-in-group p 1 :headline-stars) clist)
22428 (push (org-point-in-group p 2 :todo-keyword) clist)
22429 (push (org-point-in-group p 4 :tags) clist))
22430 (goto-char p)
22431 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22432 (if (looking-at "\\[#[A-Z0-9]\\]")
22433 (push (org-point-in-group p 0 :priority) clist)))
22435 ((org-at-item-p)
22436 (push (org-point-in-group p 2 :item-bullet) clist)
22437 (push (list :item (point-at-bol)
22438 (save-excursion (org-end-of-item) (point)))
22439 clist)
22440 (and (org-at-item-checkbox-p)
22441 (push (org-point-in-group p 0 :checkbox) clist)))
22443 ((org-at-table-p)
22444 (push (list :table (org-table-begin) (org-table-end)) clist)
22445 (if (memq 'org-formula faces)
22446 (push (list :table-special
22447 (previous-single-property-change p 'face)
22448 (next-single-property-change p 'face)) clist)))
22449 ((org-at-table-p 'any)
22450 (push (list :table-table) clist)))
22451 (goto-char p)
22453 (let ((case-fold-search t))
22454 ;; New the "medium" contexts: clocktables, source blocks
22455 (cond ((org-in-clocktable-p)
22456 (push (list :clocktable
22457 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22458 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22459 (match-beginning 1))
22460 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22461 (match-end 0))) clist))
22462 ((org-in-src-block-p)
22463 (push (list :src-block
22464 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22465 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22466 (match-beginning 1))
22467 (and (search-forward "#+END_SRC" nil t)
22468 (match-beginning 0))) clist))))
22469 (goto-char p)
22471 ;; Now the small context
22472 (cond
22473 ((org-at-timestamp-p)
22474 (push (org-point-in-group p 0 :timestamp) clist))
22475 ((memq 'org-link faces)
22476 (push (list :link
22477 (previous-single-property-change p 'face)
22478 (next-single-property-change p 'face)) clist))
22479 ((memq 'org-special-keyword faces)
22480 (push (list :keyword
22481 (previous-single-property-change p 'face)
22482 (next-single-property-change p 'face)) clist))
22483 ((org-at-target-p)
22484 (push (org-point-in-group p 0 :target) clist)
22485 (goto-char (1- (match-beginning 0)))
22486 (if (looking-at org-radio-target-regexp)
22487 (push (org-point-in-group p 0 :radio-target) clist))
22488 (goto-char p))
22489 ((setq o (car (delq nil
22490 (mapcar
22491 (lambda (x)
22492 (if (memq x org-latex-fragment-image-overlays) x))
22493 (overlays-at (point))))))
22494 (push (list :latex-fragment
22495 (overlay-start o) (overlay-end o)) clist)
22496 (push (list :latex-preview
22497 (overlay-start o) (overlay-end o)) clist))
22498 ((org-inside-LaTeX-fragment-p)
22499 ;; FIXME: positions wrong.
22500 (push (list :latex-fragment (point) (point)) clist)))
22502 (setq clist (nreverse (delq nil clist)))
22503 clist))
22505 (defun org-in-regexp (re &optional nlines visually)
22506 "Check if point is inside a match of RE.
22508 Normally only the current line is checked, but you can include
22509 NLINES extra lines after point into the search. If VISUALLY is
22510 set, require that the cursor is not after the match but really
22511 on, so that the block visually is on the match."
22512 (catch 'exit
22513 (let ((pos (point))
22514 (eol (point-at-eol (+ 1 (or nlines 0))))
22515 (inc (if visually 1 0)))
22516 (save-excursion
22517 (beginning-of-line (- 1 (or nlines 0)))
22518 (while (re-search-forward re eol t)
22519 (if (and (<= (match-beginning 0) pos)
22520 (>= (+ inc (match-end 0)) pos))
22521 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22522 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22523 "Org mode 8.3")
22525 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22526 "Non-nil when point is between matches of START-RE and END-RE.
22528 Also return a non-nil value when point is on one of the matches.
22530 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22531 buffer positions. Default values are the positions of headlines
22532 surrounding the point.
22534 The functions returns a cons cell whose car (resp. cdr) is the
22535 position before START-RE (resp. after END-RE)."
22536 (save-match-data
22537 (let ((pos (point))
22538 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22539 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22540 beg end)
22541 (save-excursion
22542 ;; Point is on a block when on START-RE or if START-RE can be
22543 ;; found before it...
22544 (and (or (org-in-regexp start-re)
22545 (re-search-backward start-re limit-up t))
22546 (setq beg (match-beginning 0))
22547 ;; ... and END-RE after it...
22548 (goto-char (match-end 0))
22549 (re-search-forward end-re limit-down t)
22550 (> (setq end (match-end 0)) pos)
22551 ;; ... without another START-RE in-between.
22552 (goto-char (match-beginning 0))
22553 (not (re-search-backward start-re (1+ beg) t))
22554 ;; Return value.
22555 (cons beg end))))))
22557 (defun org-in-block-p (names)
22558 "Non-nil when point belongs to a block whose name belongs to NAMES.
22560 NAMES is a list of strings containing names of blocks.
22562 Return first block name matched, or nil. Beware that in case of
22563 nested blocks, the returned name may not belong to the closest
22564 block from point."
22565 (save-match-data
22566 (catch 'exit
22567 (let ((case-fold-search t)
22568 (lim-up (save-excursion (outline-previous-heading)))
22569 (lim-down (save-excursion (outline-next-heading))))
22570 (mapc (lambda (name)
22571 (let ((n (regexp-quote name)))
22572 (when (org-between-regexps-p
22573 (concat "^[ \t]*#\\+begin_" n)
22574 (concat "^[ \t]*#\\+end_" n)
22575 lim-up lim-down)
22576 (throw 'exit n))))
22577 names))
22578 nil)))
22580 (defun org-occur-in-agenda-files (regexp &optional _nlines)
22581 "Call `multi-occur' with buffers for all agenda files."
22582 (interactive "sOrg-files matching: ")
22583 (let* ((files (org-agenda-files))
22584 (tnames (mapcar #'file-truename files))
22585 (extra org-agenda-text-search-extra-files))
22586 (when (eq (car extra) 'agenda-archives)
22587 (setq extra (cdr extra))
22588 (setq files (org-add-archive-files files)))
22589 (dolist (f extra)
22590 (unless (member (file-truename f) tnames)
22591 (unless (member f files) (setq files (append files (list f))))
22592 (setq tnames (append tnames (list (file-truename f))))))
22593 (multi-occur
22594 (mapcar (lambda (x)
22595 (with-current-buffer
22596 ;; FIXME: Why not just (find-file-noselect x)?
22597 ;; Is it to avoid the "revert buffer" prompt?
22598 (or (get-file-buffer x) (find-file-noselect x))
22599 (widen)
22600 (current-buffer)))
22601 files)
22602 regexp)))
22604 (if (boundp 'occur-mode-find-occurrence-hook)
22605 ;; Emacs 23
22606 (add-hook 'occur-mode-find-occurrence-hook
22607 (lambda ()
22608 (when (derived-mode-p 'org-mode)
22609 (org-reveal))))
22610 ;; Emacs 22
22611 (defadvice occur-mode-goto-occurrence
22612 (after org-occur-reveal activate)
22613 (and (derived-mode-p 'org-mode) (org-reveal)))
22614 (defadvice occur-mode-goto-occurrence-other-window
22615 (after org-occur-reveal activate)
22616 (and (derived-mode-p 'org-mode) (org-reveal)))
22617 (defadvice occur-mode-display-occurrence
22618 (after org-occur-reveal activate)
22619 (when (derived-mode-p 'org-mode)
22620 (let ((pos (occur-mode-find-occurrence)))
22621 (with-current-buffer (marker-buffer pos)
22622 (save-excursion
22623 (goto-char pos)
22624 (org-reveal)))))))
22626 (defun org-occur-link-in-agenda-files ()
22627 "Create a link and search for it in the agendas.
22628 The link is not stored in `org-stored-links', it is just created
22629 for the search purpose."
22630 (interactive)
22631 (let ((link (condition-case nil
22632 (org-store-link nil)
22633 (error "Unable to create a link to here"))))
22634 (org-occur-in-agenda-files (regexp-quote link))))
22636 (defun org-reverse-string (string)
22637 "Return the reverse of STRING."
22638 (apply 'string (reverse (string-to-list string))))
22640 ;; defsubst org-uniquify must be defined before first use
22642 (defun org-uniquify-alist (alist)
22643 "Merge elements of ALIST with the same key.
22645 For example, in this alist:
22647 \(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
22648 => \\='((a 1 3) (b 2))
22650 merge (a 1) and (a 3) into (a 1 3).
22652 The function returns the new ALIST."
22653 (let (rtn)
22654 (mapc
22655 (lambda (e)
22656 (let (n)
22657 (if (not (assoc (car e) rtn))
22658 (push e rtn)
22659 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22660 (setq rtn (assq-delete-all (car e) rtn))
22661 (push n rtn))))
22662 alist)
22663 rtn))
22665 (defun org-delete-all (elts list)
22666 "Remove all elements in ELTS from LIST."
22667 (while elts
22668 (setq list (delete (pop elts) list)))
22669 list)
22671 (defun org-count (cl-item cl-seq)
22672 "Count the number of occurrences of ITEM in SEQ.
22673 Taken from `count' in cl-seq.el with all keyword arguments removed."
22674 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22675 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22676 (while (< cl-start cl-end)
22677 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22678 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22679 (setq cl-start (1+ cl-start)))
22680 cl-count))
22682 (defun org-remove-if (predicate seq)
22683 "Remove everything from SEQ that fulfills PREDICATE."
22684 (let (res e)
22685 (while seq
22686 (setq e (pop seq))
22687 (if (not (funcall predicate e)) (push e res)))
22688 (nreverse res)))
22690 (defun org-remove-if-not (predicate seq)
22691 "Remove everything from SEQ that does not fulfill PREDICATE."
22692 (let (res e)
22693 (while seq
22694 (setq e (pop seq))
22695 (if (funcall predicate e) (push e res)))
22696 (nreverse res)))
22698 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22699 "Reduce two-argument FUNCTION across SEQ.
22700 Taken from `reduce' in cl-seq.el with all keyword arguments but
22701 \":initial-value\" removed."
22702 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22703 (cadr (memq :initial-value cl-keys)))
22704 (cl-seq (pop cl-seq))
22705 (t (funcall cl-func)))))
22706 (while cl-seq
22707 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22708 cl-accum))
22710 (defun org-every (pred seq)
22711 "Return true if PREDICATE is true of every element of SEQ.
22712 Adapted from `every' in cl.el."
22713 (catch 'org-every
22714 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22717 (defun org-some (pred seq)
22718 "Return true if PREDICATE is true of any element of SEQ.
22719 Adapted from `some' in cl.el."
22720 (catch 'org-some
22721 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22722 nil))
22724 (defun org-back-over-empty-lines ()
22725 "Move backwards over whitespace, to the beginning of the first empty line.
22726 Returns the number of empty lines passed."
22727 (let ((pos (point)))
22728 (if (cdr (assoc 'heading org-blank-before-new-entry))
22729 (skip-chars-backward " \t\n\r")
22730 (unless (eobp)
22731 (forward-line -1)))
22732 (beginning-of-line 2)
22733 (goto-char (min (point) pos))
22734 (count-lines (point) pos)))
22736 (defun org-skip-whitespace ()
22737 (skip-chars-forward " \t\n\r"))
22739 (defun org-point-in-group (point group &optional context)
22740 "Check if POINT is in match-group GROUP.
22741 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22742 match. If the match group does not exist or point is not inside it,
22743 return nil."
22744 (and (match-beginning group)
22745 (>= point (match-beginning group))
22746 (<= point (match-end group))
22747 (if context
22748 (list context (match-beginning group) (match-end group))
22749 t)))
22751 (defun org-switch-to-buffer-other-window (&rest args)
22752 "Switch to buffer in a second window on the current frame.
22753 In particular, do not allow pop-up frames.
22754 Returns the newly created buffer."
22755 (org-no-popups
22756 (apply 'switch-to-buffer-other-window args)))
22758 (defun org-combine-plists (&rest plists)
22759 "Create a single property list from all plists in PLISTS.
22760 The process starts by copying the first list, and then setting properties
22761 from the other lists. Settings in the last list are the most significant
22762 ones and overrule settings in the other lists."
22763 (let ((rtn (copy-sequence (pop plists)))
22764 p v ls)
22765 (while plists
22766 (setq ls (pop plists))
22767 (while ls
22768 (setq p (pop ls) v (pop ls))
22769 (setq rtn (plist-put rtn p v))))
22770 rtn))
22772 (defun org-replace-escapes (string table)
22773 "Replace %-escapes in STRING with values in TABLE.
22774 TABLE is an association list with keys like \"%a\" and string values.
22775 The sequences in STRING may contain normal field width and padding information,
22776 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22777 so values can contain further %-escapes if they are define later in TABLE."
22778 (let ((tbl (copy-alist table))
22779 (case-fold-search nil)
22780 (pchg 0)
22781 e re rpl)
22782 (dolist (e tbl)
22783 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22784 (when (and (cdr e) (string-match re (cdr e)))
22785 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22786 (safe "SREF"))
22787 (add-text-properties 0 3 (list 'sref sref) safe)
22788 (setcdr e (replace-match safe t t (cdr e)))))
22789 (while (string-match re string)
22790 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22791 (cdr e)))
22792 (setq string (replace-match rpl t t string))))
22793 (while (setq pchg (next-property-change pchg string))
22794 (let ((sref (get-text-property pchg 'sref string)))
22795 (when (and sref (string-match "SREF" string pchg))
22796 (setq string (replace-match sref t t string)))))
22797 string))
22799 (defun org-sublist (list start end)
22800 "Return a section of LIST, from START to END.
22801 Counting starts at 1."
22802 (let (rtn (c start))
22803 (setq list (nthcdr (1- start) list))
22804 (while (and list (<= c end))
22805 (push (pop list) rtn)
22806 (setq c (1+ c)))
22807 (nreverse rtn)))
22809 (defun org-find-base-buffer-visiting (file)
22810 "Like `find-buffer-visiting' but always return the base buffer and
22811 not an indirect buffer."
22812 (let ((buf (or (get-file-buffer file)
22813 (find-buffer-visiting file))))
22814 (if buf
22815 (or (buffer-base-buffer buf) buf)
22816 nil)))
22818 (defun org-image-file-name-regexp (&optional extensions)
22819 "Return regexp matching the file names of images.
22820 If EXTENSIONS is given, only match these."
22821 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22822 (image-file-name-regexp)
22823 (let ((image-file-name-extensions
22824 (or extensions
22825 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22826 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22827 (concat "\\."
22828 (regexp-opt (nconc (mapcar 'upcase
22829 image-file-name-extensions)
22830 image-file-name-extensions)
22832 "\\'"))))
22834 (defun org-file-image-p (file &optional extensions)
22835 "Return non-nil if FILE is an image."
22836 (save-match-data
22837 (string-match (org-image-file-name-regexp extensions) file)))
22839 (defun org-get-cursor-date (&optional with-time)
22840 "Return the date at cursor in as a time.
22841 This works in the calendar and in the agenda, anywhere else it just
22842 returns the current time.
22843 If WITH-TIME is non-nil, returns the time of the event at point (in
22844 the agenda) or the current time of the day."
22845 (let (date day defd tp hod mod)
22846 (when with-time
22847 (setq tp (get-text-property (point) 'time))
22848 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22849 (setq hod (string-to-number (match-string 1 tp))
22850 mod (string-to-number (match-string 2 tp))))
22851 (or tp (let ((now (decode-time)))
22852 (setq hod (nth 2 now)
22853 mod (nth 1 now)))))
22854 (cond
22855 ((eq major-mode 'calendar-mode)
22856 (setq date (calendar-cursor-to-date)
22857 defd (encode-time 0 (or mod 0) (or hod 0)
22858 (nth 1 date) (nth 0 date) (nth 2 date))))
22859 ((eq major-mode 'org-agenda-mode)
22860 (setq day (get-text-property (point) 'day))
22861 (if day
22862 (setq date (calendar-gregorian-from-absolute day)
22863 defd (encode-time 0 (or mod 0) (or hod 0)
22864 (nth 1 date) (nth 0 date) (nth 2 date))))))
22865 (or defd (current-time))))
22867 (defun org-mark-subtree (&optional up)
22868 "Mark the current subtree.
22869 This puts point at the start of the current subtree, and mark at
22870 the end. If a numeric prefix UP is given, move up into the
22871 hierarchy of headlines by UP levels before marking the subtree."
22872 (interactive "P")
22873 (org-with-limited-levels
22874 (cond ((org-at-heading-p) (beginning-of-line))
22875 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22876 (t (outline-previous-visible-heading 1))))
22877 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22878 (if (org-called-interactively-p 'any)
22879 (call-interactively 'org-mark-element)
22880 (org-mark-element)))
22883 ;;; Indentation
22885 (defun org--get-expected-indentation (element contentsp)
22886 "Expected indentation column for current line, according to ELEMENT.
22887 ELEMENT is an element containing point. CONTENTSP is non-nil
22888 when indentation is to be computed according to contents of
22889 ELEMENT."
22890 (let ((type (org-element-type element))
22891 (start (org-element-property :begin element))
22892 (post-affiliated (org-element-property :post-affiliated element)))
22893 (org-with-wide-buffer
22894 (cond
22895 (contentsp
22896 (case type
22897 ((diary-sexp footnote-definition) 0)
22898 ((headline inlinetask nil)
22899 (if (not org-adapt-indentation) 0
22900 (let ((level (org-current-level)))
22901 (if level (1+ level) 0))))
22902 ((item plain-list) (org-list-item-body-column post-affiliated))
22904 (goto-char start)
22905 (org-get-indentation))))
22906 ((memq type '(headline inlinetask nil))
22907 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22908 (org--get-expected-indentation element t)
22910 ((memq type '(diary-sexp footnote-definition)) 0)
22911 ;; First paragraph of a footnote definition or an item.
22912 ;; Indent like parent.
22913 ((< (line-beginning-position) start)
22914 (org--get-expected-indentation
22915 (org-element-property :parent element) t))
22916 ;; At first line: indent according to previous sibling, if any,
22917 ;; ignoring footnote definitions and inline tasks, or parent's
22918 ;; contents.
22919 ((= (line-beginning-position) start)
22920 (catch 'exit
22921 (while t
22922 (if (= (point-min) start) (throw 'exit 0)
22923 (goto-char (1- start))
22924 (let* ((previous (org-element-at-point))
22925 (parent previous))
22926 (while (and parent (<= (org-element-property :end parent) start))
22927 (setq previous parent
22928 parent (org-element-property :parent parent)))
22929 (cond
22930 ((not previous) (throw 'exit 0))
22931 ((> (org-element-property :end previous) start)
22932 (throw 'exit (org--get-expected-indentation previous t)))
22933 ((memq (org-element-type previous)
22934 '(footnote-definition inlinetask))
22935 (setq start (org-element-property :begin previous)))
22936 (t (goto-char (org-element-property :begin previous))
22937 (throw 'exit
22938 (if (bolp) (org-get-indentation)
22939 ;; At first paragraph in an item or
22940 ;; a footnote definition.
22941 (org--get-expected-indentation
22942 (org-element-property :parent previous) t))))))))))
22943 ;; Otherwise, move to the first non-blank line above.
22945 (beginning-of-line)
22946 (let ((pos (point)))
22947 (skip-chars-backward " \r\t\n")
22948 (cond
22949 ;; Two blank lines end a footnote definition or a plain
22950 ;; list. When we indent an empty line after them, the
22951 ;; containing list or footnote definition is over, so it
22952 ;; qualifies as a previous sibling. Therefore, we indent
22953 ;; like its first line.
22954 ((and (memq type '(footnote-definition plain-list))
22955 (> (count-lines (point) pos) 2))
22956 (goto-char start)
22957 (org-get-indentation))
22958 ;; Line above is the first one of a paragraph at the
22959 ;; beginning of an item or a footnote definition. Indent
22960 ;; like parent.
22961 ((< (line-beginning-position) start)
22962 (org--get-expected-indentation
22963 (org-element-property :parent element) t))
22964 ;; Line above is the beginning of an element, i.e., point
22965 ;; was originally on the blank lines between element's start
22966 ;; and contents.
22967 ((= (line-beginning-position) post-affiliated)
22968 (org--get-expected-indentation element t))
22969 ;; POS is after contents in a greater element. Indent like
22970 ;; the beginning of the element.
22972 ;; As a special case, if point is at the end of a footnote
22973 ;; definition or an item, indent like the very last element
22974 ;; within.
22975 ((and (not (eq type 'paragraph))
22976 (let ((cend (org-element-property :contents-end element)))
22977 (and cend (<= cend pos))))
22978 (if (memq type '(footnote-definition item plain-list))
22979 (let ((last (org-element-at-point)))
22980 (org--get-expected-indentation
22981 last
22982 (memq (org-element-type last)
22983 '(footnote-definition item plain-list))))
22984 (goto-char start)
22985 (org-get-indentation)))
22986 ;; In any other case, indent like the current line.
22987 (t (org-get-indentation)))))))))
22989 (defun org--align-node-property ()
22990 "Align node property at point.
22991 Alignment is done according to `org-property-format', which see."
22992 (when (save-excursion
22993 (beginning-of-line)
22994 (looking-at org-property-re))
22995 (replace-match
22996 (concat (match-string 4)
22997 (org-trim
22998 (format org-property-format (match-string 1) (match-string 3))))
22999 t t)))
23001 (defun org-indent-line ()
23002 "Indent line depending on context.
23004 Indentation is done according to the following rules:
23006 - Footnote definitions, diary sexps, headlines and inline tasks
23007 have to start at column 0.
23009 - On the very first line of an element, consider, in order, the
23010 next rules until one matches:
23012 1. If there's a sibling element before, ignoring footnote
23013 definitions and inline tasks, indent like its first line.
23015 2. If element has a parent, indent like its contents. More
23016 precisely, if parent is an item, indent after the
23017 description part, if any, or the bullet (see
23018 `org-list-description-max-indent'). Else, indent like
23019 parent's first line.
23021 3. Otherwise, indent relatively to current level, if
23022 `org-adapt-indentation' is non-nil, or to left margin.
23024 - On a blank line at the end of an element, indent according to
23025 the type of the element. More precisely
23027 1. If element is a plain list, an item, or a footnote
23028 definition, indent like the very last element within.
23030 2. If element is a paragraph, indent like its last non blank
23031 line.
23033 3. Otherwise, indent like its very first line.
23035 - In the code part of a source block, use language major mode
23036 to indent current line if `org-src-tab-acts-natively' is
23037 non-nil. If it is nil, do nothing.
23039 - Otherwise, indent like the first non-blank line above.
23041 The function doesn't indent an item as it could break the whole
23042 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
23043 \\[org-shiftmetaright].
23045 Also align node properties according to `org-property-format'."
23046 (interactive)
23047 (cond
23048 (orgstruct-is-++
23049 (let ((indent-line-function
23050 (cadadr (assq 'indent-line-function org-fb-vars))))
23051 (indent-according-to-mode)))
23052 ((org-at-heading-p) 'noindent)
23054 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23055 (type (org-element-type element)))
23056 (cond ((and (memq type '(plain-list item))
23057 (= (line-beginning-position)
23058 (org-element-property :post-affiliated element)))
23059 'noindent)
23060 ((and (eq type 'src-block)
23061 org-src-tab-acts-natively
23062 (> (line-beginning-position)
23063 (org-element-property :post-affiliated element))
23064 (< (line-beginning-position)
23065 (org-with-wide-buffer
23066 (goto-char (org-element-property :end element))
23067 (skip-chars-backward " \r\t\n")
23068 (line-beginning-position))))
23069 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23071 (let ((column (org--get-expected-indentation element nil)))
23072 ;; Preserve current column.
23073 (if (<= (current-column) (current-indentation))
23074 (org-indent-line-to column)
23075 (save-excursion (org-indent-line-to column))))
23076 ;; Align node property. Also preserve current column.
23077 (when (eq type 'node-property)
23078 (let ((column (current-column)))
23079 (org--align-node-property)
23080 (org-move-to-column column)))))))))
23082 (defun org-indent-region (start end)
23083 "Indent each non-blank line in the region.
23084 Called from a program, START and END specify the region to
23085 indent. The function will not indent contents of example blocks,
23086 verse blocks and export blocks as leading white spaces are
23087 assumed to be significant there."
23088 (interactive "r")
23089 (save-excursion
23090 (goto-char start)
23091 (skip-chars-forward " \r\t\n")
23092 (unless (eobp) (beginning-of-line))
23093 (let ((indent-to
23094 (lambda (ind pos)
23095 ;; Set IND as indentation for all lines between point and
23096 ;; POS or END, whichever comes first. Blank lines are
23097 ;; ignored. Leave point after POS once done.
23098 (let ((limit (copy-marker (min end pos))))
23099 (while (< (point) limit)
23100 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23101 (forward-line))
23102 (set-marker limit nil))))
23103 (end (copy-marker end)))
23104 (while (< (point) end)
23105 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23106 (let* ((element (org-element-at-point))
23107 (type (org-element-type element))
23108 (element-end (copy-marker (org-element-property :end element)))
23109 (ind (org--get-expected-indentation element nil)))
23110 (cond
23111 ((or (memq type '(paragraph table table-row))
23112 (not (or (org-element-property :contents-begin element)
23113 (memq type
23114 '(example-block export-block src-block)))))
23115 ;; Elements here are indented as a single block. Also
23116 ;; align node properties.
23117 (when (eq type 'node-property)
23118 (org--align-node-property)
23119 (beginning-of-line))
23120 (funcall indent-to ind element-end))
23122 ;; Elements in this category consist of three parts:
23123 ;; before the contents, the contents, and after the
23124 ;; contents. The contents are treated specially,
23125 ;; according to the element type, or not indented at
23126 ;; all. Other parts are indented as a single block.
23127 (let* ((post (copy-marker
23128 (org-element-property :post-affiliated element)))
23129 (cbeg
23130 (copy-marker
23131 (cond
23132 ((not (org-element-property :contents-begin element))
23133 ;; Fake contents for source blocks.
23134 (org-with-wide-buffer
23135 (goto-char post)
23136 (forward-line)
23137 (point)))
23138 ((memq type '(footnote-definition item plain-list))
23139 ;; Contents in these elements could start on
23140 ;; the same line as the beginning of the
23141 ;; element. Make sure we start indenting
23142 ;; from the second line.
23143 (org-with-wide-buffer
23144 (goto-char post)
23145 (end-of-line)
23146 (skip-chars-forward " \r\t\n")
23147 (if (eobp) (point) (line-beginning-position))))
23148 (t (org-element-property :contents-begin element)))))
23149 (cend (copy-marker
23150 (or (org-element-property :contents-end element)
23151 ;; Fake contents for source blocks.
23152 (org-with-wide-buffer
23153 (goto-char element-end)
23154 (skip-chars-backward " \r\t\n")
23155 (line-beginning-position)))
23156 t)))
23157 ;; Do not change items indentation individually as it
23158 ;; might break the list as a whole. On the other
23159 ;; hand, when at a plain list, indent it as a whole.
23160 (cond ((eq type 'plain-list)
23161 (let ((offset (- ind (org-get-indentation))))
23162 (unless (zerop offset)
23163 (indent-rigidly (org-element-property :begin element)
23164 (org-element-property :end element)
23165 offset))
23166 (goto-char cbeg)))
23167 ((eq type 'item) (goto-char cbeg))
23168 (t (funcall indent-to ind cbeg)))
23169 (when (< (point) end)
23170 (case type
23171 ((example-block export-block verse-block))
23172 (src-block
23173 ;; In a source block, indent source code
23174 ;; according to language major mode, but only if
23175 ;; `org-src-tab-acts-natively' is non-nil.
23176 (when (and (< (point) end) org-src-tab-acts-natively)
23177 (ignore-errors
23178 (org-babel-do-in-edit-buffer
23179 (indent-region (point-min) (point-max))))))
23180 (t (org-indent-region (point) (min cend end))))
23181 (goto-char (min cend end))
23182 (when (< (point) end) (funcall indent-to ind element-end)))
23183 (set-marker post nil)
23184 (set-marker cbeg nil)
23185 (set-marker cend nil))))
23186 (set-marker element-end nil))))
23187 (set-marker end nil))))
23189 (defun org-indent-drawer ()
23190 "Indent the drawer at point."
23191 (interactive)
23192 (unless (save-excursion
23193 (beginning-of-line)
23194 (org-looking-at-p org-drawer-regexp))
23195 (user-error "Not at a drawer"))
23196 (let ((element (org-element-at-point)))
23197 (unless (memq (org-element-type element) '(drawer property-drawer))
23198 (user-error "Not at a drawer"))
23199 (org-with-wide-buffer
23200 (org-indent-region (org-element-property :begin element)
23201 (org-element-property :end element))))
23202 (message "Drawer at point indented"))
23204 (defun org-indent-block ()
23205 "Indent the block at point."
23206 (interactive)
23207 (unless (save-excursion
23208 (beginning-of-line)
23209 (let ((case-fold-search t))
23210 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23211 (user-error "Not at a block"))
23212 (let ((element (org-element-at-point)))
23213 (unless (memq (org-element-type element)
23214 '(comment-block center-block dynamic-block example-block
23215 export-block quote-block special-block
23216 src-block verse-block))
23217 (user-error "Not at a block"))
23218 (org-with-wide-buffer
23219 (org-indent-region (org-element-property :begin element)
23220 (org-element-property :end element))))
23221 (message "Block at point indented"))
23224 ;;; Filling
23226 ;; We use our own fill-paragraph and auto-fill functions.
23228 ;; `org-fill-paragraph' relies on adaptive filling and context
23229 ;; checking. Appropriate `fill-prefix' is computed with
23230 ;; `org-adaptive-fill-function'.
23232 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23233 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23234 ;; `org-adaptive-fill-function' value. Internally,
23235 ;; `org-comment-line-break-function' breaks the line.
23237 ;; `org-setup-filling' installs filling and auto-filling related
23238 ;; variables during `org-mode' initialization.
23240 (defvar org-element-paragraph-separate) ; org-element.el
23241 (defun org-setup-filling ()
23242 (require 'org-element)
23243 ;; Prevent auto-fill from inserting unwanted new items.
23244 (when (boundp 'fill-nobreak-predicate)
23245 (org-set-local
23246 'fill-nobreak-predicate
23247 (org-uniquify
23248 (append fill-nobreak-predicate
23249 '(org-fill-line-break-nobreak-p
23250 org-fill-paragraph-with-timestamp-nobreak-p)))))
23251 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23252 (org-set-local 'paragraph-start paragraph-ending)
23253 (org-set-local 'paragraph-separate paragraph-ending))
23254 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23255 (org-set-local 'auto-fill-inhibit-regexp nil)
23256 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23257 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23258 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23260 (defun org-fill-line-break-nobreak-p ()
23261 "Non-nil when a new line at point would create an Org line break."
23262 (save-excursion
23263 (skip-chars-backward "[ \t]")
23264 (skip-chars-backward "\\\\")
23265 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23267 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23268 "Non-nil when a new line at point would split a timestamp."
23269 (and (org-at-timestamp-p t)
23270 (not (looking-at org-ts-regexp-both))))
23272 (declare-function message-in-body-p "message" ())
23273 (defvar orgtbl-line-start-regexp) ; From org-table.el
23274 (defun org-adaptive-fill-function ()
23275 "Compute a fill prefix for the current line.
23276 Return fill prefix, as a string, or nil if current line isn't
23277 meant to be filled. For convenience, if `adaptive-fill-regexp'
23278 matches in paragraphs or comments, use it."
23279 (catch 'exit
23280 (when (derived-mode-p 'message-mode)
23281 (save-excursion
23282 (beginning-of-line)
23283 (cond ((not (message-in-body-p)) (throw 'exit nil))
23284 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23285 ((looking-at message-cite-prefix-regexp)
23286 (throw 'exit (match-string-no-properties 0)))
23287 ((looking-at org-outline-regexp)
23288 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23289 (org-with-wide-buffer
23290 (unless (org-at-heading-p)
23291 (let* ((p (line-beginning-position))
23292 (element (save-excursion
23293 (beginning-of-line)
23294 (org-element-at-point)))
23295 (type (org-element-type element))
23296 (post-affiliated (org-element-property :post-affiliated element)))
23297 (unless (< p post-affiliated)
23298 (case type
23299 (comment
23300 (save-excursion
23301 (beginning-of-line)
23302 (looking-at "[ \t]*")
23303 (concat (match-string 0) "# ")))
23304 (footnote-definition "")
23305 ((item plain-list)
23306 (make-string (org-list-item-body-column post-affiliated) ?\s))
23307 (paragraph
23308 ;; Fill prefix is usually the same as the current line,
23309 ;; unless the paragraph is at the beginning of an item.
23310 (let ((parent (org-element-property :parent element)))
23311 (save-excursion
23312 (beginning-of-line)
23313 (cond ((eq (org-element-type parent) 'item)
23314 (make-string (org-list-item-body-column
23315 (org-element-property :begin parent))
23316 ?\s))
23317 ((and adaptive-fill-regexp
23318 ;; Locally disable
23319 ;; `adaptive-fill-function' to let
23320 ;; `fill-context-prefix' handle
23321 ;; `adaptive-fill-regexp' variable.
23322 (let (adaptive-fill-function)
23323 (fill-context-prefix
23324 post-affiliated
23325 (org-element-property :end element)))))
23326 ((looking-at "[ \t]+") (match-string 0))
23327 (t "")))))
23328 (comment-block
23329 ;; Only fill contents if P is within block boundaries.
23330 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23331 (forward-line)
23332 (point)))
23333 (cend (save-excursion
23334 (goto-char (org-element-property :end element))
23335 (skip-chars-backward " \r\t\n")
23336 (line-beginning-position))))
23337 (when (and (>= p cbeg) (< p cend))
23338 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23339 (match-string 0)
23340 "")))))))))))
23342 (declare-function message-goto-body "message" ())
23343 (defvar message-cite-prefix-regexp) ; From message.el
23344 (defun org-fill-paragraph (&optional justify)
23345 "Fill element at point, when applicable.
23347 This function only applies to comment blocks, comments, example
23348 blocks and paragraphs. Also, as a special case, re-align table
23349 when point is at one.
23351 If JUSTIFY is non-nil (interactively, with prefix argument),
23352 justify as well. If `sentence-end-double-space' is non-nil, then
23353 period followed by one space does not end a sentence, so don't
23354 break a line there. The variable `fill-column' controls the
23355 width for filling.
23357 For convenience, when point is at a plain list, an item or
23358 a footnote definition, try to fill the first paragraph within."
23359 (interactive)
23360 (if (and (derived-mode-p 'message-mode)
23361 (or (not (message-in-body-p))
23362 (save-excursion (move-beginning-of-line 1)
23363 (looking-at message-cite-prefix-regexp))))
23364 ;; First ensure filling is correct in message-mode.
23365 (let ((fill-paragraph-function
23366 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23367 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23368 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23369 (paragraph-separate
23370 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23371 (fill-paragraph nil))
23372 (with-syntax-table org-mode-transpose-word-syntax-table
23373 ;; Move to end of line in order to get the first paragraph
23374 ;; within a plain list or a footnote definition.
23375 (let ((element (save-excursion
23376 (end-of-line)
23377 (or (ignore-errors (org-element-at-point))
23378 (user-error "An element cannot be parsed line %d"
23379 (line-number-at-pos (point)))))))
23380 ;; First check if point is in a blank line at the beginning of
23381 ;; the buffer. In that case, ignore filling.
23382 (case (org-element-type element)
23383 ;; Use major mode filling function is src blocks.
23384 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23385 ;; Align Org tables, leave table.el tables as-is.
23386 (table-row (org-table-align) t)
23387 (table
23388 (when (eq (org-element-property :type element) 'org)
23389 (save-excursion
23390 (goto-char (org-element-property :post-affiliated element))
23391 (org-table-align)))
23393 (paragraph
23394 ;; Paragraphs may contain `line-break' type objects.
23395 (let ((beg (max (point-min)
23396 (org-element-property :contents-begin element)))
23397 (end (min (point-max)
23398 (org-element-property :contents-end element))))
23399 ;; Do nothing if point is at an affiliated keyword.
23400 (if (< (line-end-position) beg) t
23401 (when (derived-mode-p 'message-mode)
23402 ;; In `message-mode', do not fill following citation
23403 ;; in current paragraph nor text before message body.
23404 (let ((body-start (save-excursion (message-goto-body))))
23405 (when body-start (setq beg (max body-start beg))))
23406 (when (save-excursion
23407 (re-search-forward
23408 (concat "^" message-cite-prefix-regexp) end t))
23409 (setq end (match-beginning 0))))
23410 ;; Fill paragraph, taking line breaks into account.
23411 (save-excursion
23412 (goto-char beg)
23413 (let ((cuts (list beg)))
23414 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23415 (when (eq 'line-break
23416 (org-element-type
23417 (save-excursion (backward-char)
23418 (org-element-context))))
23419 (push (point) cuts)))
23420 (dolist (c (delq end cuts))
23421 (fill-region-as-paragraph c end justify)
23422 (setq end c))))
23423 t)))
23424 ;; Contents of `comment-block' type elements should be
23425 ;; filled as plain text, but only if point is within block
23426 ;; markers.
23427 (comment-block
23428 (let* ((case-fold-search t)
23429 (beg (save-excursion
23430 (goto-char (org-element-property :begin element))
23431 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23432 (forward-line)
23433 (point)))
23434 (end (save-excursion
23435 (goto-char (org-element-property :end element))
23436 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23437 (line-beginning-position))))
23438 (if (or (< (point) beg) (> (point) end)) t
23439 (fill-region-as-paragraph
23440 (save-excursion (end-of-line)
23441 (re-search-backward "^[ \t]*$" beg 'move)
23442 (line-beginning-position))
23443 (save-excursion (beginning-of-line)
23444 (re-search-forward "^[ \t]*$" end 'move)
23445 (line-beginning-position))
23446 justify))))
23447 ;; Fill comments.
23448 (comment
23449 (let ((begin (org-element-property :post-affiliated element))
23450 (end (org-element-property :end element)))
23451 (when (and (>= (point) begin) (<= (point) end))
23452 (let ((begin (save-excursion
23453 (end-of-line)
23454 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23455 (progn (forward-line) (point))
23456 begin)))
23457 (end (save-excursion
23458 (end-of-line)
23459 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23460 (1- (line-beginning-position))
23461 (skip-chars-backward " \r\t\n")
23462 (line-end-position)))))
23463 ;; Do not fill comments when at a blank line.
23464 (when (> end begin)
23465 (let ((fill-prefix
23466 (save-excursion
23467 (beginning-of-line)
23468 (looking-at "[ \t]*#")
23469 (let ((comment-prefix (match-string 0)))
23470 (goto-char (match-end 0))
23471 (if (looking-at adaptive-fill-regexp)
23472 (concat comment-prefix (match-string 0))
23473 (concat comment-prefix " "))))))
23474 (save-excursion
23475 (fill-region-as-paragraph begin end justify))))))
23477 ;; Ignore every other element.
23478 (otherwise t))))))
23480 (defun org-auto-fill-function ()
23481 "Auto-fill function."
23482 ;; Check if auto-filling is meaningful.
23483 (let ((fc (current-fill-column)))
23484 (when (and fc (> (current-column) fc))
23485 (let* ((fill-prefix (org-adaptive-fill-function))
23486 ;; Enforce empty fill prefix, if required. Otherwise, it
23487 ;; will be computed again.
23488 (adaptive-fill-mode (not (equal fill-prefix ""))))
23489 (when fill-prefix (do-auto-fill))))))
23491 (defun org-comment-line-break-function (&optional soft)
23492 "Break line at point and indent, continuing comment if within one.
23493 The inserted newline is marked hard if variable
23494 `use-hard-newlines' is true, unless optional argument SOFT is
23495 non-nil."
23496 (if soft (insert-and-inherit ?\n) (newline 1))
23497 (save-excursion (forward-char -1) (delete-horizontal-space))
23498 (delete-horizontal-space)
23499 (indent-to-left-margin)
23500 (insert-before-markers-and-inherit fill-prefix))
23503 ;;; Fixed Width Areas
23505 (defun org-toggle-fixed-width ()
23506 "Toggle fixed-width markup.
23508 Add or remove fixed-width markup on current line, whenever it
23509 makes sense. Return an error otherwise.
23511 If a region is active and if it contains only fixed-width areas
23512 or blank lines, remove all fixed-width markup in it. If the
23513 region contains anything else, convert all non-fixed-width lines
23514 to fixed-width ones.
23516 Blank lines at the end of the region are ignored unless the
23517 region only contains such lines."
23518 (interactive)
23519 (if (not (org-region-active-p))
23520 ;; No region:
23522 ;; Remove fixed width marker only in a fixed-with element.
23524 ;; Add fixed width maker in paragraphs, in blank lines after
23525 ;; elements or at the beginning of a headline or an inlinetask,
23526 ;; and before any one-line elements (e.g., a clock).
23527 (progn
23528 (beginning-of-line)
23529 (let* ((element (org-element-at-point))
23530 (type (org-element-type element)))
23531 (cond
23532 ((and (eq type 'fixed-width)
23533 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23534 (replace-match
23535 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23536 ((and (memq type '(babel-call clock comment diary-sexp headline
23537 horizontal-rule keyword paragraph
23538 planning))
23539 (<= (org-element-property :post-affiliated element) (point)))
23540 (skip-chars-forward " \t")
23541 (insert ": "))
23542 ((and (org-looking-at-p "[ \t]*$")
23543 (or (eq type 'inlinetask)
23544 (save-excursion
23545 (skip-chars-forward " \r\t\n")
23546 (<= (org-element-property :end element) (point)))))
23547 (delete-region (point) (line-end-position))
23548 (org-indent-line)
23549 (insert ": "))
23550 (t (user-error "Cannot insert a fixed-width line here")))))
23551 ;; Region active.
23552 (let* ((begin (save-excursion
23553 (goto-char (region-beginning))
23554 (line-beginning-position)))
23555 (end (copy-marker
23556 (save-excursion
23557 (goto-char (region-end))
23558 (unless (eolp) (beginning-of-line))
23559 (if (save-excursion (re-search-backward "\\S-" begin t))
23560 (progn (skip-chars-backward " \r\t\n") (point))
23561 (point)))))
23562 (all-fixed-width-p
23563 (catch 'not-all-p
23564 (save-excursion
23565 (goto-char begin)
23566 (skip-chars-forward " \r\t\n")
23567 (when (eobp) (throw 'not-all-p nil))
23568 (while (< (point) end)
23569 (let ((element (org-element-at-point)))
23570 (if (eq (org-element-type element) 'fixed-width)
23571 (goto-char (org-element-property :end element))
23572 (throw 'not-all-p nil))))
23573 t))))
23574 (if all-fixed-width-p
23575 (save-excursion
23576 (goto-char begin)
23577 (while (< (point) end)
23578 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23579 (replace-match
23580 "" nil nil nil
23581 (if (= (line-end-position) (match-end 0)) 0 1)))
23582 (forward-line)))
23583 (let ((min-ind (point-max)))
23584 ;; Find minimum indentation across all lines.
23585 (save-excursion
23586 (goto-char begin)
23587 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23588 (setq min-ind 0)
23589 (catch 'zerop
23590 (while (< (point) end)
23591 (unless (org-looking-at-p "[ \t]*$")
23592 (let ((ind (org-get-indentation)))
23593 (setq min-ind (min min-ind ind))
23594 (when (zerop ind) (throw 'zerop t))))
23595 (forward-line)))))
23596 ;; Loop over all lines and add fixed-width markup everywhere
23597 ;; but in fixed-width lines.
23598 (save-excursion
23599 (goto-char begin)
23600 (while (< (point) end)
23601 (cond
23602 ((org-at-heading-p)
23603 (insert ": ")
23604 (forward-line)
23605 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23606 (insert ":")
23607 (forward-line)))
23608 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23609 (let* ((element (org-element-at-point))
23610 (element-end (org-element-property :end element)))
23611 (if (eq (org-element-type element) 'fixed-width)
23612 (progn (goto-char element-end)
23613 (skip-chars-backward " \r\t\n")
23614 (forward-line))
23615 (let ((limit (min end element-end)))
23616 (while (< (point) limit)
23617 (org-move-to-column min-ind t)
23618 (insert ": ")
23619 (forward-line))))))
23621 (org-move-to-column min-ind t)
23622 (insert ": ")
23623 (forward-line)))))))
23624 (set-marker end nil))))
23627 ;;; Comments
23629 ;; Org comments syntax is quite complex. It requires the entire line
23630 ;; to be just a comment. Also, even with the right syntax at the
23631 ;; beginning of line, some some elements (i.e. verse-block or
23632 ;; example-block) don't accept comments. Usual Emacs comment commands
23633 ;; cannot cope with those requirements. Therefore, Org replaces them.
23635 ;; Org still relies on `comment-dwim', but cannot trust
23636 ;; `comment-only-p'. So, `comment-region-function' and
23637 ;; `uncomment-region-function' both point
23638 ;; to`org-comment-or-uncomment-region'. Eventually,
23639 ;; `org-insert-comment' takes care of insertion of comments at the
23640 ;; beginning of line.
23642 ;; `org-setup-comments-handling' install comments related variables
23643 ;; during `org-mode' initialization.
23645 (defun org-setup-comments-handling ()
23646 (interactive)
23647 (org-set-local 'comment-use-syntax nil)
23648 (org-set-local 'comment-start "# ")
23649 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23650 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23651 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23652 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23654 (defun org-insert-comment ()
23655 "Insert an empty comment above current line.
23656 If the line is empty, insert comment at its beginning. When
23657 point is within a source block, comment according to the related
23658 major mode."
23659 (if (let ((element (org-element-at-point)))
23660 (and (eq (org-element-type element) 'src-block)
23661 (< (save-excursion
23662 (goto-char (org-element-property :post-affiliated element))
23663 (line-end-position))
23664 (point))
23665 (> (save-excursion
23666 (goto-char (org-element-property :end element))
23667 (skip-chars-backward " \r\t\n")
23668 (line-beginning-position))
23669 (point))))
23670 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23671 (beginning-of-line)
23672 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23673 (open-line 1))
23674 (org-indent-line)
23675 (insert "# ")))
23677 (defvar comment-empty-lines) ; From newcomment.el.
23678 (defun org-comment-or-uncomment-region (beg end &rest _)
23679 "Comment or uncomment each non-blank line in the region.
23680 Uncomment each non-blank line between BEG and END if it only
23681 contains commented lines. Otherwise, comment them. If region is
23682 strictly within a source block, use appropriate comment syntax."
23683 (if (let ((element (org-element-at-point)))
23684 (and (eq (org-element-type element) 'src-block)
23685 (< (save-excursion
23686 (goto-char (org-element-property :post-affiliated element))
23687 (line-end-position))
23688 beg)
23689 (>= (save-excursion
23690 (goto-char (org-element-property :end element))
23691 (skip-chars-backward " \r\t\n")
23692 (line-beginning-position))
23693 end)))
23694 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23695 (save-restriction
23696 ;; Restrict region
23697 (narrow-to-region (save-excursion (goto-char beg)
23698 (skip-chars-forward " \r\t\n" end)
23699 (line-beginning-position))
23700 (save-excursion (goto-char end)
23701 (skip-chars-backward " \r\t\n" beg)
23702 (line-end-position)))
23703 (let ((uncommentp
23704 ;; UNCOMMENTP is non-nil when every non blank line between
23705 ;; BEG and END is a comment.
23706 (save-excursion
23707 (goto-char (point-min))
23708 (while (and (not (eobp))
23709 (let ((element (org-element-at-point)))
23710 (and (eq (org-element-type element) 'comment)
23711 (goto-char (min (point-max)
23712 (org-element-property
23713 :end element)))))))
23714 (eobp))))
23715 (if uncommentp
23716 ;; Only blank lines and comments in region: uncomment it.
23717 (save-excursion
23718 (goto-char (point-min))
23719 (while (not (eobp))
23720 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23721 (replace-match "" nil nil nil 1))
23722 (forward-line)))
23723 ;; Comment each line in region.
23724 (let ((min-indent (point-max)))
23725 ;; First find the minimum indentation across all lines.
23726 (save-excursion
23727 (goto-char (point-min))
23728 (while (and (not (eobp)) (not (zerop min-indent)))
23729 (unless (looking-at "[ \t]*$")
23730 (setq min-indent (min min-indent (current-indentation))))
23731 (forward-line)))
23732 ;; Then loop over all lines.
23733 (save-excursion
23734 (goto-char (point-min))
23735 (while (not (eobp))
23736 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23737 ;; Don't get fooled by invisible text (e.g. link path)
23738 ;; when moving to column MIN-INDENT.
23739 (let ((buffer-invisibility-spec nil))
23740 (org-move-to-column min-indent t))
23741 (insert comment-start))
23742 (forward-line)))))))))
23744 (defun org-comment-dwim (arg)
23745 "Call `comment-dwim' within a source edit buffer if needed."
23746 (interactive "*P")
23747 (if (org-in-src-block-p)
23748 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23749 (call-interactively 'comment-dwim)))
23752 ;;; Timestamps API
23754 ;; This section contains tools to operate on timestamp objects, as
23755 ;; returned by, e.g. `org-element-context'.
23757 (defun org-timestamp--to-internal-time (timestamp &optional end)
23758 "Encode TIMESTAMP object into Emacs internal time.
23759 Use end of date range or time range when END is non-nil."
23760 (apply #'encode-time
23761 (cons 0
23762 (mapcar
23763 (lambda (prop) (or (org-element-property prop timestamp) 0))
23764 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23765 '(:minute-start :hour-start :day-start :month-start
23766 :year-start))))))
23768 (defun org-timestamp-has-time-p (timestamp)
23769 "Non-nil when TIMESTAMP has a time specified."
23770 (org-element-property :hour-start timestamp))
23772 (defun org-timestamp-format (timestamp format &optional end utc)
23773 "Format a TIMESTAMP object into a string.
23775 FORMAT is a format specifier to be passed to
23776 `format-time-string'.
23778 When optional argument END is non-nil, use end of date-range or
23779 time-range, if possible.
23781 When optional argument UTC is non-nil, time will be expressed as
23782 Universal Time."
23783 (format-time-string
23784 format (org-timestamp--to-internal-time timestamp end) utc))
23786 (defun org-timestamp-split-range (timestamp &optional end)
23787 "Extract a TIMESTAMP object from a date or time range.
23789 END, when non-nil, means extract the end of the range.
23790 Otherwise, extract its start.
23792 Return a new timestamp object."
23793 (let ((type (org-element-property :type timestamp)))
23794 (if (memq type '(active inactive diary)) timestamp
23795 (let ((split-ts (org-element-copy timestamp)))
23796 ;; Set new type.
23797 (org-element-put-property
23798 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23799 ;; Copy start properties over end properties if END is
23800 ;; non-nil. Otherwise, copy end properties over `start' ones.
23801 (let ((p-alist '((:minute-start . :minute-end)
23802 (:hour-start . :hour-end)
23803 (:day-start . :day-end)
23804 (:month-start . :month-end)
23805 (:year-start . :year-end))))
23806 (dolist (p-cell p-alist)
23807 (org-element-put-property
23808 split-ts
23809 (funcall (if end #'car #'cdr) p-cell)
23810 (org-element-property
23811 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23812 ;; Eventually refresh `:raw-value'.
23813 (org-element-put-property split-ts :raw-value nil)
23814 (org-element-put-property
23815 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23817 (defun org-timestamp-translate (timestamp &optional boundary)
23818 "Translate TIMESTAMP object to custom format.
23820 Format string is defined in `org-time-stamp-custom-formats',
23821 which see.
23823 When optional argument BOUNDARY is non-nil, it is either the
23824 symbol `start' or `end'. In this case, only translate the
23825 starting or ending part of TIMESTAMP if it is a date or time
23826 range. Otherwise, translate both parts.
23828 Return timestamp as-is if `org-display-custom-times' is nil or if
23829 it has a `diary' type."
23830 (let ((type (org-element-property :type timestamp)))
23831 (if (or (not org-display-custom-times) (eq type 'diary))
23832 (org-element-interpret-data timestamp)
23833 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23834 org-time-stamp-custom-formats)))
23835 (if (and (not boundary) (memq type '(active-range inactive-range)))
23836 (concat (org-timestamp-format timestamp fmt)
23837 "--"
23838 (org-timestamp-format timestamp fmt t))
23839 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23843 ;;; Other stuff.
23845 (defvar reftex-docstruct-symbol)
23846 (defvar reftex-cite-format)
23847 (defvar org--rds)
23849 (defun org-reftex-citation ()
23850 "Use reftex-citation to insert a citation into the buffer.
23851 This looks for a line like
23853 #+BIBLIOGRAPHY: foo plain option:-d
23855 and derives from it that foo.bib is the bibliography file relevant
23856 for this document. It then installs the necessary environment for RefTeX
23857 to work in this buffer and calls `reftex-citation' to insert a citation
23858 into the buffer.
23860 Export of such citations to both LaTeX and HTML is handled by the contributed
23861 package ox-bibtex by Taru Karttunen."
23862 (interactive)
23863 (let ((reftex-docstruct-symbol 'org--rds)
23864 (reftex-cite-format "\\cite{%l}")
23865 org--rds bib)
23866 (save-excursion
23867 (save-restriction
23868 (widen)
23869 (let ((case-fold-search t)
23870 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23871 (if (not (save-excursion
23872 (or (re-search-forward re nil t)
23873 (re-search-backward re nil t))))
23874 (user-error "No bibliography defined in file")
23875 (setq bib (concat (match-string 1) ".bib")
23876 org--rds (list (list 'bib bib)))))))
23877 (call-interactively 'reftex-citation)))
23879 ;;;; Functions extending outline functionality
23881 (defun org-beginning-of-line (&optional arg)
23882 "Go to the beginning of the current line. If that is invisible, continue
23883 to a visible line beginning. This makes the function of C-a more intuitive.
23884 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23885 first attempt, and only move to after the tags when the cursor is already
23886 beyond the end of the headline."
23887 (interactive "P")
23888 (let ((pos (point))
23889 (special (if (consp org-special-ctrl-a/e)
23890 (car org-special-ctrl-a/e)
23891 org-special-ctrl-a/e))
23892 deactivate-mark refpos)
23893 (if (org-bound-and-true-p visual-line-mode)
23894 (beginning-of-visual-line 1)
23895 (beginning-of-line 1))
23896 (if (and arg (fboundp 'move-beginning-of-line))
23897 (call-interactively 'move-beginning-of-line)
23898 (if (bobp)
23900 (backward-char 1)
23901 (if (org-truely-invisible-p)
23902 (while (and (not (bobp)) (org-truely-invisible-p))
23903 (backward-char 1)
23904 (beginning-of-line 1))
23905 (forward-char 1))))
23906 (when special
23907 (cond
23908 ((and (looking-at org-complex-heading-regexp)
23909 (eq (char-after (match-end 1)) ?\s))
23910 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23911 (point-at-eol)))
23912 (goto-char
23913 (if (eq special t)
23914 (cond ((> pos refpos) refpos)
23915 ((= pos (point)) refpos)
23916 (t (point)))
23917 (cond ((> pos (point)) (point))
23918 ((not (eq last-command this-command)) (point))
23919 (t refpos)))))
23920 ((org-at-item-p)
23921 ;; Being at an item and not looking at an the item means point
23922 ;; was previously moved to beginning of a visual line, which
23923 ;; doesn't contain the item. Therefore, do nothing special,
23924 ;; just stay here.
23925 (when (looking-at org-list-full-item-re)
23926 ;; Set special position at first white space character after
23927 ;; bullet, and check-box, if any.
23928 (let ((after-bullet
23929 (let ((box (match-end 3)))
23930 (if (not box) (match-end 1)
23931 (let ((after (char-after box)))
23932 (if (and after (= after ? )) (1+ box) box))))))
23933 ;; Special case: Move point to special position when
23934 ;; currently after it or at beginning of line.
23935 (if (eq special t)
23936 (when (or (> pos after-bullet) (= (point) pos))
23937 (goto-char after-bullet))
23938 ;; Reversed case: Move point to special position when
23939 ;; point was already at beginning of line and command is
23940 ;; repeated.
23941 (when (and (= (point) pos) (eq last-command this-command))
23942 (goto-char after-bullet))))))))
23943 (org-no-warnings
23944 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23945 (setq disable-point-adjustment
23946 (or (not (invisible-p (point)))
23947 (not (invisible-p (max (point-min) (1- (point))))))))
23949 (defun org-end-of-line (&optional arg)
23950 "Go to the end of the line.
23951 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23952 tags on the first attempt, and only move to after the tags when
23953 the cursor is already beyond the end of the headline."
23954 (interactive "P")
23955 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23956 org-special-ctrl-a/e))
23957 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23958 'end-of-visual-line)
23959 ((fboundp 'move-end-of-line) 'move-end-of-line)
23960 (t 'end-of-line)))
23961 deactivate-mark)
23962 (if (or (not special) arg) (call-interactively move-fun)
23963 (let* ((element (save-excursion (beginning-of-line)
23964 (org-element-at-point)))
23965 (type (org-element-type element)))
23966 (cond
23967 ((memq type '(headline inlinetask))
23968 (let ((pos (point)))
23969 (beginning-of-line 1)
23970 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23971 (if (eq special t)
23972 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23973 (goto-char (match-beginning 1))
23974 (goto-char (match-end 0)))
23975 (if (or (< pos (match-end 0))
23976 (not (eq this-command last-command)))
23977 (goto-char (match-end 0))
23978 (goto-char (match-beginning 1))))
23979 (call-interactively move-fun))))
23980 ((outline-invisible-p (line-end-position))
23981 ;; If element is hidden, `move-end-of-line' would put point
23982 ;; after it. Use `end-of-line' to stay on current line.
23983 (call-interactively 'end-of-line))
23984 (t (call-interactively move-fun)))))
23985 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23986 (setq disable-point-adjustment
23987 (or (not (invisible-p (point)))
23988 (not (invisible-p (max (point-min) (1- (point))))))))
23990 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23991 (define-key org-mode-map "\C-e" 'org-end-of-line)
23993 (defun org-backward-sentence (&optional _arg)
23994 "Go to beginning of sentence, or beginning of table field.
23995 This will call `backward-sentence' or `org-table-beginning-of-field',
23996 depending on context."
23997 (interactive)
23998 (let* ((element (org-element-at-point))
23999 (contents-begin (org-element-property :contents-begin element))
24000 (table (org-element-lineage element '(table) t)))
24001 (if (and table
24002 (> (point) contents-begin)
24003 (<= (point) (org-element-property :contents-end table)))
24004 (call-interactively #'org-table-beginning-of-field)
24005 (save-restriction
24006 (when (and contents-begin
24007 (< (point-min) contents-begin)
24008 (> (point) contents-begin))
24009 (narrow-to-region contents-begin
24010 (org-element-property :contents-end element)))
24011 (call-interactively #'backward-sentence)))))
24013 (defun org-forward-sentence (&optional _arg)
24014 "Go to end of sentence, or end of table field.
24015 This will call `forward-sentence' or `org-table-end-of-field',
24016 depending on context."
24017 (interactive)
24018 (let* ((element (org-element-at-point))
24019 (contents-end (org-element-property :contents-end element))
24020 (table (org-element-lineage element '(table) t)))
24021 (if (and table
24022 (>= (point) (org-element-property :contents-begin table))
24023 (< (point) contents-end))
24024 (call-interactively #'org-table-end-of-field)
24025 (save-restriction
24026 (when (and contents-end
24027 (> (point-max) contents-end)
24028 ;; Skip blank lines between elements.
24029 (< (org-element-property :end element)
24030 (save-excursion (goto-char contents-end)
24031 (skip-chars-forward " \r\t\n"))))
24032 (narrow-to-region (org-element-property :contents-begin element)
24033 contents-end))
24034 (call-interactively #'forward-sentence)))))
24036 (define-key org-mode-map "\M-a" 'org-backward-sentence)
24037 (define-key org-mode-map "\M-e" 'org-forward-sentence)
24039 (defun org-kill-line (&optional _arg)
24040 "Kill line, to tags or end of line."
24041 (interactive)
24042 (cond
24043 ((or (not org-special-ctrl-k)
24044 (bolp)
24045 (not (org-at-heading-p)))
24046 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
24047 org-ctrl-k-protect-subtree)
24048 (if (or (eq org-ctrl-k-protect-subtree 'error)
24049 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
24050 (user-error "C-k aborted as it would kill a hidden subtree")))
24051 (call-interactively
24052 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24053 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24054 (kill-region (point) (match-beginning 1))
24055 (org-set-tags nil t))
24056 (t (kill-region (point) (point-at-eol)))))
24058 (define-key org-mode-map "\C-k" 'org-kill-line)
24060 (defun org-yank (&optional arg)
24061 "Yank. If the kill is a subtree, treat it specially.
24062 This command will look at the current kill and check if is a single
24063 subtree, or a series of subtrees[1]. If it passes the test, and if the
24064 cursor is at the beginning of a line or after the stars of a currently
24065 empty headline, then the yank is handled specially. How exactly depends
24066 on the value of the following variables, both set by default.
24068 `org-yank-folded-subtrees'
24069 When set, the subtree(s) will be folded after insertion, but only
24070 if doing so would now swallow text after the yanked text.
24072 `org-yank-adjusted-subtrees'
24073 When set, the subtree will be promoted or demoted in order to
24074 fit into the local outline tree structure, which means that the
24075 level will be adjusted so that it becomes the smaller one of the
24076 two *visible* surrounding headings.
24078 Any prefix to this command will cause `yank' to be called directly with
24079 no special treatment. In particular, a simple \\[universal-argument] prefix \
24080 will just
24081 plainly yank the text as it is.
24083 \[1] The test checks if the first non-white line is a heading
24084 and if there are no other headings with fewer stars."
24085 (interactive "P")
24086 (org-yank-generic 'yank arg))
24088 (defun org-yank-generic (command arg)
24089 "Perform some yank-like command.
24091 This function implements the behavior described in the `org-yank'
24092 documentation. However, it has been generalized to work for any
24093 interactive command with similar behavior."
24095 ;; pretend to be command COMMAND
24096 (setq this-command command)
24098 (if arg
24099 (call-interactively command)
24101 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24102 (and (org-kill-is-subtree-p)
24103 (or (bolp)
24104 (and (looking-at "[ \t]*$")
24105 (string-match
24106 "\\`\\*+\\'"
24107 (buffer-substring (point-at-bol) (point)))))))
24108 swallowp)
24109 (cond
24110 ((and subtreep org-yank-folded-subtrees)
24111 (let ((beg (point))
24112 end)
24113 (if (and subtreep org-yank-adjusted-subtrees)
24114 (org-paste-subtree nil nil 'for-yank)
24115 (call-interactively command))
24117 (setq end (point))
24118 (goto-char beg)
24119 (when (and (bolp) subtreep
24120 (not (setq swallowp
24121 (org-yank-folding-would-swallow-text beg end))))
24122 (org-with-limited-levels
24123 (or (looking-at org-outline-regexp)
24124 (re-search-forward org-outline-regexp-bol end t))
24125 (while (and (< (point) end) (looking-at org-outline-regexp))
24126 (outline-hide-subtree)
24127 (org-cycle-show-empty-lines 'folded)
24128 (condition-case nil
24129 (outline-forward-same-level 1)
24130 (error (goto-char end))))))
24131 (when swallowp
24132 (message
24133 "Inserted text not folded because that would swallow text"))
24135 (goto-char end)
24136 (skip-chars-forward " \t\n\r")
24137 (beginning-of-line 1)
24138 (push-mark beg 'nomsg)))
24139 ((and subtreep org-yank-adjusted-subtrees)
24140 (let ((beg (point-at-bol)))
24141 (org-paste-subtree nil nil 'for-yank)
24142 (push-mark beg 'nomsg)))
24144 (call-interactively command))))))
24146 (defun org-yank-folding-would-swallow-text (beg end)
24147 "Would hide-subtree at BEG swallow any text after END?"
24148 (let (level)
24149 (org-with-limited-levels
24150 (save-excursion
24151 (goto-char beg)
24152 (when (or (looking-at org-outline-regexp)
24153 (re-search-forward org-outline-regexp-bol end t))
24154 (setq level (org-outline-level)))
24155 (goto-char end)
24156 (skip-chars-forward " \t\r\n\v\f")
24157 (if (or (eobp)
24158 (and (bolp) (looking-at org-outline-regexp)
24159 (<= (org-outline-level) level)))
24160 nil ; Nothing would be swallowed
24161 t))))) ; something would swallow
24163 (define-key org-mode-map "\C-y" 'org-yank)
24165 (defun org-truely-invisible-p ()
24166 "Check if point is at a character currently not visible.
24167 This version does not only check the character property, but also
24168 `visible-mode'."
24169 ;; Early versions of noutline don't have `outline-invisible-p'.
24170 (if (org-bound-and-true-p visible-mode)
24172 (outline-invisible-p)))
24174 (defun org-invisible-p2 ()
24175 "Check if point is at a character currently not visible."
24176 (save-excursion
24177 (if (and (eolp) (not (bobp))) (backward-char 1))
24178 ;; Early versions of noutline don't have `outline-invisible-p'.
24179 (outline-invisible-p)))
24181 (defun org-back-to-heading (&optional invisible-ok)
24182 "Call `outline-back-to-heading', but provide a better error message."
24183 (condition-case nil
24184 (outline-back-to-heading invisible-ok)
24185 (error (error "Before first headline at position %d in buffer %s"
24186 (point) (current-buffer)))))
24188 (defun org-before-first-heading-p ()
24189 "Before first heading?"
24190 (save-excursion
24191 (end-of-line)
24192 (null (re-search-backward org-outline-regexp-bol nil t))))
24194 (defun org-at-heading-p (&optional ignored)
24195 (outline-on-heading-p t))
24196 ;; Compatibility alias with Org versions < 7.8.03
24197 (defalias 'org-on-heading-p 'org-at-heading-p)
24199 (defun org-in-commented-heading-p (&optional no-inheritance)
24200 "Non-nil if point is under a commented heading.
24201 This function also checks ancestors of the current headline,
24202 unless optional argument NO-INHERITANCE is non-nil."
24203 (cond
24204 ((org-before-first-heading-p) nil)
24205 ((let ((headline (nth 4 (org-heading-components))))
24206 (and headline
24207 (let ((case-fold-search nil))
24208 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24209 headline)))))
24210 (no-inheritance nil)
24212 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24214 (defun org-at-comment-p nil
24215 "Is cursor in a commented line?"
24216 (save-excursion
24217 (save-match-data
24218 (beginning-of-line)
24219 (looking-at "^[ \t]*# "))))
24221 (defun org-at-drawer-p nil
24222 "Is cursor at a drawer keyword?"
24223 (save-excursion
24224 (move-beginning-of-line 1)
24225 (looking-at org-drawer-regexp)))
24227 (defun org-at-block-p nil
24228 "Is cursor at a block keyword?"
24229 (save-excursion
24230 (move-beginning-of-line 1)
24231 (looking-at org-block-regexp)))
24233 (defun org-point-at-end-of-empty-headline ()
24234 "If point is at the end of an empty headline, return t, else nil.
24235 If the heading only contains a TODO keyword, it is still still considered
24236 empty."
24237 (and (looking-at "[ \t]*$")
24238 (when org-todo-line-regexp
24239 (save-excursion
24240 (beginning-of-line 1)
24241 (let ((case-fold-search nil))
24242 (looking-at org-todo-line-regexp)
24243 (string= (match-string 3) ""))))))
24245 (defun org-at-heading-or-item-p ()
24246 (or (org-at-heading-p) (org-at-item-p)))
24248 (defun org-at-target-p ()
24249 (or (org-in-regexp org-radio-target-regexp)
24250 (org-in-regexp org-target-regexp)))
24251 ;; Compatibility alias with Org versions < 7.8.03
24252 (defalias 'org-on-target-p 'org-at-target-p)
24254 (defun org-up-heading-all (arg)
24255 "Move to the heading line of which the present line is a subheading.
24256 This function considers both visible and invisible heading lines.
24257 With argument, move up ARG levels."
24258 (if (fboundp 'outline-up-heading-all)
24259 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24260 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24262 (defun org-up-heading-safe ()
24263 "Move to the heading line of which the present line is a subheading.
24264 This version will not throw an error. It will return the level of the
24265 headline found, or nil if no higher level is found.
24267 Also, this function will be a lot faster than `outline-up-heading',
24268 because it relies on stars being the outline starters. This can really
24269 make a significant difference in outlines with very many siblings."
24270 (when (ignore-errors (org-back-to-heading t))
24271 (let ((level-up (1- (funcall outline-level))))
24272 (and (> level-up 0)
24273 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24274 (funcall outline-level)))))
24276 (defun org-first-sibling-p ()
24277 "Is this heading the first child of its parents?"
24278 (interactive)
24279 (let ((re org-outline-regexp-bol)
24280 level l)
24281 (unless (org-at-heading-p t)
24282 (user-error "Not at a heading"))
24283 (setq level (funcall outline-level))
24284 (save-excursion
24285 (if (not (re-search-backward re nil t))
24287 (setq l (funcall outline-level))
24288 (< l level)))))
24290 (defun org-goto-sibling (&optional previous)
24291 "Goto the next sibling, even if it is invisible.
24292 When PREVIOUS is set, go to the previous sibling instead. Returns t
24293 when a sibling was found. When none is found, return nil and don't
24294 move point."
24295 (let ((fun (if previous 're-search-backward 're-search-forward))
24296 (pos (point))
24297 (re org-outline-regexp-bol)
24298 level l)
24299 (when (ignore-errors (org-back-to-heading t))
24300 (setq level (funcall outline-level))
24301 (catch 'exit
24302 (or previous (forward-char 1))
24303 (while (funcall fun re nil t)
24304 (setq l (funcall outline-level))
24305 (when (< l level) (goto-char pos) (throw 'exit nil))
24306 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24307 (goto-char pos)
24308 nil))))
24310 (defun org-show-siblings ()
24311 "Show all siblings of the current headline."
24312 (save-excursion
24313 (while (org-goto-sibling) (org-flag-heading nil)))
24314 (save-excursion
24315 (while (org-goto-sibling 'previous)
24316 (org-flag-heading nil))))
24318 (defun org-goto-first-child ()
24319 "Goto the first child, even if it is invisible.
24320 Return t when a child was found. Otherwise don't move point and
24321 return nil."
24322 (let (level (pos (point)) (re org-outline-regexp-bol))
24323 (when (ignore-errors (org-back-to-heading t))
24324 (setq level (outline-level))
24325 (forward-char 1)
24326 (if (and (re-search-forward re nil t) (> (outline-level) level))
24327 (progn (goto-char (match-beginning 0)) t)
24328 (goto-char pos) nil))))
24330 (defun org-show-hidden-entry ()
24331 "Show an entry where even the heading is hidden."
24332 (save-excursion
24333 (org-show-entry)))
24335 (defun org-flag-heading (flag &optional entry)
24336 "Flag the current heading. FLAG non-nil means make invisible.
24337 When ENTRY is non-nil, show the entire entry."
24338 (save-excursion
24339 (org-back-to-heading t)
24340 ;; Check if we should show the entire entry
24341 (if entry
24342 (progn
24343 (org-show-entry)
24344 (save-excursion
24345 (and (outline-next-heading)
24346 (org-flag-heading nil))))
24347 (outline-flag-region (max (point-min) (1- (point)))
24348 (save-excursion (outline-end-of-heading) (point))
24349 flag))))
24351 (defun org-get-next-sibling ()
24352 "Move to next heading of the same level, and return point.
24353 If there is no such heading, return nil.
24354 This is like outline-next-sibling, but invisible headings are ok."
24355 (let ((level (funcall outline-level)))
24356 (outline-next-heading)
24357 (while (and (not (eobp)) (> (funcall outline-level) level))
24358 (outline-next-heading))
24359 (if (or (eobp) (< (funcall outline-level) level))
24361 (point))))
24363 (defun org-get-last-sibling ()
24364 "Move to previous heading of the same level, and return point.
24365 If there is no such heading, return nil."
24366 (let ((opoint (point))
24367 (level (funcall outline-level)))
24368 (outline-previous-heading)
24369 (when (and (/= (point) opoint) (outline-on-heading-p t))
24370 (while (and (> (funcall outline-level) level)
24371 (not (bobp)))
24372 (outline-previous-heading))
24373 (if (< (funcall outline-level) level)
24375 (point)))))
24377 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24378 "Goto to the end of a subtree."
24379 ;; This contains an exact copy of the original function, but it uses
24380 ;; `org-back-to-heading', to make it work also in invisible
24381 ;; trees. And is uses an invisible-ok argument.
24382 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24383 ;; Furthermore, when used inside Org, finding the end of a large subtree
24384 ;; with many children and grandchildren etc, this can be much faster
24385 ;; than the outline version.
24386 (org-back-to-heading invisible-ok)
24387 (let ((first t)
24388 (level (funcall outline-level)))
24389 (if (and (derived-mode-p 'org-mode) (< level 1000))
24390 ;; A true heading (not a plain list item), in Org-mode
24391 ;; This means we can easily find the end by looking
24392 ;; only for the right number of stars. Using a regexp to do
24393 ;; this is so much faster than using a Lisp loop.
24394 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24395 (forward-char 1)
24396 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24397 ;; something else, do it the slow way
24398 (while (and (not (eobp))
24399 (or first (> (funcall outline-level) level)))
24400 (setq first nil)
24401 (outline-next-heading)))
24402 (unless to-heading
24403 (if (memq (preceding-char) '(?\n ?\^M))
24404 (progn
24405 ;; Go to end of line before heading
24406 (forward-char -1)
24407 (if (memq (preceding-char) '(?\n ?\^M))
24408 ;; leave blank line before heading
24409 (forward-char -1))))))
24410 (point))
24412 (defun org-end-of-meta-data (&optional full)
24413 "Skip planning line and properties drawer in current entry.
24414 When optional argument FULL is non-nil, also skip empty lines,
24415 clocking lines and regular drawers at the beginning of the
24416 entry."
24417 (org-back-to-heading t)
24418 (forward-line)
24419 (when (org-looking-at-p org-planning-line-re) (forward-line))
24420 (when (looking-at org-property-drawer-re)
24421 (goto-char (match-end 0))
24422 (forward-line))
24423 (when (and full (not (org-at-heading-p)))
24424 (catch 'exit
24425 (let ((end (save-excursion (outline-next-heading) (point)))
24426 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24427 (while (not (eobp))
24428 (cond ((org-looking-at-p org-drawer-regexp)
24429 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24430 (forward-line)
24431 (throw 'exit t)))
24432 ((org-looking-at-p re) (forward-line))
24433 (t (throw 'exit t))))))))
24435 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24436 "Move forward to the ARG'th subheading at same level as this one.
24437 Stop at the first and last subheadings of a superior heading.
24438 Normally this only looks at visible headings, but when INVISIBLE-OK is
24439 non-nil it will also look at invisible ones."
24440 (interactive "p")
24441 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24442 (if (and arg (< arg 0))
24443 (goto-char (point-min))
24444 (outline-next-heading))
24445 (org-at-heading-p)
24446 (let ((level (- (match-end 0) (match-beginning 0) 1))
24447 (f (if (and arg (< arg 0))
24448 're-search-backward
24449 're-search-forward))
24450 (count (if arg (abs arg) 1))
24451 (result (point)))
24452 (while (and (prog1 (> count 0)
24453 (forward-char (if (and arg (< arg 0)) -1 1)))
24454 (funcall f org-outline-regexp-bol nil 'move))
24455 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24456 (cond ((< l level) (setq count 0))
24457 ((and (= l level)
24458 (or invisible-ok
24459 (progn
24460 (goto-char (line-beginning-position))
24461 (not (outline-invisible-p)))))
24462 (setq count (1- count))
24463 (when (eq l level)
24464 (setq result (point)))))))
24465 (goto-char result))
24466 (beginning-of-line 1)))
24468 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24469 "Move backward to the ARG'th subheading at same level as this one.
24470 Stop at the first and last subheadings of a superior heading."
24471 (interactive "p")
24472 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24474 (defun org-next-visible-heading (arg)
24475 "Move to the next visible heading.
24477 This function wraps `outline-next-visible-heading' with
24478 `org-with-limited-levels' in order to skip over inline tasks and
24479 respect customization of `org-odd-levels-only'."
24480 (interactive "p")
24481 (org-with-limited-levels
24482 (outline-next-visible-heading arg)))
24484 (defun org-previous-visible-heading (arg)
24485 "Move to the next visible heading.
24487 This function wraps `outline-previous-visible-heading' with
24488 `org-with-limited-levels' in order to skip over inline tasks and
24489 respect customization of `org-odd-levels-only'."
24490 (interactive "p")
24491 (org-with-limited-levels
24492 (outline-previous-visible-heading arg)))
24494 (defun org-next-block (arg &optional backward block-regexp)
24495 "Jump to the next block.
24497 With a prefix argument ARG, jump forward ARG many blocks.
24499 When BACKWARD is non-nil, jump to the previous block.
24501 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24502 Match data is set according to this regexp when the function
24503 returns.
24505 Return point at beginning of the opening line of found block.
24506 Throw an error if no block is found."
24507 (interactive "p")
24508 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24509 (case-fold-search t)
24510 (search-fn (if backward #'re-search-backward #'re-search-forward))
24511 (count (or arg 1))
24512 (origin (point))
24513 last-element)
24514 (if backward (beginning-of-line) (end-of-line))
24515 (while (and (> count 0) (funcall search-fn re nil t))
24516 (let ((element (save-excursion
24517 (goto-char (match-beginning 0))
24518 (save-match-data (org-element-at-point)))))
24519 (when (and (memq (org-element-type element)
24520 '(center-block comment-block dynamic-block
24521 example-block export-block quote-block
24522 special-block src-block verse-block))
24523 (<= (match-beginning 0)
24524 (org-element-property :post-affiliated element)))
24525 (setq last-element element)
24526 (decf count))))
24527 (if (= count 0)
24528 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24529 (save-match-data (org-show-context)))
24530 (goto-char origin)
24531 (user-error "No %s code blocks" (if backward "previous" "further")))))
24533 (defun org-previous-block (arg &optional block-regexp)
24534 "Jump to the previous block.
24535 With a prefix argument ARG, jump backward ARG many source blocks.
24536 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24537 (interactive "p")
24538 (org-next-block arg t block-regexp))
24540 (defun org-forward-paragraph ()
24541 "Move forward to beginning of next paragraph or equivalent.
24543 The function moves point to the beginning of the next visible
24544 structural element, which can be a paragraph, a table, a list
24545 item, etc. It also provides some special moves for convenience:
24547 - On an affiliated keyword, jump to the beginning of the
24548 relative element.
24549 - On an item or a footnote definition, move to the second
24550 element inside, if any.
24551 - On a table or a property drawer, jump after it.
24552 - On a verse or source block, stop after blank lines."
24553 (interactive)
24554 (when (eobp) (user-error "Cannot move further down"))
24555 (let* ((deactivate-mark nil)
24556 (element (org-element-at-point))
24557 (type (org-element-type element))
24558 (post-affiliated (org-element-property :post-affiliated element))
24559 (contents-begin (org-element-property :contents-begin element))
24560 (contents-end (org-element-property :contents-end element))
24561 (end (let ((end (org-element-property :end element)) (parent element))
24562 (while (and (setq parent (org-element-property :parent parent))
24563 (= (org-element-property :contents-end parent) end))
24564 (setq end (org-element-property :end parent)))
24565 end)))
24566 (cond ((not element)
24567 (skip-chars-forward " \r\t\n")
24568 (or (eobp) (beginning-of-line)))
24569 ;; On affiliated keywords, move to element's beginning.
24570 ((< (point) post-affiliated)
24571 (goto-char post-affiliated))
24572 ;; At a table row, move to the end of the table. Similarly,
24573 ;; at a node property, move to the end of the property
24574 ;; drawer.
24575 ((memq type '(node-property table-row))
24576 (goto-char (org-element-property
24577 :end (org-element-property :parent element))))
24578 ((memq type '(property-drawer table)) (goto-char end))
24579 ;; Consider blank lines as separators in verse and source
24580 ;; blocks to ease editing.
24581 ((memq type '(src-block verse-block))
24582 (when (eq type 'src-block)
24583 (setq contents-end
24584 (save-excursion (goto-char end)
24585 (skip-chars-backward " \r\t\n")
24586 (line-beginning-position))))
24587 (beginning-of-line)
24588 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24589 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24590 (goto-char end)
24591 (skip-chars-forward " \r\t\n")
24592 (if (= (point) contents-end) (goto-char end)
24593 (beginning-of-line))))
24594 ;; With no contents, just skip element.
24595 ((not contents-begin) (goto-char end))
24596 ;; If contents are invisible, skip the element altogether.
24597 ((outline-invisible-p (line-end-position))
24598 (case type
24599 (headline
24600 (org-with-limited-levels (outline-next-visible-heading 1)))
24601 ;; At a plain list, make sure we move to the next item
24602 ;; instead of skipping the whole list.
24603 (plain-list (forward-char)
24604 (org-forward-paragraph))
24605 (otherwise (goto-char end))))
24606 ((>= (point) contents-end) (goto-char end))
24607 ((>= (point) contents-begin)
24608 ;; This can only happen on paragraphs and plain lists.
24609 (case type
24610 (paragraph (goto-char end))
24611 ;; At a plain list, try to move to second element in
24612 ;; first item, if possible.
24613 (plain-list (end-of-line)
24614 (org-forward-paragraph))))
24615 ;; When contents start on the middle of a line (e.g. in
24616 ;; items and footnote definitions), try to reach first
24617 ;; element starting after current line.
24618 ((> (line-end-position) contents-begin)
24619 (end-of-line)
24620 (org-forward-paragraph))
24621 (t (goto-char contents-begin)))))
24623 (defun org-backward-paragraph ()
24624 "Move backward to start of previous paragraph or equivalent.
24626 The function moves point to the beginning of the current
24627 structural element, which can be a paragraph, a table, a list
24628 item, etc., or to the beginning of the previous visible one if
24629 point is already there. It also provides some special moves for
24630 convenience:
24632 - On an affiliated keyword, jump to the first one.
24633 - On a table or a property drawer, move to its beginning.
24634 - On a verse or source block, stop before blank lines."
24635 (interactive)
24636 (when (bobp) (user-error "Cannot move further up"))
24637 (let* ((deactivate-mark nil)
24638 (element (org-element-at-point))
24639 (type (org-element-type element))
24640 (contents-begin (org-element-property :contents-begin element))
24641 (contents-end (org-element-property :contents-end element))
24642 (post-affiliated (org-element-property :post-affiliated element))
24643 (begin (org-element-property :begin element)))
24644 (cond
24645 ((not element) (goto-char (point-min)))
24646 ((= (point) begin)
24647 (backward-char)
24648 (org-backward-paragraph))
24649 ((<= (point) post-affiliated) (goto-char begin))
24650 ((memq type '(node-property table-row))
24651 (goto-char (org-element-property
24652 :post-affiliated (org-element-property :parent element))))
24653 ((memq type '(property-drawer table)) (goto-char begin))
24654 ((memq type '(src-block verse-block))
24655 (when (eq type 'src-block)
24656 (setq contents-begin
24657 (save-excursion (goto-char begin) (forward-line) (point))))
24658 (if (= (point) contents-begin) (goto-char post-affiliated)
24659 ;; Inside a verse block, see blank lines as paragraph
24660 ;; separators.
24661 (let ((origin (point)))
24662 (skip-chars-backward " \r\t\n" contents-begin)
24663 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24664 (skip-chars-forward " \r\t\n" origin)
24665 (if (= (point) origin) (goto-char contents-begin)
24666 (beginning-of-line))))))
24667 ((not contents-begin) (goto-char (or post-affiliated begin)))
24668 ((eq type 'paragraph)
24669 (goto-char contents-begin)
24670 ;; When at first paragraph in an item or a footnote definition,
24671 ;; move directly to beginning of line.
24672 (let ((parent-contents
24673 (org-element-property
24674 :contents-begin (org-element-property :parent element))))
24675 (when (and parent-contents (= parent-contents contents-begin))
24676 (beginning-of-line))))
24677 ;; At the end of a greater element, move to the beginning of the
24678 ;; last element within.
24679 ((>= (point) contents-end)
24680 (goto-char (1- contents-end))
24681 (org-backward-paragraph))
24682 (t (goto-char (or post-affiliated begin))))
24683 ;; Ensure we never leave point invisible.
24684 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24686 (defun org-forward-element ()
24687 "Move forward by one element.
24688 Move to the next element at the same level, when possible."
24689 (interactive)
24690 (cond ((eobp) (user-error "Cannot move further down"))
24691 ((org-with-limited-levels (org-at-heading-p))
24692 (let ((origin (point)))
24693 (goto-char (org-end-of-subtree nil t))
24694 (unless (org-with-limited-levels (org-at-heading-p))
24695 (goto-char origin)
24696 (user-error "Cannot move further down"))))
24698 (let* ((elem (org-element-at-point))
24699 (end (org-element-property :end elem))
24700 (parent (org-element-property :parent elem)))
24701 (cond ((and parent (= (org-element-property :contents-end parent) end))
24702 (goto-char (org-element-property :end parent)))
24703 ((integer-or-marker-p end) (goto-char end))
24704 (t (message "No element at point")))))))
24706 (defun org-backward-element ()
24707 "Move backward by one element.
24708 Move to the previous element at the same level, when possible."
24709 (interactive)
24710 (cond ((bobp) (user-error "Cannot move further up"))
24711 ((org-with-limited-levels (org-at-heading-p))
24712 ;; At a headline, move to the previous one, if any, or stay
24713 ;; here.
24714 (let ((origin (point)))
24715 (org-with-limited-levels (org-backward-heading-same-level 1))
24716 ;; When current headline has no sibling above, move to its
24717 ;; parent.
24718 (when (= (point) origin)
24719 (or (org-with-limited-levels (org-up-heading-safe))
24720 (progn (goto-char origin)
24721 (user-error "Cannot move further up"))))))
24723 (let* ((elem (org-element-at-point))
24724 (beg (org-element-property :begin elem)))
24725 (cond
24726 ;; Move to beginning of current element if point isn't
24727 ;; there already.
24728 ((null beg) (message "No element at point"))
24729 ((/= (point) beg) (goto-char beg))
24730 (t (goto-char beg)
24731 (skip-chars-backward " \r\t\n")
24732 (unless (bobp)
24733 (let ((prev (org-element-at-point)))
24734 (goto-char (org-element-property :begin prev))
24735 (while (and (setq prev (org-element-property :parent prev))
24736 (<= (org-element-property :end prev) beg))
24737 (goto-char (org-element-property :begin prev)))))))))))
24739 (defun org-up-element ()
24740 "Move to upper element."
24741 (interactive)
24742 (if (org-with-limited-levels (org-at-heading-p))
24743 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24744 (let* ((elem (org-element-at-point))
24745 (parent (org-element-property :parent elem)))
24746 (if parent (goto-char (org-element-property :begin parent))
24747 (if (org-with-limited-levels (org-before-first-heading-p))
24748 (user-error "No surrounding element")
24749 (org-with-limited-levels (org-back-to-heading)))))))
24751 (defvar org-element-greater-elements)
24752 (defun org-down-element ()
24753 "Move to inner element."
24754 (interactive)
24755 (let ((element (org-element-at-point)))
24756 (cond
24757 ((memq (org-element-type element) '(plain-list table))
24758 (goto-char (org-element-property :contents-begin element))
24759 (forward-char))
24760 ((memq (org-element-type element) org-element-greater-elements)
24761 ;; If contents are hidden, first disclose them.
24762 (when (outline-invisible-p (line-end-position)) (org-cycle))
24763 (goto-char (or (org-element-property :contents-begin element)
24764 (user-error "No content for this element"))))
24765 (t (user-error "No inner element")))))
24767 (defun org-drag-element-backward ()
24768 "Move backward element at point."
24769 (interactive)
24770 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24771 (let* ((elem (org-element-at-point))
24772 (prev-elem
24773 (save-excursion
24774 (goto-char (org-element-property :begin elem))
24775 (skip-chars-backward " \r\t\n")
24776 (unless (bobp)
24777 (let* ((beg (org-element-property :begin elem))
24778 (prev (org-element-at-point))
24779 (up prev))
24780 (while (and (setq up (org-element-property :parent up))
24781 (<= (org-element-property :end up) beg))
24782 (setq prev up))
24783 prev)))))
24784 ;; Error out if no previous element or previous element is
24785 ;; a parent of the current one.
24786 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24787 (user-error "Cannot drag element backward")
24788 (let ((pos (point)))
24789 (org-element-swap-A-B prev-elem elem)
24790 (goto-char (+ (org-element-property :begin prev-elem)
24791 (- pos (org-element-property :begin elem)))))))))
24793 (defun org-drag-element-forward ()
24794 "Move forward element at point."
24795 (interactive)
24796 (let* ((pos (point))
24797 (elem (org-element-at-point)))
24798 (when (= (point-max) (org-element-property :end elem))
24799 (user-error "Cannot drag element forward"))
24800 (goto-char (org-element-property :end elem))
24801 (let ((next-elem (org-element-at-point)))
24802 (when (or (org-element-nested-p elem next-elem)
24803 (and (eq (org-element-type next-elem) 'headline)
24804 (not (eq (org-element-type elem) 'headline))))
24805 (goto-char pos)
24806 (user-error "Cannot drag element forward"))
24807 ;; Compute new position of point: it's shifted by NEXT-ELEM
24808 ;; body's length (without final blanks) and by the length of
24809 ;; blanks between ELEM and NEXT-ELEM.
24810 (let ((size-next (- (save-excursion
24811 (goto-char (org-element-property :end next-elem))
24812 (skip-chars-backward " \r\t\n")
24813 (forward-line)
24814 ;; Small correction if buffer doesn't end
24815 ;; with a newline character.
24816 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24817 (org-element-property :begin next-elem)))
24818 (size-blank (- (org-element-property :end elem)
24819 (save-excursion
24820 (goto-char (org-element-property :end elem))
24821 (skip-chars-backward " \r\t\n")
24822 (forward-line)
24823 (point)))))
24824 (org-element-swap-A-B elem next-elem)
24825 (goto-char (+ pos size-next size-blank))))))
24827 (defun org-drag-line-forward (arg)
24828 "Drag the line at point ARG lines forward."
24829 (interactive "p")
24830 (dotimes (n (abs arg))
24831 (let ((c (current-column)))
24832 (if (< 0 arg)
24833 (progn
24834 (beginning-of-line 2)
24835 (transpose-lines 1)
24836 (beginning-of-line 0))
24837 (transpose-lines 1)
24838 (beginning-of-line -1))
24839 (org-move-to-column c))))
24841 (defun org-drag-line-backward (arg)
24842 "Drag the line at point ARG lines backward."
24843 (interactive "p")
24844 (org-drag-line-forward (- arg)))
24846 (defun org-mark-element ()
24847 "Put point at beginning of this element, mark at end.
24849 Interactively, if this command is repeated or (in Transient Mark
24850 mode) if the mark is active, it marks the next element after the
24851 ones already marked."
24852 (interactive)
24853 (let (deactivate-mark)
24854 (if (and (org-called-interactively-p 'any)
24855 (or (and (eq last-command this-command) (mark t))
24856 (and transient-mark-mode mark-active)))
24857 (set-mark
24858 (save-excursion
24859 (goto-char (mark))
24860 (goto-char (org-element-property :end (org-element-at-point)))))
24861 (let ((element (org-element-at-point)))
24862 (end-of-line)
24863 (push-mark (org-element-property :end element) t t)
24864 (goto-char (org-element-property :begin element))))))
24866 (defun org-narrow-to-element ()
24867 "Narrow buffer to current element."
24868 (interactive)
24869 (let ((elem (org-element-at-point)))
24870 (cond
24871 ((eq (car elem) 'headline)
24872 (narrow-to-region
24873 (org-element-property :begin elem)
24874 (org-element-property :end elem)))
24875 ((memq (car elem) org-element-greater-elements)
24876 (narrow-to-region
24877 (org-element-property :contents-begin elem)
24878 (org-element-property :contents-end elem)))
24880 (narrow-to-region
24881 (org-element-property :begin elem)
24882 (org-element-property :end elem))))))
24884 (defun org-transpose-element ()
24885 "Transpose current and previous elements, keeping blank lines between.
24886 Point is moved after both elements."
24887 (interactive)
24888 (org-skip-whitespace)
24889 (let ((end (org-element-property :end (org-element-at-point))))
24890 (org-drag-element-backward)
24891 (goto-char end)))
24893 (defun org-unindent-buffer ()
24894 "Un-indent the visible part of the buffer.
24895 Relative indentation (between items, inside blocks, etc.) isn't
24896 modified."
24897 (interactive)
24898 (unless (eq major-mode 'org-mode)
24899 (user-error "Cannot un-indent a buffer not in Org mode"))
24900 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24901 unindent-tree ; For byte-compiler.
24902 (unindent-tree
24903 (function
24904 (lambda (contents)
24905 (mapc
24906 (lambda (element)
24907 (if (memq (org-element-type element) '(headline section))
24908 (funcall unindent-tree (org-element-contents element))
24909 (save-excursion
24910 (save-restriction
24911 (narrow-to-region
24912 (org-element-property :begin element)
24913 (org-element-property :end element))
24914 (org-do-remove-indentation)))))
24915 (reverse contents))))))
24916 (funcall unindent-tree (org-element-contents parse-tree))))
24918 (defun org-show-subtree ()
24919 "Show everything after this heading at deeper levels."
24920 (interactive)
24921 (outline-flag-region
24922 (point)
24923 (save-excursion
24924 (org-end-of-subtree t t))
24925 nil))
24927 (defun org-show-entry ()
24928 "Show the body directly following this heading.
24929 Show the heading too, if it is currently invisible."
24930 (interactive)
24931 (save-excursion
24932 (ignore-errors
24933 (org-back-to-heading t)
24934 (outline-flag-region
24935 (max (point-min) (1- (point)))
24936 (save-excursion
24937 (if (re-search-forward
24938 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24939 (match-beginning 1)
24940 (point-max)))
24941 nil)
24942 (org-cycle-hide-drawers 'children))))
24944 (defun org-make-options-regexp (kwds &optional extra)
24945 "Make a regular expression for keyword lines.
24946 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24947 when non-nil, is a regexp matching keywords names."
24948 (concat "^[ \t]*#\\+\\("
24949 (regexp-opt kwds)
24950 (and extra (concat (and kwds "\\|") extra))
24951 "\\):[ \t]*\\(.*\\)"))
24953 ;; Make isearch reveal the necessary context
24954 (defun org-isearch-end ()
24955 "Reveal context after isearch exits."
24956 (when isearch-success ; only if search was successful
24957 (if (featurep 'xemacs)
24958 ;; Under XEmacs, the hook is run in the correct place,
24959 ;; we directly show the context.
24960 (org-show-context 'isearch)
24961 ;; In Emacs the hook runs *before* restoring the overlays.
24962 ;; So we have to use a one-time post-command-hook to do this.
24963 ;; (Emacs 22 has a special variable, see function `org-mode')
24964 (unless (and (boundp 'isearch-mode-end-hook-quit)
24965 isearch-mode-end-hook-quit)
24966 ;; Only when the isearch was not quitted.
24967 (org-add-hook 'post-command-hook 'org-isearch-post-command
24968 'append 'local)))))
24970 (defun org-isearch-post-command ()
24971 "Remove self from hook, and show context."
24972 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24973 (org-show-context 'isearch))
24976 ;;;; Integration with and fixes for other packages
24978 ;;; Imenu support
24980 (defvar org-imenu-markers nil
24981 "All markers currently used by Imenu.")
24982 (make-variable-buffer-local 'org-imenu-markers)
24984 (defun org-imenu-new-marker (&optional pos)
24985 "Return a new marker for use by Imenu, and remember the marker."
24986 (let ((m (make-marker)))
24987 (move-marker m (or pos (point)))
24988 (push m org-imenu-markers)
24991 (defun org-imenu-get-tree ()
24992 "Produce the index for Imenu."
24993 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24994 (setq org-imenu-markers nil)
24995 (let* ((n org-imenu-depth)
24996 (re (concat "^" (org-get-limited-outline-regexp)))
24997 (subs (make-vector (1+ n) nil))
24998 (last-level 0)
24999 m level head0 head)
25000 (save-excursion
25001 (save-restriction
25002 (widen)
25003 (goto-char (point-max))
25004 (while (re-search-backward re nil t)
25005 (setq level (org-reduced-level (funcall outline-level)))
25006 (when (and (<= level n)
25007 (looking-at org-complex-heading-regexp)
25008 (setq head0 (org-match-string-no-properties 4)))
25009 (setq head (org-link-display-format head0)
25010 m (org-imenu-new-marker))
25011 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
25012 (if (>= level last-level)
25013 (push (cons head m) (aref subs level))
25014 (push (cons head (aref subs (1+ level))) (aref subs level))
25015 (loop for i from (1+ level) to n do (aset subs i nil)))
25016 (setq last-level level)))))
25017 (aref subs 1)))
25019 (eval-after-load "imenu"
25020 '(progn
25021 (add-hook 'imenu-after-jump-hook
25022 (lambda ()
25023 (if (derived-mode-p 'org-mode)
25024 (org-show-context 'org-goto))))))
25026 (defun org-link-display-format (link)
25027 "Replace a link with its the description.
25028 If there is no description, use the link target."
25029 (save-match-data
25030 (if (string-match org-bracket-link-analytic-regexp link)
25031 (replace-match (if (match-end 5)
25032 (match-string 5 link)
25033 (concat (match-string 1 link)
25034 (match-string 3 link)))
25035 nil t link)
25036 link)))
25038 (defun org-toggle-link-display ()
25039 "Toggle the literal or descriptive display of links."
25040 (interactive)
25041 (if org-descriptive-links
25042 (progn (org-remove-from-invisibility-spec '(org-link))
25043 (org-restart-font-lock)
25044 (setq org-descriptive-links nil))
25045 (progn (add-to-invisibility-spec '(org-link))
25046 (org-restart-font-lock)
25047 (setq org-descriptive-links t))))
25049 ;; Speedbar support
25051 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25052 "Overlay marking the agenda restriction line in speedbar.")
25053 (overlay-put org-speedbar-restriction-lock-overlay
25054 'face 'org-agenda-restriction-lock)
25055 (overlay-put org-speedbar-restriction-lock-overlay
25056 'help-echo "Agendas are currently limited to this item.")
25057 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25059 (defun org-speedbar-set-agenda-restriction ()
25060 "Restrict future agenda commands to the location at point in speedbar.
25061 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25062 (interactive)
25063 (require 'org-agenda)
25064 (let (p m tp np dir txt)
25065 (cond
25066 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25067 'org-imenu t))
25068 (setq m (get-text-property p 'org-imenu-marker))
25069 (with-current-buffer (marker-buffer m)
25070 (goto-char m)
25071 (org-agenda-set-restriction-lock 'subtree)))
25072 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25073 'speedbar-function 'speedbar-find-file))
25074 (setq tp (previous-single-property-change
25075 (1+ p) 'speedbar-function)
25076 np (next-single-property-change
25077 tp 'speedbar-function)
25078 dir (speedbar-line-directory)
25079 txt (buffer-substring-no-properties (or tp (point-min))
25080 (or np (point-max))))
25081 (with-current-buffer (find-file-noselect
25082 (let ((default-directory dir))
25083 (expand-file-name txt)))
25084 (unless (derived-mode-p 'org-mode)
25085 (user-error "Cannot restrict to non-Org-mode file"))
25086 (org-agenda-set-restriction-lock 'file)))
25087 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25088 (move-overlay org-speedbar-restriction-lock-overlay
25089 (point-at-bol) (point-at-eol))
25090 (setq current-prefix-arg nil)
25091 (org-agenda-maybe-redo)))
25093 (defvar speedbar-file-key-map)
25094 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25095 (eval-after-load "speedbar"
25096 '(progn
25097 (speedbar-add-supported-extension ".org")
25098 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25099 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25100 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25101 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25102 (add-hook 'speedbar-visiting-tag-hook
25103 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25105 ;;; Fixes and Hacks for problems with other packages
25107 (defun org--flyspell-object-check-p (element)
25108 "Non-nil when Flyspell can check object at point.
25109 ELEMENT is the element at point."
25110 (let ((object (save-excursion
25111 (when (org-looking-at-p "\\>") (backward-char))
25112 (org-element-context element))))
25113 (case (org-element-type object)
25114 ;; Prevent checks in links due to keybinding conflict with
25115 ;; Flyspell.
25116 ((code entity export-snippet inline-babel-call
25117 inline-src-block line-break latex-fragment link macro
25118 statistics-cookie target timestamp verbatim)
25119 nil)
25120 (footnote-reference
25121 ;; Only in inline footnotes, within the definition.
25122 (and (eq (org-element-property :type object) 'inline)
25123 (< (save-excursion
25124 (goto-char (org-element-property :begin object))
25125 (search-forward ":" nil t 2))
25126 (point))))
25127 (otherwise t))))
25129 (defun org-mode-flyspell-verify ()
25130 "Function used for `flyspell-generic-check-word-predicate'."
25131 (if (org-at-heading-p)
25132 ;; At a headline or an inlinetask, check title only. This is
25133 ;; faster than relying on `org-element-at-point'.
25134 (and (save-excursion (beginning-of-line)
25135 (and (let ((case-fold-search t))
25136 (not (looking-at "\\*+ END[ \t]*$")))
25137 (looking-at org-complex-heading-regexp)))
25138 (match-beginning 4)
25139 (>= (point) (match-beginning 4))
25140 (or (not (match-beginning 5))
25141 (< (point) (match-beginning 5))))
25142 (let* ((element (org-element-at-point))
25143 (post-affiliated (org-element-property :post-affiliated element)))
25144 (cond
25145 ;; Ignore checks in all affiliated keywords but captions.
25146 ((< (point) post-affiliated)
25147 (and (save-excursion
25148 (beginning-of-line)
25149 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25150 (> (point) (match-end 0))
25151 (org--flyspell-object-check-p element)))
25152 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25153 ((let ((log (org-log-into-drawer)))
25154 (and log
25155 (let ((drawer (org-element-lineage element '(drawer))))
25156 (and drawer
25157 (eq (compare-strings
25158 log nil nil
25159 (org-element-property :drawer-name drawer) nil nil t)
25160 t)))))
25161 nil)
25163 (case (org-element-type element)
25164 ((comment quote-section) t)
25165 (comment-block
25166 ;; Allow checks between block markers, not on them.
25167 (and (> (line-beginning-position) post-affiliated)
25168 (save-excursion
25169 (end-of-line)
25170 (skip-chars-forward " \r\t\n")
25171 (< (point) (org-element-property :end element)))))
25172 ;; Arbitrary list of keywords where checks are meaningful.
25173 ;; Make sure point is on the value part of the element.
25174 (keyword
25175 (and (member (org-element-property :key element)
25176 '("DESCRIPTION" "TITLE"))
25177 (save-excursion
25178 (search-backward ":" (line-beginning-position) t))))
25179 ;; Check is globally allowed in paragraphs verse blocks and
25180 ;; table rows (after affiliated keywords) but some objects
25181 ;; must not be affected.
25182 ((paragraph table-row verse-block)
25183 (let ((cbeg (org-element-property :contents-begin element))
25184 (cend (org-element-property :contents-end element)))
25185 (and cbeg (>= (point) cbeg) (< (point) cend)
25186 (org--flyspell-object-check-p element))))))))))
25187 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25189 (defun org-remove-flyspell-overlays-in (beg end)
25190 "Remove flyspell overlays in region."
25191 (and (org-bound-and-true-p flyspell-mode)
25192 (fboundp 'flyspell-delete-region-overlays)
25193 (flyspell-delete-region-overlays beg end)))
25195 (defvar flyspell-delayed-commands)
25196 (eval-after-load "flyspell"
25197 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25199 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25200 (eval-after-load "bookmark"
25201 '(if (boundp 'bookmark-after-jump-hook)
25202 ;; We can use the hook
25203 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25204 ;; Hook not available, use advice
25205 (defadvice bookmark-jump (after org-make-visible activate)
25206 "Make the position visible."
25207 (org-bookmark-jump-unhide))))
25209 ;; Make sure saveplace shows the location if it was hidden
25210 (eval-after-load "saveplace"
25211 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25212 "Make the position visible."
25213 (org-bookmark-jump-unhide)))
25215 ;; Make sure ecb shows the location if it was hidden
25216 (eval-after-load "ecb"
25217 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25218 "Make hierarchy visible when jumping into location from ECB tree buffer."
25219 (if (derived-mode-p 'org-mode)
25220 (org-show-context))))
25222 (defun org-bookmark-jump-unhide ()
25223 "Unhide the current position, to show the bookmark location."
25224 (and (derived-mode-p 'org-mode)
25225 (or (outline-invisible-p)
25226 (save-excursion (goto-char (max (point-min) (1- (point))))
25227 (outline-invisible-p)))
25228 (org-show-context 'bookmark-jump)))
25230 (defun org-mark-jump-unhide ()
25231 "Make the point visible with `org-show-context' after jumping to the mark."
25232 (when (and (derived-mode-p 'org-mode)
25233 (outline-invisible-p))
25234 (org-show-context 'mark-goto)))
25236 (eval-after-load "simple"
25237 '(defadvice pop-to-mark-command (after org-make-visible activate)
25238 "Make the point visible with `org-show-context'."
25239 (org-mark-jump-unhide)))
25241 (eval-after-load "simple"
25242 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25243 "Make the point visible with `org-show-context'."
25244 (org-mark-jump-unhide)))
25246 (eval-after-load "simple"
25247 '(defadvice pop-global-mark (after org-make-visible activate)
25248 "Make the point visible with `org-show-context'."
25249 (org-mark-jump-unhide)))
25251 ;; Make session.el ignore our circular variable
25252 (defvar session-globals-exclude)
25253 (eval-after-load "session"
25254 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25256 ;;;; Finish up
25258 (provide 'org)
25260 (run-hooks 'org-load-hook)
25262 ;;; org.el ends here